man-pages: Add missing entry for matching metadata
[sliver-openvswitch.git] / include / openflow / nicira-ext.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 #ifndef OPENFLOW_NICIRA_EXT_H
18 #define OPENFLOW_NICIRA_EXT_H 1
19
20 #include "openflow/openflow.h"
21 #include "openvswitch/types.h"
22
23 /* The following vendor extensions, proposed by Nicira, are not yet
24  * standardized, so they are not included in openflow.h.  Some of them may be
25  * suitable for standardization; others we never expect to standardize. */
26
27 #define NX_VENDOR_ID 0x00002320
28 \f
29 /* Nicira vendor-specific error messages extension.
30  *
31  * OpenFlow 1.0 has a set of predefined error types (OFPET_*) and codes (which
32  * are specific to each type).  It does not have any provision for
33  * vendor-specific error codes, and it does not even provide "generic" error
34  * codes that can apply to problems not anticipated by the OpenFlow
35  * specification authors.
36  *
37  * This extension attempts to address the problem by adding a generic "error
38  * vendor extension".  The extension works as follows: use NXET_VENDOR as type
39  * and NXVC_VENDOR_ERROR as code, followed by struct nx_vendor_error with
40  * vendor-specific details, followed by at least 64 bytes of the failed
41  * request.
42  *
43  * It would be better to have a type-specific vendor extension, e.g. so that
44  * OFPET_BAD_ACTION could be used with vendor-specific code values.  But
45  * OFPET_BAD_ACTION and most other standardized types already specify that
46  * their 'data' values are (the start of) the OpenFlow message being replied
47  * to, so there is no room to insert a vendor ID.
48  *
49  * Currently this extension is only implemented by Open vSwitch, but it seems
50  * like a reasonable candidate for future standardization.
51  */
52
53 /* This is a random number to avoid accidental collision with any other
54  * vendor's extension. */
55 #define NXET_VENDOR 0xb0c2
56
57 /* ofp_error msg 'code' values for NXET_VENDOR. */
58 enum nx_vendor_code {
59     NXVC_VENDOR_ERROR           /* 'data' contains struct nx_vendor_error. */
60 };
61
62 /* 'data' for 'type' == NXET_VENDOR, 'code' == NXVC_VENDOR_ERROR. */
63 struct nx_vendor_error {
64     ovs_be32 vendor;            /* Vendor ID as in struct ofp_vendor_header. */
65     ovs_be16 type;              /* Vendor-defined type. */
66     ovs_be16 code;              /* Vendor-defined subtype. */
67     /* Followed by at least the first 64 bytes of the failed request. */
68 };
69 \f
70 /* Nicira vendor requests and replies. */
71
72 /* Header for Nicira vendor requests and replies. */
73 struct nicira_header {
74     struct ofp_header header;
75     ovs_be32 vendor;            /* NX_VENDOR_ID. */
76     ovs_be32 subtype;           /* See the NXT numbers in ofp-msgs.h. */
77 };
78 OFP_ASSERT(sizeof(struct nicira_header) == 16);
79
80 /* Header for Nicira vendor stats request and reply messages in OpenFlow
81  * 1.0. */
82 struct nicira10_stats_msg {
83     struct ofp10_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
84     ovs_be32 subtype;           /* One of NXST_* below. */
85     uint8_t pad[4];             /* Align to 64-bits. */
86 };
87 OFP_ASSERT(sizeof(struct nicira10_stats_msg) == 24);
88
89 /* Header for Nicira vendor stats request and reply messages in OpenFlow
90  * 1.1. */
91 struct nicira11_stats_msg {
92     struct ofp11_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
93     ovs_be32 subtype;           /* One of NXST_* below. */
94 };
95 OFP_ASSERT(sizeof(struct nicira11_stats_msg) == 24);
96
97 /* Fields to use when hashing flows. */
98 enum nx_hash_fields {
99     /* Ethernet source address (NXM_OF_ETH_SRC) only. */
100     NX_HASH_FIELDS_ETH_SRC,
101
102     /* L2 through L4, symmetric across src/dst.  Specifically, each of the
103      * following fields, if present, is hashed (slashes separate symmetric
104      * pairs):
105      *
106      *  - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
107      *  - NXM_OF_ETH_TYPE
108      *  - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
109      *  - NXM_OF_IP_PROTO
110      *  - NXM_OF_IP_SRC / NXM_OF_IP_DST
111      *  - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
112      */
113     NX_HASH_FIELDS_SYMMETRIC_L4
114 };
115
116 /* This command enables or disables an Open vSwitch extension that allows a
117  * controller to specify the OpenFlow table to which a flow should be added,
118  * instead of having the switch decide which table is most appropriate as
119  * required by OpenFlow 1.0.  By default, the extension is disabled.
120  *
121  * When this feature is enabled, Open vSwitch treats struct ofp10_flow_mod's
122  * 16-bit 'command' member as two separate fields.  The upper 8 bits are used
123  * as the table ID, the lower 8 bits specify the command as usual.  A table ID
124  * of 0xff is treated like a wildcarded table ID.
125  *
126  * The specific treatment of the table ID depends on the type of flow mod:
127  *
128  *    - OFPFC_ADD: Given a specific table ID, the flow is always placed in that
129  *      table.  If an identical flow already exists in that table only, then it
130  *      is replaced.  If the flow cannot be placed in the specified table,
131  *      either because the table is full or because the table cannot support
132  *      flows of the given type, the switch replies with an
133  *      OFPFMFC_ALL_TABLES_FULL error.  (A controller can distinguish these
134  *      cases by comparing the current and maximum number of entries reported
135  *      in ofp_table_stats.)
136  *
137  *      If the table ID is wildcarded, the switch picks an appropriate table
138  *      itself.  If an identical flow already exist in the selected flow table,
139  *      then it is replaced.  The choice of table might depend on the flows
140  *      that are already in the switch; for example, if one table fills up then
141  *      the switch might fall back to another one.
142  *
143  *    - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows
144  *      within that table are matched and modified or deleted.  If the table ID
145  *      is wildcarded, flows within any table may be matched and modified or
146  *      deleted.
147  *
148  *    - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID,
149  *      only a flow within that table may be matched and modified or deleted.
150  *      If the table ID is wildcarded and exactly one flow within any table
151  *      matches, then it is modified or deleted; if flows in more than one
152  *      table match, then none is modified or deleted.
153  */
154 struct nx_flow_mod_table_id {
155     uint8_t set;                /* Nonzero to enable, zero to disable. */
156     uint8_t pad[7];
157 };
158 OFP_ASSERT(sizeof(struct nx_flow_mod_table_id) == 8);
159
160 enum nx_packet_in_format {
161     NXPIF_OPENFLOW10 = 0,       /* Standard OpenFlow 1.0 compatible. */
162     NXPIF_NXM = 1               /* Nicira Extended. */
163 };
164
165 /* NXT_SET_PACKET_IN_FORMAT request. */
166 struct nx_set_packet_in_format {
167     ovs_be32 format;            /* One of NXPIF_*. */
168 };
169 OFP_ASSERT(sizeof(struct nx_set_packet_in_format) == 4);
170
171 /* NXT_PACKET_IN (analogous to OFPT_PACKET_IN).
172  *
173  * The NXT_PACKET_IN format is intended to model the OpenFlow-1.2 PACKET_IN
174  * with some minor tweaks.  Most notably NXT_PACKET_IN includes the cookie of
175  * the rule which triggered the NXT_PACKET_IN message, and the match fields are
176  * in NXM format.
177  *
178  * The match fields in the NXT_PACKET_IN are intended to contain flow
179  * processing metadata collected at the time the NXT_PACKET_IN message was
180  * triggered.  It is minimally required to contain the NXM_OF_IN_PORT of the
181  * packet, but may include other NXM headers such as flow registers.  The match
182  * fields are allowed to contain non-metadata (e.g. NXM_OF_ETH_SRC etc).
183  * However, this information can typically be found in the packet directly, so
184  * it may be redundant.
185  *
186  * Whereas in most cases a controller can expect to only get back NXM fields
187  * that it set up itself (e.g. flow dumps will ordinarily report only NXM
188  * fields from flows that the controller added), NXT_PACKET_IN messages might
189  * contain fields that the controller does not understand, because the switch
190  * might support fields (new registers, new protocols, etc.) that the
191  * controller does not.  The controller must prepared to tolerate these.
192  *
193  * The 'cookie' and 'table_id' fields have no meaning when 'reason' is
194  * OFPR_NO_MATCH.  In this case they should be set to 0. */
195 struct nx_packet_in {
196     ovs_be32 buffer_id;       /* ID assigned by datapath. */
197     ovs_be16 total_len;       /* Full length of frame. */
198     uint8_t reason;           /* Reason packet is sent (one of OFPR_*). */
199     uint8_t table_id;         /* ID of the table that was looked up. */
200     ovs_be64 cookie;          /* Cookie of the rule that was looked up. */
201     ovs_be16 match_len;       /* Size of nx_match. */
202     uint8_t pad[6];           /* Align to 64-bits. */
203     /* Followed by:
204      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
205      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
206      *     all-zero bytes, then
207      *   - Exactly 2 all-zero padding bytes, then
208      *   - An Ethernet frame whose length is inferred from nxh.header.length.
209      *
210      * The padding bytes preceding the Ethernet frame ensure that the IP
211      * header (if any) following the Ethernet header is 32-bit aligned. */
212
213     /* uint8_t nxm_fields[...]; */ /* Match. */
214     /* uint8_t pad[2]; */          /* Align to 64 bit + 16 bit. */
215     /* uint8_t data[0]; */         /* Ethernet frame. */
216 };
217 OFP_ASSERT(sizeof(struct nx_packet_in) == 24);
218
219 /* Configures the "role" of the sending controller.  The default role is:
220  *
221  *    - Other (NX_ROLE_OTHER), which allows the controller access to all
222  *      OpenFlow features.
223  *
224  * The other possible roles are a related pair:
225  *
226  *    - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
227  *      be at most one Master controller at a time: when a controller
228  *      configures itself as Master, any existing Master is demoted to the
229  *      Slave role.
230  *
231  *    - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
232  *      OpenFlow features.  In particular attempts to modify the flow table
233  *      will be rejected with an OFPBRC_EPERM error.
234  *
235  *      Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
236  *      messages, but they do receive OFPT_PORT_STATUS messages.
237  */
238 struct nx_role_request {
239     ovs_be32 role;              /* One of NX_ROLE_*. */
240 };
241 OFP_ASSERT(sizeof(struct nx_role_request) == 4);
242
243 enum nx_role {
244     NX_ROLE_OTHER,              /* Default role, full access. */
245     NX_ROLE_MASTER,             /* Full access, at most one. */
246     NX_ROLE_SLAVE               /* Read-only access. */
247 };
248
249 /* NXT_SET_ASYNC_CONFIG.
250  *
251  * Sent by a controller, this message configures the asynchronous messages that
252  * the controller wants to receive.  Element 0 in each array specifies messages
253  * of interest when the controller has an "other" or "master" role; element 1,
254  * when the controller has a "slave" role.
255  *
256  * Each array element is a bitmask in which a 0-bit disables receiving a
257  * particular message and a 1-bit enables receiving it.  Each bit controls the
258  * message whose 'reason' corresponds to the bit index.  For example, the bit
259  * with value 1<<2 == 4 in port_status_mask[1] determines whether the
260  * controller will receive OFPT_PORT_STATUS messages with reason OFPPR_MODIFY
261  * (value 2) when the controller has a "slave" role.
262  *
263  * As a side effect, for service controllers, this message changes the
264  * miss_send_len from default of zero to OFP_DEFAULT_MISS_SEND_LEN (128).
265  */
266 struct nx_async_config {
267     ovs_be32 packet_in_mask[2];    /* Bitmasks of OFPR_* values. */
268     ovs_be32 port_status_mask[2];  /* Bitmasks of OFPRR_* values. */
269     ovs_be32 flow_removed_mask[2]; /* Bitmasks of OFPPR_* values. */
270 };
271 OFP_ASSERT(sizeof(struct nx_async_config) == 24);
272 \f
273 /* Nicira vendor flow actions. */
274
275 enum nx_action_subtype {
276     NXAST_SNAT__OBSOLETE,       /* No longer used. */
277     NXAST_RESUBMIT,             /* struct nx_action_resubmit */
278     NXAST_SET_TUNNEL,           /* struct nx_action_set_tunnel */
279     NXAST_DROP_SPOOFED_ARP__OBSOLETE,
280     NXAST_SET_QUEUE,            /* struct nx_action_set_queue */
281     NXAST_POP_QUEUE,            /* struct nx_action_pop_queue */
282     NXAST_REG_MOVE,             /* struct nx_action_reg_move */
283     NXAST_REG_LOAD,             /* struct nx_action_reg_load */
284     NXAST_NOTE,                 /* struct nx_action_note */
285     NXAST_SET_TUNNEL64,         /* struct nx_action_set_tunnel64 */
286     NXAST_MULTIPATH,            /* struct nx_action_multipath */
287     NXAST_AUTOPATH,             /* struct nx_action_autopath */
288     NXAST_BUNDLE,               /* struct nx_action_bundle */
289     NXAST_BUNDLE_LOAD,          /* struct nx_action_bundle */
290     NXAST_RESUBMIT_TABLE,       /* struct nx_action_resubmit */
291     NXAST_OUTPUT_REG,           /* struct nx_action_output_reg */
292     NXAST_LEARN,                /* struct nx_action_learn */
293     NXAST_EXIT,                 /* struct nx_action_header */
294     NXAST_DEC_TTL,              /* struct nx_action_header */
295     NXAST_FIN_TIMEOUT,          /* struct nx_action_fin_timeout */
296     NXAST_CONTROLLER,           /* struct nx_action_controller */
297     NXAST_DEC_TTL_CNT_IDS,      /* struct nx_action_cnt_ids */
298 };
299
300 /* Header for Nicira-defined actions. */
301 struct nx_action_header {
302     ovs_be16 type;                  /* OFPAT_VENDOR. */
303     ovs_be16 len;                   /* Length is 16. */
304     ovs_be32 vendor;                /* NX_VENDOR_ID. */
305     ovs_be16 subtype;               /* NXAST_*. */
306     uint8_t pad[6];
307 };
308 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
309
310 /* Action structures for NXAST_RESUBMIT and NXAST_RESUBMIT_TABLE.
311  *
312  * These actions search one of the switch's flow tables:
313  *
314  *    - For NXAST_RESUBMIT_TABLE only, if the 'table' member is not 255, then
315  *      it specifies the table to search.
316  *
317  *    - Otherwise (for NXAST_RESUBMIT_TABLE with a 'table' of 255, or for
318  *      NXAST_RESUBMIT regardless of 'table'), it searches the current flow
319  *      table, that is, the OpenFlow flow table that contains the flow from
320  *      which this action was obtained.  If this action did not come from a
321  *      flow table (e.g. it came from an OFPT_PACKET_OUT message), then table 0
322  *      is the current table.
323  *
324  * The flow table lookup uses a flow that may be slightly modified from the
325  * original lookup:
326  *
327  *    - For NXAST_RESUBMIT, the 'in_port' member of struct nx_action_resubmit
328  *      is used as the flow's in_port.
329  *
330  *    - For NXAST_RESUBMIT_TABLE, if the 'in_port' member is not OFPP_IN_PORT,
331  *      then its value is used as the flow's in_port.  Otherwise, the original
332  *      in_port is used.
333  *
334  *    - If actions that modify the flow (e.g. OFPAT_SET_VLAN_VID) precede the
335  *      resubmit action, then the flow is updated with the new values.
336  *
337  * Following the lookup, the original in_port is restored.
338  *
339  * If the modified flow matched in the flow table, then the corresponding
340  * actions are executed.  Afterward, actions following the resubmit in the
341  * original set of actions, if any, are executed; any changes made to the
342  * packet (e.g. changes to VLAN) by secondary actions persist when those
343  * actions are executed, although the original in_port is restored.
344  *
345  * Resubmit actions may be used any number of times within a set of actions.
346  *
347  * Resubmit actions may nest to an implementation-defined depth.  Beyond this
348  * implementation-defined depth, further resubmit actions are simply ignored.
349  *
350  * NXAST_RESUBMIT ignores 'table' and 'pad'.  NXAST_RESUBMIT_TABLE requires
351  * 'pad' to be all-bits-zero.
352  *
353  * Open vSwitch 1.0.1 and earlier did not support recursion.  Open vSwitch
354  * before 1.2.90 did not support NXAST_RESUBMIT_TABLE.
355  */
356 struct nx_action_resubmit {
357     ovs_be16 type;                  /* OFPAT_VENDOR. */
358     ovs_be16 len;                   /* Length is 16. */
359     ovs_be32 vendor;                /* NX_VENDOR_ID. */
360     ovs_be16 subtype;               /* NXAST_RESUBMIT. */
361     ovs_be16 in_port;               /* New in_port for checking flow table. */
362     uint8_t table;                  /* NXAST_RESUBMIT_TABLE: table to use. */
363     uint8_t pad[3];
364 };
365 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
366
367 /* Action structure for NXAST_SET_TUNNEL.
368  *
369  * Sets the encapsulating tunnel ID to a 32-bit value.  The most-significant 32
370  * bits of the tunnel ID are set to 0. */
371 struct nx_action_set_tunnel {
372     ovs_be16 type;                  /* OFPAT_VENDOR. */
373     ovs_be16 len;                   /* Length is 16. */
374     ovs_be32 vendor;                /* NX_VENDOR_ID. */
375     ovs_be16 subtype;               /* NXAST_SET_TUNNEL. */
376     uint8_t pad[2];
377     ovs_be32 tun_id;                /* Tunnel ID. */
378 };
379 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
380
381 /* Action structure for NXAST_SET_TUNNEL64.
382  *
383  * Sets the encapsulating tunnel ID to a 64-bit value. */
384 struct nx_action_set_tunnel64 {
385     ovs_be16 type;                  /* OFPAT_VENDOR. */
386     ovs_be16 len;                   /* Length is 24. */
387     ovs_be32 vendor;                /* NX_VENDOR_ID. */
388     ovs_be16 subtype;               /* NXAST_SET_TUNNEL64. */
389     uint8_t pad[6];
390     ovs_be64 tun_id;                /* Tunnel ID. */
391 };
392 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
393
394 /* Action structure for NXAST_SET_QUEUE.
395  *
396  * Set the queue that should be used when packets are output.  This is similar
397  * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
398  * an argument.  This allows the queue to be defined before the port is
399  * known. */
400 struct nx_action_set_queue {
401     ovs_be16 type;                  /* OFPAT_VENDOR. */
402     ovs_be16 len;                   /* Length is 16. */
403     ovs_be32 vendor;                /* NX_VENDOR_ID. */
404     ovs_be16 subtype;               /* NXAST_SET_QUEUE. */
405     uint8_t pad[2];
406     ovs_be32 queue_id;              /* Where to enqueue packets. */
407 };
408 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
409
410 /* Action structure for NXAST_POP_QUEUE.
411  *
412  * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
413  * were used.  Only the original queue can be restored this way; no stack is
414  * maintained. */
415 struct nx_action_pop_queue {
416     ovs_be16 type;                  /* OFPAT_VENDOR. */
417     ovs_be16 len;                   /* Length is 16. */
418     ovs_be32 vendor;                /* NX_VENDOR_ID. */
419     ovs_be16 subtype;               /* NXAST_POP_QUEUE. */
420     uint8_t pad[6];
421 };
422 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
423
424 /* Action structure for NXAST_REG_MOVE.
425  *
426  * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
427  * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
428  * bit 'c').  Bit numbering starts at 0 for the least-significant bit, 1 for
429  * the next most significant bit, and so on.
430  *
431  * 'src' and 'dst' are nxm_header values with nxm_hasmask=0.  (It doesn't make
432  * sense to use nxm_hasmask=1 because the action does not do any kind of
433  * matching; it uses the actual value of a field.)
434  *
435  * The following nxm_header values are potentially acceptable as 'src':
436  *
437  *   - NXM_OF_IN_PORT
438  *   - NXM_OF_ETH_DST
439  *   - NXM_OF_ETH_SRC
440  *   - NXM_OF_ETH_TYPE
441  *   - NXM_OF_VLAN_TCI
442  *   - NXM_OF_IP_TOS
443  *   - NXM_OF_IP_PROTO
444  *   - NXM_OF_IP_SRC
445  *   - NXM_OF_IP_DST
446  *   - NXM_OF_TCP_SRC
447  *   - NXM_OF_TCP_DST
448  *   - NXM_OF_UDP_SRC
449  *   - NXM_OF_UDP_DST
450  *   - NXM_OF_ICMP_TYPE
451  *   - NXM_OF_ICMP_CODE
452  *   - NXM_OF_ARP_OP
453  *   - NXM_OF_ARP_SPA
454  *   - NXM_OF_ARP_TPA
455  *   - NXM_NX_TUN_ID
456  *   - NXM_NX_ARP_SHA
457  *   - NXM_NX_ARP_THA
458  *   - NXM_NX_ICMPV6_TYPE
459  *   - NXM_NX_ICMPV6_CODE
460  *   - NXM_NX_ND_SLL
461  *   - NXM_NX_ND_TLL
462  *   - NXM_NX_REG(idx) for idx in the switch's accepted range.
463  *
464  * The following nxm_header values are potentially acceptable as 'dst':
465  *
466  *   - NXM_OF_ETH_DST
467  *   - NXM_OF_ETH_SRC
468  *   - NXM_OF_IP_TOS
469  *   - NXM_OF_IP_SRC
470  *   - NXM_OF_IP_DST
471  *   - NXM_OF_TCP_SRC
472  *   - NXM_OF_TCP_DST
473  *   - NXM_OF_UDP_SRC
474  *   - NXM_OF_UDP_DST
475  *     Modifying any of the above fields changes the corresponding packet
476  *     header.
477  *
478  *   - NXM_NX_REG(idx) for idx in the switch's accepted range.
479  *
480  *   - NXM_OF_VLAN_TCI.  Modifying this field's value has side effects on the
481  *     packet's 802.1Q header.  Setting a value with CFI=0 removes the 802.1Q
482  *     header (if any), ignoring the other bits.  Setting a value with CFI=1
483  *     adds or modifies the 802.1Q header appropriately, setting the TCI field
484  *     to the field's new value (with the CFI bit masked out).
485  *
486  *   - NXM_NX_TUN_ID.  Modifying this value modifies the tunnel ID used for the
487  *     packet's next tunnel encapsulation.
488  *
489  * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
490  * nx_match satisfies its prerequisites.  For example, NXM_OF_IP_TOS may be
491  * used only if the flow's nx_match includes an nxm_entry that specifies
492  * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
493  *
494  * The switch will reject actions for which src_ofs+n_bits is greater than the
495  * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
496  * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
497  */
498 struct nx_action_reg_move {
499     ovs_be16 type;                  /* OFPAT_VENDOR. */
500     ovs_be16 len;                   /* Length is 24. */
501     ovs_be32 vendor;                /* NX_VENDOR_ID. */
502     ovs_be16 subtype;               /* NXAST_REG_MOVE. */
503     ovs_be16 n_bits;                /* Number of bits. */
504     ovs_be16 src_ofs;               /* Starting bit offset in source. */
505     ovs_be16 dst_ofs;               /* Starting bit offset in destination. */
506     ovs_be32 src;                   /* Source register. */
507     ovs_be32 dst;                   /* Destination register. */
508 };
509 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
510
511 /* Action structure for NXAST_REG_LOAD.
512  *
513  * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
514  * within 'a' numbered 'b' through 'c' (not including bit 'c').  Bit numbering
515  * starts at 0 for the least-significant bit, 1 for the next most significant
516  * bit, and so on.
517  *
518  * 'dst' is an nxm_header with nxm_hasmask=0.  See the documentation for
519  * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
520  * loading them.
521  *
522  * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
523  * to avoid enlarging the structure by another 8 bytes.  To allow 'n_bits' to
524  * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
525  * also stored as one less than its true value:
526  *
527  *  15                           6 5                0
528  * +------------------------------+------------------+
529  * |              ofs             |    n_bits - 1    |
530  * +------------------------------+------------------+
531  *
532  * The switch will reject actions for which ofs+n_bits is greater than the
533  * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
534  * greater are set to 1, with error type OFPET_BAD_ACTION, code
535  * OFPBAC_BAD_ARGUMENT.
536  */
537 struct nx_action_reg_load {
538     ovs_be16 type;                  /* OFPAT_VENDOR. */
539     ovs_be16 len;                   /* Length is 24. */
540     ovs_be32 vendor;                /* NX_VENDOR_ID. */
541     ovs_be16 subtype;               /* NXAST_REG_LOAD. */
542     ovs_be16 ofs_nbits;             /* (ofs << 6) | (n_bits - 1). */
543     ovs_be32 dst;                   /* Destination register. */
544     ovs_be64 value;                 /* Immediate value. */
545 };
546 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
547
548 /* Action structure for NXAST_NOTE.
549  *
550  * This action has no effect.  It is variable length.  The switch does not
551  * attempt to interpret the user-defined 'note' data in any way.  A controller
552  * can use this action to attach arbitrary metadata to a flow.
553  *
554  * This action might go away in the future.
555  */
556 struct nx_action_note {
557     ovs_be16 type;                  /* OFPAT_VENDOR. */
558     ovs_be16 len;                   /* A multiple of 8, but at least 16. */
559     ovs_be32 vendor;                /* NX_VENDOR_ID. */
560     ovs_be16 subtype;               /* NXAST_NOTE. */
561     uint8_t note[6];                /* Start of user-defined data. */
562     /* Possibly followed by additional user-defined data. */
563 };
564 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
565
566 /* Action structure for NXAST_MULTIPATH.
567  *
568  * This action performs the following steps in sequence:
569  *
570  *    1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
571  *       Refer to the definition of "enum nx_mp_fields" for details.
572  *
573  *       The 'basis' value is used as a universal hash parameter, that is,
574  *       different values of 'basis' yield different hash functions.  The
575  *       particular universal hash function used is implementation-defined.
576  *
577  *       The hashed fields' values are drawn from the current state of the
578  *       flow, including all modifications that have been made by actions up to
579  *       this point.
580  *
581  *    2. Applies the multipath link choice algorithm specified by 'algorithm',
582  *       one of NX_MP_ALG_*.  Refer to the definition of "enum nx_mp_algorithm"
583  *       for details.
584  *
585  *       The output of the algorithm is 'link', an unsigned integer less than
586  *       or equal to 'max_link'.
587  *
588  *       Some algorithms use 'arg' as an additional argument.
589  *
590  *    3. Stores 'link' in dst[ofs:ofs+n_bits].  The format and semantics of
591  *       'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
592  *       action.
593  *
594  * The switch will reject actions that have an unknown 'fields', or an unknown
595  * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
596  * in which 'max_link' is greater than or equal to 2**n_bits, with error type
597  * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
598  */
599 struct nx_action_multipath {
600     ovs_be16 type;              /* OFPAT_VENDOR. */
601     ovs_be16 len;               /* Length is 32. */
602     ovs_be32 vendor;            /* NX_VENDOR_ID. */
603     ovs_be16 subtype;           /* NXAST_MULTIPATH. */
604
605     /* What fields to hash and how. */
606     ovs_be16 fields;            /* One of NX_HASH_FIELDS_*. */
607     ovs_be16 basis;             /* Universal hash parameter. */
608     ovs_be16 pad0;
609
610     /* Multipath link choice algorithm to apply to hash value. */
611     ovs_be16 algorithm;         /* One of NX_MP_ALG_*. */
612     ovs_be16 max_link;          /* Number of output links, minus 1. */
613     ovs_be32 arg;               /* Algorithm-specific argument. */
614     ovs_be16 pad1;
615
616     /* Where to store the result. */
617     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
618     ovs_be32 dst;               /* Destination. */
619 };
620 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
621
622 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
623  *
624  * In the descriptions below, 'n_links' is max_link + 1. */
625 enum nx_mp_algorithm {
626     /* link = hash(flow) % n_links.
627      *
628      * Redistributes all traffic when n_links changes.  O(1) performance.  See
629      * RFC 2992.
630      *
631      * Use UINT16_MAX for max_link to get a raw hash value. */
632     NX_MP_ALG_MODULO_N,
633
634     /* link = hash(flow) / (MAX_HASH / n_links).
635      *
636      * Redistributes between one-quarter and one-half of traffic when n_links
637      * changes.  O(1) performance.  See RFC 2992.
638      */
639     NX_MP_ALG_HASH_THRESHOLD,
640
641     /* for i in [0,n_links):
642      *   weights[i] = hash(flow, i)
643      * link = { i such that weights[i] >= weights[j] for all j != i }
644      *
645      * Redistributes 1/n_links of traffic when n_links changes.  O(n_links)
646      * performance.  If n_links is greater than a threshold (currently 64, but
647      * subject to change), Open vSwitch will substitute another algorithm
648      * automatically.  See RFC 2992. */
649     NX_MP_ALG_HRW,              /* Highest Random Weight. */
650
651     /* i = 0
652      * repeat:
653      *     i = i + 1
654      *     link = hash(flow, i) % arg
655      * while link > max_link
656      *
657      * Redistributes 1/n_links of traffic when n_links changes.  O(1)
658      * performance when arg/max_link is bounded by a constant.
659      *
660      * Redistributes all traffic when arg changes.
661      *
662      * arg must be greater than max_link and for best performance should be no
663      * more than approximately max_link * 2.  If arg is outside the acceptable
664      * range, Open vSwitch will automatically substitute the least power of 2
665      * greater than max_link.
666      *
667      * This algorithm is specific to Open vSwitch.
668      */
669     NX_MP_ALG_ITER_HASH         /* Iterative Hash. */
670 };
671 \f
672 /* Action structure for NXAST_LEARN.
673  *
674  * This action adds or modifies a flow in an OpenFlow table, similar to
675  * OFPT_FLOW_MOD with OFPFC_MODIFY_STRICT as 'command'.  The new flow has the
676  * specified idle timeout, hard timeout, priority, cookie, and flags.  The new
677  * flow's match criteria and actions are built by applying each of the series
678  * of flow_mod_spec elements included as part of the action.
679  *
680  * A flow_mod_spec starts with a 16-bit header.  A header that is all-bits-0 is
681  * a no-op used for padding the action as a whole to a multiple of 8 bytes in
682  * length.  Otherwise, the flow_mod_spec can be thought of as copying 'n_bits'
683  * bits from a source to a destination.  In this case, the header contains
684  * multiple fields:
685  *
686  *  15  14  13 12  11 10                              0
687  * +------+---+------+---------------------------------+
688  * |   0  |src|  dst |             n_bits              |
689  * +------+---+------+---------------------------------+
690  *
691  * The meaning and format of a flow_mod_spec depends on 'src' and 'dst'.  The
692  * following table summarizes the meaning of each possible combination.
693  * Details follow the table:
694  *
695  *   src dst  meaning
696  *   --- ---  ----------------------------------------------------------
697  *    0   0   Add match criteria based on value in a field.
698  *    1   0   Add match criteria based on an immediate value.
699  *    0   1   Add NXAST_REG_LOAD action to copy field into a different field.
700  *    1   1   Add NXAST_REG_LOAD action to load immediate value into a field.
701  *    0   2   Add OFPAT_OUTPUT action to output to port from specified field.
702  *   All other combinations are undefined and not allowed.
703  *
704  * The flow_mod_spec header is followed by a source specification and a
705  * destination specification.  The format and meaning of the source
706  * specification depends on 'src':
707  *
708  *   - If 'src' is 0, the source bits are taken from a field in the flow to
709  *     which this action is attached.  (This should be a wildcarded field.  If
710  *     its value is fully specified then the source bits being copied have
711  *     constant values.)
712  *
713  *     The source specification is an ovs_be32 'field' and an ovs_be16 'ofs'.
714  *     'field' is an nxm_header with nxm_hasmask=0, and 'ofs' the starting bit
715  *     offset within that field.  The source bits are field[ofs:ofs+n_bits-1].
716  *     'field' and 'ofs' are subject to the same restrictions as the source
717  *     field in NXAST_REG_MOVE.
718  *
719  *   - If 'src' is 1, the source bits are a constant value.  The source
720  *     specification is (n_bits+15)/16*2 bytes long.  Taking those bytes as a
721  *     number in network order, the source bits are the 'n_bits'
722  *     least-significant bits.  The switch will report an error if other bits
723  *     in the constant are nonzero.
724  *
725  * The flow_mod_spec destination specification, for 'dst' of 0 or 1, is an
726  * ovs_be32 'field' and an ovs_be16 'ofs'.  'field' is an nxm_header with
727  * nxm_hasmask=0 and 'ofs' is a starting bit offset within that field.  The
728  * meaning of the flow_mod_spec depends on 'dst':
729  *
730  *   - If 'dst' is 0, the flow_mod_spec specifies match criteria for the new
731  *     flow.  The new flow matches only if bits field[ofs:ofs+n_bits-1] in a
732  *     packet equal the source bits.  'field' may be any nxm_header with
733  *     nxm_hasmask=0 that is allowed in NXT_FLOW_MOD.
734  *
735  *     Order is significant.  Earlier flow_mod_specs must satisfy any
736  *     prerequisites for matching fields specified later, by copying constant
737  *     values into prerequisite fields.
738  *
739  *     The switch will reject flow_mod_specs that do not satisfy NXM masking
740  *     restrictions.
741  *
742  *   - If 'dst' is 1, the flow_mod_spec specifies an NXAST_REG_LOAD action for
743  *     the new flow.  The new flow copies the source bits into
744  *     field[ofs:ofs+n_bits-1].  Actions are executed in the same order as the
745  *     flow_mod_specs.
746  *
747  *     A single NXAST_REG_LOAD action writes no more than 64 bits, so n_bits
748  *     greater than 64 yields multiple NXAST_REG_LOAD actions.
749  *
750  * The flow_mod_spec destination spec for 'dst' of 2 (when 'src' is 0) is
751  * empty.  It has the following meaning:
752  *
753  *   - The flow_mod_spec specifies an OFPAT_OUTPUT action for the new flow.
754  *     The new flow outputs to the OpenFlow port specified by the source field.
755  *     Of the special output ports with value OFPP_MAX or larger, OFPP_IN_PORT,
756  *     OFPP_FLOOD, OFPP_LOCAL, and OFPP_ALL are supported.  Other special ports
757  *     may not be used.
758  *
759  * Resource Management
760  * -------------------
761  *
762  * A switch has a finite amount of flow table space available for learning.
763  * When this space is exhausted, no new learning table entries will be learned
764  * until some existing flow table entries expire.  The controller should be
765  * prepared to handle this by flooding (which can be implemented as a
766  * low-priority flow).
767  *
768  * If a learned flow matches a single TCP stream with a relatively long
769  * timeout, one may make the best of resource constraints by setting
770  * 'fin_idle_timeout' or 'fin_hard_timeout' (both measured in seconds), or
771  * both, to shorter timeouts.  When either of these is specified as a nonzero
772  * value, OVS adds a NXAST_FIN_TIMEOUT action, with the specified timeouts, to
773  * the learned flow.
774  *
775  * Examples
776  * --------
777  *
778  * The following examples give a prose description of the flow_mod_specs along
779  * with informal notation for how those would be represented and a hex dump of
780  * the bytes that would be required.
781  *
782  * These examples could work with various nx_action_learn parameters.  Typical
783  * values would be idle_timeout=OFP_FLOW_PERMANENT, hard_timeout=60,
784  * priority=OFP_DEFAULT_PRIORITY, flags=0, table_id=10.
785  *
786  * 1. Learn input port based on the source MAC, with lookup into
787  *    NXM_NX_REG1[16:31] by resubmit to in_port=99:
788  *
789  *    Match on in_port=99:
790  *       ovs_be16(src=1, dst=0, n_bits=16),               20 10
791  *       ovs_be16(99),                                    00 63
792  *       ovs_be32(NXM_OF_IN_PORT), ovs_be16(0)            00 00 00 02 00 00
793  *
794  *    Match Ethernet destination on Ethernet source from packet:
795  *       ovs_be16(src=0, dst=0, n_bits=48),               00 30
796  *       ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0)            00 00 04 06 00 00
797  *       ovs_be32(NXM_OF_ETH_DST), ovs_be16(0)            00 00 02 06 00 00
798  *
799  *    Set NXM_NX_REG1[16:31] to the packet's input port:
800  *       ovs_be16(src=0, dst=1, n_bits=16),               08 10
801  *       ovs_be32(NXM_OF_IN_PORT), ovs_be16(0)            00 00 00 02 00 00
802  *       ovs_be32(NXM_NX_REG1), ovs_be16(16)              00 01 02 04 00 10
803  *
804  *    Given a packet that arrived on port A with Ethernet source address B,
805  *    this would set up the flow "in_port=99, dl_dst=B,
806  *    actions=load:A->NXM_NX_REG1[16..31]".
807  *
808  *    In syntax accepted by ovs-ofctl, this action is: learn(in_port=99,
809  *    NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
810  *    load:NXM_OF_IN_PORT[]->NXM_NX_REG1[16..31])
811  *
812  * 2. Output to input port based on the source MAC and VLAN VID, with lookup
813  *    into NXM_NX_REG1[16:31]:
814  *
815  *    Match on same VLAN ID as packet:
816  *       ovs_be16(src=0, dst=0, n_bits=12),               00 0c
817  *       ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0)           00 00 08 02 00 00
818  *       ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0)           00 00 08 02 00 00
819  *
820  *    Match Ethernet destination on Ethernet source from packet:
821  *       ovs_be16(src=0, dst=0, n_bits=48),               00 30
822  *       ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0)            00 00 04 06 00 00
823  *       ovs_be32(NXM_OF_ETH_DST), ovs_be16(0)            00 00 02 06 00 00
824  *
825  *    Output to the packet's input port:
826  *       ovs_be16(src=0, dst=2, n_bits=16),               10 10
827  *       ovs_be32(NXM_OF_IN_PORT), ovs_be16(0)            00 00 00 02 00 00
828  *
829  *    Given a packet that arrived on port A with Ethernet source address B in
830  *    VLAN C, this would set up the flow "dl_dst=B, vlan_vid=C,
831  *    actions=output:A".
832  *
833  *    In syntax accepted by ovs-ofctl, this action is:
834  *    learn(NXM_OF_VLAN_TCI[0..11], NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
835  *    output:NXM_OF_IN_PORT[])
836  *
837  * 3. Here's a recipe for a very simple-minded MAC learning switch.  It uses a
838  *    10-second MAC expiration time to make it easier to see what's going on
839  *
840  *      ovs-vsctl del-controller br0
841  *      ovs-ofctl del-flows br0
842  *      ovs-ofctl add-flow br0 "table=0 actions=learn(table=1, \
843           hard_timeout=10, NXM_OF_VLAN_TCI[0..11],             \
844           NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],                   \
845           output:NXM_OF_IN_PORT[]), resubmit(,1)"
846  *      ovs-ofctl add-flow br0 "table=1 priority=0 actions=flood"
847  *
848  *    You can then dump the MAC learning table with:
849  *
850  *      ovs-ofctl dump-flows br0 table=1
851  *
852  * Usage Advice
853  * ------------
854  *
855  * For best performance, segregate learned flows into a table that is not used
856  * for any other flows except possibly for a lowest-priority "catch-all" flow
857  * (a flow with no match criteria).  If different learning actions specify
858  * different match criteria, use different tables for the learned flows.
859  *
860  * The meaning of 'hard_timeout' and 'idle_timeout' can be counterintuitive.
861  * These timeouts apply to the flow that is added, which means that a flow with
862  * an idle timeout will expire when no traffic has been sent *to* the learned
863  * address.  This is not usually the intent in MAC learning; instead, we want
864  * the MAC learn entry to expire when no traffic has been sent *from* the
865  * learned address.  Use a hard timeout for that.
866  */
867 struct nx_action_learn {
868     ovs_be16 type;              /* OFPAT_VENDOR. */
869     ovs_be16 len;               /* At least 24. */
870     ovs_be32 vendor;            /* NX_VENDOR_ID. */
871     ovs_be16 subtype;           /* NXAST_LEARN. */
872     ovs_be16 idle_timeout;      /* Idle time before discarding (seconds). */
873     ovs_be16 hard_timeout;      /* Max time before discarding (seconds). */
874     ovs_be16 priority;          /* Priority level of flow entry. */
875     ovs_be64 cookie;            /* Cookie for new flow. */
876     ovs_be16 flags;             /* Either 0 or OFPFF_SEND_FLOW_REM. */
877     uint8_t table_id;           /* Table to insert flow entry. */
878     uint8_t pad;                /* Must be zero. */
879     ovs_be16 fin_idle_timeout;  /* Idle timeout after FIN, if nonzero. */
880     ovs_be16 fin_hard_timeout;  /* Hard timeout after FIN, if nonzero. */
881     /* Followed by a sequence of flow_mod_spec elements, as described above,
882      * until the end of the action is reached. */
883 };
884 OFP_ASSERT(sizeof(struct nx_action_learn) == 32);
885
886 #define NX_LEARN_N_BITS_MASK    0x3ff
887
888 #define NX_LEARN_SRC_FIELD     (0 << 13) /* Copy from field. */
889 #define NX_LEARN_SRC_IMMEDIATE (1 << 13) /* Copy from immediate value. */
890 #define NX_LEARN_SRC_MASK      (1 << 13)
891
892 #define NX_LEARN_DST_MATCH     (0 << 11) /* Add match criterion. */
893 #define NX_LEARN_DST_LOAD      (1 << 11) /* Add NXAST_REG_LOAD action. */
894 #define NX_LEARN_DST_OUTPUT    (2 << 11) /* Add OFPAT_OUTPUT action. */
895 #define NX_LEARN_DST_RESERVED  (3 << 11) /* Not yet defined. */
896 #define NX_LEARN_DST_MASK      (3 << 11)
897
898 /* Action structure for NXAST_FIN_TIMEOUT.
899  *
900  * This action changes the idle timeout or hard timeout, or both, of this
901  * OpenFlow rule when the rule matches a TCP packet with the FIN or RST flag.
902  * When such a packet is observed, the action reduces the rule's idle timeout
903  * to 'fin_idle_timeout' and its hard timeout to 'fin_hard_timeout'.  This
904  * action has no effect on an existing timeout that is already shorter than the
905  * one that the action specifies.  A 'fin_idle_timeout' or 'fin_hard_timeout'
906  * of zero has no effect on the respective timeout.
907  *
908  * 'fin_idle_timeout' and 'fin_hard_timeout' are measured in seconds.
909  * 'fin_hard_timeout' specifies time since the flow's creation, not since the
910  * receipt of the FIN or RST.
911  *
912  * This is useful for quickly discarding learned TCP flows that otherwise will
913  * take a long time to expire.
914  *
915  * This action is intended for use with an OpenFlow rule that matches only a
916  * single TCP flow.  If the rule matches multiple TCP flows (e.g. it wildcards
917  * all TCP traffic, or all TCP traffic to a particular port), then any FIN or
918  * RST in any of those flows will cause the entire OpenFlow rule to expire
919  * early, which is not normally desirable.
920  */
921 struct nx_action_fin_timeout {
922     ovs_be16 type;              /* OFPAT_VENDOR. */
923     ovs_be16 len;               /* 16. */
924     ovs_be32 vendor;            /* NX_VENDOR_ID. */
925     ovs_be16 subtype;           /* NXAST_FIN_TIMEOUT. */
926     ovs_be16 fin_idle_timeout;  /* New idle timeout, if nonzero. */
927     ovs_be16 fin_hard_timeout;  /* New hard timeout, if nonzero. */
928     ovs_be16 pad;               /* Must be zero. */
929 };
930 OFP_ASSERT(sizeof(struct nx_action_fin_timeout) == 16);
931 \f
932 /* Action structure for NXAST_AUTOPATH.
933  *
934  * This action performs the following steps in sequence:
935  *
936  *    1. Hashes the flow using an implementation-defined hash function.
937  *
938  *       The hashed fields' values are drawn from the current state of the
939  *       flow, including all modifications that have been made by actions up to
940  *       this point.
941  *
942  *    2. Selects an OpenFlow 'port'.
943  *
944  *       'port' is selected in an implementation-defined manner, taking into
945  *       account 'id' and the hash value calculated in step 1.
946  *
947  *       Generally a switch will have been configured with a set of ports that
948  *       may be chosen given 'id'.  The switch may take into account any number
949  *       of factors when choosing 'port' from its configured set.  Factors may
950  *       include carrier, load, and the results of configuration protocols such
951  *       as LACP.
952  *
953  *    3. Stores 'port' in dst[ofs:ofs+n_bits].
954  *
955  *       The format and semantics of 'dst' and 'ofs_nbits' are similar to those
956  *       for the NXAST_REG_LOAD action.
957  *
958  * The switch will reject actions in which ofs+n_bits is greater than the width
959  * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
960  */
961 struct nx_action_autopath {
962     ovs_be16 type;              /* OFPAT_VENDOR. */
963     ovs_be16 len;               /* Length is 24. */
964     ovs_be32 vendor;            /* NX_VENDOR_ID. */
965     ovs_be16 subtype;           /* NXAST_AUTOPATH. */
966
967     /* Where to store the result. */
968     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
969     ovs_be32 dst;               /* Destination. */
970
971     ovs_be32 id;                /* Autopath ID. */
972     ovs_be32 pad;
973 };
974 OFP_ASSERT(sizeof(struct nx_action_autopath) == 24);
975 \f
976 /* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD.
977  *
978  * The bundle actions choose a slave from a supplied list of options.
979  * NXAST_BUNDLE outputs to its selection.  NXAST_BUNDLE_LOAD writes its
980  * selection to a register.
981  *
982  * The list of possible slaves follows the nx_action_bundle structure. The size
983  * of each slave is governed by its type as indicated by the 'slave_type'
984  * parameter. The list of slaves should be padded at its end with zeros to make
985  * the total length of the action a multiple of 8.
986  *
987  * Switches infer from the 'slave_type' parameter the size of each slave.  All
988  * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
989  * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
990  * 2 byte width.  Switches should reject actions which indicate unknown or
991  * unsupported slave types.
992  *
993  * Switches use a strategy dictated by the 'algorithm' parameter to choose a
994  * slave.  If the switch does not support the specified 'algorithm' parameter,
995  * it should reject the action.
996  *
997  * Several algorithms take into account liveness when selecting slaves.  The
998  * liveness of a slave is implementation defined (with one exception), but will
999  * generally take into account things like its carrier status and the results
1000  * of any link monitoring protocols which happen to be running on it.  In order
1001  * to give controllers a place-holder value, the OFPP_NONE port is always
1002  * considered live.
1003  *
1004  * Some slave selection strategies require the use of a hash function, in which
1005  * case the 'fields' and 'basis' parameters should be populated.  The 'fields'
1006  * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
1007  * hash.  Refer to the definition of "enum nx_hash_fields" for details.  The
1008  * 'basis' parameter is used as a universal hash parameter.  Different values
1009  * of 'basis' yield different hash results.
1010  *
1011  * The 'zero' parameter at the end of the action structure is reserved for
1012  * future use.  Switches are required to reject actions which have nonzero
1013  * bytes in the 'zero' field.
1014  *
1015  * NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed.  Switches
1016  * should reject actions which have nonzero bytes in either of these fields.
1017  *
1018  * NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in
1019  * dst[ofs:ofs+n_bits].  The format and semantics of 'dst' and 'ofs_nbits' are
1020  * similar to those for the NXAST_REG_LOAD action. */
1021 struct nx_action_bundle {
1022     ovs_be16 type;              /* OFPAT_VENDOR. */
1023     ovs_be16 len;               /* Length including slaves. */
1024     ovs_be32 vendor;            /* NX_VENDOR_ID. */
1025     ovs_be16 subtype;           /* NXAST_BUNDLE or NXAST_BUNDLE_LOAD. */
1026
1027     /* Slave choice algorithm to apply to hash value. */
1028     ovs_be16 algorithm;         /* One of NX_BD_ALG_*. */
1029
1030     /* What fields to hash and how. */
1031     ovs_be16 fields;            /* One of NX_HASH_FIELDS_*. */
1032     ovs_be16 basis;             /* Universal hash parameter. */
1033
1034     ovs_be32 slave_type;        /* NXM_OF_IN_PORT. */
1035     ovs_be16 n_slaves;          /* Number of slaves. */
1036
1037     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
1038     ovs_be32 dst;               /* Destination. */
1039
1040     uint8_t zero[4];            /* Reserved. Must be zero. */
1041 };
1042 OFP_ASSERT(sizeof(struct nx_action_bundle) == 32);
1043
1044 /* NXAST_BUNDLE: Bundle slave choice algorithm to apply.
1045  *
1046  * In the descriptions below, 'slaves' is the list of possible slaves in the
1047  * order they appear in the OpenFlow action. */
1048 enum nx_bd_algorithm {
1049     /* Chooses the first live slave listed in the bundle.
1050      *
1051      * O(n_slaves) performance. */
1052     NX_BD_ALG_ACTIVE_BACKUP,
1053
1054     /* for i in [0,n_slaves):
1055      *   weights[i] = hash(flow, i)
1056      * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
1057      *
1058      * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
1059      * O(n_slaves) performance.
1060      *
1061      * Uses the 'fields' and 'basis' parameters. */
1062     NX_BD_ALG_HRW /* Highest Random Weight. */
1063 };
1064
1065 \f
1066 /* Action structure for NXAST_DEC_TTL_CNT_IDS.
1067  *
1068  * If the packet is not IPv4 or IPv6, does nothing.  For IPv4 or IPv6, if the
1069  * TTL or hop limit is at least 2, decrements it by 1.  Otherwise, if TTL or
1070  * hop limit is 0 or 1, sends a packet-in to the controllers with each of the
1071  * 'n_controllers' controller IDs specified in 'cnt_ids'.
1072  *
1073  * (This differs from NXAST_DEC_TTL in that for NXAST_DEC_TTL the packet-in is
1074  * sent only to controllers with id 0.)
1075  */
1076 struct nx_action_cnt_ids {
1077     ovs_be16 type;              /* OFPAT_VENDOR. */
1078     ovs_be16 len;               /* Length including slaves. */
1079     ovs_be32 vendor;            /* NX_VENDOR_ID. */
1080     ovs_be16 subtype;           /* NXAST_DEC_TTL_CNT_IDS. */
1081
1082     ovs_be16 n_controllers;     /* Number of controllers. */
1083     uint8_t zeros[4];           /* Must be zero. */
1084
1085     /* Followed by 1 or more controller ids.
1086      *
1087      * uint16_t cnt_ids[];        // Controller ids.
1088      * uint8_t pad[];           // Must be 0 to 8-byte align cnt_ids[].
1089      */
1090 };
1091 OFP_ASSERT(sizeof(struct nx_action_cnt_ids) == 16);
1092
1093 \f
1094 /* Action structure for NXAST_OUTPUT_REG.
1095  *
1096  * Outputs to the OpenFlow port number written to src[ofs:ofs+nbits].
1097  *
1098  * The format and semantics of 'src' and 'ofs_nbits' are similar to those for
1099  * the NXAST_REG_LOAD action.
1100  *
1101  * The acceptable nxm_header values for 'src' are the same as the acceptable
1102  * nxm_header values for the 'src' field of NXAST_REG_MOVE.
1103  *
1104  * The 'max_len' field indicates the number of bytes to send when the chosen
1105  * port is OFPP_CONTROLLER.  Its semantics are equivalent to the 'max_len'
1106  * field of OFPAT_OUTPUT.
1107  *
1108  * The 'zero' field is required to be zeroed for forward compatibility. */
1109 struct nx_action_output_reg {
1110     ovs_be16 type;              /* OFPAT_VENDOR. */
1111     ovs_be16 len;               /* 24. */
1112     ovs_be32 vendor;            /* NX_VENDOR_ID. */
1113     ovs_be16 subtype;           /* NXAST_OUTPUT_REG. */
1114
1115     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
1116     ovs_be32 src;               /* Source. */
1117
1118     ovs_be16 max_len;           /* Max length to send to controller. */
1119
1120     uint8_t zero[6];            /* Reserved, must be zero. */
1121 };
1122 OFP_ASSERT(sizeof(struct nx_action_output_reg) == 24);
1123 \f
1124 /* NXAST_EXIT
1125  *
1126  * Discontinues action processing.
1127  *
1128  * The NXAST_EXIT action causes the switch to immediately halt processing
1129  * actions for the flow.  Any actions which have already been processed are
1130  * executed by the switch.  However, any further actions, including those which
1131  * may be in different tables, or different levels of the NXAST_RESUBMIT
1132  * hierarchy, will be ignored.
1133  *
1134  * Uses the nx_action_header structure. */
1135 \f
1136 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
1137  *
1138  * OpenFlow 1.0 has "struct ofp10_match" for specifying flow matches.  This
1139  * structure is fixed-length and hence difficult to extend.  This section
1140  * describes a more flexible, variable-length flow match, called "nx_match" for
1141  * short, that is also supported by Open vSwitch.  This section also defines a
1142  * replacement for each OpenFlow message that includes struct ofp10_match.
1143  *
1144  *
1145  * Format
1146  * ======
1147  *
1148  * An nx_match is a sequence of zero or more "nxm_entry"s, which are
1149  * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
1150  * "nxm_entry"s are not aligned on or padded to any multibyte boundary.  The
1151  * first 4 bytes of an nxm_entry are its "header", followed by the entry's
1152  * "body".
1153  *
1154  * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
1155  *
1156  * |<-------------------- nxm_type ------------------>|
1157  * |                                                  |
1158  * |31                              16 15            9| 8 7                0
1159  * +----------------------------------+---------------+--+------------------+
1160  * |            nxm_vendor            |   nxm_field   |hm|    nxm_length    |
1161  * +----------------------------------+---------------+--+------------------+
1162  *
1163  * The most-significant 23 bits of the header are collectively "nxm_type".
1164  * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below.  Bits
1165  * 9...15 are "nxm_field", which is a vendor-specific value.  nxm_type normally
1166  * designates a protocol header, such as the Ethernet type, but it can also
1167  * refer to packet metadata, such as the switch port on which a packet arrived.
1168  *
1169  * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons).  The meaning
1170  * of this bit is explained later.
1171  *
1172  * The least-significant 8 bits are "nxm_length", a positive integer.  The
1173  * length of the nxm_entry, including the header, is exactly 4 + nxm_length
1174  * bytes.
1175  *
1176  * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
1177  * constant.  It is included only to allow software to minimally parse
1178  * "nxm_entry"s of unknown types.  (Similarly, for a given nxm_vendor,
1179  * nxm_field, and nxm_length, nxm_hasmask is a constant.)
1180  *
1181  *
1182  * Semantics
1183  * =========
1184  *
1185  * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
1186  *
1187  * An nxm_entry places a constraint on the packets matched by the nx_match:
1188  *
1189  *   - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
1190  *     field, called "nxm_value".  The nx_match matches only packets in which
1191  *     the field equals nxm_value.
1192  *
1193  *   - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
1194  *     field (nxm_value), followed by a bitmask of the same length as the
1195  *     value, called "nxm_mask".  For each 1-bit in position J in nxm_mask, the
1196  *     nx_match matches only packets for which bit J in the given field's value
1197  *     matches bit J in nxm_value.  A 0-bit in nxm_mask causes the
1198  *     corresponding bits in nxm_value and the field's value to be ignored.
1199  *     (The sense of the nxm_mask bits is the opposite of that used by the
1200  *     "wildcards" member of struct ofp10_match.)
1201  *
1202  *     When nxm_hasmask is 1, nxm_length is always even.
1203  *
1204  *     An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
1205  *     entirely.  An all-one-bits nxm_mask is equivalent to specifying 0 for
1206  *     nxm_hasmask.
1207  *
1208  * When there are multiple "nxm_entry"s, all of the constraints must be met.
1209  *
1210  *
1211  * Mask Restrictions
1212  * =================
1213  *
1214  * Masks may be restricted:
1215  *
1216  *   - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
1217  *     must always be 0 when these fields are specified.  For example, the
1218  *     field that identifies the port on which a packet was received may not be
1219  *     masked.
1220  *
1221  *   - Some nxm_types that do support masked wildcards may only support certain
1222  *     nxm_mask patterns.  For example, fields that have IPv4 address values
1223  *     may be restricted to CIDR masks.
1224  *
1225  * These restrictions should be noted in specifications for individual fields.
1226  * A switch may accept an nxm_hasmask or nxm_mask value that the specification
1227  * disallows, if the switch correctly implements support for that nxm_hasmask
1228  * or nxm_mask value.  A switch must reject an attempt to set up a flow that
1229  * contains a nxm_hasmask or nxm_mask value that it does not support.
1230  *
1231  *
1232  * Prerequisite Restrictions
1233  * =========================
1234  *
1235  * The presence of an nxm_entry with a given nxm_type may be restricted based
1236  * on the presence of or values of other "nxm_entry"s.  For example:
1237  *
1238  *   - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
1239  *     preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
1240  *     and nxm_value=0x0800.  That is, matching on the IP source address is
1241  *     allowed only if the Ethernet type is explicitly set to IP.
1242  *
1243  *   - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is
1244  *     preceded by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and
1245  *     nxm_value either 0x0800 or 0x86dd, and another with
1246  *     nxm_type=NXM_OF_IP_PROTO, nxm_hasmask=0, nxm_value=6, in that order.
1247  *     That is, matching on the TCP source port is allowed only if the Ethernet
1248  *     type is IP or IPv6 and the IP protocol is TCP.
1249  *
1250  * These restrictions should be noted in specifications for individual fields.
1251  * A switch may implement relaxed versions of these restrictions.  A switch
1252  * must reject an attempt to set up a flow that violates its restrictions.
1253  *
1254  *
1255  * Ordering Restrictions
1256  * =====================
1257  *
1258  * An nxm_entry that has prerequisite restrictions must appear after the
1259  * "nxm_entry"s for its prerequisites.  Ordering of "nxm_entry"s within an
1260  * nx_match is not otherwise constrained.
1261  *
1262  * Any given nxm_type may appear in an nx_match at most once.
1263  *
1264  *
1265  * nxm_entry Examples
1266  * ==================
1267  *
1268  * These examples show the format of a single nxm_entry with particular
1269  * nxm_hasmask and nxm_length values.  The diagrams are labeled with field
1270  * numbers and byte indexes.
1271  *
1272  *
1273  * 8-bit nxm_value, nxm_hasmask=1, nxm_length=2:
1274  *
1275  *  0          3  4   5
1276  * +------------+---+---+
1277  * |   header   | v | m |
1278  * +------------+---+---+
1279  *
1280  *
1281  * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
1282  *
1283  *  0          3 4    5
1284  * +------------+------+
1285  * |   header   | value|
1286  * +------------+------+
1287  *
1288  *
1289  * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
1290  *
1291  *  0          3 4           7
1292  * +------------+-------------+
1293  * |   header   |  nxm_value  |
1294  * +------------+-------------+
1295  *
1296  *
1297  * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
1298  *
1299  *  0          3 4                9
1300  * +------------+------------------+
1301  * |   header   |     nxm_value    |
1302  * +------------+------------------+
1303  *
1304  *
1305  * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
1306  *
1307  *  0          3 4                9 10              15
1308  * +------------+------------------+------------------+
1309  * |   header   |     nxm_value    |      nxm_mask    |
1310  * +------------+------------------+------------------+
1311  *
1312  *
1313  * Error Reporting
1314  * ===============
1315  *
1316  * A switch should report an error in an nx_match using error type
1317  * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes.  Ideally the switch
1318  * should report a specific error code, if one is assigned for the particular
1319  * problem, but NXBRC_NXM_INVALID is also available to report a generic
1320  * nx_match error.
1321  */
1322
1323 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
1324     (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
1325 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
1326     NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
1327 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
1328     NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
1329 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
1330 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
1331 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
1332 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
1333 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
1334
1335 #define NXM_MAKE_WILD_HEADER(HEADER) \
1336         NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
1337
1338 /* ## ------------------------------- ## */
1339 /* ## OpenFlow 1.0-compatible fields. ## */
1340 /* ## ------------------------------- ## */
1341
1342 /* Physical or virtual port on which the packet was received.
1343  *
1344  * Prereqs: None.
1345  *
1346  * Format: 16-bit integer in network byte order.
1347  *
1348  * Masking: Not maskable. */
1349 #define NXM_OF_IN_PORT    NXM_HEADER  (0x0000,  0, 2)
1350
1351 /* Source or destination address in Ethernet header.
1352  *
1353  * Prereqs: None.
1354  *
1355  * Format: 48-bit Ethernet MAC address.
1356  *
1357  * Masking: Fully maskable, in versions 1.8 and later. Earlier versions only
1358  *   supported the following masks for NXM_OF_ETH_DST_W: 00:00:00:00:00:00,
1359  *   fe:ff:ff:ff:ff:ff, 01:00:00:00:00:00, ff:ff:ff:ff:ff:ff. */
1360 #define NXM_OF_ETH_DST    NXM_HEADER  (0x0000,  1, 6)
1361 #define NXM_OF_ETH_DST_W  NXM_HEADER_W(0x0000,  1, 6)
1362 #define NXM_OF_ETH_SRC    NXM_HEADER  (0x0000,  2, 6)
1363 #define NXM_OF_ETH_SRC_W  NXM_HEADER_W(0x0000,  2, 6)
1364
1365 /* Packet's Ethernet type.
1366  *
1367  * For an Ethernet II packet this is taken from the Ethernet header.  For an
1368  * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
1369  * A packet that has neither format has value 0x05ff
1370  * (OFP_DL_TYPE_NOT_ETH_TYPE).
1371  *
1372  * For a packet with an 802.1Q header, this is the type of the encapsulated
1373  * frame.
1374  *
1375  * Prereqs: None.
1376  *
1377  * Format: 16-bit integer in network byte order.
1378  *
1379  * Masking: Not maskable. */
1380 #define NXM_OF_ETH_TYPE   NXM_HEADER  (0x0000,  3, 2)
1381
1382 /* 802.1Q TCI.
1383  *
1384  * For a packet with an 802.1Q header, this is the Tag Control Information
1385  * (TCI) field, with the CFI bit forced to 1.  For a packet with no 802.1Q
1386  * header, this has value 0.
1387  *
1388  * Prereqs: None.
1389  *
1390  * Format: 16-bit integer in network byte order.
1391  *
1392  * Masking: Arbitrary masks.
1393  *
1394  * This field can be used in various ways:
1395  *
1396  *   - If it is not constrained at all, the nx_match matches packets without
1397  *     an 802.1Q header or with an 802.1Q header that has any TCI value.
1398  *
1399  *   - Testing for an exact match with 0 matches only packets without an
1400  *     802.1Q header.
1401  *
1402  *   - Testing for an exact match with a TCI value with CFI=1 matches packets
1403  *     that have an 802.1Q header with a specified VID and PCP.
1404  *
1405  *   - Testing for an exact match with a nonzero TCI value with CFI=0 does
1406  *     not make sense.  The switch may reject this combination.
1407  *
1408  *   - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
1409  *     packets that have an 802.1Q header with that VID (and any PCP).
1410  *
1411  *   - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
1412  *     packets that have an 802.1Q header with that PCP (and any VID).
1413  *
1414  *   - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
1415  *     header or with an 802.1Q header with a VID of 0.
1416  *
1417  *   - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
1418  *     header or with an 802.1Q header with a PCP of 0.
1419  *
1420  *   - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
1421  *     header or with an 802.1Q header with both VID and PCP of 0.
1422  */
1423 #define NXM_OF_VLAN_TCI   NXM_HEADER  (0x0000,  4, 2)
1424 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000,  4, 2)
1425
1426 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
1427  *
1428  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1429  *
1430  * Format: 8-bit integer with 2 least-significant bits forced to 0.
1431  *
1432  * Masking: Not maskable. */
1433 #define NXM_OF_IP_TOS     NXM_HEADER  (0x0000,  5, 1)
1434
1435 /* The "protocol" byte in the IP header.
1436  *
1437  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1438  *
1439  * Format: 8-bit integer.
1440  *
1441  * Masking: Not maskable. */
1442 #define NXM_OF_IP_PROTO   NXM_HEADER  (0x0000,  6, 1)
1443
1444 /* The source or destination address in the IP header.
1445  *
1446  * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
1447  *
1448  * Format: 32-bit integer in network byte order.
1449  *
1450  * Masking: Fully maskable, in Open vSwitch 1.8 and later.  In earlier
1451  *   versions, only CIDR masks are allowed, that is, masks that consist of N
1452  *   high-order bits set to 1 and the other 32-N bits set to 0. */
1453 #define NXM_OF_IP_SRC     NXM_HEADER  (0x0000,  7, 4)
1454 #define NXM_OF_IP_SRC_W   NXM_HEADER_W(0x0000,  7, 4)
1455 #define NXM_OF_IP_DST     NXM_HEADER  (0x0000,  8, 4)
1456 #define NXM_OF_IP_DST_W   NXM_HEADER_W(0x0000,  8, 4)
1457
1458 /* The source or destination port in the TCP header.
1459  *
1460  * Prereqs:
1461  *   NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1462  *   NXM_OF_IP_PROTO must match 6 exactly.
1463  *
1464  * Format: 16-bit integer in network byte order.
1465  *
1466  * Masking: Fully maskable, in Open vSwitch 1.6 and later.  Not maskable, in
1467  *   earlier versions. */
1468 #define NXM_OF_TCP_SRC    NXM_HEADER  (0x0000,  9, 2)
1469 #define NXM_OF_TCP_SRC_W  NXM_HEADER_W(0x0000,  9, 2)
1470 #define NXM_OF_TCP_DST    NXM_HEADER  (0x0000, 10, 2)
1471 #define NXM_OF_TCP_DST_W  NXM_HEADER_W(0x0000, 10, 2)
1472
1473 /* The source or destination port in the UDP header.
1474  *
1475  * Prereqs:
1476  *   NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1477  *   NXM_OF_IP_PROTO must match 17 exactly.
1478  *
1479  * Format: 16-bit integer in network byte order.
1480  *
1481  * Masking: Fully maskable, in Open vSwitch 1.6 and later.  Not maskable, in
1482  *   earlier versions. */
1483 #define NXM_OF_UDP_SRC    NXM_HEADER  (0x0000, 11, 2)
1484 #define NXM_OF_UDP_SRC_W  NXM_HEADER_W(0x0000, 11, 2)
1485 #define NXM_OF_UDP_DST    NXM_HEADER  (0x0000, 12, 2)
1486 #define NXM_OF_UDP_DST_W  NXM_HEADER_W(0x0000, 12, 2)
1487
1488 /* The type or code in the ICMP header.
1489  *
1490  * Prereqs:
1491  *   NXM_OF_ETH_TYPE must match 0x0800 exactly.
1492  *   NXM_OF_IP_PROTO must match 1 exactly.
1493  *
1494  * Format: 8-bit integer.
1495  *
1496  * Masking: Not maskable. */
1497 #define NXM_OF_ICMP_TYPE  NXM_HEADER  (0x0000, 13, 1)
1498 #define NXM_OF_ICMP_CODE  NXM_HEADER  (0x0000, 14, 1)
1499
1500 /* ARP opcode.
1501  *
1502  * For an Ethernet+IP ARP packet, the opcode in the ARP header.  Always 0
1503  * otherwise.  Only ARP opcodes between 1 and 255 should be specified for
1504  * matching.
1505  *
1506  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1507  *
1508  * Format: 16-bit integer in network byte order.
1509  *
1510  * Masking: Not maskable. */
1511 #define NXM_OF_ARP_OP     NXM_HEADER  (0x0000, 15, 2)
1512
1513 /* For an Ethernet+IP ARP packet, the source or target protocol address
1514  * in the ARP header.  Always 0 otherwise.
1515  *
1516  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1517  *
1518  * Format: 32-bit integer in network byte order.
1519  *
1520  * Masking: Fully maskable, in Open vSwitch 1.8 and later.  In earlier
1521  *   versions, only CIDR masks are allowed, that is, masks that consist of N
1522  *   high-order bits set to 1 and the other 32-N bits set to 0. */
1523 #define NXM_OF_ARP_SPA    NXM_HEADER  (0x0000, 16, 4)
1524 #define NXM_OF_ARP_SPA_W  NXM_HEADER_W(0x0000, 16, 4)
1525 #define NXM_OF_ARP_TPA    NXM_HEADER  (0x0000, 17, 4)
1526 #define NXM_OF_ARP_TPA_W  NXM_HEADER_W(0x0000, 17, 4)
1527
1528 /* ## ------------------------ ## */
1529 /* ## Nicira match extensions. ## */
1530 /* ## ------------------------ ## */
1531
1532 /* Metadata registers.
1533  *
1534  * Registers initially have value 0.  Actions allow register values to be
1535  * manipulated.
1536  *
1537  * Prereqs: None.
1538  *
1539  * Format: Array of 32-bit integer registers.  Space is reserved for up to
1540  *   NXM_NX_MAX_REGS registers, but switches may implement fewer.
1541  *
1542  * Masking: Arbitrary masks. */
1543 #define NXM_NX_MAX_REGS 16
1544 #define NXM_NX_REG(IDX)   NXM_HEADER  (0x0001, IDX, 4)
1545 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1546 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1547 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1548 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1549 #define NXM_NX_REG0       NXM_HEADER  (0x0001, 0, 4)
1550 #define NXM_NX_REG0_W     NXM_HEADER_W(0x0001, 0, 4)
1551 #define NXM_NX_REG1       NXM_HEADER  (0x0001, 1, 4)
1552 #define NXM_NX_REG1_W     NXM_HEADER_W(0x0001, 1, 4)
1553 #define NXM_NX_REG2       NXM_HEADER  (0x0001, 2, 4)
1554 #define NXM_NX_REG2_W     NXM_HEADER_W(0x0001, 2, 4)
1555 #define NXM_NX_REG3       NXM_HEADER  (0x0001, 3, 4)
1556 #define NXM_NX_REG3_W     NXM_HEADER_W(0x0001, 3, 4)
1557 #define NXM_NX_REG4       NXM_HEADER  (0x0001, 4, 4)
1558 #define NXM_NX_REG4_W     NXM_HEADER_W(0x0001, 4, 4)
1559 #define NXM_NX_REG5       NXM_HEADER  (0x0001, 5, 4)
1560 #define NXM_NX_REG5_W     NXM_HEADER_W(0x0001, 5, 4)
1561 #define NXM_NX_REG6       NXM_HEADER  (0x0001, 6, 4)
1562 #define NXM_NX_REG6_W     NXM_HEADER_W(0x0001, 6, 4)
1563 #define NXM_NX_REG7       NXM_HEADER  (0x0001, 7, 4)
1564 #define NXM_NX_REG7_W     NXM_HEADER_W(0x0001, 7, 4)
1565
1566 /* Tunnel ID.
1567  *
1568  * For a packet received via GRE tunnel including a (32-bit) key, the key is
1569  * stored in the low 32-bits and the high bits are zeroed.  For other packets,
1570  * the value is 0.
1571  *
1572  * Prereqs: None.
1573  *
1574  * Format: 64-bit integer in network byte order.
1575  *
1576  * Masking: Arbitrary masks. */
1577 #define NXM_NX_TUN_ID     NXM_HEADER  (0x0001, 16, 8)
1578 #define NXM_NX_TUN_ID_W   NXM_HEADER_W(0x0001, 16, 8)
1579
1580 /* For an Ethernet+IP ARP packet, the source or target hardware address
1581  * in the ARP header.  Always 0 otherwise.
1582  *
1583  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1584  *
1585  * Format: 48-bit Ethernet MAC address.
1586  *
1587  * Masking: Not maskable. */
1588 #define NXM_NX_ARP_SHA    NXM_HEADER  (0x0001, 17, 6)
1589 #define NXM_NX_ARP_THA    NXM_HEADER  (0x0001, 18, 6)
1590
1591 /* The source or destination address in the IPv6 header.
1592  *
1593  * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1594  *
1595  * Format: 128-bit IPv6 address.
1596  *
1597  * Masking: Fully maskable, in Open vSwitch 1.8 and later.  In previous
1598  *   versions, only CIDR masks are allowed, that is, masks that consist of N
1599  *   high-order bits set to 1 and the other 128-N bits set to 0. */
1600 #define NXM_NX_IPV6_SRC    NXM_HEADER  (0x0001, 19, 16)
1601 #define NXM_NX_IPV6_SRC_W  NXM_HEADER_W(0x0001, 19, 16)
1602 #define NXM_NX_IPV6_DST    NXM_HEADER  (0x0001, 20, 16)
1603 #define NXM_NX_IPV6_DST_W  NXM_HEADER_W(0x0001, 20, 16)
1604
1605 /* The type or code in the ICMPv6 header.
1606  *
1607  * Prereqs:
1608  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1609  *   NXM_OF_IP_PROTO must match 58 exactly.
1610  *
1611  * Format: 8-bit integer.
1612  *
1613  * Masking: Not maskable. */
1614 #define NXM_NX_ICMPV6_TYPE NXM_HEADER  (0x0001, 21, 1)
1615 #define NXM_NX_ICMPV6_CODE NXM_HEADER  (0x0001, 22, 1)
1616
1617 /* The target address in an IPv6 Neighbor Discovery message.
1618  *
1619  * Prereqs:
1620  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1621  *   NXM_OF_IP_PROTO must match 58 exactly.
1622  *   NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1623  *
1624  * Format: 128-bit IPv6 address.
1625  *
1626  * Masking: Fully maskable, in Open vSwitch 1.8 and later.  In previous
1627  *   versions, only CIDR masks are allowed, that is, masks that consist of N
1628  *   high-order bits set to 1 and the other 128-N bits set to 0. */
1629 #define NXM_NX_ND_TARGET     NXM_HEADER    (0x0001, 23, 16)
1630 #define NXM_NX_ND_TARGET_W   NXM_HEADER_W  (0x0001, 23, 16)
1631
1632 /* The source link-layer address option in an IPv6 Neighbor Discovery
1633  * message.
1634  *
1635  * Prereqs:
1636  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1637  *   NXM_OF_IP_PROTO must match 58 exactly.
1638  *   NXM_OF_ICMPV6_TYPE must be exactly 135.
1639  *
1640  * Format: 48-bit Ethernet MAC address.
1641  *
1642  * Masking: Not maskable. */
1643 #define NXM_NX_ND_SLL      NXM_HEADER  (0x0001, 24, 6)
1644
1645 /* The target link-layer address option in an IPv6 Neighbor Discovery
1646  * message.
1647  *
1648  * Prereqs:
1649  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1650  *   NXM_OF_IP_PROTO must match 58 exactly.
1651  *   NXM_OF_ICMPV6_TYPE must be exactly 136.
1652  *
1653  * Format: 48-bit Ethernet MAC address.
1654  *
1655  * Masking: Not maskable. */
1656 #define NXM_NX_ND_TLL      NXM_HEADER  (0x0001, 25, 6)
1657
1658 /* IP fragment information.
1659  *
1660  * Prereqs:
1661  *   NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1662  *
1663  * Format: 8-bit value with one of the values 0, 1, or 3, as described below.
1664  *
1665  * Masking: Fully maskable.
1666  *
1667  * This field has three possible values:
1668  *
1669  *   - A packet that is not an IP fragment has value 0.
1670  *
1671  *   - A packet that is an IP fragment with offset 0 (the first fragment) has
1672  *     bit 0 set and thus value 1.
1673  *
1674  *   - A packet that is an IP fragment with nonzero offset has bits 0 and 1 set
1675  *     and thus value 3.
1676  *
1677  * NX_IP_FRAG_ANY and NX_IP_FRAG_LATER are declared to symbolically represent
1678  * the meanings of bits 0 and 1.
1679  *
1680  * The switch may reject matches against values that can never appear.
1681  *
1682  * It is important to understand how this field interacts with the OpenFlow IP
1683  * fragment handling mode:
1684  *
1685  *   - In OFPC_FRAG_DROP mode, the OpenFlow switch drops all IP fragments
1686  *     before they reach the flow table, so every packet that is available for
1687  *     matching will have value 0 in this field.
1688  *
1689  *   - Open vSwitch does not implement OFPC_FRAG_REASM mode, but if it did then
1690  *     IP fragments would be reassembled before they reached the flow table and
1691  *     again every packet available for matching would always have value 0.
1692  *
1693  *   - In OFPC_FRAG_NORMAL mode, all three values are possible, but OpenFlow
1694  *     1.0 says that fragments' transport ports are always 0, even for the
1695  *     first fragment, so this does not provide much extra information.
1696  *
1697  *   - In OFPC_FRAG_NX_MATCH mode, all three values are possible.  For
1698  *     fragments with offset 0, Open vSwitch makes L4 header information
1699  *     available.
1700  */
1701 #define NXM_NX_IP_FRAG     NXM_HEADER  (0x0001, 26, 1)
1702 #define NXM_NX_IP_FRAG_W   NXM_HEADER_W(0x0001, 26, 1)
1703
1704 /* Bits in the value of NXM_NX_IP_FRAG. */
1705 #define NX_IP_FRAG_ANY   (1 << 0) /* Is this a fragment? */
1706 #define NX_IP_FRAG_LATER (1 << 1) /* Is this a fragment with nonzero offset? */
1707
1708 /* The flow label in the IPv6 header.
1709  *
1710  * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1711  *
1712  * Format: 20-bit IPv6 flow label in least-significant bits.
1713  *
1714  * Masking: Not maskable. */
1715 #define NXM_NX_IPV6_LABEL  NXM_HEADER  (0x0001, 27, 4)
1716
1717 /* The ECN of the IP header.
1718  *
1719  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1720  *
1721  * Format: ECN in the low-order 2 bits.
1722  *
1723  * Masking: Not maskable. */
1724 #define NXM_NX_IP_ECN      NXM_HEADER  (0x0001, 28, 1)
1725
1726 /* The time-to-live/hop limit of the IP header.
1727  *
1728  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1729  *
1730  * Format: 8-bit integer.
1731  *
1732  * Masking: Not maskable. */
1733 #define NXM_NX_IP_TTL      NXM_HEADER  (0x0001, 29, 1)
1734
1735 /* Flow cookie.
1736  *
1737  * This may be used to gain the OpenFlow 1.1-like ability to restrict
1738  * certain NXM-based Flow Mod and Flow Stats Request messages to flows
1739  * with specific cookies.  See the "nx_flow_mod" and "nx_flow_stats_request"
1740  * structure definitions for more details.  This match is otherwise not
1741  * allowed.
1742  *
1743  * Prereqs: None.
1744  *
1745  * Format: 64-bit integer in network byte order.
1746  *
1747  * Masking: Arbitrary masks. */
1748 #define NXM_NX_COOKIE     NXM_HEADER  (0x0001, 30, 8)
1749 #define NXM_NX_COOKIE_W   NXM_HEADER_W(0x0001, 30, 8)
1750
1751 /* ## --------------------- ## */
1752 /* ## Requests and replies. ## */
1753 /* ## --------------------- ## */
1754
1755 enum nx_flow_format {
1756     NXFF_OPENFLOW10 = 0,         /* Standard OpenFlow 1.0 compatible. */
1757     NXFF_NXM = 2,                /* Nicira extended match. */
1758     NXFF_OPENFLOW12 = 3          /* OpenFlow 1.2 format. */
1759 };
1760
1761 /* NXT_SET_FLOW_FORMAT request. */
1762 struct nx_set_flow_format {
1763     ovs_be32 format;            /* One of NXFF_*. */
1764 };
1765 OFP_ASSERT(sizeof(struct nx_set_flow_format) == 4);
1766
1767 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD).
1768  *
1769  * It is possible to limit flow deletions and modifications to certain
1770  * cookies by using the NXM_NX_COOKIE(_W) matches.  The "cookie" field
1771  * is used only to add or modify flow cookies.
1772  */
1773 struct nx_flow_mod {
1774     ovs_be64 cookie;              /* Opaque controller-issued identifier. */
1775     ovs_be16 command;             /* One of OFPFC_*. */
1776     ovs_be16 idle_timeout;        /* Idle time before discarding (seconds). */
1777     ovs_be16 hard_timeout;        /* Max time before discarding (seconds). */
1778     ovs_be16 priority;            /* Priority level of flow entry. */
1779     ovs_be32 buffer_id;           /* Buffered packet to apply to (or -1).
1780                                      Not meaningful for OFPFC_DELETE*. */
1781     ovs_be16 out_port;            /* For OFPFC_DELETE* commands, require
1782                                      matching entries to include this as an
1783                                      output port.  A value of OFPP_NONE
1784                                      indicates no restriction. */
1785     ovs_be16 flags;               /* One of OFPFF_*. */
1786     ovs_be16 match_len;           /* Size of nx_match. */
1787     uint8_t pad[6];               /* Align to 64-bits. */
1788     /* Followed by:
1789      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1790      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1791      *     all-zero bytes, then
1792      *   - Actions to fill out the remainder of the message length (always a
1793      *     multiple of 8).
1794      */
1795 };
1796 OFP_ASSERT(sizeof(struct nx_flow_mod) == 32);
1797
1798 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1799 struct nx_flow_removed {
1800     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
1801     ovs_be16 priority;        /* Priority level of flow entry. */
1802     uint8_t reason;           /* One of OFPRR_*. */
1803     uint8_t pad[1];           /* Align to 32-bits. */
1804     ovs_be32 duration_sec;    /* Time flow was alive in seconds. */
1805     ovs_be32 duration_nsec;   /* Time flow was alive in nanoseconds beyond
1806                                  duration_sec. */
1807     ovs_be16 idle_timeout;    /* Idle timeout from original flow mod. */
1808     ovs_be16 match_len;       /* Size of nx_match. */
1809     ovs_be64 packet_count;
1810     ovs_be64 byte_count;
1811     /* Followed by:
1812      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1813      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1814      *     all-zero bytes. */
1815 };
1816 OFP_ASSERT(sizeof(struct nx_flow_removed) == 40);
1817
1818 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1819  * request).
1820  *
1821  * It is possible to limit matches to certain cookies by using the
1822  * NXM_NX_COOKIE and NXM_NX_COOKIE_W matches.
1823  */
1824 struct nx_flow_stats_request {
1825     ovs_be16 out_port;        /* Require matching entries to include this
1826                                  as an output port.  A value of OFPP_NONE
1827                                  indicates no restriction. */
1828     ovs_be16 match_len;       /* Length of nx_match. */
1829     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
1830                                  or 0xff for all tables. */
1831     uint8_t pad[3];           /* Align to 64 bits. */
1832     /* Followed by:
1833      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1834      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1835      *     all-zero bytes, which must also exactly fill out the length of the
1836      *     message.
1837      */
1838 };
1839 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 8);
1840
1841 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1842  * OFPST_FLOW reply).
1843  *
1844  * The values of 'idle_age' and 'hard_age' are only meaningful when talking to
1845  * a switch that implements the NXT_FLOW_AGE extension.  Zero means that the
1846  * true value is unknown, perhaps because hardware does not track the value.
1847  * (Zero is also the value that one should ordinarily expect to see talking to
1848  * a switch that does not implement NXT_FLOW_AGE, since those switches zero the
1849  * padding bytes that these fields replaced.)  A nonzero value X represents X-1
1850  * seconds.  A value of 65535 represents 65534 or more seconds.
1851  *
1852  * 'idle_age' is the number of seconds that the flow has been idle, that is,
1853  * the number of seconds since a packet passed through the flow.  'hard_age' is
1854  * the number of seconds since the flow was last modified (e.g. OFPFC_MODIFY or
1855  * OFPFC_MODIFY_STRICT).  (The 'duration_*' fields are the elapsed time since
1856  * the flow was added, regardless of subsequent modifications.)
1857  *
1858  * For a flow with an idle or hard timeout, 'idle_age' or 'hard_age',
1859  * respectively, will ordinarily be smaller than the timeout, but flow
1860  * expiration times are only approximate and so one must be prepared to
1861  * tolerate expirations that occur somewhat early or late.
1862  */
1863 struct nx_flow_stats {
1864     ovs_be16 length;          /* Length of this entry. */
1865     uint8_t table_id;         /* ID of table flow came from. */
1866     uint8_t pad;
1867     ovs_be32 duration_sec;    /* Time flow has been alive in seconds. */
1868     ovs_be32 duration_nsec;   /* Time flow has been alive in nanoseconds
1869                                  beyond duration_sec. */
1870     ovs_be16 priority;        /* Priority of the entry. */
1871     ovs_be16 idle_timeout;    /* Number of seconds idle before expiration. */
1872     ovs_be16 hard_timeout;    /* Number of seconds before expiration. */
1873     ovs_be16 match_len;       /* Length of nx_match. */
1874     ovs_be16 idle_age;        /* Seconds since last packet, plus one. */
1875     ovs_be16 hard_age;        /* Seconds since last modification, plus one. */
1876     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
1877     ovs_be64 packet_count;    /* Number of packets, UINT64_MAX if unknown. */
1878     ovs_be64 byte_count;      /* Number of bytes, UINT64_MAX if unknown. */
1879     /* Followed by:
1880      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1881      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1882      *     all-zero bytes, then
1883      *   - Actions to fill out the remainder 'length' bytes (always a multiple
1884      *     of 8).
1885      */
1886 };
1887 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1888
1889 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1890  * OFPST_AGGREGATE request).
1891  *
1892  * The reply format is identical to the reply format for OFPST_AGGREGATE,
1893  * except for the header. */
1894 struct nx_aggregate_stats_request {
1895     ovs_be16 out_port;        /* Require matching entries to include this
1896                                  as an output port.  A value of OFPP_NONE
1897                                  indicates no restriction. */
1898     ovs_be16 match_len;       /* Length of nx_match. */
1899     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
1900                                  or 0xff for all tables. */
1901     uint8_t pad[3];           /* Align to 64 bits. */
1902     /* Followed by:
1903      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1904      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1905      *     all-zero bytes, which must also exactly fill out the length of the
1906      *     message.
1907      */
1908 };
1909 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 8);
1910 \f
1911 /* NXT_SET_CONTROLLER_ID.
1912  *
1913  * Each OpenFlow controller connection has a 16-bit identifier that is
1914  * initially 0.  This message changes the connection's ID to 'id'.
1915  *
1916  * Controller connection IDs need not be unique.
1917  *
1918  * The NXAST_CONTROLLER action is the only current user of controller
1919  * connection IDs. */
1920 struct nx_controller_id {
1921     uint8_t zero[6];            /* Must be zero. */
1922     ovs_be16 controller_id;     /* New controller connection ID. */
1923 };
1924 OFP_ASSERT(sizeof(struct nx_controller_id) == 8);
1925
1926 /* Action structure for NXAST_CONTROLLER.
1927  *
1928  * This generalizes using OFPAT_OUTPUT to send a packet to OFPP_CONTROLLER.  In
1929  * addition to the 'max_len' that OFPAT_OUTPUT supports, it also allows
1930  * specifying:
1931  *
1932  *    - 'reason': The reason code to use in the ofp_packet_in or nx_packet_in.
1933  *
1934  *    - 'controller_id': The ID of the controller connection to which the
1935  *      ofp_packet_in should be sent.  The ofp_packet_in or nx_packet_in is
1936  *      sent only to controllers that have the specified controller connection
1937  *      ID.  See "struct nx_controller_id" for more information. */
1938 struct nx_action_controller {
1939     ovs_be16 type;                  /* OFPAT_VENDOR. */
1940     ovs_be16 len;                   /* Length is 16. */
1941     ovs_be32 vendor;                /* NX_VENDOR_ID. */
1942     ovs_be16 subtype;               /* NXAST_CONTROLLER. */
1943     ovs_be16 max_len;               /* Maximum length to send to controller. */
1944     ovs_be16 controller_id;         /* Controller ID to send packet-in. */
1945     uint8_t reason;                 /* enum ofp_packet_in_reason (OFPR_*). */
1946     uint8_t zero;                   /* Must be zero. */
1947 };
1948 OFP_ASSERT(sizeof(struct nx_action_controller) == 16);
1949 \f
1950 /* Flow Table Monitoring
1951  * =====================
1952  *
1953  * NXST_FLOW_MONITOR allows a controller to keep track of changes to OpenFlow
1954  * flow table(s) or subsets of them, with the following workflow:
1955  *
1956  * 1. The controller sends an NXST_FLOW_MONITOR request to begin monitoring
1957  *    flows.  The 'id' in the request must be unique among all monitors that
1958  *    the controller has started and not yet canceled on this OpenFlow
1959  *    connection.
1960  *
1961  * 2. The switch responds with an NXST_FLOW_MONITOR reply.  If the request's
1962  *    'flags' included NXFMF_INITIAL, the reply includes all the flows that
1963  *    matched the request at the time of the request (with event NXFME_ADDED).
1964  *    If 'flags' did not include NXFMF_INITIAL, the reply is empty.
1965  *
1966  *    The reply uses the xid of the request (as do all replies to OpenFlow
1967  *    requests).
1968  *
1969  * 3. Whenever a change to a flow table entry matches some outstanding monitor
1970  *    request's criteria and flags, the switch sends a notification to the
1971  *    controller as an additional NXST_FLOW_MONITOR reply with xid 0.
1972  *
1973  *    When multiple outstanding monitors match a single change, only a single
1974  *    notification is sent.  This merged notification includes the information
1975  *    requested in any of the individual monitors.  That is, if any of the
1976  *    matching monitors requests actions (NXFMF_ACTIONS), the notification
1977  *    includes actions, and if any of the monitors request full changes for the
1978  *    controller's own changes (NXFMF_OWN), the controller's own changes will
1979  *    be included in full.
1980  *
1981  * 4. The controller may cancel a monitor with NXT_FLOW_MONITOR_CANCEL.  No
1982  *    further notifications will be sent on the basis of the canceled monitor
1983  *    afterward.
1984  *
1985  *
1986  * Buffer Management
1987  * =================
1988  *
1989  * OpenFlow messages for flow monitor notifications can overflow the buffer
1990  * space available to the switch, either temporarily (e.g. due to network
1991  * conditions slowing OpenFlow traffic) or more permanently (e.g. the sustained
1992  * rate of flow table change exceeds the network bandwidth between switch and
1993  * controller).
1994  *
1995  * When Open vSwitch's notification buffer space reaches a limiting threshold,
1996  * OVS reacts as follows:
1997  *
1998  * 1. OVS sends an NXT_FLOW_MONITOR_PAUSED message to the controller, following
1999  *    all the already queued notifications.  After it receives this message,
2000  *    the controller knows that its view of the flow table, as represented by
2001  *    flow monitor notifications, is incomplete.
2002  *
2003  * 2. As long as the notification buffer is not empty:
2004  *
2005  *        - NXMFE_ADD and NXFME_MODIFIED notifications will not be sent.
2006  *
2007  *        - NXFME_DELETED notifications will still be sent, but only for flows
2008  *          that existed before OVS sent NXT_FLOW_MONITOR_PAUSED.
2009  *
2010  *        - NXFME_ABBREV notifications will not be sent.  They are treated as
2011  *          the expanded version (and therefore only the NXFME_DELETED
2012  *          components, if any, are sent).
2013  *
2014  * 3. When the notification buffer empties, OVS sends NXFME_ADD notifications
2015  *    for flows added since the buffer reached its limit and NXFME_MODIFIED
2016  *    notifications for flows that existed before the limit was reached and
2017  *    changed after the limit was reached.
2018  *
2019  * 4. OVS sends an NXT_FLOW_MONITOR_RESUMED message to the controller.  After
2020  *    it receives this message, the controller knows that its view of the flow
2021  *    table, as represented by flow monitor notifications, is again complete.
2022  *
2023  * This allows the maximum buffer space requirement for notifications to be
2024  * bounded by the limit plus the maximum number of supported flows.
2025  *
2026  *
2027  * "Flow Removed" messages
2028  * =======================
2029  *
2030  * The flow monitor mechanism is independent of OFPT_FLOW_REMOVED and
2031  * NXT_FLOW_REMOVED.  Flow monitor updates for deletion are sent if
2032  * NXFMF_DELETE is set on a monitor, regardless of whether the
2033  * OFPFF_SEND_FLOW_REM flag was set when the flow was added. */
2034
2035 /* NXST_FLOW_MONITOR request.
2036  *
2037  * The NXST_FLOW_MONITOR request's body consists of an array of zero or more
2038  * instances of this structure.  The request arranges to monitor the flows
2039  * that match the specified criteria, which are interpreted in the same way as
2040  * for NXST_FLOW.
2041  *
2042  * 'id' identifies a particular monitor for the purpose of allowing it to be
2043  * canceled later with NXT_FLOW_MONITOR_CANCEL.  'id' must be unique among
2044  * existing monitors that have not already been canceled.
2045  *
2046  * The reply includes the initial flow matches for monitors that have the
2047  * NXFMF_INITIAL flag set.  No single flow will be included in the reply more
2048  * than once, even if more than one requested monitor matches that flow.  The
2049  * reply will be empty if none of the monitors has NXFMF_INITIAL set or if none
2050  * of the monitors initially matches any flows.
2051  *
2052  * For NXFMF_ADD, an event will be reported if 'out_port' matches against the
2053  * actions of the flow being added or, for a flow that is replacing an existing
2054  * flow, if 'out_port' matches against the actions of the flow being replaced.
2055  * For NXFMF_DELETE, 'out_port' matches against the actions of a flow being
2056  * deleted.  For NXFMF_MODIFY, an event will be reported if 'out_port' matches
2057  * either the old or the new actions. */
2058 struct nx_flow_monitor_request {
2059     ovs_be32 id;                /* Controller-assigned ID for this monitor. */
2060     ovs_be16 flags;             /* NXFMF_*. */
2061     ovs_be16 out_port;          /* Required output port, if not OFPP_NONE. */
2062     ovs_be16 match_len;         /* Length of nx_match. */
2063     uint8_t table_id;           /* One table's ID or 0xff for all tables. */
2064     uint8_t zeros[5];           /* Align to 64 bits (must be zero). */
2065     /* Followed by:
2066      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
2067      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
2068      *     all-zero bytes. */
2069 };
2070 OFP_ASSERT(sizeof(struct nx_flow_monitor_request) == 16);
2071
2072 /* 'flags' bits in struct nx_flow_monitor_request. */
2073 enum nx_flow_monitor_flags {
2074     /* When to send updates. */
2075     NXFMF_INITIAL = 1 << 0,     /* Initially matching flows. */
2076     NXFMF_ADD = 1 << 1,         /* New matching flows as they are added. */
2077     NXFMF_DELETE = 1 << 2,      /* Old matching flows as they are removed. */
2078     NXFMF_MODIFY = 1 << 3,      /* Matching flows as they are changed. */
2079
2080     /* What to include in updates. */
2081     NXFMF_ACTIONS = 1 << 4,     /* If set, actions are included. */
2082     NXFMF_OWN = 1 << 5,         /* If set, include own changes in full. */
2083 };
2084
2085 /* NXST_FLOW_MONITOR reply header.
2086  *
2087  * The body of an NXST_FLOW_MONITOR reply is an array of variable-length
2088  * structures, each of which begins with this header.  The 'length' member may
2089  * be used to traverse the array, and the 'event' member may be used to
2090  * determine the particular structure.
2091  *
2092  * Every instance is a multiple of 8 bytes long. */
2093 struct nx_flow_update_header {
2094     ovs_be16 length;            /* Length of this entry. */
2095     ovs_be16 event;             /* One of NXFME_*. */
2096     /* ...other data depending on 'event'... */
2097 };
2098 OFP_ASSERT(sizeof(struct nx_flow_update_header) == 4);
2099
2100 /* 'event' values in struct nx_flow_update_header. */
2101 enum nx_flow_update_event {
2102     /* struct nx_flow_update_full. */
2103     NXFME_ADDED = 0,            /* Flow was added. */
2104     NXFME_DELETED = 1,          /* Flow was deleted. */
2105     NXFME_MODIFIED = 2,         /* Flow (generally its actions) was changed. */
2106
2107     /* struct nx_flow_update_abbrev. */
2108     NXFME_ABBREV = 3,           /* Abbreviated reply. */
2109 };
2110
2111 /* NXST_FLOW_MONITOR reply for NXFME_ADDED, NXFME_DELETED, and
2112  * NXFME_MODIFIED. */
2113 struct nx_flow_update_full {
2114     ovs_be16 length;            /* Length is 24. */
2115     ovs_be16 event;             /* One of NXFME_*. */
2116     ovs_be16 reason;            /* OFPRR_* for NXFME_DELETED, else zero. */
2117     ovs_be16 priority;          /* Priority of the entry. */
2118     ovs_be16 idle_timeout;      /* Number of seconds idle before expiration. */
2119     ovs_be16 hard_timeout;      /* Number of seconds before expiration. */
2120     ovs_be16 match_len;         /* Length of nx_match. */
2121     uint8_t table_id;           /* ID of flow's table. */
2122     uint8_t pad;                /* Reserved, currently zeroed. */
2123     ovs_be64 cookie;            /* Opaque controller-issued identifier. */
2124     /* Followed by:
2125      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
2126      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
2127      *     all-zero bytes, then
2128      *   - Actions to fill out the remainder 'length' bytes (always a multiple
2129      *     of 8).  If NXFMF_ACTIONS was not specified, or 'event' is
2130      *     NXFME_DELETED, no actions are included.
2131      */
2132 };
2133 OFP_ASSERT(sizeof(struct nx_flow_update_full) == 24);
2134
2135 /* NXST_FLOW_MONITOR reply for NXFME_ABBREV.
2136  *
2137  * When the controller does not specify NXFMF_OWN in a monitor request, any
2138  * flow tables changes due to the controller's own requests (on the same
2139  * OpenFlow channel) will be abbreviated, when possible, to this form, which
2140  * simply specifies the 'xid' of the OpenFlow request (e.g. an OFPT_FLOW_MOD or
2141  * NXT_FLOW_MOD) that caused the change.
2142  *
2143  * Some changes cannot be abbreviated and will be sent in full:
2144  *
2145  *   - Changes that only partially succeed.  This can happen if, for example,
2146  *     a flow_mod with type OFPFC_MODIFY affects multiple flows, but only some
2147  *     of those modifications succeed (e.g. due to hardware limitations).
2148  *
2149  *     This cannot occur with the current implementation of the Open vSwitch
2150  *     software datapath.  It could happen with other datapath implementations.
2151  *
2152  *   - Changes that race with conflicting changes made by other controllers or
2153  *     other flow_mods (not separated by barriers) by the same controller.
2154  *
2155  *     This cannot occur with the current Open vSwitch implementation
2156  *     (regardless of datapath) because Open vSwitch internally serializes
2157  *     potentially conflicting changes.
2158  *
2159  * A flow_mod that does not change the flow table will not trigger any
2160  * notification, even an abbreviated one.  For example, a "modify" or "delete"
2161  * flow_mod that does not match any flows will not trigger a notification.
2162  * Whether an "add" or "modify" that specifies all the same parameters that a
2163  * flow already has triggers a notification is unspecified and subject to
2164  * change in future versions of Open vSwitch.
2165  *
2166  * OVS will always send the notifications for a given flow table change before
2167  * the reply to a OFPT_BARRIER_REQUEST request that precedes the flow table
2168  * change.  Thus, if the controller does not receive an abbreviated
2169  * notification for a flow_mod before the next OFPT_BARRIER_REPLY, it will
2170  * never receive one. */
2171 struct nx_flow_update_abbrev {
2172     ovs_be16 length;            /* Length is 8. */
2173     ovs_be16 event;             /* NXFME_ABBREV. */
2174     ovs_be32 xid;               /* Controller-specified xid from flow_mod. */
2175 };
2176 OFP_ASSERT(sizeof(struct nx_flow_update_abbrev) == 8);
2177
2178 /* NXT_FLOW_MONITOR_CANCEL.
2179  *
2180  * Used by a controller to cancel an outstanding monitor. */
2181 struct nx_flow_monitor_cancel {
2182     ovs_be32 id;                /* 'id' from nx_flow_monitor_request. */
2183 };
2184 OFP_ASSERT(sizeof(struct nx_flow_monitor_cancel) == 4);
2185
2186 #endif /* openflow/nicira-ext.h */