utilities/ovs-dpctl.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include <arpa/inet.h>
  19 #include <errno.h>
  20 #include <getopt.h>
  21 #include <inttypes.h>
  22 #include <sys/socket.h>
  23 #include <net/if.h>
  24 #include <netinet/in.h>
  25 #include <signal.h>
  26 #include <stdarg.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <unistd.h>
  30 #include <sys/stat.h>
  31 #include <sys/time.h>
  32
  33 #include "command-line.h"
  34 #include "compiler.h"
  35 #include "dirs.h"
  36 #include "dpif.h"
  37 #include "dynamic-string.h"
  38 #include "netdev.h"
  39 #include "odp-util.h"
  40 #include "shash.h"
  41 #include "svec.h"
  42 #include "timeval.h"
  43 #include "util.h"
  44 #include "vlog.h"
  45
  46 VLOG_DEFINE_THIS_MODULE(dpctl);
  47
  48 static const struct command all_commands[];
  49
  50 static void usage(void) NO_RETURN;
  51 static void parse_options(int argc, char *argv[]);
  52
  53 int
  54 main(int argc, char *argv[])
  55 {
  56     set_program_name(argv[0]);
  57     parse_options(argc, argv);
  58     signal(SIGPIPE, SIG_IGN);
  59     run_command(argc - optind, argv + optind, all_commands);
  60     return 0;
  61 }
  62
  63 static void
  64 parse_options(int argc, char *argv[])
  65 {
  66     enum {
  67         OPT_DUMMY = UCHAR_MAX + 1,
  68         VLOG_OPTION_ENUMS
  69     };
  70     static struct option long_options[] = {
  71         {"timeout", required_argument, 0, 't'},
  72         {"help", no_argument, 0, 'h'},
  73         {"version", no_argument, 0, 'V'},
  74         VLOG_LONG_OPTIONS,
  75         {0, 0, 0, 0},
  76     };
  77     char *short_options = long_options_to_short_options(long_options);
  78
  79     for (;;) {
  80         unsigned long int timeout;
  81         int c;
  82
  83         c = getopt_long(argc, argv, short_options, long_options, NULL);
  84         if (c == -1) {
  85             break;
  86         }
  87
  88         switch (c) {
  89         case 't':
  90             timeout = strtoul(optarg, NULL, 10);
  91             if (timeout <= 0) {
  92                 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
  93                           optarg);
  94             } else {
  95                 time_alarm(timeout);
  96             }
  97             break;
  98
  99         case 'h':
 100             usage();
 101
 102         case 'V':
 103             OVS_PRINT_VERSION(0, 0);
 104             exit(EXIT_SUCCESS);
 105
 106         VLOG_OPTION_HANDLERS
 107
 108         case '?':
 109             exit(EXIT_FAILURE);
 110
 111         default:
 112             abort();
 113         }
 114     }
 115     free(short_options);
 116 }
 117
 118 static void
 119 usage(void)
 120 {
 121     printf("%s: Open vSwitch datapath management utility\n"
 122            "usage: %s [OPTIONS] COMMAND [ARG...]\n"
 123            "  add-dp DP [IFACE...]     add new datapath DP (with IFACEs)\n"
 124            "  del-dp DP                delete local datapath DP\n"
 125            "  add-if DP IFACE...       add each IFACE as a port on DP\n"
 126            "  del-if DP IFACE...       delete each IFACE from DP\n"
 127            "  dump-dps                 display names of all datapaths\n"
 128            "  show                     show basic info on all datapaths\n"
 129            "  show DP...               show basic info on each DP\n"
 130            "  dump-flows DP            display flows in DP\n"
 131            "  del-flows DP             delete all flows from DP\n",
 132            program_name, program_name);
 133     vlog_usage();
 134     printf("\nOther options:\n"
 135            "  -t, --timeout=SECS          give up after SECS seconds\n"
 136            "  -h, --help                  display this help message\n"
 137            "  -V, --version               display version information\n");
 138     exit(EXIT_SUCCESS);
 139 }
 140
 141 static void run(int retval, const char *message, ...)
 142     PRINTF_FORMAT(2, 3);
 143
 144 static void run(int retval, const char *message, ...)
 145 {
 146     if (retval) {
 147         va_list args;
 148
 149         fprintf(stderr, "%s: ", program_name);
 150         va_start(args, message);
 151         vfprintf(stderr, message, args);
 152         va_end(args);
 153         if (retval == EOF) {
 154             fputs(": unexpected end of file\n", stderr);
 155         } else {
 156             fprintf(stderr, ": %s\n", strerror(retval));
 157         }
 158
 159         exit(EXIT_FAILURE);
 160     }
 161 }
 162 \f
 163 static void do_add_if(int argc, char *argv[]);
 164
 165 static int if_up(const char *netdev_name)
 166 {
 167     struct netdev *netdev;
 168     int retval;
 169
 170     retval = netdev_open_default(netdev_name, &netdev);
 171     if (!retval) {
 172         retval = netdev_turn_flags_on(netdev, NETDEV_UP, true);
 173         netdev_close(netdev);
 174     }
 175     return retval;
 176 }
 177
 178 static int
 179 parsed_dpif_open(const char *arg_, bool create, struct dpif **dpifp)
 180 {
 181     int result;
 182     char *name, *type;
 183
 184     dp_parse_name(arg_, &name, &type);
 185
 186     if (create) {
 187         result = dpif_create(name, type, dpifp);
 188     } else {
 189         result = dpif_open(name, type, dpifp);
 190     }
 191
 192     free(name);
 193     free(type);
 194     return result;
 195 }
 196
 197 static void
 198 do_add_dp(int argc OVS_UNUSED, char *argv[])
 199 {
 200     struct dpif *dpif;
 201     run(parsed_dpif_open(argv[1], true, &dpif), "add_dp");
 202     dpif_close(dpif);
 203     if (argc > 2) {
 204         do_add_if(argc, argv);
 205     }
 206 }
 207
 208 static void
 209 do_del_dp(int argc OVS_UNUSED, char *argv[])
 210 {
 211     struct dpif *dpif;
 212     run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
 213     run(dpif_delete(dpif), "del_dp");
 214     dpif_close(dpif);
 215 }
 216
 217 static int
 218 compare_ports(const void *a_, const void *b_)
 219 {
 220     const struct odp_port *a = a_;
 221     const struct odp_port *b = b_;
 222     return a->port < b->port ? -1 : a->port > b->port;
 223 }
 224
 225 static void
 226 query_ports(struct dpif *dpif, struct odp_port **ports, size_t *n_ports)
 227 {
 228     run(dpif_port_list(dpif, ports, n_ports), "listing ports");
 229     qsort(*ports, *n_ports, sizeof **ports, compare_ports);
 230 }
 231
 232 static void
 233 do_add_if(int argc OVS_UNUSED, char *argv[])
 234 {
 235     bool failure = false;
 236     struct dpif *dpif;
 237     int i;
 238
 239     run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
 240     for (i = 2; i < argc; i++) {
 241         char *save_ptr = NULL;
 242         struct netdev_options options;
 243         struct netdev *netdev;
 244         struct shash args;
 245         char *option;
 246         int error;
 247
 248         options.name = strtok_r(argv[i], ",", &save_ptr);
 249         options.type = "system";
 250         options.args = &args;
 251         options.ethertype = NETDEV_ETH_TYPE_NONE;
 252
 253         if (!options.name) {
 254             ovs_error(0, "%s is not a valid network device name", argv[i]);
 255             continue;
 256         }
 257
 258         shash_init(&args);
 259         while ((option = strtok_r(NULL, "", &save_ptr)) != NULL) {
 260             char *save_ptr_2 = NULL;
 261             char *key, *value;
 262
 263             key = strtok_r(option, "=", &save_ptr_2);
 264             value = strtok_r(NULL, "", &save_ptr_2);
 265             if (!value) {
 266                 value = "";
 267             }
 268
 269             if (!strcmp(key, "type")) {
 270                 options.type = value;
 271             } else if (!shash_add_once(&args, key, value)) {
 272                 ovs_error(0, "duplicate \"%s\" option", key);
 273             }
 274         }
 275
 276         error = netdev_open(&options, &netdev);
 277         if (error) {
 278             ovs_error(error, "%s: failed to open network device",
 279                       options.name);
 280         } else {
 281             error = dpif_port_add(dpif, netdev, NULL);
 282             if (error) {
 283                 ovs_error(error, "adding %s to %s failed",
 284                           options.name, argv[1]);
 285             } else {
 286                 error = if_up(options.name);
 287             }
 288             netdev_close(netdev);
 289         }
 290         if (error) {
 291             failure = true;
 292         }
 293     }
 294     dpif_close(dpif);
 295     if (failure) {
 296         exit(EXIT_FAILURE);
 297     }
 298 }
 299
 300 static bool
 301 get_port_number(struct dpif *dpif, const char *name, uint16_t *port)
 302 {
 303     struct odp_port *ports;
 304     size_t n_ports;
 305     size_t i;
 306
 307     query_ports(dpif, &ports, &n_ports);
 308     for (i = 0; i < n_ports; i++) {
 309         if (!strcmp(name, ports[i].devname)) {
 310             *port = ports[i].port;
 311             free(ports);
 312             return true;
 313         }
 314     }
 315     free(ports);
 316     ovs_error(0, "no port named %s", name);
 317     return false;
 318 }
 319
 320 static void
 321 do_del_if(int argc OVS_UNUSED, char *argv[])
 322 {
 323     bool failure = false;
 324     struct dpif *dpif;
 325     int i;
 326
 327     run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
 328     for (i = 2; i < argc; i++) {
 329         const char *name = argv[i];
 330         uint16_t port;
 331         int error;
 332
 333         if (!name[strspn(name, "0123456789")]) {
 334             port = atoi(name);
 335         } else if (!get_port_number(dpif, name, &port)) {
 336             failure = true;
 337             continue;
 338         }
 339
 340         error = dpif_port_del(dpif, port);
 341         if (error) {
 342             ovs_error(error, "deleting port %s from %s failed", name, argv[1]);
 343             failure = true;
 344         }
 345     }
 346     dpif_close(dpif);
 347     if (failure) {
 348         exit(EXIT_FAILURE);
 349     }
 350 }
 351
 352 static void
 353 show_dpif(struct dpif *dpif)
 354 {
 355     struct odp_port *ports;
 356     struct odp_stats stats;
 357     size_t n_ports;
 358     size_t i;
 359
 360     printf("%s:\n", dpif_name(dpif));
 361     if (!dpif_get_dp_stats(dpif, &stats)) {
 362         printf("\tflows: cur:%"PRIu32", soft-max:%"PRIu32", "
 363                "hard-max:%"PRIu32"\n",
 364                stats.n_flows, stats.cur_capacity, stats.max_capacity);
 365         printf("\tports: cur:%"PRIu32", max:%"PRIu32"\n",
 366                stats.n_ports, stats.max_ports);
 367         printf("\tlookups: frags:%llu, hit:%llu, missed:%llu, lost:%llu\n",
 368                (unsigned long long int) stats.n_frags,
 369                (unsigned long long int) stats.n_hit,
 370                (unsigned long long int) stats.n_missed,
 371                (unsigned long long int) stats.n_lost);
 372         printf("\tqueues: max-miss:%"PRIu16", max-action:%"PRIu16"\n",
 373                stats.max_miss_queue, stats.max_action_queue);
 374     }
 375     query_ports(dpif, &ports, &n_ports);
 376     for (i = 0; i < n_ports; i++) {
 377         const struct odp_port *p = &ports[i];
 378         struct ds ds;
 379
 380         printf("\tport %u: %s", p->port, p->devname);
 381
 382         ds_init(&ds);
 383         format_odp_port_type(&ds, p);
 384         printf("%s\n", ds_cstr(&ds));
 385         ds_destroy(&ds);
 386     }
 387     free(ports);
 388     dpif_close(dpif);
 389 }
 390
 391 static void
 392 do_show(int argc, char *argv[])
 393 {
 394     bool failure = false;
 395     if (argc > 1) {
 396         int i;
 397         for (i = 1; i < argc; i++) {
 398             const char *name = argv[i];
 399             struct dpif *dpif;
 400             int error;
 401
 402             error = parsed_dpif_open(name, false, &dpif);
 403             if (!error) {
 404                 show_dpif(dpif);
 405             } else {
 406                 ovs_error(error, "opening datapath %s failed", name);
 407                 failure = true;
 408             }
 409         }
 410     } else {
 411         unsigned int i;
 412         for (i = 0; i < ODP_MAX; i++) {
 413             char name[128];
 414             struct dpif *dpif;
 415             int error;
 416
 417             sprintf(name, "dp%u", i);
 418             error = parsed_dpif_open(name, false, &dpif);
 419             if (!error) {
 420                 show_dpif(dpif);
 421             } else if (error != ENODEV) {
 422                 ovs_error(error, "opening datapath %s failed", name);
 423                 failure = true;
 424             }
 425         }
 426     }
 427     if (failure) {
 428         exit(EXIT_FAILURE);
 429     }
 430 }
 431
 432 static void
 433 do_dump_dps(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 434 {
 435     struct svec dpif_names, dpif_types;
 436     unsigned int i;
 437     int error = 0;
 438
 439     svec_init(&dpif_names);
 440     svec_init(&dpif_types);
 441     dp_enumerate_types(&dpif_types);
 442
 443     for (i = 0; i < dpif_types.n; i++) {
 444         unsigned int j;
 445         int retval;
 446
 447         retval = dp_enumerate_names(dpif_types.names[i], &dpif_names);
 448         if (retval) {
 449             error = retval;
 450         }
 451
 452         for (j = 0; j < dpif_names.n; j++) {
 453             struct dpif *dpif;
 454             if (!dpif_open(dpif_names.names[j], dpif_types.names[i], &dpif)) {
 455                 printf("%s\n", dpif_name(dpif));
 456                 dpif_close(dpif);
 457             }
 458         }
 459     }
 460
 461     svec_destroy(&dpif_names);
 462     svec_destroy(&dpif_types);
 463     if (error) {
 464         exit(EXIT_FAILURE);
 465     }
 466 }
 467
 468 static void
 469 do_dump_flows(int argc OVS_UNUSED, char *argv[])
 470 {
 471     struct odp_flow *flows;
 472     struct dpif *dpif;
 473     size_t n_flows;
 474     struct ds ds;
 475     size_t i;
 476
 477     run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
 478     run(dpif_flow_list_all(dpif, &flows, &n_flows), "listing all flows");
 479
 480     ds_init(&ds);
 481     for (i = 0; i < n_flows; i++) {
 482         struct odp_flow *f = &flows[i];
 483         enum { MAX_ACTIONS = 4096 }; /* An arbitrary but large number. */
 484         struct nlattr actions[MAX_ACTIONS];
 485
 486         f->actions = actions;
 487         f->actions_len = sizeof actions;
 488         if (!dpif_flow_get(dpif, f)) {
 489             ds_clear(&ds);
 490             format_odp_flow(&ds, f);
 491             printf("%s\n", ds_cstr(&ds));
 492         }
 493     }
 494     ds_destroy(&ds);
 495     dpif_close(dpif);
 496 }
 497
 498 static void
 499 do_del_flows(int argc OVS_UNUSED, char *argv[])
 500 {
 501     struct dpif *dpif;
 502
 503     run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
 504     run(dpif_flow_flush(dpif), "deleting all flows");
 505     dpif_close(dpif);
 506 }
 507
 508 static void
 509 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 510 {
 511     usage();
 512 }
 513
 514 static const struct command all_commands[] = {
 515     { "add-dp", 1, INT_MAX, do_add_dp },
 516     { "del-dp", 1, 1, do_del_dp },
 517     { "add-if", 2, INT_MAX, do_add_if },
 518     { "del-if", 2, INT_MAX, do_del_if },
 519     { "dump-dps", 0, 0, do_dump_dps },
 520     { "show", 0, INT_MAX, do_show },
 521     { "dump-flows", 1, 1, do_dump_flows },
 522     { "del-flows", 1, 1, do_del_flows },
 523     { "help", 0, INT_MAX, do_help },
 524     { NULL, 0, 0, NULL },
 525 };