utilities/ovs-ofctl.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 <ctype.h>
  19 #include <errno.h>
  20 #include <getopt.h>
  21 #include <inttypes.h>
  22 #include <sys/socket.h>
  23 #include <net/if.h>
  24 #include <signal.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <unistd.h>
  28 #include <fcntl.h>
  29 #include <sys/stat.h>
  30 #include <sys/time.h>
  31
  32 #include "byte-order.h"
  33 #include "classifier.h"
  34 #include "command-line.h"
  35 #include "daemon.h"
  36 #include "compiler.h"
  37 #include "dirs.h"
  38 #include "dynamic-string.h"
  39 #include "fatal-signal.h"
  40 #include "nx-match.h"
  41 #include "odp-util.h"
  42 #include "ofp-actions.h"
  43 #include "ofp-errors.h"
  44 #include "ofp-msgs.h"
  45 #include "ofp-parse.h"
  46 #include "ofp-print.h"
  47 #include "ofp-util.h"
  48 #include "ofp-version-opt.h"
  49 #include "ofpbuf.h"
  50 #include "ofproto/ofproto.h"
  51 #include "openflow/nicira-ext.h"
  52 #include "openflow/openflow.h"
  53 #include "dp-packet.h"
  54 #include "packets.h"
  55 #include "pcap-file.h"
  56 #include "poll-loop.h"
  57 #include "random.h"
  58 #include "stream-ssl.h"
  59 #include "socket-util.h"
  60 #include "timeval.h"
  61 #include "unixctl.h"
  62 #include "util.h"
  63 #include "openvswitch/vconn.h"
  64 #include "openvswitch/vlog.h"
  65 #include "meta-flow.h"
  66 #include "sort.h"
  67
  68 VLOG_DEFINE_THIS_MODULE(ofctl);
  69
  70 /* --bundle: Use OpenFlow 1.4 bundle for making the flow table change atomic.
  71  * NOTE: Also the flow mod will use OpenFlow 1.4, so the semantics may be
  72  * different (see the comment in parse_options() for details).
  73  */
  74 static bool bundle = false;
  75
  76 /* --strict: Use strict matching for flow mod commands?  Additionally governs
  77  * use of nx_pull_match() instead of nx_pull_match_loose() in parse-nx-match.
  78  */
  79 static bool strict;
  80
  81 /* --readd: If true, on replace-flows, re-add even flows that have not changed
  82  * (to reset flow counters). */
  83 static bool readd;
  84
  85 /* -F, --flow-format: Allowed protocols.  By default, any protocol is
  86  * allowed. */
  87 static enum ofputil_protocol allowed_protocols = OFPUTIL_P_ANY;
  88
  89 /* -P, --packet-in-format: Packet IN format to use in monitor and snoop
  90  * commands.  Either one of NXPIF_* to force a particular packet_in format, or
  91  * -1 to let ovs-ofctl choose the default. */
  92 static int preferred_packet_in_format = -1;
  93
  94 /* -m, --more: Additional verbosity for ofp-print functions. */
  95 static int verbosity;
  96
  97 /* --timestamp: Print a timestamp before each received packet on "monitor" and
  98  * "snoop" command? */
  99 static bool timestamp;
 100
 101 /* --unixctl-path: Path to use for unixctl server, for "monitor" and "snoop"
 102      commands. */
 103 static char *unixctl_path;
 104
 105 /* --sort, --rsort: Sort order. */
 106 enum sort_order { SORT_ASC, SORT_DESC };
 107 struct sort_criterion {
 108     const struct mf_field *field; /* NULL means to sort by priority. */
 109     enum sort_order order;
 110 };
 111 static struct sort_criterion *criteria;
 112 static size_t n_criteria, allocated_criteria;
 113
 114 static const struct ovs_cmdl_command *get_all_commands(void);
 115
 116 OVS_NO_RETURN static void usage(void);
 117 static void parse_options(int argc, char *argv[]);
 118
 119 static bool recv_flow_stats_reply(struct vconn *, ovs_be32 send_xid,
 120                                   struct ofpbuf **replyp,
 121                                   struct ofputil_flow_stats *,
 122                                   struct ofpbuf *ofpacts);
 123 int
 124 main(int argc, char *argv[])
 125 {
 126     struct ovs_cmdl_context ctx = { .argc = 0, };
 127     set_program_name(argv[0]);
 128     service_start(&argc, &argv);
 129     parse_options(argc, argv);
 130     fatal_ignore_sigpipe();
 131     ctx.argc = argc - optind;
 132     ctx.argv = argv + optind;
 133
 134     daemon_become_new_user(false);
 135     ovs_cmdl_run_command(&ctx, get_all_commands());
 136     return 0;
 137 }
 138
 139 static void
 140 add_sort_criterion(enum sort_order order, const char *field)
 141 {
 142     struct sort_criterion *sc;
 143
 144     if (n_criteria >= allocated_criteria) {
 145         criteria = x2nrealloc(criteria, &allocated_criteria, sizeof *criteria);
 146     }
 147
 148     sc = &criteria[n_criteria++];
 149     if (!field || !strcasecmp(field, "priority")) {
 150         sc->field = NULL;
 151     } else {
 152         sc->field = mf_from_name(field);
 153         if (!sc->field) {
 154             ovs_fatal(0, "%s: unknown field name", field);
 155         }
 156     }
 157     sc->order = order;
 158 }
 159
 160 static void
 161 parse_options(int argc, char *argv[])
 162 {
 163     enum {
 164         OPT_STRICT = UCHAR_MAX + 1,
 165         OPT_READD,
 166         OPT_TIMESTAMP,
 167         OPT_SORT,
 168         OPT_RSORT,
 169         OPT_UNIXCTL,
 170         OPT_BUNDLE,
 171         DAEMON_OPTION_ENUMS,
 172         OFP_VERSION_OPTION_ENUMS,
 173         VLOG_OPTION_ENUMS
 174     };
 175     static const struct option long_options[] = {
 176         {"timeout", required_argument, NULL, 't'},
 177         {"strict", no_argument, NULL, OPT_STRICT},
 178         {"readd", no_argument, NULL, OPT_READD},
 179         {"flow-format", required_argument, NULL, 'F'},
 180         {"packet-in-format", required_argument, NULL, 'P'},
 181         {"more", no_argument, NULL, 'm'},
 182         {"timestamp", no_argument, NULL, OPT_TIMESTAMP},
 183         {"sort", optional_argument, NULL, OPT_SORT},
 184         {"rsort", optional_argument, NULL, OPT_RSORT},
 185         {"unixctl",     required_argument, NULL, OPT_UNIXCTL},
 186         {"help", no_argument, NULL, 'h'},
 187         {"option", no_argument, NULL, 'o'},
 188         {"bundle", no_argument, NULL, OPT_BUNDLE},
 189         DAEMON_LONG_OPTIONS,
 190         OFP_VERSION_LONG_OPTIONS,
 191         VLOG_LONG_OPTIONS,
 192         STREAM_SSL_LONG_OPTIONS,
 193         {NULL, 0, NULL, 0},
 194     };
 195     char *short_options = ovs_cmdl_long_options_to_short_options(long_options);
 196     uint32_t versions;
 197     enum ofputil_protocol version_protocols;
 198
 199     /* For now, ovs-ofctl only enables OpenFlow 1.0 by default.  This is
 200      * because ovs-ofctl implements command such as "add-flow" as raw OpenFlow
 201      * requests, but those requests have subtly different semantics in
 202      * different OpenFlow versions.  For example:
 203      *
 204      *     - In OpenFlow 1.0, a "mod-flow" operation that does not find any
 205      *       existing flow to modify adds a new flow.
 206      *
 207      *     - In OpenFlow 1.1, a "mod-flow" operation that does not find any
 208      *       existing flow to modify adds a new flow, but only if the mod-flow
 209      *       did not match on the flow cookie.
 210      *
 211      *     - In OpenFlow 1.2 and a later, a "mod-flow" operation never adds a
 212      *       new flow.
 213      */
 214     set_allowed_ofp_versions("OpenFlow10");
 215
 216     for (;;) {
 217         unsigned long int timeout;
 218         int c;
 219
 220         c = getopt_long(argc, argv, short_options, long_options, NULL);
 221         if (c == -1) {
 222             break;
 223         }
 224
 225         switch (c) {
 226         case 't':
 227             timeout = strtoul(optarg, NULL, 10);
 228             if (timeout <= 0) {
 229                 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
 230                           optarg);
 231             } else {
 232                 time_alarm(timeout);
 233             }
 234             break;
 235
 236         case 'F':
 237             allowed_protocols = ofputil_protocols_from_string(optarg);
 238             if (!allowed_protocols) {
 239                 ovs_fatal(0, "%s: invalid flow format(s)", optarg);
 240             }
 241             break;
 242
 243         case 'P':
 244             preferred_packet_in_format =
 245                 ofputil_packet_in_format_from_string(optarg);
 246             if (preferred_packet_in_format < 0) {
 247                 ovs_fatal(0, "unknown packet-in format `%s'", optarg);
 248             }
 249             break;
 250
 251         case 'm':
 252             verbosity++;
 253             break;
 254
 255         case 'h':
 256             usage();
 257
 258         case 'o':
 259             ovs_cmdl_print_options(long_options);
 260             exit(EXIT_SUCCESS);
 261
 262         case OPT_BUNDLE:
 263             bundle = true;
 264             break;
 265
 266         case OPT_STRICT:
 267             strict = true;
 268             break;
 269
 270         case OPT_READD:
 271             readd = true;
 272             break;
 273
 274         case OPT_TIMESTAMP:
 275             timestamp = true;
 276             break;
 277
 278         case OPT_SORT:
 279             add_sort_criterion(SORT_ASC, optarg);
 280             break;
 281
 282         case OPT_RSORT:
 283             add_sort_criterion(SORT_DESC, optarg);
 284             break;
 285
 286         case OPT_UNIXCTL:
 287             unixctl_path = optarg;
 288             break;
 289
 290         DAEMON_OPTION_HANDLERS
 291         OFP_VERSION_OPTION_HANDLERS
 292         VLOG_OPTION_HANDLERS
 293         STREAM_SSL_OPTION_HANDLERS
 294
 295         case '?':
 296             exit(EXIT_FAILURE);
 297
 298         default:
 299             abort();
 300         }
 301     }
 302
 303     if (n_criteria) {
 304         /* Always do a final sort pass based on priority. */
 305         add_sort_criterion(SORT_DESC, "priority");
 306     }
 307
 308     free(short_options);
 309
 310     /* Implicit OpenFlow 1.4 with the '--bundle' option. */
 311     if (bundle) {
 312         /* Add implicit allowance for OpenFlow 1.4. */
 313         add_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
 314                                      OFPUTIL_P_OF14_OXM));
 315         /* Remove all prior versions. */
 316         mask_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
 317                                      OFPUTIL_P_OF14_UP));
 318     }
 319     versions = get_allowed_ofp_versions();
 320     version_protocols = ofputil_protocols_from_version_bitmap(versions);
 321     if (!(allowed_protocols & version_protocols)) {
 322         char *protocols = ofputil_protocols_to_string(allowed_protocols);
 323         struct ds version_s = DS_EMPTY_INITIALIZER;
 324
 325         ofputil_format_version_bitmap_names(&version_s, versions);
 326         ovs_fatal(0, "None of the enabled OpenFlow versions (%s) supports "
 327                   "any of the enabled flow formats (%s).  (Use -O to enable "
 328                   "additional OpenFlow versions or -F to enable additional "
 329                   "flow formats.)", ds_cstr(&version_s), protocols);
 330     }
 331     allowed_protocols &= version_protocols;
 332     mask_allowed_ofp_versions(ofputil_protocols_to_version_bitmap(
 333                                   allowed_protocols));
 334 }
 335
 336 static void
 337 usage(void)
 338 {
 339     printf("%s: OpenFlow switch management utility\n"
 340            "usage: %s [OPTIONS] COMMAND [ARG...]\n"
 341            "\nFor OpenFlow switches:\n"
 342            "  show SWITCH                 show OpenFlow information\n"
 343            "  dump-desc SWITCH            print switch description\n"
 344            "  dump-tables SWITCH          print table stats\n"
 345            "  dump-table-features SWITCH  print table features\n"
 346            "  dump-table-desc SWITCH      print table description (OF1.4+)\n"
 347            "  mod-port SWITCH IFACE ACT   modify port behavior\n"
 348            "  mod-table SWITCH MOD        modify flow table behavior\n"
 349            "      OF1.1/1.2 MOD: controller, continue, drop\n"
 350            "      OF1.4+ MOD: evict, noevict, vacancy:low,high, novacancy\n"
 351            "  get-frags SWITCH            print fragment handling behavior\n"
 352            "  set-frags SWITCH FRAG_MODE  set fragment handling behavior\n"
 353            "      FRAG_MODE: normal, drop, reassemble, nx-match\n"
 354            "  dump-ports SWITCH [PORT]    print port statistics\n"
 355            "  dump-ports-desc SWITCH [PORT]  print port descriptions\n"
 356            "  dump-flows SWITCH           print all flow entries\n"
 357            "  dump-flows SWITCH FLOW      print matching FLOWs\n"
 358            "  dump-aggregate SWITCH       print aggregate flow statistics\n"
 359            "  dump-aggregate SWITCH FLOW  print aggregate stats for FLOWs\n"
 360            "  queue-stats SWITCH [PORT [QUEUE]]  dump queue stats\n"
 361            "  add-flow SWITCH FLOW        add flow described by FLOW\n"
 362            "  add-flows SWITCH FILE       add flows from FILE\n"
 363            "  mod-flows SWITCH FLOW       modify actions of matching FLOWs\n"
 364            "  del-flows SWITCH [FLOW]     delete matching FLOWs\n"
 365            "  replace-flows SWITCH FILE   replace flows with those in FILE\n"
 366            "  diff-flows SOURCE1 SOURCE2  compare flows from two sources\n"
 367            "  packet-out SWITCH IN_PORT ACTIONS PACKET...\n"
 368            "                              execute ACTIONS on PACKET\n"
 369            "  monitor SWITCH [MISSLEN] [invalid_ttl] [watch:[...]]\n"
 370            "                              print packets received from SWITCH\n"
 371            "  snoop SWITCH                snoop on SWITCH and its controller\n"
 372            "  add-group SWITCH GROUP      add group described by GROUP\n"
 373            "  add-groups SWITCH FILE      add group from FILE\n"
 374            "  mod-group SWITCH GROUP      modify specific group\n"
 375            "  del-groups SWITCH [GROUP]   delete matching GROUPs\n"
 376            "  insert-buckets SWITCH [GROUP] add buckets to GROUP\n"
 377            "  remove-buckets SWITCH [GROUP] remove buckets from GROUP\n"
 378            "  dump-group-features SWITCH  print group features\n"
 379            "  dump-groups SWITCH [GROUP]  print group description\n"
 380            "  dump-group-stats SWITCH [GROUP]  print group statistics\n"
 381            "  queue-get-config SWITCH [PORT]  print queue config for PORT\n"
 382            "  add-meter SWITCH METER      add meter described by METER\n"
 383            "  mod-meter SWITCH METER      modify specific METER\n"
 384            "  del-meter SWITCH METER      delete METER\n"
 385            "  del-meters SWITCH           delete all meters\n"
 386            "  dump-meter SWITCH METER     print METER configuration\n"
 387            "  dump-meters SWITCH          print all meter configuration\n"
 388            "  meter-stats SWITCH [METER]  print meter statistics\n"
 389            "  meter-features SWITCH       print meter features\n"
 390            "  add-tlv-map SWITCH MAP      add TLV option MAPpings\n"
 391            "  del-tlv-map SWITCH [MAP] delete TLV option MAPpings\n"
 392            "  dump-tlv-map SWITCH      print TLV option mappings\n"
 393            "\nFor OpenFlow switches and controllers:\n"
 394            "  probe TARGET                probe whether TARGET is up\n"
 395            "  ping TARGET [N]             latency of N-byte echos\n"
 396            "  benchmark TARGET N COUNT    bandwidth of COUNT N-byte echos\n"
 397            "SWITCH or TARGET is an active OpenFlow connection method.\n"
 398            "\nOther commands:\n"
 399            "  ofp-parse FILE              print messages read from FILE\n"
 400            "  ofp-parse-pcap PCAP         print OpenFlow read from PCAP\n",
 401            program_name, program_name);
 402     vconn_usage(true, false, false);
 403     daemon_usage();
 404     ofp_version_usage();
 405     vlog_usage();
 406     printf("\nOther options:\n"
 407            "  --strict                    use strict match for flow commands\n"
 408            "  --readd                     replace flows that haven't changed\n"
 409            "  -F, --flow-format=FORMAT    force particular flow format\n"
 410            "  -P, --packet-in-format=FRMT force particular packet in format\n"
 411            "  -m, --more                  be more verbose printing OpenFlow\n"
 412            "  --timestamp                 (monitor, snoop) print timestamps\n"
 413            "  -t, --timeout=SECS          give up after SECS seconds\n"
 414            "  --sort[=field]              sort in ascending order\n"
 415            "  --rsort[=field]             sort in descending order\n"
 416            "  --unixctl=SOCKET            set control socket name\n"
 417            "  -h, --help                  display this help message\n"
 418            "  -V, --version               display version information\n");
 419     exit(EXIT_SUCCESS);
 420 }
 421
 422 static void
 423 ofctl_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
 424            const char *argv[] OVS_UNUSED, void *exiting_)
 425 {
 426     bool *exiting = exiting_;
 427     *exiting = true;
 428     unixctl_command_reply(conn, NULL);
 429 }
 430
 431 static void run(int retval, const char *message, ...)
 432     OVS_PRINTF_FORMAT(2, 3);
 433
 434 static void
 435 run(int retval, const char *message, ...)
 436 {
 437     if (retval) {
 438         va_list args;
 439
 440         va_start(args, message);
 441         ovs_fatal_valist(retval, message, args);
 442     }
 443 }
 444 \f
 445 /* Generic commands. */
 446
 447 static int
 448 open_vconn_socket(const char *name, struct vconn **vconnp)
 449 {
 450     char *vconn_name = xasprintf("unix:%s", name);
 451     int error;
 452
 453     error = vconn_open(vconn_name, get_allowed_ofp_versions(), DSCP_DEFAULT,
 454                        vconnp);
 455     if (error && error != ENOENT) {
 456         ovs_fatal(0, "%s: failed to open socket (%s)", name,
 457                   ovs_strerror(error));
 458     }
 459     free(vconn_name);
 460
 461     return error;
 462 }
 463
 464 enum open_target { MGMT, SNOOP };
 465
 466 static enum ofputil_protocol
 467 open_vconn__(const char *name, enum open_target target,
 468              struct vconn **vconnp)
 469 {
 470     const char *suffix = target == MGMT ? "mgmt" : "snoop";
 471     char *datapath_name, *datapath_type, *socket_name;
 472     enum ofputil_protocol protocol;
 473     char *bridge_path;
 474     int ofp_version;
 475     int error;
 476
 477     bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, suffix);
 478
 479     ofproto_parse_name(name, &datapath_name, &datapath_type);
 480     socket_name = xasprintf("%s/%s.%s", ovs_rundir(), datapath_name, suffix);
 481     free(datapath_name);
 482     free(datapath_type);
 483
 484     if (strchr(name, ':')) {
 485         run(vconn_open(name, get_allowed_ofp_versions(), DSCP_DEFAULT, vconnp),
 486             "connecting to %s", name);
 487     } else if (!open_vconn_socket(name, vconnp)) {
 488         /* Fall Through. */
 489     } else if (!open_vconn_socket(bridge_path, vconnp)) {
 490         /* Fall Through. */
 491     } else if (!open_vconn_socket(socket_name, vconnp)) {
 492         /* Fall Through. */
 493     } else {
 494         ovs_fatal(0, "%s is not a bridge or a socket", name);
 495     }
 496
 497     if (target == SNOOP) {
 498         vconn_set_recv_any_version(*vconnp);
 499     }
 500
 501     free(bridge_path);
 502     free(socket_name);
 503
 504     VLOG_DBG("connecting to %s", vconn_get_name(*vconnp));
 505     error = vconn_connect_block(*vconnp);
 506     if (error) {
 507         ovs_fatal(0, "%s: failed to connect to socket (%s)", name,
 508                   ovs_strerror(error));
 509     }
 510
 511     ofp_version = vconn_get_version(*vconnp);
 512     protocol = ofputil_protocol_from_ofp_version(ofp_version);
 513     if (!protocol) {
 514         ovs_fatal(0, "%s: unsupported OpenFlow version 0x%02x",
 515                   name, ofp_version);
 516     }
 517     return protocol;
 518 }
 519
 520 static enum ofputil_protocol
 521 open_vconn(const char *name, struct vconn **vconnp)
 522 {
 523     return open_vconn__(name, MGMT, vconnp);
 524 }
 525
 526 static void
 527 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
 528 {
 529     run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
 530 }
 531
 532 static void
 533 dump_transaction(struct vconn *vconn, struct ofpbuf *request)
 534 {
 535     const struct ofp_header *oh = request->data;
 536     if (ofpmsg_is_stat_request(oh)) {
 537         ovs_be32 send_xid = oh->xid;
 538         enum ofpraw request_raw;
 539         enum ofpraw reply_raw;
 540         bool done = false;
 541
 542         ofpraw_decode_partial(&request_raw, request->data, request->size);
 543         reply_raw = ofpraw_stats_request_to_reply(request_raw, oh->version);
 544
 545         send_openflow_buffer(vconn, request);
 546         while (!done) {
 547             ovs_be32 recv_xid;
 548             struct ofpbuf *reply;
 549
 550             run(vconn_recv_block(vconn, &reply),
 551                 "OpenFlow packet receive failed");
 552             recv_xid = ((struct ofp_header *) reply->data)->xid;
 553             if (send_xid == recv_xid) {
 554                 enum ofpraw raw;
 555
 556                 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
 557
 558                 ofpraw_decode(&raw, reply->data);
 559                 if (ofptype_from_ofpraw(raw) == OFPTYPE_ERROR) {
 560                     done = true;
 561                 } else if (raw == reply_raw) {
 562                     done = !ofpmp_more(reply->data);
 563                 } else {
 564                     ovs_fatal(0, "received bad reply: %s",
 565                               ofp_to_string(reply->data, reply->size,
 566                                             verbosity + 1));
 567                 }
 568             } else {
 569                 VLOG_DBG("received reply with xid %08"PRIx32" "
 570                          "!= expected %08"PRIx32, recv_xid, send_xid);
 571             }
 572             ofpbuf_delete(reply);
 573         }
 574     } else {
 575         struct ofpbuf *reply;
 576
 577         run(vconn_transact(vconn, request, &reply), "talking to %s",
 578             vconn_get_name(vconn));
 579         ofp_print(stdout, reply->data, reply->size, verbosity + 1);
 580         ofpbuf_delete(reply);
 581     }
 582 }
 583
 584 static void
 585 dump_trivial_transaction(const char *vconn_name, enum ofpraw raw)
 586 {
 587     struct ofpbuf *request;
 588     struct vconn *vconn;
 589
 590     open_vconn(vconn_name, &vconn);
 591     request = ofpraw_alloc(raw, vconn_get_version(vconn), 0);
 592     dump_transaction(vconn, request);
 593     vconn_close(vconn);
 594 }
 595
 596 /* Sends all of the 'requests', which should be requests that only have replies
 597  * if an error occurs, and waits for them to succeed or fail.  If an error does
 598  * occur, prints it and exits with an error.
 599  *
 600  * Destroys all of the 'requests'. */
 601 static void
 602 transact_multiple_noreply(struct vconn *vconn, struct ovs_list *requests)
 603 {
 604     struct ofpbuf *reply;
 605
 606     run(vconn_transact_multiple_noreply(vconn, requests, &reply),
 607         "talking to %s", vconn_get_name(vconn));
 608     if (reply) {
 609         ofp_print(stderr, reply->data, reply->size, verbosity + 2);
 610         exit(1);
 611     }
 612     ofpbuf_delete(reply);
 613 }
 614
 615 static void
 616 bundle_error_reporter(const struct ofp_header *oh)
 617 {
 618     ofp_print(stderr, oh, ntohs(oh->length), verbosity + 1);
 619     fflush(stderr);
 620 }
 621
 622 static void
 623 bundle_transact(struct vconn *vconn, struct ovs_list *requests, uint16_t flags)
 624 {
 625     run(vconn_bundle_transact(vconn, requests, flags, bundle_error_reporter),
 626         "talking to %s", vconn_get_name(vconn));
 627 }
 628
 629 /* Sends 'request', which should be a request that only has a reply if an error
 630  * occurs, and waits for it to succeed or fail.  If an error does occur, prints
 631  * it and exits with an error.
 632  *
 633  * Destroys 'request'. */
 634 static void
 635 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
 636 {
 637     struct ovs_list requests;
 638
 639     list_init(&requests);
 640     list_push_back(&requests, &request->list_node);
 641     transact_multiple_noreply(vconn, &requests);
 642 }
 643
 644 static void
 645 fetch_switch_config(struct vconn *vconn, struct ofputil_switch_config *config)
 646 {
 647     struct ofpbuf *request;
 648     struct ofpbuf *reply;
 649     enum ofptype type;
 650
 651     request = ofpraw_alloc(OFPRAW_OFPT_GET_CONFIG_REQUEST,
 652                            vconn_get_version(vconn), 0);
 653     run(vconn_transact(vconn, request, &reply),
 654         "talking to %s", vconn_get_name(vconn));
 655
 656     if (ofptype_decode(&type, reply->data)
 657         || type != OFPTYPE_GET_CONFIG_REPLY) {
 658         ovs_fatal(0, "%s: bad reply to config request", vconn_get_name(vconn));
 659     }
 660     ofputil_decode_get_config_reply(reply->data, config);
 661     ofpbuf_delete(reply);
 662 }
 663
 664 static void
 665 set_switch_config(struct vconn *vconn,
 666                   const struct ofputil_switch_config *config)
 667 {
 668     enum ofp_version version = vconn_get_version(vconn);
 669     transact_noreply(vconn, ofputil_encode_set_config(config, version));
 670 }
 671
 672 static void
 673 ofctl_show(struct ovs_cmdl_context *ctx)
 674 {
 675     const char *vconn_name = ctx->argv[1];
 676     enum ofp_version version;
 677     struct vconn *vconn;
 678     struct ofpbuf *request;
 679     struct ofpbuf *reply;
 680     bool has_ports;
 681
 682     open_vconn(vconn_name, &vconn);
 683     version = vconn_get_version(vconn);
 684     request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST, version, 0);
 685     run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
 686
 687     has_ports = ofputil_switch_features_has_ports(reply);
 688     ofp_print(stdout, reply->data, reply->size, verbosity + 1);
 689     ofpbuf_delete(reply);
 690
 691     if (!has_ports) {
 692         request = ofputil_encode_port_desc_stats_request(version, OFPP_ANY);
 693         dump_transaction(vconn, request);
 694     }
 695     dump_trivial_transaction(vconn_name, OFPRAW_OFPT_GET_CONFIG_REQUEST);
 696     vconn_close(vconn);
 697 }
 698
 699 static void
 700 ofctl_dump_desc(struct ovs_cmdl_context *ctx)
 701 {
 702     dump_trivial_transaction(ctx->argv[1], OFPRAW_OFPST_DESC_REQUEST);
 703 }
 704
 705 static void
 706 ofctl_dump_tables(struct ovs_cmdl_context *ctx)
 707 {
 708     dump_trivial_transaction(ctx->argv[1], OFPRAW_OFPST_TABLE_REQUEST);
 709 }
 710
 711 static void
 712 ofctl_dump_table_features(struct ovs_cmdl_context *ctx)
 713 {
 714     struct ofpbuf *request;
 715     struct vconn *vconn;
 716
 717     open_vconn(ctx->argv[1], &vconn);
 718     request = ofputil_encode_table_features_request(vconn_get_version(vconn));
 719
 720     /* The following is similar to dump_trivial_transaction(), but it
 721      * maintains the previous 'ofputil_table_features' from one stats reply
 722      * message to the next, which allows duplication to be eliminated in the
 723      * output across messages.  Otherwise the output is much larger and harder
 724      * to read, because only 17 or so ofputil_table_features elements fit in a
 725      * single 64 kB OpenFlow message and therefore you get a ton of repetition
 726      * (every 17th element is printed in full instead of abbreviated). */
 727
 728     const struct ofp_header *request_oh = request->data;
 729     ovs_be32 send_xid = request_oh->xid;
 730     bool done = false;
 731
 732     struct ofputil_table_features prev;
 733     int n = 0;
 734
 735     send_openflow_buffer(vconn, request);
 736     while (!done) {
 737         ovs_be32 recv_xid;
 738         struct ofpbuf *reply;
 739
 740         run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
 741         recv_xid = ((struct ofp_header *) reply->data)->xid;
 742         if (send_xid == recv_xid) {
 743             enum ofptype type;
 744             enum ofperr error;
 745             error = ofptype_decode(&type, reply->data);
 746             if (error) {
 747                 ovs_fatal(0, "decode error: %s", ofperr_get_name(error));
 748             } else if (type == OFPTYPE_ERROR) {
 749                 ofp_print(stdout, reply->data, reply->size, verbosity + 1);
 750                 done = true;
 751             } else if (type == OFPTYPE_TABLE_FEATURES_STATS_REPLY) {
 752                 done = !ofpmp_more(reply->data);
 753                 for (;;) {
 754                     struct ofputil_table_features tf;
 755                     int retval;
 756
 757                     retval = ofputil_decode_table_features(reply, &tf, true);
 758                     if (retval) {
 759                         if (retval != EOF) {
 760                             ovs_fatal(0, "decode error: %s",
 761                                       ofperr_get_name(retval));
 762                         }
 763                         break;
 764                     }
 765
 766                     struct ds s = DS_EMPTY_INITIALIZER;
 767                     ofp_print_table_features(&s, &tf, n ? &prev : NULL,
 768                                              NULL, NULL);
 769                     puts(ds_cstr(&s));
 770                     ds_destroy(&s);
 771
 772                     prev = tf;
 773                     n++;
 774                 }
 775             } else {
 776                 ovs_fatal(0, "received bad reply: %s",
 777                           ofp_to_string(reply->data, reply->size,
 778                                         verbosity + 1));
 779             }
 780         } else {
 781             VLOG_DBG("received reply with xid %08"PRIx32" "
 782                      "!= expected %08"PRIx32, recv_xid, send_xid);
 783         }
 784         ofpbuf_delete(reply);
 785     }
 786
 787     vconn_close(vconn);
 788 }
 789
 790 static void
 791 ofctl_dump_table_desc(struct ovs_cmdl_context *ctx)
 792 {
 793     struct ofpbuf *request;
 794     struct vconn *vconn;
 795
 796     open_vconn(ctx->argv[1], &vconn);
 797     request = ofputil_encode_table_desc_request(vconn_get_version(vconn));
 798     if (request) {
 799         dump_transaction(vconn, request);
 800     }
 801
 802     vconn_close(vconn);
 803 }
 804
 805
 806 static bool
 807 str_to_ofp(const char *s, ofp_port_t *ofp_port)
 808 {
 809     bool ret;
 810     uint32_t port_;
 811
 812     ret = str_to_uint(s, 10, &port_);
 813     *ofp_port = u16_to_ofp(port_);
 814     return ret;
 815 }
 816
 817 struct port_iterator {
 818     struct vconn *vconn;
 819
 820     enum { PI_FEATURES, PI_PORT_DESC } variant;
 821     struct ofpbuf *reply;
 822     ovs_be32 send_xid;
 823     bool more;
 824 };
 825
 826 static void
 827 port_iterator_fetch_port_desc(struct port_iterator *pi)
 828 {
 829     pi->variant = PI_PORT_DESC;
 830     pi->more = true;
 831
 832     struct ofpbuf *rq = ofputil_encode_port_desc_stats_request(
 833         vconn_get_version(pi->vconn), OFPP_ANY);
 834     pi->send_xid = ((struct ofp_header *) rq->data)->xid;
 835     send_openflow_buffer(pi->vconn, rq);
 836 }
 837
 838 static void
 839 port_iterator_fetch_features(struct port_iterator *pi)
 840 {
 841     pi->variant = PI_FEATURES;
 842
 843     /* Fetch the switch's ofp_switch_features. */
 844     enum ofp_version version = vconn_get_version(pi->vconn);
 845     struct ofpbuf *rq = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST, version, 0);
 846     run(vconn_transact(pi->vconn, rq, &pi->reply),
 847         "talking to %s", vconn_get_name(pi->vconn));
 848
 849     const struct ofp_header *oh = pi->reply->data;
 850     enum ofptype type;
 851     if (ofptype_decode(&type, pi->reply->data)
 852         || type != OFPTYPE_FEATURES_REPLY) {
 853         ovs_fatal(0, "%s: received bad features reply",
 854                   vconn_get_name(pi->vconn));
 855     }
 856     if (!ofputil_switch_features_has_ports(pi->reply)) {
 857         /* The switch features reply does not contain a complete list of ports.
 858          * Probably, there are more ports than will fit into a single 64 kB
 859          * OpenFlow message.  Use OFPST_PORT_DESC to get a complete list of
 860          * ports. */
 861         ofpbuf_delete(pi->reply);
 862         pi->reply = NULL;
 863         port_iterator_fetch_port_desc(pi);
 864         return;
 865     }
 866
 867     struct ofputil_switch_features features;
 868     enum ofperr error = ofputil_decode_switch_features(oh, &features,
 869                                                        pi->reply);
 870     if (error) {
 871         ovs_fatal(0, "%s: failed to decode features reply (%s)",
 872                   vconn_get_name(pi->vconn), ofperr_to_string(error));
 873     }
 874 }
 875
 876 /* Initializes 'pi' to prepare for iterating through all of the ports on the
 877  * OpenFlow switch to which 'vconn' is connected.
 878  *
 879  * During iteration, the client should not make other use of 'vconn', because
 880  * that can cause other messages to be interleaved with the replies used by the
 881  * iterator and thus some ports may be missed or a hang can occur. */
 882 static void
 883 port_iterator_init(struct port_iterator *pi, struct vconn *vconn)
 884 {
 885     memset(pi, 0, sizeof *pi);
 886     pi->vconn = vconn;
 887     if (vconn_get_version(vconn) < OFP13_VERSION) {
 888         port_iterator_fetch_features(pi);
 889     } else {
 890         port_iterator_fetch_port_desc(pi);
 891     }
 892 }
 893
 894 /* Obtains the next port from 'pi'.  On success, initializes '*pp' with the
 895  * port's details and returns true, otherwise (if all the ports have already
 896  * been seen), returns false.  */
 897 static bool
 898 port_iterator_next(struct port_iterator *pi, struct ofputil_phy_port *pp)
 899 {
 900     for (;;) {
 901         if (pi->reply) {
 902             int retval = ofputil_pull_phy_port(vconn_get_version(pi->vconn),
 903                                                pi->reply, pp);
 904             if (!retval) {
 905                 return true;
 906             } else if (retval != EOF) {
 907                 ovs_fatal(0, "received bad reply: %s",
 908                           ofp_to_string(pi->reply->data, pi->reply->size,
 909                                         verbosity + 1));
 910             }
 911         }
 912
 913         if (pi->variant == PI_FEATURES || !pi->more) {
 914             return false;
 915         }
 916
 917         ovs_be32 recv_xid;
 918         do {
 919             ofpbuf_delete(pi->reply);
 920             run(vconn_recv_block(pi->vconn, &pi->reply),
 921                 "OpenFlow receive failed");
 922             recv_xid = ((struct ofp_header *) pi->reply->data)->xid;
 923         } while (pi->send_xid != recv_xid);
 924
 925         struct ofp_header *oh = pi->reply->data;
 926         enum ofptype type;
 927         if (ofptype_pull(&type, pi->reply)
 928             || type != OFPTYPE_PORT_DESC_STATS_REPLY) {
 929             ovs_fatal(0, "received bad reply: %s",
 930                       ofp_to_string(pi->reply->data, pi->reply->size,
 931                                     verbosity + 1));
 932         }
 933
 934         pi->more = (ofpmp_flags(oh) & OFPSF_REPLY_MORE) != 0;
 935     }
 936 }
 937
 938 /* Destroys iterator 'pi'. */
 939 static void
 940 port_iterator_destroy(struct port_iterator *pi)
 941 {
 942     if (pi) {
 943         while (pi->variant == PI_PORT_DESC && pi->more) {
 944             /* Drain vconn's queue of any other replies for this request. */
 945             struct ofputil_phy_port pp;
 946             port_iterator_next(pi, &pp);
 947         }
 948
 949         ofpbuf_delete(pi->reply);
 950     }
 951 }
 952
 953 /* Opens a connection to 'vconn_name', fetches the port structure for
 954  * 'port_name' (which may be a port name or number), and copies it into
 955  * '*pp'. */
 956 static void
 957 fetch_ofputil_phy_port(const char *vconn_name, const char *port_name,
 958                        struct ofputil_phy_port *pp)
 959 {
 960     struct vconn *vconn;
 961     ofp_port_t port_no;
 962     bool found = false;
 963
 964     /* Try to interpret the argument as a port number. */
 965     if (!str_to_ofp(port_name, &port_no)) {
 966         port_no = OFPP_NONE;
 967     }
 968
 969     /* OpenFlow 1.0, 1.1, and 1.2 put the list of ports in the
 970      * OFPT_FEATURES_REPLY message.  OpenFlow 1.3 and later versions put it
 971      * into the OFPST_PORT_DESC reply.  Try it the correct way. */
 972     open_vconn(vconn_name, &vconn);
 973     struct port_iterator pi;
 974     for (port_iterator_init(&pi, vconn); port_iterator_next(&pi, pp); ) {
 975         if (port_no != OFPP_NONE
 976             ? port_no == pp->port_no
 977             : !strcmp(pp->name, port_name)) {
 978             found = true;
 979             break;
 980         }
 981     }
 982     port_iterator_destroy(&pi);
 983     vconn_close(vconn);
 984
 985     if (!found) {
 986         ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
 987     }
 988 }
 989
 990 /* Returns the port number corresponding to 'port_name' (which may be a port
 991  * name or number) within the switch 'vconn_name'. */
 992 static ofp_port_t
 993 str_to_port_no(const char *vconn_name, const char *port_name)
 994 {
 995     ofp_port_t port_no;
 996
 997     if (ofputil_port_from_string(port_name, &port_no)) {
 998         return port_no;
 999     } else {
1000         struct ofputil_phy_port pp;
1001
1002         fetch_ofputil_phy_port(vconn_name, port_name, &pp);
1003         return pp.port_no;
1004     }
1005 }
1006
1007 static bool
1008 try_set_protocol(struct vconn *vconn, enum ofputil_protocol want,
1009                  enum ofputil_protocol *cur)
1010 {
1011     for (;;) {
1012         struct ofpbuf *request, *reply;
1013         enum ofputil_protocol next;
1014
1015         request = ofputil_encode_set_protocol(*cur, want, &next);
1016         if (!request) {
1017             return *cur == want;
1018         }
1019
1020         run(vconn_transact_noreply(vconn, request, &reply),
1021             "talking to %s", vconn_get_name(vconn));
1022         if (reply) {
1023             char *s = ofp_to_string(reply->data, reply->size, 2);
1024             VLOG_DBG("%s: failed to set protocol, switch replied: %s",
1025                      vconn_get_name(vconn), s);
1026             free(s);
1027             ofpbuf_delete(reply);
1028             return false;
1029         }
1030
1031         *cur = next;
1032     }
1033 }
1034
1035 static enum ofputil_protocol
1036 set_protocol_for_flow_dump(struct vconn *vconn,
1037                            enum ofputil_protocol cur_protocol,
1038                            enum ofputil_protocol usable_protocols)
1039 {
1040     char *usable_s;
1041     int i;
1042
1043     for (i = 0; i < ofputil_n_flow_dump_protocols; i++) {
1044         enum ofputil_protocol f = ofputil_flow_dump_protocols[i];
1045         if (f & usable_protocols & allowed_protocols
1046             && try_set_protocol(vconn, f, &cur_protocol)) {
1047             return f;
1048         }
1049     }
1050
1051     usable_s = ofputil_protocols_to_string(usable_protocols);
1052     if (usable_protocols & allowed_protocols) {
1053         ovs_fatal(0, "switch does not support any of the usable flow "
1054                   "formats (%s)", usable_s);
1055     } else {
1056         char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
1057         ovs_fatal(0, "none of the usable flow formats (%s) is among the "
1058                   "allowed flow formats (%s)", usable_s, allowed_s);
1059     }
1060 }
1061
1062 static struct vconn *
1063 prepare_dump_flows(int argc, char *argv[], bool aggregate,
1064                    struct ofpbuf **requestp)
1065 {
1066     enum ofputil_protocol usable_protocols, protocol;
1067     struct ofputil_flow_stats_request fsr;
1068     struct vconn *vconn;
1069     char *error;
1070
1071     error = parse_ofp_flow_stats_request_str(&fsr, aggregate,
1072                                              argc > 2 ? argv[2] : "",
1073                                              &usable_protocols);
1074     if (error) {
1075         ovs_fatal(0, "%s", error);
1076     }
1077
1078     protocol = open_vconn(argv[1], &vconn);
1079     protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
1080     *requestp = ofputil_encode_flow_stats_request(&fsr, protocol);
1081     return vconn;
1082 }
1083
1084 static void
1085 ofctl_dump_flows__(int argc, char *argv[], bool aggregate)
1086 {
1087     struct ofpbuf *request;
1088     struct vconn *vconn;
1089
1090     vconn = prepare_dump_flows(argc, argv, aggregate, &request);
1091     dump_transaction(vconn, request);
1092     vconn_close(vconn);
1093 }
1094
1095 static int
1096 compare_flows(const void *afs_, const void *bfs_)
1097 {
1098     const struct ofputil_flow_stats *afs = afs_;
1099     const struct ofputil_flow_stats *bfs = bfs_;
1100     const struct match *a = &afs->match;
1101     const struct match *b = &bfs->match;
1102     const struct sort_criterion *sc;
1103
1104     for (sc = criteria; sc < &criteria[n_criteria]; sc++) {
1105         const struct mf_field *f = sc->field;
1106         int ret;
1107
1108         if (!f) {
1109             int a_pri = afs->priority;
1110             int b_pri = bfs->priority;
1111             ret = a_pri < b_pri ? -1 : a_pri > b_pri;
1112         } else {
1113             bool ina, inb;
1114
1115             ina = mf_are_prereqs_ok(f, &a->flow) && !mf_is_all_wild(f, &a->wc);
1116             inb = mf_are_prereqs_ok(f, &b->flow) && !mf_is_all_wild(f, &b->wc);
1117             if (ina != inb) {
1118                 /* Skip the test for sc->order, so that missing fields always
1119                  * sort to the end whether we're sorting in ascending or
1120                  * descending order. */
1121                 return ina ? -1 : 1;
1122             } else {
1123                 union mf_value aval, bval;
1124
1125                 mf_get_value(f, &a->flow, &aval);
1126                 mf_get_value(f, &b->flow, &bval);
1127                 ret = memcmp(&aval, &bval, f->n_bytes);
1128             }
1129         }
1130
1131         if (ret) {
1132             return sc->order == SORT_ASC ? ret : -ret;
1133         }
1134     }
1135
1136     return 0;
1137 }
1138
1139 static void
1140 ofctl_dump_flows(struct ovs_cmdl_context *ctx)
1141 {
1142     if (!n_criteria) {
1143         ofctl_dump_flows__(ctx->argc, ctx->argv, false);
1144         return;
1145     } else {
1146         struct ofputil_flow_stats *fses;
1147         size_t n_fses, allocated_fses;
1148         struct ofpbuf *request;
1149         struct ofpbuf ofpacts;
1150         struct ofpbuf *reply;
1151         struct vconn *vconn;
1152         ovs_be32 send_xid;
1153         struct ds s;
1154         size_t i;
1155
1156         vconn = prepare_dump_flows(ctx->argc, ctx->argv, false, &request);
1157         send_xid = ((struct ofp_header *) request->data)->xid;
1158         send_openflow_buffer(vconn, request);
1159
1160         fses = NULL;
1161         n_fses = allocated_fses = 0;
1162         reply = NULL;
1163         ofpbuf_init(&ofpacts, 0);
1164         for (;;) {
1165             struct ofputil_flow_stats *fs;
1166
1167             if (n_fses >= allocated_fses) {
1168                 fses = x2nrealloc(fses, &allocated_fses, sizeof *fses);
1169             }
1170
1171             fs = &fses[n_fses];
1172             if (!recv_flow_stats_reply(vconn, send_xid, &reply, fs,
1173                                        &ofpacts)) {
1174                 break;
1175             }
1176             fs->ofpacts = xmemdup(fs->ofpacts, fs->ofpacts_len);
1177             n_fses++;
1178         }
1179         ofpbuf_uninit(&ofpacts);
1180
1181         qsort(fses, n_fses, sizeof *fses, compare_flows);
1182
1183         ds_init(&s);
1184         for (i = 0; i < n_fses; i++) {
1185             ds_clear(&s);
1186             ofp_print_flow_stats(&s, &fses[i]);
1187             puts(ds_cstr(&s));
1188         }
1189         ds_destroy(&s);
1190
1191         for (i = 0; i < n_fses; i++) {
1192             free(CONST_CAST(struct ofpact *, fses[i].ofpacts));
1193         }
1194         free(fses);
1195
1196         vconn_close(vconn);
1197     }
1198 }
1199
1200 static void
1201 ofctl_dump_aggregate(struct ovs_cmdl_context *ctx)
1202 {
1203     ofctl_dump_flows__(ctx->argc, ctx->argv, true);
1204 }
1205
1206 static void
1207 ofctl_queue_stats(struct ovs_cmdl_context *ctx)
1208 {
1209     struct ofpbuf *request;
1210     struct vconn *vconn;
1211     struct ofputil_queue_stats_request oqs;
1212
1213     open_vconn(ctx->argv[1], &vconn);
1214
1215     if (ctx->argc > 2 && ctx->argv[2][0] && strcasecmp(ctx->argv[2], "all")) {
1216         oqs.port_no = str_to_port_no(ctx->argv[1], ctx->argv[2]);
1217     } else {
1218         oqs.port_no = OFPP_ANY;
1219     }
1220     if (ctx->argc > 3 && ctx->argv[3][0] && strcasecmp(ctx->argv[3], "all")) {
1221         oqs.queue_id = atoi(ctx->argv[3]);
1222     } else {
1223         oqs.queue_id = OFPQ_ALL;
1224     }
1225
1226     request = ofputil_encode_queue_stats_request(vconn_get_version(vconn), &oqs);
1227     dump_transaction(vconn, request);
1228     vconn_close(vconn);
1229 }
1230
1231 static void
1232 ofctl_queue_get_config(struct ovs_cmdl_context *ctx)
1233 {
1234     const char *vconn_name = ctx->argv[1];
1235     const char *port_name = ctx->argc >= 3 ? ctx->argv[2] : NULL;
1236     ofp_port_t port = (port_name
1237                        ? str_to_port_no(vconn_name, port_name)
1238                        : OFPP_ANY);
1239
1240     struct vconn *vconn;
1241     enum ofputil_protocol protocol = open_vconn(vconn_name, &vconn);
1242     enum ofp_version version = ofputil_protocol_to_ofp_version(protocol);
1243     if (port == OFPP_ANY && version == OFP10_VERSION) {
1244         /* The user requested all queues on all ports.  OpenFlow 1.0 only
1245          * supports getting queues for an individual port, so to implement the
1246          * user's request we have to get a list of all the ports.
1247          *
1248          * We use a second vconn to avoid having to accumulate a list of all of
1249          * the ports. */
1250         struct vconn *vconn2;
1251         enum ofputil_protocol protocol2 = open_vconn(vconn_name, &vconn2);
1252         enum ofp_version version2 = ofputil_protocol_to_ofp_version(protocol2);
1253
1254         struct port_iterator pi;
1255         struct ofputil_phy_port pp;
1256         for (port_iterator_init(&pi, vconn); port_iterator_next(&pi, &pp); ) {
1257             if (ofp_to_u16(pp.port_no) < ofp_to_u16(OFPP_MAX)) {
1258                 dump_transaction(vconn2,
1259                                  ofputil_encode_queue_get_config_request(
1260                                      version2, pp.port_no));
1261             }
1262         }
1263         port_iterator_destroy(&pi);
1264         vconn_close(vconn2);
1265     } else {
1266         dump_transaction(vconn, ofputil_encode_queue_get_config_request(
1267                              version, port));
1268     }
1269     vconn_close(vconn);
1270 }
1271
1272 static enum ofputil_protocol
1273 open_vconn_for_flow_mod(const char *remote, struct vconn **vconnp,
1274                         enum ofputil_protocol usable_protocols)
1275 {
1276     enum ofputil_protocol cur_protocol;
1277     char *usable_s;
1278     int i;
1279
1280     if (!(usable_protocols & allowed_protocols)) {
1281         char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
1282         usable_s = ofputil_protocols_to_string(usable_protocols);
1283         ovs_fatal(0, "none of the usable flow formats (%s) is among the "
1284                   "allowed flow formats (%s)", usable_s, allowed_s);
1285     }
1286
1287     /* If the initial flow format is allowed and usable, keep it. */
1288     cur_protocol = open_vconn(remote, vconnp);
1289     if (usable_protocols & allowed_protocols & cur_protocol) {
1290         return cur_protocol;
1291     }
1292
1293     /* Otherwise try each flow format in turn. */
1294     for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
1295         enum ofputil_protocol f = 1 << i;
1296
1297         if (f != cur_protocol
1298             && f & usable_protocols & allowed_protocols
1299             && try_set_protocol(*vconnp, f, &cur_protocol)) {
1300             return f;
1301         }
1302     }
1303
1304     usable_s = ofputil_protocols_to_string(usable_protocols);
1305     ovs_fatal(0, "switch does not support any of the usable flow "
1306               "formats (%s)", usable_s);
1307 }
1308
1309 static void
1310 bundle_flow_mod__(const char *remote, struct ofputil_flow_mod *fms,
1311                   size_t n_fms, enum ofputil_protocol usable_protocols)
1312 {
1313     enum ofputil_protocol protocol;
1314     struct vconn *vconn;
1315     struct ovs_list requests;
1316     size_t i;
1317
1318     list_init(&requests);
1319
1320     /* Bundles need OpenFlow 1.4+. */
1321     usable_protocols &= OFPUTIL_P_OF14_UP;
1322     protocol = open_vconn_for_flow_mod(remote, &vconn, usable_protocols);
1323
1324     for (i = 0; i < n_fms; i++) {
1325         struct ofputil_flow_mod *fm = &fms[i];
1326         struct ofpbuf *request = ofputil_encode_flow_mod(fm, protocol);
1327
1328         list_push_back(&requests, &request->list_node);
1329         free(CONST_CAST(struct ofpact *, fm->ofpacts));
1330     }
1331
1332     bundle_transact(vconn, &requests, OFPBF_ORDERED | OFPBF_ATOMIC);
1333     ofpbuf_list_delete(&requests);
1334     vconn_close(vconn);
1335 }
1336
1337 static void
1338 ofctl_flow_mod__(const char *remote, struct ofputil_flow_mod *fms,
1339                  size_t n_fms, enum ofputil_protocol usable_protocols)
1340 {
1341     enum ofputil_protocol protocol;
1342     struct vconn *vconn;
1343     size_t i;
1344
1345     if (bundle) {
1346         bundle_flow_mod__(remote, fms, n_fms, usable_protocols);
1347         return;
1348     }
1349
1350     protocol = open_vconn_for_flow_mod(remote, &vconn, usable_protocols);
1351
1352     for (i = 0; i < n_fms; i++) {
1353         struct ofputil_flow_mod *fm = &fms[i];
1354
1355         transact_noreply(vconn, ofputil_encode_flow_mod(fm, protocol));
1356         free(CONST_CAST(struct ofpact *, fm->ofpacts));
1357     }
1358     vconn_close(vconn);
1359 }
1360
1361 static void
1362 ofctl_flow_mod_file(int argc OVS_UNUSED, char *argv[], int command)
1363 {
1364     enum ofputil_protocol usable_protocols;
1365     struct ofputil_flow_mod *fms = NULL;
1366     size_t n_fms = 0;
1367     char *error;
1368
1369     if (command == OFPFC_ADD) {
1370         /* Allow the file to specify a mix of commands.  If none specified at
1371          * the beginning of any given line, then the default is OFPFC_ADD, so
1372          * this is backwards compatible. */
1373         command = -2;
1374     }
1375     error = parse_ofp_flow_mod_file(argv[2], command, &fms, &n_fms,
1376                                     &usable_protocols);
1377     if (error) {
1378         ovs_fatal(0, "%s", error);
1379     }
1380     ofctl_flow_mod__(argv[1], fms, n_fms, usable_protocols);
1381     free(fms);
1382 }
1383
1384 static void
1385 ofctl_flow_mod(int argc, char *argv[], uint16_t command)
1386 {
1387     if (argc > 2 && !strcmp(argv[2], "-")) {
1388         ofctl_flow_mod_file(argc, argv, command);
1389     } else {
1390         struct ofputil_flow_mod fm;
1391         char *error;
1392         enum ofputil_protocol usable_protocols;
1393
1394         error = parse_ofp_flow_mod_str(&fm, argc > 2 ? argv[2] : "", command,
1395                                        &usable_protocols);
1396         if (error) {
1397             ovs_fatal(0, "%s", error);
1398         }
1399         ofctl_flow_mod__(argv[1], &fm, 1, usable_protocols);
1400     }
1401 }
1402
1403 static void
1404 ofctl_add_flow(struct ovs_cmdl_context *ctx)
1405 {
1406     ofctl_flow_mod(ctx->argc, ctx->argv, OFPFC_ADD);
1407 }
1408
1409 static void
1410 ofctl_add_flows(struct ovs_cmdl_context *ctx)
1411 {
1412     ofctl_flow_mod_file(ctx->argc, ctx->argv, OFPFC_ADD);
1413 }
1414
1415 static void
1416 ofctl_mod_flows(struct ovs_cmdl_context *ctx)
1417 {
1418     ofctl_flow_mod(ctx->argc, ctx->argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
1419 }
1420
1421 static void
1422 ofctl_del_flows(struct ovs_cmdl_context *ctx)
1423 {
1424     ofctl_flow_mod(ctx->argc, ctx->argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
1425 }
1426
1427 static void
1428 set_packet_in_format(struct vconn *vconn,
1429                      enum nx_packet_in_format packet_in_format)
1430 {
1431     struct ofpbuf *spif;
1432
1433     spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1434                                              packet_in_format);
1435     transact_noreply(vconn, spif);
1436     VLOG_DBG("%s: using user-specified packet in format %s",
1437              vconn_get_name(vconn),
1438              ofputil_packet_in_format_to_string(packet_in_format));
1439 }
1440
1441 static int
1442 monitor_set_invalid_ttl_to_controller(struct vconn *vconn)
1443 {
1444     struct ofputil_switch_config config;
1445
1446     fetch_switch_config(vconn, &config);
1447     if (!config.invalid_ttl_to_controller) {
1448         config.invalid_ttl_to_controller = 1;
1449         set_switch_config(vconn, &config);
1450
1451         /* Then retrieve the configuration to see if it really took.  OpenFlow
1452          * has ill-defined error reporting for bad flags, so this is about the
1453          * best we can do. */
1454         fetch_switch_config(vconn, &config);
1455         if (!config.invalid_ttl_to_controller) {
1456             ovs_fatal(0, "setting invalid_ttl_to_controller failed (this "
1457                       "switch probably doesn't support this flag)");
1458         }
1459     }
1460     return 0;
1461 }
1462
1463 /* Converts hex digits in 'hex' to an OpenFlow message in '*msgp'.  The
1464  * caller must free '*msgp'.  On success, returns NULL.  On failure, returns
1465  * an error message and stores NULL in '*msgp'. */
1466 static const char *
1467 openflow_from_hex(const char *hex, struct ofpbuf **msgp)
1468 {
1469     struct ofp_header *oh;
1470     struct ofpbuf *msg;
1471
1472     msg = ofpbuf_new(strlen(hex) / 2);
1473     *msgp = NULL;
1474
1475     if (ofpbuf_put_hex(msg, hex, NULL)[0] != '\0') {
1476         ofpbuf_delete(msg);
1477         return "Trailing garbage in hex data";
1478     }
1479
1480     if (msg->size < sizeof(struct ofp_header)) {
1481         ofpbuf_delete(msg);
1482         return "Message too short for OpenFlow";
1483     }
1484
1485     oh = msg->data;
1486     if (msg->size != ntohs(oh->length)) {
1487         ofpbuf_delete(msg);
1488         return "Message size does not match length in OpenFlow header";
1489     }
1490
1491     *msgp = msg;
1492     return NULL;
1493 }
1494
1495 static void
1496 ofctl_send(struct unixctl_conn *conn, int argc,
1497            const char *argv[], void *vconn_)
1498 {
1499     struct vconn *vconn = vconn_;
1500     struct ds reply;
1501     bool ok;
1502     int i;
1503
1504     ok = true;
1505     ds_init(&reply);
1506     for (i = 1; i < argc; i++) {
1507         const char *error_msg;
1508         struct ofpbuf *msg;
1509         int error;
1510
1511         error_msg = openflow_from_hex(argv[i], &msg);
1512         if (error_msg) {
1513             ds_put_format(&reply, "%s\n", error_msg);
1514             ok = false;
1515             continue;
1516         }
1517
1518         fprintf(stderr, "send: ");
1519         ofp_print(stderr, msg->data, msg->size, verbosity);
1520
1521         error = vconn_send_block(vconn, msg);
1522         if (error) {
1523             ofpbuf_delete(msg);
1524             ds_put_format(&reply, "%s\n", ovs_strerror(error));
1525             ok = false;
1526         } else {
1527             ds_put_cstr(&reply, "sent\n");
1528         }
1529     }
1530
1531     if (ok) {
1532         unixctl_command_reply(conn, ds_cstr(&reply));
1533     } else {
1534         unixctl_command_reply_error(conn, ds_cstr(&reply));
1535     }
1536     ds_destroy(&reply);
1537 }
1538
1539 struct barrier_aux {
1540     struct vconn *vconn;        /* OpenFlow connection for sending barrier. */
1541     struct unixctl_conn *conn;  /* Connection waiting for barrier response. */
1542 };
1543
1544 static void
1545 ofctl_barrier(struct unixctl_conn *conn, int argc OVS_UNUSED,
1546               const char *argv[] OVS_UNUSED, void *aux_)
1547 {
1548     struct barrier_aux *aux = aux_;
1549     struct ofpbuf *msg;
1550     int error;
1551
1552     if (aux->conn) {
1553         unixctl_command_reply_error(conn, "already waiting for barrier reply");
1554         return;
1555     }
1556
1557     msg = ofputil_encode_barrier_request(vconn_get_version(aux->vconn));
1558     error = vconn_send_block(aux->vconn, msg);
1559     if (error) {
1560         ofpbuf_delete(msg);
1561         unixctl_command_reply_error(conn, ovs_strerror(error));
1562     } else {
1563         aux->conn = conn;
1564     }
1565 }
1566
1567 static void
1568 ofctl_set_output_file(struct unixctl_conn *conn, int argc OVS_UNUSED,
1569                       const char *argv[], void *aux OVS_UNUSED)
1570 {
1571     int fd;
1572
1573     fd = open(argv[1], O_CREAT | O_TRUNC | O_WRONLY, 0666);
1574     if (fd < 0) {
1575         unixctl_command_reply_error(conn, ovs_strerror(errno));
1576         return;
1577     }
1578
1579     fflush(stderr);
1580     dup2(fd, STDERR_FILENO);
1581     close(fd);
1582     unixctl_command_reply(conn, NULL);
1583 }
1584
1585 static void
1586 ofctl_block(struct unixctl_conn *conn, int argc OVS_UNUSED,
1587             const char *argv[] OVS_UNUSED, void *blocked_)
1588 {
1589     bool *blocked = blocked_;
1590
1591     if (!*blocked) {
1592         *blocked = true;
1593         unixctl_command_reply(conn, NULL);
1594     } else {
1595         unixctl_command_reply(conn, "already blocking");
1596     }
1597 }
1598
1599 static void
1600 ofctl_unblock(struct unixctl_conn *conn, int argc OVS_UNUSED,
1601               const char *argv[] OVS_UNUSED, void *blocked_)
1602 {
1603     bool *blocked = blocked_;
1604
1605     if (*blocked) {
1606         *blocked = false;
1607         unixctl_command_reply(conn, NULL);
1608     } else {
1609         unixctl_command_reply(conn, "already unblocked");
1610     }
1611 }
1612
1613 /* Prints to stdout all of the messages received on 'vconn'.
1614  *
1615  * Iff 'reply_to_echo_requests' is true, sends a reply to any echo request
1616  * received on 'vconn'. */
1617 static void
1618 monitor_vconn(struct vconn *vconn, bool reply_to_echo_requests)
1619 {
1620     struct barrier_aux barrier_aux = { vconn, NULL };
1621     struct unixctl_server *server;
1622     bool exiting = false;
1623     bool blocked = false;
1624     int error;
1625
1626     daemon_save_fd(STDERR_FILENO);
1627     daemonize_start(false);
1628     error = unixctl_server_create(unixctl_path, &server);
1629     if (error) {
1630         ovs_fatal(error, "failed to create unixctl server");
1631     }
1632     unixctl_command_register("exit", "", 0, 0, ofctl_exit, &exiting);
1633     unixctl_command_register("ofctl/send", "OFMSG...", 1, INT_MAX,
1634                              ofctl_send, vconn);
1635     unixctl_command_register("ofctl/barrier", "", 0, 0,
1636                              ofctl_barrier, &barrier_aux);
1637     unixctl_command_register("ofctl/set-output-file", "FILE", 1, 1,
1638                              ofctl_set_output_file, NULL);
1639
1640     unixctl_command_register("ofctl/block", "", 0, 0, ofctl_block, &blocked);
1641     unixctl_command_register("ofctl/unblock", "", 0, 0, ofctl_unblock,
1642                              &blocked);
1643
1644     daemonize_complete();
1645
1646     for (;;) {
1647         struct ofpbuf *b;
1648         int retval;
1649
1650         unixctl_server_run(server);
1651
1652         while (!blocked) {
1653             enum ofptype type;
1654
1655             retval = vconn_recv(vconn, &b);
1656             if (retval == EAGAIN) {
1657                 break;
1658             }
1659             run(retval, "vconn_recv");
1660
1661             if (timestamp) {
1662                 char *s = xastrftime_msec("%Y-%m-%d %H:%M:%S.###: ",
1663                                           time_wall_msec(), true);
1664                 fputs(s, stderr);
1665                 free(s);
1666             }
1667
1668             ofptype_decode(&type, b->data);
1669             ofp_print(stderr, b->data, b->size, verbosity + 2);
1670             fflush(stderr);
1671
1672             switch ((int) type) {
1673             case OFPTYPE_BARRIER_REPLY:
1674                 if (barrier_aux.conn) {
1675                     unixctl_command_reply(barrier_aux.conn, NULL);
1676                     barrier_aux.conn = NULL;
1677                 }
1678                 break;
1679
1680             case OFPTYPE_ECHO_REQUEST:
1681                 if (reply_to_echo_requests) {
1682                     struct ofpbuf *reply;
1683
1684                     reply = make_echo_reply(b->data);
1685                     retval = vconn_send_block(vconn, reply);
1686                     if (retval) {
1687                         ovs_fatal(retval, "failed to send echo reply");
1688                     }
1689                 }
1690                 break;
1691             }
1692             ofpbuf_delete(b);
1693         }
1694
1695         if (exiting) {
1696             break;
1697         }
1698
1699         vconn_run(vconn);
1700         vconn_run_wait(vconn);
1701         if (!blocked) {
1702             vconn_recv_wait(vconn);
1703         }
1704         unixctl_server_wait(server);
1705         poll_block();
1706     }
1707     vconn_close(vconn);
1708     unixctl_server_destroy(server);
1709 }
1710
1711 static void
1712 ofctl_monitor(struct ovs_cmdl_context *ctx)
1713 {
1714     struct vconn *vconn;
1715     int i;
1716     enum ofputil_protocol usable_protocols;
1717
1718     /* If the user wants the invalid_ttl_to_controller feature, limit the
1719      * OpenFlow versions to those that support that feature.  (Support in
1720      * OpenFlow 1.0 is an Open vSwitch extension.) */
1721     for (i = 2; i < ctx->argc; i++) {
1722         if (!strcmp(ctx->argv[i], "invalid_ttl")) {
1723             uint32_t usable_versions = ((1u << OFP10_VERSION) |
1724                                         (1u << OFP11_VERSION) |
1725                                         (1u << OFP12_VERSION));
1726             uint32_t allowed_versions = get_allowed_ofp_versions();
1727             if (!(allowed_versions & usable_versions)) {
1728                 struct ds versions = DS_EMPTY_INITIALIZER;
1729                 ofputil_format_version_bitmap_names(&versions,
1730                                                     usable_versions);
1731                 ovs_fatal(0, "invalid_ttl requires one of the OpenFlow "
1732                           "versions %s but none is enabled (use -O)",
1733                           ds_cstr(&versions));
1734             }
1735             mask_allowed_ofp_versions(usable_versions);
1736             break;
1737         }
1738     }
1739
1740     open_vconn(ctx->argv[1], &vconn);
1741     for (i = 2; i < ctx->argc; i++) {
1742         const char *arg = ctx->argv[i];
1743
1744         if (isdigit((unsigned char) *arg)) {
1745             struct ofputil_switch_config config;
1746
1747             fetch_switch_config(vconn, &config);
1748             config.miss_send_len = atoi(arg);
1749             set_switch_config(vconn, &config);
1750         } else if (!strcmp(arg, "invalid_ttl")) {
1751             monitor_set_invalid_ttl_to_controller(vconn);
1752         } else if (!strncmp(arg, "watch:", 6)) {
1753             struct ofputil_flow_monitor_request fmr;
1754             struct ofpbuf *msg;
1755             char *error;
1756
1757             error = parse_flow_monitor_request(&fmr, arg + 6,
1758                                                &usable_protocols);
1759             if (error) {
1760                 ovs_fatal(0, "%s", error);
1761             }
1762
1763             msg = ofpbuf_new(0);
1764             ofputil_append_flow_monitor_request(&fmr, msg);
1765             dump_transaction(vconn, msg);
1766             fflush(stdout);
1767         } else {
1768             ovs_fatal(0, "%s: unsupported \"monitor\" argument", arg);
1769         }
1770     }
1771
1772     if (preferred_packet_in_format >= 0) {
1773         set_packet_in_format(vconn, preferred_packet_in_format);
1774     } else {
1775         enum ofp_version version = vconn_get_version(vconn);
1776
1777         switch (version) {
1778         case OFP10_VERSION: {
1779             struct ofpbuf *spif, *reply;
1780
1781             spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1782                                                      NXPIF_NXM);
1783             run(vconn_transact_noreply(vconn, spif, &reply),
1784                 "talking to %s", vconn_get_name(vconn));
1785             if (reply) {
1786                 char *s = ofp_to_string(reply->data, reply->size, 2);
1787                 VLOG_DBG("%s: failed to set packet in format to nxm, controller"
1788                         " replied: %s. Falling back to the switch default.",
1789                         vconn_get_name(vconn), s);
1790                 free(s);
1791                 ofpbuf_delete(reply);
1792             }
1793             break;
1794         }
1795         case OFP11_VERSION:
1796         case OFP12_VERSION:
1797         case OFP13_VERSION:
1798         case OFP14_VERSION:
1799         case OFP15_VERSION:
1800             break;
1801         default:
1802             OVS_NOT_REACHED();
1803         }
1804     }
1805
1806     monitor_vconn(vconn, true);
1807 }
1808
1809 static void
1810 ofctl_snoop(struct ovs_cmdl_context *ctx)
1811 {
1812     struct vconn *vconn;
1813
1814     open_vconn__(ctx->argv[1], SNOOP, &vconn);
1815     monitor_vconn(vconn, false);
1816 }
1817
1818 static void
1819 ofctl_dump_ports(struct ovs_cmdl_context *ctx)
1820 {
1821     struct ofpbuf *request;
1822     struct vconn *vconn;
1823     ofp_port_t port;
1824
1825     open_vconn(ctx->argv[1], &vconn);
1826     port = ctx->argc > 2 ? str_to_port_no(ctx->argv[1], ctx->argv[2]) : OFPP_ANY;
1827     request = ofputil_encode_dump_ports_request(vconn_get_version(vconn), port);
1828     dump_transaction(vconn, request);
1829     vconn_close(vconn);
1830 }
1831
1832 static void
1833 ofctl_dump_ports_desc(struct ovs_cmdl_context *ctx)
1834 {
1835     struct ofpbuf *request;
1836     struct vconn *vconn;
1837     ofp_port_t port;
1838
1839     open_vconn(ctx->argv[1], &vconn);
1840     port = ctx->argc > 2 ? str_to_port_no(ctx->argv[1], ctx->argv[2]) : OFPP_ANY;
1841     request = ofputil_encode_port_desc_stats_request(vconn_get_version(vconn),
1842                                                      port);
1843     dump_transaction(vconn, request);
1844     vconn_close(vconn);
1845 }
1846
1847 static void
1848 ofctl_probe(struct ovs_cmdl_context *ctx)
1849 {
1850     struct ofpbuf *request;
1851     struct vconn *vconn;
1852     struct ofpbuf *reply;
1853
1854     open_vconn(ctx->argv[1], &vconn);
1855     request = make_echo_request(vconn_get_version(vconn));
1856     run(vconn_transact(vconn, request, &reply), "talking to %s", ctx->argv[1]);
1857     if (reply->size != sizeof(struct ofp_header)) {
1858         ovs_fatal(0, "reply does not match request");
1859     }
1860     ofpbuf_delete(reply);
1861     vconn_close(vconn);
1862 }
1863
1864 static void
1865 ofctl_packet_out(struct ovs_cmdl_context *ctx)
1866 {
1867     enum ofputil_protocol protocol;
1868     struct ofputil_packet_out po;
1869     struct ofpbuf ofpacts;
1870     struct vconn *vconn;
1871     char *error;
1872     int i;
1873     enum ofputil_protocol usable_protocols; /* XXX: Use in proto selection */
1874
1875     ofpbuf_init(&ofpacts, 64);
1876     error = ofpacts_parse_actions(ctx->argv[3], &ofpacts, &usable_protocols);
1877     if (error) {
1878         ovs_fatal(0, "%s", error);
1879     }
1880
1881     po.buffer_id = UINT32_MAX;
1882     po.in_port = str_to_port_no(ctx->argv[1], ctx->argv[2]);
1883     po.ofpacts = ofpacts.data;
1884     po.ofpacts_len = ofpacts.size;
1885
1886     protocol = open_vconn(ctx->argv[1], &vconn);
1887     for (i = 4; i < ctx->argc; i++) {
1888         struct dp_packet *packet;
1889         struct ofpbuf *opo;
1890         const char *error_msg;
1891
1892         error_msg = eth_from_hex(ctx->argv[i], &packet);
1893         if (error_msg) {
1894             ovs_fatal(0, "%s", error_msg);
1895         }
1896
1897         po.packet = dp_packet_data(packet);
1898         po.packet_len = dp_packet_size(packet);
1899         opo = ofputil_encode_packet_out(&po, protocol);
1900         transact_noreply(vconn, opo);
1901         dp_packet_delete(packet);
1902     }
1903     vconn_close(vconn);
1904     ofpbuf_uninit(&ofpacts);
1905 }
1906
1907 static void
1908 ofctl_mod_port(struct ovs_cmdl_context *ctx)
1909 {
1910     struct ofp_config_flag {
1911         const char *name;             /* The flag's name. */
1912         enum ofputil_port_config bit; /* Bit to turn on or off. */
1913         bool on;                      /* Value to set the bit to. */
1914     };
1915     static const struct ofp_config_flag flags[] = {
1916         { "up",          OFPUTIL_PC_PORT_DOWN,    false },
1917         { "down",        OFPUTIL_PC_PORT_DOWN,    true  },
1918         { "stp",         OFPUTIL_PC_NO_STP,       false },
1919         { "receive",     OFPUTIL_PC_NO_RECV,      false },
1920         { "receive-stp", OFPUTIL_PC_NO_RECV_STP,  false },
1921         { "flood",       OFPUTIL_PC_NO_FLOOD,     false },
1922         { "forward",     OFPUTIL_PC_NO_FWD,       false },
1923         { "packet-in",   OFPUTIL_PC_NO_PACKET_IN, false },
1924     };
1925
1926     const struct ofp_config_flag *flag;
1927     enum ofputil_protocol protocol;
1928     struct ofputil_port_mod pm;
1929     struct ofputil_phy_port pp;
1930     struct vconn *vconn;
1931     const char *command;
1932     bool not;
1933
1934     fetch_ofputil_phy_port(ctx->argv[1], ctx->argv[2], &pp);
1935
1936     pm.port_no = pp.port_no;
1937     pm.hw_addr = pp.hw_addr;
1938     pm.config = 0;
1939     pm.mask = 0;
1940     pm.advertise = 0;
1941
1942     if (!strncasecmp(ctx->argv[3], "no-", 3)) {
1943         command = ctx->argv[3] + 3;
1944         not = true;
1945     } else if (!strncasecmp(ctx->argv[3], "no", 2)) {
1946         command = ctx->argv[3] + 2;
1947         not = true;
1948     } else {
1949         command = ctx->argv[3];
1950         not = false;
1951     }
1952     for (flag = flags; flag < &flags[ARRAY_SIZE(flags)]; flag++) {
1953         if (!strcasecmp(command, flag->name)) {
1954             pm.mask = flag->bit;
1955             pm.config = flag->on ^ not ? flag->bit : 0;
1956             goto found;
1957         }
1958     }
1959     ovs_fatal(0, "unknown mod-port command '%s'", ctx->argv[3]);
1960
1961 found:
1962     protocol = open_vconn(ctx->argv[1], &vconn);
1963     transact_noreply(vconn, ofputil_encode_port_mod(&pm, protocol));
1964     vconn_close(vconn);
1965 }
1966
1967 /* This function uses OFPMP14_TABLE_DESC request to get the current
1968  * table configuration from switch. The function then modifies
1969  * only that table-config property, which has been requested. */
1970 static void
1971 fetch_table_desc(struct vconn *vconn, struct ofputil_table_mod *tm,
1972                  struct ofputil_table_desc *td)
1973 {
1974     struct ofpbuf *request;
1975     ovs_be32 send_xid;
1976     bool done = false;
1977     bool found = false;
1978
1979     request = ofputil_encode_table_desc_request(vconn_get_version(vconn));
1980     send_xid = ((struct ofp_header *) request->data)->xid;
1981     send_openflow_buffer(vconn, request);
1982     while (!done) {
1983         ovs_be32 recv_xid;
1984         struct ofpbuf *reply;
1985
1986         run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
1987         recv_xid = ((struct ofp_header *) reply->data)->xid;
1988         if (send_xid == recv_xid) {
1989             struct ofp_header *oh = reply->data;
1990             enum ofptype type;
1991             struct ofpbuf b;
1992             uint16_t flags;
1993
1994             ofpbuf_use_const(&b, oh, ntohs(oh->length));
1995             if (ofptype_pull(&type, &b)
1996                 || type != OFPTYPE_TABLE_DESC_REPLY) {
1997                 ovs_fatal(0, "received bad reply: %s",
1998                           ofp_to_string(reply->data, reply->size,
1999                                         verbosity + 1));
2000             }
2001             flags = ofpmp_flags(oh);
2002             done = !(flags & OFPSF_REPLY_MORE);
2003             if (found) {
2004                 /* We've already found the table desc consisting of current
2005                  * table configuration, but we need to drain the queue of
2006                  * any other replies for this request. */
2007                 continue;
2008             }
2009             while (!ofputil_decode_table_desc(&b, td, oh->version)) {
2010                 if (td->table_id == tm->table_id) {
2011                     found = true;
2012                     break;
2013                 }
2014             }
2015         } else {
2016             VLOG_DBG("received reply with xid %08"PRIx32" "
2017                      "!= expected %08"PRIx32, recv_xid, send_xid);
2018         }
2019         ofpbuf_delete(reply);
2020     }
2021     if (tm->eviction != OFPUTIL_TABLE_EVICTION_DEFAULT) {
2022         tm->vacancy = td->vacancy;
2023         tm->table_vacancy.vacancy_down = td->table_vacancy.vacancy_down;
2024         tm->table_vacancy.vacancy_up = td->table_vacancy.vacancy_up;
2025     } else if (tm->vacancy != OFPUTIL_TABLE_VACANCY_DEFAULT) {
2026         tm->eviction = td->eviction;
2027         tm->eviction_flags = td->eviction_flags;
2028     }
2029 }
2030
2031 static void
2032 ofctl_mod_table(struct ovs_cmdl_context *ctx)
2033 {
2034     uint32_t usable_versions;
2035     struct ofputil_table_mod tm;
2036     struct vconn *vconn;
2037     char *error;
2038     int i;
2039
2040     error = parse_ofp_table_mod(&tm, ctx->argv[2], ctx->argv[3],
2041                                 &usable_versions);
2042     if (error) {
2043         ovs_fatal(0, "%s", error);
2044     }
2045
2046     uint32_t allowed_versions = get_allowed_ofp_versions();
2047     if (!(allowed_versions & usable_versions)) {
2048         struct ds versions = DS_EMPTY_INITIALIZER;
2049         ofputil_format_version_bitmap_names(&versions, usable_versions);
2050         ovs_fatal(0, "table_mod '%s' requires one of the OpenFlow "
2051                   "versions %s",
2052                   ctx->argv[3], ds_cstr(&versions));
2053     }
2054     mask_allowed_ofp_versions(usable_versions);
2055     enum ofputil_protocol protocol = open_vconn(ctx->argv[1], &vconn);
2056
2057     /* For OpenFlow 1.4+, ovs-ofctl mod-table should not affect table-config
2058      * properties that the user didn't ask to change, so it is necessary to
2059      * restore the current configuration of table-config parameters using
2060      * OFPMP14_TABLE_DESC request. */
2061     if ((allowed_versions & (1u << OFP14_VERSION)) ||
2062         (allowed_versions & (1u << OFP15_VERSION))) {
2063         struct ofputil_table_desc td;
2064
2065         if (tm.table_id == OFPTT_ALL) {
2066             for (i = 0; i < OFPTT_MAX; i++) {
2067                 tm.table_id = i;
2068                 fetch_table_desc(vconn, &tm, &td);
2069                 transact_noreply(vconn,
2070                                  ofputil_encode_table_mod(&tm, protocol));
2071             }
2072         } else {
2073             fetch_table_desc(vconn, &tm, &td);
2074             transact_noreply(vconn, ofputil_encode_table_mod(&tm, protocol));
2075         }
2076     } else {
2077         transact_noreply(vconn, ofputil_encode_table_mod(&tm, protocol));
2078     }
2079     vconn_close(vconn);
2080 }
2081
2082 static void
2083 ofctl_get_frags(struct ovs_cmdl_context *ctx)
2084 {
2085     struct ofputil_switch_config config;
2086     struct vconn *vconn;
2087
2088     open_vconn(ctx->argv[1], &vconn);
2089     fetch_switch_config(vconn, &config);
2090     puts(ofputil_frag_handling_to_string(config.frag));
2091     vconn_close(vconn);
2092 }
2093
2094 static void
2095 ofctl_set_frags(struct ovs_cmdl_context *ctx)
2096 {
2097     struct ofputil_switch_config config;
2098     enum ofputil_frag_handling frag;
2099     struct vconn *vconn;
2100
2101     if (!ofputil_frag_handling_from_string(ctx->argv[2], &frag)) {
2102         ovs_fatal(0, "%s: unknown fragment handling mode", ctx->argv[2]);
2103     }
2104
2105     open_vconn(ctx->argv[1], &vconn);
2106     fetch_switch_config(vconn, &config);
2107     if (frag != config.frag) {
2108         /* Set the configuration. */
2109         config.frag = frag;
2110         set_switch_config(vconn, &config);
2111
2112         /* Then retrieve the configuration to see if it really took.  OpenFlow
2113          * has ill-defined error reporting for bad flags, so this is about the
2114          * best we can do. */
2115         fetch_switch_config(vconn, &config);
2116         if (frag != config.frag) {
2117             ovs_fatal(0, "%s: setting fragment handling mode failed (this "
2118                       "switch probably doesn't support mode \"%s\")",
2119                       ctx->argv[1], ofputil_frag_handling_to_string(frag));
2120         }
2121     }
2122     vconn_close(vconn);
2123 }
2124
2125 static void
2126 ofctl_ofp_parse(struct ovs_cmdl_context *ctx)
2127 {
2128     const char *filename = ctx->argv[1];
2129     struct ofpbuf b;
2130     FILE *file;
2131
2132     file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
2133     if (file == NULL) {
2134         ovs_fatal(errno, "%s: open", filename);
2135     }
2136
2137     ofpbuf_init(&b, 65536);
2138     for (;;) {
2139         struct ofp_header *oh;
2140         size_t length, tail_len;
2141         void *tail;
2142         size_t n;
2143
2144         ofpbuf_clear(&b);
2145         oh = ofpbuf_put_uninit(&b, sizeof *oh);
2146         n = fread(oh, 1, sizeof *oh, file);
2147         if (n == 0) {
2148             break;
2149         } else if (n < sizeof *oh) {
2150             ovs_fatal(0, "%s: unexpected end of file mid-message", filename);
2151         }
2152
2153         length = ntohs(oh->length);
2154         if (length < sizeof *oh) {
2155             ovs_fatal(0, "%s: %"PRIuSIZE"-byte message is too short for OpenFlow",
2156                       filename, length);
2157         }
2158
2159         tail_len = length - sizeof *oh;
2160         tail = ofpbuf_put_uninit(&b, tail_len);
2161         n = fread(tail, 1, tail_len, file);
2162         if (n < tail_len) {
2163             ovs_fatal(0, "%s: unexpected end of file mid-message", filename);
2164         }
2165
2166         ofp_print(stdout, b.data, b.size, verbosity + 2);
2167     }
2168     ofpbuf_uninit(&b);
2169
2170     if (file != stdin) {
2171         fclose(file);
2172     }
2173 }
2174
2175 static bool
2176 is_openflow_port(ovs_be16 port_, char *ports[])
2177 {
2178     uint16_t port = ntohs(port_);
2179     if (ports[0]) {
2180         int i;
2181
2182         for (i = 0; ports[i]; i++) {
2183             if (port == atoi(ports[i])) {
2184                 return true;
2185             }
2186         }
2187         return false;
2188     } else {
2189         return port == OFP_PORT || port == OFP_OLD_PORT;
2190     }
2191 }
2192
2193 static void
2194 ofctl_ofp_parse_pcap(struct ovs_cmdl_context *ctx)
2195 {
2196     struct tcp_reader *reader;
2197     FILE *file;
2198     int error;
2199     bool first;
2200
2201     file = ovs_pcap_open(ctx->argv[1], "rb");
2202     if (!file) {
2203         ovs_fatal(errno, "%s: open failed", ctx->argv[1]);
2204     }
2205
2206     reader = tcp_reader_open();
2207     first = true;
2208     for (;;) {
2209         struct dp_packet *packet;
2210         long long int when;
2211         struct flow flow;
2212
2213         error = ovs_pcap_read(file, &packet, &when);
2214         if (error) {
2215             break;
2216         }
2217         pkt_metadata_init(&packet->md, ODPP_NONE);
2218         flow_extract(packet, &flow);
2219         if (flow.dl_type == htons(ETH_TYPE_IP)
2220             && flow.nw_proto == IPPROTO_TCP
2221             && (is_openflow_port(flow.tp_src, ctx->argv + 2) ||
2222                 is_openflow_port(flow.tp_dst, ctx->argv + 2))) {
2223             struct dp_packet *payload = tcp_reader_run(reader, &flow, packet);
2224             if (payload) {
2225                 while (dp_packet_size(payload) >= sizeof(struct ofp_header)) {
2226                     const struct ofp_header *oh;
2227                     void *data = dp_packet_data(payload);
2228                     int length;
2229
2230                     /* Align OpenFlow on 8-byte boundary for safe access. */
2231                     dp_packet_shift(payload, -((intptr_t) data & 7));
2232
2233                     oh = dp_packet_data(payload);
2234                     length = ntohs(oh->length);
2235                     if (dp_packet_size(payload) < length) {
2236                         break;
2237                     }
2238
2239                     if (!first) {
2240                         putchar('\n');
2241                     }
2242                     first = false;
2243
2244                     if (timestamp) {
2245                         char *s = xastrftime_msec("%H:%M:%S.### ", when, true);
2246                         fputs(s, stdout);
2247                         free(s);
2248                     }
2249
2250                     printf(IP_FMT".%"PRIu16" > "IP_FMT".%"PRIu16":\n",
2251                            IP_ARGS(flow.nw_src), ntohs(flow.tp_src),
2252                            IP_ARGS(flow.nw_dst), ntohs(flow.tp_dst));
2253                     ofp_print(stdout, dp_packet_data(payload), length, verbosity + 1);
2254                     dp_packet_pull(payload, length);
2255                 }
2256             }
2257         }
2258         dp_packet_delete(packet);
2259     }
2260     tcp_reader_close(reader);
2261 }
2262
2263 static void
2264 ofctl_ping(struct ovs_cmdl_context *ctx)
2265 {
2266     size_t max_payload = 65535 - sizeof(struct ofp_header);
2267     unsigned int payload;
2268     struct vconn *vconn;
2269     int i;
2270
2271     payload = ctx->argc > 2 ? atoi(ctx->argv[2]) : 64;
2272     if (payload > max_payload) {
2273         ovs_fatal(0, "payload must be between 0 and %"PRIuSIZE" bytes", max_payload);
2274     }
2275
2276     open_vconn(ctx->argv[1], &vconn);
2277     for (i = 0; i < 10; i++) {
2278         struct timeval start, end;
2279         struct ofpbuf *request, *reply;
2280         const struct ofp_header *rpy_hdr;
2281         enum ofptype type;
2282
2283         request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
2284                                vconn_get_version(vconn), payload);
2285         random_bytes(ofpbuf_put_uninit(request, payload), payload);
2286
2287         xgettimeofday(&start);
2288         run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
2289         xgettimeofday(&end);
2290
2291         rpy_hdr = reply->data;
2292         if (ofptype_pull(&type, reply)
2293             || type != OFPTYPE_ECHO_REPLY
2294             || reply->size != payload
2295             || memcmp(request->msg, reply->msg, payload)) {
2296             printf("Reply does not match request.  Request:\n");
2297             ofp_print(stdout, request, request->size, verbosity + 2);
2298             printf("Reply:\n");
2299             ofp_print(stdout, reply, reply->size, verbosity + 2);
2300         }
2301         printf("%"PRIu32" bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
2302                reply->size, ctx->argv[1], ntohl(rpy_hdr->xid),
2303                    (1000*(double)(end.tv_sec - start.tv_sec))
2304                    + (.001*(end.tv_usec - start.tv_usec)));
2305         ofpbuf_delete(request);
2306         ofpbuf_delete(reply);
2307     }
2308     vconn_close(vconn);
2309 }
2310
2311 static void
2312 ofctl_benchmark(struct ovs_cmdl_context *ctx)
2313 {
2314     size_t max_payload = 65535 - sizeof(struct ofp_header);
2315     struct timeval start, end;
2316     unsigned int payload_size, message_size;
2317     struct vconn *vconn;
2318     double duration;
2319     int count;
2320     int i;
2321
2322     payload_size = atoi(ctx->argv[2]);
2323     if (payload_size > max_payload) {
2324         ovs_fatal(0, "payload must be between 0 and %"PRIuSIZE" bytes", max_payload);
2325     }
2326     message_size = sizeof(struct ofp_header) + payload_size;
2327
2328     count = atoi(ctx->argv[3]);
2329
2330     printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
2331            count, message_size, count * message_size);
2332
2333     open_vconn(ctx->argv[1], &vconn);
2334     xgettimeofday(&start);
2335     for (i = 0; i < count; i++) {
2336         struct ofpbuf *request, *reply;
2337
2338         request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
2339                                vconn_get_version(vconn), payload_size);
2340         ofpbuf_put_zeros(request, payload_size);
2341         run(vconn_transact(vconn, request, &reply), "transact");
2342         ofpbuf_delete(reply);
2343     }
2344     xgettimeofday(&end);
2345     vconn_close(vconn);
2346
2347     duration = ((1000*(double)(end.tv_sec - start.tv_sec))
2348                 + (.001*(end.tv_usec - start.tv_usec)));
2349     printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
2350            duration, count / (duration / 1000.0),
2351            count * message_size / (duration / 1000.0));
2352 }
2353
2354 static void
2355 ofctl_group_mod__(const char *remote, struct ofputil_group_mod *gms,
2356                   size_t n_gms, enum ofputil_protocol usable_protocols)
2357 {
2358     enum ofputil_protocol protocol;
2359     struct ofputil_group_mod *gm;
2360     enum ofp_version version;
2361     struct ofpbuf *request;
2362
2363     struct vconn *vconn;
2364     size_t i;
2365
2366     protocol = open_vconn_for_flow_mod(remote, &vconn, usable_protocols);
2367     version = ofputil_protocol_to_ofp_version(protocol);
2368
2369     for (i = 0; i < n_gms; i++) {
2370         gm = &gms[i];
2371         request = ofputil_encode_group_mod(version, gm);
2372         if (request) {
2373             transact_noreply(vconn, request);
2374         }
2375     }
2376
2377     vconn_close(vconn);
2378
2379 }
2380
2381
2382 static void
2383 ofctl_group_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
2384 {
2385     struct ofputil_group_mod *gms = NULL;
2386     enum ofputil_protocol usable_protocols;
2387     size_t n_gms = 0;
2388     char *error;
2389     int i;
2390
2391     error = parse_ofp_group_mod_file(argv[2], command, &gms, &n_gms,
2392                                      &usable_protocols);
2393     if (error) {
2394         ovs_fatal(0, "%s", error);
2395     }
2396     ofctl_group_mod__(argv[1], gms, n_gms, usable_protocols);
2397     for (i = 0; i < n_gms; i++) {
2398         ofputil_bucket_list_destroy(&gms[i].buckets);
2399     }
2400     free(gms);
2401 }
2402
2403 static void
2404 ofctl_group_mod(int argc, char *argv[], uint16_t command)
2405 {
2406     if (argc > 2 && !strcmp(argv[2], "-")) {
2407         ofctl_group_mod_file(argc, argv, command);
2408     } else {
2409         enum ofputil_protocol usable_protocols;
2410         struct ofputil_group_mod gm;
2411         char *error;
2412
2413         error = parse_ofp_group_mod_str(&gm, command, argc > 2 ? argv[2] : "",
2414                                         &usable_protocols);
2415         if (error) {
2416             ovs_fatal(0, "%s", error);
2417         }
2418         ofctl_group_mod__(argv[1], &gm, 1, usable_protocols);
2419         ofputil_bucket_list_destroy(&gm.buckets);
2420     }
2421 }
2422
2423 static void
2424 ofctl_add_group(struct ovs_cmdl_context *ctx)
2425 {
2426     ofctl_group_mod(ctx->argc, ctx->argv, OFPGC11_ADD);
2427 }
2428
2429 static void
2430 ofctl_add_groups(struct ovs_cmdl_context *ctx)
2431 {
2432     ofctl_group_mod_file(ctx->argc, ctx->argv, OFPGC11_ADD);
2433 }
2434
2435 static void
2436 ofctl_mod_group(struct ovs_cmdl_context *ctx)
2437 {
2438     ofctl_group_mod(ctx->argc, ctx->argv, OFPGC11_MODIFY);
2439 }
2440
2441 static void
2442 ofctl_del_groups(struct ovs_cmdl_context *ctx)
2443 {
2444     ofctl_group_mod(ctx->argc, ctx->argv, OFPGC11_DELETE);
2445 }
2446
2447 static void
2448 ofctl_insert_bucket(struct ovs_cmdl_context *ctx)
2449 {
2450     ofctl_group_mod(ctx->argc, ctx->argv, OFPGC15_INSERT_BUCKET);
2451 }
2452
2453 static void
2454 ofctl_remove_bucket(struct ovs_cmdl_context *ctx)
2455 {
2456     ofctl_group_mod(ctx->argc, ctx->argv, OFPGC15_REMOVE_BUCKET);
2457 }
2458
2459 static void
2460 ofctl_dump_group_stats(struct ovs_cmdl_context *ctx)
2461 {
2462     enum ofputil_protocol usable_protocols;
2463     struct ofputil_group_mod gm;
2464     struct ofpbuf *request;
2465     struct vconn *vconn;
2466     uint32_t group_id;
2467     char *error;
2468
2469     memset(&gm, 0, sizeof gm);
2470
2471     error = parse_ofp_group_mod_str(&gm, OFPGC11_DELETE,
2472                                     ctx->argc > 2 ? ctx->argv[2] : "",
2473                                     &usable_protocols);
2474     if (error) {
2475         ovs_fatal(0, "%s", error);
2476     }
2477
2478     group_id = gm.group_id;
2479
2480     open_vconn(ctx->argv[1], &vconn);
2481     request = ofputil_encode_group_stats_request(vconn_get_version(vconn),
2482                                                  group_id);
2483     if (request) {
2484         dump_transaction(vconn, request);
2485     }
2486
2487     vconn_close(vconn);
2488 }
2489
2490 static void
2491 ofctl_dump_group_desc(struct ovs_cmdl_context *ctx)
2492 {
2493     struct ofpbuf *request;
2494     struct vconn *vconn;
2495     uint32_t group_id;
2496
2497     open_vconn(ctx->argv[1], &vconn);
2498
2499     if (ctx->argc < 3 || !ofputil_group_from_string(ctx->argv[2], &group_id)) {
2500         group_id = OFPG_ALL;
2501     }
2502
2503     request = ofputil_encode_group_desc_request(vconn_get_version(vconn),
2504                                                 group_id);
2505     if (request) {
2506         dump_transaction(vconn, request);
2507     }
2508
2509     vconn_close(vconn);
2510 }
2511
2512 static void
2513 ofctl_dump_group_features(struct ovs_cmdl_context *ctx)
2514 {
2515     struct ofpbuf *request;
2516     struct vconn *vconn;
2517
2518     open_vconn(ctx->argv[1], &vconn);
2519     request = ofputil_encode_group_features_request(vconn_get_version(vconn));
2520     if (request) {
2521         dump_transaction(vconn, request);
2522     }
2523
2524     vconn_close(vconn);
2525 }
2526
2527 static void
2528 ofctl_tlv_mod(struct ovs_cmdl_context *ctx, uint16_t command)
2529 {
2530     enum ofputil_protocol usable_protocols;
2531     enum ofputil_protocol protocol;
2532     struct ofputil_tlv_table_mod ttm;
2533     char *error;
2534     enum ofp_version version;
2535     struct ofpbuf *request;
2536     struct vconn *vconn;
2537
2538     error = parse_ofp_tlv_table_mod_str(&ttm, command, ctx->argc > 2 ?
2539                                            ctx->argv[2] : "",
2540                                            &usable_protocols);
2541     if (error) {
2542         ovs_fatal(0, "%s", error);
2543     }
2544
2545     protocol = open_vconn_for_flow_mod(ctx->argv[1], &vconn, usable_protocols);
2546     version = ofputil_protocol_to_ofp_version(protocol);
2547
2548     request = ofputil_encode_tlv_table_mod(version, &ttm);
2549     if (request) {
2550         transact_noreply(vconn, request);
2551     }
2552
2553     vconn_close(vconn);
2554     ofputil_uninit_tlv_table(&ttm.mappings);
2555 }
2556
2557 static void
2558 ofctl_add_tlv_map(struct ovs_cmdl_context *ctx)
2559 {
2560     ofctl_tlv_mod(ctx, NXTTMC_ADD);
2561 }
2562
2563 static void
2564 ofctl_del_tlv_map(struct ovs_cmdl_context *ctx)
2565 {
2566     ofctl_tlv_mod(ctx, ctx->argc > 2 ? NXTTMC_DELETE : NXTTMC_CLEAR);
2567 }
2568
2569 static void
2570 ofctl_dump_tlv_map(struct ovs_cmdl_context *ctx)
2571 {
2572     dump_trivial_transaction(ctx->argv[1], OFPRAW_NXT_TLV_TABLE_REQUEST);
2573 }
2574
2575 static void
2576 ofctl_help(struct ovs_cmdl_context *ctx OVS_UNUSED)
2577 {
2578     usage();
2579 }
2580
2581 static void
2582 ofctl_list_commands(struct ovs_cmdl_context *ctx OVS_UNUSED)
2583 {
2584     ovs_cmdl_print_commands(get_all_commands());
2585 }
2586 \f
2587 /* replace-flows and diff-flows commands. */
2588
2589 struct flow_tables {
2590     struct classifier tables[OFPTT_MAX + 1];
2591 };
2592
2593 #define FOR_EACH_TABLE(CLS, TABLES)                               \
2594     for ((CLS) = (TABLES)->tables;                                \
2595          (CLS) < &(TABLES)->tables[ARRAY_SIZE((TABLES)->tables)]; \
2596          (CLS)++)
2597
2598 static void
2599 flow_tables_init(struct flow_tables *tables)
2600 {
2601     struct classifier *cls;
2602
2603     FOR_EACH_TABLE (cls, tables) {
2604         classifier_init(cls, NULL);
2605     }
2606 }
2607
2608 static void
2609 flow_tables_defer(struct flow_tables *tables)
2610 {
2611     struct classifier *cls;
2612
2613     FOR_EACH_TABLE (cls, tables) {
2614         classifier_defer(cls);
2615     }
2616 }
2617
2618 static void
2619 flow_tables_publish(struct flow_tables *tables)
2620 {
2621     struct classifier *cls;
2622
2623     FOR_EACH_TABLE (cls, tables) {
2624         classifier_publish(cls);
2625     }
2626 }
2627
2628 /* A flow table entry, possibly with two different versions. */
2629 struct fte {
2630     struct cls_rule rule;       /* Within a "struct classifier". */
2631     struct fte_version *versions[2];
2632 };
2633
2634 /* One version of a Flow Table Entry. */
2635 struct fte_version {
2636     ovs_be64 cookie;
2637     uint16_t idle_timeout;
2638     uint16_t hard_timeout;
2639     uint16_t importance;
2640     uint16_t flags;
2641     struct ofpact *ofpacts;
2642     size_t ofpacts_len;
2643     uint8_t table_id;
2644 };
2645
2646 /* Frees 'version' and the data that it owns. */
2647 static void
2648 fte_version_free(struct fte_version *version)
2649 {
2650     if (version) {
2651         free(CONST_CAST(struct ofpact *, version->ofpacts));
2652         free(version);
2653     }
2654 }
2655
2656 /* Returns true if 'a' and 'b' are the same, false if they differ.
2657  *
2658  * Ignores differences in 'flags' because there's no way to retrieve flags from
2659  * an OpenFlow switch.  We have to assume that they are the same. */
2660 static bool
2661 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
2662 {
2663     return (a->cookie == b->cookie
2664             && a->idle_timeout == b->idle_timeout
2665             && a->hard_timeout == b->hard_timeout
2666             && a->importance == b->importance
2667             && a->table_id == b->table_id
2668             && ofpacts_equal(a->ofpacts, a->ofpacts_len,
2669                              b->ofpacts, b->ofpacts_len));
2670 }
2671
2672 /* Clears 's', then if 's' has a version 'index', formats 'fte' and version
2673  * 'index' into 's', followed by a new-line. */
2674 static void
2675 fte_version_format(const struct fte *fte, int index, struct ds *s)
2676 {
2677     const struct fte_version *version = fte->versions[index];
2678
2679     ds_clear(s);
2680     if (!version) {
2681         return;
2682     }
2683
2684     if (version->table_id) {
2685         ds_put_format(s, "table=%"PRIu8" ", version->table_id);
2686     }
2687     cls_rule_format(&fte->rule, s);
2688     if (version->cookie != htonll(0)) {
2689         ds_put_format(s, " cookie=0x%"PRIx64, ntohll(version->cookie));
2690     }
2691     if (version->idle_timeout != OFP_FLOW_PERMANENT) {
2692         ds_put_format(s, " idle_timeout=%"PRIu16, version->idle_timeout);
2693     }
2694     if (version->hard_timeout != OFP_FLOW_PERMANENT) {
2695         ds_put_format(s, " hard_timeout=%"PRIu16, version->hard_timeout);
2696     }
2697     if (version->importance != 0) {
2698         ds_put_format(s, " importance=%"PRIu16, version->importance);
2699     }
2700
2701     ds_put_cstr(s, " actions=");
2702     ofpacts_format(version->ofpacts, version->ofpacts_len, s);
2703
2704     ds_put_char(s, '\n');
2705 }
2706
2707 static struct fte *
2708 fte_from_cls_rule(const struct cls_rule *cls_rule)
2709 {
2710     return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
2711 }
2712
2713 /* Frees 'fte' and its versions. */
2714 static void
2715 fte_free(struct fte *fte)
2716 {
2717     if (fte) {
2718         fte_version_free(fte->versions[0]);
2719         fte_version_free(fte->versions[1]);
2720         cls_rule_destroy(&fte->rule);
2721         free(fte);
2722     }
2723 }
2724
2725 /* Frees all of the FTEs within 'tables'. */
2726 static void
2727 fte_free_all(struct flow_tables *tables)
2728 {
2729     struct classifier *cls;
2730
2731     FOR_EACH_TABLE (cls, tables) {
2732         struct fte *fte;
2733
2734         classifier_defer(cls);
2735         CLS_FOR_EACH (fte, rule, cls) {
2736             classifier_remove(cls, &fte->rule);
2737             ovsrcu_postpone(fte_free, fte);
2738         }
2739         classifier_destroy(cls);
2740     }
2741 }
2742
2743 /* Searches 'tables' for an FTE matching 'rule', inserting a new one if
2744  * necessary.  Sets 'version' as the version of that rule with the given
2745  * 'index', replacing any existing version, if any.
2746  *
2747  * Takes ownership of 'version'. */
2748 static void
2749 fte_insert(struct flow_tables *tables, const struct match *match,
2750            int priority, struct fte_version *version, int index)
2751 {
2752     struct classifier *cls = &tables->tables[version->table_id];
2753     struct fte *old, *fte;
2754
2755     fte = xzalloc(sizeof *fte);
2756     cls_rule_init(&fte->rule, match, priority);
2757     fte->versions[index] = version;
2758
2759     old = fte_from_cls_rule(classifier_replace(cls, &fte->rule,
2760                                                CLS_MIN_VERSION, NULL, 0));
2761     if (old) {
2762         fte->versions[!index] = old->versions[!index];
2763         old->versions[!index] = NULL;
2764
2765         ovsrcu_postpone(fte_free, old);
2766     }
2767 }
2768
2769 /* Reads the flows in 'filename' as flow table entries in 'tables' for the
2770  * version with the specified 'index'.  Returns the flow formats able to
2771  * represent the flows that were read. */
2772 static enum ofputil_protocol
2773 read_flows_from_file(const char *filename, struct flow_tables *tables,
2774                      int index)
2775 {
2776     enum ofputil_protocol usable_protocols;
2777     int line_number;
2778     struct ds s;
2779     FILE *file;
2780
2781     file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
2782     if (file == NULL) {
2783         ovs_fatal(errno, "%s: open", filename);
2784     }
2785
2786     ds_init(&s);
2787     usable_protocols = OFPUTIL_P_ANY;
2788     line_number = 0;
2789     flow_tables_defer(tables);
2790     while (!ds_get_preprocessed_line(&s, file, &line_number)) {
2791         struct fte_version *version;
2792         struct ofputil_flow_mod fm;
2793         char *error;
2794         enum ofputil_protocol usable;
2795
2796         error = parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), &usable);
2797         if (error) {
2798             ovs_fatal(0, "%s:%d: %s", filename, line_number, error);
2799         }
2800         usable_protocols &= usable;
2801
2802         version = xmalloc(sizeof *version);
2803         version->cookie = fm.new_cookie;
2804         version->idle_timeout = fm.idle_timeout;
2805         version->hard_timeout = fm.hard_timeout;
2806         version->importance = fm.importance;
2807         version->flags = fm.flags & (OFPUTIL_FF_SEND_FLOW_REM
2808                                      | OFPUTIL_FF_EMERG);
2809         version->ofpacts = fm.ofpacts;
2810         version->ofpacts_len = fm.ofpacts_len;
2811         version->table_id = fm.table_id != OFPTT_ALL ? fm.table_id : 0;
2812
2813         fte_insert(tables, &fm.match, fm.priority, version, index);
2814     }
2815     flow_tables_publish(tables);
2816     ds_destroy(&s);
2817
2818     if (file != stdin) {
2819         fclose(file);
2820     }
2821
2822     return usable_protocols;
2823 }
2824
2825 static bool
2826 recv_flow_stats_reply(struct vconn *vconn, ovs_be32 send_xid,
2827                       struct ofpbuf **replyp,
2828                       struct ofputil_flow_stats *fs, struct ofpbuf *ofpacts)
2829 {
2830     struct ofpbuf *reply = *replyp;
2831
2832     for (;;) {
2833         int retval;
2834         bool more;
2835
2836         /* Get a flow stats reply message, if we don't already have one. */
2837         if (!reply) {
2838             enum ofptype type;
2839             enum ofperr error;
2840
2841             do {
2842                 run(vconn_recv_block(vconn, &reply),
2843                     "OpenFlow packet receive failed");
2844             } while (((struct ofp_header *) reply->data)->xid != send_xid);
2845
2846             error = ofptype_decode(&type, reply->data);
2847             if (error || type != OFPTYPE_FLOW_STATS_REPLY) {
2848                 ovs_fatal(0, "received bad reply: %s",
2849                           ofp_to_string(reply->data, reply->size,
2850                                         verbosity + 1));
2851             }
2852         }
2853
2854         /* Pull an individual flow stats reply out of the message. */
2855         retval = ofputil_decode_flow_stats_reply(fs, reply, false, ofpacts);
2856         switch (retval) {
2857         case 0:
2858             *replyp = reply;
2859             return true;
2860
2861         case EOF:
2862             more = ofpmp_more(reply->header);
2863             ofpbuf_delete(reply);
2864             reply = NULL;
2865             if (!more) {
2866                 *replyp = NULL;
2867                 return false;
2868             }
2869             break;
2870
2871         default:
2872             ovs_fatal(0, "parse error in reply (%s)",
2873                       ofperr_to_string(retval));
2874         }
2875     }
2876 }
2877
2878 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
2879  * format 'protocol', and adds them as flow table entries in 'tables' for the
2880  * version with the specified 'index'. */
2881 static void
2882 read_flows_from_switch(struct vconn *vconn,
2883                        enum ofputil_protocol protocol,
2884                        struct flow_tables *tables, int index)
2885 {
2886     struct ofputil_flow_stats_request fsr;
2887     struct ofputil_flow_stats fs;
2888     struct ofpbuf *request;
2889     struct ofpbuf ofpacts;
2890     struct ofpbuf *reply;
2891     ovs_be32 send_xid;
2892
2893     fsr.aggregate = false;
2894     match_init_catchall(&fsr.match);
2895     fsr.out_port = OFPP_ANY;
2896     fsr.out_group = OFPG_ANY;
2897     fsr.table_id = 0xff;
2898     fsr.cookie = fsr.cookie_mask = htonll(0);
2899     request = ofputil_encode_flow_stats_request(&fsr, protocol);
2900     send_xid = ((struct ofp_header *) request->data)->xid;
2901     send_openflow_buffer(vconn, request);
2902
2903     reply = NULL;
2904     ofpbuf_init(&ofpacts, 0);
2905     flow_tables_defer(tables);
2906     while (recv_flow_stats_reply(vconn, send_xid, &reply, &fs, &ofpacts)) {
2907         struct fte_version *version;
2908
2909         version = xmalloc(sizeof *version);
2910         version->cookie = fs.cookie;
2911         version->idle_timeout = fs.idle_timeout;
2912         version->hard_timeout = fs.hard_timeout;
2913         version->importance = fs.importance;
2914         version->flags = 0;
2915         version->ofpacts_len = fs.ofpacts_len;
2916         version->ofpacts = xmemdup(fs.ofpacts, fs.ofpacts_len);
2917         version->table_id = fs.table_id;
2918
2919         fte_insert(tables, &fs.match, fs.priority, version, index);
2920     }
2921     flow_tables_publish(tables);
2922     ofpbuf_uninit(&ofpacts);
2923 }
2924
2925 static void
2926 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
2927                   enum ofputil_protocol protocol, struct ovs_list *packets)
2928 {
2929     const struct fte_version *version = fte->versions[index];
2930     struct ofpbuf *ofm;
2931
2932     struct ofputil_flow_mod fm = {
2933         .priority = fte->rule.priority,
2934         .new_cookie = version->cookie,
2935         .modify_cookie = true,
2936         .table_id = version->table_id,
2937         .command = command,
2938         .idle_timeout = version->idle_timeout,
2939         .hard_timeout = version->hard_timeout,
2940         .importance = version->importance,
2941         .buffer_id = UINT32_MAX,
2942         .out_port = OFPP_ANY,
2943         .out_group = OFPG_ANY,
2944         .flags = version->flags,
2945         .delete_reason = OFPRR_DELETE,
2946     };
2947     minimatch_expand(&fte->rule.match, &fm.match);
2948     if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
2949         command == OFPFC_MODIFY_STRICT) {
2950         fm.ofpacts = version->ofpacts;
2951         fm.ofpacts_len = version->ofpacts_len;
2952     } else {
2953         fm.ofpacts = NULL;
2954         fm.ofpacts_len = 0;
2955     }
2956
2957     ofm = ofputil_encode_flow_mod(&fm, protocol);
2958     list_push_back(packets, &ofm->list_node);
2959 }
2960
2961 static void
2962 ofctl_replace_flows(struct ovs_cmdl_context *ctx)
2963 {
2964     enum { FILE_IDX = 0, SWITCH_IDX = 1 };
2965     enum ofputil_protocol usable_protocols, protocol;
2966     struct flow_tables tables;
2967     struct classifier *cls;
2968     struct ovs_list requests;
2969     struct vconn *vconn;
2970     struct fte *fte;
2971
2972     flow_tables_init(&tables);
2973     usable_protocols = read_flows_from_file(ctx->argv[2], &tables, FILE_IDX);
2974
2975     protocol = open_vconn(ctx->argv[1], &vconn);
2976     protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
2977
2978     read_flows_from_switch(vconn, protocol, &tables, SWITCH_IDX);
2979
2980     list_init(&requests);
2981
2982     FOR_EACH_TABLE (cls, &tables) {
2983         /* Delete flows that exist on the switch but not in the file. */
2984         CLS_FOR_EACH (fte, rule, cls) {
2985             struct fte_version *file_ver = fte->versions[FILE_IDX];
2986             struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2987
2988             if (sw_ver && !file_ver) {
2989                 fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
2990                                   protocol, &requests);
2991             }
2992         }
2993
2994         /* Add flows that exist in the file but not on the switch.
2995          * Update flows that exist in both places but differ. */
2996         CLS_FOR_EACH (fte, rule, cls) {
2997             struct fte_version *file_ver = fte->versions[FILE_IDX];
2998             struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2999
3000             if (file_ver &&
3001                 (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
3002                 fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, protocol,
3003                                   &requests);
3004             }
3005         }
3006     }
3007     if (bundle) {
3008         bundle_transact(vconn, &requests, OFPBF_ORDERED | OFPBF_ATOMIC);
3009     } else {
3010         transact_multiple_noreply(vconn, &requests);
3011     }
3012
3013     ofpbuf_list_delete(&requests);
3014     vconn_close(vconn);
3015
3016     fte_free_all(&tables);
3017 }
3018
3019 static void
3020 read_flows_from_source(const char *source, struct flow_tables *tables,
3021                        int index)
3022 {
3023     struct stat s;
3024
3025     if (source[0] == '/' || source[0] == '.'
3026         || (!strchr(source, ':') && !stat(source, &s))) {
3027         read_flows_from_file(source, tables, index);
3028     } else {
3029         enum ofputil_protocol protocol;
3030         struct vconn *vconn;
3031
3032         protocol = open_vconn(source, &vconn);
3033         protocol = set_protocol_for_flow_dump(vconn, protocol, OFPUTIL_P_ANY);
3034         read_flows_from_switch(vconn, protocol, tables, index);
3035         vconn_close(vconn);
3036     }
3037 }
3038
3039 static void
3040 ofctl_diff_flows(struct ovs_cmdl_context *ctx)
3041 {
3042     bool differences = false;
3043     struct flow_tables tables;
3044     struct classifier *cls;
3045     struct ds a_s, b_s;
3046     struct fte *fte;
3047
3048     flow_tables_init(&tables);
3049     read_flows_from_source(ctx->argv[1], &tables, 0);
3050     read_flows_from_source(ctx->argv[2], &tables, 1);
3051
3052     ds_init(&a_s);
3053     ds_init(&b_s);
3054
3055     FOR_EACH_TABLE (cls, &tables) {
3056         CLS_FOR_EACH (fte, rule, cls) {
3057             struct fte_version *a = fte->versions[0];
3058             struct fte_version *b = fte->versions[1];
3059
3060             if (!a || !b || !fte_version_equals(a, b)) {
3061                 fte_version_format(fte, 0, &a_s);
3062                 fte_version_format(fte, 1, &b_s);
3063                 if (strcmp(ds_cstr(&a_s), ds_cstr(&b_s))) {
3064                     if (a_s.length) {
3065                         printf("-%s", ds_cstr(&a_s));
3066                     }
3067                     if (b_s.length) {
3068                         printf("+%s", ds_cstr(&b_s));
3069                     }
3070                     differences = true;
3071                 }
3072             }
3073         }
3074     }
3075
3076     ds_destroy(&a_s);
3077     ds_destroy(&b_s);
3078
3079     fte_free_all(&tables);
3080
3081     if (differences) {
3082         exit(2);
3083     }
3084 }
3085
3086 static void
3087 ofctl_meter_mod__(const char *bridge, const char *str, int command)
3088 {
3089     struct ofputil_meter_mod mm;
3090     struct vconn *vconn;
3091     enum ofputil_protocol protocol;
3092     enum ofputil_protocol usable_protocols;
3093     enum ofp_version version;
3094
3095     if (str) {
3096         char *error;
3097         error = parse_ofp_meter_mod_str(&mm, str, command, &usable_protocols);
3098         if (error) {
3099             ovs_fatal(0, "%s", error);
3100         }
3101     } else {
3102         usable_protocols = OFPUTIL_P_OF13_UP;
3103         mm.command = command;
3104         mm.meter.meter_id = OFPM13_ALL;
3105     }
3106
3107     protocol = open_vconn_for_flow_mod(bridge, &vconn, usable_protocols);
3108     version = ofputil_protocol_to_ofp_version(protocol);
3109     transact_noreply(vconn, ofputil_encode_meter_mod(version, &mm));
3110     vconn_close(vconn);
3111 }
3112
3113 static void
3114 ofctl_meter_request__(const char *bridge, const char *str,
3115                       enum ofputil_meter_request_type type)
3116 {
3117     struct ofputil_meter_mod mm;
3118     struct vconn *vconn;
3119     enum ofputil_protocol usable_protocols;
3120     enum ofputil_protocol protocol;
3121     enum ofp_version version;
3122
3123     if (str) {
3124         char *error;
3125         error = parse_ofp_meter_mod_str(&mm, str, -1, &usable_protocols);
3126         if (error) {
3127             ovs_fatal(0, "%s", error);
3128         }
3129     } else {
3130         usable_protocols = OFPUTIL_P_OF13_UP;
3131         mm.meter.meter_id = OFPM13_ALL;
3132     }
3133
3134     protocol = open_vconn_for_flow_mod(bridge, &vconn, usable_protocols);
3135     version = ofputil_protocol_to_ofp_version(protocol);
3136     dump_transaction(vconn, ofputil_encode_meter_request(version, type,
3137                                                          mm.meter.meter_id));
3138     vconn_close(vconn);
3139 }
3140
3141
3142 static void
3143 ofctl_add_meter(struct ovs_cmdl_context *ctx)
3144 {
3145     ofctl_meter_mod__(ctx->argv[1], ctx->argv[2], OFPMC13_ADD);
3146 }
3147
3148 static void
3149 ofctl_mod_meter(struct ovs_cmdl_context *ctx)
3150 {
3151     ofctl_meter_mod__(ctx->argv[1], ctx->argv[2], OFPMC13_MODIFY);
3152 }
3153
3154 static void
3155 ofctl_del_meters(struct ovs_cmdl_context *ctx)
3156 {
3157     ofctl_meter_mod__(ctx->argv[1], ctx->argc > 2 ? ctx->argv[2] : NULL, OFPMC13_DELETE);
3158 }
3159
3160 static void
3161 ofctl_dump_meters(struct ovs_cmdl_context *ctx)
3162 {
3163     ofctl_meter_request__(ctx->argv[1], ctx->argc > 2 ? ctx->argv[2] : NULL,
3164                           OFPUTIL_METER_CONFIG);
3165 }
3166
3167 static void
3168 ofctl_meter_stats(struct ovs_cmdl_context *ctx)
3169 {
3170     ofctl_meter_request__(ctx->argv[1], ctx->argc > 2 ? ctx->argv[2] : NULL,
3171                           OFPUTIL_METER_STATS);
3172 }
3173
3174 static void
3175 ofctl_meter_features(struct ovs_cmdl_context *ctx)
3176 {
3177     ofctl_meter_request__(ctx->argv[1], NULL, OFPUTIL_METER_FEATURES);
3178 }
3179
3180 \f
3181 /* Undocumented commands for unit testing. */
3182
3183 static void
3184 ofctl_parse_flows__(struct ofputil_flow_mod *fms, size_t n_fms,
3185                     enum ofputil_protocol usable_protocols)
3186 {
3187     enum ofputil_protocol protocol = 0;
3188     char *usable_s;
3189     size_t i;
3190
3191     usable_s = ofputil_protocols_to_string(usable_protocols);
3192     printf("usable protocols: %s\n", usable_s);
3193     free(usable_s);
3194
3195     if (!(usable_protocols & allowed_protocols)) {
3196         ovs_fatal(0, "no usable protocol");
3197     }
3198     for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
3199         protocol = 1 << i;
3200         if (protocol & usable_protocols & allowed_protocols) {
3201             break;
3202         }
3203     }
3204     ovs_assert(is_pow2(protocol));
3205
3206     printf("chosen protocol: %s\n", ofputil_protocol_to_string(protocol));
3207
3208     for (i = 0; i < n_fms; i++) {
3209         struct ofputil_flow_mod *fm = &fms[i];
3210         struct ofpbuf *msg;
3211
3212         msg = ofputil_encode_flow_mod(fm, protocol);
3213         ofp_print(stdout, msg->data, msg->size, verbosity);
3214         ofpbuf_delete(msg);
3215
3216         free(CONST_CAST(struct ofpact *, fm->ofpacts));
3217     }
3218 }
3219
3220 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
3221  * it back to stdout.  */
3222 static void
3223 ofctl_parse_flow(struct ovs_cmdl_context *ctx)
3224 {
3225     enum ofputil_protocol usable_protocols;
3226     struct ofputil_flow_mod fm;
3227     char *error;
3228
3229     error = parse_ofp_flow_mod_str(&fm, ctx->argv[1], OFPFC_ADD, &usable_protocols);
3230     if (error) {
3231         ovs_fatal(0, "%s", error);
3232     }
3233     ofctl_parse_flows__(&fm, 1, usable_protocols);
3234 }
3235
3236 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
3237  * add-flows) and prints each of the flows back to stdout.  */
3238 static void
3239 ofctl_parse_flows(struct ovs_cmdl_context *ctx)
3240 {
3241     enum ofputil_protocol usable_protocols;
3242     struct ofputil_flow_mod *fms = NULL;
3243     size_t n_fms = 0;
3244     char *error;
3245
3246     error = parse_ofp_flow_mod_file(ctx->argv[1], OFPFC_ADD, &fms, &n_fms,
3247                                     &usable_protocols);
3248     if (error) {
3249         ovs_fatal(0, "%s", error);
3250     }
3251     ofctl_parse_flows__(fms, n_fms, usable_protocols);
3252     free(fms);
3253 }
3254
3255 static void
3256 ofctl_parse_nxm__(bool oxm, enum ofp_version version)
3257 {
3258     struct ds in;
3259
3260     ds_init(&in);
3261     while (!ds_get_test_line(&in, stdin)) {
3262         struct ofpbuf nx_match;
3263         struct match match;
3264         ovs_be64 cookie, cookie_mask;
3265         enum ofperr error;
3266         int match_len;
3267
3268         /* Convert string to nx_match. */
3269         ofpbuf_init(&nx_match, 0);
3270         if (oxm) {
3271             match_len = oxm_match_from_string(ds_cstr(&in), &nx_match);
3272         } else {
3273             match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
3274         }
3275
3276         /* Convert nx_match to match. */
3277         if (strict) {
3278             if (oxm) {
3279                 error = oxm_pull_match(&nx_match, &match);
3280             } else {
3281                 error = nx_pull_match(&nx_match, match_len, &match,
3282                                       &cookie, &cookie_mask);
3283             }
3284         } else {
3285             if (oxm) {
3286                 error = oxm_pull_match_loose(&nx_match, &match);
3287             } else {
3288                 error = nx_pull_match_loose(&nx_match, match_len, &match,
3289                                             &cookie, &cookie_mask);
3290             }
3291         }
3292
3293
3294         if (!error) {
3295             char *out;
3296
3297             /* Convert match back to nx_match. */
3298             ofpbuf_uninit(&nx_match);
3299             ofpbuf_init(&nx_match, 0);
3300             if (oxm) {
3301                 match_len = oxm_put_match(&nx_match, &match, version);
3302                 out = oxm_match_to_string(&nx_match, match_len);
3303             } else {
3304                 match_len = nx_put_match(&nx_match, &match,
3305                                          cookie, cookie_mask);
3306                 out = nx_match_to_string(nx_match.data, match_len);
3307             }
3308
3309             puts(out);
3310             free(out);
3311
3312             if (verbosity > 0) {
3313                 ovs_hex_dump(stdout, nx_match.data, nx_match.size, 0, false);
3314             }
3315         } else {
3316             printf("nx_pull_match() returned error %s\n",
3317                    ofperr_get_name(error));
3318         }
3319
3320         ofpbuf_uninit(&nx_match);
3321     }
3322     ds_destroy(&in);
3323 }
3324
3325 /* "parse-nxm": reads a series of NXM nx_match specifications as strings from
3326  * stdin, does some internal fussing with them, and then prints them back as
3327  * strings on stdout. */
3328 static void
3329 ofctl_parse_nxm(struct ovs_cmdl_context *ctx OVS_UNUSED)
3330 {
3331     ofctl_parse_nxm__(false, 0);
3332 }
3333
3334 /* "parse-oxm VERSION": reads a series of OXM nx_match specifications as
3335  * strings from stdin, does some internal fussing with them, and then prints
3336  * them back as strings on stdout.  VERSION must specify an OpenFlow version,
3337  * e.g. "OpenFlow12". */
3338 static void
3339 ofctl_parse_oxm(struct ovs_cmdl_context *ctx)
3340 {
3341     enum ofp_version version = ofputil_version_from_string(ctx->argv[1]);
3342     if (version < OFP12_VERSION) {
3343         ovs_fatal(0, "%s: not a valid version for OXM", ctx->argv[1]);
3344     }
3345
3346     ofctl_parse_nxm__(true, version);
3347 }
3348
3349 static void
3350 print_differences(const char *prefix,
3351                   const void *a_, size_t a_len,
3352                   const void *b_, size_t b_len)
3353 {
3354     const uint8_t *a = a_;
3355     const uint8_t *b = b_;
3356     size_t i;
3357
3358     for (i = 0; i < MIN(a_len, b_len); i++) {
3359         if (a[i] != b[i]) {
3360             printf("%s%2"PRIuSIZE": %02"PRIx8" -> %02"PRIx8"\n",
3361                    prefix, i, a[i], b[i]);
3362         }
3363     }
3364     for (i = a_len; i < b_len; i++) {
3365         printf("%s%2"PRIuSIZE": (none) -> %02"PRIx8"\n", prefix, i, b[i]);
3366     }
3367     for (i = b_len; i < a_len; i++) {
3368         printf("%s%2"PRIuSIZE": %02"PRIx8" -> (none)\n", prefix, i, a[i]);
3369     }
3370 }
3371
3372 static void
3373 ofctl_parse_actions__(const char *version_s, bool instructions)
3374 {
3375     enum ofp_version version;
3376     struct ds in;
3377
3378     version = ofputil_version_from_string(version_s);
3379     if (!version) {
3380         ovs_fatal(0, "%s: not a valid OpenFlow version", version_s);
3381     }
3382
3383     ds_init(&in);
3384     while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3385         struct ofpbuf of_out;
3386         struct ofpbuf of_in;
3387         struct ofpbuf ofpacts;
3388         const char *table_id;
3389         char *actions;
3390         enum ofperr error;
3391         size_t size;
3392         struct ds s;
3393
3394         /* Parse table_id separated with the follow-up actions by ",", if
3395          * any. */
3396         actions = ds_cstr(&in);
3397         table_id = NULL;
3398         if (strstr(actions, ",")) {
3399             table_id = strsep(&actions, ",");
3400         }
3401
3402         /* Parse hex bytes. */
3403         ofpbuf_init(&of_in, 0);
3404         if (ofpbuf_put_hex(&of_in, actions, NULL)[0] != '\0') {
3405             ovs_fatal(0, "Trailing garbage in hex data");
3406         }
3407
3408         /* Convert to ofpacts. */
3409         ofpbuf_init(&ofpacts, 0);
3410         size = of_in.size;
3411         error = (instructions
3412                  ? ofpacts_pull_openflow_instructions
3413                  : ofpacts_pull_openflow_actions)(
3414                      &of_in, of_in.size, version, &ofpacts);
3415         if (!error && instructions) {
3416             /* Verify actions, enforce consistency. */
3417             enum ofputil_protocol protocol;
3418             struct flow flow;
3419
3420             memset(&flow, 0, sizeof flow);
3421             protocol = ofputil_protocols_from_ofp_version(version);
3422             error = ofpacts_check_consistency(ofpacts.data, ofpacts.size,
3423                                               &flow, OFPP_MAX,
3424                                               table_id ? atoi(table_id) : 0,
3425                                               OFPTT_MAX + 1, protocol);
3426         }
3427         if (error) {
3428             printf("bad %s %s: %s\n\n",
3429                    version_s, instructions ? "instructions" : "actions",
3430                    ofperr_get_name(error));
3431             ofpbuf_uninit(&ofpacts);
3432             ofpbuf_uninit(&of_in);
3433             continue;
3434         }
3435         ofpbuf_push_uninit(&of_in, size);
3436
3437         /* Print cls_rule. */
3438         ds_init(&s);
3439         ds_put_cstr(&s, "actions=");
3440         ofpacts_format(ofpacts.data, ofpacts.size, &s);
3441         puts(ds_cstr(&s));
3442         ds_destroy(&s);
3443
3444         /* Convert back to ofp10 actions and print differences from input. */
3445         ofpbuf_init(&of_out, 0);
3446         if (instructions) {
3447            ofpacts_put_openflow_instructions(ofpacts.data, ofpacts.size,
3448                                              &of_out, version);
3449         } else {
3450            ofpacts_put_openflow_actions(ofpacts.data, ofpacts.size,
3451                                          &of_out, version);
3452         }
3453
3454         print_differences("", of_in.data, of_in.size,
3455                           of_out.data, of_out.size);
3456         putchar('\n');
3457
3458         ofpbuf_uninit(&ofpacts);
3459         ofpbuf_uninit(&of_in);
3460         ofpbuf_uninit(&of_out);
3461     }
3462     ds_destroy(&in);
3463 }
3464
3465 /* "parse-actions VERSION": reads a series of action specifications for the
3466  * given OpenFlow VERSION as hex bytes from stdin, converts them to ofpacts,
3467  * prints them as strings on stdout, and then converts them back to hex bytes
3468  * and prints any differences from the input. */
3469 static void
3470 ofctl_parse_actions(struct ovs_cmdl_context *ctx)
3471 {
3472     ofctl_parse_actions__(ctx->argv[1], false);
3473 }
3474
3475 /* "parse-actions VERSION": reads a series of instruction specifications for
3476  * the given OpenFlow VERSION as hex bytes from stdin, converts them to
3477  * ofpacts, prints them as strings on stdout, and then converts them back to
3478  * hex bytes and prints any differences from the input. */
3479 static void
3480 ofctl_parse_instructions(struct ovs_cmdl_context *ctx)
3481 {
3482     ofctl_parse_actions__(ctx->argv[1], true);
3483 }
3484
3485 /* "parse-ofp10-match": reads a series of ofp10_match specifications as hex
3486  * bytes from stdin, converts them to cls_rules, prints them as strings on
3487  * stdout, and then converts them back to hex bytes and prints any differences
3488  * from the input.
3489  *
3490  * The input hex bytes may contain "x"s to represent "don't-cares", bytes whose
3491  * values are ignored in the input and will be set to zero when OVS converts
3492  * them back to hex bytes.  ovs-ofctl actually sets "x"s to random bits when
3493  * it does the conversion to hex, to ensure that in fact they are ignored. */
3494 static void
3495 ofctl_parse_ofp10_match(struct ovs_cmdl_context *ctx OVS_UNUSED)
3496 {
3497     struct ds expout;
3498     struct ds in;
3499
3500     ds_init(&in);
3501     ds_init(&expout);
3502     while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3503         struct ofpbuf match_in, match_expout;
3504         struct ofp10_match match_out;
3505         struct ofp10_match match_normal;
3506         struct match match;
3507         char *p;
3508
3509         /* Parse hex bytes to use for expected output. */
3510         ds_clear(&expout);
3511         ds_put_cstr(&expout, ds_cstr(&in));
3512         for (p = ds_cstr(&expout); *p; p++) {
3513             if (*p == 'x') {
3514                 *p = '0';
3515             }
3516         }
3517         ofpbuf_init(&match_expout, 0);
3518         if (ofpbuf_put_hex(&match_expout, ds_cstr(&expout), NULL)[0] != '\0') {
3519             ovs_fatal(0, "Trailing garbage in hex data");
3520         }
3521         if (match_expout.size != sizeof(struct ofp10_match)) {
3522             ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3523                       match_expout.size, sizeof(struct ofp10_match));
3524         }
3525
3526         /* Parse hex bytes for input. */
3527         for (p = ds_cstr(&in); *p; p++) {
3528             if (*p == 'x') {
3529                 *p = "0123456789abcdef"[random_uint32() & 0xf];
3530             }
3531         }
3532         ofpbuf_init(&match_in, 0);
3533         if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
3534             ovs_fatal(0, "Trailing garbage in hex data");
3535         }
3536         if (match_in.size != sizeof(struct ofp10_match)) {
3537             ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3538                       match_in.size, sizeof(struct ofp10_match));
3539         }
3540
3541         /* Convert to cls_rule and print. */
3542         ofputil_match_from_ofp10_match(match_in.data, &match);
3543         match_print(&match);
3544
3545         /* Convert back to ofp10_match and print differences from input. */
3546         ofputil_match_to_ofp10_match(&match, &match_out);
3547         print_differences("", match_expout.data, match_expout.size,
3548                           &match_out, sizeof match_out);
3549
3550         /* Normalize, then convert and compare again. */
3551         ofputil_normalize_match(&match);
3552         ofputil_match_to_ofp10_match(&match, &match_normal);
3553         print_differences("normal: ", &match_out, sizeof match_out,
3554                           &match_normal, sizeof match_normal);
3555         putchar('\n');
3556
3557         ofpbuf_uninit(&match_in);
3558         ofpbuf_uninit(&match_expout);
3559     }
3560     ds_destroy(&in);
3561     ds_destroy(&expout);
3562 }
3563
3564 /* "parse-ofp11-match": reads a series of ofp11_match specifications as hex
3565  * bytes from stdin, converts them to "struct match"es, prints them as strings
3566  * on stdout, and then converts them back to hex bytes and prints any
3567  * differences from the input. */
3568 static void
3569 ofctl_parse_ofp11_match(struct ovs_cmdl_context *ctx OVS_UNUSED)
3570 {
3571     struct ds in;
3572
3573     ds_init(&in);
3574     while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3575         struct ofpbuf match_in;
3576         struct ofp11_match match_out;
3577         struct match match;
3578         enum ofperr error;
3579
3580         /* Parse hex bytes. */
3581         ofpbuf_init(&match_in, 0);
3582         if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
3583             ovs_fatal(0, "Trailing garbage in hex data");
3584         }
3585         if (match_in.size != sizeof(struct ofp11_match)) {
3586             ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3587                       match_in.size, sizeof(struct ofp11_match));
3588         }
3589
3590         /* Convert to match. */
3591         error = ofputil_match_from_ofp11_match(match_in.data, &match);
3592         if (error) {
3593             printf("bad ofp11_match: %s\n\n", ofperr_get_name(error));
3594             ofpbuf_uninit(&match_in);
3595             continue;
3596         }
3597
3598         /* Print match. */
3599         match_print(&match);
3600
3601         /* Convert back to ofp11_match and print differences from input. */
3602         ofputil_match_to_ofp11_match(&match, &match_out);
3603
3604         print_differences("", match_in.data, match_in.size,
3605                           &match_out, sizeof match_out);
3606         putchar('\n');
3607
3608         ofpbuf_uninit(&match_in);
3609     }
3610     ds_destroy(&in);
3611 }
3612
3613 /* "parse-pcap PCAP": read packets from PCAP and print their flows. */
3614 static void
3615 ofctl_parse_pcap(struct ovs_cmdl_context *ctx)
3616 {
3617     FILE *pcap;
3618
3619     pcap = ovs_pcap_open(ctx->argv[1], "rb");
3620     if (!pcap) {
3621         ovs_fatal(errno, "%s: open failed", ctx->argv[1]);
3622     }
3623
3624     for (;;) {
3625         struct dp_packet *packet;
3626         struct flow flow;
3627         int error;
3628
3629         error = ovs_pcap_read(pcap, &packet, NULL);
3630         if (error == EOF) {
3631             break;
3632         } else if (error) {
3633             ovs_fatal(error, "%s: read failed", ctx->argv[1]);
3634         }
3635
3636         pkt_metadata_init(&packet->md, ODPP_NONE);
3637         flow_extract(packet, &flow);
3638         flow_print(stdout, &flow);
3639         putchar('\n');
3640         dp_packet_delete(packet);
3641     }
3642 }
3643
3644 /* "check-vlan VLAN_TCI VLAN_TCI_MASK": converts the specified vlan_tci and
3645  * mask values to and from various formats and prints the results. */
3646 static void
3647 ofctl_check_vlan(struct ovs_cmdl_context *ctx)
3648 {
3649     struct match match;
3650
3651     char *string_s;
3652     struct ofputil_flow_mod fm;
3653
3654     struct ofpbuf nxm;
3655     struct match nxm_match;
3656     int nxm_match_len;
3657     char *nxm_s;
3658
3659     struct ofp10_match of10_raw;
3660     struct match of10_match;
3661
3662     struct ofp11_match of11_raw;
3663     struct match of11_match;
3664
3665     enum ofperr error;
3666     char *error_s;
3667
3668     enum ofputil_protocol usable_protocols; /* Unused for now. */
3669
3670     match_init_catchall(&match);
3671     match.flow.vlan_tci = htons(strtoul(ctx->argv[1], NULL, 16));
3672     match.wc.masks.vlan_tci = htons(strtoul(ctx->argv[2], NULL, 16));
3673
3674     /* Convert to and from string. */
3675     string_s = match_to_string(&match, OFP_DEFAULT_PRIORITY);
3676     printf("%s -> ", string_s);
3677     fflush(stdout);
3678     error_s = parse_ofp_str(&fm, -1, string_s, &usable_protocols);
3679     if (error_s) {
3680         ovs_fatal(0, "%s", error_s);
3681     }
3682     printf("%04"PRIx16"/%04"PRIx16"\n",
3683            ntohs(fm.match.flow.vlan_tci),
3684            ntohs(fm.match.wc.masks.vlan_tci));
3685     free(string_s);
3686
3687     /* Convert to and from NXM. */
3688     ofpbuf_init(&nxm, 0);
3689     nxm_match_len = nx_put_match(&nxm, &match, htonll(0), htonll(0));
3690     nxm_s = nx_match_to_string(nxm.data, nxm_match_len);
3691     error = nx_pull_match(&nxm, nxm_match_len, &nxm_match, NULL, NULL);
3692     printf("NXM: %s -> ", nxm_s);
3693     if (error) {
3694         printf("%s\n", ofperr_to_string(error));
3695     } else {
3696         printf("%04"PRIx16"/%04"PRIx16"\n",
3697                ntohs(nxm_match.flow.vlan_tci),
3698                ntohs(nxm_match.wc.masks.vlan_tci));
3699     }
3700     free(nxm_s);
3701     ofpbuf_uninit(&nxm);
3702
3703     /* Convert to and from OXM. */
3704     ofpbuf_init(&nxm, 0);
3705     nxm_match_len = oxm_put_match(&nxm, &match, OFP12_VERSION);
3706     nxm_s = oxm_match_to_string(&nxm, nxm_match_len);
3707     error = oxm_pull_match(&nxm, &nxm_match);
3708     printf("OXM: %s -> ", nxm_s);
3709     if (error) {
3710         printf("%s\n", ofperr_to_string(error));
3711     } else {
3712         uint16_t vid = ntohs(nxm_match.flow.vlan_tci) &
3713             (VLAN_VID_MASK | VLAN_CFI);
3714         uint16_t mask = ntohs(nxm_match.wc.masks.vlan_tci) &
3715             (VLAN_VID_MASK | VLAN_CFI);
3716
3717         printf("%04"PRIx16"/%04"PRIx16",", vid, mask);
3718         if (vid && vlan_tci_to_pcp(nxm_match.wc.masks.vlan_tci)) {
3719             printf("%02"PRIx8"\n", vlan_tci_to_pcp(nxm_match.flow.vlan_tci));
3720         } else {
3721             printf("--\n");
3722         }
3723     }
3724     free(nxm_s);
3725     ofpbuf_uninit(&nxm);
3726
3727     /* Convert to and from OpenFlow 1.0. */
3728     ofputil_match_to_ofp10_match(&match, &of10_raw);
3729     ofputil_match_from_ofp10_match(&of10_raw, &of10_match);
3730     printf("OF1.0: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
3731            ntohs(of10_raw.dl_vlan),
3732            (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN)) != 0,
3733            of10_raw.dl_vlan_pcp,
3734            (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN_PCP)) != 0,
3735            ntohs(of10_match.flow.vlan_tci),
3736            ntohs(of10_match.wc.masks.vlan_tci));
3737
3738     /* Convert to and from OpenFlow 1.1. */
3739     ofputil_match_to_ofp11_match(&match, &of11_raw);
3740     ofputil_match_from_ofp11_match(&of11_raw, &of11_match);
3741     printf("OF1.1: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
3742            ntohs(of11_raw.dl_vlan),
3743            (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN)) != 0,
3744            of11_raw.dl_vlan_pcp,
3745            (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN_PCP)) != 0,
3746            ntohs(of11_match.flow.vlan_tci),
3747            ntohs(of11_match.wc.masks.vlan_tci));
3748 }
3749
3750 /* "print-error ENUM": Prints the type and code of ENUM for every OpenFlow
3751  * version. */
3752 static void
3753 ofctl_print_error(struct ovs_cmdl_context *ctx)
3754 {
3755     enum ofperr error;
3756     int version;
3757
3758     error = ofperr_from_name(ctx->argv[1]);
3759     if (!error) {
3760         ovs_fatal(0, "unknown error \"%s\"", ctx->argv[1]);
3761     }
3762
3763     for (version = 0; version <= UINT8_MAX; version++) {
3764         const char *name = ofperr_domain_get_name(version);
3765         if (name) {
3766             int vendor = ofperr_get_vendor(error, version);
3767             int type = ofperr_get_type(error, version);
3768             int code = ofperr_get_code(error, version);
3769
3770             if (vendor != -1 || type != -1 || code != -1) {
3771                 printf("%s: vendor %#x, type %d, code %d\n",
3772                        name, vendor, type, code);
3773             }
3774         }
3775     }
3776 }
3777
3778 /* "encode-error-reply ENUM REQUEST": Encodes an error reply to REQUEST for the
3779  * error named ENUM and prints the error reply in hex. */
3780 static void
3781 ofctl_encode_error_reply(struct ovs_cmdl_context *ctx)
3782 {
3783     const struct ofp_header *oh;
3784     struct ofpbuf request, *reply;
3785     enum ofperr error;
3786
3787     error = ofperr_from_name(ctx->argv[1]);
3788     if (!error) {
3789         ovs_fatal(0, "unknown error \"%s\"", ctx->argv[1]);
3790     }
3791
3792     ofpbuf_init(&request, 0);
3793     if (ofpbuf_put_hex(&request, ctx->argv[2], NULL)[0] != '\0') {
3794         ovs_fatal(0, "Trailing garbage in hex data");
3795     }
3796     if (request.size < sizeof(struct ofp_header)) {
3797         ovs_fatal(0, "Request too short");
3798     }
3799
3800     oh = request.data;
3801     if (request.size != ntohs(oh->length)) {
3802         ovs_fatal(0, "Request size inconsistent");
3803     }
3804
3805     reply = ofperr_encode_reply(error, request.data);
3806     ofpbuf_uninit(&request);
3807
3808     ovs_hex_dump(stdout, reply->data, reply->size, 0, false);
3809     ofpbuf_delete(reply);
3810 }
3811
3812 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
3813  * binary data, interpreting them as an OpenFlow message, and prints the
3814  * OpenFlow message on stdout, at VERBOSITY (level 2 by default).
3815  *
3816  * Alternative usage: "ofp-print [VERBOSITY] - < HEXSTRING_FILE", where
3817  * HEXSTRING_FILE contains the HEXSTRING. */
3818 static void
3819 ofctl_ofp_print(struct ovs_cmdl_context *ctx)
3820 {
3821     struct ofpbuf packet;
3822     char *buffer;
3823     int verbosity = 2;
3824     struct ds line;
3825
3826     ds_init(&line);
3827
3828     if (!strcmp(ctx->argv[ctx->argc-1], "-")) {
3829         if (ds_get_line(&line, stdin)) {
3830            VLOG_FATAL("Failed to read stdin");
3831         }
3832
3833         buffer = line.string;
3834         verbosity = ctx->argc > 2 ? atoi(ctx->argv[1]) : verbosity;
3835     } else if (ctx->argc > 2) {
3836         buffer = ctx->argv[1];
3837         verbosity = atoi(ctx->argv[2]);
3838     } else {
3839         buffer = ctx->argv[1];
3840     }
3841
3842     ofpbuf_init(&packet, strlen(buffer) / 2);
3843     if (ofpbuf_put_hex(&packet, buffer, NULL)[0] != '\0') {
3844         ovs_fatal(0, "trailing garbage following hex bytes");
3845     }
3846     ofp_print(stdout, packet.data, packet.size, verbosity);
3847     ofpbuf_uninit(&packet);
3848     ds_destroy(&line);
3849 }
3850
3851 /* "encode-hello BITMAP...": Encodes each BITMAP as an OpenFlow hello message
3852  * and dumps each message in hex.  */
3853 static void
3854 ofctl_encode_hello(struct ovs_cmdl_context *ctx)
3855 {
3856     uint32_t bitmap = strtol(ctx->argv[1], NULL, 0);
3857     struct ofpbuf *hello;
3858
3859     hello = ofputil_encode_hello(bitmap);
3860     ovs_hex_dump(stdout, hello->data, hello->size, 0, false);
3861     ofp_print(stdout, hello->data, hello->size, verbosity);
3862     ofpbuf_delete(hello);
3863 }
3864
3865 static const struct ovs_cmdl_command all_commands[] = {
3866     { "show", "switch",
3867       1, 1, ofctl_show },
3868     { "monitor", "switch [misslen] [invalid_ttl] [watch:[...]]",
3869       1, 3, ofctl_monitor },
3870     { "snoop", "switch",
3871       1, 1, ofctl_snoop },
3872     { "dump-desc", "switch",
3873       1, 1, ofctl_dump_desc },
3874     { "dump-tables", "switch",
3875       1, 1, ofctl_dump_tables },
3876     { "dump-table-features", "switch",
3877       1, 1, ofctl_dump_table_features },
3878     { "dump-table-desc", "switch",
3879       1, 1, ofctl_dump_table_desc },
3880     { "dump-flows", "switch",
3881       1, 2, ofctl_dump_flows },
3882     { "dump-aggregate", "switch",
3883       1, 2, ofctl_dump_aggregate },
3884     { "queue-stats", "switch [port [queue]]",
3885       1, 3, ofctl_queue_stats },
3886     { "queue-get-config", "switch [port]",
3887       1, 2, ofctl_queue_get_config },
3888     { "add-flow", "switch flow",
3889       2, 2, ofctl_add_flow },
3890     { "add-flows", "switch file",
3891       2, 2, ofctl_add_flows },
3892     { "mod-flows", "switch flow",
3893       2, 2, ofctl_mod_flows },
3894     { "del-flows", "switch [flow]",
3895       1, 2, ofctl_del_flows },
3896     { "replace-flows", "switch file",
3897       2, 2, ofctl_replace_flows },
3898     { "diff-flows", "source1 source2",
3899       2, 2, ofctl_diff_flows },
3900     { "add-meter", "switch meter",
3901       2, 2, ofctl_add_meter },
3902     { "mod-meter", "switch meter",
3903       2, 2, ofctl_mod_meter },
3904     { "del-meter", "switch meter",
3905       2, 2, ofctl_del_meters },
3906     { "del-meters", "switch",
3907       1, 1, ofctl_del_meters },
3908     { "dump-meter", "switch meter",
3909       2, 2, ofctl_dump_meters },
3910     { "dump-meters", "switch",
3911       1, 1, ofctl_dump_meters },
3912     { "meter-stats", "switch [meter]",
3913       1, 2, ofctl_meter_stats },
3914     { "meter-features", "switch",
3915       1, 1, ofctl_meter_features },
3916     { "packet-out", "switch in_port actions packet...",
3917       4, INT_MAX, ofctl_packet_out },
3918     { "dump-ports", "switch [port]",
3919       1, 2, ofctl_dump_ports },
3920     { "dump-ports-desc", "switch [port]",
3921       1, 2, ofctl_dump_ports_desc },
3922     { "mod-port", "switch iface act",
3923       3, 3, ofctl_mod_port },
3924     { "mod-table", "switch mod",
3925       3, 3, ofctl_mod_table },
3926     { "get-frags", "switch",
3927       1, 1, ofctl_get_frags },
3928     { "set-frags", "switch frag_mode",
3929       2, 2, ofctl_set_frags },
3930     { "probe", "target",
3931       1, 1, ofctl_probe },
3932     { "ping", "target [n]",
3933       1, 2, ofctl_ping },
3934     { "benchmark", "target n count",
3935       3, 3, ofctl_benchmark },
3936
3937     { "ofp-parse", "file",
3938       1, 1, ofctl_ofp_parse },
3939     { "ofp-parse-pcap", "pcap",
3940       1, INT_MAX, ofctl_ofp_parse_pcap },
3941
3942     { "add-group", "switch group",
3943       1, 2, ofctl_add_group },
3944     { "add-groups", "switch file",
3945       1, 2, ofctl_add_groups },
3946     { "mod-group", "switch group",
3947       1, 2, ofctl_mod_group },
3948     { "del-groups", "switch [group]",
3949       1, 2, ofctl_del_groups },
3950     { "insert-buckets", "switch [group]",
3951       1, 2, ofctl_insert_bucket },
3952     { "remove-buckets", "switch [group]",
3953       1, 2, ofctl_remove_bucket },
3954     { "dump-groups", "switch [group]",
3955       1, 2, ofctl_dump_group_desc },
3956     { "dump-group-stats", "switch [group]",
3957       1, 2, ofctl_dump_group_stats },
3958     { "dump-group-features", "switch",
3959       1, 1, ofctl_dump_group_features },
3960     { "add-tlv-map", "switch map",
3961       2, 2, ofctl_add_tlv_map },
3962     { "del-tlv-map", "switch [map]",
3963       1, 2, ofctl_del_tlv_map },
3964     { "dump-tlv-map", "switch",
3965       1, 1, ofctl_dump_tlv_map },
3966     { "help", NULL, 0, INT_MAX, ofctl_help },
3967     { "list-commands", NULL, 0, INT_MAX, ofctl_list_commands },
3968
3969     /* Undocumented commands for testing. */
3970     { "parse-flow", NULL, 1, 1, ofctl_parse_flow },
3971     { "parse-flows", NULL, 1, 1, ofctl_parse_flows },
3972     { "parse-nx-match", NULL, 0, 0, ofctl_parse_nxm },
3973     { "parse-nxm", NULL, 0, 0, ofctl_parse_nxm },
3974     { "parse-oxm", NULL, 1, 1, ofctl_parse_oxm },
3975     { "parse-actions", NULL, 1, 1, ofctl_parse_actions },
3976     { "parse-instructions", NULL, 1, 1, ofctl_parse_instructions },
3977     { "parse-ofp10-match", NULL, 0, 0, ofctl_parse_ofp10_match },
3978     { "parse-ofp11-match", NULL, 0, 0, ofctl_parse_ofp11_match },
3979     { "parse-pcap", NULL, 1, 1, ofctl_parse_pcap },
3980     { "check-vlan", NULL, 2, 2, ofctl_check_vlan },
3981     { "print-error", NULL, 1, 1, ofctl_print_error },
3982     { "encode-error-reply", NULL, 2, 2, ofctl_encode_error_reply },
3983     { "ofp-print", NULL, 1, 2, ofctl_ofp_print },
3984     { "encode-hello", NULL, 1, 1, ofctl_encode_hello },
3985
3986     { NULL, NULL, 0, 0, NULL },
3987 };
3988
3989 static const struct ovs_cmdl_command *get_all_commands(void)
3990 {
3991     return all_commands;
3992 }