pintos-os.org Git - openvswitch/blob - utilities/ovs-ofctl.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira Networks.
   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 <errno.h>
  19 #include <getopt.h>
  20 #include <inttypes.h>
  21 #include <sys/socket.h>
  22 #include <net/if.h>
  23 #include <signal.h>
  24 #include <stdlib.h>
  25 #include <string.h>
  26 #include <unistd.h>
  27 #include <sys/stat.h>
  28 #include <sys/time.h>
  29
  30 #include "byte-order.h"
  31 #include "classifier.h"
  32 #include "command-line.h"
  33 #include "daemon.h"
  34 #include "compiler.h"
  35 #include "dirs.h"
  36 #include "dynamic-string.h"
  37 #include "netlink.h"
  38 #include "nx-match.h"
  39 #include "odp-util.h"
  40 #include "ofp-errors.h"
  41 #include "ofp-parse.h"
  42 #include "ofp-print.h"
  43 #include "ofp-util.h"
  44 #include "ofpbuf.h"
  45 #include "ofproto/ofproto.h"
  46 #include "openflow/nicira-ext.h"
  47 #include "openflow/openflow.h"
  48 #include "poll-loop.h"
  49 #include "random.h"
  50 #include "stream-ssl.h"
  51 #include "timeval.h"
  52 #include "unixctl.h"
  53 #include "util.h"
  54 #include "vconn.h"
  55 #include "vlog.h"
  56
  57 VLOG_DEFINE_THIS_MODULE(ofctl);
  58
  59 /* --strict: Use strict matching for flow mod commands?  Additionally governs
  60  * use of nx_pull_match() instead of nx_pull_match_loose() in parse-nx-match.
  61  */
  62 static bool strict;
  63
  64 /* --readd: If true, on replace-flows, re-add even flows that have not changed
  65  * (to reset flow counters). */
  66 static bool readd;
  67
  68 /* -F, --flow-format: Flow format to use.  Either one of NXFF_* to force a
  69  * particular flow format or -1 to let ovs-ofctl choose intelligently. */
  70 static int preferred_flow_format = -1;
  71
  72 /* -P, --packet-in-format: Packet IN format to use in monitor and snoop
  73  * commands.  Either one of NXPIF_* to force a particular packet_in format, or
  74  * -1 to let ovs-ofctl choose the default. */
  75 static int preferred_packet_in_format = -1;
  76
  77 /* -m, --more: Additional verbosity for ofp-print functions. */
  78 static int verbosity;
  79
  80 static const struct command all_commands[];
  81
  82 static void usage(void) NO_RETURN;
  83 static void parse_options(int argc, char *argv[]);
  84
  85 int
  86 main(int argc, char *argv[])
  87 {
  88     set_program_name(argv[0]);
  89     parse_options(argc, argv);
  90     signal(SIGPIPE, SIG_IGN);
  91     run_command(argc - optind, argv + optind, all_commands);
  92     return 0;
  93 }
  94
  95 static void
  96 parse_options(int argc, char *argv[])
  97 {
  98     enum {
  99         OPT_STRICT = UCHAR_MAX + 1,
 100         OPT_READD,
 101         DAEMON_OPTION_ENUMS,
 102         VLOG_OPTION_ENUMS
 103     };
 104     static struct option long_options[] = {
 105         {"timeout", required_argument, NULL, 't'},
 106         {"strict", no_argument, NULL, OPT_STRICT},
 107         {"readd", no_argument, NULL, OPT_READD},
 108         {"flow-format", required_argument, NULL, 'F'},
 109         {"packet-in-format", required_argument, NULL, 'P'},
 110         {"more", no_argument, NULL, 'm'},
 111         {"help", no_argument, NULL, 'h'},
 112         {"version", no_argument, NULL, 'V'},
 113         DAEMON_LONG_OPTIONS,
 114         VLOG_LONG_OPTIONS,
 115         STREAM_SSL_LONG_OPTIONS,
 116         {NULL, 0, NULL, 0},
 117     };
 118     char *short_options = long_options_to_short_options(long_options);
 119
 120     for (;;) {
 121         unsigned long int timeout;
 122         int c;
 123
 124         c = getopt_long(argc, argv, short_options, long_options, NULL);
 125         if (c == -1) {
 126             break;
 127         }
 128
 129         switch (c) {
 130         case 't':
 131             timeout = strtoul(optarg, NULL, 10);
 132             if (timeout <= 0) {
 133                 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
 134                           optarg);
 135             } else {
 136                 time_alarm(timeout);
 137             }
 138             break;
 139
 140         case 'F':
 141             preferred_flow_format = ofputil_flow_format_from_string(optarg);
 142             if (preferred_flow_format < 0) {
 143                 ovs_fatal(0, "unknown flow format `%s'", optarg);
 144             }
 145             break;
 146
 147         case 'P':
 148             preferred_packet_in_format =
 149                 ofputil_packet_in_format_from_string(optarg);
 150             if (preferred_packet_in_format < 0) {
 151                 ovs_fatal(0, "unknown packet-in format `%s'", optarg);
 152             }
 153             break;
 154
 155         case 'm':
 156             verbosity++;
 157             break;
 158
 159         case 'h':
 160             usage();
 161
 162         case 'V':
 163             ovs_print_version(OFP_VERSION, OFP_VERSION);
 164             exit(EXIT_SUCCESS);
 165
 166         case OPT_STRICT:
 167             strict = true;
 168             break;
 169
 170         case OPT_READD:
 171             readd = true;
 172             break;
 173
 174         DAEMON_OPTION_HANDLERS
 175         VLOG_OPTION_HANDLERS
 176         STREAM_SSL_OPTION_HANDLERS
 177
 178         case '?':
 179             exit(EXIT_FAILURE);
 180
 181         default:
 182             abort();
 183         }
 184     }
 185     free(short_options);
 186 }
 187
 188 static void
 189 usage(void)
 190 {
 191     printf("%s: OpenFlow switch management utility\n"
 192            "usage: %s [OPTIONS] COMMAND [ARG...]\n"
 193            "\nFor OpenFlow switches:\n"
 194            "  show SWITCH                 show OpenFlow information\n"
 195            "  dump-desc SWITCH            print switch description\n"
 196            "  dump-tables SWITCH          print table stats\n"
 197            "  mod-port SWITCH IFACE ACT   modify port behavior\n"
 198            "  get-frags SWITCH            print fragment handling behavior\n"
 199            "  set-frags SWITCH FRAG_MODE  set fragment handling behavior\n"
 200            "  dump-ports SWITCH [PORT]    print port statistics\n"
 201            "  dump-flows SWITCH           print all flow entries\n"
 202            "  dump-flows SWITCH FLOW      print matching FLOWs\n"
 203            "  dump-aggregate SWITCH       print aggregate flow statistics\n"
 204            "  dump-aggregate SWITCH FLOW  print aggregate stats for FLOWs\n"
 205            "  queue-stats SWITCH [PORT [QUEUE]]  dump queue stats\n"
 206            "  add-flow SWITCH FLOW        add flow described by FLOW\n"
 207            "  add-flows SWITCH FILE       add flows from FILE\n"
 208            "  mod-flows SWITCH FLOW       modify actions of matching FLOWs\n"
 209            "  del-flows SWITCH [FLOW]     delete matching FLOWs\n"
 210            "  replace-flows SWITCH FILE   replace flows with those in FILE\n"
 211            "  diff-flows SOURCE1 SOURCE2  compare flows from two sources\n"
 212            "  monitor SWITCH [MISSLEN] [invalid_ttl]\n"
 213            "                              print packets received from SWITCH\n"
 214            "  snoop SWITCH                snoop on SWITCH and its controller\n"
 215            "\nFor OpenFlow switches and controllers:\n"
 216            "  probe TARGET                probe whether TARGET is up\n"
 217            "  ping TARGET [N]             latency of N-byte echos\n"
 218            "  benchmark TARGET N COUNT    bandwidth of COUNT N-byte echos\n"
 219            "where SWITCH or TARGET is an active OpenFlow connection method.\n",
 220            program_name, program_name);
 221     vconn_usage(true, false, false);
 222     daemon_usage();
 223     vlog_usage();
 224     printf("\nOther options:\n"
 225            "  --strict                    use strict match for flow commands\n"
 226            "  --readd                     replace flows that haven't changed\n"
 227            "  -F, --flow-format=FORMAT    force particular flow format\n"
 228            "  -P, --packet-in-format=FRMT force particular packet in format\n"
 229            "  -m, --more                  be more verbose printing OpenFlow\n"
 230            "  -t, --timeout=SECS          give up after SECS seconds\n"
 231            "  -h, --help                  display this help message\n"
 232            "  -V, --version               display version information\n");
 233     exit(EXIT_SUCCESS);
 234 }
 235
 236 static void
 237 ofctl_exit(struct unixctl_conn *conn, int argc OVS_UNUSED,
 238            const char *argv[] OVS_UNUSED, void *exiting_)
 239 {
 240     bool *exiting = exiting_;
 241     *exiting = true;
 242     unixctl_command_reply(conn, 200, "");
 243 }
 244
 245 static void run(int retval, const char *message, ...)
 246     PRINTF_FORMAT(2, 3);
 247
 248 static void run(int retval, const char *message, ...)
 249 {
 250     if (retval) {
 251         va_list args;
 252
 253         va_start(args, message);
 254         ovs_fatal_valist(retval, message, args);
 255     }
 256 }
 257 \f
 258 /* Generic commands. */
 259
 260 static void
 261 open_vconn_socket(const char *name, struct vconn **vconnp)
 262 {
 263     char *vconn_name = xasprintf("unix:%s", name);
 264     VLOG_DBG("connecting to %s", vconn_name);
 265     run(vconn_open_block(vconn_name, OFP_VERSION, vconnp),
 266         "connecting to %s", vconn_name);
 267     free(vconn_name);
 268 }
 269
 270 static void
 271 open_vconn__(const char *name, const char *default_suffix,
 272              struct vconn **vconnp)
 273 {
 274     char *datapath_name, *datapath_type, *socket_name;
 275     char *bridge_path;
 276     struct stat s;
 277
 278     bridge_path = xasprintf("%s/%s.%s", ovs_rundir(), name, default_suffix);
 279
 280     ofproto_parse_name(name, &datapath_name, &datapath_type);
 281     socket_name = xasprintf("%s/%s.%s",
 282                             ovs_rundir(), datapath_name, default_suffix);
 283     free(datapath_name);
 284     free(datapath_type);
 285
 286     if (strchr(name, ':')) {
 287         run(vconn_open_block(name, OFP_VERSION, vconnp),
 288             "connecting to %s", name);
 289     } else if (!stat(name, &s) && S_ISSOCK(s.st_mode)) {
 290         open_vconn_socket(name, vconnp);
 291     } else if (!stat(bridge_path, &s) && S_ISSOCK(s.st_mode)) {
 292         open_vconn_socket(bridge_path, vconnp);
 293     } else if (!stat(socket_name, &s)) {
 294         if (!S_ISSOCK(s.st_mode)) {
 295             ovs_fatal(0, "cannot connect to %s: %s is not a socket",
 296                       name, socket_name);
 297         }
 298         open_vconn_socket(socket_name, vconnp);
 299     } else {
 300         ovs_fatal(0, "%s is not a bridge or a socket", name);
 301     }
 302
 303     free(bridge_path);
 304     free(socket_name);
 305 }
 306
 307 static void
 308 open_vconn(const char *name, struct vconn **vconnp)
 309 {
 310     return open_vconn__(name, "mgmt", vconnp);
 311 }
 312
 313 static void *
 314 alloc_stats_request(size_t rq_len, uint16_t type, struct ofpbuf **bufferp)
 315 {
 316     struct ofp_stats_msg *rq;
 317
 318     rq = make_openflow(rq_len, OFPT_STATS_REQUEST, bufferp);
 319     rq->type = htons(type);
 320     rq->flags = htons(0);
 321     return rq;
 322 }
 323
 324 static void
 325 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
 326 {
 327     update_openflow_length(buffer);
 328     run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
 329 }
 330
 331 static void
 332 dump_transaction(const char *vconn_name, struct ofpbuf *request)
 333 {
 334     struct vconn *vconn;
 335     struct ofpbuf *reply;
 336
 337     update_openflow_length(request);
 338     open_vconn(vconn_name, &vconn);
 339     run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
 340     ofp_print(stdout, reply->data, reply->size, verbosity + 1);
 341     vconn_close(vconn);
 342 }
 343
 344 static void
 345 dump_trivial_transaction(const char *vconn_name, uint8_t request_type)
 346 {
 347     struct ofpbuf *request;
 348     make_openflow(sizeof(struct ofp_header), request_type, &request);
 349     dump_transaction(vconn_name, request);
 350 }
 351
 352 static void
 353 dump_stats_transaction(const char *vconn_name, struct ofpbuf *request)
 354 {
 355     ovs_be32 send_xid = ((struct ofp_header *) request->data)->xid;
 356     struct vconn *vconn;
 357     bool done = false;
 358
 359     open_vconn(vconn_name, &vconn);
 360     send_openflow_buffer(vconn, request);
 361     while (!done) {
 362         ovs_be32 recv_xid;
 363         struct ofpbuf *reply;
 364
 365         run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
 366         recv_xid = ((struct ofp_header *) reply->data)->xid;
 367         if (send_xid == recv_xid) {
 368             struct ofp_stats_msg *osm;
 369
 370             ofp_print(stdout, reply->data, reply->size, verbosity + 1);
 371
 372             osm = ofpbuf_at(reply, 0, sizeof *osm);
 373             done = !osm || !(ntohs(osm->flags) & OFPSF_REPLY_MORE);
 374         } else {
 375             VLOG_DBG("received reply with xid %08"PRIx32" "
 376                      "!= expected %08"PRIx32, recv_xid, send_xid);
 377         }
 378         ofpbuf_delete(reply);
 379     }
 380     vconn_close(vconn);
 381 }
 382
 383 static void
 384 dump_trivial_stats_transaction(const char *vconn_name, uint8_t stats_type)
 385 {
 386     struct ofpbuf *request;
 387     alloc_stats_request(sizeof(struct ofp_stats_msg), stats_type, &request);
 388     dump_stats_transaction(vconn_name, request);
 389 }
 390
 391 /* Sends 'request', which should be a request that only has a reply if an error
 392  * occurs, and waits for it to succeed or fail.  If an error does occur, prints
 393  * it and exits with an error.
 394  *
 395  * Destroys all of the 'requests'. */
 396 static void
 397 transact_multiple_noreply(struct vconn *vconn, struct list *requests)
 398 {
 399     struct ofpbuf *request, *reply;
 400
 401     LIST_FOR_EACH (request, list_node, requests) {
 402         update_openflow_length(request);
 403     }
 404
 405     run(vconn_transact_multiple_noreply(vconn, requests, &reply),
 406         "talking to %s", vconn_get_name(vconn));
 407     if (reply) {
 408         ofp_print(stderr, reply->data, reply->size, verbosity + 2);
 409         exit(1);
 410     }
 411     ofpbuf_delete(reply);
 412 }
 413
 414 /* Sends 'request', which should be a request that only has a reply if an error
 415  * occurs, and waits for it to succeed or fail.  If an error does occur, prints
 416  * it and exits with an error.
 417  *
 418  * Destroys 'request'. */
 419 static void
 420 transact_noreply(struct vconn *vconn, struct ofpbuf *request)
 421 {
 422     struct list requests;
 423
 424     list_init(&requests);
 425     list_push_back(&requests, &request->list_node);
 426     transact_multiple_noreply(vconn, &requests);
 427 }
 428
 429 static void
 430 fetch_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
 431 {
 432     struct ofp_switch_config *config;
 433     struct ofp_header *header;
 434     struct ofpbuf *request;
 435     struct ofpbuf *reply;
 436
 437     make_openflow(sizeof(struct ofp_header), OFPT_GET_CONFIG_REQUEST,
 438                   &request);
 439     run(vconn_transact(vconn, request, &reply),
 440         "talking to %s", vconn_get_name(vconn));
 441
 442     header = reply->data;
 443     if (header->type != OFPT_GET_CONFIG_REPLY ||
 444         header->length != htons(sizeof *config)) {
 445         ovs_fatal(0, "%s: bad reply to config request", vconn_get_name(vconn));
 446     }
 447
 448     config = reply->data;
 449     *config_ = *config;
 450 }
 451
 452 static void
 453 set_switch_config(struct vconn *vconn, struct ofp_switch_config *config_)
 454 {
 455     struct ofp_switch_config *config;
 456     struct ofp_header save_header;
 457     struct ofpbuf *request;
 458
 459     config = make_openflow(sizeof *config, OFPT_SET_CONFIG, &request);
 460     save_header = config->header;
 461     *config = *config_;
 462     config->header = save_header;
 463
 464     transact_noreply(vconn, request);
 465 }
 466
 467 static void
 468 do_show(int argc OVS_UNUSED, char *argv[])
 469 {
 470     dump_trivial_transaction(argv[1], OFPT_FEATURES_REQUEST);
 471     dump_trivial_transaction(argv[1], OFPT_GET_CONFIG_REQUEST);
 472 }
 473
 474 static void
 475 do_dump_desc(int argc OVS_UNUSED, char *argv[])
 476 {
 477     dump_trivial_stats_transaction(argv[1], OFPST_DESC);
 478 }
 479
 480 static void
 481 do_dump_tables(int argc OVS_UNUSED, char *argv[])
 482 {
 483     dump_trivial_stats_transaction(argv[1], OFPST_TABLE);
 484 }
 485
 486 /* Opens a connection to 'vconn_name', fetches the ofp_phy_port structure for
 487  * 'port_name' (which may be a port name or number), and copies it into
 488  * '*oppp'. */
 489 static void
 490 fetch_ofp_phy_port(const char *vconn_name, const char *port_name,
 491                    struct ofp_phy_port *oppp)
 492 {
 493     struct ofpbuf *request, *reply;
 494     struct ofp_switch_features *osf;
 495     unsigned int port_no;
 496     struct vconn *vconn;
 497     int n_ports;
 498     int port_idx;
 499
 500     /* Try to interpret the argument as a port number. */
 501     if (!str_to_uint(port_name, 10, &port_no)) {
 502         port_no = UINT_MAX;
 503     }
 504
 505     /* Fetch the switch's ofp_switch_features. */
 506     make_openflow(sizeof(struct ofp_header), OFPT_FEATURES_REQUEST, &request);
 507     open_vconn(vconn_name, &vconn);
 508     run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
 509
 510     osf = reply->data;
 511     if (reply->size < sizeof *osf) {
 512         ovs_fatal(0, "%s: received too-short features reply (only %zu bytes)",
 513                   vconn_name, reply->size);
 514     }
 515     n_ports = (reply->size - sizeof *osf) / sizeof *osf->ports;
 516
 517     for (port_idx = 0; port_idx < n_ports; port_idx++) {
 518         const struct ofp_phy_port *opp = &osf->ports[port_idx];
 519
 520         if (port_no != UINT_MAX
 521             ? htons(port_no) == opp->port_no
 522             : !strncmp(opp->name, port_name, sizeof opp->name)) {
 523             *oppp = *opp;
 524             ofpbuf_delete(reply);
 525             vconn_close(vconn);
 526             return;
 527         }
 528     }
 529     ovs_fatal(0, "%s: couldn't find port `%s'", vconn_name, port_name);
 530 }
 531
 532 /* Returns the port number corresponding to 'port_name' (which may be a port
 533  * name or number) within the switch 'vconn_name'. */
 534 static uint16_t
 535 str_to_port_no(const char *vconn_name, const char *port_name)
 536 {
 537     unsigned int port_no;
 538
 539     if (str_to_uint(port_name, 10, &port_no)) {
 540         return port_no;
 541     } else {
 542         struct ofp_phy_port opp;
 543
 544         fetch_ofp_phy_port(vconn_name, port_name, &opp);
 545         return ntohs(opp.port_no);
 546     }
 547 }
 548
 549 static bool
 550 try_set_flow_format(struct vconn *vconn, enum nx_flow_format flow_format)
 551 {
 552     struct ofpbuf *sff, *reply;
 553
 554     sff = ofputil_make_set_flow_format(flow_format);
 555     run(vconn_transact_noreply(vconn, sff, &reply),
 556         "talking to %s", vconn_get_name(vconn));
 557     if (reply) {
 558         char *s = ofp_to_string(reply->data, reply->size, 2);
 559         VLOG_DBG("%s: failed to set flow format %s, controller replied: %s",
 560                  vconn_get_name(vconn),
 561                  ofputil_flow_format_to_string(flow_format),
 562                  s);
 563         free(s);
 564         ofpbuf_delete(reply);
 565         return false;
 566     }
 567     return true;
 568 }
 569
 570 static void
 571 set_flow_format(struct vconn *vconn, enum nx_flow_format flow_format)
 572 {
 573     struct ofpbuf *sff = ofputil_make_set_flow_format(flow_format);
 574     transact_noreply(vconn, sff);
 575     VLOG_DBG("%s: using user-specified flow format %s",
 576              vconn_get_name(vconn),
 577              ofputil_flow_format_to_string(flow_format));
 578 }
 579
 580 static enum nx_flow_format
 581 negotiate_highest_flow_format(struct vconn *vconn,
 582                               enum nx_flow_format min_format)
 583 {
 584     if (preferred_flow_format != -1) {
 585         if (preferred_flow_format < min_format) {
 586             ovs_fatal(0, "%s: cannot use requested flow format %s for "
 587                       "specified flow", vconn_get_name(vconn),
 588                       ofputil_flow_format_to_string(min_format));
 589         }
 590
 591         set_flow_format(vconn, preferred_flow_format);
 592         return preferred_flow_format;
 593     } else {
 594         enum nx_flow_format flow_format;
 595
 596         if (try_set_flow_format(vconn, NXFF_NXM)) {
 597             flow_format = NXFF_NXM;
 598         } else {
 599             flow_format = NXFF_OPENFLOW10;
 600         }
 601
 602         if (flow_format < min_format) {
 603             ovs_fatal(0, "%s: cannot use switch's most advanced flow format "
 604                       "%s for specified flow", vconn_get_name(vconn),
 605                       ofputil_flow_format_to_string(min_format));
 606         }
 607
 608         VLOG_DBG("%s: negotiated flow format %s", vconn_get_name(vconn),
 609                  ofputil_flow_format_to_string(flow_format));
 610         return flow_format;
 611     }
 612 }
 613
 614 static void
 615 do_dump_flows__(int argc, char *argv[], bool aggregate)
 616 {
 617     enum nx_flow_format min_flow_format, flow_format;
 618     struct ofputil_flow_stats_request fsr;
 619     struct ofpbuf *request;
 620     struct vconn *vconn;
 621
 622     parse_ofp_flow_stats_request_str(&fsr, aggregate, argc > 2 ? argv[2] : "");
 623
 624     open_vconn(argv[1], &vconn);
 625     min_flow_format = ofputil_min_flow_format(&fsr.match);
 626     if (fsr.cookie_mask != htonll(0)) {
 627         min_flow_format = NXFF_NXM;
 628     }
 629     flow_format = negotiate_highest_flow_format(vconn, min_flow_format);
 630     request = ofputil_encode_flow_stats_request(&fsr, flow_format);
 631     dump_stats_transaction(argv[1], request);
 632     vconn_close(vconn);
 633 }
 634
 635 static void
 636 do_dump_flows(int argc, char *argv[])
 637 {
 638     return do_dump_flows__(argc, argv, false);
 639 }
 640
 641 static void
 642 do_dump_aggregate(int argc, char *argv[])
 643 {
 644     return do_dump_flows__(argc, argv, true);
 645 }
 646
 647 static void
 648 do_queue_stats(int argc, char *argv[])
 649 {
 650     struct ofp_queue_stats_request *req;
 651     struct ofpbuf *request;
 652
 653     req = alloc_stats_request(sizeof *req, OFPST_QUEUE, &request);
 654
 655     if (argc > 2 && argv[2][0] && strcasecmp(argv[2], "all")) {
 656         req->port_no = htons(str_to_port_no(argv[1], argv[2]));
 657     } else {
 658         req->port_no = htons(OFPP_ALL);
 659     }
 660     if (argc > 3 && argv[3][0] && strcasecmp(argv[3], "all")) {
 661         req->queue_id = htonl(atoi(argv[3]));
 662     } else {
 663         req->queue_id = htonl(OFPQ_ALL);
 664     }
 665
 666     memset(req->pad, 0, sizeof req->pad);
 667
 668     dump_stats_transaction(argv[1], request);
 669 }
 670
 671 /* Sets up the flow format for a vconn that will be used to modify the flow
 672  * table.  Returns the flow format used, after possibly adding an OpenFlow
 673  * request to 'requests'.
 674  *
 675  * If 'preferred_flow_format' is -1, returns NXFF_OPENFLOW10 without modifying
 676  * 'requests', since NXFF_OPENFLOW10 is the default flow format for any
 677  * OpenFlow connection.
 678  *
 679  * If 'preferred_flow_format' is a specific format, adds a request to set that
 680  * format to 'requests' and returns the format. */
 681 static enum nx_flow_format
 682 set_initial_format_for_flow_mod(struct list *requests)
 683 {
 684     if (preferred_flow_format < 0) {
 685         return NXFF_OPENFLOW10;
 686     } else {
 687         struct ofpbuf *sff;
 688
 689         sff = ofputil_make_set_flow_format(preferred_flow_format);
 690         list_push_back(requests, &sff->list_node);
 691         return preferred_flow_format;
 692     }
 693 }
 694
 695 /* Checks that 'flow_format' is acceptable as a flow format after a flow_mod
 696  * operation, given the global 'preferred_flow_format'. */
 697 static void
 698 check_final_format_for_flow_mod(enum nx_flow_format flow_format)
 699 {
 700     if (preferred_flow_format >= 0 && flow_format > preferred_flow_format) {
 701         ovs_fatal(0, "flow cannot be expressed in flow format %s "
 702                   "(flow format %s or better is required)",
 703                   ofputil_flow_format_to_string(preferred_flow_format),
 704                   ofputil_flow_format_to_string(flow_format));
 705     }
 706 }
 707
 708 static void
 709 do_flow_mod_file__(int argc OVS_UNUSED, char *argv[], uint16_t command)
 710 {
 711     enum nx_flow_format flow_format;
 712     bool flow_mod_table_id;
 713     struct list requests;
 714     struct vconn *vconn;
 715     FILE *file;
 716
 717     file = !strcmp(argv[2], "-") ? stdin : fopen(argv[2], "r");
 718     if (file == NULL) {
 719         ovs_fatal(errno, "%s: open", argv[2]);
 720     }
 721
 722     list_init(&requests);
 723     flow_format = set_initial_format_for_flow_mod(&requests);
 724     flow_mod_table_id = false;
 725
 726     open_vconn(argv[1], &vconn);
 727     while (parse_ofp_flow_mod_file(&requests, &flow_format, &flow_mod_table_id,
 728                                    file, command)) {
 729         check_final_format_for_flow_mod(flow_format);
 730         transact_multiple_noreply(vconn, &requests);
 731     }
 732     vconn_close(vconn);
 733
 734     if (file != stdin) {
 735         fclose(file);
 736     }
 737 }
 738
 739 static void
 740 do_flow_mod__(int argc, char *argv[], uint16_t command)
 741 {
 742     enum nx_flow_format flow_format;
 743     bool flow_mod_table_id;
 744     struct list requests;
 745     struct vconn *vconn;
 746
 747     if (argc > 2 && !strcmp(argv[2], "-")) {
 748         do_flow_mod_file__(argc, argv, command);
 749         return;
 750     }
 751
 752     list_init(&requests);
 753     flow_format = set_initial_format_for_flow_mod(&requests);
 754     flow_mod_table_id = false;
 755
 756     parse_ofp_flow_mod_str(&requests, &flow_format, &flow_mod_table_id,
 757                            argc > 2 ? argv[2] : "", command, false);
 758     check_final_format_for_flow_mod(flow_format);
 759
 760     open_vconn(argv[1], &vconn);
 761     transact_multiple_noreply(vconn, &requests);
 762     vconn_close(vconn);
 763 }
 764
 765 static void
 766 do_add_flow(int argc, char *argv[])
 767 {
 768     do_flow_mod__(argc, argv, OFPFC_ADD);
 769 }
 770
 771 static void
 772 do_add_flows(int argc, char *argv[])
 773 {
 774     do_flow_mod_file__(argc, argv, OFPFC_ADD);
 775 }
 776
 777 static void
 778 do_mod_flows(int argc, char *argv[])
 779 {
 780     do_flow_mod__(argc, argv, strict ? OFPFC_MODIFY_STRICT : OFPFC_MODIFY);
 781 }
 782
 783 static void
 784 do_del_flows(int argc, char *argv[])
 785 {
 786     do_flow_mod__(argc, argv, strict ? OFPFC_DELETE_STRICT : OFPFC_DELETE);
 787 }
 788
 789 static void
 790 set_packet_in_format(struct vconn *vconn,
 791                      enum nx_packet_in_format packet_in_format)
 792 {
 793     struct ofpbuf *spif = ofputil_make_set_packet_in_format(packet_in_format);
 794     transact_noreply(vconn, spif);
 795     VLOG_DBG("%s: using user-specified packet in format %s",
 796              vconn_get_name(vconn),
 797              ofputil_packet_in_format_to_string(packet_in_format));
 798 }
 799
 800 static int
 801 monitor_set_invalid_ttl_to_controller(struct vconn *vconn)
 802 {
 803     struct ofp_switch_config config;
 804     enum ofp_config_flags flags;
 805
 806     fetch_switch_config(vconn, &config);
 807     flags = ntohs(config.flags);
 808     if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
 809         /* Set the invalid ttl config. */
 810         flags |= OFPC_INVALID_TTL_TO_CONTROLLER;
 811
 812         config.flags = htons(flags);
 813         set_switch_config(vconn, &config);
 814
 815         /* Then retrieve the configuration to see if it really took.  OpenFlow
 816          * doesn't define error reporting for bad modes, so this is all we can
 817          * do. */
 818         fetch_switch_config(vconn, &config);
 819         flags = ntohs(config.flags);
 820         if (!(flags & OFPC_INVALID_TTL_TO_CONTROLLER)) {
 821             ovs_fatal(0, "setting invalid_ttl_to_controller failed (this "
 822                       "switch probably doesn't support mode)");
 823             return -EOPNOTSUPP;
 824         }
 825     }
 826     return 0;
 827 }
 828
 829 static void
 830 monitor_vconn(struct vconn *vconn)
 831 {
 832     struct unixctl_server *server;
 833     bool exiting = false;
 834     int error;
 835
 836     daemon_save_fd(STDERR_FILENO);
 837     daemonize_start();
 838     error = unixctl_server_create(NULL, &server);
 839     if (error) {
 840         ovs_fatal(error, "failed to create unixctl server");
 841     }
 842     unixctl_command_register("exit", "", 0, 0, ofctl_exit, &exiting);
 843     daemonize_complete();
 844
 845     for (;;) {
 846         struct ofpbuf *b;
 847         int retval;
 848
 849         unixctl_server_run(server);
 850
 851         for (;;) {
 852             retval = vconn_recv(vconn, &b);
 853             if (retval == EAGAIN) {
 854                 break;
 855             }
 856
 857             run(retval, "vconn_recv");
 858             ofp_print(stderr, b->data, b->size, verbosity + 2);
 859             ofpbuf_delete(b);
 860         }
 861
 862         if (exiting) {
 863             break;
 864         }
 865
 866         vconn_run(vconn);
 867         vconn_run_wait(vconn);
 868         vconn_recv_wait(vconn);
 869         unixctl_server_wait(server);
 870         poll_block();
 871     }
 872 }
 873
 874 static void
 875 do_monitor(int argc, char *argv[])
 876 {
 877     struct vconn *vconn;
 878
 879     open_vconn(argv[1], &vconn);
 880     if (argc > 2) {
 881         struct ofp_switch_config config;
 882
 883         fetch_switch_config(vconn, &config);
 884         config.miss_send_len = htons(atoi(argv[2]));
 885         set_switch_config(vconn, &config);
 886     }
 887     if (argc > 3) {
 888         if (!strcmp(argv[3], "invalid_ttl")) {
 889             monitor_set_invalid_ttl_to_controller(vconn);
 890         }
 891     }
 892     if (preferred_packet_in_format >= 0) {
 893         set_packet_in_format(vconn, preferred_packet_in_format);
 894     } else {
 895         struct ofpbuf *spif, *reply;
 896
 897         spif = ofputil_make_set_packet_in_format(NXPIF_NXM);
 898         run(vconn_transact_noreply(vconn, spif, &reply),
 899             "talking to %s", vconn_get_name(vconn));
 900         if (reply) {
 901             char *s = ofp_to_string(reply->data, reply->size, 2);
 902             VLOG_DBG("%s: failed to set packet in format to nxm, controller"
 903                      " replied: %s. Falling back to the switch default.",
 904                      vconn_get_name(vconn), s);
 905             free(s);
 906             ofpbuf_delete(reply);
 907         }
 908     }
 909
 910     monitor_vconn(vconn);
 911 }
 912
 913 static void
 914 do_snoop(int argc OVS_UNUSED, char *argv[])
 915 {
 916     struct vconn *vconn;
 917
 918     open_vconn__(argv[1], "snoop", &vconn);
 919     monitor_vconn(vconn);
 920 }
 921
 922 static void
 923 do_dump_ports(int argc, char *argv[])
 924 {
 925     struct ofp_port_stats_request *req;
 926     struct ofpbuf *request;
 927     uint16_t port;
 928
 929     req = alloc_stats_request(sizeof *req, OFPST_PORT, &request);
 930     port = argc > 2 ? str_to_port_no(argv[1], argv[2]) : OFPP_NONE;
 931     req->port_no = htons(port);
 932     dump_stats_transaction(argv[1], request);
 933 }
 934
 935 static void
 936 do_probe(int argc OVS_UNUSED, char *argv[])
 937 {
 938     struct ofpbuf *request;
 939     struct vconn *vconn;
 940     struct ofpbuf *reply;
 941
 942     make_openflow(sizeof(struct ofp_header), OFPT_ECHO_REQUEST, &request);
 943     open_vconn(argv[1], &vconn);
 944     run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
 945     if (reply->size != sizeof(struct ofp_header)) {
 946         ovs_fatal(0, "reply does not match request");
 947     }
 948     ofpbuf_delete(reply);
 949     vconn_close(vconn);
 950 }
 951
 952 static void
 953 do_mod_port(int argc OVS_UNUSED, char *argv[])
 954 {
 955     struct ofp_port_mod *opm;
 956     struct ofp_phy_port opp;
 957     struct ofpbuf *request;
 958     struct vconn *vconn;
 959
 960     fetch_ofp_phy_port(argv[1], argv[2], &opp);
 961
 962     opm = make_openflow(sizeof(struct ofp_port_mod), OFPT_PORT_MOD, &request);
 963     opm->port_no = opp.port_no;
 964     memcpy(opm->hw_addr, opp.hw_addr, sizeof opm->hw_addr);
 965     opm->config = htonl(0);
 966     opm->mask = htonl(0);
 967     opm->advertise = htonl(0);
 968
 969     if (!strcasecmp(argv[3], "up")) {
 970         opm->mask |= htonl(OFPPC_PORT_DOWN);
 971     } else if (!strcasecmp(argv[3], "down")) {
 972         opm->mask |= htonl(OFPPC_PORT_DOWN);
 973         opm->config |= htonl(OFPPC_PORT_DOWN);
 974     } else if (!strcasecmp(argv[3], "flood")) {
 975         opm->mask |= htonl(OFPPC_NO_FLOOD);
 976     } else if (!strcasecmp(argv[3], "noflood")) {
 977         opm->mask |= htonl(OFPPC_NO_FLOOD);
 978         opm->config |= htonl(OFPPC_NO_FLOOD);
 979     } else if (!strcasecmp(argv[3], "forward")) {
 980         opm->mask |= htonl(OFPPC_NO_FWD);
 981     } else if (!strcasecmp(argv[3], "noforward")) {
 982         opm->mask |= htonl(OFPPC_NO_FWD);
 983         opm->config |= htonl(OFPPC_NO_FWD);
 984     } else {
 985         ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
 986     }
 987
 988     open_vconn(argv[1], &vconn);
 989     transact_noreply(vconn, request);
 990     vconn_close(vconn);
 991 }
 992
 993 static void
 994 do_get_frags(int argc OVS_UNUSED, char *argv[])
 995 {
 996     struct ofp_switch_config config;
 997     struct vconn *vconn;
 998
 999     open_vconn(argv[1], &vconn);
1000     fetch_switch_config(vconn, &config);
1001     puts(ofputil_frag_handling_to_string(ntohs(config.flags)));
1002     vconn_close(vconn);
1003 }
1004
1005 static void
1006 do_set_frags(int argc OVS_UNUSED, char *argv[])
1007 {
1008     struct ofp_switch_config config;
1009     enum ofp_config_flags mode;
1010     struct vconn *vconn;
1011     ovs_be16 flags;
1012
1013     if (!ofputil_frag_handling_from_string(argv[2], &mode)) {
1014         ovs_fatal(0, "%s: unknown fragment handling mode", argv[2]);
1015     }
1016
1017     open_vconn(argv[1], &vconn);
1018     fetch_switch_config(vconn, &config);
1019     flags = htons(mode) | (config.flags & htons(~OFPC_FRAG_MASK));
1020     if (flags != config.flags) {
1021         /* Set the configuration. */
1022         config.flags = flags;
1023         set_switch_config(vconn, &config);
1024
1025         /* Then retrieve the configuration to see if it really took.  OpenFlow
1026          * doesn't define error reporting for bad modes, so this is all we can
1027          * do. */
1028         fetch_switch_config(vconn, &config);
1029         if (flags != config.flags) {
1030             ovs_fatal(0, "%s: setting fragment handling mode failed (this "
1031                       "switch probably doesn't support mode \"%s\")",
1032                       argv[1], ofputil_frag_handling_to_string(mode));
1033         }
1034     }
1035     vconn_close(vconn);
1036 }
1037
1038 static void
1039 do_ping(int argc, char *argv[])
1040 {
1041     size_t max_payload = 65535 - sizeof(struct ofp_header);
1042     unsigned int payload;
1043     struct vconn *vconn;
1044     int i;
1045
1046     payload = argc > 2 ? atoi(argv[2]) : 64;
1047     if (payload > max_payload) {
1048         ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1049     }
1050
1051     open_vconn(argv[1], &vconn);
1052     for (i = 0; i < 10; i++) {
1053         struct timeval start, end;
1054         struct ofpbuf *request, *reply;
1055         struct ofp_header *rq_hdr, *rpy_hdr;
1056
1057         rq_hdr = make_openflow(sizeof(struct ofp_header) + payload,
1058                                OFPT_ECHO_REQUEST, &request);
1059         random_bytes(rq_hdr + 1, payload);
1060
1061         xgettimeofday(&start);
1062         run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
1063         xgettimeofday(&end);
1064
1065         rpy_hdr = reply->data;
1066         if (reply->size != request->size
1067             || memcmp(rpy_hdr + 1, rq_hdr + 1, payload)
1068             || rpy_hdr->xid != rq_hdr->xid
1069             || rpy_hdr->type != OFPT_ECHO_REPLY) {
1070             printf("Reply does not match request.  Request:\n");
1071             ofp_print(stdout, request, request->size, verbosity + 2);
1072             printf("Reply:\n");
1073             ofp_print(stdout, reply, reply->size, verbosity + 2);
1074         }
1075         printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
1076                reply->size - sizeof *rpy_hdr, argv[1], ntohl(rpy_hdr->xid),
1077                    (1000*(double)(end.tv_sec - start.tv_sec))
1078                    + (.001*(end.tv_usec - start.tv_usec)));
1079         ofpbuf_delete(request);
1080         ofpbuf_delete(reply);
1081     }
1082     vconn_close(vconn);
1083 }
1084
1085 static void
1086 do_benchmark(int argc OVS_UNUSED, char *argv[])
1087 {
1088     size_t max_payload = 65535 - sizeof(struct ofp_header);
1089     struct timeval start, end;
1090     unsigned int payload_size, message_size;
1091     struct vconn *vconn;
1092     double duration;
1093     int count;
1094     int i;
1095
1096     payload_size = atoi(argv[2]);
1097     if (payload_size > max_payload) {
1098         ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1099     }
1100     message_size = sizeof(struct ofp_header) + payload_size;
1101
1102     count = atoi(argv[3]);
1103
1104     printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
1105            count, message_size, count * message_size);
1106
1107     open_vconn(argv[1], &vconn);
1108     xgettimeofday(&start);
1109     for (i = 0; i < count; i++) {
1110         struct ofpbuf *request, *reply;
1111         struct ofp_header *rq_hdr;
1112
1113         rq_hdr = make_openflow(message_size, OFPT_ECHO_REQUEST, &request);
1114         memset(rq_hdr + 1, 0, payload_size);
1115         run(vconn_transact(vconn, request, &reply), "transact");
1116         ofpbuf_delete(reply);
1117     }
1118     xgettimeofday(&end);
1119     vconn_close(vconn);
1120
1121     duration = ((1000*(double)(end.tv_sec - start.tv_sec))
1122                 + (.001*(end.tv_usec - start.tv_usec)));
1123     printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
1124            duration, count / (duration / 1000.0),
1125            count * message_size / (duration / 1000.0));
1126 }
1127
1128 static void
1129 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1130 {
1131     usage();
1132 }
1133 \f
1134 /* replace-flows and diff-flows commands. */
1135
1136 /* A flow table entry, possibly with two different versions. */
1137 struct fte {
1138     struct cls_rule rule;       /* Within a "struct classifier". */
1139     struct fte_version *versions[2];
1140 };
1141
1142 /* One version of a Flow Table Entry. */
1143 struct fte_version {
1144     ovs_be64 cookie;
1145     uint16_t idle_timeout;
1146     uint16_t hard_timeout;
1147     uint16_t flags;
1148     union ofp_action *actions;
1149     size_t n_actions;
1150 };
1151
1152 /* Frees 'version' and the data that it owns. */
1153 static void
1154 fte_version_free(struct fte_version *version)
1155 {
1156     if (version) {
1157         free(version->actions);
1158         free(version);
1159     }
1160 }
1161
1162 /* Returns true if 'a' and 'b' are the same, false if they differ.
1163  *
1164  * Ignores differences in 'flags' because there's no way to retrieve flags from
1165  * an OpenFlow switch.  We have to assume that they are the same. */
1166 static bool
1167 fte_version_equals(const struct fte_version *a, const struct fte_version *b)
1168 {
1169     return (a->cookie == b->cookie
1170             && a->idle_timeout == b->idle_timeout
1171             && a->hard_timeout == b->hard_timeout
1172             && a->n_actions == b->n_actions
1173             && !memcmp(a->actions, b->actions,
1174                        a->n_actions * sizeof *a->actions));
1175 }
1176
1177 /* Prints 'version' on stdout.  Expects the caller to have printed the rule
1178  * associated with the version. */
1179 static void
1180 fte_version_print(const struct fte_version *version)
1181 {
1182     struct ds s;
1183
1184     if (version->cookie != htonll(0)) {
1185         printf(" cookie=0x%"PRIx64, ntohll(version->cookie));
1186     }
1187     if (version->idle_timeout != OFP_FLOW_PERMANENT) {
1188         printf(" idle_timeout=%"PRIu16, version->idle_timeout);
1189     }
1190     if (version->hard_timeout != OFP_FLOW_PERMANENT) {
1191         printf(" hard_timeout=%"PRIu16, version->hard_timeout);
1192     }
1193
1194     ds_init(&s);
1195     ofp_print_actions(&s, version->actions, version->n_actions);
1196     printf(" %s\n", ds_cstr(&s));
1197     ds_destroy(&s);
1198 }
1199
1200 static struct fte *
1201 fte_from_cls_rule(const struct cls_rule *cls_rule)
1202 {
1203     return cls_rule ? CONTAINER_OF(cls_rule, struct fte, rule) : NULL;
1204 }
1205
1206 /* Frees 'fte' and its versions. */
1207 static void
1208 fte_free(struct fte *fte)
1209 {
1210     if (fte) {
1211         fte_version_free(fte->versions[0]);
1212         fte_version_free(fte->versions[1]);
1213         free(fte);
1214     }
1215 }
1216
1217 /* Frees all of the FTEs within 'cls'. */
1218 static void
1219 fte_free_all(struct classifier *cls)
1220 {
1221     struct cls_cursor cursor;
1222     struct fte *fte, *next;
1223
1224     cls_cursor_init(&cursor, cls, NULL);
1225     CLS_CURSOR_FOR_EACH_SAFE (fte, next, rule, &cursor) {
1226         classifier_remove(cls, &fte->rule);
1227         fte_free(fte);
1228     }
1229 }
1230
1231 /* Searches 'cls' for an FTE matching 'rule', inserting a new one if
1232  * necessary.  Sets 'version' as the version of that rule with the given
1233  * 'index', replacing any existing version, if any.
1234  *
1235  * Takes ownership of 'version'. */
1236 static void
1237 fte_insert(struct classifier *cls, const struct cls_rule *rule,
1238            struct fte_version *version, int index)
1239 {
1240     struct fte *old, *fte;
1241
1242     fte = xzalloc(sizeof *fte);
1243     fte->rule = *rule;
1244     fte->versions[index] = version;
1245
1246     old = fte_from_cls_rule(classifier_replace(cls, &fte->rule));
1247     if (old) {
1248         fte_version_free(old->versions[index]);
1249         fte->versions[!index] = old->versions[!index];
1250         free(old);
1251     }
1252 }
1253
1254 /* Reads the flows in 'filename' as flow table entries in 'cls' for the version
1255  * with the specified 'index'.  Returns the minimum flow format required to
1256  * represent the flows that were read. */
1257 static enum nx_flow_format
1258 read_flows_from_file(const char *filename, struct classifier *cls, int index)
1259 {
1260     enum nx_flow_format min_flow_format;
1261     struct ds s;
1262     FILE *file;
1263
1264     file = !strcmp(filename, "-") ? stdin : fopen(filename, "r");
1265     if (file == NULL) {
1266         ovs_fatal(errno, "%s: open", filename);
1267     }
1268
1269     ds_init(&s);
1270     min_flow_format = NXFF_OPENFLOW10;
1271     while (!ds_get_preprocessed_line(&s, file)) {
1272         struct fte_version *version;
1273         struct ofputil_flow_mod fm;
1274         enum nx_flow_format min_ff;
1275
1276         parse_ofp_str(&fm, OFPFC_ADD, ds_cstr(&s), true);
1277
1278         version = xmalloc(sizeof *version);
1279         version->cookie = fm.cookie;
1280         version->idle_timeout = fm.idle_timeout;
1281         version->hard_timeout = fm.hard_timeout;
1282         version->flags = fm.flags & (OFPFF_SEND_FLOW_REM | OFPFF_EMERG);
1283         version->actions = fm.actions;
1284         version->n_actions = fm.n_actions;
1285
1286         min_ff = ofputil_min_flow_format(&fm.cr);
1287         min_flow_format = MAX(min_flow_format, min_ff);
1288         check_final_format_for_flow_mod(min_flow_format);
1289
1290         fte_insert(cls, &fm.cr, version, index);
1291     }
1292     ds_destroy(&s);
1293
1294     if (file != stdin) {
1295         fclose(file);
1296     }
1297
1298     return min_flow_format;
1299 }
1300
1301 /* Reads the OpenFlow flow table from 'vconn', which has currently active flow
1302  * format 'flow_format', and adds them as flow table entries in 'cls' for the
1303  * version with the specified 'index'. */
1304 static void
1305 read_flows_from_switch(struct vconn *vconn, enum nx_flow_format flow_format,
1306                        struct classifier *cls, int index)
1307 {
1308     struct ofputil_flow_stats_request fsr;
1309     struct ofpbuf *request;
1310     ovs_be32 send_xid;
1311     bool done;
1312
1313     fsr.aggregate = false;
1314     cls_rule_init_catchall(&fsr.match, 0);
1315     fsr.out_port = OFPP_NONE;
1316     fsr.table_id = 0xff;
1317     fsr.cookie = fsr.cookie_mask = htonll(0);
1318     request = ofputil_encode_flow_stats_request(&fsr, flow_format);
1319     send_xid = ((struct ofp_header *) request->data)->xid;
1320     send_openflow_buffer(vconn, request);
1321
1322     done = false;
1323     while (!done) {
1324         ovs_be32 recv_xid;
1325         struct ofpbuf *reply;
1326
1327         run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
1328         recv_xid = ((struct ofp_header *) reply->data)->xid;
1329         if (send_xid == recv_xid) {
1330             const struct ofputil_msg_type *type;
1331             const struct ofp_stats_msg *osm;
1332             enum ofputil_msg_code code;
1333
1334             ofputil_decode_msg_type(reply->data, &type);
1335             code = ofputil_msg_type_code(type);
1336             if (code != OFPUTIL_OFPST_FLOW_REPLY &&
1337                 code != OFPUTIL_NXST_FLOW_REPLY) {
1338                 ovs_fatal(0, "received bad reply: %s",
1339                           ofp_to_string(reply->data, reply->size,
1340                                         verbosity + 1));
1341             }
1342
1343             osm = reply->data;
1344             if (!(osm->flags & htons(OFPSF_REPLY_MORE))) {
1345                 done = true;
1346             }
1347
1348             for (;;) {
1349                 struct fte_version *version;
1350                 struct ofputil_flow_stats fs;
1351                 int retval;
1352
1353                 retval = ofputil_decode_flow_stats_reply(&fs, reply);
1354                 if (retval) {
1355                     if (retval != EOF) {
1356                         ovs_fatal(0, "parse error in reply");
1357                     }
1358                     break;
1359                 }
1360
1361                 version = xmalloc(sizeof *version);
1362                 version->cookie = fs.cookie;
1363                 version->idle_timeout = fs.idle_timeout;
1364                 version->hard_timeout = fs.hard_timeout;
1365                 version->flags = 0;
1366                 version->n_actions = fs.n_actions;
1367                 version->actions = xmemdup(fs.actions,
1368                                            fs.n_actions * sizeof *fs.actions);
1369
1370                 fte_insert(cls, &fs.rule, version, index);
1371             }
1372         } else {
1373             VLOG_DBG("received reply with xid %08"PRIx32" "
1374                      "!= expected %08"PRIx32, recv_xid, send_xid);
1375         }
1376         ofpbuf_delete(reply);
1377     }
1378 }
1379
1380 static void
1381 fte_make_flow_mod(const struct fte *fte, int index, uint16_t command,
1382                   enum nx_flow_format flow_format, struct list *packets)
1383 {
1384     const struct fte_version *version = fte->versions[index];
1385     struct ofputil_flow_mod fm;
1386     struct ofpbuf *ofm;
1387
1388     fm.cr = fte->rule;
1389     fm.cookie = version->cookie;
1390     fm.table_id = 0xff;
1391     fm.command = command;
1392     fm.idle_timeout = version->idle_timeout;
1393     fm.hard_timeout = version->hard_timeout;
1394     fm.buffer_id = UINT32_MAX;
1395     fm.out_port = OFPP_NONE;
1396     fm.flags = version->flags;
1397     if (command == OFPFC_ADD || command == OFPFC_MODIFY ||
1398         command == OFPFC_MODIFY_STRICT) {
1399         fm.actions = version->actions;
1400         fm.n_actions = version->n_actions;
1401     } else {
1402         fm.actions = NULL;
1403         fm.n_actions = 0;
1404     }
1405
1406     ofm = ofputil_encode_flow_mod(&fm, flow_format, false);
1407     list_push_back(packets, &ofm->list_node);
1408 }
1409
1410 static void
1411 do_replace_flows(int argc OVS_UNUSED, char *argv[])
1412 {
1413     enum { FILE_IDX = 0, SWITCH_IDX = 1 };
1414     enum nx_flow_format min_flow_format, flow_format;
1415     struct cls_cursor cursor;
1416     struct classifier cls;
1417     struct list requests;
1418     struct vconn *vconn;
1419     struct fte *fte;
1420
1421     classifier_init(&cls);
1422     min_flow_format = read_flows_from_file(argv[2], &cls, FILE_IDX);
1423
1424     open_vconn(argv[1], &vconn);
1425     flow_format = negotiate_highest_flow_format(vconn, min_flow_format);
1426     read_flows_from_switch(vconn, flow_format, &cls, SWITCH_IDX);
1427
1428     list_init(&requests);
1429
1430     /* Delete flows that exist on the switch but not in the file. */
1431     cls_cursor_init(&cursor, &cls, NULL);
1432     CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1433         struct fte_version *file_ver = fte->versions[FILE_IDX];
1434         struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
1435
1436         if (sw_ver && !file_ver) {
1437             fte_make_flow_mod(fte, SWITCH_IDX, OFPFC_DELETE_STRICT,
1438                               flow_format, &requests);
1439         }
1440     }
1441
1442     /* Add flows that exist in the file but not on the switch.
1443      * Update flows that exist in both places but differ. */
1444     cls_cursor_init(&cursor, &cls, NULL);
1445     CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1446         struct fte_version *file_ver = fte->versions[FILE_IDX];
1447         struct fte_version *sw_ver = fte->versions[SWITCH_IDX];
1448
1449         if (file_ver
1450             && (readd || !sw_ver || !fte_version_equals(sw_ver, file_ver))) {
1451             fte_make_flow_mod(fte, FILE_IDX, OFPFC_ADD, flow_format,
1452                               &requests);
1453         }
1454     }
1455     transact_multiple_noreply(vconn, &requests);
1456     vconn_close(vconn);
1457
1458     fte_free_all(&cls);
1459 }
1460
1461 static void
1462 read_flows_from_source(const char *source, struct classifier *cls, int index)
1463 {
1464     struct stat s;
1465
1466     if (source[0] == '/' || source[0] == '.'
1467         || (!strchr(source, ':') && !stat(source, &s))) {
1468         read_flows_from_file(source, cls, index);
1469     } else {
1470         enum nx_flow_format flow_format;
1471         struct vconn *vconn;
1472
1473         open_vconn(source, &vconn);
1474         flow_format = negotiate_highest_flow_format(vconn, NXFF_OPENFLOW10);
1475         read_flows_from_switch(vconn, flow_format, cls, index);
1476         vconn_close(vconn);
1477     }
1478 }
1479
1480 static void
1481 do_diff_flows(int argc OVS_UNUSED, char *argv[])
1482 {
1483     bool differences = false;
1484     struct cls_cursor cursor;
1485     struct classifier cls;
1486     struct fte *fte;
1487
1488     classifier_init(&cls);
1489     read_flows_from_source(argv[1], &cls, 0);
1490     read_flows_from_source(argv[2], &cls, 1);
1491
1492     cls_cursor_init(&cursor, &cls, NULL);
1493     CLS_CURSOR_FOR_EACH (fte, rule, &cursor) {
1494         struct fte_version *a = fte->versions[0];
1495         struct fte_version *b = fte->versions[1];
1496
1497         if (!a || !b || !fte_version_equals(a, b)) {
1498             char *rule_s = cls_rule_to_string(&fte->rule);
1499             if (a) {
1500                 printf("-%s", rule_s);
1501                 fte_version_print(a);
1502             }
1503             if (b) {
1504                 printf("+%s", rule_s);
1505                 fte_version_print(b);
1506             }
1507             free(rule_s);
1508
1509             differences = true;
1510         }
1511     }
1512
1513     fte_free_all(&cls);
1514
1515     if (differences) {
1516         exit(2);
1517     }
1518 }
1519 \f
1520 /* Undocumented commands for unit testing. */
1521
1522 static void
1523 print_packet_list(struct list *packets)
1524 {
1525     struct ofpbuf *packet, *next;
1526
1527     LIST_FOR_EACH_SAFE (packet, next, list_node, packets) {
1528         ofp_print(stdout, packet->data, packet->size, verbosity);
1529         list_remove(&packet->list_node);
1530         ofpbuf_delete(packet);
1531     }
1532 }
1533
1534 /* "parse-flow FLOW": parses the argument as a flow (like add-flow) and prints
1535  * it back to stdout.  */
1536 static void
1537 do_parse_flow(int argc OVS_UNUSED, char *argv[])
1538 {
1539     enum nx_flow_format flow_format;
1540     bool flow_mod_table_id;
1541     struct list packets;
1542
1543     flow_format = NXFF_OPENFLOW10;
1544     if (preferred_flow_format > 0) {
1545         flow_format = preferred_flow_format;
1546     }
1547     flow_mod_table_id = false;
1548
1549     list_init(&packets);
1550     parse_ofp_flow_mod_str(&packets, &flow_format, &flow_mod_table_id,
1551                            argv[1], OFPFC_ADD, false);
1552     print_packet_list(&packets);
1553 }
1554
1555 /* "parse-flows FILENAME": reads the named file as a sequence of flows (like
1556  * add-flows) and prints each of the flows back to stdout.  */
1557 static void
1558 do_parse_flows(int argc OVS_UNUSED, char *argv[])
1559 {
1560     enum nx_flow_format flow_format;
1561     bool flow_mod_table_id;
1562     struct list packets;
1563     FILE *file;
1564
1565     file = fopen(argv[1], "r");
1566     if (file == NULL) {
1567         ovs_fatal(errno, "%s: open", argv[1]);
1568     }
1569
1570     flow_format = NXFF_OPENFLOW10;
1571     if (preferred_flow_format > 0) {
1572         flow_format = preferred_flow_format;
1573     }
1574     flow_mod_table_id = false;
1575
1576     list_init(&packets);
1577     while (parse_ofp_flow_mod_file(&packets, &flow_format, &flow_mod_table_id,
1578                                    file, OFPFC_ADD)) {
1579         print_packet_list(&packets);
1580     }
1581     fclose(file);
1582 }
1583
1584 /* "parse-nx-match": reads a series of nx_match specifications as strings from
1585  * stdin, does some internal fussing with them, and then prints them back as
1586  * strings on stdout. */
1587 static void
1588 do_parse_nx_match(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1589 {
1590     struct ds in;
1591
1592     ds_init(&in);
1593     while (!ds_get_line(&in, stdin)) {
1594         struct ofpbuf nx_match;
1595         struct cls_rule rule;
1596         ovs_be64 cookie, cookie_mask;
1597         enum ofperr error;
1598         int match_len;
1599         char *s;
1600
1601         /* Delete comments, skip blank lines. */
1602         s = ds_cstr(&in);
1603         if (*s == '#') {
1604             puts(s);
1605             continue;
1606         }
1607         if (strchr(s, '#')) {
1608             *strchr(s, '#') = '\0';
1609         }
1610         if (s[strspn(s, " ")] == '\0') {
1611             putchar('\n');
1612             continue;
1613         }
1614
1615         /* Convert string to nx_match. */
1616         ofpbuf_init(&nx_match, 0);
1617         match_len = nx_match_from_string(ds_cstr(&in), &nx_match);
1618
1619         /* Convert nx_match to cls_rule. */
1620         if (strict) {
1621             error = nx_pull_match(&nx_match, match_len, 0, &rule,
1622                                   &cookie, &cookie_mask);
1623         } else {
1624             error = nx_pull_match_loose(&nx_match, match_len, 0, &rule,
1625                                         &cookie, &cookie_mask);
1626         }
1627
1628         if (!error) {
1629             char *out;
1630
1631             /* Convert cls_rule back to nx_match. */
1632             ofpbuf_uninit(&nx_match);
1633             ofpbuf_init(&nx_match, 0);
1634             match_len = nx_put_match(&nx_match, &rule, cookie, cookie_mask);
1635
1636             /* Convert nx_match to string. */
1637             out = nx_match_to_string(nx_match.data, match_len);
1638             puts(out);
1639             free(out);
1640         } else {
1641             printf("nx_pull_match() returned error %s\n",
1642                    ofperr_get_name(error));
1643         }
1644
1645         ofpbuf_uninit(&nx_match);
1646     }
1647     ds_destroy(&in);
1648 }
1649
1650 /* "ofp-print HEXSTRING [VERBOSITY]": Converts the hex digits in HEXSTRING into
1651  * binary data, interpreting them as an OpenFlow message, and prints the
1652  * OpenFlow message on stdout, at VERBOSITY (level 2 by default).  */
1653 static void
1654 do_ofp_print(int argc, char *argv[])
1655 {
1656     struct ofpbuf packet;
1657
1658     ofpbuf_init(&packet, strlen(argv[1]) / 2);
1659     if (ofpbuf_put_hex(&packet, argv[1], NULL)[0] != '\0') {
1660         ovs_fatal(0, "trailing garbage following hex bytes");
1661     }
1662     ofp_print(stdout, packet.data, packet.size, argc > 2 ? atoi(argv[2]) : 2);
1663     ofpbuf_uninit(&packet);
1664 }
1665
1666 static const struct command all_commands[] = {
1667     { "show", 1, 1, do_show },
1668     { "monitor", 1, 3, do_monitor },
1669     { "snoop", 1, 1, do_snoop },
1670     { "dump-desc", 1, 1, do_dump_desc },
1671     { "dump-tables", 1, 1, do_dump_tables },
1672     { "dump-flows", 1, 2, do_dump_flows },
1673     { "dump-aggregate", 1, 2, do_dump_aggregate },
1674     { "queue-stats", 1, 3, do_queue_stats },
1675     { "add-flow", 2, 2, do_add_flow },
1676     { "add-flows", 2, 2, do_add_flows },
1677     { "mod-flows", 2, 2, do_mod_flows },
1678     { "del-flows", 1, 2, do_del_flows },
1679     { "replace-flows", 2, 2, do_replace_flows },
1680     { "diff-flows", 2, 2, do_diff_flows },
1681     { "dump-ports", 1, 2, do_dump_ports },
1682     { "mod-port", 3, 3, do_mod_port },
1683     { "get-frags", 1, 1, do_get_frags },
1684     { "set-frags", 2, 2, do_set_frags },
1685     { "probe", 1, 1, do_probe },
1686     { "ping", 1, 2, do_ping },
1687     { "benchmark", 3, 3, do_benchmark },
1688     { "help", 0, INT_MAX, do_help },
1689
1690     /* Undocumented commands for testing. */
1691     { "parse-flow", 1, 1, do_parse_flow },
1692     { "parse-flows", 1, 1, do_parse_flows },
1693     { "parse-nx-match", 0, 0, do_parse_nx_match },
1694     { "ofp-print", 1, 2, do_ofp_print },
1695
1696     { NULL, 0, 0, NULL },
1697 };