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