lib/dpctl.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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 <inttypes.h>
  21 #include <sys/socket.h>
  22 #include <net/if.h>
  23 #include <netinet/in.h>
  24 #include <stdarg.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <unistd.h>
  28
  29 #include "command-line.h"
  30 #include "compiler.h"
  31 #include "dirs.h"
  32 #include "dpctl.h"
  33 #include "dpif.h"
  34 #include "dynamic-string.h"
  35 #include "flow.h"
  36 #include "match.h"
  37 #include "netdev.h"
  38 #include "netlink.h"
  39 #include "odp-util.h"
  40 #include "ofp-parse.h"
  41 #include "ofpbuf.h"
  42 #include "packets.h"
  43 #include "shash.h"
  44 #include "simap.h"
  45 #include "smap.h"
  46 #include "sset.h"
  47 #include "timeval.h"
  48 #include "unixctl.h"
  49 #include "util.h"
  50
  51 typedef int dpctl_command_handler(int argc, const char *argv[],
  52                                   struct dpctl_params *);
  53 struct dpctl_command {
  54     const char *name;
  55     const char *usage;
  56     int min_args;
  57     int max_args;
  58     dpctl_command_handler *handler;
  59 };
  60 static const struct dpctl_command *get_all_dpctl_commands(void);
  61
  62 static void
  63 dpctl_puts(struct dpctl_params *dpctl_p, bool error, const char *string)
  64 {
  65     dpctl_p->output(dpctl_p->aux, error, string);
  66 }
  67
  68 static void
  69 dpctl_print(struct dpctl_params *dpctl_p, const char *fmt, ...)
  70 {
  71     char *string;
  72     va_list args;
  73
  74     va_start(args, fmt);
  75     string = xvasprintf(fmt, args);
  76     va_end(args);
  77
  78     dpctl_puts(dpctl_p, false, string);
  79     free(string);
  80 }
  81
  82 static void
  83 dpctl_error(struct dpctl_params* dpctl_p, int err_no, const char *fmt, ...)
  84 {
  85     const char *subprogram_name = get_subprogram_name();
  86     struct ds ds = DS_EMPTY_INITIALIZER;
  87     int save_errno = errno;
  88     va_list args;
  89
  90
  91     if (subprogram_name[0]) {
  92         ds_put_format(&ds, "%s(%s): ", program_name,subprogram_name);
  93     } else {
  94         ds_put_format(&ds, "%s: ", program_name);
  95     }
  96
  97     va_start(args, fmt);
  98     ds_put_format_valist(&ds, fmt, args);
  99     va_end(args);
 100
 101     if (err_no != 0) {
 102         ds_put_format(&ds, " (%s)", ovs_retval_to_string(err_no));
 103     }
 104     ds_put_cstr(&ds, "\n");
 105
 106     dpctl_puts(dpctl_p, true, ds_cstr(&ds));
 107
 108     ds_destroy(&ds);
 109
 110     errno = save_errno;
 111 }
 112 \f
 113 static int dpctl_add_if(int argc, const char *argv[], struct dpctl_params *);
 114
 115 static int
 116 if_up(struct netdev *netdev)
 117 {
 118     return netdev_turn_flags_on(netdev, NETDEV_UP, NULL);
 119 }
 120
 121 /* Retrieve the name of the datapath if exactly one exists.  The caller
 122  * is responsible for freeing the returned string.  If there is not one
 123  * datapath, aborts with an error message. */
 124 static char *
 125 get_one_dp(struct dpctl_params *dpctl_p)
 126 {
 127     struct sset types;
 128     const char *type;
 129     char *dp_name = NULL;
 130     size_t count = 0;
 131
 132     sset_init(&types);
 133     dp_enumerate_types(&types);
 134     SSET_FOR_EACH (type, &types) {
 135         struct sset names;
 136
 137         sset_init(&names);
 138         if (!dp_enumerate_names(type, &names)) {
 139             count += sset_count(&names);
 140             if (!dp_name && count == 1) {
 141                 dp_name = xasprintf("%s@%s", type, SSET_FIRST(&names));
 142             }
 143         }
 144         sset_destroy(&names);
 145     }
 146     sset_destroy(&types);
 147
 148     if (!count) {
 149         dpctl_error(dpctl_p, 0, "no datapaths exist");
 150     } else if (count > 1) {
 151         dpctl_error(dpctl_p, 0, "multiple datapaths, specify one");
 152         free(dp_name);
 153         dp_name = NULL;
 154     }
 155
 156     return dp_name;
 157 }
 158
 159 static int
 160 parsed_dpif_open(const char *arg_, bool create, struct dpif **dpifp)
 161 {
 162     int result;
 163     char *name, *type;
 164
 165     dp_parse_name(arg_, &name, &type);
 166
 167     if (create) {
 168         result = dpif_create(name, type, dpifp);
 169     } else {
 170         result = dpif_open(name, type, dpifp);
 171     }
 172
 173     free(name);
 174     free(type);
 175     return result;
 176 }
 177
 178 static int
 179 dpctl_add_dp(int argc, const char *argv[],
 180              struct dpctl_params *dpctl_p)
 181 {
 182     struct dpif *dpif;
 183     int error;
 184
 185     error = parsed_dpif_open(argv[1], true, &dpif);
 186     if (error) {
 187         dpctl_error(dpctl_p, error, "add_dp");
 188         return error;
 189     }
 190     dpif_close(dpif);
 191     if (argc > 2) {
 192         error = dpctl_add_if(argc, argv, dpctl_p);
 193     }
 194     return error;
 195 }
 196
 197 static int
 198 dpctl_del_dp(int argc OVS_UNUSED, const char *argv[],
 199              struct dpctl_params *dpctl_p)
 200 {
 201     struct dpif *dpif;
 202     int error;
 203
 204     error = parsed_dpif_open(argv[1], false, &dpif);
 205     if (error) {
 206         dpctl_error(dpctl_p, error, "opening datapath");
 207         return error;
 208     }
 209     error = dpif_delete(dpif);
 210     if (error) {
 211         dpctl_error(dpctl_p, error, "del_dp");
 212     }
 213
 214     dpif_close(dpif);
 215     return error;
 216 }
 217
 218 static int
 219 dpctl_add_if(int argc OVS_UNUSED, const char *argv[],
 220              struct dpctl_params *dpctl_p)
 221 {
 222     struct dpif *dpif;
 223     int i, error, lasterror = 0;
 224
 225     error = parsed_dpif_open(argv[1], false, &dpif);
 226     if (error) {
 227         dpctl_error(dpctl_p, error, "opening datapath");
 228         return error;
 229     }
 230     for (i = 2; i < argc; i++) {
 231         const char *name, *type;
 232         char *save_ptr = NULL, *argcopy;
 233         struct netdev *netdev = NULL;
 234         struct smap args;
 235         odp_port_t port_no = ODPP_NONE;
 236         char *option;
 237
 238         argcopy = xstrdup(argv[i]);
 239         name = strtok_r(argcopy, ",", &save_ptr);
 240         type = "system";
 241
 242         if (!name) {
 243             dpctl_error(dpctl_p, 0, "%s is not a valid network device name",
 244                         argv[i]);
 245             error = EINVAL;
 246             goto next;
 247         }
 248
 249         smap_init(&args);
 250         while ((option = strtok_r(NULL, ",", &save_ptr)) != NULL) {
 251             char *save_ptr_2 = NULL;
 252             char *key, *value;
 253
 254             key = strtok_r(option, "=", &save_ptr_2);
 255             value = strtok_r(NULL, "", &save_ptr_2);
 256             if (!value) {
 257                 value = "";
 258             }
 259
 260             if (!strcmp(key, "type")) {
 261                 type = value;
 262             } else if (!strcmp(key, "port_no")) {
 263                 port_no = u32_to_odp(atoi(value));
 264             } else if (!smap_add_once(&args, key, value)) {
 265                 dpctl_error(dpctl_p, 0, "duplicate \"%s\" option", key);
 266             }
 267         }
 268
 269         error = netdev_open(name, type, &netdev);
 270         if (error) {
 271             dpctl_error(dpctl_p, error, "%s: failed to open network device",
 272                         name);
 273             goto next_destroy_args;
 274         }
 275
 276         error = netdev_set_config(netdev, &args, NULL);
 277         if (error) {
 278             goto next_destroy_args;
 279         }
 280
 281         error = dpif_port_add(dpif, netdev, &port_no);
 282         if (error) {
 283             dpctl_error(dpctl_p, error, "adding %s to %s failed", name,
 284                         argv[1]);
 285             goto next_destroy_args;
 286         }
 287
 288         error = if_up(netdev);
 289         if (error) {
 290             dpctl_error(dpctl_p, error, "%s: failed bringing interface up",
 291                         name);
 292         }
 293
 294 next_destroy_args:
 295         netdev_close(netdev);
 296         smap_destroy(&args);
 297 next:
 298         free(argcopy);
 299         if (error) {
 300             lasterror = error;
 301         }
 302     }
 303     dpif_close(dpif);
 304
 305     return lasterror;
 306 }
 307
 308 static int
 309 dpctl_set_if(int argc, const char *argv[], struct dpctl_params *dpctl_p)
 310 {
 311     struct dpif *dpif;
 312     int i, error, lasterror = 0;
 313
 314     error = parsed_dpif_open(argv[1], false, &dpif);
 315     if (error) {
 316         dpctl_error(dpctl_p, error, "opening datapath");
 317         return error;
 318     }
 319     for (i = 2; i < argc; i++) {
 320         struct netdev *netdev = NULL;
 321         struct dpif_port dpif_port;
 322         char *save_ptr = NULL;
 323         char *type = NULL;
 324         char *argcopy;
 325         const char *name;
 326         struct smap args;
 327         odp_port_t port_no;
 328         char *option;
 329         int error = 0;
 330
 331         argcopy = xstrdup(argv[i]);
 332         name = strtok_r(argcopy, ",", &save_ptr);
 333         if (!name) {
 334             dpctl_error(dpctl_p, 0, "%s is not a valid network device name",
 335                         argv[i]);
 336             goto next;
 337         }
 338
 339         /* Get the port's type from the datapath. */
 340         error = dpif_port_query_by_name(dpif, name, &dpif_port);
 341         if (error) {
 342             dpctl_error(dpctl_p, error, "%s: failed to query port in %s", name,
 343                         argv[1]);
 344             goto next;
 345         }
 346         type = xstrdup(dpif_port.type);
 347         port_no = dpif_port.port_no;
 348         dpif_port_destroy(&dpif_port);
 349
 350         /* Retrieve its existing configuration. */
 351         error = netdev_open(name, type, &netdev);
 352         if (error) {
 353             dpctl_error(dpctl_p, error, "%s: failed to open network device",
 354                         name);
 355             goto next;
 356         }
 357
 358         smap_init(&args);
 359         error = netdev_get_config(netdev, &args);
 360         if (error) {
 361             dpctl_error(dpctl_p, error, "%s: failed to fetch configuration",
 362                         name);
 363             goto next_destroy_args;
 364         }
 365
 366         /* Parse changes to configuration. */
 367         while ((option = strtok_r(NULL, ",", &save_ptr)) != NULL) {
 368             char *save_ptr_2 = NULL;
 369             char *key, *value;
 370
 371             key = strtok_r(option, "=", &save_ptr_2);
 372             value = strtok_r(NULL, "", &save_ptr_2);
 373             if (!value) {
 374                 value = "";
 375             }
 376
 377             if (!strcmp(key, "type")) {
 378                 if (strcmp(value, type)) {
 379                     dpctl_error(dpctl_p, 0,
 380                                 "%s: can't change type from %s to %s",
 381                                  name, type, value);
 382                     error = EINVAL;
 383                 }
 384             } else if (!strcmp(key, "port_no")) {
 385                 if (port_no != u32_to_odp(atoi(value))) {
 386                     dpctl_error(dpctl_p, 0, "%s: can't change port number from"
 387                               " %"PRIu32" to %d", name, port_no, atoi(value));
 388                     error = EINVAL;
 389                 }
 390             } else if (value[0] == '\0') {
 391                 smap_remove(&args, key);
 392             } else {
 393                 smap_replace(&args, key, value);
 394             }
 395         }
 396
 397         /* Update configuration. */
 398         error = netdev_set_config(netdev, &args, NULL);
 399         if (error) {
 400             goto next_destroy_args;
 401         }
 402
 403 next_destroy_args:
 404         smap_destroy(&args);
 405 next:
 406         netdev_close(netdev);
 407         free(type);
 408         free(argcopy);
 409         if (error) {
 410             lasterror = error;
 411         }
 412     }
 413     dpif_close(dpif);
 414
 415     return lasterror;
 416 }
 417
 418 static bool
 419 get_port_number(struct dpif *dpif, const char *name, odp_port_t *port,
 420                 struct dpctl_params *dpctl_p)
 421 {
 422     struct dpif_port dpif_port;
 423
 424     if (!dpif_port_query_by_name(dpif, name, &dpif_port)) {
 425         *port = dpif_port.port_no;
 426         dpif_port_destroy(&dpif_port);
 427         return true;
 428     } else {
 429         dpctl_error(dpctl_p, 0, "no port named %s", name);
 430         return false;
 431     }
 432 }
 433
 434 static int
 435 dpctl_del_if(int argc, const char *argv[], struct dpctl_params *dpctl_p)
 436 {
 437     struct dpif *dpif;
 438     int i, error, lasterror = 0;
 439
 440     error = parsed_dpif_open(argv[1], false, &dpif);
 441     if (error) {
 442         dpctl_error(dpctl_p, error, "opening datapath");
 443         return error;
 444     }
 445     for (i = 2; i < argc; i++) {
 446         const char *name = argv[i];
 447         odp_port_t port;
 448
 449         if (!name[strspn(name, "0123456789")]) {
 450             port = u32_to_odp(atoi(name));
 451         } else if (!get_port_number(dpif, name, &port, dpctl_p)) {
 452             lasterror = ENOENT;
 453             continue;
 454         }
 455
 456         error = dpif_port_del(dpif, port);
 457         if (error) {
 458             dpctl_error(dpctl_p, error, "deleting port %s from %s failed",
 459                         name, argv[1]);
 460             lasterror = error;
 461         }
 462     }
 463     dpif_close(dpif);
 464     return lasterror;
 465 }
 466
 467 static void
 468 print_stat(struct dpctl_params *dpctl_p, const char *leader, uint64_t value)
 469 {
 470     dpctl_print(dpctl_p, "%s", leader);
 471     if (value != UINT64_MAX) {
 472         dpctl_print(dpctl_p, "%"PRIu64, value);
 473     } else {
 474         dpctl_print(dpctl_p, "?");
 475     }
 476 }
 477
 478 static void
 479 print_human_size(struct dpctl_params *dpctl_p, uint64_t value)
 480 {
 481     if (value == UINT64_MAX) {
 482         /* Nothing to do. */
 483     } else if (value >= 1024ULL * 1024 * 1024 * 1024) {
 484         dpctl_print(dpctl_p, " (%.1f TiB)",
 485                     value / (1024.0 * 1024 * 1024 * 1024));
 486     } else if (value >= 1024ULL * 1024 * 1024) {
 487         dpctl_print(dpctl_p, " (%.1f GiB)", value / (1024.0 * 1024 * 1024));
 488     } else if (value >= 1024ULL * 1024) {
 489         dpctl_print(dpctl_p, " (%.1f MiB)", value / (1024.0 * 1024));
 490     } else if (value >= 1024) {
 491         dpctl_print(dpctl_p, " (%.1f KiB)", value / 1024.0);
 492     }
 493 }
 494
 495 static void
 496 show_dpif(struct dpif *dpif, struct dpctl_params *dpctl_p)
 497 {
 498     struct dpif_port_dump dump;
 499     struct dpif_port dpif_port;
 500     struct dpif_dp_stats stats;
 501     struct netdev *netdev;
 502
 503     dpctl_print(dpctl_p, "%s:\n", dpif_name(dpif));
 504     if (!dpif_get_dp_stats(dpif, &stats)) {
 505         dpctl_print(dpctl_p, "\tlookups: hit:%"PRIu64" missed:%"PRIu64
 506                              " lost:%"PRIu64"\n\tflows: %"PRIu64"\n",
 507                     stats.n_hit, stats.n_missed, stats.n_lost, stats.n_flows);
 508         if (stats.n_masks != UINT32_MAX) {
 509             uint64_t n_pkts = stats.n_hit + stats.n_missed;
 510             double avg = n_pkts ? (double) stats.n_mask_hit / n_pkts : 0.0;
 511
 512             dpctl_print(dpctl_p, "\tmasks: hit:%"PRIu64" total:%"PRIu32
 513                                  " hit/pkt:%.2f\n",
 514                         stats.n_mask_hit, stats.n_masks, avg);
 515         }
 516     }
 517
 518     DPIF_PORT_FOR_EACH (&dpif_port, &dump, dpif) {
 519         dpctl_print(dpctl_p, "\tport %u: %s",
 520                     dpif_port.port_no, dpif_port.name);
 521
 522         if (strcmp(dpif_port.type, "system")) {
 523             int error;
 524
 525             dpctl_print(dpctl_p, " (%s", dpif_port.type);
 526
 527             error = netdev_open(dpif_port.name, dpif_port.type, &netdev);
 528             if (!error) {
 529                 struct smap config;
 530
 531                 smap_init(&config);
 532                 error = netdev_get_config(netdev, &config);
 533                 if (!error) {
 534                     const struct smap_node **nodes;
 535                     size_t i;
 536
 537                     nodes = smap_sort(&config);
 538                     for (i = 0; i < smap_count(&config); i++) {
 539                         const struct smap_node *node = nodes[i];
 540                         dpctl_print(dpctl_p, "%c %s=%s", i ? ',' : ':',
 541                                     node->key, node->value);
 542                     }
 543                     free(nodes);
 544                 } else {
 545                     dpctl_print(dpctl_p, ", could not retrieve configuration "
 546                                          "(%s)",  ovs_strerror(error));
 547                 }
 548                 smap_destroy(&config);
 549
 550                 netdev_close(netdev);
 551             } else {
 552                 dpctl_print(dpctl_p, ": open failed (%s)",
 553                             ovs_strerror(error));
 554             }
 555             dpctl_print(dpctl_p, ")");
 556         }
 557         dpctl_print(dpctl_p, "\n");
 558
 559         if (dpctl_p->print_statistics) {
 560             struct netdev_stats s;
 561             int error;
 562
 563             error = netdev_open(dpif_port.name, dpif_port.type, &netdev);
 564             if (error) {
 565                 dpctl_print(dpctl_p, ", open failed (%s)",
 566                             ovs_strerror(error));
 567                 continue;
 568             }
 569             error = netdev_get_stats(netdev, &s);
 570             if (!error) {
 571                 netdev_close(netdev);
 572                 print_stat(dpctl_p, "\t\tRX packets:", s.rx_packets);
 573                 print_stat(dpctl_p, " errors:", s.rx_errors);
 574                 print_stat(dpctl_p, " dropped:", s.rx_dropped);
 575                 print_stat(dpctl_p, " overruns:", s.rx_over_errors);
 576                 print_stat(dpctl_p, " frame:", s.rx_frame_errors);
 577                 dpctl_print(dpctl_p, "\n");
 578
 579                 print_stat(dpctl_p, "\t\tTX packets:", s.tx_packets);
 580                 print_stat(dpctl_p, " errors:", s.tx_errors);
 581                 print_stat(dpctl_p, " dropped:", s.tx_dropped);
 582                 print_stat(dpctl_p, " aborted:", s.tx_aborted_errors);
 583                 print_stat(dpctl_p, " carrier:", s.tx_carrier_errors);
 584                 dpctl_print(dpctl_p, "\n");
 585
 586                 print_stat(dpctl_p, "\t\tcollisions:", s.collisions);
 587                 dpctl_print(dpctl_p, "\n");
 588
 589                 print_stat(dpctl_p, "\t\tRX bytes:", s.rx_bytes);
 590                 print_human_size(dpctl_p, s.rx_bytes);
 591                 print_stat(dpctl_p, "  TX bytes:", s.tx_bytes);
 592                 print_human_size(dpctl_p, s.tx_bytes);
 593                 dpctl_print(dpctl_p, "\n");
 594             } else {
 595                 dpctl_print(dpctl_p, ", could not retrieve stats (%s)",
 596                             ovs_strerror(error));
 597             }
 598         }
 599     }
 600     dpif_close(dpif);
 601 }
 602
 603 static int
 604 dpctl_show(int argc, const char *argv[], struct dpctl_params *dpctl_p)
 605 {
 606     int error, lasterror = 0;
 607     if (argc > 1) {
 608         int i;
 609         for (i = 1; i < argc; i++) {
 610             const char *name = argv[i];
 611             struct dpif *dpif;
 612
 613             error = parsed_dpif_open(name, false, &dpif);
 614             if (!error) {
 615                 show_dpif(dpif, dpctl_p);
 616             } else {
 617                 dpctl_error(dpctl_p, error, "opening datapath %s failed",
 618                             name);
 619                 lasterror = error;
 620             }
 621         }
 622     } else {
 623         struct sset types;
 624         const char *type;
 625
 626         sset_init(&types);
 627         dp_enumerate_types(&types);
 628         SSET_FOR_EACH (type, &types) {
 629             struct sset names;
 630             const char *name;
 631
 632             sset_init(&names);
 633             error = dp_enumerate_names(type, &names);
 634             if (error) {
 635                 lasterror = error;
 636                 goto next;
 637             }
 638             SSET_FOR_EACH (name, &names) {
 639                 struct dpif *dpif;
 640
 641                 error = dpif_open(name, type, &dpif);
 642                 if (!error) {
 643                     show_dpif(dpif, dpctl_p);
 644                 } else {
 645                     dpctl_error(dpctl_p, error, "opening datapath %s failed",
 646                                 name);
 647                     lasterror = error;
 648                 }
 649             }
 650 next:
 651             sset_destroy(&names);
 652         }
 653         sset_destroy(&types);
 654     }
 655     return lasterror;
 656 }
 657
 658 static int
 659 dpctl_dump_dps(int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
 660                struct dpctl_params *dpctl_p)
 661 {
 662     struct sset dpif_names, dpif_types;
 663     const char *type;
 664     int error, lasterror = 0;
 665
 666     sset_init(&dpif_names);
 667     sset_init(&dpif_types);
 668     dp_enumerate_types(&dpif_types);
 669
 670     SSET_FOR_EACH (type, &dpif_types) {
 671         const char *name;
 672
 673         error = dp_enumerate_names(type, &dpif_names);
 674         if (error) {
 675             lasterror = error;
 676         }
 677
 678         SSET_FOR_EACH (name, &dpif_names) {
 679             struct dpif *dpif;
 680             if (!dpif_open(name, type, &dpif)) {
 681                 dpctl_print(dpctl_p, "%s\n", dpif_name(dpif));
 682                 dpif_close(dpif);
 683             }
 684         }
 685     }
 686
 687     sset_destroy(&dpif_names);
 688     sset_destroy(&dpif_types);
 689     return lasterror;
 690 }
 691
 692 static void
 693 format_dpif_flow(struct ds *ds, const struct dpif_flow *f, struct hmap *ports,
 694                  struct dpctl_params *dpctl_p)
 695 {
 696     if (dpctl_p->verbosity) {
 697         if (f->ufid_present) {
 698             odp_format_ufid(&f->ufid, ds);
 699             ds_put_cstr(ds, ", ");
 700         } else {
 701             ds_put_cstr(ds, "ufid:<empty>, ");
 702         }
 703     }
 704     odp_flow_format(f->key, f->key_len, f->mask, f->mask_len, ports, ds,
 705                     dpctl_p->verbosity);
 706     ds_put_cstr(ds, ", ");
 707
 708     dpif_flow_stats_format(&f->stats, ds);
 709     ds_put_cstr(ds, ", actions:");
 710     format_odp_actions(ds, f->actions, f->actions_len);
 711 }
 712
 713 static int
 714 dpctl_dump_flows(int argc, const char *argv[], struct dpctl_params *dpctl_p)
 715 {
 716     struct dpif *dpif;
 717     struct ds ds;
 718     char *name;
 719
 720     char *filter = NULL;
 721     struct flow flow_filter;
 722     struct flow_wildcards wc_filter;
 723
 724     struct dpif_port_dump port_dump;
 725     struct dpif_port dpif_port;
 726     struct hmap portno_names;
 727     struct simap names_portno;
 728
 729     struct dpif_flow_dump_thread *flow_dump_thread;
 730     struct dpif_flow_dump *flow_dump;
 731     struct dpif_flow f;
 732
 733     int error;
 734
 735     if (argc > 1 && !strncmp(argv[argc - 1], "filter=", 7)) {
 736         filter = xstrdup(argv[--argc] + 7);
 737     }
 738     name = (argc == 2) ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
 739     if (!name) {
 740         error = EINVAL;
 741         goto out_freefilter;
 742     }
 743
 744     error = parsed_dpif_open(name, false, &dpif);
 745     free(name);
 746     if (error) {
 747         dpctl_error(dpctl_p, error, "opening datapath");
 748         goto out_freefilter;
 749     }
 750
 751
 752     hmap_init(&portno_names);
 753     simap_init(&names_portno);
 754     DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
 755         odp_portno_names_set(&portno_names, dpif_port.port_no, dpif_port.name);
 756         simap_put(&names_portno, dpif_port.name,
 757                   odp_to_u32(dpif_port.port_no));
 758     }
 759
 760     if (filter) {
 761         char *err = parse_ofp_exact_flow(&flow_filter, &wc_filter.masks,
 762                                          filter, &names_portno);
 763         if (err) {
 764             dpctl_error(dpctl_p, 0, "Failed to parse filter (%s)", err);
 765             error = EINVAL;
 766             goto out_dpifclose;
 767         }
 768     }
 769
 770     ds_init(&ds);
 771     flow_dump = dpif_flow_dump_create(dpif, false);
 772     flow_dump_thread = dpif_flow_dump_thread_create(flow_dump);
 773     while (dpif_flow_dump_next(flow_dump_thread, &f, 1)) {
 774         if (filter) {
 775             struct flow flow;
 776             struct flow_wildcards wc;
 777             struct match match, match_filter;
 778             struct minimatch minimatch;
 779
 780             odp_flow_key_to_flow(f.key, f.key_len, &flow);
 781             odp_flow_key_to_mask(f.mask, f.mask_len, &wc.masks, &flow);
 782             match_init(&match, &flow, &wc);
 783
 784             match_init(&match_filter, &flow_filter, &wc);
 785             match_init(&match_filter, &match_filter.flow, &wc_filter);
 786             minimatch_init(&minimatch, &match_filter);
 787
 788             if (!minimatch_matches_flow(&minimatch, &match.flow)) {
 789                 minimatch_destroy(&minimatch);
 790                 continue;
 791             }
 792             minimatch_destroy(&minimatch);
 793         }
 794         ds_clear(&ds);
 795         format_dpif_flow(&ds, &f, &portno_names, dpctl_p);
 796         dpctl_print(dpctl_p, "%s\n", ds_cstr(&ds));
 797     }
 798     dpif_flow_dump_thread_destroy(flow_dump_thread);
 799     error = dpif_flow_dump_destroy(flow_dump);
 800
 801     if (error) {
 802         dpctl_error(dpctl_p, error, "Failed to dump flows from datapath");
 803     }
 804     ds_destroy(&ds);
 805
 806 out_dpifclose:
 807     odp_portno_names_destroy(&portno_names);
 808     simap_destroy(&names_portno);
 809     hmap_destroy(&portno_names);
 810     dpif_close(dpif);
 811 out_freefilter:
 812     free(filter);
 813     return error;
 814 }
 815
 816 static int
 817 dpctl_put_flow(int argc, const char *argv[], enum dpif_flow_put_flags flags,
 818                struct dpctl_params *dpctl_p)
 819 {
 820     const char *key_s = argv[argc - 2];
 821     const char *actions_s = argv[argc - 1];
 822     struct dpif_flow_stats stats;
 823     struct dpif_port dpif_port;
 824     struct dpif_port_dump port_dump;
 825     struct ofpbuf actions;
 826     struct ofpbuf key;
 827     struct ofpbuf mask;
 828     struct dpif *dpif;
 829     ovs_u128 ufid;
 830     bool ufid_present;
 831     char *dp_name;
 832     struct simap port_names;
 833     int n, error;
 834
 835     dp_name = argc == 4 ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
 836     if (!dp_name) {
 837         return EINVAL;
 838     }
 839     error = parsed_dpif_open(dp_name, false, &dpif);
 840     free(dp_name);
 841     if (error) {
 842         dpctl_error(dpctl_p, error, "opening datapath");
 843         return error;
 844     }
 845
 846     ufid_present = false;
 847     n = odp_ufid_from_string(key_s, &ufid);
 848     if (n < 0) {
 849         dpctl_error(dpctl_p, -n, "parsing flow ufid");
 850         return -n;
 851     } else if (n) {
 852         key_s += n;
 853         ufid_present = true;
 854     }
 855
 856     simap_init(&port_names);
 857     DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
 858         simap_put(&port_names, dpif_port.name, odp_to_u32(dpif_port.port_no));
 859     }
 860
 861     ofpbuf_init(&key, 0);
 862     ofpbuf_init(&mask, 0);
 863     error = odp_flow_from_string(key_s, &port_names, &key, &mask);
 864     simap_destroy(&port_names);
 865     if (error) {
 866         dpctl_error(dpctl_p, error, "parsing flow key");
 867         goto out_freekeymask;
 868     }
 869
 870     ofpbuf_init(&actions, 0);
 871     error = odp_actions_from_string(actions_s, NULL, &actions);
 872     if (error) {
 873         dpctl_error(dpctl_p, error, "parsing actions");
 874         goto out_freeactions;
 875     }
 876     error = dpif_flow_put(dpif, flags,
 877                           ofpbuf_data(&key), ofpbuf_size(&key),
 878                           ofpbuf_size(&mask) == 0 ? NULL : ofpbuf_data(&mask),
 879                           ofpbuf_size(&mask),
 880                           ofpbuf_data(&actions), ofpbuf_size(&actions),
 881                           ufid_present ? &ufid : NULL,
 882                           dpctl_p->print_statistics ? &stats : NULL);
 883     if (error) {
 884         dpctl_error(dpctl_p, error, "updating flow table");
 885         goto out_freeactions;
 886     }
 887
 888     if (dpctl_p->print_statistics) {
 889         struct ds s;
 890
 891         ds_init(&s);
 892         dpif_flow_stats_format(&stats, &s);
 893         dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
 894         ds_destroy(&s);
 895     }
 896
 897 out_freeactions:
 898     ofpbuf_uninit(&actions);
 899 out_freekeymask:
 900     ofpbuf_uninit(&mask);
 901     ofpbuf_uninit(&key);
 902     dpif_close(dpif);
 903     return error;
 904 }
 905
 906 static int
 907 dpctl_add_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
 908 {
 909     return dpctl_put_flow(argc, argv, DPIF_FP_CREATE, dpctl_p);
 910 }
 911
 912 static int
 913 dpctl_mod_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
 914 {
 915     enum dpif_flow_put_flags flags;
 916
 917     flags = DPIF_FP_MODIFY;
 918     if (dpctl_p->may_create) {
 919         flags |= DPIF_FP_CREATE;
 920     }
 921     if (dpctl_p->zero_statistics) {
 922         flags |= DPIF_FP_ZERO_STATS;
 923     }
 924
 925     return dpctl_put_flow(argc, argv, flags, dpctl_p);
 926 }
 927
 928 static int
 929 dpctl_get_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
 930 {
 931     const char *key_s = argv[argc - 1];
 932     struct dpif_flow flow;
 933     struct dpif_port dpif_port;
 934     struct dpif_port_dump port_dump;
 935     struct dpif *dpif;
 936     char *dp_name;
 937     struct hmap portno_names;
 938     ovs_u128 ufid;
 939     struct ofpbuf buf;
 940     uint64_t stub[DPIF_FLOW_BUFSIZE / 8];
 941     struct ds ds;
 942     int n, error;
 943
 944     dp_name = argc == 3 ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
 945     if (!dp_name) {
 946         return EINVAL;
 947     }
 948     error = parsed_dpif_open(dp_name, false, &dpif);
 949     free(dp_name);
 950     if (error) {
 951         dpctl_error(dpctl_p, error, "opening datapath");
 952         return error;
 953     }
 954
 955     ofpbuf_use_stub(&buf, &stub, sizeof stub);
 956     hmap_init(&portno_names);
 957     DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
 958         odp_portno_names_set(&portno_names, dpif_port.port_no, dpif_port.name);
 959     }
 960
 961     n = odp_ufid_from_string(key_s, &ufid);
 962     if (n <= 0) {
 963         dpctl_error(dpctl_p, -n, "parsing flow ufid");
 964         goto out;
 965     }
 966
 967     error = dpif_flow_get(dpif, NULL, 0, &ufid, &buf, &flow);
 968     if (error) {
 969         dpctl_error(dpctl_p, error, "getting flow");
 970         goto out;
 971     }
 972
 973     ds_init(&ds);
 974     format_dpif_flow(&ds, &flow, &portno_names, dpctl_p);
 975     dpctl_print(dpctl_p, "%s\n", ds_cstr(&ds));
 976     ds_destroy(&ds);
 977
 978 out:
 979     odp_portno_names_destroy(&portno_names);
 980     hmap_destroy(&portno_names);
 981     ofpbuf_uninit(&buf);
 982     dpif_close(dpif);
 983     return error;
 984 }
 985
 986 static int
 987 dpctl_del_flow(int argc, const char *argv[], struct dpctl_params *dpctl_p)
 988 {
 989     const char *key_s = argv[argc - 1];
 990     struct dpif_flow_stats stats;
 991     struct dpif_port dpif_port;
 992     struct dpif_port_dump port_dump;
 993     struct ofpbuf key;
 994     struct ofpbuf mask; /* To be ignored. */
 995     struct dpif *dpif;
 996     ovs_u128 ufid;
 997     bool ufid_present;
 998     char *dp_name;
 999     struct simap port_names;
1000     int n, error;
1001
1002     dp_name = argc == 3 ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
1003     if (!dp_name) {
1004         return EINVAL;
1005     }
1006     error = parsed_dpif_open(dp_name, false, &dpif);
1007     free(dp_name);
1008     if (error) {
1009         dpctl_error(dpctl_p, error, "opening datapath");
1010         return error;
1011     }
1012
1013     ufid_present = false;
1014     n = odp_ufid_from_string(key_s, &ufid);
1015     if (n < 0) {
1016         dpctl_error(dpctl_p, -n, "parsing flow ufid");
1017         return -n;
1018     } else if (n) {
1019         key_s += n;
1020         ufid_present = true;
1021     }
1022
1023     simap_init(&port_names);
1024     DPIF_PORT_FOR_EACH (&dpif_port, &port_dump, dpif) {
1025         simap_put(&port_names, dpif_port.name, odp_to_u32(dpif_port.port_no));
1026     }
1027
1028     ofpbuf_init(&key, 0);
1029     ofpbuf_init(&mask, 0);
1030
1031     error = odp_flow_from_string(key_s, &port_names, &key, &mask);
1032     if (error) {
1033         dpctl_error(dpctl_p, error, "parsing flow key");
1034         goto out;
1035     }
1036
1037     error = dpif_flow_del(dpif,
1038                           ofpbuf_data(&key), ofpbuf_size(&key),
1039                           ufid_present ? &ufid : NULL,
1040                           dpctl_p->print_statistics ? &stats : NULL);
1041     if (error) {
1042         dpctl_error(dpctl_p, error, "deleting flow");
1043         if (error == ENOENT && !ufid_present) {
1044             struct ds s;
1045
1046             ds_init(&s);
1047             ds_put_format(&s, "Perhaps you need to specify a UFID?");
1048             dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
1049             ds_destroy(&s);
1050         }
1051         goto out;
1052     }
1053
1054     if (dpctl_p->print_statistics) {
1055         struct ds s;
1056
1057         ds_init(&s);
1058         dpif_flow_stats_format(&stats, &s);
1059         dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
1060         ds_destroy(&s);
1061     }
1062
1063 out:
1064     ofpbuf_uninit(&mask);
1065     ofpbuf_uninit(&key);
1066     simap_destroy(&port_names);
1067     dpif_close(dpif);
1068     return error;
1069 }
1070
1071 static int
1072 dpctl_del_flows(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1073 {
1074     struct dpif *dpif;
1075     char *name;
1076     int error;
1077
1078     name = (argc == 2) ? xstrdup(argv[1]) : get_one_dp(dpctl_p);
1079     if (!name) {
1080         return EINVAL;
1081     }
1082     error = parsed_dpif_open(name, false, &dpif);
1083     free(name);
1084     if (error) {
1085         dpctl_error(dpctl_p, error, "opening datapath");
1086         return error;
1087     }
1088
1089     error = dpif_flow_flush(dpif);
1090     if (error) {
1091         dpctl_error(dpctl_p, error, "deleting all flows");
1092     }
1093     dpif_close(dpif);
1094     return error;
1095 }
1096
1097 static int
1098 dpctl_help(int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
1099            struct dpctl_params *dpctl_p)
1100 {
1101     if (dpctl_p->usage) {
1102         dpctl_p->usage(dpctl_p->aux);
1103     }
1104
1105     return 0;
1106 }
1107
1108 static int
1109 dpctl_list_commands(int argc OVS_UNUSED, const char *argv[] OVS_UNUSED,
1110                     struct dpctl_params *dpctl_p)
1111 {
1112     struct ds ds = DS_EMPTY_INITIALIZER;
1113     const struct dpctl_command *commands = get_all_dpctl_commands();
1114
1115     ds_put_cstr(&ds, "The available commands are:\n");
1116     for (; commands->name; commands++) {
1117         const struct dpctl_command *c = commands;
1118
1119         ds_put_format(&ds, "  %s%-23s %s\n", dpctl_p->is_appctl ? "dpctl/" : "",
1120                       c->name, c->usage);
1121     }
1122     dpctl_puts(dpctl_p, false, ds.string);
1123     ds_destroy(&ds);
1124
1125     return 0;
1126 }
1127 \f
1128 /* Undocumented commands for unit testing. */
1129
1130 static int
1131 dpctl_parse_actions(int argc, const char *argv[], struct dpctl_params* dpctl_p)
1132 {
1133     int i, error = 0;
1134
1135     for (i = 1; i < argc; i++) {
1136         struct ofpbuf actions;
1137         struct ds s;
1138
1139         ofpbuf_init(&actions, 0);
1140         error = odp_actions_from_string(argv[i], NULL, &actions);
1141
1142         if (error) {
1143             ofpbuf_uninit(&actions);
1144             dpctl_error(dpctl_p, error, "odp_actions_from_string");
1145             return error;
1146         }
1147
1148         ds_init(&s);
1149         format_odp_actions(&s, ofpbuf_data(&actions), ofpbuf_size(&actions));
1150         dpctl_print(dpctl_p, "%s\n", ds_cstr(&s));
1151         ds_destroy(&s);
1152
1153         ofpbuf_uninit(&actions);
1154     }
1155
1156     return error;
1157 }
1158
1159 struct actions_for_flow {
1160     struct hmap_node hmap_node;
1161     struct flow flow;
1162     struct ofpbuf actions;
1163 };
1164
1165 static struct actions_for_flow *
1166 get_actions_for_flow(struct hmap *actions_per_flow, const struct flow *flow)
1167 {
1168     uint32_t hash = flow_hash(flow, 0);
1169     struct actions_for_flow *af;
1170
1171     HMAP_FOR_EACH_WITH_HASH (af, hmap_node, hash, actions_per_flow) {
1172         if (flow_equal(&af->flow, flow)) {
1173             return af;
1174         }
1175     }
1176
1177     af = xmalloc(sizeof *af);
1178     af->flow = *flow;
1179     ofpbuf_init(&af->actions, 0);
1180     hmap_insert(actions_per_flow, &af->hmap_node, hash);
1181     return af;
1182 }
1183
1184 static int
1185 compare_actions_for_flow(const void *a_, const void *b_)
1186 {
1187     struct actions_for_flow *const *a = a_;
1188     struct actions_for_flow *const *b = b_;
1189
1190     return flow_compare_3way(&(*a)->flow, &(*b)->flow);
1191 }
1192
1193 static int
1194 compare_output_actions(const void *a_, const void *b_)
1195 {
1196     const struct nlattr *a = a_;
1197     const struct nlattr *b = b_;
1198     uint32_t a_port = nl_attr_get_u32(a);
1199     uint32_t b_port = nl_attr_get_u32(b);
1200
1201     return a_port < b_port ? -1 : a_port > b_port;
1202 }
1203
1204 static void
1205 sort_output_actions__(struct nlattr *first, struct nlattr *end)
1206 {
1207     size_t bytes = (uint8_t *) end - (uint8_t *) first;
1208     size_t n = bytes / NL_A_U32_SIZE;
1209
1210     ovs_assert(bytes % NL_A_U32_SIZE == 0);
1211     qsort(first, n, NL_A_U32_SIZE, compare_output_actions);
1212 }
1213
1214 static void
1215 sort_output_actions(struct nlattr *actions, size_t length)
1216 {
1217     struct nlattr *first_output = NULL;
1218     struct nlattr *a;
1219     int left;
1220
1221     NL_ATTR_FOR_EACH (a, left, actions, length) {
1222         if (nl_attr_type(a) == OVS_ACTION_ATTR_OUTPUT) {
1223             if (!first_output) {
1224                 first_output = a;
1225             }
1226         } else {
1227             if (first_output) {
1228                 sort_output_actions__(first_output, a);
1229                 first_output = NULL;
1230             }
1231         }
1232     }
1233     if (first_output) {
1234         uint8_t *end = (uint8_t *) actions + length;
1235         sort_output_actions__(first_output,
1236                               ALIGNED_CAST(struct nlattr *, end));
1237     }
1238 }
1239
1240 /* usage: "ovs-dpctl normalize-actions FLOW ACTIONS" where FLOW and ACTIONS
1241  * have the syntax used by "ovs-dpctl dump-flows".
1242  *
1243  * This command prints ACTIONS in a format that shows what happens for each
1244  * VLAN, independent of the order of the ACTIONS.  For example, there is more
1245  * than one way to output a packet on VLANs 9 and 11, but this command will
1246  * print the same output for any form.
1247  *
1248  * The idea here generalizes beyond VLANs (e.g. to setting other fields) but
1249  * so far the implementation only covers VLANs. */
1250 static int
1251 dpctl_normalize_actions(int argc, const char *argv[],
1252                         struct dpctl_params *dpctl_p)
1253 {
1254     struct simap port_names;
1255     struct ofpbuf keybuf;
1256     struct flow flow;
1257     struct ofpbuf odp_actions;
1258     struct hmap actions_per_flow;
1259     struct actions_for_flow **afs;
1260     struct actions_for_flow *af;
1261     struct nlattr *a;
1262     size_t n_afs;
1263     struct ds s;
1264     int left;
1265     int i, error;
1266
1267     ds_init(&s);
1268
1269     simap_init(&port_names);
1270     for (i = 3; i < argc; i++) {
1271         char name[16];
1272         int number;
1273
1274         if (ovs_scan(argv[i], "%15[^=]=%d", name, &number)) {
1275             uintptr_t n = number;
1276             simap_put(&port_names, name, n);
1277         } else {
1278             dpctl_error(dpctl_p, 0, "%s: expected NAME=NUMBER", argv[i]);
1279             error = EINVAL;
1280             goto out;
1281         }
1282     }
1283
1284     /* Parse flow key. */
1285     ofpbuf_init(&keybuf, 0);
1286     error = odp_flow_from_string(argv[1], &port_names, &keybuf, NULL);
1287     if (error) {
1288         dpctl_error(dpctl_p, error, "odp_flow_key_from_string");
1289         goto out_freekeybuf;
1290     }
1291
1292     ds_clear(&s);
1293     odp_flow_format(ofpbuf_data(&keybuf), ofpbuf_size(&keybuf), NULL, 0, NULL,
1294                     &s, dpctl_p->verbosity);
1295     dpctl_print(dpctl_p, "input flow: %s\n", ds_cstr(&s));
1296
1297     error = odp_flow_key_to_flow(ofpbuf_data(&keybuf), ofpbuf_size(&keybuf),
1298                                  &flow);
1299     if (error) {
1300         dpctl_error(dpctl_p, error, "odp_flow_key_to_flow");
1301         goto out_freekeybuf;
1302     }
1303
1304     /* Parse actions. */
1305     ofpbuf_init(&odp_actions, 0);
1306     error = odp_actions_from_string(argv[2], &port_names, &odp_actions);
1307     if (error) {
1308         dpctl_error(dpctl_p, error, "odp_actions_from_string");
1309         goto out_freeactions;
1310     }
1311
1312     if (dpctl_p->verbosity) {
1313         ds_clear(&s);
1314         format_odp_actions(&s, ofpbuf_data(&odp_actions),
1315                            ofpbuf_size(&odp_actions));
1316         dpctl_print(dpctl_p, "input actions: %s\n", ds_cstr(&s));
1317     }
1318
1319     hmap_init(&actions_per_flow);
1320     NL_ATTR_FOR_EACH (a, left, ofpbuf_data(&odp_actions),
1321                       ofpbuf_size(&odp_actions)) {
1322         const struct ovs_action_push_vlan *push;
1323         switch(nl_attr_type(a)) {
1324         case OVS_ACTION_ATTR_POP_VLAN:
1325             flow.vlan_tci = htons(0);
1326             continue;
1327
1328         case OVS_ACTION_ATTR_PUSH_VLAN:
1329             push = nl_attr_get_unspec(a, sizeof *push);
1330             flow.vlan_tci = push->vlan_tci;
1331             continue;
1332         }
1333
1334         af = get_actions_for_flow(&actions_per_flow, &flow);
1335         nl_msg_put_unspec(&af->actions, nl_attr_type(a),
1336                           nl_attr_get(a), nl_attr_get_size(a));
1337     }
1338
1339     n_afs = hmap_count(&actions_per_flow);
1340     afs = xmalloc(n_afs * sizeof *afs);
1341     i = 0;
1342     HMAP_FOR_EACH (af, hmap_node, &actions_per_flow) {
1343         afs[i++] = af;
1344     }
1345
1346     ovs_assert(i == n_afs);
1347     hmap_destroy(&actions_per_flow);
1348
1349     qsort(afs, n_afs, sizeof *afs, compare_actions_for_flow);
1350
1351     for (i = 0; i < n_afs; i++) {
1352         struct actions_for_flow *af = afs[i];
1353
1354         sort_output_actions(ofpbuf_data(&af->actions),
1355                             ofpbuf_size(&af->actions));
1356
1357         if (af->flow.vlan_tci != htons(0)) {
1358             dpctl_print(dpctl_p, "vlan(vid=%"PRIu16",pcp=%d): ",
1359                         vlan_tci_to_vid(af->flow.vlan_tci),
1360                         vlan_tci_to_pcp(af->flow.vlan_tci));
1361         } else {
1362             dpctl_print(dpctl_p, "no vlan: ");
1363         }
1364
1365         if (eth_type_mpls(af->flow.dl_type)) {
1366             dpctl_print(dpctl_p, "mpls(label=%"PRIu32",tc=%d,ttl=%d): ",
1367                         mpls_lse_to_label(af->flow.mpls_lse[0]),
1368                         mpls_lse_to_tc(af->flow.mpls_lse[0]),
1369                         mpls_lse_to_ttl(af->flow.mpls_lse[0]));
1370         } else {
1371             dpctl_print(dpctl_p, "no mpls: ");
1372         }
1373
1374         ds_clear(&s);
1375         format_odp_actions(&s, ofpbuf_data(&af->actions),
1376                            ofpbuf_size(&af->actions));
1377         dpctl_print(dpctl_p, ds_cstr(&s));
1378
1379         ofpbuf_uninit(&af->actions);
1380         free(af);
1381     }
1382     free(afs);
1383
1384
1385 out_freeactions:
1386     ofpbuf_uninit(&odp_actions);
1387 out_freekeybuf:
1388     ofpbuf_uninit(&keybuf);
1389 out:
1390     simap_destroy(&port_names);
1391     ds_destroy(&s);
1392
1393     return error;
1394 }
1395 \f
1396 static const struct dpctl_command all_commands[] = {
1397     { "add-dp", "add-dp dp [iface...]", 1, INT_MAX, dpctl_add_dp },
1398     { "del-dp", "del-dp dp", 1, 1, dpctl_del_dp },
1399     { "add-if", "add-if dp iface...", 2, INT_MAX, dpctl_add_if },
1400     { "del-if", "del-if dp iface...", 2, INT_MAX, dpctl_del_if },
1401     { "set-if", "set-if dp iface...", 2, INT_MAX, dpctl_set_if },
1402     { "dump-dps", "", 0, 0, dpctl_dump_dps },
1403     { "show", "[dp...]", 0, INT_MAX, dpctl_show },
1404     { "dump-flows", "[dp]", 0, 2, dpctl_dump_flows },
1405     { "add-flow", "add-flow [dp] flow actions", 2, 3, dpctl_add_flow },
1406     { "mod-flow", "mod-flow [dp] flow actions", 2, 3, dpctl_mod_flow },
1407     { "get-flow", "get-flow [dp] ufid", 1, 2, dpctl_get_flow },
1408     { "del-flow", "del-flow [dp] flow", 1, 2, dpctl_del_flow },
1409     { "del-flows", "[dp]", 0, 1, dpctl_del_flows },
1410     { "help", "", 0, INT_MAX, dpctl_help },
1411     { "list-commands", "", 0, INT_MAX, dpctl_list_commands },
1412
1413     /* Undocumented commands for testing. */
1414     { "parse-actions", "actions", 1, INT_MAX, dpctl_parse_actions },
1415     { "normalize-actions", "actions", 2, INT_MAX, dpctl_normalize_actions },
1416
1417     { NULL, NULL, 0, 0, NULL },
1418 };
1419
1420 static const struct dpctl_command *get_all_dpctl_commands(void)
1421 {
1422     return all_commands;
1423 }
1424
1425 /* Runs the command designated by argv[0] within the command table specified by
1426  * 'commands', which must be terminated by a command whose 'name' member is a
1427  * null pointer. */
1428 int
1429 dpctl_run_command(int argc, const char *argv[], struct dpctl_params *dpctl_p)
1430 {
1431     const struct dpctl_command *p;
1432
1433     if (argc < 1) {
1434         dpctl_error(dpctl_p, 0, "missing command name; use --help for help");
1435         return EINVAL;
1436     }
1437
1438     for (p = all_commands; p->name != NULL; p++) {
1439         if (!strcmp(p->name, argv[0])) {
1440             int n_arg = argc - 1;
1441             if (n_arg < p->min_args) {
1442                 dpctl_error(dpctl_p, 0,
1443                             "'%s' command requires at least %d arguments",
1444                             p->name, p->min_args);
1445                 return EINVAL;
1446             } else if (n_arg > p->max_args) {
1447                 dpctl_error(dpctl_p, 0,
1448                             "'%s' command takes at most %d arguments",
1449                             p->name, p->max_args);
1450                 return EINVAL;
1451             } else {
1452                 return p->handler(argc, argv, dpctl_p);
1453             }
1454         }
1455     }
1456
1457     dpctl_error(dpctl_p, 0, "unknown command '%s'; use --help for help",
1458                 argv[0]);
1459     return EINVAL;
1460 }
1461 \f
1462 static void
1463 dpctl_unixctl_print(void *userdata, bool error OVS_UNUSED, const char *msg)
1464 {
1465     struct ds *ds = userdata;
1466     ds_put_cstr(ds, msg);
1467 }
1468
1469 static void
1470 dpctl_unixctl_handler(struct unixctl_conn *conn, int argc, const char *argv[],
1471                       void *aux)
1472 {
1473     struct ds ds = DS_EMPTY_INITIALIZER;
1474     struct dpctl_params dpctl_p;
1475     bool opt_parse_err = false;
1476
1477     dpctl_command_handler *handler = (dpctl_command_handler *) aux;
1478
1479     dpctl_p.print_statistics = false;
1480     dpctl_p.zero_statistics = false;
1481     dpctl_p.may_create = false;
1482     dpctl_p.verbosity = 0;
1483
1484     /* Parse options (like getopt). Unfortunately it does
1485      * not seem a good idea to call getopt_long() here, since it uses global
1486      * variables */
1487     while (argc > 1 && !opt_parse_err) {
1488         const char *arg = argv[1];
1489         if (!strncmp(arg, "--", 2)) {
1490             /* Long option */
1491             if (!strcmp(arg, "--statistics")) {
1492                 dpctl_p.print_statistics = true;
1493             } else if (!strcmp(arg, "--clear")) {
1494                 dpctl_p.zero_statistics = true;
1495             } else if (!strcmp(arg, "--may-create")) {
1496                 dpctl_p.may_create = true;
1497             } else if (!strcmp(arg, "--more")) {
1498                 dpctl_p.verbosity++;
1499             } else {
1500                 ds_put_format(&ds, "Unrecognized option %s", argv[1]);
1501                 opt_parse_err = true;
1502             }
1503         } else if (arg[0] == '-' && arg[1] != '\0') {
1504             /* Short option[s] */
1505             const char *opt = &arg[1];
1506
1507             while (*opt && !opt_parse_err) {
1508                 switch (*opt) {
1509                 case 'm':
1510                     dpctl_p.verbosity++;
1511                     break;
1512                 case 's':
1513                     dpctl_p.print_statistics = true;
1514                     break;
1515                 default:
1516                     ds_put_format(&ds, "Unrecognized option -%c", *opt);
1517                     opt_parse_err = true;
1518                     break;
1519                 }
1520                 opt++;
1521             }
1522         } else {
1523             /* Doesn't start with -, not an option */
1524             break;
1525         }
1526
1527         if (opt_parse_err) {
1528             break;
1529         }
1530         argv++;
1531         argc--;
1532     }
1533
1534     if (!opt_parse_err) {
1535         dpctl_p.is_appctl = true;
1536         dpctl_p.output = dpctl_unixctl_print;
1537         dpctl_p.aux = &ds;
1538
1539         handler(argc, argv, &dpctl_p);
1540     }
1541
1542     unixctl_command_reply(conn, ds_cstr(&ds));
1543
1544     ds_destroy(&ds);
1545 }
1546
1547 void
1548 dpctl_unixctl_register(void)
1549 {
1550     const struct dpctl_command *p;
1551
1552     for (p = all_commands; p->name != NULL; p++) {
1553         char *cmd_name = xasprintf("dpctl/%s", p->name);
1554         unixctl_command_register(cmd_name, "", p->min_args, p->max_args,
1555                                  dpctl_unixctl_handler, p->handler);
1556         free(cmd_name);
1557     }
1558 }