vswitchd/bridge.c

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