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