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 * (This extension is not yet implemented on this branch of Open
114 NXFMFC_BAD_TABLE_ID = 0x101
117 /* Nicira vendor requests and replies. */
119 /* Header for Nicira vendor requests and replies. */
120 struct nicira_header {
121 struct ofp_header header;
122 ovs_be32 vendor; /* NX_VENDOR_ID. */
123 ovs_be32 subtype; /* One of NXT_* below. */
125 OFP_ASSERT(sizeof(struct nicira_header) == 16);
127 /* Values for the 'subtype' member of struct nicira_header. */
129 /* Switch status request. The request body is an ASCII string that
130 * specifies a prefix of the key names to include in the output; if it is
131 * the null string, then all key-value pairs are included. */
134 /* Switch status reply. The reply body is an ASCII string of key-value
135 * pairs in the form "key=value\n". */
138 /* No longer used. */
139 NXT_ACT_SET_CONFIG__OBSOLETE,
140 NXT_ACT_GET_CONFIG__OBSOLETE,
141 NXT_COMMAND_REQUEST__OBSOLETE,
142 NXT_COMMAND_REPLY__OBSOLETE,
143 NXT_FLOW_END_CONFIG__OBSOLETE,
144 NXT_FLOW_END__OBSOLETE,
147 /* Use the high 32 bits of the cookie field as the tunnel ID in the flow
149 NXT_TUN_ID_FROM_COOKIE,
151 /* Controller role support. The request body is struct nx_role_request.
152 * The reply echos the request. */
156 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
157 NXT_SET_FLOW_FORMAT, /* Set flow format. */
158 NXT_FLOW_MOD, /* Analogous to OFPT_FLOW_MOD. */
159 NXT_FLOW_REMOVED /* Analogous to OFPT_FLOW_REMOVED. */
162 /* Header for Nicira vendor stats request and reply messages. */
163 struct nicira_stats_msg {
164 struct ofp_header header; /* OFPT_STATS_REQUEST or OFPT_STATS_REPLY. */
165 ovs_be16 type; /* OFPST_VENDOR. */
166 ovs_be16 flags; /* OFPSF_{REQ,REPLY}_*. */
167 ovs_be32 vendor; /* NX_VENDOR_ID. */
168 ovs_be32 subtype; /* One of NXST_* below. */
169 uint8_t pad[4]; /* Align to 64-bits. */
171 OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
173 /* Values for the 'subtype' member of struct nicira_stats_msg. */
174 enum nicira_stats_type {
175 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
176 NXST_FLOW, /* Analogous to OFPST_FLOW. */
177 NXST_AGGREGATE /* Analogous to OFPST_AGGREGATE. */
180 /* NXT_TUN_ID_FROM_COOKIE request. */
181 struct nxt_tun_id_cookie {
182 struct ofp_header header;
183 ovs_be32 vendor; /* NX_VENDOR_ID. */
184 ovs_be32 subtype; /* NXT_TUN_ID_FROM_COOKIE */
185 uint8_t set; /* Nonzero to enable, zero to disable. */
188 OFP_ASSERT(sizeof(struct nxt_tun_id_cookie) == 24);
190 /* Configures the "role" of the sending controller. The default role is:
192 * - Other (NX_ROLE_OTHER), which allows the controller access to all
195 * The other possible roles are a related pair:
197 * - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
198 * be at most one Master controller at a time: when a controller
199 * configures itself as Master, any existing Master is demoted to the
202 * - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
203 * OpenFlow features. In particular attempts to modify the flow table
204 * will be rejected with an OFPBRC_EPERM error.
206 * Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
207 * messages, but they do receive OFPT_PORT_STATUS messages.
209 struct nx_role_request {
210 struct nicira_header nxh;
211 ovs_be32 role; /* One of NX_ROLE_*. */
215 NX_ROLE_OTHER, /* Default role, full access. */
216 NX_ROLE_MASTER, /* Full access, at most one. */
217 NX_ROLE_SLAVE /* Read-only access. */
220 /* Nicira vendor flow actions. */
222 enum nx_action_subtype {
223 NXAST_SNAT__OBSOLETE, /* No longer used. */
224 NXAST_RESUBMIT, /* struct nx_action_resubmit */
225 NXAST_SET_TUNNEL, /* struct nx_action_set_tunnel */
226 NXAST_DROP_SPOOFED_ARP, /* struct nx_action_drop_spoofed_arp */
227 NXAST_SET_QUEUE, /* struct nx_action_set_queue */
228 NXAST_POP_QUEUE, /* struct nx_action_pop_queue */
229 NXAST_REG_MOVE, /* struct nx_action_reg_move */
230 NXAST_REG_LOAD, /* struct nx_action_reg_load */
231 NXAST_NOTE, /* struct nx_action_note */
232 NXAST_SET_TUNNEL64, /* struct nx_action_set_tunnel64 */
233 NXAST_MULTIPATH /* struct nx_action_multipath */
236 /* Header for Nicira-defined actions. */
237 struct nx_action_header {
238 ovs_be16 type; /* OFPAT_VENDOR. */
239 ovs_be16 len; /* Length is 16. */
240 ovs_be32 vendor; /* NX_VENDOR_ID. */
241 ovs_be16 subtype; /* NXAST_*. */
244 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
246 /* Action structure for NXAST_RESUBMIT.
248 * NXAST_RESUBMIT searches the flow table again, using a flow that is slightly
249 * modified from the original lookup:
251 * - The 'in_port' member of struct nx_action_resubmit is used as the flow's
254 * - If NXAST_RESUBMIT is preceded by actions that affect the flow
255 * (e.g. OFPAT_SET_VLAN_VID), then the flow is updated with the new
258 * Following the lookup, the original in_port is restored.
260 * If the modified flow matched in the flow table, then the corresponding
261 * actions are executed. Afterward, actions following NXAST_RESUBMIT in the
262 * original set of actions, if any, are executed; any changes made to the
263 * packet (e.g. changes to VLAN) by secondary actions persist when those
264 * actions are executed, although the original in_port is restored.
266 * NXAST_RESUBMIT may be used any number of times within a set of actions.
268 * NXAST_RESUBMIT may nest to an implementation-defined depth. Beyond this
269 * implementation-defined depth, further NXAST_RESUBMIT actions are simply
270 * ignored. (Open vSwitch 1.0.1 and earlier did not support recursion.)
272 struct nx_action_resubmit {
273 ovs_be16 type; /* OFPAT_VENDOR. */
274 ovs_be16 len; /* Length is 16. */
275 ovs_be32 vendor; /* NX_VENDOR_ID. */
276 ovs_be16 subtype; /* NXAST_RESUBMIT. */
277 ovs_be16 in_port; /* New in_port for checking flow table. */
280 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
282 /* Action structure for NXAST_SET_TUNNEL.
284 * Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32
285 * bits of the tunnel ID are set to 0. */
286 struct nx_action_set_tunnel {
287 ovs_be16 type; /* OFPAT_VENDOR. */
288 ovs_be16 len; /* Length is 16. */
289 ovs_be32 vendor; /* NX_VENDOR_ID. */
290 ovs_be16 subtype; /* NXAST_SET_TUNNEL. */
292 ovs_be32 tun_id; /* Tunnel ID. */
294 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
296 /* Action structure for NXAST_SET_TUNNEL64.
298 * Sets the encapsulating tunnel ID to a 64-bit value. */
299 struct nx_action_set_tunnel64 {
300 ovs_be16 type; /* OFPAT_VENDOR. */
301 ovs_be16 len; /* Length is 16. */
302 ovs_be32 vendor; /* NX_VENDOR_ID. */
303 ovs_be16 subtype; /* NXAST_SET_TUNNEL64. */
305 ovs_be64 tun_id; /* Tunnel ID. */
307 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
309 /* Action structure for NXAST_DROP_SPOOFED_ARP.
311 * Stops processing further actions, if the packet being processed is an
312 * Ethernet+IPv4 ARP packet for which the source Ethernet address inside the
313 * ARP packet differs from the source Ethernet address in the Ethernet header.
315 * (This action is deprecated in favor of defining flows using the
316 * NXM_NX_ARP_SHA flow match and will likely be removed in a future version
317 * of Open vSwitch.) */
318 struct nx_action_drop_spoofed_arp {
319 ovs_be16 type; /* OFPAT_VENDOR. */
320 ovs_be16 len; /* Length is 16. */
321 ovs_be32 vendor; /* NX_VENDOR_ID. */
322 ovs_be16 subtype; /* NXAST_DROP_SPOOFED_ARP. */
325 OFP_ASSERT(sizeof(struct nx_action_drop_spoofed_arp) == 16);
327 /* Action structure for NXAST_SET_QUEUE.
329 * Set the queue that should be used when packets are output. This is similar
330 * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
331 * an argument. This allows the queue to be defined before the port is
333 struct nx_action_set_queue {
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_QUEUE. */
339 ovs_be32 queue_id; /* Where to enqueue packets. */
341 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
343 /* Action structure for NXAST_POP_QUEUE.
345 * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
346 * were used. Only the original queue can be restored this way; no stack is
348 struct nx_action_pop_queue {
349 ovs_be16 type; /* OFPAT_VENDOR. */
350 ovs_be16 len; /* Length is 16. */
351 ovs_be32 vendor; /* NX_VENDOR_ID. */
352 ovs_be16 subtype; /* NXAST_POP_QUEUE. */
355 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
357 /* Action structure for NXAST_REG_MOVE.
359 * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
360 * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
361 * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
362 * the next most significant bit, and so on.
364 * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
365 * sense to use nxm_hasmask=1 because the action does not do any kind of
366 * matching; it uses the actual value of a field.)
368 * The following nxm_header values are potentially acceptable as 'src':
391 * - NXM_NX_ICMPV6_TYPE
392 * - NXM_NX_ICMPV6_CODE
395 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
397 * The following nxm_header values are potentially acceptable as 'dst':
399 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
401 * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
402 * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
403 * header (if any), ignoring the other bits. Setting a value with CFI=1
404 * adds or modifies the 802.1Q header appropriately, setting the TCI field
405 * to the field's new value (with the CFI bit masked out).
407 * - NXM_NX_TUN_ID. Modifying this value modifies the tunnel ID used for the
408 * packet's next tunnel encapsulation.
410 * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
411 * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
412 * used only if the flow's nx_match includes an nxm_entry that specifies
413 * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
415 * The switch will reject actions for which src_ofs+n_bits is greater than the
416 * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
417 * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
419 struct nx_action_reg_move {
420 ovs_be16 type; /* OFPAT_VENDOR. */
421 ovs_be16 len; /* Length is 16. */
422 ovs_be32 vendor; /* NX_VENDOR_ID. */
423 ovs_be16 subtype; /* NXAST_REG_MOVE. */
424 ovs_be16 n_bits; /* Number of bits. */
425 ovs_be16 src_ofs; /* Starting bit offset in source. */
426 ovs_be16 dst_ofs; /* Starting bit offset in destination. */
427 ovs_be32 src; /* Source register. */
428 ovs_be32 dst; /* Destination register. */
430 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
432 /* Action structure for NXAST_REG_LOAD.
434 * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
435 * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
436 * starts at 0 for the least-significant bit, 1 for the next most significant
439 * 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for
440 * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
443 * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
444 * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
445 * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
446 * also stored as one less than its true value:
449 * +------------------------------+------------------+
450 * | ofs | n_bits - 1 |
451 * +------------------------------+------------------+
453 * The switch will reject actions for which ofs+n_bits is greater than the
454 * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
455 * greater are set to 1, with error type OFPET_BAD_ACTION, code
456 * OFPBAC_BAD_ARGUMENT.
458 struct nx_action_reg_load {
459 ovs_be16 type; /* OFPAT_VENDOR. */
460 ovs_be16 len; /* Length is 16. */
461 ovs_be32 vendor; /* NX_VENDOR_ID. */
462 ovs_be16 subtype; /* NXAST_REG_LOAD. */
463 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
464 ovs_be32 dst; /* Destination register. */
465 ovs_be64 value; /* Immediate value. */
467 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
469 /* Action structure for NXAST_NOTE.
471 * This action has no effect. It is variable length. The switch does not
472 * attempt to interpret the user-defined 'note' data in any way. A controller
473 * can use this action to attach arbitrary metadata to a flow.
475 * This action might go away in the future.
477 struct nx_action_note {
478 ovs_be16 type; /* OFPAT_VENDOR. */
479 ovs_be16 len; /* A multiple of 8, but at least 16. */
480 ovs_be32 vendor; /* NX_VENDOR_ID. */
481 ovs_be16 subtype; /* NXAST_NOTE. */
482 uint8_t note[6]; /* Start of user-defined data. */
483 /* Possibly followed by additional user-defined data. */
485 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
487 /* Action structure for NXAST_MULTIPATH.
489 * This action performs the following steps in sequence:
491 * 1. Hashes the fields designated by 'fields', one of NX_MP_FIELDS_*.
492 * Refer to the definition of "enum nx_mp_fields" for details.
494 * The 'basis' value is used as a universal hash parameter, that is,
495 * different values of 'basis' yield different hash functions. The
496 * particular universal hash function used is implementation-defined.
498 * The hashed fields' values are drawn from the current state of the
499 * flow, including all modifications that have been made by actions up to
502 * 2. Applies the multipath link choice algorithm specified by 'algorithm',
503 * one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm"
506 * The output of the algorithm is 'link', an unsigned integer less than
507 * or equal to 'max_link'.
509 * Some algorithms use 'arg' as an additional argument.
511 * 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of
512 * 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
513 * action, except that 'dst' must be NXM_NX_REG(idx) for 'idx' in the
514 * switch's supported range.
516 * The switch will reject actions that have an unknown 'fields', or an unknown
517 * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
518 * in which 'max_link' is greater than or equal to 2**n_bits, with error type
519 * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
521 struct nx_action_multipath {
522 ovs_be16 type; /* OFPAT_VENDOR. */
523 ovs_be16 len; /* Length is 32. */
524 ovs_be32 vendor; /* NX_VENDOR_ID. */
525 ovs_be16 subtype; /* NXAST_MULTIPATH. */
527 /* What fields to hash and how. */
528 ovs_be16 fields; /* One of NX_MP_FIELDS_*. */
529 ovs_be16 basis; /* Universal hash parameter. */
532 /* Multipath link choice algorithm to apply to hash value. */
533 ovs_be16 algorithm; /* One of NX_MP_ALG_*. */
534 ovs_be16 max_link; /* Number of output links, minus 1. */
535 ovs_be32 arg; /* Algorithm-specific argument. */
538 /* Where to store the result. */
539 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
540 ovs_be32 dst; /* Destination register. */
542 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
544 /* NXAST_MULTIPATH: Fields to hash. */
546 /* Ethernet source address (NXM_OF_ETH_SRC) only. */
547 NX_MP_FIELDS_ETH_SRC,
549 /* L2 through L4, symmetric across src/dst. Specifically, each of the
550 * following fields, if present, is hashed (slashes separate symmetric
553 * - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
555 * - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
557 * - NXM_OF_IP_SRC / NXM_OF_IP_DST
558 * - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
559 * - NXM_OF_UDP_SRC / NXM_OF_UDP_DST
561 NX_MP_FIELDS_SYMMETRIC_L4
564 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
566 * In the descriptions below, 'n_links' is max_link + 1. */
567 enum nx_mp_algorithm {
568 /* link = hash(flow) % n_links.
570 * Redistributes all traffic when n_links changes. O(1) performance. See
573 * Use UINT16_MAX for max_link to get a raw hash value. */
576 /* link = hash(flow) / (MAX_HASH / n_links).
578 * Redistributes between one-quarter and one-half of traffic when n_links
579 * changes. O(1) performance. See RFC 2992.
581 NX_MP_ALG_HASH_THRESHOLD,
583 /* for i in [0,n_links):
584 * weights[i] = hash(flow, i)
585 * link = { i such that weights[i] >= weights[j] for all j != i }
587 * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
588 * performance. If n_links is greater than a threshold (currently 64, but
589 * subject to change), Open vSwitch will substitute another algorithm
590 * automatically. See RFC 2992. */
591 NX_MP_ALG_HRW, /* Highest Random Weight. */
596 * link = hash(flow, i) % arg
597 * while link > max_link
599 * Redistributes 1/n_links of traffic when n_links changes. O(1)
600 * performance when arg/max_link is bounded by a constant.
602 * Redistributes all traffic when arg changes.
604 * arg must be greater than max_link and for best performance should be no
605 * more than approximately max_link * 2. If arg is outside the acceptable
606 * range, Open vSwitch will automatically substitute the least power of 2
607 * greater than max_link.
609 * This algorithm is specific to Open vSwitch.
611 NX_MP_ALG_ITER_HASH /* Iterative Hash. */
614 /* Wildcard for tunnel ID. */
615 #define NXFW_TUN_ID (1 << 25)
617 #define NXFW_ALL NXFW_TUN_ID
618 #define OVSFW_ALL (OFPFW_ALL | NXFW_ALL)
620 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
622 * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches. This
623 * structure is fixed-length and hence difficult to extend. This section
624 * describes a more flexible, variable-length flow match, called "nx_match" for
625 * short, that is also supported by Open vSwitch. This section also defines a
626 * replacement for each OpenFlow message that includes struct ofp_match.
632 * An nx_match is a sequence of zero or more "nxm_entry"s, which are
633 * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
634 * "nxm_entry"s are not aligned on or padded to any multibyte boundary. The
635 * first 4 bytes of an nxm_entry are its "header", followed by the entry's
638 * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
640 * |<-------------------- nxm_type ------------------>|
643 * +----------------------------------+---------------+--+------------------+
644 * | nxm_vendor | nxm_field |hm| nxm_length |
645 * +----------------------------------+---------------+--+------------------+
647 * The most-significant 23 bits of the header are collectively "nxm_type".
648 * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
649 * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
650 * designates a protocol header, such as the Ethernet type, but it can also
651 * refer to packet metadata, such as the switch port on which a packet arrived.
653 * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
654 * of this bit is explained later.
656 * The least-significant 8 bits are "nxm_length", a positive integer. The
657 * length of the nxm_entry, including the header, is exactly 4 + nxm_length
660 * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
661 * constant. It is included only to allow software to minimally parse
662 * "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor,
663 * nxm_field, and nxm_length, nxm_hasmask is a constant.)
669 * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
671 * An nxm_entry places a constraint on the packets matched by the nx_match:
673 * - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
674 * field, called "nxm_value". The nx_match matches only packets in which
675 * the field equals nxm_value.
677 * - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
678 * field (nxm_value), followed by a bitmask of the same length as the
679 * value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
680 * nx_match matches only packets for which bit J in the given field's value
681 * matches bit J in nxm_value. A 0-bit in nxm_mask causes the
682 * corresponding bits in nxm_value and the field's value to be ignored.
683 * (The sense of the nxm_mask bits is the opposite of that used by the
684 * "wildcards" member of struct ofp_match.)
686 * When nxm_hasmask is 1, nxm_length is always even.
688 * An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
689 * entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for
692 * When there are multiple "nxm_entry"s, all of the constraints must be met.
698 * Masks may be restricted:
700 * - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
701 * must always be 0 when these fields are specified. For example, the
702 * field that identifies the port on which a packet was received may not be
705 * - Some nxm_types that do support masked wildcards may only support certain
706 * nxm_mask patterns. For example, fields that have IPv4 address values
707 * may be restricted to CIDR masks.
709 * These restrictions should be noted in specifications for individual fields.
710 * A switch may accept an nxm_hasmask or nxm_mask value that the specification
711 * disallows, if the switch correctly implements support for that nxm_hasmask
712 * or nxm_mask value. A switch must reject an attempt to set up a flow that
713 * contains a nxm_hasmask or nxm_mask value that it does not support.
716 * Prerequisite Restrictions
717 * =========================
719 * The presence of an nxm_entry with a given nxm_type may be restricted based
720 * on the presence of or values of other "nxm_entry"s. For example:
722 * - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
723 * preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
724 * and nxm_value=0x0800. That is, matching on the IP source address is
725 * allowed only if the Ethernet type is explicitly set to IP.
727 * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is preced
728 * by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
729 * nxm_value=0x0800 and another with nxm_type=NXM_OF_IP_PROTO,
730 * nxm_hasmask=0, nxm_value=6, in that order. That is, matching on the TCP
731 * source port is allowed only if the Ethernet type is IP and the IP
734 * These restrictions should be noted in specifications for individual fields.
735 * A switch may implement relaxed versions of these restrictions. A switch
736 * must reject an attempt to set up a flow that violates its restrictions.
739 * Ordering Restrictions
740 * =====================
742 * An nxm_entry that has prerequisite restrictions must appear after the
743 * "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an
744 * nx_match is not otherwise constrained.
746 * Any given nxm_type may appear in an nx_match at most once.
752 * These examples show the format of a single nxm_entry with particular
753 * nxm_hasmask and nxm_length values. The diagrams are labeled with field
754 * numbers and byte indexes.
757 * 8-bit nxm_value, nxm_hasmask=1, nxm_length=1:
760 * +------------+---+---+
762 * +------------+---+---+
765 * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
768 * +------------+------+
770 * +------------+------+
773 * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
776 * +------------+-------------+
777 * | header | nxm_value |
778 * +------------+-------------+
781 * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
784 * +------------+------------------+
785 * | header | nxm_value |
786 * +------------+------------------+
789 * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
792 * +------------+------------------+------------------+
793 * | header | nxm_value | nxm_mask |
794 * +------------+------------------+------------------+
800 * A switch should report an error in an nx_match using error type
801 * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch
802 * should report a specific error code, if one is assigned for the particular
803 * problem, but NXBRC_NXM_INVALID is also available to report a generic
807 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
808 (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
809 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
810 NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
811 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
812 NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
813 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
814 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
815 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
816 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
817 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
819 #define NXM_MAKE_WILD_HEADER(HEADER) \
820 NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
822 /* ## ------------------------------- ## */
823 /* ## OpenFlow 1.0-compatible fields. ## */
824 /* ## ------------------------------- ## */
826 /* Physical or virtual port on which the packet was received.
830 * Format: 16-bit integer in network byte order.
832 * Masking: Not maskable. */
833 #define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
835 /* Source or destination address in Ethernet header.
839 * Format: 48-bit Ethernet MAC address.
841 * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
842 * be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
843 * are all-0-bits or all-1-bits). Support for other patterns and for masking
844 * of NXM_OF_ETH_SRC is optional. */
845 #define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
846 #define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
847 #define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
849 /* Packet's Ethernet type.
851 * For an Ethernet II packet this is taken from the Ethernet header. For an
852 * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
853 * A packet that has neither format has value 0x05ff
854 * (OFP_DL_TYPE_NOT_ETH_TYPE).
856 * For a packet with an 802.1Q header, this is the type of the encapsulated
861 * Format: 16-bit integer in network byte order.
863 * Masking: Not maskable. */
864 #define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
868 * For a packet with an 802.1Q header, this is the Tag Control Information
869 * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
870 * header, this has value 0.
874 * Format: 16-bit integer in network byte order.
876 * Masking: Arbitrary masks.
878 * This field can be used in various ways:
880 * - If it is not constrained at all, the nx_match matches packets without
881 * an 802.1Q header or with an 802.1Q header that has any TCI value.
883 * - Testing for an exact match with 0 matches only packets without an
886 * - Testing for an exact match with a TCI value with CFI=1 matches packets
887 * that have an 802.1Q header with a specified VID and PCP.
889 * - Testing for an exact match with a nonzero TCI value with CFI=0 does
890 * not make sense. The switch may reject this combination.
892 * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
893 * packets that have an 802.1Q header with that VID (and any PCP).
895 * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
896 * packets that have an 802.1Q header with that PCP (and any VID).
898 * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
899 * header or with an 802.1Q header with a VID of 0.
901 * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
902 * header or with an 802.1Q header with a PCP of 0.
904 * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
905 * header or with an 802.1Q header with both VID and PCP of 0.
907 #define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
908 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
910 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
912 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
914 * Format: 8-bit integer with 2 least-significant bits forced to 0.
916 * Masking: Not maskable. */
917 #define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
919 /* The "protocol" byte in the IP header.
921 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
923 * Format: 8-bit integer.
925 * Masking: Not maskable. */
926 #define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
928 /* The source or destination address in the IP header.
930 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
932 * Format: 32-bit integer in network byte order.
934 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
935 * high-order bits set to 1 and the other 32-N bits set to 0. */
936 #define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
937 #define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
938 #define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
939 #define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
941 /* The source or destination port in the TCP header.
944 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
945 * NXM_OF_IP_PROTO must match 6 exactly.
947 * Format: 16-bit integer in network byte order.
949 * Masking: Not maskable. */
950 #define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
951 #define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
953 /* The source or destination port in the UDP header.
956 * NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
957 * NXM_OF_IP_PROTO must match 17 exactly.
959 * Format: 16-bit integer in network byte order.
961 * Masking: Not maskable. */
962 #define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
963 #define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
965 /* The type or code in the ICMP header.
968 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
969 * NXM_OF_IP_PROTO must match 1 exactly.
971 * Format: 8-bit integer.
973 * Masking: Not maskable. */
974 #define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
975 #define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
979 * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
980 * otherwise. Only ARP opcodes between 1 and 255 should be specified for
983 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
985 * Format: 16-bit integer in network byte order.
987 * Masking: Not maskable. */
988 #define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
990 /* For an Ethernet+IP ARP packet, the source or target protocol address
991 * in the ARP header. Always 0 otherwise.
993 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
995 * Format: 32-bit integer in network byte order.
997 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
998 * high-order bits set to 1 and the other 32-N bits set to 0. */
999 #define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
1000 #define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
1001 #define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
1002 #define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
1004 /* ## ------------------------ ## */
1005 /* ## Nicira match extensions. ## */
1006 /* ## ------------------------ ## */
1008 /* Metadata registers.
1010 * Registers initially have value 0. Actions allow register values to be
1015 * Format: Array of 32-bit integer registers. Space is reserved for up to
1016 * NXM_NX_MAX_REGS registers, but switches may implement fewer.
1018 * Masking: Arbitrary masks. */
1019 #define NXM_NX_MAX_REGS 16
1020 #define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
1021 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1022 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1023 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1024 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1025 #define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
1026 #define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
1027 #define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
1028 #define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
1029 #define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
1030 #define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
1031 #define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
1032 #define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
1036 * For a packet received via GRE tunnel including a (32-bit) key, the key is
1037 * stored in the low 32-bits and the high bits are zeroed. For other packets,
1042 * Format: 64-bit integer in network byte order.
1044 * Masking: Arbitrary masks. */
1045 #define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
1046 #define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
1048 /* For an Ethernet+IP ARP packet, the source or target hardware address
1049 * in the ARP header. Always 0 otherwise.
1051 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1053 * Format: 48-bit Ethernet MAC address.
1055 * Masking: Not maskable. */
1056 #define NXM_NX_ARP_SHA NXM_HEADER (0x0001, 17, 6)
1057 #define NXM_NX_ARP_THA NXM_HEADER (0x0001, 18, 6)
1059 /* The source or destination address in the IPv6 header.
1061 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1063 * Format: 128-bit IPv6 address.
1065 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1066 * high-order bits set to 1 and the other 128-N bits set to 0. */
1067 #define NXM_NX_IPV6_SRC NXM_HEADER (0x0001, 19, 16)
1068 #define NXM_NX_IPV6_SRC_W NXM_HEADER_W(0x0001, 19, 16)
1069 #define NXM_NX_IPV6_DST NXM_HEADER (0x0001, 20, 16)
1070 #define NXM_NX_IPV6_DST_W NXM_HEADER_W(0x0001, 20, 16)
1072 /* The type or code in the ICMPv6 header.
1075 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1076 * NXM_OF_IP_PROTO must match 58 exactly.
1078 * Format: 8-bit integer.
1080 * Masking: Not maskable. */
1081 #define NXM_NX_ICMPV6_TYPE NXM_HEADER (0x0001, 21, 1)
1082 #define NXM_NX_ICMPV6_CODE NXM_HEADER (0x0001, 22, 1)
1084 /* The target address in an IPv6 Neighbor Discovery message.
1087 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1088 * NXM_OF_IP_PROTO must match 58 exactly.
1089 * NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1091 * Format: 128-bit IPv6 address.
1093 * Masking: Not maskable. */
1094 #define NXM_NX_ND_TARGET NXM_HEADER (0x0001, 23, 16)
1096 /* The source link-layer address option in an IPv6 Neighbor Discovery
1100 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1101 * NXM_OF_IP_PROTO must match 58 exactly.
1102 * NXM_OF_ICMPV6_TYPE must be exactly 135.
1104 * Format: 48-bit Ethernet MAC address.
1106 * Masking: Not maskable. */
1107 #define NXM_NX_ND_SLL NXM_HEADER (0x0001, 24, 6)
1109 /* The target link-layer address option in an IPv6 Neighbor Discovery
1113 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1114 * NXM_OF_IP_PROTO must match 58 exactly.
1115 * NXM_OF_ICMPV6_TYPE must be exactly 136.
1117 * Format: 48-bit Ethernet MAC address.
1119 * Masking: Not maskable. */
1120 #define NXM_NX_ND_TLL NXM_HEADER (0x0001, 25, 6)
1123 /* ## --------------------- ## */
1124 /* ## Requests and replies. ## */
1125 /* ## --------------------- ## */
1127 enum nx_flow_format {
1128 NXFF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
1129 NXFF_TUN_ID_FROM_COOKIE = 1, /* OpenFlow 1.0, plus obtain tunnel ID from
1131 NXFF_NXM = 2 /* Nicira extended match. */
1134 /* NXT_SET_FLOW_FORMAT request. */
1135 struct nxt_set_flow_format {
1136 struct ofp_header header;
1137 ovs_be32 vendor; /* NX_VENDOR_ID. */
1138 ovs_be32 subtype; /* NXT_SET_FLOW_FORMAT. */
1139 ovs_be32 format; /* One of NXFF_*. */
1141 OFP_ASSERT(sizeof(struct nxt_set_flow_format) == 20);
1143 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */
1144 struct nx_flow_mod {
1145 struct nicira_header nxh;
1146 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1147 ovs_be16 command; /* One of OFPFC_*. */
1148 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
1149 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
1150 ovs_be16 priority; /* Priority level of flow entry. */
1151 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
1152 Not meaningful for OFPFC_DELETE*. */
1153 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
1154 matching entries to include this as an
1155 output port. A value of OFPP_NONE
1156 indicates no restriction. */
1157 ovs_be16 flags; /* One of OFPFF_*. */
1158 ovs_be16 match_len; /* Size of nx_match. */
1159 uint8_t pad[6]; /* Align to 64-bits. */
1161 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1162 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1163 * all-zero bytes, then
1164 * - Actions to fill out the remainder of the message length (always a
1168 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
1170 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1171 struct nx_flow_removed {
1172 struct nicira_header nxh;
1173 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1174 ovs_be16 priority; /* Priority level of flow entry. */
1175 uint8_t reason; /* One of OFPRR_*. */
1176 uint8_t pad[1]; /* Align to 32-bits. */
1177 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
1178 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
1180 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
1181 ovs_be16 match_len; /* Size of nx_match. */
1182 ovs_be64 packet_count;
1183 ovs_be64 byte_count;
1185 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1186 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1187 * all-zero bytes. */
1189 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
1191 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1193 struct nx_flow_stats_request {
1194 struct nicira_stats_msg nsm;
1195 ovs_be16 out_port; /* Require matching entries to include this
1196 as an output port. A value of OFPP_NONE
1197 indicates no restriction. */
1198 ovs_be16 match_len; /* Length of nx_match. */
1199 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1200 or 0xff for all tables. */
1201 uint8_t pad[3]; /* Align to 64 bits. */
1203 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1204 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1205 * all-zero bytes, which must also exactly fill out the length of the
1209 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
1211 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1212 * OFPST_FLOW reply). */
1213 struct nx_flow_stats {
1214 ovs_be16 length; /* Length of this entry. */
1215 uint8_t table_id; /* ID of table flow came from. */
1217 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
1218 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
1219 beyond duration_sec. */
1220 ovs_be16 priority; /* Priority of the entry. Only meaningful
1221 when this is not an exact-match entry. */
1222 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
1223 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
1224 ovs_be16 match_len; /* Length of nx_match. */
1225 uint8_t pad2[4]; /* Align to 64 bits. */
1226 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1227 ovs_be64 packet_count; /* Number of packets in flow. */
1228 ovs_be64 byte_count; /* Number of bytes in flow. */
1230 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1231 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1232 * all-zero bytes, then
1233 * - Actions to fill out the remainder 'length' bytes (always a multiple
1237 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1239 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1240 * OFPST_AGGREGATE request). */
1241 struct nx_aggregate_stats_request {
1242 struct nicira_stats_msg nsm;
1243 ovs_be16 out_port; /* Require matching entries to include this
1244 as an output port. A value of OFPP_NONE
1245 indicates no restriction. */
1246 ovs_be16 match_len; /* Length of nx_match. */
1247 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1248 or 0xff for all tables. */
1249 uint8_t pad[3]; /* Align to 64 bits. */
1251 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1252 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1253 * all-zero bytes, which must also exactly fill out the length of the
1257 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1259 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1260 * OFPST_AGGREGATE reply).
1262 * ofp_aggregate_stats_reply does not contain an ofp_match structure, so we
1263 * reuse it entirely. (It would be very odd to use OFPST_AGGREGATE to reply to
1264 * an NXST_AGGREGATE request, so we don't do that.) */
1265 struct nx_aggregate_stats_reply {
1266 struct nicira_stats_msg nsm;
1267 struct ofp_aggregate_stats_reply asr;
1269 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1271 #endif /* openflow/nicira-ext.h */