utilities/ovs-openflowd.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #include <config.h>
  18 #include <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 "dummy.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 "stream-ssl.h"
  43 #include "timeval.h"
  44 #include "unixctl.h"
  45 #include "util.h"
  46 #include "vconn.h"
  47 #include "vlog.h"
  48
  49 VLOG_DEFINE_THIS_MODULE(openflowd);
  50
  51 /* Settings that may be configured by the user. */
  52 struct ofsettings {
  53     const char *unixctl_path;   /* File name for unixctl socket. */
  54
  55     /* Controller configuration. */
  56     struct ofproto_controller *controllers;
  57     size_t n_controllers;
  58     enum ofproto_fail_mode fail_mode;
  59     bool run_forever;           /* Continue running even with no controller? */
  60
  61     /* Datapath. */
  62     uint64_t datapath_id;       /* Datapath ID. */
  63     char *dp_name;              /* Name of local datapath. */
  64     char *dp_type;              /* Type of local datapath. */
  65     struct sset ports;          /* Set of ports to add to datapath (if any). */
  66
  67     /* Description strings. */
  68     const char *mfr_desc;       /* Manufacturer. */
  69     const char *hw_desc;        /* Hardware. */
  70     const char *sw_desc;        /* Software version. */
  71     const char *serial_desc;    /* Serial number. */
  72     const char *dp_desc;        /* Datapath description. */
  73
  74     /* Related vconns and network devices. */
  75     struct sset snoops;          /* Listen for controller snooping conns. */
  76
  77     /* Failure behavior. */
  78     int max_idle;             /* Idle time for flows in fail-open mode. */
  79
  80     /* NetFlow. */
  81     struct sset netflow;        /* NetFlow targets. */
  82 };
  83
  84 static unixctl_cb_func ovs_openflowd_exit;
  85
  86 static void parse_options(int argc, char *argv[], struct ofsettings *);
  87 static void usage(void) NO_RETURN;
  88
  89 int
  90 main(int argc, char *argv[])
  91 {
  92     struct unixctl_server *unixctl;
  93     struct ofproto *ofproto;
  94     struct ofsettings s;
  95     int error;
  96     struct dpif *dpif;
  97     struct netflow_options nf_options;
  98     const char *port;
  99     bool exiting;
 100
 101     proctitle_init(argc, argv);
 102     set_program_name(argv[0]);
 103     parse_options(argc, argv, &s);
 104     signal(SIGPIPE, SIG_IGN);
 105
 106     daemonize_start();
 107
 108     /* Start listening for ovs-appctl requests. */
 109     error = unixctl_server_create(s.unixctl_path, &unixctl);
 110     if (error) {
 111         exit(EXIT_FAILURE);
 112     }
 113
 114     unixctl_command_register("exit", ovs_openflowd_exit, &exiting);
 115
 116     VLOG_INFO("Open vSwitch version %s", VERSION BUILDNR);
 117     VLOG_INFO("OpenFlow protocol version 0x%02x", OFP_VERSION);
 118
 119     error = dpif_create_and_open(s.dp_name, s.dp_type, &dpif);
 120     if (error) {
 121         VLOG_FATAL("could not create datapath (%s)", strerror(error));
 122     }
 123
 124     /* Add ports to the datapath if requested by the user. */
 125     SSET_FOR_EACH (port, &s.ports) {
 126         struct netdev *netdev;
 127
 128         error = netdev_open_default(port, &netdev);
 129         if (error) {
 130             VLOG_FATAL("%s: failed to open network device (%s)",
 131                        port, strerror(error));
 132         }
 133
 134         error = dpif_port_add(dpif, netdev, NULL);
 135         if (error) {
 136             VLOG_FATAL("failed to add %s as a port (%s)",
 137                        port, strerror(error));
 138         }
 139
 140         netdev_close(netdev);
 141     }
 142
 143     /* Start OpenFlow processing. */
 144     error = ofproto_create(s.dp_name, s.dp_type, NULL, NULL, &ofproto);
 145     if (error) {
 146         VLOG_FATAL("could not initialize openflow switch (%s)",
 147                    strerror(error));
 148     }
 149     if (s.datapath_id) {
 150         ofproto_set_datapath_id(ofproto, s.datapath_id);
 151     }
 152     ofproto_set_desc(ofproto, s.mfr_desc, s.hw_desc, s.sw_desc,
 153                      s.serial_desc, s.dp_desc);
 154     error = ofproto_set_snoops(ofproto, &s.snoops);
 155     if (error) {
 156         VLOG_FATAL("failed to configure controller snooping connections (%s)",
 157                    strerror(error));
 158     }
 159     memset(&nf_options, 0, sizeof nf_options);
 160     nf_options.collectors = s.netflow;
 161     error = ofproto_set_netflow(ofproto, &nf_options);
 162     if (error) {
 163         VLOG_FATAL("failed to configure NetFlow collectors (%s)",
 164                    strerror(error));
 165     }
 166     ofproto_set_controllers(ofproto, s.controllers, s.n_controllers);
 167     ofproto_set_fail_mode(ofproto, s.fail_mode);
 168
 169     daemonize_complete();
 170
 171     exiting = false;
 172     while (!exiting && (s.run_forever || ofproto_is_alive(ofproto))) {
 173         error = ofproto_run(ofproto);
 174         if (error) {
 175             VLOG_FATAL("unrecoverable datapath error (%s)", strerror(error));
 176         }
 177         unixctl_server_run(unixctl);
 178         dp_run();
 179         netdev_run();
 180
 181         ofproto_wait(ofproto);
 182         unixctl_server_wait(unixctl);
 183         dp_wait();
 184         netdev_wait();
 185         if (exiting) {
 186             poll_immediate_wake();
 187         }
 188         poll_block();
 189     }
 190
 191     dpif_close(dpif);
 192
 193     return 0;
 194 }
 195
 196 static void
 197 ovs_openflowd_exit(struct unixctl_conn *conn, const char *args OVS_UNUSED,
 198                    void *exiting_)
 199 {
 200     bool *exiting = exiting_;
 201     *exiting = true;
 202     unixctl_command_reply(conn, 200, NULL);
 203 }
 204 \f
 205 /* User interface. */
 206
 207 /* Breaks 'ports' apart at commas and adds each resulting word to 'ports'. */
 208 static void
 209 parse_ports(const char *s_, struct sset *ports)
 210 {
 211     char *s = xstrdup(s_);
 212     char *save_ptr = NULL;
 213     char *token;
 214
 215     for (token = strtok_r(s, ",", &save_ptr); token != NULL;
 216          token = strtok_r(NULL, ",", &save_ptr)) {
 217         sset_add(ports, token);
 218     }
 219     free(s);
 220 }
 221
 222 static void
 223 parse_options(int argc, char *argv[], struct ofsettings *s)
 224 {
 225     enum {
 226         OPT_DATAPATH_ID = UCHAR_MAX + 1,
 227         OPT_MFR_DESC,
 228         OPT_HW_DESC,
 229         OPT_SW_DESC,
 230         OPT_SERIAL_DESC,
 231         OPT_DP_DESC,
 232         OPT_BR_NAME,
 233         OPT_FAIL_MODE,
 234         OPT_INACTIVITY_PROBE,
 235         OPT_MAX_IDLE,
 236         OPT_MAX_BACKOFF,
 237         OPT_SNOOP,
 238         OPT_RATE_LIMIT,
 239         OPT_BURST_LIMIT,
 240         OPT_BOOTSTRAP_CA_CERT,
 241         OPT_OUT_OF_BAND,
 242         OPT_IN_BAND,
 243         OPT_NETFLOW,
 244         OPT_PORTS,
 245         OPT_UNIXCTL,
 246         OPT_ENABLE_DUMMY,
 247         VLOG_OPTION_ENUMS,
 248         LEAK_CHECKER_OPTION_ENUMS,
 249         DAEMON_OPTION_ENUMS
 250     };
 251     static struct option long_options[] = {
 252         {"datapath-id", required_argument, 0, OPT_DATAPATH_ID},
 253         {"mfr-desc", required_argument, 0, OPT_MFR_DESC},
 254         {"hw-desc", required_argument, 0, OPT_HW_DESC},
 255         {"sw-desc", required_argument, 0, OPT_SW_DESC},
 256         {"serial-desc", required_argument, 0, OPT_SERIAL_DESC},
 257         {"dp-desc", required_argument, 0, OPT_DP_DESC},
 258         {"config",      required_argument, 0, 'F'},
 259         {"br-name",     required_argument, 0, OPT_BR_NAME},
 260         {"fail",        required_argument, 0, OPT_FAIL_MODE},
 261         {"inactivity-probe", required_argument, 0, OPT_INACTIVITY_PROBE},
 262         {"max-idle",    required_argument, 0, OPT_MAX_IDLE},
 263         {"max-backoff", required_argument, 0, OPT_MAX_BACKOFF},
 264         {"listen",      required_argument, 0, 'l'},
 265         {"snoop",      required_argument, 0, OPT_SNOOP},
 266         {"rate-limit",  optional_argument, 0, OPT_RATE_LIMIT},
 267         {"burst-limit", required_argument, 0, OPT_BURST_LIMIT},
 268         {"out-of-band", no_argument, 0, OPT_OUT_OF_BAND},
 269         {"in-band",     no_argument, 0, OPT_IN_BAND},
 270         {"netflow",     required_argument, 0, OPT_NETFLOW},
 271         {"ports",       required_argument, 0, OPT_PORTS},
 272         {"unixctl",     required_argument, 0, OPT_UNIXCTL},
 273         {"enable-dummy", no_argument, 0, OPT_ENABLE_DUMMY},
 274         {"verbose",     optional_argument, 0, 'v'},
 275         {"help",        no_argument, 0, 'h'},
 276         {"version",     no_argument, 0, 'V'},
 277         DAEMON_LONG_OPTIONS,
 278         VLOG_LONG_OPTIONS,
 279         LEAK_CHECKER_LONG_OPTIONS,
 280         STREAM_SSL_LONG_OPTIONS,
 281         {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT},
 282         {0, 0, 0, 0},
 283     };
 284     char *short_options = long_options_to_short_options(long_options);
 285     struct ofproto_controller controller_opts;
 286     struct sset controllers;
 287     const char *name;
 288     int i;
 289
 290     /* Set defaults that we can figure out before parsing options. */
 291     controller_opts.target = NULL;
 292     controller_opts.max_backoff = 8;
 293     controller_opts.probe_interval = 5;
 294     controller_opts.band = OFPROTO_IN_BAND;
 295     controller_opts.rate_limit = 0;
 296     controller_opts.burst_limit = 0;
 297     s->unixctl_path = NULL;
 298     s->fail_mode = OFPROTO_FAIL_STANDALONE;
 299     s->datapath_id = 0;
 300     s->mfr_desc = NULL;
 301     s->hw_desc = NULL;
 302     s->sw_desc = NULL;
 303     s->serial_desc = NULL;
 304     s->dp_desc = NULL;
 305     sset_init(&controllers);
 306     sset_init(&s->snoops);
 307     s->max_idle = 0;
 308     sset_init(&s->netflow);
 309     sset_init(&s->ports);
 310     for (;;) {
 311         int c;
 312
 313         c = getopt_long(argc, argv, short_options, long_options, NULL);
 314         if (c == -1) {
 315             break;
 316         }
 317
 318         switch (c) {
 319         case OPT_DATAPATH_ID:
 320             if (!dpid_from_string(optarg, &s->datapath_id)) {
 321                 VLOG_FATAL("argument to --datapath-id must be exactly 16 hex "
 322                            "digits and may not be all-zero");
 323             }
 324             break;
 325
 326         case OPT_MFR_DESC:
 327             s->mfr_desc = optarg;
 328             break;
 329
 330         case OPT_HW_DESC:
 331             s->hw_desc = optarg;
 332             break;
 333
 334         case OPT_SW_DESC:
 335             s->sw_desc = optarg;
 336             break;
 337
 338         case OPT_SERIAL_DESC:
 339             s->serial_desc = optarg;
 340             break;
 341
 342         case OPT_DP_DESC:
 343             s->dp_desc = optarg;
 344             break;
 345
 346         case OPT_FAIL_MODE:
 347             if (!strcmp(optarg, "open") || !strcmp(optarg, "standalone")) {
 348                 s->fail_mode = OFPROTO_FAIL_STANDALONE;
 349             } else if (!strcmp(optarg, "closed")
 350                        || !strcmp(optarg, "secure")) {
 351                 s->fail_mode = OFPROTO_FAIL_SECURE;
 352             } else {
 353                 VLOG_FATAL("--fail argument must be \"standalone\" "
 354                            "or \"secure\"");
 355             }
 356             break;
 357
 358         case OPT_INACTIVITY_PROBE:
 359             controller_opts.probe_interval = atoi(optarg);
 360             if (controller_opts.probe_interval < 5) {
 361                 VLOG_FATAL("--inactivity-probe argument must be at least 5");
 362             }
 363             break;
 364
 365         case OPT_MAX_IDLE:
 366             if (!strcmp(optarg, "permanent")) {
 367                 s->max_idle = OFP_FLOW_PERMANENT;
 368             } else {
 369                 s->max_idle = atoi(optarg);
 370                 if (s->max_idle < 1 || s->max_idle > 65535) {
 371                     VLOG_FATAL("--max-idle argument must be between 1 and "
 372                                "65535 or the word 'permanent'");
 373                 }
 374             }
 375             break;
 376
 377         case OPT_MAX_BACKOFF:
 378             controller_opts.max_backoff = atoi(optarg);
 379             if (controller_opts.max_backoff < 1) {
 380                 VLOG_FATAL("--max-backoff argument must be at least 1");
 381             } else if (controller_opts.max_backoff > 3600) {
 382                 controller_opts.max_backoff = 3600;
 383             }
 384             break;
 385
 386         case OPT_RATE_LIMIT:
 387             if (optarg) {
 388                 controller_opts.rate_limit = atoi(optarg);
 389                 if (controller_opts.rate_limit < 1) {
 390                     VLOG_FATAL("--rate-limit argument must be at least 1");
 391                 }
 392             } else {
 393                 controller_opts.rate_limit = 1000;
 394             }
 395             break;
 396
 397         case OPT_BURST_LIMIT:
 398             controller_opts.burst_limit = atoi(optarg);
 399             if (controller_opts.burst_limit < 1) {
 400                 VLOG_FATAL("--burst-limit argument must be at least 1");
 401             }
 402             break;
 403
 404         case OPT_OUT_OF_BAND:
 405             controller_opts.band = OFPROTO_OUT_OF_BAND;
 406             break;
 407
 408         case OPT_IN_BAND:
 409             controller_opts.band = OFPROTO_IN_BAND;
 410             break;
 411
 412         case OPT_NETFLOW:
 413             sset_add(&s->netflow, optarg);
 414             break;
 415
 416         case 'l':
 417             sset_add(&controllers, optarg);
 418             break;
 419
 420         case OPT_SNOOP:
 421             sset_add(&s->snoops, optarg);
 422             break;
 423
 424         case OPT_PORTS:
 425             parse_ports(optarg, &s->ports);
 426             break;
 427
 428         case OPT_UNIXCTL:
 429             s->unixctl_path = optarg;
 430             break;
 431
 432         case OPT_ENABLE_DUMMY:
 433             dummy_enable();
 434             break;
 435
 436         case 'h':
 437             usage();
 438
 439         case 'V':
 440             OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
 441             exit(EXIT_SUCCESS);
 442
 443         DAEMON_OPTION_HANDLERS
 444
 445         VLOG_OPTION_HANDLERS
 446
 447         LEAK_CHECKER_OPTION_HANDLERS
 448
 449         STREAM_SSL_OPTION_HANDLERS
 450
 451         case OPT_BOOTSTRAP_CA_CERT:
 452             stream_ssl_set_ca_cert_file(optarg, true);
 453             break;
 454
 455         case '?':
 456             exit(EXIT_FAILURE);
 457
 458         default:
 459             abort();
 460         }
 461     }
 462     free(short_options);
 463
 464     argc -= optind;
 465     argv += optind;
 466     if (argc < 2) {
 467         VLOG_FATAL("need at least two non-option arguments; "
 468                    "use --help for usage");
 469     }
 470
 471     /* Rate limiting. */
 472     if (controller_opts.rate_limit && controller_opts.rate_limit < 100) {
 473         VLOG_WARN("Rate limit set to unusually low value %d",
 474                   controller_opts.rate_limit);
 475     }
 476
 477     /* Local vconns. */
 478     dp_parse_name(argv[0], &s->dp_name, &s->dp_type);
 479
 480     /* Figure out controller names. */
 481     s->run_forever = false;
 482     if (sset_is_empty(&controllers)) {
 483         sset_add_and_free(&controllers, xasprintf("punix:%s/%s.mgmt",
 484                                                   ovs_rundir(), s->dp_name));
 485     }
 486     for (i = 1; i < argc; i++) {
 487         if (!strcmp(argv[i], "none")) {
 488             s->run_forever = true;
 489         } else {
 490             sset_add(&controllers, argv[i]);
 491         }
 492     }
 493
 494     /* Set up controllers. */
 495     s->n_controllers = sset_count(&controllers);
 496     s->controllers = xmalloc(s->n_controllers * sizeof *s->controllers);
 497     i = 0;
 498     SSET_FOR_EACH (name, &controllers) {
 499         s->controllers[i] = controller_opts;
 500         s->controllers[i].target = xstrdup(name);
 501         i++;
 502     }
 503     sset_destroy(&controllers);
 504 }
 505
 506 static void
 507 usage(void)
 508 {
 509     printf("%s: an OpenFlow switch implementation.\n"
 510            "usage: %s [OPTIONS] [TYPE@]DATAPATH CONTROLLER...\n"
 511            "where DATAPATH is a local datapath (e.g. \"dp0\")\n"
 512            "optionally with an explicit TYPE (default: \"system\").\n"
 513            "Each CONTROLLER is an active OpenFlow connection method.\n",
 514            program_name, program_name);
 515     vconn_usage(true, true, true);
 516     printf("\nOpenFlow options:\n"
 517            "  -d, --datapath-id=ID    Use ID as the OpenFlow switch ID\n"
 518            "                          (ID must consist of 16 hex digits)\n"
 519            "  --mfr-desc=MFR          Identify manufacturer as MFR\n"
 520            "  --hw-desc=HW            Identify hardware as HW\n"
 521            "  --sw-desc=SW            Identify software as SW\n"
 522            "  --serial-desc=SERIAL    Identify serial number as SERIAL\n"
 523            "  --dp-desc=DP_DESC       Identify dp description as DP_DESC\n"
 524            "\nNetworking options:\n"
 525            "  --fail=open|closed      when controller connection fails:\n"
 526            "                            closed: drop all packets\n"
 527            "                            open (default): act as learning switch\n"
 528            "  --inactivity-probe=SECS time between inactivity probes\n"
 529            "  --max-idle=SECS         max idle for flows set up by switch\n"
 530            "  --max-backoff=SECS      max time between controller connection\n"
 531            "                          attempts (default: 8 seconds)\n"
 532            "  -l, --listen=METHOD     allow management connections on METHOD\n"
 533            "                          (a passive OpenFlow connection method)\n"
 534            "  --snoop=METHOD          allow controller snooping on METHOD\n"
 535            "                          (a passive OpenFlow connection method)\n"
 536            "  --out-of-band           controller connection is out-of-band\n"
 537            "  --netflow=HOST:PORT     configure NetFlow output target\n"
 538            "\nRate-limiting of \"packet-in\" messages to the controller:\n"
 539            "  --rate-limit[=PACKETS]  max rate, in packets/s (default: 1000)\n"
 540            "  --burst-limit=BURST     limit on packet credit for idle time\n");
 541     daemon_usage();
 542     vlog_usage();
 543     printf("\nOther options:\n"
 544            "  --unixctl=SOCKET        override default control socket name\n"
 545            "  -h, --help              display this help message\n"
 546            "  -V, --version           display version information\n");
 547     leak_checker_usage();
 548     exit(EXIT_SUCCESS);
 549 }