2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks
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:
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
17 #ifndef OPENFLOW_NICIRA_EXT_H
18 #define OPENFLOW_NICIRA_EXT_H 1
20 #include "openflow/openflow.h"
21 #include "openvswitch/types.h"
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. */
27 #define NX_VENDOR_ID 0x00002320
29 /* Nicira vendor-specific error messages extension.
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.
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
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.
49 * Currently this extension is only implemented by Open vSwitch, but it seems
50 * like a reasonable candidate for future standardization.
53 /* This is a random number to avoid accidental collision with any other
54 * vendor's extension. */
55 #define NXET_VENDOR 0xb0c2
57 /* ofp_error msg 'code' values for NXET_VENDOR. */
59 NXVC_VENDOR_ERROR /* 'data' contains struct nx_vendor_error. */
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. */
70 /* Specific Nicira extension error numbers.
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. */
78 /* Additional "code" values for OFPET_BAD_REQUEST. */
79 enum nx_bad_request_code {
80 /* Nicira Extended Match (NXM) errors. */
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,
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,
92 /* Invalid nxm_value. */
93 NXBRC_NXM_BAD_VALUE = 0x102,
95 /* Invalid nxm_mask. */
96 NXBRC_NXM_BAD_MASK = 0x103,
98 /* A prerequisite was not met. */
99 NXBRC_NXM_BAD_PREREQ = 0x104,
101 /* A given nxm_type was specified more than once. */
102 NXBRC_NXM_DUP_TYPE = 0x105
105 /* Additional "code" values for OFPET_FLOW_MOD_FAILED. */
106 enum nx_flow_mod_failed_code {
107 /* Generic hardware error. */
108 NXFMFC_HARDWARE = 0x100,
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
115 /* Nicira vendor requests and replies. */
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. */
123 OFP_ASSERT(sizeof(struct nicira_header) == 16);
125 /* Values for the 'subtype' member of struct nicira_header. */
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,
139 /* Controller role support. The request body is struct nx_role_request.
140 * The reply echos the request. */
141 NXT_ROLE_REQUEST = 10,
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. */
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
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. */
161 OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
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. */
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,
175 /* L2 through L4, symmetric across src/dst. Specifically, each of the
176 * following fields, if present, is hashed (slashes separate symmetric
179 * - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
181 * - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
183 * - NXM_OF_IP_SRC / NXM_OF_IP_DST
184 * - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
186 NX_HASH_FIELDS_SYMMETRIC_L4
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.
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.
199 * The specific treatment of the table ID depends on the type of flow mod:
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.)
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.
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
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.
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. */
234 OFP_ASSERT(sizeof(struct nxt_flow_mod_table_id) == 24);
236 /* Configures the "role" of the sending controller. The default role is:
238 * - Other (NX_ROLE_OTHER), which allows the controller access to all
241 * The other possible roles are a related pair:
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
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.
252 * Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
253 * messages, but they do receive OFPT_PORT_STATUS messages.
255 struct nx_role_request {
256 struct nicira_header nxh;
257 ovs_be32 role; /* One of 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. */
266 /* Nicira vendor flow actions. */
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 NXAST_OUTPUT_REG /* struct nx_action_output_reg */
287 /* Header for Nicira-defined actions. */
288 struct nx_action_header {
289 ovs_be16 type; /* OFPAT_VENDOR. */
290 ovs_be16 len; /* Length is 16. */
291 ovs_be32 vendor; /* NX_VENDOR_ID. */
292 ovs_be16 subtype; /* NXAST_*. */
295 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
297 /* Action structures for NXAST_RESUBMIT and NXAST_RESUBMIT_TABLE.
299 * These actions search one of the switch's flow tables:
301 * - For NXAST_RESUBMIT_TABLE only, if the 'table' member is not 255, then
302 * it specifies the table to search.
304 * - Otherwise (for NXAST_RESUBMIT_TABLE with a 'table' of 255, or for
305 * NXAST_RESUBMIT regardless of 'table'), it searches the current flow
306 * table, that is, the OpenFlow flow table that contains the flow from
307 * which this action was obtained. If this action did not come from a
308 * flow table (e.g. it came from an OFPT_PACKET_OUT message), then table 0
309 * is the current table.
311 * The flow table lookup uses a flow that may be slightly modified from the
314 * - For NXAST_RESUBMIT, the 'in_port' member of struct nx_action_resubmit
315 * is used as the flow's in_port.
317 * - For NXAST_RESUBMIT_TABLE, if the 'in_port' member is not OFPP_IN_PORT,
318 * then its value is used as the flow's in_port. Otherwise, the original
321 * - If actions that modify the flow (e.g. OFPAT_SET_VLAN_VID) precede the
322 * resubmit action, then the flow is updated with the new values.
324 * Following the lookup, the original in_port is restored.
326 * If the modified flow matched in the flow table, then the corresponding
327 * actions are executed. Afterward, actions following the resubmit in the
328 * original set of actions, if any, are executed; any changes made to the
329 * packet (e.g. changes to VLAN) by secondary actions persist when those
330 * actions are executed, although the original in_port is restored.
332 * Resubmit actions may be used any number of times within a set of actions.
334 * Resubmit actions may nest to an implementation-defined depth. Beyond this
335 * implementation-defined depth, further resubmit actions are simply ignored.
337 * NXAST_RESUBMIT ignores 'table' and 'pad'. NXAST_RESUBMIT_TABLE requires
338 * 'pad' to be all-bits-zero.
340 * Open vSwitch 1.0.1 and earlier did not support recursion. Open vSwitch
341 * before 1.2.90 did not support NXAST_RESUBMIT_TABLE.
343 struct nx_action_resubmit {
344 ovs_be16 type; /* OFPAT_VENDOR. */
345 ovs_be16 len; /* Length is 16. */
346 ovs_be32 vendor; /* NX_VENDOR_ID. */
347 ovs_be16 subtype; /* NXAST_RESUBMIT. */
348 ovs_be16 in_port; /* New in_port for checking flow table. */
349 uint8_t table; /* NXAST_RESUBMIT_TABLE: table to use. */
352 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
354 /* Action structure for NXAST_SET_TUNNEL.
356 * Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32
357 * bits of the tunnel ID are set to 0. */
358 struct nx_action_set_tunnel {
359 ovs_be16 type; /* OFPAT_VENDOR. */
360 ovs_be16 len; /* Length is 16. */
361 ovs_be32 vendor; /* NX_VENDOR_ID. */
362 ovs_be16 subtype; /* NXAST_SET_TUNNEL. */
364 ovs_be32 tun_id; /* Tunnel ID. */
366 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
368 /* Action structure for NXAST_SET_TUNNEL64.
370 * Sets the encapsulating tunnel ID to a 64-bit value. */
371 struct nx_action_set_tunnel64 {
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_TUNNEL64. */
377 ovs_be64 tun_id; /* Tunnel ID. */
379 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
381 /* Action structure for NXAST_SET_QUEUE.
383 * Set the queue that should be used when packets are output. This is similar
384 * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
385 * an argument. This allows the queue to be defined before the port is
387 struct nx_action_set_queue {
388 ovs_be16 type; /* OFPAT_VENDOR. */
389 ovs_be16 len; /* Length is 16. */
390 ovs_be32 vendor; /* NX_VENDOR_ID. */
391 ovs_be16 subtype; /* NXAST_SET_QUEUE. */
393 ovs_be32 queue_id; /* Where to enqueue packets. */
395 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
397 /* Action structure for NXAST_POP_QUEUE.
399 * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
400 * were used. Only the original queue can be restored this way; no stack is
402 struct nx_action_pop_queue {
403 ovs_be16 type; /* OFPAT_VENDOR. */
404 ovs_be16 len; /* Length is 16. */
405 ovs_be32 vendor; /* NX_VENDOR_ID. */
406 ovs_be16 subtype; /* NXAST_POP_QUEUE. */
409 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
411 /* Action structure for NXAST_REG_MOVE.
413 * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
414 * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
415 * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
416 * the next most significant bit, and so on.
418 * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
419 * sense to use nxm_hasmask=1 because the action does not do any kind of
420 * matching; it uses the actual value of a field.)
422 * The following nxm_header values are potentially acceptable as 'src':
445 * - NXM_NX_ICMPV6_TYPE
446 * - NXM_NX_ICMPV6_CODE
449 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
451 * The following nxm_header values are potentially acceptable as 'dst':
462 * Modifying any of the above fields changes the corresponding packet
465 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
467 * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
468 * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
469 * header (if any), ignoring the other bits. Setting a value with CFI=1
470 * adds or modifies the 802.1Q header appropriately, setting the TCI field
471 * to the field's new value (with the CFI bit masked out).
473 * - NXM_NX_TUN_ID. Modifying this value modifies the tunnel ID used for the
474 * packet's next tunnel encapsulation.
476 * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
477 * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
478 * used only if the flow's nx_match includes an nxm_entry that specifies
479 * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
481 * The switch will reject actions for which src_ofs+n_bits is greater than the
482 * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
483 * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
485 struct nx_action_reg_move {
486 ovs_be16 type; /* OFPAT_VENDOR. */
487 ovs_be16 len; /* Length is 16. */
488 ovs_be32 vendor; /* NX_VENDOR_ID. */
489 ovs_be16 subtype; /* NXAST_REG_MOVE. */
490 ovs_be16 n_bits; /* Number of bits. */
491 ovs_be16 src_ofs; /* Starting bit offset in source. */
492 ovs_be16 dst_ofs; /* Starting bit offset in destination. */
493 ovs_be32 src; /* Source register. */
494 ovs_be32 dst; /* Destination register. */
496 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
498 /* Action structure for NXAST_REG_LOAD.
500 * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
501 * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
502 * starts at 0 for the least-significant bit, 1 for the next most significant
505 * 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for
506 * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
509 * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
510 * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
511 * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
512 * also stored as one less than its true value:
515 * +------------------------------+------------------+
516 * | ofs | n_bits - 1 |
517 * +------------------------------+------------------+
519 * The switch will reject actions for which ofs+n_bits is greater than the
520 * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
521 * greater are set to 1, with error type OFPET_BAD_ACTION, code
522 * OFPBAC_BAD_ARGUMENT.
524 struct nx_action_reg_load {
525 ovs_be16 type; /* OFPAT_VENDOR. */
526 ovs_be16 len; /* Length is 16. */
527 ovs_be32 vendor; /* NX_VENDOR_ID. */
528 ovs_be16 subtype; /* NXAST_REG_LOAD. */
529 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
530 ovs_be32 dst; /* Destination register. */
531 ovs_be64 value; /* Immediate value. */
533 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
535 /* Action structure for NXAST_NOTE.
537 * This action has no effect. It is variable length. The switch does not
538 * attempt to interpret the user-defined 'note' data in any way. A controller
539 * can use this action to attach arbitrary metadata to a flow.
541 * This action might go away in the future.
543 struct nx_action_note {
544 ovs_be16 type; /* OFPAT_VENDOR. */
545 ovs_be16 len; /* A multiple of 8, but at least 16. */
546 ovs_be32 vendor; /* NX_VENDOR_ID. */
547 ovs_be16 subtype; /* NXAST_NOTE. */
548 uint8_t note[6]; /* Start of user-defined data. */
549 /* Possibly followed by additional user-defined data. */
551 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
553 /* Action structure for NXAST_MULTIPATH.
555 * This action performs the following steps in sequence:
557 * 1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
558 * Refer to the definition of "enum nx_mp_fields" for details.
560 * The 'basis' value is used as a universal hash parameter, that is,
561 * different values of 'basis' yield different hash functions. The
562 * particular universal hash function used is implementation-defined.
564 * The hashed fields' values are drawn from the current state of the
565 * flow, including all modifications that have been made by actions up to
568 * 2. Applies the multipath link choice algorithm specified by 'algorithm',
569 * one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm"
572 * The output of the algorithm is 'link', an unsigned integer less than
573 * or equal to 'max_link'.
575 * Some algorithms use 'arg' as an additional argument.
577 * 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of
578 * 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
581 * The switch will reject actions that have an unknown 'fields', or an unknown
582 * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
583 * in which 'max_link' is greater than or equal to 2**n_bits, with error type
584 * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
586 struct nx_action_multipath {
587 ovs_be16 type; /* OFPAT_VENDOR. */
588 ovs_be16 len; /* Length is 32. */
589 ovs_be32 vendor; /* NX_VENDOR_ID. */
590 ovs_be16 subtype; /* NXAST_MULTIPATH. */
592 /* What fields to hash and how. */
593 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
594 ovs_be16 basis; /* Universal hash parameter. */
597 /* Multipath link choice algorithm to apply to hash value. */
598 ovs_be16 algorithm; /* One of NX_MP_ALG_*. */
599 ovs_be16 max_link; /* Number of output links, minus 1. */
600 ovs_be32 arg; /* Algorithm-specific argument. */
603 /* Where to store the result. */
604 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
605 ovs_be32 dst; /* Destination. */
607 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
609 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
611 * In the descriptions below, 'n_links' is max_link + 1. */
612 enum nx_mp_algorithm {
613 /* link = hash(flow) % n_links.
615 * Redistributes all traffic when n_links changes. O(1) performance. See
618 * Use UINT16_MAX for max_link to get a raw hash value. */
621 /* link = hash(flow) / (MAX_HASH / n_links).
623 * Redistributes between one-quarter and one-half of traffic when n_links
624 * changes. O(1) performance. See RFC 2992.
626 NX_MP_ALG_HASH_THRESHOLD,
628 /* for i in [0,n_links):
629 * weights[i] = hash(flow, i)
630 * link = { i such that weights[i] >= weights[j] for all j != i }
632 * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
633 * performance. If n_links is greater than a threshold (currently 64, but
634 * subject to change), Open vSwitch will substitute another algorithm
635 * automatically. See RFC 2992. */
636 NX_MP_ALG_HRW, /* Highest Random Weight. */
641 * link = hash(flow, i) % arg
642 * while link > max_link
644 * Redistributes 1/n_links of traffic when n_links changes. O(1)
645 * performance when arg/max_link is bounded by a constant.
647 * Redistributes all traffic when arg changes.
649 * arg must be greater than max_link and for best performance should be no
650 * more than approximately max_link * 2. If arg is outside the acceptable
651 * range, Open vSwitch will automatically substitute the least power of 2
652 * greater than max_link.
654 * This algorithm is specific to Open vSwitch.
656 NX_MP_ALG_ITER_HASH /* Iterative Hash. */
659 /* Action structure for NXAST_AUTOPATH.
661 * This action performs the following steps in sequence:
663 * 1. Hashes the flow using an implementation-defined hash function.
665 * The hashed fields' values are drawn from the current state of the
666 * flow, including all modifications that have been made by actions up to
669 * 2. Selects an OpenFlow 'port'.
671 * 'port' is selected in an implementation-defined manner, taking into
672 * account 'id' and the hash value calculated in step 1.
674 * Generally a switch will have been configured with a set of ports that
675 * may be chosen given 'id'. The switch may take into account any number
676 * of factors when choosing 'port' from its configured set. Factors may
677 * include carrier, load, and the results of configuration protocols such
680 * 3. Stores 'port' in dst[ofs:ofs+n_bits].
682 * The format and semantics of 'dst' and 'ofs_nbits' are similar to those
683 * for the NXAST_REG_LOAD action.
685 * The switch will reject actions in which ofs+n_bits is greater than the width
686 * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
688 struct nx_action_autopath {
689 ovs_be16 type; /* OFPAT_VENDOR. */
690 ovs_be16 len; /* Length is 20. */
691 ovs_be32 vendor; /* NX_VENDOR_ID. */
692 ovs_be16 subtype; /* NXAST_AUTOPATH. */
694 /* Where to store the result. */
695 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
696 ovs_be32 dst; /* Destination. */
698 ovs_be32 id; /* Autopath ID. */
701 OFP_ASSERT(sizeof(struct nx_action_autopath) == 24);
703 /* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD.
705 * The bundle actions choose a slave from a supplied list of options.
706 * NXAST_BUNDLE outputs to its selection. NXAST_BUNDLE_LOAD writes its
707 * selection to a register.
709 * The list of possible slaves follows the nx_action_bundle structure. The size
710 * of each slave is governed by its type as indicated by the 'slave_type'
711 * parameter. The list of slaves should be padded at its end with zeros to make
712 * the total length of the action a multiple of 8.
714 * Switches infer from the 'slave_type' parameter the size of each slave. All
715 * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
716 * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
717 * 2 byte width. Switches should reject actions which indicate unknown or
718 * unsupported slave types.
720 * Switches use a strategy dictated by the 'algorithm' parameter to choose a
721 * slave. If the switch does not support the specified 'algorithm' parameter,
722 * it should reject the action.
724 * Some slave selection strategies require the use of a hash function, in which
725 * case the 'fields' and 'basis' parameters should be populated. The 'fields'
726 * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
727 * hash. Refer to the definition of "enum nx_hash_fields" for details. The
728 * 'basis' parameter is used as a universal hash parameter. Different values
729 * of 'basis' yield different hash results.
731 * The 'zero' parameter at the end of the action structure is reserved for
732 * future use. Switches are required to reject actions which have nonzero
733 * bytes in the 'zero' field.
735 * NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed. Switches
736 * should reject actions which have nonzero bytes in either of these fields.
738 * NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in
739 * dst[ofs:ofs+n_bits]. The format and semantics of 'dst' and 'ofs_nbits' are
740 * similar to those for the NXAST_REG_LOAD action. */
741 struct nx_action_bundle {
742 ovs_be16 type; /* OFPAT_VENDOR. */
743 ovs_be16 len; /* Length including slaves. */
744 ovs_be32 vendor; /* NX_VENDOR_ID. */
745 ovs_be16 subtype; /* NXAST_BUNDLE. */
747 /* Slave choice algorithm to apply to hash value. */
748 ovs_be16 algorithm; /* One of NX_BD_ALG_*. */
750 /* What fields to hash and how. */
751 ovs_be16 fields; /* One of NX_BD_FIELDS_*. */
752 ovs_be16 basis; /* Universal hash parameter. */
754 ovs_be32 slave_type; /* NXM_OF_IN_PORT. */
755 ovs_be16 n_slaves; /* Number of slaves. */
757 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
758 ovs_be32 dst; /* Destination. */
760 uint8_t zero[4]; /* Reserved. Must be zero. */
762 OFP_ASSERT(sizeof(struct nx_action_bundle) == 32);
764 /* NXAST_BUNDLE: Bundle slave choice algorithm to apply.
766 * In the descriptions below, 'slaves' is the list of possible slaves in the
767 * order they appear in the OpenFlow action. */
768 enum nx_bd_algorithm {
769 /* Chooses the first live slave listed in the bundle.
771 * O(n_slaves) performance. */
772 NX_BD_ALG_ACTIVE_BACKUP,
774 /* for i in [0,n_slaves):
775 * weights[i] = hash(flow, i)
776 * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
778 * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
779 * O(n_slaves) performance.
781 * Uses the 'fields' and 'basis' parameters. */
782 NX_BD_ALG_HRW /* Highest Random Weight. */
785 /* Action structure for NXAST_OUTPUT_REG.
787 * Outputs to the OpenFlow port number written to src[ofs:ofs+nbits].
789 * The format and semantics of 'src' and 'ofs_nbits' are similar to those for
790 * the NXAST_REG_LOAD action.
792 * The acceptable nxm_header values for 'src' are the same as the acceptable
793 * nxm_header values for the 'src' field of NXAST_REG_MOVE.
795 * The 'max_len' field indicates the number of bytes to send when the chosen
796 * port is OFPP_CONTROLLER. Its semantics are equivalent to the 'max_len'
797 * field of OFPAT_OUTPUT.
799 * The 'zero' field is required to be zeroed for forward compatibility. */
800 struct nx_action_output_reg {
801 ovs_be16 type; /* OFPAT_VENDOR. */
802 ovs_be16 len; /* 24. */
803 ovs_be32 vendor; /* NX_VENDOR_ID. */
804 ovs_be16 subtype; /* NXAST_OUTPUT_REG. */
806 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
807 ovs_be32 src; /* Source. */
809 ovs_be16 max_len; /* Max length to send to controller. */
811 uint8_t zero[6]; /* Reserved, must be zero. */
813 OFP_ASSERT(sizeof(struct nx_action_output_reg) == 24);
815 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
817 * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches. This
818 * structure is fixed-length and hence difficult to extend. This section
819 * describes a more flexible, variable-length flow match, called "nx_match" for
820 * short, that is also supported by Open vSwitch. This section also defines a
821 * replacement for each OpenFlow message that includes struct ofp_match.
827 * An nx_match is a sequence of zero or more "nxm_entry"s, which are
828 * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
829 * "nxm_entry"s are not aligned on or padded to any multibyte boundary. The
830 * first 4 bytes of an nxm_entry are its "header", followed by the entry's
833 * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
835 * |<-------------------- nxm_type ------------------>|
838 * +----------------------------------+---------------+--+------------------+
839 * | nxm_vendor | nxm_field |hm| nxm_length |
840 * +----------------------------------+---------------+--+------------------+
842 * The most-significant 23 bits of the header are collectively "nxm_type".
843 * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
844 * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
845 * designates a protocol header, such as the Ethernet type, but it can also
846 * refer to packet metadata, such as the switch port on which a packet arrived.
848 * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
849 * of this bit is explained later.
851 * The least-significant 8 bits are "nxm_length", a positive integer. The
852 * length of the nxm_entry, including the header, is exactly 4 + nxm_length
855 * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
856 * constant. It is included only to allow software to minimally parse
857 * "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor,
858 * nxm_field, and nxm_length, nxm_hasmask is a constant.)
864 * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
866 * An nxm_entry places a constraint on the packets matched by the nx_match:
868 * - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
869 * field, called "nxm_value". The nx_match matches only packets in which
870 * the field equals nxm_value.
872 * - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
873 * field (nxm_value), followed by a bitmask of the same length as the
874 * value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
875 * nx_match matches only packets for which bit J in the given field's value
876 * matches bit J in nxm_value. A 0-bit in nxm_mask causes the
877 * corresponding bits in nxm_value and the field's value to be ignored.
878 * (The sense of the nxm_mask bits is the opposite of that used by the
879 * "wildcards" member of struct ofp_match.)
881 * When nxm_hasmask is 1, nxm_length is always even.
883 * An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
884 * entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for
887 * When there are multiple "nxm_entry"s, all of the constraints must be met.
893 * Masks may be restricted:
895 * - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
896 * must always be 0 when these fields are specified. For example, the
897 * field that identifies the port on which a packet was received may not be
900 * - Some nxm_types that do support masked wildcards may only support certain
901 * nxm_mask patterns. For example, fields that have IPv4 address values
902 * may be restricted to CIDR masks.
904 * These restrictions should be noted in specifications for individual fields.
905 * A switch may accept an nxm_hasmask or nxm_mask value that the specification
906 * disallows, if the switch correctly implements support for that nxm_hasmask
907 * or nxm_mask value. A switch must reject an attempt to set up a flow that
908 * contains a nxm_hasmask or nxm_mask value that it does not support.
911 * Prerequisite Restrictions
912 * =========================
914 * The presence of an nxm_entry with a given nxm_type may be restricted based
915 * on the presence of or values of other "nxm_entry"s. For example:
917 * - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
918 * preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
919 * and nxm_value=0x0800. That is, matching on the IP source address is
920 * allowed only if the Ethernet type is explicitly set to IP.
922 * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is preced
923 * by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
924 * nxm_value=0x0800 and another with nxm_type=NXM_OF_IP_PROTO,
925 * nxm_hasmask=0, nxm_value=6, in that order. That is, matching on the TCP
926 * source port is allowed only if the Ethernet type is IP and the IP
929 * These restrictions should be noted in specifications for individual fields.
930 * A switch may implement relaxed versions of these restrictions. A switch
931 * must reject an attempt to set up a flow that violates its restrictions.
934 * Ordering Restrictions
935 * =====================
937 * An nxm_entry that has prerequisite restrictions must appear after the
938 * "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an
939 * nx_match is not otherwise constrained.
941 * Any given nxm_type may appear in an nx_match at most once.
947 * These examples show the format of a single nxm_entry with particular
948 * nxm_hasmask and nxm_length values. The diagrams are labeled with field
949 * numbers and byte indexes.
952 * 8-bit nxm_value, nxm_hasmask=1, nxm_length=2:
955 * +------------+---+---+
957 * +------------+---+---+
960 * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
963 * +------------+------+
965 * +------------+------+
968 * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
971 * +------------+-------------+
972 * | header | nxm_value |
973 * +------------+-------------+
976 * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
979 * +------------+------------------+
980 * | header | nxm_value |
981 * +------------+------------------+
984 * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
987 * +------------+------------------+------------------+
988 * | header | nxm_value | nxm_mask |
989 * +------------+------------------+------------------+
995 * A switch should report an error in an nx_match using error type
996 * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch
997 * should report a specific error code, if one is assigned for the particular
998 * problem, but NXBRC_NXM_INVALID is also available to report a generic
1002 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
1003 (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
1004 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
1005 NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
1006 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
1007 NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
1008 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
1009 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
1010 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
1011 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
1012 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
1014 #define NXM_MAKE_WILD_HEADER(HEADER) \
1015 NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
1017 /* ## ------------------------------- ## */
1018 /* ## OpenFlow 1.0-compatible fields. ## */
1019 /* ## ------------------------------- ## */
1021 /* Physical or virtual port on which the packet was received.
1025 * Format: 16-bit integer in network byte order.
1027 * Masking: Not maskable. */
1028 #define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
1030 /* Source or destination address in Ethernet header.
1034 * Format: 48-bit Ethernet MAC address.
1036 * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
1037 * be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
1038 * are all-0-bits or all-1-bits). Support for other patterns and for masking
1039 * of NXM_OF_ETH_SRC is optional. */
1040 #define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
1041 #define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
1042 #define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
1044 /* Packet's Ethernet type.
1046 * For an Ethernet II packet this is taken from the Ethernet header. For an
1047 * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
1048 * A packet that has neither format has value 0x05ff
1049 * (OFP_DL_TYPE_NOT_ETH_TYPE).
1051 * For a packet with an 802.1Q header, this is the type of the encapsulated
1056 * Format: 16-bit integer in network byte order.
1058 * Masking: Not maskable. */
1059 #define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
1063 * For a packet with an 802.1Q header, this is the Tag Control Information
1064 * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
1065 * header, this has value 0.
1069 * Format: 16-bit integer in network byte order.
1071 * Masking: Arbitrary masks.
1073 * This field can be used in various ways:
1075 * - If it is not constrained at all, the nx_match matches packets without
1076 * an 802.1Q header or with an 802.1Q header that has any TCI value.
1078 * - Testing for an exact match with 0 matches only packets without an
1081 * - Testing for an exact match with a TCI value with CFI=1 matches packets
1082 * that have an 802.1Q header with a specified VID and PCP.
1084 * - Testing for an exact match with a nonzero TCI value with CFI=0 does
1085 * not make sense. The switch may reject this combination.
1087 * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
1088 * packets that have an 802.1Q header with that VID (and any PCP).
1090 * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
1091 * packets that have an 802.1Q header with that PCP (and any VID).
1093 * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
1094 * header or with an 802.1Q header with a VID of 0.
1096 * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
1097 * header or with an 802.1Q header with a PCP of 0.
1099 * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
1100 * header or with an 802.1Q header with both VID and PCP of 0.
1102 #define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
1103 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
1105 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
1107 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1109 * Format: 8-bit integer with 2 least-significant bits forced to 0.
1111 * Masking: Not maskable. */
1112 #define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
1114 /* The "protocol" byte in the IP header.
1116 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1118 * Format: 8-bit integer.
1120 * Masking: Not maskable. */
1121 #define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
1123 /* The source or destination address in the IP header.
1125 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
1127 * Format: 32-bit integer in network byte order.
1129 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1130 * high-order bits set to 1 and the other 32-N bits set to 0. */
1131 #define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
1132 #define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
1133 #define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
1134 #define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
1136 /* The source or destination port in the TCP header.
1139 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1140 * NXM_OF_IP_PROTO must match 6 exactly.
1142 * Format: 16-bit integer in network byte order.
1144 * Masking: Not maskable. */
1145 #define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
1146 #define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
1148 /* The source or destination port in the UDP header.
1151 * NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1152 * NXM_OF_IP_PROTO must match 17 exactly.
1154 * Format: 16-bit integer in network byte order.
1156 * Masking: Not maskable. */
1157 #define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
1158 #define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
1160 /* The type or code in the ICMP header.
1163 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
1164 * NXM_OF_IP_PROTO must match 1 exactly.
1166 * Format: 8-bit integer.
1168 * Masking: Not maskable. */
1169 #define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
1170 #define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
1174 * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
1175 * otherwise. Only ARP opcodes between 1 and 255 should be specified for
1178 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1180 * Format: 16-bit integer in network byte order.
1182 * Masking: Not maskable. */
1183 #define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
1185 /* For an Ethernet+IP ARP packet, the source or target protocol address
1186 * in the ARP header. Always 0 otherwise.
1188 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1190 * Format: 32-bit integer in network byte order.
1192 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1193 * high-order bits set to 1 and the other 32-N bits set to 0. */
1194 #define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
1195 #define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
1196 #define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
1197 #define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
1199 /* ## ------------------------ ## */
1200 /* ## Nicira match extensions. ## */
1201 /* ## ------------------------ ## */
1203 /* Metadata registers.
1205 * Registers initially have value 0. Actions allow register values to be
1210 * Format: Array of 32-bit integer registers. Space is reserved for up to
1211 * NXM_NX_MAX_REGS registers, but switches may implement fewer.
1213 * Masking: Arbitrary masks. */
1214 #define NXM_NX_MAX_REGS 16
1215 #define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
1216 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1217 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1218 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1219 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1220 #define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
1221 #define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
1222 #define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
1223 #define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
1224 #define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
1225 #define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
1226 #define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
1227 #define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
1231 * For a packet received via GRE tunnel including a (32-bit) key, the key is
1232 * stored in the low 32-bits and the high bits are zeroed. For other packets,
1237 * Format: 64-bit integer in network byte order.
1239 * Masking: Arbitrary masks. */
1240 #define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
1241 #define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
1243 /* For an Ethernet+IP ARP packet, the source or target hardware address
1244 * in the ARP header. Always 0 otherwise.
1246 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1248 * Format: 48-bit Ethernet MAC address.
1250 * Masking: Not maskable. */
1251 #define NXM_NX_ARP_SHA NXM_HEADER (0x0001, 17, 6)
1252 #define NXM_NX_ARP_THA NXM_HEADER (0x0001, 18, 6)
1254 /* The source or destination address in the IPv6 header.
1256 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1258 * Format: 128-bit IPv6 address.
1260 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1261 * high-order bits set to 1 and the other 128-N bits set to 0. */
1262 #define NXM_NX_IPV6_SRC NXM_HEADER (0x0001, 19, 16)
1263 #define NXM_NX_IPV6_SRC_W NXM_HEADER_W(0x0001, 19, 16)
1264 #define NXM_NX_IPV6_DST NXM_HEADER (0x0001, 20, 16)
1265 #define NXM_NX_IPV6_DST_W NXM_HEADER_W(0x0001, 20, 16)
1267 /* The type or code in the ICMPv6 header.
1270 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1271 * NXM_OF_IP_PROTO must match 58 exactly.
1273 * Format: 8-bit integer.
1275 * Masking: Not maskable. */
1276 #define NXM_NX_ICMPV6_TYPE NXM_HEADER (0x0001, 21, 1)
1277 #define NXM_NX_ICMPV6_CODE NXM_HEADER (0x0001, 22, 1)
1279 /* The target address in an IPv6 Neighbor Discovery message.
1282 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1283 * NXM_OF_IP_PROTO must match 58 exactly.
1284 * NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1286 * Format: 128-bit IPv6 address.
1288 * Masking: Not maskable. */
1289 #define NXM_NX_ND_TARGET NXM_HEADER (0x0001, 23, 16)
1291 /* The source link-layer address option in an IPv6 Neighbor Discovery
1295 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1296 * NXM_OF_IP_PROTO must match 58 exactly.
1297 * NXM_OF_ICMPV6_TYPE must be exactly 135.
1299 * Format: 48-bit Ethernet MAC address.
1301 * Masking: Not maskable. */
1302 #define NXM_NX_ND_SLL NXM_HEADER (0x0001, 24, 6)
1304 /* The target link-layer address option in an IPv6 Neighbor Discovery
1308 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1309 * NXM_OF_IP_PROTO must match 58 exactly.
1310 * NXM_OF_ICMPV6_TYPE must be exactly 136.
1312 * Format: 48-bit Ethernet MAC address.
1314 * Masking: Not maskable. */
1315 #define NXM_NX_ND_TLL NXM_HEADER (0x0001, 25, 6)
1318 /* ## --------------------- ## */
1319 /* ## Requests and replies. ## */
1320 /* ## --------------------- ## */
1322 enum nx_flow_format {
1323 NXFF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
1324 NXFF_NXM = 2 /* Nicira extended match. */
1327 /* NXT_SET_FLOW_FORMAT request. */
1328 struct nxt_set_flow_format {
1329 struct ofp_header header;
1330 ovs_be32 vendor; /* NX_VENDOR_ID. */
1331 ovs_be32 subtype; /* NXT_SET_FLOW_FORMAT. */
1332 ovs_be32 format; /* One of NXFF_*. */
1334 OFP_ASSERT(sizeof(struct nxt_set_flow_format) == 20);
1336 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */
1337 struct nx_flow_mod {
1338 struct nicira_header nxh;
1339 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1340 ovs_be16 command; /* One of OFPFC_*. */
1341 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
1342 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
1343 ovs_be16 priority; /* Priority level of flow entry. */
1344 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
1345 Not meaningful for OFPFC_DELETE*. */
1346 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
1347 matching entries to include this as an
1348 output port. A value of OFPP_NONE
1349 indicates no restriction. */
1350 ovs_be16 flags; /* One of OFPFF_*. */
1351 ovs_be16 match_len; /* Size of nx_match. */
1352 uint8_t pad[6]; /* Align to 64-bits. */
1354 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1355 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1356 * all-zero bytes, then
1357 * - Actions to fill out the remainder of the message length (always a
1361 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
1363 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1364 struct nx_flow_removed {
1365 struct nicira_header nxh;
1366 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1367 ovs_be16 priority; /* Priority level of flow entry. */
1368 uint8_t reason; /* One of OFPRR_*. */
1369 uint8_t pad[1]; /* Align to 32-bits. */
1370 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
1371 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
1373 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
1374 ovs_be16 match_len; /* Size of nx_match. */
1375 ovs_be64 packet_count;
1376 ovs_be64 byte_count;
1378 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1379 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1380 * all-zero bytes. */
1382 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
1384 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1386 struct nx_flow_stats_request {
1387 struct nicira_stats_msg nsm;
1388 ovs_be16 out_port; /* Require matching entries to include this
1389 as an output port. A value of OFPP_NONE
1390 indicates no restriction. */
1391 ovs_be16 match_len; /* Length of nx_match. */
1392 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1393 or 0xff for all tables. */
1394 uint8_t pad[3]; /* Align to 64 bits. */
1396 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1397 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1398 * all-zero bytes, which must also exactly fill out the length of the
1402 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
1404 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1405 * OFPST_FLOW reply). */
1406 struct nx_flow_stats {
1407 ovs_be16 length; /* Length of this entry. */
1408 uint8_t table_id; /* ID of table flow came from. */
1410 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
1411 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
1412 beyond duration_sec. */
1413 ovs_be16 priority; /* Priority of the entry. Only meaningful
1414 when this is not an exact-match entry. */
1415 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
1416 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
1417 ovs_be16 match_len; /* Length of nx_match. */
1418 uint8_t pad2[4]; /* Align to 64 bits. */
1419 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1420 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1421 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1423 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1424 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1425 * all-zero bytes, then
1426 * - Actions to fill out the remainder 'length' bytes (always a multiple
1430 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1432 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1433 * OFPST_AGGREGATE request). */
1434 struct nx_aggregate_stats_request {
1435 struct nicira_stats_msg nsm;
1436 ovs_be16 out_port; /* Require matching entries to include this
1437 as an output port. A value of OFPP_NONE
1438 indicates no restriction. */
1439 ovs_be16 match_len; /* Length of nx_match. */
1440 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1441 or 0xff for all tables. */
1442 uint8_t pad[3]; /* Align to 64 bits. */
1444 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1445 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1446 * all-zero bytes, which must also exactly fill out the length of the
1450 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1452 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1453 * OFPST_AGGREGATE reply). */
1454 struct nx_aggregate_stats_reply {
1455 struct nicira_stats_msg nsm;
1456 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1457 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1458 ovs_be32 flow_count; /* Number of flows. */
1459 uint8_t pad[4]; /* Align to 64 bits. */
1461 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1463 #endif /* openflow/nicira-ext.h */