2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
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, 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. */
28 /* Nicira vendor-specific error messages extension.
30 * OpenFlow 1.0 has a set of predefined error types (OFPET_*) and codes (which
31 * are specific to each type). It does not have any provision for
32 * vendor-specific error codes, and it does not even provide "generic" error
33 * codes that can apply to problems not anticipated by the OpenFlow
34 * specification authors.
36 * This extension attempts to address the problem by adding a generic "error
37 * vendor extension". The extension works as follows: use NXET_VENDOR as type
38 * and NXVC_VENDOR_ERROR as code, followed by struct nx_vendor_error with
39 * vendor-specific details, followed by at least 64 bytes of the failed
42 * It would be better to have a type-specific vendor extension, e.g. so that
43 * OFPET_BAD_ACTION could be used with vendor-specific code values. But
44 * OFPET_BAD_ACTION and most other standardized types already specify that
45 * their 'data' values are (the start of) the OpenFlow message being replied
46 * to, so there is no room to insert a vendor ID.
48 * Currently this extension is only implemented by Open vSwitch, but it seems
49 * like a reasonable candidate for future standardization.
52 /* This is a random number to avoid accidental collision with any other
53 * vendor's extension. */
54 #define NXET_VENDOR 0xb0c2
56 /* ofp_error msg 'code' values for NXET_VENDOR. */
58 NXVC_VENDOR_ERROR /* 'data' contains struct nx_vendor_error. */
61 /* 'data' for 'type' == NXET_VENDOR, 'code' == NXVC_VENDOR_ERROR. */
62 struct nx_vendor_error {
63 ovs_be32 vendor; /* Vendor ID as in struct ofp_vendor_header. */
64 ovs_be16 type; /* Vendor-defined type. */
65 ovs_be16 code; /* Vendor-defined subtype. */
66 /* Followed by at least the first 64 bytes of the failed request. */
69 /* Nicira vendor requests and replies. */
71 /* Header for Nicira vendor requests and replies. */
72 struct nicira_header {
73 struct ofp_header header;
74 ovs_be32 vendor; /* NX_VENDOR_ID. */
75 ovs_be32 subtype; /* See the NXT numbers in ofp-msgs.h. */
77 OFP_ASSERT(sizeof(struct nicira_header) == 16);
79 /* Header for Nicira vendor stats request and reply messages in OpenFlow
81 struct nicira10_stats_msg {
82 struct ofp10_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
83 ovs_be32 subtype; /* One of NXST_* below. */
84 uint8_t pad[4]; /* Align to 64-bits. */
86 OFP_ASSERT(sizeof(struct nicira10_stats_msg) == 24);
88 /* Header for Nicira vendor stats request and reply messages in OpenFlow
90 struct nicira11_stats_msg {
91 struct ofp11_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
92 ovs_be32 subtype; /* One of NXST_* below. */
94 OFP_ASSERT(sizeof(struct nicira11_stats_msg) == 24);
96 /* Fields to use when hashing flows. */
98 /* Ethernet source address (NXM_OF_ETH_SRC) only. */
99 NX_HASH_FIELDS_ETH_SRC,
101 /* L2 through L4, symmetric across src/dst. Specifically, each of the
102 * following fields, if present, is hashed (slashes separate symmetric
105 * - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
107 * - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
109 * - NXM_OF_IP_SRC / NXM_OF_IP_DST
110 * - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
112 NX_HASH_FIELDS_SYMMETRIC_L4
115 /* This command enables or disables an Open vSwitch extension that allows a
116 * controller to specify the OpenFlow table to which a flow should be added,
117 * instead of having the switch decide which table is most appropriate as
118 * required by OpenFlow 1.0. Because NXM was designed as an extension to
119 * OpenFlow 1.0, the extension applies equally to ofp10_flow_mod and
120 * nx_flow_mod. By default, the extension is disabled.
122 * When this feature is enabled, Open vSwitch treats struct ofp10_flow_mod's
123 * and struct nx_flow_mod's 16-bit 'command' member as two separate fields.
124 * The upper 8 bits are used as the table ID, the lower 8 bits specify the
125 * command as usual. A table ID of 0xff is treated like a wildcarded table ID.
127 * The specific treatment of the table ID depends on the type of flow mod:
129 * - OFPFC_ADD: Given a specific table ID, the flow is always placed in that
130 * table. If an identical flow already exists in that table only, then it
131 * is replaced. If the flow cannot be placed in the specified table,
132 * either because the table is full or because the table cannot support
133 * flows of the given type, the switch replies with an OFPFMFC_TABLE_FULL
134 * error. (A controller can distinguish these cases by comparing the
135 * current and maximum number of entries reported in ofp_table_stats.)
137 * If the table ID is wildcarded, the switch picks an appropriate table
138 * itself. If an identical flow already exist in the selected flow table,
139 * then it is replaced. The choice of table might depend on the flows
140 * that are already in the switch; for example, if one table fills up then
141 * the switch might fall back to another one.
143 * - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows
144 * within that table are matched and modified or deleted. If the table ID
145 * is wildcarded, flows within any table may be matched and modified or
148 * - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID,
149 * only a flow within that table may be matched and modified or deleted.
150 * If the table ID is wildcarded and exactly one flow within any table
151 * matches, then it is modified or deleted; if flows in more than one
152 * table match, then none is modified or deleted.
154 struct nx_flow_mod_table_id {
155 uint8_t set; /* Nonzero to enable, zero to disable. */
158 OFP_ASSERT(sizeof(struct nx_flow_mod_table_id) == 8);
160 enum nx_packet_in_format {
161 NXPIF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
162 NXPIF_NXM = 1 /* Nicira Extended. */
165 /* NXT_SET_PACKET_IN_FORMAT request. */
166 struct nx_set_packet_in_format {
167 ovs_be32 format; /* One of NXPIF_*. */
169 OFP_ASSERT(sizeof(struct nx_set_packet_in_format) == 4);
171 /* NXT_PACKET_IN (analogous to OFPT_PACKET_IN).
173 * NXT_PACKET_IN is similar to the OpenFlow 1.2 OFPT_PACKET_IN. The
176 * - NXT_PACKET_IN includes the cookie of the rule that triggered the
177 * message. (OpenFlow 1.3 OFPT_PACKET_IN also includes the cookie.)
179 * - The metadata fields use NXM (instead of OXM) field numbers.
181 * Open vSwitch 1.9.0 and later omits metadata fields that are zero (as allowed
182 * by OpenFlow 1.2). Earlier versions included all implemented metadata
185 * Open vSwitch does not include non-metadata in the nx_match, because by
186 * definition that information can be found in the packet itself. The format
187 * and the standards allow this, however, so controllers should be prepared to
188 * tolerate future changes.
190 * The NXM format is convenient for reporting metadata values, but it is
191 * important not to interpret the format as matching against a flow, because it
192 * does not. Nothing is being matched; arbitrary metadata masks would not be
195 * Whereas in most cases a controller can expect to only get back NXM fields
196 * that it set up itself (e.g. flow dumps will ordinarily report only NXM
197 * fields from flows that the controller added), NXT_PACKET_IN messages might
198 * contain fields that the controller does not understand, because the switch
199 * might support fields (new registers, new protocols, etc.) that the
200 * controller does not. The controller must prepared to tolerate these.
202 * The 'cookie' field has no meaning when 'reason' is OFPR_NO_MATCH. In this
203 * case it should be UINT64_MAX. */
204 struct nx_packet_in {
205 ovs_be32 buffer_id; /* ID assigned by datapath. */
206 ovs_be16 total_len; /* Full length of frame. */
207 uint8_t reason; /* Reason packet is sent (one of OFPR_*). */
208 uint8_t table_id; /* ID of the table that was looked up. */
209 ovs_be64 cookie; /* Cookie of the rule that was looked up. */
210 ovs_be16 match_len; /* Size of nx_match. */
211 uint8_t pad[6]; /* Align to 64-bits. */
213 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
214 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
215 * all-zero bytes, then
216 * - Exactly 2 all-zero padding bytes, then
217 * - An Ethernet frame whose length is inferred from nxh.header.length.
219 * The padding bytes preceding the Ethernet frame ensure that the IP
220 * header (if any) following the Ethernet header is 32-bit aligned. */
222 /* uint8_t nxm_fields[...]; */ /* NXM headers. */
223 /* uint8_t pad[2]; */ /* Align to 64 bit + 16 bit. */
224 /* uint8_t data[0]; */ /* Ethernet frame. */
226 OFP_ASSERT(sizeof(struct nx_packet_in) == 24);
228 /* Configures the "role" of the sending controller. The default role is:
230 * - Other (NX_ROLE_OTHER), which allows the controller access to all
233 * The other possible roles are a related pair:
235 * - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
236 * be at most one Master controller at a time: when a controller
237 * configures itself as Master, any existing Master is demoted to the
240 * - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
241 * OpenFlow features. In particular attempts to modify the flow table
242 * will be rejected with an OFPBRC_EPERM error.
244 * Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
245 * messages, but they do receive OFPT_PORT_STATUS messages.
247 struct nx_role_request {
248 ovs_be32 role; /* One of NX_ROLE_*. */
250 OFP_ASSERT(sizeof(struct nx_role_request) == 4);
253 NX_ROLE_OTHER, /* Default role, full access. */
254 NX_ROLE_MASTER, /* Full access, at most one. */
255 NX_ROLE_SLAVE /* Read-only access. */
258 /* NXT_SET_ASYNC_CONFIG.
260 * Sent by a controller, this message configures the asynchronous messages that
261 * the controller wants to receive. Element 0 in each array specifies messages
262 * of interest when the controller has an "other" or "master" role; element 1,
263 * when the controller has a "slave" role.
265 * Each array element is a bitmask in which a 0-bit disables receiving a
266 * particular message and a 1-bit enables receiving it. Each bit controls the
267 * message whose 'reason' corresponds to the bit index. For example, the bit
268 * with value 1<<2 == 4 in port_status_mask[1] determines whether the
269 * controller will receive OFPT_PORT_STATUS messages with reason OFPPR_MODIFY
270 * (value 2) when the controller has a "slave" role.
272 * As a side effect, for service controllers, this message changes the
273 * miss_send_len from default of zero to OFP_DEFAULT_MISS_SEND_LEN (128).
275 struct nx_async_config {
276 ovs_be32 packet_in_mask[2]; /* Bitmasks of OFPR_* values. */
277 ovs_be32 port_status_mask[2]; /* Bitmasks of OFPRR_* values. */
278 ovs_be32 flow_removed_mask[2]; /* Bitmasks of OFPPR_* values. */
280 OFP_ASSERT(sizeof(struct nx_async_config) == 24);
282 /* Nicira vendor flow actions. */
284 enum nx_action_subtype {
285 NXAST_SNAT__OBSOLETE, /* No longer used. */
286 NXAST_RESUBMIT, /* struct nx_action_resubmit */
287 NXAST_SET_TUNNEL, /* struct nx_action_set_tunnel */
288 NXAST_DROP_SPOOFED_ARP__OBSOLETE,
289 NXAST_SET_QUEUE, /* struct nx_action_set_queue */
290 NXAST_POP_QUEUE, /* struct nx_action_pop_queue */
291 NXAST_REG_MOVE, /* struct nx_action_reg_move */
292 NXAST_REG_LOAD, /* struct nx_action_reg_load */
293 NXAST_NOTE, /* struct nx_action_note */
294 NXAST_SET_TUNNEL64, /* struct nx_action_set_tunnel64 */
295 NXAST_MULTIPATH, /* struct nx_action_multipath */
296 NXAST_AUTOPATH__OBSOLETE, /* No longer used. */
297 NXAST_BUNDLE, /* struct nx_action_bundle */
298 NXAST_BUNDLE_LOAD, /* struct nx_action_bundle */
299 NXAST_RESUBMIT_TABLE, /* struct nx_action_resubmit */
300 NXAST_OUTPUT_REG, /* struct nx_action_output_reg */
301 NXAST_LEARN, /* struct nx_action_learn */
302 NXAST_EXIT, /* struct nx_action_header */
303 NXAST_DEC_TTL, /* struct nx_action_header */
304 NXAST_FIN_TIMEOUT, /* struct nx_action_fin_timeout */
305 NXAST_CONTROLLER, /* struct nx_action_controller */
306 NXAST_DEC_TTL_CNT_IDS, /* struct nx_action_cnt_ids */
307 NXAST_WRITE_METADATA, /* struct nx_action_write_metadata */
308 NXAST_PUSH_MPLS, /* struct nx_action_push_mpls */
309 NXAST_POP_MPLS, /* struct nx_action_pop_mpls */
310 NXAST_SET_MPLS_TTL, /* struct nx_action_ttl */
311 NXAST_DEC_MPLS_TTL, /* struct nx_action_header */
312 NXAST_STACK_PUSH, /* struct nx_action_stack */
313 NXAST_STACK_POP, /* struct nx_action_stack */
314 NXAST_SAMPLE, /* struct nx_action_sample */
315 NXAST_SET_MPLS_LABEL, /* struct nx_action_ttl */
316 NXAST_SET_MPLS_TC, /* struct nx_action_ttl */
319 /* Header for Nicira-defined actions. */
320 struct nx_action_header {
321 ovs_be16 type; /* OFPAT_VENDOR. */
322 ovs_be16 len; /* Length is 16. */
323 ovs_be32 vendor; /* NX_VENDOR_ID. */
324 ovs_be16 subtype; /* NXAST_*. */
327 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
329 /* Action structures for NXAST_RESUBMIT and NXAST_RESUBMIT_TABLE.
331 * These actions search one of the switch's flow tables:
333 * - For NXAST_RESUBMIT_TABLE only, if the 'table' member is not 255, then
334 * it specifies the table to search.
336 * - Otherwise (for NXAST_RESUBMIT_TABLE with a 'table' of 255, or for
337 * NXAST_RESUBMIT regardless of 'table'), it searches the current flow
338 * table, that is, the OpenFlow flow table that contains the flow from
339 * which this action was obtained. If this action did not come from a
340 * flow table (e.g. it came from an OFPT_PACKET_OUT message), then table 0
341 * is the current table.
343 * The flow table lookup uses a flow that may be slightly modified from the
346 * - For NXAST_RESUBMIT, the 'in_port' member of struct nx_action_resubmit
347 * is used as the flow's in_port.
349 * - For NXAST_RESUBMIT_TABLE, if the 'in_port' member is not OFPP_IN_PORT,
350 * then its value is used as the flow's in_port. Otherwise, the original
353 * - If actions that modify the flow (e.g. OFPAT_SET_VLAN_VID) precede the
354 * resubmit action, then the flow is updated with the new values.
356 * Following the lookup, the original in_port is restored.
358 * If the modified flow matched in the flow table, then the corresponding
359 * actions are executed. Afterward, actions following the resubmit in the
360 * original set of actions, if any, are executed; any changes made to the
361 * packet (e.g. changes to VLAN) by secondary actions persist when those
362 * actions are executed, although the original in_port is restored.
364 * Resubmit actions may be used any number of times within a set of actions.
366 * Resubmit actions may nest to an implementation-defined depth. Beyond this
367 * implementation-defined depth, further resubmit actions are simply ignored.
369 * NXAST_RESUBMIT ignores 'table' and 'pad'. NXAST_RESUBMIT_TABLE requires
370 * 'pad' to be all-bits-zero.
372 * Open vSwitch 1.0.1 and earlier did not support recursion. Open vSwitch
373 * before 1.2.90 did not support NXAST_RESUBMIT_TABLE.
375 struct nx_action_resubmit {
376 ovs_be16 type; /* OFPAT_VENDOR. */
377 ovs_be16 len; /* Length is 16. */
378 ovs_be32 vendor; /* NX_VENDOR_ID. */
379 ovs_be16 subtype; /* NXAST_RESUBMIT. */
380 ovs_be16 in_port; /* New in_port for checking flow table. */
381 uint8_t table; /* NXAST_RESUBMIT_TABLE: table to use. */
384 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
386 /* Action structure for NXAST_SET_TUNNEL.
388 * Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32
389 * bits of the tunnel ID are set to 0. */
390 struct nx_action_set_tunnel {
391 ovs_be16 type; /* OFPAT_VENDOR. */
392 ovs_be16 len; /* Length is 16. */
393 ovs_be32 vendor; /* NX_VENDOR_ID. */
394 ovs_be16 subtype; /* NXAST_SET_TUNNEL. */
396 ovs_be32 tun_id; /* Tunnel ID. */
398 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
400 /* Action structure for NXAST_SET_TUNNEL64.
402 * Sets the encapsulating tunnel ID to a 64-bit value. */
403 struct nx_action_set_tunnel64 {
404 ovs_be16 type; /* OFPAT_VENDOR. */
405 ovs_be16 len; /* Length is 24. */
406 ovs_be32 vendor; /* NX_VENDOR_ID. */
407 ovs_be16 subtype; /* NXAST_SET_TUNNEL64. */
409 ovs_be64 tun_id; /* Tunnel ID. */
411 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
413 /* Action structure for NXAST_SET_QUEUE.
415 * Set the queue that should be used when packets are output. This is similar
416 * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
417 * an argument. This allows the queue to be defined before the port is
419 struct nx_action_set_queue {
420 ovs_be16 type; /* OFPAT_VENDOR. */
421 ovs_be16 len; /* Length is 16. */
422 ovs_be32 vendor; /* NX_VENDOR_ID. */
423 ovs_be16 subtype; /* NXAST_SET_QUEUE. */
425 ovs_be32 queue_id; /* Where to enqueue packets. */
427 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
429 /* Action structure for NXAST_POP_QUEUE.
431 * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
432 * were used. Only the original queue can be restored this way; no stack is
434 struct nx_action_pop_queue {
435 ovs_be16 type; /* OFPAT_VENDOR. */
436 ovs_be16 len; /* Length is 16. */
437 ovs_be32 vendor; /* NX_VENDOR_ID. */
438 ovs_be16 subtype; /* NXAST_POP_QUEUE. */
441 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
443 /* Action structure for NXAST_REG_MOVE.
445 * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
446 * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
447 * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
448 * the next most significant bit, and so on.
450 * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
451 * sense to use nxm_hasmask=1 because the action does not do any kind of
452 * matching; it uses the actual value of a field.)
454 * The following nxm_header values are potentially acceptable as 'src':
477 * - NXM_NX_ICMPV6_TYPE
478 * - NXM_NX_ICMPV6_CODE
481 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
483 * - NXM_NX_TUN_IPV4_SRC
484 * - NXM_NX_TUN_IPV4_DST
486 * The following nxm_header values are potentially acceptable as 'dst':
497 * Modifying any of the above fields changes the corresponding packet
502 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
506 * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
507 * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
508 * header (if any), ignoring the other bits. Setting a value with CFI=1
509 * adds or modifies the 802.1Q header appropriately, setting the TCI field
510 * to the field's new value (with the CFI bit masked out).
512 * - NXM_NX_TUN_ID, NXM_NX_TUN_IPV4_SRC, NXM_NX_TUN_IPV4_DST. Modifying
513 * any of these values modifies the corresponding tunnel header field used
514 * for the packet's next tunnel encapsulation, if allowed by the
515 * configuration of the output tunnel port.
517 * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
518 * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
519 * used only if the flow's nx_match includes an nxm_entry that specifies
520 * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
522 * The switch will reject actions for which src_ofs+n_bits is greater than the
523 * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
524 * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
526 * This action behaves properly when 'src' overlaps with 'dst', that is, it
527 * behaves as if 'src' were copied out to a temporary buffer, then the
528 * temporary buffer copied to 'dst'.
530 struct nx_action_reg_move {
531 ovs_be16 type; /* OFPAT_VENDOR. */
532 ovs_be16 len; /* Length is 24. */
533 ovs_be32 vendor; /* NX_VENDOR_ID. */
534 ovs_be16 subtype; /* NXAST_REG_MOVE. */
535 ovs_be16 n_bits; /* Number of bits. */
536 ovs_be16 src_ofs; /* Starting bit offset in source. */
537 ovs_be16 dst_ofs; /* Starting bit offset in destination. */
538 ovs_be32 src; /* Source register. */
539 ovs_be32 dst; /* Destination register. */
541 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
543 /* Action structure for NXAST_REG_LOAD.
545 * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
546 * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
547 * starts at 0 for the least-significant bit, 1 for the next most significant
550 * 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for
551 * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
554 * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
555 * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
556 * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
557 * also stored as one less than its true value:
560 * +------------------------------+------------------+
561 * | ofs | n_bits - 1 |
562 * +------------------------------+------------------+
564 * The switch will reject actions for which ofs+n_bits is greater than the
565 * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
566 * greater are set to 1, with error type OFPET_BAD_ACTION, code
567 * OFPBAC_BAD_ARGUMENT.
569 struct nx_action_reg_load {
570 ovs_be16 type; /* OFPAT_VENDOR. */
571 ovs_be16 len; /* Length is 24. */
572 ovs_be32 vendor; /* NX_VENDOR_ID. */
573 ovs_be16 subtype; /* NXAST_REG_LOAD. */
574 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
575 ovs_be32 dst; /* Destination register. */
576 ovs_be64 value; /* Immediate value. */
578 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
580 /* Action structure for NXAST_STACK_PUSH and NXAST_STACK_POP.
582 * Pushes (or pops) field[offset: offset + n_bits] to (or from)
585 struct nx_action_stack {
586 ovs_be16 type; /* OFPAT_VENDOR. */
587 ovs_be16 len; /* Length is 16. */
588 ovs_be32 vendor; /* NX_VENDOR_ID. */
589 ovs_be16 subtype; /* NXAST_STACK_PUSH or NXAST_STACK_POP. */
590 ovs_be16 offset; /* Bit offset into the field. */
591 ovs_be32 field; /* The field used for push or pop. */
592 ovs_be16 n_bits; /* (n_bits + 1) bits of the field. */
593 uint8_t zero[6]; /* Reserved, must be zero. */
595 OFP_ASSERT(sizeof(struct nx_action_stack) == 24);
597 /* Action structure for NXAST_NOTE.
599 * This action has no effect. It is variable length. The switch does not
600 * attempt to interpret the user-defined 'note' data in any way. A controller
601 * can use this action to attach arbitrary metadata to a flow.
603 * This action might go away in the future.
605 struct nx_action_note {
606 ovs_be16 type; /* OFPAT_VENDOR. */
607 ovs_be16 len; /* A multiple of 8, but at least 16. */
608 ovs_be32 vendor; /* NX_VENDOR_ID. */
609 ovs_be16 subtype; /* NXAST_NOTE. */
610 uint8_t note[6]; /* Start of user-defined data. */
611 /* Possibly followed by additional user-defined data. */
613 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
615 /* Action structure for NXAST_MULTIPATH.
617 * This action performs the following steps in sequence:
619 * 1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
620 * Refer to the definition of "enum nx_mp_fields" for details.
622 * The 'basis' value is used as a universal hash parameter, that is,
623 * different values of 'basis' yield different hash functions. The
624 * particular universal hash function used is implementation-defined.
626 * The hashed fields' values are drawn from the current state of the
627 * flow, including all modifications that have been made by actions up to
630 * 2. Applies the multipath link choice algorithm specified by 'algorithm',
631 * one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm"
634 * The output of the algorithm is 'link', an unsigned integer less than
635 * or equal to 'max_link'.
637 * Some algorithms use 'arg' as an additional argument.
639 * 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of
640 * 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
643 * The switch will reject actions that have an unknown 'fields', or an unknown
644 * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
645 * in which 'max_link' is greater than or equal to 2**n_bits, with error type
646 * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
648 struct nx_action_multipath {
649 ovs_be16 type; /* OFPAT_VENDOR. */
650 ovs_be16 len; /* Length is 32. */
651 ovs_be32 vendor; /* NX_VENDOR_ID. */
652 ovs_be16 subtype; /* NXAST_MULTIPATH. */
654 /* What fields to hash and how. */
655 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
656 ovs_be16 basis; /* Universal hash parameter. */
659 /* Multipath link choice algorithm to apply to hash value. */
660 ovs_be16 algorithm; /* One of NX_MP_ALG_*. */
661 ovs_be16 max_link; /* Number of output links, minus 1. */
662 ovs_be32 arg; /* Algorithm-specific argument. */
665 /* Where to store the result. */
666 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
667 ovs_be32 dst; /* Destination. */
669 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
671 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
673 * In the descriptions below, 'n_links' is max_link + 1. */
674 enum nx_mp_algorithm {
675 /* link = hash(flow) % n_links.
677 * Redistributes all traffic when n_links changes. O(1) performance. See
680 * Use UINT16_MAX for max_link to get a raw hash value. */
683 /* link = hash(flow) / (MAX_HASH / n_links).
685 * Redistributes between one-quarter and one-half of traffic when n_links
686 * changes. O(1) performance. See RFC 2992.
688 NX_MP_ALG_HASH_THRESHOLD,
690 /* for i in [0,n_links):
691 * weights[i] = hash(flow, i)
692 * link = { i such that weights[i] >= weights[j] for all j != i }
694 * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
695 * performance. If n_links is greater than a threshold (currently 64, but
696 * subject to change), Open vSwitch will substitute another algorithm
697 * automatically. See RFC 2992. */
698 NX_MP_ALG_HRW, /* Highest Random Weight. */
703 * link = hash(flow, i) % arg
704 * while link > max_link
706 * Redistributes 1/n_links of traffic when n_links changes. O(1)
707 * performance when arg/max_link is bounded by a constant.
709 * Redistributes all traffic when arg changes.
711 * arg must be greater than max_link and for best performance should be no
712 * more than approximately max_link * 2. If arg is outside the acceptable
713 * range, Open vSwitch will automatically substitute the least power of 2
714 * greater than max_link.
716 * This algorithm is specific to Open vSwitch.
718 NX_MP_ALG_ITER_HASH /* Iterative Hash. */
721 /* Action structure for NXAST_LEARN.
723 * This action adds or modifies a flow in an OpenFlow table, similar to
724 * OFPT_FLOW_MOD with OFPFC_MODIFY_STRICT as 'command'. The new flow has the
725 * specified idle timeout, hard timeout, priority, cookie, and flags. The new
726 * flow's match criteria and actions are built by applying each of the series
727 * of flow_mod_spec elements included as part of the action.
729 * A flow_mod_spec starts with a 16-bit header. A header that is all-bits-0 is
730 * a no-op used for padding the action as a whole to a multiple of 8 bytes in
731 * length. Otherwise, the flow_mod_spec can be thought of as copying 'n_bits'
732 * bits from a source to a destination. In this case, the header contains
735 * 15 14 13 12 11 10 0
736 * +------+---+------+---------------------------------+
737 * | 0 |src| dst | n_bits |
738 * +------+---+------+---------------------------------+
740 * The meaning and format of a flow_mod_spec depends on 'src' and 'dst'. The
741 * following table summarizes the meaning of each possible combination.
742 * Details follow the table:
745 * --- --- ----------------------------------------------------------
746 * 0 0 Add match criteria based on value in a field.
747 * 1 0 Add match criteria based on an immediate value.
748 * 0 1 Add NXAST_REG_LOAD action to copy field into a different field.
749 * 1 1 Add NXAST_REG_LOAD action to load immediate value into a field.
750 * 0 2 Add OFPAT_OUTPUT action to output to port from specified field.
751 * All other combinations are undefined and not allowed.
753 * The flow_mod_spec header is followed by a source specification and a
754 * destination specification. The format and meaning of the source
755 * specification depends on 'src':
757 * - If 'src' is 0, the source bits are taken from a field in the flow to
758 * which this action is attached. (This should be a wildcarded field. If
759 * its value is fully specified then the source bits being copied have
762 * The source specification is an ovs_be32 'field' and an ovs_be16 'ofs'.
763 * 'field' is an nxm_header with nxm_hasmask=0, and 'ofs' the starting bit
764 * offset within that field. The source bits are field[ofs:ofs+n_bits-1].
765 * 'field' and 'ofs' are subject to the same restrictions as the source
766 * field in NXAST_REG_MOVE.
768 * - If 'src' is 1, the source bits are a constant value. The source
769 * specification is (n_bits+15)/16*2 bytes long. Taking those bytes as a
770 * number in network order, the source bits are the 'n_bits'
771 * least-significant bits. The switch will report an error if other bits
772 * in the constant are nonzero.
774 * The flow_mod_spec destination specification, for 'dst' of 0 or 1, is an
775 * ovs_be32 'field' and an ovs_be16 'ofs'. 'field' is an nxm_header with
776 * nxm_hasmask=0 and 'ofs' is a starting bit offset within that field. The
777 * meaning of the flow_mod_spec depends on 'dst':
779 * - If 'dst' is 0, the flow_mod_spec specifies match criteria for the new
780 * flow. The new flow matches only if bits field[ofs:ofs+n_bits-1] in a
781 * packet equal the source bits. 'field' may be any nxm_header with
782 * nxm_hasmask=0 that is allowed in NXT_FLOW_MOD.
784 * Order is significant. Earlier flow_mod_specs must satisfy any
785 * prerequisites for matching fields specified later, by copying constant
786 * values into prerequisite fields.
788 * The switch will reject flow_mod_specs that do not satisfy NXM masking
791 * - If 'dst' is 1, the flow_mod_spec specifies an NXAST_REG_LOAD action for
792 * the new flow. The new flow copies the source bits into
793 * field[ofs:ofs+n_bits-1]. Actions are executed in the same order as the
796 * A single NXAST_REG_LOAD action writes no more than 64 bits, so n_bits
797 * greater than 64 yields multiple NXAST_REG_LOAD actions.
799 * The flow_mod_spec destination spec for 'dst' of 2 (when 'src' is 0) is
800 * empty. It has the following meaning:
802 * - The flow_mod_spec specifies an OFPAT_OUTPUT action for the new flow.
803 * The new flow outputs to the OpenFlow port specified by the source field.
804 * Of the special output ports with value OFPP_MAX or larger, OFPP_IN_PORT,
805 * OFPP_FLOOD, OFPP_LOCAL, and OFPP_ALL are supported. Other special ports
808 * Resource Management
809 * -------------------
811 * A switch has a finite amount of flow table space available for learning.
812 * When this space is exhausted, no new learning table entries will be learned
813 * until some existing flow table entries expire. The controller should be
814 * prepared to handle this by flooding (which can be implemented as a
815 * low-priority flow).
817 * If a learned flow matches a single TCP stream with a relatively long
818 * timeout, one may make the best of resource constraints by setting
819 * 'fin_idle_timeout' or 'fin_hard_timeout' (both measured in seconds), or
820 * both, to shorter timeouts. When either of these is specified as a nonzero
821 * value, OVS adds a NXAST_FIN_TIMEOUT action, with the specified timeouts, to
827 * The following examples give a prose description of the flow_mod_specs along
828 * with informal notation for how those would be represented and a hex dump of
829 * the bytes that would be required.
831 * These examples could work with various nx_action_learn parameters. Typical
832 * values would be idle_timeout=OFP_FLOW_PERMANENT, hard_timeout=60,
833 * priority=OFP_DEFAULT_PRIORITY, flags=0, table_id=10.
835 * 1. Learn input port based on the source MAC, with lookup into
836 * NXM_NX_REG1[16:31] by resubmit to in_port=99:
838 * Match on in_port=99:
839 * ovs_be16(src=1, dst=0, n_bits=16), 20 10
840 * ovs_be16(99), 00 63
841 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
843 * Match Ethernet destination on Ethernet source from packet:
844 * ovs_be16(src=0, dst=0, n_bits=48), 00 30
845 * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
846 * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
848 * Set NXM_NX_REG1[16:31] to the packet's input port:
849 * ovs_be16(src=0, dst=1, n_bits=16), 08 10
850 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
851 * ovs_be32(NXM_NX_REG1), ovs_be16(16) 00 01 02 04 00 10
853 * Given a packet that arrived on port A with Ethernet source address B,
854 * this would set up the flow "in_port=99, dl_dst=B,
855 * actions=load:A->NXM_NX_REG1[16..31]".
857 * In syntax accepted by ovs-ofctl, this action is: learn(in_port=99,
858 * NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
859 * load:NXM_OF_IN_PORT[]->NXM_NX_REG1[16..31])
861 * 2. Output to input port based on the source MAC and VLAN VID, with lookup
862 * into NXM_NX_REG1[16:31]:
864 * Match on same VLAN ID as packet:
865 * ovs_be16(src=0, dst=0, n_bits=12), 00 0c
866 * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
867 * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
869 * Match Ethernet destination on Ethernet source from packet:
870 * ovs_be16(src=0, dst=0, n_bits=48), 00 30
871 * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
872 * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
874 * Output to the packet's input port:
875 * ovs_be16(src=0, dst=2, n_bits=16), 10 10
876 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
878 * Given a packet that arrived on port A with Ethernet source address B in
879 * VLAN C, this would set up the flow "dl_dst=B, vlan_vid=C,
882 * In syntax accepted by ovs-ofctl, this action is:
883 * learn(NXM_OF_VLAN_TCI[0..11], NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
884 * output:NXM_OF_IN_PORT[])
886 * 3. Here's a recipe for a very simple-minded MAC learning switch. It uses a
887 * 10-second MAC expiration time to make it easier to see what's going on
889 * ovs-vsctl del-controller br0
890 * ovs-ofctl del-flows br0
891 * ovs-ofctl add-flow br0 "table=0 actions=learn(table=1, \
892 hard_timeout=10, NXM_OF_VLAN_TCI[0..11], \
893 NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[], \
894 output:NXM_OF_IN_PORT[]), resubmit(,1)"
895 * ovs-ofctl add-flow br0 "table=1 priority=0 actions=flood"
897 * You can then dump the MAC learning table with:
899 * ovs-ofctl dump-flows br0 table=1
904 * For best performance, segregate learned flows into a table that is not used
905 * for any other flows except possibly for a lowest-priority "catch-all" flow
906 * (a flow with no match criteria). If different learning actions specify
907 * different match criteria, use different tables for the learned flows.
909 * The meaning of 'hard_timeout' and 'idle_timeout' can be counterintuitive.
910 * These timeouts apply to the flow that is added, which means that a flow with
911 * an idle timeout will expire when no traffic has been sent *to* the learned
912 * address. This is not usually the intent in MAC learning; instead, we want
913 * the MAC learn entry to expire when no traffic has been sent *from* the
914 * learned address. Use a hard timeout for that.
916 struct nx_action_learn {
917 ovs_be16 type; /* OFPAT_VENDOR. */
918 ovs_be16 len; /* At least 24. */
919 ovs_be32 vendor; /* NX_VENDOR_ID. */
920 ovs_be16 subtype; /* NXAST_LEARN. */
921 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
922 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
923 ovs_be16 priority; /* Priority level of flow entry. */
924 ovs_be64 cookie; /* Cookie for new flow. */
925 ovs_be16 flags; /* Either 0 or OFPFF_SEND_FLOW_REM. */
926 uint8_t table_id; /* Table to insert flow entry. */
927 uint8_t pad; /* Must be zero. */
928 ovs_be16 fin_idle_timeout; /* Idle timeout after FIN, if nonzero. */
929 ovs_be16 fin_hard_timeout; /* Hard timeout after FIN, if nonzero. */
930 /* Followed by a sequence of flow_mod_spec elements, as described above,
931 * until the end of the action is reached. */
933 OFP_ASSERT(sizeof(struct nx_action_learn) == 32);
935 #define NX_LEARN_N_BITS_MASK 0x3ff
937 #define NX_LEARN_SRC_FIELD (0 << 13) /* Copy from field. */
938 #define NX_LEARN_SRC_IMMEDIATE (1 << 13) /* Copy from immediate value. */
939 #define NX_LEARN_SRC_MASK (1 << 13)
941 #define NX_LEARN_DST_MATCH (0 << 11) /* Add match criterion. */
942 #define NX_LEARN_DST_LOAD (1 << 11) /* Add NXAST_REG_LOAD action. */
943 #define NX_LEARN_DST_OUTPUT (2 << 11) /* Add OFPAT_OUTPUT action. */
944 #define NX_LEARN_DST_RESERVED (3 << 11) /* Not yet defined. */
945 #define NX_LEARN_DST_MASK (3 << 11)
947 /* Action structure for NXAST_FIN_TIMEOUT.
949 * This action changes the idle timeout or hard timeout, or both, of this
950 * OpenFlow rule when the rule matches a TCP packet with the FIN or RST flag.
951 * When such a packet is observed, the action reduces the rule's idle timeout
952 * to 'fin_idle_timeout' and its hard timeout to 'fin_hard_timeout'. This
953 * action has no effect on an existing timeout that is already shorter than the
954 * one that the action specifies. A 'fin_idle_timeout' or 'fin_hard_timeout'
955 * of zero has no effect on the respective timeout.
957 * 'fin_idle_timeout' and 'fin_hard_timeout' are measured in seconds.
958 * 'fin_hard_timeout' specifies time since the flow's creation, not since the
959 * receipt of the FIN or RST.
961 * This is useful for quickly discarding learned TCP flows that otherwise will
962 * take a long time to expire.
964 * This action is intended for use with an OpenFlow rule that matches only a
965 * single TCP flow. If the rule matches multiple TCP flows (e.g. it wildcards
966 * all TCP traffic, or all TCP traffic to a particular port), then any FIN or
967 * RST in any of those flows will cause the entire OpenFlow rule to expire
968 * early, which is not normally desirable.
970 struct nx_action_fin_timeout {
971 ovs_be16 type; /* OFPAT_VENDOR. */
972 ovs_be16 len; /* 16. */
973 ovs_be32 vendor; /* NX_VENDOR_ID. */
974 ovs_be16 subtype; /* NXAST_FIN_TIMEOUT. */
975 ovs_be16 fin_idle_timeout; /* New idle timeout, if nonzero. */
976 ovs_be16 fin_hard_timeout; /* New hard timeout, if nonzero. */
977 ovs_be16 pad; /* Must be zero. */
979 OFP_ASSERT(sizeof(struct nx_action_fin_timeout) == 16);
981 /* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD.
983 * The bundle actions choose a slave from a supplied list of options.
984 * NXAST_BUNDLE outputs to its selection. NXAST_BUNDLE_LOAD writes its
985 * selection to a register.
987 * The list of possible slaves follows the nx_action_bundle structure. The size
988 * of each slave is governed by its type as indicated by the 'slave_type'
989 * parameter. The list of slaves should be padded at its end with zeros to make
990 * the total length of the action a multiple of 8.
992 * Switches infer from the 'slave_type' parameter the size of each slave. All
993 * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
994 * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
995 * 2 byte width. Switches should reject actions which indicate unknown or
996 * unsupported slave types.
998 * Switches use a strategy dictated by the 'algorithm' parameter to choose a
999 * slave. If the switch does not support the specified 'algorithm' parameter,
1000 * it should reject the action.
1002 * Several algorithms take into account liveness when selecting slaves. The
1003 * liveness of a slave is implementation defined (with one exception), but will
1004 * generally take into account things like its carrier status and the results
1005 * of any link monitoring protocols which happen to be running on it. In order
1006 * to give controllers a place-holder value, the OFPP_NONE port is always
1009 * Some slave selection strategies require the use of a hash function, in which
1010 * case the 'fields' and 'basis' parameters should be populated. The 'fields'
1011 * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
1012 * hash. Refer to the definition of "enum nx_hash_fields" for details. The
1013 * 'basis' parameter is used as a universal hash parameter. Different values
1014 * of 'basis' yield different hash results.
1016 * The 'zero' parameter at the end of the action structure is reserved for
1017 * future use. Switches are required to reject actions which have nonzero
1018 * bytes in the 'zero' field.
1020 * NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed. Switches
1021 * should reject actions which have nonzero bytes in either of these fields.
1023 * NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in
1024 * dst[ofs:ofs+n_bits]. The format and semantics of 'dst' and 'ofs_nbits' are
1025 * similar to those for the NXAST_REG_LOAD action. */
1026 struct nx_action_bundle {
1027 ovs_be16 type; /* OFPAT_VENDOR. */
1028 ovs_be16 len; /* Length including slaves. */
1029 ovs_be32 vendor; /* NX_VENDOR_ID. */
1030 ovs_be16 subtype; /* NXAST_BUNDLE or NXAST_BUNDLE_LOAD. */
1032 /* Slave choice algorithm to apply to hash value. */
1033 ovs_be16 algorithm; /* One of NX_BD_ALG_*. */
1035 /* What fields to hash and how. */
1036 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
1037 ovs_be16 basis; /* Universal hash parameter. */
1039 ovs_be32 slave_type; /* NXM_OF_IN_PORT. */
1040 ovs_be16 n_slaves; /* Number of slaves. */
1042 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
1043 ovs_be32 dst; /* Destination. */
1045 uint8_t zero[4]; /* Reserved. Must be zero. */
1047 OFP_ASSERT(sizeof(struct nx_action_bundle) == 32);
1049 /* NXAST_BUNDLE: Bundle slave choice algorithm to apply.
1051 * In the descriptions below, 'slaves' is the list of possible slaves in the
1052 * order they appear in the OpenFlow action. */
1053 enum nx_bd_algorithm {
1054 /* Chooses the first live slave listed in the bundle.
1056 * O(n_slaves) performance. */
1057 NX_BD_ALG_ACTIVE_BACKUP,
1059 /* for i in [0,n_slaves):
1060 * weights[i] = hash(flow, i)
1061 * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
1063 * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
1064 * O(n_slaves) performance.
1066 * Uses the 'fields' and 'basis' parameters. */
1067 NX_BD_ALG_HRW /* Highest Random Weight. */
1071 /* Action structure for NXAST_DEC_TTL_CNT_IDS.
1073 * If the packet is not IPv4 or IPv6, does nothing. For IPv4 or IPv6, if the
1074 * TTL or hop limit is at least 2, decrements it by 1. Otherwise, if TTL or
1075 * hop limit is 0 or 1, sends a packet-in to the controllers with each of the
1076 * 'n_controllers' controller IDs specified in 'cnt_ids'.
1078 * (This differs from NXAST_DEC_TTL in that for NXAST_DEC_TTL the packet-in is
1079 * sent only to controllers with id 0.)
1081 struct nx_action_cnt_ids {
1082 ovs_be16 type; /* OFPAT_VENDOR. */
1083 ovs_be16 len; /* Length including slaves. */
1084 ovs_be32 vendor; /* NX_VENDOR_ID. */
1085 ovs_be16 subtype; /* NXAST_DEC_TTL_CNT_IDS. */
1087 ovs_be16 n_controllers; /* Number of controllers. */
1088 uint8_t zeros[4]; /* Must be zero. */
1090 /* Followed by 1 or more controller ids.
1092 * uint16_t cnt_ids[]; // Controller ids.
1093 * uint8_t pad[]; // Must be 0 to 8-byte align cnt_ids[].
1096 OFP_ASSERT(sizeof(struct nx_action_cnt_ids) == 16);
1099 /* Action structure for NXAST_OUTPUT_REG.
1101 * Outputs to the OpenFlow port number written to src[ofs:ofs+nbits].
1103 * The format and semantics of 'src' and 'ofs_nbits' are similar to those for
1104 * the NXAST_REG_LOAD action.
1106 * The acceptable nxm_header values for 'src' are the same as the acceptable
1107 * nxm_header values for the 'src' field of NXAST_REG_MOVE.
1109 * The 'max_len' field indicates the number of bytes to send when the chosen
1110 * port is OFPP_CONTROLLER. Its semantics are equivalent to the 'max_len'
1111 * field of OFPAT_OUTPUT.
1113 * The 'zero' field is required to be zeroed for forward compatibility. */
1114 struct nx_action_output_reg {
1115 ovs_be16 type; /* OFPAT_VENDOR. */
1116 ovs_be16 len; /* 24. */
1117 ovs_be32 vendor; /* NX_VENDOR_ID. */
1118 ovs_be16 subtype; /* NXAST_OUTPUT_REG. */
1120 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
1121 ovs_be32 src; /* Source. */
1123 ovs_be16 max_len; /* Max length to send to controller. */
1125 uint8_t zero[6]; /* Reserved, must be zero. */
1127 OFP_ASSERT(sizeof(struct nx_action_output_reg) == 24);
1131 * Discontinues action processing.
1133 * The NXAST_EXIT action causes the switch to immediately halt processing
1134 * actions for the flow. Any actions which have already been processed are
1135 * executed by the switch. However, any further actions, including those which
1136 * may be in different tables, or different levels of the NXAST_RESUBMIT
1137 * hierarchy, will be ignored.
1139 * Uses the nx_action_header structure. */
1141 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
1143 * OpenFlow 1.0 has "struct ofp10_match" for specifying flow matches. This
1144 * structure is fixed-length and hence difficult to extend. This section
1145 * describes a more flexible, variable-length flow match, called "nx_match" for
1146 * short, that is also supported by Open vSwitch. This section also defines a
1147 * replacement for each OpenFlow message that includes struct ofp10_match.
1153 * An nx_match is a sequence of zero or more "nxm_entry"s, which are
1154 * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
1155 * "nxm_entry"s are not aligned on or padded to any multibyte boundary. The
1156 * first 4 bytes of an nxm_entry are its "header", followed by the entry's
1159 * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
1161 * |<-------------------- nxm_type ------------------>|
1163 * |31 16 15 9| 8 7 0
1164 * +----------------------------------+---------------+--+------------------+
1165 * | nxm_vendor | nxm_field |hm| nxm_length |
1166 * +----------------------------------+---------------+--+------------------+
1168 * The most-significant 23 bits of the header are collectively "nxm_type".
1169 * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
1170 * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
1171 * designates a protocol header, such as the Ethernet type, but it can also
1172 * refer to packet metadata, such as the switch port on which a packet arrived.
1174 * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
1175 * of this bit is explained later.
1177 * The least-significant 8 bits are "nxm_length", a positive integer. The
1178 * length of the nxm_entry, including the header, is exactly 4 + nxm_length
1181 * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
1182 * constant. It is included only to allow software to minimally parse
1183 * "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor,
1184 * nxm_field, and nxm_length, nxm_hasmask is a constant.)
1190 * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
1192 * An nxm_entry places a constraint on the packets matched by the nx_match:
1194 * - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
1195 * field, called "nxm_value". The nx_match matches only packets in which
1196 * the field equals nxm_value.
1198 * - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
1199 * field (nxm_value), followed by a bitmask of the same length as the
1200 * value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
1201 * nx_match matches only packets for which bit J in the given field's value
1202 * matches bit J in nxm_value. A 0-bit in nxm_mask causes the
1203 * corresponding bit in nxm_value is ignored (it should be 0; Open vSwitch
1204 * may enforce this someday), as is the corresponding bit in the field's
1205 * value. (The sense of the nxm_mask bits is the opposite of that used by
1206 * the "wildcards" member of struct ofp10_match.)
1208 * When nxm_hasmask is 1, nxm_length is always even.
1210 * An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
1211 * entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for
1214 * When there are multiple "nxm_entry"s, all of the constraints must be met.
1220 * Masks may be restricted:
1222 * - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
1223 * must always be 0 when these fields are specified. For example, the
1224 * field that identifies the port on which a packet was received may not be
1227 * - Some nxm_types that do support masked wildcards may only support certain
1228 * nxm_mask patterns. For example, fields that have IPv4 address values
1229 * may be restricted to CIDR masks.
1231 * These restrictions should be noted in specifications for individual fields.
1232 * A switch may accept an nxm_hasmask or nxm_mask value that the specification
1233 * disallows, if the switch correctly implements support for that nxm_hasmask
1234 * or nxm_mask value. A switch must reject an attempt to set up a flow that
1235 * contains a nxm_hasmask or nxm_mask value that it does not support.
1238 * Prerequisite Restrictions
1239 * =========================
1241 * The presence of an nxm_entry with a given nxm_type may be restricted based
1242 * on the presence of or values of other "nxm_entry"s. For example:
1244 * - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
1245 * preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
1246 * and nxm_value=0x0800. That is, matching on the IP source address is
1247 * allowed only if the Ethernet type is explicitly set to IP.
1249 * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is
1250 * preceded by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and
1251 * nxm_value either 0x0800 or 0x86dd, and another with
1252 * nxm_type=NXM_OF_IP_PROTO, nxm_hasmask=0, nxm_value=6, in that order.
1253 * That is, matching on the TCP source port is allowed only if the Ethernet
1254 * type is IP or IPv6 and the IP protocol is TCP.
1256 * These restrictions should be noted in specifications for individual fields.
1257 * A switch may implement relaxed versions of these restrictions. A switch
1258 * must reject an attempt to set up a flow that violates its restrictions.
1261 * Ordering Restrictions
1262 * =====================
1264 * An nxm_entry that has prerequisite restrictions must appear after the
1265 * "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an
1266 * nx_match is not otherwise constrained.
1268 * Any given nxm_type may appear in an nx_match at most once.
1271 * nxm_entry Examples
1272 * ==================
1274 * These examples show the format of a single nxm_entry with particular
1275 * nxm_hasmask and nxm_length values. The diagrams are labeled with field
1276 * numbers and byte indexes.
1279 * 8-bit nxm_value, nxm_hasmask=1, nxm_length=2:
1282 * +------------+---+---+
1283 * | header | v | m |
1284 * +------------+---+---+
1287 * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
1290 * +------------+------+
1292 * +------------+------+
1295 * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
1298 * +------------+-------------+
1299 * | header | nxm_value |
1300 * +------------+-------------+
1303 * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
1306 * +------------+------------------+
1307 * | header | nxm_value |
1308 * +------------+------------------+
1311 * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
1314 * +------------+------------------+------------------+
1315 * | header | nxm_value | nxm_mask |
1316 * +------------+------------------+------------------+
1322 * A switch should report an error in an nx_match using error type
1323 * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch
1324 * should report a specific error code, if one is assigned for the particular
1325 * problem, but NXBRC_NXM_INVALID is also available to report a generic
1329 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
1330 (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
1331 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
1332 NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
1333 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
1334 NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
1335 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
1336 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
1337 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
1338 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
1339 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
1341 #define NXM_MAKE_WILD_HEADER(HEADER) \
1342 NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
1344 /* ## ------------------------------- ## */
1345 /* ## OpenFlow 1.0-compatible fields. ## */
1346 /* ## ------------------------------- ## */
1348 /* Physical or virtual port on which the packet was received.
1352 * Format: 16-bit integer in network byte order.
1354 * Masking: Not maskable. */
1355 #define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
1357 /* Source or destination address in Ethernet header.
1361 * Format: 48-bit Ethernet MAC address.
1363 * Masking: Fully maskable, in versions 1.8 and later. Earlier versions only
1364 * supported the following masks for NXM_OF_ETH_DST_W: 00:00:00:00:00:00,
1365 * fe:ff:ff:ff:ff:ff, 01:00:00:00:00:00, ff:ff:ff:ff:ff:ff. */
1366 #define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
1367 #define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
1368 #define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
1369 #define NXM_OF_ETH_SRC_W NXM_HEADER_W(0x0000, 2, 6)
1371 /* Packet's Ethernet type.
1373 * For an Ethernet II packet this is taken from the Ethernet header. For an
1374 * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
1375 * A packet that has neither format has value 0x05ff
1376 * (OFP_DL_TYPE_NOT_ETH_TYPE).
1378 * For a packet with an 802.1Q header, this is the type of the encapsulated
1383 * Format: 16-bit integer in network byte order.
1385 * Masking: Not maskable. */
1386 #define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
1390 * For a packet with an 802.1Q header, this is the Tag Control Information
1391 * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
1392 * header, this has value 0.
1396 * Format: 16-bit integer in network byte order.
1398 * Masking: Arbitrary masks.
1400 * This field can be used in various ways:
1402 * - If it is not constrained at all, the nx_match matches packets without
1403 * an 802.1Q header or with an 802.1Q header that has any TCI value.
1405 * - Testing for an exact match with 0 matches only packets without an
1408 * - Testing for an exact match with a TCI value with CFI=1 matches packets
1409 * that have an 802.1Q header with a specified VID and PCP.
1411 * - Testing for an exact match with a nonzero TCI value with CFI=0 does
1412 * not make sense. The switch may reject this combination.
1414 * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
1415 * packets that have an 802.1Q header with that VID (and any PCP).
1417 * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
1418 * packets that have an 802.1Q header with that PCP (and any VID).
1420 * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
1421 * header or with an 802.1Q header with a VID of 0.
1423 * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
1424 * header or with an 802.1Q header with a PCP of 0.
1426 * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
1427 * header or with an 802.1Q header with both VID and PCP of 0.
1429 #define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
1430 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
1432 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
1434 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1436 * Format: 8-bit integer with 2 least-significant bits forced to 0.
1438 * Masking: Not maskable. */
1439 #define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
1441 /* The "protocol" byte in the IP header.
1443 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1445 * Format: 8-bit integer.
1447 * Masking: Not maskable. */
1448 #define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
1450 /* The source or destination address in the IP header.
1452 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
1454 * Format: 32-bit integer in network byte order.
1456 * Masking: Fully maskable, in Open vSwitch 1.8 and later. In earlier
1457 * versions, only CIDR masks are allowed, that is, masks that consist of N
1458 * high-order bits set to 1 and the other 32-N bits set to 0. */
1459 #define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
1460 #define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
1461 #define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
1462 #define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
1464 /* The source or destination port in the TCP header.
1467 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1468 * NXM_OF_IP_PROTO must match 6 exactly.
1470 * Format: 16-bit integer in network byte order.
1472 * Masking: Fully maskable, in Open vSwitch 1.6 and later. Not maskable, in
1473 * earlier versions. */
1474 #define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
1475 #define NXM_OF_TCP_SRC_W NXM_HEADER_W(0x0000, 9, 2)
1476 #define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
1477 #define NXM_OF_TCP_DST_W NXM_HEADER_W(0x0000, 10, 2)
1479 /* The source or destination port in the UDP header.
1482 * NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1483 * NXM_OF_IP_PROTO must match 17 exactly.
1485 * Format: 16-bit integer in network byte order.
1487 * Masking: Fully maskable, in Open vSwitch 1.6 and later. Not maskable, in
1488 * earlier versions. */
1489 #define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
1490 #define NXM_OF_UDP_SRC_W NXM_HEADER_W(0x0000, 11, 2)
1491 #define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
1492 #define NXM_OF_UDP_DST_W NXM_HEADER_W(0x0000, 12, 2)
1494 /* The type or code in the ICMP header.
1497 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
1498 * NXM_OF_IP_PROTO must match 1 exactly.
1500 * Format: 8-bit integer.
1502 * Masking: Not maskable. */
1503 #define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
1504 #define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
1508 * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
1509 * otherwise. Only ARP opcodes between 1 and 255 should be specified for
1512 * Prereqs: NXM_OF_ETH_TYPE must match either 0x0806 or 0x8035.
1514 * Format: 16-bit integer in network byte order.
1516 * Masking: Not maskable. */
1517 #define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
1519 /* For an Ethernet+IP ARP packet, the source or target protocol address
1520 * in the ARP header. Always 0 otherwise.
1522 * Prereqs: NXM_OF_ETH_TYPE must match either 0x0806 or 0x8035.
1524 * Format: 32-bit integer in network byte order.
1526 * Masking: Fully maskable, in Open vSwitch 1.8 and later. In earlier
1527 * versions, only CIDR masks are allowed, that is, masks that consist of N
1528 * high-order bits set to 1 and the other 32-N bits set to 0. */
1529 #define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
1530 #define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
1531 #define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
1532 #define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
1534 /* ## ------------------------ ## */
1535 /* ## Nicira match extensions. ## */
1536 /* ## ------------------------ ## */
1538 /* Metadata registers.
1540 * Registers initially have value 0. Actions allow register values to be
1545 * Format: Array of 32-bit integer registers. Space is reserved for up to
1546 * NXM_NX_MAX_REGS registers, but switches may implement fewer.
1548 * Masking: Arbitrary masks. */
1549 #define NXM_NX_MAX_REGS 16
1550 #define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
1551 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1552 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1553 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1554 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1555 #define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
1556 #define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
1557 #define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
1558 #define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
1559 #define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
1560 #define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
1561 #define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
1562 #define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
1563 #define NXM_NX_REG4 NXM_HEADER (0x0001, 4, 4)
1564 #define NXM_NX_REG4_W NXM_HEADER_W(0x0001, 4, 4)
1565 #define NXM_NX_REG5 NXM_HEADER (0x0001, 5, 4)
1566 #define NXM_NX_REG5_W NXM_HEADER_W(0x0001, 5, 4)
1567 #define NXM_NX_REG6 NXM_HEADER (0x0001, 6, 4)
1568 #define NXM_NX_REG6_W NXM_HEADER_W(0x0001, 6, 4)
1569 #define NXM_NX_REG7 NXM_HEADER (0x0001, 7, 4)
1570 #define NXM_NX_REG7_W NXM_HEADER_W(0x0001, 7, 4)
1574 * For a packet received via a GRE, VXLAN or LISP tunnel including a (32-bit)
1575 * key, the key is stored in the low 32-bits and the high bits are zeroed. For
1576 * other packets, the value is 0.
1578 * All zero bits, for packets not received via a keyed tunnel.
1582 * Format: 64-bit integer in network byte order.
1584 * Masking: Arbitrary masks. */
1585 #define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
1586 #define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
1588 /* For an Ethernet+IP ARP packet, the source or target hardware address
1589 * in the ARP header. Always 0 otherwise.
1591 * Prereqs: NXM_OF_ETH_TYPE must match either 0x0806 or 0x8035.
1593 * Format: 48-bit Ethernet MAC address.
1595 * Masking: Not maskable. */
1596 #define NXM_NX_ARP_SHA NXM_HEADER (0x0001, 17, 6)
1597 #define NXM_NX_ARP_THA NXM_HEADER (0x0001, 18, 6)
1599 /* The source or destination address in the IPv6 header.
1601 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1603 * Format: 128-bit IPv6 address.
1605 * Masking: Fully maskable, in Open vSwitch 1.8 and later. In previous
1606 * versions, only CIDR masks are allowed, that is, masks that consist of N
1607 * high-order bits set to 1 and the other 128-N bits set to 0. */
1608 #define NXM_NX_IPV6_SRC NXM_HEADER (0x0001, 19, 16)
1609 #define NXM_NX_IPV6_SRC_W NXM_HEADER_W(0x0001, 19, 16)
1610 #define NXM_NX_IPV6_DST NXM_HEADER (0x0001, 20, 16)
1611 #define NXM_NX_IPV6_DST_W NXM_HEADER_W(0x0001, 20, 16)
1613 /* The type or code in the ICMPv6 header.
1616 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1617 * NXM_OF_IP_PROTO must match 58 exactly.
1619 * Format: 8-bit integer.
1621 * Masking: Not maskable. */
1622 #define NXM_NX_ICMPV6_TYPE NXM_HEADER (0x0001, 21, 1)
1623 #define NXM_NX_ICMPV6_CODE NXM_HEADER (0x0001, 22, 1)
1625 /* The target address in an IPv6 Neighbor Discovery message.
1628 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1629 * NXM_OF_IP_PROTO must match 58 exactly.
1630 * NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1632 * Format: 128-bit IPv6 address.
1634 * Masking: Fully maskable, in Open vSwitch 1.8 and later. In previous
1635 * versions, only CIDR masks are allowed, that is, masks that consist of N
1636 * high-order bits set to 1 and the other 128-N bits set to 0. */
1637 #define NXM_NX_ND_TARGET NXM_HEADER (0x0001, 23, 16)
1638 #define NXM_NX_ND_TARGET_W NXM_HEADER_W (0x0001, 23, 16)
1640 /* The source link-layer address option in an IPv6 Neighbor Discovery
1644 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1645 * NXM_OF_IP_PROTO must match 58 exactly.
1646 * NXM_OF_ICMPV6_TYPE must be exactly 135.
1648 * Format: 48-bit Ethernet MAC address.
1650 * Masking: Not maskable. */
1651 #define NXM_NX_ND_SLL NXM_HEADER (0x0001, 24, 6)
1653 /* The target link-layer address option in an IPv6 Neighbor Discovery
1657 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1658 * NXM_OF_IP_PROTO must match 58 exactly.
1659 * NXM_OF_ICMPV6_TYPE must be exactly 136.
1661 * Format: 48-bit Ethernet MAC address.
1663 * Masking: Not maskable. */
1664 #define NXM_NX_ND_TLL NXM_HEADER (0x0001, 25, 6)
1666 /* IP fragment information.
1669 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1671 * Format: 8-bit value with one of the values 0, 1, or 3, as described below.
1673 * Masking: Fully maskable.
1675 * This field has three possible values:
1677 * - A packet that is not an IP fragment has value 0.
1679 * - A packet that is an IP fragment with offset 0 (the first fragment) has
1680 * bit 0 set and thus value 1.
1682 * - A packet that is an IP fragment with nonzero offset has bits 0 and 1 set
1685 * NX_IP_FRAG_ANY and NX_IP_FRAG_LATER are declared to symbolically represent
1686 * the meanings of bits 0 and 1.
1688 * The switch may reject matches against values that can never appear.
1690 * It is important to understand how this field interacts with the OpenFlow IP
1691 * fragment handling mode:
1693 * - In OFPC_FRAG_DROP mode, the OpenFlow switch drops all IP fragments
1694 * before they reach the flow table, so every packet that is available for
1695 * matching will have value 0 in this field.
1697 * - Open vSwitch does not implement OFPC_FRAG_REASM mode, but if it did then
1698 * IP fragments would be reassembled before they reached the flow table and
1699 * again every packet available for matching would always have value 0.
1701 * - In OFPC_FRAG_NORMAL mode, all three values are possible, but OpenFlow
1702 * 1.0 says that fragments' transport ports are always 0, even for the
1703 * first fragment, so this does not provide much extra information.
1705 * - In OFPC_FRAG_NX_MATCH mode, all three values are possible. For
1706 * fragments with offset 0, Open vSwitch makes L4 header information
1709 #define NXM_NX_IP_FRAG NXM_HEADER (0x0001, 26, 1)
1710 #define NXM_NX_IP_FRAG_W NXM_HEADER_W(0x0001, 26, 1)
1712 /* Bits in the value of NXM_NX_IP_FRAG. */
1713 #define NX_IP_FRAG_ANY (1 << 0) /* Is this a fragment? */
1714 #define NX_IP_FRAG_LATER (1 << 1) /* Is this a fragment with nonzero offset? */
1716 /* The flow label in the IPv6 header.
1718 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1720 * Format: 20-bit IPv6 flow label in least-significant bits.
1722 * Masking: Fully maskable. */
1723 #define NXM_NX_IPV6_LABEL NXM_HEADER (0x0001, 27, 4)
1724 #define NXM_NX_IPV6_LABEL_W NXM_HEADER_W(0x0001, 27, 4)
1726 /* The ECN of the IP header.
1728 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1730 * Format: ECN in the low-order 2 bits.
1732 * Masking: Not maskable. */
1733 #define NXM_NX_IP_ECN NXM_HEADER (0x0001, 28, 1)
1735 /* The time-to-live/hop limit of the IP header.
1737 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1739 * Format: 8-bit integer.
1741 * Masking: Not maskable. */
1742 #define NXM_NX_IP_TTL NXM_HEADER (0x0001, 29, 1)
1746 * This may be used to gain the OpenFlow 1.1-like ability to restrict
1747 * certain NXM-based Flow Mod and Flow Stats Request messages to flows
1748 * with specific cookies. See the "nx_flow_mod" and "nx_flow_stats_request"
1749 * structure definitions for more details. This match is otherwise not
1754 * Format: 64-bit integer in network byte order.
1756 * Masking: Arbitrary masks. */
1757 #define NXM_NX_COOKIE NXM_HEADER (0x0001, 30, 8)
1758 #define NXM_NX_COOKIE_W NXM_HEADER_W(0x0001, 30, 8)
1760 /* The source or destination address in the outer IP header of a tunneled
1763 * For non-tunneled packets, the value is 0.
1767 * Format: 32-bit integer in network byte order.
1769 * Masking: Fully maskable. */
1770 #define NXM_NX_TUN_IPV4_SRC NXM_HEADER (0x0001, 31, 4)
1771 #define NXM_NX_TUN_IPV4_SRC_W NXM_HEADER_W(0x0001, 31, 4)
1772 #define NXM_NX_TUN_IPV4_DST NXM_HEADER (0x0001, 32, 4)
1773 #define NXM_NX_TUN_IPV4_DST_W NXM_HEADER_W(0x0001, 32, 4)
1775 /* Metadata marked onto the packet in a system-dependent manner.
1777 * The packet mark may be used to carry contextual information
1778 * to other parts of the system outside of Open vSwitch. As a
1779 * result, the semantics depend on system in use.
1783 * Format: 32-bit integer in network byte order.
1785 * Masking: Fully maskable. */
1786 #define NXM_NX_PKT_MARK NXM_HEADER (0x0001, 33, 4)
1787 #define NXM_NX_PKT_MARK_W NXM_HEADER_W(0x0001, 33, 4)
1789 /* The flags in the TCP header.
1792 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1793 * NXM_OF_IP_PROTO must match 6 exactly.
1795 * Format: 16-bit integer with 4 most-significant bits forced to 0.
1797 * Masking: Bits 0-11 fully maskable. */
1798 #define NXM_NX_TCP_FLAGS NXM_HEADER (0x0001, 34, 2)
1799 #define NXM_NX_TCP_FLAGS_W NXM_HEADER_W(0x0001, 34, 2)
1801 /* ## --------------------- ## */
1802 /* ## Requests and replies. ## */
1803 /* ## --------------------- ## */
1805 enum nx_flow_format {
1806 NXFF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
1807 NXFF_NXM = 2 /* Nicira extended match. */
1810 /* NXT_SET_FLOW_FORMAT request. */
1811 struct nx_set_flow_format {
1812 ovs_be32 format; /* One of NXFF_*. */
1814 OFP_ASSERT(sizeof(struct nx_set_flow_format) == 4);
1816 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD).
1818 * It is possible to limit flow deletions and modifications to certain
1819 * cookies by using the NXM_NX_COOKIE(_W) matches. The "cookie" field
1820 * is used only to add or modify flow cookies.
1822 struct nx_flow_mod {
1823 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1824 ovs_be16 command; /* OFPFC_* + possibly a table ID (see comment
1825 * on struct nx_flow_mod_table_id). */
1826 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
1827 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
1828 ovs_be16 priority; /* Priority level of flow entry. */
1829 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
1830 Not meaningful for OFPFC_DELETE*. */
1831 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
1832 matching entries to include this as an
1833 output port. A value of OFPP_NONE
1834 indicates no restriction. */
1835 ovs_be16 flags; /* One of OFPFF_*. */
1836 ovs_be16 match_len; /* Size of nx_match. */
1837 uint8_t pad[6]; /* Align to 64-bits. */
1839 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1840 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1841 * all-zero bytes, then
1842 * - Actions to fill out the remainder of the message length (always a
1846 OFP_ASSERT(sizeof(struct nx_flow_mod) == 32);
1848 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED).
1850 * 'table_id' is present only in Open vSwitch 1.11 and later. In earlier
1851 * versions of Open vSwitch, this is a padding byte that is always zeroed.
1852 * Therefore, a 'table_id' value of 0 indicates that the table ID is not known,
1853 * and other values may be interpreted as one more than the flow's former table
1855 struct nx_flow_removed {
1856 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1857 ovs_be16 priority; /* Priority level of flow entry. */
1858 uint8_t reason; /* One of OFPRR_*. */
1859 uint8_t table_id; /* Flow's former table ID, plus one. */
1860 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
1861 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
1863 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
1864 ovs_be16 match_len; /* Size of nx_match. */
1865 ovs_be64 packet_count;
1866 ovs_be64 byte_count;
1868 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1869 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1870 * all-zero bytes. */
1872 OFP_ASSERT(sizeof(struct nx_flow_removed) == 40);
1874 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1877 * It is possible to limit matches to certain cookies by using the
1878 * NXM_NX_COOKIE and NXM_NX_COOKIE_W matches.
1880 struct nx_flow_stats_request {
1881 ovs_be16 out_port; /* Require matching entries to include this
1882 as an output port. A value of OFPP_NONE
1883 indicates no restriction. */
1884 ovs_be16 match_len; /* Length of nx_match. */
1885 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1886 or 0xff for all tables. */
1887 uint8_t pad[3]; /* Align to 64 bits. */
1889 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1890 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1891 * all-zero bytes, which must also exactly fill out the length of the
1895 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 8);
1897 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1898 * OFPST_FLOW reply).
1900 * The values of 'idle_age' and 'hard_age' are only meaningful when talking to
1901 * a switch that implements the NXT_FLOW_AGE extension. Zero means that the
1902 * true value is unknown, perhaps because hardware does not track the value.
1903 * (Zero is also the value that one should ordinarily expect to see talking to
1904 * a switch that does not implement NXT_FLOW_AGE, since those switches zero the
1905 * padding bytes that these fields replaced.) A nonzero value X represents X-1
1906 * seconds. A value of 65535 represents 65534 or more seconds.
1908 * 'idle_age' is the number of seconds that the flow has been idle, that is,
1909 * the number of seconds since a packet passed through the flow. 'hard_age' is
1910 * the number of seconds since the flow was last modified (e.g. OFPFC_MODIFY or
1911 * OFPFC_MODIFY_STRICT). (The 'duration_*' fields are the elapsed time since
1912 * the flow was added, regardless of subsequent modifications.)
1914 * For a flow with an idle or hard timeout, 'idle_age' or 'hard_age',
1915 * respectively, will ordinarily be smaller than the timeout, but flow
1916 * expiration times are only approximate and so one must be prepared to
1917 * tolerate expirations that occur somewhat early or late.
1919 struct nx_flow_stats {
1920 ovs_be16 length; /* Length of this entry. */
1921 uint8_t table_id; /* ID of table flow came from. */
1923 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
1924 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
1925 beyond duration_sec. */
1926 ovs_be16 priority; /* Priority of the entry. */
1927 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
1928 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
1929 ovs_be16 match_len; /* Length of nx_match. */
1930 ovs_be16 idle_age; /* Seconds since last packet, plus one. */
1931 ovs_be16 hard_age; /* Seconds since last modification, plus one. */
1932 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1933 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1934 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1936 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1937 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1938 * all-zero bytes, then
1939 * - Actions to fill out the remainder 'length' bytes (always a multiple
1943 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1945 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1946 * OFPST_AGGREGATE request).
1948 * The reply format is identical to the reply format for OFPST_AGGREGATE,
1949 * except for the header. */
1950 struct nx_aggregate_stats_request {
1951 ovs_be16 out_port; /* Require matching entries to include this
1952 as an output port. A value of OFPP_NONE
1953 indicates no restriction. */
1954 ovs_be16 match_len; /* Length of nx_match. */
1955 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1956 or 0xff for all tables. */
1957 uint8_t pad[3]; /* Align to 64 bits. */
1959 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1960 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1961 * all-zero bytes, which must also exactly fill out the length of the
1965 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 8);
1967 /* NXT_SET_CONTROLLER_ID.
1969 * Each OpenFlow controller connection has a 16-bit identifier that is
1970 * initially 0. This message changes the connection's ID to 'id'.
1972 * Controller connection IDs need not be unique.
1974 * The NXAST_CONTROLLER action is the only current user of controller
1975 * connection IDs. */
1976 struct nx_controller_id {
1977 uint8_t zero[6]; /* Must be zero. */
1978 ovs_be16 controller_id; /* New controller connection ID. */
1980 OFP_ASSERT(sizeof(struct nx_controller_id) == 8);
1982 /* Action structure for NXAST_CONTROLLER.
1984 * This generalizes using OFPAT_OUTPUT to send a packet to OFPP_CONTROLLER. In
1985 * addition to the 'max_len' that OFPAT_OUTPUT supports, it also allows
1988 * - 'reason': The reason code to use in the ofp_packet_in or nx_packet_in.
1990 * - 'controller_id': The ID of the controller connection to which the
1991 * ofp_packet_in should be sent. The ofp_packet_in or nx_packet_in is
1992 * sent only to controllers that have the specified controller connection
1993 * ID. See "struct nx_controller_id" for more information. */
1994 struct nx_action_controller {
1995 ovs_be16 type; /* OFPAT_VENDOR. */
1996 ovs_be16 len; /* Length is 16. */
1997 ovs_be32 vendor; /* NX_VENDOR_ID. */
1998 ovs_be16 subtype; /* NXAST_CONTROLLER. */
1999 ovs_be16 max_len; /* Maximum length to send to controller. */
2000 ovs_be16 controller_id; /* Controller ID to send packet-in. */
2001 uint8_t reason; /* enum ofp_packet_in_reason (OFPR_*). */
2002 uint8_t zero; /* Must be zero. */
2004 OFP_ASSERT(sizeof(struct nx_action_controller) == 16);
2006 /* Flow Table Monitoring
2007 * =====================
2009 * NXST_FLOW_MONITOR allows a controller to keep track of changes to OpenFlow
2010 * flow table(s) or subsets of them, with the following workflow:
2012 * 1. The controller sends an NXST_FLOW_MONITOR request to begin monitoring
2013 * flows. The 'id' in the request must be unique among all monitors that
2014 * the controller has started and not yet canceled on this OpenFlow
2017 * 2. The switch responds with an NXST_FLOW_MONITOR reply. If the request's
2018 * 'flags' included NXFMF_INITIAL, the reply includes all the flows that
2019 * matched the request at the time of the request (with event NXFME_ADDED).
2020 * If 'flags' did not include NXFMF_INITIAL, the reply is empty.
2022 * The reply uses the xid of the request (as do all replies to OpenFlow
2025 * 3. Whenever a change to a flow table entry matches some outstanding monitor
2026 * request's criteria and flags, the switch sends a notification to the
2027 * controller as an additional NXST_FLOW_MONITOR reply with xid 0.
2029 * When multiple outstanding monitors match a single change, only a single
2030 * notification is sent. This merged notification includes the information
2031 * requested in any of the individual monitors. That is, if any of the
2032 * matching monitors requests actions (NXFMF_ACTIONS), the notification
2033 * includes actions, and if any of the monitors request full changes for the
2034 * controller's own changes (NXFMF_OWN), the controller's own changes will
2035 * be included in full.
2037 * 4. The controller may cancel a monitor with NXT_FLOW_MONITOR_CANCEL. No
2038 * further notifications will be sent on the basis of the canceled monitor
2045 * OpenFlow messages for flow monitor notifications can overflow the buffer
2046 * space available to the switch, either temporarily (e.g. due to network
2047 * conditions slowing OpenFlow traffic) or more permanently (e.g. the sustained
2048 * rate of flow table change exceeds the network bandwidth between switch and
2051 * When Open vSwitch's notification buffer space reaches a limiting threshold,
2052 * OVS reacts as follows:
2054 * 1. OVS sends an NXT_FLOW_MONITOR_PAUSED message to the controller, following
2055 * all the already queued notifications. After it receives this message,
2056 * the controller knows that its view of the flow table, as represented by
2057 * flow monitor notifications, is incomplete.
2059 * 2. As long as the notification buffer is not empty:
2061 * - NXMFE_ADD and NXFME_MODIFIED notifications will not be sent.
2063 * - NXFME_DELETED notifications will still be sent, but only for flows
2064 * that existed before OVS sent NXT_FLOW_MONITOR_PAUSED.
2066 * - NXFME_ABBREV notifications will not be sent. They are treated as
2067 * the expanded version (and therefore only the NXFME_DELETED
2068 * components, if any, are sent).
2070 * 3. When the notification buffer empties, OVS sends NXFME_ADD notifications
2071 * for flows added since the buffer reached its limit and NXFME_MODIFIED
2072 * notifications for flows that existed before the limit was reached and
2073 * changed after the limit was reached.
2075 * 4. OVS sends an NXT_FLOW_MONITOR_RESUMED message to the controller. After
2076 * it receives this message, the controller knows that its view of the flow
2077 * table, as represented by flow monitor notifications, is again complete.
2079 * This allows the maximum buffer space requirement for notifications to be
2080 * bounded by the limit plus the maximum number of supported flows.
2083 * "Flow Removed" messages
2084 * =======================
2086 * The flow monitor mechanism is independent of OFPT_FLOW_REMOVED and
2087 * NXT_FLOW_REMOVED. Flow monitor updates for deletion are sent if
2088 * NXFMF_DELETE is set on a monitor, regardless of whether the
2089 * OFPFF_SEND_FLOW_REM flag was set when the flow was added. */
2091 /* NXST_FLOW_MONITOR request.
2093 * The NXST_FLOW_MONITOR request's body consists of an array of zero or more
2094 * instances of this structure. The request arranges to monitor the flows
2095 * that match the specified criteria, which are interpreted in the same way as
2098 * 'id' identifies a particular monitor for the purpose of allowing it to be
2099 * canceled later with NXT_FLOW_MONITOR_CANCEL. 'id' must be unique among
2100 * existing monitors that have not already been canceled.
2102 * The reply includes the initial flow matches for monitors that have the
2103 * NXFMF_INITIAL flag set. No single flow will be included in the reply more
2104 * than once, even if more than one requested monitor matches that flow. The
2105 * reply will be empty if none of the monitors has NXFMF_INITIAL set or if none
2106 * of the monitors initially matches any flows.
2108 * For NXFMF_ADD, an event will be reported if 'out_port' matches against the
2109 * actions of the flow being added or, for a flow that is replacing an existing
2110 * flow, if 'out_port' matches against the actions of the flow being replaced.
2111 * For NXFMF_DELETE, 'out_port' matches against the actions of a flow being
2112 * deleted. For NXFMF_MODIFY, an event will be reported if 'out_port' matches
2113 * either the old or the new actions. */
2114 struct nx_flow_monitor_request {
2115 ovs_be32 id; /* Controller-assigned ID for this monitor. */
2116 ovs_be16 flags; /* NXFMF_*. */
2117 ovs_be16 out_port; /* Required output port, if not OFPP_NONE. */
2118 ovs_be16 match_len; /* Length of nx_match. */
2119 uint8_t table_id; /* One table's ID or 0xff for all tables. */
2120 uint8_t zeros[5]; /* Align to 64 bits (must be zero). */
2122 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
2123 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
2124 * all-zero bytes. */
2126 OFP_ASSERT(sizeof(struct nx_flow_monitor_request) == 16);
2128 /* 'flags' bits in struct nx_flow_monitor_request. */
2129 enum nx_flow_monitor_flags {
2130 /* When to send updates. */
2131 NXFMF_INITIAL = 1 << 0, /* Initially matching flows. */
2132 NXFMF_ADD = 1 << 1, /* New matching flows as they are added. */
2133 NXFMF_DELETE = 1 << 2, /* Old matching flows as they are removed. */
2134 NXFMF_MODIFY = 1 << 3, /* Matching flows as they are changed. */
2136 /* What to include in updates. */
2137 NXFMF_ACTIONS = 1 << 4, /* If set, actions are included. */
2138 NXFMF_OWN = 1 << 5, /* If set, include own changes in full. */
2141 /* NXST_FLOW_MONITOR reply header.
2143 * The body of an NXST_FLOW_MONITOR reply is an array of variable-length
2144 * structures, each of which begins with this header. The 'length' member may
2145 * be used to traverse the array, and the 'event' member may be used to
2146 * determine the particular structure.
2148 * Every instance is a multiple of 8 bytes long. */
2149 struct nx_flow_update_header {
2150 ovs_be16 length; /* Length of this entry. */
2151 ovs_be16 event; /* One of NXFME_*. */
2152 /* ...other data depending on 'event'... */
2154 OFP_ASSERT(sizeof(struct nx_flow_update_header) == 4);
2156 /* 'event' values in struct nx_flow_update_header. */
2157 enum nx_flow_update_event {
2158 /* struct nx_flow_update_full. */
2159 NXFME_ADDED = 0, /* Flow was added. */
2160 NXFME_DELETED = 1, /* Flow was deleted. */
2161 NXFME_MODIFIED = 2, /* Flow (generally its actions) was changed. */
2163 /* struct nx_flow_update_abbrev. */
2164 NXFME_ABBREV = 3, /* Abbreviated reply. */
2167 /* NXST_FLOW_MONITOR reply for NXFME_ADDED, NXFME_DELETED, and
2168 * NXFME_MODIFIED. */
2169 struct nx_flow_update_full {
2170 ovs_be16 length; /* Length is 24. */
2171 ovs_be16 event; /* One of NXFME_*. */
2172 ovs_be16 reason; /* OFPRR_* for NXFME_DELETED, else zero. */
2173 ovs_be16 priority; /* Priority of the entry. */
2174 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
2175 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
2176 ovs_be16 match_len; /* Length of nx_match. */
2177 uint8_t table_id; /* ID of flow's table. */
2178 uint8_t pad; /* Reserved, currently zeroed. */
2179 ovs_be64 cookie; /* Opaque controller-issued identifier. */
2181 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
2182 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
2183 * all-zero bytes, then
2184 * - Actions to fill out the remainder 'length' bytes (always a multiple
2185 * of 8). If NXFMF_ACTIONS was not specified, or 'event' is
2186 * NXFME_DELETED, no actions are included.
2189 OFP_ASSERT(sizeof(struct nx_flow_update_full) == 24);
2191 /* NXST_FLOW_MONITOR reply for NXFME_ABBREV.
2193 * When the controller does not specify NXFMF_OWN in a monitor request, any
2194 * flow tables changes due to the controller's own requests (on the same
2195 * OpenFlow channel) will be abbreviated, when possible, to this form, which
2196 * simply specifies the 'xid' of the OpenFlow request (e.g. an OFPT_FLOW_MOD or
2197 * NXT_FLOW_MOD) that caused the change.
2199 * Some changes cannot be abbreviated and will be sent in full:
2201 * - Changes that only partially succeed. This can happen if, for example,
2202 * a flow_mod with type OFPFC_MODIFY affects multiple flows, but only some
2203 * of those modifications succeed (e.g. due to hardware limitations).
2205 * This cannot occur with the current implementation of the Open vSwitch
2206 * software datapath. It could happen with other datapath implementations.
2208 * - Changes that race with conflicting changes made by other controllers or
2209 * other flow_mods (not separated by barriers) by the same controller.
2211 * This cannot occur with the current Open vSwitch implementation
2212 * (regardless of datapath) because Open vSwitch internally serializes
2213 * potentially conflicting changes.
2215 * A flow_mod that does not change the flow table will not trigger any
2216 * notification, even an abbreviated one. For example, a "modify" or "delete"
2217 * flow_mod that does not match any flows will not trigger a notification.
2218 * Whether an "add" or "modify" that specifies all the same parameters that a
2219 * flow already has triggers a notification is unspecified and subject to
2220 * change in future versions of Open vSwitch.
2222 * OVS will always send the notifications for a given flow table change before
2223 * the reply to a OFPT_BARRIER_REQUEST request that follows the flow table
2224 * change. Thus, if the controller does not receive an abbreviated (or
2225 * unabbreviated) notification for a flow_mod before the next
2226 * OFPT_BARRIER_REPLY, it will never receive one. */
2227 struct nx_flow_update_abbrev {
2228 ovs_be16 length; /* Length is 8. */
2229 ovs_be16 event; /* NXFME_ABBREV. */
2230 ovs_be32 xid; /* Controller-specified xid from flow_mod. */
2232 OFP_ASSERT(sizeof(struct nx_flow_update_abbrev) == 8);
2234 /* NXT_FLOW_MONITOR_CANCEL.
2236 * Used by a controller to cancel an outstanding monitor. */
2237 struct nx_flow_monitor_cancel {
2238 ovs_be32 id; /* 'id' from nx_flow_monitor_request. */
2240 OFP_ASSERT(sizeof(struct nx_flow_monitor_cancel) == 4);
2242 /* Action structure for NXAST_WRITE_METADATA.
2244 * Modifies the 'mask' bits of the metadata value. */
2245 struct nx_action_write_metadata {
2246 ovs_be16 type; /* OFPAT_VENDOR. */
2247 ovs_be16 len; /* Length is 32. */
2248 ovs_be32 vendor; /* NX_VENDOR_ID. */
2249 ovs_be16 subtype; /* NXAST_WRITE_METADATA. */
2250 uint8_t zeros[6]; /* Must be zero. */
2251 ovs_be64 metadata; /* Metadata register. */
2252 ovs_be64 mask; /* Metadata mask. */
2254 OFP_ASSERT(sizeof(struct nx_action_write_metadata) == 32);
2256 /* Action structure for NXAST_PUSH_MPLS. */
2257 struct nx_action_push_mpls {
2258 ovs_be16 type; /* OFPAT_VENDOR. */
2259 ovs_be16 len; /* Length is 8. */
2260 ovs_be32 vendor; /* NX_VENDOR_ID. */
2261 ovs_be16 subtype; /* NXAST_PUSH_MPLS. */
2262 ovs_be16 ethertype; /* Ethertype */
2265 OFP_ASSERT(sizeof(struct nx_action_push_mpls) == 16);
2267 /* Action structure for NXAST_POP_MPLS. */
2268 struct nx_action_pop_mpls {
2269 ovs_be16 type; /* OFPAT_VENDOR. */
2270 ovs_be16 len; /* Length is 8. */
2271 ovs_be32 vendor; /* NX_VENDOR_ID. */
2272 ovs_be16 subtype; /* NXAST_POP_MPLS. */
2273 ovs_be16 ethertype; /* Ethertype */
2276 OFP_ASSERT(sizeof(struct nx_action_pop_mpls) == 16);
2278 /* Action structure for NXAST_SET_MPLS_LABEL. */
2279 struct nx_action_mpls_label {
2280 ovs_be16 type; /* OFPAT_VENDOR. */
2281 ovs_be16 len; /* Length is 8. */
2282 ovs_be32 vendor; /* NX_VENDOR_ID. */
2283 ovs_be16 subtype; /* NXAST_SET_MPLS_LABEL. */
2284 uint8_t zeros[2]; /* Must be zero. */
2285 ovs_be32 label; /* LABEL */
2287 OFP_ASSERT(sizeof(struct nx_action_mpls_label) == 16);
2289 /* Action structure for NXAST_SET_MPLS_TC. */
2290 struct nx_action_mpls_tc {
2291 ovs_be16 type; /* OFPAT_VENDOR. */
2292 ovs_be16 len; /* Length is 8. */
2293 ovs_be32 vendor; /* NX_VENDOR_ID. */
2294 ovs_be16 subtype; /* NXAST_SET_MPLS_TC. */
2295 uint8_t tc; /* TC */
2298 OFP_ASSERT(sizeof(struct nx_action_mpls_tc) == 16);
2300 /* Action structure for NXAST_SET_MPLS_TTL. */
2301 struct nx_action_mpls_ttl {
2302 ovs_be16 type; /* OFPAT_VENDOR. */
2303 ovs_be16 len; /* Length is 8. */
2304 ovs_be32 vendor; /* NX_VENDOR_ID. */
2305 ovs_be16 subtype; /* NXAST_SET_MPLS_TTL. */
2306 uint8_t ttl; /* TTL */
2309 OFP_ASSERT(sizeof(struct nx_action_mpls_ttl) == 16);
2311 /* Action structure for NXAST_SAMPLE.
2313 * Samples matching packets with the given probability and sends them
2314 * each to the set of collectors identified with the given ID. The
2315 * probability is expressed as a number of packets to be sampled out
2316 * of USHRT_MAX packets, and must be >0.
2318 * When sending packet samples to IPFIX collectors, the IPFIX flow
2319 * record sent for each sampled packet is associated with the given
2320 * observation domain ID and observation point ID. Each IPFIX flow
2321 * record contain the sampled packet's headers when executing this
2322 * rule. If a sampled packet's headers are modified by previous
2323 * actions in the flow, those modified headers are sent. */
2324 struct nx_action_sample {
2325 ovs_be16 type; /* OFPAT_VENDOR. */
2326 ovs_be16 len; /* Length is 24. */
2327 ovs_be32 vendor; /* NX_VENDOR_ID. */
2328 ovs_be16 subtype; /* NXAST_SAMPLE. */
2329 ovs_be16 probability; /* Fraction of packets to sample. */
2330 ovs_be32 collector_set_id; /* ID of collector set in OVSDB. */
2331 ovs_be32 obs_domain_id; /* ID of sampling observation domain. */
2332 ovs_be32 obs_point_id; /* ID of sampling observation point. */
2334 OFP_ASSERT(sizeof(struct nx_action_sample) == 24);
2336 #endif /* openflow/nicira-ext.h */
git://git.onelab.eu / sliver-openvswitch.git / blob