utilities/ovs-controller.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011 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: 0 to disable wildcard flow entries, a OFPFW_* bitmask to
  65  * enable specific wildcards, or UINT32_MAX to use the default wildcards. */
  66 static uint32_t wildcards = 0;
  67
  68 /* --max-idle: Maximum idle time, in seconds, before flows expire. */
  69 static int max_idle = 60;
  70
  71 /* --mute: If true, accept connections from switches but do not reply to any
  72  * of their messages (for debugging fail-open mode). */
  73 static bool mute = false;
  74
  75 /* -q, --queue: default OpenFlow queue, none if UINT32_MAX. */
  76 static uint32_t default_queue = UINT32_MAX;
  77
  78 /* -Q, --port-queue: map from port name to port number (cast to void *). */
  79 static struct shash port_queues = SHASH_INITIALIZER(&port_queues);
  80
  81 /* --with-flows: Flows to send to switch. */
  82 static struct ofputil_flow_mod *default_flows;
  83 static size_t n_default_flows;
  84
  85 /* --unixctl: Name of unixctl socket, or null to use the default. */
  86 static char *unixctl_path = NULL;
  87
  88 static int do_switching(struct switch_ *);
  89 static void new_switch(struct switch_ *, struct vconn *);
  90 static void parse_options(int argc, char *argv[]);
  91 static void usage(void) NO_RETURN;
  92
  93 int
  94 main(int argc, char *argv[])
  95 {
  96     struct unixctl_server *unixctl;
  97     struct switch_ switches[MAX_SWITCHES];
  98     struct pvconn *listeners[MAX_LISTENERS];
  99     int n_switches, n_listeners;
 100     int retval;
 101     int i;
 102
 103     proctitle_init(argc, argv);
 104     set_program_name(argv[0]);
 105     parse_options(argc, argv);
 106     signal(SIGPIPE, SIG_IGN);
 107
 108     if (argc - optind < 1) {
 109         ovs_fatal(0, "at least one vconn argument required; "
 110                   "use --help for usage");
 111     }
 112
 113     n_switches = n_listeners = 0;
 114     for (i = optind; i < argc; i++) {
 115         const char *name = argv[i];
 116         struct vconn *vconn;
 117
 118         retval = vconn_open(name, OFP10_VERSION, &vconn);
 119         if (!retval) {
 120             if (n_switches >= MAX_SWITCHES) {
 121                 ovs_fatal(0, "max %d switch connections", n_switches);
 122             }
 123             new_switch(&switches[n_switches++], vconn);
 124             continue;
 125         } else if (retval == EAFNOSUPPORT) {
 126             struct pvconn *pvconn;
 127             retval = pvconn_open(name, &pvconn);
 128             if (!retval) {
 129                 if (n_listeners >= MAX_LISTENERS) {
 130                     ovs_fatal(0, "max %d passive connections", n_listeners);
 131                 }
 132                 listeners[n_listeners++] = pvconn;
 133             }
 134         }
 135         if (retval) {
 136             VLOG_ERR("%s: connect: %s", name, strerror(retval));
 137         }
 138     }
 139     if (n_switches == 0 && n_listeners == 0) {
 140         ovs_fatal(0, "no active or passive switch connections");
 141     }
 142
 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], OFP10_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.wildcards = wildcards;
 232     cfg.max_idle = set_up_flows ? max_idle : -1;
 233     cfg.default_flows = default_flows;
 234     cfg.n_default_flows = n_default_flows;
 235     cfg.default_queue = default_queue;
 236     cfg.port_queues = &port_queues;
 237     sw->lswitch = lswitch_create(sw->rconn, &cfg);
 238 }
 239
 240 static int
 241 do_switching(struct switch_ *sw)
 242 {
 243     unsigned int packets_sent;
 244     struct ofpbuf *msg;
 245
 246     packets_sent = rconn_packets_sent(sw->rconn);
 247
 248     msg = rconn_recv(sw->rconn);
 249     if (msg) {
 250         if (!mute) {
 251             lswitch_process_packet(sw->lswitch, sw->rconn, msg);
 252         }
 253         ofpbuf_delete(msg);
 254     }
 255     rconn_run(sw->rconn);
 256
 257     return (!rconn_is_alive(sw->rconn) ? EOF
 258             : rconn_packets_sent(sw->rconn) != packets_sent ? 0
 259             : EAGAIN);
 260 }
 261
 262 static void
 263 add_port_queue(char *s)
 264 {
 265     char *save_ptr = NULL;
 266     char *port_name;
 267     char *queue_id;
 268
 269     port_name = strtok_r(s, ":", &save_ptr);
 270     queue_id = strtok_r(NULL, "", &save_ptr);
 271     if (!queue_id) {
 272         ovs_fatal(0, "argument to -Q or --port-queue should take the form "
 273                   "\"<port-name>:<queue-id>\"");
 274     }
 275
 276     if (!shash_add_once(&port_queues, port_name,
 277                         (void *) (uintptr_t) atoi(queue_id))) {
 278         ovs_fatal(0, "<port-name> arguments for -Q or --port-queue must "
 279                   "be unique");
 280     }
 281 }
 282
 283 static void
 284 parse_options(int argc, char *argv[])
 285 {
 286     enum {
 287         OPT_MAX_IDLE = UCHAR_MAX + 1,
 288         OPT_PEER_CA_CERT,
 289         OPT_MUTE,
 290         OPT_WITH_FLOWS,
 291         OPT_UNIXCTL,
 292         VLOG_OPTION_ENUMS,
 293         DAEMON_OPTION_ENUMS
 294     };
 295     static struct option long_options[] = {
 296         {"hub",         no_argument, NULL, 'H'},
 297         {"noflow",      no_argument, NULL, 'n'},
 298         {"normal",      no_argument, NULL, 'N'},
 299         {"wildcards",   optional_argument, NULL, 'w'},
 300         {"max-idle",    required_argument, NULL, OPT_MAX_IDLE},
 301         {"mute",        no_argument, NULL, OPT_MUTE},
 302         {"queue",       required_argument, NULL, 'q'},
 303         {"port-queue",  required_argument, NULL, 'Q'},
 304         {"with-flows",  required_argument, NULL, OPT_WITH_FLOWS},
 305         {"unixctl",     required_argument, NULL, OPT_UNIXCTL},
 306         {"help",        no_argument, NULL, 'h'},
 307         {"version",     no_argument, NULL, 'V'},
 308         DAEMON_LONG_OPTIONS,
 309         VLOG_LONG_OPTIONS,
 310         STREAM_SSL_LONG_OPTIONS,
 311         {"peer-ca-cert", required_argument, NULL, OPT_PEER_CA_CERT},
 312         {NULL, 0, NULL, 0},
 313     };
 314     char *short_options = long_options_to_short_options(long_options);
 315
 316     for (;;) {
 317         int indexptr;
 318         int c;
 319
 320         c = getopt_long(argc, argv, short_options, long_options, &indexptr);
 321         if (c == -1) {
 322             break;
 323         }
 324
 325         switch (c) {
 326         case 'H':
 327             learn_macs = false;
 328             break;
 329
 330         case 'n':
 331             set_up_flows = false;
 332             break;
 333
 334         case OPT_MUTE:
 335             mute = true;
 336             break;
 337
 338         case 'N':
 339             action_normal = true;
 340             break;
 341
 342         case 'w':
 343             wildcards = optarg ? strtol(optarg, NULL, 16) : UINT32_MAX;
 344             break;
 345
 346         case OPT_MAX_IDLE:
 347             if (!strcmp(optarg, "permanent")) {
 348                 max_idle = OFP_FLOW_PERMANENT;
 349             } else {
 350                 max_idle = atoi(optarg);
 351                 if (max_idle < 1 || max_idle > 65535) {
 352                     ovs_fatal(0, "--max-idle argument must be between 1 and "
 353                               "65535 or the word 'permanent'");
 354                 }
 355             }
 356             break;
 357
 358         case 'q':
 359             default_queue = atoi(optarg);
 360             break;
 361
 362         case 'Q':
 363             add_port_queue(optarg);
 364             break;
 365
 366         case OPT_WITH_FLOWS:
 367             parse_ofp_flow_mod_file(optarg, OFPFC_ADD, &default_flows,
 368                                     &n_default_flows);
 369             break;
 370
 371         case OPT_UNIXCTL:
 372             unixctl_path = optarg;
 373             break;
 374
 375         case 'h':
 376             usage();
 377
 378         case 'V':
 379             ovs_print_version(OFP10_VERSION, OFP10_VERSION);
 380             exit(EXIT_SUCCESS);
 381
 382         VLOG_OPTION_HANDLERS
 383         DAEMON_OPTION_HANDLERS
 384
 385         STREAM_SSL_OPTION_HANDLERS
 386
 387         case OPT_PEER_CA_CERT:
 388             stream_ssl_set_peer_ca_cert_file(optarg);
 389             break;
 390
 391         case '?':
 392             exit(EXIT_FAILURE);
 393
 394         default:
 395             abort();
 396         }
 397     }
 398     free(short_options);
 399
 400     if (!shash_is_empty(&port_queues) || default_queue != UINT32_MAX) {
 401         if (action_normal) {
 402             ovs_error(0, "queue IDs are incompatible with -N or --normal; "
 403                       "not using OFPP_NORMAL");
 404             action_normal = false;
 405         }
 406
 407         if (!learn_macs) {
 408             ovs_error(0, "queue IDs are incompatible with -H or --hub; "
 409                       "not acting as hub");
 410             learn_macs = true;
 411         }
 412     }
 413 }
 414
 415 static void
 416 usage(void)
 417 {
 418     printf("%s: OpenFlow controller\n"
 419            "usage: %s [OPTIONS] METHOD\n"
 420            "where METHOD is any OpenFlow connection method.\n",
 421            program_name, program_name);
 422     vconn_usage(true, true, false);
 423     daemon_usage();
 424     vlog_usage();
 425     printf("\nOther options:\n"
 426            "  -H, --hub               act as hub instead of learning switch\n"
 427            "  -n, --noflow            pass traffic, but don't add flows\n"
 428            "  --max-idle=SECS         max idle time for new flows\n"
 429            "  -N, --normal            use OFPP_NORMAL action\n"
 430            "  -w, --wildcards[=MASK]  wildcard (specified) bits in flows\n"
 431            "  -q, --queue=QUEUE-ID    OpenFlow queue ID to use for output\n"
 432            "  -Q PORT-NAME:QUEUE-ID   use QUEUE-ID for frames from PORT-NAME\n"
 433            "  --with-flows FILE       use the flows from FILE\n"
 434            "  --unixctl=SOCKET        override default control socket name\n"
 435            "  -h, --help              display this help message\n"
 436            "  -V, --version           display version information\n");
 437     exit(EXIT_SUCCESS);
 438 }