vswitchd/bridge.c

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