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