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 */
285 NXAST_LEARN
, /* struct nx_action_learn */
286 NXAST_EXIT
/* struct nx_action_header */
289 /* Header for Nicira-defined actions. */
290 struct nx_action_header
{
291 ovs_be16 type
; /* OFPAT_VENDOR. */
292 ovs_be16 len
; /* Length is 16. */
293 ovs_be32 vendor
; /* NX_VENDOR_ID. */
294 ovs_be16 subtype
; /* NXAST_*. */
297 OFP_ASSERT(sizeof(struct nx_action_header
) == 16);
299 /* Action structures for NXAST_RESUBMIT and NXAST_RESUBMIT_TABLE.
301 * These actions search one of the switch's flow tables:
303 * - For NXAST_RESUBMIT_TABLE only, if the 'table' member is not 255, then
304 * it specifies the table to search.
306 * - Otherwise (for NXAST_RESUBMIT_TABLE with a 'table' of 255, or for
307 * NXAST_RESUBMIT regardless of 'table'), it searches the current flow
308 * table, that is, the OpenFlow flow table that contains the flow from
309 * which this action was obtained. If this action did not come from a
310 * flow table (e.g. it came from an OFPT_PACKET_OUT message), then table 0
311 * is the current table.
313 * The flow table lookup uses a flow that may be slightly modified from the
316 * - For NXAST_RESUBMIT, the 'in_port' member of struct nx_action_resubmit
317 * is used as the flow's in_port.
319 * - For NXAST_RESUBMIT_TABLE, if the 'in_port' member is not OFPP_IN_PORT,
320 * then its value is used as the flow's in_port. Otherwise, the original
323 * - If actions that modify the flow (e.g. OFPAT_SET_VLAN_VID) precede the
324 * resubmit action, then the flow is updated with the new values.
326 * Following the lookup, the original in_port is restored.
328 * If the modified flow matched in the flow table, then the corresponding
329 * actions are executed. Afterward, actions following the resubmit in the
330 * original set of actions, if any, are executed; any changes made to the
331 * packet (e.g. changes to VLAN) by secondary actions persist when those
332 * actions are executed, although the original in_port is restored.
334 * Resubmit actions may be used any number of times within a set of actions.
336 * Resubmit actions may nest to an implementation-defined depth. Beyond this
337 * implementation-defined depth, further resubmit actions are simply ignored.
339 * NXAST_RESUBMIT ignores 'table' and 'pad'. NXAST_RESUBMIT_TABLE requires
340 * 'pad' to be all-bits-zero.
342 * Open vSwitch 1.0.1 and earlier did not support recursion. Open vSwitch
343 * before 1.2.90 did not support NXAST_RESUBMIT_TABLE.
345 struct nx_action_resubmit
{
346 ovs_be16 type
; /* OFPAT_VENDOR. */
347 ovs_be16 len
; /* Length is 16. */
348 ovs_be32 vendor
; /* NX_VENDOR_ID. */
349 ovs_be16 subtype
; /* NXAST_RESUBMIT. */
350 ovs_be16 in_port
; /* New in_port for checking flow table. */
351 uint8_t table
; /* NXAST_RESUBMIT_TABLE: table to use. */
354 OFP_ASSERT(sizeof(struct nx_action_resubmit
) == 16);
356 /* Action structure for NXAST_SET_TUNNEL.
358 * Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32
359 * bits of the tunnel ID are set to 0. */
360 struct nx_action_set_tunnel
{
361 ovs_be16 type
; /* OFPAT_VENDOR. */
362 ovs_be16 len
; /* Length is 16. */
363 ovs_be32 vendor
; /* NX_VENDOR_ID. */
364 ovs_be16 subtype
; /* NXAST_SET_TUNNEL. */
366 ovs_be32 tun_id
; /* Tunnel ID. */
368 OFP_ASSERT(sizeof(struct nx_action_set_tunnel
) == 16);
370 /* Action structure for NXAST_SET_TUNNEL64.
372 * Sets the encapsulating tunnel ID to a 64-bit value. */
373 struct nx_action_set_tunnel64
{
374 ovs_be16 type
; /* OFPAT_VENDOR. */
375 ovs_be16 len
; /* Length is 16. */
376 ovs_be32 vendor
; /* NX_VENDOR_ID. */
377 ovs_be16 subtype
; /* NXAST_SET_TUNNEL64. */
379 ovs_be64 tun_id
; /* Tunnel ID. */
381 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64
) == 24);
383 /* Action structure for NXAST_SET_QUEUE.
385 * Set the queue that should be used when packets are output. This is similar
386 * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
387 * an argument. This allows the queue to be defined before the port is
389 struct nx_action_set_queue
{
390 ovs_be16 type
; /* OFPAT_VENDOR. */
391 ovs_be16 len
; /* Length is 16. */
392 ovs_be32 vendor
; /* NX_VENDOR_ID. */
393 ovs_be16 subtype
; /* NXAST_SET_QUEUE. */
395 ovs_be32 queue_id
; /* Where to enqueue packets. */
397 OFP_ASSERT(sizeof(struct nx_action_set_queue
) == 16);
399 /* Action structure for NXAST_POP_QUEUE.
401 * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
402 * were used. Only the original queue can be restored this way; no stack is
404 struct nx_action_pop_queue
{
405 ovs_be16 type
; /* OFPAT_VENDOR. */
406 ovs_be16 len
; /* Length is 16. */
407 ovs_be32 vendor
; /* NX_VENDOR_ID. */
408 ovs_be16 subtype
; /* NXAST_POP_QUEUE. */
411 OFP_ASSERT(sizeof(struct nx_action_pop_queue
) == 16);
413 /* Action structure for NXAST_REG_MOVE.
415 * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
416 * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
417 * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
418 * the next most significant bit, and so on.
420 * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
421 * sense to use nxm_hasmask=1 because the action does not do any kind of
422 * matching; it uses the actual value of a field.)
424 * The following nxm_header values are potentially acceptable as 'src':
447 * - NXM_NX_ICMPV6_TYPE
448 * - NXM_NX_ICMPV6_CODE
451 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
453 * The following nxm_header values are potentially acceptable as 'dst':
464 * Modifying any of the above fields changes the corresponding packet
467 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
469 * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
470 * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
471 * header (if any), ignoring the other bits. Setting a value with CFI=1
472 * adds or modifies the 802.1Q header appropriately, setting the TCI field
473 * to the field's new value (with the CFI bit masked out).
475 * - NXM_NX_TUN_ID. Modifying this value modifies the tunnel ID used for the
476 * packet's next tunnel encapsulation.
478 * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
479 * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
480 * used only if the flow's nx_match includes an nxm_entry that specifies
481 * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
483 * The switch will reject actions for which src_ofs+n_bits is greater than the
484 * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
485 * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
487 struct nx_action_reg_move
{
488 ovs_be16 type
; /* OFPAT_VENDOR. */
489 ovs_be16 len
; /* Length is 16. */
490 ovs_be32 vendor
; /* NX_VENDOR_ID. */
491 ovs_be16 subtype
; /* NXAST_REG_MOVE. */
492 ovs_be16 n_bits
; /* Number of bits. */
493 ovs_be16 src_ofs
; /* Starting bit offset in source. */
494 ovs_be16 dst_ofs
; /* Starting bit offset in destination. */
495 ovs_be32 src
; /* Source register. */
496 ovs_be32 dst
; /* Destination register. */
498 OFP_ASSERT(sizeof(struct nx_action_reg_move
) == 24);
500 /* Action structure for NXAST_REG_LOAD.
502 * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
503 * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
504 * starts at 0 for the least-significant bit, 1 for the next most significant
507 * 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for
508 * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
511 * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
512 * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
513 * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
514 * also stored as one less than its true value:
517 * +------------------------------+------------------+
518 * | ofs | n_bits - 1 |
519 * +------------------------------+------------------+
521 * The switch will reject actions for which ofs+n_bits is greater than the
522 * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
523 * greater are set to 1, with error type OFPET_BAD_ACTION, code
524 * OFPBAC_BAD_ARGUMENT.
526 struct nx_action_reg_load
{
527 ovs_be16 type
; /* OFPAT_VENDOR. */
528 ovs_be16 len
; /* Length is 16. */
529 ovs_be32 vendor
; /* NX_VENDOR_ID. */
530 ovs_be16 subtype
; /* NXAST_REG_LOAD. */
531 ovs_be16 ofs_nbits
; /* (ofs << 6) | (n_bits - 1). */
532 ovs_be32 dst
; /* Destination register. */
533 ovs_be64 value
; /* Immediate value. */
535 OFP_ASSERT(sizeof(struct nx_action_reg_load
) == 24);
537 /* Action structure for NXAST_NOTE.
539 * This action has no effect. It is variable length. The switch does not
540 * attempt to interpret the user-defined 'note' data in any way. A controller
541 * can use this action to attach arbitrary metadata to a flow.
543 * This action might go away in the future.
545 struct nx_action_note
{
546 ovs_be16 type
; /* OFPAT_VENDOR. */
547 ovs_be16 len
; /* A multiple of 8, but at least 16. */
548 ovs_be32 vendor
; /* NX_VENDOR_ID. */
549 ovs_be16 subtype
; /* NXAST_NOTE. */
550 uint8_t note
[6]; /* Start of user-defined data. */
551 /* Possibly followed by additional user-defined data. */
553 OFP_ASSERT(sizeof(struct nx_action_note
) == 16);
555 /* Action structure for NXAST_MULTIPATH.
557 * This action performs the following steps in sequence:
559 * 1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
560 * Refer to the definition of "enum nx_mp_fields" for details.
562 * The 'basis' value is used as a universal hash parameter, that is,
563 * different values of 'basis' yield different hash functions. The
564 * particular universal hash function used is implementation-defined.
566 * The hashed fields' values are drawn from the current state of the
567 * flow, including all modifications that have been made by actions up to
570 * 2. Applies the multipath link choice algorithm specified by 'algorithm',
571 * one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm"
574 * The output of the algorithm is 'link', an unsigned integer less than
575 * or equal to 'max_link'.
577 * Some algorithms use 'arg' as an additional argument.
579 * 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of
580 * 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
583 * The switch will reject actions that have an unknown 'fields', or an unknown
584 * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
585 * in which 'max_link' is greater than or equal to 2**n_bits, with error type
586 * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
588 struct nx_action_multipath
{
589 ovs_be16 type
; /* OFPAT_VENDOR. */
590 ovs_be16 len
; /* Length is 32. */
591 ovs_be32 vendor
; /* NX_VENDOR_ID. */
592 ovs_be16 subtype
; /* NXAST_MULTIPATH. */
594 /* What fields to hash and how. */
595 ovs_be16 fields
; /* One of NX_HASH_FIELDS_*. */
596 ovs_be16 basis
; /* Universal hash parameter. */
599 /* Multipath link choice algorithm to apply to hash value. */
600 ovs_be16 algorithm
; /* One of NX_MP_ALG_*. */
601 ovs_be16 max_link
; /* Number of output links, minus 1. */
602 ovs_be32 arg
; /* Algorithm-specific argument. */
605 /* Where to store the result. */
606 ovs_be16 ofs_nbits
; /* (ofs << 6) | (n_bits - 1). */
607 ovs_be32 dst
; /* Destination. */
609 OFP_ASSERT(sizeof(struct nx_action_multipath
) == 32);
611 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
613 * In the descriptions below, 'n_links' is max_link + 1. */
614 enum nx_mp_algorithm
{
615 /* link = hash(flow) % n_links.
617 * Redistributes all traffic when n_links changes. O(1) performance. See
620 * Use UINT16_MAX for max_link to get a raw hash value. */
623 /* link = hash(flow) / (MAX_HASH / n_links).
625 * Redistributes between one-quarter and one-half of traffic when n_links
626 * changes. O(1) performance. See RFC 2992.
628 NX_MP_ALG_HASH_THRESHOLD
,
630 /* for i in [0,n_links):
631 * weights[i] = hash(flow, i)
632 * link = { i such that weights[i] >= weights[j] for all j != i }
634 * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
635 * performance. If n_links is greater than a threshold (currently 64, but
636 * subject to change), Open vSwitch will substitute another algorithm
637 * automatically. See RFC 2992. */
638 NX_MP_ALG_HRW
, /* Highest Random Weight. */
643 * link = hash(flow, i) % arg
644 * while link > max_link
646 * Redistributes 1/n_links of traffic when n_links changes. O(1)
647 * performance when arg/max_link is bounded by a constant.
649 * Redistributes all traffic when arg changes.
651 * arg must be greater than max_link and for best performance should be no
652 * more than approximately max_link * 2. If arg is outside the acceptable
653 * range, Open vSwitch will automatically substitute the least power of 2
654 * greater than max_link.
656 * This algorithm is specific to Open vSwitch.
658 NX_MP_ALG_ITER_HASH
/* Iterative Hash. */
661 /* Action structure for NXAST_LEARN.
663 * This action adds or modifies a flow in an OpenFlow table, similar to
664 * OFPT_FLOW_MOD with OFPFC_MODIFY_STRICT as 'command'. The new flow has the
665 * specified idle timeout, hard timeout, priority, cookie, and flags. The new
666 * flow's match criteria and actions are built by applying each of the series
667 * of flow_mod_spec elements included as part of the action.
669 * A flow_mod_spec starts with a 16-bit header. A header that is all-bits-0 is
670 * a no-op used for padding the action as a whole to a multiple of 8 bytes in
671 * length. Otherwise, the flow_mod_spec can be thought of as copying 'n_bits'
672 * bits from a source to a destination. In this case, the header contains
675 * 15 14 13 12 11 10 0
676 * +------+---+------+---------------------------------+
677 * | 0 |src| dst | n_bits |
678 * +------+---+------+---------------------------------+
680 * The meaning and format of a flow_mod_spec depends on 'src' and 'dst'. The
681 * following table summarizes the meaning of each possible combination.
682 * Details follow the table:
685 * --- --- ----------------------------------------------------------
686 * 0 0 Add match criteria based on value in a field.
687 * 1 0 Add match criteria based on an immediate value.
688 * 0 1 Add NXAST_REG_LOAD action to copy field into a different field.
689 * 1 1 Add NXAST_REG_LOAD action to load immediate value into a field.
690 * 0 2 Add OFPAT_OUTPUT action to output to port from specified field.
691 * All other combinations are undefined and not allowed.
693 * The flow_mod_spec header is followed by a source specification and a
694 * destination specification. The format and meaning of the source
695 * specification depends on 'src':
697 * - If 'src' is 0, the source bits are taken from a field in the flow to
698 * which this action is attached. (This should be a wildcarded field. If
699 * its value is fully specified then the source bits being copied have
702 * The source specification is an ovs_be32 'field' and an ovs_be16 'ofs'.
703 * 'field' is an nxm_header with nxm_hasmask=0, and 'ofs' the starting bit
704 * offset within that field. The source bits are field[ofs:ofs+n_bits-1].
705 * 'field' and 'ofs' are subject to the same restrictions as the source
706 * field in NXAST_REG_MOVE.
708 * - If 'src' is 1, the source bits are a constant value. The source
709 * specification is (n_bits+15)/16*2 bytes long. Taking those bytes as a
710 * number in network order, the source bits are the 'n_bits'
711 * least-significant bits. The switch will report an error if other bits
712 * in the constant are nonzero.
714 * The flow_mod_spec destination specification, for 'dst' of 0 or 1, is an
715 * ovs_be32 'field' and an ovs_be16 'ofs'. 'field' is an nxm_header with
716 * nxm_hasmask=0 and 'ofs' is a starting bit offset within that field. The
717 * meaning of the flow_mod_spec depends on 'dst':
719 * - If 'dst' is 0, the flow_mod_spec specifies match criteria for the new
720 * flow. The new flow matches only if bits field[ofs:ofs+n_bits-1] in a
721 * packet equal the source bits. 'field' may be any nxm_header with
722 * nxm_hasmask=0 that is allowed in NXT_FLOW_MOD.
724 * Order is significant. Earlier flow_mod_specs must satisfy any
725 * prerequisites for matching fields specified later, by copying constant
726 * values into prerequisite fields.
728 * The switch will reject flow_mod_specs that do not satisfy NXM masking
731 * - If 'dst' is 1, the flow_mod_spec specifies an NXAST_REG_LOAD action for
732 * the new flow. The new flow copies the source bits into
733 * field[ofs:ofs+n_bits-1]. Actions are executed in the same order as the
736 * The flow_mod_spec destination spec for 'dst' of 2 (when 'src' is 0) is
737 * empty. It has the following meaning:
739 * - The flow_mod_spec specifies an OFPAT_OUTPUT action for the new flow.
740 * The new flow outputs to the OpenFlow port specified by the source field.
741 * Of the special output ports with value OFPP_MAX or larger, OFPP_IN_PORT,
742 * OFPP_FLOOD, OFPP_LOCAL, and OFPP_ALL are supported. Other special ports
745 * Resource Management
746 * -------------------
748 * A switch has a finite amount of flow table space available for learning.
749 * When this space is exhausted, no new learning table entries will be learned
750 * until some existing flow table entries expire. The controller should be
751 * prepared to handle this by flooding (which can be implemented as a
752 * low-priority flow).
757 * The following examples give a prose description of the flow_mod_specs along
758 * with informal notation for how those would be represented and a hex dump of
759 * the bytes that would be required.
761 * These examples could work with various nx_action_learn parameters. Typical
762 * values would be idle_timeout=OFP_FLOW_PERMANENT, hard_timeout=60,
763 * priority=OFP_DEFAULT_PRIORITY, flags=0, table_id=10.
765 * 1. Learn input port based on the source MAC, with lookup into
766 * NXM_NX_REG1[16:31] by resubmit to in_port=99:
768 * Match on in_port=99:
769 * ovs_be16(src=1, dst=0, n_bits=16), 20 10
770 * ovs_be16(99), 00 63
771 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
773 * Match Ethernet destination on Ethernet source from packet:
774 * ovs_be16(src=0, dst=0, n_bits=48), 00 30
775 * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
776 * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
778 * Set NXM_NX_REG1[16:31] to the packet's input port:
779 * ovs_be16(src=0, dst=1, n_bits=16), 08 10
780 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
781 * ovs_be32(NXM_NX_REG1), ovs_be16(16) 00 01 02 04 00 10
783 * Given a packet that arrived on port A with Ethernet source address B,
784 * this would set up the flow "in_port=99, dl_dst=B,
785 * actions=load:A->NXM_NX_REG1[16..31]".
787 * In syntax accepted by ovs-ofctl, this action is: learn(in_port=99,
788 * NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
789 * load:NXM_OF_IN_PORT[]->NXM_NX_REG1[16..31])
791 * 2. Output to input port based on the source MAC and VLAN VID, with lookup
792 * into NXM_NX_REG1[16:31]:
794 * Match on same VLAN ID as packet:
795 * ovs_be16(src=0, dst=0, n_bits=12), 00 0c
796 * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
797 * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
799 * Match Ethernet destination on Ethernet source from packet:
800 * ovs_be16(src=0, dst=0, n_bits=48), 00 30
801 * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
802 * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
804 * Output to the packet's input port:
805 * ovs_be16(src=0, dst=2, n_bits=16), 10 10
806 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
808 * Given a packet that arrived on port A with Ethernet source address B in
809 * VLAN C, this would set up the flow "dl_dst=B, vlan_vid=C,
812 * In syntax accepted by ovs-ofctl, this action is:
813 * learn(NXM_OF_VLAN_TCI[0..11], NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
814 * output:NXM_OF_IN_PORT[])
816 * 3. Here's a recipe for a very simple-minded MAC learning switch. It uses a
817 * 10-second MAC expiration time to make it easier to see what's going on
819 * ovs-vsctl del-controller br0
820 * ovs-ofctl del-flows br0
821 * ovs-ofctl add-flow br0 "table=0 actions=learn(table=1, \
822 hard_timeout=10, NXM_OF_VLAN_TCI[0..11], \
823 NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[], \
824 output:NXM_OF_IN_PORT[]), resubmit(,1)"
825 * ovs-ofctl add-flow br0 "table=1 priority=0 actions=flood"
827 * You can then dump the MAC learning table with:
829 * ovs-ofctl dump-flows br0 table=1
834 * For best performance, segregate learned flows into a table that is not used
835 * for any other flows except possibly for a lowest-priority "catch-all" flow
836 * (a flow with no match criteria). If different learning actions specify
837 * different match criteria, use different tables for the learned flows.
839 * The meaning of 'hard_timeout' and 'idle_timeout' can be counterintuitive.
840 * These timeouts apply to the flow that is added, which means that a flow with
841 * an idle timeout will expire when no traffic has been sent *to* the learned
842 * address. This is not usually the intent in MAC learning; instead, we want
843 * the MAC learn entry to expire when no traffic has been sent *from* the
844 * learned address. Use a hard timeout for that.
846 struct nx_action_learn
{
847 ovs_be16 type
; /* OFPAT_VENDOR. */
848 ovs_be16 len
; /* At least 24. */
849 ovs_be32 vendor
; /* NX_VENDOR_ID. */
850 ovs_be16 subtype
; /* NXAST_LEARN. */
851 ovs_be16 idle_timeout
; /* Idle time before discarding (seconds). */
852 ovs_be16 hard_timeout
; /* Max time before discarding (seconds). */
853 ovs_be16 priority
; /* Priority level of flow entry. */
854 ovs_be64 cookie
; /* Cookie for new flow. */
855 ovs_be16 flags
; /* Either 0 or OFPFF_SEND_FLOW_REM. */
856 uint8_t table_id
; /* Table to insert flow entry. */
857 uint8_t pad
[5]; /* Must be zero. */
858 /* Followed by a sequence of flow_mod_spec elements, as described above,
859 * until the end of the action is reached. */
861 OFP_ASSERT(sizeof(struct nx_action_learn
) == 32);
863 #define NX_LEARN_N_BITS_MASK 0x3ff
865 #define NX_LEARN_SRC_FIELD (0 << 13) /* Copy from field. */
866 #define NX_LEARN_SRC_IMMEDIATE (1 << 13) /* Copy from immediate value. */
867 #define NX_LEARN_SRC_MASK (1 << 13)
869 #define NX_LEARN_DST_MATCH (0 << 11) /* Add match criterion. */
870 #define NX_LEARN_DST_LOAD (1 << 11) /* Add NXAST_REG_LOAD action. */
871 #define NX_LEARN_DST_OUTPUT (2 << 11) /* Add OFPAT_OUTPUT action. */
872 #define NX_LEARN_DST_RESERVED (3 << 11) /* Not yet defined. */
873 #define NX_LEARN_DST_MASK (3 << 11)
875 /* Action structure for NXAST_AUTOPATH.
877 * This action performs the following steps in sequence:
879 * 1. Hashes the flow using an implementation-defined hash function.
881 * The hashed fields' values are drawn from the current state of the
882 * flow, including all modifications that have been made by actions up to
885 * 2. Selects an OpenFlow 'port'.
887 * 'port' is selected in an implementation-defined manner, taking into
888 * account 'id' and the hash value calculated in step 1.
890 * Generally a switch will have been configured with a set of ports that
891 * may be chosen given 'id'. The switch may take into account any number
892 * of factors when choosing 'port' from its configured set. Factors may
893 * include carrier, load, and the results of configuration protocols such
896 * 3. Stores 'port' in dst[ofs:ofs+n_bits].
898 * The format and semantics of 'dst' and 'ofs_nbits' are similar to those
899 * for the NXAST_REG_LOAD action.
901 * The switch will reject actions in which ofs+n_bits is greater than the width
902 * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
904 struct nx_action_autopath
{
905 ovs_be16 type
; /* OFPAT_VENDOR. */
906 ovs_be16 len
; /* Length is 20. */
907 ovs_be32 vendor
; /* NX_VENDOR_ID. */
908 ovs_be16 subtype
; /* NXAST_AUTOPATH. */
910 /* Where to store the result. */
911 ovs_be16 ofs_nbits
; /* (ofs << 6) | (n_bits - 1). */
912 ovs_be32 dst
; /* Destination. */
914 ovs_be32 id
; /* Autopath ID. */
917 OFP_ASSERT(sizeof(struct nx_action_autopath
) == 24);
919 /* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD.
921 * The bundle actions choose a slave from a supplied list of options.
922 * NXAST_BUNDLE outputs to its selection. NXAST_BUNDLE_LOAD writes its
923 * selection to a register.
925 * The list of possible slaves follows the nx_action_bundle structure. The size
926 * of each slave is governed by its type as indicated by the 'slave_type'
927 * parameter. The list of slaves should be padded at its end with zeros to make
928 * the total length of the action a multiple of 8.
930 * Switches infer from the 'slave_type' parameter the size of each slave. All
931 * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
932 * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
933 * 2 byte width. Switches should reject actions which indicate unknown or
934 * unsupported slave types.
936 * Switches use a strategy dictated by the 'algorithm' parameter to choose a
937 * slave. If the switch does not support the specified 'algorithm' parameter,
938 * it should reject the action.
940 * Several algorithms take into account liveness when selecting slaves. The
941 * liveness of a slave is implementation defined (with one exception), but will
942 * generally take into account things like its carrier status and the results
943 * of any link monitoring protocols which happen to be running on it. In order
944 * to give controllers a place-holder value, the OFPP_NONE port is always
947 * Some slave selection strategies require the use of a hash function, in which
948 * case the 'fields' and 'basis' parameters should be populated. The 'fields'
949 * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
950 * hash. Refer to the definition of "enum nx_hash_fields" for details. The
951 * 'basis' parameter is used as a universal hash parameter. Different values
952 * of 'basis' yield different hash results.
954 * The 'zero' parameter at the end of the action structure is reserved for
955 * future use. Switches are required to reject actions which have nonzero
956 * bytes in the 'zero' field.
958 * NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed. Switches
959 * should reject actions which have nonzero bytes in either of these fields.
961 * NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in
962 * dst[ofs:ofs+n_bits]. The format and semantics of 'dst' and 'ofs_nbits' are
963 * similar to those for the NXAST_REG_LOAD action. */
964 struct nx_action_bundle
{
965 ovs_be16 type
; /* OFPAT_VENDOR. */
966 ovs_be16 len
; /* Length including slaves. */
967 ovs_be32 vendor
; /* NX_VENDOR_ID. */
968 ovs_be16 subtype
; /* NXAST_BUNDLE. */
970 /* Slave choice algorithm to apply to hash value. */
971 ovs_be16 algorithm
; /* One of NX_BD_ALG_*. */
973 /* What fields to hash and how. */
974 ovs_be16 fields
; /* One of NX_HASH_FIELDS_*. */
975 ovs_be16 basis
; /* Universal hash parameter. */
977 ovs_be32 slave_type
; /* NXM_OF_IN_PORT. */
978 ovs_be16 n_slaves
; /* Number of slaves. */
980 ovs_be16 ofs_nbits
; /* (ofs << 6) | (n_bits - 1). */
981 ovs_be32 dst
; /* Destination. */
983 uint8_t zero
[4]; /* Reserved. Must be zero. */
985 OFP_ASSERT(sizeof(struct nx_action_bundle
) == 32);
987 /* NXAST_BUNDLE: Bundle slave choice algorithm to apply.
989 * In the descriptions below, 'slaves' is the list of possible slaves in the
990 * order they appear in the OpenFlow action. */
991 enum nx_bd_algorithm
{
992 /* Chooses the first live slave listed in the bundle.
994 * O(n_slaves) performance. */
995 NX_BD_ALG_ACTIVE_BACKUP
,
997 /* for i in [0,n_slaves):
998 * weights[i] = hash(flow, i)
999 * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
1001 * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
1002 * O(n_slaves) performance.
1004 * Uses the 'fields' and 'basis' parameters. */
1005 NX_BD_ALG_HRW
/* Highest Random Weight. */
1008 /* Action structure for NXAST_OUTPUT_REG.
1010 * Outputs to the OpenFlow port number written to src[ofs:ofs+nbits].
1012 * The format and semantics of 'src' and 'ofs_nbits' are similar to those for
1013 * the NXAST_REG_LOAD action.
1015 * The acceptable nxm_header values for 'src' are the same as the acceptable
1016 * nxm_header values for the 'src' field of NXAST_REG_MOVE.
1018 * The 'max_len' field indicates the number of bytes to send when the chosen
1019 * port is OFPP_CONTROLLER. Its semantics are equivalent to the 'max_len'
1020 * field of OFPAT_OUTPUT.
1022 * The 'zero' field is required to be zeroed for forward compatibility. */
1023 struct nx_action_output_reg
{
1024 ovs_be16 type
; /* OFPAT_VENDOR. */
1025 ovs_be16 len
; /* 24. */
1026 ovs_be32 vendor
; /* NX_VENDOR_ID. */
1027 ovs_be16 subtype
; /* NXAST_OUTPUT_REG. */
1029 ovs_be16 ofs_nbits
; /* (ofs << 6) | (n_bits - 1). */
1030 ovs_be32 src
; /* Source. */
1032 ovs_be16 max_len
; /* Max length to send to controller. */
1034 uint8_t zero
[6]; /* Reserved, must be zero. */
1036 OFP_ASSERT(sizeof(struct nx_action_output_reg
) == 24);
1040 * Discontinues action processing.
1042 * The NXAST_EXIT action causes the switch to immediately halt processing
1043 * actions for the flow. Any actions which have already been processed are
1044 * executed by the switch. However, any further actions, including those which
1045 * may be in different tables, or different levels of the NXAST_RESUBMIT
1046 * hierarchy, will be ignored.
1048 * Uses the nx_action_header structure. */
1050 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
1052 * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches. This
1053 * structure is fixed-length and hence difficult to extend. This section
1054 * describes a more flexible, variable-length flow match, called "nx_match" for
1055 * short, that is also supported by Open vSwitch. This section also defines a
1056 * replacement for each OpenFlow message that includes struct ofp_match.
1062 * An nx_match is a sequence of zero or more "nxm_entry"s, which are
1063 * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
1064 * "nxm_entry"s are not aligned on or padded to any multibyte boundary. The
1065 * first 4 bytes of an nxm_entry are its "header", followed by the entry's
1068 * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
1070 * |<-------------------- nxm_type ------------------>|
1072 * |31 16 15 9| 8 7 0
1073 * +----------------------------------+---------------+--+------------------+
1074 * | nxm_vendor | nxm_field |hm| nxm_length |
1075 * +----------------------------------+---------------+--+------------------+
1077 * The most-significant 23 bits of the header are collectively "nxm_type".
1078 * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
1079 * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
1080 * designates a protocol header, such as the Ethernet type, but it can also
1081 * refer to packet metadata, such as the switch port on which a packet arrived.
1083 * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
1084 * of this bit is explained later.
1086 * The least-significant 8 bits are "nxm_length", a positive integer. The
1087 * length of the nxm_entry, including the header, is exactly 4 + nxm_length
1090 * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
1091 * constant. It is included only to allow software to minimally parse
1092 * "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor,
1093 * nxm_field, and nxm_length, nxm_hasmask is a constant.)
1099 * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
1101 * An nxm_entry places a constraint on the packets matched by the nx_match:
1103 * - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
1104 * field, called "nxm_value". The nx_match matches only packets in which
1105 * the field equals nxm_value.
1107 * - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
1108 * field (nxm_value), followed by a bitmask of the same length as the
1109 * value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
1110 * nx_match matches only packets for which bit J in the given field's value
1111 * matches bit J in nxm_value. A 0-bit in nxm_mask causes the
1112 * corresponding bits in nxm_value and the field's value to be ignored.
1113 * (The sense of the nxm_mask bits is the opposite of that used by the
1114 * "wildcards" member of struct ofp_match.)
1116 * When nxm_hasmask is 1, nxm_length is always even.
1118 * An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
1119 * entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for
1122 * When there are multiple "nxm_entry"s, all of the constraints must be met.
1128 * Masks may be restricted:
1130 * - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
1131 * must always be 0 when these fields are specified. For example, the
1132 * field that identifies the port on which a packet was received may not be
1135 * - Some nxm_types that do support masked wildcards may only support certain
1136 * nxm_mask patterns. For example, fields that have IPv4 address values
1137 * may be restricted to CIDR masks.
1139 * These restrictions should be noted in specifications for individual fields.
1140 * A switch may accept an nxm_hasmask or nxm_mask value that the specification
1141 * disallows, if the switch correctly implements support for that nxm_hasmask
1142 * or nxm_mask value. A switch must reject an attempt to set up a flow that
1143 * contains a nxm_hasmask or nxm_mask value that it does not support.
1146 * Prerequisite Restrictions
1147 * =========================
1149 * The presence of an nxm_entry with a given nxm_type may be restricted based
1150 * on the presence of or values of other "nxm_entry"s. For example:
1152 * - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
1153 * preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
1154 * and nxm_value=0x0800. That is, matching on the IP source address is
1155 * allowed only if the Ethernet type is explicitly set to IP.
1157 * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is
1158 * preceded by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and
1159 * nxm_value either 0x0800 or 0x86dd, and another with
1160 * nxm_type=NXM_OF_IP_PROTO, nxm_hasmask=0, nxm_value=6, in that order.
1161 * That is, matching on the TCP source port is allowed only if the Ethernet
1162 * type is IP or IPv6 and the IP protocol is TCP.
1164 * These restrictions should be noted in specifications for individual fields.
1165 * A switch may implement relaxed versions of these restrictions. A switch
1166 * must reject an attempt to set up a flow that violates its restrictions.
1169 * Ordering Restrictions
1170 * =====================
1172 * An nxm_entry that has prerequisite restrictions must appear after the
1173 * "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an
1174 * nx_match is not otherwise constrained.
1176 * Any given nxm_type may appear in an nx_match at most once.
1179 * nxm_entry Examples
1180 * ==================
1182 * These examples show the format of a single nxm_entry with particular
1183 * nxm_hasmask and nxm_length values. The diagrams are labeled with field
1184 * numbers and byte indexes.
1187 * 8-bit nxm_value, nxm_hasmask=1, nxm_length=2:
1190 * +------------+---+---+
1191 * | header | v | m |
1192 * +------------+---+---+
1195 * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
1198 * +------------+------+
1200 * +------------+------+
1203 * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
1206 * +------------+-------------+
1207 * | header | nxm_value |
1208 * +------------+-------------+
1211 * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
1214 * +------------+------------------+
1215 * | header | nxm_value |
1216 * +------------+------------------+
1219 * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
1222 * +------------+------------------+------------------+
1223 * | header | nxm_value | nxm_mask |
1224 * +------------+------------------+------------------+
1230 * A switch should report an error in an nx_match using error type
1231 * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch
1232 * should report a specific error code, if one is assigned for the particular
1233 * problem, but NXBRC_NXM_INVALID is also available to report a generic
1237 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
1238 (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
1239 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
1240 NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
1241 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
1242 NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
1243 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
1244 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
1245 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
1246 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
1247 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
1249 #define NXM_MAKE_WILD_HEADER(HEADER) \
1250 NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
1252 /* ## ------------------------------- ## */
1253 /* ## OpenFlow 1.0-compatible fields. ## */
1254 /* ## ------------------------------- ## */
1256 /* Physical or virtual port on which the packet was received.
1260 * Format: 16-bit integer in network byte order.
1262 * Masking: Not maskable. */
1263 #define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
1265 /* Source or destination address in Ethernet header.
1269 * Format: 48-bit Ethernet MAC address.
1271 * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
1272 * be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
1273 * are all-0-bits or all-1-bits). Support for other patterns and for masking
1274 * of NXM_OF_ETH_SRC is optional. */
1275 #define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
1276 #define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
1277 #define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
1279 /* Packet's Ethernet type.
1281 * For an Ethernet II packet this is taken from the Ethernet header. For an
1282 * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
1283 * A packet that has neither format has value 0x05ff
1284 * (OFP_DL_TYPE_NOT_ETH_TYPE).
1286 * For a packet with an 802.1Q header, this is the type of the encapsulated
1291 * Format: 16-bit integer in network byte order.
1293 * Masking: Not maskable. */
1294 #define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
1298 * For a packet with an 802.1Q header, this is the Tag Control Information
1299 * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
1300 * header, this has value 0.
1304 * Format: 16-bit integer in network byte order.
1306 * Masking: Arbitrary masks.
1308 * This field can be used in various ways:
1310 * - If it is not constrained at all, the nx_match matches packets without
1311 * an 802.1Q header or with an 802.1Q header that has any TCI value.
1313 * - Testing for an exact match with 0 matches only packets without an
1316 * - Testing for an exact match with a TCI value with CFI=1 matches packets
1317 * that have an 802.1Q header with a specified VID and PCP.
1319 * - Testing for an exact match with a nonzero TCI value with CFI=0 does
1320 * not make sense. The switch may reject this combination.
1322 * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
1323 * packets that have an 802.1Q header with that VID (and any PCP).
1325 * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
1326 * packets that have an 802.1Q header with that PCP (and any VID).
1328 * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
1329 * header or with an 802.1Q header with a VID of 0.
1331 * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
1332 * header or with an 802.1Q header with a PCP of 0.
1334 * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
1335 * header or with an 802.1Q header with both VID and PCP of 0.
1337 #define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
1338 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
1340 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
1342 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1344 * Format: 8-bit integer with 2 least-significant bits forced to 0.
1346 * Masking: Not maskable. */
1347 #define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
1349 /* The "protocol" byte in the IP header.
1351 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1353 * Format: 8-bit integer.
1355 * Masking: Not maskable. */
1356 #define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
1358 /* The source or destination address in the IP header.
1360 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
1362 * Format: 32-bit integer in network byte order.
1364 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1365 * high-order bits set to 1 and the other 32-N bits set to 0. */
1366 #define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
1367 #define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
1368 #define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
1369 #define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
1371 /* The source or destination port in the TCP header.
1374 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1375 * NXM_OF_IP_PROTO must match 6 exactly.
1377 * Format: 16-bit integer in network byte order.
1379 * Masking: Not maskable. */
1380 #define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
1381 #define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
1383 /* The source or destination port in the UDP header.
1386 * NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1387 * NXM_OF_IP_PROTO must match 17 exactly.
1389 * Format: 16-bit integer in network byte order.
1391 * Masking: Not maskable. */
1392 #define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
1393 #define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
1395 /* The type or code in the ICMP header.
1398 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
1399 * NXM_OF_IP_PROTO must match 1 exactly.
1401 * Format: 8-bit integer.
1403 * Masking: Not maskable. */
1404 #define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
1405 #define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
1409 * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
1410 * otherwise. Only ARP opcodes between 1 and 255 should be specified for
1413 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1415 * Format: 16-bit integer in network byte order.
1417 * Masking: Not maskable. */
1418 #define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
1420 /* For an Ethernet+IP ARP packet, the source or target protocol address
1421 * in the ARP header. Always 0 otherwise.
1423 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1425 * Format: 32-bit integer in network byte order.
1427 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1428 * high-order bits set to 1 and the other 32-N bits set to 0. */
1429 #define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
1430 #define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
1431 #define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
1432 #define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
1434 /* ## ------------------------ ## */
1435 /* ## Nicira match extensions. ## */
1436 /* ## ------------------------ ## */
1438 /* Metadata registers.
1440 * Registers initially have value 0. Actions allow register values to be
1445 * Format: Array of 32-bit integer registers. Space is reserved for up to
1446 * NXM_NX_MAX_REGS registers, but switches may implement fewer.
1448 * Masking: Arbitrary masks. */
1449 #define NXM_NX_MAX_REGS 16
1450 #define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
1451 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1452 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1453 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1454 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1455 #define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
1456 #define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
1457 #define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
1458 #define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
1459 #define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
1460 #define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
1461 #define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
1462 #define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
1463 #define NXM_NX_REG4 NXM_HEADER (0x0001, 4, 4)
1464 #define NXM_NX_REG4_W NXM_HEADER_W(0x0001, 4, 4)
1468 * For a packet received via GRE tunnel including a (32-bit) key, the key is
1469 * stored in the low 32-bits and the high bits are zeroed. For other packets,
1474 * Format: 64-bit integer in network byte order.
1476 * Masking: Arbitrary masks. */
1477 #define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
1478 #define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
1480 /* For an Ethernet+IP ARP packet, the source or target hardware address
1481 * in the ARP header. Always 0 otherwise.
1483 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1485 * Format: 48-bit Ethernet MAC address.
1487 * Masking: Not maskable. */
1488 #define NXM_NX_ARP_SHA NXM_HEADER (0x0001, 17, 6)
1489 #define NXM_NX_ARP_THA NXM_HEADER (0x0001, 18, 6)
1491 /* The source or destination address in the IPv6 header.
1493 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1495 * Format: 128-bit IPv6 address.
1497 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1498 * high-order bits set to 1 and the other 128-N bits set to 0. */
1499 #define NXM_NX_IPV6_SRC NXM_HEADER (0x0001, 19, 16)
1500 #define NXM_NX_IPV6_SRC_W NXM_HEADER_W(0x0001, 19, 16)
1501 #define NXM_NX_IPV6_DST NXM_HEADER (0x0001, 20, 16)
1502 #define NXM_NX_IPV6_DST_W NXM_HEADER_W(0x0001, 20, 16)
1504 /* The type or code in the ICMPv6 header.
1507 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1508 * NXM_OF_IP_PROTO must match 58 exactly.
1510 * Format: 8-bit integer.
1512 * Masking: Not maskable. */
1513 #define NXM_NX_ICMPV6_TYPE NXM_HEADER (0x0001, 21, 1)
1514 #define NXM_NX_ICMPV6_CODE NXM_HEADER (0x0001, 22, 1)
1516 /* The target address in an IPv6 Neighbor Discovery message.
1519 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1520 * NXM_OF_IP_PROTO must match 58 exactly.
1521 * NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1523 * Format: 128-bit IPv6 address.
1525 * Masking: Not maskable. */
1526 #define NXM_NX_ND_TARGET NXM_HEADER (0x0001, 23, 16)
1528 /* The source link-layer address option in an IPv6 Neighbor Discovery
1532 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1533 * NXM_OF_IP_PROTO must match 58 exactly.
1534 * NXM_OF_ICMPV6_TYPE must be exactly 135.
1536 * Format: 48-bit Ethernet MAC address.
1538 * Masking: Not maskable. */
1539 #define NXM_NX_ND_SLL NXM_HEADER (0x0001, 24, 6)
1541 /* The target link-layer address option in an IPv6 Neighbor Discovery
1545 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1546 * NXM_OF_IP_PROTO must match 58 exactly.
1547 * NXM_OF_ICMPV6_TYPE must be exactly 136.
1549 * Format: 48-bit Ethernet MAC address.
1551 * Masking: Not maskable. */
1552 #define NXM_NX_ND_TLL NXM_HEADER (0x0001, 25, 6)
1554 /* IP fragment information.
1557 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1559 * Format: 8-bit value with one of the values 0, 1, or 3, as described below.
1561 * Masking: Fully maskable.
1563 * This field has three possible values:
1565 * - A packet that is not an IP fragment has value 0.
1567 * - A packet that is an IP fragment with offset 0 (the first fragment) has
1568 * bit 0 set and thus value 1.
1570 * - A packet that is an IP fragment with nonzero offset has bits 0 and 1 set
1573 * NX_IP_FRAG_ANY and NX_IP_FRAG_LATER are declared to symbolically represent
1574 * the meanings of bits 0 and 1.
1576 * The switch may reject matches against values that can never appear.
1578 * It is important to understand how this field interacts with the OpenFlow IP
1579 * fragment handling mode:
1581 * - In OFPC_FRAG_DROP mode, the OpenFlow switch drops all IP fragments
1582 * before they reach the flow table, so every packet that is available for
1583 * matching will have value 0 in this field.
1585 * - Open vSwitch does not implement OFPC_FRAG_REASM mode, but if it did then
1586 * IP fragments would be reassembled before they reached the flow table and
1587 * again every packet available for matching would always have value 0.
1589 * - In OFPC_FRAG_NORMAL mode, all three values are possible, but OpenFlow
1590 * 1.0 says that fragments' transport ports are always 0, even for the
1591 * first fragment, so this does not provide much extra information.
1593 * - In OFPC_FRAG_NX_MATCH mode, all three values are possible. For
1594 * fragments with offset 0, Open vSwitch makes L4 header information
1597 #define NXM_NX_IP_FRAG NXM_HEADER (0x0001, 26, 1)
1598 #define NXM_NX_IP_FRAG_W NXM_HEADER_W(0x0001, 26, 1)
1600 /* Bits in the value of NXM_NX_IP_FRAG. */
1601 #define NX_IP_FRAG_ANY (1 << 0) /* Is this a fragment? */
1602 #define NX_IP_FRAG_LATER (1 << 1) /* Is this a fragment with nonzero offset? */
1604 /* ## --------------------- ## */
1605 /* ## Requests and replies. ## */
1606 /* ## --------------------- ## */
1608 enum nx_flow_format
{
1609 NXFF_OPENFLOW10
= 0, /* Standard OpenFlow 1.0 compatible. */
1610 NXFF_NXM
= 2 /* Nicira extended match. */
1613 /* NXT_SET_FLOW_FORMAT request. */
1614 struct nxt_set_flow_format
{
1615 struct ofp_header header
;
1616 ovs_be32 vendor
; /* NX_VENDOR_ID. */
1617 ovs_be32 subtype
; /* NXT_SET_FLOW_FORMAT. */
1618 ovs_be32 format
; /* One of NXFF_*. */
1620 OFP_ASSERT(sizeof(struct nxt_set_flow_format
) == 20);
1622 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */
1623 struct nx_flow_mod
{
1624 struct nicira_header nxh
;
1625 ovs_be64 cookie
; /* Opaque controller-issued identifier. */
1626 ovs_be16 command
; /* One of OFPFC_*. */
1627 ovs_be16 idle_timeout
; /* Idle time before discarding (seconds). */
1628 ovs_be16 hard_timeout
; /* Max time before discarding (seconds). */
1629 ovs_be16 priority
; /* Priority level of flow entry. */
1630 ovs_be32 buffer_id
; /* Buffered packet to apply to (or -1).
1631 Not meaningful for OFPFC_DELETE*. */
1632 ovs_be16 out_port
; /* For OFPFC_DELETE* commands, require
1633 matching entries to include this as an
1634 output port. A value of OFPP_NONE
1635 indicates no restriction. */
1636 ovs_be16 flags
; /* One of OFPFF_*. */
1637 ovs_be16 match_len
; /* Size of nx_match. */
1638 uint8_t pad
[6]; /* Align to 64-bits. */
1640 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1641 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1642 * all-zero bytes, then
1643 * - Actions to fill out the remainder of the message length (always a
1647 OFP_ASSERT(sizeof(struct nx_flow_mod
) == 48);
1649 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1650 struct nx_flow_removed
{
1651 struct nicira_header nxh
;
1652 ovs_be64 cookie
; /* Opaque controller-issued identifier. */
1653 ovs_be16 priority
; /* Priority level of flow entry. */
1654 uint8_t reason
; /* One of OFPRR_*. */
1655 uint8_t pad
[1]; /* Align to 32-bits. */
1656 ovs_be32 duration_sec
; /* Time flow was alive in seconds. */
1657 ovs_be32 duration_nsec
; /* Time flow was alive in nanoseconds beyond
1659 ovs_be16 idle_timeout
; /* Idle timeout from original flow mod. */
1660 ovs_be16 match_len
; /* Size of nx_match. */
1661 ovs_be64 packet_count
;
1662 ovs_be64 byte_count
;
1664 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1665 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1666 * all-zero bytes. */
1668 OFP_ASSERT(sizeof(struct nx_flow_removed
) == 56);
1670 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1672 struct nx_flow_stats_request
{
1673 struct nicira_stats_msg nsm
;
1674 ovs_be16 out_port
; /* Require matching entries to include this
1675 as an output port. A value of OFPP_NONE
1676 indicates no restriction. */
1677 ovs_be16 match_len
; /* Length of nx_match. */
1678 uint8_t table_id
; /* ID of table to read (from ofp_table_stats)
1679 or 0xff for all tables. */
1680 uint8_t pad
[3]; /* Align to 64 bits. */
1682 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1683 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1684 * all-zero bytes, which must also exactly fill out the length of the
1688 OFP_ASSERT(sizeof(struct nx_flow_stats_request
) == 32);
1690 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1691 * OFPST_FLOW reply). */
1692 struct nx_flow_stats
{
1693 ovs_be16 length
; /* Length of this entry. */
1694 uint8_t table_id
; /* ID of table flow came from. */
1696 ovs_be32 duration_sec
; /* Time flow has been alive in seconds. */
1697 ovs_be32 duration_nsec
; /* Time flow has been alive in nanoseconds
1698 beyond duration_sec. */
1699 ovs_be16 priority
; /* Priority of the entry. Only meaningful
1700 when this is not an exact-match entry. */
1701 ovs_be16 idle_timeout
; /* Number of seconds idle before expiration. */
1702 ovs_be16 hard_timeout
; /* Number of seconds before expiration. */
1703 ovs_be16 match_len
; /* Length of nx_match. */
1704 uint8_t pad2
[4]; /* Align to 64 bits. */
1705 ovs_be64 cookie
; /* Opaque controller-issued identifier. */
1706 ovs_be64 packet_count
; /* Number of packets, UINT64_MAX if unknown. */
1707 ovs_be64 byte_count
; /* Number of bytes, UINT64_MAX if unknown. */
1709 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1710 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1711 * all-zero bytes, then
1712 * - Actions to fill out the remainder 'length' bytes (always a multiple
1716 OFP_ASSERT(sizeof(struct nx_flow_stats
) == 48);
1718 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1719 * OFPST_AGGREGATE request). */
1720 struct nx_aggregate_stats_request
{
1721 struct nicira_stats_msg nsm
;
1722 ovs_be16 out_port
; /* Require matching entries to include this
1723 as an output port. A value of OFPP_NONE
1724 indicates no restriction. */
1725 ovs_be16 match_len
; /* Length of nx_match. */
1726 uint8_t table_id
; /* ID of table to read (from ofp_table_stats)
1727 or 0xff for all tables. */
1728 uint8_t pad
[3]; /* Align to 64 bits. */
1730 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1731 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1732 * all-zero bytes, which must also exactly fill out the length of the
1736 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request
) == 32);
1738 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1739 * OFPST_AGGREGATE reply). */
1740 struct nx_aggregate_stats_reply
{
1741 struct nicira_stats_msg nsm
;
1742 ovs_be64 packet_count
; /* Number of packets, UINT64_MAX if unknown. */
1743 ovs_be64 byte_count
; /* Number of bytes, UINT64_MAX if unknown. */
1744 ovs_be32 flow_count
; /* Number of flows. */
1745 uint8_t pad
[4]; /* Align to 64 bits. */
1747 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply
) == 48);
1749 #endif /* openflow/nicira-ext.h */