secchan/secchan.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 #include <assert.h>
  36 #include <errno.h>
  37 #include <getopt.h>
  38 #include <inttypes.h>
  39 #include <netinet/in.h>
  40 #include <poll.h>
  41 #include <regex.h>
  42 #include <stdlib.h>
  43 #include <signal.h>
  44 #include <string.h>
  45 #include <time.h>
  46 #include <unistd.h>
  47
  48 #include "buffer.h"
  49 #include "command-line.h"
  50 #include "compiler.h"
  51 #include "daemon.h"
  52 #include "dhcp.h"
  53 #include "dhcp-client.h"
  54 #include "dynamic-string.h"
  55 #include "fault.h"
  56 #include "flow.h"
  57 #include "learning-switch.h"
  58 #include "list.h"
  59 #include "mac-learning.h"
  60 #include "netdev.h"
  61 #include "openflow.h"
  62 #include "packets.h"
  63 #include "poll-loop.h"
  64 #include "rconn.h"
  65 #include "timeval.h"
  66 #include "util.h"
  67 #include "vconn-ssl.h"
  68 #include "vconn.h"
  69 #include "vlog-socket.h"
  70
  71 #include "vlog.h"
  72 #define THIS_MODULE VLM_secchan
  73
  74 /* Behavior when the connection to the controller fails. */
  75 enum fail_mode {
  76     FAIL_OPEN,                  /* Act as learning switch. */
  77     FAIL_CLOSED                 /* Drop all packets. */
  78 };
  79
  80 /* Maximum number of management connection listeners. */
  81 #define MAX_MGMT 8
  82
  83 /* Settings that may be configured by the user. */
  84 struct settings {
  85     /* Overall mode of operation. */
  86     bool discovery;           /* Discover the controller automatically? */
  87     bool in_band;             /* Connect to controller in-band? */
  88
  89     /* Related vconns and network devices. */
  90     const char *nl_name;        /* Local datapath (must be "nl:" vconn). */
  91     char *of_name;              /* ofX network device name. */
  92     const char *controller_name; /* Controller (if not discovery mode). */
  93     const char *listener_names[MAX_MGMT]; /* Listen for mgmt connections. */
  94     size_t n_listeners;          /* Number of mgmt connection listeners. */
  95
  96     /* Failure behavior. */
  97     enum fail_mode fail_mode; /* Act as learning switch if no controller? */
  98     int max_idle;             /* Idle time for flows in fail-open mode. */
  99     int probe_interval;       /* # seconds idle before sending echo request. */
 100     int max_backoff;          /* Max # seconds between connection attempts. */
 101
 102     /* Packet-in rate-limiting. */
 103     int rate_limit;           /* Tokens added to bucket per second. */
 104     int burst_limit;          /* Maximum number token bucket size. */
 105
 106     /* Discovery behavior. */
 107     regex_t accept_controller_regex;  /* Controller vconns to accept. */
 108     const char *accept_controller_re; /* String version of regex. */
 109     bool update_resolv_conf;          /* Update /etc/resolv.conf? */
 110 };
 111
 112 struct half {
 113     struct rconn *rconn;
 114     struct buffer *rxbuf;
 115     int n_txq;                  /* No. of packets queued for tx on 'rconn'. */
 116 };
 117
 118 struct relay {
 119     struct list node;
 120
 121 #define HALF_LOCAL 0
 122 #define HALF_REMOTE 1
 123     struct half halves[2];
 124
 125     bool is_mgmt_conn;
 126 };
 127
 128 struct hook {
 129     bool (*packet_cb)(struct relay *, int half, void *aux);
 130     void (*periodic_cb)(void *aux);
 131     void (*wait_cb)(void *aux);
 132     void *aux;
 133 };
 134
 135 static struct vlog_rate_limit vrl = VLOG_RATE_LIMIT_INIT(60, 60);
 136
 137 static void parse_options(int argc, char *argv[], struct settings *);
 138 static void usage(void) NO_RETURN;
 139
 140 static struct relay *relay_create(struct rconn *local, struct rconn *remote,
 141                                   bool is_mgmt_conn);
 142 static struct relay *relay_accept(const struct settings *, struct vconn *);
 143 static void relay_run(struct relay *, const struct hook[], size_t n_hooks);
 144 static void relay_wait(struct relay *);
 145 static void relay_destroy(struct relay *);
 146
 147 static struct hook make_hook(bool (*packet_cb)(struct relay *, int, void *),
 148                              void (*periodic_cb)(void *),
 149                              void (*wait_cb)(void *),
 150                              void *aux);
 151
 152 struct switch_status;
 153 struct status_reply;
 154 static struct hook switch_status_hook_create(const struct settings *,
 155                                              struct switch_status **);
 156 static void switch_status_register_category(struct switch_status *,
 157                                             const char *category,
 158                                             void (*cb)(struct status_reply *,
 159                                                        void *aux),
 160                                             void *aux);
 161 static void status_reply_put(struct status_reply *, const char *, ...)
 162     PRINTF_FORMAT(2, 3);
 163
 164 static void rconn_status_cb(struct status_reply *, void *rconn_);
 165
 166 static struct discovery *discovery_init(const struct settings *,
 167                                         struct switch_status *);
 168 static void discovery_question_connectivity(struct discovery *);
 169 static bool discovery_run(struct discovery *, char **controller_name);
 170 static void discovery_wait(struct discovery *);
 171
 172 static struct hook in_band_hook_create(const struct settings *,
 173                                        struct switch_status *,
 174                                        struct rconn *remote);
 175 static struct hook fail_open_hook_create(const struct settings *,
 176                                          struct switch_status *,
 177                                          struct rconn *local,
 178                                          struct rconn *remote);
 179 static struct hook rate_limit_hook_create(const struct settings *,
 180                                           struct switch_status *,
 181                                           struct rconn *local,
 182                                           struct rconn *remote);
 183
 184
 185 static void modify_dhcp_request(struct dhcp_msg *, void *aux);
 186 static bool validate_dhcp_offer(const struct dhcp_msg *, void *aux);
 187
 188 int
 189 main(int argc, char *argv[])
 190 {
 191     struct settings s;
 192
 193     struct list relays = LIST_INITIALIZER(&relays);
 194
 195     struct hook hooks[8];
 196     size_t n_hooks = 0;
 197
 198     struct vconn *listeners[MAX_MGMT];
 199     size_t n_listeners;
 200
 201     struct rconn *local_rconn, *remote_rconn;
 202     struct relay *controller_relay;
 203     struct discovery *discovery;
 204     struct switch_status *switch_status;
 205     int i;
 206     int retval;
 207
 208     set_program_name(argv[0]);
 209     register_fault_handlers();
 210     time_init();
 211     vlog_init();
 212     parse_options(argc, argv, &s);
 213     signal(SIGPIPE, SIG_IGN);
 214
 215     /* Start listening for management connections. */
 216     n_listeners = 0;
 217     for (i = 0; i < s.n_listeners; i++) {
 218         const char *name = s.listener_names[i];
 219         struct vconn *listener;
 220         retval = vconn_open(name, &listener);
 221         if (retval && retval != EAGAIN) {
 222             fatal(retval, "opening %s", name);
 223         }
 224         if (!vconn_is_passive(listener)) {
 225             fatal(0, "%s is not a passive vconn", name);
 226         }
 227         listeners[n_listeners++] = listener;
 228     }
 229
 230     /* Initialize switch status hook. */
 231     hooks[n_hooks++] = switch_status_hook_create(&s, &switch_status);
 232
 233     /* Start controller discovery. */
 234     discovery = s.discovery ? discovery_init(&s, switch_status) : NULL;
 235
 236     /* Start listening for vlogconf requests. */
 237     retval = vlog_server_listen(NULL, NULL);
 238     if (retval) {
 239         fatal(retval, "Could not listen for vlog connections");
 240     }
 241
 242     die_if_already_running();
 243     daemonize();
 244
 245     VLOG_WARN("OpenFlow reference implementation version %s", VERSION);
 246     VLOG_WARN("OpenFlow protocol version 0x%02x", OFP_VERSION);
 247
 248     /* Connect to datapath. */
 249     local_rconn = rconn_create(0, s.max_backoff);
 250     rconn_connect(local_rconn, s.nl_name);
 251     switch_status_register_category(switch_status, "local",
 252                                     rconn_status_cb, local_rconn);
 253
 254     /* Connect to controller. */
 255     remote_rconn = rconn_create(s.probe_interval, s.max_backoff);
 256     if (s.controller_name) {
 257         retval = rconn_connect(remote_rconn, s.controller_name);
 258         if (retval == EAFNOSUPPORT) {
 259             fatal(0, "No support for %s vconn", s.controller_name);
 260         }
 261     }
 262     switch_status_register_category(switch_status, "remote",
 263                                     rconn_status_cb, remote_rconn);
 264
 265     /* Start relaying. */
 266     controller_relay = relay_create(local_rconn, remote_rconn, false);
 267     list_push_back(&relays, &controller_relay->node);
 268
 269     /* Set up hooks. */
 270     if (s.in_band) {
 271         hooks[n_hooks++] = in_band_hook_create(&s, switch_status,
 272                                                remote_rconn);
 273     }
 274     if (s.fail_mode == FAIL_OPEN) {
 275         hooks[n_hooks++] = fail_open_hook_create(&s, switch_status,
 276                                                  local_rconn, remote_rconn);
 277     }
 278     if (s.rate_limit) {
 279         hooks[n_hooks++] = rate_limit_hook_create(&s, switch_status,
 280                                                   local_rconn, remote_rconn);
 281     }
 282     assert(n_hooks <= ARRAY_SIZE(hooks));
 283
 284     for (;;) {
 285         struct relay *r, *n;
 286         size_t i;
 287
 288         /* Do work. */
 289         LIST_FOR_EACH_SAFE (r, n, struct relay, node, &relays) {
 290             relay_run(r, hooks, n_hooks);
 291         }
 292         for (i = 0; i < n_listeners; i++) {
 293             for (;;) {
 294                 struct relay *r = relay_accept(&s, listeners[i]);
 295                 if (!r) {
 296                     break;
 297                 }
 298                 list_push_back(&relays, &r->node);
 299             }
 300         }
 301         for (i = 0; i < n_hooks; i++) {
 302             if (hooks[i].periodic_cb) {
 303                 hooks[i].periodic_cb(hooks[i].aux);
 304             }
 305         }
 306         if (s.discovery) {
 307             char *controller_name;
 308             if (rconn_is_connectivity_questionable(remote_rconn)) {
 309                 discovery_question_connectivity(discovery);
 310             }
 311             if (discovery_run(discovery, &controller_name)) {
 312                 if (controller_name) {
 313                     rconn_connect(remote_rconn, controller_name);
 314                 } else {
 315                     rconn_disconnect(remote_rconn);
 316                 }
 317             }
 318         }
 319
 320         /* Wait for something to happen. */
 321         LIST_FOR_EACH (r, struct relay, node, &relays) {
 322             relay_wait(r);
 323         }
 324         for (i = 0; i < n_listeners; i++) {
 325             vconn_accept_wait(listeners[i]);
 326         }
 327         for (i = 0; i < n_hooks; i++) {
 328             if (hooks[i].wait_cb) {
 329                 hooks[i].wait_cb(hooks[i].aux);
 330             }
 331         }
 332         if (discovery) {
 333             discovery_wait(discovery);
 334         }
 335         poll_block();
 336     }
 337
 338     return 0;
 339 }
 340
 341 static struct hook
 342 make_hook(bool (*packet_cb)(struct relay *, int half, void *aux),
 343           void (*periodic_cb)(void *aux),
 344           void (*wait_cb)(void *aux),
 345           void *aux)
 346 {
 347     struct hook h;
 348     h.packet_cb = packet_cb;
 349     h.periodic_cb = periodic_cb;
 350     h.wait_cb = wait_cb;
 351     h.aux = aux;
 352     return h;
 353 }
 354 \f
 355 /* OpenFlow message relaying. */
 356
 357 static struct relay *
 358 relay_accept(const struct settings *s, struct vconn *listen_vconn)
 359 {
 360     struct vconn *new_remote, *new_local;
 361     char *nl_name_without_subscription;
 362     struct rconn *r1, *r2;
 363     int retval;
 364
 365     retval = vconn_accept(listen_vconn, &new_remote);
 366     if (retval) {
 367         if (retval != EAGAIN) {
 368             VLOG_WARN_RL(&vrl, "accept failed (%s)", strerror(retval));
 369         }
 370         return NULL;
 371     }
 372
 373     /* nl:123 or nl:123:1 opens a netlink connection to local datapath 123.  We
 374      * only accept the former syntax in main().
 375      *
 376      * nl:123:0 opens a netlink connection to local datapath 123 without
 377      * obtaining a subscription for ofp_packet_in or ofp_flow_expired
 378      * messages.*/
 379     nl_name_without_subscription = xasprintf("%s:0", s->nl_name);
 380     retval = vconn_open(nl_name_without_subscription, &new_local);
 381     if (retval) {
 382         VLOG_ERR_RL(&vrl, "could not connect to %s (%s)",
 383                     nl_name_without_subscription, strerror(retval));
 384         vconn_close(new_remote);
 385         free(nl_name_without_subscription);
 386         return NULL;
 387     }
 388
 389     /* Create and return relay. */
 390     r1 = rconn_create(0, 0);
 391     rconn_connect_unreliably(r1, nl_name_without_subscription, new_local);
 392     free(nl_name_without_subscription);
 393
 394     r2 = rconn_create(0, 0);
 395     rconn_connect_unreliably(r2, "passive", new_remote);
 396
 397     return relay_create(r1, r2, true);
 398 }
 399
 400 static struct relay *
 401 relay_create(struct rconn *local, struct rconn *remote, bool is_mgmt_conn)
 402 {
 403     struct relay *r = xcalloc(1, sizeof *r);
 404     r->halves[HALF_LOCAL].rconn = local;
 405     r->halves[HALF_REMOTE].rconn = remote;
 406     r->is_mgmt_conn = is_mgmt_conn;
 407     return r;
 408 }
 409
 410 static void
 411 relay_run(struct relay *r, const struct hook hooks[], size_t n_hooks)
 412 {
 413     int iteration;
 414     int i;
 415
 416     for (i = 0; i < 2; i++) {
 417         rconn_run(r->halves[i].rconn);
 418     }
 419
 420     /* Limit the number of iterations to prevent other tasks from starving. */
 421     for (iteration = 0; iteration < 50; iteration++) {
 422         bool progress = false;
 423         for (i = 0; i < 2; i++) {
 424             struct half *this = &r->halves[i];
 425             struct half *peer = &r->halves[!i];
 426
 427             if (!this->rxbuf) {
 428                 this->rxbuf = rconn_recv(this->rconn);
 429                 if (this->rxbuf) {
 430                     const struct hook *h;
 431                     for (h = hooks; h < &hooks[n_hooks]; h++) {
 432                         if (h->packet_cb(r, i, h->aux)) {
 433                             buffer_delete(this->rxbuf);
 434                             this->rxbuf = NULL;
 435                             progress = true;
 436                             break;
 437                         }
 438                     }
 439                 }
 440             }
 441
 442             if (this->rxbuf && !this->n_txq) {
 443                 int retval = rconn_send(peer->rconn, this->rxbuf,
 444                                         &this->n_txq);
 445                 if (retval != EAGAIN) {
 446                     if (!retval) {
 447                         progress = true;
 448                     } else {
 449                         buffer_delete(this->rxbuf);
 450                     }
 451                     this->rxbuf = NULL;
 452                 }
 453             }
 454         }
 455         if (!progress) {
 456             break;
 457         }
 458     }
 459
 460     if (r->is_mgmt_conn) {
 461         for (i = 0; i < 2; i++) {
 462             struct half *this = &r->halves[i];
 463             if (!rconn_is_alive(this->rconn)) {
 464                 relay_destroy(r);
 465                 return;
 466             }
 467         }
 468     }
 469 }
 470
 471 static void
 472 relay_wait(struct relay *r)
 473 {
 474     int i;
 475
 476     for (i = 0; i < 2; i++) {
 477         struct half *this = &r->halves[i];
 478
 479         rconn_run_wait(this->rconn);
 480         if (!this->rxbuf) {
 481             rconn_recv_wait(this->rconn);
 482         }
 483     }
 484 }
 485
 486 static void
 487 relay_destroy(struct relay *r)
 488 {
 489     int i;
 490
 491     list_remove(&r->node);
 492     for (i = 0; i < 2; i++) {
 493         struct half *this = &r->halves[i];
 494         rconn_destroy(this->rconn);
 495         buffer_delete(this->rxbuf);
 496     }
 497     free(r);
 498 }
 499 \f
 500 /* In-band control. */
 501
 502 struct in_band_data {
 503     const struct settings *s;
 504     struct mac_learning *ml;
 505     struct netdev *of_device;
 506     struct rconn *controller;
 507     uint8_t mac[ETH_ADDR_LEN];
 508     int n_queued;
 509 };
 510
 511 static void
 512 queue_tx(struct rconn *rc, struct in_band_data *in_band, struct buffer *b)
 513 {
 514     rconn_send_with_limit(rc, b, &in_band->n_queued, 10);
 515 }
 516
 517 static const uint8_t *
 518 get_controller_mac(struct in_band_data *in_band)
 519 {
 520     static uint32_t ip, last_nonzero_ip;
 521     static uint8_t mac[ETH_ADDR_LEN], last_nonzero_mac[ETH_ADDR_LEN];
 522     static time_t next_refresh = 0;
 523
 524     uint32_t last_ip = ip;
 525
 526     time_t now = time_now();
 527
 528     ip = rconn_get_ip(in_band->controller);
 529     if (last_ip != ip || !next_refresh || now >= next_refresh) {
 530         bool have_mac;
 531
 532         /* Look up MAC address. */
 533         memset(mac, 0, sizeof mac);
 534         if (ip) {
 535             int retval = netdev_arp_lookup(in_band->of_device, ip, mac);
 536             if (retval) {
 537                 VLOG_DBG("cannot look up controller hw address ("IP_FMT"): %s",
 538                          IP_ARGS(&ip), strerror(retval));
 539             }
 540         }
 541         have_mac = !eth_addr_is_zero(mac);
 542
 543         /* Log changes in IP, MAC addresses. */
 544         if (ip && ip != last_nonzero_ip) {
 545             VLOG_DBG("controller IP address changed from "IP_FMT
 546                      " to "IP_FMT, IP_ARGS(&last_nonzero_ip), IP_ARGS(&ip));
 547             last_nonzero_ip = ip;
 548         }
 549         if (have_mac && memcmp(last_nonzero_mac, mac, ETH_ADDR_LEN)) {
 550             VLOG_DBG("controller MAC address changed from "ETH_ADDR_FMT" to "
 551                      ETH_ADDR_FMT,
 552                      ETH_ADDR_ARGS(last_nonzero_mac), ETH_ADDR_ARGS(mac));
 553             memcpy(last_nonzero_mac, mac, ETH_ADDR_LEN);
 554         }
 555
 556         /* Schedule next refresh.
 557          *
 558          * If we have an IP address but not a MAC address, then refresh
 559          * quickly, since we probably will get a MAC address soon (via ARP).
 560          * Otherwise, we can afford to wait a little while. */
 561         next_refresh = now + (!ip || have_mac ? 10 : 1);
 562     }
 563     return !eth_addr_is_zero(mac) ? mac : NULL;
 564 }
 565
 566 static bool
 567 is_controller_mac(const uint8_t dl_addr[ETH_ADDR_LEN],
 568                   struct in_band_data *in_band)
 569 {
 570     const uint8_t *mac = get_controller_mac(in_band);
 571     return mac && eth_addr_equals(mac, dl_addr);
 572 }
 573
 574 static bool
 575 in_band_packet_cb(struct relay *r, int half, void *in_band_)
 576 {
 577     struct in_band_data *in_band = in_band_;
 578     struct rconn *rc = r->halves[HALF_LOCAL].rconn;
 579     struct buffer *msg = r->halves[HALF_LOCAL].rxbuf;
 580     struct ofp_packet_in *opi;
 581     struct ofp_header *oh;
 582     size_t pkt_ofs, pkt_len;
 583     struct buffer pkt;
 584     struct flow flow;
 585     uint16_t in_port, out_port;
 586     const uint8_t *controller_mac;
 587
 588     if (half != HALF_LOCAL || r->is_mgmt_conn) {
 589         return false;
 590     }
 591
 592     oh = msg->data;
 593     if (oh->type != OFPT_PACKET_IN) {
 594         return false;
 595     }
 596     if (msg->size < offsetof(struct ofp_packet_in, data)) {
 597         VLOG_WARN_RL(&vrl, "packet too short (%zu bytes) for packet_in",
 598                      msg->size);
 599         return false;
 600     }
 601
 602     /* Extract flow data from 'opi' into 'flow'. */
 603     opi = msg->data;
 604     in_port = ntohs(opi->in_port);
 605     pkt_ofs = offsetof(struct ofp_packet_in, data);
 606     pkt_len = ntohs(opi->header.length) - pkt_ofs;
 607     pkt.data = opi->data;
 608     pkt.size = pkt_len;
 609     flow_extract(&pkt, in_port, &flow);
 610
 611     /* Deal with local stuff. */
 612     controller_mac = get_controller_mac(in_band);
 613     if (in_port == OFPP_LOCAL) {
 614         /* Sent by secure channel. */
 615         out_port = mac_learning_lookup(in_band->ml, flow.dl_dst);
 616     } else if (eth_addr_equals(flow.dl_dst, in_band->mac)) {
 617         /* Sent to secure channel. */
 618         out_port = OFPP_LOCAL;
 619         if (mac_learning_learn(in_band->ml, flow.dl_src, in_port)) {
 620             VLOG_DBG_RL(&vrl, "learned that "ETH_ADDR_FMT" is on port %"PRIu16,
 621                         ETH_ADDR_ARGS(flow.dl_src), in_port);
 622         }
 623     } else if (flow.dl_type == htons(ETH_TYPE_ARP)
 624                && eth_addr_is_broadcast(flow.dl_dst)
 625                && is_controller_mac(flow.dl_src, in_band)) {
 626         /* ARP sent by controller. */
 627         out_port = OFPP_FLOOD;
 628     } else if (is_controller_mac(flow.dl_dst, in_band)
 629                && in_port == mac_learning_lookup(in_band->ml,
 630                                                  controller_mac)) {
 631         /* Drop controller traffic that arrives on the controller port. */
 632         queue_tx(rc, in_band, make_add_flow(&flow, ntohl(opi->buffer_id),
 633                                             in_band->s->max_idle, 0));
 634         return true;
 635     } else {
 636         return false;
 637     }
 638
 639     if (out_port != OFPP_FLOOD) {
 640         /* The output port is known, so add a new flow. */
 641         queue_tx(rc, in_band,
 642                  make_add_simple_flow(&flow, ntohl(opi->buffer_id),
 643                                       out_port, in_band->s->max_idle));
 644
 645         /* If the switch didn't buffer the packet, we need to send a copy. */
 646         if (ntohl(opi->buffer_id) == UINT32_MAX) {
 647             queue_tx(rc, in_band,
 648                      make_unbuffered_packet_out(&pkt, in_port, out_port));
 649         }
 650     } else {
 651         /* We don't know that MAC.  Send along the packet without setting up a
 652          * flow. */
 653         struct buffer *b;
 654         if (ntohl(opi->buffer_id) == UINT32_MAX) {
 655             b = make_unbuffered_packet_out(&pkt, in_port, out_port);
 656         } else {
 657             b = make_buffered_packet_out(ntohl(opi->buffer_id),
 658                                          in_port, out_port);
 659         }
 660         queue_tx(rc, in_band, b);
 661     }
 662     return true;
 663 }
 664
 665 static void
 666 in_band_status_cb(struct status_reply *sr, void *in_band_)
 667 {
 668     struct in_band_data *in_band = in_band_;
 669     struct in_addr local_ip;
 670     uint32_t controller_ip;
 671     const uint8_t *controller_mac;
 672
 673     if (netdev_get_in4(in_band->of_device, &local_ip)) {
 674         status_reply_put(sr, "local-ip="IP_FMT, IP_ARGS(&local_ip.s_addr));
 675     }
 676     status_reply_put(sr, "local-mac="ETH_ADDR_FMT,
 677                      ETH_ADDR_ARGS(in_band->mac));
 678
 679     controller_ip = rconn_get_ip(in_band->controller);
 680     if (controller_ip) {
 681         status_reply_put(sr, "controller-ip="IP_FMT,
 682                       IP_ARGS(&controller_ip));
 683     }
 684     controller_mac = get_controller_mac(in_band);
 685     if (controller_mac) {
 686         status_reply_put(sr, "controller-mac="ETH_ADDR_FMT,
 687                       ETH_ADDR_ARGS(controller_mac));
 688     }
 689 }
 690
 691 static struct hook
 692 in_band_hook_create(const struct settings *s, struct switch_status *ss,
 693                     struct rconn *remote)
 694 {
 695     struct in_band_data *in_band;
 696     int retval;
 697
 698     in_band = xcalloc(1, sizeof *in_band);
 699     in_band->s = s;
 700     in_band->ml = mac_learning_create();
 701     retval = netdev_open(s->of_name, NETDEV_ETH_TYPE_NONE,
 702                          &in_band->of_device);
 703     if (retval) {
 704         fatal(retval, "Could not open %s device", s->of_name);
 705     }
 706     memcpy(in_band->mac, netdev_get_etheraddr(in_band->of_device),
 707            ETH_ADDR_LEN);
 708     in_band->controller = remote;
 709     switch_status_register_category(ss, "in-band", in_band_status_cb, in_band);
 710     return make_hook(in_band_packet_cb, NULL, NULL, in_band);
 711 }
 712 \f
 713 /* Fail open support. */
 714
 715 struct fail_open_data {
 716     const struct settings *s;
 717     struct rconn *local_rconn;
 718     struct rconn *remote_rconn;
 719     struct lswitch *lswitch;
 720     int last_disconn_secs;
 721 };
 722
 723 /* Causes 'r' to enter or leave fail-open mode, if appropriate. */
 724 static void
 725 fail_open_periodic_cb(void *fail_open_)
 726 {
 727     struct fail_open_data *fail_open = fail_open_;
 728     int disconn_secs;
 729     bool open;
 730
 731     disconn_secs = rconn_disconnected_duration(fail_open->remote_rconn);
 732     open = disconn_secs >= fail_open->s->probe_interval * 3;
 733     if (open != (fail_open->lswitch != NULL)) {
 734         if (!open) {
 735             VLOG_WARN("No longer in fail-open mode");
 736             lswitch_destroy(fail_open->lswitch);
 737             fail_open->lswitch = NULL;
 738         } else {
 739             VLOG_WARN("Could not connect to controller for %d seconds, "
 740                       "failing open", disconn_secs);
 741             fail_open->lswitch = lswitch_create(fail_open->local_rconn, true,
 742                                                 fail_open->s->max_idle);
 743             fail_open->last_disconn_secs = disconn_secs;
 744         }
 745     } else if (open && disconn_secs > fail_open->last_disconn_secs + 60) {
 746         VLOG_WARN("Still in fail-open mode after %d seconds disconnected "
 747                   "from controller", disconn_secs);
 748         fail_open->last_disconn_secs = disconn_secs;
 749     }
 750 }
 751
 752 static bool
 753 fail_open_packet_cb(struct relay *r, int half, void *fail_open_)
 754 {
 755     struct fail_open_data *fail_open = fail_open_;
 756     if (half != HALF_LOCAL || r->is_mgmt_conn || !fail_open->lswitch) {
 757         return false;
 758     } else {
 759         lswitch_process_packet(fail_open->lswitch, fail_open->local_rconn,
 760                                r->halves[HALF_LOCAL].rxbuf);
 761         rconn_run(fail_open->local_rconn);
 762         return true;
 763     }
 764 }
 765
 766 static void
 767 fail_open_status_cb(struct status_reply *sr, void *fail_open_)
 768 {
 769     struct fail_open_data *fail_open = fail_open_;
 770     const struct settings *s = fail_open->s;
 771     int trigger_duration = s->probe_interval * 3;
 772     int cur_duration = rconn_disconnected_duration(fail_open->remote_rconn);
 773
 774     status_reply_put(sr, "trigger-duration=%d", trigger_duration);
 775     status_reply_put(sr, "current-duration=%d", cur_duration);
 776     status_reply_put(sr, "triggered=%s",
 777                      cur_duration >= trigger_duration ? "true" : "false");
 778     status_reply_put(sr, "max-idle=%d", s->max_idle);
 779 }
 780
 781 static struct hook
 782 fail_open_hook_create(const struct settings *s, struct switch_status *ss,
 783                       struct rconn *local_rconn, struct rconn *remote_rconn)
 784 {
 785     struct fail_open_data *fail_open = xmalloc(sizeof *fail_open);
 786     fail_open->s = s;
 787     fail_open->local_rconn = local_rconn;
 788     fail_open->remote_rconn = remote_rconn;
 789     fail_open->lswitch = NULL;
 790     switch_status_register_category(ss, "fail-open",
 791                                     fail_open_status_cb, fail_open);
 792     return make_hook(fail_open_packet_cb, fail_open_periodic_cb, NULL,
 793                      fail_open);
 794 }
 795 \f
 796 struct rate_limiter {
 797     const struct settings *s;
 798     struct rconn *remote_rconn;
 799
 800     /* One queue per physical port. */
 801     struct queue queues[OFPP_MAX];
 802     int n_queued;               /* Sum over queues[*].n. */
 803     int next_tx_port;           /* Next port to check in round-robin. */
 804
 805     /* Token bucket.
 806      *
 807      * It costs 1000 tokens to send a single packet_in message.  A single token
 808      * per message would be more straightforward, but this choice lets us avoid
 809      * round-off error in refill_bucket()'s calculation of how many tokens to
 810      * add to the bucket, since no division step is needed. */
 811     long long int last_fill;    /* Time at which we last added tokens. */
 812     int tokens;                 /* Current number of tokens. */
 813
 814     /* Transmission queue. */
 815     int n_txq;                  /* No. of packets waiting in rconn for tx. */
 816
 817     /* Statistics reporting. */
 818     unsigned long long n_normal;        /* # txed w/o rate limit queuing. */
 819     unsigned long long n_limited;       /* # queued for rate limiting. */
 820     unsigned long long n_queue_dropped; /* # dropped due to queue overflow. */
 821     unsigned long long n_tx_dropped;    /* # dropped due to tx overflow. */
 822 };
 823
 824 /* Drop a packet from the longest queue in 'rl'. */
 825 static void
 826 drop_packet(struct rate_limiter *rl)
 827 {
 828     struct queue *longest;      /* Queue currently selected as longest. */
 829     int n_longest;              /* # of queues of same length as 'longest'. */
 830     struct queue *q;
 831
 832     longest = &rl->queues[0];
 833     n_longest = 1;
 834     for (q = &rl->queues[0]; q < &rl->queues[OFPP_MAX]; q++) {
 835         if (longest->n < q->n) {
 836             longest = q;
 837             n_longest = 1;
 838         } else if (longest->n == q->n) {
 839             n_longest++;
 840
 841             /* Randomly select one of the longest queues, with a uniform
 842              * distribution (Knuth algorithm 3.4.2R). */
 843             if (!random_range(n_longest)) {
 844                 longest = q;
 845             }
 846         }
 847     }
 848
 849     /* FIXME: do we want to pop the tail instead? */
 850     buffer_delete(queue_pop_head(longest));
 851     rl->n_queued--;
 852 }
 853
 854 /* Remove and return the next packet to transmit (in round-robin order). */
 855 static struct buffer *
 856 dequeue_packet(struct rate_limiter *rl)
 857 {
 858     unsigned int i;
 859
 860     for (i = 0; i < OFPP_MAX; i++) {
 861         unsigned int port = (rl->next_tx_port + i) % OFPP_MAX;
 862         struct queue *q = &rl->queues[port];
 863         if (q->n) {
 864             rl->next_tx_port = (port + 1) % OFPP_MAX;
 865             rl->n_queued--;
 866             return queue_pop_head(q);
 867         }
 868     }
 869     NOT_REACHED();
 870 }
 871
 872 /* Add tokens to the bucket based on elapsed time. */
 873 static void
 874 refill_bucket(struct rate_limiter *rl)
 875 {
 876     const struct settings *s = rl->s;
 877     long long int now = time_msec();
 878     long long int tokens = (now - rl->last_fill) * s->rate_limit + rl->tokens;
 879     if (tokens >= 1000) {
 880         rl->last_fill = now;
 881         rl->tokens = MIN(tokens, s->burst_limit * 1000);
 882     }
 883 }
 884
 885 /* Attempts to remove enough tokens from 'rl' to transmit a packet.  Returns
 886  * true if successful, false otherwise.  (In the latter case no tokens are
 887  * removed.) */
 888 static bool
 889 get_token(struct rate_limiter *rl)
 890 {
 891     if (rl->tokens >= 1000) {
 892         rl->tokens -= 1000;
 893         return true;
 894     } else {
 895         return false;
 896     }
 897 }
 898
 899 static bool
 900 rate_limit_packet_cb(struct relay *r, int half, void *rl_)
 901 {
 902     struct rate_limiter *rl = rl_;
 903     const struct settings *s = rl->s;
 904     struct buffer *msg = r->halves[HALF_LOCAL].rxbuf;
 905     struct ofp_header *oh;
 906
 907     if (half == HALF_REMOTE) {
 908         return false;
 909     }
 910
 911     oh = msg->data;
 912     if (oh->type != OFPT_PACKET_IN) {
 913         return false;
 914     }
 915     if (msg->size < offsetof(struct ofp_packet_in, data)) {
 916         VLOG_WARN_RL(&vrl, "packet too short (%zu bytes) for packet_in",
 917                      msg->size);
 918         return false;
 919     }
 920
 921     if (!rl->n_queued && get_token(rl)) {
 922         /* In the common case where we are not constrained by the rate limit,
 923          * let the packet take the normal path. */
 924         rl->n_normal++;
 925         return false;
 926     } else {
 927         /* Otherwise queue it up for the periodic callback to drain out. */
 928         struct ofp_packet_in *opi = msg->data;
 929         int port = ntohs(opi->in_port) % OFPP_MAX;
 930         if (rl->n_queued >= s->burst_limit) {
 931             drop_packet(rl);
 932         }
 933         queue_push_tail(&rl->queues[port], buffer_clone(msg));
 934         rl->n_queued++;
 935         rl->n_limited++;
 936         return true;
 937     }
 938 }
 939
 940 static void
 941 rate_limit_status_cb(struct status_reply *sr, void *rl_)
 942 {
 943     struct rate_limiter *rl = rl_;
 944
 945     status_reply_put(sr, "normal=%llu", rl->n_normal);
 946     status_reply_put(sr, "limited=%llu", rl->n_limited);
 947     status_reply_put(sr, "queue-dropped=%llu", rl->n_queue_dropped);
 948     status_reply_put(sr, "tx-dropped=%llu", rl->n_tx_dropped);
 949 }
 950
 951 static void
 952 rate_limit_periodic_cb(void *rl_)
 953 {
 954     struct rate_limiter *rl = rl_;
 955     int i;
 956
 957     /* Drain some packets out of the bucket if possible, but limit the number
 958      * of iterations to allow other code to get work done too. */
 959     refill_bucket(rl);
 960     for (i = 0; rl->n_queued && get_token(rl) && i < 50; i++) {
 961         /* Use a small, arbitrary limit for the amount of queuing to do here,
 962          * because the TCP connection is responsible for buffering and there is
 963          * no point in trying to transmit faster than the TCP connection can
 964          * handle. */
 965         struct buffer *b = dequeue_packet(rl);
 966         if (rconn_send_with_limit(rl->remote_rconn, b, &rl->n_txq, 10)) {
 967             rl->n_tx_dropped++;
 968         }
 969     }
 970 }
 971
 972 static void
 973 rate_limit_wait_cb(void *rl_)
 974 {
 975     struct rate_limiter *rl = rl_;
 976     if (rl->n_queued) {
 977         if (rl->tokens >= 1000) {
 978             /* We can transmit more packets as soon as we're called again. */
 979             poll_immediate_wake();
 980         } else {
 981             /* We have to wait for the bucket to re-fill.  We could calculate
 982              * the exact amount of time here for increased smoothness. */
 983             poll_timer_wait(TIME_UPDATE_INTERVAL / 2);
 984         }
 985     }
 986 }
 987
 988 static struct hook
 989 rate_limit_hook_create(const struct settings *s, struct switch_status *ss,
 990                        struct rconn *local, struct rconn *remote)
 991 {
 992     struct rate_limiter *rl;
 993     size_t i;
 994
 995     rl = xcalloc(1, sizeof *rl);
 996     rl->s = s;
 997     rl->remote_rconn = remote;
 998     for (i = 0; i < ARRAY_SIZE(rl->queues); i++) {
 999         queue_init(&rl->queues[i]);
1000     }
1001     rl->last_fill = time_msec();
1002     rl->tokens = s->rate_limit * 100;
1003     switch_status_register_category(ss, "rate-limit",
1004                                     rate_limit_status_cb, rl);
1005     return make_hook(rate_limit_packet_cb, rate_limit_periodic_cb,
1006                      rate_limit_wait_cb, rl);
1007 }
1008 \f
1009 /* OFPST_SWITCH statistics. */
1010
1011 struct switch_status_category {
1012     char *name;
1013     void (*cb)(struct status_reply *, void *aux);
1014     void *aux;
1015 };
1016
1017 struct switch_status {
1018     const struct settings *s;
1019     time_t booted;
1020     struct switch_status_category categories[8];
1021     int n_categories;
1022 };
1023
1024 struct status_reply {
1025     struct switch_status_category *category;
1026     struct ds request;
1027     struct ds output;
1028 };
1029
1030 static bool
1031 switch_status_packet_cb(struct relay *r, int half, void *ss_)
1032 {
1033     struct switch_status *ss = ss_;
1034     struct rconn *rc = r->halves[HALF_REMOTE].rconn;
1035     struct buffer *msg = r->halves[HALF_REMOTE].rxbuf;
1036     struct switch_status_category *c;
1037     struct ofp_stats_request *osr;
1038     struct ofp_stats_reply *reply;
1039     struct status_reply sr;
1040     struct ofp_header *oh;
1041     struct buffer *b;
1042     int retval;
1043
1044     if (half == HALF_LOCAL) {
1045         return false;
1046     }
1047
1048     oh = msg->data;
1049     if (oh->type != OFPT_STATS_REQUEST) {
1050         return false;
1051     }
1052     if (msg->size < sizeof(struct ofp_stats_request)) {
1053         VLOG_WARN_RL(&vrl, "packet too short (%zu bytes) for stats_request",
1054                      msg->size);
1055         return false;
1056     }
1057
1058     osr = msg->data;
1059     if (osr->type != htons(OFPST_SWITCH)) {
1060         return false;
1061     }
1062
1063     sr.request.string = (void *) (osr + 1);
1064     sr.request.length = msg->size - sizeof *osr;
1065     ds_init(&sr.output);
1066     for (c = ss->categories; c < &ss->categories[ss->n_categories]; c++) {
1067         if (!memcmp(c->name, sr.request.string,
1068                     MIN(strlen(c->name), sr.request.length))) {
1069             sr.category = c;
1070             c->cb(&sr, c->aux);
1071         }
1072     }
1073     reply = make_openflow_xid((offsetof(struct ofp_stats_reply, body)
1074                                + sr.output.length),
1075                               OFPT_STATS_REPLY, osr->header.xid, &b);
1076     reply->type = htons(OFPST_SWITCH);
1077     reply->flags = 0;
1078     memcpy(reply->body, sr.output.string, sr.output.length);
1079     retval = rconn_send(rc, b, NULL);
1080     if (retval && retval != EAGAIN) {
1081         VLOG_WARN("send failed (%s)", strerror(retval));
1082     }
1083     ds_destroy(&sr.output);
1084     return true;
1085 }
1086
1087 static void
1088 rconn_status_cb(struct status_reply *sr, void *rconn_)
1089 {
1090     struct rconn *rconn = rconn_;
1091     time_t now = time_now();
1092
1093     status_reply_put(sr, "name=%s", rconn_get_name(rconn));
1094     status_reply_put(sr, "state=%s", rconn_get_state(rconn));
1095     status_reply_put(sr, "backoff=%d", rconn_get_backoff(rconn));
1096     status_reply_put(sr, "is-connected=%s",
1097                      rconn_is_connected(rconn) ? "true" : "false");
1098     status_reply_put(sr, "sent-msgs=%u", rconn_packets_sent(rconn));
1099     status_reply_put(sr, "received-msgs=%u", rconn_packets_received(rconn));
1100     status_reply_put(sr, "attempted-connections=%u",
1101                      rconn_get_attempted_connections(rconn));
1102     status_reply_put(sr, "successful-connections=%u",
1103                      rconn_get_successful_connections(rconn));
1104     status_reply_put(sr, "last-connection=%ld",
1105                      (long int) (now - rconn_get_last_connection(rconn)));
1106     status_reply_put(sr, "time-connected=%lu",
1107                      rconn_get_total_time_connected(rconn));
1108     status_reply_put(sr, "state-elapsed=%u", rconn_get_state_elapsed(rconn));
1109 }
1110
1111 static void
1112 config_status_cb(struct status_reply *sr, void *s_)
1113 {
1114     const struct settings *s = s_;
1115     size_t i;
1116
1117     for (i = 0; i < s->n_listeners; i++) {
1118         status_reply_put(sr, "management%zu=%s", i, s->listener_names[i]);
1119     }
1120     if (s->probe_interval) {
1121         status_reply_put(sr, "probe-interval=%d", s->probe_interval);
1122     }
1123     if (s->max_backoff) {
1124         status_reply_put(sr, "max-backoff=%d", s->max_backoff);
1125     }
1126 }
1127
1128 static void
1129 switch_status_cb(struct status_reply *sr, void *ss_)
1130 {
1131     struct switch_status *ss = ss_;
1132     time_t now = time_now();
1133
1134     status_reply_put(sr, "now=%ld", (long int) now);
1135     status_reply_put(sr, "uptime=%ld", (long int) (now - ss->booted));
1136     status_reply_put(sr, "pid=%ld", (long int) getpid());
1137 }
1138
1139 static struct hook
1140 switch_status_hook_create(const struct settings *s, struct switch_status **ssp)
1141 {
1142     struct switch_status *ss = xcalloc(1, sizeof *ss);
1143     ss->s = s;
1144     ss->booted = time_now();
1145     switch_status_register_category(ss, "config",
1146                                     config_status_cb, (void *) s);
1147     switch_status_register_category(ss, "switch", switch_status_cb, ss);
1148     *ssp = ss;
1149     return make_hook(switch_status_packet_cb, NULL, NULL, ss);
1150 }
1151
1152 static void
1153 switch_status_register_category(struct switch_status *ss,
1154                                 const char *category,
1155                                 void (*cb)(struct status_reply *,
1156                                            void *aux),
1157                                 void *aux)
1158 {
1159     struct switch_status_category *c;
1160     assert(ss->n_categories < ARRAY_SIZE(ss->categories));
1161     c = &ss->categories[ss->n_categories++];
1162     c->cb = cb;
1163     c->aux = aux;
1164     c->name = xstrdup(category);
1165 }
1166
1167 static void
1168 status_reply_put(struct status_reply *sr, const char *content, ...)
1169 {
1170     size_t old_length = sr->output.length;
1171     size_t added;
1172     va_list args;
1173
1174     /* Append the status reply to the output. */
1175     ds_put_format(&sr->output, "%s.", sr->category->name);
1176     va_start(args, content);
1177     ds_put_format_valist(&sr->output, content, args);
1178     va_end(args);
1179     if (ds_last(&sr->output) != '\n') {
1180         ds_put_char(&sr->output, '\n');
1181     }
1182
1183     /* Drop what we just added if it doesn't match the request. */
1184     added = sr->output.length - old_length;
1185     if (added < sr->request.length
1186         || memcmp(&sr->output.string[old_length],
1187                   sr->request.string, sr->request.length)) {
1188         ds_truncate(&sr->output, old_length);
1189     }
1190 }
1191
1192 \f
1193 /* Controller discovery. */
1194
1195 struct discovery
1196 {
1197     const struct settings *s;
1198     struct dhclient *dhcp;
1199     int n_changes;
1200 };
1201
1202 static void
1203 discovery_status_cb(struct status_reply *sr, void *d_)
1204 {
1205     struct discovery *d = d_;
1206
1207     status_reply_put(sr, "accept-remote=%s", d->s->accept_controller_re);
1208     status_reply_put(sr, "n-changes=%d", d->n_changes);
1209     status_reply_put(sr, "state=%s", dhclient_get_state(d->dhcp));
1210     status_reply_put(sr, "state-elapsed=%u",
1211                      dhclient_get_state_elapsed(d->dhcp));
1212     if (dhclient_is_bound(d->dhcp)) {
1213         uint32_t ip = dhclient_get_ip(d->dhcp);
1214         uint32_t netmask = dhclient_get_netmask(d->dhcp);
1215         uint32_t router = dhclient_get_router(d->dhcp);
1216
1217         const struct dhcp_msg *cfg = dhclient_get_config(d->dhcp);
1218         uint32_t dns_server;
1219         char *domain_name;
1220         int i;
1221
1222         status_reply_put(sr, "ip="IP_FMT, IP_ARGS(&ip));
1223         status_reply_put(sr, "netmask="IP_FMT, IP_ARGS(&netmask));
1224         if (router) {
1225             status_reply_put(sr, "router="IP_FMT, IP_ARGS(&router));
1226         }
1227
1228         for (i = 0; dhcp_msg_get_ip(cfg, DHCP_CODE_DNS_SERVER, i, &dns_server);
1229              i++) {
1230             status_reply_put(sr, "dns%d="IP_FMT, i, IP_ARGS(&dns_server));
1231         }
1232
1233         domain_name = dhcp_msg_get_string(cfg, DHCP_CODE_DOMAIN_NAME);
1234         if (domain_name) {
1235             status_reply_put(sr, "domain=%s", domain_name);
1236             free(domain_name);
1237         }
1238
1239         status_reply_put(sr, "lease-remaining=%u",
1240                          dhclient_get_lease_remaining(d->dhcp));
1241     }
1242 }
1243
1244 static struct discovery *
1245 discovery_init(const struct settings *s, struct switch_status *ss)
1246 {
1247     struct netdev *netdev;
1248     struct discovery *d;
1249     struct dhclient *dhcp;
1250     int retval;
1251
1252     /* Bring ofX network device up. */
1253     retval = netdev_open(s->of_name, NETDEV_ETH_TYPE_NONE, &netdev);
1254     if (retval) {
1255         fatal(retval, "Could not open %s device", s->of_name);
1256     }
1257     retval = netdev_turn_flags_on(netdev, NETDEV_UP, true);
1258     if (retval) {
1259         fatal(retval, "Could not bring %s device up", s->of_name);
1260     }
1261     netdev_close(netdev);
1262
1263     /* Initialize DHCP client. */
1264     retval = dhclient_create(s->of_name, modify_dhcp_request,
1265                              validate_dhcp_offer, (void *) s, &dhcp);
1266     if (retval) {
1267         fatal(retval, "Failed to initialize DHCP client");
1268     }
1269     dhclient_init(dhcp, 0);
1270
1271     d = xmalloc(sizeof *d);
1272     d->s = s;
1273     d->dhcp = dhcp;
1274     d->n_changes = 0;
1275
1276     switch_status_register_category(ss, "discovery", discovery_status_cb, d);
1277
1278     return d;
1279 }
1280
1281 static void
1282 discovery_question_connectivity(struct discovery *d)
1283 {
1284     dhclient_force_renew(d->dhcp, 15);
1285 }
1286
1287 static bool
1288 discovery_run(struct discovery *d, char **controller_name)
1289 {
1290     dhclient_run(d->dhcp);
1291     if (!dhclient_changed(d->dhcp)) {
1292         return false;
1293     }
1294
1295     dhclient_configure_netdev(d->dhcp);
1296     if (d->s->update_resolv_conf) {
1297         dhclient_update_resolv_conf(d->dhcp);
1298     }
1299
1300     if (dhclient_is_bound(d->dhcp)) {
1301         *controller_name = dhcp_msg_get_string(dhclient_get_config(d->dhcp),
1302                                                DHCP_CODE_OFP_CONTROLLER_VCONN);
1303         VLOG_WARN("%s: discovered controller", *controller_name);
1304         d->n_changes++;
1305     } else {
1306         *controller_name = NULL;
1307         if (d->n_changes) {
1308             VLOG_WARN("discovered controller no longer available");
1309             d->n_changes++;
1310         }
1311     }
1312     return true;
1313 }
1314
1315 static void
1316 discovery_wait(struct discovery *d)
1317 {
1318     dhclient_wait(d->dhcp);
1319 }
1320
1321 static void
1322 modify_dhcp_request(struct dhcp_msg *msg, void *aux)
1323 {
1324     dhcp_msg_put_string(msg, DHCP_CODE_VENDOR_CLASS, "OpenFlow");
1325 }
1326
1327 static bool
1328 validate_dhcp_offer(const struct dhcp_msg *msg, void *s_)
1329 {
1330     const struct settings *s = s_;
1331     char *vconn_name;
1332     bool accept;
1333
1334     vconn_name = dhcp_msg_get_string(msg, DHCP_CODE_OFP_CONTROLLER_VCONN);
1335     if (!vconn_name) {
1336         VLOG_WARN_RL(&vrl, "rejecting DHCP offer missing controller vconn");
1337         return false;
1338     }
1339     accept = !regexec(&s->accept_controller_regex, vconn_name, 0, NULL, 0);
1340     if (!accept) {
1341         VLOG_WARN_RL(&vrl, "rejecting controller vconn that fails to match %s",
1342                      s->accept_controller_re);
1343     }
1344     free(vconn_name);
1345     return accept;
1346 }
1347 \f
1348 /* User interface. */
1349
1350 static void
1351 parse_options(int argc, char *argv[], struct settings *s)
1352 {
1353     enum {
1354         OPT_ACCEPT_VCONN = UCHAR_MAX + 1,
1355         OPT_NO_RESOLV_CONF,
1356         OPT_INACTIVITY_PROBE,
1357         OPT_MAX_IDLE,
1358         OPT_MAX_BACKOFF,
1359         OPT_RATE_LIMIT,
1360         OPT_BURST_LIMIT
1361     };
1362     static struct option long_options[] = {
1363         {"accept-vconn", required_argument, 0, OPT_ACCEPT_VCONN},
1364         {"no-resolv-conf", no_argument, 0, OPT_NO_RESOLV_CONF},
1365         {"fail",        required_argument, 0, 'F'},
1366         {"inactivity-probe", required_argument, 0, OPT_INACTIVITY_PROBE},
1367         {"max-idle",    required_argument, 0, OPT_MAX_IDLE},
1368         {"max-backoff", required_argument, 0, OPT_MAX_BACKOFF},
1369         {"listen",      required_argument, 0, 'l'},
1370         {"rate-limit",  optional_argument, 0, OPT_RATE_LIMIT},
1371         {"burst-limit", required_argument, 0, OPT_BURST_LIMIT},
1372         {"detach",      no_argument, 0, 'D'},
1373         {"force",       no_argument, 0, 'f'},
1374         {"pidfile",     optional_argument, 0, 'P'},
1375         {"verbose",     optional_argument, 0, 'v'},
1376         {"help",        no_argument, 0, 'h'},
1377         {"version",     no_argument, 0, 'V'},
1378         VCONN_SSL_LONG_OPTIONS
1379         {0, 0, 0, 0},
1380     };
1381     char *short_options = long_options_to_short_options(long_options);
1382     char *accept_re = NULL;
1383     int retval;
1384
1385     /* Set defaults that we can figure out before parsing options. */
1386     s->n_listeners = 0;
1387     s->fail_mode = FAIL_OPEN;
1388     s->max_idle = 15;
1389     s->probe_interval = 15;
1390     s->max_backoff = 15;
1391     s->update_resolv_conf = true;
1392     s->rate_limit = 0;
1393     s->burst_limit = 0;
1394     for (;;) {
1395         int c;
1396
1397         c = getopt_long(argc, argv, short_options, long_options, NULL);
1398         if (c == -1) {
1399             break;
1400         }
1401
1402         switch (c) {
1403         case OPT_ACCEPT_VCONN:
1404             accept_re = optarg[0] == '^' ? optarg : xasprintf("^%s", optarg);
1405             break;
1406
1407         case OPT_NO_RESOLV_CONF:
1408             s->update_resolv_conf = false;
1409             break;
1410
1411         case 'F':
1412             if (!strcmp(optarg, "open")) {
1413                 s->fail_mode = FAIL_OPEN;
1414             } else if (!strcmp(optarg, "closed")) {
1415                 s->fail_mode = FAIL_CLOSED;
1416             } else {
1417                 fatal(0,
1418                       "-f or --fail argument must be \"open\" or \"closed\"");
1419             }
1420             break;
1421
1422         case OPT_INACTIVITY_PROBE:
1423             s->probe_interval = atoi(optarg);
1424             if (s->probe_interval < 5) {
1425                 fatal(0, "--inactivity-probe argument must be at least 5");
1426             }
1427             break;
1428
1429         case OPT_MAX_IDLE:
1430             if (!strcmp(optarg, "permanent")) {
1431                 s->max_idle = OFP_FLOW_PERMANENT;
1432             } else {
1433                 s->max_idle = atoi(optarg);
1434                 if (s->max_idle < 1 || s->max_idle > 65535) {
1435                     fatal(0, "--max-idle argument must be between 1 and "
1436                           "65535 or the word 'permanent'");
1437                 }
1438             }
1439             break;
1440
1441         case OPT_MAX_BACKOFF:
1442             s->max_backoff = atoi(optarg);
1443             if (s->max_backoff < 1) {
1444                 fatal(0, "--max-backoff argument must be at least 1");
1445             } else if (s->max_backoff > 3600) {
1446                 s->max_backoff = 3600;
1447             }
1448             break;
1449
1450         case OPT_RATE_LIMIT:
1451             if (optarg) {
1452                 s->rate_limit = atoi(optarg);
1453                 if (s->rate_limit < 1) {
1454                     fatal(0, "--rate-limit argument must be at least 1");
1455                 }
1456             } else {
1457                 s->rate_limit = 1000;
1458             }
1459             break;
1460
1461         case OPT_BURST_LIMIT:
1462             s->burst_limit = atoi(optarg);
1463             if (s->burst_limit < 1) {
1464                 fatal(0, "--burst-limit argument must be at least 1");
1465             }
1466             break;
1467
1468         case 'D':
1469             set_detach();
1470             break;
1471
1472         case 'P':
1473             set_pidfile(optarg);
1474             break;
1475
1476         case 'f':
1477             ignore_existing_pidfile();
1478             break;
1479
1480         case 'l':
1481             if (s->n_listeners >= MAX_MGMT) {
1482                 fatal(0, "-l or --listen may be specified at most %d times",
1483                       MAX_MGMT);
1484             }
1485             s->listener_names[s->n_listeners++] = optarg;
1486             break;
1487
1488         case 'h':
1489             usage();
1490
1491         case 'V':
1492             printf("%s "VERSION" compiled "__DATE__" "__TIME__"\n", argv[0]);
1493             exit(EXIT_SUCCESS);
1494
1495         case 'v':
1496             vlog_set_verbosity(optarg);
1497             break;
1498
1499         VCONN_SSL_OPTION_HANDLERS
1500
1501         case '?':
1502             exit(EXIT_FAILURE);
1503
1504         default:
1505             abort();
1506         }
1507     }
1508     free(short_options);
1509
1510     argc -= optind;
1511     argv += optind;
1512     if (argc < 1 || argc > 2) {
1513         fatal(0, "need one or two non-option arguments; use --help for usage");
1514     }
1515
1516     /* Local and remote vconns. */
1517     s->nl_name = argv[0];
1518     if (strncmp(s->nl_name, "nl:", 3)
1519         || strlen(s->nl_name) < 4
1520         || s->nl_name[strspn(s->nl_name + 3, "0123456789") + 3]) {
1521         fatal(0, "%s: argument is not of the form \"nl:DP_IDX\"", s->nl_name);
1522     }
1523     s->of_name = xasprintf("of%s", s->nl_name + 3);
1524     s->controller_name = argc > 1 ? xstrdup(argv[1]) : NULL;
1525
1526     /* Set accept_controller_regex. */
1527     if (!accept_re) {
1528         accept_re = vconn_ssl_is_configured() ? "^ssl:.*" : ".*";
1529     }
1530     retval = regcomp(&s->accept_controller_regex, accept_re,
1531                      REG_NOSUB | REG_EXTENDED);
1532     if (retval) {
1533         size_t length = regerror(retval, &s->accept_controller_regex, NULL, 0);
1534         char *buffer = xmalloc(length);
1535         regerror(retval, &s->accept_controller_regex, buffer, length);
1536         fatal(0, "%s: %s", accept_re, buffer);
1537     }
1538     s->accept_controller_re = accept_re;
1539
1540     /* Mode of operation. */
1541     s->discovery = s->controller_name == NULL;
1542     if (s->discovery) {
1543         s->in_band = true;
1544     } else {
1545         enum netdev_flags flags;
1546         struct netdev *netdev;
1547
1548         retval = netdev_open(s->of_name, NETDEV_ETH_TYPE_NONE, &netdev);
1549         if (retval) {
1550             fatal(retval, "Could not open %s device", s->of_name);
1551         }
1552
1553         retval = netdev_get_flags(netdev, &flags);
1554         if (retval) {
1555             fatal(retval, "Could not get flags for %s device", s->of_name);
1556         }
1557
1558         s->in_band = (flags & NETDEV_UP) != 0;
1559         if (s->in_band && netdev_get_in6(netdev, NULL)) {
1560             VLOG_WARN("Ignoring IPv6 address on %s device: IPv6 not supported",
1561                       s->of_name);
1562         }
1563
1564         netdev_close(netdev);
1565     }
1566
1567     /* Rate limiting. */
1568     if (s->rate_limit) {
1569         if (s->rate_limit < 100) {
1570             VLOG_WARN("Rate limit set to unusually low value %d",
1571                       s->rate_limit);
1572         }
1573         if (!s->burst_limit) {
1574             s->burst_limit = s->rate_limit / 4;
1575         }
1576         s->burst_limit = MAX(s->burst_limit, 1);
1577         s->burst_limit = MIN(s->burst_limit, INT_MAX / 1000);
1578     }
1579 }
1580
1581 static void
1582 usage(void)
1583 {
1584     printf("%s: secure channel, a relay for OpenFlow messages.\n"
1585            "usage: %s [OPTIONS] nl:DP_IDX [CONTROLLER]\n"
1586            "where nl:DP_IDX is a datapath that has been added with dpctl.\n"
1587            "CONTROLLER is an active OpenFlow connection method; if it is\n"
1588            "omitted, then secchan performs controller discovery.\n",
1589            program_name, program_name);
1590     vconn_usage(true, true);
1591     printf("\nController discovery options:\n"
1592            "  --accept-vconn=REGEX    accept matching discovered controllers\n"
1593            "  --no-resolv-conf        do not update /etc/resolv.conf\n"
1594            "\nNetworking options:\n"
1595            "  -F, --fail=open|closed  when controller connection fails:\n"
1596            "                            closed: drop all packets\n"
1597            "                            open (default): act as learning switch\n"
1598            "  --inactivity-probe=SECS time between inactivity probes\n"
1599            "  --max-idle=SECS         max idle for flows set up by secchan\n"
1600            "  --max-backoff=SECS      max time between controller connection\n"
1601            "                          attempts (default: 15 seconds)\n"
1602            "  -l, --listen=METHOD     allow management connections on METHOD\n"
1603            "                          (a passive OpenFlow connection method)\n"
1604            "\nRate-limiting of \"packet-in\" messages to the controller:\n"
1605            "  --rate-limit[=PACKETS]  max rate, in packets/s (default: 1000)\n"
1606            "  --burst-limit=BURST     limit on packet credit for idle time\n"
1607            "\nOther options:\n"
1608            "  -D, --detach            run in background as daemon\n"
1609            "  -P, --pidfile[=FILE]    create pidfile (default: %s/secchan.pid)\n"
1610            "  -f, --force             with -P, start even if already running\n"
1611            "  -v, --verbose=MODULE[:FACILITY[:LEVEL]]  set logging levels\n"
1612            "  -v, --verbose           set maximum verbosity level\n"
1613            "  -h, --help              display this help message\n"
1614            "  -V, --version           display version information\n",
1615            RUNDIR);
1616     exit(EXIT_SUCCESS);
1617 }