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