2 * Copyright (c) 2008, 2009, 2010 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_CODE 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. */
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. */
107 /* Generic hardware error. */
108 NXFMFC_HARDWARE = 0x100,
110 /* A nonexistent table ID was specified in the "command" field of struct
111 * ofp_flow_mod, when the nxt_flow_mod_table_id extension is enabled.
112 * (This extension is not yet implemented on this branch of Open
114 NXFMFC_BAD_TABLE_ID = 0x101
117 /* Nicira vendor requests and replies. */
119 /* Header for Nicira vendor requests and replies. */
120 struct nicira_header {
121 struct ofp_header header;
122 ovs_be32 vendor; /* NX_VENDOR_ID. */
123 ovs_be32 subtype; /* One of NXT_* below. */
125 OFP_ASSERT(sizeof(struct nicira_header) == 16);
127 /* Values for the 'subtype' member of struct nicira_header. */
129 /* Switch status request. The request body is an ASCII string that
130 * specifies a prefix of the key names to include in the output; if it is
131 * the null string, then all key-value pairs are included. */
134 /* Switch status reply. The reply body is an ASCII string of key-value
135 * pairs in the form "key=value\n". */
138 /* No longer used. */
139 NXT_ACT_SET_CONFIG__OBSOLETE,
140 NXT_ACT_GET_CONFIG__OBSOLETE,
141 NXT_COMMAND_REQUEST__OBSOLETE,
142 NXT_COMMAND_REPLY__OBSOLETE,
143 NXT_FLOW_END_CONFIG__OBSOLETE,
144 NXT_FLOW_END__OBSOLETE,
147 /* Use the high 32 bits of the cookie field as the tunnel ID in the flow
149 NXT_TUN_ID_FROM_COOKIE,
151 /* Controller role support. The request body is struct nx_role_request.
152 * The reply echos the request. */
156 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
157 NXT_SET_FLOW_FORMAT, /* Set flow format. */
158 NXT_FLOW_MOD, /* Analogous to OFPT_FLOW_MOD. */
159 NXT_FLOW_REMOVED /* Analogous to OFPT_FLOW_REMOVED. */
162 /* Header for Nicira vendor stats request and reply messages. */
163 struct nicira_stats_msg {
164 struct ofp_header header; /* OFPT_STATS_REQUEST or OFPT_STATS_REPLY. */
165 ovs_be16 type; /* OFPST_VENDOR. */
166 ovs_be16 flags; /* OFPSF_{REQ,REPLY}_*. */
167 ovs_be32 vendor; /* NX_VENDOR_ID. */
168 ovs_be32 subtype; /* One of NXST_* below. */
169 uint8_t pad[4]; /* Align to 64-bits. */
171 OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
173 /* Values for the 'subtype' member of struct nicira_stats_msg. */
174 enum nicira_stats_type {
175 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
176 NXST_FLOW, /* Analogous to OFPST_FLOW. */
177 NXST_AGGREGATE /* Analogous to OFPST_AGGREGATE. */
180 /* NXT_TUN_ID_FROM_COOKIE request. */
181 struct nxt_tun_id_cookie {
182 struct ofp_header header;
183 uint32_t vendor; /* NX_VENDOR_ID. */
184 uint32_t subtype; /* NXT_TUN_ID_FROM_COOKIE */
185 uint8_t set; /* Nonzero to enable, zero to disable. */
188 OFP_ASSERT(sizeof(struct nxt_tun_id_cookie) == 24);
190 /* Configures the "role" of the sending controller. The default role is:
192 * - Other (NX_ROLE_OTHER), which allows the controller access to all
195 * The other possible roles are a related pair:
197 * - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
198 * be at most one Master controller at a time: when a controller
199 * configures itself as Master, any existing Master is demoted to the
202 * - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
203 * OpenFlow features. In particular attempts to modify the flow table
204 * will be rejected with an OFPBRC_EPERM error.
206 * Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
207 * messages, but they do receive OFPT_PORT_STATUS messages.
209 struct nx_role_request {
210 struct nicira_header nxh;
211 uint32_t role; /* One of NX_ROLE_*. */
215 NX_ROLE_OTHER, /* Default role, full access. */
216 NX_ROLE_MASTER, /* Full access, at most one. */
217 NX_ROLE_SLAVE /* Read-only access. */
220 /* Nicira vendor flow actions. */
222 enum nx_action_subtype {
223 NXAST_SNAT__OBSOLETE, /* No longer used. */
224 NXAST_RESUBMIT, /* struct nx_action_resubmit */
225 NXAST_SET_TUNNEL, /* struct nx_action_set_tunnel */
226 NXAST_DROP_SPOOFED_ARP, /* struct nx_action_drop_spoofed_arp */
227 NXAST_SET_QUEUE, /* struct nx_action_set_queue */
228 NXAST_POP_QUEUE, /* struct nx_action_pop_queue */
229 NXAST_REG_MOVE, /* struct nx_action_reg_move */
230 NXAST_REG_LOAD, /* struct nx_action_reg_load */
231 NXAST_NOTE, /* struct nx_action_note */
232 NXAST_SET_TUNNEL64, /* struct nx_action_set_tunnel64 */
235 /* Header for Nicira-defined actions. */
236 struct nx_action_header {
237 uint16_t type; /* OFPAT_VENDOR. */
238 uint16_t len; /* Length is 16. */
239 uint32_t vendor; /* NX_VENDOR_ID. */
240 uint16_t subtype; /* NXAST_*. */
243 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
245 /* Action structure for NXAST_RESUBMIT.
247 * NXAST_RESUBMIT searches the flow table again, using a flow that is slightly
248 * modified from the original lookup:
250 * - The 'in_port' member of struct nx_action_resubmit is used as the flow's
253 * - If NXAST_RESUBMIT is preceded by actions that affect the flow
254 * (e.g. OFPAT_SET_VLAN_VID), then the flow is updated with the new
257 * Following the lookup, the original in_port is restored.
259 * If the modified flow matched in the flow table, then the corresponding
260 * actions are executed. Afterward, actions following NXAST_RESUBMIT in the
261 * original set of actions, if any, are executed; any changes made to the
262 * packet (e.g. changes to VLAN) by secondary actions persist when those
263 * actions are executed, although the original in_port is restored.
265 * NXAST_RESUBMIT may be used any number of times within a set of actions.
267 * NXAST_RESUBMIT may nest to an implementation-defined depth. Beyond this
268 * implementation-defined depth, further NXAST_RESUBMIT actions are simply
269 * ignored. (Open vSwitch 1.0.1 and earlier did not support recursion.)
271 struct nx_action_resubmit {
272 uint16_t type; /* OFPAT_VENDOR. */
273 uint16_t len; /* Length is 16. */
274 uint32_t vendor; /* NX_VENDOR_ID. */
275 uint16_t subtype; /* NXAST_RESUBMIT. */
276 uint16_t in_port; /* New in_port for checking flow table. */
279 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
281 /* Action structure for NXAST_SET_TUNNEL.
283 * Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32
284 * bits of the tunnel ID are set to 0. */
285 struct nx_action_set_tunnel {
286 uint16_t type; /* OFPAT_VENDOR. */
287 uint16_t len; /* Length is 16. */
288 uint32_t vendor; /* NX_VENDOR_ID. */
289 uint16_t subtype; /* NXAST_SET_TUNNEL. */
291 uint32_t tun_id; /* Tunnel ID. */
293 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
295 /* Action structure for NXAST_SET_TUNNEL64.
297 * Sets the encapsulating tunnel ID to a 64-bit value. */
298 struct nx_action_set_tunnel64 {
299 ovs_be16 type; /* OFPAT_VENDOR. */
300 ovs_be16 len; /* Length is 16. */
301 ovs_be32 vendor; /* NX_VENDOR_ID. */
302 ovs_be16 subtype; /* NXAST_SET_TUNNEL64. */
304 ovs_be64 tun_id; /* Tunnel ID. */
306 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
308 /* Action structure for NXAST_DROP_SPOOFED_ARP.
310 * Stops processing further actions, if the packet being processed is an
311 * Ethernet+IPv4 ARP packet for which the source Ethernet address inside the
312 * ARP packet differs from the source Ethernet address in the Ethernet header.
314 * This is useful because OpenFlow does not provide a way to match on the
315 * Ethernet addresses inside ARP packets, so there is no other way to drop
316 * spoofed ARPs other than sending every ARP packet to a controller. */
317 struct nx_action_drop_spoofed_arp {
318 uint16_t type; /* OFPAT_VENDOR. */
319 uint16_t len; /* Length is 16. */
320 uint32_t vendor; /* NX_VENDOR_ID. */
321 uint16_t subtype; /* NXAST_DROP_SPOOFED_ARP. */
324 OFP_ASSERT(sizeof(struct nx_action_drop_spoofed_arp) == 16);
326 /* Action structure for NXAST_SET_QUEUE.
328 * Set the queue that should be used when packets are output. This is similar
329 * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
330 * an argument. This allows the queue to be defined before the port is
332 struct nx_action_set_queue {
333 uint16_t type; /* OFPAT_VENDOR. */
334 uint16_t len; /* Length is 16. */
335 uint32_t vendor; /* NX_VENDOR_ID. */
336 uint16_t subtype; /* NXAST_SET_QUEUE. */
338 uint32_t queue_id; /* Where to enqueue packets. */
340 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
342 /* Action structure for NXAST_POP_QUEUE.
344 * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
345 * were used. Only the original queue can be restored this way; no stack is
347 struct nx_action_pop_queue {
348 uint16_t type; /* OFPAT_VENDOR. */
349 uint16_t len; /* Length is 16. */
350 uint32_t vendor; /* NX_VENDOR_ID. */
351 uint16_t subtype; /* NXAST_POP_QUEUE. */
354 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
356 /* Action structure for NXAST_REG_MOVE.
358 * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
359 * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
360 * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
361 * the next most significant bit, and so on.
363 * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
364 * sense to use nxm_hasmask=1 because the action does not do any kind of
365 * matching; it uses the actual value of a field.)
367 * The following nxm_header values are potentially acceptable as 'src':
388 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
390 * The following nxm_header values are potentially acceptable as 'dst':
392 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
394 * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
395 * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
396 * header (if any), ignoring the other bits. Setting a value with CFI=1
397 * adds or modifies the 802.1Q header appropriately, setting the TCI field
398 * to the field's new value (with the CFI bit masked out).
400 * - NXM_NX_TUN_ID. Modifying this value modifies the tunnel ID used for the
401 * packet's next tunnel encapsulation.
403 * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
404 * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
405 * used only if the flow's nx_match includes an nxm_entry that specifies
406 * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
408 * The switch will reject actions for which src_ofs+n_bits is greater than the
409 * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
410 * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
412 struct nx_action_reg_move {
413 ovs_be16 type; /* OFPAT_VENDOR. */
414 ovs_be16 len; /* Length is 16. */
415 ovs_be32 vendor; /* NX_VENDOR_ID. */
416 ovs_be16 subtype; /* NXAST_REG_MOVE. */
417 ovs_be16 n_bits; /* Number of bits. */
418 ovs_be16 src_ofs; /* Starting bit offset in source. */
419 ovs_be16 dst_ofs; /* Starting bit offset in destination. */
420 ovs_be32 src; /* Source register. */
421 ovs_be32 dst; /* Destination register. */
423 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
425 /* Action structure for NXAST_REG_LOAD.
427 * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
428 * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
429 * starts at 0 for the least-significant bit, 1 for the next most significant
432 * 'dst' is an nxm_header with nxm_hasmask=0. It must be one of the following:
434 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
436 * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
437 * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
438 * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
439 * also stored as one less than its true value:
442 * +------------------------------+------------------+
443 * | ofs | n_bits - 1 |
444 * +------------------------------+------------------+
446 * The switch will reject actions for which ofs+n_bits is greater than the
447 * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
448 * greater are set to 1, with error type OFPET_BAD_ACTION, code
449 * OFPBAC_BAD_ARGUMENT.
451 struct nx_action_reg_load {
452 ovs_be16 type; /* OFPAT_VENDOR. */
453 ovs_be16 len; /* Length is 16. */
454 ovs_be32 vendor; /* NX_VENDOR_ID. */
455 ovs_be16 subtype; /* NXAST_REG_LOAD. */
456 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
457 ovs_be32 dst; /* Destination register. */
458 ovs_be64 value; /* Immediate value. */
460 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
462 /* Action structure for NXAST_NOTE.
464 * This action has no effect. It is variable length. The switch does not
465 * attempt to interpret the user-defined 'note' data in any way. A controller
466 * can use this action to attach arbitrary metadata to a flow.
468 * This action might go away in the future.
470 struct nx_action_note {
471 uint16_t type; /* OFPAT_VENDOR. */
472 uint16_t len; /* A multiple of 8, but at least 16. */
473 uint32_t vendor; /* NX_VENDOR_ID. */
474 uint16_t subtype; /* NXAST_NOTE. */
475 uint8_t note[6]; /* Start of user-defined data. */
476 /* Possibly followed by additional user-defined data. */
478 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
480 /* Wildcard for tunnel ID. */
481 #define NXFW_TUN_ID (1 << 25)
483 #define NXFW_ALL NXFW_TUN_ID
484 #define OVSFW_ALL (OFPFW_ALL | NXFW_ALL)
486 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
488 * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches. This
489 * structure is fixed-length and hence difficult to extend. This section
490 * describes a more flexible, variable-length flow match, called "nx_match" for
491 * short, that is also supported by Open vSwitch. This section also defines a
492 * replacement for each OpenFlow message that includes struct ofp_match.
498 * An nx_match is a sequence of zero or more "nxm_entry"s, which are
499 * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
500 * "nxm_entry"s are not aligned on or padded to any multibyte boundary. The
501 * first 4 bytes of an nxm_entry are its "header", followed by the entry's
504 * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
506 * |<-------------------- nxm_type ------------------>|
509 * +----------------------------------+---------------+--+------------------+
510 * | nxm_vendor | nxm_field |hm| nxm_length |
511 * +----------------------------------+---------------+--+------------------+
513 * The most-significant 23 bits of the header are collectively "nxm_type".
514 * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
515 * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
516 * designates a protocol header, such as the Ethernet type, but it can also
517 * refer to packet metadata, such as the switch port on which a packet arrived.
519 * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
520 * of this bit is explained later.
522 * The least-significant 8 bits are "nxm_length", a positive integer. The
523 * length of the nxm_entry, including the header, is exactly 4 + nxm_length
526 * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
527 * constant. It is included only to allow software to minimally parse
528 * "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor,
529 * nxm_field, and nxm_length, nxm_hasmask is a constant.)
535 * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
537 * An nxm_entry places a constraint on the packets matched by the nx_match:
539 * - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
540 * field, called "nxm_value". The nx_match matches only packets in which
541 * the field equals nxm_value.
543 * - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
544 * field (nxm_value), followed by a bitmask of the same length as the
545 * value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
546 * nx_match matches only packets for which bit J in the given field's value
547 * matches bit J in nxm_value. A 0-bit in nxm_mask causes the
548 * corresponding bits in nxm_value and the field's value to be ignored.
549 * (The sense of the nxm_mask bits is the opposite of that used by the
550 * "wildcards" member of struct ofp_match.)
552 * When nxm_hasmask is 1, nxm_length is always even.
554 * An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
555 * entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for
558 * When there are multiple "nxm_entry"s, all of the constraints must be met.
564 * Masks may be restricted:
566 * - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
567 * must always be 0 when these fields are specified. For example, the
568 * field that identifies the port on which a packet was received may not be
571 * - Some nxm_types that do support masked wildcards may only support certain
572 * nxm_mask patterns. For example, fields that have IPv4 address values
573 * may be restricted to CIDR masks.
575 * These restrictions should be noted in specifications for individual fields.
576 * A switch may accept an nxm_hasmask or nxm_mask value that the specification
577 * disallows, if the switch correctly implements support for that nxm_hasmask
578 * or nxm_mask value. A switch must reject an attempt to set up a flow that
579 * contains a nxm_hasmask or nxm_mask value that it does not support.
582 * Prerequisite Restrictions
583 * =========================
585 * The presence of an nxm_entry with a given nxm_type may be restricted based
586 * on the presence of or values of other "nxm_entry"s. For example:
588 * - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
589 * preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
590 * and nxm_value=0x0800. That is, matching on the IP source address is
591 * allowed only if the Ethernet type is explicitly set to IP.
593 * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is preced
594 * by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
595 * nxm_value=0x0800 and another with nxm_type=NXM_OF_IP_PROTO,
596 * nxm_hasmask=0, nxm_value=6, in that order. That is, matching on the TCP
597 * source port is allowed only if the Ethernet type is IP and the IP
600 * These restrictions should be noted in specifications for individual fields.
601 * A switch may implement relaxed versions of these restrictions. A switch
602 * must reject an attempt to set up a flow that violates its restrictions.
605 * Ordering Restrictions
606 * =====================
608 * An nxm_entry that has prerequisite restrictions must appear after the
609 * "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an
610 * nx_match is not otherwise constrained.
612 * Any given nxm_type may appear in an nx_match at most once.
618 * These examples show the format of a single nxm_entry with particular
619 * nxm_hasmask and nxm_length values. The diagrams are labeled with field
620 * numbers and byte indexes.
623 * 8-bit nxm_value, nxm_hasmask=1, nxm_length=1:
626 * +------------+---+---+
628 * +------------+---+---+
631 * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
634 * +------------+------+
636 * +------------+------+
639 * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
642 * +------------+-------------+
643 * | header | nxm_value |
644 * +------------+-------------+
647 * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
650 * +------------+------------------+
651 * | header | nxm_value |
652 * +------------+------------------+
655 * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
658 * +------------+------------------+------------------+
659 * | header | nxm_value | nxm_mask |
660 * +------------+------------------+------------------+
666 * A switch should report an error in an nx_match using error type
667 * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch
668 * should report a specific error code, if one is assigned for the particular
669 * problem, but NXBRC_NXM_INVALID is also available to report a generic
673 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
674 (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
675 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
676 NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
677 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
678 NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
679 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
680 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
681 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
682 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
683 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
685 #define NXM_MAKE_WILD_HEADER(HEADER) \
686 NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
688 /* ## ------------------------------- ## */
689 /* ## OpenFlow 1.0-compatible fields. ## */
690 /* ## ------------------------------- ## */
692 /* Physical or virtual port on which the packet was received.
696 * Format: 16-bit integer in network byte order.
698 * Masking: Not maskable. */
699 #define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
701 /* Source or destination address in Ethernet header.
705 * Format: 48-bit Ethernet MAC address.
707 * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
708 * be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
709 * are all-0-bits or all-1-bits). Support for other patterns and for masking
710 * of NXM_OF_ETH_SRC is optional. */
711 #define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
712 #define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
713 #define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
715 /* Packet's Ethernet type.
717 * For an Ethernet II packet this is taken from the Ethernet header. For an
718 * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
719 * A packet that has neither format has value 0x05ff
720 * (OFP_DL_TYPE_NOT_ETH_TYPE).
722 * For a packet with an 802.1Q header, this is the type of the encapsulated
727 * Format: 16-bit integer in network byte order.
729 * Masking: Not maskable. */
730 #define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
734 * For a packet with an 802.1Q header, this is the Tag Control Information
735 * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
736 * header, this has value 0.
740 * Format: 16-bit integer in network byte order.
742 * Masking: Arbitrary masks.
744 * This field can be used in various ways:
746 * - If it is not constrained at all, the nx_match matches packets without
747 * an 802.1Q header or with an 802.1Q header that has any TCI value.
749 * - Testing for an exact match with 0 matches only packets without an
752 * - Testing for an exact match with a TCI value with CFI=1 matches packets
753 * that have an 802.1Q header with a specified VID and PCP.
755 * - Testing for an exact match with a nonzero TCI value with CFI=0 does
756 * not make sense. The switch may reject this combination.
758 * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
759 * packets that have an 802.1Q header with that VID (and any PCP).
761 * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
762 * packets that have an 802.1Q header with that PCP (and any VID).
764 * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
765 * header or with an 802.1Q header with a VID of 0.
767 #define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
768 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
770 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
772 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
774 * Format: 8-bit integer with 2 least-significant bits forced to 0.
776 * Masking: Not maskable. */
777 #define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
779 /* The "protocol" byte in the IP header.
781 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
783 * Format: 8-bit integer.
785 * Masking: Not maskable. */
786 #define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
788 /* The source or destination address in the IP header.
790 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
792 * Format: 32-bit integer in network byte order.
794 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
795 * high-order bits set to 1 and the other 32-N bits set to 0. */
796 #define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
797 #define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
798 #define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
799 #define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
801 /* The source or destination port in the TCP header.
804 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
805 * NXM_OF_IP_PROTO must match 6 exactly.
807 * Format: 16-bit integer in network byte order.
809 * Masking: Not maskable. */
810 #define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
811 #define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
813 /* The source or destination port in the UDP header.
816 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
817 * NXM_OF_IP_PROTO must match 17 exactly.
819 * Format: 16-bit integer in network byte order.
821 * Masking: Not maskable. */
822 #define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
823 #define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
825 /* The type or code in the ICMP header.
828 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
829 * NXM_OF_IP_PROTO must match 1 exactly.
831 * Format: 8-bit integer.
833 * Masking: Not maskable. */
834 #define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
835 #define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
839 * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
840 * otherwise. Only ARP opcodes between 1 and 255 should be specified for
843 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
845 * Format: 16-bit integer in network byte order.
847 * Masking: Not maskable. */
848 #define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
850 /* For an Ethernet+IP ARP packet, the source or target protocol address
851 * in the ARP header. Always 0 otherwise.
853 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
855 * Format: 32-bit integer in network byte order.
857 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
858 * high-order bits set to 1 and the other 32-N bits set to 0. */
859 #define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
860 #define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
861 #define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
862 #define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
864 /* ## ------------------------ ## */
865 /* ## Nicira match extensions. ## */
866 /* ## ------------------------ ## */
868 /* Metadata registers.
870 * Registers initially have value 0. Actions allow register values to be
875 * Format: Array of 32-bit integer registers. Space is reserved for up to
876 * NXM_NX_MAX_REGS registers, but switches may implement fewer.
878 * Masking: Arbitrary masks. */
879 #define NXM_NX_MAX_REGS 16
880 #define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
881 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
882 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
883 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
884 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
885 #define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
886 #define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
887 #define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
888 #define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
889 #define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
890 #define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
891 #define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
892 #define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
896 * For a packet received via GRE tunnel including a (32-bit) key, the key is
897 * stored in the low 32-bits and the high bits are zeroed. For other packets,
902 * Format: 64-bit integer in network byte order.
904 * Masking: Arbitrary masks. */
905 #define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
906 #define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
908 /* ## --------------------- ## */
909 /* ## Requests and replies. ## */
910 /* ## --------------------- ## */
912 enum nx_flow_format {
913 NXFF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
914 NXFF_TUN_ID_FROM_COOKIE = 1, /* OpenFlow 1.0, plus obtain tunnel ID from
916 NXFF_NXM = 2 /* Nicira extended match. */
919 /* NXT_SET_FLOW_FORMAT request. */
920 struct nxt_set_flow_format {
921 struct ofp_header header;
922 ovs_be32 vendor; /* NX_VENDOR_ID. */
923 ovs_be32 subtype; /* NXT_SET_FLOW_FORMAT. */
924 ovs_be32 format; /* One of NXFF_*. */
926 OFP_ASSERT(sizeof(struct nxt_set_flow_format) == 20);
928 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */
930 struct nicira_header nxh;
931 ovs_be64 cookie; /* Opaque controller-issued identifier. */
932 ovs_be16 command; /* One of OFPFC_*. */
933 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
934 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
935 ovs_be16 priority; /* Priority level of flow entry. */
936 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
937 Not meaningful for OFPFC_DELETE*. */
938 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
939 matching entries to include this as an
940 output port. A value of OFPP_NONE
941 indicates no restriction. */
942 ovs_be16 flags; /* One of OFPFF_*. */
943 ovs_be16 match_len; /* Size of nx_match. */
944 uint8_t pad[6]; /* Align to 64-bits. */
946 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
947 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
948 * all-zero bytes, then
949 * - Actions to fill out the remainder of the message length (always a
953 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
955 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
956 struct nx_flow_removed {
957 struct nicira_header nxh;
958 ovs_be64 cookie; /* Opaque controller-issued identifier. */
959 ovs_be16 priority; /* Priority level of flow entry. */
960 uint8_t reason; /* One of OFPRR_*. */
961 uint8_t pad[1]; /* Align to 32-bits. */
962 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
963 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
965 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
966 ovs_be16 match_len; /* Size of nx_match. */
967 ovs_be64 packet_count;
970 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
971 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
974 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
976 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
978 struct nx_flow_stats_request {
979 struct nicira_stats_msg nsm;
980 ovs_be16 out_port; /* Require matching entries to include this
981 as an output port. A value of OFPP_NONE
982 indicates no restriction. */
983 ovs_be16 match_len; /* Length of nx_match. */
984 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
985 or 0xff for all tables. */
986 uint8_t pad[3]; /* Align to 64 bits. */
988 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
989 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
990 * all-zero bytes, which must also exactly fill out the length of the
994 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
996 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
997 * OFPST_FLOW reply). */
998 struct nx_flow_stats {
999 ovs_be16 length; /* Length of this entry. */
1000 uint8_t table_id; /* ID of table flow came from. */
1002 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
1003 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
1004 beyond duration_sec. */
1005 ovs_be16 priority; /* Priority of the entry. Only meaningful
1006 when this is not an exact-match entry. */
1007 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
1008 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
1009 ovs_be16 match_len; /* Length of nx_match. */
1010 uint8_t pad2[4]; /* Align to 64 bits. */
1011 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1012 ovs_be64 packet_count; /* Number of packets in flow. */
1013 ovs_be64 byte_count; /* Number of bytes in flow. */
1015 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1016 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1017 * all-zero bytes, then
1018 * - Actions to fill out the remainder 'length' bytes (always a multiple
1022 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1024 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1025 * OFPST_AGGREGATE request). */
1026 struct nx_aggregate_stats_request {
1027 struct nicira_stats_msg nsm;
1028 ovs_be16 out_port; /* Require matching entries to include this
1029 as an output port. A value of OFPP_NONE
1030 indicates no restriction. */
1031 ovs_be16 match_len; /* Length of nx_match. */
1032 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1033 or 0xff for all tables. */
1034 uint8_t pad[3]; /* Align to 64 bits. */
1036 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1037 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1038 * all-zero bytes, which must also exactly fill out the length of the
1042 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1044 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1045 * OFPST_AGGREGATE reply).
1047 * ofp_aggregate_stats_reply does not contain an ofp_match structure, so we
1048 * reuse it entirely. (It would be very odd to use OFPST_AGGREGATE to reply to
1049 * an NXST_AGGREGATE request, so we don't do that.) */
1050 struct nx_aggregate_stats_reply {
1051 struct nicira_stats_msg nsm;
1052 struct ofp_aggregate_stats_reply asr;
1054 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1056 #endif /* openflow/nicira-ext.h */