2 * Copyright (c) 2008, 2009, 2010 Nicira Networks.
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <netinet/in.h>
27 #include "command-line.h"
32 #include "leak-checker.h"
36 #include "ofproto/ofproto.h"
37 #include "openflow/openflow.h"
39 #include "poll-loop.h"
41 #include "stream-ssl.h"
49 VLOG_DEFINE_THIS_MODULE(openflowd)
51 /* Settings that may be configured by the user. */
53 /* Controller configuration. */
54 struct ofproto_controller *controllers;
56 enum ofproto_fail_mode fail_mode;
59 uint64_t datapath_id; /* Datapath ID. */
60 char *dp_name; /* Name of local datapath. */
61 char *dp_type; /* Type of local datapath. */
62 struct svec ports; /* Set of ports to add to datapath (if any). */
64 /* Description strings. */
65 const char *mfr_desc; /* Manufacturer. */
66 const char *hw_desc; /* Hardware. */
67 const char *sw_desc; /* Software version. */
68 const char *serial_desc; /* Serial number. */
69 const char *dp_desc; /* Datapath description. */
71 /* Related vconns and network devices. */
72 struct svec snoops; /* Listen for controller snooping conns. */
74 /* Failure behavior. */
75 int max_idle; /* Idle time for flows in fail-open mode. */
78 struct svec netflow; /* NetFlow targets. */
81 static void parse_options(int argc, char *argv[], struct ofsettings *);
82 static void usage(void) NO_RETURN;
85 main(int argc, char *argv[])
87 struct unixctl_server *unixctl;
88 struct ofproto *ofproto;
92 struct netflow_options nf_options;
94 proctitle_init(argc, argv);
95 set_program_name(argv[0]);
96 parse_options(argc, argv, &s);
97 signal(SIGPIPE, SIG_IGN);
99 die_if_already_running();
102 /* Start listening for ovs-appctl requests. */
103 error = unixctl_server_create(NULL, &unixctl);
108 VLOG_INFO("Open vSwitch version %s", VERSION BUILDNR);
109 VLOG_INFO("OpenFlow protocol version 0x%02x", OFP_VERSION);
111 error = dpif_create_and_open(s.dp_name, s.dp_type, &dpif);
113 ovs_fatal(error, "could not create datapath");
116 /* Add ports to the datapath if requested by the user. */
121 SVEC_FOR_EACH (i, port, &s.ports) {
122 error = dpif_port_add(dpif, port, 0, NULL);
124 ovs_fatal(error, "failed to add %s as a port", port);
129 /* Start OpenFlow processing. */
130 error = ofproto_create(s.dp_name, s.dp_type, NULL, NULL, &ofproto);
132 ovs_fatal(error, "could not initialize openflow switch");
135 ofproto_set_datapath_id(ofproto, s.datapath_id);
137 ofproto_set_desc(ofproto, s.mfr_desc, s.hw_desc, s.sw_desc,
138 s.serial_desc, s.dp_desc);
139 error = ofproto_set_snoops(ofproto, &s.snoops);
142 "failed to configure controller snooping connections");
144 memset(&nf_options, 0, sizeof nf_options);
145 nf_options.collectors = s.netflow;
146 error = ofproto_set_netflow(ofproto, &nf_options);
148 ovs_fatal(error, "failed to configure NetFlow collectors");
150 ofproto_set_controllers(ofproto, s.controllers, s.n_controllers);
151 ofproto_set_fail_mode(ofproto, s.fail_mode);
153 daemonize_complete();
156 /* Data thread started */
157 fprintf(stdout, "THREADED version running!\n");
161 /* The following loop polls on protocol messages
162 * and on messages related to topology changes */
163 while (ofproto_is_alive(ofproto)) {
164 error = ofproto_run(ofproto);
166 ovs_fatal(error, "unrecoverable datapath error");
168 unixctl_server_run(unixctl);
174 ofproto_wait(ofproto);
175 unixctl_server_wait(unixctl);
188 /* User interface. */
191 parse_options(int argc, char *argv[], struct ofsettings *s)
194 OPT_DATAPATH_ID = UCHAR_MAX + 1,
204 OPT_INACTIVITY_PROBE,
210 OPT_BOOTSTRAP_CA_CERT,
216 LEAK_CHECKER_OPTION_ENUMS
218 static struct option long_options[] = {
219 {"datapath-id", required_argument, 0, OPT_DATAPATH_ID},
220 {"mfr-desc", required_argument, 0, OPT_MFR_DESC},
221 {"hw-desc", required_argument, 0, OPT_HW_DESC},
222 {"sw-desc", required_argument, 0, OPT_SW_DESC},
223 {"serial-desc", required_argument, 0, OPT_SERIAL_DESC},
224 {"dp-desc", required_argument, 0, OPT_DP_DESC},
225 {"accept-vconn", required_argument, 0, OPT_ACCEPT_VCONN},
226 {"no-resolv-conf", no_argument, 0, OPT_NO_RESOLV_CONF},
227 {"config", required_argument, 0, 'F'},
228 {"br-name", required_argument, 0, OPT_BR_NAME},
229 {"fail", required_argument, 0, OPT_FAIL_MODE},
230 {"inactivity-probe", required_argument, 0, OPT_INACTIVITY_PROBE},
231 {"max-idle", required_argument, 0, OPT_MAX_IDLE},
232 {"max-backoff", required_argument, 0, OPT_MAX_BACKOFF},
233 {"listen", required_argument, 0, 'l'},
234 {"snoop", required_argument, 0, OPT_SNOOP},
235 {"rate-limit", optional_argument, 0, OPT_RATE_LIMIT},
236 {"burst-limit", required_argument, 0, OPT_BURST_LIMIT},
237 {"out-of-band", no_argument, 0, OPT_OUT_OF_BAND},
238 {"in-band", no_argument, 0, OPT_IN_BAND},
239 {"netflow", required_argument, 0, OPT_NETFLOW},
240 {"ports", required_argument, 0, OPT_PORTS},
241 {"verbose", optional_argument, 0, 'v'},
242 {"help", no_argument, 0, 'h'},
243 {"version", no_argument, 0, 'V'},
246 LEAK_CHECKER_LONG_OPTIONS,
248 STREAM_SSL_LONG_OPTIONS
249 {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT},
253 char *short_options = long_options_to_short_options(long_options);
254 struct ofproto_controller controller_opts;
255 struct svec controllers;
258 /* Set defaults that we can figure out before parsing options. */
259 controller_opts.target = NULL;
260 controller_opts.max_backoff = 8;
261 controller_opts.probe_interval = 5;
262 controller_opts.band = OFPROTO_IN_BAND;
263 controller_opts.accept_re = NULL;
264 controller_opts.update_resolv_conf = true;
265 controller_opts.rate_limit = 0;
266 controller_opts.burst_limit = 0;
267 s->fail_mode = OFPROTO_FAIL_STANDALONE;
272 s->serial_desc = NULL;
274 svec_init(&controllers);
275 svec_init(&s->snoops);
277 svec_init(&s->netflow);
278 svec_init(&s->ports);
282 c = getopt_long(argc, argv, short_options, long_options, NULL);
288 case OPT_DATAPATH_ID:
289 if (!dpid_from_string(optarg, &s->datapath_id)) {
290 ovs_fatal(0, "argument to --datapath-id must be "
291 "exactly 16 hex digits and may not be all-zero");
296 s->mfr_desc = optarg;
307 case OPT_SERIAL_DESC:
308 s->serial_desc = optarg;
315 case OPT_ACCEPT_VCONN:
316 controller_opts.accept_re = optarg;
319 case OPT_NO_RESOLV_CONF:
320 controller_opts.update_resolv_conf = false;
324 if (!strcmp(optarg, "open") || !strcmp(optarg, "standalone")) {
325 s->fail_mode = OFPROTO_FAIL_STANDALONE;
326 } else if (!strcmp(optarg, "closed")
327 || !strcmp(optarg, "secure")) {
328 s->fail_mode = OFPROTO_FAIL_SECURE;
330 ovs_fatal(0, "--fail argument must be \"standalone\" "
335 case OPT_INACTIVITY_PROBE:
336 controller_opts.probe_interval = atoi(optarg);
337 if (controller_opts.probe_interval < 5) {
338 ovs_fatal(0, "--inactivity-probe argument must be at least 5");
343 if (!strcmp(optarg, "permanent")) {
344 s->max_idle = OFP_FLOW_PERMANENT;
346 s->max_idle = atoi(optarg);
347 if (s->max_idle < 1 || s->max_idle > 65535) {
348 ovs_fatal(0, "--max-idle argument must be between 1 and "
349 "65535 or the word 'permanent'");
354 case OPT_MAX_BACKOFF:
355 controller_opts.max_backoff = atoi(optarg);
356 if (controller_opts.max_backoff < 1) {
357 ovs_fatal(0, "--max-backoff argument must be at least 1");
358 } else if (controller_opts.max_backoff > 3600) {
359 controller_opts.max_backoff = 3600;
365 controller_opts.rate_limit = atoi(optarg);
366 if (controller_opts.rate_limit < 1) {
367 ovs_fatal(0, "--rate-limit argument must be at least 1");
370 controller_opts.rate_limit = 1000;
374 case OPT_BURST_LIMIT:
375 controller_opts.burst_limit = atoi(optarg);
376 if (controller_opts.burst_limit < 1) {
377 ovs_fatal(0, "--burst-limit argument must be at least 1");
381 case OPT_OUT_OF_BAND:
382 controller_opts.band = OFPROTO_OUT_OF_BAND;
386 controller_opts.band = OFPROTO_IN_BAND;
390 svec_add(&s->netflow, optarg);
394 svec_add(&controllers, optarg);
398 svec_add(&s->snoops, optarg);
402 svec_split(&s->ports, optarg, ",");
409 OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
412 DAEMON_OPTION_HANDLERS
416 LEAK_CHECKER_OPTION_HANDLERS
419 STREAM_SSL_OPTION_HANDLERS
421 case OPT_BOOTSTRAP_CA_CERT:
422 stream_ssl_set_ca_cert_file(optarg, true);
438 ovs_fatal(0, "need at least one non-option arguments; "
439 "use --help for usage");
442 /* Set accept_controller_regex. */
443 if (!controller_opts.accept_re) {
444 controller_opts.accept_re
445 = stream_ssl_is_configured() ? "^ssl:.*" : "^tcp:.*";
449 if (controller_opts.rate_limit && controller_opts.rate_limit < 100) {
450 VLOG_WARN("Rate limit set to unusually low value %d",
451 controller_opts.rate_limit);
455 dp_parse_name(argv[0], &s->dp_name, &s->dp_type);
457 /* Figure out controller names. */
458 if (!controllers.n) {
459 svec_add_nocopy(&controllers,
460 xasprintf("punix:%s/%s.mgmt", ovs_rundir, s->dp_name));
462 for (i = 1; i < argc; i++) {
463 svec_add(&controllers, argv[i]);
466 svec_add(&controllers, "discover");
469 /* Set up controllers. */
470 s->n_controllers = controllers.n;
471 s->controllers = xmalloc(s->n_controllers * sizeof *s->controllers);
475 for (i = 0; i < s->n_controllers; i++) {
476 s->controllers[i] = controller_opts;
477 s->controllers[i].target = controllers.names[i];
482 if (controller_opts.band == OFPROTO_OUT_OF_BAND) {
485 for (i = 0; i < s->n_controllers; i++) {
486 if (!strcmp(s->controllers[i].target, "discover")) {
487 ovs_fatal(0, "Cannot perform discovery with out-of-band "
497 printf("%s: an OpenFlow switch implementation.\n"
498 "usage: %s [OPTIONS] DATAPATH [CONTROLLER...]\n"
499 "DATAPATH is a local datapath (e.g. \"dp0\").\n"
500 "Each CONTROLLER is an active OpenFlow connection method. If\n"
501 "none is given, ovs-openflowd performs controller discovery.\n",
502 program_name, program_name);
503 vconn_usage(true, true, true);
504 printf("\nOpenFlow options:\n"
505 " -d, --datapath-id=ID Use ID as the OpenFlow switch ID\n"
506 " (ID must consist of 16 hex digits)\n"
507 " --mfr-desc=MFR Identify manufacturer as MFR\n"
508 " --hw-desc=HW Identify hardware as HW\n"
509 " --sw-desc=SW Identify software as SW\n"
510 " --serial-desc=SERIAL Identify serial number as SERIAL\n"
511 " --dp-desc=DP_DESC Identify dp description as DP_DESC\n"
512 "\nController discovery options:\n"
513 " --accept-vconn=REGEX accept matching discovered controllers\n"
514 " --no-resolv-conf do not update /etc/resolv.conf\n"
515 "\nNetworking options:\n"
516 " --fail=open|closed when controller connection fails:\n"
517 " closed: drop all packets\n"
518 " open (default): act as learning switch\n"
519 " --inactivity-probe=SECS time between inactivity probes\n"
520 " --max-idle=SECS max idle for flows set up by switch\n"
521 " --max-backoff=SECS max time between controller connection\n"
522 " attempts (default: 8 seconds)\n"
523 " -l, --listen=METHOD allow management connections on METHOD\n"
524 " (a passive OpenFlow connection method)\n"
525 " --snoop=METHOD allow controller snooping on METHOD\n"
526 " (a passive OpenFlow connection method)\n"
527 " --out-of-band controller connection is out-of-band\n"
528 " --netflow=HOST:PORT configure NetFlow output target\n"
529 "\nRate-limiting of \"packet-in\" messages to the controller:\n"
530 " --rate-limit[=PACKETS] max rate, in packets/s (default: 1000)\n"
531 " --burst-limit=BURST limit on packet credit for idle time\n");
534 printf("\nOther options:\n"
535 " -h, --help display this help message\n"
536 " -V, --version display version information\n");
537 leak_checker_usage();