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_header header; /* OFPT_STATS_REQUEST or OFPT_STATS_REPLY. */
158 ovs_be16 type; /* OFPST_VENDOR. */
159 ovs_be16 flags; /* OFPSF_{REQ,REPLY}_*. */
160 ovs_be32 vendor; /* NX_VENDOR_ID. */
161 ovs_be32 subtype; /* One of NXST_* below. */
162 uint8_t pad[4]; /* Align to 64-bits. */
164 OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
166 /* Values for the 'subtype' member of struct nicira_stats_msg. */
167 enum nicira_stats_type {
168 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
169 NXST_FLOW, /* Analogous to OFPST_FLOW. */
170 NXST_AGGREGATE /* Analogous to OFPST_AGGREGATE. */
173 /* This command enables or disables an Open vSwitch extension that allows a
174 * controller to specify the OpenFlow table to which a flow should be added,
175 * instead of having the switch decide which table is most appropriate as
176 * required by OpenFlow 1.0. By default, the extension is disabled.
178 * When this feature is enabled, Open vSwitch treats struct ofp_flow_mod's
179 * 16-bit 'command' member as two separate fields. The upper 8 bits are used
180 * as the table ID, the lower 8 bits specify the command as usual. A table ID
181 * of 0xff is treated like a wildcarded table ID.
183 * The specific treatment of the table ID depends on the type of flow mod:
185 * - OFPFC_ADD: Given a specific table ID, the flow is always placed in that
186 * table. If an identical flow already exists in that table only, then it
187 * is replaced. If the flow cannot be placed in the specified table,
188 * either because the table is full or because the table cannot support
189 * flows of the given type, the switch replies with an
190 * OFPFMFC_ALL_TABLES_FULL error. (A controller can distinguish these
191 * cases by comparing the current and maximum number of entries reported
192 * in ofp_table_stats.)
194 * If the table ID is wildcarded, the switch picks an appropriate table
195 * itself. If an identical flow already exist in the selected flow table,
196 * then it is replaced. The choice of table might depend on the flows
197 * that are already in the switch; for example, if one table fills up then
198 * the switch might fall back to another one.
200 * - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows
201 * within that table are matched and modified or deleted. If the table ID
202 * is wildcarded, flows within any table may be matched and modified or
205 * - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID,
206 * only a flow within that table may be matched and modified or deleted.
207 * If the table ID is wildcarded and exactly one flow within any table
208 * matches, then it is modified or deleted; if flows in more than one
209 * table match, then none is modified or deleted.
211 struct nxt_flow_mod_table_id {
212 struct ofp_header header;
213 uint32_t vendor; /* NX_VENDOR_ID. */
214 uint32_t subtype; /* NXT_FLOW_MOD_TABLE_ID. */
215 uint8_t set; /* Nonzero to enable, zero to disable. */
218 OFP_ASSERT(sizeof(struct nxt_flow_mod_table_id) == 24);
220 /* Configures the "role" of the sending controller. The default role is:
222 * - Other (NX_ROLE_OTHER), which allows the controller access to all
225 * The other possible roles are a related pair:
227 * - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
228 * be at most one Master controller at a time: when a controller
229 * configures itself as Master, any existing Master is demoted to the
232 * - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
233 * OpenFlow features. In particular attempts to modify the flow table
234 * will be rejected with an OFPBRC_EPERM error.
236 * Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
237 * messages, but they do receive OFPT_PORT_STATUS messages.
239 struct nx_role_request {
240 struct nicira_header nxh;
241 ovs_be32 role; /* One of NX_ROLE_*. */
245 NX_ROLE_OTHER, /* Default role, full access. */
246 NX_ROLE_MASTER, /* Full access, at most one. */
247 NX_ROLE_SLAVE /* Read-only access. */
250 /* Nicira vendor flow actions. */
252 enum nx_action_subtype {
253 NXAST_SNAT__OBSOLETE, /* No longer used. */
254 NXAST_RESUBMIT, /* struct nx_action_resubmit */
255 NXAST_SET_TUNNEL, /* struct nx_action_set_tunnel */
256 NXAST_DROP_SPOOFED_ARP__OBSOLETE,
257 NXAST_SET_QUEUE, /* struct nx_action_set_queue */
258 NXAST_POP_QUEUE, /* struct nx_action_pop_queue */
259 NXAST_REG_MOVE, /* struct nx_action_reg_move */
260 NXAST_REG_LOAD, /* struct nx_action_reg_load */
261 NXAST_NOTE, /* struct nx_action_note */
262 NXAST_SET_TUNNEL64, /* struct nx_action_set_tunnel64 */
263 NXAST_MULTIPATH, /* struct nx_action_multipath */
264 NXAST_AUTOPATH /* struct nx_action_autopath */
267 /* Header for Nicira-defined actions. */
268 struct nx_action_header {
269 ovs_be16 type; /* OFPAT_VENDOR. */
270 ovs_be16 len; /* Length is 16. */
271 ovs_be32 vendor; /* NX_VENDOR_ID. */
272 ovs_be16 subtype; /* NXAST_*. */
275 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
277 /* Action structure for NXAST_RESUBMIT.
279 * NXAST_RESUBMIT searches the flow table again, using a flow that is slightly
280 * modified from the original lookup:
282 * - The 'in_port' member of struct nx_action_resubmit is used as the flow's
285 * - If NXAST_RESUBMIT is preceded by actions that affect the flow
286 * (e.g. OFPAT_SET_VLAN_VID), then the flow is updated with the new
289 * Following the lookup, the original in_port is restored.
291 * If the modified flow matched in the flow table, then the corresponding
292 * actions are executed. Afterward, actions following NXAST_RESUBMIT in the
293 * original set of actions, if any, are executed; any changes made to the
294 * packet (e.g. changes to VLAN) by secondary actions persist when those
295 * actions are executed, although the original in_port is restored.
297 * NXAST_RESUBMIT may be used any number of times within a set of actions.
299 * NXAST_RESUBMIT may nest to an implementation-defined depth. Beyond this
300 * implementation-defined depth, further NXAST_RESUBMIT actions are simply
301 * ignored. (Open vSwitch 1.0.1 and earlier did not support recursion.)
303 struct nx_action_resubmit {
304 ovs_be16 type; /* OFPAT_VENDOR. */
305 ovs_be16 len; /* Length is 16. */
306 ovs_be32 vendor; /* NX_VENDOR_ID. */
307 ovs_be16 subtype; /* NXAST_RESUBMIT. */
308 ovs_be16 in_port; /* New in_port for checking flow table. */
311 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
313 /* Action structure for NXAST_SET_TUNNEL.
315 * Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32
316 * bits of the tunnel ID are set to 0. */
317 struct nx_action_set_tunnel {
318 ovs_be16 type; /* OFPAT_VENDOR. */
319 ovs_be16 len; /* Length is 16. */
320 ovs_be32 vendor; /* NX_VENDOR_ID. */
321 ovs_be16 subtype; /* NXAST_SET_TUNNEL. */
323 ovs_be32 tun_id; /* Tunnel ID. */
325 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
327 /* Action structure for NXAST_SET_TUNNEL64.
329 * Sets the encapsulating tunnel ID to a 64-bit value. */
330 struct nx_action_set_tunnel64 {
331 ovs_be16 type; /* OFPAT_VENDOR. */
332 ovs_be16 len; /* Length is 16. */
333 ovs_be32 vendor; /* NX_VENDOR_ID. */
334 ovs_be16 subtype; /* NXAST_SET_TUNNEL64. */
336 ovs_be64 tun_id; /* Tunnel ID. */
338 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
340 /* Action structure for NXAST_SET_QUEUE.
342 * Set the queue that should be used when packets are output. This is similar
343 * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
344 * an argument. This allows the queue to be defined before the port is
346 struct nx_action_set_queue {
347 ovs_be16 type; /* OFPAT_VENDOR. */
348 ovs_be16 len; /* Length is 16. */
349 ovs_be32 vendor; /* NX_VENDOR_ID. */
350 ovs_be16 subtype; /* NXAST_SET_QUEUE. */
352 ovs_be32 queue_id; /* Where to enqueue packets. */
354 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
356 /* Action structure for NXAST_POP_QUEUE.
358 * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
359 * were used. Only the original queue can be restored this way; no stack is
361 struct nx_action_pop_queue {
362 ovs_be16 type; /* OFPAT_VENDOR. */
363 ovs_be16 len; /* Length is 16. */
364 ovs_be32 vendor; /* NX_VENDOR_ID. */
365 ovs_be16 subtype; /* NXAST_POP_QUEUE. */
368 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
370 /* Action structure for NXAST_REG_MOVE.
372 * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
373 * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
374 * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
375 * the next most significant bit, and so on.
377 * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
378 * sense to use nxm_hasmask=1 because the action does not do any kind of
379 * matching; it uses the actual value of a field.)
381 * The following nxm_header values are potentially acceptable as 'src':
404 * - NXM_NX_ICMPV6_TYPE
405 * - NXM_NX_ICMPV6_CODE
408 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
410 * The following nxm_header values are potentially acceptable as 'dst':
412 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
414 * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
415 * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
416 * header (if any), ignoring the other bits. Setting a value with CFI=1
417 * adds or modifies the 802.1Q header appropriately, setting the TCI field
418 * to the field's new value (with the CFI bit masked out).
420 * - NXM_NX_TUN_ID. Modifying this value modifies the tunnel ID used for the
421 * packet's next tunnel encapsulation.
423 * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
424 * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
425 * used only if the flow's nx_match includes an nxm_entry that specifies
426 * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
428 * The switch will reject actions for which src_ofs+n_bits is greater than the
429 * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
430 * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
432 struct nx_action_reg_move {
433 ovs_be16 type; /* OFPAT_VENDOR. */
434 ovs_be16 len; /* Length is 16. */
435 ovs_be32 vendor; /* NX_VENDOR_ID. */
436 ovs_be16 subtype; /* NXAST_REG_MOVE. */
437 ovs_be16 n_bits; /* Number of bits. */
438 ovs_be16 src_ofs; /* Starting bit offset in source. */
439 ovs_be16 dst_ofs; /* Starting bit offset in destination. */
440 ovs_be32 src; /* Source register. */
441 ovs_be32 dst; /* Destination register. */
443 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
445 /* Action structure for NXAST_REG_LOAD.
447 * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
448 * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
449 * starts at 0 for the least-significant bit, 1 for the next most significant
452 * 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for
453 * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
456 * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
457 * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
458 * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
459 * also stored as one less than its true value:
462 * +------------------------------+------------------+
463 * | ofs | n_bits - 1 |
464 * +------------------------------+------------------+
466 * The switch will reject actions for which ofs+n_bits is greater than the
467 * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
468 * greater are set to 1, with error type OFPET_BAD_ACTION, code
469 * OFPBAC_BAD_ARGUMENT.
471 struct nx_action_reg_load {
472 ovs_be16 type; /* OFPAT_VENDOR. */
473 ovs_be16 len; /* Length is 16. */
474 ovs_be32 vendor; /* NX_VENDOR_ID. */
475 ovs_be16 subtype; /* NXAST_REG_LOAD. */
476 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
477 ovs_be32 dst; /* Destination register. */
478 ovs_be64 value; /* Immediate value. */
480 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
482 /* Action structure for NXAST_NOTE.
484 * This action has no effect. It is variable length. The switch does not
485 * attempt to interpret the user-defined 'note' data in any way. A controller
486 * can use this action to attach arbitrary metadata to a flow.
488 * This action might go away in the future.
490 struct nx_action_note {
491 ovs_be16 type; /* OFPAT_VENDOR. */
492 ovs_be16 len; /* A multiple of 8, but at least 16. */
493 ovs_be32 vendor; /* NX_VENDOR_ID. */
494 ovs_be16 subtype; /* NXAST_NOTE. */
495 uint8_t note[6]; /* Start of user-defined data. */
496 /* Possibly followed by additional user-defined data. */
498 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
500 /* Action structure for NXAST_MULTIPATH.
502 * This action performs the following steps in sequence:
504 * 1. Hashes the fields designated by 'fields', one of NX_MP_FIELDS_*.
505 * Refer to the definition of "enum nx_mp_fields" for details.
507 * The 'basis' value is used as a universal hash parameter, that is,
508 * different values of 'basis' yield different hash functions. The
509 * particular universal hash function used is implementation-defined.
511 * The hashed fields' values are drawn from the current state of the
512 * flow, including all modifications that have been made by actions up to
515 * 2. Applies the multipath link choice algorithm specified by 'algorithm',
516 * one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm"
519 * The output of the algorithm is 'link', an unsigned integer less than
520 * or equal to 'max_link'.
522 * Some algorithms use 'arg' as an additional argument.
524 * 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of
525 * 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
526 * action, except that 'dst' must be NXM_NX_REG(idx) for 'idx' in the
527 * switch's supported range.
529 * The switch will reject actions that have an unknown 'fields', or an unknown
530 * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
531 * in which 'max_link' is greater than or equal to 2**n_bits, with error type
532 * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
534 struct nx_action_multipath {
535 ovs_be16 type; /* OFPAT_VENDOR. */
536 ovs_be16 len; /* Length is 32. */
537 ovs_be32 vendor; /* NX_VENDOR_ID. */
538 ovs_be16 subtype; /* NXAST_MULTIPATH. */
540 /* What fields to hash and how. */
541 ovs_be16 fields; /* One of NX_MP_FIELDS_*. */
542 ovs_be16 basis; /* Universal hash parameter. */
545 /* Multipath link choice algorithm to apply to hash value. */
546 ovs_be16 algorithm; /* One of NX_MP_ALG_*. */
547 ovs_be16 max_link; /* Number of output links, minus 1. */
548 ovs_be32 arg; /* Algorithm-specific argument. */
551 /* Where to store the result. */
552 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
553 ovs_be32 dst; /* Destination register. */
555 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
557 /* NXAST_MULTIPATH: Fields to hash. */
559 /* Ethernet source address (NXM_OF_ETH_SRC) only. */
560 NX_MP_FIELDS_ETH_SRC,
562 /* L2 through L4, symmetric across src/dst. Specifically, each of the
563 * following fields, if present, is hashed (slashes separate symmetric
566 * - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
568 * - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
570 * - NXM_OF_IP_SRC / NXM_OF_IP_DST
571 * - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
572 * - NXM_OF_UDP_SRC / NXM_OF_UDP_DST
574 NX_MP_FIELDS_SYMMETRIC_L4
577 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
579 * In the descriptions below, 'n_links' is max_link + 1. */
580 enum nx_mp_algorithm {
581 /* link = hash(flow) % n_links.
583 * Redistributes all traffic when n_links changes. O(1) performance. See
586 * Use UINT16_MAX for max_link to get a raw hash value. */
589 /* link = hash(flow) / (MAX_HASH / n_links).
591 * Redistributes between one-quarter and one-half of traffic when n_links
592 * changes. O(1) performance. See RFC 2992.
594 NX_MP_ALG_HASH_THRESHOLD,
596 /* for i in [0,n_links):
597 * weights[i] = hash(flow, i)
598 * link = { i such that weights[i] >= weights[j] for all j != i }
600 * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
601 * performance. If n_links is greater than a threshold (currently 64, but
602 * subject to change), Open vSwitch will substitute another algorithm
603 * automatically. See RFC 2992. */
604 NX_MP_ALG_HRW, /* Highest Random Weight. */
609 * link = hash(flow, i) % arg
610 * while link > max_link
612 * Redistributes 1/n_links of traffic when n_links changes. O(1)
613 * performance when arg/max_link is bounded by a constant.
615 * Redistributes all traffic when arg changes.
617 * arg must be greater than max_link and for best performance should be no
618 * more than approximately max_link * 2. If arg is outside the acceptable
619 * range, Open vSwitch will automatically substitute the least power of 2
620 * greater than max_link.
622 * This algorithm is specific to Open vSwitch.
624 NX_MP_ALG_ITER_HASH /* Iterative Hash. */
627 /* Action structure for NXAST_AUTOPATH.
629 * This action performs the following steps in sequence:
631 * 1. Hashes the flow using an implementation-defined hash function.
633 * The hashed fields' values are drawn from the current state of the
634 * flow, including all modifications that have been made by actions up to
637 * 2. Selects an OpenFlow 'port'.
639 * 'port' is selected in an implementation-defined manner, taking into
640 * account 'id' and the hash value calculated in step 1.
642 * Generally a switch will have been configured with a set of ports that
643 * may be chosen given 'id'. The switch may take into account any number
644 * of factors when choosing 'port' from its configured set. Factors may
645 * include carrier, load, and the results of configuration protocols such
648 * 3. Stores 'port' in dst[ofs:ofs+n_bits].
650 * The format and semantics of 'dst' and 'ofs_nbits' are similar to those
651 * for the NXAST_REG_LOAD action, except that 'dst' must be
652 * NXM_NX_REG(idx) for 'idx' in the switch's supported range.
654 * The switch will reject actions in which ofs+n_bits is greater than the width
655 * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
657 struct nx_action_autopath {
658 ovs_be16 type; /* OFPAT_VENDOR. */
659 ovs_be16 len; /* Length is 20. */
660 ovs_be32 vendor; /* NX_VENDOR_ID. */
661 ovs_be16 subtype; /* NXAST_MULTIPATH. */
663 /* Where to store the result. */
664 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
665 ovs_be32 dst; /* Destination register. */
667 ovs_be32 id; /* Autopath ID. */
670 OFP_ASSERT(sizeof(struct nx_action_autopath) == 24);
672 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
674 * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches. This
675 * structure is fixed-length and hence difficult to extend. This section
676 * describes a more flexible, variable-length flow match, called "nx_match" for
677 * short, that is also supported by Open vSwitch. This section also defines a
678 * replacement for each OpenFlow message that includes struct ofp_match.
684 * An nx_match is a sequence of zero or more "nxm_entry"s, which are
685 * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
686 * "nxm_entry"s are not aligned on or padded to any multibyte boundary. The
687 * first 4 bytes of an nxm_entry are its "header", followed by the entry's
690 * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
692 * |<-------------------- nxm_type ------------------>|
695 * +----------------------------------+---------------+--+------------------+
696 * | nxm_vendor | nxm_field |hm| nxm_length |
697 * +----------------------------------+---------------+--+------------------+
699 * The most-significant 23 bits of the header are collectively "nxm_type".
700 * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
701 * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
702 * designates a protocol header, such as the Ethernet type, but it can also
703 * refer to packet metadata, such as the switch port on which a packet arrived.
705 * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
706 * of this bit is explained later.
708 * The least-significant 8 bits are "nxm_length", a positive integer. The
709 * length of the nxm_entry, including the header, is exactly 4 + nxm_length
712 * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
713 * constant. It is included only to allow software to minimally parse
714 * "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor,
715 * nxm_field, and nxm_length, nxm_hasmask is a constant.)
721 * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
723 * An nxm_entry places a constraint on the packets matched by the nx_match:
725 * - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
726 * field, called "nxm_value". The nx_match matches only packets in which
727 * the field equals nxm_value.
729 * - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
730 * field (nxm_value), followed by a bitmask of the same length as the
731 * value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
732 * nx_match matches only packets for which bit J in the given field's value
733 * matches bit J in nxm_value. A 0-bit in nxm_mask causes the
734 * corresponding bits in nxm_value and the field's value to be ignored.
735 * (The sense of the nxm_mask bits is the opposite of that used by the
736 * "wildcards" member of struct ofp_match.)
738 * When nxm_hasmask is 1, nxm_length is always even.
740 * An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
741 * entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for
744 * When there are multiple "nxm_entry"s, all of the constraints must be met.
750 * Masks may be restricted:
752 * - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
753 * must always be 0 when these fields are specified. For example, the
754 * field that identifies the port on which a packet was received may not be
757 * - Some nxm_types that do support masked wildcards may only support certain
758 * nxm_mask patterns. For example, fields that have IPv4 address values
759 * may be restricted to CIDR masks.
761 * These restrictions should be noted in specifications for individual fields.
762 * A switch may accept an nxm_hasmask or nxm_mask value that the specification
763 * disallows, if the switch correctly implements support for that nxm_hasmask
764 * or nxm_mask value. A switch must reject an attempt to set up a flow that
765 * contains a nxm_hasmask or nxm_mask value that it does not support.
768 * Prerequisite Restrictions
769 * =========================
771 * The presence of an nxm_entry with a given nxm_type may be restricted based
772 * on the presence of or values of other "nxm_entry"s. For example:
774 * - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
775 * preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
776 * and nxm_value=0x0800. That is, matching on the IP source address is
777 * allowed only if the Ethernet type is explicitly set to IP.
779 * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is preced
780 * by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
781 * nxm_value=0x0800 and another with nxm_type=NXM_OF_IP_PROTO,
782 * nxm_hasmask=0, nxm_value=6, in that order. That is, matching on the TCP
783 * source port is allowed only if the Ethernet type is IP and the IP
786 * These restrictions should be noted in specifications for individual fields.
787 * A switch may implement relaxed versions of these restrictions. A switch
788 * must reject an attempt to set up a flow that violates its restrictions.
791 * Ordering Restrictions
792 * =====================
794 * An nxm_entry that has prerequisite restrictions must appear after the
795 * "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an
796 * nx_match is not otherwise constrained.
798 * Any given nxm_type may appear in an nx_match at most once.
804 * These examples show the format of a single nxm_entry with particular
805 * nxm_hasmask and nxm_length values. The diagrams are labeled with field
806 * numbers and byte indexes.
809 * 8-bit nxm_value, nxm_hasmask=1, nxm_length=1:
812 * +------------+---+---+
814 * +------------+---+---+
817 * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
820 * +------------+------+
822 * +------------+------+
825 * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
828 * +------------+-------------+
829 * | header | nxm_value |
830 * +------------+-------------+
833 * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
836 * +------------+------------------+
837 * | header | nxm_value |
838 * +------------+------------------+
841 * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
844 * +------------+------------------+------------------+
845 * | header | nxm_value | nxm_mask |
846 * +------------+------------------+------------------+
852 * A switch should report an error in an nx_match using error type
853 * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch
854 * should report a specific error code, if one is assigned for the particular
855 * problem, but NXBRC_NXM_INVALID is also available to report a generic
859 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
860 (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
861 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
862 NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
863 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
864 NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
865 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
866 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
867 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
868 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
869 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
871 #define NXM_MAKE_WILD_HEADER(HEADER) \
872 NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
874 /* ## ------------------------------- ## */
875 /* ## OpenFlow 1.0-compatible fields. ## */
876 /* ## ------------------------------- ## */
878 /* Physical or virtual port on which the packet was received.
882 * Format: 16-bit integer in network byte order.
884 * Masking: Not maskable. */
885 #define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
887 /* Source or destination address in Ethernet header.
891 * Format: 48-bit Ethernet MAC address.
893 * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
894 * be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
895 * are all-0-bits or all-1-bits). Support for other patterns and for masking
896 * of NXM_OF_ETH_SRC is optional. */
897 #define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
898 #define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
899 #define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
901 /* Packet's Ethernet type.
903 * For an Ethernet II packet this is taken from the Ethernet header. For an
904 * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
905 * A packet that has neither format has value 0x05ff
906 * (OFP_DL_TYPE_NOT_ETH_TYPE).
908 * For a packet with an 802.1Q header, this is the type of the encapsulated
913 * Format: 16-bit integer in network byte order.
915 * Masking: Not maskable. */
916 #define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
920 * For a packet with an 802.1Q header, this is the Tag Control Information
921 * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
922 * header, this has value 0.
926 * Format: 16-bit integer in network byte order.
928 * Masking: Arbitrary masks.
930 * This field can be used in various ways:
932 * - If it is not constrained at all, the nx_match matches packets without
933 * an 802.1Q header or with an 802.1Q header that has any TCI value.
935 * - Testing for an exact match with 0 matches only packets without an
938 * - Testing for an exact match with a TCI value with CFI=1 matches packets
939 * that have an 802.1Q header with a specified VID and PCP.
941 * - Testing for an exact match with a nonzero TCI value with CFI=0 does
942 * not make sense. The switch may reject this combination.
944 * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
945 * packets that have an 802.1Q header with that VID (and any PCP).
947 * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
948 * packets that have an 802.1Q header with that PCP (and any VID).
950 * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
951 * header or with an 802.1Q header with a VID of 0.
953 * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
954 * header or with an 802.1Q header with a PCP of 0.
956 * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
957 * header or with an 802.1Q header with both VID and PCP of 0.
959 #define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
960 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
962 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
964 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
966 * Format: 8-bit integer with 2 least-significant bits forced to 0.
968 * Masking: Not maskable. */
969 #define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
971 /* The "protocol" byte in the IP header.
973 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
975 * Format: 8-bit integer.
977 * Masking: Not maskable. */
978 #define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
980 /* The source or destination address in the IP header.
982 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
984 * Format: 32-bit integer in network byte order.
986 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
987 * high-order bits set to 1 and the other 32-N bits set to 0. */
988 #define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
989 #define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
990 #define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
991 #define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
993 /* The source or destination port in the TCP header.
996 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
997 * NXM_OF_IP_PROTO must match 6 exactly.
999 * Format: 16-bit integer in network byte order.
1001 * Masking: Not maskable. */
1002 #define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
1003 #define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
1005 /* The source or destination port in the UDP header.
1008 * NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1009 * NXM_OF_IP_PROTO must match 17 exactly.
1011 * Format: 16-bit integer in network byte order.
1013 * Masking: Not maskable. */
1014 #define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
1015 #define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
1017 /* The type or code in the ICMP header.
1020 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
1021 * NXM_OF_IP_PROTO must match 1 exactly.
1023 * Format: 8-bit integer.
1025 * Masking: Not maskable. */
1026 #define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
1027 #define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
1031 * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
1032 * otherwise. Only ARP opcodes between 1 and 255 should be specified for
1035 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1037 * Format: 16-bit integer in network byte order.
1039 * Masking: Not maskable. */
1040 #define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
1042 /* For an Ethernet+IP ARP packet, the source or target protocol address
1043 * in the ARP header. Always 0 otherwise.
1045 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1047 * Format: 32-bit integer in network byte order.
1049 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1050 * high-order bits set to 1 and the other 32-N bits set to 0. */
1051 #define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
1052 #define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
1053 #define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
1054 #define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
1056 /* ## ------------------------ ## */
1057 /* ## Nicira match extensions. ## */
1058 /* ## ------------------------ ## */
1060 /* Metadata registers.
1062 * Registers initially have value 0. Actions allow register values to be
1067 * Format: Array of 32-bit integer registers. Space is reserved for up to
1068 * NXM_NX_MAX_REGS registers, but switches may implement fewer.
1070 * Masking: Arbitrary masks. */
1071 #define NXM_NX_MAX_REGS 16
1072 #define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
1073 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1074 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1075 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1076 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1077 #define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
1078 #define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
1079 #define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
1080 #define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
1081 #define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
1082 #define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
1083 #define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
1084 #define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
1088 * For a packet received via GRE tunnel including a (32-bit) key, the key is
1089 * stored in the low 32-bits and the high bits are zeroed. For other packets,
1094 * Format: 64-bit integer in network byte order.
1096 * Masking: Arbitrary masks. */
1097 #define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
1098 #define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
1100 /* For an Ethernet+IP ARP packet, the source or target hardware address
1101 * in the ARP header. Always 0 otherwise.
1103 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1105 * Format: 48-bit Ethernet MAC address.
1107 * Masking: Not maskable. */
1108 #define NXM_NX_ARP_SHA NXM_HEADER (0x0001, 17, 6)
1109 #define NXM_NX_ARP_THA NXM_HEADER (0x0001, 18, 6)
1111 /* The source or destination address in the IPv6 header.
1113 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1115 * Format: 128-bit IPv6 address.
1117 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1118 * high-order bits set to 1 and the other 128-N bits set to 0. */
1119 #define NXM_NX_IPV6_SRC NXM_HEADER (0x0001, 19, 16)
1120 #define NXM_NX_IPV6_SRC_W NXM_HEADER_W(0x0001, 19, 16)
1121 #define NXM_NX_IPV6_DST NXM_HEADER (0x0001, 20, 16)
1122 #define NXM_NX_IPV6_DST_W NXM_HEADER_W(0x0001, 20, 16)
1124 /* The type or code in the ICMPv6 header.
1127 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1128 * NXM_OF_IP_PROTO must match 58 exactly.
1130 * Format: 8-bit integer.
1132 * Masking: Not maskable. */
1133 #define NXM_NX_ICMPV6_TYPE NXM_HEADER (0x0001, 21, 1)
1134 #define NXM_NX_ICMPV6_CODE NXM_HEADER (0x0001, 22, 1)
1136 /* The target address in an IPv6 Neighbor Discovery message.
1139 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1140 * NXM_OF_IP_PROTO must match 58 exactly.
1141 * NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1143 * Format: 128-bit IPv6 address.
1145 * Masking: Not maskable. */
1146 #define NXM_NX_ND_TARGET NXM_HEADER (0x0001, 23, 16)
1148 /* The source link-layer address option in an IPv6 Neighbor Discovery
1152 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1153 * NXM_OF_IP_PROTO must match 58 exactly.
1154 * NXM_OF_ICMPV6_TYPE must be exactly 135.
1156 * Format: 48-bit Ethernet MAC address.
1158 * Masking: Not maskable. */
1159 #define NXM_NX_ND_SLL NXM_HEADER (0x0001, 24, 6)
1161 /* The target link-layer address option in an IPv6 Neighbor Discovery
1165 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1166 * NXM_OF_IP_PROTO must match 58 exactly.
1167 * NXM_OF_ICMPV6_TYPE must be exactly 136.
1169 * Format: 48-bit Ethernet MAC address.
1171 * Masking: Not maskable. */
1172 #define NXM_NX_ND_TLL NXM_HEADER (0x0001, 25, 6)
1175 /* ## --------------------- ## */
1176 /* ## Requests and replies. ## */
1177 /* ## --------------------- ## */
1179 enum nx_flow_format {
1180 NXFF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
1181 NXFF_NXM = 2 /* Nicira extended match. */
1184 /* NXT_SET_FLOW_FORMAT request. */
1185 struct nxt_set_flow_format {
1186 struct ofp_header header;
1187 ovs_be32 vendor; /* NX_VENDOR_ID. */
1188 ovs_be32 subtype; /* NXT_SET_FLOW_FORMAT. */
1189 ovs_be32 format; /* One of NXFF_*. */
1191 OFP_ASSERT(sizeof(struct nxt_set_flow_format) == 20);
1193 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */
1194 struct nx_flow_mod {
1195 struct nicira_header nxh;
1196 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1197 ovs_be16 command; /* One of OFPFC_*. */
1198 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
1199 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
1200 ovs_be16 priority; /* Priority level of flow entry. */
1201 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
1202 Not meaningful for OFPFC_DELETE*. */
1203 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
1204 matching entries to include this as an
1205 output port. A value of OFPP_NONE
1206 indicates no restriction. */
1207 ovs_be16 flags; /* One of OFPFF_*. */
1208 ovs_be16 match_len; /* Size of nx_match. */
1209 uint8_t pad[6]; /* Align to 64-bits. */
1211 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1212 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1213 * all-zero bytes, then
1214 * - Actions to fill out the remainder of the message length (always a
1218 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
1220 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1221 struct nx_flow_removed {
1222 struct nicira_header nxh;
1223 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1224 ovs_be16 priority; /* Priority level of flow entry. */
1225 uint8_t reason; /* One of OFPRR_*. */
1226 uint8_t pad[1]; /* Align to 32-bits. */
1227 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
1228 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
1230 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
1231 ovs_be16 match_len; /* Size of nx_match. */
1232 ovs_be64 packet_count;
1233 ovs_be64 byte_count;
1235 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1236 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1237 * all-zero bytes. */
1239 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
1241 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1243 struct nx_flow_stats_request {
1244 struct nicira_stats_msg nsm;
1245 ovs_be16 out_port; /* Require matching entries to include this
1246 as an output port. A value of OFPP_NONE
1247 indicates no restriction. */
1248 ovs_be16 match_len; /* Length of nx_match. */
1249 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1250 or 0xff for all tables. */
1251 uint8_t pad[3]; /* Align to 64 bits. */
1253 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1254 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1255 * all-zero bytes, which must also exactly fill out the length of the
1259 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
1261 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1262 * OFPST_FLOW reply). */
1263 struct nx_flow_stats {
1264 ovs_be16 length; /* Length of this entry. */
1265 uint8_t table_id; /* ID of table flow came from. */
1267 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
1268 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
1269 beyond duration_sec. */
1270 ovs_be16 priority; /* Priority of the entry. Only meaningful
1271 when this is not an exact-match entry. */
1272 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
1273 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
1274 ovs_be16 match_len; /* Length of nx_match. */
1275 uint8_t pad2[4]; /* Align to 64 bits. */
1276 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1277 ovs_be64 packet_count; /* Number of packets in flow. */
1278 ovs_be64 byte_count; /* Number of bytes in flow. */
1280 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1281 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1282 * all-zero bytes, then
1283 * - Actions to fill out the remainder 'length' bytes (always a multiple
1287 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1289 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1290 * OFPST_AGGREGATE request). */
1291 struct nx_aggregate_stats_request {
1292 struct nicira_stats_msg nsm;
1293 ovs_be16 out_port; /* Require matching entries to include this
1294 as an output port. A value of OFPP_NONE
1295 indicates no restriction. */
1296 ovs_be16 match_len; /* Length of nx_match. */
1297 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1298 or 0xff for all tables. */
1299 uint8_t pad[3]; /* Align to 64 bits. */
1301 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1302 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1303 * all-zero bytes, which must also exactly fill out the length of the
1307 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1309 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1310 * OFPST_AGGREGATE reply).
1312 * ofp_aggregate_stats_reply does not contain an ofp_match structure, so we
1313 * reuse it entirely. (It would be very odd to use OFPST_AGGREGATE to reply to
1314 * an NXST_AGGREGATE request, so we don't do that.) */
1315 struct nx_aggregate_stats_reply {
1316 struct nicira_stats_msg nsm;
1317 struct ofp_aggregate_stats_reply asr;
1319 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1321 #endif /* openflow/nicira-ext.h */