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,
106 /* A request specified a nonexistent table ID. (But NXFMFC_BAD_TABLE_ID is
107 * used instead, when it is appropriate, because that is such a special
109 NXBRC_BAD_TABLE_ID = 0x200,
111 /* NXT_ROLE_REQUEST specified an invalid role. */
112 NXBRC_BAD_ROLE = 0x201,
115 /* Additional "code" values for OFPET_FLOW_MOD_FAILED. */
116 enum nx_flow_mod_failed_code {
117 /* Generic hardware error. */
118 NXFMFC_HARDWARE = 0x100,
120 /* A nonexistent table ID was specified in the "command" field of struct
121 * ofp_flow_mod, when the nxt_flow_mod_table_id extension is enabled. */
122 NXFMFC_BAD_TABLE_ID = 0x101
125 /* Nicira vendor requests and replies. */
127 /* Header for Nicira vendor requests and replies. */
128 struct nicira_header {
129 struct ofp_header header;
130 ovs_be32 vendor; /* NX_VENDOR_ID. */
131 ovs_be32 subtype; /* One of NXT_* below. */
133 OFP_ASSERT(sizeof(struct nicira_header) == 16);
135 /* Values for the 'subtype' member of struct nicira_header. */
137 /* No longer used. */
138 NXT_STATUS_REQUEST__OBSOLETE = 0,
139 NXT_STATUS_REPLY__OBSOLETE = 1,
140 NXT_ACT_SET_CONFIG__OBSOLETE = 2,
141 NXT_ACT_GET_CONFIG__OBSOLETE = 3,
142 NXT_COMMAND_REQUEST__OBSOLETE = 4,
143 NXT_COMMAND_REPLY__OBSOLETE = 5,
144 NXT_FLOW_END_CONFIG__OBSOLETE = 6,
145 NXT_FLOW_END__OBSOLETE = 7,
146 NXT_MGMT__OBSOLETE = 8,
147 NXT_TUN_ID_FROM_COOKIE__OBSOLETE = 9,
149 /* Controller role support. The request body is struct nx_role_request.
150 * The reply echos the request. */
151 NXT_ROLE_REQUEST = 10,
154 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
155 NXT_SET_FLOW_FORMAT = 12, /* Set flow format. */
156 NXT_FLOW_MOD = 13, /* Analogous to OFPT_FLOW_MOD. */
157 NXT_FLOW_REMOVED = 14, /* Analogous to OFPT_FLOW_REMOVED. */
159 /* Use the upper 8 bits of the 'command' member in struct ofp_flow_mod to
160 * designate the table to which a flow is to be added? See the big comment
161 * on struct nxt_flow_mod_table_id for more information. */
162 NXT_FLOW_MOD_TABLE_ID = 15
165 /* Header for Nicira vendor stats request and reply messages. */
166 struct nicira_stats_msg {
167 struct ofp_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
168 ovs_be32 subtype; /* One of NXST_* below. */
169 uint8_t pad[4]; /* Align to 64-bits. */
171 OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
173 /* Values for the 'subtype' member of struct nicira_stats_msg. */
174 enum nicira_stats_type {
175 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
176 NXST_FLOW, /* Analogous to OFPST_FLOW. */
177 NXST_AGGREGATE /* Analogous to OFPST_AGGREGATE. */
180 /* Fields to use when hashing flows. */
181 enum nx_hash_fields {
182 /* Ethernet source address (NXM_OF_ETH_SRC) only. */
183 NX_HASH_FIELDS_ETH_SRC,
185 /* L2 through L4, symmetric across src/dst. Specifically, each of the
186 * following fields, if present, is hashed (slashes separate symmetric
189 * - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
191 * - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
193 * - NXM_OF_IP_SRC / NXM_OF_IP_DST
194 * - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
196 NX_HASH_FIELDS_SYMMETRIC_L4
199 /* This command enables or disables an Open vSwitch extension that allows a
200 * controller to specify the OpenFlow table to which a flow should be added,
201 * instead of having the switch decide which table is most appropriate as
202 * required by OpenFlow 1.0. By default, the extension is disabled.
204 * When this feature is enabled, Open vSwitch treats struct ofp_flow_mod's
205 * 16-bit 'command' member as two separate fields. The upper 8 bits are used
206 * as the table ID, the lower 8 bits specify the command as usual. A table ID
207 * of 0xff is treated like a wildcarded table ID.
209 * The specific treatment of the table ID depends on the type of flow mod:
211 * - OFPFC_ADD: Given a specific table ID, the flow is always placed in that
212 * table. If an identical flow already exists in that table only, then it
213 * is replaced. If the flow cannot be placed in the specified table,
214 * either because the table is full or because the table cannot support
215 * flows of the given type, the switch replies with an
216 * OFPFMFC_ALL_TABLES_FULL error. (A controller can distinguish these
217 * cases by comparing the current and maximum number of entries reported
218 * in ofp_table_stats.)
220 * If the table ID is wildcarded, the switch picks an appropriate table
221 * itself. If an identical flow already exist in the selected flow table,
222 * then it is replaced. The choice of table might depend on the flows
223 * that are already in the switch; for example, if one table fills up then
224 * the switch might fall back to another one.
226 * - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows
227 * within that table are matched and modified or deleted. If the table ID
228 * is wildcarded, flows within any table may be matched and modified or
231 * - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID,
232 * only a flow within that table may be matched and modified or deleted.
233 * If the table ID is wildcarded and exactly one flow within any table
234 * matches, then it is modified or deleted; if flows in more than one
235 * table match, then none is modified or deleted.
237 struct nxt_flow_mod_table_id {
238 struct ofp_header header;
239 uint32_t vendor; /* NX_VENDOR_ID. */
240 uint32_t subtype; /* NXT_FLOW_MOD_TABLE_ID. */
241 uint8_t set; /* Nonzero to enable, zero to disable. */
244 OFP_ASSERT(sizeof(struct nxt_flow_mod_table_id) == 24);
246 /* Configures the "role" of the sending controller. The default role is:
248 * - Other (NX_ROLE_OTHER), which allows the controller access to all
251 * The other possible roles are a related pair:
253 * - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
254 * be at most one Master controller at a time: when a controller
255 * configures itself as Master, any existing Master is demoted to the
258 * - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
259 * OpenFlow features. In particular attempts to modify the flow table
260 * will be rejected with an OFPBRC_EPERM error.
262 * Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
263 * messages, but they do receive OFPT_PORT_STATUS messages.
265 struct nx_role_request {
266 struct nicira_header nxh;
267 ovs_be32 role; /* One of NX_ROLE_*. */
271 NX_ROLE_OTHER, /* Default role, full access. */
272 NX_ROLE_MASTER, /* Full access, at most one. */
273 NX_ROLE_SLAVE /* Read-only access. */
276 /* Nicira vendor flow actions. */
278 enum nx_action_subtype {
279 NXAST_SNAT__OBSOLETE, /* No longer used. */
280 NXAST_RESUBMIT, /* struct nx_action_resubmit */
281 NXAST_SET_TUNNEL, /* struct nx_action_set_tunnel */
282 NXAST_DROP_SPOOFED_ARP__OBSOLETE,
283 NXAST_SET_QUEUE, /* struct nx_action_set_queue */
284 NXAST_POP_QUEUE, /* struct nx_action_pop_queue */
285 NXAST_REG_MOVE, /* struct nx_action_reg_move */
286 NXAST_REG_LOAD, /* struct nx_action_reg_load */
287 NXAST_NOTE, /* struct nx_action_note */
288 NXAST_SET_TUNNEL64, /* struct nx_action_set_tunnel64 */
289 NXAST_MULTIPATH, /* struct nx_action_multipath */
290 NXAST_AUTOPATH, /* struct nx_action_autopath */
291 NXAST_BUNDLE, /* struct nx_action_bundle */
292 NXAST_BUNDLE_LOAD, /* struct nx_action_bundle */
293 NXAST_RESUBMIT_TABLE, /* struct nx_action_resubmit */
294 NXAST_OUTPUT_REG, /* struct nx_action_output_reg */
295 NXAST_LEARN, /* struct nx_action_learn */
296 NXAST_EXIT /* struct nx_action_header */
299 /* Header for Nicira-defined actions. */
300 struct nx_action_header {
301 ovs_be16 type; /* OFPAT_VENDOR. */
302 ovs_be16 len; /* Length is 16. */
303 ovs_be32 vendor; /* NX_VENDOR_ID. */
304 ovs_be16 subtype; /* NXAST_*. */
307 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
309 /* Action structures for NXAST_RESUBMIT and NXAST_RESUBMIT_TABLE.
311 * These actions search one of the switch's flow tables:
313 * - For NXAST_RESUBMIT_TABLE only, if the 'table' member is not 255, then
314 * it specifies the table to search.
316 * - Otherwise (for NXAST_RESUBMIT_TABLE with a 'table' of 255, or for
317 * NXAST_RESUBMIT regardless of 'table'), it searches the current flow
318 * table, that is, the OpenFlow flow table that contains the flow from
319 * which this action was obtained. If this action did not come from a
320 * flow table (e.g. it came from an OFPT_PACKET_OUT message), then table 0
321 * is the current table.
323 * The flow table lookup uses a flow that may be slightly modified from the
326 * - For NXAST_RESUBMIT, the 'in_port' member of struct nx_action_resubmit
327 * is used as the flow's in_port.
329 * - For NXAST_RESUBMIT_TABLE, if the 'in_port' member is not OFPP_IN_PORT,
330 * then its value is used as the flow's in_port. Otherwise, the original
333 * - If actions that modify the flow (e.g. OFPAT_SET_VLAN_VID) precede the
334 * resubmit action, then the flow is updated with the new values.
336 * Following the lookup, the original in_port is restored.
338 * If the modified flow matched in the flow table, then the corresponding
339 * actions are executed. Afterward, actions following the resubmit in the
340 * original set of actions, if any, are executed; any changes made to the
341 * packet (e.g. changes to VLAN) by secondary actions persist when those
342 * actions are executed, although the original in_port is restored.
344 * Resubmit actions may be used any number of times within a set of actions.
346 * Resubmit actions may nest to an implementation-defined depth. Beyond this
347 * implementation-defined depth, further resubmit actions are simply ignored.
349 * NXAST_RESUBMIT ignores 'table' and 'pad'. NXAST_RESUBMIT_TABLE requires
350 * 'pad' to be all-bits-zero.
352 * Open vSwitch 1.0.1 and earlier did not support recursion. Open vSwitch
353 * before 1.2.90 did not support NXAST_RESUBMIT_TABLE.
355 struct nx_action_resubmit {
356 ovs_be16 type; /* OFPAT_VENDOR. */
357 ovs_be16 len; /* Length is 16. */
358 ovs_be32 vendor; /* NX_VENDOR_ID. */
359 ovs_be16 subtype; /* NXAST_RESUBMIT. */
360 ovs_be16 in_port; /* New in_port for checking flow table. */
361 uint8_t table; /* NXAST_RESUBMIT_TABLE: table to use. */
364 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
366 /* Action structure for NXAST_SET_TUNNEL.
368 * Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32
369 * bits of the tunnel ID are set to 0. */
370 struct nx_action_set_tunnel {
371 ovs_be16 type; /* OFPAT_VENDOR. */
372 ovs_be16 len; /* Length is 16. */
373 ovs_be32 vendor; /* NX_VENDOR_ID. */
374 ovs_be16 subtype; /* NXAST_SET_TUNNEL. */
376 ovs_be32 tun_id; /* Tunnel ID. */
378 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
380 /* Action structure for NXAST_SET_TUNNEL64.
382 * Sets the encapsulating tunnel ID to a 64-bit value. */
383 struct nx_action_set_tunnel64 {
384 ovs_be16 type; /* OFPAT_VENDOR. */
385 ovs_be16 len; /* Length is 16. */
386 ovs_be32 vendor; /* NX_VENDOR_ID. */
387 ovs_be16 subtype; /* NXAST_SET_TUNNEL64. */
389 ovs_be64 tun_id; /* Tunnel ID. */
391 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
393 /* Action structure for NXAST_SET_QUEUE.
395 * Set the queue that should be used when packets are output. This is similar
396 * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
397 * an argument. This allows the queue to be defined before the port is
399 struct nx_action_set_queue {
400 ovs_be16 type; /* OFPAT_VENDOR. */
401 ovs_be16 len; /* Length is 16. */
402 ovs_be32 vendor; /* NX_VENDOR_ID. */
403 ovs_be16 subtype; /* NXAST_SET_QUEUE. */
405 ovs_be32 queue_id; /* Where to enqueue packets. */
407 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
409 /* Action structure for NXAST_POP_QUEUE.
411 * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
412 * were used. Only the original queue can be restored this way; no stack is
414 struct nx_action_pop_queue {
415 ovs_be16 type; /* OFPAT_VENDOR. */
416 ovs_be16 len; /* Length is 16. */
417 ovs_be32 vendor; /* NX_VENDOR_ID. */
418 ovs_be16 subtype; /* NXAST_POP_QUEUE. */
421 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
423 /* Action structure for NXAST_REG_MOVE.
425 * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
426 * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
427 * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
428 * the next most significant bit, and so on.
430 * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
431 * sense to use nxm_hasmask=1 because the action does not do any kind of
432 * matching; it uses the actual value of a field.)
434 * The following nxm_header values are potentially acceptable as 'src':
457 * - NXM_NX_ICMPV6_TYPE
458 * - NXM_NX_ICMPV6_CODE
461 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
463 * The following nxm_header values are potentially acceptable as 'dst':
474 * Modifying any of the above fields changes the corresponding packet
477 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
479 * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
480 * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
481 * header (if any), ignoring the other bits. Setting a value with CFI=1
482 * adds or modifies the 802.1Q header appropriately, setting the TCI field
483 * to the field's new value (with the CFI bit masked out).
485 * - NXM_NX_TUN_ID. Modifying this value modifies the tunnel ID used for the
486 * packet's next tunnel encapsulation.
488 * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
489 * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
490 * used only if the flow's nx_match includes an nxm_entry that specifies
491 * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
493 * The switch will reject actions for which src_ofs+n_bits is greater than the
494 * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
495 * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
497 struct nx_action_reg_move {
498 ovs_be16 type; /* OFPAT_VENDOR. */
499 ovs_be16 len; /* Length is 16. */
500 ovs_be32 vendor; /* NX_VENDOR_ID. */
501 ovs_be16 subtype; /* NXAST_REG_MOVE. */
502 ovs_be16 n_bits; /* Number of bits. */
503 ovs_be16 src_ofs; /* Starting bit offset in source. */
504 ovs_be16 dst_ofs; /* Starting bit offset in destination. */
505 ovs_be32 src; /* Source register. */
506 ovs_be32 dst; /* Destination register. */
508 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
510 /* Action structure for NXAST_REG_LOAD.
512 * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
513 * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
514 * starts at 0 for the least-significant bit, 1 for the next most significant
517 * 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for
518 * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
521 * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
522 * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
523 * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
524 * also stored as one less than its true value:
527 * +------------------------------+------------------+
528 * | ofs | n_bits - 1 |
529 * +------------------------------+------------------+
531 * The switch will reject actions for which ofs+n_bits is greater than the
532 * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
533 * greater are set to 1, with error type OFPET_BAD_ACTION, code
534 * OFPBAC_BAD_ARGUMENT.
536 struct nx_action_reg_load {
537 ovs_be16 type; /* OFPAT_VENDOR. */
538 ovs_be16 len; /* Length is 16. */
539 ovs_be32 vendor; /* NX_VENDOR_ID. */
540 ovs_be16 subtype; /* NXAST_REG_LOAD. */
541 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
542 ovs_be32 dst; /* Destination register. */
543 ovs_be64 value; /* Immediate value. */
545 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
547 /* Action structure for NXAST_NOTE.
549 * This action has no effect. It is variable length. The switch does not
550 * attempt to interpret the user-defined 'note' data in any way. A controller
551 * can use this action to attach arbitrary metadata to a flow.
553 * This action might go away in the future.
555 struct nx_action_note {
556 ovs_be16 type; /* OFPAT_VENDOR. */
557 ovs_be16 len; /* A multiple of 8, but at least 16. */
558 ovs_be32 vendor; /* NX_VENDOR_ID. */
559 ovs_be16 subtype; /* NXAST_NOTE. */
560 uint8_t note[6]; /* Start of user-defined data. */
561 /* Possibly followed by additional user-defined data. */
563 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
565 /* Action structure for NXAST_MULTIPATH.
567 * This action performs the following steps in sequence:
569 * 1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
570 * Refer to the definition of "enum nx_mp_fields" for details.
572 * The 'basis' value is used as a universal hash parameter, that is,
573 * different values of 'basis' yield different hash functions. The
574 * particular universal hash function used is implementation-defined.
576 * The hashed fields' values are drawn from the current state of the
577 * flow, including all modifications that have been made by actions up to
580 * 2. Applies the multipath link choice algorithm specified by 'algorithm',
581 * one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm"
584 * The output of the algorithm is 'link', an unsigned integer less than
585 * or equal to 'max_link'.
587 * Some algorithms use 'arg' as an additional argument.
589 * 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of
590 * 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
593 * The switch will reject actions that have an unknown 'fields', or an unknown
594 * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
595 * in which 'max_link' is greater than or equal to 2**n_bits, with error type
596 * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
598 struct nx_action_multipath {
599 ovs_be16 type; /* OFPAT_VENDOR. */
600 ovs_be16 len; /* Length is 32. */
601 ovs_be32 vendor; /* NX_VENDOR_ID. */
602 ovs_be16 subtype; /* NXAST_MULTIPATH. */
604 /* What fields to hash and how. */
605 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
606 ovs_be16 basis; /* Universal hash parameter. */
609 /* Multipath link choice algorithm to apply to hash value. */
610 ovs_be16 algorithm; /* One of NX_MP_ALG_*. */
611 ovs_be16 max_link; /* Number of output links, minus 1. */
612 ovs_be32 arg; /* Algorithm-specific argument. */
615 /* Where to store the result. */
616 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
617 ovs_be32 dst; /* Destination. */
619 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
621 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
623 * In the descriptions below, 'n_links' is max_link + 1. */
624 enum nx_mp_algorithm {
625 /* link = hash(flow) % n_links.
627 * Redistributes all traffic when n_links changes. O(1) performance. See
630 * Use UINT16_MAX for max_link to get a raw hash value. */
633 /* link = hash(flow) / (MAX_HASH / n_links).
635 * Redistributes between one-quarter and one-half of traffic when n_links
636 * changes. O(1) performance. See RFC 2992.
638 NX_MP_ALG_HASH_THRESHOLD,
640 /* for i in [0,n_links):
641 * weights[i] = hash(flow, i)
642 * link = { i such that weights[i] >= weights[j] for all j != i }
644 * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
645 * performance. If n_links is greater than a threshold (currently 64, but
646 * subject to change), Open vSwitch will substitute another algorithm
647 * automatically. See RFC 2992. */
648 NX_MP_ALG_HRW, /* Highest Random Weight. */
653 * link = hash(flow, i) % arg
654 * while link > max_link
656 * Redistributes 1/n_links of traffic when n_links changes. O(1)
657 * performance when arg/max_link is bounded by a constant.
659 * Redistributes all traffic when arg changes.
661 * arg must be greater than max_link and for best performance should be no
662 * more than approximately max_link * 2. If arg is outside the acceptable
663 * range, Open vSwitch will automatically substitute the least power of 2
664 * greater than max_link.
666 * This algorithm is specific to Open vSwitch.
668 NX_MP_ALG_ITER_HASH /* Iterative Hash. */
671 /* Action structure for NXAST_LEARN.
673 * This action adds or modifies a flow in an OpenFlow table, similar to
674 * OFPT_FLOW_MOD with OFPFC_MODIFY_STRICT as 'command'. The new flow has the
675 * specified idle timeout, hard timeout, priority, cookie, and flags. The new
676 * flow's match criteria and actions are built by applying each of the series
677 * of flow_mod_spec elements included as part of the action.
679 * A flow_mod_spec starts with a 16-bit header. A header that is all-bits-0 is
680 * a no-op used for padding the action as a whole to a multiple of 8 bytes in
681 * length. Otherwise, the flow_mod_spec can be thought of as copying 'n_bits'
682 * bits from a source to a destination. In this case, the header contains
685 * 15 14 13 12 11 10 0
686 * +------+---+------+---------------------------------+
687 * | 0 |src| dst | n_bits |
688 * +------+---+------+---------------------------------+
690 * The meaning and format of a flow_mod_spec depends on 'src' and 'dst'. The
691 * following table summarizes the meaning of each possible combination.
692 * Details follow the table:
695 * --- --- ----------------------------------------------------------
696 * 0 0 Add match criteria based on value in a field.
697 * 1 0 Add match criteria based on an immediate value.
698 * 0 1 Add NXAST_REG_LOAD action to copy field into a different field.
699 * 1 1 Add NXAST_REG_LOAD action to load immediate value into a field.
700 * 0 2 Add OFPAT_OUTPUT action to output to port from specified field.
701 * All other combinations are undefined and not allowed.
703 * The flow_mod_spec header is followed by a source specification and a
704 * destination specification. The format and meaning of the source
705 * specification depends on 'src':
707 * - If 'src' is 0, the source bits are taken from a field in the flow to
708 * which this action is attached. (This should be a wildcarded field. If
709 * its value is fully specified then the source bits being copied have
712 * The source specification is an ovs_be32 'field' and an ovs_be16 'ofs'.
713 * 'field' is an nxm_header with nxm_hasmask=0, and 'ofs' the starting bit
714 * offset within that field. The source bits are field[ofs:ofs+n_bits-1].
715 * 'field' and 'ofs' are subject to the same restrictions as the source
716 * field in NXAST_REG_MOVE.
718 * - If 'src' is 1, the source bits are a constant value. The source
719 * specification is (n_bits+15)/16*2 bytes long. Taking those bytes as a
720 * number in network order, the source bits are the 'n_bits'
721 * least-significant bits. The switch will report an error if other bits
722 * in the constant are nonzero.
724 * The flow_mod_spec destination specification, for 'dst' of 0 or 1, is an
725 * ovs_be32 'field' and an ovs_be16 'ofs'. 'field' is an nxm_header with
726 * nxm_hasmask=0 and 'ofs' is a starting bit offset within that field. The
727 * meaning of the flow_mod_spec depends on 'dst':
729 * - If 'dst' is 0, the flow_mod_spec specifies match criteria for the new
730 * flow. The new flow matches only if bits field[ofs:ofs+n_bits-1] in a
731 * packet equal the source bits. 'field' may be any nxm_header with
732 * nxm_hasmask=0 that is allowed in NXT_FLOW_MOD.
734 * Order is significant. Earlier flow_mod_specs must satisfy any
735 * prerequisites for matching fields specified later, by copying constant
736 * values into prerequisite fields.
738 * The switch will reject flow_mod_specs that do not satisfy NXM masking
741 * - If 'dst' is 1, the flow_mod_spec specifies an NXAST_REG_LOAD action for
742 * the new flow. The new flow copies the source bits into
743 * field[ofs:ofs+n_bits-1]. Actions are executed in the same order as the
746 * The flow_mod_spec destination spec for 'dst' of 2 (when 'src' is 0) is
747 * empty. It has the following meaning:
749 * - The flow_mod_spec specifies an OFPAT_OUTPUT action for the new flow.
750 * The new flow outputs to the OpenFlow port specified by the source field.
751 * Of the special output ports with value OFPP_MAX or larger, OFPP_IN_PORT,
752 * OFPP_FLOOD, OFPP_LOCAL, and OFPP_ALL are supported. Other special ports
755 * Resource Management
756 * -------------------
758 * A switch has a finite amount of flow table space available for learning.
759 * When this space is exhausted, no new learning table entries will be learned
760 * until some existing flow table entries expire. The controller should be
761 * prepared to handle this by flooding (which can be implemented as a
762 * low-priority flow).
767 * The following examples give a prose description of the flow_mod_specs along
768 * with informal notation for how those would be represented and a hex dump of
769 * the bytes that would be required.
771 * These examples could work with various nx_action_learn parameters. Typical
772 * values would be idle_timeout=OFP_FLOW_PERMANENT, hard_timeout=60,
773 * priority=OFP_DEFAULT_PRIORITY, flags=0, table_id=10.
775 * 1. Learn input port based on the source MAC, with lookup into
776 * NXM_NX_REG1[16:31] by resubmit to in_port=99:
778 * Match on in_port=99:
779 * ovs_be16(src=1, dst=0, n_bits=16), 20 10
780 * ovs_be16(99), 00 63
781 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
783 * Match Ethernet destination on Ethernet source from packet:
784 * ovs_be16(src=0, dst=0, n_bits=48), 00 30
785 * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
786 * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
788 * Set NXM_NX_REG1[16:31] to the packet's input port:
789 * ovs_be16(src=0, dst=1, n_bits=16), 08 10
790 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
791 * ovs_be32(NXM_NX_REG1), ovs_be16(16) 00 01 02 04 00 10
793 * Given a packet that arrived on port A with Ethernet source address B,
794 * this would set up the flow "in_port=99, dl_dst=B,
795 * actions=load:A->NXM_NX_REG1[16..31]".
797 * In syntax accepted by ovs-ofctl, this action is: learn(in_port=99,
798 * NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
799 * load:NXM_OF_IN_PORT[]->NXM_NX_REG1[16..31])
801 * 2. Output to input port based on the source MAC and VLAN VID, with lookup
802 * into NXM_NX_REG1[16:31]:
804 * Match on same VLAN ID as packet:
805 * ovs_be16(src=0, dst=0, n_bits=12), 00 0c
806 * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
807 * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
809 * Match Ethernet destination on Ethernet source from packet:
810 * ovs_be16(src=0, dst=0, n_bits=48), 00 30
811 * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
812 * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
814 * Output to the packet's input port:
815 * ovs_be16(src=0, dst=2, n_bits=16), 10 10
816 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
818 * Given a packet that arrived on port A with Ethernet source address B in
819 * VLAN C, this would set up the flow "dl_dst=B, vlan_vid=C,
822 * In syntax accepted by ovs-ofctl, this action is:
823 * learn(NXM_OF_VLAN_TCI[0..11], NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
824 * output:NXM_OF_IN_PORT[])
826 * 3. Here's a recipe for a very simple-minded MAC learning switch. It uses a
827 * 10-second MAC expiration time to make it easier to see what's going on
829 * ovs-vsctl del-controller br0
830 * ovs-ofctl del-flows br0
831 * ovs-ofctl add-flow br0 "table=0 actions=learn(table=1, \
832 hard_timeout=10, NXM_OF_VLAN_TCI[0..11], \
833 NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[], \
834 output:NXM_OF_IN_PORT[]), resubmit(,1)"
835 * ovs-ofctl add-flow br0 "table=1 priority=0 actions=flood"
837 * You can then dump the MAC learning table with:
839 * ovs-ofctl dump-flows br0 table=1
844 * For best performance, segregate learned flows into a table that is not used
845 * for any other flows except possibly for a lowest-priority "catch-all" flow
846 * (a flow with no match criteria). If different learning actions specify
847 * different match criteria, use different tables for the learned flows.
849 * The meaning of 'hard_timeout' and 'idle_timeout' can be counterintuitive.
850 * These timeouts apply to the flow that is added, which means that a flow with
851 * an idle timeout will expire when no traffic has been sent *to* the learned
852 * address. This is not usually the intent in MAC learning; instead, we want
853 * the MAC learn entry to expire when no traffic has been sent *from* the
854 * learned address. Use a hard timeout for that.
856 struct nx_action_learn {
857 ovs_be16 type; /* OFPAT_VENDOR. */
858 ovs_be16 len; /* At least 24. */
859 ovs_be32 vendor; /* NX_VENDOR_ID. */
860 ovs_be16 subtype; /* NXAST_LEARN. */
861 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
862 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
863 ovs_be16 priority; /* Priority level of flow entry. */
864 ovs_be64 cookie; /* Cookie for new flow. */
865 ovs_be16 flags; /* Either 0 or OFPFF_SEND_FLOW_REM. */
866 uint8_t table_id; /* Table to insert flow entry. */
867 uint8_t pad[5]; /* Must be zero. */
868 /* Followed by a sequence of flow_mod_spec elements, as described above,
869 * until the end of the action is reached. */
871 OFP_ASSERT(sizeof(struct nx_action_learn) == 32);
873 #define NX_LEARN_N_BITS_MASK 0x3ff
875 #define NX_LEARN_SRC_FIELD (0 << 13) /* Copy from field. */
876 #define NX_LEARN_SRC_IMMEDIATE (1 << 13) /* Copy from immediate value. */
877 #define NX_LEARN_SRC_MASK (1 << 13)
879 #define NX_LEARN_DST_MATCH (0 << 11) /* Add match criterion. */
880 #define NX_LEARN_DST_LOAD (1 << 11) /* Add NXAST_REG_LOAD action. */
881 #define NX_LEARN_DST_OUTPUT (2 << 11) /* Add OFPAT_OUTPUT action. */
882 #define NX_LEARN_DST_RESERVED (3 << 11) /* Not yet defined. */
883 #define NX_LEARN_DST_MASK (3 << 11)
885 /* Action structure for NXAST_AUTOPATH.
887 * This action performs the following steps in sequence:
889 * 1. Hashes the flow using an implementation-defined hash function.
891 * The hashed fields' values are drawn from the current state of the
892 * flow, including all modifications that have been made by actions up to
895 * 2. Selects an OpenFlow 'port'.
897 * 'port' is selected in an implementation-defined manner, taking into
898 * account 'id' and the hash value calculated in step 1.
900 * Generally a switch will have been configured with a set of ports that
901 * may be chosen given 'id'. The switch may take into account any number
902 * of factors when choosing 'port' from its configured set. Factors may
903 * include carrier, load, and the results of configuration protocols such
906 * 3. Stores 'port' in dst[ofs:ofs+n_bits].
908 * The format and semantics of 'dst' and 'ofs_nbits' are similar to those
909 * for the NXAST_REG_LOAD action.
911 * The switch will reject actions in which ofs+n_bits is greater than the width
912 * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
914 struct nx_action_autopath {
915 ovs_be16 type; /* OFPAT_VENDOR. */
916 ovs_be16 len; /* Length is 20. */
917 ovs_be32 vendor; /* NX_VENDOR_ID. */
918 ovs_be16 subtype; /* NXAST_AUTOPATH. */
920 /* Where to store the result. */
921 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
922 ovs_be32 dst; /* Destination. */
924 ovs_be32 id; /* Autopath ID. */
927 OFP_ASSERT(sizeof(struct nx_action_autopath) == 24);
929 /* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD.
931 * The bundle actions choose a slave from a supplied list of options.
932 * NXAST_BUNDLE outputs to its selection. NXAST_BUNDLE_LOAD writes its
933 * selection to a register.
935 * The list of possible slaves follows the nx_action_bundle structure. The size
936 * of each slave is governed by its type as indicated by the 'slave_type'
937 * parameter. The list of slaves should be padded at its end with zeros to make
938 * the total length of the action a multiple of 8.
940 * Switches infer from the 'slave_type' parameter the size of each slave. All
941 * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
942 * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
943 * 2 byte width. Switches should reject actions which indicate unknown or
944 * unsupported slave types.
946 * Switches use a strategy dictated by the 'algorithm' parameter to choose a
947 * slave. If the switch does not support the specified 'algorithm' parameter,
948 * it should reject the action.
950 * Several algorithms take into account liveness when selecting slaves. The
951 * liveness of a slave is implementation defined (with one exception), but will
952 * generally take into account things like its carrier status and the results
953 * of any link monitoring protocols which happen to be running on it. In order
954 * to give controllers a place-holder value, the OFPP_NONE port is always
957 * Some slave selection strategies require the use of a hash function, in which
958 * case the 'fields' and 'basis' parameters should be populated. The 'fields'
959 * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
960 * hash. Refer to the definition of "enum nx_hash_fields" for details. The
961 * 'basis' parameter is used as a universal hash parameter. Different values
962 * of 'basis' yield different hash results.
964 * The 'zero' parameter at the end of the action structure is reserved for
965 * future use. Switches are required to reject actions which have nonzero
966 * bytes in the 'zero' field.
968 * NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed. Switches
969 * should reject actions which have nonzero bytes in either of these fields.
971 * NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in
972 * dst[ofs:ofs+n_bits]. The format and semantics of 'dst' and 'ofs_nbits' are
973 * similar to those for the NXAST_REG_LOAD action. */
974 struct nx_action_bundle {
975 ovs_be16 type; /* OFPAT_VENDOR. */
976 ovs_be16 len; /* Length including slaves. */
977 ovs_be32 vendor; /* NX_VENDOR_ID. */
978 ovs_be16 subtype; /* NXAST_BUNDLE. */
980 /* Slave choice algorithm to apply to hash value. */
981 ovs_be16 algorithm; /* One of NX_BD_ALG_*. */
983 /* What fields to hash and how. */
984 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
985 ovs_be16 basis; /* Universal hash parameter. */
987 ovs_be32 slave_type; /* NXM_OF_IN_PORT. */
988 ovs_be16 n_slaves; /* Number of slaves. */
990 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
991 ovs_be32 dst; /* Destination. */
993 uint8_t zero[4]; /* Reserved. Must be zero. */
995 OFP_ASSERT(sizeof(struct nx_action_bundle) == 32);
997 /* NXAST_BUNDLE: Bundle slave choice algorithm to apply.
999 * In the descriptions below, 'slaves' is the list of possible slaves in the
1000 * order they appear in the OpenFlow action. */
1001 enum nx_bd_algorithm {
1002 /* Chooses the first live slave listed in the bundle.
1004 * O(n_slaves) performance. */
1005 NX_BD_ALG_ACTIVE_BACKUP,
1007 /* for i in [0,n_slaves):
1008 * weights[i] = hash(flow, i)
1009 * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
1011 * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
1012 * O(n_slaves) performance.
1014 * Uses the 'fields' and 'basis' parameters. */
1015 NX_BD_ALG_HRW /* Highest Random Weight. */
1018 /* Action structure for NXAST_OUTPUT_REG.
1020 * Outputs to the OpenFlow port number written to src[ofs:ofs+nbits].
1022 * The format and semantics of 'src' and 'ofs_nbits' are similar to those for
1023 * the NXAST_REG_LOAD action.
1025 * The acceptable nxm_header values for 'src' are the same as the acceptable
1026 * nxm_header values for the 'src' field of NXAST_REG_MOVE.
1028 * The 'max_len' field indicates the number of bytes to send when the chosen
1029 * port is OFPP_CONTROLLER. Its semantics are equivalent to the 'max_len'
1030 * field of OFPAT_OUTPUT.
1032 * The 'zero' field is required to be zeroed for forward compatibility. */
1033 struct nx_action_output_reg {
1034 ovs_be16 type; /* OFPAT_VENDOR. */
1035 ovs_be16 len; /* 24. */
1036 ovs_be32 vendor; /* NX_VENDOR_ID. */
1037 ovs_be16 subtype; /* NXAST_OUTPUT_REG. */
1039 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
1040 ovs_be32 src; /* Source. */
1042 ovs_be16 max_len; /* Max length to send to controller. */
1044 uint8_t zero[6]; /* Reserved, must be zero. */
1046 OFP_ASSERT(sizeof(struct nx_action_output_reg) == 24);
1050 * Discontinues action processing.
1052 * The NXAST_EXIT action causes the switch to immediately halt processing
1053 * actions for the flow. Any actions which have already been processed are
1054 * executed by the switch. However, any further actions, including those which
1055 * may be in different tables, or different levels of the NXAST_RESUBMIT
1056 * hierarchy, will be ignored.
1058 * Uses the nx_action_header structure. */
1060 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
1062 * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches. This
1063 * structure is fixed-length and hence difficult to extend. This section
1064 * describes a more flexible, variable-length flow match, called "nx_match" for
1065 * short, that is also supported by Open vSwitch. This section also defines a
1066 * replacement for each OpenFlow message that includes struct ofp_match.
1072 * An nx_match is a sequence of zero or more "nxm_entry"s, which are
1073 * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
1074 * "nxm_entry"s are not aligned on or padded to any multibyte boundary. The
1075 * first 4 bytes of an nxm_entry are its "header", followed by the entry's
1078 * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
1080 * |<-------------------- nxm_type ------------------>|
1082 * |31 16 15 9| 8 7 0
1083 * +----------------------------------+---------------+--+------------------+
1084 * | nxm_vendor | nxm_field |hm| nxm_length |
1085 * +----------------------------------+---------------+--+------------------+
1087 * The most-significant 23 bits of the header are collectively "nxm_type".
1088 * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
1089 * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
1090 * designates a protocol header, such as the Ethernet type, but it can also
1091 * refer to packet metadata, such as the switch port on which a packet arrived.
1093 * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
1094 * of this bit is explained later.
1096 * The least-significant 8 bits are "nxm_length", a positive integer. The
1097 * length of the nxm_entry, including the header, is exactly 4 + nxm_length
1100 * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
1101 * constant. It is included only to allow software to minimally parse
1102 * "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor,
1103 * nxm_field, and nxm_length, nxm_hasmask is a constant.)
1109 * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
1111 * An nxm_entry places a constraint on the packets matched by the nx_match:
1113 * - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
1114 * field, called "nxm_value". The nx_match matches only packets in which
1115 * the field equals nxm_value.
1117 * - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
1118 * field (nxm_value), followed by a bitmask of the same length as the
1119 * value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
1120 * nx_match matches only packets for which bit J in the given field's value
1121 * matches bit J in nxm_value. A 0-bit in nxm_mask causes the
1122 * corresponding bits in nxm_value and the field's value to be ignored.
1123 * (The sense of the nxm_mask bits is the opposite of that used by the
1124 * "wildcards" member of struct ofp_match.)
1126 * When nxm_hasmask is 1, nxm_length is always even.
1128 * An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
1129 * entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for
1132 * When there are multiple "nxm_entry"s, all of the constraints must be met.
1138 * Masks may be restricted:
1140 * - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
1141 * must always be 0 when these fields are specified. For example, the
1142 * field that identifies the port on which a packet was received may not be
1145 * - Some nxm_types that do support masked wildcards may only support certain
1146 * nxm_mask patterns. For example, fields that have IPv4 address values
1147 * may be restricted to CIDR masks.
1149 * These restrictions should be noted in specifications for individual fields.
1150 * A switch may accept an nxm_hasmask or nxm_mask value that the specification
1151 * disallows, if the switch correctly implements support for that nxm_hasmask
1152 * or nxm_mask value. A switch must reject an attempt to set up a flow that
1153 * contains a nxm_hasmask or nxm_mask value that it does not support.
1156 * Prerequisite Restrictions
1157 * =========================
1159 * The presence of an nxm_entry with a given nxm_type may be restricted based
1160 * on the presence of or values of other "nxm_entry"s. For example:
1162 * - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
1163 * preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
1164 * and nxm_value=0x0800. That is, matching on the IP source address is
1165 * allowed only if the Ethernet type is explicitly set to IP.
1167 * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is
1168 * preceded by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and
1169 * nxm_value either 0x0800 or 0x86dd, and another with
1170 * nxm_type=NXM_OF_IP_PROTO, nxm_hasmask=0, nxm_value=6, in that order.
1171 * That is, matching on the TCP source port is allowed only if the Ethernet
1172 * type is IP or IPv6 and the IP protocol is TCP.
1174 * These restrictions should be noted in specifications for individual fields.
1175 * A switch may implement relaxed versions of these restrictions. A switch
1176 * must reject an attempt to set up a flow that violates its restrictions.
1179 * Ordering Restrictions
1180 * =====================
1182 * An nxm_entry that has prerequisite restrictions must appear after the
1183 * "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an
1184 * nx_match is not otherwise constrained.
1186 * Any given nxm_type may appear in an nx_match at most once.
1189 * nxm_entry Examples
1190 * ==================
1192 * These examples show the format of a single nxm_entry with particular
1193 * nxm_hasmask and nxm_length values. The diagrams are labeled with field
1194 * numbers and byte indexes.
1197 * 8-bit nxm_value, nxm_hasmask=1, nxm_length=2:
1200 * +------------+---+---+
1201 * | header | v | m |
1202 * +------------+---+---+
1205 * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
1208 * +------------+------+
1210 * +------------+------+
1213 * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
1216 * +------------+-------------+
1217 * | header | nxm_value |
1218 * +------------+-------------+
1221 * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
1224 * +------------+------------------+
1225 * | header | nxm_value |
1226 * +------------+------------------+
1229 * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
1232 * +------------+------------------+------------------+
1233 * | header | nxm_value | nxm_mask |
1234 * +------------+------------------+------------------+
1240 * A switch should report an error in an nx_match using error type
1241 * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch
1242 * should report a specific error code, if one is assigned for the particular
1243 * problem, but NXBRC_NXM_INVALID is also available to report a generic
1247 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
1248 (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
1249 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
1250 NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
1251 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
1252 NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
1253 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
1254 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
1255 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
1256 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
1257 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
1259 #define NXM_MAKE_WILD_HEADER(HEADER) \
1260 NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
1262 /* ## ------------------------------- ## */
1263 /* ## OpenFlow 1.0-compatible fields. ## */
1264 /* ## ------------------------------- ## */
1266 /* Physical or virtual port on which the packet was received.
1270 * Format: 16-bit integer in network byte order.
1272 * Masking: Not maskable. */
1273 #define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
1275 /* Source or destination address in Ethernet header.
1279 * Format: 48-bit Ethernet MAC address.
1281 * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
1282 * be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
1283 * are all-0-bits or all-1-bits). Support for other patterns and for masking
1284 * of NXM_OF_ETH_SRC is optional. */
1285 #define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
1286 #define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
1287 #define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
1289 /* Packet's Ethernet type.
1291 * For an Ethernet II packet this is taken from the Ethernet header. For an
1292 * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
1293 * A packet that has neither format has value 0x05ff
1294 * (OFP_DL_TYPE_NOT_ETH_TYPE).
1296 * For a packet with an 802.1Q header, this is the type of the encapsulated
1301 * Format: 16-bit integer in network byte order.
1303 * Masking: Not maskable. */
1304 #define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
1308 * For a packet with an 802.1Q header, this is the Tag Control Information
1309 * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
1310 * header, this has value 0.
1314 * Format: 16-bit integer in network byte order.
1316 * Masking: Arbitrary masks.
1318 * This field can be used in various ways:
1320 * - If it is not constrained at all, the nx_match matches packets without
1321 * an 802.1Q header or with an 802.1Q header that has any TCI value.
1323 * - Testing for an exact match with 0 matches only packets without an
1326 * - Testing for an exact match with a TCI value with CFI=1 matches packets
1327 * that have an 802.1Q header with a specified VID and PCP.
1329 * - Testing for an exact match with a nonzero TCI value with CFI=0 does
1330 * not make sense. The switch may reject this combination.
1332 * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
1333 * packets that have an 802.1Q header with that VID (and any PCP).
1335 * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
1336 * packets that have an 802.1Q header with that PCP (and any VID).
1338 * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
1339 * header or with an 802.1Q header with a VID of 0.
1341 * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
1342 * header or with an 802.1Q header with a PCP of 0.
1344 * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
1345 * header or with an 802.1Q header with both VID and PCP of 0.
1347 #define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
1348 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
1350 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
1352 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1354 * Format: 8-bit integer with 2 least-significant bits forced to 0.
1356 * Masking: Not maskable. */
1357 #define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
1359 /* The "protocol" byte in the IP header.
1361 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1363 * Format: 8-bit integer.
1365 * Masking: Not maskable. */
1366 #define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
1368 /* The source or destination address in the IP header.
1370 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
1372 * Format: 32-bit integer in network byte order.
1374 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1375 * high-order bits set to 1 and the other 32-N bits set to 0. */
1376 #define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
1377 #define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
1378 #define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
1379 #define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
1381 /* The source or destination port in the TCP header.
1384 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1385 * NXM_OF_IP_PROTO must match 6 exactly.
1387 * Format: 16-bit integer in network byte order.
1389 * Masking: Not maskable. */
1390 #define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
1391 #define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
1393 /* The source or destination port in the UDP header.
1396 * NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1397 * NXM_OF_IP_PROTO must match 17 exactly.
1399 * Format: 16-bit integer in network byte order.
1401 * Masking: Not maskable. */
1402 #define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
1403 #define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
1405 /* The type or code in the ICMP header.
1408 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
1409 * NXM_OF_IP_PROTO must match 1 exactly.
1411 * Format: 8-bit integer.
1413 * Masking: Not maskable. */
1414 #define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
1415 #define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
1419 * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
1420 * otherwise. Only ARP opcodes between 1 and 255 should be specified for
1423 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1425 * Format: 16-bit integer in network byte order.
1427 * Masking: Not maskable. */
1428 #define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
1430 /* For an Ethernet+IP ARP packet, the source or target protocol address
1431 * in the ARP header. Always 0 otherwise.
1433 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1435 * Format: 32-bit integer in network byte order.
1437 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1438 * high-order bits set to 1 and the other 32-N bits set to 0. */
1439 #define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
1440 #define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
1441 #define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
1442 #define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
1444 /* ## ------------------------ ## */
1445 /* ## Nicira match extensions. ## */
1446 /* ## ------------------------ ## */
1448 /* Metadata registers.
1450 * Registers initially have value 0. Actions allow register values to be
1455 * Format: Array of 32-bit integer registers. Space is reserved for up to
1456 * NXM_NX_MAX_REGS registers, but switches may implement fewer.
1458 * Masking: Arbitrary masks. */
1459 #define NXM_NX_MAX_REGS 16
1460 #define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
1461 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1462 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1463 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1464 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1465 #define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
1466 #define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
1467 #define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
1468 #define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
1469 #define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
1470 #define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
1471 #define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
1472 #define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
1473 #define NXM_NX_REG4 NXM_HEADER (0x0001, 4, 4)
1474 #define NXM_NX_REG4_W NXM_HEADER_W(0x0001, 4, 4)
1478 * For a packet received via GRE tunnel including a (32-bit) key, the key is
1479 * stored in the low 32-bits and the high bits are zeroed. For other packets,
1484 * Format: 64-bit integer in network byte order.
1486 * Masking: Arbitrary masks. */
1487 #define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
1488 #define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
1490 /* For an Ethernet+IP ARP packet, the source or target hardware address
1491 * in the ARP header. Always 0 otherwise.
1493 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1495 * Format: 48-bit Ethernet MAC address.
1497 * Masking: Not maskable. */
1498 #define NXM_NX_ARP_SHA NXM_HEADER (0x0001, 17, 6)
1499 #define NXM_NX_ARP_THA NXM_HEADER (0x0001, 18, 6)
1501 /* The source or destination address in the IPv6 header.
1503 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1505 * Format: 128-bit IPv6 address.
1507 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1508 * high-order bits set to 1 and the other 128-N bits set to 0. */
1509 #define NXM_NX_IPV6_SRC NXM_HEADER (0x0001, 19, 16)
1510 #define NXM_NX_IPV6_SRC_W NXM_HEADER_W(0x0001, 19, 16)
1511 #define NXM_NX_IPV6_DST NXM_HEADER (0x0001, 20, 16)
1512 #define NXM_NX_IPV6_DST_W NXM_HEADER_W(0x0001, 20, 16)
1514 /* The type or code in the ICMPv6 header.
1517 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1518 * NXM_OF_IP_PROTO must match 58 exactly.
1520 * Format: 8-bit integer.
1522 * Masking: Not maskable. */
1523 #define NXM_NX_ICMPV6_TYPE NXM_HEADER (0x0001, 21, 1)
1524 #define NXM_NX_ICMPV6_CODE NXM_HEADER (0x0001, 22, 1)
1526 /* The target address in an IPv6 Neighbor Discovery message.
1529 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1530 * NXM_OF_IP_PROTO must match 58 exactly.
1531 * NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1533 * Format: 128-bit IPv6 address.
1535 * Masking: Not maskable. */
1536 #define NXM_NX_ND_TARGET NXM_HEADER (0x0001, 23, 16)
1538 /* The source link-layer address option in an IPv6 Neighbor Discovery
1542 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1543 * NXM_OF_IP_PROTO must match 58 exactly.
1544 * NXM_OF_ICMPV6_TYPE must be exactly 135.
1546 * Format: 48-bit Ethernet MAC address.
1548 * Masking: Not maskable. */
1549 #define NXM_NX_ND_SLL NXM_HEADER (0x0001, 24, 6)
1551 /* The target link-layer address option in an IPv6 Neighbor Discovery
1555 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1556 * NXM_OF_IP_PROTO must match 58 exactly.
1557 * NXM_OF_ICMPV6_TYPE must be exactly 136.
1559 * Format: 48-bit Ethernet MAC address.
1561 * Masking: Not maskable. */
1562 #define NXM_NX_ND_TLL NXM_HEADER (0x0001, 25, 6)
1564 /* IP fragment information.
1567 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1569 * Format: 8-bit value with one of the values 0, 1, or 3, as described below.
1571 * Masking: Fully maskable.
1573 * This field has three possible values:
1575 * - A packet that is not an IP fragment has value 0.
1577 * - A packet that is an IP fragment with offset 0 (the first fragment) has
1578 * bit 0 set and thus value 1.
1580 * - A packet that is an IP fragment with nonzero offset has bits 0 and 1 set
1583 * NX_IP_FRAG_ANY and NX_IP_FRAG_LATER are declared to symbolically represent
1584 * the meanings of bits 0 and 1.
1586 * The switch may reject matches against values that can never appear.
1588 * It is important to understand how this field interacts with the OpenFlow IP
1589 * fragment handling mode:
1591 * - In OFPC_FRAG_DROP mode, the OpenFlow switch drops all IP fragments
1592 * before they reach the flow table, so every packet that is available for
1593 * matching will have value 0 in this field.
1595 * - Open vSwitch does not implement OFPC_FRAG_REASM mode, but if it did then
1596 * IP fragments would be reassembled before they reached the flow table and
1597 * again every packet available for matching would always have value 0.
1599 * - In OFPC_FRAG_NORMAL mode, all three values are possible, but OpenFlow
1600 * 1.0 says that fragments' transport ports are always 0, even for the
1601 * first fragment, so this does not provide much extra information.
1603 * - In OFPC_FRAG_NX_MATCH mode, all three values are possible. For
1604 * fragments with offset 0, Open vSwitch makes L4 header information
1607 #define NXM_NX_IP_FRAG NXM_HEADER (0x0001, 26, 1)
1608 #define NXM_NX_IP_FRAG_W NXM_HEADER_W(0x0001, 26, 1)
1610 /* Bits in the value of NXM_NX_IP_FRAG. */
1611 #define NX_IP_FRAG_ANY (1 << 0) /* Is this a fragment? */
1612 #define NX_IP_FRAG_LATER (1 << 1) /* Is this a fragment with nonzero offset? */
1614 /* ## --------------------- ## */
1615 /* ## Requests and replies. ## */
1616 /* ## --------------------- ## */
1618 enum nx_flow_format {
1619 NXFF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
1620 NXFF_NXM = 2 /* Nicira extended match. */
1623 /* NXT_SET_FLOW_FORMAT request. */
1624 struct nxt_set_flow_format {
1625 struct ofp_header header;
1626 ovs_be32 vendor; /* NX_VENDOR_ID. */
1627 ovs_be32 subtype; /* NXT_SET_FLOW_FORMAT. */
1628 ovs_be32 format; /* One of NXFF_*. */
1630 OFP_ASSERT(sizeof(struct nxt_set_flow_format) == 20);
1632 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */
1633 struct nx_flow_mod {
1634 struct nicira_header nxh;
1635 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1636 ovs_be16 command; /* One of OFPFC_*. */
1637 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
1638 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
1639 ovs_be16 priority; /* Priority level of flow entry. */
1640 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
1641 Not meaningful for OFPFC_DELETE*. */
1642 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
1643 matching entries to include this as an
1644 output port. A value of OFPP_NONE
1645 indicates no restriction. */
1646 ovs_be16 flags; /* One of OFPFF_*. */
1647 ovs_be16 match_len; /* Size of nx_match. */
1648 uint8_t pad[6]; /* Align to 64-bits. */
1650 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1651 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1652 * all-zero bytes, then
1653 * - Actions to fill out the remainder of the message length (always a
1657 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
1659 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1660 struct nx_flow_removed {
1661 struct nicira_header nxh;
1662 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1663 ovs_be16 priority; /* Priority level of flow entry. */
1664 uint8_t reason; /* One of OFPRR_*. */
1665 uint8_t pad[1]; /* Align to 32-bits. */
1666 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
1667 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
1669 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
1670 ovs_be16 match_len; /* Size of nx_match. */
1671 ovs_be64 packet_count;
1672 ovs_be64 byte_count;
1674 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1675 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1676 * all-zero bytes. */
1678 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
1680 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1682 struct nx_flow_stats_request {
1683 struct nicira_stats_msg nsm;
1684 ovs_be16 out_port; /* Require matching entries to include this
1685 as an output port. A value of OFPP_NONE
1686 indicates no restriction. */
1687 ovs_be16 match_len; /* Length of nx_match. */
1688 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1689 or 0xff for all tables. */
1690 uint8_t pad[3]; /* Align to 64 bits. */
1692 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1693 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1694 * all-zero bytes, which must also exactly fill out the length of the
1698 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
1700 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1701 * OFPST_FLOW reply). */
1702 struct nx_flow_stats {
1703 ovs_be16 length; /* Length of this entry. */
1704 uint8_t table_id; /* ID of table flow came from. */
1706 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
1707 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
1708 beyond duration_sec. */
1709 ovs_be16 priority; /* Priority of the entry. Only meaningful
1710 when this is not an exact-match entry. */
1711 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
1712 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
1713 ovs_be16 match_len; /* Length of nx_match. */
1714 uint8_t pad2[4]; /* Align to 64 bits. */
1715 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1716 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1717 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1719 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1720 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1721 * all-zero bytes, then
1722 * - Actions to fill out the remainder 'length' bytes (always a multiple
1726 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1728 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1729 * OFPST_AGGREGATE request). */
1730 struct nx_aggregate_stats_request {
1731 struct nicira_stats_msg nsm;
1732 ovs_be16 out_port; /* Require matching entries to include this
1733 as an output port. A value of OFPP_NONE
1734 indicates no restriction. */
1735 ovs_be16 match_len; /* Length of nx_match. */
1736 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1737 or 0xff for all tables. */
1738 uint8_t pad[3]; /* Align to 64 bits. */
1740 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1741 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1742 * all-zero bytes, which must also exactly fill out the length of the
1746 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1748 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1749 * OFPST_AGGREGATE reply). */
1750 struct nx_aggregate_stats_reply {
1751 struct nicira_stats_msg nsm;
1752 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1753 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1754 ovs_be32 flow_count; /* Number of flows. */
1755 uint8_t pad[4]; /* Align to 64 bits. */
1757 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1759 #endif /* openflow/nicira-ext.h */