2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 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,
106 /* A request specified a nonexistent table ID. (But NXFMFC_BAD_TABLE_ID is
107 * used instead, when it is appropriate, because that is such a special
109 NXBRC_BAD_TABLE_ID = 0x200,
111 /* NXT_ROLE_REQUEST specified an invalid role. */
112 NXBRC_BAD_ROLE = 0x201,
114 /* The in_port in an ofp_packet_out request is invalid. */
115 NXBRC_BAD_IN_PORT = 0x202
118 /* Additional "code" values for OFPET_FLOW_MOD_FAILED. */
119 enum nx_flow_mod_failed_code {
120 /* Generic hardware error. */
121 NXFMFC_HARDWARE = 0x100,
123 /* A nonexistent table ID was specified in the "command" field of struct
124 * ofp_flow_mod, when the nxt_flow_mod_table_id extension is enabled. */
125 NXFMFC_BAD_TABLE_ID = 0x101
128 /* Nicira vendor requests and replies. */
130 /* Header for Nicira vendor requests and replies. */
131 struct nicira_header {
132 struct ofp_header header;
133 ovs_be32 vendor; /* NX_VENDOR_ID. */
134 ovs_be32 subtype; /* One of NXT_* below. */
136 OFP_ASSERT(sizeof(struct nicira_header) == 16);
138 /* Values for the 'subtype' member of struct nicira_header. */
140 /* No longer used. */
141 NXT_STATUS_REQUEST__OBSOLETE = 0,
142 NXT_STATUS_REPLY__OBSOLETE = 1,
143 NXT_ACT_SET_CONFIG__OBSOLETE = 2,
144 NXT_ACT_GET_CONFIG__OBSOLETE = 3,
145 NXT_COMMAND_REQUEST__OBSOLETE = 4,
146 NXT_COMMAND_REPLY__OBSOLETE = 5,
147 NXT_FLOW_END_CONFIG__OBSOLETE = 6,
148 NXT_FLOW_END__OBSOLETE = 7,
149 NXT_MGMT__OBSOLETE = 8,
150 NXT_TUN_ID_FROM_COOKIE__OBSOLETE = 9,
152 /* Controller role support. The request body is struct nx_role_request.
153 * The reply echos the request. */
154 NXT_ROLE_REQUEST = 10,
157 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
158 NXT_SET_FLOW_FORMAT = 12, /* Set flow format. */
159 NXT_FLOW_MOD = 13, /* Analogous to OFPT_FLOW_MOD. */
160 NXT_FLOW_REMOVED = 14, /* Analogous to OFPT_FLOW_REMOVED. */
162 /* Use the upper 8 bits of the 'command' member in struct ofp_flow_mod to
163 * designate the table to which a flow is to be added? See the big comment
164 * on struct nx_flow_mod_table_id for more information. */
165 NXT_FLOW_MOD_TABLE_ID = 15,
167 /* Alternative PACKET_IN message formats. */
168 NXT_SET_PACKET_IN_FORMAT = 16, /* Set Packet In format. */
169 NXT_PACKET_IN = 17 /* Nicira Packet In. */
172 /* Header for Nicira vendor stats request and reply messages. */
173 struct nicira_stats_msg {
174 struct ofp_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
175 ovs_be32 subtype; /* One of NXST_* below. */
176 uint8_t pad[4]; /* Align to 64-bits. */
178 OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
180 /* Values for the 'subtype' member of struct nicira_stats_msg. */
181 enum nicira_stats_type {
182 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
183 NXST_FLOW, /* Analogous to OFPST_FLOW. */
184 NXST_AGGREGATE /* Analogous to OFPST_AGGREGATE. */
187 /* Fields to use when hashing flows. */
188 enum nx_hash_fields {
189 /* Ethernet source address (NXM_OF_ETH_SRC) only. */
190 NX_HASH_FIELDS_ETH_SRC,
192 /* L2 through L4, symmetric across src/dst. Specifically, each of the
193 * following fields, if present, is hashed (slashes separate symmetric
196 * - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
198 * - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
200 * - NXM_OF_IP_SRC / NXM_OF_IP_DST
201 * - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
203 NX_HASH_FIELDS_SYMMETRIC_L4
206 /* This command enables or disables an Open vSwitch extension that allows a
207 * controller to specify the OpenFlow table to which a flow should be added,
208 * instead of having the switch decide which table is most appropriate as
209 * required by OpenFlow 1.0. By default, the extension is disabled.
211 * When this feature is enabled, Open vSwitch treats struct ofp_flow_mod's
212 * 16-bit 'command' member as two separate fields. The upper 8 bits are used
213 * as the table ID, the lower 8 bits specify the command as usual. A table ID
214 * of 0xff is treated like a wildcarded table ID.
216 * The specific treatment of the table ID depends on the type of flow mod:
218 * - OFPFC_ADD: Given a specific table ID, the flow is always placed in that
219 * table. If an identical flow already exists in that table only, then it
220 * is replaced. If the flow cannot be placed in the specified table,
221 * either because the table is full or because the table cannot support
222 * flows of the given type, the switch replies with an
223 * OFPFMFC_ALL_TABLES_FULL error. (A controller can distinguish these
224 * cases by comparing the current and maximum number of entries reported
225 * in ofp_table_stats.)
227 * If the table ID is wildcarded, the switch picks an appropriate table
228 * itself. If an identical flow already exist in the selected flow table,
229 * then it is replaced. The choice of table might depend on the flows
230 * that are already in the switch; for example, if one table fills up then
231 * the switch might fall back to another one.
233 * - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows
234 * within that table are matched and modified or deleted. If the table ID
235 * is wildcarded, flows within any table may be matched and modified or
238 * - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID,
239 * only a flow within that table may be matched and modified or deleted.
240 * If the table ID is wildcarded and exactly one flow within any table
241 * matches, then it is modified or deleted; if flows in more than one
242 * table match, then none is modified or deleted.
244 struct nx_flow_mod_table_id {
245 struct ofp_header header;
246 uint32_t vendor; /* NX_VENDOR_ID. */
247 uint32_t subtype; /* NXT_FLOW_MOD_TABLE_ID. */
248 uint8_t set; /* Nonzero to enable, zero to disable. */
251 OFP_ASSERT(sizeof(struct nx_flow_mod_table_id) == 24);
253 enum nx_packet_in_format {
254 NXPIF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
255 NXPIF_NXM = 1 /* Nicira Extended. */
258 /* NXT_SET_PACKET_IN_FORMAT request. */
259 struct nx_set_packet_in_format {
260 struct nicira_header nxh;
261 ovs_be32 format; /* One of NXPIF_*. */
263 OFP_ASSERT(sizeof(struct nx_set_packet_in_format) == 20);
265 /* NXT_PACKET_IN (analogous to OFPT_PACKET_IN).
267 * The NXT_PACKET_IN format is intended to model the OpenFlow-1.2 PACKET_IN
268 * with some minor tweaks. Most notably NXT_PACKET_IN includes the cookie of
269 * the rule which triggered the NXT_PACKET_IN message, and the match fields are
272 * The match fields in the NXT_PACKET_IN are intended to contain flow
273 * processing metadata collected at the time the NXT_PACKET_IN message was
274 * triggered. It is minimally required to contain the NXM_OF_IN_PORT of the
275 * packet, but may include other NXM headers such as flow registers. The match
276 * fields are allowed to contain non-metadata (e.g. NXM_OF_ETH_SRC etc).
277 * However, this information can typically be found in the packet directly, so
278 * it may be redundant.
280 * Whereas in most cases a controller can expect to only get back NXM fields
281 * that it set up itself (e.g. flow dumps will ordinarily report only NXM
282 * fields from flows that the controller added), NXT_PACKET_IN messages might
283 * contain fields that the controller does not understand, because the switch
284 * might support fields (new registers, new protocols, etc.) that the
285 * controller does not. Â The controller must prepared to tolerate these.
287 * The 'cookie' and 'table_id' fields have no meaning when 'reason' is
288 * OFPR_NO_MATCH. In this case they should be set to 0. */
289 struct nx_packet_in {
290 struct nicira_header nxh;
291 ovs_be32 buffer_id; /* ID assigned by datapath. */
292 ovs_be16 total_len; /* Full length of frame. */
293 uint8_t reason; /* Reason packet is sent (one of OFPR_*). */
294 uint8_t table_id; /* ID of the table that was looked up. */
295 ovs_be64 cookie; /* Cookie of the rule that was looked up. */
296 ovs_be16 match_len; /* Size of nx_match. */
297 uint8_t pad[6]; /* Align to 64-bits. */
299 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
300 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
301 * all-zero bytes, then
302 * - Exactly 2 all-zero padding bytes, then
303 * - An Ethernet frame whose length is inferred from nxh.header.length.
305 * The padding bytes preceding the Ethernet frame ensure that the IP
306 * header (if any) following the Ethernet header is 32-bit aligned. */
308 /* uint8_t nxm_fields[...]; */ /* Match. */
309 /* uint8_t pad[2]; */ /* Align to 64 bit + 16 bit. */
310 /* uint8_t data[0]; */ /* Ethernet frame. */
312 OFP_ASSERT(sizeof(struct nx_packet_in) == 40);
314 /* Configures the "role" of the sending controller. The default role is:
316 * - Other (NX_ROLE_OTHER), which allows the controller access to all
319 * The other possible roles are a related pair:
321 * - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
322 * be at most one Master controller at a time: when a controller
323 * configures itself as Master, any existing Master is demoted to the
326 * - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
327 * OpenFlow features. In particular attempts to modify the flow table
328 * will be rejected with an OFPBRC_EPERM error.
330 * Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
331 * messages, but they do receive OFPT_PORT_STATUS messages.
333 struct nx_role_request {
334 struct nicira_header nxh;
335 ovs_be32 role; /* One of NX_ROLE_*. */
339 NX_ROLE_OTHER, /* Default role, full access. */
340 NX_ROLE_MASTER, /* Full access, at most one. */
341 NX_ROLE_SLAVE /* Read-only access. */
344 /* Nicira vendor flow actions. */
346 enum nx_action_subtype {
347 NXAST_SNAT__OBSOLETE, /* No longer used. */
348 NXAST_RESUBMIT, /* struct nx_action_resubmit */
349 NXAST_SET_TUNNEL, /* struct nx_action_set_tunnel */
350 NXAST_DROP_SPOOFED_ARP__OBSOLETE,
351 NXAST_SET_QUEUE, /* struct nx_action_set_queue */
352 NXAST_POP_QUEUE, /* struct nx_action_pop_queue */
353 NXAST_REG_MOVE, /* struct nx_action_reg_move */
354 NXAST_REG_LOAD, /* struct nx_action_reg_load */
355 NXAST_NOTE, /* struct nx_action_note */
356 NXAST_SET_TUNNEL64, /* struct nx_action_set_tunnel64 */
357 NXAST_MULTIPATH, /* struct nx_action_multipath */
358 NXAST_AUTOPATH, /* struct nx_action_autopath */
359 NXAST_BUNDLE, /* struct nx_action_bundle */
360 NXAST_BUNDLE_LOAD, /* struct nx_action_bundle */
361 NXAST_RESUBMIT_TABLE, /* struct nx_action_resubmit */
362 NXAST_OUTPUT_REG, /* struct nx_action_output_reg */
363 NXAST_LEARN, /* struct nx_action_learn */
364 NXAST_EXIT, /* struct nx_action_header */
365 NXAST_DEC_TTL, /* struct nx_action_header */
368 /* Header for Nicira-defined actions. */
369 struct nx_action_header {
370 ovs_be16 type; /* OFPAT_VENDOR. */
371 ovs_be16 len; /* Length is 16. */
372 ovs_be32 vendor; /* NX_VENDOR_ID. */
373 ovs_be16 subtype; /* NXAST_*. */
376 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
378 /* Action structures for NXAST_RESUBMIT and NXAST_RESUBMIT_TABLE.
380 * These actions search one of the switch's flow tables:
382 * - For NXAST_RESUBMIT_TABLE only, if the 'table' member is not 255, then
383 * it specifies the table to search.
385 * - Otherwise (for NXAST_RESUBMIT_TABLE with a 'table' of 255, or for
386 * NXAST_RESUBMIT regardless of 'table'), it searches the current flow
387 * table, that is, the OpenFlow flow table that contains the flow from
388 * which this action was obtained. If this action did not come from a
389 * flow table (e.g. it came from an OFPT_PACKET_OUT message), then table 0
390 * is the current table.
392 * The flow table lookup uses a flow that may be slightly modified from the
395 * - For NXAST_RESUBMIT, the 'in_port' member of struct nx_action_resubmit
396 * is used as the flow's in_port.
398 * - For NXAST_RESUBMIT_TABLE, if the 'in_port' member is not OFPP_IN_PORT,
399 * then its value is used as the flow's in_port. Otherwise, the original
402 * - If actions that modify the flow (e.g. OFPAT_SET_VLAN_VID) precede the
403 * resubmit action, then the flow is updated with the new values.
405 * Following the lookup, the original in_port is restored.
407 * If the modified flow matched in the flow table, then the corresponding
408 * actions are executed. Afterward, actions following the resubmit in the
409 * original set of actions, if any, are executed; any changes made to the
410 * packet (e.g. changes to VLAN) by secondary actions persist when those
411 * actions are executed, although the original in_port is restored.
413 * Resubmit actions may be used any number of times within a set of actions.
415 * Resubmit actions may nest to an implementation-defined depth. Beyond this
416 * implementation-defined depth, further resubmit actions are simply ignored.
418 * NXAST_RESUBMIT ignores 'table' and 'pad'. NXAST_RESUBMIT_TABLE requires
419 * 'pad' to be all-bits-zero.
421 * Open vSwitch 1.0.1 and earlier did not support recursion. Open vSwitch
422 * before 1.2.90 did not support NXAST_RESUBMIT_TABLE.
424 struct nx_action_resubmit {
425 ovs_be16 type; /* OFPAT_VENDOR. */
426 ovs_be16 len; /* Length is 16. */
427 ovs_be32 vendor; /* NX_VENDOR_ID. */
428 ovs_be16 subtype; /* NXAST_RESUBMIT. */
429 ovs_be16 in_port; /* New in_port for checking flow table. */
430 uint8_t table; /* NXAST_RESUBMIT_TABLE: table to use. */
433 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
435 /* Action structure for NXAST_SET_TUNNEL.
437 * Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32
438 * bits of the tunnel ID are set to 0. */
439 struct nx_action_set_tunnel {
440 ovs_be16 type; /* OFPAT_VENDOR. */
441 ovs_be16 len; /* Length is 16. */
442 ovs_be32 vendor; /* NX_VENDOR_ID. */
443 ovs_be16 subtype; /* NXAST_SET_TUNNEL. */
445 ovs_be32 tun_id; /* Tunnel ID. */
447 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
449 /* Action structure for NXAST_SET_TUNNEL64.
451 * Sets the encapsulating tunnel ID to a 64-bit value. */
452 struct nx_action_set_tunnel64 {
453 ovs_be16 type; /* OFPAT_VENDOR. */
454 ovs_be16 len; /* Length is 16. */
455 ovs_be32 vendor; /* NX_VENDOR_ID. */
456 ovs_be16 subtype; /* NXAST_SET_TUNNEL64. */
458 ovs_be64 tun_id; /* Tunnel ID. */
460 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
462 /* Action structure for NXAST_SET_QUEUE.
464 * Set the queue that should be used when packets are output. This is similar
465 * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
466 * an argument. This allows the queue to be defined before the port is
468 struct nx_action_set_queue {
469 ovs_be16 type; /* OFPAT_VENDOR. */
470 ovs_be16 len; /* Length is 16. */
471 ovs_be32 vendor; /* NX_VENDOR_ID. */
472 ovs_be16 subtype; /* NXAST_SET_QUEUE. */
474 ovs_be32 queue_id; /* Where to enqueue packets. */
476 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
478 /* Action structure for NXAST_POP_QUEUE.
480 * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
481 * were used. Only the original queue can be restored this way; no stack is
483 struct nx_action_pop_queue {
484 ovs_be16 type; /* OFPAT_VENDOR. */
485 ovs_be16 len; /* Length is 16. */
486 ovs_be32 vendor; /* NX_VENDOR_ID. */
487 ovs_be16 subtype; /* NXAST_POP_QUEUE. */
490 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
492 /* Action structure for NXAST_REG_MOVE.
494 * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
495 * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
496 * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
497 * the next most significant bit, and so on.
499 * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
500 * sense to use nxm_hasmask=1 because the action does not do any kind of
501 * matching; it uses the actual value of a field.)
503 * The following nxm_header values are potentially acceptable as 'src':
526 * - NXM_NX_ICMPV6_TYPE
527 * - NXM_NX_ICMPV6_CODE
530 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
532 * The following nxm_header values are potentially acceptable as 'dst':
543 * Modifying any of the above fields changes the corresponding packet
546 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
548 * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
549 * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
550 * header (if any), ignoring the other bits. Setting a value with CFI=1
551 * adds or modifies the 802.1Q header appropriately, setting the TCI field
552 * to the field's new value (with the CFI bit masked out).
554 * - NXM_NX_TUN_ID. Modifying this value modifies the tunnel ID used for the
555 * packet's next tunnel encapsulation.
557 * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
558 * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
559 * used only if the flow's nx_match includes an nxm_entry that specifies
560 * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
562 * The switch will reject actions for which src_ofs+n_bits is greater than the
563 * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
564 * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
566 struct nx_action_reg_move {
567 ovs_be16 type; /* OFPAT_VENDOR. */
568 ovs_be16 len; /* Length is 16. */
569 ovs_be32 vendor; /* NX_VENDOR_ID. */
570 ovs_be16 subtype; /* NXAST_REG_MOVE. */
571 ovs_be16 n_bits; /* Number of bits. */
572 ovs_be16 src_ofs; /* Starting bit offset in source. */
573 ovs_be16 dst_ofs; /* Starting bit offset in destination. */
574 ovs_be32 src; /* Source register. */
575 ovs_be32 dst; /* Destination register. */
577 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
579 /* Action structure for NXAST_REG_LOAD.
581 * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
582 * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
583 * starts at 0 for the least-significant bit, 1 for the next most significant
586 * 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for
587 * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
590 * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
591 * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
592 * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
593 * also stored as one less than its true value:
596 * +------------------------------+------------------+
597 * | ofs | n_bits - 1 |
598 * +------------------------------+------------------+
600 * The switch will reject actions for which ofs+n_bits is greater than the
601 * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
602 * greater are set to 1, with error type OFPET_BAD_ACTION, code
603 * OFPBAC_BAD_ARGUMENT.
605 struct nx_action_reg_load {
606 ovs_be16 type; /* OFPAT_VENDOR. */
607 ovs_be16 len; /* Length is 16. */
608 ovs_be32 vendor; /* NX_VENDOR_ID. */
609 ovs_be16 subtype; /* NXAST_REG_LOAD. */
610 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
611 ovs_be32 dst; /* Destination register. */
612 ovs_be64 value; /* Immediate value. */
614 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
616 /* Action structure for NXAST_NOTE.
618 * This action has no effect. It is variable length. The switch does not
619 * attempt to interpret the user-defined 'note' data in any way. A controller
620 * can use this action to attach arbitrary metadata to a flow.
622 * This action might go away in the future.
624 struct nx_action_note {
625 ovs_be16 type; /* OFPAT_VENDOR. */
626 ovs_be16 len; /* A multiple of 8, but at least 16. */
627 ovs_be32 vendor; /* NX_VENDOR_ID. */
628 ovs_be16 subtype; /* NXAST_NOTE. */
629 uint8_t note[6]; /* Start of user-defined data. */
630 /* Possibly followed by additional user-defined data. */
632 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
634 /* Action structure for NXAST_MULTIPATH.
636 * This action performs the following steps in sequence:
638 * 1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
639 * Refer to the definition of "enum nx_mp_fields" for details.
641 * The 'basis' value is used as a universal hash parameter, that is,
642 * different values of 'basis' yield different hash functions. The
643 * particular universal hash function used is implementation-defined.
645 * The hashed fields' values are drawn from the current state of the
646 * flow, including all modifications that have been made by actions up to
649 * 2. Applies the multipath link choice algorithm specified by 'algorithm',
650 * one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm"
653 * The output of the algorithm is 'link', an unsigned integer less than
654 * or equal to 'max_link'.
656 * Some algorithms use 'arg' as an additional argument.
658 * 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of
659 * 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
662 * The switch will reject actions that have an unknown 'fields', or an unknown
663 * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
664 * in which 'max_link' is greater than or equal to 2**n_bits, with error type
665 * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
667 struct nx_action_multipath {
668 ovs_be16 type; /* OFPAT_VENDOR. */
669 ovs_be16 len; /* Length is 32. */
670 ovs_be32 vendor; /* NX_VENDOR_ID. */
671 ovs_be16 subtype; /* NXAST_MULTIPATH. */
673 /* What fields to hash and how. */
674 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
675 ovs_be16 basis; /* Universal hash parameter. */
678 /* Multipath link choice algorithm to apply to hash value. */
679 ovs_be16 algorithm; /* One of NX_MP_ALG_*. */
680 ovs_be16 max_link; /* Number of output links, minus 1. */
681 ovs_be32 arg; /* Algorithm-specific argument. */
684 /* Where to store the result. */
685 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
686 ovs_be32 dst; /* Destination. */
688 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
690 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
692 * In the descriptions below, 'n_links' is max_link + 1. */
693 enum nx_mp_algorithm {
694 /* link = hash(flow) % n_links.
696 * Redistributes all traffic when n_links changes. O(1) performance. See
699 * Use UINT16_MAX for max_link to get a raw hash value. */
702 /* link = hash(flow) / (MAX_HASH / n_links).
704 * Redistributes between one-quarter and one-half of traffic when n_links
705 * changes. O(1) performance. See RFC 2992.
707 NX_MP_ALG_HASH_THRESHOLD,
709 /* for i in [0,n_links):
710 * weights[i] = hash(flow, i)
711 * link = { i such that weights[i] >= weights[j] for all j != i }
713 * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
714 * performance. If n_links is greater than a threshold (currently 64, but
715 * subject to change), Open vSwitch will substitute another algorithm
716 * automatically. See RFC 2992. */
717 NX_MP_ALG_HRW, /* Highest Random Weight. */
722 * link = hash(flow, i) % arg
723 * while link > max_link
725 * Redistributes 1/n_links of traffic when n_links changes. O(1)
726 * performance when arg/max_link is bounded by a constant.
728 * Redistributes all traffic when arg changes.
730 * arg must be greater than max_link and for best performance should be no
731 * more than approximately max_link * 2. If arg is outside the acceptable
732 * range, Open vSwitch will automatically substitute the least power of 2
733 * greater than max_link.
735 * This algorithm is specific to Open vSwitch.
737 NX_MP_ALG_ITER_HASH /* Iterative Hash. */
740 /* Action structure for NXAST_LEARN.
742 * This action adds or modifies a flow in an OpenFlow table, similar to
743 * OFPT_FLOW_MOD with OFPFC_MODIFY_STRICT as 'command'. The new flow has the
744 * specified idle timeout, hard timeout, priority, cookie, and flags. The new
745 * flow's match criteria and actions are built by applying each of the series
746 * of flow_mod_spec elements included as part of the action.
748 * A flow_mod_spec starts with a 16-bit header. A header that is all-bits-0 is
749 * a no-op used for padding the action as a whole to a multiple of 8 bytes in
750 * length. Otherwise, the flow_mod_spec can be thought of as copying 'n_bits'
751 * bits from a source to a destination. In this case, the header contains
754 * 15 14 13 12 11 10 0
755 * +------+---+------+---------------------------------+
756 * | 0 |src| dst | n_bits |
757 * +------+---+------+---------------------------------+
759 * The meaning and format of a flow_mod_spec depends on 'src' and 'dst'. The
760 * following table summarizes the meaning of each possible combination.
761 * Details follow the table:
764 * --- --- ----------------------------------------------------------
765 * 0 0 Add match criteria based on value in a field.
766 * 1 0 Add match criteria based on an immediate value.
767 * 0 1 Add NXAST_REG_LOAD action to copy field into a different field.
768 * 1 1 Add NXAST_REG_LOAD action to load immediate value into a field.
769 * 0 2 Add OFPAT_OUTPUT action to output to port from specified field.
770 * All other combinations are undefined and not allowed.
772 * The flow_mod_spec header is followed by a source specification and a
773 * destination specification. The format and meaning of the source
774 * specification depends on 'src':
776 * - If 'src' is 0, the source bits are taken from a field in the flow to
777 * which this action is attached. (This should be a wildcarded field. If
778 * its value is fully specified then the source bits being copied have
781 * The source specification is an ovs_be32 'field' and an ovs_be16 'ofs'.
782 * 'field' is an nxm_header with nxm_hasmask=0, and 'ofs' the starting bit
783 * offset within that field. The source bits are field[ofs:ofs+n_bits-1].
784 * 'field' and 'ofs' are subject to the same restrictions as the source
785 * field in NXAST_REG_MOVE.
787 * - If 'src' is 1, the source bits are a constant value. The source
788 * specification is (n_bits+15)/16*2 bytes long. Taking those bytes as a
789 * number in network order, the source bits are the 'n_bits'
790 * least-significant bits. The switch will report an error if other bits
791 * in the constant are nonzero.
793 * The flow_mod_spec destination specification, for 'dst' of 0 or 1, is an
794 * ovs_be32 'field' and an ovs_be16 'ofs'. 'field' is an nxm_header with
795 * nxm_hasmask=0 and 'ofs' is a starting bit offset within that field. The
796 * meaning of the flow_mod_spec depends on 'dst':
798 * - If 'dst' is 0, the flow_mod_spec specifies match criteria for the new
799 * flow. The new flow matches only if bits field[ofs:ofs+n_bits-1] in a
800 * packet equal the source bits. 'field' may be any nxm_header with
801 * nxm_hasmask=0 that is allowed in NXT_FLOW_MOD.
803 * Order is significant. Earlier flow_mod_specs must satisfy any
804 * prerequisites for matching fields specified later, by copying constant
805 * values into prerequisite fields.
807 * The switch will reject flow_mod_specs that do not satisfy NXM masking
810 * - If 'dst' is 1, the flow_mod_spec specifies an NXAST_REG_LOAD action for
811 * the new flow. The new flow copies the source bits into
812 * field[ofs:ofs+n_bits-1]. Actions are executed in the same order as the
815 * The flow_mod_spec destination spec for 'dst' of 2 (when 'src' is 0) is
816 * empty. It has the following meaning:
818 * - The flow_mod_spec specifies an OFPAT_OUTPUT action for the new flow.
819 * The new flow outputs to the OpenFlow port specified by the source field.
820 * Of the special output ports with value OFPP_MAX or larger, OFPP_IN_PORT,
821 * OFPP_FLOOD, OFPP_LOCAL, and OFPP_ALL are supported. Other special ports
824 * Resource Management
825 * -------------------
827 * A switch has a finite amount of flow table space available for learning.
828 * When this space is exhausted, no new learning table entries will be learned
829 * until some existing flow table entries expire. The controller should be
830 * prepared to handle this by flooding (which can be implemented as a
831 * low-priority flow).
836 * The following examples give a prose description of the flow_mod_specs along
837 * with informal notation for how those would be represented and a hex dump of
838 * the bytes that would be required.
840 * These examples could work with various nx_action_learn parameters. Typical
841 * values would be idle_timeout=OFP_FLOW_PERMANENT, hard_timeout=60,
842 * priority=OFP_DEFAULT_PRIORITY, flags=0, table_id=10.
844 * 1. Learn input port based on the source MAC, with lookup into
845 * NXM_NX_REG1[16:31] by resubmit to in_port=99:
847 * Match on in_port=99:
848 * ovs_be16(src=1, dst=0, n_bits=16), 20 10
849 * ovs_be16(99), 00 63
850 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
852 * Match Ethernet destination on Ethernet source from packet:
853 * ovs_be16(src=0, dst=0, n_bits=48), 00 30
854 * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
855 * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
857 * Set NXM_NX_REG1[16:31] to the packet's input port:
858 * ovs_be16(src=0, dst=1, n_bits=16), 08 10
859 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
860 * ovs_be32(NXM_NX_REG1), ovs_be16(16) 00 01 02 04 00 10
862 * Given a packet that arrived on port A with Ethernet source address B,
863 * this would set up the flow "in_port=99, dl_dst=B,
864 * actions=load:A->NXM_NX_REG1[16..31]".
866 * In syntax accepted by ovs-ofctl, this action is: learn(in_port=99,
867 * NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
868 * load:NXM_OF_IN_PORT[]->NXM_NX_REG1[16..31])
870 * 2. Output to input port based on the source MAC and VLAN VID, with lookup
871 * into NXM_NX_REG1[16:31]:
873 * Match on same VLAN ID as packet:
874 * ovs_be16(src=0, dst=0, n_bits=12), 00 0c
875 * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
876 * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
878 * Match Ethernet destination on Ethernet source from packet:
879 * ovs_be16(src=0, dst=0, n_bits=48), 00 30
880 * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
881 * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
883 * Output to the packet's input port:
884 * ovs_be16(src=0, dst=2, n_bits=16), 10 10
885 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
887 * Given a packet that arrived on port A with Ethernet source address B in
888 * VLAN C, this would set up the flow "dl_dst=B, vlan_vid=C,
891 * In syntax accepted by ovs-ofctl, this action is:
892 * learn(NXM_OF_VLAN_TCI[0..11], NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
893 * output:NXM_OF_IN_PORT[])
895 * 3. Here's a recipe for a very simple-minded MAC learning switch. It uses a
896 * 10-second MAC expiration time to make it easier to see what's going on
898 * ovs-vsctl del-controller br0
899 * ovs-ofctl del-flows br0
900 * ovs-ofctl add-flow br0 "table=0 actions=learn(table=1, \
901 hard_timeout=10, NXM_OF_VLAN_TCI[0..11], \
902 NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[], \
903 output:NXM_OF_IN_PORT[]), resubmit(,1)"
904 * ovs-ofctl add-flow br0 "table=1 priority=0 actions=flood"
906 * You can then dump the MAC learning table with:
908 * ovs-ofctl dump-flows br0 table=1
913 * For best performance, segregate learned flows into a table that is not used
914 * for any other flows except possibly for a lowest-priority "catch-all" flow
915 * (a flow with no match criteria). If different learning actions specify
916 * different match criteria, use different tables for the learned flows.
918 * The meaning of 'hard_timeout' and 'idle_timeout' can be counterintuitive.
919 * These timeouts apply to the flow that is added, which means that a flow with
920 * an idle timeout will expire when no traffic has been sent *to* the learned
921 * address. This is not usually the intent in MAC learning; instead, we want
922 * the MAC learn entry to expire when no traffic has been sent *from* the
923 * learned address. Use a hard timeout for that.
925 struct nx_action_learn {
926 ovs_be16 type; /* OFPAT_VENDOR. */
927 ovs_be16 len; /* At least 24. */
928 ovs_be32 vendor; /* NX_VENDOR_ID. */
929 ovs_be16 subtype; /* NXAST_LEARN. */
930 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
931 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
932 ovs_be16 priority; /* Priority level of flow entry. */
933 ovs_be64 cookie; /* Cookie for new flow. */
934 ovs_be16 flags; /* Either 0 or OFPFF_SEND_FLOW_REM. */
935 uint8_t table_id; /* Table to insert flow entry. */
936 uint8_t pad[5]; /* Must be zero. */
937 /* Followed by a sequence of flow_mod_spec elements, as described above,
938 * until the end of the action is reached. */
940 OFP_ASSERT(sizeof(struct nx_action_learn) == 32);
942 #define NX_LEARN_N_BITS_MASK 0x3ff
944 #define NX_LEARN_SRC_FIELD (0 << 13) /* Copy from field. */
945 #define NX_LEARN_SRC_IMMEDIATE (1 << 13) /* Copy from immediate value. */
946 #define NX_LEARN_SRC_MASK (1 << 13)
948 #define NX_LEARN_DST_MATCH (0 << 11) /* Add match criterion. */
949 #define NX_LEARN_DST_LOAD (1 << 11) /* Add NXAST_REG_LOAD action. */
950 #define NX_LEARN_DST_OUTPUT (2 << 11) /* Add OFPAT_OUTPUT action. */
951 #define NX_LEARN_DST_RESERVED (3 << 11) /* Not yet defined. */
952 #define NX_LEARN_DST_MASK (3 << 11)
954 /* Action structure for NXAST_AUTOPATH.
956 * This action performs the following steps in sequence:
958 * 1. Hashes the flow using an implementation-defined hash function.
960 * The hashed fields' values are drawn from the current state of the
961 * flow, including all modifications that have been made by actions up to
964 * 2. Selects an OpenFlow 'port'.
966 * 'port' is selected in an implementation-defined manner, taking into
967 * account 'id' and the hash value calculated in step 1.
969 * Generally a switch will have been configured with a set of ports that
970 * may be chosen given 'id'. The switch may take into account any number
971 * of factors when choosing 'port' from its configured set. Factors may
972 * include carrier, load, and the results of configuration protocols such
975 * 3. Stores 'port' in dst[ofs:ofs+n_bits].
977 * The format and semantics of 'dst' and 'ofs_nbits' are similar to those
978 * for the NXAST_REG_LOAD action.
980 * The switch will reject actions in which ofs+n_bits is greater than the width
981 * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
983 struct nx_action_autopath {
984 ovs_be16 type; /* OFPAT_VENDOR. */
985 ovs_be16 len; /* Length is 20. */
986 ovs_be32 vendor; /* NX_VENDOR_ID. */
987 ovs_be16 subtype; /* NXAST_AUTOPATH. */
989 /* Where to store the result. */
990 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
991 ovs_be32 dst; /* Destination. */
993 ovs_be32 id; /* Autopath ID. */
996 OFP_ASSERT(sizeof(struct nx_action_autopath) == 24);
998 /* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD.
1000 * The bundle actions choose a slave from a supplied list of options.
1001 * NXAST_BUNDLE outputs to its selection. NXAST_BUNDLE_LOAD writes its
1002 * selection to a register.
1004 * The list of possible slaves follows the nx_action_bundle structure. The size
1005 * of each slave is governed by its type as indicated by the 'slave_type'
1006 * parameter. The list of slaves should be padded at its end with zeros to make
1007 * the total length of the action a multiple of 8.
1009 * Switches infer from the 'slave_type' parameter the size of each slave. All
1010 * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
1011 * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
1012 * 2 byte width. Switches should reject actions which indicate unknown or
1013 * unsupported slave types.
1015 * Switches use a strategy dictated by the 'algorithm' parameter to choose a
1016 * slave. If the switch does not support the specified 'algorithm' parameter,
1017 * it should reject the action.
1019 * Several algorithms take into account liveness when selecting slaves. The
1020 * liveness of a slave is implementation defined (with one exception), but will
1021 * generally take into account things like its carrier status and the results
1022 * of any link monitoring protocols which happen to be running on it. In order
1023 * to give controllers a place-holder value, the OFPP_NONE port is always
1026 * Some slave selection strategies require the use of a hash function, in which
1027 * case the 'fields' and 'basis' parameters should be populated. The 'fields'
1028 * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
1029 * hash. Refer to the definition of "enum nx_hash_fields" for details. The
1030 * 'basis' parameter is used as a universal hash parameter. Different values
1031 * of 'basis' yield different hash results.
1033 * The 'zero' parameter at the end of the action structure is reserved for
1034 * future use. Switches are required to reject actions which have nonzero
1035 * bytes in the 'zero' field.
1037 * NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed. Switches
1038 * should reject actions which have nonzero bytes in either of these fields.
1040 * NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in
1041 * dst[ofs:ofs+n_bits]. The format and semantics of 'dst' and 'ofs_nbits' are
1042 * similar to those for the NXAST_REG_LOAD action. */
1043 struct nx_action_bundle {
1044 ovs_be16 type; /* OFPAT_VENDOR. */
1045 ovs_be16 len; /* Length including slaves. */
1046 ovs_be32 vendor; /* NX_VENDOR_ID. */
1047 ovs_be16 subtype; /* NXAST_BUNDLE or NXAST_BUNDLE_LOAD. */
1049 /* Slave choice algorithm to apply to hash value. */
1050 ovs_be16 algorithm; /* One of NX_BD_ALG_*. */
1052 /* What fields to hash and how. */
1053 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
1054 ovs_be16 basis; /* Universal hash parameter. */
1056 ovs_be32 slave_type; /* NXM_OF_IN_PORT. */
1057 ovs_be16 n_slaves; /* Number of slaves. */
1059 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
1060 ovs_be32 dst; /* Destination. */
1062 uint8_t zero[4]; /* Reserved. Must be zero. */
1064 OFP_ASSERT(sizeof(struct nx_action_bundle) == 32);
1066 /* NXAST_BUNDLE: Bundle slave choice algorithm to apply.
1068 * In the descriptions below, 'slaves' is the list of possible slaves in the
1069 * order they appear in the OpenFlow action. */
1070 enum nx_bd_algorithm {
1071 /* Chooses the first live slave listed in the bundle.
1073 * O(n_slaves) performance. */
1074 NX_BD_ALG_ACTIVE_BACKUP,
1076 /* for i in [0,n_slaves):
1077 * weights[i] = hash(flow, i)
1078 * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
1080 * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
1081 * O(n_slaves) performance.
1083 * Uses the 'fields' and 'basis' parameters. */
1084 NX_BD_ALG_HRW /* Highest Random Weight. */
1087 /* Action structure for NXAST_OUTPUT_REG.
1089 * Outputs to the OpenFlow port number written to src[ofs:ofs+nbits].
1091 * The format and semantics of 'src' and 'ofs_nbits' are similar to those for
1092 * the NXAST_REG_LOAD action.
1094 * The acceptable nxm_header values for 'src' are the same as the acceptable
1095 * nxm_header values for the 'src' field of NXAST_REG_MOVE.
1097 * The 'max_len' field indicates the number of bytes to send when the chosen
1098 * port is OFPP_CONTROLLER. Its semantics are equivalent to the 'max_len'
1099 * field of OFPAT_OUTPUT.
1101 * The 'zero' field is required to be zeroed for forward compatibility. */
1102 struct nx_action_output_reg {
1103 ovs_be16 type; /* OFPAT_VENDOR. */
1104 ovs_be16 len; /* 24. */
1105 ovs_be32 vendor; /* NX_VENDOR_ID. */
1106 ovs_be16 subtype; /* NXAST_OUTPUT_REG. */
1108 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
1109 ovs_be32 src; /* Source. */
1111 ovs_be16 max_len; /* Max length to send to controller. */
1113 uint8_t zero[6]; /* Reserved, must be zero. */
1115 OFP_ASSERT(sizeof(struct nx_action_output_reg) == 24);
1119 * Discontinues action processing.
1121 * The NXAST_EXIT action causes the switch to immediately halt processing
1122 * actions for the flow. Any actions which have already been processed are
1123 * executed by the switch. However, any further actions, including those which
1124 * may be in different tables, or different levels of the NXAST_RESUBMIT
1125 * hierarchy, will be ignored.
1127 * Uses the nx_action_header structure. */
1129 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
1131 * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches. This
1132 * structure is fixed-length and hence difficult to extend. This section
1133 * describes a more flexible, variable-length flow match, called "nx_match" for
1134 * short, that is also supported by Open vSwitch. This section also defines a
1135 * replacement for each OpenFlow message that includes struct ofp_match.
1141 * An nx_match is a sequence of zero or more "nxm_entry"s, which are
1142 * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
1143 * "nxm_entry"s are not aligned on or padded to any multibyte boundary. The
1144 * first 4 bytes of an nxm_entry are its "header", followed by the entry's
1147 * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
1149 * |<-------------------- nxm_type ------------------>|
1151 * |31 16 15 9| 8 7 0
1152 * +----------------------------------+---------------+--+------------------+
1153 * | nxm_vendor | nxm_field |hm| nxm_length |
1154 * +----------------------------------+---------------+--+------------------+
1156 * The most-significant 23 bits of the header are collectively "nxm_type".
1157 * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
1158 * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
1159 * designates a protocol header, such as the Ethernet type, but it can also
1160 * refer to packet metadata, such as the switch port on which a packet arrived.
1162 * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
1163 * of this bit is explained later.
1165 * The least-significant 8 bits are "nxm_length", a positive integer. The
1166 * length of the nxm_entry, including the header, is exactly 4 + nxm_length
1169 * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
1170 * constant. It is included only to allow software to minimally parse
1171 * "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor,
1172 * nxm_field, and nxm_length, nxm_hasmask is a constant.)
1178 * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
1180 * An nxm_entry places a constraint on the packets matched by the nx_match:
1182 * - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
1183 * field, called "nxm_value". The nx_match matches only packets in which
1184 * the field equals nxm_value.
1186 * - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
1187 * field (nxm_value), followed by a bitmask of the same length as the
1188 * value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
1189 * nx_match matches only packets for which bit J in the given field's value
1190 * matches bit J in nxm_value. A 0-bit in nxm_mask causes the
1191 * corresponding bits in nxm_value and the field's value to be ignored.
1192 * (The sense of the nxm_mask bits is the opposite of that used by the
1193 * "wildcards" member of struct ofp_match.)
1195 * When nxm_hasmask is 1, nxm_length is always even.
1197 * An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
1198 * entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for
1201 * When there are multiple "nxm_entry"s, all of the constraints must be met.
1207 * Masks may be restricted:
1209 * - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
1210 * must always be 0 when these fields are specified. For example, the
1211 * field that identifies the port on which a packet was received may not be
1214 * - Some nxm_types that do support masked wildcards may only support certain
1215 * nxm_mask patterns. For example, fields that have IPv4 address values
1216 * may be restricted to CIDR masks.
1218 * These restrictions should be noted in specifications for individual fields.
1219 * A switch may accept an nxm_hasmask or nxm_mask value that the specification
1220 * disallows, if the switch correctly implements support for that nxm_hasmask
1221 * or nxm_mask value. A switch must reject an attempt to set up a flow that
1222 * contains a nxm_hasmask or nxm_mask value that it does not support.
1225 * Prerequisite Restrictions
1226 * =========================
1228 * The presence of an nxm_entry with a given nxm_type may be restricted based
1229 * on the presence of or values of other "nxm_entry"s. For example:
1231 * - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
1232 * preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
1233 * and nxm_value=0x0800. That is, matching on the IP source address is
1234 * allowed only if the Ethernet type is explicitly set to IP.
1236 * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is
1237 * preceded by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and
1238 * nxm_value either 0x0800 or 0x86dd, and another with
1239 * nxm_type=NXM_OF_IP_PROTO, nxm_hasmask=0, nxm_value=6, in that order.
1240 * That is, matching on the TCP source port is allowed only if the Ethernet
1241 * type is IP or IPv6 and the IP protocol is TCP.
1243 * These restrictions should be noted in specifications for individual fields.
1244 * A switch may implement relaxed versions of these restrictions. A switch
1245 * must reject an attempt to set up a flow that violates its restrictions.
1248 * Ordering Restrictions
1249 * =====================
1251 * An nxm_entry that has prerequisite restrictions must appear after the
1252 * "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an
1253 * nx_match is not otherwise constrained.
1255 * Any given nxm_type may appear in an nx_match at most once.
1258 * nxm_entry Examples
1259 * ==================
1261 * These examples show the format of a single nxm_entry with particular
1262 * nxm_hasmask and nxm_length values. The diagrams are labeled with field
1263 * numbers and byte indexes.
1266 * 8-bit nxm_value, nxm_hasmask=1, nxm_length=2:
1269 * +------------+---+---+
1270 * | header | v | m |
1271 * +------------+---+---+
1274 * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
1277 * +------------+------+
1279 * +------------+------+
1282 * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
1285 * +------------+-------------+
1286 * | header | nxm_value |
1287 * +------------+-------------+
1290 * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
1293 * +------------+------------------+
1294 * | header | nxm_value |
1295 * +------------+------------------+
1298 * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
1301 * +------------+------------------+------------------+
1302 * | header | nxm_value | nxm_mask |
1303 * +------------+------------------+------------------+
1309 * A switch should report an error in an nx_match using error type
1310 * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch
1311 * should report a specific error code, if one is assigned for the particular
1312 * problem, but NXBRC_NXM_INVALID is also available to report a generic
1316 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
1317 (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
1318 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
1319 NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
1320 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
1321 NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
1322 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
1323 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
1324 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
1325 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
1326 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
1328 #define NXM_MAKE_WILD_HEADER(HEADER) \
1329 NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
1331 /* ## ------------------------------- ## */
1332 /* ## OpenFlow 1.0-compatible fields. ## */
1333 /* ## ------------------------------- ## */
1335 /* Physical or virtual port on which the packet was received.
1339 * Format: 16-bit integer in network byte order.
1341 * Masking: Not maskable. */
1342 #define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
1344 /* Source or destination address in Ethernet header.
1348 * Format: 48-bit Ethernet MAC address.
1350 * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
1351 * be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
1352 * are all-0-bits or all-1-bits). Support for other patterns and for masking
1353 * of NXM_OF_ETH_SRC is optional. */
1354 #define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
1355 #define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
1356 #define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
1358 /* Packet's Ethernet type.
1360 * For an Ethernet II packet this is taken from the Ethernet header. For an
1361 * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
1362 * A packet that has neither format has value 0x05ff
1363 * (OFP_DL_TYPE_NOT_ETH_TYPE).
1365 * For a packet with an 802.1Q header, this is the type of the encapsulated
1370 * Format: 16-bit integer in network byte order.
1372 * Masking: Not maskable. */
1373 #define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
1377 * For a packet with an 802.1Q header, this is the Tag Control Information
1378 * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
1379 * header, this has value 0.
1383 * Format: 16-bit integer in network byte order.
1385 * Masking: Arbitrary masks.
1387 * This field can be used in various ways:
1389 * - If it is not constrained at all, the nx_match matches packets without
1390 * an 802.1Q header or with an 802.1Q header that has any TCI value.
1392 * - Testing for an exact match with 0 matches only packets without an
1395 * - Testing for an exact match with a TCI value with CFI=1 matches packets
1396 * that have an 802.1Q header with a specified VID and PCP.
1398 * - Testing for an exact match with a nonzero TCI value with CFI=0 does
1399 * not make sense. The switch may reject this combination.
1401 * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
1402 * packets that have an 802.1Q header with that VID (and any PCP).
1404 * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
1405 * packets that have an 802.1Q header with that PCP (and any VID).
1407 * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
1408 * header or with an 802.1Q header with a VID of 0.
1410 * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
1411 * header or with an 802.1Q header with a PCP of 0.
1413 * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
1414 * header or with an 802.1Q header with both VID and PCP of 0.
1416 #define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
1417 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
1419 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
1421 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1423 * Format: 8-bit integer with 2 least-significant bits forced to 0.
1425 * Masking: Not maskable. */
1426 #define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
1428 /* The "protocol" byte in the IP header.
1430 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1432 * Format: 8-bit integer.
1434 * Masking: Not maskable. */
1435 #define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
1437 /* The source or destination address in the IP header.
1439 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
1441 * Format: 32-bit integer in network byte order.
1443 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1444 * high-order bits set to 1 and the other 32-N bits set to 0. */
1445 #define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
1446 #define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
1447 #define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
1448 #define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
1450 /* The source or destination port in the TCP header.
1453 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1454 * NXM_OF_IP_PROTO must match 6 exactly.
1456 * Format: 16-bit integer in network byte order.
1458 * Masking: Not maskable. */
1459 #define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
1460 #define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
1462 /* The source or destination port in the UDP header.
1465 * NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1466 * NXM_OF_IP_PROTO must match 17 exactly.
1468 * Format: 16-bit integer in network byte order.
1470 * Masking: Not maskable. */
1471 #define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
1472 #define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
1474 /* The type or code in the ICMP header.
1477 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
1478 * NXM_OF_IP_PROTO must match 1 exactly.
1480 * Format: 8-bit integer.
1482 * Masking: Not maskable. */
1483 #define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
1484 #define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
1488 * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
1489 * otherwise. Only ARP opcodes between 1 and 255 should be specified for
1492 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1494 * Format: 16-bit integer in network byte order.
1496 * Masking: Not maskable. */
1497 #define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
1499 /* For an Ethernet+IP ARP packet, the source or target protocol address
1500 * in the ARP header. Always 0 otherwise.
1502 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1504 * Format: 32-bit integer in network byte order.
1506 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1507 * high-order bits set to 1 and the other 32-N bits set to 0. */
1508 #define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
1509 #define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
1510 #define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
1511 #define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
1513 /* ## ------------------------ ## */
1514 /* ## Nicira match extensions. ## */
1515 /* ## ------------------------ ## */
1517 /* Metadata registers.
1519 * Registers initially have value 0. Actions allow register values to be
1524 * Format: Array of 32-bit integer registers. Space is reserved for up to
1525 * NXM_NX_MAX_REGS registers, but switches may implement fewer.
1527 * Masking: Arbitrary masks. */
1528 #define NXM_NX_MAX_REGS 16
1529 #define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
1530 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1531 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1532 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1533 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1534 #define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
1535 #define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
1536 #define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
1537 #define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
1538 #define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
1539 #define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
1540 #define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
1541 #define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
1542 #define NXM_NX_REG4 NXM_HEADER (0x0001, 4, 4)
1543 #define NXM_NX_REG4_W NXM_HEADER_W(0x0001, 4, 4)
1547 * For a packet received via GRE tunnel including a (32-bit) key, the key is
1548 * stored in the low 32-bits and the high bits are zeroed. For other packets,
1553 * Format: 64-bit integer in network byte order.
1555 * Masking: Arbitrary masks. */
1556 #define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
1557 #define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
1559 /* For an Ethernet+IP ARP packet, the source or target hardware address
1560 * in the ARP header. Always 0 otherwise.
1562 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1564 * Format: 48-bit Ethernet MAC address.
1566 * Masking: Not maskable. */
1567 #define NXM_NX_ARP_SHA NXM_HEADER (0x0001, 17, 6)
1568 #define NXM_NX_ARP_THA NXM_HEADER (0x0001, 18, 6)
1570 /* The source or destination address in the IPv6 header.
1572 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1574 * Format: 128-bit IPv6 address.
1576 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1577 * high-order bits set to 1 and the other 128-N bits set to 0. */
1578 #define NXM_NX_IPV6_SRC NXM_HEADER (0x0001, 19, 16)
1579 #define NXM_NX_IPV6_SRC_W NXM_HEADER_W(0x0001, 19, 16)
1580 #define NXM_NX_IPV6_DST NXM_HEADER (0x0001, 20, 16)
1581 #define NXM_NX_IPV6_DST_W NXM_HEADER_W(0x0001, 20, 16)
1583 /* The type or code in the ICMPv6 header.
1586 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1587 * NXM_OF_IP_PROTO must match 58 exactly.
1589 * Format: 8-bit integer.
1591 * Masking: Not maskable. */
1592 #define NXM_NX_ICMPV6_TYPE NXM_HEADER (0x0001, 21, 1)
1593 #define NXM_NX_ICMPV6_CODE NXM_HEADER (0x0001, 22, 1)
1595 /* The target address in an IPv6 Neighbor Discovery message.
1598 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1599 * NXM_OF_IP_PROTO must match 58 exactly.
1600 * NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1602 * Format: 128-bit IPv6 address.
1604 * Masking: Not maskable. */
1605 #define NXM_NX_ND_TARGET NXM_HEADER (0x0001, 23, 16)
1607 /* The source link-layer address option in an IPv6 Neighbor Discovery
1611 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1612 * NXM_OF_IP_PROTO must match 58 exactly.
1613 * NXM_OF_ICMPV6_TYPE must be exactly 135.
1615 * Format: 48-bit Ethernet MAC address.
1617 * Masking: Not maskable. */
1618 #define NXM_NX_ND_SLL NXM_HEADER (0x0001, 24, 6)
1620 /* The target link-layer address option in an IPv6 Neighbor Discovery
1624 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1625 * NXM_OF_IP_PROTO must match 58 exactly.
1626 * NXM_OF_ICMPV6_TYPE must be exactly 136.
1628 * Format: 48-bit Ethernet MAC address.
1630 * Masking: Not maskable. */
1631 #define NXM_NX_ND_TLL NXM_HEADER (0x0001, 25, 6)
1633 /* IP fragment information.
1636 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1638 * Format: 8-bit value with one of the values 0, 1, or 3, as described below.
1640 * Masking: Fully maskable.
1642 * This field has three possible values:
1644 * - A packet that is not an IP fragment has value 0.
1646 * - A packet that is an IP fragment with offset 0 (the first fragment) has
1647 * bit 0 set and thus value 1.
1649 * - A packet that is an IP fragment with nonzero offset has bits 0 and 1 set
1652 * NX_IP_FRAG_ANY and NX_IP_FRAG_LATER are declared to symbolically represent
1653 * the meanings of bits 0 and 1.
1655 * The switch may reject matches against values that can never appear.
1657 * It is important to understand how this field interacts with the OpenFlow IP
1658 * fragment handling mode:
1660 * - In OFPC_FRAG_DROP mode, the OpenFlow switch drops all IP fragments
1661 * before they reach the flow table, so every packet that is available for
1662 * matching will have value 0 in this field.
1664 * - Open vSwitch does not implement OFPC_FRAG_REASM mode, but if it did then
1665 * IP fragments would be reassembled before they reached the flow table and
1666 * again every packet available for matching would always have value 0.
1668 * - In OFPC_FRAG_NORMAL mode, all three values are possible, but OpenFlow
1669 * 1.0 says that fragments' transport ports are always 0, even for the
1670 * first fragment, so this does not provide much extra information.
1672 * - In OFPC_FRAG_NX_MATCH mode, all three values are possible. For
1673 * fragments with offset 0, Open vSwitch makes L4 header information
1676 #define NXM_NX_IP_FRAG NXM_HEADER (0x0001, 26, 1)
1677 #define NXM_NX_IP_FRAG_W NXM_HEADER_W(0x0001, 26, 1)
1679 /* Bits in the value of NXM_NX_IP_FRAG. */
1680 #define NX_IP_FRAG_ANY (1 << 0) /* Is this a fragment? */
1681 #define NX_IP_FRAG_LATER (1 << 1) /* Is this a fragment with nonzero offset? */
1683 /* The flow label in the IPv6 header.
1685 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1687 * Format: 20-bit IPv6 flow label in least-significant bits.
1689 * Masking: Not maskable. */
1690 #define NXM_NX_IPV6_LABEL NXM_HEADER (0x0001, 27, 4)
1692 /* The ECN of the IP header.
1694 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1696 * Format: ECN in the low-order 2 bits.
1698 * Masking: Not maskable. */
1699 #define NXM_NX_IP_ECN NXM_HEADER (0x0001, 28, 1)
1701 /* The time-to-live/hop limit of the IP header.
1703 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1705 * Format: 8-bit integer.
1707 * Masking: Not maskable. */
1708 #define NXM_NX_IP_TTL NXM_HEADER (0x0001, 29, 1)
1712 * This may be used to gain the OpenFlow 1.1-like ability to restrict
1713 * certain NXM-based Flow Mod and Flow Stats Request messages to flows
1714 * with specific cookies. See the "nx_flow_mod" and "nx_flow_stats_request"
1715 * structure definitions for more details. This match is otherwise not
1720 * Format: 64-bit integer in network byte order.
1722 * Masking: Arbitrary masks. */
1723 #define NXM_NX_COOKIE NXM_HEADER (0x0001, 30, 8)
1724 #define NXM_NX_COOKIE_W NXM_HEADER_W(0x0001, 30, 8)
1726 /* ## --------------------- ## */
1727 /* ## Requests and replies. ## */
1728 /* ## --------------------- ## */
1730 enum nx_flow_format {
1731 NXFF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
1732 NXFF_NXM = 2 /* Nicira extended match. */
1735 /* NXT_SET_FLOW_FORMAT request. */
1736 struct nx_set_flow_format {
1737 struct ofp_header header;
1738 ovs_be32 vendor; /* NX_VENDOR_ID. */
1739 ovs_be32 subtype; /* NXT_SET_FLOW_FORMAT. */
1740 ovs_be32 format; /* One of NXFF_*. */
1742 OFP_ASSERT(sizeof(struct nx_set_flow_format) == 20);
1744 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD).
1746 * It is possible to limit flow deletions and modifications to certain
1747 * cookies by using the NXM_NX_COOKIE and NXM_NX_COOKIE_W matches. For
1748 * these commands, the "cookie" field is always ignored. Flow additions
1749 * make use of the "cookie" field and ignore any NXM_NX_COOKIE*
1752 struct nx_flow_mod {
1753 struct nicira_header nxh;
1754 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1755 ovs_be16 command; /* One of OFPFC_*. */
1756 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
1757 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
1758 ovs_be16 priority; /* Priority level of flow entry. */
1759 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
1760 Not meaningful for OFPFC_DELETE*. */
1761 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
1762 matching entries to include this as an
1763 output port. A value of OFPP_NONE
1764 indicates no restriction. */
1765 ovs_be16 flags; /* One of OFPFF_*. */
1766 ovs_be16 match_len; /* Size of nx_match. */
1767 uint8_t pad[6]; /* Align to 64-bits. */
1769 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1770 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1771 * all-zero bytes, then
1772 * - Actions to fill out the remainder of the message length (always a
1776 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
1778 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1779 struct nx_flow_removed {
1780 struct nicira_header nxh;
1781 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1782 ovs_be16 priority; /* Priority level of flow entry. */
1783 uint8_t reason; /* One of OFPRR_*. */
1784 uint8_t pad[1]; /* Align to 32-bits. */
1785 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
1786 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
1788 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
1789 ovs_be16 match_len; /* Size of nx_match. */
1790 ovs_be64 packet_count;
1791 ovs_be64 byte_count;
1793 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1794 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1795 * all-zero bytes. */
1797 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
1799 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1802 * It is possible to limit matches to certain cookies by using the
1803 * NXM_NX_COOKIE and NXM_NX_COOKIE_W matches.
1805 struct nx_flow_stats_request {
1806 struct nicira_stats_msg nsm;
1807 ovs_be16 out_port; /* Require matching entries to include this
1808 as an output port. A value of OFPP_NONE
1809 indicates no restriction. */
1810 ovs_be16 match_len; /* Length of nx_match. */
1811 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1812 or 0xff for all tables. */
1813 uint8_t pad[3]; /* Align to 64 bits. */
1815 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1816 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1817 * all-zero bytes, which must also exactly fill out the length of the
1821 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
1823 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1824 * OFPST_FLOW reply). */
1825 struct nx_flow_stats {
1826 ovs_be16 length; /* Length of this entry. */
1827 uint8_t table_id; /* ID of table flow came from. */
1829 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
1830 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
1831 beyond duration_sec. */
1832 ovs_be16 priority; /* Priority of the entry. Only meaningful
1833 when this is not an exact-match entry. */
1834 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
1835 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
1836 ovs_be16 match_len; /* Length of nx_match. */
1837 uint8_t pad2[4]; /* Align to 64 bits. */
1838 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1839 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1840 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1842 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1843 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1844 * all-zero bytes, then
1845 * - Actions to fill out the remainder 'length' bytes (always a multiple
1849 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1851 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1852 * OFPST_AGGREGATE request). */
1853 struct nx_aggregate_stats_request {
1854 struct nicira_stats_msg nsm;
1855 ovs_be16 out_port; /* Require matching entries to include this
1856 as an output port. A value of OFPP_NONE
1857 indicates no restriction. */
1858 ovs_be16 match_len; /* Length of nx_match. */
1859 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1860 or 0xff for all tables. */
1861 uint8_t pad[3]; /* Align to 64 bits. */
1863 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1864 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1865 * all-zero bytes, which must also exactly fill out the length of the
1869 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1871 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1872 * OFPST_AGGREGATE reply). */
1873 struct nx_aggregate_stats_reply {
1874 struct nicira_stats_msg nsm;
1875 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1876 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1877 ovs_be32 flow_count; /* Number of flows. */
1878 uint8_t pad[4]; /* Align to 64 bits. */
1880 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1882 #endif /* openflow/nicira-ext.h */