2 * Copyright (c) 2008, 2009 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"
46 #include "vconn-ssl.h"
50 #define THIS_MODULE VLM_openflowd
52 /* Behavior when the connection to the controller fails. */
54 FAIL_OPEN, /* Act as learning switch. */
55 FAIL_CLOSED /* Drop all packets. */
58 /* Settings that may be configured by the user. */
60 /* Overall mode of operation. */
61 bool discovery; /* Discover the controller automatically? */
62 bool in_band; /* Connect to controller in-band? */
65 uint64_t datapath_id; /* Datapath ID. */
66 const char *dp_name; /* Name of local datapath. */
68 /* Description strings. */
69 const char *mfr_desc; /* Manufacturer. */
70 const char *hw_desc; /* Hardware. */
71 const char *sw_desc; /* Software version. */
72 const char *serial_desc; /* Serial number. */
74 /* Related vconns and network devices. */
75 const char *controller_name; /* Controller (if not discovery mode). */
76 struct svec listeners; /* Listen for management connections. */
77 struct svec snoops; /* Listen for controller snooping conns. */
79 /* Failure behavior. */
80 enum fail_mode fail_mode; /* Act as learning switch if no controller? */
81 int max_idle; /* Idle time for flows in fail-open mode. */
82 int probe_interval; /* # seconds idle before sending echo request. */
83 int max_backoff; /* Max # seconds between connection attempts. */
85 /* Packet-in rate-limiting. */
86 int rate_limit; /* Tokens added to bucket per second. */
87 int burst_limit; /* Maximum number token bucket size. */
89 /* Discovery behavior. */
90 const char *accept_controller_re; /* Controller vconns to accept. */
91 bool update_resolv_conf; /* Update /etc/resolv.conf? */
93 /* Spanning tree protocol. */
96 /* Remote command execution. */
97 char *command_acl; /* Command white/blacklist, as shell globs. */
98 char *command_dir; /* Directory that contains commands. */
101 uint64_t mgmt_id; /* Management ID. */
104 struct svec netflow; /* NetFlow targets. */
107 static void parse_options(int argc, char *argv[], struct ofsettings *);
108 static void usage(void) NO_RETURN;
111 main(int argc, char *argv[])
113 struct unixctl_server *unixctl;
114 struct ofproto *ofproto;
117 struct netflow_options nf_options;
119 set_program_name(argv[0]);
120 register_fault_handlers();
123 parse_options(argc, argv, &s);
124 signal(SIGPIPE, SIG_IGN);
126 die_if_already_running();
129 /* Start listening for ovs-appctl requests. */
130 error = unixctl_server_create(NULL, &unixctl);
132 ovs_fatal(error, "Could not listen for unixctl connections");
135 VLOG_INFO("Open vSwitch version %s", VERSION BUILDNR);
136 VLOG_INFO("OpenFlow protocol version 0x%02x", OFP_VERSION);
138 /* Start OpenFlow processing. */
139 error = ofproto_create(s.dp_name, NULL, NULL, &ofproto);
141 ovs_fatal(error, "could not initialize openflow switch");
143 error = ofproto_set_in_band(ofproto, s.in_band);
145 ovs_fatal(error, "failed to configure in-band control");
147 error = ofproto_set_discovery(ofproto, s.discovery, s.accept_controller_re,
148 s.update_resolv_conf);
150 ovs_fatal(error, "failed to configure controller discovery");
153 ofproto_set_datapath_id(ofproto, s.datapath_id);
156 ofproto_set_mgmt_id(ofproto, s.mgmt_id);
158 ofproto_set_desc(ofproto, s.mfr_desc, s.hw_desc, s.sw_desc, s.serial_desc);
159 if (!s.listeners.n) {
160 svec_add_nocopy(&s.listeners, xasprintf("punix:%s/%s.mgmt",
161 ovs_rundir, s.dp_name));
162 } else if (s.listeners.n == 1 && !strcmp(s.listeners.names[0], "none")) {
163 svec_clear(&s.listeners);
165 error = ofproto_set_listeners(ofproto, &s.listeners);
167 ovs_fatal(error, "failed to configure management connections");
169 error = ofproto_set_snoops(ofproto, &s.snoops);
172 "failed to configure controller snooping connections");
174 memset(&nf_options, 0, sizeof nf_options);
175 nf_options.collectors = s.netflow;
176 error = ofproto_set_netflow(ofproto, &nf_options);
178 ovs_fatal(error, "failed to configure NetFlow collectors");
180 ofproto_set_failure(ofproto, s.fail_mode == FAIL_OPEN);
181 ofproto_set_probe_interval(ofproto, s.probe_interval);
182 ofproto_set_max_backoff(ofproto, s.max_backoff);
183 ofproto_set_rate_limit(ofproto, s.rate_limit, s.burst_limit);
184 error = ofproto_set_stp(ofproto, s.enable_stp);
186 ovs_fatal(error, "failed to configure STP");
188 error = ofproto_set_remote_execution(ofproto, s.command_acl,
191 ovs_fatal(error, "failed to configure remote command execution");
194 error = ofproto_set_controller(ofproto, s.controller_name);
196 ovs_fatal(error, "failed to configure controller");
200 while (ofproto_is_alive(ofproto)) {
201 error = ofproto_run(ofproto);
203 ovs_fatal(error, "unrecoverable datapath error");
205 unixctl_server_run(unixctl);
209 ofproto_wait(ofproto);
210 unixctl_server_wait(unixctl);
219 /* User interface. */
222 parse_options(int argc, char *argv[], struct ofsettings *s)
225 OPT_DATAPATH_ID = UCHAR_MAX + 1,
234 OPT_INACTIVITY_PROBE,
240 OPT_BOOTSTRAP_CA_CERT,
250 LEAK_CHECKER_OPTION_ENUMS
252 static struct option long_options[] = {
253 {"datapath-id", required_argument, 0, OPT_DATAPATH_ID},
254 {"manufacturer", required_argument, 0, OPT_MANUFACTURER},
255 {"hardware", required_argument, 0, OPT_HARDWARE},
256 {"software", required_argument, 0, OPT_SOFTWARE},
257 {"serial", required_argument, 0, OPT_SERIAL},
258 {"accept-vconn", required_argument, 0, OPT_ACCEPT_VCONN},
259 {"no-resolv-conf", no_argument, 0, OPT_NO_RESOLV_CONF},
260 {"config", required_argument, 0, 'F'},
261 {"br-name", required_argument, 0, OPT_BR_NAME},
262 {"fail", required_argument, 0, OPT_FAIL_MODE},
263 {"inactivity-probe", required_argument, 0, OPT_INACTIVITY_PROBE},
264 {"max-idle", required_argument, 0, OPT_MAX_IDLE},
265 {"max-backoff", required_argument, 0, OPT_MAX_BACKOFF},
266 {"listen", required_argument, 0, 'l'},
267 {"snoop", required_argument, 0, OPT_SNOOP},
268 {"rate-limit", optional_argument, 0, OPT_RATE_LIMIT},
269 {"burst-limit", required_argument, 0, OPT_BURST_LIMIT},
270 {"stp", no_argument, 0, OPT_STP},
271 {"no-stp", no_argument, 0, OPT_NO_STP},
272 {"out-of-band", no_argument, 0, OPT_OUT_OF_BAND},
273 {"in-band", no_argument, 0, OPT_IN_BAND},
274 {"command-acl", required_argument, 0, OPT_COMMAND_ACL},
275 {"command-dir", required_argument, 0, OPT_COMMAND_DIR},
276 {"netflow", required_argument, 0, OPT_NETFLOW},
277 {"mgmt-id", required_argument, 0, OPT_MGMT_ID},
278 {"verbose", optional_argument, 0, 'v'},
279 {"help", no_argument, 0, 'h'},
280 {"version", no_argument, 0, 'V'},
283 LEAK_CHECKER_LONG_OPTIONS,
285 VCONN_SSL_LONG_OPTIONS
286 {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT},
290 char *short_options = long_options_to_short_options(long_options);
292 /* Set defaults that we can figure out before parsing options. */
297 s->serial_desc = NULL;
298 svec_init(&s->listeners);
299 svec_init(&s->snoops);
300 s->fail_mode = FAIL_OPEN;
302 s->probe_interval = 0;
304 s->update_resolv_conf = true;
307 s->accept_controller_re = NULL;
308 s->enable_stp = false;
311 s->command_dir = NULL;
312 svec_init(&s->netflow);
317 c = getopt_long(argc, argv, short_options, long_options, NULL);
323 case OPT_DATAPATH_ID:
324 if (strlen(optarg) != 12
325 || strspn(optarg, "0123456789abcdefABCDEF") != 12) {
326 ovs_fatal(0, "argument to --datapath-id must be "
327 "exactly 12 hex digits");
329 s->datapath_id = strtoll(optarg, NULL, 16);
330 if (!s->datapath_id) {
331 ovs_fatal(0, "argument to --datapath-id must be nonzero");
335 case OPT_MANUFACTURER:
336 s->mfr_desc = optarg;
348 s->serial_desc = optarg;
351 case OPT_ACCEPT_VCONN:
352 s->accept_controller_re = optarg;
355 case OPT_NO_RESOLV_CONF:
356 s->update_resolv_conf = false;
360 if (!strcmp(optarg, "open")) {
361 s->fail_mode = FAIL_OPEN;
362 } else if (!strcmp(optarg, "closed")) {
363 s->fail_mode = FAIL_CLOSED;
365 ovs_fatal(0, "--fail argument must be \"open\" or \"closed\"");
369 case OPT_INACTIVITY_PROBE:
370 s->probe_interval = atoi(optarg);
371 if (s->probe_interval < 5) {
372 ovs_fatal(0, "--inactivity-probe argument must be at least 5");
377 if (!strcmp(optarg, "permanent")) {
378 s->max_idle = OFP_FLOW_PERMANENT;
380 s->max_idle = atoi(optarg);
381 if (s->max_idle < 1 || s->max_idle > 65535) {
382 ovs_fatal(0, "--max-idle argument must be between 1 and "
383 "65535 or the word 'permanent'");
388 case OPT_MAX_BACKOFF:
389 s->max_backoff = atoi(optarg);
390 if (s->max_backoff < 1) {
391 ovs_fatal(0, "--max-backoff argument must be at least 1");
392 } else if (s->max_backoff > 3600) {
393 s->max_backoff = 3600;
399 s->rate_limit = atoi(optarg);
400 if (s->rate_limit < 1) {
401 ovs_fatal(0, "--rate-limit argument must be at least 1");
404 s->rate_limit = 1000;
408 case OPT_BURST_LIMIT:
409 s->burst_limit = atoi(optarg);
410 if (s->burst_limit < 1) {
411 ovs_fatal(0, "--burst-limit argument must be at least 1");
416 s->enable_stp = true;
420 s->enable_stp = false;
423 case OPT_OUT_OF_BAND:
431 case OPT_COMMAND_ACL:
432 s->command_acl = (s->command_acl[0]
433 ? xasprintf("%s,%s", s->command_acl, optarg)
437 case OPT_COMMAND_DIR:
438 s->command_dir = optarg;
442 svec_add(&s->netflow, optarg);
446 if (strlen(optarg) != 12
447 || strspn(optarg, "0123456789abcdefABCDEF") != 12) {
448 ovs_fatal(0, "argument to --mgmt-id must be "
449 "exactly 12 hex digits");
451 s->mgmt_id = strtoll(optarg, NULL, 16);
453 ovs_fatal(0, "argument to --mgmt-id must be nonzero");
458 svec_add(&s->listeners, optarg);
462 svec_add(&s->snoops, optarg);
469 OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
472 DAEMON_OPTION_HANDLERS
476 LEAK_CHECKER_OPTION_HANDLERS
479 VCONN_SSL_OPTION_HANDLERS
481 case OPT_BOOTSTRAP_CA_CERT:
482 vconn_ssl_set_ca_cert_file(optarg, true);
497 if (argc < 1 || argc > 2) {
498 ovs_fatal(0, "need one or two non-option arguments; "
499 "use --help for usage");
502 /* Local and remote vconns. */
503 s->dp_name = argv[0];
504 s->controller_name = argc > 1 ? xstrdup(argv[1]) : NULL;
506 /* Set accept_controller_regex. */
507 if (!s->accept_controller_re) {
508 s->accept_controller_re
509 = vconn_ssl_is_configured() ? "^ssl:.*" : "^tcp:.*";
512 /* Mode of operation. */
513 s->discovery = s->controller_name == NULL;
514 if (s->discovery && !s->in_band) {
515 ovs_fatal(0, "Cannot perform discovery with out-of-band control");
519 if (s->rate_limit && s->rate_limit < 100) {
520 VLOG_WARN("Rate limit set to unusually low value %d", s->rate_limit);
527 printf("%s: an OpenFlow switch implementation.\n"
528 "usage: %s [OPTIONS] DATAPATH [CONTROLLER]\n"
529 "DATAPATH is a local datapath (e.g. \"dp0\").\n"
530 "CONTROLLER is an active OpenFlow connection method; if it is\n"
531 "omitted, then ovs-openflowd performs controller discovery.\n",
532 program_name, program_name);
533 vconn_usage(true, true, true);
534 printf("\nOpenFlow options:\n"
535 " -d, --datapath-id=ID Use ID as the OpenFlow switch ID\n"
536 " (ID must consist of 12 hex digits)\n"
537 " --mgmt-id=ID Use ID as the management ID\n"
538 " (ID must consist of 12 hex digits)\n"
539 " --manufacturer=MFR Identify manufacturer as MFR\n"
540 " --hardware=HW Identify hardware as HW\n"
541 " --software=SW Identify software as SW\n"
542 " --serial=SERIAL Identify serial number as SERIAL\n"
543 "\nController discovery options:\n"
544 " --accept-vconn=REGEX accept matching discovered controllers\n"
545 " --no-resolv-conf do not update /etc/resolv.conf\n"
546 "\nNetworking options:\n"
547 " --fail=open|closed when controller connection fails:\n"
548 " closed: drop all packets\n"
549 " open (default): act as learning switch\n"
550 " --inactivity-probe=SECS time between inactivity probes\n"
551 " --max-idle=SECS max idle for flows set up by switch\n"
552 " --max-backoff=SECS max time between controller connection\n"
553 " attempts (default: 8 seconds)\n"
554 " -l, --listen=METHOD allow management connections on METHOD\n"
555 " (a passive OpenFlow connection method)\n"
556 " --snoop=METHOD allow controller snooping on METHOD\n"
557 " (a passive OpenFlow connection method)\n"
558 " --out-of-band controller connection is out-of-band\n"
559 " --netflow=HOST:PORT configure NetFlow output target\n"
560 "\nRate-limiting of \"packet-in\" messages to the controller:\n"
561 " --rate-limit[=PACKETS] max rate, in packets/s (default: 1000)\n"
562 " --burst-limit=BURST limit on packet credit for idle time\n"
563 "\nRemote command execution options:\n"
564 " --command-acl=[!]GLOB[,[!]GLOB...] set allowed/denied commands\n"
565 " --command-dir=DIR set command dir (default: %s/commands)\n",
569 printf("\nOther options:\n"
570 " -h, --help display this help message\n"
571 " -V, --version display version information\n");
572 leak_checker_usage();