utilities/ovs-ofctl.c

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