utilities/ovs-ofctl.c

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