utilities/ovs-ofctl.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 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 <sys/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 "nx-match.h"
  40 #include "odp-util.h"
  41 #include "ofp-actions.h"
  42 #include "ofp-errors.h"
  43 #include "ofp-msgs.h"
  44 #include "ofp-parse.h"
  45 #include "ofp-print.h"
  46 #include "ofp-util.h"
  47 #include "ofpbuf.h"
  48 #include "ofproto/ofproto.h"
  49 #include "openflow/nicira-ext.h"
  50 #include "openflow/openflow.h"
  51 #include "packets.h"
  52 #include "poll-loop.h"
  53 #include "random.h"
  54 #include "stream-ssl.h"
  55 #include "timeval.h"
  56 #include "unixctl.h"
  57 #include "util.h"
  58 #include "vconn.h"
  59 #include "vlog.h"
  60 #include "meta-flow.h"
  61 #include "sort.h"
  62
  63 VLOG_DEFINE_THIS_MODULE(ofctl);
  64
  65 /* --strict: Use strict matching for flow mod commands?  Additionally governs
  66  * use of nx_pull_match() instead of nx_pull_match_loose() in parse-nx-match.
  67  */
  68 static bool strict;
  69
  70 /* --readd: If true, on replace-flows, re-add even flows that have not changed
  71  * (to reset flow counters). */
  72 static bool readd;
  73
  74 /* -F, --flow-format: Allowed protocols.  By default, any protocol is
  75  * allowed. */
  76 static enum ofputil_protocol allowed_protocols = OFPUTIL_P_ANY;
  77
  78 /* -P, --packet-in-format: Packet IN format to use in monitor and snoop
  79  * commands.  Either one of NXPIF_* to force a particular packet_in format, or
  80  * -1 to let ovs-ofctl choose the default. */
  81 static int preferred_packet_in_format = -1;
  82
  83 /* -m, --more: Additional verbosity for ofp-print functions. */
  84 static int verbosity;
  85
  86 /* --timestamp: Print a timestamp before each received packet on "monitor" and
  87  * "snoop" command? */
  88 static bool timestamp;
  89
  90 /* --sort, --rsort: Sort order. */
  91 enum sort_order { SORT_ASC, SORT_DESC };
  92 struct sort_criterion {
  93     const struct mf_field *field; /* NULL means to sort by priority. */
  94     enum sort_order order;
  95 };
  96 static struct sort_criterion *criteria;
  97 static size_t n_criteria, allocated_criteria;
  98
  99 static const struct command all_commands[];
 100
 101 static void usage(void) NO_RETURN;
 102 static void parse_options(int argc, char *argv[]);
 103
 104 static bool recv_flow_stats_reply(struct vconn *, ovs_be32 send_xid,
 105                                   struct ofpbuf **replyp,
 106                                   struct ofputil_flow_stats *,
 107                                   struct ofpbuf *ofpacts);
 108 int
 109 main(int argc, char *argv[])
 110 {
 111     set_program_name(argv[0]);
 112     parse_options(argc, argv);
 113     signal(SIGPIPE, SIG_IGN);
 114     run_command(argc - optind, argv + optind, all_commands);
 115     return 0;
 116 }
 117
 118 static void
 119 add_sort_criterion(enum sort_order order, const char *field)
 120 {
 121     struct sort_criterion *sc;
 122
 123     if (n_criteria >= allocated_criteria) {
 124         criteria = x2nrealloc(criteria, &allocated_criteria, sizeof *criteria);
 125     }
 126
 127     sc = &criteria[n_criteria++];
 128     if (!field || !strcasecmp(field, "priority")) {
 129         sc->field = NULL;
 130     } else {
 131         sc->field = mf_from_name(field);
 132         if (!sc->field) {
 133             ovs_fatal(0, "%s: unknown field name", field);
 134         }
 135     }
 136     sc->order = order;
 137 }
 138
 139 static void
 140 parse_options(int argc, char *argv[])
 141 {
 142     enum {
 143         OPT_STRICT = UCHAR_MAX + 1,
 144         OPT_READD,
 145         OPT_TIMESTAMP,
 146         OPT_SORT,
 147         OPT_RSORT,
 148         DAEMON_OPTION_ENUMS,
 149         VLOG_OPTION_ENUMS
 150     };
 151     static struct option long_options[] = {
 152         {"timeout", required_argument, NULL, 't'},
 153         {"strict", no_argument, NULL, OPT_STRICT},
 154         {"readd", no_argument, NULL, OPT_READD},
 155         {"flow-format", required_argument, NULL, 'F'},
 156         {"packet-in-format", required_argument, NULL, 'P'},
 157         {"more", no_argument, NULL, 'm'},
 158         {"timestamp", no_argument, NULL, OPT_TIMESTAMP},
 159         {"sort", optional_argument, NULL, OPT_SORT},
 160         {"rsort", optional_argument, NULL, OPT_RSORT},
 161         {"help", no_argument, NULL, 'h'},
 162         {"version", no_argument, NULL, 'V'},
 163         DAEMON_LONG_OPTIONS,
 164         VLOG_LONG_OPTIONS,
 165         STREAM_SSL_LONG_OPTIONS,
 166         {NULL, 0, NULL, 0},
 167     };
 168     char *short_options = long_options_to_short_options(long_options);
 169
 170     for (;;) {
 171         unsigned long int timeout;
 172         int c;
 173
 174         c = getopt_long(argc, argv, short_options, long_options, NULL);
 175         if (c == -1) {
 176             break;
 177         }
 178
 179         switch (c) {
 180         case 't':
 181             timeout = strtoul(optarg, NULL, 10);
 182             if (timeout <= 0) {
 183                 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
 184                           optarg);
 185             } else {
 186                 time_alarm(timeout);
 187             }
 188             break;
 189
 190         case 'F':
 191             allowed_protocols = ofputil_protocols_from_string(optarg);
 192             if (!allowed_protocols) {
 193                 ovs_fatal(0, "%s: invalid flow format(s)", optarg);
 194             }
 195             break;
 196
 197         case 'P':
 198             preferred_packet_in_format =
 199                 ofputil_packet_in_format_from_string(optarg);
 200             if (preferred_packet_in_format < 0) {
 201                 ovs_fatal(0, "unknown packet-in format `%s'", optarg);
 202             }
 203             break;
 204
 205         case 'm':
 206             verbosity++;
 207             break;
 208
 209         case 'h':
 210             usage();
 211
 212         case 'V':
 213             ovs_print_version(OFP10_VERSION, OFP10_VERSION);
 214             exit(EXIT_SUCCESS);
 215
 216         case OPT_STRICT:
 217             strict = true;
 218             break;
 219
 220         case OPT_READD:
 221             readd = true;
 222             break;
 223
 224         case OPT_TIMESTAMP:
 225             timestamp = true;
 226             break;
 227
 228         case OPT_SORT:
 229             add_sort_criterion(SORT_ASC, optarg);
 230             break;
 231
 232         case OPT_RSORT:
 233             add_sort_criterion(SORT_DESC, optarg);
 234             break;
 235
 236         DAEMON_OPTION_HANDLERS
 237         VLOG_OPTION_HANDLERS
 238         STREAM_SSL_OPTION_HANDLERS
 239
 240         case '?':
 241             exit(EXIT_FAILURE);
 242
 243         default:
 244             abort();
 245         }
 246     }
 247
 248     if (n_criteria) {
 249         /* Always do a final sort pass based on priority. */
 250         add_sort_criterion(SORT_DESC, "priority");
 251     }
 252
 253     free(short_options);
 254 }
 255
 256 static void
 257 usage(void)
 258 {
 259     printf("%s: OpenFlow switch management utility\n"
 260            "usage: %s [OPTIONS] COMMAND [ARG...]\n"
 261            "\nFor OpenFlow switches:\n"
 262            "  show SWITCH                 show OpenFlow information\n"
 263            "  dump-desc SWITCH            print switch description\n"
 264            "  dump-tables SWITCH          print table stats\n"
 265            "  mod-port SWITCH IFACE ACT   modify port behavior\n"
 266            "  get-frags SWITCH            print fragment handling behavior\n"
 267            "  set-frags SWITCH FRAG_MODE  set fragment handling behavior\n"
 268            "  dump-ports SWITCH [PORT]    print port statistics\n"
 269            "  dump-ports-desc SWITCH      print port descriptions\n"
 270            "  dump-flows SWITCH           print all flow entries\n"
 271            "  dump-flows SWITCH FLOW      print matching FLOWs\n"
 272            "  dump-aggregate SWITCH       print aggregate flow statistics\n"
 273            "  dump-aggregate SWITCH FLOW  print aggregate stats for FLOWs\n"
 274            "  queue-stats SWITCH [PORT [QUEUE]]  dump queue stats\n"
 275            "  add-flow SWITCH FLOW        add flow described by FLOW\n"
 276            "  add-flows SWITCH FILE       add flows from FILE\n"
 277            "  mod-flows SWITCH FLOW       modify actions of matching FLOWs\n"
 278            "  del-flows SWITCH [FLOW]     delete matching FLOWs\n"
 279            "  replace-flows SWITCH FILE   replace flows with those in FILE\n"
 280            "  diff-flows SOURCE1 SOURCE2  compare flows from two sources\n"
 281            "  packet-out SWITCH IN_PORT ACTIONS PACKET...\n"
 282            "                              execute ACTIONS on PACKET\n"
 283            "  monitor SWITCH [MISSLEN] [invalid_ttl] [watch:[...]]\n"
 284            "                              print packets received from SWITCH\n"
 285            "  snoop SWITCH                snoop on SWITCH and its controller\n"
 286            "\nFor OpenFlow switches and controllers:\n"
 287            "  probe TARGET                probe whether TARGET is up\n"
 288            "  ping TARGET [N]             latency of N-byte echos\n"
 289            "  benchmark TARGET N COUNT    bandwidth of COUNT N-byte echos\n"
 290            "where SWITCH or TARGET is an active OpenFlow connection method.\n",
 291            program_name, program_name);
 292     vconn_usage(true, false, false);
 293     daemon_usage();
 294     vlog_usage();
 295     printf("\nOther options:\n"
 296            "  --strict                    use strict match for flow commands\n"
 297            "  --readd                     replace flows that haven't changed\n"
 298            "  -F, --flow-format=FORMAT    force particular flow format\n"
 299            "  -P, --packet-in-format=FRMT force particular packet in format\n"
 300            "  -m, --more                  be more verbose printing OpenFlow\n"
 301            "  --timestamp                 (monitor, snoop) print timestamps\n"
 302            "  -t, --timeout=SECS          give up after SECS seconds\n"
 303            "  --sort[=field]              sort in ascending order\n"
 304            "  --rsort[=field]             sort in descending order\n"
 305            "  -h, --help                  display this help message\n"
 306            "  -V, --version               display version information\n");
 307     exit(EXIT_SUCCESS);
 308 }
 309
 310 static void
 311 ofctl_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
 312            const char *argv[] OVS_UNUSED, void *exiting_)
 313 {
 314     bool *exiting = exiting_;
 315     *exiting = true;
 316     unixctl_command_reply(conn, NULL);
 317 }
 318
 319 static void run(int retval, const char *message, ...)
 320     PRINTF_FORMAT(2, 3);
 321
 322 static void run(int retval, const char *message, ...)
 323 {
 324     if (retval) {
 325         va_list args;
 326
 327         va_start(args, message);
 328         ovs_fatal_valist(retval, message, args);
 329     }
 330 }
 331 \f
 332 /* Generic commands. */
 333
 334 static void
 335 open_vconn_socket(const char *name, struct vconn **vconnp)
 336 {
 337     char *vconn_name = xasprintf("unix:%s", name);
 338     VLOG_DBG("connecting to %s", vconn_name);
 339     run(vconn_open_block(vconn_name, OFP10_VERSION, vconnp),
 340         "connecting to %s", vconn_name);
 341     free(vconn_name);
 342 }
 343
 344 static enum ofputil_protocol
 345 open_vconn__(const char *name, const char *default_suffix,
 346              struct vconn **vconnp)
 347 {
 348     char *datapath_name, *datapath_type, *socket_name;
 349     enum ofputil_protocol protocol;
 350     char *bridge_path;
 351     int ofp_version;
 352     struct stat s;
 353
 354     bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, default_suffix);
 355
 356     ofproto_parse_name(name, &datapath_name, &datapath_type);
 357     socket_name = xasprintf("%s/%s.%s",
 358                             ovs_rundir(), datapath_name, default_suffix);
 359     free(datapath_name);
 360     free(datapath_type);
 361
 362     if (strchr(name, ':')) {
 363         run(vconn_open_block(name, OFP10_VERSION, vconnp),
 364             "connecting to %s", name);
 365     } else if (!stat(name, &s) && S_ISSOCK(s.st_mode)) {
 366         open_vconn_socket(name, vconnp);
 367     } else if (!stat(bridge_path, &s) && S_ISSOCK(s.st_mode)) {
 368         open_vconn_socket(bridge_path, vconnp);
 369     } else if (!stat(socket_name, &s)) {
 370         if (!S_ISSOCK(s.st_mode)) {
 371             ovs_fatal(0, "cannot connect to %s: %s is not a socket",
 372                       name, socket_name);
 373         }
 374         open_vconn_socket(socket_name, vconnp);
 375     } else {
 376         ovs_fatal(0, "%s is not a bridge or a socket", name);
 377     }
 378
 379     free(bridge_path);
 380     free(socket_name);
 381
 382     ofp_version = vconn_get_version(*vconnp);
 383     protocol = ofputil_protocol_from_ofp_version(ofp_version);
 384     if (!protocol) {
 385         ovs_fatal(0, "%s: unsupported OpenFlow version 0x%02x",
 386                   name, ofp_version);
 387     }
 388     return protocol;
 389 }
 390
 391 static enum ofputil_protocol
 392 open_vconn(const char *name, struct vconn **vconnp)
 393 {
 394     return open_vconn__(name, "mgmt", vconnp);
 395 }
 396
 397 static void
 398 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
 399 {
 400     ofpmsg_update_length(buffer);
 401     run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
 402 }
 403
 404 static void
 405 dump_transaction(const char *vconn_name, struct ofpbuf *request)
 406 {
 407     struct vconn *vconn;
 408     struct ofpbuf *reply;
 409
 410     ofpmsg_update_length(request);
 411     open_vconn(vconn_name, &vconn);
 412     run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
 413     ofp_print(stdout, reply->data, reply->size, verbosity + 1);
 414     ofpbuf_delete(reply);
 415     vconn_close(vconn);
 416 }
 417
 418 static void
 419 dump_trivial_transaction(const char *vconn_name, enum ofpraw raw)
 420 {
 421     struct ofpbuf *request;
 422     request = ofpraw_alloc(raw, OFP10_VERSION, 0);
 423     dump_transaction(vconn_name, request);
 424 }
 425
 426 static void
 427 dump_stats_transaction(struct vconn *vconn, struct ofpbuf *request)
 428 {
 429     const struct ofp_header *request_oh = request->data;
 430     ovs_be32 send_xid = request_oh->xid;
 431     enum ofpraw request_raw;
 432     enum ofpraw reply_raw;
 433     bool done = false;
 434
 435     ofpraw_decode_partial(&request_raw, request->data, request->size);
 436     reply_raw = ofpraw_stats_request_to_reply(request_raw,
 437                                               request_oh->version);
 438
 439     send_openflow_buffer(vconn, request);
 440     while (!done) {
 441         ovs_be32 recv_xid;
 442         struct ofpbuf *reply;
 443
 444         run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
 445         recv_xid = ((struct ofp_header *) reply->data)->xid;
 446         if (send_xid == recv_xid) {
 447             enum ofpraw raw;
 448
 449             ofp_print(stdout, reply->data, reply->size, verbosity + 1);
 450
 451             ofpraw_decode(&raw, reply->data);
 452             if (ofptype_from_ofpraw(raw) == OFPTYPE_ERROR) {
 453                 done = true;
 454             } else if (raw == reply_raw) {
 455                 done = !ofpmp_more(reply->data);
 456             } else {
 457                 ovs_fatal(0, "received bad reply: %s",
 458                           ofp_to_string(reply->data, reply->size,
 459                                         verbosity + 1));
 460             }
 461         } else {
 462             VLOG_DBG("received reply with xid %08"PRIx32" "
 463                      "!= expected %08"PRIx32, recv_xid, send_xid);
 464         }
 465         ofpbuf_delete(reply);
 466     }
 467 }
 468
 469 static void
 470 dump_trivial_stats_transaction(const char *vconn_name, enum ofpraw raw)
 471 {
 472     struct ofpbuf *request;
 473     struct vconn *vconn;
 474
 475     open_vconn(vconn_name, &vconn);
 476     request = ofpraw_alloc(raw, vconn_get_version(vconn), 0);
 477     dump_stats_transaction(vconn, request);
 478     vconn_close(vconn);
 479 }
 480
 481 /* Sends 'request', which should be a request that only has a reply if an error
 482  * occurs, and waits for it to succeed or fail.  If an error does occur, prints
 483  * it and exits with an error.
 484  *
 485  * Destroys all of the 'requests'. */
 486 static void
 487 transact_multiple_noreply(struct vconn *vconn, struct list *requests)
 488 {
 489     struct ofpbuf *request, *reply;
 490
 491     LIST_FOR_EACH (request, list_node, requests) {
 492         ofpmsg_update_length(request);
 493     }
 494
 495     run(vconn_transact_multiple_noreply(vconn, requests, &reply),
 496         "talking to %s", vconn_get_name(vconn));
 497     if (reply) {
 498         ofp_print(stderr, reply->data, reply->size, verbosity + 2);
 499         exit(1);
 500     }
 501     ofpbuf_delete(reply);
 502 }
 503
 504 /* Sends 'request', which should be a request that only has a reply if an error
 505  * occurs, and waits for it to succeed or fail.  If an error does occur, prints
 506  * it and exits with an error.
 507  *
 508  * Destroys 'request'. */
 509 static void
 510 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
 511 {
 512     struct list requests;
 513
 514     list_init(&requests);
 515     list_push_back(&requests, &request->list_node);
 516     transact_multiple_noreply(vconn, &requests);
 517 }
 518
 519 static void
 520 fetch_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
 521 {
 522     struct ofp_switch_config *config;
 523     struct ofpbuf *request;
 524     struct ofpbuf *reply;
 525     enum ofptype type;
 526
 527     request = ofpraw_alloc(OFPRAW_OFPT_GET_CONFIG_REQUEST, OFP10_VERSION, 0);
 528     run(vconn_transact(vconn, request, &reply),
 529         "talking to %s", vconn_get_name(vconn));
 530
 531     if (ofptype_pull(&type, reply) || type != OFPTYPE_GET_CONFIG_REPLY) {
 532         ovs_fatal(0, "%s: bad reply to config request", vconn_get_name(vconn));
 533     }
 534
 535     config = ofpbuf_pull(reply, sizeof *config);
 536     *config_ = *config;
 537
 538     ofpbuf_delete(reply);
 539 }
 540
 541 static void
 542 set_switch_config(struct vconn *vconn, const struct ofp_switch_config *config)
 543 {
 544     struct ofpbuf *request;
 545
 546     request = ofpraw_alloc(OFPRAW_OFPT_SET_CONFIG, OFP10_VERSION, 0);
 547     ofpbuf_put(request, config, sizeof *config);
 548
 549     transact_noreply(vconn, request);
 550 }
 551
 552 static void
 553 ofctl_show(int argc OVS_UNUSED, char *argv[])
 554 {
 555     const char *vconn_name = argv[1];
 556     struct vconn *vconn;
 557     struct ofpbuf *request;
 558     struct ofpbuf *reply;
 559     bool trunc;
 560
 561     request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST, OFP10_VERSION, 0);
 562     open_vconn(vconn_name, &vconn);
 563     run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
 564
 565     trunc = ofputil_switch_features_ports_trunc(reply);
 566     ofp_print(stdout, reply->data, reply->size, verbosity + 1);
 567
 568     ofpbuf_delete(reply);
 569     vconn_close(vconn);
 570
 571     if (trunc) {
 572         /* The Features Reply may not contain all the ports, so send a
 573          * Port Description stats request, which doesn't have size
 574          * constraints. */
 575         dump_trivial_stats_transaction(vconn_name,
 576                                        OFPRAW_OFPST_PORT_DESC_REQUEST);
 577     }
 578     dump_trivial_transaction(vconn_name, OFPRAW_OFPT_GET_CONFIG_REQUEST);
 579 }
 580
 581 static void
 582 ofctl_dump_desc(int argc OVS_UNUSED, char *argv[])
 583 {
 584     dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_DESC_REQUEST);
 585 }
 586
 587 static void
 588 ofctl_dump_tables(int argc OVS_UNUSED, char *argv[])
 589 {
 590     dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_TABLE_REQUEST);
 591 }
 592
 593 static bool
 594 fetch_port_by_features(const char *vconn_name,
 595                        const char *port_name, unsigned int port_no,
 596                        struct ofputil_phy_port *pp, bool *trunc)
 597 {
 598     struct ofputil_switch_features features;
 599     const struct ofp_header *oh;
 600     struct ofpbuf *request, *reply;
 601     struct vconn *vconn;
 602     enum ofperr error;
 603     enum ofptype type;
 604     struct ofpbuf b;
 605     bool found = false;
 606
 607     /* Fetch the switch's ofp_switch_features. */
 608     request = ofpraw_alloc(OFPRAW_OFPT_FEATURES_REQUEST, OFP10_VERSION, 0);
 609     open_vconn(vconn_name, &vconn);
 610     run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
 611     vconn_close(vconn);
 612
 613     oh = reply->data;
 614     if (ofptype_decode(&type, reply->data)
 615         || type != OFPTYPE_FEATURES_REPLY) {
 616         ovs_fatal(0, "%s: received bad features reply", vconn_name);
 617     }
 618
 619     *trunc = false;
 620     if (ofputil_switch_features_ports_trunc(reply)) {
 621         *trunc = true;
 622         goto exit;
 623     }
 624
 625     error = ofputil_decode_switch_features(oh, &features, &b);
 626     if (error) {
 627         ovs_fatal(0, "%s: failed to decode features reply (%s)",
 628                   vconn_name, ofperr_to_string(error));
 629     }
 630
 631     while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
 632         if (port_no != UINT_MAX
 633             ? port_no == pp->port_no
 634             : !strcmp(pp->name, port_name)) {
 635             found = true;
 636             goto exit;
 637         }
 638     }
 639
 640 exit:
 641     ofpbuf_delete(reply);
 642     return found;
 643 }
 644
 645 static bool
 646 fetch_port_by_stats(const char *vconn_name,
 647                     const char *port_name, unsigned int port_no,
 648                     struct ofputil_phy_port *pp)
 649 {
 650     struct ofpbuf *request;
 651     struct vconn *vconn;
 652     ovs_be32 send_xid;
 653     bool done = false;
 654     bool found = false;
 655
 656     request = ofpraw_alloc(OFPRAW_OFPST_PORT_DESC_REQUEST, OFP10_VERSION, 0);
 657     send_xid = ((struct ofp_header *) request->data)->xid;
 658
 659     open_vconn(vconn_name, &vconn);
 660     send_openflow_buffer(vconn, request);
 661     while (!done) {
 662         ovs_be32 recv_xid;
 663         struct ofpbuf *reply;
 664
 665         run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
 666         recv_xid = ((struct ofp_header *) reply->data)->xid;
 667         if (send_xid == recv_xid) {
 668             struct ofp_header *oh = reply->data;
 669             enum ofptype type;
 670             struct ofpbuf b;
 671             uint16_t flags;
 672
 673             ofpbuf_use_const(&b, oh, ntohs(oh->length));
 674             if (ofptype_pull(&type, &b)
 675                 || type != OFPTYPE_PORT_DESC_STATS_REPLY) {
 676                 ovs_fatal(0, "received bad reply: %s",
 677                           ofp_to_string(reply->data, reply->size,
 678                                         verbosity + 1));
 679             }
 680
 681             flags = ofpmp_flags(oh);
 682             done = !(flags & OFPSF_REPLY_MORE);
 683
 684             if (found) {
 685                 /* We've already found the port, but we need to drain
 686                  * the queue of any other replies for this request. */
 687                 continue;
 688             }
 689
 690             while (!ofputil_pull_phy_port(oh->version, &b, pp)) {
 691                 if (port_no != UINT_MAX ? port_no == pp->port_no
 692                                         : !strcmp(pp->name, port_name)) {
 693                     found = true;
 694                     break;
 695                 }
 696             }
 697         } else {
 698             VLOG_DBG("received reply with xid %08"PRIx32" "
 699                      "!= expected %08"PRIx32, recv_xid, send_xid);
 700         }
 701         ofpbuf_delete(reply);
 702     }
 703     vconn_close(vconn);
 704
 705     return found;
 706 }
 707
 708
 709 /* Opens a connection to 'vconn_name', fetches the port structure for
 710  * 'port_name' (which may be a port name or number), and copies it into
 711  * '*pp'. */
 712 static void
 713 fetch_ofputil_phy_port(const char *vconn_name, const char *port_name,
 714                        struct ofputil_phy_port *pp)
 715 {
 716     unsigned int port_no;
 717     bool found;
 718     bool trunc;
 719
 720     /* Try to interpret the argument as a port number. */
 721     if (!str_to_uint(port_name, 10, &port_no)) {
 722         port_no = UINT_MAX;
 723     }
 724
 725     /* Try to find the port based on the Features Reply.  If it looks
 726      * like the results may be truncated, then use the Port Description
 727      * stats message introduced in OVS 1.7. */
 728     found = fetch_port_by_features(vconn_name, port_name, port_no, pp,
 729                                    &trunc);
 730     if (trunc) {
 731         found = fetch_port_by_stats(vconn_name, port_name, port_no, pp);
 732     }
 733
 734     if (!found) {
 735         ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
 736     }
 737 }
 738
 739 /* Returns the port number corresponding to 'port_name' (which may be a port
 740  * name or number) within the switch 'vconn_name'. */
 741 static uint16_t
 742 str_to_port_no(const char *vconn_name, const char *port_name)
 743 {
 744     uint16_t port_no = ofputil_port_from_string(port_name);
 745     if (port_no) {
 746         return port_no;
 747     } else {
 748         struct ofputil_phy_port pp;
 749
 750         fetch_ofputil_phy_port(vconn_name, port_name, &pp);
 751         return pp.port_no;
 752     }
 753 }
 754
 755 static bool
 756 try_set_protocol(struct vconn *vconn, enum ofputil_protocol want,
 757                  enum ofputil_protocol *cur)
 758 {
 759     for (;;) {
 760         struct ofpbuf *request, *reply;
 761         enum ofputil_protocol next;
 762
 763         request = ofputil_encode_set_protocol(*cur, want, &next);
 764         if (!request) {
 765             return true;
 766         }
 767
 768         run(vconn_transact_noreply(vconn, request, &reply),
 769             "talking to %s", vconn_get_name(vconn));
 770         if (reply) {
 771             char *s = ofp_to_string(reply->data, reply->size, 2);
 772             VLOG_DBG("%s: failed to set protocol, switch replied: %s",
 773                      vconn_get_name(vconn), s);
 774             free(s);
 775             ofpbuf_delete(reply);
 776             return false;
 777         }
 778
 779         *cur = next;
 780     }
 781 }
 782
 783 static enum ofputil_protocol
 784 set_protocol_for_flow_dump(struct vconn *vconn,
 785                            enum ofputil_protocol cur_protocol,
 786                            enum ofputil_protocol usable_protocols)
 787 {
 788     char *usable_s;
 789     int i;
 790
 791     for (i = 0; i < ofputil_n_flow_dump_protocols; i++) {
 792         enum ofputil_protocol f = ofputil_flow_dump_protocols[i];
 793         if (f & usable_protocols & allowed_protocols
 794             && try_set_protocol(vconn, f, &cur_protocol)) {
 795             return f;
 796         }
 797     }
 798
 799     usable_s = ofputil_protocols_to_string(usable_protocols);
 800     if (usable_protocols & allowed_protocols) {
 801         ovs_fatal(0, "switch does not support any of the usable flow "
 802                   "formats (%s)", usable_s);
 803     } else {
 804         char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
 805         ovs_fatal(0, "none of the usable flow formats (%s) is among the "
 806                   "allowed flow formats (%s)", usable_s, allowed_s);
 807     }
 808 }
 809
 810 static struct vconn *
 811 prepare_dump_flows(int argc, char *argv[], bool aggregate,
 812                    struct ofpbuf **requestp)
 813 {
 814     enum ofputil_protocol usable_protocols, protocol;
 815     struct ofputil_flow_stats_request fsr;
 816     struct vconn *vconn;
 817
 818     parse_ofp_flow_stats_request_str(&fsr, aggregate, argc > 2 ? argv[2] : "");
 819     usable_protocols = ofputil_flow_stats_request_usable_protocols(&fsr);
 820
 821     protocol = open_vconn(argv[1], &vconn);
 822     protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
 823     *requestp = ofputil_encode_flow_stats_request(&fsr, protocol);
 824     return vconn;
 825 }
 826
 827 static void
 828 ofctl_dump_flows__(int argc, char *argv[], bool aggregate)
 829 {
 830     struct ofpbuf *request;
 831     struct vconn *vconn;
 832
 833     vconn = prepare_dump_flows(argc, argv, aggregate, &request);
 834     dump_stats_transaction(vconn, request);
 835     vconn_close(vconn);
 836 }
 837
 838 static int
 839 compare_flows(const void *afs_, const void *bfs_)
 840 {
 841     const struct ofputil_flow_stats *afs = afs_;
 842     const struct ofputil_flow_stats *bfs = bfs_;
 843     const struct match *a = &afs->match;
 844     const struct match *b = &bfs->match;
 845     const struct sort_criterion *sc;
 846
 847     for (sc = criteria; sc < &criteria[n_criteria]; sc++) {
 848         const struct mf_field *f = sc->field;
 849         int ret;
 850
 851         if (!f) {
 852             unsigned int a_pri = afs->priority;
 853             unsigned int b_pri = bfs->priority;
 854             ret = a_pri < b_pri ? -1 : a_pri > b_pri;
 855         } else {
 856             bool ina, inb;
 857
 858             ina = mf_are_prereqs_ok(f, &a->flow) && !mf_is_all_wild(f, &a->wc);
 859             inb = mf_are_prereqs_ok(f, &b->flow) && !mf_is_all_wild(f, &b->wc);
 860             if (ina != inb) {
 861                 /* Skip the test for sc->order, so that missing fields always
 862                  * sort to the end whether we're sorting in ascending or
 863                  * descending order. */
 864                 return ina ? -1 : 1;
 865             } else {
 866                 union mf_value aval, bval;
 867
 868                 mf_get_value(f, &a->flow, &aval);
 869                 mf_get_value(f, &b->flow, &bval);
 870                 ret = memcmp(&aval, &bval, f->n_bytes);
 871             }
 872         }
 873
 874         if (ret) {
 875             return sc->order == SORT_ASC ? ret : -ret;
 876         }
 877     }
 878
 879     return 0;
 880 }
 881
 882 static void
 883 ofctl_dump_flows(int argc, char *argv[])
 884 {
 885     if (!n_criteria) {
 886         return ofctl_dump_flows__(argc, argv, false);
 887     } else {
 888         struct ofputil_flow_stats *fses;
 889         size_t n_fses, allocated_fses;
 890         struct ofpbuf *request;
 891         struct ofpbuf ofpacts;
 892         struct ofpbuf *reply;
 893         struct vconn *vconn;
 894         ovs_be32 send_xid;
 895         struct ds s;
 896         size_t i;
 897
 898         vconn = prepare_dump_flows(argc, argv, false, &request);
 899         send_xid = ((struct ofp_header *) request->data)->xid;
 900         send_openflow_buffer(vconn, request);
 901
 902         fses = NULL;
 903         n_fses = allocated_fses = 0;
 904         reply = NULL;
 905         ofpbuf_init(&ofpacts, 0);
 906         for (;;) {
 907             struct ofputil_flow_stats *fs;
 908
 909             if (n_fses >= allocated_fses) {
 910                 fses = x2nrealloc(fses, &allocated_fses, sizeof *fses);
 911             }
 912
 913             fs = &fses[n_fses];
 914             if (!recv_flow_stats_reply(vconn, send_xid, &reply, fs,
 915                                        &ofpacts)) {
 916                 break;
 917             }
 918             fs->ofpacts = xmemdup(fs->ofpacts, fs->ofpacts_len);
 919             n_fses++;
 920         }
 921         ofpbuf_uninit(&ofpacts);
 922
 923         qsort(fses, n_fses, sizeof *fses, compare_flows);
 924
 925         ds_init(&s);
 926         for (i = 0; i < n_fses; i++) {
 927             ds_clear(&s);
 928             ofp_print_flow_stats(&s, &fses[i]);
 929             puts(ds_cstr(&s));
 930         }
 931         ds_destroy(&s);
 932
 933         for (i = 0; i < n_fses; i++) {
 934             free(fses[i].ofpacts);
 935         }
 936         free(fses);
 937
 938         vconn_close(vconn);
 939     }
 940 }
 941
 942 static void
 943 ofctl_dump_aggregate(int argc, char *argv[])
 944 {
 945     return ofctl_dump_flows__(argc, argv, true);
 946 }
 947
 948 static void
 949 ofctl_queue_stats(int argc, char *argv[])
 950 {
 951     struct ofpbuf *request;
 952     struct vconn *vconn;
 953     struct ofputil_queue_stats_request oqs;
 954
 955     open_vconn(argv[1], &vconn);
 956
 957     if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
 958         oqs.port_no = str_to_port_no(argv[1], argv[2]);
 959     } else {
 960         oqs.port_no = OFPP_ALL;
 961     }
 962     if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
 963         oqs.queue_id = atoi(argv[3]);
 964     } else {
 965         oqs.queue_id = OFPQ_ALL;
 966     }
 967
 968     request = ofputil_encode_queue_stats_request(vconn_get_version(vconn), &oqs);
 969     dump_stats_transaction(vconn, request);
 970     vconn_close(vconn);
 971 }
 972
 973 static enum ofputil_protocol
 974 open_vconn_for_flow_mod(const char *remote,
 975                         const struct ofputil_flow_mod *fms, size_t n_fms,
 976                         struct vconn **vconnp)
 977 {
 978     enum ofputil_protocol usable_protocols;
 979     enum ofputil_protocol cur_protocol;
 980     char *usable_s;
 981     int i;
 982
 983     /* Figure out what flow formats will work. */
 984     usable_protocols = ofputil_flow_mod_usable_protocols(fms, n_fms);
 985     if (!(usable_protocols & allowed_protocols)) {
 986         char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
 987         usable_s = ofputil_protocols_to_string(usable_protocols);
 988         ovs_fatal(0, "none of the usable flow formats (%s) is among the "
 989                   "allowed flow formats (%s)", usable_s, allowed_s);
 990     }
 991
 992     /* If the initial flow format is allowed and usable, keep it. */
 993     cur_protocol = open_vconn(remote, vconnp);
 994     if (usable_protocols & allowed_protocols & cur_protocol) {
 995         return cur_protocol;
 996     }
 997
 998     /* Otherwise try each flow format in turn. */
 999     for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
1000         enum ofputil_protocol f = 1 << i;
1001
1002         if (f != cur_protocol
1003             && f & usable_protocols & allowed_protocols
1004             && try_set_protocol(*vconnp, f, &cur_protocol)) {
1005             return f;
1006         }
1007     }
1008
1009     usable_s = ofputil_protocols_to_string(usable_protocols);
1010     ovs_fatal(0, "switch does not support any of the usable flow "
1011               "formats (%s)", usable_s);
1012 }
1013
1014 static void
1015 ofctl_flow_mod__(const char *remote, struct ofputil_flow_mod *fms,
1016                  size_t n_fms)
1017 {
1018     enum ofputil_protocol protocol;
1019     struct vconn *vconn;
1020     size_t i;
1021
1022     protocol = open_vconn_for_flow_mod(remote, fms, n_fms, &vconn);
1023
1024     for (i = 0; i < n_fms; i++) {
1025         struct ofputil_flow_mod *fm = &fms[i];
1026
1027         transact_noreply(vconn, ofputil_encode_flow_mod(fm, protocol));
1028         free(fm->ofpacts);
1029     }
1030     vconn_close(vconn);
1031 }
1032
1033 static void
1034 ofctl_flow_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
1035 {
1036     struct ofputil_flow_mod *fms = NULL;
1037     size_t n_fms = 0;
1038
1039     parse_ofp_flow_mod_file(argv[2], command, &fms, &n_fms);
1040     ofctl_flow_mod__(argv[1], fms, n_fms);
1041     free(fms);
1042 }
1043
1044 static void
1045 ofctl_flow_mod(int argc, char *argv[], uint16_t command)
1046 {
1047     if (argc > 2 && !strcmp(argv[2], "-")) {
1048         ofctl_flow_mod_file(argc, argv, command);
1049     } else {
1050         struct ofputil_flow_mod fm;
1051         parse_ofp_flow_mod_str(&fm, argc > 2 ? argv[2] : "", command, false);
1052         ofctl_flow_mod__(argv[1], &fm, 1);
1053     }
1054 }
1055
1056 static void
1057 ofctl_add_flow(int argc, char *argv[])
1058 {
1059     ofctl_flow_mod(argc, argv, OFPFC_ADD);
1060 }
1061
1062 static void
1063 ofctl_add_flows(int argc, char *argv[])
1064 {
1065     ofctl_flow_mod_file(argc, argv, OFPFC_ADD);
1066 }
1067
1068 static void
1069 ofctl_mod_flows(int argc, char *argv[])
1070 {
1071     ofctl_flow_mod(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
1072 }
1073
1074 static void
1075 ofctl_del_flows(int argc, char *argv[])
1076 {
1077     ofctl_flow_mod(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
1078 }
1079
1080 static void
1081 set_packet_in_format(struct vconn *vconn,
1082                      enum nx_packet_in_format packet_in_format)
1083 {
1084     struct ofpbuf *spif;
1085
1086     spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1087                                              packet_in_format);
1088     transact_noreply(vconn, spif);
1089     VLOG_DBG("%s: using user-specified packet in format %s",
1090              vconn_get_name(vconn),
1091              ofputil_packet_in_format_to_string(packet_in_format));
1092 }
1093
1094 static int
1095 monitor_set_invalid_ttl_to_controller(struct vconn *vconn)
1096 {
1097     struct ofp_switch_config config;
1098     enum ofp_config_flags flags;
1099
1100     fetch_switch_config(vconn, &config);
1101     flags = ntohs(config.flags);
1102     if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1103         /* Set the invalid ttl config. */
1104         flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
1105
1106         config.flags = htons(flags);
1107         set_switch_config(vconn, &config);
1108
1109         /* Then retrieve the configuration to see if it really took.  OpenFlow
1110          * doesn't define error reporting for bad modes, so this is all we can
1111          * do. */
1112         fetch_switch_config(vconn, &config);
1113         flags = ntohs(config.flags);
1114         if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1115             ovs_fatal(0, "setting invalid_ttl_to_controller failed (this "
1116                       "switch probably doesn't support mode)");
1117             return -EOPNOTSUPP;
1118         }
1119     }
1120     return 0;
1121 }
1122
1123 /* Converts hex digits in 'hex' to an OpenFlow message in '*msgp'.  The
1124  * caller must free '*msgp'.  On success, returns NULL.  On failure, returns
1125  * an error message and stores NULL in '*msgp'. */
1126 static const char *
1127 openflow_from_hex(const char *hex, struct ofpbuf **msgp)
1128 {
1129     struct ofp_header *oh;
1130     struct ofpbuf *msg;
1131
1132     msg = ofpbuf_new(strlen(hex) / 2);
1133     *msgp = NULL;
1134
1135     if (ofpbuf_put_hex(msg, hex, NULL)[0] != '\0') {
1136         ofpbuf_delete(msg);
1137         return "Trailing garbage in hex data";
1138     }
1139
1140     if (msg->size < sizeof(struct ofp_header)) {
1141         ofpbuf_delete(msg);
1142         return "Message too short for OpenFlow";
1143     }
1144
1145     oh = msg->data;
1146     if (msg->size != ntohs(oh->length)) {
1147         ofpbuf_delete(msg);
1148         return "Message size does not match length in OpenFlow header";
1149     }
1150
1151     *msgp = msg;
1152     return NULL;
1153 }
1154
1155 static void
1156 ofctl_send(struct unixctl_conn *conn, int argc,
1157            const char *argv[], void *vconn_)
1158 {
1159     struct vconn *vconn = vconn_;
1160     struct ds reply;
1161     bool ok;
1162     int i;
1163
1164     ok = true;
1165     ds_init(&reply);
1166     for (i = 1; i < argc; i++) {
1167         const char *error_msg;
1168         struct ofpbuf *msg;
1169         int error;
1170
1171         error_msg = openflow_from_hex(argv[i], &msg);
1172         if (error_msg) {
1173             ds_put_format(&reply, "%s\n", error_msg);
1174             ok = false;
1175             continue;
1176         }
1177
1178         fprintf(stderr, "send: ");
1179         ofp_print(stderr, msg->data, msg->size, verbosity);
1180
1181         error = vconn_send_block(vconn, msg);
1182         if (error) {
1183             ofpbuf_delete(msg);
1184             ds_put_format(&reply, "%s\n", strerror(error));
1185             ok = false;
1186         } else {
1187             ds_put_cstr(&reply, "sent\n");
1188         }
1189     }
1190
1191     if (ok) {
1192         unixctl_command_reply(conn, ds_cstr(&reply));
1193     } else {
1194         unixctl_command_reply_error(conn, ds_cstr(&reply));
1195     }
1196     ds_destroy(&reply);
1197 }
1198
1199 struct barrier_aux {
1200     struct vconn *vconn;        /* OpenFlow connection for sending barrier. */
1201     struct unixctl_conn *conn;  /* Connection waiting for barrier response. */
1202 };
1203
1204 static void
1205 ofctl_barrier(struct unixctl_conn *conn, int argc OVS_UNUSED,
1206               const char *argv[] OVS_UNUSED, void *aux_)
1207 {
1208     struct barrier_aux *aux = aux_;
1209     struct ofpbuf *msg;
1210     int error;
1211
1212     if (aux->conn) {
1213         unixctl_command_reply_error(conn, "already waiting for barrier reply");
1214         return;
1215     }
1216
1217     msg = ofputil_encode_barrier_request(vconn_get_version(aux->vconn));
1218     error = vconn_send_block(aux->vconn, msg);
1219     if (error) {
1220         ofpbuf_delete(msg);
1221         unixctl_command_reply_error(conn, strerror(error));
1222     } else {
1223         aux->conn = conn;
1224     }
1225 }
1226
1227 static void
1228 ofctl_set_output_file(struct unixctl_conn *conn, int argc OVS_UNUSED,
1229                       const char *argv[], void *aux OVS_UNUSED)
1230 {
1231     int fd;
1232
1233     fd = open(argv[1], O_CREAT | O_TRUNC | O_WRONLY, 0666);
1234     if (fd < 0) {
1235         unixctl_command_reply_error(conn, strerror(errno));
1236         return;
1237     }
1238
1239     fflush(stderr);
1240     dup2(fd, STDERR_FILENO);
1241     close(fd);
1242     unixctl_command_reply(conn, NULL);
1243 }
1244
1245 static void
1246 ofctl_block(struct unixctl_conn *conn, int argc OVS_UNUSED,
1247             const char *argv[] OVS_UNUSED, void *blocked_)
1248 {
1249     bool *blocked = blocked_;
1250
1251     if (!*blocked) {
1252         *blocked = true;
1253         unixctl_command_reply(conn, NULL);
1254     } else {
1255         unixctl_command_reply(conn, "already blocking");
1256     }
1257 }
1258
1259 static void
1260 ofctl_unblock(struct unixctl_conn *conn, int argc OVS_UNUSED,
1261               const char *argv[] OVS_UNUSED, void *blocked_)
1262 {
1263     bool *blocked = blocked_;
1264
1265     if (*blocked) {
1266         *blocked = false;
1267         unixctl_command_reply(conn, NULL);
1268     } else {
1269         unixctl_command_reply(conn, "already unblocked");
1270     }
1271 }
1272
1273 static void
1274 monitor_vconn(struct vconn *vconn)
1275 {
1276     struct barrier_aux barrier_aux = { vconn, NULL };
1277     struct unixctl_server *server;
1278     bool exiting = false;
1279     bool blocked = false;
1280     int error;
1281
1282     daemon_save_fd(STDERR_FILENO);
1283     daemonize_start();
1284     error = unixctl_server_create(NULL, &server);
1285     if (error) {
1286         ovs_fatal(error, "failed to create unixctl server");
1287     }
1288     unixctl_command_register("exit", "", 0, 0, ofctl_exit, &exiting);
1289     unixctl_command_register("ofctl/send", "OFMSG...", 1, INT_MAX,
1290                              ofctl_send, vconn);
1291     unixctl_command_register("ofctl/barrier", "", 0, 0,
1292                              ofctl_barrier, &barrier_aux);
1293     unixctl_command_register("ofctl/set-output-file", "FILE", 1, 1,
1294                              ofctl_set_output_file, NULL);
1295
1296     unixctl_command_register("ofctl/block", "", 0, 0, ofctl_block, &blocked);
1297     unixctl_command_register("ofctl/unblock", "", 0, 0, ofctl_unblock,
1298                              &blocked);
1299
1300     daemonize_complete();
1301
1302     for (;;) {
1303         struct ofpbuf *b;
1304         int retval;
1305
1306         unixctl_server_run(server);
1307
1308         while (!blocked) {
1309             enum ofptype type;
1310
1311             retval = vconn_recv(vconn, &b);
1312             if (retval == EAGAIN) {
1313                 break;
1314             }
1315             run(retval, "vconn_recv");
1316
1317             if (timestamp) {
1318                 time_t now = time_wall();
1319                 char s[32];
1320
1321                 strftime(s, sizeof s, "%Y-%m-%d %H:%M:%S: ", gmtime(&now));
1322                 fputs(s, stderr);
1323             }
1324
1325             ofptype_decode(&type, b->data);
1326             ofp_print(stderr, b->data, b->size, verbosity + 2);
1327             ofpbuf_delete(b);
1328
1329             if (barrier_aux.conn && type == OFPTYPE_BARRIER_REPLY) {
1330                 unixctl_command_reply(barrier_aux.conn, NULL);
1331                 barrier_aux.conn = NULL;
1332             }
1333         }
1334
1335         if (exiting) {
1336             break;
1337         }
1338
1339         vconn_run(vconn);
1340         vconn_run_wait(vconn);
1341         if (!blocked) {
1342             vconn_recv_wait(vconn);
1343         }
1344         unixctl_server_wait(server);
1345         poll_block();
1346     }
1347     vconn_close(vconn);
1348     unixctl_server_destroy(server);
1349 }
1350
1351 static void
1352 ofctl_monitor(int argc, char *argv[])
1353 {
1354     struct vconn *vconn;
1355     int i;
1356
1357     open_vconn(argv[1], &vconn);
1358     for (i = 2; i < argc; i++) {
1359         const char *arg = argv[i];
1360
1361         if (isdigit((unsigned char) *arg)) {
1362             struct ofp_switch_config config;
1363
1364             fetch_switch_config(vconn, &config);
1365             config.miss_send_len = htons(atoi(arg));
1366             set_switch_config(vconn, &config);
1367         } else if (!strcmp(arg, "invalid_ttl")) {
1368             monitor_set_invalid_ttl_to_controller(vconn);
1369         } else if (!strncmp(arg, "watch:", 6)) {
1370             struct ofputil_flow_monitor_request fmr;
1371             struct ofpbuf *msg;
1372
1373             parse_flow_monitor_request(&fmr, arg + 6);
1374
1375             msg = ofpbuf_new(0);
1376             ofputil_append_flow_monitor_request(&fmr, msg);
1377             dump_stats_transaction(vconn, msg);
1378         } else {
1379             ovs_fatal(0, "%s: unsupported \"monitor\" argument", arg);
1380         }
1381     }
1382
1383     if (preferred_packet_in_format >= 0) {
1384         set_packet_in_format(vconn, preferred_packet_in_format);
1385     } else {
1386         struct ofpbuf *spif, *reply;
1387
1388         spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1389                                                  NXPIF_NXM);
1390         run(vconn_transact_noreply(vconn, spif, &reply),
1391             "talking to %s", vconn_get_name(vconn));
1392         if (reply) {
1393             char *s = ofp_to_string(reply->data, reply->size, 2);
1394             VLOG_DBG("%s: failed to set packet in format to nxm, controller"
1395                      " replied: %s. Falling back to the switch default.",
1396                      vconn_get_name(vconn), s);
1397             free(s);
1398             ofpbuf_delete(reply);
1399         }
1400     }
1401
1402     monitor_vconn(vconn);
1403 }
1404
1405 static void
1406 ofctl_snoop(int argc OVS_UNUSED, char *argv[])
1407 {
1408     struct vconn *vconn;
1409
1410     open_vconn__(argv[1], "snoop", &vconn);
1411     monitor_vconn(vconn);
1412 }
1413
1414 static void
1415 ofctl_dump_ports(int argc, char *argv[])
1416 {
1417     struct ofpbuf *request;
1418     struct vconn *vconn;
1419     uint16_t port;
1420
1421     open_vconn(argv[1], &vconn);
1422     port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_NONE;
1423     request = ofputil_encode_dump_ports_request(vconn_get_version(vconn), port);
1424     dump_stats_transaction(vconn, request);
1425     vconn_close(vconn);
1426 }
1427
1428 static void
1429 ofctl_dump_ports_desc(int argc OVS_UNUSED, char *argv[])
1430 {
1431     dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_PORT_DESC_REQUEST);
1432 }
1433
1434 static void
1435 ofctl_probe(int argc OVS_UNUSED, char *argv[])
1436 {
1437     struct ofpbuf *request;
1438     struct vconn *vconn;
1439     struct ofpbuf *reply;
1440
1441     open_vconn(argv[1], &vconn);
1442     request = make_echo_request(vconn_get_version(vconn));
1443     run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1444     if (reply->size != sizeof(struct ofp_header)) {
1445         ovs_fatal(0, "reply does not match request");
1446     }
1447     ofpbuf_delete(reply);
1448     vconn_close(vconn);
1449 }
1450
1451 static void
1452 ofctl_packet_out(int argc, char *argv[])
1453 {
1454     enum ofputil_protocol protocol;
1455     struct ofputil_packet_out po;
1456     struct ofpbuf ofpacts;
1457     struct vconn *vconn;
1458     int i;
1459
1460     ofpbuf_init(&ofpacts, 64);
1461     parse_ofpacts(argv[3], &ofpacts);
1462
1463     po.buffer_id = UINT32_MAX;
1464     po.in_port = str_to_port_no(argv[1], argv[2]);
1465     po.ofpacts = ofpacts.data;
1466     po.ofpacts_len = ofpacts.size;
1467
1468     protocol = open_vconn(argv[1], &vconn);
1469     for (i = 4; i < argc; i++) {
1470         struct ofpbuf *packet, *opo;
1471         const char *error_msg;
1472
1473         error_msg = eth_from_hex(argv[i], &packet);
1474         if (error_msg) {
1475             ovs_fatal(0, "%s", error_msg);
1476         }
1477
1478         po.packet = packet->data;
1479         po.packet_len = packet->size;
1480         opo = ofputil_encode_packet_out(&po, protocol);
1481         transact_noreply(vconn, opo);
1482         ofpbuf_delete(packet);
1483     }
1484     vconn_close(vconn);
1485     ofpbuf_uninit(&ofpacts);
1486 }
1487
1488 static void
1489 ofctl_mod_port(int argc OVS_UNUSED, char *argv[])
1490 {
1491     struct ofp_config_flag {
1492         const char *name;             /* The flag's name. */
1493         enum ofputil_port_config bit; /* Bit to turn on or off. */
1494         bool on;                      /* Value to set the bit to. */
1495     };
1496     static const struct ofp_config_flag flags[] = {
1497         { "up",          OFPUTIL_PC_PORT_DOWN,    false },
1498         { "down",        OFPUTIL_PC_PORT_DOWN,    true  },
1499         { "stp",         OFPUTIL_PC_NO_STP,       false },
1500         { "receive",     OFPUTIL_PC_NO_RECV,      false },
1501         { "receive-stp", OFPUTIL_PC_NO_RECV_STP,  false },
1502         { "flood",       OFPUTIL_PC_NO_FLOOD,     false },
1503         { "forward",     OFPUTIL_PC_NO_FWD,       false },
1504         { "packet-in",   OFPUTIL_PC_NO_PACKET_IN, false },
1505     };
1506
1507     const struct ofp_config_flag *flag;
1508     enum ofputil_protocol protocol;
1509     struct ofputil_port_mod pm;
1510     struct ofputil_phy_port pp;
1511     struct vconn *vconn;
1512     const char *command;
1513     bool not;
1514
1515     fetch_ofputil_phy_port(argv[1], argv[2], &pp);
1516
1517     pm.port_no = pp.port_no;
1518     memcpy(pm.hw_addr, pp.hw_addr, ETH_ADDR_LEN);
1519     pm.config = 0;
1520     pm.mask = 0;
1521     pm.advertise = 0;
1522
1523     if (!strncasecmp(argv[3], "no-", 3)) {
1524         command = argv[3] + 3;
1525         not = true;
1526     } else if (!strncasecmp(argv[3], "no", 2)) {
1527         command = argv[3] + 2;
1528         not = true;
1529     } else {
1530         command = argv[3];
1531         not = false;
1532     }
1533     for (flag = flags; flag < &flags[ARRAY_SIZE(flags)]; flag++) {
1534         if (!strcasecmp(command, flag->name)) {
1535             pm.mask = flag->bit;
1536             pm.config = flag->on ^ not ? flag->bit : 0;
1537             goto found;
1538         }
1539     }
1540     ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
1541
1542 found:
1543     protocol = open_vconn(argv[1], &vconn);
1544     transact_noreply(vconn, ofputil_encode_port_mod(&pm, protocol));
1545     vconn_close(vconn);
1546 }
1547
1548 static void
1549 ofctl_get_frags(int argc OVS_UNUSED, char *argv[])
1550 {
1551     struct ofp_switch_config config;
1552     struct vconn *vconn;
1553
1554     open_vconn(argv[1], &vconn);
1555     fetch_switch_config(vconn, &config);
1556     puts(ofputil_frag_handling_to_string(ntohs(config.flags)));
1557     vconn_close(vconn);
1558 }
1559
1560 static void
1561 ofctl_set_frags(int argc OVS_UNUSED, char *argv[])
1562 {
1563     struct ofp_switch_config config;
1564     enum ofp_config_flags mode;
1565     struct vconn *vconn;
1566     ovs_be16 flags;
1567
1568     if (!ofputil_frag_handling_from_string(argv[2], &mode)) {
1569         ovs_fatal(0, "%s: unknown fragment handling mode", argv[2]);
1570     }
1571
1572     open_vconn(argv[1], &vconn);
1573     fetch_switch_config(vconn, &config);
1574     flags = htons(mode) | (config.flags & htons(~OFPC_FRAG_MASK));
1575     if (flags != config.flags) {
1576         /* Set the configuration. */
1577         config.flags = flags;
1578         set_switch_config(vconn, &config);
1579
1580         /* Then retrieve the configuration to see if it really took.  OpenFlow
1581          * doesn't define error reporting for bad modes, so this is all we can
1582          * do. */
1583         fetch_switch_config(vconn, &config);
1584         if (flags != config.flags) {
1585             ovs_fatal(0, "%s: setting fragment handling mode failed (this "
1586                       "switch probably doesn't support mode \"%s\")",
1587                       argv[1], ofputil_frag_handling_to_string(mode));
1588         }
1589     }
1590     vconn_close(vconn);
1591 }
1592
1593 static void
1594 ofctl_ping(int argc, char *argv[])
1595 {
1596     size_t max_payload = 65535 - sizeof(struct ofp_header);
1597     unsigned int payload;
1598     struct vconn *vconn;
1599     int i;
1600
1601     payload = argc > 2 ? atoi(argv[2]) : 64;
1602     if (payload > max_payload) {
1603         ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1604     }
1605
1606     open_vconn(argv[1], &vconn);
1607     for (i = 0; i < 10; i++) {
1608         struct timeval start, end;
1609         struct ofpbuf *request, *reply;
1610         const struct ofp_header *rpy_hdr;
1611         enum ofptype type;
1612
1613         request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST, OFP10_VERSION,
1614                                payload);
1615         random_bytes(ofpbuf_put_uninit(request, payload), payload);
1616
1617         xgettimeofday(&start);
1618         run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
1619         xgettimeofday(&end);
1620
1621         rpy_hdr = reply->data;
1622         if (ofptype_pull(&type, reply)
1623             || type != OFPTYPE_ECHO_REPLY
1624             || reply->size != payload
1625             || memcmp(request->l3, reply->l3, payload)) {
1626             printf("Reply does not match request.  Request:\n");
1627             ofp_print(stdout, request, request->size, verbosity + 2);
1628             printf("Reply:\n");
1629             ofp_print(stdout, reply, reply->size, verbosity + 2);
1630         }
1631         printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
1632                reply->size, argv[1], ntohl(rpy_hdr->xid),
1633                    (1000*(double)(end.tv_sec - start.tv_sec))
1634                    + (.001*(end.tv_usec - start.tv_usec)));
1635         ofpbuf_delete(request);
1636         ofpbuf_delete(reply);
1637     }
1638     vconn_close(vconn);
1639 }
1640
1641 static void
1642 ofctl_benchmark(int argc OVS_UNUSED, char *argv[])
1643 {
1644     size_t max_payload = 65535 - sizeof(struct ofp_header);
1645     struct timeval start, end;
1646     unsigned int payload_size, message_size;
1647     struct vconn *vconn;
1648     double duration;
1649     int count;
1650     int i;
1651
1652     payload_size = atoi(argv[2]);
1653     if (payload_size > max_payload) {
1654         ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1655     }
1656     message_size = sizeof(struct ofp_header) + payload_size;
1657
1658     count = atoi(argv[3]);
1659
1660     printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
1661            count, message_size, count * message_size);
1662
1663     open_vconn(argv[1], &vconn);
1664     xgettimeofday(&start);
1665     for (i = 0; i < count; i++) {
1666         struct ofpbuf *request, *reply;
1667
1668         request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST, OFP10_VERSION,
1669                                payload_size);
1670         ofpbuf_put_zeros(request, payload_size);
1671         run(vconn_transact(vconn, request, &reply), "transact");
1672         ofpbuf_delete(reply);
1673     }
1674     xgettimeofday(&end);
1675     vconn_close(vconn);
1676
1677     duration = ((1000*(double)(end.tv_sec - start.tv_sec))
1678                 + (.001*(end.tv_usec - start.tv_usec)));
1679     printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
1680            duration, count / (duration / 1000.0),
1681            count * message_size / (duration / 1000.0));
1682 }
1683
1684 static void
1685 ofctl_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1686 {
1687     usage();
1688 }
1689 \f
1690 /* replace-flows and diff-flows commands. */
1691
1692 /* A flow table entry, possibly with two different versions. */
1693 struct fte {
1694     struct cls_rule rule;       /* Within a "struct classifier". */
1695     struct fte_version *versions[2];
1696 };
1697
1698 /* One version of a Flow Table Entry. */
1699 struct fte_version {
1700     ovs_be64 cookie;
1701     uint16_t idle_timeout;
1702     uint16_t hard_timeout;
1703     uint16_t flags;
1704     struct ofpact *ofpacts;
1705     size_t ofpacts_len;
1706 };
1707
1708 /* Frees 'version' and the data that it owns. */
1709 static void
1710 fte_version_free(struct fte_version *version)
1711 {
1712     if (version) {
1713         free(version->ofpacts);
1714         free(version);
1715     }
1716 }
1717
1718 /* Returns true if 'a' and 'b' are the same, false if they differ.
1719  *
1720  * Ignores differences in 'flags' because there's no way to retrieve flags from
1721  * an OpenFlow switch.  We have to assume that they are the same. */
1722 static bool
1723 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
1724 {
1725     return (a->cookie == b->cookie
1726             && a->idle_timeout == b->idle_timeout
1727             && a->hard_timeout == b->hard_timeout
1728             && ofpacts_equal(a->ofpacts, a->ofpacts_len,
1729                              b->ofpacts, b->ofpacts_len));
1730 }
1731
1732 /* Clears 's', then if 's' has a version 'index', formats 'fte' and version
1733  * 'index' into 's', followed by a new-line. */
1734 static void
1735 fte_version_format(const struct fte *fte, int index, struct ds *s)
1736 {
1737     const struct fte_version *version = fte->versions[index];
1738
1739     ds_clear(s);
1740     if (!version) {
1741         return;
1742     }
1743
1744     cls_rule_format(&fte->rule, s);
1745     if (version->cookie != htonll(0)) {
1746         ds_put_format(s, " cookie=0x%"PRIx64, ntohll(version->cookie));
1747     }
1748     if (version->idle_timeout != OFP_FLOW_PERMANENT) {
1749         ds_put_format(s, " idle_timeout=%"PRIu16, version->idle_timeout);
1750     }
1751     if (version->hard_timeout != OFP_FLOW_PERMANENT) {
1752         ds_put_format(s, " hard_timeout=%"PRIu16, version->hard_timeout);
1753     }
1754
1755     ds_put_char(s, ' ');
1756     ofpacts_format(version->ofpacts, version->ofpacts_len, s);
1757
1758     ds_put_char(s, '\n');
1759 }
1760
1761 static struct fte *
1762 fte_from_cls_rule(const struct cls_rule *cls_rule)
1763 {
1764     return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
1765 }
1766
1767 /* Frees 'fte' and its versions. */
1768 static void
1769 fte_free(struct fte *fte)
1770 {
1771     if (fte) {
1772         fte_version_free(fte->versions[0]);
1773         fte_version_free(fte->versions[1]);
1774         cls_rule_destroy(&fte->rule);
1775         free(fte);
1776     }
1777 }
1778
1779 /* Frees all of the FTEs within 'cls'. */
1780 static void
1781 fte_free_all(struct classifier *cls)
1782 {
1783     struct cls_cursor cursor;
1784     struct fte *fte, *next;
1785
1786     cls_cursor_init(&cursor, cls, NULL);
1787     CLS_CURSOR_FOR_EACH_SAFE (fte, next, rule, &cursor) {
1788         classifier_remove(cls, &fte->rule);
1789         fte_free(fte);
1790     }
1791     classifier_destroy(cls);
1792 }
1793
1794 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
1795  * necessary.  Sets 'version' as the version of that rule with the given
1796  * 'index', replacing any existing version, if any.
1797  *
1798  * Takes ownership of 'version'. */
1799 static void
1800 fte_insert(struct classifier *cls, const struct match *match,
1801            unsigned int priority, struct fte_version *version, int index)
1802 {
1803     struct fte *old, *fte;
1804
1805     fte = xzalloc(sizeof *fte);
1806     cls_rule_init(&fte->rule, match, priority);
1807     fte->versions[index] = version;
1808
1809     old = fte_from_cls_rule(classifier_replace(cls, &fte->rule));
1810     if (old) {
1811         fte_version_free(old->versions[index]);
1812         fte->versions[!index] = old->versions[!index];
1813         cls_rule_destroy(&old->rule);
1814         free(old);
1815     }
1816 }
1817
1818 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
1819  * with the specified 'index'.  Returns the flow formats able to represent the
1820  * flows that were read. */
1821 static enum ofputil_protocol
1822 read_flows_from_file(const char *filename, struct classifier *cls, int index)
1823 {
1824     enum ofputil_protocol usable_protocols;
1825     struct ds s;
1826     FILE *file;
1827
1828     file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1829     if (file == NULL) {
1830         ovs_fatal(errno, "%s: open", filename);
1831     }
1832
1833     ds_init(&s);
1834     usable_protocols = OFPUTIL_P_ANY;
1835     while (!ds_get_preprocessed_line(&s, file)) {
1836         struct fte_version *version;
1837         struct ofputil_flow_mod fm;
1838
1839         parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), true);
1840
1841         version = xmalloc(sizeof *version);
1842         version->cookie = fm.new_cookie;
1843         version->idle_timeout = fm.idle_timeout;
1844         version->hard_timeout = fm.hard_timeout;
1845         version->flags = fm.flags & (OFPFF_SEND_FLOW_REM | OFPFF10_EMERG);
1846         version->ofpacts = fm.ofpacts;
1847         version->ofpacts_len = fm.ofpacts_len;
1848
1849         usable_protocols &= ofputil_usable_protocols(&fm.match);
1850
1851         fte_insert(cls, &fm.match, fm.priority, version, index);
1852     }
1853     ds_destroy(&s);
1854
1855     if (file != stdin) {
1856         fclose(file);
1857     }
1858
1859     return usable_protocols;
1860 }
1861
1862 static bool
1863 recv_flow_stats_reply(struct vconn *vconn, ovs_be32 send_xid,
1864                       struct ofpbuf **replyp,
1865                       struct ofputil_flow_stats *fs, struct ofpbuf *ofpacts)
1866 {
1867     struct ofpbuf *reply = *replyp;
1868
1869     for (;;) {
1870         int retval;
1871         bool more;
1872
1873         /* Get a flow stats reply message, if we don't already have one. */
1874         if (!reply) {
1875             enum ofptype type;
1876             enum ofperr error;
1877
1878             do {
1879                 run(vconn_recv_block(vconn, &reply),
1880                     "OpenFlow packet receive failed");
1881             } while (((struct ofp_header *) reply->data)->xid != send_xid);
1882
1883             error = ofptype_decode(&type, reply->data);
1884             if (error || type != OFPTYPE_FLOW_STATS_REPLY) {
1885                 ovs_fatal(0, "received bad reply: %s",
1886                           ofp_to_string(reply->data, reply->size,
1887                                         verbosity + 1));
1888             }
1889         }
1890
1891         /* Pull an individual flow stats reply out of the message. */
1892         retval = ofputil_decode_flow_stats_reply(fs, reply, false, ofpacts);
1893         switch (retval) {
1894         case 0:
1895             *replyp = reply;
1896             return true;
1897
1898         case EOF:
1899             more = ofpmp_more(reply->l2);
1900             ofpbuf_delete(reply);
1901             reply = NULL;
1902             if (!more) {
1903                 *replyp = NULL;
1904                 return false;
1905             }
1906             break;
1907
1908         default:
1909             ovs_fatal(0, "parse error in reply (%s)",
1910                       ofperr_to_string(retval));
1911         }
1912     }
1913 }
1914
1915 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
1916  * format 'protocol', and adds them as flow table entries in 'cls' for the
1917  * version with the specified 'index'. */
1918 static void
1919 read_flows_from_switch(struct vconn *vconn,
1920                        enum ofputil_protocol protocol,
1921                        struct classifier *cls, int index)
1922 {
1923     struct ofputil_flow_stats_request fsr;
1924     struct ofputil_flow_stats fs;
1925     struct ofpbuf *request;
1926     struct ofpbuf ofpacts;
1927     struct ofpbuf *reply;
1928     ovs_be32 send_xid;
1929
1930     fsr.aggregate = false;
1931     match_init_catchall(&fsr.match);
1932     fsr.out_port = OFPP_NONE;
1933     fsr.table_id = 0xff;
1934     fsr.cookie = fsr.cookie_mask = htonll(0);
1935     request = ofputil_encode_flow_stats_request(&fsr, protocol);
1936     send_xid = ((struct ofp_header *) request->data)->xid;
1937     send_openflow_buffer(vconn, request);
1938
1939     reply = NULL;
1940     ofpbuf_init(&ofpacts, 0);
1941     while (recv_flow_stats_reply(vconn, send_xid, &reply, &fs, &ofpacts)) {
1942         struct fte_version *version;
1943
1944         version = xmalloc(sizeof *version);
1945         version->cookie = fs.cookie;
1946         version->idle_timeout = fs.idle_timeout;
1947         version->hard_timeout = fs.hard_timeout;
1948         version->flags = 0;
1949         version->ofpacts_len = fs.ofpacts_len;
1950         version->ofpacts = xmemdup(fs.ofpacts, fs.ofpacts_len);
1951
1952         fte_insert(cls, &fs.match, fs.priority, version, index);
1953     }
1954     ofpbuf_uninit(&ofpacts);
1955 }
1956
1957 static void
1958 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
1959                   enum ofputil_protocol protocol, struct list *packets)
1960 {
1961     const struct fte_version *version = fte->versions[index];
1962     struct ofputil_flow_mod fm;
1963     struct ofpbuf *ofm;
1964
1965     minimatch_expand(&fte->rule.match, &fm.match);
1966     fm.priority = fte->rule.priority;
1967     fm.cookie = htonll(0);
1968     fm.cookie_mask = htonll(0);
1969     fm.new_cookie = version->cookie;
1970     fm.table_id = 0xff;
1971     fm.command = command;
1972     fm.idle_timeout = version->idle_timeout;
1973     fm.hard_timeout = version->hard_timeout;
1974     fm.buffer_id = UINT32_MAX;
1975     fm.out_port = OFPP_NONE;
1976     fm.flags = version->flags;
1977     if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
1978         command == OFPFC_MODIFY_STRICT) {
1979         fm.ofpacts = version->ofpacts;
1980         fm.ofpacts_len = version->ofpacts_len;
1981     } else {
1982         fm.ofpacts = NULL;
1983         fm.ofpacts_len = 0;
1984     }
1985
1986     ofm = ofputil_encode_flow_mod(&fm, protocol);
1987     list_push_back(packets, &ofm->list_node);
1988 }
1989
1990 static void
1991 ofctl_replace_flows(int argc OVS_UNUSED, char *argv[])
1992 {
1993     enum { FILE_IDX = 0, SWITCH_IDX = 1 };
1994     enum ofputil_protocol usable_protocols, protocol;
1995     struct cls_cursor cursor;
1996     struct classifier cls;
1997     struct list requests;
1998     struct vconn *vconn;
1999     struct fte *fte;
2000
2001     classifier_init(&cls);
2002     usable_protocols = read_flows_from_file(argv[2], &cls, FILE_IDX);
2003
2004     protocol = open_vconn(argv[1], &vconn);
2005     protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
2006
2007     read_flows_from_switch(vconn, protocol, &cls, SWITCH_IDX);
2008
2009     list_init(&requests);
2010
2011     /* Delete flows that exist on the switch but not in the file. */
2012     cls_cursor_init(&cursor, &cls, NULL);
2013     CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2014         struct fte_version *file_ver = fte->versions[FILE_IDX];
2015         struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2016
2017         if (sw_ver && !file_ver) {
2018             fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
2019                               protocol, &requests);
2020         }
2021     }
2022
2023     /* Add flows that exist in the file but not on the switch.
2024      * Update flows that exist in both places but differ. */
2025     cls_cursor_init(&cursor, &cls, NULL);
2026     CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2027         struct fte_version *file_ver = fte->versions[FILE_IDX];
2028         struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2029
2030         if (file_ver
2031             && (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
2032             fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, protocol, &requests);
2033         }
2034     }
2035     transact_multiple_noreply(vconn, &requests);
2036     vconn_close(vconn);
2037
2038     fte_free_all(&cls);
2039 }
2040
2041 static void
2042 read_flows_from_source(const char *source, struct classifier *cls, int index)
2043 {
2044     struct stat s;
2045
2046     if (source[0] == '/' || source[0] == '.'
2047         || (!strchr(source, ':') && !stat(source, &s))) {
2048         read_flows_from_file(source, cls, index);
2049     } else {
2050         enum ofputil_protocol protocol;
2051         struct vconn *vconn;
2052
2053         protocol = open_vconn(source, &vconn);
2054         protocol = set_protocol_for_flow_dump(vconn, protocol, OFPUTIL_P_ANY);
2055         read_flows_from_switch(vconn, protocol, cls, index);
2056         vconn_close(vconn);
2057     }
2058 }
2059
2060 static void
2061 ofctl_diff_flows(int argc OVS_UNUSED, char *argv[])
2062 {
2063     bool differences = false;
2064     struct cls_cursor cursor;
2065     struct classifier cls;
2066     struct ds a_s, b_s;
2067     struct fte *fte;
2068
2069     classifier_init(&cls);
2070     read_flows_from_source(argv[1], &cls, 0);
2071     read_flows_from_source(argv[2], &cls, 1);
2072
2073     ds_init(&a_s);
2074     ds_init(&b_s);
2075
2076     cls_cursor_init(&cursor, &cls, NULL);
2077     CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2078         struct fte_version *a = fte->versions[0];
2079         struct fte_version *b = fte->versions[1];
2080
2081         if (!a || !b || !fte_version_equals(a, b)) {
2082             fte_version_format(fte, 0, &a_s);
2083             fte_version_format(fte, 1, &b_s);
2084             if (strcmp(ds_cstr(&a_s), ds_cstr(&b_s))) {
2085                 if (a_s.length) {
2086                     printf("-%s", ds_cstr(&a_s));
2087                 }
2088                 if (b_s.length) {
2089                     printf("+%s", ds_cstr(&b_s));
2090                 }
2091                 differences = true;
2092             }
2093         }
2094     }
2095
2096     ds_destroy(&a_s);
2097     ds_destroy(&b_s);
2098
2099     fte_free_all(&cls);
2100
2101     if (differences) {
2102         exit(2);
2103     }
2104 }
2105 \f
2106 /* Undocumented commands for unit testing. */
2107
2108 static void
2109 ofctl_parse_flows__(struct ofputil_flow_mod *fms, size_t n_fms)
2110 {
2111     enum ofputil_protocol usable_protocols;
2112     enum ofputil_protocol protocol = 0;
2113     char *usable_s;
2114     size_t i;
2115
2116     usable_protocols = ofputil_flow_mod_usable_protocols(fms, n_fms);
2117     usable_s = ofputil_protocols_to_string(usable_protocols);
2118     printf("usable protocols: %s\n", usable_s);
2119     free(usable_s);
2120
2121     if (!(usable_protocols & allowed_protocols)) {
2122         ovs_fatal(0, "no usable protocol");
2123     }
2124     for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
2125         protocol = 1 << i;
2126         if (protocol & usable_protocols & allowed_protocols) {
2127             break;
2128         }
2129     }
2130     assert(IS_POW2(protocol));
2131
2132     printf("chosen protocol: %s\n", ofputil_protocol_to_string(protocol));
2133
2134     for (i = 0; i < n_fms; i++) {
2135         struct ofputil_flow_mod *fm = &fms[i];
2136         struct ofpbuf *msg;
2137
2138         msg = ofputil_encode_flow_mod(fm, protocol);
2139         ofp_print(stdout, msg->data, msg->size, verbosity);
2140         ofpbuf_delete(msg);
2141
2142         free(fm->ofpacts);
2143     }
2144 }
2145
2146 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
2147  * it back to stdout.  */
2148 static void
2149 ofctl_parse_flow(int argc OVS_UNUSED, char *argv[])
2150 {
2151     struct ofputil_flow_mod fm;
2152
2153     parse_ofp_flow_mod_str(&fm, argv[1], OFPFC_ADD, false);
2154     ofctl_parse_flows__(&fm, 1);
2155 }
2156
2157 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
2158  * add-flows) and prints each of the flows back to stdout.  */
2159 static void
2160 ofctl_parse_flows(int argc OVS_UNUSED, char *argv[])
2161 {
2162     struct ofputil_flow_mod *fms = NULL;
2163     size_t n_fms = 0;
2164
2165     parse_ofp_flow_mod_file(argv[1], OFPFC_ADD, &fms, &n_fms);
2166     ofctl_parse_flows__(fms, n_fms);
2167     free(fms);
2168 }
2169
2170 static void
2171 ofctl_parse_nxm__(bool oxm)
2172 {
2173     struct ds in;
2174
2175     ds_init(&in);
2176     while (!ds_get_test_line(&in, stdin)) {
2177         struct ofpbuf nx_match;
2178         struct match match;
2179         ovs_be64 cookie, cookie_mask;
2180         enum ofperr error;
2181         int match_len;
2182
2183         /* Convert string to nx_match. */
2184         ofpbuf_init(&nx_match, 0);
2185         if (oxm) {
2186             match_len = oxm_match_from_string(ds_cstr(&in), &nx_match);
2187         } else {
2188             match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
2189         }
2190
2191         /* Convert nx_match to match. */
2192         if (strict) {
2193             if (oxm) {
2194                 error = oxm_pull_match(&nx_match, &match);
2195             } else {
2196                 error = nx_pull_match(&nx_match, match_len, &match,
2197                                       &cookie, &cookie_mask);
2198             }
2199         } else {
2200             if (oxm) {
2201                 error = oxm_pull_match_loose(&nx_match, &match);
2202             } else {
2203                 error = nx_pull_match_loose(&nx_match, match_len, &match,
2204                                             &cookie, &cookie_mask);
2205             }
2206         }
2207
2208
2209         if (!error) {
2210             char *out;
2211
2212             /* Convert match back to nx_match. */
2213             ofpbuf_uninit(&nx_match);
2214             ofpbuf_init(&nx_match, 0);
2215             if (oxm) {
2216                 match_len = oxm_put_match(&nx_match, &match);
2217                 out = oxm_match_to_string(nx_match.data, match_len);
2218             } else {
2219                 match_len = nx_put_match(&nx_match, &match,
2220                                          cookie, cookie_mask);
2221                 out = nx_match_to_string(nx_match.data, match_len);
2222             }
2223
2224             puts(out);
2225             free(out);
2226         } else {
2227             printf("nx_pull_match() returned error %s\n",
2228                    ofperr_get_name(error));
2229         }
2230
2231         ofpbuf_uninit(&nx_match);
2232     }
2233     ds_destroy(&in);
2234 }
2235
2236 /* "parse-nxm": reads a series of NXM nx_match specifications as strings from
2237  * stdin, does some internal fussing with them, and then prints them back as
2238  * strings on stdout. */
2239 static void
2240 ofctl_parse_nxm(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2241 {
2242     return ofctl_parse_nxm__(false);
2243 }
2244
2245 /* "parse-oxm": reads a series of OXM nx_match specifications as strings from
2246  * stdin, does some internal fussing with them, and then prints them back as
2247  * strings on stdout. */
2248 static void
2249 ofctl_parse_oxm(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2250 {
2251     return ofctl_parse_nxm__(true);
2252 }
2253
2254 static void
2255 print_differences(const char *prefix,
2256                   const void *a_, size_t a_len,
2257                   const void *b_, size_t b_len)
2258 {
2259     const uint8_t *a = a_;
2260     const uint8_t *b = b_;
2261     size_t i;
2262
2263     for (i = 0; i < MIN(a_len, b_len); i++) {
2264         if (a[i] != b[i]) {
2265             printf("%s%2zu: %02"PRIx8" -> %02"PRIx8"\n",
2266                    prefix, i, a[i], b[i]);
2267         }
2268     }
2269     for (i = a_len; i < b_len; i++) {
2270         printf("%s%2zu: (none) -> %02"PRIx8"\n", prefix, i, b[i]);
2271     }
2272     for (i = b_len; i < a_len; i++) {
2273         printf("%s%2zu: %02"PRIx8" -> (none)\n", prefix, i, a[i]);
2274     }
2275 }
2276
2277 /* "parse-ofp10-actions": reads a series of OpenFlow 1.0 action specifications
2278  * as hex bytes from stdin, converts them to ofpacts, prints them as strings
2279  * on stdout, and then converts them back to hex bytes and prints any
2280  * differences from the input. */
2281 static void
2282 ofctl_parse_ofp10_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2283 {
2284     struct ds in;
2285
2286     ds_init(&in);
2287     while (!ds_get_preprocessed_line(&in, stdin)) {
2288         struct ofpbuf of10_out;
2289         struct ofpbuf of10_in;
2290         struct ofpbuf ofpacts;
2291         enum ofperr error;
2292         size_t size;
2293         struct ds s;
2294
2295         /* Parse hex bytes. */
2296         ofpbuf_init(&of10_in, 0);
2297         if (ofpbuf_put_hex(&of10_in, ds_cstr(&in), NULL)[0] != '\0') {
2298             ovs_fatal(0, "Trailing garbage in hex data");
2299         }
2300
2301         /* Convert to ofpacts. */
2302         ofpbuf_init(&ofpacts, 0);
2303         size = of10_in.size;
2304         error = ofpacts_pull_openflow10(&of10_in, of10_in.size, &ofpacts);
2305         if (error) {
2306             printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error));
2307             ofpbuf_uninit(&ofpacts);
2308             ofpbuf_uninit(&of10_in);
2309             continue;
2310         }
2311         ofpbuf_push_uninit(&of10_in, size);
2312
2313         /* Print cls_rule. */
2314         ds_init(&s);
2315         ofpacts_format(ofpacts.data, ofpacts.size, &s);
2316         puts(ds_cstr(&s));
2317         ds_destroy(&s);
2318
2319         /* Convert back to ofp10 actions and print differences from input. */
2320         ofpbuf_init(&of10_out, 0);
2321         ofpacts_put_openflow10(ofpacts.data, ofpacts.size, &of10_out);
2322
2323         print_differences("", of10_in.data, of10_in.size,
2324                           of10_out.data, of10_out.size);
2325         putchar('\n');
2326
2327         ofpbuf_uninit(&ofpacts);
2328         ofpbuf_uninit(&of10_in);
2329         ofpbuf_uninit(&of10_out);
2330     }
2331     ds_destroy(&in);
2332 }
2333
2334 /* "parse-ofp10-match": reads a series of ofp10_match specifications as hex
2335  * bytes from stdin, converts them to cls_rules, prints them as strings on
2336  * stdout, and then converts them back to hex bytes and prints any differences
2337  * from the input.
2338  *
2339  * The input hex bytes may contain "x"s to represent "don't-cares", bytes whose
2340  * values are ignored in the input and will be set to zero when OVS converts
2341  * them back to hex bytes.  ovs-ofctl actually sets "x"s to random bits when
2342  * it does the conversion to hex, to ensure that in fact they are ignored. */
2343 static void
2344 ofctl_parse_ofp10_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2345 {
2346     struct ds expout;
2347     struct ds in;
2348
2349     ds_init(&in);
2350     ds_init(&expout);
2351     while (!ds_get_preprocessed_line(&in, stdin)) {
2352         struct ofpbuf match_in, match_expout;
2353         struct ofp10_match match_out;
2354         struct ofp10_match match_normal;
2355         struct match match;
2356         char *p;
2357
2358         /* Parse hex bytes to use for expected output. */
2359         ds_clear(&expout);
2360         ds_put_cstr(&expout, ds_cstr(&in));
2361         for (p = ds_cstr(&expout); *p; p++) {
2362             if (*p == 'x') {
2363                 *p = '0';
2364             }
2365         }
2366         ofpbuf_init(&match_expout, 0);
2367         if (ofpbuf_put_hex(&match_expout, ds_cstr(&expout), NULL)[0] != '\0') {
2368             ovs_fatal(0, "Trailing garbage in hex data");
2369         }
2370         if (match_expout.size != sizeof(struct ofp10_match)) {
2371             ovs_fatal(0, "Input is %zu bytes, expected %zu",
2372                       match_expout.size, sizeof(struct ofp10_match));
2373         }
2374
2375         /* Parse hex bytes for input. */
2376         for (p = ds_cstr(&in); *p; p++) {
2377             if (*p == 'x') {
2378                 *p = "0123456789abcdef"[random_uint32() & 0xf];
2379             }
2380         }
2381         ofpbuf_init(&match_in, 0);
2382         if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
2383             ovs_fatal(0, "Trailing garbage in hex data");
2384         }
2385         if (match_in.size != sizeof(struct ofp10_match)) {
2386             ovs_fatal(0, "Input is %zu bytes, expected %zu",
2387                       match_in.size, sizeof(struct ofp10_match));
2388         }
2389
2390         /* Convert to cls_rule and print. */
2391         ofputil_match_from_ofp10_match(match_in.data, &match);
2392         match_print(&match);
2393
2394         /* Convert back to ofp10_match and print differences from input. */
2395         ofputil_match_to_ofp10_match(&match, &match_out);
2396         print_differences("", match_expout.data, match_expout.size,
2397                           &match_out, sizeof match_out);
2398
2399         /* Normalize, then convert and compare again. */
2400         ofputil_normalize_match(&match);
2401         ofputil_match_to_ofp10_match(&match, &match_normal);
2402         print_differences("normal: ", &match_out, sizeof match_out,
2403                           &match_normal, sizeof match_normal);
2404         putchar('\n');
2405
2406         ofpbuf_uninit(&match_in);
2407         ofpbuf_uninit(&match_expout);
2408     }
2409     ds_destroy(&in);
2410     ds_destroy(&expout);
2411 }
2412
2413 /* "parse-ofp11-match": reads a series of ofp11_match specifications as hex
2414  * bytes from stdin, converts them to "struct match"es, prints them as strings
2415  * on stdout, and then converts them back to hex bytes and prints any
2416  * differences from the input. */
2417 static void
2418 ofctl_parse_ofp11_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2419 {
2420     struct ds in;
2421
2422     ds_init(&in);
2423     while (!ds_get_preprocessed_line(&in, stdin)) {
2424         struct ofpbuf match_in;
2425         struct ofp11_match match_out;
2426         struct match match;
2427         enum ofperr error;
2428
2429         /* Parse hex bytes. */
2430         ofpbuf_init(&match_in, 0);
2431         if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
2432             ovs_fatal(0, "Trailing garbage in hex data");
2433         }
2434         if (match_in.size != sizeof(struct ofp11_match)) {
2435             ovs_fatal(0, "Input is %zu bytes, expected %zu",
2436                       match_in.size, sizeof(struct ofp11_match));
2437         }
2438
2439         /* Convert to match. */
2440         error = ofputil_match_from_ofp11_match(match_in.data, &match);
2441         if (error) {
2442             printf("bad ofp11_match: %s\n\n", ofperr_get_name(error));
2443             ofpbuf_uninit(&match_in);
2444             continue;
2445         }
2446
2447         /* Print match. */
2448         match_print(&match);
2449
2450         /* Convert back to ofp11_match and print differences from input. */
2451         ofputil_match_to_ofp11_match(&match, &match_out);
2452
2453         print_differences("", match_in.data, match_in.size,
2454                           &match_out, sizeof match_out);
2455         putchar('\n');
2456
2457         ofpbuf_uninit(&match_in);
2458     }
2459     ds_destroy(&in);
2460 }
2461
2462 /* "parse-ofp11-actions": reads a series of OpenFlow 1.1 action specifications
2463  * as hex bytes from stdin, converts them to ofpacts, prints them as strings
2464  * on stdout, and then converts them back to hex bytes and prints any
2465  * differences from the input. */
2466 static void
2467 ofctl_parse_ofp11_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2468 {
2469     struct ds in;
2470
2471     ds_init(&in);
2472     while (!ds_get_preprocessed_line(&in, stdin)) {
2473         struct ofpbuf of11_out;
2474         struct ofpbuf of11_in;
2475         struct ofpbuf ofpacts;
2476         enum ofperr error;
2477         size_t size;
2478         struct ds s;
2479
2480         /* Parse hex bytes. */
2481         ofpbuf_init(&of11_in, 0);
2482         if (ofpbuf_put_hex(&of11_in, ds_cstr(&in), NULL)[0] != '\0') {
2483             ovs_fatal(0, "Trailing garbage in hex data");
2484         }
2485
2486         /* Convert to ofpacts. */
2487         ofpbuf_init(&ofpacts, 0);
2488         size = of11_in.size;
2489         error = ofpacts_pull_openflow11_actions(&of11_in, of11_in.size,
2490                                                 &ofpacts);
2491         if (error) {
2492             printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error));
2493             ofpbuf_uninit(&ofpacts);
2494             ofpbuf_uninit(&of11_in);
2495             continue;
2496         }
2497         ofpbuf_push_uninit(&of11_in, size);
2498
2499         /* Print cls_rule. */
2500         ds_init(&s);
2501         ofpacts_format(ofpacts.data, ofpacts.size, &s);
2502         puts(ds_cstr(&s));
2503         ds_destroy(&s);
2504
2505         /* Convert back to ofp11 actions and print differences from input. */
2506         ofpbuf_init(&of11_out, 0);
2507         ofpacts_put_openflow11_actions(ofpacts.data, ofpacts.size, &of11_out);
2508
2509         print_differences("", of11_in.data, of11_in.size,
2510                           of11_out.data, of11_out.size);
2511         putchar('\n');
2512
2513         ofpbuf_uninit(&ofpacts);
2514         ofpbuf_uninit(&of11_in);
2515         ofpbuf_uninit(&of11_out);
2516     }
2517     ds_destroy(&in);
2518 }
2519
2520 /* "parse-ofp11-instructions": reads a series of OpenFlow 1.1 instruction
2521  * specifications as hex bytes from stdin, converts them to ofpacts, prints
2522  * them as strings on stdout, and then converts them back to hex bytes and
2523  * prints any differences from the input. */
2524 static void
2525 ofctl_parse_ofp11_instructions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2526 {
2527     struct ds in;
2528
2529     ds_init(&in);
2530     while (!ds_get_preprocessed_line(&in, stdin)) {
2531         struct ofpbuf of11_out;
2532         struct ofpbuf of11_in;
2533         struct ofpbuf ofpacts;
2534         enum ofperr error;
2535         size_t size;
2536         struct ds s;
2537
2538         /* Parse hex bytes. */
2539         ofpbuf_init(&of11_in, 0);
2540         if (ofpbuf_put_hex(&of11_in, ds_cstr(&in), NULL)[0] != '\0') {
2541             ovs_fatal(0, "Trailing garbage in hex data");
2542         }
2543
2544         /* Convert to ofpacts. */
2545         ofpbuf_init(&ofpacts, 0);
2546         size = of11_in.size;
2547         error = ofpacts_pull_openflow11_instructions(&of11_in, of11_in.size,
2548                                                      &ofpacts);
2549         if (error) {
2550             printf("bad OF1.1 instructions: %s\n\n", ofperr_get_name(error));
2551             ofpbuf_uninit(&ofpacts);
2552             ofpbuf_uninit(&of11_in);
2553             continue;
2554         }
2555         ofpbuf_push_uninit(&of11_in, size);
2556
2557         /* Print cls_rule. */
2558         ds_init(&s);
2559         ofpacts_format(ofpacts.data, ofpacts.size, &s);
2560         puts(ds_cstr(&s));
2561         ds_destroy(&s);
2562
2563         /* Convert back to ofp11 instructions and print differences from
2564          * input. */
2565         ofpbuf_init(&of11_out, 0);
2566         ofpacts_put_openflow11_instructions(ofpacts.data, ofpacts.size,
2567                                             &of11_out);
2568
2569         print_differences("", of11_in.data, of11_in.size,
2570                           of11_out.data, of11_out.size);
2571         putchar('\n');
2572
2573         ofpbuf_uninit(&ofpacts);
2574         ofpbuf_uninit(&of11_in);
2575         ofpbuf_uninit(&of11_out);
2576     }
2577     ds_destroy(&in);
2578 }
2579
2580 /* "check-vlan VLAN_TCI VLAN_TCI_MASK": converts the specified vlan_tci and
2581  * mask values to and from various formats and prints the results. */
2582 static void
2583 ofctl_check_vlan(int argc OVS_UNUSED, char *argv[])
2584 {
2585     struct match match;
2586
2587     char *string_s;
2588     struct ofputil_flow_mod fm;
2589
2590     struct ofpbuf nxm;
2591     struct match nxm_match;
2592     int nxm_match_len;
2593     char *nxm_s;
2594
2595     struct ofp10_match of10_raw;
2596     struct match of10_match;
2597
2598     struct ofp11_match of11_raw;
2599     struct match of11_match;
2600
2601     enum ofperr error;
2602
2603     match_init_catchall(&match);
2604     match.flow.vlan_tci = htons(strtoul(argv[1], NULL, 16));
2605     match.wc.masks.vlan_tci = htons(strtoul(argv[2], NULL, 16));
2606
2607     /* Convert to and from string. */
2608     string_s = match_to_string(&match, OFP_DEFAULT_PRIORITY);
2609     printf("%s -> ", string_s);
2610     fflush(stdout);
2611     parse_ofp_str(&fm, -1, string_s, false);
2612     printf("%04"PRIx16"/%04"PRIx16"\n",
2613            ntohs(fm.match.flow.vlan_tci),
2614            ntohs(fm.match.wc.masks.vlan_tci));
2615     free(string_s);
2616
2617     /* Convert to and from NXM. */
2618     ofpbuf_init(&nxm, 0);
2619     nxm_match_len = nx_put_match(&nxm, &match, htonll(0), htonll(0));
2620     nxm_s = nx_match_to_string(nxm.data, nxm_match_len);
2621     error = nx_pull_match(&nxm, nxm_match_len, &nxm_match, NULL, NULL);
2622     printf("NXM: %s -> ", nxm_s);
2623     if (error) {
2624         printf("%s\n", ofperr_to_string(error));
2625     } else {
2626         printf("%04"PRIx16"/%04"PRIx16"\n",
2627                ntohs(nxm_match.flow.vlan_tci),
2628                ntohs(nxm_match.wc.masks.vlan_tci));
2629     }
2630     free(nxm_s);
2631     ofpbuf_uninit(&nxm);
2632
2633     /* Convert to and from OXM. */
2634     ofpbuf_init(&nxm, 0);
2635     nxm_match_len = oxm_put_match(&nxm, &match);
2636     nxm_s = oxm_match_to_string(nxm.data, nxm_match_len);
2637     error = oxm_pull_match(&nxm, &nxm_match);
2638     printf("OXM: %s -> ", nxm_s);
2639     if (error) {
2640         printf("%s\n", ofperr_to_string(error));
2641     } else {
2642         uint16_t vid = ntohs(nxm_match.flow.vlan_tci) &
2643             (VLAN_VID_MASK | VLAN_CFI);
2644         uint16_t mask = ntohs(nxm_match.wc.masks.vlan_tci) &
2645             (VLAN_VID_MASK | VLAN_CFI);
2646
2647         printf("%04"PRIx16"/%04"PRIx16",", vid, mask);
2648         if (vid && vlan_tci_to_pcp(nxm_match.wc.masks.vlan_tci)) {
2649             printf("%02"PRIx8"\n", vlan_tci_to_pcp(nxm_match.flow.vlan_tci));
2650         } else {
2651             printf("--\n");
2652         }
2653     }
2654     free(nxm_s);
2655     ofpbuf_uninit(&nxm);
2656
2657     /* Convert to and from OpenFlow 1.0. */
2658     ofputil_match_to_ofp10_match(&match, &of10_raw);
2659     ofputil_match_from_ofp10_match(&of10_raw, &of10_match);
2660     printf("OF1.0: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
2661            ntohs(of10_raw.dl_vlan),
2662            (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN)) != 0,
2663            of10_raw.dl_vlan_pcp,
2664            (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN_PCP)) != 0,
2665            ntohs(of10_match.flow.vlan_tci),
2666            ntohs(of10_match.wc.masks.vlan_tci));
2667
2668     /* Convert to and from OpenFlow 1.1. */
2669     ofputil_match_to_ofp11_match(&match, &of11_raw);
2670     ofputil_match_from_ofp11_match(&of11_raw, &of11_match);
2671     printf("OF1.1: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
2672            ntohs(of11_raw.dl_vlan),
2673            (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN)) != 0,
2674            of11_raw.dl_vlan_pcp,
2675            (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN_PCP)) != 0,
2676            ntohs(of11_match.flow.vlan_tci),
2677            ntohs(of11_match.wc.masks.vlan_tci));
2678 }
2679
2680 /* "print-error ENUM": Prints the type and code of ENUM for every OpenFlow
2681  * version. */
2682 static void
2683 ofctl_print_error(int argc OVS_UNUSED, char *argv[])
2684 {
2685     enum ofperr error;
2686     int version;
2687
2688     error = ofperr_from_name(argv[1]);
2689     if (!error) {
2690         ovs_fatal(0, "unknown error \"%s\"", argv[1]);
2691     }
2692
2693     for (version = 0; version <= UINT8_MAX; version++) {
2694         const char *name = ofperr_domain_get_name(version);
2695         if (!name) {
2696             continue;
2697         }
2698         printf("%s: %d,%d\n",
2699                ofperr_domain_get_name(version),
2700                ofperr_get_type(error, version),
2701                ofperr_get_code(error, version));
2702     }
2703 }
2704
2705 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
2706  * binary data, interpreting them as an OpenFlow message, and prints the
2707  * OpenFlow message on stdout, at VERBOSITY (level 2 by default).  */
2708 static void
2709 ofctl_ofp_print(int argc, char *argv[])
2710 {
2711     struct ofpbuf packet;
2712
2713     ofpbuf_init(&packet, strlen(argv[1]) / 2);
2714     if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
2715         ovs_fatal(0, "trailing garbage following hex bytes");
2716     }
2717     ofp_print(stdout, packet.data, packet.size, argc > 2 ? atoi(argv[2]) : 2);
2718     ofpbuf_uninit(&packet);
2719 }
2720
2721 static const struct command all_commands[] = {
2722     { "show", 1, 1, ofctl_show },
2723     { "monitor", 1, 3, ofctl_monitor },
2724     { "snoop", 1, 1, ofctl_snoop },
2725     { "dump-desc", 1, 1, ofctl_dump_desc },
2726     { "dump-tables", 1, 1, ofctl_dump_tables },
2727     { "dump-flows", 1, 2, ofctl_dump_flows },
2728     { "dump-aggregate", 1, 2, ofctl_dump_aggregate },
2729     { "queue-stats", 1, 3, ofctl_queue_stats },
2730     { "add-flow", 2, 2, ofctl_add_flow },
2731     { "add-flows", 2, 2, ofctl_add_flows },
2732     { "mod-flows", 2, 2, ofctl_mod_flows },
2733     { "del-flows", 1, 2, ofctl_del_flows },
2734     { "replace-flows", 2, 2, ofctl_replace_flows },
2735     { "diff-flows", 2, 2, ofctl_diff_flows },
2736     { "packet-out", 4, INT_MAX, ofctl_packet_out },
2737     { "dump-ports", 1, 2, ofctl_dump_ports },
2738     { "dump-ports-desc", 1, 1, ofctl_dump_ports_desc },
2739     { "mod-port", 3, 3, ofctl_mod_port },
2740     { "get-frags", 1, 1, ofctl_get_frags },
2741     { "set-frags", 2, 2, ofctl_set_frags },
2742     { "probe", 1, 1, ofctl_probe },
2743     { "ping", 1, 2, ofctl_ping },
2744     { "benchmark", 3, 3, ofctl_benchmark },
2745     { "help", 0, INT_MAX, ofctl_help },
2746
2747     /* Undocumented commands for testing. */
2748     { "parse-flow", 1, 1, ofctl_parse_flow },
2749     { "parse-flows", 1, 1, ofctl_parse_flows },
2750     { "parse-nx-match", 0, 0, ofctl_parse_nxm },
2751     { "parse-nxm", 0, 0, ofctl_parse_nxm },
2752     { "parse-oxm", 0, 0, ofctl_parse_oxm },
2753     { "parse-ofp10-actions", 0, 0, ofctl_parse_ofp10_actions },
2754     { "parse-ofp10-match", 0, 0, ofctl_parse_ofp10_match },
2755     { "parse-ofp11-match", 0, 0, ofctl_parse_ofp11_match },
2756     { "parse-ofp11-actions", 0, 0, ofctl_parse_ofp11_actions },
2757     { "parse-ofp11-instructions", 0, 0, ofctl_parse_ofp11_instructions },
2758     { "check-vlan", 2, 2, ofctl_check_vlan },
2759     { "print-error", 1, 1, ofctl_print_error },
2760     { "ofp-print", 1, 2, ofctl_ofp_print },
2761
2762     { NULL, 0, 0, NULL },
2763 };