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