]> git.proxmox.com Git - ovs.git/blame - utilities/ovs-controller.c
ofproto: Drop duplicate "const" in parameter declaration.
[ovs.git] / utilities / ovs-controller.c
CommitLineData
064af421 1/*
8274ae95 2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
064af421 3 *
a14bc59f
BP
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:
064af421 7 *
a14bc59f
BP
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
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.
064af421
BP
15 */
16
17#include <config.h>
18
19#include <errno.h>
20#include <getopt.h>
21#include <limits.h>
22#include <signal.h>
23#include <stdlib.h>
882c2399 24#include <stdio.h>
064af421
BP
25#include <string.h>
26
27#include "command-line.h"
28#include "compiler.h"
29#include "daemon.h"
064af421 30#include "learning-switch.h"
09913dfd 31#include "ofp-parse.h"
064af421
BP
32#include "ofpbuf.h"
33#include "openflow/openflow.h"
34#include "poll-loop.h"
35#include "rconn.h"
d4cdc6b4 36#include "shash.h"
fe55ad15 37#include "stream-ssl.h"
064af421
BP
38#include "timeval.h"
39#include "unixctl.h"
40#include "util.h"
064af421 41#include "vconn.h"
064af421 42#include "vlog.h"
5136ce49 43
d98e6007 44VLOG_DEFINE_THIS_MODULE(controller);
064af421
BP
45
46#define MAX_SWITCHES 16
47#define MAX_LISTENERS 16
48
49struct switch_ {
50 struct lswitch *lswitch;
51 struct rconn *rconn;
52};
53
d4cdc6b4 54/* -H, --hub: Learn the ports on which MAC addresses appear? */
064af421
BP
55static bool learn_macs = true;
56
d4cdc6b4
BP
57/* -n, --noflow: Set up flows? (If not, every packet is processed at the
58 * controller.) */
d6fbec6d 59static bool set_up_flows = true;
064af421 60
9af9e2e8
JT
61/* -N, --normal: Use "NORMAL" action instead of explicit port? */
62static bool action_normal = false;
63
64/* -w, --wildcard: Set up exact match or wildcard flow entries? */
65static bool exact_flows = true;
66
064af421
BP
67/* --max-idle: Maximum idle time, in seconds, before flows expire. */
68static int max_idle = 60;
69
7778bd15
BP
70/* --mute: If true, accept connections from switches but do not reply to any
71 * of their messages (for debugging fail-open mode). */
72static bool mute = false;
73
d4cdc6b4
BP
74/* -q, --queue: default OpenFlow queue, none if UINT32_MAX. */
75static uint32_t default_queue = UINT32_MAX;
76
77/* -Q, --port-queue: map from port name to port number (cast to void *). */
78static struct shash port_queues = SHASH_INITIALIZER(&port_queues);
611e9a35 79
b3907fbc
BP
80/* --with-flows: Flows to send to switch, or an empty list not to send any
81 * default flows. */
82static struct list default_flows = LIST_INITIALIZER(&default_flows);
882c2399 83
b66bdf30
BP
84/* --unixctl: Name of unixctl socket, or null to use the default. */
85static char *unixctl_path = NULL;
86
064af421 87static int do_switching(struct switch_ *);
58bdd092 88static void new_switch(struct switch_ *, struct vconn *);
064af421
BP
89static void parse_options(int argc, char *argv[]);
90static void usage(void) NO_RETURN;
91
92int
93main(int argc, char *argv[])
94{
95 struct unixctl_server *unixctl;
96 struct switch_ switches[MAX_SWITCHES];
97 struct pvconn *listeners[MAX_LISTENERS];
98 int n_switches, n_listeners;
99 int retval;
100 int i;
101
40f0707c 102 proctitle_init(argc, argv);
064af421 103 set_program_name(argv[0]);
064af421
BP
104 parse_options(argc, argv);
105 signal(SIGPIPE, SIG_IGN);
106
107 if (argc - optind < 1) {
108 ovs_fatal(0, "at least one vconn argument required; "
109 "use --help for usage");
110 }
111
112 n_switches = n_listeners = 0;
113 for (i = optind; i < argc; i++) {
114 const char *name = argv[i];
115 struct vconn *vconn;
064af421
BP
116
117 retval = vconn_open(name, OFP_VERSION, &vconn);
118 if (!retval) {
119 if (n_switches >= MAX_SWITCHES) {
120 ovs_fatal(0, "max %d switch connections", n_switches);
121 }
58bdd092 122 new_switch(&switches[n_switches++], vconn);
064af421
BP
123 continue;
124 } else if (retval == EAFNOSUPPORT) {
125 struct pvconn *pvconn;
126 retval = pvconn_open(name, &pvconn);
127 if (!retval) {
128 if (n_listeners >= MAX_LISTENERS) {
129 ovs_fatal(0, "max %d passive connections", n_listeners);
130 }
131 listeners[n_listeners++] = pvconn;
132 }
133 }
134 if (retval) {
135 VLOG_ERR("%s: connect: %s", name, strerror(retval));
136 }
137 }
138 if (n_switches == 0 && n_listeners == 0) {
139 ovs_fatal(0, "no active or passive switch connections");
140 }
141
95440284 142 daemonize_start();
064af421 143
b66bdf30 144 retval = unixctl_server_create(unixctl_path, &unixctl);
064af421 145 if (retval) {
4d12270a 146 exit(EXIT_FAILURE);
064af421
BP
147 }
148
95440284
BP
149 daemonize_complete();
150
064af421
BP
151 while (n_switches > 0 || n_listeners > 0) {
152 int iteration;
064af421
BP
153
154 /* Accept connections on listening vconns. */
155 for (i = 0; i < n_listeners && n_switches < MAX_SWITCHES; ) {
156 struct vconn *new_vconn;
064af421
BP
157
158 retval = pvconn_accept(listeners[i], OFP_VERSION, &new_vconn);
159 if (!retval || retval == EAGAIN) {
160 if (!retval) {
58bdd092 161 new_switch(&switches[n_switches++], new_vconn);
064af421
BP
162 }
163 i++;
164 } else {
165 pvconn_close(listeners[i]);
166 listeners[i] = listeners[--n_listeners];
167 }
168 }
169
170 /* Do some switching work. Limit the number of iterations so that
171 * callbacks registered with the poll loop don't starve. */
172 for (iteration = 0; iteration < 50; iteration++) {
173 bool progress = false;
174 for (i = 0; i < n_switches; ) {
175 struct switch_ *this = &switches[i];
2a022368
BP
176
177 retval = do_switching(this);
064af421
BP
178 if (!retval || retval == EAGAIN) {
179 if (!retval) {
180 progress = true;
181 }
182 i++;
183 } else {
184 rconn_destroy(this->rconn);
185 lswitch_destroy(this->lswitch);
186 switches[i] = switches[--n_switches];
187 }
188 }
189 if (!progress) {
190 break;
191 }
192 }
193 for (i = 0; i < n_switches; i++) {
194 struct switch_ *this = &switches[i];
ba186119 195 lswitch_run(this->lswitch);
064af421
BP
196 }
197
198 unixctl_server_run(unixctl);
199
200 /* Wait for something to happen. */
201 if (n_switches < MAX_SWITCHES) {
202 for (i = 0; i < n_listeners; i++) {
203 pvconn_wait(listeners[i]);
204 }
205 }
206 for (i = 0; i < n_switches; i++) {
207 struct switch_ *sw = &switches[i];
208 rconn_run_wait(sw->rconn);
209 rconn_recv_wait(sw->rconn);
210 lswitch_wait(sw->lswitch);
211 }
212 unixctl_server_wait(unixctl);
213 poll_block();
214 }
215
216 return 0;
217}
218
219static void
58bdd092 220new_switch(struct switch_ *sw, struct vconn *vconn)
064af421 221{
ad67e568
BP
222 struct lswitch_config cfg;
223
9794e806 224 sw->rconn = rconn_create(60, 0);
eb15cdbb 225 rconn_connect_unreliably(sw->rconn, vconn, NULL);
882c2399 226
ad67e568
BP
227 cfg.mode = (action_normal ? LSW_NORMAL
228 : learn_macs ? LSW_LEARN
229 : LSW_FLOOD);
230 cfg.max_idle = set_up_flows ? max_idle : -1;
b3907fbc 231 cfg.default_flows = &default_flows;
d4cdc6b4
BP
232 cfg.default_queue = default_queue;
233 cfg.port_queues = &port_queues;
ad67e568 234 sw->lswitch = lswitch_create(sw->rconn, &cfg);
064af421
BP
235}
236
237static int
238do_switching(struct switch_ *sw)
239{
240 unsigned int packets_sent;
241 struct ofpbuf *msg;
242
243 packets_sent = rconn_packets_sent(sw->rconn);
244
245 msg = rconn_recv(sw->rconn);
246 if (msg) {
7778bd15
BP
247 if (!mute) {
248 lswitch_process_packet(sw->lswitch, sw->rconn, msg);
249 }
064af421
BP
250 ofpbuf_delete(msg);
251 }
252 rconn_run(sw->rconn);
253
254 return (!rconn_is_alive(sw->rconn) ? EOF
255 : rconn_packets_sent(sw->rconn) != packets_sent ? 0
256 : EAGAIN);
257}
258
09913dfd
BP
259static void
260read_flow_file(const char *name)
261{
88ca35ee 262 enum nx_flow_format flow_format;
09913dfd
BP
263 FILE *stream;
264
265 stream = fopen(optarg, "r");
266 if (!stream) {
267 ovs_fatal(errno, "%s: open", name);
268 }
269
88ca35ee 270 flow_format = NXFF_OPENFLOW10;
02c5617b
BP
271 while (parse_ofp_flow_mod_file(&default_flows, &flow_format, stream,
272 OFPFC_ADD)) {
88ca35ee 273 continue;
09913dfd
BP
274 }
275
276 fclose(stream);
277}
278
d4cdc6b4
BP
279static void
280add_port_queue(char *s)
281{
282 char *save_ptr = NULL;
283 char *port_name;
284 char *queue_id;
285
286 port_name = strtok_r(s, ":", &save_ptr);
287 queue_id = strtok_r(NULL, "", &save_ptr);
288 if (!queue_id) {
289 ovs_fatal(0, "argument to -Q or --port-queue should take the form "
290 "\"<port-name>:<queue-id>\"");
291 }
292
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 "
296 "be unique");
297 }
298}
299
064af421
BP
300static void
301parse_options(int argc, char *argv[])
302{
303 enum {
304 OPT_MAX_IDLE = UCHAR_MAX + 1,
305 OPT_PEER_CA_CERT,
7778bd15 306 OPT_MUTE,
882c2399 307 OPT_WITH_FLOWS,
b66bdf30 308 OPT_UNIXCTL,
8274ae95
BP
309 VLOG_OPTION_ENUMS,
310 DAEMON_OPTION_ENUMS
064af421
BP
311 };
312 static struct option long_options[] = {
313 {"hub", no_argument, 0, 'H'},
314 {"noflow", no_argument, 0, 'n'},
9af9e2e8
JT
315 {"normal", no_argument, 0, 'N'},
316 {"wildcard", no_argument, 0, 'w'},
064af421 317 {"max-idle", required_argument, 0, OPT_MAX_IDLE},
7778bd15 318 {"mute", no_argument, 0, OPT_MUTE},
611e9a35 319 {"queue", required_argument, 0, 'q'},
d4cdc6b4 320 {"port-queue", required_argument, 0, 'Q'},
882c2399 321 {"with-flows", required_argument, 0, OPT_WITH_FLOWS},
b66bdf30 322 {"unixctl", required_argument, 0, OPT_UNIXCTL},
064af421
BP
323 {"help", no_argument, 0, 'h'},
324 {"version", no_argument, 0, 'V'},
325 DAEMON_LONG_OPTIONS,
326 VLOG_LONG_OPTIONS,
bf8f2167 327 STREAM_SSL_LONG_OPTIONS,
064af421 328 {"peer-ca-cert", required_argument, 0, OPT_PEER_CA_CERT},
064af421
BP
329 {0, 0, 0, 0},
330 };
331 char *short_options = long_options_to_short_options(long_options);
332
333 for (;;) {
334 int indexptr;
335 int c;
336
337 c = getopt_long(argc, argv, short_options, long_options, &indexptr);
338 if (c == -1) {
339 break;
340 }
341
342 switch (c) {
343 case 'H':
344 learn_macs = false;
345 break;
346
347 case 'n':
d6fbec6d 348 set_up_flows = false;
064af421
BP
349 break;
350
7778bd15
BP
351 case OPT_MUTE:
352 mute = true;
353 break;
354
9af9e2e8
JT
355 case 'N':
356 action_normal = true;
357 break;
358
359 case 'w':
360 exact_flows = false;
361 break;
362
064af421
BP
363 case OPT_MAX_IDLE:
364 if (!strcmp(optarg, "permanent")) {
365 max_idle = OFP_FLOW_PERMANENT;
366 } else {
367 max_idle = atoi(optarg);
368 if (max_idle < 1 || max_idle > 65535) {
369 ovs_fatal(0, "--max-idle argument must be between 1 and "
370 "65535 or the word 'permanent'");
371 }
372 }
373 break;
374
611e9a35 375 case 'q':
d4cdc6b4
BP
376 default_queue = atoi(optarg);
377 break;
378
379 case 'Q':
380 add_port_queue(optarg);
611e9a35
BP
381 break;
382
882c2399 383 case OPT_WITH_FLOWS:
09913dfd 384 read_flow_file(optarg);
882c2399
JP
385 break;
386
b66bdf30
BP
387 case OPT_UNIXCTL:
388 unixctl_path = optarg;
389 break;
390
064af421
BP
391 case 'h':
392 usage();
393
394 case 'V':
395 OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
396 exit(EXIT_SUCCESS);
397
398 VLOG_OPTION_HANDLERS
399 DAEMON_OPTION_HANDLERS
400
fe55ad15 401 STREAM_SSL_OPTION_HANDLERS
064af421
BP
402
403 case OPT_PEER_CA_CERT:
fe55ad15 404 stream_ssl_set_peer_ca_cert_file(optarg);
064af421 405 break;
064af421
BP
406
407 case '?':
408 exit(EXIT_FAILURE);
409
410 default:
411 abort();
412 }
413 }
414 free(short_options);
d4cdc6b4
BP
415
416 if (!shash_is_empty(&port_queues) || default_queue != UINT32_MAX) {
417 if (action_normal) {
418 ovs_error(0, "queue IDs are incompatible with -N or --normal; "
419 "not using OFPP_NORMAL");
420 action_normal = false;
421 }
422
423 if (!learn_macs) {
424 ovs_error(0, "queue IDs are incompatible with -H or --hub; "
425 "not acting as hub");
426 learn_macs = true;
427 }
428 }
064af421
BP
429}
430
431static void
432usage(void)
433{
434 printf("%s: OpenFlow controller\n"
435 "usage: %s [OPTIONS] METHOD\n"
436 "where METHOD is any OpenFlow connection method.\n",
437 program_name, program_name);
438 vconn_usage(true, true, false);
439 daemon_usage();
440 vlog_usage();
441 printf("\nOther options:\n"
442 " -H, --hub act as hub instead of learning switch\n"
443 " -n, --noflow pass traffic, but don't add flows\n"
444 " --max-idle=SECS max idle time for new flows\n"
d4cdc6b4 445 " -N, --normal use OFPP_NORMAL action\n"
9af9e2e8 446 " -w, --wildcard use wildcards, not exact-match rules\n"
d4cdc6b4
BP
447 " -q, --queue=QUEUE-ID OpenFlow queue ID to use for output\n"
448 " -Q PORT-NAME:QUEUE-ID use QUEUE-ID for frames from PORT-NAME\n"
882c2399 449 " --with-flows FILE use the flows from FILE\n"
b66bdf30 450 " --unixctl=SOCKET override default control socket name\n"
064af421
BP
451 " -h, --help display this help message\n"
452 " -V, --version display version information\n");
453 exit(EXIT_SUCCESS);
454}