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. */
27 #define NX_VENDOR_ID 0x00002320
29 /* Nicira vendor-specific error messages extension.
31 * OpenFlow 1.0 has a set of predefined error types (OFPET_*) and codes (which
32 * are specific to each type). It does not have any provision for
33 * vendor-specific error codes, and it does not even provide "generic" error
34 * codes that can apply to problems not anticipated by the OpenFlow
35 * specification authors.
37 * This extension attempts to address the problem by adding a generic "error
38 * vendor extension". The extension works as follows: use NXET_VENDOR as type
39 * and NXVC_VENDOR_ERROR as code, followed by struct nx_vendor_error with
40 * vendor-specific details, followed by at least 64 bytes of the failed
43 * It would be better to have a type-specific vendor extension, e.g. so that
44 * OFPET_BAD_ACTION could be used with vendor-specific code values. But
45 * OFPET_BAD_ACTION and most other standardized types already specify that
46 * their 'data' values are (the start of) the OpenFlow message being replied
47 * to, so there is no room to insert a vendor ID.
49 * Currently this extension is only implemented by Open vSwitch, but it seems
50 * like a reasonable candidate for future standardization.
53 /* This is a random number to avoid accidental collision with any other
54 * vendor's extension. */
55 #define NXET_VENDOR 0xb0c2
57 /* ofp_error msg 'code' values for NXET_VENDOR. */
59 NXVC_VENDOR_ERROR /* 'data' contains struct nx_vendor_error. */
62 /* 'data' for 'type' == NXET_VENDOR, 'code' == NXVC_VENDOR_ERROR. */
63 struct nx_vendor_error {
64 ovs_be32 vendor; /* Vendor ID as in struct ofp_vendor_header. */
65 ovs_be16 type; /* Vendor-defined type. */
66 ovs_be16 code; /* Vendor-defined subtype. */
67 /* Followed by at least the first 64 bytes of the failed request. */
70 /* Nicira vendor requests and replies. */
72 /* Header for Nicira vendor requests and replies. */
73 struct nicira_header {
74 struct ofp_header header;
75 ovs_be32 vendor; /* NX_VENDOR_ID. */
76 ovs_be32 subtype; /* See the NXT numbers in ofp-msgs.h. */
78 OFP_ASSERT(sizeof(struct nicira_header) == 16);
80 /* Header for Nicira vendor stats request and reply messages in OpenFlow
82 struct nicira10_stats_msg {
83 struct ofp10_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
84 ovs_be32 subtype; /* One of NXST_* below. */
85 uint8_t pad[4]; /* Align to 64-bits. */
87 OFP_ASSERT(sizeof(struct nicira10_stats_msg) == 24);
89 /* Header for Nicira vendor stats request and reply messages in OpenFlow
91 struct nicira11_stats_msg {
92 struct ofp11_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
93 ovs_be32 subtype; /* One of NXST_* below. */
95 OFP_ASSERT(sizeof(struct nicira11_stats_msg) == 24);
97 /* Fields to use when hashing flows. */
99 /* Ethernet source address (NXM_OF_ETH_SRC) only. */
100 NX_HASH_FIELDS_ETH_SRC,
102 /* L2 through L4, symmetric across src/dst. Specifically, each of the
103 * following fields, if present, is hashed (slashes separate symmetric
106 * - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
108 * - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
110 * - NXM_OF_IP_SRC / NXM_OF_IP_DST
111 * - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
113 NX_HASH_FIELDS_SYMMETRIC_L4
116 /* This command enables or disables an Open vSwitch extension that allows a
117 * controller to specify the OpenFlow table to which a flow should be added,
118 * instead of having the switch decide which table is most appropriate as
119 * required by OpenFlow 1.0. Because NXM was designed as an extension to
120 * OpenFlow 1.0, the extension applies equally to ofp10_flow_mod and
121 * nx_flow_mod. By default, the extension is disabled.
123 * When this feature is enabled, Open vSwitch treats struct ofp10_flow_mod's
124 * and struct nx_flow_mod's 16-bit 'command' member as two separate fields.
125 * The upper 8 bits are used as the table ID, the lower 8 bits specify the
126 * command as usual. A table ID of 0xff is treated like a wildcarded table ID.
128 * The specific treatment of the table ID depends on the type of flow mod:
130 * - OFPFC_ADD: Given a specific table ID, the flow is always placed in that
131 * table. If an identical flow already exists in that table only, then it
132 * is replaced. If the flow cannot be placed in the specified table,
133 * either because the table is full or because the table cannot support
134 * flows of the given type, the switch replies with an OFPFMFC_TABLE_FULL
135 * error. (A controller can distinguish these cases by comparing the
136 * current and maximum number of entries reported in ofp_table_stats.)
138 * If the table ID is wildcarded, the switch picks an appropriate table
139 * itself. If an identical flow already exist in the selected flow table,
140 * then it is replaced. The choice of table might depend on the flows
141 * that are already in the switch; for example, if one table fills up then
142 * the switch might fall back to another one.
144 * - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows
145 * within that table are matched and modified or deleted. If the table ID
146 * is wildcarded, flows within any table may be matched and modified or
149 * - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID,
150 * only a flow within that table may be matched and modified or deleted.
151 * If the table ID is wildcarded and exactly one flow within any table
152 * matches, then it is modified or deleted; if flows in more than one
153 * table match, then none is modified or deleted.
155 struct nx_flow_mod_table_id {
156 uint8_t set; /* Nonzero to enable, zero to disable. */
159 OFP_ASSERT(sizeof(struct nx_flow_mod_table_id) == 8);
161 enum nx_packet_in_format {
162 NXPIF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
163 NXPIF_NXM = 1 /* Nicira Extended. */
166 /* NXT_SET_PACKET_IN_FORMAT request. */
167 struct nx_set_packet_in_format {
168 ovs_be32 format; /* One of NXPIF_*. */
170 OFP_ASSERT(sizeof(struct nx_set_packet_in_format) == 4);
172 /* NXT_PACKET_IN (analogous to OFPT_PACKET_IN).
174 * NXT_PACKET_IN is similar to the OpenFlow 1.2 OFPT_PACKET_IN. The
177 * - NXT_PACKET_IN includes the cookie of the rule that triggered the
178 * message. (OpenFlow 1.3 OFPT_PACKET_IN also includes the cookie.)
180 * - The metadata fields use NXM (instead of OXM) field numbers.
182 * Open vSwitch 1.9.0 and later omits metadata fields that are zero (as allowed
183 * by OpenFlow 1.2). Earlier versions included all implemented metadata
186 * Open vSwitch does not include non-metadata in the nx_match, because by
187 * definition that information can be found in the packet itself. The format
188 * and the standards allow this, however, so controllers should be prepared to
189 * tolerate future changes.
191 * The NXM format is convenient for reporting metadata values, but it is
192 * important not to interpret the format as matching against a flow, because it
193 * does not. Nothing is being matched; arbitrary metadata masks would not be
196 * Whereas in most cases a controller can expect to only get back NXM fields
197 * that it set up itself (e.g. flow dumps will ordinarily report only NXM
198 * fields from flows that the controller added), NXT_PACKET_IN messages might
199 * contain fields that the controller does not understand, because the switch
200 * might support fields (new registers, new protocols, etc.) that the
201 * controller does not. The controller must prepared to tolerate these.
203 * The 'cookie' and 'table_id' fields have no meaning when 'reason' is
204 * OFPR_NO_MATCH. In this case they should be set to 0. */
205 struct nx_packet_in {
206 ovs_be32 buffer_id; /* ID assigned by datapath. */
207 ovs_be16 total_len; /* Full length of frame. */
208 uint8_t reason; /* Reason packet is sent (one of OFPR_*). */
209 uint8_t table_id; /* ID of the table that was looked up. */
210 ovs_be64 cookie; /* Cookie of the rule that was looked up. */
211 ovs_be16 match_len; /* Size of nx_match. */
212 uint8_t pad[6]; /* Align to 64-bits. */
214 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
215 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
216 * all-zero bytes, then
217 * - Exactly 2 all-zero padding bytes, then
218 * - An Ethernet frame whose length is inferred from nxh.header.length.
220 * The padding bytes preceding the Ethernet frame ensure that the IP
221 * header (if any) following the Ethernet header is 32-bit aligned. */
223 /* uint8_t nxm_fields[...]; */ /* NXM headers. */
224 /* uint8_t pad[2]; */ /* Align to 64 bit + 16 bit. */
225 /* uint8_t data[0]; */ /* Ethernet frame. */
227 OFP_ASSERT(sizeof(struct nx_packet_in) == 24);
229 /* Configures the "role" of the sending controller. The default role is:
231 * - Other (NX_ROLE_OTHER), which allows the controller access to all
234 * The other possible roles are a related pair:
236 * - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
237 * be at most one Master controller at a time: when a controller
238 * configures itself as Master, any existing Master is demoted to the
241 * - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
242 * OpenFlow features. In particular attempts to modify the flow table
243 * will be rejected with an OFPBRC_EPERM error.
245 * Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
246 * messages, but they do receive OFPT_PORT_STATUS messages.
248 struct nx_role_request {
249 ovs_be32 role; /* One of NX_ROLE_*. */
251 OFP_ASSERT(sizeof(struct nx_role_request) == 4);
254 NX_ROLE_OTHER, /* Default role, full access. */
255 NX_ROLE_MASTER, /* Full access, at most one. */
256 NX_ROLE_SLAVE /* Read-only access. */
259 /* NXT_SET_ASYNC_CONFIG.
261 * Sent by a controller, this message configures the asynchronous messages that
262 * the controller wants to receive. Element 0 in each array specifies messages
263 * of interest when the controller has an "other" or "master" role; element 1,
264 * when the controller has a "slave" role.
266 * Each array element is a bitmask in which a 0-bit disables receiving a
267 * particular message and a 1-bit enables receiving it. Each bit controls the
268 * message whose 'reason' corresponds to the bit index. For example, the bit
269 * with value 1<<2 == 4 in port_status_mask[1] determines whether the
270 * controller will receive OFPT_PORT_STATUS messages with reason OFPPR_MODIFY
271 * (value 2) when the controller has a "slave" role.
273 * As a side effect, for service controllers, this message changes the
274 * miss_send_len from default of zero to OFP_DEFAULT_MISS_SEND_LEN (128).
276 struct nx_async_config {
277 ovs_be32 packet_in_mask[2]; /* Bitmasks of OFPR_* values. */
278 ovs_be32 port_status_mask[2]; /* Bitmasks of OFPRR_* values. */
279 ovs_be32 flow_removed_mask[2]; /* Bitmasks of OFPPR_* values. */
281 OFP_ASSERT(sizeof(struct nx_async_config) == 24);
283 /* Nicira vendor flow actions. */
285 enum nx_action_subtype {
286 NXAST_SNAT__OBSOLETE, /* No longer used. */
287 NXAST_RESUBMIT, /* struct nx_action_resubmit */
288 NXAST_SET_TUNNEL, /* struct nx_action_set_tunnel */
289 NXAST_DROP_SPOOFED_ARP__OBSOLETE,
290 NXAST_SET_QUEUE, /* struct nx_action_set_queue */
291 NXAST_POP_QUEUE, /* struct nx_action_pop_queue */
292 NXAST_REG_MOVE, /* struct nx_action_reg_move */
293 NXAST_REG_LOAD, /* struct nx_action_reg_load */
294 NXAST_NOTE, /* struct nx_action_note */
295 NXAST_SET_TUNNEL64, /* struct nx_action_set_tunnel64 */
296 NXAST_MULTIPATH, /* struct nx_action_multipath */
297 NXAST_AUTOPATH__OBSOLETE, /* No longer used. */
298 NXAST_BUNDLE, /* struct nx_action_bundle */
299 NXAST_BUNDLE_LOAD, /* struct nx_action_bundle */
300 NXAST_RESUBMIT_TABLE, /* struct nx_action_resubmit */
301 NXAST_OUTPUT_REG, /* struct nx_action_output_reg */
302 NXAST_LEARN, /* struct nx_action_learn */
303 NXAST_EXIT, /* struct nx_action_header */
304 NXAST_DEC_TTL, /* struct nx_action_header */
305 NXAST_FIN_TIMEOUT, /* struct nx_action_fin_timeout */
306 NXAST_CONTROLLER, /* struct nx_action_controller */
307 NXAST_DEC_TTL_CNT_IDS, /* struct nx_action_cnt_ids */
308 NXAST_WRITE_METADATA, /* struct nx_action_write_metadata */
309 NXAST_PUSH_MPLS, /* struct nx_action_push_mpls */
310 NXAST_POP_MPLS, /* struct nx_action_pop_mpls */
311 NXAST_SET_MPLS_TTL, /* struct nx_action_ttl */
312 NXAST_DEC_MPLS_TTL, /* struct nx_action_header */
313 NXAST_STACK_PUSH, /* struct nx_action_stack */
314 NXAST_STACK_POP, /* struct nx_action_stack */
315 NXAST_SAMPLE, /* struct nx_action_sample */
318 /* Header for Nicira-defined actions. */
319 struct nx_action_header {
320 ovs_be16 type; /* OFPAT_VENDOR. */
321 ovs_be16 len; /* Length is 16. */
322 ovs_be32 vendor; /* NX_VENDOR_ID. */
323 ovs_be16 subtype; /* NXAST_*. */
326 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
328 /* Action structures for NXAST_RESUBMIT and NXAST_RESUBMIT_TABLE.
330 * These actions search one of the switch's flow tables:
332 * - For NXAST_RESUBMIT_TABLE only, if the 'table' member is not 255, then
333 * it specifies the table to search.
335 * - Otherwise (for NXAST_RESUBMIT_TABLE with a 'table' of 255, or for
336 * NXAST_RESUBMIT regardless of 'table'), it searches the current flow
337 * table, that is, the OpenFlow flow table that contains the flow from
338 * which this action was obtained. If this action did not come from a
339 * flow table (e.g. it came from an OFPT_PACKET_OUT message), then table 0
340 * is the current table.
342 * The flow table lookup uses a flow that may be slightly modified from the
345 * - For NXAST_RESUBMIT, the 'in_port' member of struct nx_action_resubmit
346 * is used as the flow's in_port.
348 * - For NXAST_RESUBMIT_TABLE, if the 'in_port' member is not OFPP_IN_PORT,
349 * then its value is used as the flow's in_port. Otherwise, the original
352 * - If actions that modify the flow (e.g. OFPAT_SET_VLAN_VID) precede the
353 * resubmit action, then the flow is updated with the new values.
355 * Following the lookup, the original in_port is restored.
357 * If the modified flow matched in the flow table, then the corresponding
358 * actions are executed. Afterward, actions following the resubmit in the
359 * original set of actions, if any, are executed; any changes made to the
360 * packet (e.g. changes to VLAN) by secondary actions persist when those
361 * actions are executed, although the original in_port is restored.
363 * Resubmit actions may be used any number of times within a set of actions.
365 * Resubmit actions may nest to an implementation-defined depth. Beyond this
366 * implementation-defined depth, further resubmit actions are simply ignored.
368 * NXAST_RESUBMIT ignores 'table' and 'pad'. NXAST_RESUBMIT_TABLE requires
369 * 'pad' to be all-bits-zero.
371 * Open vSwitch 1.0.1 and earlier did not support recursion. Open vSwitch
372 * before 1.2.90 did not support NXAST_RESUBMIT_TABLE.
374 struct nx_action_resubmit {
375 ovs_be16 type; /* OFPAT_VENDOR. */
376 ovs_be16 len; /* Length is 16. */
377 ovs_be32 vendor; /* NX_VENDOR_ID. */
378 ovs_be16 subtype; /* NXAST_RESUBMIT. */
379 ovs_be16 in_port; /* New in_port for checking flow table. */
380 uint8_t table; /* NXAST_RESUBMIT_TABLE: table to use. */
383 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
385 /* Action structure for NXAST_SET_TUNNEL.
387 * Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32
388 * bits of the tunnel ID are set to 0. */
389 struct nx_action_set_tunnel {
390 ovs_be16 type; /* OFPAT_VENDOR. */
391 ovs_be16 len; /* Length is 16. */
392 ovs_be32 vendor; /* NX_VENDOR_ID. */
393 ovs_be16 subtype; /* NXAST_SET_TUNNEL. */
395 ovs_be32 tun_id; /* Tunnel ID. */
397 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
399 /* Action structure for NXAST_SET_TUNNEL64.
401 * Sets the encapsulating tunnel ID to a 64-bit value. */
402 struct nx_action_set_tunnel64 {
403 ovs_be16 type; /* OFPAT_VENDOR. */
404 ovs_be16 len; /* Length is 24. */
405 ovs_be32 vendor; /* NX_VENDOR_ID. */
406 ovs_be16 subtype; /* NXAST_SET_TUNNEL64. */
408 ovs_be64 tun_id; /* Tunnel ID. */
410 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
412 /* Action structure for NXAST_SET_QUEUE.
414 * Set the queue that should be used when packets are output. This is similar
415 * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
416 * an argument. This allows the queue to be defined before the port is
418 struct nx_action_set_queue {
419 ovs_be16 type; /* OFPAT_VENDOR. */
420 ovs_be16 len; /* Length is 16. */
421 ovs_be32 vendor; /* NX_VENDOR_ID. */
422 ovs_be16 subtype; /* NXAST_SET_QUEUE. */
424 ovs_be32 queue_id; /* Where to enqueue packets. */
426 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
428 /* Action structure for NXAST_POP_QUEUE.
430 * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
431 * were used. Only the original queue can be restored this way; no stack is
433 struct nx_action_pop_queue {
434 ovs_be16 type; /* OFPAT_VENDOR. */
435 ovs_be16 len; /* Length is 16. */
436 ovs_be32 vendor; /* NX_VENDOR_ID. */
437 ovs_be16 subtype; /* NXAST_POP_QUEUE. */
440 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
442 /* Action structure for NXAST_REG_MOVE.
444 * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
445 * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
446 * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
447 * the next most significant bit, and so on.
449 * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
450 * sense to use nxm_hasmask=1 because the action does not do any kind of
451 * matching; it uses the actual value of a field.)
453 * The following nxm_header values are potentially acceptable as 'src':
476 * - NXM_NX_ICMPV6_TYPE
477 * - NXM_NX_ICMPV6_CODE
480 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
482 * The following nxm_header values are potentially acceptable as 'dst':
493 * Modifying any of the above fields changes the corresponding packet
496 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
498 * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
499 * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
500 * header (if any), ignoring the other bits. Setting a value with CFI=1
501 * adds or modifies the 802.1Q header appropriately, setting the TCI field
502 * to the field's new value (with the CFI bit masked out).
504 * - NXM_NX_TUN_ID. Modifying this value modifies the tunnel ID used for the
505 * packet's next tunnel encapsulation.
507 * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
508 * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
509 * used only if the flow's nx_match includes an nxm_entry that specifies
510 * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
512 * The switch will reject actions for which src_ofs+n_bits is greater than the
513 * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
514 * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
516 * This action behaves properly when 'src' overlaps with 'dst', that is, it
517 * behaves as if 'src' were copied out to a temporary buffer, then the
518 * temporary buffer copied to 'dst'.
520 struct nx_action_reg_move {
521 ovs_be16 type; /* OFPAT_VENDOR. */
522 ovs_be16 len; /* Length is 24. */
523 ovs_be32 vendor; /* NX_VENDOR_ID. */
524 ovs_be16 subtype; /* NXAST_REG_MOVE. */
525 ovs_be16 n_bits; /* Number of bits. */
526 ovs_be16 src_ofs; /* Starting bit offset in source. */
527 ovs_be16 dst_ofs; /* Starting bit offset in destination. */
528 ovs_be32 src; /* Source register. */
529 ovs_be32 dst; /* Destination register. */
531 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
533 /* Action structure for NXAST_REG_LOAD.
535 * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
536 * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
537 * starts at 0 for the least-significant bit, 1 for the next most significant
540 * 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for
541 * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
544 * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
545 * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
546 * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
547 * also stored as one less than its true value:
550 * +------------------------------+------------------+
551 * | ofs | n_bits - 1 |
552 * +------------------------------+------------------+
554 * The switch will reject actions for which ofs+n_bits is greater than the
555 * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
556 * greater are set to 1, with error type OFPET_BAD_ACTION, code
557 * OFPBAC_BAD_ARGUMENT.
559 struct nx_action_reg_load {
560 ovs_be16 type; /* OFPAT_VENDOR. */
561 ovs_be16 len; /* Length is 24. */
562 ovs_be32 vendor; /* NX_VENDOR_ID. */
563 ovs_be16 subtype; /* NXAST_REG_LOAD. */
564 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
565 ovs_be32 dst; /* Destination register. */
566 ovs_be64 value; /* Immediate value. */
568 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
570 /* Action structure for NXAST_STACK_PUSH and NXAST_STACK_POP.
572 * Pushes (or pops) field[offset: offset + n_bits] to (or from)
575 struct nx_action_stack {
576 ovs_be16 type; /* OFPAT_VENDOR. */
577 ovs_be16 len; /* Length is 16. */
578 ovs_be32 vendor; /* NX_VENDOR_ID. */
579 ovs_be16 subtype; /* NXAST_STACK_PUSH or NXAST_STACK_POP. */
580 ovs_be16 offset; /* Bit offset into the field. */
581 ovs_be32 field; /* The field used for push or pop. */
582 ovs_be16 n_bits; /* (n_bits + 1) bits of the field. */
583 uint8_t zero[6]; /* Reserved, must be zero. */
585 OFP_ASSERT(sizeof(struct nx_action_stack) == 24);
587 /* Action structure for NXAST_NOTE.
589 * This action has no effect. It is variable length. The switch does not
590 * attempt to interpret the user-defined 'note' data in any way. A controller
591 * can use this action to attach arbitrary metadata to a flow.
593 * This action might go away in the future.
595 struct nx_action_note {
596 ovs_be16 type; /* OFPAT_VENDOR. */
597 ovs_be16 len; /* A multiple of 8, but at least 16. */
598 ovs_be32 vendor; /* NX_VENDOR_ID. */
599 ovs_be16 subtype; /* NXAST_NOTE. */
600 uint8_t note[6]; /* Start of user-defined data. */
601 /* Possibly followed by additional user-defined data. */
603 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
605 /* Action structure for NXAST_MULTIPATH.
607 * This action performs the following steps in sequence:
609 * 1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
610 * Refer to the definition of "enum nx_mp_fields" for details.
612 * The 'basis' value is used as a universal hash parameter, that is,
613 * different values of 'basis' yield different hash functions. The
614 * particular universal hash function used is implementation-defined.
616 * The hashed fields' values are drawn from the current state of the
617 * flow, including all modifications that have been made by actions up to
620 * 2. Applies the multipath link choice algorithm specified by 'algorithm',
621 * one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm"
624 * The output of the algorithm is 'link', an unsigned integer less than
625 * or equal to 'max_link'.
627 * Some algorithms use 'arg' as an additional argument.
629 * 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of
630 * 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
633 * The switch will reject actions that have an unknown 'fields', or an unknown
634 * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
635 * in which 'max_link' is greater than or equal to 2**n_bits, with error type
636 * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
638 struct nx_action_multipath {
639 ovs_be16 type; /* OFPAT_VENDOR. */
640 ovs_be16 len; /* Length is 32. */
641 ovs_be32 vendor; /* NX_VENDOR_ID. */
642 ovs_be16 subtype; /* NXAST_MULTIPATH. */
644 /* What fields to hash and how. */
645 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
646 ovs_be16 basis; /* Universal hash parameter. */
649 /* Multipath link choice algorithm to apply to hash value. */
650 ovs_be16 algorithm; /* One of NX_MP_ALG_*. */
651 ovs_be16 max_link; /* Number of output links, minus 1. */
652 ovs_be32 arg; /* Algorithm-specific argument. */
655 /* Where to store the result. */
656 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
657 ovs_be32 dst; /* Destination. */
659 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
661 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
663 * In the descriptions below, 'n_links' is max_link + 1. */
664 enum nx_mp_algorithm {
665 /* link = hash(flow) % n_links.
667 * Redistributes all traffic when n_links changes. O(1) performance. See
670 * Use UINT16_MAX for max_link to get a raw hash value. */
673 /* link = hash(flow) / (MAX_HASH / n_links).
675 * Redistributes between one-quarter and one-half of traffic when n_links
676 * changes. O(1) performance. See RFC 2992.
678 NX_MP_ALG_HASH_THRESHOLD,
680 /* for i in [0,n_links):
681 * weights[i] = hash(flow, i)
682 * link = { i such that weights[i] >= weights[j] for all j != i }
684 * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
685 * performance. If n_links is greater than a threshold (currently 64, but
686 * subject to change), Open vSwitch will substitute another algorithm
687 * automatically. See RFC 2992. */
688 NX_MP_ALG_HRW, /* Highest Random Weight. */
693 * link = hash(flow, i) % arg
694 * while link > max_link
696 * Redistributes 1/n_links of traffic when n_links changes. O(1)
697 * performance when arg/max_link is bounded by a constant.
699 * Redistributes all traffic when arg changes.
701 * arg must be greater than max_link and for best performance should be no
702 * more than approximately max_link * 2. If arg is outside the acceptable
703 * range, Open vSwitch will automatically substitute the least power of 2
704 * greater than max_link.
706 * This algorithm is specific to Open vSwitch.
708 NX_MP_ALG_ITER_HASH /* Iterative Hash. */
711 /* Action structure for NXAST_LEARN.
713 * This action adds or modifies a flow in an OpenFlow table, similar to
714 * OFPT_FLOW_MOD with OFPFC_MODIFY_STRICT as 'command'. The new flow has the
715 * specified idle timeout, hard timeout, priority, cookie, and flags. The new
716 * flow's match criteria and actions are built by applying each of the series
717 * of flow_mod_spec elements included as part of the action.
719 * A flow_mod_spec starts with a 16-bit header. A header that is all-bits-0 is
720 * a no-op used for padding the action as a whole to a multiple of 8 bytes in
721 * length. Otherwise, the flow_mod_spec can be thought of as copying 'n_bits'
722 * bits from a source to a destination. In this case, the header contains
725 * 15 14 13 12 11 10 0
726 * +------+---+------+---------------------------------+
727 * | 0 |src| dst | n_bits |
728 * +------+---+------+---------------------------------+
730 * The meaning and format of a flow_mod_spec depends on 'src' and 'dst'. The
731 * following table summarizes the meaning of each possible combination.
732 * Details follow the table:
735 * --- --- ----------------------------------------------------------
736 * 0 0 Add match criteria based on value in a field.
737 * 1 0 Add match criteria based on an immediate value.
738 * 0 1 Add NXAST_REG_LOAD action to copy field into a different field.
739 * 1 1 Add NXAST_REG_LOAD action to load immediate value into a field.
740 * 0 2 Add OFPAT_OUTPUT action to output to port from specified field.
741 * All other combinations are undefined and not allowed.
743 * The flow_mod_spec header is followed by a source specification and a
744 * destination specification. The format and meaning of the source
745 * specification depends on 'src':
747 * - If 'src' is 0, the source bits are taken from a field in the flow to
748 * which this action is attached. (This should be a wildcarded field. If
749 * its value is fully specified then the source bits being copied have
752 * The source specification is an ovs_be32 'field' and an ovs_be16 'ofs'.
753 * 'field' is an nxm_header with nxm_hasmask=0, and 'ofs' the starting bit
754 * offset within that field. The source bits are field[ofs:ofs+n_bits-1].
755 * 'field' and 'ofs' are subject to the same restrictions as the source
756 * field in NXAST_REG_MOVE.
758 * - If 'src' is 1, the source bits are a constant value. The source
759 * specification is (n_bits+15)/16*2 bytes long. Taking those bytes as a
760 * number in network order, the source bits are the 'n_bits'
761 * least-significant bits. The switch will report an error if other bits
762 * in the constant are nonzero.
764 * The flow_mod_spec destination specification, for 'dst' of 0 or 1, is an
765 * ovs_be32 'field' and an ovs_be16 'ofs'. 'field' is an nxm_header with
766 * nxm_hasmask=0 and 'ofs' is a starting bit offset within that field. The
767 * meaning of the flow_mod_spec depends on 'dst':
769 * - If 'dst' is 0, the flow_mod_spec specifies match criteria for the new
770 * flow. The new flow matches only if bits field[ofs:ofs+n_bits-1] in a
771 * packet equal the source bits. 'field' may be any nxm_header with
772 * nxm_hasmask=0 that is allowed in NXT_FLOW_MOD.
774 * Order is significant. Earlier flow_mod_specs must satisfy any
775 * prerequisites for matching fields specified later, by copying constant
776 * values into prerequisite fields.
778 * The switch will reject flow_mod_specs that do not satisfy NXM masking
781 * - If 'dst' is 1, the flow_mod_spec specifies an NXAST_REG_LOAD action for
782 * the new flow. The new flow copies the source bits into
783 * field[ofs:ofs+n_bits-1]. Actions are executed in the same order as the
786 * A single NXAST_REG_LOAD action writes no more than 64 bits, so n_bits
787 * greater than 64 yields multiple NXAST_REG_LOAD actions.
789 * The flow_mod_spec destination spec for 'dst' of 2 (when 'src' is 0) is
790 * empty. It has the following meaning:
792 * - The flow_mod_spec specifies an OFPAT_OUTPUT action for the new flow.
793 * The new flow outputs to the OpenFlow port specified by the source field.
794 * Of the special output ports with value OFPP_MAX or larger, OFPP_IN_PORT,
795 * OFPP_FLOOD, OFPP_LOCAL, and OFPP_ALL are supported. Other special ports
798 * Resource Management
799 * -------------------
801 * A switch has a finite amount of flow table space available for learning.
802 * When this space is exhausted, no new learning table entries will be learned
803 * until some existing flow table entries expire. The controller should be
804 * prepared to handle this by flooding (which can be implemented as a
805 * low-priority flow).
807 * If a learned flow matches a single TCP stream with a relatively long
808 * timeout, one may make the best of resource constraints by setting
809 * 'fin_idle_timeout' or 'fin_hard_timeout' (both measured in seconds), or
810 * both, to shorter timeouts. When either of these is specified as a nonzero
811 * value, OVS adds a NXAST_FIN_TIMEOUT action, with the specified timeouts, to
817 * The following examples give a prose description of the flow_mod_specs along
818 * with informal notation for how those would be represented and a hex dump of
819 * the bytes that would be required.
821 * These examples could work with various nx_action_learn parameters. Typical
822 * values would be idle_timeout=OFP_FLOW_PERMANENT, hard_timeout=60,
823 * priority=OFP_DEFAULT_PRIORITY, flags=0, table_id=10.
825 * 1. Learn input port based on the source MAC, with lookup into
826 * NXM_NX_REG1[16:31] by resubmit to in_port=99:
828 * Match on in_port=99:
829 * ovs_be16(src=1, dst=0, n_bits=16), 20 10
830 * ovs_be16(99), 00 63
831 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
833 * Match Ethernet destination on Ethernet source from packet:
834 * ovs_be16(src=0, dst=0, n_bits=48), 00 30
835 * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
836 * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
838 * Set NXM_NX_REG1[16:31] to the packet's input port:
839 * ovs_be16(src=0, dst=1, n_bits=16), 08 10
840 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
841 * ovs_be32(NXM_NX_REG1), ovs_be16(16) 00 01 02 04 00 10
843 * Given a packet that arrived on port A with Ethernet source address B,
844 * this would set up the flow "in_port=99, dl_dst=B,
845 * actions=load:A->NXM_NX_REG1[16..31]".
847 * In syntax accepted by ovs-ofctl, this action is: learn(in_port=99,
848 * NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
849 * load:NXM_OF_IN_PORT[]->NXM_NX_REG1[16..31])
851 * 2. Output to input port based on the source MAC and VLAN VID, with lookup
852 * into NXM_NX_REG1[16:31]:
854 * Match on same VLAN ID as packet:
855 * ovs_be16(src=0, dst=0, n_bits=12), 00 0c
856 * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
857 * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
859 * Match Ethernet destination on Ethernet source from packet:
860 * ovs_be16(src=0, dst=0, n_bits=48), 00 30
861 * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
862 * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
864 * Output to the packet's input port:
865 * ovs_be16(src=0, dst=2, n_bits=16), 10 10
866 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
868 * Given a packet that arrived on port A with Ethernet source address B in
869 * VLAN C, this would set up the flow "dl_dst=B, vlan_vid=C,
872 * In syntax accepted by ovs-ofctl, this action is:
873 * learn(NXM_OF_VLAN_TCI[0..11], NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
874 * output:NXM_OF_IN_PORT[])
876 * 3. Here's a recipe for a very simple-minded MAC learning switch. It uses a
877 * 10-second MAC expiration time to make it easier to see what's going on
879 * ovs-vsctl del-controller br0
880 * ovs-ofctl del-flows br0
881 * ovs-ofctl add-flow br0 "table=0 actions=learn(table=1, \
882 hard_timeout=10, NXM_OF_VLAN_TCI[0..11], \
883 NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[], \
884 output:NXM_OF_IN_PORT[]), resubmit(,1)"
885 * ovs-ofctl add-flow br0 "table=1 priority=0 actions=flood"
887 * You can then dump the MAC learning table with:
889 * ovs-ofctl dump-flows br0 table=1
894 * For best performance, segregate learned flows into a table that is not used
895 * for any other flows except possibly for a lowest-priority "catch-all" flow
896 * (a flow with no match criteria). If different learning actions specify
897 * different match criteria, use different tables for the learned flows.
899 * The meaning of 'hard_timeout' and 'idle_timeout' can be counterintuitive.
900 * These timeouts apply to the flow that is added, which means that a flow with
901 * an idle timeout will expire when no traffic has been sent *to* the learned
902 * address. This is not usually the intent in MAC learning; instead, we want
903 * the MAC learn entry to expire when no traffic has been sent *from* the
904 * learned address. Use a hard timeout for that.
906 struct nx_action_learn {
907 ovs_be16 type; /* OFPAT_VENDOR. */
908 ovs_be16 len; /* At least 24. */
909 ovs_be32 vendor; /* NX_VENDOR_ID. */
910 ovs_be16 subtype; /* NXAST_LEARN. */
911 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
912 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
913 ovs_be16 priority; /* Priority level of flow entry. */
914 ovs_be64 cookie; /* Cookie for new flow. */
915 ovs_be16 flags; /* Either 0 or OFPFF_SEND_FLOW_REM. */
916 uint8_t table_id; /* Table to insert flow entry. */
917 uint8_t pad; /* Must be zero. */
918 ovs_be16 fin_idle_timeout; /* Idle timeout after FIN, if nonzero. */
919 ovs_be16 fin_hard_timeout; /* Hard timeout after FIN, if nonzero. */
920 /* Followed by a sequence of flow_mod_spec elements, as described above,
921 * until the end of the action is reached. */
923 OFP_ASSERT(sizeof(struct nx_action_learn) == 32);
925 #define NX_LEARN_N_BITS_MASK 0x3ff
927 #define NX_LEARN_SRC_FIELD (0 << 13) /* Copy from field. */
928 #define NX_LEARN_SRC_IMMEDIATE (1 << 13) /* Copy from immediate value. */
929 #define NX_LEARN_SRC_MASK (1 << 13)
931 #define NX_LEARN_DST_MATCH (0 << 11) /* Add match criterion. */
932 #define NX_LEARN_DST_LOAD (1 << 11) /* Add NXAST_REG_LOAD action. */
933 #define NX_LEARN_DST_OUTPUT (2 << 11) /* Add OFPAT_OUTPUT action. */
934 #define NX_LEARN_DST_RESERVED (3 << 11) /* Not yet defined. */
935 #define NX_LEARN_DST_MASK (3 << 11)
937 /* Action structure for NXAST_FIN_TIMEOUT.
939 * This action changes the idle timeout or hard timeout, or both, of this
940 * OpenFlow rule when the rule matches a TCP packet with the FIN or RST flag.
941 * When such a packet is observed, the action reduces the rule's idle timeout
942 * to 'fin_idle_timeout' and its hard timeout to 'fin_hard_timeout'. This
943 * action has no effect on an existing timeout that is already shorter than the
944 * one that the action specifies. A 'fin_idle_timeout' or 'fin_hard_timeout'
945 * of zero has no effect on the respective timeout.
947 * 'fin_idle_timeout' and 'fin_hard_timeout' are measured in seconds.
948 * 'fin_hard_timeout' specifies time since the flow's creation, not since the
949 * receipt of the FIN or RST.
951 * This is useful for quickly discarding learned TCP flows that otherwise will
952 * take a long time to expire.
954 * This action is intended for use with an OpenFlow rule that matches only a
955 * single TCP flow. If the rule matches multiple TCP flows (e.g. it wildcards
956 * all TCP traffic, or all TCP traffic to a particular port), then any FIN or
957 * RST in any of those flows will cause the entire OpenFlow rule to expire
958 * early, which is not normally desirable.
960 struct nx_action_fin_timeout {
961 ovs_be16 type; /* OFPAT_VENDOR. */
962 ovs_be16 len; /* 16. */
963 ovs_be32 vendor; /* NX_VENDOR_ID. */
964 ovs_be16 subtype; /* NXAST_FIN_TIMEOUT. */
965 ovs_be16 fin_idle_timeout; /* New idle timeout, if nonzero. */
966 ovs_be16 fin_hard_timeout; /* New hard timeout, if nonzero. */
967 ovs_be16 pad; /* Must be zero. */
969 OFP_ASSERT(sizeof(struct nx_action_fin_timeout) == 16);
971 /* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD.
973 * The bundle actions choose a slave from a supplied list of options.
974 * NXAST_BUNDLE outputs to its selection. NXAST_BUNDLE_LOAD writes its
975 * selection to a register.
977 * The list of possible slaves follows the nx_action_bundle structure. The size
978 * of each slave is governed by its type as indicated by the 'slave_type'
979 * parameter. The list of slaves should be padded at its end with zeros to make
980 * the total length of the action a multiple of 8.
982 * Switches infer from the 'slave_type' parameter the size of each slave. All
983 * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
984 * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
985 * 2 byte width. Switches should reject actions which indicate unknown or
986 * unsupported slave types.
988 * Switches use a strategy dictated by the 'algorithm' parameter to choose a
989 * slave. If the switch does not support the specified 'algorithm' parameter,
990 * it should reject the action.
992 * Several algorithms take into account liveness when selecting slaves. The
993 * liveness of a slave is implementation defined (with one exception), but will
994 * generally take into account things like its carrier status and the results
995 * of any link monitoring protocols which happen to be running on it. In order
996 * to give controllers a place-holder value, the OFPP_NONE port is always
999 * Some slave selection strategies require the use of a hash function, in which
1000 * case the 'fields' and 'basis' parameters should be populated. The 'fields'
1001 * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
1002 * hash. Refer to the definition of "enum nx_hash_fields" for details. The
1003 * 'basis' parameter is used as a universal hash parameter. Different values
1004 * of 'basis' yield different hash results.
1006 * The 'zero' parameter at the end of the action structure is reserved for
1007 * future use. Switches are required to reject actions which have nonzero
1008 * bytes in the 'zero' field.
1010 * NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed. Switches
1011 * should reject actions which have nonzero bytes in either of these fields.
1013 * NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in
1014 * dst[ofs:ofs+n_bits]. The format and semantics of 'dst' and 'ofs_nbits' are
1015 * similar to those for the NXAST_REG_LOAD action. */
1016 struct nx_action_bundle {
1017 ovs_be16 type; /* OFPAT_VENDOR. */
1018 ovs_be16 len; /* Length including slaves. */
1019 ovs_be32 vendor; /* NX_VENDOR_ID. */
1020 ovs_be16 subtype; /* NXAST_BUNDLE or NXAST_BUNDLE_LOAD. */
1022 /* Slave choice algorithm to apply to hash value. */
1023 ovs_be16 algorithm; /* One of NX_BD_ALG_*. */
1025 /* What fields to hash and how. */
1026 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
1027 ovs_be16 basis; /* Universal hash parameter. */
1029 ovs_be32 slave_type; /* NXM_OF_IN_PORT. */
1030 ovs_be16 n_slaves; /* Number of slaves. */
1032 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
1033 ovs_be32 dst; /* Destination. */
1035 uint8_t zero[4]; /* Reserved. Must be zero. */
1037 OFP_ASSERT(sizeof(struct nx_action_bundle) == 32);
1039 /* NXAST_BUNDLE: Bundle slave choice algorithm to apply.
1041 * In the descriptions below, 'slaves' is the list of possible slaves in the
1042 * order they appear in the OpenFlow action. */
1043 enum nx_bd_algorithm {
1044 /* Chooses the first live slave listed in the bundle.
1046 * O(n_slaves) performance. */
1047 NX_BD_ALG_ACTIVE_BACKUP,
1049 /* for i in [0,n_slaves):
1050 * weights[i] = hash(flow, i)
1051 * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
1053 * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
1054 * O(n_slaves) performance.
1056 * Uses the 'fields' and 'basis' parameters. */
1057 NX_BD_ALG_HRW /* Highest Random Weight. */
1061 /* Action structure for NXAST_DEC_TTL_CNT_IDS.
1063 * If the packet is not IPv4 or IPv6, does nothing. For IPv4 or IPv6, if the
1064 * TTL or hop limit is at least 2, decrements it by 1. Otherwise, if TTL or
1065 * hop limit is 0 or 1, sends a packet-in to the controllers with each of the
1066 * 'n_controllers' controller IDs specified in 'cnt_ids'.
1068 * (This differs from NXAST_DEC_TTL in that for NXAST_DEC_TTL the packet-in is
1069 * sent only to controllers with id 0.)
1071 struct nx_action_cnt_ids {
1072 ovs_be16 type; /* OFPAT_VENDOR. */
1073 ovs_be16 len; /* Length including slaves. */
1074 ovs_be32 vendor; /* NX_VENDOR_ID. */
1075 ovs_be16 subtype; /* NXAST_DEC_TTL_CNT_IDS. */
1077 ovs_be16 n_controllers; /* Number of controllers. */
1078 uint8_t zeros[4]; /* Must be zero. */
1080 /* Followed by 1 or more controller ids.
1082 * uint16_t cnt_ids[]; // Controller ids.
1083 * uint8_t pad[]; // Must be 0 to 8-byte align cnt_ids[].
1086 OFP_ASSERT(sizeof(struct nx_action_cnt_ids) == 16);
1089 /* Action structure for NXAST_OUTPUT_REG.
1091 * Outputs to the OpenFlow port number written to src[ofs:ofs+nbits].
1093 * The format and semantics of 'src' and 'ofs_nbits' are similar to those for
1094 * the NXAST_REG_LOAD action.
1096 * The acceptable nxm_header values for 'src' are the same as the acceptable
1097 * nxm_header values for the 'src' field of NXAST_REG_MOVE.
1099 * The 'max_len' field indicates the number of bytes to send when the chosen
1100 * port is OFPP_CONTROLLER. Its semantics are equivalent to the 'max_len'
1101 * field of OFPAT_OUTPUT.
1103 * The 'zero' field is required to be zeroed for forward compatibility. */
1104 struct nx_action_output_reg {
1105 ovs_be16 type; /* OFPAT_VENDOR. */
1106 ovs_be16 len; /* 24. */
1107 ovs_be32 vendor; /* NX_VENDOR_ID. */
1108 ovs_be16 subtype; /* NXAST_OUTPUT_REG. */
1110 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
1111 ovs_be32 src; /* Source. */
1113 ovs_be16 max_len; /* Max length to send to controller. */
1115 uint8_t zero[6]; /* Reserved, must be zero. */
1117 OFP_ASSERT(sizeof(struct nx_action_output_reg) == 24);
1121 * Discontinues action processing.
1123 * The NXAST_EXIT action causes the switch to immediately halt processing
1124 * actions for the flow. Any actions which have already been processed are
1125 * executed by the switch. However, any further actions, including those which
1126 * may be in different tables, or different levels of the NXAST_RESUBMIT
1127 * hierarchy, will be ignored.
1129 * Uses the nx_action_header structure. */
1131 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
1133 * OpenFlow 1.0 has "struct ofp10_match" for specifying flow matches. This
1134 * structure is fixed-length and hence difficult to extend. This section
1135 * describes a more flexible, variable-length flow match, called "nx_match" for
1136 * short, that is also supported by Open vSwitch. This section also defines a
1137 * replacement for each OpenFlow message that includes struct ofp10_match.
1143 * An nx_match is a sequence of zero or more "nxm_entry"s, which are
1144 * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
1145 * "nxm_entry"s are not aligned on or padded to any multibyte boundary. The
1146 * first 4 bytes of an nxm_entry are its "header", followed by the entry's
1149 * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
1151 * |<-------------------- nxm_type ------------------>|
1153 * |31 16 15 9| 8 7 0
1154 * +----------------------------------+---------------+--+------------------+
1155 * | nxm_vendor | nxm_field |hm| nxm_length |
1156 * +----------------------------------+---------------+--+------------------+
1158 * The most-significant 23 bits of the header are collectively "nxm_type".
1159 * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
1160 * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
1161 * designates a protocol header, such as the Ethernet type, but it can also
1162 * refer to packet metadata, such as the switch port on which a packet arrived.
1164 * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
1165 * of this bit is explained later.
1167 * The least-significant 8 bits are "nxm_length", a positive integer. The
1168 * length of the nxm_entry, including the header, is exactly 4 + nxm_length
1171 * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
1172 * constant. It is included only to allow software to minimally parse
1173 * "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor,
1174 * nxm_field, and nxm_length, nxm_hasmask is a constant.)
1180 * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
1182 * An nxm_entry places a constraint on the packets matched by the nx_match:
1184 * - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
1185 * field, called "nxm_value". The nx_match matches only packets in which
1186 * the field equals nxm_value.
1188 * - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
1189 * field (nxm_value), followed by a bitmask of the same length as the
1190 * value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
1191 * nx_match matches only packets for which bit J in the given field's value
1192 * matches bit J in nxm_value. A 0-bit in nxm_mask causes the
1193 * corresponding bit in nxm_value is ignored (it should be 0; Open vSwitch
1194 * may enforce this someday), as is the corresponding bit in the field's
1195 * value. (The sense of the nxm_mask bits is the opposite of that used by
1196 * the "wildcards" member of struct ofp10_match.)
1198 * When nxm_hasmask is 1, nxm_length is always even.
1200 * An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
1201 * entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for
1204 * When there are multiple "nxm_entry"s, all of the constraints must be met.
1210 * Masks may be restricted:
1212 * - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
1213 * must always be 0 when these fields are specified. For example, the
1214 * field that identifies the port on which a packet was received may not be
1217 * - Some nxm_types that do support masked wildcards may only support certain
1218 * nxm_mask patterns. For example, fields that have IPv4 address values
1219 * may be restricted to CIDR masks.
1221 * These restrictions should be noted in specifications for individual fields.
1222 * A switch may accept an nxm_hasmask or nxm_mask value that the specification
1223 * disallows, if the switch correctly implements support for that nxm_hasmask
1224 * or nxm_mask value. A switch must reject an attempt to set up a flow that
1225 * contains a nxm_hasmask or nxm_mask value that it does not support.
1228 * Prerequisite Restrictions
1229 * =========================
1231 * The presence of an nxm_entry with a given nxm_type may be restricted based
1232 * on the presence of or values of other "nxm_entry"s. For example:
1234 * - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
1235 * preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
1236 * and nxm_value=0x0800. That is, matching on the IP source address is
1237 * allowed only if the Ethernet type is explicitly set to IP.
1239 * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is
1240 * preceded by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and
1241 * nxm_value either 0x0800 or 0x86dd, and another with
1242 * nxm_type=NXM_OF_IP_PROTO, nxm_hasmask=0, nxm_value=6, in that order.
1243 * That is, matching on the TCP source port is allowed only if the Ethernet
1244 * type is IP or IPv6 and the IP protocol is TCP.
1246 * These restrictions should be noted in specifications for individual fields.
1247 * A switch may implement relaxed versions of these restrictions. A switch
1248 * must reject an attempt to set up a flow that violates its restrictions.
1251 * Ordering Restrictions
1252 * =====================
1254 * An nxm_entry that has prerequisite restrictions must appear after the
1255 * "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an
1256 * nx_match is not otherwise constrained.
1258 * Any given nxm_type may appear in an nx_match at most once.
1261 * nxm_entry Examples
1262 * ==================
1264 * These examples show the format of a single nxm_entry with particular
1265 * nxm_hasmask and nxm_length values. The diagrams are labeled with field
1266 * numbers and byte indexes.
1269 * 8-bit nxm_value, nxm_hasmask=1, nxm_length=2:
1272 * +------------+---+---+
1273 * | header | v | m |
1274 * +------------+---+---+
1277 * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
1280 * +------------+------+
1282 * +------------+------+
1285 * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
1288 * +------------+-------------+
1289 * | header | nxm_value |
1290 * +------------+-------------+
1293 * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
1296 * +------------+------------------+
1297 * | header | nxm_value |
1298 * +------------+------------------+
1301 * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
1304 * +------------+------------------+------------------+
1305 * | header | nxm_value | nxm_mask |
1306 * +------------+------------------+------------------+
1312 * A switch should report an error in an nx_match using error type
1313 * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch
1314 * should report a specific error code, if one is assigned for the particular
1315 * problem, but NXBRC_NXM_INVALID is also available to report a generic
1319 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
1320 (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
1321 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
1322 NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
1323 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
1324 NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
1325 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
1326 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
1327 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
1328 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
1329 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
1331 #define NXM_MAKE_WILD_HEADER(HEADER) \
1332 NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
1334 /* ## ------------------------------- ## */
1335 /* ## OpenFlow 1.0-compatible fields. ## */
1336 /* ## ------------------------------- ## */
1338 /* Physical or virtual port on which the packet was received.
1342 * Format: 16-bit integer in network byte order.
1344 * Masking: Not maskable. */
1345 #define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
1347 /* Source or destination address in Ethernet header.
1351 * Format: 48-bit Ethernet MAC address.
1353 * Masking: Fully maskable, in versions 1.8 and later. Earlier versions only
1354 * supported the following masks for NXM_OF_ETH_DST_W: 00:00:00:00:00:00,
1355 * fe:ff:ff:ff:ff:ff, 01:00:00:00:00:00, ff:ff:ff:ff:ff:ff. */
1356 #define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
1357 #define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
1358 #define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
1359 #define NXM_OF_ETH_SRC_W NXM_HEADER_W(0x0000, 2, 6)
1361 /* Packet's Ethernet type.
1363 * For an Ethernet II packet this is taken from the Ethernet header. For an
1364 * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
1365 * A packet that has neither format has value 0x05ff
1366 * (OFP_DL_TYPE_NOT_ETH_TYPE).
1368 * For a packet with an 802.1Q header, this is the type of the encapsulated
1373 * Format: 16-bit integer in network byte order.
1375 * Masking: Not maskable. */
1376 #define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
1380 * For a packet with an 802.1Q header, this is the Tag Control Information
1381 * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
1382 * header, this has value 0.
1386 * Format: 16-bit integer in network byte order.
1388 * Masking: Arbitrary masks.
1390 * This field can be used in various ways:
1392 * - If it is not constrained at all, the nx_match matches packets without
1393 * an 802.1Q header or with an 802.1Q header that has any TCI value.
1395 * - Testing for an exact match with 0 matches only packets without an
1398 * - Testing for an exact match with a TCI value with CFI=1 matches packets
1399 * that have an 802.1Q header with a specified VID and PCP.
1401 * - Testing for an exact match with a nonzero TCI value with CFI=0 does
1402 * not make sense. The switch may reject this combination.
1404 * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
1405 * packets that have an 802.1Q header with that VID (and any PCP).
1407 * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
1408 * packets that have an 802.1Q header with that PCP (and any VID).
1410 * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
1411 * header or with an 802.1Q header with a VID of 0.
1413 * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
1414 * header or with an 802.1Q header with a PCP of 0.
1416 * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
1417 * header or with an 802.1Q header with both VID and PCP of 0.
1419 #define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
1420 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
1422 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
1424 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1426 * Format: 8-bit integer with 2 least-significant bits forced to 0.
1428 * Masking: Not maskable. */
1429 #define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
1431 /* The "protocol" byte in the IP header.
1433 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1435 * Format: 8-bit integer.
1437 * Masking: Not maskable. */
1438 #define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
1440 /* The source or destination address in the IP header.
1442 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
1444 * Format: 32-bit integer in network byte order.
1446 * Masking: Fully maskable, in Open vSwitch 1.8 and later. In earlier
1447 * versions, only CIDR masks are allowed, that is, masks that consist of N
1448 * high-order bits set to 1 and the other 32-N bits set to 0. */
1449 #define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
1450 #define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
1451 #define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
1452 #define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
1454 /* The source or destination port in the TCP header.
1457 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1458 * NXM_OF_IP_PROTO must match 6 exactly.
1460 * Format: 16-bit integer in network byte order.
1462 * Masking: Fully maskable, in Open vSwitch 1.6 and later. Not maskable, in
1463 * earlier versions. */
1464 #define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
1465 #define NXM_OF_TCP_SRC_W NXM_HEADER_W(0x0000, 9, 2)
1466 #define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
1467 #define NXM_OF_TCP_DST_W NXM_HEADER_W(0x0000, 10, 2)
1469 /* The source or destination port in the UDP header.
1472 * NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1473 * NXM_OF_IP_PROTO must match 17 exactly.
1475 * Format: 16-bit integer in network byte order.
1477 * Masking: Fully maskable, in Open vSwitch 1.6 and later. Not maskable, in
1478 * earlier versions. */
1479 #define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
1480 #define NXM_OF_UDP_SRC_W NXM_HEADER_W(0x0000, 11, 2)
1481 #define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
1482 #define NXM_OF_UDP_DST_W NXM_HEADER_W(0x0000, 12, 2)
1484 /* The type or code in the ICMP header.
1487 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
1488 * NXM_OF_IP_PROTO must match 1 exactly.
1490 * Format: 8-bit integer.
1492 * Masking: Not maskable. */
1493 #define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
1494 #define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
1498 * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
1499 * otherwise. Only ARP opcodes between 1 and 255 should be specified for
1502 * Prereqs: NXM_OF_ETH_TYPE must match either 0x0806 or 0x8035.
1504 * Format: 16-bit integer in network byte order.
1506 * Masking: Not maskable. */
1507 #define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
1509 /* For an Ethernet+IP ARP packet, the source or target protocol address
1510 * in the ARP header. Always 0 otherwise.
1512 * Prereqs: NXM_OF_ETH_TYPE must match either 0x0806 or 0x8035.
1514 * Format: 32-bit integer in network byte order.
1516 * Masking: Fully maskable, in Open vSwitch 1.8 and later. In earlier
1517 * versions, only CIDR masks are allowed, that is, masks that consist of N
1518 * high-order bits set to 1 and the other 32-N bits set to 0. */
1519 #define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
1520 #define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
1521 #define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
1522 #define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
1524 /* ## ------------------------ ## */
1525 /* ## Nicira match extensions. ## */
1526 /* ## ------------------------ ## */
1528 /* Metadata registers.
1530 * Registers initially have value 0. Actions allow register values to be
1535 * Format: Array of 32-bit integer registers. Space is reserved for up to
1536 * NXM_NX_MAX_REGS registers, but switches may implement fewer.
1538 * Masking: Arbitrary masks. */
1539 #define NXM_NX_MAX_REGS 16
1540 #define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
1541 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1542 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1543 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1544 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1545 #define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
1546 #define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
1547 #define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
1548 #define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
1549 #define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
1550 #define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
1551 #define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
1552 #define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
1553 #define NXM_NX_REG4 NXM_HEADER (0x0001, 4, 4)
1554 #define NXM_NX_REG4_W NXM_HEADER_W(0x0001, 4, 4)
1555 #define NXM_NX_REG5 NXM_HEADER (0x0001, 5, 4)
1556 #define NXM_NX_REG5_W NXM_HEADER_W(0x0001, 5, 4)
1557 #define NXM_NX_REG6 NXM_HEADER (0x0001, 6, 4)
1558 #define NXM_NX_REG6_W NXM_HEADER_W(0x0001, 6, 4)
1559 #define NXM_NX_REG7 NXM_HEADER (0x0001, 7, 4)
1560 #define NXM_NX_REG7_W NXM_HEADER_W(0x0001, 7, 4)
1564 * For a packet received via a GRE, VXLAN or LISP tunnel including a (32-bit)
1565 * key, the key is stored in the low 32-bits and the high bits are zeroed. For
1566 * other packets, the value is 0.
1568 * All zero bits, for packets not received via a keyed tunnel.
1572 * Format: 64-bit integer in network byte order.
1574 * Masking: Arbitrary masks. */
1575 #define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
1576 #define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
1578 /* For an Ethernet+IP ARP packet, the source or target hardware address
1579 * in the ARP header. Always 0 otherwise.
1581 * Prereqs: NXM_OF_ETH_TYPE must match either 0x0806 or 0x8035.
1583 * Format: 48-bit Ethernet MAC address.
1585 * Masking: Not maskable. */
1586 #define NXM_NX_ARP_SHA NXM_HEADER (0x0001, 17, 6)
1587 #define NXM_NX_ARP_THA NXM_HEADER (0x0001, 18, 6)
1589 /* The source or destination address in the IPv6 header.
1591 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1593 * Format: 128-bit IPv6 address.
1595 * Masking: Fully maskable, in Open vSwitch 1.8 and later. In previous
1596 * versions, only CIDR masks are allowed, that is, masks that consist of N
1597 * high-order bits set to 1 and the other 128-N bits set to 0. */
1598 #define NXM_NX_IPV6_SRC NXM_HEADER (0x0001, 19, 16)
1599 #define NXM_NX_IPV6_SRC_W NXM_HEADER_W(0x0001, 19, 16)
1600 #define NXM_NX_IPV6_DST NXM_HEADER (0x0001, 20, 16)
1601 #define NXM_NX_IPV6_DST_W NXM_HEADER_W(0x0001, 20, 16)
1603 /* The type or code in the ICMPv6 header.
1606 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1607 * NXM_OF_IP_PROTO must match 58 exactly.
1609 * Format: 8-bit integer.
1611 * Masking: Not maskable. */
1612 #define NXM_NX_ICMPV6_TYPE NXM_HEADER (0x0001, 21, 1)
1613 #define NXM_NX_ICMPV6_CODE NXM_HEADER (0x0001, 22, 1)
1615 /* The target address in an IPv6 Neighbor Discovery message.
1618 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1619 * NXM_OF_IP_PROTO must match 58 exactly.
1620 * NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1622 * Format: 128-bit IPv6 address.
1624 * Masking: Fully maskable, in Open vSwitch 1.8 and later. In previous
1625 * versions, only CIDR masks are allowed, that is, masks that consist of N
1626 * high-order bits set to 1 and the other 128-N bits set to 0. */
1627 #define NXM_NX_ND_TARGET NXM_HEADER (0x0001, 23, 16)
1628 #define NXM_NX_ND_TARGET_W NXM_HEADER_W (0x0001, 23, 16)
1630 /* The source link-layer address option in an IPv6 Neighbor Discovery
1634 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1635 * NXM_OF_IP_PROTO must match 58 exactly.
1636 * NXM_OF_ICMPV6_TYPE must be exactly 135.
1638 * Format: 48-bit Ethernet MAC address.
1640 * Masking: Not maskable. */
1641 #define NXM_NX_ND_SLL NXM_HEADER (0x0001, 24, 6)
1643 /* The target link-layer address option in an IPv6 Neighbor Discovery
1647 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1648 * NXM_OF_IP_PROTO must match 58 exactly.
1649 * NXM_OF_ICMPV6_TYPE must be exactly 136.
1651 * Format: 48-bit Ethernet MAC address.
1653 * Masking: Not maskable. */
1654 #define NXM_NX_ND_TLL NXM_HEADER (0x0001, 25, 6)
1656 /* IP fragment information.
1659 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1661 * Format: 8-bit value with one of the values 0, 1, or 3, as described below.
1663 * Masking: Fully maskable.
1665 * This field has three possible values:
1667 * - A packet that is not an IP fragment has value 0.
1669 * - A packet that is an IP fragment with offset 0 (the first fragment) has
1670 * bit 0 set and thus value 1.
1672 * - A packet that is an IP fragment with nonzero offset has bits 0 and 1 set
1675 * NX_IP_FRAG_ANY and NX_IP_FRAG_LATER are declared to symbolically represent
1676 * the meanings of bits 0 and 1.
1678 * The switch may reject matches against values that can never appear.
1680 * It is important to understand how this field interacts with the OpenFlow IP
1681 * fragment handling mode:
1683 * - In OFPC_FRAG_DROP mode, the OpenFlow switch drops all IP fragments
1684 * before they reach the flow table, so every packet that is available for
1685 * matching will have value 0 in this field.
1687 * - Open vSwitch does not implement OFPC_FRAG_REASM mode, but if it did then
1688 * IP fragments would be reassembled before they reached the flow table and
1689 * again every packet available for matching would always have value 0.
1691 * - In OFPC_FRAG_NORMAL mode, all three values are possible, but OpenFlow
1692 * 1.0 says that fragments' transport ports are always 0, even for the
1693 * first fragment, so this does not provide much extra information.
1695 * - In OFPC_FRAG_NX_MATCH mode, all three values are possible. For
1696 * fragments with offset 0, Open vSwitch makes L4 header information
1699 #define NXM_NX_IP_FRAG NXM_HEADER (0x0001, 26, 1)
1700 #define NXM_NX_IP_FRAG_W NXM_HEADER_W(0x0001, 26, 1)
1702 /* Bits in the value of NXM_NX_IP_FRAG. */
1703 #define NX_IP_FRAG_ANY (1 << 0) /* Is this a fragment? */
1704 #define NX_IP_FRAG_LATER (1 << 1) /* Is this a fragment with nonzero offset? */
1706 /* The flow label in the IPv6 header.
1708 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1710 * Format: 20-bit IPv6 flow label in least-significant bits.
1712 * Masking: Not maskable. */
1713 #define NXM_NX_IPV6_LABEL NXM_HEADER (0x0001, 27, 4)
1715 /* The ECN of the IP header.
1717 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1719 * Format: ECN in the low-order 2 bits.
1721 * Masking: Not maskable. */
1722 #define NXM_NX_IP_ECN NXM_HEADER (0x0001, 28, 1)
1724 /* The time-to-live/hop limit of the IP header.
1726 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1728 * Format: 8-bit integer.
1730 * Masking: Not maskable. */
1731 #define NXM_NX_IP_TTL NXM_HEADER (0x0001, 29, 1)
1735 * This may be used to gain the OpenFlow 1.1-like ability to restrict
1736 * certain NXM-based Flow Mod and Flow Stats Request messages to flows
1737 * with specific cookies. See the "nx_flow_mod" and "nx_flow_stats_request"
1738 * structure definitions for more details. This match is otherwise not
1743 * Format: 64-bit integer in network byte order.
1745 * Masking: Arbitrary masks. */
1746 #define NXM_NX_COOKIE NXM_HEADER (0x0001, 30, 8)
1747 #define NXM_NX_COOKIE_W NXM_HEADER_W(0x0001, 30, 8)
1749 /* ## --------------------- ## */
1750 /* ## Requests and replies. ## */
1751 /* ## --------------------- ## */
1753 enum nx_flow_format {
1754 NXFF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
1755 NXFF_NXM = 2 /* Nicira extended match. */
1758 /* NXT_SET_FLOW_FORMAT request. */
1759 struct nx_set_flow_format {
1760 ovs_be32 format; /* One of NXFF_*. */
1762 OFP_ASSERT(sizeof(struct nx_set_flow_format) == 4);
1764 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD).
1766 * It is possible to limit flow deletions and modifications to certain
1767 * cookies by using the NXM_NX_COOKIE(_W) matches. The "cookie" field
1768 * is used only to add or modify flow cookies.
1770 struct nx_flow_mod {
1771 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1772 ovs_be16 command; /* OFPFC_* + possibly a table ID (see comment
1773 * on struct nx_flow_mod_table_id). */
1774 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
1775 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
1776 ovs_be16 priority; /* Priority level of flow entry. */
1777 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
1778 Not meaningful for OFPFC_DELETE*. */
1779 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
1780 matching entries to include this as an
1781 output port. A value of OFPP_NONE
1782 indicates no restriction. */
1783 ovs_be16 flags; /* One of OFPFF_*. */
1784 ovs_be16 match_len; /* Size of nx_match. */
1785 uint8_t pad[6]; /* Align to 64-bits. */
1787 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1788 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1789 * all-zero bytes, then
1790 * - Actions to fill out the remainder of the message length (always a
1794 OFP_ASSERT(sizeof(struct nx_flow_mod) == 32);
1796 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED).
1798 * 'table_id' is present only in Open vSwitch 1.11 and later. In earlier
1799 * versions of Open vSwitch, this is a padding byte that is always zeroed.
1800 * Therefore, a 'table_id' value of 0 indicates that the table ID is not known,
1801 * and other values may be interpreted as one more than the flow's former table
1803 struct nx_flow_removed {
1804 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1805 ovs_be16 priority; /* Priority level of flow entry. */
1806 uint8_t reason; /* One of OFPRR_*. */
1807 uint8_t table_id; /* Flow's former table ID, plus one. */
1808 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
1809 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
1811 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
1812 ovs_be16 match_len; /* Size of nx_match. */
1813 ovs_be64 packet_count;
1814 ovs_be64 byte_count;
1816 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1817 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1818 * all-zero bytes. */
1820 OFP_ASSERT(sizeof(struct nx_flow_removed) == 40);
1822 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1825 * It is possible to limit matches to certain cookies by using the
1826 * NXM_NX_COOKIE and NXM_NX_COOKIE_W matches.
1828 struct nx_flow_stats_request {
1829 ovs_be16 out_port; /* Require matching entries to include this
1830 as an output port. A value of OFPP_NONE
1831 indicates no restriction. */
1832 ovs_be16 match_len; /* Length of nx_match. */
1833 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1834 or 0xff for all tables. */
1835 uint8_t pad[3]; /* Align to 64 bits. */
1837 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1838 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1839 * all-zero bytes, which must also exactly fill out the length of the
1843 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 8);
1845 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1846 * OFPST_FLOW reply).
1848 * The values of 'idle_age' and 'hard_age' are only meaningful when talking to
1849 * a switch that implements the NXT_FLOW_AGE extension. Zero means that the
1850 * true value is unknown, perhaps because hardware does not track the value.
1851 * (Zero is also the value that one should ordinarily expect to see talking to
1852 * a switch that does not implement NXT_FLOW_AGE, since those switches zero the
1853 * padding bytes that these fields replaced.) A nonzero value X represents X-1
1854 * seconds. A value of 65535 represents 65534 or more seconds.
1856 * 'idle_age' is the number of seconds that the flow has been idle, that is,
1857 * the number of seconds since a packet passed through the flow. 'hard_age' is
1858 * the number of seconds since the flow was last modified (e.g. OFPFC_MODIFY or
1859 * OFPFC_MODIFY_STRICT). (The 'duration_*' fields are the elapsed time since
1860 * the flow was added, regardless of subsequent modifications.)
1862 * For a flow with an idle or hard timeout, 'idle_age' or 'hard_age',
1863 * respectively, will ordinarily be smaller than the timeout, but flow
1864 * expiration times are only approximate and so one must be prepared to
1865 * tolerate expirations that occur somewhat early or late.
1867 struct nx_flow_stats {
1868 ovs_be16 length; /* Length of this entry. */
1869 uint8_t table_id; /* ID of table flow came from. */
1871 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
1872 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
1873 beyond duration_sec. */
1874 ovs_be16 priority; /* Priority of the entry. */
1875 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
1876 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
1877 ovs_be16 match_len; /* Length of nx_match. */
1878 ovs_be16 idle_age; /* Seconds since last packet, plus one. */
1879 ovs_be16 hard_age; /* Seconds since last modification, plus one. */
1880 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1881 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1882 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1884 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1885 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1886 * all-zero bytes, then
1887 * - Actions to fill out the remainder 'length' bytes (always a multiple
1891 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1893 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1894 * OFPST_AGGREGATE request).
1896 * The reply format is identical to the reply format for OFPST_AGGREGATE,
1897 * except for the header. */
1898 struct nx_aggregate_stats_request {
1899 ovs_be16 out_port; /* Require matching entries to include this
1900 as an output port. A value of OFPP_NONE
1901 indicates no restriction. */
1902 ovs_be16 match_len; /* Length of nx_match. */
1903 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1904 or 0xff for all tables. */
1905 uint8_t pad[3]; /* Align to 64 bits. */
1907 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1908 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1909 * all-zero bytes, which must also exactly fill out the length of the
1913 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 8);
1915 /* NXT_SET_CONTROLLER_ID.
1917 * Each OpenFlow controller connection has a 16-bit identifier that is
1918 * initially 0. This message changes the connection's ID to 'id'.
1920 * Controller connection IDs need not be unique.
1922 * The NXAST_CONTROLLER action is the only current user of controller
1923 * connection IDs. */
1924 struct nx_controller_id {
1925 uint8_t zero[6]; /* Must be zero. */
1926 ovs_be16 controller_id; /* New controller connection ID. */
1928 OFP_ASSERT(sizeof(struct nx_controller_id) == 8);
1930 /* Action structure for NXAST_CONTROLLER.
1932 * This generalizes using OFPAT_OUTPUT to send a packet to OFPP_CONTROLLER. In
1933 * addition to the 'max_len' that OFPAT_OUTPUT supports, it also allows
1936 * - 'reason': The reason code to use in the ofp_packet_in or nx_packet_in.
1938 * - 'controller_id': The ID of the controller connection to which the
1939 * ofp_packet_in should be sent. The ofp_packet_in or nx_packet_in is
1940 * sent only to controllers that have the specified controller connection
1941 * ID. See "struct nx_controller_id" for more information. */
1942 struct nx_action_controller {
1943 ovs_be16 type; /* OFPAT_VENDOR. */
1944 ovs_be16 len; /* Length is 16. */
1945 ovs_be32 vendor; /* NX_VENDOR_ID. */
1946 ovs_be16 subtype; /* NXAST_CONTROLLER. */
1947 ovs_be16 max_len; /* Maximum length to send to controller. */
1948 ovs_be16 controller_id; /* Controller ID to send packet-in. */
1949 uint8_t reason; /* enum ofp_packet_in_reason (OFPR_*). */
1950 uint8_t zero; /* Must be zero. */
1952 OFP_ASSERT(sizeof(struct nx_action_controller) == 16);
1954 /* Flow Table Monitoring
1955 * =====================
1957 * NXST_FLOW_MONITOR allows a controller to keep track of changes to OpenFlow
1958 * flow table(s) or subsets of them, with the following workflow:
1960 * 1. The controller sends an NXST_FLOW_MONITOR request to begin monitoring
1961 * flows. The 'id' in the request must be unique among all monitors that
1962 * the controller has started and not yet canceled on this OpenFlow
1965 * 2. The switch responds with an NXST_FLOW_MONITOR reply. If the request's
1966 * 'flags' included NXFMF_INITIAL, the reply includes all the flows that
1967 * matched the request at the time of the request (with event NXFME_ADDED).
1968 * If 'flags' did not include NXFMF_INITIAL, the reply is empty.
1970 * The reply uses the xid of the request (as do all replies to OpenFlow
1973 * 3. Whenever a change to a flow table entry matches some outstanding monitor
1974 * request's criteria and flags, the switch sends a notification to the
1975 * controller as an additional NXST_FLOW_MONITOR reply with xid 0.
1977 * When multiple outstanding monitors match a single change, only a single
1978 * notification is sent. This merged notification includes the information
1979 * requested in any of the individual monitors. That is, if any of the
1980 * matching monitors requests actions (NXFMF_ACTIONS), the notification
1981 * includes actions, and if any of the monitors request full changes for the
1982 * controller's own changes (NXFMF_OWN), the controller's own changes will
1983 * be included in full.
1985 * 4. The controller may cancel a monitor with NXT_FLOW_MONITOR_CANCEL. No
1986 * further notifications will be sent on the basis of the canceled monitor
1993 * OpenFlow messages for flow monitor notifications can overflow the buffer
1994 * space available to the switch, either temporarily (e.g. due to network
1995 * conditions slowing OpenFlow traffic) or more permanently (e.g. the sustained
1996 * rate of flow table change exceeds the network bandwidth between switch and
1999 * When Open vSwitch's notification buffer space reaches a limiting threshold,
2000 * OVS reacts as follows:
2002 * 1. OVS sends an NXT_FLOW_MONITOR_PAUSED message to the controller, following
2003 * all the already queued notifications. After it receives this message,
2004 * the controller knows that its view of the flow table, as represented by
2005 * flow monitor notifications, is incomplete.
2007 * 2. As long as the notification buffer is not empty:
2009 * - NXMFE_ADD and NXFME_MODIFIED notifications will not be sent.
2011 * - NXFME_DELETED notifications will still be sent, but only for flows
2012 * that existed before OVS sent NXT_FLOW_MONITOR_PAUSED.
2014 * - NXFME_ABBREV notifications will not be sent. They are treated as
2015 * the expanded version (and therefore only the NXFME_DELETED
2016 * components, if any, are sent).
2018 * 3. When the notification buffer empties, OVS sends NXFME_ADD notifications
2019 * for flows added since the buffer reached its limit and NXFME_MODIFIED
2020 * notifications for flows that existed before the limit was reached and
2021 * changed after the limit was reached.
2023 * 4. OVS sends an NXT_FLOW_MONITOR_RESUMED message to the controller. After
2024 * it receives this message, the controller knows that its view of the flow
2025 * table, as represented by flow monitor notifications, is again complete.
2027 * This allows the maximum buffer space requirement for notifications to be
2028 * bounded by the limit plus the maximum number of supported flows.
2031 * "Flow Removed" messages
2032 * =======================
2034 * The flow monitor mechanism is independent of OFPT_FLOW_REMOVED and
2035 * NXT_FLOW_REMOVED. Flow monitor updates for deletion are sent if
2036 * NXFMF_DELETE is set on a monitor, regardless of whether the
2037 * OFPFF_SEND_FLOW_REM flag was set when the flow was added. */
2039 /* NXST_FLOW_MONITOR request.
2041 * The NXST_FLOW_MONITOR request's body consists of an array of zero or more
2042 * instances of this structure. The request arranges to monitor the flows
2043 * that match the specified criteria, which are interpreted in the same way as
2046 * 'id' identifies a particular monitor for the purpose of allowing it to be
2047 * canceled later with NXT_FLOW_MONITOR_CANCEL. 'id' must be unique among
2048 * existing monitors that have not already been canceled.
2050 * The reply includes the initial flow matches for monitors that have the
2051 * NXFMF_INITIAL flag set. No single flow will be included in the reply more
2052 * than once, even if more than one requested monitor matches that flow. The
2053 * reply will be empty if none of the monitors has NXFMF_INITIAL set or if none
2054 * of the monitors initially matches any flows.
2056 * For NXFMF_ADD, an event will be reported if 'out_port' matches against the
2057 * actions of the flow being added or, for a flow that is replacing an existing
2058 * flow, if 'out_port' matches against the actions of the flow being replaced.
2059 * For NXFMF_DELETE, 'out_port' matches against the actions of a flow being
2060 * deleted. For NXFMF_MODIFY, an event will be reported if 'out_port' matches
2061 * either the old or the new actions. */
2062 struct nx_flow_monitor_request {
2063 ovs_be32 id; /* Controller-assigned ID for this monitor. */
2064 ovs_be16 flags; /* NXFMF_*. */
2065 ovs_be16 out_port; /* Required output port, if not OFPP_NONE. */
2066 ovs_be16 match_len; /* Length of nx_match. */
2067 uint8_t table_id; /* One table's ID or 0xff for all tables. */
2068 uint8_t zeros[5]; /* Align to 64 bits (must be zero). */
2070 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
2071 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
2072 * all-zero bytes. */
2074 OFP_ASSERT(sizeof(struct nx_flow_monitor_request) == 16);
2076 /* 'flags' bits in struct nx_flow_monitor_request. */
2077 enum nx_flow_monitor_flags {
2078 /* When to send updates. */
2079 NXFMF_INITIAL = 1 << 0, /* Initially matching flows. */
2080 NXFMF_ADD = 1 << 1, /* New matching flows as they are added. */
2081 NXFMF_DELETE = 1 << 2, /* Old matching flows as they are removed. */
2082 NXFMF_MODIFY = 1 << 3, /* Matching flows as they are changed. */
2084 /* What to include in updates. */
2085 NXFMF_ACTIONS = 1 << 4, /* If set, actions are included. */
2086 NXFMF_OWN = 1 << 5, /* If set, include own changes in full. */
2089 /* NXST_FLOW_MONITOR reply header.
2091 * The body of an NXST_FLOW_MONITOR reply is an array of variable-length
2092 * structures, each of which begins with this header. The 'length' member may
2093 * be used to traverse the array, and the 'event' member may be used to
2094 * determine the particular structure.
2096 * Every instance is a multiple of 8 bytes long. */
2097 struct nx_flow_update_header {
2098 ovs_be16 length; /* Length of this entry. */
2099 ovs_be16 event; /* One of NXFME_*. */
2100 /* ...other data depending on 'event'... */
2102 OFP_ASSERT(sizeof(struct nx_flow_update_header) == 4);
2104 /* 'event' values in struct nx_flow_update_header. */
2105 enum nx_flow_update_event {
2106 /* struct nx_flow_update_full. */
2107 NXFME_ADDED = 0, /* Flow was added. */
2108 NXFME_DELETED = 1, /* Flow was deleted. */
2109 NXFME_MODIFIED = 2, /* Flow (generally its actions) was changed. */
2111 /* struct nx_flow_update_abbrev. */
2112 NXFME_ABBREV = 3, /* Abbreviated reply. */
2115 /* NXST_FLOW_MONITOR reply for NXFME_ADDED, NXFME_DELETED, and
2116 * NXFME_MODIFIED. */
2117 struct nx_flow_update_full {
2118 ovs_be16 length; /* Length is 24. */
2119 ovs_be16 event; /* One of NXFME_*. */
2120 ovs_be16 reason; /* OFPRR_* for NXFME_DELETED, else zero. */
2121 ovs_be16 priority; /* Priority of the entry. */
2122 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
2123 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
2124 ovs_be16 match_len; /* Length of nx_match. */
2125 uint8_t table_id; /* ID of flow's table. */
2126 uint8_t pad; /* Reserved, currently zeroed. */
2127 ovs_be64 cookie; /* Opaque controller-issued identifier. */
2129 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
2130 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
2131 * all-zero bytes, then
2132 * - Actions to fill out the remainder 'length' bytes (always a multiple
2133 * of 8). If NXFMF_ACTIONS was not specified, or 'event' is
2134 * NXFME_DELETED, no actions are included.
2137 OFP_ASSERT(sizeof(struct nx_flow_update_full) == 24);
2139 /* NXST_FLOW_MONITOR reply for NXFME_ABBREV.
2141 * When the controller does not specify NXFMF_OWN in a monitor request, any
2142 * flow tables changes due to the controller's own requests (on the same
2143 * OpenFlow channel) will be abbreviated, when possible, to this form, which
2144 * simply specifies the 'xid' of the OpenFlow request (e.g. an OFPT_FLOW_MOD or
2145 * NXT_FLOW_MOD) that caused the change.
2147 * Some changes cannot be abbreviated and will be sent in full:
2149 * - Changes that only partially succeed. This can happen if, for example,
2150 * a flow_mod with type OFPFC_MODIFY affects multiple flows, but only some
2151 * of those modifications succeed (e.g. due to hardware limitations).
2153 * This cannot occur with the current implementation of the Open vSwitch
2154 * software datapath. It could happen with other datapath implementations.
2156 * - Changes that race with conflicting changes made by other controllers or
2157 * other flow_mods (not separated by barriers) by the same controller.
2159 * This cannot occur with the current Open vSwitch implementation
2160 * (regardless of datapath) because Open vSwitch internally serializes
2161 * potentially conflicting changes.
2163 * A flow_mod that does not change the flow table will not trigger any
2164 * notification, even an abbreviated one. For example, a "modify" or "delete"
2165 * flow_mod that does not match any flows will not trigger a notification.
2166 * Whether an "add" or "modify" that specifies all the same parameters that a
2167 * flow already has triggers a notification is unspecified and subject to
2168 * change in future versions of Open vSwitch.
2170 * OVS will always send the notifications for a given flow table change before
2171 * the reply to a OFPT_BARRIER_REQUEST request that follows the flow table
2172 * change. Thus, if the controller does not receive an abbreviated (or
2173 * unabbreviated) notification for a flow_mod before the next
2174 * OFPT_BARRIER_REPLY, it will never receive one. */
2175 struct nx_flow_update_abbrev {
2176 ovs_be16 length; /* Length is 8. */
2177 ovs_be16 event; /* NXFME_ABBREV. */
2178 ovs_be32 xid; /* Controller-specified xid from flow_mod. */
2180 OFP_ASSERT(sizeof(struct nx_flow_update_abbrev) == 8);
2182 /* NXT_FLOW_MONITOR_CANCEL.
2184 * Used by a controller to cancel an outstanding monitor. */
2185 struct nx_flow_monitor_cancel {
2186 ovs_be32 id; /* 'id' from nx_flow_monitor_request. */
2188 OFP_ASSERT(sizeof(struct nx_flow_monitor_cancel) == 4);
2190 /* Action structure for NXAST_WRITE_METADATA.
2192 * Modifies the 'mask' bits of the metadata value. */
2193 struct nx_action_write_metadata {
2194 ovs_be16 type; /* OFPAT_VENDOR. */
2195 ovs_be16 len; /* Length is 32. */
2196 ovs_be32 vendor; /* NX_VENDOR_ID. */
2197 ovs_be16 subtype; /* NXAST_WRITE_METADATA. */
2198 uint8_t zeros[6]; /* Must be zero. */
2199 ovs_be64 metadata; /* Metadata register. */
2200 ovs_be64 mask; /* Metadata mask. */
2202 OFP_ASSERT(sizeof(struct nx_action_write_metadata) == 32);
2204 /* Action structure for NXAST_PUSH_MPLS. */
2205 struct nx_action_push_mpls {
2206 ovs_be16 type; /* OFPAT_VENDOR. */
2207 ovs_be16 len; /* Length is 8. */
2208 ovs_be32 vendor; /* NX_VENDOR_ID. */
2209 ovs_be16 subtype; /* NXAST_PUSH_MPLS. */
2210 ovs_be16 ethertype; /* Ethertype */
2213 OFP_ASSERT(sizeof(struct nx_action_push_mpls) == 16);
2215 /* Action structure for NXAST_POP_MPLS. */
2216 struct nx_action_pop_mpls {
2217 ovs_be16 type; /* OFPAT_VENDOR. */
2218 ovs_be16 len; /* Length is 8. */
2219 ovs_be32 vendor; /* NX_VENDOR_ID. */
2220 ovs_be16 subtype; /* NXAST_POP_MPLS. */
2221 ovs_be16 ethertype; /* Ethertype */
2224 OFP_ASSERT(sizeof(struct nx_action_pop_mpls) == 16);
2226 /* Action structure for NXAST_SET_MPLS_TTL. */
2227 struct nx_action_mpls_ttl {
2228 ovs_be16 type; /* OFPAT_VENDOR. */
2229 ovs_be16 len; /* Length is 8. */
2230 ovs_be32 vendor; /* NX_VENDOR_ID. */
2231 ovs_be16 subtype; /* NXAST_SET_MPLS_TTL. */
2232 uint8_t ttl; /* TTL */
2235 OFP_ASSERT(sizeof(struct nx_action_mpls_ttl) == 16);
2237 /* Action structure for NXAST_SAMPLE.
2239 * Samples matching packets with the given probability and sends them
2240 * each to the set of collectors identified with the given ID. The
2241 * probability is expressed as a number of packets to be sampled out
2242 * of USHRT_MAX packets, and must be >0.
2244 * When sending packet samples to IPFIX collectors, the IPFIX flow
2245 * record sent for each sampled packet is associated with the given
2246 * observation domain ID and observation point ID. Each IPFIX flow
2247 * record contain the sampled packet's headers when executing this
2248 * rule. If a sampled packet's headers are modified by previous
2249 * actions in the flow, those modified headers are sent. */
2250 struct nx_action_sample {
2251 ovs_be16 type; /* OFPAT_VENDOR. */
2252 ovs_be16 len; /* Length is 24. */
2253 ovs_be32 vendor; /* NX_VENDOR_ID. */
2254 ovs_be16 subtype; /* NXAST_SAMPLE. */
2255 ovs_be16 probability; /* Fraction of packets to sample. */
2256 ovs_be32 collector_set_id; /* ID of collector set in OVSDB. */
2257 ovs_be32 obs_domain_id; /* ID of sampling observation domain. */
2258 ovs_be32 obs_point_id; /* ID of sampling observation point. */
2260 OFP_ASSERT(sizeof(struct nx_action_sample) == 24);
2262 #endif /* openflow/nicira-ext.h */
git://git.onelab.eu / sliver-openvswitch.git / blob