2 * Copyright (c) 2008, 2009, 2010, 2011 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"
33 #include "leak-checker.h"
37 #include "ofproto/ofproto.h"
38 #include "openflow/openflow.h"
40 #include "poll-loop.h"
42 #include "stream-ssl.h"
49 VLOG_DEFINE_THIS_MODULE(openflowd);
51 /* Settings that may be configured by the user. */
53 const char *unixctl_path; /* File name for unixctl socket. */
55 /* Controller configuration. */
56 struct ofproto_controller *controllers;
58 enum ofproto_fail_mode fail_mode;
59 bool run_forever; /* Continue running even with no controller? */
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). */
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. */
74 /* Related vconns and network devices. */
75 struct sset snoops; /* Listen for controller snooping conns. */
77 /* Failure behavior. */
78 int max_idle; /* Idle time for flows in fail-open mode. */
81 struct sset netflow; /* NetFlow targets. */
84 static unixctl_cb_func ovs_openflowd_exit;
86 static void parse_options(int argc, char *argv[], struct ofsettings *);
87 static void usage(void) NO_RETURN;
90 main(int argc, char *argv[])
92 struct unixctl_server *unixctl;
93 struct ofproto *ofproto;
97 struct netflow_options nf_options;
101 proctitle_init(argc, argv);
102 set_program_name(argv[0]);
103 parse_options(argc, argv, &s);
104 signal(SIGPIPE, SIG_IGN);
106 die_if_already_running();
109 /* Start listening for ovs-appctl requests. */
110 error = unixctl_server_create(s.unixctl_path, &unixctl);
115 unixctl_command_register("exit", ovs_openflowd_exit, &exiting);
117 VLOG_INFO("Open vSwitch version %s", VERSION BUILDNR);
118 VLOG_INFO("OpenFlow protocol version 0x%02x", OFP_VERSION);
120 error = dpif_create_and_open(s.dp_name, s.dp_type, &dpif);
122 ovs_fatal(error, "could not create datapath");
125 /* Add ports to the datapath if requested by the user. */
126 SSET_FOR_EACH (port, &s.ports) {
127 struct netdev *netdev;
129 error = netdev_open_default(port, &netdev);
131 ovs_fatal(error, "%s: failed to open network device", port);
134 error = dpif_port_add(dpif, netdev, NULL);
136 ovs_fatal(error, "failed to add %s as a port", port);
139 netdev_close(netdev);
142 /* Start OpenFlow processing. */
143 error = ofproto_create(s.dp_name, s.dp_type, NULL, NULL, &ofproto);
145 ovs_fatal(error, "could not initialize openflow switch");
148 ofproto_set_datapath_id(ofproto, s.datapath_id);
150 ofproto_set_desc(ofproto, s.mfr_desc, s.hw_desc, s.sw_desc,
151 s.serial_desc, s.dp_desc);
152 error = ofproto_set_snoops(ofproto, &s.snoops);
155 "failed to configure controller snooping connections");
157 memset(&nf_options, 0, sizeof nf_options);
158 nf_options.collectors = s.netflow;
159 error = ofproto_set_netflow(ofproto, &nf_options);
161 ovs_fatal(error, "failed to configure NetFlow collectors");
163 ofproto_set_controllers(ofproto, s.controllers, s.n_controllers);
164 ofproto_set_fail_mode(ofproto, s.fail_mode);
166 daemonize_complete();
169 while (!exiting && (s.run_forever || ofproto_is_alive(ofproto))) {
170 error = ofproto_run(ofproto);
172 ovs_fatal(error, "unrecoverable datapath error");
174 unixctl_server_run(unixctl);
178 ofproto_wait(ofproto);
179 unixctl_server_wait(unixctl);
183 poll_immediate_wake();
194 ovs_openflowd_exit(struct unixctl_conn *conn, const char *args OVS_UNUSED,
197 bool *exiting = exiting_;
199 unixctl_command_reply(conn, 200, NULL);
202 /* User interface. */
204 /* Breaks 'ports' apart at commas and adds each resulting word to 'ports'. */
206 parse_ports(const char *s_, struct sset *ports)
208 char *s = xstrdup(s_);
209 char *save_ptr = NULL;
212 for (token = strtok_r(s, ",", &save_ptr); token != NULL;
213 token = strtok_r(NULL, ",", &save_ptr)) {
214 sset_add(ports, token);
220 parse_options(int argc, char *argv[], struct ofsettings *s)
223 OPT_DATAPATH_ID = UCHAR_MAX + 1,
231 OPT_INACTIVITY_PROBE,
237 OPT_BOOTSTRAP_CA_CERT,
245 LEAK_CHECKER_OPTION_ENUMS,
248 static struct option long_options[] = {
249 {"datapath-id", required_argument, 0, OPT_DATAPATH_ID},
250 {"mfr-desc", required_argument, 0, OPT_MFR_DESC},
251 {"hw-desc", required_argument, 0, OPT_HW_DESC},
252 {"sw-desc", required_argument, 0, OPT_SW_DESC},
253 {"serial-desc", required_argument, 0, OPT_SERIAL_DESC},
254 {"dp-desc", required_argument, 0, OPT_DP_DESC},
255 {"config", required_argument, 0, 'F'},
256 {"br-name", required_argument, 0, OPT_BR_NAME},
257 {"fail", required_argument, 0, OPT_FAIL_MODE},
258 {"inactivity-probe", required_argument, 0, OPT_INACTIVITY_PROBE},
259 {"max-idle", required_argument, 0, OPT_MAX_IDLE},
260 {"max-backoff", required_argument, 0, OPT_MAX_BACKOFF},
261 {"listen", required_argument, 0, 'l'},
262 {"snoop", required_argument, 0, OPT_SNOOP},
263 {"rate-limit", optional_argument, 0, OPT_RATE_LIMIT},
264 {"burst-limit", required_argument, 0, OPT_BURST_LIMIT},
265 {"out-of-band", no_argument, 0, OPT_OUT_OF_BAND},
266 {"in-band", no_argument, 0, OPT_IN_BAND},
267 {"netflow", required_argument, 0, OPT_NETFLOW},
268 {"ports", required_argument, 0, OPT_PORTS},
269 {"unixctl", required_argument, 0, OPT_UNIXCTL},
270 {"enable-dummy", no_argument, 0, OPT_ENABLE_DUMMY},
271 {"verbose", optional_argument, 0, 'v'},
272 {"help", no_argument, 0, 'h'},
273 {"version", no_argument, 0, 'V'},
276 LEAK_CHECKER_LONG_OPTIONS,
278 STREAM_SSL_LONG_OPTIONS
279 {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT},
283 char *short_options = long_options_to_short_options(long_options);
284 struct ofproto_controller controller_opts;
285 struct sset controllers;
289 /* Set defaults that we can figure out before parsing options. */
290 controller_opts.target = NULL;
291 controller_opts.max_backoff = 8;
292 controller_opts.probe_interval = 5;
293 controller_opts.band = OFPROTO_IN_BAND;
294 controller_opts.rate_limit = 0;
295 controller_opts.burst_limit = 0;
296 s->unixctl_path = NULL;
297 s->fail_mode = OFPROTO_FAIL_STANDALONE;
302 s->serial_desc = NULL;
304 sset_init(&controllers);
305 sset_init(&s->snoops);
307 sset_init(&s->netflow);
308 sset_init(&s->ports);
312 c = getopt_long(argc, argv, short_options, long_options, NULL);
318 case OPT_DATAPATH_ID:
319 if (!dpid_from_string(optarg, &s->datapath_id)) {
320 ovs_fatal(0, "argument to --datapath-id must be "
321 "exactly 16 hex digits and may not be all-zero");
326 s->mfr_desc = optarg;
337 case OPT_SERIAL_DESC:
338 s->serial_desc = optarg;
346 if (!strcmp(optarg, "open") || !strcmp(optarg, "standalone")) {
347 s->fail_mode = OFPROTO_FAIL_STANDALONE;
348 } else if (!strcmp(optarg, "closed")
349 || !strcmp(optarg, "secure")) {
350 s->fail_mode = OFPROTO_FAIL_SECURE;
352 ovs_fatal(0, "--fail argument must be \"standalone\" "
357 case OPT_INACTIVITY_PROBE:
358 controller_opts.probe_interval = atoi(optarg);
359 if (controller_opts.probe_interval < 5) {
360 ovs_fatal(0, "--inactivity-probe argument must be at least 5");
365 if (!strcmp(optarg, "permanent")) {
366 s->max_idle = OFP_FLOW_PERMANENT;
368 s->max_idle = atoi(optarg);
369 if (s->max_idle < 1 || s->max_idle > 65535) {
370 ovs_fatal(0, "--max-idle argument must be between 1 and "
371 "65535 or the word 'permanent'");
376 case OPT_MAX_BACKOFF:
377 controller_opts.max_backoff = atoi(optarg);
378 if (controller_opts.max_backoff < 1) {
379 ovs_fatal(0, "--max-backoff argument must be at least 1");
380 } else if (controller_opts.max_backoff > 3600) {
381 controller_opts.max_backoff = 3600;
387 controller_opts.rate_limit = atoi(optarg);
388 if (controller_opts.rate_limit < 1) {
389 ovs_fatal(0, "--rate-limit argument must be at least 1");
392 controller_opts.rate_limit = 1000;
396 case OPT_BURST_LIMIT:
397 controller_opts.burst_limit = atoi(optarg);
398 if (controller_opts.burst_limit < 1) {
399 ovs_fatal(0, "--burst-limit argument must be at least 1");
403 case OPT_OUT_OF_BAND:
404 controller_opts.band = OFPROTO_OUT_OF_BAND;
408 controller_opts.band = OFPROTO_IN_BAND;
412 sset_add(&s->netflow, optarg);
416 sset_add(&controllers, optarg);
420 sset_add(&s->snoops, optarg);
424 parse_ports(optarg, &s->ports);
428 s->unixctl_path = optarg;
431 case OPT_ENABLE_DUMMY:
439 OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
442 DAEMON_OPTION_HANDLERS
446 LEAK_CHECKER_OPTION_HANDLERS
449 STREAM_SSL_OPTION_HANDLERS
451 case OPT_BOOTSTRAP_CA_CERT:
452 stream_ssl_set_ca_cert_file(optarg, true);
468 ovs_fatal(0, "need at least two non-option arguments; "
469 "use --help for usage");
473 if (controller_opts.rate_limit && controller_opts.rate_limit < 100) {
474 VLOG_WARN("Rate limit set to unusually low value %d",
475 controller_opts.rate_limit);
479 dp_parse_name(argv[0], &s->dp_name, &s->dp_type);
481 /* Figure out controller names. */
482 s->run_forever = false;
483 if (sset_is_empty(&controllers)) {
484 sset_add_and_free(&controllers, xasprintf("punix:%s/%s.mgmt",
485 ovs_rundir(), s->dp_name));
487 for (i = 1; i < argc; i++) {
488 if (!strcmp(argv[i], "none")) {
489 s->run_forever = true;
491 sset_add(&controllers, argv[i]);
495 /* Set up controllers. */
496 s->n_controllers = sset_count(&controllers);
497 s->controllers = xmalloc(s->n_controllers * sizeof *s->controllers);
499 SSET_FOR_EACH (name, &controllers) {
500 s->controllers[i] = controller_opts;
501 s->controllers[i].target = xstrdup(name);
504 sset_destroy(&controllers);
510 printf("%s: an OpenFlow switch implementation.\n"
511 "usage: %s [OPTIONS] [TYPE@]DATAPATH CONTROLLER...\n"
512 "where DATAPATH is a local datapath (e.g. \"dp0\")\n"
513 "optionally with an explicit TYPE (default: \"system\").\n"
514 "Each CONTROLLER is an active OpenFlow connection method.\n",
515 program_name, program_name);
516 vconn_usage(true, true, true);
517 printf("\nOpenFlow options:\n"
518 " -d, --datapath-id=ID Use ID as the OpenFlow switch ID\n"
519 " (ID must consist of 16 hex digits)\n"
520 " --mfr-desc=MFR Identify manufacturer as MFR\n"
521 " --hw-desc=HW Identify hardware as HW\n"
522 " --sw-desc=SW Identify software as SW\n"
523 " --serial-desc=SERIAL Identify serial number as SERIAL\n"
524 " --dp-desc=DP_DESC Identify dp description as DP_DESC\n"
525 "\nNetworking options:\n"
526 " --fail=open|closed when controller connection fails:\n"
527 " closed: drop all packets\n"
528 " open (default): act as learning switch\n"
529 " --inactivity-probe=SECS time between inactivity probes\n"
530 " --max-idle=SECS max idle for flows set up by switch\n"
531 " --max-backoff=SECS max time between controller connection\n"
532 " attempts (default: 8 seconds)\n"
533 " -l, --listen=METHOD allow management connections on METHOD\n"
534 " (a passive OpenFlow connection method)\n"
535 " --snoop=METHOD allow controller snooping on METHOD\n"
536 " (a passive OpenFlow connection method)\n"
537 " --out-of-band controller connection is out-of-band\n"
538 " --netflow=HOST:PORT configure NetFlow output target\n"
539 "\nRate-limiting of \"packet-in\" messages to the controller:\n"
540 " --rate-limit[=PACKETS] max rate, in packets/s (default: 1000)\n"
541 " --burst-limit=BURST limit on packet credit for idle time\n");
544 printf("\nOther options:\n"
545 " --unixctl=SOCKET override default control socket name\n"
546 " -h, --help display this help message\n"
547 " -V, --version display version information\n");
548 leak_checker_usage();