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.
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"
44 VLOG_DEFINE_THIS_MODULE(controller);
46 #define MAX_SWITCHES 16
47 #define MAX_LISTENERS 16
50 struct lswitch *lswitch;
54 /* -H, --hub: Learn the ports on which MAC addresses appear? */
55 static bool learn_macs = true;
57 /* -n, --noflow: Set up flows? (If not, every packet is processed at the
59 static bool set_up_flows = true;
61 /* -N, --normal: Use "NORMAL" action instead of explicit port? */
62 static bool action_normal = false;
64 /* -w, --wildcard: Set up exact match or wildcard flow entries? */
65 static bool exact_flows = true;
67 /* --max-idle: Maximum idle time, in seconds, before flows expire. */
68 static int max_idle = 60;
70 /* --mute: If true, accept connections from switches but do not reply to any
71 * of their messages (for debugging fail-open mode). */
72 static bool mute = false;
74 /* -q, --queue: default OpenFlow queue, none if UINT32_MAX. */
75 static uint32_t default_queue = UINT32_MAX;
77 /* -Q, --port-queue: map from port name to port number (cast to void *). */
78 static struct shash port_queues = SHASH_INITIALIZER(&port_queues);
80 /* --with-flows: Flows to send to switch, or an empty list not to send any
82 static struct list default_flows = LIST_INITIALIZER(&default_flows);
84 /* --unixctl: Name of unixctl socket, or null to use the default. */
85 static char *unixctl_path = NULL;
87 static int do_switching(struct switch_ *);
88 static void new_switch(struct switch_ *, struct vconn *);
89 static void parse_options(int argc, char *argv[]);
90 static void usage(void) NO_RETURN;
93 main(int argc, char *argv[])
95 struct unixctl_server *unixctl;
96 struct switch_ switches[MAX_SWITCHES];
97 struct pvconn *listeners[MAX_LISTENERS];
98 int n_switches, n_listeners;
102 proctitle_init(argc, argv);
103 set_program_name(argv[0]);
104 parse_options(argc, argv);
105 signal(SIGPIPE, SIG_IGN);
107 if (argc - optind < 1) {
108 ovs_fatal(0, "at least one vconn argument required; "
109 "use --help for usage");
112 n_switches = n_listeners = 0;
113 for (i = optind; i < argc; i++) {
114 const char *name = argv[i];
117 retval = vconn_open(name, OFP_VERSION, &vconn);
119 if (n_switches >= MAX_SWITCHES) {
120 ovs_fatal(0, "max %d switch connections", n_switches);
122 new_switch(&switches[n_switches++], vconn);
124 } else if (retval == EAFNOSUPPORT) {
125 struct pvconn *pvconn;
126 retval = pvconn_open(name, &pvconn);
128 if (n_listeners >= MAX_LISTENERS) {
129 ovs_fatal(0, "max %d passive connections", n_listeners);
131 listeners[n_listeners++] = pvconn;
135 VLOG_ERR("%s: connect: %s", name, strerror(retval));
138 if (n_switches == 0 && n_listeners == 0) {
139 ovs_fatal(0, "no active or passive switch connections");
142 die_if_already_running();
145 retval = unixctl_server_create(unixctl_path, &unixctl);
150 daemonize_complete();
152 while (n_switches > 0 || n_listeners > 0) {
155 /* Accept connections on listening vconns. */
156 for (i = 0; i < n_listeners && n_switches < MAX_SWITCHES; ) {
157 struct vconn *new_vconn;
159 retval = pvconn_accept(listeners[i], OFP_VERSION, &new_vconn);
160 if (!retval || retval == EAGAIN) {
162 new_switch(&switches[n_switches++], new_vconn);
166 pvconn_close(listeners[i]);
167 listeners[i] = listeners[--n_listeners];
171 /* Do some switching work. Limit the number of iterations so that
172 * callbacks registered with the poll loop don't starve. */
173 for (iteration = 0; iteration < 50; iteration++) {
174 bool progress = false;
175 for (i = 0; i < n_switches; ) {
176 struct switch_ *this = &switches[i];
178 retval = do_switching(this);
179 if (!retval || retval == EAGAIN) {
185 rconn_destroy(this->rconn);
186 lswitch_destroy(this->lswitch);
187 switches[i] = switches[--n_switches];
194 for (i = 0; i < n_switches; i++) {
195 struct switch_ *this = &switches[i];
196 lswitch_run(this->lswitch);
199 unixctl_server_run(unixctl);
201 /* Wait for something to happen. */
202 if (n_switches < MAX_SWITCHES) {
203 for (i = 0; i < n_listeners; i++) {
204 pvconn_wait(listeners[i]);
207 for (i = 0; i < n_switches; i++) {
208 struct switch_ *sw = &switches[i];
209 rconn_run_wait(sw->rconn);
210 rconn_recv_wait(sw->rconn);
211 lswitch_wait(sw->lswitch);
213 unixctl_server_wait(unixctl);
221 new_switch(struct switch_ *sw, struct vconn *vconn)
223 struct lswitch_config cfg;
225 sw->rconn = rconn_create(60, 0);
226 rconn_connect_unreliably(sw->rconn, vconn, NULL);
228 cfg.mode = (action_normal ? LSW_NORMAL
229 : learn_macs ? LSW_LEARN
231 cfg.max_idle = set_up_flows ? max_idle : -1;
232 cfg.default_flows = &default_flows;
233 cfg.default_queue = default_queue;
234 cfg.port_queues = &port_queues;
235 sw->lswitch = lswitch_create(sw->rconn, &cfg);
239 do_switching(struct switch_ *sw)
241 unsigned int packets_sent;
244 packets_sent = rconn_packets_sent(sw->rconn);
246 msg = rconn_recv(sw->rconn);
249 lswitch_process_packet(sw->lswitch, sw->rconn, msg);
253 rconn_run(sw->rconn);
255 return (!rconn_is_alive(sw->rconn) ? EOF
256 : rconn_packets_sent(sw->rconn) != packets_sent ? 0
261 read_flow_file(const char *name)
263 enum nx_flow_format flow_format;
266 stream = fopen(optarg, "r");
268 ovs_fatal(errno, "%s: open", name);
271 flow_format = NXFF_OPENFLOW10;
272 while (parse_ofp_add_flow_file(&default_flows, &flow_format, stream)) {
280 add_port_queue(char *s)
282 char *save_ptr = NULL;
286 port_name = strtok_r(s, ":", &save_ptr);
287 queue_id = strtok_r(NULL, "", &save_ptr);
289 ovs_fatal(0, "argument to -Q or --port-queue should take the form "
290 "\"<port-name>:<queue-id>\"");
293 if (!shash_add_once(&port_queues, port_name,
294 (void *) (uintptr_t) atoi(queue_id))) {
295 ovs_fatal(0, "<port-name> arguments for -Q or --port-queue must "
301 parse_options(int argc, char *argv[])
304 OPT_MAX_IDLE = UCHAR_MAX + 1,
312 static struct option long_options[] = {
313 {"hub", no_argument, 0, 'H'},
314 {"noflow", no_argument, 0, 'n'},
315 {"normal", no_argument, 0, 'N'},
316 {"wildcard", no_argument, 0, 'w'},
317 {"max-idle", required_argument, 0, OPT_MAX_IDLE},
318 {"mute", no_argument, 0, OPT_MUTE},
319 {"queue", required_argument, 0, 'q'},
320 {"port-queue", required_argument, 0, 'Q'},
321 {"with-flows", required_argument, 0, OPT_WITH_FLOWS},
322 {"unixctl", required_argument, 0, OPT_UNIXCTL},
323 {"help", no_argument, 0, 'h'},
324 {"version", no_argument, 0, 'V'},
328 STREAM_SSL_LONG_OPTIONS
329 {"peer-ca-cert", required_argument, 0, OPT_PEER_CA_CERT},
333 char *short_options = long_options_to_short_options(long_options);
339 c = getopt_long(argc, argv, short_options, long_options, &indexptr);
350 set_up_flows = false;
358 action_normal = true;
366 if (!strcmp(optarg, "permanent")) {
367 max_idle = OFP_FLOW_PERMANENT;
369 max_idle = atoi(optarg);
370 if (max_idle < 1 || max_idle > 65535) {
371 ovs_fatal(0, "--max-idle argument must be between 1 and "
372 "65535 or the word 'permanent'");
378 default_queue = atoi(optarg);
382 add_port_queue(optarg);
386 read_flow_file(optarg);
390 unixctl_path = optarg;
397 OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
401 DAEMON_OPTION_HANDLERS
404 STREAM_SSL_OPTION_HANDLERS
406 case OPT_PEER_CA_CERT:
407 stream_ssl_set_peer_ca_cert_file(optarg);
420 if (!shash_is_empty(&port_queues) || default_queue != UINT32_MAX) {
422 ovs_error(0, "queue IDs are incompatible with -N or --normal; "
423 "not using OFPP_NORMAL");
424 action_normal = false;
428 ovs_error(0, "queue IDs are incompatible with -H or --hub; "
429 "not acting as hub");
438 printf("%s: OpenFlow controller\n"
439 "usage: %s [OPTIONS] METHOD\n"
440 "where METHOD is any OpenFlow connection method.\n",
441 program_name, program_name);
442 vconn_usage(true, true, false);
445 printf("\nOther options:\n"
446 " -H, --hub act as hub instead of learning switch\n"
447 " -n, --noflow pass traffic, but don't add flows\n"
448 " --max-idle=SECS max idle time for new flows\n"
449 " -N, --normal use OFPP_NORMAL action\n"
450 " -w, --wildcard use wildcards, not exact-match rules\n"
451 " -q, --queue=QUEUE-ID OpenFlow queue ID to use for output\n"
452 " -Q PORT-NAME:QUEUE-ID use QUEUE-ID for frames from PORT-NAME\n"
453 " --with-flows FILE use the flows from FILE\n"
454 " --unixctl=SOCKET override default control socket name\n"
455 " -h, --help display this help message\n"
456 " -V, --version display version information\n");