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             fflush(stderr);
1483
1484             switch ((int) type) {
1485             case OFPTYPE_BARRIER_REPLY:
1486                 if (barrier_aux.conn) {
1487                     unixctl_command_reply(barrier_aux.conn, NULL);
1488                     barrier_aux.conn = NULL;
1489                 }
1490                 break;
1491
1492             case OFPTYPE_ECHO_REQUEST:
1493                 if (reply_to_echo_requests) {
1494                     struct ofpbuf *reply;
1495
1496                     reply = make_echo_reply(ofpbuf_data(b));
1497                     retval = vconn_send_block(vconn, reply);
1498                     if (retval) {
1499                         ovs_fatal(retval, "failed to send echo reply");
1500                     }
1501                 }
1502                 break;
1503             }
1504             ofpbuf_delete(b);
1505         }
1506
1507         if (exiting) {
1508             break;
1509         }
1510
1511         vconn_run(vconn);
1512         vconn_run_wait(vconn);
1513         if (!blocked) {
1514             vconn_recv_wait(vconn);
1515         }
1516         unixctl_server_wait(server);
1517         poll_block();
1518     }
1519     vconn_close(vconn);
1520     unixctl_server_destroy(server);
1521 }
1522
1523 static void
1524 ofctl_monitor(int argc, char *argv[])
1525 {
1526     struct vconn *vconn;
1527     int i;
1528     enum ofputil_protocol usable_protocols;
1529
1530     open_vconn(argv[1], &vconn);
1531     for (i = 2; i < argc; i++) {
1532         const char *arg = argv[i];
1533
1534         if (isdigit((unsigned char) *arg)) {
1535             struct ofp_switch_config config;
1536
1537             fetch_switch_config(vconn, &config);
1538             config.miss_send_len = htons(atoi(arg));
1539             set_switch_config(vconn, &config);
1540         } else if (!strcmp(arg, "invalid_ttl")) {
1541             monitor_set_invalid_ttl_to_controller(vconn);
1542         } else if (!strncmp(arg, "watch:", 6)) {
1543             struct ofputil_flow_monitor_request fmr;
1544             struct ofpbuf *msg;
1545             char *error;
1546
1547             error = parse_flow_monitor_request(&fmr, arg + 6,
1548                                                &usable_protocols);
1549             if (error) {
1550                 ovs_fatal(0, "%s", error);
1551             }
1552
1553             msg = ofpbuf_new(0);
1554             ofputil_append_flow_monitor_request(&fmr, msg);
1555             dump_stats_transaction(vconn, msg);
1556             fflush(stdout);
1557         } else {
1558             ovs_fatal(0, "%s: unsupported \"monitor\" argument", arg);
1559         }
1560     }
1561
1562     if (preferred_packet_in_format >= 0) {
1563         set_packet_in_format(vconn, preferred_packet_in_format);
1564     } else {
1565         enum ofp_version version = vconn_get_version(vconn);
1566
1567         switch (version) {
1568         case OFP10_VERSION: {
1569             struct ofpbuf *spif, *reply;
1570
1571             spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1572                                                      NXPIF_NXM);
1573             run(vconn_transact_noreply(vconn, spif, &reply),
1574                 "talking to %s", vconn_get_name(vconn));
1575             if (reply) {
1576                 char *s = ofp_to_string(ofpbuf_data(reply), ofpbuf_size(reply), 2);
1577                 VLOG_DBG("%s: failed to set packet in format to nxm, controller"
1578                         " replied: %s. Falling back to the switch default.",
1579                         vconn_get_name(vconn), s);
1580                 free(s);
1581                 ofpbuf_delete(reply);
1582             }
1583             break;
1584         }
1585         case OFP11_VERSION:
1586         case OFP12_VERSION:
1587         case OFP13_VERSION:
1588         case OFP14_VERSION:
1589         case OFP15_VERSION:
1590             break;
1591         default:
1592             OVS_NOT_REACHED();
1593         }
1594     }
1595
1596     monitor_vconn(vconn, true);
1597 }
1598
1599 static void
1600 ofctl_snoop(int argc OVS_UNUSED, char *argv[])
1601 {
1602     struct vconn *vconn;
1603
1604     open_vconn__(argv[1], SNOOP, &vconn);
1605     monitor_vconn(vconn, false);
1606 }
1607
1608 static void
1609 ofctl_dump_ports(int argc, char *argv[])
1610 {
1611     struct ofpbuf *request;
1612     struct vconn *vconn;
1613     ofp_port_t port;
1614
1615     open_vconn(argv[1], &vconn);
1616     port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_ANY;
1617     request = ofputil_encode_dump_ports_request(vconn_get_version(vconn), port);
1618     dump_stats_transaction(vconn, request);
1619     vconn_close(vconn);
1620 }
1621
1622 static void
1623 ofctl_dump_ports_desc(int argc OVS_UNUSED, char *argv[])
1624 {
1625     struct ofpbuf *request;
1626     struct vconn *vconn;
1627     ofp_port_t port;
1628
1629     open_vconn(argv[1], &vconn);
1630     port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_ANY;
1631     request = ofputil_encode_port_desc_stats_request(vconn_get_version(vconn),
1632                                                      port);
1633     dump_stats_transaction(vconn, request);
1634     vconn_close(vconn);
1635 }
1636
1637 static void
1638 ofctl_probe(int argc OVS_UNUSED, char *argv[])
1639 {
1640     struct ofpbuf *request;
1641     struct vconn *vconn;
1642     struct ofpbuf *reply;
1643
1644     open_vconn(argv[1], &vconn);
1645     request = make_echo_request(vconn_get_version(vconn));
1646     run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1647     if (ofpbuf_size(reply) != sizeof(struct ofp_header)) {
1648         ovs_fatal(0, "reply does not match request");
1649     }
1650     ofpbuf_delete(reply);
1651     vconn_close(vconn);
1652 }
1653
1654 static void
1655 ofctl_packet_out(int argc, char *argv[])
1656 {
1657     enum ofputil_protocol protocol;
1658     struct ofputil_packet_out po;
1659     struct ofpbuf ofpacts;
1660     struct vconn *vconn;
1661     char *error;
1662     int i;
1663     enum ofputil_protocol usable_protocols; /* XXX: Use in proto selection */
1664
1665     ofpbuf_init(&ofpacts, 64);
1666     error = parse_ofpacts(argv[3], &ofpacts, &usable_protocols);
1667     if (error) {
1668         ovs_fatal(0, "%s", error);
1669     }
1670
1671     po.buffer_id = UINT32_MAX;
1672     po.in_port = str_to_port_no(argv[1], argv[2]);
1673     po.ofpacts = ofpbuf_data(&ofpacts);
1674     po.ofpacts_len = ofpbuf_size(&ofpacts);
1675
1676     protocol = open_vconn(argv[1], &vconn);
1677     for (i = 4; i < argc; i++) {
1678         struct ofpbuf *packet, *opo;
1679         const char *error_msg;
1680
1681         error_msg = eth_from_hex(argv[i], &packet);
1682         if (error_msg) {
1683             ovs_fatal(0, "%s", error_msg);
1684         }
1685
1686         po.packet = ofpbuf_data(packet);
1687         po.packet_len = ofpbuf_size(packet);
1688         opo = ofputil_encode_packet_out(&po, protocol);
1689         transact_noreply(vconn, opo);
1690         ofpbuf_delete(packet);
1691     }
1692     vconn_close(vconn);
1693     ofpbuf_uninit(&ofpacts);
1694 }
1695
1696 static void
1697 ofctl_mod_port(int argc OVS_UNUSED, char *argv[])
1698 {
1699     struct ofp_config_flag {
1700         const char *name;             /* The flag's name. */
1701         enum ofputil_port_config bit; /* Bit to turn on or off. */
1702         bool on;                      /* Value to set the bit to. */
1703     };
1704     static const struct ofp_config_flag flags[] = {
1705         { "up",          OFPUTIL_PC_PORT_DOWN,    false },
1706         { "down",        OFPUTIL_PC_PORT_DOWN,    true  },
1707         { "stp",         OFPUTIL_PC_NO_STP,       false },
1708         { "receive",     OFPUTIL_PC_NO_RECV,      false },
1709         { "receive-stp", OFPUTIL_PC_NO_RECV_STP,  false },
1710         { "flood",       OFPUTIL_PC_NO_FLOOD,     false },
1711         { "forward",     OFPUTIL_PC_NO_FWD,       false },
1712         { "packet-in",   OFPUTIL_PC_NO_PACKET_IN, false },
1713     };
1714
1715     const struct ofp_config_flag *flag;
1716     enum ofputil_protocol protocol;
1717     struct ofputil_port_mod pm;
1718     struct ofputil_phy_port pp;
1719     struct vconn *vconn;
1720     const char *command;
1721     bool not;
1722
1723     fetch_ofputil_phy_port(argv[1], argv[2], &pp);
1724
1725     pm.port_no = pp.port_no;
1726     memcpy(pm.hw_addr, pp.hw_addr, ETH_ADDR_LEN);
1727     pm.config = 0;
1728     pm.mask = 0;
1729     pm.advertise = 0;
1730
1731     if (!strncasecmp(argv[3], "no-", 3)) {
1732         command = argv[3] + 3;
1733         not = true;
1734     } else if (!strncasecmp(argv[3], "no", 2)) {
1735         command = argv[3] + 2;
1736         not = true;
1737     } else {
1738         command = argv[3];
1739         not = false;
1740     }
1741     for (flag = flags; flag < &flags[ARRAY_SIZE(flags)]; flag++) {
1742         if (!strcasecmp(command, flag->name)) {
1743             pm.mask = flag->bit;
1744             pm.config = flag->on ^ not ? flag->bit : 0;
1745             goto found;
1746         }
1747     }
1748     ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
1749
1750 found:
1751     protocol = open_vconn(argv[1], &vconn);
1752     transact_noreply(vconn, ofputil_encode_port_mod(&pm, protocol));
1753     vconn_close(vconn);
1754 }
1755
1756 static void
1757 ofctl_mod_table(int argc OVS_UNUSED, char *argv[])
1758 {
1759     enum ofputil_protocol protocol, usable_protocols;
1760     struct ofputil_table_mod tm;
1761     struct vconn *vconn;
1762     char *error;
1763     int i;
1764
1765     error = parse_ofp_table_mod(&tm, argv[2], argv[3], &usable_protocols);
1766     if (error) {
1767         ovs_fatal(0, "%s", error);
1768     }
1769
1770     protocol = open_vconn(argv[1], &vconn);
1771     if (!(protocol & usable_protocols)) {
1772         for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
1773             enum ofputil_protocol f = 1 << i;
1774             if (f != protocol
1775                 && f & usable_protocols
1776                 && try_set_protocol(vconn, f, &protocol)) {
1777                 protocol = f;
1778                 break;
1779             }
1780         }
1781     }
1782
1783     if (!(protocol & usable_protocols)) {
1784         char *usable_s = ofputil_protocols_to_string(usable_protocols);
1785         ovs_fatal(0, "Switch does not support table mod message(%s)", usable_s);
1786     }
1787
1788     transact_noreply(vconn, ofputil_encode_table_mod(&tm, protocol));
1789     vconn_close(vconn);
1790 }
1791
1792 static void
1793 ofctl_get_frags(int argc OVS_UNUSED, char *argv[])
1794 {
1795     struct ofp_switch_config config;
1796     struct vconn *vconn;
1797
1798     open_vconn(argv[1], &vconn);
1799     fetch_switch_config(vconn, &config);
1800     puts(ofputil_frag_handling_to_string(ntohs(config.flags)));
1801     vconn_close(vconn);
1802 }
1803
1804 static void
1805 ofctl_set_frags(int argc OVS_UNUSED, char *argv[])
1806 {
1807     struct ofp_switch_config config;
1808     enum ofp_config_flags mode;
1809     struct vconn *vconn;
1810     ovs_be16 flags;
1811
1812     if (!ofputil_frag_handling_from_string(argv[2], &mode)) {
1813         ovs_fatal(0, "%s: unknown fragment handling mode", argv[2]);
1814     }
1815
1816     open_vconn(argv[1], &vconn);
1817     fetch_switch_config(vconn, &config);
1818     flags = htons(mode) | (config.flags & htons(~OFPC_FRAG_MASK));
1819     if (flags != config.flags) {
1820         /* Set the configuration. */
1821         config.flags = flags;
1822         set_switch_config(vconn, &config);
1823
1824         /* Then retrieve the configuration to see if it really took.  OpenFlow
1825          * doesn't define error reporting for bad modes, so this is all we can
1826          * do. */
1827         fetch_switch_config(vconn, &config);
1828         if (flags != config.flags) {
1829             ovs_fatal(0, "%s: setting fragment handling mode failed (this "
1830                       "switch probably doesn't support mode \"%s\")",
1831                       argv[1], ofputil_frag_handling_to_string(mode));
1832         }
1833     }
1834     vconn_close(vconn);
1835 }
1836
1837 static void
1838 ofctl_ofp_parse(int argc OVS_UNUSED, char *argv[])
1839 {
1840     const char *filename = argv[1];
1841     struct ofpbuf b;
1842     FILE *file;
1843
1844     file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1845     if (file == NULL) {
1846         ovs_fatal(errno, "%s: open", filename);
1847     }
1848
1849     ofpbuf_init(&b, 65536);
1850     for (;;) {
1851         struct ofp_header *oh;
1852         size_t length, tail_len;
1853         void *tail;
1854         size_t n;
1855
1856         ofpbuf_clear(&b);
1857         oh = ofpbuf_put_uninit(&b, sizeof *oh);
1858         n = fread(oh, 1, sizeof *oh, file);
1859         if (n == 0) {
1860             break;
1861         } else if (n < sizeof *oh) {
1862             ovs_fatal(0, "%s: unexpected end of file mid-message", filename);
1863         }
1864
1865         length = ntohs(oh->length);
1866         if (length < sizeof *oh) {
1867             ovs_fatal(0, "%s: %"PRIuSIZE"-byte message is too short for OpenFlow",
1868                       filename, length);
1869         }
1870
1871         tail_len = length - sizeof *oh;
1872         tail = ofpbuf_put_uninit(&b, tail_len);
1873         n = fread(tail, 1, tail_len, file);
1874         if (n < tail_len) {
1875             ovs_fatal(0, "%s: unexpected end of file mid-message", filename);
1876         }
1877
1878         ofp_print(stdout, ofpbuf_data(&b), ofpbuf_size(&b), verbosity + 2);
1879     }
1880     ofpbuf_uninit(&b);
1881
1882     if (file != stdin) {
1883         fclose(file);
1884     }
1885 }
1886
1887 static bool
1888 is_openflow_port(ovs_be16 port_, char *ports[])
1889 {
1890     uint16_t port = ntohs(port_);
1891     if (ports[0]) {
1892         int i;
1893
1894         for (i = 0; ports[i]; i++) {
1895             if (port == atoi(ports[i])) {
1896                 return true;
1897             }
1898         }
1899         return false;
1900     } else {
1901         return port == OFP_PORT || port == OFP_OLD_PORT;
1902     }
1903 }
1904
1905 static void
1906 ofctl_ofp_parse_pcap(int argc OVS_UNUSED, char *argv[])
1907 {
1908     struct tcp_reader *reader;
1909     FILE *file;
1910     int error;
1911     bool first;
1912
1913     file = ovs_pcap_open(argv[1], "rb");
1914     if (!file) {
1915         ovs_fatal(errno, "%s: open failed", argv[1]);
1916     }
1917
1918     reader = tcp_reader_open();
1919     first = true;
1920     for (;;) {
1921         struct ofpbuf *packet;
1922         long long int when;
1923         struct flow flow;
1924         const struct pkt_metadata md = PKT_METADATA_INITIALIZER(ODPP_NONE);
1925
1926         error = ovs_pcap_read(file, &packet, &when);
1927         if (error) {
1928             break;
1929         }
1930         flow_extract(packet, &md, &flow);
1931         if (flow.dl_type == htons(ETH_TYPE_IP)
1932             && flow.nw_proto == IPPROTO_TCP
1933             && (is_openflow_port(flow.tp_src, argv + 2) ||
1934                 is_openflow_port(flow.tp_dst, argv + 2))) {
1935             struct ofpbuf *payload = tcp_reader_run(reader, &flow, packet);
1936             if (payload) {
1937                 while (ofpbuf_size(payload) >= sizeof(struct ofp_header)) {
1938                     const struct ofp_header *oh;
1939                     void *data = ofpbuf_data(payload);
1940                     int length;
1941
1942                     /* Align OpenFlow on 8-byte boundary for safe access. */
1943                     ofpbuf_shift(payload, -((intptr_t) data & 7));
1944
1945                     oh = ofpbuf_data(payload);
1946                     length = ntohs(oh->length);
1947                     if (ofpbuf_size(payload) < length) {
1948                         break;
1949                     }
1950
1951                     if (!first) {
1952                         putchar('\n');
1953                     }
1954                     first = false;
1955
1956                     if (timestamp) {
1957                         char *s = xastrftime_msec("%H:%M:%S.### ", when, true);
1958                         fputs(s, stdout);
1959                         free(s);
1960                     }
1961
1962                     printf(IP_FMT".%"PRIu16" > "IP_FMT".%"PRIu16":\n",
1963                            IP_ARGS(flow.nw_src), ntohs(flow.tp_src),
1964                            IP_ARGS(flow.nw_dst), ntohs(flow.tp_dst));
1965                     ofp_print(stdout, ofpbuf_data(payload), length, verbosity + 1);
1966                     ofpbuf_pull(payload, length);
1967                 }
1968             }
1969         }
1970         ofpbuf_delete(packet);
1971     }
1972     tcp_reader_close(reader);
1973 }
1974
1975 static void
1976 ofctl_ping(int argc, char *argv[])
1977 {
1978     size_t max_payload = 65535 - sizeof(struct ofp_header);
1979     unsigned int payload;
1980     struct vconn *vconn;
1981     int i;
1982
1983     payload = argc > 2 ? atoi(argv[2]) : 64;
1984     if (payload > max_payload) {
1985         ovs_fatal(0, "payload must be between 0 and %"PRIuSIZE" bytes", max_payload);
1986     }
1987
1988     open_vconn(argv[1], &vconn);
1989     for (i = 0; i < 10; i++) {
1990         struct timeval start, end;
1991         struct ofpbuf *request, *reply;
1992         const struct ofp_header *rpy_hdr;
1993         enum ofptype type;
1994
1995         request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
1996                                vconn_get_version(vconn), payload);
1997         random_bytes(ofpbuf_put_uninit(request, payload), payload);
1998
1999         xgettimeofday(&start);
2000         run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
2001         xgettimeofday(&end);
2002
2003         rpy_hdr = ofpbuf_data(reply);
2004         if (ofptype_pull(&type, reply)
2005             || type != OFPTYPE_ECHO_REPLY
2006             || ofpbuf_size(reply) != payload
2007             || memcmp(ofpbuf_l3(request), ofpbuf_l3(reply), payload)) {
2008             printf("Reply does not match request.  Request:\n");
2009             ofp_print(stdout, request, ofpbuf_size(request), verbosity + 2);
2010             printf("Reply:\n");
2011             ofp_print(stdout, reply, ofpbuf_size(reply), verbosity + 2);
2012         }
2013         printf("%"PRIu32" bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
2014                ofpbuf_size(reply), argv[1], ntohl(rpy_hdr->xid),
2015                    (1000*(double)(end.tv_sec - start.tv_sec))
2016                    + (.001*(end.tv_usec - start.tv_usec)));
2017         ofpbuf_delete(request);
2018         ofpbuf_delete(reply);
2019     }
2020     vconn_close(vconn);
2021 }
2022
2023 static void
2024 ofctl_benchmark(int argc OVS_UNUSED, char *argv[])
2025 {
2026     size_t max_payload = 65535 - sizeof(struct ofp_header);
2027     struct timeval start, end;
2028     unsigned int payload_size, message_size;
2029     struct vconn *vconn;
2030     double duration;
2031     int count;
2032     int i;
2033
2034     payload_size = atoi(argv[2]);
2035     if (payload_size > max_payload) {
2036         ovs_fatal(0, "payload must be between 0 and %"PRIuSIZE" bytes", max_payload);
2037     }
2038     message_size = sizeof(struct ofp_header) + payload_size;
2039
2040     count = atoi(argv[3]);
2041
2042     printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
2043            count, message_size, count * message_size);
2044
2045     open_vconn(argv[1], &vconn);
2046     xgettimeofday(&start);
2047     for (i = 0; i < count; i++) {
2048         struct ofpbuf *request, *reply;
2049
2050         request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST,
2051                                vconn_get_version(vconn), payload_size);
2052         ofpbuf_put_zeros(request, payload_size);
2053         run(vconn_transact(vconn, request, &reply), "transact");
2054         ofpbuf_delete(reply);
2055     }
2056     xgettimeofday(&end);
2057     vconn_close(vconn);
2058
2059     duration = ((1000*(double)(end.tv_sec - start.tv_sec))
2060                 + (.001*(end.tv_usec - start.tv_usec)));
2061     printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
2062            duration, count / (duration / 1000.0),
2063            count * message_size / (duration / 1000.0));
2064 }
2065
2066 static void
2067 ofctl_group_mod__(const char *remote, struct ofputil_group_mod *gms,
2068                  size_t n_gms)
2069 {
2070     struct ofputil_group_mod *gm;
2071     struct ofpbuf *request;
2072
2073     struct vconn *vconn;
2074     size_t i;
2075
2076     open_vconn(remote, &vconn);
2077
2078     for (i = 0; i < n_gms; i++) {
2079         gm = &gms[i];
2080         request = ofputil_encode_group_mod(vconn_get_version(vconn), gm);
2081         if (request) {
2082             transact_noreply(vconn, request);
2083         }
2084     }
2085
2086     vconn_close(vconn);
2087
2088 }
2089
2090
2091 static void
2092 ofctl_group_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
2093 {
2094     struct ofputil_group_mod *gms = NULL;
2095     enum ofputil_protocol usable_protocols;
2096     size_t n_gms = 0;
2097     char *error;
2098
2099     error = parse_ofp_group_mod_file(argv[2], command, &gms, &n_gms,
2100                                      &usable_protocols);
2101     if (error) {
2102         ovs_fatal(0, "%s", error);
2103     }
2104     ofctl_group_mod__(argv[1], gms, n_gms);
2105     free(gms);
2106 }
2107
2108 static void
2109 ofctl_group_mod(int argc, char *argv[], uint16_t command)
2110 {
2111     if (argc > 2 && !strcmp(argv[2], "-")) {
2112         ofctl_group_mod_file(argc, argv, command);
2113     } else {
2114         enum ofputil_protocol usable_protocols;
2115         struct ofputil_group_mod gm;
2116         char *error;
2117
2118         error = parse_ofp_group_mod_str(&gm, command, argc > 2 ? argv[2] : "",
2119                                         &usable_protocols);
2120         if (error) {
2121             ovs_fatal(0, "%s", error);
2122         }
2123         ofctl_group_mod__(argv[1], &gm, 1);
2124     }
2125 }
2126
2127 static void
2128 ofctl_add_group(int argc, char *argv[])
2129 {
2130     ofctl_group_mod(argc, argv, OFPGC11_ADD);
2131 }
2132
2133 static void
2134 ofctl_add_groups(int argc, char *argv[])
2135 {
2136     ofctl_group_mod_file(argc, argv, OFPGC11_ADD);
2137 }
2138
2139 static void
2140 ofctl_mod_group(int argc, char *argv[])
2141 {
2142     ofctl_group_mod(argc, argv, OFPGC11_MODIFY);
2143 }
2144
2145 static void
2146 ofctl_del_groups(int argc, char *argv[])
2147 {
2148     ofctl_group_mod(argc, argv, OFPGC11_DELETE);
2149 }
2150
2151 static void
2152 ofctl_dump_group_stats(int argc, char *argv[])
2153 {
2154     enum ofputil_protocol usable_protocols;
2155     struct ofputil_group_mod gm;
2156     struct ofpbuf *request;
2157     struct vconn *vconn;
2158     uint32_t group_id;
2159     char *error;
2160
2161     memset(&gm, 0, sizeof gm);
2162
2163     error = parse_ofp_group_mod_str(&gm, OFPGC11_DELETE,
2164                                     argc > 2 ? argv[2] : "",
2165                                     &usable_protocols);
2166     if (error) {
2167         ovs_fatal(0, "%s", error);
2168     }
2169
2170     group_id = gm.group_id;
2171
2172     open_vconn(argv[1], &vconn);
2173     request = ofputil_encode_group_stats_request(vconn_get_version(vconn),
2174                                                  group_id);
2175     if (request) {
2176         dump_stats_transaction(vconn, request);
2177     }
2178
2179     vconn_close(vconn);
2180 }
2181
2182 static void
2183 ofctl_dump_group_desc(int argc OVS_UNUSED, char *argv[])
2184 {
2185     struct ofpbuf *request;
2186     struct vconn *vconn;
2187     uint32_t group_id;
2188
2189     open_vconn(argv[1], &vconn);
2190
2191     if (argc < 3 || !ofputil_group_from_string(argv[2], &group_id)) {
2192         group_id = OFPG11_ALL;
2193     }
2194
2195     request = ofputil_encode_group_desc_request(vconn_get_version(vconn),
2196                                                 group_id);
2197     if (request) {
2198         dump_stats_transaction(vconn, request);
2199     }
2200
2201     vconn_close(vconn);
2202 }
2203
2204 static void
2205 ofctl_dump_group_features(int argc OVS_UNUSED, char *argv[])
2206 {
2207     struct ofpbuf *request;
2208     struct vconn *vconn;
2209
2210     open_vconn(argv[1], &vconn);
2211     request = ofputil_encode_group_features_request(vconn_get_version(vconn));
2212     if (request) {
2213         dump_stats_transaction(vconn, request);
2214     }
2215
2216     vconn_close(vconn);
2217 }
2218
2219 static void
2220 ofctl_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2221 {
2222     usage();
2223 }
2224 \f
2225 /* replace-flows and diff-flows commands. */
2226
2227 /* A flow table entry, possibly with two different versions. */
2228 struct fte {
2229     struct cls_rule rule;       /* Within a "struct classifier". */
2230     struct fte_version *versions[2];
2231 };
2232
2233 /* One version of a Flow Table Entry. */
2234 struct fte_version {
2235     ovs_be64 cookie;
2236     uint16_t idle_timeout;
2237     uint16_t hard_timeout;
2238     uint16_t flags;
2239     struct ofpact *ofpacts;
2240     size_t ofpacts_len;
2241 };
2242
2243 /* Frees 'version' and the data that it owns. */
2244 static void
2245 fte_version_free(struct fte_version *version)
2246 {
2247     if (version) {
2248         free(CONST_CAST(struct ofpact *, version->ofpacts));
2249         free(version);
2250     }
2251 }
2252
2253 /* Returns true if 'a' and 'b' are the same, false if they differ.
2254  *
2255  * Ignores differences in 'flags' because there's no way to retrieve flags from
2256  * an OpenFlow switch.  We have to assume that they are the same. */
2257 static bool
2258 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
2259 {
2260     return (a->cookie == b->cookie
2261             && a->idle_timeout == b->idle_timeout
2262             && a->hard_timeout == b->hard_timeout
2263             && ofpacts_equal(a->ofpacts, a->ofpacts_len,
2264                              b->ofpacts, b->ofpacts_len));
2265 }
2266
2267 /* Clears 's', then if 's' has a version 'index', formats 'fte' and version
2268  * 'index' into 's', followed by a new-line. */
2269 static void
2270 fte_version_format(const struct fte *fte, int index, struct ds *s)
2271 {
2272     const struct fte_version *version = fte->versions[index];
2273
2274     ds_clear(s);
2275     if (!version) {
2276         return;
2277     }
2278
2279     cls_rule_format(&fte->rule, s);
2280     if (version->cookie != htonll(0)) {
2281         ds_put_format(s, " cookie=0x%"PRIx64, ntohll(version->cookie));
2282     }
2283     if (version->idle_timeout != OFP_FLOW_PERMANENT) {
2284         ds_put_format(s, " idle_timeout=%"PRIu16, version->idle_timeout);
2285     }
2286     if (version->hard_timeout != OFP_FLOW_PERMANENT) {
2287         ds_put_format(s, " hard_timeout=%"PRIu16, version->hard_timeout);
2288     }
2289
2290     ds_put_cstr(s, " actions=");
2291     ofpacts_format(version->ofpacts, version->ofpacts_len, s);
2292
2293     ds_put_char(s, '\n');
2294 }
2295
2296 static struct fte *
2297 fte_from_cls_rule(const struct cls_rule *cls_rule)
2298 {
2299     return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
2300 }
2301
2302 /* Frees 'fte' and its versions. */
2303 static void
2304 fte_free(struct fte *fte)
2305 {
2306     if (fte) {
2307         fte_version_free(fte->versions[0]);
2308         fte_version_free(fte->versions[1]);
2309         cls_rule_destroy(&fte->rule);
2310         free(fte);
2311     }
2312 }
2313
2314 /* Frees all of the FTEs within 'cls'. */
2315 static void
2316 fte_free_all(struct classifier *cls)
2317 {
2318     struct cls_cursor cursor;
2319     struct fte *fte, *next;
2320
2321     fat_rwlock_wrlock(&cls->rwlock);
2322     cls_cursor_init(&cursor, cls, NULL);
2323     CLS_CURSOR_FOR_EACH_SAFE (fte, next, rule, &cursor) {
2324         classifier_remove(cls, &fte->rule);
2325         fte_free(fte);
2326     }
2327     fat_rwlock_unlock(&cls->rwlock);
2328     classifier_destroy(cls);
2329 }
2330
2331 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
2332  * necessary.  Sets 'version' as the version of that rule with the given
2333  * 'index', replacing any existing version, if any.
2334  *
2335  * Takes ownership of 'version'. */
2336 static void
2337 fte_insert(struct classifier *cls, const struct match *match,
2338            unsigned int priority, struct fte_version *version, int index)
2339 {
2340     struct fte *old, *fte;
2341
2342     fte = xzalloc(sizeof *fte);
2343     cls_rule_init(&fte->rule, match, priority);
2344     fte->versions[index] = version;
2345
2346     fat_rwlock_wrlock(&cls->rwlock);
2347     old = fte_from_cls_rule(classifier_replace(cls, &fte->rule));
2348     fat_rwlock_unlock(&cls->rwlock);
2349     if (old) {
2350         fte_version_free(old->versions[index]);
2351         fte->versions[!index] = old->versions[!index];
2352         cls_rule_destroy(&old->rule);
2353         free(old);
2354     }
2355 }
2356
2357 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
2358  * with the specified 'index'.  Returns the flow formats able to represent the
2359  * flows that were read. */
2360 static enum ofputil_protocol
2361 read_flows_from_file(const char *filename, struct classifier *cls, int index)
2362 {
2363     enum ofputil_protocol usable_protocols;
2364     int line_number;
2365     struct ds s;
2366     FILE *file;
2367
2368     file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
2369     if (file == NULL) {
2370         ovs_fatal(errno, "%s: open", filename);
2371     }
2372
2373     ds_init(&s);
2374     usable_protocols = OFPUTIL_P_ANY;
2375     line_number = 0;
2376     while (!ds_get_preprocessed_line(&s, file, &line_number)) {
2377         struct fte_version *version;
2378         struct ofputil_flow_mod fm;
2379         char *error;
2380         enum ofputil_protocol usable;
2381
2382         error = parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), &usable);
2383         if (error) {
2384             ovs_fatal(0, "%s:%d: %s", filename, line_number, error);
2385         }
2386         usable_protocols &= usable;
2387
2388         version = xmalloc(sizeof *version);
2389         version->cookie = fm.new_cookie;
2390         version->idle_timeout = fm.idle_timeout;
2391         version->hard_timeout = fm.hard_timeout;
2392         version->flags = fm.flags & (OFPUTIL_FF_SEND_FLOW_REM
2393                                      | OFPUTIL_FF_EMERG);
2394         version->ofpacts = fm.ofpacts;
2395         version->ofpacts_len = fm.ofpacts_len;
2396
2397         fte_insert(cls, &fm.match, fm.priority, version, index);
2398     }
2399     ds_destroy(&s);
2400
2401     if (file != stdin) {
2402         fclose(file);
2403     }
2404
2405     return usable_protocols;
2406 }
2407
2408 static bool
2409 recv_flow_stats_reply(struct vconn *vconn, ovs_be32 send_xid,
2410                       struct ofpbuf **replyp,
2411                       struct ofputil_flow_stats *fs, struct ofpbuf *ofpacts)
2412 {
2413     struct ofpbuf *reply = *replyp;
2414
2415     for (;;) {
2416         int retval;
2417         bool more;
2418
2419         /* Get a flow stats reply message, if we don't already have one. */
2420         if (!reply) {
2421             enum ofptype type;
2422             enum ofperr error;
2423
2424             do {
2425                 run(vconn_recv_block(vconn, &reply),
2426                     "OpenFlow packet receive failed");
2427             } while (((struct ofp_header *) ofpbuf_data(reply))->xid != send_xid);
2428
2429             error = ofptype_decode(&type, ofpbuf_data(reply));
2430             if (error || type != OFPTYPE_FLOW_STATS_REPLY) {
2431                 ovs_fatal(0, "received bad reply: %s",
2432                           ofp_to_string(ofpbuf_data(reply), ofpbuf_size(reply),
2433                                         verbosity + 1));
2434             }
2435         }
2436
2437         /* Pull an individual flow stats reply out of the message. */
2438         retval = ofputil_decode_flow_stats_reply(fs, reply, false, ofpacts);
2439         switch (retval) {
2440         case 0:
2441             *replyp = reply;
2442             return true;
2443
2444         case EOF:
2445             more = ofpmp_more(reply->frame);
2446             ofpbuf_delete(reply);
2447             reply = NULL;
2448             if (!more) {
2449                 *replyp = NULL;
2450                 return false;
2451             }
2452             break;
2453
2454         default:
2455             ovs_fatal(0, "parse error in reply (%s)",
2456                       ofperr_to_string(retval));
2457         }
2458     }
2459 }
2460
2461 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
2462  * format 'protocol', and adds them as flow table entries in 'cls' for the
2463  * version with the specified 'index'. */
2464 static void
2465 read_flows_from_switch(struct vconn *vconn,
2466                        enum ofputil_protocol protocol,
2467                        struct classifier *cls, int index)
2468 {
2469     struct ofputil_flow_stats_request fsr;
2470     struct ofputil_flow_stats fs;
2471     struct ofpbuf *request;
2472     struct ofpbuf ofpacts;
2473     struct ofpbuf *reply;
2474     ovs_be32 send_xid;
2475
2476     fsr.aggregate = false;
2477     match_init_catchall(&fsr.match);
2478     fsr.out_port = OFPP_ANY;
2479     fsr.table_id = 0xff;
2480     fsr.cookie = fsr.cookie_mask = htonll(0);
2481     request = ofputil_encode_flow_stats_request(&fsr, protocol);
2482     send_xid = ((struct ofp_header *) ofpbuf_data(request))->xid;
2483     send_openflow_buffer(vconn, request);
2484
2485     reply = NULL;
2486     ofpbuf_init(&ofpacts, 0);
2487     while (recv_flow_stats_reply(vconn, send_xid, &reply, &fs, &ofpacts)) {
2488         struct fte_version *version;
2489
2490         version = xmalloc(sizeof *version);
2491         version->cookie = fs.cookie;
2492         version->idle_timeout = fs.idle_timeout;
2493         version->hard_timeout = fs.hard_timeout;
2494         version->flags = 0;
2495         version->ofpacts_len = fs.ofpacts_len;
2496         version->ofpacts = xmemdup(fs.ofpacts, fs.ofpacts_len);
2497
2498         fte_insert(cls, &fs.match, fs.priority, version, index);
2499     }
2500     ofpbuf_uninit(&ofpacts);
2501 }
2502
2503 static void
2504 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
2505                   enum ofputil_protocol protocol, struct list *packets)
2506 {
2507     const struct fte_version *version = fte->versions[index];
2508     struct ofputil_flow_mod fm;
2509     struct ofpbuf *ofm;
2510
2511     minimatch_expand(&fte->rule.match, &fm.match);
2512     fm.priority = fte->rule.priority;
2513     fm.cookie = htonll(0);
2514     fm.cookie_mask = htonll(0);
2515     fm.new_cookie = version->cookie;
2516     fm.modify_cookie = true;
2517     fm.table_id = 0xff;
2518     fm.command = command;
2519     fm.idle_timeout = version->idle_timeout;
2520     fm.hard_timeout = version->hard_timeout;
2521     fm.buffer_id = UINT32_MAX;
2522     fm.out_port = OFPP_ANY;
2523     fm.flags = version->flags;
2524     if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
2525         command == OFPFC_MODIFY_STRICT) {
2526         fm.ofpacts = version->ofpacts;
2527         fm.ofpacts_len = version->ofpacts_len;
2528     } else {
2529         fm.ofpacts = NULL;
2530         fm.ofpacts_len = 0;
2531     }
2532
2533     ofm = ofputil_encode_flow_mod(&fm, protocol);
2534     list_push_back(packets, &ofm->list_node);
2535 }
2536
2537 static void
2538 ofctl_replace_flows(int argc OVS_UNUSED, char *argv[])
2539 {
2540     enum { FILE_IDX = 0, SWITCH_IDX = 1 };
2541     enum ofputil_protocol usable_protocols, protocol;
2542     struct cls_cursor cursor;
2543     struct classifier cls;
2544     struct list requests;
2545     struct vconn *vconn;
2546     struct fte *fte;
2547
2548     classifier_init(&cls, NULL);
2549     usable_protocols = read_flows_from_file(argv[2], &cls, FILE_IDX);
2550
2551     protocol = open_vconn(argv[1], &vconn);
2552     protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
2553
2554     read_flows_from_switch(vconn, protocol, &cls, SWITCH_IDX);
2555
2556     list_init(&requests);
2557
2558     /* Delete flows that exist on the switch but not in the file. */
2559     fat_rwlock_rdlock(&cls.rwlock);
2560     cls_cursor_init(&cursor, &cls, NULL);
2561     CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2562         struct fte_version *file_ver = fte->versions[FILE_IDX];
2563         struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2564
2565         if (sw_ver && !file_ver) {
2566             fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
2567                               protocol, &requests);
2568         }
2569     }
2570
2571     /* Add flows that exist in the file but not on the switch.
2572      * Update flows that exist in both places but differ. */
2573     cls_cursor_init(&cursor, &cls, NULL);
2574     CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2575         struct fte_version *file_ver = fte->versions[FILE_IDX];
2576         struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2577
2578         if (file_ver
2579             && (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
2580             fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, protocol, &requests);
2581         }
2582     }
2583     fat_rwlock_unlock(&cls.rwlock);
2584     transact_multiple_noreply(vconn, &requests);
2585     vconn_close(vconn);
2586
2587     fte_free_all(&cls);
2588 }
2589
2590 static void
2591 read_flows_from_source(const char *source, struct classifier *cls, int index)
2592 {
2593     struct stat s;
2594
2595     if (source[0] == '/' || source[0] == '.'
2596         || (!strchr(source, ':') && !stat(source, &s))) {
2597         read_flows_from_file(source, cls, index);
2598     } else {
2599         enum ofputil_protocol protocol;
2600         struct vconn *vconn;
2601
2602         protocol = open_vconn(source, &vconn);
2603         protocol = set_protocol_for_flow_dump(vconn, protocol, OFPUTIL_P_ANY);
2604         read_flows_from_switch(vconn, protocol, cls, index);
2605         vconn_close(vconn);
2606     }
2607 }
2608
2609 static void
2610 ofctl_diff_flows(int argc OVS_UNUSED, char *argv[])
2611 {
2612     bool differences = false;
2613     struct cls_cursor cursor;
2614     struct classifier cls;
2615     struct ds a_s, b_s;
2616     struct fte *fte;
2617
2618     classifier_init(&cls, NULL);
2619     read_flows_from_source(argv[1], &cls, 0);
2620     read_flows_from_source(argv[2], &cls, 1);
2621
2622     ds_init(&a_s);
2623     ds_init(&b_s);
2624
2625     fat_rwlock_rdlock(&cls.rwlock);
2626     cls_cursor_init(&cursor, &cls, NULL);
2627     CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2628         struct fte_version *a = fte->versions[0];
2629         struct fte_version *b = fte->versions[1];
2630
2631         if (!a || !b || !fte_version_equals(a, b)) {
2632             fte_version_format(fte, 0, &a_s);
2633             fte_version_format(fte, 1, &b_s);
2634             if (strcmp(ds_cstr(&a_s), ds_cstr(&b_s))) {
2635                 if (a_s.length) {
2636                     printf("-%s", ds_cstr(&a_s));
2637                 }
2638                 if (b_s.length) {
2639                     printf("+%s", ds_cstr(&b_s));
2640                 }
2641                 differences = true;
2642             }
2643         }
2644     }
2645     fat_rwlock_unlock(&cls.rwlock);
2646
2647     ds_destroy(&a_s);
2648     ds_destroy(&b_s);
2649
2650     fte_free_all(&cls);
2651
2652     if (differences) {
2653         exit(2);
2654     }
2655 }
2656
2657 static void
2658 ofctl_meter_mod__(const char *bridge, const char *str, int command)
2659 {
2660     struct ofputil_meter_mod mm;
2661     struct vconn *vconn;
2662     enum ofputil_protocol protocol;
2663     enum ofputil_protocol usable_protocols;
2664     enum ofp_version version;
2665
2666     if (str) {
2667         char *error;
2668         error = parse_ofp_meter_mod_str(&mm, str, command, &usable_protocols);
2669         if (error) {
2670             ovs_fatal(0, "%s", error);
2671         }
2672     } else {
2673         usable_protocols = OFPUTIL_P_OF13_UP;
2674         mm.command = command;
2675         mm.meter.meter_id = OFPM13_ALL;
2676     }
2677
2678     protocol = open_vconn_for_flow_mod(bridge, &vconn, usable_protocols);
2679     version = ofputil_protocol_to_ofp_version(protocol);
2680     transact_noreply(vconn, ofputil_encode_meter_mod(version, &mm));
2681     vconn_close(vconn);
2682 }
2683
2684 static void
2685 ofctl_meter_request__(const char *bridge, const char *str,
2686                       enum ofputil_meter_request_type type)
2687 {
2688     struct ofputil_meter_mod mm;
2689     struct vconn *vconn;
2690     enum ofputil_protocol usable_protocols;
2691     enum ofputil_protocol protocol;
2692     enum ofp_version version;
2693
2694     if (str) {
2695         char *error;
2696         error = parse_ofp_meter_mod_str(&mm, str, -1, &usable_protocols);
2697         if (error) {
2698             ovs_fatal(0, "%s", error);
2699         }
2700     } else {
2701         usable_protocols = OFPUTIL_P_OF13_UP;
2702         mm.meter.meter_id = OFPM13_ALL;
2703     }
2704
2705     protocol = open_vconn_for_flow_mod(bridge, &vconn, usable_protocols);
2706     version = ofputil_protocol_to_ofp_version(protocol);
2707     transact_noreply(vconn, ofputil_encode_meter_request(version,
2708                                                          type,
2709                                                          mm.meter.meter_id));
2710     vconn_close(vconn);
2711 }
2712
2713
2714 static void
2715 ofctl_add_meter(int argc OVS_UNUSED, char *argv[])
2716 {
2717     ofctl_meter_mod__(argv[1], argv[2], OFPMC13_ADD);
2718 }
2719
2720 static void
2721 ofctl_mod_meter(int argc OVS_UNUSED, char *argv[])
2722 {
2723     ofctl_meter_mod__(argv[1], argv[2], OFPMC13_MODIFY);
2724 }
2725
2726 static void
2727 ofctl_del_meters(int argc, char *argv[])
2728 {
2729     ofctl_meter_mod__(argv[1], argc > 2 ? argv[2] : NULL, OFPMC13_DELETE);
2730 }
2731
2732 static void
2733 ofctl_dump_meters(int argc, char *argv[])
2734 {
2735     ofctl_meter_request__(argv[1], argc > 2 ? argv[2] : NULL,
2736                           OFPUTIL_METER_CONFIG);
2737 }
2738
2739 static void
2740 ofctl_meter_stats(int argc, char *argv[])
2741 {
2742     ofctl_meter_request__(argv[1], argc > 2 ? argv[2] : NULL,
2743                           OFPUTIL_METER_STATS);
2744 }
2745
2746 static void
2747 ofctl_meter_features(int argc OVS_UNUSED, char *argv[])
2748 {
2749     ofctl_meter_request__(argv[1], NULL, OFPUTIL_METER_FEATURES);
2750 }
2751
2752 \f
2753 /* Undocumented commands for unit testing. */
2754
2755 static void
2756 ofctl_parse_flows__(struct ofputil_flow_mod *fms, size_t n_fms,
2757                     enum ofputil_protocol usable_protocols)
2758 {
2759     enum ofputil_protocol protocol = 0;
2760     char *usable_s;
2761     size_t i;
2762
2763     usable_s = ofputil_protocols_to_string(usable_protocols);
2764     printf("usable protocols: %s\n", usable_s);
2765     free(usable_s);
2766
2767     if (!(usable_protocols & allowed_protocols)) {
2768         ovs_fatal(0, "no usable protocol");
2769     }
2770     for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
2771         protocol = 1 << i;
2772         if (protocol & usable_protocols & allowed_protocols) {
2773             break;
2774         }
2775     }
2776     ovs_assert(is_pow2(protocol));
2777
2778     printf("chosen protocol: %s\n", ofputil_protocol_to_string(protocol));
2779
2780     for (i = 0; i < n_fms; i++) {
2781         struct ofputil_flow_mod *fm = &fms[i];
2782         struct ofpbuf *msg;
2783
2784         msg = ofputil_encode_flow_mod(fm, protocol);
2785         ofp_print(stdout, ofpbuf_data(msg), ofpbuf_size(msg), verbosity);
2786         ofpbuf_delete(msg);
2787
2788         free(CONST_CAST(struct ofpact *, fm->ofpacts));
2789     }
2790 }
2791
2792 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
2793  * it back to stdout.  */
2794 static void
2795 ofctl_parse_flow(int argc OVS_UNUSED, char *argv[])
2796 {
2797     enum ofputil_protocol usable_protocols;
2798     struct ofputil_flow_mod fm;
2799     char *error;
2800
2801     error = parse_ofp_flow_mod_str(&fm, argv[1], OFPFC_ADD, &usable_protocols);
2802     if (error) {
2803         ovs_fatal(0, "%s", error);
2804     }
2805     ofctl_parse_flows__(&fm, 1, usable_protocols);
2806 }
2807
2808 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
2809  * add-flows) and prints each of the flows back to stdout.  */
2810 static void
2811 ofctl_parse_flows(int argc OVS_UNUSED, char *argv[])
2812 {
2813     enum ofputil_protocol usable_protocols;
2814     struct ofputil_flow_mod *fms = NULL;
2815     size_t n_fms = 0;
2816     char *error;
2817
2818     error = parse_ofp_flow_mod_file(argv[1], OFPFC_ADD, &fms, &n_fms,
2819                                     &usable_protocols);
2820     if (error) {
2821         ovs_fatal(0, "%s", error);
2822     }
2823     ofctl_parse_flows__(fms, n_fms, usable_protocols);
2824     free(fms);
2825 }
2826
2827 static void
2828 ofctl_parse_nxm__(bool oxm, enum ofp_version version)
2829 {
2830     struct ds in;
2831
2832     ds_init(&in);
2833     while (!ds_get_test_line(&in, stdin)) {
2834         struct ofpbuf nx_match;
2835         struct match match;
2836         ovs_be64 cookie, cookie_mask;
2837         enum ofperr error;
2838         int match_len;
2839
2840         /* Convert string to nx_match. */
2841         ofpbuf_init(&nx_match, 0);
2842         if (oxm) {
2843             match_len = oxm_match_from_string(ds_cstr(&in), &nx_match);
2844         } else {
2845             match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
2846         }
2847
2848         /* Convert nx_match to match. */
2849         if (strict) {
2850             if (oxm) {
2851                 error = oxm_pull_match(&nx_match, &match);
2852             } else {
2853                 error = nx_pull_match(&nx_match, match_len, &match,
2854                                       &cookie, &cookie_mask);
2855             }
2856         } else {
2857             if (oxm) {
2858                 error = oxm_pull_match_loose(&nx_match, &match);
2859             } else {
2860                 error = nx_pull_match_loose(&nx_match, match_len, &match,
2861                                             &cookie, &cookie_mask);
2862             }
2863         }
2864
2865
2866         if (!error) {
2867             char *out;
2868
2869             /* Convert match back to nx_match. */
2870             ofpbuf_uninit(&nx_match);
2871             ofpbuf_init(&nx_match, 0);
2872             if (oxm) {
2873                 match_len = oxm_put_match(&nx_match, &match, version);
2874                 out = oxm_match_to_string(&nx_match, match_len);
2875             } else {
2876                 match_len = nx_put_match(&nx_match, &match,
2877                                          cookie, cookie_mask);
2878                 out = nx_match_to_string(ofpbuf_data(&nx_match), match_len);
2879             }
2880
2881             puts(out);
2882             free(out);
2883         } else {
2884             printf("nx_pull_match() returned error %s\n",
2885                    ofperr_get_name(error));
2886         }
2887
2888         ofpbuf_uninit(&nx_match);
2889     }
2890     ds_destroy(&in);
2891 }
2892
2893 /* "parse-nxm": reads a series of NXM nx_match specifications as strings from
2894  * stdin, does some internal fussing with them, and then prints them back as
2895  * strings on stdout. */
2896 static void
2897 ofctl_parse_nxm(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2898 {
2899     return ofctl_parse_nxm__(false, 0);
2900 }
2901
2902 /* "parse-oxm VERSION": reads a series of OXM nx_match specifications as
2903  * strings from stdin, does some internal fussing with them, and then prints
2904  * them back as strings on stdout.  VERSION must specify an OpenFlow version,
2905  * e.g. "OpenFlow12". */
2906 static void
2907 ofctl_parse_oxm(int argc OVS_UNUSED, char *argv[])
2908 {
2909     enum ofp_version version = ofputil_version_from_string(argv[1]);
2910     if (version < OFP12_VERSION) {
2911         ovs_fatal(0, "%s: not a valid version for OXM", argv[1]);
2912     }
2913
2914     return ofctl_parse_nxm__(true, version);
2915 }
2916
2917 static void
2918 print_differences(const char *prefix,
2919                   const void *a_, size_t a_len,
2920                   const void *b_, size_t b_len)
2921 {
2922     const uint8_t *a = a_;
2923     const uint8_t *b = b_;
2924     size_t i;
2925
2926     for (i = 0; i < MIN(a_len, b_len); i++) {
2927         if (a[i] != b[i]) {
2928             printf("%s%2"PRIuSIZE": %02"PRIx8" -> %02"PRIx8"\n",
2929                    prefix, i, a[i], b[i]);
2930         }
2931     }
2932     for (i = a_len; i < b_len; i++) {
2933         printf("%s%2"PRIuSIZE": (none) -> %02"PRIx8"\n", prefix, i, b[i]);
2934     }
2935     for (i = b_len; i < a_len; i++) {
2936         printf("%s%2"PRIuSIZE": %02"PRIx8" -> (none)\n", prefix, i, a[i]);
2937     }
2938 }
2939
2940 /* "parse-ofp10-actions": reads a series of OpenFlow 1.0 action specifications
2941  * as hex bytes from stdin, converts them to ofpacts, prints them as strings
2942  * on stdout, and then converts them back to hex bytes and prints any
2943  * differences from the input. */
2944 static void
2945 ofctl_parse_ofp10_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2946 {
2947     struct ds in;
2948
2949     ds_init(&in);
2950     while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
2951         struct ofpbuf of10_out;
2952         struct ofpbuf of10_in;
2953         struct ofpbuf ofpacts;
2954         enum ofperr error;
2955         size_t size;
2956         struct ds s;
2957
2958         /* Parse hex bytes. */
2959         ofpbuf_init(&of10_in, 0);
2960         if (ofpbuf_put_hex(&of10_in, ds_cstr(&in), NULL)[0] != '\0') {
2961             ovs_fatal(0, "Trailing garbage in hex data");
2962         }
2963
2964         /* Convert to ofpacts. */
2965         ofpbuf_init(&ofpacts, 0);
2966         size = ofpbuf_size(&of10_in);
2967         error = ofpacts_pull_openflow_actions(&of10_in, ofpbuf_size(&of10_in),
2968                                               OFP10_VERSION, &ofpacts);
2969         if (error) {
2970             printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error));
2971             ofpbuf_uninit(&ofpacts);
2972             ofpbuf_uninit(&of10_in);
2973             continue;
2974         }
2975         ofpbuf_push_uninit(&of10_in, size);
2976
2977         /* Print cls_rule. */
2978         ds_init(&s);
2979         ds_put_cstr(&s, "actions=");
2980         ofpacts_format(ofpbuf_data(&ofpacts), ofpbuf_size(&ofpacts), &s);
2981         puts(ds_cstr(&s));
2982         ds_destroy(&s);
2983
2984         /* Convert back to ofp10 actions and print differences from input. */
2985         ofpbuf_init(&of10_out, 0);
2986         ofpacts_put_openflow_actions(ofpbuf_data(&ofpacts), ofpbuf_size(&ofpacts), &of10_out,
2987                                      OFP10_VERSION);
2988
2989         print_differences("", ofpbuf_data(&of10_in), ofpbuf_size(&of10_in),
2990                           ofpbuf_data(&of10_out), ofpbuf_size(&of10_out));
2991         putchar('\n');
2992
2993         ofpbuf_uninit(&ofpacts);
2994         ofpbuf_uninit(&of10_in);
2995         ofpbuf_uninit(&of10_out);
2996     }
2997     ds_destroy(&in);
2998 }
2999
3000 /* "parse-ofp10-match": reads a series of ofp10_match specifications as hex
3001  * bytes from stdin, converts them to cls_rules, prints them as strings on
3002  * stdout, and then converts them back to hex bytes and prints any differences
3003  * from the input.
3004  *
3005  * The input hex bytes may contain "x"s to represent "don't-cares", bytes whose
3006  * values are ignored in the input and will be set to zero when OVS converts
3007  * them back to hex bytes.  ovs-ofctl actually sets "x"s to random bits when
3008  * it does the conversion to hex, to ensure that in fact they are ignored. */
3009 static void
3010 ofctl_parse_ofp10_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
3011 {
3012     struct ds expout;
3013     struct ds in;
3014
3015     ds_init(&in);
3016     ds_init(&expout);
3017     while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3018         struct ofpbuf match_in, match_expout;
3019         struct ofp10_match match_out;
3020         struct ofp10_match match_normal;
3021         struct match match;
3022         char *p;
3023
3024         /* Parse hex bytes to use for expected output. */
3025         ds_clear(&expout);
3026         ds_put_cstr(&expout, ds_cstr(&in));
3027         for (p = ds_cstr(&expout); *p; p++) {
3028             if (*p == 'x') {
3029                 *p = '0';
3030             }
3031         }
3032         ofpbuf_init(&match_expout, 0);
3033         if (ofpbuf_put_hex(&match_expout, ds_cstr(&expout), NULL)[0] != '\0') {
3034             ovs_fatal(0, "Trailing garbage in hex data");
3035         }
3036         if (ofpbuf_size(&match_expout) != sizeof(struct ofp10_match)) {
3037             ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3038                       ofpbuf_size(&match_expout), sizeof(struct ofp10_match));
3039         }
3040
3041         /* Parse hex bytes for input. */
3042         for (p = ds_cstr(&in); *p; p++) {
3043             if (*p == 'x') {
3044                 *p = "0123456789abcdef"[random_uint32() & 0xf];
3045             }
3046         }
3047         ofpbuf_init(&match_in, 0);
3048         if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
3049             ovs_fatal(0, "Trailing garbage in hex data");
3050         }
3051         if (ofpbuf_size(&match_in) != sizeof(struct ofp10_match)) {
3052             ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3053                       ofpbuf_size(&match_in), sizeof(struct ofp10_match));
3054         }
3055
3056         /* Convert to cls_rule and print. */
3057         ofputil_match_from_ofp10_match(ofpbuf_data(&match_in), &match);
3058         match_print(&match);
3059
3060         /* Convert back to ofp10_match and print differences from input. */
3061         ofputil_match_to_ofp10_match(&match, &match_out);
3062         print_differences("", ofpbuf_data(&match_expout), ofpbuf_size(&match_expout),
3063                           &match_out, sizeof match_out);
3064
3065         /* Normalize, then convert and compare again. */
3066         ofputil_normalize_match(&match);
3067         ofputil_match_to_ofp10_match(&match, &match_normal);
3068         print_differences("normal: ", &match_out, sizeof match_out,
3069                           &match_normal, sizeof match_normal);
3070         putchar('\n');
3071
3072         ofpbuf_uninit(&match_in);
3073         ofpbuf_uninit(&match_expout);
3074     }
3075     ds_destroy(&in);
3076     ds_destroy(&expout);
3077 }
3078
3079 /* "parse-ofp11-match": reads a series of ofp11_match specifications as hex
3080  * bytes from stdin, converts them to "struct match"es, prints them as strings
3081  * on stdout, and then converts them back to hex bytes and prints any
3082  * differences from the input. */
3083 static void
3084 ofctl_parse_ofp11_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
3085 {
3086     struct ds in;
3087
3088     ds_init(&in);
3089     while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3090         struct ofpbuf match_in;
3091         struct ofp11_match match_out;
3092         struct match match;
3093         enum ofperr error;
3094
3095         /* Parse hex bytes. */
3096         ofpbuf_init(&match_in, 0);
3097         if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
3098             ovs_fatal(0, "Trailing garbage in hex data");
3099         }
3100         if (ofpbuf_size(&match_in) != sizeof(struct ofp11_match)) {
3101             ovs_fatal(0, "Input is %"PRIu32" bytes, expected %"PRIuSIZE,
3102                       ofpbuf_size(&match_in), sizeof(struct ofp11_match));
3103         }
3104
3105         /* Convert to match. */
3106         error = ofputil_match_from_ofp11_match(ofpbuf_data(&match_in), &match);
3107         if (error) {
3108             printf("bad ofp11_match: %s\n\n", ofperr_get_name(error));
3109             ofpbuf_uninit(&match_in);
3110             continue;
3111         }
3112
3113         /* Print match. */
3114         match_print(&match);
3115
3116         /* Convert back to ofp11_match and print differences from input. */
3117         ofputil_match_to_ofp11_match(&match, &match_out);
3118
3119         print_differences("", ofpbuf_data(&match_in), ofpbuf_size(&match_in),
3120                           &match_out, sizeof match_out);
3121         putchar('\n');
3122
3123         ofpbuf_uninit(&match_in);
3124     }
3125     ds_destroy(&in);
3126 }
3127
3128 /* "parse-ofp11-actions": reads a series of OpenFlow 1.1 action specifications
3129  * as hex bytes from stdin, converts them to ofpacts, prints them as strings
3130  * on stdout, and then converts them back to hex bytes and prints any
3131  * differences from the input. */
3132 static void
3133 ofctl_parse_ofp11_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
3134 {
3135     struct ds in;
3136
3137     ds_init(&in);
3138     while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3139         struct ofpbuf of11_out;
3140         struct ofpbuf of11_in;
3141         struct ofpbuf ofpacts;
3142         enum ofperr error;
3143         size_t size;
3144         struct ds s;
3145
3146         /* Parse hex bytes. */
3147         ofpbuf_init(&of11_in, 0);
3148         if (ofpbuf_put_hex(&of11_in, ds_cstr(&in), NULL)[0] != '\0') {
3149             ovs_fatal(0, "Trailing garbage in hex data");
3150         }
3151
3152         /* Convert to ofpacts. */
3153         ofpbuf_init(&ofpacts, 0);
3154         size = ofpbuf_size(&of11_in);
3155         error = ofpacts_pull_openflow_actions(&of11_in, ofpbuf_size(&of11_in),
3156                                               OFP11_VERSION, &ofpacts);
3157         if (error) {
3158             printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error));
3159             ofpbuf_uninit(&ofpacts);
3160             ofpbuf_uninit(&of11_in);
3161             continue;
3162         }
3163         ofpbuf_push_uninit(&of11_in, size);
3164
3165         /* Print cls_rule. */
3166         ds_init(&s);
3167         ds_put_cstr(&s, "actions=");
3168         ofpacts_format(ofpbuf_data(&ofpacts), ofpbuf_size(&ofpacts), &s);
3169         puts(ds_cstr(&s));
3170         ds_destroy(&s);
3171
3172         /* Convert back to ofp11 actions and print differences from input. */
3173         ofpbuf_init(&of11_out, 0);
3174         ofpacts_put_openflow_actions(ofpbuf_data(&ofpacts), ofpbuf_size(&ofpacts), &of11_out,
3175                                      OFP11_VERSION);
3176
3177         print_differences("", ofpbuf_data(&of11_in), ofpbuf_size(&of11_in),
3178                           ofpbuf_data(&of11_out), ofpbuf_size(&of11_out));
3179         putchar('\n');
3180
3181         ofpbuf_uninit(&ofpacts);
3182         ofpbuf_uninit(&of11_in);
3183         ofpbuf_uninit(&of11_out);
3184     }
3185     ds_destroy(&in);
3186 }
3187
3188 /* "parse-ofp11-instructions": reads a series of OpenFlow 1.1 instruction
3189  * specifications as hex bytes from stdin, converts them to ofpacts, prints
3190  * them as strings on stdout, and then converts them back to hex bytes and
3191  * prints any differences from the input. */
3192 static void
3193 ofctl_parse_ofp11_instructions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
3194 {
3195     struct ds in;
3196
3197     ds_init(&in);
3198     while (!ds_get_preprocessed_line(&in, stdin, NULL)) {
3199         struct ofpbuf of11_out;
3200         struct ofpbuf of11_in;
3201         struct ofpbuf ofpacts;
3202         enum ofperr error;
3203         size_t size;
3204         struct ds s;
3205         const char *table_id;
3206         char *instructions;
3207
3208         /* Parse table_id separated with the follow-up instructions by ",", if
3209          * any. */
3210         instructions = ds_cstr(&in);
3211         table_id = NULL;
3212         if (strstr(instructions, ",")) {
3213             table_id = strsep(&instructions, ",");
3214         }
3215
3216         /* Parse hex bytes. */
3217         ofpbuf_init(&of11_in, 0);
3218         if (ofpbuf_put_hex(&of11_in, instructions, NULL)[0] != '\0') {
3219             ovs_fatal(0, "Trailing garbage in hex data");
3220         }
3221
3222         /* Convert to ofpacts. */
3223         ofpbuf_init(&ofpacts, 0);
3224         size = ofpbuf_size(&of11_in);
3225         error = ofpacts_pull_openflow_instructions(&of11_in, ofpbuf_size(&of11_in),
3226                                                    OFP11_VERSION, &ofpacts);
3227         if (!error) {
3228             /* Verify actions, enforce consistency. */
3229             struct flow flow;
3230             memset(&flow, 0, sizeof flow);
3231             error = ofpacts_check_consistency(ofpbuf_data(&ofpacts), ofpbuf_size(&ofpacts),
3232                                               &flow, OFPP_MAX,
3233                                               table_id ? atoi(table_id) : 0,
3234                                               255, OFPUTIL_P_OF11_STD);
3235         }
3236         if (error) {
3237             printf("bad OF1.1 instructions: %s\n\n", ofperr_get_name(error));
3238             ofpbuf_uninit(&ofpacts);
3239             ofpbuf_uninit(&of11_in);
3240             continue;
3241         }
3242         ofpbuf_push_uninit(&of11_in, size);
3243
3244         /* Print cls_rule. */
3245         ds_init(&s);
3246         ds_put_cstr(&s, "actions=");
3247         ofpacts_format(ofpbuf_data(&ofpacts), ofpbuf_size(&ofpacts), &s);
3248         puts(ds_cstr(&s));
3249         ds_destroy(&s);
3250
3251         /* Convert back to ofp11 instructions and print differences from
3252          * input. */
3253         ofpbuf_init(&of11_out, 0);
3254         ofpacts_put_openflow_instructions(ofpbuf_data(&ofpacts), ofpbuf_size(&ofpacts),
3255                                           &of11_out, OFP13_VERSION);
3256
3257         print_differences("", ofpbuf_data(&of11_in), ofpbuf_size(&of11_in),
3258                           ofpbuf_data(&of11_out), ofpbuf_size(&of11_out));
3259         putchar('\n');
3260
3261         ofpbuf_uninit(&ofpacts);
3262         ofpbuf_uninit(&of11_in);
3263         ofpbuf_uninit(&of11_out);
3264     }
3265     ds_destroy(&in);
3266 }
3267
3268 /* "parse-pcap PCAP": read packets from PCAP and print their flows. */
3269 static void
3270 ofctl_parse_pcap(int argc OVS_UNUSED, char *argv[])
3271 {
3272     FILE *pcap;
3273
3274     pcap = ovs_pcap_open(argv[1], "rb");
3275     if (!pcap) {
3276         ovs_fatal(errno, "%s: open failed", argv[1]);
3277     }
3278
3279     for (;;) {
3280         struct ofpbuf *packet;
3281         struct flow flow;
3282         const struct pkt_metadata md = PKT_METADATA_INITIALIZER(ODPP_NONE);
3283         int error;
3284
3285         error = ovs_pcap_read(pcap, &packet, NULL);
3286         if (error == EOF) {
3287             break;
3288         } else if (error) {
3289             ovs_fatal(error, "%s: read failed", argv[1]);
3290         }
3291
3292         flow_extract(packet, &md, &flow);
3293         flow_print(stdout, &flow);
3294         putchar('\n');
3295         ofpbuf_delete(packet);
3296     }
3297 }
3298
3299 /* "check-vlan VLAN_TCI VLAN_TCI_MASK": converts the specified vlan_tci and
3300  * mask values to and from various formats and prints the results. */
3301 static void
3302 ofctl_check_vlan(int argc OVS_UNUSED, char *argv[])
3303 {
3304     struct match match;
3305
3306     char *string_s;
3307     struct ofputil_flow_mod fm;
3308
3309     struct ofpbuf nxm;
3310     struct match nxm_match;
3311     int nxm_match_len;
3312     char *nxm_s;
3313
3314     struct ofp10_match of10_raw;
3315     struct match of10_match;
3316
3317     struct ofp11_match of11_raw;
3318     struct match of11_match;
3319
3320     enum ofperr error;
3321     char *error_s;
3322
3323     enum ofputil_protocol usable_protocols; /* Unused for now. */
3324
3325     match_init_catchall(&match);
3326     match.flow.vlan_tci = htons(strtoul(argv[1], NULL, 16));
3327     match.wc.masks.vlan_tci = htons(strtoul(argv[2], NULL, 16));
3328
3329     /* Convert to and from string. */
3330     string_s = match_to_string(&match, OFP_DEFAULT_PRIORITY);
3331     printf("%s -> ", string_s);
3332     fflush(stdout);
3333     error_s = parse_ofp_str(&fm, -1, string_s, &usable_protocols);
3334     if (error_s) {
3335         ovs_fatal(0, "%s", error_s);
3336     }
3337     printf("%04"PRIx16"/%04"PRIx16"\n",
3338            ntohs(fm.match.flow.vlan_tci),
3339            ntohs(fm.match.wc.masks.vlan_tci));
3340     free(string_s);
3341
3342     /* Convert to and from NXM. */
3343     ofpbuf_init(&nxm, 0);
3344     nxm_match_len = nx_put_match(&nxm, &match, htonll(0), htonll(0));
3345     nxm_s = nx_match_to_string(ofpbuf_data(&nxm), nxm_match_len);
3346     error = nx_pull_match(&nxm, nxm_match_len, &nxm_match, NULL, NULL);
3347     printf("NXM: %s -> ", nxm_s);
3348     if (error) {
3349         printf("%s\n", ofperr_to_string(error));
3350     } else {
3351         printf("%04"PRIx16"/%04"PRIx16"\n",
3352                ntohs(nxm_match.flow.vlan_tci),
3353                ntohs(nxm_match.wc.masks.vlan_tci));
3354     }
3355     free(nxm_s);
3356     ofpbuf_uninit(&nxm);
3357
3358     /* Convert to and from OXM. */
3359     ofpbuf_init(&nxm, 0);
3360     nxm_match_len = oxm_put_match(&nxm, &match, OFP12_VERSION);
3361     nxm_s = oxm_match_to_string(&nxm, nxm_match_len);
3362     error = oxm_pull_match(&nxm, &nxm_match);
3363     printf("OXM: %s -> ", nxm_s);
3364     if (error) {
3365         printf("%s\n", ofperr_to_string(error));
3366     } else {
3367         uint16_t vid = ntohs(nxm_match.flow.vlan_tci) &
3368             (VLAN_VID_MASK | VLAN_CFI);
3369         uint16_t mask = ntohs(nxm_match.wc.masks.vlan_tci) &
3370             (VLAN_VID_MASK | VLAN_CFI);
3371
3372         printf("%04"PRIx16"/%04"PRIx16",", vid, mask);
3373         if (vid && vlan_tci_to_pcp(nxm_match.wc.masks.vlan_tci)) {
3374             printf("%02"PRIx8"\n", vlan_tci_to_pcp(nxm_match.flow.vlan_tci));
3375         } else {
3376             printf("--\n");
3377         }
3378     }
3379     free(nxm_s);
3380     ofpbuf_uninit(&nxm);
3381
3382     /* Convert to and from OpenFlow 1.0. */
3383     ofputil_match_to_ofp10_match(&match, &of10_raw);
3384     ofputil_match_from_ofp10_match(&of10_raw, &of10_match);
3385     printf("OF1.0: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
3386            ntohs(of10_raw.dl_vlan),
3387            (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN)) != 0,
3388            of10_raw.dl_vlan_pcp,
3389            (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN_PCP)) != 0,
3390            ntohs(of10_match.flow.vlan_tci),
3391            ntohs(of10_match.wc.masks.vlan_tci));
3392
3393     /* Convert to and from OpenFlow 1.1. */
3394     ofputil_match_to_ofp11_match(&match, &of11_raw);
3395     ofputil_match_from_ofp11_match(&of11_raw, &of11_match);
3396     printf("OF1.1: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
3397            ntohs(of11_raw.dl_vlan),
3398            (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN)) != 0,
3399            of11_raw.dl_vlan_pcp,
3400            (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN_PCP)) != 0,
3401            ntohs(of11_match.flow.vlan_tci),
3402            ntohs(of11_match.wc.masks.vlan_tci));
3403 }
3404
3405 /* "print-error ENUM": Prints the type and code of ENUM for every OpenFlow
3406  * version. */
3407 static void
3408 ofctl_print_error(int argc OVS_UNUSED, char *argv[])
3409 {
3410     enum ofperr error;
3411     int version;
3412
3413     error = ofperr_from_name(argv[1]);
3414     if (!error) {
3415         ovs_fatal(0, "unknown error \"%s\"", argv[1]);
3416     }
3417
3418     for (version = 0; version <= UINT8_MAX; version++) {
3419         const char *name = ofperr_domain_get_name(version);
3420         if (name) {
3421             int vendor = ofperr_get_vendor(error, version);
3422             int type = ofperr_get_type(error, version);
3423             int code = ofperr_get_code(error, version);
3424
3425             if (vendor != -1 || type != -1 || code != -1) {
3426                 printf("%s: vendor %#x, type %d, code %d\n",
3427                        name, vendor, type, code);
3428             }
3429         }
3430     }
3431 }
3432
3433 /* "encode-error-reply ENUM REQUEST": Encodes an error reply to REQUEST for the
3434  * error named ENUM and prints the error reply in hex. */
3435 static void
3436 ofctl_encode_error_reply(int argc OVS_UNUSED, char *argv[])
3437 {
3438     const struct ofp_header *oh;
3439     struct ofpbuf request, *reply;
3440     enum ofperr error;
3441
3442     error = ofperr_from_name(argv[1]);
3443     if (!error) {
3444         ovs_fatal(0, "unknown error \"%s\"", argv[1]);
3445     }
3446
3447     ofpbuf_init(&request, 0);
3448     if (ofpbuf_put_hex(&request, argv[2], NULL)[0] != '\0') {
3449         ovs_fatal(0, "Trailing garbage in hex data");
3450     }
3451     if (ofpbuf_size(&request) < sizeof(struct ofp_header)) {
3452         ovs_fatal(0, "Request too short");
3453     }
3454
3455     oh = ofpbuf_data(&request);
3456     if (ofpbuf_size(&request) != ntohs(oh->length)) {
3457         ovs_fatal(0, "Request size inconsistent");
3458     }
3459
3460     reply = ofperr_encode_reply(error, ofpbuf_data(&request));
3461     ofpbuf_uninit(&request);
3462
3463     ovs_hex_dump(stdout, ofpbuf_data(reply), ofpbuf_size(reply), 0, false);
3464     ofpbuf_delete(reply);
3465 }
3466
3467 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
3468  * binary data, interpreting them as an OpenFlow message, and prints the
3469  * OpenFlow message on stdout, at VERBOSITY (level 2 by default).  */
3470 static void
3471 ofctl_ofp_print(int argc, char *argv[])
3472 {
3473     struct ofpbuf packet;
3474
3475     ofpbuf_init(&packet, strlen(argv[1]) / 2);
3476     if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
3477         ovs_fatal(0, "trailing garbage following hex bytes");
3478     }
3479     ofp_print(stdout, ofpbuf_data(&packet), ofpbuf_size(&packet), argc > 2 ? atoi(argv[2]) : 2);
3480     ofpbuf_uninit(&packet);
3481 }
3482
3483 /* "encode-hello BITMAP...": Encodes each BITMAP as an OpenFlow hello message
3484  * and dumps each message in hex.  */
3485 static void
3486 ofctl_encode_hello(int argc OVS_UNUSED, char *argv[])
3487 {
3488     uint32_t bitmap = strtol(argv[1], NULL, 0);
3489     struct ofpbuf *hello;
3490
3491     hello = ofputil_encode_hello(bitmap);
3492     ovs_hex_dump(stdout, ofpbuf_data(hello), ofpbuf_size(hello), 0, false);
3493     ofp_print(stdout, ofpbuf_data(hello), ofpbuf_size(hello), verbosity);
3494     ofpbuf_delete(hello);
3495 }
3496
3497 static const struct command all_commands[] = {
3498     { "show", 1, 1, ofctl_show },
3499     { "monitor", 1, 3, ofctl_monitor },
3500     { "snoop", 1, 1, ofctl_snoop },
3501     { "dump-desc", 1, 1, ofctl_dump_desc },
3502     { "dump-tables", 1, 1, ofctl_dump_tables },
3503     { "dump-table-features", 1, 1, ofctl_dump_table_features },
3504     { "dump-flows", 1, 2, ofctl_dump_flows },
3505     { "dump-aggregate", 1, 2, ofctl_dump_aggregate },
3506     { "queue-stats", 1, 3, ofctl_queue_stats },
3507     { "queue-get-config", 2, 2, ofctl_queue_get_config },
3508     { "add-flow", 2, 2, ofctl_add_flow },
3509     { "add-flows", 2, 2, ofctl_add_flows },
3510     { "mod-flows", 2, 2, ofctl_mod_flows },
3511     { "del-flows", 1, 2, ofctl_del_flows },
3512     { "replace-flows", 2, 2, ofctl_replace_flows },
3513     { "diff-flows", 2, 2, ofctl_diff_flows },
3514     { "add-meter", 2, 2, ofctl_add_meter },
3515     { "mod-meter", 2, 2, ofctl_mod_meter },
3516     { "del-meter", 2, 2, ofctl_del_meters },
3517     { "del-meters", 1, 1, ofctl_del_meters },
3518     { "dump-meter", 2, 2, ofctl_dump_meters },
3519     { "dump-meters", 1, 1, ofctl_dump_meters },
3520     { "meter-stats", 1, 2, ofctl_meter_stats },
3521     { "meter-features", 1, 1, ofctl_meter_features },
3522     { "packet-out", 4, INT_MAX, ofctl_packet_out },
3523     { "dump-ports", 1, 2, ofctl_dump_ports },
3524     { "dump-ports-desc", 1, 2, ofctl_dump_ports_desc },
3525     { "mod-port", 3, 3, ofctl_mod_port },
3526     { "mod-table", 3, 3, ofctl_mod_table },
3527     { "get-frags", 1, 1, ofctl_get_frags },
3528     { "set-frags", 2, 2, ofctl_set_frags },
3529     { "probe", 1, 1, ofctl_probe },
3530     { "ping", 1, 2, ofctl_ping },
3531     { "benchmark", 3, 3, ofctl_benchmark },
3532
3533     { "ofp-parse", 1, 1, ofctl_ofp_parse },
3534     { "ofp-parse-pcap", 1, INT_MAX, ofctl_ofp_parse_pcap },
3535
3536     { "add-group", 1, 2, ofctl_add_group },
3537     { "add-groups", 1, 2, ofctl_add_groups },
3538     { "mod-group", 1, 2, ofctl_mod_group },
3539     { "del-groups", 1, 2, ofctl_del_groups },
3540     { "dump-groups", 1, 2, ofctl_dump_group_desc },
3541     { "dump-group-stats", 1, 2, ofctl_dump_group_stats },
3542     { "dump-group-features", 1, 1, ofctl_dump_group_features },
3543     { "help", 0, INT_MAX, ofctl_help },
3544
3545     /* Undocumented commands for testing. */
3546     { "parse-flow", 1, 1, ofctl_parse_flow },
3547     { "parse-flows", 1, 1, ofctl_parse_flows },
3548     { "parse-nx-match", 0, 0, ofctl_parse_nxm },
3549     { "parse-nxm", 0, 0, ofctl_parse_nxm },
3550     { "parse-oxm", 1, 1, ofctl_parse_oxm },
3551     { "parse-ofp10-actions", 0, 0, ofctl_parse_ofp10_actions },
3552     { "parse-ofp10-match", 0, 0, ofctl_parse_ofp10_match },
3553     { "parse-ofp11-match", 0, 0, ofctl_parse_ofp11_match },
3554     { "parse-ofp11-actions", 0, 0, ofctl_parse_ofp11_actions },
3555     { "parse-ofp11-instructions", 0, 0, ofctl_parse_ofp11_instructions },
3556     { "parse-pcap", 1, 1, ofctl_parse_pcap },
3557     { "check-vlan", 2, 2, ofctl_check_vlan },
3558     { "print-error", 1, 1, ofctl_print_error },
3559     { "encode-error-reply", 2, 2, ofctl_encode_error_reply },
3560     { "ofp-print", 1, 2, ofctl_ofp_print },
3561     { "encode-hello", 1, 1, ofctl_encode_hello },
3562
3563     { NULL, 0, 0, NULL },
3564 };
3565
3566 static const struct command *get_all_commands(void)
3567 {
3568     return all_commands;
3569 }