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);
108 /* Start listening for ovs-appctl requests. */
109 error = unixctl_server_create(s.unixctl_path, &unixctl);
114 unixctl_command_register("exit", ovs_openflowd_exit, &exiting);
116 VLOG_INFO("Open vSwitch version %s", VERSION BUILDNR);
117 VLOG_INFO("OpenFlow protocol version 0x%02x", OFP_VERSION);
119 error = dpif_create_and_open(s.dp_name, s.dp_type, &dpif);
121 VLOG_FATAL("could not create datapath (%s)", strerror(error));
124 /* Add ports to the datapath if requested by the user. */
125 SSET_FOR_EACH (port, &s.ports) {
126 struct netdev *netdev;
128 error = netdev_open_default(port, &netdev);
130 VLOG_FATAL("%s: failed to open network device (%s)",
131 port, strerror(error));
134 error = dpif_port_add(dpif, netdev, NULL);
136 VLOG_FATAL("failed to add %s as a port (%s)",
137 port, strerror(error));
140 netdev_close(netdev);
143 /* Start OpenFlow processing. */
144 error = ofproto_create(s.dp_name, s.dp_type, NULL, NULL, &ofproto);
146 VLOG_FATAL("could not initialize openflow switch (%s)",
150 ofproto_set_datapath_id(ofproto, s.datapath_id);
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);
156 VLOG_FATAL("failed to configure controller snooping connections (%s)",
159 memset(&nf_options, 0, sizeof nf_options);
160 nf_options.collectors = s.netflow;
161 error = ofproto_set_netflow(ofproto, &nf_options);
163 VLOG_FATAL("failed to configure NetFlow collectors (%s)",
166 ofproto_set_controllers(ofproto, s.controllers, s.n_controllers);
167 ofproto_set_fail_mode(ofproto, s.fail_mode);
169 daemonize_complete();
172 while (!exiting && (s.run_forever || ofproto_is_alive(ofproto))) {
173 error = ofproto_run(ofproto);
175 VLOG_FATAL("unrecoverable datapath error (%s)", strerror(error));
177 unixctl_server_run(unixctl);
181 ofproto_wait(ofproto);
182 unixctl_server_wait(unixctl);
186 poll_immediate_wake();
197 ovs_openflowd_exit(struct unixctl_conn *conn, const char *args OVS_UNUSED,
200 bool *exiting = exiting_;
202 unixctl_command_reply(conn, 200, NULL);
205 /* User interface. */
207 /* Breaks 'ports' apart at commas and adds each resulting word to 'ports'. */
209 parse_ports(const char *s_, struct sset *ports)
211 char *s = xstrdup(s_);
212 char *save_ptr = NULL;
215 for (token = strtok_r(s, ",", &save_ptr); token != NULL;
216 token = strtok_r(NULL, ",", &save_ptr)) {
217 sset_add(ports, token);
223 parse_options(int argc, char *argv[], struct ofsettings *s)
226 OPT_DATAPATH_ID = UCHAR_MAX + 1,
234 OPT_INACTIVITY_PROBE,
240 OPT_BOOTSTRAP_CA_CERT,
248 LEAK_CHECKER_OPTION_ENUMS,
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'},
279 LEAK_CHECKER_LONG_OPTIONS,
281 STREAM_SSL_LONG_OPTIONS
282 {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT},
286 char *short_options = long_options_to_short_options(long_options);
287 struct ofproto_controller controller_opts;
288 struct sset controllers;
292 /* Set defaults that we can figure out before parsing options. */
293 controller_opts.target = NULL;
294 controller_opts.max_backoff = 8;
295 controller_opts.probe_interval = 5;
296 controller_opts.band = OFPROTO_IN_BAND;
297 controller_opts.rate_limit = 0;
298 controller_opts.burst_limit = 0;
299 s->unixctl_path = NULL;
300 s->fail_mode = OFPROTO_FAIL_STANDALONE;
305 s->serial_desc = NULL;
307 sset_init(&controllers);
308 sset_init(&s->snoops);
310 sset_init(&s->netflow);
311 sset_init(&s->ports);
315 c = getopt_long(argc, argv, short_options, long_options, NULL);
321 case OPT_DATAPATH_ID:
322 if (!dpid_from_string(optarg, &s->datapath_id)) {
323 VLOG_FATAL("argument to --datapath-id must be exactly 16 hex "
324 "digits and may not be all-zero");
329 s->mfr_desc = optarg;
340 case OPT_SERIAL_DESC:
341 s->serial_desc = optarg;
349 if (!strcmp(optarg, "open") || !strcmp(optarg, "standalone")) {
350 s->fail_mode = OFPROTO_FAIL_STANDALONE;
351 } else if (!strcmp(optarg, "closed")
352 || !strcmp(optarg, "secure")) {
353 s->fail_mode = OFPROTO_FAIL_SECURE;
355 VLOG_FATAL("--fail argument must be \"standalone\" "
360 case OPT_INACTIVITY_PROBE:
361 controller_opts.probe_interval = atoi(optarg);
362 if (controller_opts.probe_interval < 5) {
363 VLOG_FATAL("--inactivity-probe argument must be at least 5");
368 if (!strcmp(optarg, "permanent")) {
369 s->max_idle = OFP_FLOW_PERMANENT;
371 s->max_idle = atoi(optarg);
372 if (s->max_idle < 1 || s->max_idle > 65535) {
373 VLOG_FATAL("--max-idle argument must be between 1 and "
374 "65535 or the word 'permanent'");
379 case OPT_MAX_BACKOFF:
380 controller_opts.max_backoff = atoi(optarg);
381 if (controller_opts.max_backoff < 1) {
382 VLOG_FATAL("--max-backoff argument must be at least 1");
383 } else if (controller_opts.max_backoff > 3600) {
384 controller_opts.max_backoff = 3600;
390 controller_opts.rate_limit = atoi(optarg);
391 if (controller_opts.rate_limit < 1) {
392 VLOG_FATAL("--rate-limit argument must be at least 1");
395 controller_opts.rate_limit = 1000;
399 case OPT_BURST_LIMIT:
400 controller_opts.burst_limit = atoi(optarg);
401 if (controller_opts.burst_limit < 1) {
402 VLOG_FATAL("--burst-limit argument must be at least 1");
406 case OPT_OUT_OF_BAND:
407 controller_opts.band = OFPROTO_OUT_OF_BAND;
411 controller_opts.band = OFPROTO_IN_BAND;
415 sset_add(&s->netflow, optarg);
419 sset_add(&controllers, optarg);
423 sset_add(&s->snoops, optarg);
427 parse_ports(optarg, &s->ports);
431 s->unixctl_path = optarg;
434 case OPT_ENABLE_DUMMY:
442 OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
445 DAEMON_OPTION_HANDLERS
449 LEAK_CHECKER_OPTION_HANDLERS
452 STREAM_SSL_OPTION_HANDLERS
454 case OPT_BOOTSTRAP_CA_CERT:
455 stream_ssl_set_ca_cert_file(optarg, true);
471 VLOG_FATAL("need at least two non-option arguments; "
472 "use --help for usage");
476 if (controller_opts.rate_limit && controller_opts.rate_limit < 100) {
477 VLOG_WARN("Rate limit set to unusually low value %d",
478 controller_opts.rate_limit);
482 dp_parse_name(argv[0], &s->dp_name, &s->dp_type);
484 /* Figure out controller names. */
485 s->run_forever = false;
486 if (sset_is_empty(&controllers)) {
487 sset_add_and_free(&controllers, xasprintf("punix:%s/%s.mgmt",
488 ovs_rundir(), s->dp_name));
490 for (i = 1; i < argc; i++) {
491 if (!strcmp(argv[i], "none")) {
492 s->run_forever = true;
494 sset_add(&controllers, argv[i]);
498 /* Set up controllers. */
499 s->n_controllers = sset_count(&controllers);
500 s->controllers = xmalloc(s->n_controllers * sizeof *s->controllers);
502 SSET_FOR_EACH (name, &controllers) {
503 s->controllers[i] = controller_opts;
504 s->controllers[i].target = xstrdup(name);
507 sset_destroy(&controllers);
513 printf("%s: an OpenFlow switch implementation.\n"
514 "usage: %s [OPTIONS] [TYPE@]DATAPATH CONTROLLER...\n"
515 "where DATAPATH is a local datapath (e.g. \"dp0\")\n"
516 "optionally with an explicit TYPE (default: \"system\").\n"
517 "Each CONTROLLER is an active OpenFlow connection method.\n",
518 program_name, program_name);
519 vconn_usage(true, true, true);
520 printf("\nOpenFlow options:\n"
521 " -d, --datapath-id=ID Use ID as the OpenFlow switch ID\n"
522 " (ID must consist of 16 hex digits)\n"
523 " --mfr-desc=MFR Identify manufacturer as MFR\n"
524 " --hw-desc=HW Identify hardware as HW\n"
525 " --sw-desc=SW Identify software as SW\n"
526 " --serial-desc=SERIAL Identify serial number as SERIAL\n"
527 " --dp-desc=DP_DESC Identify dp description as DP_DESC\n"
528 "\nNetworking options:\n"
529 " --fail=open|closed when controller connection fails:\n"
530 " closed: drop all packets\n"
531 " open (default): act as learning switch\n"
532 " --inactivity-probe=SECS time between inactivity probes\n"
533 " --max-idle=SECS max idle for flows set up by switch\n"
534 " --max-backoff=SECS max time between controller connection\n"
535 " attempts (default: 8 seconds)\n"
536 " -l, --listen=METHOD allow management connections on METHOD\n"
537 " (a passive OpenFlow connection method)\n"
538 " --snoop=METHOD allow controller snooping on METHOD\n"
539 " (a passive OpenFlow connection method)\n"
540 " --out-of-band controller connection is out-of-band\n"
541 " --netflow=HOST:PORT configure NetFlow output target\n"
542 "\nRate-limiting of \"packet-in\" messages to the controller:\n"
543 " --rate-limit[=PACKETS] max rate, in packets/s (default: 1000)\n"
544 " --burst-limit=BURST limit on packet credit for idle time\n");
547 printf("\nOther options:\n"
548 " --unixctl=SOCKET override default control socket name\n"
549 " -h, --help display this help message\n"
550 " -V, --version display version information\n");
551 leak_checker_usage();