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 "command-line.h"
  49 #include "compiler.h"
  50 #include "daemon.h"
  51 #include "dhcp-client.h"
  52 #include "dhcp.h"
  53 #include "dynamic-string.h"
  54 #include "fault.h"
  55 #include "flow.h"
  56 #include "learning-switch.h"
  57 #include "list.h"
  58 #include "mac-learning.h"
  59 #include "netdev.h"
  60 #include "nicira-ext.h"
  61 #include "ofpbuf.h"
  62 #include "openflow.h"
  63 #include "packets.h"
  64 #include "poll-loop.h"
  65 #include "rconn.h"
  66 #include "stp.h"
  67 #include "timeval.h"
  68 #include "util.h"
  69 #include "vconn-ssl.h"
  70 #include "vconn.h"
  71 #include "vlog-socket.h"
  72
  73 #include "vlog.h"
  74 #define THIS_MODULE VLM_secchan
  75
  76 /* Behavior when the connection to the controller fails. */
  77 enum fail_mode {
  78     FAIL_OPEN,                  /* Act as learning switch. */
  79     FAIL_CLOSED                 /* Drop all packets. */
  80 };
  81
  82 /* Maximum number of management connection listeners. */
  83 #define MAX_MGMT 8
  84
  85 /* Settings that may be configured by the user. */
  86 struct settings {
  87     /* Overall mode of operation. */
  88     bool discovery;           /* Discover the controller automatically? */
  89     bool in_band;             /* Connect to controller in-band? */
  90
  91     /* Related vconns and network devices. */
  92     const char *nl_name;        /* Local datapath (must be "nl:" vconn). */
  93     char *of_name;              /* ofX network device name. */
  94     const char *controller_name; /* Controller (if not discovery mode). */
  95     const char *listener_names[MAX_MGMT]; /* Listen for mgmt connections. */
  96     size_t n_listeners;          /* Number of mgmt connection listeners. */
  97     const char *monitor_name;   /* Listen for traffic monitor connections. */
  98
  99     /* Failure behavior. */
 100     enum fail_mode fail_mode; /* Act as learning switch if no controller? */
 101     int max_idle;             /* Idle time for flows in fail-open mode. */
 102     int probe_interval;       /* # seconds idle before sending echo request. */
 103     int max_backoff;          /* Max # seconds between connection attempts. */
 104
 105     /* Packet-in rate-limiting. */
 106     int rate_limit;           /* Tokens added to bucket per second. */
 107     int burst_limit;          /* Maximum number token bucket size. */
 108
 109     /* Discovery behavior. */
 110     regex_t accept_controller_regex;  /* Controller vconns to accept. */
 111     const char *accept_controller_re; /* String version of regex. */
 112     bool update_resolv_conf;          /* Update /etc/resolv.conf? */
 113
 114     /* Spanning tree protocol. */
 115     bool enable_stp;
 116 };
 117
 118 struct half {
 119     struct rconn *rconn;
 120     struct ofpbuf *rxbuf;
 121     int n_txq;                  /* No. of packets queued for tx on 'rconn'. */
 122 };
 123
 124 struct relay {
 125     struct list node;
 126
 127 #define HALF_LOCAL 0
 128 #define HALF_REMOTE 1
 129     struct half halves[2];
 130
 131     bool is_mgmt_conn;
 132 };
 133
 134 struct hook {
 135     bool (*packet_cb[2])(struct relay *, void *aux);
 136     void (*periodic_cb)(void *aux);
 137     void (*wait_cb)(void *aux);
 138     void *aux;
 139 };
 140
 141 static struct vlog_rate_limit vrl = VLOG_RATE_LIMIT_INIT(60, 60);
 142
 143 static void parse_options(int argc, char *argv[], struct settings *);
 144 static void usage(void) NO_RETURN;
 145
 146 static struct pvconn *open_passive_vconn(const char *name);
 147 static struct vconn *accept_vconn(struct pvconn *pvconn);
 148
 149 static struct relay *relay_create(struct rconn *local, struct rconn *remote,
 150                                   bool is_mgmt_conn);
 151 static struct relay *relay_accept(const struct settings *, struct pvconn *);
 152 static void relay_run(struct relay *, const struct hook[], size_t n_hooks);
 153 static void relay_wait(struct relay *);
 154 static void relay_destroy(struct relay *);
 155
 156 static struct hook make_hook(bool (*local_packet_cb)(struct relay *, void *),
 157                              bool (*remote_packet_cb)(struct relay *, void *),
 158                              void (*periodic_cb)(void *),
 159                              void (*wait_cb)(void *),
 160                              void *aux);
 161 static struct ofp_packet_in *get_ofp_packet_in(struct relay *);
 162 static bool get_ofp_packet_eth_header(struct relay *, struct ofp_packet_in **,
 163                                       struct eth_header **);
 164 static void get_ofp_packet_payload(struct ofp_packet_in *, struct ofpbuf *);
 165
 166 struct switch_status;
 167 struct status_reply;
 168 static struct hook switch_status_hook_create(const struct settings *,
 169                                              struct switch_status **);
 170 static void switch_status_register_category(struct switch_status *,
 171                                             const char *category,
 172                                             void (*cb)(struct status_reply *,
 173                                                        void *aux),
 174                                             void *aux);
 175 static void status_reply_put(struct status_reply *, const char *, ...)
 176     PRINTF_FORMAT(2, 3);
 177
 178 static void rconn_status_cb(struct status_reply *, void *rconn_);
 179
 180 static struct discovery *discovery_init(const struct settings *,
 181                                         struct switch_status *);
 182 static void discovery_question_connectivity(struct discovery *);
 183 static bool discovery_run(struct discovery *, char **controller_name);
 184 static void discovery_wait(struct discovery *);
 185
 186 static struct hook in_band_hook_create(const struct settings *,
 187                                        struct switch_status *,
 188                                        struct rconn *remote);
 189
 190 struct port_watcher;
 191 static struct hook port_watcher_create(struct rconn *local,
 192                                        struct rconn *remote,
 193                                        struct port_watcher **);
 194 static uint32_t port_watcher_get_flags(const struct port_watcher *,
 195                                        int port_no);
 196 static void port_watcher_set_flags(struct port_watcher *,
 197                                    int port_no, uint32_t flags, uint32_t mask);
 198
 199 static struct hook stp_hook_create(const struct settings *,
 200                                    struct port_watcher *,
 201                                    struct rconn *local, struct rconn *remote);
 202
 203 static struct hook fail_open_hook_create(const struct settings *,
 204                                          struct switch_status *,
 205                                          struct rconn *local,
 206                                          struct rconn *remote);
 207 static struct hook rate_limit_hook_create(const struct settings *,
 208                                           struct switch_status *,
 209                                           struct rconn *local,
 210                                           struct rconn *remote);
 211
 212
 213 static void modify_dhcp_request(struct dhcp_msg *, void *aux);
 214 static bool validate_dhcp_offer(const struct dhcp_msg *, void *aux);
 215
 216 int
 217 main(int argc, char *argv[])
 218 {
 219     struct settings s;
 220
 221     struct list relays = LIST_INITIALIZER(&relays);
 222
 223     struct hook hooks[8];
 224     size_t n_hooks = 0;
 225
 226     struct pvconn *monitor;
 227
 228     struct pvconn *listeners[MAX_MGMT];
 229     size_t n_listeners;
 230
 231     struct rconn *local_rconn, *remote_rconn;
 232     struct relay *controller_relay;
 233     struct discovery *discovery;
 234     struct switch_status *switch_status;
 235     struct port_watcher *pw;
 236     int i;
 237     int retval;
 238
 239     set_program_name(argv[0]);
 240     register_fault_handlers();
 241     time_init();
 242     vlog_init();
 243     parse_options(argc, argv, &s);
 244     signal(SIGPIPE, SIG_IGN);
 245
 246     /* Start listening for management and monitoring connections. */
 247     n_listeners = 0;
 248     for (i = 0; i < s.n_listeners; i++) {
 249         listeners[n_listeners++] = open_passive_vconn(s.listener_names[i]);
 250     }
 251     monitor = s.monitor_name ? open_passive_vconn(s.monitor_name) : NULL;
 252
 253     /* Initialize switch status hook. */
 254     hooks[n_hooks++] = switch_status_hook_create(&s, &switch_status);
 255
 256     /* Start controller discovery. */
 257     discovery = s.discovery ? discovery_init(&s, switch_status) : NULL;
 258
 259     /* Start listening for vlogconf requests. */
 260     retval = vlog_server_listen(NULL, NULL);
 261     if (retval) {
 262         ofp_fatal(retval, "Could not listen for vlog connections");
 263     }
 264
 265     die_if_already_running();
 266     daemonize();
 267
 268     VLOG_WARN("OpenFlow reference implementation version %s", VERSION);
 269     VLOG_WARN("OpenFlow protocol version 0x%02x", OFP_VERSION);
 270
 271     /* Connect to datapath. */
 272     local_rconn = rconn_create(0, s.max_backoff);
 273     rconn_connect(local_rconn, s.nl_name);
 274     switch_status_register_category(switch_status, "local",
 275                                     rconn_status_cb, local_rconn);
 276
 277     /* Connect to controller. */
 278     remote_rconn = rconn_create(s.probe_interval, s.max_backoff);
 279     if (s.controller_name) {
 280         retval = rconn_connect(remote_rconn, s.controller_name);
 281         if (retval == EAFNOSUPPORT) {
 282             ofp_fatal(0, "No support for %s vconn", s.controller_name);
 283         }
 284     }
 285     switch_status_register_category(switch_status, "remote",
 286                                     rconn_status_cb, remote_rconn);
 287
 288     /* Start relaying. */
 289     controller_relay = relay_create(local_rconn, remote_rconn, false);
 290     list_push_back(&relays, &controller_relay->node);
 291
 292     /* Set up hooks. */
 293     hooks[n_hooks++] = port_watcher_create(local_rconn, remote_rconn, &pw);
 294     if (s.enable_stp) {
 295         hooks[n_hooks++] = stp_hook_create(&s, pw, local_rconn, remote_rconn);
 296     }
 297     if (s.in_band) {
 298         hooks[n_hooks++] = in_band_hook_create(&s, switch_status,
 299                                                remote_rconn);
 300     }
 301     if (s.fail_mode == FAIL_OPEN) {
 302         hooks[n_hooks++] = fail_open_hook_create(&s, switch_status,
 303                                                  local_rconn, remote_rconn);
 304     }
 305     if (s.rate_limit) {
 306         hooks[n_hooks++] = rate_limit_hook_create(&s, switch_status,
 307                                                   local_rconn, remote_rconn);
 308     }
 309     assert(n_hooks <= ARRAY_SIZE(hooks));
 310
 311     for (;;) {
 312         struct relay *r, *n;
 313         size_t i;
 314
 315         /* Do work. */
 316         LIST_FOR_EACH_SAFE (r, n, struct relay, node, &relays) {
 317             relay_run(r, hooks, n_hooks);
 318         }
 319         for (i = 0; i < n_listeners; i++) {
 320             for (;;) {
 321                 struct relay *r = relay_accept(&s, listeners[i]);
 322                 if (!r) {
 323                     break;
 324                 }
 325                 list_push_back(&relays, &r->node);
 326             }
 327         }
 328         if (monitor) {
 329             struct vconn *new = accept_vconn(monitor);
 330             if (new) {
 331                 rconn_add_monitor(local_rconn, new);
 332             }
 333         }
 334         for (i = 0; i < n_hooks; i++) {
 335             if (hooks[i].periodic_cb) {
 336                 hooks[i].periodic_cb(hooks[i].aux);
 337             }
 338         }
 339         if (s.discovery) {
 340             char *controller_name;
 341             if (rconn_is_connectivity_questionable(remote_rconn)) {
 342                 discovery_question_connectivity(discovery);
 343             }
 344             if (discovery_run(discovery, &controller_name)) {
 345                 if (controller_name) {
 346                     rconn_connect(remote_rconn, controller_name);
 347                 } else {
 348                     rconn_disconnect(remote_rconn);
 349                 }
 350             }
 351         }
 352
 353         /* Wait for something to happen. */
 354         LIST_FOR_EACH (r, struct relay, node, &relays) {
 355             relay_wait(r);
 356         }
 357         for (i = 0; i < n_listeners; i++) {
 358             pvconn_wait(listeners[i]);
 359         }
 360         if (monitor) {
 361             pvconn_wait(monitor);
 362         }
 363         for (i = 0; i < n_hooks; i++) {
 364             if (hooks[i].wait_cb) {
 365                 hooks[i].wait_cb(hooks[i].aux);
 366             }
 367         }
 368         if (discovery) {
 369             discovery_wait(discovery);
 370         }
 371         poll_block();
 372     }
 373
 374     return 0;
 375 }
 376
 377 static struct pvconn *
 378 open_passive_vconn(const char *name)
 379 {
 380     struct pvconn *pvconn;
 381     int retval;
 382
 383     retval = pvconn_open(name, &pvconn);
 384     if (retval && retval != EAGAIN) {
 385         ofp_fatal(retval, "opening %s", name);
 386     }
 387     return pvconn;
 388 }
 389
 390 static struct vconn *
 391 accept_vconn(struct pvconn *pvconn)
 392 {
 393     struct vconn *new;
 394     int retval;
 395
 396     retval = pvconn_accept(pvconn, OFP_VERSION, &new);
 397     if (retval && retval != EAGAIN) {
 398         VLOG_WARN_RL(&vrl, "accept failed (%s)", strerror(retval));
 399     }
 400     return new;
 401 }
 402
 403 static struct hook
 404 make_hook(bool (*local_packet_cb)(struct relay *, void *aux),
 405           bool (*remote_packet_cb)(struct relay *, void *aux),
 406           void (*periodic_cb)(void *aux),
 407           void (*wait_cb)(void *aux),
 408           void *aux)
 409 {
 410     struct hook h;
 411     h.packet_cb[HALF_LOCAL] = local_packet_cb;
 412     h.packet_cb[HALF_REMOTE] = remote_packet_cb;
 413     h.periodic_cb = periodic_cb;
 414     h.wait_cb = wait_cb;
 415     h.aux = aux;
 416     return h;
 417 }
 418
 419 static struct ofp_packet_in *
 420 get_ofp_packet_in(struct relay *r)
 421 {
 422     struct ofpbuf *msg = r->halves[HALF_LOCAL].rxbuf;
 423     struct ofp_header *oh = msg->data;
 424     if (oh->type == OFPT_PACKET_IN) {
 425         if (msg->size >= offsetof (struct ofp_packet_in, data)) {
 426             return msg->data;
 427         } else {
 428             VLOG_WARN("packet too short (%zu bytes) for packet_in",
 429                       msg->size);
 430         }
 431     }
 432     return NULL;
 433 }
 434
 435 static bool
 436 get_ofp_packet_eth_header(struct relay *r, struct ofp_packet_in **opip,
 437                           struct eth_header **ethp)
 438 {
 439     const int min_len = offsetof(struct ofp_packet_in, data) + ETH_HEADER_LEN;
 440     struct ofp_packet_in *opi = get_ofp_packet_in(r);
 441     if (opi && ntohs(opi->header.length) >= min_len) {
 442         *opip = opi;
 443         *ethp = (void *) opi->data;
 444         return true;
 445     }
 446     return false;
 447 }
 448
 449 \f
 450 /* OpenFlow message relaying. */
 451
 452 static struct relay *
 453 relay_accept(const struct settings *s, struct pvconn *pvconn)
 454 {
 455     struct vconn *new_remote, *new_local;
 456     char *nl_name_without_subscription;
 457     struct rconn *r1, *r2;
 458     int retval;
 459
 460     new_remote = accept_vconn(pvconn);
 461     if (!new_remote) {
 462         return NULL;
 463     }
 464
 465     /* nl:123 or nl:123:1 opens a netlink connection to local datapath 123.  We
 466      * only accept the former syntax in main().
 467      *
 468      * nl:123:0 opens a netlink connection to local datapath 123 without
 469      * obtaining a subscription for ofp_packet_in or ofp_flow_expired
 470      * messages.*/
 471     nl_name_without_subscription = xasprintf("%s:0", s->nl_name);
 472     retval = vconn_open(nl_name_without_subscription, OFP_VERSION, &new_local);
 473     if (retval) {
 474         VLOG_ERR_RL(&vrl, "could not connect to %s (%s)",
 475                     nl_name_without_subscription, strerror(retval));
 476         vconn_close(new_remote);
 477         free(nl_name_without_subscription);
 478         return NULL;
 479     }
 480
 481     /* Create and return relay. */
 482     r1 = rconn_create(0, 0);
 483     rconn_connect_unreliably(r1, nl_name_without_subscription, new_local);
 484     free(nl_name_without_subscription);
 485
 486     r2 = rconn_create(0, 0);
 487     rconn_connect_unreliably(r2, "passive", new_remote);
 488
 489     return relay_create(r1, r2, true);
 490 }
 491
 492 static struct relay *
 493 relay_create(struct rconn *local, struct rconn *remote, bool is_mgmt_conn)
 494 {
 495     struct relay *r = xcalloc(1, sizeof *r);
 496     r->halves[HALF_LOCAL].rconn = local;
 497     r->halves[HALF_REMOTE].rconn = remote;
 498     r->is_mgmt_conn = is_mgmt_conn;
 499     return r;
 500 }
 501
 502 static void
 503 relay_run(struct relay *r, const struct hook hooks[], size_t n_hooks)
 504 {
 505     int iteration;
 506     int i;
 507
 508     for (i = 0; i < 2; i++) {
 509         rconn_run(r->halves[i].rconn);
 510     }
 511
 512     /* Limit the number of iterations to prevent other tasks from starving. */
 513     for (iteration = 0; iteration < 50; iteration++) {
 514         bool progress = false;
 515         for (i = 0; i < 2; i++) {
 516             struct half *this = &r->halves[i];
 517             struct half *peer = &r->halves[!i];
 518
 519             if (!this->rxbuf) {
 520                 this->rxbuf = rconn_recv(this->rconn);
 521                 if (this->rxbuf && (i == HALF_REMOTE || !r->is_mgmt_conn)) {
 522                     const struct hook *h;
 523                     for (h = hooks; h < &hooks[n_hooks]; h++) {
 524                         if (h->packet_cb[i] && h->packet_cb[i](r, h->aux)) {
 525                             ofpbuf_delete(this->rxbuf);
 526                             this->rxbuf = NULL;
 527                             progress = true;
 528                             break;
 529                         }
 530                     }
 531                 }
 532             }
 533
 534             if (this->rxbuf && !this->n_txq) {
 535                 int retval = rconn_send(peer->rconn, this->rxbuf,
 536                                         &this->n_txq);
 537                 if (retval != EAGAIN) {
 538                     if (!retval) {
 539                         progress = true;
 540                     } else {
 541                         ofpbuf_delete(this->rxbuf);
 542                     }
 543                     this->rxbuf = NULL;
 544                 }
 545             }
 546         }
 547         if (!progress) {
 548             break;
 549         }
 550     }
 551
 552     if (r->is_mgmt_conn) {
 553         for (i = 0; i < 2; i++) {
 554             struct half *this = &r->halves[i];
 555             if (!rconn_is_alive(this->rconn)) {
 556                 relay_destroy(r);
 557                 return;
 558             }
 559         }
 560     }
 561 }
 562
 563 static void
 564 relay_wait(struct relay *r)
 565 {
 566     int i;
 567
 568     for (i = 0; i < 2; i++) {
 569         struct half *this = &r->halves[i];
 570
 571         rconn_run_wait(this->rconn);
 572         if (!this->rxbuf) {
 573             rconn_recv_wait(this->rconn);
 574         }
 575     }
 576 }
 577
 578 static void
 579 relay_destroy(struct relay *r)
 580 {
 581     int i;
 582
 583     list_remove(&r->node);
 584     for (i = 0; i < 2; i++) {
 585         struct half *this = &r->halves[i];
 586         rconn_destroy(this->rconn);
 587         ofpbuf_delete(this->rxbuf);
 588     }
 589     free(r);
 590 }
 591 \f
 592 /* Port status watcher. */
 593
 594 typedef void port_changed_cb_func(uint16_t port_no,
 595                                   const struct ofp_phy_port *old,
 596                                   const struct ofp_phy_port *new,
 597                                   void *aux);
 598
 599 struct port_watcher_cb {
 600     port_changed_cb_func *port_changed;
 601     void *aux;
 602 };
 603
 604 struct port_watcher {
 605     struct rconn *local_rconn;
 606     struct rconn *remote_rconn;
 607     struct ofp_phy_port ports[OFPP_MAX + 1];
 608     time_t last_feature_request;
 609     bool got_feature_reply;
 610     int n_txq;
 611     struct port_watcher_cb cbs[2];
 612     int n_cbs;
 613 };
 614
 615 /* Returns the number of fields that differ from 'a' to 'b'. */
 616 static int
 617 opp_differs(const struct ofp_phy_port *a, const struct ofp_phy_port *b)
 618 {
 619     BUILD_ASSERT_DECL(sizeof *a == 36); /* Trips when we add or remove fields. */
 620     return ((a->port_no != b->port_no)
 621             + (memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr) != 0)
 622             + (memcmp(a->name, b->name, sizeof a->name) != 0)
 623             + (a->flags != b->flags)
 624             + (a->speed != b->speed)
 625             + (a->features != b->features));
 626 }
 627
 628 static void
 629 sanitize_opp(struct ofp_phy_port *opp)
 630 {
 631     size_t i;
 632
 633     for (i = 0; i < sizeof opp->name; i++) {
 634         char c = opp->name[i];
 635         if (c && (c < 0x20 || c > 0x7e)) {
 636             opp->name[i] = '.';
 637         }
 638     }
 639     opp->name[sizeof opp->name - 1] = '\0';
 640 }
 641
 642 static int
 643 port_no_to_pw_idx(int port_no)
 644 {
 645     return (port_no < OFPP_MAX ? port_no
 646             : port_no == OFPP_LOCAL ? OFPP_MAX
 647             : -1);
 648 }
 649
 650 static void
 651 call_port_changed_callbacks(struct port_watcher *pw, int port_no,
 652                             const struct ofp_phy_port *old,
 653                             const struct ofp_phy_port *new)
 654 {
 655     if (opp_differs(old, new)) {
 656         int i;
 657         for (i = 0; i < pw->n_cbs; i++) {
 658             port_changed_cb_func *port_changed = pw->cbs[i].port_changed;
 659             if (port_changed) {
 660                 (port_changed)(port_no, old, new, pw->cbs[i].aux);
 661             }
 662         }
 663     }
 664 }
 665
 666 static void
 667 update_phy_port(struct port_watcher *pw, struct ofp_phy_port *opp,
 668                 uint8_t reason, bool seen[OFPP_MAX + 1])
 669 {
 670     struct ofp_phy_port *pw_opp;
 671     struct ofp_phy_port old;
 672     uint16_t port_no;
 673     int idx;
 674
 675     port_no = ntohs(opp->port_no);
 676     idx = port_no_to_pw_idx(port_no);
 677     if (idx < 0) {
 678         return;
 679     }
 680
 681     if (seen) {
 682         seen[idx] = true;
 683     }
 684
 685     pw_opp = &pw->ports[idx];
 686     old = *pw_opp;
 687     if (reason == OFPPR_DELETE) {
 688         memset(pw_opp, 0, sizeof *pw_opp);
 689         pw_opp->port_no = htons(OFPP_NONE);
 690     } else if (reason == OFPPR_MOD || reason == OFPPR_ADD) {
 691         *pw_opp = *opp;
 692         sanitize_opp(pw_opp);
 693     }
 694     call_port_changed_callbacks(pw, port_no, &old, pw_opp);
 695 }
 696
 697 static bool
 698 port_watcher_local_packet_cb(struct relay *r, void *pw_)
 699 {
 700     struct port_watcher *pw = pw_;
 701     struct ofpbuf *msg = r->halves[HALF_LOCAL].rxbuf;
 702     struct ofp_header *oh = msg->data;
 703
 704     if (oh->type == OFPT_FEATURES_REPLY
 705         && msg->size >= offsetof(struct ofp_switch_features, ports)) {
 706         struct ofp_switch_features *osf = msg->data;
 707         bool seen[ARRAY_SIZE(pw->ports)];
 708         size_t n_ports;
 709         size_t i;
 710
 711         pw->got_feature_reply = true;
 712
 713         /* Update each port included in the message. */
 714         memset(seen, 0, sizeof seen);
 715         n_ports = ((msg->size - offsetof(struct ofp_switch_features, ports))
 716                    / sizeof *osf->ports);
 717         for (i = 0; i < n_ports; i++) {
 718             struct ofp_phy_port *opp = &osf->ports[i];
 719             update_phy_port(pw, opp, OFPPR_MOD, seen);
 720         }
 721
 722         /* Delete all the ports not included in the message. */
 723         for (i = 0; i < ARRAY_SIZE(pw->ports); i++) {
 724             if (!seen[i]) {
 725                 update_phy_port(pw, &pw->ports[i], OFPPR_DELETE, NULL);
 726             }
 727         }
 728     } else if (oh->type == OFPT_PORT_STATUS
 729                && msg->size >= sizeof(struct ofp_port_status)) {
 730         struct ofp_port_status *ops = msg->data;
 731         update_phy_port(pw, &ops->desc, ops->reason, NULL);
 732     }
 733     return false;
 734 }
 735
 736 static bool
 737 port_watcher_remote_packet_cb(struct relay *r, void *pw_)
 738 {
 739     struct port_watcher *pw = pw_;
 740     struct ofpbuf *msg = r->halves[HALF_REMOTE].rxbuf;
 741     struct ofp_header *oh = msg->data;
 742
 743     if (oh->type == OFPT_PORT_MOD
 744         && msg->size >= sizeof(struct ofp_port_mod)) {
 745         struct ofp_port_mod *opm = msg->data;
 746         uint16_t port_no = ntohs(opm->desc.port_no);
 747         int idx = port_no_to_pw_idx(port_no);
 748         if (idx >= 0) {
 749             struct ofp_phy_port *pw_opp = &pw->ports[idx];
 750             if (pw_opp->port_no != htons(OFPP_NONE)) {
 751                 struct ofp_phy_port old = *pw_opp;
 752                 pw_opp->flags = ((pw_opp->flags & ~opm->mask)
 753                                  | (opm->desc.flags & opm->mask));
 754                 call_port_changed_callbacks(pw, port_no, &old, pw_opp);
 755             }
 756         }
 757     }
 758     return false;
 759 }
 760
 761 static void
 762 port_watcher_periodic_cb(void *pw_)
 763 {
 764     struct port_watcher *pw = pw_;
 765
 766     if (!pw->got_feature_reply && time_now() >= pw->last_feature_request + 5) {
 767         struct ofpbuf *b;
 768         make_openflow(sizeof(struct ofp_header), OFPT_FEATURES_REQUEST, &b);
 769         rconn_send_with_limit(pw->local_rconn, b, &pw->n_txq, 1);
 770         pw->last_feature_request = time_now();
 771     }
 772 }
 773
 774 static void
 775 put_duplexes(struct ds *ds, const char *name, uint32_t features,
 776              uint32_t hd_bit, uint32_t fd_bit)
 777 {
 778     if (features & (hd_bit | fd_bit)) {
 779         ds_put_format(ds, " %s", name);
 780         if (features & hd_bit) {
 781             ds_put_cstr(ds, "(HD)");
 782         }
 783         if (features & fd_bit) {
 784             ds_put_cstr(ds, "(FD)");
 785         }
 786     }
 787 }
 788
 789 static void
 790 log_port_status(uint16_t port_no,
 791                 const struct ofp_phy_port *old,
 792                 const struct ofp_phy_port *new,
 793                 void *aux)
 794 {
 795     if (VLOG_IS_DBG_ENABLED()) {
 796         bool was_enabled = old->port_no != htons(OFPP_NONE);
 797         bool now_enabled = new->port_no != htons(OFPP_NONE);
 798         uint32_t features = ntohl(new->features);
 799         struct ds ds;
 800
 801         if (old->flags != new->flags && opp_differs(old, new) == 1) {
 802             /* Don't care if only flags changed. */
 803             return;
 804         }
 805
 806         ds_init(&ds);
 807         ds_put_format(&ds, "\"%s\", "ETH_ADDR_FMT, new->name,
 808                       ETH_ADDR_ARGS(new->hw_addr));
 809         if (ntohl(new->speed)) {
 810             ds_put_format(&ds, ", speed %"PRIu32, ntohl(new->speed));
 811         }
 812         if (features & (OFPPF_10MB_HD | OFPPF_10MB_FD
 813                         | OFPPF_100MB_HD | OFPPF_100MB_FD
 814                         | OFPPF_1GB_HD | OFPPF_1GB_FD | OFPPF_10GB_FD)) {
 815             ds_put_cstr(&ds, ", supports");
 816             put_duplexes(&ds, "10M", features, OFPPF_10MB_HD, OFPPF_10MB_FD);
 817             put_duplexes(&ds, "100M", features,
 818                          OFPPF_100MB_HD, OFPPF_100MB_FD);
 819             put_duplexes(&ds, "1G", features, OFPPF_100MB_HD, OFPPF_100MB_FD);
 820             if (features & OFPPF_10GB_FD) {
 821                 ds_put_cstr(&ds, " 10G");
 822             }
 823         }
 824         if (was_enabled != now_enabled) {
 825             if (now_enabled) {
 826                 VLOG_DBG("Port %d added: %s", port_no, ds_cstr(&ds));
 827             } else {
 828                 VLOG_DBG("Port %d deleted", port_no);
 829             }
 830         } else {
 831             VLOG_DBG("Port %d changed: %s", port_no, ds_cstr(&ds));
 832         }
 833         ds_destroy(&ds);
 834     }
 835 }
 836
 837 static void
 838 port_watcher_register_callback(struct port_watcher *pw,
 839                                port_changed_cb_func *port_changed,
 840                                void *aux)
 841 {
 842     assert(pw->n_cbs < ARRAY_SIZE(pw->cbs));
 843     pw->cbs[pw->n_cbs].port_changed = port_changed;
 844     pw->cbs[pw->n_cbs].aux = aux;
 845     pw->n_cbs++;
 846 }
 847
 848 static uint32_t
 849 port_watcher_get_flags(const struct port_watcher *pw, int port_no)
 850 {
 851     int idx = port_no_to_pw_idx(port_no);
 852     return idx >= 0 ? ntohl(pw->ports[idx].flags) : 0;
 853 }
 854
 855 static void
 856 port_watcher_set_flags(struct port_watcher *pw,
 857                        int port_no, uint32_t flags, uint32_t mask)
 858 {
 859     struct ofp_phy_port old;
 860     struct ofp_phy_port *p;
 861     struct ofp_port_mod *opm;
 862     struct ofp_port_status *ops;
 863     struct ofpbuf *b;
 864     int idx;
 865
 866     idx = port_no_to_pw_idx(port_no);
 867     if (idx < 0) {
 868         return;
 869     }
 870
 871     p = &pw->ports[idx];
 872     if (!((ntohl(p->flags) ^ flags) & mask)) {
 873         return;
 874     }
 875     old = *p;
 876
 877     /* Update our idea of the flags. */
 878     p->flags = htonl((ntohl(p->flags) & ~mask) | (flags & mask));
 879     call_port_changed_callbacks(pw, port_no, &old, p);
 880
 881     /* Change the flags in the datapath. */
 882     opm = make_openflow(sizeof *opm, OFPT_PORT_MOD, &b);
 883     opm->mask = htonl(mask);
 884     opm->desc = *p;
 885     rconn_send(pw->local_rconn, b, NULL);
 886
 887     /* Notify the controller that the flags changed. */
 888     ops = make_openflow(sizeof *ops, OFPT_PORT_STATUS, &b);
 889     ops->reason = OFPPR_MOD;
 890     ops->desc = *p;
 891     rconn_send(pw->remote_rconn, b, NULL);
 892 }
 893
 894 static bool
 895 port_watcher_is_ready(const struct port_watcher *pw)
 896 {
 897     return pw->got_feature_reply;
 898 }
 899
 900 static struct hook
 901 port_watcher_create(struct rconn *local_rconn, struct rconn *remote_rconn,
 902                     struct port_watcher **pwp)
 903 {
 904     struct port_watcher *pw;
 905     int i;
 906
 907     pw = *pwp = xcalloc(1, sizeof *pw);
 908     pw->local_rconn = local_rconn;
 909     pw->remote_rconn = remote_rconn;
 910     pw->last_feature_request = TIME_MIN;
 911     for (i = 0; i < OFPP_MAX; i++) {
 912         pw->ports[i].port_no = htons(OFPP_NONE);
 913     }
 914     port_watcher_register_callback(pw, log_port_status, NULL);
 915     return make_hook(port_watcher_local_packet_cb,
 916                      port_watcher_remote_packet_cb,
 917                      port_watcher_periodic_cb, NULL, pw);
 918 }
 919 \f
 920 /* Spanning tree protocol. */
 921
 922 /* Extra time, in seconds, at boot before going into fail-open, to give the
 923  * spanning tree protocol time to figure out the network layout. */
 924 #define STP_EXTRA_BOOT_TIME 30
 925
 926 struct stp_data {
 927     struct stp *stp;
 928     struct port_watcher *pw;
 929     struct rconn *local_rconn;
 930     struct rconn *remote_rconn;
 931     uint8_t dpid[ETH_ADDR_LEN];
 932     long long int last_tick_256ths;
 933     int n_txq;
 934 };
 935
 936 static bool
 937 stp_local_packet_cb(struct relay *r, void *stp_)
 938 {
 939     struct ofpbuf *msg = r->halves[HALF_LOCAL].rxbuf;
 940     struct ofp_header *oh;
 941     struct stp_data *stp = stp_;
 942     struct ofp_packet_in *opi;
 943     struct eth_header *eth;
 944     struct llc_header *llc;
 945     struct ofpbuf payload;
 946     uint16_t port_no;
 947     struct flow flow;
 948
 949     oh = msg->data;
 950     if (oh->type == OFPT_FEATURES_REPLY
 951         && msg->size >= offsetof(struct ofp_switch_features, ports)) {
 952         struct ofp_switch_features *osf = msg->data;
 953         osf->capabilities |= htonl(OFPC_STP);
 954         return false;
 955     }
 956
 957     if (!get_ofp_packet_eth_header(r, &opi, &eth)
 958         || !eth_addr_equals(eth->eth_dst, stp_eth_addr)) {
 959         return false;
 960     }
 961
 962     port_no = ntohs(opi->in_port);
 963     if (port_no >= STP_MAX_PORTS) {
 964         /* STP only supports 255 ports. */
 965         return false;
 966     }
 967     if (port_watcher_get_flags(stp->pw, port_no) & OFPPFL_NO_STP) {
 968         /* We're not doing STP on this port. */
 969         return false;
 970     }
 971
 972     if (opi->reason == OFPR_ACTION) {
 973         /* The controller set up a flow for this, so we won't intercept it. */
 974         return false;
 975     }
 976
 977     get_ofp_packet_payload(opi, &payload);
 978     flow_extract(&payload, port_no, &flow);
 979     if (flow.dl_type != htons(OFP_DL_TYPE_NOT_ETH_TYPE)) {
 980         VLOG_DBG("non-LLC frame received on STP multicast address");
 981         return false;
 982     }
 983     llc = ofpbuf_at_assert(&payload, sizeof *eth, sizeof *llc);
 984     if (llc->llc_dsap != STP_LLC_DSAP) {
 985         VLOG_DBG("bad DSAP 0x%02"PRIx8" received on STP multicast address",
 986                  llc->llc_dsap);
 987         return false;
 988     }
 989
 990     /* Trim off padding on payload. */
 991     if (payload.size > ntohs(eth->eth_type) + ETH_HEADER_LEN) {
 992         payload.size = ntohs(eth->eth_type) + ETH_HEADER_LEN;
 993     }
 994     if (ofpbuf_try_pull(&payload, ETH_HEADER_LEN + LLC_HEADER_LEN)) {
 995         struct stp_port *p = stp_get_port(stp->stp, port_no);
 996         stp_received_bpdu(p, payload.data, payload.size);
 997     }
 998
 999     return true;
1000 }
1001
1002 static long long int
1003 time_256ths(void)
1004 {
1005     return time_msec() * 256 / 1000;
1006 }
1007
1008 static void
1009 stp_periodic_cb(void *stp_)
1010 {
1011     struct stp_data *stp = stp_;
1012     long long int now_256ths = time_256ths();
1013     long long int elapsed_256ths = now_256ths - stp->last_tick_256ths;
1014     struct stp_port *p;
1015
1016     if (!port_watcher_is_ready(stp->pw)) {
1017         /* Can't start STP until we know port flags, because port flags can
1018          * disable STP. */
1019         return;
1020     }
1021     if (elapsed_256ths <= 0) {
1022         return;
1023     }
1024
1025     stp_tick(stp->stp, MIN(INT_MAX, elapsed_256ths));
1026     stp->last_tick_256ths = now_256ths;
1027
1028     while (stp_get_changed_port(stp->stp, &p)) {
1029         int port_no = stp_port_no(p);
1030         enum stp_state state = stp_port_get_state(p);
1031
1032         if (state != STP_DISABLED) {
1033             VLOG_WARN("STP: Port %d entered %s state",
1034                       port_no, stp_state_name(state));
1035         }
1036         if (!(port_watcher_get_flags(stp->pw, port_no) & OFPPFL_NO_STP)) {
1037             uint32_t flags;
1038             switch (state) {
1039             case STP_LISTENING:
1040                 flags = OFPPFL_STP_LISTEN;
1041                 break;
1042             case STP_LEARNING:
1043                 flags = OFPPFL_STP_LEARN;
1044                 break;
1045             case STP_DISABLED:
1046             case STP_FORWARDING:
1047                 flags = OFPPFL_STP_FORWARD;
1048                 break;
1049             case STP_BLOCKING:
1050                 flags = OFPPFL_STP_BLOCK;
1051                 break;
1052             default:
1053                 VLOG_DBG_RL(&vrl, "STP: Port %d has bad state %x",
1054                             port_no, state);
1055                 flags = OFPPFL_STP_FORWARD;
1056                 break;
1057             }
1058             if (!stp_forward_in_state(state)) {
1059                 flags |= OFPPFL_NO_FLOOD;
1060             }
1061             port_watcher_set_flags(stp->pw, port_no, flags,
1062                                    OFPPFL_STP_MASK | OFPPFL_NO_FLOOD);
1063         } else {
1064             /* We don't own those flags. */
1065         }
1066     }
1067 }
1068
1069 static void
1070 stp_wait_cb(void *stp_ UNUSED)
1071 {
1072     poll_timer_wait(1000);
1073 }
1074
1075 static void
1076 send_bpdu(const void *bpdu, size_t bpdu_size, int port_no, void *stp_)
1077 {
1078     struct stp_data *stp = stp_;
1079     struct eth_header *eth;
1080     struct llc_header *llc;
1081     struct ofpbuf pkt, *opo;
1082
1083     /* Packet skeleton. */
1084     ofpbuf_init(&pkt, ETH_HEADER_LEN + LLC_HEADER_LEN + bpdu_size);
1085     eth = ofpbuf_put_uninit(&pkt, sizeof *eth);
1086     llc = ofpbuf_put_uninit(&pkt, sizeof *llc);
1087     ofpbuf_put(&pkt, bpdu, bpdu_size);
1088
1089     /* 802.2 header. */
1090     memcpy(eth->eth_dst, stp_eth_addr, ETH_ADDR_LEN);
1091     memcpy(eth->eth_src, stp->pw->ports[port_no].hw_addr, ETH_ADDR_LEN);
1092     eth->eth_type = htons(pkt.size - ETH_HEADER_LEN);
1093
1094     /* LLC header. */
1095     llc->llc_dsap = STP_LLC_DSAP;
1096     llc->llc_ssap = STP_LLC_SSAP;
1097     llc->llc_cntl = STP_LLC_CNTL;
1098
1099     opo = make_unbuffered_packet_out(&pkt, OFPP_NONE, port_no);
1100     ofpbuf_uninit(&pkt);
1101     rconn_send_with_limit(stp->local_rconn, opo, &stp->n_txq, OFPP_MAX);
1102 }
1103
1104 static bool
1105 stp_is_port_supported(uint16_t port_no)
1106 {
1107     /* We should be able to support STP on all possible OpenFlow physical
1108      * ports.  (But we don't support STP on OFPP_LOCAL.)  */
1109     BUILD_ASSERT_DECL(STP_MAX_PORTS >= OFPP_MAX);
1110     return port_no < STP_MAX_PORTS;
1111 }
1112
1113 static void
1114 stp_port_changed_cb(uint16_t port_no,
1115                     const struct ofp_phy_port *old,
1116                     const struct ofp_phy_port *new,
1117                     void *stp_)
1118 {
1119     struct stp_data *stp = stp_;
1120     struct stp_port *p;
1121
1122     if (!stp_is_port_supported(port_no)) {
1123         return;
1124     }
1125
1126     p = stp_get_port(stp->stp, port_no);
1127     if (new->port_no == htons(OFPP_NONE)
1128         || new->flags & htonl(OFPPFL_NO_STP)) {
1129         stp_port_disable(p);
1130     } else {
1131         stp_port_enable(p);
1132         stp_port_set_speed(p, new->speed);
1133     }
1134 }
1135
1136 static struct hook
1137 stp_hook_create(const struct settings *s, struct port_watcher *pw,
1138                 struct rconn *local, struct rconn *remote)
1139 {
1140     uint8_t dpid[ETH_ADDR_LEN];
1141     struct netdev *netdev;
1142     struct stp_data *stp;
1143     int retval;
1144
1145     retval = netdev_open(s->of_name, NETDEV_ETH_TYPE_NONE, &netdev);
1146     if (retval) {
1147         ofp_fatal(retval, "Could not open %s device", s->of_name);
1148     }
1149     memcpy(dpid, netdev_get_etheraddr(netdev), ETH_ADDR_LEN);
1150     netdev_close(netdev);
1151
1152     stp = xcalloc(1, sizeof *stp);
1153     stp->stp = stp_create("stp", eth_addr_to_uint64(dpid), send_bpdu, stp);
1154     stp->pw = pw;
1155     memcpy(stp->dpid, dpid, ETH_ADDR_LEN);
1156     stp->local_rconn = local;
1157     stp->remote_rconn = remote;
1158     stp->last_tick_256ths = time_256ths();
1159
1160     port_watcher_register_callback(pw, stp_port_changed_cb, stp);
1161     return make_hook(stp_local_packet_cb, NULL,
1162                      stp_periodic_cb, stp_wait_cb, stp);
1163 }
1164 \f
1165 /* In-band control. */
1166
1167 struct in_band_data {
1168     const struct settings *s;
1169     struct mac_learning *ml;
1170     struct netdev *of_device;
1171     struct rconn *controller;
1172     uint8_t mac[ETH_ADDR_LEN];
1173     int n_queued;
1174 };
1175
1176 static void
1177 queue_tx(struct rconn *rc, struct in_band_data *in_band, struct ofpbuf *b)
1178 {
1179     rconn_send_with_limit(rc, b, &in_band->n_queued, 10);
1180 }
1181
1182 static const uint8_t *
1183 get_controller_mac(struct in_band_data *in_band)
1184 {
1185     static uint32_t ip, last_nonzero_ip;
1186     static uint8_t mac[ETH_ADDR_LEN], last_nonzero_mac[ETH_ADDR_LEN];
1187     static time_t next_refresh = 0;
1188
1189     uint32_t last_ip = ip;
1190
1191     time_t now = time_now();
1192
1193     ip = rconn_get_ip(in_band->controller);
1194     if (last_ip != ip || !next_refresh || now >= next_refresh) {
1195         bool have_mac;
1196
1197         /* Look up MAC address. */
1198         memset(mac, 0, sizeof mac);
1199         if (ip) {
1200             int retval = netdev_arp_lookup(in_band->of_device, ip, mac);
1201             if (retval) {
1202                 VLOG_DBG("cannot look up controller hw address ("IP_FMT"): %s",
1203                          IP_ARGS(&ip), strerror(retval));
1204             }
1205         }
1206         have_mac = !eth_addr_is_zero(mac);
1207
1208         /* Log changes in IP, MAC addresses. */
1209         if (ip && ip != last_nonzero_ip) {
1210             VLOG_DBG("controller IP address changed from "IP_FMT
1211                      " to "IP_FMT, IP_ARGS(&last_nonzero_ip), IP_ARGS(&ip));
1212             last_nonzero_ip = ip;
1213         }
1214         if (have_mac && memcmp(last_nonzero_mac, mac, ETH_ADDR_LEN)) {
1215             VLOG_DBG("controller MAC address changed from "ETH_ADDR_FMT" to "
1216                      ETH_ADDR_FMT,
1217                      ETH_ADDR_ARGS(last_nonzero_mac), ETH_ADDR_ARGS(mac));
1218             memcpy(last_nonzero_mac, mac, ETH_ADDR_LEN);
1219         }
1220
1221         /* Schedule next refresh.
1222          *
1223          * If we have an IP address but not a MAC address, then refresh
1224          * quickly, since we probably will get a MAC address soon (via ARP).
1225          * Otherwise, we can afford to wait a little while. */
1226         next_refresh = now + (!ip || have_mac ? 10 : 1);
1227     }
1228     return !eth_addr_is_zero(mac) ? mac : NULL;
1229 }
1230
1231 static bool
1232 is_controller_mac(const uint8_t dl_addr[ETH_ADDR_LEN],
1233                   struct in_band_data *in_band)
1234 {
1235     const uint8_t *mac = get_controller_mac(in_band);
1236     return mac && eth_addr_equals(mac, dl_addr);
1237 }
1238
1239 static void
1240 in_band_learn_mac(struct in_band_data *in_band,
1241                   uint16_t in_port, const uint8_t src_mac[ETH_ADDR_LEN])
1242 {
1243     if (mac_learning_learn(in_band->ml, src_mac, in_port)) {
1244         VLOG_DBG_RL(&vrl, "learned that "ETH_ADDR_FMT" is on port %"PRIu16,
1245                     ETH_ADDR_ARGS(src_mac), in_port);
1246     }
1247 }
1248
1249 static bool
1250 in_band_local_packet_cb(struct relay *r, void *in_band_)
1251 {
1252     struct in_band_data *in_band = in_band_;
1253     struct rconn *rc = r->halves[HALF_LOCAL].rconn;
1254     struct ofp_packet_in *opi;
1255     struct eth_header *eth;
1256     struct ofpbuf payload;
1257     struct flow flow;
1258     uint16_t in_port;
1259     int out_port;
1260
1261     if (!get_ofp_packet_eth_header(r, &opi, &eth)) {
1262         return false;
1263     }
1264     in_port = ntohs(opi->in_port);
1265
1266     /* Deal with local stuff. */
1267     if (in_port == OFPP_LOCAL) {
1268         /* Sent by secure channel. */
1269         out_port = mac_learning_lookup(in_band->ml, eth->eth_dst);
1270     } else if (eth_addr_equals(eth->eth_dst, in_band->mac)) {
1271         /* Sent to secure channel. */
1272         out_port = OFPP_LOCAL;
1273         in_band_learn_mac(in_band, in_port, eth->eth_src);
1274     } else if (eth->eth_type == htons(ETH_TYPE_ARP)
1275                && eth_addr_is_broadcast(eth->eth_dst)
1276                && is_controller_mac(eth->eth_src, in_band)) {
1277         /* ARP sent by controller. */
1278         out_port = OFPP_FLOOD;
1279     } else if (is_controller_mac(eth->eth_dst, in_band)
1280                || is_controller_mac(eth->eth_src, in_band)) {
1281         /* Traffic to or from controller.  Switch it by hand. */
1282         in_band_learn_mac(in_band, in_port, eth->eth_src);
1283         out_port = mac_learning_lookup(in_band->ml, eth->eth_dst);
1284     } else {
1285         const uint8_t *controller_mac;
1286         controller_mac = get_controller_mac(in_band);
1287         if (eth->eth_type == htons(ETH_TYPE_ARP)
1288             && eth_addr_is_broadcast(eth->eth_dst)
1289             && is_controller_mac(eth->eth_src, in_band)) {
1290             /* ARP sent by controller. */
1291             out_port = OFPP_FLOOD;
1292         } else if (is_controller_mac(eth->eth_dst, in_band)
1293                    && in_port == mac_learning_lookup(in_band->ml,
1294                                                      controller_mac)) {
1295             /* Drop controller traffic that arrives on the controller port. */
1296             out_port = -1;
1297         } else {
1298             return false;
1299         }
1300     }
1301
1302     get_ofp_packet_payload(opi, &payload);
1303     flow_extract(&payload, in_port, &flow);
1304     if (in_port == out_port) {
1305         /* The input and output port match.  Set up a flow to drop packets. */
1306         queue_tx(rc, in_band, make_add_flow(&flow, ntohl(opi->buffer_id),
1307                                           in_band->s->max_idle, 0));
1308     } else if (out_port != OFPP_FLOOD) {
1309         /* The output port is known, so add a new flow. */
1310         queue_tx(rc, in_band,
1311                  make_add_simple_flow(&flow, ntohl(opi->buffer_id),
1312                                       out_port, in_band->s->max_idle));
1313
1314         /* If the switch didn't buffer the packet, we need to send a copy. */
1315         if (ntohl(opi->buffer_id) == UINT32_MAX) {
1316             queue_tx(rc, in_band,
1317                      make_unbuffered_packet_out(&payload, in_port, out_port));
1318         }
1319     } else {
1320         /* We don't know that MAC.  Send along the packet without setting up a
1321          * flow. */
1322         struct ofpbuf *b;
1323         if (ntohl(opi->buffer_id) == UINT32_MAX) {
1324             b = make_unbuffered_packet_out(&payload, in_port, out_port);
1325         } else {
1326             b = make_buffered_packet_out(ntohl(opi->buffer_id),
1327                                          in_port, out_port);
1328         }
1329         queue_tx(rc, in_band, b);
1330     }
1331     return true;
1332 }
1333
1334 static void
1335 in_band_status_cb(struct status_reply *sr, void *in_band_)
1336 {
1337     struct in_band_data *in_band = in_band_;
1338     struct in_addr local_ip;
1339     uint32_t controller_ip;
1340     const uint8_t *controller_mac;
1341
1342     if (netdev_get_in4(in_band->of_device, &local_ip)) {
1343         status_reply_put(sr, "local-ip="IP_FMT, IP_ARGS(&local_ip.s_addr));
1344     }
1345     status_reply_put(sr, "local-mac="ETH_ADDR_FMT,
1346                      ETH_ADDR_ARGS(in_band->mac));
1347
1348     controller_ip = rconn_get_ip(in_band->controller);
1349     if (controller_ip) {
1350         status_reply_put(sr, "controller-ip="IP_FMT,
1351                       IP_ARGS(&controller_ip));
1352     }
1353     controller_mac = get_controller_mac(in_band);
1354     if (controller_mac) {
1355         status_reply_put(sr, "controller-mac="ETH_ADDR_FMT,
1356                       ETH_ADDR_ARGS(controller_mac));
1357     }
1358 }
1359
1360 static void
1361 get_ofp_packet_payload(struct ofp_packet_in *opi, struct ofpbuf *payload)
1362 {
1363     payload->data = opi->data;
1364     payload->size = ntohs(opi->header.length) - offsetof(struct ofp_packet_in,
1365                                                          data);
1366 }
1367
1368 static struct hook
1369 in_band_hook_create(const struct settings *s, struct switch_status *ss,
1370                     struct rconn *remote)
1371 {
1372     struct in_band_data *in_band;
1373     int retval;
1374
1375     in_band = xcalloc(1, sizeof *in_band);
1376     in_band->s = s;
1377     in_band->ml = mac_learning_create();
1378     retval = netdev_open(s->of_name, NETDEV_ETH_TYPE_NONE,
1379                          &in_band->of_device);
1380     if (retval) {
1381         ofp_fatal(retval, "Could not open %s device", s->of_name);
1382     }
1383     memcpy(in_band->mac, netdev_get_etheraddr(in_band->of_device),
1384            ETH_ADDR_LEN);
1385     in_band->controller = remote;
1386     switch_status_register_category(ss, "in-band", in_band_status_cb, in_band);
1387     return make_hook(in_band_local_packet_cb, NULL, NULL, NULL, in_band);
1388 }
1389 \f
1390 /* Fail open support. */
1391
1392 struct fail_open_data {
1393     const struct settings *s;
1394     struct rconn *local_rconn;
1395     struct rconn *remote_rconn;
1396     struct lswitch *lswitch;
1397     int last_disconn_secs;
1398     time_t boot_deadline;
1399 };
1400
1401 /* Causes 'r' to enter or leave fail-open mode, if appropriate. */
1402 static void
1403 fail_open_periodic_cb(void *fail_open_)
1404 {
1405     struct fail_open_data *fail_open = fail_open_;
1406     int disconn_secs;
1407     bool open;
1408
1409     if (time_now() < fail_open->boot_deadline) {
1410         return;
1411     }
1412     disconn_secs = rconn_disconnected_duration(fail_open->remote_rconn);
1413     open = disconn_secs >= fail_open->s->probe_interval * 3;
1414     if (open != (fail_open->lswitch != NULL)) {
1415         if (!open) {
1416             VLOG_WARN("No longer in fail-open mode");
1417             lswitch_destroy(fail_open->lswitch);
1418             fail_open->lswitch = NULL;
1419         } else {
1420             VLOG_WARN("Could not connect to controller for %d seconds, "
1421                       "failing open", disconn_secs);
1422             fail_open->lswitch = lswitch_create(fail_open->local_rconn, true,
1423                                                 fail_open->s->max_idle);
1424             fail_open->last_disconn_secs = disconn_secs;
1425         }
1426     } else if (open && disconn_secs > fail_open->last_disconn_secs + 60) {
1427         VLOG_WARN("Still in fail-open mode after %d seconds disconnected "
1428                   "from controller", disconn_secs);
1429         fail_open->last_disconn_secs = disconn_secs;
1430     }
1431 }
1432
1433 static bool
1434 fail_open_local_packet_cb(struct relay *r, void *fail_open_)
1435 {
1436     struct fail_open_data *fail_open = fail_open_;
1437     if (!fail_open->lswitch) {
1438         return false;
1439     } else {
1440         lswitch_process_packet(fail_open->lswitch, fail_open->local_rconn,
1441                                r->halves[HALF_LOCAL].rxbuf);
1442         rconn_run(fail_open->local_rconn);
1443         return true;
1444     }
1445 }
1446
1447 static void
1448 fail_open_status_cb(struct status_reply *sr, void *fail_open_)
1449 {
1450     struct fail_open_data *fail_open = fail_open_;
1451     const struct settings *s = fail_open->s;
1452     int trigger_duration = s->probe_interval * 3;
1453     int cur_duration = rconn_disconnected_duration(fail_open->remote_rconn);
1454
1455     status_reply_put(sr, "trigger-duration=%d", trigger_duration);
1456     status_reply_put(sr, "current-duration=%d", cur_duration);
1457     status_reply_put(sr, "triggered=%s",
1458                      cur_duration >= trigger_duration ? "true" : "false");
1459     status_reply_put(sr, "max-idle=%d", s->max_idle);
1460 }
1461
1462 static struct hook
1463 fail_open_hook_create(const struct settings *s, struct switch_status *ss,
1464                       struct rconn *local_rconn, struct rconn *remote_rconn)
1465 {
1466     struct fail_open_data *fail_open = xmalloc(sizeof *fail_open);
1467     fail_open->s = s;
1468     fail_open->local_rconn = local_rconn;
1469     fail_open->remote_rconn = remote_rconn;
1470     fail_open->lswitch = NULL;
1471     fail_open->boot_deadline = time_now() + s->probe_interval * 3;
1472     if (s->enable_stp) {
1473         fail_open->boot_deadline += STP_EXTRA_BOOT_TIME;
1474     }
1475     switch_status_register_category(ss, "fail-open",
1476                                     fail_open_status_cb, fail_open);
1477     return make_hook(fail_open_local_packet_cb, NULL,
1478                      fail_open_periodic_cb, NULL, fail_open);
1479 }
1480 \f
1481 struct rate_limiter {
1482     const struct settings *s;
1483     struct rconn *remote_rconn;
1484
1485     /* One queue per physical port. */
1486     struct ofp_queue queues[OFPP_MAX];
1487     int n_queued;               /* Sum over queues[*].n. */
1488     int next_tx_port;           /* Next port to check in round-robin. */
1489
1490     /* Token bucket.
1491      *
1492      * It costs 1000 tokens to send a single packet_in message.  A single token
1493      * per message would be more straightforward, but this choice lets us avoid
1494      * round-off error in refill_bucket()'s calculation of how many tokens to
1495      * add to the bucket, since no division step is needed. */
1496     long long int last_fill;    /* Time at which we last added tokens. */
1497     int tokens;                 /* Current number of tokens. */
1498
1499     /* Transmission queue. */
1500     int n_txq;                  /* No. of packets waiting in rconn for tx. */
1501
1502     /* Statistics reporting. */
1503     unsigned long long n_normal;        /* # txed w/o rate limit queuing. */
1504     unsigned long long n_limited;       /* # queued for rate limiting. */
1505     unsigned long long n_queue_dropped; /* # dropped due to queue overflow. */
1506     unsigned long long n_tx_dropped;    /* # dropped due to tx overflow. */
1507 };
1508
1509 /* Drop a packet from the longest queue in 'rl'. */
1510 static void
1511 drop_packet(struct rate_limiter *rl)
1512 {
1513     struct ofp_queue *longest;  /* Queue currently selected as longest. */
1514     int n_longest;              /* # of queues of same length as 'longest'. */
1515     struct ofp_queue *q;
1516
1517     longest = &rl->queues[0];
1518     n_longest = 1;
1519     for (q = &rl->queues[0]; q < &rl->queues[OFPP_MAX]; q++) {
1520         if (longest->n < q->n) {
1521             longest = q;
1522             n_longest = 1;
1523         } else if (longest->n == q->n) {
1524             n_longest++;
1525
1526             /* Randomly select one of the longest queues, with a uniform
1527              * distribution (Knuth algorithm 3.4.2R). */
1528             if (!random_range(n_longest)) {
1529                 longest = q;
1530             }
1531         }
1532     }
1533
1534     /* FIXME: do we want to pop the tail instead? */
1535     ofpbuf_delete(queue_pop_head(longest));
1536     rl->n_queued--;
1537 }
1538
1539 /* Remove and return the next packet to transmit (in round-robin order). */
1540 static struct ofpbuf *
1541 dequeue_packet(struct rate_limiter *rl)
1542 {
1543     unsigned int i;
1544
1545     for (i = 0; i < OFPP_MAX; i++) {
1546         unsigned int port = (rl->next_tx_port + i) % OFPP_MAX;
1547         struct ofp_queue *q = &rl->queues[port];
1548         if (q->n) {
1549             rl->next_tx_port = (port + 1) % OFPP_MAX;
1550             rl->n_queued--;
1551             return queue_pop_head(q);
1552         }
1553     }
1554     NOT_REACHED();
1555 }
1556
1557 /* Add tokens to the bucket based on elapsed time. */
1558 static void
1559 refill_bucket(struct rate_limiter *rl)
1560 {
1561     const struct settings *s = rl->s;
1562     long long int now = time_msec();
1563     long long int tokens = (now - rl->last_fill) * s->rate_limit + rl->tokens;
1564     if (tokens >= 1000) {
1565         rl->last_fill = now;
1566         rl->tokens = MIN(tokens, s->burst_limit * 1000);
1567     }
1568 }
1569
1570 /* Attempts to remove enough tokens from 'rl' to transmit a packet.  Returns
1571  * true if successful, false otherwise.  (In the latter case no tokens are
1572  * removed.) */
1573 static bool
1574 get_token(struct rate_limiter *rl)
1575 {
1576     if (rl->tokens >= 1000) {
1577         rl->tokens -= 1000;
1578         return true;
1579     } else {
1580         return false;
1581     }
1582 }
1583
1584 static bool
1585 rate_limit_local_packet_cb(struct relay *r, void *rl_)
1586 {
1587     struct rate_limiter *rl = rl_;
1588     const struct settings *s = rl->s;
1589     struct ofp_packet_in *opi;
1590
1591     opi = get_ofp_packet_in(r);
1592     if (!opi) {
1593         return false;
1594     }
1595
1596     if (!rl->n_queued && get_token(rl)) {
1597         /* In the common case where we are not constrained by the rate limit,
1598          * let the packet take the normal path. */
1599         rl->n_normal++;
1600         return false;
1601     } else {
1602         /* Otherwise queue it up for the periodic callback to drain out. */
1603         struct ofpbuf *msg = r->halves[HALF_LOCAL].rxbuf;
1604         int port = ntohs(opi->in_port) % OFPP_MAX;
1605         if (rl->n_queued >= s->burst_limit) {
1606             drop_packet(rl);
1607         }
1608         queue_push_tail(&rl->queues[port], ofpbuf_clone(msg));
1609         rl->n_queued++;
1610         rl->n_limited++;
1611         return true;
1612     }
1613 }
1614
1615 static void
1616 rate_limit_status_cb(struct status_reply *sr, void *rl_)
1617 {
1618     struct rate_limiter *rl = rl_;
1619
1620     status_reply_put(sr, "normal=%llu", rl->n_normal);
1621     status_reply_put(sr, "limited=%llu", rl->n_limited);
1622     status_reply_put(sr, "queue-dropped=%llu", rl->n_queue_dropped);
1623     status_reply_put(sr, "tx-dropped=%llu", rl->n_tx_dropped);
1624 }
1625
1626 static void
1627 rate_limit_periodic_cb(void *rl_)
1628 {
1629     struct rate_limiter *rl = rl_;
1630     int i;
1631
1632     /* Drain some packets out of the bucket if possible, but limit the number
1633      * of iterations to allow other code to get work done too. */
1634     refill_bucket(rl);
1635     for (i = 0; rl->n_queued && get_token(rl) && i < 50; i++) {
1636         /* Use a small, arbitrary limit for the amount of queuing to do here,
1637          * because the TCP connection is responsible for buffering and there is
1638          * no point in trying to transmit faster than the TCP connection can
1639          * handle. */
1640         struct ofpbuf *b = dequeue_packet(rl);
1641         if (rconn_send_with_limit(rl->remote_rconn, b, &rl->n_txq, 10)) {
1642             rl->n_tx_dropped++;
1643         }
1644     }
1645 }
1646
1647 static void
1648 rate_limit_wait_cb(void *rl_)
1649 {
1650     struct rate_limiter *rl = rl_;
1651     if (rl->n_queued) {
1652         if (rl->tokens >= 1000) {
1653             /* We can transmit more packets as soon as we're called again. */
1654             poll_immediate_wake();
1655         } else {
1656             /* We have to wait for the bucket to re-fill.  We could calculate
1657              * the exact amount of time here for increased smoothness. */
1658             poll_timer_wait(TIME_UPDATE_INTERVAL / 2);
1659         }
1660     }
1661 }
1662
1663 static struct hook
1664 rate_limit_hook_create(const struct settings *s, struct switch_status *ss,
1665                        struct rconn *local, struct rconn *remote)
1666 {
1667     struct rate_limiter *rl;
1668     size_t i;
1669
1670     rl = xcalloc(1, sizeof *rl);
1671     rl->s = s;
1672     rl->remote_rconn = remote;
1673     for (i = 0; i < ARRAY_SIZE(rl->queues); i++) {
1674         queue_init(&rl->queues[i]);
1675     }
1676     rl->last_fill = time_msec();
1677     rl->tokens = s->rate_limit * 100;
1678     switch_status_register_category(ss, "rate-limit",
1679                                     rate_limit_status_cb, rl);
1680     return make_hook(rate_limit_local_packet_cb, NULL, rate_limit_periodic_cb,
1681                      rate_limit_wait_cb, rl);
1682 }
1683 \f
1684 /* OFPST_SWITCH statistics. */
1685
1686 struct switch_status_category {
1687     char *name;
1688     void (*cb)(struct status_reply *, void *aux);
1689     void *aux;
1690 };
1691
1692 struct switch_status {
1693     const struct settings *s;
1694     time_t booted;
1695     struct switch_status_category categories[8];
1696     int n_categories;
1697 };
1698
1699 struct status_reply {
1700     struct switch_status_category *category;
1701     struct ds request;
1702     struct ds output;
1703 };
1704
1705 static bool
1706 switch_status_remote_packet_cb(struct relay *r, void *ss_)
1707 {
1708     struct switch_status *ss = ss_;
1709     struct rconn *rc = r->halves[HALF_REMOTE].rconn;
1710     struct ofpbuf *msg = r->halves[HALF_REMOTE].rxbuf;
1711     struct switch_status_category *c;
1712     struct nicira_header *request;
1713     struct nicira_header *reply;
1714     struct status_reply sr;
1715     struct ofpbuf *b;
1716     int retval;
1717
1718     if (msg->size < sizeof(struct nicira_header)) {
1719         return false;
1720     }
1721     request = msg->data;
1722     if (request->header.type != OFPT_VENDOR
1723         || request->vendor_id != htonl(NX_VENDOR_ID)
1724         || request->subtype != htonl(NXT_STATUS_REQUEST)) {
1725         return false;
1726     }
1727
1728     sr.request.string = (void *) (request + 1);
1729     sr.request.length = msg->size - sizeof *request;
1730     ds_init(&sr.output);
1731     for (c = ss->categories; c < &ss->categories[ss->n_categories]; c++) {
1732         if (!memcmp(c->name, sr.request.string,
1733                     MIN(strlen(c->name), sr.request.length))) {
1734             sr.category = c;
1735             c->cb(&sr, c->aux);
1736         }
1737     }
1738     reply = make_openflow_xid(sizeof *reply + sr.output.length,
1739                               OFPT_VENDOR, request->header.xid, &b);
1740     reply->vendor_id = htonl(NX_VENDOR_ID);
1741     reply->subtype = htonl(NXT_STATUS_REPLY);
1742     memcpy(reply + 1, sr.output.string, sr.output.length);
1743     retval = rconn_send(rc, b, NULL);
1744     if (retval && retval != EAGAIN) {
1745         VLOG_WARN("send failed (%s)", strerror(retval));
1746     }
1747     ds_destroy(&sr.output);
1748     return true;
1749 }
1750
1751 static void
1752 rconn_status_cb(struct status_reply *sr, void *rconn_)
1753 {
1754     struct rconn *rconn = rconn_;
1755     time_t now = time_now();
1756
1757     status_reply_put(sr, "name=%s", rconn_get_name(rconn));
1758     status_reply_put(sr, "state=%s", rconn_get_state(rconn));
1759     status_reply_put(sr, "backoff=%d", rconn_get_backoff(rconn));
1760     status_reply_put(sr, "is-connected=%s",
1761                      rconn_is_connected(rconn) ? "true" : "false");
1762     status_reply_put(sr, "sent-msgs=%u", rconn_packets_sent(rconn));
1763     status_reply_put(sr, "received-msgs=%u", rconn_packets_received(rconn));
1764     status_reply_put(sr, "attempted-connections=%u",
1765                      rconn_get_attempted_connections(rconn));
1766     status_reply_put(sr, "successful-connections=%u",
1767                      rconn_get_successful_connections(rconn));
1768     status_reply_put(sr, "last-connection=%ld",
1769                      (long int) (now - rconn_get_last_connection(rconn)));
1770     status_reply_put(sr, "time-connected=%lu",
1771                      rconn_get_total_time_connected(rconn));
1772     status_reply_put(sr, "state-elapsed=%u", rconn_get_state_elapsed(rconn));
1773 }
1774
1775 static void
1776 config_status_cb(struct status_reply *sr, void *s_)
1777 {
1778     const struct settings *s = s_;
1779     size_t i;
1780
1781     for (i = 0; i < s->n_listeners; i++) {
1782         status_reply_put(sr, "management%zu=%s", i, s->listener_names[i]);
1783     }
1784     if (s->probe_interval) {
1785         status_reply_put(sr, "probe-interval=%d", s->probe_interval);
1786     }
1787     if (s->max_backoff) {
1788         status_reply_put(sr, "max-backoff=%d", s->max_backoff);
1789     }
1790 }
1791
1792 static void
1793 switch_status_cb(struct status_reply *sr, void *ss_)
1794 {
1795     struct switch_status *ss = ss_;
1796     time_t now = time_now();
1797
1798     status_reply_put(sr, "now=%ld", (long int) now);
1799     status_reply_put(sr, "uptime=%ld", (long int) (now - ss->booted));
1800     status_reply_put(sr, "pid=%ld", (long int) getpid());
1801 }
1802
1803 static struct hook
1804 switch_status_hook_create(const struct settings *s, struct switch_status **ssp)
1805 {
1806     struct switch_status *ss = xcalloc(1, sizeof *ss);
1807     ss->s = s;
1808     ss->booted = time_now();
1809     switch_status_register_category(ss, "config",
1810                                     config_status_cb, (void *) s);
1811     switch_status_register_category(ss, "switch", switch_status_cb, ss);
1812     *ssp = ss;
1813     return make_hook(NULL, switch_status_remote_packet_cb, NULL, NULL, ss);
1814 }
1815
1816 static void
1817 switch_status_register_category(struct switch_status *ss,
1818                                 const char *category,
1819                                 void (*cb)(struct status_reply *,
1820                                            void *aux),
1821                                 void *aux)
1822 {
1823     struct switch_status_category *c;
1824     assert(ss->n_categories < ARRAY_SIZE(ss->categories));
1825     c = &ss->categories[ss->n_categories++];
1826     c->cb = cb;
1827     c->aux = aux;
1828     c->name = xstrdup(category);
1829 }
1830
1831 static void
1832 status_reply_put(struct status_reply *sr, const char *content, ...)
1833 {
1834     size_t old_length = sr->output.length;
1835     size_t added;
1836     va_list args;
1837
1838     /* Append the status reply to the output. */
1839     ds_put_format(&sr->output, "%s.", sr->category->name);
1840     va_start(args, content);
1841     ds_put_format_valist(&sr->output, content, args);
1842     va_end(args);
1843     if (ds_last(&sr->output) != '\n') {
1844         ds_put_char(&sr->output, '\n');
1845     }
1846
1847     /* Drop what we just added if it doesn't match the request. */
1848     added = sr->output.length - old_length;
1849     if (added < sr->request.length
1850         || memcmp(&sr->output.string[old_length],
1851                   sr->request.string, sr->request.length)) {
1852         ds_truncate(&sr->output, old_length);
1853     }
1854 }
1855
1856 \f
1857 /* Controller discovery. */
1858
1859 struct discovery
1860 {
1861     const struct settings *s;
1862     struct dhclient *dhcp;
1863     int n_changes;
1864 };
1865
1866 static void
1867 discovery_status_cb(struct status_reply *sr, void *d_)
1868 {
1869     struct discovery *d = d_;
1870
1871     status_reply_put(sr, "accept-remote=%s", d->s->accept_controller_re);
1872     status_reply_put(sr, "n-changes=%d", d->n_changes);
1873     status_reply_put(sr, "state=%s", dhclient_get_state(d->dhcp));
1874     status_reply_put(sr, "state-elapsed=%u",
1875                      dhclient_get_state_elapsed(d->dhcp));
1876     if (dhclient_is_bound(d->dhcp)) {
1877         uint32_t ip = dhclient_get_ip(d->dhcp);
1878         uint32_t netmask = dhclient_get_netmask(d->dhcp);
1879         uint32_t router = dhclient_get_router(d->dhcp);
1880
1881         const struct dhcp_msg *cfg = dhclient_get_config(d->dhcp);
1882         uint32_t dns_server;
1883         char *domain_name;
1884         int i;
1885
1886         status_reply_put(sr, "ip="IP_FMT, IP_ARGS(&ip));
1887         status_reply_put(sr, "netmask="IP_FMT, IP_ARGS(&netmask));
1888         if (router) {
1889             status_reply_put(sr, "router="IP_FMT, IP_ARGS(&router));
1890         }
1891
1892         for (i = 0; dhcp_msg_get_ip(cfg, DHCP_CODE_DNS_SERVER, i, &dns_server);
1893              i++) {
1894             status_reply_put(sr, "dns%d="IP_FMT, i, IP_ARGS(&dns_server));
1895         }
1896
1897         domain_name = dhcp_msg_get_string(cfg, DHCP_CODE_DOMAIN_NAME);
1898         if (domain_name) {
1899             status_reply_put(sr, "domain=%s", domain_name);
1900             free(domain_name);
1901         }
1902
1903         status_reply_put(sr, "lease-remaining=%u",
1904                          dhclient_get_lease_remaining(d->dhcp));
1905     }
1906 }
1907
1908 static struct discovery *
1909 discovery_init(const struct settings *s, struct switch_status *ss)
1910 {
1911     struct netdev *netdev;
1912     struct discovery *d;
1913     struct dhclient *dhcp;
1914     int retval;
1915
1916     /* Bring ofX network device up. */
1917     retval = netdev_open(s->of_name, NETDEV_ETH_TYPE_NONE, &netdev);
1918     if (retval) {
1919         ofp_fatal(retval, "Could not open %s device", s->of_name);
1920     }
1921     retval = netdev_turn_flags_on(netdev, NETDEV_UP, true);
1922     if (retval) {
1923         ofp_fatal(retval, "Could not bring %s device up", s->of_name);
1924     }
1925     netdev_close(netdev);
1926
1927     /* Initialize DHCP client. */
1928     retval = dhclient_create(s->of_name, modify_dhcp_request,
1929                              validate_dhcp_offer, (void *) s, &dhcp);
1930     if (retval) {
1931         ofp_fatal(retval, "Failed to initialize DHCP client");
1932     }
1933     dhclient_init(dhcp, 0);
1934
1935     d = xmalloc(sizeof *d);
1936     d->s = s;
1937     d->dhcp = dhcp;
1938     d->n_changes = 0;
1939
1940     switch_status_register_category(ss, "discovery", discovery_status_cb, d);
1941
1942     return d;
1943 }
1944
1945 static void
1946 discovery_question_connectivity(struct discovery *d)
1947 {
1948     dhclient_force_renew(d->dhcp, 15);
1949 }
1950
1951 static bool
1952 discovery_run(struct discovery *d, char **controller_name)
1953 {
1954     dhclient_run(d->dhcp);
1955     if (!dhclient_changed(d->dhcp)) {
1956         return false;
1957     }
1958
1959     dhclient_configure_netdev(d->dhcp);
1960     if (d->s->update_resolv_conf) {
1961         dhclient_update_resolv_conf(d->dhcp);
1962     }
1963
1964     if (dhclient_is_bound(d->dhcp)) {
1965         *controller_name = dhcp_msg_get_string(dhclient_get_config(d->dhcp),
1966                                                DHCP_CODE_OFP_CONTROLLER_VCONN);
1967         VLOG_WARN("%s: discovered controller", *controller_name);
1968         d->n_changes++;
1969     } else {
1970         *controller_name = NULL;
1971         if (d->n_changes) {
1972             VLOG_WARN("discovered controller no longer available");
1973             d->n_changes++;
1974         }
1975     }
1976     return true;
1977 }
1978
1979 static void
1980 discovery_wait(struct discovery *d)
1981 {
1982     dhclient_wait(d->dhcp);
1983 }
1984
1985 static void
1986 modify_dhcp_request(struct dhcp_msg *msg, void *aux)
1987 {
1988     dhcp_msg_put_string(msg, DHCP_CODE_VENDOR_CLASS, "OpenFlow");
1989 }
1990
1991 static bool
1992 validate_dhcp_offer(const struct dhcp_msg *msg, void *s_)
1993 {
1994     const struct settings *s = s_;
1995     char *vconn_name;
1996     bool accept;
1997
1998     vconn_name = dhcp_msg_get_string(msg, DHCP_CODE_OFP_CONTROLLER_VCONN);
1999     if (!vconn_name) {
2000         VLOG_WARN_RL(&vrl, "rejecting DHCP offer missing controller vconn");
2001         return false;
2002     }
2003     accept = !regexec(&s->accept_controller_regex, vconn_name, 0, NULL, 0);
2004     if (!accept) {
2005         VLOG_WARN_RL(&vrl, "rejecting controller vconn that fails to match %s",
2006                      s->accept_controller_re);
2007     }
2008     free(vconn_name);
2009     return accept;
2010 }
2011 \f
2012 /* User interface. */
2013
2014 static void
2015 parse_options(int argc, char *argv[], struct settings *s)
2016 {
2017     enum {
2018         OPT_ACCEPT_VCONN = UCHAR_MAX + 1,
2019         OPT_NO_RESOLV_CONF,
2020         OPT_INACTIVITY_PROBE,
2021         OPT_MAX_IDLE,
2022         OPT_MAX_BACKOFF,
2023         OPT_RATE_LIMIT,
2024         OPT_BURST_LIMIT,
2025         OPT_BOOTSTRAP_CA_CERT,
2026         OPT_NO_STP
2027     };
2028     static struct option long_options[] = {
2029         {"accept-vconn", required_argument, 0, OPT_ACCEPT_VCONN},
2030         {"no-resolv-conf", no_argument, 0, OPT_NO_RESOLV_CONF},
2031         {"fail",        required_argument, 0, 'F'},
2032         {"inactivity-probe", required_argument, 0, OPT_INACTIVITY_PROBE},
2033         {"max-idle",    required_argument, 0, OPT_MAX_IDLE},
2034         {"max-backoff", required_argument, 0, OPT_MAX_BACKOFF},
2035         {"listen",      required_argument, 0, 'l'},
2036         {"monitor",     required_argument, 0, 'm'},
2037         {"rate-limit",  optional_argument, 0, OPT_RATE_LIMIT},
2038         {"burst-limit", required_argument, 0, OPT_BURST_LIMIT},
2039         {"no-stp",      no_argument, 0, OPT_NO_STP},
2040         {"detach",      no_argument, 0, 'D'},
2041         {"force",       no_argument, 0, 'f'},
2042         {"pidfile",     optional_argument, 0, 'P'},
2043         {"verbose",     optional_argument, 0, 'v'},
2044         {"help",        no_argument, 0, 'h'},
2045         {"version",     no_argument, 0, 'V'},
2046 #ifdef HAVE_OPENSSL
2047         VCONN_SSL_LONG_OPTIONS
2048         {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT},
2049 #endif
2050         {0, 0, 0, 0},
2051     };
2052     char *short_options = long_options_to_short_options(long_options);
2053     char *accept_re = NULL;
2054     int retval;
2055
2056     /* Set defaults that we can figure out before parsing options. */
2057     s->n_listeners = 0;
2058     s->monitor_name = NULL;
2059     s->fail_mode = FAIL_OPEN;
2060     s->max_idle = 15;
2061     s->probe_interval = 15;
2062     s->max_backoff = 15;
2063     s->update_resolv_conf = true;
2064     s->rate_limit = 0;
2065     s->burst_limit = 0;
2066     s->enable_stp = true;
2067     for (;;) {
2068         int c;
2069
2070         c = getopt_long(argc, argv, short_options, long_options, NULL);
2071         if (c == -1) {
2072             break;
2073         }
2074
2075         switch (c) {
2076         case OPT_ACCEPT_VCONN:
2077             accept_re = optarg[0] == '^' ? optarg : xasprintf("^%s", optarg);
2078             break;
2079
2080         case OPT_NO_RESOLV_CONF:
2081             s->update_resolv_conf = false;
2082             break;
2083
2084         case 'F':
2085             if (!strcmp(optarg, "open")) {
2086                 s->fail_mode = FAIL_OPEN;
2087             } else if (!strcmp(optarg, "closed")) {
2088                 s->fail_mode = FAIL_CLOSED;
2089             } else {
2090                 ofp_fatal(0, "-f or --fail argument must be \"open\" "
2091                           "or \"closed\"");
2092             }
2093             break;
2094
2095         case OPT_INACTIVITY_PROBE:
2096             s->probe_interval = atoi(optarg);
2097             if (s->probe_interval < 5) {
2098                 ofp_fatal(0, "--inactivity-probe argument must be at least 5");
2099             }
2100             break;
2101
2102         case OPT_MAX_IDLE:
2103             if (!strcmp(optarg, "permanent")) {
2104                 s->max_idle = OFP_FLOW_PERMANENT;
2105             } else {
2106                 s->max_idle = atoi(optarg);
2107                 if (s->max_idle < 1 || s->max_idle > 65535) {
2108                     ofp_fatal(0, "--max-idle argument must be between 1 and "
2109                               "65535 or the word 'permanent'");
2110                 }
2111             }
2112             break;
2113
2114         case OPT_MAX_BACKOFF:
2115             s->max_backoff = atoi(optarg);
2116             if (s->max_backoff < 1) {
2117                 ofp_fatal(0, "--max-backoff argument must be at least 1");
2118             } else if (s->max_backoff > 3600) {
2119                 s->max_backoff = 3600;
2120             }
2121             break;
2122
2123         case OPT_RATE_LIMIT:
2124             if (optarg) {
2125                 s->rate_limit = atoi(optarg);
2126                 if (s->rate_limit < 1) {
2127                     ofp_fatal(0, "--rate-limit argument must be at least 1");
2128                 }
2129             } else {
2130                 s->rate_limit = 1000;
2131             }
2132             break;
2133
2134         case OPT_BURST_LIMIT:
2135             s->burst_limit = atoi(optarg);
2136             if (s->burst_limit < 1) {
2137                 ofp_fatal(0, "--burst-limit argument must be at least 1");
2138             }
2139             break;
2140
2141         case OPT_NO_STP:
2142             s->enable_stp = false;
2143             break;
2144
2145         case 'D':
2146             set_detach();
2147             break;
2148
2149         case 'P':
2150             set_pidfile(optarg);
2151             break;
2152
2153         case 'f':
2154             ignore_existing_pidfile();
2155             break;
2156
2157         case 'l':
2158             if (s->n_listeners >= MAX_MGMT) {
2159                 ofp_fatal(0,
2160                           "-l or --listen may be specified at most %d times",
2161                           MAX_MGMT);
2162             }
2163             s->listener_names[s->n_listeners++] = optarg;
2164             break;
2165
2166         case 'm':
2167             if (s->monitor_name) {
2168                 ofp_fatal(0, "-m or --monitor may only be specified once");
2169             }
2170             s->monitor_name = optarg;
2171             break;
2172
2173         case 'h':
2174             usage();
2175
2176         case 'V':
2177             printf("%s "VERSION" compiled "__DATE__" "__TIME__"\n", argv[0]);
2178             exit(EXIT_SUCCESS);
2179
2180         case 'v':
2181             vlog_set_verbosity(optarg);
2182             break;
2183
2184 #ifdef HAVE_OPENSSL
2185         VCONN_SSL_OPTION_HANDLERS
2186
2187         case OPT_BOOTSTRAP_CA_CERT:
2188             vconn_ssl_set_ca_cert_file(optarg, true);
2189             break;
2190 #endif
2191
2192         case '?':
2193             exit(EXIT_FAILURE);
2194
2195         default:
2196             abort();
2197         }
2198     }
2199     free(short_options);
2200
2201     argc -= optind;
2202     argv += optind;
2203     if (argc < 1 || argc > 2) {
2204         ofp_fatal(0, "need one or two non-option arguments; "
2205                   "use --help for usage");
2206     }
2207
2208     /* Local and remote vconns. */
2209     s->nl_name = argv[0];
2210     if (strncmp(s->nl_name, "nl:", 3)
2211         || strlen(s->nl_name) < 4
2212         || s->nl_name[strspn(s->nl_name + 3, "0123456789") + 3]) {
2213         ofp_fatal(0, "%s: argument is not of the form \"nl:DP_IDX\"",
2214                   s->nl_name);
2215     }
2216     s->of_name = xasprintf("of%s", s->nl_name + 3);
2217     s->controller_name = argc > 1 ? xstrdup(argv[1]) : NULL;
2218
2219     /* Set accept_controller_regex. */
2220     if (!accept_re) {
2221         accept_re = vconn_ssl_is_configured() ? "^ssl:.*" : ".*";
2222     }
2223     retval = regcomp(&s->accept_controller_regex, accept_re,
2224                      REG_NOSUB | REG_EXTENDED);
2225     if (retval) {
2226         size_t length = regerror(retval, &s->accept_controller_regex, NULL, 0);
2227         char *buffer = xmalloc(length);
2228         regerror(retval, &s->accept_controller_regex, buffer, length);
2229         ofp_fatal(0, "%s: %s", accept_re, buffer);
2230     }
2231     s->accept_controller_re = accept_re;
2232
2233     /* Mode of operation. */
2234     s->discovery = s->controller_name == NULL;
2235     if (s->discovery) {
2236         s->in_band = true;
2237     } else {
2238         enum netdev_flags flags;
2239         struct netdev *netdev;
2240
2241         retval = netdev_open(s->of_name, NETDEV_ETH_TYPE_NONE, &netdev);
2242         if (retval) {
2243             ofp_fatal(retval, "Could not open %s device", s->of_name);
2244         }
2245
2246         retval = netdev_get_flags(netdev, &flags);
2247         if (retval) {
2248             ofp_fatal(retval, "Could not get flags for %s device", s->of_name);
2249         }
2250
2251         s->in_band = (flags & NETDEV_UP) != 0;
2252         if (s->in_band && netdev_get_in6(netdev, NULL)) {
2253             VLOG_WARN("Ignoring IPv6 address on %s device: IPv6 not supported",
2254                       s->of_name);
2255         }
2256
2257         netdev_close(netdev);
2258     }
2259
2260     /* Rate limiting. */
2261     if (s->rate_limit) {
2262         if (s->rate_limit < 100) {
2263             VLOG_WARN("Rate limit set to unusually low value %d",
2264                       s->rate_limit);
2265         }
2266         if (!s->burst_limit) {
2267             s->burst_limit = s->rate_limit / 4;
2268         }
2269         s->burst_limit = MAX(s->burst_limit, 1);
2270         s->burst_limit = MIN(s->burst_limit, INT_MAX / 1000);
2271     }
2272 }
2273
2274 static void
2275 usage(void)
2276 {
2277     printf("%s: secure channel, a relay for OpenFlow messages.\n"
2278            "usage: %s [OPTIONS] nl:DP_IDX [CONTROLLER]\n"
2279            "where nl:DP_IDX is a datapath that has been added with dpctl.\n"
2280            "CONTROLLER is an active OpenFlow connection method; if it is\n"
2281            "omitted, then secchan performs controller discovery.\n",
2282            program_name, program_name);
2283     vconn_usage(true, true, true);
2284     printf("\nController discovery options:\n"
2285            "  --accept-vconn=REGEX    accept matching discovered controllers\n"
2286            "  --no-resolv-conf        do not update /etc/resolv.conf\n"
2287            "\nNetworking options:\n"
2288            "  -F, --fail=open|closed  when controller connection fails:\n"
2289            "                            closed: drop all packets\n"
2290            "                            open (default): act as learning switch\n"
2291            "  --inactivity-probe=SECS time between inactivity probes\n"
2292            "  --max-idle=SECS         max idle for flows set up by secchan\n"
2293            "  --max-backoff=SECS      max time between controller connection\n"
2294            "                          attempts (default: 15 seconds)\n"
2295            "  -l, --listen=METHOD     allow management connections on METHOD\n"
2296            "                          (a passive OpenFlow connection method)\n"
2297            "  -m, --monitor=METHOD    copy traffic to/from kernel to METHOD\n"
2298            "                          (a passive OpenFlow connection method)\n"
2299            "  --no-stp                disable 802.1D Spanning Tree Protocol\n"
2300            "\nRate-limiting of \"packet-in\" messages to the controller:\n"
2301            "  --rate-limit[=PACKETS]  max rate, in packets/s (default: 1000)\n"
2302            "  --burst-limit=BURST     limit on packet credit for idle time\n"
2303            "\nOther options:\n"
2304            "  -D, --detach            run in background as daemon\n"
2305            "  -P, --pidfile[=FILE]    create pidfile (default: %s/secchan.pid)\n"
2306            "  -f, --force             with -P, start even if already running\n"
2307            "  -v, --verbose=MODULE[:FACILITY[:LEVEL]]  set logging levels\n"
2308            "  -v, --verbose           set maximum verbosity level\n"
2309            "  -h, --help              display this help message\n"
2310            "  -V, --version           display version information\n",
2311            RUNDIR);
2312     exit(EXIT_SUCCESS);
2313 }