2 * Copyright (c) 2008, 2009, 2010 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.
26 #include "command-line.h"
29 #include "learning-switch.h"
31 #include "openflow/openflow.h"
32 #include "poll-loop.h"
34 #include "stream-ssl.h"
41 VLOG_DEFINE_THIS_MODULE(controller)
43 #define MAX_SWITCHES 16
44 #define MAX_LISTENERS 16
47 struct lswitch *lswitch;
51 /* Learn the ports on which MAC addresses appear? */
52 static bool learn_macs = true;
54 /* Set up flows? (If not, every packet is processed at the controller.) */
55 static bool set_up_flows = true;
57 /* -N, --normal: Use "NORMAL" action instead of explicit port? */
58 static bool action_normal = false;
60 /* -w, --wildcard: Set up exact match or wildcard flow entries? */
61 static bool exact_flows = true;
63 /* --max-idle: Maximum idle time, in seconds, before flows expire. */
64 static int max_idle = 60;
66 /* --mute: If true, accept connections from switches but do not reply to any
67 * of their messages (for debugging fail-open mode). */
68 static bool mute = false;
70 /* -q, --queue: OpenFlow queue to use, or the default queue if UINT32_MAX. */
71 static uint32_t queue_id = UINT32_MAX;
73 /* --unixctl: Name of unixctl socket, or null to use the default. */
74 static char *unixctl_path = NULL;
76 static int do_switching(struct switch_ *);
77 static void new_switch(struct switch_ *, struct vconn *);
78 static void parse_options(int argc, char *argv[]);
79 static void usage(void) NO_RETURN;
82 main(int argc, char *argv[])
84 struct unixctl_server *unixctl;
85 struct switch_ switches[MAX_SWITCHES];
86 struct pvconn *listeners[MAX_LISTENERS];
87 int n_switches, n_listeners;
91 proctitle_init(argc, argv);
92 set_program_name(argv[0]);
93 parse_options(argc, argv);
94 signal(SIGPIPE, SIG_IGN);
96 if (argc - optind < 1) {
97 ovs_fatal(0, "at least one vconn argument required; "
98 "use --help for usage");
101 n_switches = n_listeners = 0;
102 for (i = optind; i < argc; i++) {
103 const char *name = argv[i];
107 retval = vconn_open(name, OFP_VERSION, &vconn);
109 if (n_switches >= MAX_SWITCHES) {
110 ovs_fatal(0, "max %d switch connections", n_switches);
112 new_switch(&switches[n_switches++], vconn);
114 } else if (retval == EAFNOSUPPORT) {
115 struct pvconn *pvconn;
116 retval = pvconn_open(name, &pvconn);
118 if (n_listeners >= MAX_LISTENERS) {
119 ovs_fatal(0, "max %d passive connections", n_listeners);
121 listeners[n_listeners++] = pvconn;
125 VLOG_ERR("%s: connect: %s", name, strerror(retval));
128 if (n_switches == 0 && n_listeners == 0) {
129 ovs_fatal(0, "no active or passive switch connections");
132 die_if_already_running();
135 retval = unixctl_server_create(unixctl_path, &unixctl);
140 daemonize_complete();
142 while (n_switches > 0 || n_listeners > 0) {
146 /* Accept connections on listening vconns. */
147 for (i = 0; i < n_listeners && n_switches < MAX_SWITCHES; ) {
148 struct vconn *new_vconn;
151 retval = pvconn_accept(listeners[i], OFP_VERSION, &new_vconn);
152 if (!retval || retval == EAGAIN) {
154 new_switch(&switches[n_switches++], new_vconn);
158 pvconn_close(listeners[i]);
159 listeners[i] = listeners[--n_listeners];
163 /* Do some switching work. Limit the number of iterations so that
164 * callbacks registered with the poll loop don't starve. */
165 for (iteration = 0; iteration < 50; iteration++) {
166 bool progress = false;
167 for (i = 0; i < n_switches; ) {
168 struct switch_ *this = &switches[i];
169 int retval = do_switching(this);
170 if (!retval || retval == EAGAIN) {
176 rconn_destroy(this->rconn);
177 lswitch_destroy(this->lswitch);
178 switches[i] = switches[--n_switches];
185 for (i = 0; i < n_switches; i++) {
186 struct switch_ *this = &switches[i];
187 lswitch_run(this->lswitch, this->rconn);
190 unixctl_server_run(unixctl);
192 /* Wait for something to happen. */
193 if (n_switches < MAX_SWITCHES) {
194 for (i = 0; i < n_listeners; i++) {
195 pvconn_wait(listeners[i]);
198 for (i = 0; i < n_switches; i++) {
199 struct switch_ *sw = &switches[i];
200 rconn_run_wait(sw->rconn);
201 rconn_recv_wait(sw->rconn);
202 lswitch_wait(sw->lswitch);
204 unixctl_server_wait(unixctl);
212 new_switch(struct switch_ *sw, struct vconn *vconn)
214 sw->rconn = rconn_create(60, 0);
215 rconn_connect_unreliably(sw->rconn, vconn, NULL);
216 sw->lswitch = lswitch_create(sw->rconn, learn_macs, exact_flows,
217 set_up_flows ? max_idle : -1,
219 lswitch_set_queue(sw->lswitch, queue_id);
223 do_switching(struct switch_ *sw)
225 unsigned int packets_sent;
228 packets_sent = rconn_packets_sent(sw->rconn);
230 msg = rconn_recv(sw->rconn);
233 lswitch_process_packet(sw->lswitch, sw->rconn, msg);
237 rconn_run(sw->rconn);
239 return (!rconn_is_alive(sw->rconn) ? EOF
240 : rconn_packets_sent(sw->rconn) != packets_sent ? 0
245 parse_options(int argc, char *argv[])
248 OPT_MAX_IDLE = UCHAR_MAX + 1,
254 static struct option long_options[] = {
255 {"hub", no_argument, 0, 'H'},
256 {"noflow", no_argument, 0, 'n'},
257 {"normal", no_argument, 0, 'N'},
258 {"wildcard", no_argument, 0, 'w'},
259 {"max-idle", required_argument, 0, OPT_MAX_IDLE},
260 {"mute", no_argument, 0, OPT_MUTE},
261 {"queue", required_argument, 0, 'q'},
262 {"unixctl", required_argument, 0, OPT_UNIXCTL},
263 {"help", no_argument, 0, 'h'},
264 {"version", no_argument, 0, 'V'},
268 STREAM_SSL_LONG_OPTIONS
269 {"peer-ca-cert", required_argument, 0, OPT_PEER_CA_CERT},
273 char *short_options = long_options_to_short_options(long_options);
279 c = getopt_long(argc, argv, short_options, long_options, &indexptr);
290 set_up_flows = false;
298 action_normal = true;
306 if (!strcmp(optarg, "permanent")) {
307 max_idle = OFP_FLOW_PERMANENT;
309 max_idle = atoi(optarg);
310 if (max_idle < 1 || max_idle > 65535) {
311 ovs_fatal(0, "--max-idle argument must be between 1 and "
312 "65535 or the word 'permanent'");
318 queue_id = atoi(optarg);
322 unixctl_path = optarg;
329 OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
333 DAEMON_OPTION_HANDLERS
336 STREAM_SSL_OPTION_HANDLERS
338 case OPT_PEER_CA_CERT:
339 stream_ssl_set_peer_ca_cert_file(optarg);
356 printf("%s: OpenFlow controller\n"
357 "usage: %s [OPTIONS] METHOD\n"
358 "where METHOD is any OpenFlow connection method.\n",
359 program_name, program_name);
360 vconn_usage(true, true, false);
363 printf("\nOther options:\n"
364 " -H, --hub act as hub instead of learning switch\n"
365 " -n, --noflow pass traffic, but don't add flows\n"
366 " --max-idle=SECS max idle time for new flows\n"
367 " -N, --normal use OFPAT_NORMAL action\n"
368 " -w, --wildcard use wildcards, not exact-match rules\n"
369 " -q, --queue=QUEUE OpenFlow queue ID to use for output\n"
370 " --unixctl=SOCKET override default control socket name\n"
371 " -h, --help display this help message\n"
372 " -V, --version display version information\n");