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