utilities/ovs-ofctl.c

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