2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira Networks
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #ifndef OPENFLOW_NICIRA_EXT_H
18 #define OPENFLOW_NICIRA_EXT_H 1
20 #include "openflow/openflow.h"
21 #include "openvswitch/types.h"
23 /* The following vendor extensions, proposed by Nicira Networks, are not yet
24 * standardized, so they are not included in openflow.h. Some of them may be
25 * suitable for standardization; others we never expect to standardize. */
27 #define NX_VENDOR_ID 0x00002320
29 /* Nicira vendor-specific error messages extension.
31 * OpenFlow 1.0 has a set of predefined error types (OFPET_*) and codes (which
32 * are specific to each type). It does not have any provision for
33 * vendor-specific error codes, and it does not even provide "generic" error
34 * codes that can apply to problems not anticipated by the OpenFlow
35 * specification authors.
37 * This extension attempts to address the problem by adding a generic "error
38 * vendor extension". The extension works as follows: use NXET_VENDOR as type
39 * and NXVC_VENDOR_ERROR as code, followed by struct nx_vendor_error with
40 * vendor-specific details, followed by at least 64 bytes of the failed
43 * It would be better to have a type-specific vendor extension, e.g. so that
44 * OFPET_BAD_ACTION could be used with vendor-specific code values. But
45 * OFPET_BAD_ACTION and most other standardized types already specify that
46 * their 'data' values are (the start of) the OpenFlow message being replied
47 * to, so there is no room to insert a vendor ID.
49 * Currently this extension is only implemented by Open vSwitch, but it seems
50 * like a reasonable candidate for future standardization.
53 /* This is a random number to avoid accidental collision with any other
54 * vendor's extension. */
55 #define NXET_VENDOR 0xb0c2
57 /* ofp_error msg 'code' values for NXET_VENDOR. */
59 NXVC_VENDOR_ERROR /* 'data' contains struct nx_vendor_error. */
62 /* 'data' for 'type' == NXET_VENDOR, 'code' == NXVC_VENDOR_ERROR. */
63 struct nx_vendor_error {
64 ovs_be32 vendor; /* Vendor ID as in struct ofp_vendor_header. */
65 ovs_be16 type; /* Vendor-defined type. */
66 ovs_be16 code; /* Vendor-defined subtype. */
67 /* Followed by at least the first 64 bytes of the failed request. */
70 /* 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; /* One of NXT_* below. */
78 OFP_ASSERT(sizeof(struct nicira_header) == 16);
80 /* Values for the 'subtype' member of struct nicira_header. */
83 NXT_STATUS_REQUEST__OBSOLETE = 0,
84 NXT_STATUS_REPLY__OBSOLETE = 1,
85 NXT_ACT_SET_CONFIG__OBSOLETE = 2,
86 NXT_ACT_GET_CONFIG__OBSOLETE = 3,
87 NXT_COMMAND_REQUEST__OBSOLETE = 4,
88 NXT_COMMAND_REPLY__OBSOLETE = 5,
89 NXT_FLOW_END_CONFIG__OBSOLETE = 6,
90 NXT_FLOW_END__OBSOLETE = 7,
91 NXT_MGMT__OBSOLETE = 8,
92 NXT_TUN_ID_FROM_COOKIE__OBSOLETE = 9,
94 /* Controller role support. The request body is struct nx_role_request.
95 * The reply echos the request. */
96 NXT_ROLE_REQUEST = 10,
99 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
100 NXT_SET_FLOW_FORMAT = 12, /* Set flow format. */
101 NXT_FLOW_MOD = 13, /* Analogous to OFPT_FLOW_MOD. */
102 NXT_FLOW_REMOVED = 14, /* Analogous to OFPT_FLOW_REMOVED. */
104 /* Use the upper 8 bits of the 'command' member in struct ofp_flow_mod to
105 * designate the table to which a flow is to be added? See the big comment
106 * on struct nx_flow_mod_table_id for more information. */
107 NXT_FLOW_MOD_TABLE_ID = 15,
109 /* Alternative PACKET_IN message formats. */
110 NXT_SET_PACKET_IN_FORMAT = 16, /* Set Packet In format. */
111 NXT_PACKET_IN = 17, /* Nicira Packet In. */
113 /* Are the idle_age and hard_age members in struct nx_flow_stats supported?
114 * If so, the switch does not reply to this message (which consists only of
115 * a "struct nicira_header"). If not, the switch sends an error reply. */
119 /* Header for Nicira vendor stats request and reply messages. */
120 struct nicira_stats_msg {
121 struct ofp_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
122 ovs_be32 subtype; /* One of NXST_* below. */
123 uint8_t pad[4]; /* Align to 64-bits. */
125 OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
127 /* Values for the 'subtype' member of struct nicira_stats_msg. */
128 enum nicira_stats_type {
129 /* Flexible flow specification (aka NXM = Nicira Extended Match). */
130 NXST_FLOW, /* Analogous to OFPST_FLOW. */
131 NXST_AGGREGATE /* Analogous to OFPST_AGGREGATE. */
134 /* Fields to use when hashing flows. */
135 enum nx_hash_fields {
136 /* Ethernet source address (NXM_OF_ETH_SRC) only. */
137 NX_HASH_FIELDS_ETH_SRC,
139 /* L2 through L4, symmetric across src/dst. Specifically, each of the
140 * following fields, if present, is hashed (slashes separate symmetric
143 * - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
145 * - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
147 * - NXM_OF_IP_SRC / NXM_OF_IP_DST
148 * - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
150 NX_HASH_FIELDS_SYMMETRIC_L4
153 /* This command enables or disables an Open vSwitch extension that allows a
154 * controller to specify the OpenFlow table to which a flow should be added,
155 * instead of having the switch decide which table is most appropriate as
156 * required by OpenFlow 1.0. By default, the extension is disabled.
158 * When this feature is enabled, Open vSwitch treats struct ofp_flow_mod's
159 * 16-bit 'command' member as two separate fields. The upper 8 bits are used
160 * as the table ID, the lower 8 bits specify the command as usual. A table ID
161 * of 0xff is treated like a wildcarded table ID.
163 * The specific treatment of the table ID depends on the type of flow mod:
165 * - OFPFC_ADD: Given a specific table ID, the flow is always placed in that
166 * table. If an identical flow already exists in that table only, then it
167 * is replaced. If the flow cannot be placed in the specified table,
168 * either because the table is full or because the table cannot support
169 * flows of the given type, the switch replies with an
170 * OFPFMFC_ALL_TABLES_FULL error. (A controller can distinguish these
171 * cases by comparing the current and maximum number of entries reported
172 * in ofp_table_stats.)
174 * If the table ID is wildcarded, the switch picks an appropriate table
175 * itself. If an identical flow already exist in the selected flow table,
176 * then it is replaced. The choice of table might depend on the flows
177 * that are already in the switch; for example, if one table fills up then
178 * the switch might fall back to another one.
180 * - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows
181 * within that table are matched and modified or deleted. If the table ID
182 * is wildcarded, flows within any table may be matched and modified or
185 * - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID,
186 * only a flow within that table may be matched and modified or deleted.
187 * If the table ID is wildcarded and exactly one flow within any table
188 * matches, then it is modified or deleted; if flows in more than one
189 * table match, then none is modified or deleted.
191 struct nx_flow_mod_table_id {
192 struct ofp_header header;
193 uint32_t vendor; /* NX_VENDOR_ID. */
194 uint32_t subtype; /* NXT_FLOW_MOD_TABLE_ID. */
195 uint8_t set; /* Nonzero to enable, zero to disable. */
198 OFP_ASSERT(sizeof(struct nx_flow_mod_table_id) == 24);
200 enum nx_packet_in_format {
201 NXPIF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
202 NXPIF_NXM = 1 /* Nicira Extended. */
205 /* NXT_SET_PACKET_IN_FORMAT request. */
206 struct nx_set_packet_in_format {
207 struct nicira_header nxh;
208 ovs_be32 format; /* One of NXPIF_*. */
210 OFP_ASSERT(sizeof(struct nx_set_packet_in_format) == 20);
212 /* NXT_PACKET_IN (analogous to OFPT_PACKET_IN).
214 * The NXT_PACKET_IN format is intended to model the OpenFlow-1.2 PACKET_IN
215 * with some minor tweaks. Most notably NXT_PACKET_IN includes the cookie of
216 * the rule which triggered the NXT_PACKET_IN message, and the match fields are
219 * The match fields in the NXT_PACKET_IN are intended to contain flow
220 * processing metadata collected at the time the NXT_PACKET_IN message was
221 * triggered. It is minimally required to contain the NXM_OF_IN_PORT of the
222 * packet, but may include other NXM headers such as flow registers. The match
223 * fields are allowed to contain non-metadata (e.g. NXM_OF_ETH_SRC etc).
224 * However, this information can typically be found in the packet directly, so
225 * it may be redundant.
227 * Whereas in most cases a controller can expect to only get back NXM fields
228 * that it set up itself (e.g. flow dumps will ordinarily report only NXM
229 * fields from flows that the controller added), NXT_PACKET_IN messages might
230 * contain fields that the controller does not understand, because the switch
231 * might support fields (new registers, new protocols, etc.) that the
232 * controller does not. Â The controller must prepared to tolerate these.
234 * The 'cookie' and 'table_id' fields have no meaning when 'reason' is
235 * OFPR_NO_MATCH. In this case they should be set to 0. */
236 struct nx_packet_in {
237 struct nicira_header nxh;
238 ovs_be32 buffer_id; /* ID assigned by datapath. */
239 ovs_be16 total_len; /* Full length of frame. */
240 uint8_t reason; /* Reason packet is sent (one of OFPR_*). */
241 uint8_t table_id; /* ID of the table that was looked up. */
242 ovs_be64 cookie; /* Cookie of the rule that was looked up. */
243 ovs_be16 match_len; /* Size of nx_match. */
244 uint8_t pad[6]; /* Align to 64-bits. */
246 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
247 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
248 * all-zero bytes, then
249 * - Exactly 2 all-zero padding bytes, then
250 * - An Ethernet frame whose length is inferred from nxh.header.length.
252 * The padding bytes preceding the Ethernet frame ensure that the IP
253 * header (if any) following the Ethernet header is 32-bit aligned. */
255 /* uint8_t nxm_fields[...]; */ /* Match. */
256 /* uint8_t pad[2]; */ /* Align to 64 bit + 16 bit. */
257 /* uint8_t data[0]; */ /* Ethernet frame. */
259 OFP_ASSERT(sizeof(struct nx_packet_in) == 40);
261 /* Configures the "role" of the sending controller. The default role is:
263 * - Other (NX_ROLE_OTHER), which allows the controller access to all
266 * The other possible roles are a related pair:
268 * - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
269 * be at most one Master controller at a time: when a controller
270 * configures itself as Master, any existing Master is demoted to the
273 * - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
274 * OpenFlow features. In particular attempts to modify the flow table
275 * will be rejected with an OFPBRC_EPERM error.
277 * Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
278 * messages, but they do receive OFPT_PORT_STATUS messages.
280 struct nx_role_request {
281 struct nicira_header nxh;
282 ovs_be32 role; /* One of NX_ROLE_*. */
284 OFP_ASSERT(sizeof(struct nx_role_request) == 20);
287 NX_ROLE_OTHER, /* Default role, full access. */
288 NX_ROLE_MASTER, /* Full access, at most one. */
289 NX_ROLE_SLAVE /* Read-only access. */
292 /* Nicira vendor flow actions. */
294 enum nx_action_subtype {
295 NXAST_SNAT__OBSOLETE, /* No longer used. */
296 NXAST_RESUBMIT, /* struct nx_action_resubmit */
297 NXAST_SET_TUNNEL, /* struct nx_action_set_tunnel */
298 NXAST_DROP_SPOOFED_ARP__OBSOLETE,
299 NXAST_SET_QUEUE, /* struct nx_action_set_queue */
300 NXAST_POP_QUEUE, /* struct nx_action_pop_queue */
301 NXAST_REG_MOVE, /* struct nx_action_reg_move */
302 NXAST_REG_LOAD, /* struct nx_action_reg_load */
303 NXAST_NOTE, /* struct nx_action_note */
304 NXAST_SET_TUNNEL64, /* struct nx_action_set_tunnel64 */
305 NXAST_MULTIPATH, /* struct nx_action_multipath */
306 NXAST_AUTOPATH, /* struct nx_action_autopath */
307 NXAST_BUNDLE, /* struct nx_action_bundle */
308 NXAST_BUNDLE_LOAD, /* struct nx_action_bundle */
309 NXAST_RESUBMIT_TABLE, /* struct nx_action_resubmit */
310 NXAST_OUTPUT_REG, /* struct nx_action_output_reg */
311 NXAST_LEARN, /* struct nx_action_learn */
312 NXAST_EXIT, /* struct nx_action_header */
313 NXAST_DEC_TTL, /* struct nx_action_header */
316 /* Header for Nicira-defined actions. */
317 struct nx_action_header {
318 ovs_be16 type; /* OFPAT_VENDOR. */
319 ovs_be16 len; /* Length is 16. */
320 ovs_be32 vendor; /* NX_VENDOR_ID. */
321 ovs_be16 subtype; /* NXAST_*. */
324 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
326 /* Action structures for NXAST_RESUBMIT and NXAST_RESUBMIT_TABLE.
328 * These actions search one of the switch's flow tables:
330 * - For NXAST_RESUBMIT_TABLE only, if the 'table' member is not 255, then
331 * it specifies the table to search.
333 * - Otherwise (for NXAST_RESUBMIT_TABLE with a 'table' of 255, or for
334 * NXAST_RESUBMIT regardless of 'table'), it searches the current flow
335 * table, that is, the OpenFlow flow table that contains the flow from
336 * which this action was obtained. If this action did not come from a
337 * flow table (e.g. it came from an OFPT_PACKET_OUT message), then table 0
338 * is the current table.
340 * The flow table lookup uses a flow that may be slightly modified from the
343 * - For NXAST_RESUBMIT, the 'in_port' member of struct nx_action_resubmit
344 * is used as the flow's in_port.
346 * - For NXAST_RESUBMIT_TABLE, if the 'in_port' member is not OFPP_IN_PORT,
347 * then its value is used as the flow's in_port. Otherwise, the original
350 * - If actions that modify the flow (e.g. OFPAT_SET_VLAN_VID) precede the
351 * resubmit action, then the flow is updated with the new values.
353 * Following the lookup, the original in_port is restored.
355 * If the modified flow matched in the flow table, then the corresponding
356 * actions are executed. Afterward, actions following the resubmit in the
357 * original set of actions, if any, are executed; any changes made to the
358 * packet (e.g. changes to VLAN) by secondary actions persist when those
359 * actions are executed, although the original in_port is restored.
361 * Resubmit actions may be used any number of times within a set of actions.
363 * Resubmit actions may nest to an implementation-defined depth. Beyond this
364 * implementation-defined depth, further resubmit actions are simply ignored.
366 * NXAST_RESUBMIT ignores 'table' and 'pad'. NXAST_RESUBMIT_TABLE requires
367 * 'pad' to be all-bits-zero.
369 * Open vSwitch 1.0.1 and earlier did not support recursion. Open vSwitch
370 * before 1.2.90 did not support NXAST_RESUBMIT_TABLE.
372 struct nx_action_resubmit {
373 ovs_be16 type; /* OFPAT_VENDOR. */
374 ovs_be16 len; /* Length is 16. */
375 ovs_be32 vendor; /* NX_VENDOR_ID. */
376 ovs_be16 subtype; /* NXAST_RESUBMIT. */
377 ovs_be16 in_port; /* New in_port for checking flow table. */
378 uint8_t table; /* NXAST_RESUBMIT_TABLE: table to use. */
381 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
383 /* Action structure for NXAST_SET_TUNNEL.
385 * Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32
386 * bits of the tunnel ID are set to 0. */
387 struct nx_action_set_tunnel {
388 ovs_be16 type; /* OFPAT_VENDOR. */
389 ovs_be16 len; /* Length is 16. */
390 ovs_be32 vendor; /* NX_VENDOR_ID. */
391 ovs_be16 subtype; /* NXAST_SET_TUNNEL. */
393 ovs_be32 tun_id; /* Tunnel ID. */
395 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
397 /* Action structure for NXAST_SET_TUNNEL64.
399 * Sets the encapsulating tunnel ID to a 64-bit value. */
400 struct nx_action_set_tunnel64 {
401 ovs_be16 type; /* OFPAT_VENDOR. */
402 ovs_be16 len; /* Length is 16. */
403 ovs_be32 vendor; /* NX_VENDOR_ID. */
404 ovs_be16 subtype; /* NXAST_SET_TUNNEL64. */
406 ovs_be64 tun_id; /* Tunnel ID. */
408 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
410 /* Action structure for NXAST_SET_QUEUE.
412 * Set the queue that should be used when packets are output. This is similar
413 * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
414 * an argument. This allows the queue to be defined before the port is
416 struct nx_action_set_queue {
417 ovs_be16 type; /* OFPAT_VENDOR. */
418 ovs_be16 len; /* Length is 16. */
419 ovs_be32 vendor; /* NX_VENDOR_ID. */
420 ovs_be16 subtype; /* NXAST_SET_QUEUE. */
422 ovs_be32 queue_id; /* Where to enqueue packets. */
424 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
426 /* Action structure for NXAST_POP_QUEUE.
428 * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
429 * were used. Only the original queue can be restored this way; no stack is
431 struct nx_action_pop_queue {
432 ovs_be16 type; /* OFPAT_VENDOR. */
433 ovs_be16 len; /* Length is 16. */
434 ovs_be32 vendor; /* NX_VENDOR_ID. */
435 ovs_be16 subtype; /* NXAST_POP_QUEUE. */
438 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
440 /* Action structure for NXAST_REG_MOVE.
442 * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
443 * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
444 * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for
445 * the next most significant bit, and so on.
447 * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make
448 * sense to use nxm_hasmask=1 because the action does not do any kind of
449 * matching; it uses the actual value of a field.)
451 * The following nxm_header values are potentially acceptable as 'src':
474 * - NXM_NX_ICMPV6_TYPE
475 * - NXM_NX_ICMPV6_CODE
478 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
480 * The following nxm_header values are potentially acceptable as 'dst':
491 * Modifying any of the above fields changes the corresponding packet
494 * - NXM_NX_REG(idx) for idx in the switch's accepted range.
496 * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the
497 * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q
498 * header (if any), ignoring the other bits. Setting a value with CFI=1
499 * adds or modifies the 802.1Q header appropriately, setting the TCI field
500 * to the field's new value (with the CFI bit masked out).
502 * - NXM_NX_TUN_ID. Modifying this value modifies the tunnel ID used for the
503 * packet's next tunnel encapsulation.
505 * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
506 * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be
507 * used only if the flow's nx_match includes an nxm_entry that specifies
508 * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
510 * The switch will reject actions for which src_ofs+n_bits is greater than the
511 * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
512 * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
514 struct nx_action_reg_move {
515 ovs_be16 type; /* OFPAT_VENDOR. */
516 ovs_be16 len; /* Length is 16. */
517 ovs_be32 vendor; /* NX_VENDOR_ID. */
518 ovs_be16 subtype; /* NXAST_REG_MOVE. */
519 ovs_be16 n_bits; /* Number of bits. */
520 ovs_be16 src_ofs; /* Starting bit offset in source. */
521 ovs_be16 dst_ofs; /* Starting bit offset in destination. */
522 ovs_be32 src; /* Source register. */
523 ovs_be32 dst; /* Destination register. */
525 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
527 /* Action structure for NXAST_REG_LOAD.
529 * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
530 * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering
531 * starts at 0 for the least-significant bit, 1 for the next most significant
534 * 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for
535 * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
538 * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
539 * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to
540 * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
541 * also stored as one less than its true value:
544 * +------------------------------+------------------+
545 * | ofs | n_bits - 1 |
546 * +------------------------------+------------------+
548 * The switch will reject actions for which ofs+n_bits is greater than the
549 * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
550 * greater are set to 1, with error type OFPET_BAD_ACTION, code
551 * OFPBAC_BAD_ARGUMENT.
553 struct nx_action_reg_load {
554 ovs_be16 type; /* OFPAT_VENDOR. */
555 ovs_be16 len; /* Length is 16. */
556 ovs_be32 vendor; /* NX_VENDOR_ID. */
557 ovs_be16 subtype; /* NXAST_REG_LOAD. */
558 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
559 ovs_be32 dst; /* Destination register. */
560 ovs_be64 value; /* Immediate value. */
562 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
564 /* Action structure for NXAST_NOTE.
566 * This action has no effect. It is variable length. The switch does not
567 * attempt to interpret the user-defined 'note' data in any way. A controller
568 * can use this action to attach arbitrary metadata to a flow.
570 * This action might go away in the future.
572 struct nx_action_note {
573 ovs_be16 type; /* OFPAT_VENDOR. */
574 ovs_be16 len; /* A multiple of 8, but at least 16. */
575 ovs_be32 vendor; /* NX_VENDOR_ID. */
576 ovs_be16 subtype; /* NXAST_NOTE. */
577 uint8_t note[6]; /* Start of user-defined data. */
578 /* Possibly followed by additional user-defined data. */
580 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
582 /* Action structure for NXAST_MULTIPATH.
584 * This action performs the following steps in sequence:
586 * 1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
587 * Refer to the definition of "enum nx_mp_fields" for details.
589 * The 'basis' value is used as a universal hash parameter, that is,
590 * different values of 'basis' yield different hash functions. The
591 * particular universal hash function used is implementation-defined.
593 * The hashed fields' values are drawn from the current state of the
594 * flow, including all modifications that have been made by actions up to
597 * 2. Applies the multipath link choice algorithm specified by 'algorithm',
598 * one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm"
601 * The output of the algorithm is 'link', an unsigned integer less than
602 * or equal to 'max_link'.
604 * Some algorithms use 'arg' as an additional argument.
606 * 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of
607 * 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
610 * The switch will reject actions that have an unknown 'fields', or an unknown
611 * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
612 * in which 'max_link' is greater than or equal to 2**n_bits, with error type
613 * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
615 struct nx_action_multipath {
616 ovs_be16 type; /* OFPAT_VENDOR. */
617 ovs_be16 len; /* Length is 32. */
618 ovs_be32 vendor; /* NX_VENDOR_ID. */
619 ovs_be16 subtype; /* NXAST_MULTIPATH. */
621 /* What fields to hash and how. */
622 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
623 ovs_be16 basis; /* Universal hash parameter. */
626 /* Multipath link choice algorithm to apply to hash value. */
627 ovs_be16 algorithm; /* One of NX_MP_ALG_*. */
628 ovs_be16 max_link; /* Number of output links, minus 1. */
629 ovs_be32 arg; /* Algorithm-specific argument. */
632 /* Where to store the result. */
633 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
634 ovs_be32 dst; /* Destination. */
636 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
638 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
640 * In the descriptions below, 'n_links' is max_link + 1. */
641 enum nx_mp_algorithm {
642 /* link = hash(flow) % n_links.
644 * Redistributes all traffic when n_links changes. O(1) performance. See
647 * Use UINT16_MAX for max_link to get a raw hash value. */
650 /* link = hash(flow) / (MAX_HASH / n_links).
652 * Redistributes between one-quarter and one-half of traffic when n_links
653 * changes. O(1) performance. See RFC 2992.
655 NX_MP_ALG_HASH_THRESHOLD,
657 /* for i in [0,n_links):
658 * weights[i] = hash(flow, i)
659 * link = { i such that weights[i] >= weights[j] for all j != i }
661 * Redistributes 1/n_links of traffic when n_links changes. O(n_links)
662 * performance. If n_links is greater than a threshold (currently 64, but
663 * subject to change), Open vSwitch will substitute another algorithm
664 * automatically. See RFC 2992. */
665 NX_MP_ALG_HRW, /* Highest Random Weight. */
670 * link = hash(flow, i) % arg
671 * while link > max_link
673 * Redistributes 1/n_links of traffic when n_links changes. O(1)
674 * performance when arg/max_link is bounded by a constant.
676 * Redistributes all traffic when arg changes.
678 * arg must be greater than max_link and for best performance should be no
679 * more than approximately max_link * 2. If arg is outside the acceptable
680 * range, Open vSwitch will automatically substitute the least power of 2
681 * greater than max_link.
683 * This algorithm is specific to Open vSwitch.
685 NX_MP_ALG_ITER_HASH /* Iterative Hash. */
688 /* Action structure for NXAST_LEARN.
690 * This action adds or modifies a flow in an OpenFlow table, similar to
691 * OFPT_FLOW_MOD with OFPFC_MODIFY_STRICT as 'command'. The new flow has the
692 * specified idle timeout, hard timeout, priority, cookie, and flags. The new
693 * flow's match criteria and actions are built by applying each of the series
694 * of flow_mod_spec elements included as part of the action.
696 * A flow_mod_spec starts with a 16-bit header. A header that is all-bits-0 is
697 * a no-op used for padding the action as a whole to a multiple of 8 bytes in
698 * length. Otherwise, the flow_mod_spec can be thought of as copying 'n_bits'
699 * bits from a source to a destination. In this case, the header contains
702 * 15 14 13 12 11 10 0
703 * +------+---+------+---------------------------------+
704 * | 0 |src| dst | n_bits |
705 * +------+---+------+---------------------------------+
707 * The meaning and format of a flow_mod_spec depends on 'src' and 'dst'. The
708 * following table summarizes the meaning of each possible combination.
709 * Details follow the table:
712 * --- --- ----------------------------------------------------------
713 * 0 0 Add match criteria based on value in a field.
714 * 1 0 Add match criteria based on an immediate value.
715 * 0 1 Add NXAST_REG_LOAD action to copy field into a different field.
716 * 1 1 Add NXAST_REG_LOAD action to load immediate value into a field.
717 * 0 2 Add OFPAT_OUTPUT action to output to port from specified field.
718 * All other combinations are undefined and not allowed.
720 * The flow_mod_spec header is followed by a source specification and a
721 * destination specification. The format and meaning of the source
722 * specification depends on 'src':
724 * - If 'src' is 0, the source bits are taken from a field in the flow to
725 * which this action is attached. (This should be a wildcarded field. If
726 * its value is fully specified then the source bits being copied have
729 * The source specification is an ovs_be32 'field' and an ovs_be16 'ofs'.
730 * 'field' is an nxm_header with nxm_hasmask=0, and 'ofs' the starting bit
731 * offset within that field. The source bits are field[ofs:ofs+n_bits-1].
732 * 'field' and 'ofs' are subject to the same restrictions as the source
733 * field in NXAST_REG_MOVE.
735 * - If 'src' is 1, the source bits are a constant value. The source
736 * specification is (n_bits+15)/16*2 bytes long. Taking those bytes as a
737 * number in network order, the source bits are the 'n_bits'
738 * least-significant bits. The switch will report an error if other bits
739 * in the constant are nonzero.
741 * The flow_mod_spec destination specification, for 'dst' of 0 or 1, is an
742 * ovs_be32 'field' and an ovs_be16 'ofs'. 'field' is an nxm_header with
743 * nxm_hasmask=0 and 'ofs' is a starting bit offset within that field. The
744 * meaning of the flow_mod_spec depends on 'dst':
746 * - If 'dst' is 0, the flow_mod_spec specifies match criteria for the new
747 * flow. The new flow matches only if bits field[ofs:ofs+n_bits-1] in a
748 * packet equal the source bits. 'field' may be any nxm_header with
749 * nxm_hasmask=0 that is allowed in NXT_FLOW_MOD.
751 * Order is significant. Earlier flow_mod_specs must satisfy any
752 * prerequisites for matching fields specified later, by copying constant
753 * values into prerequisite fields.
755 * The switch will reject flow_mod_specs that do not satisfy NXM masking
758 * - If 'dst' is 1, the flow_mod_spec specifies an NXAST_REG_LOAD action for
759 * the new flow. The new flow copies the source bits into
760 * field[ofs:ofs+n_bits-1]. Actions are executed in the same order as the
763 * The flow_mod_spec destination spec for 'dst' of 2 (when 'src' is 0) is
764 * empty. It has the following meaning:
766 * - The flow_mod_spec specifies an OFPAT_OUTPUT action for the new flow.
767 * The new flow outputs to the OpenFlow port specified by the source field.
768 * Of the special output ports with value OFPP_MAX or larger, OFPP_IN_PORT,
769 * OFPP_FLOOD, OFPP_LOCAL, and OFPP_ALL are supported. Other special ports
772 * Resource Management
773 * -------------------
775 * A switch has a finite amount of flow table space available for learning.
776 * When this space is exhausted, no new learning table entries will be learned
777 * until some existing flow table entries expire. The controller should be
778 * prepared to handle this by flooding (which can be implemented as a
779 * low-priority flow).
784 * The following examples give a prose description of the flow_mod_specs along
785 * with informal notation for how those would be represented and a hex dump of
786 * the bytes that would be required.
788 * These examples could work with various nx_action_learn parameters. Typical
789 * values would be idle_timeout=OFP_FLOW_PERMANENT, hard_timeout=60,
790 * priority=OFP_DEFAULT_PRIORITY, flags=0, table_id=10.
792 * 1. Learn input port based on the source MAC, with lookup into
793 * NXM_NX_REG1[16:31] by resubmit to in_port=99:
795 * Match on in_port=99:
796 * ovs_be16(src=1, dst=0, n_bits=16), 20 10
797 * ovs_be16(99), 00 63
798 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
800 * Match Ethernet destination on Ethernet source from packet:
801 * ovs_be16(src=0, dst=0, n_bits=48), 00 30
802 * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
803 * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
805 * Set NXM_NX_REG1[16:31] to the packet's input port:
806 * ovs_be16(src=0, dst=1, n_bits=16), 08 10
807 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
808 * ovs_be32(NXM_NX_REG1), ovs_be16(16) 00 01 02 04 00 10
810 * Given a packet that arrived on port A with Ethernet source address B,
811 * this would set up the flow "in_port=99, dl_dst=B,
812 * actions=load:A->NXM_NX_REG1[16..31]".
814 * In syntax accepted by ovs-ofctl, this action is: learn(in_port=99,
815 * NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
816 * load:NXM_OF_IN_PORT[]->NXM_NX_REG1[16..31])
818 * 2. Output to input port based on the source MAC and VLAN VID, with lookup
819 * into NXM_NX_REG1[16:31]:
821 * Match on same VLAN ID as packet:
822 * ovs_be16(src=0, dst=0, n_bits=12), 00 0c
823 * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
824 * ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0) 00 00 08 02 00 00
826 * Match Ethernet destination on Ethernet source from packet:
827 * ovs_be16(src=0, dst=0, n_bits=48), 00 30
828 * ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0) 00 00 04 06 00 00
829 * ovs_be32(NXM_OF_ETH_DST), ovs_be16(0) 00 00 02 06 00 00
831 * Output to the packet's input port:
832 * ovs_be16(src=0, dst=2, n_bits=16), 10 10
833 * ovs_be32(NXM_OF_IN_PORT), ovs_be16(0) 00 00 00 02 00 00
835 * Given a packet that arrived on port A with Ethernet source address B in
836 * VLAN C, this would set up the flow "dl_dst=B, vlan_vid=C,
839 * In syntax accepted by ovs-ofctl, this action is:
840 * learn(NXM_OF_VLAN_TCI[0..11], NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
841 * output:NXM_OF_IN_PORT[])
843 * 3. Here's a recipe for a very simple-minded MAC learning switch. It uses a
844 * 10-second MAC expiration time to make it easier to see what's going on
846 * ovs-vsctl del-controller br0
847 * ovs-ofctl del-flows br0
848 * ovs-ofctl add-flow br0 "table=0 actions=learn(table=1, \
849 hard_timeout=10, NXM_OF_VLAN_TCI[0..11], \
850 NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[], \
851 output:NXM_OF_IN_PORT[]), resubmit(,1)"
852 * ovs-ofctl add-flow br0 "table=1 priority=0 actions=flood"
854 * You can then dump the MAC learning table with:
856 * ovs-ofctl dump-flows br0 table=1
861 * For best performance, segregate learned flows into a table that is not used
862 * for any other flows except possibly for a lowest-priority "catch-all" flow
863 * (a flow with no match criteria). If different learning actions specify
864 * different match criteria, use different tables for the learned flows.
866 * The meaning of 'hard_timeout' and 'idle_timeout' can be counterintuitive.
867 * These timeouts apply to the flow that is added, which means that a flow with
868 * an idle timeout will expire when no traffic has been sent *to* the learned
869 * address. This is not usually the intent in MAC learning; instead, we want
870 * the MAC learn entry to expire when no traffic has been sent *from* the
871 * learned address. Use a hard timeout for that.
873 struct nx_action_learn {
874 ovs_be16 type; /* OFPAT_VENDOR. */
875 ovs_be16 len; /* At least 24. */
876 ovs_be32 vendor; /* NX_VENDOR_ID. */
877 ovs_be16 subtype; /* NXAST_LEARN. */
878 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
879 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
880 ovs_be16 priority; /* Priority level of flow entry. */
881 ovs_be64 cookie; /* Cookie for new flow. */
882 ovs_be16 flags; /* Either 0 or OFPFF_SEND_FLOW_REM. */
883 uint8_t table_id; /* Table to insert flow entry. */
884 uint8_t pad[5]; /* Must be zero. */
885 /* Followed by a sequence of flow_mod_spec elements, as described above,
886 * until the end of the action is reached. */
888 OFP_ASSERT(sizeof(struct nx_action_learn) == 32);
890 #define NX_LEARN_N_BITS_MASK 0x3ff
892 #define NX_LEARN_SRC_FIELD (0 << 13) /* Copy from field. */
893 #define NX_LEARN_SRC_IMMEDIATE (1 << 13) /* Copy from immediate value. */
894 #define NX_LEARN_SRC_MASK (1 << 13)
896 #define NX_LEARN_DST_MATCH (0 << 11) /* Add match criterion. */
897 #define NX_LEARN_DST_LOAD (1 << 11) /* Add NXAST_REG_LOAD action. */
898 #define NX_LEARN_DST_OUTPUT (2 << 11) /* Add OFPAT_OUTPUT action. */
899 #define NX_LEARN_DST_RESERVED (3 << 11) /* Not yet defined. */
900 #define NX_LEARN_DST_MASK (3 << 11)
902 /* Action structure for NXAST_AUTOPATH.
904 * This action performs the following steps in sequence:
906 * 1. Hashes the flow using an implementation-defined hash function.
908 * The hashed fields' values are drawn from the current state of the
909 * flow, including all modifications that have been made by actions up to
912 * 2. Selects an OpenFlow 'port'.
914 * 'port' is selected in an implementation-defined manner, taking into
915 * account 'id' and the hash value calculated in step 1.
917 * Generally a switch will have been configured with a set of ports that
918 * may be chosen given 'id'. The switch may take into account any number
919 * of factors when choosing 'port' from its configured set. Factors may
920 * include carrier, load, and the results of configuration protocols such
923 * 3. Stores 'port' in dst[ofs:ofs+n_bits].
925 * The format and semantics of 'dst' and 'ofs_nbits' are similar to those
926 * for the NXAST_REG_LOAD action.
928 * The switch will reject actions in which ofs+n_bits is greater than the width
929 * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
931 struct nx_action_autopath {
932 ovs_be16 type; /* OFPAT_VENDOR. */
933 ovs_be16 len; /* Length is 20. */
934 ovs_be32 vendor; /* NX_VENDOR_ID. */
935 ovs_be16 subtype; /* NXAST_AUTOPATH. */
937 /* Where to store the result. */
938 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
939 ovs_be32 dst; /* Destination. */
941 ovs_be32 id; /* Autopath ID. */
944 OFP_ASSERT(sizeof(struct nx_action_autopath) == 24);
946 /* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD.
948 * The bundle actions choose a slave from a supplied list of options.
949 * NXAST_BUNDLE outputs to its selection. NXAST_BUNDLE_LOAD writes its
950 * selection to a register.
952 * The list of possible slaves follows the nx_action_bundle structure. The size
953 * of each slave is governed by its type as indicated by the 'slave_type'
954 * parameter. The list of slaves should be padded at its end with zeros to make
955 * the total length of the action a multiple of 8.
957 * Switches infer from the 'slave_type' parameter the size of each slave. All
958 * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
959 * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
960 * 2 byte width. Switches should reject actions which indicate unknown or
961 * unsupported slave types.
963 * Switches use a strategy dictated by the 'algorithm' parameter to choose a
964 * slave. If the switch does not support the specified 'algorithm' parameter,
965 * it should reject the action.
967 * Several algorithms take into account liveness when selecting slaves. The
968 * liveness of a slave is implementation defined (with one exception), but will
969 * generally take into account things like its carrier status and the results
970 * of any link monitoring protocols which happen to be running on it. In order
971 * to give controllers a place-holder value, the OFPP_NONE port is always
974 * Some slave selection strategies require the use of a hash function, in which
975 * case the 'fields' and 'basis' parameters should be populated. The 'fields'
976 * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
977 * hash. Refer to the definition of "enum nx_hash_fields" for details. The
978 * 'basis' parameter is used as a universal hash parameter. Different values
979 * of 'basis' yield different hash results.
981 * The 'zero' parameter at the end of the action structure is reserved for
982 * future use. Switches are required to reject actions which have nonzero
983 * bytes in the 'zero' field.
985 * NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed. Switches
986 * should reject actions which have nonzero bytes in either of these fields.
988 * NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in
989 * dst[ofs:ofs+n_bits]. The format and semantics of 'dst' and 'ofs_nbits' are
990 * similar to those for the NXAST_REG_LOAD action. */
991 struct nx_action_bundle {
992 ovs_be16 type; /* OFPAT_VENDOR. */
993 ovs_be16 len; /* Length including slaves. */
994 ovs_be32 vendor; /* NX_VENDOR_ID. */
995 ovs_be16 subtype; /* NXAST_BUNDLE or NXAST_BUNDLE_LOAD. */
997 /* Slave choice algorithm to apply to hash value. */
998 ovs_be16 algorithm; /* One of NX_BD_ALG_*. */
1000 /* What fields to hash and how. */
1001 ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */
1002 ovs_be16 basis; /* Universal hash parameter. */
1004 ovs_be32 slave_type; /* NXM_OF_IN_PORT. */
1005 ovs_be16 n_slaves; /* Number of slaves. */
1007 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
1008 ovs_be32 dst; /* Destination. */
1010 uint8_t zero[4]; /* Reserved. Must be zero. */
1012 OFP_ASSERT(sizeof(struct nx_action_bundle) == 32);
1014 /* NXAST_BUNDLE: Bundle slave choice algorithm to apply.
1016 * In the descriptions below, 'slaves' is the list of possible slaves in the
1017 * order they appear in the OpenFlow action. */
1018 enum nx_bd_algorithm {
1019 /* Chooses the first live slave listed in the bundle.
1021 * O(n_slaves) performance. */
1022 NX_BD_ALG_ACTIVE_BACKUP,
1024 /* for i in [0,n_slaves):
1025 * weights[i] = hash(flow, i)
1026 * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
1028 * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
1029 * O(n_slaves) performance.
1031 * Uses the 'fields' and 'basis' parameters. */
1032 NX_BD_ALG_HRW /* Highest Random Weight. */
1035 /* Action structure for NXAST_OUTPUT_REG.
1037 * Outputs to the OpenFlow port number written to src[ofs:ofs+nbits].
1039 * The format and semantics of 'src' and 'ofs_nbits' are similar to those for
1040 * the NXAST_REG_LOAD action.
1042 * The acceptable nxm_header values for 'src' are the same as the acceptable
1043 * nxm_header values for the 'src' field of NXAST_REG_MOVE.
1045 * The 'max_len' field indicates the number of bytes to send when the chosen
1046 * port is OFPP_CONTROLLER. Its semantics are equivalent to the 'max_len'
1047 * field of OFPAT_OUTPUT.
1049 * The 'zero' field is required to be zeroed for forward compatibility. */
1050 struct nx_action_output_reg {
1051 ovs_be16 type; /* OFPAT_VENDOR. */
1052 ovs_be16 len; /* 24. */
1053 ovs_be32 vendor; /* NX_VENDOR_ID. */
1054 ovs_be16 subtype; /* NXAST_OUTPUT_REG. */
1056 ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */
1057 ovs_be32 src; /* Source. */
1059 ovs_be16 max_len; /* Max length to send to controller. */
1061 uint8_t zero[6]; /* Reserved, must be zero. */
1063 OFP_ASSERT(sizeof(struct nx_action_output_reg) == 24);
1067 * Discontinues action processing.
1069 * The NXAST_EXIT action causes the switch to immediately halt processing
1070 * actions for the flow. Any actions which have already been processed are
1071 * executed by the switch. However, any further actions, including those which
1072 * may be in different tables, or different levels of the NXAST_RESUBMIT
1073 * hierarchy, will be ignored.
1075 * Uses the nx_action_header structure. */
1077 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
1079 * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches. This
1080 * structure is fixed-length and hence difficult to extend. This section
1081 * describes a more flexible, variable-length flow match, called "nx_match" for
1082 * short, that is also supported by Open vSwitch. This section also defines a
1083 * replacement for each OpenFlow message that includes struct ofp_match.
1089 * An nx_match is a sequence of zero or more "nxm_entry"s, which are
1090 * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
1091 * "nxm_entry"s are not aligned on or padded to any multibyte boundary. The
1092 * first 4 bytes of an nxm_entry are its "header", followed by the entry's
1095 * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
1097 * |<-------------------- nxm_type ------------------>|
1099 * |31 16 15 9| 8 7 0
1100 * +----------------------------------+---------------+--+------------------+
1101 * | nxm_vendor | nxm_field |hm| nxm_length |
1102 * +----------------------------------+---------------+--+------------------+
1104 * The most-significant 23 bits of the header are collectively "nxm_type".
1105 * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits
1106 * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally
1107 * designates a protocol header, such as the Ethernet type, but it can also
1108 * refer to packet metadata, such as the switch port on which a packet arrived.
1110 * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning
1111 * of this bit is explained later.
1113 * The least-significant 8 bits are "nxm_length", a positive integer. The
1114 * length of the nxm_entry, including the header, is exactly 4 + nxm_length
1117 * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
1118 * constant. It is included only to allow software to minimally parse
1119 * "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor,
1120 * nxm_field, and nxm_length, nxm_hasmask is a constant.)
1126 * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
1128 * An nxm_entry places a constraint on the packets matched by the nx_match:
1130 * - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
1131 * field, called "nxm_value". The nx_match matches only packets in which
1132 * the field equals nxm_value.
1134 * - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
1135 * field (nxm_value), followed by a bitmask of the same length as the
1136 * value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the
1137 * nx_match matches only packets for which bit J in the given field's value
1138 * matches bit J in nxm_value. A 0-bit in nxm_mask causes the
1139 * corresponding bits in nxm_value and the field's value to be ignored.
1140 * (The sense of the nxm_mask bits is the opposite of that used by the
1141 * "wildcards" member of struct ofp_match.)
1143 * When nxm_hasmask is 1, nxm_length is always even.
1145 * An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
1146 * entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for
1149 * When there are multiple "nxm_entry"s, all of the constraints must be met.
1155 * Masks may be restricted:
1157 * - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
1158 * must always be 0 when these fields are specified. For example, the
1159 * field that identifies the port on which a packet was received may not be
1162 * - Some nxm_types that do support masked wildcards may only support certain
1163 * nxm_mask patterns. For example, fields that have IPv4 address values
1164 * may be restricted to CIDR masks.
1166 * These restrictions should be noted in specifications for individual fields.
1167 * A switch may accept an nxm_hasmask or nxm_mask value that the specification
1168 * disallows, if the switch correctly implements support for that nxm_hasmask
1169 * or nxm_mask value. A switch must reject an attempt to set up a flow that
1170 * contains a nxm_hasmask or nxm_mask value that it does not support.
1173 * Prerequisite Restrictions
1174 * =========================
1176 * The presence of an nxm_entry with a given nxm_type may be restricted based
1177 * on the presence of or values of other "nxm_entry"s. For example:
1179 * - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
1180 * preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
1181 * and nxm_value=0x0800. That is, matching on the IP source address is
1182 * allowed only if the Ethernet type is explicitly set to IP.
1184 * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is
1185 * preceded by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and
1186 * nxm_value either 0x0800 or 0x86dd, and another with
1187 * nxm_type=NXM_OF_IP_PROTO, nxm_hasmask=0, nxm_value=6, in that order.
1188 * That is, matching on the TCP source port is allowed only if the Ethernet
1189 * type is IP or IPv6 and the IP protocol is TCP.
1191 * These restrictions should be noted in specifications for individual fields.
1192 * A switch may implement relaxed versions of these restrictions. A switch
1193 * must reject an attempt to set up a flow that violates its restrictions.
1196 * Ordering Restrictions
1197 * =====================
1199 * An nxm_entry that has prerequisite restrictions must appear after the
1200 * "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an
1201 * nx_match is not otherwise constrained.
1203 * Any given nxm_type may appear in an nx_match at most once.
1206 * nxm_entry Examples
1207 * ==================
1209 * These examples show the format of a single nxm_entry with particular
1210 * nxm_hasmask and nxm_length values. The diagrams are labeled with field
1211 * numbers and byte indexes.
1214 * 8-bit nxm_value, nxm_hasmask=1, nxm_length=2:
1217 * +------------+---+---+
1218 * | header | v | m |
1219 * +------------+---+---+
1222 * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
1225 * +------------+------+
1227 * +------------+------+
1230 * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
1233 * +------------+-------------+
1234 * | header | nxm_value |
1235 * +------------+-------------+
1238 * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
1241 * +------------+------------------+
1242 * | header | nxm_value |
1243 * +------------+------------------+
1246 * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
1249 * +------------+------------------+------------------+
1250 * | header | nxm_value | nxm_mask |
1251 * +------------+------------------+------------------+
1257 * A switch should report an error in an nx_match using error type
1258 * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch
1259 * should report a specific error code, if one is assigned for the particular
1260 * problem, but NXBRC_NXM_INVALID is also available to report a generic
1264 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
1265 (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
1266 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
1267 NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
1268 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
1269 NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
1270 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
1271 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
1272 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
1273 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
1274 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
1276 #define NXM_MAKE_WILD_HEADER(HEADER) \
1277 NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
1279 /* ## ------------------------------- ## */
1280 /* ## OpenFlow 1.0-compatible fields. ## */
1281 /* ## ------------------------------- ## */
1283 /* Physical or virtual port on which the packet was received.
1287 * Format: 16-bit integer in network byte order.
1289 * Masking: Not maskable. */
1290 #define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2)
1292 /* Source or destination address in Ethernet header.
1296 * Format: 48-bit Ethernet MAC address.
1298 * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must
1299 * be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that
1300 * are all-0-bits or all-1-bits). Support for other patterns and for masking
1301 * of NXM_OF_ETH_SRC is optional. */
1302 #define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6)
1303 #define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6)
1304 #define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6)
1306 /* Packet's Ethernet type.
1308 * For an Ethernet II packet this is taken from the Ethernet header. For an
1309 * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
1310 * A packet that has neither format has value 0x05ff
1311 * (OFP_DL_TYPE_NOT_ETH_TYPE).
1313 * For a packet with an 802.1Q header, this is the type of the encapsulated
1318 * Format: 16-bit integer in network byte order.
1320 * Masking: Not maskable. */
1321 #define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2)
1325 * For a packet with an 802.1Q header, this is the Tag Control Information
1326 * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q
1327 * header, this has value 0.
1331 * Format: 16-bit integer in network byte order.
1333 * Masking: Arbitrary masks.
1335 * This field can be used in various ways:
1337 * - If it is not constrained at all, the nx_match matches packets without
1338 * an 802.1Q header or with an 802.1Q header that has any TCI value.
1340 * - Testing for an exact match with 0 matches only packets without an
1343 * - Testing for an exact match with a TCI value with CFI=1 matches packets
1344 * that have an 802.1Q header with a specified VID and PCP.
1346 * - Testing for an exact match with a nonzero TCI value with CFI=0 does
1347 * not make sense. The switch may reject this combination.
1349 * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
1350 * packets that have an 802.1Q header with that VID (and any PCP).
1352 * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
1353 * packets that have an 802.1Q header with that PCP (and any VID).
1355 * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
1356 * header or with an 802.1Q header with a VID of 0.
1358 * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
1359 * header or with an 802.1Q header with a PCP of 0.
1361 * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
1362 * header or with an 802.1Q header with both VID and PCP of 0.
1364 #define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2)
1365 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2)
1367 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
1369 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1371 * Format: 8-bit integer with 2 least-significant bits forced to 0.
1373 * Masking: Not maskable. */
1374 #define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1)
1376 /* The "protocol" byte in the IP header.
1378 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1380 * Format: 8-bit integer.
1382 * Masking: Not maskable. */
1383 #define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1)
1385 /* The source or destination address in the IP header.
1387 * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
1389 * Format: 32-bit integer in network byte order.
1391 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1392 * high-order bits set to 1 and the other 32-N bits set to 0. */
1393 #define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4)
1394 #define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4)
1395 #define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4)
1396 #define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4)
1398 /* The source or destination port in the TCP header.
1401 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1402 * NXM_OF_IP_PROTO must match 6 exactly.
1404 * Format: 16-bit integer in network byte order.
1406 * Masking: Fully maskable, in Open vSwitch 1.6 and later. Not maskable, in
1407 * earlier versions. */
1408 #define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2)
1409 #define NXM_OF_TCP_SRC_W NXM_HEADER_W(0x0000, 9, 2)
1410 #define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2)
1411 #define NXM_OF_TCP_DST_W NXM_HEADER_W(0x0000, 10, 2)
1413 /* The source or destination port in the UDP header.
1416 * NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1417 * NXM_OF_IP_PROTO must match 17 exactly.
1419 * Format: 16-bit integer in network byte order.
1421 * Masking: Fully maskable, in Open vSwitch 1.6 and later. Not maskable, in
1422 * earlier versions. */
1423 #define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2)
1424 #define NXM_OF_UDP_SRC_W NXM_HEADER_W(0x0000, 11, 2)
1425 #define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2)
1426 #define NXM_OF_UDP_DST_W NXM_HEADER_W(0x0000, 12, 2)
1428 /* The type or code in the ICMP header.
1431 * NXM_OF_ETH_TYPE must match 0x0800 exactly.
1432 * NXM_OF_IP_PROTO must match 1 exactly.
1434 * Format: 8-bit integer.
1436 * Masking: Not maskable. */
1437 #define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1)
1438 #define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1)
1442 * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0
1443 * otherwise. Only ARP opcodes between 1 and 255 should be specified for
1446 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1448 * Format: 16-bit integer in network byte order.
1450 * Masking: Not maskable. */
1451 #define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2)
1453 /* For an Ethernet+IP ARP packet, the source or target protocol address
1454 * in the ARP header. Always 0 otherwise.
1456 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1458 * Format: 32-bit integer in network byte order.
1460 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1461 * high-order bits set to 1 and the other 32-N bits set to 0. */
1462 #define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4)
1463 #define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4)
1464 #define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4)
1465 #define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4)
1467 /* ## ------------------------ ## */
1468 /* ## Nicira match extensions. ## */
1469 /* ## ------------------------ ## */
1471 /* Metadata registers.
1473 * Registers initially have value 0. Actions allow register values to be
1478 * Format: Array of 32-bit integer registers. Space is reserved for up to
1479 * NXM_NX_MAX_REGS registers, but switches may implement fewer.
1481 * Masking: Arbitrary masks. */
1482 #define NXM_NX_MAX_REGS 16
1483 #define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4)
1484 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1485 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1486 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1487 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1488 #define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4)
1489 #define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4)
1490 #define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4)
1491 #define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4)
1492 #define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4)
1493 #define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4)
1494 #define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4)
1495 #define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4)
1496 #define NXM_NX_REG4 NXM_HEADER (0x0001, 4, 4)
1497 #define NXM_NX_REG4_W NXM_HEADER_W(0x0001, 4, 4)
1501 * For a packet received via GRE tunnel including a (32-bit) key, the key is
1502 * stored in the low 32-bits and the high bits are zeroed. For other packets,
1507 * Format: 64-bit integer in network byte order.
1509 * Masking: Arbitrary masks. */
1510 #define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8)
1511 #define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8)
1513 /* For an Ethernet+IP ARP packet, the source or target hardware address
1514 * in the ARP header. Always 0 otherwise.
1516 * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1518 * Format: 48-bit Ethernet MAC address.
1520 * Masking: Not maskable. */
1521 #define NXM_NX_ARP_SHA NXM_HEADER (0x0001, 17, 6)
1522 #define NXM_NX_ARP_THA NXM_HEADER (0x0001, 18, 6)
1524 /* The source or destination address in the IPv6 header.
1526 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1528 * Format: 128-bit IPv6 address.
1530 * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1531 * high-order bits set to 1 and the other 128-N bits set to 0. */
1532 #define NXM_NX_IPV6_SRC NXM_HEADER (0x0001, 19, 16)
1533 #define NXM_NX_IPV6_SRC_W NXM_HEADER_W(0x0001, 19, 16)
1534 #define NXM_NX_IPV6_DST NXM_HEADER (0x0001, 20, 16)
1535 #define NXM_NX_IPV6_DST_W NXM_HEADER_W(0x0001, 20, 16)
1537 /* The type or code in the ICMPv6 header.
1540 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1541 * NXM_OF_IP_PROTO must match 58 exactly.
1543 * Format: 8-bit integer.
1545 * Masking: Not maskable. */
1546 #define NXM_NX_ICMPV6_TYPE NXM_HEADER (0x0001, 21, 1)
1547 #define NXM_NX_ICMPV6_CODE NXM_HEADER (0x0001, 22, 1)
1549 /* The target address in an IPv6 Neighbor Discovery message.
1552 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1553 * NXM_OF_IP_PROTO must match 58 exactly.
1554 * NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1556 * Format: 128-bit IPv6 address.
1558 * Masking: Not maskable. */
1559 #define NXM_NX_ND_TARGET NXM_HEADER (0x0001, 23, 16)
1561 /* The source link-layer address option in an IPv6 Neighbor Discovery
1565 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1566 * NXM_OF_IP_PROTO must match 58 exactly.
1567 * NXM_OF_ICMPV6_TYPE must be exactly 135.
1569 * Format: 48-bit Ethernet MAC address.
1571 * Masking: Not maskable. */
1572 #define NXM_NX_ND_SLL NXM_HEADER (0x0001, 24, 6)
1574 /* The target link-layer address option in an IPv6 Neighbor Discovery
1578 * NXM_OF_ETH_TYPE must match 0x86dd exactly.
1579 * NXM_OF_IP_PROTO must match 58 exactly.
1580 * NXM_OF_ICMPV6_TYPE must be exactly 136.
1582 * Format: 48-bit Ethernet MAC address.
1584 * Masking: Not maskable. */
1585 #define NXM_NX_ND_TLL NXM_HEADER (0x0001, 25, 6)
1587 /* IP fragment information.
1590 * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1592 * Format: 8-bit value with one of the values 0, 1, or 3, as described below.
1594 * Masking: Fully maskable.
1596 * This field has three possible values:
1598 * - A packet that is not an IP fragment has value 0.
1600 * - A packet that is an IP fragment with offset 0 (the first fragment) has
1601 * bit 0 set and thus value 1.
1603 * - A packet that is an IP fragment with nonzero offset has bits 0 and 1 set
1606 * NX_IP_FRAG_ANY and NX_IP_FRAG_LATER are declared to symbolically represent
1607 * the meanings of bits 0 and 1.
1609 * The switch may reject matches against values that can never appear.
1611 * It is important to understand how this field interacts with the OpenFlow IP
1612 * fragment handling mode:
1614 * - In OFPC_FRAG_DROP mode, the OpenFlow switch drops all IP fragments
1615 * before they reach the flow table, so every packet that is available for
1616 * matching will have value 0 in this field.
1618 * - Open vSwitch does not implement OFPC_FRAG_REASM mode, but if it did then
1619 * IP fragments would be reassembled before they reached the flow table and
1620 * again every packet available for matching would always have value 0.
1622 * - In OFPC_FRAG_NORMAL mode, all three values are possible, but OpenFlow
1623 * 1.0 says that fragments' transport ports are always 0, even for the
1624 * first fragment, so this does not provide much extra information.
1626 * - In OFPC_FRAG_NX_MATCH mode, all three values are possible. For
1627 * fragments with offset 0, Open vSwitch makes L4 header information
1630 #define NXM_NX_IP_FRAG NXM_HEADER (0x0001, 26, 1)
1631 #define NXM_NX_IP_FRAG_W NXM_HEADER_W(0x0001, 26, 1)
1633 /* Bits in the value of NXM_NX_IP_FRAG. */
1634 #define NX_IP_FRAG_ANY (1 << 0) /* Is this a fragment? */
1635 #define NX_IP_FRAG_LATER (1 << 1) /* Is this a fragment with nonzero offset? */
1637 /* The flow label in the IPv6 header.
1639 * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1641 * Format: 20-bit IPv6 flow label in least-significant bits.
1643 * Masking: Not maskable. */
1644 #define NXM_NX_IPV6_LABEL NXM_HEADER (0x0001, 27, 4)
1646 /* The ECN of the IP header.
1648 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1650 * Format: ECN in the low-order 2 bits.
1652 * Masking: Not maskable. */
1653 #define NXM_NX_IP_ECN NXM_HEADER (0x0001, 28, 1)
1655 /* The time-to-live/hop limit of the IP header.
1657 * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1659 * Format: 8-bit integer.
1661 * Masking: Not maskable. */
1662 #define NXM_NX_IP_TTL NXM_HEADER (0x0001, 29, 1)
1666 * This may be used to gain the OpenFlow 1.1-like ability to restrict
1667 * certain NXM-based Flow Mod and Flow Stats Request messages to flows
1668 * with specific cookies. See the "nx_flow_mod" and "nx_flow_stats_request"
1669 * structure definitions for more details. This match is otherwise not
1674 * Format: 64-bit integer in network byte order.
1676 * Masking: Arbitrary masks. */
1677 #define NXM_NX_COOKIE NXM_HEADER (0x0001, 30, 8)
1678 #define NXM_NX_COOKIE_W NXM_HEADER_W(0x0001, 30, 8)
1680 /* ## --------------------- ## */
1681 /* ## Requests and replies. ## */
1682 /* ## --------------------- ## */
1684 enum nx_flow_format {
1685 NXFF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */
1686 NXFF_NXM = 2 /* Nicira extended match. */
1689 /* NXT_SET_FLOW_FORMAT request. */
1690 struct nx_set_flow_format {
1691 struct ofp_header header;
1692 ovs_be32 vendor; /* NX_VENDOR_ID. */
1693 ovs_be32 subtype; /* NXT_SET_FLOW_FORMAT. */
1694 ovs_be32 format; /* One of NXFF_*. */
1696 OFP_ASSERT(sizeof(struct nx_set_flow_format) == 20);
1698 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD).
1700 * It is possible to limit flow deletions and modifications to certain
1701 * cookies by using the NXM_NX_COOKIE and NXM_NX_COOKIE_W matches. For
1702 * these commands, the "cookie" field is always ignored. Flow additions
1703 * make use of the "cookie" field and ignore any NXM_NX_COOKIE*
1706 struct nx_flow_mod {
1707 struct nicira_header nxh;
1708 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1709 ovs_be16 command; /* One of OFPFC_*. */
1710 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
1711 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
1712 ovs_be16 priority; /* Priority level of flow entry. */
1713 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
1714 Not meaningful for OFPFC_DELETE*. */
1715 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
1716 matching entries to include this as an
1717 output port. A value of OFPP_NONE
1718 indicates no restriction. */
1719 ovs_be16 flags; /* One of OFPFF_*. */
1720 ovs_be16 match_len; /* Size of nx_match. */
1721 uint8_t pad[6]; /* Align to 64-bits. */
1723 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1724 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1725 * all-zero bytes, then
1726 * - Actions to fill out the remainder of the message length (always a
1730 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
1732 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1733 struct nx_flow_removed {
1734 struct nicira_header nxh;
1735 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1736 ovs_be16 priority; /* Priority level of flow entry. */
1737 uint8_t reason; /* One of OFPRR_*. */
1738 uint8_t pad[1]; /* Align to 32-bits. */
1739 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
1740 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
1742 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
1743 ovs_be16 match_len; /* Size of nx_match. */
1744 ovs_be64 packet_count;
1745 ovs_be64 byte_count;
1747 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1748 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1749 * all-zero bytes. */
1751 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
1753 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1756 * It is possible to limit matches to certain cookies by using the
1757 * NXM_NX_COOKIE and NXM_NX_COOKIE_W matches.
1759 struct nx_flow_stats_request {
1760 struct nicira_stats_msg nsm;
1761 ovs_be16 out_port; /* Require matching entries to include this
1762 as an output port. A value of OFPP_NONE
1763 indicates no restriction. */
1764 ovs_be16 match_len; /* Length of nx_match. */
1765 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1766 or 0xff for all tables. */
1767 uint8_t pad[3]; /* Align to 64 bits. */
1769 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1770 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1771 * all-zero bytes, which must also exactly fill out the length of the
1775 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
1777 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1778 * OFPST_FLOW reply).
1780 * The values of 'idle_age' and 'hard_age' are only meaningful when talking to
1781 * a switch that implements the NXT_FLOW_AGE extension. Zero means that the
1782 * true value is unknown, perhaps because hardware does not track the value.
1783 * (Zero is also the value that one should ordinarily expect to see talking to
1784 * a switch that does not implement NXT_FLOW_AGE, since those switches zero the
1785 * padding bytes that these fields replaced.) A nonzero value X represents X-1
1786 * seconds. A value of 65535 represents 65534 or more seconds.
1788 * 'idle_age' is the number of seconds that the flow has been idle, that is,
1789 * the number of seconds since a packet passed through the flow. 'hard_age' is
1790 * the number of seconds since the flow was last modified (e.g. OFPFC_MODIFY or
1791 * OFPFC_MODIFY_STRICT). (The 'duration_*' fields are the elapsed time since
1792 * the flow was added, regardless of subsequent modifications.)
1794 * For a flow with an idle or hard timeout, 'idle_age' or 'hard_age',
1795 * respectively, will ordinarily be smaller than the timeout, but flow
1796 * expiration times are only approximate and so one must be prepared to
1797 * tolerate expirations that occur somewhat early or late.
1799 struct nx_flow_stats {
1800 ovs_be16 length; /* Length of this entry. */
1801 uint8_t table_id; /* ID of table flow came from. */
1803 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
1804 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
1805 beyond duration_sec. */
1806 ovs_be16 priority; /* Priority of the entry. Only meaningful
1807 when this is not an exact-match entry. */
1808 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
1809 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
1810 ovs_be16 match_len; /* Length of nx_match. */
1811 ovs_be16 idle_age; /* Seconds since last packet, plus one. */
1812 ovs_be16 hard_age; /* Seconds since last modification, plus one. */
1813 ovs_be64 cookie; /* Opaque controller-issued identifier. */
1814 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1815 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1817 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1818 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1819 * all-zero bytes, then
1820 * - Actions to fill out the remainder 'length' bytes (always a multiple
1824 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1826 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1827 * OFPST_AGGREGATE request). */
1828 struct nx_aggregate_stats_request {
1829 struct nicira_stats_msg nsm;
1830 ovs_be16 out_port; /* Require matching entries to include this
1831 as an output port. A value of OFPP_NONE
1832 indicates no restriction. */
1833 ovs_be16 match_len; /* Length of nx_match. */
1834 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
1835 or 0xff for all tables. */
1836 uint8_t pad[3]; /* Align to 64 bits. */
1838 * - Exactly match_len (possibly 0) bytes containing the nx_match, then
1839 * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1840 * all-zero bytes, which must also exactly fill out the length of the
1844 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1846 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1847 * OFPST_AGGREGATE reply). */
1848 struct nx_aggregate_stats_reply {
1849 struct nicira_stats_msg nsm;
1850 ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */
1851 ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */
1852 ovs_be32 flow_count; /* Number of flows. */
1853 uint8_t pad[4]; /* Align to 64 bits. */
1855 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1857 #endif /* openflow/nicira-ext.h */