bridge: Update a comment
[sliver-openvswitch.git] / vswitchd / bridge.c
1 /* Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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 <errno.h>
19 #include <inttypes.h>
20 #include <stdlib.h>
21 #include "async-append.h"
22 #include "bfd.h"
23 #include "bitmap.h"
24 #include "cfm.h"
25 #include "connectivity.h"
26 #include "coverage.h"
27 #include "daemon.h"
28 #include "dirs.h"
29 #include "dynamic-string.h"
30 #include "hash.h"
31 #include "hmap.h"
32 #include "hmapx.h"
33 #include "jsonrpc.h"
34 #include "lacp.h"
35 #include "list.h"
36 #include "mac-learning.h"
37 #include "meta-flow.h"
38 #include "netdev.h"
39 #include "ofp-print.h"
40 #include "ofp-util.h"
41 #include "ofpbuf.h"
42 #include "ofproto/bond.h"
43 #include "ofproto/ofproto.h"
44 #include "poll-loop.h"
45 #include "seq.h"
46 #include "sha1.h"
47 #include "shash.h"
48 #include "smap.h"
49 #include "socket-util.h"
50 #include "stream.h"
51 #include "stream-ssl.h"
52 #include "sset.h"
53 #include "system-stats.h"
54 #include "timeval.h"
55 #include "util.h"
56 #include "unixctl.h"
57 #include "vlandev.h"
58 #include "lib/vswitch-idl.h"
59 #include "xenserver.h"
60 #include "vlog.h"
61 #include "sflow_api.h"
62 #include "vlan-bitmap.h"
63
64 VLOG_DEFINE_THIS_MODULE(bridge);
65
66 COVERAGE_DEFINE(bridge_reconfigure);
67
68 struct iface {
69     /* These members are always valid.
70      *
71      * They are immutable: they never change between iface_create() and
72      * iface_destroy(). */
73     struct list port_elem;      /* Element in struct port's "ifaces" list. */
74     struct hmap_node name_node; /* In struct bridge's "iface_by_name" hmap. */
75     struct hmap_node ofp_port_node; /* In struct bridge's "ifaces" hmap. */
76     struct port *port;          /* Containing port. */
77     char *name;                 /* Host network device name. */
78     struct netdev *netdev;      /* Network device. */
79     ofp_port_t ofp_port;        /* OpenFlow port number. */
80
81     /* These members are valid only within bridge_reconfigure(). */
82     const char *type;           /* Usually same as cfg->type. */
83     const struct ovsrec_interface *cfg;
84 };
85
86 struct mirror {
87     struct uuid uuid;           /* UUID of this "mirror" record in database. */
88     struct hmap_node hmap_node; /* In struct bridge's "mirrors" hmap. */
89     struct bridge *bridge;
90     char *name;
91     const struct ovsrec_mirror *cfg;
92 };
93
94 struct port {
95     struct hmap_node hmap_node; /* Element in struct bridge's "ports" hmap. */
96     struct bridge *bridge;
97     char *name;
98
99     const struct ovsrec_port *cfg;
100
101     /* An ordinary bridge port has 1 interface.
102      * A bridge port for bonding has at least 2 interfaces. */
103     struct list ifaces;         /* List of "struct iface"s. */
104 };
105
106 struct bridge {
107     struct hmap_node node;      /* In 'all_bridges'. */
108     char *name;                 /* User-specified arbitrary name. */
109     char *type;                 /* Datapath type. */
110     uint8_t ea[ETH_ADDR_LEN];   /* Bridge Ethernet Address. */
111     uint8_t default_ea[ETH_ADDR_LEN]; /* Default MAC. */
112     const struct ovsrec_bridge *cfg;
113
114     /* OpenFlow switch processing. */
115     struct ofproto *ofproto;    /* OpenFlow switch. */
116
117     /* Bridge ports. */
118     struct hmap ports;          /* "struct port"s indexed by name. */
119     struct hmap ifaces;         /* "struct iface"s indexed by ofp_port. */
120     struct hmap iface_by_name;  /* "struct iface"s indexed by name. */
121
122     /* Port mirroring. */
123     struct hmap mirrors;        /* "struct mirror" indexed by UUID. */
124
125     /* Used during reconfiguration. */
126     struct shash wanted_ports;
127
128     /* Synthetic local port if necessary. */
129     struct ovsrec_port synth_local_port;
130     struct ovsrec_interface synth_local_iface;
131     struct ovsrec_interface *synth_local_ifacep;
132 };
133
134 /* All bridges, indexed by name. */
135 static struct hmap all_bridges = HMAP_INITIALIZER(&all_bridges);
136
137 /* OVSDB IDL used to obtain configuration. */
138 static struct ovsdb_idl *idl;
139
140 /* We want to complete daemonization, fully detaching from our parent process,
141  * only after we have completed our initial configuration, committed our state
142  * to the database, and received confirmation back from the database server
143  * that it applied the commit.  This allows our parent process to know that,
144  * post-detach, ephemeral fields such as datapath-id and ofport are very likely
145  * to have already been filled in.  (It is only "very likely" rather than
146  * certain because there is always a slim possibility that the transaction will
147  * fail or that some other client has added new bridges, ports, etc. while
148  * ovs-vswitchd was configuring using an old configuration.)
149  *
150  * We only need to do this once for our initial configuration at startup, so
151  * 'initial_config_done' tracks whether we've already done it.  While we are
152  * waiting for a response to our commit, 'daemonize_txn' tracks the transaction
153  * itself and is otherwise NULL. */
154 static bool initial_config_done;
155 static struct ovsdb_idl_txn *daemonize_txn;
156
157 /* Most recently processed IDL sequence number. */
158 static unsigned int idl_seqno;
159
160 /* Track changes to port connectivity. */
161 static uint64_t connectivity_seqno = LLONG_MIN;
162
163 /* Each time this timer expires, the bridge fetches interface and mirror
164  * statistics and pushes them into the database. */
165 #define IFACE_STATS_INTERVAL (5 * 1000) /* In milliseconds. */
166 static long long int iface_stats_timer = LLONG_MIN;
167
168 /* In some datapaths, creating and destroying OpenFlow ports can be extremely
169  * expensive.  This can cause bridge_reconfigure() to take a long time during
170  * which no other work can be done.  To deal with this problem, we limit port
171  * adds and deletions to a window of OFP_PORT_ACTION_WINDOW milliseconds per
172  * call to bridge_reconfigure().  If there is more work to do after the limit
173  * is reached, 'need_reconfigure', is flagged and it's done on the next loop.
174  * This allows the rest of the code to catch up on important things like
175  * forwarding packets. */
176 #define OFP_PORT_ACTION_WINDOW 10
177
178 static void add_del_bridges(const struct ovsrec_open_vswitch *);
179 static void bridge_run__(void);
180 static void bridge_create(const struct ovsrec_bridge *);
181 static void bridge_destroy(struct bridge *);
182 static struct bridge *bridge_lookup(const char *name);
183 static unixctl_cb_func bridge_unixctl_dump_flows;
184 static unixctl_cb_func bridge_unixctl_reconnect;
185 static size_t bridge_get_controllers(const struct bridge *br,
186                                      struct ovsrec_controller ***controllersp);
187 static void bridge_collect_wanted_ports(struct bridge *,
188                                         const unsigned long *splinter_vlans,
189                                         struct shash *wanted_ports);
190 static void bridge_delete_ofprotos(void);
191 static void bridge_delete_or_reconfigure_ports(struct bridge *);
192 static void bridge_del_ports(struct bridge *,
193                              const struct shash *wanted_ports);
194 static void bridge_add_ports(struct bridge *,
195                              const struct shash *wanted_ports);
196
197 static void bridge_configure_flow_miss_model(const char *opt);
198 static void bridge_configure_datapath_id(struct bridge *);
199 static void bridge_configure_netflow(struct bridge *);
200 static void bridge_configure_forward_bpdu(struct bridge *);
201 static void bridge_configure_mac_table(struct bridge *);
202 static void bridge_configure_sflow(struct bridge *, int *sflow_bridge_number);
203 static void bridge_configure_ipfix(struct bridge *);
204 static void bridge_configure_stp(struct bridge *);
205 static void bridge_configure_tables(struct bridge *);
206 static void bridge_configure_dp_desc(struct bridge *);
207 static void bridge_configure_remotes(struct bridge *,
208                                      const struct sockaddr_in *managers,
209                                      size_t n_managers);
210 static void bridge_pick_local_hw_addr(struct bridge *,
211                                       uint8_t ea[ETH_ADDR_LEN],
212                                       struct iface **hw_addr_iface);
213 static uint64_t bridge_pick_datapath_id(struct bridge *,
214                                         const uint8_t bridge_ea[ETH_ADDR_LEN],
215                                         struct iface *hw_addr_iface);
216 static uint64_t dpid_from_hash(const void *, size_t nbytes);
217 static bool bridge_has_bond_fake_iface(const struct bridge *,
218                                        const char *name);
219 static bool port_is_bond_fake_iface(const struct port *);
220
221 static unixctl_cb_func qos_unixctl_show;
222
223 static struct port *port_create(struct bridge *, const struct ovsrec_port *);
224 static void port_del_ifaces(struct port *);
225 static void port_destroy(struct port *);
226 static struct port *port_lookup(const struct bridge *, const char *name);
227 static void port_configure(struct port *);
228 static struct lacp_settings *port_configure_lacp(struct port *,
229                                                  struct lacp_settings *);
230 static void port_configure_bond(struct port *, struct bond_settings *);
231 static bool port_is_synthetic(const struct port *);
232
233 static void reconfigure_system_stats(const struct ovsrec_open_vswitch *);
234 static void run_system_stats(void);
235
236 static void bridge_configure_mirrors(struct bridge *);
237 static struct mirror *mirror_create(struct bridge *,
238                                     const struct ovsrec_mirror *);
239 static void mirror_destroy(struct mirror *);
240 static bool mirror_configure(struct mirror *);
241 static void mirror_refresh_stats(struct mirror *);
242
243 static void iface_configure_lacp(struct iface *, struct lacp_slave_settings *);
244 static bool iface_create(struct bridge *, const struct ovsrec_interface *,
245                          const struct ovsrec_port *);
246 static bool iface_is_internal(const struct ovsrec_interface *iface,
247                               const struct ovsrec_bridge *br);
248 static const char *iface_get_type(const struct ovsrec_interface *,
249                                   const struct ovsrec_bridge *);
250 static void iface_destroy(struct iface *);
251 static struct iface *iface_lookup(const struct bridge *, const char *name);
252 static struct iface *iface_find(const char *name);
253 static struct iface *iface_from_ofp_port(const struct bridge *,
254                                          ofp_port_t ofp_port);
255 static void iface_set_mac(struct iface *);
256 static void iface_set_ofport(const struct ovsrec_interface *, ofp_port_t ofport);
257 static void iface_clear_db_record(const struct ovsrec_interface *if_cfg);
258 static void iface_configure_qos(struct iface *, const struct ovsrec_qos *);
259 static void iface_configure_cfm(struct iface *);
260 static void iface_refresh_cfm_stats(struct iface *);
261 static void iface_refresh_stats(struct iface *);
262 static void iface_refresh_status(struct iface *);
263 static bool iface_is_synthetic(const struct iface *);
264 static ofp_port_t iface_get_requested_ofp_port(
265     const struct ovsrec_interface *);
266 static ofp_port_t iface_pick_ofport(const struct ovsrec_interface *);
267
268 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
269  *
270  * This is deprecated.  It is only for compatibility with broken device drivers
271  * in old versions of Linux that do not properly support VLANs when VLAN
272  * devices are not used.  When broken device drivers are no longer in
273  * widespread use, we will delete these interfaces. */
274
275 /* True if VLAN splinters are enabled on any interface, false otherwise.*/
276 static bool vlan_splinters_enabled_anywhere;
277
278 static bool vlan_splinters_is_enabled(const struct ovsrec_interface *);
279 static unsigned long int *collect_splinter_vlans(
280     const struct ovsrec_open_vswitch *);
281 static void configure_splinter_port(struct port *);
282 static void add_vlan_splinter_ports(struct bridge *,
283                                     const unsigned long int *splinter_vlans,
284                                     struct shash *ports);
285
286 static void
287 bridge_init_ofproto(const struct ovsrec_open_vswitch *cfg)
288 {
289     struct shash iface_hints;
290     static bool initialized = false;
291     int i;
292
293     if (initialized) {
294         return;
295     }
296
297     shash_init(&iface_hints);
298
299     if (cfg) {
300         for (i = 0; i < cfg->n_bridges; i++) {
301             const struct ovsrec_bridge *br_cfg = cfg->bridges[i];
302             int j;
303
304             for (j = 0; j < br_cfg->n_ports; j++) {
305                 struct ovsrec_port *port_cfg = br_cfg->ports[j];
306                 int k;
307
308                 for (k = 0; k < port_cfg->n_interfaces; k++) {
309                     struct ovsrec_interface *if_cfg = port_cfg->interfaces[k];
310                     struct iface_hint *iface_hint;
311
312                     iface_hint = xmalloc(sizeof *iface_hint);
313                     iface_hint->br_name = br_cfg->name;
314                     iface_hint->br_type = br_cfg->datapath_type;
315                     iface_hint->ofp_port = iface_pick_ofport(if_cfg);
316
317                     shash_add(&iface_hints, if_cfg->name, iface_hint);
318                 }
319             }
320         }
321     }
322
323     ofproto_init(&iface_hints);
324
325     shash_destroy_free_data(&iface_hints);
326     initialized = true;
327 }
328 \f
329 /* Public functions. */
330
331 /* Initializes the bridge module, configuring it to obtain its configuration
332  * from an OVSDB server accessed over 'remote', which should be a string in a
333  * form acceptable to ovsdb_idl_create(). */
334 void
335 bridge_init(const char *remote)
336 {
337     /* Create connection to database. */
338     idl = ovsdb_idl_create(remote, &ovsrec_idl_class, true, true);
339     idl_seqno = ovsdb_idl_get_seqno(idl);
340     ovsdb_idl_set_lock(idl, "ovs_vswitchd");
341     ovsdb_idl_verify_write_only(idl);
342
343     ovsdb_idl_omit_alert(idl, &ovsrec_open_vswitch_col_cur_cfg);
344     ovsdb_idl_omit_alert(idl, &ovsrec_open_vswitch_col_statistics);
345     ovsdb_idl_omit(idl, &ovsrec_open_vswitch_col_external_ids);
346     ovsdb_idl_omit(idl, &ovsrec_open_vswitch_col_ovs_version);
347     ovsdb_idl_omit(idl, &ovsrec_open_vswitch_col_db_version);
348     ovsdb_idl_omit(idl, &ovsrec_open_vswitch_col_system_type);
349     ovsdb_idl_omit(idl, &ovsrec_open_vswitch_col_system_version);
350
351     ovsdb_idl_omit_alert(idl, &ovsrec_bridge_col_datapath_id);
352     ovsdb_idl_omit_alert(idl, &ovsrec_bridge_col_status);
353     ovsdb_idl_omit(idl, &ovsrec_bridge_col_external_ids);
354
355     ovsdb_idl_omit_alert(idl, &ovsrec_port_col_status);
356     ovsdb_idl_omit_alert(idl, &ovsrec_port_col_statistics);
357     ovsdb_idl_omit(idl, &ovsrec_port_col_external_ids);
358     ovsdb_idl_omit(idl, &ovsrec_port_col_fake_bridge);
359
360     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_admin_state);
361     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_duplex);
362     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_link_speed);
363     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_link_state);
364     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_link_resets);
365     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_mac_in_use);
366     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_ifindex);
367     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_mtu);
368     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_ofport);
369     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_statistics);
370     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_status);
371     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_cfm_fault);
372     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_cfm_fault_status);
373     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_cfm_remote_mpids);
374     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_cfm_flap_count);
375     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_cfm_health);
376     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_cfm_remote_opstate);
377     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_bfd_status);
378     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_lacp_current);
379     ovsdb_idl_omit(idl, &ovsrec_interface_col_external_ids);
380
381     ovsdb_idl_omit_alert(idl, &ovsrec_controller_col_is_connected);
382     ovsdb_idl_omit_alert(idl, &ovsrec_controller_col_role);
383     ovsdb_idl_omit_alert(idl, &ovsrec_controller_col_status);
384     ovsdb_idl_omit(idl, &ovsrec_controller_col_external_ids);
385
386     ovsdb_idl_omit(idl, &ovsrec_qos_col_external_ids);
387
388     ovsdb_idl_omit(idl, &ovsrec_queue_col_external_ids);
389
390     ovsdb_idl_omit(idl, &ovsrec_mirror_col_external_ids);
391     ovsdb_idl_omit_alert(idl, &ovsrec_mirror_col_statistics);
392
393     ovsdb_idl_omit(idl, &ovsrec_netflow_col_external_ids);
394     ovsdb_idl_omit(idl, &ovsrec_sflow_col_external_ids);
395     ovsdb_idl_omit(idl, &ovsrec_ipfix_col_external_ids);
396     ovsdb_idl_omit(idl, &ovsrec_flow_sample_collector_set_col_external_ids);
397
398     ovsdb_idl_omit(idl, &ovsrec_manager_col_external_ids);
399     ovsdb_idl_omit(idl, &ovsrec_manager_col_inactivity_probe);
400     ovsdb_idl_omit(idl, &ovsrec_manager_col_is_connected);
401     ovsdb_idl_omit(idl, &ovsrec_manager_col_max_backoff);
402     ovsdb_idl_omit(idl, &ovsrec_manager_col_status);
403
404     ovsdb_idl_omit(idl, &ovsrec_ssl_col_external_ids);
405
406     /* Register unixctl commands. */
407     unixctl_command_register("qos/show", "interface", 1, 1,
408                              qos_unixctl_show, NULL);
409     unixctl_command_register("bridge/dump-flows", "bridge", 1, 1,
410                              bridge_unixctl_dump_flows, NULL);
411     unixctl_command_register("bridge/reconnect", "[bridge]", 0, 1,
412                              bridge_unixctl_reconnect, NULL);
413     lacp_init();
414     bond_init();
415     cfm_init();
416     stp_init();
417 }
418
419 void
420 bridge_exit(void)
421 {
422     struct bridge *br, *next_br;
423
424     HMAP_FOR_EACH_SAFE (br, next_br, node, &all_bridges) {
425         bridge_destroy(br);
426     }
427     ovsdb_idl_destroy(idl);
428 }
429
430 /* Looks at the list of managers in 'ovs_cfg' and extracts their remote IP
431  * addresses and ports into '*managersp' and '*n_managersp'.  The caller is
432  * responsible for freeing '*managersp' (with free()).
433  *
434  * You may be asking yourself "why does ovs-vswitchd care?", because
435  * ovsdb-server is responsible for connecting to the managers, and ovs-vswitchd
436  * should not be and in fact is not directly involved in that.  But
437  * ovs-vswitchd needs to make sure that ovsdb-server can reach the managers, so
438  * it has to tell in-band control where the managers are to enable that.
439  * (Thus, only managers connected in-band are collected.)
440  */
441 static void
442 collect_in_band_managers(const struct ovsrec_open_vswitch *ovs_cfg,
443                          struct sockaddr_in **managersp, size_t *n_managersp)
444 {
445     struct sockaddr_in *managers = NULL;
446     size_t n_managers = 0;
447     struct sset targets;
448     size_t i;
449
450     /* Collect all of the potential targets from the "targets" columns of the
451      * rows pointed to by "manager_options", excluding any that are
452      * out-of-band. */
453     sset_init(&targets);
454     for (i = 0; i < ovs_cfg->n_manager_options; i++) {
455         struct ovsrec_manager *m = ovs_cfg->manager_options[i];
456
457         if (m->connection_mode && !strcmp(m->connection_mode, "out-of-band")) {
458             sset_find_and_delete(&targets, m->target);
459         } else {
460             sset_add(&targets, m->target);
461         }
462     }
463
464     /* Now extract the targets' IP addresses. */
465     if (!sset_is_empty(&targets)) {
466         const char *target;
467
468         managers = xmalloc(sset_count(&targets) * sizeof *managers);
469         SSET_FOR_EACH (target, &targets) {
470             struct sockaddr_in *sin = &managers[n_managers];
471
472             if (stream_parse_target_with_default_port(target,
473                                                       OVSDB_OLD_PORT,
474                                                       sin)) {
475                 n_managers++;
476             }
477         }
478     }
479     sset_destroy(&targets);
480
481     *managersp = managers;
482     *n_managersp = n_managers;
483 }
484
485 static void
486 bridge_reconfigure(const struct ovsrec_open_vswitch *ovs_cfg)
487 {
488     unsigned long int *splinter_vlans;
489     struct sockaddr_in *managers;
490     struct bridge *br, *next;
491     int sflow_bridge_number;
492     size_t n_managers;
493
494     COVERAGE_INC(bridge_reconfigure);
495
496     ofproto_set_flow_limit(smap_get_int(&ovs_cfg->other_config, "flow-limit",
497                                         OFPROTO_FLOW_LIMIT_DEFAULT));
498
499     ofproto_set_threads(
500         smap_get_int(&ovs_cfg->other_config, "n-handler-threads", 0),
501         smap_get_int(&ovs_cfg->other_config, "n-revalidator-threads", 0));
502
503     bridge_configure_flow_miss_model(smap_get(&ovs_cfg->other_config,
504                                               "force-miss-model"));
505
506     /* Destroy "struct bridge"s, "struct port"s, and "struct iface"s according
507      * to 'ovs_cfg', with only very minimal configuration otherwise.
508      *
509      * This is mostly an update to bridge data structures. Nothing is pushed
510      * down to ofproto or lower layers. */
511     add_del_bridges(ovs_cfg);
512     splinter_vlans = collect_splinter_vlans(ovs_cfg);
513     HMAP_FOR_EACH (br, node, &all_bridges) {
514         bridge_collect_wanted_ports(br, splinter_vlans, &br->wanted_ports);
515         bridge_del_ports(br, &br->wanted_ports);
516     }
517     free(splinter_vlans);
518
519     /* Start pushing configuration changes down to the ofproto layer:
520      *
521      *   - Delete ofprotos that are no longer configured.
522      *
523      *   - Delete ports that are no longer configured.
524      *
525      *   - Reconfigure existing ports to their desired configurations, or
526      *     delete them if not possible.
527      *
528      * We have to do all the deletions before we can do any additions, because
529      * the ports to be added might require resources that will be freed up by
530      * deletions (they might especially overlap in name). */
531     bridge_delete_ofprotos();
532     HMAP_FOR_EACH (br, node, &all_bridges) {
533         if (br->ofproto) {
534             bridge_delete_or_reconfigure_ports(br);
535         }
536     }
537
538     /* Finish pushing configuration changes to the ofproto layer:
539      *
540      *     - Create ofprotos that are missing.
541      *
542      *     - Add ports that are missing. */
543     HMAP_FOR_EACH_SAFE (br, next, node, &all_bridges) {
544         if (!br->ofproto) {
545             int error;
546
547             error = ofproto_create(br->name, br->type, &br->ofproto);
548             if (error) {
549                 VLOG_ERR("failed to create bridge %s: %s", br->name,
550                          ovs_strerror(error));
551                 shash_destroy(&br->wanted_ports);
552                 bridge_destroy(br);
553             }
554         }
555     }
556     HMAP_FOR_EACH (br, node, &all_bridges) {
557         bridge_add_ports(br, &br->wanted_ports);
558         shash_destroy(&br->wanted_ports);
559     }
560
561     reconfigure_system_stats(ovs_cfg);
562
563     /* Complete the configuration. */
564     sflow_bridge_number = 0;
565     collect_in_band_managers(ovs_cfg, &managers, &n_managers);
566     HMAP_FOR_EACH (br, node, &all_bridges) {
567         struct port *port;
568
569         /* We need the datapath ID early to allow LACP ports to use it as the
570          * default system ID. */
571         bridge_configure_datapath_id(br);
572
573         HMAP_FOR_EACH (port, hmap_node, &br->ports) {
574             struct iface *iface;
575
576             port_configure(port);
577
578             LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
579                 iface_configure_cfm(iface);
580                 iface_configure_qos(iface, port->cfg->qos);
581                 iface_set_mac(iface);
582                 ofproto_port_set_bfd(br->ofproto, iface->ofp_port,
583                                      &iface->cfg->bfd);
584             }
585         }
586         bridge_configure_mirrors(br);
587         bridge_configure_forward_bpdu(br);
588         bridge_configure_mac_table(br);
589         bridge_configure_remotes(br, managers, n_managers);
590         bridge_configure_netflow(br);
591         bridge_configure_sflow(br, &sflow_bridge_number);
592         bridge_configure_ipfix(br);
593         bridge_configure_stp(br);
594         bridge_configure_tables(br);
595         bridge_configure_dp_desc(br);
596
597         if (smap_get(&br->cfg->other_config, "flow-eviction-threshold")) {
598             /* XXX: Remove this warning message eventually. */
599             VLOG_WARN_ONCE("As of June 2013, flow-eviction-threshold has been"
600                            " moved to the Open_vSwitch table.  Ignoring its"
601                            " setting in the bridge table.");
602         }
603     }
604     free(managers);
605
606     /* The ofproto-dpif provider does some final reconfiguration in its
607      * ->type_run() function.  We have to call it before notifying the database
608      * client that reconfiguration is complete, otherwise there is a very
609      * narrow race window in which e.g. ofproto/trace will not recognize the
610      * new configuration (sometimes this causes unit test failures). */
611     bridge_run__();
612 }
613
614 /* Delete ofprotos which aren't configured or have the wrong type.  Create
615  * ofprotos which don't exist but need to. */
616 static void
617 bridge_delete_ofprotos(void)
618 {
619     struct bridge *br;
620     struct sset names;
621     struct sset types;
622     const char *type;
623
624     /* Delete ofprotos with no bridge or with the wrong type. */
625     sset_init(&names);
626     sset_init(&types);
627     ofproto_enumerate_types(&types);
628     SSET_FOR_EACH (type, &types) {
629         const char *name;
630
631         ofproto_enumerate_names(type, &names);
632         SSET_FOR_EACH (name, &names) {
633             br = bridge_lookup(name);
634             if (!br || strcmp(type, br->type)) {
635                 ofproto_delete(name, type);
636             }
637         }
638     }
639     sset_destroy(&names);
640     sset_destroy(&types);
641 }
642
643 static ofp_port_t *
644 add_ofp_port(ofp_port_t port, ofp_port_t *ports, size_t *n, size_t *allocated)
645 {
646     if (*n >= *allocated) {
647         ports = x2nrealloc(ports, allocated, sizeof *ports);
648     }
649     ports[(*n)++] = port;
650     return ports;
651 }
652
653 static void
654 bridge_delete_or_reconfigure_ports(struct bridge *br)
655 {
656     struct ofproto_port ofproto_port;
657     struct ofproto_port_dump dump;
658
659     /* List of "ofp_port"s to delete.  We make a list instead of deleting them
660      * right away because ofproto implementations aren't necessarily able to
661      * iterate through a changing list of ports in an entirely robust way. */
662     ofp_port_t *del;
663     size_t n, allocated;
664     size_t i;
665
666     del = NULL;
667     n = allocated = 0;
668
669     OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, br->ofproto) {
670         ofp_port_t requested_ofp_port;
671         struct iface *iface;
672
673         iface = iface_lookup(br, ofproto_port.name);
674         if (!iface) {
675             /* No such iface is configured, so we should delete this
676              * ofproto_port.
677              *
678              * As a corner case exception, keep the port if it's a bond fake
679              * interface. */
680             if (bridge_has_bond_fake_iface(br, ofproto_port.name)
681                 && !strcmp(ofproto_port.type, "internal")) {
682                 continue;
683             }
684             goto delete;
685         }
686
687         if (strcmp(ofproto_port.type, iface->type)
688             || netdev_set_config(iface->netdev, &iface->cfg->options)) {
689             /* The interface is the wrong type or can't be configured.
690              * Delete it. */
691             goto delete;
692         }
693
694         /* If the requested OpenFlow port for 'iface' changed, and it's not
695          * already the correct port, then we might want to temporarily delete
696          * this interface, so we can add it back again with the new OpenFlow
697          * port number. */
698         requested_ofp_port = iface_get_requested_ofp_port(iface->cfg);
699         if (iface->ofp_port != OFPP_LOCAL &&
700             requested_ofp_port != OFPP_NONE &&
701             requested_ofp_port != iface->ofp_port) {
702             ofp_port_t victim_request;
703             struct iface *victim;
704
705             /* Check for an existing OpenFlow port currently occupying
706              * 'iface''s requested port number.  If there isn't one, then
707              * delete this port.  Otherwise we need to consider further. */
708             victim = iface_from_ofp_port(br, requested_ofp_port);
709             if (!victim) {
710                 goto delete;
711             }
712
713             /* 'victim' is a port currently using 'iface''s requested port
714              * number.  Unless 'victim' specifically requested that port
715              * number, too, then we can delete both 'iface' and 'victim'
716              * temporarily.  (We'll add both of them back again later with new
717              * OpenFlow port numbers.)
718              *
719              * If 'victim' did request port number 'requested_ofp_port', just
720              * like 'iface', then that's a configuration inconsistency that we
721              * can't resolve.  We might as well let it keep its current port
722              * number. */
723             victim_request = iface_get_requested_ofp_port(victim->cfg);
724             if (victim_request != requested_ofp_port) {
725                 del = add_ofp_port(victim->ofp_port, del, &n, &allocated);
726                 iface_destroy(victim);
727                 goto delete;
728             }
729         }
730
731         /* Keep it. */
732         continue;
733
734     delete:
735         iface_destroy(iface);
736         del = add_ofp_port(ofproto_port.ofp_port, del, &n, &allocated);
737     }
738
739     for (i = 0; i < n; i++) {
740         ofproto_port_del(br->ofproto, del[i]);
741     }
742     free(del);
743 }
744
745 static void
746 bridge_add_ports__(struct bridge *br, const struct shash *wanted_ports,
747                    bool with_requested_port)
748 {
749     struct shash_node *port_node;
750
751     SHASH_FOR_EACH (port_node, wanted_ports) {
752         const struct ovsrec_port *port_cfg = port_node->data;
753         size_t i;
754
755         for (i = 0; i < port_cfg->n_interfaces; i++) {
756             const struct ovsrec_interface *iface_cfg = port_cfg->interfaces[i];
757             ofp_port_t requested_ofp_port;
758
759             requested_ofp_port = iface_get_requested_ofp_port(iface_cfg);
760             if ((requested_ofp_port != OFPP_NONE) == with_requested_port) {
761                 struct iface *iface = iface_lookup(br, iface_cfg->name);
762
763                 if (!iface) {
764                     iface_create(br, iface_cfg, port_cfg);
765                 }
766             }
767         }
768     }
769 }
770
771 static void
772 bridge_add_ports(struct bridge *br, const struct shash *wanted_ports)
773 {
774     /* First add interfaces that request a particular port number. */
775     bridge_add_ports__(br, wanted_ports, true);
776
777     /* Then add interfaces that want automatic port number assignment.
778      * We add these afterward to avoid accidentally taking a specifically
779      * requested port number. */
780     bridge_add_ports__(br, wanted_ports, false);
781 }
782
783 static void
784 port_configure(struct port *port)
785 {
786     const struct ovsrec_port *cfg = port->cfg;
787     struct bond_settings bond_settings;
788     struct lacp_settings lacp_settings;
789     struct ofproto_bundle_settings s;
790     struct iface *iface;
791
792     if (cfg->vlan_mode && !strcmp(cfg->vlan_mode, "splinter")) {
793         configure_splinter_port(port);
794         return;
795     }
796
797     /* Get name. */
798     s.name = port->name;
799
800     /* Get slaves. */
801     s.n_slaves = 0;
802     s.slaves = xmalloc(list_size(&port->ifaces) * sizeof *s.slaves);
803     LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
804         s.slaves[s.n_slaves++] = iface->ofp_port;
805     }
806
807     /* Get VLAN tag. */
808     s.vlan = -1;
809     if (cfg->tag && *cfg->tag >= 0 && *cfg->tag <= 4095) {
810         s.vlan = *cfg->tag;
811     }
812
813     /* Get VLAN trunks. */
814     s.trunks = NULL;
815     if (cfg->n_trunks) {
816         s.trunks = vlan_bitmap_from_array(cfg->trunks, cfg->n_trunks);
817     }
818
819     /* Get VLAN mode. */
820     if (cfg->vlan_mode) {
821         if (!strcmp(cfg->vlan_mode, "access")) {
822             s.vlan_mode = PORT_VLAN_ACCESS;
823         } else if (!strcmp(cfg->vlan_mode, "trunk")) {
824             s.vlan_mode = PORT_VLAN_TRUNK;
825         } else if (!strcmp(cfg->vlan_mode, "native-tagged")) {
826             s.vlan_mode = PORT_VLAN_NATIVE_TAGGED;
827         } else if (!strcmp(cfg->vlan_mode, "native-untagged")) {
828             s.vlan_mode = PORT_VLAN_NATIVE_UNTAGGED;
829         } else {
830             /* This "can't happen" because ovsdb-server should prevent it. */
831             VLOG_ERR("unknown VLAN mode %s", cfg->vlan_mode);
832             s.vlan_mode = PORT_VLAN_TRUNK;
833         }
834     } else {
835         if (s.vlan >= 0) {
836             s.vlan_mode = PORT_VLAN_ACCESS;
837             if (cfg->n_trunks) {
838                 VLOG_ERR("port %s: ignoring trunks in favor of implicit vlan",
839                          port->name);
840             }
841         } else {
842             s.vlan_mode = PORT_VLAN_TRUNK;
843         }
844     }
845     s.use_priority_tags = smap_get_bool(&cfg->other_config, "priority-tags",
846                                         false);
847
848     /* Get LACP settings. */
849     s.lacp = port_configure_lacp(port, &lacp_settings);
850     if (s.lacp) {
851         size_t i = 0;
852
853         s.lacp_slaves = xmalloc(s.n_slaves * sizeof *s.lacp_slaves);
854         LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
855             iface_configure_lacp(iface, &s.lacp_slaves[i++]);
856         }
857     } else {
858         s.lacp_slaves = NULL;
859     }
860
861     /* Get bond settings. */
862     if (s.n_slaves > 1) {
863         s.bond = &bond_settings;
864         port_configure_bond(port, &bond_settings);
865     } else {
866         s.bond = NULL;
867         LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
868             netdev_set_miimon_interval(iface->netdev, 0);
869         }
870     }
871
872     /* Register. */
873     ofproto_bundle_register(port->bridge->ofproto, port, &s);
874
875     /* Clean up. */
876     free(s.slaves);
877     free(s.trunks);
878     free(s.lacp_slaves);
879 }
880
881 static void
882 bridge_configure_flow_miss_model(const char *opt)
883 {
884     enum ofproto_flow_miss_model model = OFPROTO_HANDLE_MISS_AUTO;
885
886     if (opt) {
887         if (!strcmp(opt, "with-facets")) {
888             model = OFPROTO_HANDLE_MISS_WITH_FACETS;
889         } else if (!strcmp(opt, "without-facets")) {
890             model = OFPROTO_HANDLE_MISS_WITHOUT_FACETS;
891         }
892     }
893
894     ofproto_set_flow_miss_model(model);
895 }
896
897 /* Pick local port hardware address and datapath ID for 'br'. */
898 static void
899 bridge_configure_datapath_id(struct bridge *br)
900 {
901     uint8_t ea[ETH_ADDR_LEN];
902     uint64_t dpid;
903     struct iface *local_iface;
904     struct iface *hw_addr_iface;
905     char *dpid_string;
906
907     bridge_pick_local_hw_addr(br, ea, &hw_addr_iface);
908     local_iface = iface_from_ofp_port(br, OFPP_LOCAL);
909     if (local_iface) {
910         int error = netdev_set_etheraddr(local_iface->netdev, ea);
911         if (error) {
912             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
913             VLOG_ERR_RL(&rl, "bridge %s: failed to set bridge "
914                         "Ethernet address: %s",
915                         br->name, ovs_strerror(error));
916         }
917     }
918     memcpy(br->ea, ea, ETH_ADDR_LEN);
919
920     dpid = bridge_pick_datapath_id(br, ea, hw_addr_iface);
921     if (dpid != ofproto_get_datapath_id(br->ofproto)) {
922         VLOG_INFO("bridge %s: using datapath ID %016"PRIx64, br->name, dpid);
923         ofproto_set_datapath_id(br->ofproto, dpid);
924     }
925
926     dpid_string = xasprintf("%016"PRIx64, dpid);
927     ovsrec_bridge_set_datapath_id(br->cfg, dpid_string);
928     free(dpid_string);
929 }
930
931 /* Returns a bitmap of "enum ofputil_protocol"s that are allowed for use with
932  * 'br'. */
933 static uint32_t
934 bridge_get_allowed_versions(struct bridge *br)
935 {
936     if (!br->cfg->n_protocols)
937         return 0;
938
939     return ofputil_versions_from_strings(br->cfg->protocols,
940                                          br->cfg->n_protocols);
941 }
942
943 /* Set NetFlow configuration on 'br'. */
944 static void
945 bridge_configure_netflow(struct bridge *br)
946 {
947     struct ovsrec_netflow *cfg = br->cfg->netflow;
948     struct netflow_options opts;
949
950     if (!cfg) {
951         ofproto_set_netflow(br->ofproto, NULL);
952         return;
953     }
954
955     memset(&opts, 0, sizeof opts);
956
957     /* Get default NetFlow configuration from datapath.
958      * Apply overrides from 'cfg'. */
959     ofproto_get_netflow_ids(br->ofproto, &opts.engine_type, &opts.engine_id);
960     if (cfg->engine_type) {
961         opts.engine_type = *cfg->engine_type;
962     }
963     if (cfg->engine_id) {
964         opts.engine_id = *cfg->engine_id;
965     }
966
967     /* Configure active timeout interval. */
968     opts.active_timeout = cfg->active_timeout;
969     if (!opts.active_timeout) {
970         opts.active_timeout = -1;
971     } else if (opts.active_timeout < 0) {
972         VLOG_WARN("bridge %s: active timeout interval set to negative "
973                   "value, using default instead (%d seconds)", br->name,
974                   NF_ACTIVE_TIMEOUT_DEFAULT);
975         opts.active_timeout = -1;
976     }
977
978     /* Add engine ID to interface number to disambiguate bridgs? */
979     opts.add_id_to_iface = cfg->add_id_to_interface;
980     if (opts.add_id_to_iface) {
981         if (opts.engine_id > 0x7f) {
982             VLOG_WARN("bridge %s: NetFlow port mangling may conflict with "
983                       "another vswitch, choose an engine id less than 128",
984                       br->name);
985         }
986         if (hmap_count(&br->ports) > 508) {
987             VLOG_WARN("bridge %s: NetFlow port mangling will conflict with "
988                       "another port when more than 508 ports are used",
989                       br->name);
990         }
991     }
992
993     /* Collectors. */
994     sset_init(&opts.collectors);
995     sset_add_array(&opts.collectors, cfg->targets, cfg->n_targets);
996
997     /* Configure. */
998     if (ofproto_set_netflow(br->ofproto, &opts)) {
999         VLOG_ERR("bridge %s: problem setting netflow collectors", br->name);
1000     }
1001     sset_destroy(&opts.collectors);
1002 }
1003
1004 /* Set sFlow configuration on 'br'. */
1005 static void
1006 bridge_configure_sflow(struct bridge *br, int *sflow_bridge_number)
1007 {
1008     const struct ovsrec_sflow *cfg = br->cfg->sflow;
1009     struct ovsrec_controller **controllers;
1010     struct ofproto_sflow_options oso;
1011     size_t n_controllers;
1012     size_t i;
1013
1014     if (!cfg) {
1015         ofproto_set_sflow(br->ofproto, NULL);
1016         return;
1017     }
1018
1019     memset(&oso, 0, sizeof oso);
1020
1021     sset_init(&oso.targets);
1022     sset_add_array(&oso.targets, cfg->targets, cfg->n_targets);
1023
1024     oso.sampling_rate = SFL_DEFAULT_SAMPLING_RATE;
1025     if (cfg->sampling) {
1026         oso.sampling_rate = *cfg->sampling;
1027     }
1028
1029     oso.polling_interval = SFL_DEFAULT_POLLING_INTERVAL;
1030     if (cfg->polling) {
1031         oso.polling_interval = *cfg->polling;
1032     }
1033
1034     oso.header_len = SFL_DEFAULT_HEADER_SIZE;
1035     if (cfg->header) {
1036         oso.header_len = *cfg->header;
1037     }
1038
1039     oso.sub_id = (*sflow_bridge_number)++;
1040     oso.agent_device = cfg->agent;
1041
1042     oso.control_ip = NULL;
1043     n_controllers = bridge_get_controllers(br, &controllers);
1044     for (i = 0; i < n_controllers; i++) {
1045         if (controllers[i]->local_ip) {
1046             oso.control_ip = controllers[i]->local_ip;
1047             break;
1048         }
1049     }
1050     ofproto_set_sflow(br->ofproto, &oso);
1051
1052     sset_destroy(&oso.targets);
1053 }
1054
1055 /* Returns whether a IPFIX row is valid. */
1056 static bool
1057 ovsrec_ipfix_is_valid(const struct ovsrec_ipfix *ipfix)
1058 {
1059     return ipfix && ipfix->n_targets > 0;
1060 }
1061
1062 /* Returns whether a Flow_Sample_Collector_Set row is valid. */
1063 static bool
1064 ovsrec_fscs_is_valid(const struct ovsrec_flow_sample_collector_set *fscs,
1065                      const struct bridge *br)
1066 {
1067     return ovsrec_ipfix_is_valid(fscs->ipfix) && fscs->bridge == br->cfg;
1068 }
1069
1070 /* Set IPFIX configuration on 'br'. */
1071 static void
1072 bridge_configure_ipfix(struct bridge *br)
1073 {
1074     const struct ovsrec_ipfix *be_cfg = br->cfg->ipfix;
1075     bool valid_be_cfg = ovsrec_ipfix_is_valid(be_cfg);
1076     const struct ovsrec_flow_sample_collector_set *fe_cfg;
1077     struct ofproto_ipfix_bridge_exporter_options be_opts;
1078     struct ofproto_ipfix_flow_exporter_options *fe_opts = NULL;
1079     size_t n_fe_opts = 0;
1080
1081     OVSREC_FLOW_SAMPLE_COLLECTOR_SET_FOR_EACH(fe_cfg, idl) {
1082         if (ovsrec_fscs_is_valid(fe_cfg, br)) {
1083             n_fe_opts++;
1084         }
1085     }
1086
1087     if (!valid_be_cfg && n_fe_opts == 0) {
1088         ofproto_set_ipfix(br->ofproto, NULL, NULL, 0);
1089         return;
1090     }
1091
1092     if (valid_be_cfg) {
1093         memset(&be_opts, 0, sizeof be_opts);
1094
1095         sset_init(&be_opts.targets);
1096         sset_add_array(&be_opts.targets, be_cfg->targets, be_cfg->n_targets);
1097
1098         if (be_cfg->sampling) {
1099             be_opts.sampling_rate = *be_cfg->sampling;
1100         } else {
1101             be_opts.sampling_rate = SFL_DEFAULT_SAMPLING_RATE;
1102         }
1103         if (be_cfg->obs_domain_id) {
1104             be_opts.obs_domain_id = *be_cfg->obs_domain_id;
1105         }
1106         if (be_cfg->obs_point_id) {
1107             be_opts.obs_point_id = *be_cfg->obs_point_id;
1108         }
1109         if (be_cfg->cache_active_timeout) {
1110             be_opts.cache_active_timeout = *be_cfg->cache_active_timeout;
1111         }
1112         if (be_cfg->cache_max_flows) {
1113             be_opts.cache_max_flows = *be_cfg->cache_max_flows;
1114         }
1115     }
1116
1117     if (n_fe_opts > 0) {
1118         struct ofproto_ipfix_flow_exporter_options *opts;
1119         fe_opts = xcalloc(n_fe_opts, sizeof *fe_opts);
1120         opts = fe_opts;
1121         OVSREC_FLOW_SAMPLE_COLLECTOR_SET_FOR_EACH(fe_cfg, idl) {
1122             if (ovsrec_fscs_is_valid(fe_cfg, br)) {
1123                 opts->collector_set_id = fe_cfg->id;
1124                 sset_init(&opts->targets);
1125                 sset_add_array(&opts->targets, fe_cfg->ipfix->targets,
1126                                fe_cfg->ipfix->n_targets);
1127                 opts->cache_active_timeout = fe_cfg->ipfix->cache_active_timeout
1128                     ? *fe_cfg->ipfix->cache_active_timeout : 0;
1129                 opts->cache_max_flows = fe_cfg->ipfix->cache_max_flows
1130                     ? *fe_cfg->ipfix->cache_max_flows : 0;
1131                 opts++;
1132             }
1133         }
1134     }
1135
1136     ofproto_set_ipfix(br->ofproto, valid_be_cfg ? &be_opts : NULL, fe_opts,
1137                       n_fe_opts);
1138
1139     if (valid_be_cfg) {
1140         sset_destroy(&be_opts.targets);
1141     }
1142
1143     if (n_fe_opts > 0) {
1144         struct ofproto_ipfix_flow_exporter_options *opts = fe_opts;
1145         size_t i;
1146         for (i = 0; i < n_fe_opts; i++) {
1147             sset_destroy(&opts->targets);
1148             opts++;
1149         }
1150         free(fe_opts);
1151     }
1152 }
1153
1154 static void
1155 port_configure_stp(const struct ofproto *ofproto, struct port *port,
1156                    struct ofproto_port_stp_settings *port_s,
1157                    int *port_num_counter, unsigned long *port_num_bitmap)
1158 {
1159     const char *config_str;
1160     struct iface *iface;
1161
1162     if (!smap_get_bool(&port->cfg->other_config, "stp-enable", true)) {
1163         port_s->enable = false;
1164         return;
1165     } else {
1166         port_s->enable = true;
1167     }
1168
1169     /* STP over bonds is not supported. */
1170     if (!list_is_singleton(&port->ifaces)) {
1171         VLOG_ERR("port %s: cannot enable STP on bonds, disabling",
1172                  port->name);
1173         port_s->enable = false;
1174         return;
1175     }
1176
1177     iface = CONTAINER_OF(list_front(&port->ifaces), struct iface, port_elem);
1178
1179     /* Internal ports shouldn't participate in spanning tree, so
1180      * skip them. */
1181     if (!strcmp(iface->type, "internal")) {
1182         VLOG_DBG("port %s: disable STP on internal ports", port->name);
1183         port_s->enable = false;
1184         return;
1185     }
1186
1187     /* STP on mirror output ports is not supported. */
1188     if (ofproto_is_mirror_output_bundle(ofproto, port)) {
1189         VLOG_DBG("port %s: disable STP on mirror ports", port->name);
1190         port_s->enable = false;
1191         return;
1192     }
1193
1194     config_str = smap_get(&port->cfg->other_config, "stp-port-num");
1195     if (config_str) {
1196         unsigned long int port_num = strtoul(config_str, NULL, 0);
1197         int port_idx = port_num - 1;
1198
1199         if (port_num < 1 || port_num > STP_MAX_PORTS) {
1200             VLOG_ERR("port %s: invalid stp-port-num", port->name);
1201             port_s->enable = false;
1202             return;
1203         }
1204
1205         if (bitmap_is_set(port_num_bitmap, port_idx)) {
1206             VLOG_ERR("port %s: duplicate stp-port-num %lu, disabling",
1207                     port->name, port_num);
1208             port_s->enable = false;
1209             return;
1210         }
1211         bitmap_set1(port_num_bitmap, port_idx);
1212         port_s->port_num = port_idx;
1213     } else {
1214         if (*port_num_counter >= STP_MAX_PORTS) {
1215             VLOG_ERR("port %s: too many STP ports, disabling", port->name);
1216             port_s->enable = false;
1217             return;
1218         }
1219
1220         port_s->port_num = (*port_num_counter)++;
1221     }
1222
1223     config_str = smap_get(&port->cfg->other_config, "stp-path-cost");
1224     if (config_str) {
1225         port_s->path_cost = strtoul(config_str, NULL, 10);
1226     } else {
1227         enum netdev_features current;
1228         unsigned int mbps;
1229
1230         netdev_get_features(iface->netdev, &current, NULL, NULL, NULL);
1231         mbps = netdev_features_to_bps(current, 100 * 1000 * 1000) / 1000000;
1232         port_s->path_cost = stp_convert_speed_to_cost(mbps);
1233     }
1234
1235     config_str = smap_get(&port->cfg->other_config, "stp-port-priority");
1236     if (config_str) {
1237         port_s->priority = strtoul(config_str, NULL, 0);
1238     } else {
1239         port_s->priority = STP_DEFAULT_PORT_PRIORITY;
1240     }
1241 }
1242
1243 /* Set spanning tree configuration on 'br'. */
1244 static void
1245 bridge_configure_stp(struct bridge *br)
1246 {
1247     if (!br->cfg->stp_enable) {
1248         ofproto_set_stp(br->ofproto, NULL);
1249     } else {
1250         struct ofproto_stp_settings br_s;
1251         const char *config_str;
1252         struct port *port;
1253         int port_num_counter;
1254         unsigned long *port_num_bitmap;
1255
1256         config_str = smap_get(&br->cfg->other_config, "stp-system-id");
1257         if (config_str) {
1258             uint8_t ea[ETH_ADDR_LEN];
1259
1260             if (eth_addr_from_string(config_str, ea)) {
1261                 br_s.system_id = eth_addr_to_uint64(ea);
1262             } else {
1263                 br_s.system_id = eth_addr_to_uint64(br->ea);
1264                 VLOG_ERR("bridge %s: invalid stp-system-id, defaulting "
1265                          "to "ETH_ADDR_FMT, br->name, ETH_ADDR_ARGS(br->ea));
1266             }
1267         } else {
1268             br_s.system_id = eth_addr_to_uint64(br->ea);
1269         }
1270
1271         config_str = smap_get(&br->cfg->other_config, "stp-priority");
1272         if (config_str) {
1273             br_s.priority = strtoul(config_str, NULL, 0);
1274         } else {
1275             br_s.priority = STP_DEFAULT_BRIDGE_PRIORITY;
1276         }
1277
1278         config_str = smap_get(&br->cfg->other_config, "stp-hello-time");
1279         if (config_str) {
1280             br_s.hello_time = strtoul(config_str, NULL, 10) * 1000;
1281         } else {
1282             br_s.hello_time = STP_DEFAULT_HELLO_TIME;
1283         }
1284
1285         config_str = smap_get(&br->cfg->other_config, "stp-max-age");
1286         if (config_str) {
1287             br_s.max_age = strtoul(config_str, NULL, 10) * 1000;
1288         } else {
1289             br_s.max_age = STP_DEFAULT_MAX_AGE;
1290         }
1291
1292         config_str = smap_get(&br->cfg->other_config, "stp-forward-delay");
1293         if (config_str) {
1294             br_s.fwd_delay = strtoul(config_str, NULL, 10) * 1000;
1295         } else {
1296             br_s.fwd_delay = STP_DEFAULT_FWD_DELAY;
1297         }
1298
1299         /* Configure STP on the bridge. */
1300         if (ofproto_set_stp(br->ofproto, &br_s)) {
1301             VLOG_ERR("bridge %s: could not enable STP", br->name);
1302             return;
1303         }
1304
1305         /* Users must either set the port number with the "stp-port-num"
1306          * configuration on all ports or none.  If manual configuration
1307          * is not done, then we allocate them sequentially. */
1308         port_num_counter = 0;
1309         port_num_bitmap = bitmap_allocate(STP_MAX_PORTS);
1310         HMAP_FOR_EACH (port, hmap_node, &br->ports) {
1311             struct ofproto_port_stp_settings port_s;
1312             struct iface *iface;
1313
1314             port_configure_stp(br->ofproto, port, &port_s,
1315                                &port_num_counter, port_num_bitmap);
1316
1317             /* As bonds are not supported, just apply configuration to
1318              * all interfaces. */
1319             LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
1320                 if (ofproto_port_set_stp(br->ofproto, iface->ofp_port,
1321                                          &port_s)) {
1322                     VLOG_ERR("port %s: could not enable STP", port->name);
1323                     continue;
1324                 }
1325             }
1326         }
1327
1328         if (bitmap_scan(port_num_bitmap, 0, STP_MAX_PORTS) != STP_MAX_PORTS
1329                     && port_num_counter) {
1330             VLOG_ERR("bridge %s: must manually configure all STP port "
1331                      "IDs or none, disabling", br->name);
1332             ofproto_set_stp(br->ofproto, NULL);
1333         }
1334         bitmap_free(port_num_bitmap);
1335     }
1336 }
1337
1338 static bool
1339 bridge_has_bond_fake_iface(const struct bridge *br, const char *name)
1340 {
1341     const struct port *port = port_lookup(br, name);
1342     return port && port_is_bond_fake_iface(port);
1343 }
1344
1345 static bool
1346 port_is_bond_fake_iface(const struct port *port)
1347 {
1348     return port->cfg->bond_fake_iface && !list_is_short(&port->ifaces);
1349 }
1350
1351 static void
1352 add_del_bridges(const struct ovsrec_open_vswitch *cfg)
1353 {
1354     struct bridge *br, *next;
1355     struct shash new_br;
1356     size_t i;
1357
1358     /* Collect new bridges' names and types. */
1359     shash_init(&new_br);
1360     for (i = 0; i < cfg->n_bridges; i++) {
1361         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1362         const struct ovsrec_bridge *br_cfg = cfg->bridges[i];
1363
1364         if (strchr(br_cfg->name, '/')) {
1365             /* Prevent remote ovsdb-server users from accessing arbitrary
1366              * directories, e.g. consider a bridge named "../../../etc/". */
1367             VLOG_WARN_RL(&rl, "ignoring bridge with invalid name \"%s\"",
1368                          br_cfg->name);
1369         } else if (!shash_add_once(&new_br, br_cfg->name, br_cfg)) {
1370             VLOG_WARN_RL(&rl, "bridge %s specified twice", br_cfg->name);
1371         }
1372     }
1373
1374     /* Get rid of deleted bridges or those whose types have changed.
1375      * Update 'cfg' of bridges that still exist. */
1376     HMAP_FOR_EACH_SAFE (br, next, node, &all_bridges) {
1377         br->cfg = shash_find_data(&new_br, br->name);
1378         if (!br->cfg || strcmp(br->type, ofproto_normalize_type(
1379                                    br->cfg->datapath_type))) {
1380             bridge_destroy(br);
1381         }
1382     }
1383
1384     /* Add new bridges. */
1385     for (i = 0; i < cfg->n_bridges; i++) {
1386         const struct ovsrec_bridge *br_cfg = cfg->bridges[i];
1387         struct bridge *br = bridge_lookup(br_cfg->name);
1388         if (!br) {
1389             bridge_create(br_cfg);
1390         }
1391     }
1392
1393     shash_destroy(&new_br);
1394 }
1395
1396 /* Configures 'netdev' based on the "options" column in 'iface_cfg'.
1397  * Returns 0 if successful, otherwise a positive errno value. */
1398 static int
1399 iface_set_netdev_config(const struct ovsrec_interface *iface_cfg,
1400                         struct netdev *netdev)
1401 {
1402     return netdev_set_config(netdev, &iface_cfg->options);
1403 }
1404
1405 /* Opens a network device for 'if_cfg' and configures it.  Adds the network
1406  * device to br->ofproto and stores the OpenFlow port number in '*ofp_portp'.
1407  *
1408  * If successful, returns 0 and stores the network device in '*netdevp'.  On
1409  * failure, returns a positive errno value and stores NULL in '*netdevp'. */
1410 static int
1411 iface_do_create(const struct bridge *br,
1412                 const struct ovsrec_interface *iface_cfg,
1413                 const struct ovsrec_port *port_cfg,
1414                 ofp_port_t *ofp_portp, struct netdev **netdevp)
1415 {
1416     struct netdev *netdev = NULL;
1417     int error;
1418
1419     if (netdev_is_reserved_name(iface_cfg->name)) {
1420         VLOG_WARN("could not create interface %s, name is reserved",
1421                   iface_cfg->name);
1422         error = EINVAL;
1423         goto error;
1424     }
1425
1426     error = netdev_open(iface_cfg->name,
1427                         iface_get_type(iface_cfg, br->cfg), &netdev);
1428     if (error) {
1429         VLOG_WARN("could not open network device %s (%s)",
1430                   iface_cfg->name, ovs_strerror(error));
1431         goto error;
1432     }
1433
1434     error = iface_set_netdev_config(iface_cfg, netdev);
1435     if (error) {
1436         goto error;
1437     }
1438
1439     *ofp_portp = iface_pick_ofport(iface_cfg);
1440     error = ofproto_port_add(br->ofproto, netdev, ofp_portp);
1441     if (error) {
1442         goto error;
1443     }
1444
1445     VLOG_INFO("bridge %s: added interface %s on port %d",
1446               br->name, iface_cfg->name, *ofp_portp);
1447
1448     if ((port_cfg->vlan_mode && !strcmp(port_cfg->vlan_mode, "splinter"))
1449         || iface_is_internal(iface_cfg, br->cfg)) {
1450         netdev_turn_flags_on(netdev, NETDEV_UP, NULL);
1451     }
1452
1453     *netdevp = netdev;
1454     return 0;
1455
1456 error:
1457     *netdevp = NULL;
1458     netdev_close(netdev);
1459     return error;
1460 }
1461
1462 /* Creates a new iface on 'br' based on 'if_cfg'.  The new iface has OpenFlow
1463  * port number 'ofp_port'.  If ofp_port is OFPP_NONE, an OpenFlow port is
1464  * automatically allocated for the iface.  Takes ownership of and
1465  * deallocates 'if_cfg'.
1466  *
1467  * Return true if an iface is successfully created, false otherwise. */
1468 static bool
1469 iface_create(struct bridge *br, const struct ovsrec_interface *iface_cfg,
1470              const struct ovsrec_port *port_cfg)
1471 {
1472     struct netdev *netdev;
1473     struct iface *iface;
1474     ofp_port_t ofp_port;
1475     struct port *port;
1476     int error;
1477
1478     /* Do the bits that can fail up front. */
1479     ovs_assert(!iface_lookup(br, iface_cfg->name));
1480     error = iface_do_create(br, iface_cfg, port_cfg, &ofp_port, &netdev);
1481     if (error) {
1482         iface_set_ofport(iface_cfg, OFPP_NONE);
1483         iface_clear_db_record(iface_cfg);
1484         return false;
1485     }
1486
1487     /* Get or create the port structure. */
1488     port = port_lookup(br, port_cfg->name);
1489     if (!port) {
1490         port = port_create(br, port_cfg);
1491     }
1492
1493     /* Create the iface structure. */
1494     iface = xzalloc(sizeof *iface);
1495     list_push_back(&port->ifaces, &iface->port_elem);
1496     hmap_insert(&br->iface_by_name, &iface->name_node,
1497                 hash_string(iface_cfg->name, 0));
1498     iface->port = port;
1499     iface->name = xstrdup(iface_cfg->name);
1500     iface->ofp_port = ofp_port;
1501     iface->netdev = netdev;
1502     iface->type = iface_get_type(iface_cfg, br->cfg);
1503     iface->cfg = iface_cfg;
1504     hmap_insert(&br->ifaces, &iface->ofp_port_node,
1505                 hash_ofp_port(ofp_port));
1506
1507     iface_set_ofport(iface->cfg, ofp_port);
1508
1509     /* Populate initial status in database. */
1510     iface_refresh_stats(iface);
1511     iface_refresh_status(iface);
1512
1513     /* Add bond fake iface if necessary. */
1514     if (port_is_bond_fake_iface(port)) {
1515         struct ofproto_port ofproto_port;
1516
1517         if (ofproto_port_query_by_name(br->ofproto, port->name,
1518                                        &ofproto_port)) {
1519             struct netdev *netdev;
1520             int error;
1521
1522             error = netdev_open(port->name, "internal", &netdev);
1523             if (!error) {
1524                 ofp_port_t fake_ofp_port = OFPP_NONE;
1525                 ofproto_port_add(br->ofproto, netdev, &fake_ofp_port);
1526                 netdev_close(netdev);
1527             } else {
1528                 VLOG_WARN("could not open network device %s (%s)",
1529                           port->name, ovs_strerror(error));
1530             }
1531         } else {
1532             /* Already exists, nothing to do. */
1533             ofproto_port_destroy(&ofproto_port);
1534         }
1535     }
1536
1537     return true;
1538 }
1539
1540 /* Set forward BPDU option. */
1541 static void
1542 bridge_configure_forward_bpdu(struct bridge *br)
1543 {
1544     ofproto_set_forward_bpdu(br->ofproto,
1545                              smap_get_bool(&br->cfg->other_config,
1546                                            "forward-bpdu",
1547                                            false));
1548 }
1549
1550 /* Set MAC learning table configuration for 'br'. */
1551 static void
1552 bridge_configure_mac_table(struct bridge *br)
1553 {
1554     const char *idle_time_str;
1555     int idle_time;
1556
1557     const char *mac_table_size_str;
1558     int mac_table_size;
1559
1560     idle_time_str = smap_get(&br->cfg->other_config, "mac-aging-time");
1561     idle_time = (idle_time_str && atoi(idle_time_str)
1562                  ? atoi(idle_time_str)
1563                  : MAC_ENTRY_DEFAULT_IDLE_TIME);
1564
1565     mac_table_size_str = smap_get(&br->cfg->other_config, "mac-table-size");
1566     mac_table_size = (mac_table_size_str && atoi(mac_table_size_str)
1567                       ? atoi(mac_table_size_str)
1568                       : MAC_DEFAULT_MAX);
1569
1570     ofproto_set_mac_table_config(br->ofproto, idle_time, mac_table_size);
1571 }
1572
1573 static void
1574 bridge_pick_local_hw_addr(struct bridge *br, uint8_t ea[ETH_ADDR_LEN],
1575                           struct iface **hw_addr_iface)
1576 {
1577     struct hmapx mirror_output_ports;
1578     const char *hwaddr;
1579     struct port *port;
1580     bool found_addr = false;
1581     int error;
1582     int i;
1583
1584     *hw_addr_iface = NULL;
1585
1586     /* Did the user request a particular MAC? */
1587     hwaddr = smap_get(&br->cfg->other_config, "hwaddr");
1588     if (hwaddr && eth_addr_from_string(hwaddr, ea)) {
1589         if (eth_addr_is_multicast(ea)) {
1590             VLOG_ERR("bridge %s: cannot set MAC address to multicast "
1591                      "address "ETH_ADDR_FMT, br->name, ETH_ADDR_ARGS(ea));
1592         } else if (eth_addr_is_zero(ea)) {
1593             VLOG_ERR("bridge %s: cannot set MAC address to zero", br->name);
1594         } else {
1595             return;
1596         }
1597     }
1598
1599     /* Mirror output ports don't participate in picking the local hardware
1600      * address.  ofproto can't help us find out whether a given port is a
1601      * mirror output because we haven't configured mirrors yet, so we need to
1602      * accumulate them ourselves. */
1603     hmapx_init(&mirror_output_ports);
1604     for (i = 0; i < br->cfg->n_mirrors; i++) {
1605         struct ovsrec_mirror *m = br->cfg->mirrors[i];
1606         if (m->output_port) {
1607             hmapx_add(&mirror_output_ports, m->output_port);
1608         }
1609     }
1610
1611     /* Otherwise choose the minimum non-local MAC address among all of the
1612      * interfaces. */
1613     HMAP_FOR_EACH (port, hmap_node, &br->ports) {
1614         uint8_t iface_ea[ETH_ADDR_LEN];
1615         struct iface *candidate;
1616         struct iface *iface;
1617
1618         /* Mirror output ports don't participate. */
1619         if (hmapx_contains(&mirror_output_ports, port->cfg)) {
1620             continue;
1621         }
1622
1623         /* Choose the MAC address to represent the port. */
1624         iface = NULL;
1625         if (port->cfg->mac && eth_addr_from_string(port->cfg->mac, iface_ea)) {
1626             /* Find the interface with this Ethernet address (if any) so that
1627              * we can provide the correct devname to the caller. */
1628             LIST_FOR_EACH (candidate, port_elem, &port->ifaces) {
1629                 uint8_t candidate_ea[ETH_ADDR_LEN];
1630                 if (!netdev_get_etheraddr(candidate->netdev, candidate_ea)
1631                     && eth_addr_equals(iface_ea, candidate_ea)) {
1632                     iface = candidate;
1633                 }
1634             }
1635         } else {
1636             /* Choose the interface whose MAC address will represent the port.
1637              * The Linux kernel bonding code always chooses the MAC address of
1638              * the first slave added to a bond, and the Fedora networking
1639              * scripts always add slaves to a bond in alphabetical order, so
1640              * for compatibility we choose the interface with the name that is
1641              * first in alphabetical order. */
1642             LIST_FOR_EACH (candidate, port_elem, &port->ifaces) {
1643                 if (!iface || strcmp(candidate->name, iface->name) < 0) {
1644                     iface = candidate;
1645                 }
1646             }
1647
1648             /* The local port doesn't count (since we're trying to choose its
1649              * MAC address anyway). */
1650             if (iface->ofp_port == OFPP_LOCAL) {
1651                 continue;
1652             }
1653
1654             /* Grab MAC. */
1655             error = netdev_get_etheraddr(iface->netdev, iface_ea);
1656             if (error) {
1657                 continue;
1658             }
1659         }
1660
1661         /* Compare against our current choice. */
1662         if (!eth_addr_is_multicast(iface_ea) &&
1663             !eth_addr_is_local(iface_ea) &&
1664             !eth_addr_is_reserved(iface_ea) &&
1665             !eth_addr_is_zero(iface_ea) &&
1666             (!found_addr || eth_addr_compare_3way(iface_ea, ea) < 0))
1667         {
1668             memcpy(ea, iface_ea, ETH_ADDR_LEN);
1669             *hw_addr_iface = iface;
1670             found_addr = true;
1671         }
1672     }
1673
1674     if (!found_addr) {
1675         memcpy(ea, br->default_ea, ETH_ADDR_LEN);
1676         *hw_addr_iface = NULL;
1677     }
1678
1679     hmapx_destroy(&mirror_output_ports);
1680 }
1681
1682 /* Choose and returns the datapath ID for bridge 'br' given that the bridge
1683  * Ethernet address is 'bridge_ea'.  If 'bridge_ea' is the Ethernet address of
1684  * an interface on 'br', then that interface must be passed in as
1685  * 'hw_addr_iface'; if 'bridge_ea' was derived some other way, then
1686  * 'hw_addr_iface' must be passed in as a null pointer. */
1687 static uint64_t
1688 bridge_pick_datapath_id(struct bridge *br,
1689                         const uint8_t bridge_ea[ETH_ADDR_LEN],
1690                         struct iface *hw_addr_iface)
1691 {
1692     /*
1693      * The procedure for choosing a bridge MAC address will, in the most
1694      * ordinary case, also choose a unique MAC that we can use as a datapath
1695      * ID.  In some special cases, though, multiple bridges will end up with
1696      * the same MAC address.  This is OK for the bridges, but it will confuse
1697      * the OpenFlow controller, because each datapath needs a unique datapath
1698      * ID.
1699      *
1700      * Datapath IDs must be unique.  It is also very desirable that they be
1701      * stable from one run to the next, so that policy set on a datapath
1702      * "sticks".
1703      */
1704     const char *datapath_id;
1705     uint64_t dpid;
1706
1707     datapath_id = smap_get(&br->cfg->other_config, "datapath-id");
1708     if (datapath_id && dpid_from_string(datapath_id, &dpid)) {
1709         return dpid;
1710     }
1711
1712     if (!hw_addr_iface) {
1713         /*
1714          * A purely internal bridge, that is, one that has no non-virtual
1715          * network devices on it at all, is difficult because it has no
1716          * natural unique identifier at all.
1717          *
1718          * When the host is a XenServer, we handle this case by hashing the
1719          * host's UUID with the name of the bridge.  Names of bridges are
1720          * persistent across XenServer reboots, although they can be reused if
1721          * an internal network is destroyed and then a new one is later
1722          * created, so this is fairly effective.
1723          *
1724          * When the host is not a XenServer, we punt by using a random MAC
1725          * address on each run.
1726          */
1727         const char *host_uuid = xenserver_get_host_uuid();
1728         if (host_uuid) {
1729             char *combined = xasprintf("%s,%s", host_uuid, br->name);
1730             dpid = dpid_from_hash(combined, strlen(combined));
1731             free(combined);
1732             return dpid;
1733         }
1734     }
1735
1736     return eth_addr_to_uint64(bridge_ea);
1737 }
1738
1739 static uint64_t
1740 dpid_from_hash(const void *data, size_t n)
1741 {
1742     uint8_t hash[SHA1_DIGEST_SIZE];
1743
1744     BUILD_ASSERT_DECL(sizeof hash >= ETH_ADDR_LEN);
1745     sha1_bytes(data, n, hash);
1746     eth_addr_mark_random(hash);
1747     return eth_addr_to_uint64(hash);
1748 }
1749
1750 static void
1751 iface_refresh_status(struct iface *iface)
1752 {
1753     struct smap smap;
1754
1755     enum netdev_features current;
1756     int64_t bps;
1757     int mtu;
1758     int64_t mtu_64;
1759     uint8_t mac[ETH_ADDR_LEN];
1760     int64_t ifindex64;
1761     int error;
1762
1763     if (iface_is_synthetic(iface)) {
1764         return;
1765     }
1766
1767     smap_init(&smap);
1768
1769     if (!netdev_get_status(iface->netdev, &smap)) {
1770         ovsrec_interface_set_status(iface->cfg, &smap);
1771     } else {
1772         ovsrec_interface_set_status(iface->cfg, NULL);
1773     }
1774
1775     smap_destroy(&smap);
1776
1777     error = netdev_get_features(iface->netdev, &current, NULL, NULL, NULL);
1778     bps = !error ? netdev_features_to_bps(current, 0) : 0;
1779     if (bps) {
1780         ovsrec_interface_set_duplex(iface->cfg,
1781                                     netdev_features_is_full_duplex(current)
1782                                     ? "full" : "half");
1783         ovsrec_interface_set_link_speed(iface->cfg, &bps, 1);
1784     } else {
1785         ovsrec_interface_set_duplex(iface->cfg, NULL);
1786         ovsrec_interface_set_link_speed(iface->cfg, NULL, 0);
1787     }
1788
1789     error = netdev_get_mtu(iface->netdev, &mtu);
1790     if (!error) {
1791         mtu_64 = mtu;
1792         ovsrec_interface_set_mtu(iface->cfg, &mtu_64, 1);
1793     } else {
1794         ovsrec_interface_set_mtu(iface->cfg, NULL, 0);
1795     }
1796
1797     error = netdev_get_etheraddr(iface->netdev, mac);
1798     if (!error) {
1799         char mac_string[32];
1800
1801         sprintf(mac_string, ETH_ADDR_FMT, ETH_ADDR_ARGS(mac));
1802         ovsrec_interface_set_mac_in_use(iface->cfg, mac_string);
1803     } else {
1804         ovsrec_interface_set_mac_in_use(iface->cfg, NULL);
1805     }
1806
1807     /* The netdev may return a negative number (such as -EOPNOTSUPP)
1808      * if there is no valid ifindex number. */
1809     ifindex64 = netdev_get_ifindex(iface->netdev);
1810     if (ifindex64 < 0) {
1811         ifindex64 = 0;
1812     }
1813     ovsrec_interface_set_ifindex(iface->cfg, &ifindex64, 1);
1814 }
1815
1816 /* Writes 'iface''s CFM statistics to the database. 'iface' must not be
1817  * synthetic. */
1818 static void
1819 iface_refresh_cfm_stats(struct iface *iface)
1820 {
1821     const struct ovsrec_interface *cfg = iface->cfg;
1822     struct ofproto_cfm_status status;
1823
1824     if (!ofproto_port_get_cfm_status(iface->port->bridge->ofproto,
1825                                     iface->ofp_port, &status)) {
1826         ovsrec_interface_set_cfm_fault(cfg, NULL, 0);
1827         ovsrec_interface_set_cfm_fault_status(cfg, NULL, 0);
1828         ovsrec_interface_set_cfm_remote_opstate(cfg, NULL);
1829         ovsrec_interface_set_cfm_flap_count(cfg, NULL, 0);
1830         ovsrec_interface_set_cfm_health(cfg, NULL, 0);
1831         ovsrec_interface_set_cfm_remote_mpids(cfg, NULL, 0);
1832     } else {
1833         const char *reasons[CFM_FAULT_N_REASONS];
1834         int64_t cfm_health = status.health;
1835         int64_t cfm_flap_count = status.flap_count;
1836         bool faulted = status.faults != 0;
1837         size_t i, j;
1838
1839         ovsrec_interface_set_cfm_fault(cfg, &faulted, 1);
1840
1841         j = 0;
1842         for (i = 0; i < CFM_FAULT_N_REASONS; i++) {
1843             int reason = 1 << i;
1844             if (status.faults & reason) {
1845                 reasons[j++] = cfm_fault_reason_to_str(reason);
1846             }
1847         }
1848         ovsrec_interface_set_cfm_fault_status(cfg, (char **) reasons, j);
1849
1850         ovsrec_interface_set_cfm_flap_count(cfg, &cfm_flap_count, 1);
1851
1852         if (status.remote_opstate >= 0) {
1853             const char *remote_opstate = status.remote_opstate ? "up" : "down";
1854             ovsrec_interface_set_cfm_remote_opstate(cfg, remote_opstate);
1855         } else {
1856             ovsrec_interface_set_cfm_remote_opstate(cfg, NULL);
1857         }
1858
1859         ovsrec_interface_set_cfm_remote_mpids(cfg,
1860                                               (const int64_t *)status.rmps,
1861                                               status.n_rmps);
1862         if (cfm_health >= 0) {
1863             ovsrec_interface_set_cfm_health(cfg, &cfm_health, 1);
1864         } else {
1865             ovsrec_interface_set_cfm_health(cfg, NULL, 0);
1866         }
1867
1868         free(status.rmps);
1869     }
1870 }
1871
1872 static void
1873 iface_refresh_stats(struct iface *iface)
1874 {
1875 #define IFACE_STATS                             \
1876     IFACE_STAT(rx_packets,      "rx_packets")   \
1877     IFACE_STAT(tx_packets,      "tx_packets")   \
1878     IFACE_STAT(rx_bytes,        "rx_bytes")     \
1879     IFACE_STAT(tx_bytes,        "tx_bytes")     \
1880     IFACE_STAT(rx_dropped,      "rx_dropped")   \
1881     IFACE_STAT(tx_dropped,      "tx_dropped")   \
1882     IFACE_STAT(rx_errors,       "rx_errors")    \
1883     IFACE_STAT(tx_errors,       "tx_errors")    \
1884     IFACE_STAT(rx_frame_errors, "rx_frame_err") \
1885     IFACE_STAT(rx_over_errors,  "rx_over_err")  \
1886     IFACE_STAT(rx_crc_errors,   "rx_crc_err")   \
1887     IFACE_STAT(collisions,      "collisions")
1888
1889 #define IFACE_STAT(MEMBER, NAME) + 1
1890     enum { N_IFACE_STATS = IFACE_STATS };
1891 #undef IFACE_STAT
1892     int64_t values[N_IFACE_STATS];
1893     char *keys[N_IFACE_STATS];
1894     int n;
1895
1896     struct netdev_stats stats;
1897
1898     if (iface_is_synthetic(iface)) {
1899         return;
1900     }
1901
1902     /* Intentionally ignore return value, since errors will set 'stats' to
1903      * all-1s, and we will deal with that correctly below. */
1904     netdev_get_stats(iface->netdev, &stats);
1905
1906     /* Copy statistics into keys[] and values[]. */
1907     n = 0;
1908 #define IFACE_STAT(MEMBER, NAME)                \
1909     if (stats.MEMBER != UINT64_MAX) {           \
1910         keys[n] = NAME;                         \
1911         values[n] = stats.MEMBER;               \
1912         n++;                                    \
1913     }
1914     IFACE_STATS;
1915 #undef IFACE_STAT
1916     ovs_assert(n <= N_IFACE_STATS);
1917
1918     ovsrec_interface_set_statistics(iface->cfg, keys, values, n);
1919 #undef IFACE_STATS
1920 }
1921
1922 static void
1923 br_refresh_stp_status(struct bridge *br)
1924 {
1925     struct smap smap = SMAP_INITIALIZER(&smap);
1926     struct ofproto *ofproto = br->ofproto;
1927     struct ofproto_stp_status status;
1928
1929     if (ofproto_get_stp_status(ofproto, &status)) {
1930         return;
1931     }
1932
1933     if (!status.enabled) {
1934         ovsrec_bridge_set_status(br->cfg, NULL);
1935         return;
1936     }
1937
1938     smap_add_format(&smap, "stp_bridge_id", STP_ID_FMT,
1939                     STP_ID_ARGS(status.bridge_id));
1940     smap_add_format(&smap, "stp_designated_root", STP_ID_FMT,
1941                     STP_ID_ARGS(status.designated_root));
1942     smap_add_format(&smap, "stp_root_path_cost", "%d", status.root_path_cost);
1943
1944     ovsrec_bridge_set_status(br->cfg, &smap);
1945     smap_destroy(&smap);
1946 }
1947
1948 static void
1949 port_refresh_stp_status(struct port *port)
1950 {
1951     struct ofproto *ofproto = port->bridge->ofproto;
1952     struct iface *iface;
1953     struct ofproto_port_stp_status status;
1954     struct smap smap;
1955
1956     if (port_is_synthetic(port)) {
1957         return;
1958     }
1959
1960     /* STP doesn't currently support bonds. */
1961     if (!list_is_singleton(&port->ifaces)) {
1962         ovsrec_port_set_status(port->cfg, NULL);
1963         return;
1964     }
1965
1966     iface = CONTAINER_OF(list_front(&port->ifaces), struct iface, port_elem);
1967     if (ofproto_port_get_stp_status(ofproto, iface->ofp_port, &status)) {
1968         return;
1969     }
1970
1971     if (!status.enabled) {
1972         ovsrec_port_set_status(port->cfg, NULL);
1973         return;
1974     }
1975
1976     /* Set Status column. */
1977     smap_init(&smap);
1978     smap_add_format(&smap, "stp_port_id", STP_PORT_ID_FMT, status.port_id);
1979     smap_add(&smap, "stp_state", stp_state_name(status.state));
1980     smap_add_format(&smap, "stp_sec_in_state", "%u", status.sec_in_state);
1981     smap_add(&smap, "stp_role", stp_role_name(status.role));
1982     ovsrec_port_set_status(port->cfg, &smap);
1983     smap_destroy(&smap);
1984 }
1985
1986 static void
1987 port_refresh_stp_stats(struct port *port)
1988 {
1989     struct ofproto *ofproto = port->bridge->ofproto;
1990     struct iface *iface;
1991     struct ofproto_port_stp_stats stats;
1992     char *keys[3];
1993     int64_t int_values[3];
1994
1995     if (port_is_synthetic(port)) {
1996         return;
1997     }
1998
1999     /* STP doesn't currently support bonds. */
2000     if (!list_is_singleton(&port->ifaces)) {
2001         return;
2002     }
2003
2004     iface = CONTAINER_OF(list_front(&port->ifaces), struct iface, port_elem);
2005     if (ofproto_port_get_stp_stats(ofproto, iface->ofp_port, &stats)) {
2006         return;
2007     }
2008
2009     if (!stats.enabled) {
2010         ovsrec_port_set_statistics(port->cfg, NULL, NULL, 0);
2011         return;
2012     }
2013
2014     /* Set Statistics column. */
2015     keys[0] = "stp_tx_count";
2016     int_values[0] = stats.tx_count;
2017     keys[1] = "stp_rx_count";
2018     int_values[1] = stats.rx_count;
2019     keys[2] = "stp_error_count";
2020     int_values[2] = stats.error_count;
2021
2022     ovsrec_port_set_statistics(port->cfg, keys, int_values,
2023                                ARRAY_SIZE(int_values));
2024 }
2025
2026 static bool
2027 enable_system_stats(const struct ovsrec_open_vswitch *cfg)
2028 {
2029     return smap_get_bool(&cfg->other_config, "enable-statistics", false);
2030 }
2031
2032 static void
2033 reconfigure_system_stats(const struct ovsrec_open_vswitch *cfg)
2034 {
2035     bool enable = enable_system_stats(cfg);
2036
2037     system_stats_enable(enable);
2038     if (!enable) {
2039         ovsrec_open_vswitch_set_statistics(cfg, NULL);
2040     }
2041 }
2042
2043 static void
2044 run_system_stats(void)
2045 {
2046     const struct ovsrec_open_vswitch *cfg = ovsrec_open_vswitch_first(idl);
2047     struct smap *stats;
2048
2049     stats = system_stats_run();
2050     if (stats && cfg) {
2051         struct ovsdb_idl_txn *txn;
2052         struct ovsdb_datum datum;
2053
2054         txn = ovsdb_idl_txn_create(idl);
2055         ovsdb_datum_from_smap(&datum, stats);
2056         ovsdb_idl_txn_write(&cfg->header_, &ovsrec_open_vswitch_col_statistics,
2057                             &datum);
2058         ovsdb_idl_txn_commit(txn);
2059         ovsdb_idl_txn_destroy(txn);
2060
2061         free(stats);
2062     }
2063 }
2064
2065 static const char *
2066 ofp12_controller_role_to_str(enum ofp12_controller_role role)
2067 {
2068     switch (role) {
2069     case OFPCR12_ROLE_EQUAL:
2070         return "other";
2071     case OFPCR12_ROLE_MASTER:
2072         return "master";
2073     case OFPCR12_ROLE_SLAVE:
2074         return "slave";
2075     case OFPCR12_ROLE_NOCHANGE:
2076     default:
2077         return "*** INVALID ROLE ***";
2078     }
2079 }
2080
2081 static void
2082 refresh_controller_status(void)
2083 {
2084     struct bridge *br;
2085     struct shash info;
2086     const struct ovsrec_controller *cfg;
2087
2088     shash_init(&info);
2089
2090     /* Accumulate status for controllers on all bridges. */
2091     HMAP_FOR_EACH (br, node, &all_bridges) {
2092         ofproto_get_ofproto_controller_info(br->ofproto, &info);
2093     }
2094
2095     /* Update each controller in the database with current status. */
2096     OVSREC_CONTROLLER_FOR_EACH(cfg, idl) {
2097         struct ofproto_controller_info *cinfo =
2098             shash_find_data(&info, cfg->target);
2099
2100         if (cinfo) {
2101             struct smap smap = SMAP_INITIALIZER(&smap);
2102             const char **values = cinfo->pairs.values;
2103             const char **keys = cinfo->pairs.keys;
2104             size_t i;
2105
2106             for (i = 0; i < cinfo->pairs.n; i++) {
2107                 smap_add(&smap, keys[i], values[i]);
2108             }
2109
2110             ovsrec_controller_set_is_connected(cfg, cinfo->is_connected);
2111             ovsrec_controller_set_role(cfg, ofp12_controller_role_to_str(
2112                                            cinfo->role));
2113             ovsrec_controller_set_status(cfg, &smap);
2114             smap_destroy(&smap);
2115         } else {
2116             ovsrec_controller_set_is_connected(cfg, false);
2117             ovsrec_controller_set_role(cfg, NULL);
2118             ovsrec_controller_set_status(cfg, NULL);
2119         }
2120     }
2121
2122     ofproto_free_ofproto_controller_info(&info);
2123 }
2124 \f
2125 /* "Instant" stats.
2126  *
2127  * Some information in the database must be kept as up-to-date as possible to
2128  * allow controllers to respond rapidly to network outages.  We call these
2129  * statistics "instant" stats.
2130  *
2131  * We wish to update these statistics every INSTANT_INTERVAL_MSEC milliseconds,
2132  * assuming that they've changed.  The only means we have to determine whether
2133  * they have changed are:
2134  *
2135  *   - Try to commit changes to the database.  If nothing changed, then
2136  *     ovsdb_idl_txn_commit() returns TXN_UNCHANGED, otherwise some other
2137  *     value.
2138  *
2139  *   - instant_stats_run() is called late in the run loop, after anything that
2140  *     might change any of the instant stats.
2141  *
2142  * We use these two facts together to avoid waking the process up every
2143  * INSTANT_INTERVAL_MSEC whether there is any change or not.
2144  */
2145
2146 /* Minimum interval between writing updates to the instant stats to the
2147  * database. */
2148 #define INSTANT_INTERVAL_MSEC 100
2149
2150 /* Current instant stats database transaction, NULL if there is no ongoing
2151  * transaction. */
2152 static struct ovsdb_idl_txn *instant_txn;
2153
2154 /* Next time (in msec on monotonic clock) at which we will update the instant
2155  * stats.  */
2156 static long long int instant_next_txn = LLONG_MIN;
2157
2158 /* True if the run loop has run since we last saw that the instant stats were
2159  * unchanged, that is, this is true if we need to wake up at 'instant_next_txn'
2160  * to refresh the instant stats. */
2161 static bool instant_stats_could_have_changed;
2162
2163 static void
2164 instant_stats_run(void)
2165 {
2166     enum ovsdb_idl_txn_status status;
2167
2168     instant_stats_could_have_changed = true;
2169
2170     if (!instant_txn) {
2171         struct bridge *br;
2172         uint64_t seq;
2173
2174         if (time_msec() < instant_next_txn) {
2175             return;
2176         }
2177         instant_next_txn = time_msec() + INSTANT_INTERVAL_MSEC;
2178
2179         seq = seq_read(connectivity_seq_get());
2180         if (seq == connectivity_seqno) {
2181             return;
2182         }
2183         connectivity_seqno = seq;
2184
2185         instant_txn = ovsdb_idl_txn_create(idl);
2186         HMAP_FOR_EACH (br, node, &all_bridges) {
2187             struct iface *iface;
2188             struct port *port;
2189
2190             br_refresh_stp_status(br);
2191
2192             HMAP_FOR_EACH (port, hmap_node, &br->ports) {
2193                 port_refresh_stp_status(port);
2194             }
2195
2196             HMAP_FOR_EACH (iface, name_node, &br->iface_by_name) {
2197                 enum netdev_flags flags;
2198                 struct smap smap;
2199                 const char *link_state;
2200                 int64_t link_resets;
2201                 int current, error;
2202
2203                 if (iface_is_synthetic(iface)) {
2204                     continue;
2205                 }
2206
2207                 current = ofproto_port_is_lacp_current(br->ofproto,
2208                                                        iface->ofp_port);
2209                 if (current >= 0) {
2210                     bool bl = current;
2211                     ovsrec_interface_set_lacp_current(iface->cfg, &bl, 1);
2212                 } else {
2213                     ovsrec_interface_set_lacp_current(iface->cfg, NULL, 0);
2214                 }
2215
2216                 error = netdev_get_flags(iface->netdev, &flags);
2217                 if (!error) {
2218                     const char *state = flags & NETDEV_UP ? "up" : "down";
2219                     ovsrec_interface_set_admin_state(iface->cfg, state);
2220                 } else {
2221                     ovsrec_interface_set_admin_state(iface->cfg, NULL);
2222                 }
2223
2224                 link_state = netdev_get_carrier(iface->netdev) ? "up" : "down";
2225                 ovsrec_interface_set_link_state(iface->cfg, link_state);
2226
2227                 link_resets = netdev_get_carrier_resets(iface->netdev);
2228                 ovsrec_interface_set_link_resets(iface->cfg, &link_resets, 1);
2229
2230                 iface_refresh_cfm_stats(iface);
2231
2232                 smap_init(&smap);
2233                 ofproto_port_get_bfd_status(br->ofproto, iface->ofp_port,
2234                                             &smap);
2235                 ovsrec_interface_set_bfd_status(iface->cfg, &smap);
2236                 smap_destroy(&smap);
2237             }
2238         }
2239     }
2240
2241     status = ovsdb_idl_txn_commit(instant_txn);
2242     if (status != TXN_INCOMPLETE) {
2243         ovsdb_idl_txn_destroy(instant_txn);
2244         instant_txn = NULL;
2245     }
2246     if (status == TXN_UNCHANGED) {
2247         instant_stats_could_have_changed = false;
2248     }
2249 }
2250
2251 static void
2252 instant_stats_wait(void)
2253 {
2254     if (instant_txn) {
2255         ovsdb_idl_txn_wait(instant_txn);
2256     } else if (instant_stats_could_have_changed) {
2257         poll_timer_wait_until(instant_next_txn);
2258     }
2259 }
2260 \f
2261 static void
2262 bridge_run__(void)
2263 {
2264     struct bridge *br;
2265     struct sset types;
2266     const char *type;
2267
2268     /* Let each datapath type do the work that it needs to do. */
2269     sset_init(&types);
2270     ofproto_enumerate_types(&types);
2271     SSET_FOR_EACH (type, &types) {
2272         ofproto_type_run(type);
2273     }
2274     sset_destroy(&types);
2275
2276     /* Let each bridge do the work that it needs to do. */
2277     HMAP_FOR_EACH (br, node, &all_bridges) {
2278         ofproto_run(br->ofproto);
2279     }
2280 }
2281
2282 void
2283 bridge_run(void)
2284 {
2285     static struct ovsrec_open_vswitch null_cfg;
2286     const struct ovsrec_open_vswitch *cfg;
2287
2288     bool vlan_splinters_changed;
2289     struct bridge *br;
2290
2291     ovsrec_open_vswitch_init(&null_cfg);
2292
2293     ovsdb_idl_run(idl);
2294
2295     if (ovsdb_idl_is_lock_contended(idl)) {
2296         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
2297         struct bridge *br, *next_br;
2298
2299         VLOG_ERR_RL(&rl, "another ovs-vswitchd process is running, "
2300                     "disabling this process (pid %ld) until it goes away",
2301                     (long int) getpid());
2302
2303         HMAP_FOR_EACH_SAFE (br, next_br, node, &all_bridges) {
2304             bridge_destroy(br);
2305         }
2306         /* Since we will not be running system_stats_run() in this process
2307          * with the current situation of multiple ovs-vswitchd daemons,
2308          * disable system stats collection. */
2309         system_stats_enable(false);
2310         return;
2311     } else if (!ovsdb_idl_has_lock(idl)) {
2312         return;
2313     }
2314     cfg = ovsrec_open_vswitch_first(idl);
2315
2316     /* Initialize the ofproto library.  This only needs to run once, but
2317      * it must be done after the configuration is set.  If the
2318      * initialization has already occurred, bridge_init_ofproto()
2319      * returns immediately. */
2320     bridge_init_ofproto(cfg);
2321
2322     /* Once the value of flow-restore-wait is false, we no longer should
2323      * check its value from the database. */
2324     if (cfg && ofproto_get_flow_restore_wait()) {
2325         ofproto_set_flow_restore_wait(smap_get_bool(&cfg->other_config,
2326                                         "flow-restore-wait", false));
2327     }
2328
2329     bridge_run__();
2330
2331     /* Re-configure SSL.  We do this on every trip through the main loop,
2332      * instead of just when the database changes, because the contents of the
2333      * key and certificate files can change without the database changing.
2334      *
2335      * We do this before bridge_reconfigure() because that function might
2336      * initiate SSL connections and thus requires SSL to be configured. */
2337     if (cfg && cfg->ssl) {
2338         const struct ovsrec_ssl *ssl = cfg->ssl;
2339
2340         stream_ssl_set_key_and_cert(ssl->private_key, ssl->certificate);
2341         stream_ssl_set_ca_cert_file(ssl->ca_cert, ssl->bootstrap_ca_cert);
2342     }
2343
2344     /* If VLAN splinters are in use, then we need to reconfigure if VLAN
2345      * usage has changed. */
2346     vlan_splinters_changed = false;
2347     if (vlan_splinters_enabled_anywhere) {
2348         HMAP_FOR_EACH (br, node, &all_bridges) {
2349             if (ofproto_has_vlan_usage_changed(br->ofproto)) {
2350                 vlan_splinters_changed = true;
2351                 break;
2352             }
2353         }
2354     }
2355
2356     if (ovsdb_idl_get_seqno(idl) != idl_seqno || vlan_splinters_changed) {
2357         struct ovsdb_idl_txn *txn;
2358
2359         idl_seqno = ovsdb_idl_get_seqno(idl);
2360         txn = ovsdb_idl_txn_create(idl);
2361         bridge_reconfigure(cfg ? cfg : &null_cfg);
2362
2363         if (cfg) {
2364             ovsrec_open_vswitch_set_cur_cfg(cfg, cfg->next_cfg);
2365         }
2366
2367         /* If we are completing our initial configuration for this run
2368          * of ovs-vswitchd, then keep the transaction around to monitor
2369          * it for completion. */
2370         if (initial_config_done) {
2371             ovsdb_idl_txn_commit(txn);
2372             ovsdb_idl_txn_destroy(txn);
2373         } else {
2374             initial_config_done = true;
2375             daemonize_txn = txn;
2376         }
2377     }
2378
2379     if (daemonize_txn) {
2380         enum ovsdb_idl_txn_status status = ovsdb_idl_txn_commit(daemonize_txn);
2381         if (status != TXN_INCOMPLETE) {
2382             ovsdb_idl_txn_destroy(daemonize_txn);
2383             daemonize_txn = NULL;
2384
2385             /* ovs-vswitchd has completed initialization, so allow the
2386              * process that forked us to exit successfully. */
2387             daemonize_complete();
2388
2389             vlog_enable_async();
2390
2391             VLOG_INFO_ONCE("%s (Open vSwitch) %s", program_name, VERSION);
2392         }
2393     }
2394
2395     /* Refresh interface and mirror stats if necessary. */
2396     if (time_msec() >= iface_stats_timer) {
2397         if (cfg) {
2398             struct ovsdb_idl_txn *txn;
2399
2400             txn = ovsdb_idl_txn_create(idl);
2401             HMAP_FOR_EACH (br, node, &all_bridges) {
2402                 struct port *port;
2403                 struct mirror *m;
2404
2405                 HMAP_FOR_EACH (port, hmap_node, &br->ports) {
2406                     struct iface *iface;
2407
2408                     LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
2409                         iface_refresh_stats(iface);
2410                         iface_refresh_status(iface);
2411                     }
2412
2413                     port_refresh_stp_stats(port);
2414                 }
2415
2416                 HMAP_FOR_EACH (m, hmap_node, &br->mirrors) {
2417                     mirror_refresh_stats(m);
2418                 }
2419
2420             }
2421             refresh_controller_status();
2422             ovsdb_idl_txn_commit(txn);
2423             ovsdb_idl_txn_destroy(txn); /* XXX */
2424         }
2425
2426         iface_stats_timer = time_msec() + IFACE_STATS_INTERVAL;
2427     }
2428
2429     run_system_stats();
2430     instant_stats_run();
2431 }
2432
2433 void
2434 bridge_wait(void)
2435 {
2436     struct sset types;
2437     const char *type;
2438
2439     ovsdb_idl_wait(idl);
2440     if (daemonize_txn) {
2441         ovsdb_idl_txn_wait(daemonize_txn);
2442     }
2443
2444     sset_init(&types);
2445     ofproto_enumerate_types(&types);
2446     SSET_FOR_EACH (type, &types) {
2447         ofproto_type_wait(type);
2448     }
2449     sset_destroy(&types);
2450
2451     if (!hmap_is_empty(&all_bridges)) {
2452         struct bridge *br;
2453
2454         HMAP_FOR_EACH (br, node, &all_bridges) {
2455             ofproto_wait(br->ofproto);
2456         }
2457         poll_timer_wait_until(iface_stats_timer);
2458     }
2459
2460     system_stats_wait();
2461     instant_stats_wait();
2462 }
2463
2464 /* Adds some memory usage statistics for bridges into 'usage', for use with
2465  * memory_report(). */
2466 void
2467 bridge_get_memory_usage(struct simap *usage)
2468 {
2469     struct bridge *br;
2470     struct sset types;
2471     const char *type;
2472
2473     sset_init(&types);
2474     ofproto_enumerate_types(&types);
2475     SSET_FOR_EACH (type, &types) {
2476         ofproto_type_get_memory_usage(type, usage);
2477     }
2478     sset_destroy(&types);
2479
2480     HMAP_FOR_EACH (br, node, &all_bridges) {
2481         ofproto_get_memory_usage(br->ofproto, usage);
2482     }
2483 }
2484 \f
2485 /* QoS unixctl user interface functions. */
2486
2487 struct qos_unixctl_show_cbdata {
2488     struct ds *ds;
2489     struct iface *iface;
2490 };
2491
2492 static void
2493 qos_unixctl_show_queue(unsigned int queue_id,
2494                        const struct smap *details,
2495                        struct iface *iface,
2496                        struct ds *ds)
2497 {
2498     struct netdev_queue_stats stats;
2499     struct smap_node *node;
2500     int error;
2501
2502     ds_put_cstr(ds, "\n");
2503     if (queue_id) {
2504         ds_put_format(ds, "Queue %u:\n", queue_id);
2505     } else {
2506         ds_put_cstr(ds, "Default:\n");
2507     }
2508
2509     SMAP_FOR_EACH (node, details) {
2510         ds_put_format(ds, "\t%s: %s\n", node->key, node->value);
2511     }
2512
2513     error = netdev_get_queue_stats(iface->netdev, queue_id, &stats);
2514     if (!error) {
2515         if (stats.tx_packets != UINT64_MAX) {
2516             ds_put_format(ds, "\ttx_packets: %"PRIu64"\n", stats.tx_packets);
2517         }
2518
2519         if (stats.tx_bytes != UINT64_MAX) {
2520             ds_put_format(ds, "\ttx_bytes: %"PRIu64"\n", stats.tx_bytes);
2521         }
2522
2523         if (stats.tx_errors != UINT64_MAX) {
2524             ds_put_format(ds, "\ttx_errors: %"PRIu64"\n", stats.tx_errors);
2525         }
2526     } else {
2527         ds_put_format(ds, "\tFailed to get statistics for queue %u: %s",
2528                       queue_id, ovs_strerror(error));
2529     }
2530 }
2531
2532 static void
2533 qos_unixctl_show(struct unixctl_conn *conn, int argc OVS_UNUSED,
2534                  const char *argv[], void *aux OVS_UNUSED)
2535 {
2536     struct ds ds = DS_EMPTY_INITIALIZER;
2537     struct smap smap = SMAP_INITIALIZER(&smap);
2538     struct iface *iface;
2539     const char *type;
2540     struct smap_node *node;
2541
2542     iface = iface_find(argv[1]);
2543     if (!iface) {
2544         unixctl_command_reply_error(conn, "no such interface");
2545         return;
2546     }
2547
2548     netdev_get_qos(iface->netdev, &type, &smap);
2549
2550     if (*type != '\0') {
2551         struct netdev_queue_dump dump;
2552         struct smap details;
2553         unsigned int queue_id;
2554
2555         ds_put_format(&ds, "QoS: %s %s\n", iface->name, type);
2556
2557         SMAP_FOR_EACH (node, &smap) {
2558             ds_put_format(&ds, "%s: %s\n", node->key, node->value);
2559         }
2560
2561         smap_init(&details);
2562         NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &dump, iface->netdev) {
2563             qos_unixctl_show_queue(queue_id, &details, iface, &ds);
2564         }
2565         smap_destroy(&details);
2566
2567         unixctl_command_reply(conn, ds_cstr(&ds));
2568     } else {
2569         ds_put_format(&ds, "QoS not configured on %s\n", iface->name);
2570         unixctl_command_reply_error(conn, ds_cstr(&ds));
2571     }
2572
2573     smap_destroy(&smap);
2574     ds_destroy(&ds);
2575 }
2576 \f
2577 /* Bridge reconfiguration functions. */
2578 static void
2579 bridge_create(const struct ovsrec_bridge *br_cfg)
2580 {
2581     struct bridge *br;
2582
2583     ovs_assert(!bridge_lookup(br_cfg->name));
2584     br = xzalloc(sizeof *br);
2585
2586     br->name = xstrdup(br_cfg->name);
2587     br->type = xstrdup(ofproto_normalize_type(br_cfg->datapath_type));
2588     br->cfg = br_cfg;
2589
2590     /* Derive the default Ethernet address from the bridge's UUID.  This should
2591      * be unique and it will be stable between ovs-vswitchd runs.  */
2592     memcpy(br->default_ea, &br_cfg->header_.uuid, ETH_ADDR_LEN);
2593     eth_addr_mark_random(br->default_ea);
2594
2595     hmap_init(&br->ports);
2596     hmap_init(&br->ifaces);
2597     hmap_init(&br->iface_by_name);
2598     hmap_init(&br->mirrors);
2599
2600     hmap_insert(&all_bridges, &br->node, hash_string(br->name, 0));
2601 }
2602
2603 static void
2604 bridge_destroy(struct bridge *br)
2605 {
2606     if (br) {
2607         struct mirror *mirror, *next_mirror;
2608         struct port *port, *next_port;
2609
2610         HMAP_FOR_EACH_SAFE (port, next_port, hmap_node, &br->ports) {
2611             port_destroy(port);
2612         }
2613         HMAP_FOR_EACH_SAFE (mirror, next_mirror, hmap_node, &br->mirrors) {
2614             mirror_destroy(mirror);
2615         }
2616
2617         hmap_remove(&all_bridges, &br->node);
2618         ofproto_destroy(br->ofproto);
2619         hmap_destroy(&br->ifaces);
2620         hmap_destroy(&br->ports);
2621         hmap_destroy(&br->iface_by_name);
2622         hmap_destroy(&br->mirrors);
2623         free(br->name);
2624         free(br->type);
2625         free(br);
2626     }
2627 }
2628
2629 static struct bridge *
2630 bridge_lookup(const char *name)
2631 {
2632     struct bridge *br;
2633
2634     HMAP_FOR_EACH_WITH_HASH (br, node, hash_string(name, 0), &all_bridges) {
2635         if (!strcmp(br->name, name)) {
2636             return br;
2637         }
2638     }
2639     return NULL;
2640 }
2641
2642 /* Handle requests for a listing of all flows known by the OpenFlow
2643  * stack, including those normally hidden. */
2644 static void
2645 bridge_unixctl_dump_flows(struct unixctl_conn *conn, int argc OVS_UNUSED,
2646                           const char *argv[], void *aux OVS_UNUSED)
2647 {
2648     struct bridge *br;
2649     struct ds results;
2650
2651     br = bridge_lookup(argv[1]);
2652     if (!br) {
2653         unixctl_command_reply_error(conn, "Unknown bridge");
2654         return;
2655     }
2656
2657     ds_init(&results);
2658     ofproto_get_all_flows(br->ofproto, &results);
2659
2660     unixctl_command_reply(conn, ds_cstr(&results));
2661     ds_destroy(&results);
2662 }
2663
2664 /* "bridge/reconnect [BRIDGE]": makes BRIDGE drop all of its controller
2665  * connections and reconnect.  If BRIDGE is not specified, then all bridges
2666  * drop their controller connections and reconnect. */
2667 static void
2668 bridge_unixctl_reconnect(struct unixctl_conn *conn, int argc,
2669                          const char *argv[], void *aux OVS_UNUSED)
2670 {
2671     struct bridge *br;
2672     if (argc > 1) {
2673         br = bridge_lookup(argv[1]);
2674         if (!br) {
2675             unixctl_command_reply_error(conn,  "Unknown bridge");
2676             return;
2677         }
2678         ofproto_reconnect_controllers(br->ofproto);
2679     } else {
2680         HMAP_FOR_EACH (br, node, &all_bridges) {
2681             ofproto_reconnect_controllers(br->ofproto);
2682         }
2683     }
2684     unixctl_command_reply(conn, NULL);
2685 }
2686
2687 static size_t
2688 bridge_get_controllers(const struct bridge *br,
2689                        struct ovsrec_controller ***controllersp)
2690 {
2691     struct ovsrec_controller **controllers;
2692     size_t n_controllers;
2693
2694     controllers = br->cfg->controller;
2695     n_controllers = br->cfg->n_controller;
2696
2697     if (n_controllers == 1 && !strcmp(controllers[0]->target, "none")) {
2698         controllers = NULL;
2699         n_controllers = 0;
2700     }
2701
2702     if (controllersp) {
2703         *controllersp = controllers;
2704     }
2705     return n_controllers;
2706 }
2707
2708 static void
2709 bridge_collect_wanted_ports(struct bridge *br,
2710                             const unsigned long int *splinter_vlans,
2711                             struct shash *wanted_ports)
2712 {
2713     size_t i;
2714
2715     shash_init(wanted_ports);
2716
2717     for (i = 0; i < br->cfg->n_ports; i++) {
2718         const char *name = br->cfg->ports[i]->name;
2719         if (!shash_add_once(wanted_ports, name, br->cfg->ports[i])) {
2720             VLOG_WARN("bridge %s: %s specified twice as bridge port",
2721                       br->name, name);
2722         }
2723     }
2724     if (bridge_get_controllers(br, NULL)
2725         && !shash_find(wanted_ports, br->name)) {
2726         VLOG_WARN("bridge %s: no port named %s, synthesizing one",
2727                   br->name, br->name);
2728
2729         ovsrec_interface_init(&br->synth_local_iface);
2730         ovsrec_port_init(&br->synth_local_port);
2731
2732         br->synth_local_port.interfaces = &br->synth_local_ifacep;
2733         br->synth_local_port.n_interfaces = 1;
2734         br->synth_local_port.name = br->name;
2735
2736         br->synth_local_iface.name = br->name;
2737         br->synth_local_iface.type = "internal";
2738
2739         br->synth_local_ifacep = &br->synth_local_iface;
2740
2741         shash_add(wanted_ports, br->name, &br->synth_local_port);
2742     }
2743
2744     if (splinter_vlans) {
2745         add_vlan_splinter_ports(br, splinter_vlans, wanted_ports);
2746     }
2747 }
2748
2749 /* Deletes "struct port"s and "struct iface"s under 'br' which aren't
2750  * consistent with 'br->cfg'.  Updates 'br->if_cfg_queue' with interfaces which
2751  * 'br' needs to complete its configuration. */
2752 static void
2753 bridge_del_ports(struct bridge *br, const struct shash *wanted_ports)
2754 {
2755     struct shash_node *port_node;
2756     struct port *port, *next;
2757
2758     /* Get rid of deleted ports.
2759      * Get rid of deleted interfaces on ports that still exist. */
2760     HMAP_FOR_EACH_SAFE (port, next, hmap_node, &br->ports) {
2761         port->cfg = shash_find_data(wanted_ports, port->name);
2762         if (!port->cfg) {
2763             port_destroy(port);
2764         } else {
2765             port_del_ifaces(port);
2766         }
2767     }
2768
2769     /* Update iface->cfg and iface->type in interfaces that still exist. */
2770     SHASH_FOR_EACH (port_node, wanted_ports) {
2771         const struct ovsrec_port *port = port_node->data;
2772         size_t i;
2773
2774         for (i = 0; i < port->n_interfaces; i++) {
2775             const struct ovsrec_interface *cfg = port->interfaces[i];
2776             struct iface *iface = iface_lookup(br, cfg->name);
2777             const char *type = iface_get_type(cfg, br->cfg);
2778
2779             if (iface) {
2780                 iface->cfg = cfg;
2781                 iface->type = type;
2782             } else if (!strcmp(type, "null")) {
2783                 VLOG_WARN_ONCE("%s: The null interface type is deprecated and"
2784                                " may be removed in February 2013. Please email"
2785                                " dev@openvswitch.org with concerns.",
2786                                cfg->name);
2787             } else {
2788                 /* We will add new interfaces later. */
2789             }
2790         }
2791     }
2792 }
2793
2794 /* Initializes 'oc' appropriately as a management service controller for
2795  * 'br'.
2796  *
2797  * The caller must free oc->target when it is no longer needed. */
2798 static void
2799 bridge_ofproto_controller_for_mgmt(const struct bridge *br,
2800                                    struct ofproto_controller *oc)
2801 {
2802     oc->target = xasprintf("punix:%s/%s.mgmt", ovs_rundir(), br->name);
2803     oc->max_backoff = 0;
2804     oc->probe_interval = 60;
2805     oc->band = OFPROTO_OUT_OF_BAND;
2806     oc->rate_limit = 0;
2807     oc->burst_limit = 0;
2808     oc->enable_async_msgs = true;
2809 }
2810
2811 /* Converts ovsrec_controller 'c' into an ofproto_controller in 'oc'.  */
2812 static void
2813 bridge_ofproto_controller_from_ovsrec(const struct ovsrec_controller *c,
2814                                       struct ofproto_controller *oc)
2815 {
2816     int dscp;
2817
2818     oc->target = c->target;
2819     oc->max_backoff = c->max_backoff ? *c->max_backoff / 1000 : 8;
2820     oc->probe_interval = c->inactivity_probe ? *c->inactivity_probe / 1000 : 5;
2821     oc->band = (!c->connection_mode || !strcmp(c->connection_mode, "in-band")
2822                 ? OFPROTO_IN_BAND : OFPROTO_OUT_OF_BAND);
2823     oc->rate_limit = c->controller_rate_limit ? *c->controller_rate_limit : 0;
2824     oc->burst_limit = (c->controller_burst_limit
2825                        ? *c->controller_burst_limit : 0);
2826     oc->enable_async_msgs = (!c->enable_async_messages
2827                              || *c->enable_async_messages);
2828     dscp = smap_get_int(&c->other_config, "dscp", DSCP_DEFAULT);
2829     if (dscp < 0 || dscp > 63) {
2830         dscp = DSCP_DEFAULT;
2831     }
2832     oc->dscp = dscp;
2833 }
2834
2835 /* Configures the IP stack for 'br''s local interface properly according to the
2836  * configuration in 'c'.  */
2837 static void
2838 bridge_configure_local_iface_netdev(struct bridge *br,
2839                                     struct ovsrec_controller *c)
2840 {
2841     struct netdev *netdev;
2842     struct in_addr mask, gateway;
2843
2844     struct iface *local_iface;
2845     struct in_addr ip;
2846
2847     /* If there's no local interface or no IP address, give up. */
2848     local_iface = iface_from_ofp_port(br, OFPP_LOCAL);
2849     if (!local_iface || !c->local_ip || !inet_aton(c->local_ip, &ip)) {
2850         return;
2851     }
2852
2853     /* Bring up the local interface. */
2854     netdev = local_iface->netdev;
2855     netdev_turn_flags_on(netdev, NETDEV_UP, NULL);
2856
2857     /* Configure the IP address and netmask. */
2858     if (!c->local_netmask
2859         || !inet_aton(c->local_netmask, &mask)
2860         || !mask.s_addr) {
2861         mask.s_addr = guess_netmask(ip.s_addr);
2862     }
2863     if (!netdev_set_in4(netdev, ip, mask)) {
2864         VLOG_INFO("bridge %s: configured IP address "IP_FMT", netmask "IP_FMT,
2865                   br->name, IP_ARGS(ip.s_addr), IP_ARGS(mask.s_addr));
2866     }
2867
2868     /* Configure the default gateway. */
2869     if (c->local_gateway
2870         && inet_aton(c->local_gateway, &gateway)
2871         && gateway.s_addr) {
2872         if (!netdev_add_router(netdev, gateway)) {
2873             VLOG_INFO("bridge %s: configured gateway "IP_FMT,
2874                       br->name, IP_ARGS(gateway.s_addr));
2875         }
2876     }
2877 }
2878
2879 /* Returns true if 'a' and 'b' are the same except that any number of slashes
2880  * in either string are treated as equal to any number of slashes in the other,
2881  * e.g. "x///y" is equal to "x/y".
2882  *
2883  * Also, if 'b_stoplen' bytes from 'b' are found to be equal to corresponding
2884  * bytes from 'a', the function considers this success.  Specify 'b_stoplen' as
2885  * SIZE_MAX to compare all of 'a' to all of 'b' rather than just a prefix of
2886  * 'b' against a prefix of 'a'.
2887  */
2888 static bool
2889 equal_pathnames(const char *a, const char *b, size_t b_stoplen)
2890 {
2891     const char *b_start = b;
2892     for (;;) {
2893         if (b - b_start >= b_stoplen) {
2894             return true;
2895         } else if (*a != *b) {
2896             return false;
2897         } else if (*a == '/') {
2898             a += strspn(a, "/");
2899             b += strspn(b, "/");
2900         } else if (*a == '\0') {
2901             return true;
2902         } else {
2903             a++;
2904             b++;
2905         }
2906     }
2907 }
2908
2909 static void
2910 bridge_configure_remotes(struct bridge *br,
2911                          const struct sockaddr_in *managers, size_t n_managers)
2912 {
2913     bool disable_in_band;
2914
2915     struct ovsrec_controller **controllers;
2916     size_t n_controllers;
2917
2918     enum ofproto_fail_mode fail_mode;
2919
2920     struct ofproto_controller *ocs;
2921     size_t n_ocs;
2922     size_t i;
2923
2924     /* Check if we should disable in-band control on this bridge. */
2925     disable_in_band = smap_get_bool(&br->cfg->other_config, "disable-in-band",
2926                                     false);
2927
2928     /* Set OpenFlow queue ID for in-band control. */
2929     ofproto_set_in_band_queue(br->ofproto,
2930                               smap_get_int(&br->cfg->other_config,
2931                                            "in-band-queue", -1));
2932
2933     if (disable_in_band) {
2934         ofproto_set_extra_in_band_remotes(br->ofproto, NULL, 0);
2935     } else {
2936         ofproto_set_extra_in_band_remotes(br->ofproto, managers, n_managers);
2937     }
2938
2939     n_controllers = bridge_get_controllers(br, &controllers);
2940
2941     ocs = xmalloc((n_controllers + 1) * sizeof *ocs);
2942     n_ocs = 0;
2943
2944     bridge_ofproto_controller_for_mgmt(br, &ocs[n_ocs++]);
2945     for (i = 0; i < n_controllers; i++) {
2946         struct ovsrec_controller *c = controllers[i];
2947
2948         if (!strncmp(c->target, "punix:", 6)
2949             || !strncmp(c->target, "unix:", 5)) {
2950             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2951             char *whitelist;
2952
2953             if (!strncmp(c->target, "unix:", 5)) {
2954                 /* Connect to a listening socket */
2955                 whitelist = xasprintf("unix:%s/", ovs_rundir());
2956                 if (strchr(c->target, '/') &&
2957                    !equal_pathnames(c->target, whitelist,
2958                      strlen(whitelist))) {
2959                     /* Absolute path specified, but not in ovs_rundir */
2960                     VLOG_ERR_RL(&rl, "bridge %s: Not connecting to socket "
2961                                   "controller \"%s\" due to possibility for "
2962                                   "remote exploit.  Instead, specify socket "
2963                                   "in whitelisted \"%s\" or connect to "
2964                                   "\"unix:%s/%s.mgmt\" (which is always "
2965                                   "available without special configuration).",
2966                                   br->name, c->target, whitelist,
2967                                   ovs_rundir(), br->name);
2968                     free(whitelist);
2969                     continue;
2970                 }
2971             } else {
2972                whitelist = xasprintf("punix:%s/%s.controller",
2973                                      ovs_rundir(), br->name);
2974                if (!equal_pathnames(c->target, whitelist, SIZE_MAX)) {
2975                    /* Prevent remote ovsdb-server users from accessing
2976                     * arbitrary Unix domain sockets and overwriting arbitrary
2977                     * local files. */
2978                    VLOG_ERR_RL(&rl, "bridge %s: Not adding Unix domain socket "
2979                                   "controller \"%s\" due to possibility of "
2980                                   "overwriting local files. Instead, specify "
2981                                   "whitelisted \"%s\" or connect to "
2982                                   "\"unix:%s/%s.mgmt\" (which is always "
2983                                   "available without special configuration).",
2984                                   br->name, c->target, whitelist,
2985                                   ovs_rundir(), br->name);
2986                    free(whitelist);
2987                    continue;
2988                }
2989             }
2990
2991             free(whitelist);
2992         }
2993
2994         bridge_configure_local_iface_netdev(br, c);
2995         bridge_ofproto_controller_from_ovsrec(c, &ocs[n_ocs]);
2996         if (disable_in_band) {
2997             ocs[n_ocs].band = OFPROTO_OUT_OF_BAND;
2998         }
2999         n_ocs++;
3000     }
3001
3002     ofproto_set_controllers(br->ofproto, ocs, n_ocs,
3003                             bridge_get_allowed_versions(br));
3004     free(ocs[0].target); /* From bridge_ofproto_controller_for_mgmt(). */
3005     free(ocs);
3006
3007     /* Set the fail-mode. */
3008     fail_mode = !br->cfg->fail_mode
3009                 || !strcmp(br->cfg->fail_mode, "standalone")
3010                     ? OFPROTO_FAIL_STANDALONE
3011                     : OFPROTO_FAIL_SECURE;
3012     ofproto_set_fail_mode(br->ofproto, fail_mode);
3013
3014     /* Configure OpenFlow controller connection snooping. */
3015     if (!ofproto_has_snoops(br->ofproto)) {
3016         struct sset snoops;
3017
3018         sset_init(&snoops);
3019         sset_add_and_free(&snoops, xasprintf("punix:%s/%s.snoop",
3020                                              ovs_rundir(), br->name));
3021         ofproto_set_snoops(br->ofproto, &snoops);
3022         sset_destroy(&snoops);
3023     }
3024 }
3025
3026 static void
3027 bridge_configure_tables(struct bridge *br)
3028 {
3029     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3030     int n_tables;
3031     int i, j, k;
3032
3033     n_tables = ofproto_get_n_tables(br->ofproto);
3034     j = 0;
3035     for (i = 0; i < n_tables; i++) {
3036         struct ofproto_table_settings s;
3037
3038         s.name = NULL;
3039         s.max_flows = UINT_MAX;
3040         s.groups = NULL;
3041         s.n_groups = 0;
3042         s.n_prefix_fields = 0;
3043         memset(s.prefix_fields, ~0, sizeof(s.prefix_fields));
3044
3045         if (j < br->cfg->n_flow_tables && i == br->cfg->key_flow_tables[j]) {
3046             struct ovsrec_flow_table *cfg = br->cfg->value_flow_tables[j++];
3047
3048             s.name = cfg->name;
3049             if (cfg->n_flow_limit && *cfg->flow_limit < UINT_MAX) {
3050                 s.max_flows = *cfg->flow_limit;
3051             }
3052             if (cfg->overflow_policy
3053                 && !strcmp(cfg->overflow_policy, "evict")) {
3054
3055                 s.groups = xmalloc(cfg->n_groups * sizeof *s.groups);
3056                 for (k = 0; k < cfg->n_groups; k++) {
3057                     const char *string = cfg->groups[k];
3058                     char *msg;
3059
3060                     msg = mf_parse_subfield__(&s.groups[k], &string);
3061                     if (msg) {
3062                         VLOG_WARN_RL(&rl, "bridge %s table %d: error parsing "
3063                                      "'groups' (%s)", br->name, i, msg);
3064                         free(msg);
3065                     } else if (*string) {
3066                         VLOG_WARN_RL(&rl, "bridge %s table %d: 'groups' "
3067                                      "element '%s' contains trailing garbage",
3068                                      br->name, i, cfg->groups[k]);
3069                     } else {
3070                         s.n_groups++;
3071                     }
3072                 }
3073             }
3074             /* Prefix lookup fields. */
3075             s.n_prefix_fields = 0;
3076             for (k = 0; k < cfg->n_prefixes; k++) {
3077                 const char *name = cfg->prefixes[k];
3078                 const struct mf_field *mf = mf_from_name(name);
3079                 if (!mf) {
3080                     VLOG_WARN("bridge %s: 'prefixes' with unknown field: %s",
3081                               br->name, name);
3082                     continue;
3083                 }
3084                 if (mf->flow_be32ofs < 0 || mf->n_bits % 32) {
3085                     VLOG_WARN("bridge %s: 'prefixes' with incompatible field: "
3086                               "%s", br->name, name);
3087                     continue;
3088                 }
3089                 if (s.n_prefix_fields >= ARRAY_SIZE(s.prefix_fields)) {
3090                     VLOG_WARN("bridge %s: 'prefixes' with too many fields, "
3091                               "field not used: %s", br->name, name);
3092                     continue;
3093                 }
3094                 s.prefix_fields[s.n_prefix_fields++] = mf->id;
3095             }
3096             if (s.n_prefix_fields > 0) {
3097                 int k;
3098                 struct ds ds = DS_EMPTY_INITIALIZER;
3099                 for (k = 0; k < s.n_prefix_fields; k++) {
3100                     if (k) {
3101                         ds_put_char(&ds, ',');
3102                     }
3103                     ds_put_cstr(&ds, mf_from_id(s.prefix_fields[k])->name);
3104                 }
3105                 VLOG_INFO("bridge %s table %d: Prefix lookup with: %s.",
3106                           br->name, i, ds_cstr(&ds));
3107                 ds_destroy(&ds);
3108             }
3109         }
3110
3111         ofproto_configure_table(br->ofproto, i, &s);
3112
3113         free(s.groups);
3114     }
3115     for (; j < br->cfg->n_flow_tables; j++) {
3116         VLOG_WARN_RL(&rl, "bridge %s: ignoring configuration for flow table "
3117                      "%"PRId64" not supported by this datapath", br->name,
3118                      br->cfg->key_flow_tables[j]);
3119     }
3120 }
3121
3122 static void
3123 bridge_configure_dp_desc(struct bridge *br)
3124 {
3125     ofproto_set_dp_desc(br->ofproto,
3126                         smap_get(&br->cfg->other_config, "dp-desc"));
3127 }
3128 \f
3129 /* Port functions. */
3130
3131 static void iface_destroy__(struct iface *);
3132
3133 static struct port *
3134 port_create(struct bridge *br, const struct ovsrec_port *cfg)
3135 {
3136     struct port *port;
3137
3138     port = xzalloc(sizeof *port);
3139     port->bridge = br;
3140     port->name = xstrdup(cfg->name);
3141     port->cfg = cfg;
3142     list_init(&port->ifaces);
3143
3144     hmap_insert(&br->ports, &port->hmap_node, hash_string(port->name, 0));
3145     return port;
3146 }
3147
3148 /* Deletes interfaces from 'port' that are no longer configured for it. */
3149 static void
3150 port_del_ifaces(struct port *port)
3151 {
3152     struct iface *iface, *next;
3153     struct sset new_ifaces;
3154     size_t i;
3155
3156     /* Collect list of new interfaces. */
3157     sset_init(&new_ifaces);
3158     for (i = 0; i < port->cfg->n_interfaces; i++) {
3159         const char *name = port->cfg->interfaces[i]->name;
3160         const char *type = port->cfg->interfaces[i]->type;
3161         if (strcmp(type, "null")) {
3162             sset_add(&new_ifaces, name);
3163         }
3164     }
3165
3166     /* Get rid of deleted interfaces. */
3167     LIST_FOR_EACH_SAFE (iface, next, port_elem, &port->ifaces) {
3168         if (!sset_contains(&new_ifaces, iface->name)) {
3169             iface_destroy(iface);
3170         }
3171     }
3172
3173     sset_destroy(&new_ifaces);
3174 }
3175
3176 static void
3177 port_destroy(struct port *port)
3178 {
3179     if (port) {
3180         struct bridge *br = port->bridge;
3181         struct iface *iface, *next;
3182
3183         if (br->ofproto) {
3184             ofproto_bundle_unregister(br->ofproto, port);
3185         }
3186
3187         LIST_FOR_EACH_SAFE (iface, next, port_elem, &port->ifaces) {
3188             iface_destroy__(iface);
3189         }
3190
3191         hmap_remove(&br->ports, &port->hmap_node);
3192         free(port->name);
3193         free(port);
3194     }
3195 }
3196
3197 static struct port *
3198 port_lookup(const struct bridge *br, const char *name)
3199 {
3200     struct port *port;
3201
3202     HMAP_FOR_EACH_WITH_HASH (port, hmap_node, hash_string(name, 0),
3203                              &br->ports) {
3204         if (!strcmp(port->name, name)) {
3205             return port;
3206         }
3207     }
3208     return NULL;
3209 }
3210
3211 static bool
3212 enable_lacp(struct port *port, bool *activep)
3213 {
3214     if (!port->cfg->lacp) {
3215         /* XXX when LACP implementation has been sufficiently tested, enable by
3216          * default and make active on bonded ports. */
3217         return false;
3218     } else if (!strcmp(port->cfg->lacp, "off")) {
3219         return false;
3220     } else if (!strcmp(port->cfg->lacp, "active")) {
3221         *activep = true;
3222         return true;
3223     } else if (!strcmp(port->cfg->lacp, "passive")) {
3224         *activep = false;
3225         return true;
3226     } else {
3227         VLOG_WARN("port %s: unknown LACP mode %s",
3228                   port->name, port->cfg->lacp);
3229         return false;
3230     }
3231 }
3232
3233 static struct lacp_settings *
3234 port_configure_lacp(struct port *port, struct lacp_settings *s)
3235 {
3236     const char *lacp_time, *system_id;
3237     int priority;
3238
3239     if (!enable_lacp(port, &s->active)) {
3240         return NULL;
3241     }
3242
3243     s->name = port->name;
3244
3245     system_id = smap_get(&port->cfg->other_config, "lacp-system-id");
3246     if (system_id) {
3247         if (!ovs_scan(system_id, ETH_ADDR_SCAN_FMT,
3248                       ETH_ADDR_SCAN_ARGS(s->id))) {
3249             VLOG_WARN("port %s: LACP system ID (%s) must be an Ethernet"
3250                       " address.", port->name, system_id);
3251             return NULL;
3252         }
3253     } else {
3254         memcpy(s->id, port->bridge->ea, ETH_ADDR_LEN);
3255     }
3256
3257     if (eth_addr_is_zero(s->id)) {
3258         VLOG_WARN("port %s: Invalid zero LACP system ID.", port->name);
3259         return NULL;
3260     }
3261
3262     /* Prefer bondable links if unspecified. */
3263     priority = smap_get_int(&port->cfg->other_config, "lacp-system-priority",
3264                             0);
3265     s->priority = (priority > 0 && priority <= UINT16_MAX
3266                    ? priority
3267                    : UINT16_MAX - !list_is_short(&port->ifaces));
3268
3269     lacp_time = smap_get(&port->cfg->other_config, "lacp-time");
3270     s->fast = lacp_time && !strcasecmp(lacp_time, "fast");
3271
3272     s->fallback_ab_cfg = smap_get_bool(&port->cfg->other_config,
3273                                        "lacp-fallback-ab", false);
3274
3275     return s;
3276 }
3277
3278 static void
3279 iface_configure_lacp(struct iface *iface, struct lacp_slave_settings *s)
3280 {
3281     int priority, portid, key;
3282
3283     portid = smap_get_int(&iface->cfg->other_config, "lacp-port-id", 0);
3284     priority = smap_get_int(&iface->cfg->other_config, "lacp-port-priority",
3285                             0);
3286     key = smap_get_int(&iface->cfg->other_config, "lacp-aggregation-key", 0);
3287
3288     if (portid <= 0 || portid > UINT16_MAX) {
3289         portid = ofp_to_u16(iface->ofp_port);
3290     }
3291
3292     if (priority <= 0 || priority > UINT16_MAX) {
3293         priority = UINT16_MAX;
3294     }
3295
3296     if (key < 0 || key > UINT16_MAX) {
3297         key = 0;
3298     }
3299
3300     s->name = iface->name;
3301     s->id = portid;
3302     s->priority = priority;
3303     s->key = key;
3304 }
3305
3306 static void
3307 port_configure_bond(struct port *port, struct bond_settings *s)
3308 {
3309     const char *detect_s;
3310     struct iface *iface;
3311     int miimon_interval;
3312
3313     s->name = port->name;
3314     s->balance = BM_AB;
3315     if (port->cfg->bond_mode) {
3316         if (!bond_mode_from_string(&s->balance, port->cfg->bond_mode)) {
3317             VLOG_WARN("port %s: unknown bond_mode %s, defaulting to %s",
3318                       port->name, port->cfg->bond_mode,
3319                       bond_mode_to_string(s->balance));
3320         }
3321     } else {
3322         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 1);
3323
3324         /* XXX: Post version 1.5.*, the default bond_mode changed from SLB to
3325          * active-backup. At some point we should remove this warning. */
3326         VLOG_WARN_RL(&rl, "port %s: Using the default bond_mode %s. Note that"
3327                      " in previous versions, the default bond_mode was"
3328                      " balance-slb", port->name,
3329                      bond_mode_to_string(s->balance));
3330     }
3331     if (s->balance == BM_SLB && port->bridge->cfg->n_flood_vlans) {
3332         VLOG_WARN("port %s: SLB bonds are incompatible with flood_vlans, "
3333                   "please use another bond type or disable flood_vlans",
3334                   port->name);
3335     }
3336
3337     miimon_interval = smap_get_int(&port->cfg->other_config,
3338                                    "bond-miimon-interval", 0);
3339     if (miimon_interval <= 0) {
3340         miimon_interval = 200;
3341     }
3342
3343     detect_s = smap_get(&port->cfg->other_config, "bond-detect-mode");
3344     if (!detect_s || !strcmp(detect_s, "carrier")) {
3345         miimon_interval = 0;
3346     } else if (strcmp(detect_s, "miimon")) {
3347         VLOG_WARN("port %s: unsupported bond-detect-mode %s, "
3348                   "defaulting to carrier", port->name, detect_s);
3349         miimon_interval = 0;
3350     }
3351
3352     s->up_delay = MAX(0, port->cfg->bond_updelay);
3353     s->down_delay = MAX(0, port->cfg->bond_downdelay);
3354     s->basis = smap_get_int(&port->cfg->other_config, "bond-hash-basis", 0);
3355     s->rebalance_interval = smap_get_int(&port->cfg->other_config,
3356                                            "bond-rebalance-interval", 10000);
3357     if (s->rebalance_interval && s->rebalance_interval < 1000) {
3358         s->rebalance_interval = 1000;
3359     }
3360
3361     s->fake_iface = port->cfg->bond_fake_iface;
3362
3363     s->lacp_fallback_ab_cfg = smap_get_bool(&port->cfg->other_config,
3364                                        "lacp-fallback-ab", false);
3365
3366     LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
3367         netdev_set_miimon_interval(iface->netdev, miimon_interval);
3368     }
3369 }
3370
3371 /* Returns true if 'port' is synthetic, that is, if we constructed it locally
3372  * instead of obtaining it from the database. */
3373 static bool
3374 port_is_synthetic(const struct port *port)
3375 {
3376     return ovsdb_idl_row_is_synthetic(&port->cfg->header_);
3377 }
3378 \f
3379 /* Interface functions. */
3380
3381 static bool
3382 iface_is_internal(const struct ovsrec_interface *iface,
3383                   const struct ovsrec_bridge *br)
3384 {
3385     /* The local port and "internal" ports are always "internal". */
3386     return !strcmp(iface->type, "internal") || !strcmp(iface->name, br->name);
3387 }
3388
3389 /* Returns the correct network device type for interface 'iface' in bridge
3390  * 'br'. */
3391 static const char *
3392 iface_get_type(const struct ovsrec_interface *iface,
3393                const struct ovsrec_bridge *br)
3394 {
3395     const char *type;
3396
3397     /* The local port always has type "internal".  Other ports take
3398      * their type from the database and default to "system" if none is
3399      * specified. */
3400     if (iface_is_internal(iface, br)) {
3401         type = "internal";
3402     } else {
3403         type = iface->type[0] ? iface->type : "system";
3404     }
3405
3406     return ofproto_port_open_type(br->datapath_type, type);
3407 }
3408
3409 static void
3410 iface_destroy__(struct iface *iface)
3411 {
3412     if (iface) {
3413         struct port *port = iface->port;
3414         struct bridge *br = port->bridge;
3415
3416         if (br->ofproto && iface->ofp_port != OFPP_NONE) {
3417             ofproto_port_unregister(br->ofproto, iface->ofp_port);
3418         }
3419
3420         if (iface->ofp_port != OFPP_NONE) {
3421             hmap_remove(&br->ifaces, &iface->ofp_port_node);
3422         }
3423
3424         list_remove(&iface->port_elem);
3425         hmap_remove(&br->iface_by_name, &iface->name_node);
3426
3427         netdev_close(iface->netdev);
3428
3429         free(iface->name);
3430         free(iface);
3431     }
3432 }
3433
3434 static void
3435 iface_destroy(struct iface *iface)
3436 {
3437     if (iface) {
3438         struct port *port = iface->port;
3439
3440         iface_destroy__(iface);
3441         if (list_is_empty(&port->ifaces)) {
3442             port_destroy(port);
3443         }
3444     }
3445 }
3446
3447 static struct iface *
3448 iface_lookup(const struct bridge *br, const char *name)
3449 {
3450     struct iface *iface;
3451
3452     HMAP_FOR_EACH_WITH_HASH (iface, name_node, hash_string(name, 0),
3453                              &br->iface_by_name) {
3454         if (!strcmp(iface->name, name)) {
3455             return iface;
3456         }
3457     }
3458
3459     return NULL;
3460 }
3461
3462 static struct iface *
3463 iface_find(const char *name)
3464 {
3465     const struct bridge *br;
3466
3467     HMAP_FOR_EACH (br, node, &all_bridges) {
3468         struct iface *iface = iface_lookup(br, name);
3469
3470         if (iface) {
3471             return iface;
3472         }
3473     }
3474     return NULL;
3475 }
3476
3477 static struct iface *
3478 iface_from_ofp_port(const struct bridge *br, ofp_port_t ofp_port)
3479 {
3480     struct iface *iface;
3481
3482     HMAP_FOR_EACH_IN_BUCKET (iface, ofp_port_node, hash_ofp_port(ofp_port),
3483                              &br->ifaces) {
3484         if (iface->ofp_port == ofp_port) {
3485             return iface;
3486         }
3487     }
3488     return NULL;
3489 }
3490
3491 /* Set Ethernet address of 'iface', if one is specified in the configuration
3492  * file. */
3493 static void
3494 iface_set_mac(struct iface *iface)
3495 {
3496     uint8_t ea[ETH_ADDR_LEN];
3497
3498     if (!strcmp(iface->type, "internal")
3499         && iface->cfg->mac && eth_addr_from_string(iface->cfg->mac, ea)) {
3500         if (iface->ofp_port == OFPP_LOCAL) {
3501             VLOG_ERR("interface %s: ignoring mac in Interface record "
3502                      "(use Bridge record to set local port's mac)",
3503                      iface->name);
3504         } else if (eth_addr_is_multicast(ea)) {
3505             VLOG_ERR("interface %s: cannot set MAC to multicast address",
3506                      iface->name);
3507         } else {
3508             int error = netdev_set_etheraddr(iface->netdev, ea);
3509             if (error) {
3510                 VLOG_ERR("interface %s: setting MAC failed (%s)",
3511                          iface->name, ovs_strerror(error));
3512             }
3513         }
3514     }
3515 }
3516
3517 /* Sets the ofport column of 'if_cfg' to 'ofport'. */
3518 static void
3519 iface_set_ofport(const struct ovsrec_interface *if_cfg, ofp_port_t ofport)
3520 {
3521     if (if_cfg && !ovsdb_idl_row_is_synthetic(&if_cfg->header_)) {
3522         int64_t port = ofport == OFPP_NONE ? -1 : ofp_to_u16(ofport);
3523         ovsrec_interface_set_ofport(if_cfg, &port, 1);
3524     }
3525 }
3526
3527 /* Clears all of the fields in 'if_cfg' that indicate interface status, and
3528  * sets the "ofport" field to -1.
3529  *
3530  * This is appropriate when 'if_cfg''s interface cannot be created or is
3531  * otherwise invalid. */
3532 static void
3533 iface_clear_db_record(const struct ovsrec_interface *if_cfg)
3534 {
3535     if (!ovsdb_idl_row_is_synthetic(&if_cfg->header_)) {
3536         ovsrec_interface_set_status(if_cfg, NULL);
3537         ovsrec_interface_set_admin_state(if_cfg, NULL);
3538         ovsrec_interface_set_duplex(if_cfg, NULL);
3539         ovsrec_interface_set_link_speed(if_cfg, NULL, 0);
3540         ovsrec_interface_set_link_state(if_cfg, NULL);
3541         ovsrec_interface_set_mac_in_use(if_cfg, NULL);
3542         ovsrec_interface_set_mtu(if_cfg, NULL, 0);
3543         ovsrec_interface_set_cfm_fault(if_cfg, NULL, 0);
3544         ovsrec_interface_set_cfm_fault_status(if_cfg, NULL, 0);
3545         ovsrec_interface_set_cfm_remote_mpids(if_cfg, NULL, 0);
3546         ovsrec_interface_set_lacp_current(if_cfg, NULL, 0);
3547         ovsrec_interface_set_statistics(if_cfg, NULL, NULL, 0);
3548         ovsrec_interface_set_ifindex(if_cfg, NULL, 0);
3549     }
3550 }
3551
3552 static bool
3553 queue_ids_include(const struct ovsdb_datum *queues, int64_t target)
3554 {
3555     union ovsdb_atom atom;
3556
3557     atom.integer = target;
3558     return ovsdb_datum_find_key(queues, &atom, OVSDB_TYPE_INTEGER) != UINT_MAX;
3559 }
3560
3561 static void
3562 iface_configure_qos(struct iface *iface, const struct ovsrec_qos *qos)
3563 {
3564     struct ofpbuf queues_buf;
3565
3566     ofpbuf_init(&queues_buf, 0);
3567
3568     if (!qos || qos->type[0] == '\0' || qos->n_queues < 1) {
3569         netdev_set_qos(iface->netdev, NULL, NULL);
3570     } else {
3571         const struct ovsdb_datum *queues;
3572         struct netdev_queue_dump dump;
3573         unsigned int queue_id;
3574         struct smap details;
3575         bool queue_zero;
3576         size_t i;
3577
3578         /* Configure top-level Qos for 'iface'. */
3579         netdev_set_qos(iface->netdev, qos->type, &qos->other_config);
3580
3581         /* Deconfigure queues that were deleted. */
3582         queues = ovsrec_qos_get_queues(qos, OVSDB_TYPE_INTEGER,
3583                                        OVSDB_TYPE_UUID);
3584         smap_init(&details);
3585         NETDEV_QUEUE_FOR_EACH (&queue_id, &details, &dump, iface->netdev) {
3586             if (!queue_ids_include(queues, queue_id)) {
3587                 netdev_delete_queue(iface->netdev, queue_id);
3588             }
3589         }
3590         smap_destroy(&details);
3591
3592         /* Configure queues for 'iface'. */
3593         queue_zero = false;
3594         for (i = 0; i < qos->n_queues; i++) {
3595             const struct ovsrec_queue *queue = qos->value_queues[i];
3596             unsigned int queue_id = qos->key_queues[i];
3597
3598             if (queue_id == 0) {
3599                 queue_zero = true;
3600             }
3601
3602             if (queue->n_dscp == 1) {
3603                 struct ofproto_port_queue *port_queue;
3604
3605                 port_queue = ofpbuf_put_uninit(&queues_buf,
3606                                                sizeof *port_queue);
3607                 port_queue->queue = queue_id;
3608                 port_queue->dscp = queue->dscp[0];
3609             }
3610
3611             netdev_set_queue(iface->netdev, queue_id, &queue->other_config);
3612         }
3613         if (!queue_zero) {
3614             struct smap details;
3615
3616             smap_init(&details);
3617             netdev_set_queue(iface->netdev, 0, &details);
3618             smap_destroy(&details);
3619         }
3620     }
3621
3622     if (iface->ofp_port != OFPP_NONE) {
3623         const struct ofproto_port_queue *port_queues = queues_buf.data;
3624         size_t n_queues = queues_buf.size / sizeof *port_queues;
3625
3626         ofproto_port_set_queues(iface->port->bridge->ofproto, iface->ofp_port,
3627                                 port_queues, n_queues);
3628     }
3629
3630     netdev_set_policing(iface->netdev,
3631                         iface->cfg->ingress_policing_rate,
3632                         iface->cfg->ingress_policing_burst);
3633
3634     ofpbuf_uninit(&queues_buf);
3635 }
3636
3637 static void
3638 iface_configure_cfm(struct iface *iface)
3639 {
3640     const struct ovsrec_interface *cfg = iface->cfg;
3641     const char *opstate_str;
3642     const char *cfm_ccm_vlan;
3643     struct cfm_settings s;
3644     struct smap netdev_args;
3645
3646     if (!cfg->n_cfm_mpid) {
3647         ofproto_port_clear_cfm(iface->port->bridge->ofproto, iface->ofp_port);
3648         return;
3649     }
3650
3651     s.check_tnl_key = false;
3652     smap_init(&netdev_args);
3653     if (!netdev_get_config(iface->netdev, &netdev_args)) {
3654         const char *key = smap_get(&netdev_args, "key");
3655         const char *in_key = smap_get(&netdev_args, "in_key");
3656
3657         s.check_tnl_key = (key && !strcmp(key, "flow"))
3658                            || (in_key && !strcmp(in_key, "flow"));
3659     }
3660     smap_destroy(&netdev_args);
3661
3662     s.mpid = *cfg->cfm_mpid;
3663     s.interval = smap_get_int(&iface->cfg->other_config, "cfm_interval", 0);
3664     cfm_ccm_vlan = smap_get(&iface->cfg->other_config, "cfm_ccm_vlan");
3665     s.ccm_pcp = smap_get_int(&iface->cfg->other_config, "cfm_ccm_pcp", 0);
3666
3667     if (s.interval <= 0) {
3668         s.interval = 1000;
3669     }
3670
3671     if (!cfm_ccm_vlan) {
3672         s.ccm_vlan = 0;
3673     } else if (!strcasecmp("random", cfm_ccm_vlan)) {
3674         s.ccm_vlan = CFM_RANDOM_VLAN;
3675     } else {
3676         s.ccm_vlan = atoi(cfm_ccm_vlan);
3677         if (s.ccm_vlan == CFM_RANDOM_VLAN) {
3678             s.ccm_vlan = 0;
3679         }
3680     }
3681
3682     s.extended = smap_get_bool(&iface->cfg->other_config, "cfm_extended",
3683                                false);
3684     s.demand = smap_get_bool(&iface->cfg->other_config, "cfm_demand", false);
3685
3686     opstate_str = smap_get(&iface->cfg->other_config, "cfm_opstate");
3687     s.opup = !opstate_str || !strcasecmp("up", opstate_str);
3688
3689     ofproto_port_set_cfm(iface->port->bridge->ofproto, iface->ofp_port, &s);
3690 }
3691
3692 /* Returns true if 'iface' is synthetic, that is, if we constructed it locally
3693  * instead of obtaining it from the database. */
3694 static bool
3695 iface_is_synthetic(const struct iface *iface)
3696 {
3697     return ovsdb_idl_row_is_synthetic(&iface->cfg->header_);
3698 }
3699
3700 static ofp_port_t
3701 iface_validate_ofport__(size_t n, int64_t *ofport)
3702 {
3703     return (n && *ofport >= 1 && *ofport < ofp_to_u16(OFPP_MAX)
3704             ? u16_to_ofp(*ofport)
3705             : OFPP_NONE);
3706 }
3707
3708 static ofp_port_t
3709 iface_get_requested_ofp_port(const struct ovsrec_interface *cfg)
3710 {
3711     return iface_validate_ofport__(cfg->n_ofport_request, cfg->ofport_request);
3712 }
3713
3714 static ofp_port_t
3715 iface_pick_ofport(const struct ovsrec_interface *cfg)
3716 {
3717     ofp_port_t requested_ofport = iface_get_requested_ofp_port(cfg);
3718     return (requested_ofport != OFPP_NONE
3719             ? requested_ofport
3720             : iface_validate_ofport__(cfg->n_ofport, cfg->ofport));
3721 }
3722 \f
3723 /* Port mirroring. */
3724
3725 static struct mirror *
3726 mirror_find_by_uuid(struct bridge *br, const struct uuid *uuid)
3727 {
3728     struct mirror *m;
3729
3730     HMAP_FOR_EACH_IN_BUCKET (m, hmap_node, uuid_hash(uuid), &br->mirrors) {
3731         if (uuid_equals(uuid, &m->uuid)) {
3732             return m;
3733         }
3734     }
3735     return NULL;
3736 }
3737
3738 static void
3739 bridge_configure_mirrors(struct bridge *br)
3740 {
3741     const struct ovsdb_datum *mc;
3742     unsigned long *flood_vlans;
3743     struct mirror *m, *next;
3744     size_t i;
3745
3746     /* Get rid of deleted mirrors. */
3747     mc = ovsrec_bridge_get_mirrors(br->cfg, OVSDB_TYPE_UUID);
3748     HMAP_FOR_EACH_SAFE (m, next, hmap_node, &br->mirrors) {
3749         union ovsdb_atom atom;
3750
3751         atom.uuid = m->uuid;
3752         if (ovsdb_datum_find_key(mc, &atom, OVSDB_TYPE_UUID) == UINT_MAX) {
3753             mirror_destroy(m);
3754         }
3755     }
3756
3757     /* Add new mirrors and reconfigure existing ones. */
3758     for (i = 0; i < br->cfg->n_mirrors; i++) {
3759         const struct ovsrec_mirror *cfg = br->cfg->mirrors[i];
3760         struct mirror *m = mirror_find_by_uuid(br, &cfg->header_.uuid);
3761         if (!m) {
3762             m = mirror_create(br, cfg);
3763         }
3764         m->cfg = cfg;
3765         if (!mirror_configure(m)) {
3766             mirror_destroy(m);
3767         }
3768     }
3769
3770     /* Update flooded vlans (for RSPAN). */
3771     flood_vlans = vlan_bitmap_from_array(br->cfg->flood_vlans,
3772                                          br->cfg->n_flood_vlans);
3773     ofproto_set_flood_vlans(br->ofproto, flood_vlans);
3774     bitmap_free(flood_vlans);
3775 }
3776
3777 static struct mirror *
3778 mirror_create(struct bridge *br, const struct ovsrec_mirror *cfg)
3779 {
3780     struct mirror *m;
3781
3782     m = xzalloc(sizeof *m);
3783     m->uuid = cfg->header_.uuid;
3784     hmap_insert(&br->mirrors, &m->hmap_node, uuid_hash(&m->uuid));
3785     m->bridge = br;
3786     m->name = xstrdup(cfg->name);
3787
3788     return m;
3789 }
3790
3791 static void
3792 mirror_destroy(struct mirror *m)
3793 {
3794     if (m) {
3795         struct bridge *br = m->bridge;
3796
3797         if (br->ofproto) {
3798             ofproto_mirror_unregister(br->ofproto, m);
3799         }
3800
3801         hmap_remove(&br->mirrors, &m->hmap_node);
3802         free(m->name);
3803         free(m);
3804     }
3805 }
3806
3807 static void
3808 mirror_collect_ports(struct mirror *m,
3809                      struct ovsrec_port **in_ports, int n_in_ports,
3810                      void ***out_portsp, size_t *n_out_portsp)
3811 {
3812     void **out_ports = xmalloc(n_in_ports * sizeof *out_ports);
3813     size_t n_out_ports = 0;
3814     size_t i;
3815
3816     for (i = 0; i < n_in_ports; i++) {
3817         const char *name = in_ports[i]->name;
3818         struct port *port = port_lookup(m->bridge, name);
3819         if (port) {
3820             out_ports[n_out_ports++] = port;
3821         } else {
3822             VLOG_WARN("bridge %s: mirror %s cannot match on nonexistent "
3823                       "port %s", m->bridge->name, m->name, name);
3824         }
3825     }
3826     *out_portsp = out_ports;
3827     *n_out_portsp = n_out_ports;
3828 }
3829
3830 static bool
3831 mirror_configure(struct mirror *m)
3832 {
3833     const struct ovsrec_mirror *cfg = m->cfg;
3834     struct ofproto_mirror_settings s;
3835
3836     /* Set name. */
3837     if (strcmp(cfg->name, m->name)) {
3838         free(m->name);
3839         m->name = xstrdup(cfg->name);
3840     }
3841     s.name = m->name;
3842
3843     /* Get output port or VLAN. */
3844     if (cfg->output_port) {
3845         s.out_bundle = port_lookup(m->bridge, cfg->output_port->name);
3846         if (!s.out_bundle) {
3847             VLOG_ERR("bridge %s: mirror %s outputs to port not on bridge",
3848                      m->bridge->name, m->name);
3849             return false;
3850         }
3851         s.out_vlan = UINT16_MAX;
3852
3853         if (cfg->output_vlan) {
3854             VLOG_ERR("bridge %s: mirror %s specifies both output port and "
3855                      "output vlan; ignoring output vlan",
3856                      m->bridge->name, m->name);
3857         }
3858     } else if (cfg->output_vlan) {
3859         /* The database should prevent invalid VLAN values. */
3860         s.out_bundle = NULL;
3861         s.out_vlan = *cfg->output_vlan;
3862     } else {
3863         VLOG_ERR("bridge %s: mirror %s does not specify output; ignoring",
3864                  m->bridge->name, m->name);
3865         return false;
3866     }
3867
3868     /* Get port selection. */
3869     if (cfg->select_all) {
3870         size_t n_ports = hmap_count(&m->bridge->ports);
3871         void **ports = xmalloc(n_ports * sizeof *ports);
3872         struct port *port;
3873         size_t i;
3874
3875         i = 0;
3876         HMAP_FOR_EACH (port, hmap_node, &m->bridge->ports) {
3877             ports[i++] = port;
3878         }
3879
3880         s.srcs = ports;
3881         s.n_srcs = n_ports;
3882
3883         s.dsts = ports;
3884         s.n_dsts = n_ports;
3885     } else {
3886         /* Get ports, dropping ports that don't exist.
3887          * The IDL ensures that there are no duplicates. */
3888         mirror_collect_ports(m, cfg->select_src_port, cfg->n_select_src_port,
3889                              &s.srcs, &s.n_srcs);
3890         mirror_collect_ports(m, cfg->select_dst_port, cfg->n_select_dst_port,
3891                              &s.dsts, &s.n_dsts);
3892     }
3893
3894     /* Get VLAN selection. */
3895     s.src_vlans = vlan_bitmap_from_array(cfg->select_vlan, cfg->n_select_vlan);
3896
3897     /* Configure. */
3898     ofproto_mirror_register(m->bridge->ofproto, m, &s);
3899
3900     /* Clean up. */
3901     if (s.srcs != s.dsts) {
3902         free(s.dsts);
3903     }
3904     free(s.srcs);
3905     free(s.src_vlans);
3906
3907     return true;
3908 }
3909 \f
3910 /* Linux VLAN device support (e.g. "eth0.10" for VLAN 10.)
3911  *
3912  * This is deprecated.  It is only for compatibility with broken device drivers
3913  * in old versions of Linux that do not properly support VLANs when VLAN
3914  * devices are not used.  When broken device drivers are no longer in
3915  * widespread use, we will delete these interfaces. */
3916
3917 static struct ovsrec_port **recs;
3918 static size_t n_recs, allocated_recs;
3919
3920 /* Adds 'rec' to a list of recs that have to be destroyed when the VLAN
3921  * splinters are reconfigured. */
3922 static void
3923 register_rec(struct ovsrec_port *rec)
3924 {
3925     if (n_recs >= allocated_recs) {
3926         recs = x2nrealloc(recs, &allocated_recs, sizeof *recs);
3927     }
3928     recs[n_recs++] = rec;
3929 }
3930
3931 /* Frees all of the ports registered with register_reg(). */
3932 static void
3933 free_registered_recs(void)
3934 {
3935     size_t i;
3936
3937     for (i = 0; i < n_recs; i++) {
3938         struct ovsrec_port *port = recs[i];
3939         size_t j;
3940
3941         for (j = 0; j < port->n_interfaces; j++) {
3942             struct ovsrec_interface *iface = port->interfaces[j];
3943             free(iface->name);
3944             free(iface);
3945         }
3946
3947         smap_destroy(&port->other_config);
3948         free(port->interfaces);
3949         free(port->name);
3950         free(port->tag);
3951         free(port);
3952     }
3953     n_recs = 0;
3954 }
3955
3956 /* Returns true if VLAN splinters are enabled on 'iface_cfg', false
3957  * otherwise. */
3958 static bool
3959 vlan_splinters_is_enabled(const struct ovsrec_interface *iface_cfg)
3960 {
3961     return smap_get_bool(&iface_cfg->other_config, "enable-vlan-splinters",
3962                          false);
3963 }
3964
3965 /* Figures out the set of VLANs that are in use for the purpose of VLAN
3966  * splinters.
3967  *
3968  * If VLAN splinters are enabled on at least one interface and any VLANs are in
3969  * use, returns a 4096-bit bitmap with a 1-bit for each in-use VLAN (bits 0 and
3970  * 4095 will not be set).  The caller is responsible for freeing the bitmap,
3971  * with free().
3972  *
3973  * If VLANs splinters are not enabled on any interface or if no VLANs are in
3974  * use, returns NULL.
3975  *
3976  * Updates 'vlan_splinters_enabled_anywhere'. */
3977 static unsigned long int *
3978 collect_splinter_vlans(const struct ovsrec_open_vswitch *ovs_cfg)
3979 {
3980     unsigned long int *splinter_vlans;
3981     struct sset splinter_ifaces;
3982     const char *real_dev_name;
3983     struct shash *real_devs;
3984     struct shash_node *node;
3985     struct bridge *br;
3986     size_t i;
3987
3988     /* Free space allocated for synthesized ports and interfaces, since we're
3989      * in the process of reconstructing all of them. */
3990     free_registered_recs();
3991
3992     splinter_vlans = bitmap_allocate(4096);
3993     sset_init(&splinter_ifaces);
3994     vlan_splinters_enabled_anywhere = false;
3995     for (i = 0; i < ovs_cfg->n_bridges; i++) {
3996         struct ovsrec_bridge *br_cfg = ovs_cfg->bridges[i];
3997         size_t j;
3998
3999         for (j = 0; j < br_cfg->n_ports; j++) {
4000             struct ovsrec_port *port_cfg = br_cfg->ports[j];
4001             int k;
4002
4003             for (k = 0; k < port_cfg->n_interfaces; k++) {
4004                 struct ovsrec_interface *iface_cfg = port_cfg->interfaces[k];
4005
4006                 if (vlan_splinters_is_enabled(iface_cfg)) {
4007                     vlan_splinters_enabled_anywhere = true;
4008                     sset_add(&splinter_ifaces, iface_cfg->name);
4009                     vlan_bitmap_from_array__(port_cfg->trunks,
4010                                              port_cfg->n_trunks,
4011                                              splinter_vlans);
4012                 }
4013             }
4014
4015             if (port_cfg->tag && *port_cfg->tag > 0 && *port_cfg->tag < 4095) {
4016                 bitmap_set1(splinter_vlans, *port_cfg->tag);
4017             }
4018         }
4019     }
4020
4021     if (!vlan_splinters_enabled_anywhere) {
4022         free(splinter_vlans);
4023         sset_destroy(&splinter_ifaces);
4024         return NULL;
4025     }
4026
4027     HMAP_FOR_EACH (br, node, &all_bridges) {
4028         if (br->ofproto) {
4029             ofproto_get_vlan_usage(br->ofproto, splinter_vlans);
4030         }
4031     }
4032
4033     /* Don't allow VLANs 0 or 4095 to be splintered.  VLAN 0 should appear on
4034      * the real device.  VLAN 4095 is reserved and Linux doesn't allow a VLAN
4035      * device to be created for it. */
4036     bitmap_set0(splinter_vlans, 0);
4037     bitmap_set0(splinter_vlans, 4095);
4038
4039     /* Delete all VLAN devices that we don't need. */
4040     vlandev_refresh();
4041     real_devs = vlandev_get_real_devs();
4042     SHASH_FOR_EACH (node, real_devs) {
4043         const struct vlan_real_dev *real_dev = node->data;
4044         const struct vlan_dev *vlan_dev;
4045         bool real_dev_has_splinters;
4046
4047         real_dev_has_splinters = sset_contains(&splinter_ifaces,
4048                                                real_dev->name);
4049         HMAP_FOR_EACH (vlan_dev, hmap_node, &real_dev->vlan_devs) {
4050             if (!real_dev_has_splinters
4051                 || !bitmap_is_set(splinter_vlans, vlan_dev->vid)) {
4052                 struct netdev *netdev;
4053
4054                 if (!netdev_open(vlan_dev->name, "system", &netdev)) {
4055                     if (!netdev_get_in4(netdev, NULL, NULL) ||
4056                         !netdev_get_in6(netdev, NULL)) {
4057                         /* It has an IP address configured, so we don't own
4058                          * it.  Don't delete it. */
4059                     } else {
4060                         vlandev_del(vlan_dev->name);
4061                     }
4062                     netdev_close(netdev);
4063                 }
4064             }
4065
4066         }
4067     }
4068
4069     /* Add all VLAN devices that we need. */
4070     SSET_FOR_EACH (real_dev_name, &splinter_ifaces) {
4071         int vid;
4072
4073         BITMAP_FOR_EACH_1 (vid, 4096, splinter_vlans) {
4074             if (!vlandev_get_name(real_dev_name, vid)) {
4075                 vlandev_add(real_dev_name, vid);
4076             }
4077         }
4078     }
4079
4080     vlandev_refresh();
4081
4082     sset_destroy(&splinter_ifaces);
4083
4084     if (bitmap_scan(splinter_vlans, 0, 4096) >= 4096) {
4085         free(splinter_vlans);
4086         return NULL;
4087     }
4088     return splinter_vlans;
4089 }
4090
4091 /* Pushes the configure of VLAN splinter port 'port' (e.g. eth0.9) down to
4092  * ofproto.  */
4093 static void
4094 configure_splinter_port(struct port *port)
4095 {
4096     struct ofproto *ofproto = port->bridge->ofproto;
4097     ofp_port_t realdev_ofp_port;
4098     const char *realdev_name;
4099     struct iface *vlandev, *realdev;
4100
4101     ofproto_bundle_unregister(port->bridge->ofproto, port);
4102
4103     vlandev = CONTAINER_OF(list_front(&port->ifaces), struct iface,
4104                            port_elem);
4105
4106     realdev_name = smap_get(&port->cfg->other_config, "realdev");
4107     realdev = iface_lookup(port->bridge, realdev_name);
4108     realdev_ofp_port = realdev ? realdev->ofp_port : 0;
4109
4110     ofproto_port_set_realdev(ofproto, vlandev->ofp_port, realdev_ofp_port,
4111                              *port->cfg->tag);
4112 }
4113
4114 static struct ovsrec_port *
4115 synthesize_splinter_port(const char *real_dev_name,
4116                          const char *vlan_dev_name, int vid)
4117 {
4118     struct ovsrec_interface *iface;
4119     struct ovsrec_port *port;
4120
4121     iface = xmalloc(sizeof *iface);
4122     ovsrec_interface_init(iface);
4123     iface->name = xstrdup(vlan_dev_name);
4124     iface->type = "system";
4125
4126     port = xmalloc(sizeof *port);
4127     ovsrec_port_init(port);
4128     port->interfaces = xmemdup(&iface, sizeof iface);
4129     port->n_interfaces = 1;
4130     port->name = xstrdup(vlan_dev_name);
4131     port->vlan_mode = "splinter";
4132     port->tag = xmalloc(sizeof *port->tag);
4133     *port->tag = vid;
4134
4135     smap_add(&port->other_config, "realdev", real_dev_name);
4136
4137     register_rec(port);
4138     return port;
4139 }
4140
4141 /* For each interface with 'br' that has VLAN splinters enabled, adds a
4142  * corresponding ovsrec_port to 'ports' for each splinter VLAN marked with a
4143  * 1-bit in the 'splinter_vlans' bitmap. */
4144 static void
4145 add_vlan_splinter_ports(struct bridge *br,
4146                         const unsigned long int *splinter_vlans,
4147                         struct shash *ports)
4148 {
4149     size_t i;
4150
4151     /* We iterate through 'br->cfg->ports' instead of 'ports' here because
4152      * we're modifying 'ports'. */
4153     for (i = 0; i < br->cfg->n_ports; i++) {
4154         const char *name = br->cfg->ports[i]->name;
4155         struct ovsrec_port *port_cfg = shash_find_data(ports, name);
4156         size_t j;
4157
4158         for (j = 0; j < port_cfg->n_interfaces; j++) {
4159             struct ovsrec_interface *iface_cfg = port_cfg->interfaces[j];
4160
4161             if (vlan_splinters_is_enabled(iface_cfg)) {
4162                 const char *real_dev_name;
4163                 uint16_t vid;
4164
4165                 real_dev_name = iface_cfg->name;
4166                 BITMAP_FOR_EACH_1 (vid, 4096, splinter_vlans) {
4167                     const char *vlan_dev_name;
4168
4169                     vlan_dev_name = vlandev_get_name(real_dev_name, vid);
4170                     if (vlan_dev_name
4171                         && !shash_find(ports, vlan_dev_name)) {
4172                         shash_add(ports, vlan_dev_name,
4173                                   synthesize_splinter_port(
4174                                       real_dev_name, vlan_dev_name, vid));
4175                     }
4176                 }
4177             }
4178         }
4179     }
4180 }
4181
4182 static void
4183 mirror_refresh_stats(struct mirror *m)
4184 {
4185     struct ofproto *ofproto = m->bridge->ofproto;
4186     uint64_t tx_packets, tx_bytes;
4187     char *keys[2];
4188     int64_t values[2];
4189     size_t stat_cnt = 0;
4190
4191     if (ofproto_mirror_get_stats(ofproto, m, &tx_packets, &tx_bytes)) {
4192         ovsrec_mirror_set_statistics(m->cfg, NULL, NULL, 0);
4193         return;
4194     }
4195
4196     if (tx_packets != UINT64_MAX) {
4197         keys[stat_cnt] = "tx_packets";
4198         values[stat_cnt] = tx_packets;
4199         stat_cnt++;
4200     }
4201     if (tx_bytes != UINT64_MAX) {
4202         keys[stat_cnt] = "tx_bytes";
4203         values[stat_cnt] = tx_bytes;
4204         stat_cnt++;
4205     }
4206
4207     ovsrec_mirror_set_statistics(m->cfg, keys, values, stat_cnt);
4208 }