pintos-os.org Git - openvswitch/blob - 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 <stdlib.h>
  39 #include <string.h>
  40 #include <unistd.h>
  41 #include <sys/time.h>
  42
  43 #include "command-line.h"
  44 #include "compiler.h"
  45 #include "buffer.h"
  46 #include "dpif.h"
  47 #ifdef HAVE_NETLINK
  48 #include "netlink.h"
  49 #include "openflow-netlink.h"
  50 #endif
  51 #include "util.h"
  52 #include "socket-util.h"
  53 #include "openflow.h"
  54 #include "ofp-print.h"
  55 #include "vconn.h"
  56 #include "vconn-ssl.h"
  57
  58 #include "vlog.h"
  59 #define THIS_MODULE VLM_DPCTL
  60
  61 static const char* ifconfigbin = "/sbin/ifconfig";
  62
  63 struct command {
  64     const char *name;
  65     int min_args;
  66     int max_args;
  67     void (*handler)(int argc, char *argv[]);
  68 };
  69
  70 static struct command all_commands[];
  71
  72 static void usage(void) NO_RETURN;
  73 static void parse_options(int argc, char *argv[]);
  74
  75 int main(int argc, char *argv[])
  76 {
  77     struct command *p;
  78
  79     set_program_name(argv[0]);
  80     vlog_init();
  81     parse_options(argc, argv);
  82
  83     argc -= optind;
  84     argv += optind;
  85     if (argc < 1)
  86         fatal(0, "missing command name; use --help for help");
  87
  88     for (p = all_commands; p->name != NULL; p++) {
  89         if (!strcmp(p->name, argv[0])) {
  90             int n_arg = argc - 1;
  91             if (n_arg < p->min_args)
  92                 fatal(0, "'%s' command requires at least %d arguments",
  93                       p->name, p->min_args);
  94             else if (n_arg > p->max_args)
  95                 fatal(0, "'%s' command takes at most %d arguments",
  96                       p->name, p->max_args);
  97             else {
  98                 p->handler(argc, argv);
  99                 exit(0);
 100             }
 101         }
 102     }
 103     fatal(0, "unknown command '%s'; use --help for help", argv[0]);
 104
 105     return 0;
 106 }
 107
 108 static void
 109 parse_options(int argc, char *argv[])
 110 {
 111     static struct option long_options[] = {
 112         {"verbose", optional_argument, 0, 'v'},
 113         {"help", no_argument, 0, 'h'},
 114         {"version", no_argument, 0, 'V'},
 115 #ifdef HAVE_OPENSSL
 116         {"private-key", required_argument, 0, 'p'},
 117         {"certificate", required_argument, 0, 'c'},
 118         {"ca-cert",     required_argument, 0, 'C'},
 119 #endif
 120         {0, 0, 0, 0},
 121     };
 122     char *short_options = long_options_to_short_options(long_options);
 123
 124     for (;;) {
 125         int indexptr;
 126         int c;
 127
 128         c = getopt_long(argc, argv, short_options, long_options, &indexptr);
 129         if (c == -1) {
 130             break;
 131         }
 132
 133         switch (c) {
 134         case 'h':
 135             usage();
 136
 137         case 'V':
 138             printf("%s "VERSION" compiled "__DATE__" "__TIME__"\n", argv[0]);
 139             exit(EXIT_SUCCESS);
 140
 141         case 'v':
 142             vlog_set_verbosity(optarg);
 143             break;
 144
 145 #ifdef HAVE_OPENSSL
 146         case 'p':
 147             vconn_ssl_set_private_key_file(optarg);
 148             break;
 149
 150         case 'c':
 151             vconn_ssl_set_certificate_file(optarg);
 152             break;
 153
 154         case 'C':
 155             vconn_ssl_set_ca_cert_file(optarg);
 156             break;
 157 #endif
 158
 159         case '?':
 160             exit(EXIT_FAILURE);
 161
 162         default:
 163             abort();
 164         }
 165     }
 166     free(short_options);
 167 }
 168
 169 static void
 170 usage(void)
 171 {
 172     printf("%s: OpenFlow switch management utility\n"
 173            "usage: %s [OPTIONS] COMMAND [ARG...]\n"
 174 #ifdef HAVE_NETLINK
 175            "\nCommands that apply to local datapaths only:\n"
 176            "  adddp nl:DP_ID              add a new local datapath DP_ID\n"
 177            "  deldp nl:DP_ID              delete local datapath DP_ID\n"
 178            "  addif nl:DP_ID IFACE        add IFACE as a port on DP_ID\n"
 179            "  delif nl:DP_ID IFACE        delete IFACE as a port on DP_ID\n"
 180            "  benchmark-nl nl:DP_ID N SIZE   send N packets of SIZE bytes\n"
 181 #endif
 182            "\nCommands that apply to local datapaths and remote switches:\n"
 183            "  show METHOD                 show information about METHOD\n"
 184            "  monitor METHOD              print packets received on METHOD\n"
 185            "  dump-tables METHOD          print table stats for METHOD\n"
 186            "  dump-flows METHOD T_ID      print all flow entries in table T_ID of METHOD\n"
 187            "  dump-flows METHOD T_ID FLOW print matching FLOWs in table T_ID of METHOD\n"
 188            "  add-flows METHOD FILE       add flows from FILE to METHOD\n"
 189            "where each METHOD is an active OpenFlow connection method.\n",
 190            program_name, program_name);
 191     vconn_usage(true, false);
 192     printf("\nOptions:\n"
 193            "  -v, --verbose               set maximum verbosity level\n"
 194            "  -h, --help                  display this help message\n"
 195            "  -V, --version               display version information\n");
 196     exit(EXIT_SUCCESS);
 197 }
 198
 199 static void run(int retval, const char *name)
 200 {
 201     if (retval) {
 202         fatal(retval, "%s", name);
 203     }
 204 }
 205 \f
 206 #ifdef HAVE_NETLINK
 207 /* Netlink-only commands. */
 208
 209 static int  if_up(const char* intf)
 210 {
 211     char command[256];
 212     snprintf(command, sizeof command, "%s %s up &> /dev/null",
 213             ifconfigbin, intf);
 214     return system(command);
 215 }
 216
 217 static void open_nl_vconn(const char *name, bool subscribe, struct dpif *dpif)
 218 {
 219     if (strncmp(name, "nl:", 3)
 220         || strlen(name) < 4
 221         || name[strspn(name + 3, "0123456789") + 3]) {
 222         fatal(0, "%s: argument is not of the form \"nl:DP_ID\"", name);
 223     }
 224     run(dpif_open(atoi(name + 3), subscribe, dpif), "opening datapath");
 225 }
 226
 227 static void do_add_dp(int argc UNUSED, char *argv[])
 228 {
 229     struct dpif dp;
 230     open_nl_vconn(argv[1], false, &dp);
 231     run(dpif_add_dp(&dp), "add_dp");
 232     dpif_close(&dp);
 233 }
 234
 235 static void do_del_dp(int argc UNUSED, char *argv[])
 236 {
 237     struct dpif dp;
 238     open_nl_vconn(argv[1], false, &dp);
 239     run(dpif_del_dp(&dp), "del_dp");
 240     dpif_close(&dp);
 241 }
 242
 243 static void do_add_port(int argc UNUSED, char *argv[])
 244 {
 245     struct dpif dp;
 246     if_up(argv[2]);
 247     open_nl_vconn(argv[1], false, &dp);
 248     run(dpif_add_port(&dp, argv[2]), "add_port");
 249     dpif_close(&dp);
 250 }
 251
 252 static void do_del_port(int argc UNUSED, char *argv[])
 253 {
 254     struct dpif dp;
 255     open_nl_vconn(argv[1], false, &dp);
 256     run(dpif_del_port(&dp, argv[2]), "del_port");
 257     dpif_close(&dp);
 258 }
 259
 260 #define BENCHMARK_INCR   100
 261
 262 static void do_benchmark_nl(int argc UNUSED, char *argv[])
 263 {
 264     struct dpif dp;
 265     uint32_t num_packets, i, milestone;
 266     struct timeval start, end;
 267
 268     open_nl_vconn(argv[1], false, &dp);
 269     num_packets = atoi(argv[2]);
 270     milestone = BENCHMARK_INCR;
 271     run(dpif_benchmark_nl(&dp, num_packets, atoi(argv[3])), "benchmark_nl");
 272     if (gettimeofday(&start, NULL) == -1) {
 273         run(errno, "gettimeofday");
 274     }
 275     for (i = 0; i < num_packets;i++) {
 276         struct buffer *b;
 277         run(dpif_recv_openflow(&dp, &b, true), "dpif_recv_openflow");
 278         if (i == milestone) {
 279             gettimeofday(&end, NULL);
 280             printf("%u packets received in %f ms\n",
 281                    BENCHMARK_INCR,
 282                    (1000*(double)(end.tv_sec - start.tv_sec))
 283                    + (.001*(end.tv_usec - start.tv_usec)));
 284             milestone += BENCHMARK_INCR;
 285             start = end;
 286         }
 287         buffer_delete(b);
 288     }
 289     gettimeofday(&end, NULL);
 290     printf("%u packets received in %f ms\n",
 291            i - (milestone - BENCHMARK_INCR),
 292            (1000*(double)(end.tv_sec - start.tv_sec))
 293            + (.001*(end.tv_usec - start.tv_usec)));
 294
 295     dpif_close(&dp);
 296 }
 297 #endif /* HAVE_NETLINK */
 298 \f
 299 /* Generic commands. */
 300
 301 static void do_show(int argc UNUSED, char *argv[])
 302 {
 303 #if 0
 304     struct dpif dp;
 305     run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
 306     run(dpif_show(&dp), "show");
 307     dpif_close(&dp);
 308 #endif
 309 }
 310
 311 static void do_monitor(int argc UNUSED, char *argv[])
 312 {
 313     struct dpif dp;
 314     run(dpif_open(atoi(argv[1]), true, &dp), "dpif_open");
 315     for (;;) {
 316         struct buffer *b;
 317         run(dpif_recv_openflow(&dp, &b, true), "dpif_recv_openflow");
 318         ofp_print(stderr, b->data, b->size, 2);
 319         buffer_delete(b);
 320     }
 321 }
 322
 323 static void do_dump_tables(int argc, char *argv[])
 324 {
 325     struct dpif dp;
 326     run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
 327     run(dpif_dump_tables(&dp), "dump_tables");
 328     dpif_close(&dp);
 329 }
 330
 331
 332 static uint32_t
 333 str_to_int(const char *str)
 334 {
 335     uint32_t value;
 336     if (sscanf(str, "%"SCNu32, &value) != 1) {
 337         fatal(0, "invalid numeric format %s", str);
 338     }
 339     return value;
 340 }
 341
 342 static void
 343 str_to_mac(const char *str, uint8_t mac[6])
 344 {
 345     if (sscanf(str, "%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8":%"SCNx8,
 346                &mac[0], &mac[1], &mac[2], &mac[3], &mac[4], &mac[5]) != 6) {
 347         fatal(0, "invalid mac address %s", str);
 348     }
 349 }
 350
 351 static void
 352 str_to_ip(const char *str, uint32_t *ip)
 353 {
 354     struct in_addr in_addr;
 355     int retval;
 356
 357     retval = lookup_ip(str, &in_addr);
 358     if (retval) {
 359         fatal(0, "%s: could not convert to IP address", str);
 360     }
 361     *ip = in_addr.s_addr;
 362 }
 363
 364 static void
 365 str_to_action(const char *str, struct ofp_action *action)
 366 {
 367     uint16_t port;
 368
 369     if (!strcasecmp(str, "flood")) {
 370         port = OFPP_FLOOD;
 371     } else if (!strcasecmp(str, "controller")) {
 372         port = OFPP_CONTROLLER;
 373     } else {
 374         port = str_to_int(str);
 375     }
 376
 377     memset(action, 0, sizeof *action);
 378     action->type = OFPAT_OUTPUT;
 379     action->arg.output.port = htons(port);
 380 }
 381
 382 static void
 383 str_to_flow(char *string, struct ofp_match *match, struct ofp_action *action)
 384 {
 385     struct field {
 386         const char *name;
 387         uint32_t wildcard;
 388         enum { F_U8, F_U16, F_MAC, F_IP } type;
 389         size_t offset;
 390     };
 391
 392 #define F_OFS(MEMBER) offsetof(struct ofp_match, MEMBER)
 393     static const struct field fields[] = {
 394         { "in_port", OFPFW_IN_PORT, F_U16, F_OFS(in_port) },
 395         { "dl_vlan", OFPFW_DL_VLAN, F_U16, F_OFS(dl_vlan) },
 396         { "dl_src", OFPFW_DL_SRC, F_MAC, F_OFS(dl_src) },
 397         { "dl_dst", OFPFW_DL_DST, F_MAC, F_OFS(dl_dst) },
 398         { "dl_type", OFPFW_DL_TYPE, F_U16, F_OFS(dl_type) },
 399         { "nw_src", OFPFW_NW_SRC, F_IP, F_OFS(nw_src) },
 400         { "nw_dst", OFPFW_NW_DST, F_IP, F_OFS(nw_dst) },
 401         { "nw_proto", OFPFW_NW_PROTO, F_U8, F_OFS(nw_proto) },
 402         { "tp_src", OFPFW_TP_SRC, F_U16, F_OFS(tp_src) },
 403         { "tp_dst", OFPFW_TP_DST, F_U16, F_OFS(tp_dst) },
 404     };
 405
 406     char *name, *value;
 407     uint32_t wildcards;
 408     bool got_action = false;
 409
 410     memset(match, 0, sizeof *match);
 411     wildcards = OFPFW_ALL;
 412     for (name = strtok(string, "="), value = strtok(NULL, " \t\n");
 413          name && value;
 414          name = strtok(NULL, "="), value = strtok(NULL, " \t\n"))
 415     {
 416         const struct field *f;
 417         void *data;
 418
 419         if (action && !strcmp(name, "action")) {
 420             got_action = true;
 421             str_to_action(value, action);
 422             continue;
 423         }
 424
 425         for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
 426             if (!strcmp(f->name, name)) {
 427                 goto found;
 428             }
 429         }
 430         fprintf(stderr, "%s: unknown field %s (fields are",
 431                 program_name, name);
 432         for (f = fields; f < &fields[ARRAY_SIZE(fields)]; f++) {
 433             if (f != fields) {
 434                 putc(',', stderr);
 435             }
 436             fprintf(stderr, " %s", f->name);
 437         }
 438         fprintf(stderr, ")\n");
 439         exit(1);
 440
 441     found:
 442         data = (char *) match + f->offset;
 443         if (!strcmp(value, "*")) {
 444             wildcards |= f->wildcard;
 445         } else {
 446             wildcards &= ~f->wildcard;
 447             if (f->type == F_U8) {
 448                 *(uint8_t *) data = str_to_int(value);
 449             } else if (f->type == F_U16) {
 450                 *(uint16_t *) data = htons(str_to_int(value));
 451             } else if (f->type == F_MAC) {
 452                 str_to_mac(value, data);
 453             } else if (f->type == F_IP) {
 454                 str_to_ip(value, data);
 455             } else {
 456                 NOT_REACHED();
 457             }
 458         }
 459     }
 460     if (name && !value) {
 461         fatal(0, "field %s missing value", name);
 462     }
 463     if (action && !got_action) {
 464         fatal(0, "must specify an action");
 465     }
 466     match->wildcards = htons(wildcards);
 467 }
 468
 469 static void do_dump_flows(int argc, char *argv[])
 470 {
 471     struct dpif dp;
 472     struct ofp_match match, *matchp;
 473     run(dpif_open(atoi(argv[1]), false, &dp), "dpif_open");
 474     if (argc == 4) {
 475         str_to_flow(argv[3], &match, NULL);
 476         matchp = &match;
 477     } else {
 478         matchp = NULL;
 479     }
 480     run(dpif_dump_flows(&dp, atoi(argv[2]), matchp), "dump_flows");
 481     dpif_close(&dp);
 482 }
 483
 484 static void do_add_flows(int argc, char *argv[])
 485 {
 486     struct vconn *vconn;
 487     char vconn_name[16];
 488
 489     FILE *file;
 490     char line[1024];
 491
 492     int retval;
 493
 494     file = fopen(argv[2], "r");
 495     if (file == NULL) {
 496         fatal(errno, "%s: open", argv[2]);
 497     }
 498
 499     sprintf(vconn_name, "nl:%d", atoi(argv[1]));
 500     retval = vconn_open(vconn_name, &vconn);
 501     if (retval) {
 502         fatal(retval, "opening datapath");
 503     }
 504
 505     while (fgets(line, sizeof line, file)) {
 506         struct buffer *buffer;
 507         struct ofp_flow_mod *ofm;
 508         size_t size;
 509
 510         char *comment;
 511
 512         /* Delete comments. */
 513         comment = strchr(line, '#');
 514         if (comment) {
 515             *comment = '\0';
 516         }
 517
 518         /* Drop empty lines. */
 519         if (line[strspn(line, " \t\n")] == '\0') {
 520             continue;
 521         }
 522
 523         size = sizeof *ofm + sizeof ofm->actions[0];
 524         buffer = buffer_new(size);
 525         ofm = buffer_put_uninit(buffer, size);
 526
 527         /* Parse. */
 528         memset(ofm, 0, size);
 529         ofm->header.type = OFPT_FLOW_MOD;
 530         ofm->header.version = OFP_VERSION;
 531         ofm->header.length = htons(size);
 532         ofm->command = htons(OFPFC_ADD);
 533         ofm->max_idle = htons(50);
 534         ofm->buffer_id = htonl(UINT32_MAX);
 535         ofm->group_id = htonl(0);
 536         str_to_flow(line, &ofm->match, &ofm->actions[0]);
 537
 538         retval = vconn_send_block(vconn, buffer);
 539         if (retval) {
 540             fatal(retval, "sending to datapath");
 541         }
 542     }
 543     vconn_close(vconn);
 544     fclose(file);
 545 }
 546
 547 static void do_help(int argc UNUSED, char *argv[] UNUSED)
 548 {
 549     usage();
 550 }
 551
 552 static struct command all_commands[] = {
 553 #ifdef HAVE_NETLINK
 554     { "adddp", 1, 1, do_add_dp },
 555     { "deldp", 1, 1, do_del_dp },
 556     { "addif", 2, 2, do_add_port },
 557     { "delif", 2, 2, do_del_port },
 558     { "benchmark-nl", 3, 3, do_benchmark_nl },
 559 #endif
 560
 561     { "show", 1, 1, do_show },
 562
 563     { "help", 0, INT_MAX, do_help },
 564     { "monitor", 1, 1, do_monitor },
 565     { "dump-tables", 1, 1, do_dump_tables },
 566     { "dump-flows", 2, 3, do_dump_flows },
 567     { "add-flows", 2, 2, do_add_flows },
 568 };