cfm: Cleanup CFM module interface.
[sliver-openvswitch.git] / vswitchd / bridge.c
1 /* Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks
2  *
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at:
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15
16 #include <config.h>
17 #include "bridge.h"
18 #include <assert.h>
19 #include <errno.h>
20 #include <inttypes.h>
21 #include <stdlib.h>
22 #include "bitmap.h"
23 #include "bond.h"
24 #include "cfm.h"
25 #include "coverage.h"
26 #include "daemon.h"
27 #include "dirs.h"
28 #include "dynamic-string.h"
29 #include "hash.h"
30 #include "hmap.h"
31 #include "jsonrpc.h"
32 #include "lacp.h"
33 #include "list.h"
34 #include "netdev.h"
35 #include "ofp-print.h"
36 #include "ofpbuf.h"
37 #include "ofproto/ofproto.h"
38 #include "poll-loop.h"
39 #include "sha1.h"
40 #include "shash.h"
41 #include "socket-util.h"
42 #include "stream-ssl.h"
43 #include "sset.h"
44 #include "system-stats.h"
45 #include "timeval.h"
46 #include "util.h"
47 #include "unixctl.h"
48 #include "vswitchd/vswitch-idl.h"
49 #include "xenserver.h"
50 #include "vlog.h"
51 #include "sflow_api.h"
52 #include "vlan-bitmap.h"
53
54 VLOG_DEFINE_THIS_MODULE(bridge);
55
56 COVERAGE_DEFINE(bridge_reconfigure);
57
58 struct iface {
59     /* These members are always valid. */
60     struct list port_elem;      /* Element in struct port's "ifaces" list. */
61     struct hmap_node name_node; /* In struct bridge's "iface_by_name" hmap. */
62     struct port *port;          /* Containing port. */
63     char *name;                 /* Host network device name. */
64     tag_type tag;               /* Tag associated with this interface. */
65
66     /* These members are valid only after bridge_reconfigure() causes them to
67      * be initialized. */
68     struct hmap_node ofp_port_node; /* In struct bridge's "ifaces" hmap. */
69     int ofp_port;               /* OpenFlow port number, -1 if unknown. */
70     struct netdev *netdev;      /* Network device. */
71     const char *type;           /* Usually same as cfg->type. */
72     const struct ovsrec_interface *cfg;
73 };
74
75 struct mirror {
76     struct uuid uuid;           /* UUID of this "mirror" record in database. */
77     struct hmap_node hmap_node; /* In struct bridge's "mirrors" hmap. */
78     struct bridge *bridge;
79     char *name;
80 };
81
82 struct port {
83     struct bridge *bridge;
84     struct hmap_node hmap_node; /* Element in struct bridge's "ports" hmap. */
85     char *name;
86
87     const struct ovsrec_port *cfg;
88
89     /* An ordinary bridge port has 1 interface.
90      * A bridge port for bonding has at least 2 interfaces. */
91     struct list ifaces;         /* List of "struct iface"s. */
92 };
93
94 struct bridge {
95     struct hmap_node node;      /* In 'all_bridges'. */
96     char *name;                 /* User-specified arbitrary name. */
97     char *type;                 /* Datapath type. */
98     uint8_t ea[ETH_ADDR_LEN];   /* Bridge Ethernet Address. */
99     uint8_t default_ea[ETH_ADDR_LEN]; /* Default MAC. */
100     const struct ovsrec_bridge *cfg;
101
102     /* OpenFlow switch processing. */
103     struct ofproto *ofproto;    /* OpenFlow switch. */
104
105     /* Bridge ports. */
106     struct hmap ports;          /* "struct port"s indexed by name. */
107     struct hmap ifaces;         /* "struct iface"s indexed by ofp_port. */
108     struct hmap iface_by_name;  /* "struct iface"s indexed by name. */
109
110     /* Port mirroring. */
111     struct hmap mirrors;        /* "struct mirror" indexed by UUID. */
112
113     /* Synthetic local port if necessary. */
114     struct ovsrec_port synth_local_port;
115     struct ovsrec_interface synth_local_iface;
116     struct ovsrec_interface *synth_local_ifacep;
117 };
118
119 /* All bridges, indexed by name. */
120 static struct hmap all_bridges = HMAP_INITIALIZER(&all_bridges);
121
122 /* OVSDB IDL used to obtain configuration. */
123 static struct ovsdb_idl *idl;
124
125 /* Each time this timer expires, the bridge fetches systems and interface
126  * statistics and pushes them into the database. */
127 #define STATS_INTERVAL (5 * 1000) /* In milliseconds. */
128 static long long int stats_timer = LLONG_MIN;
129
130 /* Stores the time after which rate limited statistics may be written to the
131  * database.  Only updated when changes to the database require rate limiting.
132  */
133 #define DB_LIMIT_INTERVAL (1 * 1000) /* In milliseconds. */
134 static long long int db_limiter = LLONG_MIN;
135
136 static void add_del_bridges(const struct ovsrec_open_vswitch *);
137 static void bridge_del_ofprotos(void);
138 static bool bridge_add_ofprotos(struct bridge *);
139 static void bridge_create(const struct ovsrec_bridge *);
140 static void bridge_destroy(struct bridge *);
141 static struct bridge *bridge_lookup(const char *name);
142 static unixctl_cb_func bridge_unixctl_dump_flows;
143 static unixctl_cb_func bridge_unixctl_reconnect;
144 static size_t bridge_get_controllers(const struct bridge *br,
145                                      struct ovsrec_controller ***controllersp);
146 static void bridge_add_del_ports(struct bridge *);
147 static void bridge_add_ofproto_ports(struct bridge *);
148 static void bridge_del_ofproto_ports(struct bridge *);
149 static void bridge_refresh_ofp_port(struct bridge *);
150 static void bridge_configure_datapath_id(struct bridge *);
151 static void bridge_configure_netflow(struct bridge *);
152 static void bridge_configure_sflow(struct bridge *, int *sflow_bridge_number);
153 static void bridge_configure_remotes(struct bridge *,
154                                      const struct sockaddr_in *managers,
155                                      size_t n_managers);
156 static void bridge_pick_local_hw_addr(struct bridge *,
157                                       uint8_t ea[ETH_ADDR_LEN],
158                                       struct iface **hw_addr_iface);
159 static uint64_t bridge_pick_datapath_id(struct bridge *,
160                                         const uint8_t bridge_ea[ETH_ADDR_LEN],
161                                         struct iface *hw_addr_iface);
162 static uint64_t dpid_from_hash(const void *, size_t nbytes);
163 static bool bridge_has_bond_fake_iface(const struct bridge *,
164                                        const char *name);
165 static bool port_is_bond_fake_iface(const struct port *);
166
167 static unixctl_cb_func qos_unixctl_show;
168
169 static struct port *port_create(struct bridge *, const struct ovsrec_port *);
170 static void port_add_ifaces(struct port *);
171 static void port_del_ifaces(struct port *);
172 static void port_destroy(struct port *);
173 static struct port *port_lookup(const struct bridge *, const char *name);
174 static void port_configure(struct port *);
175 static struct lacp_settings *port_configure_lacp(struct port *,
176                                                  struct lacp_settings *);
177 static void port_configure_bond(struct port *, struct bond_settings *,
178                                 uint32_t *bond_stable_ids);
179
180 static void bridge_configure_mirrors(struct bridge *);
181 static struct mirror *mirror_create(struct bridge *,
182                                     const struct ovsrec_mirror *);
183 static void mirror_destroy(struct mirror *);
184 static bool mirror_configure(struct mirror *, const struct ovsrec_mirror *);
185
186 static void iface_configure_lacp(struct iface *, struct lacp_slave_settings *);
187 static struct iface *iface_create(struct port *port,
188                                   const struct ovsrec_interface *if_cfg);
189 static void iface_destroy(struct iface *);
190 static struct iface *iface_lookup(const struct bridge *, const char *name);
191 static struct iface *iface_find(const char *name);
192 static struct iface *iface_from_ofp_port(const struct bridge *,
193                                          uint16_t ofp_port);
194 static void iface_set_mac(struct iface *);
195 static void iface_set_ofport(const struct ovsrec_interface *, int64_t ofport);
196 static void iface_configure_qos(struct iface *, const struct ovsrec_qos *);
197 static void iface_configure_cfm(struct iface *);
198 static bool iface_refresh_cfm_stats(struct iface *iface);
199 static bool iface_get_carrier(const struct iface *);
200 static bool iface_is_synthetic(const struct iface *);
201
202 static void shash_from_ovs_idl_map(char **keys, char **values, size_t n,
203                                    struct shash *);
204 static void shash_to_ovs_idl_map(struct shash *,
205                                  char ***keys, char ***values, size_t *n);
206 \f
207 /* Public functions. */
208
209 /* Initializes the bridge module, configuring it to obtain its configuration
210  * from an OVSDB server accessed over 'remote', which should be a string in a
211  * form acceptable to ovsdb_idl_create(). */
212 void
213 bridge_init(const char *remote)
214 {
215     /* Create connection to database. */
216     idl = ovsdb_idl_create(remote, &ovsrec_idl_class, true);
217
218     ovsdb_idl_omit_alert(idl, &ovsrec_open_vswitch_col_cur_cfg);
219     ovsdb_idl_omit_alert(idl, &ovsrec_open_vswitch_col_statistics);
220     ovsdb_idl_omit(idl, &ovsrec_open_vswitch_col_external_ids);
221     ovsdb_idl_omit(idl, &ovsrec_open_vswitch_col_ovs_version);
222     ovsdb_idl_omit(idl, &ovsrec_open_vswitch_col_db_version);
223     ovsdb_idl_omit(idl, &ovsrec_open_vswitch_col_system_type);
224     ovsdb_idl_omit(idl, &ovsrec_open_vswitch_col_system_version);
225
226     ovsdb_idl_omit_alert(idl, &ovsrec_bridge_col_datapath_id);
227     ovsdb_idl_omit(idl, &ovsrec_bridge_col_external_ids);
228
229     ovsdb_idl_omit(idl, &ovsrec_port_col_external_ids);
230     ovsdb_idl_omit(idl, &ovsrec_port_col_fake_bridge);
231
232     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_admin_state);
233     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_duplex);
234     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_link_speed);
235     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_link_state);
236     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_mtu);
237     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_ofport);
238     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_statistics);
239     ovsdb_idl_omit_alert(idl, &ovsrec_interface_col_status);
240     ovsdb_idl_omit(idl, &ovsrec_interface_col_external_ids);
241
242     ovsdb_idl_omit_alert(idl, &ovsrec_controller_col_is_connected);
243     ovsdb_idl_omit_alert(idl, &ovsrec_controller_col_role);
244     ovsdb_idl_omit_alert(idl, &ovsrec_controller_col_status);
245     ovsdb_idl_omit(idl, &ovsrec_controller_col_external_ids);
246
247     ovsdb_idl_omit(idl, &ovsrec_qos_col_external_ids);
248
249     ovsdb_idl_omit(idl, &ovsrec_queue_col_external_ids);
250
251     ovsdb_idl_omit(idl, &ovsrec_mirror_col_external_ids);
252
253     ovsdb_idl_omit(idl, &ovsrec_netflow_col_external_ids);
254
255     ovsdb_idl_omit(idl, &ovsrec_sflow_col_external_ids);
256
257     ovsdb_idl_omit(idl, &ovsrec_manager_col_external_ids);
258     ovsdb_idl_omit(idl, &ovsrec_manager_col_inactivity_probe);
259     ovsdb_idl_omit(idl, &ovsrec_manager_col_is_connected);
260     ovsdb_idl_omit(idl, &ovsrec_manager_col_max_backoff);
261     ovsdb_idl_omit(idl, &ovsrec_manager_col_status);
262
263     ovsdb_idl_omit(idl, &ovsrec_ssl_col_external_ids);
264
265     /* Register unixctl commands. */
266     unixctl_command_register("qos/show", qos_unixctl_show, NULL);
267     unixctl_command_register("bridge/dump-flows", bridge_unixctl_dump_flows,
268                              NULL);
269     unixctl_command_register("bridge/reconnect", bridge_unixctl_reconnect,
270                              NULL);
271     lacp_init();
272     bond_init();
273     cfm_init();
274 }
275
276 void
277 bridge_exit(void)
278 {
279     struct bridge *br, *next_br;
280
281     HMAP_FOR_EACH_SAFE (br, next_br, node, &all_bridges) {
282         bridge_destroy(br);
283     }
284     ovsdb_idl_destroy(idl);
285 }
286
287 /* Looks at the list of managers in 'ovs_cfg' and extracts their remote IP
288  * addresses and ports into '*managersp' and '*n_managersp'.  The caller is
289  * responsible for freeing '*managersp' (with free()).
290  *
291  * You may be asking yourself "why does ovs-vswitchd care?", because
292  * ovsdb-server is responsible for connecting to the managers, and ovs-vswitchd
293  * should not be and in fact is not directly involved in that.  But
294  * ovs-vswitchd needs to make sure that ovsdb-server can reach the managers, so
295  * it has to tell in-band control where the managers are to enable that.
296  * (Thus, only managers connected in-band are collected.)
297  */
298 static void
299 collect_in_band_managers(const struct ovsrec_open_vswitch *ovs_cfg,
300                          struct sockaddr_in **managersp, size_t *n_managersp)
301 {
302     struct sockaddr_in *managers = NULL;
303     size_t n_managers = 0;
304     struct sset targets;
305     size_t i;
306
307     /* Collect all of the potential targets from the "targets" columns of the
308      * rows pointed to by "manager_options", excluding any that are
309      * out-of-band. */
310     sset_init(&targets);
311     for (i = 0; i < ovs_cfg->n_manager_options; i++) {
312         struct ovsrec_manager *m = ovs_cfg->manager_options[i];
313
314         if (m->connection_mode && !strcmp(m->connection_mode, "out-of-band")) {
315             sset_find_and_delete(&targets, m->target);
316         } else {
317             sset_add(&targets, m->target);
318         }
319     }
320
321     /* Now extract the targets' IP addresses. */
322     if (!sset_is_empty(&targets)) {
323         const char *target;
324
325         managers = xmalloc(sset_count(&targets) * sizeof *managers);
326         SSET_FOR_EACH (target, &targets) {
327             struct sockaddr_in *sin = &managers[n_managers];
328
329             if ((!strncmp(target, "tcp:", 4)
330                  && inet_parse_active(target + 4, JSONRPC_TCP_PORT, sin)) ||
331                 (!strncmp(target, "ssl:", 4)
332                  && inet_parse_active(target + 4, JSONRPC_SSL_PORT, sin))) {
333                 n_managers++;
334             }
335         }
336     }
337     sset_destroy(&targets);
338
339     *managersp = managers;
340     *n_managersp = n_managers;
341 }
342
343 static void
344 bridge_reconfigure(const struct ovsrec_open_vswitch *ovs_cfg)
345 {
346     struct sockaddr_in *managers;
347     struct bridge *br, *next;
348     int sflow_bridge_number;
349     size_t n_managers;
350
351     COVERAGE_INC(bridge_reconfigure);
352
353     /* Create and destroy "struct bridge"s, "struct port"s, and "struct
354      * iface"s according to 'ovs_cfg', with only very minimal configuration
355      * otherwise.
356      *
357      * This is purely an update to bridge data structures.  Nothing is pushed
358      * down to ofproto or lower layers. */
359     add_del_bridges(ovs_cfg);
360     HMAP_FOR_EACH (br, node, &all_bridges) {
361         bridge_add_del_ports(br);
362     }
363
364     /* Delete all datapaths and datapath ports that are no longer configured.
365      *
366      * The kernel will reject any attempt to add a given port to a datapath if
367      * that port already belongs to a different datapath, so we must do all
368      * port deletions before any port additions.  A datapath always has a
369      * "local port" so we must delete not-configured datapaths too. */
370     bridge_del_ofprotos();
371     HMAP_FOR_EACH (br, node, &all_bridges) {
372         if (br->ofproto) {
373             bridge_del_ofproto_ports(br);
374         }
375     }
376
377     /* Create datapaths and datapath ports that are missing.
378      *
379      * After this is done, we have our final set of bridges, ports, and
380      * interfaces.  Every "struct bridge" has an ofproto, every "struct port"
381      * has at least one iface, every "struct iface" has a valid ofp_port and
382      * netdev. */
383     HMAP_FOR_EACH_SAFE (br, next, node, &all_bridges) {
384         if (!br->ofproto && !bridge_add_ofprotos(br)) {
385             bridge_destroy(br);
386         }
387     }
388     HMAP_FOR_EACH (br, node, &all_bridges) {
389         bridge_refresh_ofp_port(br);
390         bridge_add_ofproto_ports(br);
391     }
392
393     /* Complete the configuration. */
394     sflow_bridge_number = 0;
395     collect_in_band_managers(ovs_cfg, &managers, &n_managers);
396     HMAP_FOR_EACH (br, node, &all_bridges) {
397         struct port *port;
398
399         HMAP_FOR_EACH (port, hmap_node, &br->ports) {
400             struct iface *iface;
401
402             port_configure(port);
403
404             HMAP_FOR_EACH (iface, ofp_port_node, &br->ifaces) {
405                 iface_configure_cfm(iface);
406                 iface_configure_qos(iface, port->cfg->qos);
407                 iface_set_mac(iface);
408             }
409         }
410         bridge_configure_mirrors(br);
411         bridge_configure_datapath_id(br);
412         bridge_configure_remotes(br, managers, n_managers);
413         bridge_configure_netflow(br);
414         bridge_configure_sflow(br, &sflow_bridge_number);
415     }
416     free(managers);
417
418     /* ovs-vswitchd has completed initialization, so allow the process that
419      * forked us to exit successfully. */
420     daemonize_complete();
421 }
422
423 /* Iterate over all ofprotos and delete any of them that do not have a
424  * configured bridge or that are the wrong type. */
425 static void
426 bridge_del_ofprotos(void)
427 {
428     struct sset names;
429     struct sset types;
430     const char *type;
431
432     sset_init(&names);
433     sset_init(&types);
434     ofproto_enumerate_types(&types);
435     SSET_FOR_EACH (type, &types) {
436         const char *name;
437
438         ofproto_enumerate_names(type, &names);
439         SSET_FOR_EACH (name, &names) {
440             struct bridge *br = bridge_lookup(name);
441             if (!br || strcmp(type, br->type)) {
442                 ofproto_delete(name, type);
443             }
444         }
445     }
446     sset_destroy(&names);
447     sset_destroy(&types);
448 }
449
450 static bool
451 bridge_add_ofprotos(struct bridge *br)
452 {
453     int error = ofproto_create(br->name, br->type, &br->ofproto);
454     if (error) {
455         VLOG_ERR("failed to create bridge %s: %s", br->name, strerror(error));
456         return false;
457     }
458     return true;
459 }
460
461 static void
462 port_configure(struct port *port)
463 {
464     const struct ovsrec_port *cfg = port->cfg;
465     struct bond_settings bond_settings;
466     struct lacp_settings lacp_settings;
467     struct ofproto_bundle_settings s;
468     struct iface *iface;
469
470     /* Get name. */
471     s.name = port->name;
472
473     /* Get slaves. */
474     s.n_slaves = 0;
475     s.slaves = xmalloc(list_size(&port->ifaces) * sizeof *s.slaves);
476     LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
477         s.slaves[s.n_slaves++] = iface->ofp_port;
478     }
479
480     /* Get VLAN tag. */
481     s.vlan = -1;
482     if (cfg->tag) {
483         if (list_is_short(&port->ifaces)) {
484             if (*cfg->tag >= 0 && *cfg->tag <= 4095) {
485                 s.vlan = *cfg->tag;
486                 VLOG_DBG("port %s: assigning VLAN tag %d", port->name, s.vlan);
487             }
488         } else {
489             /* It's possible that bonded, VLAN-tagged ports make sense.  Maybe
490              * they even work as-is.  But they have not been tested. */
491             VLOG_WARN("port %s: VLAN tags not supported on bonded ports",
492                       port->name);
493         }
494     }
495
496     /* Get VLAN trunks. */
497     s.trunks = NULL;
498     if (s.vlan < 0 && cfg->n_trunks) {
499         s.trunks = vlan_bitmap_from_array(cfg->trunks, cfg->n_trunks);
500     } else if (s.vlan >= 0 && cfg->n_trunks) {
501         VLOG_ERR("port %s: ignoring trunks in favor of implicit vlan",
502                  port->name);
503     }
504
505     /* Get LACP settings. */
506     s.lacp = port_configure_lacp(port, &lacp_settings);
507     if (s.lacp) {
508         size_t i = 0;
509
510         s.lacp_slaves = xmalloc(s.n_slaves * sizeof *s.lacp_slaves);
511         LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
512             iface_configure_lacp(iface, &s.lacp_slaves[i++]);
513         }
514     } else {
515         s.lacp_slaves = NULL;
516     }
517
518     /* Get bond settings. */
519     if (s.n_slaves > 1) {
520         s.bond = &bond_settings;
521         s.bond_stable_ids = xmalloc(s.n_slaves * sizeof *s.bond_stable_ids);
522         port_configure_bond(port, &bond_settings, s.bond_stable_ids);
523     } else {
524         s.bond = NULL;
525         s.bond_stable_ids = NULL;
526
527         LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
528             netdev_set_miimon_interval(iface->netdev, 0);
529         }
530     }
531
532     /* Register. */
533     ofproto_bundle_register(port->bridge->ofproto, port, &s);
534
535     /* Clean up. */
536     free(s.trunks);
537     free(s.lacp_slaves);
538     free(s.bond_stable_ids);
539 }
540
541 /* Pick local port hardware address and datapath ID for 'br'. */
542 static void
543 bridge_configure_datapath_id(struct bridge *br)
544 {
545     uint8_t ea[ETH_ADDR_LEN];
546     uint64_t dpid;
547     struct iface *local_iface;
548     struct iface *hw_addr_iface;
549     char *dpid_string;
550
551     bridge_pick_local_hw_addr(br, ea, &hw_addr_iface);
552     local_iface = iface_from_ofp_port(br, OFPP_LOCAL);
553     if (local_iface) {
554         int error = netdev_set_etheraddr(local_iface->netdev, ea);
555         if (error) {
556             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
557             VLOG_ERR_RL(&rl, "bridge %s: failed to set bridge "
558                         "Ethernet address: %s",
559                         br->name, strerror(error));
560         }
561     }
562     memcpy(br->ea, ea, ETH_ADDR_LEN);
563
564     dpid = bridge_pick_datapath_id(br, ea, hw_addr_iface);
565     ofproto_set_datapath_id(br->ofproto, dpid);
566
567     dpid_string = xasprintf("%016"PRIx64, dpid);
568     ovsrec_bridge_set_datapath_id(br->cfg, dpid_string);
569     free(dpid_string);
570 }
571
572 /* Set NetFlow configuration on 'br'. */
573 static void
574 bridge_configure_netflow(struct bridge *br)
575 {
576     struct ovsrec_netflow *cfg = br->cfg->netflow;
577     struct netflow_options opts;
578
579     if (!cfg) {
580         ofproto_set_netflow(br->ofproto, NULL);
581         return;
582     }
583
584     memset(&opts, 0, sizeof opts);
585
586     /* Get default NetFlow configuration from datapath.
587      * Apply overrides from 'cfg'. */
588     ofproto_get_netflow_ids(br->ofproto, &opts.engine_type, &opts.engine_id);
589     if (cfg->engine_type) {
590         opts.engine_type = *cfg->engine_type;
591     }
592     if (cfg->engine_id) {
593         opts.engine_id = *cfg->engine_id;
594     }
595
596     /* Configure active timeout interval. */
597     opts.active_timeout = cfg->active_timeout;
598     if (!opts.active_timeout) {
599         opts.active_timeout = -1;
600     } else if (opts.active_timeout < 0) {
601         VLOG_WARN("bridge %s: active timeout interval set to negative "
602                   "value, using default instead (%d seconds)", br->name,
603                   NF_ACTIVE_TIMEOUT_DEFAULT);
604         opts.active_timeout = -1;
605     }
606
607     /* Add engine ID to interface number to disambiguate bridgs? */
608     opts.add_id_to_iface = cfg->add_id_to_interface;
609     if (opts.add_id_to_iface) {
610         if (opts.engine_id > 0x7f) {
611             VLOG_WARN("bridge %s: NetFlow port mangling may conflict with "
612                       "another vswitch, choose an engine id less than 128",
613                       br->name);
614         }
615         if (hmap_count(&br->ports) > 508) {
616             VLOG_WARN("bridge %s: NetFlow port mangling will conflict with "
617                       "another port when more than 508 ports are used",
618                       br->name);
619         }
620     }
621
622     /* Collectors. */
623     sset_init(&opts.collectors);
624     sset_add_array(&opts.collectors, cfg->targets, cfg->n_targets);
625
626     /* Configure. */
627     if (ofproto_set_netflow(br->ofproto, &opts)) {
628         VLOG_ERR("bridge %s: problem setting netflow collectors", br->name);
629     }
630     sset_destroy(&opts.collectors);
631 }
632
633 /* Set sFlow configuration on 'br'. */
634 static void
635 bridge_configure_sflow(struct bridge *br, int *sflow_bridge_number)
636 {
637     const struct ovsrec_sflow *cfg = br->cfg->sflow;
638     struct ovsrec_controller **controllers;
639     struct ofproto_sflow_options oso;
640     size_t n_controllers;
641     size_t i;
642
643     if (!cfg) {
644         ofproto_set_sflow(br->ofproto, NULL);
645         return;
646     }
647
648     memset(&oso, 0, sizeof oso);
649
650     sset_init(&oso.targets);
651     sset_add_array(&oso.targets, cfg->targets, cfg->n_targets);
652
653     oso.sampling_rate = SFL_DEFAULT_SAMPLING_RATE;
654     if (cfg->sampling) {
655         oso.sampling_rate = *cfg->sampling;
656     }
657
658     oso.polling_interval = SFL_DEFAULT_POLLING_INTERVAL;
659     if (cfg->polling) {
660         oso.polling_interval = *cfg->polling;
661     }
662
663     oso.header_len = SFL_DEFAULT_HEADER_SIZE;
664     if (cfg->header) {
665         oso.header_len = *cfg->header;
666     }
667
668     oso.sub_id = (*sflow_bridge_number)++;
669     oso.agent_device = cfg->agent;
670
671     oso.control_ip = NULL;
672     n_controllers = bridge_get_controllers(br, &controllers);
673     for (i = 0; i < n_controllers; i++) {
674         if (controllers[i]->local_ip) {
675             oso.control_ip = controllers[i]->local_ip;
676             break;
677         }
678     }
679     ofproto_set_sflow(br->ofproto, &oso);
680
681     sset_destroy(&oso.targets);
682 }
683
684 static bool
685 bridge_has_bond_fake_iface(const struct bridge *br, const char *name)
686 {
687     const struct port *port = port_lookup(br, name);
688     return port && port_is_bond_fake_iface(port);
689 }
690
691 static bool
692 port_is_bond_fake_iface(const struct port *port)
693 {
694     return port->cfg->bond_fake_iface && !list_is_short(&port->ifaces);
695 }
696
697 static void
698 add_del_bridges(const struct ovsrec_open_vswitch *cfg)
699 {
700     struct bridge *br, *next;
701     struct shash new_br;
702     size_t i;
703
704     /* Collect new bridges' names and types. */
705     shash_init(&new_br);
706     for (i = 0; i < cfg->n_bridges; i++) {
707         const struct ovsrec_bridge *br_cfg = cfg->bridges[i];
708         if (!shash_add_once(&new_br, br_cfg->name, br_cfg)) {
709             VLOG_WARN("bridge %s specified twice", br_cfg->name);
710         }
711     }
712
713     /* Get rid of deleted bridges or those whose types have changed.
714      * Update 'cfg' of bridges that still exist. */
715     HMAP_FOR_EACH_SAFE (br, next, node, &all_bridges) {
716         br->cfg = shash_find_data(&new_br, br->name);
717         if (!br->cfg || strcmp(br->type, ofproto_normalize_type(
718                                    br->cfg->datapath_type))) {
719             bridge_destroy(br);
720         }
721     }
722
723     /* Add new bridges. */
724     for (i = 0; i < cfg->n_bridges; i++) {
725         const struct ovsrec_bridge *br_cfg = cfg->bridges[i];
726         struct bridge *br = bridge_lookup(br_cfg->name);
727         if (!br) {
728             bridge_create(br_cfg);
729         }
730     }
731
732     shash_destroy(&new_br);
733 }
734
735 /* Delete each ofproto port on 'br' that doesn't have a corresponding "struct
736  * iface".
737  *
738  * The kernel will reject any attempt to add a given port to a datapath if that
739  * port already belongs to a different datapath, so we must do all port
740  * deletions before any port additions. */
741 static void
742 bridge_del_ofproto_ports(struct bridge *br)
743 {
744     struct ofproto_port_dump dump;
745     struct ofproto_port ofproto_port;
746
747     OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, br->ofproto) {
748         const char *name = ofproto_port.name;
749         struct iface *iface;
750         const char *type;
751         int error;
752
753         /* Ignore the local port.  We can't change it anyhow. */
754         if (!strcmp(name, br->name)) {
755             continue;
756         }
757
758         /* Get the type that 'ofproto_port' should have (ordinarily the
759          * type of its corresponding iface) or NULL if it should be
760          * deleted. */
761         iface = iface_lookup(br, name);
762         type = (iface ? iface->type
763                 : bridge_has_bond_fake_iface(br, name) ? "internal"
764                 : NULL);
765
766         /* If it's the wrong type then delete the ofproto port. */
767         if (type
768             && !strcmp(ofproto_port.type, type)
769             && (!iface || !iface->netdev
770                 || !strcmp(netdev_get_type(iface->netdev), type))) {
771             continue;
772         }
773         error = ofproto_port_del(br->ofproto, ofproto_port.ofp_port);
774         if (error) {
775             VLOG_WARN("bridge %s: failed to remove %s interface (%s)",
776                       br->name, name, strerror(error));
777         }
778         if (iface) {
779             netdev_close(iface->netdev);
780             iface->netdev = NULL;
781         }
782     }
783 }
784
785 static void
786 iface_set_ofp_port(struct iface *iface, int ofp_port)
787 {
788     struct bridge *br = iface->port->bridge;
789
790     assert(iface->ofp_port < 0 && ofp_port >= 0);
791     iface->ofp_port = ofp_port;
792     hmap_insert(&br->ifaces, &iface->ofp_port_node, hash_int(ofp_port, 0));
793     iface_set_ofport(iface->cfg, ofp_port);
794 }
795
796 static void
797 bridge_refresh_ofp_port(struct bridge *br)
798 {
799     struct ofproto_port_dump dump;
800     struct ofproto_port ofproto_port;
801     struct port *port;
802
803     /* Clear all the "ofp_port"es. */
804     hmap_clear(&br->ifaces);
805     HMAP_FOR_EACH (port, hmap_node, &br->ports) {
806         struct iface *iface;
807
808         LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
809             iface->ofp_port = -1;
810         }
811     }
812
813     /* Obtain the correct "ofp_port"s from ofproto. */
814     OFPROTO_PORT_FOR_EACH (&ofproto_port, &dump, br->ofproto) {
815         struct iface *iface = iface_lookup(br, ofproto_port.name);
816         if (iface) {
817             if (iface->ofp_port >= 0) {
818                 VLOG_WARN("bridge %s: interface %s reported twice",
819                           br->name, ofproto_port.name);
820             } else if (iface_from_ofp_port(br, ofproto_port.ofp_port)) {
821                 VLOG_WARN("bridge %s: interface %"PRIu16" reported twice",
822                           br->name, ofproto_port.ofp_port);
823             } else {
824                 iface_set_ofp_port(iface, ofproto_port.ofp_port);
825             }
826         }
827     }
828 }
829
830 /* Add an ofproto port for any "struct iface" that doesn't have one.
831  * Delete any "struct iface" for which this fails.
832  * Delete any "struct port" that thereby ends up with no ifaces. */
833 static void
834 bridge_add_ofproto_ports(struct bridge *br)
835 {
836     struct port *port, *next_port;
837
838     HMAP_FOR_EACH_SAFE (port, next_port, hmap_node, &br->ports) {
839         struct iface *iface, *next_iface;
840         struct ofproto_port ofproto_port;
841
842         LIST_FOR_EACH_SAFE (iface, next_iface, port_elem, &port->ifaces) {
843             struct shash args;
844             int error;
845
846             /* Open the netdev or reconfigure it. */
847             shash_init(&args);
848             shash_from_ovs_idl_map(iface->cfg->key_options,
849                                    iface->cfg->value_options,
850                                    iface->cfg->n_options, &args);
851             if (!iface->netdev) {
852                 struct netdev_options options;
853                 options.name = iface->name;
854                 options.type = iface->type;
855                 options.args = &args;
856                 options.ethertype = NETDEV_ETH_TYPE_NONE;
857                 error = netdev_open(&options, &iface->netdev);
858             } else {
859                 error = netdev_set_config(iface->netdev, &args);
860             }
861             shash_destroy(&args);
862             if (error) {
863                 VLOG_WARN("could not %s network device %s (%s)",
864                           iface->netdev ? "reconfigure" : "open",
865                           iface->name, strerror(error));
866             }
867
868             /* Add the port, if necessary. */
869             if (iface->netdev && iface->ofp_port < 0) {
870                 uint16_t ofp_port;
871                 int error;
872
873                 error = ofproto_port_add(br->ofproto, iface->netdev,
874                                          &ofp_port);
875                 if (!error) {
876                     iface_set_ofp_port(iface, ofp_port);
877                 } else {
878                     netdev_close(iface->netdev);
879                     iface->netdev = NULL;
880                 }
881             }
882
883             /* Delete the iface if  */
884             if (iface->netdev && iface->ofp_port >= 0) {
885                 VLOG_DBG("bridge %s: interface %s is on port %d",
886                          br->name, iface->name, iface->ofp_port);
887             } else {
888                 if (iface->netdev) {
889                     VLOG_ERR("bridge %s: missing %s interface, dropping",
890                              br->name, iface->name);
891                 } else {
892                     /* We already reported a related error, don't bother
893                      * duplicating it. */
894                 }
895                 iface_set_ofport(iface->cfg, -1);
896                 iface_destroy(iface);
897             }
898         }
899         if (list_is_empty(&port->ifaces)) {
900             VLOG_WARN("%s port has no interfaces, dropping", port->name);
901             port_destroy(port);
902             continue;
903         }
904
905         /* Add bond fake iface if necessary. */
906         if (port_is_bond_fake_iface(port)) {
907             if (ofproto_port_query_by_name(br->ofproto, port->name,
908                                            &ofproto_port)) {
909                 struct netdev_options options;
910                 struct netdev *netdev;
911                 int error;
912
913                 options.name = port->name;
914                 options.type = "internal";
915                 options.args = NULL;
916                 options.ethertype = NETDEV_ETH_TYPE_NONE;
917                 error = netdev_open(&options, &netdev);
918                 if (!error) {
919                     ofproto_port_add(br->ofproto, netdev, NULL);
920                     netdev_close(netdev);
921                 } else {
922                     VLOG_WARN("could not open network device %s (%s)",
923                               port->name, strerror(error));
924                 }
925             } else {
926                 /* Already exists, nothing to do. */
927                 ofproto_port_destroy(&ofproto_port);
928             }
929         }
930     }
931 }
932
933 static const char *
934 get_ovsrec_key_value(const struct ovsdb_idl_row *row,
935                      const struct ovsdb_idl_column *column,
936                      const char *key)
937 {
938     const struct ovsdb_datum *datum;
939     union ovsdb_atom atom;
940     unsigned int idx;
941
942     datum = ovsdb_idl_get(row, column, OVSDB_TYPE_STRING, OVSDB_TYPE_STRING);
943     atom.string = (char *) key;
944     idx = ovsdb_datum_find_key(datum, &atom, OVSDB_TYPE_STRING);
945     return idx == UINT_MAX ? NULL : datum->values[idx].string;
946 }
947
948 static const char *
949 bridge_get_other_config(const struct ovsrec_bridge *br_cfg, const char *key)
950 {
951     return get_ovsrec_key_value(&br_cfg->header_,
952                                 &ovsrec_bridge_col_other_config, key);
953 }
954
955 static void
956 bridge_pick_local_hw_addr(struct bridge *br, uint8_t ea[ETH_ADDR_LEN],
957                           struct iface **hw_addr_iface)
958 {
959     const char *hwaddr;
960     struct port *port;
961     int error;
962
963     *hw_addr_iface = NULL;
964
965     /* Did the user request a particular MAC? */
966     hwaddr = bridge_get_other_config(br->cfg, "hwaddr");
967     if (hwaddr && eth_addr_from_string(hwaddr, ea)) {
968         if (eth_addr_is_multicast(ea)) {
969             VLOG_ERR("bridge %s: cannot set MAC address to multicast "
970                      "address "ETH_ADDR_FMT, br->name, ETH_ADDR_ARGS(ea));
971         } else if (eth_addr_is_zero(ea)) {
972             VLOG_ERR("bridge %s: cannot set MAC address to zero", br->name);
973         } else {
974             return;
975         }
976     }
977
978     /* Otherwise choose the minimum non-local MAC address among all of the
979      * interfaces. */
980     memset(ea, 0xff, ETH_ADDR_LEN);
981     HMAP_FOR_EACH (port, hmap_node, &br->ports) {
982         uint8_t iface_ea[ETH_ADDR_LEN];
983         struct iface *candidate;
984         struct iface *iface;
985
986         /* Mirror output ports don't participate. */
987         if (ofproto_is_mirror_output_bundle(br->ofproto, port)) {
988             continue;
989         }
990
991         /* Choose the MAC address to represent the port. */
992         iface = NULL;
993         if (port->cfg->mac && eth_addr_from_string(port->cfg->mac, iface_ea)) {
994             /* Find the interface with this Ethernet address (if any) so that
995              * we can provide the correct devname to the caller. */
996             LIST_FOR_EACH (candidate, port_elem, &port->ifaces) {
997                 uint8_t candidate_ea[ETH_ADDR_LEN];
998                 if (!netdev_get_etheraddr(candidate->netdev, candidate_ea)
999                     && eth_addr_equals(iface_ea, candidate_ea)) {
1000                     iface = candidate;
1001                 }
1002             }
1003         } else {
1004             /* Choose the interface whose MAC address will represent the port.
1005              * The Linux kernel bonding code always chooses the MAC address of
1006              * the first slave added to a bond, and the Fedora networking
1007              * scripts always add slaves to a bond in alphabetical order, so
1008              * for compatibility we choose the interface with the name that is
1009              * first in alphabetical order. */
1010             LIST_FOR_EACH (candidate, port_elem, &port->ifaces) {
1011                 if (!iface || strcmp(candidate->name, iface->name) < 0) {
1012                     iface = candidate;
1013                 }
1014             }
1015
1016             /* The local port doesn't count (since we're trying to choose its
1017              * MAC address anyway). */
1018             if (iface->ofp_port == OFPP_LOCAL) {
1019                 continue;
1020             }
1021
1022             /* Grab MAC. */
1023             error = netdev_get_etheraddr(iface->netdev, iface_ea);
1024             if (error) {
1025                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1026                 VLOG_ERR_RL(&rl, "failed to obtain Ethernet address of %s: %s",
1027                             iface->name, strerror(error));
1028                 continue;
1029             }
1030         }
1031
1032         /* Compare against our current choice. */
1033         if (!eth_addr_is_multicast(iface_ea) &&
1034             !eth_addr_is_local(iface_ea) &&
1035             !eth_addr_is_reserved(iface_ea) &&
1036             !eth_addr_is_zero(iface_ea) &&
1037             eth_addr_compare_3way(iface_ea, ea) < 0)
1038         {
1039             memcpy(ea, iface_ea, ETH_ADDR_LEN);
1040             *hw_addr_iface = iface;
1041         }
1042     }
1043     if (eth_addr_is_multicast(ea)) {
1044         memcpy(ea, br->default_ea, ETH_ADDR_LEN);
1045         *hw_addr_iface = NULL;
1046         VLOG_WARN("bridge %s: using default bridge Ethernet "
1047                   "address "ETH_ADDR_FMT, br->name, ETH_ADDR_ARGS(ea));
1048     } else {
1049         VLOG_DBG("bridge %s: using bridge Ethernet address "ETH_ADDR_FMT,
1050                  br->name, ETH_ADDR_ARGS(ea));
1051     }
1052 }
1053
1054 /* Choose and returns the datapath ID for bridge 'br' given that the bridge
1055  * Ethernet address is 'bridge_ea'.  If 'bridge_ea' is the Ethernet address of
1056  * an interface on 'br', then that interface must be passed in as
1057  * 'hw_addr_iface'; if 'bridge_ea' was derived some other way, then
1058  * 'hw_addr_iface' must be passed in as a null pointer. */
1059 static uint64_t
1060 bridge_pick_datapath_id(struct bridge *br,
1061                         const uint8_t bridge_ea[ETH_ADDR_LEN],
1062                         struct iface *hw_addr_iface)
1063 {
1064     /*
1065      * The procedure for choosing a bridge MAC address will, in the most
1066      * ordinary case, also choose a unique MAC that we can use as a datapath
1067      * ID.  In some special cases, though, multiple bridges will end up with
1068      * the same MAC address.  This is OK for the bridges, but it will confuse
1069      * the OpenFlow controller, because each datapath needs a unique datapath
1070      * ID.
1071      *
1072      * Datapath IDs must be unique.  It is also very desirable that they be
1073      * stable from one run to the next, so that policy set on a datapath
1074      * "sticks".
1075      */
1076     const char *datapath_id;
1077     uint64_t dpid;
1078
1079     datapath_id = bridge_get_other_config(br->cfg, "datapath-id");
1080     if (datapath_id && dpid_from_string(datapath_id, &dpid)) {
1081         return dpid;
1082     }
1083
1084     if (hw_addr_iface) {
1085         int vlan;
1086         if (!netdev_get_vlan_vid(hw_addr_iface->netdev, &vlan)) {
1087             /*
1088              * A bridge whose MAC address is taken from a VLAN network device
1089              * (that is, a network device created with vconfig(8) or similar
1090              * tool) will have the same MAC address as a bridge on the VLAN
1091              * device's physical network device.
1092              *
1093              * Handle this case by hashing the physical network device MAC
1094              * along with the VLAN identifier.
1095              */
1096             uint8_t buf[ETH_ADDR_LEN + 2];
1097             memcpy(buf, bridge_ea, ETH_ADDR_LEN);
1098             buf[ETH_ADDR_LEN] = vlan >> 8;
1099             buf[ETH_ADDR_LEN + 1] = vlan;
1100             return dpid_from_hash(buf, sizeof buf);
1101         } else {
1102             /*
1103              * Assume that this bridge's MAC address is unique, since it
1104              * doesn't fit any of the cases we handle specially.
1105              */
1106         }
1107     } else {
1108         /*
1109          * A purely internal bridge, that is, one that has no non-virtual
1110          * network devices on it at all, is more difficult because it has no
1111          * natural unique identifier at all.
1112          *
1113          * When the host is a XenServer, we handle this case by hashing the
1114          * host's UUID with the name of the bridge.  Names of bridges are
1115          * persistent across XenServer reboots, although they can be reused if
1116          * an internal network is destroyed and then a new one is later
1117          * created, so this is fairly effective.
1118          *
1119          * When the host is not a XenServer, we punt by using a random MAC
1120          * address on each run.
1121          */
1122         const char *host_uuid = xenserver_get_host_uuid();
1123         if (host_uuid) {
1124             char *combined = xasprintf("%s,%s", host_uuid, br->name);
1125             dpid = dpid_from_hash(combined, strlen(combined));
1126             free(combined);
1127             return dpid;
1128         }
1129     }
1130
1131     return eth_addr_to_uint64(bridge_ea);
1132 }
1133
1134 static uint64_t
1135 dpid_from_hash(const void *data, size_t n)
1136 {
1137     uint8_t hash[SHA1_DIGEST_SIZE];
1138
1139     BUILD_ASSERT_DECL(sizeof hash >= ETH_ADDR_LEN);
1140     sha1_bytes(data, n, hash);
1141     eth_addr_mark_random(hash);
1142     return eth_addr_to_uint64(hash);
1143 }
1144
1145 static void
1146 iface_refresh_status(struct iface *iface)
1147 {
1148     struct shash sh;
1149
1150     enum netdev_flags flags;
1151     uint32_t current;
1152     int64_t bps;
1153     int mtu;
1154     int64_t mtu_64;
1155     int error;
1156
1157     if (iface_is_synthetic(iface)) {
1158         return;
1159     }
1160
1161     shash_init(&sh);
1162
1163     if (!netdev_get_status(iface->netdev, &sh)) {
1164         size_t n;
1165         char **keys, **values;
1166
1167         shash_to_ovs_idl_map(&sh, &keys, &values, &n);
1168         ovsrec_interface_set_status(iface->cfg, keys, values, n);
1169
1170         free(keys);
1171         free(values);
1172     } else {
1173         ovsrec_interface_set_status(iface->cfg, NULL, NULL, 0);
1174     }
1175
1176     shash_destroy_free_data(&sh);
1177
1178     error = netdev_get_flags(iface->netdev, &flags);
1179     if (!error) {
1180         ovsrec_interface_set_admin_state(iface->cfg, flags & NETDEV_UP ? "up" : "down");
1181     }
1182     else {
1183         ovsrec_interface_set_admin_state(iface->cfg, NULL);
1184     }
1185
1186     error = netdev_get_features(iface->netdev, &current, NULL, NULL, NULL);
1187     if (!error) {
1188         ovsrec_interface_set_duplex(iface->cfg,
1189                                     netdev_features_is_full_duplex(current)
1190                                     ? "full" : "half");
1191         /* warning: uint64_t -> int64_t conversion */
1192         bps = netdev_features_to_bps(current);
1193         ovsrec_interface_set_link_speed(iface->cfg, &bps, 1);
1194     }
1195     else {
1196         ovsrec_interface_set_duplex(iface->cfg, NULL);
1197         ovsrec_interface_set_link_speed(iface->cfg, NULL, 0);
1198     }
1199
1200     ovsrec_interface_set_link_state(iface->cfg,
1201                                     iface_get_carrier(iface) ? "up" : "down");
1202
1203     error = netdev_get_mtu(iface->netdev, &mtu);
1204     if (!error && mtu != INT_MAX) {
1205         mtu_64 = mtu;
1206         ovsrec_interface_set_mtu(iface->cfg, &mtu_64, 1);
1207     }
1208     else {
1209         ovsrec_interface_set_mtu(iface->cfg, NULL, 0);
1210     }
1211 }
1212
1213 /* Writes 'iface''s CFM statistics to the database.  Returns true if anything
1214  * changed, false otherwise. */
1215 static bool
1216 iface_refresh_cfm_stats(struct iface *iface)
1217 {
1218     const struct ovsrec_interface *cfg = iface->cfg;
1219     bool changed = false;
1220     int fault;
1221
1222     fault = ofproto_port_get_cfm_fault(iface->port->bridge->ofproto,
1223                                        iface->ofp_port);
1224
1225     if (fault < 0) {
1226         return false;
1227     }
1228
1229     if (cfg->n_cfm_fault != 1 || cfg->cfm_fault[0] != fault) {
1230         bool fault_bool = fault;
1231         ovsrec_interface_set_cfm_fault(cfg, &fault_bool, 1);
1232         changed = true;
1233     }
1234
1235     return changed;
1236 }
1237
1238 static bool
1239 iface_refresh_lacp_stats(struct iface *iface)
1240 {
1241     struct ofproto *ofproto = iface->port->bridge->ofproto;
1242     int old = iface->cfg->lacp_current ? *iface->cfg->lacp_current : -1;
1243     int new = ofproto_port_is_lacp_current(ofproto, iface->ofp_port);
1244
1245     if (old != new) {
1246         bool current = new;
1247         ovsrec_interface_set_lacp_current(iface->cfg, &current, new >= 0);
1248     }
1249     return old != new;
1250 }
1251
1252 static void
1253 iface_refresh_stats(struct iface *iface)
1254 {
1255     struct iface_stat {
1256         char *name;
1257         int offset;
1258     };
1259     static const struct iface_stat iface_stats[] = {
1260         { "rx_packets", offsetof(struct netdev_stats, rx_packets) },
1261         { "tx_packets", offsetof(struct netdev_stats, tx_packets) },
1262         { "rx_bytes", offsetof(struct netdev_stats, rx_bytes) },
1263         { "tx_bytes", offsetof(struct netdev_stats, tx_bytes) },
1264         { "rx_dropped", offsetof(struct netdev_stats, rx_dropped) },
1265         { "tx_dropped", offsetof(struct netdev_stats, tx_dropped) },
1266         { "rx_errors", offsetof(struct netdev_stats, rx_errors) },
1267         { "tx_errors", offsetof(struct netdev_stats, tx_errors) },
1268         { "rx_frame_err", offsetof(struct netdev_stats, rx_frame_errors) },
1269         { "rx_over_err", offsetof(struct netdev_stats, rx_over_errors) },
1270         { "rx_crc_err", offsetof(struct netdev_stats, rx_crc_errors) },
1271         { "collisions", offsetof(struct netdev_stats, collisions) },
1272     };
1273     enum { N_STATS = ARRAY_SIZE(iface_stats) };
1274     const struct iface_stat *s;
1275
1276     char *keys[N_STATS];
1277     int64_t values[N_STATS];
1278     int n;
1279
1280     struct netdev_stats stats;
1281
1282     if (iface_is_synthetic(iface)) {
1283         return;
1284     }
1285
1286     /* Intentionally ignore return value, since errors will set 'stats' to
1287      * all-1s, and we will deal with that correctly below. */
1288     netdev_get_stats(iface->netdev, &stats);
1289
1290     n = 0;
1291     for (s = iface_stats; s < &iface_stats[N_STATS]; s++) {
1292         uint64_t value = *(uint64_t *) (((char *) &stats) + s->offset);
1293         if (value != UINT64_MAX) {
1294             keys[n] = s->name;
1295             values[n] = value;
1296             n++;
1297         }
1298     }
1299
1300     ovsrec_interface_set_statistics(iface->cfg, keys, values, n);
1301 }
1302
1303 static void
1304 refresh_system_stats(const struct ovsrec_open_vswitch *cfg)
1305 {
1306     struct ovsdb_datum datum;
1307     struct shash stats;
1308
1309     shash_init(&stats);
1310     get_system_stats(&stats);
1311
1312     ovsdb_datum_from_shash(&datum, &stats);
1313     ovsdb_idl_txn_write(&cfg->header_, &ovsrec_open_vswitch_col_statistics,
1314                         &datum);
1315 }
1316
1317 static inline const char *
1318 nx_role_to_str(enum nx_role role)
1319 {
1320     switch (role) {
1321     case NX_ROLE_OTHER:
1322         return "other";
1323     case NX_ROLE_MASTER:
1324         return "master";
1325     case NX_ROLE_SLAVE:
1326         return "slave";
1327     default:
1328         return "*** INVALID ROLE ***";
1329     }
1330 }
1331
1332 static void
1333 bridge_refresh_controller_status(const struct bridge *br)
1334 {
1335     struct shash info;
1336     const struct ovsrec_controller *cfg;
1337
1338     ofproto_get_ofproto_controller_info(br->ofproto, &info);
1339
1340     OVSREC_CONTROLLER_FOR_EACH(cfg, idl) {
1341         struct ofproto_controller_info *cinfo =
1342             shash_find_data(&info, cfg->target);
1343
1344         if (cinfo) {
1345             ovsrec_controller_set_is_connected(cfg, cinfo->is_connected);
1346             ovsrec_controller_set_role(cfg, nx_role_to_str(cinfo->role));
1347             ovsrec_controller_set_status(cfg, (char **) cinfo->pairs.keys,
1348                                          (char **) cinfo->pairs.values,
1349                                          cinfo->pairs.n);
1350         } else {
1351             ovsrec_controller_set_is_connected(cfg, false);
1352             ovsrec_controller_set_role(cfg, NULL);
1353             ovsrec_controller_set_status(cfg, NULL, NULL, 0);
1354         }
1355     }
1356
1357     ofproto_free_ofproto_controller_info(&info);
1358 }
1359
1360 void
1361 bridge_run(void)
1362 {
1363     const struct ovsrec_open_vswitch *cfg;
1364
1365     bool datapath_destroyed;
1366     bool database_changed;
1367     struct bridge *br;
1368
1369     /* Let each bridge do the work that it needs to do. */
1370     datapath_destroyed = false;
1371     HMAP_FOR_EACH (br, node, &all_bridges) {
1372         int error = ofproto_run(br->ofproto);
1373         if (error) {
1374             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1375             VLOG_ERR_RL(&rl, "bridge %s: datapath was destroyed externally, "
1376                         "forcing reconfiguration", br->name);
1377             datapath_destroyed = true;
1378         }
1379     }
1380
1381     /* (Re)configure if necessary. */
1382     database_changed = ovsdb_idl_run(idl);
1383     cfg = ovsrec_open_vswitch_first(idl);
1384
1385     /* Re-configure SSL.  We do this on every trip through the main loop,
1386      * instead of just when the database changes, because the contents of the
1387      * key and certificate files can change without the database changing.
1388      *
1389      * We do this before bridge_reconfigure() because that function might
1390      * initiate SSL connections and thus requires SSL to be configured. */
1391     if (cfg && cfg->ssl) {
1392         const struct ovsrec_ssl *ssl = cfg->ssl;
1393
1394         stream_ssl_set_key_and_cert(ssl->private_key, ssl->certificate);
1395         stream_ssl_set_ca_cert_file(ssl->ca_cert, ssl->bootstrap_ca_cert);
1396     }
1397
1398     if (database_changed || datapath_destroyed) {
1399         if (cfg) {
1400             struct ovsdb_idl_txn *txn = ovsdb_idl_txn_create(idl);
1401
1402             bridge_reconfigure(cfg);
1403
1404             ovsrec_open_vswitch_set_cur_cfg(cfg, cfg->next_cfg);
1405             ovsdb_idl_txn_commit(txn);
1406             ovsdb_idl_txn_destroy(txn); /* XXX */
1407         } else {
1408             /* We still need to reconfigure to avoid dangling pointers to
1409              * now-destroyed ovsrec structures inside bridge data. */
1410             static const struct ovsrec_open_vswitch null_cfg;
1411
1412             bridge_reconfigure(&null_cfg);
1413         }
1414     }
1415
1416     /* Refresh system and interface stats if necessary. */
1417     if (time_msec() >= stats_timer) {
1418         if (cfg) {
1419             struct ovsdb_idl_txn *txn;
1420
1421             txn = ovsdb_idl_txn_create(idl);
1422             HMAP_FOR_EACH (br, node, &all_bridges) {
1423                 struct port *port;
1424
1425                 HMAP_FOR_EACH (port, hmap_node, &br->ports) {
1426                     struct iface *iface;
1427
1428                     LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
1429                         iface_refresh_stats(iface);
1430                         iface_refresh_status(iface);
1431                     }
1432                 }
1433                 bridge_refresh_controller_status(br);
1434             }
1435             refresh_system_stats(cfg);
1436             ovsdb_idl_txn_commit(txn);
1437             ovsdb_idl_txn_destroy(txn); /* XXX */
1438         }
1439
1440         stats_timer = time_msec() + STATS_INTERVAL;
1441     }
1442
1443     if (time_msec() >= db_limiter) {
1444         struct ovsdb_idl_txn *txn;
1445         bool changed = false;
1446
1447         txn = ovsdb_idl_txn_create(idl);
1448         HMAP_FOR_EACH (br, node, &all_bridges) {
1449             struct port *port;
1450
1451             HMAP_FOR_EACH (port, hmap_node, &br->ports) {
1452                 struct iface *iface;
1453
1454                 LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
1455                     changed = iface_refresh_cfm_stats(iface) || changed;
1456                     changed = iface_refresh_lacp_stats(iface) || changed;
1457                 }
1458             }
1459         }
1460
1461         if (changed) {
1462             db_limiter = time_msec() + DB_LIMIT_INTERVAL;
1463         }
1464
1465         ovsdb_idl_txn_commit(txn);
1466         ovsdb_idl_txn_destroy(txn);
1467     }
1468 }
1469
1470 void
1471 bridge_wait(void)
1472 {
1473     struct bridge *br;
1474
1475     HMAP_FOR_EACH (br, node, &all_bridges) {
1476         ofproto_wait(br->ofproto);
1477     }
1478     ovsdb_idl_wait(idl);
1479     poll_timer_wait_until(stats_timer);
1480
1481     if (db_limiter > time_msec()) {
1482         poll_timer_wait_until(db_limiter);
1483     }
1484 }
1485 \f
1486 /* QoS unixctl user interface functions. */
1487
1488 struct qos_unixctl_show_cbdata {
1489     struct ds *ds;
1490     struct iface *iface;
1491 };
1492
1493 static void
1494 qos_unixctl_show_cb(unsigned int queue_id,
1495                     const struct shash *details,
1496                     void *aux)
1497 {
1498     struct qos_unixctl_show_cbdata *data = aux;
1499     struct ds *ds = data->ds;
1500     struct iface *iface = data->iface;
1501     struct netdev_queue_stats stats;
1502     struct shash_node *node;
1503     int error;
1504
1505     ds_put_cstr(ds, "\n");
1506     if (queue_id) {
1507         ds_put_format(ds, "Queue %u:\n", queue_id);
1508     } else {
1509         ds_put_cstr(ds, "Default:\n");
1510     }
1511
1512     SHASH_FOR_EACH (node, details) {
1513         ds_put_format(ds, "\t%s: %s\n", node->name, (char *)node->data);
1514     }
1515
1516     error = netdev_get_queue_stats(iface->netdev, queue_id, &stats);
1517     if (!error) {
1518         if (stats.tx_packets != UINT64_MAX) {
1519             ds_put_format(ds, "\ttx_packets: %"PRIu64"\n", stats.tx_packets);
1520         }
1521
1522         if (stats.tx_bytes != UINT64_MAX) {
1523             ds_put_format(ds, "\ttx_bytes: %"PRIu64"\n", stats.tx_bytes);
1524         }
1525
1526         if (stats.tx_errors != UINT64_MAX) {
1527             ds_put_format(ds, "\ttx_errors: %"PRIu64"\n", stats.tx_errors);
1528         }
1529     } else {
1530         ds_put_format(ds, "\tFailed to get statistics for queue %u: %s",
1531                       queue_id, strerror(error));
1532     }
1533 }
1534
1535 static void
1536 qos_unixctl_show(struct unixctl_conn *conn,
1537                  const char *args, void *aux OVS_UNUSED)
1538 {
1539     struct ds ds = DS_EMPTY_INITIALIZER;
1540     struct shash sh = SHASH_INITIALIZER(&sh);
1541     struct iface *iface;
1542     const char *type;
1543     struct shash_node *node;
1544     struct qos_unixctl_show_cbdata data;
1545     int error;
1546
1547     iface = iface_find(args);
1548     if (!iface) {
1549         unixctl_command_reply(conn, 501, "no such interface");
1550         return;
1551     }
1552
1553     netdev_get_qos(iface->netdev, &type, &sh);
1554
1555     if (*type != '\0') {
1556         ds_put_format(&ds, "QoS: %s %s\n", iface->name, type);
1557
1558         SHASH_FOR_EACH (node, &sh) {
1559             ds_put_format(&ds, "%s: %s\n", node->name, (char *)node->data);
1560         }
1561
1562         data.ds = &ds;
1563         data.iface = iface;
1564         error = netdev_dump_queues(iface->netdev, qos_unixctl_show_cb, &data);
1565
1566         if (error) {
1567             ds_put_format(&ds, "failed to dump queues: %s", strerror(error));
1568         }
1569         unixctl_command_reply(conn, 200, ds_cstr(&ds));
1570     } else {
1571         ds_put_format(&ds, "QoS not configured on %s\n", iface->name);
1572         unixctl_command_reply(conn, 501, ds_cstr(&ds));
1573     }
1574
1575     shash_destroy_free_data(&sh);
1576     ds_destroy(&ds);
1577 }
1578 \f
1579 /* Bridge reconfiguration functions. */
1580 static void
1581 bridge_create(const struct ovsrec_bridge *br_cfg)
1582 {
1583     struct bridge *br;
1584
1585     assert(!bridge_lookup(br_cfg->name));
1586     br = xzalloc(sizeof *br);
1587
1588     br->name = xstrdup(br_cfg->name);
1589     br->type = xstrdup(ofproto_normalize_type(br_cfg->datapath_type));
1590     br->cfg = br_cfg;
1591
1592     /* Derive the default Ethernet address from the bridge's UUID.  This should
1593      * be unique and it will be stable between ovs-vswitchd runs.  */
1594     memcpy(br->default_ea, &br_cfg->header_.uuid, ETH_ADDR_LEN);
1595     eth_addr_mark_random(br->default_ea);
1596
1597     hmap_init(&br->ports);
1598     hmap_init(&br->ifaces);
1599     hmap_init(&br->iface_by_name);
1600     hmap_init(&br->mirrors);
1601
1602     hmap_insert(&all_bridges, &br->node, hash_string(br->name, 0));
1603 }
1604
1605 static void
1606 bridge_destroy(struct bridge *br)
1607 {
1608     if (br) {
1609         struct mirror *mirror, *next_mirror;
1610         struct port *port, *next_port;
1611
1612         HMAP_FOR_EACH_SAFE (port, next_port, hmap_node, &br->ports) {
1613             port_destroy(port);
1614         }
1615         HMAP_FOR_EACH_SAFE (mirror, next_mirror, hmap_node, &br->mirrors) {
1616             mirror_destroy(mirror);
1617         }
1618         hmap_remove(&all_bridges, &br->node);
1619         ofproto_destroy(br->ofproto);
1620         hmap_destroy(&br->ifaces);
1621         hmap_destroy(&br->ports);
1622         hmap_destroy(&br->iface_by_name);
1623         hmap_destroy(&br->mirrors);
1624         free(br->name);
1625         free(br->type);
1626         free(br);
1627     }
1628 }
1629
1630 static struct bridge *
1631 bridge_lookup(const char *name)
1632 {
1633     struct bridge *br;
1634
1635     HMAP_FOR_EACH_WITH_HASH (br, node, hash_string(name, 0), &all_bridges) {
1636         if (!strcmp(br->name, name)) {
1637             return br;
1638         }
1639     }
1640     return NULL;
1641 }
1642
1643 /* Handle requests for a listing of all flows known by the OpenFlow
1644  * stack, including those normally hidden. */
1645 static void
1646 bridge_unixctl_dump_flows(struct unixctl_conn *conn,
1647                           const char *args, void *aux OVS_UNUSED)
1648 {
1649     struct bridge *br;
1650     struct ds results;
1651
1652     br = bridge_lookup(args);
1653     if (!br) {
1654         unixctl_command_reply(conn, 501, "Unknown bridge");
1655         return;
1656     }
1657
1658     ds_init(&results);
1659     ofproto_get_all_flows(br->ofproto, &results);
1660
1661     unixctl_command_reply(conn, 200, ds_cstr(&results));
1662     ds_destroy(&results);
1663 }
1664
1665 /* "bridge/reconnect [BRIDGE]": makes BRIDGE drop all of its controller
1666  * connections and reconnect.  If BRIDGE is not specified, then all bridges
1667  * drop their controller connections and reconnect. */
1668 static void
1669 bridge_unixctl_reconnect(struct unixctl_conn *conn,
1670                          const char *args, void *aux OVS_UNUSED)
1671 {
1672     struct bridge *br;
1673     if (args[0] != '\0') {
1674         br = bridge_lookup(args);
1675         if (!br) {
1676             unixctl_command_reply(conn, 501, "Unknown bridge");
1677             return;
1678         }
1679         ofproto_reconnect_controllers(br->ofproto);
1680     } else {
1681         HMAP_FOR_EACH (br, node, &all_bridges) {
1682             ofproto_reconnect_controllers(br->ofproto);
1683         }
1684     }
1685     unixctl_command_reply(conn, 200, NULL);
1686 }
1687
1688 static size_t
1689 bridge_get_controllers(const struct bridge *br,
1690                        struct ovsrec_controller ***controllersp)
1691 {
1692     struct ovsrec_controller **controllers;
1693     size_t n_controllers;
1694
1695     controllers = br->cfg->controller;
1696     n_controllers = br->cfg->n_controller;
1697
1698     if (n_controllers == 1 && !strcmp(controllers[0]->target, "none")) {
1699         controllers = NULL;
1700         n_controllers = 0;
1701     }
1702
1703     if (controllersp) {
1704         *controllersp = controllers;
1705     }
1706     return n_controllers;
1707 }
1708
1709 /* Adds and deletes "struct port"s and "struct iface"s under 'br' to match
1710  * those configured in 'br->cfg'. */
1711 static void
1712 bridge_add_del_ports(struct bridge *br)
1713 {
1714     struct port *port, *next;
1715     struct shash_node *node;
1716     struct shash new_ports;
1717     size_t i;
1718
1719     /* Collect new ports. */
1720     shash_init(&new_ports);
1721     for (i = 0; i < br->cfg->n_ports; i++) {
1722         const char *name = br->cfg->ports[i]->name;
1723         if (!shash_add_once(&new_ports, name, br->cfg->ports[i])) {
1724             VLOG_WARN("bridge %s: %s specified twice as bridge port",
1725                       br->name, name);
1726         }
1727     }
1728     if (bridge_get_controllers(br, NULL)
1729         && !shash_find(&new_ports, br->name)) {
1730         VLOG_WARN("bridge %s: no port named %s, synthesizing one",
1731                   br->name, br->name);
1732
1733         br->synth_local_port.interfaces = &br->synth_local_ifacep;
1734         br->synth_local_port.n_interfaces = 1;
1735         br->synth_local_port.name = br->name;
1736
1737         br->synth_local_iface.name = br->name;
1738         br->synth_local_iface.type = "internal";
1739
1740         br->synth_local_ifacep = &br->synth_local_iface;
1741
1742         shash_add(&new_ports, br->name, &br->synth_local_port);
1743     }
1744
1745     /* Get rid of deleted ports.
1746      * Get rid of deleted interfaces on ports that still exist.
1747      * Update 'cfg' of ports that still exist. */
1748     HMAP_FOR_EACH_SAFE (port, next, hmap_node, &br->ports) {
1749         port->cfg = shash_find_data(&new_ports, port->name);
1750         if (!port->cfg) {
1751             port_destroy(port);
1752         } else {
1753             port_del_ifaces(port);
1754         }
1755     }
1756
1757     /* Create new ports.
1758      * Add new interfaces to existing ports. */
1759     SHASH_FOR_EACH (node, &new_ports) {
1760         struct port *port = port_lookup(br, node->name);
1761         if (!port) {
1762             struct ovsrec_port *cfg = node->data;
1763             port = port_create(br, cfg);
1764         }
1765         port_add_ifaces(port);
1766         if (list_is_empty(&port->ifaces)) {
1767             VLOG_WARN("bridge %s: port %s has no interfaces, dropping",
1768                       br->name, port->name);
1769             port_destroy(port);
1770         }
1771     }
1772     shash_destroy(&new_ports);
1773 }
1774
1775 /* Initializes 'oc' appropriately as a management service controller for
1776  * 'br'.
1777  *
1778  * The caller must free oc->target when it is no longer needed. */
1779 static void
1780 bridge_ofproto_controller_for_mgmt(const struct bridge *br,
1781                                    struct ofproto_controller *oc)
1782 {
1783     oc->target = xasprintf("punix:%s/%s.mgmt", ovs_rundir(), br->name);
1784     oc->max_backoff = 0;
1785     oc->probe_interval = 60;
1786     oc->band = OFPROTO_OUT_OF_BAND;
1787     oc->rate_limit = 0;
1788     oc->burst_limit = 0;
1789 }
1790
1791 /* Converts ovsrec_controller 'c' into an ofproto_controller in 'oc'.  */
1792 static void
1793 bridge_ofproto_controller_from_ovsrec(const struct ovsrec_controller *c,
1794                                       struct ofproto_controller *oc)
1795 {
1796     oc->target = c->target;
1797     oc->max_backoff = c->max_backoff ? *c->max_backoff / 1000 : 8;
1798     oc->probe_interval = c->inactivity_probe ? *c->inactivity_probe / 1000 : 5;
1799     oc->band = (!c->connection_mode || !strcmp(c->connection_mode, "in-band")
1800                 ? OFPROTO_IN_BAND : OFPROTO_OUT_OF_BAND);
1801     oc->rate_limit = c->controller_rate_limit ? *c->controller_rate_limit : 0;
1802     oc->burst_limit = (c->controller_burst_limit
1803                        ? *c->controller_burst_limit : 0);
1804 }
1805
1806 /* Configures the IP stack for 'br''s local interface properly according to the
1807  * configuration in 'c'.  */
1808 static void
1809 bridge_configure_local_iface_netdev(struct bridge *br,
1810                                     struct ovsrec_controller *c)
1811 {
1812     struct netdev *netdev;
1813     struct in_addr mask, gateway;
1814
1815     struct iface *local_iface;
1816     struct in_addr ip;
1817
1818     /* If there's no local interface or no IP address, give up. */
1819     local_iface = iface_from_ofp_port(br, OFPP_LOCAL);
1820     if (!local_iface || !c->local_ip || !inet_aton(c->local_ip, &ip)) {
1821         return;
1822     }
1823
1824     /* Bring up the local interface. */
1825     netdev = local_iface->netdev;
1826     netdev_turn_flags_on(netdev, NETDEV_UP, true);
1827
1828     /* Configure the IP address and netmask. */
1829     if (!c->local_netmask
1830         || !inet_aton(c->local_netmask, &mask)
1831         || !mask.s_addr) {
1832         mask.s_addr = guess_netmask(ip.s_addr);
1833     }
1834     if (!netdev_set_in4(netdev, ip, mask)) {
1835         VLOG_INFO("bridge %s: configured IP address "IP_FMT", netmask "IP_FMT,
1836                   br->name, IP_ARGS(&ip.s_addr), IP_ARGS(&mask.s_addr));
1837     }
1838
1839     /* Configure the default gateway. */
1840     if (c->local_gateway
1841         && inet_aton(c->local_gateway, &gateway)
1842         && gateway.s_addr) {
1843         if (!netdev_add_router(netdev, gateway)) {
1844             VLOG_INFO("bridge %s: configured gateway "IP_FMT,
1845                       br->name, IP_ARGS(&gateway.s_addr));
1846         }
1847     }
1848 }
1849
1850 static void
1851 bridge_configure_remotes(struct bridge *br,
1852                          const struct sockaddr_in *managers, size_t n_managers)
1853 {
1854     const char *disable_ib_str, *queue_id_str;
1855     bool disable_in_band = false;
1856     int queue_id;
1857
1858     struct ovsrec_controller **controllers;
1859     size_t n_controllers;
1860
1861     enum ofproto_fail_mode fail_mode;
1862
1863     struct ofproto_controller *ocs;
1864     size_t n_ocs;
1865     size_t i;
1866
1867     /* Check if we should disable in-band control on this bridge. */
1868     disable_ib_str = bridge_get_other_config(br->cfg, "disable-in-band");
1869     if (disable_ib_str && !strcmp(disable_ib_str, "true")) {
1870         disable_in_band = true;
1871     }
1872
1873     /* Set OpenFlow queue ID for in-band control. */
1874     queue_id_str = bridge_get_other_config(br->cfg, "in-band-queue");
1875     queue_id = queue_id_str ? strtol(queue_id_str, NULL, 10) : -1;
1876     ofproto_set_in_band_queue(br->ofproto, queue_id);
1877
1878     if (disable_in_band) {
1879         ofproto_set_extra_in_band_remotes(br->ofproto, NULL, 0);
1880     } else {
1881         ofproto_set_extra_in_band_remotes(br->ofproto, managers, n_managers);
1882     }
1883
1884     n_controllers = bridge_get_controllers(br, &controllers);
1885
1886     ocs = xmalloc((n_controllers + 1) * sizeof *ocs);
1887     n_ocs = 0;
1888
1889     bridge_ofproto_controller_for_mgmt(br, &ocs[n_ocs++]);
1890     for (i = 0; i < n_controllers; i++) {
1891         struct ovsrec_controller *c = controllers[i];
1892
1893         if (!strncmp(c->target, "punix:", 6)
1894             || !strncmp(c->target, "unix:", 5)) {
1895             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1896
1897             /* Prevent remote ovsdb-server users from accessing arbitrary Unix
1898              * domain sockets and overwriting arbitrary local files. */
1899             VLOG_ERR_RL(&rl, "bridge %s: not adding Unix domain socket "
1900                         "controller \"%s\" due to possibility for remote "
1901                         "exploit", br->name, c->target);
1902             continue;
1903         }
1904
1905         bridge_configure_local_iface_netdev(br, c);
1906         bridge_ofproto_controller_from_ovsrec(c, &ocs[n_ocs]);
1907         if (disable_in_band) {
1908             ocs[n_ocs].band = OFPROTO_OUT_OF_BAND;
1909         }
1910         n_ocs++;
1911     }
1912
1913     ofproto_set_controllers(br->ofproto, ocs, n_ocs);
1914     free(ocs[0].target); /* From bridge_ofproto_controller_for_mgmt(). */
1915     free(ocs);
1916
1917     /* Set the fail-mode. */
1918     fail_mode = !br->cfg->fail_mode
1919                 || !strcmp(br->cfg->fail_mode, "standalone")
1920                     ? OFPROTO_FAIL_STANDALONE
1921                     : OFPROTO_FAIL_SECURE;
1922     ofproto_set_fail_mode(br->ofproto, fail_mode);
1923
1924     /* Configure OpenFlow controller connection snooping. */
1925     if (!ofproto_has_snoops(br->ofproto)) {
1926         struct sset snoops;
1927
1928         sset_init(&snoops);
1929         sset_add_and_free(&snoops, xasprintf("punix:%s/%s.snoop",
1930                                              ovs_rundir(), br->name));
1931         ofproto_set_snoops(br->ofproto, &snoops);
1932         sset_destroy(&snoops);
1933     }
1934 }
1935 \f
1936 /* Port functions. */
1937
1938 static struct port *
1939 port_create(struct bridge *br, const struct ovsrec_port *cfg)
1940 {
1941     struct port *port;
1942
1943     port = xzalloc(sizeof *port);
1944     port->bridge = br;
1945     port->name = xstrdup(cfg->name);
1946     port->cfg = cfg;
1947     list_init(&port->ifaces);
1948
1949     hmap_insert(&br->ports, &port->hmap_node, hash_string(port->name, 0));
1950
1951     VLOG_INFO("created port %s on bridge %s", port->name, br->name);
1952
1953     return port;
1954 }
1955
1956 static const char *
1957 get_port_other_config(const struct ovsrec_port *port, const char *key,
1958                       const char *default_value)
1959 {
1960     const char *value;
1961
1962     value = get_ovsrec_key_value(&port->header_, &ovsrec_port_col_other_config,
1963                                  key);
1964     return value ? value : default_value;
1965 }
1966
1967 static const char *
1968 get_interface_other_config(const struct ovsrec_interface *iface,
1969                            const char *key, const char *default_value)
1970 {
1971     const char *value;
1972
1973     value = get_ovsrec_key_value(&iface->header_,
1974                                  &ovsrec_interface_col_other_config, key);
1975     return value ? value : default_value;
1976 }
1977
1978 /* Deletes interfaces from 'port' that are no longer configured for it. */
1979 static void
1980 port_del_ifaces(struct port *port)
1981 {
1982     struct iface *iface, *next;
1983     struct sset new_ifaces;
1984     size_t i;
1985
1986     /* Collect list of new interfaces. */
1987     sset_init(&new_ifaces);
1988     for (i = 0; i < port->cfg->n_interfaces; i++) {
1989         const char *name = port->cfg->interfaces[i]->name;
1990         const char *type = port->cfg->interfaces[i]->name;
1991         if (strcmp(type, "null")) {
1992             sset_add(&new_ifaces, name);
1993         }
1994     }
1995
1996     /* Get rid of deleted interfaces. */
1997     LIST_FOR_EACH_SAFE (iface, next, port_elem, &port->ifaces) {
1998         if (!sset_contains(&new_ifaces, iface->name)) {
1999             iface_destroy(iface);
2000         }
2001     }
2002
2003     sset_destroy(&new_ifaces);
2004 }
2005
2006 /* Adds new interfaces to 'port' and updates 'type' and 'cfg' members of
2007  * existing ones. */
2008 static void
2009 port_add_ifaces(struct port *port)
2010 {
2011     struct shash new_ifaces;
2012     struct shash_node *node;
2013     size_t i;
2014
2015     /* Collect new ifaces. */
2016     shash_init(&new_ifaces);
2017     for (i = 0; i < port->cfg->n_interfaces; i++) {
2018         const struct ovsrec_interface *cfg = port->cfg->interfaces[i];
2019         if (strcmp(cfg->type, "null")
2020             && !shash_add_once(&new_ifaces, cfg->name, cfg)) {
2021             VLOG_WARN("port %s: %s specified twice as port interface",
2022                       port->name, cfg->name);
2023             iface_set_ofport(cfg, -1);
2024         }
2025     }
2026
2027     /* Create new interfaces.
2028      * Update interface types and 'cfg' members. */
2029     SHASH_FOR_EACH (node, &new_ifaces) {
2030         const struct ovsrec_interface *cfg = node->data;
2031         const char *iface_name = node->name;
2032         struct iface *iface;
2033
2034         iface = iface_lookup(port->bridge, iface_name);
2035         if (!iface) {
2036             iface = iface_create(port, cfg);
2037         } else {
2038             iface->cfg = cfg;
2039         }
2040
2041         /* Determine interface type.  The local port always has type
2042          * "internal".  Other ports take their type from the database and
2043          * default to "system" if none is specified. */
2044         iface->type = (!strcmp(iface_name, port->bridge->name) ? "internal"
2045                        : cfg->type[0] ? cfg->type
2046                        : "system");
2047     }
2048     shash_destroy(&new_ifaces);
2049 }
2050
2051 static void
2052 port_destroy(struct port *port)
2053 {
2054     if (port) {
2055         struct bridge *br = port->bridge;
2056         struct iface *iface, *next;
2057
2058         if (br->ofproto) {
2059             ofproto_bundle_unregister(br->ofproto, port);
2060         }
2061
2062         LIST_FOR_EACH_SAFE (iface, next, port_elem, &port->ifaces) {
2063             iface_destroy(iface);
2064         }
2065
2066         hmap_remove(&br->ports, &port->hmap_node);
2067
2068         VLOG_INFO("destroyed port %s on bridge %s", port->name, br->name);
2069
2070         free(port->name);
2071         free(port);
2072     }
2073 }
2074
2075 static struct port *
2076 port_lookup(const struct bridge *br, const char *name)
2077 {
2078     struct port *port;
2079
2080     HMAP_FOR_EACH_WITH_HASH (port, hmap_node, hash_string(name, 0),
2081                              &br->ports) {
2082         if (!strcmp(port->name, name)) {
2083             return port;
2084         }
2085     }
2086     return NULL;
2087 }
2088
2089 static bool
2090 enable_lacp(struct port *port, bool *activep)
2091 {
2092     if (!port->cfg->lacp) {
2093         /* XXX when LACP implementation has been sufficiently tested, enable by
2094          * default and make active on bonded ports. */
2095         return false;
2096     } else if (!strcmp(port->cfg->lacp, "off")) {
2097         return false;
2098     } else if (!strcmp(port->cfg->lacp, "active")) {
2099         *activep = true;
2100         return true;
2101     } else if (!strcmp(port->cfg->lacp, "passive")) {
2102         *activep = false;
2103         return true;
2104     } else {
2105         VLOG_WARN("port %s: unknown LACP mode %s",
2106                   port->name, port->cfg->lacp);
2107         return false;
2108     }
2109 }
2110
2111 static struct lacp_settings *
2112 port_configure_lacp(struct port *port, struct lacp_settings *s)
2113 {
2114     const char *lacp_time;
2115     long long int custom_time;
2116     int priority;
2117
2118     if (!enable_lacp(port, &s->active)) {
2119         return NULL;
2120     }
2121
2122     s->name = port->name;
2123     memcpy(s->id, port->bridge->ea, ETH_ADDR_LEN);
2124
2125     /* Prefer bondable links if unspecified. */
2126     priority = atoi(get_port_other_config(port->cfg, "lacp-system-priority",
2127                                           "0"));
2128     s->priority = (priority > 0 && priority <= UINT16_MAX
2129                    ? priority
2130                    : UINT16_MAX - !list_is_short(&port->ifaces));
2131
2132     s->heartbeat = !strcmp(get_port_other_config(port->cfg,
2133                                                  "lacp-heartbeat",
2134                                                  "false"), "true");
2135
2136
2137     lacp_time = get_port_other_config(port->cfg, "lacp-time", "slow");
2138     custom_time = atoi(lacp_time);
2139     if (!strcmp(lacp_time, "fast")) {
2140         s->lacp_time = LACP_TIME_FAST;
2141     } else if (!strcmp(lacp_time, "slow")) {
2142         s->lacp_time = LACP_TIME_SLOW;
2143     } else if (custom_time > 0) {
2144         s->lacp_time = LACP_TIME_CUSTOM;
2145         s->custom_time = custom_time;
2146     } else {
2147         s->lacp_time = LACP_TIME_SLOW;
2148     }
2149
2150     return s;
2151 }
2152
2153 static void
2154 iface_configure_lacp(struct iface *iface, struct lacp_slave_settings *s)
2155 {
2156     int priority, portid, key;
2157
2158     portid = atoi(get_interface_other_config(iface->cfg, "lacp-port-id", "0"));
2159     priority = atoi(get_interface_other_config(iface->cfg,
2160                                                "lacp-port-priority", "0"));
2161     key = atoi(get_interface_other_config(iface->cfg, "lacp-aggregation-key",
2162                                           "0"));
2163
2164     if (portid <= 0 || portid > UINT16_MAX) {
2165         portid = iface->ofp_port;
2166     }
2167
2168     if (priority <= 0 || priority > UINT16_MAX) {
2169         priority = UINT16_MAX;
2170     }
2171
2172     if (key < 0 || key > UINT16_MAX) {
2173         key = 0;
2174     }
2175
2176     s->name = iface->name;
2177     s->id = portid;
2178     s->priority = priority;
2179     s->key = key;
2180 }
2181
2182 static void
2183 port_configure_bond(struct port *port, struct bond_settings *s,
2184                     uint32_t *bond_stable_ids)
2185 {
2186     const char *detect_s;
2187     struct iface *iface;
2188     int miimon_interval;
2189     size_t i;
2190
2191     s->name = port->name;
2192     s->balance = BM_SLB;
2193     if (port->cfg->bond_mode
2194         && !bond_mode_from_string(&s->balance, port->cfg->bond_mode)) {
2195         VLOG_WARN("port %s: unknown bond_mode %s, defaulting to %s",
2196                   port->name, port->cfg->bond_mode,
2197                   bond_mode_to_string(s->balance));
2198     }
2199
2200     miimon_interval = atoi(get_port_other_config(port->cfg,
2201                                                  "bond-miimon-interval", "0"));
2202     if (miimon_interval <= 0) {
2203         miimon_interval = 200;
2204     }
2205
2206     detect_s = get_port_other_config(port->cfg, "bond-detect-mode", "carrier");
2207     if (!strcmp(detect_s, "carrier")) {
2208         miimon_interval = 0;
2209     } else if (strcmp(detect_s, "miimon")) {
2210         VLOG_WARN("port %s: unsupported bond-detect-mode %s, "
2211                   "defaulting to carrier", port->name, detect_s);
2212         miimon_interval = 0;
2213     }
2214
2215     s->up_delay = MAX(0, port->cfg->bond_updelay);
2216     s->down_delay = MAX(0, port->cfg->bond_downdelay);
2217     s->basis = atoi(get_port_other_config(port->cfg, "bond-hash-basis", "0"));
2218     s->rebalance_interval = atoi(
2219         get_port_other_config(port->cfg, "bond-rebalance-interval", "10000"));
2220     if (s->rebalance_interval < 1000) {
2221         s->rebalance_interval = 1000;
2222     }
2223
2224     s->fake_iface = port->cfg->bond_fake_iface;
2225
2226     i = 0;
2227     LIST_FOR_EACH (iface, port_elem, &port->ifaces) {
2228         long long stable_id;
2229
2230         stable_id = atoll(get_interface_other_config(iface->cfg,
2231                                                      "bond-stable-id", "0"));
2232         if (stable_id <= 0 || stable_id >= UINT32_MAX) {
2233             stable_id = iface->ofp_port;
2234         }
2235         bond_stable_ids[i++] = stable_id;
2236
2237         netdev_set_miimon_interval(iface->netdev, miimon_interval);
2238     }
2239 }
2240 \f
2241 /* Interface functions. */
2242
2243 static struct iface *
2244 iface_create(struct port *port, const struct ovsrec_interface *if_cfg)
2245 {
2246     struct bridge *br = port->bridge;
2247     struct iface *iface;
2248     char *name = if_cfg->name;
2249
2250     iface = xzalloc(sizeof *iface);
2251     iface->port = port;
2252     iface->name = xstrdup(name);
2253     iface->ofp_port = -1;
2254     iface->tag = tag_create_random();
2255     iface->netdev = NULL;
2256     iface->cfg = if_cfg;
2257
2258     hmap_insert(&br->iface_by_name, &iface->name_node, hash_string(name, 0));
2259
2260     list_push_back(&port->ifaces, &iface->port_elem);
2261
2262     VLOG_DBG("attached network device %s to port %s", iface->name, port->name);
2263
2264     return iface;
2265 }
2266
2267 static void
2268 iface_destroy(struct iface *iface)
2269 {
2270     if (iface) {
2271         struct port *port = iface->port;
2272         struct bridge *br = port->bridge;
2273
2274         if (br->ofproto && iface->ofp_port >= 0) {
2275             ofproto_port_unregister(br->ofproto, iface->ofp_port);
2276         }
2277
2278         if (iface->ofp_port >= 0) {
2279             hmap_remove(&br->ifaces, &iface->ofp_port_node);
2280         }
2281
2282         list_remove(&iface->port_elem);
2283         hmap_remove(&br->iface_by_name, &iface->name_node);
2284
2285         netdev_close(iface->netdev);
2286
2287         free(iface->name);
2288         free(iface);
2289     }
2290 }
2291
2292 static struct iface *
2293 iface_lookup(const struct bridge *br, const char *name)
2294 {
2295     struct iface *iface;
2296
2297     HMAP_FOR_EACH_WITH_HASH (iface, name_node, hash_string(name, 0),
2298                              &br->iface_by_name) {
2299         if (!strcmp(iface->name, name)) {
2300             return iface;
2301         }
2302     }
2303
2304     return NULL;
2305 }
2306
2307 static struct iface *
2308 iface_find(const char *name)
2309 {
2310     const struct bridge *br;
2311
2312     HMAP_FOR_EACH (br, node, &all_bridges) {
2313         struct iface *iface = iface_lookup(br, name);
2314
2315         if (iface) {
2316             return iface;
2317         }
2318     }
2319     return NULL;
2320 }
2321
2322 static struct iface *
2323 iface_from_ofp_port(const struct bridge *br, uint16_t ofp_port)
2324 {
2325     struct iface *iface;
2326
2327     HMAP_FOR_EACH_IN_BUCKET (iface, ofp_port_node,
2328                              hash_int(ofp_port, 0), &br->ifaces) {
2329         if (iface->ofp_port == ofp_port) {
2330             return iface;
2331         }
2332     }
2333     return NULL;
2334 }
2335
2336 /* Set Ethernet address of 'iface', if one is specified in the configuration
2337  * file. */
2338 static void
2339 iface_set_mac(struct iface *iface)
2340 {
2341     uint8_t ea[ETH_ADDR_LEN];
2342
2343     if (!strcmp(iface->type, "internal")
2344         && iface->cfg->mac && eth_addr_from_string(iface->cfg->mac, ea)) {
2345         if (iface->ofp_port == OFPP_LOCAL) {
2346             VLOG_ERR("interface %s: ignoring mac in Interface record "
2347                      "(use Bridge record to set local port's mac)",
2348                      iface->name);
2349         } else if (eth_addr_is_multicast(ea)) {
2350             VLOG_ERR("interface %s: cannot set MAC to multicast address",
2351                      iface->name);
2352         } else {
2353             int error = netdev_set_etheraddr(iface->netdev, ea);
2354             if (error) {
2355                 VLOG_ERR("interface %s: setting MAC failed (%s)",
2356                          iface->name, strerror(error));
2357             }
2358         }
2359     }
2360 }
2361
2362 /* Sets the ofport column of 'if_cfg' to 'ofport'. */
2363 static void
2364 iface_set_ofport(const struct ovsrec_interface *if_cfg, int64_t ofport)
2365 {
2366     if (if_cfg && !ovsdb_idl_row_is_synthetic(&if_cfg->header_)) {
2367         ovsrec_interface_set_ofport(if_cfg, &ofport, 1);
2368     }
2369 }
2370
2371 /* Adds the 'n' key-value pairs in 'keys' in 'values' to 'shash'.
2372  *
2373  * The value strings in '*shash' are taken directly from values[], not copied,
2374  * so the caller should not modify or free them. */
2375 static void
2376 shash_from_ovs_idl_map(char **keys, char **values, size_t n,
2377                        struct shash *shash)
2378 {
2379     size_t i;
2380
2381     shash_init(shash);
2382     for (i = 0; i < n; i++) {
2383         shash_add(shash, keys[i], values[i]);
2384     }
2385 }
2386
2387 /* Creates 'keys' and 'values' arrays from 'shash'.
2388  *
2389  * Sets 'keys' and 'values' to heap allocated arrays representing the key-value
2390  * pairs in 'shash'.  The caller takes ownership of 'keys' and 'values'.  They
2391  * are populated with with strings taken directly from 'shash' and thus have
2392  * the same ownership of the key-value pairs in shash.
2393  */
2394 static void
2395 shash_to_ovs_idl_map(struct shash *shash,
2396                      char ***keys, char ***values, size_t *n)
2397 {
2398     size_t i, count;
2399     char **k, **v;
2400     struct shash_node *sn;
2401
2402     count = shash_count(shash);
2403
2404     k = xmalloc(count * sizeof *k);
2405     v = xmalloc(count * sizeof *v);
2406
2407     i = 0;
2408     SHASH_FOR_EACH(sn, shash) {
2409         k[i] = sn->name;
2410         v[i] = sn->data;
2411         i++;
2412     }
2413
2414     *n      = count;
2415     *keys   = k;
2416     *values = v;
2417 }
2418
2419 struct iface_delete_queues_cbdata {
2420     struct netdev *netdev;
2421     const struct ovsdb_datum *queues;
2422 };
2423
2424 static bool
2425 queue_ids_include(const struct ovsdb_datum *queues, int64_t target)
2426 {
2427     union ovsdb_atom atom;
2428
2429     atom.integer = target;
2430     return ovsdb_datum_find_key(queues, &atom, OVSDB_TYPE_INTEGER) != UINT_MAX;
2431 }
2432
2433 static void
2434 iface_delete_queues(unsigned int queue_id,
2435                     const struct shash *details OVS_UNUSED, void *cbdata_)
2436 {
2437     struct iface_delete_queues_cbdata *cbdata = cbdata_;
2438
2439     if (!queue_ids_include(cbdata->queues, queue_id)) {
2440         netdev_delete_queue(cbdata->netdev, queue_id);
2441     }
2442 }
2443
2444 static void
2445 iface_configure_qos(struct iface *iface, const struct ovsrec_qos *qos)
2446 {
2447     if (!qos || qos->type[0] == '\0' || qos->n_queues < 1) {
2448         netdev_set_qos(iface->netdev, NULL, NULL);
2449     } else {
2450         struct iface_delete_queues_cbdata cbdata;
2451         struct shash details;
2452         size_t i;
2453
2454         /* Configure top-level Qos for 'iface'. */
2455         shash_from_ovs_idl_map(qos->key_other_config, qos->value_other_config,
2456                                qos->n_other_config, &details);
2457         netdev_set_qos(iface->netdev, qos->type, &details);
2458         shash_destroy(&details);
2459
2460         /* Deconfigure queues that were deleted. */
2461         cbdata.netdev = iface->netdev;
2462         cbdata.queues = ovsrec_qos_get_queues(qos, OVSDB_TYPE_INTEGER,
2463                                               OVSDB_TYPE_UUID);
2464         netdev_dump_queues(iface->netdev, iface_delete_queues, &cbdata);
2465
2466         /* Configure queues for 'iface'. */
2467         for (i = 0; i < qos->n_queues; i++) {
2468             const struct ovsrec_queue *queue = qos->value_queues[i];
2469             unsigned int queue_id = qos->key_queues[i];
2470
2471             shash_from_ovs_idl_map(queue->key_other_config,
2472                                    queue->value_other_config,
2473                                    queue->n_other_config, &details);
2474             netdev_set_queue(iface->netdev, queue_id, &details);
2475             shash_destroy(&details);
2476         }
2477     }
2478
2479     netdev_set_policing(iface->netdev,
2480                         iface->cfg->ingress_policing_rate,
2481                         iface->cfg->ingress_policing_burst);
2482 }
2483
2484 static void
2485 iface_configure_cfm(struct iface *iface)
2486 {
2487     const struct ovsrec_interface *cfg = iface->cfg;
2488     struct cfm_settings s;
2489     uint16_t remote_mpid;
2490
2491     if (!cfg->n_cfm_mpid || !cfg->n_cfm_remote_mpid) {
2492         ofproto_port_clear_cfm(iface->port->bridge->ofproto, iface->ofp_port);
2493         return;
2494     }
2495
2496     s.name = iface->name;
2497     s.mpid = *cfg->cfm_mpid;
2498     remote_mpid = *cfg->cfm_remote_mpid;
2499     s.remote_mpids = &remote_mpid;
2500     s.n_remote_mpids = 1;
2501
2502     s.interval = atoi(get_interface_other_config(iface->cfg, "cfm_interval",
2503                                                  "0"));
2504     if (s.interval <= 0) {
2505         s.interval = 1000;
2506     }
2507
2508     ofproto_port_set_cfm(iface->port->bridge->ofproto, iface->ofp_port, &s);
2509 }
2510
2511 /* Read carrier or miimon status directly from 'iface''s netdev, according to
2512  * how 'iface''s port is configured.
2513  *
2514  * Returns true if 'iface' is up, false otherwise. */
2515 static bool
2516 iface_get_carrier(const struct iface *iface)
2517 {
2518     /* XXX */
2519     return netdev_get_carrier(iface->netdev);
2520 }
2521
2522 /* Returns true if 'iface' is synthetic, that is, if we constructed it locally
2523  * instead of obtaining it from the database. */
2524 static bool
2525 iface_is_synthetic(const struct iface *iface)
2526 {
2527     return ovsdb_idl_row_is_synthetic(&iface->cfg->header_);
2528 }
2529 \f
2530 /* Port mirroring. */
2531
2532 static struct mirror *
2533 mirror_find_by_uuid(struct bridge *br, const struct uuid *uuid)
2534 {
2535     struct mirror *m;
2536
2537     HMAP_FOR_EACH_IN_BUCKET (m, hmap_node, uuid_hash(uuid), &br->mirrors) {
2538         if (uuid_equals(uuid, &m->uuid)) {
2539             return m;
2540         }
2541     }
2542     return NULL;
2543 }
2544
2545 static void
2546 bridge_configure_mirrors(struct bridge *br)
2547 {
2548     const struct ovsdb_datum *mc;
2549     unsigned long *flood_vlans;
2550     struct mirror *m, *next;
2551     size_t i;
2552
2553     /* Get rid of deleted mirrors. */
2554     mc = ovsrec_bridge_get_mirrors(br->cfg, OVSDB_TYPE_UUID);
2555     HMAP_FOR_EACH_SAFE (m, next, hmap_node, &br->mirrors) {
2556         union ovsdb_atom atom;
2557
2558         atom.uuid = m->uuid;
2559         if (ovsdb_datum_find_key(mc, &atom, OVSDB_TYPE_UUID) == UINT_MAX) {
2560             mirror_destroy(m);
2561         }
2562     }
2563
2564     /* Add new mirrors and reconfigure existing ones. */
2565     for (i = 0; i < br->cfg->n_mirrors; i++) {
2566         const struct ovsrec_mirror *cfg = br->cfg->mirrors[i];
2567         struct mirror *m = mirror_find_by_uuid(br, &cfg->header_.uuid);
2568         if (!m) {
2569             m = mirror_create(br, cfg);
2570         }
2571         if (!mirror_configure(m, cfg)) {
2572             mirror_destroy(m);
2573         }
2574     }
2575
2576     /* Update flooded vlans (for RSPAN). */
2577     flood_vlans = vlan_bitmap_from_array(br->cfg->flood_vlans,
2578                                          br->cfg->n_flood_vlans);
2579     ofproto_set_flood_vlans(br->ofproto, flood_vlans);
2580     bitmap_free(flood_vlans);
2581 }
2582
2583 static struct mirror *
2584 mirror_create(struct bridge *br, const struct ovsrec_mirror *cfg)
2585 {
2586     struct mirror *m;
2587
2588     m = xzalloc(sizeof *m);
2589     m->uuid = cfg->header_.uuid;
2590     hmap_insert(&br->mirrors, &m->hmap_node, uuid_hash(&m->uuid));
2591     m->bridge = br;
2592     m->name = xstrdup(cfg->name);
2593
2594     return m;
2595 }
2596
2597 static void
2598 mirror_destroy(struct mirror *m)
2599 {
2600     if (m) {
2601         struct bridge *br = m->bridge;
2602
2603         if (br->ofproto) {
2604             ofproto_mirror_unregister(br->ofproto, m);
2605         }
2606
2607         hmap_remove(&br->mirrors, &m->hmap_node);
2608         free(m->name);
2609         free(m);
2610     }
2611 }
2612
2613 static void
2614 mirror_collect_ports(struct mirror *m,
2615                      struct ovsrec_port **in_ports, int n_in_ports,
2616                      void ***out_portsp, size_t *n_out_portsp)
2617 {
2618     void **out_ports = xmalloc(n_in_ports * sizeof *out_ports);
2619     size_t n_out_ports = 0;
2620     size_t i;
2621
2622     for (i = 0; i < n_in_ports; i++) {
2623         const char *name = in_ports[i]->name;
2624         struct port *port = port_lookup(m->bridge, name);
2625         if (port) {
2626             out_ports[n_out_ports++] = port;
2627         } else {
2628             VLOG_WARN("bridge %s: mirror %s cannot match on nonexistent "
2629                       "port %s", m->bridge->name, m->name, name);
2630         }
2631     }
2632     *out_portsp = out_ports;
2633     *n_out_portsp = n_out_ports;
2634 }
2635
2636 static bool
2637 mirror_configure(struct mirror *m, const struct ovsrec_mirror *cfg)
2638 {
2639     struct ofproto_mirror_settings s;
2640
2641     /* Set name. */
2642     if (strcmp(cfg->name, m->name)) {
2643         free(m->name);
2644         m->name = xstrdup(cfg->name);
2645     }
2646     s.name = m->name;
2647
2648     /* Get output port or VLAN. */
2649     if (cfg->output_port) {
2650         s.out_bundle = port_lookup(m->bridge, cfg->output_port->name);
2651         if (!s.out_bundle) {
2652             VLOG_ERR("bridge %s: mirror %s outputs to port not on bridge",
2653                      m->bridge->name, m->name);
2654             return false;
2655         }
2656         s.out_vlan = UINT16_MAX;
2657
2658         if (cfg->output_vlan) {
2659             VLOG_ERR("bridge %s: mirror %s specifies both output port and "
2660                      "output vlan; ignoring output vlan",
2661                      m->bridge->name, m->name);
2662         }
2663     } else if (cfg->output_vlan) {
2664         /* The database should prevent invalid VLAN values. */
2665         s.out_bundle = NULL;
2666         s.out_vlan = *cfg->output_vlan;
2667     } else {
2668         VLOG_ERR("bridge %s: mirror %s does not specify output; ignoring",
2669                  m->bridge->name, m->name);
2670         return false;
2671     }
2672
2673     /* Get port selection. */
2674     if (cfg->select_all) {
2675         size_t n_ports = hmap_count(&m->bridge->ports);
2676         void **ports = xmalloc(n_ports * sizeof *ports);
2677         struct port *port;
2678         size_t i;
2679
2680         i = 0;
2681         HMAP_FOR_EACH (port, hmap_node, &m->bridge->ports) {
2682             ports[i++] = port;
2683         }
2684
2685         s.srcs = ports;
2686         s.n_srcs = n_ports;
2687
2688         s.dsts = ports;
2689         s.n_dsts = n_ports;
2690     } else {
2691         /* Get ports, dropping ports that don't exist.
2692          * The IDL ensures that there are no duplicates. */
2693         mirror_collect_ports(m, cfg->select_src_port, cfg->n_select_src_port,
2694                              &s.srcs, &s.n_srcs);
2695         mirror_collect_ports(m, cfg->select_dst_port, cfg->n_select_dst_port,
2696                              &s.dsts, &s.n_dsts);
2697
2698     }
2699
2700     /* Get VLAN selection. */
2701     s.src_vlans = vlan_bitmap_from_array(cfg->select_vlan, cfg->n_select_vlan);
2702
2703     /* Configure. */
2704     ofproto_mirror_register(m->bridge->ofproto, m, &s);
2705
2706     /* Clean up. */
2707     if (s.srcs != s.dsts) {
2708         free(s.dsts);
2709     }
2710     free(s.srcs);
2711     free(s.src_vlans);
2712
2713     return true;
2714 }