vswitchd/bridge.c

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