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