utilities/ovs-ofctl.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 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 <arpa/inet.h>
  19 #include <errno.h>
  20 #include <getopt.h>
  21 #include <inttypes.h>
  22 #include <net/if.h>
  23 #include <netinet/in.h>
  24 #include <signal.h>
  25 #include <stdarg.h>
  26 #include <stdlib.h>
  27 #include <string.h>
  28 #include <unistd.h>
  29 #include <sys/stat.h>
  30 #include <sys/time.h>
  31
  32 #include "command-line.h"
  33 #include "compiler.h"
  34 #include "dirs.h"
  35 #include "dpif.h"
  36 #include "dynamic-string.h"
  37 #include "netdev.h"
  38 #include "netlink.h"
  39 #include "odp-util.h"
  40 #include "ofp-print.h"
  41 #include "ofpbuf.h"
  42 #include "openflow/nicira-ext.h"
  43 #include "openflow/openflow.h"
  44 #include "packets.h"
  45 #include "random.h"
  46 #include "socket-util.h"
  47 #include "stream-ssl.h"
  48 #include "timeval.h"
  49 #include "util.h"
  50 #include "vconn.h"
  51 #include "xtoxll.h"
  52
  53 #include "vlog.h"
  54 #define THIS_MODULE VLM_ofctl
  55
  56 #define DEFAULT_IDLE_TIMEOUT 60
  57
  58 #define MOD_PORT_CMD_UP      "up"
  59 #define MOD_PORT_CMD_DOWN    "down"
  60 #define MOD_PORT_CMD_FLOOD   "flood"
  61 #define MOD_PORT_CMD_NOFLOOD "noflood"
  62
  63 /* Use strict matching for flow mod commands? */
  64 static bool strict;
  65
  66 static const struct command all_commands[];
  67
  68 static void usage(void) NO_RETURN;
  69 static void parse_options(int argc, char *argv[]);
  70
  71 int
  72 main(int argc, char *argv[])
  73 {
  74     set_program_name(argv[0]);
  75     time_init();
  76     vlog_init();
  77     parse_options(argc, argv);
  78     signal(SIGPIPE, SIG_IGN);
  79     run_command(argc - optind, argv + optind, all_commands);
  80     return 0;
  81 }
  82
  83 static void
  84 parse_options(int argc, char *argv[])
  85 {
  86     enum {
  87         OPT_STRICT = UCHAR_MAX + 1,
  88         VLOG_OPTION_ENUMS
  89     };
  90     static struct option long_options[] = {
  91         {"timeout", required_argument, 0, 't'},
  92         {"strict", no_argument, 0, OPT_STRICT},
  93         {"help", no_argument, 0, 'h'},
  94         {"version", no_argument, 0, 'V'},
  95         VLOG_LONG_OPTIONS,
  96         STREAM_SSL_LONG_OPTIONS
  97         {0, 0, 0, 0},
  98     };
  99     char *short_options = long_options_to_short_options(long_options);
 100
 101     for (;;) {
 102         unsigned long int timeout;
 103         int c;
 104
 105         c = getopt_long(argc, argv, short_options, long_options, NULL);
 106         if (c == -1) {
 107             break;
 108         }
 109
 110         switch (c) {
 111         case 't':
 112             timeout = strtoul(optarg, NULL, 10);
 113             if (timeout <= 0) {
 114                 ovs_fatal(0, "value %s on -t or --timeout is not at least 1",
 115                           optarg);
 116             } else {
 117                 time_alarm(timeout);
 118             }
 119             break;
 120
 121         case 'h':
 122             usage();
 123
 124         case 'V':
 125             OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
 126             exit(EXIT_SUCCESS);
 127
 128         case OPT_STRICT:
 129             strict = true;
 130             break;
 131
 132         VLOG_OPTION_HANDLERS
 133         STREAM_SSL_OPTION_HANDLERS
 134
 135         case '?':
 136             exit(EXIT_FAILURE);
 137
 138         default:
 139             abort();
 140         }
 141     }
 142     free(short_options);
 143 }
 144
 145 static void
 146 usage(void)
 147 {
 148     printf("%s: OpenFlow switch management utility\n"
 149            "usage: %s [OPTIONS] COMMAND [ARG...]\n"
 150            "\nFor OpenFlow switches:\n"
 151            "  show SWITCH                 show OpenFlow information\n"
 152            "  status SWITCH [KEY]         report statistics (about KEY)\n"
 153            "  dump-desc SWITCH            print switch description\n"
 154            "  dump-tables SWITCH          print table stats\n"
 155            "  mod-port SWITCH IFACE ACT   modify port behavior\n"
 156            "  dump-ports SWITCH           print port statistics\n"
 157            "  dump-flows SWITCH           print all flow entries\n"
 158            "  dump-flows SWITCH FLOW      print matching FLOWs\n"
 159            "  dump-aggregate SWITCH       print aggregate flow statistics\n"
 160            "  dump-aggregate SWITCH FLOW  print aggregate stats for FLOWs\n"
 161            "  add-flow SWITCH FLOW        add flow described by FLOW\n"
 162            "  add-flows SWITCH FILE       add flows from FILE\n"
 163            "  mod-flows SWITCH FLOW       modify actions of matching FLOWs\n"
 164            "  del-flows SWITCH [FLOW]     delete matching FLOWs\n"
 165            "  monitor SWITCH MISSLEN EXP  print packets received from SWITCH\n"
 166            "\nFor OpenFlow switches and controllers:\n"
 167            "  probe VCONN                 probe whether VCONN is up\n"
 168            "  ping VCONN [N]              latency of N-byte echos\n"
 169            "  benchmark VCONN N COUNT     bandwidth of COUNT N-byte echos\n"
 170            "where each SWITCH is an active OpenFlow connection method.\n",
 171            program_name, program_name);
 172     vconn_usage(true, false, false);
 173     vlog_usage();
 174     printf("\nOther options:\n"
 175            "  --strict                    use strict match for flow commands\n"
 176            "  -t, --timeout=SECS          give up after SECS seconds\n"
 177            "  -h, --help                  display this help message\n"
 178            "  -V, --version               display version information\n");
 179     exit(EXIT_SUCCESS);
 180 }
 181
 182 static void run(int retval, const char *message, ...)
 183     PRINTF_FORMAT(2, 3);
 184
 185 static void run(int retval, const char *message, ...)
 186 {
 187     if (retval) {
 188         va_list args;
 189
 190         fprintf(stderr, "%s: ", program_name);
 191         va_start(args, message);
 192         vfprintf(stderr, message, args);
 193         va_end(args);
 194         if (retval == EOF) {
 195             fputs(": unexpected end of file\n", stderr);
 196         } else {
 197             fprintf(stderr, ": %s\n", strerror(retval));
 198         }
 199
 200         exit(EXIT_FAILURE);
 201     }
 202 }
 203 \f
 204 /* Generic commands. */
 205
 206 static void
 207 open_vconn_socket(const char *name, struct vconn **vconnp)
 208 {
 209     char *vconn_name = xasprintf("unix:%s", name);
 210     VLOG_INFO("connecting to %s", vconn_name);
 211     run(vconn_open_block(vconn_name, OFP_VERSION, vconnp),
 212         "connecting to %s", vconn_name);
 213     free(vconn_name);
 214 }
 215
 216 static void
 217 open_vconn(const char *name, struct vconn **vconnp)
 218 {
 219     struct dpif *dpif;
 220     struct stat s;
 221     char *bridge_path, *datapath_name, *datapath_type;
 222
 223     bridge_path = xasprintf("%s/%s.mgmt", ovs_rundir, name);
 224     dp_parse_name(name, &datapath_name, &datapath_type);
 225
 226     if (strstr(name, ":")) {
 227         run(vconn_open_block(name, OFP_VERSION, vconnp),
 228             "connecting to %s", name);
 229     } else if (!stat(name, &s) && S_ISSOCK(s.st_mode)) {
 230         open_vconn_socket(name, vconnp);
 231     } else if (!stat(bridge_path, &s) && S_ISSOCK(s.st_mode)) {
 232         open_vconn_socket(bridge_path, vconnp);
 233     } else if (!dpif_open(datapath_name, datapath_type, &dpif)) {
 234         char dpif_name[IF_NAMESIZE + 1];
 235         char *socket_name;
 236
 237         run(dpif_port_get_name(dpif, ODPP_LOCAL, dpif_name, sizeof dpif_name),
 238             "obtaining name of %s", dpif_name);
 239         dpif_close(dpif);
 240         if (strcmp(dpif_name, name)) {
 241             VLOG_INFO("datapath %s is named %s", name, dpif_name);
 242         }
 243
 244         socket_name = xasprintf("%s/%s.mgmt", ovs_rundir, dpif_name);
 245         if (stat(socket_name, &s)) {
 246             ovs_fatal(errno, "cannot connect to %s: stat failed on %s",
 247                       name, socket_name);
 248         } else if (!S_ISSOCK(s.st_mode)) {
 249             ovs_fatal(0, "cannot connect to %s: %s is not a socket",
 250                       name, socket_name);
 251         }
 252
 253         open_vconn_socket(socket_name, vconnp);
 254         free(socket_name);
 255     } else {
 256         ovs_fatal(0, "%s is not a valid connection method", name);
 257     }
 258
 259     free(datapath_name);
 260     free(datapath_type);
 261     free(bridge_path);
 262 }
 263
 264 static void *
 265 alloc_stats_request(size_t body_len, uint16_t type, struct ofpbuf **bufferp)
 266 {
 267     struct ofp_stats_request *rq;
 268     rq = make_openflow((offsetof(struct ofp_stats_request, body)
 269                         + body_len), OFPT_STATS_REQUEST, bufferp);
 270     rq->type = htons(type);
 271     rq->flags = htons(0);
 272     return rq->body;
 273 }
 274
 275 static void
 276 send_openflow_buffer(struct vconn *vconn, struct ofpbuf *buffer)
 277 {
 278     update_openflow_length(buffer);
 279     run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
 280 }
 281
 282 static void
 283 dump_transaction(const char *vconn_name, struct ofpbuf *request)
 284 {
 285     struct vconn *vconn;
 286     struct ofpbuf *reply;
 287
 288     update_openflow_length(request);
 289     open_vconn(vconn_name, &vconn);
 290     run(vconn_transact(vconn, request, &reply), "talking to %s", vconn_name);
 291     ofp_print(stdout, reply->data, reply->size, 1);
 292     vconn_close(vconn);
 293 }
 294
 295 static void
 296 dump_trivial_transaction(const char *vconn_name, uint8_t request_type)
 297 {
 298     struct ofpbuf *request;
 299     make_openflow(sizeof(struct ofp_header), request_type, &request);
 300     dump_transaction(vconn_name, request);
 301 }
 302
 303 static void
 304 dump_stats_transaction(const char *vconn_name, struct ofpbuf *request)
 305 {
 306     uint32_t send_xid = ((struct ofp_header *) request->data)->xid;
 307     struct vconn *vconn;
 308     bool done = false;
 309
 310     open_vconn(vconn_name, &vconn);
 311     send_openflow_buffer(vconn, request);
 312     while (!done) {
 313         uint32_t recv_xid;
 314         struct ofpbuf *reply;
 315
 316         run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
 317         recv_xid = ((struct ofp_header *) reply->data)->xid;
 318         if (send_xid == recv_xid) {
 319             struct ofp_stats_reply *osr;
 320
 321             ofp_print(stdout, reply->data, reply->size, 1);
 322
 323             osr = ofpbuf_at(reply, 0, sizeof *osr);
 324             done = !osr || !(ntohs(osr->flags) & OFPSF_REPLY_MORE);
 325         } else {
 326             VLOG_DBG("received reply with xid %08"PRIx32" "
 327                      "!= expected %08"PRIx32, recv_xid, send_xid);
 328         }
 329         ofpbuf_delete(reply);
 330     }
 331     vconn_close(vconn);
 332 }
 333
 334 static void
 335 dump_trivial_stats_transaction(const char *vconn_name, uint8_t stats_type)
 336 {
 337     struct ofpbuf *request;
 338     alloc_stats_request(0, stats_type, &request);
 339     dump_stats_transaction(vconn_name, request);
 340 }
 341
 342 static void
 343 do_show(int argc OVS_UNUSED, char *argv[])
 344 {
 345     dump_trivial_transaction(argv[1], OFPT_FEATURES_REQUEST);
 346     dump_trivial_transaction(argv[1], OFPT_GET_CONFIG_REQUEST);
 347 }
 348
 349 static void
 350 do_status(int argc, char *argv[])
 351 {
 352     struct nicira_header *request, *reply;
 353     struct vconn *vconn;
 354     struct ofpbuf *b;
 355
 356     request = make_openflow(sizeof *request, OFPT_VENDOR, &b);
 357     request->vendor = htonl(NX_VENDOR_ID);
 358     request->subtype = htonl(NXT_STATUS_REQUEST);
 359     if (argc > 2) {
 360         ofpbuf_put(b, argv[2], strlen(argv[2]));
 361         update_openflow_length(b);
 362     }
 363     open_vconn(argv[1], &vconn);
 364     run(vconn_transact(vconn, b, &b), "talking to %s", argv[1]);
 365     vconn_close(vconn);
 366
 367     if (b->size < sizeof *reply) {
 368         ovs_fatal(0, "short reply (%zu bytes)", b->size);
 369     }
 370     reply = b->data;
 371     if (reply->header.type != OFPT_VENDOR
 372         || reply->vendor != ntohl(NX_VENDOR_ID)
 373         || reply->subtype != ntohl(NXT_STATUS_REPLY)) {
 374         ofp_print(stderr, b->data, b->size, 2);
 375         ovs_fatal(0, "bad reply");
 376     }
 377
 378     fwrite(reply + 1, b->size - sizeof *reply, 1, stdout);
 379 }
 380
 381 static void
 382 do_dump_desc(int argc OVS_UNUSED, char *argv[])
 383 {
 384     dump_trivial_stats_transaction(argv[1], OFPST_DESC);
 385 }
 386
 387 static void
 388 do_dump_tables(int argc OVS_UNUSED, char *argv[])
 389 {
 390     dump_trivial_stats_transaction(argv[1], OFPST_TABLE);
 391 }
 392
 393
 394 static uint32_t
 395 str_to_u32(const char *str)
 396 {
 397     char *tail;
 398     uint32_t value;
 399
 400     errno = 0;
 401     value = strtoul(str, &tail, 0);
 402     if (errno == EINVAL || errno == ERANGE || *tail) {
 403         ovs_fatal(0, "invalid numeric format %s", str);
 404     }
 405     return value;
 406 }
 407
 408 static void
 409 str_to_mac(const char *str, uint8_t mac[6])
 410 {
 411     if (sscanf(str, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
 412         != ETH_ADDR_SCAN_COUNT) {
 413         ovs_fatal(0, "invalid mac address %s", str);
 414     }
 415 }
 416
 417 static uint32_t
 418 str_to_ip(const char *str_, uint32_t *ip)
 419 {
 420     char *str = xstrdup(str_);
 421     char *save_ptr = NULL;
 422     const char *name, *netmask;
 423     struct in_addr in_addr;
 424     int n_wild, retval;
 425
 426     name = strtok_r(str, "/", &save_ptr);
 427     retval = name ? lookup_ip(name, &in_addr) : EINVAL;
 428     if (retval) {
 429         ovs_fatal(0, "%s: could not convert to IP address", str);
 430     }
 431     *ip = in_addr.s_addr;
 432
 433     netmask = strtok_r(NULL, "/", &save_ptr);
 434     if (netmask) {
 435         uint8_t o[4];
 436         if (sscanf(netmask, "%"SCNu8".%"SCNu8".%"SCNu8".%"SCNu8,
 437                    &o[0], &o[1], &o[2], &o[3]) == 4) {
 438             uint32_t nm = (o[0] << 24) | (o[1] << 16) | (o[2] << 8) | o[3];
 439             int i;
 440
 441             /* Find first 1-bit. */
 442             for (i = 0; i < 32; i++) {
 443                 if (nm & (1u << i)) {
 444                     break;
 445                 }
 446             }
 447             n_wild = i;
 448
 449             /* Verify that the rest of the bits are 1-bits. */
 450             for (; i < 32; i++) {
 451                 if (!(nm & (1u << i))) {
 452                     ovs_fatal(0, "%s: %s is not a valid netmask",
 453                               str, netmask);
 454                 }
 455             }
 456         } else {
 457             int prefix = atoi(netmask);
 458             if (prefix <= 0 || prefix > 32) {
 459                 ovs_fatal(0, "%s: network prefix bits not between 1 and 32",
 460                           str);
 461             }
 462             n_wild = 32 - prefix;
 463         }
 464     } else {
 465         n_wild = 0;
 466     }
 467
 468     free(str);
 469     return n_wild;
 470 }
 471
 472 static void *
 473 put_action(struct ofpbuf *b, size_t size, uint16_t type)
 474 {
 475     struct ofp_action_header *ah = ofpbuf_put_zeros(b, size);
 476     ah->type = htons(type);
 477     ah->len = htons(size);
 478     return ah;
 479 }
 480
 481 static struct ofp_action_output *
 482 put_output_action(struct ofpbuf *b, uint16_t port)
 483 {
 484     struct ofp_action_output *oao = put_action(b, sizeof *oao, OFPAT_OUTPUT);
 485     oao->port = htons(port);
 486     return oao;
 487 }
 488
 489 static void
 490 put_dl_addr_action(struct ofpbuf *b, uint16_t type, const char *addr)
 491 {
 492     struct ofp_action_dl_addr *oada = put_action(b, sizeof *oada, type);
 493     str_to_mac(addr, oada->dl_addr);
 494 }
 495
 496
 497 static bool
 498 parse_port_name(const char *name, uint16_t *port)
 499 {
 500     struct pair {
 501         const char *name;
 502         uint16_t value;
 503     };
 504     static const struct pair pairs[] = {
 505 #define DEF_PAIR(NAME) {#NAME, OFPP_##NAME}
 506         DEF_PAIR(IN_PORT),
 507         DEF_PAIR(TABLE),
 508         DEF_PAIR(NORMAL),
 509         DEF_PAIR(FLOOD),
 510         DEF_PAIR(ALL),
 511         DEF_PAIR(CONTROLLER),
 512         DEF_PAIR(LOCAL),
 513         DEF_PAIR(NONE),
 514 #undef DEF_PAIR
 515     };
 516     static const int n_pairs = ARRAY_SIZE(pairs);
 517     size_t i;
 518
 519     for (i = 0; i < n_pairs; i++) {
 520         if (!strcasecmp(name, pairs[i].name)) {
 521             *port = pairs[i].value;
 522             return true;
 523         }
 524     }
 525     return false;
 526 }
 527
 528 static void
 529 str_to_action(char *str, struct ofpbuf *b)
 530 {
 531     char *act, *arg;
 532     char *saveptr = NULL;
 533     bool drop = false;
 534     int n_actions;
 535
 536     for (act = strtok_r(str, ", \t\r\n", &saveptr), n_actions = 0; act;
 537          act = strtok_r(NULL, ", \t\r\n", &saveptr), n_actions++)
 538     {
 539         uint16_t port;
 540
 541         if (drop) {
 542             ovs_fatal(0, "Drop actions must not be followed by other actions");
 543         }
 544
 545         /* Arguments are separated by colons */
 546         arg = strchr(act, ':');
 547         if (arg) {
 548             *arg = '\0';
 549             arg++;
 550         }
 551
 552         if (!strcasecmp(act, "mod_vlan_vid")) {
 553             struct ofp_action_vlan_vid *va;
 554             va = put_action(b, sizeof *va, OFPAT_SET_VLAN_VID);
 555             va->vlan_vid = htons(str_to_u32(arg));
 556         } else if (!strcasecmp(act, "mod_vlan_pcp")) {
 557             struct ofp_action_vlan_pcp *va;
 558             va = put_action(b, sizeof *va, OFPAT_SET_VLAN_PCP);
 559             va->vlan_pcp = str_to_u32(arg);
 560         } else if (!strcasecmp(act, "strip_vlan")) {
 561             struct ofp_action_header *ah;
 562             ah = put_action(b, sizeof *ah, OFPAT_STRIP_VLAN);
 563             ah->type = htons(OFPAT_STRIP_VLAN);
 564         } else if (!strcasecmp(act, "mod_dl_src")) {
 565             put_dl_addr_action(b, OFPAT_SET_DL_SRC, arg);
 566         } else if (!strcasecmp(act, "mod_dl_dst")) {
 567             put_dl_addr_action(b, OFPAT_SET_DL_DST, arg);
 568         } else if (!strcasecmp(act, "mod_nw_src")) {
 569             struct ofp_action_nw_addr *na;
 570             na = put_action(b, sizeof *na, OFPAT_SET_NW_SRC);
 571             str_to_ip(arg, &na->nw_addr);
 572         } else if (!strcasecmp(act, "mod_nw_dst")) {
 573             struct ofp_action_nw_addr *na;
 574             na = put_action(b, sizeof *na, OFPAT_SET_NW_DST);
 575             str_to_ip(arg, &na->nw_addr);
 576         } else if (!strcasecmp(act, "mod_tp_src")) {
 577             struct ofp_action_tp_port *ta;
 578             ta = put_action(b, sizeof *ta, OFPAT_SET_TP_SRC);
 579             ta->tp_port = htons(str_to_u32(arg));
 580         } else if (!strcasecmp(act, "mod_tp_dst")) {
 581             struct ofp_action_tp_port *ta;
 582             ta = put_action(b, sizeof *ta, OFPAT_SET_TP_DST);
 583             ta->tp_port = htons(str_to_u32(arg));
 584         } else if (!strcasecmp(act, "mod_nw_tos")) {
 585             struct ofp_action_nw_tos *nt;
 586             nt = put_action(b, sizeof *nt, OFPAT_SET_NW_TOS);
 587             nt->nw_tos = str_to_u32(arg);
 588         } else if (!strcasecmp(act, "output")) {
 589             put_output_action(b, str_to_u32(arg));
 590         } else if (!strcasecmp(act, "drop")) {
 591             /* A drop action in OpenFlow occurs by just not setting
 592              * an action. */
 593             drop = true;
 594             if (n_actions) {
 595                 ovs_fatal(0, "Drop actions must not be preceded by other "
 596                           "actions");
 597             }
 598         } else if (!strcasecmp(act, "CONTROLLER")) {
 599             struct ofp_action_output *oao;
 600             oao = put_output_action(b, OFPP_CONTROLLER);
 601
 602             /* Unless a numeric argument is specified, we send the whole
 603              * packet to the controller. */
 604             if (arg && (strspn(act, "0123456789") == strlen(act))) {
 605                oao->max_len = htons(str_to_u32(arg));
 606             } else {
 607                 oao->max_len = htons(UINT16_MAX);
 608             }
 609         } else if (parse_port_name(act, &port)) {
 610             put_output_action(b, port);
 611         } else if (strspn(act, "0123456789") == strlen(act)) {
 612             put_output_action(b, str_to_u32(act));
 613         } else {
 614             ovs_fatal(0, "Unknown action: %s", act);
 615         }
 616     }
 617 }
 618
 619 struct protocol {
 620     const char *name;
 621     uint16_t dl_type;
 622     uint8_t nw_proto;
 623 };
 624
 625 static bool
 626 parse_protocol(const char *name, const struct protocol **p_out)
 627 {
 628     static const struct protocol protocols[] = {
 629         { "ip", ETH_TYPE_IP, 0 },
 630         { "arp", ETH_TYPE_ARP, 0 },
 631         { "icmp", ETH_TYPE_IP, IP_TYPE_ICMP },
 632         { "tcp", ETH_TYPE_IP, IP_TYPE_TCP },
 633         { "udp", ETH_TYPE_IP, IP_TYPE_UDP },
 634     };
 635     const struct protocol *p;
 636
 637     for (p = protocols; p < &protocols[ARRAY_SIZE(protocols)]; p++) {
 638         if (!strcmp(p->name, name)) {
 639             *p_out = p;
 640             return true;
 641         }
 642     }
 643     *p_out = NULL;
 644     return false;
 645 }
 646
 647 struct field {
 648     const char *name;
 649     uint32_t wildcard;
 650     enum { F_U8, F_U16, F_MAC, F_IP } type;
 651     size_t offset, shift;
 652 };
 653
 654 static bool
 655 parse_field(const char *name, const struct field **f_out)
 656 {
 657 #define F_OFS(MEMBER) offsetof(struct ofp_match, MEMBER)
 658     static const struct field fields[] = {
 659         { "in_port", OFPFW_IN_PORT, F_U16, F_OFS(in_port), 0 },
 660         { "dl_vlan", OFPFW_DL_VLAN, F_U16, F_OFS(dl_vlan), 0 },
 661         { "dl_vlan_pcp", OFPFW_DL_VLAN_PCP, F_U8, F_OFS(dl_vlan_pcp), 0 },
 662         { "dl_src", OFPFW_DL_SRC, F_MAC, F_OFS(dl_src), 0 },
 663         { "dl_dst", OFPFW_DL_DST, F_MAC, F_OFS(dl_dst), 0 },
 664         { "dl_type", OFPFW_DL_TYPE, F_U16, F_OFS(dl_type), 0 },
 665         { "nw_src", OFPFW_NW_SRC_MASK, F_IP,
 666           F_OFS(nw_src), OFPFW_NW_SRC_SHIFT },
 667         { "nw_dst", OFPFW_NW_DST_MASK, F_IP,
 668           F_OFS(nw_dst), OFPFW_NW_DST_SHIFT },
 669         { "nw_proto", OFPFW_NW_PROTO, F_U8, F_OFS(nw_proto), 0 },
 670         { "tp_src", OFPFW_TP_SRC, F_U16, F_OFS(tp_src), 0 },
 671         { "tp_dst", OFPFW_TP_DST, F_U16, F_OFS(tp_dst), 0 },
 672         { "icmp_type", OFPFW_ICMP_TYPE, F_U16, F_OFS(icmp_type), 0 },
 673         { "icmp_code", OFPFW_ICMP_CODE, F_U16, F_OFS(icmp_code), 0 }
 674     };
 675     const struct field *f;
 676
 677     for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
 678         if (!strcmp(f->name, name)) {
 679             *f_out = f;
 680             return true;
 681         }
 682     }
 683     *f_out = NULL;
 684     return false;
 685 }
 686
 687 static void
 688 str_to_flow(char *string, struct ofp_match *match, struct ofpbuf *actions,
 689             uint8_t *table_idx, uint16_t *out_port, uint16_t *priority,
 690             uint16_t *idle_timeout, uint16_t *hard_timeout,
 691             uint64_t *cookie)
 692 {
 693     char *save_ptr = NULL;
 694     char *name;
 695     uint32_t wildcards;
 696
 697     if (table_idx) {
 698         *table_idx = 0xff;
 699     }
 700     if (out_port) {
 701         *out_port = OFPP_NONE;
 702     }
 703     if (priority) {
 704         *priority = OFP_DEFAULT_PRIORITY;
 705     }
 706     if (idle_timeout) {
 707         *idle_timeout = DEFAULT_IDLE_TIMEOUT;
 708     }
 709     if (hard_timeout) {
 710         *hard_timeout = OFP_FLOW_PERMANENT;
 711     }
 712     if (cookie) {
 713         *cookie = 0;
 714     }
 715     if (actions) {
 716         char *act_str = strstr(string, "action");
 717         if (!act_str) {
 718             ovs_fatal(0, "must specify an action");
 719         }
 720         *(act_str-1) = '\0';
 721
 722         act_str = strchr(act_str, '=');
 723         if (!act_str) {
 724             ovs_fatal(0, "must specify an action");
 725         }
 726
 727         act_str++;
 728
 729         str_to_action(act_str, actions);
 730     }
 731     memset(match, 0, sizeof *match);
 732     wildcards = OFPFW_ALL;
 733     for (name = strtok_r(string, "=, \t\r\n", &save_ptr); name;
 734          name = strtok_r(NULL, "=, \t\r\n", &save_ptr)) {
 735         const struct protocol *p;
 736
 737         if (parse_protocol(name, &p)) {
 738             wildcards &= ~OFPFW_DL_TYPE;
 739             match->dl_type = htons(p->dl_type);
 740             if (p->nw_proto) {
 741                 wildcards &= ~OFPFW_NW_PROTO;
 742                 match->nw_proto = p->nw_proto;
 743             }
 744         } else {
 745             const struct field *f;
 746             char *value;
 747
 748             value = strtok_r(NULL, ", \t\r\n", &save_ptr);
 749             if (!value) {
 750                 ovs_fatal(0, "field %s missing value", name);
 751             }
 752
 753             if (table_idx && !strcmp(name, "table")) {
 754                 *table_idx = atoi(value);
 755             } else if (out_port && !strcmp(name, "out_port")) {
 756                 *out_port = atoi(value);
 757             } else if (priority && !strcmp(name, "priority")) {
 758                 *priority = atoi(value);
 759             } else if (idle_timeout && !strcmp(name, "idle_timeout")) {
 760                 *idle_timeout = atoi(value);
 761             } else if (hard_timeout && !strcmp(name, "hard_timeout")) {
 762                 *hard_timeout = atoi(value);
 763             } else if (cookie && !strcmp(name, "cookie")) {
 764                 *cookie = atoi(value);
 765             } else if (parse_field(name, &f)) {
 766                 void *data = (char *) match + f->offset;
 767                 if (!strcmp(value, "*") || !strcmp(value, "ANY")) {
 768                     wildcards |= f->wildcard;
 769                 } else {
 770                     wildcards &= ~f->wildcard;
 771                     if (f->wildcard == OFPFW_IN_PORT
 772                         && parse_port_name(value, (uint16_t *) data)) {
 773                         /* Nothing to do. */
 774                     } else if (f->type == F_U8) {
 775                         *(uint8_t *) data = str_to_u32(value);
 776                     } else if (f->type == F_U16) {
 777                         *(uint16_t *) data = htons(str_to_u32(value));
 778                     } else if (f->type == F_MAC) {
 779                         str_to_mac(value, data);
 780                     } else if (f->type == F_IP) {
 781                         wildcards |= str_to_ip(value, data) << f->shift;
 782                     } else {
 783                         NOT_REACHED();
 784                     }
 785                 }
 786             } else {
 787                 ovs_fatal(0, "unknown keyword %s", name);
 788             }
 789         }
 790     }
 791     match->wildcards = htonl(wildcards);
 792 }
 793
 794 static void
 795 do_dump_flows(int argc, char *argv[])
 796 {
 797     struct ofp_flow_stats_request *req;
 798     uint16_t out_port;
 799     struct ofpbuf *request;
 800
 801     req = alloc_stats_request(sizeof *req, OFPST_FLOW, &request);
 802     str_to_flow(argc > 2 ? argv[2] : "", &req->match, NULL,
 803                 &req->table_id, &out_port, NULL, NULL, NULL, NULL);
 804     memset(&req->pad, 0, sizeof req->pad);
 805     req->out_port = htons(out_port);
 806
 807     dump_stats_transaction(argv[1], request);
 808 }
 809
 810 static void
 811 do_dump_aggregate(int argc, char *argv[])
 812 {
 813     struct ofp_aggregate_stats_request *req;
 814     struct ofpbuf *request;
 815     uint16_t out_port;
 816
 817     req = alloc_stats_request(sizeof *req, OFPST_AGGREGATE, &request);
 818     str_to_flow(argc > 2 ? argv[2] : "", &req->match, NULL,
 819                 &req->table_id, &out_port, NULL, NULL, NULL, NULL);
 820     memset(&req->pad, 0, sizeof req->pad);
 821     req->out_port = htons(out_port);
 822
 823     dump_stats_transaction(argv[1], request);
 824 }
 825
 826 static void
 827 do_add_flow(int argc OVS_UNUSED, char *argv[])
 828 {
 829     struct vconn *vconn;
 830     struct ofpbuf *buffer;
 831     struct ofp_flow_mod *ofm;
 832     uint16_t priority, idle_timeout, hard_timeout;
 833     uint64_t cookie;
 834     struct ofp_match match;
 835
 836     /* Parse and send.  str_to_flow() will expand and reallocate the data in
 837      * 'buffer', so we can't keep pointers to across the str_to_flow() call. */
 838     make_openflow(sizeof *ofm, OFPT_FLOW_MOD, &buffer);
 839     str_to_flow(argv[2], &match, buffer,
 840                 NULL, NULL, &priority, &idle_timeout, &hard_timeout,
 841                 &cookie);
 842     ofm = buffer->data;
 843     ofm->match = match;
 844     ofm->command = htons(OFPFC_ADD);
 845     ofm->cookie = htonll(cookie);
 846     ofm->idle_timeout = htons(idle_timeout);
 847     ofm->hard_timeout = htons(hard_timeout);
 848     ofm->buffer_id = htonl(UINT32_MAX);
 849     ofm->priority = htons(priority);
 850
 851     open_vconn(argv[1], &vconn);
 852     send_openflow_buffer(vconn, buffer);
 853     vconn_close(vconn);
 854 }
 855
 856 static void
 857 do_add_flows(int argc OVS_UNUSED, char *argv[])
 858 {
 859     struct vconn *vconn;
 860     FILE *file;
 861     char line[1024];
 862
 863     file = fopen(argv[2], "r");
 864     if (file == NULL) {
 865         ovs_fatal(errno, "%s: open", argv[2]);
 866     }
 867
 868     open_vconn(argv[1], &vconn);
 869     while (fgets(line, sizeof line, file)) {
 870         struct ofpbuf *buffer;
 871         struct ofp_flow_mod *ofm;
 872         uint16_t priority, idle_timeout, hard_timeout;
 873         uint64_t cookie;
 874         struct ofp_match match;
 875
 876         char *comment;
 877
 878         /* Delete comments. */
 879         comment = strchr(line, '#');
 880         if (comment) {
 881             *comment = '\0';
 882         }
 883
 884         /* Drop empty lines. */
 885         if (line[strspn(line, " \t\n")] == '\0') {
 886             continue;
 887         }
 888
 889         /* Parse and send.  str_to_flow() will expand and reallocate the data
 890          * in 'buffer', so we can't keep pointers to across the str_to_flow()
 891          * call. */
 892         make_openflow(sizeof *ofm, OFPT_FLOW_MOD, &buffer);
 893         str_to_flow(line, &match, buffer,
 894                     NULL, NULL, &priority, &idle_timeout, &hard_timeout,
 895                     &cookie);
 896         ofm = buffer->data;
 897         ofm->match = match;
 898         ofm->command = htons(OFPFC_ADD);
 899         ofm->cookie = htonll(cookie);
 900         ofm->idle_timeout = htons(idle_timeout);
 901         ofm->hard_timeout = htons(hard_timeout);
 902         ofm->buffer_id = htonl(UINT32_MAX);
 903         ofm->priority = htons(priority);
 904
 905         send_openflow_buffer(vconn, buffer);
 906     }
 907     vconn_close(vconn);
 908     fclose(file);
 909 }
 910
 911 static void
 912 do_mod_flows(int argc OVS_UNUSED, char *argv[])
 913 {
 914     uint16_t priority, idle_timeout, hard_timeout;
 915     uint64_t cookie;
 916     struct vconn *vconn;
 917     struct ofpbuf *buffer;
 918     struct ofp_flow_mod *ofm;
 919     struct ofp_match match;
 920
 921     /* Parse and send.  str_to_flow() will expand and reallocate the data in
 922      * 'buffer', so we can't keep pointers to across the str_to_flow() call. */
 923     make_openflow(sizeof *ofm, OFPT_FLOW_MOD, &buffer);
 924     str_to_flow(argv[2], &match, buffer,
 925                 NULL, NULL, &priority, &idle_timeout, &hard_timeout,
 926                 &cookie);
 927     ofm = buffer->data;
 928     ofm->match = match;
 929     if (strict) {
 930         ofm->command = htons(OFPFC_MODIFY_STRICT);
 931     } else {
 932         ofm->command = htons(OFPFC_MODIFY);
 933     }
 934     ofm->idle_timeout = htons(idle_timeout);
 935     ofm->hard_timeout = htons(hard_timeout);
 936     ofm->cookie = htonll(cookie);
 937     ofm->buffer_id = htonl(UINT32_MAX);
 938     ofm->priority = htons(priority);
 939
 940     open_vconn(argv[1], &vconn);
 941     send_openflow_buffer(vconn, buffer);
 942     vconn_close(vconn);
 943 }
 944
 945 static void do_del_flows(int argc, char *argv[])
 946 {
 947     struct vconn *vconn;
 948     uint16_t priority;
 949     uint16_t out_port;
 950     struct ofpbuf *buffer;
 951     struct ofp_flow_mod *ofm;
 952
 953     /* Parse and send. */
 954     ofm = make_openflow(sizeof *ofm, OFPT_FLOW_MOD, &buffer);
 955     str_to_flow(argc > 2 ? argv[2] : "", &ofm->match, NULL, NULL,
 956                 &out_port, &priority, NULL, NULL, NULL);
 957     if (strict) {
 958         ofm->command = htons(OFPFC_DELETE_STRICT);
 959     } else {
 960         ofm->command = htons(OFPFC_DELETE);
 961     }
 962     ofm->idle_timeout = htons(0);
 963     ofm->hard_timeout = htons(0);
 964     ofm->buffer_id = htonl(UINT32_MAX);
 965     ofm->out_port = htons(out_port);
 966     ofm->priority = htons(priority);
 967
 968     open_vconn(argv[1], &vconn);
 969     send_openflow_buffer(vconn, buffer);
 970     vconn_close(vconn);
 971 }
 972
 973 static void
 974 do_monitor(int argc OVS_UNUSED, char *argv[])
 975 {
 976     struct vconn *vconn;
 977
 978     open_vconn(argv[1], &vconn);
 979     if (argc > 2) {
 980         int miss_send_len = atoi(argv[2]);
 981         struct ofp_switch_config *osc;
 982         struct ofpbuf *buf;
 983
 984         osc = make_openflow(sizeof *osc, OFPT_SET_CONFIG, &buf);
 985         osc->miss_send_len = htons(miss_send_len);
 986         send_openflow_buffer(vconn, buf);
 987     }
 988     for (;;) {
 989         struct ofpbuf *b;
 990         run(vconn_recv_block(vconn, &b), "vconn_recv");
 991         ofp_print(stderr, b->data, b->size, 2);
 992         ofpbuf_delete(b);
 993     }
 994 }
 995
 996 static void
 997 do_dump_ports(int argc OVS_UNUSED, char *argv[])
 998 {
 999     dump_trivial_stats_transaction(argv[1], OFPST_PORT);
1000 }
1001
1002 static void
1003 do_probe(int argc OVS_UNUSED, char *argv[])
1004 {
1005     struct ofpbuf *request;
1006     struct vconn *vconn;
1007     struct ofpbuf *reply;
1008
1009     make_openflow(sizeof(struct ofp_header), OFPT_ECHO_REQUEST, &request);
1010     open_vconn(argv[1], &vconn);
1011     run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1012     if (reply->size != sizeof(struct ofp_header)) {
1013         ovs_fatal(0, "reply does not match request");
1014     }
1015     ofpbuf_delete(reply);
1016     vconn_close(vconn);
1017 }
1018
1019 static void
1020 do_mod_port(int argc OVS_UNUSED, char *argv[])
1021 {
1022     struct ofpbuf *request, *reply;
1023     struct ofp_switch_features *osf;
1024     struct ofp_port_mod *opm;
1025     struct vconn *vconn;
1026     char *endptr;
1027     int n_ports;
1028     int port_idx;
1029     int port_no;
1030
1031
1032     /* Check if the argument is a port index.  Otherwise, treat it as
1033      * the port name. */
1034     port_no = strtol(argv[2], &endptr, 10);
1035     if (port_no == 0 && endptr == argv[2]) {
1036         port_no = -1;
1037     }
1038
1039     /* Send a "Features Request" to get the information we need in order
1040      * to modify the port. */
1041     make_openflow(sizeof(struct ofp_header), OFPT_FEATURES_REQUEST, &request);
1042     open_vconn(argv[1], &vconn);
1043     run(vconn_transact(vconn, request, &reply), "talking to %s", argv[1]);
1044
1045     osf = reply->data;
1046     n_ports = (reply->size - sizeof *osf) / sizeof *osf->ports;
1047
1048     for (port_idx = 0; port_idx < n_ports; port_idx++) {
1049         if (port_no != -1) {
1050             /* Check argument as a port index */
1051             if (osf->ports[port_idx].port_no == htons(port_no)) {
1052                 break;
1053             }
1054         } else {
1055             /* Check argument as an interface name */
1056             if (!strncmp((char *)osf->ports[port_idx].name, argv[2],
1057                         sizeof osf->ports[0].name)) {
1058                 break;
1059             }
1060
1061         }
1062     }
1063     if (port_idx == n_ports) {
1064         ovs_fatal(0, "couldn't find monitored port: %s", argv[2]);
1065     }
1066
1067     opm = make_openflow(sizeof(struct ofp_port_mod), OFPT_PORT_MOD, &request);
1068     opm->port_no = osf->ports[port_idx].port_no;
1069     memcpy(opm->hw_addr, osf->ports[port_idx].hw_addr, sizeof opm->hw_addr);
1070     opm->config = htonl(0);
1071     opm->mask = htonl(0);
1072     opm->advertise = htonl(0);
1073
1074     printf("modifying port: %s\n", osf->ports[port_idx].name);
1075
1076     if (!strncasecmp(argv[3], MOD_PORT_CMD_UP, sizeof MOD_PORT_CMD_UP)) {
1077         opm->mask |= htonl(OFPPC_PORT_DOWN);
1078     } else if (!strncasecmp(argv[3], MOD_PORT_CMD_DOWN,
1079                 sizeof MOD_PORT_CMD_DOWN)) {
1080         opm->mask |= htonl(OFPPC_PORT_DOWN);
1081         opm->config |= htonl(OFPPC_PORT_DOWN);
1082     } else if (!strncasecmp(argv[3], MOD_PORT_CMD_FLOOD,
1083                 sizeof MOD_PORT_CMD_FLOOD)) {
1084         opm->mask |= htonl(OFPPC_NO_FLOOD);
1085     } else if (!strncasecmp(argv[3], MOD_PORT_CMD_NOFLOOD,
1086                 sizeof MOD_PORT_CMD_NOFLOOD)) {
1087         opm->mask |= htonl(OFPPC_NO_FLOOD);
1088         opm->config |= htonl(OFPPC_NO_FLOOD);
1089     } else {
1090         ovs_fatal(0, "unknown mod-port command '%s'", argv[3]);
1091     }
1092
1093     send_openflow_buffer(vconn, request);
1094
1095     ofpbuf_delete(reply);
1096     vconn_close(vconn);
1097 }
1098
1099 static void
1100 do_ping(int argc, char *argv[])
1101 {
1102     size_t max_payload = 65535 - sizeof(struct ofp_header);
1103     unsigned int payload;
1104     struct vconn *vconn;
1105     int i;
1106
1107     payload = argc > 2 ? atoi(argv[2]) : 64;
1108     if (payload > max_payload) {
1109         ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1110     }
1111
1112     open_vconn(argv[1], &vconn);
1113     for (i = 0; i < 10; i++) {
1114         struct timeval start, end;
1115         struct ofpbuf *request, *reply;
1116         struct ofp_header *rq_hdr, *rpy_hdr;
1117
1118         rq_hdr = make_openflow(sizeof(struct ofp_header) + payload,
1119                                OFPT_ECHO_REQUEST, &request);
1120         random_bytes(rq_hdr + 1, payload);
1121
1122         gettimeofday(&start, NULL);
1123         run(vconn_transact(vconn, ofpbuf_clone(request), &reply), "transact");
1124         gettimeofday(&end, NULL);
1125
1126         rpy_hdr = reply->data;
1127         if (reply->size != request->size
1128             || memcmp(rpy_hdr + 1, rq_hdr + 1, payload)
1129             || rpy_hdr->xid != rq_hdr->xid
1130             || rpy_hdr->type != OFPT_ECHO_REPLY) {
1131             printf("Reply does not match request.  Request:\n");
1132             ofp_print(stdout, request, request->size, 2);
1133             printf("Reply:\n");
1134             ofp_print(stdout, reply, reply->size, 2);
1135         }
1136         printf("%zu bytes from %s: xid=%08"PRIx32" time=%.1f ms\n",
1137                reply->size - sizeof *rpy_hdr, argv[1], rpy_hdr->xid,
1138                    (1000*(double)(end.tv_sec - start.tv_sec))
1139                    + (.001*(end.tv_usec - start.tv_usec)));
1140         ofpbuf_delete(request);
1141         ofpbuf_delete(reply);
1142     }
1143     vconn_close(vconn);
1144 }
1145
1146 static void
1147 do_benchmark(int argc OVS_UNUSED, char *argv[])
1148 {
1149     size_t max_payload = 65535 - sizeof(struct ofp_header);
1150     struct timeval start, end;
1151     unsigned int payload_size, message_size;
1152     struct vconn *vconn;
1153     double duration;
1154     int count;
1155     int i;
1156
1157     payload_size = atoi(argv[2]);
1158     if (payload_size > max_payload) {
1159         ovs_fatal(0, "payload must be between 0 and %zu bytes", max_payload);
1160     }
1161     message_size = sizeof(struct ofp_header) + payload_size;
1162
1163     count = atoi(argv[3]);
1164
1165     printf("Sending %d packets * %u bytes (with header) = %u bytes total\n",
1166            count, message_size, count * message_size);
1167
1168     open_vconn(argv[1], &vconn);
1169     gettimeofday(&start, NULL);
1170     for (i = 0; i < count; i++) {
1171         struct ofpbuf *request, *reply;
1172         struct ofp_header *rq_hdr;
1173
1174         rq_hdr = make_openflow(message_size, OFPT_ECHO_REQUEST, &request);
1175         memset(rq_hdr + 1, 0, payload_size);
1176         run(vconn_transact(vconn, request, &reply), "transact");
1177         ofpbuf_delete(reply);
1178     }
1179     gettimeofday(&end, NULL);
1180     vconn_close(vconn);
1181
1182     duration = ((1000*(double)(end.tv_sec - start.tv_sec))
1183                 + (.001*(end.tv_usec - start.tv_usec)));
1184     printf("Finished in %.1f ms (%.0f packets/s) (%.0f bytes/s)\n",
1185            duration, count / (duration / 1000.0),
1186            count * message_size / (duration / 1000.0));
1187 }
1188
1189 static void
1190 do_help(int argc OVS_UNUSED, char *argv[] OVS_UNUSED)
1191 {
1192     usage();
1193 }
1194
1195 static const struct command all_commands[] = {
1196     { "show", 1, 1, do_show },
1197     { "status", 1, 2, do_status },
1198     { "monitor", 1, 3, do_monitor },
1199     { "dump-desc", 1, 1, do_dump_desc },
1200     { "dump-tables", 1, 1, do_dump_tables },
1201     { "dump-flows", 1, 2, do_dump_flows },
1202     { "dump-aggregate", 1, 2, do_dump_aggregate },
1203     { "add-flow", 2, 2, do_add_flow },
1204     { "add-flows", 2, 2, do_add_flows },
1205     { "mod-flows", 2, 2, do_mod_flows },
1206     { "del-flows", 1, 2, do_del_flows },
1207     { "dump-ports", 1, 1, do_dump_ports },
1208     { "mod-port", 3, 3, do_mod_port },
1209     { "probe", 1, 1, do_probe },
1210     { "ping", 1, 2, do_ping },
1211     { "benchmark", 3, 3, do_benchmark },
1212     { "help", 0, INT_MAX, do_help },
1213     { NULL, 0, 0, NULL },
1214 };