bridge: Improve comment.
[sliver-openvswitch.git] / vswitchd / bridge.c
1 /* Copyright (c) 2008, 2009, 2010, 2011 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 "byte-order.h"
19 #include <assert.h>
20 #include <errno.h>
21 #include <arpa/inet.h>
22 #include <ctype.h>
23 #include <inttypes.h>
24 #include <sys/socket.h>
25 #include <net/if.h>
26 #include <openflow/openflow.h>
27 #include <signal.h>
28 #include <stdlib.h>
29 #include <strings.h>
30 #include <sys/stat.h>
31 #include <sys/socket.h>
32 #include <sys/types.h>
33 #include <unistd.h>
34 #include "bitmap.h"
35 #include "cfm.h"
36 #include "classifier.h"
37 #include "coverage.h"
38 #include "daemon.h"
39 #include "dirs.h"
40 #include "dpif.h"
41 #include "dynamic-string.h"
42 #include "flow.h"
43 #include "hash.h"
44 #include "hmap.h"
45 #include "jsonrpc.h"
46 #include "lacp.h"
47 #include "list.h"
48 #include "mac-learning.h"
49 #include "netdev.h"
50 #include "netlink.h"
51 #include "odp-util.h"
52 #include "ofp-print.h"
53 #include "ofpbuf.h"
54 #include "ofproto/netflow.h"
55 #include "ofproto/ofproto.h"
56 #include "ovsdb-data.h"
57 #include "packets.h"
58 #include "poll-loop.h"
59 #include "process.h"
60 #include "sha1.h"
61 #include "shash.h"
62 #include "socket-util.h"
63 #include "stream-ssl.h"
64 #include "sset.h"
65 #include "svec.h"
66 #include "system-stats.h"
67 #include "timeval.h"
68 #include "util.h"
69 #include "unixctl.h"
70 #include "vconn.h"
71 #include "vswitchd/vswitch-idl.h"
72 #include "xenserver.h"
73 #include "vlog.h"
74 #include "sflow_api.h"
75
76 VLOG_DEFINE_THIS_MODULE(bridge);
77
78 COVERAGE_DEFINE(bridge_flush);
79 COVERAGE_DEFINE(bridge_process_flow);
80 COVERAGE_DEFINE(bridge_process_cfm);
81 COVERAGE_DEFINE(bridge_process_lacp);
82 COVERAGE_DEFINE(bridge_reconfigure);
83 COVERAGE_DEFINE(bridge_lacp_update);
84
85 struct dst {
86     uint16_t vlan;
87     uint16_t dp_ifidx;
88 };
89
90 struct dst_set {
91     struct dst builtin[32];
92     struct dst *dsts;
93     size_t n, allocated;
94 };
95
96 static void dst_set_init(struct dst_set *);
97 static void dst_set_add(struct dst_set *, const struct dst *);
98 static void dst_set_free(struct dst_set *);
99
100 struct iface {
101     /* These members are always valid. */
102     struct list port_elem;      /* Element in struct port's "ifaces" list. */
103     struct port *port;          /* Containing port. */
104     char *name;                 /* Host network device name. */
105     tag_type tag;               /* Tag associated with this interface. */
106     long long delay_expires;    /* Time after which 'enabled' may change. */
107
108     /* These members are valid only after bridge_reconfigure() causes them to
109      * be initialized. */
110     struct hmap_node dp_ifidx_node; /* In struct bridge's "ifaces" hmap. */
111     int dp_ifidx;               /* Index within kernel datapath. */
112     struct netdev *netdev;      /* Network device. */
113     bool enabled;               /* May be chosen for flows? */
114     bool up;                    /* Is the interface up? */
115     const char *type;           /* Usually same as cfg->type. */
116     const struct ovsrec_interface *cfg;
117 };
118
119 #define BOND_MASK 0xff
120 struct bond_entry {
121     struct iface *iface;        /* Assigned iface, or NULL if none. */
122     uint64_t tx_bytes;          /* Count of bytes recently transmitted. */
123     tag_type tag;               /* Tag for bond_entry<->iface association. */
124 };
125
126 enum bond_mode {
127     BM_TCP, /* Transport Layer Load Balance. */
128     BM_SLB, /* Source Load Balance. */
129     BM_AB   /* Active Backup. */
130 };
131
132 #define MAX_MIRRORS 32
133 typedef uint32_t mirror_mask_t;
134 #define MIRROR_MASK_C(X) UINT32_C(X)
135 BUILD_ASSERT_DECL(sizeof(mirror_mask_t) * CHAR_BIT >= MAX_MIRRORS);
136 struct mirror {
137     struct bridge *bridge;
138     size_t idx;
139     char *name;
140     struct uuid uuid;           /* UUID of this "mirror" record in database. */
141
142     /* Selection criteria. */
143     struct sset src_ports;      /* Source port names. */
144     struct sset dst_ports;      /* Destination port names. */
145     int *vlans;
146     size_t n_vlans;
147
148     /* Output. */
149     struct port *out_port;
150     int out_vlan;
151 };
152
153 #define FLOOD_PORT ((struct port *) 1) /* The 'flood' output port. */
154 struct port {
155     struct bridge *bridge;
156     struct hmap_node hmap_node; /* Element in struct bridge's "ports" hmap. */
157     char *name;
158
159     int vlan;                   /* -1=trunk port, else a 12-bit VLAN ID. */
160     unsigned long *trunks;      /* Bitmap of trunked VLANs, if 'vlan' == -1.
161                                  * NULL if all VLANs are trunked. */
162     const struct ovsrec_port *cfg;
163
164     /* Monitoring. */
165     struct netdev_monitor *monitor;   /* Tracks carrier. NULL if miimon. */
166     long long int miimon_interval;    /* Miimon status refresh interval. */
167     long long int miimon_next_update; /* Time of next miimon update. */
168
169     /* An ordinary bridge port has 1 interface.
170      * A bridge port for bonding has at least 2 interfaces. */
171     struct list ifaces;         /* List of "struct iface"s. */
172     size_t n_ifaces;            /* list_size(ifaces). */
173
174     /* Bonding info. */
175     enum bond_mode bond_mode;   /* Type of the bond. BM_SLB is the default. */
176     struct iface *active_iface; /* iface on which bcasts accepted, or NULL. */
177     tag_type no_ifaces_tag;     /* Tag for flows when all ifaces disabled. */
178     int updelay, downdelay;     /* Delay before iface goes up/down, in ms. */
179     bool bond_fake_iface;       /* Fake a bond interface for legacy compat? */
180     long long int bond_next_fake_iface_update; /* Time of next update. */
181
182     /* LACP information. */
183     struct lacp *lacp;          /* LACP object. NULL if LACP is disabled. */
184
185     /* SLB specific bonding info. */
186     struct bond_entry *bond_hash; /* An array of (BOND_MASK + 1) elements. */
187     int bond_rebalance_interval; /* Interval between rebalances, in ms. */
188     long long int bond_next_rebalance; /* Next rebalancing time. */
189
190     /* Port mirroring info. */
191     mirror_mask_t src_mirrors;  /* Mirrors triggered when packet received. */
192     mirror_mask_t dst_mirrors;  /* Mirrors triggered when packet sent. */
193     bool is_mirror_output_port; /* Does port mirroring send frames here? */
194 };
195
196 struct bridge {
197     struct list node;           /* Node in global list of bridges. */
198     char *name;                 /* User-specified arbitrary name. */
199     struct mac_learning *ml;    /* MAC learning table. */
200     uint8_t ea[ETH_ADDR_LEN];   /* Bridge Ethernet Address. */
201     uint8_t default_ea[ETH_ADDR_LEN]; /* Default MAC. */
202     const struct ovsrec_bridge *cfg;
203
204     /* OpenFlow switch processing. */
205     struct ofproto *ofproto;    /* OpenFlow switch. */
206
207     /* Kernel datapath information. */
208     struct dpif *dpif;          /* Datapath. */
209     struct hmap ifaces;         /* "struct iface"s indexed by dp_ifidx. */
210
211     /* Bridge ports. */
212     struct hmap ports;          /* "struct port"s indexed by name. */
213     struct shash iface_by_name; /* "struct iface"s indexed by name. */
214
215     /* Bonding. */
216     bool has_bonded_ports;
217
218     /* Flow tracking. */
219     bool flush;
220
221     /* Port mirroring. */
222     struct mirror *mirrors[MAX_MIRRORS];
223 };
224
225 /* List of all bridges. */
226 static struct list all_bridges = LIST_INITIALIZER(&all_bridges);
227
228 /* OVSDB IDL used to obtain configuration. */
229 static struct ovsdb_idl *idl;
230
231 /* Each time this timer expires, the bridge fetches systems and interface
232  * statistics and pushes them into the database. */
233 #define STATS_INTERVAL (5 * 1000) /* In milliseconds. */
234 static long long int stats_timer = LLONG_MIN;
235
236 /* Stores the time after which CFM statistics may be written to the database.
237  * Only updated when changes to the database require rate limiting. */
238 #define CFM_LIMIT_INTERVAL (1 * 1000) /* In milliseconds. */
239 static long long int cfm_limiter = LLONG_MIN;
240
241 static struct bridge *bridge_create(const struct ovsrec_bridge *br_cfg);
242 static void bridge_destroy(struct bridge *);
243 static struct bridge *bridge_lookup(const char *name);
244 static unixctl_cb_func bridge_unixctl_dump_flows;
245 static unixctl_cb_func bridge_unixctl_reconnect;
246 static int bridge_run_one(struct bridge *);
247 static size_t bridge_get_controllers(const struct bridge *br,
248                                      struct ovsrec_controller ***controllersp);
249 static void bridge_reconfigure_one(struct bridge *);
250 static void bridge_reconfigure_remotes(struct bridge *,
251                                        const struct sockaddr_in *managers,
252                                        size_t n_managers);
253 static void bridge_get_all_ifaces(const struct bridge *, struct shash *ifaces);
254 static void bridge_fetch_dp_ifaces(struct bridge *);
255 static void bridge_flush(struct bridge *);
256 static void bridge_pick_local_hw_addr(struct bridge *,
257                                       uint8_t ea[ETH_ADDR_LEN],
258                                       struct iface **hw_addr_iface);
259 static uint64_t bridge_pick_datapath_id(struct bridge *,
260                                         const uint8_t bridge_ea[ETH_ADDR_LEN],
261                                         struct iface *hw_addr_iface);
262 static uint64_t dpid_from_hash(const void *, size_t nbytes);
263
264 static unixctl_cb_func bridge_unixctl_fdb_show;
265 static unixctl_cb_func cfm_unixctl_show;
266 static unixctl_cb_func qos_unixctl_show;
267
268 static void bond_init(void);
269 static void bond_run(struct port *);
270 static void bond_wait(struct port *);
271 static void bond_rebalance_port(struct port *);
272 static void bond_send_learning_packets(struct port *);
273 static void bond_enable_slave(struct iface *iface, bool enable);
274
275 static void port_run(struct port *);
276 static void port_wait(struct port *);
277 static struct port *port_create(struct bridge *, const char *name);
278 static void port_reconfigure(struct port *, const struct ovsrec_port *);
279 static void port_del_ifaces(struct port *, const struct ovsrec_port *);
280 static void port_destroy(struct port *);
281 static struct port *port_lookup(const struct bridge *, const char *name);
282 static struct iface *port_lookup_iface(const struct port *, const char *name);
283 static struct iface *port_get_an_iface(const struct port *);
284 static struct port *port_from_dp_ifidx(const struct bridge *,
285                                        uint16_t dp_ifidx);
286 static void port_update_bonding(struct port *);
287 static void port_update_lacp(struct port *);
288
289 static void mirror_create(struct bridge *, struct ovsrec_mirror *);
290 static void mirror_destroy(struct mirror *);
291 static void mirror_reconfigure(struct bridge *);
292 static void mirror_reconfigure_one(struct mirror *, struct ovsrec_mirror *);
293 static bool vlan_is_mirrored(const struct mirror *, int vlan);
294
295 static struct iface *iface_create(struct port *port,
296                                   const struct ovsrec_interface *if_cfg);
297 static void iface_destroy(struct iface *);
298 static struct iface *iface_lookup(const struct bridge *, const char *name);
299 static struct iface *iface_find(const char *name);
300 static struct iface *iface_from_dp_ifidx(const struct bridge *,
301                                          uint16_t dp_ifidx);
302 static void iface_set_mac(struct iface *);
303 static void iface_set_ofport(const struct ovsrec_interface *, int64_t ofport);
304 static void iface_update_qos(struct iface *, const struct ovsrec_qos *);
305 static void iface_update_cfm(struct iface *);
306 static bool iface_refresh_cfm_stats(struct iface *iface);
307 static void iface_update_carrier(struct iface *);
308 static bool iface_get_carrier(const struct iface *);
309
310 static void shash_from_ovs_idl_map(char **keys, char **values, size_t n,
311                                    struct shash *);
312 static void shash_to_ovs_idl_map(struct shash *,
313                                  char ***keys, char ***values, size_t *n);
314
315 /* Hooks into ofproto processing. */
316 static struct ofhooks bridge_ofhooks;
317 \f
318 /* Public functions. */
319
320 /* Initializes the bridge module, configuring it to obtain its configuration
321  * from an OVSDB server accessed over 'remote', which should be a string in a
322  * form acceptable to ovsdb_idl_create(). */
323 void
324 bridge_init(const char *remote)
325 {
326     /* Create connection to database. */
327     idl = ovsdb_idl_create(remote, &ovsrec_idl_class, true);
328
329     ovsdb_idl_omit_alert(idl, &ovsrec_open_vswitch_col_cur_cfg);
330     ovsdb_idl_omit_alert(idl, &ovsrec_open_vswitch_col_statistics);
331     ovsdb_idl_omit(idl, &ovsrec_open_vswitch_col_external_ids);
332
333     ovsdb_idl_omit(idl, &ovsrec_bridge_col_external_ids);
334
335     ovsdb_idl_omit(idl, &ovsrec_port_col_external_ids);
336     ovsdb_idl_omit(idl, &ovsrec_port_col_fake_bridge);
337
338     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_ofport);
339     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_statistics);
340     ovsdb_idl_omit(idl, &ovsrec_interface_col_external_ids);
341
342     /* Register unixctl commands. */
343     unixctl_command_register("fdb/show", bridge_unixctl_fdb_show, NULL);
344     unixctl_command_register("cfm/show", cfm_unixctl_show, NULL);
345     unixctl_command_register("qos/show", qos_unixctl_show, NULL);
346     unixctl_command_register("bridge/dump-flows", bridge_unixctl_dump_flows,
347                              NULL);
348     unixctl_command_register("bridge/reconnect", bridge_unixctl_reconnect,
349                              NULL);
350     lacp_init();
351     bond_init();
352 }
353
354 void
355 bridge_exit(void)
356 {
357     struct bridge *br, *next_br;
358
359     LIST_FOR_EACH_SAFE (br, next_br, node, &all_bridges) {
360         bridge_destroy(br);
361     }
362     ovsdb_idl_destroy(idl);
363 }
364
365 /* Performs configuration that is only necessary once at ovs-vswitchd startup,
366  * but for which the ovs-vswitchd configuration 'cfg' is required. */
367 static void
368 bridge_configure_once(const struct ovsrec_open_vswitch *cfg)
369 {
370     static bool already_configured_once;
371     struct sset bridge_names;
372     struct sset dpif_names, dpif_types;
373     const char *type;
374     size_t i;
375
376     /* Only do this once per ovs-vswitchd run. */
377     if (already_configured_once) {
378         return;
379     }
380     already_configured_once = true;
381
382     stats_timer = time_msec() + STATS_INTERVAL;
383
384     /* Get all the configured bridges' names from 'cfg' into 'bridge_names'. */
385     sset_init(&bridge_names);
386     for (i = 0; i < cfg->n_bridges; i++) {
387         sset_add(&bridge_names, cfg->bridges[i]->name);
388     }
389
390     /* Iterate over all system dpifs and delete any of them that do not appear
391      * in 'cfg'. */
392     sset_init(&dpif_names);
393     sset_init(&dpif_types);
394     dp_enumerate_types(&dpif_types);
395     SSET_FOR_EACH (type, &dpif_types) {
396         const char *name;
397
398         dp_enumerate_names(type, &dpif_names);
399
400         /* Delete each dpif whose name is not in 'bridge_names'. */
401         SSET_FOR_EACH (name, &dpif_names) {
402             if (!sset_contains(&bridge_names, name)) {
403                 struct dpif *dpif;
404                 int retval;
405
406                 retval = dpif_open(name, type, &dpif);
407                 if (!retval) {
408                     dpif_delete(dpif);
409                     dpif_close(dpif);
410                 }
411             }
412         }
413     }
414     sset_destroy(&bridge_names);
415     sset_destroy(&dpif_names);
416     sset_destroy(&dpif_types);
417 }
418
419 /* Callback for iterate_and_prune_ifaces(). */
420 static bool
421 check_iface(struct bridge *br, struct iface *iface, void *aux OVS_UNUSED)
422 {
423     if (!iface->netdev) {
424         /* We already reported a related error, don't bother duplicating it. */
425         return false;
426     }
427
428     if (iface->dp_ifidx < 0) {
429         VLOG_ERR("%s interface not in %s, dropping",
430                  iface->name, dpif_name(br->dpif));
431         return false;
432     }
433
434     VLOG_DBG("%s has interface %s on port %d", dpif_name(br->dpif),
435              iface->name, iface->dp_ifidx);
436     return true;
437 }
438
439 /* Callback for iterate_and_prune_ifaces(). */
440 static bool
441 set_iface_properties(struct bridge *br OVS_UNUSED, struct iface *iface,
442                      void *aux OVS_UNUSED)
443 {
444     /* Set policing attributes. */
445     netdev_set_policing(iface->netdev,
446                         iface->cfg->ingress_policing_rate,
447                         iface->cfg->ingress_policing_burst);
448
449     /* Set MAC address of internal interfaces other than the local
450      * interface. */
451     if (iface->dp_ifidx != ODPP_LOCAL && !strcmp(iface->type, "internal")) {
452         iface_set_mac(iface);
453     }
454
455     return true;
456 }
457
458 /* Calls 'cb' for each interfaces in 'br', passing along the 'aux' argument.
459  * Deletes from 'br' all the interfaces for which 'cb' returns false, and then
460  * deletes from 'br' any ports that no longer have any interfaces. */
461 static void
462 iterate_and_prune_ifaces(struct bridge *br,
463                          bool (*cb)(struct bridge *, struct iface *,
464                                     void *aux),
465                          void *aux)
466 {
467     struct port *port, *next_port;
468
469     HMAP_FOR_EACH_SAFE (port, next_port, hmap_node, &br->ports) {
470         struct iface *iface, *next_iface;
471
472         LIST_FOR_EACH_SAFE (iface, next_iface, port_elem, &port->ifaces) {
473             if (!cb(br, iface, aux)) {
474                 iface_set_ofport(iface->cfg, -1);
475                 iface_destroy(iface);
476             }
477         }
478
479         if (!port->n_ifaces) {
480             VLOG_WARN("%s port has no interfaces, dropping", port->name);
481             port_destroy(port);
482         }
483     }
484 }
485
486 /* Looks at the list of managers in 'ovs_cfg' and extracts their remote IP
487  * addresses and ports into '*managersp' and '*n_managersp'.  The caller is
488  * responsible for freeing '*managersp' (with free()).
489  *
490  * You may be asking yourself "why does ovs-vswitchd care?", because
491  * ovsdb-server is responsible for connecting to the managers, and ovs-vswitchd
492  * should not be and in fact is not directly involved in that.  But
493  * ovs-vswitchd needs to make sure that ovsdb-server can reach the managers, so
494  * it has to tell in-band control where the managers are to enable that.
495  * (Thus, only managers connected in-band are collected.)
496  */
497 static void
498 collect_in_band_managers(const struct ovsrec_open_vswitch *ovs_cfg,
499                          struct sockaddr_in **managersp, size_t *n_managersp)
500 {
501     struct sockaddr_in *managers = NULL;
502     size_t n_managers = 0;
503     struct sset targets;
504     size_t i;
505
506     /* Collect all of the potential targets from the "targets" columns of the
507      * rows pointed to by "manager_options", excluding any that are
508      * out-of-band. */
509     sset_init(&targets);
510     for (i = 0; i < ovs_cfg->n_manager_options; i++) {
511         struct ovsrec_manager *m = ovs_cfg->manager_options[i];
512
513         if (m->connection_mode && !strcmp(m->connection_mode, "out-of-band")) {
514             sset_find_and_delete(&targets, m->target);
515         } else {
516             sset_add(&targets, m->target);
517         }
518     }
519
520     /* Now extract the targets' IP addresses. */
521     if (!sset_is_empty(&targets)) {
522         const char *target;
523
524         managers = xmalloc(sset_count(&targets) * sizeof *managers);
525         SSET_FOR_EACH (target, &targets) {
526             struct sockaddr_in *sin = &managers[n_managers];
527
528             if ((!strncmp(target, "tcp:", 4)
529                  && inet_parse_active(target + 4, JSONRPC_TCP_PORT, sin)) ||
530                 (!strncmp(target, "ssl:", 4)
531                  && inet_parse_active(target + 4, JSONRPC_SSL_PORT, sin))) {
532                 n_managers++;
533             }
534         }
535     }
536     sset_destroy(&targets);
537
538     *managersp = managers;
539     *n_managersp = n_managers;
540 }
541
542 static void
543 bridge_reconfigure(const struct ovsrec_open_vswitch *ovs_cfg)
544 {
545     struct shash old_br, new_br;
546     struct shash_node *node;
547     struct bridge *br, *next;
548     struct sockaddr_in *managers;
549     size_t n_managers;
550     size_t i;
551     int sflow_bridge_number;
552
553     COVERAGE_INC(bridge_reconfigure);
554
555     collect_in_band_managers(ovs_cfg, &managers, &n_managers);
556
557     /* Collect old and new bridges. */
558     shash_init(&old_br);
559     shash_init(&new_br);
560     LIST_FOR_EACH (br, node, &all_bridges) {
561         shash_add(&old_br, br->name, br);
562     }
563     for (i = 0; i < ovs_cfg->n_bridges; i++) {
564         const struct ovsrec_bridge *br_cfg = ovs_cfg->bridges[i];
565         if (!shash_add_once(&new_br, br_cfg->name, br_cfg)) {
566             VLOG_WARN("more than one bridge named %s", br_cfg->name);
567         }
568     }
569
570     /* Get rid of deleted bridges and add new bridges. */
571     LIST_FOR_EACH_SAFE (br, next, node, &all_bridges) {
572         struct ovsrec_bridge *br_cfg = shash_find_data(&new_br, br->name);
573         if (br_cfg) {
574             br->cfg = br_cfg;
575         } else {
576             bridge_destroy(br);
577         }
578     }
579     SHASH_FOR_EACH (node, &new_br) {
580         const char *br_name = node->name;
581         const struct ovsrec_bridge *br_cfg = node->data;
582         br = shash_find_data(&old_br, br_name);
583         if (br) {
584             /* If the bridge datapath type has changed, we need to tear it
585              * down and recreate. */
586             if (strcmp(br->cfg->datapath_type, br_cfg->datapath_type)) {
587                 bridge_destroy(br);
588                 bridge_create(br_cfg);
589             }
590         } else {
591             bridge_create(br_cfg);
592         }
593     }
594     shash_destroy(&old_br);
595     shash_destroy(&new_br);
596
597     /* Reconfigure all bridges. */
598     LIST_FOR_EACH (br, node, &all_bridges) {
599         bridge_reconfigure_one(br);
600     }
601
602     /* Add and delete ports on all datapaths.
603      *
604      * The kernel will reject any attempt to add a given port to a datapath if
605      * that port already belongs to a different datapath, so we must do all
606      * port deletions before any port additions. */
607     LIST_FOR_EACH (br, node, &all_bridges) {
608         struct dpif_port_dump dump;
609         struct shash want_ifaces;
610         struct dpif_port dpif_port;
611
612         bridge_get_all_ifaces(br, &want_ifaces);
613         DPIF_PORT_FOR_EACH (&dpif_port, &dump, br->dpif) {
614             if (!shash_find(&want_ifaces, dpif_port.name)
615                 && strcmp(dpif_port.name, br->name)) {
616                 int retval = dpif_port_del(br->dpif, dpif_port.port_no);
617                 if (retval) {
618                     VLOG_WARN("failed to remove %s interface from %s: %s",
619                               dpif_port.name, dpif_name(br->dpif),
620                               strerror(retval));
621                 }
622             }
623         }
624         shash_destroy(&want_ifaces);
625     }
626     LIST_FOR_EACH (br, node, &all_bridges) {
627         struct shash cur_ifaces, want_ifaces;
628         struct dpif_port_dump dump;
629         struct dpif_port dpif_port;
630
631         /* Get the set of interfaces currently in this datapath. */
632         shash_init(&cur_ifaces);
633         DPIF_PORT_FOR_EACH (&dpif_port, &dump, br->dpif) {
634             struct dpif_port *port_info = xmalloc(sizeof *port_info);
635             dpif_port_clone(port_info, &dpif_port);
636             shash_add(&cur_ifaces, dpif_port.name, port_info);
637         }
638
639         /* Get the set of interfaces we want on this datapath. */
640         bridge_get_all_ifaces(br, &want_ifaces);
641
642         hmap_clear(&br->ifaces);
643         SHASH_FOR_EACH (node, &want_ifaces) {
644             const char *if_name = node->name;
645             struct iface *iface = node->data;
646             struct dpif_port *dpif_port;
647             const char *type;
648             int error;
649
650             type = iface ? iface->type : "internal";
651             dpif_port = shash_find_data(&cur_ifaces, if_name);
652
653             /* If we have a port or a netdev already, and it's not the type we
654              * want, then delete the port (if any) and close the netdev (if
655              * any). */
656             if ((dpif_port && strcmp(dpif_port->type, type))
657                 || (iface && iface->netdev
658                     && strcmp(type, netdev_get_type(iface->netdev)))) {
659                 if (dpif_port) {
660                     error = ofproto_port_del(br->ofproto, dpif_port->port_no);
661                     if (error) {
662                         continue;
663                     }
664                     dpif_port = NULL;
665                 }
666                 if (iface) {
667                     netdev_close(iface->netdev);
668                     iface->netdev = NULL;
669                 }
670             }
671
672             /* If the port doesn't exist or we don't have the netdev open,
673              * we need to do more work. */
674             if (!dpif_port || (iface && !iface->netdev)) {
675                 struct netdev_options options;
676                 struct netdev *netdev;
677                 struct shash args;
678
679                 /* First open the network device. */
680                 options.name = if_name;
681                 options.type = type;
682                 options.args = &args;
683                 options.ethertype = NETDEV_ETH_TYPE_NONE;
684
685                 shash_init(&args);
686                 if (iface) {
687                     shash_from_ovs_idl_map(iface->cfg->key_options,
688                                            iface->cfg->value_options,
689                                            iface->cfg->n_options, &args);
690                 }
691                 error = netdev_open(&options, &netdev);
692                 shash_destroy(&args);
693
694                 if (error) {
695                     VLOG_WARN("could not open network device %s (%s)",
696                               if_name, strerror(error));
697                     continue;
698                 }
699
700                 /* Then add the port if we haven't already. */
701                 if (!dpif_port) {
702                     error = dpif_port_add(br->dpif, netdev, NULL);
703                     if (error) {
704                         netdev_close(netdev);
705                         if (error == EFBIG) {
706                             VLOG_ERR("ran out of valid port numbers on %s",
707                                      dpif_name(br->dpif));
708                             break;
709                         } else {
710                             VLOG_WARN("failed to add %s interface to %s: %s",
711                                       if_name, dpif_name(br->dpif),
712                                       strerror(error));
713                             continue;
714                         }
715                     }
716                 }
717
718                 /* Update 'iface'. */
719                 if (iface) {
720                     iface->netdev = netdev;
721                     iface->enabled = iface_get_carrier(iface);
722                     iface->up = iface->enabled;
723                 }
724             } else if (iface && iface->netdev) {
725                 struct shash args;
726
727                 shash_init(&args);
728                 shash_from_ovs_idl_map(iface->cfg->key_options,
729                                        iface->cfg->value_options,
730                                        iface->cfg->n_options, &args);
731                 netdev_set_config(iface->netdev, &args);
732                 shash_destroy(&args);
733             }
734         }
735         shash_destroy(&want_ifaces);
736
737         SHASH_FOR_EACH (node, &cur_ifaces) {
738             struct dpif_port *port_info = node->data;
739             dpif_port_destroy(port_info);
740             free(port_info);
741         }
742         shash_destroy(&cur_ifaces);
743     }
744     sflow_bridge_number = 0;
745     LIST_FOR_EACH (br, node, &all_bridges) {
746         uint8_t ea[ETH_ADDR_LEN];
747         uint64_t dpid;
748         struct iface *local_iface;
749         struct iface *hw_addr_iface;
750         char *dpid_string;
751
752         bridge_fetch_dp_ifaces(br);
753
754         iterate_and_prune_ifaces(br, check_iface, NULL);
755
756         /* Pick local port hardware address, datapath ID. */
757         bridge_pick_local_hw_addr(br, ea, &hw_addr_iface);
758         local_iface = iface_from_dp_ifidx(br, ODPP_LOCAL);
759         if (local_iface) {
760             int error = netdev_set_etheraddr(local_iface->netdev, ea);
761             if (error) {
762                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
763                 VLOG_ERR_RL(&rl, "bridge %s: failed to set bridge "
764                             "Ethernet address: %s",
765                             br->name, strerror(error));
766             }
767         }
768         memcpy(br->ea, ea, ETH_ADDR_LEN);
769
770         dpid = bridge_pick_datapath_id(br, ea, hw_addr_iface);
771         ofproto_set_datapath_id(br->ofproto, dpid);
772
773         dpid_string = xasprintf("%016"PRIx64, dpid);
774         ovsrec_bridge_set_datapath_id(br->cfg, dpid_string);
775         free(dpid_string);
776
777         /* Set NetFlow configuration on this bridge. */
778         if (br->cfg->netflow) {
779             struct ovsrec_netflow *nf_cfg = br->cfg->netflow;
780             struct netflow_options opts;
781
782             memset(&opts, 0, sizeof opts);
783
784             dpif_get_netflow_ids(br->dpif, &opts.engine_type, &opts.engine_id);
785             if (nf_cfg->engine_type) {
786                 opts.engine_type = *nf_cfg->engine_type;
787             }
788             if (nf_cfg->engine_id) {
789                 opts.engine_id = *nf_cfg->engine_id;
790             }
791
792             opts.active_timeout = nf_cfg->active_timeout;
793             if (!opts.active_timeout) {
794                 opts.active_timeout = -1;
795             } else if (opts.active_timeout < 0) {
796                 VLOG_WARN("bridge %s: active timeout interval set to negative "
797                           "value, using default instead (%d seconds)", br->name,
798                           NF_ACTIVE_TIMEOUT_DEFAULT);
799                 opts.active_timeout = -1;
800             }
801
802             opts.add_id_to_iface = nf_cfg->add_id_to_interface;
803             if (opts.add_id_to_iface) {
804                 if (opts.engine_id > 0x7f) {
805                     VLOG_WARN("bridge %s: netflow port mangling may conflict "
806                               "with another vswitch, choose an engine id less "
807                               "than 128", br->name);
808                 }
809                 if (hmap_count(&br->ports) > 508) {
810                     VLOG_WARN("bridge %s: netflow port mangling will conflict "
811                               "with another port when more than 508 ports are "
812                               "used", br->name);
813                 }
814             }
815
816             sset_init(&opts.collectors);
817             sset_add_array(&opts.collectors,
818                            nf_cfg->targets, nf_cfg->n_targets);
819             if (ofproto_set_netflow(br->ofproto, &opts)) {
820                 VLOG_ERR("bridge %s: problem setting netflow collectors",
821                          br->name);
822             }
823             sset_destroy(&opts.collectors);
824         } else {
825             ofproto_set_netflow(br->ofproto, NULL);
826         }
827
828         /* Set sFlow configuration on this bridge. */
829         if (br->cfg->sflow) {
830             const struct ovsrec_sflow *sflow_cfg = br->cfg->sflow;
831             struct ovsrec_controller **controllers;
832             struct ofproto_sflow_options oso;
833             size_t n_controllers;
834
835             memset(&oso, 0, sizeof oso);
836
837             sset_init(&oso.targets);
838             sset_add_array(&oso.targets,
839                            sflow_cfg->targets, sflow_cfg->n_targets);
840
841             oso.sampling_rate = SFL_DEFAULT_SAMPLING_RATE;
842             if (sflow_cfg->sampling) {
843                 oso.sampling_rate = *sflow_cfg->sampling;
844             }
845
846             oso.polling_interval = SFL_DEFAULT_POLLING_INTERVAL;
847             if (sflow_cfg->polling) {
848                 oso.polling_interval = *sflow_cfg->polling;
849             }
850
851             oso.header_len = SFL_DEFAULT_HEADER_SIZE;
852             if (sflow_cfg->header) {
853                 oso.header_len = *sflow_cfg->header;
854             }
855
856             oso.sub_id = sflow_bridge_number++;
857             oso.agent_device = sflow_cfg->agent;
858
859             oso.control_ip = NULL;
860             n_controllers = bridge_get_controllers(br, &controllers);
861             for (i = 0; i < n_controllers; i++) {
862                 if (controllers[i]->local_ip) {
863                     oso.control_ip = controllers[i]->local_ip;
864                     break;
865                 }
866             }
867             ofproto_set_sflow(br->ofproto, &oso);
868
869             sset_destroy(&oso.targets);
870         } else {
871             ofproto_set_sflow(br->ofproto, NULL);
872         }
873
874         /* Update the controller and related settings.  It would be more
875          * straightforward to call this from bridge_reconfigure_one(), but we
876          * can't do it there for two reasons.  First, and most importantly, at
877          * that point we don't know the dp_ifidx of any interfaces that have
878          * been added to the bridge (because we haven't actually added them to
879          * the datapath).  Second, at that point we haven't set the datapath ID
880          * yet; when a controller is configured, resetting the datapath ID will
881          * immediately disconnect from the controller, so it's better to set
882          * the datapath ID before the controller. */
883         bridge_reconfigure_remotes(br, managers, n_managers);
884     }
885     LIST_FOR_EACH (br, node, &all_bridges) {
886         struct port *port;
887
888         HMAP_FOR_EACH (port, hmap_node, &br->ports) {
889             struct iface *iface;
890
891             if (port->monitor) {
892                 LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
893                     netdev_monitor_add(port->monitor, iface->netdev);
894                 }
895             } else {
896                 port->miimon_next_update = 0;
897             }
898
899             port_update_lacp(port);
900             port_update_bonding(port);
901
902             LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
903                 iface_update_qos(iface, port->cfg->qos);
904             }
905         }
906     }
907     LIST_FOR_EACH (br, node, &all_bridges) {
908         iterate_and_prune_ifaces(br, set_iface_properties, NULL);
909     }
910
911     LIST_FOR_EACH (br, node, &all_bridges) {
912         struct iface *iface;
913         HMAP_FOR_EACH (iface, dp_ifidx_node, &br->ifaces) {
914             iface_update_cfm(iface);
915         }
916     }
917
918     free(managers);
919
920     /* ovs-vswitchd has completed initialization, so allow the process that
921      * forked us to exit successfully. */
922     daemonize_complete();
923 }
924
925 static const char *
926 get_ovsrec_key_value(const struct ovsdb_idl_row *row,
927                      const struct ovsdb_idl_column *column,
928                      const char *key)
929 {
930     const struct ovsdb_datum *datum;
931     union ovsdb_atom atom;
932     unsigned int idx;
933
934     datum = ovsdb_idl_get(row, column, OVSDB_TYPE_STRING, OVSDB_TYPE_STRING);
935     atom.string = (char *) key;
936     idx = ovsdb_datum_find_key(datum, &atom, OVSDB_TYPE_STRING);
937     return idx == UINT_MAX ? NULL : datum->values[idx].string;
938 }
939
940 static const char *
941 bridge_get_other_config(const struct ovsrec_bridge *br_cfg, const char *key)
942 {
943     return get_ovsrec_key_value(&br_cfg->header_,
944                                 &ovsrec_bridge_col_other_config, key);
945 }
946
947 static void
948 bridge_pick_local_hw_addr(struct bridge *br, uint8_t ea[ETH_ADDR_LEN],
949                           struct iface **hw_addr_iface)
950 {
951     const char *hwaddr;
952     struct port *port;
953     int error;
954
955     *hw_addr_iface = NULL;
956
957     /* Did the user request a particular MAC? */
958     hwaddr = bridge_get_other_config(br->cfg, "hwaddr");
959     if (hwaddr && eth_addr_from_string(hwaddr, ea)) {
960         if (eth_addr_is_multicast(ea)) {
961             VLOG_ERR("bridge %s: cannot set MAC address to multicast "
962                      "address "ETH_ADDR_FMT, br->name, ETH_ADDR_ARGS(ea));
963         } else if (eth_addr_is_zero(ea)) {
964             VLOG_ERR("bridge %s: cannot set MAC address to zero", br->name);
965         } else {
966             return;
967         }
968     }
969
970     /* Otherwise choose the minimum non-local MAC address among all of the
971      * interfaces. */
972     memset(ea, 0xff, ETH_ADDR_LEN);
973     HMAP_FOR_EACH (port, hmap_node, &br->ports) {
974         uint8_t iface_ea[ETH_ADDR_LEN];
975         struct iface *candidate;
976         struct iface *iface;
977
978         /* Mirror output ports don't participate. */
979         if (port->is_mirror_output_port) {
980             continue;
981         }
982
983         /* Choose the MAC address to represent the port. */
984         iface = NULL;
985         if (port->cfg->mac && eth_addr_from_string(port->cfg->mac, iface_ea)) {
986             /* Find the interface with this Ethernet address (if any) so that
987              * we can provide the correct devname to the caller. */
988             LIST_FOR_EACH (candidate, port_elem, &port->ifaces) {
989                 uint8_t candidate_ea[ETH_ADDR_LEN];
990                 if (!netdev_get_etheraddr(candidate->netdev, candidate_ea)
991                     && eth_addr_equals(iface_ea, candidate_ea)) {
992                     iface = candidate;
993                 }
994             }
995         } else {
996             /* Choose the interface whose MAC address will represent the port.
997              * The Linux kernel bonding code always chooses the MAC address of
998              * the first slave added to a bond, and the Fedora networking
999              * scripts always add slaves to a bond in alphabetical order, so
1000              * for compatibility we choose the interface with the name that is
1001              * first in alphabetical order. */
1002             LIST_FOR_EACH (candidate, port_elem, &port->ifaces) {
1003                 if (!iface || strcmp(candidate->name, iface->name) < 0) {
1004                     iface = candidate;
1005                 }
1006             }
1007
1008             /* The local port doesn't count (since we're trying to choose its
1009              * MAC address anyway). */
1010             if (iface->dp_ifidx == ODPP_LOCAL) {
1011                 continue;
1012             }
1013
1014             /* Grab MAC. */
1015             error = netdev_get_etheraddr(iface->netdev, iface_ea);
1016             if (error) {
1017                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1018                 VLOG_ERR_RL(&rl, "failed to obtain Ethernet address of %s: %s",
1019                             iface->name, strerror(error));
1020                 continue;
1021             }
1022         }
1023
1024         /* Compare against our current choice. */
1025         if (!eth_addr_is_multicast(iface_ea) &&
1026             !eth_addr_is_local(iface_ea) &&
1027             !eth_addr_is_reserved(iface_ea) &&
1028             !eth_addr_is_zero(iface_ea) &&
1029             eth_addr_compare_3way(iface_ea, ea) < 0)
1030         {
1031             memcpy(ea, iface_ea, ETH_ADDR_LEN);
1032             *hw_addr_iface = iface;
1033         }
1034     }
1035     if (eth_addr_is_multicast(ea)) {
1036         memcpy(ea, br->default_ea, ETH_ADDR_LEN);
1037         *hw_addr_iface = NULL;
1038         VLOG_WARN("bridge %s: using default bridge Ethernet "
1039                   "address "ETH_ADDR_FMT, br->name, ETH_ADDR_ARGS(ea));
1040     } else {
1041         VLOG_DBG("bridge %s: using bridge Ethernet address "ETH_ADDR_FMT,
1042                  br->name, ETH_ADDR_ARGS(ea));
1043     }
1044 }
1045
1046 /* Choose and returns the datapath ID for bridge 'br' given that the bridge
1047  * Ethernet address is 'bridge_ea'.  If 'bridge_ea' is the Ethernet address of
1048  * an interface on 'br', then that interface must be passed in as
1049  * 'hw_addr_iface'; if 'bridge_ea' was derived some other way, then
1050  * 'hw_addr_iface' must be passed in as a null pointer. */
1051 static uint64_t
1052 bridge_pick_datapath_id(struct bridge *br,
1053                         const uint8_t bridge_ea[ETH_ADDR_LEN],
1054                         struct iface *hw_addr_iface)
1055 {
1056     /*
1057      * The procedure for choosing a bridge MAC address will, in the most
1058      * ordinary case, also choose a unique MAC that we can use as a datapath
1059      * ID.  In some special cases, though, multiple bridges will end up with
1060      * the same MAC address.  This is OK for the bridges, but it will confuse
1061      * the OpenFlow controller, because each datapath needs a unique datapath
1062      * ID.
1063      *
1064      * Datapath IDs must be unique.  It is also very desirable that they be
1065      * stable from one run to the next, so that policy set on a datapath
1066      * "sticks".
1067      */
1068     const char *datapath_id;
1069     uint64_t dpid;
1070
1071     datapath_id = bridge_get_other_config(br->cfg, "datapath-id");
1072     if (datapath_id && dpid_from_string(datapath_id, &dpid)) {
1073         return dpid;
1074     }
1075
1076     if (hw_addr_iface) {
1077         int vlan;
1078         if (!netdev_get_vlan_vid(hw_addr_iface->netdev, &vlan)) {
1079             /*
1080              * A bridge whose MAC address is taken from a VLAN network device
1081              * (that is, a network device created with vconfig(8) or similar
1082              * tool) will have the same MAC address as a bridge on the VLAN
1083              * device's physical network device.
1084              *
1085              * Handle this case by hashing the physical network device MAC
1086              * along with the VLAN identifier.
1087              */
1088             uint8_t buf[ETH_ADDR_LEN + 2];
1089             memcpy(buf, bridge_ea, ETH_ADDR_LEN);
1090             buf[ETH_ADDR_LEN] = vlan >> 8;
1091             buf[ETH_ADDR_LEN + 1] = vlan;
1092             return dpid_from_hash(buf, sizeof buf);
1093         } else {
1094             /*
1095              * Assume that this bridge's MAC address is unique, since it
1096              * doesn't fit any of the cases we handle specially.
1097              */
1098         }
1099     } else {
1100         /*
1101          * A purely internal bridge, that is, one that has no non-virtual
1102          * network devices on it at all, is more difficult because it has no
1103          * natural unique identifier at all.
1104          *
1105          * When the host is a XenServer, we handle this case by hashing the
1106          * host's UUID with the name of the bridge.  Names of bridges are
1107          * persistent across XenServer reboots, although they can be reused if
1108          * an internal network is destroyed and then a new one is later
1109          * created, so this is fairly effective.
1110          *
1111          * When the host is not a XenServer, we punt by using a random MAC
1112          * address on each run.
1113          */
1114         const char *host_uuid = xenserver_get_host_uuid();
1115         if (host_uuid) {
1116             char *combined = xasprintf("%s,%s", host_uuid, br->name);
1117             dpid = dpid_from_hash(combined, strlen(combined));
1118             free(combined);
1119             return dpid;
1120         }
1121     }
1122
1123     return eth_addr_to_uint64(bridge_ea);
1124 }
1125
1126 static uint64_t
1127 dpid_from_hash(const void *data, size_t n)
1128 {
1129     uint8_t hash[SHA1_DIGEST_SIZE];
1130
1131     BUILD_ASSERT_DECL(sizeof hash >= ETH_ADDR_LEN);
1132     sha1_bytes(data, n, hash);
1133     eth_addr_mark_random(hash);
1134     return eth_addr_to_uint64(hash);
1135 }
1136
1137 static void
1138 iface_refresh_status(struct iface *iface)
1139 {
1140     struct shash sh;
1141
1142     enum netdev_flags flags;
1143     uint32_t current;
1144     int64_t bps;
1145     int mtu;
1146     int64_t mtu_64;
1147     int error;
1148
1149     shash_init(&sh);
1150
1151     if (!netdev_get_status(iface->netdev, &sh)) {
1152         size_t n;
1153         char **keys, **values;
1154
1155         shash_to_ovs_idl_map(&sh, &keys, &values, &n);
1156         ovsrec_interface_set_status(iface->cfg, keys, values, n);
1157
1158         free(keys);
1159         free(values);
1160     } else {
1161         ovsrec_interface_set_status(iface->cfg, NULL, NULL, 0);
1162     }
1163
1164     shash_destroy_free_data(&sh);
1165
1166     error = netdev_get_flags(iface->netdev, &flags);
1167     if (!error) {
1168         ovsrec_interface_set_admin_state(iface->cfg, flags & NETDEV_UP ? "up" : "down");
1169     }
1170     else {
1171         ovsrec_interface_set_admin_state(iface->cfg, NULL);
1172     }
1173
1174     error = netdev_get_features(iface->netdev, &current, NULL, NULL, NULL);
1175     if (!error) {
1176         ovsrec_interface_set_duplex(iface->cfg,
1177                                     netdev_features_is_full_duplex(current)
1178                                     ? "full" : "half");
1179         /* warning: uint64_t -> int64_t conversion */
1180         bps = netdev_features_to_bps(current);
1181         ovsrec_interface_set_link_speed(iface->cfg, &bps, 1);
1182     }
1183     else {
1184         ovsrec_interface_set_duplex(iface->cfg, NULL);
1185         ovsrec_interface_set_link_speed(iface->cfg, NULL, 0);
1186     }
1187
1188
1189     ovsrec_interface_set_link_state(iface->cfg,
1190                                     iface_get_carrier(iface) ? "up" : "down");
1191
1192     error = netdev_get_mtu(iface->netdev, &mtu);
1193     if (!error && mtu != INT_MAX) {
1194         mtu_64 = mtu;
1195         ovsrec_interface_set_mtu(iface->cfg, &mtu_64, 1);
1196     }
1197     else {
1198         ovsrec_interface_set_mtu(iface->cfg, NULL, 0);
1199     }
1200 }
1201
1202 /* Writes 'iface''s CFM statistics to the database.  Returns true if anything
1203  * changed, false otherwise. */
1204 static bool
1205 iface_refresh_cfm_stats(struct iface *iface)
1206 {
1207     const struct ovsrec_monitor *mon;
1208     const struct cfm *cfm;
1209     bool changed = false;
1210     size_t i;
1211
1212     mon = iface->cfg->monitor;
1213     cfm = ofproto_iface_get_cfm(iface->port->bridge->ofproto, iface->dp_ifidx);
1214
1215     if (!cfm || !mon) {
1216         return false;
1217     }
1218
1219     for (i = 0; i < mon->n_remote_mps; i++) {
1220         const struct ovsrec_maintenance_point *mp;
1221         const struct remote_mp *rmp;
1222
1223         mp = mon->remote_mps[i];
1224         rmp = cfm_get_remote_mp(cfm, mp->mpid);
1225
1226         if (mp->n_fault != 1 || mp->fault[0] != rmp->fault) {
1227             ovsrec_maintenance_point_set_fault(mp, &rmp->fault, 1);
1228             changed = true;
1229         }
1230     }
1231
1232     if (mon->n_fault != 1 || mon->fault[0] != cfm->fault) {
1233         ovsrec_monitor_set_fault(mon, &cfm->fault, 1);
1234         changed = true;
1235     }
1236
1237     return changed;
1238 }
1239
1240 static void
1241 iface_refresh_stats(struct iface *iface)
1242 {
1243     struct iface_stat {
1244         char *name;
1245         int offset;
1246     };
1247     static const struct iface_stat iface_stats[] = {
1248         { "rx_packets", offsetof(struct netdev_stats, rx_packets) },
1249         { "tx_packets", offsetof(struct netdev_stats, tx_packets) },
1250         { "rx_bytes", offsetof(struct netdev_stats, rx_bytes) },
1251         { "tx_bytes", offsetof(struct netdev_stats, tx_bytes) },
1252         { "rx_dropped", offsetof(struct netdev_stats, rx_dropped) },
1253         { "tx_dropped", offsetof(struct netdev_stats, tx_dropped) },
1254         { "rx_errors", offsetof(struct netdev_stats, rx_errors) },
1255         { "tx_errors", offsetof(struct netdev_stats, tx_errors) },
1256         { "rx_frame_err", offsetof(struct netdev_stats, rx_frame_errors) },
1257         { "rx_over_err", offsetof(struct netdev_stats, rx_over_errors) },
1258         { "rx_crc_err", offsetof(struct netdev_stats, rx_crc_errors) },
1259         { "collisions", offsetof(struct netdev_stats, collisions) },
1260     };
1261     enum { N_STATS = ARRAY_SIZE(iface_stats) };
1262     const struct iface_stat *s;
1263
1264     char *keys[N_STATS];
1265     int64_t values[N_STATS];
1266     int n;
1267
1268     struct netdev_stats stats;
1269
1270     /* Intentionally ignore return value, since errors will set 'stats' to
1271      * all-1s, and we will deal with that correctly below. */
1272     netdev_get_stats(iface->netdev, &stats);
1273
1274     n = 0;
1275     for (s = iface_stats; s < &iface_stats[N_STATS]; s++) {
1276         uint64_t value = *(uint64_t *) (((char *) &stats) + s->offset);
1277         if (value != UINT64_MAX) {
1278             keys[n] = s->name;
1279             values[n] = value;
1280             n++;
1281         }
1282     }
1283
1284     ovsrec_interface_set_statistics(iface->cfg, keys, values, n);
1285 }
1286
1287 static void
1288 refresh_system_stats(const struct ovsrec_open_vswitch *cfg)
1289 {
1290     struct ovsdb_datum datum;
1291     struct shash stats;
1292
1293     shash_init(&stats);
1294     get_system_stats(&stats);
1295
1296     ovsdb_datum_from_shash(&datum, &stats);
1297     ovsdb_idl_txn_write(&cfg->header_, &ovsrec_open_vswitch_col_statistics,
1298                         &datum);
1299 }
1300
1301 static inline const char *
1302 nx_role_to_str(enum nx_role role)
1303 {
1304     switch (role) {
1305     case NX_ROLE_OTHER:
1306         return "other";
1307     case NX_ROLE_MASTER:
1308         return "master";
1309     case NX_ROLE_SLAVE:
1310         return "slave";
1311     default:
1312         return "*** INVALID ROLE ***";
1313     }
1314 }
1315
1316 static void
1317 bridge_refresh_controller_status(const struct bridge *br)
1318 {
1319     struct shash info;
1320     const struct ovsrec_controller *cfg;
1321
1322     ofproto_get_ofproto_controller_info(br->ofproto, &info);
1323
1324     OVSREC_CONTROLLER_FOR_EACH(cfg, idl) {
1325         struct ofproto_controller_info *cinfo =
1326             shash_find_data(&info, cfg->target);
1327
1328         if (cinfo) {
1329             ovsrec_controller_set_is_connected(cfg, cinfo->is_connected);
1330             ovsrec_controller_set_role(cfg, nx_role_to_str(cinfo->role));
1331             ovsrec_controller_set_status(cfg, (char **) cinfo->pairs.keys,
1332                                          (char **) cinfo->pairs.values,
1333                                          cinfo->pairs.n);
1334         } else {
1335             ovsrec_controller_set_is_connected(cfg, false);
1336             ovsrec_controller_set_role(cfg, NULL);
1337             ovsrec_controller_set_status(cfg, NULL, NULL, 0);
1338         }
1339     }
1340
1341     ofproto_free_ofproto_controller_info(&info);
1342 }
1343
1344 void
1345 bridge_run(void)
1346 {
1347     const struct ovsrec_open_vswitch *cfg;
1348
1349     bool datapath_destroyed;
1350     bool database_changed;
1351     struct bridge *br;
1352
1353     /* Let each bridge do the work that it needs to do. */
1354     datapath_destroyed = false;
1355     LIST_FOR_EACH (br, node, &all_bridges) {
1356         int error = bridge_run_one(br);
1357         if (error) {
1358             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1359             VLOG_ERR_RL(&rl, "bridge %s: datapath was destroyed externally, "
1360                         "forcing reconfiguration", br->name);
1361             datapath_destroyed = true;
1362         }
1363     }
1364
1365     /* (Re)configure if necessary. */
1366     database_changed = ovsdb_idl_run(idl);
1367     cfg = ovsrec_open_vswitch_first(idl);
1368 #ifdef HAVE_OPENSSL
1369     /* Re-configure SSL.  We do this on every trip through the main loop,
1370      * instead of just when the database changes, because the contents of the
1371      * key and certificate files can change without the database changing.
1372      *
1373      * We do this before bridge_reconfigure() because that function might
1374      * initiate SSL connections and thus requires SSL to be configured. */
1375     if (cfg && cfg->ssl) {
1376         const struct ovsrec_ssl *ssl = cfg->ssl;
1377
1378         stream_ssl_set_key_and_cert(ssl->private_key, ssl->certificate);
1379         stream_ssl_set_ca_cert_file(ssl->ca_cert, ssl->bootstrap_ca_cert);
1380     }
1381 #endif
1382     if (database_changed || datapath_destroyed) {
1383         if (cfg) {
1384             struct ovsdb_idl_txn *txn = ovsdb_idl_txn_create(idl);
1385
1386             bridge_configure_once(cfg);
1387             bridge_reconfigure(cfg);
1388
1389             ovsrec_open_vswitch_set_cur_cfg(cfg, cfg->next_cfg);
1390             ovsdb_idl_txn_commit(txn);
1391             ovsdb_idl_txn_destroy(txn); /* XXX */
1392         } else {
1393             /* We still need to reconfigure to avoid dangling pointers to
1394              * now-destroyed ovsrec structures inside bridge data. */
1395             static const struct ovsrec_open_vswitch null_cfg;
1396
1397             bridge_reconfigure(&null_cfg);
1398         }
1399     }
1400
1401     /* Refresh system and interface stats if necessary. */
1402     if (time_msec() >= stats_timer) {
1403         if (cfg) {
1404             struct ovsdb_idl_txn *txn;
1405
1406             txn = ovsdb_idl_txn_create(idl);
1407             LIST_FOR_EACH (br, node, &all_bridges) {
1408                 struct port *port;
1409
1410                 HMAP_FOR_EACH (port, hmap_node, &br->ports) {
1411                     struct iface *iface;
1412
1413                     LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
1414                         iface_refresh_stats(iface);
1415                         iface_refresh_status(iface);
1416                     }
1417                 }
1418                 bridge_refresh_controller_status(br);
1419             }
1420             refresh_system_stats(cfg);
1421             ovsdb_idl_txn_commit(txn);
1422             ovsdb_idl_txn_destroy(txn); /* XXX */
1423         }
1424
1425         stats_timer = time_msec() + STATS_INTERVAL;
1426     }
1427
1428     if (time_msec() >= cfm_limiter) {
1429         struct ovsdb_idl_txn *txn;
1430         bool changed = false;
1431
1432         txn = ovsdb_idl_txn_create(idl);
1433         LIST_FOR_EACH (br, node, &all_bridges) {
1434             struct port *port;
1435
1436             HMAP_FOR_EACH (port, hmap_node, &br->ports) {
1437                 struct iface *iface;
1438
1439                 LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
1440                     changed = iface_refresh_cfm_stats(iface) || changed;
1441                 }
1442             }
1443         }
1444
1445         if (changed) {
1446             cfm_limiter = time_msec() + CFM_LIMIT_INTERVAL;
1447         }
1448
1449         ovsdb_idl_txn_commit(txn);
1450         ovsdb_idl_txn_destroy(txn);
1451     }
1452 }
1453
1454 void
1455 bridge_wait(void)
1456 {
1457     struct bridge *br;
1458
1459     LIST_FOR_EACH (br, node, &all_bridges) {
1460         struct port *port;
1461
1462         ofproto_wait(br->ofproto);
1463         mac_learning_wait(br->ml);
1464         HMAP_FOR_EACH (port, hmap_node, &br->ports) {
1465             port_wait(port);
1466         }
1467     }
1468     ovsdb_idl_wait(idl);
1469     poll_timer_wait_until(stats_timer);
1470
1471     if (cfm_limiter > time_msec()) {
1472         poll_timer_wait_until(cfm_limiter);
1473     }
1474 }
1475
1476 /* Forces 'br' to revalidate all of its flows.  This is appropriate when 'br''s
1477  * configuration changes.  */
1478 static void
1479 bridge_flush(struct bridge *br)
1480 {
1481     COVERAGE_INC(bridge_flush);
1482     br->flush = true;
1483 }
1484 \f
1485 /* Bridge unixctl user interface functions. */
1486 static void
1487 bridge_unixctl_fdb_show(struct unixctl_conn *conn,
1488                         const char *args, void *aux OVS_UNUSED)
1489 {
1490     struct ds ds = DS_EMPTY_INITIALIZER;
1491     const struct bridge *br;
1492     const struct mac_entry *e;
1493
1494     br = bridge_lookup(args);
1495     if (!br) {
1496         unixctl_command_reply(conn, 501, "no such bridge");
1497         return;
1498     }
1499
1500     ds_put_cstr(&ds, " port  VLAN  MAC                Age\n");
1501     LIST_FOR_EACH (e, lru_node, &br->ml->lrus) {
1502         struct port *port = e->port.p;
1503         ds_put_format(&ds, "%5d  %4d  "ETH_ADDR_FMT"  %3d\n",
1504                       port_get_an_iface(port)->dp_ifidx,
1505                       e->vlan, ETH_ADDR_ARGS(e->mac), mac_entry_age(e));
1506     }
1507     unixctl_command_reply(conn, 200, ds_cstr(&ds));
1508     ds_destroy(&ds);
1509 }
1510 \f
1511 /* CFM unixctl user interface functions. */
1512 static void
1513 cfm_unixctl_show(struct unixctl_conn *conn,
1514                  const char *args, void *aux OVS_UNUSED)
1515 {
1516     struct ds ds = DS_EMPTY_INITIALIZER;
1517     struct iface *iface;
1518     const struct cfm *cfm;
1519
1520     iface = iface_find(args);
1521     if (!iface) {
1522         unixctl_command_reply(conn, 501, "no such interface");
1523         return;
1524     }
1525
1526     cfm = ofproto_iface_get_cfm(iface->port->bridge->ofproto, iface->dp_ifidx);
1527
1528     if (!cfm) {
1529         unixctl_command_reply(conn, 501, "CFM not enabled");
1530         return;
1531     }
1532
1533     cfm_dump_ds(cfm, &ds);
1534     unixctl_command_reply(conn, 200, ds_cstr(&ds));
1535     ds_destroy(&ds);
1536 }
1537 \f
1538 /* QoS unixctl user interface functions. */
1539
1540 struct qos_unixctl_show_cbdata {
1541     struct ds *ds;
1542     struct iface *iface;
1543 };
1544
1545 static void
1546 qos_unixctl_show_cb(unsigned int queue_id,
1547                     const struct shash *details,
1548                     void *aux)
1549 {
1550     struct qos_unixctl_show_cbdata *data = aux;
1551     struct ds *ds = data->ds;
1552     struct iface *iface = data->iface;
1553     struct netdev_queue_stats stats;
1554     struct shash_node *node;
1555     int error;
1556
1557     ds_put_cstr(ds, "\n");
1558     if (queue_id) {
1559         ds_put_format(ds, "Queue %u:\n", queue_id);
1560     } else {
1561         ds_put_cstr(ds, "Default:\n");
1562     }
1563
1564     SHASH_FOR_EACH (node, details) {
1565         ds_put_format(ds, "\t%s: %s\n", node->name, (char *)node->data);
1566     }
1567
1568     error = netdev_get_queue_stats(iface->netdev, queue_id, &stats);
1569     if (!error) {
1570         if (stats.tx_packets != UINT64_MAX) {
1571             ds_put_format(ds, "\ttx_packets: %"PRIu64"\n", stats.tx_packets);
1572         }
1573
1574         if (stats.tx_bytes != UINT64_MAX) {
1575             ds_put_format(ds, "\ttx_bytes: %"PRIu64"\n", stats.tx_bytes);
1576         }
1577
1578         if (stats.tx_errors != UINT64_MAX) {
1579             ds_put_format(ds, "\ttx_errors: %"PRIu64"\n", stats.tx_errors);
1580         }
1581     } else {
1582         ds_put_format(ds, "\tFailed to get statistics for queue %u: %s",
1583                       queue_id, strerror(error));
1584     }
1585 }
1586
1587 static void
1588 qos_unixctl_show(struct unixctl_conn *conn,
1589                  const char *args, void *aux OVS_UNUSED)
1590 {
1591     struct ds ds = DS_EMPTY_INITIALIZER;
1592     struct shash sh = SHASH_INITIALIZER(&sh);
1593     struct iface *iface;
1594     const char *type;
1595     struct shash_node *node;
1596     struct qos_unixctl_show_cbdata data;
1597     int error;
1598
1599     iface = iface_find(args);
1600     if (!iface) {
1601         unixctl_command_reply(conn, 501, "no such interface");
1602         return;
1603     }
1604
1605     netdev_get_qos(iface->netdev, &type, &sh);
1606
1607     if (*type != '\0') {
1608         ds_put_format(&ds, "QoS: %s %s\n", iface->name, type);
1609
1610         SHASH_FOR_EACH (node, &sh) {
1611             ds_put_format(&ds, "%s: %s\n", node->name, (char *)node->data);
1612         }
1613
1614         data.ds = &ds;
1615         data.iface = iface;
1616         error = netdev_dump_queues(iface->netdev, qos_unixctl_show_cb, &data);
1617
1618         if (error) {
1619             ds_put_format(&ds, "failed to dump queues: %s", strerror(error));
1620         }
1621         unixctl_command_reply(conn, 200, ds_cstr(&ds));
1622     } else {
1623         ds_put_format(&ds, "QoS not configured on %s\n", iface->name);
1624         unixctl_command_reply(conn, 501, ds_cstr(&ds));
1625     }
1626
1627     shash_destroy_free_data(&sh);
1628     ds_destroy(&ds);
1629 }
1630 \f
1631 /* Bridge reconfiguration functions. */
1632 static struct bridge *
1633 bridge_create(const struct ovsrec_bridge *br_cfg)
1634 {
1635     struct bridge *br;
1636     int error;
1637
1638     assert(!bridge_lookup(br_cfg->name));
1639     br = xzalloc(sizeof *br);
1640
1641     error = dpif_create_and_open(br_cfg->name, br_cfg->datapath_type,
1642                                  &br->dpif);
1643     if (error) {
1644         free(br);
1645         return NULL;
1646     }
1647
1648     error = ofproto_create(br_cfg->name, br_cfg->datapath_type, &bridge_ofhooks,
1649                            br, &br->ofproto);
1650     if (error) {
1651         VLOG_ERR("failed to create switch %s: %s", br_cfg->name,
1652                  strerror(error));
1653         dpif_delete(br->dpif);
1654         dpif_close(br->dpif);
1655         free(br);
1656         return NULL;
1657     }
1658
1659     br->name = xstrdup(br_cfg->name);
1660     br->cfg = br_cfg;
1661     br->ml = mac_learning_create();
1662     eth_addr_nicira_random(br->default_ea);
1663
1664     hmap_init(&br->ports);
1665     hmap_init(&br->ifaces);
1666     shash_init(&br->iface_by_name);
1667
1668     br->flush = false;
1669
1670     list_push_back(&all_bridges, &br->node);
1671
1672     VLOG_INFO("created bridge %s on %s", br->name, dpif_name(br->dpif));
1673
1674     return br;
1675 }
1676
1677 static void
1678 bridge_destroy(struct bridge *br)
1679 {
1680     if (br) {
1681         struct port *port, *next;
1682         int error;
1683
1684         HMAP_FOR_EACH_SAFE (port, next, hmap_node, &br->ports) {
1685             port_destroy(port);
1686         }
1687         list_remove(&br->node);
1688         ofproto_destroy(br->ofproto);
1689         error = dpif_delete(br->dpif);
1690         if (error && error != ENOENT) {
1691             VLOG_ERR("failed to delete %s: %s",
1692                      dpif_name(br->dpif), strerror(error));
1693         }
1694         dpif_close(br->dpif);
1695         mac_learning_destroy(br->ml);
1696         hmap_destroy(&br->ifaces);
1697         hmap_destroy(&br->ports);
1698         shash_destroy(&br->iface_by_name);
1699         free(br->name);
1700         free(br);
1701     }
1702 }
1703
1704 static struct bridge *
1705 bridge_lookup(const char *name)
1706 {
1707     struct bridge *br;
1708
1709     LIST_FOR_EACH (br, node, &all_bridges) {
1710         if (!strcmp(br->name, name)) {
1711             return br;
1712         }
1713     }
1714     return NULL;
1715 }
1716
1717 /* Handle requests for a listing of all flows known by the OpenFlow
1718  * stack, including those normally hidden. */
1719 static void
1720 bridge_unixctl_dump_flows(struct unixctl_conn *conn,
1721                           const char *args, void *aux OVS_UNUSED)
1722 {
1723     struct bridge *br;
1724     struct ds results;
1725
1726     br = bridge_lookup(args);
1727     if (!br) {
1728         unixctl_command_reply(conn, 501, "Unknown bridge");
1729         return;
1730     }
1731
1732     ds_init(&results);
1733     ofproto_get_all_flows(br->ofproto, &results);
1734
1735     unixctl_command_reply(conn, 200, ds_cstr(&results));
1736     ds_destroy(&results);
1737 }
1738
1739 /* "bridge/reconnect [BRIDGE]": makes BRIDGE drop all of its controller
1740  * connections and reconnect.  If BRIDGE is not specified, then all bridges
1741  * drop their controller connections and reconnect. */
1742 static void
1743 bridge_unixctl_reconnect(struct unixctl_conn *conn,
1744                          const char *args, void *aux OVS_UNUSED)
1745 {
1746     struct bridge *br;
1747     if (args[0] != '\0') {
1748         br = bridge_lookup(args);
1749         if (!br) {
1750             unixctl_command_reply(conn, 501, "Unknown bridge");
1751             return;
1752         }
1753         ofproto_reconnect_controllers(br->ofproto);
1754     } else {
1755         LIST_FOR_EACH (br, node, &all_bridges) {
1756             ofproto_reconnect_controllers(br->ofproto);
1757         }
1758     }
1759     unixctl_command_reply(conn, 200, NULL);
1760 }
1761
1762 static int
1763 bridge_run_one(struct bridge *br)
1764 {
1765     struct port *port;
1766     int error;
1767
1768     error = ofproto_run1(br->ofproto);
1769     if (error) {
1770         return error;
1771     }
1772
1773     mac_learning_run(br->ml, ofproto_get_revalidate_set(br->ofproto));
1774
1775     HMAP_FOR_EACH (port, hmap_node, &br->ports) {
1776         port_run(port);
1777     }
1778
1779     error = ofproto_run2(br->ofproto, br->flush);
1780     br->flush = false;
1781
1782     return error;
1783 }
1784
1785 static size_t
1786 bridge_get_controllers(const struct bridge *br,
1787                        struct ovsrec_controller ***controllersp)
1788 {
1789     struct ovsrec_controller **controllers;
1790     size_t n_controllers;
1791
1792     controllers = br->cfg->controller;
1793     n_controllers = br->cfg->n_controller;
1794
1795     if (n_controllers == 1 && !strcmp(controllers[0]->target, "none")) {
1796         controllers = NULL;
1797         n_controllers = 0;
1798     }
1799
1800     if (controllersp) {
1801         *controllersp = controllers;
1802     }
1803     return n_controllers;
1804 }
1805
1806 static void
1807 bridge_reconfigure_one(struct bridge *br)
1808 {
1809     enum ofproto_fail_mode fail_mode;
1810     struct port *port, *next;
1811     struct shash_node *node;
1812     struct shash new_ports;
1813     size_t i;
1814
1815     /* Collect new ports. */
1816     shash_init(&new_ports);
1817     for (i = 0; i < br->cfg->n_ports; i++) {
1818         const char *name = br->cfg->ports[i]->name;
1819         if (!shash_add_once(&new_ports, name, br->cfg->ports[i])) {
1820             VLOG_WARN("bridge %s: %s specified twice as bridge port",
1821                       br->name, name);
1822         }
1823     }
1824
1825     /* If we have a controller, then we need a local port.  Complain if the
1826      * user didn't specify one.
1827      *
1828      * XXX perhaps we should synthesize a port ourselves in this case. */
1829     if (bridge_get_controllers(br, NULL)) {
1830         char local_name[IF_NAMESIZE];
1831         int error;
1832
1833         error = dpif_port_get_name(br->dpif, ODPP_LOCAL,
1834                                    local_name, sizeof local_name);
1835         if (!error && !shash_find(&new_ports, local_name)) {
1836             VLOG_WARN("bridge %s: controller specified but no local port "
1837                       "(port named %s) defined",
1838                       br->name, local_name);
1839         }
1840     }
1841
1842     /* Get rid of deleted ports.
1843      * Get rid of deleted interfaces on ports that still exist. */
1844     HMAP_FOR_EACH_SAFE (port, next, hmap_node, &br->ports) {
1845         const struct ovsrec_port *port_cfg;
1846
1847         port_cfg = shash_find_data(&new_ports, port->name);
1848         if (!port_cfg) {
1849             port_destroy(port);
1850         } else {
1851             port_del_ifaces(port, port_cfg);
1852         }
1853     }
1854
1855     /* Create new ports.
1856      * Add new interfaces to existing ports.
1857      * Reconfigure existing ports. */
1858     SHASH_FOR_EACH (node, &new_ports) {
1859         struct port *port = port_lookup(br, node->name);
1860         if (!port) {
1861             port = port_create(br, node->name);
1862         }
1863
1864         port_reconfigure(port, node->data);
1865         if (!port->n_ifaces) {
1866             VLOG_WARN("bridge %s: port %s has no interfaces, dropping",
1867                       br->name, port->name);
1868             port_destroy(port);
1869         }
1870     }
1871     shash_destroy(&new_ports);
1872
1873     /* Set the fail-mode */
1874     fail_mode = !br->cfg->fail_mode
1875                 || !strcmp(br->cfg->fail_mode, "standalone")
1876                     ? OFPROTO_FAIL_STANDALONE
1877                     : OFPROTO_FAIL_SECURE;
1878     if (ofproto_get_fail_mode(br->ofproto) != fail_mode
1879         && !ofproto_has_primary_controller(br->ofproto)) {
1880         ofproto_flush_flows(br->ofproto);
1881     }
1882     ofproto_set_fail_mode(br->ofproto, fail_mode);
1883
1884     /* Delete all flows if we're switching from connected to standalone or vice
1885      * versa.  (XXX Should we delete all flows if we are switching from one
1886      * controller to another?) */
1887
1888     /* Configure OpenFlow controller connection snooping. */
1889     if (!ofproto_has_snoops(br->ofproto)) {
1890         struct sset snoops;
1891
1892         sset_init(&snoops);
1893         sset_add_and_free(&snoops, xasprintf("punix:%s/%s.snoop",
1894                                              ovs_rundir(), br->name));
1895         ofproto_set_snoops(br->ofproto, &snoops);
1896         sset_destroy(&snoops);
1897     }
1898
1899     mirror_reconfigure(br);
1900 }
1901
1902 /* Initializes 'oc' appropriately as a management service controller for
1903  * 'br'.
1904  *
1905  * The caller must free oc->target when it is no longer needed. */
1906 static void
1907 bridge_ofproto_controller_for_mgmt(const struct bridge *br,
1908                                    struct ofproto_controller *oc)
1909 {
1910     oc->target = xasprintf("punix:%s/%s.mgmt", ovs_rundir(), br->name);
1911     oc->max_backoff = 0;
1912     oc->probe_interval = 60;
1913     oc->band = OFPROTO_OUT_OF_BAND;
1914     oc->rate_limit = 0;
1915     oc->burst_limit = 0;
1916 }
1917
1918 /* Converts ovsrec_controller 'c' into an ofproto_controller in 'oc'.  */
1919 static void
1920 bridge_ofproto_controller_from_ovsrec(const struct ovsrec_controller *c,
1921                                       struct ofproto_controller *oc)
1922 {
1923     oc->target = c->target;
1924     oc->max_backoff = c->max_backoff ? *c->max_backoff / 1000 : 8;
1925     oc->probe_interval = c->inactivity_probe ? *c->inactivity_probe / 1000 : 5;
1926     oc->band = (!c->connection_mode || !strcmp(c->connection_mode, "in-band")
1927                 ? OFPROTO_IN_BAND : OFPROTO_OUT_OF_BAND);
1928     oc->rate_limit = c->controller_rate_limit ? *c->controller_rate_limit : 0;
1929     oc->burst_limit = (c->controller_burst_limit
1930                        ? *c->controller_burst_limit : 0);
1931 }
1932
1933 /* Configures the IP stack for 'br''s local interface properly according to the
1934  * configuration in 'c'.  */
1935 static void
1936 bridge_configure_local_iface_netdev(struct bridge *br,
1937                                     struct ovsrec_controller *c)
1938 {
1939     struct netdev *netdev;
1940     struct in_addr mask, gateway;
1941
1942     struct iface *local_iface;
1943     struct in_addr ip;
1944
1945     /* If there's no local interface or no IP address, give up. */
1946     local_iface = iface_from_dp_ifidx(br, ODPP_LOCAL);
1947     if (!local_iface || !c->local_ip || !inet_aton(c->local_ip, &ip)) {
1948         return;
1949     }
1950
1951     /* Bring up the local interface. */
1952     netdev = local_iface->netdev;
1953     netdev_turn_flags_on(netdev, NETDEV_UP, true);
1954
1955     /* Configure the IP address and netmask. */
1956     if (!c->local_netmask
1957         || !inet_aton(c->local_netmask, &mask)
1958         || !mask.s_addr) {
1959         mask.s_addr = guess_netmask(ip.s_addr);
1960     }
1961     if (!netdev_set_in4(netdev, ip, mask)) {
1962         VLOG_INFO("bridge %s: configured IP address "IP_FMT", netmask "IP_FMT,
1963                   br->name, IP_ARGS(&ip.s_addr), IP_ARGS(&mask.s_addr));
1964     }
1965
1966     /* Configure the default gateway. */
1967     if (c->local_gateway
1968         && inet_aton(c->local_gateway, &gateway)
1969         && gateway.s_addr) {
1970         if (!netdev_add_router(netdev, gateway)) {
1971             VLOG_INFO("bridge %s: configured gateway "IP_FMT,
1972                       br->name, IP_ARGS(&gateway.s_addr));
1973         }
1974     }
1975 }
1976
1977 static void
1978 bridge_reconfigure_remotes(struct bridge *br,
1979                            const struct sockaddr_in *managers,
1980                            size_t n_managers)
1981 {
1982     const char *disable_ib_str, *queue_id_str;
1983     bool disable_in_band = false;
1984     int queue_id;
1985
1986     struct ovsrec_controller **controllers;
1987     size_t n_controllers;
1988     bool had_primary;
1989
1990     struct ofproto_controller *ocs;
1991     size_t n_ocs;
1992     size_t i;
1993
1994     /* Check if we should disable in-band control on this bridge. */
1995     disable_ib_str = bridge_get_other_config(br->cfg, "disable-in-band");
1996     if (disable_ib_str && !strcmp(disable_ib_str, "true")) {
1997         disable_in_band = true;
1998     }
1999
2000     /* Set OpenFlow queue ID for in-band control. */
2001     queue_id_str = bridge_get_other_config(br->cfg, "in-band-queue");
2002     queue_id = queue_id_str ? strtol(queue_id_str, NULL, 10) : -1;
2003     ofproto_set_in_band_queue(br->ofproto, queue_id);
2004
2005     if (disable_in_band) {
2006         ofproto_set_extra_in_band_remotes(br->ofproto, NULL, 0);
2007     } else {
2008         ofproto_set_extra_in_band_remotes(br->ofproto, managers, n_managers);
2009     }
2010     had_primary = ofproto_has_primary_controller(br->ofproto);
2011
2012     n_controllers = bridge_get_controllers(br, &controllers);
2013
2014     ocs = xmalloc((n_controllers + 1) * sizeof *ocs);
2015     n_ocs = 0;
2016
2017     bridge_ofproto_controller_for_mgmt(br, &ocs[n_ocs++]);
2018     for (i = 0; i < n_controllers; i++) {
2019         struct ovsrec_controller *c = controllers[i];
2020
2021         if (!strncmp(c->target, "punix:", 6)
2022             || !strncmp(c->target, "unix:", 5)) {
2023             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2024
2025             /* Prevent remote ovsdb-server users from accessing arbitrary Unix
2026              * domain sockets and overwriting arbitrary local files. */
2027             VLOG_ERR_RL(&rl, "%s: not adding Unix domain socket controller "
2028                         "\"%s\" due to possibility for remote exploit",
2029                         dpif_name(br->dpif), c->target);
2030             continue;
2031         }
2032
2033         bridge_configure_local_iface_netdev(br, c);
2034         bridge_ofproto_controller_from_ovsrec(c, &ocs[n_ocs]);
2035         if (disable_in_band) {
2036             ocs[n_ocs].band = OFPROTO_OUT_OF_BAND;
2037         }
2038         n_ocs++;
2039     }
2040
2041     ofproto_set_controllers(br->ofproto, ocs, n_ocs);
2042     free(ocs[0].target); /* From bridge_ofproto_controller_for_mgmt(). */
2043     free(ocs);
2044
2045     if (had_primary != ofproto_has_primary_controller(br->ofproto)) {
2046         ofproto_flush_flows(br->ofproto);
2047     }
2048
2049     /* If there are no controllers and the bridge is in standalone
2050      * mode, set up a flow that matches every packet and directs
2051      * them to OFPP_NORMAL (which goes to us).  Otherwise, the
2052      * switch is in secure mode and we won't pass any traffic until
2053      * a controller has been defined and it tells us to do so. */
2054     if (!n_controllers
2055         && ofproto_get_fail_mode(br->ofproto) == OFPROTO_FAIL_STANDALONE) {
2056         union ofp_action action;
2057         struct cls_rule rule;
2058
2059         memset(&action, 0, sizeof action);
2060         action.type = htons(OFPAT_OUTPUT);
2061         action.output.len = htons(sizeof action);
2062         action.output.port = htons(OFPP_NORMAL);
2063         cls_rule_init_catchall(&rule, 0);
2064         ofproto_add_flow(br->ofproto, &rule, &action, 1);
2065     }
2066 }
2067
2068 static void
2069 bridge_get_all_ifaces(const struct bridge *br, struct shash *ifaces)
2070 {
2071     struct port *port;
2072
2073     shash_init(ifaces);
2074     HMAP_FOR_EACH (port, hmap_node, &br->ports) {
2075         struct iface *iface;
2076
2077         LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
2078             shash_add_once(ifaces, iface->name, iface);
2079         }
2080         if (port->n_ifaces > 1 && port->cfg->bond_fake_iface) {
2081             shash_add_once(ifaces, port->name, NULL);
2082         }
2083     }
2084 }
2085
2086 /* For robustness, in case the administrator moves around datapath ports behind
2087  * our back, we re-check all the datapath port numbers here.
2088  *
2089  * This function will set the 'dp_ifidx' members of interfaces that have
2090  * disappeared to -1, so only call this function from a context where those
2091  * 'struct iface's will be removed from the bridge.  Otherwise, the -1
2092  * 'dp_ifidx'es will cause trouble later when we try to send them to the
2093  * datapath, which doesn't support UINT16_MAX+1 ports. */
2094 static void
2095 bridge_fetch_dp_ifaces(struct bridge *br)
2096 {
2097     struct dpif_port_dump dump;
2098     struct dpif_port dpif_port;
2099     struct port *port;
2100
2101     /* Reset all interface numbers. */
2102     HMAP_FOR_EACH (port, hmap_node, &br->ports) {
2103         struct iface *iface;
2104
2105         LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
2106             iface->dp_ifidx = -1;
2107         }
2108     }
2109     hmap_clear(&br->ifaces);
2110
2111     DPIF_PORT_FOR_EACH (&dpif_port, &dump, br->dpif) {
2112         struct iface *iface = iface_lookup(br, dpif_port.name);
2113         if (iface) {
2114             if (iface->dp_ifidx >= 0) {
2115                 VLOG_WARN("%s reported interface %s twice",
2116                           dpif_name(br->dpif), dpif_port.name);
2117             } else if (iface_from_dp_ifidx(br, dpif_port.port_no)) {
2118                 VLOG_WARN("%s reported interface %"PRIu16" twice",
2119                           dpif_name(br->dpif), dpif_port.port_no);
2120             } else {
2121                 iface->dp_ifidx = dpif_port.port_no;
2122                 hmap_insert(&br->ifaces, &iface->dp_ifidx_node,
2123                             hash_int(iface->dp_ifidx, 0));
2124             }
2125
2126             iface_set_ofport(iface->cfg,
2127                              (iface->dp_ifidx >= 0
2128                               ? odp_port_to_ofp_port(iface->dp_ifidx)
2129                               : -1));
2130         }
2131     }
2132 }
2133 \f
2134 /* Bridge packet processing functions. */
2135
2136 static bool
2137 bond_is_tcp_hash(const struct port *port)
2138 {
2139     return port->bond_mode == BM_TCP && lacp_negotiated(port->lacp);
2140 }
2141
2142 static int
2143 bond_hash_src(const uint8_t mac[ETH_ADDR_LEN], uint16_t vlan)
2144 {
2145     return hash_bytes(mac, ETH_ADDR_LEN, vlan) & BOND_MASK;
2146 }
2147
2148 static int bond_hash_tcp(const struct flow *flow, uint16_t vlan)
2149 {
2150     struct flow hash_flow;
2151
2152     memcpy(&hash_flow, flow, sizeof hash_flow);
2153     hash_flow.vlan_tci = 0;
2154
2155     /* The symmetric quality of this hash function is not required, but
2156      * flow_hash_symmetric_l4 already exists, and is sufficient for our
2157      * purposes, so we use it out of convenience. */
2158     return flow_hash_symmetric_l4(&hash_flow, vlan) & BOND_MASK;
2159 }
2160
2161 static struct bond_entry *
2162 lookup_bond_entry(const struct port *port, const struct flow *flow,
2163                   uint16_t vlan)
2164 {
2165     assert(port->bond_mode != BM_AB);
2166
2167     if (bond_is_tcp_hash(port)) {
2168         return &port->bond_hash[bond_hash_tcp(flow, vlan)];
2169     } else {
2170         return &port->bond_hash[bond_hash_src(flow->dl_src, vlan)];
2171     }
2172 }
2173
2174 static struct iface *
2175 bond_choose_iface(const struct port *port)
2176 {
2177     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
2178     struct iface *best_down_slave;
2179     struct iface *iface;
2180
2181     best_down_slave = NULL;
2182     LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
2183         if (iface->enabled) {
2184             return iface;
2185         } else if ((!best_down_slave
2186                     || iface->delay_expires < best_down_slave->delay_expires)
2187                    && lacp_slave_may_enable(port->lacp, iface)) {
2188             best_down_slave = iface;
2189         }
2190     }
2191
2192     if (best_down_slave) {
2193         VLOG_INFO_RL(&rl, "interface %s: skipping remaining %lli ms updelay "
2194                      "since no other interface is up",
2195                      best_down_slave->name,
2196                      best_down_slave->delay_expires - time_msec());
2197         bond_enable_slave(best_down_slave, true);
2198     }
2199
2200     return best_down_slave;
2201 }
2202
2203 static bool
2204 choose_output_iface(const struct port *port, const struct flow *flow,
2205                     uint16_t vlan, uint16_t *dp_ifidx, tag_type *tags)
2206 {
2207     struct iface *iface;
2208
2209     assert(port->n_ifaces);
2210     if (port->n_ifaces == 1) {
2211         iface = port_get_an_iface(port);
2212     } else if (port->bond_mode == BM_AB) {
2213         iface = port->active_iface;
2214         if (!iface) {
2215             *tags |= port->no_ifaces_tag;
2216             return false;
2217         }
2218     } else {
2219         struct bond_entry *e = lookup_bond_entry(port, flow, vlan);
2220         if (!e->iface || !e->iface->enabled) {
2221             /* XXX select interface properly.  The current interface selection
2222              * is only good for testing the rebalancing code. */
2223             e->iface = bond_choose_iface(port);
2224             if (!e->iface) {
2225                 *tags |= port->no_ifaces_tag;
2226                 return false;
2227             }
2228             e->tag = tag_create_random();
2229         }
2230         *tags |= e->tag;
2231         iface = e->iface;
2232     }
2233     *dp_ifidx = iface->dp_ifidx;
2234     *tags |= iface->tag;        /* Currently only used for bonding. */
2235     return true;
2236 }
2237
2238 static void
2239 bond_link_status_update(struct iface *iface)
2240 {
2241     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
2242     struct port *port = iface->port;
2243     bool up = iface->up && lacp_slave_may_enable(port->lacp, iface);
2244     int updelay, downdelay;
2245
2246     updelay = port->updelay;
2247     downdelay = port->downdelay;
2248
2249     if (lacp_negotiated(port->lacp)) {
2250         downdelay = 0;
2251         updelay = 0;
2252     }
2253
2254     if ((up == iface->enabled) == (iface->delay_expires == LLONG_MAX)) {
2255         /* Nothing to do. */
2256         return;
2257     }
2258     VLOG_INFO_RL(&rl, "interface %s: link state %s",
2259                  iface->name, up ? "up" : "down");
2260     if (up == iface->enabled) {
2261         iface->delay_expires = LLONG_MAX;
2262         VLOG_INFO_RL(&rl, "interface %s: will not be %s",
2263                      iface->name, up ? "disabled" : "enabled");
2264     } else if (up && !port->active_iface) {
2265         bond_enable_slave(iface, true);
2266         if (updelay) {
2267             VLOG_INFO_RL(&rl, "interface %s: skipping %d ms updelay since no "
2268                          "other interface is up", iface->name, updelay);
2269         }
2270     } else {
2271         int delay = up ? updelay : downdelay;
2272         iface->delay_expires = time_msec() + delay;
2273         if (delay) {
2274             VLOG_INFO_RL(&rl,
2275                          "interface %s: will be %s if it stays %s for %d ms",
2276                          iface->name,
2277                          up ? "enabled" : "disabled",
2278                          up ? "up" : "down",
2279                          delay);
2280         }
2281     }
2282 }
2283
2284 static void
2285 bond_choose_active_iface(struct port *port)
2286 {
2287     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
2288
2289     port->active_iface = bond_choose_iface(port);
2290     if (port->active_iface) {
2291         VLOG_INFO_RL(&rl, "port %s: active interface is now %s",
2292                      port->name, port->active_iface->name);
2293     } else {
2294         VLOG_WARN_RL(&rl, "port %s: all ports disabled, no active interface",
2295                      port->name);
2296     }
2297 }
2298
2299 static void
2300 bond_enable_slave(struct iface *iface, bool enable)
2301 {
2302     struct port *port = iface->port;
2303     struct bridge *br = port->bridge;
2304
2305     /* This acts as a recursion check.  If the act of disabling a slave
2306      * causes a different slave to be enabled, the flag will allow us to
2307      * skip redundant work when we reenter this function.  It must be
2308      * cleared on exit to keep things safe with multiple bonds. */
2309     static bool moving_active_iface = false;
2310
2311     iface->delay_expires = LLONG_MAX;
2312     if (enable == iface->enabled) {
2313         return;
2314     }
2315
2316     iface->enabled = enable;
2317     if (!iface->enabled) {
2318         VLOG_WARN("interface %s: disabled", iface->name);
2319         ofproto_revalidate(br->ofproto, iface->tag);
2320         if (iface == port->active_iface) {
2321             /* Disabling a slave can lead to another slave being immediately
2322              * enabled if there will be no active slaves but one is waiting
2323              * on an updelay.  In this case we do not need to run most of the
2324              * code for the newly enabled slave since there was no period
2325              * without an active slave and it is redundant with the disabling
2326              * path. */
2327             moving_active_iface = true;
2328             bond_choose_active_iface(port);
2329         }
2330         bond_send_learning_packets(port);
2331     } else {
2332         VLOG_WARN("interface %s: enabled", iface->name);
2333         if (!port->active_iface && !moving_active_iface) {
2334             ofproto_revalidate(br->ofproto, port->no_ifaces_tag);
2335             bond_choose_active_iface(port);
2336             bond_send_learning_packets(port);
2337         }
2338         iface->tag = tag_create_random();
2339     }
2340
2341     moving_active_iface = false;
2342 }
2343
2344 /* Attempts to make the sum of the bond slaves' statistics appear on the fake
2345  * bond interface. */
2346 static void
2347 bond_update_fake_iface_stats(struct port *port)
2348 {
2349     struct netdev_stats bond_stats;
2350     struct netdev *bond_dev;
2351     struct iface *iface;
2352
2353     memset(&bond_stats, 0, sizeof bond_stats);
2354
2355     LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
2356         struct netdev_stats slave_stats;
2357
2358         if (!netdev_get_stats(iface->netdev, &slave_stats)) {
2359             /* XXX: We swap the stats here because they are swapped back when
2360              * reported by the internal device.  The reason for this is
2361              * internal devices normally represent packets going into the system
2362              * but when used as fake bond device they represent packets leaving
2363              * the system.  We really should do this in the internal device
2364              * itself because changing it here reverses the counts from the
2365              * perspective of the switch.  However, the internal device doesn't
2366              * know what type of device it represents so we have to do it here
2367              * for now. */
2368             bond_stats.tx_packets += slave_stats.rx_packets;
2369             bond_stats.tx_bytes += slave_stats.rx_bytes;
2370             bond_stats.rx_packets += slave_stats.tx_packets;
2371             bond_stats.rx_bytes += slave_stats.tx_bytes;
2372         }
2373     }
2374
2375     if (!netdev_open_default(port->name, &bond_dev)) {
2376         netdev_set_stats(bond_dev, &bond_stats);
2377         netdev_close(bond_dev);
2378     }
2379 }
2380
2381 static void
2382 bond_run(struct port *port)
2383 {
2384     struct iface *iface;
2385
2386     if (port->n_ifaces < 2) {
2387         return;
2388     }
2389
2390     LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
2391         bond_link_status_update(iface);
2392     }
2393
2394     LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
2395         if (time_msec() >= iface->delay_expires) {
2396             bond_enable_slave(iface, !iface->enabled);
2397         }
2398     }
2399
2400     if (port->bond_fake_iface
2401         && time_msec() >= port->bond_next_fake_iface_update) {
2402         bond_update_fake_iface_stats(port);
2403         port->bond_next_fake_iface_update = time_msec() + 1000;
2404     }
2405 }
2406
2407 static void
2408 bond_wait(struct port *port)
2409 {
2410     struct iface *iface;
2411
2412     if (port->n_ifaces < 2) {
2413         return;
2414     }
2415
2416     LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
2417         if (iface->delay_expires != LLONG_MAX) {
2418             poll_timer_wait_until(iface->delay_expires);
2419         }
2420     }
2421
2422     if (port->bond_fake_iface) {
2423         poll_timer_wait_until(port->bond_next_fake_iface_update);
2424     }
2425 }
2426
2427 static bool
2428 set_dst(struct dst *dst, const struct flow *flow,
2429         const struct port *in_port, const struct port *out_port,
2430         tag_type *tags)
2431 {
2432     dst->vlan = (out_port->vlan >= 0 ? OFP_VLAN_NONE
2433               : in_port->vlan >= 0 ? in_port->vlan
2434               : flow->vlan_tci == 0 ? OFP_VLAN_NONE
2435               : vlan_tci_to_vid(flow->vlan_tci));
2436     return choose_output_iface(out_port, flow, dst->vlan,
2437                                &dst->dp_ifidx, tags);
2438 }
2439
2440 static void
2441 swap_dst(struct dst *p, struct dst *q)
2442 {
2443     struct dst tmp = *p;
2444     *p = *q;
2445     *q = tmp;
2446 }
2447
2448 /* Moves all the dsts with vlan == 'vlan' to the front of the 'n_dsts' in
2449  * 'dsts'.  (This may help performance by reducing the number of VLAN changes
2450  * that we push to the datapath.  We could in fact fully sort the array by
2451  * vlan, but in most cases there are at most two different vlan tags so that's
2452  * possibly overkill.) */
2453 static void
2454 partition_dsts(struct dst_set *set, int vlan)
2455 {
2456     struct dst *first = set->dsts;
2457     struct dst *last = set->dsts + set->n;
2458
2459     while (first != last) {
2460         /* Invariants:
2461          *      - All dsts < first have vlan == 'vlan'.
2462          *      - All dsts >= last have vlan != 'vlan'.
2463          *      - first < last. */
2464         while (first->vlan == vlan) {
2465             if (++first == last) {
2466                 return;
2467             }
2468         }
2469
2470         /* Same invariants, plus one additional:
2471          *      - first->vlan != vlan.
2472          */
2473         while (last[-1].vlan != vlan) {
2474             if (--last == first) {
2475                 return;
2476             }
2477         }
2478
2479         /* Same invariants, plus one additional:
2480          *      - last[-1].vlan == vlan.*/
2481         swap_dst(first++, --last);
2482     }
2483 }
2484
2485 static int
2486 mirror_mask_ffs(mirror_mask_t mask)
2487 {
2488     BUILD_ASSERT_DECL(sizeof(unsigned int) >= sizeof(mask));
2489     return ffs(mask);
2490 }
2491
2492 static void
2493 dst_set_init(struct dst_set *set)
2494 {
2495     set->dsts = set->builtin;
2496     set->n = 0;
2497     set->allocated = ARRAY_SIZE(set->builtin);
2498 }
2499
2500 static void
2501 dst_set_add(struct dst_set *set, const struct dst *dst)
2502 {
2503     if (set->n >= set->allocated) {
2504         size_t new_allocated;
2505         struct dst *new_dsts;
2506
2507         new_allocated = set->allocated * 2;
2508         new_dsts = xmalloc(new_allocated * sizeof *new_dsts);
2509         memcpy(new_dsts, set->dsts, set->n * sizeof *new_dsts);
2510
2511         dst_set_free(set);
2512
2513         set->dsts = new_dsts;
2514         set->allocated = new_allocated;
2515     }
2516     set->dsts[set->n++] = *dst;
2517 }
2518
2519 static void
2520 dst_set_free(struct dst_set *set)
2521 {
2522     if (set->dsts != set->builtin) {
2523         free(set->dsts);
2524     }
2525 }
2526
2527 static bool
2528 dst_is_duplicate(const struct dst_set *set, const struct dst *test)
2529 {
2530     size_t i;
2531     for (i = 0; i < set->n; i++) {
2532         if (set->dsts[i].vlan == test->vlan
2533             && set->dsts[i].dp_ifidx == test->dp_ifidx) {
2534             return true;
2535         }
2536     }
2537     return false;
2538 }
2539
2540 static bool
2541 port_trunks_vlan(const struct port *port, uint16_t vlan)
2542 {
2543     return (port->vlan < 0
2544             && (!port->trunks || bitmap_is_set(port->trunks, vlan)));
2545 }
2546
2547 static bool
2548 port_includes_vlan(const struct port *port, uint16_t vlan)
2549 {
2550     return vlan == port->vlan || port_trunks_vlan(port, vlan);
2551 }
2552
2553 static bool
2554 port_is_floodable(const struct port *port)
2555 {
2556     struct iface *iface;
2557
2558     LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
2559         if (!ofproto_port_is_floodable(port->bridge->ofproto,
2560                                        iface->dp_ifidx)) {
2561             return false;
2562         }
2563     }
2564     return true;
2565 }
2566
2567 /* Returns the tag for 'port''s active iface, or 'port''s no_ifaces_tag if
2568  * there is no active iface. */
2569 static tag_type
2570 port_get_active_iface_tag(const struct port *port)
2571 {
2572     return (port->active_iface
2573             ? port->active_iface->tag
2574             : port->no_ifaces_tag);
2575 }
2576
2577 /* Returns an arbitrary interface within 'port'.
2578  *
2579  * 'port' must have at least one interface. */
2580 static struct iface *
2581 port_get_an_iface(const struct port *port)
2582 {
2583     return CONTAINER_OF(list_front(&port->ifaces), struct iface, port_elem);
2584 }
2585
2586 static void
2587 compose_dsts(const struct bridge *br, const struct flow *flow, uint16_t vlan,
2588              const struct port *in_port, const struct port *out_port,
2589              struct dst_set *set, tag_type *tags, uint16_t *nf_output_iface)
2590 {
2591     mirror_mask_t mirrors = in_port->src_mirrors;
2592     struct dst dst;
2593     int flow_vlan;
2594
2595     flow_vlan = vlan_tci_to_vid(flow->vlan_tci);
2596     if (flow_vlan == 0) {
2597         flow_vlan = OFP_VLAN_NONE;
2598     }
2599
2600     if (out_port == FLOOD_PORT) {
2601         struct port *port;
2602
2603         HMAP_FOR_EACH (port, hmap_node, &br->ports) {
2604             if (port != in_port
2605                 && port_is_floodable(port)
2606                 && port_includes_vlan(port, vlan)
2607                 && !port->is_mirror_output_port
2608                 && set_dst(&dst, flow, in_port, port, tags)) {
2609                 mirrors |= port->dst_mirrors;
2610                 dst_set_add(set, &dst);
2611             }
2612         }
2613         *nf_output_iface = NF_OUT_FLOOD;
2614     } else if (out_port && set_dst(&dst, flow, in_port, out_port, tags)) {
2615         dst_set_add(set, &dst);
2616         *nf_output_iface = dst.dp_ifidx;
2617         mirrors |= out_port->dst_mirrors;
2618     }
2619
2620     while (mirrors) {
2621         struct mirror *m = br->mirrors[mirror_mask_ffs(mirrors) - 1];
2622         if (!m->n_vlans || vlan_is_mirrored(m, vlan)) {
2623             if (m->out_port) {
2624                 if (set_dst(&dst, flow, in_port, m->out_port, tags)
2625                     && !dst_is_duplicate(set, &dst)) {
2626                     dst_set_add(set, &dst);
2627                 }
2628             } else {
2629                 struct port *port;
2630
2631                 HMAP_FOR_EACH (port, hmap_node, &br->ports) {
2632                     if (port_includes_vlan(port, m->out_vlan)
2633                         && set_dst(&dst, flow, in_port, port, tags))
2634                     {
2635                         if (port->vlan < 0) {
2636                             dst.vlan = m->out_vlan;
2637                         }
2638                         if (dst_is_duplicate(set, &dst)) {
2639                             continue;
2640                         }
2641
2642                         /* Use the vlan tag on the original flow instead of
2643                          * the one passed in the vlan parameter.  This ensures
2644                          * that we compare the vlan from before any implicit
2645                          * tagging tags place. This is necessary because
2646                          * dst->vlan is the final vlan, after removing implicit
2647                          * tags. */
2648                         if (port == in_port && dst.vlan == flow_vlan) {
2649                             /* Don't send out input port on same VLAN. */
2650                             continue;
2651                         }
2652                         dst_set_add(set, &dst);
2653                     }
2654                 }
2655             }
2656         }
2657         mirrors &= mirrors - 1;
2658     }
2659
2660     partition_dsts(set, flow_vlan);
2661 }
2662
2663 static void OVS_UNUSED
2664 print_dsts(const struct dst_set *set)
2665 {
2666     size_t i;
2667
2668     for (i = 0; i < set->n; i++) {
2669         const struct dst *dst = &set->dsts[i];
2670
2671         printf(">p%"PRIu16, dst->dp_ifidx);
2672         if (dst->vlan != OFP_VLAN_NONE) {
2673             printf("v%"PRIu16, dst->vlan);
2674         }
2675     }
2676 }
2677
2678 static void
2679 compose_actions(struct bridge *br, const struct flow *flow, uint16_t vlan,
2680                 const struct port *in_port, const struct port *out_port,
2681                 tag_type *tags, struct ofpbuf *actions,
2682                 uint16_t *nf_output_iface)
2683 {
2684     struct dst_set set;
2685     uint16_t cur_vlan;
2686     size_t i;
2687
2688     dst_set_init(&set);
2689     compose_dsts(br, flow, vlan, in_port, out_port, &set, tags,
2690                  nf_output_iface);
2691
2692     cur_vlan = vlan_tci_to_vid(flow->vlan_tci);
2693     if (cur_vlan == 0) {
2694         cur_vlan = OFP_VLAN_NONE;
2695     }
2696     for (i = 0; i < set.n; i++) {
2697         const struct dst *dst = &set.dsts[i];
2698         if (dst->vlan != cur_vlan) {
2699             if (dst->vlan == OFP_VLAN_NONE) {
2700                 nl_msg_put_flag(actions, ODP_ACTION_ATTR_STRIP_VLAN);
2701             } else {
2702                 ovs_be16 tci;
2703                 tci = htons(dst->vlan & VLAN_VID_MASK);
2704                 tci |= flow->vlan_tci & htons(VLAN_PCP_MASK);
2705                 nl_msg_put_be16(actions, ODP_ACTION_ATTR_SET_DL_TCI, tci);
2706             }
2707             cur_vlan = dst->vlan;
2708         }
2709         nl_msg_put_u32(actions, ODP_ACTION_ATTR_OUTPUT, dst->dp_ifidx);
2710     }
2711     dst_set_free(&set);
2712 }
2713
2714 /* Returns the effective vlan of a packet, taking into account both the
2715  * 802.1Q header and implicitly tagged ports.  A value of 0 indicates that
2716  * the packet is untagged and -1 indicates it has an invalid header and
2717  * should be dropped. */
2718 static int flow_get_vlan(struct bridge *br, const struct flow *flow,
2719                          struct port *in_port, bool have_packet)
2720 {
2721     int vlan = vlan_tci_to_vid(flow->vlan_tci);
2722     if (in_port->vlan >= 0) {
2723         if (vlan) {
2724             /* XXX support double tagging? */
2725             if (have_packet) {
2726                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2727                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %d tagged "
2728                              "packet received on port %s configured with "
2729                              "implicit VLAN %"PRIu16,
2730                              br->name, vlan, in_port->name, in_port->vlan);
2731             }
2732             return -1;
2733         }
2734         vlan = in_port->vlan;
2735     } else {
2736         if (!port_includes_vlan(in_port, vlan)) {
2737             if (have_packet) {
2738                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2739                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %d tagged "
2740                              "packet received on port %s not configured for "
2741                              "trunking VLAN %d",
2742                              br->name, vlan, in_port->name, vlan);
2743             }
2744             return -1;
2745         }
2746     }
2747
2748     return vlan;
2749 }
2750
2751 /* A VM broadcasts a gratuitous ARP to indicate that it has resumed after
2752  * migration.  Older Citrix-patched Linux DomU used gratuitous ARP replies to
2753  * indicate this; newer upstream kernels use gratuitous ARP requests. */
2754 static bool
2755 is_gratuitous_arp(const struct flow *flow)
2756 {
2757     return (flow->dl_type == htons(ETH_TYPE_ARP)
2758             && eth_addr_is_broadcast(flow->dl_dst)
2759             && (flow->nw_proto == ARP_OP_REPLY
2760                 || (flow->nw_proto == ARP_OP_REQUEST
2761                     && flow->nw_src == flow->nw_dst)));
2762 }
2763
2764 static void
2765 update_learning_table(struct bridge *br, const struct flow *flow, int vlan,
2766                       struct port *in_port)
2767 {
2768     struct mac_entry *mac;
2769
2770     if (!mac_learning_may_learn(br->ml, flow->dl_src, vlan)) {
2771         return;
2772     }
2773
2774     mac = mac_learning_insert(br->ml, flow->dl_src, vlan);
2775     if (is_gratuitous_arp(flow)) {
2776         /* We don't want to learn from gratuitous ARP packets that are
2777          * reflected back over bond slaves so we lock the learning table. */
2778         if (in_port->n_ifaces == 1) {
2779             mac_entry_set_grat_arp_lock(mac);
2780         } else if (mac_entry_is_grat_arp_locked(mac)) {
2781             return;
2782         }
2783     }
2784
2785     if (mac_entry_is_new(mac) || mac->port.p != in_port) {
2786         /* The log messages here could actually be useful in debugging,
2787          * so keep the rate limit relatively high. */
2788         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30, 300);
2789         VLOG_DBG_RL(&rl, "bridge %s: learned that "ETH_ADDR_FMT" is "
2790                     "on port %s in VLAN %d",
2791                     br->name, ETH_ADDR_ARGS(flow->dl_src),
2792                     in_port->name, vlan);
2793
2794         mac->port.p = in_port;
2795         ofproto_revalidate(br->ofproto, mac_learning_changed(br->ml, mac));
2796     }
2797 }
2798
2799 /* Determines whether packets in 'flow' within 'br' should be forwarded or
2800  * dropped.  Returns true if they may be forwarded, false if they should be
2801  * dropped.
2802  *
2803  * If 'have_packet' is true, it indicates that the caller is processing a
2804  * received packet.  If 'have_packet' is false, then the caller is just
2805  * revalidating an existing flow because configuration has changed.  Either
2806  * way, 'have_packet' only affects logging (there is no point in logging errors
2807  * during revalidation).
2808  *
2809  * Sets '*in_portp' to the input port.  This will be a null pointer if
2810  * flow->in_port does not designate a known input port (in which case
2811  * is_admissible() returns false).
2812  *
2813  * When returning true, sets '*vlanp' to the effective VLAN of the input
2814  * packet, as returned by flow_get_vlan().
2815  *
2816  * May also add tags to '*tags', although the current implementation only does
2817  * so in one special case.
2818  */
2819 static bool
2820 is_admissible(struct bridge *br, const struct flow *flow, bool have_packet,
2821               tag_type *tags, int *vlanp, struct port **in_portp)
2822 {
2823     struct iface *in_iface;
2824     struct port *in_port;
2825     int vlan;
2826
2827     /* Find the interface and port structure for the received packet. */
2828     in_iface = iface_from_dp_ifidx(br, flow->in_port);
2829     if (!in_iface) {
2830         /* No interface?  Something fishy... */
2831         if (have_packet) {
2832             /* Odd.  A few possible reasons here:
2833              *
2834              * - We deleted an interface but there are still a few packets
2835              *   queued up from it.
2836              *
2837              * - Someone externally added an interface (e.g. with "ovs-dpctl
2838              *   add-if") that we don't know about.
2839              *
2840              * - Packet arrived on the local port but the local port is not
2841              *   one of our bridge ports.
2842              */
2843             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2844
2845             VLOG_WARN_RL(&rl, "bridge %s: received packet on unknown "
2846                          "interface %"PRIu16, br->name, flow->in_port);
2847         }
2848
2849         *in_portp = NULL;
2850         return false;
2851     }
2852     *in_portp = in_port = in_iface->port;
2853     *vlanp = vlan = flow_get_vlan(br, flow, in_port, have_packet);
2854     if (vlan < 0) {
2855         return false;
2856     }
2857
2858     /* Drop frames for reserved multicast addresses. */
2859     if (eth_addr_is_reserved(flow->dl_dst)) {
2860         return false;
2861     }
2862
2863     /* Drop frames on ports reserved for mirroring. */
2864     if (in_port->is_mirror_output_port) {
2865         if (have_packet) {
2866             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2867             VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port "
2868                          "%s, which is reserved exclusively for mirroring",
2869                          br->name, in_port->name);
2870         }
2871         return false;
2872     }
2873
2874     /* When using LACP, do not accept packets from disabled interfaces. */
2875     if (lacp_negotiated(in_port->lacp) && !in_iface->enabled) {
2876         return false;
2877     }
2878
2879     /* Packets received on non-LACP bonds need special attention to avoid
2880      * duplicates. */
2881     if (in_port->n_ifaces > 1 && !lacp_negotiated(in_port->lacp)) {
2882         struct mac_entry *mac;
2883
2884         if (eth_addr_is_multicast(flow->dl_dst)) {
2885             *tags |= port_get_active_iface_tag(in_port);
2886             if (in_port->active_iface != in_iface) {
2887                 /* Drop all multicast packets on inactive slaves. */
2888                 return false;
2889             }
2890         }
2891
2892         /* Drop all packets for which we have learned a different input
2893          * port, because we probably sent the packet on one slave and got
2894          * it back on the other.  Gratuitous ARP packets are an exception
2895          * to this rule: the host has moved to another switch.  The exception
2896          * to the exception is if we locked the learning table to avoid
2897          * reflections on bond slaves.  If this is the case, just drop the
2898          * packet now. */
2899         mac = mac_learning_lookup(br->ml, flow->dl_src, vlan, NULL);
2900         if (mac && mac->port.p != in_port &&
2901             (!is_gratuitous_arp(flow) || mac_entry_is_grat_arp_locked(mac))) {
2902                 return false;
2903         }
2904     }
2905
2906     return true;
2907 }
2908
2909 /* If the composed actions may be applied to any packet in the given 'flow',
2910  * returns true.  Otherwise, the actions should only be applied to 'packet', or
2911  * not at all, if 'packet' was NULL. */
2912 static bool
2913 process_flow(struct bridge *br, const struct flow *flow,
2914              const struct ofpbuf *packet, struct ofpbuf *actions,
2915              tag_type *tags, uint16_t *nf_output_iface)
2916 {
2917     struct port *in_port;
2918     struct port *out_port;
2919     struct mac_entry *mac;
2920     int vlan;
2921
2922     /* Check whether we should drop packets in this flow. */
2923     if (!is_admissible(br, flow, packet != NULL, tags, &vlan, &in_port)) {
2924         out_port = NULL;
2925         goto done;
2926     }
2927
2928     /* Learn source MAC (but don't try to learn from revalidation). */
2929     if (packet) {
2930         update_learning_table(br, flow, vlan, in_port);
2931     }
2932
2933     /* Determine output port. */
2934     mac = mac_learning_lookup(br->ml, flow->dl_dst, vlan, tags);
2935     if (mac) {
2936         out_port = mac->port.p;
2937     } else if (!packet && !eth_addr_is_multicast(flow->dl_dst)) {
2938         /* If we are revalidating but don't have a learning entry then
2939          * eject the flow.  Installing a flow that floods packets opens
2940          * up a window of time where we could learn from a packet reflected
2941          * on a bond and blackhole packets before the learning table is
2942          * updated to reflect the correct port. */
2943         return false;
2944     } else {
2945         out_port = FLOOD_PORT;
2946     }
2947
2948     /* Don't send packets out their input ports. */
2949     if (in_port == out_port) {
2950         out_port = NULL;
2951     }
2952
2953 done:
2954     if (in_port) {
2955         compose_actions(br, flow, vlan, in_port, out_port, tags, actions,
2956                         nf_output_iface);
2957     }
2958
2959     return true;
2960 }
2961
2962 static bool
2963 bridge_normal_ofhook_cb(const struct flow *flow, const struct ofpbuf *packet,
2964                         struct ofpbuf *actions, tag_type *tags,
2965                         uint16_t *nf_output_iface, void *br_)
2966 {
2967     struct bridge *br = br_;
2968
2969     COVERAGE_INC(bridge_process_flow);
2970     return process_flow(br, flow, packet, actions, tags, nf_output_iface);
2971 }
2972
2973 static bool
2974 bridge_special_ofhook_cb(const struct flow *flow,
2975                          const struct ofpbuf *packet, void *br_)
2976 {
2977     struct iface *iface;
2978     struct bridge *br = br_;
2979
2980     iface = iface_from_dp_ifidx(br, flow->in_port);
2981
2982     if (flow->dl_type == htons(ETH_TYPE_LACP)) {
2983
2984         if (iface && iface->port->lacp && packet) {
2985             const struct lacp_pdu *pdu = parse_lacp_packet(packet);
2986
2987             if (pdu) {
2988                 COVERAGE_INC(bridge_process_lacp);
2989                 lacp_process_pdu(iface->port->lacp, iface, pdu);
2990             }
2991         }
2992         return false;
2993     }
2994
2995     return true;
2996 }
2997
2998 static void
2999 bridge_account_flow_ofhook_cb(const struct flow *flow, tag_type tags,
3000                               const struct nlattr *actions,
3001                               size_t actions_len,
3002                               uint64_t n_bytes, void *br_)
3003 {
3004     struct bridge *br = br_;
3005     const struct nlattr *a;
3006     struct port *in_port;
3007     tag_type dummy = 0;
3008     unsigned int left;
3009     int vlan;
3010
3011     /* Feed information from the active flows back into the learning table to
3012      * ensure that table is always in sync with what is actually flowing
3013      * through the datapath.
3014      *
3015      * We test that 'tags' is nonzero to ensure that only flows that include an
3016      * OFPP_NORMAL action are used for learning.  This works because
3017      * bridge_normal_ofhook_cb() always sets a nonzero tag value. */
3018     if (tags && is_admissible(br, flow, false, &dummy, &vlan, &in_port)) {
3019         update_learning_table(br, flow, vlan, in_port);
3020     }
3021
3022     /* Account for bond slave utilization. */
3023     if (!br->has_bonded_ports) {
3024         return;
3025     }
3026     NL_ATTR_FOR_EACH_UNSAFE (a, left, actions, actions_len) {
3027         if (nl_attr_type(a) == ODP_ACTION_ATTR_OUTPUT) {
3028             struct port *out_port = port_from_dp_ifidx(br, nl_attr_get_u32(a));
3029             if (out_port && out_port->n_ifaces >= 2 &&
3030                 out_port->bond_mode != BM_AB) {
3031                 uint16_t vlan = (flow->vlan_tci
3032                                  ? vlan_tci_to_vid(flow->vlan_tci)
3033                                  : OFP_VLAN_NONE);
3034                 struct bond_entry *e = lookup_bond_entry(out_port, flow, vlan);
3035                 e->tx_bytes += n_bytes;
3036             }
3037         }
3038     }
3039 }
3040
3041 static void
3042 bridge_account_checkpoint_ofhook_cb(void *br_)
3043 {
3044     struct bridge *br = br_;
3045     struct port *port;
3046     long long int now;
3047
3048     if (!br->has_bonded_ports) {
3049         return;
3050     }
3051
3052     now = time_msec();
3053     HMAP_FOR_EACH (port, hmap_node, &br->ports) {
3054         if (port->n_ifaces > 1 && port->bond_mode != BM_AB
3055             && now >= port->bond_next_rebalance) {
3056             port->bond_next_rebalance = now + port->bond_rebalance_interval;
3057             bond_rebalance_port(port);
3058         }
3059     }
3060 }
3061
3062 static struct ofhooks bridge_ofhooks = {
3063     bridge_normal_ofhook_cb,
3064     bridge_special_ofhook_cb,
3065     bridge_account_flow_ofhook_cb,
3066     bridge_account_checkpoint_ofhook_cb,
3067 };
3068 \f
3069 /* Bonding functions. */
3070
3071 /* Statistics for a single interface on a bonded port, used for load-based
3072  * bond rebalancing.  */
3073 struct slave_balance {
3074     struct iface *iface;        /* The interface. */
3075     uint64_t tx_bytes;          /* Sum of hashes[*]->tx_bytes. */
3076
3077     /* All the "bond_entry"s that are assigned to this interface, in order of
3078      * increasing tx_bytes. */
3079     struct bond_entry **hashes;
3080     size_t n_hashes;
3081 };
3082
3083 static const char *
3084 bond_mode_to_string(enum bond_mode bm) {
3085     static char *bm_slb = "balance-slb";
3086     static char *bm_ab  = "active-backup";
3087     static char *bm_tcp = "balance-tcp";
3088
3089     switch (bm) {
3090     case BM_SLB: return bm_slb;
3091     case BM_AB:  return bm_ab;
3092     case BM_TCP: return bm_tcp;
3093     }
3094
3095     NOT_REACHED();
3096     return NULL;
3097 }
3098
3099 /* Sorts pointers to pointers to bond_entries in ascending order by the
3100  * interface to which they are assigned, and within a single interface in
3101  * ascending order of bytes transmitted. */
3102 static int
3103 compare_bond_entries(const void *a_, const void *b_)
3104 {
3105     const struct bond_entry *const *ap = a_;
3106     const struct bond_entry *const *bp = b_;
3107     const struct bond_entry *a = *ap;
3108     const struct bond_entry *b = *bp;
3109     if (a->iface != b->iface) {
3110         return a->iface > b->iface ? 1 : -1;
3111     } else if (a->tx_bytes != b->tx_bytes) {
3112         return a->tx_bytes > b->tx_bytes ? 1 : -1;
3113     } else {
3114         return 0;
3115     }
3116 }
3117
3118 /* Sorts slave_balances so that enabled ports come first, and otherwise in
3119  * *descending* order by number of bytes transmitted. */
3120 static int
3121 compare_slave_balance(const void *a_, const void *b_)
3122 {
3123     const struct slave_balance *a = a_;
3124     const struct slave_balance *b = b_;
3125     if (a->iface->enabled != b->iface->enabled) {
3126         return a->iface->enabled ? -1 : 1;
3127     } else if (a->tx_bytes != b->tx_bytes) {
3128         return a->tx_bytes > b->tx_bytes ? -1 : 1;
3129     } else {
3130         return 0;
3131     }
3132 }
3133
3134 static void
3135 swap_bals(struct slave_balance *a, struct slave_balance *b)
3136 {
3137     struct slave_balance tmp = *a;
3138     *a = *b;
3139     *b = tmp;
3140 }
3141
3142 /* Restores the 'n_bals' slave_balance structures in 'bals' to sorted order
3143  * given that 'p' (and only 'p') might be in the wrong location.
3144  *
3145  * This function invalidates 'p', since it might now be in a different memory
3146  * location. */
3147 static void
3148 resort_bals(struct slave_balance *p,
3149             struct slave_balance bals[], size_t n_bals)
3150 {
3151     if (n_bals > 1) {
3152         for (; p > bals && p->tx_bytes > p[-1].tx_bytes; p--) {
3153             swap_bals(p, p - 1);
3154         }
3155         for (; p < &bals[n_bals - 1] && p->tx_bytes < p[1].tx_bytes; p++) {
3156             swap_bals(p, p + 1);
3157         }
3158     }
3159 }
3160
3161 static void
3162 log_bals(const struct slave_balance *bals, size_t n_bals, struct port *port)
3163 {
3164     if (VLOG_IS_DBG_ENABLED()) {
3165         struct ds ds = DS_EMPTY_INITIALIZER;
3166         const struct slave_balance *b;
3167
3168         for (b = bals; b < bals + n_bals; b++) {
3169             size_t i;
3170
3171             if (b > bals) {
3172                 ds_put_char(&ds, ',');
3173             }
3174             ds_put_format(&ds, " %s %"PRIu64"kB",
3175                           b->iface->name, b->tx_bytes / 1024);
3176
3177             if (!b->iface->enabled) {
3178                 ds_put_cstr(&ds, " (disabled)");
3179             }
3180             if (b->n_hashes > 0) {
3181                 ds_put_cstr(&ds, " (");
3182                 for (i = 0; i < b->n_hashes; i++) {
3183                     const struct bond_entry *e = b->hashes[i];
3184                     if (i > 0) {
3185                         ds_put_cstr(&ds, " + ");
3186                     }
3187                     ds_put_format(&ds, "h%td: %"PRIu64"kB",
3188                                   e - port->bond_hash, e->tx_bytes / 1024);
3189                 }
3190                 ds_put_cstr(&ds, ")");
3191             }
3192         }
3193         VLOG_DBG("bond %s:%s", port->name, ds_cstr(&ds));
3194         ds_destroy(&ds);
3195     }
3196 }
3197
3198 /* Shifts 'hash' from 'from' to 'to' within 'port'. */
3199 static void
3200 bond_shift_load(struct slave_balance *from, struct slave_balance *to,
3201                 int hash_idx)
3202 {
3203     struct bond_entry *hash = from->hashes[hash_idx];
3204     struct port *port = from->iface->port;
3205     uint64_t delta = hash->tx_bytes;
3206
3207     assert(port->bond_mode != BM_AB);
3208
3209     VLOG_INFO("bond %s: shift %"PRIu64"kB of load (with hash %td) "
3210               "from %s to %s (now carrying %"PRIu64"kB and "
3211               "%"PRIu64"kB load, respectively)",
3212               port->name, delta / 1024, hash - port->bond_hash,
3213               from->iface->name, to->iface->name,
3214               (from->tx_bytes - delta) / 1024,
3215               (to->tx_bytes + delta) / 1024);
3216
3217     /* Delete element from from->hashes.
3218      *
3219      * We don't bother to add the element to to->hashes because not only would
3220      * it require more work, the only purpose it would be to allow that hash to
3221      * be migrated to another slave in this rebalancing run, and there is no
3222      * point in doing that.  */
3223     if (hash_idx == 0) {
3224         from->hashes++;
3225     } else {
3226         memmove(from->hashes + hash_idx, from->hashes + hash_idx + 1,
3227                 (from->n_hashes - (hash_idx + 1)) * sizeof *from->hashes);
3228     }
3229     from->n_hashes--;
3230
3231     /* Shift load away from 'from' to 'to'. */
3232     from->tx_bytes -= delta;
3233     to->tx_bytes += delta;
3234
3235     /* Arrange for flows to be revalidated. */
3236     ofproto_revalidate(port->bridge->ofproto, hash->tag);
3237     hash->iface = to->iface;
3238     hash->tag = tag_create_random();
3239 }
3240
3241 static void
3242 bond_rebalance_port(struct port *port)
3243 {
3244     struct slave_balance *bals;
3245     size_t n_bals;
3246     struct bond_entry *hashes[BOND_MASK + 1];
3247     struct slave_balance *b, *from, *to;
3248     struct bond_entry *e;
3249     struct iface *iface;
3250     size_t i;
3251
3252     assert(port->bond_mode != BM_AB);
3253
3254     /* Sets up 'bals' to describe each of the port's interfaces, sorted in
3255      * descending order of tx_bytes, so that bals[0] represents the most
3256      * heavily loaded slave and bals[n_bals - 1] represents the least heavily
3257      * loaded slave.
3258      *
3259      * The code is a bit tricky: to avoid dynamically allocating a 'hashes'
3260      * array for each slave_balance structure, we sort our local array of
3261      * hashes in order by slave, so that all of the hashes for a given slave
3262      * become contiguous in memory, and then we point each 'hashes' members of
3263      * a slave_balance structure to the start of a contiguous group. */
3264     n_bals = port->n_ifaces;
3265     b = bals = xmalloc(n_bals * sizeof *bals);
3266     LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
3267         b->iface = iface;
3268         b->tx_bytes = 0;
3269         b->hashes = NULL;
3270         b->n_hashes = 0;
3271         b++;
3272     }
3273     assert(b == &bals[n_bals]);
3274     for (i = 0; i <= BOND_MASK; i++) {
3275         hashes[i] = &port->bond_hash[i];
3276     }
3277     qsort(hashes, BOND_MASK + 1, sizeof *hashes, compare_bond_entries);
3278     for (i = 0; i <= BOND_MASK; i++) {
3279         e = hashes[i];
3280         if (!e->iface) {
3281             continue;
3282         }
3283
3284         for (b = bals; b < &bals[n_bals]; b++) {
3285             if (b->iface == e->iface) {
3286                 b->tx_bytes += e->tx_bytes;
3287                 if (!b->hashes) {
3288                     b->hashes = &hashes[i];
3289                 }
3290                 b->n_hashes++;
3291                 break;
3292             }
3293         }
3294     }
3295     qsort(bals, n_bals, sizeof *bals, compare_slave_balance);
3296     log_bals(bals, n_bals, port);
3297
3298     /* Discard slaves that aren't enabled (which were sorted to the back of the
3299      * array earlier). */
3300     while (!bals[n_bals - 1].iface->enabled) {
3301         n_bals--;
3302         if (!n_bals) {
3303             goto exit;
3304         }
3305     }
3306
3307     /* Shift load from the most-loaded slaves to the least-loaded slaves. */
3308     to = &bals[n_bals - 1];
3309     for (from = bals; from < to; ) {
3310         uint64_t overload = from->tx_bytes - to->tx_bytes;
3311         if (overload < to->tx_bytes >> 5 || overload < 100000) {
3312             /* The extra load on 'from' (and all less-loaded slaves), compared
3313              * to that of 'to' (the least-loaded slave), is less than ~3%, or
3314              * it is less than ~1Mbps.  No point in rebalancing. */
3315             break;
3316         } else if (from->n_hashes == 1) {
3317             /* 'from' only carries a single MAC hash, so we can't shift any
3318              * load away from it, even though we want to. */
3319             from++;
3320         } else {
3321             /* 'from' is carrying significantly more load than 'to', and that
3322              * load is split across at least two different hashes.  Pick a hash
3323              * to migrate to 'to' (the least-loaded slave), given that doing so
3324              * must decrease the ratio of the load on the two slaves by at
3325              * least 0.1.
3326              *
3327              * The sort order we use means that we prefer to shift away the
3328              * smallest hashes instead of the biggest ones.  There is little
3329              * reason behind this decision; we could use the opposite sort
3330              * order to shift away big hashes ahead of small ones. */
3331             bool order_swapped;
3332
3333             for (i = 0; i < from->n_hashes; i++) {
3334                 double old_ratio, new_ratio;
3335                 uint64_t delta = from->hashes[i]->tx_bytes;
3336
3337                 if (delta == 0 || from->tx_bytes - delta == 0) {
3338                     /* Pointless move. */
3339                     continue;
3340                 }
3341
3342                 order_swapped = from->tx_bytes - delta < to->tx_bytes + delta;
3343
3344                 if (to->tx_bytes == 0) {
3345                     /* Nothing on the new slave, move it. */
3346                     break;
3347                 }
3348
3349                 old_ratio = (double)from->tx_bytes / to->tx_bytes;
3350                 new_ratio = (double)(from->tx_bytes - delta) /
3351                             (to->tx_bytes + delta);
3352
3353                 if (new_ratio == 0) {
3354                     /* Should already be covered but check to prevent division
3355                      * by zero. */
3356                     continue;
3357                 }
3358
3359                 if (new_ratio < 1) {
3360                     new_ratio = 1 / new_ratio;
3361                 }
3362
3363                 if (old_ratio - new_ratio > 0.1) {
3364                     /* Would decrease the ratio, move it. */
3365                     break;
3366                 }
3367             }
3368             if (i < from->n_hashes) {
3369                 bond_shift_load(from, to, i);
3370
3371                 /* If the result of the migration changed the relative order of
3372                  * 'from' and 'to' swap them back to maintain invariants. */
3373                 if (order_swapped) {
3374                     swap_bals(from, to);
3375                 }
3376
3377                 /* Re-sort 'bals'.  Note that this may make 'from' and 'to'
3378                  * point to different slave_balance structures.  It is only
3379                  * valid to do these two operations in a row at all because we
3380                  * know that 'from' will not move past 'to' and vice versa. */
3381                 resort_bals(from, bals, n_bals);
3382                 resort_bals(to, bals, n_bals);
3383             } else {
3384                 from++;
3385             }
3386         }
3387     }
3388
3389     /* Implement exponentially weighted moving average.  A weight of 1/2 causes
3390      * historical data to decay to <1% in 7 rebalancing runs.  */
3391     for (e = &port->bond_hash[0]; e <= &port->bond_hash[BOND_MASK]; e++) {
3392         e->tx_bytes /= 2;
3393         if (!e->tx_bytes) {
3394             e->iface = NULL;
3395         }
3396     }
3397
3398 exit:
3399     free(bals);
3400 }
3401
3402 static void
3403 bond_send_learning_packets(struct port *port)
3404 {
3405     struct bridge *br = port->bridge;
3406     struct mac_entry *e;
3407     struct ofpbuf packet;
3408     int error, n_packets, n_errors;
3409
3410     if (!port->n_ifaces || !port->active_iface || bond_is_tcp_hash(port)) {
3411         return;
3412     }
3413
3414     ofpbuf_init(&packet, 128);
3415     error = n_packets = n_errors = 0;
3416     LIST_FOR_EACH (e, lru_node, &br->ml->lrus) {
3417         tag_type tags = 0;
3418         uint16_t dp_ifidx;
3419         struct flow flow;
3420         int retval;
3421
3422         if (e->port.p == port) {
3423             continue;
3424         }
3425
3426         compose_benign_packet(&packet, "Open vSwitch Bond Failover", 0xf177,
3427                               e->mac);
3428         flow_extract(&packet, 0, ODPP_NONE, &flow);
3429
3430         if (!choose_output_iface(port, &flow, e->vlan, &dp_ifidx, &tags)) {
3431             continue;
3432         }
3433
3434         /* Send packet. */
3435         n_packets++;
3436         retval = ofproto_send_packet(br->ofproto, dp_ifidx, e->vlan, &packet);
3437         if (retval) {
3438             error = retval;
3439             n_errors++;
3440         }
3441     }
3442     ofpbuf_uninit(&packet);
3443
3444     if (n_errors) {
3445         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3446         VLOG_WARN_RL(&rl, "bond %s: %d errors sending %d gratuitous learning "
3447                      "packets, last error was: %s",
3448                      port->name, n_errors, n_packets, strerror(error));
3449     } else {
3450         VLOG_DBG("bond %s: sent %d gratuitous learning packets",
3451                  port->name, n_packets);
3452     }
3453 }
3454 \f
3455 /* Bonding unixctl user interface functions. */
3456
3457 static void
3458 bond_unixctl_list(struct unixctl_conn *conn,
3459                   const char *args OVS_UNUSED, void *aux OVS_UNUSED)
3460 {
3461     struct ds ds = DS_EMPTY_INITIALIZER;
3462     const struct bridge *br;
3463
3464     ds_put_cstr(&ds, "bridge\tbond\ttype\tslaves\n");
3465
3466     LIST_FOR_EACH (br, node, &all_bridges) {
3467         struct port *port;
3468
3469         HMAP_FOR_EACH (port, hmap_node, &br->ports) {
3470             if (port->n_ifaces > 1) {
3471                 struct iface *iface;
3472
3473                 ds_put_format(&ds, "%s\t%s\t%s\t", br->name, port->name,
3474                               bond_mode_to_string(port->bond_mode));
3475                 LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
3476                     if (&iface->port_elem != list_front(&port->ifaces)) {
3477                         ds_put_cstr(&ds, ", ");
3478                     }
3479                     ds_put_cstr(&ds, iface->name);
3480                 }
3481                 ds_put_char(&ds, '\n');
3482             }
3483         }
3484     }
3485     unixctl_command_reply(conn, 200, ds_cstr(&ds));
3486     ds_destroy(&ds);
3487 }
3488
3489 static struct port *
3490 bond_find(const char *name)
3491 {
3492     const struct bridge *br;
3493
3494     LIST_FOR_EACH (br, node, &all_bridges) {
3495         struct port *port;
3496
3497         HMAP_FOR_EACH (port, hmap_node, &br->ports) {
3498             if (!strcmp(port->name, name) && port->n_ifaces > 1) {
3499                 return port;
3500             }
3501         }
3502     }
3503     return NULL;
3504 }
3505
3506 static void
3507 bond_unixctl_show(struct unixctl_conn *conn,
3508                   const char *args, void *aux OVS_UNUSED)
3509 {
3510     struct ds ds = DS_EMPTY_INITIALIZER;
3511     const struct port *port;
3512     struct iface *iface;
3513
3514     port = bond_find(args);
3515     if (!port) {
3516         unixctl_command_reply(conn, 501, "no such bond");
3517         return;
3518     }
3519
3520     ds_put_format(&ds, "bond_mode: %s\n",
3521                   bond_mode_to_string(port->bond_mode));
3522
3523     if (port->lacp) {
3524         ds_put_format(&ds, "lacp: %s\n",
3525                       lacp_is_active(port->lacp) ? "active" : "passive");
3526     } else {
3527         ds_put_cstr(&ds, "lacp: off\n");
3528     }
3529
3530     if (port->bond_mode != BM_AB) {
3531         ds_put_format(&ds, "bond-hash-algorithm: %s\n",
3532                       bond_is_tcp_hash(port) ? "balance-tcp" : "balance-slb");
3533     }
3534
3535
3536     ds_put_format(&ds, "bond-detect-mode: %s\n",
3537                   port->monitor ? "carrier" : "miimon");
3538
3539     if (!port->monitor) {
3540         ds_put_format(&ds, "bond-miimon-interval: %lld\n",
3541                       port->miimon_interval);
3542     }
3543
3544     ds_put_format(&ds, "updelay: %d ms\n", port->updelay);
3545     ds_put_format(&ds, "downdelay: %d ms\n", port->downdelay);
3546
3547     if (port->bond_mode != BM_AB) {
3548         ds_put_format(&ds, "next rebalance: %lld ms\n",
3549                       port->bond_next_rebalance - time_msec());
3550     }
3551
3552     LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
3553         struct bond_entry *be;
3554         struct flow flow;
3555
3556         /* Basic info. */
3557         ds_put_format(&ds, "\nslave %s: %s\n",
3558                       iface->name, iface->enabled ? "enabled" : "disabled");
3559         if (iface == port->active_iface) {
3560             ds_put_cstr(&ds, "\tactive slave\n");
3561         }
3562         if (iface->delay_expires != LLONG_MAX) {
3563             ds_put_format(&ds, "\t%s expires in %lld ms\n",
3564                           iface->enabled ? "downdelay" : "updelay",
3565                           iface->delay_expires - time_msec());
3566         }
3567
3568         if (port->bond_mode == BM_AB) {
3569             continue;
3570         }
3571
3572         /* Hashes. */
3573         memset(&flow, 0, sizeof flow);
3574         for (be = port->bond_hash; be <= &port->bond_hash[BOND_MASK]; be++) {
3575             int hash = be - port->bond_hash;
3576             struct mac_entry *me;
3577
3578             if (be->iface != iface) {
3579                 continue;
3580             }
3581
3582             ds_put_format(&ds, "\thash %d: %"PRIu64" kB load\n",
3583                           hash, be->tx_bytes / 1024);
3584
3585             if (port->bond_mode != BM_SLB) {
3586                 continue;
3587             }
3588
3589             /* MACs. */
3590             LIST_FOR_EACH (me, lru_node, &port->bridge->ml->lrus) {
3591                 uint16_t dp_ifidx;
3592                 tag_type tags = 0;
3593
3594                 memcpy(flow.dl_src, me->mac, ETH_ADDR_LEN);
3595                 if (bond_hash_src(me->mac, me->vlan) == hash
3596                     && me->port.p != port
3597                     && choose_output_iface(port, &flow, me->vlan,
3598                                            &dp_ifidx, &tags)
3599                     && dp_ifidx == iface->dp_ifidx)
3600                 {
3601                     ds_put_format(&ds, "\t\t"ETH_ADDR_FMT"\n",
3602                                   ETH_ADDR_ARGS(me->mac));
3603                 }
3604             }
3605         }
3606     }
3607     unixctl_command_reply(conn, 200, ds_cstr(&ds));
3608     ds_destroy(&ds);
3609 }
3610
3611 static void
3612 bond_unixctl_migrate(struct unixctl_conn *conn, const char *args_,
3613                      void *aux OVS_UNUSED)
3614 {
3615     char *args = (char *) args_;
3616     char *save_ptr = NULL;
3617     char *bond_s, *hash_s, *slave_s;
3618     struct port *port;
3619     struct iface *iface;
3620     struct bond_entry *entry;
3621     int hash;
3622
3623     bond_s = strtok_r(args, " ", &save_ptr);
3624     hash_s = strtok_r(NULL, " ", &save_ptr);
3625     slave_s = strtok_r(NULL, " ", &save_ptr);
3626     if (!slave_s) {
3627         unixctl_command_reply(conn, 501,
3628                               "usage: bond/migrate BOND HASH SLAVE");
3629         return;
3630     }
3631
3632     port = bond_find(bond_s);
3633     if (!port) {
3634         unixctl_command_reply(conn, 501, "no such bond");
3635         return;
3636     }
3637
3638     if (port->bond_mode != BM_SLB) {
3639         unixctl_command_reply(conn, 501, "not an SLB bond");
3640         return;
3641     }
3642
3643     if (strspn(hash_s, "0123456789") == strlen(hash_s)) {
3644         hash = atoi(hash_s) & BOND_MASK;
3645     } else {
3646         unixctl_command_reply(conn, 501, "bad hash");
3647         return;
3648     }
3649
3650     iface = port_lookup_iface(port, slave_s);
3651     if (!iface) {
3652         unixctl_command_reply(conn, 501, "no such slave");
3653         return;
3654     }
3655
3656     if (!iface->enabled) {
3657         unixctl_command_reply(conn, 501, "cannot migrate to disabled slave");
3658         return;
3659     }
3660
3661     entry = &port->bond_hash[hash];
3662     ofproto_revalidate(port->bridge->ofproto, entry->tag);
3663     entry->iface = iface;
3664     entry->tag = tag_create_random();
3665     unixctl_command_reply(conn, 200, "migrated");
3666 }
3667
3668 static void
3669 bond_unixctl_set_active_slave(struct unixctl_conn *conn, const char *args_,
3670                               void *aux OVS_UNUSED)
3671 {
3672     char *args = (char *) args_;
3673     char *save_ptr = NULL;
3674     char *bond_s, *slave_s;
3675     struct port *port;
3676     struct iface *iface;
3677
3678     bond_s = strtok_r(args, " ", &save_ptr);
3679     slave_s = strtok_r(NULL, " ", &save_ptr);
3680     if (!slave_s) {
3681         unixctl_command_reply(conn, 501,
3682                               "usage: bond/set-active-slave BOND SLAVE");
3683         return;
3684     }
3685
3686     port = bond_find(bond_s);
3687     if (!port) {
3688         unixctl_command_reply(conn, 501, "no such bond");
3689         return;
3690     }
3691
3692     iface = port_lookup_iface(port, slave_s);
3693     if (!iface) {
3694         unixctl_command_reply(conn, 501, "no such slave");
3695         return;
3696     }
3697
3698     if (!iface->enabled) {
3699         unixctl_command_reply(conn, 501, "cannot make disabled slave active");
3700         return;
3701     }
3702
3703     if (port->active_iface != iface) {
3704         ofproto_revalidate(port->bridge->ofproto,
3705                            port_get_active_iface_tag(port));
3706         port->active_iface = iface;
3707         VLOG_INFO("port %s: active interface is now %s",
3708                   port->name, iface->name);
3709         bond_send_learning_packets(port);
3710         unixctl_command_reply(conn, 200, "done");
3711     } else {
3712         unixctl_command_reply(conn, 200, "no change");
3713     }
3714 }
3715
3716 static void
3717 enable_slave(struct unixctl_conn *conn, const char *args_, bool enable)
3718 {
3719     char *args = (char *) args_;
3720     char *save_ptr = NULL;
3721     char *bond_s, *slave_s;
3722     struct port *port;
3723     struct iface *iface;
3724
3725     bond_s = strtok_r(args, " ", &save_ptr);
3726     slave_s = strtok_r(NULL, " ", &save_ptr);
3727     if (!slave_s) {
3728         unixctl_command_reply(conn, 501,
3729                               "usage: bond/enable/disable-slave BOND SLAVE");
3730         return;
3731     }
3732
3733     port = bond_find(bond_s);
3734     if (!port) {
3735         unixctl_command_reply(conn, 501, "no such bond");
3736         return;
3737     }
3738
3739     iface = port_lookup_iface(port, slave_s);
3740     if (!iface) {
3741         unixctl_command_reply(conn, 501, "no such slave");
3742         return;
3743     }
3744
3745     bond_enable_slave(iface, enable);
3746     unixctl_command_reply(conn, 501, enable ? "enabled" : "disabled");
3747 }
3748
3749 static void
3750 bond_unixctl_enable_slave(struct unixctl_conn *conn, const char *args,
3751                           void *aux OVS_UNUSED)
3752 {
3753     enable_slave(conn, args, true);
3754 }
3755
3756 static void
3757 bond_unixctl_disable_slave(struct unixctl_conn *conn, const char *args,
3758                            void *aux OVS_UNUSED)
3759 {
3760     enable_slave(conn, args, false);
3761 }
3762
3763 static void
3764 bond_unixctl_hash(struct unixctl_conn *conn, const char *args_,
3765                   void *aux OVS_UNUSED)
3766 {
3767     char *args = (char *) args_;
3768     uint8_t mac[ETH_ADDR_LEN];
3769     uint8_t hash;
3770     char *hash_cstr;
3771     unsigned int vlan;
3772     char *mac_s, *vlan_s;
3773     char *save_ptr = NULL;
3774
3775     mac_s  = strtok_r(args, " ", &save_ptr);
3776     vlan_s = strtok_r(NULL, " ", &save_ptr);
3777
3778     if (vlan_s) {
3779         if (sscanf(vlan_s, "%u", &vlan) != 1) {
3780             unixctl_command_reply(conn, 501, "invalid vlan");
3781             return;
3782         }
3783     } else {
3784         vlan = OFP_VLAN_NONE;
3785     }
3786
3787     if (sscanf(mac_s, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
3788         == ETH_ADDR_SCAN_COUNT) {
3789         hash = bond_hash_src(mac, vlan);
3790
3791         hash_cstr = xasprintf("%u", hash);
3792         unixctl_command_reply(conn, 200, hash_cstr);
3793         free(hash_cstr);
3794     } else {
3795         unixctl_command_reply(conn, 501, "invalid mac");
3796     }
3797 }
3798
3799 static void
3800 bond_init(void)
3801 {
3802     unixctl_command_register("bond/list", bond_unixctl_list, NULL);
3803     unixctl_command_register("bond/show", bond_unixctl_show, NULL);
3804     unixctl_command_register("bond/migrate", bond_unixctl_migrate, NULL);
3805     unixctl_command_register("bond/set-active-slave",
3806                              bond_unixctl_set_active_slave, NULL);
3807     unixctl_command_register("bond/enable-slave", bond_unixctl_enable_slave,
3808                              NULL);
3809     unixctl_command_register("bond/disable-slave", bond_unixctl_disable_slave,
3810                              NULL);
3811     unixctl_command_register("bond/hash", bond_unixctl_hash, NULL);
3812 }
3813 \f
3814 /* Port functions. */
3815
3816 static void
3817 lacp_send_pdu_cb(void *aux, const struct lacp_pdu *pdu)
3818 {
3819     struct iface *iface = aux;
3820     uint8_t ea[ETH_ADDR_LEN];
3821     int error;
3822
3823     error = netdev_get_etheraddr(iface->netdev, ea);
3824     if (!error) {
3825         struct ofpbuf packet;
3826         struct lacp_pdu *packet_pdu;
3827
3828         ofpbuf_init(&packet, 0);
3829         packet_pdu = eth_compose(&packet, eth_addr_lacp, ea, ETH_TYPE_LACP,
3830                                  sizeof *packet_pdu);
3831         memcpy(packet_pdu, pdu, sizeof *packet_pdu);
3832         ofproto_send_packet(iface->port->bridge->ofproto,
3833                             iface->dp_ifidx, 0, &packet);
3834         ofpbuf_uninit(&packet);
3835     } else {
3836         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 10);
3837         VLOG_ERR_RL(&rl, "iface %s: failed to obtain Ethernet address "
3838                     "(%s)", iface->name, strerror(error));
3839     }
3840 }
3841
3842 static void
3843 port_run(struct port *port)
3844 {
3845     if (port->monitor) {
3846         char *devname;
3847
3848         /* Track carrier going up and down on interfaces. */
3849         while (!netdev_monitor_poll(port->monitor, &devname)) {
3850             struct iface *iface;
3851
3852             iface = port_lookup_iface(port, devname);
3853             if (iface) {
3854                 iface_update_carrier(iface);
3855             }
3856             free(devname);
3857         }
3858     } else if (time_msec() >= port->miimon_next_update) {
3859         struct iface *iface;
3860
3861         LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
3862             iface_update_carrier(iface);
3863         }
3864         port->miimon_next_update = time_msec() + port->miimon_interval;
3865     }
3866
3867     if (port->lacp) {
3868         struct iface *iface;
3869
3870         LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
3871             lacp_slave_enable(port->lacp, iface, iface->enabled);
3872         }
3873
3874         lacp_run(port->lacp, lacp_send_pdu_cb);
3875     }
3876
3877     bond_run(port);
3878 }
3879
3880 static void
3881 port_wait(struct port *port)
3882 {
3883     if (port->monitor) {
3884         netdev_monitor_poll_wait(port->monitor);
3885     } else {
3886         poll_timer_wait_until(port->miimon_next_update);
3887     }
3888
3889     if (port->lacp) {
3890         lacp_wait(port->lacp);
3891     }
3892
3893     bond_wait(port);
3894 }
3895
3896 static struct port *
3897 port_create(struct bridge *br, const char *name)
3898 {
3899     struct port *port;
3900
3901     port = xzalloc(sizeof *port);
3902     port->bridge = br;
3903     port->vlan = -1;
3904     port->trunks = NULL;
3905     port->name = xstrdup(name);
3906     port->active_iface = NULL;
3907     list_init(&port->ifaces);
3908
3909     hmap_insert(&br->ports, &port->hmap_node, hash_string(port->name, 0));
3910
3911     VLOG_INFO("created port %s on bridge %s", port->name, br->name);
3912     bridge_flush(br);
3913
3914     return port;
3915 }
3916
3917 static const char *
3918 get_port_other_config(const struct ovsrec_port *port, const char *key,
3919                       const char *default_value)
3920 {
3921     const char *value;
3922
3923     value = get_ovsrec_key_value(&port->header_, &ovsrec_port_col_other_config,
3924                                  key);
3925     return value ? value : default_value;
3926 }
3927
3928 static const char *
3929 get_interface_other_config(const struct ovsrec_interface *iface,
3930                            const char *key, const char *default_value)
3931 {
3932     const char *value;
3933
3934     value = get_ovsrec_key_value(&iface->header_,
3935                                  &ovsrec_interface_col_other_config, key);
3936     return value ? value : default_value;
3937 }
3938
3939 static void
3940 port_del_ifaces(struct port *port, const struct ovsrec_port *cfg)
3941 {
3942     struct iface *iface, *next;
3943     struct sset new_ifaces;
3944     size_t i;
3945
3946     /* Collect list of new interfaces. */
3947     sset_init(&new_ifaces);
3948     for (i = 0; i < cfg->n_interfaces; i++) {
3949         const char *name = cfg->interfaces[i]->name;
3950         sset_add(&new_ifaces, name);
3951     }
3952
3953     /* Get rid of deleted interfaces. */
3954     LIST_FOR_EACH_SAFE (iface, next, port_elem, &port->ifaces) {
3955         if (!sset_contains(&new_ifaces, iface->name)) {
3956             iface_destroy(iface);
3957         }
3958     }
3959
3960     sset_destroy(&new_ifaces);
3961 }
3962
3963 /* Expires all MAC learning entries associated with 'port' and forces ofproto
3964  * to revalidate every flow. */
3965 static void
3966 port_flush_macs(struct port *port)
3967 {
3968     struct bridge *br = port->bridge;
3969     struct mac_learning *ml = br->ml;
3970     struct mac_entry *mac, *next_mac;
3971
3972     bridge_flush(br);
3973     LIST_FOR_EACH_SAFE (mac, next_mac, lru_node, &ml->lrus) {
3974         if (mac->port.p == port) {
3975             mac_learning_expire(ml, mac);
3976         }
3977     }
3978 }
3979
3980 static void
3981 port_reconfigure(struct port *port, const struct ovsrec_port *cfg)
3982 {
3983     const char *detect_mode;
3984     struct sset new_ifaces;
3985     long long int next_rebalance, miimon_next_update;
3986     bool need_flush = false;
3987     unsigned long *trunks;
3988     int vlan;
3989     size_t i;
3990
3991     port->cfg = cfg;
3992
3993     /* Update settings. */
3994     port->updelay = cfg->bond_updelay;
3995     if (port->updelay < 0) {
3996         port->updelay = 0;
3997     }
3998     port->downdelay = cfg->bond_downdelay;
3999     if (port->downdelay < 0) {
4000         port->downdelay = 0;
4001     }
4002     port->bond_rebalance_interval = atoi(
4003         get_port_other_config(cfg, "bond-rebalance-interval", "10000"));
4004     if (port->bond_rebalance_interval < 1000) {
4005         port->bond_rebalance_interval = 1000;
4006     }
4007     next_rebalance = time_msec() + port->bond_rebalance_interval;
4008     if (port->bond_next_rebalance > next_rebalance) {
4009         port->bond_next_rebalance = next_rebalance;
4010     }
4011
4012     detect_mode = get_port_other_config(cfg, "bond-detect-mode",
4013                                         "carrier");
4014
4015     netdev_monitor_destroy(port->monitor);
4016     port->monitor = NULL;
4017
4018     if (strcmp(detect_mode, "miimon")) {
4019         port->monitor = netdev_monitor_create();
4020
4021         if (strcmp(detect_mode, "carrier")) {
4022             VLOG_WARN("port %s: unsupported bond-detect-mode %s, "
4023                       "defaulting to carrier", port->name, detect_mode);
4024         }
4025     }
4026
4027     port->miimon_interval = atoi(
4028         get_port_other_config(cfg, "bond-miimon-interval", "200"));
4029     if (port->miimon_interval < 100) {
4030         port->miimon_interval = 100;
4031     }
4032     miimon_next_update = time_msec() + port->miimon_interval;
4033     if (port->miimon_next_update > miimon_next_update) {
4034         port->miimon_next_update = miimon_next_update;
4035     }
4036
4037     if (!port->cfg->bond_mode ||
4038         !strcmp(port->cfg->bond_mode, bond_mode_to_string(BM_SLB))) {
4039         port->bond_mode = BM_SLB;
4040     } else if (!strcmp(port->cfg->bond_mode, bond_mode_to_string(BM_AB))) {
4041         port->bond_mode = BM_AB;
4042     } else if (!strcmp(port->cfg->bond_mode, bond_mode_to_string(BM_TCP))) {
4043         port->bond_mode = BM_TCP;
4044     } else {
4045         port->bond_mode = BM_SLB;
4046         VLOG_WARN("port %s: unknown bond_mode %s, defaulting to %s",
4047                   port->name, port->cfg->bond_mode,
4048                   bond_mode_to_string(port->bond_mode));
4049     }
4050
4051     /* Add new interfaces and update 'cfg' member of existing ones. */
4052     sset_init(&new_ifaces);
4053     for (i = 0; i < cfg->n_interfaces; i++) {
4054         const struct ovsrec_interface *if_cfg = cfg->interfaces[i];
4055         struct iface *iface;
4056
4057         if (!sset_add(&new_ifaces, if_cfg->name)) {
4058             VLOG_WARN("port %s: %s specified twice as port interface",
4059                       port->name, if_cfg->name);
4060             iface_set_ofport(if_cfg, -1);
4061             continue;
4062         }
4063
4064         iface = iface_lookup(port->bridge, if_cfg->name);
4065         if (iface) {
4066             if (iface->port != port) {
4067                 VLOG_ERR("bridge %s: %s interface is on multiple ports, "
4068                          "removing from %s",
4069                          port->bridge->name, if_cfg->name, iface->port->name);
4070                 continue;
4071             }
4072             iface->cfg = if_cfg;
4073         } else {
4074             iface = iface_create(port, if_cfg);
4075         }
4076
4077         /* Determine interface type.  The local port always has type
4078          * "internal".  Other ports take their type from the database and
4079          * default to "system" if none is specified. */
4080         iface->type = (!strcmp(if_cfg->name, port->bridge->name) ? "internal"
4081                        : if_cfg->type[0] ? if_cfg->type
4082                        : "system");
4083     }
4084     sset_destroy(&new_ifaces);
4085
4086     /* Get VLAN tag. */
4087     vlan = -1;
4088     if (cfg->tag) {
4089         if (port->n_ifaces < 2) {
4090             vlan = *cfg->tag;
4091             if (vlan >= 0 && vlan <= 4095) {
4092                 VLOG_DBG("port %s: assigning VLAN tag %d", port->name, vlan);
4093             } else {
4094                 vlan = -1;
4095             }
4096         } else {
4097             /* It's possible that bonded, VLAN-tagged ports make sense.  Maybe
4098              * they even work as-is.  But they have not been tested. */
4099             VLOG_WARN("port %s: VLAN tags not supported on bonded ports",
4100                       port->name);
4101         }
4102     }
4103     if (port->vlan != vlan) {
4104         port->vlan = vlan;
4105         need_flush = true;
4106     }
4107
4108     /* Get trunked VLANs. */
4109     trunks = NULL;
4110     if (vlan < 0 && cfg->n_trunks) {
4111         size_t n_errors;
4112
4113         trunks = bitmap_allocate(4096);
4114         n_errors = 0;
4115         for (i = 0; i < cfg->n_trunks; i++) {
4116             int trunk = cfg->trunks[i];
4117             if (trunk >= 0) {
4118                 bitmap_set1(trunks, trunk);
4119             } else {
4120                 n_errors++;
4121             }
4122         }
4123         if (n_errors) {
4124             VLOG_ERR("port %s: invalid values for %zu trunk VLANs",
4125                      port->name, cfg->n_trunks);
4126         }
4127         if (n_errors == cfg->n_trunks) {
4128             VLOG_ERR("port %s: no valid trunks, trunking all VLANs",
4129                      port->name);
4130             bitmap_free(trunks);
4131             trunks = NULL;
4132         }
4133     } else if (vlan >= 0 && cfg->n_trunks) {
4134         VLOG_ERR("port %s: ignoring trunks in favor of implicit vlan",
4135                  port->name);
4136     }
4137     if (trunks == NULL
4138         ? port->trunks != NULL
4139         : port->trunks == NULL || !bitmap_equal(trunks, port->trunks, 4096)) {
4140         need_flush = true;
4141     }
4142     bitmap_free(port->trunks);
4143     port->trunks = trunks;
4144
4145     if (need_flush) {
4146         port_flush_macs(port);
4147     }
4148 }
4149
4150 static void
4151 port_destroy(struct port *port)
4152 {
4153     if (port) {
4154         struct bridge *br = port->bridge;
4155         struct iface *iface, *next;
4156         int i;
4157
4158         for (i = 0; i < MAX_MIRRORS; i++) {
4159             struct mirror *m = br->mirrors[i];
4160             if (m && m->out_port == port) {
4161                 mirror_destroy(m);
4162             }
4163         }
4164
4165         LIST_FOR_EACH_SAFE (iface, next, port_elem, &port->ifaces) {
4166             iface_destroy(iface);
4167         }
4168
4169         hmap_remove(&br->ports, &port->hmap_node);
4170
4171         VLOG_INFO("destroyed port %s on bridge %s", port->name, br->name);
4172
4173         port_flush_macs(port);
4174
4175         lacp_destroy(port->lacp);
4176         netdev_monitor_destroy(port->monitor);
4177         bitmap_free(port->trunks);
4178         free(port->bond_hash);
4179         free(port->name);
4180         free(port);
4181     }
4182 }
4183
4184 static struct port *
4185 port_from_dp_ifidx(const struct bridge *br, uint16_t dp_ifidx)
4186 {
4187     struct iface *iface = iface_from_dp_ifidx(br, dp_ifidx);
4188     return iface ? iface->port : NULL;
4189 }
4190
4191 static struct port *
4192 port_lookup(const struct bridge *br, const char *name)
4193 {
4194     struct port *port;
4195
4196     HMAP_FOR_EACH_WITH_HASH (port, hmap_node, hash_string(name, 0),
4197                              &br->ports) {
4198         if (!strcmp(port->name, name)) {
4199             return port;
4200         }
4201     }
4202     return NULL;
4203 }
4204
4205 static struct iface *
4206 port_lookup_iface(const struct port *port, const char *name)
4207 {
4208     struct iface *iface = iface_lookup(port->bridge, name);
4209     return iface && iface->port == port ? iface : NULL;
4210 }
4211
4212 static bool
4213 enable_lacp(struct port *port, bool *activep)
4214 {
4215     if (!port->cfg->lacp) {
4216         /* XXX when LACP implementation has been sufficiently tested, enable by
4217          * default and make active on bonded ports. */
4218         return false;
4219     } else if (!strcmp(port->cfg->lacp, "off")) {
4220         return false;
4221     } else if (!strcmp(port->cfg->lacp, "active")) {
4222         *activep = true;
4223         return true;
4224     } else if (!strcmp(port->cfg->lacp, "passive")) {
4225         *activep = false;
4226         return true;
4227     } else {
4228         VLOG_WARN("port %s: unknown LACP mode %s",
4229                   port->name, port->cfg->lacp);
4230         return false;
4231     }
4232 }
4233
4234 static void
4235 iface_update_lacp(struct iface *iface)
4236 {
4237     struct lacp_slave_settings s;
4238     int priority;
4239
4240     s.name = iface->name;
4241     s.id = iface->dp_ifidx;
4242     priority = atoi(get_interface_other_config(
4243                         iface->cfg, "lacp-port-priority", "0"));
4244     s.priority = (priority >= 0 && priority <= UINT16_MAX ? priority
4245                   : UINT16_MAX);
4246
4247     lacp_slave_register(iface->port->lacp, iface, &s);
4248 }
4249
4250 static void
4251 port_update_lacp(struct port *port)
4252 {
4253     struct lacp_settings s;
4254     struct iface *iface;
4255
4256     if (!enable_lacp(port, &s.active)) {
4257         lacp_destroy(port->lacp);
4258         port->lacp = NULL;
4259         return;
4260     }
4261
4262     if (!port->lacp) {
4263         port->lacp = lacp_create();
4264     }
4265
4266     s.name = port->name;
4267     memcpy(s.id, port->bridge->ea, ETH_ADDR_LEN);
4268     s.priority = atoi(get_port_other_config(port->cfg, "lacp-system-priority",
4269                                           "0"));
4270     s.fast = !strcmp(get_port_other_config(port->cfg, "lacp-time", "slow"),
4271                      "fast");
4272
4273     if (s.priority <= 0 || s.priority > UINT16_MAX) {
4274         /* Prefer bondable links if unspecified. */
4275         s.priority = UINT16_MAX - (port->n_ifaces > 1);
4276     }
4277
4278     lacp_configure(port->lacp, &s);
4279     LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
4280         iface_update_lacp(iface);
4281     }
4282 }
4283
4284 static void
4285 port_update_bonding(struct port *port)
4286 {
4287     if (port->n_ifaces < 2) {
4288         /* Not a bonded port. */
4289         free(port->bond_hash);
4290         port->bond_hash = NULL;
4291         port->bond_fake_iface = false;
4292         port->active_iface = NULL;
4293         port->no_ifaces_tag = 0;
4294     } else {
4295         size_t i;
4296
4297         if (port->bond_mode != BM_AB && !port->bond_hash) {
4298             port->bond_hash = xcalloc(BOND_MASK + 1, sizeof *port->bond_hash);
4299             for (i = 0; i <= BOND_MASK; i++) {
4300                 struct bond_entry *e = &port->bond_hash[i];
4301                 e->iface = NULL;
4302                 e->tx_bytes = 0;
4303             }
4304             port->bond_next_rebalance
4305                 = time_msec() + port->bond_rebalance_interval;
4306         } else if (port->bond_mode == BM_AB) {
4307             free(port->bond_hash);
4308             port->bond_hash = NULL;
4309         }
4310
4311         if (!port->no_ifaces_tag) {
4312             port->no_ifaces_tag = tag_create_random();
4313         }
4314
4315         if (!port->active_iface) {
4316             bond_choose_active_iface(port);
4317         }
4318
4319         port->bond_fake_iface = port->cfg->bond_fake_iface;
4320         if (port->bond_fake_iface) {
4321             port->bond_next_fake_iface_update = time_msec();
4322         }
4323
4324     }
4325 }
4326 \f
4327 /* Interface functions. */
4328
4329 static struct iface *
4330 iface_create(struct port *port, const struct ovsrec_interface *if_cfg)
4331 {
4332     struct bridge *br = port->bridge;
4333     struct iface *iface;
4334     char *name = if_cfg->name;
4335
4336     iface = xzalloc(sizeof *iface);
4337     iface->port = port;
4338     iface->name = xstrdup(name);
4339     iface->dp_ifidx = -1;
4340     iface->tag = tag_create_random();
4341     iface->delay_expires = LLONG_MAX;
4342     iface->netdev = NULL;
4343     iface->cfg = if_cfg;
4344
4345     shash_add_assert(&br->iface_by_name, iface->name, iface);
4346
4347     list_push_back(&port->ifaces, &iface->port_elem);
4348     port->n_ifaces++;
4349
4350     if (port->n_ifaces > 1) {
4351         br->has_bonded_ports = true;
4352     }
4353
4354     VLOG_DBG("attached network device %s to port %s", iface->name, port->name);
4355
4356     bridge_flush(br);
4357
4358     return iface;
4359 }
4360
4361 static void
4362 iface_destroy(struct iface *iface)
4363 {
4364     if (iface) {
4365         struct port *port = iface->port;
4366         struct bridge *br = port->bridge;
4367         bool del_active = port->active_iface == iface;
4368
4369         if (port->bond_hash) {
4370             struct bond_entry *e;
4371             for (e = port->bond_hash; e <= &port->bond_hash[BOND_MASK]; e++) {
4372                 if (e->iface == iface) {
4373                     e->iface = NULL;
4374                 }
4375             }
4376         }
4377
4378         if (iface->port->lacp) {
4379             lacp_slave_unregister(iface->port->lacp, iface);
4380         }
4381
4382         if (port->monitor && iface->netdev) {
4383             netdev_monitor_remove(port->monitor, iface->netdev);
4384         }
4385
4386         shash_find_and_delete_assert(&br->iface_by_name, iface->name);
4387
4388         if (iface->dp_ifidx >= 0) {
4389             hmap_remove(&br->ifaces, &iface->dp_ifidx_node);
4390         }
4391
4392         list_remove(&iface->port_elem);
4393         port->n_ifaces--;
4394
4395         netdev_close(iface->netdev);
4396
4397         if (del_active) {
4398             bond_choose_active_iface(port);
4399             bond_send_learning_packets(port);
4400         }
4401
4402         free(iface->name);
4403         free(iface);
4404
4405         bridge_flush(port->bridge);
4406     }
4407 }
4408
4409 static struct iface *
4410 iface_lookup(const struct bridge *br, const char *name)
4411 {
4412     return shash_find_data(&br->iface_by_name, name);
4413 }
4414
4415 static struct iface *
4416 iface_find(const char *name)
4417 {
4418     const struct bridge *br;
4419
4420     LIST_FOR_EACH (br, node, &all_bridges) {
4421         struct iface *iface = iface_lookup(br, name);
4422
4423         if (iface) {
4424             return iface;
4425         }
4426     }
4427     return NULL;
4428 }
4429
4430 static struct iface *
4431 iface_from_dp_ifidx(const struct bridge *br, uint16_t dp_ifidx)
4432 {
4433     struct iface *iface;
4434
4435     HMAP_FOR_EACH_IN_BUCKET (iface, dp_ifidx_node,
4436                              hash_int(dp_ifidx, 0), &br->ifaces) {
4437         if (iface->dp_ifidx == dp_ifidx) {
4438             return iface;
4439         }
4440     }
4441     return NULL;
4442 }
4443
4444 /* Set Ethernet address of 'iface', if one is specified in the configuration
4445  * file. */
4446 static void
4447 iface_set_mac(struct iface *iface)
4448 {
4449     uint8_t ea[ETH_ADDR_LEN];
4450
4451     if (iface->cfg->mac && eth_addr_from_string(iface->cfg->mac, ea)) {
4452         if (eth_addr_is_multicast(ea)) {
4453             VLOG_ERR("interface %s: cannot set MAC to multicast address",
4454                      iface->name);
4455         } else if (iface->dp_ifidx == ODPP_LOCAL) {
4456             VLOG_ERR("ignoring iface.%s.mac; use bridge.%s.mac instead",
4457                      iface->name, iface->name);
4458         } else {
4459             int error = netdev_set_etheraddr(iface->netdev, ea);
4460             if (error) {
4461                 VLOG_ERR("interface %s: setting MAC failed (%s)",
4462                          iface->name, strerror(error));
4463             }
4464         }
4465     }
4466 }
4467
4468 /* Sets the ofport column of 'if_cfg' to 'ofport'. */
4469 static void
4470 iface_set_ofport(const struct ovsrec_interface *if_cfg, int64_t ofport)
4471 {
4472     if (if_cfg) {
4473         ovsrec_interface_set_ofport(if_cfg, &ofport, 1);
4474     }
4475 }
4476
4477 /* Adds the 'n' key-value pairs in 'keys' in 'values' to 'shash'.
4478  *
4479  * The value strings in '*shash' are taken directly from values[], not copied,
4480  * so the caller should not modify or free them. */
4481 static void
4482 shash_from_ovs_idl_map(char **keys, char **values, size_t n,
4483                        struct shash *shash)
4484 {
4485     size_t i;
4486
4487     shash_init(shash);
4488     for (i = 0; i < n; i++) {
4489         shash_add(shash, keys[i], values[i]);
4490     }
4491 }
4492
4493 /* Creates 'keys' and 'values' arrays from 'shash'.
4494  *
4495  * Sets 'keys' and 'values' to heap allocated arrays representing the key-value
4496  * pairs in 'shash'.  The caller takes ownership of 'keys' and 'values'.  They
4497  * are populated with with strings taken directly from 'shash' and thus have
4498  * the same ownership of the key-value pairs in shash.
4499  */
4500 static void
4501 shash_to_ovs_idl_map(struct shash *shash,
4502                      char ***keys, char ***values, size_t *n)
4503 {
4504     size_t i, count;
4505     char **k, **v;
4506     struct shash_node *sn;
4507
4508     count = shash_count(shash);
4509
4510     k = xmalloc(count * sizeof *k);
4511     v = xmalloc(count * sizeof *v);
4512
4513     i = 0;
4514     SHASH_FOR_EACH(sn, shash) {
4515         k[i] = sn->name;
4516         v[i] = sn->data;
4517         i++;
4518     }
4519
4520     *n      = count;
4521     *keys   = k;
4522     *values = v;
4523 }
4524
4525 struct iface_delete_queues_cbdata {
4526     struct netdev *netdev;
4527     const struct ovsdb_datum *queues;
4528 };
4529
4530 static bool
4531 queue_ids_include(const struct ovsdb_datum *queues, int64_t target)
4532 {
4533     union ovsdb_atom atom;
4534
4535     atom.integer = target;
4536     return ovsdb_datum_find_key(queues, &atom, OVSDB_TYPE_INTEGER) != UINT_MAX;
4537 }
4538
4539 static void
4540 iface_delete_queues(unsigned int queue_id,
4541                     const struct shash *details OVS_UNUSED, void *cbdata_)
4542 {
4543     struct iface_delete_queues_cbdata *cbdata = cbdata_;
4544
4545     if (!queue_ids_include(cbdata->queues, queue_id)) {
4546         netdev_delete_queue(cbdata->netdev, queue_id);
4547     }
4548 }
4549
4550 static void
4551 iface_update_carrier(struct iface *iface)
4552 {
4553     bool carrier = iface_get_carrier(iface);
4554     if (carrier == iface->up) {
4555         return;
4556     }
4557
4558     iface->up = carrier;
4559     if (iface->port->lacp) {
4560         lacp_slave_carrier_changed(iface->port->lacp, iface);
4561     }
4562 }
4563
4564 static void
4565 iface_update_qos(struct iface *iface, const struct ovsrec_qos *qos)
4566 {
4567     if (!qos || qos->type[0] == '\0') {
4568         netdev_set_qos(iface->netdev, NULL, NULL);
4569     } else {
4570         struct iface_delete_queues_cbdata cbdata;
4571         struct shash details;
4572         size_t i;
4573
4574         /* Configure top-level Qos for 'iface'. */
4575         shash_from_ovs_idl_map(qos->key_other_config, qos->value_other_config,
4576                                qos->n_other_config, &details);
4577         netdev_set_qos(iface->netdev, qos->type, &details);
4578         shash_destroy(&details);
4579
4580         /* Deconfigure queues that were deleted. */
4581         cbdata.netdev = iface->netdev;
4582         cbdata.queues = ovsrec_qos_get_queues(qos, OVSDB_TYPE_INTEGER,
4583                                               OVSDB_TYPE_UUID);
4584         netdev_dump_queues(iface->netdev, iface_delete_queues, &cbdata);
4585
4586         /* Configure queues for 'iface'. */
4587         for (i = 0; i < qos->n_queues; i++) {
4588             const struct ovsrec_queue *queue = qos->value_queues[i];
4589             unsigned int queue_id = qos->key_queues[i];
4590
4591             shash_from_ovs_idl_map(queue->key_other_config,
4592                                    queue->value_other_config,
4593                                    queue->n_other_config, &details);
4594             netdev_set_queue(iface->netdev, queue_id, &details);
4595             shash_destroy(&details);
4596         }
4597     }
4598 }
4599
4600 static void
4601 iface_update_cfm(struct iface *iface)
4602 {
4603     size_t i;
4604     struct cfm cfm;
4605     uint16_t *remote_mps;
4606     struct ovsrec_monitor *mon;
4607     uint8_t maid[CCM_MAID_LEN];
4608
4609     mon = iface->cfg->monitor;
4610
4611     if (!mon) {
4612         ofproto_iface_clear_cfm(iface->port->bridge->ofproto, iface->dp_ifidx);
4613         return;
4614     }
4615
4616     if (!cfm_generate_maid(mon->md_name, mon->ma_name, maid)) {
4617         VLOG_WARN("interface %s: Failed to generate MAID.", iface->name);
4618         return;
4619     }
4620
4621     cfm.mpid     = mon->mpid;
4622     cfm.interval = mon->interval ? *mon->interval : 1000;
4623
4624     memcpy(cfm.maid, maid, sizeof cfm.maid);
4625
4626     remote_mps = xzalloc(mon->n_remote_mps * sizeof *remote_mps);
4627     for(i = 0; i < mon->n_remote_mps; i++) {
4628         remote_mps[i] = mon->remote_mps[i]->mpid;
4629     }
4630
4631     ofproto_iface_set_cfm(iface->port->bridge->ofproto, iface->dp_ifidx,
4632                           &cfm, remote_mps, mon->n_remote_mps);
4633     free(remote_mps);
4634 }
4635
4636 /* Read carrier or miimon status directly from 'iface''s netdev, according to
4637  * how 'iface''s port is configured.
4638  *
4639  * Returns true if 'iface' is up, false otherwise. */
4640 static bool
4641 iface_get_carrier(const struct iface *iface)
4642 {
4643     return (iface->port->monitor
4644             ? netdev_get_carrier(iface->netdev)
4645             : netdev_get_miimon(iface->netdev));
4646 }
4647 \f
4648 /* Port mirroring. */
4649
4650 static struct mirror *
4651 mirror_find_by_uuid(struct bridge *br, const struct uuid *uuid)
4652 {
4653     int i;
4654
4655     for (i = 0; i < MAX_MIRRORS; i++) {
4656         struct mirror *m = br->mirrors[i];
4657         if (m && uuid_equals(uuid, &m->uuid)) {
4658             return m;
4659         }
4660     }
4661     return NULL;
4662 }
4663
4664 static void
4665 mirror_reconfigure(struct bridge *br)
4666 {
4667     unsigned long *rspan_vlans;
4668     struct port *port;
4669     int i;
4670
4671     /* Get rid of deleted mirrors. */
4672     for (i = 0; i < MAX_MIRRORS; i++) {
4673         struct mirror *m = br->mirrors[i];
4674         if (m) {
4675             const struct ovsdb_datum *mc;
4676             union ovsdb_atom atom;
4677
4678             mc = ovsrec_bridge_get_mirrors(br->cfg, OVSDB_TYPE_UUID);
4679             atom.uuid = br->mirrors[i]->uuid;
4680             if (ovsdb_datum_find_key(mc, &atom, OVSDB_TYPE_UUID) == UINT_MAX) {
4681                 mirror_destroy(m);
4682             }
4683         }
4684     }
4685
4686     /* Add new mirrors and reconfigure existing ones. */
4687     for (i = 0; i < br->cfg->n_mirrors; i++) {
4688         struct ovsrec_mirror *cfg = br->cfg->mirrors[i];
4689         struct mirror *m = mirror_find_by_uuid(br, &cfg->header_.uuid);
4690         if (m) {
4691             mirror_reconfigure_one(m, cfg);
4692         } else {
4693             mirror_create(br, cfg);
4694         }
4695     }
4696
4697     /* Update port reserved status. */
4698     HMAP_FOR_EACH (port, hmap_node, &br->ports) {
4699         port->is_mirror_output_port = false;
4700     }
4701     for (i = 0; i < MAX_MIRRORS; i++) {
4702         struct mirror *m = br->mirrors[i];
4703         if (m && m->out_port) {
4704             m->out_port->is_mirror_output_port = true;
4705         }
4706     }
4707
4708     /* Update flooded vlans (for RSPAN). */
4709     rspan_vlans = NULL;
4710     if (br->cfg->n_flood_vlans) {
4711         rspan_vlans = bitmap_allocate(4096);
4712
4713         for (i = 0; i < br->cfg->n_flood_vlans; i++) {
4714             int64_t vlan = br->cfg->flood_vlans[i];
4715             if (vlan >= 0 && vlan < 4096) {
4716                 bitmap_set1(rspan_vlans, vlan);
4717                 VLOG_INFO("bridge %s: disabling learning on vlan %"PRId64,
4718                           br->name, vlan);
4719             } else {
4720                 VLOG_ERR("bridge %s: invalid value %"PRId64 "for flood VLAN",
4721                          br->name, vlan);
4722             }
4723         }
4724     }
4725     if (mac_learning_set_flood_vlans(br->ml, rspan_vlans)) {
4726         bridge_flush(br);
4727         mac_learning_flush(br->ml);
4728     }
4729 }
4730
4731 static void
4732 mirror_create(struct bridge *br, struct ovsrec_mirror *cfg)
4733 {
4734     struct mirror *m;
4735     size_t i;
4736
4737     for (i = 0; ; i++) {
4738         if (i >= MAX_MIRRORS) {
4739             VLOG_WARN("bridge %s: maximum of %d port mirrors reached, "
4740                       "cannot create %s", br->name, MAX_MIRRORS, cfg->name);
4741             return;
4742         }
4743         if (!br->mirrors[i]) {
4744             break;
4745         }
4746     }
4747
4748     VLOG_INFO("created port mirror %s on bridge %s", cfg->name, br->name);
4749     bridge_flush(br);
4750     mac_learning_flush(br->ml);
4751
4752     br->mirrors[i] = m = xzalloc(sizeof *m);
4753     m->bridge = br;
4754     m->idx = i;
4755     m->name = xstrdup(cfg->name);
4756     sset_init(&m->src_ports);
4757     sset_init(&m->dst_ports);
4758     m->vlans = NULL;
4759     m->n_vlans = 0;
4760     m->out_vlan = -1;
4761     m->out_port = NULL;
4762
4763     mirror_reconfigure_one(m, cfg);
4764 }
4765
4766 static void
4767 mirror_destroy(struct mirror *m)
4768 {
4769     if (m) {
4770         struct bridge *br = m->bridge;
4771         struct port *port;
4772
4773         HMAP_FOR_EACH (port, hmap_node, &br->ports) {
4774             port->src_mirrors &= ~(MIRROR_MASK_C(1) << m->idx);
4775             port->dst_mirrors &= ~(MIRROR_MASK_C(1) << m->idx);
4776         }
4777
4778         sset_destroy(&m->src_ports);
4779         sset_destroy(&m->dst_ports);
4780         free(m->vlans);
4781
4782         m->bridge->mirrors[m->idx] = NULL;
4783         free(m->name);
4784         free(m);
4785
4786         bridge_flush(br);
4787         mac_learning_flush(br->ml);
4788     }
4789 }
4790
4791 static void
4792 mirror_collect_ports(struct mirror *m, struct ovsrec_port **ports, int n_ports,
4793                      struct sset *names)
4794 {
4795     size_t i;
4796
4797     for (i = 0; i < n_ports; i++) {
4798         const char *name = ports[i]->name;
4799         if (port_lookup(m->bridge, name)) {
4800             sset_add(names, name);
4801         } else {
4802             VLOG_WARN("bridge %s: mirror %s cannot match on nonexistent "
4803                       "port %s", m->bridge->name, m->name, name);
4804         }
4805     }
4806 }
4807
4808 static size_t
4809 mirror_collect_vlans(struct mirror *m, const struct ovsrec_mirror *cfg,
4810                      int **vlans)
4811 {
4812     size_t n_vlans;
4813     size_t i;
4814
4815     *vlans = xmalloc(sizeof **vlans * cfg->n_select_vlan);
4816     n_vlans = 0;
4817     for (i = 0; i < cfg->n_select_vlan; i++) {
4818         int64_t vlan = cfg->select_vlan[i];
4819         if (vlan < 0 || vlan > 4095) {
4820             VLOG_WARN("bridge %s: mirror %s selects invalid VLAN %"PRId64,
4821                       m->bridge->name, m->name, vlan);
4822         } else {
4823             (*vlans)[n_vlans++] = vlan;
4824         }
4825     }
4826     return n_vlans;
4827 }
4828
4829 static bool
4830 vlan_is_mirrored(const struct mirror *m, int vlan)
4831 {
4832     size_t i;
4833
4834     for (i = 0; i < m->n_vlans; i++) {
4835         if (m->vlans[i] == vlan) {
4836             return true;
4837         }
4838     }
4839     return false;
4840 }
4841
4842 static bool
4843 port_trunks_any_mirrored_vlan(const struct mirror *m, const struct port *p)
4844 {
4845     size_t i;
4846
4847     for (i = 0; i < m->n_vlans; i++) {
4848         if (port_trunks_vlan(p, m->vlans[i])) {
4849             return true;
4850         }
4851     }
4852     return false;
4853 }
4854
4855 static void
4856 mirror_reconfigure_one(struct mirror *m, struct ovsrec_mirror *cfg)
4857 {
4858     struct sset src_ports, dst_ports;
4859     mirror_mask_t mirror_bit;
4860     struct port *out_port;
4861     struct port *port;
4862     int out_vlan;
4863     size_t n_vlans;
4864     int *vlans;
4865
4866     /* Set name. */
4867     if (strcmp(cfg->name, m->name)) {
4868         free(m->name);
4869         m->name = xstrdup(cfg->name);
4870     }
4871
4872     /* Get output port. */
4873     if (cfg->output_port) {
4874         out_port = port_lookup(m->bridge, cfg->output_port->name);
4875         if (!out_port) {
4876             VLOG_ERR("bridge %s: mirror %s outputs to port not on bridge",
4877                      m->bridge->name, m->name);
4878             mirror_destroy(m);
4879             return;
4880         }
4881         out_vlan = -1;
4882
4883         if (cfg->output_vlan) {
4884             VLOG_ERR("bridge %s: mirror %s specifies both output port and "
4885                      "output vlan; ignoring output vlan",
4886                      m->bridge->name, m->name);
4887         }
4888     } else if (cfg->output_vlan) {
4889         out_port = NULL;
4890         out_vlan = *cfg->output_vlan;
4891     } else {
4892         VLOG_ERR("bridge %s: mirror %s does not specify output; ignoring",
4893                  m->bridge->name, m->name);
4894         mirror_destroy(m);
4895         return;
4896     }
4897
4898     sset_init(&src_ports);
4899     sset_init(&dst_ports);
4900     if (cfg->select_all) {
4901         HMAP_FOR_EACH (port, hmap_node, &m->bridge->ports) {
4902             sset_add(&src_ports, port->name);
4903             sset_add(&dst_ports, port->name);
4904         }
4905         vlans = NULL;
4906         n_vlans = 0;
4907     } else {
4908         /* Get ports, and drop duplicates and ports that don't exist. */
4909         mirror_collect_ports(m, cfg->select_src_port, cfg->n_select_src_port,
4910                              &src_ports);
4911         mirror_collect_ports(m, cfg->select_dst_port, cfg->n_select_dst_port,
4912                              &dst_ports);
4913
4914         /* Get all the vlans, and drop duplicate and invalid vlans. */
4915         n_vlans = mirror_collect_vlans(m, cfg, &vlans);
4916     }
4917
4918     /* Update mirror data. */
4919     if (!sset_equals(&m->src_ports, &src_ports)
4920         || !sset_equals(&m->dst_ports, &dst_ports)
4921         || m->n_vlans != n_vlans
4922         || memcmp(m->vlans, vlans, sizeof *vlans * n_vlans)
4923         || m->out_port != out_port
4924         || m->out_vlan != out_vlan) {
4925         bridge_flush(m->bridge);
4926         mac_learning_flush(m->bridge->ml);
4927     }
4928     sset_swap(&m->src_ports, &src_ports);
4929     sset_swap(&m->dst_ports, &dst_ports);
4930     free(m->vlans);
4931     m->vlans = vlans;
4932     m->n_vlans = n_vlans;
4933     m->out_port = out_port;
4934     m->out_vlan = out_vlan;
4935
4936     /* Update ports. */
4937     mirror_bit = MIRROR_MASK_C(1) << m->idx;
4938     HMAP_FOR_EACH (port, hmap_node, &m->bridge->ports) {
4939         if (sset_contains(&m->src_ports, port->name)
4940             || (m->n_vlans
4941                 && (!port->vlan
4942                     ? port_trunks_any_mirrored_vlan(m, port)
4943                     : vlan_is_mirrored(m, port->vlan)))) {
4944             port->src_mirrors |= mirror_bit;
4945         } else {
4946             port->src_mirrors &= ~mirror_bit;
4947         }
4948
4949         if (sset_contains(&m->dst_ports, port->name)) {
4950             port->dst_mirrors |= mirror_bit;
4951         } else {
4952             port->dst_mirrors &= ~mirror_bit;
4953         }
4954     }
4955
4956     /* Clean up. */
4957     sset_destroy(&src_ports);
4958     sset_destroy(&dst_ports);
4959 }