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