vswitchd/bridge.c

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