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, or null not to learn. */
 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         if (br->ml) {
 850             mac_learning_wait(br->ml);
 851         }
 852         bond_wait(br);
 853         brstp_wait(br);
 854     }
 855 }
 856
 857 /* Forces 'br' to revalidate all of its flows.  This is appropriate when 'br''s
 858  * configuration changes.  */
 859 static void
 860 bridge_flush(struct bridge *br)
 861 {
 862     COVERAGE_INC(bridge_flush);
 863     br->flush = true;
 864     if (br->ml) {
 865         mac_learning_flush(br->ml);
 866     }
 867 }
 868 \f
 869 /* Bridge unixctl user interface functions. */
 870 static void
 871 bridge_unixctl_fdb_show(struct unixctl_conn *conn, const char *args)
 872 {
 873     struct ds ds = DS_EMPTY_INITIALIZER;
 874     const struct bridge *br;
 875
 876     br = bridge_lookup(args);
 877     if (!br) {
 878         unixctl_command_reply(conn, 501, "no such bridge");
 879         return;
 880     }
 881
 882     ds_put_cstr(&ds, " port  VLAN  MAC                Age\n");
 883     if (br->ml) {
 884         const struct mac_entry *e;
 885         LIST_FOR_EACH (e, struct mac_entry, lru_node, &br->ml->lrus) {
 886             if (e->port < 0 || e->port >= br->n_ports) {
 887                 continue;
 888             }
 889             ds_put_format(&ds, "%5d  %4d  "ETH_ADDR_FMT"  %3d\n",
 890                           br->ports[e->port]->ifaces[0]->dp_ifidx,
 891                           e->vlan, ETH_ADDR_ARGS(e->mac), mac_entry_age(e));
 892         }
 893     }
 894     unixctl_command_reply(conn, 200, ds_cstr(&ds));
 895     ds_destroy(&ds);
 896 }
 897 \f
 898 /* Bridge reconfiguration functions. */
 899
 900 static struct bridge *
 901 bridge_create(const char *name)
 902 {
 903     struct bridge *br;
 904     int error;
 905
 906     assert(!bridge_lookup(name));
 907     br = xcalloc(1, sizeof *br);
 908
 909     error = dpif_create(name, &br->dpif);
 910     if (error == EEXIST) {
 911         error = dpif_open(name, &br->dpif);
 912         if (error) {
 913             VLOG_ERR("datapath %s already exists but cannot be opened: %s",
 914                      name, strerror(error));
 915             free(br);
 916             return NULL;
 917         }
 918         dpif_flow_flush(&br->dpif);
 919     } else if (error) {
 920         VLOG_ERR("failed to create datapath %s: %s", name, strerror(error));
 921         free(br);
 922         return NULL;
 923     }
 924
 925     error = ofproto_create(name, &bridge_ofhooks, br, &br->ofproto);
 926     if (error) {
 927         VLOG_ERR("failed to create switch %s: %s", name, strerror(error));
 928         dpif_delete(&br->dpif);
 929         dpif_close(&br->dpif);
 930         free(br);
 931         return NULL;
 932     }
 933
 934     br->name = xstrdup(name);
 935     br->ml = mac_learning_create();
 936     br->sent_config_request = false;
 937     eth_addr_random(br->default_ea);
 938
 939     port_array_init(&br->ifaces);
 940
 941     br->flush = false;
 942     br->bond_next_rebalance = time_msec() + 10000;
 943
 944     list_push_back(&all_bridges, &br->node);
 945
 946     VLOG_INFO("created bridge %s on dp%u", br->name, dpif_id(&br->dpif));
 947
 948     return br;
 949 }
 950
 951 static void
 952 bridge_destroy(struct bridge *br)
 953 {
 954     if (br) {
 955         int error;
 956
 957         while (br->n_ports > 0) {
 958             port_destroy(br->ports[br->n_ports - 1]);
 959         }
 960         list_remove(&br->node);
 961         error = dpif_delete(&br->dpif);
 962         if (error && error != ENOENT) {
 963             VLOG_ERR("failed to delete dp%u: %s",
 964                      dpif_id(&br->dpif), strerror(error));
 965         }
 966         dpif_close(&br->dpif);
 967         ofproto_destroy(br->ofproto);
 968         free(br->controller);
 969         mac_learning_destroy(br->ml);
 970         port_array_destroy(&br->ifaces);
 971         free(br->ports);
 972         free(br->name);
 973         free(br);
 974     }
 975 }
 976
 977 static struct bridge *
 978 bridge_lookup(const char *name)
 979 {
 980     struct bridge *br;
 981
 982     LIST_FOR_EACH (br, struct bridge, node, &all_bridges) {
 983         if (!strcmp(br->name, name)) {
 984             return br;
 985         }
 986     }
 987     return NULL;
 988 }
 989
 990 bool
 991 bridge_exists(const char *name)
 992 {
 993     return bridge_lookup(name) ? true : false;
 994 }
 995
 996 uint64_t
 997 bridge_get_datapathid(const char *name)
 998 {
 999     struct bridge *br = bridge_lookup(name);
1000     return br ? ofproto_get_datapath_id(br->ofproto) : 0;
1001 }
1002
1003 /* Handle requests for a listing of all flows known by the OpenFlow
1004  * stack, including those normally hidden. */
1005 static void
1006 bridge_unixctl_dump_flows(struct unixctl_conn *conn, const char *args)
1007 {
1008     struct bridge *br;
1009     struct ds results;
1010
1011     br = bridge_lookup(args);
1012     if (!br) {
1013         unixctl_command_reply(conn, 501, "Unknown bridge");
1014         return;
1015     }
1016
1017     ds_init(&results);
1018     ofproto_get_all_flows(br->ofproto, &results);
1019
1020     unixctl_command_reply(conn, 200, ds_cstr(&results));
1021     ds_destroy(&results);
1022 }
1023
1024 static int
1025 bridge_run_one(struct bridge *br)
1026 {
1027     int error;
1028
1029     error = ofproto_run1(br->ofproto);
1030     if (error) {
1031         return error;
1032     }
1033
1034     if (br->ml) {
1035         mac_learning_run(br->ml, ofproto_get_revalidate_set(br->ofproto));
1036     }
1037     bond_run(br);
1038     brstp_run(br);
1039
1040     error = ofproto_run2(br->ofproto, br->flush);
1041     br->flush = false;
1042
1043     return error;
1044 }
1045
1046 static const char *
1047 bridge_get_controller(const struct bridge *br)
1048 {
1049     const char *controller;
1050
1051     controller = cfg_get_string(0, "bridge.%s.controller", br->name);
1052     if (!controller) {
1053         controller = cfg_get_string(0, "mgmt.controller");
1054     }
1055     return controller && controller[0] ? controller : NULL;
1056 }
1057
1058 static void
1059 bridge_reconfigure_one(struct bridge *br)
1060 {
1061     struct svec old_ports, new_ports, ifaces;
1062     struct svec listeners, old_listeners;
1063     struct svec snoops, old_snoops;
1064     size_t i, j;
1065
1066     /* Collect old ports. */
1067     svec_init(&old_ports);
1068     for (i = 0; i < br->n_ports; i++) {
1069         svec_add(&old_ports, br->ports[i]->name);
1070     }
1071     svec_sort(&old_ports);
1072     assert(svec_is_unique(&old_ports));
1073
1074     /* Collect new ports. */
1075     svec_init(&new_ports);
1076     cfg_get_all_keys(&new_ports, "bridge.%s.port", br->name);
1077     svec_sort(&new_ports);
1078     if (bridge_get_controller(br) && !svec_contains(&new_ports, br->name)) {
1079         svec_add(&new_ports, br->name);
1080         svec_sort(&new_ports);
1081     }
1082     if (!svec_is_unique(&new_ports)) {
1083         VLOG_WARN("bridge %s: %s specified twice as bridge port",
1084                   br->name, svec_get_duplicate(&new_ports));
1085         svec_unique(&new_ports);
1086     }
1087
1088     ofproto_set_mgmt_id(br->ofproto, mgmt_id);
1089
1090     /* Get rid of deleted ports and add new ports. */
1091     for (i = 0; i < br->n_ports; ) {
1092         struct port *port = br->ports[i];
1093         if (!svec_contains(&new_ports, port->name)) {
1094             port_destroy(port);
1095         } else {
1096             i++;
1097         }
1098     }
1099     for (i = 0; i < new_ports.n; i++) {
1100         const char *name = new_ports.names[i];
1101         if (!svec_contains(&old_ports, name)) {
1102             port_create(br, name);
1103         }
1104     }
1105     svec_destroy(&old_ports);
1106     svec_destroy(&new_ports);
1107
1108     /* Reconfigure all ports. */
1109     for (i = 0; i < br->n_ports; i++) {
1110         port_reconfigure(br->ports[i]);
1111     }
1112
1113     /* Check and delete duplicate interfaces. */
1114     svec_init(&ifaces);
1115     for (i = 0; i < br->n_ports; ) {
1116         struct port *port = br->ports[i];
1117         for (j = 0; j < port->n_ifaces; ) {
1118             struct iface *iface = port->ifaces[j];
1119             if (svec_contains(&ifaces, iface->name)) {
1120                 VLOG_ERR("bridge %s: %s interface is on multiple ports, "
1121                          "removing from %s",
1122                          br->name, iface->name, port->name);
1123                 iface_destroy(iface);
1124             } else {
1125                 svec_add(&ifaces, iface->name);
1126                 svec_sort(&ifaces);
1127                 j++;
1128             }
1129         }
1130         if (!port->n_ifaces) {
1131             VLOG_ERR("%s port has no interfaces, dropping", port->name);
1132             port_destroy(port);
1133         } else {
1134             i++;
1135         }
1136     }
1137     svec_destroy(&ifaces);
1138
1139     /* Delete all flows if we're switching from connected to standalone or vice
1140      * versa.  (XXX Should we delete all flows if we are switching from one
1141      * controller to another?) */
1142
1143     /* Configure OpenFlow management listeners. */
1144     svec_init(&listeners);
1145     cfg_get_all_strings(&listeners, "bridge.%s.openflow.listeners", br->name);
1146     if (!listeners.n) {
1147         svec_add_nocopy(&listeners, xasprintf("punix:%s/%s.mgmt",
1148                                               ovs_rundir, br->name));
1149     } else if (listeners.n == 1 && !strcmp(listeners.names[0], "none")) {
1150         svec_clear(&listeners);
1151     }
1152     svec_sort_unique(&listeners);
1153
1154     svec_init(&old_listeners);
1155     ofproto_get_listeners(br->ofproto, &old_listeners);
1156     svec_sort_unique(&old_listeners);
1157
1158     if (!svec_equal(&listeners, &old_listeners)) {
1159         ofproto_set_listeners(br->ofproto, &listeners);
1160     }
1161     svec_destroy(&listeners);
1162     svec_destroy(&old_listeners);
1163
1164     /* Configure OpenFlow controller connection snooping. */
1165     svec_init(&snoops);
1166     cfg_get_all_strings(&snoops, "bridge.%s.openflow.snoops", br->name);
1167     if (!snoops.n) {
1168         svec_add_nocopy(&snoops, xasprintf("punix:%s/%s.snoop",
1169                                            ovs_rundir, br->name));
1170     } else if (snoops.n == 1 && !strcmp(snoops.names[0], "none")) {
1171         svec_clear(&snoops);
1172     }
1173     svec_sort_unique(&snoops);
1174
1175     svec_init(&old_snoops);
1176     ofproto_get_snoops(br->ofproto, &old_snoops);
1177     svec_sort_unique(&old_snoops);
1178
1179     if (!svec_equal(&snoops, &old_snoops)) {
1180         ofproto_set_snoops(br->ofproto, &snoops);
1181     }
1182     svec_destroy(&snoops);
1183     svec_destroy(&old_snoops);
1184
1185     mirror_reconfigure(br);
1186 }
1187
1188 static void
1189 bridge_reconfigure_controller(struct bridge *br)
1190 {
1191     char *pfx = xasprintf("bridge.%s.controller", br->name);
1192     const char *controller;
1193
1194     controller = bridge_get_controller(br);
1195     if ((br->controller != NULL) != (controller != NULL)) {
1196         ofproto_flush_flows(br->ofproto);
1197     }
1198     free(br->controller);
1199     br->controller = controller ? xstrdup(controller) : NULL;
1200
1201     if (controller) {
1202         const char *fail_mode;
1203         int max_backoff, probe;
1204         int rate_limit, burst_limit;
1205
1206         if (!strcmp(controller, "discover")) {
1207             bool update_resolv_conf = true;
1208
1209             if (cfg_has("%s.update-resolv.conf", pfx)) {
1210                 update_resolv_conf = cfg_get_bool(0, "%s.update-resolv.conf",
1211                         pfx);
1212             }
1213             ofproto_set_discovery(br->ofproto, true,
1214                                   cfg_get_string(0, "%s.accept-regex", pfx),
1215                                   update_resolv_conf);
1216         } else {
1217             struct netdev *netdev;
1218             bool in_band;
1219             int error;
1220
1221             in_band = (!cfg_is_valid(CFG_BOOL | CFG_REQUIRED,
1222                                      "%s.in-band", pfx)
1223                        || cfg_get_bool(0, "%s.in-band", pfx));
1224             ofproto_set_discovery(br->ofproto, false, NULL, NULL);
1225             ofproto_set_in_band(br->ofproto, in_band);
1226
1227             error = netdev_open(br->name, NETDEV_ETH_TYPE_NONE, &netdev);
1228             if (!error) {
1229                 if (cfg_is_valid(CFG_IP | CFG_REQUIRED, "%s.ip", pfx)) {
1230                     struct in_addr ip, mask, gateway;
1231                     ip.s_addr = cfg_get_ip(0, "%s.ip", pfx);
1232                     mask.s_addr = cfg_get_ip(0, "%s.netmask", pfx);
1233                     gateway.s_addr = cfg_get_ip(0, "%s.gateway", pfx);
1234
1235                     netdev_turn_flags_on(netdev, NETDEV_UP, true);
1236                     if (!mask.s_addr) {
1237                         mask.s_addr = guess_netmask(ip.s_addr);
1238                     }
1239                     if (!netdev_set_in4(netdev, ip, mask)) {
1240                         VLOG_INFO("bridge %s: configured IP address "IP_FMT", "
1241                                   "netmask "IP_FMT,
1242                                   br->name, IP_ARGS(&ip.s_addr),
1243                                   IP_ARGS(&mask.s_addr));
1244                     }
1245
1246                     if (gateway.s_addr) {
1247                         if (!netdev_add_router(gateway)) {
1248                             VLOG_INFO("bridge %s: configured gateway "IP_FMT,
1249                                       br->name, IP_ARGS(&gateway.s_addr));
1250                         }
1251                     }
1252                 }
1253                 netdev_close(netdev);
1254             }
1255         }
1256
1257         fail_mode = cfg_get_string(0, "%s.fail-mode", pfx);
1258         if (!fail_mode) {
1259             fail_mode = cfg_get_string(0, "mgmt.fail-mode");
1260         }
1261         ofproto_set_failure(br->ofproto,
1262                             (!fail_mode
1263                              || !strcmp(fail_mode, "standalone")
1264                              || !strcmp(fail_mode, "open")));
1265
1266         probe = cfg_get_int(0, "%s.inactivity-probe", pfx);
1267         if (probe < 5) {
1268             probe = cfg_get_int(0, "mgmt.inactivity-probe");
1269             if (probe < 5) {
1270                 probe = 5;
1271             }
1272         }
1273         ofproto_set_probe_interval(br->ofproto, probe);
1274
1275         max_backoff = cfg_get_int(0, "%s.max-backoff", pfx);
1276         if (!max_backoff) {
1277             max_backoff = cfg_get_int(0, "mgmt.max-backoff");
1278             if (!max_backoff) {
1279                 max_backoff = 8;
1280             }
1281         }
1282         ofproto_set_max_backoff(br->ofproto, max_backoff);
1283
1284         rate_limit = cfg_get_int(0, "%s.rate-limit", pfx);
1285         if (!rate_limit) {
1286             rate_limit = cfg_get_int(0, "mgmt.rate-limit");
1287         }
1288         burst_limit = cfg_get_int(0, "%s.burst-limit", pfx);
1289         if (!burst_limit) {
1290             burst_limit = cfg_get_int(0, "mgmt.burst-limit");
1291         }
1292         ofproto_set_rate_limit(br->ofproto, rate_limit, burst_limit);
1293
1294         ofproto_set_stp(br->ofproto, cfg_get_bool(0, "%s.stp", pfx));
1295
1296         if (cfg_has("%s.commands.acl", pfx)) {
1297             struct svec command_acls;
1298             char *command_acl;
1299
1300             svec_init(&command_acls);
1301             cfg_get_all_strings(&command_acls, "%s.commands.acl", pfx);
1302             command_acl = svec_join(&command_acls, ",", "");
1303
1304             ofproto_set_remote_execution(br->ofproto, command_acl,
1305                                          cfg_get_string(0, "%s.commands.dir",
1306                                                         pfx));
1307
1308             svec_destroy(&command_acls);
1309             free(command_acl);
1310         } else {
1311             ofproto_set_remote_execution(br->ofproto, NULL, NULL);
1312         }
1313     } else {
1314         union ofp_action action;
1315         flow_t flow;
1316
1317         /* Set up a flow that matches every packet and directs them to
1318          * OFPP_NORMAL (which goes to us). */
1319         memset(&action, 0, sizeof action);
1320         action.type = htons(OFPAT_OUTPUT);
1321         action.output.len = htons(sizeof action);
1322         action.output.port = htons(OFPP_NORMAL);
1323         memset(&flow, 0, sizeof flow);
1324         ofproto_add_flow(br->ofproto, &flow, OFPFW_ALL, 0,
1325                          &action, 1, 0);
1326
1327         ofproto_set_in_band(br->ofproto, false);
1328         ofproto_set_max_backoff(br->ofproto, 1);
1329         ofproto_set_probe_interval(br->ofproto, 5);
1330         ofproto_set_failure(br->ofproto, false);
1331         ofproto_set_stp(br->ofproto, false);
1332     }
1333     free(pfx);
1334
1335     ofproto_set_controller(br->ofproto, br->controller);
1336 }
1337
1338 static void
1339 bridge_get_all_ifaces(const struct bridge *br, struct svec *ifaces)
1340 {
1341     size_t i, j;
1342
1343     svec_init(ifaces);
1344     for (i = 0; i < br->n_ports; i++) {
1345         struct port *port = br->ports[i];
1346         for (j = 0; j < port->n_ifaces; j++) {
1347             struct iface *iface = port->ifaces[j];
1348             svec_add(ifaces, iface->name);
1349         }
1350         if (port->n_ifaces > 1
1351             && cfg_get_bool(0, "bonding.%s.fake-iface", port->name)) {
1352             svec_add(ifaces, port->name);
1353         }
1354     }
1355     svec_sort_unique(ifaces);
1356 }
1357
1358 /* For robustness, in case the administrator moves around datapath ports behind
1359  * our back, we re-check all the datapath port numbers here.
1360  *
1361  * This function will set the 'dp_ifidx' members of interfaces that have
1362  * disappeared to -1, so only call this function from a context where those
1363  * 'struct iface's will be removed from the bridge.  Otherwise, the -1
1364  * 'dp_ifidx'es will cause trouble later when we try to send them to the
1365  * datapath, which doesn't support UINT16_MAX+1 ports. */
1366 static void
1367 bridge_fetch_dp_ifaces(struct bridge *br)
1368 {
1369     struct odp_port *dpif_ports;
1370     size_t n_dpif_ports;
1371     size_t i, j;
1372
1373     /* Reset all interface numbers. */
1374     for (i = 0; i < br->n_ports; i++) {
1375         struct port *port = br->ports[i];
1376         for (j = 0; j < port->n_ifaces; j++) {
1377             struct iface *iface = port->ifaces[j];
1378             iface->dp_ifidx = -1;
1379         }
1380     }
1381     port_array_clear(&br->ifaces);
1382
1383     dpif_port_list(&br->dpif, &dpif_ports, &n_dpif_ports);
1384     for (i = 0; i < n_dpif_ports; i++) {
1385         struct odp_port *p = &dpif_ports[i];
1386         struct iface *iface = iface_lookup(br, p->devname);
1387         if (iface) {
1388             if (iface->dp_ifidx >= 0) {
1389                 VLOG_WARN("dp%u reported interface %s twice",
1390                           dpif_id(&br->dpif), p->devname);
1391             } else if (iface_from_dp_ifidx(br, p->port)) {
1392                 VLOG_WARN("dp%u reported interface %"PRIu16" twice",
1393                           dpif_id(&br->dpif), p->port);
1394             } else {
1395                 port_array_set(&br->ifaces, p->port, iface);
1396                 iface->dp_ifidx = p->port;
1397             }
1398         }
1399     }
1400     free(dpif_ports);
1401 }
1402 \f
1403 /* Bridge packet processing functions. */
1404
1405 static int
1406 bond_hash(const uint8_t mac[ETH_ADDR_LEN])
1407 {
1408     return hash_bytes(mac, ETH_ADDR_LEN, 0) & BOND_MASK;
1409 }
1410
1411 static struct bond_entry *
1412 lookup_bond_entry(const struct port *port, const uint8_t mac[ETH_ADDR_LEN])
1413 {
1414     return &port->bond_hash[bond_hash(mac)];
1415 }
1416
1417 static int
1418 bond_choose_iface(const struct port *port)
1419 {
1420     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1421     size_t i, best_down_slave = -1;
1422     long long next_delay_expiration = LLONG_MAX;
1423
1424     for (i = 0; i < port->n_ifaces; i++) {
1425         struct iface *iface = port->ifaces[i];
1426
1427         if (iface->enabled) {
1428             return i;
1429         } else if (iface->delay_expires < next_delay_expiration) {
1430             best_down_slave = i;
1431             next_delay_expiration = iface->delay_expires;
1432         }
1433     }
1434
1435     if (best_down_slave != -1) {
1436         struct iface *iface = port->ifaces[best_down_slave];
1437
1438         VLOG_INFO_RL(&rl, "interface %s: skipping remaining %lli ms updelay "
1439                      "since no other interface is up", iface->name,
1440                      iface->delay_expires - time_msec());
1441         bond_enable_slave(iface, true);
1442     }
1443
1444     return best_down_slave;
1445 }
1446
1447 static bool
1448 choose_output_iface(const struct port *port, const uint8_t *dl_src,
1449                     uint16_t *dp_ifidx, tag_type *tags)
1450 {
1451     struct iface *iface;
1452
1453     assert(port->n_ifaces);
1454     if (port->n_ifaces == 1) {
1455         iface = port->ifaces[0];
1456     } else {
1457         struct bond_entry *e = lookup_bond_entry(port, dl_src);
1458         if (e->iface_idx < 0 || e->iface_idx >= port->n_ifaces
1459             || !port->ifaces[e->iface_idx]->enabled) {
1460             /* XXX select interface properly.  The current interface selection
1461              * is only good for testing the rebalancing code. */
1462             e->iface_idx = bond_choose_iface(port);
1463             if (e->iface_idx < 0) {
1464                 *tags |= port->no_ifaces_tag;
1465                 return false;
1466             }
1467             e->iface_tag = tag_create_random();
1468             ((struct port *) port)->bond_compat_is_stale = true;
1469         }
1470         *tags |= e->iface_tag;
1471         iface = port->ifaces[e->iface_idx];
1472     }
1473     *dp_ifidx = iface->dp_ifidx;
1474     *tags |= iface->tag;        /* Currently only used for bonding. */
1475     return true;
1476 }
1477
1478 static void
1479 bond_link_status_update(struct iface *iface, bool carrier)
1480 {
1481     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1482     struct port *port = iface->port;
1483
1484     if ((carrier == iface->enabled) == (iface->delay_expires == LLONG_MAX)) {
1485         /* Nothing to do. */
1486         return;
1487     }
1488     VLOG_INFO_RL(&rl, "interface %s: carrier %s",
1489                  iface->name, carrier ? "detected" : "dropped");
1490     if (carrier == iface->enabled) {
1491         iface->delay_expires = LLONG_MAX;
1492         VLOG_INFO_RL(&rl, "interface %s: will not be %s",
1493                      iface->name, carrier ? "disabled" : "enabled");
1494     } else if (carrier && port->active_iface < 0) {
1495         bond_enable_slave(iface, true);
1496         if (port->updelay) {
1497             VLOG_INFO_RL(&rl, "interface %s: skipping %d ms updelay since no "
1498                          "other interface is up", iface->name, port->updelay);
1499         }
1500     } else {
1501         int delay = carrier ? port->updelay : port->downdelay;
1502         iface->delay_expires = time_msec() + delay;
1503         if (delay) {
1504             VLOG_INFO_RL(&rl,
1505                          "interface %s: will be %s if it stays %s for %d ms",
1506                          iface->name,
1507                          carrier ? "enabled" : "disabled",
1508                          carrier ? "up" : "down",
1509                          delay);
1510         }
1511     }
1512 }
1513
1514 static void
1515 bond_choose_active_iface(struct port *port)
1516 {
1517     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(5, 20);
1518
1519     port->active_iface = bond_choose_iface(port);
1520     port->active_iface_tag = tag_create_random();
1521     if (port->active_iface >= 0) {
1522         VLOG_INFO_RL(&rl, "port %s: active interface is now %s",
1523                      port->name, port->ifaces[port->active_iface]->name);
1524     } else {
1525         VLOG_WARN_RL(&rl, "port %s: all ports disabled, no active interface",
1526                      port->name);
1527     }
1528 }
1529
1530 static void
1531 bond_enable_slave(struct iface *iface, bool enable)
1532 {
1533     struct port *port = iface->port;
1534     struct bridge *br = port->bridge;
1535
1536     /* This acts as a recursion check.  If the act of disabling a slave
1537      * causes a different slave to be enabled, the flag will allow us to
1538      * skip redundant work when we reenter this function.  It must be
1539      * cleared on exit to keep things safe with multiple bonds. */
1540     static bool moving_active_iface = false;
1541
1542     iface->delay_expires = LLONG_MAX;
1543     if (enable == iface->enabled) {
1544         return;
1545     }
1546
1547     iface->enabled = enable;
1548     if (!iface->enabled) {
1549         VLOG_WARN("interface %s: disabled", iface->name);
1550         ofproto_revalidate(br->ofproto, iface->tag);
1551         if (iface->port_ifidx == port->active_iface) {
1552             ofproto_revalidate(br->ofproto,
1553                                port->active_iface_tag);
1554
1555             /* Disabling a slave can lead to another slave being immediately
1556              * enabled if there will be no active slaves but one is waiting
1557              * on an updelay.  In this case we do not need to run most of the
1558              * code for the newly enabled slave since there was no period
1559              * without an active slave and it is redundant with the disabling
1560              * path. */
1561             moving_active_iface = true;
1562             bond_choose_active_iface(port);
1563         }
1564         bond_send_learning_packets(port);
1565     } else {
1566         VLOG_WARN("interface %s: enabled", iface->name);
1567         if (port->active_iface < 0 && !moving_active_iface) {
1568             ofproto_revalidate(br->ofproto, port->no_ifaces_tag);
1569             bond_choose_active_iface(port);
1570             bond_send_learning_packets(port);
1571         }
1572         iface->tag = tag_create_random();
1573     }
1574
1575     moving_active_iface = false;
1576     port->bond_compat_is_stale = true;
1577 }
1578
1579 static void
1580 bond_run(struct bridge *br)
1581 {
1582     size_t i, j;
1583
1584     for (i = 0; i < br->n_ports; i++) {
1585         struct port *port = br->ports[i];
1586
1587         if (port->n_ifaces >= 2) {
1588             for (j = 0; j < port->n_ifaces; j++) {
1589                 struct iface *iface = port->ifaces[j];
1590                 if (time_msec() >= iface->delay_expires) {
1591                     bond_enable_slave(iface, !iface->enabled);
1592                 }
1593             }
1594         }
1595
1596         if (port->bond_compat_is_stale) {
1597             port->bond_compat_is_stale = false;
1598             port_update_bond_compat(port);
1599         }
1600     }
1601 }
1602
1603 static void
1604 bond_wait(struct bridge *br)
1605 {
1606     size_t i, j;
1607
1608     for (i = 0; i < br->n_ports; i++) {
1609         struct port *port = br->ports[i];
1610         if (port->n_ifaces < 2) {
1611             continue;
1612         }
1613         for (j = 0; j < port->n_ifaces; j++) {
1614             struct iface *iface = port->ifaces[j];
1615             if (iface->delay_expires != LLONG_MAX) {
1616                 poll_timer_wait(iface->delay_expires - time_msec());
1617             }
1618         }
1619     }
1620 }
1621
1622 static bool
1623 set_dst(struct dst *p, const flow_t *flow,
1624         const struct port *in_port, const struct port *out_port,
1625         tag_type *tags)
1626 {
1627     /* STP handling.
1628      *
1629      * XXX This uses too many tags: any broadcast flow will get one tag per
1630      * destination port, and thus a broadcast on a switch of any size is likely
1631      * to have all tag bits set.  We should figure out a way to be smarter.
1632      *
1633      * This is OK when STP is disabled, because stp_state_tag is 0 then. */
1634     *tags |= out_port->stp_state_tag;
1635     if (!(out_port->stp_state & (STP_DISABLED | STP_FORWARDING))) {
1636         return false;
1637     }
1638
1639     p->vlan = (out_port->vlan >= 0 ? OFP_VLAN_NONE
1640               : in_port->vlan >= 0 ? in_port->vlan
1641               : ntohs(flow->dl_vlan));
1642     return choose_output_iface(out_port, flow->dl_src, &p->dp_ifidx, tags);
1643 }
1644
1645 static void
1646 swap_dst(struct dst *p, struct dst *q)
1647 {
1648     struct dst tmp = *p;
1649     *p = *q;
1650     *q = tmp;
1651 }
1652
1653 /* Moves all the dsts with vlan == 'vlan' to the front of the 'n_dsts' in
1654  * 'dsts'.  (This may help performance by reducing the number of VLAN changes
1655  * that we push to the datapath.  We could in fact fully sort the array by
1656  * vlan, but in most cases there are at most two different vlan tags so that's
1657  * possibly overkill.) */
1658 static void
1659 partition_dsts(struct dst *dsts, size_t n_dsts, int vlan)
1660 {
1661     struct dst *first = dsts;
1662     struct dst *last = dsts + n_dsts;
1663
1664     while (first != last) {
1665         /* Invariants:
1666          *      - All dsts < first have vlan == 'vlan'.
1667          *      - All dsts >= last have vlan != 'vlan'.
1668          *      - first < last. */
1669         while (first->vlan == vlan) {
1670             if (++first == last) {
1671                 return;
1672             }
1673         }
1674
1675         /* Same invariants, plus one additional:
1676          *      - first->vlan != vlan.
1677          */
1678         while (last[-1].vlan != vlan) {
1679             if (--last == first) {
1680                 return;
1681             }
1682         }
1683
1684         /* Same invariants, plus one additional:
1685          *      - last[-1].vlan == vlan.*/
1686         swap_dst(first++, --last);
1687     }
1688 }
1689
1690 static int
1691 mirror_mask_ffs(mirror_mask_t mask)
1692 {
1693     BUILD_ASSERT_DECL(sizeof(unsigned int) >= sizeof(mask));
1694     return ffs(mask);
1695 }
1696
1697 static bool
1698 dst_is_duplicate(const struct dst *dsts, size_t n_dsts,
1699                  const struct dst *test)
1700 {
1701     size_t i;
1702     for (i = 0; i < n_dsts; i++) {
1703         if (dsts[i].vlan == test->vlan && dsts[i].dp_ifidx == test->dp_ifidx) {
1704             return true;
1705         }
1706     }
1707     return false;
1708 }
1709
1710 static bool
1711 port_trunks_vlan(const struct port *port, uint16_t vlan)
1712 {
1713     return port->vlan < 0 && bitmap_is_set(port->trunks, vlan);
1714 }
1715
1716 static bool
1717 port_includes_vlan(const struct port *port, uint16_t vlan)
1718 {
1719     return vlan == port->vlan || port_trunks_vlan(port, vlan);
1720 }
1721
1722 static size_t
1723 compose_dsts(const struct bridge *br, const flow_t *flow, uint16_t vlan,
1724              const struct port *in_port, const struct port *out_port,
1725              struct dst dsts[], tag_type *tags, uint16_t *nf_output_iface)
1726 {
1727     mirror_mask_t mirrors = in_port->src_mirrors;
1728     struct dst *dst = dsts;
1729     size_t i;
1730
1731     *tags |= in_port->stp_state_tag;
1732     if (out_port == FLOOD_PORT) {
1733         /* XXX use ODP_FLOOD if no vlans or bonding. */
1734         /* XXX even better, define each VLAN as a datapath port group */
1735         for (i = 0; i < br->n_ports; i++) {
1736             struct port *port = br->ports[i];
1737             if (port != in_port && port_includes_vlan(port, vlan)
1738                 && !port->is_mirror_output_port
1739                 && set_dst(dst, flow, in_port, port, tags)) {
1740                 mirrors |= port->dst_mirrors;
1741                 dst++;
1742             }
1743         }
1744         *nf_output_iface = NF_OUT_FLOOD;
1745     } else if (out_port && set_dst(dst, flow, in_port, out_port, tags)) {
1746         *nf_output_iface = dst->dp_ifidx;
1747         mirrors |= out_port->dst_mirrors;
1748         dst++;
1749     }
1750
1751     while (mirrors) {
1752         struct mirror *m = br->mirrors[mirror_mask_ffs(mirrors) - 1];
1753         if (!m->n_vlans || vlan_is_mirrored(m, vlan)) {
1754             if (m->out_port) {
1755                 if (set_dst(dst, flow, in_port, m->out_port, tags)
1756                     && !dst_is_duplicate(dsts, dst - dsts, dst)) {
1757                     dst++;
1758                 }
1759             } else {
1760                 for (i = 0; i < br->n_ports; i++) {
1761                     struct port *port = br->ports[i];
1762                     if (port_includes_vlan(port, m->out_vlan)
1763                         && set_dst(dst, flow, in_port, port, tags))
1764                     {
1765                         int flow_vlan;
1766
1767                         if (port->vlan < 0) {
1768                             dst->vlan = m->out_vlan;
1769                         }
1770                         if (dst_is_duplicate(dsts, dst - dsts, dst)) {
1771                             continue;
1772                         }
1773
1774                         /* Use the vlan tag on the original flow instead of
1775                          * the one passed in the vlan parameter.  This ensures
1776                          * that we compare the vlan from before any implicit
1777                          * tagging tags place. This is necessary because
1778                          * dst->vlan is the final vlan, after removing implicit
1779                          * tags. */
1780                         flow_vlan = ntohs(flow->dl_vlan);
1781                         if (flow_vlan == 0) {
1782                             flow_vlan = OFP_VLAN_NONE;
1783                         }
1784                         if (port == in_port && dst->vlan == flow_vlan) {
1785                             /* Don't send out input port on same VLAN. */
1786                             continue;
1787                         }
1788                         dst++;
1789                     }
1790                 }
1791             }
1792         }
1793         mirrors &= mirrors - 1;
1794     }
1795
1796     partition_dsts(dsts, dst - dsts, ntohs(flow->dl_vlan));
1797     return dst - dsts;
1798 }
1799
1800 static void UNUSED
1801 print_dsts(const struct dst *dsts, size_t n)
1802 {
1803     for (; n--; dsts++) {
1804         printf(">p%"PRIu16, dsts->dp_ifidx);
1805         if (dsts->vlan != OFP_VLAN_NONE) {
1806             printf("v%"PRIu16, dsts->vlan);
1807         }
1808     }
1809 }
1810
1811 static void
1812 compose_actions(struct bridge *br, const flow_t *flow, uint16_t vlan,
1813                 const struct port *in_port, const struct port *out_port,
1814                 tag_type *tags, struct odp_actions *actions,
1815                 uint16_t *nf_output_iface)
1816 {
1817     struct dst dsts[DP_MAX_PORTS * (MAX_MIRRORS + 1)];
1818     size_t n_dsts;
1819     const struct dst *p;
1820     uint16_t cur_vlan;
1821
1822     n_dsts = compose_dsts(br, flow, vlan, in_port, out_port, dsts, tags,
1823                           nf_output_iface);
1824
1825     cur_vlan = ntohs(flow->dl_vlan);
1826     for (p = dsts; p < &dsts[n_dsts]; p++) {
1827         union odp_action *a;
1828         if (p->vlan != cur_vlan) {
1829             if (p->vlan == OFP_VLAN_NONE) {
1830                 odp_actions_add(actions, ODPAT_STRIP_VLAN);
1831             } else {
1832                 a = odp_actions_add(actions, ODPAT_SET_VLAN_VID);
1833                 a->vlan_vid.vlan_vid = htons(p->vlan);
1834             }
1835             cur_vlan = p->vlan;
1836         }
1837         a = odp_actions_add(actions, ODPAT_OUTPUT);
1838         a->output.port = p->dp_ifidx;
1839     }
1840 }
1841
1842 static bool
1843 is_bcast_arp_reply(const flow_t *flow)
1844 {
1845     return (flow->dl_type == htons(ETH_TYPE_ARP)
1846             && flow->nw_proto == ARP_OP_REPLY
1847             && eth_addr_is_broadcast(flow->dl_dst));
1848 }
1849
1850 /* If the composed actions may be applied to any packet in the given 'flow',
1851  * returns true.  Otherwise, the actions should only be applied to 'packet', or
1852  * not at all, if 'packet' was NULL. */
1853 static bool
1854 process_flow(struct bridge *br, const flow_t *flow,
1855              const struct ofpbuf *packet, struct odp_actions *actions,
1856              tag_type *tags, uint16_t *nf_output_iface)
1857 {
1858     struct iface *in_iface;
1859     struct port *in_port;
1860     struct port *out_port = NULL; /* By default, drop the packet/flow. */
1861     int vlan;
1862
1863     /* Find the interface and port structure for the received packet. */
1864     in_iface = iface_from_dp_ifidx(br, flow->in_port);
1865     if (!in_iface) {
1866         /* No interface?  Something fishy... */
1867         if (packet != NULL) {
1868             /* Odd.  A few possible reasons here:
1869              *
1870              * - We deleted an interface but there are still a few packets
1871              *   queued up from it.
1872              *
1873              * - Someone externally added an interface (e.g. with "ovs-dpctl
1874              *   add-if") that we don't know about.
1875              *
1876              * - Packet arrived on the local port but the local port is not
1877              *   one of our bridge ports.
1878              */
1879             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1880
1881             VLOG_WARN_RL(&rl, "bridge %s: received packet on unknown "
1882                          "interface %"PRIu16, br->name, flow->in_port);
1883         }
1884
1885         /* Return without adding any actions, to drop packets on this flow. */
1886         return true;
1887     }
1888     in_port = in_iface->port;
1889
1890     /* Figure out what VLAN this packet belongs to.
1891      *
1892      * Note that dl_vlan of 0 and of OFP_VLAN_NONE both mean that the packet
1893      * belongs to VLAN 0, so we should treat both cases identically.  (In the
1894      * former case, the packet has an 802.1Q header that specifies VLAN 0,
1895      * presumably to allow a priority to be specified.  In the latter case, the
1896      * packet does not have any 802.1Q header.) */
1897     vlan = ntohs(flow->dl_vlan);
1898     if (vlan == OFP_VLAN_NONE) {
1899         vlan = 0;
1900     }
1901     if (in_port->vlan >= 0) {
1902         if (vlan) {
1903             /* XXX support double tagging? */
1904             if (packet != NULL) {
1905                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1906                 VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %"PRIu16" tagged "
1907                              "packet received on port %s configured with "
1908                              "implicit VLAN %"PRIu16,
1909                              br->name, ntohs(flow->dl_vlan),
1910                              in_port->name, in_port->vlan);
1911             }
1912             goto done;
1913         }
1914         vlan = in_port->vlan;
1915     } else {
1916         if (!port_includes_vlan(in_port, vlan)) {
1917             static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1918             VLOG_WARN_RL(&rl, "bridge %s: dropping VLAN %d tagged "
1919                          "packet received on port %s not configured for "
1920                          "trunking VLAN %d",
1921                          br->name, vlan, in_port->name, vlan);
1922             goto done;
1923         }
1924     }
1925
1926     /* Drop frames for ports that STP wants entirely killed (both for
1927      * forwarding and for learning).  Later, after we do learning, we'll drop
1928      * the frames that STP wants to do learning but not forwarding on. */
1929     if (in_port->stp_state & (STP_LISTENING | STP_BLOCKING)) {
1930         goto done;
1931     }
1932
1933     /* Drop frames for reserved multicast addresses. */
1934     if (eth_addr_is_reserved(flow->dl_dst)) {
1935         goto done;
1936     }
1937
1938     /* Drop frames on ports reserved for mirroring. */
1939     if (in_port->is_mirror_output_port) {
1940         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
1941         VLOG_WARN_RL(&rl, "bridge %s: dropping packet received on port %s, "
1942                      "which is reserved exclusively for mirroring",
1943                      br->name, in_port->name);
1944         goto done;
1945     }
1946
1947     /* Packets received on bonds need special attention to avoid duplicates. */
1948     if (in_port->n_ifaces > 1) {
1949         int src_idx;
1950
1951         if (eth_addr_is_multicast(flow->dl_dst)) {
1952             *tags |= in_port->active_iface_tag;
1953             if (in_port->active_iface != in_iface->port_ifidx) {
1954                 /* Drop all multicast packets on inactive slaves. */
1955                 goto done;
1956             }
1957         }
1958
1959         /* Drop all packets for which we have learned a different input
1960          * port, because we probably sent the packet on one slave and got
1961          * it back on the other.  Broadcast ARP replies are an exception
1962          * to this rule: the host has moved to another switch. */
1963         src_idx = mac_learning_lookup(br->ml, flow->dl_src, vlan);
1964         if (src_idx != -1 && src_idx != in_port->port_idx &&
1965             !is_bcast_arp_reply(flow)) {
1966                 goto done;
1967         }
1968     }
1969
1970     /* MAC learning. */
1971     out_port = FLOOD_PORT;
1972     if (br->ml) {
1973         int out_port_idx;
1974
1975         /* Learn source MAC (but don't try to learn from revalidation). */
1976         if (packet) {
1977             tag_type rev_tag = mac_learning_learn(br->ml, flow->dl_src,
1978                                                   vlan, in_port->port_idx);
1979             if (rev_tag) {
1980                 /* The log messages here could actually be useful in debugging,
1981                  * so keep the rate limit relatively high. */
1982                 static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(30,
1983                                                                         300);
1984                 VLOG_DBG_RL(&rl, "bridge %s: learned that "ETH_ADDR_FMT" is "
1985                             "on port %s in VLAN %d",
1986                             br->name, ETH_ADDR_ARGS(flow->dl_src),
1987                             in_port->name, vlan);
1988                 ofproto_revalidate(br->ofproto, rev_tag);
1989             }
1990         }
1991
1992         /* Determine output port. */
1993         out_port_idx = mac_learning_lookup_tag(br->ml, flow->dl_dst, vlan,
1994                                                tags);
1995         if (out_port_idx >= 0 && out_port_idx < br->n_ports) {
1996             out_port = br->ports[out_port_idx];
1997         } else if (!packet) {
1998             /* If we are revalidating but don't have a learning entry then
1999              * eject the flow.  Installing a flow that floods packets will
2000              * prevent us from seeing future packets and learning properly. */
2001             return false;
2002         }
2003     }
2004
2005     /* Don't send packets out their input ports.  Don't forward frames that STP
2006      * wants us to discard. */
2007     if (in_port == out_port || in_port->stp_state == STP_LEARNING) {
2008         out_port = NULL;
2009     }
2010
2011 done:
2012     compose_actions(br, flow, vlan, in_port, out_port, tags, actions,
2013                     nf_output_iface);
2014
2015     return true;
2016 }
2017
2018 /* Careful: 'opp' is in host byte order and opp->port_no is an OFP port
2019  * number. */
2020 static void
2021 bridge_port_changed_ofhook_cb(enum ofp_port_reason reason,
2022                               const struct ofp_phy_port *opp,
2023                               void *br_)
2024 {
2025     struct bridge *br = br_;
2026     struct iface *iface;
2027     struct port *port;
2028
2029     iface = iface_from_dp_ifidx(br, ofp_port_to_odp_port(opp->port_no));
2030     if (!iface) {
2031         return;
2032     }
2033     port = iface->port;
2034
2035     if (reason == OFPPR_DELETE) {
2036         VLOG_WARN("bridge %s: interface %s deleted unexpectedly",
2037                   br->name, iface->name);
2038         iface_destroy(iface);
2039         if (!port->n_ifaces) {
2040             VLOG_WARN("bridge %s: port %s has no interfaces, dropping",
2041                       br->name, port->name);
2042             port_destroy(port);
2043         }
2044
2045         bridge_flush(br);
2046     } else {
2047         memcpy(iface->mac, opp->hw_addr, ETH_ADDR_LEN);
2048         if (port->n_ifaces > 1) {
2049             bool up = !(opp->state & OFPPS_LINK_DOWN);
2050             bond_link_status_update(iface, up);
2051             port_update_bond_compat(port);
2052         }
2053     }
2054 }
2055
2056 static bool
2057 bridge_normal_ofhook_cb(const flow_t *flow, const struct ofpbuf *packet,
2058                         struct odp_actions *actions, tag_type *tags,
2059                         uint16_t *nf_output_iface, void *br_)
2060 {
2061     struct bridge *br = br_;
2062
2063 #if 0
2064     if (flow->dl_type == htons(OFP_DL_TYPE_NOT_ETH_TYPE)
2065         && eth_addr_equals(flow->dl_dst, stp_eth_addr)) {
2066         brstp_receive(br, flow, payload);
2067         return true;
2068     }
2069 #endif
2070
2071     COVERAGE_INC(bridge_process_flow);
2072     return process_flow(br, flow, packet, actions, tags, nf_output_iface);
2073 }
2074
2075 static void
2076 bridge_account_flow_ofhook_cb(const flow_t *flow,
2077                               const union odp_action *actions,
2078                               size_t n_actions, unsigned long long int n_bytes,
2079                               void *br_)
2080 {
2081     struct bridge *br = br_;
2082     const union odp_action *a;
2083
2084     if (!br->has_bonded_ports) {
2085         return;
2086     }
2087
2088     for (a = actions; a < &actions[n_actions]; a++) {
2089         if (a->type == ODPAT_OUTPUT) {
2090             struct port *port = port_from_dp_ifidx(br, a->output.port);
2091             if (port && port->n_ifaces >= 2) {
2092                 struct bond_entry *e = lookup_bond_entry(port, flow->dl_src);
2093                 e->tx_bytes += n_bytes;
2094             }
2095         }
2096     }
2097 }
2098
2099 static void
2100 bridge_account_checkpoint_ofhook_cb(void *br_)
2101 {
2102     struct bridge *br = br_;
2103     size_t i;
2104
2105     if (!br->has_bonded_ports) {
2106         return;
2107     }
2108
2109     /* The current ofproto implementation calls this callback at least once a
2110      * second, so this timer implementation is sufficient. */
2111     if (time_msec() < br->bond_next_rebalance) {
2112         return;
2113     }
2114     br->bond_next_rebalance = time_msec() + 10000;
2115
2116     for (i = 0; i < br->n_ports; i++) {
2117         struct port *port = br->ports[i];
2118         if (port->n_ifaces > 1) {
2119             bond_rebalance_port(port);
2120         }
2121     }
2122 }
2123
2124 static struct ofhooks bridge_ofhooks = {
2125     bridge_port_changed_ofhook_cb,
2126     bridge_normal_ofhook_cb,
2127     bridge_account_flow_ofhook_cb,
2128     bridge_account_checkpoint_ofhook_cb,
2129 };
2130 \f
2131 /* Bonding functions. */
2132
2133 /* Statistics for a single interface on a bonded port, used for load-based
2134  * bond rebalancing.  */
2135 struct slave_balance {
2136     struct iface *iface;        /* The interface. */
2137     uint64_t tx_bytes;          /* Sum of hashes[*]->tx_bytes. */
2138
2139     /* All the "bond_entry"s that are assigned to this interface, in order of
2140      * increasing tx_bytes. */
2141     struct bond_entry **hashes;
2142     size_t n_hashes;
2143 };
2144
2145 /* Sorts pointers to pointers to bond_entries in ascending order by the
2146  * interface to which they are assigned, and within a single interface in
2147  * ascending order of bytes transmitted. */
2148 static int
2149 compare_bond_entries(const void *a_, const void *b_)
2150 {
2151     const struct bond_entry *const *ap = a_;
2152     const struct bond_entry *const *bp = b_;
2153     const struct bond_entry *a = *ap;
2154     const struct bond_entry *b = *bp;
2155     if (a->iface_idx != b->iface_idx) {
2156         return a->iface_idx > b->iface_idx ? 1 : -1;
2157     } else if (a->tx_bytes != b->tx_bytes) {
2158         return a->tx_bytes > b->tx_bytes ? 1 : -1;
2159     } else {
2160         return 0;
2161     }
2162 }
2163
2164 /* Sorts slave_balances so that enabled ports come first, and otherwise in
2165  * *descending* order by number of bytes transmitted. */
2166 static int
2167 compare_slave_balance(const void *a_, const void *b_)
2168 {
2169     const struct slave_balance *a = a_;
2170     const struct slave_balance *b = b_;
2171     if (a->iface->enabled != b->iface->enabled) {
2172         return a->iface->enabled ? -1 : 1;
2173     } else if (a->tx_bytes != b->tx_bytes) {
2174         return a->tx_bytes > b->tx_bytes ? -1 : 1;
2175     } else {
2176         return 0;
2177     }
2178 }
2179
2180 static void
2181 swap_bals(struct slave_balance *a, struct slave_balance *b)
2182 {
2183     struct slave_balance tmp = *a;
2184     *a = *b;
2185     *b = tmp;
2186 }
2187
2188 /* Restores the 'n_bals' slave_balance structures in 'bals' to sorted order
2189  * given that 'p' (and only 'p') might be in the wrong location.
2190  *
2191  * This function invalidates 'p', since it might now be in a different memory
2192  * location. */
2193 static void
2194 resort_bals(struct slave_balance *p,
2195             struct slave_balance bals[], size_t n_bals)
2196 {
2197     if (n_bals > 1) {
2198         for (; p > bals && p->tx_bytes > p[-1].tx_bytes; p--) {
2199             swap_bals(p, p - 1);
2200         }
2201         for (; p < &bals[n_bals - 1] && p->tx_bytes < p[1].tx_bytes; p++) {
2202             swap_bals(p, p + 1);
2203         }
2204     }
2205 }
2206
2207 static void
2208 log_bals(const struct slave_balance *bals, size_t n_bals, struct port *port)
2209 {
2210     if (VLOG_IS_DBG_ENABLED()) {
2211         struct ds ds = DS_EMPTY_INITIALIZER;
2212         const struct slave_balance *b;
2213
2214         for (b = bals; b < bals + n_bals; b++) {
2215             size_t i;
2216
2217             if (b > bals) {
2218                 ds_put_char(&ds, ',');
2219             }
2220             ds_put_format(&ds, " %s %"PRIu64"kB",
2221                           b->iface->name, b->tx_bytes / 1024);
2222
2223             if (!b->iface->enabled) {
2224                 ds_put_cstr(&ds, " (disabled)");
2225             }
2226             if (b->n_hashes > 0) {
2227                 ds_put_cstr(&ds, " (");
2228                 for (i = 0; i < b->n_hashes; i++) {
2229                     const struct bond_entry *e = b->hashes[i];
2230                     if (i > 0) {
2231                         ds_put_cstr(&ds, " + ");
2232                     }
2233                     ds_put_format(&ds, "h%td: %"PRIu64"kB",
2234                                   e - port->bond_hash, e->tx_bytes / 1024);
2235                 }
2236                 ds_put_cstr(&ds, ")");
2237             }
2238         }
2239         VLOG_DBG("bond %s:%s", port->name, ds_cstr(&ds));
2240         ds_destroy(&ds);
2241     }
2242 }
2243
2244 /* Shifts 'hash' from 'from' to 'to' within 'port'. */
2245 static void
2246 bond_shift_load(struct slave_balance *from, struct slave_balance *to,
2247                 int hash_idx)
2248 {
2249     struct bond_entry *hash = from->hashes[hash_idx];
2250     struct port *port = from->iface->port;
2251     uint64_t delta = hash->tx_bytes;
2252
2253     VLOG_INFO("bond %s: shift %"PRIu64"kB of load (with hash %td) "
2254               "from %s to %s (now carrying %"PRIu64"kB and "
2255               "%"PRIu64"kB load, respectively)",
2256               port->name, delta / 1024, hash - port->bond_hash,
2257               from->iface->name, to->iface->name,
2258               (from->tx_bytes - delta) / 1024,
2259               (to->tx_bytes + delta) / 1024);
2260
2261     /* Delete element from from->hashes.
2262      *
2263      * We don't bother to add the element to to->hashes because not only would
2264      * it require more work, the only purpose it would be to allow that hash to
2265      * be migrated to another slave in this rebalancing run, and there is no
2266      * point in doing that.  */
2267     if (hash_idx == 0) {
2268         from->hashes++;
2269     } else {
2270         memmove(from->hashes + hash_idx, from->hashes + hash_idx + 1,
2271                 (from->n_hashes - (hash_idx + 1)) * sizeof *from->hashes);
2272     }
2273     from->n_hashes--;
2274
2275     /* Shift load away from 'from' to 'to'. */
2276     from->tx_bytes -= delta;
2277     to->tx_bytes += delta;
2278
2279     /* Arrange for flows to be revalidated. */
2280     ofproto_revalidate(port->bridge->ofproto, hash->iface_tag);
2281     hash->iface_idx = to->iface->port_ifidx;
2282     hash->iface_tag = tag_create_random();
2283 }
2284
2285 static void
2286 bond_rebalance_port(struct port *port)
2287 {
2288     struct slave_balance bals[DP_MAX_PORTS];
2289     size_t n_bals;
2290     struct bond_entry *hashes[BOND_MASK + 1];
2291     struct slave_balance *b, *from, *to;
2292     struct bond_entry *e;
2293     size_t i;
2294
2295     /* Sets up 'bals' to describe each of the port's interfaces, sorted in
2296      * descending order of tx_bytes, so that bals[0] represents the most
2297      * heavily loaded slave and bals[n_bals - 1] represents the least heavily
2298      * loaded slave.
2299      *
2300      * The code is a bit tricky: to avoid dynamically allocating a 'hashes'
2301      * array for each slave_balance structure, we sort our local array of
2302      * hashes in order by slave, so that all of the hashes for a given slave
2303      * become contiguous in memory, and then we point each 'hashes' members of
2304      * a slave_balance structure to the start of a contiguous group. */
2305     n_bals = port->n_ifaces;
2306     for (b = bals; b < &bals[n_bals]; b++) {
2307         b->iface = port->ifaces[b - bals];
2308         b->tx_bytes = 0;
2309         b->hashes = NULL;
2310         b->n_hashes = 0;
2311     }
2312     for (i = 0; i <= BOND_MASK; i++) {
2313         hashes[i] = &port->bond_hash[i];
2314     }
2315     qsort(hashes, BOND_MASK + 1, sizeof *hashes, compare_bond_entries);
2316     for (i = 0; i <= BOND_MASK; i++) {
2317         e = hashes[i];
2318         if (e->iface_idx >= 0 && e->iface_idx < port->n_ifaces) {
2319             b = &bals[e->iface_idx];
2320             b->tx_bytes += e->tx_bytes;
2321             if (!b->hashes) {
2322                 b->hashes = &hashes[i];
2323             }
2324             b->n_hashes++;
2325         }
2326     }
2327     qsort(bals, n_bals, sizeof *bals, compare_slave_balance);
2328     log_bals(bals, n_bals, port);
2329
2330     /* Discard slaves that aren't enabled (which were sorted to the back of the
2331      * array earlier). */
2332     while (!bals[n_bals - 1].iface->enabled) {
2333         n_bals--;
2334         if (!n_bals) {
2335             return;
2336         }
2337     }
2338
2339     /* Shift load from the most-loaded slaves to the least-loaded slaves. */
2340     to = &bals[n_bals - 1];
2341     for (from = bals; from < to; ) {
2342         uint64_t overload = from->tx_bytes - to->tx_bytes;
2343         if (overload < to->tx_bytes >> 5 || overload < 100000) {
2344             /* The extra load on 'from' (and all less-loaded slaves), compared
2345              * to that of 'to' (the least-loaded slave), is less than ~3%, or
2346              * it is less than ~1Mbps.  No point in rebalancing. */
2347             break;
2348         } else if (from->n_hashes == 1) {
2349             /* 'from' only carries a single MAC hash, so we can't shift any
2350              * load away from it, even though we want to. */
2351             from++;
2352         } else {
2353             /* 'from' is carrying significantly more load than 'to', and that
2354              * load is split across at least two different hashes.  Pick a hash
2355              * to migrate to 'to' (the least-loaded slave), given that doing so
2356              * must decrease the ratio of the load on the two slaves by at
2357              * least 0.1.
2358              *
2359              * The sort order we use means that we prefer to shift away the
2360              * smallest hashes instead of the biggest ones.  There is little
2361              * reason behind this decision; we could use the opposite sort
2362              * order to shift away big hashes ahead of small ones. */
2363             size_t i;
2364             bool order_swapped;
2365
2366             for (i = 0; i < from->n_hashes; i++) {
2367                 double old_ratio, new_ratio;
2368                 uint64_t delta = from->hashes[i]->tx_bytes;
2369
2370                 if (delta == 0 || from->tx_bytes - delta == 0) {
2371                     /* Pointless move. */
2372                     continue;
2373                 }
2374
2375                 order_swapped = from->tx_bytes - delta < to->tx_bytes + delta;
2376
2377                 if (to->tx_bytes == 0) {
2378                     /* Nothing on the new slave, move it. */
2379                     break;
2380                 }
2381
2382                 old_ratio = (double)from->tx_bytes / to->tx_bytes;
2383                 new_ratio = (double)(from->tx_bytes - delta) /
2384                             (to->tx_bytes + delta);
2385
2386                 if (new_ratio == 0) {
2387                     /* Should already be covered but check to prevent division
2388                      * by zero. */
2389                     continue;
2390                 }
2391
2392                 if (new_ratio < 1) {
2393                     new_ratio = 1 / new_ratio;
2394                 }
2395
2396                 if (old_ratio - new_ratio > 0.1) {
2397                     /* Would decrease the ratio, move it. */
2398                     break;
2399                 }
2400             }
2401             if (i < from->n_hashes) {
2402                 bond_shift_load(from, to, i);
2403                 port->bond_compat_is_stale = true;
2404
2405                 /* If the result of the migration changed the relative order of
2406                  * 'from' and 'to' swap them back to maintain invariants. */
2407                 if (order_swapped) {
2408                     swap_bals(from, to);
2409                 }
2410
2411                 /* Re-sort 'bals'.  Note that this may make 'from' and 'to'
2412                  * point to different slave_balance structures.  It is only
2413                  * valid to do these two operations in a row at all because we
2414                  * know that 'from' will not move past 'to' and vice versa. */
2415                 resort_bals(from, bals, n_bals);
2416                 resort_bals(to, bals, n_bals);
2417             } else {
2418                 from++;
2419             }
2420         }
2421     }
2422
2423     /* Implement exponentially weighted moving average.  A weight of 1/2 causes
2424      * historical data to decay to <1% in 7 rebalancing runs.  */
2425     for (e = &port->bond_hash[0]; e <= &port->bond_hash[BOND_MASK]; e++) {
2426         e->tx_bytes /= 2;
2427     }
2428 }
2429
2430 static void
2431 bond_send_learning_packets(struct port *port)
2432 {
2433     struct bridge *br = port->bridge;
2434     struct mac_entry *e;
2435     struct ofpbuf packet;
2436     int error, n_packets, n_errors;
2437
2438     if (!port->n_ifaces || port->active_iface < 0 || !br->ml) {
2439         return;
2440     }
2441
2442     ofpbuf_init(&packet, 128);
2443     error = n_packets = n_errors = 0;
2444     LIST_FOR_EACH (e, struct mac_entry, lru_node, &br->ml->lrus) {
2445         union ofp_action actions[2], *a;
2446         uint16_t dp_ifidx;
2447         tag_type tags = 0;
2448         flow_t flow;
2449         int retval;
2450
2451         if (e->port == port->port_idx
2452             || !choose_output_iface(port, e->mac, &dp_ifidx, &tags)) {
2453             continue;
2454         }
2455
2456         /* Compose actions. */
2457         memset(actions, 0, sizeof actions);
2458         a = actions;
2459         if (e->vlan) {
2460             a->vlan_vid.type = htons(OFPAT_SET_VLAN_VID);
2461             a->vlan_vid.len = htons(sizeof *a);
2462             a->vlan_vid.vlan_vid = htons(e->vlan);
2463             a++;
2464         }
2465         a->output.type = htons(OFPAT_OUTPUT);
2466         a->output.len = htons(sizeof *a);
2467         a->output.port = htons(odp_port_to_ofp_port(dp_ifidx));
2468         a++;
2469
2470         /* Send packet. */
2471         n_packets++;
2472         compose_benign_packet(&packet, "Open vSwitch Bond Failover", 0xf177,
2473                               e->mac);
2474         flow_extract(&packet, ODPP_NONE, &flow);
2475         retval = ofproto_send_packet(br->ofproto, &flow, actions, a - actions,
2476                                      &packet);
2477         if (retval) {
2478             error = retval;
2479             n_errors++;
2480         }
2481     }
2482     ofpbuf_uninit(&packet);
2483
2484     if (n_errors) {
2485         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
2486         VLOG_WARN_RL(&rl, "bond %s: %d errors sending %d gratuitous learning "
2487                      "packets, last error was: %s",
2488                      port->name, n_errors, n_packets, strerror(error));
2489     } else {
2490         VLOG_DBG("bond %s: sent %d gratuitous learning packets",
2491                  port->name, n_packets);
2492     }
2493 }
2494 \f
2495 /* Bonding unixctl user interface functions. */
2496
2497 static void
2498 bond_unixctl_list(struct unixctl_conn *conn, const char *args UNUSED)
2499 {
2500     struct ds ds = DS_EMPTY_INITIALIZER;
2501     const struct bridge *br;
2502
2503     ds_put_cstr(&ds, "bridge\tbond\tslaves\n");
2504
2505     LIST_FOR_EACH (br, struct bridge, node, &all_bridges) {
2506         size_t i;
2507
2508         for (i = 0; i < br->n_ports; i++) {
2509             const struct port *port = br->ports[i];
2510             if (port->n_ifaces > 1) {
2511                 size_t j;
2512
2513                 ds_put_format(&ds, "%s\t%s\t", br->name, port->name);
2514                 for (j = 0; j < port->n_ifaces; j++) {
2515                     const struct iface *iface = port->ifaces[j];
2516                     if (j) {
2517                         ds_put_cstr(&ds, ", ");
2518                     }
2519                     ds_put_cstr(&ds, iface->name);
2520                 }
2521                 ds_put_char(&ds, '\n');
2522             }
2523         }
2524     }
2525     unixctl_command_reply(conn, 200, ds_cstr(&ds));
2526     ds_destroy(&ds);
2527 }
2528
2529 static struct port *
2530 bond_find(const char *name)
2531 {
2532     const struct bridge *br;
2533
2534     LIST_FOR_EACH (br, struct bridge, node, &all_bridges) {
2535         size_t i;
2536
2537         for (i = 0; i < br->n_ports; i++) {
2538             struct port *port = br->ports[i];
2539             if (!strcmp(port->name, name) && port->n_ifaces > 1) {
2540                 return port;
2541             }
2542         }
2543     }
2544     return NULL;
2545 }
2546
2547 static void
2548 bond_unixctl_show(struct unixctl_conn *conn, const char *args)
2549 {
2550     struct ds ds = DS_EMPTY_INITIALIZER;
2551     const struct port *port;
2552     size_t j;
2553
2554     port = bond_find(args);
2555     if (!port) {
2556         unixctl_command_reply(conn, 501, "no such bond");
2557         return;
2558     }
2559
2560     ds_put_format(&ds, "updelay: %d ms\n", port->updelay);
2561     ds_put_format(&ds, "downdelay: %d ms\n", port->downdelay);
2562     ds_put_format(&ds, "next rebalance: %lld ms\n",
2563                   port->bridge->bond_next_rebalance - time_msec());
2564     for (j = 0; j < port->n_ifaces; j++) {
2565         const struct iface *iface = port->ifaces[j];
2566         struct bond_entry *be;
2567
2568         /* Basic info. */
2569         ds_put_format(&ds, "slave %s: %s\n",
2570                       iface->name, iface->enabled ? "enabled" : "disabled");
2571         if (j == port->active_iface) {
2572             ds_put_cstr(&ds, "\tactive slave\n");
2573         }
2574         if (iface->delay_expires != LLONG_MAX) {
2575             ds_put_format(&ds, "\t%s expires in %lld ms\n",
2576                           iface->enabled ? "downdelay" : "updelay",
2577                           iface->delay_expires - time_msec());
2578         }
2579
2580         /* Hashes. */
2581         for (be = port->bond_hash; be <= &port->bond_hash[BOND_MASK]; be++) {
2582             int hash = be - port->bond_hash;
2583             struct mac_entry *me;
2584
2585             if (be->iface_idx != j) {
2586                 continue;
2587             }
2588
2589             ds_put_format(&ds, "\thash %d: %"PRIu64" kB load\n",
2590                           hash, be->tx_bytes / 1024);
2591
2592             /* MACs. */
2593             if (!port->bridge->ml) {
2594                 break;
2595             }
2596
2597             LIST_FOR_EACH (me, struct mac_entry, lru_node,
2598                            &port->bridge->ml->lrus) {
2599                 uint16_t dp_ifidx;
2600                 tag_type tags = 0;
2601                 if (bond_hash(me->mac) == hash
2602                     && me->port != port->port_idx
2603                     && choose_output_iface(port, me->mac, &dp_ifidx, &tags)
2604                     && dp_ifidx == iface->dp_ifidx)
2605                 {
2606                     ds_put_format(&ds, "\t\t"ETH_ADDR_FMT"\n",
2607                                   ETH_ADDR_ARGS(me->mac));
2608                 }
2609             }
2610         }
2611     }
2612     unixctl_command_reply(conn, 200, ds_cstr(&ds));
2613     ds_destroy(&ds);
2614 }
2615
2616 static void
2617 bond_unixctl_migrate(struct unixctl_conn *conn, const char *args_)
2618 {
2619     char *args = (char *) args_;
2620     char *save_ptr = NULL;
2621     char *bond_s, *hash_s, *slave_s;
2622     uint8_t mac[ETH_ADDR_LEN];
2623     struct port *port;
2624     struct iface *iface;
2625     struct bond_entry *entry;
2626     int hash;
2627
2628     bond_s = strtok_r(args, " ", &save_ptr);
2629     hash_s = strtok_r(NULL, " ", &save_ptr);
2630     slave_s = strtok_r(NULL, " ", &save_ptr);
2631     if (!slave_s) {
2632         unixctl_command_reply(conn, 501,
2633                               "usage: bond/migrate BOND HASH SLAVE");
2634         return;
2635     }
2636
2637     port = bond_find(bond_s);
2638     if (!port) {
2639         unixctl_command_reply(conn, 501, "no such bond");
2640         return;
2641     }
2642
2643     if (sscanf(hash_s, ETH_ADDR_SCAN_FMT, ETH_ADDR_SCAN_ARGS(mac))
2644         == ETH_ADDR_SCAN_COUNT) {
2645         hash = bond_hash(mac);
2646     } else if (strspn(hash_s, "0123456789") == strlen(hash_s)) {
2647         hash = atoi(hash_s) & BOND_MASK;
2648     } else {
2649         unixctl_command_reply(conn, 501, "bad hash");
2650         return;
2651     }
2652
2653     iface = port_lookup_iface(port, slave_s);
2654     if (!iface) {
2655         unixctl_command_reply(conn, 501, "no such slave");
2656         return;
2657     }
2658
2659     if (!iface->enabled) {
2660         unixctl_command_reply(conn, 501, "cannot migrate to disabled slave");
2661         return;
2662     }
2663
2664     entry = &port->bond_hash[hash];
2665     ofproto_revalidate(port->bridge->ofproto, entry->iface_tag);
2666     entry->iface_idx = iface->port_ifidx;
2667     entry->iface_tag = tag_create_random();
2668     port->bond_compat_is_stale = true;
2669     unixctl_command_reply(conn, 200, "migrated");
2670 }
2671
2672 static void
2673 bond_unixctl_set_active_slave(struct unixctl_conn *conn, const char *args_)
2674 {
2675     char *args = (char *) args_;
2676     char *save_ptr = NULL;
2677     char *bond_s, *slave_s;
2678     struct port *port;
2679     struct iface *iface;
2680
2681     bond_s = strtok_r(args, " ", &save_ptr);
2682     slave_s = strtok_r(NULL, " ", &save_ptr);
2683     if (!slave_s) {
2684         unixctl_command_reply(conn, 501,
2685                               "usage: bond/set-active-slave BOND SLAVE");
2686         return;
2687     }
2688
2689     port = bond_find(bond_s);
2690     if (!port) {
2691         unixctl_command_reply(conn, 501, "no such bond");
2692         return;
2693     }
2694
2695     iface = port_lookup_iface(port, slave_s);
2696     if (!iface) {
2697         unixctl_command_reply(conn, 501, "no such slave");
2698         return;
2699     }
2700
2701     if (!iface->enabled) {
2702         unixctl_command_reply(conn, 501, "cannot make disabled slave active");
2703         return;
2704     }
2705
2706     if (port->active_iface != iface->port_ifidx) {
2707         ofproto_revalidate(port->bridge->ofproto, port->active_iface_tag);
2708         port->active_iface = iface->port_ifidx;
2709         port->active_iface_tag = tag_create_random();
2710         VLOG_INFO("port %s: active interface is now %s",
2711                   port->name, iface->name);
2712         bond_send_learning_packets(port);
2713         unixctl_command_reply(conn, 200, "done");
2714     } else {
2715         unixctl_command_reply(conn, 200, "no change");
2716     }
2717 }
2718
2719 static void
2720 enable_slave(struct unixctl_conn *conn, const char *args_, bool enable)
2721 {
2722     char *args = (char *) args_;
2723     char *save_ptr = NULL;
2724     char *bond_s, *slave_s;
2725     struct port *port;
2726     struct iface *iface;
2727
2728     bond_s = strtok_r(args, " ", &save_ptr);
2729     slave_s = strtok_r(NULL, " ", &save_ptr);
2730     if (!slave_s) {
2731         unixctl_command_reply(conn, 501,
2732                               "usage: bond/enable/disable-slave BOND SLAVE");
2733         return;
2734     }
2735
2736     port = bond_find(bond_s);
2737     if (!port) {
2738         unixctl_command_reply(conn, 501, "no such bond");
2739         return;
2740     }
2741
2742     iface = port_lookup_iface(port, slave_s);
2743     if (!iface) {
2744         unixctl_command_reply(conn, 501, "no such slave");
2745         return;
2746     }
2747
2748     bond_enable_slave(iface, enable);
2749     unixctl_command_reply(conn, 501, enable ? "enabled" : "disabled");
2750 }
2751
2752 static void
2753 bond_unixctl_enable_slave(struct unixctl_conn *conn, const char *args)
2754 {
2755     enable_slave(conn, args, true);
2756 }
2757
2758 static void
2759 bond_unixctl_disable_slave(struct unixctl_conn *conn, const char *args)
2760 {
2761     enable_slave(conn, args, false);
2762 }
2763
2764 static void
2765 bond_init(void)
2766 {
2767     unixctl_command_register("bond/list", bond_unixctl_list);
2768     unixctl_command_register("bond/show", bond_unixctl_show);
2769     unixctl_command_register("bond/migrate", bond_unixctl_migrate);
2770     unixctl_command_register("bond/set-active-slave",
2771                              bond_unixctl_set_active_slave);
2772     unixctl_command_register("bond/enable-slave", bond_unixctl_enable_slave);
2773     unixctl_command_register("bond/disable-slave", bond_unixctl_disable_slave);
2774 }
2775 \f
2776 /* Port functions. */
2777
2778 static void
2779 port_create(struct bridge *br, const char *name)
2780 {
2781     struct port *port;
2782
2783     port = xcalloc(1, sizeof *port);
2784     port->bridge = br;
2785     port->port_idx = br->n_ports;
2786     port->vlan = -1;
2787     port->trunks = NULL;
2788     port->name = xstrdup(name);
2789     port->active_iface = -1;
2790     port->stp_state = STP_DISABLED;
2791     port->stp_state_tag = 0;
2792
2793     if (br->n_ports >= br->allocated_ports) {
2794         br->ports = x2nrealloc(br->ports, &br->allocated_ports,
2795                                sizeof *br->ports);
2796     }
2797     br->ports[br->n_ports++] = port;
2798
2799     VLOG_INFO("created port %s on bridge %s", port->name, br->name);
2800     bridge_flush(br);
2801 }
2802
2803 static void
2804 port_reconfigure(struct port *port)
2805 {
2806     bool bonded = cfg_has_section("bonding.%s", port->name);
2807     struct svec old_ifaces, new_ifaces;
2808     unsigned long *trunks;
2809     int vlan;
2810     size_t i;
2811
2812     /* Collect old and new interfaces. */
2813     svec_init(&old_ifaces);
2814     svec_init(&new_ifaces);
2815     for (i = 0; i < port->n_ifaces; i++) {
2816         svec_add(&old_ifaces, port->ifaces[i]->name);
2817     }
2818     svec_sort(&old_ifaces);
2819     if (bonded) {
2820         cfg_get_all_keys(&new_ifaces, "bonding.%s.slave", port->name);
2821         if (!new_ifaces.n) {
2822             VLOG_ERR("port %s: no interfaces specified for bonded port",
2823                      port->name);
2824         } else if (new_ifaces.n == 1) {
2825             VLOG_WARN("port %s: only 1 interface specified for bonded port",
2826                       port->name);
2827         }
2828
2829         port->updelay = cfg_get_int(0, "bonding.%s.updelay", port->name);
2830         if (port->updelay < 0) {
2831             port->updelay = 0;
2832         }
2833         port->downdelay = cfg_get_int(0, "bonding.%s.downdelay", port->name);
2834         if (port->downdelay < 0) {
2835             port->downdelay = 0;
2836         }
2837     } else {
2838         svec_init(&new_ifaces);
2839         svec_add(&new_ifaces, port->name);
2840     }
2841
2842     /* Get rid of deleted interfaces and add new interfaces. */
2843     for (i = 0; i < port->n_ifaces; i++) {
2844         struct iface *iface = port->ifaces[i];
2845         if (!svec_contains(&new_ifaces, iface->name)) {
2846             iface_destroy(iface);
2847         } else {
2848             i++;
2849         }
2850     }
2851     for (i = 0; i < new_ifaces.n; i++) {
2852         const char *name = new_ifaces.names[i];
2853         if (!svec_contains(&old_ifaces, name)) {
2854             iface_create(port, name);
2855         }
2856     }
2857
2858     /* Get VLAN tag. */
2859     vlan = -1;
2860     if (cfg_has("vlan.%s.tag", port->name)) {
2861         if (!bonded) {
2862             vlan = cfg_get_vlan(0, "vlan.%s.tag", port->name);
2863             if (vlan >= 0 && vlan <= 4095) {
2864                 VLOG_DBG("port %s: assigning VLAN tag %d", port->name, vlan);
2865             }
2866         } else {
2867             /* It's possible that bonded, VLAN-tagged ports make sense.  Maybe
2868              * they even work as-is.  But they have not been tested. */
2869             VLOG_WARN("port %s: VLAN tags not supported on bonded ports",
2870                       port->name);
2871         }
2872     }
2873     if (port->vlan != vlan) {
2874         port->vlan = vlan;
2875         bridge_flush(port->bridge);
2876     }
2877
2878     /* Get trunked VLANs. */
2879     trunks = NULL;
2880     if (vlan < 0) {
2881         size_t n_trunks, n_errors;
2882         size_t i;
2883
2884         trunks = bitmap_allocate(4096);
2885         n_trunks = cfg_count("vlan.%s.trunks", port->name);
2886         n_errors = 0;
2887         for (i = 0; i < n_trunks; i++) {
2888             int trunk = cfg_get_vlan(i, "vlan.%s.trunks", port->name);
2889             if (trunk >= 0) {
2890                 bitmap_set1(trunks, trunk);
2891             } else {
2892                 n_errors++;
2893             }
2894         }
2895         if (n_errors) {
2896             VLOG_ERR("port %s: invalid values for %zu trunk VLANs",
2897                      port->name, n_trunks);
2898         }
2899         if (n_errors == n_trunks) {
2900             if (n_errors) {
2901                 VLOG_ERR("port %s: no valid trunks, trunking all VLANs",
2902                          port->name);
2903             }
2904             bitmap_set_multiple(trunks, 0, 4096, 1);
2905         }
2906     } else {
2907         if (cfg_has("vlan.%s.trunks", port->name)) {
2908             VLOG_ERR("ignoring vlan.%s.trunks in favor of vlan.%s.vlan",
2909                      port->name, port->name);
2910         }
2911     }
2912     if (trunks == NULL
2913         ? port->trunks != NULL
2914         : port->trunks == NULL || !bitmap_equal(trunks, port->trunks, 4096)) {
2915         bridge_flush(port->bridge);
2916     }
2917     bitmap_free(port->trunks);
2918     port->trunks = trunks;
2919
2920     svec_destroy(&old_ifaces);
2921     svec_destroy(&new_ifaces);
2922 }
2923
2924 static void
2925 port_destroy(struct port *port)
2926 {
2927     if (port) {
2928         struct bridge *br = port->bridge;
2929         struct port *del;
2930         size_t i;
2931
2932         proc_net_compat_update_vlan(port->name, NULL, 0);
2933         proc_net_compat_update_bond(port->name, NULL);
2934
2935         for (i = 0; i < MAX_MIRRORS; i++) {
2936             struct mirror *m = br->mirrors[i];
2937             if (m && m->out_port == port) {
2938                 mirror_destroy(m);
2939             }
2940         }
2941
2942         while (port->n_ifaces > 0) {
2943             iface_destroy(port->ifaces[port->n_ifaces - 1]);
2944         }
2945
2946         del = br->ports[port->port_idx] = br->ports[--br->n_ports];
2947         del->port_idx = port->port_idx;
2948
2949         free(port->ifaces);
2950         bitmap_free(port->trunks);
2951         free(port->name);
2952         free(port);
2953         bridge_flush(br);
2954     }
2955 }
2956
2957 static struct port *
2958 port_from_dp_ifidx(const struct bridge *br, uint16_t dp_ifidx)
2959 {
2960     struct iface *iface = iface_from_dp_ifidx(br, dp_ifidx);
2961     return iface ? iface->port : NULL;
2962 }
2963
2964 static struct port *
2965 port_lookup(const struct bridge *br, const char *name)
2966 {
2967     size_t i;
2968
2969     for (i = 0; i < br->n_ports; i++) {
2970         struct port *port = br->ports[i];
2971         if (!strcmp(port->name, name)) {
2972             return port;
2973         }
2974     }
2975     return NULL;
2976 }
2977
2978 static struct iface *
2979 port_lookup_iface(const struct port *port, const char *name)
2980 {
2981     size_t j;
2982
2983     for (j = 0; j < port->n_ifaces; j++) {
2984         struct iface *iface = port->ifaces[j];
2985         if (!strcmp(iface->name, name)) {
2986             return iface;
2987         }
2988     }
2989     return NULL;
2990 }
2991
2992 static void
2993 port_update_bonding(struct port *port)
2994 {
2995     if (port->n_ifaces < 2) {
2996         /* Not a bonded port. */
2997         if (port->bond_hash) {
2998             free(port->bond_hash);
2999             port->bond_hash = NULL;
3000             port->bond_compat_is_stale = true;
3001         }
3002     } else {
3003         if (!port->bond_hash) {
3004             size_t i;
3005
3006             port->bond_hash = xcalloc(BOND_MASK + 1, sizeof *port->bond_hash);
3007             for (i = 0; i <= BOND_MASK; i++) {
3008                 struct bond_entry *e = &port->bond_hash[i];
3009                 e->iface_idx = -1;
3010                 e->tx_bytes = 0;
3011             }
3012             port->no_ifaces_tag = tag_create_random();
3013             bond_choose_active_iface(port);
3014         }
3015         port->bond_compat_is_stale = true;
3016     }
3017 }
3018
3019 static void
3020 port_update_bond_compat(struct port *port)
3021 {
3022     struct compat_bond_hash compat_hashes[BOND_MASK + 1];
3023     struct compat_bond bond;
3024     size_t i;
3025
3026     if (port->n_ifaces < 2) {
3027         proc_net_compat_update_bond(port->name, NULL);
3028         return;
3029     }
3030
3031     bond.up = false;
3032     bond.updelay = port->updelay;
3033     bond.downdelay = port->downdelay;
3034
3035     bond.n_hashes = 0;
3036     bond.hashes = compat_hashes;
3037     if (port->bond_hash) {
3038         const struct bond_entry *e;
3039         for (e = port->bond_hash; e <= &port->bond_hash[BOND_MASK]; e++) {
3040             if (e->iface_idx >= 0 && e->iface_idx < port->n_ifaces) {
3041                 struct compat_bond_hash *cbh = &bond.hashes[bond.n_hashes++];
3042                 cbh->hash = e - port->bond_hash;
3043                 cbh->netdev_name = port->ifaces[e->iface_idx]->name;
3044             }
3045         }
3046     }
3047
3048     bond.n_slaves = port->n_ifaces;
3049     bond.slaves = xmalloc(port->n_ifaces * sizeof *bond.slaves);
3050     for (i = 0; i < port->n_ifaces; i++) {
3051         struct iface *iface = port->ifaces[i];
3052         struct compat_bond_slave *slave = &bond.slaves[i];
3053         slave->name = iface->name;
3054
3055         /* We need to make the same determination as the Linux bonding
3056          * code to determine whether a slave should be consider "up".
3057          * The Linux function bond_miimon_inspect() supports four
3058          * BOND_LINK_* states:
3059          *
3060          *    - BOND_LINK_UP: carrier detected, updelay has passed.
3061          *    - BOND_LINK_FAIL: carrier lost, downdelay in progress.
3062          *    - BOND_LINK_DOWN: carrier lost, downdelay has passed.
3063          *    - BOND_LINK_BACK: carrier detected, updelay in progress.
3064          *
3065          * The function bond_info_show_slave() only considers BOND_LINK_UP
3066          * to be "up" and anything else to be "down".
3067          */
3068         slave->up = iface->enabled && iface->delay_expires == LLONG_MAX;
3069         if (slave->up) {
3070             bond.up = true;
3071         }
3072         memcpy(slave->mac, iface->mac, ETH_ADDR_LEN);
3073     }
3074
3075     if (cfg_get_bool(0, "bonding.%s.fake-iface", port->name)) {
3076         struct netdev *bond_netdev;
3077
3078         if (!netdev_open(port->name, NETDEV_ETH_TYPE_NONE, &bond_netdev)) {
3079             if (bond.up) {
3080                 netdev_turn_flags_on(bond_netdev, NETDEV_UP, true);
3081             } else {
3082                 netdev_turn_flags_off(bond_netdev, NETDEV_UP, true);
3083             }
3084             netdev_close(bond_netdev);
3085         }
3086     }
3087
3088     proc_net_compat_update_bond(port->name, &bond);
3089     free(bond.slaves);
3090 }
3091
3092 static void
3093 port_update_vlan_compat(struct port *port)
3094 {
3095     struct bridge *br = port->bridge;
3096     char *vlandev_name = NULL;
3097
3098     if (port->vlan > 0) {
3099         /* Figure out the name that the VLAN device should actually have, if it
3100          * existed.  This takes some work because the VLAN device would not
3101          * have port->name in its name; rather, it would have the trunk port's
3102          * name, and 'port' would be attached to a bridge that also had the
3103          * VLAN device one of its ports.  So we need to find a trunk port that
3104          * includes port->vlan.
3105          *
3106          * There might be more than one candidate.  This doesn't happen on
3107          * XenServer, so if it happens we just pick the first choice in
3108          * alphabetical order instead of creating multiple VLAN devices. */
3109         size_t i;
3110         for (i = 0; i < br->n_ports; i++) {
3111             struct port *p = br->ports[i];
3112             if (port_trunks_vlan(p, port->vlan)
3113                 && p->n_ifaces
3114                 && (!vlandev_name || strcmp(p->name, vlandev_name) <= 0))
3115             {
3116                 const uint8_t *ea = p->ifaces[0]->mac;
3117                 if (!eth_addr_is_multicast(ea) &&
3118                     !eth_addr_is_reserved(ea) &&
3119                     !eth_addr_is_zero(ea)) {
3120                     vlandev_name = p->name;
3121                 }
3122             }
3123         }
3124     }
3125     proc_net_compat_update_vlan(port->name, vlandev_name, port->vlan);
3126 }
3127 \f
3128 /* Interface functions. */
3129
3130 static void
3131 iface_create(struct port *port, const char *name)
3132 {
3133     struct iface *iface;
3134
3135     iface = xcalloc(1, sizeof *iface);
3136     iface->port = port;
3137     iface->port_ifidx = port->n_ifaces;
3138     iface->name = xstrdup(name);
3139     iface->dp_ifidx = -1;
3140     iface->tag = tag_create_random();
3141     iface->delay_expires = LLONG_MAX;
3142
3143     if (!cfg_get_bool(0, "iface.%s.internal", iface->name)) {
3144         netdev_nodev_get_etheraddr(name, iface->mac);
3145         netdev_nodev_get_carrier(name, &iface->enabled);
3146     } else {
3147         /* Internal interfaces are created later by the call to dpif_port_add()
3148          * in bridge_reconfigure().  Until then, we can't obtain any
3149          * information about them.  (There's no real value in doing so, anyway,
3150          * because the 'mac' and 'enabled' values are only used for interfaces
3151          * that are bond slaves, and it doesn't normally make sense to bond an
3152          * internal interface.) */
3153     }
3154
3155     if (port->n_ifaces >= port->allocated_ifaces) {
3156         port->ifaces = x2nrealloc(port->ifaces, &port->allocated_ifaces,
3157                                   sizeof *port->ifaces);
3158     }
3159     port->ifaces[port->n_ifaces++] = iface;
3160     if (port->n_ifaces > 1) {
3161         port->bridge->has_bonded_ports = true;
3162     }
3163
3164     VLOG_DBG("attached network device %s to port %s", iface->name, port->name);
3165
3166     port_update_bonding(port);
3167     bridge_flush(port->bridge);
3168 }
3169
3170 static void
3171 iface_destroy(struct iface *iface)
3172 {
3173     if (iface) {
3174         struct port *port = iface->port;
3175         struct bridge *br = port->bridge;
3176         bool del_active = port->active_iface == iface->port_ifidx;
3177         struct iface *del;
3178
3179         if (iface->dp_ifidx >= 0) {
3180             port_array_set(&br->ifaces, iface->dp_ifidx, NULL);
3181         }
3182
3183         del = port->ifaces[iface->port_ifidx] = port->ifaces[--port->n_ifaces];
3184         del->port_ifidx = iface->port_ifidx;
3185
3186         free(iface->name);
3187         free(iface);
3188
3189         if (del_active) {
3190             ofproto_revalidate(port->bridge->ofproto, port->active_iface_tag);
3191             bond_choose_active_iface(port);
3192             bond_send_learning_packets(port);
3193         }
3194
3195         port_update_bonding(port);
3196         bridge_flush(port->bridge);
3197     }
3198 }
3199
3200 static struct iface *
3201 iface_lookup(const struct bridge *br, const char *name)
3202 {
3203     size_t i, j;
3204
3205     for (i = 0; i < br->n_ports; i++) {
3206         struct port *port = br->ports[i];
3207         for (j = 0; j < port->n_ifaces; j++) {
3208             struct iface *iface = port->ifaces[j];
3209             if (!strcmp(iface->name, name)) {
3210                 return iface;
3211             }
3212         }
3213     }
3214     return NULL;
3215 }
3216
3217 static struct iface *
3218 iface_from_dp_ifidx(const struct bridge *br, uint16_t dp_ifidx)
3219 {
3220     return port_array_get(&br->ifaces, dp_ifidx);
3221 }
3222
3223 /* Returns true if 'iface' is the name of an "internal" interface on bridge
3224  * 'br', that is, an interface that is entirely simulated within the datapath.
3225  * The local port (ODPP_LOCAL) is always an internal interface.  Other local
3226  * interfaces are created by setting "iface.<iface>.internal = true".
3227  *
3228  * In addition, we have a kluge-y feature that creates an internal port with
3229  * the name of a bonded port if "bonding.<bondname>.fake-iface = true" is set.
3230  * This feature needs to go away in the long term.  Until then, this is one
3231  * reason why this function takes a name instead of a struct iface: the fake
3232  * interfaces created this way do not have a struct iface. */
3233 static bool
3234 iface_is_internal(const struct bridge *br, const char *iface)
3235 {
3236     if (!strcmp(iface, br->name)
3237         || cfg_get_bool(0, "iface.%s.internal", iface)) {
3238         return true;
3239     }
3240
3241     if (cfg_get_bool(0, "bonding.%s.fake-iface", iface)) {
3242         struct port *port = port_lookup(br, iface);
3243         if (port && port->n_ifaces > 1) {
3244             return true;
3245         }
3246     }
3247
3248     return false;
3249 }
3250
3251 /* Set Ethernet address of 'iface', if one is specified in the configuration
3252  * file. */
3253 static void
3254 iface_set_mac(struct iface *iface)
3255 {
3256     uint64_t mac = cfg_get_mac(0, "iface.%s.mac", iface->name);
3257     if (mac) {
3258         static uint8_t ea[ETH_ADDR_LEN];
3259
3260         eth_addr_from_uint64(mac, ea);
3261         if (eth_addr_is_multicast(ea)) {
3262             VLOG_ERR("interface %s: cannot set MAC to multicast address",
3263                      iface->name);
3264         } else if (iface->dp_ifidx == ODPP_LOCAL) {
3265             VLOG_ERR("ignoring iface.%s.mac; use bridge.%s.mac instead",
3266                      iface->name, iface->name);
3267         } else {
3268             int error = netdev_nodev_set_etheraddr(iface->name, ea);
3269             if (error) {
3270                 VLOG_ERR("interface %s: setting MAC failed (%s)",
3271                          iface->name, strerror(error));
3272             }
3273         }
3274     }
3275 }
3276 \f
3277 /* Port mirroring. */
3278
3279 static void
3280 mirror_reconfigure(struct bridge *br)
3281 {
3282     struct svec old_mirrors, new_mirrors;
3283     size_t i;
3284
3285     /* Collect old and new mirrors. */
3286     svec_init(&old_mirrors);
3287     svec_init(&new_mirrors);
3288     cfg_get_subsections(&new_mirrors, "mirror.%s", br->name);
3289     for (i = 0; i < MAX_MIRRORS; i++) {
3290         if (br->mirrors[i]) {
3291             svec_add(&old_mirrors, br->mirrors[i]->name);
3292         }
3293     }
3294
3295     /* Get rid of deleted mirrors and add new mirrors. */
3296     svec_sort(&old_mirrors);
3297     assert(svec_is_unique(&old_mirrors));
3298     svec_sort(&new_mirrors);
3299     assert(svec_is_unique(&new_mirrors));
3300     for (i = 0; i < MAX_MIRRORS; i++) {
3301         struct mirror *m = br->mirrors[i];
3302         if (m && !svec_contains(&new_mirrors, m->name)) {
3303             mirror_destroy(m);
3304         }
3305     }
3306     for (i = 0; i < new_mirrors.n; i++) {
3307         const char *name = new_mirrors.names[i];
3308         if (!svec_contains(&old_mirrors, name)) {
3309             mirror_create(br, name);
3310         }
3311     }
3312     svec_destroy(&old_mirrors);
3313     svec_destroy(&new_mirrors);
3314
3315     /* Reconfigure all mirrors. */
3316     for (i = 0; i < MAX_MIRRORS; i++) {
3317         if (br->mirrors[i]) {
3318             mirror_reconfigure_one(br->mirrors[i]);
3319         }
3320     }
3321
3322     /* Update port reserved status. */
3323     for (i = 0; i < br->n_ports; i++) {
3324         br->ports[i]->is_mirror_output_port = false;
3325     }
3326     for (i = 0; i < MAX_MIRRORS; i++) {
3327         struct mirror *m = br->mirrors[i];
3328         if (m && m->out_port) {
3329             m->out_port->is_mirror_output_port = true;
3330         }
3331     }
3332 }
3333
3334 static void
3335 mirror_create(struct bridge *br, const char *name)
3336 {
3337     struct mirror *m;
3338     size_t i;
3339
3340     for (i = 0; ; i++) {
3341         if (i >= MAX_MIRRORS) {
3342             VLOG_WARN("bridge %s: maximum of %d port mirrors reached, "
3343                       "cannot create %s", br->name, MAX_MIRRORS, name);
3344             return;
3345         }
3346         if (!br->mirrors[i]) {
3347             break;
3348         }
3349     }
3350
3351     VLOG_INFO("created port mirror %s on bridge %s", name, br->name);
3352     bridge_flush(br);
3353
3354     br->mirrors[i] = m = xcalloc(1, sizeof *m);
3355     m->bridge = br;
3356     m->idx = i;
3357     m->name = xstrdup(name);
3358     svec_init(&m->src_ports);
3359     svec_init(&m->dst_ports);
3360     m->vlans = NULL;
3361     m->n_vlans = 0;
3362     m->out_vlan = -1;
3363     m->out_port = NULL;
3364 }
3365
3366 static void
3367 mirror_destroy(struct mirror *m)
3368 {
3369     if (m) {
3370         struct bridge *br = m->bridge;
3371         size_t i;
3372
3373         for (i = 0; i < br->n_ports; i++) {
3374             br->ports[i]->src_mirrors &= ~(MIRROR_MASK_C(1) << m->idx);
3375             br->ports[i]->dst_mirrors &= ~(MIRROR_MASK_C(1) << m->idx);
3376         }
3377
3378         svec_destroy(&m->src_ports);
3379         svec_destroy(&m->dst_ports);
3380         free(m->vlans);
3381
3382         m->bridge->mirrors[m->idx] = NULL;
3383         free(m);
3384
3385         bridge_flush(br);
3386     }
3387 }
3388
3389 static void
3390 prune_ports(struct mirror *m, struct svec *ports)
3391 {
3392     struct svec tmp;
3393     size_t i;
3394
3395     svec_sort_unique(ports);
3396
3397     svec_init(&tmp);
3398     for (i = 0; i < ports->n; i++) {
3399         const char *name = ports->names[i];
3400         if (port_lookup(m->bridge, name)) {
3401             svec_add(&tmp, name);
3402         } else {
3403             VLOG_WARN("mirror.%s.%s: cannot match on nonexistent port %s",
3404                       m->bridge->name, m->name, name);
3405         }
3406     }
3407     svec_swap(ports, &tmp);
3408     svec_destroy(&tmp);
3409 }
3410
3411 static size_t
3412 prune_vlans(struct mirror *m, struct svec *vlan_strings, int **vlans)
3413 {
3414     size_t n_vlans, i;
3415
3416     /* This isn't perfect: it won't combine "0" and "00", and the textual sort
3417      * order won't give us numeric sort order.  But that's good enough for what
3418      * we need right now. */
3419     svec_sort_unique(vlan_strings);
3420
3421     *vlans = xmalloc(sizeof *vlans * vlan_strings->n);
3422     n_vlans = 0;
3423     for (i = 0; i < vlan_strings->n; i++) {
3424         const char *name = vlan_strings->names[i];
3425         int vlan;
3426         if (!str_to_int(name, 10, &vlan) || vlan < 0 || vlan > 4095) {
3427             VLOG_WARN("mirror.%s.%s.select.vlan: ignoring invalid VLAN %s",
3428                       m->bridge->name, m->name, name);
3429         } else {
3430             (*vlans)[n_vlans++] = vlan;
3431         }
3432     }
3433     return n_vlans;
3434 }
3435
3436 static bool
3437 vlan_is_mirrored(const struct mirror *m, int vlan)
3438 {
3439     size_t i;
3440
3441     for (i = 0; i < m->n_vlans; i++) {
3442         if (m->vlans[i] == vlan) {
3443             return true;
3444         }
3445     }
3446     return false;
3447 }
3448
3449 static bool
3450 port_trunks_any_mirrored_vlan(const struct mirror *m, const struct port *p)
3451 {
3452     size_t i;
3453
3454     for (i = 0; i < m->n_vlans; i++) {
3455         if (port_trunks_vlan(p, m->vlans[i])) {
3456             return true;
3457         }
3458     }
3459     return false;
3460 }
3461
3462 static void
3463 mirror_reconfigure_one(struct mirror *m)
3464 {
3465     char *pfx = xasprintf("mirror.%s.%s", m->bridge->name, m->name);
3466     struct svec src_ports, dst_ports, ports;
3467     struct svec vlan_strings;
3468     mirror_mask_t mirror_bit;
3469     const char *out_port_name;
3470     struct port *out_port;
3471     int out_vlan;
3472     size_t n_vlans;
3473     int *vlans;
3474     size_t i;
3475     bool mirror_all_ports;
3476     bool any_ports_specified;
3477
3478     /* Get output port. */
3479     out_port_name = cfg_get_key(0, "mirror.%s.%s.output.port",
3480                                 m->bridge->name, m->name);
3481     if (out_port_name) {
3482         out_port = port_lookup(m->bridge, out_port_name);
3483         if (!out_port) {
3484             VLOG_ERR("%s.output.port: bridge %s does not have a port "
3485                       "named %s", pfx, m->bridge->name, out_port_name);
3486             mirror_destroy(m);
3487             free(pfx);
3488             return;
3489         }
3490         out_vlan = -1;
3491
3492         if (cfg_has("%s.output.vlan", pfx)) {
3493             VLOG_ERR("%s.output.port and %s.output.vlan both specified; "
3494                      "ignoring %s.output.vlan", pfx, pfx, pfx);
3495         }
3496     } else if (cfg_has("%s.output.vlan", pfx)) {
3497         out_port = NULL;
3498         out_vlan = cfg_get_vlan(0, "%s.output.vlan", pfx);
3499     } else {
3500         VLOG_ERR("%s: neither %s.output.port nor %s.output.vlan specified, "
3501                  "but exactly one is required; disabling port mirror %s",
3502                  pfx, pfx, pfx, pfx);
3503         mirror_destroy(m);
3504         free(pfx);
3505         return;
3506     }
3507
3508     /* Get all the ports, and drop duplicates and ports that don't exist. */
3509     svec_init(&src_ports);
3510     svec_init(&dst_ports);
3511     svec_init(&ports);
3512     cfg_get_all_keys(&src_ports, "%s.select.src-port", pfx);
3513     cfg_get_all_keys(&dst_ports, "%s.select.dst-port", pfx);
3514     cfg_get_all_keys(&ports, "%s.select.port", pfx);
3515     any_ports_specified = src_ports.n || dst_ports.n || ports.n;
3516     svec_append(&src_ports, &ports);
3517     svec_append(&dst_ports, &ports);
3518     svec_destroy(&ports);
3519     prune_ports(m, &src_ports);
3520     prune_ports(m, &dst_ports);
3521     if (any_ports_specified && !src_ports.n && !dst_ports.n) {
3522         VLOG_ERR("%s: none of the specified ports exist; "
3523                  "disabling port mirror %s", pfx, pfx);
3524         mirror_destroy(m);
3525         goto exit;
3526     }
3527
3528     /* Get all the vlans, and drop duplicate and invalid vlans. */
3529     svec_init(&vlan_strings);
3530     cfg_get_all_keys(&vlan_strings, "%s.select.vlan", pfx);
3531     n_vlans = prune_vlans(m, &vlan_strings, &vlans);
3532     svec_destroy(&vlan_strings);
3533
3534     /* Update mirror data. */
3535     if (!svec_equal(&m->src_ports, &src_ports)
3536         || !svec_equal(&m->dst_ports, &dst_ports)
3537         || m->n_vlans != n_vlans
3538         || memcmp(m->vlans, vlans, sizeof *vlans * n_vlans)
3539         || m->out_port != out_port
3540         || m->out_vlan != out_vlan) {
3541         bridge_flush(m->bridge);
3542     }
3543     svec_swap(&m->src_ports, &src_ports);
3544     svec_swap(&m->dst_ports, &dst_ports);
3545     free(m->vlans);
3546     m->vlans = vlans;
3547     m->n_vlans = n_vlans;
3548     m->out_port = out_port;
3549     m->out_vlan = out_vlan;
3550
3551     /* If no selection criteria have been given, mirror for all ports. */
3552     mirror_all_ports = (!m->src_ports.n) && (!m->dst_ports.n) && (!m->n_vlans);
3553
3554     /* Update ports. */
3555     mirror_bit = MIRROR_MASK_C(1) << m->idx;
3556     for (i = 0; i < m->bridge->n_ports; i++) {
3557         struct port *port = m->bridge->ports[i];
3558
3559         if (mirror_all_ports
3560             || svec_contains(&m->src_ports, port->name)
3561             || (m->n_vlans
3562                 && (!port->vlan
3563                     ? port_trunks_any_mirrored_vlan(m, port)
3564                     : vlan_is_mirrored(m, port->vlan)))) {
3565             port->src_mirrors |= mirror_bit;
3566         } else {
3567             port->src_mirrors &= ~mirror_bit;
3568         }
3569
3570         if (mirror_all_ports || svec_contains(&m->dst_ports, port->name)) {
3571             port->dst_mirrors |= mirror_bit;
3572         } else {
3573             port->dst_mirrors &= ~mirror_bit;
3574         }
3575     }
3576
3577     /* Clean up. */
3578 exit:
3579     svec_destroy(&src_ports);
3580     svec_destroy(&dst_ports);
3581     free(pfx);
3582 }
3583 \f
3584 /* Spanning tree protocol. */
3585
3586 static void brstp_update_port_state(struct port *);
3587
3588 static void
3589 brstp_send_bpdu(struct ofpbuf *pkt, int port_no, void *br_)
3590 {
3591     struct bridge *br = br_;
3592     static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(1, 5);
3593     struct iface *iface = iface_from_dp_ifidx(br, port_no);
3594     if (!iface) {
3595         VLOG_WARN_RL(&rl, "%s: cannot send BPDU on unknown port %d",
3596                      br->name, port_no);
3597     } else if (eth_addr_is_zero(iface->mac)) {
3598         VLOG_WARN_RL(&rl, "%s: cannot send BPDU on port %d with unknown MAC",
3599                      br->name, port_no);
3600     } else {
3601         union ofp_action action;
3602         struct eth_header *eth = pkt->l2;
3603         flow_t flow;
3604
3605         memcpy(eth->eth_src, iface->mac, ETH_ADDR_LEN);
3606
3607         memset(&action, 0, sizeof action);
3608         action.type = htons(OFPAT_OUTPUT);
3609         action.output.len = htons(sizeof action);
3610         action.output.port = htons(port_no);
3611
3612         flow_extract(pkt, ODPP_NONE, &flow);
3613         ofproto_send_packet(br->ofproto, &flow, &action, 1, pkt);
3614     }
3615     ofpbuf_delete(pkt);
3616 }
3617
3618 static void
3619 brstp_reconfigure(struct bridge *br)
3620 {
3621     size_t i;
3622
3623     if (!cfg_get_bool(0, "stp.%s.enabled", br->name)) {
3624         if (br->stp) {
3625             stp_destroy(br->stp);
3626             br->stp = NULL;
3627
3628             bridge_flush(br);
3629         }
3630     } else {
3631         uint64_t bridge_address, bridge_id;
3632         int bridge_priority;
3633
3634         bridge_address = cfg_get_mac(0, "stp.%s.address", br->name);
3635         if (!bridge_address) {
3636             if (br->stp) {
3637                 bridge_address = (stp_get_bridge_id(br->stp)
3638                                   & ((UINT64_C(1) << 48) - 1));
3639             } else {
3640                 uint8_t mac[ETH_ADDR_LEN];
3641                 eth_addr_random(mac);
3642                 bridge_address = eth_addr_to_uint64(mac);
3643             }
3644         }
3645
3646         if (cfg_is_valid(CFG_INT | CFG_REQUIRED, "stp.%s.priority",
3647                          br->name)) {
3648             bridge_priority = cfg_get_int(0, "stp.%s.priority", br->name);
3649         } else {
3650             bridge_priority = STP_DEFAULT_BRIDGE_PRIORITY;
3651         }
3652
3653         bridge_id = bridge_address | ((uint64_t) bridge_priority << 48);
3654         if (!br->stp) {
3655             br->stp = stp_create(br->name, bridge_id, brstp_send_bpdu, br);
3656             br->stp_last_tick = time_msec();
3657             bridge_flush(br);
3658         } else {
3659             if (bridge_id != stp_get_bridge_id(br->stp)) {
3660                 stp_set_bridge_id(br->stp, bridge_id);
3661                 bridge_flush(br);
3662             }
3663         }
3664
3665         for (i = 0; i < br->n_ports; i++) {
3666             struct port *p = br->ports[i];
3667             int dp_ifidx;
3668             struct stp_port *sp;
3669             int path_cost, priority;
3670             bool enable;
3671
3672             if (!p->n_ifaces) {
3673                 continue;
3674             }
3675             dp_ifidx = p->ifaces[0]->dp_ifidx;
3676             if (dp_ifidx < 0 || dp_ifidx >= STP_MAX_PORTS) {
3677                 continue;
3678             }
3679
3680             sp = stp_get_port(br->stp, dp_ifidx);
3681             enable = (!cfg_is_valid(CFG_BOOL | CFG_REQUIRED,
3682                                     "stp.%s.port.%s.enabled",
3683                                     br->name, p->name)
3684                       || cfg_get_bool(0, "stp.%s.port.%s.enabled",
3685                                       br->name, p->name));
3686             if (p->is_mirror_output_port) {
3687                 enable = false;
3688             }
3689             if (enable != (stp_port_get_state(sp) != STP_DISABLED)) {
3690                 bridge_flush(br); /* Might not be necessary. */
3691                 if (enable) {
3692                     stp_port_enable(sp);
3693                 } else {
3694                     stp_port_disable(sp);
3695                 }
3696             }
3697
3698             path_cost = cfg_get_int(0, "stp.%s.port.%s.path-cost",
3699                                     br->name, p->name);
3700             stp_port_set_path_cost(sp, path_cost ? path_cost : 19 /* XXX */);
3701
3702             priority = (cfg_is_valid(CFG_INT | CFG_REQUIRED,
3703                                      "stp.%s.port.%s.priority",
3704                                      br->name, p->name)
3705                         ? cfg_get_int(0, "stp.%s.port.%s.priority",
3706                                       br->name, p->name)
3707                         : STP_DEFAULT_PORT_PRIORITY);
3708             stp_port_set_priority(sp, priority);
3709         }
3710
3711         brstp_adjust_timers(br);
3712     }
3713     for (i = 0; i < br->n_ports; i++) {
3714         brstp_update_port_state(br->ports[i]);
3715     }
3716 }
3717
3718 static void
3719 brstp_update_port_state(struct port *p)
3720 {
3721     struct bridge *br = p->bridge;
3722     enum stp_state state;
3723
3724     /* Figure out new state. */
3725     state = STP_DISABLED;
3726     if (br->stp && p->n_ifaces > 0) {
3727         int dp_ifidx = p->ifaces[0]->dp_ifidx;
3728         if (dp_ifidx >= 0 && dp_ifidx < STP_MAX_PORTS) {
3729             state = stp_port_get_state(stp_get_port(br->stp, dp_ifidx));
3730         }
3731     }
3732
3733     /* Update state. */
3734     if (p->stp_state != state) {
3735         static struct vlog_rate_limit rl = VLOG_RATE_LIMIT_INIT(10, 10);
3736         VLOG_INFO_RL(&rl, "port %s: STP state changed from %s to %s",
3737                      p->name, stp_state_name(p->stp_state),
3738                      stp_state_name(state));
3739         if (p->stp_state == STP_DISABLED) {
3740             bridge_flush(br);
3741         } else {
3742             ofproto_revalidate(p->bridge->ofproto, p->stp_state_tag);
3743         }
3744         p->stp_state = state;
3745         p->stp_state_tag = (p->stp_state == STP_DISABLED ? 0
3746                             : tag_create_random());
3747     }
3748 }
3749
3750 static void
3751 brstp_adjust_timers(struct bridge *br)
3752 {
3753     int hello_time = cfg_get_int(0, "stp.%s.hello-time", br->name);
3754     int max_age = cfg_get_int(0, "stp.%s.max-age", br->name);
3755     int forward_delay = cfg_get_int(0, "stp.%s.forward-delay", br->name);
3756
3757     stp_set_hello_time(br->stp, hello_time ? hello_time : 2000);
3758     stp_set_max_age(br->stp, max_age ? max_age : 20000);
3759     stp_set_forward_delay(br->stp, forward_delay ? forward_delay : 15000);
3760 }
3761
3762 static void
3763 brstp_run(struct bridge *br)
3764 {
3765     if (br->stp) {
3766         long long int now = time_msec();
3767         long long int elapsed = now - br->stp_last_tick;
3768         struct stp_port *sp;
3769
3770         if (elapsed > 0) {
3771             stp_tick(br->stp, MIN(INT_MAX, elapsed));
3772             br->stp_last_tick = now;
3773         }
3774         while (stp_get_changed_port(br->stp, &sp)) {
3775             struct port *p = port_from_dp_ifidx(br, stp_port_no(sp));
3776             if (p) {
3777                 brstp_update_port_state(p);
3778             }
3779         }
3780     }
3781 }
3782
3783 static void
3784 brstp_wait(struct bridge *br)
3785 {
3786     if (br->stp) {
3787         poll_timer_wait(1000);
3788     }
3789 }