DESIGN

   1                      Design Decisions In Open vSwitch
   2                      ================================
   3
   4 This document describes design decisions that went into implementing
   5 Open vSwitch.  While we believe these to be reasonable decisions, it is
   6 impossible to predict how Open vSwitch will be used in all environments.
   7 Understanding assumptions made by Open vSwitch is critical to a
   8 successful deployment.  The end of this document contains contact
   9 information that can be used to let us know how we can make Open vSwitch
  10 more generally useful.
  11
  12 Asynchronous Messages
  13 =====================
  14
  15 Over time, Open vSwitch has added many knobs that control whether a
  16 given controller receives OpenFlow asynchronous messages.  This
  17 section describes how all of these features interact.
  18
  19 First, a service controller never receives any asynchronous messages
  20 unless it explicitly configures a miss_send_len greater than zero with
  21 an OFPT_SET_CONFIG message.
  22
  23 Second, OFPT_FLOW_REMOVED and NXT_FLOW_REMOVED messages are generated
  24 only if the flow that was removed had the OFPFF_SEND_FLOW_REM flag
  25 set.
  26
  27 Finally, Open vSwitch consults a per-connection table indexed by the
  28 message type, reason code, and current role.  The following table
  29 shows how this table is initialized by default when an OpenFlow
  30 connection is made.  An entry labeled "yes" means that the message is
  31 sent, an entry labeled "---" means that the message is suppressed.
  32
  33                                              master/
  34   message and reason code                     other     slave
  35   ----------------------------------------   -------    -----
  36   OFPT_PACKET_IN / NXT_PACKET_IN
  37     OFPR_NO_MATCH                              yes       ---
  38     OFPR_ACTION                                yes       ---
  39     OFPR_INVALID_TTL                           ---       ---
  40
  41   OFPT_FLOW_REMOVED / NXT_FLOW_REMOVED
  42     OFPRR_IDLE_TIMEOUT                         yes       ---
  43     OFPRR_HARD_TIMEOUT                         yes       ---
  44     OFPRR_DELETE                               yes       ---
  45
  46   OFPT_PORT_STATUS
  47     OFPPR_ADD                                  yes       yes
  48     OFPPR_DELETE                               yes       yes
  49     OFPPR_MODIFY                               yes       yes
  50
  51 The NXT_SET_ASYNC_CONFIG message directly sets all of the values in
  52 this table for the current connection.  The
  53 OFPC_INVALID_TTL_TO_CONTROLLER bit in the OFPT_SET_CONFIG message
  54 controls the setting for OFPR_INVALID_TTL for the "master" role.
  55
  56
  57 OFPAT_ENQUEUE
  58 =============
  59
  60 The OpenFlow 1.0 specification requires the output port of the OFPAT_ENQUEUE
  61 action to "refer to a valid physical port (i.e. < OFPP_MAX) or OFPP_IN_PORT".
  62 Although OFPP_LOCAL is not less than OFPP_MAX, it is an 'internal' port which
  63 can have QoS applied to it in Linux.  Since we allow the OFPAT_ENQUEUE to apply
  64 to 'internal' ports whose port numbers are less than OFPP_MAX, we interpret
  65 OFPP_LOCAL as a physical port and support OFPAT_ENQUEUE on it as well.
  66
  67
  68 OFPT_FLOW_MOD
  69 =============
  70
  71 The OpenFlow 1.0 specification for the behavior of OFPT_FLOW_MOD is
  72 confusing.  The following table summarizes the Open vSwitch
  73 implementation of its behavior in the following categories:
  74
  75     - "match on priority": Whether the flow_mod acts only on flows
  76       whose priority matches that included in the flow_mod message.
  77
  78     - "match on out_port": Whether the flow_mod acts only on flows
  79       that output to the out_port included in the flow_mod message (if
  80       out_port is not OFPP_NONE).
  81
  82     - "updates flow_cookie": Whether the flow_mod changes the
  83       flow_cookie of the flow or flows that it matches to the
  84       flow_cookie included in the flow_mod message.
  85
  86     - "updates OFPFF_ flags": Whether the flow_mod changes the
  87       OFPFF_SEND_FLOW_REM flag of the flow or flows that it matches to
  88       the setting included in the flags of the flow_mod message.
  89
  90     - "honors OFPFF_CHECK_OVERLAP": Whether the OFPFF_CHECK_OVERLAP
  91       flag in the flow_mod is significant.
  92
  93     - "updates idle_timeout" and "updates hard_timeout": Whether the
  94       idle_timeout and hard_timeout in the flow_mod, respectively,
  95       have an effect on the flow or flows matched by the flow_mod.
  96
  97     - "updates idle timer": Whether the flow_mod resets the per-flow
  98       timer that measures how long a flow has been idle.
  99
 100     - "updates hard timer": Whether the flow_mod resets the per-flow
 101       timer that measures how long it has been since a flow was
 102       modified.
 103
 104     - "zeros counters": Whether the flow_mod resets per-flow packet
 105       and byte counters to zero.
 106
 107     - "sends flow_removed message": Whether the flow_mod generates a
 108       flow_removed message for the flow or flows that it affects.
 109
 110 An entry labeled "yes" means that the flow mod type does have the
 111 indicated behavior, "---" means that it does not, an empty cell means
 112 that the property is not applicable, and other values are explained
 113 below the table.
 114
 115                                           MODIFY          DELETE
 116                              ADD  MODIFY  STRICT  DELETE  STRICT
 117                              ===  ======  ======  ======  ======
 118 match on priority           ---    ---     yes     ---     yes
 119 match on out_port           ---    ---     ---     yes     yes
 120 updates flow_cookie          yes    yes     yes
 121 updates OFPFF_SEND_FLOW_REM  yes     +       +
 122 honors OFPFF_CHECK_OVERLAP   yes     +       +
 123 updates idle_timeout         yes     +       +
 124 updates hard_timeout         yes     +       +
 125 resets idle timer            yes     +       +
 126 resets hard timer            yes    yes     yes
 127 zeros counters               yes     +       +
 128 sends flow_removed message   ---    ---     ---      %       %
 129
 130 (+) "modify" and "modify-strict" only take these actions when they
 131     create a new flow, not when they update an existing flow.
 132
 133 (%) "delete" and "delete_strict" generates a flow_removed message if
 134     the deleted flow or flows have the OFPFF_SEND_FLOW_REM flag set.
 135     (Each controller can separately control whether it wants to
 136     receive the generated messages.)
 137
 138
 139 Multiple Table Support
 140 ======================
 141
 142 OpenFlow 1.0 has only rudimentary support for multiple flow tables.
 143 Notably, OpenFlow 1.0 does not allow the controller to specify the
 144 flow table to which a flow is to be added.  Open vSwitch adds an
 145 extension for this purpose, which is enabled on a per-OpenFlow
 146 connection basis using the NXT_FLOW_MOD_TABLE_ID message.  When the
 147 extension is enabled, the upper 8 bits of the 'command' member in an
 148 OFPT_FLOW_MOD or NXT_FLOW_MOD message designates the table to which a
 149 flow is to be added.
 150
 151 The Open vSwitch software switch implementation offers 255 flow
 152 tables.  On packet ingress, only the first flow table (table 0) is
 153 searched, and the contents of the remaining tables are not considered
 154 in any way.  Tables other than table 0 only come into play when an
 155 NXAST_RESUBMIT_TABLE action specifies another table to search.
 156
 157 Tables 128 and above are reserved for use by the switch itself.
 158 Controllers should use only tables 0 through 127.
 159
 160
 161 IPv6
 162 ====
 163
 164 Open vSwitch supports stateless handling of IPv6 packets.  Flows can be
 165 written to support matching TCP, UDP, and ICMPv6 headers within an IPv6
 166 packet.  Deeper matching of some Neighbor Discovery messages is also
 167 supported.
 168
 169 IPv6 was not designed to interact well with middle-boxes.  This,
 170 combined with Open vSwitch's stateless nature, have affected the
 171 processing of IPv6 traffic, which is detailed below.
 172
 173 Extension Headers
 174 -----------------
 175
 176 The base IPv6 header is incredibly simple with the intention of only
 177 containing information relevant for routing packets between two
 178 endpoints.  IPv6 relies heavily on the use of extension headers to
 179 provide any other functionality.  Unfortunately, the extension headers
 180 were designed in such a way that it is impossible to move to the next
 181 header (including the layer-4 payload) unless the current header is
 182 understood.
 183
 184 Open vSwitch will process the following extension headers and continue
 185 to the next header:
 186
 187     * Fragment (see the next section)
 188     * AH (Authentication Header)
 189     * Hop-by-Hop Options
 190     * Routing
 191     * Destination Options
 192
 193 When a header is encountered that is not in that list, it is considered
 194 "terminal".  A terminal header's IPv6 protocol value is stored in
 195 "nw_proto" for matching purposes.  If a terminal header is TCP, UDP, or
 196 ICMPv6, the packet will be further processed in an attempt to extract
 197 layer-4 information.
 198
 199 Fragments
 200 ---------
 201
 202 IPv6 requires that every link in the internet have an MTU of 1280 octets
 203 or greater (RFC 2460).  As such, a terminal header (as described above in
 204 "Extension Headers") in the first fragment should generally be
 205 reachable.  In this case, the terminal header's IPv6 protocol type is
 206 stored in the "nw_proto" field for matching purposes.  If a terminal
 207 header cannot be found in the first fragment (one with a fragment offset
 208 of zero), the "nw_proto" field is set to 0.  Subsequent fragments (those
 209 with a non-zero fragment offset) have the "nw_proto" field set to the
 210 IPv6 protocol type for fragments (44).
 211
 212 Jumbograms
 213 ----------
 214
 215 An IPv6 jumbogram (RFC 2675) is a packet containing a payload longer
 216 than 65,535 octets.  A jumbogram is only relevant in subnets with a link
 217 MTU greater than 65,575 octets, and are not required to be supported on
 218 nodes that do not connect to link with such large MTUs.  Currently, Open
 219 vSwitch doesn't process jumbograms.
 220
 221
 222 In-Band Control
 223 ===============
 224
 225 In-band control allows a single network to be used for OpenFlow traffic and
 226 other data traffic.  See ovs-vswitchd.conf.db(5) for a description of
 227 configuring in-band control.
 228
 229 This comment is an attempt to describe how in-band control works at a
 230 wire- and implementation-level.  Correctly implementing in-band
 231 control has proven difficult due to its many subtleties, and has thus
 232 gone through many iterations.  Please read through and understand the
 233 reasoning behind the chosen rules before making modifications.
 234
 235 In Open vSwitch, in-band control is implemented as "hidden" flows (in that
 236 they are not visible through OpenFlow) and at a higher priority than
 237 wildcarded flows can be set up by through OpenFlow.  This is done so that
 238 the OpenFlow controller cannot interfere with them and possibly break
 239 connectivity with its switches.  It is possible to see all flows, including
 240 in-band ones, with the ovs-appctl "bridge/dump-flows" command.
 241
 242 The Open vSwitch implementation of in-band control can hide traffic to
 243 arbitrary "remotes", where each remote is one TCP port on one IP address.
 244 Currently the remotes are automatically configured as the in-band OpenFlow
 245 controllers plus the OVSDB managers, if any.  (The latter is a requirement
 246 because OVSDB managers are responsible for configuring OpenFlow controllers,
 247 so if the manager cannot be reached then OpenFlow cannot be reconfigured.)
 248
 249 The following rules (with the OFPP_NORMAL action) are set up on any bridge
 250 that has any remotes:
 251
 252    (a) DHCP requests sent from the local port.
 253    (b) ARP replies to the local port's MAC address.
 254    (c) ARP requests from the local port's MAC address.
 255
 256 In-band also sets up the following rules for each unique next-hop MAC
 257 address for the remotes' IPs (the "next hop" is either the remote
 258 itself, if it is on a local subnet, or the gateway to reach the remote):
 259
 260    (d) ARP replies to the next hop's MAC address.
 261    (e) ARP requests from the next hop's MAC address.
 262
 263 In-band also sets up the following rules for each unique remote IP address:
 264
 265    (f) ARP replies containing the remote's IP address as a target.
 266    (g) ARP requests containing the remote's IP address as a source.
 267
 268 In-band also sets up the following rules for each unique remote (IP,port)
 269 pair:
 270
 271    (h) TCP traffic to the remote's IP and port.
 272    (i) TCP traffic from the remote's IP and port.
 273
 274 The goal of these rules is to be as narrow as possible to allow a
 275 switch to join a network and be able to communicate with the
 276 remotes.  As mentioned earlier, these rules have higher priority
 277 than the controller's rules, so if they are too broad, they may
 278 prevent the controller from implementing its policy.  As such,
 279 in-band actively monitors some aspects of flow and packet processing
 280 so that the rules can be made more precise.
 281
 282 In-band control monitors attempts to add flows into the datapath that
 283 could interfere with its duties.  The datapath only allows exact
 284 match entries, so in-band control is able to be very precise about
 285 the flows it prevents.  Flows that miss in the datapath are sent to
 286 userspace to be processed, so preventing these flows from being
 287 cached in the "fast path" does not affect correctness.  The only type
 288 of flow that is currently prevented is one that would prevent DHCP
 289 replies from being seen by the local port.  For example, a rule that
 290 forwarded all DHCP traffic to the controller would not be allowed,
 291 but one that forwarded to all ports (including the local port) would.
 292
 293 As mentioned earlier, packets that miss in the datapath are sent to
 294 the userspace for processing.  The userspace has its own flow table,
 295 the "classifier", so in-band checks whether any special processing
 296 is needed before the classifier is consulted.  If a packet is a DHCP
 297 response to a request from the local port, the packet is forwarded to
 298 the local port, regardless of the flow table.  Note that this requires
 299 L7 processing of DHCP replies to determine whether the 'chaddr' field
 300 matches the MAC address of the local port.
 301
 302 It is interesting to note that for an L3-based in-band control
 303 mechanism, the majority of rules are devoted to ARP traffic.  At first
 304 glance, some of these rules appear redundant.  However, each serves an
 305 important role.  First, in order to determine the MAC address of the
 306 remote side (controller or gateway) for other ARP rules, we must allow
 307 ARP traffic for our local port with rules (b) and (c).  If we are
 308 between a switch and its connection to the remote, we have to
 309 allow the other switch's ARP traffic to through.  This is done with
 310 rules (d) and (e), since we do not know the addresses of the other
 311 switches a priori, but do know the remote's or gateway's.  Finally,
 312 if the remote is running in a local guest VM that is not reached
 313 through the local port, the switch that is connected to the VM must
 314 allow ARP traffic based on the remote's IP address, since it will
 315 not know the MAC address of the local port that is sending the traffic
 316 or the MAC address of the remote in the guest VM.
 317
 318 With a few notable exceptions below, in-band should work in most
 319 network setups.  The following are considered "supported' in the
 320 current implementation:
 321
 322    - Locally Connected.  The switch and remote are on the same
 323      subnet.  This uses rules (a), (b), (c), (h), and (i).
 324
 325    - Reached through Gateway.  The switch and remote are on
 326      different subnets and must go through a gateway.  This uses
 327      rules (a), (b), (c), (h), and (i).
 328
 329    - Between Switch and Remote.  This switch is between another
 330      switch and the remote, and we want to allow the other
 331      switch's traffic through.  This uses rules (d), (e), (h), and
 332      (i).  It uses (b) and (c) indirectly in order to know the MAC
 333      address for rules (d) and (e).  Note that DHCP for the other
 334      switch will not work unless an OpenFlow controller explicitly lets this
 335      switch pass the traffic.
 336
 337    - Between Switch and Gateway.  This switch is between another
 338      switch and the gateway, and we want to allow the other switch's
 339      traffic through.  This uses the same rules and logic as the
 340      "Between Switch and Remote" configuration described earlier.
 341
 342    - Remote on Local VM.  The remote is a guest VM on the
 343      system running in-band control.  This uses rules (a), (b), (c),
 344      (h), and (i).
 345
 346    - Remote on Local VM with Different Networks.  The remote
 347      is a guest VM on the system running in-band control, but the
 348      local port is not used to connect to the remote.  For
 349      example, an IP address is configured on eth0 of the switch.  The
 350      remote's VM is connected through eth1 of the switch, but an
 351      IP address has not been configured for that port on the switch.
 352      As such, the switch will use eth0 to connect to the remote,
 353      and eth1's rules about the local port will not work.  In the
 354      example, the switch attached to eth0 would use rules (a), (b),
 355      (c), (h), and (i) on eth0.  The switch attached to eth1 would use
 356      rules (f), (g), (h), and (i).
 357
 358 The following are explicitly *not* supported by in-band control:
 359
 360    - Specify Remote by Name.  Currently, the remote must be
 361      identified by IP address.  A naive approach would be to permit
 362      all DNS traffic.  Unfortunately, this would prevent the
 363      controller from defining any policy over DNS.  Since switches
 364      that are located behind us need to connect to the remote,
 365      in-band cannot simply add a rule that allows DNS traffic from
 366      the local port.  The "correct" way to support this is to parse
 367      DNS requests to allow all traffic related to a request for the
 368      remote's name through.  Due to the potential security
 369      problems and amount of processing, we decided to hold off for
 370      the time-being.
 371
 372    - Differing Remotes for Switches.  All switches must know
 373      the L3 addresses for all the remotes that other switches
 374      may use, since rules need to be set up to allow traffic related
 375      to those remotes through.  See rules (f), (g), (h), and (i).
 376
 377    - Differing Routes for Switches.  In order for the switch to
 378      allow other switches to connect to a remote through a
 379      gateway, it allows the gateway's traffic through with rules (d)
 380      and (e).  If the routes to the remote differ for the two
 381      switches, we will not know the MAC address of the alternate
 382      gateway.
 383
 384
 385 Suggestions
 386 ===========
 387
 388 Suggestions to improve Open vSwitch are welcome at discuss@openvswitch.org.