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