utilities/ovs-openflowd.c

   1 /*
   2  * Copyright (c) 2008, 2009 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 <assert.h>
  19 #include <errno.h>
  20 #include <getopt.h>
  21 #include <inttypes.h>
  22 #include <netinet/in.h>
  23 #include <stdlib.h>
  24 #include <signal.h>
  25 #include <string.h>
  26
  27 #include "command-line.h"
  28 #include "compiler.h"
  29 #include "daemon.h"
  30 #include "dirs.h"
  31 #include "dpif.h"
  32 #include "fault.h"
  33 #include "leak-checker.h"
  34 #include "list.h"
  35 #include "netdev.h"
  36 #include "ofpbuf.h"
  37 #include "ofproto/ofproto.h"
  38 #include "openflow/openflow.h"
  39 #include "packets.h"
  40 #include "poll-loop.h"
  41 #include "rconn.h"
  42 #include "svec.h"
  43 #include "timeval.h"
  44 #include "unixctl.h"
  45 #include "util.h"
  46 #include "vconn-ssl.h"
  47 #include "vconn.h"
  48
  49 #include "vlog.h"
  50 #define THIS_MODULE VLM_openflowd
  51
  52 /* Behavior when the connection to the controller fails. */
  53 enum fail_mode {
  54     FAIL_OPEN,                  /* Act as learning switch. */
  55     FAIL_CLOSED                 /* Drop all packets. */
  56 };
  57
  58 /* Settings that may be configured by the user. */
  59 struct ofsettings {
  60     /* Overall mode of operation. */
  61     bool discovery;           /* Discover the controller automatically? */
  62     bool in_band;             /* Connect to controller in-band? */
  63
  64     /* Datapath. */
  65     uint64_t datapath_id;       /* Datapath ID. */
  66     const char *dp_name;        /* Name of local datapath. */
  67     struct svec ports;          /* Set of ports to add to datapath (if any). */
  68
  69     /* Description strings. */
  70     const char *mfr_desc;       /* Manufacturer. */
  71     const char *hw_desc;        /* Hardware. */
  72     const char *sw_desc;        /* Software version. */
  73     const char *serial_desc;    /* Serial number. */
  74
  75     /* Related vconns and network devices. */
  76     const char *controller_name; /* Controller (if not discovery mode). */
  77     struct svec listeners;       /* Listen for management connections. */
  78     struct svec snoops;          /* Listen for controller snooping conns. */
  79
  80     /* Failure behavior. */
  81     enum fail_mode fail_mode; /* Act as learning switch if no controller? */
  82     int max_idle;             /* Idle time for flows in fail-open mode. */
  83     int probe_interval;       /* # seconds idle before sending echo request. */
  84     int max_backoff;          /* Max # seconds between connection attempts. */
  85
  86     /* Packet-in rate-limiting. */
  87     int rate_limit;           /* Tokens added to bucket per second. */
  88     int burst_limit;          /* Maximum number token bucket size. */
  89
  90     /* Discovery behavior. */
  91     const char *accept_controller_re; /* Controller vconns to accept. */
  92     bool update_resolv_conf;          /* Update /etc/resolv.conf? */
  93
  94     /* Spanning tree protocol. */
  95     bool enable_stp;
  96
  97     /* Remote command execution. */
  98     char *command_acl;          /* Command white/blacklist, as shell globs. */
  99     char *command_dir;          /* Directory that contains commands. */
 100
 101     /* Management. */
 102     uint64_t mgmt_id;           /* Management ID. */
 103
 104     /* NetFlow. */
 105     struct svec netflow;        /* NetFlow targets. */
 106 };
 107
 108 static void parse_options(int argc, char *argv[], struct ofsettings *);
 109 static void usage(void) NO_RETURN;
 110
 111 int
 112 main(int argc, char *argv[])
 113 {
 114     struct unixctl_server *unixctl;
 115     struct ofproto *ofproto;
 116     struct ofsettings s;
 117     int error;
 118     struct netflow_options nf_options;
 119
 120     set_program_name(argv[0]);
 121     register_fault_handlers();
 122     time_init();
 123     vlog_init();
 124     parse_options(argc, argv, &s);
 125     signal(SIGPIPE, SIG_IGN);
 126
 127     die_if_already_running();
 128     daemonize();
 129
 130     /* Start listening for ovs-appctl requests. */
 131     error = unixctl_server_create(NULL, &unixctl);
 132     if (error) {
 133         ovs_fatal(error, "Could not listen for unixctl connections");
 134     }
 135
 136     VLOG_INFO("Open vSwitch version %s", VERSION BUILDNR);
 137     VLOG_INFO("OpenFlow protocol version 0x%02x", OFP_VERSION);
 138
 139     /* Create the datapath and add ports to it, if requested by the user. */
 140     if (s.ports.n) {
 141         struct dpif *dpif;
 142         const char *port;
 143         size_t i;
 144
 145         error = dpif_create_and_open(s.dp_name, &dpif);
 146         if (error) {
 147             ovs_fatal(error, "could not create datapath");
 148         }
 149
 150         SVEC_FOR_EACH (i, port, &s.ports) {
 151             error = dpif_port_add(dpif, port, 0, NULL);
 152             if (error) {
 153                 ovs_fatal(error, "failed to add %s as a port", port);
 154             }
 155         }
 156         dpif_close(dpif);
 157     }
 158
 159     /* Start OpenFlow processing. */
 160     error = ofproto_create(s.dp_name, NULL, NULL, &ofproto);
 161     if (error) {
 162         ovs_fatal(error, "could not initialize openflow switch");
 163     }
 164     error = ofproto_set_in_band(ofproto, s.in_band);
 165     if (error) {
 166         ovs_fatal(error, "failed to configure in-band control");
 167     }
 168     error = ofproto_set_discovery(ofproto, s.discovery, s.accept_controller_re,
 169                                   s.update_resolv_conf);
 170     if (error) {
 171         ovs_fatal(error, "failed to configure controller discovery");
 172     }
 173     if (s.datapath_id) {
 174         ofproto_set_datapath_id(ofproto, s.datapath_id);
 175     }
 176     if (s.mgmt_id) {
 177         ofproto_set_mgmt_id(ofproto, s.mgmt_id);
 178     }
 179     ofproto_set_desc(ofproto, s.mfr_desc, s.hw_desc, s.sw_desc, s.serial_desc);
 180     if (!s.listeners.n) {
 181         svec_add_nocopy(&s.listeners, xasprintf("punix:%s/%s.mgmt",
 182                                               ovs_rundir, s.dp_name));
 183     } else if (s.listeners.n == 1 && !strcmp(s.listeners.names[0], "none")) {
 184         svec_clear(&s.listeners);
 185     }
 186     error = ofproto_set_listeners(ofproto, &s.listeners);
 187     if (error) {
 188         ovs_fatal(error, "failed to configure management connections");
 189     }
 190     error = ofproto_set_snoops(ofproto, &s.snoops);
 191     if (error) {
 192         ovs_fatal(error,
 193                   "failed to configure controller snooping connections");
 194     }
 195     memset(&nf_options, 0, sizeof nf_options);
 196     nf_options.collectors = s.netflow;
 197     error = ofproto_set_netflow(ofproto, &nf_options);
 198     if (error) {
 199         ovs_fatal(error, "failed to configure NetFlow collectors");
 200     }
 201     ofproto_set_failure(ofproto, s.fail_mode == FAIL_OPEN);
 202     ofproto_set_probe_interval(ofproto, s.probe_interval);
 203     ofproto_set_max_backoff(ofproto, s.max_backoff);
 204     ofproto_set_rate_limit(ofproto, s.rate_limit, s.burst_limit);
 205     error = ofproto_set_stp(ofproto, s.enable_stp);
 206     if (error) {
 207         ovs_fatal(error, "failed to configure STP");
 208     }
 209     error = ofproto_set_remote_execution(ofproto, s.command_acl,
 210                                          s.command_dir);
 211     if (error) {
 212         ovs_fatal(error, "failed to configure remote command execution");
 213     }
 214     if (!s.discovery) {
 215         error = ofproto_set_controller(ofproto, s.controller_name);
 216         if (error) {
 217             ovs_fatal(error, "failed to configure controller");
 218         }
 219     }
 220
 221     while (ofproto_is_alive(ofproto)) {
 222         error = ofproto_run(ofproto);
 223         if (error) {
 224             ovs_fatal(error, "unrecoverable datapath error");
 225         }
 226         unixctl_server_run(unixctl);
 227         dp_run();
 228         netdev_run();
 229
 230         ofproto_wait(ofproto);
 231         unixctl_server_wait(unixctl);
 232         dp_wait();
 233         netdev_wait();
 234         poll_block();
 235     }
 236
 237     return 0;
 238 }
 239 \f
 240 /* User interface. */
 241
 242 static void
 243 parse_options(int argc, char *argv[], struct ofsettings *s)
 244 {
 245     enum {
 246         OPT_DATAPATH_ID = UCHAR_MAX + 1,
 247         OPT_MANUFACTURER,
 248         OPT_HARDWARE,
 249         OPT_SOFTWARE,
 250         OPT_SERIAL,
 251         OPT_ACCEPT_VCONN,
 252         OPT_NO_RESOLV_CONF,
 253         OPT_BR_NAME,
 254         OPT_FAIL_MODE,
 255         OPT_INACTIVITY_PROBE,
 256         OPT_MAX_IDLE,
 257         OPT_MAX_BACKOFF,
 258         OPT_SNOOP,
 259         OPT_RATE_LIMIT,
 260         OPT_BURST_LIMIT,
 261         OPT_BOOTSTRAP_CA_CERT,
 262         OPT_STP,
 263         OPT_NO_STP,
 264         OPT_OUT_OF_BAND,
 265         OPT_IN_BAND,
 266         OPT_COMMAND_ACL,
 267         OPT_COMMAND_DIR,
 268         OPT_NETFLOW,
 269         OPT_MGMT_ID,
 270         OPT_PORTS,
 271         VLOG_OPTION_ENUMS,
 272         LEAK_CHECKER_OPTION_ENUMS
 273     };
 274     static struct option long_options[] = {
 275         {"datapath-id", required_argument, 0, OPT_DATAPATH_ID},
 276         {"manufacturer", required_argument, 0, OPT_MANUFACTURER},
 277         {"hardware", required_argument, 0, OPT_HARDWARE},
 278         {"software", required_argument, 0, OPT_SOFTWARE},
 279         {"serial", required_argument, 0, OPT_SERIAL},
 280         {"accept-vconn", required_argument, 0, OPT_ACCEPT_VCONN},
 281         {"no-resolv-conf", no_argument, 0, OPT_NO_RESOLV_CONF},
 282         {"config",      required_argument, 0, 'F'},
 283         {"br-name",     required_argument, 0, OPT_BR_NAME},
 284         {"fail",        required_argument, 0, OPT_FAIL_MODE},
 285         {"inactivity-probe", required_argument, 0, OPT_INACTIVITY_PROBE},
 286         {"max-idle",    required_argument, 0, OPT_MAX_IDLE},
 287         {"max-backoff", required_argument, 0, OPT_MAX_BACKOFF},
 288         {"listen",      required_argument, 0, 'l'},
 289         {"snoop",      required_argument, 0, OPT_SNOOP},
 290         {"rate-limit",  optional_argument, 0, OPT_RATE_LIMIT},
 291         {"burst-limit", required_argument, 0, OPT_BURST_LIMIT},
 292         {"stp",         no_argument, 0, OPT_STP},
 293         {"no-stp",      no_argument, 0, OPT_NO_STP},
 294         {"out-of-band", no_argument, 0, OPT_OUT_OF_BAND},
 295         {"in-band",     no_argument, 0, OPT_IN_BAND},
 296         {"command-acl", required_argument, 0, OPT_COMMAND_ACL},
 297         {"command-dir", required_argument, 0, OPT_COMMAND_DIR},
 298         {"netflow",     required_argument, 0, OPT_NETFLOW},
 299         {"mgmt-id",     required_argument, 0, OPT_MGMT_ID},
 300         {"ports",       required_argument, 0, OPT_PORTS},
 301         {"verbose",     optional_argument, 0, 'v'},
 302         {"help",        no_argument, 0, 'h'},
 303         {"version",     no_argument, 0, 'V'},
 304         DAEMON_LONG_OPTIONS,
 305         VLOG_LONG_OPTIONS,
 306         LEAK_CHECKER_LONG_OPTIONS,
 307 #ifdef HAVE_OPENSSL
 308         VCONN_SSL_LONG_OPTIONS
 309         {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT},
 310 #endif
 311         {0, 0, 0, 0},
 312     };
 313     char *short_options = long_options_to_short_options(long_options);
 314
 315     /* Set defaults that we can figure out before parsing options. */
 316     s->datapath_id = 0;
 317     s->mfr_desc = NULL;
 318     s->hw_desc = NULL;
 319     s->sw_desc = NULL;
 320     s->serial_desc = NULL;
 321     svec_init(&s->listeners);
 322     svec_init(&s->snoops);
 323     s->fail_mode = FAIL_OPEN;
 324     s->max_idle = 0;
 325     s->probe_interval = 0;
 326     s->max_backoff = 8;
 327     s->update_resolv_conf = true;
 328     s->rate_limit = 0;
 329     s->burst_limit = 0;
 330     s->accept_controller_re = NULL;
 331     s->enable_stp = false;
 332     s->in_band = true;
 333     s->command_acl = "";
 334     s->command_dir = NULL;
 335     svec_init(&s->netflow);
 336     s->mgmt_id = 0;
 337     svec_init(&s->ports);
 338     for (;;) {
 339         int c;
 340
 341         c = getopt_long(argc, argv, short_options, long_options, NULL);
 342         if (c == -1) {
 343             break;
 344         }
 345
 346         switch (c) {
 347         case OPT_DATAPATH_ID:
 348             if (!dpid_from_string(optarg, &s->datapath_id)) {
 349                 ovs_fatal(0, "argument to --datapath-id must be "
 350                           "exactly 12 hex digits and may not be all-zero");
 351             }
 352             break;
 353
 354         case OPT_MANUFACTURER:
 355             s->mfr_desc = optarg;
 356             break;
 357
 358         case OPT_HARDWARE:
 359             s->hw_desc = optarg;
 360             break;
 361
 362         case OPT_SOFTWARE:
 363             s->sw_desc = optarg;
 364             break;
 365
 366         case OPT_SERIAL:
 367             s->serial_desc = optarg;
 368             break;
 369
 370         case OPT_ACCEPT_VCONN:
 371             s->accept_controller_re = optarg;
 372             break;
 373
 374         case OPT_NO_RESOLV_CONF:
 375             s->update_resolv_conf = false;
 376             break;
 377
 378         case OPT_FAIL_MODE:
 379             if (!strcmp(optarg, "open")) {
 380                 s->fail_mode = FAIL_OPEN;
 381             } else if (!strcmp(optarg, "closed")) {
 382                 s->fail_mode = FAIL_CLOSED;
 383             } else {
 384                 ovs_fatal(0, "--fail argument must be \"open\" or \"closed\"");
 385             }
 386             break;
 387
 388         case OPT_INACTIVITY_PROBE:
 389             s->probe_interval = atoi(optarg);
 390             if (s->probe_interval < 5) {
 391                 ovs_fatal(0, "--inactivity-probe argument must be at least 5");
 392             }
 393             break;
 394
 395         case OPT_MAX_IDLE:
 396             if (!strcmp(optarg, "permanent")) {
 397                 s->max_idle = OFP_FLOW_PERMANENT;
 398             } else {
 399                 s->max_idle = atoi(optarg);
 400                 if (s->max_idle < 1 || s->max_idle > 65535) {
 401                     ovs_fatal(0, "--max-idle argument must be between 1 and "
 402                               "65535 or the word 'permanent'");
 403                 }
 404             }
 405             break;
 406
 407         case OPT_MAX_BACKOFF:
 408             s->max_backoff = atoi(optarg);
 409             if (s->max_backoff < 1) {
 410                 ovs_fatal(0, "--max-backoff argument must be at least 1");
 411             } else if (s->max_backoff > 3600) {
 412                 s->max_backoff = 3600;
 413             }
 414             break;
 415
 416         case OPT_RATE_LIMIT:
 417             if (optarg) {
 418                 s->rate_limit = atoi(optarg);
 419                 if (s->rate_limit < 1) {
 420                     ovs_fatal(0, "--rate-limit argument must be at least 1");
 421                 }
 422             } else {
 423                 s->rate_limit = 1000;
 424             }
 425             break;
 426
 427         case OPT_BURST_LIMIT:
 428             s->burst_limit = atoi(optarg);
 429             if (s->burst_limit < 1) {
 430                 ovs_fatal(0, "--burst-limit argument must be at least 1");
 431             }
 432             break;
 433
 434         case OPT_STP:
 435             s->enable_stp = true;
 436             break;
 437
 438         case OPT_NO_STP:
 439             s->enable_stp = false;
 440             break;
 441
 442         case OPT_OUT_OF_BAND:
 443             s->in_band = false;
 444             break;
 445
 446         case OPT_IN_BAND:
 447             s->in_band = true;
 448             break;
 449
 450         case OPT_COMMAND_ACL:
 451             s->command_acl = (s->command_acl[0]
 452                               ? xasprintf("%s,%s", s->command_acl, optarg)
 453                               : optarg);
 454             break;
 455
 456         case OPT_COMMAND_DIR:
 457             s->command_dir = optarg;
 458             break;
 459
 460         case OPT_NETFLOW:
 461             svec_add(&s->netflow, optarg);
 462             break;
 463
 464         case OPT_MGMT_ID:
 465             if (strlen(optarg) != 12
 466                 || strspn(optarg, "0123456789abcdefABCDEF") != 12) {
 467                 ovs_fatal(0, "argument to --mgmt-id must be "
 468                           "exactly 12 hex digits");
 469             }
 470             s->mgmt_id = strtoll(optarg, NULL, 16);
 471             if (!s->mgmt_id) {
 472                 ovs_fatal(0, "argument to --mgmt-id must be nonzero");
 473             }
 474             break;
 475
 476         case 'l':
 477             svec_add(&s->listeners, optarg);
 478             break;
 479
 480         case OPT_SNOOP:
 481             svec_add(&s->snoops, optarg);
 482             break;
 483
 484         case OPT_PORTS:
 485             svec_split(&s->ports, optarg, ",");
 486             break;
 487
 488         case 'h':
 489             usage();
 490
 491         case 'V':
 492             OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
 493             exit(EXIT_SUCCESS);
 494
 495         DAEMON_OPTION_HANDLERS
 496
 497         VLOG_OPTION_HANDLERS
 498
 499         LEAK_CHECKER_OPTION_HANDLERS
 500
 501 #ifdef HAVE_OPENSSL
 502         VCONN_SSL_OPTION_HANDLERS
 503
 504         case OPT_BOOTSTRAP_CA_CERT:
 505             vconn_ssl_set_ca_cert_file(optarg, true);
 506             break;
 507 #endif
 508
 509         case '?':
 510             exit(EXIT_FAILURE);
 511
 512         default:
 513             abort();
 514         }
 515     }
 516     free(short_options);
 517
 518     argc -= optind;
 519     argv += optind;
 520     if (argc < 1 || argc > 2) {
 521         ovs_fatal(0, "need one or two non-option arguments; "
 522                   "use --help for usage");
 523     }
 524
 525     /* Local and remote vconns. */
 526     s->dp_name = argv[0];
 527     s->controller_name = argc > 1 ? xstrdup(argv[1]) : NULL;
 528
 529     /* Set accept_controller_regex. */
 530     if (!s->accept_controller_re) {
 531         s->accept_controller_re
 532             = vconn_ssl_is_configured() ? "^ssl:.*" : "^tcp:.*";
 533     }
 534
 535     /* Mode of operation. */
 536     s->discovery = s->controller_name == NULL;
 537     if (s->discovery && !s->in_band) {
 538         ovs_fatal(0, "Cannot perform discovery with out-of-band control");
 539     }
 540
 541     /* Rate limiting. */
 542     if (s->rate_limit && s->rate_limit < 100) {
 543         VLOG_WARN("Rate limit set to unusually low value %d", s->rate_limit);
 544     }
 545 }
 546
 547 static void
 548 usage(void)
 549 {
 550     printf("%s: an OpenFlow switch implementation.\n"
 551            "usage: %s [OPTIONS] DATAPATH [CONTROLLER]\n"
 552            "DATAPATH is a local datapath (e.g. \"dp0\").\n"
 553            "CONTROLLER is an active OpenFlow connection method; if it is\n"
 554            "omitted, then ovs-openflowd performs controller discovery.\n",
 555            program_name, program_name);
 556     vconn_usage(true, true, true);
 557     printf("\nOpenFlow options:\n"
 558            "  -d, --datapath-id=ID    Use ID as the OpenFlow switch ID\n"
 559            "                          (ID must consist of 12 hex digits)\n"
 560            "  --mgmt-id=ID            Use ID as the management ID\n"
 561            "                          (ID must consist of 12 hex digits)\n"
 562            "  --manufacturer=MFR      Identify manufacturer as MFR\n"
 563            "  --hardware=HW           Identify hardware as HW\n"
 564            "  --software=SW           Identify software as SW\n"
 565            "  --serial=SERIAL         Identify serial number as SERIAL\n"
 566            "\nController discovery options:\n"
 567            "  --accept-vconn=REGEX    accept matching discovered controllers\n"
 568            "  --no-resolv-conf        do not update /etc/resolv.conf\n"
 569            "\nNetworking options:\n"
 570            "  --fail=open|closed      when controller connection fails:\n"
 571            "                            closed: drop all packets\n"
 572            "                            open (default): act as learning switch\n"
 573            "  --inactivity-probe=SECS time between inactivity probes\n"
 574            "  --max-idle=SECS         max idle for flows set up by switch\n"
 575            "  --max-backoff=SECS      max time between controller connection\n"
 576            "                          attempts (default: 8 seconds)\n"
 577            "  -l, --listen=METHOD     allow management connections on METHOD\n"
 578            "                          (a passive OpenFlow connection method)\n"
 579            "  --snoop=METHOD          allow controller snooping on METHOD\n"
 580            "                          (a passive OpenFlow connection method)\n"
 581            "  --out-of-band           controller connection is out-of-band\n"
 582            "  --netflow=HOST:PORT     configure NetFlow output target\n"
 583            "\nRate-limiting of \"packet-in\" messages to the controller:\n"
 584            "  --rate-limit[=PACKETS]  max rate, in packets/s (default: 1000)\n"
 585            "  --burst-limit=BURST     limit on packet credit for idle time\n"
 586            "\nRemote command execution options:\n"
 587            "  --command-acl=[!]GLOB[,[!]GLOB...] set allowed/denied commands\n"
 588            "  --command-dir=DIR       set command dir (default: %s/commands)\n",
 589            ovs_pkgdatadir);
 590     daemon_usage();
 591     vlog_usage();
 592     printf("\nOther options:\n"
 593            "  -h, --help              display this help message\n"
 594            "  -V, --version           display version information\n");
 595     leak_checker_usage();
 596     exit(EXIT_SUCCESS);
 597 }