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;
 745
 746     if (ofputil_port_from_string(port_name, &port_no)) {
 747         return port_no;
 748     } else {
 749         struct ofputil_phy_port pp;
 750
 751         fetch_ofputil_phy_port(vconn_name, port_name, &pp);
 752         return pp.port_no;
 753     }
 754 }
 755
 756 static bool
 757 try_set_protocol(struct vconn *vconn, enum ofputil_protocol want,
 758                  enum ofputil_protocol *cur)
 759 {
 760     for (;;) {
 761         struct ofpbuf *request, *reply;
 762         enum ofputil_protocol next;
 763
 764         request = ofputil_encode_set_protocol(*cur, want, &next);
 765         if (!request) {
 766             return true;
 767         }
 768
 769         run(vconn_transact_noreply(vconn, request, &reply),
 770             "talking to %s", vconn_get_name(vconn));
 771         if (reply) {
 772             char *s = ofp_to_string(reply->data, reply->size, 2);
 773             VLOG_DBG("%s: failed to set protocol, switch replied: %s",
 774                      vconn_get_name(vconn), s);
 775             free(s);
 776             ofpbuf_delete(reply);
 777             return false;
 778         }
 779
 780         *cur = next;
 781     }
 782 }
 783
 784 static enum ofputil_protocol
 785 set_protocol_for_flow_dump(struct vconn *vconn,
 786                            enum ofputil_protocol cur_protocol,
 787                            enum ofputil_protocol usable_protocols)
 788 {
 789     char *usable_s;
 790     int i;
 791
 792     for (i = 0; i < ofputil_n_flow_dump_protocols; i++) {
 793         enum ofputil_protocol f = ofputil_flow_dump_protocols[i];
 794         if (f & usable_protocols & allowed_protocols
 795             && try_set_protocol(vconn, f, &cur_protocol)) {
 796             return f;
 797         }
 798     }
 799
 800     usable_s = ofputil_protocols_to_string(usable_protocols);
 801     if (usable_protocols & allowed_protocols) {
 802         ovs_fatal(0, "switch does not support any of the usable flow "
 803                   "formats (%s)", usable_s);
 804     } else {
 805         char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
 806         ovs_fatal(0, "none of the usable flow formats (%s) is among the "
 807                   "allowed flow formats (%s)", usable_s, allowed_s);
 808     }
 809 }
 810
 811 static struct vconn *
 812 prepare_dump_flows(int argc, char *argv[], bool aggregate,
 813                    struct ofpbuf **requestp)
 814 {
 815     enum ofputil_protocol usable_protocols, protocol;
 816     struct ofputil_flow_stats_request fsr;
 817     struct vconn *vconn;
 818
 819     parse_ofp_flow_stats_request_str(&fsr, aggregate, argc > 2 ? argv[2] : "");
 820     usable_protocols = ofputil_flow_stats_request_usable_protocols(&fsr);
 821
 822     protocol = open_vconn(argv[1], &vconn);
 823     protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
 824     *requestp = ofputil_encode_flow_stats_request(&fsr, protocol);
 825     return vconn;
 826 }
 827
 828 static void
 829 ofctl_dump_flows__(int argc, char *argv[], bool aggregate)
 830 {
 831     struct ofpbuf *request;
 832     struct vconn *vconn;
 833
 834     vconn = prepare_dump_flows(argc, argv, aggregate, &request);
 835     dump_stats_transaction(vconn, request);
 836     vconn_close(vconn);
 837 }
 838
 839 static int
 840 compare_flows(const void *afs_, const void *bfs_)
 841 {
 842     const struct ofputil_flow_stats *afs = afs_;
 843     const struct ofputil_flow_stats *bfs = bfs_;
 844     const struct match *a = &afs->match;
 845     const struct match *b = &bfs->match;
 846     const struct sort_criterion *sc;
 847
 848     for (sc = criteria; sc < &criteria[n_criteria]; sc++) {
 849         const struct mf_field *f = sc->field;
 850         int ret;
 851
 852         if (!f) {
 853             unsigned int a_pri = afs->priority;
 854             unsigned int b_pri = bfs->priority;
 855             ret = a_pri < b_pri ? -1 : a_pri > b_pri;
 856         } else {
 857             bool ina, inb;
 858
 859             ina = mf_are_prereqs_ok(f, &a->flow) && !mf_is_all_wild(f, &a->wc);
 860             inb = mf_are_prereqs_ok(f, &b->flow) && !mf_is_all_wild(f, &b->wc);
 861             if (ina != inb) {
 862                 /* Skip the test for sc->order, so that missing fields always
 863                  * sort to the end whether we're sorting in ascending or
 864                  * descending order. */
 865                 return ina ? -1 : 1;
 866             } else {
 867                 union mf_value aval, bval;
 868
 869                 mf_get_value(f, &a->flow, &aval);
 870                 mf_get_value(f, &b->flow, &bval);
 871                 ret = memcmp(&aval, &bval, f->n_bytes);
 872             }
 873         }
 874
 875         if (ret) {
 876             return sc->order == SORT_ASC ? ret : -ret;
 877         }
 878     }
 879
 880     return 0;
 881 }
 882
 883 static void
 884 ofctl_dump_flows(int argc, char *argv[])
 885 {
 886     if (!n_criteria) {
 887         return ofctl_dump_flows__(argc, argv, false);
 888     } else {
 889         struct ofputil_flow_stats *fses;
 890         size_t n_fses, allocated_fses;
 891         struct ofpbuf *request;
 892         struct ofpbuf ofpacts;
 893         struct ofpbuf *reply;
 894         struct vconn *vconn;
 895         ovs_be32 send_xid;
 896         struct ds s;
 897         size_t i;
 898
 899         vconn = prepare_dump_flows(argc, argv, false, &request);
 900         send_xid = ((struct ofp_header *) request->data)->xid;
 901         send_openflow_buffer(vconn, request);
 902
 903         fses = NULL;
 904         n_fses = allocated_fses = 0;
 905         reply = NULL;
 906         ofpbuf_init(&ofpacts, 0);
 907         for (;;) {
 908             struct ofputil_flow_stats *fs;
 909
 910             if (n_fses >= allocated_fses) {
 911                 fses = x2nrealloc(fses, &allocated_fses, sizeof *fses);
 912             }
 913
 914             fs = &fses[n_fses];
 915             if (!recv_flow_stats_reply(vconn, send_xid, &reply, fs,
 916                                        &ofpacts)) {
 917                 break;
 918             }
 919             fs->ofpacts = xmemdup(fs->ofpacts, fs->ofpacts_len);
 920             n_fses++;
 921         }
 922         ofpbuf_uninit(&ofpacts);
 923
 924         qsort(fses, n_fses, sizeof *fses, compare_flows);
 925
 926         ds_init(&s);
 927         for (i = 0; i < n_fses; i++) {
 928             ds_clear(&s);
 929             ofp_print_flow_stats(&s, &fses[i]);
 930             puts(ds_cstr(&s));
 931         }
 932         ds_destroy(&s);
 933
 934         for (i = 0; i < n_fses; i++) {
 935             free(fses[i].ofpacts);
 936         }
 937         free(fses);
 938
 939         vconn_close(vconn);
 940     }
 941 }
 942
 943 static void
 944 ofctl_dump_aggregate(int argc, char *argv[])
 945 {
 946     return ofctl_dump_flows__(argc, argv, true);
 947 }
 948
 949 static void
 950 ofctl_queue_stats(int argc, char *argv[])
 951 {
 952     struct ofpbuf *request;
 953     struct vconn *vconn;
 954     struct ofputil_queue_stats_request oqs;
 955
 956     open_vconn(argv[1], &vconn);
 957
 958     if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
 959         oqs.port_no = str_to_port_no(argv[1], argv[2]);
 960     } else {
 961         oqs.port_no = OFPP_ALL;
 962     }
 963     if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
 964         oqs.queue_id = atoi(argv[3]);
 965     } else {
 966         oqs.queue_id = OFPQ_ALL;
 967     }
 968
 969     request = ofputil_encode_queue_stats_request(vconn_get_version(vconn), &oqs);
 970     dump_stats_transaction(vconn, request);
 971     vconn_close(vconn);
 972 }
 973
 974 static enum ofputil_protocol
 975 open_vconn_for_flow_mod(const char *remote,
 976                         const struct ofputil_flow_mod *fms, size_t n_fms,
 977                         struct vconn **vconnp)
 978 {
 979     enum ofputil_protocol usable_protocols;
 980     enum ofputil_protocol cur_protocol;
 981     char *usable_s;
 982     int i;
 983
 984     /* Figure out what flow formats will work. */
 985     usable_protocols = ofputil_flow_mod_usable_protocols(fms, n_fms);
 986     if (!(usable_protocols & allowed_protocols)) {
 987         char *allowed_s = ofputil_protocols_to_string(allowed_protocols);
 988         usable_s = ofputil_protocols_to_string(usable_protocols);
 989         ovs_fatal(0, "none of the usable flow formats (%s) is among the "
 990                   "allowed flow formats (%s)", usable_s, allowed_s);
 991     }
 992
 993     /* If the initial flow format is allowed and usable, keep it. */
 994     cur_protocol = open_vconn(remote, vconnp);
 995     if (usable_protocols & allowed_protocols & cur_protocol) {
 996         return cur_protocol;
 997     }
 998
 999     /* Otherwise try each flow format in turn. */
1000     for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
1001         enum ofputil_protocol f = 1 << i;
1002
1003         if (f != cur_protocol
1004             && f & usable_protocols & allowed_protocols
1005             && try_set_protocol(*vconnp, f, &cur_protocol)) {
1006             return f;
1007         }
1008     }
1009
1010     usable_s = ofputil_protocols_to_string(usable_protocols);
1011     ovs_fatal(0, "switch does not support any of the usable flow "
1012               "formats (%s)", usable_s);
1013 }
1014
1015 static void
1016 ofctl_flow_mod__(const char *remote, struct ofputil_flow_mod *fms,
1017                  size_t n_fms)
1018 {
1019     enum ofputil_protocol protocol;
1020     struct vconn *vconn;
1021     size_t i;
1022
1023     protocol = open_vconn_for_flow_mod(remote, fms, n_fms, &vconn);
1024
1025     for (i = 0; i < n_fms; i++) {
1026         struct ofputil_flow_mod *fm = &fms[i];
1027
1028         transact_noreply(vconn, ofputil_encode_flow_mod(fm, protocol));
1029         free(fm->ofpacts);
1030     }
1031     vconn_close(vconn);
1032 }
1033
1034 static void
1035 ofctl_flow_mod_file(int argc OVS_UNUSED, char *argv[], uint16_t command)
1036 {
1037     struct ofputil_flow_mod *fms = NULL;
1038     size_t n_fms = 0;
1039
1040     parse_ofp_flow_mod_file(argv[2], command, &fms, &n_fms);
1041     ofctl_flow_mod__(argv[1], fms, n_fms);
1042     free(fms);
1043 }
1044
1045 static void
1046 ofctl_flow_mod(int argc, char *argv[], uint16_t command)
1047 {
1048     if (argc > 2 && !strcmp(argv[2], "-")) {
1049         ofctl_flow_mod_file(argc, argv, command);
1050     } else {
1051         struct ofputil_flow_mod fm;
1052         parse_ofp_flow_mod_str(&fm, argc > 2 ? argv[2] : "", command, false);
1053         ofctl_flow_mod__(argv[1], &fm, 1);
1054     }
1055 }
1056
1057 static void
1058 ofctl_add_flow(int argc, char *argv[])
1059 {
1060     ofctl_flow_mod(argc, argv, OFPFC_ADD);
1061 }
1062
1063 static void
1064 ofctl_add_flows(int argc, char *argv[])
1065 {
1066     ofctl_flow_mod_file(argc, argv, OFPFC_ADD);
1067 }
1068
1069 static void
1070 ofctl_mod_flows(int argc, char *argv[])
1071 {
1072     ofctl_flow_mod(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
1073 }
1074
1075 static void
1076 ofctl_del_flows(int argc, char *argv[])
1077 {
1078     ofctl_flow_mod(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
1079 }
1080
1081 static void
1082 set_packet_in_format(struct vconn *vconn,
1083                      enum nx_packet_in_format packet_in_format)
1084 {
1085     struct ofpbuf *spif;
1086
1087     spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1088                                              packet_in_format);
1089     transact_noreply(vconn, spif);
1090     VLOG_DBG("%s: using user-specified packet in format %s",
1091              vconn_get_name(vconn),
1092              ofputil_packet_in_format_to_string(packet_in_format));
1093 }
1094
1095 static int
1096 monitor_set_invalid_ttl_to_controller(struct vconn *vconn)
1097 {
1098     struct ofp_switch_config config;
1099     enum ofp_config_flags flags;
1100
1101     fetch_switch_config(vconn, &config);
1102     flags = ntohs(config.flags);
1103     if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1104         /* Set the invalid ttl config. */
1105         flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
1106
1107         config.flags = htons(flags);
1108         set_switch_config(vconn, &config);
1109
1110         /* Then retrieve the configuration to see if it really took.  OpenFlow
1111          * doesn't define error reporting for bad modes, so this is all we can
1112          * do. */
1113         fetch_switch_config(vconn, &config);
1114         flags = ntohs(config.flags);
1115         if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
1116             ovs_fatal(0, "setting invalid_ttl_to_controller failed (this "
1117                       "switch probably doesn't support mode)");
1118             return -EOPNOTSUPP;
1119         }
1120     }
1121     return 0;
1122 }
1123
1124 /* Converts hex digits in 'hex' to an OpenFlow message in '*msgp'.  The
1125  * caller must free '*msgp'.  On success, returns NULL.  On failure, returns
1126  * an error message and stores NULL in '*msgp'. */
1127 static const char *
1128 openflow_from_hex(const char *hex, struct ofpbuf **msgp)
1129 {
1130     struct ofp_header *oh;
1131     struct ofpbuf *msg;
1132
1133     msg = ofpbuf_new(strlen(hex) / 2);
1134     *msgp = NULL;
1135
1136     if (ofpbuf_put_hex(msg, hex, NULL)[0] != '\0') {
1137         ofpbuf_delete(msg);
1138         return "Trailing garbage in hex data";
1139     }
1140
1141     if (msg->size < sizeof(struct ofp_header)) {
1142         ofpbuf_delete(msg);
1143         return "Message too short for OpenFlow";
1144     }
1145
1146     oh = msg->data;
1147     if (msg->size != ntohs(oh->length)) {
1148         ofpbuf_delete(msg);
1149         return "Message size does not match length in OpenFlow header";
1150     }
1151
1152     *msgp = msg;
1153     return NULL;
1154 }
1155
1156 static void
1157 ofctl_send(struct unixctl_conn *conn, int argc,
1158            const char *argv[], void *vconn_)
1159 {
1160     struct vconn *vconn = vconn_;
1161     struct ds reply;
1162     bool ok;
1163     int i;
1164
1165     ok = true;
1166     ds_init(&reply);
1167     for (i = 1; i < argc; i++) {
1168         const char *error_msg;
1169         struct ofpbuf *msg;
1170         int error;
1171
1172         error_msg = openflow_from_hex(argv[i], &msg);
1173         if (error_msg) {
1174             ds_put_format(&reply, "%s\n", error_msg);
1175             ok = false;
1176             continue;
1177         }
1178
1179         fprintf(stderr, "send: ");
1180         ofp_print(stderr, msg->data, msg->size, verbosity);
1181
1182         error = vconn_send_block(vconn, msg);
1183         if (error) {
1184             ofpbuf_delete(msg);
1185             ds_put_format(&reply, "%s\n", strerror(error));
1186             ok = false;
1187         } else {
1188             ds_put_cstr(&reply, "sent\n");
1189         }
1190     }
1191
1192     if (ok) {
1193         unixctl_command_reply(conn, ds_cstr(&reply));
1194     } else {
1195         unixctl_command_reply_error(conn, ds_cstr(&reply));
1196     }
1197     ds_destroy(&reply);
1198 }
1199
1200 struct barrier_aux {
1201     struct vconn *vconn;        /* OpenFlow connection for sending barrier. */
1202     struct unixctl_conn *conn;  /* Connection waiting for barrier response. */
1203 };
1204
1205 static void
1206 ofctl_barrier(struct unixctl_conn *conn, int argc OVS_UNUSED,
1207               const char *argv[] OVS_UNUSED, void *aux_)
1208 {
1209     struct barrier_aux *aux = aux_;
1210     struct ofpbuf *msg;
1211     int error;
1212
1213     if (aux->conn) {
1214         unixctl_command_reply_error(conn, "already waiting for barrier reply");
1215         return;
1216     }
1217
1218     msg = ofputil_encode_barrier_request(vconn_get_version(aux->vconn));
1219     error = vconn_send_block(aux->vconn, msg);
1220     if (error) {
1221         ofpbuf_delete(msg);
1222         unixctl_command_reply_error(conn, strerror(error));
1223     } else {
1224         aux->conn = conn;
1225     }
1226 }
1227
1228 static void
1229 ofctl_set_output_file(struct unixctl_conn *conn, int argc OVS_UNUSED,
1230                       const char *argv[], void *aux OVS_UNUSED)
1231 {
1232     int fd;
1233
1234     fd = open(argv[1], O_CREAT | O_TRUNC | O_WRONLY, 0666);
1235     if (fd < 0) {
1236         unixctl_command_reply_error(conn, strerror(errno));
1237         return;
1238     }
1239
1240     fflush(stderr);
1241     dup2(fd, STDERR_FILENO);
1242     close(fd);
1243     unixctl_command_reply(conn, NULL);
1244 }
1245
1246 static void
1247 ofctl_block(struct unixctl_conn *conn, int argc OVS_UNUSED,
1248             const char *argv[] OVS_UNUSED, void *blocked_)
1249 {
1250     bool *blocked = blocked_;
1251
1252     if (!*blocked) {
1253         *blocked = true;
1254         unixctl_command_reply(conn, NULL);
1255     } else {
1256         unixctl_command_reply(conn, "already blocking");
1257     }
1258 }
1259
1260 static void
1261 ofctl_unblock(struct unixctl_conn *conn, int argc OVS_UNUSED,
1262               const char *argv[] OVS_UNUSED, void *blocked_)
1263 {
1264     bool *blocked = blocked_;
1265
1266     if (*blocked) {
1267         *blocked = false;
1268         unixctl_command_reply(conn, NULL);
1269     } else {
1270         unixctl_command_reply(conn, "already unblocked");
1271     }
1272 }
1273
1274 static void
1275 monitor_vconn(struct vconn *vconn)
1276 {
1277     struct barrier_aux barrier_aux = { vconn, NULL };
1278     struct unixctl_server *server;
1279     bool exiting = false;
1280     bool blocked = false;
1281     int error;
1282
1283     daemon_save_fd(STDERR_FILENO);
1284     daemonize_start();
1285     error = unixctl_server_create(NULL, &server);
1286     if (error) {
1287         ovs_fatal(error, "failed to create unixctl server");
1288     }
1289     unixctl_command_register("exit", "", 0, 0, ofctl_exit, &exiting);
1290     unixctl_command_register("ofctl/send", "OFMSG...", 1, INT_MAX,
1291                              ofctl_send, vconn);
1292     unixctl_command_register("ofctl/barrier", "", 0, 0,
1293                              ofctl_barrier, &barrier_aux);
1294     unixctl_command_register("ofctl/set-output-file", "FILE", 1, 1,
1295                              ofctl_set_output_file, NULL);
1296
1297     unixctl_command_register("ofctl/block", "", 0, 0, ofctl_block, &blocked);
1298     unixctl_command_register("ofctl/unblock", "", 0, 0, ofctl_unblock,
1299                              &blocked);
1300
1301     daemonize_complete();
1302
1303     for (;;) {
1304         struct ofpbuf *b;
1305         int retval;
1306
1307         unixctl_server_run(server);
1308
1309         while (!blocked) {
1310             enum ofptype type;
1311
1312             retval = vconn_recv(vconn, &b);
1313             if (retval == EAGAIN) {
1314                 break;
1315             }
1316             run(retval, "vconn_recv");
1317
1318             if (timestamp) {
1319                 time_t now = time_wall();
1320                 char s[32];
1321
1322                 strftime(s, sizeof s, "%Y-%m-%d %H:%M:%S: ", gmtime(&now));
1323                 fputs(s, stderr);
1324             }
1325
1326             ofptype_decode(&type, b->data);
1327             ofp_print(stderr, b->data, b->size, verbosity + 2);
1328             ofpbuf_delete(b);
1329
1330             if (barrier_aux.conn && type == OFPTYPE_BARRIER_REPLY) {
1331                 unixctl_command_reply(barrier_aux.conn, NULL);
1332                 barrier_aux.conn = NULL;
1333             }
1334         }
1335
1336         if (exiting) {
1337             break;
1338         }
1339
1340         vconn_run(vconn);
1341         vconn_run_wait(vconn);
1342         if (!blocked) {
1343             vconn_recv_wait(vconn);
1344         }
1345         unixctl_server_wait(server);
1346         poll_block();
1347     }
1348     vconn_close(vconn);
1349     unixctl_server_destroy(server);
1350 }
1351
1352 static void
1353 ofctl_monitor(int argc, char *argv[])
1354 {
1355     struct vconn *vconn;
1356     int i;
1357
1358     open_vconn(argv[1], &vconn);
1359     for (i = 2; i < argc; i++) {
1360         const char *arg = argv[i];
1361
1362         if (isdigit((unsigned char) *arg)) {
1363             struct ofp_switch_config config;
1364
1365             fetch_switch_config(vconn, &config);
1366             config.miss_send_len = htons(atoi(arg));
1367             set_switch_config(vconn, &config);
1368         } else if (!strcmp(arg, "invalid_ttl")) {
1369             monitor_set_invalid_ttl_to_controller(vconn);
1370         } else if (!strncmp(arg, "watch:", 6)) {
1371             struct ofputil_flow_monitor_request fmr;
1372             struct ofpbuf *msg;
1373
1374             parse_flow_monitor_request(&fmr, arg + 6);
1375
1376             msg = ofpbuf_new(0);
1377             ofputil_append_flow_monitor_request(&fmr, msg);
1378             dump_stats_transaction(vconn, msg);
1379         } else {
1380             ovs_fatal(0, "%s: unsupported \"monitor\" argument", arg);
1381         }
1382     }
1383
1384     if (preferred_packet_in_format >= 0) {
1385         set_packet_in_format(vconn, preferred_packet_in_format);
1386     } else {
1387         struct ofpbuf *spif, *reply;
1388
1389         spif = ofputil_make_set_packet_in_format(vconn_get_version(vconn),
1390                                                  NXPIF_NXM);
1391         run(vconn_transact_noreply(vconn, spif, &reply),
1392             "talking to %s", vconn_get_name(vconn));
1393         if (reply) {
1394             char *s = ofp_to_string(reply->data, reply->size, 2);
1395             VLOG_DBG("%s: failed to set packet in format to nxm, controller"
1396                      " replied: %s. Falling back to the switch default.",
1397                      vconn_get_name(vconn), s);
1398             free(s);
1399             ofpbuf_delete(reply);
1400         }
1401     }
1402
1403     monitor_vconn(vconn);
1404 }
1405
1406 static void
1407 ofctl_snoop(int argc OVS_UNUSED, char *argv[])
1408 {
1409     struct vconn *vconn;
1410
1411     open_vconn__(argv[1], "snoop", &vconn);
1412     monitor_vconn(vconn);
1413 }
1414
1415 static void
1416 ofctl_dump_ports(int argc, char *argv[])
1417 {
1418     struct ofpbuf *request;
1419     struct vconn *vconn;
1420     uint16_t port;
1421
1422     open_vconn(argv[1], &vconn);
1423     port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_NONE;
1424     request = ofputil_encode_dump_ports_request(vconn_get_version(vconn), port);
1425     dump_stats_transaction(vconn, request);
1426     vconn_close(vconn);
1427 }
1428
1429 static void
1430 ofctl_dump_ports_desc(int argc OVS_UNUSED, char *argv[])
1431 {
1432     dump_trivial_stats_transaction(argv[1], OFPRAW_OFPST_PORT_DESC_REQUEST);
1433 }
1434
1435 static void
1436 ofctl_probe(int argc OVS_UNUSED, char *argv[])
1437 {
1438     struct ofpbuf *request;
1439     struct vconn *vconn;
1440     struct ofpbuf *reply;
1441
1442     open_vconn(argv[1], &vconn);
1443     request = make_echo_request(vconn_get_version(vconn));
1444     run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1445     if (reply->size != sizeof(struct ofp_header)) {
1446         ovs_fatal(0, "reply does not match request");
1447     }
1448     ofpbuf_delete(reply);
1449     vconn_close(vconn);
1450 }
1451
1452 static void
1453 ofctl_packet_out(int argc, char *argv[])
1454 {
1455     enum ofputil_protocol protocol;
1456     struct ofputil_packet_out po;
1457     struct ofpbuf ofpacts;
1458     struct vconn *vconn;
1459     int i;
1460
1461     ofpbuf_init(&ofpacts, 64);
1462     parse_ofpacts(argv[3], &ofpacts);
1463
1464     po.buffer_id = UINT32_MAX;
1465     po.in_port = str_to_port_no(argv[1], argv[2]);
1466     po.ofpacts = ofpacts.data;
1467     po.ofpacts_len = ofpacts.size;
1468
1469     protocol = open_vconn(argv[1], &vconn);
1470     for (i = 4; i < argc; i++) {
1471         struct ofpbuf *packet, *opo;
1472         const char *error_msg;
1473
1474         error_msg = eth_from_hex(argv[i], &packet);
1475         if (error_msg) {
1476             ovs_fatal(0, "%s", error_msg);
1477         }
1478
1479         po.packet = packet->data;
1480         po.packet_len = packet->size;
1481         opo = ofputil_encode_packet_out(&po, protocol);
1482         transact_noreply(vconn, opo);
1483         ofpbuf_delete(packet);
1484     }
1485     vconn_close(vconn);
1486     ofpbuf_uninit(&ofpacts);
1487 }
1488
1489 static void
1490 ofctl_mod_port(int argc OVS_UNUSED, char *argv[])
1491 {
1492     struct ofp_config_flag {
1493         const char *name;             /* The flag's name. */
1494         enum ofputil_port_config bit; /* Bit to turn on or off. */
1495         bool on;                      /* Value to set the bit to. */
1496     };
1497     static const struct ofp_config_flag flags[] = {
1498         { "up",          OFPUTIL_PC_PORT_DOWN,    false },
1499         { "down",        OFPUTIL_PC_PORT_DOWN,    true  },
1500         { "stp",         OFPUTIL_PC_NO_STP,       false },
1501         { "receive",     OFPUTIL_PC_NO_RECV,      false },
1502         { "receive-stp", OFPUTIL_PC_NO_RECV_STP,  false },
1503         { "flood",       OFPUTIL_PC_NO_FLOOD,     false },
1504         { "forward",     OFPUTIL_PC_NO_FWD,       false },
1505         { "packet-in",   OFPUTIL_PC_NO_PACKET_IN, false },
1506     };
1507
1508     const struct ofp_config_flag *flag;
1509     enum ofputil_protocol protocol;
1510     struct ofputil_port_mod pm;
1511     struct ofputil_phy_port pp;
1512     struct vconn *vconn;
1513     const char *command;
1514     bool not;
1515
1516     fetch_ofputil_phy_port(argv[1], argv[2], &pp);
1517
1518     pm.port_no = pp.port_no;
1519     memcpy(pm.hw_addr, pp.hw_addr, ETH_ADDR_LEN);
1520     pm.config = 0;
1521     pm.mask = 0;
1522     pm.advertise = 0;
1523
1524     if (!strncasecmp(argv[3], "no-", 3)) {
1525         command = argv[3] + 3;
1526         not = true;
1527     } else if (!strncasecmp(argv[3], "no", 2)) {
1528         command = argv[3] + 2;
1529         not = true;
1530     } else {
1531         command = argv[3];
1532         not = false;
1533     }
1534     for (flag = flags; flag < &flags[ARRAY_SIZE(flags)]; flag++) {
1535         if (!strcasecmp(command, flag->name)) {
1536             pm.mask = flag->bit;
1537             pm.config = flag->on ^ not ? flag->bit : 0;
1538             goto found;
1539         }
1540     }
1541     ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
1542
1543 found:
1544     protocol = open_vconn(argv[1], &vconn);
1545     transact_noreply(vconn, ofputil_encode_port_mod(&pm, protocol));
1546     vconn_close(vconn);
1547 }
1548
1549 static void
1550 ofctl_get_frags(int argc OVS_UNUSED, char *argv[])
1551 {
1552     struct ofp_switch_config config;
1553     struct vconn *vconn;
1554
1555     open_vconn(argv[1], &vconn);
1556     fetch_switch_config(vconn, &config);
1557     puts(ofputil_frag_handling_to_string(ntohs(config.flags)));
1558     vconn_close(vconn);
1559 }
1560
1561 static void
1562 ofctl_set_frags(int argc OVS_UNUSED, char *argv[])
1563 {
1564     struct ofp_switch_config config;
1565     enum ofp_config_flags mode;
1566     struct vconn *vconn;
1567     ovs_be16 flags;
1568
1569     if (!ofputil_frag_handling_from_string(argv[2], &mode)) {
1570         ovs_fatal(0, "%s: unknown fragment handling mode", argv[2]);
1571     }
1572
1573     open_vconn(argv[1], &vconn);
1574     fetch_switch_config(vconn, &config);
1575     flags = htons(mode) | (config.flags & htons(~OFPC_FRAG_MASK));
1576     if (flags != config.flags) {
1577         /* Set the configuration. */
1578         config.flags = flags;
1579         set_switch_config(vconn, &config);
1580
1581         /* Then retrieve the configuration to see if it really took.  OpenFlow
1582          * doesn't define error reporting for bad modes, so this is all we can
1583          * do. */
1584         fetch_switch_config(vconn, &config);
1585         if (flags != config.flags) {
1586             ovs_fatal(0, "%s: setting fragment handling mode failed (this "
1587                       "switch probably doesn't support mode \"%s\")",
1588                       argv[1], ofputil_frag_handling_to_string(mode));
1589         }
1590     }
1591     vconn_close(vconn);
1592 }
1593
1594 static void
1595 ofctl_ping(int argc, char *argv[])
1596 {
1597     size_t max_payload = 65535 - sizeof(struct ofp_header);
1598     unsigned int payload;
1599     struct vconn *vconn;
1600     int i;
1601
1602     payload = argc > 2 ? atoi(argv[2]) : 64;
1603     if (payload > max_payload) {
1604         ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1605     }
1606
1607     open_vconn(argv[1], &vconn);
1608     for (i = 0; i < 10; i++) {
1609         struct timeval start, end;
1610         struct ofpbuf *request, *reply;
1611         const struct ofp_header *rpy_hdr;
1612         enum ofptype type;
1613
1614         request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST, OFP10_VERSION,
1615                                payload);
1616         random_bytes(ofpbuf_put_uninit(request, payload), payload);
1617
1618         xgettimeofday(&start);
1619         run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
1620         xgettimeofday(&end);
1621
1622         rpy_hdr = reply->data;
1623         if (ofptype_pull(&type, reply)
1624             || type != OFPTYPE_ECHO_REPLY
1625             || reply->size != payload
1626             || memcmp(request->l3, reply->l3, payload)) {
1627             printf("Reply does not match request.  Request:\n");
1628             ofp_print(stdout, request, request->size, verbosity + 2);
1629             printf("Reply:\n");
1630             ofp_print(stdout, reply, reply->size, verbosity + 2);
1631         }
1632         printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
1633                reply->size, argv[1], ntohl(rpy_hdr->xid),
1634                    (1000*(double)(end.tv_sec - start.tv_sec))
1635                    + (.001*(end.tv_usec - start.tv_usec)));
1636         ofpbuf_delete(request);
1637         ofpbuf_delete(reply);
1638     }
1639     vconn_close(vconn);
1640 }
1641
1642 static void
1643 ofctl_benchmark(int argc OVS_UNUSED, char *argv[])
1644 {
1645     size_t max_payload = 65535 - sizeof(struct ofp_header);
1646     struct timeval start, end;
1647     unsigned int payload_size, message_size;
1648     struct vconn *vconn;
1649     double duration;
1650     int count;
1651     int i;
1652
1653     payload_size = atoi(argv[2]);
1654     if (payload_size > max_payload) {
1655         ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1656     }
1657     message_size = sizeof(struct ofp_header) + payload_size;
1658
1659     count = atoi(argv[3]);
1660
1661     printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
1662            count, message_size, count * message_size);
1663
1664     open_vconn(argv[1], &vconn);
1665     xgettimeofday(&start);
1666     for (i = 0; i < count; i++) {
1667         struct ofpbuf *request, *reply;
1668
1669         request = ofpraw_alloc(OFPRAW_OFPT_ECHO_REQUEST, OFP10_VERSION,
1670                                payload_size);
1671         ofpbuf_put_zeros(request, payload_size);
1672         run(vconn_transact(vconn, request, &reply), "transact");
1673         ofpbuf_delete(reply);
1674     }
1675     xgettimeofday(&end);
1676     vconn_close(vconn);
1677
1678     duration = ((1000*(double)(end.tv_sec - start.tv_sec))
1679                 + (.001*(end.tv_usec - start.tv_usec)));
1680     printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
1681            duration, count / (duration / 1000.0),
1682            count * message_size / (duration / 1000.0));
1683 }
1684
1685 static void
1686 ofctl_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1687 {
1688     usage();
1689 }
1690 \f
1691 /* replace-flows and diff-flows commands. */
1692
1693 /* A flow table entry, possibly with two different versions. */
1694 struct fte {
1695     struct cls_rule rule;       /* Within a "struct classifier". */
1696     struct fte_version *versions[2];
1697 };
1698
1699 /* One version of a Flow Table Entry. */
1700 struct fte_version {
1701     ovs_be64 cookie;
1702     uint16_t idle_timeout;
1703     uint16_t hard_timeout;
1704     uint16_t flags;
1705     struct ofpact *ofpacts;
1706     size_t ofpacts_len;
1707 };
1708
1709 /* Frees 'version' and the data that it owns. */
1710 static void
1711 fte_version_free(struct fte_version *version)
1712 {
1713     if (version) {
1714         free(version->ofpacts);
1715         free(version);
1716     }
1717 }
1718
1719 /* Returns true if 'a' and 'b' are the same, false if they differ.
1720  *
1721  * Ignores differences in 'flags' because there's no way to retrieve flags from
1722  * an OpenFlow switch.  We have to assume that they are the same. */
1723 static bool
1724 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
1725 {
1726     return (a->cookie == b->cookie
1727             && a->idle_timeout == b->idle_timeout
1728             && a->hard_timeout == b->hard_timeout
1729             && ofpacts_equal(a->ofpacts, a->ofpacts_len,
1730                              b->ofpacts, b->ofpacts_len));
1731 }
1732
1733 /* Clears 's', then if 's' has a version 'index', formats 'fte' and version
1734  * 'index' into 's', followed by a new-line. */
1735 static void
1736 fte_version_format(const struct fte *fte, int index, struct ds *s)
1737 {
1738     const struct fte_version *version = fte->versions[index];
1739
1740     ds_clear(s);
1741     if (!version) {
1742         return;
1743     }
1744
1745     cls_rule_format(&fte->rule, s);
1746     if (version->cookie != htonll(0)) {
1747         ds_put_format(s, " cookie=0x%"PRIx64, ntohll(version->cookie));
1748     }
1749     if (version->idle_timeout != OFP_FLOW_PERMANENT) {
1750         ds_put_format(s, " idle_timeout=%"PRIu16, version->idle_timeout);
1751     }
1752     if (version->hard_timeout != OFP_FLOW_PERMANENT) {
1753         ds_put_format(s, " hard_timeout=%"PRIu16, version->hard_timeout);
1754     }
1755
1756     ds_put_char(s, ' ');
1757     ofpacts_format(version->ofpacts, version->ofpacts_len, s);
1758
1759     ds_put_char(s, '\n');
1760 }
1761
1762 static struct fte *
1763 fte_from_cls_rule(const struct cls_rule *cls_rule)
1764 {
1765     return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
1766 }
1767
1768 /* Frees 'fte' and its versions. */
1769 static void
1770 fte_free(struct fte *fte)
1771 {
1772     if (fte) {
1773         fte_version_free(fte->versions[0]);
1774         fte_version_free(fte->versions[1]);
1775         cls_rule_destroy(&fte->rule);
1776         free(fte);
1777     }
1778 }
1779
1780 /* Frees all of the FTEs within 'cls'. */
1781 static void
1782 fte_free_all(struct classifier *cls)
1783 {
1784     struct cls_cursor cursor;
1785     struct fte *fte, *next;
1786
1787     cls_cursor_init(&cursor, cls, NULL);
1788     CLS_CURSOR_FOR_EACH_SAFE (fte, next, rule, &cursor) {
1789         classifier_remove(cls, &fte->rule);
1790         fte_free(fte);
1791     }
1792     classifier_destroy(cls);
1793 }
1794
1795 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
1796  * necessary.  Sets 'version' as the version of that rule with the given
1797  * 'index', replacing any existing version, if any.
1798  *
1799  * Takes ownership of 'version'. */
1800 static void
1801 fte_insert(struct classifier *cls, const struct match *match,
1802            unsigned int priority, struct fte_version *version, int index)
1803 {
1804     struct fte *old, *fte;
1805
1806     fte = xzalloc(sizeof *fte);
1807     cls_rule_init(&fte->rule, match, priority);
1808     fte->versions[index] = version;
1809
1810     old = fte_from_cls_rule(classifier_replace(cls, &fte->rule));
1811     if (old) {
1812         fte_version_free(old->versions[index]);
1813         fte->versions[!index] = old->versions[!index];
1814         cls_rule_destroy(&old->rule);
1815         free(old);
1816     }
1817 }
1818
1819 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
1820  * with the specified 'index'.  Returns the flow formats able to represent the
1821  * flows that were read. */
1822 static enum ofputil_protocol
1823 read_flows_from_file(const char *filename, struct classifier *cls, int index)
1824 {
1825     enum ofputil_protocol usable_protocols;
1826     struct ds s;
1827     FILE *file;
1828
1829     file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1830     if (file == NULL) {
1831         ovs_fatal(errno, "%s: open", filename);
1832     }
1833
1834     ds_init(&s);
1835     usable_protocols = OFPUTIL_P_ANY;
1836     while (!ds_get_preprocessed_line(&s, file)) {
1837         struct fte_version *version;
1838         struct ofputil_flow_mod fm;
1839
1840         parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), true);
1841
1842         version = xmalloc(sizeof *version);
1843         version->cookie = fm.new_cookie;
1844         version->idle_timeout = fm.idle_timeout;
1845         version->hard_timeout = fm.hard_timeout;
1846         version->flags = fm.flags & (OFPFF_SEND_FLOW_REM | OFPFF10_EMERG);
1847         version->ofpacts = fm.ofpacts;
1848         version->ofpacts_len = fm.ofpacts_len;
1849
1850         usable_protocols &= ofputil_usable_protocols(&fm.match);
1851
1852         fte_insert(cls, &fm.match, fm.priority, version, index);
1853     }
1854     ds_destroy(&s);
1855
1856     if (file != stdin) {
1857         fclose(file);
1858     }
1859
1860     return usable_protocols;
1861 }
1862
1863 static bool
1864 recv_flow_stats_reply(struct vconn *vconn, ovs_be32 send_xid,
1865                       struct ofpbuf **replyp,
1866                       struct ofputil_flow_stats *fs, struct ofpbuf *ofpacts)
1867 {
1868     struct ofpbuf *reply = *replyp;
1869
1870     for (;;) {
1871         int retval;
1872         bool more;
1873
1874         /* Get a flow stats reply message, if we don't already have one. */
1875         if (!reply) {
1876             enum ofptype type;
1877             enum ofperr error;
1878
1879             do {
1880                 run(vconn_recv_block(vconn, &reply),
1881                     "OpenFlow packet receive failed");
1882             } while (((struct ofp_header *) reply->data)->xid != send_xid);
1883
1884             error = ofptype_decode(&type, reply->data);
1885             if (error || type != OFPTYPE_FLOW_STATS_REPLY) {
1886                 ovs_fatal(0, "received bad reply: %s",
1887                           ofp_to_string(reply->data, reply->size,
1888                                         verbosity + 1));
1889             }
1890         }
1891
1892         /* Pull an individual flow stats reply out of the message. */
1893         retval = ofputil_decode_flow_stats_reply(fs, reply, false, ofpacts);
1894         switch (retval) {
1895         case 0:
1896             *replyp = reply;
1897             return true;
1898
1899         case EOF:
1900             more = ofpmp_more(reply->l2);
1901             ofpbuf_delete(reply);
1902             reply = NULL;
1903             if (!more) {
1904                 *replyp = NULL;
1905                 return false;
1906             }
1907             break;
1908
1909         default:
1910             ovs_fatal(0, "parse error in reply (%s)",
1911                       ofperr_to_string(retval));
1912         }
1913     }
1914 }
1915
1916 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
1917  * format 'protocol', and adds them as flow table entries in 'cls' for the
1918  * version with the specified 'index'. */
1919 static void
1920 read_flows_from_switch(struct vconn *vconn,
1921                        enum ofputil_protocol protocol,
1922                        struct classifier *cls, int index)
1923 {
1924     struct ofputil_flow_stats_request fsr;
1925     struct ofputil_flow_stats fs;
1926     struct ofpbuf *request;
1927     struct ofpbuf ofpacts;
1928     struct ofpbuf *reply;
1929     ovs_be32 send_xid;
1930
1931     fsr.aggregate = false;
1932     match_init_catchall(&fsr.match);
1933     fsr.out_port = OFPP_NONE;
1934     fsr.table_id = 0xff;
1935     fsr.cookie = fsr.cookie_mask = htonll(0);
1936     request = ofputil_encode_flow_stats_request(&fsr, protocol);
1937     send_xid = ((struct ofp_header *) request->data)->xid;
1938     send_openflow_buffer(vconn, request);
1939
1940     reply = NULL;
1941     ofpbuf_init(&ofpacts, 0);
1942     while (recv_flow_stats_reply(vconn, send_xid, &reply, &fs, &ofpacts)) {
1943         struct fte_version *version;
1944
1945         version = xmalloc(sizeof *version);
1946         version->cookie = fs.cookie;
1947         version->idle_timeout = fs.idle_timeout;
1948         version->hard_timeout = fs.hard_timeout;
1949         version->flags = 0;
1950         version->ofpacts_len = fs.ofpacts_len;
1951         version->ofpacts = xmemdup(fs.ofpacts, fs.ofpacts_len);
1952
1953         fte_insert(cls, &fs.match, fs.priority, version, index);
1954     }
1955     ofpbuf_uninit(&ofpacts);
1956 }
1957
1958 static void
1959 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
1960                   enum ofputil_protocol protocol, struct list *packets)
1961 {
1962     const struct fte_version *version = fte->versions[index];
1963     struct ofputil_flow_mod fm;
1964     struct ofpbuf *ofm;
1965
1966     minimatch_expand(&fte->rule.match, &fm.match);
1967     fm.priority = fte->rule.priority;
1968     fm.cookie = htonll(0);
1969     fm.cookie_mask = htonll(0);
1970     fm.new_cookie = version->cookie;
1971     fm.table_id = 0xff;
1972     fm.command = command;
1973     fm.idle_timeout = version->idle_timeout;
1974     fm.hard_timeout = version->hard_timeout;
1975     fm.buffer_id = UINT32_MAX;
1976     fm.out_port = OFPP_NONE;
1977     fm.flags = version->flags;
1978     if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
1979         command == OFPFC_MODIFY_STRICT) {
1980         fm.ofpacts = version->ofpacts;
1981         fm.ofpacts_len = version->ofpacts_len;
1982     } else {
1983         fm.ofpacts = NULL;
1984         fm.ofpacts_len = 0;
1985     }
1986
1987     ofm = ofputil_encode_flow_mod(&fm, protocol);
1988     list_push_back(packets, &ofm->list_node);
1989 }
1990
1991 static void
1992 ofctl_replace_flows(int argc OVS_UNUSED, char *argv[])
1993 {
1994     enum { FILE_IDX = 0, SWITCH_IDX = 1 };
1995     enum ofputil_protocol usable_protocols, protocol;
1996     struct cls_cursor cursor;
1997     struct classifier cls;
1998     struct list requests;
1999     struct vconn *vconn;
2000     struct fte *fte;
2001
2002     classifier_init(&cls);
2003     usable_protocols = read_flows_from_file(argv[2], &cls, FILE_IDX);
2004
2005     protocol = open_vconn(argv[1], &vconn);
2006     protocol = set_protocol_for_flow_dump(vconn, protocol, usable_protocols);
2007
2008     read_flows_from_switch(vconn, protocol, &cls, SWITCH_IDX);
2009
2010     list_init(&requests);
2011
2012     /* Delete flows that exist on the switch but not in the file. */
2013     cls_cursor_init(&cursor, &cls, NULL);
2014     CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2015         struct fte_version *file_ver = fte->versions[FILE_IDX];
2016         struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2017
2018         if (sw_ver && !file_ver) {
2019             fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
2020                               protocol, &requests);
2021         }
2022     }
2023
2024     /* Add flows that exist in the file but not on the switch.
2025      * Update flows that exist in both places but differ. */
2026     cls_cursor_init(&cursor, &cls, NULL);
2027     CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2028         struct fte_version *file_ver = fte->versions[FILE_IDX];
2029         struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
2030
2031         if (file_ver
2032             && (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
2033             fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, protocol, &requests);
2034         }
2035     }
2036     transact_multiple_noreply(vconn, &requests);
2037     vconn_close(vconn);
2038
2039     fte_free_all(&cls);
2040 }
2041
2042 static void
2043 read_flows_from_source(const char *source, struct classifier *cls, int index)
2044 {
2045     struct stat s;
2046
2047     if (source[0] == '/' || source[0] == '.'
2048         || (!strchr(source, ':') && !stat(source, &s))) {
2049         read_flows_from_file(source, cls, index);
2050     } else {
2051         enum ofputil_protocol protocol;
2052         struct vconn *vconn;
2053
2054         protocol = open_vconn(source, &vconn);
2055         protocol = set_protocol_for_flow_dump(vconn, protocol, OFPUTIL_P_ANY);
2056         read_flows_from_switch(vconn, protocol, cls, index);
2057         vconn_close(vconn);
2058     }
2059 }
2060
2061 static void
2062 ofctl_diff_flows(int argc OVS_UNUSED, char *argv[])
2063 {
2064     bool differences = false;
2065     struct cls_cursor cursor;
2066     struct classifier cls;
2067     struct ds a_s, b_s;
2068     struct fte *fte;
2069
2070     classifier_init(&cls);
2071     read_flows_from_source(argv[1], &cls, 0);
2072     read_flows_from_source(argv[2], &cls, 1);
2073
2074     ds_init(&a_s);
2075     ds_init(&b_s);
2076
2077     cls_cursor_init(&cursor, &cls, NULL);
2078     CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
2079         struct fte_version *a = fte->versions[0];
2080         struct fte_version *b = fte->versions[1];
2081
2082         if (!a || !b || !fte_version_equals(a, b)) {
2083             fte_version_format(fte, 0, &a_s);
2084             fte_version_format(fte, 1, &b_s);
2085             if (strcmp(ds_cstr(&a_s), ds_cstr(&b_s))) {
2086                 if (a_s.length) {
2087                     printf("-%s", ds_cstr(&a_s));
2088                 }
2089                 if (b_s.length) {
2090                     printf("+%s", ds_cstr(&b_s));
2091                 }
2092                 differences = true;
2093             }
2094         }
2095     }
2096
2097     ds_destroy(&a_s);
2098     ds_destroy(&b_s);
2099
2100     fte_free_all(&cls);
2101
2102     if (differences) {
2103         exit(2);
2104     }
2105 }
2106 \f
2107 /* Undocumented commands for unit testing. */
2108
2109 static void
2110 ofctl_parse_flows__(struct ofputil_flow_mod *fms, size_t n_fms)
2111 {
2112     enum ofputil_protocol usable_protocols;
2113     enum ofputil_protocol protocol = 0;
2114     char *usable_s;
2115     size_t i;
2116
2117     usable_protocols = ofputil_flow_mod_usable_protocols(fms, n_fms);
2118     usable_s = ofputil_protocols_to_string(usable_protocols);
2119     printf("usable protocols: %s\n", usable_s);
2120     free(usable_s);
2121
2122     if (!(usable_protocols & allowed_protocols)) {
2123         ovs_fatal(0, "no usable protocol");
2124     }
2125     for (i = 0; i < sizeof(enum ofputil_protocol) * CHAR_BIT; i++) {
2126         protocol = 1 << i;
2127         if (protocol & usable_protocols & allowed_protocols) {
2128             break;
2129         }
2130     }
2131     assert(IS_POW2(protocol));
2132
2133     printf("chosen protocol: %s\n", ofputil_protocol_to_string(protocol));
2134
2135     for (i = 0; i < n_fms; i++) {
2136         struct ofputil_flow_mod *fm = &fms[i];
2137         struct ofpbuf *msg;
2138
2139         msg = ofputil_encode_flow_mod(fm, protocol);
2140         ofp_print(stdout, msg->data, msg->size, verbosity);
2141         ofpbuf_delete(msg);
2142
2143         free(fm->ofpacts);
2144     }
2145 }
2146
2147 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
2148  * it back to stdout.  */
2149 static void
2150 ofctl_parse_flow(int argc OVS_UNUSED, char *argv[])
2151 {
2152     struct ofputil_flow_mod fm;
2153
2154     parse_ofp_flow_mod_str(&fm, argv[1], OFPFC_ADD, false);
2155     ofctl_parse_flows__(&fm, 1);
2156 }
2157
2158 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
2159  * add-flows) and prints each of the flows back to stdout.  */
2160 static void
2161 ofctl_parse_flows(int argc OVS_UNUSED, char *argv[])
2162 {
2163     struct ofputil_flow_mod *fms = NULL;
2164     size_t n_fms = 0;
2165
2166     parse_ofp_flow_mod_file(argv[1], OFPFC_ADD, &fms, &n_fms);
2167     ofctl_parse_flows__(fms, n_fms);
2168     free(fms);
2169 }
2170
2171 static void
2172 ofctl_parse_nxm__(bool oxm)
2173 {
2174     struct ds in;
2175
2176     ds_init(&in);
2177     while (!ds_get_test_line(&in, stdin)) {
2178         struct ofpbuf nx_match;
2179         struct match match;
2180         ovs_be64 cookie, cookie_mask;
2181         enum ofperr error;
2182         int match_len;
2183
2184         /* Convert string to nx_match. */
2185         ofpbuf_init(&nx_match, 0);
2186         if (oxm) {
2187             match_len = oxm_match_from_string(ds_cstr(&in), &nx_match);
2188         } else {
2189             match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
2190         }
2191
2192         /* Convert nx_match to match. */
2193         if (strict) {
2194             if (oxm) {
2195                 error = oxm_pull_match(&nx_match, &match);
2196             } else {
2197                 error = nx_pull_match(&nx_match, match_len, &match,
2198                                       &cookie, &cookie_mask);
2199             }
2200         } else {
2201             if (oxm) {
2202                 error = oxm_pull_match_loose(&nx_match, &match);
2203             } else {
2204                 error = nx_pull_match_loose(&nx_match, match_len, &match,
2205                                             &cookie, &cookie_mask);
2206             }
2207         }
2208
2209
2210         if (!error) {
2211             char *out;
2212
2213             /* Convert match back to nx_match. */
2214             ofpbuf_uninit(&nx_match);
2215             ofpbuf_init(&nx_match, 0);
2216             if (oxm) {
2217                 match_len = oxm_put_match(&nx_match, &match);
2218                 out = oxm_match_to_string(nx_match.data, match_len);
2219             } else {
2220                 match_len = nx_put_match(&nx_match, &match,
2221                                          cookie, cookie_mask);
2222                 out = nx_match_to_string(nx_match.data, match_len);
2223             }
2224
2225             puts(out);
2226             free(out);
2227         } else {
2228             printf("nx_pull_match() returned error %s\n",
2229                    ofperr_get_name(error));
2230         }
2231
2232         ofpbuf_uninit(&nx_match);
2233     }
2234     ds_destroy(&in);
2235 }
2236
2237 /* "parse-nxm": reads a series of NXM nx_match specifications as strings from
2238  * stdin, does some internal fussing with them, and then prints them back as
2239  * strings on stdout. */
2240 static void
2241 ofctl_parse_nxm(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2242 {
2243     return ofctl_parse_nxm__(false);
2244 }
2245
2246 /* "parse-oxm": reads a series of OXM nx_match specifications as strings from
2247  * stdin, does some internal fussing with them, and then prints them back as
2248  * strings on stdout. */
2249 static void
2250 ofctl_parse_oxm(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2251 {
2252     return ofctl_parse_nxm__(true);
2253 }
2254
2255 static void
2256 print_differences(const char *prefix,
2257                   const void *a_, size_t a_len,
2258                   const void *b_, size_t b_len)
2259 {
2260     const uint8_t *a = a_;
2261     const uint8_t *b = b_;
2262     size_t i;
2263
2264     for (i = 0; i < MIN(a_len, b_len); i++) {
2265         if (a[i] != b[i]) {
2266             printf("%s%2zu: %02"PRIx8" -> %02"PRIx8"\n",
2267                    prefix, i, a[i], b[i]);
2268         }
2269     }
2270     for (i = a_len; i < b_len; i++) {
2271         printf("%s%2zu: (none) -> %02"PRIx8"\n", prefix, i, b[i]);
2272     }
2273     for (i = b_len; i < a_len; i++) {
2274         printf("%s%2zu: %02"PRIx8" -> (none)\n", prefix, i, a[i]);
2275     }
2276 }
2277
2278 /* "parse-ofp10-actions": reads a series of OpenFlow 1.0 action specifications
2279  * as hex bytes from stdin, converts them to ofpacts, prints them as strings
2280  * on stdout, and then converts them back to hex bytes and prints any
2281  * differences from the input. */
2282 static void
2283 ofctl_parse_ofp10_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2284 {
2285     struct ds in;
2286
2287     ds_init(&in);
2288     while (!ds_get_preprocessed_line(&in, stdin)) {
2289         struct ofpbuf of10_out;
2290         struct ofpbuf of10_in;
2291         struct ofpbuf ofpacts;
2292         enum ofperr error;
2293         size_t size;
2294         struct ds s;
2295
2296         /* Parse hex bytes. */
2297         ofpbuf_init(&of10_in, 0);
2298         if (ofpbuf_put_hex(&of10_in, ds_cstr(&in), NULL)[0] != '\0') {
2299             ovs_fatal(0, "Trailing garbage in hex data");
2300         }
2301
2302         /* Convert to ofpacts. */
2303         ofpbuf_init(&ofpacts, 0);
2304         size = of10_in.size;
2305         error = ofpacts_pull_openflow10(&of10_in, of10_in.size, &ofpacts);
2306         if (error) {
2307             printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error));
2308             ofpbuf_uninit(&ofpacts);
2309             ofpbuf_uninit(&of10_in);
2310             continue;
2311         }
2312         ofpbuf_push_uninit(&of10_in, size);
2313
2314         /* Print cls_rule. */
2315         ds_init(&s);
2316         ofpacts_format(ofpacts.data, ofpacts.size, &s);
2317         puts(ds_cstr(&s));
2318         ds_destroy(&s);
2319
2320         /* Convert back to ofp10 actions and print differences from input. */
2321         ofpbuf_init(&of10_out, 0);
2322         ofpacts_put_openflow10(ofpacts.data, ofpacts.size, &of10_out);
2323
2324         print_differences("", of10_in.data, of10_in.size,
2325                           of10_out.data, of10_out.size);
2326         putchar('\n');
2327
2328         ofpbuf_uninit(&ofpacts);
2329         ofpbuf_uninit(&of10_in);
2330         ofpbuf_uninit(&of10_out);
2331     }
2332     ds_destroy(&in);
2333 }
2334
2335 /* "parse-ofp10-match": reads a series of ofp10_match specifications as hex
2336  * bytes from stdin, converts them to cls_rules, prints them as strings on
2337  * stdout, and then converts them back to hex bytes and prints any differences
2338  * from the input.
2339  *
2340  * The input hex bytes may contain "x"s to represent "don't-cares", bytes whose
2341  * values are ignored in the input and will be set to zero when OVS converts
2342  * them back to hex bytes.  ovs-ofctl actually sets "x"s to random bits when
2343  * it does the conversion to hex, to ensure that in fact they are ignored. */
2344 static void
2345 ofctl_parse_ofp10_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2346 {
2347     struct ds expout;
2348     struct ds in;
2349
2350     ds_init(&in);
2351     ds_init(&expout);
2352     while (!ds_get_preprocessed_line(&in, stdin)) {
2353         struct ofpbuf match_in, match_expout;
2354         struct ofp10_match match_out;
2355         struct ofp10_match match_normal;
2356         struct match match;
2357         char *p;
2358
2359         /* Parse hex bytes to use for expected output. */
2360         ds_clear(&expout);
2361         ds_put_cstr(&expout, ds_cstr(&in));
2362         for (p = ds_cstr(&expout); *p; p++) {
2363             if (*p == 'x') {
2364                 *p = '0';
2365             }
2366         }
2367         ofpbuf_init(&match_expout, 0);
2368         if (ofpbuf_put_hex(&match_expout, ds_cstr(&expout), NULL)[0] != '\0') {
2369             ovs_fatal(0, "Trailing garbage in hex data");
2370         }
2371         if (match_expout.size != sizeof(struct ofp10_match)) {
2372             ovs_fatal(0, "Input is %zu bytes, expected %zu",
2373                       match_expout.size, sizeof(struct ofp10_match));
2374         }
2375
2376         /* Parse hex bytes for input. */
2377         for (p = ds_cstr(&in); *p; p++) {
2378             if (*p == 'x') {
2379                 *p = "0123456789abcdef"[random_uint32() & 0xf];
2380             }
2381         }
2382         ofpbuf_init(&match_in, 0);
2383         if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
2384             ovs_fatal(0, "Trailing garbage in hex data");
2385         }
2386         if (match_in.size != sizeof(struct ofp10_match)) {
2387             ovs_fatal(0, "Input is %zu bytes, expected %zu",
2388                       match_in.size, sizeof(struct ofp10_match));
2389         }
2390
2391         /* Convert to cls_rule and print. */
2392         ofputil_match_from_ofp10_match(match_in.data, &match);
2393         match_print(&match);
2394
2395         /* Convert back to ofp10_match and print differences from input. */
2396         ofputil_match_to_ofp10_match(&match, &match_out);
2397         print_differences("", match_expout.data, match_expout.size,
2398                           &match_out, sizeof match_out);
2399
2400         /* Normalize, then convert and compare again. */
2401         ofputil_normalize_match(&match);
2402         ofputil_match_to_ofp10_match(&match, &match_normal);
2403         print_differences("normal: ", &match_out, sizeof match_out,
2404                           &match_normal, sizeof match_normal);
2405         putchar('\n');
2406
2407         ofpbuf_uninit(&match_in);
2408         ofpbuf_uninit(&match_expout);
2409     }
2410     ds_destroy(&in);
2411     ds_destroy(&expout);
2412 }
2413
2414 /* "parse-ofp11-match": reads a series of ofp11_match specifications as hex
2415  * bytes from stdin, converts them to "struct match"es, prints them as strings
2416  * on stdout, and then converts them back to hex bytes and prints any
2417  * differences from the input. */
2418 static void
2419 ofctl_parse_ofp11_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2420 {
2421     struct ds in;
2422
2423     ds_init(&in);
2424     while (!ds_get_preprocessed_line(&in, stdin)) {
2425         struct ofpbuf match_in;
2426         struct ofp11_match match_out;
2427         struct match match;
2428         enum ofperr error;
2429
2430         /* Parse hex bytes. */
2431         ofpbuf_init(&match_in, 0);
2432         if (ofpbuf_put_hex(&match_in, ds_cstr(&in), NULL)[0] != '\0') {
2433             ovs_fatal(0, "Trailing garbage in hex data");
2434         }
2435         if (match_in.size != sizeof(struct ofp11_match)) {
2436             ovs_fatal(0, "Input is %zu bytes, expected %zu",
2437                       match_in.size, sizeof(struct ofp11_match));
2438         }
2439
2440         /* Convert to match. */
2441         error = ofputil_match_from_ofp11_match(match_in.data, &match);
2442         if (error) {
2443             printf("bad ofp11_match: %s\n\n", ofperr_get_name(error));
2444             ofpbuf_uninit(&match_in);
2445             continue;
2446         }
2447
2448         /* Print match. */
2449         match_print(&match);
2450
2451         /* Convert back to ofp11_match and print differences from input. */
2452         ofputil_match_to_ofp11_match(&match, &match_out);
2453
2454         print_differences("", match_in.data, match_in.size,
2455                           &match_out, sizeof match_out);
2456         putchar('\n');
2457
2458         ofpbuf_uninit(&match_in);
2459     }
2460     ds_destroy(&in);
2461 }
2462
2463 /* "parse-ofp11-actions": reads a series of OpenFlow 1.1 action specifications
2464  * as hex bytes from stdin, converts them to ofpacts, prints them as strings
2465  * on stdout, and then converts them back to hex bytes and prints any
2466  * differences from the input. */
2467 static void
2468 ofctl_parse_ofp11_actions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2469 {
2470     struct ds in;
2471
2472     ds_init(&in);
2473     while (!ds_get_preprocessed_line(&in, stdin)) {
2474         struct ofpbuf of11_out;
2475         struct ofpbuf of11_in;
2476         struct ofpbuf ofpacts;
2477         enum ofperr error;
2478         size_t size;
2479         struct ds s;
2480
2481         /* Parse hex bytes. */
2482         ofpbuf_init(&of11_in, 0);
2483         if (ofpbuf_put_hex(&of11_in, ds_cstr(&in), NULL)[0] != '\0') {
2484             ovs_fatal(0, "Trailing garbage in hex data");
2485         }
2486
2487         /* Convert to ofpacts. */
2488         ofpbuf_init(&ofpacts, 0);
2489         size = of11_in.size;
2490         error = ofpacts_pull_openflow11_actions(&of11_in, of11_in.size,
2491                                                 &ofpacts);
2492         if (error) {
2493             printf("bad OF1.1 actions: %s\n\n", ofperr_get_name(error));
2494             ofpbuf_uninit(&ofpacts);
2495             ofpbuf_uninit(&of11_in);
2496             continue;
2497         }
2498         ofpbuf_push_uninit(&of11_in, size);
2499
2500         /* Print cls_rule. */
2501         ds_init(&s);
2502         ofpacts_format(ofpacts.data, ofpacts.size, &s);
2503         puts(ds_cstr(&s));
2504         ds_destroy(&s);
2505
2506         /* Convert back to ofp11 actions and print differences from input. */
2507         ofpbuf_init(&of11_out, 0);
2508         ofpacts_put_openflow11_actions(ofpacts.data, ofpacts.size, &of11_out);
2509
2510         print_differences("", of11_in.data, of11_in.size,
2511                           of11_out.data, of11_out.size);
2512         putchar('\n');
2513
2514         ofpbuf_uninit(&ofpacts);
2515         ofpbuf_uninit(&of11_in);
2516         ofpbuf_uninit(&of11_out);
2517     }
2518     ds_destroy(&in);
2519 }
2520
2521 /* "parse-ofp11-instructions": reads a series of OpenFlow 1.1 instruction
2522  * specifications as hex bytes from stdin, converts them to ofpacts, prints
2523  * them as strings on stdout, and then converts them back to hex bytes and
2524  * prints any differences from the input. */
2525 static void
2526 ofctl_parse_ofp11_instructions(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
2527 {
2528     struct ds in;
2529
2530     ds_init(&in);
2531     while (!ds_get_preprocessed_line(&in, stdin)) {
2532         struct ofpbuf of11_out;
2533         struct ofpbuf of11_in;
2534         struct ofpbuf ofpacts;
2535         enum ofperr error;
2536         size_t size;
2537         struct ds s;
2538
2539         /* Parse hex bytes. */
2540         ofpbuf_init(&of11_in, 0);
2541         if (ofpbuf_put_hex(&of11_in, ds_cstr(&in), NULL)[0] != '\0') {
2542             ovs_fatal(0, "Trailing garbage in hex data");
2543         }
2544
2545         /* Convert to ofpacts. */
2546         ofpbuf_init(&ofpacts, 0);
2547         size = of11_in.size;
2548         error = ofpacts_pull_openflow11_instructions(&of11_in, of11_in.size,
2549                                                      &ofpacts);
2550         if (error) {
2551             printf("bad OF1.1 instructions: %s\n\n", ofperr_get_name(error));
2552             ofpbuf_uninit(&ofpacts);
2553             ofpbuf_uninit(&of11_in);
2554             continue;
2555         }
2556         ofpbuf_push_uninit(&of11_in, size);
2557
2558         /* Print cls_rule. */
2559         ds_init(&s);
2560         ofpacts_format(ofpacts.data, ofpacts.size, &s);
2561         puts(ds_cstr(&s));
2562         ds_destroy(&s);
2563
2564         /* Convert back to ofp11 instructions and print differences from
2565          * input. */
2566         ofpbuf_init(&of11_out, 0);
2567         ofpacts_put_openflow11_instructions(ofpacts.data, ofpacts.size,
2568                                             &of11_out);
2569
2570         print_differences("", of11_in.data, of11_in.size,
2571                           of11_out.data, of11_out.size);
2572         putchar('\n');
2573
2574         ofpbuf_uninit(&ofpacts);
2575         ofpbuf_uninit(&of11_in);
2576         ofpbuf_uninit(&of11_out);
2577     }
2578     ds_destroy(&in);
2579 }
2580
2581 /* "check-vlan VLAN_TCI VLAN_TCI_MASK": converts the specified vlan_tci and
2582  * mask values to and from various formats and prints the results. */
2583 static void
2584 ofctl_check_vlan(int argc OVS_UNUSED, char *argv[])
2585 {
2586     struct match match;
2587
2588     char *string_s;
2589     struct ofputil_flow_mod fm;
2590
2591     struct ofpbuf nxm;
2592     struct match nxm_match;
2593     int nxm_match_len;
2594     char *nxm_s;
2595
2596     struct ofp10_match of10_raw;
2597     struct match of10_match;
2598
2599     struct ofp11_match of11_raw;
2600     struct match of11_match;
2601
2602     enum ofperr error;
2603
2604     match_init_catchall(&match);
2605     match.flow.vlan_tci = htons(strtoul(argv[1], NULL, 16));
2606     match.wc.masks.vlan_tci = htons(strtoul(argv[2], NULL, 16));
2607
2608     /* Convert to and from string. */
2609     string_s = match_to_string(&match, OFP_DEFAULT_PRIORITY);
2610     printf("%s -> ", string_s);
2611     fflush(stdout);
2612     parse_ofp_str(&fm, -1, string_s, false);
2613     printf("%04"PRIx16"/%04"PRIx16"\n",
2614            ntohs(fm.match.flow.vlan_tci),
2615            ntohs(fm.match.wc.masks.vlan_tci));
2616     free(string_s);
2617
2618     /* Convert to and from NXM. */
2619     ofpbuf_init(&nxm, 0);
2620     nxm_match_len = nx_put_match(&nxm, &match, htonll(0), htonll(0));
2621     nxm_s = nx_match_to_string(nxm.data, nxm_match_len);
2622     error = nx_pull_match(&nxm, nxm_match_len, &nxm_match, NULL, NULL);
2623     printf("NXM: %s -> ", nxm_s);
2624     if (error) {
2625         printf("%s\n", ofperr_to_string(error));
2626     } else {
2627         printf("%04"PRIx16"/%04"PRIx16"\n",
2628                ntohs(nxm_match.flow.vlan_tci),
2629                ntohs(nxm_match.wc.masks.vlan_tci));
2630     }
2631     free(nxm_s);
2632     ofpbuf_uninit(&nxm);
2633
2634     /* Convert to and from OXM. */
2635     ofpbuf_init(&nxm, 0);
2636     nxm_match_len = oxm_put_match(&nxm, &match);
2637     nxm_s = oxm_match_to_string(nxm.data, nxm_match_len);
2638     error = oxm_pull_match(&nxm, &nxm_match);
2639     printf("OXM: %s -> ", nxm_s);
2640     if (error) {
2641         printf("%s\n", ofperr_to_string(error));
2642     } else {
2643         uint16_t vid = ntohs(nxm_match.flow.vlan_tci) &
2644             (VLAN_VID_MASK | VLAN_CFI);
2645         uint16_t mask = ntohs(nxm_match.wc.masks.vlan_tci) &
2646             (VLAN_VID_MASK | VLAN_CFI);
2647
2648         printf("%04"PRIx16"/%04"PRIx16",", vid, mask);
2649         if (vid && vlan_tci_to_pcp(nxm_match.wc.masks.vlan_tci)) {
2650             printf("%02"PRIx8"\n", vlan_tci_to_pcp(nxm_match.flow.vlan_tci));
2651         } else {
2652             printf("--\n");
2653         }
2654     }
2655     free(nxm_s);
2656     ofpbuf_uninit(&nxm);
2657
2658     /* Convert to and from OpenFlow 1.0. */
2659     ofputil_match_to_ofp10_match(&match, &of10_raw);
2660     ofputil_match_from_ofp10_match(&of10_raw, &of10_match);
2661     printf("OF1.0: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
2662            ntohs(of10_raw.dl_vlan),
2663            (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN)) != 0,
2664            of10_raw.dl_vlan_pcp,
2665            (of10_raw.wildcards & htonl(OFPFW10_DL_VLAN_PCP)) != 0,
2666            ntohs(of10_match.flow.vlan_tci),
2667            ntohs(of10_match.wc.masks.vlan_tci));
2668
2669     /* Convert to and from OpenFlow 1.1. */
2670     ofputil_match_to_ofp11_match(&match, &of11_raw);
2671     ofputil_match_from_ofp11_match(&of11_raw, &of11_match);
2672     printf("OF1.1: %04"PRIx16"/%d,%02"PRIx8"/%d -> %04"PRIx16"/%04"PRIx16"\n",
2673            ntohs(of11_raw.dl_vlan),
2674            (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN)) != 0,
2675            of11_raw.dl_vlan_pcp,
2676            (of11_raw.wildcards & htonl(OFPFW11_DL_VLAN_PCP)) != 0,
2677            ntohs(of11_match.flow.vlan_tci),
2678            ntohs(of11_match.wc.masks.vlan_tci));
2679 }
2680
2681 /* "print-error ENUM": Prints the type and code of ENUM for every OpenFlow
2682  * version. */
2683 static void
2684 ofctl_print_error(int argc OVS_UNUSED, char *argv[])
2685 {
2686     enum ofperr error;
2687     int version;
2688
2689     error = ofperr_from_name(argv[1]);
2690     if (!error) {
2691         ovs_fatal(0, "unknown error \"%s\"", argv[1]);
2692     }
2693
2694     for (version = 0; version <= UINT8_MAX; version++) {
2695         const char *name = ofperr_domain_get_name(version);
2696         if (!name) {
2697             continue;
2698         }
2699         printf("%s: %d,%d\n",
2700                ofperr_domain_get_name(version),
2701                ofperr_get_type(error, version),
2702                ofperr_get_code(error, version));
2703     }
2704 }
2705
2706 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
2707  * binary data, interpreting them as an OpenFlow message, and prints the
2708  * OpenFlow message on stdout, at VERBOSITY (level 2 by default).  */
2709 static void
2710 ofctl_ofp_print(int argc, char *argv[])
2711 {
2712     struct ofpbuf packet;
2713
2714     ofpbuf_init(&packet, strlen(argv[1]) / 2);
2715     if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
2716         ovs_fatal(0, "trailing garbage following hex bytes");
2717     }
2718     ofp_print(stdout, packet.data, packet.size, argc > 2 ? atoi(argv[2]) : 2);
2719     ofpbuf_uninit(&packet);
2720 }
2721
2722 static const struct command all_commands[] = {
2723     { "show", 1, 1, ofctl_show },
2724     { "monitor", 1, 3, ofctl_monitor },
2725     { "snoop", 1, 1, ofctl_snoop },
2726     { "dump-desc", 1, 1, ofctl_dump_desc },
2727     { "dump-tables", 1, 1, ofctl_dump_tables },
2728     { "dump-flows", 1, 2, ofctl_dump_flows },
2729     { "dump-aggregate", 1, 2, ofctl_dump_aggregate },
2730     { "queue-stats", 1, 3, ofctl_queue_stats },
2731     { "add-flow", 2, 2, ofctl_add_flow },
2732     { "add-flows", 2, 2, ofctl_add_flows },
2733     { "mod-flows", 2, 2, ofctl_mod_flows },
2734     { "del-flows", 1, 2, ofctl_del_flows },
2735     { "replace-flows", 2, 2, ofctl_replace_flows },
2736     { "diff-flows", 2, 2, ofctl_diff_flows },
2737     { "packet-out", 4, INT_MAX, ofctl_packet_out },
2738     { "dump-ports", 1, 2, ofctl_dump_ports },
2739     { "dump-ports-desc", 1, 1, ofctl_dump_ports_desc },
2740     { "mod-port", 3, 3, ofctl_mod_port },
2741     { "get-frags", 1, 1, ofctl_get_frags },
2742     { "set-frags", 2, 2, ofctl_set_frags },
2743     { "probe", 1, 1, ofctl_probe },
2744     { "ping", 1, 2, ofctl_ping },
2745     { "benchmark", 3, 3, ofctl_benchmark },
2746     { "help", 0, INT_MAX, ofctl_help },
2747
2748     /* Undocumented commands for testing. */
2749     { "parse-flow", 1, 1, ofctl_parse_flow },
2750     { "parse-flows", 1, 1, ofctl_parse_flows },
2751     { "parse-nx-match", 0, 0, ofctl_parse_nxm },
2752     { "parse-nxm", 0, 0, ofctl_parse_nxm },
2753     { "parse-oxm", 0, 0, ofctl_parse_oxm },
2754     { "parse-ofp10-actions", 0, 0, ofctl_parse_ofp10_actions },
2755     { "parse-ofp10-match", 0, 0, ofctl_parse_ofp10_match },
2756     { "parse-ofp11-match", 0, 0, ofctl_parse_ofp11_match },
2757     { "parse-ofp11-actions", 0, 0, ofctl_parse_ofp11_actions },
2758     { "parse-ofp11-instructions", 0, 0, ofctl_parse_ofp11_instructions },
2759     { "check-vlan", 2, 2, ofctl_check_vlan },
2760     { "print-error", 1, 1, ofctl_print_error },
2761     { "ofp-print", 1, 2, ofctl_ofp_print },
2762
2763     { NULL, 0, 0, NULL },
2764 };