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 /* This command enables or disables an Open vSwitch extension that allows a
171 * controller to specify the OpenFlow table to which a flow should be added,
172 * instead of having the switch decide which table is most appropriate as
173 * required by OpenFlow 1.0. By default, the extension is disabled.
175 * When this feature is enabled, Open vSwitch treats struct ofp_flow_mod's
176 * 16-bit 'command' member as two separate fields. The upper 8 bits are used
177 * as the table ID, the lower 8 bits specify the command as usual. A table ID
178 * of 0xff is treated like a wildcarded table ID.
180 * The specific treatment of the table ID depends on the type of flow mod:
182 * - OFPFC_ADD: Given a specific table ID, the flow is always placed in that
183 * table. If an identical flow already exists in that table only, then it
184 * is replaced. If the flow cannot be placed in the specified table,
185 * either because the table is full or because the table cannot support
186 * flows of the given type, the switch replies with an
187 * OFPFMFC_ALL_TABLES_FULL error. (A controller can distinguish these
188 * cases by comparing the current and maximum number of entries reported
189 * in ofp_table_stats.)
191 * If the table ID is wildcarded, the switch picks an appropriate table
192 * itself. If an identical flow already exist in the selected flow table,
193 * then it is replaced. The choice of table might depend on the flows
194 * that are already in the switch; for example, if one table fills up then
195 * the switch might fall back to another one.
197 * - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows
198 * within that table are matched and modified or deleted. If the table ID
199 * is wildcarded, flows within any table may be matched and modified or
202 * - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID,
203 * only a flow within that table may be matched and modified or deleted.
204 * If the table ID is wildcarded and exactly one flow within any table
205 * matches, then it is modified or deleted; if flows in more than one
206 * table match, then none is modified or deleted.
208 struct nxt_flow_mod_table_id {
209 struct ofp_header header;
210 uint32_t vendor; /* NX_VENDOR_ID. */
211 uint32_t subtype; /* NXT_FLOW_MOD_TABLE_ID. */
212 uint8_t set; /* Nonzero to enable, zero to disable. */
215 OFP_ASSERT(sizeof(struct nxt_flow_mod_table_id) == 24);
217 /* Configures the "role" of the sending controller. The default role is:
219 * - Other (NX_ROLE_OTHER), which allows the controller access to all
222 * The other possible roles are a related pair:
224 * - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
225 * be at most one Master controller at a time: when a controller
226 * configures itself as Master, any existing Master is demoted to the
229 * - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
230 * OpenFlow features. In particular attempts to modify the flow table
231 * will be rejected with an OFPBRC_EPERM error.
233 * Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
234 * messages, but they do receive OFPT_PORT_STATUS messages.
236 struct nx_role_request {
237 struct nicira_header nxh;
238 ovs_be32 role; /* One of NX_ROLE_*. */
242 NX_ROLE_OTHER, /* Default role, full access. */
243 NX_ROLE_MASTER, /* Full access, at most one. */
244 NX_ROLE_SLAVE /* Read-only access. */
247 /* Nicira vendor flow actions. */
249 enum nx_action_subtype {
250 NXAST_SNAT__OBSOLETE, /* No longer used. */
251 NXAST_RESUBMIT, /* struct nx_action_resubmit */
252 NXAST_SET_TUNNEL, /* struct nx_action_set_tunnel */
253 NXAST_DROP_SPOOFED_ARP__OBSOLETE,
254 NXAST_SET_QUEUE, /* struct nx_action_set_queue */
255 NXAST_POP_QUEUE, /* struct nx_action_pop_queue */
256 NXAST_REG_MOVE, /* struct nx_action_reg_move */
257 NXAST_REG_LOAD, /* struct nx_action_reg_load */
258 NXAST_NOTE, /* struct nx_action_note */
259 NXAST_SET_TUNNEL64, /* struct nx_action_set_tunnel64 */
260 NXAST_MULTIPATH, /* struct nx_action_multipath */
261 NXAST_AUTOPATH /* struct nx_action_autopath */
264 /* Header for Nicira-defined actions. */
265 struct nx_action_header {
266 ovs_be16 type; /* OFPAT_VENDOR. */
267 ovs_be16 len; /* Length is 16. */
268 ovs_be32 vendor; /* NX_VENDOR_ID. */
269 ovs_be16 subtype; /* NXAST_*. */
272 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
274 /* Action structure for NXAST_RESUBMIT.
276 * NXAST_RESUBMIT searches the flow table again, using a flow that is slightly
277 * modified from the original lookup:
279 * - The 'in_port' member of struct nx_action_resubmit is used as the flow's
282 * - If NXAST_RESUBMIT is preceded by actions that affect the flow
283 * (e.g. OFPAT_SET_VLAN_VID), then the flow is updated with the new
286 * Following the lookup, the original in_port is restored.
288 * If the modified flow matched in the flow table, then the corresponding
289 * actions are executed. Afterward, actions following NXAST_RESUBMIT in the
290 * original set of actions, if any, are executed; any changes made to the
291 * packet (e.g. changes to VLAN) by secondary actions persist when those
292 * actions are executed, although the original in_port is restored.
294 * NXAST_RESUBMIT may be used any number of times within a set of actions.
296 * NXAST_RESUBMIT may nest to an implementation-defined depth. Beyond this
297 * implementation-defined depth, further NXAST_RESUBMIT actions are simply
298 * ignored. (Open vSwitch 1.0.1 and earlier did not support recursion.)
300 struct nx_action_resubmit {
301 ovs_be16 type; /* OFPAT_VENDOR. */
302 ovs_be16 len; /* Length is 16. */
303 ovs_be32 vendor; /* NX_VENDOR_ID. */
304 ovs_be16 subtype; /* NXAST_RESUBMIT. */
305 ovs_be16 in_port; /* New in_port for checking flow table. */
308 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
310 /* Action structure for NXAST_SET_TUNNEL.
312 * Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32
313 * bits of the tunnel ID are set to 0. */
314 struct nx_action_set_tunnel {
315 ovs_be16 type; /* OFPAT_VENDOR. */
316 ovs_be16 len; /* Length is 16. */
317 ovs_be32 vendor; /* NX_VENDOR_ID. */
318 ovs_be16 subtype; /* NXAST_SET_TUNNEL. */
320 ovs_be32 tun_id; /* Tunnel ID. */
322 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
324 /* Action structure for NXAST_SET_TUNNEL64.
326 * Sets the encapsulating tunnel ID to a 64-bit value. */
327 struct nx_action_set_tunnel64 {
328 ovs_be16 type; /* OFPAT_VENDOR. */
329 ovs_be16 len; /* Length is 16. */
330 ovs_be32 vendor; /* NX_VENDOR_ID. */
331 ovs_be16 subtype; /* NXAST_SET_TUNNEL64. */
333 ovs_be64 tun_id; /* Tunnel ID. */
335 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
337 /* Action structure for NXAST_SET_QUEUE.
339 * Set the queue that should be used when packets are output. This is similar
340 * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
341 * an argument. This allows the queue to be defined before the port is
343 struct nx_action_set_queue {
344 ovs_be16 type; /* OFPAT_VENDOR. */
345 ovs_be16 len; /* Length is 16. */
346 ovs_be32 vendor; /* NX_VENDOR_ID. */
347 ovs_be16 subtype; /* NXAST_SET_QUEUE. */
349 ovs_be32 queue_id; /* Where to enqueue packets. */
351 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
353 /* Action structure for NXAST_POP_QUEUE.
355 * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
356 * were used. Only the original queue can be restored this way; no stack is
358 struct nx_action_pop_queue {
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_POP_QUEUE. */
365 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
367 /* Action structure for NXAST_REG_MOVE.
369 * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
370 * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
371 * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
372 * the next most significant bit, and so on.
374 * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
375 * sense to use nxm_hasmask=1 because the action does not do any kind of
376 * matching; it uses the actual value of a field.)
378 * The following nxm_header values are potentially acceptable as 'src':
401 * - NXM_NX_ICMPV6_TYPE
402 * - NXM_NX_ICMPV6_CODE
405 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
407 * The following nxm_header values are potentially acceptable as 'dst':
409 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
411 * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
412 * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
413 * header (if any), ignoring the other bits. Setting a value with CFI=1
414 * adds or modifies the 802.1Q header appropriately, setting the TCI field
415 * to the field's new value (with the CFI bit masked out).
417 * - NXM_NX_TUN_ID. Modifying this value modifies the tunnel ID used for the
418 * packet's next tunnel encapsulation.
420 * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
421 * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
422 * used only if the flow's nx_match includes an nxm_entry that specifies
423 * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
425 * The switch will reject actions for which src_ofs+n_bits is greater than the
426 * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
427 * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
429 struct nx_action_reg_move {
430 ovs_be16 type; /* OFPAT_VENDOR. */
431 ovs_be16 len; /* Length is 16. */
432 ovs_be32 vendor; /* NX_VENDOR_ID. */
433 ovs_be16 subtype; /* NXAST_REG_MOVE. */
434 ovs_be16 n_bits; /* Number of bits. */
435 ovs_be16 src_ofs; /* Starting bit offset in source. */
436 ovs_be16 dst_ofs; /* Starting bit offset in destination. */
437 ovs_be32 src; /* Source register. */
438 ovs_be32 dst; /* Destination register. */
440 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
442 /* Action structure for NXAST_REG_LOAD.
444 * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
445 * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
446 * starts at 0 for the least-significant bit, 1 for the next most significant
449 * 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for
450 * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
453 * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
454 * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
455 * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
456 * also stored as one less than its true value:
459 * +------------------------------+------------------+
460 * | ofs | n_bits - 1 |
461 * +------------------------------+------------------+
463 * The switch will reject actions for which ofs+n_bits is greater than the
464 * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
465 * greater are set to 1, with error type OFPET_BAD_ACTION, code
466 * OFPBAC_BAD_ARGUMENT.
468 struct nx_action_reg_load {
469 ovs_be16 type; /* OFPAT_VENDOR. */
470 ovs_be16 len; /* Length is 16. */
471 ovs_be32 vendor; /* NX_VENDOR_ID. */
472 ovs_be16 subtype; /* NXAST_REG_LOAD. */
473 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
474 ovs_be32 dst; /* Destination register. */
475 ovs_be64 value; /* Immediate value. */
477 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
479 /* Action structure for NXAST_NOTE.
481 * This action has no effect. It is variable length. The switch does not
482 * attempt to interpret the user-defined 'note' data in any way. A controller
483 * can use this action to attach arbitrary metadata to a flow.
485 * This action might go away in the future.
487 struct nx_action_note {
488 ovs_be16 type; /* OFPAT_VENDOR. */
489 ovs_be16 len; /* A multiple of 8, but at least 16. */
490 ovs_be32 vendor; /* NX_VENDOR_ID. */
491 ovs_be16 subtype; /* NXAST_NOTE. */
492 uint8_t note[6]; /* Start of user-defined data. */
493 /* Possibly followed by additional user-defined data. */
495 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
497 /* Action structure for NXAST_MULTIPATH.
499 * This action performs the following steps in sequence:
501 * 1. Hashes the fields designated by 'fields', one of NX_MP_FIELDS_*.
502 * Refer to the definition of "enum nx_mp_fields" for details.
504 * The 'basis' value is used as a universal hash parameter, that is,
505 * different values of 'basis' yield different hash functions. The
506 * particular universal hash function used is implementation-defined.
508 * The hashed fields' values are drawn from the current state of the
509 * flow, including all modifications that have been made by actions up to
512 * 2. Applies the multipath link choice algorithm specified by 'algorithm',
513 * one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm"
516 * The output of the algorithm is 'link', an unsigned integer less than
517 * or equal to 'max_link'.
519 * Some algorithms use 'arg' as an additional argument.
521 * 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of
522 * 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
523 * action, except that 'dst' must be NXM_NX_REG(idx) for 'idx' in the
524 * switch's supported range.
526 * The switch will reject actions that have an unknown 'fields', or an unknown
527 * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
528 * in which 'max_link' is greater than or equal to 2**n_bits, with error type
529 * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
531 struct nx_action_multipath {
532 ovs_be16 type; /* OFPAT_VENDOR. */
533 ovs_be16 len; /* Length is 32. */
534 ovs_be32 vendor; /* NX_VENDOR_ID. */
535 ovs_be16 subtype; /* NXAST_MULTIPATH. */
537 /* What fields to hash and how. */
538 ovs_be16 fields; /* One of NX_MP_FIELDS_*. */
539 ovs_be16 basis; /* Universal hash parameter. */
542 /* Multipath link choice algorithm to apply to hash value. */
543 ovs_be16 algorithm; /* One of NX_MP_ALG_*. */
544 ovs_be16 max_link; /* Number of output links, minus 1. */
545 ovs_be32 arg; /* Algorithm-specific argument. */
548 /* Where to store the result. */
549 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
550 ovs_be32 dst; /* Destination register. */
552 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
554 /* NXAST_MULTIPATH: Fields to hash. */
556 /* Ethernet source address (NXM_OF_ETH_SRC) only. */
557 NX_MP_FIELDS_ETH_SRC,
559 /* L2 through L4, symmetric across src/dst. Specifically, each of the
560 * following fields, if present, is hashed (slashes separate symmetric
563 * - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
565 * - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
567 * - NXM_OF_IP_SRC / NXM_OF_IP_DST
568 * - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
569 * - NXM_OF_UDP_SRC / NXM_OF_UDP_DST
571 NX_MP_FIELDS_SYMMETRIC_L4
574 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
576 * In the descriptions below, 'n_links' is max_link + 1. */
577 enum nx_mp_algorithm {
578 /* link = hash(flow) % n_links.
580 * Redistributes all traffic when n_links changes. O(1) performance. See
583 * Use UINT16_MAX for max_link to get a raw hash value. */
586 /* link = hash(flow) / (MAX_HASH / n_links).
588 * Redistributes between one-quarter and one-half of traffic when n_links
589 * changes. O(1) performance. See RFC 2992.
591 NX_MP_ALG_HASH_THRESHOLD,
593 /* for i in [0,n_links):
594 * weights[i] = hash(flow, i)
595 * link = { i such that weights[i] >= weights[j] for all j != i }
597 * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
598 * performance. If n_links is greater than a threshold (currently 64, but
599 * subject to change), Open vSwitch will substitute another algorithm
600 * automatically. See RFC 2992. */
601 NX_MP_ALG_HRW, /* Highest Random Weight. */
606 * link = hash(flow, i) % arg
607 * while link > max_link
609 * Redistributes 1/n_links of traffic when n_links changes. O(1)
610 * performance when arg/max_link is bounded by a constant.
612 * Redistributes all traffic when arg changes.
614 * arg must be greater than max_link and for best performance should be no
615 * more than approximately max_link * 2. If arg is outside the acceptable
616 * range, Open vSwitch will automatically substitute the least power of 2
617 * greater than max_link.
619 * This algorithm is specific to Open vSwitch.
621 NX_MP_ALG_ITER_HASH /* Iterative Hash. */
624 /* Action structure for NXAST_AUTOPATH.
626 * This action performs the following steps in sequence:
628 * 1. Hashes the flow using an implementation-defined hash function.
630 * The hashed fields' values are drawn from the current state of the
631 * flow, including all modifications that have been made by actions up to
634 * 2. Selects an OpenFlow 'port'.
636 * 'port' is selected in an implementation-defined manner, taking into
637 * account 'id' and the hash value calculated in step 1.
639 * Generally a switch will have been configured with a set of ports that
640 * may be chosen given 'id'. The switch may take into account any number
641 * of factors when choosing 'port' from its configured set. Factors may
642 * include carrier, load, and the results of configuration protocols such
645 * 3. Stores 'port' in dst[ofs:ofs+n_bits].
647 * The format and semantics of 'dst' and 'ofs_nbits' are similar to those
648 * for the NXAST_REG_LOAD action, except that 'dst' must be
649 * NXM_NX_REG(idx) for 'idx' in the switch's supported range.
651 * The switch will reject actions in which ofs+n_bits is greater than the width
652 * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
654 struct nx_action_autopath {
655 ovs_be16 type; /* OFPAT_VENDOR. */
656 ovs_be16 len; /* Length is 20. */
657 ovs_be32 vendor; /* NX_VENDOR_ID. */
658 ovs_be16 subtype; /* NXAST_AUTOPATH. */
660 /* Where to store the result. */
661 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
662 ovs_be32 dst; /* Destination register. */
664 ovs_be32 id; /* Autopath ID. */
667 OFP_ASSERT(sizeof(struct nx_action_autopath) == 24);
669 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
671 * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches. This
672 * structure is fixed-length and hence difficult to extend. This section
673 * describes a more flexible, variable-length flow match, called "nx_match" for
674 * short, that is also supported by Open vSwitch. This section also defines a
675 * replacement for each OpenFlow message that includes struct ofp_match.
681 * An nx_match is a sequence of zero or more "nxm_entry"s, which are
682 * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
683 * "nxm_entry"s are not aligned on or padded to any multibyte boundary. The
684 * first 4 bytes of an nxm_entry are its "header", followed by the entry's
687 * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
689 * |<-------------------- nxm_type ------------------>|
692 * +----------------------------------+---------------+--+------------------+
693 * | nxm_vendor | nxm_field |hm| nxm_length |
694 * +----------------------------------+---------------+--+------------------+
696 * The most-significant 23 bits of the header are collectively "nxm_type".
697 * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
698 * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
699 * designates a protocol header, such as the Ethernet type, but it can also
700 * refer to packet metadata, such as the switch port on which a packet arrived.
702 * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
703 * of this bit is explained later.
705 * The least-significant 8 bits are "nxm_length", a positive integer. The
706 * length of the nxm_entry, including the header, is exactly 4 + nxm_length
709 * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
710 * constant. It is included only to allow software to minimally parse
711 * "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor,
712 * nxm_field, and nxm_length, nxm_hasmask is a constant.)
718 * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
720 * An nxm_entry places a constraint on the packets matched by the nx_match:
722 * - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
723 * field, called "nxm_value". The nx_match matches only packets in which
724 * the field equals nxm_value.
726 * - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
727 * field (nxm_value), followed by a bitmask of the same length as the
728 * value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
729 * nx_match matches only packets for which bit J in the given field's value
730 * matches bit J in nxm_value. A 0-bit in nxm_mask causes the
731 * corresponding bits in nxm_value and the field's value to be ignored.
732 * (The sense of the nxm_mask bits is the opposite of that used by the
733 * "wildcards" member of struct ofp_match.)
735 * When nxm_hasmask is 1, nxm_length is always even.
737 * An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
738 * entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for
741 * When there are multiple "nxm_entry"s, all of the constraints must be met.
747 * Masks may be restricted:
749 * - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
750 * must always be 0 when these fields are specified. For example, the
751 * field that identifies the port on which a packet was received may not be
754 * - Some nxm_types that do support masked wildcards may only support certain
755 * nxm_mask patterns. For example, fields that have IPv4 address values
756 * may be restricted to CIDR masks.
758 * These restrictions should be noted in specifications for individual fields.
759 * A switch may accept an nxm_hasmask or nxm_mask value that the specification
760 * disallows, if the switch correctly implements support for that nxm_hasmask
761 * or nxm_mask value. A switch must reject an attempt to set up a flow that
762 * contains a nxm_hasmask or nxm_mask value that it does not support.
765 * Prerequisite Restrictions
766 * =========================
768 * The presence of an nxm_entry with a given nxm_type may be restricted based
769 * on the presence of or values of other "nxm_entry"s. For example:
771 * - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
772 * preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
773 * and nxm_value=0x0800. That is, matching on the IP source address is
774 * allowed only if the Ethernet type is explicitly set to IP.
776 * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is preced
777 * by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
778 * nxm_value=0x0800 and another with nxm_type=NXM_OF_IP_PROTO,
779 * nxm_hasmask=0, nxm_value=6, in that order. That is, matching on the TCP
780 * source port is allowed only if the Ethernet type is IP and the IP
783 * These restrictions should be noted in specifications for individual fields.
784 * A switch may implement relaxed versions of these restrictions. A switch
785 * must reject an attempt to set up a flow that violates its restrictions.
788 * Ordering Restrictions
789 * =====================
791 * An nxm_entry that has prerequisite restrictions must appear after the
792 * "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an
793 * nx_match is not otherwise constrained.
795 * Any given nxm_type may appear in an nx_match at most once.
801 * These examples show the format of a single nxm_entry with particular
802 * nxm_hasmask and nxm_length values. The diagrams are labeled with field
803 * numbers and byte indexes.
806 * 8-bit nxm_value, nxm_hasmask=1, nxm_length=1:
809 * +------------+---+---+
811 * +------------+---+---+
814 * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
817 * +------------+------+
819 * +------------+------+
822 * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
825 * +------------+-------------+
826 * | header | nxm_value |
827 * +------------+-------------+
830 * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
833 * +------------+------------------+
834 * | header | nxm_value |
835 * +------------+------------------+
838 * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
841 * +------------+------------------+------------------+
842 * | header | nxm_value | nxm_mask |
843 * +------------+------------------+------------------+
849 * A switch should report an error in an nx_match using error type
850 * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch
851 * should report a specific error code, if one is assigned for the particular
852 * problem, but NXBRC_NXM_INVALID is also available to report a generic
856 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
857 (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
858 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
859 NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
860 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
861 NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
862 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
863 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
864 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
865 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
866 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
868 #define NXM_MAKE_WILD_HEADER(HEADER) \
869 NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
871 /* ## ------------------------------- ## */
872 /* ## OpenFlow 1.0-compatible fields. ## */
873 /* ## ------------------------------- ## */
875 /* Physical or virtual port on which the packet was received.
879 * Format: 16-bit integer in network byte order.
881 * Masking: Not maskable. */
882 #define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
884 /* Source or destination address in Ethernet header.
888 * Format: 48-bit Ethernet MAC address.
890 * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
891 * be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
892 * are all-0-bits or all-1-bits). Support for other patterns and for masking
893 * of NXM_OF_ETH_SRC is optional. */
894 #define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
895 #define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
896 #define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
898 /* Packet's Ethernet type.
900 * For an Ethernet II packet this is taken from the Ethernet header. For an
901 * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
902 * A packet that has neither format has value 0x05ff
903 * (OFP_DL_TYPE_NOT_ETH_TYPE).
905 * For a packet with an 802.1Q header, this is the type of the encapsulated
910 * Format: 16-bit integer in network byte order.
912 * Masking: Not maskable. */
913 #define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
917 * For a packet with an 802.1Q header, this is the Tag Control Information
918 * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
919 * header, this has value 0.
923 * Format: 16-bit integer in network byte order.
925 * Masking: Arbitrary masks.
927 * This field can be used in various ways:
929 * - If it is not constrained at all, the nx_match matches packets without
930 * an 802.1Q header or with an 802.1Q header that has any TCI value.
932 * - Testing for an exact match with 0 matches only packets without an
935 * - Testing for an exact match with a TCI value with CFI=1 matches packets
936 * that have an 802.1Q header with a specified VID and PCP.
938 * - Testing for an exact match with a nonzero TCI value with CFI=0 does
939 * not make sense. The switch may reject this combination.
941 * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
942 * packets that have an 802.1Q header with that VID (and any PCP).
944 * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
945 * packets that have an 802.1Q header with that PCP (and any VID).
947 * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
948 * header or with an 802.1Q header with a VID of 0.
950 * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
951 * header or with an 802.1Q header with a PCP of 0.
953 * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
954 * header or with an 802.1Q header with both VID and PCP of 0.
956 #define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
957 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
959 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
961 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
963 * Format: 8-bit integer with 2 least-significant bits forced to 0.
965 * Masking: Not maskable. */
966 #define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
968 /* The "protocol" byte in the IP header.
970 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
972 * Format: 8-bit integer.
974 * Masking: Not maskable. */
975 #define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
977 /* The source or destination address in the IP header.
979 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
981 * Format: 32-bit integer in network byte order.
983 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
984 * high-order bits set to 1 and the other 32-N bits set to 0. */
985 #define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
986 #define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
987 #define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
988 #define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
990 /* The source or destination port in the TCP header.
993 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
994 * NXM_OF_IP_PROTO must match 6 exactly.
996 * Format: 16-bit integer in network byte order.
998 * Masking: Not maskable. */
999 #define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
1000 #define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
1002 /* The source or destination port in the UDP header.
1005 * NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1006 * NXM_OF_IP_PROTO must match 17 exactly.
1008 * Format: 16-bit integer in network byte order.
1010 * Masking: Not maskable. */
1011 #define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
1012 #define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
1014 /* The type or code in the ICMP header.
1017 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
1018 * NXM_OF_IP_PROTO must match 1 exactly.
1020 * Format: 8-bit integer.
1022 * Masking: Not maskable. */
1023 #define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
1024 #define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
1028 * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
1029 * otherwise. Only ARP opcodes between 1 and 255 should be specified for
1032 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1034 * Format: 16-bit integer in network byte order.
1036 * Masking: Not maskable. */
1037 #define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
1039 /* For an Ethernet+IP ARP packet, the source or target protocol address
1040 * in the ARP header. Always 0 otherwise.
1042 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1044 * Format: 32-bit integer in network byte order.
1046 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1047 * high-order bits set to 1 and the other 32-N bits set to 0. */
1048 #define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
1049 #define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
1050 #define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
1051 #define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
1053 /* ## ------------------------ ## */
1054 /* ## Nicira match extensions. ## */
1055 /* ## ------------------------ ## */
1057 /* Metadata registers.
1059 * Registers initially have value 0. Actions allow register values to be
1064 * Format: Array of 32-bit integer registers. Space is reserved for up to
1065 * NXM_NX_MAX_REGS registers, but switches may implement fewer.
1067 * Masking: Arbitrary masks. */
1068 #define NXM_NX_MAX_REGS 16
1069 #define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
1070 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1071 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1072 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1073 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1074 #define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
1075 #define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
1076 #define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
1077 #define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
1078 #define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
1079 #define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
1080 #define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
1081 #define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
1085 * For a packet received via GRE tunnel including a (32-bit) key, the key is
1086 * stored in the low 32-bits and the high bits are zeroed. For other packets,
1091 * Format: 64-bit integer in network byte order.
1093 * Masking: Arbitrary masks. */
1094 #define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
1095 #define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
1097 /* For an Ethernet+IP ARP packet, the source or target hardware address
1098 * in the ARP header. Always 0 otherwise.
1100 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1102 * Format: 48-bit Ethernet MAC address.
1104 * Masking: Not maskable. */
1105 #define NXM_NX_ARP_SHA NXM_HEADER (0x0001, 17, 6)
1106 #define NXM_NX_ARP_THA NXM_HEADER (0x0001, 18, 6)
1108 /* The source or destination address in the IPv6 header.
1110 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1112 * Format: 128-bit IPv6 address.
1114 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1115 * high-order bits set to 1 and the other 128-N bits set to 0. */
1116 #define NXM_NX_IPV6_SRC NXM_HEADER (0x0001, 19, 16)
1117 #define NXM_NX_IPV6_SRC_W NXM_HEADER_W(0x0001, 19, 16)
1118 #define NXM_NX_IPV6_DST NXM_HEADER (0x0001, 20, 16)
1119 #define NXM_NX_IPV6_DST_W NXM_HEADER_W(0x0001, 20, 16)
1121 /* The type or code in the ICMPv6 header.
1124 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1125 * NXM_OF_IP_PROTO must match 58 exactly.
1127 * Format: 8-bit integer.
1129 * Masking: Not maskable. */
1130 #define NXM_NX_ICMPV6_TYPE NXM_HEADER (0x0001, 21, 1)
1131 #define NXM_NX_ICMPV6_CODE NXM_HEADER (0x0001, 22, 1)
1133 /* The target address in an IPv6 Neighbor Discovery message.
1136 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1137 * NXM_OF_IP_PROTO must match 58 exactly.
1138 * NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1140 * Format: 128-bit IPv6 address.
1142 * Masking: Not maskable. */
1143 #define NXM_NX_ND_TARGET NXM_HEADER (0x0001, 23, 16)
1145 /* The source link-layer address option in an IPv6 Neighbor Discovery
1149 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1150 * NXM_OF_IP_PROTO must match 58 exactly.
1151 * NXM_OF_ICMPV6_TYPE must be exactly 135.
1153 * Format: 48-bit Ethernet MAC address.
1155 * Masking: Not maskable. */
1156 #define NXM_NX_ND_SLL NXM_HEADER (0x0001, 24, 6)
1158 /* The target link-layer address option in an IPv6 Neighbor Discovery
1162 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1163 * NXM_OF_IP_PROTO must match 58 exactly.
1164 * NXM_OF_ICMPV6_TYPE must be exactly 136.
1166 * Format: 48-bit Ethernet MAC address.
1168 * Masking: Not maskable. */
1169 #define NXM_NX_ND_TLL NXM_HEADER (0x0001, 25, 6)
1172 /* ## --------------------- ## */
1173 /* ## Requests and replies. ## */
1174 /* ## --------------------- ## */
1176 enum nx_flow_format {
1177 NXFF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
1178 NXFF_NXM = 2 /* Nicira extended match. */
1181 /* NXT_SET_FLOW_FORMAT request. */
1182 struct nxt_set_flow_format {
1183 struct ofp_header header;
1184 ovs_be32 vendor; /* NX_VENDOR_ID. */
1185 ovs_be32 subtype; /* NXT_SET_FLOW_FORMAT. */
1186 ovs_be32 format; /* One of NXFF_*. */
1188 OFP_ASSERT(sizeof(struct nxt_set_flow_format) == 20);
1190 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */
1191 struct nx_flow_mod {
1192 struct nicira_header nxh;
1193 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1194 ovs_be16 command; /* One of OFPFC_*. */
1195 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
1196 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
1197 ovs_be16 priority; /* Priority level of flow entry. */
1198 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
1199 Not meaningful for OFPFC_DELETE*. */
1200 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
1201 matching entries to include this as an
1202 output port. A value of OFPP_NONE
1203 indicates no restriction. */
1204 ovs_be16 flags; /* One of OFPFF_*. */
1205 ovs_be16 match_len; /* Size of nx_match. */
1206 uint8_t pad[6]; /* Align to 64-bits. */
1208 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1209 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1210 * all-zero bytes, then
1211 * - Actions to fill out the remainder of the message length (always a
1215 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
1217 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1218 struct nx_flow_removed {
1219 struct nicira_header nxh;
1220 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1221 ovs_be16 priority; /* Priority level of flow entry. */
1222 uint8_t reason; /* One of OFPRR_*. */
1223 uint8_t pad[1]; /* Align to 32-bits. */
1224 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
1225 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
1227 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
1228 ovs_be16 match_len; /* Size of nx_match. */
1229 ovs_be64 packet_count;
1230 ovs_be64 byte_count;
1232 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1233 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1234 * all-zero bytes. */
1236 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
1238 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1240 struct nx_flow_stats_request {
1241 struct nicira_stats_msg nsm;
1242 ovs_be16 out_port; /* Require matching entries to include this
1243 as an output port. A value of OFPP_NONE
1244 indicates no restriction. */
1245 ovs_be16 match_len; /* Length of nx_match. */
1246 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1247 or 0xff for all tables. */
1248 uint8_t pad[3]; /* Align to 64 bits. */
1250 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1251 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1252 * all-zero bytes, which must also exactly fill out the length of the
1256 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
1258 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1259 * OFPST_FLOW reply). */
1260 struct nx_flow_stats {
1261 ovs_be16 length; /* Length of this entry. */
1262 uint8_t table_id; /* ID of table flow came from. */
1264 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
1265 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
1266 beyond duration_sec. */
1267 ovs_be16 priority; /* Priority of the entry. Only meaningful
1268 when this is not an exact-match entry. */
1269 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
1270 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
1271 ovs_be16 match_len; /* Length of nx_match. */
1272 uint8_t pad2[4]; /* Align to 64 bits. */
1273 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1274 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1275 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1277 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1278 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1279 * all-zero bytes, then
1280 * - Actions to fill out the remainder 'length' bytes (always a multiple
1284 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1286 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1287 * OFPST_AGGREGATE request). */
1288 struct nx_aggregate_stats_request {
1289 struct nicira_stats_msg nsm;
1290 ovs_be16 out_port; /* Require matching entries to include this
1291 as an output port. A value of OFPP_NONE
1292 indicates no restriction. */
1293 ovs_be16 match_len; /* Length of nx_match. */
1294 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1295 or 0xff for all tables. */
1296 uint8_t pad[3]; /* Align to 64 bits. */
1298 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1299 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1300 * all-zero bytes, which must also exactly fill out the length of the
1304 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1306 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1307 * OFPST_AGGREGATE reply). */
1308 struct nx_aggregate_stats_reply {
1309 struct nicira_stats_msg nsm;
1310 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1311 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1312 ovs_be32 flow_count; /* Number of flows. */
1313 uint8_t pad[4]; /* Align to 64 bits. */
1315 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1317 #endif /* openflow/nicira-ext.h */