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 edit_port_cb_func(struct ofp_phy_port *port, void *aux);
 595 typedef void port_changed_cb_func(uint16_t port_no,
 596                                   const struct ofp_phy_port *old,
 597                                   const struct ofp_phy_port *new,
 598                                   void *aux);
 599
 600 struct port_watcher_cb {
 601     edit_port_cb_func *edit_port;
 602     port_changed_cb_func *port_changed;
 603     void *aux;
 604 };
 605
 606 struct port_watcher {
 607     struct rconn *local_rconn;
 608     struct rconn *remote_rconn;
 609     struct ofp_phy_port ports[OFPP_MAX + 1];
 610     time_t last_feature_request;
 611     bool got_feature_reply;
 612     int n_txq;
 613     struct port_watcher_cb cbs[2];
 614     int n_cbs;
 615 };
 616
 617 /* Returns the number of fields that differ from 'a' to 'b'. */
 618 static int
 619 opp_differs(const struct ofp_phy_port *a, const struct ofp_phy_port *b)
 620 {
 621     BUILD_ASSERT_DECL(sizeof *a == 36); /* Trips when we add or remove fields. */
 622     return ((a->port_no != b->port_no)
 623             + (memcmp(a->hw_addr, b->hw_addr, sizeof a->hw_addr) != 0)
 624             + (memcmp(a->name, b->name, sizeof a->name) != 0)
 625             + (a->flags != b->flags)
 626             + (a->speed != b->speed)
 627             + (a->features != b->features));
 628 }
 629
 630 static void
 631 sanitize_opp(struct ofp_phy_port *opp)
 632 {
 633     size_t i;
 634
 635     for (i = 0; i < sizeof opp->name; i++) {
 636         char c = opp->name[i];
 637         if (c && (c < 0x20 || c > 0x7e)) {
 638             opp->name[i] = '.';
 639         }
 640     }
 641     opp->name[sizeof opp->name - 1] = '\0';
 642 }
 643
 644 static int
 645 port_no_to_pw_idx(int port_no)
 646 {
 647     return (port_no < OFPP_MAX ? port_no
 648             : port_no == OFPP_LOCAL ? OFPP_MAX
 649             : -1);
 650 }
 651
 652 static void
 653 call_port_changed_callbacks(struct port_watcher *pw, int port_no,
 654                             const struct ofp_phy_port *old,
 655                             const struct ofp_phy_port *new)
 656 {
 657     if (opp_differs(old, new)) {
 658         int i;
 659         for (i = 0; i < pw->n_cbs; i++) {
 660             port_changed_cb_func *port_changed = pw->cbs[i].port_changed;
 661             if (port_changed) {
 662                 (port_changed)(port_no, old, new, pw->cbs[i].aux);
 663             }
 664         }
 665     }
 666 }
 667
 668 static void
 669 call_edit_port_callbacks(struct port_watcher *pw, struct ofp_phy_port *p)
 670 {
 671     int i;
 672     for (i = 0; i < pw->n_cbs; i++) {
 673         edit_port_cb_func *edit_port = pw->cbs[i].edit_port;
 674         if (edit_port) {
 675             (edit_port)(p, pw->cbs[i].aux);
 676         }
 677     }
 678 }
 679
 680 static void
 681 update_phy_port(struct port_watcher *pw, struct ofp_phy_port *opp,
 682                 uint8_t reason, bool seen[OFPP_MAX + 1])
 683 {
 684     struct ofp_phy_port *pw_opp;
 685     struct ofp_phy_port old;
 686     uint16_t port_no;
 687     int idx;
 688
 689     port_no = ntohs(opp->port_no);
 690     idx = port_no_to_pw_idx(port_no);
 691     if (idx < 0) {
 692         return;
 693     }
 694
 695     if (seen) {
 696         seen[idx] = true;
 697     }
 698
 699     pw_opp = &pw->ports[idx];
 700     old = *pw_opp;
 701     if (reason == OFPPR_DELETE) {
 702         memset(pw_opp, 0, sizeof *pw_opp);
 703         pw_opp->port_no = htons(OFPP_NONE);
 704     } else if (reason == OFPPR_MOD || reason == OFPPR_ADD) {
 705         *pw_opp = *opp;
 706         sanitize_opp(pw_opp);
 707     }
 708     call_port_changed_callbacks(pw, port_no, &old, pw_opp);
 709 }
 710
 711 static bool
 712 port_watcher_local_packet_cb(struct relay *r, void *pw_)
 713 {
 714     struct port_watcher *pw = pw_;
 715     struct ofpbuf *msg = r->halves[HALF_LOCAL].rxbuf;
 716     struct ofp_header *oh = msg->data;
 717
 718     if (oh->type == OFPT_FEATURES_REPLY
 719         && msg->size >= offsetof(struct ofp_switch_features, ports)) {
 720         struct ofp_switch_features *osf = msg->data;
 721         bool seen[ARRAY_SIZE(pw->ports)];
 722         size_t n_ports;
 723         size_t i;
 724
 725         pw->got_feature_reply = true;
 726
 727         /* Update each port included in the message. */
 728         memset(seen, 0, sizeof seen);
 729         n_ports = ((msg->size - offsetof(struct ofp_switch_features, ports))
 730                    / sizeof *osf->ports);
 731         for (i = 0; i < n_ports; i++) {
 732             struct ofp_phy_port *opp = &osf->ports[i];
 733             call_edit_port_callbacks(pw, opp);
 734             update_phy_port(pw, opp, OFPPR_MOD, seen);
 735         }
 736
 737         /* Delete all the ports not included in the message. */
 738         for (i = 0; i < ARRAY_SIZE(pw->ports); i++) {
 739             if (!seen[i]) {
 740                 update_phy_port(pw, &pw->ports[i], OFPPR_DELETE, NULL);
 741             }
 742         }
 743     } else if (oh->type == OFPT_PORT_STATUS
 744                && msg->size >= sizeof(struct ofp_port_status)) {
 745         struct ofp_port_status *ops = msg->data;
 746         call_edit_port_callbacks(pw, &ops->desc);
 747         update_phy_port(pw, &ops->desc, ops->reason, NULL);
 748     }
 749     return false;
 750 }
 751
 752 static bool
 753 port_watcher_remote_packet_cb(struct relay *r, void *pw_)
 754 {
 755     struct port_watcher *pw = pw_;
 756     struct ofpbuf *msg = r->halves[HALF_REMOTE].rxbuf;
 757     struct ofp_header *oh = msg->data;
 758
 759     if (oh->type == OFPT_PORT_MOD
 760         && msg->size >= sizeof(struct ofp_port_mod)) {
 761         struct ofp_port_mod *opm = msg->data;
 762         uint16_t port_no = ntohs(opm->desc.port_no);
 763         int idx = port_no_to_pw_idx(port_no);
 764         if (idx >= 0) {
 765             struct ofp_phy_port *pw_opp = &pw->ports[idx];
 766             if (pw_opp->port_no != htons(OFPP_NONE)) {
 767                 struct ofp_phy_port old = *pw_opp;
 768                 pw_opp->flags = ((pw_opp->flags & ~opm->mask)
 769                                  | (opm->desc.flags & opm->mask));
 770                 call_port_changed_callbacks(pw, port_no, &old, pw_opp);
 771             }
 772         }
 773     }
 774     return false;
 775 }
 776
 777 static void
 778 port_watcher_periodic_cb(void *pw_)
 779 {
 780     struct port_watcher *pw = pw_;
 781
 782     if (!pw->got_feature_reply && time_now() >= pw->last_feature_request + 5) {
 783         struct ofpbuf *b;
 784         make_openflow(sizeof(struct ofp_header), OFPT_FEATURES_REQUEST, &b);
 785         rconn_send_with_limit(pw->local_rconn, b, &pw->n_txq, 1);
 786         pw->last_feature_request = time_now();
 787     }
 788 }
 789
 790 static void
 791 put_duplexes(struct ds *ds, const char *name, uint32_t features,
 792              uint32_t hd_bit, uint32_t fd_bit)
 793 {
 794     if (features & (hd_bit | fd_bit)) {
 795         ds_put_format(ds, " %s", name);
 796         if (features & hd_bit) {
 797             ds_put_cstr(ds, "(HD)");
 798         }
 799         if (features & fd_bit) {
 800             ds_put_cstr(ds, "(FD)");
 801         }
 802     }
 803 }
 804
 805 static void
 806 log_port_status(uint16_t port_no,
 807                 const struct ofp_phy_port *old,
 808                 const struct ofp_phy_port *new,
 809                 void *aux)
 810 {
 811     if (VLOG_IS_DBG_ENABLED()) {
 812         bool was_enabled = old->port_no != htons(OFPP_NONE);
 813         bool now_enabled = new->port_no != htons(OFPP_NONE);
 814         uint32_t features = ntohl(new->features);
 815         struct ds ds;
 816
 817         if (old->flags != new->flags && opp_differs(old, new) == 1) {
 818             /* Don't care if only flags changed. */
 819             return;
 820         }
 821
 822         ds_init(&ds);
 823         ds_put_format(&ds, "\"%s\", "ETH_ADDR_FMT, new->name,
 824                       ETH_ADDR_ARGS(new->hw_addr));
 825         if (ntohl(new->speed)) {
 826             ds_put_format(&ds, ", speed %"PRIu32, ntohl(new->speed));
 827         }
 828         if (features & (OFPPF_10MB_HD | OFPPF_10MB_FD
 829                         | OFPPF_100MB_HD | OFPPF_100MB_FD
 830                         | OFPPF_1GB_HD | OFPPF_1GB_FD | OFPPF_10GB_FD)) {
 831             ds_put_cstr(&ds, ", supports");
 832             put_duplexes(&ds, "10M", features, OFPPF_10MB_HD, OFPPF_10MB_FD);
 833             put_duplexes(&ds, "100M", features,
 834                          OFPPF_100MB_HD, OFPPF_100MB_FD);
 835             put_duplexes(&ds, "1G", features, OFPPF_100MB_HD, OFPPF_100MB_FD);
 836             if (features & OFPPF_10GB_FD) {
 837                 ds_put_cstr(&ds, " 10G");
 838             }
 839         }
 840         if (was_enabled != now_enabled) {
 841             if (now_enabled) {
 842                 VLOG_DBG("Port %d added: %s", port_no, ds_cstr(&ds));
 843             } else {
 844                 VLOG_DBG("Port %d deleted", port_no);
 845             }
 846         } else {
 847             VLOG_DBG("Port %d changed: %s", port_no, ds_cstr(&ds));
 848         }
 849         ds_destroy(&ds);
 850     }
 851 }
 852
 853 static void
 854 port_watcher_register_callback(struct port_watcher *pw,
 855                                edit_port_cb_func *edit_port,
 856                                port_changed_cb_func *port_changed,
 857                                void *aux)
 858 {
 859     assert(pw->n_cbs < ARRAY_SIZE(pw->cbs));
 860     pw->cbs[pw->n_cbs].edit_port = edit_port;
 861     pw->cbs[pw->n_cbs].port_changed = port_changed;
 862     pw->cbs[pw->n_cbs].aux = aux;
 863     pw->n_cbs++;
 864 }
 865
 866 static uint32_t
 867 port_watcher_get_flags(const struct port_watcher *pw, int port_no)
 868 {
 869     int idx = port_no_to_pw_idx(port_no);
 870     return idx >= 0 ? ntohl(pw->ports[idx].flags) : 0;
 871 }
 872
 873 static void
 874 port_watcher_set_flags(struct port_watcher *pw,
 875                        int port_no, uint32_t flags, uint32_t mask)
 876 {
 877     struct ofp_phy_port old;
 878     struct ofp_phy_port *p;
 879     struct ofp_port_mod *opm;
 880     struct ofp_port_status *ops;
 881     struct ofpbuf *b;
 882     int idx;
 883
 884     idx = port_no_to_pw_idx(port_no);
 885     if (idx < 0) {
 886         return;
 887     }
 888
 889     p = &pw->ports[idx];
 890     if (!((ntohl(p->flags) ^ flags) & mask)) {
 891         return;
 892     }
 893     old = *p;
 894
 895     /* Update our idea of the flags. */
 896     p->flags = htonl((ntohl(p->flags) & ~mask) | (flags & mask));
 897     call_port_changed_callbacks(pw, port_no, &old, p);
 898
 899     /* Change the flags in the datapath. */
 900     opm = make_openflow(sizeof *opm, OFPT_PORT_MOD, &b);
 901     opm->mask = htonl(mask);
 902     opm->desc = *p;
 903     rconn_send(pw->local_rconn, b, NULL);
 904
 905     /* Notify the controller that the flags changed. */
 906     ops = make_openflow(sizeof *ops, OFPT_PORT_STATUS, &b);
 907     ops->reason = OFPPR_MOD;
 908     ops->desc = *p;
 909     rconn_send(pw->remote_rconn, b, NULL);
 910 }
 911
 912 static bool
 913 port_watcher_is_ready(const struct port_watcher *pw)
 914 {
 915     return pw->got_feature_reply;
 916 }
 917
 918 static struct hook
 919 port_watcher_create(struct rconn *local_rconn, struct rconn *remote_rconn,
 920                     struct port_watcher **pwp)
 921 {
 922     struct port_watcher *pw;
 923     int i;
 924
 925     pw = *pwp = xcalloc(1, sizeof *pw);
 926     pw->local_rconn = local_rconn;
 927     pw->remote_rconn = remote_rconn;
 928     pw->last_feature_request = TIME_MIN;
 929     for (i = 0; i < OFPP_MAX; i++) {
 930         pw->ports[i].port_no = htons(OFPP_NONE);
 931     }
 932     port_watcher_register_callback(pw, NULL, log_port_status, NULL);
 933     return make_hook(port_watcher_local_packet_cb,
 934                      port_watcher_remote_packet_cb,
 935                      port_watcher_periodic_cb, NULL, pw);
 936 }
 937 \f
 938 /* Spanning tree protocol. */
 939
 940 /* Extra time, in seconds, at boot before going into fail-open, to give the
 941  * spanning tree protocol time to figure out the network layout. */
 942 #define STP_EXTRA_BOOT_TIME 30
 943
 944 struct stp_data {
 945     struct stp *stp;
 946     struct port_watcher *pw;
 947     struct rconn *local_rconn;
 948     struct rconn *remote_rconn;
 949     uint8_t dpid[ETH_ADDR_LEN];
 950     long long int last_tick_256ths;
 951     int n_txq;
 952 };
 953
 954 static bool
 955 stp_local_packet_cb(struct relay *r, void *stp_)
 956 {
 957     struct ofpbuf *msg = r->halves[HALF_LOCAL].rxbuf;
 958     struct ofp_header *oh;
 959     struct stp_data *stp = stp_;
 960     struct ofp_packet_in *opi;
 961     struct eth_header *eth;
 962     struct llc_header *llc;
 963     struct ofpbuf payload;
 964     uint16_t port_no;
 965     struct flow flow;
 966
 967     oh = msg->data;
 968     if (oh->type == OFPT_FEATURES_REPLY
 969         && msg->size >= offsetof(struct ofp_switch_features, ports)) {
 970         struct ofp_switch_features *osf = msg->data;
 971         osf->capabilities |= htonl(OFPC_STP);
 972         return false;
 973     }
 974
 975     if (!get_ofp_packet_eth_header(r, &opi, &eth)
 976         || !eth_addr_equals(eth->eth_dst, stp_eth_addr)) {
 977         return false;
 978     }
 979
 980     port_no = ntohs(opi->in_port);
 981     if (port_no >= STP_MAX_PORTS) {
 982         /* STP only supports 255 ports. */
 983         return false;
 984     }
 985     if (port_watcher_get_flags(stp->pw, port_no) & OFPPFL_NO_STP) {
 986         /* We're not doing STP on this port. */
 987         return false;
 988     }
 989
 990     if (opi->reason == OFPR_ACTION) {
 991         /* The controller set up a flow for this, so we won't intercept it. */
 992         return false;
 993     }
 994
 995     get_ofp_packet_payload(opi, &payload);
 996     flow_extract(&payload, port_no, &flow);
 997     if (flow.dl_type != htons(OFP_DL_TYPE_NOT_ETH_TYPE)) {
 998         VLOG_DBG("non-LLC frame received on STP multicast address");
 999         return false;
1000     }
1001     llc = ofpbuf_at_assert(&payload, sizeof *eth, sizeof *llc);
1002     if (llc->llc_dsap != STP_LLC_DSAP) {
1003         VLOG_DBG("bad DSAP 0x%02"PRIx8" received on STP multicast address",
1004                  llc->llc_dsap);
1005         return false;
1006     }
1007
1008     /* Trim off padding on payload. */
1009     if (payload.size > ntohs(eth->eth_type) + ETH_HEADER_LEN) {
1010         payload.size = ntohs(eth->eth_type) + ETH_HEADER_LEN;
1011     }
1012     if (ofpbuf_try_pull(&payload, ETH_HEADER_LEN + LLC_HEADER_LEN)) {
1013         struct stp_port *p = stp_get_port(stp->stp, port_no);
1014         stp_received_bpdu(p, payload.data, payload.size);
1015     }
1016
1017     return true;
1018 }
1019
1020 static long long int
1021 time_256ths(void)
1022 {
1023     return time_msec() * 256 / 1000;
1024 }
1025
1026 static void
1027 stp_periodic_cb(void *stp_)
1028 {
1029     struct stp_data *stp = stp_;
1030     long long int now_256ths = time_256ths();
1031     long long int elapsed_256ths = now_256ths - stp->last_tick_256ths;
1032     struct stp_port *p;
1033
1034     if (!port_watcher_is_ready(stp->pw)) {
1035         /* Can't start STP until we know port flags, because port flags can
1036          * disable STP. */
1037         return;
1038     }
1039     if (elapsed_256ths <= 0) {
1040         return;
1041     }
1042
1043     stp_tick(stp->stp, MIN(INT_MAX, elapsed_256ths));
1044     stp->last_tick_256ths = now_256ths;
1045
1046     while (stp_get_changed_port(stp->stp, &p)) {
1047         int port_no = stp_port_no(p);
1048         enum stp_state state = stp_port_get_state(p);
1049
1050         if (state != STP_DISABLED) {
1051             VLOG_WARN("STP: Port %d entered %s state",
1052                       port_no, stp_state_name(state));
1053         }
1054         if (!(port_watcher_get_flags(stp->pw, port_no) & OFPPFL_NO_STP)) {
1055             uint32_t flags;
1056             switch (state) {
1057             case STP_LISTENING:
1058                 flags = OFPPFL_STP_LISTEN;
1059                 break;
1060             case STP_LEARNING:
1061                 flags = OFPPFL_STP_LEARN;
1062                 break;
1063             case STP_DISABLED:
1064             case STP_FORWARDING:
1065                 flags = OFPPFL_STP_FORWARD;
1066                 break;
1067             case STP_BLOCKING:
1068                 flags = OFPPFL_STP_BLOCK;
1069                 break;
1070             default:
1071                 VLOG_DBG_RL(&vrl, "STP: Port %d has bad state %x",
1072                             port_no, state);
1073                 flags = OFPPFL_STP_FORWARD;
1074                 break;
1075             }
1076             if (!stp_forward_in_state(state)) {
1077                 flags |= OFPPFL_NO_FLOOD;
1078             }
1079             port_watcher_set_flags(stp->pw, port_no, flags,
1080                                    OFPPFL_STP_MASK | OFPPFL_NO_FLOOD);
1081         } else {
1082             /* We don't own those flags. */
1083         }
1084     }
1085 }
1086
1087 static void
1088 stp_wait_cb(void *stp_ UNUSED)
1089 {
1090     poll_timer_wait(1000);
1091 }
1092
1093 static void
1094 send_bpdu(const void *bpdu, size_t bpdu_size, int port_no, void *stp_)
1095 {
1096     struct stp_data *stp = stp_;
1097     struct eth_header *eth;
1098     struct llc_header *llc;
1099     struct ofpbuf pkt, *opo;
1100
1101     /* Packet skeleton. */
1102     ofpbuf_init(&pkt, ETH_HEADER_LEN + LLC_HEADER_LEN + bpdu_size);
1103     eth = ofpbuf_put_uninit(&pkt, sizeof *eth);
1104     llc = ofpbuf_put_uninit(&pkt, sizeof *llc);
1105     ofpbuf_put(&pkt, bpdu, bpdu_size);
1106
1107     /* 802.2 header. */
1108     memcpy(eth->eth_dst, stp_eth_addr, ETH_ADDR_LEN);
1109     memcpy(eth->eth_src, stp->pw->ports[port_no].hw_addr, ETH_ADDR_LEN);
1110     eth->eth_type = htons(pkt.size - ETH_HEADER_LEN);
1111
1112     /* LLC header. */
1113     llc->llc_dsap = STP_LLC_DSAP;
1114     llc->llc_ssap = STP_LLC_SSAP;
1115     llc->llc_cntl = STP_LLC_CNTL;
1116
1117     opo = make_unbuffered_packet_out(&pkt, OFPP_NONE, port_no);
1118     ofpbuf_uninit(&pkt);
1119     rconn_send_with_limit(stp->local_rconn, opo, &stp->n_txq, OFPP_MAX);
1120 }
1121
1122 static bool
1123 stp_is_port_supported(uint16_t port_no)
1124 {
1125     /* We should be able to support STP on all possible OpenFlow physical
1126      * ports.  (But we don't support STP on OFPP_LOCAL.)  */
1127     BUILD_ASSERT_DECL(STP_MAX_PORTS >= OFPP_MAX);
1128     return port_no < STP_MAX_PORTS;
1129 }
1130
1131 static void
1132 stp_port_changed_cb(uint16_t port_no,
1133                     const struct ofp_phy_port *old,
1134                     const struct ofp_phy_port *new,
1135                     void *stp_)
1136 {
1137     struct stp_data *stp = stp_;
1138     struct stp_port *p;
1139
1140     if (!stp_is_port_supported(port_no)) {
1141         return;
1142     }
1143
1144     p = stp_get_port(stp->stp, port_no);
1145     if (new->port_no == htons(OFPP_NONE)
1146         || new->flags & htonl(OFPPFL_NO_STP)) {
1147         stp_port_disable(p);
1148     } else {
1149         stp_port_enable(p);
1150         stp_port_set_speed(p, new->speed);
1151     }
1152 }
1153
1154 static struct hook
1155 stp_hook_create(const struct settings *s, struct port_watcher *pw,
1156                 struct rconn *local, struct rconn *remote)
1157 {
1158     uint8_t dpid[ETH_ADDR_LEN];
1159     struct netdev *netdev;
1160     struct stp_data *stp;
1161     int retval;
1162
1163     retval = netdev_open(s->of_name, NETDEV_ETH_TYPE_NONE, &netdev);
1164     if (retval) {
1165         ofp_fatal(retval, "Could not open %s device", s->of_name);
1166     }
1167     memcpy(dpid, netdev_get_etheraddr(netdev), ETH_ADDR_LEN);
1168     netdev_close(netdev);
1169
1170     stp = xcalloc(1, sizeof *stp);
1171     stp->stp = stp_create("stp", eth_addr_to_uint64(dpid), send_bpdu, stp);
1172     stp->pw = pw;
1173     memcpy(stp->dpid, dpid, ETH_ADDR_LEN);
1174     stp->local_rconn = local;
1175     stp->remote_rconn = remote;
1176     stp->last_tick_256ths = time_256ths();
1177
1178     port_watcher_register_callback(pw, NULL, stp_port_changed_cb, stp);
1179     return make_hook(stp_local_packet_cb, NULL,
1180                      stp_periodic_cb, stp_wait_cb, stp);
1181 }
1182 \f
1183 /* In-band control. */
1184
1185 struct in_band_data {
1186     const struct settings *s;
1187     struct mac_learning *ml;
1188     struct netdev *of_device;
1189     struct rconn *controller;
1190     uint8_t mac[ETH_ADDR_LEN];
1191     int n_queued;
1192 };
1193
1194 static void
1195 queue_tx(struct rconn *rc, struct in_band_data *in_band, struct ofpbuf *b)
1196 {
1197     rconn_send_with_limit(rc, b, &in_band->n_queued, 10);
1198 }
1199
1200 static const uint8_t *
1201 get_controller_mac(struct in_band_data *in_band)
1202 {
1203     static uint32_t ip, last_nonzero_ip;
1204     static uint8_t mac[ETH_ADDR_LEN], last_nonzero_mac[ETH_ADDR_LEN];
1205     static time_t next_refresh = 0;
1206
1207     uint32_t last_ip = ip;
1208
1209     time_t now = time_now();
1210
1211     ip = rconn_get_ip(in_band->controller);
1212     if (last_ip != ip || !next_refresh || now >= next_refresh) {
1213         bool have_mac;
1214
1215         /* Look up MAC address. */
1216         memset(mac, 0, sizeof mac);
1217         if (ip) {
1218             int retval = netdev_arp_lookup(in_band->of_device, ip, mac);
1219             if (retval) {
1220                 VLOG_DBG("cannot look up controller hw address ("IP_FMT"): %s",
1221                          IP_ARGS(&ip), strerror(retval));
1222             }
1223         }
1224         have_mac = !eth_addr_is_zero(mac);
1225
1226         /* Log changes in IP, MAC addresses. */
1227         if (ip && ip != last_nonzero_ip) {
1228             VLOG_DBG("controller IP address changed from "IP_FMT
1229                      " to "IP_FMT, IP_ARGS(&last_nonzero_ip), IP_ARGS(&ip));
1230             last_nonzero_ip = ip;
1231         }
1232         if (have_mac && memcmp(last_nonzero_mac, mac, ETH_ADDR_LEN)) {
1233             VLOG_DBG("controller MAC address changed from "ETH_ADDR_FMT" to "
1234                      ETH_ADDR_FMT,
1235                      ETH_ADDR_ARGS(last_nonzero_mac), ETH_ADDR_ARGS(mac));
1236             memcpy(last_nonzero_mac, mac, ETH_ADDR_LEN);
1237         }
1238
1239         /* Schedule next refresh.
1240          *
1241          * If we have an IP address but not a MAC address, then refresh
1242          * quickly, since we probably will get a MAC address soon (via ARP).
1243          * Otherwise, we can afford to wait a little while. */
1244         next_refresh = now + (!ip || have_mac ? 10 : 1);
1245     }
1246     return !eth_addr_is_zero(mac) ? mac : NULL;
1247 }
1248
1249 static bool
1250 is_controller_mac(const uint8_t dl_addr[ETH_ADDR_LEN],
1251                   struct in_band_data *in_band)
1252 {
1253     const uint8_t *mac = get_controller_mac(in_band);
1254     return mac && eth_addr_equals(mac, dl_addr);
1255 }
1256
1257 static void
1258 in_band_learn_mac(struct in_band_data *in_band,
1259                   uint16_t in_port, const uint8_t src_mac[ETH_ADDR_LEN])
1260 {
1261     if (mac_learning_learn(in_band->ml, src_mac, in_port)) {
1262         VLOG_DBG_RL(&vrl, "learned that "ETH_ADDR_FMT" is on port %"PRIu16,
1263                     ETH_ADDR_ARGS(src_mac), in_port);
1264     }
1265 }
1266
1267 static bool
1268 in_band_local_packet_cb(struct relay *r, void *in_band_)
1269 {
1270     struct in_band_data *in_band = in_band_;
1271     struct rconn *rc = r->halves[HALF_LOCAL].rconn;
1272     struct ofp_packet_in *opi;
1273     struct eth_header *eth;
1274     struct ofpbuf payload;
1275     struct flow flow;
1276     uint16_t in_port;
1277     int out_port;
1278
1279     if (!get_ofp_packet_eth_header(r, &opi, &eth)) {
1280         return false;
1281     }
1282     in_port = ntohs(opi->in_port);
1283
1284     /* Deal with local stuff. */
1285     if (in_port == OFPP_LOCAL) {
1286         /* Sent by secure channel. */
1287         out_port = mac_learning_lookup(in_band->ml, eth->eth_dst);
1288     } else if (eth_addr_equals(eth->eth_dst, in_band->mac)) {
1289         /* Sent to secure channel. */
1290         out_port = OFPP_LOCAL;
1291         in_band_learn_mac(in_band, in_port, eth->eth_src);
1292     } else if (eth->eth_type == htons(ETH_TYPE_ARP)
1293                && eth_addr_is_broadcast(eth->eth_dst)
1294                && is_controller_mac(eth->eth_src, in_band)) {
1295         /* ARP sent by controller. */
1296         out_port = OFPP_FLOOD;
1297     } else if (is_controller_mac(eth->eth_dst, in_band)
1298                || is_controller_mac(eth->eth_src, in_band)) {
1299         /* Traffic to or from controller.  Switch it by hand. */
1300         in_band_learn_mac(in_band, in_port, eth->eth_src);
1301         out_port = mac_learning_lookup(in_band->ml, eth->eth_dst);
1302     } else {
1303         const uint8_t *controller_mac;
1304         controller_mac = get_controller_mac(in_band);
1305         if (eth->eth_type == htons(ETH_TYPE_ARP)
1306             && eth_addr_is_broadcast(eth->eth_dst)
1307             && is_controller_mac(eth->eth_src, in_band)) {
1308             /* ARP sent by controller. */
1309             out_port = OFPP_FLOOD;
1310         } else if (is_controller_mac(eth->eth_dst, in_band)
1311                    && in_port == mac_learning_lookup(in_band->ml,
1312                                                      controller_mac)) {
1313             /* Drop controller traffic that arrives on the controller port. */
1314             out_port = -1;
1315         } else {
1316             return false;
1317         }
1318     }
1319
1320     get_ofp_packet_payload(opi, &payload);
1321     flow_extract(&payload, in_port, &flow);
1322     if (in_port == out_port) {
1323         /* The input and output port match.  Set up a flow to drop packets. */
1324         queue_tx(rc, in_band, make_add_flow(&flow, ntohl(opi->buffer_id),
1325                                           in_band->s->max_idle, 0));
1326     } else if (out_port != OFPP_FLOOD) {
1327         /* The output port is known, so add a new flow. */
1328         queue_tx(rc, in_band,
1329                  make_add_simple_flow(&flow, ntohl(opi->buffer_id),
1330                                       out_port, in_band->s->max_idle));
1331
1332         /* If the switch didn't buffer the packet, we need to send a copy. */
1333         if (ntohl(opi->buffer_id) == UINT32_MAX) {
1334             queue_tx(rc, in_band,
1335                      make_unbuffered_packet_out(&payload, in_port, out_port));
1336         }
1337     } else {
1338         /* We don't know that MAC.  Send along the packet without setting up a
1339          * flow. */
1340         struct ofpbuf *b;
1341         if (ntohl(opi->buffer_id) == UINT32_MAX) {
1342             b = make_unbuffered_packet_out(&payload, in_port, out_port);
1343         } else {
1344             b = make_buffered_packet_out(ntohl(opi->buffer_id),
1345                                          in_port, out_port);
1346         }
1347         queue_tx(rc, in_band, b);
1348     }
1349     return true;
1350 }
1351
1352 static void
1353 in_band_status_cb(struct status_reply *sr, void *in_band_)
1354 {
1355     struct in_band_data *in_band = in_band_;
1356     struct in_addr local_ip;
1357     uint32_t controller_ip;
1358     const uint8_t *controller_mac;
1359
1360     if (netdev_get_in4(in_band->of_device, &local_ip)) {
1361         status_reply_put(sr, "local-ip="IP_FMT, IP_ARGS(&local_ip.s_addr));
1362     }
1363     status_reply_put(sr, "local-mac="ETH_ADDR_FMT,
1364                      ETH_ADDR_ARGS(in_band->mac));
1365
1366     controller_ip = rconn_get_ip(in_band->controller);
1367     if (controller_ip) {
1368         status_reply_put(sr, "controller-ip="IP_FMT,
1369                       IP_ARGS(&controller_ip));
1370     }
1371     controller_mac = get_controller_mac(in_band);
1372     if (controller_mac) {
1373         status_reply_put(sr, "controller-mac="ETH_ADDR_FMT,
1374                       ETH_ADDR_ARGS(controller_mac));
1375     }
1376 }
1377
1378 static void
1379 get_ofp_packet_payload(struct ofp_packet_in *opi, struct ofpbuf *payload)
1380 {
1381     payload->data = opi->data;
1382     payload->size = ntohs(opi->header.length) - offsetof(struct ofp_packet_in,
1383                                                          data);
1384 }
1385
1386 static struct hook
1387 in_band_hook_create(const struct settings *s, struct switch_status *ss,
1388                     struct rconn *remote)
1389 {
1390     struct in_band_data *in_band;
1391     int retval;
1392
1393     in_band = xcalloc(1, sizeof *in_band);
1394     in_band->s = s;
1395     in_band->ml = mac_learning_create();
1396     retval = netdev_open(s->of_name, NETDEV_ETH_TYPE_NONE,
1397                          &in_band->of_device);
1398     if (retval) {
1399         ofp_fatal(retval, "Could not open %s device", s->of_name);
1400     }
1401     memcpy(in_band->mac, netdev_get_etheraddr(in_band->of_device),
1402            ETH_ADDR_LEN);
1403     in_band->controller = remote;
1404     switch_status_register_category(ss, "in-band", in_band_status_cb, in_band);
1405     return make_hook(in_band_local_packet_cb, NULL, NULL, NULL, in_band);
1406 }
1407 \f
1408 /* Fail open support. */
1409
1410 struct fail_open_data {
1411     const struct settings *s;
1412     struct rconn *local_rconn;
1413     struct rconn *remote_rconn;
1414     struct lswitch *lswitch;
1415     int last_disconn_secs;
1416     time_t boot_deadline;
1417 };
1418
1419 /* Causes 'r' to enter or leave fail-open mode, if appropriate. */
1420 static void
1421 fail_open_periodic_cb(void *fail_open_)
1422 {
1423     struct fail_open_data *fail_open = fail_open_;
1424     int disconn_secs;
1425     bool open;
1426
1427     if (time_now() < fail_open->boot_deadline) {
1428         return;
1429     }
1430     disconn_secs = rconn_disconnected_duration(fail_open->remote_rconn);
1431     open = disconn_secs >= fail_open->s->probe_interval * 3;
1432     if (open != (fail_open->lswitch != NULL)) {
1433         if (!open) {
1434             VLOG_WARN("No longer in fail-open mode");
1435             lswitch_destroy(fail_open->lswitch);
1436             fail_open->lswitch = NULL;
1437         } else {
1438             VLOG_WARN("Could not connect to controller for %d seconds, "
1439                       "failing open", disconn_secs);
1440             fail_open->lswitch = lswitch_create(fail_open->local_rconn, true,
1441                                                 fail_open->s->max_idle);
1442             fail_open->last_disconn_secs = disconn_secs;
1443         }
1444     } else if (open && disconn_secs > fail_open->last_disconn_secs + 60) {
1445         VLOG_WARN("Still in fail-open mode after %d seconds disconnected "
1446                   "from controller", disconn_secs);
1447         fail_open->last_disconn_secs = disconn_secs;
1448     }
1449 }
1450
1451 static bool
1452 fail_open_local_packet_cb(struct relay *r, void *fail_open_)
1453 {
1454     struct fail_open_data *fail_open = fail_open_;
1455     if (!fail_open->lswitch) {
1456         return false;
1457     } else {
1458         lswitch_process_packet(fail_open->lswitch, fail_open->local_rconn,
1459                                r->halves[HALF_LOCAL].rxbuf);
1460         rconn_run(fail_open->local_rconn);
1461         return true;
1462     }
1463 }
1464
1465 static void
1466 fail_open_status_cb(struct status_reply *sr, void *fail_open_)
1467 {
1468     struct fail_open_data *fail_open = fail_open_;
1469     const struct settings *s = fail_open->s;
1470     int trigger_duration = s->probe_interval * 3;
1471     int cur_duration = rconn_disconnected_duration(fail_open->remote_rconn);
1472
1473     status_reply_put(sr, "trigger-duration=%d", trigger_duration);
1474     status_reply_put(sr, "current-duration=%d", cur_duration);
1475     status_reply_put(sr, "triggered=%s",
1476                      cur_duration >= trigger_duration ? "true" : "false");
1477     status_reply_put(sr, "max-idle=%d", s->max_idle);
1478 }
1479
1480 static struct hook
1481 fail_open_hook_create(const struct settings *s, struct switch_status *ss,
1482                       struct rconn *local_rconn, struct rconn *remote_rconn)
1483 {
1484     struct fail_open_data *fail_open = xmalloc(sizeof *fail_open);
1485     fail_open->s = s;
1486     fail_open->local_rconn = local_rconn;
1487     fail_open->remote_rconn = remote_rconn;
1488     fail_open->lswitch = NULL;
1489     fail_open->boot_deadline = time_now() + s->probe_interval * 3;
1490     if (s->enable_stp) {
1491         fail_open->boot_deadline += STP_EXTRA_BOOT_TIME;
1492     }
1493     switch_status_register_category(ss, "fail-open",
1494                                     fail_open_status_cb, fail_open);
1495     return make_hook(fail_open_local_packet_cb, NULL,
1496                      fail_open_periodic_cb, NULL, fail_open);
1497 }
1498 \f
1499 struct rate_limiter {
1500     const struct settings *s;
1501     struct rconn *remote_rconn;
1502
1503     /* One queue per physical port. */
1504     struct ofp_queue queues[OFPP_MAX];
1505     int n_queued;               /* Sum over queues[*].n. */
1506     int next_tx_port;           /* Next port to check in round-robin. */
1507
1508     /* Token bucket.
1509      *
1510      * It costs 1000 tokens to send a single packet_in message.  A single token
1511      * per message would be more straightforward, but this choice lets us avoid
1512      * round-off error in refill_bucket()'s calculation of how many tokens to
1513      * add to the bucket, since no division step is needed. */
1514     long long int last_fill;    /* Time at which we last added tokens. */
1515     int tokens;                 /* Current number of tokens. */
1516
1517     /* Transmission queue. */
1518     int n_txq;                  /* No. of packets waiting in rconn for tx. */
1519
1520     /* Statistics reporting. */
1521     unsigned long long n_normal;        /* # txed w/o rate limit queuing. */
1522     unsigned long long n_limited;       /* # queued for rate limiting. */
1523     unsigned long long n_queue_dropped; /* # dropped due to queue overflow. */
1524     unsigned long long n_tx_dropped;    /* # dropped due to tx overflow. */
1525 };
1526
1527 /* Drop a packet from the longest queue in 'rl'. */
1528 static void
1529 drop_packet(struct rate_limiter *rl)
1530 {
1531     struct ofp_queue *longest;  /* Queue currently selected as longest. */
1532     int n_longest;              /* # of queues of same length as 'longest'. */
1533     struct ofp_queue *q;
1534
1535     longest = &rl->queues[0];
1536     n_longest = 1;
1537     for (q = &rl->queues[0]; q < &rl->queues[OFPP_MAX]; q++) {
1538         if (longest->n < q->n) {
1539             longest = q;
1540             n_longest = 1;
1541         } else if (longest->n == q->n) {
1542             n_longest++;
1543
1544             /* Randomly select one of the longest queues, with a uniform
1545              * distribution (Knuth algorithm 3.4.2R). */
1546             if (!random_range(n_longest)) {
1547                 longest = q;
1548             }
1549         }
1550     }
1551
1552     /* FIXME: do we want to pop the tail instead? */
1553     ofpbuf_delete(queue_pop_head(longest));
1554     rl->n_queued--;
1555 }
1556
1557 /* Remove and return the next packet to transmit (in round-robin order). */
1558 static struct ofpbuf *
1559 dequeue_packet(struct rate_limiter *rl)
1560 {
1561     unsigned int i;
1562
1563     for (i = 0; i < OFPP_MAX; i++) {
1564         unsigned int port = (rl->next_tx_port + i) % OFPP_MAX;
1565         struct ofp_queue *q = &rl->queues[port];
1566         if (q->n) {
1567             rl->next_tx_port = (port + 1) % OFPP_MAX;
1568             rl->n_queued--;
1569             return queue_pop_head(q);
1570         }
1571     }
1572     NOT_REACHED();
1573 }
1574
1575 /* Add tokens to the bucket based on elapsed time. */
1576 static void
1577 refill_bucket(struct rate_limiter *rl)
1578 {
1579     const struct settings *s = rl->s;
1580     long long int now = time_msec();
1581     long long int tokens = (now - rl->last_fill) * s->rate_limit + rl->tokens;
1582     if (tokens >= 1000) {
1583         rl->last_fill = now;
1584         rl->tokens = MIN(tokens, s->burst_limit * 1000);
1585     }
1586 }
1587
1588 /* Attempts to remove enough tokens from 'rl' to transmit a packet.  Returns
1589  * true if successful, false otherwise.  (In the latter case no tokens are
1590  * removed.) */
1591 static bool
1592 get_token(struct rate_limiter *rl)
1593 {
1594     if (rl->tokens >= 1000) {
1595         rl->tokens -= 1000;
1596         return true;
1597     } else {
1598         return false;
1599     }
1600 }
1601
1602 static bool
1603 rate_limit_local_packet_cb(struct relay *r, void *rl_)
1604 {
1605     struct rate_limiter *rl = rl_;
1606     const struct settings *s = rl->s;
1607     struct ofp_packet_in *opi;
1608
1609     opi = get_ofp_packet_in(r);
1610     if (!opi) {
1611         return false;
1612     }
1613
1614     if (!rl->n_queued && get_token(rl)) {
1615         /* In the common case where we are not constrained by the rate limit,
1616          * let the packet take the normal path. */
1617         rl->n_normal++;
1618         return false;
1619     } else {
1620         /* Otherwise queue it up for the periodic callback to drain out. */
1621         struct ofpbuf *msg = r->halves[HALF_LOCAL].rxbuf;
1622         int port = ntohs(opi->in_port) % OFPP_MAX;
1623         if (rl->n_queued >= s->burst_limit) {
1624             drop_packet(rl);
1625         }
1626         queue_push_tail(&rl->queues[port], ofpbuf_clone(msg));
1627         rl->n_queued++;
1628         rl->n_limited++;
1629         return true;
1630     }
1631 }
1632
1633 static void
1634 rate_limit_status_cb(struct status_reply *sr, void *rl_)
1635 {
1636     struct rate_limiter *rl = rl_;
1637
1638     status_reply_put(sr, "normal=%llu", rl->n_normal);
1639     status_reply_put(sr, "limited=%llu", rl->n_limited);
1640     status_reply_put(sr, "queue-dropped=%llu", rl->n_queue_dropped);
1641     status_reply_put(sr, "tx-dropped=%llu", rl->n_tx_dropped);
1642 }
1643
1644 static void
1645 rate_limit_periodic_cb(void *rl_)
1646 {
1647     struct rate_limiter *rl = rl_;
1648     int i;
1649
1650     /* Drain some packets out of the bucket if possible, but limit the number
1651      * of iterations to allow other code to get work done too. */
1652     refill_bucket(rl);
1653     for (i = 0; rl->n_queued && get_token(rl) && i < 50; i++) {
1654         /* Use a small, arbitrary limit for the amount of queuing to do here,
1655          * because the TCP connection is responsible for buffering and there is
1656          * no point in trying to transmit faster than the TCP connection can
1657          * handle. */
1658         struct ofpbuf *b = dequeue_packet(rl);
1659         if (rconn_send_with_limit(rl->remote_rconn, b, &rl->n_txq, 10)) {
1660             rl->n_tx_dropped++;
1661         }
1662     }
1663 }
1664
1665 static void
1666 rate_limit_wait_cb(void *rl_)
1667 {
1668     struct rate_limiter *rl = rl_;
1669     if (rl->n_queued) {
1670         if (rl->tokens >= 1000) {
1671             /* We can transmit more packets as soon as we're called again. */
1672             poll_immediate_wake();
1673         } else {
1674             /* We have to wait for the bucket to re-fill.  We could calculate
1675              * the exact amount of time here for increased smoothness. */
1676             poll_timer_wait(TIME_UPDATE_INTERVAL / 2);
1677         }
1678     }
1679 }
1680
1681 static struct hook
1682 rate_limit_hook_create(const struct settings *s, struct switch_status *ss,
1683                        struct rconn *local, struct rconn *remote)
1684 {
1685     struct rate_limiter *rl;
1686     size_t i;
1687
1688     rl = xcalloc(1, sizeof *rl);
1689     rl->s = s;
1690     rl->remote_rconn = remote;
1691     for (i = 0; i < ARRAY_SIZE(rl->queues); i++) {
1692         queue_init(&rl->queues[i]);
1693     }
1694     rl->last_fill = time_msec();
1695     rl->tokens = s->rate_limit * 100;
1696     switch_status_register_category(ss, "rate-limit",
1697                                     rate_limit_status_cb, rl);
1698     return make_hook(rate_limit_local_packet_cb, NULL, rate_limit_periodic_cb,
1699                      rate_limit_wait_cb, rl);
1700 }
1701 \f
1702 /* OFPST_SWITCH statistics. */
1703
1704 struct switch_status_category {
1705     char *name;
1706     void (*cb)(struct status_reply *, void *aux);
1707     void *aux;
1708 };
1709
1710 struct switch_status {
1711     const struct settings *s;
1712     time_t booted;
1713     struct switch_status_category categories[8];
1714     int n_categories;
1715 };
1716
1717 struct status_reply {
1718     struct switch_status_category *category;
1719     struct ds request;
1720     struct ds output;
1721 };
1722
1723 static bool
1724 switch_status_remote_packet_cb(struct relay *r, void *ss_)
1725 {
1726     struct switch_status *ss = ss_;
1727     struct rconn *rc = r->halves[HALF_REMOTE].rconn;
1728     struct ofpbuf *msg = r->halves[HALF_REMOTE].rxbuf;
1729     struct switch_status_category *c;
1730     struct nicira_header *request;
1731     struct nicira_header *reply;
1732     struct status_reply sr;
1733     struct ofpbuf *b;
1734     int retval;
1735
1736     if (msg->size < sizeof(struct nicira_header)) {
1737         return false;
1738     }
1739     request = msg->data;
1740     if (request->header.type != OFPT_VENDOR
1741         || request->vendor_id != htonl(NX_VENDOR_ID)
1742         || request->subtype != htonl(NXT_STATUS_REQUEST)) {
1743         return false;
1744     }
1745
1746     sr.request.string = (void *) (request + 1);
1747     sr.request.length = msg->size - sizeof *request;
1748     ds_init(&sr.output);
1749     for (c = ss->categories; c < &ss->categories[ss->n_categories]; c++) {
1750         if (!memcmp(c->name, sr.request.string,
1751                     MIN(strlen(c->name), sr.request.length))) {
1752             sr.category = c;
1753             c->cb(&sr, c->aux);
1754         }
1755     }
1756     reply = make_openflow_xid(sizeof *reply + sr.output.length,
1757                               OFPT_VENDOR, request->header.xid, &b);
1758     reply->vendor_id = htonl(NX_VENDOR_ID);
1759     reply->subtype = htonl(NXT_STATUS_REPLY);
1760     memcpy(reply + 1, sr.output.string, sr.output.length);
1761     retval = rconn_send(rc, b, NULL);
1762     if (retval && retval != EAGAIN) {
1763         VLOG_WARN("send failed (%s)", strerror(retval));
1764     }
1765     ds_destroy(&sr.output);
1766     return true;
1767 }
1768
1769 static void
1770 rconn_status_cb(struct status_reply *sr, void *rconn_)
1771 {
1772     struct rconn *rconn = rconn_;
1773     time_t now = time_now();
1774
1775     status_reply_put(sr, "name=%s", rconn_get_name(rconn));
1776     status_reply_put(sr, "state=%s", rconn_get_state(rconn));
1777     status_reply_put(sr, "backoff=%d", rconn_get_backoff(rconn));
1778     status_reply_put(sr, "is-connected=%s",
1779                      rconn_is_connected(rconn) ? "true" : "false");
1780     status_reply_put(sr, "sent-msgs=%u", rconn_packets_sent(rconn));
1781     status_reply_put(sr, "received-msgs=%u", rconn_packets_received(rconn));
1782     status_reply_put(sr, "attempted-connections=%u",
1783                      rconn_get_attempted_connections(rconn));
1784     status_reply_put(sr, "successful-connections=%u",
1785                      rconn_get_successful_connections(rconn));
1786     status_reply_put(sr, "last-connection=%ld",
1787                      (long int) (now - rconn_get_last_connection(rconn)));
1788     status_reply_put(sr, "time-connected=%lu",
1789                      rconn_get_total_time_connected(rconn));
1790     status_reply_put(sr, "state-elapsed=%u", rconn_get_state_elapsed(rconn));
1791 }
1792
1793 static void
1794 config_status_cb(struct status_reply *sr, void *s_)
1795 {
1796     const struct settings *s = s_;
1797     size_t i;
1798
1799     for (i = 0; i < s->n_listeners; i++) {
1800         status_reply_put(sr, "management%zu=%s", i, s->listener_names[i]);
1801     }
1802     if (s->probe_interval) {
1803         status_reply_put(sr, "probe-interval=%d", s->probe_interval);
1804     }
1805     if (s->max_backoff) {
1806         status_reply_put(sr, "max-backoff=%d", s->max_backoff);
1807     }
1808 }
1809
1810 static void
1811 switch_status_cb(struct status_reply *sr, void *ss_)
1812 {
1813     struct switch_status *ss = ss_;
1814     time_t now = time_now();
1815
1816     status_reply_put(sr, "now=%ld", (long int) now);
1817     status_reply_put(sr, "uptime=%ld", (long int) (now - ss->booted));
1818     status_reply_put(sr, "pid=%ld", (long int) getpid());
1819 }
1820
1821 static struct hook
1822 switch_status_hook_create(const struct settings *s, struct switch_status **ssp)
1823 {
1824     struct switch_status *ss = xcalloc(1, sizeof *ss);
1825     ss->s = s;
1826     ss->booted = time_now();
1827     switch_status_register_category(ss, "config",
1828                                     config_status_cb, (void *) s);
1829     switch_status_register_category(ss, "switch", switch_status_cb, ss);
1830     *ssp = ss;
1831     return make_hook(NULL, switch_status_remote_packet_cb, NULL, NULL, ss);
1832 }
1833
1834 static void
1835 switch_status_register_category(struct switch_status *ss,
1836                                 const char *category,
1837                                 void (*cb)(struct status_reply *,
1838                                            void *aux),
1839                                 void *aux)
1840 {
1841     struct switch_status_category *c;
1842     assert(ss->n_categories < ARRAY_SIZE(ss->categories));
1843     c = &ss->categories[ss->n_categories++];
1844     c->cb = cb;
1845     c->aux = aux;
1846     c->name = xstrdup(category);
1847 }
1848
1849 static void
1850 status_reply_put(struct status_reply *sr, const char *content, ...)
1851 {
1852     size_t old_length = sr->output.length;
1853     size_t added;
1854     va_list args;
1855
1856     /* Append the status reply to the output. */
1857     ds_put_format(&sr->output, "%s.", sr->category->name);
1858     va_start(args, content);
1859     ds_put_format_valist(&sr->output, content, args);
1860     va_end(args);
1861     if (ds_last(&sr->output) != '\n') {
1862         ds_put_char(&sr->output, '\n');
1863     }
1864
1865     /* Drop what we just added if it doesn't match the request. */
1866     added = sr->output.length - old_length;
1867     if (added < sr->request.length
1868         || memcmp(&sr->output.string[old_length],
1869                   sr->request.string, sr->request.length)) {
1870         ds_truncate(&sr->output, old_length);
1871     }
1872 }
1873
1874 \f
1875 /* Controller discovery. */
1876
1877 struct discovery
1878 {
1879     const struct settings *s;
1880     struct dhclient *dhcp;
1881     int n_changes;
1882 };
1883
1884 static void
1885 discovery_status_cb(struct status_reply *sr, void *d_)
1886 {
1887     struct discovery *d = d_;
1888
1889     status_reply_put(sr, "accept-remote=%s", d->s->accept_controller_re);
1890     status_reply_put(sr, "n-changes=%d", d->n_changes);
1891     status_reply_put(sr, "state=%s", dhclient_get_state(d->dhcp));
1892     status_reply_put(sr, "state-elapsed=%u",
1893                      dhclient_get_state_elapsed(d->dhcp));
1894     if (dhclient_is_bound(d->dhcp)) {
1895         uint32_t ip = dhclient_get_ip(d->dhcp);
1896         uint32_t netmask = dhclient_get_netmask(d->dhcp);
1897         uint32_t router = dhclient_get_router(d->dhcp);
1898
1899         const struct dhcp_msg *cfg = dhclient_get_config(d->dhcp);
1900         uint32_t dns_server;
1901         char *domain_name;
1902         int i;
1903
1904         status_reply_put(sr, "ip="IP_FMT, IP_ARGS(&ip));
1905         status_reply_put(sr, "netmask="IP_FMT, IP_ARGS(&netmask));
1906         if (router) {
1907             status_reply_put(sr, "router="IP_FMT, IP_ARGS(&router));
1908         }
1909
1910         for (i = 0; dhcp_msg_get_ip(cfg, DHCP_CODE_DNS_SERVER, i, &dns_server);
1911              i++) {
1912             status_reply_put(sr, "dns%d="IP_FMT, i, IP_ARGS(&dns_server));
1913         }
1914
1915         domain_name = dhcp_msg_get_string(cfg, DHCP_CODE_DOMAIN_NAME);
1916         if (domain_name) {
1917             status_reply_put(sr, "domain=%s", domain_name);
1918             free(domain_name);
1919         }
1920
1921         status_reply_put(sr, "lease-remaining=%u",
1922                          dhclient_get_lease_remaining(d->dhcp));
1923     }
1924 }
1925
1926 static struct discovery *
1927 discovery_init(const struct settings *s, struct switch_status *ss)
1928 {
1929     struct netdev *netdev;
1930     struct discovery *d;
1931     struct dhclient *dhcp;
1932     int retval;
1933
1934     /* Bring ofX network device up. */
1935     retval = netdev_open(s->of_name, NETDEV_ETH_TYPE_NONE, &netdev);
1936     if (retval) {
1937         ofp_fatal(retval, "Could not open %s device", s->of_name);
1938     }
1939     retval = netdev_turn_flags_on(netdev, NETDEV_UP, true);
1940     if (retval) {
1941         ofp_fatal(retval, "Could not bring %s device up", s->of_name);
1942     }
1943     netdev_close(netdev);
1944
1945     /* Initialize DHCP client. */
1946     retval = dhclient_create(s->of_name, modify_dhcp_request,
1947                              validate_dhcp_offer, (void *) s, &dhcp);
1948     if (retval) {
1949         ofp_fatal(retval, "Failed to initialize DHCP client");
1950     }
1951     dhclient_init(dhcp, 0);
1952
1953     d = xmalloc(sizeof *d);
1954     d->s = s;
1955     d->dhcp = dhcp;
1956     d->n_changes = 0;
1957
1958     switch_status_register_category(ss, "discovery", discovery_status_cb, d);
1959
1960     return d;
1961 }
1962
1963 static void
1964 discovery_question_connectivity(struct discovery *d)
1965 {
1966     dhclient_force_renew(d->dhcp, 15);
1967 }
1968
1969 static bool
1970 discovery_run(struct discovery *d, char **controller_name)
1971 {
1972     dhclient_run(d->dhcp);
1973     if (!dhclient_changed(d->dhcp)) {
1974         return false;
1975     }
1976
1977     dhclient_configure_netdev(d->dhcp);
1978     if (d->s->update_resolv_conf) {
1979         dhclient_update_resolv_conf(d->dhcp);
1980     }
1981
1982     if (dhclient_is_bound(d->dhcp)) {
1983         *controller_name = dhcp_msg_get_string(dhclient_get_config(d->dhcp),
1984                                                DHCP_CODE_OFP_CONTROLLER_VCONN);
1985         VLOG_WARN("%s: discovered controller", *controller_name);
1986         d->n_changes++;
1987     } else {
1988         *controller_name = NULL;
1989         if (d->n_changes) {
1990             VLOG_WARN("discovered controller no longer available");
1991             d->n_changes++;
1992         }
1993     }
1994     return true;
1995 }
1996
1997 static void
1998 discovery_wait(struct discovery *d)
1999 {
2000     dhclient_wait(d->dhcp);
2001 }
2002
2003 static void
2004 modify_dhcp_request(struct dhcp_msg *msg, void *aux)
2005 {
2006     dhcp_msg_put_string(msg, DHCP_CODE_VENDOR_CLASS, "OpenFlow");
2007 }
2008
2009 static bool
2010 validate_dhcp_offer(const struct dhcp_msg *msg, void *s_)
2011 {
2012     const struct settings *s = s_;
2013     char *vconn_name;
2014     bool accept;
2015
2016     vconn_name = dhcp_msg_get_string(msg, DHCP_CODE_OFP_CONTROLLER_VCONN);
2017     if (!vconn_name) {
2018         VLOG_WARN_RL(&vrl, "rejecting DHCP offer missing controller vconn");
2019         return false;
2020     }
2021     accept = !regexec(&s->accept_controller_regex, vconn_name, 0, NULL, 0);
2022     if (!accept) {
2023         VLOG_WARN_RL(&vrl, "rejecting controller vconn that fails to match %s",
2024                      s->accept_controller_re);
2025     }
2026     free(vconn_name);
2027     return accept;
2028 }
2029 \f
2030 /* User interface. */
2031
2032 static void
2033 parse_options(int argc, char *argv[], struct settings *s)
2034 {
2035     enum {
2036         OPT_ACCEPT_VCONN = UCHAR_MAX + 1,
2037         OPT_NO_RESOLV_CONF,
2038         OPT_INACTIVITY_PROBE,
2039         OPT_MAX_IDLE,
2040         OPT_MAX_BACKOFF,
2041         OPT_RATE_LIMIT,
2042         OPT_BURST_LIMIT,
2043         OPT_BOOTSTRAP_CA_CERT,
2044         OPT_NO_STP
2045     };
2046     static struct option long_options[] = {
2047         {"accept-vconn", required_argument, 0, OPT_ACCEPT_VCONN},
2048         {"no-resolv-conf", no_argument, 0, OPT_NO_RESOLV_CONF},
2049         {"fail",        required_argument, 0, 'F'},
2050         {"inactivity-probe", required_argument, 0, OPT_INACTIVITY_PROBE},
2051         {"max-idle",    required_argument, 0, OPT_MAX_IDLE},
2052         {"max-backoff", required_argument, 0, OPT_MAX_BACKOFF},
2053         {"listen",      required_argument, 0, 'l'},
2054         {"monitor",     required_argument, 0, 'm'},
2055         {"rate-limit",  optional_argument, 0, OPT_RATE_LIMIT},
2056         {"burst-limit", required_argument, 0, OPT_BURST_LIMIT},
2057         {"no-stp",      no_argument, 0, OPT_NO_STP},
2058         {"detach",      no_argument, 0, 'D'},
2059         {"force",       no_argument, 0, 'f'},
2060         {"pidfile",     optional_argument, 0, 'P'},
2061         {"verbose",     optional_argument, 0, 'v'},
2062         {"help",        no_argument, 0, 'h'},
2063         {"version",     no_argument, 0, 'V'},
2064 #ifdef HAVE_OPENSSL
2065         VCONN_SSL_LONG_OPTIONS
2066         {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT},
2067 #endif
2068         {0, 0, 0, 0},
2069     };
2070     char *short_options = long_options_to_short_options(long_options);
2071     char *accept_re = NULL;
2072     int retval;
2073
2074     /* Set defaults that we can figure out before parsing options. */
2075     s->n_listeners = 0;
2076     s->monitor_name = NULL;
2077     s->fail_mode = FAIL_OPEN;
2078     s->max_idle = 15;
2079     s->probe_interval = 15;
2080     s->max_backoff = 15;
2081     s->update_resolv_conf = true;
2082     s->rate_limit = 0;
2083     s->burst_limit = 0;
2084     s->enable_stp = true;
2085     for (;;) {
2086         int c;
2087
2088         c = getopt_long(argc, argv, short_options, long_options, NULL);
2089         if (c == -1) {
2090             break;
2091         }
2092
2093         switch (c) {
2094         case OPT_ACCEPT_VCONN:
2095             accept_re = optarg[0] == '^' ? optarg : xasprintf("^%s", optarg);
2096             break;
2097
2098         case OPT_NO_RESOLV_CONF:
2099             s->update_resolv_conf = false;
2100             break;
2101
2102         case 'F':
2103             if (!strcmp(optarg, "open")) {
2104                 s->fail_mode = FAIL_OPEN;
2105             } else if (!strcmp(optarg, "closed")) {
2106                 s->fail_mode = FAIL_CLOSED;
2107             } else {
2108                 ofp_fatal(0, "-f or --fail argument must be \"open\" "
2109                           "or \"closed\"");
2110             }
2111             break;
2112
2113         case OPT_INACTIVITY_PROBE:
2114             s->probe_interval = atoi(optarg);
2115             if (s->probe_interval < 5) {
2116                 ofp_fatal(0, "--inactivity-probe argument must be at least 5");
2117             }
2118             break;
2119
2120         case OPT_MAX_IDLE:
2121             if (!strcmp(optarg, "permanent")) {
2122                 s->max_idle = OFP_FLOW_PERMANENT;
2123             } else {
2124                 s->max_idle = atoi(optarg);
2125                 if (s->max_idle < 1 || s->max_idle > 65535) {
2126                     ofp_fatal(0, "--max-idle argument must be between 1 and "
2127                               "65535 or the word 'permanent'");
2128                 }
2129             }
2130             break;
2131
2132         case OPT_MAX_BACKOFF:
2133             s->max_backoff = atoi(optarg);
2134             if (s->max_backoff < 1) {
2135                 ofp_fatal(0, "--max-backoff argument must be at least 1");
2136             } else if (s->max_backoff > 3600) {
2137                 s->max_backoff = 3600;
2138             }
2139             break;
2140
2141         case OPT_RATE_LIMIT:
2142             if (optarg) {
2143                 s->rate_limit = atoi(optarg);
2144                 if (s->rate_limit < 1) {
2145                     ofp_fatal(0, "--rate-limit argument must be at least 1");
2146                 }
2147             } else {
2148                 s->rate_limit = 1000;
2149             }
2150             break;
2151
2152         case OPT_BURST_LIMIT:
2153             s->burst_limit = atoi(optarg);
2154             if (s->burst_limit < 1) {
2155                 ofp_fatal(0, "--burst-limit argument must be at least 1");
2156             }
2157             break;
2158
2159         case OPT_NO_STP:
2160             s->enable_stp = false;
2161             break;
2162
2163         case 'D':
2164             set_detach();
2165             break;
2166
2167         case 'P':
2168             set_pidfile(optarg);
2169             break;
2170
2171         case 'f':
2172             ignore_existing_pidfile();
2173             break;
2174
2175         case 'l':
2176             if (s->n_listeners >= MAX_MGMT) {
2177                 ofp_fatal(0,
2178                           "-l or --listen may be specified at most %d times",
2179                           MAX_MGMT);
2180             }
2181             s->listener_names[s->n_listeners++] = optarg;
2182             break;
2183
2184         case 'm':
2185             if (s->monitor_name) {
2186                 ofp_fatal(0, "-m or --monitor may only be specified once");
2187             }
2188             s->monitor_name = optarg;
2189             break;
2190
2191         case 'h':
2192             usage();
2193
2194         case 'V':
2195             printf("%s "VERSION" compiled "__DATE__" "__TIME__"\n", argv[0]);
2196             exit(EXIT_SUCCESS);
2197
2198         case 'v':
2199             vlog_set_verbosity(optarg);
2200             break;
2201
2202 #ifdef HAVE_OPENSSL
2203         VCONN_SSL_OPTION_HANDLERS
2204
2205         case OPT_BOOTSTRAP_CA_CERT:
2206             vconn_ssl_set_ca_cert_file(optarg, true);
2207             break;
2208 #endif
2209
2210         case '?':
2211             exit(EXIT_FAILURE);
2212
2213         default:
2214             abort();
2215         }
2216     }
2217     free(short_options);
2218
2219     argc -= optind;
2220     argv += optind;
2221     if (argc < 1 || argc > 2) {
2222         ofp_fatal(0, "need one or two non-option arguments; "
2223                   "use --help for usage");
2224     }
2225
2226     /* Local and remote vconns. */
2227     s->nl_name = argv[0];
2228     if (strncmp(s->nl_name, "nl:", 3)
2229         || strlen(s->nl_name) < 4
2230         || s->nl_name[strspn(s->nl_name + 3, "0123456789") + 3]) {
2231         ofp_fatal(0, "%s: argument is not of the form \"nl:DP_IDX\"",
2232                   s->nl_name);
2233     }
2234     s->of_name = xasprintf("of%s", s->nl_name + 3);
2235     s->controller_name = argc > 1 ? xstrdup(argv[1]) : NULL;
2236
2237     /* Set accept_controller_regex. */
2238     if (!accept_re) {
2239         accept_re = vconn_ssl_is_configured() ? "^ssl:.*" : ".*";
2240     }
2241     retval = regcomp(&s->accept_controller_regex, accept_re,
2242                      REG_NOSUB | REG_EXTENDED);
2243     if (retval) {
2244         size_t length = regerror(retval, &s->accept_controller_regex, NULL, 0);
2245         char *buffer = xmalloc(length);
2246         regerror(retval, &s->accept_controller_regex, buffer, length);
2247         ofp_fatal(0, "%s: %s", accept_re, buffer);
2248     }
2249     s->accept_controller_re = accept_re;
2250
2251     /* Mode of operation. */
2252     s->discovery = s->controller_name == NULL;
2253     if (s->discovery) {
2254         s->in_band = true;
2255     } else {
2256         enum netdev_flags flags;
2257         struct netdev *netdev;
2258
2259         retval = netdev_open(s->of_name, NETDEV_ETH_TYPE_NONE, &netdev);
2260         if (retval) {
2261             ofp_fatal(retval, "Could not open %s device", s->of_name);
2262         }
2263
2264         retval = netdev_get_flags(netdev, &flags);
2265         if (retval) {
2266             ofp_fatal(retval, "Could not get flags for %s device", s->of_name);
2267         }
2268
2269         s->in_band = (flags & NETDEV_UP) != 0;
2270         if (s->in_band && netdev_get_in6(netdev, NULL)) {
2271             VLOG_WARN("Ignoring IPv6 address on %s device: IPv6 not supported",
2272                       s->of_name);
2273         }
2274
2275         netdev_close(netdev);
2276     }
2277
2278     /* Rate limiting. */
2279     if (s->rate_limit) {
2280         if (s->rate_limit < 100) {
2281             VLOG_WARN("Rate limit set to unusually low value %d",
2282                       s->rate_limit);
2283         }
2284         if (!s->burst_limit) {
2285             s->burst_limit = s->rate_limit / 4;
2286         }
2287         s->burst_limit = MAX(s->burst_limit, 1);
2288         s->burst_limit = MIN(s->burst_limit, INT_MAX / 1000);
2289     }
2290 }
2291
2292 static void
2293 usage(void)
2294 {
2295     printf("%s: secure channel, a relay for OpenFlow messages.\n"
2296            "usage: %s [OPTIONS] nl:DP_IDX [CONTROLLER]\n"
2297            "where nl:DP_IDX is a datapath that has been added with dpctl.\n"
2298            "CONTROLLER is an active OpenFlow connection method; if it is\n"
2299            "omitted, then secchan performs controller discovery.\n",
2300            program_name, program_name);
2301     vconn_usage(true, true, true);
2302     printf("\nController discovery options:\n"
2303            "  --accept-vconn=REGEX    accept matching discovered controllers\n"
2304            "  --no-resolv-conf        do not update /etc/resolv.conf\n"
2305            "\nNetworking options:\n"
2306            "  -F, --fail=open|closed  when controller connection fails:\n"
2307            "                            closed: drop all packets\n"
2308            "                            open (default): act as learning switch\n"
2309            "  --inactivity-probe=SECS time between inactivity probes\n"
2310            "  --max-idle=SECS         max idle for flows set up by secchan\n"
2311            "  --max-backoff=SECS      max time between controller connection\n"
2312            "                          attempts (default: 15 seconds)\n"
2313            "  -l, --listen=METHOD     allow management connections on METHOD\n"
2314            "                          (a passive OpenFlow connection method)\n"
2315            "  -m, --monitor=METHOD    copy traffic to/from kernel to METHOD\n"
2316            "                          (a passive OpenFlow connection method)\n"
2317            "  --no-stp                disable 802.1D Spanning Tree Protocol\n"
2318            "\nRate-limiting of \"packet-in\" messages to the controller:\n"
2319            "  --rate-limit[=PACKETS]  max rate, in packets/s (default: 1000)\n"
2320            "  --burst-limit=BURST     limit on packet credit for idle time\n"
2321            "\nOther options:\n"
2322            "  -D, --detach            run in background as daemon\n"
2323            "  -P, --pidfile[=FILE]    create pidfile (default: %s/secchan.pid)\n"
2324            "  -f, --force             with -P, start even if already running\n"
2325            "  -v, --verbose=MODULE[:FACILITY[:LEVEL]]  set logging levels\n"
2326            "  -v, --verbose           set maximum verbosity level\n"
2327            "  -h, --help              display this help message\n"
2328            "  -V, --version           display version information\n",
2329            RUNDIR);
2330     exit(EXIT_SUCCESS);
2331 }