lib/dpctl.c

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