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