ovs-controller: Improve QoS abilities.
[sliver-openvswitch.git] / utilities / ovs-controller.c
1 /*
2  * Copyright (c) 2008, 2009, 2010 Nicira Networks.
3  *
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:
7  *
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.
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>
24 #include <stdio.h>
25 #include <string.h>
26
27 #include "command-line.h"
28 #include "compiler.h"
29 #include "daemon.h"
30 #include "learning-switch.h"
31 #include "ofp-parse.h"
32 #include "ofpbuf.h"
33 #include "openflow/openflow.h"
34 #include "poll-loop.h"
35 #include "rconn.h"
36 #include "shash.h"
37 #include "stream-ssl.h"
38 #include "timeval.h"
39 #include "unixctl.h"
40 #include "util.h"
41 #include "vconn.h"
42 #include "vlog.h"
43
44 VLOG_DEFINE_THIS_MODULE(controller)
45
46 #define MAX_SWITCHES 16
47 #define MAX_LISTENERS 16
48
49 struct switch_ {
50     struct lswitch *lswitch;
51     struct rconn *rconn;
52 };
53
54 /* -H, --hub: Learn the ports on which MAC addresses appear? */
55 static bool learn_macs = true;
56
57 /* -n, --noflow: Set up flows?  (If not, every packet is processed at the
58  * controller.) */
59 static bool set_up_flows = true;
60
61 /* -N, --normal: Use "NORMAL" action instead of explicit port? */
62 static bool action_normal = false;
63
64 /* -w, --wildcard: Set up exact match or wildcard flow entries? */
65 static bool exact_flows = true;
66
67 /* --max-idle: Maximum idle time, in seconds, before flows expire. */
68 static int max_idle = 60;
69
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;
73
74 /* -q, --queue: default OpenFlow queue, none if UINT32_MAX. */
75 static uint32_t default_queue = UINT32_MAX;
76
77 /* -Q, --port-queue: map from port name to port number (cast to void *). */
78 static struct shash port_queues = SHASH_INITIALIZER(&port_queues);
79
80 /* --with-flows: File with flows to send to switch, or null to not load
81  * any default flows. */
82 static struct ovs_queue default_flows = OVS_QUEUE_INITIALIZER;
83
84 /* --unixctl: Name of unixctl socket, or null to use the default. */
85 static char *unixctl_path = NULL;
86
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;
91
92 int
93 main(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
102     proctitle_init(argc, argv);
103     set_program_name(argv[0]);
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;
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             }
122             new_switch(&switches[n_switches++], vconn);
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
142     die_if_already_running();
143     daemonize_start();
144
145     retval = unixctl_server_create(unixctl_path, &unixctl);
146     if (retval) {
147         exit(EXIT_FAILURE);
148     }
149
150     daemonize_complete();
151
152     while (n_switches > 0 || n_listeners > 0) {
153         int iteration;
154
155         /* Accept connections on listening vconns. */
156         for (i = 0; i < n_listeners && n_switches < MAX_SWITCHES; ) {
157             struct vconn *new_vconn;
158
159             retval = pvconn_accept(listeners[i], OFP_VERSION, &new_vconn);
160             if (!retval || retval == EAGAIN) {
161                 if (!retval) {
162                     new_switch(&switches[n_switches++], new_vconn);
163                 }
164                 i++;
165             } else {
166                 pvconn_close(listeners[i]);
167                 listeners[i] = listeners[--n_listeners];
168             }
169         }
170
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];
177
178                 retval = do_switching(this);
179                 if (!retval || retval == EAGAIN) {
180                     if (!retval) {
181                         progress = true;
182                     }
183                     i++;
184                 } else {
185                     rconn_destroy(this->rconn);
186                     lswitch_destroy(this->lswitch);
187                     switches[i] = switches[--n_switches];
188                 }
189             }
190             if (!progress) {
191                 break;
192             }
193         }
194         for (i = 0; i < n_switches; i++) {
195             struct switch_ *this = &switches[i];
196             lswitch_run(this->lswitch);
197         }
198
199         unixctl_server_run(unixctl);
200
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]);
205             }
206         }
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);
212         }
213         unixctl_server_wait(unixctl);
214         poll_block();
215     }
216
217     return 0;
218 }
219
220 static void
221 new_switch(struct switch_ *sw, struct vconn *vconn)
222 {
223     struct lswitch_config cfg;
224
225     sw->rconn = rconn_create(60, 0);
226     rconn_connect_unreliably(sw->rconn, vconn, NULL);
227
228     cfg.mode = (action_normal ? LSW_NORMAL
229                 : learn_macs ? LSW_LEARN
230                 : LSW_FLOOD);
231     cfg.max_idle = set_up_flows ? max_idle : -1;
232     cfg.default_flows = default_flows.head;
233     cfg.default_queue = default_queue;
234     cfg.port_queues = &port_queues;
235     sw->lswitch = lswitch_create(sw->rconn, &cfg);
236 }
237
238 static int
239 do_switching(struct switch_ *sw)
240 {
241     unsigned int packets_sent;
242     struct ofpbuf *msg;
243
244     packets_sent = rconn_packets_sent(sw->rconn);
245
246     msg = rconn_recv(sw->rconn);
247     if (msg) {
248         if (!mute) {
249             lswitch_process_packet(sw->lswitch, sw->rconn, msg);
250         }
251         ofpbuf_delete(msg);
252     }
253     rconn_run(sw->rconn);
254
255     return (!rconn_is_alive(sw->rconn) ? EOF
256             : rconn_packets_sent(sw->rconn) != packets_sent ? 0
257             : EAGAIN);
258 }
259
260 static void
261 read_flow_file(const char *name)
262 {
263     struct ofpbuf *b;
264     FILE *stream;
265
266     stream = fopen(optarg, "r");
267     if (!stream) {
268         ovs_fatal(errno, "%s: open", name);
269     }
270
271     while ((b = parse_ofp_add_flow_file(stream)) != NULL) {
272         queue_push_tail(&default_flows, b);
273     }
274
275     fclose(stream);
276 }
277
278 static void
279 add_port_queue(char *s)
280 {
281     char *save_ptr = NULL;
282     char *port_name;
283     char *queue_id;
284
285     port_name = strtok_r(s, ":", &save_ptr);
286     queue_id = strtok_r(NULL, "", &save_ptr);
287     if (!queue_id) {
288         ovs_fatal(0, "argument to -Q or --port-queue should take the form "
289                   "\"<port-name>:<queue-id>\"");
290     }
291
292     if (!shash_add_once(&port_queues, port_name,
293                         (void *) (uintptr_t) atoi(queue_id))) {
294         ovs_fatal(0, "<port-name> arguments for -Q or --port-queue must "
295                   "be unique");
296     }
297 }
298
299 static void
300 parse_options(int argc, char *argv[])
301 {
302     enum {
303         OPT_MAX_IDLE = UCHAR_MAX + 1,
304         OPT_PEER_CA_CERT,
305         OPT_MUTE,
306         OPT_WITH_FLOWS,
307         OPT_UNIXCTL,
308         VLOG_OPTION_ENUMS
309     };
310     static struct option long_options[] = {
311         {"hub",         no_argument, 0, 'H'},
312         {"noflow",      no_argument, 0, 'n'},
313         {"normal",      no_argument, 0, 'N'},
314         {"wildcard",    no_argument, 0, 'w'},
315         {"max-idle",    required_argument, 0, OPT_MAX_IDLE},
316         {"mute",        no_argument, 0, OPT_MUTE},
317         {"queue",       required_argument, 0, 'q'},
318         {"port-queue",  required_argument, 0, 'Q'},
319         {"with-flows",  required_argument, 0, OPT_WITH_FLOWS},
320         {"unixctl",     required_argument, 0, OPT_UNIXCTL},
321         {"help",        no_argument, 0, 'h'},
322         {"version",     no_argument, 0, 'V'},
323         DAEMON_LONG_OPTIONS,
324         VLOG_LONG_OPTIONS,
325 #ifdef HAVE_OPENSSL
326         STREAM_SSL_LONG_OPTIONS
327         {"peer-ca-cert", required_argument, 0, OPT_PEER_CA_CERT},
328 #endif
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':
348             set_up_flows = false;
349             break;
350
351         case OPT_MUTE:
352             mute = true;
353             break;
354
355         case 'N':
356             action_normal = true;
357             break;
358
359         case 'w':
360             exact_flows = false;
361             break;
362
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
375         case 'q':
376             default_queue = atoi(optarg);
377             break;
378
379         case 'Q':
380             add_port_queue(optarg);
381             break;
382
383         case OPT_WITH_FLOWS:
384             read_flow_file(optarg);
385             break;
386
387         case OPT_UNIXCTL:
388             unixctl_path = optarg;
389             break;
390
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
401 #ifdef HAVE_OPENSSL
402         STREAM_SSL_OPTION_HANDLERS
403
404         case OPT_PEER_CA_CERT:
405             stream_ssl_set_peer_ca_cert_file(optarg);
406             break;
407 #endif
408
409         case '?':
410             exit(EXIT_FAILURE);
411
412         default:
413             abort();
414         }
415     }
416     free(short_options);
417
418     if (!shash_is_empty(&port_queues) || default_queue != UINT32_MAX) {
419         if (action_normal) {
420             ovs_error(0, "queue IDs are incompatible with -N or --normal; "
421                       "not using OFPP_NORMAL");
422             action_normal = false;
423         }
424
425         if (!learn_macs) {
426             ovs_error(0, "queue IDs are incompatible with -H or --hub; "
427                       "not acting as hub");
428             learn_macs = true;
429         }
430     }
431 }
432
433 static void
434 usage(void)
435 {
436     printf("%s: OpenFlow controller\n"
437            "usage: %s [OPTIONS] METHOD\n"
438            "where METHOD is any OpenFlow connection method.\n",
439            program_name, program_name);
440     vconn_usage(true, true, false);
441     daemon_usage();
442     vlog_usage();
443     printf("\nOther options:\n"
444            "  -H, --hub               act as hub instead of learning switch\n"
445            "  -n, --noflow            pass traffic, but don't add flows\n"
446            "  --max-idle=SECS         max idle time for new flows\n"
447            "  -N, --normal            use OFPP_NORMAL action\n"
448            "  -w, --wildcard          use wildcards, not exact-match rules\n"
449            "  -q, --queue=QUEUE-ID    OpenFlow queue ID to use for output\n"
450            "  -Q PORT-NAME:QUEUE-ID   use QUEUE-ID for frames from PORT-NAME\n"
451            "  --with-flows FILE       use the flows from FILE\n"
452            "  --unixctl=SOCKET        override default control socket name\n"
453            "  -h, --help              display this help message\n"
454            "  -V, --version           display version information\n");
455     exit(EXIT_SUCCESS);
456 }