Merge "master" into "next".
[openvswitch] / vswitchd / bridge.c
1 /* Copyright (c) 2008, 2009, 2010 Nicira Networks
2  *
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15
16 #include <config.h>
17 #include "bridge.h"
18 #include <assert.h>
19 #include <errno.h>
20 #include <arpa/inet.h>
21 #include <ctype.h>
22 #include <inttypes.h>
23 #include <net/if.h>
24 #include <openflow/openflow.h>
25 #include <signal.h>
26 #include <stdlib.h>
27 #include <strings.h>
28 #include <sys/stat.h>
29 #include <sys/socket.h>
30 #include <sys/types.h>
31 #include <unistd.h>
32 #include "bitmap.h"
33 #include "coverage.h"
34 #include "dirs.h"
35 #include "dpif.h"
36 #include "dynamic-string.h"
37 #include "flow.h"
38 #include "hash.h"
39 #include "list.h"
40 #include "mac-learning.h"
41 #include "netdev.h"
42 #include "odp-util.h"
43 #include "ofp-print.h"
44 #include "ofpbuf.h"
45 #include "ofproto/netflow.h"
46 #include "ofproto/ofproto.h"
47 #include "packets.h"
48 #include "poll-loop.h"
49 #include "port-array.h"
50 #include "proc-net-compat.h"
51 #include "process.h"
52 #include "sha1.h"
53 #include "shash.h"
54 #include "socket-util.h"
55 #include "stream-ssl.h"
56 #include "svec.h"
57 #include "timeval.h"
58 #include "util.h"
59 #include "unixctl.h"
60 #include "vconn.h"
61 #include "vswitchd/vswitch-idl.h"
62 #include "xenserver.h"
63 #include "xtoxll.h"
64 #include "sflow_api.h"
65
66 #define THIS_MODULE VLM_bridge
67 #include "vlog.h"
68
69 struct dst {
70     uint16_t vlan;
71     uint16_t dp_ifidx;
72 };
73
74 struct iface {
75     /* These members are always valid. */
76     struct port *port;          /* Containing port. */
77     size_t port_ifidx;          /* Index within containing port. */
78     char *name;                 /* Host network device name. */
79     tag_type tag;               /* Tag associated with this interface. */
80     long long delay_expires;    /* Time after which 'enabled' may change. */
81
82     /* These members are valid only after bridge_reconfigure() causes them to
83      * be initialized.*/
84     int dp_ifidx;               /* Index within kernel datapath. */
85     struct netdev *netdev;      /* Network device. */
86     bool enabled;               /* May be chosen for flows? */
87
88     /* This member is only valid *during* bridge_reconfigure(). */
89     const struct ovsrec_interface *cfg;
90 };
91
92 #define BOND_MASK 0xff
93 struct bond_entry {
94     int iface_idx;              /* Index of assigned iface, or -1 if none. */
95     uint64_t tx_bytes;          /* Count of bytes recently transmitted. */
96     tag_type iface_tag;         /* Tag associated with iface_idx. */
97 };
98
99 #define MAX_MIRRORS 32
100 typedef uint32_t mirror_mask_t;
101 #define MIRROR_MASK_C(X) UINT32_C(X)
102 BUILD_ASSERT_DECL(sizeof(mirror_mask_t) * CHAR_BIT >= MAX_MIRRORS);
103 struct mirror {
104     struct bridge *bridge;
105     size_t idx;
106     char *name;
107
108     /* Selection criteria. */
109     struct shash src_ports;     /* Name is port name; data is always NULL. */
110     struct shash dst_ports;     /* Name is port name; data is always NULL. */
111     int *vlans;
112     size_t n_vlans;
113
114     /* Output. */
115     struct port *out_port;
116     int out_vlan;
117 };
118
119 #define FLOOD_PORT ((struct port *) 1) /* The 'flood' output port. */
120 struct port {
121     struct bridge *bridge;
122     size_t port_idx;
123     int vlan;                   /* -1=trunk port, else a 12-bit VLAN ID. */
124     unsigned long *trunks;      /* Bitmap of trunked VLANs, if 'vlan' == -1. */
125     char *name;
126
127     /* An ordinary bridge port has 1 interface.
128      * A bridge port for bonding has at least 2 interfaces. */
129     struct iface **ifaces;
130     size_t n_ifaces, allocated_ifaces;
131
132     /* Bonding info. */
133     struct bond_entry *bond_hash; /* An array of (BOND_MASK + 1) elements. */
134     int active_iface;           /* Ifidx on which bcasts accepted, or -1. */
135     tag_type active_iface_tag;  /* Tag for bcast flows. */
136     tag_type no_ifaces_tag;     /* Tag for flows when all ifaces disabled. */
137     int updelay, downdelay;     /* Delay before iface goes up/down, in ms. */
138     bool bond_compat_is_stale;  /* Need to call port_update_bond_compat()? */
139     bool bond_fake_iface;       /* Fake a bond interface for legacy compat? */
140
141     /* Port mirroring info. */
142     mirror_mask_t src_mirrors;  /* Mirrors triggered when packet received. */
143     mirror_mask_t dst_mirrors;  /* Mirrors triggered when packet sent. */
144     bool is_mirror_output_port; /* Does port mirroring send frames here? */
145
146     /* This member is only valid *during* bridge_reconfigure(). */
147     const struct ovsrec_port *cfg;
148 };
149
150 #define DP_MAX_PORTS 255
151 struct bridge {
152     struct list node;           /* Node in global list of bridges. */
153     char *name;                 /* User-specified arbitrary name. */
154     struct mac_learning *ml;    /* MAC learning table. */
155     bool sent_config_request;   /* Successfully sent config request? */
156     uint8_t default_ea[ETH_ADDR_LEN]; /* Default MAC. */
157
158     /* Support for remote controllers. */
159     char *controller;           /* NULL if there is no remote controller;
160                                  * "discover" to do controller discovery;
161                                  * otherwise a vconn name. */
162
163     /* OpenFlow switch processing. */
164     struct ofproto *ofproto;    /* OpenFlow switch. */
165
166     /* Kernel datapath information. */
167     struct dpif *dpif;          /* Datapath. */
168     struct port_array ifaces;   /* Indexed by kernel datapath port number. */
169
170     /* Bridge ports. */
171     struct port **ports;
172     size_t n_ports, allocated_ports;
173
174     /* Bonding. */
175     bool has_bonded_ports;
176     long long int bond_next_rebalance;
177
178     /* Flow tracking. */
179     bool flush;
180
181     /* Flow statistics gathering. */
182     time_t next_stats_request;
183
184     /* Port mirroring. */
185     struct mirror *mirrors[MAX_MIRRORS];
186
187     /* This member is only valid *during* bridge_reconfigure(). */
188     const struct ovsrec_bridge *cfg;
189 };
190
191 /* List of all bridges. */
192 static struct list all_bridges = LIST_INITIALIZER(&all_bridges);
193
194 /* Maximum number of datapaths. */
195 enum { DP_MAX = 256 };
196
197 static struct bridge *bridge_create(const struct ovsrec_bridge *br_cfg);
198 static void bridge_destroy(struct bridge *);
199 static struct bridge *bridge_lookup(const char *name);
200 static unixctl_cb_func bridge_unixctl_dump_flows;
201 static int bridge_run_one(struct bridge *);
202 static const struct ovsrec_controller *bridge_get_controller(
203                       const struct ovsrec_open_vswitch *ovs_cfg,
204                       const struct bridge *br);
205 static void bridge_reconfigure_one(const struct ovsrec_open_vswitch *,
206                                    struct bridge *);
207 static void bridge_reconfigure_controller(const struct ovsrec_open_vswitch *,
208                                           struct bridge *);
209 static void bridge_get_all_ifaces(const struct bridge *, struct shash *ifaces);
210 static void bridge_fetch_dp_ifaces(struct bridge *);
211 static void bridge_flush(struct bridge *);
212 static void bridge_pick_local_hw_addr(struct bridge *,
213                                       uint8_t ea[ETH_ADDR_LEN],
214                                       struct iface **hw_addr_iface);
215 static uint64_t bridge_pick_datapath_id(struct bridge *,
216                                         const uint8_t bridge_ea[ETH_ADDR_LEN],
217                                         struct iface *hw_addr_iface);
218 static struct iface *bridge_get_local_iface(struct bridge *);
219 static uint64_t dpid_from_hash(const void *, size_t nbytes);
220
221 static unixctl_cb_func bridge_unixctl_fdb_show;
222
223 static void bond_init(void);
224 static void bond_run(struct bridge *);
225 static void bond_wait(struct bridge *);
226 static void bond_rebalance_port(struct port *);
227 static void bond_send_learning_packets(struct port *);
228 static void bond_enable_slave(struct iface *iface, bool enable);
229
230 static struct port *port_create(struct bridge *, const char *name);
231 static void port_reconfigure(struct port *, const struct ovsrec_port *);
232 static void port_destroy(struct port *);
233 static struct port *port_lookup(const struct bridge *, const char *name);
234 static struct iface *port_lookup_iface(const struct port *, const char *name);
235 static struct port *port_from_dp_ifidx(const struct bridge *,
236                                        uint16_t dp_ifidx);
237 static void port_update_bond_compat(struct port *);
238 static void port_update_vlan_compat(struct port *);
239 static void port_update_bonding(struct port *);
240
241 static struct mirror *mirror_create(struct bridge *, const char *name);
242 static void mirror_destroy(struct mirror *);
243 static void mirror_reconfigure(struct bridge *);
244 static void mirror_reconfigure_one(struct mirror *, struct ovsrec_mirror *);
245 static bool vlan_is_mirrored(const struct mirror *, int vlan);
246
247 static struct iface *iface_create(struct port *port, 
248                                   const struct ovsrec_interface *if_cfg);
249 static void iface_destroy(struct iface *);
250 static struct iface *iface_lookup(const struct bridge *, const char *name);
251 static struct iface *iface_from_dp_ifidx(const struct bridge *,
252                                          uint16_t dp_ifidx);
253 static bool iface_is_internal(const struct bridge *, const char *name);
254 static void iface_set_mac(struct iface *);
255
256 /* Hooks into ofproto processing. */
257 static struct ofhooks bridge_ofhooks;
258 \f
259 /* Public functions. */
260
261 /* Adds the name of each interface used by a bridge, including local and
262  * internal ports, to 'svec'. */
263 void
264 bridge_get_ifaces(struct svec *svec) 
265 {
266     struct bridge *br, *next;
267     size_t i, j;
268
269     LIST_FOR_EACH_SAFE (br, next, struct bridge, node, &all_bridges) {
270         for (i = 0; i < br->n_ports; i++) {
271             struct port *port = br->ports[i];
272
273             for (j = 0; j < port->n_ifaces; j++) {
274                 struct iface *iface = port->ifaces[j];
275                 if (iface->dp_ifidx < 0) {
276                     VLOG_ERR("%s interface not in datapath %s, ignoring",
277                              iface->name, dpif_name(br->dpif));
278                 } else {
279                     if (iface->dp_ifidx != ODPP_LOCAL) {
280                         svec_add(svec, iface->name);
281                     }
282                 }
283             }
284         }
285     }
286 }
287
288 void
289 bridge_init(const struct ovsrec_open_vswitch *cfg)
290 {
291     struct svec bridge_names;
292     struct svec dpif_names, dpif_types;
293     size_t i;
294
295     unixctl_command_register("fdb/show", bridge_unixctl_fdb_show, NULL);
296
297     svec_init(&bridge_names);
298     for (i = 0; i < cfg->n_bridges; i++) {
299         svec_add(&bridge_names, cfg->bridges[i]->name);
300     }
301     svec_sort(&bridge_names);
302
303     svec_init(&dpif_names);
304     svec_init(&dpif_types);
305     dp_enumerate_types(&dpif_types);
306     for (i = 0; i < dpif_types.n; i++) {
307         struct dpif *dpif;
308         int retval;
309         size_t j;
310
311         dp_enumerate_names(dpif_types.names[i], &dpif_names);
312
313         for (j = 0; j < dpif_names.n; j++) {
314             retval = dpif_open(dpif_names.names[j], dpif_types.names[i], &dpif);
315             if (!retval) {
316                 struct svec all_names;
317                 size_t k;
318
319                 svec_init(&all_names);
320                 dpif_get_all_names(dpif, &all_names);
321                 for (k = 0; k < all_names.n; k++) {
322                     if (svec_contains(&bridge_names, all_names.names[k])) {
323                         goto found;
324                     }
325                 }
326                 dpif_delete(dpif);
327             found:
328                 svec_destroy(&all_names);
329                 dpif_close(dpif);
330             }
331         }
332     }
333     svec_destroy(&dpif_names);
334     svec_destroy(&dpif_types);
335
336     unixctl_command_register("bridge/dump-flows", bridge_unixctl_dump_flows,
337                              NULL);
338
339     bond_init();
340     bridge_reconfigure(cfg);
341 }
342
343 #ifdef HAVE_OPENSSL
344 static bool
345 config_string_change(const char *value, char **valuep)
346 {
347     if (value && (!*valuep || strcmp(value, *valuep))) {
348         free(*valuep);
349         *valuep = xstrdup(value);
350         return true;
351     } else {
352         return false;
353     }
354 }
355
356 static void
357 bridge_configure_ssl(const struct ovsrec_ssl *ssl)
358 {
359     /* XXX SSL should be configurable on a per-bridge basis.
360      * XXX should be possible to de-configure SSL. */
361     static char *private_key_file;
362     static char *certificate_file;
363     static char *cacert_file;
364     struct stat s;
365
366     if (!ssl) {
367         /* XXX We can't un-set SSL settings. */
368         return;
369     }
370
371     if (config_string_change(ssl->private_key, &private_key_file)) {
372         stream_ssl_set_private_key_file(private_key_file);
373     }
374
375     if (config_string_change(ssl->certificate, &certificate_file)) {
376         stream_ssl_set_certificate_file(certificate_file);
377     }
378
379     /* We assume that even if the filename hasn't changed, if the CA cert 
380      * file has been removed, that we want to move back into
381      * boot-strapping mode.  This opens a small security hole, because
382      * the old certificate will still be trusted until vSwitch is
383      * restarted.  We may want to address this in vconn's SSL library. */
384     if (config_string_change(ssl->ca_cert, &cacert_file)
385         || (cacert_file && stat(cacert_file, &s) && errno == ENOENT)) {
386         stream_ssl_set_ca_cert_file(cacert_file, ssl->bootstrap_ca_cert);
387     }
388 }
389 #endif
390
391 /* Attempt to create the network device 'iface_name' through the netdev
392  * library. */
393 static int
394 set_up_iface(const struct ovsrec_interface *iface_cfg, struct iface *iface,
395              bool create)
396 {
397     struct shash_node *node;
398     struct shash options;
399     int error = 0;
400     size_t i;
401
402     shash_init(&options);
403     for (i = 0; i < iface_cfg->n_options; i++) {
404         shash_add(&options, iface_cfg->key_options[i],
405                   xstrdup(iface_cfg->value_options[i]));
406     }
407
408     if (create) {
409         struct netdev_options netdev_options;
410
411         memset(&netdev_options, 0, sizeof netdev_options);
412         netdev_options.name = iface_cfg->name;
413         netdev_options.type = iface_cfg->type;
414         netdev_options.args = &options;
415         netdev_options.ethertype = NETDEV_ETH_TYPE_NONE;
416         netdev_options.may_create = true;
417         if (iface_is_internal(iface->port->bridge, iface_cfg->name)) {
418             netdev_options.may_open = true;
419         }
420
421         error = netdev_open(&netdev_options, &iface->netdev);
422
423         if (iface->netdev) {
424             netdev_get_carrier(iface->netdev, &iface->enabled);
425         }
426     } else if (iface->netdev) {
427         const char *netdev_type = netdev_get_type(iface->netdev);
428         const char *iface_type = iface_cfg->type && strlen(iface_cfg->type)
429                                   ? iface_cfg->type : NULL;
430
431         if (!iface_type || !strcmp(netdev_type, iface_type)) {
432             error = netdev_reconfigure(iface->netdev, &options);
433         } else {
434             VLOG_WARN("%s: attempting change device type from %s to %s",
435                       iface_cfg->name, netdev_type, iface_type);
436             error = EINVAL;
437         }
438     }
439
440     SHASH_FOR_EACH (node, &options) {
441         free(node->data);
442     }
443     shash_destroy(&options);
444
445     return error;
446 }
447
448 static int
449 reconfigure_iface(const struct ovsrec_interface *iface_cfg, struct iface *iface)
450 {
451     return set_up_iface(iface_cfg, iface, false);
452 }
453
454 static bool
455 check_iface_netdev(struct bridge *br OVS_UNUSED, struct iface *iface,
456                    void *aux OVS_UNUSED)
457 {
458     if (!iface->netdev) {
459         int error = set_up_iface(iface->cfg, iface, true);
460         if (error) {
461             VLOG_WARN("could not open netdev on %s, dropping: %s", iface->name,
462                                                                strerror(error));
463             return false;
464         }
465     }
466
467     return true;
468 }
469
470 static bool
471 check_iface_dp_ifidx(struct bridge *br, struct iface *iface,
472                      void *aux OVS_UNUSED)
473 {
474     if (iface->dp_ifidx >= 0) {
475         VLOG_DBG("%s has interface %s on port %d",
476                  dpif_name(br->dpif),
477                  iface->name, iface->dp_ifidx);
478         return true;
479     } else {
480         VLOG_ERR("%s interface not in %s, dropping",
481                  iface->name, dpif_name(br->dpif));
482         return false;
483     }
484 }
485
486 static bool
487 set_iface_properties(struct bridge *br OVS_UNUSED, struct iface *iface,
488                      void *aux OVS_UNUSED)
489 {
490     /* Set policing attributes. */
491     netdev_set_policing(iface->netdev,
492                         iface->cfg->ingress_policing_rate,
493                         iface->cfg->ingress_policing_burst);
494
495     /* Set MAC address of internal interfaces other than the local
496      * interface. */
497     if (iface->dp_ifidx != ODPP_LOCAL
498         && iface_is_internal(br, iface->name)) {
499         iface_set_mac(iface);
500     }
501
502     return true;
503 }
504
505 /* Calls 'cb' for each interfaces in 'br', passing along the 'aux' argument.
506  * Deletes from 'br' all the interfaces for which 'cb' returns false, and then
507  * deletes from 'br' any ports that no longer have any interfaces. */
508 static void
509 iterate_and_prune_ifaces(struct bridge *br,
510                          bool (*cb)(struct bridge *, struct iface *,
511                                     void *aux),
512                          void *aux)
513 {
514     size_t i, j;
515
516     for (i = 0; i < br->n_ports; ) {
517         struct port *port = br->ports[i];
518         for (j = 0; j < port->n_ifaces; ) {
519             struct iface *iface = port->ifaces[j];
520             if (cb(br, iface, aux)) {
521                 j++;
522             } else {
523                 iface_destroy(iface);
524             }
525         }
526
527         if (port->n_ifaces) {
528             i++;
529         } else  {
530             VLOG_ERR("%s port has no interfaces, dropping", port->name);
531             port_destroy(port);
532         }
533     }
534 }
535
536 void
537 bridge_reconfigure(const struct ovsrec_open_vswitch *ovs_cfg)
538 {
539     struct ovsdb_idl_txn *txn;
540     struct shash old_br, new_br;
541     struct shash_node *node;
542     struct bridge *br, *next;
543     size_t i;
544     int sflow_bridge_number;
545
546     COVERAGE_INC(bridge_reconfigure);
547
548     txn = ovsdb_idl_txn_create(ovs_cfg->header_.table->idl);
549
550     /* Collect old and new bridges. */
551     shash_init(&old_br);
552     shash_init(&new_br);
553     LIST_FOR_EACH (br, struct bridge, node, &all_bridges) {
554         shash_add(&old_br, br->name, br);
555     }
556     for (i = 0; i < ovs_cfg->n_bridges; i++) {
557         const struct ovsrec_bridge *br_cfg = ovs_cfg->bridges[i];
558         if (!shash_add_once(&new_br, br_cfg->name, br_cfg)) {
559             VLOG_WARN("more than one bridge named %s", br_cfg->name);
560         }
561     }
562
563     /* Get rid of deleted bridges and add new bridges. */
564     LIST_FOR_EACH_SAFE (br, next, struct bridge, node, &all_bridges) {
565         struct ovsrec_bridge *br_cfg = shash_find_data(&new_br, br->name);
566         if (br_cfg) {
567             br->cfg = br_cfg;
568         } else {
569             bridge_destroy(br);
570         }
571     }
572     SHASH_FOR_EACH (node, &new_br) {
573         const char *br_name = node->name;
574         const struct ovsrec_bridge *br_cfg = node->data;
575         br = shash_find_data(&old_br, br_name);
576         if (br) {
577             /* If the bridge datapath type has changed, we need to tear it
578              * down and recreate. */
579             if (strcmp(br->cfg->datapath_type, br_cfg->datapath_type)) {
580                 bridge_destroy(br);
581                 bridge_create(br_cfg);
582             }
583         } else {
584             bridge_create(br_cfg);
585         }
586     }
587     shash_destroy(&old_br);
588     shash_destroy(&new_br);
589
590 #ifdef HAVE_OPENSSL
591     /* Configure SSL. */
592     bridge_configure_ssl(ovs_cfg->ssl);
593 #endif
594
595     /* Reconfigure all bridges. */
596     LIST_FOR_EACH (br, struct bridge, node, &all_bridges) {
597         bridge_reconfigure_one(ovs_cfg, br);
598     }
599
600     /* Add and delete ports on all datapaths.
601      *
602      * The kernel will reject any attempt to add a given port to a datapath if
603      * that port already belongs to a different datapath, so we must do all
604      * port deletions before any port additions. */
605     LIST_FOR_EACH (br, struct bridge, node, &all_bridges) {
606         struct odp_port *dpif_ports;
607         size_t n_dpif_ports;
608         struct shash want_ifaces;
609
610         dpif_port_list(br->dpif, &dpif_ports, &n_dpif_ports);
611         bridge_get_all_ifaces(br, &want_ifaces);
612         for (i = 0; i < n_dpif_ports; i++) {
613             const struct odp_port *p = &dpif_ports[i];
614             if (!shash_find(&want_ifaces, p->devname)
615                 && strcmp(p->devname, br->name)) {
616                 int retval = dpif_port_del(br->dpif, p->port);
617                 if (retval) {
618                     VLOG_ERR("failed to remove %s interface from %s: %s",
619                              p->devname, dpif_name(br->dpif),
620                              strerror(retval));
621                 }
622             }
623         }
624         shash_destroy(&want_ifaces);
625         free(dpif_ports);
626     }
627     LIST_FOR_EACH (br, struct bridge, node, &all_bridges) {
628         struct odp_port *dpif_ports;
629         size_t n_dpif_ports;
630         struct shash cur_ifaces, want_ifaces;
631         struct shash_node *node;
632
633         /* Get the set of interfaces currently in this datapath. */
634         dpif_port_list(br->dpif, &dpif_ports, &n_dpif_ports);
635         shash_init(&cur_ifaces);
636         for (i = 0; i < n_dpif_ports; i++) {
637             const char *name = dpif_ports[i].devname;
638             if (!shash_find(&cur_ifaces, name)) {
639                 shash_add(&cur_ifaces, name, NULL);
640             }
641         }
642         free(dpif_ports);
643
644         /* Get the set of interfaces we want on this datapath. */
645         bridge_get_all_ifaces(br, &want_ifaces);
646
647         SHASH_FOR_EACH (node, &want_ifaces) {
648             const char *if_name = node->name;
649             struct iface *iface = node->data;
650
651             if (shash_find(&cur_ifaces, if_name)) {
652                 /* Already exists, just reconfigure it. */
653                 if (iface) {
654                     reconfigure_iface(iface->cfg, iface);
655                 }
656             } else {
657                 /* Need to add to datapath. */
658                 bool internal;
659                 int error;
660
661                 /* Add to datapath. */
662                 internal = iface_is_internal(br, if_name);
663                 error = dpif_port_add(br->dpif, if_name,
664                                       internal ? ODP_PORT_INTERNAL : 0, NULL);
665                 if (error == EFBIG) {
666                     VLOG_ERR("ran out of valid port numbers on %s",
667                              dpif_name(br->dpif));
668                     break;
669                 } else if (error) {
670                     VLOG_ERR("failed to add %s interface to %s: %s",
671                              if_name, dpif_name(br->dpif), strerror(error));
672                 }
673             }
674         }
675         shash_destroy(&cur_ifaces);
676         shash_destroy(&want_ifaces);
677     }
678     sflow_bridge_number = 0;
679     LIST_FOR_EACH (br, struct bridge, node, &all_bridges) {
680         uint8_t ea[8];
681         uint64_t dpid;
682         struct iface *local_iface;
683         struct iface *hw_addr_iface;
684         char *dpid_string;
685
686         bridge_fetch_dp_ifaces(br);
687
688         iterate_and_prune_ifaces(br, check_iface_netdev, NULL);
689         iterate_and_prune_ifaces(br, check_iface_dp_ifidx, NULL);
690
691         /* Pick local port hardware address, datapath ID. */
692         bridge_pick_local_hw_addr(br, ea, &hw_addr_iface);
693         local_iface = bridge_get_local_iface(br);
694         if (local_iface) {
695             int error = netdev_set_etheraddr(local_iface->netdev, ea);
696             if (error) {
697                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
698                 VLOG_ERR_RL(&rl, "bridge %s: failed to set bridge "
699                             "Ethernet address: %s",
700                             br->name, strerror(error));
701             }
702         }
703
704         dpid = bridge_pick_datapath_id(br, ea, hw_addr_iface);
705         ofproto_set_datapath_id(br->ofproto, dpid);
706
707         dpid_string = xasprintf("%012"PRIx64, dpid);
708         ovsrec_bridge_set_datapath_id(br->cfg, dpid_string);
709         free(dpid_string);
710
711         /* Set NetFlow configuration on this bridge. */
712         if (br->cfg->netflow) {
713             struct ovsrec_netflow *nf_cfg = br->cfg->netflow;
714             struct netflow_options opts;
715
716             memset(&opts, 0, sizeof opts);
717
718             dpif_get_netflow_ids(br->dpif, &opts.engine_type, &opts.engine_id);
719             if (nf_cfg->engine_type) {
720                 opts.engine_type = *nf_cfg->engine_type;
721             }
722             if (nf_cfg->engine_id) {
723                 opts.engine_id = *nf_cfg->engine_id;
724             }
725
726             opts.active_timeout = nf_cfg->active_timeout;
727             if (!opts.active_timeout) {
728                 opts.active_timeout = -1;
729             } else if (opts.active_timeout < 0) {
730                 VLOG_WARN("bridge %s: active timeout interval set to negative "
731                           "value, using default instead (%d seconds)", br->name,
732                           NF_ACTIVE_TIMEOUT_DEFAULT);
733                 opts.active_timeout = -1;
734             }
735
736             opts.add_id_to_iface = nf_cfg->add_id_to_interface;
737             if (opts.add_id_to_iface) {
738                 if (opts.engine_id > 0x7f) {
739                     VLOG_WARN("bridge %s: netflow port mangling may conflict "
740                               "with another vswitch, choose an engine id less "
741                               "than 128", br->name);
742                 }
743                 if (br->n_ports > 508) {
744                     VLOG_WARN("bridge %s: netflow port mangling will conflict "
745                               "with another port when more than 508 ports are "
746                               "used", br->name);
747                 }
748             }
749
750             opts.collectors.n = nf_cfg->n_targets;
751             opts.collectors.names = nf_cfg->targets;
752             if (ofproto_set_netflow(br->ofproto, &opts)) {
753                 VLOG_ERR("bridge %s: problem setting netflow collectors", 
754                          br->name);
755             }
756         } else {
757             ofproto_set_netflow(br->ofproto, NULL);
758         }
759
760         /* Set sFlow configuration on this bridge. */
761         if (br->cfg->sflow) {
762             const struct ovsrec_sflow *sflow_cfg = br->cfg->sflow;
763             const struct ovsrec_controller *ctrl;
764             struct ofproto_sflow_options oso;
765
766             memset(&oso, 0, sizeof oso);
767
768             oso.targets.n = sflow_cfg->n_targets;
769             oso.targets.names = sflow_cfg->targets;
770
771             oso.sampling_rate = SFL_DEFAULT_SAMPLING_RATE;
772             if (sflow_cfg->sampling) {
773                 oso.sampling_rate = *sflow_cfg->sampling;
774             }
775
776             oso.polling_interval = SFL_DEFAULT_POLLING_INTERVAL;
777             if (sflow_cfg->polling) {
778                 oso.polling_interval = *sflow_cfg->polling;
779             }
780
781             oso.header_len = SFL_DEFAULT_HEADER_SIZE;
782             if (sflow_cfg->header) {
783                 oso.header_len = *sflow_cfg->header;
784             }
785
786             oso.sub_id = sflow_bridge_number++;
787             oso.agent_device = sflow_cfg->agent;
788
789             ctrl = bridge_get_controller(ovs_cfg, br);
790             oso.control_ip = ctrl ? ctrl->local_ip : NULL;
791             ofproto_set_sflow(br->ofproto, &oso);
792
793             svec_destroy(&oso.targets);
794         } else {
795             ofproto_set_sflow(br->ofproto, NULL);
796         }
797
798         /* Update the controller and related settings.  It would be more
799          * straightforward to call this from bridge_reconfigure_one(), but we
800          * can't do it there for two reasons.  First, and most importantly, at
801          * that point we don't know the dp_ifidx of any interfaces that have
802          * been added to the bridge (because we haven't actually added them to
803          * the datapath).  Second, at that point we haven't set the datapath ID
804          * yet; when a controller is configured, resetting the datapath ID will
805          * immediately disconnect from the controller, so it's better to set
806          * the datapath ID before the controller. */
807         bridge_reconfigure_controller(ovs_cfg, br);
808     }
809     LIST_FOR_EACH (br, struct bridge, node, &all_bridges) {
810         for (i = 0; i < br->n_ports; i++) {
811             struct port *port = br->ports[i];
812
813             port_update_vlan_compat(port);
814             port_update_bonding(port);
815         }
816     }
817     LIST_FOR_EACH (br, struct bridge, node, &all_bridges) {
818         iterate_and_prune_ifaces(br, set_iface_properties, NULL);
819     }
820
821     ovsrec_open_vswitch_set_cur_cfg(ovs_cfg, ovs_cfg->next_cfg);
822
823     ovsdb_idl_txn_commit(txn);
824     ovsdb_idl_txn_destroy(txn); /* XXX */
825 }
826
827 static const char *
828 bridge_get_other_config(const struct ovsrec_bridge *br_cfg, const char *key)
829 {
830     size_t i;
831
832     for (i = 0; i < br_cfg->n_other_config; i++) {
833         if (!strcmp(br_cfg->key_other_config[i], key)) {
834             return br_cfg->value_other_config[i];
835         }
836     }
837     return NULL;
838 }
839
840 static void
841 bridge_pick_local_hw_addr(struct bridge *br, uint8_t ea[ETH_ADDR_LEN],
842                           struct iface **hw_addr_iface)
843 {
844     const char *hwaddr;
845     size_t i, j;
846     int error;
847
848     *hw_addr_iface = NULL;
849
850     /* Did the user request a particular MAC? */
851     hwaddr = bridge_get_other_config(br->cfg, "hwaddr");
852     if (hwaddr && eth_addr_from_string(hwaddr, ea)) {
853         if (eth_addr_is_multicast(ea)) {
854             VLOG_ERR("bridge %s: cannot set MAC address to multicast "
855                      "address "ETH_ADDR_FMT, br->name, ETH_ADDR_ARGS(ea));
856         } else if (eth_addr_is_zero(ea)) {
857             VLOG_ERR("bridge %s: cannot set MAC address to zero", br->name);
858         } else {
859             return;
860         }
861     }
862
863     /* Otherwise choose the minimum non-local MAC address among all of the
864      * interfaces. */
865     memset(ea, 0xff, sizeof ea);
866     for (i = 0; i < br->n_ports; i++) {
867         struct port *port = br->ports[i];
868         uint8_t iface_ea[ETH_ADDR_LEN];
869         struct iface *iface;
870
871         /* Mirror output ports don't participate. */
872         if (port->is_mirror_output_port) {
873             continue;
874         }
875
876         /* Choose the MAC address to represent the port. */
877         if (port->cfg->mac && eth_addr_from_string(port->cfg->mac, iface_ea)) {
878             /* Find the interface with this Ethernet address (if any) so that
879              * we can provide the correct devname to the caller. */
880             iface = NULL;
881             for (j = 0; j < port->n_ifaces; j++) {
882                 struct iface *candidate = port->ifaces[j];
883                 uint8_t candidate_ea[ETH_ADDR_LEN];
884                 if (!netdev_get_etheraddr(candidate->netdev, candidate_ea)
885                     && eth_addr_equals(iface_ea, candidate_ea)) {
886                     iface = candidate;
887                 }
888             }
889         } else {
890             /* Choose the interface whose MAC address will represent the port.
891              * The Linux kernel bonding code always chooses the MAC address of
892              * the first slave added to a bond, and the Fedora networking
893              * scripts always add slaves to a bond in alphabetical order, so
894              * for compatibility we choose the interface with the name that is
895              * first in alphabetical order. */
896             iface = port->ifaces[0];
897             for (j = 1; j < port->n_ifaces; j++) {
898                 struct iface *candidate = port->ifaces[j];
899                 if (strcmp(candidate->name, iface->name) < 0) {
900                     iface = candidate;
901                 }
902             }
903
904             /* The local port doesn't count (since we're trying to choose its
905              * MAC address anyway). */
906             if (iface->dp_ifidx == ODPP_LOCAL) {
907                 continue;
908             }
909
910             /* Grab MAC. */
911             error = netdev_get_etheraddr(iface->netdev, iface_ea);
912             if (error) {
913                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
914                 VLOG_ERR_RL(&rl, "failed to obtain Ethernet address of %s: %s",
915                             iface->name, strerror(error));
916                 continue;
917             }
918         }
919
920         /* Compare against our current choice. */
921         if (!eth_addr_is_multicast(iface_ea) &&
922             !eth_addr_is_local(iface_ea) &&
923             !eth_addr_is_reserved(iface_ea) &&
924             !eth_addr_is_zero(iface_ea) &&
925             memcmp(iface_ea, ea, ETH_ADDR_LEN) < 0)
926         {
927             memcpy(ea, iface_ea, ETH_ADDR_LEN);
928             *hw_addr_iface = iface;
929         }
930     }
931     if (eth_addr_is_multicast(ea)) {
932         memcpy(ea, br->default_ea, ETH_ADDR_LEN);
933         *hw_addr_iface = NULL;
934         VLOG_WARN("bridge %s: using default bridge Ethernet "
935                   "address "ETH_ADDR_FMT, br->name, ETH_ADDR_ARGS(ea));
936     } else {
937         VLOG_DBG("bridge %s: using bridge Ethernet address "ETH_ADDR_FMT,
938                  br->name, ETH_ADDR_ARGS(ea));
939     }
940 }
941
942 /* Choose and returns the datapath ID for bridge 'br' given that the bridge
943  * Ethernet address is 'bridge_ea'.  If 'bridge_ea' is the Ethernet address of
944  * an interface on 'br', then that interface must be passed in as
945  * 'hw_addr_iface'; if 'bridge_ea' was derived some other way, then
946  * 'hw_addr_iface' must be passed in as a null pointer. */
947 static uint64_t
948 bridge_pick_datapath_id(struct bridge *br,
949                         const uint8_t bridge_ea[ETH_ADDR_LEN],
950                         struct iface *hw_addr_iface)
951 {
952     /*
953      * The procedure for choosing a bridge MAC address will, in the most
954      * ordinary case, also choose a unique MAC that we can use as a datapath
955      * ID.  In some special cases, though, multiple bridges will end up with
956      * the same MAC address.  This is OK for the bridges, but it will confuse
957      * the OpenFlow controller, because each datapath needs a unique datapath
958      * ID.
959      *
960      * Datapath IDs must be unique.  It is also very desirable that they be
961      * stable from one run to the next, so that policy set on a datapath
962      * "sticks".
963      */
964     const char *datapath_id;
965     uint64_t dpid;
966
967     datapath_id = bridge_get_other_config(br->cfg, "datapath-id");
968     if (datapath_id && dpid_from_string(datapath_id, &dpid)) {
969         return dpid;
970     }
971
972     if (hw_addr_iface) {
973         int vlan;
974         if (!netdev_get_vlan_vid(hw_addr_iface->netdev, &vlan)) {
975             /*
976              * A bridge whose MAC address is taken from a VLAN network device
977              * (that is, a network device created with vconfig(8) or similar
978              * tool) will have the same MAC address as a bridge on the VLAN
979              * device's physical network device.
980              *
981              * Handle this case by hashing the physical network device MAC
982              * along with the VLAN identifier.
983              */
984             uint8_t buf[ETH_ADDR_LEN + 2];
985             memcpy(buf, bridge_ea, ETH_ADDR_LEN);
986             buf[ETH_ADDR_LEN] = vlan >> 8;
987             buf[ETH_ADDR_LEN + 1] = vlan;
988             return dpid_from_hash(buf, sizeof buf);
989         } else {
990             /*
991              * Assume that this bridge's MAC address is unique, since it
992              * doesn't fit any of the cases we handle specially.
993              */
994         }
995     } else {
996         /*
997          * A purely internal bridge, that is, one that has no non-virtual
998          * network devices on it at all, is more difficult because it has no
999          * natural unique identifier at all.
1000          *
1001          * When the host is a XenServer, we handle this case by hashing the
1002          * host's UUID with the name of the bridge.  Names of bridges are
1003          * persistent across XenServer reboots, although they can be reused if
1004          * an internal network is destroyed and then a new one is later
1005          * created, so this is fairly effective.
1006          *
1007          * When the host is not a XenServer, we punt by using a random MAC
1008          * address on each run.
1009          */
1010         const char *host_uuid = xenserver_get_host_uuid();
1011         if (host_uuid) {
1012             char *combined = xasprintf("%s,%s", host_uuid, br->name);
1013             dpid = dpid_from_hash(combined, strlen(combined));
1014             free(combined);
1015             return dpid;
1016         }
1017     }
1018
1019     return eth_addr_to_uint64(bridge_ea);
1020 }
1021
1022 static uint64_t
1023 dpid_from_hash(const void *data, size_t n)
1024 {
1025     uint8_t hash[SHA1_DIGEST_SIZE];
1026
1027     BUILD_ASSERT_DECL(sizeof hash >= ETH_ADDR_LEN);
1028     sha1_bytes(data, n, hash);
1029     eth_addr_mark_random(hash);
1030     return eth_addr_to_uint64(hash);
1031 }
1032
1033 int
1034 bridge_run(void)
1035 {
1036     struct bridge *br, *next;
1037     int retval;
1038
1039     retval = 0;
1040     LIST_FOR_EACH_SAFE (br, next, struct bridge, node, &all_bridges) {
1041         int error = bridge_run_one(br);
1042         if (error) {
1043             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1044             VLOG_ERR_RL(&rl, "bridge %s: datapath was destroyed externally, "
1045                         "forcing reconfiguration", br->name);
1046             if (!retval) {
1047                 retval = error;
1048             }
1049         }
1050     }
1051     return retval;
1052 }
1053
1054 void
1055 bridge_wait(void)
1056 {
1057     struct bridge *br;
1058
1059     LIST_FOR_EACH (br, struct bridge, node, &all_bridges) {
1060         ofproto_wait(br->ofproto);
1061         if (br->controller) {
1062             continue;
1063         }
1064
1065         mac_learning_wait(br->ml);
1066         bond_wait(br);
1067     }
1068 }
1069
1070 /* Forces 'br' to revalidate all of its flows.  This is appropriate when 'br''s
1071  * configuration changes.  */
1072 static void
1073 bridge_flush(struct bridge *br)
1074 {
1075     COVERAGE_INC(bridge_flush);
1076     br->flush = true;
1077     mac_learning_flush(br->ml);
1078 }
1079
1080 /* Returns the 'br' interface for the ODPP_LOCAL port, or null if 'br' has no
1081  * such interface. */
1082 static struct iface *
1083 bridge_get_local_iface(struct bridge *br)
1084 {
1085     size_t i, j;
1086
1087     for (i = 0; i < br->n_ports; i++) {
1088         struct port *port = br->ports[i];
1089         for (j = 0; j < port->n_ifaces; j++) {
1090             struct iface *iface = port->ifaces[j];
1091             if (iface->dp_ifidx == ODPP_LOCAL) {
1092                 return iface;
1093             }
1094         }
1095     }
1096
1097     return NULL;
1098 }
1099 \f
1100 /* Bridge unixctl user interface functions. */
1101 static void
1102 bridge_unixctl_fdb_show(struct unixctl_conn *conn,
1103                         const char *args, void *aux OVS_UNUSED)
1104 {
1105     struct ds ds = DS_EMPTY_INITIALIZER;
1106     const struct bridge *br;
1107     const struct mac_entry *e;
1108
1109     br = bridge_lookup(args);
1110     if (!br) {
1111         unixctl_command_reply(conn, 501, "no such bridge");
1112         return;
1113     }
1114
1115     ds_put_cstr(&ds, " port  VLAN  MAC                Age\n");
1116     LIST_FOR_EACH (e, struct mac_entry, lru_node, &br->ml->lrus) {
1117         if (e->port < 0 || e->port >= br->n_ports) {
1118             continue;
1119         }
1120         ds_put_format(&ds, "%5d  %4d  "ETH_ADDR_FMT"  %3d\n",
1121                       br->ports[e->port]->ifaces[0]->dp_ifidx,
1122                       e->vlan, ETH_ADDR_ARGS(e->mac), mac_entry_age(e));
1123     }
1124     unixctl_command_reply(conn, 200, ds_cstr(&ds));
1125     ds_destroy(&ds);
1126 }
1127 \f
1128 /* Bridge reconfiguration functions. */
1129 static struct bridge *
1130 bridge_create(const struct ovsrec_bridge *br_cfg)
1131 {
1132     struct bridge *br;
1133     int error;
1134
1135     assert(!bridge_lookup(br_cfg->name));
1136     br = xzalloc(sizeof *br);
1137
1138     error = dpif_create_and_open(br_cfg->name, br_cfg->datapath_type,
1139                                  &br->dpif);
1140     if (error) {
1141         free(br);
1142         return NULL;
1143     }
1144     dpif_flow_flush(br->dpif);
1145
1146     error = ofproto_create(br_cfg->name, br_cfg->datapath_type, &bridge_ofhooks,
1147                            br, &br->ofproto);
1148     if (error) {
1149         VLOG_ERR("failed to create switch %s: %s", br_cfg->name,
1150                  strerror(error));
1151         dpif_delete(br->dpif);
1152         dpif_close(br->dpif);
1153         free(br);
1154         return NULL;
1155     }
1156
1157     br->name = xstrdup(br_cfg->name);
1158     br->cfg = br_cfg;
1159     br->ml = mac_learning_create();
1160     br->sent_config_request = false;
1161     eth_addr_nicira_random(br->default_ea);
1162
1163     port_array_init(&br->ifaces);
1164
1165     br->flush = false;
1166     br->bond_next_rebalance = time_msec() + 10000;
1167
1168     list_push_back(&all_bridges, &br->node);
1169
1170     VLOG_INFO("created bridge %s on %s", br->name, dpif_name(br->dpif));
1171
1172     return br;
1173 }
1174
1175 static void
1176 bridge_destroy(struct bridge *br)
1177 {
1178     if (br) {
1179         int error;
1180
1181         while (br->n_ports > 0) {
1182             port_destroy(br->ports[br->n_ports - 1]);
1183         }
1184         list_remove(&br->node);
1185         error = dpif_delete(br->dpif);
1186         if (error && error != ENOENT) {
1187             VLOG_ERR("failed to delete %s: %s",
1188                      dpif_name(br->dpif), strerror(error));
1189         }
1190         dpif_close(br->dpif);
1191         ofproto_destroy(br->ofproto);
1192         free(br->controller);
1193         mac_learning_destroy(br->ml);
1194         port_array_destroy(&br->ifaces);
1195         free(br->ports);
1196         free(br->name);
1197         free(br);
1198     }
1199 }
1200
1201 static struct bridge *
1202 bridge_lookup(const char *name)
1203 {
1204     struct bridge *br;
1205
1206     LIST_FOR_EACH (br, struct bridge, node, &all_bridges) {
1207         if (!strcmp(br->name, name)) {
1208             return br;
1209         }
1210     }
1211     return NULL;
1212 }
1213
1214 bool
1215 bridge_exists(const char *name)
1216 {
1217     return bridge_lookup(name) ? true : false;
1218 }
1219
1220 uint64_t
1221 bridge_get_datapathid(const char *name)
1222 {
1223     struct bridge *br = bridge_lookup(name);
1224     return br ? ofproto_get_datapath_id(br->ofproto) : 0;
1225 }
1226
1227 /* Handle requests for a listing of all flows known by the OpenFlow
1228  * stack, including those normally hidden. */
1229 static void
1230 bridge_unixctl_dump_flows(struct unixctl_conn *conn,
1231                           const char *args, void *aux OVS_UNUSED)
1232 {
1233     struct bridge *br;
1234     struct ds results;
1235     
1236     br = bridge_lookup(args);
1237     if (!br) {
1238         unixctl_command_reply(conn, 501, "Unknown bridge");
1239         return;
1240     }
1241
1242     ds_init(&results);
1243     ofproto_get_all_flows(br->ofproto, &results);
1244
1245     unixctl_command_reply(conn, 200, ds_cstr(&results));
1246     ds_destroy(&results);
1247 }
1248
1249 static int
1250 bridge_run_one(struct bridge *br)
1251 {
1252     int error;
1253
1254     error = ofproto_run1(br->ofproto);
1255     if (error) {
1256         return error;
1257     }
1258
1259     mac_learning_run(br->ml, ofproto_get_revalidate_set(br->ofproto));
1260     bond_run(br);
1261
1262     error = ofproto_run2(br->ofproto, br->flush);
1263     br->flush = false;
1264
1265     return error;
1266 }
1267
1268 static const struct ovsrec_controller *
1269 bridge_get_controller(const struct ovsrec_open_vswitch *ovs_cfg,
1270                       const struct bridge *br)
1271 {
1272     const struct ovsrec_controller *controller;
1273
1274     controller = (br->cfg->controller ? br->cfg->controller
1275                   : ovs_cfg->controller ? ovs_cfg->controller
1276                   : NULL);
1277
1278     if (controller && !strcmp(controller->target, "none")) {
1279         return NULL;
1280     }
1281
1282     return controller;
1283 }
1284
1285 static bool
1286 check_duplicate_ifaces(struct bridge *br, struct iface *iface, void *ifaces_)
1287 {
1288     struct svec *ifaces = ifaces_;
1289     if (!svec_contains(ifaces, iface->name)) {
1290         svec_add(ifaces, iface->name);
1291         svec_sort(ifaces);
1292         return true;
1293     } else {
1294         VLOG_ERR("bridge %s: %s interface is on multiple ports, "
1295                  "removing from %s",
1296                  br->name, iface->name, iface->port->name);
1297         return false;
1298     }
1299 }
1300
1301 static void
1302 bridge_reconfigure_one(const struct ovsrec_open_vswitch *ovs_cfg,
1303                        struct bridge *br)
1304 {
1305     struct shash old_ports, new_ports;
1306     struct svec ifaces;
1307     struct svec listeners, old_listeners;
1308     struct svec snoops, old_snoops;
1309     struct shash_node *node;
1310     size_t i;
1311
1312     /* Collect old ports. */
1313     shash_init(&old_ports);
1314     for (i = 0; i < br->n_ports; i++) {
1315         shash_add(&old_ports, br->ports[i]->name, br->ports[i]);
1316     }
1317
1318     /* Collect new ports. */
1319     shash_init(&new_ports);
1320     for (i = 0; i < br->cfg->n_ports; i++) {
1321         const char *name = br->cfg->ports[i]->name;
1322         if (!shash_add_once(&new_ports, name, br->cfg->ports[i])) {
1323             VLOG_WARN("bridge %s: %s specified twice as bridge port",
1324                       br->name, name);
1325         }
1326     }
1327
1328     /* If we have a controller, then we need a local port.  Complain if the
1329      * user didn't specify one.
1330      *
1331      * XXX perhaps we should synthesize a port ourselves in this case. */
1332     if (bridge_get_controller(ovs_cfg, br)) {
1333         char local_name[IF_NAMESIZE];
1334         int error;
1335
1336         error = dpif_port_get_name(br->dpif, ODPP_LOCAL,
1337                                    local_name, sizeof local_name);
1338         if (!error && !shash_find(&new_ports, local_name)) {
1339             VLOG_WARN("bridge %s: controller specified but no local port "
1340                       "(port named %s) defined",
1341                       br->name, local_name);
1342         }
1343     }
1344
1345     /* Get rid of deleted ports and add new ports. */
1346     SHASH_FOR_EACH (node, &old_ports) {
1347         if (!shash_find(&new_ports, node->name)) {
1348             port_destroy(node->data);
1349         }
1350     }
1351     SHASH_FOR_EACH (node, &new_ports) {
1352         struct port *port = shash_find_data(&old_ports, node->name);
1353         if (!port) {
1354             port = port_create(br, node->name);
1355         }
1356         port_reconfigure(port, node->data);
1357     }
1358     shash_destroy(&old_ports);
1359     shash_destroy(&new_ports);
1360
1361     /* Check and delete duplicate interfaces. */
1362     svec_init(&ifaces);
1363     iterate_and_prune_ifaces(br, check_duplicate_ifaces, &ifaces);
1364     svec_destroy(&ifaces);
1365
1366     /* Delete all flows if we're switching from connected to standalone or vice
1367      * versa.  (XXX Should we delete all flows if we are switching from one
1368      * controller to another?) */
1369
1370 #if 0
1371     /* Configure OpenFlow management listeners. */
1372     svec_init(&listeners);
1373     cfg_get_all_strings(&listeners, "bridge.%s.openflow.listeners", br->name);
1374     if (!listeners.n) {
1375         svec_add_nocopy(&listeners, xasprintf("punix:%s/%s.mgmt",
1376                                               ovs_rundir, br->name));
1377     } else if (listeners.n == 1 && !strcmp(listeners.names[0], "none")) {
1378         svec_clear(&listeners);
1379     }
1380     svec_sort_unique(&listeners);
1381
1382     svec_init(&old_listeners);
1383     ofproto_get_listeners(br->ofproto, &old_listeners);
1384     svec_sort_unique(&old_listeners);
1385
1386     if (!svec_equal(&listeners, &old_listeners)) {
1387         ofproto_set_listeners(br->ofproto, &listeners);
1388     }
1389     svec_destroy(&listeners);
1390     svec_destroy(&old_listeners);
1391
1392     /* Configure OpenFlow controller connection snooping. */
1393     svec_init(&snoops);
1394     cfg_get_all_strings(&snoops, "bridge.%s.openflow.snoops", br->name);
1395     if (!snoops.n) {
1396         svec_add_nocopy(&snoops, xasprintf("punix:%s/%s.snoop",
1397                                            ovs_rundir, br->name));
1398     } else if (snoops.n == 1 && !strcmp(snoops.names[0], "none")) {
1399         svec_clear(&snoops);
1400     }
1401     svec_sort_unique(&snoops);
1402
1403     svec_init(&old_snoops);
1404     ofproto_get_snoops(br->ofproto, &old_snoops);
1405     svec_sort_unique(&old_snoops);
1406
1407     if (!svec_equal(&snoops, &old_snoops)) {
1408         ofproto_set_snoops(br->ofproto, &snoops);
1409     }
1410     svec_destroy(&snoops);
1411     svec_destroy(&old_snoops);
1412 #else
1413     /* Default listener. */
1414     svec_init(&listeners);
1415     svec_add_nocopy(&listeners, xasprintf("punix:%s/%s.mgmt",
1416                                           ovs_rundir, br->name));
1417     svec_init(&old_listeners);
1418     ofproto_get_listeners(br->ofproto, &old_listeners);
1419     if (!svec_equal(&listeners, &old_listeners)) {
1420         ofproto_set_listeners(br->ofproto, &listeners);
1421     }
1422     svec_destroy(&listeners);
1423     svec_destroy(&old_listeners);
1424
1425     /* Default snoop. */
1426     svec_init(&snoops);
1427     svec_add_nocopy(&snoops, xasprintf("punix:%s/%s.snoop",
1428                                        ovs_rundir, br->name));
1429     svec_init(&old_snoops);
1430     ofproto_get_snoops(br->ofproto, &old_snoops);
1431     if (!svec_equal(&snoops, &old_snoops)) {
1432         ofproto_set_snoops(br->ofproto, &snoops);
1433     }
1434     svec_destroy(&snoops);
1435     svec_destroy(&old_snoops);
1436 #endif
1437
1438     mirror_reconfigure(br);
1439 }
1440
1441 static void
1442 bridge_reconfigure_controller(const struct ovsrec_open_vswitch *ovs_cfg,
1443                               struct bridge *br)
1444 {
1445     char *pfx = xasprintf("bridge.%s.controller", br->name);
1446     const struct ovsrec_controller *c;
1447
1448     c = bridge_get_controller(ovs_cfg, br);
1449     if ((br->controller != NULL) != (c != NULL)) {
1450         ofproto_flush_flows(br->ofproto);
1451     }
1452     free(br->controller);
1453     br->controller = c ? xstrdup(c->target) : NULL;
1454
1455     if (c) {
1456         int max_backoff, probe;
1457         int rate_limit, burst_limit;
1458
1459         if (!strcmp(c->target, "discover")) {
1460             ofproto_set_discovery(br->ofproto, true,
1461                                   c->discover_accept_regex,
1462                                   c->discover_update_resolv_conf);
1463         } else {
1464             struct iface *local_iface;
1465             struct in_addr ip;
1466             bool in_band;
1467
1468             in_band = (!c->connection_mode
1469                        || !strcmp(c->connection_mode, "out-of-band"));
1470             ofproto_set_discovery(br->ofproto, false, NULL, NULL);
1471             ofproto_set_in_band(br->ofproto, in_band);
1472
1473             local_iface = bridge_get_local_iface(br);
1474             if (local_iface && c->local_ip && inet_aton(c->local_ip, &ip)) {
1475                 struct netdev *netdev = local_iface->netdev;
1476                 struct in_addr mask, gateway;
1477
1478                 if (!c->local_netmask || !inet_aton(c->local_netmask, &mask)) {
1479                     mask.s_addr = 0;
1480                 }
1481                 if (!c->local_gateway
1482                     || !inet_aton(c->local_gateway, &gateway)) {
1483                     gateway.s_addr = 0;
1484                 }
1485
1486                 netdev_turn_flags_on(netdev, NETDEV_UP, true);
1487                 if (!mask.s_addr) {
1488                     mask.s_addr = guess_netmask(ip.s_addr);
1489                 }
1490                 if (!netdev_set_in4(netdev, ip, mask)) {
1491                     VLOG_INFO("bridge %s: configured IP address "IP_FMT", "
1492                               "netmask "IP_FMT,
1493                               br->name, IP_ARGS(&ip.s_addr),
1494                               IP_ARGS(&mask.s_addr));
1495                 }
1496
1497                 if (gateway.s_addr) {
1498                     if (!netdev_add_router(netdev, gateway)) {
1499                         VLOG_INFO("bridge %s: configured gateway "IP_FMT,
1500                                   br->name, IP_ARGS(&gateway.s_addr));
1501                     }
1502                 }
1503             }
1504         }
1505
1506         ofproto_set_failure(br->ofproto,
1507                             (!c->fail_mode
1508                              || !strcmp(c->fail_mode, "standalone")
1509                              || !strcmp(c->fail_mode, "open")));
1510
1511         probe = c->inactivity_probe ? *c->inactivity_probe / 1000 : 5;
1512         ofproto_set_probe_interval(br->ofproto, probe);
1513
1514         max_backoff = c->max_backoff ? *c->max_backoff / 1000 : 8;
1515         ofproto_set_max_backoff(br->ofproto, max_backoff);
1516
1517         rate_limit = c->controller_rate_limit ? *c->controller_rate_limit : 0;
1518         burst_limit = c->controller_burst_limit ? *c->controller_burst_limit : 0;
1519         ofproto_set_rate_limit(br->ofproto, rate_limit, burst_limit);
1520     } else {
1521         union ofp_action action;
1522         flow_t flow;
1523
1524         /* Set up a flow that matches every packet and directs them to
1525          * OFPP_NORMAL (which goes to us). */
1526         memset(&action, 0, sizeof action);
1527         action.type = htons(OFPAT_OUTPUT);
1528         action.output.len = htons(sizeof action);
1529         action.output.port = htons(OFPP_NORMAL);
1530         memset(&flow, 0, sizeof flow);
1531         ofproto_add_flow(br->ofproto, &flow, OFPFW_ALL, 0,
1532                          &action, 1, 0);
1533
1534         ofproto_set_in_band(br->ofproto, false);
1535         ofproto_set_max_backoff(br->ofproto, 1);
1536         ofproto_set_probe_interval(br->ofproto, 5);
1537         ofproto_set_failure(br->ofproto, false);
1538     }
1539     free(pfx);
1540
1541     ofproto_set_controller(br->ofproto, br->controller);
1542 }
1543
1544 static void
1545 bridge_get_all_ifaces(const struct bridge *br, struct shash *ifaces)
1546 {
1547     size_t i, j;
1548
1549     shash_init(ifaces);
1550     for (i = 0; i < br->n_ports; i++) {
1551         struct port *port = br->ports[i];
1552         for (j = 0; j < port->n_ifaces; j++) {
1553             struct iface *iface = port->ifaces[j];
1554             shash_add_once(ifaces, iface->name, iface);
1555         }
1556         if (port->n_ifaces > 1 && port->cfg->bond_fake_iface) {
1557             shash_add_once(ifaces, port->name, NULL);
1558         }
1559     }
1560 }
1561
1562 /* For robustness, in case the administrator moves around datapath ports behind
1563  * our back, we re-check all the datapath port numbers here.
1564  *
1565  * This function will set the 'dp_ifidx' members of interfaces that have
1566  * disappeared to -1, so only call this function from a context where those
1567  * 'struct iface's will be removed from the bridge.  Otherwise, the -1
1568  * 'dp_ifidx'es will cause trouble later when we try to send them to the
1569  * datapath, which doesn't support UINT16_MAX+1 ports. */
1570 static void
1571 bridge_fetch_dp_ifaces(struct bridge *br)
1572 {
1573     struct odp_port *dpif_ports;
1574     size_t n_dpif_ports;
1575     size_t i, j;
1576
1577     /* Reset all interface numbers. */
1578     for (i = 0; i < br->n_ports; i++) {
1579         struct port *port = br->ports[i];
1580         for (j = 0; j < port->n_ifaces; j++) {
1581             struct iface *iface = port->ifaces[j];
1582             iface->dp_ifidx = -1;
1583         }
1584     }
1585     port_array_clear(&br->ifaces);
1586
1587     dpif_port_list(br->dpif, &dpif_ports, &n_dpif_ports);
1588     for (i = 0; i < n_dpif_ports; i++) {
1589         struct odp_port *p = &dpif_ports[i];
1590         struct iface *iface = iface_lookup(br, p->devname);
1591         if (iface) {
1592             if (iface->dp_ifidx >= 0) {
1593                 VLOG_WARN("%s reported interface %s twice",
1594                           dpif_name(br->dpif), p->devname);
1595             } else if (iface_from_dp_ifidx(br, p->port)) {
1596                 VLOG_WARN("%s reported interface %"PRIu16" twice",
1597                           dpif_name(br->dpif), p->port);
1598             } else {
1599                 port_array_set(&br->ifaces, p->port, iface);
1600                 iface->dp_ifidx = p->port;
1601             }
1602
1603             if (iface->cfg) {
1604                 int64_t ofport = (iface->dp_ifidx >= 0
1605                                   ? odp_port_to_ofp_port(iface->dp_ifidx)
1606                                   : -1);
1607                 ovsrec_interface_set_ofport(iface->cfg, &ofport, 1);
1608             }
1609         }
1610     }
1611     free(dpif_ports);
1612 }
1613 \f
1614 /* Bridge packet processing functions. */
1615
1616 static int
1617 bond_hash(const uint8_t mac[ETH_ADDR_LEN])
1618 {
1619     return hash_bytes(mac, ETH_ADDR_LEN, 0) & BOND_MASK;
1620 }
1621
1622 static struct bond_entry *
1623 lookup_bond_entry(const struct port *port, const uint8_t mac[ETH_ADDR_LEN])
1624 {
1625     return &port->bond_hash[bond_hash(mac)];
1626 }
1627
1628 static int
1629 bond_choose_iface(const struct port *port)
1630 {
1631     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1632     size_t i, best_down_slave = -1;
1633     long long next_delay_expiration = LLONG_MAX;
1634
1635     for (i = 0; i < port->n_ifaces; i++) {
1636         struct iface *iface = port->ifaces[i];
1637
1638         if (iface->enabled) {
1639             return i;
1640         } else if (iface->delay_expires < next_delay_expiration) {
1641             best_down_slave = i;
1642             next_delay_expiration = iface->delay_expires;
1643         }
1644     }
1645
1646     if (best_down_slave != -1) {
1647         struct iface *iface = port->ifaces[best_down_slave];
1648
1649         VLOG_INFO_RL(&rl, "interface %s: skipping remaining %lli ms updelay "
1650                      "since no other interface is up", iface->name,
1651                      iface->delay_expires - time_msec());
1652         bond_enable_slave(iface, true);
1653     }
1654
1655     return best_down_slave;
1656 }
1657
1658 static bool
1659 choose_output_iface(const struct port *port, const uint8_t *dl_src,
1660                     uint16_t *dp_ifidx, tag_type *tags)
1661 {
1662     struct iface *iface;
1663
1664     assert(port->n_ifaces);
1665     if (port->n_ifaces == 1) {
1666         iface = port->ifaces[0];
1667     } else {
1668         struct bond_entry *e = lookup_bond_entry(port, dl_src);
1669         if (e->iface_idx < 0 || e->iface_idx >= port->n_ifaces
1670             || !port->ifaces[e->iface_idx]->enabled) {
1671             /* XXX select interface properly.  The current interface selection
1672              * is only good for testing the rebalancing code. */
1673             e->iface_idx = bond_choose_iface(port);
1674             if (e->iface_idx < 0) {
1675                 *tags |= port->no_ifaces_tag;
1676                 return false;
1677             }
1678             e->iface_tag = tag_create_random();
1679             ((struct port *) port)->bond_compat_is_stale = true;
1680         }
1681         *tags |= e->iface_tag;
1682         iface = port->ifaces[e->iface_idx];
1683     }
1684     *dp_ifidx = iface->dp_ifidx;
1685     *tags |= iface->tag;        /* Currently only used for bonding. */
1686     return true;
1687 }
1688
1689 static void
1690 bond_link_status_update(struct iface *iface, bool carrier)
1691 {
1692     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1693     struct port *port = iface->port;
1694
1695     if ((carrier == iface->enabled) == (iface->delay_expires == LLONG_MAX)) {
1696         /* Nothing to do. */
1697         return;
1698     }
1699     VLOG_INFO_RL(&rl, "interface %s: carrier %s",
1700                  iface->name, carrier ? "detected" : "dropped");
1701     if (carrier == iface->enabled) {
1702         iface->delay_expires = LLONG_MAX;
1703         VLOG_INFO_RL(&rl, "interface %s: will not be %s",
1704                      iface->name, carrier ? "disabled" : "enabled");
1705     } else if (carrier && port->active_iface < 0) {
1706         bond_enable_slave(iface, true);
1707         if (port->updelay) {
1708             VLOG_INFO_RL(&rl, "interface %s: skipping %d ms updelay since no "
1709                          "other interface is up", iface->name, port->updelay);
1710         }
1711     } else {
1712         int delay = carrier ? port->updelay : port->downdelay;
1713         iface->delay_expires = time_msec() + delay;
1714         if (delay) {
1715             VLOG_INFO_RL(&rl,
1716                          "interface %s: will be %s if it stays %s for %d ms",
1717                          iface->name,
1718                          carrier ? "enabled" : "disabled",
1719                          carrier ? "up" : "down",
1720                          delay);
1721         }
1722     }
1723 }
1724
1725 static void
1726 bond_choose_active_iface(struct port *port)
1727 {
1728     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1729
1730     port->active_iface = bond_choose_iface(port);
1731     port->active_iface_tag = tag_create_random();
1732     if (port->active_iface >= 0) {
1733         VLOG_INFO_RL(&rl, "port %s: active interface is now %s",
1734                      port->name, port->ifaces[port->active_iface]->name);
1735     } else {
1736         VLOG_WARN_RL(&rl, "port %s: all ports disabled, no active interface",
1737                      port->name);
1738     }
1739 }
1740
1741 static void
1742 bond_enable_slave(struct iface *iface, bool enable)
1743 {
1744     struct port *port = iface->port;
1745     struct bridge *br = port->bridge;
1746
1747     /* This acts as a recursion check.  If the act of disabling a slave
1748      * causes a different slave to be enabled, the flag will allow us to
1749      * skip redundant work when we reenter this function.  It must be
1750      * cleared on exit to keep things safe with multiple bonds. */
1751     static bool moving_active_iface = false;
1752
1753     iface->delay_expires = LLONG_MAX;
1754     if (enable == iface->enabled) {
1755         return;
1756     }
1757
1758     iface->enabled = enable;
1759     if (!iface->enabled) {
1760         VLOG_WARN("interface %s: disabled", iface->name);
1761         ofproto_revalidate(br->ofproto, iface->tag);
1762         if (iface->port_ifidx == port->active_iface) {
1763             ofproto_revalidate(br->ofproto,
1764                                port->active_iface_tag);
1765
1766             /* Disabling a slave can lead to another slave being immediately
1767              * enabled if there will be no active slaves but one is waiting
1768              * on an updelay.  In this case we do not need to run most of the
1769              * code for the newly enabled slave since there was no period
1770              * without an active slave and it is redundant with the disabling
1771              * path. */
1772             moving_active_iface = true;
1773             bond_choose_active_iface(port);
1774         }
1775         bond_send_learning_packets(port);
1776     } else {
1777         VLOG_WARN("interface %s: enabled", iface->name);
1778         if (port->active_iface < 0 && !moving_active_iface) {
1779             ofproto_revalidate(br->ofproto, port->no_ifaces_tag);
1780             bond_choose_active_iface(port);
1781             bond_send_learning_packets(port);
1782         }
1783         iface->tag = tag_create_random();
1784     }
1785
1786     moving_active_iface = false;
1787     port->bond_compat_is_stale = true;
1788 }
1789
1790 static void
1791 bond_run(struct bridge *br)
1792 {
1793     size_t i, j;
1794
1795     for (i = 0; i < br->n_ports; i++) {
1796         struct port *port = br->ports[i];
1797
1798         if (port->n_ifaces >= 2) {
1799             for (j = 0; j < port->n_ifaces; j++) {
1800                 struct iface *iface = port->ifaces[j];
1801                 if (time_msec() >= iface->delay_expires) {
1802                     bond_enable_slave(iface, !iface->enabled);
1803                 }
1804             }
1805         }
1806
1807         if (port->bond_compat_is_stale) {
1808             port->bond_compat_is_stale = false;
1809             port_update_bond_compat(port);
1810         }
1811     }
1812 }
1813
1814 static void
1815 bond_wait(struct bridge *br)
1816 {
1817     size_t i, j;
1818
1819     for (i = 0; i < br->n_ports; i++) {
1820         struct port *port = br->ports[i];
1821         if (port->n_ifaces < 2) {
1822             continue;
1823         }
1824         for (j = 0; j < port->n_ifaces; j++) {
1825             struct iface *iface = port->ifaces[j];
1826             if (iface->delay_expires != LLONG_MAX) {
1827                 poll_timer_wait(iface->delay_expires - time_msec());
1828             }
1829         }
1830     }
1831 }
1832
1833 static bool
1834 set_dst(struct dst *p, const flow_t *flow,
1835         const struct port *in_port, const struct port *out_port,
1836         tag_type *tags)
1837 {
1838     p->vlan = (out_port->vlan >= 0 ? OFP_VLAN_NONE
1839               : in_port->vlan >= 0 ? in_port->vlan
1840               : ntohs(flow->dl_vlan));
1841     return choose_output_iface(out_port, flow->dl_src, &p->dp_ifidx, tags);
1842 }
1843
1844 static void
1845 swap_dst(struct dst *p, struct dst *q)
1846 {
1847     struct dst tmp = *p;
1848     *p = *q;
1849     *q = tmp;
1850 }
1851
1852 /* Moves all the dsts with vlan == 'vlan' to the front of the 'n_dsts' in
1853  * 'dsts'.  (This may help performance by reducing the number of VLAN changes
1854  * that we push to the datapath.  We could in fact fully sort the array by
1855  * vlan, but in most cases there are at most two different vlan tags so that's
1856  * possibly overkill.) */
1857 static void
1858 partition_dsts(struct dst *dsts, size_t n_dsts, int vlan)
1859 {
1860     struct dst *first = dsts;
1861     struct dst *last = dsts + n_dsts;
1862
1863     while (first != last) {
1864         /* Invariants:
1865          *      - All dsts < first have vlan == 'vlan'.
1866          *      - All dsts >= last have vlan != 'vlan'.
1867          *      - first < last. */
1868         while (first->vlan == vlan) {
1869             if (++first == last) {
1870                 return;
1871             }
1872         }
1873
1874         /* Same invariants, plus one additional:
1875          *      - first->vlan != vlan.
1876          */
1877         while (last[-1].vlan != vlan) {
1878             if (--last == first) {
1879                 return;
1880             }
1881         }
1882
1883         /* Same invariants, plus one additional:
1884          *      - last[-1].vlan == vlan.*/
1885         swap_dst(first++, --last);
1886     }
1887 }
1888
1889 static int
1890 mirror_mask_ffs(mirror_mask_t mask)
1891 {
1892     BUILD_ASSERT_DECL(sizeof(unsigned int) >= sizeof(mask));
1893     return ffs(mask);
1894 }
1895
1896 static bool
1897 dst_is_duplicate(const struct dst *dsts, size_t n_dsts,
1898                  const struct dst *test)
1899 {
1900     size_t i;
1901     for (i = 0; i < n_dsts; i++) {
1902         if (dsts[i].vlan == test->vlan && dsts[i].dp_ifidx == test->dp_ifidx) {
1903             return true;
1904         }
1905     }
1906     return false;
1907 }
1908
1909 static bool
1910 port_trunks_vlan(const struct port *port, uint16_t vlan)
1911 {
1912     return port->vlan < 0 && bitmap_is_set(port->trunks, vlan);
1913 }
1914
1915 static bool
1916 port_includes_vlan(const struct port *port, uint16_t vlan)
1917 {
1918     return vlan == port->vlan || port_trunks_vlan(port, vlan);
1919 }
1920
1921 static size_t
1922 compose_dsts(const struct bridge *br, const flow_t *flow, uint16_t vlan,
1923              const struct port *in_port, const struct port *out_port,
1924              struct dst dsts[], tag_type *tags, uint16_t *nf_output_iface)
1925 {
1926     mirror_mask_t mirrors = in_port->src_mirrors;
1927     struct dst *dst = dsts;
1928     size_t i;
1929
1930     if (out_port == FLOOD_PORT) {
1931         /* XXX use ODP_FLOOD if no vlans or bonding. */
1932         /* XXX even better, define each VLAN as a datapath port group */
1933         for (i = 0; i < br->n_ports; i++) {
1934             struct port *port = br->ports[i];
1935             if (port != in_port && port_includes_vlan(port, vlan)
1936                 && !port->is_mirror_output_port
1937                 && set_dst(dst, flow, in_port, port, tags)) {
1938                 mirrors |= port->dst_mirrors;
1939                 dst++;
1940             }
1941         }
1942         *nf_output_iface = NF_OUT_FLOOD;
1943     } else if (out_port && set_dst(dst, flow, in_port, out_port, tags)) {
1944         *nf_output_iface = dst->dp_ifidx;
1945         mirrors |= out_port->dst_mirrors;
1946         dst++;
1947     }
1948
1949     while (mirrors) {
1950         struct mirror *m = br->mirrors[mirror_mask_ffs(mirrors) - 1];
1951         if (!m->n_vlans || vlan_is_mirrored(m, vlan)) {
1952             if (m->out_port) {
1953                 if (set_dst(dst, flow, in_port, m->out_port, tags)
1954                     && !dst_is_duplicate(dsts, dst - dsts, dst)) {
1955                     dst++;
1956                 }
1957             } else {
1958                 for (i = 0; i < br->n_ports; i++) {
1959                     struct port *port = br->ports[i];
1960                     if (port_includes_vlan(port, m->out_vlan)
1961                         && set_dst(dst, flow, in_port, port, tags))
1962                     {
1963                         int flow_vlan;
1964
1965                         if (port->vlan < 0) {
1966                             dst->vlan = m->out_vlan;
1967                         }
1968                         if (dst_is_duplicate(dsts, dst - dsts, dst)) {
1969                             continue;
1970                         }
1971
1972                         /* Use the vlan tag on the original flow instead of
1973                          * the one passed in the vlan parameter.  This ensures
1974                          * that we compare the vlan from before any implicit
1975                          * tagging tags place. This is necessary because
1976                          * dst->vlan is the final vlan, after removing implicit
1977                          * tags. */
1978                         flow_vlan = ntohs(flow->dl_vlan);
1979                         if (flow_vlan == 0) {
1980                             flow_vlan = OFP_VLAN_NONE;
1981                         }
1982                         if (port == in_port && dst->vlan == flow_vlan) {
1983                             /* Don't send out input port on same VLAN. */
1984                             continue;
1985                         }
1986                         dst++;
1987                     }
1988                 }
1989             }
1990         }
1991         mirrors &= mirrors - 1;
1992     }
1993
1994     partition_dsts(dsts, dst - dsts, ntohs(flow->dl_vlan));
1995     return dst - dsts;
1996 }
1997
1998 static void OVS_UNUSED
1999 print_dsts(const struct dst *dsts, size_t n)
2000 {
2001     for (; n--; dsts++) {
2002         printf(">p%"PRIu16, dsts->dp_ifidx);
2003         if (dsts->vlan != OFP_VLAN_NONE) {
2004             printf("v%"PRIu16, dsts->vlan);
2005         }
2006     }
2007 }
2008
2009 static void
2010 compose_actions(struct bridge *br, const flow_t *flow, uint16_t vlan,
2011                 const struct port *in_port, const struct port *out_port,
2012                 tag_type *tags, struct odp_actions *actions,
2013                 uint16_t *nf_output_iface)
2014 {
2015     struct dst dsts[DP_MAX_PORTS * (MAX_MIRRORS + 1)];
2016     size_t n_dsts;
2017     const struct dst *p;
2018     uint16_t cur_vlan;
2019
2020     n_dsts = compose_dsts(br, flow, vlan, in_port, out_port, dsts, tags,
2021                           nf_output_iface);
2022
2023     cur_vlan = ntohs(flow->dl_vlan);
2024     for (p = dsts; p < &dsts[n_dsts]; p++) {
2025         union odp_action *a;
2026         if (p->vlan != cur_vlan) {
2027             if (p->vlan == OFP_VLAN_NONE) {
2028                 odp_actions_add(actions, ODPAT_STRIP_VLAN);
2029             } else {
2030                 a = odp_actions_add(actions, ODPAT_SET_VLAN_VID);
2031                 a->vlan_vid.vlan_vid = htons(p->vlan);
2032             }
2033             cur_vlan = p->vlan;
2034         }
2035         a = odp_actions_add(actions, ODPAT_OUTPUT);
2036         a->output.port = p->dp_ifidx;
2037     }
2038 }
2039
2040 /* Returns the effective vlan of a packet, taking into account both the
2041  * 802.1Q header and implicitly tagged ports.  A value of 0 indicates that
2042  * the packet is untagged and -1 indicates it has an invalid header and
2043  * should be dropped. */
2044 static int flow_get_vlan(struct bridge *br, const flow_t *flow,
2045                          struct port *in_port, bool have_packet)
2046 {
2047     /* Note that dl_vlan of 0 and of OFP_VLAN_NONE both mean that the packet
2048      * belongs to VLAN 0, so we should treat both cases identically.  (In the
2049      * former case, the packet has an 802.1Q header that specifies VLAN 0,
2050      * presumably to allow a priority to be specified.  In the latter case, the
2051      * packet does not have any 802.1Q header.) */
2052     int vlan = ntohs(flow->dl_vlan);
2053     if (vlan == OFP_VLAN_NONE) {
2054         vlan = 0;
2055     }
2056     if (in_port->vlan >= 0) {
2057         if (vlan) {
2058             /* XXX support double tagging? */
2059             if (have_packet) {
2060                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2061                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %"PRIu16" tagged "
2062                              "packet received on port %s configured with "
2063                              "implicit VLAN %"PRIu16,
2064                              br->name, ntohs(flow->dl_vlan),
2065                              in_port->name, in_port->vlan);
2066             }
2067             return -1;
2068         }
2069         vlan = in_port->vlan;
2070     } else {
2071         if (!port_includes_vlan(in_port, vlan)) {
2072             if (have_packet) {
2073                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2074                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %d tagged "
2075                              "packet received on port %s not configured for "
2076                              "trunking VLAN %d",
2077                              br->name, vlan, in_port->name, vlan);
2078             }
2079             return -1;
2080         }
2081     }
2082
2083     return vlan;
2084 }
2085
2086 static void
2087 update_learning_table(struct bridge *br, const flow_t *flow, int vlan,
2088                       struct port *in_port)
2089 {
2090     tag_type rev_tag = mac_learning_learn(br->ml, flow->dl_src,
2091                                           vlan, in_port->port_idx);
2092     if (rev_tag) {
2093         /* The log messages here could actually be useful in debugging,
2094          * so keep the rate limit relatively high. */
2095         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30,
2096                                                                 300);
2097         VLOG_DBG_RL(&rl, "bridge %s: learned that "ETH_ADDR_FMT" is "
2098                     "on port %s in VLAN %d",
2099                     br->name, ETH_ADDR_ARGS(flow->dl_src),
2100                     in_port->name, vlan);
2101         ofproto_revalidate(br->ofproto, rev_tag);
2102     }
2103 }
2104
2105 static bool
2106 is_bcast_arp_reply(const flow_t *flow)
2107 {
2108     return (flow->dl_type == htons(ETH_TYPE_ARP)
2109             && flow->nw_proto == ARP_OP_REPLY
2110             && eth_addr_is_broadcast(flow->dl_dst));
2111 }
2112
2113 /* If the composed actions may be applied to any packet in the given 'flow',
2114  * returns true.  Otherwise, the actions should only be applied to 'packet', or
2115  * not at all, if 'packet' was NULL. */
2116 static bool
2117 process_flow(struct bridge *br, const flow_t *flow,
2118              const struct ofpbuf *packet, struct odp_actions *actions,
2119              tag_type *tags, uint16_t *nf_output_iface)
2120 {
2121     struct iface *in_iface;
2122     struct port *in_port;
2123     struct port *out_port = NULL; /* By default, drop the packet/flow. */
2124     int vlan;
2125     int out_port_idx;
2126
2127     /* Find the interface and port structure for the received packet. */
2128     in_iface = iface_from_dp_ifidx(br, flow->in_port);
2129     if (!in_iface) {
2130         /* No interface?  Something fishy... */
2131         if (packet != NULL) {
2132             /* Odd.  A few possible reasons here:
2133              *
2134              * - We deleted an interface but there are still a few packets
2135              *   queued up from it.
2136              *
2137              * - Someone externally added an interface (e.g. with "ovs-dpctl
2138              *   add-if") that we don't know about.
2139              *
2140              * - Packet arrived on the local port but the local port is not
2141              *   one of our bridge ports.
2142              */
2143             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2144
2145             VLOG_WARN_RL(&rl, "bridge %s: received packet on unknown "
2146                          "interface %"PRIu16, br->name, flow->in_port); 
2147         }
2148
2149         /* Return without adding any actions, to drop packets on this flow. */
2150         return true;
2151     }
2152     in_port = in_iface->port;
2153     vlan = flow_get_vlan(br, flow, in_port, !!packet);
2154     if (vlan < 0) {
2155         goto done;
2156     }
2157
2158     /* Drop frames for reserved multicast addresses. */
2159     if (eth_addr_is_reserved(flow->dl_dst)) {
2160         goto done;
2161     }
2162
2163     /* Drop frames on ports reserved for mirroring. */
2164     if (in_port->is_mirror_output_port) {
2165         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2166         VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port %s, "
2167                      "which is reserved exclusively for mirroring",
2168                      br->name, in_port->name);
2169         goto done;
2170     }
2171
2172     /* Packets received on bonds need special attention to avoid duplicates. */
2173     if (in_port->n_ifaces > 1) {
2174         int src_idx;
2175
2176         if (eth_addr_is_multicast(flow->dl_dst)) {
2177             *tags |= in_port->active_iface_tag;
2178             if (in_port->active_iface != in_iface->port_ifidx) {
2179                 /* Drop all multicast packets on inactive slaves. */
2180                 goto done;
2181             }
2182         }
2183
2184         /* Drop all packets for which we have learned a different input
2185          * port, because we probably sent the packet on one slave and got
2186          * it back on the other.  Broadcast ARP replies are an exception
2187          * to this rule: the host has moved to another switch. */
2188         src_idx = mac_learning_lookup(br->ml, flow->dl_src, vlan);
2189         if (src_idx != -1 && src_idx != in_port->port_idx &&
2190             !is_bcast_arp_reply(flow)) {
2191                 goto done;
2192         }
2193     }
2194
2195     /* MAC learning. */
2196     out_port = FLOOD_PORT;
2197     /* Learn source MAC (but don't try to learn from revalidation). */
2198     if (packet) {
2199         update_learning_table(br, flow, vlan, in_port);
2200     }
2201
2202     /* Determine output port. */
2203     out_port_idx = mac_learning_lookup_tag(br->ml, flow->dl_dst, vlan,
2204                                            tags);
2205     if (out_port_idx >= 0 && out_port_idx < br->n_ports) {
2206         out_port = br->ports[out_port_idx];
2207     } else if (!packet && !eth_addr_is_multicast(flow->dl_dst)) {
2208         /* If we are revalidating but don't have a learning entry then
2209          * eject the flow.  Installing a flow that floods packets opens
2210          * up a window of time where we could learn from a packet reflected
2211          * on a bond and blackhole packets before the learning table is
2212          * updated to reflect the correct port. */
2213         return false;
2214     }
2215
2216     /* Don't send packets out their input ports. */
2217     if (in_port == out_port) {
2218         out_port = NULL;
2219     }
2220
2221 done:
2222     compose_actions(br, flow, vlan, in_port, out_port, tags, actions,
2223                     nf_output_iface);
2224
2225     return true;
2226 }
2227
2228 /* Careful: 'opp' is in host byte order and opp->port_no is an OFP port
2229  * number. */
2230 static void
2231 bridge_port_changed_ofhook_cb(enum ofp_port_reason reason,
2232                               const struct ofp_phy_port *opp,
2233                               void *br_)
2234 {
2235     struct bridge *br = br_;
2236     struct iface *iface;
2237     struct port *port;
2238
2239     iface = iface_from_dp_ifidx(br, ofp_port_to_odp_port(opp->port_no));
2240     if (!iface) {
2241         return;
2242     }
2243     port = iface->port;
2244
2245     if (reason == OFPPR_DELETE) {
2246         VLOG_WARN("bridge %s: interface %s deleted unexpectedly",
2247                   br->name, iface->name);
2248         iface_destroy(iface);
2249         if (!port->n_ifaces) {
2250             VLOG_WARN("bridge %s: port %s has no interfaces, dropping",
2251                       br->name, port->name);
2252             port_destroy(port);
2253         }
2254
2255         bridge_flush(br);
2256     } else {
2257         if (port->n_ifaces > 1) {
2258             bool up = !(opp->state & OFPPS_LINK_DOWN);
2259             bond_link_status_update(iface, up);
2260             port_update_bond_compat(port);
2261         }
2262     }
2263 }
2264
2265 static bool
2266 bridge_normal_ofhook_cb(const flow_t *flow, const struct ofpbuf *packet,
2267                         struct odp_actions *actions, tag_type *tags,
2268                         uint16_t *nf_output_iface, void *br_)
2269 {
2270     struct bridge *br = br_;
2271
2272     COVERAGE_INC(bridge_process_flow);
2273     return process_flow(br, flow, packet, actions, tags, nf_output_iface);
2274 }
2275
2276 static void
2277 bridge_account_flow_ofhook_cb(const flow_t *flow,
2278                               const union odp_action *actions,
2279                               size_t n_actions, unsigned long long int n_bytes,
2280                               void *br_)
2281 {
2282     struct bridge *br = br_;
2283     struct port *in_port;
2284     const union odp_action *a;
2285
2286     /* Feed information from the active flows back into the learning table
2287      * to ensure that table is always in sync with what is actually flowing
2288      * through the datapath. */
2289     in_port = port_from_dp_ifidx(br, flow->in_port);
2290     if (in_port) {
2291         int vlan = flow_get_vlan(br, flow, in_port, false);
2292          if (vlan >= 0) {
2293             update_learning_table(br, flow, vlan, in_port);
2294         }
2295     }
2296
2297     if (!br->has_bonded_ports) {
2298         return;
2299     }
2300
2301     for (a = actions; a < &actions[n_actions]; a++) {
2302         if (a->type == ODPAT_OUTPUT) {
2303             struct port *out_port = port_from_dp_ifidx(br, a->output.port);
2304             if (out_port && out_port->n_ifaces >= 2) {
2305                 struct bond_entry *e = lookup_bond_entry(out_port,
2306                                                          flow->dl_src);
2307                 e->tx_bytes += n_bytes;
2308             }
2309         }
2310     }
2311 }
2312
2313 static void
2314 bridge_account_checkpoint_ofhook_cb(void *br_)
2315 {
2316     struct bridge *br = br_;
2317     size_t i;
2318
2319     if (!br->has_bonded_ports) {
2320         return;
2321     }
2322
2323     /* The current ofproto implementation calls this callback at least once a
2324      * second, so this timer implementation is sufficient. */
2325     if (time_msec() < br->bond_next_rebalance) {
2326         return;
2327     }
2328     br->bond_next_rebalance = time_msec() + 10000;
2329
2330     for (i = 0; i < br->n_ports; i++) {
2331         struct port *port = br->ports[i];
2332         if (port->n_ifaces > 1) {
2333             bond_rebalance_port(port);
2334         }
2335     }
2336 }
2337
2338 static struct ofhooks bridge_ofhooks = {
2339     bridge_port_changed_ofhook_cb,
2340     bridge_normal_ofhook_cb,
2341     bridge_account_flow_ofhook_cb,
2342     bridge_account_checkpoint_ofhook_cb,
2343 };
2344 \f
2345 /* Bonding functions. */
2346
2347 /* Statistics for a single interface on a bonded port, used for load-based
2348  * bond rebalancing.  */
2349 struct slave_balance {
2350     struct iface *iface;        /* The interface. */
2351     uint64_t tx_bytes;          /* Sum of hashes[*]->tx_bytes. */
2352
2353     /* All the "bond_entry"s that are assigned to this interface, in order of
2354      * increasing tx_bytes. */
2355     struct bond_entry **hashes;
2356     size_t n_hashes;
2357 };
2358
2359 /* Sorts pointers to pointers to bond_entries in ascending order by the
2360  * interface to which they are assigned, and within a single interface in
2361  * ascending order of bytes transmitted. */
2362 static int
2363 compare_bond_entries(const void *a_, const void *b_)
2364 {
2365     const struct bond_entry *const *ap = a_;
2366     const struct bond_entry *const *bp = b_;
2367     const struct bond_entry *a = *ap;
2368     const struct bond_entry *b = *bp;
2369     if (a->iface_idx != b->iface_idx) {
2370         return a->iface_idx > b->iface_idx ? 1 : -1;
2371     } else if (a->tx_bytes != b->tx_bytes) {
2372         return a->tx_bytes > b->tx_bytes ? 1 : -1;
2373     } else {
2374         return 0;
2375     }
2376 }
2377
2378 /* Sorts slave_balances so that enabled ports come first, and otherwise in
2379  * *descending* order by number of bytes transmitted. */
2380 static int
2381 compare_slave_balance(const void *a_, const void *b_)
2382 {
2383     const struct slave_balance *a = a_;
2384     const struct slave_balance *b = b_;
2385     if (a->iface->enabled != b->iface->enabled) {
2386         return a->iface->enabled ? -1 : 1;
2387     } else if (a->tx_bytes != b->tx_bytes) {
2388         return a->tx_bytes > b->tx_bytes ? -1 : 1;
2389     } else {
2390         return 0;
2391     }
2392 }
2393
2394 static void
2395 swap_bals(struct slave_balance *a, struct slave_balance *b)
2396 {
2397     struct slave_balance tmp = *a;
2398     *a = *b;
2399     *b = tmp;
2400 }
2401
2402 /* Restores the 'n_bals' slave_balance structures in 'bals' to sorted order
2403  * given that 'p' (and only 'p') might be in the wrong location.
2404  *
2405  * This function invalidates 'p', since it might now be in a different memory
2406  * location. */
2407 static void
2408 resort_bals(struct slave_balance *p,
2409             struct slave_balance bals[], size_t n_bals)
2410 {
2411     if (n_bals > 1) {
2412         for (; p > bals && p->tx_bytes > p[-1].tx_bytes; p--) {
2413             swap_bals(p, p - 1);
2414         }
2415         for (; p < &bals[n_bals - 1] && p->tx_bytes < p[1].tx_bytes; p++) {
2416             swap_bals(p, p + 1);
2417         }
2418     }
2419 }
2420
2421 static void
2422 log_bals(const struct slave_balance *bals, size_t n_bals, struct port *port)
2423 {
2424     if (VLOG_IS_DBG_ENABLED()) {
2425         struct ds ds = DS_EMPTY_INITIALIZER;
2426         const struct slave_balance *b;
2427
2428         for (b = bals; b < bals + n_bals; b++) {
2429             size_t i;
2430
2431             if (b > bals) {
2432                 ds_put_char(&ds, ',');
2433             }
2434             ds_put_format(&ds, " %s %"PRIu64"kB",
2435                           b->iface->name, b->tx_bytes / 1024);
2436
2437             if (!b->iface->enabled) {
2438                 ds_put_cstr(&ds, " (disabled)");
2439             }
2440             if (b->n_hashes > 0) {
2441                 ds_put_cstr(&ds, " (");
2442                 for (i = 0; i < b->n_hashes; i++) {
2443                     const struct bond_entry *e = b->hashes[i];
2444                     if (i > 0) {
2445                         ds_put_cstr(&ds, " + ");
2446                     }
2447                     ds_put_format(&ds, "h%td: %"PRIu64"kB",
2448                                   e - port->bond_hash, e->tx_bytes / 1024);
2449                 }
2450                 ds_put_cstr(&ds, ")");
2451             }
2452         }
2453         VLOG_DBG("bond %s:%s", port->name, ds_cstr(&ds));
2454         ds_destroy(&ds);
2455     }
2456 }
2457
2458 /* Shifts 'hash' from 'from' to 'to' within 'port'. */
2459 static void
2460 bond_shift_load(struct slave_balance *from, struct slave_balance *to,
2461                 int hash_idx)
2462 {
2463     struct bond_entry *hash = from->hashes[hash_idx];
2464     struct port *port = from->iface->port;
2465     uint64_t delta = hash->tx_bytes;
2466
2467     VLOG_INFO("bond %s: shift %"PRIu64"kB of load (with hash %td) "
2468               "from %s to %s (now carrying %"PRIu64"kB and "
2469               "%"PRIu64"kB load, respectively)",
2470               port->name, delta / 1024, hash - port->bond_hash,
2471               from->iface->name, to->iface->name,
2472               (from->tx_bytes - delta) / 1024,
2473               (to->tx_bytes + delta) / 1024);
2474
2475     /* Delete element from from->hashes.
2476      *
2477      * We don't bother to add the element to to->hashes because not only would
2478      * it require more work, the only purpose it would be to allow that hash to
2479      * be migrated to another slave in this rebalancing run, and there is no
2480      * point in doing that.  */
2481     if (hash_idx == 0) {
2482         from->hashes++;
2483     } else {
2484         memmove(from->hashes + hash_idx, from->hashes + hash_idx + 1,
2485                 (from->n_hashes - (hash_idx + 1)) * sizeof *from->hashes);
2486     }
2487     from->n_hashes--;
2488
2489     /* Shift load away from 'from' to 'to'. */
2490     from->tx_bytes -= delta;
2491     to->tx_bytes += delta;
2492
2493     /* Arrange for flows to be revalidated. */
2494     ofproto_revalidate(port->bridge->ofproto, hash->iface_tag);
2495     hash->iface_idx = to->iface->port_ifidx;
2496     hash->iface_tag = tag_create_random();
2497 }
2498
2499 static void
2500 bond_rebalance_port(struct port *port)
2501 {
2502     struct slave_balance bals[DP_MAX_PORTS];
2503     size_t n_bals;
2504     struct bond_entry *hashes[BOND_MASK + 1];
2505     struct slave_balance *b, *from, *to;
2506     struct bond_entry *e;
2507     size_t i;
2508
2509     /* Sets up 'bals' to describe each of the port's interfaces, sorted in
2510      * descending order of tx_bytes, so that bals[0] represents the most
2511      * heavily loaded slave and bals[n_bals - 1] represents the least heavily
2512      * loaded slave.
2513      *
2514      * The code is a bit tricky: to avoid dynamically allocating a 'hashes'
2515      * array for each slave_balance structure, we sort our local array of
2516      * hashes in order by slave, so that all of the hashes for a given slave
2517      * become contiguous in memory, and then we point each 'hashes' members of
2518      * a slave_balance structure to the start of a contiguous group. */
2519     n_bals = port->n_ifaces;
2520     for (b = bals; b < &bals[n_bals]; b++) {
2521         b->iface = port->ifaces[b - bals];
2522         b->tx_bytes = 0;
2523         b->hashes = NULL;
2524         b->n_hashes = 0;
2525     }
2526     for (i = 0; i <= BOND_MASK; i++) {
2527         hashes[i] = &port->bond_hash[i];
2528     }
2529     qsort(hashes, BOND_MASK + 1, sizeof *hashes, compare_bond_entries);
2530     for (i = 0; i <= BOND_MASK; i++) {
2531         e = hashes[i];
2532         if (e->iface_idx >= 0 && e->iface_idx < port->n_ifaces) {
2533             b = &bals[e->iface_idx];
2534             b->tx_bytes += e->tx_bytes;
2535             if (!b->hashes) {
2536                 b->hashes = &hashes[i];
2537             }
2538             b->n_hashes++;
2539         }
2540     }
2541     qsort(bals, n_bals, sizeof *bals, compare_slave_balance);
2542     log_bals(bals, n_bals, port);
2543
2544     /* Discard slaves that aren't enabled (which were sorted to the back of the
2545      * array earlier). */
2546     while (!bals[n_bals - 1].iface->enabled) {
2547         n_bals--;
2548         if (!n_bals) {
2549             return;
2550         }
2551     }
2552
2553     /* Shift load from the most-loaded slaves to the least-loaded slaves. */
2554     to = &bals[n_bals - 1];
2555     for (from = bals; from < to; ) {
2556         uint64_t overload = from->tx_bytes - to->tx_bytes;
2557         if (overload < to->tx_bytes >> 5 || overload < 100000) {
2558             /* The extra load on 'from' (and all less-loaded slaves), compared
2559              * to that of 'to' (the least-loaded slave), is less than ~3%, or
2560              * it is less than ~1Mbps.  No point in rebalancing. */
2561             break;
2562         } else if (from->n_hashes == 1) {
2563             /* 'from' only carries a single MAC hash, so we can't shift any
2564              * load away from it, even though we want to. */
2565             from++;
2566         } else {
2567             /* 'from' is carrying significantly more load than 'to', and that
2568              * load is split across at least two different hashes.  Pick a hash
2569              * to migrate to 'to' (the least-loaded slave), given that doing so
2570              * must decrease the ratio of the load on the two slaves by at
2571              * least 0.1.
2572              *
2573              * The sort order we use means that we prefer to shift away the
2574              * smallest hashes instead of the biggest ones.  There is little
2575              * reason behind this decision; we could use the opposite sort
2576              * order to shift away big hashes ahead of small ones. */
2577             size_t i;
2578             bool order_swapped;
2579
2580             for (i = 0; i < from->n_hashes; i++) {
2581                 double old_ratio, new_ratio;
2582                 uint64_t delta = from->hashes[i]->tx_bytes;
2583
2584                 if (delta == 0 || from->tx_bytes - delta == 0) {
2585                     /* Pointless move. */
2586                     continue;
2587                 }
2588
2589                 order_swapped = from->tx_bytes - delta < to->tx_bytes + delta;
2590
2591                 if (to->tx_bytes == 0) {
2592                     /* Nothing on the new slave, move it. */
2593                     break;
2594                 }
2595
2596                 old_ratio = (double)from->tx_bytes / to->tx_bytes;
2597                 new_ratio = (double)(from->tx_bytes - delta) /
2598                             (to->tx_bytes + delta);
2599
2600                 if (new_ratio == 0) {
2601                     /* Should already be covered but check to prevent division
2602                      * by zero. */
2603                     continue;
2604                 }
2605
2606                 if (new_ratio < 1) {
2607                     new_ratio = 1 / new_ratio;
2608                 }
2609
2610                 if (old_ratio - new_ratio > 0.1) {
2611                     /* Would decrease the ratio, move it. */
2612                     break;
2613                 }
2614             }
2615             if (i < from->n_hashes) {
2616                 bond_shift_load(from, to, i);
2617                 port->bond_compat_is_stale = true;
2618
2619                 /* If the result of the migration changed the relative order of
2620                  * 'from' and 'to' swap them back to maintain invariants. */
2621                 if (order_swapped) {
2622                     swap_bals(from, to);
2623                 }
2624
2625                 /* Re-sort 'bals'.  Note that this may make 'from' and 'to'
2626                  * point to different slave_balance structures.  It is only
2627                  * valid to do these two operations in a row at all because we
2628                  * know that 'from' will not move past 'to' and vice versa. */
2629                 resort_bals(from, bals, n_bals);
2630                 resort_bals(to, bals, n_bals);
2631             } else {
2632                 from++;
2633             }
2634         }
2635     }
2636
2637     /* Implement exponentially weighted moving average.  A weight of 1/2 causes
2638      * historical data to decay to <1% in 7 rebalancing runs.  */
2639     for (e = &port->bond_hash[0]; e <= &port->bond_hash[BOND_MASK]; e++) {
2640         e->tx_bytes /= 2;
2641     }
2642 }
2643
2644 static void
2645 bond_send_learning_packets(struct port *port)
2646 {
2647     struct bridge *br = port->bridge;
2648     struct mac_entry *e;
2649     struct ofpbuf packet;
2650     int error, n_packets, n_errors;
2651
2652     if (!port->n_ifaces || port->active_iface < 0) {
2653         return;
2654     }
2655
2656     ofpbuf_init(&packet, 128);
2657     error = n_packets = n_errors = 0;
2658     LIST_FOR_EACH (e, struct mac_entry, lru_node, &br->ml->lrus) {
2659         union ofp_action actions[2], *a;
2660         uint16_t dp_ifidx;
2661         tag_type tags = 0;
2662         flow_t flow;
2663         int retval;
2664
2665         if (e->port == port->port_idx
2666             || !choose_output_iface(port, e->mac, &dp_ifidx, &tags)) {
2667             continue;
2668         }
2669
2670         /* Compose actions. */
2671         memset(actions, 0, sizeof actions);
2672         a = actions;
2673         if (e->vlan) {
2674             a->vlan_vid.type = htons(OFPAT_SET_VLAN_VID);
2675             a->vlan_vid.len = htons(sizeof *a);
2676             a->vlan_vid.vlan_vid = htons(e->vlan);
2677             a++;
2678         }
2679         a->output.type = htons(OFPAT_OUTPUT);
2680         a->output.len = htons(sizeof *a);
2681         a->output.port = htons(odp_port_to_ofp_port(dp_ifidx));
2682         a++;
2683
2684         /* Send packet. */
2685         n_packets++;
2686         compose_benign_packet(&packet, "Open vSwitch Bond Failover", 0xf177,
2687                               e->mac);
2688         flow_extract(&packet, ODPP_NONE, &flow);
2689         retval = ofproto_send_packet(br->ofproto, &flow, actions, a - actions,
2690                                      &packet);
2691         if (retval) {
2692             error = retval;
2693             n_errors++;
2694         }
2695     }
2696     ofpbuf_uninit(&packet);
2697
2698     if (n_errors) {
2699         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2700         VLOG_WARN_RL(&rl, "bond %s: %d errors sending %d gratuitous learning "
2701                      "packets, last error was: %s",
2702                      port->name, n_errors, n_packets, strerror(error));
2703     } else {
2704         VLOG_DBG("bond %s: sent %d gratuitous learning packets",
2705                  port->name, n_packets);
2706     }
2707 }
2708 \f
2709 /* Bonding unixctl user interface functions. */
2710
2711 static void
2712 bond_unixctl_list(struct unixctl_conn *conn,
2713                   const char *args OVS_UNUSED, void *aux OVS_UNUSED)
2714 {
2715     struct ds ds = DS_EMPTY_INITIALIZER;
2716     const struct bridge *br;
2717
2718     ds_put_cstr(&ds, "bridge\tbond\tslaves\n");
2719
2720     LIST_FOR_EACH (br, struct bridge, node, &all_bridges) {
2721         size_t i;
2722
2723         for (i = 0; i < br->n_ports; i++) {
2724             const struct port *port = br->ports[i];
2725             if (port->n_ifaces > 1) {
2726                 size_t j;
2727
2728                 ds_put_format(&ds, "%s\t%s\t", br->name, port->name);
2729                 for (j = 0; j < port->n_ifaces; j++) {
2730                     const struct iface *iface = port->ifaces[j];
2731                     if (j) {
2732                         ds_put_cstr(&ds, ", ");
2733                     }
2734                     ds_put_cstr(&ds, iface->name);
2735                 }
2736                 ds_put_char(&ds, '\n');
2737             }
2738         }
2739     }
2740     unixctl_command_reply(conn, 200, ds_cstr(&ds));
2741     ds_destroy(&ds);
2742 }
2743
2744 static struct port *
2745 bond_find(const char *name)
2746 {
2747     const struct bridge *br;
2748
2749     LIST_FOR_EACH (br, struct bridge, node, &all_bridges) {
2750         size_t i;
2751
2752         for (i = 0; i < br->n_ports; i++) {
2753             struct port *port = br->ports[i];
2754             if (!strcmp(port->name, name) && port->n_ifaces > 1) {
2755                 return port;
2756             }
2757         }
2758     }
2759     return NULL;
2760 }
2761
2762 static void
2763 bond_unixctl_show(struct unixctl_conn *conn,
2764                   const char *args, void *aux OVS_UNUSED)
2765 {
2766     struct ds ds = DS_EMPTY_INITIALIZER;
2767     const struct port *port;
2768     size_t j;
2769
2770     port = bond_find(args);
2771     if (!port) {
2772         unixctl_command_reply(conn, 501, "no such bond");
2773         return;
2774     }
2775
2776     ds_put_format(&ds, "updelay: %d ms\n", port->updelay);
2777     ds_put_format(&ds, "downdelay: %d ms\n", port->downdelay);
2778     ds_put_format(&ds, "next rebalance: %lld ms\n",
2779                   port->bridge->bond_next_rebalance - time_msec());
2780     for (j = 0; j < port->n_ifaces; j++) {
2781         const struct iface *iface = port->ifaces[j];
2782         struct bond_entry *be;
2783
2784         /* Basic info. */
2785         ds_put_format(&ds, "slave %s: %s\n",
2786                       iface->name, iface->enabled ? "enabled" : "disabled");
2787         if (j == port->active_iface) {
2788             ds_put_cstr(&ds, "\tactive slave\n");
2789         }
2790         if (iface->delay_expires != LLONG_MAX) {
2791             ds_put_format(&ds, "\t%s expires in %lld ms\n",
2792                           iface->enabled ? "downdelay" : "updelay",
2793                           iface->delay_expires - time_msec());
2794         }
2795
2796         /* Hashes. */
2797         for (be = port->bond_hash; be <= &port->bond_hash[BOND_MASK]; be++) {
2798             int hash = be - port->bond_hash;
2799             struct mac_entry *me;
2800
2801             if (be->iface_idx != j) {
2802                 continue;
2803             }
2804
2805             ds_put_format(&ds, "\thash %d: %"PRIu64" kB load\n",
2806                           hash, be->tx_bytes / 1024);
2807
2808             /* MACs. */
2809             LIST_FOR_EACH (me, struct mac_entry, lru_node,
2810                            &port->bridge->ml->lrus) {
2811                 uint16_t dp_ifidx;
2812                 tag_type tags = 0;
2813                 if (bond_hash(me->mac) == hash
2814                     && me->port != port->port_idx
2815                     && choose_output_iface(port, me->mac, &dp_ifidx, &tags)
2816                     && dp_ifidx == iface->dp_ifidx)
2817                 {
2818                     ds_put_format(&ds, "\t\t"ETH_ADDR_FMT"\n",
2819                                   ETH_ADDR_ARGS(me->mac));
2820                 }
2821             }
2822         }
2823     }
2824     unixctl_command_reply(conn, 200, ds_cstr(&ds));
2825     ds_destroy(&ds);
2826 }
2827
2828 static void
2829 bond_unixctl_migrate(struct unixctl_conn *conn, const char *args_,
2830                      void *aux OVS_UNUSED)
2831 {
2832     char *args = (char *) args_;
2833     char *save_ptr = NULL;
2834     char *bond_s, *hash_s, *slave_s;
2835     uint8_t mac[ETH_ADDR_LEN];
2836     struct port *port;
2837     struct iface *iface;
2838     struct bond_entry *entry;
2839     int hash;
2840
2841     bond_s = strtok_r(args, " ", &save_ptr);
2842     hash_s = strtok_r(NULL, " ", &save_ptr);
2843     slave_s = strtok_r(NULL, " ", &save_ptr);
2844     if (!slave_s) {
2845         unixctl_command_reply(conn, 501,
2846                               "usage: bond/migrate BOND HASH SLAVE");
2847         return;
2848     }
2849
2850     port = bond_find(bond_s);
2851     if (!port) {
2852         unixctl_command_reply(conn, 501, "no such bond");
2853         return;
2854     }
2855
2856     if (sscanf(hash_s, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
2857         == ETH_ADDR_SCAN_COUNT) {
2858         hash = bond_hash(mac);
2859     } else if (strspn(hash_s, "0123456789") == strlen(hash_s)) {
2860         hash = atoi(hash_s) & BOND_MASK;
2861     } else {
2862         unixctl_command_reply(conn, 501, "bad hash");
2863         return;
2864     }
2865
2866     iface = port_lookup_iface(port, slave_s);
2867     if (!iface) {
2868         unixctl_command_reply(conn, 501, "no such slave");
2869         return;
2870     }
2871
2872     if (!iface->enabled) {
2873         unixctl_command_reply(conn, 501, "cannot migrate to disabled slave");
2874         return;
2875     }
2876
2877     entry = &port->bond_hash[hash];
2878     ofproto_revalidate(port->bridge->ofproto, entry->iface_tag);
2879     entry->iface_idx = iface->port_ifidx;
2880     entry->iface_tag = tag_create_random();
2881     port->bond_compat_is_stale = true;
2882     unixctl_command_reply(conn, 200, "migrated");
2883 }
2884
2885 static void
2886 bond_unixctl_set_active_slave(struct unixctl_conn *conn, const char *args_,
2887                               void *aux OVS_UNUSED)
2888 {
2889     char *args = (char *) args_;
2890     char *save_ptr = NULL;
2891     char *bond_s, *slave_s;
2892     struct port *port;
2893     struct iface *iface;
2894
2895     bond_s = strtok_r(args, " ", &save_ptr);
2896     slave_s = strtok_r(NULL, " ", &save_ptr);
2897     if (!slave_s) {
2898         unixctl_command_reply(conn, 501,
2899                               "usage: bond/set-active-slave BOND SLAVE");
2900         return;
2901     }
2902
2903     port = bond_find(bond_s);
2904     if (!port) {
2905         unixctl_command_reply(conn, 501, "no such bond");
2906         return;
2907     }
2908
2909     iface = port_lookup_iface(port, slave_s);
2910     if (!iface) {
2911         unixctl_command_reply(conn, 501, "no such slave");
2912         return;
2913     }
2914
2915     if (!iface->enabled) {
2916         unixctl_command_reply(conn, 501, "cannot make disabled slave active");
2917         return;
2918     }
2919
2920     if (port->active_iface != iface->port_ifidx) {
2921         ofproto_revalidate(port->bridge->ofproto, port->active_iface_tag);
2922         port->active_iface = iface->port_ifidx;
2923         port->active_iface_tag = tag_create_random();
2924         VLOG_INFO("port %s: active interface is now %s",
2925                   port->name, iface->name);
2926         bond_send_learning_packets(port);
2927         unixctl_command_reply(conn, 200, "done");
2928     } else {
2929         unixctl_command_reply(conn, 200, "no change");
2930     }
2931 }
2932
2933 static void
2934 enable_slave(struct unixctl_conn *conn, const char *args_, bool enable)
2935 {
2936     char *args = (char *) args_;
2937     char *save_ptr = NULL;
2938     char *bond_s, *slave_s;
2939     struct port *port;
2940     struct iface *iface;
2941
2942     bond_s = strtok_r(args, " ", &save_ptr);
2943     slave_s = strtok_r(NULL, " ", &save_ptr);
2944     if (!slave_s) {
2945         unixctl_command_reply(conn, 501,
2946                               "usage: bond/enable/disable-slave BOND SLAVE");
2947         return;
2948     }
2949
2950     port = bond_find(bond_s);
2951     if (!port) {
2952         unixctl_command_reply(conn, 501, "no such bond");
2953         return;
2954     }
2955
2956     iface = port_lookup_iface(port, slave_s);
2957     if (!iface) {
2958         unixctl_command_reply(conn, 501, "no such slave");
2959         return;
2960     }
2961
2962     bond_enable_slave(iface, enable);
2963     unixctl_command_reply(conn, 501, enable ? "enabled" : "disabled");
2964 }
2965
2966 static void
2967 bond_unixctl_enable_slave(struct unixctl_conn *conn, const char *args,
2968                           void *aux OVS_UNUSED)
2969 {
2970     enable_slave(conn, args, true);
2971 }
2972
2973 static void
2974 bond_unixctl_disable_slave(struct unixctl_conn *conn, const char *args,
2975                            void *aux OVS_UNUSED)
2976 {
2977     enable_slave(conn, args, false);
2978 }
2979
2980 static void
2981 bond_unixctl_hash(struct unixctl_conn *conn, const char *args,
2982                   void *aux OVS_UNUSED)
2983 {
2984         uint8_t mac[ETH_ADDR_LEN];
2985         uint8_t hash;
2986         char *hash_cstr;
2987
2988         if (sscanf(args, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
2989             == ETH_ADDR_SCAN_COUNT) {
2990                 hash = bond_hash(mac);
2991
2992                 hash_cstr = xasprintf("%u", hash);
2993                 unixctl_command_reply(conn, 200, hash_cstr);
2994                 free(hash_cstr);
2995         } else {
2996                 unixctl_command_reply(conn, 501, "invalid mac");
2997         }
2998 }
2999
3000 static void
3001 bond_init(void)
3002 {
3003     unixctl_command_register("bond/list", bond_unixctl_list, NULL);
3004     unixctl_command_register("bond/show", bond_unixctl_show, NULL);
3005     unixctl_command_register("bond/migrate", bond_unixctl_migrate, NULL);
3006     unixctl_command_register("bond/set-active-slave",
3007                              bond_unixctl_set_active_slave, NULL);
3008     unixctl_command_register("bond/enable-slave", bond_unixctl_enable_slave,
3009                              NULL);
3010     unixctl_command_register("bond/disable-slave", bond_unixctl_disable_slave,
3011                              NULL);
3012     unixctl_command_register("bond/hash", bond_unixctl_hash, NULL);
3013 }
3014 \f
3015 /* Port functions. */
3016
3017 static struct port *
3018 port_create(struct bridge *br, const char *name)
3019 {
3020     struct port *port;
3021
3022     port = xzalloc(sizeof *port);
3023     port->bridge = br;
3024     port->port_idx = br->n_ports;
3025     port->vlan = -1;
3026     port->trunks = NULL;
3027     port->name = xstrdup(name);
3028     port->active_iface = -1;
3029
3030     if (br->n_ports >= br->allocated_ports) {
3031         br->ports = x2nrealloc(br->ports, &br->allocated_ports,
3032                                sizeof *br->ports);
3033     }
3034     br->ports[br->n_ports++] = port;
3035
3036     VLOG_INFO("created port %s on bridge %s", port->name, br->name);
3037     bridge_flush(br);
3038
3039     return port;
3040 }
3041
3042 static void
3043 port_reconfigure(struct port *port, const struct ovsrec_port *cfg)
3044 {
3045     struct shash old_ifaces, new_ifaces;
3046     struct shash_node *node;
3047     unsigned long *trunks;
3048     int vlan;
3049     size_t i;
3050
3051     port->cfg = cfg;
3052
3053     /* Collect old and new interfaces. */
3054     shash_init(&old_ifaces);
3055     shash_init(&new_ifaces);
3056     for (i = 0; i < port->n_ifaces; i++) {
3057         shash_add(&old_ifaces, port->ifaces[i]->name, port->ifaces[i]);
3058     }
3059     for (i = 0; i < cfg->n_interfaces; i++) {
3060         const char *name = cfg->interfaces[i]->name;
3061         if (!shash_add_once(&new_ifaces, name, cfg->interfaces[i])) {
3062             VLOG_WARN("port %s: %s specified twice as port interface",
3063                       port->name, name);
3064         }
3065     }
3066     port->updelay = cfg->bond_updelay;
3067     if (port->updelay < 0) {
3068         port->updelay = 0;
3069     }
3070     port->updelay = cfg->bond_downdelay;
3071     if (port->downdelay < 0) {
3072         port->downdelay = 0;
3073     }
3074
3075     /* Get rid of deleted interfaces and add new interfaces. */
3076     SHASH_FOR_EACH (node, &old_ifaces) {
3077         if (!shash_find(&new_ifaces, node->name)) {
3078             iface_destroy(node->data);
3079         }
3080     }
3081     SHASH_FOR_EACH (node, &new_ifaces) {
3082         const struct ovsrec_interface *if_cfg = node->data;
3083         struct iface *iface;
3084
3085         iface = shash_find_data(&old_ifaces, if_cfg->name);
3086         if (!iface) {
3087             iface_create(port, if_cfg);
3088         } else {
3089             iface->cfg = if_cfg;
3090         }
3091     }
3092
3093     /* Get VLAN tag. */
3094     vlan = -1;
3095     if (cfg->tag) {
3096         if (port->n_ifaces < 2) {
3097             vlan = *cfg->tag;
3098             if (vlan >= 0 && vlan <= 4095) {
3099                 VLOG_DBG("port %s: assigning VLAN tag %d", port->name, vlan);
3100             } else {
3101                 vlan = -1;
3102             }
3103         } else {
3104             /* It's possible that bonded, VLAN-tagged ports make sense.  Maybe
3105              * they even work as-is.  But they have not been tested. */
3106             VLOG_WARN("port %s: VLAN tags not supported on bonded ports",
3107                       port->name);
3108         }
3109     }
3110     if (port->vlan != vlan) {
3111         port->vlan = vlan;
3112         bridge_flush(port->bridge);
3113     }
3114
3115     /* Get trunked VLANs. */
3116     trunks = NULL;
3117     if (vlan < 0) {
3118         size_t n_errors;
3119         size_t i;
3120
3121         trunks = bitmap_allocate(4096);
3122         n_errors = 0;
3123         for (i = 0; i < cfg->n_trunks; i++) {
3124             int trunk = cfg->trunks[i];
3125             if (trunk >= 0) {
3126                 bitmap_set1(trunks, trunk);
3127             } else {
3128                 n_errors++;
3129             }
3130         }
3131         if (n_errors) {
3132             VLOG_ERR("port %s: invalid values for %zu trunk VLANs",
3133                      port->name, cfg->n_trunks);
3134         }
3135         if (n_errors == cfg->n_trunks) {
3136             if (n_errors) {
3137                 VLOG_ERR("port %s: no valid trunks, trunking all VLANs",
3138                          port->name);
3139             }
3140             bitmap_set_multiple(trunks, 0, 4096, 1);
3141         }
3142     } else {
3143         if (cfg->n_trunks) {
3144             VLOG_ERR("port %s: ignoring trunks in favor of implicit vlan",
3145                      port->name);
3146         }
3147     }
3148     if (trunks == NULL
3149         ? port->trunks != NULL
3150         : port->trunks == NULL || !bitmap_equal(trunks, port->trunks, 4096)) {
3151         bridge_flush(port->bridge);
3152     }
3153     bitmap_free(port->trunks);
3154     port->trunks = trunks;
3155
3156     shash_destroy(&old_ifaces);
3157     shash_destroy(&new_ifaces);
3158 }
3159
3160 static void
3161 port_destroy(struct port *port)
3162 {
3163     if (port) {
3164         struct bridge *br = port->bridge;
3165         struct port *del;
3166         int i;
3167
3168         proc_net_compat_update_vlan(port->name, NULL, 0);
3169         proc_net_compat_update_bond(port->name, NULL);
3170
3171         for (i = 0; i < MAX_MIRRORS; i++) {
3172             struct mirror *m = br->mirrors[i];
3173             if (m && m->out_port == port) {
3174                 mirror_destroy(m);
3175             }
3176         }
3177
3178         while (port->n_ifaces > 0) {
3179             iface_destroy(port->ifaces[port->n_ifaces - 1]);
3180         }
3181
3182         del = br->ports[port->port_idx] = br->ports[--br->n_ports];
3183         del->port_idx = port->port_idx;
3184
3185         free(port->ifaces);
3186         bitmap_free(port->trunks);
3187         free(port->name);
3188         free(port);
3189         bridge_flush(br);
3190     }
3191 }
3192
3193 static struct port *
3194 port_from_dp_ifidx(const struct bridge *br, uint16_t dp_ifidx)
3195 {
3196     struct iface *iface = iface_from_dp_ifidx(br, dp_ifidx);
3197     return iface ? iface->port : NULL;
3198 }
3199
3200 static struct port *
3201 port_lookup(const struct bridge *br, const char *name)
3202 {
3203     size_t i;
3204
3205     for (i = 0; i < br->n_ports; i++) {
3206         struct port *port = br->ports[i];
3207         if (!strcmp(port->name, name)) {
3208             return port;
3209         }
3210     }
3211     return NULL;
3212 }
3213
3214 static struct iface *
3215 port_lookup_iface(const struct port *port, const char *name)
3216 {
3217     size_t j;
3218
3219     for (j = 0; j < port->n_ifaces; j++) {
3220         struct iface *iface = port->ifaces[j];
3221         if (!strcmp(iface->name, name)) {
3222             return iface;
3223         }
3224     }
3225     return NULL;
3226 }
3227
3228 static void
3229 port_update_bonding(struct port *port)
3230 {
3231     if (port->n_ifaces < 2) {
3232         /* Not a bonded port. */
3233         if (port->bond_hash) {
3234             free(port->bond_hash);
3235             port->bond_hash = NULL;
3236             port->bond_compat_is_stale = true;
3237             port->bond_fake_iface = false;
3238         }
3239     } else {
3240         if (!port->bond_hash) {
3241             size_t i;
3242
3243             port->bond_hash = xcalloc(BOND_MASK + 1, sizeof *port->bond_hash);
3244             for (i = 0; i <= BOND_MASK; i++) {
3245                 struct bond_entry *e = &port->bond_hash[i];
3246                 e->iface_idx = -1;
3247                 e->tx_bytes = 0;
3248             }
3249             port->no_ifaces_tag = tag_create_random();
3250             bond_choose_active_iface(port);
3251         }
3252         port->bond_compat_is_stale = true;
3253         port->bond_fake_iface = port->cfg->bond_fake_iface;
3254     }
3255 }
3256
3257 static void
3258 port_update_bond_compat(struct port *port)
3259 {
3260     struct compat_bond_hash compat_hashes[BOND_MASK + 1];
3261     struct compat_bond bond;
3262     size_t i;
3263
3264     if (port->n_ifaces < 2) {
3265         proc_net_compat_update_bond(port->name, NULL);
3266         return;
3267     }
3268
3269     bond.up = false;
3270     bond.updelay = port->updelay;
3271     bond.downdelay = port->downdelay;
3272
3273     bond.n_hashes = 0;
3274     bond.hashes = compat_hashes;
3275     if (port->bond_hash) {
3276         const struct bond_entry *e;
3277         for (e = port->bond_hash; e <= &port->bond_hash[BOND_MASK]; e++) {
3278             if (e->iface_idx >= 0 && e->iface_idx < port->n_ifaces) {
3279                 struct compat_bond_hash *cbh = &bond.hashes[bond.n_hashes++];
3280                 cbh->hash = e - port->bond_hash;
3281                 cbh->netdev_name = port->ifaces[e->iface_idx]->name;
3282             }
3283         }
3284     }
3285
3286     bond.n_slaves = port->n_ifaces;
3287     bond.slaves = xmalloc(port->n_ifaces * sizeof *bond.slaves);
3288     for (i = 0; i < port->n_ifaces; i++) {
3289         struct iface *iface = port->ifaces[i];
3290         struct compat_bond_slave *slave = &bond.slaves[i];
3291         slave->name = iface->name;
3292
3293         /* We need to make the same determination as the Linux bonding
3294          * code to determine whether a slave should be consider "up".
3295          * The Linux function bond_miimon_inspect() supports four 
3296          * BOND_LINK_* states:
3297          *      
3298          *    - BOND_LINK_UP: carrier detected, updelay has passed.
3299          *    - BOND_LINK_FAIL: carrier lost, downdelay in progress.
3300          *    - BOND_LINK_DOWN: carrier lost, downdelay has passed.
3301          *    - BOND_LINK_BACK: carrier detected, updelay in progress.
3302          *
3303          * The function bond_info_show_slave() only considers BOND_LINK_UP 
3304          * to be "up" and anything else to be "down".
3305          */
3306         slave->up = iface->enabled && iface->delay_expires == LLONG_MAX;
3307         if (slave->up) {
3308             bond.up = true;
3309         }
3310         netdev_get_etheraddr(iface->netdev, slave->mac);
3311     }
3312
3313     if (port->bond_fake_iface) {
3314         struct netdev *bond_netdev;
3315
3316         if (!netdev_open_default(port->name, &bond_netdev)) {
3317             if (bond.up) {
3318                 netdev_turn_flags_on(bond_netdev, NETDEV_UP, true);
3319             } else {
3320                 netdev_turn_flags_off(bond_netdev, NETDEV_UP, true);
3321             }
3322             netdev_close(bond_netdev);
3323         }
3324     }
3325
3326     proc_net_compat_update_bond(port->name, &bond);
3327     free(bond.slaves);
3328 }
3329
3330 static void
3331 port_update_vlan_compat(struct port *port)
3332 {
3333     struct bridge *br = port->bridge;
3334     char *vlandev_name = NULL;
3335
3336     if (port->vlan > 0) {
3337         /* Figure out the name that the VLAN device should actually have, if it
3338          * existed.  This takes some work because the VLAN device would not
3339          * have port->name in its name; rather, it would have the trunk port's
3340          * name, and 'port' would be attached to a bridge that also had the
3341          * VLAN device one of its ports.  So we need to find a trunk port that
3342          * includes port->vlan.
3343          *
3344          * There might be more than one candidate.  This doesn't happen on
3345          * XenServer, so if it happens we just pick the first choice in
3346          * alphabetical order instead of creating multiple VLAN devices. */
3347         size_t i;
3348         for (i = 0; i < br->n_ports; i++) {
3349             struct port *p = br->ports[i];
3350             if (port_trunks_vlan(p, port->vlan)
3351                 && p->n_ifaces
3352                 && (!vlandev_name || strcmp(p->name, vlandev_name) <= 0))
3353             {
3354                 uint8_t ea[ETH_ADDR_LEN];
3355                 netdev_get_etheraddr(p->ifaces[0]->netdev, ea);
3356                 if (!eth_addr_is_multicast(ea) &&
3357                     !eth_addr_is_reserved(ea) &&
3358                     !eth_addr_is_zero(ea)) {
3359                     vlandev_name = p->name;
3360                 }
3361             }
3362         }
3363     }
3364     proc_net_compat_update_vlan(port->name, vlandev_name, port->vlan);
3365 }
3366 \f
3367 /* Interface functions. */
3368
3369 static struct iface *
3370 iface_create(struct port *port, const struct ovsrec_interface *if_cfg)
3371 {
3372     struct iface *iface;
3373     char *name = if_cfg->name;
3374     int error;
3375
3376     iface = xzalloc(sizeof *iface);
3377     iface->port = port;
3378     iface->port_ifidx = port->n_ifaces;
3379     iface->name = xstrdup(name);
3380     iface->dp_ifidx = -1;
3381     iface->tag = tag_create_random();
3382     iface->delay_expires = LLONG_MAX;
3383     iface->netdev = NULL;
3384     iface->cfg = if_cfg;
3385
3386     if (port->n_ifaces >= port->allocated_ifaces) {
3387         port->ifaces = x2nrealloc(port->ifaces, &port->allocated_ifaces,
3388                                   sizeof *port->ifaces);
3389     }
3390     port->ifaces[port->n_ifaces++] = iface;
3391     if (port->n_ifaces > 1) {
3392         port->bridge->has_bonded_ports = true;
3393     }
3394
3395     /* Attempt to create the network interface in case it
3396      * doesn't exist yet. */
3397     if (!iface_is_internal(port->bridge, iface->name)) {
3398         error = set_up_iface(if_cfg, iface, true);
3399         if (error) {
3400             VLOG_WARN("could not create iface %s: %s", iface->name,
3401                     strerror(error));
3402         }
3403     }
3404
3405     VLOG_DBG("attached network device %s to port %s", iface->name, port->name);
3406
3407     bridge_flush(port->bridge);
3408
3409     return iface;
3410 }
3411
3412 static void
3413 iface_destroy(struct iface *iface)
3414 {
3415     if (iface) {
3416         struct port *port = iface->port;
3417         struct bridge *br = port->bridge;
3418         bool del_active = port->active_iface == iface->port_ifidx;
3419         struct iface *del;
3420
3421         if (iface->dp_ifidx >= 0) {
3422             port_array_set(&br->ifaces, iface->dp_ifidx, NULL);
3423         }
3424
3425         del = port->ifaces[iface->port_ifidx] = port->ifaces[--port->n_ifaces];
3426         del->port_ifidx = iface->port_ifidx;
3427
3428         netdev_close(iface->netdev);
3429
3430         if (del_active) {
3431             ofproto_revalidate(port->bridge->ofproto, port->active_iface_tag);
3432             bond_choose_active_iface(port);
3433             bond_send_learning_packets(port);
3434         }
3435
3436         free(iface->name);
3437         free(iface);
3438
3439         bridge_flush(port->bridge);
3440     }
3441 }
3442
3443 static struct iface *
3444 iface_lookup(const struct bridge *br, const char *name)
3445 {
3446     size_t i, j;
3447
3448     for (i = 0; i < br->n_ports; i++) {
3449         struct port *port = br->ports[i];
3450         for (j = 0; j < port->n_ifaces; j++) {
3451             struct iface *iface = port->ifaces[j];
3452             if (!strcmp(iface->name, name)) {
3453                 return iface;
3454             }
3455         }
3456     }
3457     return NULL;
3458 }
3459
3460 static struct iface *
3461 iface_from_dp_ifidx(const struct bridge *br, uint16_t dp_ifidx)
3462 {
3463     return port_array_get(&br->ifaces, dp_ifidx);
3464 }
3465
3466 /* Returns true if 'iface' is the name of an "internal" interface on bridge
3467  * 'br', that is, an interface that is entirely simulated within the datapath.
3468  * The local port (ODPP_LOCAL) is always an internal interface.  Other local
3469  * interfaces are created by setting "iface.<iface>.internal = true".
3470  *
3471  * In addition, we have a kluge-y feature that creates an internal port with
3472  * the name of a bonded port if "bonding.<bondname>.fake-iface = true" is set.
3473  * This feature needs to go away in the long term.  Until then, this is one
3474  * reason why this function takes a name instead of a struct iface: the fake
3475  * interfaces created this way do not have a struct iface. */
3476 static bool
3477 iface_is_internal(const struct bridge *br, const char *if_name)
3478 {
3479     /* XXX wastes time */
3480     struct iface *iface;
3481     struct port *port;
3482
3483     if (!strcmp(if_name, br->name)) {
3484         return true;
3485     }
3486
3487     iface = iface_lookup(br, if_name);
3488     if (iface && !strcmp(iface->cfg->type, "internal")) {
3489         return true;
3490     }
3491
3492     port = port_lookup(br, if_name);
3493     if (port && port->n_ifaces > 1 && port->cfg->bond_fake_iface) {
3494         return true;
3495     }
3496     return false;
3497 }
3498
3499 /* Set Ethernet address of 'iface', if one is specified in the configuration
3500  * file. */
3501 static void
3502 iface_set_mac(struct iface *iface)
3503 {
3504     uint8_t ea[ETH_ADDR_LEN];
3505
3506     if (iface->cfg->mac && eth_addr_from_string(iface->cfg->mac, ea)) {
3507         if (eth_addr_is_multicast(ea)) {
3508             VLOG_ERR("interface %s: cannot set MAC to multicast address",
3509                      iface->name);
3510         } else if (iface->dp_ifidx == ODPP_LOCAL) {
3511             VLOG_ERR("ignoring iface.%s.mac; use bridge.%s.mac instead",
3512                      iface->name, iface->name);
3513         } else {
3514             int error = netdev_set_etheraddr(iface->netdev, ea);
3515             if (error) {
3516                 VLOG_ERR("interface %s: setting MAC failed (%s)",
3517                          iface->name, strerror(error));
3518             }
3519         }
3520     }
3521 }
3522 \f
3523 /* Port mirroring. */
3524
3525 static void
3526 mirror_reconfigure(struct bridge *br)
3527 {
3528     struct shash old_mirrors, new_mirrors;
3529     struct shash_node *node;
3530     unsigned long *rspan_vlans;
3531     int i;
3532
3533     /* Collect old mirrors. */
3534     shash_init(&old_mirrors);
3535     for (i = 0; i < MAX_MIRRORS; i++) {
3536         if (br->mirrors[i]) {
3537             shash_add(&old_mirrors, br->mirrors[i]->name, br->mirrors[i]);
3538         }
3539     }
3540
3541     /* Collect new mirrors. */
3542     shash_init(&new_mirrors);
3543     for (i = 0; i < br->cfg->n_mirrors; i++) {
3544         struct ovsrec_mirror *cfg = br->cfg->mirrors[i];
3545         if (!shash_add_once(&new_mirrors, cfg->name, cfg)) {
3546             VLOG_WARN("bridge %s: %s specified twice as mirror",
3547                       br->name, cfg->name);
3548         }
3549     }
3550
3551     /* Get rid of deleted mirrors and add new mirrors. */
3552     SHASH_FOR_EACH (node, &old_mirrors) {
3553         if (!shash_find(&new_mirrors, node->name)) {
3554             mirror_destroy(node->data);
3555         }
3556     }
3557     SHASH_FOR_EACH (node, &new_mirrors) {
3558         struct mirror *mirror = shash_find_data(&old_mirrors, node->name);
3559         if (!mirror) {
3560             mirror = mirror_create(br, node->name);
3561             if (!mirror) {
3562                 break;
3563             }
3564         }
3565         mirror_reconfigure_one(mirror, node->data);
3566     }
3567     shash_destroy(&old_mirrors);
3568     shash_destroy(&new_mirrors);
3569
3570     /* Update port reserved status. */
3571     for (i = 0; i < br->n_ports; i++) {
3572         br->ports[i]->is_mirror_output_port = false;
3573     }
3574     for (i = 0; i < MAX_MIRRORS; i++) {
3575         struct mirror *m = br->mirrors[i];
3576         if (m && m->out_port) {
3577             m->out_port->is_mirror_output_port = true;
3578         }
3579     }
3580
3581     /* Update flooded vlans (for RSPAN). */
3582     rspan_vlans = NULL;
3583     if (br->cfg->n_flood_vlans) {
3584         rspan_vlans = bitmap_allocate(4096);
3585
3586         for (i = 0; i < br->cfg->n_flood_vlans; i++) {
3587             int64_t vlan = br->cfg->flood_vlans[i];
3588             if (vlan >= 0 && vlan < 4096) {
3589                 bitmap_set1(rspan_vlans, vlan);
3590                 VLOG_INFO("bridge %s: disabling learning on vlan %"PRId64,
3591                           br->name, vlan);
3592             } else {
3593                 VLOG_ERR("bridge %s: invalid value %"PRId64 "for flood VLAN",
3594                          br->name, vlan);
3595             }
3596         }
3597     }
3598     if (mac_learning_set_flood_vlans(br->ml, rspan_vlans)) {
3599         bridge_flush(br);
3600     }
3601 }
3602
3603 static struct mirror *
3604 mirror_create(struct bridge *br, const char *name)
3605 {
3606     struct mirror *m;
3607     size_t i;
3608
3609     for (i = 0; ; i++) {
3610         if (i >= MAX_MIRRORS) {
3611             VLOG_WARN("bridge %s: maximum of %d port mirrors reached, "
3612                       "cannot create %s", br->name, MAX_MIRRORS, name);
3613             return NULL;
3614         }
3615         if (!br->mirrors[i]) {
3616             break;
3617         }
3618     }
3619
3620     VLOG_INFO("created port mirror %s on bridge %s", name, br->name);
3621     bridge_flush(br);
3622
3623     br->mirrors[i] = m = xzalloc(sizeof *m);
3624     m->bridge = br;
3625     m->idx = i;
3626     m->name = xstrdup(name);
3627     shash_init(&m->src_ports);
3628     shash_init(&m->dst_ports);
3629     m->vlans = NULL;
3630     m->n_vlans = 0;
3631     m->out_vlan = -1;
3632     m->out_port = NULL;
3633
3634     return m;
3635 }
3636
3637 static void
3638 mirror_destroy(struct mirror *m)
3639 {
3640     if (m) {
3641         struct bridge *br = m->bridge;
3642         size_t i;
3643
3644         for (i = 0; i < br->n_ports; i++) {
3645             br->ports[i]->src_mirrors &= ~(MIRROR_MASK_C(1) << m->idx);
3646             br->ports[i]->dst_mirrors &= ~(MIRROR_MASK_C(1) << m->idx);
3647         }
3648
3649         shash_destroy(&m->src_ports);
3650         shash_destroy(&m->dst_ports);
3651         free(m->vlans);
3652
3653         m->bridge->mirrors[m->idx] = NULL;
3654         free(m);
3655
3656         bridge_flush(br);
3657     }
3658 }
3659
3660 static void
3661 mirror_collect_ports(struct mirror *m, struct ovsrec_port **ports, int n_ports,
3662                      struct shash *names)
3663 {
3664     size_t i;
3665
3666     for (i = 0; i < n_ports; i++) {
3667         const char *name = ports[i]->name;
3668         if (port_lookup(m->bridge, name)) {
3669             shash_add_once(names, name, NULL);
3670         } else {
3671             VLOG_WARN("bridge %s: mirror %s cannot match on nonexistent "
3672                       "port %s", m->bridge->name, m->name, name);
3673         }
3674     }
3675 }
3676
3677 static size_t
3678 mirror_collect_vlans(struct mirror *m, const struct ovsrec_mirror *cfg,
3679                      int **vlans)
3680 {
3681     size_t n_vlans;
3682     size_t i;
3683
3684     *vlans = xmalloc(sizeof **vlans * cfg->n_select_vlan);
3685     n_vlans = 0;
3686     for (i = 0; i < cfg->n_select_vlan; i++) {
3687         int64_t vlan = cfg->select_vlan[i];
3688         if (vlan < 0 || vlan > 4095) {
3689             VLOG_WARN("bridge %s: mirror %s selects invalid VLAN %"PRId64,
3690                       m->bridge->name, m->name, vlan);
3691         } else {
3692             (*vlans)[n_vlans++] = vlan;
3693         }
3694     }
3695     return n_vlans;
3696 }
3697
3698 static bool
3699 vlan_is_mirrored(const struct mirror *m, int vlan)
3700 {
3701     size_t i;
3702
3703     for (i = 0; i < m->n_vlans; i++) {
3704         if (m->vlans[i] == vlan) {
3705             return true;
3706         }
3707     }
3708     return false;
3709 }
3710
3711 static bool
3712 port_trunks_any_mirrored_vlan(const struct mirror *m, const struct port *p)
3713 {
3714     size_t i;
3715
3716     for (i = 0; i < m->n_vlans; i++) {
3717         if (port_trunks_vlan(p, m->vlans[i])) {
3718             return true;
3719         }
3720     }
3721     return false;
3722 }
3723
3724 static void
3725 mirror_reconfigure_one(struct mirror *m, struct ovsrec_mirror *cfg)
3726 {
3727     struct shash src_ports, dst_ports;
3728     mirror_mask_t mirror_bit;
3729     struct port *out_port;
3730     int out_vlan;
3731     size_t n_vlans;
3732     int *vlans;
3733     size_t i;
3734     bool mirror_all_ports;
3735     bool any_ports_specified;
3736     bool any_vlans_specified;
3737
3738     /* Get output port. */
3739     if (cfg->output_port) {
3740         out_port = port_lookup(m->bridge, cfg->output_port->name);
3741         if (!out_port) {
3742             VLOG_ERR("bridge %s: mirror %s outputs to port not on bridge",
3743                      m->bridge->name, m->name);
3744             mirror_destroy(m);
3745             return;
3746         }
3747         out_vlan = -1;
3748
3749         if (cfg->output_vlan) {
3750             VLOG_ERR("bridge %s: mirror %s specifies both output port and "
3751                      "output vlan; ignoring output vlan",
3752                      m->bridge->name, m->name);
3753         }
3754     } else if (cfg->output_vlan) {
3755         out_port = NULL;
3756         out_vlan = *cfg->output_vlan;
3757     } else {
3758         VLOG_ERR("bridge %s: mirror %s does not specify output; ignoring",
3759                  m->bridge->name, m->name);
3760         mirror_destroy(m);
3761         return;
3762     }
3763
3764     /* Get all the ports, and drop duplicates and ports that don't exist. */
3765     shash_init(&src_ports);
3766     shash_init(&dst_ports);
3767     mirror_collect_ports(m, cfg->select_src_port, cfg->n_select_src_port,
3768                          &src_ports);
3769     mirror_collect_ports(m, cfg->select_dst_port, cfg->n_select_dst_port,
3770                          &dst_ports);
3771     any_ports_specified = cfg->n_select_dst_port || cfg->n_select_dst_port;
3772     if (any_ports_specified
3773         && shash_is_empty(&src_ports) && shash_is_empty(&dst_ports)) {
3774         VLOG_ERR("bridge %s: disabling mirror %s since none of the specified "
3775                  "selection ports exists", m->bridge->name, m->name);
3776         mirror_destroy(m);
3777         goto exit;
3778     }
3779
3780     /* Get all the vlans, and drop duplicate and invalid vlans. */
3781     n_vlans = mirror_collect_vlans(m, cfg, &vlans);
3782     any_vlans_specified = cfg->n_select_vlan > 0;
3783     if (any_vlans_specified && !n_vlans) {
3784         VLOG_ERR("bridge %s: disabling mirror %s since none of the specified "
3785                  "VLANs exists", m->bridge->name, m->name);
3786         mirror_destroy(m);
3787         goto exit;
3788     }
3789
3790     /* Update mirror data. */
3791     if (!shash_equal_keys(&m->src_ports, &src_ports)
3792         || !shash_equal_keys(&m->dst_ports, &dst_ports)
3793         || m->n_vlans != n_vlans
3794         || memcmp(m->vlans, vlans, sizeof *vlans * n_vlans)
3795         || m->out_port != out_port
3796         || m->out_vlan != out_vlan) {
3797         bridge_flush(m->bridge);
3798     }
3799     shash_swap(&m->src_ports, &src_ports);
3800     shash_swap(&m->dst_ports, &dst_ports);
3801     free(m->vlans);
3802     m->vlans = vlans;
3803     m->n_vlans = n_vlans;
3804     m->out_port = out_port;
3805     m->out_vlan = out_vlan;
3806
3807     /* If no selection criteria have been given, mirror for all ports. */
3808     mirror_all_ports = !any_ports_specified && !any_vlans_specified;
3809
3810     /* Update ports. */
3811     mirror_bit = MIRROR_MASK_C(1) << m->idx;
3812     for (i = 0; i < m->bridge->n_ports; i++) {
3813         struct port *port = m->bridge->ports[i];
3814
3815         if (mirror_all_ports
3816             || shash_find(&m->src_ports, port->name)
3817             || (m->n_vlans
3818                 && (!port->vlan
3819                     ? port_trunks_any_mirrored_vlan(m, port)
3820                     : vlan_is_mirrored(m, port->vlan)))) {
3821             port->src_mirrors |= mirror_bit;
3822         } else {
3823             port->src_mirrors &= ~mirror_bit;
3824         }
3825
3826         if (mirror_all_ports || shash_find(&m->dst_ports, port->name)) {
3827             port->dst_mirrors |= mirror_bit;
3828         } else {
3829             port->dst_mirrors &= ~mirror_bit;
3830         }
3831     }
3832
3833     /* Clean up. */
3834 exit:
3835     shash_destroy(&src_ports);
3836     shash_destroy(&dst_ports);
3837 }