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,
114 /* The in_port in an ofp_packet_out request is invalid. */
115 NXBRC_BAD_IN_PORT = 0x202
118 /* Additional "code" values for OFPET_FLOW_MOD_FAILED. */
119 enum nx_flow_mod_failed_code {
120 /* Generic hardware error. */
121 NXFMFC_HARDWARE = 0x100,
123 /* A nonexistent table ID was specified in the "command" field of struct
124 * ofp_flow_mod, when the nxt_flow_mod_table_id extension is enabled. */
125 NXFMFC_BAD_TABLE_ID = 0x101
128 /* Nicira vendor requests and replies. */
130 /* Header for Nicira vendor requests and replies. */
131 struct nicira_header {
132 struct ofp_header header;
133 ovs_be32 vendor; /* NX_VENDOR_ID. */
134 ovs_be32 subtype; /* One of NXT_* below. */
136 OFP_ASSERT(sizeof(struct nicira_header) == 16);
138 /* Values for the 'subtype' member of struct nicira_header. */
140 /* No longer used. */
141 NXT_STATUS_REQUEST__OBSOLETE = 0,
142 NXT_STATUS_REPLY__OBSOLETE = 1,
143 NXT_ACT_SET_CONFIG__OBSOLETE = 2,
144 NXT_ACT_GET_CONFIG__OBSOLETE = 3,
145 NXT_COMMAND_REQUEST__OBSOLETE = 4,
146 NXT_COMMAND_REPLY__OBSOLETE = 5,
147 NXT_FLOW_END_CONFIG__OBSOLETE = 6,
148 NXT_FLOW_END__OBSOLETE = 7,
149 NXT_MGMT__OBSOLETE = 8,
150 NXT_TUN_ID_FROM_COOKIE__OBSOLETE = 9,
152 /* Controller role support. The request body is struct nx_role_request.
153 * The reply echos the request. */
154 NXT_ROLE_REQUEST = 10,
157 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
158 NXT_SET_FLOW_FORMAT = 12, /* Set flow format. */
159 NXT_FLOW_MOD = 13, /* Analogous to OFPT_FLOW_MOD. */
160 NXT_FLOW_REMOVED = 14, /* Analogous to OFPT_FLOW_REMOVED. */
162 /* Use the upper 8 bits of the 'command' member in struct ofp_flow_mod to
163 * designate the table to which a flow is to be added? See the big comment
164 * on struct nxt_flow_mod_table_id for more information. */
165 NXT_FLOW_MOD_TABLE_ID = 15
168 /* Header for Nicira vendor stats request and reply messages. */
169 struct nicira_stats_msg {
170 struct ofp_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
171 ovs_be32 subtype; /* One of NXST_* below. */
172 uint8_t pad[4]; /* Align to 64-bits. */
174 OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
176 /* Values for the 'subtype' member of struct nicira_stats_msg. */
177 enum nicira_stats_type {
178 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
179 NXST_FLOW, /* Analogous to OFPST_FLOW. */
180 NXST_AGGREGATE /* Analogous to OFPST_AGGREGATE. */
183 /* Fields to use when hashing flows. */
184 enum nx_hash_fields {
185 /* Ethernet source address (NXM_OF_ETH_SRC) only. */
186 NX_HASH_FIELDS_ETH_SRC,
188 /* L2 through L4, symmetric across src/dst. Specifically, each of the
189 * following fields, if present, is hashed (slashes separate symmetric
192 * - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
194 * - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
196 * - NXM_OF_IP_SRC / NXM_OF_IP_DST
197 * - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
199 NX_HASH_FIELDS_SYMMETRIC_L4
202 /* This command enables or disables an Open vSwitch extension that allows a
203 * controller to specify the OpenFlow table to which a flow should be added,
204 * instead of having the switch decide which table is most appropriate as
205 * required by OpenFlow 1.0. By default, the extension is disabled.
207 * When this feature is enabled, Open vSwitch treats struct ofp_flow_mod's
208 * 16-bit 'command' member as two separate fields. The upper 8 bits are used
209 * as the table ID, the lower 8 bits specify the command as usual. A table ID
210 * of 0xff is treated like a wildcarded table ID.
212 * The specific treatment of the table ID depends on the type of flow mod:
214 * - OFPFC_ADD: Given a specific table ID, the flow is always placed in that
215 * table. If an identical flow already exists in that table only, then it
216 * is replaced. If the flow cannot be placed in the specified table,
217 * either because the table is full or because the table cannot support
218 * flows of the given type, the switch replies with an
219 * OFPFMFC_ALL_TABLES_FULL error. (A controller can distinguish these
220 * cases by comparing the current and maximum number of entries reported
221 * in ofp_table_stats.)
223 * If the table ID is wildcarded, the switch picks an appropriate table
224 * itself. If an identical flow already exist in the selected flow table,
225 * then it is replaced. The choice of table might depend on the flows
226 * that are already in the switch; for example, if one table fills up then
227 * the switch might fall back to another one.
229 * - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows
230 * within that table are matched and modified or deleted. If the table ID
231 * is wildcarded, flows within any table may be matched and modified or
234 * - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID,
235 * only a flow within that table may be matched and modified or deleted.
236 * If the table ID is wildcarded and exactly one flow within any table
237 * matches, then it is modified or deleted; if flows in more than one
238 * table match, then none is modified or deleted.
240 struct nxt_flow_mod_table_id {
241 struct ofp_header header;
242 uint32_t vendor; /* NX_VENDOR_ID. */
243 uint32_t subtype; /* NXT_FLOW_MOD_TABLE_ID. */
244 uint8_t set; /* Nonzero to enable, zero to disable. */
247 OFP_ASSERT(sizeof(struct nxt_flow_mod_table_id) == 24);
249 /* Configures the "role" of the sending controller. The default role is:
251 * - Other (NX_ROLE_OTHER), which allows the controller access to all
254 * The other possible roles are a related pair:
256 * - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
257 * be at most one Master controller at a time: when a controller
258 * configures itself as Master, any existing Master is demoted to the
261 * - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
262 * OpenFlow features. In particular attempts to modify the flow table
263 * will be rejected with an OFPBRC_EPERM error.
265 * Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
266 * messages, but they do receive OFPT_PORT_STATUS messages.
268 struct nx_role_request {
269 struct nicira_header nxh;
270 ovs_be32 role; /* One of NX_ROLE_*. */
274 NX_ROLE_OTHER, /* Default role, full access. */
275 NX_ROLE_MASTER, /* Full access, at most one. */
276 NX_ROLE_SLAVE /* Read-only access. */
279 /* Nicira vendor flow actions. */
281 enum nx_action_subtype {
282 NXAST_SNAT__OBSOLETE, /* No longer used. */
283 NXAST_RESUBMIT, /* struct nx_action_resubmit */
284 NXAST_SET_TUNNEL, /* struct nx_action_set_tunnel */
285 NXAST_DROP_SPOOFED_ARP__OBSOLETE,
286 NXAST_SET_QUEUE, /* struct nx_action_set_queue */
287 NXAST_POP_QUEUE, /* struct nx_action_pop_queue */
288 NXAST_REG_MOVE, /* struct nx_action_reg_move */
289 NXAST_REG_LOAD, /* struct nx_action_reg_load */
290 NXAST_NOTE, /* struct nx_action_note */
291 NXAST_SET_TUNNEL64, /* struct nx_action_set_tunnel64 */
292 NXAST_MULTIPATH, /* struct nx_action_multipath */
293 NXAST_AUTOPATH, /* struct nx_action_autopath */
294 NXAST_BUNDLE, /* struct nx_action_bundle */
295 NXAST_BUNDLE_LOAD, /* struct nx_action_bundle */
296 NXAST_RESUBMIT_TABLE, /* struct nx_action_resubmit */
297 NXAST_OUTPUT_REG, /* struct nx_action_output_reg */
298 NXAST_LEARN, /* struct nx_action_learn */
299 NXAST_EXIT /* struct nx_action_header */
302 /* Header for Nicira-defined actions. */
303 struct nx_action_header {
304 ovs_be16 type; /* OFPAT_VENDOR. */
305 ovs_be16 len; /* Length is 16. */
306 ovs_be32 vendor; /* NX_VENDOR_ID. */
307 ovs_be16 subtype; /* NXAST_*. */
310 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
312 /* Action structures for NXAST_RESUBMIT and NXAST_RESUBMIT_TABLE.
314 * These actions search one of the switch's flow tables:
316 * - For NXAST_RESUBMIT_TABLE only, if the 'table' member is not 255, then
317 * it specifies the table to search.
319 * - Otherwise (for NXAST_RESUBMIT_TABLE with a 'table' of 255, or for
320 * NXAST_RESUBMIT regardless of 'table'), it searches the current flow
321 * table, that is, the OpenFlow flow table that contains the flow from
322 * which this action was obtained. If this action did not come from a
323 * flow table (e.g. it came from an OFPT_PACKET_OUT message), then table 0
324 * is the current table.
326 * The flow table lookup uses a flow that may be slightly modified from the
329 * - For NXAST_RESUBMIT, the 'in_port' member of struct nx_action_resubmit
330 * is used as the flow's in_port.
332 * - For NXAST_RESUBMIT_TABLE, if the 'in_port' member is not OFPP_IN_PORT,
333 * then its value is used as the flow's in_port. Otherwise, the original
336 * - If actions that modify the flow (e.g. OFPAT_SET_VLAN_VID) precede the
337 * resubmit action, then the flow is updated with the new values.
339 * Following the lookup, the original in_port is restored.
341 * If the modified flow matched in the flow table, then the corresponding
342 * actions are executed. Afterward, actions following the resubmit in the
343 * original set of actions, if any, are executed; any changes made to the
344 * packet (e.g. changes to VLAN) by secondary actions persist when those
345 * actions are executed, although the original in_port is restored.
347 * Resubmit actions may be used any number of times within a set of actions.
349 * Resubmit actions may nest to an implementation-defined depth. Beyond this
350 * implementation-defined depth, further resubmit actions are simply ignored.
352 * NXAST_RESUBMIT ignores 'table' and 'pad'. NXAST_RESUBMIT_TABLE requires
353 * 'pad' to be all-bits-zero.
355 * Open vSwitch 1.0.1 and earlier did not support recursion. Open vSwitch
356 * before 1.2.90 did not support NXAST_RESUBMIT_TABLE.
358 struct nx_action_resubmit {
359 ovs_be16 type; /* OFPAT_VENDOR. */
360 ovs_be16 len; /* Length is 16. */
361 ovs_be32 vendor; /* NX_VENDOR_ID. */
362 ovs_be16 subtype; /* NXAST_RESUBMIT. */
363 ovs_be16 in_port; /* New in_port for checking flow table. */
364 uint8_t table; /* NXAST_RESUBMIT_TABLE: table to use. */
367 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
369 /* Action structure for NXAST_SET_TUNNEL.
371 * Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32
372 * bits of the tunnel ID are set to 0. */
373 struct nx_action_set_tunnel {
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_TUNNEL. */
379 ovs_be32 tun_id; /* Tunnel ID. */
381 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
383 /* Action structure for NXAST_SET_TUNNEL64.
385 * Sets the encapsulating tunnel ID to a 64-bit value. */
386 struct nx_action_set_tunnel64 {
387 ovs_be16 type; /* OFPAT_VENDOR. */
388 ovs_be16 len; /* Length is 16. */
389 ovs_be32 vendor; /* NX_VENDOR_ID. */
390 ovs_be16 subtype; /* NXAST_SET_TUNNEL64. */
392 ovs_be64 tun_id; /* Tunnel ID. */
394 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
396 /* Action structure for NXAST_SET_QUEUE.
398 * Set the queue that should be used when packets are output. This is similar
399 * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
400 * an argument. This allows the queue to be defined before the port is
402 struct nx_action_set_queue {
403 ovs_be16 type; /* OFPAT_VENDOR. */
404 ovs_be16 len; /* Length is 16. */
405 ovs_be32 vendor; /* NX_VENDOR_ID. */
406 ovs_be16 subtype; /* NXAST_SET_QUEUE. */
408 ovs_be32 queue_id; /* Where to enqueue packets. */
410 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
412 /* Action structure for NXAST_POP_QUEUE.
414 * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
415 * were used. Only the original queue can be restored this way; no stack is
417 struct nx_action_pop_queue {
418 ovs_be16 type; /* OFPAT_VENDOR. */
419 ovs_be16 len; /* Length is 16. */
420 ovs_be32 vendor; /* NX_VENDOR_ID. */
421 ovs_be16 subtype; /* NXAST_POP_QUEUE. */
424 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
426 /* Action structure for NXAST_REG_MOVE.
428 * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
429 * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
430 * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
431 * the next most significant bit, and so on.
433 * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
434 * sense to use nxm_hasmask=1 because the action does not do any kind of
435 * matching; it uses the actual value of a field.)
437 * The following nxm_header values are potentially acceptable as 'src':
460 * - NXM_NX_ICMPV6_TYPE
461 * - NXM_NX_ICMPV6_CODE
464 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
466 * The following nxm_header values are potentially acceptable as 'dst':
477 * Modifying any of the above fields changes the corresponding packet
480 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
482 * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
483 * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
484 * header (if any), ignoring the other bits. Setting a value with CFI=1
485 * adds or modifies the 802.1Q header appropriately, setting the TCI field
486 * to the field's new value (with the CFI bit masked out).
488 * - NXM_NX_TUN_ID. Modifying this value modifies the tunnel ID used for the
489 * packet's next tunnel encapsulation.
491 * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
492 * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
493 * used only if the flow's nx_match includes an nxm_entry that specifies
494 * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
496 * The switch will reject actions for which src_ofs+n_bits is greater than the
497 * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
498 * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
500 struct nx_action_reg_move {
501 ovs_be16 type; /* OFPAT_VENDOR. */
502 ovs_be16 len; /* Length is 16. */
503 ovs_be32 vendor; /* NX_VENDOR_ID. */
504 ovs_be16 subtype; /* NXAST_REG_MOVE. */
505 ovs_be16 n_bits; /* Number of bits. */
506 ovs_be16 src_ofs; /* Starting bit offset in source. */
507 ovs_be16 dst_ofs; /* Starting bit offset in destination. */
508 ovs_be32 src; /* Source register. */
509 ovs_be32 dst; /* Destination register. */
511 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
513 /* Action structure for NXAST_REG_LOAD.
515 * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
516 * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
517 * starts at 0 for the least-significant bit, 1 for the next most significant
520 * 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for
521 * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
524 * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
525 * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
526 * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
527 * also stored as one less than its true value:
530 * +------------------------------+------------------+
531 * | ofs | n_bits - 1 |
532 * +------------------------------+------------------+
534 * The switch will reject actions for which ofs+n_bits is greater than the
535 * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
536 * greater are set to 1, with error type OFPET_BAD_ACTION, code
537 * OFPBAC_BAD_ARGUMENT.
539 struct nx_action_reg_load {
540 ovs_be16 type; /* OFPAT_VENDOR. */
541 ovs_be16 len; /* Length is 16. */
542 ovs_be32 vendor; /* NX_VENDOR_ID. */
543 ovs_be16 subtype; /* NXAST_REG_LOAD. */
544 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
545 ovs_be32 dst; /* Destination register. */
546 ovs_be64 value; /* Immediate value. */
548 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
550 /* Action structure for NXAST_NOTE.
552 * This action has no effect. It is variable length. The switch does not
553 * attempt to interpret the user-defined 'note' data in any way. A controller
554 * can use this action to attach arbitrary metadata to a flow.
556 * This action might go away in the future.
558 struct nx_action_note {
559 ovs_be16 type; /* OFPAT_VENDOR. */
560 ovs_be16 len; /* A multiple of 8, but at least 16. */
561 ovs_be32 vendor; /* NX_VENDOR_ID. */
562 ovs_be16 subtype; /* NXAST_NOTE. */
563 uint8_t note[6]; /* Start of user-defined data. */
564 /* Possibly followed by additional user-defined data. */
566 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
568 /* Action structure for NXAST_MULTIPATH.
570 * This action performs the following steps in sequence:
572 * 1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
573 * Refer to the definition of "enum nx_mp_fields" for details.
575 * The 'basis' value is used as a universal hash parameter, that is,
576 * different values of 'basis' yield different hash functions. The
577 * particular universal hash function used is implementation-defined.
579 * The hashed fields' values are drawn from the current state of the
580 * flow, including all modifications that have been made by actions up to
583 * 2. Applies the multipath link choice algorithm specified by 'algorithm',
584 * one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm"
587 * The output of the algorithm is 'link', an unsigned integer less than
588 * or equal to 'max_link'.
590 * Some algorithms use 'arg' as an additional argument.
592 * 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of
593 * 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
596 * The switch will reject actions that have an unknown 'fields', or an unknown
597 * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
598 * in which 'max_link' is greater than or equal to 2**n_bits, with error type
599 * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
601 struct nx_action_multipath {
602 ovs_be16 type; /* OFPAT_VENDOR. */
603 ovs_be16 len; /* Length is 32. */
604 ovs_be32 vendor; /* NX_VENDOR_ID. */
605 ovs_be16 subtype; /* NXAST_MULTIPATH. */
607 /* What fields to hash and how. */
608 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
609 ovs_be16 basis; /* Universal hash parameter. */
612 /* Multipath link choice algorithm to apply to hash value. */
613 ovs_be16 algorithm; /* One of NX_MP_ALG_*. */
614 ovs_be16 max_link; /* Number of output links, minus 1. */
615 ovs_be32 arg; /* Algorithm-specific argument. */
618 /* Where to store the result. */
619 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
620 ovs_be32 dst; /* Destination. */
622 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
624 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
626 * In the descriptions below, 'n_links' is max_link + 1. */
627 enum nx_mp_algorithm {
628 /* link = hash(flow) % n_links.
630 * Redistributes all traffic when n_links changes. O(1) performance. See
633 * Use UINT16_MAX for max_link to get a raw hash value. */
636 /* link = hash(flow) / (MAX_HASH / n_links).
638 * Redistributes between one-quarter and one-half of traffic when n_links
639 * changes. O(1) performance. See RFC 2992.
641 NX_MP_ALG_HASH_THRESHOLD,
643 /* for i in [0,n_links):
644 * weights[i] = hash(flow, i)
645 * link = { i such that weights[i] >= weights[j] for all j != i }
647 * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
648 * performance. If n_links is greater than a threshold (currently 64, but
649 * subject to change), Open vSwitch will substitute another algorithm
650 * automatically. See RFC 2992. */
651 NX_MP_ALG_HRW, /* Highest Random Weight. */
656 * link = hash(flow, i) % arg
657 * while link > max_link
659 * Redistributes 1/n_links of traffic when n_links changes. O(1)
660 * performance when arg/max_link is bounded by a constant.
662 * Redistributes all traffic when arg changes.
664 * arg must be greater than max_link and for best performance should be no
665 * more than approximately max_link * 2. If arg is outside the acceptable
666 * range, Open vSwitch will automatically substitute the least power of 2
667 * greater than max_link.
669 * This algorithm is specific to Open vSwitch.
671 NX_MP_ALG_ITER_HASH /* Iterative Hash. */
674 /* Action structure for NXAST_LEARN.
676 * This action adds or modifies a flow in an OpenFlow table, similar to
677 * OFPT_FLOW_MOD with OFPFC_MODIFY_STRICT as 'command'. The new flow has the
678 * specified idle timeout, hard timeout, priority, cookie, and flags. The new
679 * flow's match criteria and actions are built by applying each of the series
680 * of flow_mod_spec elements included as part of the action.
682 * A flow_mod_spec starts with a 16-bit header. A header that is all-bits-0 is
683 * a no-op used for padding the action as a whole to a multiple of 8 bytes in
684 * length. Otherwise, the flow_mod_spec can be thought of as copying 'n_bits'
685 * bits from a source to a destination. In this case, the header contains
688 * 15 14 13 12 11 10 0
689 * +------+---+------+---------------------------------+
690 * | 0 |src| dst | n_bits |
691 * +------+---+------+---------------------------------+
693 * The meaning and format of a flow_mod_spec depends on 'src' and 'dst'. The
694 * following table summarizes the meaning of each possible combination.
695 * Details follow the table:
698 * --- --- ----------------------------------------------------------
699 * 0 0 Add match criteria based on value in a field.
700 * 1 0 Add match criteria based on an immediate value.
701 * 0 1 Add NXAST_REG_LOAD action to copy field into a different field.
702 * 1 1 Add NXAST_REG_LOAD action to load immediate value into a field.
703 * 0 2 Add OFPAT_OUTPUT action to output to port from specified field.
704 * All other combinations are undefined and not allowed.
706 * The flow_mod_spec header is followed by a source specification and a
707 * destination specification. The format and meaning of the source
708 * specification depends on 'src':
710 * - If 'src' is 0, the source bits are taken from a field in the flow to
711 * which this action is attached. (This should be a wildcarded field. If
712 * its value is fully specified then the source bits being copied have
715 * The source specification is an ovs_be32 'field' and an ovs_be16 'ofs'.
716 * 'field' is an nxm_header with nxm_hasmask=0, and 'ofs' the starting bit
717 * offset within that field. The source bits are field[ofs:ofs+n_bits-1].
718 * 'field' and 'ofs' are subject to the same restrictions as the source
719 * field in NXAST_REG_MOVE.
721 * - If 'src' is 1, the source bits are a constant value. The source
722 * specification is (n_bits+15)/16*2 bytes long. Taking those bytes as a
723 * number in network order, the source bits are the 'n_bits'
724 * least-significant bits. The switch will report an error if other bits
725 * in the constant are nonzero.
727 * The flow_mod_spec destination specification, for 'dst' of 0 or 1, is an
728 * ovs_be32 'field' and an ovs_be16 'ofs'. 'field' is an nxm_header with
729 * nxm_hasmask=0 and 'ofs' is a starting bit offset within that field. The
730 * meaning of the flow_mod_spec depends on 'dst':
732 * - If 'dst' is 0, the flow_mod_spec specifies match criteria for the new
733 * flow. The new flow matches only if bits field[ofs:ofs+n_bits-1] in a
734 * packet equal the source bits. 'field' may be any nxm_header with
735 * nxm_hasmask=0 that is allowed in NXT_FLOW_MOD.
737 * Order is significant. Earlier flow_mod_specs must satisfy any
738 * prerequisites for matching fields specified later, by copying constant
739 * values into prerequisite fields.
741 * The switch will reject flow_mod_specs that do not satisfy NXM masking
744 * - If 'dst' is 1, the flow_mod_spec specifies an NXAST_REG_LOAD action for
745 * the new flow. The new flow copies the source bits into
746 * field[ofs:ofs+n_bits-1]. Actions are executed in the same order as the
749 * The flow_mod_spec destination spec for 'dst' of 2 (when 'src' is 0) is
750 * empty. It has the following meaning:
752 * - The flow_mod_spec specifies an OFPAT_OUTPUT action for the new flow.
753 * The new flow outputs to the OpenFlow port specified by the source field.
754 * Of the special output ports with value OFPP_MAX or larger, OFPP_IN_PORT,
755 * OFPP_FLOOD, OFPP_LOCAL, and OFPP_ALL are supported. Other special ports
758 * Resource Management
759 * -------------------
761 * A switch has a finite amount of flow table space available for learning.
762 * When this space is exhausted, no new learning table entries will be learned
763 * until some existing flow table entries expire. The controller should be
764 * prepared to handle this by flooding (which can be implemented as a
765 * low-priority flow).
770 * The following examples give a prose description of the flow_mod_specs along
771 * with informal notation for how those would be represented and a hex dump of
772 * the bytes that would be required.
774 * These examples could work with various nx_action_learn parameters. Typical
775 * values would be idle_timeout=OFP_FLOW_PERMANENT, hard_timeout=60,
776 * priority=OFP_DEFAULT_PRIORITY, flags=0, table_id=10.
778 * 1. Learn input port based on the source MAC, with lookup into
779 * NXM_NX_REG1[16:31] by resubmit to in_port=99:
781 * Match on in_port=99:
782 * ovs_be16(src=1, dst=0, n_bits=16), 20 10
783 * ovs_be16(99), 00 63
784 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
786 * Match Ethernet destination on Ethernet source from packet:
787 * ovs_be16(src=0, dst=0, n_bits=48), 00 30
788 * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
789 * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
791 * Set NXM_NX_REG1[16:31] to the packet's input port:
792 * ovs_be16(src=0, dst=1, n_bits=16), 08 10
793 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
794 * ovs_be32(NXM_NX_REG1), ovs_be16(16) 00 01 02 04 00 10
796 * Given a packet that arrived on port A with Ethernet source address B,
797 * this would set up the flow "in_port=99, dl_dst=B,
798 * actions=load:A->NXM_NX_REG1[16..31]".
800 * In syntax accepted by ovs-ofctl, this action is: learn(in_port=99,
801 * NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
802 * load:NXM_OF_IN_PORT[]->NXM_NX_REG1[16..31])
804 * 2. Output to input port based on the source MAC and VLAN VID, with lookup
805 * into NXM_NX_REG1[16:31]:
807 * Match on same VLAN ID as packet:
808 * ovs_be16(src=0, dst=0, n_bits=12), 00 0c
809 * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
810 * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
812 * Match Ethernet destination on Ethernet source from packet:
813 * ovs_be16(src=0, dst=0, n_bits=48), 00 30
814 * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
815 * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
817 * Output to the packet's input port:
818 * ovs_be16(src=0, dst=2, n_bits=16), 10 10
819 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
821 * Given a packet that arrived on port A with Ethernet source address B in
822 * VLAN C, this would set up the flow "dl_dst=B, vlan_vid=C,
825 * In syntax accepted by ovs-ofctl, this action is:
826 * learn(NXM_OF_VLAN_TCI[0..11], NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
827 * output:NXM_OF_IN_PORT[])
829 * 3. Here's a recipe for a very simple-minded MAC learning switch. It uses a
830 * 10-second MAC expiration time to make it easier to see what's going on
832 * ovs-vsctl del-controller br0
833 * ovs-ofctl del-flows br0
834 * ovs-ofctl add-flow br0 "table=0 actions=learn(table=1, \
835 hard_timeout=10, NXM_OF_VLAN_TCI[0..11], \
836 NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[], \
837 output:NXM_OF_IN_PORT[]), resubmit(,1)"
838 * ovs-ofctl add-flow br0 "table=1 priority=0 actions=flood"
840 * You can then dump the MAC learning table with:
842 * ovs-ofctl dump-flows br0 table=1
847 * For best performance, segregate learned flows into a table that is not used
848 * for any other flows except possibly for a lowest-priority "catch-all" flow
849 * (a flow with no match criteria). If different learning actions specify
850 * different match criteria, use different tables for the learned flows.
852 * The meaning of 'hard_timeout' and 'idle_timeout' can be counterintuitive.
853 * These timeouts apply to the flow that is added, which means that a flow with
854 * an idle timeout will expire when no traffic has been sent *to* the learned
855 * address. This is not usually the intent in MAC learning; instead, we want
856 * the MAC learn entry to expire when no traffic has been sent *from* the
857 * learned address. Use a hard timeout for that.
859 struct nx_action_learn {
860 ovs_be16 type; /* OFPAT_VENDOR. */
861 ovs_be16 len; /* At least 24. */
862 ovs_be32 vendor; /* NX_VENDOR_ID. */
863 ovs_be16 subtype; /* NXAST_LEARN. */
864 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
865 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
866 ovs_be16 priority; /* Priority level of flow entry. */
867 ovs_be64 cookie; /* Cookie for new flow. */
868 ovs_be16 flags; /* Either 0 or OFPFF_SEND_FLOW_REM. */
869 uint8_t table_id; /* Table to insert flow entry. */
870 uint8_t pad[5]; /* Must be zero. */
871 /* Followed by a sequence of flow_mod_spec elements, as described above,
872 * until the end of the action is reached. */
874 OFP_ASSERT(sizeof(struct nx_action_learn) == 32);
876 #define NX_LEARN_N_BITS_MASK 0x3ff
878 #define NX_LEARN_SRC_FIELD (0 << 13) /* Copy from field. */
879 #define NX_LEARN_SRC_IMMEDIATE (1 << 13) /* Copy from immediate value. */
880 #define NX_LEARN_SRC_MASK (1 << 13)
882 #define NX_LEARN_DST_MATCH (0 << 11) /* Add match criterion. */
883 #define NX_LEARN_DST_LOAD (1 << 11) /* Add NXAST_REG_LOAD action. */
884 #define NX_LEARN_DST_OUTPUT (2 << 11) /* Add OFPAT_OUTPUT action. */
885 #define NX_LEARN_DST_RESERVED (3 << 11) /* Not yet defined. */
886 #define NX_LEARN_DST_MASK (3 << 11)
888 /* Action structure for NXAST_AUTOPATH.
890 * This action performs the following steps in sequence:
892 * 1. Hashes the flow using an implementation-defined hash function.
894 * The hashed fields' values are drawn from the current state of the
895 * flow, including all modifications that have been made by actions up to
898 * 2. Selects an OpenFlow 'port'.
900 * 'port' is selected in an implementation-defined manner, taking into
901 * account 'id' and the hash value calculated in step 1.
903 * Generally a switch will have been configured with a set of ports that
904 * may be chosen given 'id'. The switch may take into account any number
905 * of factors when choosing 'port' from its configured set. Factors may
906 * include carrier, load, and the results of configuration protocols such
909 * 3. Stores 'port' in dst[ofs:ofs+n_bits].
911 * The format and semantics of 'dst' and 'ofs_nbits' are similar to those
912 * for the NXAST_REG_LOAD action.
914 * The switch will reject actions in which ofs+n_bits is greater than the width
915 * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
917 struct nx_action_autopath {
918 ovs_be16 type; /* OFPAT_VENDOR. */
919 ovs_be16 len; /* Length is 20. */
920 ovs_be32 vendor; /* NX_VENDOR_ID. */
921 ovs_be16 subtype; /* NXAST_AUTOPATH. */
923 /* Where to store the result. */
924 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
925 ovs_be32 dst; /* Destination. */
927 ovs_be32 id; /* Autopath ID. */
930 OFP_ASSERT(sizeof(struct nx_action_autopath) == 24);
932 /* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD.
934 * The bundle actions choose a slave from a supplied list of options.
935 * NXAST_BUNDLE outputs to its selection. NXAST_BUNDLE_LOAD writes its
936 * selection to a register.
938 * The list of possible slaves follows the nx_action_bundle structure. The size
939 * of each slave is governed by its type as indicated by the 'slave_type'
940 * parameter. The list of slaves should be padded at its end with zeros to make
941 * the total length of the action a multiple of 8.
943 * Switches infer from the 'slave_type' parameter the size of each slave. All
944 * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
945 * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
946 * 2 byte width. Switches should reject actions which indicate unknown or
947 * unsupported slave types.
949 * Switches use a strategy dictated by the 'algorithm' parameter to choose a
950 * slave. If the switch does not support the specified 'algorithm' parameter,
951 * it should reject the action.
953 * Several algorithms take into account liveness when selecting slaves. The
954 * liveness of a slave is implementation defined (with one exception), but will
955 * generally take into account things like its carrier status and the results
956 * of any link monitoring protocols which happen to be running on it. In order
957 * to give controllers a place-holder value, the OFPP_NONE port is always
960 * Some slave selection strategies require the use of a hash function, in which
961 * case the 'fields' and 'basis' parameters should be populated. The 'fields'
962 * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
963 * hash. Refer to the definition of "enum nx_hash_fields" for details. The
964 * 'basis' parameter is used as a universal hash parameter. Different values
965 * of 'basis' yield different hash results.
967 * The 'zero' parameter at the end of the action structure is reserved for
968 * future use. Switches are required to reject actions which have nonzero
969 * bytes in the 'zero' field.
971 * NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed. Switches
972 * should reject actions which have nonzero bytes in either of these fields.
974 * NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in
975 * dst[ofs:ofs+n_bits]. The format and semantics of 'dst' and 'ofs_nbits' are
976 * similar to those for the NXAST_REG_LOAD action. */
977 struct nx_action_bundle {
978 ovs_be16 type; /* OFPAT_VENDOR. */
979 ovs_be16 len; /* Length including slaves. */
980 ovs_be32 vendor; /* NX_VENDOR_ID. */
981 ovs_be16 subtype; /* NXAST_BUNDLE. */
983 /* Slave choice algorithm to apply to hash value. */
984 ovs_be16 algorithm; /* One of NX_BD_ALG_*. */
986 /* What fields to hash and how. */
987 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
988 ovs_be16 basis; /* Universal hash parameter. */
990 ovs_be32 slave_type; /* NXM_OF_IN_PORT. */
991 ovs_be16 n_slaves; /* Number of slaves. */
993 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
994 ovs_be32 dst; /* Destination. */
996 uint8_t zero[4]; /* Reserved. Must be zero. */
998 OFP_ASSERT(sizeof(struct nx_action_bundle) == 32);
1000 /* NXAST_BUNDLE: Bundle slave choice algorithm to apply.
1002 * In the descriptions below, 'slaves' is the list of possible slaves in the
1003 * order they appear in the OpenFlow action. */
1004 enum nx_bd_algorithm {
1005 /* Chooses the first live slave listed in the bundle.
1007 * O(n_slaves) performance. */
1008 NX_BD_ALG_ACTIVE_BACKUP,
1010 /* for i in [0,n_slaves):
1011 * weights[i] = hash(flow, i)
1012 * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
1014 * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
1015 * O(n_slaves) performance.
1017 * Uses the 'fields' and 'basis' parameters. */
1018 NX_BD_ALG_HRW /* Highest Random Weight. */
1021 /* Action structure for NXAST_OUTPUT_REG.
1023 * Outputs to the OpenFlow port number written to src[ofs:ofs+nbits].
1025 * The format and semantics of 'src' and 'ofs_nbits' are similar to those for
1026 * the NXAST_REG_LOAD action.
1028 * The acceptable nxm_header values for 'src' are the same as the acceptable
1029 * nxm_header values for the 'src' field of NXAST_REG_MOVE.
1031 * The 'max_len' field indicates the number of bytes to send when the chosen
1032 * port is OFPP_CONTROLLER. Its semantics are equivalent to the 'max_len'
1033 * field of OFPAT_OUTPUT.
1035 * The 'zero' field is required to be zeroed for forward compatibility. */
1036 struct nx_action_output_reg {
1037 ovs_be16 type; /* OFPAT_VENDOR. */
1038 ovs_be16 len; /* 24. */
1039 ovs_be32 vendor; /* NX_VENDOR_ID. */
1040 ovs_be16 subtype; /* NXAST_OUTPUT_REG. */
1042 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
1043 ovs_be32 src; /* Source. */
1045 ovs_be16 max_len; /* Max length to send to controller. */
1047 uint8_t zero[6]; /* Reserved, must be zero. */
1049 OFP_ASSERT(sizeof(struct nx_action_output_reg) == 24);
1053 * Discontinues action processing.
1055 * The NXAST_EXIT action causes the switch to immediately halt processing
1056 * actions for the flow. Any actions which have already been processed are
1057 * executed by the switch. However, any further actions, including those which
1058 * may be in different tables, or different levels of the NXAST_RESUBMIT
1059 * hierarchy, will be ignored.
1061 * Uses the nx_action_header structure. */
1063 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
1065 * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches. This
1066 * structure is fixed-length and hence difficult to extend. This section
1067 * describes a more flexible, variable-length flow match, called "nx_match" for
1068 * short, that is also supported by Open vSwitch. This section also defines a
1069 * replacement for each OpenFlow message that includes struct ofp_match.
1075 * An nx_match is a sequence of zero or more "nxm_entry"s, which are
1076 * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
1077 * "nxm_entry"s are not aligned on or padded to any multibyte boundary. The
1078 * first 4 bytes of an nxm_entry are its "header", followed by the entry's
1081 * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
1083 * |<-------------------- nxm_type ------------------>|
1085 * |31 16 15 9| 8 7 0
1086 * +----------------------------------+---------------+--+------------------+
1087 * | nxm_vendor | nxm_field |hm| nxm_length |
1088 * +----------------------------------+---------------+--+------------------+
1090 * The most-significant 23 bits of the header are collectively "nxm_type".
1091 * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
1092 * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
1093 * designates a protocol header, such as the Ethernet type, but it can also
1094 * refer to packet metadata, such as the switch port on which a packet arrived.
1096 * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
1097 * of this bit is explained later.
1099 * The least-significant 8 bits are "nxm_length", a positive integer. The
1100 * length of the nxm_entry, including the header, is exactly 4 + nxm_length
1103 * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
1104 * constant. It is included only to allow software to minimally parse
1105 * "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor,
1106 * nxm_field, and nxm_length, nxm_hasmask is a constant.)
1112 * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
1114 * An nxm_entry places a constraint on the packets matched by the nx_match:
1116 * - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
1117 * field, called "nxm_value". The nx_match matches only packets in which
1118 * the field equals nxm_value.
1120 * - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
1121 * field (nxm_value), followed by a bitmask of the same length as the
1122 * value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
1123 * nx_match matches only packets for which bit J in the given field's value
1124 * matches bit J in nxm_value. A 0-bit in nxm_mask causes the
1125 * corresponding bits in nxm_value and the field's value to be ignored.
1126 * (The sense of the nxm_mask bits is the opposite of that used by the
1127 * "wildcards" member of struct ofp_match.)
1129 * When nxm_hasmask is 1, nxm_length is always even.
1131 * An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
1132 * entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for
1135 * When there are multiple "nxm_entry"s, all of the constraints must be met.
1141 * Masks may be restricted:
1143 * - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
1144 * must always be 0 when these fields are specified. For example, the
1145 * field that identifies the port on which a packet was received may not be
1148 * - Some nxm_types that do support masked wildcards may only support certain
1149 * nxm_mask patterns. For example, fields that have IPv4 address values
1150 * may be restricted to CIDR masks.
1152 * These restrictions should be noted in specifications for individual fields.
1153 * A switch may accept an nxm_hasmask or nxm_mask value that the specification
1154 * disallows, if the switch correctly implements support for that nxm_hasmask
1155 * or nxm_mask value. A switch must reject an attempt to set up a flow that
1156 * contains a nxm_hasmask or nxm_mask value that it does not support.
1159 * Prerequisite Restrictions
1160 * =========================
1162 * The presence of an nxm_entry with a given nxm_type may be restricted based
1163 * on the presence of or values of other "nxm_entry"s. For example:
1165 * - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
1166 * preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
1167 * and nxm_value=0x0800. That is, matching on the IP source address is
1168 * allowed only if the Ethernet type is explicitly set to IP.
1170 * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is
1171 * preceded by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and
1172 * nxm_value either 0x0800 or 0x86dd, and another with
1173 * nxm_type=NXM_OF_IP_PROTO, nxm_hasmask=0, nxm_value=6, in that order.
1174 * That is, matching on the TCP source port is allowed only if the Ethernet
1175 * type is IP or IPv6 and the IP protocol is TCP.
1177 * These restrictions should be noted in specifications for individual fields.
1178 * A switch may implement relaxed versions of these restrictions. A switch
1179 * must reject an attempt to set up a flow that violates its restrictions.
1182 * Ordering Restrictions
1183 * =====================
1185 * An nxm_entry that has prerequisite restrictions must appear after the
1186 * "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an
1187 * nx_match is not otherwise constrained.
1189 * Any given nxm_type may appear in an nx_match at most once.
1192 * nxm_entry Examples
1193 * ==================
1195 * These examples show the format of a single nxm_entry with particular
1196 * nxm_hasmask and nxm_length values. The diagrams are labeled with field
1197 * numbers and byte indexes.
1200 * 8-bit nxm_value, nxm_hasmask=1, nxm_length=2:
1203 * +------------+---+---+
1204 * | header | v | m |
1205 * +------------+---+---+
1208 * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
1211 * +------------+------+
1213 * +------------+------+
1216 * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
1219 * +------------+-------------+
1220 * | header | nxm_value |
1221 * +------------+-------------+
1224 * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
1227 * +------------+------------------+
1228 * | header | nxm_value |
1229 * +------------+------------------+
1232 * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
1235 * +------------+------------------+------------------+
1236 * | header | nxm_value | nxm_mask |
1237 * +------------+------------------+------------------+
1243 * A switch should report an error in an nx_match using error type
1244 * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch
1245 * should report a specific error code, if one is assigned for the particular
1246 * problem, but NXBRC_NXM_INVALID is also available to report a generic
1250 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
1251 (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
1252 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
1253 NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
1254 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
1255 NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
1256 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
1257 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
1258 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
1259 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
1260 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
1262 #define NXM_MAKE_WILD_HEADER(HEADER) \
1263 NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
1265 /* ## ------------------------------- ## */
1266 /* ## OpenFlow 1.0-compatible fields. ## */
1267 /* ## ------------------------------- ## */
1269 /* Physical or virtual port on which the packet was received.
1273 * Format: 16-bit integer in network byte order.
1275 * Masking: Not maskable. */
1276 #define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
1278 /* Source or destination address in Ethernet header.
1282 * Format: 48-bit Ethernet MAC address.
1284 * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
1285 * be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
1286 * are all-0-bits or all-1-bits). Support for other patterns and for masking
1287 * of NXM_OF_ETH_SRC is optional. */
1288 #define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
1289 #define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
1290 #define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
1292 /* Packet's Ethernet type.
1294 * For an Ethernet II packet this is taken from the Ethernet header. For an
1295 * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
1296 * A packet that has neither format has value 0x05ff
1297 * (OFP_DL_TYPE_NOT_ETH_TYPE).
1299 * For a packet with an 802.1Q header, this is the type of the encapsulated
1304 * Format: 16-bit integer in network byte order.
1306 * Masking: Not maskable. */
1307 #define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
1311 * For a packet with an 802.1Q header, this is the Tag Control Information
1312 * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
1313 * header, this has value 0.
1317 * Format: 16-bit integer in network byte order.
1319 * Masking: Arbitrary masks.
1321 * This field can be used in various ways:
1323 * - If it is not constrained at all, the nx_match matches packets without
1324 * an 802.1Q header or with an 802.1Q header that has any TCI value.
1326 * - Testing for an exact match with 0 matches only packets without an
1329 * - Testing for an exact match with a TCI value with CFI=1 matches packets
1330 * that have an 802.1Q header with a specified VID and PCP.
1332 * - Testing for an exact match with a nonzero TCI value with CFI=0 does
1333 * not make sense. The switch may reject this combination.
1335 * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
1336 * packets that have an 802.1Q header with that VID (and any PCP).
1338 * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
1339 * packets that have an 802.1Q header with that PCP (and any VID).
1341 * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
1342 * header or with an 802.1Q header with a VID of 0.
1344 * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
1345 * header or with an 802.1Q header with a PCP of 0.
1347 * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
1348 * header or with an 802.1Q header with both VID and PCP of 0.
1350 #define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
1351 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
1353 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
1355 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1357 * Format: 8-bit integer with 2 least-significant bits forced to 0.
1359 * Masking: Not maskable. */
1360 #define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
1362 /* The "protocol" byte in the IP header.
1364 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1366 * Format: 8-bit integer.
1368 * Masking: Not maskable. */
1369 #define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
1371 /* The source or destination address in the IP header.
1373 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
1375 * Format: 32-bit integer in network byte order.
1377 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1378 * high-order bits set to 1 and the other 32-N bits set to 0. */
1379 #define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
1380 #define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
1381 #define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
1382 #define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
1384 /* The source or destination port in the TCP header.
1387 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1388 * NXM_OF_IP_PROTO must match 6 exactly.
1390 * Format: 16-bit integer in network byte order.
1392 * Masking: Not maskable. */
1393 #define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
1394 #define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
1396 /* The source or destination port in the UDP header.
1399 * NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1400 * NXM_OF_IP_PROTO must match 17 exactly.
1402 * Format: 16-bit integer in network byte order.
1404 * Masking: Not maskable. */
1405 #define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
1406 #define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
1408 /* The type or code in the ICMP header.
1411 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
1412 * NXM_OF_IP_PROTO must match 1 exactly.
1414 * Format: 8-bit integer.
1416 * Masking: Not maskable. */
1417 #define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
1418 #define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
1422 * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
1423 * otherwise. Only ARP opcodes between 1 and 255 should be specified for
1426 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1428 * Format: 16-bit integer in network byte order.
1430 * Masking: Not maskable. */
1431 #define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
1433 /* For an Ethernet+IP ARP packet, the source or target protocol address
1434 * in the ARP header. Always 0 otherwise.
1436 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1438 * Format: 32-bit integer in network byte order.
1440 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1441 * high-order bits set to 1 and the other 32-N bits set to 0. */
1442 #define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
1443 #define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
1444 #define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
1445 #define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
1447 /* ## ------------------------ ## */
1448 /* ## Nicira match extensions. ## */
1449 /* ## ------------------------ ## */
1451 /* Metadata registers.
1453 * Registers initially have value 0. Actions allow register values to be
1458 * Format: Array of 32-bit integer registers. Space is reserved for up to
1459 * NXM_NX_MAX_REGS registers, but switches may implement fewer.
1461 * Masking: Arbitrary masks. */
1462 #define NXM_NX_MAX_REGS 16
1463 #define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
1464 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1465 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1466 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1467 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1468 #define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
1469 #define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
1470 #define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
1471 #define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
1472 #define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
1473 #define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
1474 #define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
1475 #define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
1476 #define NXM_NX_REG4 NXM_HEADER (0x0001, 4, 4)
1477 #define NXM_NX_REG4_W NXM_HEADER_W(0x0001, 4, 4)
1481 * For a packet received via GRE tunnel including a (32-bit) key, the key is
1482 * stored in the low 32-bits and the high bits are zeroed. For other packets,
1487 * Format: 64-bit integer in network byte order.
1489 * Masking: Arbitrary masks. */
1490 #define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
1491 #define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
1493 /* For an Ethernet+IP ARP packet, the source or target hardware address
1494 * in the ARP header. Always 0 otherwise.
1496 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1498 * Format: 48-bit Ethernet MAC address.
1500 * Masking: Not maskable. */
1501 #define NXM_NX_ARP_SHA NXM_HEADER (0x0001, 17, 6)
1502 #define NXM_NX_ARP_THA NXM_HEADER (0x0001, 18, 6)
1504 /* The source or destination address in the IPv6 header.
1506 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1508 * Format: 128-bit IPv6 address.
1510 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1511 * high-order bits set to 1 and the other 128-N bits set to 0. */
1512 #define NXM_NX_IPV6_SRC NXM_HEADER (0x0001, 19, 16)
1513 #define NXM_NX_IPV6_SRC_W NXM_HEADER_W(0x0001, 19, 16)
1514 #define NXM_NX_IPV6_DST NXM_HEADER (0x0001, 20, 16)
1515 #define NXM_NX_IPV6_DST_W NXM_HEADER_W(0x0001, 20, 16)
1517 /* The type or code in the ICMPv6 header.
1520 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1521 * NXM_OF_IP_PROTO must match 58 exactly.
1523 * Format: 8-bit integer.
1525 * Masking: Not maskable. */
1526 #define NXM_NX_ICMPV6_TYPE NXM_HEADER (0x0001, 21, 1)
1527 #define NXM_NX_ICMPV6_CODE NXM_HEADER (0x0001, 22, 1)
1529 /* The target address in an IPv6 Neighbor Discovery message.
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 either 135 or 136.
1536 * Format: 128-bit IPv6 address.
1538 * Masking: Not maskable. */
1539 #define NXM_NX_ND_TARGET NXM_HEADER (0x0001, 23, 16)
1541 /* The source 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 135.
1549 * Format: 48-bit Ethernet MAC address.
1551 * Masking: Not maskable. */
1552 #define NXM_NX_ND_SLL NXM_HEADER (0x0001, 24, 6)
1554 /* The target link-layer address option in an IPv6 Neighbor Discovery
1558 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1559 * NXM_OF_IP_PROTO must match 58 exactly.
1560 * NXM_OF_ICMPV6_TYPE must be exactly 136.
1562 * Format: 48-bit Ethernet MAC address.
1564 * Masking: Not maskable. */
1565 #define NXM_NX_ND_TLL NXM_HEADER (0x0001, 25, 6)
1567 /* IP fragment information.
1570 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1572 * Format: 8-bit value with one of the values 0, 1, or 3, as described below.
1574 * Masking: Fully maskable.
1576 * This field has three possible values:
1578 * - A packet that is not an IP fragment has value 0.
1580 * - A packet that is an IP fragment with offset 0 (the first fragment) has
1581 * bit 0 set and thus value 1.
1583 * - A packet that is an IP fragment with nonzero offset has bits 0 and 1 set
1586 * NX_IP_FRAG_ANY and NX_IP_FRAG_LATER are declared to symbolically represent
1587 * the meanings of bits 0 and 1.
1589 * The switch may reject matches against values that can never appear.
1591 * It is important to understand how this field interacts with the OpenFlow IP
1592 * fragment handling mode:
1594 * - In OFPC_FRAG_DROP mode, the OpenFlow switch drops all IP fragments
1595 * before they reach the flow table, so every packet that is available for
1596 * matching will have value 0 in this field.
1598 * - Open vSwitch does not implement OFPC_FRAG_REASM mode, but if it did then
1599 * IP fragments would be reassembled before they reached the flow table and
1600 * again every packet available for matching would always have value 0.
1602 * - In OFPC_FRAG_NORMAL mode, all three values are possible, but OpenFlow
1603 * 1.0 says that fragments' transport ports are always 0, even for the
1604 * first fragment, so this does not provide much extra information.
1606 * - In OFPC_FRAG_NX_MATCH mode, all three values are possible. For
1607 * fragments with offset 0, Open vSwitch makes L4 header information
1610 #define NXM_NX_IP_FRAG NXM_HEADER (0x0001, 26, 1)
1611 #define NXM_NX_IP_FRAG_W NXM_HEADER_W(0x0001, 26, 1)
1613 /* Bits in the value of NXM_NX_IP_FRAG. */
1614 #define NX_IP_FRAG_ANY (1 << 0) /* Is this a fragment? */
1615 #define NX_IP_FRAG_LATER (1 << 1) /* Is this a fragment with nonzero offset? */
1617 /* The flow label in the IPv6 header.
1619 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1621 * Format: 20-bit IPv6 flow label in least-significant bits.
1623 * Masking: Not maskable. */
1624 #define NXM_NX_IPV6_LABEL NXM_HEADER (0x0001, 27, 4)
1626 /* The ECN of the IP header.
1628 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1630 * Format: ECN in the low-order 2 bits.
1632 * Masking: Not maskable. */
1633 #define NXM_NX_IP_ECN NXM_HEADER (0x0001, 28, 1)
1635 /* The time-to-live/hop limit of the IP header.
1637 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1639 * Format: 8-bit integer.
1641 * Masking: Not maskable. */
1642 #define NXM_NX_IP_TTL NXM_HEADER (0x0001, 29, 1)
1644 /* ## --------------------- ## */
1645 /* ## Requests and replies. ## */
1646 /* ## --------------------- ## */
1648 enum nx_flow_format {
1649 NXFF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
1650 NXFF_NXM = 2 /* Nicira extended match. */
1653 /* NXT_SET_FLOW_FORMAT request. */
1654 struct nxt_set_flow_format {
1655 struct ofp_header header;
1656 ovs_be32 vendor; /* NX_VENDOR_ID. */
1657 ovs_be32 subtype; /* NXT_SET_FLOW_FORMAT. */
1658 ovs_be32 format; /* One of NXFF_*. */
1660 OFP_ASSERT(sizeof(struct nxt_set_flow_format) == 20);
1662 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */
1663 struct nx_flow_mod {
1664 struct nicira_header nxh;
1665 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1666 ovs_be16 command; /* One of OFPFC_*. */
1667 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
1668 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
1669 ovs_be16 priority; /* Priority level of flow entry. */
1670 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
1671 Not meaningful for OFPFC_DELETE*. */
1672 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
1673 matching entries to include this as an
1674 output port. A value of OFPP_NONE
1675 indicates no restriction. */
1676 ovs_be16 flags; /* One of OFPFF_*. */
1677 ovs_be16 match_len; /* Size of nx_match. */
1678 uint8_t pad[6]; /* Align to 64-bits. */
1680 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1681 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1682 * all-zero bytes, then
1683 * - Actions to fill out the remainder of the message length (always a
1687 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
1689 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1690 struct nx_flow_removed {
1691 struct nicira_header nxh;
1692 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1693 ovs_be16 priority; /* Priority level of flow entry. */
1694 uint8_t reason; /* One of OFPRR_*. */
1695 uint8_t pad[1]; /* Align to 32-bits. */
1696 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
1697 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
1699 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
1700 ovs_be16 match_len; /* Size of nx_match. */
1701 ovs_be64 packet_count;
1702 ovs_be64 byte_count;
1704 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1705 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1706 * all-zero bytes. */
1708 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
1710 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1712 struct nx_flow_stats_request {
1713 struct nicira_stats_msg nsm;
1714 ovs_be16 out_port; /* Require matching entries to include this
1715 as an output port. A value of OFPP_NONE
1716 indicates no restriction. */
1717 ovs_be16 match_len; /* Length of nx_match. */
1718 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1719 or 0xff for all tables. */
1720 uint8_t pad[3]; /* Align to 64 bits. */
1722 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1723 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1724 * all-zero bytes, which must also exactly fill out the length of the
1728 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
1730 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1731 * OFPST_FLOW reply). */
1732 struct nx_flow_stats {
1733 ovs_be16 length; /* Length of this entry. */
1734 uint8_t table_id; /* ID of table flow came from. */
1736 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
1737 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
1738 beyond duration_sec. */
1739 ovs_be16 priority; /* Priority of the entry. Only meaningful
1740 when this is not an exact-match entry. */
1741 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
1742 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
1743 ovs_be16 match_len; /* Length of nx_match. */
1744 uint8_t pad2[4]; /* Align to 64 bits. */
1745 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1746 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1747 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1749 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1750 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1751 * all-zero bytes, then
1752 * - Actions to fill out the remainder 'length' bytes (always a multiple
1756 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1758 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1759 * OFPST_AGGREGATE request). */
1760 struct nx_aggregate_stats_request {
1761 struct nicira_stats_msg nsm;
1762 ovs_be16 out_port; /* Require matching entries to include this
1763 as an output port. A value of OFPP_NONE
1764 indicates no restriction. */
1765 ovs_be16 match_len; /* Length of nx_match. */
1766 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1767 or 0xff for all tables. */
1768 uint8_t pad[3]; /* Align to 64 bits. */
1770 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1771 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1772 * all-zero bytes, which must also exactly fill out the length of the
1776 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1778 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1779 * OFPST_AGGREGATE reply). */
1780 struct nx_aggregate_stats_reply {
1781 struct nicira_stats_msg nsm;
1782 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1783 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1784 ovs_be32 flow_count; /* Number of flows. */
1785 uint8_t pad[4]; /* Align to 64 bits. */
1787 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1789 #endif /* openflow/nicira-ext.h */