2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #ifndef OPENFLOW_NICIRA_EXT_H
18 #define OPENFLOW_NICIRA_EXT_H 1
20 #include "openflow/openflow.h"
21 #include "openvswitch/types.h"
23 /* The following vendor extensions, proposed by Nicira Networks, are not yet
24 * standardized, so they are not included in openflow.h. Some of them may be
25 * suitable for standardization; others we never expect to standardize. */
27 #define NX_VENDOR_ID 0x00002320
29 /* Nicira vendor-specific error messages extension.
31 * OpenFlow 1.0 has a set of predefined error types (OFPET_*) and codes (which
32 * are specific to each type). It does not have any provision for
33 * vendor-specific error codes, and it does not even provide "generic" error
34 * codes that can apply to problems not anticipated by the OpenFlow
35 * specification authors.
37 * This extension attempts to address the problem by adding a generic "error
38 * vendor extension". The extension works as follows: use NXET_VENDOR as type
39 * and NXVC_VENDOR_ERROR as code, followed by struct nx_vendor_error with
40 * vendor-specific details, followed by at least 64 bytes of the failed
43 * It would be better to have a type-specific vendor extension, e.g. so that
44 * OFPET_BAD_ACTION could be used with vendor-specific code values. But
45 * OFPET_BAD_ACTION and most other standardized types already specify that
46 * their 'data' values are (the start of) the OpenFlow message being replied
47 * to, so there is no room to insert a vendor ID.
49 * Currently this extension is only implemented by Open vSwitch, but it seems
50 * like a reasonable candidate for future standardization.
53 /* This is a random number to avoid accidental collision with any other
54 * vendor's extension. */
55 #define NXET_VENDOR 0xb0c2
57 /* ofp_error msg 'code' values for NXET_VENDOR. */
59 NXVC_VENDOR_ERROR /* 'data' contains struct nx_vendor_error. */
62 /* 'data' for 'type' == NXET_VENDOR, 'code' == NXVC_VENDOR_ERROR. */
63 struct nx_vendor_error {
64 ovs_be32 vendor; /* Vendor ID as in struct ofp_vendor_header. */
65 ovs_be16 type; /* Vendor-defined type. */
66 ovs_be16 code; /* Vendor-defined subtype. */
67 /* Followed by at least the first 64 bytes of the failed request. */
70 /* Specific Nicira extension error numbers.
72 * These are the "code" values used in nx_vendor_error. So far, the "type"
73 * values in nx_vendor_error are the same as those in ofp_error_msg. That is,
74 * at Nicira so far we've only needed additional vendor-specific 'code' values,
75 * so we're using the existing 'type' values to avoid having to invent new ones
76 * that duplicate the current ones' meanings. */
78 /* Additional "code" values for OFPET_BAD_REQUEST. */
79 enum nx_bad_request_code {
80 /* Nicira Extended Match (NXM) errors. */
82 /* Generic error code used when there is an error in an NXM sent to the
83 * switch. The switch may use one of the more specific error codes below,
84 * if there is an appropriate one, to simplify debugging, but it is not
85 * required to do so. */
86 NXBRC_NXM_INVALID = 0x100,
88 /* The nxm_type, or nxm_type taken in combination with nxm_hasmask or
89 * nxm_length or both, is invalid or not implemented. */
90 NXBRC_NXM_BAD_TYPE = 0x101,
92 /* Invalid nxm_value. */
93 NXBRC_NXM_BAD_VALUE = 0x102,
95 /* Invalid nxm_mask. */
96 NXBRC_NXM_BAD_MASK = 0x103,
98 /* A prerequisite was not met. */
99 NXBRC_NXM_BAD_PREREQ = 0x104,
101 /* A given nxm_type was specified more than once. */
102 NXBRC_NXM_DUP_TYPE = 0x105
105 /* Additional "code" values for OFPET_FLOW_MOD_FAILED. */
106 enum nx_flow_mod_failed_code {
107 /* Generic hardware error. */
108 NXFMFC_HARDWARE = 0x100,
110 /* A nonexistent table ID was specified in the "command" field of struct
111 * ofp_flow_mod, when the nxt_flow_mod_table_id extension is enabled. */
112 NXFMFC_BAD_TABLE_ID = 0x101
115 /* Nicira vendor requests and replies. */
117 /* Header for Nicira vendor requests and replies. */
118 struct nicira_header {
119 struct ofp_header header;
120 ovs_be32 vendor; /* NX_VENDOR_ID. */
121 ovs_be32 subtype; /* One of NXT_* below. */
123 OFP_ASSERT(sizeof(struct nicira_header) == 16);
125 /* Values for the 'subtype' member of struct nicira_header. */
127 /* No longer used. */
128 NXT_STATUS_REQUEST__OBSOLETE = 0,
129 NXT_STATUS_REPLY__OBSOLETE = 1,
130 NXT_ACT_SET_CONFIG__OBSOLETE = 2,
131 NXT_ACT_GET_CONFIG__OBSOLETE = 3,
132 NXT_COMMAND_REQUEST__OBSOLETE = 4,
133 NXT_COMMAND_REPLY__OBSOLETE = 5,
134 NXT_FLOW_END_CONFIG__OBSOLETE = 6,
135 NXT_FLOW_END__OBSOLETE = 7,
136 NXT_MGMT__OBSOLETE = 8,
137 NXT_TUN_ID_FROM_COOKIE__OBSOLETE = 9,
139 /* Controller role support. The request body is struct nx_role_request.
140 * The reply echos the request. */
141 NXT_ROLE_REQUEST = 10,
144 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
145 NXT_SET_FLOW_FORMAT = 12, /* Set flow format. */
146 NXT_FLOW_MOD = 13, /* Analogous to OFPT_FLOW_MOD. */
147 NXT_FLOW_REMOVED = 14, /* Analogous to OFPT_FLOW_REMOVED. */
149 /* Use the upper 8 bits of the 'command' member in struct ofp_flow_mod to
150 * designate the table to which a flow is to be added? See the big comment
151 * on struct nxt_flow_mod_table_id for more information. */
152 NXT_FLOW_MOD_TABLE_ID = 15
155 /* Header for Nicira vendor stats request and reply messages. */
156 struct nicira_stats_msg {
157 struct ofp_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
158 ovs_be32 subtype; /* One of NXST_* below. */
159 uint8_t pad[4]; /* Align to 64-bits. */
161 OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
163 /* Values for the 'subtype' member of struct nicira_stats_msg. */
164 enum nicira_stats_type {
165 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
166 NXST_FLOW, /* Analogous to OFPST_FLOW. */
167 NXST_AGGREGATE /* Analogous to OFPST_AGGREGATE. */
170 /* Fields to use when hashing flows. */
171 enum nx_hash_fields {
172 /* Ethernet source address (NXM_OF_ETH_SRC) only. */
173 NX_HASH_FIELDS_ETH_SRC,
175 /* L2 through L4, symmetric across src/dst. Specifically, each of the
176 * following fields, if present, is hashed (slashes separate symmetric
179 * - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
181 * - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
183 * - NXM_OF_IP_SRC / NXM_OF_IP_DST
184 * - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
186 NX_HASH_FIELDS_SYMMETRIC_L4
189 /* This command enables or disables an Open vSwitch extension that allows a
190 * controller to specify the OpenFlow table to which a flow should be added,
191 * instead of having the switch decide which table is most appropriate as
192 * required by OpenFlow 1.0. By default, the extension is disabled.
194 * When this feature is enabled, Open vSwitch treats struct ofp_flow_mod's
195 * 16-bit 'command' member as two separate fields. The upper 8 bits are used
196 * as the table ID, the lower 8 bits specify the command as usual. A table ID
197 * of 0xff is treated like a wildcarded table ID.
199 * The specific treatment of the table ID depends on the type of flow mod:
201 * - OFPFC_ADD: Given a specific table ID, the flow is always placed in that
202 * table. If an identical flow already exists in that table only, then it
203 * is replaced. If the flow cannot be placed in the specified table,
204 * either because the table is full or because the table cannot support
205 * flows of the given type, the switch replies with an
206 * OFPFMFC_ALL_TABLES_FULL error. (A controller can distinguish these
207 * cases by comparing the current and maximum number of entries reported
208 * in ofp_table_stats.)
210 * If the table ID is wildcarded, the switch picks an appropriate table
211 * itself. If an identical flow already exist in the selected flow table,
212 * then it is replaced. The choice of table might depend on the flows
213 * that are already in the switch; for example, if one table fills up then
214 * the switch might fall back to another one.
216 * - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows
217 * within that table are matched and modified or deleted. If the table ID
218 * is wildcarded, flows within any table may be matched and modified or
221 * - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID,
222 * only a flow within that table may be matched and modified or deleted.
223 * If the table ID is wildcarded and exactly one flow within any table
224 * matches, then it is modified or deleted; if flows in more than one
225 * table match, then none is modified or deleted.
227 struct nxt_flow_mod_table_id {
228 struct ofp_header header;
229 uint32_t vendor; /* NX_VENDOR_ID. */
230 uint32_t subtype; /* NXT_FLOW_MOD_TABLE_ID. */
231 uint8_t set; /* Nonzero to enable, zero to disable. */
234 OFP_ASSERT(sizeof(struct nxt_flow_mod_table_id) == 24);
236 /* Configures the "role" of the sending controller. The default role is:
238 * - Other (NX_ROLE_OTHER), which allows the controller access to all
241 * The other possible roles are a related pair:
243 * - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
244 * be at most one Master controller at a time: when a controller
245 * configures itself as Master, any existing Master is demoted to the
248 * - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
249 * OpenFlow features. In particular attempts to modify the flow table
250 * will be rejected with an OFPBRC_EPERM error.
252 * Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
253 * messages, but they do receive OFPT_PORT_STATUS messages.
255 struct nx_role_request {
256 struct nicira_header nxh;
257 ovs_be32 role; /* One of NX_ROLE_*. */
261 NX_ROLE_OTHER, /* Default role, full access. */
262 NX_ROLE_MASTER, /* Full access, at most one. */
263 NX_ROLE_SLAVE /* Read-only access. */
266 /* Nicira vendor flow actions. */
268 enum nx_action_subtype {
269 NXAST_SNAT__OBSOLETE, /* No longer used. */
270 NXAST_RESUBMIT, /* struct nx_action_resubmit */
271 NXAST_SET_TUNNEL, /* struct nx_action_set_tunnel */
272 NXAST_DROP_SPOOFED_ARP__OBSOLETE,
273 NXAST_SET_QUEUE, /* struct nx_action_set_queue */
274 NXAST_POP_QUEUE, /* struct nx_action_pop_queue */
275 NXAST_REG_MOVE, /* struct nx_action_reg_move */
276 NXAST_REG_LOAD, /* struct nx_action_reg_load */
277 NXAST_NOTE, /* struct nx_action_note */
278 NXAST_SET_TUNNEL64, /* struct nx_action_set_tunnel64 */
279 NXAST_MULTIPATH, /* struct nx_action_multipath */
280 NXAST_AUTOPATH /* struct nx_action_autopath */
283 /* Header for Nicira-defined actions. */
284 struct nx_action_header {
285 ovs_be16 type; /* OFPAT_VENDOR. */
286 ovs_be16 len; /* Length is 16. */
287 ovs_be32 vendor; /* NX_VENDOR_ID. */
288 ovs_be16 subtype; /* NXAST_*. */
291 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
293 /* Action structure for NXAST_RESUBMIT.
295 * NXAST_RESUBMIT searches the flow table again, using a flow that is slightly
296 * modified from the original lookup:
298 * - The 'in_port' member of struct nx_action_resubmit is used as the flow's
301 * - If NXAST_RESUBMIT is preceded by actions that affect the flow
302 * (e.g. OFPAT_SET_VLAN_VID), then the flow is updated with the new
305 * Following the lookup, the original in_port is restored.
307 * If the modified flow matched in the flow table, then the corresponding
308 * actions are executed. Afterward, actions following NXAST_RESUBMIT in the
309 * original set of actions, if any, are executed; any changes made to the
310 * packet (e.g. changes to VLAN) by secondary actions persist when those
311 * actions are executed, although the original in_port is restored.
313 * NXAST_RESUBMIT may be used any number of times within a set of actions.
315 * NXAST_RESUBMIT may nest to an implementation-defined depth. Beyond this
316 * implementation-defined depth, further NXAST_RESUBMIT actions are simply
317 * ignored. (Open vSwitch 1.0.1 and earlier did not support recursion.)
319 struct nx_action_resubmit {
320 ovs_be16 type; /* OFPAT_VENDOR. */
321 ovs_be16 len; /* Length is 16. */
322 ovs_be32 vendor; /* NX_VENDOR_ID. */
323 ovs_be16 subtype; /* NXAST_RESUBMIT. */
324 ovs_be16 in_port; /* New in_port for checking flow table. */
327 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
329 /* Action structure for NXAST_SET_TUNNEL.
331 * Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32
332 * bits of the tunnel ID are set to 0. */
333 struct nx_action_set_tunnel {
334 ovs_be16 type; /* OFPAT_VENDOR. */
335 ovs_be16 len; /* Length is 16. */
336 ovs_be32 vendor; /* NX_VENDOR_ID. */
337 ovs_be16 subtype; /* NXAST_SET_TUNNEL. */
339 ovs_be32 tun_id; /* Tunnel ID. */
341 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
343 /* Action structure for NXAST_SET_TUNNEL64.
345 * Sets the encapsulating tunnel ID to a 64-bit value. */
346 struct nx_action_set_tunnel64 {
347 ovs_be16 type; /* OFPAT_VENDOR. */
348 ovs_be16 len; /* Length is 16. */
349 ovs_be32 vendor; /* NX_VENDOR_ID. */
350 ovs_be16 subtype; /* NXAST_SET_TUNNEL64. */
352 ovs_be64 tun_id; /* Tunnel ID. */
354 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
356 /* Action structure for NXAST_SET_QUEUE.
358 * Set the queue that should be used when packets are output. This is similar
359 * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
360 * an argument. This allows the queue to be defined before the port is
362 struct nx_action_set_queue {
363 ovs_be16 type; /* OFPAT_VENDOR. */
364 ovs_be16 len; /* Length is 16. */
365 ovs_be32 vendor; /* NX_VENDOR_ID. */
366 ovs_be16 subtype; /* NXAST_SET_QUEUE. */
368 ovs_be32 queue_id; /* Where to enqueue packets. */
370 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
372 /* Action structure for NXAST_POP_QUEUE.
374 * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
375 * were used. Only the original queue can be restored this way; no stack is
377 struct nx_action_pop_queue {
378 ovs_be16 type; /* OFPAT_VENDOR. */
379 ovs_be16 len; /* Length is 16. */
380 ovs_be32 vendor; /* NX_VENDOR_ID. */
381 ovs_be16 subtype; /* NXAST_POP_QUEUE. */
384 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
386 /* Action structure for NXAST_REG_MOVE.
388 * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
389 * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
390 * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
391 * the next most significant bit, and so on.
393 * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
394 * sense to use nxm_hasmask=1 because the action does not do any kind of
395 * matching; it uses the actual value of a field.)
397 * The following nxm_header values are potentially acceptable as 'src':
420 * - NXM_NX_ICMPV6_TYPE
421 * - NXM_NX_ICMPV6_CODE
424 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
426 * The following nxm_header values are potentially acceptable as 'dst':
428 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
430 * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
431 * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
432 * header (if any), ignoring the other bits. Setting a value with CFI=1
433 * adds or modifies the 802.1Q header appropriately, setting the TCI field
434 * to the field's new value (with the CFI bit masked out).
436 * - NXM_NX_TUN_ID. Modifying this value modifies the tunnel ID used for the
437 * packet's next tunnel encapsulation.
439 * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
440 * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
441 * used only if the flow's nx_match includes an nxm_entry that specifies
442 * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
444 * The switch will reject actions for which src_ofs+n_bits is greater than the
445 * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
446 * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
448 struct nx_action_reg_move {
449 ovs_be16 type; /* OFPAT_VENDOR. */
450 ovs_be16 len; /* Length is 16. */
451 ovs_be32 vendor; /* NX_VENDOR_ID. */
452 ovs_be16 subtype; /* NXAST_REG_MOVE. */
453 ovs_be16 n_bits; /* Number of bits. */
454 ovs_be16 src_ofs; /* Starting bit offset in source. */
455 ovs_be16 dst_ofs; /* Starting bit offset in destination. */
456 ovs_be32 src; /* Source register. */
457 ovs_be32 dst; /* Destination register. */
459 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
461 /* Action structure for NXAST_REG_LOAD.
463 * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
464 * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
465 * starts at 0 for the least-significant bit, 1 for the next most significant
468 * 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for
469 * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
472 * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
473 * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
474 * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
475 * also stored as one less than its true value:
478 * +------------------------------+------------------+
479 * | ofs | n_bits - 1 |
480 * +------------------------------+------------------+
482 * The switch will reject actions for which ofs+n_bits is greater than the
483 * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
484 * greater are set to 1, with error type OFPET_BAD_ACTION, code
485 * OFPBAC_BAD_ARGUMENT.
487 struct nx_action_reg_load {
488 ovs_be16 type; /* OFPAT_VENDOR. */
489 ovs_be16 len; /* Length is 16. */
490 ovs_be32 vendor; /* NX_VENDOR_ID. */
491 ovs_be16 subtype; /* NXAST_REG_LOAD. */
492 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
493 ovs_be32 dst; /* Destination register. */
494 ovs_be64 value; /* Immediate value. */
496 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
498 /* Action structure for NXAST_NOTE.
500 * This action has no effect. It is variable length. The switch does not
501 * attempt to interpret the user-defined 'note' data in any way. A controller
502 * can use this action to attach arbitrary metadata to a flow.
504 * This action might go away in the future.
506 struct nx_action_note {
507 ovs_be16 type; /* OFPAT_VENDOR. */
508 ovs_be16 len; /* A multiple of 8, but at least 16. */
509 ovs_be32 vendor; /* NX_VENDOR_ID. */
510 ovs_be16 subtype; /* NXAST_NOTE. */
511 uint8_t note[6]; /* Start of user-defined data. */
512 /* Possibly followed by additional user-defined data. */
514 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
516 /* Action structure for NXAST_MULTIPATH.
518 * This action performs the following steps in sequence:
520 * 1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
521 * Refer to the definition of "enum nx_mp_fields" for details.
523 * The 'basis' value is used as a universal hash parameter, that is,
524 * different values of 'basis' yield different hash functions. The
525 * particular universal hash function used is implementation-defined.
527 * The hashed fields' values are drawn from the current state of the
528 * flow, including all modifications that have been made by actions up to
531 * 2. Applies the multipath link choice algorithm specified by 'algorithm',
532 * one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm"
535 * The output of the algorithm is 'link', an unsigned integer less than
536 * or equal to 'max_link'.
538 * Some algorithms use 'arg' as an additional argument.
540 * 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of
541 * 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
542 * action, except that 'dst' must be NXM_NX_REG(idx) for 'idx' in the
543 * switch's supported range.
545 * The switch will reject actions that have an unknown 'fields', or an unknown
546 * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
547 * in which 'max_link' is greater than or equal to 2**n_bits, with error type
548 * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
550 struct nx_action_multipath {
551 ovs_be16 type; /* OFPAT_VENDOR. */
552 ovs_be16 len; /* Length is 32. */
553 ovs_be32 vendor; /* NX_VENDOR_ID. */
554 ovs_be16 subtype; /* NXAST_MULTIPATH. */
556 /* What fields to hash and how. */
557 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
558 ovs_be16 basis; /* Universal hash parameter. */
561 /* Multipath link choice algorithm to apply to hash value. */
562 ovs_be16 algorithm; /* One of NX_MP_ALG_*. */
563 ovs_be16 max_link; /* Number of output links, minus 1. */
564 ovs_be32 arg; /* Algorithm-specific argument. */
567 /* Where to store the result. */
568 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
569 ovs_be32 dst; /* Destination register. */
571 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
573 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
575 * In the descriptions below, 'n_links' is max_link + 1. */
576 enum nx_mp_algorithm {
577 /* link = hash(flow) % n_links.
579 * Redistributes all traffic when n_links changes. O(1) performance. See
582 * Use UINT16_MAX for max_link to get a raw hash value. */
585 /* link = hash(flow) / (MAX_HASH / n_links).
587 * Redistributes between one-quarter and one-half of traffic when n_links
588 * changes. O(1) performance. See RFC 2992.
590 NX_MP_ALG_HASH_THRESHOLD,
592 /* for i in [0,n_links):
593 * weights[i] = hash(flow, i)
594 * link = { i such that weights[i] >= weights[j] for all j != i }
596 * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
597 * performance. If n_links is greater than a threshold (currently 64, but
598 * subject to change), Open vSwitch will substitute another algorithm
599 * automatically. See RFC 2992. */
600 NX_MP_ALG_HRW, /* Highest Random Weight. */
605 * link = hash(flow, i) % arg
606 * while link > max_link
608 * Redistributes 1/n_links of traffic when n_links changes. O(1)
609 * performance when arg/max_link is bounded by a constant.
611 * Redistributes all traffic when arg changes.
613 * arg must be greater than max_link and for best performance should be no
614 * more than approximately max_link * 2. If arg is outside the acceptable
615 * range, Open vSwitch will automatically substitute the least power of 2
616 * greater than max_link.
618 * This algorithm is specific to Open vSwitch.
620 NX_MP_ALG_ITER_HASH /* Iterative Hash. */
623 /* Action structure for NXAST_AUTOPATH.
625 * This action performs the following steps in sequence:
627 * 1. Hashes the flow using an implementation-defined hash function.
629 * The hashed fields' values are drawn from the current state of the
630 * flow, including all modifications that have been made by actions up to
633 * 2. Selects an OpenFlow 'port'.
635 * 'port' is selected in an implementation-defined manner, taking into
636 * account 'id' and the hash value calculated in step 1.
638 * Generally a switch will have been configured with a set of ports that
639 * may be chosen given 'id'. The switch may take into account any number
640 * of factors when choosing 'port' from its configured set. Factors may
641 * include carrier, load, and the results of configuration protocols such
644 * 3. Stores 'port' in dst[ofs:ofs+n_bits].
646 * The format and semantics of 'dst' and 'ofs_nbits' are similar to those
647 * for the NXAST_REG_LOAD action, except that 'dst' must be
648 * NXM_NX_REG(idx) for 'idx' in the switch's supported range.
650 * The switch will reject actions in which ofs+n_bits is greater than the width
651 * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
653 struct nx_action_autopath {
654 ovs_be16 type; /* OFPAT_VENDOR. */
655 ovs_be16 len; /* Length is 20. */
656 ovs_be32 vendor; /* NX_VENDOR_ID. */
657 ovs_be16 subtype; /* NXAST_AUTOPATH. */
659 /* Where to store the result. */
660 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
661 ovs_be32 dst; /* Destination register. */
663 ovs_be32 id; /* Autopath ID. */
666 OFP_ASSERT(sizeof(struct nx_action_autopath) == 24);
668 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
670 * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches. This
671 * structure is fixed-length and hence difficult to extend. This section
672 * describes a more flexible, variable-length flow match, called "nx_match" for
673 * short, that is also supported by Open vSwitch. This section also defines a
674 * replacement for each OpenFlow message that includes struct ofp_match.
680 * An nx_match is a sequence of zero or more "nxm_entry"s, which are
681 * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
682 * "nxm_entry"s are not aligned on or padded to any multibyte boundary. The
683 * first 4 bytes of an nxm_entry are its "header", followed by the entry's
686 * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
688 * |<-------------------- nxm_type ------------------>|
691 * +----------------------------------+---------------+--+------------------+
692 * | nxm_vendor | nxm_field |hm| nxm_length |
693 * +----------------------------------+---------------+--+------------------+
695 * The most-significant 23 bits of the header are collectively "nxm_type".
696 * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
697 * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
698 * designates a protocol header, such as the Ethernet type, but it can also
699 * refer to packet metadata, such as the switch port on which a packet arrived.
701 * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
702 * of this bit is explained later.
704 * The least-significant 8 bits are "nxm_length", a positive integer. The
705 * length of the nxm_entry, including the header, is exactly 4 + nxm_length
708 * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
709 * constant. It is included only to allow software to minimally parse
710 * "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor,
711 * nxm_field, and nxm_length, nxm_hasmask is a constant.)
717 * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
719 * An nxm_entry places a constraint on the packets matched by the nx_match:
721 * - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
722 * field, called "nxm_value". The nx_match matches only packets in which
723 * the field equals nxm_value.
725 * - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
726 * field (nxm_value), followed by a bitmask of the same length as the
727 * value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
728 * nx_match matches only packets for which bit J in the given field's value
729 * matches bit J in nxm_value. A 0-bit in nxm_mask causes the
730 * corresponding bits in nxm_value and the field's value to be ignored.
731 * (The sense of the nxm_mask bits is the opposite of that used by the
732 * "wildcards" member of struct ofp_match.)
734 * When nxm_hasmask is 1, nxm_length is always even.
736 * An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
737 * entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for
740 * When there are multiple "nxm_entry"s, all of the constraints must be met.
746 * Masks may be restricted:
748 * - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
749 * must always be 0 when these fields are specified. For example, the
750 * field that identifies the port on which a packet was received may not be
753 * - Some nxm_types that do support masked wildcards may only support certain
754 * nxm_mask patterns. For example, fields that have IPv4 address values
755 * may be restricted to CIDR masks.
757 * These restrictions should be noted in specifications for individual fields.
758 * A switch may accept an nxm_hasmask or nxm_mask value that the specification
759 * disallows, if the switch correctly implements support for that nxm_hasmask
760 * or nxm_mask value. A switch must reject an attempt to set up a flow that
761 * contains a nxm_hasmask or nxm_mask value that it does not support.
764 * Prerequisite Restrictions
765 * =========================
767 * The presence of an nxm_entry with a given nxm_type may be restricted based
768 * on the presence of or values of other "nxm_entry"s. For example:
770 * - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
771 * preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
772 * and nxm_value=0x0800. That is, matching on the IP source address is
773 * allowed only if the Ethernet type is explicitly set to IP.
775 * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is preced
776 * by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
777 * nxm_value=0x0800 and another with nxm_type=NXM_OF_IP_PROTO,
778 * nxm_hasmask=0, nxm_value=6, in that order. That is, matching on the TCP
779 * source port is allowed only if the Ethernet type is IP and the IP
782 * These restrictions should be noted in specifications for individual fields.
783 * A switch may implement relaxed versions of these restrictions. A switch
784 * must reject an attempt to set up a flow that violates its restrictions.
787 * Ordering Restrictions
788 * =====================
790 * An nxm_entry that has prerequisite restrictions must appear after the
791 * "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an
792 * nx_match is not otherwise constrained.
794 * Any given nxm_type may appear in an nx_match at most once.
800 * These examples show the format of a single nxm_entry with particular
801 * nxm_hasmask and nxm_length values. The diagrams are labeled with field
802 * numbers and byte indexes.
805 * 8-bit nxm_value, nxm_hasmask=1, nxm_length=1:
808 * +------------+---+---+
810 * +------------+---+---+
813 * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
816 * +------------+------+
818 * +------------+------+
821 * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
824 * +------------+-------------+
825 * | header | nxm_value |
826 * +------------+-------------+
829 * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
832 * +------------+------------------+
833 * | header | nxm_value |
834 * +------------+------------------+
837 * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
840 * +------------+------------------+------------------+
841 * | header | nxm_value | nxm_mask |
842 * +------------+------------------+------------------+
848 * A switch should report an error in an nx_match using error type
849 * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch
850 * should report a specific error code, if one is assigned for the particular
851 * problem, but NXBRC_NXM_INVALID is also available to report a generic
855 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
856 (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
857 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
858 NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
859 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
860 NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
861 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
862 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
863 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
864 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
865 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
867 #define NXM_MAKE_WILD_HEADER(HEADER) \
868 NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
870 /* ## ------------------------------- ## */
871 /* ## OpenFlow 1.0-compatible fields. ## */
872 /* ## ------------------------------- ## */
874 /* Physical or virtual port on which the packet was received.
878 * Format: 16-bit integer in network byte order.
880 * Masking: Not maskable. */
881 #define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
883 /* Source or destination address in Ethernet header.
887 * Format: 48-bit Ethernet MAC address.
889 * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
890 * be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
891 * are all-0-bits or all-1-bits). Support for other patterns and for masking
892 * of NXM_OF_ETH_SRC is optional. */
893 #define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
894 #define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
895 #define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
897 /* Packet's Ethernet type.
899 * For an Ethernet II packet this is taken from the Ethernet header. For an
900 * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
901 * A packet that has neither format has value 0x05ff
902 * (OFP_DL_TYPE_NOT_ETH_TYPE).
904 * For a packet with an 802.1Q header, this is the type of the encapsulated
909 * Format: 16-bit integer in network byte order.
911 * Masking: Not maskable. */
912 #define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
916 * For a packet with an 802.1Q header, this is the Tag Control Information
917 * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
918 * header, this has value 0.
922 * Format: 16-bit integer in network byte order.
924 * Masking: Arbitrary masks.
926 * This field can be used in various ways:
928 * - If it is not constrained at all, the nx_match matches packets without
929 * an 802.1Q header or with an 802.1Q header that has any TCI value.
931 * - Testing for an exact match with 0 matches only packets without an
934 * - Testing for an exact match with a TCI value with CFI=1 matches packets
935 * that have an 802.1Q header with a specified VID and PCP.
937 * - Testing for an exact match with a nonzero TCI value with CFI=0 does
938 * not make sense. The switch may reject this combination.
940 * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
941 * packets that have an 802.1Q header with that VID (and any PCP).
943 * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
944 * packets that have an 802.1Q header with that PCP (and any VID).
946 * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
947 * header or with an 802.1Q header with a VID of 0.
949 * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
950 * header or with an 802.1Q header with a PCP of 0.
952 * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
953 * header or with an 802.1Q header with both VID and PCP of 0.
955 #define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
956 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
958 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
960 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
962 * Format: 8-bit integer with 2 least-significant bits forced to 0.
964 * Masking: Not maskable. */
965 #define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
967 /* The "protocol" byte in the IP header.
969 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
971 * Format: 8-bit integer.
973 * Masking: Not maskable. */
974 #define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
976 /* The source or destination address in the IP header.
978 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
980 * Format: 32-bit integer in network byte order.
982 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
983 * high-order bits set to 1 and the other 32-N bits set to 0. */
984 #define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
985 #define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
986 #define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
987 #define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
989 /* The source or destination port in the TCP header.
992 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
993 * NXM_OF_IP_PROTO must match 6 exactly.
995 * Format: 16-bit integer in network byte order.
997 * Masking: Not maskable. */
998 #define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
999 #define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
1001 /* The source or destination port in the UDP header.
1004 * NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1005 * NXM_OF_IP_PROTO must match 17 exactly.
1007 * Format: 16-bit integer in network byte order.
1009 * Masking: Not maskable. */
1010 #define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
1011 #define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
1013 /* The type or code in the ICMP header.
1016 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
1017 * NXM_OF_IP_PROTO must match 1 exactly.
1019 * Format: 8-bit integer.
1021 * Masking: Not maskable. */
1022 #define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
1023 #define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
1027 * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
1028 * otherwise. Only ARP opcodes between 1 and 255 should be specified for
1031 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1033 * Format: 16-bit integer in network byte order.
1035 * Masking: Not maskable. */
1036 #define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
1038 /* For an Ethernet+IP ARP packet, the source or target protocol address
1039 * in the ARP header. Always 0 otherwise.
1041 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1043 * Format: 32-bit integer in network byte order.
1045 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1046 * high-order bits set to 1 and the other 32-N bits set to 0. */
1047 #define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
1048 #define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
1049 #define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
1050 #define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
1052 /* ## ------------------------ ## */
1053 /* ## Nicira match extensions. ## */
1054 /* ## ------------------------ ## */
1056 /* Metadata registers.
1058 * Registers initially have value 0. Actions allow register values to be
1063 * Format: Array of 32-bit integer registers. Space is reserved for up to
1064 * NXM_NX_MAX_REGS registers, but switches may implement fewer.
1066 * Masking: Arbitrary masks. */
1067 #define NXM_NX_MAX_REGS 16
1068 #define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
1069 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1070 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1071 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1072 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1073 #define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
1074 #define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
1075 #define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
1076 #define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
1077 #define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
1078 #define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
1079 #define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
1080 #define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
1084 * For a packet received via GRE tunnel including a (32-bit) key, the key is
1085 * stored in the low 32-bits and the high bits are zeroed. For other packets,
1090 * Format: 64-bit integer in network byte order.
1092 * Masking: Arbitrary masks. */
1093 #define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
1094 #define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
1096 /* For an Ethernet+IP ARP packet, the source or target hardware address
1097 * in the ARP header. Always 0 otherwise.
1099 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1101 * Format: 48-bit Ethernet MAC address.
1103 * Masking: Not maskable. */
1104 #define NXM_NX_ARP_SHA NXM_HEADER (0x0001, 17, 6)
1105 #define NXM_NX_ARP_THA NXM_HEADER (0x0001, 18, 6)
1107 /* The source or destination address in the IPv6 header.
1109 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1111 * Format: 128-bit IPv6 address.
1113 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1114 * high-order bits set to 1 and the other 128-N bits set to 0. */
1115 #define NXM_NX_IPV6_SRC NXM_HEADER (0x0001, 19, 16)
1116 #define NXM_NX_IPV6_SRC_W NXM_HEADER_W(0x0001, 19, 16)
1117 #define NXM_NX_IPV6_DST NXM_HEADER (0x0001, 20, 16)
1118 #define NXM_NX_IPV6_DST_W NXM_HEADER_W(0x0001, 20, 16)
1120 /* The type or code in the ICMPv6 header.
1123 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1124 * NXM_OF_IP_PROTO must match 58 exactly.
1126 * Format: 8-bit integer.
1128 * Masking: Not maskable. */
1129 #define NXM_NX_ICMPV6_TYPE NXM_HEADER (0x0001, 21, 1)
1130 #define NXM_NX_ICMPV6_CODE NXM_HEADER (0x0001, 22, 1)
1132 /* The target address in an IPv6 Neighbor Discovery message.
1135 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1136 * NXM_OF_IP_PROTO must match 58 exactly.
1137 * NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1139 * Format: 128-bit IPv6 address.
1141 * Masking: Not maskable. */
1142 #define NXM_NX_ND_TARGET NXM_HEADER (0x0001, 23, 16)
1144 /* The source link-layer address option in an IPv6 Neighbor Discovery
1148 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1149 * NXM_OF_IP_PROTO must match 58 exactly.
1150 * NXM_OF_ICMPV6_TYPE must be exactly 135.
1152 * Format: 48-bit Ethernet MAC address.
1154 * Masking: Not maskable. */
1155 #define NXM_NX_ND_SLL NXM_HEADER (0x0001, 24, 6)
1157 /* The target link-layer address option in an IPv6 Neighbor Discovery
1161 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1162 * NXM_OF_IP_PROTO must match 58 exactly.
1163 * NXM_OF_ICMPV6_TYPE must be exactly 136.
1165 * Format: 48-bit Ethernet MAC address.
1167 * Masking: Not maskable. */
1168 #define NXM_NX_ND_TLL NXM_HEADER (0x0001, 25, 6)
1171 /* ## --------------------- ## */
1172 /* ## Requests and replies. ## */
1173 /* ## --------------------- ## */
1175 enum nx_flow_format {
1176 NXFF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
1177 NXFF_NXM = 2 /* Nicira extended match. */
1180 /* NXT_SET_FLOW_FORMAT request. */
1181 struct nxt_set_flow_format {
1182 struct ofp_header header;
1183 ovs_be32 vendor; /* NX_VENDOR_ID. */
1184 ovs_be32 subtype; /* NXT_SET_FLOW_FORMAT. */
1185 ovs_be32 format; /* One of NXFF_*. */
1187 OFP_ASSERT(sizeof(struct nxt_set_flow_format) == 20);
1189 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */
1190 struct nx_flow_mod {
1191 struct nicira_header nxh;
1192 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1193 ovs_be16 command; /* One of OFPFC_*. */
1194 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
1195 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
1196 ovs_be16 priority; /* Priority level of flow entry. */
1197 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
1198 Not meaningful for OFPFC_DELETE*. */
1199 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
1200 matching entries to include this as an
1201 output port. A value of OFPP_NONE
1202 indicates no restriction. */
1203 ovs_be16 flags; /* One of OFPFF_*. */
1204 ovs_be16 match_len; /* Size of nx_match. */
1205 uint8_t pad[6]; /* Align to 64-bits. */
1207 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1208 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1209 * all-zero bytes, then
1210 * - Actions to fill out the remainder of the message length (always a
1214 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
1216 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1217 struct nx_flow_removed {
1218 struct nicira_header nxh;
1219 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1220 ovs_be16 priority; /* Priority level of flow entry. */
1221 uint8_t reason; /* One of OFPRR_*. */
1222 uint8_t pad[1]; /* Align to 32-bits. */
1223 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
1224 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
1226 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
1227 ovs_be16 match_len; /* Size of nx_match. */
1228 ovs_be64 packet_count;
1229 ovs_be64 byte_count;
1231 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1232 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1233 * all-zero bytes. */
1235 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
1237 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1239 struct nx_flow_stats_request {
1240 struct nicira_stats_msg nsm;
1241 ovs_be16 out_port; /* Require matching entries to include this
1242 as an output port. A value of OFPP_NONE
1243 indicates no restriction. */
1244 ovs_be16 match_len; /* Length of nx_match. */
1245 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1246 or 0xff for all tables. */
1247 uint8_t pad[3]; /* Align to 64 bits. */
1249 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1250 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1251 * all-zero bytes, which must also exactly fill out the length of the
1255 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
1257 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1258 * OFPST_FLOW reply). */
1259 struct nx_flow_stats {
1260 ovs_be16 length; /* Length of this entry. */
1261 uint8_t table_id; /* ID of table flow came from. */
1263 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
1264 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
1265 beyond duration_sec. */
1266 ovs_be16 priority; /* Priority of the entry. Only meaningful
1267 when this is not an exact-match entry. */
1268 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
1269 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
1270 ovs_be16 match_len; /* Length of nx_match. */
1271 uint8_t pad2[4]; /* Align to 64 bits. */
1272 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1273 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1274 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1276 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1277 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1278 * all-zero bytes, then
1279 * - Actions to fill out the remainder 'length' bytes (always a multiple
1283 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1285 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1286 * OFPST_AGGREGATE request). */
1287 struct nx_aggregate_stats_request {
1288 struct nicira_stats_msg nsm;
1289 ovs_be16 out_port; /* Require matching entries to include this
1290 as an output port. A value of OFPP_NONE
1291 indicates no restriction. */
1292 ovs_be16 match_len; /* Length of nx_match. */
1293 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1294 or 0xff for all tables. */
1295 uint8_t pad[3]; /* Align to 64 bits. */
1297 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1298 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1299 * all-zero bytes, which must also exactly fill out the length of the
1303 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1305 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1306 * OFPST_AGGREGATE reply). */
1307 struct nx_aggregate_stats_reply {
1308 struct nicira_stats_msg nsm;
1309 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1310 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1311 ovs_be32 flow_count; /* Number of flows. */
1312 uint8_t pad[4]; /* Align to 64 bits. */
1314 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1316 #endif /* openflow/nicira-ext.h */