1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
4 * We are making the OpenFlow specification and associated documentation
5 * (Software) available for public use and benefit with the expectation
6 * that others will use, modify and enhance the Software and contribute
7 * those enhancements back to the community. However, since we would
8 * like to make the Software available for broadest use, with as few
9 * restrictions as possible permission is hereby granted, free of
10 * charge, to any person obtaining a copy of this Software to deal in
11 * the Software under the copyrights without restriction, including
12 * without limitation the rights to use, copy, modify, merge, publish,
13 * distribute, sublicense, and/or sell copies of the Software, and to
14 * permit persons to whom the Software is furnished to do so, subject to
15 * the following conditions:
17 * The above copyright notice and this permission notice shall be
18 * included in all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 * The name and trademarks of copyright holder(s) may NOT be used in
30 * advertising or publicity pertaining to the Software or any
31 * derivatives without specific, written prior permission.
41 #include "command-line.h"
45 #include "learning-switch.h"
47 #include "poll-loop.h"
50 #include "vconn-ssl.h"
52 #include "vlog-socket.h"
55 #define THIS_MODULE VLM_controller
57 #define MAX_SWITCHES 16
58 #define MAX_LISTENERS 16
61 struct lswitch *lswitch;
65 /* Learn the ports on which MAC addresses appear? */
66 static bool learn_macs = true;
68 /* Set up flows? (If not, every packet is processed at the controller.) */
69 static bool setup_flows = true;
71 /* --max-idle: Maximum idle time, in seconds, before flows expire. */
72 static int max_idle = 60;
74 static int do_switching(struct switch_ *);
75 static void new_switch(struct switch_ *, struct vconn *, const char *name);
76 static void parse_options(int argc, char *argv[]);
77 static void usage(void) NO_RETURN;
80 main(int argc, char *argv[])
82 struct switch_ switches[MAX_SWITCHES];
83 struct vconn *listeners[MAX_LISTENERS];
84 int n_switches, n_listeners;
88 set_program_name(argv[0]);
89 register_fault_handlers();
91 parse_options(argc, argv);
93 if (argc - optind < 1) {
94 fatal(0, "at least one vconn argument required; use --help for usage");
97 retval = vlog_server_listen(NULL, NULL);
99 fatal(retval, "Could not listen for vlog connections");
102 n_switches = n_listeners = 0;
103 for (i = optind; i < argc; i++) {
104 const char *name = argv[i];
108 retval = vconn_open(name, &vconn);
110 VLOG_ERR("%s: connect: %s", name, strerror(retval));
114 if (vconn_is_passive(vconn)) {
115 if (n_listeners >= MAX_LISTENERS) {
116 fatal(0, "max %d passive connections", n_listeners);
118 listeners[n_listeners++] = vconn;
120 if (n_switches >= MAX_SWITCHES) {
121 fatal(0, "max %d switch connections", n_switches);
123 new_switch(&switches[n_switches++], vconn, name);
126 if (n_switches == 0 && n_listeners == 0) {
127 fatal(0, "no active or passive switch connections");
132 while (n_switches > 0 || n_listeners > 0) {
136 /* Accept connections on listening vconns. */
137 for (i = 0; i < n_listeners && n_switches < MAX_SWITCHES; ) {
138 struct vconn *new_vconn;
141 retval = vconn_accept(listeners[i], &new_vconn);
142 if (!retval || retval == EAGAIN) {
144 new_switch(&switches[n_switches++], new_vconn, "tcp");
148 vconn_close(listeners[i]);
149 listeners[i] = listeners[--n_listeners];
153 /* Do some switching work. Limit the number of iterations so that
154 * callbacks registered with the poll loop don't starve. */
155 for (iteration = 0; iteration < 50; iteration++) {
156 bool progress = false;
157 for (i = 0; i < n_switches; ) {
158 struct switch_ *this = &switches[i];
159 int retval = do_switching(this);
160 if (!retval || retval == EAGAIN) {
166 lswitch_destroy(this->lswitch);
167 rconn_destroy(this->rconn);
168 switches[i] = switches[--n_switches];
176 /* Wait for something to happen. */
177 if (n_switches < MAX_SWITCHES) {
178 for (i = 0; i < n_listeners; i++) {
179 vconn_accept_wait(listeners[i]);
182 for (i = 0; i < n_switches; i++) {
183 struct switch_ *sw = &switches[i];
184 rconn_run_wait(sw->rconn);
185 rconn_recv_wait(sw->rconn);
194 new_switch(struct switch_ *sw, struct vconn *vconn, const char *name)
196 sw->rconn = rconn_new_from_vconn(name, 128, vconn);
197 sw->lswitch = lswitch_create(sw->rconn, learn_macs,
198 setup_flows ? max_idle : -1);
202 do_switching(struct switch_ *sw)
204 unsigned int packets_sent;
207 packets_sent = rconn_packets_sent(sw->rconn);
209 msg = rconn_recv(sw->rconn);
211 lswitch_process_packet(sw->lswitch, sw->rconn, msg);
214 rconn_run(sw->rconn);
216 return (!rconn_is_alive(sw->rconn) ? EOF
217 : rconn_packets_sent(sw->rconn) != packets_sent ? 0
222 parse_options(int argc, char *argv[])
224 enum { OPT_MAX_IDLE = UCHAR_MAX + 1 };
225 static struct option long_options[] = {
226 {"detach", no_argument, 0, 'D'},
227 {"pidfile", optional_argument, 0, 'P'},
228 {"hub", no_argument, 0, 'H'},
229 {"noflow", no_argument, 0, 'n'},
230 {"max-idle", required_argument, 0, OPT_MAX_IDLE},
231 {"verbose", optional_argument, 0, 'v'},
232 {"help", no_argument, 0, 'h'},
233 {"version", no_argument, 0, 'V'},
234 VCONN_SSL_LONG_OPTIONS
237 char *short_options = long_options_to_short_options(long_options);
243 c = getopt_long(argc, argv, short_options, long_options, &indexptr);
254 set_pidfile(optarg ? optarg : "controller.pid");
266 if (!strcmp(optarg, "permanent")) {
267 max_idle = OFP_FLOW_PERMANENT;
269 max_idle = atoi(optarg);
270 if (max_idle < 1 || max_idle > 65535) {
271 fatal(0, "--max-idle argument must be between 1 and "
272 "65535 or the word 'permanent'");
281 printf("%s "VERSION" compiled "__DATE__" "__TIME__"\n", argv[0]);
285 vlog_set_verbosity(optarg);
288 VCONN_SSL_OPTION_HANDLERS
303 printf("%s: OpenFlow controller\n"
304 "usage: %s [OPTIONS] METHOD\n"
305 "where METHOD is any OpenFlow connection method.\n",
306 program_name, program_name);
307 vconn_usage(true, true);
308 printf("\nOther options:\n"
309 " -D, --detach run in background as daemon\n"
310 " -P, --pidfile[=FILE] create pidfile (default: %s/controller.pid)\n"
311 " -H, --hub act as hub instead of learning switch\n"
312 " -n, --noflow pass traffic, but don't add flows\n"
313 " --max-idle=SECS max idle time for new flows\n"
314 " -v, --verbose=MODULE:FACILITY:LEVEL configure logging levels\n"
315 " -v, --verbose set maximum verbosity level\n"
316 " -h, --help display this help message\n"
317 " -V, --version display version information\n",