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;
87 /* --unixctl: Name of unixctl socket, or null to use the default. */
88 static char *unixctl_path = NULL;
90 static void new_switch(struct switch_ *, struct vconn *);
91 static void parse_options(int argc, char *argv[]);
92 static void usage(void) NO_RETURN;
95 main(int argc, char *argv[])
97 struct unixctl_server *unixctl;
98 struct switch_ switches[MAX_SWITCHES];
99 struct pvconn *listeners[MAX_LISTENERS];
100 int n_switches, n_listeners;
104 proctitle_init(argc, argv);
105 set_program_name(argv[0]);
106 parse_options(argc, argv);
107 signal(SIGPIPE, SIG_IGN);
109 if (argc - optind < 1) {
110 ovs_fatal(0, "at least one vconn argument required; "
111 "use --help for usage");
114 n_switches = n_listeners = 0;
115 for (i = optind; i < argc; i++) {
116 const char *name = argv[i];
119 retval = vconn_open(name, get_allowed_ofp_versions(), DSCP_DEFAULT,
122 if (n_switches >= MAX_SWITCHES) {
123 ovs_fatal(0, "max %d switch connections", n_switches);
125 new_switch(&switches[n_switches++], vconn);
127 } else if (retval == EAFNOSUPPORT) {
128 struct pvconn *pvconn;
129 retval = pvconn_open(name, get_allowed_ofp_versions(),
130 DSCP_DEFAULT, &pvconn);
132 if (n_listeners >= MAX_LISTENERS) {
133 ovs_fatal(0, "max %d passive connections", n_listeners);
135 listeners[n_listeners++] = pvconn;
139 VLOG_ERR("%s: connect: %s", name, strerror(retval));
142 if (n_switches == 0 && n_listeners == 0) {
143 ovs_fatal(0, "no active or passive switch connections");
148 retval = unixctl_server_create(unixctl_path, &unixctl);
153 daemonize_complete();
155 while (n_switches > 0 || n_listeners > 0) {
156 /* Accept connections on listening vconns. */
157 for (i = 0; i < n_listeners && n_switches < MAX_SWITCHES; ) {
158 struct vconn *new_vconn;
160 retval = pvconn_accept(listeners[i], &new_vconn);
161 if (!retval || retval == EAGAIN) {
163 new_switch(&switches[n_switches++], new_vconn);
167 pvconn_close(listeners[i]);
168 listeners[i] = listeners[--n_listeners];
172 /* Do some switching work. . */
173 for (i = 0; i < n_switches; ) {
174 struct switch_ *this = &switches[i];
175 lswitch_run(this->lswitch);
176 if (lswitch_is_alive(this->lswitch)) {
179 lswitch_destroy(this->lswitch);
180 switches[i] = switches[--n_switches];
184 unixctl_server_run(unixctl);
186 /* Wait for something to happen. */
187 if (n_switches < MAX_SWITCHES) {
188 for (i = 0; i < n_listeners; i++) {
189 pvconn_wait(listeners[i]);
192 for (i = 0; i < n_switches; i++) {
193 struct switch_ *sw = &switches[i];
194 lswitch_wait(sw->lswitch);
196 unixctl_server_wait(unixctl);
204 new_switch(struct switch_ *sw, struct vconn *vconn)
206 struct lswitch_config cfg;
209 rconn = rconn_create(60, 0, DSCP_DEFAULT, get_allowed_ofp_versions());
210 rconn_connect_unreliably(rconn, vconn, NULL);
212 cfg.mode = (action_normal ? LSW_NORMAL
213 : learn_macs ? LSW_LEARN
215 cfg.wildcards = wildcards;
216 cfg.max_idle = set_up_flows ? max_idle : -1;
217 cfg.default_flows = default_flows;
218 cfg.n_default_flows = n_default_flows;
219 cfg.default_queue = default_queue;
220 cfg.port_queues = &port_queues;
222 sw->lswitch = lswitch_create(rconn, &cfg);
226 add_port_queue(char *s)
228 char *save_ptr = NULL;
232 port_name = strtok_r(s, ":", &save_ptr);
233 queue_id = strtok_r(NULL, "", &save_ptr);
235 ovs_fatal(0, "argument to -Q or --port-queue should take the form "
236 "\"<port-name>:<queue-id>\"");
239 if (!simap_put(&port_queues, port_name, atoi(queue_id))) {
240 ovs_fatal(0, "<port-name> arguments for -Q or --port-queue must "
246 parse_options(int argc, char *argv[])
249 OPT_MAX_IDLE = UCHAR_MAX + 1,
256 OFP_VERSION_OPTION_ENUMS
258 static struct option long_options[] = {
259 {"hub", no_argument, NULL, 'H'},
260 {"noflow", no_argument, NULL, 'n'},
261 {"normal", no_argument, NULL, 'N'},
262 {"wildcards", optional_argument, NULL, 'w'},
263 {"max-idle", required_argument, NULL, OPT_MAX_IDLE},
264 {"mute", no_argument, NULL, OPT_MUTE},
265 {"queue", required_argument, NULL, 'q'},
266 {"port-queue", required_argument, NULL, 'Q'},
267 {"with-flows", required_argument, NULL, OPT_WITH_FLOWS},
268 {"unixctl", required_argument, NULL, OPT_UNIXCTL},
269 {"help", no_argument, NULL, 'h'},
271 OFP_VERSION_LONG_OPTIONS,
273 STREAM_SSL_LONG_OPTIONS,
274 {"peer-ca-cert", required_argument, NULL, OPT_PEER_CA_CERT},
277 char *short_options = long_options_to_short_options(long_options);
283 c = getopt_long(argc, argv, short_options, long_options, &indexptr);
294 set_up_flows = false;
302 action_normal = true;
306 wildcards = optarg ? strtol(optarg, NULL, 16) : UINT32_MAX;
310 if (!strcmp(optarg, "permanent")) {
311 max_idle = OFP_FLOW_PERMANENT;
313 max_idle = atoi(optarg);
314 if (max_idle < 1 || max_idle > 65535) {
315 ovs_fatal(0, "--max-idle argument must be between 1 and "
316 "65535 or the word 'permanent'");
322 default_queue = atoi(optarg);
326 add_port_queue(optarg);
330 parse_ofp_flow_mod_file(optarg, OFPFC_ADD, &default_flows,
335 unixctl_path = optarg;
342 OFP_VERSION_OPTION_HANDLERS
343 DAEMON_OPTION_HANDLERS
345 STREAM_SSL_OPTION_HANDLERS
347 case OPT_PEER_CA_CERT:
348 stream_ssl_set_peer_ca_cert_file(optarg);
360 if (!simap_is_empty(&port_queues) || default_queue != UINT32_MAX) {
362 ovs_error(0, "queue IDs are incompatible with -N or --normal; "
363 "not using OFPP_NORMAL");
364 action_normal = false;
368 ovs_error(0, "queue IDs are incompatible with -H or --hub; "
369 "not acting as hub");
378 printf("%s: OpenFlow controller\n"
379 "usage: %s [OPTIONS] METHOD\n"
380 "where METHOD is any OpenFlow connection method.\n",
381 program_name, program_name);
382 vconn_usage(true, true, false);
386 printf("\nOther options:\n"
387 " -H, --hub act as hub instead of learning switch\n"
388 " -n, --noflow pass traffic, but don't add flows\n"
389 " --max-idle=SECS max idle time for new flows\n"
390 " -N, --normal use OFPP_NORMAL action\n"
391 " -w, --wildcards[=MASK] wildcard (specified) bits in flows\n"
392 " -q, --queue=QUEUE-ID OpenFlow queue ID to use for output\n"
393 " -Q PORT-NAME:QUEUE-ID use QUEUE-ID for frames from PORT-NAME\n"
394 " --with-flows FILE use the flows from FILE\n"
395 " --unixctl=SOCKET override default control socket name\n"
396 " -h, --help display this help message\n"
397 " -V, --version display version information\n");