2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #ifndef OPENFLOW_NICIRA_EXT_H
18 #define OPENFLOW_NICIRA_EXT_H 1
20 #include "openflow/openflow.h"
21 #include "openvswitch/types.h"
23 /* The following vendor extensions, proposed by Nicira Networks, are not yet
24 * standardized, so they are not included in openflow.h. Some of them may be
25 * suitable for standardization; others we never expect to standardize. */
27 #define NX_VENDOR_ID 0x00002320
29 /* Nicira vendor-specific error messages extension.
31 * OpenFlow 1.0 has a set of predefined error types (OFPET_*) and codes (which
32 * are specific to each type). It does not have any provision for
33 * vendor-specific error codes, and it does not even provide "generic" error
34 * codes that can apply to problems not anticipated by the OpenFlow
35 * specification authors.
37 * This extension attempts to address the problem by adding a generic "error
38 * vendor extension". The extension works as follows: use NXET_VENDOR as type
39 * and NXVC_VENDOR_ERROR as code, followed by struct nx_vendor_error with
40 * vendor-specific details, followed by at least 64 bytes of the failed
43 * It would be better to have a type-specific vendor extension, e.g. so that
44 * OFPET_BAD_ACTION could be used with vendor-specific code values. But
45 * OFPET_BAD_ACTION and most other standardized types already specify that
46 * their 'data' values are (the start of) the OpenFlow message being replied
47 * to, so there is no room to insert a vendor ID.
49 * Currently this extension is only implemented by Open vSwitch, but it seems
50 * like a reasonable candidate for future standardization.
53 /* This is a random number to avoid accidental collision with any other
54 * vendor's extension. */
55 #define NXET_VENDOR 0xb0c2
57 /* ofp_error msg 'code' values for NXET_VENDOR. */
59 NXVC_VENDOR_ERROR /* 'data' contains struct nx_vendor_error. */
62 /* 'data' for 'type' == NXET_VENDOR, 'code' == NXVC_VENDOR_ERROR. */
63 struct nx_vendor_error {
64 ovs_be32 vendor; /* Vendor ID as in struct ofp_vendor_header. */
65 ovs_be16 type; /* Vendor-defined type. */
66 ovs_be16 code; /* Vendor-defined subtype. */
67 /* Followed by at least the first 64 bytes of the failed request. */
70 /* Specific Nicira extension error numbers.
72 * These are the "code" values used in nx_vendor_error. So far, the "type"
73 * values in nx_vendor_error are the same as those in ofp_error_msg. That is,
74 * at Nicira so far we've only needed additional vendor-specific 'code' values,
75 * so we're using the existing 'type' values to avoid having to invent new ones
76 * that duplicate the current ones' meanings. */
78 /* Additional "code" values for OFPET_BAD_REQUEST. */
79 enum nx_bad_request_code {
80 /* Nicira Extended Match (NXM) errors. */
82 /* Generic error code used when there is an error in an NXM sent to the
83 * switch. The switch may use one of the more specific error codes below,
84 * if there is an appropriate one, to simplify debugging, but it is not
85 * required to do so. */
86 NXBRC_NXM_INVALID = 0x100,
88 /* The nxm_type, or nxm_type taken in combination with nxm_hasmask or
89 * nxm_length or both, is invalid or not implemented. */
90 NXBRC_NXM_BAD_TYPE = 0x101,
92 /* Invalid nxm_value. */
93 NXBRC_NXM_BAD_VALUE = 0x102,
95 /* Invalid nxm_mask. */
96 NXBRC_NXM_BAD_MASK = 0x103,
98 /* A prerequisite was not met. */
99 NXBRC_NXM_BAD_PREREQ = 0x104,
101 /* A given nxm_type was specified more than once. */
102 NXBRC_NXM_DUP_TYPE = 0x105
105 /* Additional "code" values for OFPET_FLOW_MOD_FAILED. */
106 enum nx_flow_mod_failed_code {
107 /* Generic hardware error. */
108 NXFMFC_HARDWARE = 0x100,
110 /* A nonexistent table ID was specified in the "command" field of struct
111 * ofp_flow_mod, when the nxt_flow_mod_table_id extension is enabled. */
112 NXFMFC_BAD_TABLE_ID = 0x101
115 /* Nicira vendor requests and replies. */
117 /* Header for Nicira vendor requests and replies. */
118 struct nicira_header {
119 struct ofp_header header;
120 ovs_be32 vendor; /* NX_VENDOR_ID. */
121 ovs_be32 subtype; /* One of NXT_* below. */
123 OFP_ASSERT(sizeof(struct nicira_header) == 16);
125 /* Values for the 'subtype' member of struct nicira_header. */
127 /* No longer used. */
128 NXT_STATUS_REQUEST__OBSOLETE = 0,
129 NXT_STATUS_REPLY__OBSOLETE = 1,
130 NXT_ACT_SET_CONFIG__OBSOLETE = 2,
131 NXT_ACT_GET_CONFIG__OBSOLETE = 3,
132 NXT_COMMAND_REQUEST__OBSOLETE = 4,
133 NXT_COMMAND_REPLY__OBSOLETE = 5,
134 NXT_FLOW_END_CONFIG__OBSOLETE = 6,
135 NXT_FLOW_END__OBSOLETE = 7,
136 NXT_MGMT__OBSOLETE = 8,
137 NXT_TUN_ID_FROM_COOKIE__OBSOLETE = 9,
139 /* Controller role support. The request body is struct nx_role_request.
140 * The reply echos the request. */
141 NXT_ROLE_REQUEST = 10,
144 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
145 NXT_SET_FLOW_FORMAT = 12, /* Set flow format. */
146 NXT_FLOW_MOD = 13, /* Analogous to OFPT_FLOW_MOD. */
147 NXT_FLOW_REMOVED = 14, /* Analogous to OFPT_FLOW_REMOVED. */
149 /* Use the upper 8 bits of the 'command' member in struct ofp_flow_mod to
150 * designate the table to which a flow is to be added? See the big comment
151 * on struct nxt_flow_mod_table_id for more information. */
152 NXT_FLOW_MOD_TABLE_ID = 15
155 /* Header for Nicira vendor stats request and reply messages. */
156 struct nicira_stats_msg {
157 struct ofp_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
158 ovs_be32 subtype; /* One of NXST_* below. */
159 uint8_t pad[4]; /* Align to 64-bits. */
161 OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
163 /* Values for the 'subtype' member of struct nicira_stats_msg. */
164 enum nicira_stats_type {
165 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
166 NXST_FLOW, /* Analogous to OFPST_FLOW. */
167 NXST_AGGREGATE /* Analogous to OFPST_AGGREGATE. */
170 /* Fields to use when hashing flows. */
171 enum nx_hash_fields {
172 /* Ethernet source address (NXM_OF_ETH_SRC) only. */
173 NX_HASH_FIELDS_ETH_SRC,
175 /* L2 through L4, symmetric across src/dst. Specifically, each of the
176 * following fields, if present, is hashed (slashes separate symmetric
179 * - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
181 * - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
183 * - NXM_OF_IP_SRC / NXM_OF_IP_DST
184 * - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
186 NX_HASH_FIELDS_SYMMETRIC_L4
189 /* This command enables or disables an Open vSwitch extension that allows a
190 * controller to specify the OpenFlow table to which a flow should be added,
191 * instead of having the switch decide which table is most appropriate as
192 * required by OpenFlow 1.0. By default, the extension is disabled.
194 * When this feature is enabled, Open vSwitch treats struct ofp_flow_mod's
195 * 16-bit 'command' member as two separate fields. The upper 8 bits are used
196 * as the table ID, the lower 8 bits specify the command as usual. A table ID
197 * of 0xff is treated like a wildcarded table ID.
199 * The specific treatment of the table ID depends on the type of flow mod:
201 * - OFPFC_ADD: Given a specific table ID, the flow is always placed in that
202 * table. If an identical flow already exists in that table only, then it
203 * is replaced. If the flow cannot be placed in the specified table,
204 * either because the table is full or because the table cannot support
205 * flows of the given type, the switch replies with an
206 * OFPFMFC_ALL_TABLES_FULL error. (A controller can distinguish these
207 * cases by comparing the current and maximum number of entries reported
208 * in ofp_table_stats.)
210 * If the table ID is wildcarded, the switch picks an appropriate table
211 * itself. If an identical flow already exist in the selected flow table,
212 * then it is replaced. The choice of table might depend on the flows
213 * that are already in the switch; for example, if one table fills up then
214 * the switch might fall back to another one.
216 * - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows
217 * within that table are matched and modified or deleted. If the table ID
218 * is wildcarded, flows within any table may be matched and modified or
221 * - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID,
222 * only a flow within that table may be matched and modified or deleted.
223 * If the table ID is wildcarded and exactly one flow within any table
224 * matches, then it is modified or deleted; if flows in more than one
225 * table match, then none is modified or deleted.
227 struct nxt_flow_mod_table_id {
228 struct ofp_header header;
229 uint32_t vendor; /* NX_VENDOR_ID. */
230 uint32_t subtype; /* NXT_FLOW_MOD_TABLE_ID. */
231 uint8_t set; /* Nonzero to enable, zero to disable. */
234 OFP_ASSERT(sizeof(struct nxt_flow_mod_table_id) == 24);
236 /* Configures the "role" of the sending controller. The default role is:
238 * - Other (NX_ROLE_OTHER), which allows the controller access to all
241 * The other possible roles are a related pair:
243 * - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
244 * be at most one Master controller at a time: when a controller
245 * configures itself as Master, any existing Master is demoted to the
248 * - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
249 * OpenFlow features. In particular attempts to modify the flow table
250 * will be rejected with an OFPBRC_EPERM error.
252 * Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
253 * messages, but they do receive OFPT_PORT_STATUS messages.
255 struct nx_role_request {
256 struct nicira_header nxh;
257 ovs_be32 role; /* One of NX_ROLE_*. */
261 NX_ROLE_OTHER, /* Default role, full access. */
262 NX_ROLE_MASTER, /* Full access, at most one. */
263 NX_ROLE_SLAVE /* Read-only access. */
266 /* Nicira vendor flow actions. */
268 enum nx_action_subtype {
269 NXAST_SNAT__OBSOLETE, /* No longer used. */
270 NXAST_RESUBMIT, /* struct nx_action_resubmit */
271 NXAST_SET_TUNNEL, /* struct nx_action_set_tunnel */
272 NXAST_DROP_SPOOFED_ARP__OBSOLETE,
273 NXAST_SET_QUEUE, /* struct nx_action_set_queue */
274 NXAST_POP_QUEUE, /* struct nx_action_pop_queue */
275 NXAST_REG_MOVE, /* struct nx_action_reg_move */
276 NXAST_REG_LOAD, /* struct nx_action_reg_load */
277 NXAST_NOTE, /* struct nx_action_note */
278 NXAST_SET_TUNNEL64, /* struct nx_action_set_tunnel64 */
279 NXAST_MULTIPATH, /* struct nx_action_multipath */
280 NXAST_AUTOPATH, /* struct nx_action_autopath */
281 NXAST_BUNDLE /* struct nx_action_bundle */
284 /* Header for Nicira-defined actions. */
285 struct nx_action_header {
286 ovs_be16 type; /* OFPAT_VENDOR. */
287 ovs_be16 len; /* Length is 16. */
288 ovs_be32 vendor; /* NX_VENDOR_ID. */
289 ovs_be16 subtype; /* NXAST_*. */
292 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
294 /* Action structure for NXAST_RESUBMIT.
296 * NXAST_RESUBMIT searches the flow table again, using a flow that is slightly
297 * modified from the original lookup:
299 * - The 'in_port' member of struct nx_action_resubmit is used as the flow's
302 * - If NXAST_RESUBMIT is preceded by actions that affect the flow
303 * (e.g. OFPAT_SET_VLAN_VID), then the flow is updated with the new
306 * Following the lookup, the original in_port is restored.
308 * If the modified flow matched in the flow table, then the corresponding
309 * actions are executed. Afterward, actions following NXAST_RESUBMIT in the
310 * original set of actions, if any, are executed; any changes made to the
311 * packet (e.g. changes to VLAN) by secondary actions persist when those
312 * actions are executed, although the original in_port is restored.
314 * NXAST_RESUBMIT may be used any number of times within a set of actions.
316 * NXAST_RESUBMIT may nest to an implementation-defined depth. Beyond this
317 * implementation-defined depth, further NXAST_RESUBMIT actions are simply
318 * ignored. (Open vSwitch 1.0.1 and earlier did not support recursion.)
320 struct nx_action_resubmit {
321 ovs_be16 type; /* OFPAT_VENDOR. */
322 ovs_be16 len; /* Length is 16. */
323 ovs_be32 vendor; /* NX_VENDOR_ID. */
324 ovs_be16 subtype; /* NXAST_RESUBMIT. */
325 ovs_be16 in_port; /* New in_port for checking flow table. */
328 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
330 /* Action structure for NXAST_SET_TUNNEL.
332 * Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32
333 * bits of the tunnel ID are set to 0. */
334 struct nx_action_set_tunnel {
335 ovs_be16 type; /* OFPAT_VENDOR. */
336 ovs_be16 len; /* Length is 16. */
337 ovs_be32 vendor; /* NX_VENDOR_ID. */
338 ovs_be16 subtype; /* NXAST_SET_TUNNEL. */
340 ovs_be32 tun_id; /* Tunnel ID. */
342 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
344 /* Action structure for NXAST_SET_TUNNEL64.
346 * Sets the encapsulating tunnel ID to a 64-bit value. */
347 struct nx_action_set_tunnel64 {
348 ovs_be16 type; /* OFPAT_VENDOR. */
349 ovs_be16 len; /* Length is 16. */
350 ovs_be32 vendor; /* NX_VENDOR_ID. */
351 ovs_be16 subtype; /* NXAST_SET_TUNNEL64. */
353 ovs_be64 tun_id; /* Tunnel ID. */
355 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
357 /* Action structure for NXAST_SET_QUEUE.
359 * Set the queue that should be used when packets are output. This is similar
360 * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
361 * an argument. This allows the queue to be defined before the port is
363 struct nx_action_set_queue {
364 ovs_be16 type; /* OFPAT_VENDOR. */
365 ovs_be16 len; /* Length is 16. */
366 ovs_be32 vendor; /* NX_VENDOR_ID. */
367 ovs_be16 subtype; /* NXAST_SET_QUEUE. */
369 ovs_be32 queue_id; /* Where to enqueue packets. */
371 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
373 /* Action structure for NXAST_POP_QUEUE.
375 * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
376 * were used. Only the original queue can be restored this way; no stack is
378 struct nx_action_pop_queue {
379 ovs_be16 type; /* OFPAT_VENDOR. */
380 ovs_be16 len; /* Length is 16. */
381 ovs_be32 vendor; /* NX_VENDOR_ID. */
382 ovs_be16 subtype; /* NXAST_POP_QUEUE. */
385 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
387 /* Action structure for NXAST_REG_MOVE.
389 * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
390 * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
391 * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
392 * the next most significant bit, and so on.
394 * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
395 * sense to use nxm_hasmask=1 because the action does not do any kind of
396 * matching; it uses the actual value of a field.)
398 * The following nxm_header values are potentially acceptable as 'src':
421 * - NXM_NX_ICMPV6_TYPE
422 * - NXM_NX_ICMPV6_CODE
425 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
427 * The following nxm_header values are potentially acceptable as 'dst':
429 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
431 * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
432 * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
433 * header (if any), ignoring the other bits. Setting a value with CFI=1
434 * adds or modifies the 802.1Q header appropriately, setting the TCI field
435 * to the field's new value (with the CFI bit masked out).
437 * - NXM_NX_TUN_ID. Modifying this value modifies the tunnel ID used for the
438 * packet's next tunnel encapsulation.
440 * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
441 * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
442 * used only if the flow's nx_match includes an nxm_entry that specifies
443 * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
445 * The switch will reject actions for which src_ofs+n_bits is greater than the
446 * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
447 * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
449 struct nx_action_reg_move {
450 ovs_be16 type; /* OFPAT_VENDOR. */
451 ovs_be16 len; /* Length is 16. */
452 ovs_be32 vendor; /* NX_VENDOR_ID. */
453 ovs_be16 subtype; /* NXAST_REG_MOVE. */
454 ovs_be16 n_bits; /* Number of bits. */
455 ovs_be16 src_ofs; /* Starting bit offset in source. */
456 ovs_be16 dst_ofs; /* Starting bit offset in destination. */
457 ovs_be32 src; /* Source register. */
458 ovs_be32 dst; /* Destination register. */
460 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
462 /* Action structure for NXAST_REG_LOAD.
464 * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
465 * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
466 * starts at 0 for the least-significant bit, 1 for the next most significant
469 * 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for
470 * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
473 * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
474 * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
475 * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
476 * also stored as one less than its true value:
479 * +------------------------------+------------------+
480 * | ofs | n_bits - 1 |
481 * +------------------------------+------------------+
483 * The switch will reject actions for which ofs+n_bits is greater than the
484 * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
485 * greater are set to 1, with error type OFPET_BAD_ACTION, code
486 * OFPBAC_BAD_ARGUMENT.
488 struct nx_action_reg_load {
489 ovs_be16 type; /* OFPAT_VENDOR. */
490 ovs_be16 len; /* Length is 16. */
491 ovs_be32 vendor; /* NX_VENDOR_ID. */
492 ovs_be16 subtype; /* NXAST_REG_LOAD. */
493 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
494 ovs_be32 dst; /* Destination register. */
495 ovs_be64 value; /* Immediate value. */
497 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
499 /* Action structure for NXAST_NOTE.
501 * This action has no effect. It is variable length. The switch does not
502 * attempt to interpret the user-defined 'note' data in any way. A controller
503 * can use this action to attach arbitrary metadata to a flow.
505 * This action might go away in the future.
507 struct nx_action_note {
508 ovs_be16 type; /* OFPAT_VENDOR. */
509 ovs_be16 len; /* A multiple of 8, but at least 16. */
510 ovs_be32 vendor; /* NX_VENDOR_ID. */
511 ovs_be16 subtype; /* NXAST_NOTE. */
512 uint8_t note[6]; /* Start of user-defined data. */
513 /* Possibly followed by additional user-defined data. */
515 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
517 /* Action structure for NXAST_MULTIPATH.
519 * This action performs the following steps in sequence:
521 * 1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
522 * Refer to the definition of "enum nx_mp_fields" for details.
524 * The 'basis' value is used as a universal hash parameter, that is,
525 * different values of 'basis' yield different hash functions. The
526 * particular universal hash function used is implementation-defined.
528 * The hashed fields' values are drawn from the current state of the
529 * flow, including all modifications that have been made by actions up to
532 * 2. Applies the multipath link choice algorithm specified by 'algorithm',
533 * one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm"
536 * The output of the algorithm is 'link', an unsigned integer less than
537 * or equal to 'max_link'.
539 * Some algorithms use 'arg' as an additional argument.
541 * 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of
542 * 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
543 * action, except that 'dst' must be NXM_NX_REG(idx) for 'idx' in the
544 * switch's supported range.
546 * The switch will reject actions that have an unknown 'fields', or an unknown
547 * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
548 * in which 'max_link' is greater than or equal to 2**n_bits, with error type
549 * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
551 struct nx_action_multipath {
552 ovs_be16 type; /* OFPAT_VENDOR. */
553 ovs_be16 len; /* Length is 32. */
554 ovs_be32 vendor; /* NX_VENDOR_ID. */
555 ovs_be16 subtype; /* NXAST_MULTIPATH. */
557 /* What fields to hash and how. */
558 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
559 ovs_be16 basis; /* Universal hash parameter. */
562 /* Multipath link choice algorithm to apply to hash value. */
563 ovs_be16 algorithm; /* One of NX_MP_ALG_*. */
564 ovs_be16 max_link; /* Number of output links, minus 1. */
565 ovs_be32 arg; /* Algorithm-specific argument. */
568 /* Where to store the result. */
569 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
570 ovs_be32 dst; /* Destination register. */
572 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
574 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
576 * In the descriptions below, 'n_links' is max_link + 1. */
577 enum nx_mp_algorithm {
578 /* link = hash(flow) % n_links.
580 * Redistributes all traffic when n_links changes. O(1) performance. See
583 * Use UINT16_MAX for max_link to get a raw hash value. */
586 /* link = hash(flow) / (MAX_HASH / n_links).
588 * Redistributes between one-quarter and one-half of traffic when n_links
589 * changes. O(1) performance. See RFC 2992.
591 NX_MP_ALG_HASH_THRESHOLD,
593 /* for i in [0,n_links):
594 * weights[i] = hash(flow, i)
595 * link = { i such that weights[i] >= weights[j] for all j != i }
597 * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
598 * performance. If n_links is greater than a threshold (currently 64, but
599 * subject to change), Open vSwitch will substitute another algorithm
600 * automatically. See RFC 2992. */
601 NX_MP_ALG_HRW, /* Highest Random Weight. */
606 * link = hash(flow, i) % arg
607 * while link > max_link
609 * Redistributes 1/n_links of traffic when n_links changes. O(1)
610 * performance when arg/max_link is bounded by a constant.
612 * Redistributes all traffic when arg changes.
614 * arg must be greater than max_link and for best performance should be no
615 * more than approximately max_link * 2. If arg is outside the acceptable
616 * range, Open vSwitch will automatically substitute the least power of 2
617 * greater than max_link.
619 * This algorithm is specific to Open vSwitch.
621 NX_MP_ALG_ITER_HASH /* Iterative Hash. */
624 /* Action structure for NXAST_AUTOPATH.
626 * This action performs the following steps in sequence:
628 * 1. Hashes the flow using an implementation-defined hash function.
630 * The hashed fields' values are drawn from the current state of the
631 * flow, including all modifications that have been made by actions up to
634 * 2. Selects an OpenFlow 'port'.
636 * 'port' is selected in an implementation-defined manner, taking into
637 * account 'id' and the hash value calculated in step 1.
639 * Generally a switch will have been configured with a set of ports that
640 * may be chosen given 'id'. The switch may take into account any number
641 * of factors when choosing 'port' from its configured set. Factors may
642 * include carrier, load, and the results of configuration protocols such
645 * 3. Stores 'port' in dst[ofs:ofs+n_bits].
647 * The format and semantics of 'dst' and 'ofs_nbits' are similar to those
648 * for the NXAST_REG_LOAD action, except that 'dst' must be
649 * NXM_NX_REG(idx) for 'idx' in the switch's supported range.
651 * The switch will reject actions in which ofs+n_bits is greater than the width
652 * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
654 struct nx_action_autopath {
655 ovs_be16 type; /* OFPAT_VENDOR. */
656 ovs_be16 len; /* Length is 20. */
657 ovs_be32 vendor; /* NX_VENDOR_ID. */
658 ovs_be16 subtype; /* NXAST_AUTOPATH. */
660 /* Where to store the result. */
661 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
662 ovs_be32 dst; /* Destination register. */
664 ovs_be32 id; /* Autopath ID. */
667 OFP_ASSERT(sizeof(struct nx_action_autopath) == 24);
669 /* Action structure for NXAST_BUNDLE.
671 * NXAST_BUNDLE chooses a slave from a supplied list of options, and outputs to
674 * The list of possible slaves follows the nx_action_bundle structure. The size
675 * of each slave is governed by its type as indicated by the 'slave_type'
676 * parameter. The list of slaves should be padded at its end with zeros to make
677 * the total length of the action a multiple of 8.
679 * Switches infer from the 'slave_type' parameter the size of each slave. All
680 * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
681 * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
682 * 2 byte width. Switches should reject actions which indicate unknown or
683 * unsupported slave types.
685 * Switches use a strategy dictated by the 'algorithm' parameter to choose a
686 * slave. If the switch does not support the specified 'algorithm' parameter,
687 * it should reject the action.
689 * Some slave selection strategies require the use of a hash function, in which
690 * case the 'fields' and 'basis' parameters should be populated. The 'fields'
691 * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
692 * hash. Refer to the definition of "enum nx_hash_fields" for details. The
693 * 'basis' parameter is used as a universal hash parameter. Different values
694 * of 'basis' yield different hash results.
696 * The 'zero' parameter at the end of the action structure is reserved for
697 * future use. Switches are required to reject actions which have nonzero
698 * bytes in the 'zero' field. */
699 struct nx_action_bundle {
700 ovs_be16 type; /* OFPAT_VENDOR. */
701 ovs_be16 len; /* Length including slaves. */
702 ovs_be32 vendor; /* NX_VENDOR_ID. */
703 ovs_be16 subtype; /* NXAST_BUNDLE. */
705 /* Slave choice algorithm to apply to hash value. */
706 ovs_be16 algorithm; /* One of NX_BD_ALG_*. */
708 /* What fields to hash and how. */
709 ovs_be16 fields; /* One of NX_BD_FIELDS_*. */
710 ovs_be16 basis; /* Universal hash parameter. */
712 ovs_be32 slave_type; /* NXM_OF_IN_PORT. */
713 ovs_be16 n_slaves; /* Number of slaves. */
715 uint8_t zero[10]; /* Reserved. Must be zero. */
717 OFP_ASSERT(sizeof(struct nx_action_bundle) == 32);
719 /* NXAST_BUNDLE: Bundle slave choice algorithm to apply.
721 * In the descriptions below, 'slaves' is the list of possible slaves in the
722 * order they appear in the OpenFlow action. */
723 enum nx_bd_algorithm {
724 /* Chooses the first live slave listed in the bundle.
726 * O(n_slaves) performance. */
727 NX_BD_ALG_ACTIVE_BACKUP,
729 /* for i in [0,n_slaves):
730 * weights[i] = hash(flow, i)
731 * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
733 * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
734 * O(n_slaves) performance.
736 * Uses the 'fields' and 'basis' parameters. */
737 NX_BD_ALG_HRW /* Highest Random Weight. */
740 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
742 * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches. This
743 * structure is fixed-length and hence difficult to extend. This section
744 * describes a more flexible, variable-length flow match, called "nx_match" for
745 * short, that is also supported by Open vSwitch. This section also defines a
746 * replacement for each OpenFlow message that includes struct ofp_match.
752 * An nx_match is a sequence of zero or more "nxm_entry"s, which are
753 * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
754 * "nxm_entry"s are not aligned on or padded to any multibyte boundary. The
755 * first 4 bytes of an nxm_entry are its "header", followed by the entry's
758 * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
760 * |<-------------------- nxm_type ------------------>|
763 * +----------------------------------+---------------+--+------------------+
764 * | nxm_vendor | nxm_field |hm| nxm_length |
765 * +----------------------------------+---------------+--+------------------+
767 * The most-significant 23 bits of the header are collectively "nxm_type".
768 * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
769 * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
770 * designates a protocol header, such as the Ethernet type, but it can also
771 * refer to packet metadata, such as the switch port on which a packet arrived.
773 * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
774 * of this bit is explained later.
776 * The least-significant 8 bits are "nxm_length", a positive integer. The
777 * length of the nxm_entry, including the header, is exactly 4 + nxm_length
780 * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
781 * constant. It is included only to allow software to minimally parse
782 * "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor,
783 * nxm_field, and nxm_length, nxm_hasmask is a constant.)
789 * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
791 * An nxm_entry places a constraint on the packets matched by the nx_match:
793 * - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
794 * field, called "nxm_value". The nx_match matches only packets in which
795 * the field equals nxm_value.
797 * - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
798 * field (nxm_value), followed by a bitmask of the same length as the
799 * value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
800 * nx_match matches only packets for which bit J in the given field's value
801 * matches bit J in nxm_value. A 0-bit in nxm_mask causes the
802 * corresponding bits in nxm_value and the field's value to be ignored.
803 * (The sense of the nxm_mask bits is the opposite of that used by the
804 * "wildcards" member of struct ofp_match.)
806 * When nxm_hasmask is 1, nxm_length is always even.
808 * An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
809 * entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for
812 * When there are multiple "nxm_entry"s, all of the constraints must be met.
818 * Masks may be restricted:
820 * - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
821 * must always be 0 when these fields are specified. For example, the
822 * field that identifies the port on which a packet was received may not be
825 * - Some nxm_types that do support masked wildcards may only support certain
826 * nxm_mask patterns. For example, fields that have IPv4 address values
827 * may be restricted to CIDR masks.
829 * These restrictions should be noted in specifications for individual fields.
830 * A switch may accept an nxm_hasmask or nxm_mask value that the specification
831 * disallows, if the switch correctly implements support for that nxm_hasmask
832 * or nxm_mask value. A switch must reject an attempt to set up a flow that
833 * contains a nxm_hasmask or nxm_mask value that it does not support.
836 * Prerequisite Restrictions
837 * =========================
839 * The presence of an nxm_entry with a given nxm_type may be restricted based
840 * on the presence of or values of other "nxm_entry"s. For example:
842 * - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
843 * preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
844 * and nxm_value=0x0800. That is, matching on the IP source address is
845 * allowed only if the Ethernet type is explicitly set to IP.
847 * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is preced
848 * by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
849 * nxm_value=0x0800 and another with nxm_type=NXM_OF_IP_PROTO,
850 * nxm_hasmask=0, nxm_value=6, in that order. That is, matching on the TCP
851 * source port is allowed only if the Ethernet type is IP and the IP
854 * These restrictions should be noted in specifications for individual fields.
855 * A switch may implement relaxed versions of these restrictions. A switch
856 * must reject an attempt to set up a flow that violates its restrictions.
859 * Ordering Restrictions
860 * =====================
862 * An nxm_entry that has prerequisite restrictions must appear after the
863 * "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an
864 * nx_match is not otherwise constrained.
866 * Any given nxm_type may appear in an nx_match at most once.
872 * These examples show the format of a single nxm_entry with particular
873 * nxm_hasmask and nxm_length values. The diagrams are labeled with field
874 * numbers and byte indexes.
877 * 8-bit nxm_value, nxm_hasmask=1, nxm_length=1:
880 * +------------+---+---+
882 * +------------+---+---+
885 * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
888 * +------------+------+
890 * +------------+------+
893 * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
896 * +------------+-------------+
897 * | header | nxm_value |
898 * +------------+-------------+
901 * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
904 * +------------+------------------+
905 * | header | nxm_value |
906 * +------------+------------------+
909 * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
912 * +------------+------------------+------------------+
913 * | header | nxm_value | nxm_mask |
914 * +------------+------------------+------------------+
920 * A switch should report an error in an nx_match using error type
921 * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch
922 * should report a specific error code, if one is assigned for the particular
923 * problem, but NXBRC_NXM_INVALID is also available to report a generic
927 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
928 (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
929 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
930 NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
931 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
932 NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
933 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
934 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
935 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
936 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
937 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
939 #define NXM_MAKE_WILD_HEADER(HEADER) \
940 NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
942 /* ## ------------------------------- ## */
943 /* ## OpenFlow 1.0-compatible fields. ## */
944 /* ## ------------------------------- ## */
946 /* Physical or virtual port on which the packet was received.
950 * Format: 16-bit integer in network byte order.
952 * Masking: Not maskable. */
953 #define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
955 /* Source or destination address in Ethernet header.
959 * Format: 48-bit Ethernet MAC address.
961 * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
962 * be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
963 * are all-0-bits or all-1-bits). Support for other patterns and for masking
964 * of NXM_OF_ETH_SRC is optional. */
965 #define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
966 #define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
967 #define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
969 /* Packet's Ethernet type.
971 * For an Ethernet II packet this is taken from the Ethernet header. For an
972 * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
973 * A packet that has neither format has value 0x05ff
974 * (OFP_DL_TYPE_NOT_ETH_TYPE).
976 * For a packet with an 802.1Q header, this is the type of the encapsulated
981 * Format: 16-bit integer in network byte order.
983 * Masking: Not maskable. */
984 #define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
988 * For a packet with an 802.1Q header, this is the Tag Control Information
989 * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
990 * header, this has value 0.
994 * Format: 16-bit integer in network byte order.
996 * Masking: Arbitrary masks.
998 * This field can be used in various ways:
1000 * - If it is not constrained at all, the nx_match matches packets without
1001 * an 802.1Q header or with an 802.1Q header that has any TCI value.
1003 * - Testing for an exact match with 0 matches only packets without an
1006 * - Testing for an exact match with a TCI value with CFI=1 matches packets
1007 * that have an 802.1Q header with a specified VID and PCP.
1009 * - Testing for an exact match with a nonzero TCI value with CFI=0 does
1010 * not make sense. The switch may reject this combination.
1012 * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
1013 * packets that have an 802.1Q header with that VID (and any PCP).
1015 * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
1016 * packets that have an 802.1Q header with that PCP (and any VID).
1018 * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
1019 * header or with an 802.1Q header with a VID of 0.
1021 * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
1022 * header or with an 802.1Q header with a PCP of 0.
1024 * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
1025 * header or with an 802.1Q header with both VID and PCP of 0.
1027 #define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
1028 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
1030 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
1032 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1034 * Format: 8-bit integer with 2 least-significant bits forced to 0.
1036 * Masking: Not maskable. */
1037 #define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
1039 /* The "protocol" byte in the IP header.
1041 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1043 * Format: 8-bit integer.
1045 * Masking: Not maskable. */
1046 #define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
1048 /* The source or destination address in the IP header.
1050 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
1052 * Format: 32-bit integer in network byte order.
1054 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1055 * high-order bits set to 1 and the other 32-N bits set to 0. */
1056 #define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
1057 #define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
1058 #define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
1059 #define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
1061 /* The source or destination port in the TCP header.
1064 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1065 * NXM_OF_IP_PROTO must match 6 exactly.
1067 * Format: 16-bit integer in network byte order.
1069 * Masking: Not maskable. */
1070 #define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
1071 #define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
1073 /* The source or destination port in the UDP header.
1076 * NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1077 * NXM_OF_IP_PROTO must match 17 exactly.
1079 * Format: 16-bit integer in network byte order.
1081 * Masking: Not maskable. */
1082 #define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
1083 #define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
1085 /* The type or code in the ICMP header.
1088 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
1089 * NXM_OF_IP_PROTO must match 1 exactly.
1091 * Format: 8-bit integer.
1093 * Masking: Not maskable. */
1094 #define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
1095 #define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
1099 * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
1100 * otherwise. Only ARP opcodes between 1 and 255 should be specified for
1103 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1105 * Format: 16-bit integer in network byte order.
1107 * Masking: Not maskable. */
1108 #define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
1110 /* For an Ethernet+IP ARP packet, the source or target protocol address
1111 * in the ARP header. Always 0 otherwise.
1113 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1115 * Format: 32-bit integer in network byte order.
1117 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1118 * high-order bits set to 1 and the other 32-N bits set to 0. */
1119 #define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
1120 #define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
1121 #define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
1122 #define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
1124 /* ## ------------------------ ## */
1125 /* ## Nicira match extensions. ## */
1126 /* ## ------------------------ ## */
1128 /* Metadata registers.
1130 * Registers initially have value 0. Actions allow register values to be
1135 * Format: Array of 32-bit integer registers. Space is reserved for up to
1136 * NXM_NX_MAX_REGS registers, but switches may implement fewer.
1138 * Masking: Arbitrary masks. */
1139 #define NXM_NX_MAX_REGS 16
1140 #define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
1141 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1142 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1143 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1144 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1145 #define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
1146 #define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
1147 #define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
1148 #define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
1149 #define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
1150 #define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
1151 #define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
1152 #define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
1156 * For a packet received via GRE tunnel including a (32-bit) key, the key is
1157 * stored in the low 32-bits and the high bits are zeroed. For other packets,
1162 * Format: 64-bit integer in network byte order.
1164 * Masking: Arbitrary masks. */
1165 #define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
1166 #define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
1168 /* For an Ethernet+IP ARP packet, the source or target hardware address
1169 * in the ARP header. Always 0 otherwise.
1171 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1173 * Format: 48-bit Ethernet MAC address.
1175 * Masking: Not maskable. */
1176 #define NXM_NX_ARP_SHA NXM_HEADER (0x0001, 17, 6)
1177 #define NXM_NX_ARP_THA NXM_HEADER (0x0001, 18, 6)
1179 /* The source or destination address in the IPv6 header.
1181 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1183 * Format: 128-bit IPv6 address.
1185 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1186 * high-order bits set to 1 and the other 128-N bits set to 0. */
1187 #define NXM_NX_IPV6_SRC NXM_HEADER (0x0001, 19, 16)
1188 #define NXM_NX_IPV6_SRC_W NXM_HEADER_W(0x0001, 19, 16)
1189 #define NXM_NX_IPV6_DST NXM_HEADER (0x0001, 20, 16)
1190 #define NXM_NX_IPV6_DST_W NXM_HEADER_W(0x0001, 20, 16)
1192 /* The type or code in the ICMPv6 header.
1195 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1196 * NXM_OF_IP_PROTO must match 58 exactly.
1198 * Format: 8-bit integer.
1200 * Masking: Not maskable. */
1201 #define NXM_NX_ICMPV6_TYPE NXM_HEADER (0x0001, 21, 1)
1202 #define NXM_NX_ICMPV6_CODE NXM_HEADER (0x0001, 22, 1)
1204 /* The target address in an IPv6 Neighbor Discovery message.
1207 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1208 * NXM_OF_IP_PROTO must match 58 exactly.
1209 * NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1211 * Format: 128-bit IPv6 address.
1213 * Masking: Not maskable. */
1214 #define NXM_NX_ND_TARGET NXM_HEADER (0x0001, 23, 16)
1216 /* The source link-layer address option in an IPv6 Neighbor Discovery
1220 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1221 * NXM_OF_IP_PROTO must match 58 exactly.
1222 * NXM_OF_ICMPV6_TYPE must be exactly 135.
1224 * Format: 48-bit Ethernet MAC address.
1226 * Masking: Not maskable. */
1227 #define NXM_NX_ND_SLL NXM_HEADER (0x0001, 24, 6)
1229 /* The target link-layer address option in an IPv6 Neighbor Discovery
1233 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1234 * NXM_OF_IP_PROTO must match 58 exactly.
1235 * NXM_OF_ICMPV6_TYPE must be exactly 136.
1237 * Format: 48-bit Ethernet MAC address.
1239 * Masking: Not maskable. */
1240 #define NXM_NX_ND_TLL NXM_HEADER (0x0001, 25, 6)
1243 /* ## --------------------- ## */
1244 /* ## Requests and replies. ## */
1245 /* ## --------------------- ## */
1247 enum nx_flow_format {
1248 NXFF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
1249 NXFF_NXM = 2 /* Nicira extended match. */
1252 /* NXT_SET_FLOW_FORMAT request. */
1253 struct nxt_set_flow_format {
1254 struct ofp_header header;
1255 ovs_be32 vendor; /* NX_VENDOR_ID. */
1256 ovs_be32 subtype; /* NXT_SET_FLOW_FORMAT. */
1257 ovs_be32 format; /* One of NXFF_*. */
1259 OFP_ASSERT(sizeof(struct nxt_set_flow_format) == 20);
1261 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */
1262 struct nx_flow_mod {
1263 struct nicira_header nxh;
1264 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1265 ovs_be16 command; /* One of OFPFC_*. */
1266 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
1267 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
1268 ovs_be16 priority; /* Priority level of flow entry. */
1269 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
1270 Not meaningful for OFPFC_DELETE*. */
1271 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
1272 matching entries to include this as an
1273 output port. A value of OFPP_NONE
1274 indicates no restriction. */
1275 ovs_be16 flags; /* One of OFPFF_*. */
1276 ovs_be16 match_len; /* Size of nx_match. */
1277 uint8_t pad[6]; /* Align to 64-bits. */
1279 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1280 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1281 * all-zero bytes, then
1282 * - Actions to fill out the remainder of the message length (always a
1286 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
1288 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1289 struct nx_flow_removed {
1290 struct nicira_header nxh;
1291 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1292 ovs_be16 priority; /* Priority level of flow entry. */
1293 uint8_t reason; /* One of OFPRR_*. */
1294 uint8_t pad[1]; /* Align to 32-bits. */
1295 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
1296 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
1298 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
1299 ovs_be16 match_len; /* Size of nx_match. */
1300 ovs_be64 packet_count;
1301 ovs_be64 byte_count;
1303 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1304 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1305 * all-zero bytes. */
1307 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
1309 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1311 struct nx_flow_stats_request {
1312 struct nicira_stats_msg nsm;
1313 ovs_be16 out_port; /* Require matching entries to include this
1314 as an output port. A value of OFPP_NONE
1315 indicates no restriction. */
1316 ovs_be16 match_len; /* Length of nx_match. */
1317 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1318 or 0xff for all tables. */
1319 uint8_t pad[3]; /* Align to 64 bits. */
1321 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1322 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1323 * all-zero bytes, which must also exactly fill out the length of the
1327 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
1329 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1330 * OFPST_FLOW reply). */
1331 struct nx_flow_stats {
1332 ovs_be16 length; /* Length of this entry. */
1333 uint8_t table_id; /* ID of table flow came from. */
1335 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
1336 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
1337 beyond duration_sec. */
1338 ovs_be16 priority; /* Priority of the entry. Only meaningful
1339 when this is not an exact-match entry. */
1340 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
1341 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
1342 ovs_be16 match_len; /* Length of nx_match. */
1343 uint8_t pad2[4]; /* Align to 64 bits. */
1344 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1345 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1346 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1348 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1349 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1350 * all-zero bytes, then
1351 * - Actions to fill out the remainder 'length' bytes (always a multiple
1355 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1357 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1358 * OFPST_AGGREGATE request). */
1359 struct nx_aggregate_stats_request {
1360 struct nicira_stats_msg nsm;
1361 ovs_be16 out_port; /* Require matching entries to include this
1362 as an output port. A value of OFPP_NONE
1363 indicates no restriction. */
1364 ovs_be16 match_len; /* Length of nx_match. */
1365 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1366 or 0xff for all tables. */
1367 uint8_t pad[3]; /* Align to 64 bits. */
1369 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1370 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1371 * all-zero bytes, which must also exactly fill out the length of the
1375 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1377 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1378 * OFPST_AGGREGATE reply). */
1379 struct nx_aggregate_stats_reply {
1380 struct nicira_stats_msg nsm;
1381 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1382 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1383 ovs_be32 flow_count; /* Number of flows. */
1384 uint8_t pad[4]; /* Align to 64 bits. */
1386 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1388 #endif /* openflow/nicira-ext.h */