bbe96b35bbbd7ad5baffb2a1b2534ba5f10d89e3
[openvswitch] / include / openflow / nicira-ext.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks
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 Networks, 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 /* Specific Nicira extension error numbers.
71  *
72  * These are the "code" values used in nx_vendor_error.  So far, the "type"
73  * values in nx_vendor_error are the same as those in ofp_error_msg.  That is,
74  * at Nicira so far we've only needed additional vendor-specific 'code' values,
75  * so we're using the existing 'type' values to avoid having to invent new ones
76  * that duplicate the current ones' meanings. */
77
78 /* Additional "code" values for OFPET_BAD_REQUEST. */
79 enum nx_bad_request_code {
80 /* Nicira Extended Match (NXM) errors. */
81
82     /* Generic error code used when there is an error in an NXM sent to the
83      * switch.  The switch may use one of the more specific error codes below,
84      * if there is an appropriate one, to simplify debugging, but it is not
85      * required to do so. */
86     NXBRC_NXM_INVALID = 0x100,
87
88     /* The nxm_type, or nxm_type taken in combination with nxm_hasmask or
89      * nxm_length or both, is invalid or not implemented. */
90     NXBRC_NXM_BAD_TYPE = 0x101,
91
92     /* Invalid nxm_value. */
93     NXBRC_NXM_BAD_VALUE = 0x102,
94
95     /* Invalid nxm_mask. */
96     NXBRC_NXM_BAD_MASK = 0x103,
97
98     /* A prerequisite was not met. */
99     NXBRC_NXM_BAD_PREREQ = 0x104,
100
101     /* A given nxm_type was specified more than once. */
102     NXBRC_NXM_DUP_TYPE = 0x105
103 };
104
105 /* Additional "code" values for OFPET_FLOW_MOD_FAILED. */
106 enum nx_flow_mod_failed_code {
107     /* Generic hardware error. */
108     NXFMFC_HARDWARE = 0x100,
109
110     /* A nonexistent table ID was specified in the "command" field of struct
111      * ofp_flow_mod, when the nxt_flow_mod_table_id extension is enabled. */
112     NXFMFC_BAD_TABLE_ID = 0x101
113 };
114 \f
115 /* Nicira vendor requests and replies. */
116
117 /* Header for Nicira vendor requests and replies. */
118 struct nicira_header {
119     struct ofp_header header;
120     ovs_be32 vendor;            /* NX_VENDOR_ID. */
121     ovs_be32 subtype;           /* One of NXT_* below. */
122 };
123 OFP_ASSERT(sizeof(struct nicira_header) == 16);
124
125 /* Values for the 'subtype' member of struct nicira_header. */
126 enum nicira_type {
127     /* No longer used. */
128     NXT_STATUS_REQUEST__OBSOLETE = 0,
129     NXT_STATUS_REPLY__OBSOLETE = 1,
130     NXT_ACT_SET_CONFIG__OBSOLETE = 2,
131     NXT_ACT_GET_CONFIG__OBSOLETE = 3,
132     NXT_COMMAND_REQUEST__OBSOLETE = 4,
133     NXT_COMMAND_REPLY__OBSOLETE = 5,
134     NXT_FLOW_END_CONFIG__OBSOLETE = 6,
135     NXT_FLOW_END__OBSOLETE = 7,
136     NXT_MGMT__OBSOLETE = 8,
137     NXT_TUN_ID_FROM_COOKIE__OBSOLETE = 9,
138
139     /* Controller role support.  The request body is struct nx_role_request.
140      * The reply echos the request. */
141     NXT_ROLE_REQUEST = 10,
142     NXT_ROLE_REPLY = 11,
143
144     /* Flexible flow specification (aka NXM = Nicira Extended Match). */
145     NXT_SET_FLOW_FORMAT = 12,   /* Set flow format. */
146     NXT_FLOW_MOD = 13,          /* Analogous to OFPT_FLOW_MOD. */
147     NXT_FLOW_REMOVED = 14,      /* Analogous to OFPT_FLOW_REMOVED. */
148
149     /* Use the upper 8 bits of the 'command' member in struct ofp_flow_mod to
150      * designate the table to which a flow is to be added?  See the big comment
151      * on struct nxt_flow_mod_table_id for more information. */
152     NXT_FLOW_MOD_TABLE_ID = 15
153 };
154
155 /* Header for Nicira vendor stats request and reply messages. */
156 struct nicira_stats_msg {
157     struct ofp_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
158     ovs_be32 subtype;           /* One of NXST_* below. */
159     uint8_t pad[4];             /* Align to 64-bits. */
160 };
161 OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
162
163 /* Values for the 'subtype' member of struct nicira_stats_msg. */
164 enum nicira_stats_type {
165     /* Flexible flow specification (aka NXM = Nicira Extended Match). */
166     NXST_FLOW,                  /* Analogous to OFPST_FLOW. */
167     NXST_AGGREGATE              /* Analogous to OFPST_AGGREGATE. */
168 };
169
170 /* Fields to use when hashing flows. */
171 enum nx_hash_fields {
172     /* Ethernet source address (NXM_OF_ETH_SRC) only. */
173     NX_HASH_FIELDS_ETH_SRC,
174
175     /* L2 through L4, symmetric across src/dst.  Specifically, each of the
176      * following fields, if present, is hashed (slashes separate symmetric
177      * pairs):
178      *
179      *  - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
180      *  - NXM_OF_ETH_TYPE
181      *  - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
182      *  - NXM_OF_IP_PROTO
183      *  - NXM_OF_IP_SRC / NXM_OF_IP_DST
184      *  - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
185      */
186     NX_HASH_FIELDS_SYMMETRIC_L4
187 };
188
189 /* This command enables or disables an Open vSwitch extension that allows a
190  * controller to specify the OpenFlow table to which a flow should be added,
191  * instead of having the switch decide which table is most appropriate as
192  * required by OpenFlow 1.0.  By default, the extension is disabled.
193  *
194  * When this feature is enabled, Open vSwitch treats struct ofp_flow_mod's
195  * 16-bit 'command' member as two separate fields.  The upper 8 bits are used
196  * as the table ID, the lower 8 bits specify the command as usual.  A table ID
197  * of 0xff is treated like a wildcarded table ID.
198  *
199  * The specific treatment of the table ID depends on the type of flow mod:
200  *
201  *    - OFPFC_ADD: Given a specific table ID, the flow is always placed in that
202  *      table.  If an identical flow already exists in that table only, then it
203  *      is replaced.  If the flow cannot be placed in the specified table,
204  *      either because the table is full or because the table cannot support
205  *      flows of the given type, the switch replies with an
206  *      OFPFMFC_ALL_TABLES_FULL error.  (A controller can distinguish these
207  *      cases by comparing the current and maximum number of entries reported
208  *      in ofp_table_stats.)
209  *
210  *      If the table ID is wildcarded, the switch picks an appropriate table
211  *      itself.  If an identical flow already exist in the selected flow table,
212  *      then it is replaced.  The choice of table might depend on the flows
213  *      that are already in the switch; for example, if one table fills up then
214  *      the switch might fall back to another one.
215  *
216  *    - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows
217  *      within that table are matched and modified or deleted.  If the table ID
218  *      is wildcarded, flows within any table may be matched and modified or
219  *      deleted.
220  *
221  *    - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID,
222  *      only a flow within that table may be matched and modified or deleted.
223  *      If the table ID is wildcarded and exactly one flow within any table
224  *      matches, then it is modified or deleted; if flows in more than one
225  *      table match, then none is modified or deleted.
226  */
227 struct nxt_flow_mod_table_id {
228     struct ofp_header header;
229     uint32_t vendor;            /* NX_VENDOR_ID. */
230     uint32_t subtype;           /* NXT_FLOW_MOD_TABLE_ID. */
231     uint8_t set;                /* Nonzero to enable, zero to disable. */
232     uint8_t pad[7];
233 };
234 OFP_ASSERT(sizeof(struct nxt_flow_mod_table_id) == 24);
235
236 /* Configures the "role" of the sending controller.  The default role is:
237  *
238  *    - Other (NX_ROLE_OTHER), which allows the controller access to all
239  *      OpenFlow features.
240  *
241  * The other possible roles are a related pair:
242  *
243  *    - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
244  *      be at most one Master controller at a time: when a controller
245  *      configures itself as Master, any existing Master is demoted to the
246  *      Slave role.
247  *
248  *    - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
249  *      OpenFlow features.  In particular attempts to modify the flow table
250  *      will be rejected with an OFPBRC_EPERM error.
251  *
252  *      Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
253  *      messages, but they do receive OFPT_PORT_STATUS messages.
254  */
255 struct nx_role_request {
256     struct nicira_header nxh;
257     ovs_be32 role;              /* One of NX_ROLE_*. */
258 };
259
260 enum nx_role {
261     NX_ROLE_OTHER,              /* Default role, full access. */
262     NX_ROLE_MASTER,             /* Full access, at most one. */
263     NX_ROLE_SLAVE               /* Read-only access. */
264 };
265 \f
266 /* Nicira vendor flow actions. */
267
268 enum nx_action_subtype {
269     NXAST_SNAT__OBSOLETE,       /* No longer used. */
270     NXAST_RESUBMIT,             /* struct nx_action_resubmit */
271     NXAST_SET_TUNNEL,           /* struct nx_action_set_tunnel */
272     NXAST_DROP_SPOOFED_ARP__OBSOLETE,
273     NXAST_SET_QUEUE,            /* struct nx_action_set_queue */
274     NXAST_POP_QUEUE,            /* struct nx_action_pop_queue */
275     NXAST_REG_MOVE,             /* struct nx_action_reg_move */
276     NXAST_REG_LOAD,             /* struct nx_action_reg_load */
277     NXAST_NOTE,                 /* struct nx_action_note */
278     NXAST_SET_TUNNEL64,         /* struct nx_action_set_tunnel64 */
279     NXAST_MULTIPATH,            /* struct nx_action_multipath */
280     NXAST_AUTOPATH,             /* struct nx_action_autopath */
281     NXAST_BUNDLE,               /* struct nx_action_bundle */
282     NXAST_BUNDLE_LOAD,          /* struct nx_action_bundle */
283     NXAST_RESUBMIT_TABLE        /* struct nx_action_resubmit */
284 };
285
286 /* Header for Nicira-defined actions. */
287 struct nx_action_header {
288     ovs_be16 type;                  /* OFPAT_VENDOR. */
289     ovs_be16 len;                   /* Length is 16. */
290     ovs_be32 vendor;                /* NX_VENDOR_ID. */
291     ovs_be16 subtype;               /* NXAST_*. */
292     uint8_t pad[6];
293 };
294 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
295
296 /* Action structures for NXAST_RESUBMIT and NXAST_RESUBMIT_TABLE.
297  *
298  * These actions search one of the switch's flow tables:
299  *
300  *    - For NXAST_RESUBMIT_TABLE only, if the 'table' member is not 255, then
301  *      it specifies the table to search.
302  *
303  *    - Otherwise (for NXAST_RESUBMIT_TABLE with a 'table' of 255, or for
304  *      NXAST_RESUBMIT regardless of 'table'), it searches the current flow
305  *      table, that is, the OpenFlow flow table that contains the flow from
306  *      which this action was obtained.  If this action did not come from a
307  *      flow table (e.g. it came from an OFPT_PACKET_OUT message), then table 0
308  *      is the current table.
309  *
310  * The flow table lookup uses a flow that may be slightly modified from the
311  * original lookup:
312  *
313  *    - For NXAST_RESUBMIT, the 'in_port' member of struct nx_action_resubmit
314  *      is used as the flow's in_port.
315  *
316  *    - For NXAST_RESUBMIT_TABLE, if the 'in_port' member is not OFPP_IN_PORT,
317  *      then its value is used as the flow's in_port.  Otherwise, the original
318  *      in_port is used.
319  *
320  *    - If actions that modify the flow (e.g. OFPAT_SET_VLAN_VID) precede the
321  *      resubmit action, then the flow is updated with the new values.
322  *
323  * Following the lookup, the original in_port is restored.
324  *
325  * If the modified flow matched in the flow table, then the corresponding
326  * actions are executed.  Afterward, actions following the resubmit in the
327  * original set of actions, if any, are executed; any changes made to the
328  * packet (e.g. changes to VLAN) by secondary actions persist when those
329  * actions are executed, although the original in_port is restored.
330  *
331  * Resubmit actions may be used any number of times within a set of actions.
332  *
333  * Resubmit actions may nest to an implementation-defined depth.  Beyond this
334  * implementation-defined depth, further resubmit actions are simply ignored.
335  *
336  * NXAST_RESUBMIT ignores 'table' and 'pad'.  NXAST_RESUBMIT_TABLE requires
337  * 'pad' to be all-bits-zero.
338  *
339  * Open vSwitch 1.0.1 and earlier did not support recursion.  Open vSwitch
340  * before 1.2.90 did not support NXAST_RESUBMIT_TABLE.
341  */
342 struct nx_action_resubmit {
343     ovs_be16 type;                  /* OFPAT_VENDOR. */
344     ovs_be16 len;                   /* Length is 16. */
345     ovs_be32 vendor;                /* NX_VENDOR_ID. */
346     ovs_be16 subtype;               /* NXAST_RESUBMIT. */
347     ovs_be16 in_port;               /* New in_port for checking flow table. */
348     uint8_t table;                  /* NXAST_RESUBMIT_TABLE: table to use. */
349     uint8_t pad[3];
350 };
351 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
352
353 /* Action structure for NXAST_SET_TUNNEL.
354  *
355  * Sets the encapsulating tunnel ID to a 32-bit value.  The most-significant 32
356  * bits of the tunnel ID are set to 0. */
357 struct nx_action_set_tunnel {
358     ovs_be16 type;                  /* OFPAT_VENDOR. */
359     ovs_be16 len;                   /* Length is 16. */
360     ovs_be32 vendor;                /* NX_VENDOR_ID. */
361     ovs_be16 subtype;               /* NXAST_SET_TUNNEL. */
362     uint8_t pad[2];
363     ovs_be32 tun_id;                /* Tunnel ID. */
364 };
365 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
366
367 /* Action structure for NXAST_SET_TUNNEL64.
368  *
369  * Sets the encapsulating tunnel ID to a 64-bit value. */
370 struct nx_action_set_tunnel64 {
371     ovs_be16 type;                  /* OFPAT_VENDOR. */
372     ovs_be16 len;                   /* Length is 16. */
373     ovs_be32 vendor;                /* NX_VENDOR_ID. */
374     ovs_be16 subtype;               /* NXAST_SET_TUNNEL64. */
375     uint8_t pad[6];
376     ovs_be64 tun_id;                /* Tunnel ID. */
377 };
378 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
379
380 /* Action structure for NXAST_SET_QUEUE.
381  *
382  * Set the queue that should be used when packets are output.  This is similar
383  * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
384  * an argument.  This allows the queue to be defined before the port is
385  * known. */
386 struct nx_action_set_queue {
387     ovs_be16 type;                  /* OFPAT_VENDOR. */
388     ovs_be16 len;                   /* Length is 16. */
389     ovs_be32 vendor;                /* NX_VENDOR_ID. */
390     ovs_be16 subtype;               /* NXAST_SET_QUEUE. */
391     uint8_t pad[2];
392     ovs_be32 queue_id;              /* Where to enqueue packets. */
393 };
394 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
395
396 /* Action structure for NXAST_POP_QUEUE.
397  *
398  * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
399  * were used.  Only the original queue can be restored this way; no stack is
400  * maintained. */
401 struct nx_action_pop_queue {
402     ovs_be16 type;                  /* OFPAT_VENDOR. */
403     ovs_be16 len;                   /* Length is 16. */
404     ovs_be32 vendor;                /* NX_VENDOR_ID. */
405     ovs_be16 subtype;               /* NXAST_POP_QUEUE. */
406     uint8_t pad[6];
407 };
408 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
409
410 /* Action structure for NXAST_REG_MOVE.
411  *
412  * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
413  * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
414  * bit 'c').  Bit numbering starts at 0 for the least-significant bit, 1 for
415  * the next most significant bit, and so on.
416  *
417  * 'src' and 'dst' are nxm_header values with nxm_hasmask=0.  (It doesn't make
418  * sense to use nxm_hasmask=1 because the action does not do any kind of
419  * matching; it uses the actual value of a field.)
420  *
421  * The following nxm_header values are potentially acceptable as 'src':
422  *
423  *   - NXM_OF_IN_PORT
424  *   - NXM_OF_ETH_DST
425  *   - NXM_OF_ETH_SRC
426  *   - NXM_OF_ETH_TYPE
427  *   - NXM_OF_VLAN_TCI
428  *   - NXM_OF_IP_TOS
429  *   - NXM_OF_IP_PROTO
430  *   - NXM_OF_IP_SRC
431  *   - NXM_OF_IP_DST
432  *   - NXM_OF_TCP_SRC
433  *   - NXM_OF_TCP_DST
434  *   - NXM_OF_UDP_SRC
435  *   - NXM_OF_UDP_DST
436  *   - NXM_OF_ICMP_TYPE
437  *   - NXM_OF_ICMP_CODE
438  *   - NXM_OF_ARP_OP
439  *   - NXM_OF_ARP_SPA
440  *   - NXM_OF_ARP_TPA
441  *   - NXM_NX_TUN_ID
442  *   - NXM_NX_ARP_SHA
443  *   - NXM_NX_ARP_THA
444  *   - NXM_NX_ICMPV6_TYPE
445  *   - NXM_NX_ICMPV6_CODE
446  *   - NXM_NX_ND_SLL
447  *   - NXM_NX_ND_TLL
448  *   - NXM_NX_REG(idx) for idx in the switch's accepted range.
449  *
450  * The following nxm_header values are potentially acceptable as 'dst':
451  *
452  *   - NXM_OF_ETH_DST
453  *   - NXM_OF_ETH_SRC
454  *   - NXM_OF_IP_TOS
455  *   - NXM_OF_IP_SRC
456  *   - NXM_OF_IP_DST
457  *   - NXM_OF_TCP_SRC
458  *   - NXM_OF_TCP_DST
459  *   - NXM_OF_UDP_SRC
460  *   - NXM_OF_UDP_DST
461  *     Modifying any of the above fields changes the corresponding packet
462  *     header.
463  *
464  *   - NXM_NX_REG(idx) for idx in the switch's accepted range.
465  *
466  *   - NXM_OF_VLAN_TCI.  Modifying this field's value has side effects on the
467  *     packet's 802.1Q header.  Setting a value with CFI=0 removes the 802.1Q
468  *     header (if any), ignoring the other bits.  Setting a value with CFI=1
469  *     adds or modifies the 802.1Q header appropriately, setting the TCI field
470  *     to the field's new value (with the CFI bit masked out).
471  *
472  *   - NXM_NX_TUN_ID.  Modifying this value modifies the tunnel ID used for the
473  *     packet's next tunnel encapsulation.
474  *
475  * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
476  * nx_match satisfies its prerequisites.  For example, NXM_OF_IP_TOS may be
477  * used only if the flow's nx_match includes an nxm_entry that specifies
478  * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
479  *
480  * The switch will reject actions for which src_ofs+n_bits is greater than the
481  * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
482  * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
483  */
484 struct nx_action_reg_move {
485     ovs_be16 type;                  /* OFPAT_VENDOR. */
486     ovs_be16 len;                   /* Length is 16. */
487     ovs_be32 vendor;                /* NX_VENDOR_ID. */
488     ovs_be16 subtype;               /* NXAST_REG_MOVE. */
489     ovs_be16 n_bits;                /* Number of bits. */
490     ovs_be16 src_ofs;               /* Starting bit offset in source. */
491     ovs_be16 dst_ofs;               /* Starting bit offset in destination. */
492     ovs_be32 src;                   /* Source register. */
493     ovs_be32 dst;                   /* Destination register. */
494 };
495 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
496
497 /* Action structure for NXAST_REG_LOAD.
498  *
499  * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
500  * within 'a' numbered 'b' through 'c' (not including bit 'c').  Bit numbering
501  * starts at 0 for the least-significant bit, 1 for the next most significant
502  * bit, and so on.
503  *
504  * 'dst' is an nxm_header with nxm_hasmask=0.  See the documentation for
505  * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
506  * loading them.
507  *
508  * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
509  * to avoid enlarging the structure by another 8 bytes.  To allow 'n_bits' to
510  * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
511  * also stored as one less than its true value:
512  *
513  *  15                           6 5                0
514  * +------------------------------+------------------+
515  * |              ofs             |    n_bits - 1    |
516  * +------------------------------+------------------+
517  *
518  * The switch will reject actions for which ofs+n_bits is greater than the
519  * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
520  * greater are set to 1, with error type OFPET_BAD_ACTION, code
521  * OFPBAC_BAD_ARGUMENT.
522  */
523 struct nx_action_reg_load {
524     ovs_be16 type;                  /* OFPAT_VENDOR. */
525     ovs_be16 len;                   /* Length is 16. */
526     ovs_be32 vendor;                /* NX_VENDOR_ID. */
527     ovs_be16 subtype;               /* NXAST_REG_LOAD. */
528     ovs_be16 ofs_nbits;             /* (ofs << 6) | (n_bits - 1). */
529     ovs_be32 dst;                   /* Destination register. */
530     ovs_be64 value;                 /* Immediate value. */
531 };
532 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
533
534 /* Action structure for NXAST_NOTE.
535  *
536  * This action has no effect.  It is variable length.  The switch does not
537  * attempt to interpret the user-defined 'note' data in any way.  A controller
538  * can use this action to attach arbitrary metadata to a flow.
539  *
540  * This action might go away in the future.
541  */
542 struct nx_action_note {
543     ovs_be16 type;                  /* OFPAT_VENDOR. */
544     ovs_be16 len;                   /* A multiple of 8, but at least 16. */
545     ovs_be32 vendor;                /* NX_VENDOR_ID. */
546     ovs_be16 subtype;               /* NXAST_NOTE. */
547     uint8_t note[6];                /* Start of user-defined data. */
548     /* Possibly followed by additional user-defined data. */
549 };
550 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
551
552 /* Action structure for NXAST_MULTIPATH.
553  *
554  * This action performs the following steps in sequence:
555  *
556  *    1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
557  *       Refer to the definition of "enum nx_mp_fields" for details.
558  *
559  *       The 'basis' value is used as a universal hash parameter, that is,
560  *       different values of 'basis' yield different hash functions.  The
561  *       particular universal hash function used is implementation-defined.
562  *
563  *       The hashed fields' values are drawn from the current state of the
564  *       flow, including all modifications that have been made by actions up to
565  *       this point.
566  *
567  *    2. Applies the multipath link choice algorithm specified by 'algorithm',
568  *       one of NX_MP_ALG_*.  Refer to the definition of "enum nx_mp_algorithm"
569  *       for details.
570  *
571  *       The output of the algorithm is 'link', an unsigned integer less than
572  *       or equal to 'max_link'.
573  *
574  *       Some algorithms use 'arg' as an additional argument.
575  *
576  *    3. Stores 'link' in dst[ofs:ofs+n_bits].  The format and semantics of
577  *       'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
578  *       action.
579  *
580  * The switch will reject actions that have an unknown 'fields', or an unknown
581  * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
582  * in which 'max_link' is greater than or equal to 2**n_bits, with error type
583  * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
584  */
585 struct nx_action_multipath {
586     ovs_be16 type;              /* OFPAT_VENDOR. */
587     ovs_be16 len;               /* Length is 32. */
588     ovs_be32 vendor;            /* NX_VENDOR_ID. */
589     ovs_be16 subtype;           /* NXAST_MULTIPATH. */
590
591     /* What fields to hash and how. */
592     ovs_be16 fields;            /* One of NX_HASH_FIELDS_*. */
593     ovs_be16 basis;             /* Universal hash parameter. */
594     ovs_be16 pad0;
595
596     /* Multipath link choice algorithm to apply to hash value. */
597     ovs_be16 algorithm;         /* One of NX_MP_ALG_*. */
598     ovs_be16 max_link;          /* Number of output links, minus 1. */
599     ovs_be32 arg;               /* Algorithm-specific argument. */
600     ovs_be16 pad1;
601
602     /* Where to store the result. */
603     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
604     ovs_be32 dst;               /* Destination. */
605 };
606 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
607
608 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
609  *
610  * In the descriptions below, 'n_links' is max_link + 1. */
611 enum nx_mp_algorithm {
612     /* link = hash(flow) % n_links.
613      *
614      * Redistributes all traffic when n_links changes.  O(1) performance.  See
615      * RFC 2992.
616      *
617      * Use UINT16_MAX for max_link to get a raw hash value. */
618     NX_MP_ALG_MODULO_N,
619
620     /* link = hash(flow) / (MAX_HASH / n_links).
621      *
622      * Redistributes between one-quarter and one-half of traffic when n_links
623      * changes.  O(1) performance.  See RFC 2992.
624      */
625     NX_MP_ALG_HASH_THRESHOLD,
626
627     /* for i in [0,n_links):
628      *   weights[i] = hash(flow, i)
629      * link = { i such that weights[i] >= weights[j] for all j != i }
630      *
631      * Redistributes 1/n_links of traffic when n_links changes.  O(n_links)
632      * performance.  If n_links is greater than a threshold (currently 64, but
633      * subject to change), Open vSwitch will substitute another algorithm
634      * automatically.  See RFC 2992. */
635     NX_MP_ALG_HRW,              /* Highest Random Weight. */
636
637     /* i = 0
638      * repeat:
639      *     i = i + 1
640      *     link = hash(flow, i) % arg
641      * while link > max_link
642      *
643      * Redistributes 1/n_links of traffic when n_links changes.  O(1)
644      * performance when arg/max_link is bounded by a constant.
645      *
646      * Redistributes all traffic when arg changes.
647      *
648      * arg must be greater than max_link and for best performance should be no
649      * more than approximately max_link * 2.  If arg is outside the acceptable
650      * range, Open vSwitch will automatically substitute the least power of 2
651      * greater than max_link.
652      *
653      * This algorithm is specific to Open vSwitch.
654      */
655     NX_MP_ALG_ITER_HASH         /* Iterative Hash. */
656 };
657 \f
658 /* Action structure for NXAST_AUTOPATH.
659  *
660  * This action performs the following steps in sequence:
661  *
662  *    1. Hashes the flow using an implementation-defined hash function.
663  *
664  *       The hashed fields' values are drawn from the current state of the
665  *       flow, including all modifications that have been made by actions up to
666  *       this point.
667  *
668  *    2. Selects an OpenFlow 'port'.
669  *
670  *       'port' is selected in an implementation-defined manner, taking into
671  *       account 'id' and the hash value calculated in step 1.
672  *
673  *       Generally a switch will have been configured with a set of ports that
674  *       may be chosen given 'id'.  The switch may take into account any number
675  *       of factors when choosing 'port' from its configured set.  Factors may
676  *       include carrier, load, and the results of configuration protocols such
677  *       as LACP.
678  *
679  *    3. Stores 'port' in dst[ofs:ofs+n_bits].
680  *
681  *       The format and semantics of 'dst' and 'ofs_nbits' are similar to those
682  *       for the NXAST_REG_LOAD action.
683  *
684  * The switch will reject actions in which ofs+n_bits is greater than the width
685  * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
686  */
687 struct nx_action_autopath {
688     ovs_be16 type;              /* OFPAT_VENDOR. */
689     ovs_be16 len;               /* Length is 20. */
690     ovs_be32 vendor;            /* NX_VENDOR_ID. */
691     ovs_be16 subtype;           /* NXAST_AUTOPATH. */
692
693     /* Where to store the result. */
694     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
695     ovs_be32 dst;               /* Destination. */
696
697     ovs_be32 id;                /* Autopath ID. */
698     ovs_be32 pad;
699 };
700 OFP_ASSERT(sizeof(struct nx_action_autopath) == 24);
701 \f
702 /* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD.
703  *
704  * The bundle actions choose a slave from a supplied list of options.
705  * NXAST_BUNDLE outputs to its selection.  NXAST_BUNDLE_LOAD writes its
706  * selection to a register.
707  *
708  * The list of possible slaves follows the nx_action_bundle structure. The size
709  * of each slave is governed by its type as indicated by the 'slave_type'
710  * parameter. The list of slaves should be padded at its end with zeros to make
711  * the total length of the action a multiple of 8.
712  *
713  * Switches infer from the 'slave_type' parameter the size of each slave.  All
714  * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
715  * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
716  * 2 byte width.  Switches should reject actions which indicate unknown or
717  * unsupported slave types.
718  *
719  * Switches use a strategy dictated by the 'algorithm' parameter to choose a
720  * slave.  If the switch does not support the specified 'algorithm' parameter,
721  * it should reject the action.
722  *
723  * Some slave selection strategies require the use of a hash function, in which
724  * case the 'fields' and 'basis' parameters should be populated.  The 'fields'
725  * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
726  * hash.  Refer to the definition of "enum nx_hash_fields" for details.  The
727  * 'basis' parameter is used as a universal hash parameter.  Different values
728  * of 'basis' yield different hash results.
729  *
730  * The 'zero' parameter at the end of the action structure is reserved for
731  * future use.  Switches are required to reject actions which have nonzero
732  * bytes in the 'zero' field.
733  *
734  * NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed.  Switches
735  * should reject actions which have nonzero bytes in either of these fields.
736  *
737  * NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in
738  * dst[ofs:ofs+n_bits].  The format and semantics of 'dst' and 'ofs_nbits' are
739  * similar to those for the NXAST_REG_LOAD action. */
740 struct nx_action_bundle {
741     ovs_be16 type;              /* OFPAT_VENDOR. */
742     ovs_be16 len;               /* Length including slaves. */
743     ovs_be32 vendor;            /* NX_VENDOR_ID. */
744     ovs_be16 subtype;           /* NXAST_BUNDLE. */
745
746     /* Slave choice algorithm to apply to hash value. */
747     ovs_be16 algorithm;         /* One of NX_BD_ALG_*. */
748
749     /* What fields to hash and how. */
750     ovs_be16 fields;            /* One of NX_BD_FIELDS_*. */
751     ovs_be16 basis;             /* Universal hash parameter. */
752
753     ovs_be32 slave_type;        /* NXM_OF_IN_PORT. */
754     ovs_be16 n_slaves;          /* Number of slaves. */
755
756     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
757     ovs_be32 dst;               /* Destination. */
758
759     uint8_t zero[4];            /* Reserved. Must be zero. */
760 };
761 OFP_ASSERT(sizeof(struct nx_action_bundle) == 32);
762
763 /* NXAST_BUNDLE: Bundle slave choice algorithm to apply.
764  *
765  * In the descriptions below, 'slaves' is the list of possible slaves in the
766  * order they appear in the OpenFlow action. */
767 enum nx_bd_algorithm {
768     /* Chooses the first live slave listed in the bundle.
769      *
770      * O(n_slaves) performance. */
771     NX_BD_ALG_ACTIVE_BACKUP,
772
773     /* for i in [0,n_slaves):
774      *   weights[i] = hash(flow, i)
775      * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
776      *
777      * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
778      * O(n_slaves) performance.
779      *
780      * Uses the 'fields' and 'basis' parameters. */
781     NX_BD_ALG_HRW /* Highest Random Weight. */
782 };
783 \f
784 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
785  *
786  * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches.  This
787  * structure is fixed-length and hence difficult to extend.  This section
788  * describes a more flexible, variable-length flow match, called "nx_match" for
789  * short, that is also supported by Open vSwitch.  This section also defines a
790  * replacement for each OpenFlow message that includes struct ofp_match.
791  *
792  *
793  * Format
794  * ======
795  *
796  * An nx_match is a sequence of zero or more "nxm_entry"s, which are
797  * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
798  * "nxm_entry"s are not aligned on or padded to any multibyte boundary.  The
799  * first 4 bytes of an nxm_entry are its "header", followed by the entry's
800  * "body".
801  *
802  * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
803  *
804  * |<-------------------- nxm_type ------------------>|
805  * |                                                  |
806  * |31                              16 15            9| 8 7                0
807  * +----------------------------------+---------------+--+------------------+
808  * |            nxm_vendor            |   nxm_field   |hm|    nxm_length    |
809  * +----------------------------------+---------------+--+------------------+
810  *
811  * The most-significant 23 bits of the header are collectively "nxm_type".
812  * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below.  Bits
813  * 9...15 are "nxm_field", which is a vendor-specific value.  nxm_type normally
814  * designates a protocol header, such as the Ethernet type, but it can also
815  * refer to packet metadata, such as the switch port on which a packet arrived.
816  *
817  * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons).  The meaning
818  * of this bit is explained later.
819  *
820  * The least-significant 8 bits are "nxm_length", a positive integer.  The
821  * length of the nxm_entry, including the header, is exactly 4 + nxm_length
822  * bytes.
823  *
824  * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
825  * constant.  It is included only to allow software to minimally parse
826  * "nxm_entry"s of unknown types.  (Similarly, for a given nxm_vendor,
827  * nxm_field, and nxm_length, nxm_hasmask is a constant.)
828  *
829  *
830  * Semantics
831  * =========
832  *
833  * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
834  *
835  * An nxm_entry places a constraint on the packets matched by the nx_match:
836  *
837  *   - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
838  *     field, called "nxm_value".  The nx_match matches only packets in which
839  *     the field equals nxm_value.
840  *
841  *   - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
842  *     field (nxm_value), followed by a bitmask of the same length as the
843  *     value, called "nxm_mask".  For each 1-bit in position J in nxm_mask, the
844  *     nx_match matches only packets for which bit J in the given field's value
845  *     matches bit J in nxm_value.  A 0-bit in nxm_mask causes the
846  *     corresponding bits in nxm_value and the field's value to be ignored.
847  *     (The sense of the nxm_mask bits is the opposite of that used by the
848  *     "wildcards" member of struct ofp_match.)
849  *
850  *     When nxm_hasmask is 1, nxm_length is always even.
851  *
852  *     An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
853  *     entirely.  An all-one-bits nxm_mask is equivalent to specifying 0 for
854  *     nxm_hasmask.
855  *
856  * When there are multiple "nxm_entry"s, all of the constraints must be met.
857  *
858  *
859  * Mask Restrictions
860  * =================
861  *
862  * Masks may be restricted:
863  *
864  *   - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
865  *     must always be 0 when these fields are specified.  For example, the
866  *     field that identifies the port on which a packet was received may not be
867  *     masked.
868  *
869  *   - Some nxm_types that do support masked wildcards may only support certain
870  *     nxm_mask patterns.  For example, fields that have IPv4 address values
871  *     may be restricted to CIDR masks.
872  *
873  * These restrictions should be noted in specifications for individual fields.
874  * A switch may accept an nxm_hasmask or nxm_mask value that the specification
875  * disallows, if the switch correctly implements support for that nxm_hasmask
876  * or nxm_mask value.  A switch must reject an attempt to set up a flow that
877  * contains a nxm_hasmask or nxm_mask value that it does not support.
878  *
879  *
880  * Prerequisite Restrictions
881  * =========================
882  *
883  * The presence of an nxm_entry with a given nxm_type may be restricted based
884  * on the presence of or values of other "nxm_entry"s.  For example:
885  *
886  *   - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
887  *     preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
888  *     and nxm_value=0x0800.  That is, matching on the IP source address is
889  *     allowed only if the Ethernet type is explicitly set to IP.
890  *
891  *   - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is preced
892  *     by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
893  *     nxm_value=0x0800 and another with nxm_type=NXM_OF_IP_PROTO,
894  *     nxm_hasmask=0, nxm_value=6, in that order.  That is, matching on the TCP
895  *     source port is allowed only if the Ethernet type is IP and the IP
896  *     protocol is TCP.
897  *
898  * These restrictions should be noted in specifications for individual fields.
899  * A switch may implement relaxed versions of these restrictions.  A switch
900  * must reject an attempt to set up a flow that violates its restrictions.
901  *
902  *
903  * Ordering Restrictions
904  * =====================
905  *
906  * An nxm_entry that has prerequisite restrictions must appear after the
907  * "nxm_entry"s for its prerequisites.  Ordering of "nxm_entry"s within an
908  * nx_match is not otherwise constrained.
909  *
910  * Any given nxm_type may appear in an nx_match at most once.
911  *
912  *
913  * nxm_entry Examples
914  * ==================
915  *
916  * These examples show the format of a single nxm_entry with particular
917  * nxm_hasmask and nxm_length values.  The diagrams are labeled with field
918  * numbers and byte indexes.
919  *
920  *
921  * 8-bit nxm_value, nxm_hasmask=1, nxm_length=2:
922  *
923  *  0          3  4   5
924  * +------------+---+---+
925  * |   header   | v | m |
926  * +------------+---+---+
927  *
928  *
929  * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
930  *
931  *  0          3 4    5
932  * +------------+------+
933  * |   header   | value|
934  * +------------+------+
935  *
936  *
937  * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
938  *
939  *  0          3 4           7
940  * +------------+-------------+
941  * |   header   |  nxm_value  |
942  * +------------+-------------+
943  *
944  *
945  * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
946  *
947  *  0          3 4                9
948  * +------------+------------------+
949  * |   header   |     nxm_value    |
950  * +------------+------------------+
951  *
952  *
953  * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
954  *
955  *  0          3 4                9 10              15
956  * +------------+------------------+------------------+
957  * |   header   |     nxm_value    |      nxm_mask    |
958  * +------------+------------------+------------------+
959  *
960  *
961  * Error Reporting
962  * ===============
963  *
964  * A switch should report an error in an nx_match using error type
965  * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes.  Ideally the switch
966  * should report a specific error code, if one is assigned for the particular
967  * problem, but NXBRC_NXM_INVALID is also available to report a generic
968  * nx_match error.
969  */
970
971 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
972     (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
973 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
974     NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
975 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
976     NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
977 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
978 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
979 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
980 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
981 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
982
983 #define NXM_MAKE_WILD_HEADER(HEADER) \
984         NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
985
986 /* ## ------------------------------- ## */
987 /* ## OpenFlow 1.0-compatible fields. ## */
988 /* ## ------------------------------- ## */
989
990 /* Physical or virtual port on which the packet was received.
991  *
992  * Prereqs: None.
993  *
994  * Format: 16-bit integer in network byte order.
995  *
996  * Masking: Not maskable. */
997 #define NXM_OF_IN_PORT    NXM_HEADER  (0x0000,  0, 2)
998
999 /* Source or destination address in Ethernet header.
1000  *
1001  * Prereqs: None.
1002  *
1003  * Format: 48-bit Ethernet MAC address.
1004  *
1005  * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
1006  *   be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
1007  *   are all-0-bits or all-1-bits).  Support for other patterns and for masking
1008  *   of NXM_OF_ETH_SRC is optional. */
1009 #define NXM_OF_ETH_DST    NXM_HEADER  (0x0000,  1, 6)
1010 #define NXM_OF_ETH_DST_W  NXM_HEADER_W(0x0000,  1, 6)
1011 #define NXM_OF_ETH_SRC    NXM_HEADER  (0x0000,  2, 6)
1012
1013 /* Packet's Ethernet type.
1014  *
1015  * For an Ethernet II packet this is taken from the Ethernet header.  For an
1016  * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
1017  * A packet that has neither format has value 0x05ff
1018  * (OFP_DL_TYPE_NOT_ETH_TYPE).
1019  *
1020  * For a packet with an 802.1Q header, this is the type of the encapsulated
1021  * frame.
1022  *
1023  * Prereqs: None.
1024  *
1025  * Format: 16-bit integer in network byte order.
1026  *
1027  * Masking: Not maskable. */
1028 #define NXM_OF_ETH_TYPE   NXM_HEADER  (0x0000,  3, 2)
1029
1030 /* 802.1Q TCI.
1031  *
1032  * For a packet with an 802.1Q header, this is the Tag Control Information
1033  * (TCI) field, with the CFI bit forced to 1.  For a packet with no 802.1Q
1034  * header, this has value 0.
1035  *
1036  * Prereqs: None.
1037  *
1038  * Format: 16-bit integer in network byte order.
1039  *
1040  * Masking: Arbitrary masks.
1041  *
1042  * This field can be used in various ways:
1043  *
1044  *   - If it is not constrained at all, the nx_match matches packets without
1045  *     an 802.1Q header or with an 802.1Q header that has any TCI value.
1046  *
1047  *   - Testing for an exact match with 0 matches only packets without an
1048  *     802.1Q header.
1049  *
1050  *   - Testing for an exact match with a TCI value with CFI=1 matches packets
1051  *     that have an 802.1Q header with a specified VID and PCP.
1052  *
1053  *   - Testing for an exact match with a nonzero TCI value with CFI=0 does
1054  *     not make sense.  The switch may reject this combination.
1055  *
1056  *   - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
1057  *     packets that have an 802.1Q header with that VID (and any PCP).
1058  *
1059  *   - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
1060  *     packets that have an 802.1Q header with that PCP (and any VID).
1061  *
1062  *   - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
1063  *     header or with an 802.1Q header with a VID of 0.
1064  *
1065  *   - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
1066  *     header or with an 802.1Q header with a PCP of 0.
1067  *
1068  *   - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
1069  *     header or with an 802.1Q header with both VID and PCP of 0.
1070  */
1071 #define NXM_OF_VLAN_TCI   NXM_HEADER  (0x0000,  4, 2)
1072 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000,  4, 2)
1073
1074 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
1075  *
1076  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1077  *
1078  * Format: 8-bit integer with 2 least-significant bits forced to 0.
1079  *
1080  * Masking: Not maskable. */
1081 #define NXM_OF_IP_TOS     NXM_HEADER  (0x0000,  5, 1)
1082
1083 /* The "protocol" byte in the IP header.
1084  *
1085  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1086  *
1087  * Format: 8-bit integer.
1088  *
1089  * Masking: Not maskable. */
1090 #define NXM_OF_IP_PROTO   NXM_HEADER  (0x0000,  6, 1)
1091
1092 /* The source or destination address in the IP header.
1093  *
1094  * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
1095  *
1096  * Format: 32-bit integer in network byte order.
1097  *
1098  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1099  *   high-order bits set to 1 and the other 32-N bits set to 0. */
1100 #define NXM_OF_IP_SRC     NXM_HEADER  (0x0000,  7, 4)
1101 #define NXM_OF_IP_SRC_W   NXM_HEADER_W(0x0000,  7, 4)
1102 #define NXM_OF_IP_DST     NXM_HEADER  (0x0000,  8, 4)
1103 #define NXM_OF_IP_DST_W   NXM_HEADER_W(0x0000,  8, 4)
1104
1105 /* The source or destination port in the TCP header.
1106  *
1107  * Prereqs:
1108  *   NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1109  *   NXM_OF_IP_PROTO must match 6 exactly.
1110  *
1111  * Format: 16-bit integer in network byte order.
1112  *
1113  * Masking: Not maskable. */
1114 #define NXM_OF_TCP_SRC    NXM_HEADER  (0x0000,  9, 2)
1115 #define NXM_OF_TCP_DST    NXM_HEADER  (0x0000, 10, 2)
1116
1117 /* The source or destination port in the UDP header.
1118  *
1119  * Prereqs:
1120  *   NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1121  *   NXM_OF_IP_PROTO must match 17 exactly.
1122  *
1123  * Format: 16-bit integer in network byte order.
1124  *
1125  * Masking: Not maskable. */
1126 #define NXM_OF_UDP_SRC    NXM_HEADER  (0x0000, 11, 2)
1127 #define NXM_OF_UDP_DST    NXM_HEADER  (0x0000, 12, 2)
1128
1129 /* The type or code in the ICMP header.
1130  *
1131  * Prereqs:
1132  *   NXM_OF_ETH_TYPE must match 0x0800 exactly.
1133  *   NXM_OF_IP_PROTO must match 1 exactly.
1134  *
1135  * Format: 8-bit integer.
1136  *
1137  * Masking: Not maskable. */
1138 #define NXM_OF_ICMP_TYPE  NXM_HEADER  (0x0000, 13, 1)
1139 #define NXM_OF_ICMP_CODE  NXM_HEADER  (0x0000, 14, 1)
1140
1141 /* ARP opcode.
1142  *
1143  * For an Ethernet+IP ARP packet, the opcode in the ARP header.  Always 0
1144  * otherwise.  Only ARP opcodes between 1 and 255 should be specified for
1145  * matching.
1146  *
1147  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1148  *
1149  * Format: 16-bit integer in network byte order.
1150  *
1151  * Masking: Not maskable. */
1152 #define NXM_OF_ARP_OP     NXM_HEADER  (0x0000, 15, 2)
1153
1154 /* For an Ethernet+IP ARP packet, the source or target protocol address
1155  * in the ARP header.  Always 0 otherwise.
1156  *
1157  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1158  *
1159  * Format: 32-bit integer in network byte order.
1160  *
1161  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1162  *   high-order bits set to 1 and the other 32-N bits set to 0. */
1163 #define NXM_OF_ARP_SPA    NXM_HEADER  (0x0000, 16, 4)
1164 #define NXM_OF_ARP_SPA_W  NXM_HEADER_W(0x0000, 16, 4)
1165 #define NXM_OF_ARP_TPA    NXM_HEADER  (0x0000, 17, 4)
1166 #define NXM_OF_ARP_TPA_W  NXM_HEADER_W(0x0000, 17, 4)
1167
1168 /* ## ------------------------ ## */
1169 /* ## Nicira match extensions. ## */
1170 /* ## ------------------------ ## */
1171
1172 /* Metadata registers.
1173  *
1174  * Registers initially have value 0.  Actions allow register values to be
1175  * manipulated.
1176  *
1177  * Prereqs: None.
1178  *
1179  * Format: Array of 32-bit integer registers.  Space is reserved for up to
1180  *   NXM_NX_MAX_REGS registers, but switches may implement fewer.
1181  *
1182  * Masking: Arbitrary masks. */
1183 #define NXM_NX_MAX_REGS 16
1184 #define NXM_NX_REG(IDX)   NXM_HEADER  (0x0001, IDX, 4)
1185 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1186 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1187 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1188 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1189 #define NXM_NX_REG0       NXM_HEADER  (0x0001, 0, 4)
1190 #define NXM_NX_REG0_W     NXM_HEADER_W(0x0001, 0, 4)
1191 #define NXM_NX_REG1       NXM_HEADER  (0x0001, 1, 4)
1192 #define NXM_NX_REG1_W     NXM_HEADER_W(0x0001, 1, 4)
1193 #define NXM_NX_REG2       NXM_HEADER  (0x0001, 2, 4)
1194 #define NXM_NX_REG2_W     NXM_HEADER_W(0x0001, 2, 4)
1195 #define NXM_NX_REG3       NXM_HEADER  (0x0001, 3, 4)
1196 #define NXM_NX_REG3_W     NXM_HEADER_W(0x0001, 3, 4)
1197
1198 /* Tunnel ID.
1199  *
1200  * For a packet received via GRE tunnel including a (32-bit) key, the key is
1201  * stored in the low 32-bits and the high bits are zeroed.  For other packets,
1202  * the value is 0.
1203  *
1204  * Prereqs: None.
1205  *
1206  * Format: 64-bit integer in network byte order.
1207  *
1208  * Masking: Arbitrary masks. */
1209 #define NXM_NX_TUN_ID     NXM_HEADER  (0x0001, 16, 8)
1210 #define NXM_NX_TUN_ID_W   NXM_HEADER_W(0x0001, 16, 8)
1211
1212 /* For an Ethernet+IP ARP packet, the source or target hardware address
1213  * in the ARP header.  Always 0 otherwise.
1214  *
1215  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1216  *
1217  * Format: 48-bit Ethernet MAC address.
1218  *
1219  * Masking: Not maskable. */
1220 #define NXM_NX_ARP_SHA    NXM_HEADER  (0x0001, 17, 6)
1221 #define NXM_NX_ARP_THA    NXM_HEADER  (0x0001, 18, 6)
1222
1223 /* The source or destination address in the IPv6 header.
1224  *
1225  * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1226  *
1227  * Format: 128-bit IPv6 address.
1228  *
1229  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1230  *   high-order bits set to 1 and the other 128-N bits set to 0. */
1231 #define NXM_NX_IPV6_SRC    NXM_HEADER  (0x0001, 19, 16)
1232 #define NXM_NX_IPV6_SRC_W  NXM_HEADER_W(0x0001, 19, 16)
1233 #define NXM_NX_IPV6_DST    NXM_HEADER  (0x0001, 20, 16)
1234 #define NXM_NX_IPV6_DST_W  NXM_HEADER_W(0x0001, 20, 16)
1235
1236 /* The type or code in the ICMPv6 header.
1237  *
1238  * Prereqs:
1239  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1240  *   NXM_OF_IP_PROTO must match 58 exactly.
1241  *
1242  * Format: 8-bit integer.
1243  *
1244  * Masking: Not maskable. */
1245 #define NXM_NX_ICMPV6_TYPE NXM_HEADER  (0x0001, 21, 1)
1246 #define NXM_NX_ICMPV6_CODE NXM_HEADER  (0x0001, 22, 1)
1247
1248 /* The target address in an IPv6 Neighbor Discovery message.
1249  *
1250  * Prereqs:
1251  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1252  *   NXM_OF_IP_PROTO must match 58 exactly.
1253  *   NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1254  *
1255  * Format: 128-bit IPv6 address.
1256  *
1257  * Masking: Not maskable. */
1258 #define NXM_NX_ND_TARGET   NXM_HEADER  (0x0001, 23, 16)
1259
1260 /* The source link-layer address option in an IPv6 Neighbor Discovery
1261  * message.
1262  *
1263  * Prereqs:
1264  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1265  *   NXM_OF_IP_PROTO must match 58 exactly.
1266  *   NXM_OF_ICMPV6_TYPE must be exactly 135.
1267  *
1268  * Format: 48-bit Ethernet MAC address.
1269  *
1270  * Masking: Not maskable. */
1271 #define NXM_NX_ND_SLL      NXM_HEADER  (0x0001, 24, 6)
1272
1273 /* The target link-layer address option in an IPv6 Neighbor Discovery
1274  * message.
1275  *
1276  * Prereqs:
1277  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1278  *   NXM_OF_IP_PROTO must match 58 exactly.
1279  *   NXM_OF_ICMPV6_TYPE must be exactly 136.
1280  *
1281  * Format: 48-bit Ethernet MAC address.
1282  *
1283  * Masking: Not maskable. */
1284 #define NXM_NX_ND_TLL      NXM_HEADER  (0x0001, 25, 6)
1285
1286
1287 /* ## --------------------- ## */
1288 /* ## Requests and replies. ## */
1289 /* ## --------------------- ## */
1290
1291 enum nx_flow_format {
1292     NXFF_OPENFLOW10 = 0,         /* Standard OpenFlow 1.0 compatible. */
1293     NXFF_NXM = 2                 /* Nicira extended match. */
1294 };
1295
1296 /* NXT_SET_FLOW_FORMAT request. */
1297 struct nxt_set_flow_format {
1298     struct ofp_header header;
1299     ovs_be32 vendor;            /* NX_VENDOR_ID. */
1300     ovs_be32 subtype;           /* NXT_SET_FLOW_FORMAT. */
1301     ovs_be32 format;            /* One of NXFF_*. */
1302 };
1303 OFP_ASSERT(sizeof(struct nxt_set_flow_format) == 20);
1304
1305 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */
1306 struct nx_flow_mod {
1307     struct nicira_header nxh;
1308     ovs_be64 cookie;              /* Opaque controller-issued identifier. */
1309     ovs_be16 command;             /* One of OFPFC_*. */
1310     ovs_be16 idle_timeout;        /* Idle time before discarding (seconds). */
1311     ovs_be16 hard_timeout;        /* Max time before discarding (seconds). */
1312     ovs_be16 priority;            /* Priority level of flow entry. */
1313     ovs_be32 buffer_id;           /* Buffered packet to apply to (or -1).
1314                                      Not meaningful for OFPFC_DELETE*. */
1315     ovs_be16 out_port;            /* For OFPFC_DELETE* commands, require
1316                                      matching entries to include this as an
1317                                      output port.  A value of OFPP_NONE
1318                                      indicates no restriction. */
1319     ovs_be16 flags;               /* One of OFPFF_*. */
1320     ovs_be16 match_len;           /* Size of nx_match. */
1321     uint8_t pad[6];               /* Align to 64-bits. */
1322     /* Followed by:
1323      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1324      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1325      *     all-zero bytes, then
1326      *   - Actions to fill out the remainder of the message length (always a
1327      *     multiple of 8).
1328      */
1329 };
1330 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
1331
1332 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1333 struct nx_flow_removed {
1334     struct nicira_header nxh;
1335     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
1336     ovs_be16 priority;        /* Priority level of flow entry. */
1337     uint8_t reason;           /* One of OFPRR_*. */
1338     uint8_t pad[1];           /* Align to 32-bits. */
1339     ovs_be32 duration_sec;    /* Time flow was alive in seconds. */
1340     ovs_be32 duration_nsec;   /* Time flow was alive in nanoseconds beyond
1341                                  duration_sec. */
1342     ovs_be16 idle_timeout;    /* Idle timeout from original flow mod. */
1343     ovs_be16 match_len;       /* Size of nx_match. */
1344     ovs_be64 packet_count;
1345     ovs_be64 byte_count;
1346     /* Followed by:
1347      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1348      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1349      *     all-zero bytes. */
1350 };
1351 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
1352
1353 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1354  * request). */
1355 struct nx_flow_stats_request {
1356     struct nicira_stats_msg nsm;
1357     ovs_be16 out_port;        /* Require matching entries to include this
1358                                  as an output port.  A value of OFPP_NONE
1359                                  indicates no restriction. */
1360     ovs_be16 match_len;       /* Length of nx_match. */
1361     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
1362                                  or 0xff for all tables. */
1363     uint8_t pad[3];           /* Align to 64 bits. */
1364     /* Followed by:
1365      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1366      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1367      *     all-zero bytes, which must also exactly fill out the length of the
1368      *     message.
1369      */
1370 };
1371 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
1372
1373 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1374  * OFPST_FLOW reply). */
1375 struct nx_flow_stats {
1376     ovs_be16 length;          /* Length of this entry. */
1377     uint8_t table_id;         /* ID of table flow came from. */
1378     uint8_t pad;
1379     ovs_be32 duration_sec;    /* Time flow has been alive in seconds. */
1380     ovs_be32 duration_nsec;   /* Time flow has been alive in nanoseconds
1381                                  beyond duration_sec. */
1382     ovs_be16 priority;        /* Priority of the entry. Only meaningful
1383                                  when this is not an exact-match entry. */
1384     ovs_be16 idle_timeout;    /* Number of seconds idle before expiration. */
1385     ovs_be16 hard_timeout;    /* Number of seconds before expiration. */
1386     ovs_be16 match_len;       /* Length of nx_match. */
1387     uint8_t pad2[4];          /* Align to 64 bits. */
1388     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
1389     ovs_be64 packet_count;    /* Number of packets, UINT64_MAX if unknown. */
1390     ovs_be64 byte_count;      /* Number of bytes, UINT64_MAX if unknown. */
1391     /* Followed by:
1392      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1393      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1394      *     all-zero bytes, then
1395      *   - Actions to fill out the remainder 'length' bytes (always a multiple
1396      *     of 8).
1397      */
1398 };
1399 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1400
1401 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1402  * OFPST_AGGREGATE request). */
1403 struct nx_aggregate_stats_request {
1404     struct nicira_stats_msg nsm;
1405     ovs_be16 out_port;        /* Require matching entries to include this
1406                                  as an output port.  A value of OFPP_NONE
1407                                  indicates no restriction. */
1408     ovs_be16 match_len;       /* Length of nx_match. */
1409     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
1410                                  or 0xff for all tables. */
1411     uint8_t pad[3];           /* Align to 64 bits. */
1412     /* Followed by:
1413      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1414      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1415      *     all-zero bytes, which must also exactly fill out the length of the
1416      *     message.
1417      */
1418 };
1419 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1420
1421 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1422  * OFPST_AGGREGATE reply). */
1423 struct nx_aggregate_stats_reply {
1424     struct nicira_stats_msg nsm;
1425     ovs_be64 packet_count;     /* Number of packets, UINT64_MAX if unknown. */
1426     ovs_be64 byte_count;       /* Number of bytes, UINT64_MAX if unknown. */
1427     ovs_be32 flow_count;       /* Number of flows. */
1428     uint8_t pad[4];            /* Align to 64 bits. */
1429 };
1430 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1431
1432 #endif /* openflow/nicira-ext.h */