utilities/ovs-ofctl.c

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