vswitchd/INTERNALS

   1                        ========================
   2                         ovs-vswitchd Internals
   3                        ========================
   4
   5 This document describes some of the internals of the ovs-vswitchd
   6 process.  It is not complete.  It tends to be updated on demand, so if
   7 you have questions about the vswitchd implementation, ask them and
   8 perhaps we'll add some appropriate documentation here.
   9
  10 Most of the ovs-vswitchd implementation is in vswitchd/bridge.c, so
  11 code references below should be assumed to refer to that file except
  12 as otherwise specified.
  13
  14 Bonding
  15 =======
  16
  17 Bonding allows two or more interfaces (the "slaves") to share network
  18 traffic.  From a high-level point of view, bonded interfaces act like
  19 a single port, but they have the bandwidth of multiple network
  20 devices, e.g. two 1 GB physical interfaces act like a single 2 GB
  21 interface.  Bonds also increase robustness: the bonded port does not
  22 go down as long as at least one of its slaves is up.
  23
  24 In vswitchd, a bond always has at least two slaves (and may have
  25 more).  If a configuration error, etc. would cause a bond to have only
  26 one slave, the port becomes an ordinary port, not a bonded port, and
  27 none of the special features of bonded ports described in this section
  28 apply.
  29
  30 There are many forms of bonding, but ovs-vswitchd currently implements
  31 only a single kind, called "source load balancing" or SLB bonding.
  32 SLB bonding divides traffic among the slaves based on the Ethernet
  33 source address.  This is useful only if the traffic over the bond has
  34 multiple Ethernet source addresses, for example if network traffic
  35 from multiple VMs are multiplexed over the bond.
  36
  37 Enabling and Disabling Slaves
  38 -----------------------------
  39
  40 When a bond is created, a slave is initially enabled or disabled based
  41 on whether carrier is detected on the NIC (see iface_create()).  After
  42 that, a slave is disabled if its carrier goes down for a period of
  43 time longer than the downdelay, and it is enabled if carrier comes up
  44 for longer than the updelay (see bond_link_status_update()).  There is
  45 one exception where the updelay is skipped: if no slaves at all are
  46 currently enabled, then the first slave on which carrier comes up is
  47 enabled immediately.
  48
  49 The updelay should be set to a time longer than the STP forwarding
  50 delay of the physical switch to which the bond port is connected (if
  51 STP is enabled on that switch).  Otherwise, the slave will be enabled,
  52 and load may be shifted to it, before the physical switch starts
  53 forwarding packets on that port, which can cause some data to be
  54 "blackholed" for a time.  The exception for a single enabled slave
  55 does not cause any problem in this regard because when no slaves are
  56 enabled all output packets are blackholed anyway.
  57
  58 When a slave becomes disabled, the vswitch immediately chooses a new
  59 output port for traffic that was destined for that slave (see
  60 bond_enable_slave()).  It also sends a "gratuitous learning packet",
  61 specifically a RARP, on the bond port (on the newly chosen slave) for
  62 each MAC address that the vswitch has learned on a port other than the
  63 bond (see bond_send_learning_packets()), to teach the physical switch
  64 that the new slave should be used in place of the one that is now
  65 disabled.  (This behavior probably makes sense only for a vswitch that
  66 has only one port (the bond) connected to a physical switch; vswitchd
  67 should probably provide a way to disable or configure it in other
  68 scenarios.)
  69
  70 Bond Packet Input
  71 -----------------
  72
  73 Bonding accepts unicast packets on any bond slave.  This can
  74 occasionally cause packet duplication for the first few packets sent
  75 to a given MAC, if the physical switch attached to the bond is
  76 flooding packets to that MAC because it has not yet learned the
  77 correct slave for that MAC.
  78
  79 Bonding only accepts multicast (and broadcast) packets on a single
  80 bond slave (the "active slave") at any given time.  Multicast packets
  81 received on other slaves are dropped.  Otherwise, every multicast
  82 packet would be duplicated, once for every bond slave, because the
  83 physical switch attached to the bond will flood those packets.
  84
  85 Bonding also drops received packets when the vswitch has learned that
  86 the packet's MAC is on a port other than the bond port itself.  This is
  87 because it is likely that the vswitch itself sent the packet out the
  88 bond port on a different slave and is now receiving the packet back.
  89 This occurs when the packet is multicast or the physical switch has not
  90 yet learned the MAC and is flooding it.  However, the vswitch makes an
  91 exception to this rule for broadcast ARP replies, which indicate that
  92 the MAC has moved to another switch, probably due to VM migration.
  93 (ARP replies are normally unicast, so this exception does not match
  94 normal ARP replies.  It will match the learning packets sent on bond
  95 fail-over.)
  96
  97 The active slave is simply the first slave to be enabled after the
  98 bond is created (see bond_choose_active_iface()).  If the active slave
  99 is disabled, then a new active slave is chosen among the slaves that
 100 remain active.  Currently due to the way that configuration works,
 101 this tends to be the remaining slave whose interface name is first
 102 alphabetically, but this is by no means guaranteed.
 103
 104 Bond Packet Output
 105 ------------------
 106
 107 When a packet is sent out a bond port, the bond slave actually used is
 108 selected based on the packet's source MAC and VLAN tag (see
 109 choose_output_iface()).  In particular, the source MAC and VLAN tag
 110 are hashed into one of 256 values, and that value is looked up in a
 111 hash table (the "bond hash") kept in the "bond_hash" member of struct
 112 port.  The hash table entry identifies a bond slave.  If no bond slave
 113 has yet been chosen for that hash table entry, vswitchd chooses one
 114 arbitrarily.
 115
 116 Every 10 seconds, vswitchd rebalances the bond slaves (see
 117 bond_rebalance_port()).  To rebalance, vswitchd examines the
 118 statistics for the number of bytes transmitted by each slave over
 119 approximately the past minute, with data sent more recently weighted
 120 more heavily than data sent less recently.  It considers each of the
 121 slaves in order from most-loaded to least-loaded.  If highly loaded
 122 slave H is significantly more heavily loaded than the least-loaded
 123 slave L, and slave H carries at least two hashes, then vswitchd shifts
 124 one of H's hashes to L.  However, vswitchd will only shift a hash from
 125 H to L if it will decrease the ratio of the load between H and L by at
 126 least 0.1.
 127
 128 Currently, "significantly more loaded" means that H must carry at
 129 least 1 Mbps more traffic, and that traffic must be at least 3%
 130 greater than L's.
 131
 132 Bond Balance Modes
 133 ------------------
 134
 135 Each bond balancing mode has different considerations, described
 136 below.
 137
 138 LACP Bonding
 139 ------------
 140
 141 LACP bonding requires the remote switch to implement LACP, but it is
 142 otherwise very simple in that, after LACP negotiation is complete,
 143 there is no need for special handling of received packets.
 144
 145 SLB Bonding
 146 -----------
 147
 148 SLB bonding allows a limited form of load balancing without the remote
 149 switch's knowledge or cooperation.  The basics of SLB are simple.  SLB
 150 assigns each source MAC+VLAN pair to a link and transmits all packets
 151 from that MAC+VLAN through that link.  Learning in the remote switch
 152 causes it to send packets to that MAC+VLAN through the same link.
 153
 154 SLB bonding has the following complications:
 155
 156    0. When the remote switch has not learned the MAC for the
 157       destination of a unicast packet and hence floods the packet to
 158       all of the links on the SLB bond, Open vSwitch will forward
 159       duplicate packets, one per link, to each other switch port.
 160
 161       Open vSwitch does not solve this problem.
 162
 163    1. When the remote switch receives a multicast or broadcast packet
 164       from a port not on the SLB bond, it will forward it to all of
 165       the links in the SLB bond.  This would cause packet duplication
 166       if not handled specially.
 167
 168       Open vSwitch avoids packet duplication by accepting multicast
 169       and broadcast packets on only the active slave, and dropping
 170       multicast and broadcast packets on all other slaves.
 171
 172    2. When Open vSwitch forwards a multicast or broadcast packet to a
 173       link in the SLB bond other than the active slave, the remote
 174       switch will forward it to all of the other links in the SLB
 175       bond, including the active slave.  Without special handling,
 176       this would mean that Open vSwitch would forward a second copy of
 177       the packet to each switch port (other than the bond), including
 178       the port that originated the packet.
 179
 180       Open vSwitch deals with this case by dropping packets received
 181       on any SLB bonded link that have a source MAC+VLAN that has been
 182       learned on any other port.  (This means that SLB as implemented
 183       in Open vSwitch relies critically on MAC learning.  Notably, SLB
 184       is incompatible with the "flood_vlans" feature.)
 185
 186    3. Suppose that a MAC+VLAN moves to an SLB bond from another port
 187       (e.g. when a VM is migrated from this hypervisor to a different
 188       one).  Without additional special handling, Open vSwitch will
 189       not notice until the MAC learning entry expires, up to 60
 190       seconds later as a consequence of rule #2.
 191
 192       Open vSwitch avoids a 60-second delay by listening for
 193       gratuitous ARPs, which VMs commonly emit upon migration.  As an
 194       exception to rule #2, a gratuitous ARP received on an SLB bond
 195       is not dropped and updates the MAC learning table in the usual
 196       way.  (If a move does not trigger a gratuitous ARP, or if the
 197       gratuitous ARP is lost in the network, then a 60-second delay
 198       still occurs.)
 199
 200    4. Suppose that a MAC+VLAN moves from an SLB bond to another port
 201       (e.g. when a VM is migrated from a different hypervisor to this
 202       one), that the MAC+VLAN emits a gratuitous ARP, and that Open
 203       vSwitch forwards that gratuitous ARP to a link in the SLB bond
 204       other than the active slave.  The remote switch will forward the
 205       gratuitous ARP to all of the other links in the SLB bond,
 206       including the active slave.  Without additional special
 207       handling, this would mean that Open vSwitch would learn that the
 208       MAC+VLAN was located on the SLB bond, as a consequence of rule
 209       #3.
 210
 211       Open vSwitch avoids this problem by "locking" the MAC learning
 212       table entry for a MAC+VLAN from which a gratuitous ARP was
 213       received from a non-SLB bond port.  For 5 seconds, a locked MAC
 214       learning table entry will not be updated based on a gratuitous
 215       ARP received on a SLB bond.