utilities/ovs-controller.c

   1 /*
   2  * Copyright (c) 2008, 2009 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 <string.h>
  25
  26 #include "command-line.h"
  27 #include "compiler.h"
  28 #include "daemon.h"
  29 #include "fault.h"
  30 #include "learning-switch.h"
  31 #include "ofpbuf.h"
  32 #include "openflow/openflow.h"
  33 #include "poll-loop.h"
  34 #include "rconn.h"
  35 #include "timeval.h"
  36 #include "unixctl.h"
  37 #include "util.h"
  38 #include "vconn-ssl.h"
  39 #include "vconn.h"
  40
  41 #include "vlog.h"
  42 #define THIS_MODULE VLM_controller
  43
  44 #define MAX_SWITCHES 16
  45 #define MAX_LISTENERS 16
  46
  47 struct switch_ {
  48     struct lswitch *lswitch;
  49     struct rconn *rconn;
  50 };
  51
  52 /* Learn the ports on which MAC addresses appear? */
  53 static bool learn_macs = true;
  54
  55 /* Set up flows?  (If not, every packet is processed at the controller.) */
  56 static bool set_up_flows = true;
  57
  58 /* -N, --normal: Use "NORMAL" action instead of explicit port? */
  59 static bool action_normal = false;
  60
  61 /* -w, --wildcard: Set up exact match or wildcard flow entries? */
  62 static bool exact_flows = true;
  63
  64 /* --max-idle: Maximum idle time, in seconds, before flows expire. */
  65 static int max_idle = 60;
  66
  67 /* --mute: If true, accept connections from switches but do not reply to any
  68  * of their messages (for debugging fail-open mode). */
  69 static bool mute = false;
  70
  71 static int do_switching(struct switch_ *);
  72 static void new_switch(struct switch_ *, struct vconn *, const char *name);
  73 static void parse_options(int argc, char *argv[]);
  74 static void usage(void) NO_RETURN;
  75
  76 int
  77 main(int argc, char *argv[])
  78 {
  79     struct unixctl_server *unixctl;
  80     struct switch_ switches[MAX_SWITCHES];
  81     struct pvconn *listeners[MAX_LISTENERS];
  82     int n_switches, n_listeners;
  83     int retval;
  84     int i;
  85
  86     set_program_name(argv[0]);
  87     register_fault_handlers();
  88     time_init();
  89     vlog_init();
  90     parse_options(argc, argv);
  91     signal(SIGPIPE, SIG_IGN);
  92
  93     if (argc - optind < 1) {
  94         ovs_fatal(0, "at least one vconn argument required; "
  95                   "use --help for usage");
  96     }
  97
  98     n_switches = n_listeners = 0;
  99     for (i = optind; i < argc; i++) {
 100         const char *name = argv[i];
 101         struct vconn *vconn;
 102         int retval;
 103
 104         retval = vconn_open(name, OFP_VERSION, &vconn);
 105         if (!retval) {
 106             if (n_switches >= MAX_SWITCHES) {
 107                 ovs_fatal(0, "max %d switch connections", n_switches);
 108             }
 109             new_switch(&switches[n_switches++], vconn, name);
 110             continue;
 111         } else if (retval == EAFNOSUPPORT) {
 112             struct pvconn *pvconn;
 113             retval = pvconn_open(name, &pvconn);
 114             if (!retval) {
 115                 if (n_listeners >= MAX_LISTENERS) {
 116                     ovs_fatal(0, "max %d passive connections", n_listeners);
 117                 }
 118                 listeners[n_listeners++] = pvconn;
 119             }
 120         }
 121         if (retval) {
 122             VLOG_ERR("%s: connect: %s", name, strerror(retval));
 123         }
 124     }
 125     if (n_switches == 0 && n_listeners == 0) {
 126         ovs_fatal(0, "no active or passive switch connections");
 127     }
 128
 129     die_if_already_running();
 130     daemonize();
 131
 132     retval = unixctl_server_create(NULL, &unixctl);
 133     if (retval) {
 134         ovs_fatal(retval, "Could not listen for unixctl connections");
 135     }
 136
 137     while (n_switches > 0 || n_listeners > 0) {
 138         int iteration;
 139         int i;
 140
 141         /* Accept connections on listening vconns. */
 142         for (i = 0; i < n_listeners && n_switches < MAX_SWITCHES; ) {
 143             struct vconn *new_vconn;
 144             int retval;
 145
 146             retval = pvconn_accept(listeners[i], OFP_VERSION, &new_vconn);
 147             if (!retval || retval == EAGAIN) {
 148                 if (!retval) {
 149                     new_switch(&switches[n_switches++], new_vconn, "tcp");
 150                 }
 151                 i++;
 152             } else {
 153                 pvconn_close(listeners[i]);
 154                 listeners[i] = listeners[--n_listeners];
 155             }
 156         }
 157
 158         /* Do some switching work.  Limit the number of iterations so that
 159          * callbacks registered with the poll loop don't starve. */
 160         for (iteration = 0; iteration < 50; iteration++) {
 161             bool progress = false;
 162             for (i = 0; i < n_switches; ) {
 163                 struct switch_ *this = &switches[i];
 164                 int retval = do_switching(this);
 165                 if (!retval || retval == EAGAIN) {
 166                     if (!retval) {
 167                         progress = true;
 168                     }
 169                     i++;
 170                 } else {
 171                     rconn_destroy(this->rconn);
 172                     lswitch_destroy(this->lswitch);
 173                     switches[i] = switches[--n_switches];
 174                 }
 175             }
 176             if (!progress) {
 177                 break;
 178             }
 179         }
 180         for (i = 0; i < n_switches; i++) {
 181             struct switch_ *this = &switches[i];
 182             lswitch_run(this->lswitch, this->rconn);
 183         }
 184
 185         unixctl_server_run(unixctl);
 186
 187         /* Wait for something to happen. */
 188         if (n_switches < MAX_SWITCHES) {
 189             for (i = 0; i < n_listeners; i++) {
 190                 pvconn_wait(listeners[i]);
 191             }
 192         }
 193         for (i = 0; i < n_switches; i++) {
 194             struct switch_ *sw = &switches[i];
 195             rconn_run_wait(sw->rconn);
 196             rconn_recv_wait(sw->rconn);
 197             lswitch_wait(sw->lswitch);
 198         }
 199         unixctl_server_wait(unixctl);
 200         poll_block();
 201     }
 202
 203     return 0;
 204 }
 205
 206 static void
 207 new_switch(struct switch_ *sw, struct vconn *vconn, const char *name)
 208 {
 209     sw->rconn = rconn_new_from_vconn(name, vconn);
 210     sw->lswitch = lswitch_create(sw->rconn, learn_macs, exact_flows,
 211                                  set_up_flows ? max_idle : -1,
 212                                  action_normal);
 213 }
 214
 215 static int
 216 do_switching(struct switch_ *sw)
 217 {
 218     unsigned int packets_sent;
 219     struct ofpbuf *msg;
 220
 221     packets_sent = rconn_packets_sent(sw->rconn);
 222
 223     msg = rconn_recv(sw->rconn);
 224     if (msg) {
 225         if (!mute) {
 226             lswitch_process_packet(sw->lswitch, sw->rconn, msg);
 227         }
 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         OPT_MUTE,
 244         VLOG_OPTION_ENUMS
 245     };
 246     static struct option long_options[] = {
 247         {"hub",         no_argument, 0, 'H'},
 248         {"noflow",      no_argument, 0, 'n'},
 249         {"normal",      no_argument, 0, 'N'},
 250         {"wildcard",    no_argument, 0, 'w'},
 251         {"max-idle",    required_argument, 0, OPT_MAX_IDLE},
 252         {"mute",        no_argument, 0, OPT_MUTE},
 253         {"help",        no_argument, 0, 'h'},
 254         {"version",     no_argument, 0, 'V'},
 255         DAEMON_LONG_OPTIONS,
 256         VLOG_LONG_OPTIONS,
 257 #ifdef HAVE_OPENSSL
 258         VCONN_SSL_LONG_OPTIONS
 259         {"peer-ca-cert", required_argument, 0, OPT_PEER_CA_CERT},
 260 #endif
 261         {0, 0, 0, 0},
 262     };
 263     char *short_options = long_options_to_short_options(long_options);
 264
 265     for (;;) {
 266         int indexptr;
 267         int c;
 268
 269         c = getopt_long(argc, argv, short_options, long_options, &indexptr);
 270         if (c == -1) {
 271             break;
 272         }
 273
 274         switch (c) {
 275         case 'H':
 276             learn_macs = false;
 277             break;
 278
 279         case 'n':
 280             set_up_flows = false;
 281             break;
 282
 283         case OPT_MUTE:
 284             mute = true;
 285             break;
 286
 287         case 'N':
 288             action_normal = true;
 289             break;
 290
 291         case 'w':
 292             exact_flows = false;
 293             break;
 294
 295         case OPT_MAX_IDLE:
 296             if (!strcmp(optarg, "permanent")) {
 297                 max_idle = OFP_FLOW_PERMANENT;
 298             } else {
 299                 max_idle = atoi(optarg);
 300                 if (max_idle < 1 || max_idle > 65535) {
 301                     ovs_fatal(0, "--max-idle argument must be between 1 and "
 302                               "65535 or the word 'permanent'");
 303                 }
 304             }
 305             break;
 306
 307         case 'h':
 308             usage();
 309
 310         case 'V':
 311             OVS_PRINT_VERSION(OFP_VERSION, OFP_VERSION);
 312             exit(EXIT_SUCCESS);
 313
 314         VLOG_OPTION_HANDLERS
 315         DAEMON_OPTION_HANDLERS
 316
 317 #ifdef HAVE_OPENSSL
 318         VCONN_SSL_OPTION_HANDLERS
 319
 320         case OPT_PEER_CA_CERT:
 321             vconn_ssl_set_peer_ca_cert_file(optarg);
 322             break;
 323 #endif
 324
 325         case '?':
 326             exit(EXIT_FAILURE);
 327
 328         default:
 329             abort();
 330         }
 331     }
 332     free(short_options);
 333 }
 334
 335 static void
 336 usage(void)
 337 {
 338     printf("%s: OpenFlow controller\n"
 339            "usage: %s [OPTIONS] METHOD\n"
 340            "where METHOD is any OpenFlow connection method.\n",
 341            program_name, program_name);
 342     vconn_usage(true, true, false);
 343     daemon_usage();
 344     vlog_usage();
 345     printf("\nOther options:\n"
 346            "  -H, --hub               act as hub instead of learning switch\n"
 347            "  -n, --noflow            pass traffic, but don't add flows\n"
 348            "  --max-idle=SECS         max idle time for new flows\n"
 349            "  -N, --normal            use OFPAT_NORMAL action\n"
 350            "  -w, --wildcard          use wildcards, not exact-match rules\n"
 351            "  -h, --help              display this help message\n"
 352            "  -V, --version           display version information\n");
 353     exit(EXIT_SUCCESS);
 354 }