2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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.
27 #include "command-line.h"
30 #include "learning-switch.h"
31 #include "ofp-parse.h"
32 #include "ofp-version-opt.h"
34 #include "openflow/openflow.h"
35 #include "poll-loop.h"
38 #include "stream-ssl.h"
44 #include "socket-util.h"
47 VLOG_DEFINE_THIS_MODULE(controller);
49 #define MAX_SWITCHES 16
50 #define MAX_LISTENERS 16
53 struct lswitch *lswitch;
56 /* -H, --hub: Learn the ports on which MAC addresses appear? */
57 static bool learn_macs = true;
59 /* -n, --noflow: Set up flows? (If not, every packet is processed at the
61 static bool set_up_flows = true;
63 /* -N, --normal: Use "NORMAL" action instead of explicit port? */
64 static bool action_normal = false;
66 /* -w, --wildcard: 0 to disable wildcard flow entries, an OFPFW10_* bitmask to
67 * enable specific wildcards, or UINT32_MAX to use the default wildcards. */
68 static uint32_t wildcards = 0;
70 /* --max-idle: Maximum idle time, in seconds, before flows expire. */
71 static int max_idle = 60;
73 /* --mute: If true, accept connections from switches but do not reply to any
74 * of their messages (for debugging fail-open mode). */
75 static bool mute = false;
77 /* -q, --queue: default OpenFlow queue, none if UINT32_MAX. */
78 static uint32_t default_queue = UINT32_MAX;
80 /* -Q, --port-queue: map from port name to port number. */
81 static struct simap port_queues = SIMAP_INITIALIZER(&port_queues);
83 /* --with-flows: Flows to send to switch. */
84 static struct ofputil_flow_mod *default_flows;
85 static size_t n_default_flows;
86 static enum ofputil_protocol usable_protocols;
88 /* --unixctl: Name of unixctl socket, or null to use the default. */
89 static char *unixctl_path = NULL;
91 static void new_switch(struct switch_ *, struct vconn *);
92 static void parse_options(int argc, char *argv[]);
93 static void usage(void) NO_RETURN;
96 main(int argc, char *argv[])
98 struct unixctl_server *unixctl;
99 struct switch_ switches[MAX_SWITCHES];
100 struct pvconn *listeners[MAX_LISTENERS];
101 int n_switches, n_listeners;
105 proctitle_init(argc, argv);
106 set_program_name(argv[0]);
107 parse_options(argc, argv);
108 signal(SIGPIPE, SIG_IGN);
110 if (argc - optind < 1) {
111 ovs_fatal(0, "at least one vconn argument required; "
112 "use --help for usage");
115 n_switches = n_listeners = 0;
116 for (i = optind; i < argc; i++) {
117 const char *name = argv[i];
120 retval = vconn_open(name, get_allowed_ofp_versions(), DSCP_DEFAULT,
123 if (n_switches >= MAX_SWITCHES) {
124 ovs_fatal(0, "max %d switch connections", n_switches);
126 new_switch(&switches[n_switches++], vconn);
128 } else if (retval == EAFNOSUPPORT) {
129 struct pvconn *pvconn;
130 retval = pvconn_open(name, get_allowed_ofp_versions(),
131 DSCP_DEFAULT, &pvconn);
133 if (n_listeners >= MAX_LISTENERS) {
134 ovs_fatal(0, "max %d passive connections", n_listeners);
136 listeners[n_listeners++] = pvconn;
140 VLOG_ERR("%s: connect: %s", name, ovs_strerror(retval));
143 if (n_switches == 0 && n_listeners == 0) {
144 ovs_fatal(0, "no active or passive switch connections");
149 retval = unixctl_server_create(unixctl_path, &unixctl);
154 daemonize_complete();
156 while (n_switches > 0 || n_listeners > 0) {
157 /* Accept connections on listening vconns. */
158 for (i = 0; i < n_listeners && n_switches < MAX_SWITCHES; ) {
159 struct vconn *new_vconn;
161 retval = pvconn_accept(listeners[i], &new_vconn);
162 if (!retval || retval == EAGAIN) {
164 new_switch(&switches[n_switches++], new_vconn);
168 pvconn_close(listeners[i]);
169 listeners[i] = listeners[--n_listeners];
173 /* Do some switching work. . */
174 for (i = 0; i < n_switches; ) {
175 struct switch_ *this = &switches[i];
176 lswitch_run(this->lswitch);
177 if (lswitch_is_alive(this->lswitch)) {
180 lswitch_destroy(this->lswitch);
181 switches[i] = switches[--n_switches];
185 unixctl_server_run(unixctl);
187 /* Wait for something to happen. */
188 if (n_switches < MAX_SWITCHES) {
189 for (i = 0; i < n_listeners; i++) {
190 pvconn_wait(listeners[i]);
193 for (i = 0; i < n_switches; i++) {
194 struct switch_ *sw = &switches[i];
195 lswitch_wait(sw->lswitch);
197 unixctl_server_wait(unixctl);
205 new_switch(struct switch_ *sw, struct vconn *vconn)
207 struct lswitch_config cfg;
210 rconn = rconn_create(60, 0, DSCP_DEFAULT, get_allowed_ofp_versions());
211 rconn_connect_unreliably(rconn, vconn, NULL);
213 cfg.mode = (action_normal ? LSW_NORMAL
214 : learn_macs ? LSW_LEARN
216 cfg.wildcards = wildcards;
217 cfg.max_idle = set_up_flows ? max_idle : -1;
218 cfg.default_flows = default_flows;
219 cfg.n_default_flows = n_default_flows;
220 cfg.usable_protocols = usable_protocols;
221 cfg.default_queue = default_queue;
222 cfg.port_queues = &port_queues;
224 sw->lswitch = lswitch_create(rconn, &cfg);
228 add_port_queue(char *s)
230 char *save_ptr = NULL;
234 port_name = strtok_r(s, ":", &save_ptr);
235 queue_id = strtok_r(NULL, "", &save_ptr);
237 ovs_fatal(0, "argument to -Q or --port-queue should take the form "
238 "\"<port-name>:<queue-id>\"");
241 if (!simap_put(&port_queues, port_name, atoi(queue_id))) {
242 ovs_fatal(0, "<port-name> arguments for -Q or --port-queue must "
248 parse_options(int argc, char *argv[])
251 OPT_MAX_IDLE = UCHAR_MAX + 1,
258 OFP_VERSION_OPTION_ENUMS
260 static const struct option long_options[] = {
261 {"hub", no_argument, NULL, 'H'},
262 {"noflow", no_argument, NULL, 'n'},
263 {"normal", no_argument, NULL, 'N'},
264 {"wildcards", optional_argument, NULL, 'w'},
265 {"max-idle", required_argument, NULL, OPT_MAX_IDLE},
266 {"mute", no_argument, NULL, OPT_MUTE},
267 {"queue", required_argument, NULL, 'q'},
268 {"port-queue", required_argument, NULL, 'Q'},
269 {"with-flows", required_argument, NULL, OPT_WITH_FLOWS},
270 {"unixctl", required_argument, NULL, OPT_UNIXCTL},
271 {"help", no_argument, NULL, 'h'},
273 OFP_VERSION_LONG_OPTIONS,
275 STREAM_SSL_LONG_OPTIONS,
276 {"peer-ca-cert", required_argument, NULL, OPT_PEER_CA_CERT},
279 char *short_options = long_options_to_short_options(long_options);
286 c = getopt_long(argc, argv, short_options, long_options, &indexptr);
297 set_up_flows = false;
305 action_normal = true;
309 wildcards = optarg ? strtol(optarg, NULL, 16) : UINT32_MAX;
313 if (!strcmp(optarg, "permanent")) {
314 max_idle = OFP_FLOW_PERMANENT;
316 max_idle = atoi(optarg);
317 if (max_idle < 1 || max_idle > 65535) {
318 ovs_fatal(0, "--max-idle argument must be between 1 and "
319 "65535 or the word 'permanent'");
325 default_queue = atoi(optarg);
329 add_port_queue(optarg);
333 error = parse_ofp_flow_mod_file(optarg, OFPFC_ADD, &default_flows,
337 ovs_fatal(0, "%s", error);
342 unixctl_path = optarg;
349 OFP_VERSION_OPTION_HANDLERS
350 DAEMON_OPTION_HANDLERS
352 STREAM_SSL_OPTION_HANDLERS
354 case OPT_PEER_CA_CERT:
355 stream_ssl_set_peer_ca_cert_file(optarg);
367 if (!simap_is_empty(&port_queues) || default_queue != UINT32_MAX) {
369 ovs_error(0, "queue IDs are incompatible with -N or --normal; "
370 "not using OFPP_NORMAL");
371 action_normal = false;
375 ovs_error(0, "queue IDs are incompatible with -H or --hub; "
376 "not acting as hub");
385 printf("%s: OpenFlow controller\n"
386 "usage: %s [OPTIONS] METHOD\n"
387 "where METHOD is any OpenFlow connection method.\n",
388 program_name, program_name);
389 vconn_usage(true, true, false);
393 printf("\nOther options:\n"
394 " -H, --hub act as hub instead of learning switch\n"
395 " -n, --noflow pass traffic, but don't add flows\n"
396 " --max-idle=SECS max idle time for new flows\n"
397 " -N, --normal use OFPP_NORMAL action\n"
398 " -w, --wildcards[=MASK] wildcard (specified) bits in flows\n"
399 " -q, --queue=QUEUE-ID OpenFlow queue ID to use for output\n"
400 " -Q PORT-NAME:QUEUE-ID use QUEUE-ID for frames from PORT-NAME\n"
401 " --with-flows FILE use the flows from FILE\n"
402 " --unixctl=SOCKET override default control socket name\n"
403 " -h, --help display this help message\n"
404 " -V, --version display version information\n");