utilities/dpctl.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 #include <errno.h>
  35 #include <getopt.h>
  36 #include <inttypes.h>
  37 #include <netinet/in.h>
  38 #include <stdarg.h>
  39 #include <stdlib.h>
  40 #include <string.h>
  41 #include <unistd.h>
  42 #include <sys/time.h>
  43
  44 #include "command-line.h"
  45 #include "compiler.h"
  46 #include "buffer.h"
  47 #include "dpif.h"
  48 #ifdef HAVE_NETLINK
  49 #include "netlink.h"
  50 #include "openflow-netlink.h"
  51 #endif
  52 #include "util.h"
  53 #include "socket-util.h"
  54 #include "openflow.h"
  55 #include "ofp-print.h"
  56 #include "vconn.h"
  57 #include "vconn-ssl.h"
  58
  59 #include "vlog.h"
  60 #define THIS_MODULE VLM_dpctl
  61
  62 static const char* ifconfigbin = "/sbin/ifconfig";
  63
  64 struct command {
  65     const char *name;
  66     int min_args;
  67     int max_args;
  68     void (*handler)(int argc, char *argv[]);
  69 };
  70
  71 static struct command all_commands[];
  72
  73 static void usage(void) NO_RETURN;
  74 static void parse_options(int argc, char *argv[]);
  75
  76 int main(int argc, char *argv[])
  77 {
  78     struct command *p;
  79
  80     set_program_name(argv[0]);
  81     vlog_init();
  82     parse_options(argc, argv);
  83
  84     argc -= optind;
  85     argv += optind;
  86     if (argc < 1)
  87         fatal(0, "missing command name; use --help for help");
  88
  89     for (p = all_commands; p->name != NULL; p++) {
  90         if (!strcmp(p->name, argv[0])) {
  91             int n_arg = argc - 1;
  92             if (n_arg < p->min_args)
  93                 fatal(0, "'%s' command requires at least %d arguments",
  94                       p->name, p->min_args);
  95             else if (n_arg > p->max_args)
  96                 fatal(0, "'%s' command takes at most %d arguments",
  97                       p->name, p->max_args);
  98             else {
  99                 p->handler(argc, argv);
 100                 exit(0);
 101             }
 102         }
 103     }
 104     fatal(0, "unknown command '%s'; use --help for help", argv[0]);
 105
 106     return 0;
 107 }
 108
 109 static void
 110 parse_options(int argc, char *argv[])
 111 {
 112     static struct option long_options[] = {
 113         {"verbose", optional_argument, 0, 'v'},
 114         {"help", no_argument, 0, 'h'},
 115         {"version", no_argument, 0, 'V'},
 116         VCONN_SSL_LONG_OPTIONS
 117         {0, 0, 0, 0},
 118     };
 119     char *short_options = long_options_to_short_options(long_options);
 120
 121     for (;;) {
 122         int indexptr;
 123         int c;
 124
 125         c = getopt_long(argc, argv, short_options, long_options, &indexptr);
 126         if (c == -1) {
 127             break;
 128         }
 129
 130         switch (c) {
 131         case 'h':
 132             usage();
 133
 134         case 'V':
 135             printf("%s "VERSION" compiled "__DATE__" "__TIME__"\n", argv[0]);
 136             exit(EXIT_SUCCESS);
 137
 138         case 'v':
 139             vlog_set_verbosity(optarg);
 140             break;
 141
 142         VCONN_SSL_OPTION_HANDLERS
 143
 144         case '?':
 145             exit(EXIT_FAILURE);
 146
 147         default:
 148             abort();
 149         }
 150     }
 151     free(short_options);
 152 }
 153
 154 static void
 155 usage(void)
 156 {
 157     printf("%s: OpenFlow switch management utility\n"
 158            "usage: %s [OPTIONS] COMMAND [ARG...]\n"
 159 #ifdef HAVE_NETLINK
 160            "\nCommands that apply to local datapaths only:\n"
 161            "  adddp nl:DP_ID              add a new local datapath DP_ID\n"
 162            "  deldp nl:DP_ID              delete local datapath DP_ID\n"
 163            "  addif nl:DP_ID IFACE        add IFACE as a port on DP_ID\n"
 164            "  delif nl:DP_ID IFACE        delete IFACE as a port on DP_ID\n"
 165            "  monitor nl:DP_ID            print packets received\n"
 166            "  benchmark-nl nl:DP_ID N SIZE   send N packets of SIZE bytes\n"
 167 #endif
 168            "\nCommands that apply to local datapaths and remote switches:\n"
 169            "  show SWITCH                 show information\n"
 170            "  dump-tables SWITCH          print table stats\n"
 171            "  dump-ports SWITCH           print port statistics\n"
 172            "  dump-flows SWITCH           print all flow entries\n"
 173            "  dump-flows SWITCH FLOW      print matching FLOWs\n"
 174            "  add-flows SWITCH FILE       add flows from FILE\n"
 175            "where each SWITCH is an active OpenFlow connection method.\n",
 176            program_name, program_name);
 177     vconn_usage(true, false);
 178     printf("\nOptions:\n"
 179            "  -v, --verbose               set maximum verbosity level\n"
 180            "  -h, --help                  display this help message\n"
 181            "  -V, --version               display version information\n");
 182     exit(EXIT_SUCCESS);
 183 }
 184
 185 static void run(int retval, const char *message, ...)
 186     PRINTF_FORMAT(2, 3);
 187
 188 static void run(int retval, const char *message, ...)
 189 {
 190     if (retval) {
 191         va_list args;
 192
 193         fprintf(stderr, "%s: ", program_name);
 194         va_start(args, message);
 195         vfprintf(stderr, message, args);
 196         va_end(args);
 197         if (retval == EOF) {
 198             fputs(": unexpected end of file\n", stderr);
 199         } else {
 200             fprintf(stderr, ": %s\n", strerror(retval));
 201         }
 202
 203         exit(EXIT_FAILURE);
 204     }
 205 }
 206 \f
 207 #ifdef HAVE_NETLINK
 208 /* Netlink-only commands. */
 209
 210 static int  if_up(const char* intf)
 211 {
 212     char command[256];
 213     snprintf(command, sizeof command, "%s %s up &> /dev/null",
 214             ifconfigbin, intf);
 215     return system(command);
 216 }
 217
 218 static void open_nl_vconn(const char *name, bool subscribe, struct dpif *dpif)
 219 {
 220     if (strncmp(name, "nl:", 3)
 221         || strlen(name) < 4
 222         || name[strspn(name + 3, "0123456789") + 3]) {
 223         fatal(0, "%s: argument is not of the form \"nl:DP_ID\"", name);
 224     }
 225     run(dpif_open(atoi(name + 3), subscribe, dpif), "opening datapath");
 226 }
 227
 228 static void do_add_dp(int argc UNUSED, char *argv[])
 229 {
 230     struct dpif dp;
 231     open_nl_vconn(argv[1], false, &dp);
 232     run(dpif_add_dp(&dp), "add_dp");
 233     dpif_close(&dp);
 234 }
 235
 236 static void do_del_dp(int argc UNUSED, char *argv[])
 237 {
 238     struct dpif dp;
 239     open_nl_vconn(argv[1], false, &dp);
 240     run(dpif_del_dp(&dp), "del_dp");
 241     dpif_close(&dp);
 242 }
 243
 244 static void do_add_port(int argc UNUSED, char *argv[])
 245 {
 246     struct dpif dp;
 247     if_up(argv[2]);
 248     open_nl_vconn(argv[1], false, &dp);
 249     run(dpif_add_port(&dp, argv[2]), "add_port");
 250     dpif_close(&dp);
 251 }
 252
 253 static void do_del_port(int argc UNUSED, char *argv[])
 254 {
 255     struct dpif dp;
 256     open_nl_vconn(argv[1], false, &dp);
 257     run(dpif_del_port(&dp, argv[2]), "del_port");
 258     dpif_close(&dp);
 259 }
 260
 261 static void do_monitor(int argc UNUSED, char *argv[])
 262 {
 263     struct dpif dp;
 264     open_nl_vconn(argv[1], false, &dp);
 265     for (;;) {
 266         struct buffer *b;
 267         run(dpif_recv_openflow(&dp, &b, true), "dpif_recv_openflow");
 268         ofp_print(stderr, b->data, b->size, 2);
 269         buffer_delete(b);
 270     }
 271 }
 272
 273 #define BENCHMARK_INCR   100
 274
 275 static void do_benchmark_nl(int argc UNUSED, char *argv[])
 276 {
 277     struct dpif dp;
 278     uint32_t num_packets, i, milestone;
 279     struct timeval start, end;
 280
 281     open_nl_vconn(argv[1], false, &dp);
 282     num_packets = atoi(argv[2]);
 283     milestone = BENCHMARK_INCR;
 284     run(dpif_benchmark_nl(&dp, num_packets, atoi(argv[3])), "benchmark_nl");
 285     if (gettimeofday(&start, NULL) == -1) {
 286         run(errno, "gettimeofday");
 287     }
 288     for (i = 0; i < num_packets;i++) {
 289         struct buffer *b;
 290         run(dpif_recv_openflow(&dp, &b, true), "dpif_recv_openflow");
 291         if (i == milestone) {
 292             gettimeofday(&end, NULL);
 293             printf("%u packets received in %f ms\n",
 294                    BENCHMARK_INCR,
 295                    (1000*(double)(end.tv_sec - start.tv_sec))
 296                    + (.001*(end.tv_usec - start.tv_usec)));
 297             milestone += BENCHMARK_INCR;
 298             start = end;
 299         }
 300         buffer_delete(b);
 301     }
 302     gettimeofday(&end, NULL);
 303     printf("%u packets received in %f ms\n",
 304            i - (milestone - BENCHMARK_INCR),
 305            (1000*(double)(end.tv_sec - start.tv_sec))
 306            + (.001*(end.tv_usec - start.tv_usec)));
 307
 308     dpif_close(&dp);
 309 }
 310 #endif /* HAVE_NETLINK */
 311 \f
 312 /* Generic commands. */
 313
 314 static uint32_t
 315 random_xid(void)
 316 {
 317     static bool inited = false;
 318     if (!inited) {
 319         struct timeval tv;
 320         inited = true;
 321         if (gettimeofday(&tv, NULL) < 0) {
 322             fatal(errno, "gettimeofday");
 323         }
 324         srand(tv.tv_sec ^ tv.tv_usec);
 325     }
 326     return rand();
 327 }
 328
 329 static void *
 330 alloc_openflow_buffer(size_t openflow_len, uint8_t type,
 331                       struct buffer **bufferp)
 332 {
 333         struct buffer *buffer;
 334         struct ofp_header *oh;
 335
 336         buffer = *bufferp = buffer_new(openflow_len);
 337         oh = buffer_put_uninit(buffer, openflow_len);
 338     memset(oh, 0, openflow_len);
 339         oh->version = OFP_VERSION;
 340         oh->type = type;
 341         oh->length = 0;
 342         oh->xid = random_xid();
 343         return oh;
 344 }
 345
 346 static void
 347 send_openflow_buffer(struct vconn *vconn, struct buffer *buffer)
 348 {
 349     struct ofp_header *oh;
 350
 351     oh = buffer_at_assert(buffer, 0, sizeof *oh);
 352     oh->length = htons(buffer->size);
 353
 354     run(vconn_send_block(vconn, buffer), "failed to send packet to switch");
 355 }
 356
 357 static struct buffer *
 358 transact_openflow(struct vconn *vconn, struct buffer *request)
 359 {
 360     uint32_t send_xid = ((struct ofp_header *) request->data)->xid;
 361
 362     send_openflow_buffer(vconn, request);
 363     for (;;) {
 364         uint32_t recv_xid;
 365         struct buffer *reply;
 366
 367         run(vconn_recv_block(vconn, &reply), "OpenFlow packet receive failed");
 368         recv_xid = ((struct ofp_header *) reply->data)->xid;
 369         if (send_xid == recv_xid) {
 370             return reply;
 371         }
 372
 373         VLOG_DBG("received reply with xid %08"PRIx32" != expected %08"PRIx32,
 374                  recv_xid, send_xid);
 375         buffer_delete(reply);
 376     }
 377 }
 378
 379 static void
 380 dump_transaction(const char *vconn_name, uint8_t request_type)
 381 {
 382     struct vconn *vconn;
 383     struct buffer *request, *reply;
 384
 385     run(vconn_open_block(vconn_name, &vconn), "connecting to %s", vconn_name);
 386     alloc_openflow_buffer(sizeof(struct ofp_header), request_type, &request);
 387     reply = transact_openflow(vconn, request);
 388     ofp_print(stdout, reply->data, reply->size, 1);
 389     vconn_close(vconn);
 390 }
 391
 392 static void
 393 do_show(int argc UNUSED, char *argv[])
 394 {
 395     dump_transaction(argv[1], OFPT_FEATURES_REQUEST);
 396 }
 397
 398
 399 static void
 400 do_dump_tables(int argc, char *argv[])
 401 {
 402     dump_transaction(argv[1], OFPT_TABLE_STATS_REQUEST);
 403 }
 404
 405
 406 static uint32_t
 407 str_to_int(const char *str)
 408 {
 409     uint32_t value;
 410     if (sscanf(str, "%"SCNu32, &value) != 1) {
 411         fatal(0, "invalid numeric format %s", str);
 412     }
 413     return value;
 414 }
 415
 416 static void
 417 str_to_mac(const char *str, uint8_t mac[6])
 418 {
 419     if (sscanf(str, "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8,
 420                &mac[0], &mac[1], &mac[2], &mac[3], &mac[4], &mac[5]) != 6) {
 421         fatal(0, "invalid mac address %s", str);
 422     }
 423 }
 424
 425 static void
 426 str_to_ip(const char *str, uint32_t *ip)
 427 {
 428     struct in_addr in_addr;
 429     int retval;
 430
 431     retval = lookup_ip(str, &in_addr);
 432     if (retval) {
 433         fatal(0, "%s: could not convert to IP address", str);
 434     }
 435     *ip = in_addr.s_addr;
 436 }
 437
 438 static void
 439 str_to_action(const char *str, struct ofp_action *action)
 440 {
 441     uint16_t port;
 442
 443     if (!strcasecmp(str, "flood")) {
 444         port = OFPP_FLOOD;
 445     } else if (!strcasecmp(str, "controller")) {
 446         port = OFPP_CONTROLLER;
 447     } else {
 448         port = str_to_int(str);
 449     }
 450
 451     memset(action, 0, sizeof *action);
 452     action->type = OFPAT_OUTPUT;
 453     action->arg.output.port = htons(port);
 454 }
 455
 456 static void
 457 str_to_flow(char *string, struct ofp_match *match, struct ofp_action *action,
 458             uint8_t *table_idx, uint16_t *priority)
 459 {
 460     struct field {
 461         const char *name;
 462         uint32_t wildcard;
 463         enum { F_U8, F_U16, F_MAC, F_IP } type;
 464         size_t offset;
 465     };
 466
 467 #define F_OFS(MEMBER) offsetof(struct ofp_match, MEMBER)
 468     static const struct field fields[] = {
 469         { "in_port", OFPFW_IN_PORT, F_U16, F_OFS(in_port) },
 470         { "dl_vlan", OFPFW_DL_VLAN, F_U16, F_OFS(dl_vlan) },
 471         { "dl_src", OFPFW_DL_SRC, F_MAC, F_OFS(dl_src) },
 472         { "dl_dst", OFPFW_DL_DST, F_MAC, F_OFS(dl_dst) },
 473         { "dl_type", OFPFW_DL_TYPE, F_U16, F_OFS(dl_type) },
 474         { "nw_src", OFPFW_NW_SRC, F_IP, F_OFS(nw_src) },
 475         { "nw_dst", OFPFW_NW_DST, F_IP, F_OFS(nw_dst) },
 476         { "nw_proto", OFPFW_NW_PROTO, F_U8, F_OFS(nw_proto) },
 477         { "tp_src", OFPFW_TP_SRC, F_U16, F_OFS(tp_src) },
 478         { "tp_dst", OFPFW_TP_DST, F_U16, F_OFS(tp_dst) },
 479     };
 480
 481     char *name, *value;
 482     uint32_t wildcards;
 483     bool got_action = false;
 484
 485     if (table_idx) {
 486         *table_idx = 0xff;
 487     }
 488     memset(match, 0, sizeof *match);
 489     wildcards = OFPFW_ALL;
 490     for (name = strtok(string, "="), value = strtok(NULL, " \t\n");
 491          name && value;
 492          name = strtok(NULL, "="), value = strtok(NULL, " \t\n"))
 493     {
 494         const struct field *f;
 495         void *data;
 496
 497         if (action && !strcmp(name, "action")) {
 498             got_action = true;
 499             str_to_action(value, action);
 500             continue;
 501         }
 502
 503         if (table_idx && !strcmp(name, "table")) {
 504             *table_idx = atoi(value);
 505             continue;
 506         }
 507
 508         if (priority && !strcmp(name, "priority")) {
 509             *priority = atoi(value);
 510             continue;
 511         }
 512
 513         for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
 514             if (!strcmp(f->name, name)) {
 515                 goto found;
 516             }
 517         }
 518         fprintf(stderr, "%s: unknown field %s (fields are",
 519                 program_name, name);
 520         for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
 521             if (f != fields) {
 522                 putc(',', stderr);
 523             }
 524             fprintf(stderr, " %s", f->name);
 525         }
 526         fprintf(stderr, ")\n");
 527         exit(1);
 528
 529     found:
 530         data = (char *) match + f->offset;
 531         if (!strcmp(value, "*")) {
 532             wildcards |= f->wildcard;
 533         } else {
 534             wildcards &= ~f->wildcard;
 535             if (f->type == F_U8) {
 536                 *(uint8_t *) data = str_to_int(value);
 537             } else if (f->type == F_U16) {
 538                 *(uint16_t *) data = htons(str_to_int(value));
 539             } else if (f->type == F_MAC) {
 540                 str_to_mac(value, data);
 541             } else if (f->type == F_IP) {
 542                 str_to_ip(value, data);
 543             } else {
 544                 NOT_REACHED();
 545             }
 546         }
 547     }
 548     if (name && !value) {
 549         fatal(0, "field %s missing value", name);
 550     }
 551     if (action && !got_action) {
 552         fatal(0, "must specify an action");
 553     }
 554     match->wildcards = htons(wildcards);
 555 }
 556
 557 static void do_dump_flows(int argc, char *argv[])
 558 {
 559     struct vconn *vconn;
 560     struct buffer *request, *reply;
 561     struct ofp_flow_stats_request *fsr;
 562
 563     run(vconn_open_block(argv[1], &vconn), "connecting to %s", argv[1]);
 564     fsr = alloc_openflow_buffer(sizeof *fsr, OFPT_FLOW_STATS_REQUEST, &request);
 565     str_to_flow(argc > 2 ? argv[2] : "", &fsr->match, NULL, &fsr->table_id, NULL);
 566     fsr->type = OFPFS_INDIV;
 567     fsr->pad = 0;
 568     reply = transact_openflow(vconn, request);
 569     ofp_print(stdout, reply->data, reply->size, 1);
 570     vconn_close(vconn);
 571 }
 572
 573 static void do_add_flows(int argc, char *argv[])
 574 {
 575     struct vconn *vconn;
 576
 577     FILE *file;
 578     char line[1024];
 579
 580     file = fopen(argv[2], "r");
 581     if (file == NULL) {
 582         fatal(errno, "%s: open", argv[2]);
 583     }
 584
 585     run(vconn_open_block(argv[1], &vconn), "connecting to %s", argv[1]);
 586     while (fgets(line, sizeof line, file)) {
 587         struct buffer *buffer;
 588         struct ofp_flow_mod *ofm;
 589         uint16_t priority=0;
 590         size_t size;
 591
 592         char *comment;
 593
 594         /* Delete comments. */
 595         comment = strchr(line, '#');
 596         if (comment) {
 597             *comment = '\0';
 598         }
 599
 600         /* Drop empty lines. */
 601         if (line[strspn(line, " \t\n")] == '\0') {
 602             continue;
 603         }
 604
 605         /* Parse and send. */
 606         size = sizeof *ofm + sizeof ofm->actions[0];
 607         ofm = alloc_openflow_buffer(size, OFPT_FLOW_MOD, &buffer);
 608         ofm->command = htons(OFPFC_ADD);
 609         ofm->max_idle = htons(50);
 610         ofm->buffer_id = htonl(UINT32_MAX);
 611         ofm->group_id = htonl(0);
 612         str_to_flow(line, &ofm->match, &ofm->actions[0], NULL, &priority);
 613         ofm->priority = htons(priority);
 614
 615         send_openflow_buffer(vconn, buffer);
 616     }
 617     vconn_close(vconn);
 618     fclose(file);
 619 }
 620
 621 static void
 622 do_dump_ports(int argc, char *argv[])
 623 {
 624     dump_transaction(argv[1], OFPT_PORT_STATS_REQUEST);
 625 }
 626
 627 static void do_help(int argc UNUSED, char *argv[] UNUSED)
 628 {
 629     usage();
 630 }
 631
 632 static struct command all_commands[] = {
 633 #ifdef HAVE_NETLINK
 634     { "adddp", 1, 1, do_add_dp },
 635     { "deldp", 1, 1, do_del_dp },
 636     { "addif", 2, 2, do_add_port },
 637     { "delif", 2, 2, do_del_port },
 638     { "benchmark-nl", 3, 3, do_benchmark_nl },
 639 #endif
 640
 641     { "show", 1, 1, do_show },
 642
 643     { "help", 0, INT_MAX, do_help },
 644     { "monitor", 1, 1, do_monitor },
 645     { "dump-tables", 1, 1, do_dump_tables },
 646     { "dump-flows", 1, 2, do_dump_flows },
 647     { "add-flows", 2, 2, do_add_flows },
 648     { "dump-ports", 1, 1, do_dump_ports },
 649 };