ofproto: Implement OF1.4 Set/Get asynchronous configuration messages.
[cascardo/ovs.git] / DESIGN.md
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 changes its miss_send_len from the service controller
21 default of zero in one of the following ways:
22
23   - Sending an OFPT_SET_CONFIG message with nonzero miss_send_len.
24
25   - Sending any NXT_SET_ASYNC_CONFIG message: as a side effect, this
26     message changes the miss_send_len to
27     OFP_DEFAULT_MISS_SEND_LEN (128) for service controllers.
28
29 Second, OFPT_FLOW_REMOVED and NXT_FLOW_REMOVED messages are generated
30 only if the flow that was removed had the OFPFF_SEND_FLOW_REM flag
31 set.
32
33 Third, OFPT_PACKET_IN and NXT_PACKET_IN messages are sent only to
34 OpenFlow controller connections that have the correct connection ID
35 (see "struct nx_controller_id" and "struct nx_action_controller"):
36
37   - For packet-in messages generated by a NXAST_CONTROLLER action,
38     the controller ID specified in the action.
39
40   - For other packet-in messages, controller ID zero.  (This is the
41     default ID when an OpenFlow controller does not configure one.)
42
43 Finally, Open vSwitch consults a per-connection table indexed by the
44 message type, reason code, and current role.  The following table
45 shows how this table is initialized by default when an OpenFlow
46 connection is made.  An entry labeled "yes" means that the message is
47 sent, an entry labeled "---" means that the message is suppressed.
48
49 ```
50                                              master/
51   message and reason code                     other     slave
52   ----------------------------------------   -------    -----
53   OFPT_PACKET_IN / NXT_PACKET_IN
54     OFPR_NO_MATCH                              yes       ---
55     OFPR_ACTION                                yes       ---
56     OFPR_INVALID_TTL                           ---       ---
57     OFPR_ACTION_SET (OF1.4+)                   yes       ---
58     OFPR_GROUP (OF1.4+)                        yes       ---
59
60   OFPT_FLOW_REMOVED / NXT_FLOW_REMOVED
61     OFPRR_IDLE_TIMEOUT                         yes       ---
62     OFPRR_HARD_TIMEOUT                         yes       ---
63     OFPRR_DELETE                               yes       ---
64     OFPRR_GROUP_DELETE (OF1.4+)                yes       ---
65     OFPRR_METER_DELETE (OF1.4+)                yes       ---
66     OFPRR_EVICTION (OF1.4+)                    yes       ---
67
68   OFPT_PORT_STATUS
69     OFPPR_ADD                                  yes       yes
70     OFPPR_DELETE                               yes       yes
71     OFPPR_MODIFY                               yes       yes
72
73   OFPT_ROLE_REQUEST / OFPT_ROLE_REPLY (OF1.4+)
74     OFPCRR_MASTER_REQUEST                      ---       ---
75     OFPCRR_CONFIG                              ---       ---
76     OFPCRR_EXPERIMENTER                        ---       ---
77
78   OFPT_TABLE_STATUS (OF1.4+)
79     OFPTR_VACANCY_DOWN                         ---       ---
80     OFPTR_VACANCY_UP                           ---       ---
81
82   OFPT_REQUESTFORWARD (OF1.4+)
83     OFPRFR_GROUP_MOD                           ---       ---
84     OFPRFR_METER_MOD                           ---       ---
85 ```
86
87 The NXT_SET_ASYNC_CONFIG message directly sets all of the values in
88 this table for the current connection.  The
89 OFPC_INVALID_TTL_TO_CONTROLLER bit in the OFPT_SET_CONFIG message
90 controls the setting for OFPR_INVALID_TTL for the "master" role.
91
92
93 OFPAT_ENQUEUE
94 =============
95
96 The OpenFlow 1.0 specification requires the output port of the OFPAT_ENQUEUE
97 action to "refer to a valid physical port (i.e. < OFPP_MAX) or OFPP_IN_PORT".
98 Although OFPP_LOCAL is not less than OFPP_MAX, it is an 'internal' port which
99 can have QoS applied to it in Linux.  Since we allow the OFPAT_ENQUEUE to apply
100 to 'internal' ports whose port numbers are less than OFPP_MAX, we interpret
101 OFPP_LOCAL as a physical port and support OFPAT_ENQUEUE on it as well.
102
103
104 OFPT_FLOW_MOD
105 =============
106
107 The OpenFlow specification for the behavior of OFPT_FLOW_MOD is
108 confusing.  The following tables summarize the Open vSwitch
109 implementation of its behavior in the following categories:
110
111   - "match on priority": Whether the flow_mod acts only on flows
112     whose priority matches that included in the flow_mod message.
113
114   - "match on out_port": Whether the flow_mod acts only on flows
115     that output to the out_port included in the flow_mod message (if
116     out_port is not OFPP_NONE).  OpenFlow 1.1 and later have a
117     similar feature (not listed separately here) for out_group.
118
119   - "match on flow_cookie": Whether the flow_mod acts only on flows
120     whose flow_cookie matches an optional controller-specified value
121     and mask.
122
123   - "updates flow_cookie": Whether the flow_mod changes the
124     flow_cookie of the flow or flows that it matches to the
125     flow_cookie included in the flow_mod message.
126
127   - "updates OFPFF_ flags": Whether the flow_mod changes the
128     OFPFF_SEND_FLOW_REM flag of the flow or flows that it matches to
129     the setting included in the flags of the flow_mod message.
130
131   - "honors OFPFF_CHECK_OVERLAP": Whether the OFPFF_CHECK_OVERLAP
132     flag in the flow_mod is significant.
133
134   - "updates idle_timeout" and "updates hard_timeout": Whether the
135     idle_timeout and hard_timeout in the flow_mod, respectively,
136     have an effect on the flow or flows matched by the flow_mod.
137
138   - "updates idle timer": Whether the flow_mod resets the per-flow
139     timer that measures how long a flow has been idle.
140
141   - "updates hard timer": Whether the flow_mod resets the per-flow
142     timer that measures how long it has been since a flow was
143     modified.
144
145   - "zeros counters": Whether the flow_mod resets per-flow packet
146     and byte counters to zero.
147
148   - "may add a new flow": Whether the flow_mod may add a new flow to
149     the flow table.  (Obviously this is always true for "add"
150     commands but in some OpenFlow versions "modify" and
151     "modify-strict" can also add new flows.)
152
153   - "sends flow_removed message": Whether the flow_mod generates a
154     flow_removed message for the flow or flows that it affects.
155
156 An entry labeled "yes" means that the flow mod type does have the
157 indicated behavior, "---" means that it does not, an empty cell means
158 that the property is not applicable, and other values are explained
159 below the table.
160
161 OpenFlow 1.0
162 ------------
163
164 ```
165                                           MODIFY          DELETE
166                              ADD  MODIFY  STRICT  DELETE  STRICT
167                              ===  ======  ======  ======  ======
168 match on priority            yes    ---     yes     ---     yes
169 match on out_port            ---    ---     ---     yes     yes
170 match on flow_cookie         ---    ---     ---     ---     ---
171 match on table_id            ---    ---     ---     ---     ---
172 controller chooses table_id  ---    ---     ---
173 updates flow_cookie          yes    yes     yes
174 updates OFPFF_SEND_FLOW_REM  yes     +       +
175 honors OFPFF_CHECK_OVERLAP   yes     +       +
176 updates idle_timeout         yes     +       +
177 updates hard_timeout         yes     +       +
178 resets idle timer            yes     +       +
179 resets hard timer            yes    yes     yes
180 zeros counters               yes     +       +
181 may add a new flow           yes    yes     yes
182 sends flow_removed message   ---    ---     ---      %       %
183
184 (+) "modify" and "modify-strict" only take these actions when they
185     create a new flow, not when they update an existing flow.
186
187 (%) "delete" and "delete_strict" generates a flow_removed message if
188     the deleted flow or flows have the OFPFF_SEND_FLOW_REM flag set.
189     (Each controller can separately control whether it wants to
190     receive the generated messages.)
191 ```
192
193 OpenFlow 1.1
194 ------------
195
196 OpenFlow 1.1 makes these changes:
197
198   - The controller now must specify the table_id of the flow match
199     searched and into which a flow may be inserted.  Behavior for a
200     table_id of 255 is undefined.
201
202   - A flow_mod, except an "add", can now match on the flow_cookie.
203
204   - When a flow_mod matches on the flow_cookie, "modify" and
205     "modify-strict" never insert a new flow.
206
207 ```
208                                           MODIFY          DELETE
209                              ADD  MODIFY  STRICT  DELETE  STRICT
210                              ===  ======  ======  ======  ======
211 match on priority            yes    ---     yes     ---     yes
212 match on out_port            ---    ---     ---     yes     yes
213 match on flow_cookie         ---    yes     yes     yes     yes
214 match on table_id            yes    yes     yes     yes     yes
215 controller chooses table_id  yes    yes     yes
216 updates flow_cookie          yes    ---     ---
217 updates OFPFF_SEND_FLOW_REM  yes     +       +
218 honors OFPFF_CHECK_OVERLAP   yes     +       +
219 updates idle_timeout         yes     +       +
220 updates hard_timeout         yes     +       +
221 resets idle timer            yes     +       +
222 resets hard timer            yes    yes     yes
223 zeros counters               yes     +       +
224 may add a new flow           yes     #       #
225 sends flow_removed message   ---    ---     ---      %       %
226
227 (+) "modify" and "modify-strict" only take these actions when they
228     create a new flow, not when they update an existing flow.
229
230 (%) "delete" and "delete_strict" generates a flow_removed message if
231     the deleted flow or flows have the OFPFF_SEND_FLOW_REM flag set.
232     (Each controller can separately control whether it wants to
233     receive the generated messages.)
234
235 (#) "modify" and "modify-strict" only add a new flow if the flow_mod
236     does not match on any bits of the flow cookie
237 ```
238
239 OpenFlow 1.2
240 ------------
241
242 OpenFlow 1.2 makes these changes:
243
244   - Only "add" commands ever add flows, "modify" and "modify-strict"
245     never do.
246
247   - A new flag OFPFF_RESET_COUNTS now controls whether "modify" and
248     "modify-strict" reset counters, whereas previously they never
249     reset counters (except when they inserted a new flow).
250
251 ```
252                                           MODIFY          DELETE
253                              ADD  MODIFY  STRICT  DELETE  STRICT
254                              ===  ======  ======  ======  ======
255 match on priority            yes    ---     yes     ---     yes
256 match on out_port            ---    ---     ---     yes     yes
257 match on flow_cookie         ---    yes     yes     yes     yes
258 match on table_id            yes    yes     yes     yes     yes
259 controller chooses table_id  yes    yes     yes
260 updates flow_cookie          yes    ---     ---
261 updates OFPFF_SEND_FLOW_REM  yes    ---     ---
262 honors OFPFF_CHECK_OVERLAP   yes    ---     ---
263 updates idle_timeout         yes    ---     ---
264 updates hard_timeout         yes    ---     ---
265 resets idle timer            yes    ---     ---
266 resets hard timer            yes    yes     yes
267 zeros counters               yes     &       &
268 may add a new flow           yes    ---     ---
269 sends flow_removed message   ---    ---     ---      %       %
270
271 (%) "delete" and "delete_strict" generates a flow_removed message if
272     the deleted flow or flows have the OFPFF_SEND_FLOW_REM flag set.
273     (Each controller can separately control whether it wants to
274     receive the generated messages.)
275
276 (&) "modify" and "modify-strict" reset counters if the
277     OFPFF_RESET_COUNTS flag is specified.
278 ```
279
280 OpenFlow 1.3
281 ------------
282
283 OpenFlow 1.3 makes these changes:
284
285   - Behavior for a table_id of 255 is now defined, for "delete" and
286     "delete-strict" commands, as meaning to delete from all tables.
287     A table_id of 255 is now explicitly invalid for other commands.
288
289   - New flags OFPFF_NO_PKT_COUNTS and OFPFF_NO_BYT_COUNTS for "add"
290     operations.
291
292 The table for 1.3 is the same as the one shown above for 1.2.
293
294
295 OpenFlow 1.4
296 -----------
297
298 OpenFlow 1.4 makes these changes:
299
300   - Adds the "importance" field to flow_mods, but it does not
301     explicitly specify which kinds of flow_mods set the importance.
302     For consistency, Open vSwitch uses the same rule for importance
303     as for idle_timeout and hard_timeout, that is, only an "ADD"
304     flow_mod sets the importance.  (This issue has been filed with
305     the ONF as EXT-496.)
306
307   - Eviction Mechanism to automatically delete entries of lower
308     importance to make space for newer entries.
309
310
311 OpenFlow 1.4 Bundles
312 ====================
313
314 Open vSwitch makes all flow table modifications atomically, i.e., any
315 datapath packet only sees flow table configurations either before or
316 after any change made by any flow_mod.  For example, if a controller
317 removes all flows with a single OpenFlow "flow_mod", no packet sees an
318 intermediate version of the OpenFlow pipeline where only some of the
319 flows have been deleted.
320
321 It should be noted that Open vSwitch caches datapath flows, and that
322 the cached flows are NOT flushed immediately when a flow table
323 changes.  Instead, the datapath flows are revalidated against the new
324 flow table as soon as possible, and usually within one second of the
325 modification.  This design amortizes the cost of datapath cache
326 flushing across multiple flow table changes, and has a significant
327 performance effect during simultaneous heavy flow table churn and high
328 traffic load.  This means that different cached datapath flows may
329 have been computed based on a different flow table configurations, but
330 each of the datapath flows is guaranteed to have been computed over a
331 coherent view of the flow tables, as described above.
332
333 With OpenFlow 1.4 bundles this atomicity can be extended across an
334 arbitrary set of flow_mods.  Bundles are supported for flow_mod and
335 port_mod messages only.  For flow_mods, both 'atomic' and 'ordered'
336 bundle flags are trivially supported, as all bundled messages are
337 executed in the order they were added and all flow table modifications
338 are now atomic to the datapath.  Port mods may not appear in atomic
339 bundles, as port status modifications are not atomic.
340
341 To support bundles, ovs-ofctl has a '--bundle' option that makes the
342 flow mod commands ('add-flow', 'add-flows', 'mod-flows', 'del-flows',
343 and 'replace-flows') use an OpenFlow 1.4 bundle to operate the
344 modifications as a single atomic transaction.  If any of the flow mods
345 in a transaction fail, none of them are executed.  All flow mods in a
346 bundle appear to datapath lookups simultaneously.
347
348 Furthermore, ovs-ofctl 'add-flow' and 'add-flows' commands now accept
349 arbitrary flow mods as an input by allowing the flow specification to
350 start with an explicit 'add', 'modify', 'modify_strict', 'delete', or
351 'delete_strict' keyword.  A missing keyword is treated as 'add', so
352 this is fully backwards compatible.  With the new '--bundle' option
353 all the flow mods are executed as a single atomic transaction using an
354 OpenFlow 1.4 bundle.  Without the '--bundle' option the flow mods are
355 executed in order up to the first failing flow_mod, and in case of an
356 error the earlier successful flow_mods are not rolled back.
357
358
359 OFPT_PACKET_IN
360 ==============
361
362 The OpenFlow 1.1 specification for OFPT_PACKET_IN is confusing.  The
363 definition in OF1.1 openflow.h is[*]:
364
365 ```
366   /* Packet received on port (datapath -> controller). */
367   struct ofp_packet_in {
368       struct ofp_header header;
369       uint32_t buffer_id;     /* ID assigned by datapath. */
370       uint32_t in_port;       /* Port on which frame was received. */
371       uint32_t in_phy_port;   /* Physical Port on which frame was received. */
372       uint16_t total_len;     /* Full length of frame. */
373       uint8_t reason;         /* Reason packet is being sent (one of OFPR_*) */
374       uint8_t table_id;       /* ID of the table that was looked up */
375       uint8_t data[0];        /* Ethernet frame, halfway through 32-bit word,
376                                  so the IP header is 32-bit aligned.  The
377                                  amount of data is inferred from the length
378                                  field in the header.  Because of padding,
379                                  offsetof(struct ofp_packet_in, data) ==
380                                  sizeof(struct ofp_packet_in) - 2. */
381   };
382   OFP_ASSERT(sizeof(struct ofp_packet_in) == 24);
383 ```
384
385 The confusing part is the comment on the data[] member.  This comment
386 is a leftover from OF1.0 openflow.h, in which the comment was correct:
387 sizeof(struct ofp_packet_in) is 20 in OF1.0 and offsetof(struct
388 ofp_packet_in, data) is 18.  When OF1.1 was written, the structure
389 members were changed but the comment was carelessly not updated, and
390 the comment became wrong: sizeof(struct ofp_packet_in) and
391 offsetof(struct ofp_packet_in, data) are both 24 in OF1.1.
392
393 That leaves the question of how to implement ofp_packet_in in OF1.1.
394 The OpenFlow reference implementation for OF1.1 does not include any
395 padding, that is, the first byte of the encapsulated frame immediately
396 follows the 'table_id' member without a gap.  Open vSwitch therefore
397 implements it the same way for compatibility.
398
399 For an earlier discussion, please see the thread archived at:
400 https://mailman.stanford.edu/pipermail/openflow-discuss/2011-August/002604.html
401
402 [*] The quoted definition is directly from OF1.1.  Definitions used
403     inside OVS omit the 8-byte ofp_header members, so the sizes in
404     this discussion are 8 bytes larger than those declared in OVS
405     header files.
406
407
408 VLAN Matching
409 =============
410
411 The 802.1Q VLAN header causes more trouble than any other 4 bytes in
412 networking.  More specifically, three versions of OpenFlow and Open
413 vSwitch have among them four different ways to match the contents and
414 presence of the VLAN header.  The following table describes how each
415 version works.
416
417        Match        NXM        OF1.0        OF1.1         OF1.2
418        -----  ---------  -----------  -----------  ------------
419          [1]  0000/0000  ????/1,??/?  ????/1,??/?  0000/0000,--
420          [2]  0000/ffff  ffff/0,??/?  ffff/0,??/?  0000/ffff,--
421          [3]  1xxx/1fff  0xxx/0,??/1  0xxx/0,??/1  1xxx/ffff,--
422          [4]  z000/f000  ????/1,0y/0  fffe/0,0y/0  1000/1000,0y
423          [5]  zxxx/ffff  0xxx/0,0y/0  0xxx/0,0y/0  1xxx/ffff,0y
424          [6]  0000/0fff    <none>       <none>        <none>
425          [7]  0000/f000    <none>       <none>        <none>
426          [8]  0000/efff    <none>       <none>        <none>
427          [9]  1001/1001    <none>       <none>     1001/1001,--
428         [10]  3000/3000    <none>       <none>        <none>
429
430 Each column is interpreted as follows.
431
432   - Match: See the list below.
433
434   - NXM: xxxx/yyyy means NXM_OF_VLAN_TCI_W with value xxxx and mask
435     yyyy.  A mask of 0000 is equivalent to omitting
436     NXM_OF_VLAN_TCI(_W), a mask of ffff is equivalent to
437     NXM_OF_VLAN_TCI.
438
439   - OF1.0 and OF1.1: wwww/x,yy/z means dl_vlan wwww, OFPFW_DL_VLAN
440     x, dl_vlan_pcp yy, and OFPFW_DL_VLAN_PCP z.  ? means that the
441     given nibble is ignored (and conventionally 0 for wwww or yy,
442     conventionally 1 for x or z).  <none> means that the given match
443     is not supported.
444
445   - OF1.2: xxxx/yyyy,zz means OXM_OF_VLAN_VID_W with value xxxx and
446     mask yyyy, and OXM_OF_VLAN_PCP (which is not maskable) with
447     value zz.  A mask of 0000 is equivalent to omitting
448     OXM_OF_VLAN_VID(_W), a mask of ffff is equivalent to
449     OXM_OF_VLAN_VID.  -- means that OXM_OF_VLAN_PCP is omitted.
450     <none> means that the given match is not supported.
451
452 The matches are:
453
454  [1] Matches any packet, that is, one without an 802.1Q header or with
455      an 802.1Q header with any TCI value.
456
457  [2] Matches only packets without an 802.1Q header.
458
459      NXM: Any match with (vlan_tci == 0) and (vlan_tci_mask & 0x1000)
460      != 0 is equivalent to the one listed in the table.
461
462      OF1.0: The spec doesn't define behavior if dl_vlan is set to
463      0xffff and OFPFW_DL_VLAN_PCP is not set.
464
465      OF1.1: The spec says explicitly to ignore dl_vlan_pcp when
466      dl_vlan is set to 0xffff.
467
468      OF1.2: The spec doesn't say what should happen if (vlan_vid == 0)
469      and (vlan_vid_mask & 0x1000) != 0 but (vlan_vid_mask != 0x1000),
470      but it would be straightforward to also interpret as [2].
471
472  [3] Matches only packets that have an 802.1Q header with VID xxx (and
473      any PCP).
474
475  [4] Matches only packets that have an 802.1Q header with PCP y (and
476      any VID).
477
478      NXM: z is ((y << 1) | 1).
479
480      OF1.0: The spec isn't very clear, but OVS implements it this way.
481
482      OF1.2: Presumably other masks such that (vlan_vid_mask & 0x1fff)
483      == 0x1000 would also work, but the spec doesn't define their
484      behavior.
485
486  [5] Matches only packets that have an 802.1Q header with VID xxx and
487      PCP y.
488
489      NXM: z is ((y << 1) | 1).
490
491      OF1.2: Presumably other masks such that (vlan_vid_mask & 0x1fff)
492      == 0x1fff would also work.
493
494  [6] Matches packets with no 802.1Q header or with an 802.1Q header
495      with a VID of 0.  Only possible with NXM.
496
497  [7] Matches packets with no 802.1Q header or with an 802.1Q header
498      with a PCP of 0.  Only possible with NXM.
499
500  [8] Matches packets with no 802.1Q header or with an 802.1Q header
501      with both VID and PCP of 0.  Only possible with NXM.
502
503  [9] Matches only packets that have an 802.1Q header with an
504      odd-numbered VID (and any PCP).  Only possible with NXM and
505      OF1.2.  (This is just an example; one can match on any desired
506      VID bit pattern.)
507
508 [10] Matches only packets that have an 802.1Q header with an
509      odd-numbered PCP (and any VID).  Only possible with NXM.  (This
510      is just an example; one can match on any desired VID bit
511      pattern.)
512
513 Additional notes:
514
515   - OF1.2: The top three bits of OXM_OF_VLAN_VID are fixed to zero,
516     so bits 13, 14, and 15 in the masks listed in the table may be
517     set to arbitrary values, as long as the corresponding value bits
518     are also zero.  The suggested ffff mask for [2], [3], and [5]
519     allows a shorter OXM representation (the mask is omitted) than
520     the minimal 1fff mask.
521
522
523 Flow Cookies
524 ============
525
526 OpenFlow 1.0 and later versions have the concept of a "flow cookie",
527 which is a 64-bit integer value attached to each flow.  The treatment
528 of the flow cookie has varied greatly across OpenFlow versions,
529 however.
530
531 In OpenFlow 1.0:
532
533   - OFPFC_ADD set the cookie in the flow that it added.
534
535   - OFPFC_MODIFY and OFPFC_MODIFY_STRICT updated the cookie for
536     the flow or flows that it modified.
537
538   - OFPST_FLOW messages included the flow cookie.
539
540   - OFPT_FLOW_REMOVED messages reported the cookie of the flow
541     that was removed.
542
543 OpenFlow 1.1 made the following changes:
544
545   - Flow mod operations OFPFC_MODIFY, OFPFC_MODIFY_STRICT,
546     OFPFC_DELETE, and OFPFC_DELETE_STRICT, plus flow stats
547     requests and aggregate stats requests, gained the ability to
548     match on flow cookies with an arbitrary mask.
549
550   - OFPFC_MODIFY and OFPFC_MODIFY_STRICT were changed to add a
551     new flow, in the case of no match, only if the flow table
552     modification operation did not match on the cookie field.
553     (In OpenFlow 1.0, modify operations always added a new flow
554     when there was no match.)
555
556   - OFPFC_MODIFY and OFPFC_MODIFY_STRICT no longer updated flow
557     cookies.
558
559 OpenFlow 1.2 made the following changes:
560
561   - OFPC_MODIFY and OFPFC_MODIFY_STRICT were changed to never
562     add a new flow, regardless of whether the flow cookie was
563     used for matching.
564
565 Open vSwitch support for OpenFlow 1.0 implements the OpenFlow 1.0
566 behavior with the following extensions:
567
568   - An NXM extension field NXM_NX_COOKIE(_W) allows the NXM
569     versions of OFPFC_MODIFY, OFPFC_MODIFY_STRICT, OFPFC_DELETE,
570     and OFPFC_DELETE_STRICT flow_mods, plus flow stats requests
571     and aggregate stats requests, to match on flow cookies with
572     arbitrary masks.  This is much like the equivalent OpenFlow
573     1.1 feature.
574
575   - Like OpenFlow 1.1, OFPC_MODIFY and OFPFC_MODIFY_STRICT add a
576     new flow if there is no match and the mask is zero (or not
577     given).
578
579   - The "cookie" field in OFPT_FLOW_MOD and NXT_FLOW_MOD messages
580     is used as the cookie value for OFPFC_ADD commands, as
581     described in OpenFlow 1.0.  For OFPFC_MODIFY and
582     OFPFC_MODIFY_STRICT commands, the "cookie" field is used as a
583     new cookie for flows that match unless it is UINT64_MAX, in
584     which case the flow's cookie is not updated.
585
586   - NXT_PACKET_IN (the Nicira extended version of
587     OFPT_PACKET_IN) reports the cookie of the rule that
588     generated the packet, or all-1-bits if no rule generated the
589     packet.  (Older versions of OVS used all-0-bits instead of
590     all-1-bits.)
591
592 The following table shows the handling of different protocols when
593 receiving OFPFC_MODIFY and OFPFC_MODIFY_STRICT messages.  A mask of 0
594 indicates either an explicit mask of zero or an implicit one by not
595 specifying the NXM_NX_COOKIE(_W) field.
596
597 ```
598                 Match   Update   Add on miss   Add on miss
599                 cookie  cookie     mask!=0       mask==0
600                 ======  ======   ===========   ===========
601 OpenFlow 1.0      no     yes        <always add on miss>
602 OpenFlow 1.1     yes      no          no           yes
603 OpenFlow 1.2     yes      no          no            no
604 NXM              yes     yes*         no           yes
605
606 * Updates the flow's cookie unless the "cookie" field is UINT64_MAX.
607 ```
608
609 Multiple Table Support
610 ======================
611
612 OpenFlow 1.0 has only rudimentary support for multiple flow tables.
613 Notably, OpenFlow 1.0 does not allow the controller to specify the
614 flow table to which a flow is to be added.  Open vSwitch adds an
615 extension for this purpose, which is enabled on a per-OpenFlow
616 connection basis using the NXT_FLOW_MOD_TABLE_ID message.  When the
617 extension is enabled, the upper 8 bits of the 'command' member in an
618 OFPT_FLOW_MOD or NXT_FLOW_MOD message designates the table to which a
619 flow is to be added.
620
621 The Open vSwitch software switch implementation offers 255 flow
622 tables.  On packet ingress, only the first flow table (table 0) is
623 searched, and the contents of the remaining tables are not considered
624 in any way.  Tables other than table 0 only come into play when an
625 NXAST_RESUBMIT_TABLE action specifies another table to search.
626
627 Tables 128 and above are reserved for use by the switch itself.
628 Controllers should use only tables 0 through 127.
629
630
631 OFPTC_* Table Configuration
632 ===========================
633
634 This section covers the history of the OFPTC_* table configuration
635 bits across OpenFlow versions.
636
637 OpenFlow 1.0 flow tables had fixed configurations.
638
639 OpenFlow 1.1 enabled controllers to configure behavior upon flow table
640 miss and added the OFPTC_MISS_* constants for that purpose.  OFPTC_*
641 did not control anything else but it was nevertheless conceptualized
642 as a set of bit-fields instead of an enum.  OF1.1 added the
643 OFPT_TABLE_MOD message to set OFPTC_MISS_* for a flow table and added
644 the 'config' field to the OFPST_TABLE reply to report the current
645 setting.
646
647 OpenFlow 1.2 did not change anything in this regard.
648
649 OpenFlow 1.3 switched to another means to changing flow table miss
650 behavior and deprecated OFPTC_MISS_* without adding any more OFPTC_*
651 constants.  This meant that OFPT_TABLE_MOD now had no purpose at all,
652 but OF1.3 kept it around "for backward compatibility with older and
653 newer versions of the specification."  At the same time, OF1.3
654 introduced a new message OFPMP_TABLE_FEATURES that included a field
655 'config' documented as reporting the OFPTC_* values set with
656 OFPT_TABLE_MOD; of course this served no real purpose because no
657 OFPTC_* values are defined.  OF1.3 did remove the OFPTC_* field from
658 OFPMP_TABLE (previously named OFPST_TABLE).
659
660 OpenFlow 1.4 defined two new OFPTC_* constants, OFPTC_EVICTION and
661 OFPTC_VACANCY_EVENTS, using bits that did not overlap with
662 OFPTC_MISS_* even though those bits had not been defined since OF1.2.
663 OFPT_TABLE_MOD still controlled these settings.  The field for OFPTC_*
664 values in OFPMP_TABLE_FEATURES was renamed from 'config' to
665 'capabilities' and documented as reporting the flags that are
666 supported in a OFPT_TABLE_MOD message.  The OFPMP_TABLE_DESC message
667 newly added in OF1.4 reported the OFPTC_* setting.
668
669 OpenFlow 1.5 did not change anything in this regard.
670
671 The following table summarizes.  The columns say:
672
673   - OpenFlow version(s).
674
675   - The OFPTC_* flags defined in those versions.
676
677   - Whether OFPT_TABLE_MOD can modify OFPTC_* flags.
678
679   - Whether OFPST_TABLE/OFPMP_TABLE reports the OFPTC_* flags.
680
681   - What OFPMP_TABLE_FEATURES reports (if it exists): either the
682     current configuration or the switch's capabilities.
683
684   - Whether OFPMP_TABLE_DESC reports the current configuration.
685
686 OpenFlow   OFPTC_* flags            TABLE_MOD stats? TABLE_FEATURES TABLE_DESC
687 ---------  -----------------------  --------- ------ -------------- ----------
688 OF1.0      none                     no[*][+]  no[*]  nothing[*][+]  no[*][+]
689 OF1.1/1.2  MISS_*                   yes       yes    nothing[+]     no[+]
690 OF1.3      none                     yes[*]    no[*]  config[*]      no[*][+]
691 OF1.4/1.5  EVICTION/VACANCY_EVENTS  yes       no     capabilities   yes
692
693    [*] Nothing to report/change anyway.
694
695    [+] No such message.
696
697
698 IPv6
699 ====
700
701 Open vSwitch supports stateless handling of IPv6 packets.  Flows can be
702 written to support matching TCP, UDP, and ICMPv6 headers within an IPv6
703 packet.  Deeper matching of some Neighbor Discovery messages is also
704 supported.
705
706 IPv6 was not designed to interact well with middle-boxes.  This,
707 combined with Open vSwitch's stateless nature, have affected the
708 processing of IPv6 traffic, which is detailed below.
709
710 Extension Headers
711 -----------------
712
713 The base IPv6 header is incredibly simple with the intention of only
714 containing information relevant for routing packets between two
715 endpoints.  IPv6 relies heavily on the use of extension headers to
716 provide any other functionality.  Unfortunately, the extension headers
717 were designed in such a way that it is impossible to move to the next
718 header (including the layer-4 payload) unless the current header is
719 understood.
720
721 Open vSwitch will process the following extension headers and continue
722 to the next header:
723
724   * Fragment (see the next section)
725   * AH (Authentication Header)
726   * Hop-by-Hop Options
727   * Routing
728   * Destination Options
729
730 When a header is encountered that is not in that list, it is considered
731 "terminal".  A terminal header's IPv6 protocol value is stored in
732 "nw_proto" for matching purposes.  If a terminal header is TCP, UDP, or
733 ICMPv6, the packet will be further processed in an attempt to extract
734 layer-4 information.
735
736 Fragments
737 ---------
738
739 IPv6 requires that every link in the internet have an MTU of 1280 octets
740 or greater (RFC 2460).  As such, a terminal header (as described above in
741 "Extension Headers") in the first fragment should generally be
742 reachable.  In this case, the terminal header's IPv6 protocol type is
743 stored in the "nw_proto" field for matching purposes.  If a terminal
744 header cannot be found in the first fragment (one with a fragment offset
745 of zero), the "nw_proto" field is set to 0.  Subsequent fragments (those
746 with a non-zero fragment offset) have the "nw_proto" field set to the
747 IPv6 protocol type for fragments (44).
748
749 Jumbograms
750 ----------
751
752 An IPv6 jumbogram (RFC 2675) is a packet containing a payload longer
753 than 65,535 octets.  A jumbogram is only relevant in subnets with a link
754 MTU greater than 65,575 octets, and are not required to be supported on
755 nodes that do not connect to link with such large MTUs.  Currently, Open
756 vSwitch doesn't process jumbograms.
757
758
759 In-Band Control
760 ===============
761
762 Motivation
763 ----------
764
765 An OpenFlow switch must establish and maintain a TCP network
766 connection to its controller.  There are two basic ways to categorize
767 the network that this connection traverses: either it is completely
768 separate from the one that the switch is otherwise controlling, or its
769 path may overlap the network that the switch controls.  We call the
770 former case "out-of-band control", the latter case "in-band control".
771
772 Out-of-band control has the following benefits:
773
774   - Simplicity: Out-of-band control slightly simplifies the switch
775     implementation.
776
777   - Reliability: Excessive switch traffic volume cannot interfere
778     with control traffic.
779
780   - Integrity: Machines not on the control network cannot
781     impersonate a switch or a controller.
782
783   - Confidentiality: Machines not on the control network cannot
784     snoop on control traffic.
785
786 In-band control, on the other hand, has the following advantages:
787
788   - No dedicated port: There is no need to dedicate a physical
789     switch port to control, which is important on switches that have
790     few ports (e.g. wireless routers, low-end embedded platforms).
791
792   - No dedicated network: There is no need to build and maintain a
793     separate control network.  This is important in many
794     environments because it reduces proliferation of switches and
795     wiring.
796
797 Open vSwitch supports both out-of-band and in-band control.  This
798 section describes the principles behind in-band control.  See the
799 description of the Controller table in ovs-vswitchd.conf.db(5) to
800 configure OVS for in-band control.
801
802 Principles
803 ----------
804
805 The fundamental principle of in-band control is that an OpenFlow
806 switch must recognize and switch control traffic without involving the
807 OpenFlow controller.  All the details of implementing in-band control
808 are special cases of this principle.
809
810 The rationale for this principle is simple.  If the switch does not
811 handle in-band control traffic itself, then it will be caught in a
812 contradiction: it must contact the controller, but it cannot, because
813 only the controller can set up the flows that are needed to contact
814 the controller.
815
816 The following points describe important special cases of this
817 principle.
818
819  - In-band control must be implemented regardless of whether the
820    switch is connected.
821
822    It is tempting to implement the in-band control rules only when
823    the switch is not connected to the controller, using the
824    reasoning that the controller should have complete control once
825    it has established a connection with the switch.
826
827    This does not work in practice.  Consider the case where the
828    switch is connected to the controller.  Occasionally it can
829    happen that the controller forgets or otherwise needs to obtain
830    the MAC address of the switch.  To do so, the controller sends a
831    broadcast ARP request.  A switch that implements the in-band
832    control rules only when it is disconnected will then send an
833    OFPT_PACKET_IN message up to the controller.  The controller will
834    be unable to respond, because it does not know the MAC address of
835    the switch.  This is a deadlock situation that can only be
836    resolved by the switch noticing that its connection to the
837    controller has hung and reconnecting.
838
839  - In-band control must override flows set up by the controller.
840
841    It is reasonable to assume that flows set up by the OpenFlow
842    controller should take precedence over in-band control, on the
843    basis that the controller should be in charge of the switch.
844
845    Again, this does not work in practice.  Reasonable controller
846    implementations may set up a "last resort" fallback rule that
847    wildcards every field and, e.g., sends it up to the controller or
848    discards it.  If a controller does that, then it will isolate
849    itself from the switch.
850
851  - The switch must recognize all control traffic.
852
853    The fundamental principle of in-band control states, in part,
854    that a switch must recognize control traffic without involving
855    the OpenFlow controller.  More specifically, the switch must
856    recognize *all* control traffic.  "False negatives", that is,
857    packets that constitute control traffic but that the switch does
858    not recognize as control traffic, lead to control traffic storms.
859
860    Consider an OpenFlow switch that only recognizes control packets
861    sent to or from that switch.  Now suppose that two switches of
862    this type, named A and B, are connected to ports on an Ethernet
863    hub (not a switch) and that an OpenFlow controller is connected
864    to a third hub port.  In this setup, control traffic sent by
865    switch A will be seen by switch B, which will send it to the
866    controller as part of an OFPT_PACKET_IN message.  Switch A will
867    then see the OFPT_PACKET_IN message's packet, re-encapsulate it
868    in another OFPT_PACKET_IN, and send it to the controller.  Switch
869    B will then see that OFPT_PACKET_IN, and so on in an infinite
870    loop.
871
872    Incidentally, the consequences of "false positives", where
873    packets that are not control traffic are nevertheless recognized
874    as control traffic, are much less severe.  The controller will
875    not be able to control their behavior, but the network will
876    remain in working order.  False positives do constitute a
877    security problem.
878
879  - The switch should use echo-requests to detect disconnection.
880
881    TCP will notice that a connection has hung, but this can take a
882    considerable amount of time.  For example, with default settings
883    the Linux kernel TCP implementation will retransmit for between
884    13 and 30 minutes, depending on the connection's retransmission
885    timeout, according to kernel documentation.  This is far too long
886    for a switch to be disconnected, so an OpenFlow switch should
887    implement its own connection timeout.  OpenFlow OFPT_ECHO_REQUEST
888    messages are the best way to do this, since they test the
889    OpenFlow connection itself.
890
891 Implementation
892 --------------
893
894 This section describes how Open vSwitch implements in-band control.
895 Correctly implementing in-band control has proven difficult due to its
896 many subtleties, and has thus gone through many iterations.  Please
897 read through and understand the reasoning behind the chosen rules
898 before making modifications.
899
900 Open vSwitch implements in-band control as "hidden" flows, that is,
901 flows that are not visible through OpenFlow, and at a higher priority
902 than wildcarded flows can be set up through OpenFlow.  This is done so
903 that the OpenFlow controller cannot interfere with them and possibly
904 break connectivity with its switches.  It is possible to see all
905 flows, including in-band ones, with the ovs-appctl "bridge/dump-flows"
906 command.
907
908 The Open vSwitch implementation of in-band control can hide traffic to
909 arbitrary "remotes", where each remote is one TCP port on one IP address.
910 Currently the remotes are automatically configured as the in-band OpenFlow
911 controllers plus the OVSDB managers, if any.  (The latter is a requirement
912 because OVSDB managers are responsible for configuring OpenFlow controllers,
913 so if the manager cannot be reached then OpenFlow cannot be reconfigured.)
914
915 The following rules (with the OFPP_NORMAL action) are set up on any bridge
916 that has any remotes:
917
918    (a) DHCP requests sent from the local port.
919    (b) ARP replies to the local port's MAC address.
920    (c) ARP requests from the local port's MAC address.
921
922 In-band also sets up the following rules for each unique next-hop MAC
923 address for the remotes' IPs (the "next hop" is either the remote
924 itself, if it is on a local subnet, or the gateway to reach the remote):
925
926    (d) ARP replies to the next hop's MAC address.
927    (e) ARP requests from the next hop's MAC address.
928
929 In-band also sets up the following rules for each unique remote IP address:
930
931    (f) ARP replies containing the remote's IP address as a target.
932    (g) ARP requests containing the remote's IP address as a source.
933
934 In-band also sets up the following rules for each unique remote (IP,port)
935 pair:
936
937    (h) TCP traffic to the remote's IP and port.
938    (i) TCP traffic from the remote's IP and port.
939
940 The goal of these rules is to be as narrow as possible to allow a
941 switch to join a network and be able to communicate with the
942 remotes.  As mentioned earlier, these rules have higher priority
943 than the controller's rules, so if they are too broad, they may
944 prevent the controller from implementing its policy.  As such,
945 in-band actively monitors some aspects of flow and packet processing
946 so that the rules can be made more precise.
947
948 In-band control monitors attempts to add flows into the datapath that
949 could interfere with its duties.  The datapath only allows exact
950 match entries, so in-band control is able to be very precise about
951 the flows it prevents.  Flows that miss in the datapath are sent to
952 userspace to be processed, so preventing these flows from being
953 cached in the "fast path" does not affect correctness.  The only type
954 of flow that is currently prevented is one that would prevent DHCP
955 replies from being seen by the local port.  For example, a rule that
956 forwarded all DHCP traffic to the controller would not be allowed,
957 but one that forwarded to all ports (including the local port) would.
958
959 As mentioned earlier, packets that miss in the datapath are sent to
960 the userspace for processing.  The userspace has its own flow table,
961 the "classifier", so in-band checks whether any special processing
962 is needed before the classifier is consulted.  If a packet is a DHCP
963 response to a request from the local port, the packet is forwarded to
964 the local port, regardless of the flow table.  Note that this requires
965 L7 processing of DHCP replies to determine whether the 'chaddr' field
966 matches the MAC address of the local port.
967
968 It is interesting to note that for an L3-based in-band control
969 mechanism, the majority of rules are devoted to ARP traffic.  At first
970 glance, some of these rules appear redundant.  However, each serves an
971 important role.  First, in order to determine the MAC address of the
972 remote side (controller or gateway) for other ARP rules, we must allow
973 ARP traffic for our local port with rules (b) and (c).  If we are
974 between a switch and its connection to the remote, we have to
975 allow the other switch's ARP traffic to through.  This is done with
976 rules (d) and (e), since we do not know the addresses of the other
977 switches a priori, but do know the remote's or gateway's.  Finally,
978 if the remote is running in a local guest VM that is not reached
979 through the local port, the switch that is connected to the VM must
980 allow ARP traffic based on the remote's IP address, since it will
981 not know the MAC address of the local port that is sending the traffic
982 or the MAC address of the remote in the guest VM.
983
984 With a few notable exceptions below, in-band should work in most
985 network setups.  The following are considered "supported" in the
986 current implementation:
987
988  - Locally Connected.  The switch and remote are on the same
989    subnet.  This uses rules (a), (b), (c), (h), and (i).
990
991  - Reached through Gateway.  The switch and remote are on
992    different subnets and must go through a gateway.  This uses
993    rules (a), (b), (c), (h), and (i).
994
995  - Between Switch and Remote.  This switch is between another
996    switch and the remote, and we want to allow the other
997    switch's traffic through.  This uses rules (d), (e), (h), and
998    (i).  It uses (b) and (c) indirectly in order to know the MAC
999    address for rules (d) and (e).  Note that DHCP for the other
1000    switch will not work unless an OpenFlow controller explicitly lets this
1001    switch pass the traffic.
1002
1003  - Between Switch and Gateway.  This switch is between another
1004    switch and the gateway, and we want to allow the other switch's
1005    traffic through.  This uses the same rules and logic as the
1006    "Between Switch and Remote" configuration described earlier.
1007
1008  - Remote on Local VM.  The remote is a guest VM on the
1009    system running in-band control.  This uses rules (a), (b), (c),
1010    (h), and (i).
1011
1012  - Remote on Local VM with Different Networks.  The remote
1013    is a guest VM on the system running in-band control, but the
1014    local port is not used to connect to the remote.  For
1015    example, an IP address is configured on eth0 of the switch.  The
1016    remote's VM is connected through eth1 of the switch, but an
1017    IP address has not been configured for that port on the switch.
1018    As such, the switch will use eth0 to connect to the remote,
1019    and eth1's rules about the local port will not work.  In the
1020    example, the switch attached to eth0 would use rules (a), (b),
1021    (c), (h), and (i) on eth0.  The switch attached to eth1 would use
1022    rules (f), (g), (h), and (i).
1023
1024 The following are explicitly *not* supported by in-band control:
1025
1026  - Specify Remote by Name.  Currently, the remote must be
1027    identified by IP address.  A naive approach would be to permit
1028    all DNS traffic.  Unfortunately, this would prevent the
1029    controller from defining any policy over DNS.  Since switches
1030    that are located behind us need to connect to the remote,
1031    in-band cannot simply add a rule that allows DNS traffic from
1032    the local port.  The "correct" way to support this is to parse
1033    DNS requests to allow all traffic related to a request for the
1034    remote's name through.  Due to the potential security
1035    problems and amount of processing, we decided to hold off for
1036    the time-being.
1037
1038  - Differing Remotes for Switches.  All switches must know
1039    the L3 addresses for all the remotes that other switches
1040    may use, since rules need to be set up to allow traffic related
1041    to those remotes through.  See rules (f), (g), (h), and (i).
1042
1043  - Differing Routes for Switches.  In order for the switch to
1044    allow other switches to connect to a remote through a
1045    gateway, it allows the gateway's traffic through with rules (d)
1046    and (e).  If the routes to the remote differ for the two
1047    switches, we will not know the MAC address of the alternate
1048    gateway.
1049
1050
1051 Action Reproduction
1052 ===================
1053
1054 It seems likely that many controllers, at least at startup, use the
1055 OpenFlow "flow statistics" request to obtain existing flows, then
1056 compare the flows' actions against the actions that they expect to
1057 find.  Before version 1.8.0, Open vSwitch always returned exact,
1058 byte-for-byte copies of the actions that had been added to the flow
1059 table.  The current version of Open vSwitch does not always do this in
1060 some exceptional cases.  This section lists the exceptions that
1061 controller authors must keep in mind if they compare actual actions
1062 against desired actions in a bytewise fashion:
1063
1064   - Open vSwitch zeros padding bytes in action structures,
1065     regardless of their values when the flows were added.
1066
1067   - Open vSwitch "normalizes" the instructions in OpenFlow 1.1
1068     (and later) in the following way:
1069
1070     * OVS sorts the instructions into the following order:
1071       Apply-Actions, Clear-Actions, Write-Actions,
1072       Write-Metadata, Goto-Table.
1073
1074     * OVS drops Apply-Actions instructions that have empty
1075       action lists.
1076
1077     * OVS drops Write-Actions instructions that have empty
1078       action sets.
1079
1080 Please report other discrepancies, if you notice any, so that we can
1081 fix or document them.
1082
1083
1084 Suggestions
1085 ===========
1086
1087 Suggestions to improve Open vSwitch are welcome at discuss@openvswitch.org.