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     enum ofptype type;
 850     if (ofptype_decode(&type, pi->reply->data)
 851         || type != OFPTYPE_FEATURES_REPLY) {
 852         ovs_fatal(0, "%s: received bad features reply",
 853                   vconn_get_name(pi->vconn));
 854     }
 855     if (!ofputil_switch_features_has_ports(pi->reply)) {
 856         /* The switch features reply does not contain a complete list of ports.
 857          * Probably, there are more ports than will fit into a single 64 kB
 858          * OpenFlow message.  Use OFPST_PORT_DESC to get a complete list of
 859          * ports. */
 860         ofpbuf_delete(pi->reply);
 861         pi->reply = NULL;
 862         port_iterator_fetch_port_desc(pi);
 863         return;
 864     }
 865
 866     struct ofputil_switch_features features;
 867     enum ofperr error = ofputil_pull_switch_features(pi->reply, &features);
 868     if (error) {
 869         ovs_fatal(0, "%s: failed to decode features reply (%s)",
 870                   vconn_get_name(pi->vconn), ofperr_to_string(error));
 871     }
 872 }
 873
 874 /* Initializes 'pi' to prepare for iterating through all of the ports on the
 875  * OpenFlow switch to which 'vconn' is connected.
 876  *
 877  * During iteration, the client should not make other use of 'vconn', because
 878  * that can cause other messages to be interleaved with the replies used by the
 879  * iterator and thus some ports may be missed or a hang can occur. */
 880 static void
 881 port_iterator_init(struct port_iterator *pi, struct vconn *vconn)
 882 {
 883     memset(pi, 0, sizeof *pi);
 884     pi->vconn = vconn;
 885     if (vconn_get_version(vconn) < OFP13_VERSION) {
 886         port_iterator_fetch_features(pi);
 887     } else {
 888         port_iterator_fetch_port_desc(pi);
 889     }
 890 }
 891
 892 /* Obtains the next port from 'pi'.  On success, initializes '*pp' with the
 893  * port's details and returns true, otherwise (if all the ports have already
 894  * been seen), returns false.  */
 895 static bool
 896 port_iterator_next(struct port_iterator *pi, struct ofputil_phy_port *pp)
 897 {
 898     for (;;) {
 899         if (pi->reply) {
 900             int retval = ofputil_pull_phy_port(vconn_get_version(pi->vconn),
 901                                                pi->reply, pp);
 902             if (!retval) {
 903                 return true;
 904             } else if (retval != EOF) {
 905                 ovs_fatal(0, "received bad reply: %s",
 906                           ofp_to_string(pi->reply->data, pi->reply->size,
 907                                         verbosity + 1));
 908             }
 909         }
 910
 911         if (pi->variant == PI_FEATURES || !pi->more) {
 912             return false;
 913         }
 914
 915         ovs_be32 recv_xid;
 916         do {
 917             ofpbuf_delete(pi->reply);
 918             run(vconn_recv_block(pi->vconn, &pi->reply),
 919                 "OpenFlow receive failed");
 920             recv_xid = ((struct ofp_header *) pi->reply->data)->xid;
 921         } while (pi->send_xid != recv_xid);
 922
 923         struct ofp_header *oh = pi->reply->data;
 924         enum ofptype type;
 925         if (ofptype_pull(&type, pi->reply)
 926             || type != OFPTYPE_PORT_DESC_STATS_REPLY) {
 927             ovs_fatal(0, "received bad reply: %s",
 928                       ofp_to_string(pi->reply->data, pi->reply->size,
 929                                     verbosity + 1));
 930         }
 931
 932         pi->more = (ofpmp_flags(oh) & OFPSF_REPLY_MORE) != 0;
 933     }
 934 }
 935
 936 /* Destroys iterator 'pi'. */
 937 static void
 938 port_iterator_destroy(struct port_iterator *pi)
 939 {
 940     if (pi) {
 941         while (pi->variant == PI_PORT_DESC && pi->more) {
 942             /* Drain vconn's queue of any other replies for this request. */
 943             struct ofputil_phy_port pp;
 944             port_iterator_next(pi, &pp);
 945         }
 946
 947         ofpbuf_delete(pi->reply);
 948     }
 949 }
 950
 951 /* Opens a connection to 'vconn_name', fetches the port structure for
 952  * 'port_name' (which may be a port name or number), and copies it into
 953  * '*pp'. */
 954 static void
 955 fetch_ofputil_phy_port(const char *vconn_name, const char *port_name,
 956                        struct ofputil_phy_port *pp)
 957 {
 958     struct vconn *vconn;
 959     ofp_port_t port_no;
 960     bool found = false;
 961
 962     /* Try to interpret the argument as a port number. */
 963     if (!str_to_ofp(port_name, &port_no)) {
 964         port_no = OFPP_NONE;
 965     }
 966
 967     /* OpenFlow 1.0, 1.1, and 1.2 put the list of ports in the
 968      * OFPT_FEATURES_REPLY message.  OpenFlow 1.3 and later versions put it
 969      * into the OFPST_PORT_DESC reply.  Try it the correct way. */
 970     open_vconn(vconn_name, &vconn);
 971     struct port_iterator pi;
 972     for (port_iterator_init(&pi, vconn); port_iterator_next(&pi, pp); ) {
 973         if (port_no != OFPP_NONE
 974             ? port_no == pp->port_no
 975             : !strcmp(pp->name, port_name)) {
 976             found = true;
 977             break;
 978         }
 979     }
 980     port_iterator_destroy(&pi);
 981     vconn_close(vconn);
 982
 983     if (!found) {
 984         ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
 985     }
 986 }
 987
 988 /* Returns the port number corresponding to 'port_name' (which may be a port
 989  * name or number) within the switch 'vconn_name'. */
 990 static ofp_port_t
 991 str_to_port_no(const char *vconn_name, const char *port_name)
 992 {
 993     ofp_port_t port_no;
 994
 995     if (ofputil_port_from_string(port_name, &port_no)) {
 996         return port_no;
 997     } else {
 998         struct ofputil_phy_port pp;
 999
1000         fetch_ofputil_phy_port(vconn_name, port_name, &pp);
1001         return pp.port_no;
1002     }
1003 }
1004
1005 static bool
1006 try_set_protocol(struct vconn *vconn, enum ofputil_protocol want,
1007                  enum ofputil_protocol *cur)
1008 {
1009     for (;;) {
1010         struct ofpbuf *request, *reply;
1011         enum ofputil_protocol next;
1012
1013         request = ofputil_encode_set_protocol(*cur, want, &next);
1014         if (!request) {
1015             return *cur == want;
1016         }
1017
1018         run(vconn_transact_noreply(vconn, request, &reply),
1019             "talking to %s", vconn_get_name(vconn));
1020         if (reply) {
1021             char *s = ofp_to_string(reply->data, reply->size, 2);
1022             VLOG_DBG("%s: failed to set protocol, switch replied: %s",
1023                      vconn_get_name(vconn), s);
1024             free(s);
1025             ofpbuf_delete(reply);
1026             return false;
1027         }
1028
1029         *cur = next;
1030     }
1031 }
1032
1033 static enum ofputil_protocol
1034 set_protocol_for_flow_dump(struct vconn *vconn,
1035                            enum ofputil_protocol cur_protocol,
1036                            enum ofputil_protocol usable_protocols)
1037 {
1038     char *usable_s;
1039     int i;
1040
1041     for (i = 0; i < ofputil_n_flow_dump_protocols; i++) {
1042         enum ofputil_protocol f = ofputil_flow_dump_protocols[i];
1043         if (f & usable_protocols & allowed_protocols
1044             && try_set_protocol(vconn, f, &cur_protocol)) {
1045             return f;
1046         }
1047     }
1048
1049     usable_s = ofputil_protocols_to_string(usable_protocols);
1050     if (usable_protocols & allowed_protocols) {
1051         ovs_fatal(0, "switch does not support any of the usable flow "
1052                   "formats (%s)", usable_s);
1053     } else {
1054         char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
1055         ovs_fatal(0, "none of the usable flow formats (%s) is among the "
1056                   "allowed flow formats (%s)", usable_s, allowed_s);
1057     }
1058 }
1059
1060 static struct vconn *
1061 prepare_dump_flows(int argc, char *argv[], bool aggregate,
1062                    struct ofpbuf **requestp)
1063 {
1064     enum ofputil_protocol usable_protocols, protocol;
1065     struct ofputil_flow_stats_request fsr;
1066     struct vconn *vconn;
1067     char *error;
1068
1069     error = parse_ofp_flow_stats_request_str(&fsr, aggregate,
1070                                              argc > 2 ? argv[2] : "",
1071                                              &usable_protocols);
1072     if (error) {
1073         ovs_fatal(0, "%s", error);
1074     }
1075
1076     protocol = open_vconn(argv[1], &vconn);
1077     protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
1078     *requestp = ofputil_encode_flow_stats_request(&fsr, protocol);
1079     return vconn;
1080 }
1081
1082 static void
1083 ofctl_dump_flows__(int argc, char *argv[], bool aggregate)
1084 {
1085     struct ofpbuf *request;
1086     struct vconn *vconn;
1087
1088     vconn = prepare_dump_flows(argc, argv, aggregate, &request);
1089     dump_transaction(vconn, request);
1090     vconn_close(vconn);
1091 }
1092
1093 static int
1094 compare_flows(const void *afs_, const void *bfs_)
1095 {
1096     const struct ofputil_flow_stats *afs = afs_;
1097     const struct ofputil_flow_stats *bfs = bfs_;
1098     const struct match *a = &afs->match;
1099     const struct match *b = &bfs->match;
1100     const struct sort_criterion *sc;
1101
1102     for (sc = criteria; sc < &criteria[n_criteria]; sc++) {
1103         const struct mf_field *f = sc->field;
1104         int ret;
1105
1106         if (!f) {
1107             int a_pri = afs->priority;
1108             int b_pri = bfs->priority;
1109             ret = a_pri < b_pri ? -1 : a_pri > b_pri;
1110         } else {
1111             bool ina, inb;
1112
1113             ina = mf_are_prereqs_ok(f, &a->flow) && !mf_is_all_wild(f, &a->wc);
1114             inb = mf_are_prereqs_ok(f, &b->flow) && !mf_is_all_wild(f, &b->wc);
1115             if (ina != inb) {
1116                 /* Skip the test for sc->order, so that missing fields always
1117                  * sort to the end whether we're sorting in ascending or
1118                  * descending order. */
1119                 return ina ? -1 : 1;
1120             } else {
1121                 union mf_value aval, bval;
1122
1123                 mf_get_value(f, &a->flow, &aval);
1124                 mf_get_value(f, &b->flow, &bval);
1125                 ret = memcmp(&aval, &bval, f->n_bytes);
1126             }
1127         }
1128
1129         if (ret) {
1130             return sc->order == SORT_ASC ? ret : -ret;
1131         }
1132     }
1133
1134     return 0;
1135 }
1136
1137 static void
1138 ofctl_dump_flows(struct ovs_cmdl_context *ctx)
1139 {
1140     if (!n_criteria) {
1141         ofctl_dump_flows__(ctx->argc, ctx->argv, false);
1142         return;
1143     } else {
1144         struct ofputil_flow_stats *fses;
1145         size_t n_fses, allocated_fses;
1146         struct ofpbuf *request;
1147         struct ofpbuf ofpacts;
1148         struct ofpbuf *reply;
1149         struct vconn *vconn;
1150         ovs_be32 send_xid;
1151         struct ds s;
1152         size_t i;
1153
1154         vconn = prepare_dump_flows(ctx->argc, ctx->argv, false, &request);
1155         send_xid = ((struct ofp_header *) request->data)->xid;
1156         send_openflow_buffer(vconn, request);
1157
1158         fses = NULL;
1159         n_fses = allocated_fses = 0;
1160         reply = NULL;
1161         ofpbuf_init(&ofpacts, 0);
1162         for (;;) {
1163             struct ofputil_flow_stats *fs;
1164
1165             if (n_fses >= allocated_fses) {
1166                 fses = x2nrealloc(fses, &allocated_fses, sizeof *fses);
1167             }
1168
1169             fs = &fses[n_fses];
1170             if (!recv_flow_stats_reply(vconn, send_xid, &reply, fs,
1171                                        &ofpacts)) {
1172                 break;
1173             }
1174             fs->ofpacts = xmemdup(fs->ofpacts, fs->ofpacts_len);
1175             n_fses++;
1176         }
1177         ofpbuf_uninit(&ofpacts);
1178
1179         qsort(fses, n_fses, sizeof *fses, compare_flows);
1180
1181         ds_init(&s);
1182         for (i = 0; i < n_fses; i++) {
1183             ds_clear(&s);
1184             ofp_print_flow_stats(&s, &fses[i]);
1185             puts(ds_cstr(&s));
1186         }
1187         ds_destroy(&s);
1188
1189         for (i = 0; i < n_fses; i++) {
1190             free(CONST_CAST(struct ofpact *, fses[i].ofpacts));
1191         }
1192         free(fses);
1193
1194         vconn_close(vconn);
1195     }
1196 }
1197
1198 static void
1199 ofctl_dump_aggregate(struct ovs_cmdl_context *ctx)
1200 {
1201     ofctl_dump_flows__(ctx->argc, ctx->argv, true);
1202 }
1203
1204 static void
1205 ofctl_queue_stats(struct ovs_cmdl_context *ctx)
1206 {
1207     struct ofpbuf *request;
1208     struct vconn *vconn;
1209     struct ofputil_queue_stats_request oqs;
1210
1211     open_vconn(ctx->argv[1], &vconn);
1212
1213     if (ctx->argc > 2 && ctx->argv[2][0] && strcasecmp(ctx->argv[2], "all")) {
1214         oqs.port_no = str_to_port_no(ctx->argv[1], ctx->argv[2]);
1215     } else {
1216         oqs.port_no = OFPP_ANY;
1217     }
1218     if (ctx->argc > 3 && ctx->argv[3][0] && strcasecmp(ctx->argv[3], "all")) {
1219         oqs.queue_id = atoi(ctx->argv[3]);
1220     } else {
1221         oqs.queue_id = OFPQ_ALL;
1222     }
1223
1224     request = ofputil_encode_queue_stats_request(vconn_get_version(vconn), &oqs);
1225     dump_transaction(vconn, request);
1226     vconn_close(vconn);
1227 }
1228
1229 static void
1230 ofctl_queue_get_config(struct ovs_cmdl_context *ctx)
1231 {
1232     const char *vconn_name = ctx->argv[1];
1233     const char *port_name = ctx->argc > 2 ? ctx->argv[2] : "any";
1234     ofp_port_t port = str_to_port_no(vconn_name, port_name);
1235     const char *queue_name = ctx->argc > 3 ? ctx->argv[3] : "all";
1236     uint32_t queue = (!strcasecmp(queue_name, "all")
1237                       ? OFPQ_ALL
1238                       : atoi(queue_name));
1239     struct vconn *vconn;
1240
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, queue));
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, queue));
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             struct ofpbuf b = ofpbuf_const_initializer(oh, ntohs(oh->length));
1991
1992             enum ofptype type;
1993             if (ofptype_pull(&type, &b)
1994                 || type != OFPTYPE_TABLE_DESC_REPLY) {
1995                 ovs_fatal(0, "received bad reply: %s",
1996                           ofp_to_string(reply->data, reply->size,
1997                                         verbosity + 1));
1998             }
1999             uint16_t flags = ofpmp_flags(oh);
2000             done = !(flags & OFPSF_REPLY_MORE);
2001             if (found) {
2002                 /* We've already found the table desc consisting of current
2003                  * table configuration, but we need to drain the queue of
2004                  * any other replies for this request. */
2005                 continue;
2006             }
2007             while (!ofputil_decode_table_desc(&b, td, oh->version)) {
2008                 if (td->table_id == tm->table_id) {
2009                     found = true;
2010                     break;
2011                 }
2012             }
2013         } else {
2014             VLOG_DBG("received reply with xid %08"PRIx32" "
2015                      "!= expected %08"PRIx32, recv_xid, send_xid);
2016         }
2017         ofpbuf_delete(reply);
2018     }
2019     if (tm->eviction != OFPUTIL_TABLE_EVICTION_DEFAULT) {
2020         tm->vacancy = td->vacancy;
2021         tm->table_vacancy.vacancy_down = td->table_vacancy.vacancy_down;
2022         tm->table_vacancy.vacancy_up = td->table_vacancy.vacancy_up;
2023     } else if (tm->vacancy != OFPUTIL_TABLE_VACANCY_DEFAULT) {
2024         tm->eviction = td->eviction;
2025         tm->eviction_flags = td->eviction_flags;
2026     }
2027 }
2028
2029 static void
2030 ofctl_mod_table(struct ovs_cmdl_context *ctx)
2031 {
2032     uint32_t usable_versions;
2033     struct ofputil_table_mod tm;
2034     struct vconn *vconn;
2035     char *error;
2036     int i;
2037
2038     error = parse_ofp_table_mod(&tm, ctx->argv[2], ctx->argv[3],
2039                                 &usable_versions);
2040     if (error) {
2041         ovs_fatal(0, "%s", error);
2042     }
2043
2044     uint32_t allowed_versions = get_allowed_ofp_versions();
2045     if (!(allowed_versions & usable_versions)) {
2046         struct ds versions = DS_EMPTY_INITIALIZER;
2047         ofputil_format_version_bitmap_names(&versions, usable_versions);
2048         ovs_fatal(0, "table_mod '%s' requires one of the OpenFlow "
2049                   "versions %s",
2050                   ctx->argv[3], ds_cstr(&versions));
2051     }
2052     mask_allowed_ofp_versions(usable_versions);
2053     enum ofputil_protocol protocol = open_vconn(ctx->argv[1], &vconn);
2054
2055     /* For OpenFlow 1.4+, ovs-ofctl mod-table should not affect table-config
2056      * properties that the user didn't ask to change, so it is necessary to
2057      * restore the current configuration of table-config parameters using
2058      * OFPMP14_TABLE_DESC request. */
2059     if ((allowed_versions & (1u << OFP14_VERSION)) ||
2060         (allowed_versions & (1u << OFP15_VERSION))) {
2061         struct ofputil_table_desc td;
2062
2063         if (tm.table_id == OFPTT_ALL) {
2064             for (i = 0; i < OFPTT_MAX; i++) {
2065                 tm.table_id = i;
2066                 fetch_table_desc(vconn, &tm, &td);
2067                 transact_noreply(vconn,
2068                                  ofputil_encode_table_mod(&tm, protocol));
2069             }
2070         } else {
2071             fetch_table_desc(vconn, &tm, &td);
2072             transact_noreply(vconn, ofputil_encode_table_mod(&tm, protocol));
2073         }
2074     } else {
2075         transact_noreply(vconn, ofputil_encode_table_mod(&tm, protocol));
2076     }
2077     vconn_close(vconn);
2078 }
2079
2080 static void
2081 ofctl_get_frags(struct ovs_cmdl_context *ctx)
2082 {
2083     struct ofputil_switch_config config;
2084     struct vconn *vconn;
2085
2086     open_vconn(ctx->argv[1], &vconn);
2087     fetch_switch_config(vconn, &config);
2088     puts(ofputil_frag_handling_to_string(config.frag));
2089     vconn_close(vconn);
2090 }
2091
2092 static void
2093 ofctl_set_frags(struct ovs_cmdl_context *ctx)
2094 {
2095     struct ofputil_switch_config config;
2096     enum ofputil_frag_handling frag;
2097     struct vconn *vconn;
2098
2099     if (!ofputil_frag_handling_from_string(ctx->argv[2], &frag)) {
2100         ovs_fatal(0, "%s: unknown fragment handling mode", ctx->argv[2]);
2101     }
2102
2103     open_vconn(ctx->argv[1], &vconn);
2104     fetch_switch_config(vconn, &config);
2105     if (frag != config.frag) {
2106         /* Set the configuration. */
2107         config.frag = frag;
2108         set_switch_config(vconn, &config);
2109
2110         /* Then retrieve the configuration to see if it really took.  OpenFlow
2111          * has ill-defined error reporting for bad flags, so this is about the
2112          * best we can do. */
2113         fetch_switch_config(vconn, &config);
2114         if (frag != config.frag) {
2115             ovs_fatal(0, "%s: setting fragment handling mode failed (this "
2116                       "switch probably doesn't support mode \"%s\")",
2117                       ctx->argv[1], ofputil_frag_handling_to_string(frag));
2118         }
2119     }
2120     vconn_close(vconn);
2121 }
2122
2123 static void
2124 ofctl_ofp_parse(struct ovs_cmdl_context *ctx)
2125 {
2126     const char *filename = ctx->argv[1];
2127     struct ofpbuf b;
2128     FILE *file;
2129
2130     file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
2131     if (file == NULL) {
2132         ovs_fatal(errno, "%s: open", filename);
2133     }
2134
2135     ofpbuf_init(&b, 65536);
2136     for (;;) {
2137         struct ofp_header *oh;
2138         size_t length, tail_len;
2139         void *tail;
2140         size_t n;
2141
2142         ofpbuf_clear(&b);
2143         oh = ofpbuf_put_uninit(&b, sizeof *oh);
2144         n = fread(oh, 1, sizeof *oh, file);
2145         if (n == 0) {
2146             break;
2147         } else if (n < sizeof *oh) {
2148             ovs_fatal(0, "%s: unexpected end of file mid-message", filename);
2149         }
2150
2151         length = ntohs(oh->length);
2152         if (length < sizeof *oh) {
2153             ovs_fatal(0, "%s: %"PRIuSIZE"-byte message is too short for OpenFlow",
2154                       filename, length);
2155         }
2156
2157         tail_len = length - sizeof *oh;
2158         tail = ofpbuf_put_uninit(&b, tail_len);
2159         n = fread(tail, 1, tail_len, file);
2160         if (n < tail_len) {
2161             ovs_fatal(0, "%s: unexpected end of file mid-message", filename);
2162         }
2163
2164         ofp_print(stdout, b.data, b.size, verbosity + 2);
2165     }
2166     ofpbuf_uninit(&b);
2167
2168     if (file != stdin) {
2169         fclose(file);
2170     }
2171 }
2172
2173 static bool
2174 is_openflow_port(ovs_be16 port_, char *ports[])
2175 {
2176     uint16_t port = ntohs(port_);
2177     if (ports[0]) {
2178         int i;
2179
2180         for (i = 0; ports[i]; i++) {
2181             if (port == atoi(ports[i])) {
2182                 return true;
2183             }
2184         }
2185         return false;
2186     } else {
2187         return port == OFP_PORT || port == OFP_OLD_PORT;
2188     }
2189 }
2190
2191 static void
2192 ofctl_ofp_parse_pcap(struct ovs_cmdl_context *ctx)
2193 {
2194     struct tcp_reader *reader;
2195     FILE *file;
2196     int error;
2197     bool first;
2198
2199     file = ovs_pcap_open(ctx->argv[1], "rb");
2200     if (!file) {
2201         ovs_fatal(errno, "%s: open failed", ctx->argv[1]);
2202     }
2203
2204     reader = tcp_reader_open();
2205     first = true;
2206     for (;;) {
2207         struct dp_packet *packet;
2208         long long int when;
2209         struct flow flow;
2210
2211         error = ovs_pcap_read(file, &packet, &when);
2212         if (error) {
2213             break;
2214         }
2215         pkt_metadata_init(&packet->md, ODPP_NONE);
2216         flow_extract(packet, &flow);
2217         if (flow.dl_type == htons(ETH_TYPE_IP)
2218             && flow.nw_proto == IPPROTO_TCP
2219             && (is_openflow_port(flow.tp_src, ctx->argv + 2) ||
2220                 is_openflow_port(flow.tp_dst, ctx->argv + 2))) {
2221             struct dp_packet *payload = tcp_reader_run(reader, &flow, packet);
2222             if (payload) {
2223                 while (dp_packet_size(payload) >= sizeof(struct ofp_header)) {
2224                     const struct ofp_header *oh;
2225                     void *data = dp_packet_data(payload);
2226                     int length;
2227
2228                     /* Align OpenFlow on 8-byte boundary for safe access. */
2229                     dp_packet_shift(payload, -((intptr_t) data & 7));
2230
2231                     oh = dp_packet_data(payload);
2232                     length = ntohs(oh->length);
2233                     if (dp_packet_size(payload) < length) {
2234                         break;
2235                     }
2236
2237                     if (!first) {
2238                         putchar('\n');
2239                     }
2240                     first = false;
2241
2242                     if (timestamp) {
2243                         char *s = xastrftime_msec("%H:%M:%S.### ", when, true);
2244                         fputs(s, stdout);
2245                         free(s);
2246                     }
2247
2248                     printf(IP_FMT".%"PRIu16" > "IP_FMT".%"PRIu16":\n",
2249                            IP_ARGS(flow.nw_src), ntohs(flow.tp_src),
2250                            IP_ARGS(flow.nw_dst), ntohs(flow.tp_dst));
2251                     ofp_print(stdout, dp_packet_data(payload), length, verbosity + 1);
2252                     dp_packet_pull(payload, length);
2253                 }
2254             }
2255         }
2256         dp_packet_delete(packet);
2257     }
2258     tcp_reader_close(reader);
2259 }
2260
2261 static void
2262 ofctl_ping(struct ovs_cmdl_context *ctx)
2263 {
2264     size_t max_payload = 65535 - sizeof(struct ofp_header);
2265     unsigned int payload;
2266     struct vconn *vconn;
2267     int i;
2268
2269     payload = ctx->argc > 2 ? atoi(ctx->argv[2]) : 64;
2270     if (payload > max_payload) {
2271         ovs_fatal(0, "payload must be between 0 and %"PRIuSIZE" bytes", max_payload);
2272     }
2273
2274     open_vconn(ctx->argv[1], &vconn);
2275     for (i = 0; i < 10; i++) {
2276         struct timeval start, end;
2277         struct ofpbuf *request, *reply;
2278         const struct ofp_header *rpy_hdr;
2279         enum ofptype type;
2280
2281         request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
2282                                vconn_get_version(vconn), payload);
2283         random_bytes(ofpbuf_put_uninit(request, payload), payload);
2284
2285         xgettimeofday(&start);
2286         run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
2287         xgettimeofday(&end);
2288
2289         rpy_hdr = reply->data;
2290         if (ofptype_pull(&type, reply)
2291             || type != OFPTYPE_ECHO_REPLY
2292             || reply->size != payload
2293             || memcmp(request->msg, reply->msg, payload)) {
2294             printf("Reply does not match request.  Request:\n");
2295             ofp_print(stdout, request, request->size, verbosity + 2);
2296             printf("Reply:\n");
2297             ofp_print(stdout, reply, reply->size, verbosity + 2);
2298         }
2299         printf("%"PRIu32" bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
2300                reply->size, ctx->argv[1], ntohl(rpy_hdr->xid),
2301                    (1000*(double)(end.tv_sec - start.tv_sec))
2302                    + (.001*(end.tv_usec - start.tv_usec)));
2303         ofpbuf_delete(request);
2304         ofpbuf_delete(reply);
2305     }
2306     vconn_close(vconn);
2307 }
2308
2309 static void
2310 ofctl_benchmark(struct ovs_cmdl_context *ctx)
2311 {
2312     size_t max_payload = 65535 - sizeof(struct ofp_header);
2313     struct timeval start, end;
2314     unsigned int payload_size, message_size;
2315     struct vconn *vconn;
2316     double duration;
2317     int count;
2318     int i;
2319
2320     payload_size = atoi(ctx->argv[2]);
2321     if (payload_size > max_payload) {
2322         ovs_fatal(0, "payload must be between 0 and %"PRIuSIZE" bytes", max_payload);
2323     }
2324     message_size = sizeof(struct ofp_header) + payload_size;
2325
2326     count = atoi(ctx->argv[3]);
2327
2328     printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
2329            count, message_size, count * message_size);
2330
2331     open_vconn(ctx->argv[1], &vconn);
2332     xgettimeofday(&start);
2333     for (i = 0; i < count; i++) {
2334         struct ofpbuf *request, *reply;
2335
2336         request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
2337                                vconn_get_version(vconn), payload_size);
2338         ofpbuf_put_zeros(request, payload_size);
2339         run(vconn_transact(vconn, request, &reply), "transact");
2340         ofpbuf_delete(reply);
2341     }
2342     xgettimeofday(&end);
2343     vconn_close(vconn);
2344
2345     duration = ((1000*(double)(end.tv_sec - start.tv_sec))
2346                 + (.001*(end.tv_usec - start.tv_usec)));
2347     printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
2348            duration, count / (duration / 1000.0),
2349            count * message_size / (duration / 1000.0));
2350 }
2351
2352 static void
2353 ofctl_group_mod__(const char *remote, struct ofputil_group_mod *gms,
2354                   size_t n_gms, enum ofputil_protocol usable_protocols)
2355 {
2356     enum ofputil_protocol protocol;
2357     struct ofputil_group_mod *gm;
2358     enum ofp_version version;
2359     struct ofpbuf *request;
2360
2361     struct vconn *vconn;
2362     size_t i;
2363
2364     protocol = open_vconn_for_flow_mod(remote, &vconn, usable_protocols);
2365     version = ofputil_protocol_to_ofp_version(protocol);
2366
2367     for (i = 0; i < n_gms; i++) {
2368         gm = &gms[i];
2369         request = ofputil_encode_group_mod(version, gm);
2370         if (request) {
2371             transact_noreply(vconn, request);
2372         }
2373     }
2374
2375     vconn_close(vconn);
2376
2377 }
2378
2379
2380 static void
2381 ofctl_group_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
2382 {
2383     struct ofputil_group_mod *gms = NULL;
2384     enum ofputil_protocol usable_protocols;
2385     size_t n_gms = 0;
2386     char *error;
2387     int i;
2388
2389     error = parse_ofp_group_mod_file(argv[2], command, &gms, &n_gms,
2390                                      &usable_protocols);
2391     if (error) {
2392         ovs_fatal(0, "%s", error);
2393     }
2394     ofctl_group_mod__(argv[1], gms, n_gms, usable_protocols);
2395     for (i = 0; i < n_gms; i++) {
2396         ofputil_bucket_list_destroy(&gms[i].buckets);
2397     }
2398     free(gms);
2399 }
2400
2401 static void
2402 ofctl_group_mod(int argc, char *argv[], uint16_t command)
2403 {
2404     if (argc > 2 && !strcmp(argv[2], "-")) {
2405         ofctl_group_mod_file(argc, argv, command);
2406     } else {
2407         enum ofputil_protocol usable_protocols;
2408         struct ofputil_group_mod gm;
2409         char *error;
2410
2411         error = parse_ofp_group_mod_str(&gm, command, argc > 2 ? argv[2] : "",
2412                                         &usable_protocols);
2413         if (error) {
2414             ovs_fatal(0, "%s", error);
2415         }
2416         ofctl_group_mod__(argv[1], &gm, 1, usable_protocols);
2417         ofputil_bucket_list_destroy(&gm.buckets);
2418     }
2419 }
2420
2421 static void
2422 ofctl_add_group(struct ovs_cmdl_context *ctx)
2423 {
2424     ofctl_group_mod(ctx->argc, ctx->argv, OFPGC11_ADD);
2425 }
2426
2427 static void
2428 ofctl_add_groups(struct ovs_cmdl_context *ctx)
2429 {
2430     ofctl_group_mod_file(ctx->argc, ctx->argv, OFPGC11_ADD);
2431 }
2432
2433 static void
2434 ofctl_mod_group(struct ovs_cmdl_context *ctx)
2435 {
2436     ofctl_group_mod(ctx->argc, ctx->argv, OFPGC11_MODIFY);
2437 }
2438
2439 static void
2440 ofctl_del_groups(struct ovs_cmdl_context *ctx)
2441 {
2442     ofctl_group_mod(ctx->argc, ctx->argv, OFPGC11_DELETE);
2443 }
2444
2445 static void
2446 ofctl_insert_bucket(struct ovs_cmdl_context *ctx)
2447 {
2448     ofctl_group_mod(ctx->argc, ctx->argv, OFPGC15_INSERT_BUCKET);
2449 }
2450
2451 static void
2452 ofctl_remove_bucket(struct ovs_cmdl_context *ctx)
2453 {
2454     ofctl_group_mod(ctx->argc, ctx->argv, OFPGC15_REMOVE_BUCKET);
2455 }
2456
2457 static void
2458 ofctl_dump_group_stats(struct ovs_cmdl_context *ctx)
2459 {
2460     enum ofputil_protocol usable_protocols;
2461     struct ofputil_group_mod gm;
2462     struct ofpbuf *request;
2463     struct vconn *vconn;
2464     uint32_t group_id;
2465     char *error;
2466
2467     memset(&gm, 0, sizeof gm);
2468
2469     error = parse_ofp_group_mod_str(&gm, OFPGC11_DELETE,
2470                                     ctx->argc > 2 ? ctx->argv[2] : "",
2471                                     &usable_protocols);
2472     if (error) {
2473         ovs_fatal(0, "%s", error);
2474     }
2475
2476     group_id = gm.group_id;
2477
2478     open_vconn(ctx->argv[1], &vconn);
2479     request = ofputil_encode_group_stats_request(vconn_get_version(vconn),
2480                                                  group_id);
2481     if (request) {
2482         dump_transaction(vconn, request);
2483     }
2484
2485     vconn_close(vconn);
2486 }
2487
2488 static void
2489 ofctl_dump_group_desc(struct ovs_cmdl_context *ctx)
2490 {
2491     struct ofpbuf *request;
2492     struct vconn *vconn;
2493     uint32_t group_id;
2494
2495     open_vconn(ctx->argv[1], &vconn);
2496
2497     if (ctx->argc < 3 || !ofputil_group_from_string(ctx->argv[2], &group_id)) {
2498         group_id = OFPG_ALL;
2499     }
2500
2501     request = ofputil_encode_group_desc_request(vconn_get_version(vconn),
2502                                                 group_id);
2503     if (request) {
2504         dump_transaction(vconn, request);
2505     }
2506
2507     vconn_close(vconn);
2508 }
2509
2510 static void
2511 ofctl_dump_group_features(struct ovs_cmdl_context *ctx)
2512 {
2513     struct ofpbuf *request;
2514     struct vconn *vconn;
2515
2516     open_vconn(ctx->argv[1], &vconn);
2517     request = ofputil_encode_group_features_request(vconn_get_version(vconn));
2518     if (request) {
2519         dump_transaction(vconn, request);
2520     }
2521
2522     vconn_close(vconn);
2523 }
2524
2525 static void
2526 ofctl_tlv_mod(struct ovs_cmdl_context *ctx, uint16_t command)
2527 {
2528     enum ofputil_protocol usable_protocols;
2529     enum ofputil_protocol protocol;
2530     struct ofputil_tlv_table_mod ttm;
2531     char *error;
2532     enum ofp_version version;
2533     struct ofpbuf *request;
2534     struct vconn *vconn;
2535
2536     error = parse_ofp_tlv_table_mod_str(&ttm, command, ctx->argc > 2 ?
2537                                            ctx->argv[2] : "",
2538                                            &usable_protocols);
2539     if (error) {
2540         ovs_fatal(0, "%s", error);
2541     }
2542
2543     protocol = open_vconn_for_flow_mod(ctx->argv[1], &vconn, usable_protocols);
2544     version = ofputil_protocol_to_ofp_version(protocol);
2545
2546     request = ofputil_encode_tlv_table_mod(version, &ttm);
2547     if (request) {
2548         transact_noreply(vconn, request);
2549     }
2550
2551     vconn_close(vconn);
2552     ofputil_uninit_tlv_table(&ttm.mappings);
2553 }
2554
2555 static void
2556 ofctl_add_tlv_map(struct ovs_cmdl_context *ctx)
2557 {
2558     ofctl_tlv_mod(ctx, NXTTMC_ADD);
2559 }
2560
2561 static void
2562 ofctl_del_tlv_map(struct ovs_cmdl_context *ctx)
2563 {
2564     ofctl_tlv_mod(ctx, ctx->argc > 2 ? NXTTMC_DELETE : NXTTMC_CLEAR);
2565 }
2566
2567 static void
2568 ofctl_dump_tlv_map(struct ovs_cmdl_context *ctx)
2569 {
2570     dump_trivial_transaction(ctx->argv[1], OFPRAW_NXT_TLV_TABLE_REQUEST);
2571 }
2572
2573 static void
2574 ofctl_help(struct ovs_cmdl_context *ctx OVS_UNUSED)
2575 {
2576     usage();
2577 }
2578
2579 static void
2580 ofctl_list_commands(struct ovs_cmdl_context *ctx OVS_UNUSED)
2581 {
2582     ovs_cmdl_print_commands(get_all_commands());
2583 }
2584 \f
2585 /* replace-flows and diff-flows commands. */
2586
2587 struct flow_tables {
2588     struct classifier tables[OFPTT_MAX + 1];
2589 };
2590
2591 #define FOR_EACH_TABLE(CLS, TABLES)                               \
2592     for ((CLS) = (TABLES)->tables;                                \
2593          (CLS) < &(TABLES)->tables[ARRAY_SIZE((TABLES)->tables)]; \
2594          (CLS)++)
2595
2596 static void
2597 flow_tables_init(struct flow_tables *tables)
2598 {
2599     struct classifier *cls;
2600
2601     FOR_EACH_TABLE (cls, tables) {
2602         classifier_init(cls, NULL);
2603     }
2604 }
2605
2606 static void
2607 flow_tables_defer(struct flow_tables *tables)
2608 {
2609     struct classifier *cls;
2610
2611     FOR_EACH_TABLE (cls, tables) {
2612         classifier_defer(cls);
2613     }
2614 }
2615
2616 static void
2617 flow_tables_publish(struct flow_tables *tables)
2618 {
2619     struct classifier *cls;
2620
2621     FOR_EACH_TABLE (cls, tables) {
2622         classifier_publish(cls);
2623     }
2624 }
2625
2626 /* A flow table entry, possibly with two different versions. */
2627 struct fte {
2628     struct cls_rule rule;       /* Within a "struct classifier". */
2629     struct fte_version *versions[2];
2630 };
2631
2632 /* One version of a Flow Table Entry. */
2633 struct fte_version {
2634     ovs_be64 cookie;
2635     uint16_t idle_timeout;
2636     uint16_t hard_timeout;
2637     uint16_t importance;
2638     uint16_t flags;
2639     struct ofpact *ofpacts;
2640     size_t ofpacts_len;
2641     uint8_t table_id;
2642 };
2643
2644 /* Frees 'version' and the data that it owns. */
2645 static void
2646 fte_version_free(struct fte_version *version)
2647 {
2648     if (version) {
2649         free(CONST_CAST(struct ofpact *, version->ofpacts));
2650         free(version);
2651     }
2652 }
2653
2654 /* Returns true if 'a' and 'b' are the same, false if they differ.
2655  *
2656  * Ignores differences in 'flags' because there's no way to retrieve flags from
2657  * an OpenFlow switch.  We have to assume that they are the same. */
2658 static bool
2659 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
2660 {
2661     return (a->cookie == b->cookie
2662             && a->idle_timeout == b->idle_timeout
2663             && a->hard_timeout == b->hard_timeout
2664             && a->importance == b->importance
2665             && a->table_id == b->table_id
2666             && ofpacts_equal(a->ofpacts, a->ofpacts_len,
2667                              b->ofpacts, b->ofpacts_len));
2668 }
2669
2670 /* Clears 's', then if 's' has a version 'index', formats 'fte' and version
2671  * 'index' into 's', followed by a new-line. */
2672 static void
2673 fte_version_format(const struct fte *fte, int index, struct ds *s)
2674 {
2675     const struct fte_version *version = fte->versions[index];
2676
2677     ds_clear(s);
2678     if (!version) {
2679         return;
2680     }
2681
2682     if (version->table_id) {
2683         ds_put_format(s, "table=%"PRIu8" ", version->table_id);
2684     }
2685     cls_rule_format(&fte->rule, s);
2686     if (version->cookie != htonll(0)) {
2687         ds_put_format(s, " cookie=0x%"PRIx64, ntohll(version->cookie));
2688     }
2689     if (version->idle_timeout != OFP_FLOW_PERMANENT) {
2690         ds_put_format(s, " idle_timeout=%"PRIu16, version->idle_timeout);
2691     }
2692     if (version->hard_timeout != OFP_FLOW_PERMANENT) {
2693         ds_put_format(s, " hard_timeout=%"PRIu16, version->hard_timeout);
2694     }
2695     if (version->importance != 0) {
2696         ds_put_format(s, " importance=%"PRIu16, version->importance);
2697     }
2698
2699     ds_put_cstr(s, " actions=");
2700     ofpacts_format(version->ofpacts, version->ofpacts_len, s);
2701
2702     ds_put_char(s, '\n');
2703 }
2704
2705 static struct fte *
2706 fte_from_cls_rule(const struct cls_rule *cls_rule)
2707 {
2708     return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
2709 }
2710
2711 /* Frees 'fte' and its versions. */
2712 static void
2713 fte_free(struct fte *fte)
2714 {
2715     if (fte) {
2716         fte_version_free(fte->versions[0]);
2717         fte_version_free(fte->versions[1]);
2718         cls_rule_destroy(&fte->rule);
2719         free(fte);
2720     }
2721 }
2722
2723 /* Frees all of the FTEs within 'tables'. */
2724 static void
2725 fte_free_all(struct flow_tables *tables)
2726 {
2727     struct classifier *cls;
2728
2729     FOR_EACH_TABLE (cls, tables) {
2730         struct fte *fte;
2731
2732         classifier_defer(cls);
2733         CLS_FOR_EACH (fte, rule, cls) {
2734             classifier_remove(cls, &fte->rule);
2735             ovsrcu_postpone(fte_free, fte);
2736         }
2737         classifier_destroy(cls);
2738     }
2739 }
2740
2741 /* Searches 'tables' for an FTE matching 'rule', inserting a new one if
2742  * necessary.  Sets 'version' as the version of that rule with the given
2743  * 'index', replacing any existing version, if any.
2744  *
2745  * Takes ownership of 'version'. */
2746 static void
2747 fte_insert(struct flow_tables *tables, const struct match *match,
2748            int priority, struct fte_version *version, int index)
2749 {
2750     struct classifier *cls = &tables->tables[version->table_id];
2751     struct fte *old, *fte;
2752
2753     fte = xzalloc(sizeof *fte);
2754     cls_rule_init(&fte->rule, match, priority);
2755     fte->versions[index] = version;
2756
2757     old = fte_from_cls_rule(classifier_replace(cls, &fte->rule,
2758                                                CLS_MIN_VERSION, NULL, 0));
2759     if (old) {
2760         fte->versions[!index] = old->versions[!index];
2761         old->versions[!index] = NULL;
2762
2763         ovsrcu_postpone(fte_free, old);
2764     }
2765 }
2766
2767 /* Reads the flows in 'filename' as flow table entries in 'tables' for the
2768  * version with the specified 'index'.  Returns the flow formats able to
2769  * represent the flows that were read. */
2770 static enum ofputil_protocol
2771 read_flows_from_file(const char *filename, struct flow_tables *tables,
2772                      int index)
2773 {
2774     enum ofputil_protocol usable_protocols;
2775     int line_number;
2776     struct ds s;
2777     FILE *file;
2778
2779     file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
2780     if (file == NULL) {
2781         ovs_fatal(errno, "%s: open", filename);
2782     }
2783
2784     ds_init(&s);
2785     usable_protocols = OFPUTIL_P_ANY;
2786     line_number = 0;
2787     flow_tables_defer(tables);
2788     while (!ds_get_preprocessed_line(&s, file, &line_number)) {
2789         struct fte_version *version;
2790         struct ofputil_flow_mod fm;
2791         char *error;
2792         enum ofputil_protocol usable;
2793
2794         error = parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), &usable);
2795         if (error) {
2796             ovs_fatal(0, "%s:%d: %s", filename, line_number, error);
2797         }
2798         usable_protocols &= usable;
2799
2800         version = xmalloc(sizeof *version);
2801         version->cookie = fm.new_cookie;
2802         version->idle_timeout = fm.idle_timeout;
2803         version->hard_timeout = fm.hard_timeout;
2804         version->importance = fm.importance;
2805         version->flags = fm.flags & (OFPUTIL_FF_SEND_FLOW_REM
2806                                      | OFPUTIL_FF_EMERG);
2807         version->ofpacts = fm.ofpacts;
2808         version->ofpacts_len = fm.ofpacts_len;
2809         version->table_id = fm.table_id != OFPTT_ALL ? fm.table_id : 0;
2810
2811         fte_insert(tables, &fm.match, fm.priority, version, index);
2812     }
2813     flow_tables_publish(tables);
2814     ds_destroy(&s);
2815
2816     if (file != stdin) {
2817         fclose(file);
2818     }
2819
2820     return usable_protocols;
2821 }
2822
2823 static bool
2824 recv_flow_stats_reply(struct vconn *vconn, ovs_be32 send_xid,
2825                       struct ofpbuf **replyp,
2826                       struct ofputil_flow_stats *fs, struct ofpbuf *ofpacts)
2827 {
2828     struct ofpbuf *reply = *replyp;
2829
2830     for (;;) {
2831         int retval;
2832         bool more;
2833
2834         /* Get a flow stats reply message, if we don't already have one. */
2835         if (!reply) {
2836             enum ofptype type;
2837             enum ofperr error;
2838
2839             do {
2840                 run(vconn_recv_block(vconn, &reply),
2841                     "OpenFlow packet receive failed");
2842             } while (((struct ofp_header *) reply->data)->xid != send_xid);
2843
2844             error = ofptype_decode(&type, reply->data);
2845             if (error || type != OFPTYPE_FLOW_STATS_REPLY) {
2846                 ovs_fatal(0, "received bad reply: %s",
2847                           ofp_to_string(reply->data, reply->size,
2848                                         verbosity + 1));
2849             }
2850         }
2851
2852         /* Pull an individual flow stats reply out of the message. */
2853         retval = ofputil_decode_flow_stats_reply(fs, reply, false, ofpacts);
2854         switch (retval) {
2855         case 0:
2856             *replyp = reply;
2857             return true;
2858
2859         case EOF:
2860             more = ofpmp_more(reply->header);
2861             ofpbuf_delete(reply);
2862             reply = NULL;
2863             if (!more) {
2864                 *replyp = NULL;
2865                 return false;
2866             }
2867             break;
2868
2869         default:
2870             ovs_fatal(0, "parse error in reply (%s)",
2871                       ofperr_to_string(retval));
2872         }
2873     }
2874 }
2875
2876 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
2877  * format 'protocol', and adds them as flow table entries in 'tables' for the
2878  * version with the specified 'index'. */
2879 static void
2880 read_flows_from_switch(struct vconn *vconn,
2881                        enum ofputil_protocol protocol,
2882                        struct flow_tables *tables, int index)
2883 {
2884     struct ofputil_flow_stats_request fsr;
2885     struct ofputil_flow_stats fs;
2886     struct ofpbuf *request;
2887     struct ofpbuf ofpacts;
2888     struct ofpbuf *reply;
2889     ovs_be32 send_xid;
2890
2891     fsr.aggregate = false;
2892     match_init_catchall(&fsr.match);
2893     fsr.out_port = OFPP_ANY;
2894     fsr.out_group = OFPG_ANY;
2895     fsr.table_id = 0xff;
2896     fsr.cookie = fsr.cookie_mask = htonll(0);
2897     request = ofputil_encode_flow_stats_request(&fsr, protocol);
2898     send_xid = ((struct ofp_header *) request->data)->xid;
2899     send_openflow_buffer(vconn, request);
2900
2901     reply = NULL;
2902     ofpbuf_init(&ofpacts, 0);
2903     flow_tables_defer(tables);
2904     while (recv_flow_stats_reply(vconn, send_xid, &reply, &fs, &ofpacts)) {
2905         struct fte_version *version;
2906
2907         version = xmalloc(sizeof *version);
2908         version->cookie = fs.cookie;
2909         version->idle_timeout = fs.idle_timeout;
2910         version->hard_timeout = fs.hard_timeout;
2911         version->importance = fs.importance;
2912         version->flags = 0;
2913         version->ofpacts_len = fs.ofpacts_len;
2914         version->ofpacts = xmemdup(fs.ofpacts, fs.ofpacts_len);
2915         version->table_id = fs.table_id;
2916
2917         fte_insert(tables, &fs.match, fs.priority, version, index);
2918     }
2919     flow_tables_publish(tables);
2920     ofpbuf_uninit(&ofpacts);
2921 }
2922
2923 static void
2924 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
2925                   enum ofputil_protocol protocol, struct ovs_list *packets)
2926 {
2927     const struct fte_version *version = fte->versions[index];
2928     struct ofpbuf *ofm;
2929
2930     struct ofputil_flow_mod fm = {
2931         .priority = fte->rule.priority,
2932         .new_cookie = version->cookie,
2933         .modify_cookie = true,
2934         .table_id = version->table_id,
2935         .command = command,
2936         .idle_timeout = version->idle_timeout,
2937         .hard_timeout = version->hard_timeout,
2938         .importance = version->importance,
2939         .buffer_id = UINT32_MAX,
2940         .out_port = OFPP_ANY,
2941         .out_group = OFPG_ANY,
2942         .flags = version->flags,
2943         .delete_reason = OFPRR_DELETE,
2944     };
2945     minimatch_expand(&fte->rule.match, &fm.match);
2946     if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
2947         command == OFPFC_MODIFY_STRICT) {
2948         fm.ofpacts = version->ofpacts;
2949         fm.ofpacts_len = version->ofpacts_len;
2950     } else {
2951         fm.ofpacts = NULL;
2952         fm.ofpacts_len = 0;
2953     }
2954
2955     ofm = ofputil_encode_flow_mod(&fm, protocol);
2956     list_push_back(packets, &ofm->list_node);
2957 }
2958
2959 static void
2960 ofctl_replace_flows(struct ovs_cmdl_context *ctx)
2961 {
2962     enum { FILE_IDX = 0, SWITCH_IDX = 1 };
2963     enum ofputil_protocol usable_protocols, protocol;
2964     struct flow_tables tables;
2965     struct classifier *cls;
2966     struct ovs_list requests;
2967     struct vconn *vconn;
2968     struct fte *fte;
2969
2970     flow_tables_init(&tables);
2971     usable_protocols = read_flows_from_file(ctx->argv[2], &tables, FILE_IDX);
2972
2973     protocol = open_vconn(ctx->argv[1], &vconn);
2974     protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
2975
2976     read_flows_from_switch(vconn, protocol, &tables, SWITCH_IDX);
2977
2978     list_init(&requests);
2979
2980     FOR_EACH_TABLE (cls, &tables) {
2981         /* Delete flows that exist on the switch but not in the file. */
2982         CLS_FOR_EACH (fte, rule, cls) {
2983             struct fte_version *file_ver = fte->versions[FILE_IDX];
2984             struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2985
2986             if (sw_ver && !file_ver) {
2987                 fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
2988                                   protocol, &requests);
2989             }
2990         }
2991
2992         /* Add flows that exist in the file but not on the switch.
2993          * Update flows that exist in both places but differ. */
2994         CLS_FOR_EACH (fte, rule, cls) {
2995             struct fte_version *file_ver = fte->versions[FILE_IDX];
2996             struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2997
2998             if (file_ver &&
2999                 (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
3000                 fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, protocol,
3001                                   &requests);
3002             }
3003         }
3004     }
3005     if (bundle) {
3006         bundle_transact(vconn, &requests, OFPBF_ORDERED | OFPBF_ATOMIC);
3007     } else {
3008         transact_multiple_noreply(vconn, &requests);
3009     }
3010
3011     ofpbuf_list_delete(&requests);
3012     vconn_close(vconn);
3013
3014     fte_free_all(&tables);
3015 }
3016
3017 static void
3018 read_flows_from_source(const char *source, struct flow_tables *tables,
3019                        int index)
3020 {
3021     struct stat s;
3022
3023     if (source[0] == '/' || source[0] == '.'
3024         || (!strchr(source, ':') && !stat(source, &s))) {
3025         read_flows_from_file(source, tables, index);
3026     } else {
3027         enum ofputil_protocol protocol;
3028         struct vconn *vconn;
3029
3030         protocol = open_vconn(source, &vconn);
3031         protocol = set_protocol_for_flow_dump(vconn, protocol, OFPUTIL_P_ANY);
3032         read_flows_from_switch(vconn, protocol, tables, index);
3033         vconn_close(vconn);
3034     }
3035 }
3036
3037 static void
3038 ofctl_diff_flows(struct ovs_cmdl_context *ctx)
3039 {
3040     bool differences = false;
3041     struct flow_tables tables;
3042     struct classifier *cls;
3043     struct ds a_s, b_s;
3044     struct fte *fte;
3045
3046     flow_tables_init(&tables);
3047     read_flows_from_source(ctx->argv[1], &tables, 0);
3048     read_flows_from_source(ctx->argv[2], &tables, 1);
3049
3050     ds_init(&a_s);
3051     ds_init(&b_s);
3052
3053     FOR_EACH_TABLE (cls, &tables) {
3054         CLS_FOR_EACH (fte, rule, cls) {
3055             struct fte_version *a = fte->versions[0];
3056             struct fte_version *b = fte->versions[1];
3057
3058             if (!a || !b || !fte_version_equals(a, b)) {
3059                 fte_version_format(fte, 0, &a_s);
3060                 fte_version_format(fte, 1, &b_s);
3061                 if (strcmp(ds_cstr(&a_s), ds_cstr(&b_s))) {
3062                     if (a_s.length) {
3063                         printf("-%s", ds_cstr(&a_s));
3064                     }
3065                     if (b_s.length) {
3066                         printf("+%s", ds_cstr(&b_s));
3067                     }
3068                     differences = true;
3069                 }
3070             }
3071         }
3072     }
3073
3074     ds_destroy(&a_s);
3075     ds_destroy(&b_s);
3076
3077     fte_free_all(&tables);
3078
3079     if (differences) {
3080         exit(2);
3081     }
3082 }
3083
3084 static void
3085 ofctl_meter_mod__(const char *bridge, const char *str, int command)
3086 {
3087     struct ofputil_meter_mod mm;
3088     struct vconn *vconn;
3089     enum ofputil_protocol protocol;
3090     enum ofputil_protocol usable_protocols;
3091     enum ofp_version version;
3092
3093     if (str) {
3094         char *error;
3095         error = parse_ofp_meter_mod_str(&mm, str, command, &usable_protocols);
3096         if (error) {
3097             ovs_fatal(0, "%s", error);
3098         }
3099     } else {
3100         usable_protocols = OFPUTIL_P_OF13_UP;
3101         mm.command = command;
3102         mm.meter.meter_id = OFPM13_ALL;
3103     }
3104
3105     protocol = open_vconn_for_flow_mod(bridge, &vconn, usable_protocols);
3106     version = ofputil_protocol_to_ofp_version(protocol);
3107     transact_noreply(vconn, ofputil_encode_meter_mod(version, &mm));
3108     vconn_close(vconn);
3109 }
3110
3111 static void
3112 ofctl_meter_request__(const char *bridge, const char *str,
3113                       enum ofputil_meter_request_type type)
3114 {
3115     struct ofputil_meter_mod mm;
3116     struct vconn *vconn;
3117     enum ofputil_protocol usable_protocols;
3118     enum ofputil_protocol protocol;
3119     enum ofp_version version;
3120
3121     if (str) {
3122         char *error;
3123         error = parse_ofp_meter_mod_str(&mm, str, -1, &usable_protocols);
3124         if (error) {
3125             ovs_fatal(0, "%s", error);
3126         }
3127     } else {
3128         usable_protocols = OFPUTIL_P_OF13_UP;
3129         mm.meter.meter_id = OFPM13_ALL;
3130     }
3131
3132     protocol = open_vconn_for_flow_mod(bridge, &vconn, usable_protocols);
3133     version = ofputil_protocol_to_ofp_version(protocol);
3134     dump_transaction(vconn, ofputil_encode_meter_request(version, type,
3135                                                          mm.meter.meter_id));
3136     vconn_close(vconn);
3137 }
3138
3139
3140 static void
3141 ofctl_add_meter(struct ovs_cmdl_context *ctx)
3142 {
3143     ofctl_meter_mod__(ctx->argv[1], ctx->argv[2], OFPMC13_ADD);
3144 }
3145
3146 static void
3147 ofctl_mod_meter(struct ovs_cmdl_context *ctx)
3148 {
3149     ofctl_meter_mod__(ctx->argv[1], ctx->argv[2], OFPMC13_MODIFY);
3150 }
3151
3152 static void
3153 ofctl_del_meters(struct ovs_cmdl_context *ctx)
3154 {
3155     ofctl_meter_mod__(ctx->argv[1], ctx->argc > 2 ? ctx->argv[2] : NULL, OFPMC13_DELETE);
3156 }
3157
3158 static void
3159 ofctl_dump_meters(struct ovs_cmdl_context *ctx)
3160 {
3161     ofctl_meter_request__(ctx->argv[1], ctx->argc > 2 ? ctx->argv[2] : NULL,
3162                           OFPUTIL_METER_CONFIG);
3163 }
3164
3165 static void
3166 ofctl_meter_stats(struct ovs_cmdl_context *ctx)
3167 {
3168     ofctl_meter_request__(ctx->argv[1], ctx->argc > 2 ? ctx->argv[2] : NULL,
3169                           OFPUTIL_METER_STATS);
3170 }
3171
3172 static void
3173 ofctl_meter_features(struct ovs_cmdl_context *ctx)
3174 {
3175     ofctl_meter_request__(ctx->argv[1], NULL, OFPUTIL_METER_FEATURES);
3176 }
3177
3178 \f
3179 /* Undocumented commands for unit testing. */
3180
3181 static void
3182 ofctl_parse_flows__(struct ofputil_flow_mod *fms, size_t n_fms,
3183                     enum ofputil_protocol usable_protocols)
3184 {
3185     enum ofputil_protocol protocol = 0;
3186     char *usable_s;
3187     size_t i;
3188
3189     usable_s = ofputil_protocols_to_string(usable_protocols);
3190     printf("usable protocols: %s\n", usable_s);
3191     free(usable_s);
3192
3193     if (!(usable_protocols & allowed_protocols)) {
3194         ovs_fatal(0, "no usable protocol");
3195     }
3196     for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
3197         protocol = 1 << i;
3198         if (protocol & usable_protocols & allowed_protocols) {
3199             break;
3200         }
3201     }
3202     ovs_assert(is_pow2(protocol));
3203
3204     printf("chosen protocol: %s\n", ofputil_protocol_to_string(protocol));
3205
3206     for (i = 0; i < n_fms; i++) {
3207         struct ofputil_flow_mod *fm = &fms[i];
3208         struct ofpbuf *msg;
3209
3210         msg = ofputil_encode_flow_mod(fm, protocol);
3211         ofp_print(stdout, msg->data, msg->size, verbosity);
3212         ofpbuf_delete(msg);
3213
3214         free(CONST_CAST(struct ofpact *, fm->ofpacts));
3215     }
3216 }
3217
3218 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
3219  * it back to stdout.  */
3220 static void
3221 ofctl_parse_flow(struct ovs_cmdl_context *ctx)
3222 {
3223     enum ofputil_protocol usable_protocols;
3224     struct ofputil_flow_mod fm;
3225     char *error;
3226
3227     error = parse_ofp_flow_mod_str(&fm, ctx->argv[1], OFPFC_ADD, &usable_protocols);
3228     if (error) {
3229         ovs_fatal(0, "%s", error);
3230     }
3231     ofctl_parse_flows__(&fm, 1, usable_protocols);
3232 }
3233
3234 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
3235  * add-flows) and prints each of the flows back to stdout.  */
3236 static void
3237 ofctl_parse_flows(struct ovs_cmdl_context *ctx)
3238 {
3239     enum ofputil_protocol usable_protocols;
3240     struct ofputil_flow_mod *fms = NULL;
3241     size_t n_fms = 0;
3242     char *error;
3243
3244     error = parse_ofp_flow_mod_file(ctx->argv[1], OFPFC_ADD, &fms, &n_fms,
3245                                     &usable_protocols);
3246     if (error) {
3247         ovs_fatal(0, "%s", error);
3248     }
3249     ofctl_parse_flows__(fms, n_fms, usable_protocols);
3250     free(fms);
3251 }
3252
3253 static void
3254 ofctl_parse_nxm__(bool oxm, enum ofp_version version)
3255 {
3256     struct ds in;
3257
3258     ds_init(&in);
3259     while (!ds_get_test_line(&in, stdin)) {
3260         struct ofpbuf nx_match;
3261         struct match match;
3262         ovs_be64 cookie, cookie_mask;
3263         enum ofperr error;
3264         int match_len;
3265
3266         /* Convert string to nx_match. */
3267         ofpbuf_init(&nx_match, 0);
3268         if (oxm) {
3269             match_len = oxm_match_from_string(ds_cstr(&in), &nx_match);
3270         } else {
3271             match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
3272         }
3273
3274         /* Convert nx_match to match. */
3275         if (strict) {
3276             if (oxm) {
3277                 error = oxm_pull_match(&nx_match, &match);
3278             } else {
3279                 error = nx_pull_match(&nx_match, match_len, &match,
3280                                       &cookie, &cookie_mask);
3281             }
3282         } else {
3283             if (oxm) {
3284                 error = oxm_pull_match_loose(&nx_match, &match);
3285             } else {
3286                 error = nx_pull_match_loose(&nx_match, match_len, &match,
3287                                             &cookie, &cookie_mask);
3288             }
3289         }
3290
3291
3292         if (!error) {
3293             char *out;
3294
3295             /* Convert match back to nx_match. */
3296             ofpbuf_uninit(&nx_match);
3297             ofpbuf_init(&nx_match, 0);
3298             if (oxm) {
3299                 match_len = oxm_put_match(&nx_match, &match, version);
3300                 out = oxm_match_to_string(&nx_match, match_len);
3301             } else {
3302                 match_len = nx_put_match(&nx_match, &match,
3303                                          cookie, cookie_mask);
3304                 out = nx_match_to_string(nx_match.data, match_len);
3305             }
3306
3307             puts(out);
3308             free(out);
3309
3310             if (verbosity > 0) {
3311                 ovs_hex_dump(stdout, nx_match.data, nx_match.size, 0, false);
3312             }
3313         } else {
3314             printf("nx_pull_match() returned error %s\n",
3315                    ofperr_get_name(error));
3316         }
3317
3318         ofpbuf_uninit(&nx_match);
3319     }
3320     ds_destroy(&in);
3321 }
3322
3323 /* "parse-nxm": reads a series of NXM nx_match specifications as strings from
3324  * stdin, does some internal fussing with them, and then prints them back as
3325  * strings on stdout. */
3326 static void
3327 ofctl_parse_nxm(struct ovs_cmdl_context *ctx OVS_UNUSED)
3328 {
3329     ofctl_parse_nxm__(false, 0);
3330 }
3331
3332 /* "parse-oxm VERSION": reads a series of OXM nx_match specifications as
3333  * strings from stdin, does some internal fussing with them, and then prints
3334  * them back as strings on stdout.  VERSION must specify an OpenFlow version,
3335  * e.g. "OpenFlow12". */
3336 static void
3337 ofctl_parse_oxm(struct ovs_cmdl_context *ctx)
3338 {
3339     enum ofp_version version = ofputil_version_from_string(ctx->argv[1]);
3340     if (version < OFP12_VERSION) {
3341         ovs_fatal(0, "%s: not a valid version for OXM", ctx->argv[1]);
3342     }
3343
3344     ofctl_parse_nxm__(true, version);
3345 }
3346
3347 static void
3348 print_differences(const char *prefix,
3349                   const void *a_, size_t a_len,
3350                   const void *b_, size_t b_len)
3351 {
3352     const uint8_t *a = a_;
3353     const uint8_t *b = b_;
3354     size_t i;
3355
3356     for (i = 0; i < MIN(a_len, b_len); i++) {
3357         if (a[i] != b[i]) {
3358             printf("%s%2"PRIuSIZE": %02"PRIx8" -> %02"PRIx8"\n",
3359                    prefix, i, a[i], b[i]);
3360         }
3361     }
3362     for (i = a_len; i < b_len; i++) {
3363         printf("%s%2"PRIuSIZE": (none) -> %02"PRIx8"\n", prefix, i, b[i]);
3364     }
3365     for (i = b_len; i < a_len; i++) {
3366         printf("%s%2"PRIuSIZE": %02"PRIx8" -> (none)\n", prefix, i, a[i]);
3367     }
3368 }
3369
3370 static void
3371 ofctl_parse_actions__(const char *version_s, bool instructions)
3372 {
3373     enum ofp_version version;
3374     struct ds in;
3375
3376     version = ofputil_version_from_string(version_s);
3377     if (!version) {
3378         ovs_fatal(0, "%s: not a valid OpenFlow version", version_s);
3379     }
3380
3381     ds_init(&in);
3382     while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3383         struct ofpbuf of_out;
3384         struct ofpbuf of_in;
3385         struct ofpbuf ofpacts;
3386         const char *table_id;
3387         char *actions;
3388         enum ofperr error;
3389         size_t size;
3390         struct ds s;
3391
3392         /* Parse table_id separated with the follow-up actions by ",", if
3393          * any. */
3394         actions = ds_cstr(&in);
3395         table_id = NULL;
3396         if (strstr(actions, ",")) {
3397             table_id = strsep(&actions, ",");
3398         }
3399
3400         /* Parse hex bytes. */
3401         ofpbuf_init(&of_in, 0);
3402         if (ofpbuf_put_hex(&of_in, actions, NULL)[0] != '\0') {
3403             ovs_fatal(0, "Trailing garbage in hex data");
3404         }
3405
3406         /* Convert to ofpacts. */
3407         ofpbuf_init(&ofpacts, 0);
3408         size = of_in.size;
3409         error = (instructions
3410                  ? ofpacts_pull_openflow_instructions
3411                  : ofpacts_pull_openflow_actions)(
3412                      &of_in, of_in.size, version, &ofpacts);
3413         if (!error && instructions) {
3414             /* Verify actions, enforce consistency. */
3415             enum ofputil_protocol protocol;
3416             struct flow flow;
3417
3418             memset(&flow, 0, sizeof flow);
3419             protocol = ofputil_protocols_from_ofp_version(version);
3420             error = ofpacts_check_consistency(ofpacts.data, ofpacts.size,
3421                                               &flow, OFPP_MAX,
3422                                               table_id ? atoi(table_id) : 0,
3423                                               OFPTT_MAX + 1, protocol);
3424         }
3425         if (error) {
3426             printf("bad %s %s: %s\n\n",
3427                    version_s, instructions ? "instructions" : "actions",
3428                    ofperr_get_name(error));
3429             ofpbuf_uninit(&ofpacts);
3430             ofpbuf_uninit(&of_in);
3431             continue;
3432         }
3433         ofpbuf_push_uninit(&of_in, size);
3434
3435         /* Print cls_rule. */
3436         ds_init(&s);
3437         ds_put_cstr(&s, "actions=");
3438         ofpacts_format(ofpacts.data, ofpacts.size, &s);
3439         puts(ds_cstr(&s));
3440         ds_destroy(&s);
3441
3442         /* Convert back to ofp10 actions and print differences from input. */
3443         ofpbuf_init(&of_out, 0);
3444         if (instructions) {
3445            ofpacts_put_openflow_instructions(ofpacts.data, ofpacts.size,
3446                                              &of_out, version);
3447         } else {
3448            ofpacts_put_openflow_actions(ofpacts.data, ofpacts.size,
3449                                          &of_out, version);
3450         }
3451
3452         print_differences("", of_in.data, of_in.size,
3453                           of_out.data, of_out.size);
3454         putchar('\n');
3455
3456         ofpbuf_uninit(&ofpacts);
3457         ofpbuf_uninit(&of_in);
3458         ofpbuf_uninit(&of_out);
3459     }
3460     ds_destroy(&in);
3461 }
3462
3463 /* "parse-actions VERSION": reads a series of action specifications for the
3464  * given OpenFlow VERSION as hex bytes from stdin, converts them to ofpacts,
3465  * prints them as strings on stdout, and then converts them back to hex bytes
3466  * and prints any differences from the input. */
3467 static void
3468 ofctl_parse_actions(struct ovs_cmdl_context *ctx)
3469 {
3470     ofctl_parse_actions__(ctx->argv[1], false);
3471 }
3472
3473 /* "parse-actions VERSION": reads a series of instruction specifications for
3474  * the given OpenFlow VERSION as hex bytes from stdin, converts them to
3475  * ofpacts, prints them as strings on stdout, and then converts them back to
3476  * hex bytes and prints any differences from the input. */
3477 static void
3478 ofctl_parse_instructions(struct ovs_cmdl_context *ctx)
3479 {
3480     ofctl_parse_actions__(ctx->argv[1], true);
3481 }
3482
3483 /* "parse-ofp10-match": reads a series of ofp10_match specifications as hex
3484  * bytes from stdin, converts them to cls_rules, prints them as strings on
3485  * stdout, and then converts them back to hex bytes and prints any differences
3486  * from the input.
3487  *
3488  * The input hex bytes may contain "x"s to represent "don't-cares", bytes whose
3489  * values are ignored in the input and will be set to zero when OVS converts
3490  * them back to hex bytes.  ovs-ofctl actually sets "x"s to random bits when
3491  * it does the conversion to hex, to ensure that in fact they are ignored. */
3492 static void
3493 ofctl_parse_ofp10_match(struct ovs_cmdl_context *ctx OVS_UNUSED)
3494 {
3495     struct ds expout;
3496     struct ds in;
3497
3498     ds_init(&in);
3499     ds_init(&expout);
3500     while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3501         struct ofpbuf match_in, match_expout;
3502         struct ofp10_match match_out;
3503         struct ofp10_match match_normal;
3504         struct match match;
3505         char *p;
3506
3507         /* Parse hex bytes to use for expected output. */
3508         ds_clear(&expout);
3509         ds_put_cstr(&expout, ds_cstr(&in));
3510         for (p = ds_cstr(&expout); *p; p++) {
3511             if (*p == 'x') {
3512                 *p = '0';
3513             }
3514         }
3515         ofpbuf_init(&match_expout, 0);
3516         if (ofpbuf_put_hex(&match_expout, ds_cstr(&expout), NULL)[0] != '\0') {
3517             ovs_fatal(0, "Trailing garbage in hex data");
3518         }
3519         if (match_expout.size != sizeof(struct ofp10_match)) {
3520             ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3521                       match_expout.size, sizeof(struct ofp10_match));
3522         }
3523
3524         /* Parse hex bytes for input. */
3525         for (p = ds_cstr(&in); *p; p++) {
3526             if (*p == 'x') {
3527                 *p = "0123456789abcdef"[random_uint32() & 0xf];
3528             }
3529         }
3530         ofpbuf_init(&match_in, 0);
3531         if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
3532             ovs_fatal(0, "Trailing garbage in hex data");
3533         }
3534         if (match_in.size != sizeof(struct ofp10_match)) {
3535             ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3536                       match_in.size, sizeof(struct ofp10_match));
3537         }
3538
3539         /* Convert to cls_rule and print. */
3540         ofputil_match_from_ofp10_match(match_in.data, &match);
3541         match_print(&match);
3542
3543         /* Convert back to ofp10_match and print differences from input. */
3544         ofputil_match_to_ofp10_match(&match, &match_out);
3545         print_differences("", match_expout.data, match_expout.size,
3546                           &match_out, sizeof match_out);
3547
3548         /* Normalize, then convert and compare again. */
3549         ofputil_normalize_match(&match);
3550         ofputil_match_to_ofp10_match(&match, &match_normal);
3551         print_differences("normal: ", &match_out, sizeof match_out,
3552                           &match_normal, sizeof match_normal);
3553         putchar('\n');
3554
3555         ofpbuf_uninit(&match_in);
3556         ofpbuf_uninit(&match_expout);
3557     }
3558     ds_destroy(&in);
3559     ds_destroy(&expout);
3560 }
3561
3562 /* "parse-ofp11-match": reads a series of ofp11_match specifications as hex
3563  * bytes from stdin, converts them to "struct match"es, prints them as strings
3564  * on stdout, and then converts them back to hex bytes and prints any
3565  * differences from the input. */
3566 static void
3567 ofctl_parse_ofp11_match(struct ovs_cmdl_context *ctx OVS_UNUSED)
3568 {
3569     struct ds in;
3570
3571     ds_init(&in);
3572     while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3573         struct ofpbuf match_in;
3574         struct ofp11_match match_out;
3575         struct match match;
3576         enum ofperr error;
3577
3578         /* Parse hex bytes. */
3579         ofpbuf_init(&match_in, 0);
3580         if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
3581             ovs_fatal(0, "Trailing garbage in hex data");
3582         }
3583         if (match_in.size != sizeof(struct ofp11_match)) {
3584             ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3585                       match_in.size, sizeof(struct ofp11_match));
3586         }
3587
3588         /* Convert to match. */
3589         error = ofputil_match_from_ofp11_match(match_in.data, &match);
3590         if (error) {
3591             printf("bad ofp11_match: %s\n\n", ofperr_get_name(error));
3592             ofpbuf_uninit(&match_in);
3593             continue;
3594         }
3595
3596         /* Print match. */
3597         match_print(&match);
3598
3599         /* Convert back to ofp11_match and print differences from input. */
3600         ofputil_match_to_ofp11_match(&match, &match_out);
3601
3602         print_differences("", match_in.data, match_in.size,
3603                           &match_out, sizeof match_out);
3604         putchar('\n');
3605
3606         ofpbuf_uninit(&match_in);
3607     }
3608     ds_destroy(&in);
3609 }
3610
3611 /* "parse-pcap PCAP": read packets from PCAP and print their flows. */
3612 static void
3613 ofctl_parse_pcap(struct ovs_cmdl_context *ctx)
3614 {
3615     FILE *pcap;
3616
3617     pcap = ovs_pcap_open(ctx->argv[1], "rb");
3618     if (!pcap) {
3619         ovs_fatal(errno, "%s: open failed", ctx->argv[1]);
3620     }
3621
3622     for (;;) {
3623         struct dp_packet *packet;
3624         struct flow flow;
3625         int error;
3626
3627         error = ovs_pcap_read(pcap, &packet, NULL);
3628         if (error == EOF) {
3629             break;
3630         } else if (error) {
3631             ovs_fatal(error, "%s: read failed", ctx->argv[1]);
3632         }
3633
3634         pkt_metadata_init(&packet->md, ODPP_NONE);
3635         flow_extract(packet, &flow);
3636         flow_print(stdout, &flow);
3637         putchar('\n');
3638         dp_packet_delete(packet);
3639     }
3640 }
3641
3642 /* "check-vlan VLAN_TCI VLAN_TCI_MASK": converts the specified vlan_tci and
3643  * mask values to and from various formats and prints the results. */
3644 static void
3645 ofctl_check_vlan(struct ovs_cmdl_context *ctx)
3646 {
3647     struct match match;
3648
3649     char *string_s;
3650     struct ofputil_flow_mod fm;
3651
3652     struct ofpbuf nxm;
3653     struct match nxm_match;
3654     int nxm_match_len;
3655     char *nxm_s;
3656
3657     struct ofp10_match of10_raw;
3658     struct match of10_match;
3659
3660     struct ofp11_match of11_raw;
3661     struct match of11_match;
3662
3663     enum ofperr error;
3664     char *error_s;
3665
3666     enum ofputil_protocol usable_protocols; /* Unused for now. */
3667
3668     match_init_catchall(&match);
3669     match.flow.vlan_tci = htons(strtoul(ctx->argv[1], NULL, 16));
3670     match.wc.masks.vlan_tci = htons(strtoul(ctx->argv[2], NULL, 16));
3671
3672     /* Convert to and from string. */
3673     string_s = match_to_string(&match, OFP_DEFAULT_PRIORITY);
3674     printf("%s -> ", string_s);
3675     fflush(stdout);
3676     error_s = parse_ofp_str(&fm, -1, string_s, &usable_protocols);
3677     if (error_s) {
3678         ovs_fatal(0, "%s", error_s);
3679     }
3680     printf("%04"PRIx16"/%04"PRIx16"\n",
3681            ntohs(fm.match.flow.vlan_tci),
3682            ntohs(fm.match.wc.masks.vlan_tci));
3683     free(string_s);
3684
3685     /* Convert to and from NXM. */
3686     ofpbuf_init(&nxm, 0);
3687     nxm_match_len = nx_put_match(&nxm, &match, htonll(0), htonll(0));
3688     nxm_s = nx_match_to_string(nxm.data, nxm_match_len);
3689     error = nx_pull_match(&nxm, nxm_match_len, &nxm_match, NULL, NULL);
3690     printf("NXM: %s -> ", nxm_s);
3691     if (error) {
3692         printf("%s\n", ofperr_to_string(error));
3693     } else {
3694         printf("%04"PRIx16"/%04"PRIx16"\n",
3695                ntohs(nxm_match.flow.vlan_tci),
3696                ntohs(nxm_match.wc.masks.vlan_tci));
3697     }
3698     free(nxm_s);
3699     ofpbuf_uninit(&nxm);
3700
3701     /* Convert to and from OXM. */
3702     ofpbuf_init(&nxm, 0);
3703     nxm_match_len = oxm_put_match(&nxm, &match, OFP12_VERSION);
3704     nxm_s = oxm_match_to_string(&nxm, nxm_match_len);
3705     error = oxm_pull_match(&nxm, &nxm_match);
3706     printf("OXM: %s -> ", nxm_s);
3707     if (error) {
3708         printf("%s\n", ofperr_to_string(error));
3709     } else {
3710         uint16_t vid = ntohs(nxm_match.flow.vlan_tci) &
3711             (VLAN_VID_MASK | VLAN_CFI);
3712         uint16_t mask = ntohs(nxm_match.wc.masks.vlan_tci) &
3713             (VLAN_VID_MASK | VLAN_CFI);
3714
3715         printf("%04"PRIx16"/%04"PRIx16",", vid, mask);
3716         if (vid && vlan_tci_to_pcp(nxm_match.wc.masks.vlan_tci)) {
3717             printf("%02"PRIx8"\n", vlan_tci_to_pcp(nxm_match.flow.vlan_tci));
3718         } else {
3719             printf("--\n");
3720         }
3721     }
3722     free(nxm_s);
3723     ofpbuf_uninit(&nxm);
3724
3725     /* Convert to and from OpenFlow 1.0. */
3726     ofputil_match_to_ofp10_match(&match, &of10_raw);
3727     ofputil_match_from_ofp10_match(&of10_raw, &of10_match);
3728     printf("OF1.0: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
3729            ntohs(of10_raw.dl_vlan),
3730            (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN)) != 0,
3731            of10_raw.dl_vlan_pcp,
3732            (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN_PCP)) != 0,
3733            ntohs(of10_match.flow.vlan_tci),
3734            ntohs(of10_match.wc.masks.vlan_tci));
3735
3736     /* Convert to and from OpenFlow 1.1. */
3737     ofputil_match_to_ofp11_match(&match, &of11_raw);
3738     ofputil_match_from_ofp11_match(&of11_raw, &of11_match);
3739     printf("OF1.1: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
3740            ntohs(of11_raw.dl_vlan),
3741            (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN)) != 0,
3742            of11_raw.dl_vlan_pcp,
3743            (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN_PCP)) != 0,
3744            ntohs(of11_match.flow.vlan_tci),
3745            ntohs(of11_match.wc.masks.vlan_tci));
3746 }
3747
3748 /* "print-error ENUM": Prints the type and code of ENUM for every OpenFlow
3749  * version. */
3750 static void
3751 ofctl_print_error(struct ovs_cmdl_context *ctx)
3752 {
3753     enum ofperr error;
3754     int version;
3755
3756     error = ofperr_from_name(ctx->argv[1]);
3757     if (!error) {
3758         ovs_fatal(0, "unknown error \"%s\"", ctx->argv[1]);
3759     }
3760
3761     for (version = 0; version <= UINT8_MAX; version++) {
3762         const char *name = ofperr_domain_get_name(version);
3763         if (name) {
3764             int vendor = ofperr_get_vendor(error, version);
3765             int type = ofperr_get_type(error, version);
3766             int code = ofperr_get_code(error, version);
3767
3768             if (vendor != -1 || type != -1 || code != -1) {
3769                 printf("%s: vendor %#x, type %d, code %d\n",
3770                        name, vendor, type, code);
3771             }
3772         }
3773     }
3774 }
3775
3776 /* "encode-error-reply ENUM REQUEST": Encodes an error reply to REQUEST for the
3777  * error named ENUM and prints the error reply in hex. */
3778 static void
3779 ofctl_encode_error_reply(struct ovs_cmdl_context *ctx)
3780 {
3781     const struct ofp_header *oh;
3782     struct ofpbuf request, *reply;
3783     enum ofperr error;
3784
3785     error = ofperr_from_name(ctx->argv[1]);
3786     if (!error) {
3787         ovs_fatal(0, "unknown error \"%s\"", ctx->argv[1]);
3788     }
3789
3790     ofpbuf_init(&request, 0);
3791     if (ofpbuf_put_hex(&request, ctx->argv[2], NULL)[0] != '\0') {
3792         ovs_fatal(0, "Trailing garbage in hex data");
3793     }
3794     if (request.size < sizeof(struct ofp_header)) {
3795         ovs_fatal(0, "Request too short");
3796     }
3797
3798     oh = request.data;
3799     if (request.size != ntohs(oh->length)) {
3800         ovs_fatal(0, "Request size inconsistent");
3801     }
3802
3803     reply = ofperr_encode_reply(error, request.data);
3804     ofpbuf_uninit(&request);
3805
3806     ovs_hex_dump(stdout, reply->data, reply->size, 0, false);
3807     ofpbuf_delete(reply);
3808 }
3809
3810 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
3811  * binary data, interpreting them as an OpenFlow message, and prints the
3812  * OpenFlow message on stdout, at VERBOSITY (level 2 by default).
3813  *
3814  * Alternative usage: "ofp-print [VERBOSITY] - < HEXSTRING_FILE", where
3815  * HEXSTRING_FILE contains the HEXSTRING. */
3816 static void
3817 ofctl_ofp_print(struct ovs_cmdl_context *ctx)
3818 {
3819     struct ofpbuf packet;
3820     char *buffer;
3821     int verbosity = 2;
3822     struct ds line;
3823
3824     ds_init(&line);
3825
3826     if (!strcmp(ctx->argv[ctx->argc-1], "-")) {
3827         if (ds_get_line(&line, stdin)) {
3828            VLOG_FATAL("Failed to read stdin");
3829         }
3830
3831         buffer = line.string;
3832         verbosity = ctx->argc > 2 ? atoi(ctx->argv[1]) : verbosity;
3833     } else if (ctx->argc > 2) {
3834         buffer = ctx->argv[1];
3835         verbosity = atoi(ctx->argv[2]);
3836     } else {
3837         buffer = ctx->argv[1];
3838     }
3839
3840     ofpbuf_init(&packet, strlen(buffer) / 2);
3841     if (ofpbuf_put_hex(&packet, buffer, NULL)[0] != '\0') {
3842         ovs_fatal(0, "trailing garbage following hex bytes");
3843     }
3844     ofp_print(stdout, packet.data, packet.size, verbosity);
3845     ofpbuf_uninit(&packet);
3846     ds_destroy(&line);
3847 }
3848
3849 /* "encode-hello BITMAP...": Encodes each BITMAP as an OpenFlow hello message
3850  * and dumps each message in hex.  */
3851 static void
3852 ofctl_encode_hello(struct ovs_cmdl_context *ctx)
3853 {
3854     uint32_t bitmap = strtol(ctx->argv[1], NULL, 0);
3855     struct ofpbuf *hello;
3856
3857     hello = ofputil_encode_hello(bitmap);
3858     ovs_hex_dump(stdout, hello->data, hello->size, 0, false);
3859     ofp_print(stdout, hello->data, hello->size, verbosity);
3860     ofpbuf_delete(hello);
3861 }
3862
3863 static const struct ovs_cmdl_command all_commands[] = {
3864     { "show", "switch",
3865       1, 1, ofctl_show },
3866     { "monitor", "switch [misslen] [invalid_ttl] [watch:[...]]",
3867       1, 3, ofctl_monitor },
3868     { "snoop", "switch",
3869       1, 1, ofctl_snoop },
3870     { "dump-desc", "switch",
3871       1, 1, ofctl_dump_desc },
3872     { "dump-tables", "switch",
3873       1, 1, ofctl_dump_tables },
3874     { "dump-table-features", "switch",
3875       1, 1, ofctl_dump_table_features },
3876     { "dump-table-desc", "switch",
3877       1, 1, ofctl_dump_table_desc },
3878     { "dump-flows", "switch",
3879       1, 2, ofctl_dump_flows },
3880     { "dump-aggregate", "switch",
3881       1, 2, ofctl_dump_aggregate },
3882     { "queue-stats", "switch [port [queue]]",
3883       1, 3, ofctl_queue_stats },
3884     { "queue-get-config", "switch [port [queue]]",
3885       1, 3, ofctl_queue_get_config },
3886     { "add-flow", "switch flow",
3887       2, 2, ofctl_add_flow },
3888     { "add-flows", "switch file",
3889       2, 2, ofctl_add_flows },
3890     { "mod-flows", "switch flow",
3891       2, 2, ofctl_mod_flows },
3892     { "del-flows", "switch [flow]",
3893       1, 2, ofctl_del_flows },
3894     { "replace-flows", "switch file",
3895       2, 2, ofctl_replace_flows },
3896     { "diff-flows", "source1 source2",
3897       2, 2, ofctl_diff_flows },
3898     { "add-meter", "switch meter",
3899       2, 2, ofctl_add_meter },
3900     { "mod-meter", "switch meter",
3901       2, 2, ofctl_mod_meter },
3902     { "del-meter", "switch meter",
3903       2, 2, ofctl_del_meters },
3904     { "del-meters", "switch",
3905       1, 1, ofctl_del_meters },
3906     { "dump-meter", "switch meter",
3907       2, 2, ofctl_dump_meters },
3908     { "dump-meters", "switch",
3909       1, 1, ofctl_dump_meters },
3910     { "meter-stats", "switch [meter]",
3911       1, 2, ofctl_meter_stats },
3912     { "meter-features", "switch",
3913       1, 1, ofctl_meter_features },
3914     { "packet-out", "switch in_port actions packet...",
3915       4, INT_MAX, ofctl_packet_out },
3916     { "dump-ports", "switch [port]",
3917       1, 2, ofctl_dump_ports },
3918     { "dump-ports-desc", "switch [port]",
3919       1, 2, ofctl_dump_ports_desc },
3920     { "mod-port", "switch iface act",
3921       3, 3, ofctl_mod_port },
3922     { "mod-table", "switch mod",
3923       3, 3, ofctl_mod_table },
3924     { "get-frags", "switch",
3925       1, 1, ofctl_get_frags },
3926     { "set-frags", "switch frag_mode",
3927       2, 2, ofctl_set_frags },
3928     { "probe", "target",
3929       1, 1, ofctl_probe },
3930     { "ping", "target [n]",
3931       1, 2, ofctl_ping },
3932     { "benchmark", "target n count",
3933       3, 3, ofctl_benchmark },
3934
3935     { "ofp-parse", "file",
3936       1, 1, ofctl_ofp_parse },
3937     { "ofp-parse-pcap", "pcap",
3938       1, INT_MAX, ofctl_ofp_parse_pcap },
3939
3940     { "add-group", "switch group",
3941       1, 2, ofctl_add_group },
3942     { "add-groups", "switch file",
3943       1, 2, ofctl_add_groups },
3944     { "mod-group", "switch group",
3945       1, 2, ofctl_mod_group },
3946     { "del-groups", "switch [group]",
3947       1, 2, ofctl_del_groups },
3948     { "insert-buckets", "switch [group]",
3949       1, 2, ofctl_insert_bucket },
3950     { "remove-buckets", "switch [group]",
3951       1, 2, ofctl_remove_bucket },
3952     { "dump-groups", "switch [group]",
3953       1, 2, ofctl_dump_group_desc },
3954     { "dump-group-stats", "switch [group]",
3955       1, 2, ofctl_dump_group_stats },
3956     { "dump-group-features", "switch",
3957       1, 1, ofctl_dump_group_features },
3958     { "add-tlv-map", "switch map",
3959       2, 2, ofctl_add_tlv_map },
3960     { "del-tlv-map", "switch [map]",
3961       1, 2, ofctl_del_tlv_map },
3962     { "dump-tlv-map", "switch",
3963       1, 1, ofctl_dump_tlv_map },
3964     { "help", NULL, 0, INT_MAX, ofctl_help },
3965     { "list-commands", NULL, 0, INT_MAX, ofctl_list_commands },
3966
3967     /* Undocumented commands for testing. */
3968     { "parse-flow", NULL, 1, 1, ofctl_parse_flow },
3969     { "parse-flows", NULL, 1, 1, ofctl_parse_flows },
3970     { "parse-nx-match", NULL, 0, 0, ofctl_parse_nxm },
3971     { "parse-nxm", NULL, 0, 0, ofctl_parse_nxm },
3972     { "parse-oxm", NULL, 1, 1, ofctl_parse_oxm },
3973     { "parse-actions", NULL, 1, 1, ofctl_parse_actions },
3974     { "parse-instructions", NULL, 1, 1, ofctl_parse_instructions },
3975     { "parse-ofp10-match", NULL, 0, 0, ofctl_parse_ofp10_match },
3976     { "parse-ofp11-match", NULL, 0, 0, ofctl_parse_ofp11_match },
3977     { "parse-pcap", NULL, 1, 1, ofctl_parse_pcap },
3978     { "check-vlan", NULL, 2, 2, ofctl_check_vlan },
3979     { "print-error", NULL, 1, 1, ofctl_print_error },
3980     { "encode-error-reply", NULL, 2, 2, ofctl_encode_error_reply },
3981     { "ofp-print", NULL, 1, 2, ofctl_ofp_print },
3982     { "encode-hello", NULL, 1, 1, ofctl_encode_hello },
3983
3984     { NULL, NULL, 0, 0, NULL },
3985 };
3986
3987 static const struct ovs_cmdl_command *get_all_commands(void)
3988 {
3989     return all_commands;
3990 }