2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 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"
33 #include "openflow/openflow.h"
34 #include "poll-loop.h"
37 #include "stream-ssl.h"
43 #include "socket-util.h"
45 VLOG_DEFINE_THIS_MODULE(controller);
47 #define MAX_SWITCHES 16
48 #define MAX_LISTENERS 16
51 struct lswitch *lswitch;
55 /* -H, --hub: Learn the ports on which MAC addresses appear? */
56 static bool learn_macs = true;
58 /* -n, --noflow: Set up flows? (If not, every packet is processed at the
60 static bool set_up_flows = true;
62 /* -N, --normal: Use "NORMAL" action instead of explicit port? */
63 static bool action_normal = false;
65 /* -w, --wildcard: 0 to disable wildcard flow entries, an OFPFW10_* bitmask to
66 * enable specific wildcards, or UINT32_MAX to use the default wildcards. */
67 static uint32_t wildcards = 0;
69 /* --max-idle: Maximum idle time, in seconds, before flows expire. */
70 static int max_idle = 60;
72 /* --mute: If true, accept connections from switches but do not reply to any
73 * of their messages (for debugging fail-open mode). */
74 static bool mute = false;
76 /* -q, --queue: default OpenFlow queue, none if UINT32_MAX. */
77 static uint32_t default_queue = UINT32_MAX;
79 /* -Q, --port-queue: map from port name to port number. */
80 static struct simap port_queues = SIMAP_INITIALIZER(&port_queues);
82 /* --with-flows: Flows to send to switch. */
83 static struct ofputil_flow_mod *default_flows;
84 static size_t n_default_flows;
86 /* --unixctl: Name of unixctl socket, or null to use the default. */
87 static char *unixctl_path = NULL;
89 static int do_switching(struct switch_ *);
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, OFP10_VERSION, &vconn, DSCP_DEFAULT);
121 if (n_switches >= MAX_SWITCHES) {
122 ovs_fatal(0, "max %d switch connections", n_switches);
124 new_switch(&switches[n_switches++], vconn);
126 } else if (retval == EAFNOSUPPORT) {
127 struct pvconn *pvconn;
128 retval = pvconn_open(name, &pvconn, DSCP_DEFAULT);
130 if (n_listeners >= MAX_LISTENERS) {
131 ovs_fatal(0, "max %d passive connections", n_listeners);
133 listeners[n_listeners++] = pvconn;
137 VLOG_ERR("%s: connect: %s", name, strerror(retval));
140 if (n_switches == 0 && n_listeners == 0) {
141 ovs_fatal(0, "no active or passive switch connections");
146 retval = unixctl_server_create(unixctl_path, &unixctl);
151 daemonize_complete();
153 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], OFP10_VERSION, &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. Limit the number of iterations so that
173 * callbacks registered with the poll loop don't starve. */
174 for (iteration = 0; iteration < 50; iteration++) {
175 bool progress = false;
176 for (i = 0; i < n_switches; ) {
177 struct switch_ *this = &switches[i];
179 retval = do_switching(this);
180 if (!retval || retval == EAGAIN) {
186 rconn_destroy(this->rconn);
187 lswitch_destroy(this->lswitch);
188 switches[i] = switches[--n_switches];
195 for (i = 0; i < n_switches; i++) {
196 struct switch_ *this = &switches[i];
197 lswitch_run(this->lswitch);
200 unixctl_server_run(unixctl);
202 /* Wait for something to happen. */
203 if (n_switches < MAX_SWITCHES) {
204 for (i = 0; i < n_listeners; i++) {
205 pvconn_wait(listeners[i]);
208 for (i = 0; i < n_switches; i++) {
209 struct switch_ *sw = &switches[i];
210 rconn_run_wait(sw->rconn);
211 rconn_recv_wait(sw->rconn);
212 lswitch_wait(sw->lswitch);
214 unixctl_server_wait(unixctl);
222 new_switch(struct switch_ *sw, struct vconn *vconn)
224 struct lswitch_config cfg;
226 sw->rconn = rconn_create(60, 0, DSCP_DEFAULT);
227 rconn_connect_unreliably(sw->rconn, vconn, NULL);
229 cfg.mode = (action_normal ? LSW_NORMAL
230 : learn_macs ? LSW_LEARN
232 cfg.wildcards = wildcards;
233 cfg.max_idle = set_up_flows ? max_idle : -1;
234 cfg.default_flows = default_flows;
235 cfg.n_default_flows = n_default_flows;
236 cfg.default_queue = default_queue;
237 cfg.port_queues = &port_queues;
238 sw->lswitch = lswitch_create(sw->rconn, &cfg);
242 do_switching(struct switch_ *sw)
244 unsigned int packets_sent;
247 packets_sent = rconn_packets_sent(sw->rconn);
249 msg = rconn_recv(sw->rconn);
252 lswitch_process_packet(sw->lswitch, sw->rconn, msg);
256 rconn_run(sw->rconn);
258 return (!rconn_is_alive(sw->rconn) ? EOF
259 : rconn_packets_sent(sw->rconn) != packets_sent ? 0
264 add_port_queue(char *s)
266 char *save_ptr = NULL;
270 port_name = strtok_r(s, ":", &save_ptr);
271 queue_id = strtok_r(NULL, "", &save_ptr);
273 ovs_fatal(0, "argument to -Q or --port-queue should take the form "
274 "\"<port-name>:<queue-id>\"");
277 if (!simap_put(&port_queues, port_name, atoi(queue_id))) {
278 ovs_fatal(0, "<port-name> arguments for -Q or --port-queue must "
284 parse_options(int argc, char *argv[])
287 OPT_MAX_IDLE = UCHAR_MAX + 1,
295 static struct option long_options[] = {
296 {"hub", no_argument, NULL, 'H'},
297 {"noflow", no_argument, NULL, 'n'},
298 {"normal", no_argument, NULL, 'N'},
299 {"wildcards", optional_argument, NULL, 'w'},
300 {"max-idle", required_argument, NULL, OPT_MAX_IDLE},
301 {"mute", no_argument, NULL, OPT_MUTE},
302 {"queue", required_argument, NULL, 'q'},
303 {"port-queue", required_argument, NULL, 'Q'},
304 {"with-flows", required_argument, NULL, OPT_WITH_FLOWS},
305 {"unixctl", required_argument, NULL, OPT_UNIXCTL},
306 {"help", no_argument, NULL, 'h'},
307 {"version", no_argument, NULL, 'V'},
310 STREAM_SSL_LONG_OPTIONS,
311 {"peer-ca-cert", required_argument, NULL, OPT_PEER_CA_CERT},
314 char *short_options = long_options_to_short_options(long_options);
320 c = getopt_long(argc, argv, short_options, long_options, &indexptr);
331 set_up_flows = false;
339 action_normal = true;
343 wildcards = optarg ? strtol(optarg, NULL, 16) : UINT32_MAX;
347 if (!strcmp(optarg, "permanent")) {
348 max_idle = OFP_FLOW_PERMANENT;
350 max_idle = atoi(optarg);
351 if (max_idle < 1 || max_idle > 65535) {
352 ovs_fatal(0, "--max-idle argument must be between 1 and "
353 "65535 or the word 'permanent'");
359 default_queue = atoi(optarg);
363 add_port_queue(optarg);
367 parse_ofp_flow_mod_file(optarg, OFPFC_ADD, &default_flows,
372 unixctl_path = optarg;
379 ovs_print_version(OFP10_VERSION, OFP10_VERSION);
383 DAEMON_OPTION_HANDLERS
385 STREAM_SSL_OPTION_HANDLERS
387 case OPT_PEER_CA_CERT:
388 stream_ssl_set_peer_ca_cert_file(optarg);
400 if (!simap_is_empty(&port_queues) || default_queue != UINT32_MAX) {
402 ovs_error(0, "queue IDs are incompatible with -N or --normal; "
403 "not using OFPP_NORMAL");
404 action_normal = false;
408 ovs_error(0, "queue IDs are incompatible with -H or --hub; "
409 "not acting as hub");
418 printf("%s: OpenFlow controller\n"
419 "usage: %s [OPTIONS] METHOD\n"
420 "where METHOD is any OpenFlow connection method.\n",
421 program_name, program_name);
422 vconn_usage(true, true, false);
425 printf("\nOther options:\n"
426 " -H, --hub act as hub instead of learning switch\n"
427 " -n, --noflow pass traffic, but don't add flows\n"
428 " --max-idle=SECS max idle time for new flows\n"
429 " -N, --normal use OFPP_NORMAL action\n"
430 " -w, --wildcards[=MASK] wildcard (specified) bits in flows\n"
431 " -q, --queue=QUEUE-ID OpenFlow queue ID to use for output\n"
432 " -Q PORT-NAME:QUEUE-ID use QUEUE-ID for frames from PORT-NAME\n"
433 " --with-flows FILE use the flows from FILE\n"
434 " --unixctl=SOCKET override default control socket name\n"
435 " -h, --help display this help message\n"
436 " -V, --version display version information\n");