controller/controller.c

   1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   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:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  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
  27  * SOFTWARE.
  28  *
  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.
  32  */
  33
  34 #include <config.h>
  35
  36 #include <errno.h>
  37 #include <getopt.h>
  38 #include <limits.h>
  39 #include <signal.h>
  40 #include <stdlib.h>
  41 #include <string.h>
  42
  43 #include "buffer.h"
  44 #include "command-line.h"
  45 #include "compiler.h"
  46 #include "daemon.h"
  47 #include "fault.h"
  48 #include "learning-switch.h"
  49 #include "openflow.h"
  50 #include "poll-loop.h"
  51 #include "rconn.h"
  52 #include "timeval.h"
  53 #include "util.h"
  54 #include "vconn-ssl.h"
  55 #include "vconn.h"
  56 #include "vlog-socket.h"
  57
  58 #include "vlog.h"
  59 #define THIS_MODULE VLM_controller
  60
  61 #define MAX_SWITCHES 16
  62 #define MAX_LISTENERS 16
  63
  64 struct switch_ {
  65     struct lswitch *lswitch;
  66     struct rconn *rconn;
  67 };
  68
  69 /* Learn the ports on which MAC addresses appear? */
  70 static bool learn_macs = true;
  71
  72 /* Set up flows?  (If not, every packet is processed at the controller.) */
  73 static bool setup_flows = true;
  74
  75 /* --max-idle: Maximum idle time, in seconds, before flows expire. */
  76 static int max_idle = 60;
  77
  78 static int do_switching(struct switch_ *);
  79 static void new_switch(struct switch_ *, struct vconn *, const char *name);
  80 static void parse_options(int argc, char *argv[]);
  81 static void usage(void) NO_RETURN;
  82
  83 int
  84 main(int argc, char *argv[])
  85 {
  86     struct switch_ switches[MAX_SWITCHES];
  87     struct pvconn *listeners[MAX_LISTENERS];
  88     int n_switches, n_listeners;
  89     int retval;
  90     int i;
  91
  92     set_program_name(argv[0]);
  93     register_fault_handlers();
  94     time_init();
  95     vlog_init();
  96     parse_options(argc, argv);
  97     signal(SIGPIPE, SIG_IGN);
  98
  99     if (argc - optind < 1) {
 100         fatal(0, "at least one vconn argument required; use --help for usage");
 101     }
 102
 103     retval = vlog_server_listen(NULL, NULL);
 104     if (retval) {
 105         fatal(retval, "Could not listen for vlog connections");
 106     }
 107
 108     n_switches = n_listeners = 0;
 109     for (i = optind; i < argc; i++) {
 110         const char *name = argv[i];
 111         struct vconn *vconn;
 112         int retval;
 113
 114         retval = vconn_open(name, OFP_VERSION, &vconn);
 115         if (!retval) {
 116             if (n_switches >= MAX_SWITCHES) {
 117                 fatal(0, "max %d switch connections", n_switches);
 118             }
 119             new_switch(&switches[n_switches++], vconn, name);
 120             continue;
 121         } else if (retval == EAFNOSUPPORT) {
 122             struct pvconn *pvconn;
 123             retval = pvconn_open(name, &pvconn);
 124             if (!retval) {
 125                 if (n_listeners >= MAX_LISTENERS) {
 126                     fatal(0, "max %d passive connections", n_listeners);
 127                 }
 128                 listeners[n_listeners++] = pvconn;
 129             }
 130         }
 131         if (retval) {
 132             VLOG_ERR("%s: connect: %s", name, strerror(retval));
 133         }
 134     }
 135     if (n_switches == 0 && n_listeners == 0) {
 136         fatal(0, "no active or passive switch connections");
 137     }
 138
 139     die_if_already_running();
 140     daemonize();
 141
 142     while (n_switches > 0 || n_listeners > 0) {
 143         int iteration;
 144         int i;
 145
 146         /* Accept connections on listening vconns. */
 147         for (i = 0; i < n_listeners && n_switches < MAX_SWITCHES; ) {
 148             struct vconn *new_vconn;
 149             int retval;
 150
 151             retval = pvconn_accept(listeners[i], OFP_VERSION, &new_vconn);
 152             if (!retval || retval == EAGAIN) {
 153                 if (!retval) {
 154                     new_switch(&switches[n_switches++], new_vconn, "tcp");
 155                 }
 156                 i++;
 157             } else {
 158                 pvconn_close(listeners[i]);
 159                 listeners[i] = listeners[--n_listeners];
 160             }
 161         }
 162
 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) {
 171                     if (!retval) {
 172                         progress = true;
 173                     }
 174                     i++;
 175                 } else {
 176                     lswitch_destroy(this->lswitch);
 177                     rconn_destroy(this->rconn);
 178                     switches[i] = switches[--n_switches];
 179                 }
 180             }
 181             if (!progress) {
 182                 break;
 183             }
 184         }
 185
 186         /* Wait for something to happen. */
 187         if (n_switches < MAX_SWITCHES) {
 188             for (i = 0; i < n_listeners; i++) {
 189                 pvconn_wait(listeners[i]);
 190             }
 191         }
 192         for (i = 0; i < n_switches; i++) {
 193             struct switch_ *sw = &switches[i];
 194             rconn_run_wait(sw->rconn);
 195             rconn_recv_wait(sw->rconn);
 196         }
 197         poll_block();
 198     }
 199
 200     return 0;
 201 }
 202
 203 static void
 204 new_switch(struct switch_ *sw, struct vconn *vconn, const char *name)
 205 {
 206     sw->rconn = rconn_new_from_vconn(name, vconn);
 207     sw->lswitch = lswitch_create(sw->rconn, learn_macs,
 208                                  setup_flows ? max_idle : -1);
 209 }
 210
 211 static int
 212 do_switching(struct switch_ *sw)
 213 {
 214     unsigned int packets_sent;
 215     struct buffer *msg;
 216
 217     packets_sent = rconn_packets_sent(sw->rconn);
 218
 219     msg = rconn_recv(sw->rconn);
 220     if (msg) {
 221         lswitch_process_packet(sw->lswitch, sw->rconn, msg);
 222         buffer_delete(msg);
 223     }
 224     rconn_run(sw->rconn);
 225
 226     return (!rconn_is_alive(sw->rconn) ? EOF
 227             : rconn_packets_sent(sw->rconn) != packets_sent ? 0
 228             : EAGAIN);
 229 }
 230
 231 static void
 232 parse_options(int argc, char *argv[])
 233 {
 234     enum { OPT_MAX_IDLE = UCHAR_MAX + 1 };
 235     static struct option long_options[] = {
 236         {"detach",      no_argument, 0, 'D'},
 237         {"pidfile",     optional_argument, 0, 'P'},
 238         {"force",       no_argument, 0, 'f'},
 239         {"hub",         no_argument, 0, 'H'},
 240         {"noflow",      no_argument, 0, 'n'},
 241         {"max-idle",    required_argument, 0, OPT_MAX_IDLE},
 242         {"verbose",     optional_argument, 0, 'v'},
 243         {"help",        no_argument, 0, 'h'},
 244         {"version",     no_argument, 0, 'V'},
 245         VCONN_SSL_LONG_OPTIONS
 246         {0, 0, 0, 0},
 247     };
 248     char *short_options = long_options_to_short_options(long_options);
 249
 250     for (;;) {
 251         int indexptr;
 252         int c;
 253
 254         c = getopt_long(argc, argv, short_options, long_options, &indexptr);
 255         if (c == -1) {
 256             break;
 257         }
 258
 259         switch (c) {
 260         case 'D':
 261             set_detach();
 262             break;
 263
 264         case 'P':
 265             set_pidfile(optarg);
 266             break;
 267
 268         case 'f':
 269             ignore_existing_pidfile();
 270             break;
 271
 272         case 'H':
 273             learn_macs = false;
 274             break;
 275
 276         case 'n':
 277             setup_flows = false;
 278             break;
 279
 280         case OPT_MAX_IDLE:
 281             if (!strcmp(optarg, "permanent")) {
 282                 max_idle = OFP_FLOW_PERMANENT;
 283             } else {
 284                 max_idle = atoi(optarg);
 285                 if (max_idle < 1 || max_idle > 65535) {
 286                     fatal(0, "--max-idle argument must be between 1 and "
 287                           "65535 or the word 'permanent'");
 288                 }
 289             }
 290             break;
 291
 292         case 'h':
 293             usage();
 294
 295         case 'V':
 296             printf("%s "VERSION" compiled "__DATE__" "__TIME__"\n", argv[0]);
 297             exit(EXIT_SUCCESS);
 298
 299         case 'v':
 300             vlog_set_verbosity(optarg);
 301             break;
 302
 303         VCONN_SSL_OPTION_HANDLERS
 304
 305         case '?':
 306             exit(EXIT_FAILURE);
 307
 308         default:
 309             abort();
 310         }
 311     }
 312     free(short_options);
 313 }
 314
 315 static void
 316 usage(void)
 317 {
 318     printf("%s: OpenFlow controller\n"
 319            "usage: %s [OPTIONS] METHOD\n"
 320            "where METHOD is any OpenFlow connection method.\n",
 321            program_name, program_name);
 322     vconn_usage(true, true);
 323     printf("\nOther options:\n"
 324            "  -D, --detach            run in background as daemon\n"
 325            "  -P, --pidfile[=FILE]    create pidfile (default: %s/controller.pid)\n"
 326            "  -f, --force             with -P, start even if already running\n"
 327            "  -H, --hub               act as hub instead of learning switch\n"
 328            "  -n, --noflow            pass traffic, but don't add flows\n"
 329            "  --max-idle=SECS         max idle time for new flows\n"
 330            "  -v, --verbose=MODULE[:FACILITY[:LEVEL]]  set logging levels\n"
 331            "  -v, --verbose           set maximum verbosity level\n"
 332            "  -h, --help              display this help message\n"
 333            "  -V, --version           display version information\n",
 334            RUNDIR);
 335     exit(EXIT_SUCCESS);
 336 }