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 */
234 /* Header for Nicira-defined actions. */
235 struct nx_action_header {
236 uint16_t type; /* OFPAT_VENDOR. */
237 uint16_t len; /* Length is 16. */
238 uint32_t vendor; /* NX_VENDOR_ID. */
239 uint16_t subtype; /* NXAST_*. */
242 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
244 /* Action structure for NXAST_RESUBMIT.
246 * NXAST_RESUBMIT searches the flow table again, using a flow that is slightly
247 * modified from the original lookup:
249 * - The 'in_port' member of struct nx_action_resubmit is used as the flow's
252 * - If NXAST_RESUBMIT is preceded by actions that affect the flow
253 * (e.g. OFPAT_SET_VLAN_VID), then the flow is updated with the new
256 * Following the lookup, the original in_port is restored.
258 * If the modified flow matched in the flow table, then the corresponding
259 * actions are executed. Afterward, actions following NXAST_RESUBMIT in the
260 * original set of actions, if any, are executed; any changes made to the
261 * packet (e.g. changes to VLAN) by secondary actions persist when those
262 * actions are executed, although the original in_port is restored.
264 * NXAST_RESUBMIT may be used any number of times within a set of actions.
266 * NXAST_RESUBMIT may nest to an implementation-defined depth. Beyond this
267 * implementation-defined depth, further NXAST_RESUBMIT actions are simply
268 * ignored. (Open vSwitch 1.0.1 and earlier did not support recursion.)
270 struct nx_action_resubmit {
271 uint16_t type; /* OFPAT_VENDOR. */
272 uint16_t len; /* Length is 16. */
273 uint32_t vendor; /* NX_VENDOR_ID. */
274 uint16_t subtype; /* NXAST_RESUBMIT. */
275 uint16_t in_port; /* New in_port for checking flow table. */
278 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
280 /* Action structure for NXAST_SET_TUNNEL.
282 * Sets the encapsulating tunnel ID. */
283 struct nx_action_set_tunnel {
284 uint16_t type; /* OFPAT_VENDOR. */
285 uint16_t len; /* Length is 16. */
286 uint32_t vendor; /* NX_VENDOR_ID. */
287 uint16_t subtype; /* NXAST_SET_TUNNEL. */
289 uint32_t tun_id; /* Tunnel ID. */
291 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
293 /* Action structure for NXAST_DROP_SPOOFED_ARP.
295 * Stops processing further actions, if the packet being processed is an
296 * Ethernet+IPv4 ARP packet for which the source Ethernet address inside the
297 * ARP packet differs from the source Ethernet address in the Ethernet header.
299 * This is useful because OpenFlow does not provide a way to match on the
300 * Ethernet addresses inside ARP packets, so there is no other way to drop
301 * spoofed ARPs other than sending every ARP packet to a controller. */
302 struct nx_action_drop_spoofed_arp {
303 uint16_t type; /* OFPAT_VENDOR. */
304 uint16_t len; /* Length is 16. */
305 uint32_t vendor; /* NX_VENDOR_ID. */
306 uint16_t subtype; /* NXAST_DROP_SPOOFED_ARP. */
309 OFP_ASSERT(sizeof(struct nx_action_drop_spoofed_arp) == 16);
311 /* Action structure for NXAST_SET_QUEUE.
313 * Set the queue that should be used when packets are output. This is similar
314 * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
315 * an argument. This allows the queue to be defined before the port is
317 struct nx_action_set_queue {
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_SET_QUEUE. */
323 uint32_t queue_id; /* Where to enqueue packets. */
325 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
327 /* Action structure for NXAST_POP_QUEUE.
329 * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
330 * were used. Only the original queue can be restored this way; no stack is
332 struct nx_action_pop_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_POP_QUEUE. */
339 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
341 /* Action structure for NXAST_REG_MOVE.
343 * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
344 * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
345 * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
346 * the next most significant bit, and so on.
348 * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
349 * sense to use nxm_hasmask=1 because the action does not do any kind of
350 * matching; it uses the actual value of a field.)
352 * The following nxm_header values are potentially acceptable as 'src':
373 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
375 * The following nxm_header values are potentially acceptable as 'dst':
377 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
379 * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
380 * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
381 * header (if any), ignoring the other bits. Setting a value with CFI=1
382 * adds or modifies the 802.1Q header appropriately, setting the TCI field
383 * to the field's new value (with the CFI bit masked out).
385 * - NXM_NX_TUN_ID. Modifying this value modifies the tunnel ID used for the
386 * packet's next tunnel encapsulation.
388 * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
389 * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
390 * used only if the flow's nx_match includes an nxm_entry that specifies
391 * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
393 * The switch will reject actions for which src_ofs+n_bits is greater than the
394 * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
395 * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
397 struct nx_action_reg_move {
398 ovs_be16 type; /* OFPAT_VENDOR. */
399 ovs_be16 len; /* Length is 16. */
400 ovs_be32 vendor; /* NX_VENDOR_ID. */
401 ovs_be16 subtype; /* NXAST_REG_MOVE. */
402 ovs_be16 n_bits; /* Number of bits. */
403 ovs_be16 src_ofs; /* Starting bit offset in source. */
404 ovs_be16 dst_ofs; /* Starting bit offset in destination. */
405 ovs_be32 src; /* Source register. */
406 ovs_be32 dst; /* Destination register. */
408 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
410 /* Action structure for NXAST_REG_LOAD.
412 * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
413 * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
414 * starts at 0 for the least-significant bit, 1 for the next most significant
417 * 'dst' is an nxm_header with nxm_hasmask=0. It must be one of the following:
419 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
421 * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
422 * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
423 * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
424 * also stored as one less than its true value:
427 * +------------------------------+------------------+
428 * | ofs | n_bits - 1 |
429 * +------------------------------+------------------+
431 * The switch will reject actions for which ofs+n_bits is greater than the
432 * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
433 * greater are set to 1, with error type OFPET_BAD_ACTION, code
434 * OFPBAC_BAD_ARGUMENT.
436 struct nx_action_reg_load {
437 ovs_be16 type; /* OFPAT_VENDOR. */
438 ovs_be16 len; /* Length is 16. */
439 ovs_be32 vendor; /* NX_VENDOR_ID. */
440 ovs_be16 subtype; /* NXAST_REG_LOAD. */
441 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
442 ovs_be32 dst; /* Destination register. */
443 ovs_be64 value; /* Immediate value. */
445 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
447 /* Action structure for NXAST_NOTE.
449 * This action has no effect. It is variable length. The switch does not
450 * attempt to interpret the user-defined 'note' data in any way. A controller
451 * can use this action to attach arbitrary metadata to a flow.
453 * This action might go away in the future.
455 struct nx_action_note {
456 uint16_t type; /* OFPAT_VENDOR. */
457 uint16_t len; /* A multiple of 8, but at least 16. */
458 uint32_t vendor; /* NX_VENDOR_ID. */
459 uint16_t subtype; /* NXAST_NOTE. */
460 uint8_t note[6]; /* Start of user-defined data. */
461 /* Possibly followed by additional user-defined data. */
463 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
465 /* Wildcard for tunnel ID. */
466 #define NXFW_TUN_ID (1 << 25)
468 #define NXFW_ALL NXFW_TUN_ID
469 #define OVSFW_ALL (OFPFW_ALL | NXFW_ALL)
471 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
473 * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches. This
474 * structure is fixed-length and hence difficult to extend. This section
475 * describes a more flexible, variable-length flow match, called "nx_match" for
476 * short, that is also supported by Open vSwitch. This section also defines a
477 * replacement for each OpenFlow message that includes struct ofp_match.
483 * An nx_match is a sequence of zero or more "nxm_entry"s, which are
484 * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
485 * "nxm_entry"s are not aligned on or padded to any multibyte boundary. The
486 * first 4 bytes of an nxm_entry are its "header", followed by the entry's
489 * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
491 * |<-------------------- nxm_type ------------------>|
494 * +----------------------------------+---------------+--+------------------+
495 * | nxm_vendor | nxm_field |hm| nxm_length |
496 * +----------------------------------+---------------+--+------------------+
498 * The most-significant 23 bits of the header are collectively "nxm_type".
499 * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
500 * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
501 * designates a protocol header, such as the Ethernet type, but it can also
502 * refer to packet metadata, such as the switch port on which a packet arrived.
504 * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
505 * of this bit is explained later.
507 * The least-significant 8 bits are "nxm_length", a positive integer. The
508 * length of the nxm_entry, including the header, is exactly 4 + nxm_length
511 * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
512 * constant. It is included only to allow software to minimally parse
513 * "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor,
514 * nxm_field, and nxm_length, nxm_hasmask is a constant.)
520 * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
522 * An nxm_entry places a constraint on the packets matched by the nx_match:
524 * - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
525 * field, called "nxm_value". The nx_match matches only packets in which
526 * the field equals nxm_value.
528 * - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
529 * field (nxm_value), followed by a bitmask of the same length as the
530 * value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
531 * nx_match matches only packets for which bit J in the given field's value
532 * matches bit J in nxm_value. A 0-bit in nxm_mask causes the
533 * corresponding bits in nxm_value and the field's value to be ignored.
534 * (The sense of the nxm_mask bits is the opposite of that used by the
535 * "wildcards" member of struct ofp_match.)
537 * When nxm_hasmask is 1, nxm_length is always even.
539 * An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
540 * entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for
543 * When there are multiple "nxm_entry"s, all of the constraints must be met.
549 * Masks may be restricted:
551 * - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
552 * must always be 0 when these fields are specified. For example, the
553 * field that identifies the port on which a packet was received may not be
556 * - Some nxm_types that do support masked wildcards may only support certain
557 * nxm_mask patterns. For example, fields that have IPv4 address values
558 * may be restricted to CIDR masks.
560 * These restrictions should be noted in specifications for individual fields.
561 * A switch may accept an nxm_hasmask or nxm_mask value that the specification
562 * disallows, if the switch correctly implements support for that nxm_hasmask
563 * or nxm_mask value. A switch must reject an attempt to set up a flow that
564 * contains a nxm_hasmask or nxm_mask value that it does not support.
567 * Prerequisite Restrictions
568 * =========================
570 * The presence of an nxm_entry with a given nxm_type may be restricted based
571 * on the presence of or values of other "nxm_entry"s. For example:
573 * - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
574 * preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
575 * and nxm_value=0x0800. That is, matching on the IP source address is
576 * allowed only if the Ethernet type is explicitly set to IP.
578 * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is preced
579 * by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
580 * nxm_value=0x0800 and another with nxm_type=NXM_OF_IP_PROTO,
581 * nxm_hasmask=0, nxm_value=6, in that order. That is, matching on the TCP
582 * source port is allowed only if the Ethernet type is IP and the IP
585 * These restrictions should be noted in specifications for individual fields.
586 * A switch may implement relaxed versions of these restrictions. A switch
587 * must reject an attempt to set up a flow that violates its restrictions.
590 * Ordering Restrictions
591 * =====================
593 * An nxm_entry that has prerequisite restrictions must appear after the
594 * "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an
595 * nx_match is not otherwise constrained.
597 * Any given nxm_type may appear in an nx_match at most once.
603 * These examples show the format of a single nxm_entry with particular
604 * nxm_hasmask and nxm_length values. The diagrams are labeled with field
605 * numbers and byte indexes.
608 * 8-bit nxm_value, nxm_hasmask=1, nxm_length=1:
611 * +------------+---+---+
613 * +------------+---+---+
616 * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
619 * +------------+------+
621 * +------------+------+
624 * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
627 * +------------+-------------+
628 * | header | nxm_value |
629 * +------------+-------------+
632 * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
635 * +------------+------------------+
636 * | header | nxm_value |
637 * +------------+------------------+
640 * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
643 * +------------+------------------+------------------+
644 * | header | nxm_value | nxm_mask |
645 * +------------+------------------+------------------+
651 * A switch should report an error in an nx_match using error type
652 * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch
653 * should report a specific error code, if one is assigned for the particular
654 * problem, but NXBRC_NXM_INVALID is also available to report a generic
658 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
659 (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
660 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
661 NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
662 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
663 NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
664 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
665 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
666 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
667 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
668 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
670 #define NXM_MAKE_WILD_HEADER(HEADER) \
671 NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
673 /* ## ------------------------------- ## */
674 /* ## OpenFlow 1.0-compatible fields. ## */
675 /* ## ------------------------------- ## */
677 /* Physical or virtual port on which the packet was received.
681 * Format: 16-bit integer in network byte order.
683 * Masking: Not maskable. */
684 #define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
686 /* Source or destination address in Ethernet header.
690 * Format: 48-bit Ethernet MAC address.
692 * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
693 * be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
694 * are all-0-bits or all-1-bits). Support for other patterns and for masking
695 * of NXM_OF_ETH_SRC is optional. */
696 #define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
697 #define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
698 #define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
700 /* Packet's Ethernet type.
702 * For an Ethernet II packet this is taken from the Ethernet header. For an
703 * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
704 * A packet that has neither format has value 0x05ff
705 * (OFP_DL_TYPE_NOT_ETH_TYPE).
707 * For a packet with an 802.1Q header, this is the type of the encapsulated
712 * Format: 16-bit integer in network byte order.
714 * Masking: Not maskable. */
715 #define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
719 * For a packet with an 802.1Q header, this is the Tag Control Information
720 * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
721 * header, this has value 0.
725 * Format: 16-bit integer in network byte order.
727 * Masking: Arbitrary masks.
729 * This field can be used in various ways:
731 * - If it is not constrained at all, the nx_match matches packets without
732 * an 802.1Q header or with an 802.1Q header that has any TCI value.
734 * - Testing for an exact match with 0 matches only packets without an
737 * - Testing for an exact match with a TCI value with CFI=1 matches packets
738 * that have an 802.1Q header with a specified VID and PCP.
740 * - Testing for an exact match with a nonzero TCI value with CFI=0 does
741 * not make sense. The switch may reject this combination.
743 * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
744 * packets that have an 802.1Q header with that VID (and any PCP).
746 * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
747 * packets that have an 802.1Q header with that PCP (and any VID).
749 * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
750 * header or with an 802.1Q header with a VID of 0.
752 #define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
753 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
755 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
757 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
759 * Format: 8-bit integer with 2 least-significant bits forced to 0.
761 * Masking: Not maskable. */
762 #define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
764 /* The "protocol" byte in the IP header.
766 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
768 * Format: 8-bit integer.
770 * Masking: Not maskable. */
771 #define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
773 /* The source or destination address in the IP header.
775 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
777 * Format: 32-bit integer in network byte order.
779 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
780 * high-order bits set to 1 and the other 32-N bits set to 0. */
781 #define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
782 #define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
783 #define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
784 #define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
786 /* The source or destination port in the TCP header.
789 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
790 * NXM_OF_IP_PROTO must match 6 exactly.
792 * Format: 16-bit integer in network byte order.
794 * Masking: Not maskable. */
795 #define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
796 #define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
798 /* The source or destination port in the UDP header.
801 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
802 * NXM_OF_IP_PROTO must match 17 exactly.
804 * Format: 16-bit integer in network byte order.
806 * Masking: Not maskable. */
807 #define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
808 #define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
810 /* The type or code in the ICMP header.
813 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
814 * NXM_OF_IP_PROTO must match 1 exactly.
816 * Format: 8-bit integer.
818 * Masking: Not maskable. */
819 #define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
820 #define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
824 * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
825 * otherwise. Only ARP opcodes between 1 and 255 should be specified for
828 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
830 * Format: 16-bit integer in network byte order.
832 * Masking: Not maskable. */
833 #define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
835 /* For an Ethernet+IP ARP packet, the source or target protocol address
836 * in the ARP header. Always 0 otherwise.
838 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
840 * Format: 32-bit integer in network byte order.
842 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
843 * high-order bits set to 1 and the other 32-N bits set to 0. */
844 #define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
845 #define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
846 #define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
847 #define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
849 /* ## ------------------------ ## */
850 /* ## Nicira match extensions. ## */
851 /* ## ------------------------ ## */
853 /* Metadata registers.
855 * Registers initially have value 0. Actions allow register values to be
860 * Format: Array of 32-bit integer registers. Space is reserved for up to
861 * NXM_NX_MAX_REGS registers, but switches may implement fewer.
863 * Masking: Arbitrary masks. */
864 #define NXM_NX_MAX_REGS 16
865 #define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
866 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
867 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
868 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
869 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
870 #define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
871 #define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
872 #define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
873 #define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
874 #define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
875 #define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
876 #define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
877 #define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
881 * For a packet received via GRE tunnel including a (32-bit) key, the key is
882 * stored in the low 32-bits and the high bits are zeroed. For other packets,
887 * Format: 64-bit integer in network byte order.
889 * Masking: Arbitrary masks. */
890 #define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
891 #define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
893 /* ## --------------------- ## */
894 /* ## Requests and replies. ## */
895 /* ## --------------------- ## */
897 enum nx_flow_format {
898 NXFF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
899 NXFF_TUN_ID_FROM_COOKIE = 1, /* OpenFlow 1.0, plus obtain tunnel ID from
901 NXFF_NXM = 2 /* Nicira extended match. */
904 /* NXT_SET_FLOW_FORMAT request. */
905 struct nxt_set_flow_format {
906 struct ofp_header header;
907 ovs_be32 vendor; /* NX_VENDOR_ID. */
908 ovs_be32 subtype; /* NXT_SET_FLOW_FORMAT. */
909 ovs_be32 format; /* One of NXFF_*. */
911 OFP_ASSERT(sizeof(struct nxt_set_flow_format) == 20);
913 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */
915 struct nicira_header nxh;
916 ovs_be64 cookie; /* Opaque controller-issued identifier. */
917 ovs_be16 command; /* One of OFPFC_*. */
918 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
919 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
920 ovs_be16 priority; /* Priority level of flow entry. */
921 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
922 Not meaningful for OFPFC_DELETE*. */
923 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
924 matching entries to include this as an
925 output port. A value of OFPP_NONE
926 indicates no restriction. */
927 ovs_be16 flags; /* One of OFPFF_*. */
928 ovs_be16 match_len; /* Size of nx_match. */
929 uint8_t pad[6]; /* Align to 64-bits. */
931 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
932 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
933 * all-zero bytes, then
934 * - Actions to fill out the remainder of the message length (always a
938 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
940 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
941 struct nx_flow_removed {
942 struct nicira_header nxh;
943 ovs_be64 cookie; /* Opaque controller-issued identifier. */
944 ovs_be16 priority; /* Priority level of flow entry. */
945 uint8_t reason; /* One of OFPRR_*. */
946 uint8_t pad[1]; /* Align to 32-bits. */
947 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
948 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
950 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
951 ovs_be16 match_len; /* Size of nx_match. */
952 ovs_be64 packet_count;
955 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
956 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
959 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
961 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
963 struct nx_flow_stats_request {
964 struct nicira_stats_msg nsm;
965 ovs_be16 out_port; /* Require matching entries to include this
966 as an output port. A value of OFPP_NONE
967 indicates no restriction. */
968 ovs_be16 match_len; /* Length of nx_match. */
969 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
970 or 0xff for all tables. */
971 uint8_t pad[3]; /* Align to 64 bits. */
973 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
974 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
975 * all-zero bytes, which must also exactly fill out the length of the
979 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
981 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
982 * OFPST_FLOW reply). */
983 struct nx_flow_stats {
984 ovs_be16 length; /* Length of this entry. */
985 uint8_t table_id; /* ID of table flow came from. */
987 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
988 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
989 beyond duration_sec. */
990 ovs_be16 priority; /* Priority of the entry. Only meaningful
991 when this is not an exact-match entry. */
992 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
993 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
994 ovs_be16 match_len; /* Length of nx_match. */
995 uint8_t pad2[4]; /* Align to 64 bits. */
996 ovs_be64 cookie; /* Opaque controller-issued identifier. */
997 ovs_be64 packet_count; /* Number of packets in flow. */
998 ovs_be64 byte_count; /* Number of bytes in flow. */
1000 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1001 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1002 * all-zero bytes, then
1003 * - Actions to fill out the remainder 'length' bytes (always a multiple
1007 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1009 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1010 * OFPST_AGGREGATE request). */
1011 struct nx_aggregate_stats_request {
1012 struct nicira_stats_msg nsm;
1013 ovs_be16 out_port; /* Require matching entries to include this
1014 as an output port. A value of OFPP_NONE
1015 indicates no restriction. */
1016 ovs_be16 match_len; /* Length of nx_match. */
1017 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1018 or 0xff for all tables. */
1019 uint8_t pad[3]; /* Align to 64 bits. */
1021 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1022 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1023 * all-zero bytes, which must also exactly fill out the length of the
1027 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1029 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1030 * OFPST_AGGREGATE reply).
1032 * ofp_aggregate_stats_reply does not contain an ofp_match structure, so we
1033 * reuse it entirely. (It would be very odd to use OFPST_AGGREGATE to reply to
1034 * an NXST_AGGREGATE request, so we don't do that.) */
1035 struct nx_aggregate_stats_reply {
1036 struct nicira_stats_msg nsm;
1037 struct ofp_aggregate_stats_reply asr;
1039 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1041 #endif /* openflow/nicira-ext.h */