utilities/ovs-ofctl.c

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