utilities/ovs-testcontroller.c

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2015 Nicira, Inc.
   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 "fatal-signal.h"
  31 #include "learning-switch.h"
  32 #include "ofp-parse.h"
  33 #include "ofp-version-opt.h"
  34 #include "ofpbuf.h"
  35 #include "openflow/openflow.h"
  36 #include "poll-loop.h"
  37 #include "rconn.h"
  38 #include "simap.h"
  39 #include "stream-ssl.h"
  40 #include "timeval.h"
  41 #include "unixctl.h"
  42 #include "util.h"
  43 #include "openvswitch/vconn.h"
  44 #include "openvswitch/vlog.h"
  45 #include "socket-util.h"
  46 #include "ofp-util.h"
  47
  48 VLOG_DEFINE_THIS_MODULE(controller);
  49
  50 #define MAX_SWITCHES 16
  51 #define MAX_LISTENERS 16
  52
  53 struct switch_ {
  54     struct lswitch *lswitch;
  55 };
  56
  57 /* -H, --hub: Learn the ports on which MAC addresses appear? */
  58 static bool learn_macs = true;
  59
  60 /* -n, --noflow: Set up flows?  (If not, every packet is processed at the
  61  * controller.) */
  62 static bool set_up_flows = true;
  63
  64 /* -N, --normal: Use "NORMAL" action instead of explicit port? */
  65 static bool action_normal = false;
  66
  67 /* -w, --wildcard: 0 to disable wildcard flow entries, an OFPFW10_* bitmask to
  68  * enable specific wildcards, or UINT32_MAX to use the default wildcards. */
  69 static uint32_t wildcards = 0;
  70
  71 /* --max-idle: Maximum idle time, in seconds, before flows expire. */
  72 static int max_idle = 60;
  73
  74 /* --mute: If true, accept connections from switches but do not reply to any
  75  * of their messages (for debugging fail-open mode). */
  76 static bool mute = false;
  77
  78 /* -q, --queue: default OpenFlow queue, none if UINT32_MAX. */
  79 static uint32_t default_queue = UINT32_MAX;
  80
  81 /* -Q, --port-queue: map from port name to port number. */
  82 static struct simap port_queues = SIMAP_INITIALIZER(&port_queues);
  83
  84 /* --with-flows: Flows to send to switch. */
  85 static struct ofputil_flow_mod *default_flows;
  86 static size_t n_default_flows;
  87 static enum ofputil_protocol usable_protocols;
  88
  89 /* --unixctl: Name of unixctl socket, or null to use the default. */
  90 static char *unixctl_path = NULL;
  91
  92 static void new_switch(struct switch_ *, struct vconn *);
  93 static void parse_options(int argc, char *argv[]);
  94 OVS_NO_RETURN static void usage(void);
  95
  96 int
  97 main(int argc, char *argv[])
  98 {
  99     struct unixctl_server *unixctl;
 100     struct switch_ switches[MAX_SWITCHES];
 101     struct pvconn *listeners[MAX_LISTENERS];
 102     int n_switches, n_listeners;
 103     int retval;
 104     int i;
 105
 106     ovs_cmdl_proctitle_init(argc, argv);
 107     set_program_name(argv[0]);
 108     parse_options(argc, argv);
 109     fatal_ignore_sigpipe();
 110
 111     daemon_become_new_user(false);
 112
 113     if (argc - optind < 1) {
 114         ovs_fatal(0, "at least one vconn argument required; "
 115                   "use --help for usage");
 116     }
 117
 118     n_switches = n_listeners = 0;
 119     for (i = optind; i < argc; i++) {
 120         const char *name = argv[i];
 121         struct vconn *vconn;
 122
 123         retval = vconn_open(name, get_allowed_ofp_versions(), DSCP_DEFAULT,
 124                             &vconn);
 125         if (!retval) {
 126             if (n_switches >= MAX_SWITCHES) {
 127                 ovs_fatal(0, "max %d switch connections", n_switches);
 128             }
 129             new_switch(&switches[n_switches++], vconn);
 130             continue;
 131         } else if (retval == EAFNOSUPPORT) {
 132             struct pvconn *pvconn;
 133             retval = pvconn_open(name, get_allowed_ofp_versions(),
 134                                  DSCP_DEFAULT, &pvconn);
 135             if (!retval) {
 136                 if (n_listeners >= MAX_LISTENERS) {
 137                     ovs_fatal(0, "max %d passive connections", n_listeners);
 138                 }
 139                 listeners[n_listeners++] = pvconn;
 140             }
 141         }
 142         if (retval) {
 143             VLOG_ERR("%s: connect: %s", name, ovs_strerror(retval));
 144         }
 145     }
 146     if (n_switches == 0 && n_listeners == 0) {
 147         ovs_fatal(0, "no active or passive switch connections");
 148     }
 149
 150     daemonize_start(false);
 151
 152     retval = unixctl_server_create(unixctl_path, &unixctl);
 153     if (retval) {
 154         exit(EXIT_FAILURE);
 155     }
 156
 157     daemonize_complete();
 158
 159     while (n_switches > 0 || n_listeners > 0) {
 160         /* Accept connections on listening vconns. */
 161         for (i = 0; i < n_listeners && n_switches < MAX_SWITCHES; ) {
 162             struct vconn *new_vconn;
 163
 164             retval = pvconn_accept(listeners[i], &new_vconn);
 165             if (!retval || retval == EAGAIN) {
 166                 if (!retval) {
 167                     new_switch(&switches[n_switches++], new_vconn);
 168                 }
 169                 i++;
 170             } else {
 171                 pvconn_close(listeners[i]);
 172                 listeners[i] = listeners[--n_listeners];
 173             }
 174         }
 175
 176         /* Do some switching work.  . */
 177         for (i = 0; i < n_switches; ) {
 178             struct switch_ *this = &switches[i];
 179             lswitch_run(this->lswitch);
 180             if (lswitch_is_alive(this->lswitch)) {
 181                 i++;
 182             } else {
 183                 lswitch_destroy(this->lswitch);
 184                 switches[i] = switches[--n_switches];
 185             }
 186         }
 187
 188         unixctl_server_run(unixctl);
 189
 190         /* Wait for something to happen. */
 191         if (n_switches < MAX_SWITCHES) {
 192             for (i = 0; i < n_listeners; i++) {
 193                 pvconn_wait(listeners[i]);
 194             }
 195         }
 196         for (i = 0; i < n_switches; i++) {
 197             struct switch_ *sw = &switches[i];
 198             lswitch_wait(sw->lswitch);
 199         }
 200         unixctl_server_wait(unixctl);
 201         poll_block();
 202     }
 203
 204     return 0;
 205 }
 206
 207 static void
 208 new_switch(struct switch_ *sw, struct vconn *vconn)
 209 {
 210     struct lswitch_config cfg;
 211     struct rconn *rconn;
 212
 213     rconn = rconn_create(60, 0, DSCP_DEFAULT, get_allowed_ofp_versions());
 214     rconn_connect_unreliably(rconn, vconn, NULL);
 215
 216     cfg.mode = (action_normal ? LSW_NORMAL
 217                 : learn_macs ? LSW_LEARN
 218                 : LSW_FLOOD);
 219     cfg.wildcards = wildcards;
 220     cfg.max_idle = set_up_flows ? max_idle : -1;
 221     cfg.default_flows = default_flows;
 222     cfg.n_default_flows = n_default_flows;
 223     cfg.usable_protocols = usable_protocols;
 224     cfg.default_queue = default_queue;
 225     cfg.port_queues = &port_queues;
 226     cfg.mute = mute;
 227     sw->lswitch = lswitch_create(rconn, &cfg);
 228 }
 229
 230 static void
 231 add_port_queue(char *s)
 232 {
 233     char *save_ptr = NULL;
 234     char *port_name;
 235     char *queue_id;
 236
 237     port_name = strtok_r(s, ":", &save_ptr);
 238     queue_id = strtok_r(NULL, "", &save_ptr);
 239     if (!queue_id) {
 240         ovs_fatal(0, "argument to -Q or --port-queue should take the form "
 241                   "\"<port-name>:<queue-id>\"");
 242     }
 243
 244     if (!simap_put(&port_queues, port_name, atoi(queue_id))) {
 245         ovs_fatal(0, "<port-name> arguments for -Q or --port-queue must "
 246                   "be unique");
 247     }
 248 }
 249
 250 static void
 251 parse_options(int argc, char *argv[])
 252 {
 253     enum {
 254         OPT_MAX_IDLE = UCHAR_MAX + 1,
 255         OPT_PEER_CA_CERT,
 256         OPT_MUTE,
 257         OPT_WITH_FLOWS,
 258         OPT_UNIXCTL,
 259         VLOG_OPTION_ENUMS,
 260         DAEMON_OPTION_ENUMS,
 261         OFP_VERSION_OPTION_ENUMS
 262     };
 263     static const struct option long_options[] = {
 264         {"hub",         no_argument, NULL, 'H'},
 265         {"noflow",      no_argument, NULL, 'n'},
 266         {"normal",      no_argument, NULL, 'N'},
 267         {"wildcards",   optional_argument, NULL, 'w'},
 268         {"max-idle",    required_argument, NULL, OPT_MAX_IDLE},
 269         {"mute",        no_argument, NULL, OPT_MUTE},
 270         {"queue",       required_argument, NULL, 'q'},
 271         {"port-queue",  required_argument, NULL, 'Q'},
 272         {"with-flows",  required_argument, NULL, OPT_WITH_FLOWS},
 273         {"unixctl",     required_argument, NULL, OPT_UNIXCTL},
 274         {"help",        no_argument, NULL, 'h'},
 275         DAEMON_LONG_OPTIONS,
 276         OFP_VERSION_LONG_OPTIONS,
 277         VLOG_LONG_OPTIONS,
 278         STREAM_SSL_LONG_OPTIONS,
 279         {"peer-ca-cert", required_argument, NULL, OPT_PEER_CA_CERT},
 280         {NULL, 0, NULL, 0},
 281     };
 282     char *short_options = ovs_cmdl_long_options_to_short_options(long_options);
 283
 284     for (;;) {
 285         int indexptr;
 286         char *error;
 287         int c;
 288
 289         c = getopt_long(argc, argv, short_options, long_options, &indexptr);
 290         if (c == -1) {
 291             break;
 292         }
 293
 294         switch (c) {
 295         case 'H':
 296             learn_macs = false;
 297             break;
 298
 299         case 'n':
 300             set_up_flows = false;
 301             break;
 302
 303         case OPT_MUTE:
 304             mute = true;
 305             break;
 306
 307         case 'N':
 308             action_normal = true;
 309             break;
 310
 311         case 'w':
 312             wildcards = optarg ? strtol(optarg, NULL, 16) : UINT32_MAX;
 313             break;
 314
 315         case OPT_MAX_IDLE:
 316             if (!strcmp(optarg, "permanent")) {
 317                 max_idle = OFP_FLOW_PERMANENT;
 318             } else {
 319                 max_idle = atoi(optarg);
 320                 if (max_idle < 1 || max_idle > 65535) {
 321                     ovs_fatal(0, "--max-idle argument must be between 1 and "
 322                               "65535 or the word 'permanent'");
 323                 }
 324             }
 325             break;
 326
 327         case 'q':
 328             default_queue = atoi(optarg);
 329             break;
 330
 331         case 'Q':
 332             add_port_queue(optarg);
 333             break;
 334
 335         case OPT_WITH_FLOWS:
 336             error = parse_ofp_flow_mod_file(optarg, OFPFC_ADD, &default_flows,
 337                                             &n_default_flows,
 338                                             &usable_protocols);
 339             if (error) {
 340                 ovs_fatal(0, "%s", error);
 341             }
 342             break;
 343
 344         case OPT_UNIXCTL:
 345             unixctl_path = optarg;
 346             break;
 347
 348         case 'h':
 349             usage();
 350
 351         VLOG_OPTION_HANDLERS
 352         OFP_VERSION_OPTION_HANDLERS
 353         DAEMON_OPTION_HANDLERS
 354
 355         STREAM_SSL_OPTION_HANDLERS
 356
 357         case OPT_PEER_CA_CERT:
 358             stream_ssl_set_peer_ca_cert_file(optarg);
 359             break;
 360
 361         case '?':
 362             exit(EXIT_FAILURE);
 363
 364         default:
 365             abort();
 366         }
 367     }
 368     free(short_options);
 369
 370     if (!simap_is_empty(&port_queues) || default_queue != UINT32_MAX) {
 371         if (action_normal) {
 372             ovs_error(0, "queue IDs are incompatible with -N or --normal; "
 373                       "not using OFPP_NORMAL");
 374             action_normal = false;
 375         }
 376
 377         if (!learn_macs) {
 378             ovs_error(0, "queue IDs are incompatible with -H or --hub; "
 379                       "not acting as hub");
 380             learn_macs = true;
 381         }
 382     }
 383 }
 384
 385 static void
 386 usage(void)
 387 {
 388     printf("%s: OpenFlow controller\n"
 389            "usage: %s [OPTIONS] METHOD\n"
 390            "where METHOD is any OpenFlow connection method.\n",
 391            program_name, program_name);
 392     vconn_usage(true, true, false);
 393     daemon_usage();
 394     ofp_version_usage();
 395     vlog_usage();
 396     printf("\nOther options:\n"
 397            "  -H, --hub               act as hub instead of learning switch\n"
 398            "  -n, --noflow            pass traffic, but don't add flows\n"
 399            "  --max-idle=SECS         max idle time for new flows\n"
 400            "  -N, --normal            use OFPP_NORMAL action\n"
 401            "  -w, --wildcards[=MASK]  wildcard (specified) bits in flows\n"
 402            "  -q, --queue=QUEUE-ID    OpenFlow queue ID to use for output\n"
 403            "  -Q PORT-NAME:QUEUE-ID   use QUEUE-ID for frames from PORT-NAME\n"
 404            "  --with-flows FILE       use the flows from FILE\n"
 405            "  --unixctl=SOCKET        override default control socket name\n"
 406            "  -h, --help              display this help message\n"
 407            "  -V, --version           display version information\n");
 408     exit(EXIT_SUCCESS);
 409 }