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 "command-line.h"
  44 #include "compiler.h"
  45 #include "daemon.h"
  46 #include "fault.h"
  47 #include "learning-switch.h"
  48 #include "ofpbuf.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         ofp_fatal(0, "at least one vconn argument required; "
 101                   "use --help for usage");
 102     }
 103
 104     retval = vlog_server_listen(NULL, NULL);
 105     if (retval) {
 106         ofp_fatal(retval, "Could not listen for vlog connections");
 107     }
 108
 109     n_switches = n_listeners = 0;
 110     for (i = optind; i < argc; i++) {
 111         const char *name = argv[i];
 112         struct vconn *vconn;
 113         int retval;
 114
 115         retval = vconn_open(name, OFP_VERSION, &vconn);
 116         if (!retval) {
 117             if (n_switches >= MAX_SWITCHES) {
 118                 ofp_fatal(0, "max %d switch connections", n_switches);
 119             }
 120             new_switch(&switches[n_switches++], vconn, name);
 121             continue;
 122         } else if (retval == EAFNOSUPPORT) {
 123             struct pvconn *pvconn;
 124             retval = pvconn_open(name, &pvconn);
 125             if (!retval) {
 126                 if (n_listeners >= MAX_LISTENERS) {
 127                     ofp_fatal(0, "max %d passive connections", n_listeners);
 128                 }
 129                 listeners[n_listeners++] = pvconn;
 130             }
 131         }
 132         if (retval) {
 133             VLOG_ERR("%s: connect: %s", name, strerror(retval));
 134         }
 135     }
 136     if (n_switches == 0 && n_listeners == 0) {
 137         ofp_fatal(0, "no active or passive switch connections");
 138     }
 139
 140     die_if_already_running();
 141     daemonize();
 142
 143     while (n_switches > 0 || n_listeners > 0) {
 144         int iteration;
 145         int i;
 146
 147         /* Accept connections on listening vconns. */
 148         for (i = 0; i < n_listeners && n_switches < MAX_SWITCHES; ) {
 149             struct vconn *new_vconn;
 150             int retval;
 151
 152             retval = pvconn_accept(listeners[i], OFP_VERSION, &new_vconn);
 153             if (!retval || retval == EAGAIN) {
 154                 if (!retval) {
 155                     new_switch(&switches[n_switches++], new_vconn, "tcp");
 156                 }
 157                 i++;
 158             } else {
 159                 pvconn_close(listeners[i]);
 160                 listeners[i] = listeners[--n_listeners];
 161             }
 162         }
 163
 164         /* Do some switching work.  Limit the number of iterations so that
 165          * callbacks registered with the poll loop don't starve. */
 166         for (iteration = 0; iteration < 50; iteration++) {
 167             bool progress = false;
 168             for (i = 0; i < n_switches; ) {
 169                 struct switch_ *this = &switches[i];
 170                 int retval = do_switching(this);
 171                 if (!retval || retval == EAGAIN) {
 172                     if (!retval) {
 173                         progress = true;
 174                     }
 175                     i++;
 176                 } else {
 177                     rconn_destroy(this->rconn);
 178                     lswitch_destroy(this->lswitch);
 179                     switches[i] = switches[--n_switches];
 180                 }
 181             }
 182             if (!progress) {
 183                 break;
 184             }
 185         }
 186         for (i = 0; i < n_switches; i++) {
 187             struct switch_ *this = &switches[i];
 188             lswitch_run(this->lswitch, this->rconn);
 189         }
 190
 191         /* Wait for something to happen. */
 192         if (n_switches < MAX_SWITCHES) {
 193             for (i = 0; i < n_listeners; i++) {
 194                 pvconn_wait(listeners[i]);
 195             }
 196         }
 197         for (i = 0; i < n_switches; i++) {
 198             struct switch_ *sw = &switches[i];
 199             rconn_run_wait(sw->rconn);
 200             rconn_recv_wait(sw->rconn);
 201             lswitch_wait(sw->lswitch);
 202         }
 203         poll_block();
 204     }
 205
 206     return 0;
 207 }
 208
 209 static void
 210 new_switch(struct switch_ *sw, struct vconn *vconn, const char *name)
 211 {
 212     sw->rconn = rconn_new_from_vconn(name, vconn);
 213     sw->lswitch = lswitch_create(sw->rconn, learn_macs,
 214                                  setup_flows ? max_idle : -1);
 215 }
 216
 217 static int
 218 do_switching(struct switch_ *sw)
 219 {
 220     unsigned int packets_sent;
 221     struct ofpbuf *msg;
 222
 223     packets_sent = rconn_packets_sent(sw->rconn);
 224
 225     msg = rconn_recv(sw->rconn);
 226     if (msg) {
 227         lswitch_process_packet(sw->lswitch, sw->rconn, msg);
 228         ofpbuf_delete(msg);
 229     }
 230     rconn_run(sw->rconn);
 231
 232     return (!rconn_is_alive(sw->rconn) ? EOF
 233             : rconn_packets_sent(sw->rconn) != packets_sent ? 0
 234             : EAGAIN);
 235 }
 236
 237 static void
 238 parse_options(int argc, char *argv[])
 239 {
 240     enum {
 241         OPT_MAX_IDLE = UCHAR_MAX + 1,
 242         OPT_PEER_CA_CERT
 243     };
 244     static struct option long_options[] = {
 245         {"detach",      no_argument, 0, 'D'},
 246         {"pidfile",     optional_argument, 0, 'P'},
 247         {"force",       no_argument, 0, 'f'},
 248         {"hub",         no_argument, 0, 'H'},
 249         {"noflow",      no_argument, 0, 'n'},
 250         {"max-idle",    required_argument, 0, OPT_MAX_IDLE},
 251         {"verbose",     optional_argument, 0, 'v'},
 252         {"help",        no_argument, 0, 'h'},
 253         {"version",     no_argument, 0, 'V'},
 254 #ifdef HAVE_OPENSSL
 255         VCONN_SSL_LONG_OPTIONS
 256         {"peer-ca-cert", required_argument, 0, OPT_PEER_CA_CERT},
 257 #endif
 258         {0, 0, 0, 0},
 259     };
 260     char *short_options = long_options_to_short_options(long_options);
 261
 262     for (;;) {
 263         int indexptr;
 264         int c;
 265
 266         c = getopt_long(argc, argv, short_options, long_options, &indexptr);
 267         if (c == -1) {
 268             break;
 269         }
 270
 271         switch (c) {
 272         case 'D':
 273             set_detach();
 274             break;
 275
 276         case 'P':
 277             set_pidfile(optarg);
 278             break;
 279
 280         case 'f':
 281             ignore_existing_pidfile();
 282             break;
 283
 284         case 'H':
 285             learn_macs = false;
 286             break;
 287
 288         case 'n':
 289             setup_flows = false;
 290             break;
 291
 292         case OPT_MAX_IDLE:
 293             if (!strcmp(optarg, "permanent")) {
 294                 max_idle = OFP_FLOW_PERMANENT;
 295             } else {
 296                 max_idle = atoi(optarg);
 297                 if (max_idle < 1 || max_idle > 65535) {
 298                     ofp_fatal(0, "--max-idle argument must be between 1 and "
 299                               "65535 or the word 'permanent'");
 300                 }
 301             }
 302             break;
 303
 304         case 'h':
 305             usage();
 306
 307         case 'V':
 308             printf("%s "VERSION" compiled "__DATE__" "__TIME__"\n", argv[0]);
 309             exit(EXIT_SUCCESS);
 310
 311         case 'v':
 312             vlog_set_verbosity(optarg);
 313             break;
 314
 315 #ifdef HAVE_OPENSSL
 316         VCONN_SSL_OPTION_HANDLERS
 317
 318         case OPT_PEER_CA_CERT:
 319             vconn_ssl_set_peer_ca_cert_file(optarg);
 320             break;
 321 #endif
 322
 323         case '?':
 324             exit(EXIT_FAILURE);
 325
 326         default:
 327             abort();
 328         }
 329     }
 330     free(short_options);
 331 }
 332
 333 static void
 334 usage(void)
 335 {
 336     printf("%s: OpenFlow controller\n"
 337            "usage: %s [OPTIONS] METHOD\n"
 338            "where METHOD is any OpenFlow connection method.\n",
 339            program_name, program_name);
 340     vconn_usage(true, true, false);
 341     printf("\nOther options:\n"
 342            "  -D, --detach            run in background as daemon\n"
 343            "  -P, --pidfile[=FILE]    create pidfile (default: %s/controller.pid)\n"
 344            "  -f, --force             with -P, start even if already running\n"
 345            "  -H, --hub               act as hub instead of learning switch\n"
 346            "  -n, --noflow            pass traffic, but don't add flows\n"
 347            "  --max-idle=SECS         max idle time for new flows\n"
 348            "  -v, --verbose=MODULE[:FACILITY[:LEVEL]]  set logging levels\n"
 349            "  -v, --verbose           set maximum verbosity level\n"
 350            "  -h, --help              display this help message\n"
 351            "  -V, --version           display version information\n",
 352            RUNDIR);
 353     exit(EXIT_SUCCESS);
 354 }