utilities/ovs-dpctl.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
   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 "flow.h"
  39 #include "netdev.h"
  40 #include "netlink.h"
  41 #include "odp-util.h"
  42 #include "ofpbuf.h"
  43 #include "packets.h"
  44 #include "shash.h"
  45 #include "simap.h"
  46 #include "smap.h"
  47 #include "sset.h"
  48 #include "timeval.h"
  49 #include "util.h"
  50 #include "vlog.h"
  51
  52 VLOG_DEFINE_THIS_MODULE(dpctl);
  53
  54 /* -s, --statistics: Print port/flow statistics? */
  55 static bool print_statistics;
  56
  57 /* --clear: Reset existing statistics to zero when modifying a flow? */
  58 static bool zero_statistics;
  59
  60 /* --may-create: Allow mod-flows command to create a new flow? */
  61 static bool may_create;
  62
  63 /* -m, --more: Output verbosity.
  64  *
  65  * So far only undocumented commands honor this option, so we don't document
  66  * the option itself. */
  67 static int verbosity;
  68
  69 static const struct command all_commands[];
  70
  71 static void usage(void) NO_RETURN;
  72 static void parse_options(int argc, char *argv[]);
  73
  74 int
  75 main(int argc, char *argv[])
  76 {
  77     set_program_name(argv[0]);
  78     parse_options(argc, argv);
  79     signal(SIGPIPE, SIG_IGN);
  80     run_command(argc - optind, argv + optind, all_commands);
  81     return 0;
  82 }
  83
  84 static void
  85 parse_options(int argc, char *argv[])
  86 {
  87     enum {
  88         OPT_CLEAR = UCHAR_MAX + 1,
  89         OPT_MAY_CREATE,
  90         VLOG_OPTION_ENUMS
  91     };
  92     static const struct option long_options[] = {
  93         {"statistics", no_argument, NULL, 's'},
  94         {"clear", no_argument, NULL, OPT_CLEAR},
  95         {"may-create", no_argument, NULL, OPT_MAY_CREATE},
  96         {"more", no_argument, NULL, 'm'},
  97         {"timeout", required_argument, NULL, 't'},
  98         {"help", no_argument, NULL, 'h'},
  99         {"version", no_argument, NULL, 'V'},
 100         VLOG_LONG_OPTIONS,
 101         {NULL, 0, NULL, 0},
 102     };
 103     char *short_options = long_options_to_short_options(long_options);
 104
 105     for (;;) {
 106         unsigned long int timeout;
 107         int c;
 108
 109         c = getopt_long(argc, argv, short_options, long_options, NULL);
 110         if (c == -1) {
 111             break;
 112         }
 113
 114         switch (c) {
 115         case 's':
 116             print_statistics = true;
 117             break;
 118
 119         case OPT_CLEAR:
 120             zero_statistics = true;
 121             break;
 122
 123         case OPT_MAY_CREATE:
 124             may_create = true;
 125             break;
 126
 127         case 'm':
 128             verbosity++;
 129             break;
 130
 131         case 't':
 132             timeout = strtoul(optarg, NULL, 10);
 133             if (timeout <= 0) {
 134                 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
 135                           optarg);
 136             } else {
 137                 time_alarm(timeout);
 138             }
 139             break;
 140
 141         case 'h':
 142             usage();
 143
 144         case 'V':
 145             ovs_print_version(0, 0);
 146             exit(EXIT_SUCCESS);
 147
 148         VLOG_OPTION_HANDLERS
 149
 150         case '?':
 151             exit(EXIT_FAILURE);
 152
 153         default:
 154             abort();
 155         }
 156     }
 157     free(short_options);
 158 }
 159
 160 static void
 161 usage(void)
 162 {
 163     printf("%s: Open vSwitch datapath management utility\n"
 164            "usage: %s [OPTIONS] COMMAND [ARG...]\n"
 165            "  add-dp DP [IFACE...]     add new datapath DP (with IFACEs)\n"
 166            "  del-dp DP                delete local datapath DP\n"
 167            "  add-if DP IFACE...       add each IFACE as a port on DP\n"
 168            "  set-if DP IFACE...       reconfigure each IFACE within DP\n"
 169            "  del-if DP IFACE...       delete each IFACE from DP\n"
 170            "  dump-dps                 display names of all datapaths\n"
 171            "  show                     show basic info on all datapaths\n"
 172            "  show DP...               show basic info on each DP\n"
 173            "  dump-flows DP            display flows in DP\n"
 174            "  add-flow DP FLOW ACTIONS add FLOW with ACTIONS to DP\n"
 175            "  mod-flow DP FLOW ACTIONS change FLOW actions to ACTIONS in DP\n"
 176            "  del-flow DP FLOW         delete FLOW from DP\n"
 177            "  del-flows DP             delete all flows from DP\n"
 178            "Each IFACE on add-dp, add-if, and set-if may be followed by\n"
 179            "comma-separated options.  See ovs-dpctl(8) for syntax, or the\n"
 180            "Interface table in ovs-vswitchd.conf.db(5) for an options list.\n",
 181            program_name, program_name);
 182     vlog_usage();
 183     printf("\nOptions for show and mod-flow:\n"
 184            "  -s,  --statistics           print statistics for port or flow\n"
 185            "\nOptions for mod-flow:\n"
 186            "  --may-create                create flow if it doesn't exist\n"
 187            "  --clear                     reset existing stats to zero\n"
 188            "\nOther options:\n"
 189            "  -t, --timeout=SECS          give up after SECS seconds\n"
 190            "  -h, --help                  display this help message\n"
 191            "  -V, --version               display version information\n");
 192     exit(EXIT_SUCCESS);
 193 }
 194
 195 static void run(int retval, const char *message, ...)
 196     PRINTF_FORMAT(2, 3);
 197
 198 static void run(int retval, const char *message, ...)
 199 {
 200     if (retval) {
 201         va_list args;
 202
 203         va_start(args, message);
 204         ovs_fatal_valist(retval, message, args);
 205     }
 206 }
 207 \f
 208 static void dpctl_add_if(int argc, char *argv[]);
 209
 210 static int if_up(const char *netdev_name)
 211 {
 212     struct netdev *netdev;
 213     int retval;
 214
 215     retval = netdev_open(netdev_name, "system", &netdev);
 216     if (!retval) {
 217         retval = netdev_turn_flags_on(netdev, NETDEV_UP, NULL);
 218         netdev_close(netdev);
 219     }
 220     return retval;
 221 }
 222
 223 /* Retrieve the name of the datapath if exactly one exists.  The caller
 224  * is responsible for freeing the returned string.  If there is not one
 225  * datapath, aborts with an error message. */
 226 static char *
 227 get_one_dp(void)
 228 {
 229     struct sset types;
 230     const char *type;
 231     char *dp_name = NULL;
 232     size_t count = 0;
 233
 234     sset_init(&types);
 235     dp_enumerate_types(&types);
 236     SSET_FOR_EACH (type, &types) {
 237         struct sset names;
 238
 239         sset_init(&names);
 240         if (!dp_enumerate_names(type, &names)) {
 241             count += sset_count(&names);
 242             if (!dp_name && count == 1) {
 243                 dp_name = xasprintf("%s@%s", type, SSET_FIRST(&names));
 244             }
 245         }
 246         sset_destroy(&names);
 247     }
 248     sset_destroy(&types);
 249
 250     if (!count) {
 251         ovs_fatal(0, "no datapaths exist");
 252     } else if (count > 1) {
 253         ovs_fatal(0, "multiple datapaths, specify one");
 254     }
 255
 256     return dp_name;
 257 }
 258
 259 static int
 260 parsed_dpif_open(const char *arg_, bool create, struct dpif **dpifp)
 261 {
 262     int result;
 263     char *name, *type;
 264
 265     dp_parse_name(arg_, &name, &type);
 266
 267     if (create) {
 268         result = dpif_create(name, type, dpifp);
 269     } else {
 270         result = dpif_open(name, type, dpifp);
 271     }
 272
 273     free(name);
 274     free(type);
 275     return result;
 276 }
 277
 278 static void
 279 dpctl_add_dp(int argc OVS_UNUSED, char *argv[])
 280 {
 281     struct dpif *dpif;
 282     run(parsed_dpif_open(argv[1], true, &dpif), "add_dp");
 283     dpif_close(dpif);
 284     if (argc > 2) {
 285         dpctl_add_if(argc, argv);
 286     }
 287 }
 288
 289 static void
 290 dpctl_del_dp(int argc OVS_UNUSED, char *argv[])
 291 {
 292     struct dpif *dpif;
 293     run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
 294     run(dpif_delete(dpif), "del_dp");
 295     dpif_close(dpif);
 296 }
 297
 298 static void
 299 dpctl_add_if(int argc OVS_UNUSED, char *argv[])
 300 {
 301     bool failure = false;
 302     struct dpif *dpif;
 303     int i;
 304
 305     run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
 306     for (i = 2; i < argc; i++) {
 307         const char *name, *type;
 308         char *save_ptr = NULL;
 309         struct netdev *netdev = NULL;
 310         struct smap args;
 311         odp_port_t port_no = ODPP_NONE;
 312         char *option;
 313         int error;
 314
 315         name = strtok_r(argv[i], ",", &save_ptr);
 316         type = "system";
 317
 318         if (!name) {
 319             ovs_error(0, "%s is not a valid network device name", argv[i]);
 320             failure = true;
 321             continue;
 322         }
 323
 324         smap_init(&args);
 325         while ((option = strtok_r(NULL, ",", &save_ptr)) != NULL) {
 326             char *save_ptr_2 = NULL;
 327             char *key, *value;
 328
 329             key = strtok_r(option, "=", &save_ptr_2);
 330             value = strtok_r(NULL, "", &save_ptr_2);
 331             if (!value) {
 332                 value = "";
 333             }
 334
 335             if (!strcmp(key, "type")) {
 336                 type = value;
 337             } else if (!strcmp(key, "port_no")) {
 338                 port_no = u32_to_odp(atoi(value));
 339             } else if (!smap_add_once(&args, key, value)) {
 340                 ovs_error(0, "duplicate \"%s\" option", key);
 341             }
 342         }
 343
 344         error = netdev_open(name, type, &netdev);
 345         if (error) {
 346             ovs_error(error, "%s: failed to open network device", name);
 347             goto next;
 348         }
 349
 350         error = netdev_set_config(netdev, &args);
 351         if (error) {
 352             ovs_error(error, "%s: failed to configure network device", name);
 353             goto next;
 354         }
 355
 356         error = dpif_port_add(dpif, netdev, &port_no);
 357         if (error) {
 358             ovs_error(error, "adding %s to %s failed", name, argv[1]);
 359             goto next;
 360         }
 361
 362         error = if_up(name);
 363
 364 next:
 365         netdev_close(netdev);
 366         if (error) {
 367             failure = true;
 368         }
 369     }
 370     dpif_close(dpif);
 371     if (failure) {
 372         exit(EXIT_FAILURE);
 373     }
 374 }
 375
 376 static void
 377 dpctl_set_if(int argc, char *argv[])
 378 {
 379     bool failure = false;
 380     struct dpif *dpif;
 381     int i;
 382
 383     run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
 384     for (i = 2; i < argc; i++) {
 385         struct netdev *netdev = NULL;
 386         struct dpif_port dpif_port;
 387         char *save_ptr = NULL;
 388         char *type = NULL;
 389         const char *name;
 390         struct smap args;
 391         odp_port_t port_no;
 392         char *option;
 393         int error;
 394
 395         name = strtok_r(argv[i], ",", &save_ptr);
 396         if (!name) {
 397             ovs_error(0, "%s is not a valid network device name", argv[i]);
 398             failure = true;
 399             continue;
 400         }
 401
 402         /* Get the port's type from the datapath. */
 403         error = dpif_port_query_by_name(dpif, name, &dpif_port);
 404         if (error) {
 405             ovs_error(error, "%s: failed to query port in %s", name, argv[1]);
 406             goto next;
 407         }
 408         type = xstrdup(dpif_port.type);
 409         port_no = dpif_port.port_no;
 410         dpif_port_destroy(&dpif_port);
 411
 412         /* Retrieve its existing configuration. */
 413         error = netdev_open(name, type, &netdev);
 414         if (error) {
 415             ovs_error(error, "%s: failed to open network device", name);
 416             goto next;
 417         }
 418
 419         smap_init(&args);
 420         error = netdev_get_config(netdev, &args);
 421         if (error) {
 422             ovs_error(error, "%s: failed to fetch configuration", name);
 423             goto next;
 424         }
 425
 426         /* Parse changes to configuration. */
 427         while ((option = strtok_r(NULL, ",", &save_ptr)) != NULL) {
 428             char *save_ptr_2 = NULL;
 429             char *key, *value;
 430
 431             key = strtok_r(option, "=", &save_ptr_2);
 432             value = strtok_r(NULL, "", &save_ptr_2);
 433             if (!value) {
 434                 value = "";
 435             }
 436
 437             if (!strcmp(key, "type")) {
 438                 if (strcmp(value, type)) {
 439                     ovs_error(0, "%s: can't change type from %s to %s",
 440                               name, type, value);
 441                     failure = true;
 442                 }
 443             } else if (!strcmp(key, "port_no")) {
 444                 if (port_no != u32_to_odp(atoi(value))) {
 445                     ovs_error(0, "%s: can't change port number from "
 446                               "%"PRIu32" to %d",
 447                               name, port_no, atoi(value));
 448                     failure = true;
 449                 }
 450             } else if (value[0] == '\0') {
 451                 smap_remove(&args, key);
 452             } else {
 453                 smap_replace(&args, key, value);
 454             }
 455         }
 456
 457         /* Update configuration. */
 458         error = netdev_set_config(netdev, &args);
 459         smap_destroy(&args);
 460         if (error) {
 461             ovs_error(error, "%s: failed to configure network device", name);
 462             goto next;
 463         }
 464
 465 next:
 466         free(type);
 467         netdev_close(netdev);
 468         if (error) {
 469             failure = true;
 470         }
 471     }
 472     dpif_close(dpif);
 473     if (failure) {
 474         exit(EXIT_FAILURE);
 475     }
 476 }
 477
 478 static bool
 479 get_port_number(struct dpif *dpif, const char *name, odp_port_t *port)
 480 {
 481     struct dpif_port dpif_port;
 482
 483     if (!dpif_port_query_by_name(dpif, name, &dpif_port)) {
 484         *port = dpif_port.port_no;
 485         dpif_port_destroy(&dpif_port);
 486         return true;
 487     } else {
 488         ovs_error(0, "no port named %s", name);
 489         return false;
 490     }
 491 }
 492
 493 static void
 494 dpctl_del_if(int argc OVS_UNUSED, char *argv[])
 495 {
 496     bool failure = false;
 497     struct dpif *dpif;
 498     int i;
 499
 500     run(parsed_dpif_open(argv[1], false, &dpif), "opening datapath");
 501     for (i = 2; i < argc; i++) {
 502         const char *name = argv[i];
 503         odp_port_t port;
 504         int error;
 505
 506         if (!name[strspn(name, "0123456789")]) {
 507             port = u32_to_odp(atoi(name));
 508         } else if (!get_port_number(dpif, name, &port)) {
 509             failure = true;
 510             continue;
 511         }
 512
 513         error = dpif_port_del(dpif, port);
 514         if (error) {
 515             ovs_error(error, "deleting port %s from %s failed", name, argv[1]);
 516             failure = true;
 517         }
 518     }
 519     dpif_close(dpif);
 520     if (failure) {
 521         exit(EXIT_FAILURE);
 522     }
 523 }
 524
 525 static void
 526 print_stat(const char *leader, uint64_t value)
 527 {
 528     fputs(leader, stdout);
 529     if (value != UINT64_MAX) {
 530         printf("%"PRIu64, value);
 531     } else {
 532         putchar('?');
 533     }
 534 }
 535
 536 static void
 537 print_human_size(uint64_t value)
 538 {
 539     if (value == UINT64_MAX) {
 540         /* Nothing to do. */
 541     } else if (value >= 1024ULL * 1024 * 1024 * 1024) {
 542         printf(" (%.1f TiB)", value / (1024.0 * 1024 * 1024 * 1024));
 543     } else if (value >= 1024ULL * 1024 * 1024) {
 544         printf(" (%.1f GiB)", value / (1024.0 * 1024 * 1024));
 545     } else if (value >= 1024ULL * 1024) {
 546         printf(" (%.1f MiB)", value / (1024.0 * 1024));
 547     } else if (value >= 1024) {
 548         printf(" (%.1f KiB)", value / 1024.0);
 549     }
 550 }
 551
 552 static void
 553 show_dpif(struct dpif *dpif)
 554 {
 555     struct dpif_port_dump dump;
 556     struct dpif_port dpif_port;
 557     struct dpif_dp_stats stats;
 558     struct netdev *netdev;
 559
 560     printf("%s:\n", dpif_name(dpif));
 561     if (!dpif_get_dp_stats(dpif, &stats)) {
 562         printf("\tlookups: hit:%"PRIu64" missed:%"PRIu64" lost:%"PRIu64"\n"
 563                "\tflows: %"PRIu64"\n",
 564                stats.n_hit, stats.n_missed, stats.n_lost, stats.n_flows);
 565     }
 566     DPIF_PORT_FOR_EACH (&dpif_port, &dump, dpif) {
 567         printf("\tport %u: %s", dpif_port.port_no, dpif_port.name);
 568
 569         if (strcmp(dpif_port.type, "system")) {
 570             int error;
 571
 572             printf (" (%s", dpif_port.type);
 573
 574             error = netdev_open(dpif_port.name, dpif_port.type, &netdev);
 575             if (!error) {
 576                 struct smap config;
 577
 578                 smap_init(&config);
 579                 error = netdev_get_config(netdev, &config);
 580                 if (!error) {
 581                     const struct smap_node **nodes;
 582                     size_t i;
 583
 584                     nodes = smap_sort(&config);
 585                     for (i = 0; i < smap_count(&config); i++) {
 586                         const struct smap_node *node = nodes[i];
 587                         printf("%c %s=%s", i ? ',' : ':', node->key,
 588                                node->value);
 589                     }
 590                     free(nodes);
 591                 } else {
 592                     printf(", could not retrieve configuration (%s)",
 593                            ovs_strerror(error));
 594                 }
 595                 smap_destroy(&config);
 596
 597                 netdev_close(netdev);
 598             } else {
 599                 printf(": open failed (%s)", ovs_strerror(error));
 600             }
 601             putchar(')');
 602         }
 603         putchar('\n');
 604
 605         if (print_statistics) {
 606             struct netdev_stats s;
 607             int error;
 608
 609             error = netdev_open(dpif_port.name, dpif_port.type, &netdev);
 610             if (error) {
 611                 printf(", open failed (%s)", ovs_strerror(error));
 612                 continue;
 613             }
 614             error = netdev_get_stats(netdev, &s);
 615             if (error) {
 616                 printf(", could not retrieve stats (%s)", ovs_strerror(error));
 617                 continue;
 618             }
 619
 620             netdev_close(netdev);
 621             print_stat("\t\tRX packets:", s.rx_packets);
 622             print_stat(" errors:", s.rx_errors);
 623             print_stat(" dropped:", s.rx_dropped);
 624             print_stat(" overruns:", s.rx_over_errors);
 625             print_stat(" frame:", s.rx_frame_errors);
 626             printf("\n");
 627
 628             print_stat("\t\tTX packets:", s.tx_packets);
 629             print_stat(" errors:", s.tx_errors);
 630             print_stat(" dropped:", s.tx_dropped);
 631             print_stat(" aborted:", s.tx_aborted_errors);
 632             print_stat(" carrier:", s.tx_carrier_errors);
 633             printf("\n");
 634
 635             print_stat("\t\tcollisions:", s.collisions);
 636             printf("\n");
 637
 638             print_stat("\t\tRX bytes:", s.rx_bytes);
 639             print_human_size(s.rx_bytes);
 640             print_stat("  TX bytes:", s.tx_bytes);
 641             print_human_size(s.tx_bytes);
 642             printf("\n");
 643         }
 644     }
 645     dpif_close(dpif);
 646 }
 647
 648 static void
 649 dpctl_show(int argc, char *argv[])
 650 {
 651     bool failure = false;
 652     if (argc > 1) {
 653         int i;
 654         for (i = 1; i < argc; i++) {
 655             const char *name = argv[i];
 656             struct dpif *dpif;
 657             int error;
 658
 659             error = parsed_dpif_open(name, false, &dpif);
 660             if (!error) {
 661                 show_dpif(dpif);
 662             } else {
 663                 ovs_error(error, "opening datapath %s failed", name);
 664                 failure = true;
 665             }
 666         }
 667     } else {
 668         struct sset types;
 669         const char *type;
 670
 671         sset_init(&types);
 672         dp_enumerate_types(&types);
 673         SSET_FOR_EACH (type, &types) {
 674             struct sset names;
 675             const char *name;
 676
 677             sset_init(&names);
 678             if (dp_enumerate_names(type, &names)) {
 679                 failure = true;
 680                 continue;
 681             }
 682             SSET_FOR_EACH (name, &names) {
 683                 struct dpif *dpif;
 684                 int error;
 685
 686                 error = dpif_open(name, type, &dpif);
 687                 if (!error) {
 688                     show_dpif(dpif);
 689                 } else {
 690                     ovs_error(error, "opening datapath %s failed", name);
 691                     failure = true;
 692                 }
 693             }
 694             sset_destroy(&names);
 695         }
 696         sset_destroy(&types);
 697     }
 698     if (failure) {
 699         exit(EXIT_FAILURE);
 700     }
 701 }
 702
 703 static void
 704 dpctl_dump_dps(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 705 {
 706     struct sset dpif_names, dpif_types;
 707     const char *type;
 708     int error = 0;
 709
 710     sset_init(&dpif_names);
 711     sset_init(&dpif_types);
 712     dp_enumerate_types(&dpif_types);
 713
 714     SSET_FOR_EACH (type, &dpif_types) {
 715         const char *name;
 716         int retval;
 717
 718         retval = dp_enumerate_names(type, &dpif_names);
 719         if (retval) {
 720             error = retval;
 721         }
 722
 723         SSET_FOR_EACH (name, &dpif_names) {
 724             struct dpif *dpif;
 725             if (!dpif_open(name, type, &dpif)) {
 726                 printf("%s\n", dpif_name(dpif));
 727                 dpif_close(dpif);
 728             }
 729         }
 730     }
 731
 732     sset_destroy(&dpif_names);
 733     sset_destroy(&dpif_types);
 734     if (error) {
 735         exit(EXIT_FAILURE);
 736     }
 737 }
 738
 739 static void
 740 dpctl_dump_flows(int argc, char *argv[])
 741 {
 742     const struct dpif_flow_stats *stats;
 743     const struct nlattr *actions;
 744     struct dpif_flow_dump dump;
 745     const struct nlattr *key;
 746     const struct nlattr *mask;
 747     size_t actions_len;
 748     struct dpif *dpif;
 749     size_t key_len;
 750     size_t mask_len;
 751     struct ds ds;
 752     char *name;
 753
 754     name = (argc == 2) ? xstrdup(argv[1]) : get_one_dp();
 755     run(parsed_dpif_open(name, false, &dpif), "opening datapath");
 756     free(name);
 757
 758     ds_init(&ds);
 759     dpif_flow_dump_start(&dump, dpif);
 760     while (dpif_flow_dump_next(&dump, &key, &key_len,
 761                                &mask, &mask_len,
 762                                &actions, &actions_len, &stats)) {
 763         ds_clear(&ds);
 764         odp_flow_format(key, key_len, mask, mask_len, &ds);
 765         ds_put_cstr(&ds, ", ");
 766
 767         dpif_flow_stats_format(stats, &ds);
 768         ds_put_cstr(&ds, ", actions:");
 769         format_odp_actions(&ds, actions, actions_len);
 770         printf("%s\n", ds_cstr(&ds));
 771     }
 772     dpif_flow_dump_done(&dump);
 773     ds_destroy(&ds);
 774     dpif_close(dpif);
 775 }
 776
 777 static void
 778 dpctl_put_flow(int argc, char *argv[], enum dpif_flow_put_flags flags)
 779 {
 780     const char *key_s = argv[argc - 2];
 781     const char *actions_s = argv[argc - 1];
 782     struct dpif_flow_stats stats;
 783     struct ofpbuf actions;
 784     struct ofpbuf key;
 785     struct ofpbuf mask;
 786     struct dpif *dpif;
 787     struct ds s;
 788     char *dp_name;
 789
 790     ds_init(&s);
 791     ofpbuf_init(&key, 0);
 792     ofpbuf_init(&mask, 0);
 793     run(odp_flow_from_string(key_s, NULL, &key, &mask), "parsing flow key");
 794
 795     ofpbuf_init(&actions, 0);
 796     run(odp_actions_from_string(actions_s, NULL, &actions), "parsing actions");
 797
 798     dp_name = argc == 4 ? xstrdup(argv[1]) : get_one_dp();
 799     run(parsed_dpif_open(dp_name, false, &dpif), "opening datapath");
 800     free(dp_name);
 801
 802     run(dpif_flow_put(dpif, flags,
 803                       key.data, key.size,
 804                       mask.size == 0 ? NULL : mask.data, mask.size,
 805                       actions.data, actions.size,
 806                       print_statistics ? &stats : NULL),
 807         "updating flow table");
 808
 809     ofpbuf_uninit(&key);
 810     ofpbuf_uninit(&mask);
 811     ofpbuf_uninit(&actions);
 812
 813     if (print_statistics) {
 814         struct ds s;
 815
 816         ds_init(&s);
 817         dpif_flow_stats_format(&stats, &s);
 818         puts(ds_cstr(&s));
 819         ds_destroy(&s);
 820     }
 821 }
 822
 823 static void
 824 dpctl_add_flow(int argc, char *argv[])
 825 {
 826     dpctl_put_flow(argc, argv, DPIF_FP_CREATE);
 827 }
 828
 829 static void
 830 dpctl_mod_flow(int argc OVS_UNUSED, char *argv[])
 831 {
 832     enum dpif_flow_put_flags flags;
 833
 834     flags = DPIF_FP_MODIFY;
 835     if (may_create) {
 836         flags |= DPIF_FP_CREATE;
 837     }
 838     if (zero_statistics) {
 839         flags |= DPIF_FP_ZERO_STATS;
 840     }
 841
 842     dpctl_put_flow(argc, argv, flags);
 843 }
 844
 845 static void
 846 dpctl_del_flow(int argc, char *argv[])
 847 {
 848     const char *key_s = argv[argc - 1];
 849     struct dpif_flow_stats stats;
 850     struct ofpbuf key;
 851     struct ofpbuf mask; /* To be ignored. */
 852     struct dpif *dpif;
 853     char *dp_name;
 854
 855     ofpbuf_init(&key, 0);
 856     ofpbuf_init(&mask, 0);
 857     run(odp_flow_from_string(key_s, NULL, &key, &mask), "parsing flow key");
 858
 859     dp_name = argc == 2 ? xstrdup(argv[1]) : get_one_dp();
 860     run(parsed_dpif_open(dp_name, false, &dpif), "opening datapath");
 861     free(dp_name);
 862
 863     run(dpif_flow_del(dpif,
 864                       key.data, key.size,
 865                       print_statistics ? &stats : NULL), "deleting flow");
 866
 867     ofpbuf_uninit(&key);
 868     ofpbuf_uninit(&mask);
 869
 870     if (print_statistics) {
 871         struct ds s;
 872
 873         ds_init(&s);
 874         dpif_flow_stats_format(&stats, &s);
 875         puts(ds_cstr(&s));
 876         ds_destroy(&s);
 877     }
 878 }
 879
 880 static void
 881 dpctl_del_flows(int argc, char *argv[])
 882 {
 883     struct dpif *dpif;
 884     char *name;
 885
 886     name = (argc == 2) ? xstrdup(argv[1]) : get_one_dp();
 887     run(parsed_dpif_open(name, false, &dpif), "opening datapath");
 888     free(name);
 889
 890     run(dpif_flow_flush(dpif), "deleting all flows");
 891     dpif_close(dpif);
 892 }
 893
 894 static void
 895 dpctl_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
 896 {
 897     usage();
 898 }
 899 \f
 900 /* Undocumented commands for unit testing. */
 901
 902 static void
 903 dpctl_parse_actions(int argc, char *argv[])
 904 {
 905     int i;
 906
 907     for (i = 1; i < argc; i++) {
 908         struct ofpbuf actions;
 909         struct ds s;
 910
 911         ofpbuf_init(&actions, 0);
 912         run(odp_actions_from_string(argv[i], NULL, &actions),
 913             "odp_actions_from_string");
 914
 915         ds_init(&s);
 916         format_odp_actions(&s, actions.data, actions.size);
 917         puts(ds_cstr(&s));
 918         ds_destroy(&s);
 919
 920         ofpbuf_uninit(&actions);
 921     }
 922 }
 923
 924 struct actions_for_flow {
 925     struct hmap_node hmap_node;
 926     struct flow flow;
 927     struct ofpbuf actions;
 928 };
 929
 930 static struct actions_for_flow *
 931 get_actions_for_flow(struct hmap *actions_per_flow, const struct flow *flow)
 932 {
 933     uint32_t hash = flow_hash(flow, 0);
 934     struct actions_for_flow *af;
 935
 936     HMAP_FOR_EACH_WITH_HASH (af, hmap_node, hash, actions_per_flow) {
 937         if (flow_equal(&af->flow, flow)) {
 938             return af;
 939         }
 940     }
 941
 942     af = xmalloc(sizeof *af);
 943     af->flow = *flow;
 944     ofpbuf_init(&af->actions, 0);
 945     hmap_insert(actions_per_flow, &af->hmap_node, hash);
 946     return af;
 947 }
 948
 949 static int
 950 compare_actions_for_flow(const void *a_, const void *b_)
 951 {
 952     struct actions_for_flow *const *a = a_;
 953     struct actions_for_flow *const *b = b_;
 954
 955     return flow_compare_3way(&(*a)->flow, &(*b)->flow);
 956 }
 957
 958 static int
 959 compare_output_actions(const void *a_, const void *b_)
 960 {
 961     const struct nlattr *a = a_;
 962     const struct nlattr *b = b_;
 963     uint32_t a_port = nl_attr_get_u32(a);
 964     uint32_t b_port = nl_attr_get_u32(b);
 965
 966     return a_port < b_port ? -1 : a_port > b_port;
 967 }
 968
 969 static void
 970 sort_output_actions__(struct nlattr *first, struct nlattr *end)
 971 {
 972     size_t bytes = (uint8_t *) end - (uint8_t *) first;
 973     size_t n = bytes / NL_A_U32_SIZE;
 974
 975     ovs_assert(bytes % NL_A_U32_SIZE == 0);
 976     qsort(first, n, NL_A_U32_SIZE, compare_output_actions);
 977 }
 978
 979 static void
 980 sort_output_actions(struct nlattr *actions, size_t length)
 981 {
 982     struct nlattr *first_output = NULL;
 983     struct nlattr *a;
 984     int left;
 985
 986     NL_ATTR_FOR_EACH (a, left, actions, length) {
 987         if (nl_attr_type(a) == OVS_ACTION_ATTR_OUTPUT) {
 988             if (!first_output) {
 989                 first_output = a;
 990             }
 991         } else {
 992             if (first_output) {
 993                 sort_output_actions__(first_output, a);
 994                 first_output = NULL;
 995             }
 996         }
 997     }
 998     if (first_output) {
 999         uint8_t *end = (uint8_t *) actions + length;
1000         sort_output_actions__(first_output, (struct nlattr *) end);
1001     }
1002 }
1003
1004 /* usage: "ovs-dpctl normalize-actions FLOW ACTIONS" where FLOW and ACTIONS
1005  * have the syntax used by "ovs-dpctl dump-flows".
1006  *
1007  * This command prints ACTIONS in a format that shows what happens for each
1008  * VLAN, independent of the order of the ACTIONS.  For example, there is more
1009  * than one way to output a packet on VLANs 9 and 11, but this command will
1010  * print the same output for any form.
1011  *
1012  * The idea here generalizes beyond VLANs (e.g. to setting other fields) but
1013  * so far the implementation only covers VLANs. */
1014 static void
1015 dpctl_normalize_actions(int argc, char *argv[])
1016 {
1017     struct simap port_names;
1018     struct ofpbuf keybuf;
1019     struct flow flow;
1020     struct ofpbuf odp_actions;
1021     struct hmap actions_per_flow;
1022     struct actions_for_flow **afs;
1023     struct actions_for_flow *af;
1024     struct nlattr *a;
1025     size_t n_afs;
1026     struct ds s;
1027     int left;
1028     int i;
1029
1030     ds_init(&s);
1031
1032     simap_init(&port_names);
1033     for (i = 3; i < argc; i++) {
1034         char name[16];
1035         int number;
1036         int n = -1;
1037
1038         if (sscanf(argv[i], "%15[^=]=%d%n", name, &number, &n) > 0 && n > 0) {
1039             uintptr_t n = number;
1040             simap_put(&port_names, name, n);
1041         } else {
1042             ovs_fatal(0, "%s: expected NAME=NUMBER", argv[i]);
1043         }
1044     }
1045
1046     /* Parse flow key. */
1047     ofpbuf_init(&keybuf, 0);
1048     run(odp_flow_from_string(argv[1], &port_names, &keybuf, NULL),
1049         "odp_flow_key_from_string");
1050
1051     ds_clear(&s);
1052     odp_flow_format(keybuf.data, keybuf.size, NULL, 0, &s);
1053     printf("input flow: %s\n", ds_cstr(&s));
1054
1055     run(odp_flow_key_to_flow(keybuf.data, keybuf.size, &flow),
1056         "odp_flow_key_to_flow");
1057     ofpbuf_uninit(&keybuf);
1058
1059     /* Parse actions. */
1060     ofpbuf_init(&odp_actions, 0);
1061     run(odp_actions_from_string(argv[2], &port_names, &odp_actions),
1062         "odp_actions_from_string");
1063
1064     if (verbosity) {
1065         ds_clear(&s);
1066         format_odp_actions(&s, odp_actions.data, odp_actions.size);
1067         printf("input actions: %s\n", ds_cstr(&s));
1068     }
1069
1070     hmap_init(&actions_per_flow);
1071     NL_ATTR_FOR_EACH (a, left, odp_actions.data, odp_actions.size) {
1072         const struct ovs_action_push_vlan *push;
1073         switch(nl_attr_type(a)) {
1074         case OVS_ACTION_ATTR_POP_VLAN:
1075             flow.vlan_tci = htons(0);
1076             continue;
1077
1078         case OVS_ACTION_ATTR_PUSH_VLAN:
1079             push = nl_attr_get_unspec(a, sizeof *push);
1080             flow.vlan_tci = push->vlan_tci;
1081             continue;
1082         }
1083
1084         af = get_actions_for_flow(&actions_per_flow, &flow);
1085         nl_msg_put_unspec(&af->actions, nl_attr_type(a),
1086                           nl_attr_get(a), nl_attr_get_size(a));
1087     }
1088
1089     n_afs = hmap_count(&actions_per_flow);
1090     afs = xmalloc(n_afs * sizeof *afs);
1091     i = 0;
1092     HMAP_FOR_EACH (af, hmap_node, &actions_per_flow) {
1093         afs[i++] = af;
1094     }
1095     ovs_assert(i == n_afs);
1096
1097     qsort(afs, n_afs, sizeof *afs, compare_actions_for_flow);
1098
1099     for (i = 0; i < n_afs; i++) {
1100         const struct actions_for_flow *af = afs[i];
1101
1102         sort_output_actions(af->actions.data, af->actions.size);
1103
1104         if (af->flow.vlan_tci != htons(0)) {
1105             printf("vlan(vid=%"PRIu16",pcp=%d): ",
1106                    vlan_tci_to_vid(af->flow.vlan_tci),
1107                    vlan_tci_to_pcp(af->flow.vlan_tci));
1108         } else {
1109             printf("no vlan: ");
1110         }
1111
1112         if (af->flow.mpls_depth) {
1113             printf("mpls(label=%"PRIu32",tc=%d,ttl=%d): ",
1114                    mpls_lse_to_label(af->flow.mpls_lse),
1115                    mpls_lse_to_tc(af->flow.mpls_lse),
1116                    mpls_lse_to_ttl(af->flow.mpls_lse));
1117         } else {
1118             printf("no mpls: ");
1119         }
1120
1121         ds_clear(&s);
1122         format_odp_actions(&s, af->actions.data, af->actions.size);
1123         puts(ds_cstr(&s));
1124     }
1125     ds_destroy(&s);
1126 }
1127
1128 static const struct command all_commands[] = {
1129     { "add-dp", 1, INT_MAX, dpctl_add_dp },
1130     { "del-dp", 1, 1, dpctl_del_dp },
1131     { "add-if", 2, INT_MAX, dpctl_add_if },
1132     { "del-if", 2, INT_MAX, dpctl_del_if },
1133     { "set-if", 2, INT_MAX, dpctl_set_if },
1134     { "dump-dps", 0, 0, dpctl_dump_dps },
1135     { "show", 0, INT_MAX, dpctl_show },
1136     { "dump-flows", 0, 1, dpctl_dump_flows },
1137     { "add-flow", 2, 3, dpctl_add_flow },
1138     { "mod-flow", 2, 3, dpctl_mod_flow },
1139     { "del-flow", 1, 2, dpctl_del_flow },
1140     { "del-flows", 0, 1, dpctl_del_flows },
1141     { "help", 0, INT_MAX, dpctl_help },
1142
1143     /* Undocumented commands for testing. */
1144     { "parse-actions", 1, INT_MAX, dpctl_parse_actions },
1145     { "normalize-actions", 2, INT_MAX, dpctl_normalize_actions },
1146
1147     { NULL, 0, 0, NULL },
1148 };