flow: Adds support for arbitrary ethernet masking
[openvswitch] / include / openflow / nicira-ext.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #ifndef OPENFLOW_NICIRA_EXT_H
18 #define OPENFLOW_NICIRA_EXT_H 1
19
20 #include "openflow/openflow.h"
21 #include "openvswitch/types.h"
22
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. */
26
27 #define NX_VENDOR_ID 0x00002320
28 \f
29 /* Nicira vendor-specific error messages extension.
30  *
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.
36  *
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
41  * request.
42  *
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.
48  *
49  * Currently this extension is only implemented by Open vSwitch, but it seems
50  * like a reasonable candidate for future standardization.
51  */
52
53 /* This is a random number to avoid accidental collision with any other
54  * vendor's extension. */
55 #define NXET_VENDOR 0xb0c2
56
57 /* ofp_error msg 'code' values for NXET_VENDOR. */
58 enum nx_vendor_code {
59     NXVC_VENDOR_ERROR           /* 'data' contains struct nx_vendor_error. */
60 };
61
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. */
68 };
69 \f
70 /* Nicira vendor requests and replies. */
71
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. */
77 };
78 OFP_ASSERT(sizeof(struct nicira_header) == 16);
79
80 /* Values for the 'subtype' member of struct nicira_header. */
81 enum nicira_type {
82     /* No longer used. */
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,
93
94     /* Controller role support.  The request body is struct nx_role_request.
95      * The reply echos the request. */
96     NXT_ROLE_REQUEST = 10,
97     NXT_ROLE_REPLY = 11,
98
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. */
103
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,
108
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. */
112
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. */
116     NXT_FLOW_AGE = 18,
117
118     NXT_SET_ASYNC_CONFIG = 19,  /* struct nx_async_config. */
119     NXT_SET_CONTROLLER_ID = 20, /* struct nx_controller_id. */
120 };
121
122 /* Header for Nicira vendor stats request and reply messages. */
123 struct nicira_stats_msg {
124     struct ofp_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */
125     ovs_be32 subtype;           /* One of NXST_* below. */
126     uint8_t pad[4];             /* Align to 64-bits. */
127 };
128 OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24);
129
130 /* Values for the 'subtype' member of struct nicira_stats_msg. */
131 enum nicira_stats_type {
132     /* Flexible flow specification (aka NXM = Nicira Extended Match). */
133     NXST_FLOW,                  /* Analogous to OFPST_FLOW. */
134     NXST_AGGREGATE              /* Analogous to OFPST_AGGREGATE. */
135 };
136
137 /* Fields to use when hashing flows. */
138 enum nx_hash_fields {
139     /* Ethernet source address (NXM_OF_ETH_SRC) only. */
140     NX_HASH_FIELDS_ETH_SRC,
141
142     /* L2 through L4, symmetric across src/dst.  Specifically, each of the
143      * following fields, if present, is hashed (slashes separate symmetric
144      * pairs):
145      *
146      *  - NXM_OF_ETH_DST / NXM_OF_ETH_SRC
147      *  - NXM_OF_ETH_TYPE
148      *  - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI.
149      *  - NXM_OF_IP_PROTO
150      *  - NXM_OF_IP_SRC / NXM_OF_IP_DST
151      *  - NXM_OF_TCP_SRC / NXM_OF_TCP_DST
152      */
153     NX_HASH_FIELDS_SYMMETRIC_L4
154 };
155
156 /* This command enables or disables an Open vSwitch extension that allows a
157  * controller to specify the OpenFlow table to which a flow should be added,
158  * instead of having the switch decide which table is most appropriate as
159  * required by OpenFlow 1.0.  By default, the extension is disabled.
160  *
161  * When this feature is enabled, Open vSwitch treats struct ofp_flow_mod's
162  * 16-bit 'command' member as two separate fields.  The upper 8 bits are used
163  * as the table ID, the lower 8 bits specify the command as usual.  A table ID
164  * of 0xff is treated like a wildcarded table ID.
165  *
166  * The specific treatment of the table ID depends on the type of flow mod:
167  *
168  *    - OFPFC_ADD: Given a specific table ID, the flow is always placed in that
169  *      table.  If an identical flow already exists in that table only, then it
170  *      is replaced.  If the flow cannot be placed in the specified table,
171  *      either because the table is full or because the table cannot support
172  *      flows of the given type, the switch replies with an
173  *      OFPFMFC_ALL_TABLES_FULL error.  (A controller can distinguish these
174  *      cases by comparing the current and maximum number of entries reported
175  *      in ofp_table_stats.)
176  *
177  *      If the table ID is wildcarded, the switch picks an appropriate table
178  *      itself.  If an identical flow already exist in the selected flow table,
179  *      then it is replaced.  The choice of table might depend on the flows
180  *      that are already in the switch; for example, if one table fills up then
181  *      the switch might fall back to another one.
182  *
183  *    - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows
184  *      within that table are matched and modified or deleted.  If the table ID
185  *      is wildcarded, flows within any table may be matched and modified or
186  *      deleted.
187  *
188  *    - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID,
189  *      only a flow within that table may be matched and modified or deleted.
190  *      If the table ID is wildcarded and exactly one flow within any table
191  *      matches, then it is modified or deleted; if flows in more than one
192  *      table match, then none is modified or deleted.
193  */
194 struct nx_flow_mod_table_id {
195     struct ofp_header header;
196     ovs_be32 vendor;            /* NX_VENDOR_ID. */
197     ovs_be32 subtype;           /* NXT_FLOW_MOD_TABLE_ID. */
198     uint8_t set;                /* Nonzero to enable, zero to disable. */
199     uint8_t pad[7];
200 };
201 OFP_ASSERT(sizeof(struct nx_flow_mod_table_id) == 24);
202
203 enum nx_packet_in_format {
204     NXPIF_OPENFLOW10 = 0,       /* Standard OpenFlow 1.0 compatible. */
205     NXPIF_NXM = 1               /* Nicira Extended. */
206 };
207
208 /* NXT_SET_PACKET_IN_FORMAT request. */
209 struct nx_set_packet_in_format {
210     struct nicira_header nxh;
211     ovs_be32 format;            /* One of NXPIF_*. */
212 };
213 OFP_ASSERT(sizeof(struct nx_set_packet_in_format) == 20);
214
215 /* NXT_PACKET_IN (analogous to OFPT_PACKET_IN).
216  *
217  * The NXT_PACKET_IN format is intended to model the OpenFlow-1.2 PACKET_IN
218  * with some minor tweaks.  Most notably NXT_PACKET_IN includes the cookie of
219  * the rule which triggered the NXT_PACKET_IN message, and the match fields are
220  * in NXM format.
221  *
222  * The match fields in the NXT_PACKET_IN are intended to contain flow
223  * processing metadata collected at the time the NXT_PACKET_IN message was
224  * triggered.  It is minimally required to contain the NXM_OF_IN_PORT of the
225  * packet, but may include other NXM headers such as flow registers.  The match
226  * fields are allowed to contain non-metadata (e.g. NXM_OF_ETH_SRC etc).
227  * However, this information can typically be found in the packet directly, so
228  * it may be redundant.
229  *
230  * Whereas in most cases a controller can expect to only get back NXM fields
231  * that it set up itself (e.g. flow dumps will ordinarily report only NXM
232  * fields from flows that the controller added), NXT_PACKET_IN messages might
233  * contain fields that the controller does not understand, because the switch
234  * might support fields (new registers, new protocols, etc.) that the
235  * controller does not. Â The controller must prepared to tolerate these.
236  *
237  * The 'cookie' and 'table_id' fields have no meaning when 'reason' is
238  * OFPR_NO_MATCH.  In this case they should be set to 0. */
239 struct nx_packet_in {
240     struct nicira_header nxh;
241     ovs_be32 buffer_id;       /* ID assigned by datapath. */
242     ovs_be16 total_len;       /* Full length of frame. */
243     uint8_t reason;           /* Reason packet is sent (one of OFPR_*). */
244     uint8_t table_id;         /* ID of the table that was looked up. */
245     ovs_be64 cookie;          /* Cookie of the rule that was looked up. */
246     ovs_be16 match_len;       /* Size of nx_match. */
247     uint8_t pad[6];           /* Align to 64-bits. */
248     /* Followed by:
249      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
250      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
251      *     all-zero bytes, then
252      *   - Exactly 2 all-zero padding bytes, then
253      *   - An Ethernet frame whose length is inferred from nxh.header.length.
254      *
255      * The padding bytes preceding the Ethernet frame ensure that the IP
256      * header (if any) following the Ethernet header is 32-bit aligned. */
257
258     /* uint8_t nxm_fields[...]; */ /* Match. */
259     /* uint8_t pad[2]; */          /* Align to 64 bit + 16 bit. */
260     /* uint8_t data[0]; */         /* Ethernet frame. */
261 };
262 OFP_ASSERT(sizeof(struct nx_packet_in) == 40);
263
264 /* Configures the "role" of the sending controller.  The default role is:
265  *
266  *    - Other (NX_ROLE_OTHER), which allows the controller access to all
267  *      OpenFlow features.
268  *
269  * The other possible roles are a related pair:
270  *
271  *    - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may
272  *      be at most one Master controller at a time: when a controller
273  *      configures itself as Master, any existing Master is demoted to the
274  *      Slave role.
275  *
276  *    - Slave (NX_ROLE_SLAVE) allows the controller read-only access to
277  *      OpenFlow features.  In particular attempts to modify the flow table
278  *      will be rejected with an OFPBRC_EPERM error.
279  *
280  *      Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED
281  *      messages, but they do receive OFPT_PORT_STATUS messages.
282  */
283 struct nx_role_request {
284     struct nicira_header nxh;
285     ovs_be32 role;              /* One of NX_ROLE_*. */
286 };
287 OFP_ASSERT(sizeof(struct nx_role_request) == 20);
288
289 enum nx_role {
290     NX_ROLE_OTHER,              /* Default role, full access. */
291     NX_ROLE_MASTER,             /* Full access, at most one. */
292     NX_ROLE_SLAVE               /* Read-only access. */
293 };
294
295 /* NXT_SET_ASYNC_CONFIG.
296  *
297  * Sent by a controller, this message configures the asynchronous messages that
298  * the controller wants to receive.  Element 0 in each array specifies messages
299  * of interest when the controller has an "other" or "master" role; element 1,
300  * when the controller has a "slave" role.
301  *
302  * Each array element is a bitmask in which a 0-bit disables receiving a
303  * particular message and a 1-bit enables receiving it.  Each bit controls the
304  * message whose 'reason' corresponds to the bit index.  For example, the bit
305  * with value 1<<2 == 4 in port_status_mask[1] determines whether the
306  * controller will receive OFPT_PORT_STATUS messages with reason OFPPR_MODIFY
307  * (value 2) when the controller has a "slave" role.
308  */
309 struct nx_async_config {
310     struct nicira_header nxh;
311     ovs_be32 packet_in_mask[2];    /* Bitmasks of OFPR_* values. */
312     ovs_be32 port_status_mask[2];  /* Bitmasks of OFPRR_* values. */
313     ovs_be32 flow_removed_mask[2]; /* Bitmasks of OFPPR_* values. */
314 };
315 OFP_ASSERT(sizeof(struct nx_async_config) == 40);
316 \f
317 /* Nicira vendor flow actions. */
318
319 enum nx_action_subtype {
320     NXAST_SNAT__OBSOLETE,       /* No longer used. */
321     NXAST_RESUBMIT,             /* struct nx_action_resubmit */
322     NXAST_SET_TUNNEL,           /* struct nx_action_set_tunnel */
323     NXAST_DROP_SPOOFED_ARP__OBSOLETE,
324     NXAST_SET_QUEUE,            /* struct nx_action_set_queue */
325     NXAST_POP_QUEUE,            /* struct nx_action_pop_queue */
326     NXAST_REG_MOVE,             /* struct nx_action_reg_move */
327     NXAST_REG_LOAD,             /* struct nx_action_reg_load */
328     NXAST_NOTE,                 /* struct nx_action_note */
329     NXAST_SET_TUNNEL64,         /* struct nx_action_set_tunnel64 */
330     NXAST_MULTIPATH,            /* struct nx_action_multipath */
331     NXAST_AUTOPATH,             /* struct nx_action_autopath */
332     NXAST_BUNDLE,               /* struct nx_action_bundle */
333     NXAST_BUNDLE_LOAD,          /* struct nx_action_bundle */
334     NXAST_RESUBMIT_TABLE,       /* struct nx_action_resubmit */
335     NXAST_OUTPUT_REG,           /* struct nx_action_output_reg */
336     NXAST_LEARN,                /* struct nx_action_learn */
337     NXAST_EXIT,                 /* struct nx_action_header */
338     NXAST_DEC_TTL,              /* struct nx_action_header */
339     NXAST_FIN_TIMEOUT,          /* struct nx_action_fin_timeout */
340     NXAST_CONTROLLER,           /* struct nx_action_controller */
341 };
342
343 /* Header for Nicira-defined actions. */
344 struct nx_action_header {
345     ovs_be16 type;                  /* OFPAT_VENDOR. */
346     ovs_be16 len;                   /* Length is 16. */
347     ovs_be32 vendor;                /* NX_VENDOR_ID. */
348     ovs_be16 subtype;               /* NXAST_*. */
349     uint8_t pad[6];
350 };
351 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
352
353 /* Action structures for NXAST_RESUBMIT and NXAST_RESUBMIT_TABLE.
354  *
355  * These actions search one of the switch's flow tables:
356  *
357  *    - For NXAST_RESUBMIT_TABLE only, if the 'table' member is not 255, then
358  *      it specifies the table to search.
359  *
360  *    - Otherwise (for NXAST_RESUBMIT_TABLE with a 'table' of 255, or for
361  *      NXAST_RESUBMIT regardless of 'table'), it searches the current flow
362  *      table, that is, the OpenFlow flow table that contains the flow from
363  *      which this action was obtained.  If this action did not come from a
364  *      flow table (e.g. it came from an OFPT_PACKET_OUT message), then table 0
365  *      is the current table.
366  *
367  * The flow table lookup uses a flow that may be slightly modified from the
368  * original lookup:
369  *
370  *    - For NXAST_RESUBMIT, the 'in_port' member of struct nx_action_resubmit
371  *      is used as the flow's in_port.
372  *
373  *    - For NXAST_RESUBMIT_TABLE, if the 'in_port' member is not OFPP_IN_PORT,
374  *      then its value is used as the flow's in_port.  Otherwise, the original
375  *      in_port is used.
376  *
377  *    - If actions that modify the flow (e.g. OFPAT_SET_VLAN_VID) precede the
378  *      resubmit action, then the flow is updated with the new values.
379  *
380  * Following the lookup, the original in_port is restored.
381  *
382  * If the modified flow matched in the flow table, then the corresponding
383  * actions are executed.  Afterward, actions following the resubmit in the
384  * original set of actions, if any, are executed; any changes made to the
385  * packet (e.g. changes to VLAN) by secondary actions persist when those
386  * actions are executed, although the original in_port is restored.
387  *
388  * Resubmit actions may be used any number of times within a set of actions.
389  *
390  * Resubmit actions may nest to an implementation-defined depth.  Beyond this
391  * implementation-defined depth, further resubmit actions are simply ignored.
392  *
393  * NXAST_RESUBMIT ignores 'table' and 'pad'.  NXAST_RESUBMIT_TABLE requires
394  * 'pad' to be all-bits-zero.
395  *
396  * Open vSwitch 1.0.1 and earlier did not support recursion.  Open vSwitch
397  * before 1.2.90 did not support NXAST_RESUBMIT_TABLE.
398  */
399 struct nx_action_resubmit {
400     ovs_be16 type;                  /* OFPAT_VENDOR. */
401     ovs_be16 len;                   /* Length is 16. */
402     ovs_be32 vendor;                /* NX_VENDOR_ID. */
403     ovs_be16 subtype;               /* NXAST_RESUBMIT. */
404     ovs_be16 in_port;               /* New in_port for checking flow table. */
405     uint8_t table;                  /* NXAST_RESUBMIT_TABLE: table to use. */
406     uint8_t pad[3];
407 };
408 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
409
410 /* Action structure for NXAST_SET_TUNNEL.
411  *
412  * Sets the encapsulating tunnel ID to a 32-bit value.  The most-significant 32
413  * bits of the tunnel ID are set to 0. */
414 struct nx_action_set_tunnel {
415     ovs_be16 type;                  /* OFPAT_VENDOR. */
416     ovs_be16 len;                   /* Length is 16. */
417     ovs_be32 vendor;                /* NX_VENDOR_ID. */
418     ovs_be16 subtype;               /* NXAST_SET_TUNNEL. */
419     uint8_t pad[2];
420     ovs_be32 tun_id;                /* Tunnel ID. */
421 };
422 OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16);
423
424 /* Action structure for NXAST_SET_TUNNEL64.
425  *
426  * Sets the encapsulating tunnel ID to a 64-bit value. */
427 struct nx_action_set_tunnel64 {
428     ovs_be16 type;                  /* OFPAT_VENDOR. */
429     ovs_be16 len;                   /* Length is 16. */
430     ovs_be32 vendor;                /* NX_VENDOR_ID. */
431     ovs_be16 subtype;               /* NXAST_SET_TUNNEL64. */
432     uint8_t pad[6];
433     ovs_be64 tun_id;                /* Tunnel ID. */
434 };
435 OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24);
436
437 /* Action structure for NXAST_SET_QUEUE.
438  *
439  * Set the queue that should be used when packets are output.  This is similar
440  * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as
441  * an argument.  This allows the queue to be defined before the port is
442  * known. */
443 struct nx_action_set_queue {
444     ovs_be16 type;                  /* OFPAT_VENDOR. */
445     ovs_be16 len;                   /* Length is 16. */
446     ovs_be32 vendor;                /* NX_VENDOR_ID. */
447     ovs_be16 subtype;               /* NXAST_SET_QUEUE. */
448     uint8_t pad[2];
449     ovs_be32 queue_id;              /* Where to enqueue packets. */
450 };
451 OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16);
452
453 /* Action structure for NXAST_POP_QUEUE.
454  *
455  * Restores the queue to the value it was before any NXAST_SET_QUEUE actions
456  * were used.  Only the original queue can be restored this way; no stack is
457  * maintained. */
458 struct nx_action_pop_queue {
459     ovs_be16 type;                  /* OFPAT_VENDOR. */
460     ovs_be16 len;                   /* Length is 16. */
461     ovs_be32 vendor;                /* NX_VENDOR_ID. */
462     ovs_be16 subtype;               /* NXAST_POP_QUEUE. */
463     uint8_t pad[6];
464 };
465 OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16);
466
467 /* Action structure for NXAST_REG_MOVE.
468  *
469  * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where
470  * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including
471  * bit 'c').  Bit numbering starts at 0 for the least-significant bit, 1 for
472  * the next most significant bit, and so on.
473  *
474  * 'src' and 'dst' are nxm_header values with nxm_hasmask=0.  (It doesn't make
475  * sense to use nxm_hasmask=1 because the action does not do any kind of
476  * matching; it uses the actual value of a field.)
477  *
478  * The following nxm_header values are potentially acceptable as 'src':
479  *
480  *   - NXM_OF_IN_PORT
481  *   - NXM_OF_ETH_DST
482  *   - NXM_OF_ETH_SRC
483  *   - NXM_OF_ETH_TYPE
484  *   - NXM_OF_VLAN_TCI
485  *   - NXM_OF_IP_TOS
486  *   - NXM_OF_IP_PROTO
487  *   - NXM_OF_IP_SRC
488  *   - NXM_OF_IP_DST
489  *   - NXM_OF_TCP_SRC
490  *   - NXM_OF_TCP_DST
491  *   - NXM_OF_UDP_SRC
492  *   - NXM_OF_UDP_DST
493  *   - NXM_OF_ICMP_TYPE
494  *   - NXM_OF_ICMP_CODE
495  *   - NXM_OF_ARP_OP
496  *   - NXM_OF_ARP_SPA
497  *   - NXM_OF_ARP_TPA
498  *   - NXM_NX_TUN_ID
499  *   - NXM_NX_ARP_SHA
500  *   - NXM_NX_ARP_THA
501  *   - NXM_NX_ICMPV6_TYPE
502  *   - NXM_NX_ICMPV6_CODE
503  *   - NXM_NX_ND_SLL
504  *   - NXM_NX_ND_TLL
505  *   - NXM_NX_REG(idx) for idx in the switch's accepted range.
506  *
507  * The following nxm_header values are potentially acceptable as 'dst':
508  *
509  *   - NXM_OF_ETH_DST
510  *   - NXM_OF_ETH_SRC
511  *   - NXM_OF_IP_TOS
512  *   - NXM_OF_IP_SRC
513  *   - NXM_OF_IP_DST
514  *   - NXM_OF_TCP_SRC
515  *   - NXM_OF_TCP_DST
516  *   - NXM_OF_UDP_SRC
517  *   - NXM_OF_UDP_DST
518  *     Modifying any of the above fields changes the corresponding packet
519  *     header.
520  *
521  *   - NXM_NX_REG(idx) for idx in the switch's accepted range.
522  *
523  *   - NXM_OF_VLAN_TCI.  Modifying this field's value has side effects on the
524  *     packet's 802.1Q header.  Setting a value with CFI=0 removes the 802.1Q
525  *     header (if any), ignoring the other bits.  Setting a value with CFI=1
526  *     adds or modifies the 802.1Q header appropriately, setting the TCI field
527  *     to the field's new value (with the CFI bit masked out).
528  *
529  *   - NXM_NX_TUN_ID.  Modifying this value modifies the tunnel ID used for the
530  *     packet's next tunnel encapsulation.
531  *
532  * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose
533  * nx_match satisfies its prerequisites.  For example, NXM_OF_IP_TOS may be
534  * used only if the flow's nx_match includes an nxm_entry that specifies
535  * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800.
536  *
537  * The switch will reject actions for which src_ofs+n_bits is greater than the
538  * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with
539  * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
540  */
541 struct nx_action_reg_move {
542     ovs_be16 type;                  /* OFPAT_VENDOR. */
543     ovs_be16 len;                   /* Length is 16. */
544     ovs_be32 vendor;                /* NX_VENDOR_ID. */
545     ovs_be16 subtype;               /* NXAST_REG_MOVE. */
546     ovs_be16 n_bits;                /* Number of bits. */
547     ovs_be16 src_ofs;               /* Starting bit offset in source. */
548     ovs_be16 dst_ofs;               /* Starting bit offset in destination. */
549     ovs_be32 src;                   /* Source register. */
550     ovs_be32 dst;                   /* Destination register. */
551 };
552 OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24);
553
554 /* Action structure for NXAST_REG_LOAD.
555  *
556  * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits
557  * within 'a' numbered 'b' through 'c' (not including bit 'c').  Bit numbering
558  * starts at 0 for the least-significant bit, 1 for the next most significant
559  * bit, and so on.
560  *
561  * 'dst' is an nxm_header with nxm_hasmask=0.  See the documentation for
562  * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of
563  * loading them.
564  *
565  * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field
566  * to avoid enlarging the structure by another 8 bytes.  To allow 'n_bits' to
567  * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is
568  * also stored as one less than its true value:
569  *
570  *  15                           6 5                0
571  * +------------------------------+------------------+
572  * |              ofs             |    n_bits - 1    |
573  * +------------------------------+------------------+
574  *
575  * The switch will reject actions for which ofs+n_bits is greater than the
576  * width of 'dst', or in which any bits in 'value' with value 2**n_bits or
577  * greater are set to 1, with error type OFPET_BAD_ACTION, code
578  * OFPBAC_BAD_ARGUMENT.
579  */
580 struct nx_action_reg_load {
581     ovs_be16 type;                  /* OFPAT_VENDOR. */
582     ovs_be16 len;                   /* Length is 16. */
583     ovs_be32 vendor;                /* NX_VENDOR_ID. */
584     ovs_be16 subtype;               /* NXAST_REG_LOAD. */
585     ovs_be16 ofs_nbits;             /* (ofs << 6) | (n_bits - 1). */
586     ovs_be32 dst;                   /* Destination register. */
587     ovs_be64 value;                 /* Immediate value. */
588 };
589 OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24);
590
591 /* Action structure for NXAST_NOTE.
592  *
593  * This action has no effect.  It is variable length.  The switch does not
594  * attempt to interpret the user-defined 'note' data in any way.  A controller
595  * can use this action to attach arbitrary metadata to a flow.
596  *
597  * This action might go away in the future.
598  */
599 struct nx_action_note {
600     ovs_be16 type;                  /* OFPAT_VENDOR. */
601     ovs_be16 len;                   /* A multiple of 8, but at least 16. */
602     ovs_be32 vendor;                /* NX_VENDOR_ID. */
603     ovs_be16 subtype;               /* NXAST_NOTE. */
604     uint8_t note[6];                /* Start of user-defined data. */
605     /* Possibly followed by additional user-defined data. */
606 };
607 OFP_ASSERT(sizeof(struct nx_action_note) == 16);
608
609 /* Action structure for NXAST_MULTIPATH.
610  *
611  * This action performs the following steps in sequence:
612  *
613  *    1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*.
614  *       Refer to the definition of "enum nx_mp_fields" for details.
615  *
616  *       The 'basis' value is used as a universal hash parameter, that is,
617  *       different values of 'basis' yield different hash functions.  The
618  *       particular universal hash function used is implementation-defined.
619  *
620  *       The hashed fields' values are drawn from the current state of the
621  *       flow, including all modifications that have been made by actions up to
622  *       this point.
623  *
624  *    2. Applies the multipath link choice algorithm specified by 'algorithm',
625  *       one of NX_MP_ALG_*.  Refer to the definition of "enum nx_mp_algorithm"
626  *       for details.
627  *
628  *       The output of the algorithm is 'link', an unsigned integer less than
629  *       or equal to 'max_link'.
630  *
631  *       Some algorithms use 'arg' as an additional argument.
632  *
633  *    3. Stores 'link' in dst[ofs:ofs+n_bits].  The format and semantics of
634  *       'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD
635  *       action.
636  *
637  * The switch will reject actions that have an unknown 'fields', or an unknown
638  * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or
639  * in which 'max_link' is greater than or equal to 2**n_bits, with error type
640  * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
641  */
642 struct nx_action_multipath {
643     ovs_be16 type;              /* OFPAT_VENDOR. */
644     ovs_be16 len;               /* Length is 32. */
645     ovs_be32 vendor;            /* NX_VENDOR_ID. */
646     ovs_be16 subtype;           /* NXAST_MULTIPATH. */
647
648     /* What fields to hash and how. */
649     ovs_be16 fields;            /* One of NX_HASH_FIELDS_*. */
650     ovs_be16 basis;             /* Universal hash parameter. */
651     ovs_be16 pad0;
652
653     /* Multipath link choice algorithm to apply to hash value. */
654     ovs_be16 algorithm;         /* One of NX_MP_ALG_*. */
655     ovs_be16 max_link;          /* Number of output links, minus 1. */
656     ovs_be32 arg;               /* Algorithm-specific argument. */
657     ovs_be16 pad1;
658
659     /* Where to store the result. */
660     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
661     ovs_be32 dst;               /* Destination. */
662 };
663 OFP_ASSERT(sizeof(struct nx_action_multipath) == 32);
664
665 /* NXAST_MULTIPATH: Multipath link choice algorithm to apply.
666  *
667  * In the descriptions below, 'n_links' is max_link + 1. */
668 enum nx_mp_algorithm {
669     /* link = hash(flow) % n_links.
670      *
671      * Redistributes all traffic when n_links changes.  O(1) performance.  See
672      * RFC 2992.
673      *
674      * Use UINT16_MAX for max_link to get a raw hash value. */
675     NX_MP_ALG_MODULO_N,
676
677     /* link = hash(flow) / (MAX_HASH / n_links).
678      *
679      * Redistributes between one-quarter and one-half of traffic when n_links
680      * changes.  O(1) performance.  See RFC 2992.
681      */
682     NX_MP_ALG_HASH_THRESHOLD,
683
684     /* for i in [0,n_links):
685      *   weights[i] = hash(flow, i)
686      * link = { i such that weights[i] >= weights[j] for all j != i }
687      *
688      * Redistributes 1/n_links of traffic when n_links changes.  O(n_links)
689      * performance.  If n_links is greater than a threshold (currently 64, but
690      * subject to change), Open vSwitch will substitute another algorithm
691      * automatically.  See RFC 2992. */
692     NX_MP_ALG_HRW,              /* Highest Random Weight. */
693
694     /* i = 0
695      * repeat:
696      *     i = i + 1
697      *     link = hash(flow, i) % arg
698      * while link > max_link
699      *
700      * Redistributes 1/n_links of traffic when n_links changes.  O(1)
701      * performance when arg/max_link is bounded by a constant.
702      *
703      * Redistributes all traffic when arg changes.
704      *
705      * arg must be greater than max_link and for best performance should be no
706      * more than approximately max_link * 2.  If arg is outside the acceptable
707      * range, Open vSwitch will automatically substitute the least power of 2
708      * greater than max_link.
709      *
710      * This algorithm is specific to Open vSwitch.
711      */
712     NX_MP_ALG_ITER_HASH         /* Iterative Hash. */
713 };
714 \f
715 /* Action structure for NXAST_LEARN.
716  *
717  * This action adds or modifies a flow in an OpenFlow table, similar to
718  * OFPT_FLOW_MOD with OFPFC_MODIFY_STRICT as 'command'.  The new flow has the
719  * specified idle timeout, hard timeout, priority, cookie, and flags.  The new
720  * flow's match criteria and actions are built by applying each of the series
721  * of flow_mod_spec elements included as part of the action.
722  *
723  * A flow_mod_spec starts with a 16-bit header.  A header that is all-bits-0 is
724  * a no-op used for padding the action as a whole to a multiple of 8 bytes in
725  * length.  Otherwise, the flow_mod_spec can be thought of as copying 'n_bits'
726  * bits from a source to a destination.  In this case, the header contains
727  * multiple fields:
728  *
729  *  15  14  13 12  11 10                              0
730  * +------+---+------+---------------------------------+
731  * |   0  |src|  dst |             n_bits              |
732  * +------+---+------+---------------------------------+
733  *
734  * The meaning and format of a flow_mod_spec depends on 'src' and 'dst'.  The
735  * following table summarizes the meaning of each possible combination.
736  * Details follow the table:
737  *
738  *   src dst  meaning
739  *   --- ---  ----------------------------------------------------------
740  *    0   0   Add match criteria based on value in a field.
741  *    1   0   Add match criteria based on an immediate value.
742  *    0   1   Add NXAST_REG_LOAD action to copy field into a different field.
743  *    1   1   Add NXAST_REG_LOAD action to load immediate value into a field.
744  *    0   2   Add OFPAT_OUTPUT action to output to port from specified field.
745  *   All other combinations are undefined and not allowed.
746  *
747  * The flow_mod_spec header is followed by a source specification and a
748  * destination specification.  The format and meaning of the source
749  * specification depends on 'src':
750  *
751  *   - If 'src' is 0, the source bits are taken from a field in the flow to
752  *     which this action is attached.  (This should be a wildcarded field.  If
753  *     its value is fully specified then the source bits being copied have
754  *     constant values.)
755  *
756  *     The source specification is an ovs_be32 'field' and an ovs_be16 'ofs'.
757  *     'field' is an nxm_header with nxm_hasmask=0, and 'ofs' the starting bit
758  *     offset within that field.  The source bits are field[ofs:ofs+n_bits-1].
759  *     'field' and 'ofs' are subject to the same restrictions as the source
760  *     field in NXAST_REG_MOVE.
761  *
762  *   - If 'src' is 1, the source bits are a constant value.  The source
763  *     specification is (n_bits+15)/16*2 bytes long.  Taking those bytes as a
764  *     number in network order, the source bits are the 'n_bits'
765  *     least-significant bits.  The switch will report an error if other bits
766  *     in the constant are nonzero.
767  *
768  * The flow_mod_spec destination specification, for 'dst' of 0 or 1, is an
769  * ovs_be32 'field' and an ovs_be16 'ofs'.  'field' is an nxm_header with
770  * nxm_hasmask=0 and 'ofs' is a starting bit offset within that field.  The
771  * meaning of the flow_mod_spec depends on 'dst':
772  *
773  *   - If 'dst' is 0, the flow_mod_spec specifies match criteria for the new
774  *     flow.  The new flow matches only if bits field[ofs:ofs+n_bits-1] in a
775  *     packet equal the source bits.  'field' may be any nxm_header with
776  *     nxm_hasmask=0 that is allowed in NXT_FLOW_MOD.
777  *
778  *     Order is significant.  Earlier flow_mod_specs must satisfy any
779  *     prerequisites for matching fields specified later, by copying constant
780  *     values into prerequisite fields.
781  *
782  *     The switch will reject flow_mod_specs that do not satisfy NXM masking
783  *     restrictions.
784  *
785  *   - If 'dst' is 1, the flow_mod_spec specifies an NXAST_REG_LOAD action for
786  *     the new flow.  The new flow copies the source bits into
787  *     field[ofs:ofs+n_bits-1].  Actions are executed in the same order as the
788  *     flow_mod_specs.
789  *
790  *     A single NXAST_REG_LOAD action writes no more than 64 bits, so n_bits
791  *     greater than 64 yields multiple NXAST_REG_LOAD actions.
792  *
793  * The flow_mod_spec destination spec for 'dst' of 2 (when 'src' is 0) is
794  * empty.  It has the following meaning:
795  *
796  *   - The flow_mod_spec specifies an OFPAT_OUTPUT action for the new flow.
797  *     The new flow outputs to the OpenFlow port specified by the source field.
798  *     Of the special output ports with value OFPP_MAX or larger, OFPP_IN_PORT,
799  *     OFPP_FLOOD, OFPP_LOCAL, and OFPP_ALL are supported.  Other special ports
800  *     may not be used.
801  *
802  * Resource Management
803  * -------------------
804  *
805  * A switch has a finite amount of flow table space available for learning.
806  * When this space is exhausted, no new learning table entries will be learned
807  * until some existing flow table entries expire.  The controller should be
808  * prepared to handle this by flooding (which can be implemented as a
809  * low-priority flow).
810  *
811  * If a learned flow matches a single TCP stream with a relatively long
812  * timeout, one may make the best of resource constraints by setting
813  * 'fin_idle_timeout' or 'fin_hard_timeout' (both measured in seconds), or
814  * both, to shorter timeouts.  When either of these is specified as a nonzero
815  * value, OVS adds a NXAST_FIN_TIMEOUT action, with the specified timeouts, to
816  * the learned flow.
817  *
818  * Examples
819  * --------
820  *
821  * The following examples give a prose description of the flow_mod_specs along
822  * with informal notation for how those would be represented and a hex dump of
823  * the bytes that would be required.
824  *
825  * These examples could work with various nx_action_learn parameters.  Typical
826  * values would be idle_timeout=OFP_FLOW_PERMANENT, hard_timeout=60,
827  * priority=OFP_DEFAULT_PRIORITY, flags=0, table_id=10.
828  *
829  * 1. Learn input port based on the source MAC, with lookup into
830  *    NXM_NX_REG1[16:31] by resubmit to in_port=99:
831  *
832  *    Match on in_port=99:
833  *       ovs_be16(src=1, dst=0, n_bits=16),               20 10
834  *       ovs_be16(99),                                    00 63
835  *       ovs_be32(NXM_OF_IN_PORT), ovs_be16(0)            00 00 00 02 00 00
836  *
837  *    Match Ethernet destination on Ethernet source from packet:
838  *       ovs_be16(src=0, dst=0, n_bits=48),               00 30
839  *       ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0)            00 00 04 06 00 00
840  *       ovs_be32(NXM_OF_ETH_DST), ovs_be16(0)            00 00 02 06 00 00
841  *
842  *    Set NXM_NX_REG1[16:31] to the packet's input port:
843  *       ovs_be16(src=0, dst=1, n_bits=16),               08 10
844  *       ovs_be32(NXM_OF_IN_PORT), ovs_be16(0)            00 00 00 02 00 00
845  *       ovs_be32(NXM_NX_REG1), ovs_be16(16)              00 01 02 04 00 10
846  *
847  *    Given a packet that arrived on port A with Ethernet source address B,
848  *    this would set up the flow "in_port=99, dl_dst=B,
849  *    actions=load:A->NXM_NX_REG1[16..31]".
850  *
851  *    In syntax accepted by ovs-ofctl, this action is: learn(in_port=99,
852  *    NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
853  *    load:NXM_OF_IN_PORT[]->NXM_NX_REG1[16..31])
854  *
855  * 2. Output to input port based on the source MAC and VLAN VID, with lookup
856  *    into NXM_NX_REG1[16:31]:
857  *
858  *    Match on same VLAN ID as packet:
859  *       ovs_be16(src=0, dst=0, n_bits=12),               00 0c
860  *       ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0)           00 00 08 02 00 00
861  *       ovs_be32(NXM_OF_VLAN_TCI), ovs_be16(0)           00 00 08 02 00 00
862  *
863  *    Match Ethernet destination on Ethernet source from packet:
864  *       ovs_be16(src=0, dst=0, n_bits=48),               00 30
865  *       ovs_be32(NXM_OF_ETH_SRC), ovs_be16(0)            00 00 04 06 00 00
866  *       ovs_be32(NXM_OF_ETH_DST), ovs_be16(0)            00 00 02 06 00 00
867  *
868  *    Output to the packet's input port:
869  *       ovs_be16(src=0, dst=2, n_bits=16),               10 10
870  *       ovs_be32(NXM_OF_IN_PORT), ovs_be16(0)            00 00 00 02 00 00
871  *
872  *    Given a packet that arrived on port A with Ethernet source address B in
873  *    VLAN C, this would set up the flow "dl_dst=B, vlan_vid=C,
874  *    actions=output:A".
875  *
876  *    In syntax accepted by ovs-ofctl, this action is:
877  *    learn(NXM_OF_VLAN_TCI[0..11], NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],
878  *    output:NXM_OF_IN_PORT[])
879  *
880  * 3. Here's a recipe for a very simple-minded MAC learning switch.  It uses a
881  *    10-second MAC expiration time to make it easier to see what's going on
882  *
883  *      ovs-vsctl del-controller br0
884  *      ovs-ofctl del-flows br0
885  *      ovs-ofctl add-flow br0 "table=0 actions=learn(table=1, \
886           hard_timeout=10, NXM_OF_VLAN_TCI[0..11],             \
887           NXM_OF_ETH_DST[]=NXM_OF_ETH_SRC[],                   \
888           output:NXM_OF_IN_PORT[]), resubmit(,1)"
889  *      ovs-ofctl add-flow br0 "table=1 priority=0 actions=flood"
890  *
891  *    You can then dump the MAC learning table with:
892  *
893  *      ovs-ofctl dump-flows br0 table=1
894  *
895  * Usage Advice
896  * ------------
897  *
898  * For best performance, segregate learned flows into a table that is not used
899  * for any other flows except possibly for a lowest-priority "catch-all" flow
900  * (a flow with no match criteria).  If different learning actions specify
901  * different match criteria, use different tables for the learned flows.
902  *
903  * The meaning of 'hard_timeout' and 'idle_timeout' can be counterintuitive.
904  * These timeouts apply to the flow that is added, which means that a flow with
905  * an idle timeout will expire when no traffic has been sent *to* the learned
906  * address.  This is not usually the intent in MAC learning; instead, we want
907  * the MAC learn entry to expire when no traffic has been sent *from* the
908  * learned address.  Use a hard timeout for that.
909  */
910 struct nx_action_learn {
911     ovs_be16 type;              /* OFPAT_VENDOR. */
912     ovs_be16 len;               /* At least 24. */
913     ovs_be32 vendor;            /* NX_VENDOR_ID. */
914     ovs_be16 subtype;           /* NXAST_LEARN. */
915     ovs_be16 idle_timeout;      /* Idle time before discarding (seconds). */
916     ovs_be16 hard_timeout;      /* Max time before discarding (seconds). */
917     ovs_be16 priority;          /* Priority level of flow entry. */
918     ovs_be64 cookie;            /* Cookie for new flow. */
919     ovs_be16 flags;             /* Either 0 or OFPFF_SEND_FLOW_REM. */
920     uint8_t table_id;           /* Table to insert flow entry. */
921     uint8_t pad;                /* Must be zero. */
922     ovs_be16 fin_idle_timeout;  /* Idle timeout after FIN, if nonzero. */
923     ovs_be16 fin_hard_timeout;  /* Hard timeout after FIN, if nonzero. */
924     /* Followed by a sequence of flow_mod_spec elements, as described above,
925      * until the end of the action is reached. */
926 };
927 OFP_ASSERT(sizeof(struct nx_action_learn) == 32);
928
929 #define NX_LEARN_N_BITS_MASK    0x3ff
930
931 #define NX_LEARN_SRC_FIELD     (0 << 13) /* Copy from field. */
932 #define NX_LEARN_SRC_IMMEDIATE (1 << 13) /* Copy from immediate value. */
933 #define NX_LEARN_SRC_MASK      (1 << 13)
934
935 #define NX_LEARN_DST_MATCH     (0 << 11) /* Add match criterion. */
936 #define NX_LEARN_DST_LOAD      (1 << 11) /* Add NXAST_REG_LOAD action. */
937 #define NX_LEARN_DST_OUTPUT    (2 << 11) /* Add OFPAT_OUTPUT action. */
938 #define NX_LEARN_DST_RESERVED  (3 << 11) /* Not yet defined. */
939 #define NX_LEARN_DST_MASK      (3 << 11)
940
941 /* Action structure for NXAST_FIN_TIMEOUT.
942  *
943  * This action changes the idle timeout or hard timeout, or both, of this
944  * OpenFlow rule when the rule matches a TCP packet with the FIN or RST flag.
945  * When such a packet is observed, the action reduces the rule's idle timeout
946  * to 'fin_idle_timeout' and its hard timeout to 'fin_hard_timeout'.  This
947  * action has no effect on an existing timeout that is already shorter than the
948  * one that the action specifies.  A 'fin_idle_timeout' or 'fin_hard_timeout'
949  * of zero has no effect on the respective timeout.
950  *
951  * 'fin_idle_timeout' and 'fin_hard_timeout' are measured in seconds.
952  * 'fin_hard_timeout' specifies time since the flow's creation, not since the
953  * receipt of the FIN or RST.
954  *
955  * This is useful for quickly discarding learned TCP flows that otherwise will
956  * take a long time to expire.
957  *
958  * This action is intended for use with an OpenFlow rule that matches only a
959  * single TCP flow.  If the rule matches multiple TCP flows (e.g. it wildcards
960  * all TCP traffic, or all TCP traffic to a particular port), then any FIN or
961  * RST in any of those flows will cause the entire OpenFlow rule to expire
962  * early, which is not normally desirable.
963  */
964 struct nx_action_fin_timeout {
965     ovs_be16 type;              /* OFPAT_VENDOR. */
966     ovs_be16 len;               /* 16. */
967     ovs_be32 vendor;            /* NX_VENDOR_ID. */
968     ovs_be16 subtype;           /* NXAST_FIN_TIMEOUT. */
969     ovs_be16 fin_idle_timeout;  /* New idle timeout, if nonzero. */
970     ovs_be16 fin_hard_timeout;  /* New hard timeout, if nonzero. */
971     ovs_be16 pad;               /* Must be zero. */
972 };
973 OFP_ASSERT(sizeof(struct nx_action_fin_timeout) == 16);
974 \f
975 /* Action structure for NXAST_AUTOPATH.
976  *
977  * This action performs the following steps in sequence:
978  *
979  *    1. Hashes the flow using an implementation-defined hash function.
980  *
981  *       The hashed fields' values are drawn from the current state of the
982  *       flow, including all modifications that have been made by actions up to
983  *       this point.
984  *
985  *    2. Selects an OpenFlow 'port'.
986  *
987  *       'port' is selected in an implementation-defined manner, taking into
988  *       account 'id' and the hash value calculated in step 1.
989  *
990  *       Generally a switch will have been configured with a set of ports that
991  *       may be chosen given 'id'.  The switch may take into account any number
992  *       of factors when choosing 'port' from its configured set.  Factors may
993  *       include carrier, load, and the results of configuration protocols such
994  *       as LACP.
995  *
996  *    3. Stores 'port' in dst[ofs:ofs+n_bits].
997  *
998  *       The format and semantics of 'dst' and 'ofs_nbits' are similar to those
999  *       for the NXAST_REG_LOAD action.
1000  *
1001  * The switch will reject actions in which ofs+n_bits is greater than the width
1002  * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT.
1003  */
1004 struct nx_action_autopath {
1005     ovs_be16 type;              /* OFPAT_VENDOR. */
1006     ovs_be16 len;               /* Length is 20. */
1007     ovs_be32 vendor;            /* NX_VENDOR_ID. */
1008     ovs_be16 subtype;           /* NXAST_AUTOPATH. */
1009
1010     /* Where to store the result. */
1011     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
1012     ovs_be32 dst;               /* Destination. */
1013
1014     ovs_be32 id;                /* Autopath ID. */
1015     ovs_be32 pad;
1016 };
1017 OFP_ASSERT(sizeof(struct nx_action_autopath) == 24);
1018 \f
1019 /* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD.
1020  *
1021  * The bundle actions choose a slave from a supplied list of options.
1022  * NXAST_BUNDLE outputs to its selection.  NXAST_BUNDLE_LOAD writes its
1023  * selection to a register.
1024  *
1025  * The list of possible slaves follows the nx_action_bundle structure. The size
1026  * of each slave is governed by its type as indicated by the 'slave_type'
1027  * parameter. The list of slaves should be padded at its end with zeros to make
1028  * the total length of the action a multiple of 8.
1029  *
1030  * Switches infer from the 'slave_type' parameter the size of each slave.  All
1031  * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates
1032  * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) ==
1033  * 2 byte width.  Switches should reject actions which indicate unknown or
1034  * unsupported slave types.
1035  *
1036  * Switches use a strategy dictated by the 'algorithm' parameter to choose a
1037  * slave.  If the switch does not support the specified 'algorithm' parameter,
1038  * it should reject the action.
1039  *
1040  * Several algorithms take into account liveness when selecting slaves.  The
1041  * liveness of a slave is implementation defined (with one exception), but will
1042  * generally take into account things like its carrier status and the results
1043  * of any link monitoring protocols which happen to be running on it.  In order
1044  * to give controllers a place-holder value, the OFPP_NONE port is always
1045  * considered live.
1046  *
1047  * Some slave selection strategies require the use of a hash function, in which
1048  * case the 'fields' and 'basis' parameters should be populated.  The 'fields'
1049  * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to
1050  * hash.  Refer to the definition of "enum nx_hash_fields" for details.  The
1051  * 'basis' parameter is used as a universal hash parameter.  Different values
1052  * of 'basis' yield different hash results.
1053  *
1054  * The 'zero' parameter at the end of the action structure is reserved for
1055  * future use.  Switches are required to reject actions which have nonzero
1056  * bytes in the 'zero' field.
1057  *
1058  * NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed.  Switches
1059  * should reject actions which have nonzero bytes in either of these fields.
1060  *
1061  * NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in
1062  * dst[ofs:ofs+n_bits].  The format and semantics of 'dst' and 'ofs_nbits' are
1063  * similar to those for the NXAST_REG_LOAD action. */
1064 struct nx_action_bundle {
1065     ovs_be16 type;              /* OFPAT_VENDOR. */
1066     ovs_be16 len;               /* Length including slaves. */
1067     ovs_be32 vendor;            /* NX_VENDOR_ID. */
1068     ovs_be16 subtype;           /* NXAST_BUNDLE or NXAST_BUNDLE_LOAD. */
1069
1070     /* Slave choice algorithm to apply to hash value. */
1071     ovs_be16 algorithm;         /* One of NX_BD_ALG_*. */
1072
1073     /* What fields to hash and how. */
1074     ovs_be16 fields;            /* One of NX_HASH_FIELDS_*. */
1075     ovs_be16 basis;             /* Universal hash parameter. */
1076
1077     ovs_be32 slave_type;        /* NXM_OF_IN_PORT. */
1078     ovs_be16 n_slaves;          /* Number of slaves. */
1079
1080     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
1081     ovs_be32 dst;               /* Destination. */
1082
1083     uint8_t zero[4];            /* Reserved. Must be zero. */
1084 };
1085 OFP_ASSERT(sizeof(struct nx_action_bundle) == 32);
1086
1087 /* NXAST_BUNDLE: Bundle slave choice algorithm to apply.
1088  *
1089  * In the descriptions below, 'slaves' is the list of possible slaves in the
1090  * order they appear in the OpenFlow action. */
1091 enum nx_bd_algorithm {
1092     /* Chooses the first live slave listed in the bundle.
1093      *
1094      * O(n_slaves) performance. */
1095     NX_BD_ALG_ACTIVE_BACKUP,
1096
1097     /* for i in [0,n_slaves):
1098      *   weights[i] = hash(flow, i)
1099      * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i }
1100      *
1101      * Redistributes 1/n_slaves of traffic when a slave's liveness changes.
1102      * O(n_slaves) performance.
1103      *
1104      * Uses the 'fields' and 'basis' parameters. */
1105     NX_BD_ALG_HRW /* Highest Random Weight. */
1106 };
1107 \f
1108 /* Action structure for NXAST_OUTPUT_REG.
1109  *
1110  * Outputs to the OpenFlow port number written to src[ofs:ofs+nbits].
1111  *
1112  * The format and semantics of 'src' and 'ofs_nbits' are similar to those for
1113  * the NXAST_REG_LOAD action.
1114  *
1115  * The acceptable nxm_header values for 'src' are the same as the acceptable
1116  * nxm_header values for the 'src' field of NXAST_REG_MOVE.
1117  *
1118  * The 'max_len' field indicates the number of bytes to send when the chosen
1119  * port is OFPP_CONTROLLER.  Its semantics are equivalent to the 'max_len'
1120  * field of OFPAT_OUTPUT.
1121  *
1122  * The 'zero' field is required to be zeroed for forward compatibility. */
1123 struct nx_action_output_reg {
1124     ovs_be16 type;              /* OFPAT_VENDOR. */
1125     ovs_be16 len;               /* 24. */
1126     ovs_be32 vendor;            /* NX_VENDOR_ID. */
1127     ovs_be16 subtype;           /* NXAST_OUTPUT_REG. */
1128
1129     ovs_be16 ofs_nbits;         /* (ofs << 6) | (n_bits - 1). */
1130     ovs_be32 src;               /* Source. */
1131
1132     ovs_be16 max_len;           /* Max length to send to controller. */
1133
1134     uint8_t zero[6];            /* Reserved, must be zero. */
1135 };
1136 OFP_ASSERT(sizeof(struct nx_action_output_reg) == 24);
1137 \f
1138 /* NXAST_EXIT
1139  *
1140  * Discontinues action processing.
1141  *
1142  * The NXAST_EXIT action causes the switch to immediately halt processing
1143  * actions for the flow.  Any actions which have already been processed are
1144  * executed by the switch.  However, any further actions, including those which
1145  * may be in different tables, or different levels of the NXAST_RESUBMIT
1146  * hierarchy, will be ignored.
1147  *
1148  * Uses the nx_action_header structure. */
1149 \f
1150 /* Flexible flow specifications (aka NXM = Nicira Extended Match).
1151  *
1152  * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches.  This
1153  * structure is fixed-length and hence difficult to extend.  This section
1154  * describes a more flexible, variable-length flow match, called "nx_match" for
1155  * short, that is also supported by Open vSwitch.  This section also defines a
1156  * replacement for each OpenFlow message that includes struct ofp_match.
1157  *
1158  *
1159  * Format
1160  * ======
1161  *
1162  * An nx_match is a sequence of zero or more "nxm_entry"s, which are
1163  * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long.
1164  * "nxm_entry"s are not aligned on or padded to any multibyte boundary.  The
1165  * first 4 bytes of an nxm_entry are its "header", followed by the entry's
1166  * "body".
1167  *
1168  * An nxm_entry's header is interpreted as a 32-bit word in network byte order:
1169  *
1170  * |<-------------------- nxm_type ------------------>|
1171  * |                                                  |
1172  * |31                              16 15            9| 8 7                0
1173  * +----------------------------------+---------------+--+------------------+
1174  * |            nxm_vendor            |   nxm_field   |hm|    nxm_length    |
1175  * +----------------------------------+---------------+--+------------------+
1176  *
1177  * The most-significant 23 bits of the header are collectively "nxm_type".
1178  * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below.  Bits
1179  * 9...15 are "nxm_field", which is a vendor-specific value.  nxm_type normally
1180  * designates a protocol header, such as the Ethernet type, but it can also
1181  * refer to packet metadata, such as the switch port on which a packet arrived.
1182  *
1183  * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons).  The meaning
1184  * of this bit is explained later.
1185  *
1186  * The least-significant 8 bits are "nxm_length", a positive integer.  The
1187  * length of the nxm_entry, including the header, is exactly 4 + nxm_length
1188  * bytes.
1189  *
1190  * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a
1191  * constant.  It is included only to allow software to minimally parse
1192  * "nxm_entry"s of unknown types.  (Similarly, for a given nxm_vendor,
1193  * nxm_field, and nxm_length, nxm_hasmask is a constant.)
1194  *
1195  *
1196  * Semantics
1197  * =========
1198  *
1199  * A zero-length nx_match (one with no "nxm_entry"s) matches every packet.
1200  *
1201  * An nxm_entry places a constraint on the packets matched by the nx_match:
1202  *
1203  *   - If nxm_hasmask is 0, the nxm_entry's body contains a value for the
1204  *     field, called "nxm_value".  The nx_match matches only packets in which
1205  *     the field equals nxm_value.
1206  *
1207  *   - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the
1208  *     field (nxm_value), followed by a bitmask of the same length as the
1209  *     value, called "nxm_mask".  For each 1-bit in position J in nxm_mask, the
1210  *     nx_match matches only packets for which bit J in the given field's value
1211  *     matches bit J in nxm_value.  A 0-bit in nxm_mask causes the
1212  *     corresponding bits in nxm_value and the field's value to be ignored.
1213  *     (The sense of the nxm_mask bits is the opposite of that used by the
1214  *     "wildcards" member of struct ofp_match.)
1215  *
1216  *     When nxm_hasmask is 1, nxm_length is always even.
1217  *
1218  *     An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry
1219  *     entirely.  An all-one-bits nxm_mask is equivalent to specifying 0 for
1220  *     nxm_hasmask.
1221  *
1222  * When there are multiple "nxm_entry"s, all of the constraints must be met.
1223  *
1224  *
1225  * Mask Restrictions
1226  * =================
1227  *
1228  * Masks may be restricted:
1229  *
1230  *   - Some nxm_types may not support masked wildcards, that is, nxm_hasmask
1231  *     must always be 0 when these fields are specified.  For example, the
1232  *     field that identifies the port on which a packet was received may not be
1233  *     masked.
1234  *
1235  *   - Some nxm_types that do support masked wildcards may only support certain
1236  *     nxm_mask patterns.  For example, fields that have IPv4 address values
1237  *     may be restricted to CIDR masks.
1238  *
1239  * These restrictions should be noted in specifications for individual fields.
1240  * A switch may accept an nxm_hasmask or nxm_mask value that the specification
1241  * disallows, if the switch correctly implements support for that nxm_hasmask
1242  * or nxm_mask value.  A switch must reject an attempt to set up a flow that
1243  * contains a nxm_hasmask or nxm_mask value that it does not support.
1244  *
1245  *
1246  * Prerequisite Restrictions
1247  * =========================
1248  *
1249  * The presence of an nxm_entry with a given nxm_type may be restricted based
1250  * on the presence of or values of other "nxm_entry"s.  For example:
1251  *
1252  *   - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is
1253  *     preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0,
1254  *     and nxm_value=0x0800.  That is, matching on the IP source address is
1255  *     allowed only if the Ethernet type is explicitly set to IP.
1256  *
1257  *   - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is
1258  *     preceded by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and
1259  *     nxm_value either 0x0800 or 0x86dd, and another with
1260  *     nxm_type=NXM_OF_IP_PROTO, nxm_hasmask=0, nxm_value=6, in that order.
1261  *     That is, matching on the TCP source port is allowed only if the Ethernet
1262  *     type is IP or IPv6 and the IP protocol is TCP.
1263  *
1264  * These restrictions should be noted in specifications for individual fields.
1265  * A switch may implement relaxed versions of these restrictions.  A switch
1266  * must reject an attempt to set up a flow that violates its restrictions.
1267  *
1268  *
1269  * Ordering Restrictions
1270  * =====================
1271  *
1272  * An nxm_entry that has prerequisite restrictions must appear after the
1273  * "nxm_entry"s for its prerequisites.  Ordering of "nxm_entry"s within an
1274  * nx_match is not otherwise constrained.
1275  *
1276  * Any given nxm_type may appear in an nx_match at most once.
1277  *
1278  *
1279  * nxm_entry Examples
1280  * ==================
1281  *
1282  * These examples show the format of a single nxm_entry with particular
1283  * nxm_hasmask and nxm_length values.  The diagrams are labeled with field
1284  * numbers and byte indexes.
1285  *
1286  *
1287  * 8-bit nxm_value, nxm_hasmask=1, nxm_length=2:
1288  *
1289  *  0          3  4   5
1290  * +------------+---+---+
1291  * |   header   | v | m |
1292  * +------------+---+---+
1293  *
1294  *
1295  * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2:
1296  *
1297  *  0          3 4    5
1298  * +------------+------+
1299  * |   header   | value|
1300  * +------------+------+
1301  *
1302  *
1303  * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4:
1304  *
1305  *  0          3 4           7
1306  * +------------+-------------+
1307  * |   header   |  nxm_value  |
1308  * +------------+-------------+
1309  *
1310  *
1311  * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6:
1312  *
1313  *  0          3 4                9
1314  * +------------+------------------+
1315  * |   header   |     nxm_value    |
1316  * +------------+------------------+
1317  *
1318  *
1319  * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12:
1320  *
1321  *  0          3 4                9 10              15
1322  * +------------+------------------+------------------+
1323  * |   header   |     nxm_value    |      nxm_mask    |
1324  * +------------+------------------+------------------+
1325  *
1326  *
1327  * Error Reporting
1328  * ===============
1329  *
1330  * A switch should report an error in an nx_match using error type
1331  * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes.  Ideally the switch
1332  * should report a specific error code, if one is assigned for the particular
1333  * problem, but NXBRC_NXM_INVALID is also available to report a generic
1334  * nx_match error.
1335  */
1336
1337 #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \
1338     (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH))
1339 #define NXM_HEADER(VENDOR, FIELD, LENGTH) \
1340     NXM_HEADER__(VENDOR, FIELD, 0, LENGTH)
1341 #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \
1342     NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2)
1343 #define NXM_VENDOR(HEADER) ((HEADER) >> 16)
1344 #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f)
1345 #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff)
1346 #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1)
1347 #define NXM_LENGTH(HEADER) ((HEADER) & 0xff)
1348
1349 #define NXM_MAKE_WILD_HEADER(HEADER) \
1350         NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER))
1351
1352 /* ## ------------------------------- ## */
1353 /* ## OpenFlow 1.0-compatible fields. ## */
1354 /* ## ------------------------------- ## */
1355
1356 /* Physical or virtual port on which the packet was received.
1357  *
1358  * Prereqs: None.
1359  *
1360  * Format: 16-bit integer in network byte order.
1361  *
1362  * Masking: Not maskable. */
1363 #define NXM_OF_IN_PORT    NXM_HEADER  (0x0000,  0, 2)
1364
1365 /* Source or destination address in Ethernet header.
1366  *
1367  * Prereqs: None.
1368  *
1369  * Format: 48-bit Ethernet MAC address.
1370  *
1371  * Masking: Fully maskable, in versions 1.8 and later. Earlier versions only
1372  *   supported the following masks for NXM_OF_ETH_DST_W: 00:00:00:00:00:00,
1373  *   fe:ff:ff:ff:ff:ff, 01:00:00:00:00:00, ff:ff:ff:ff:ff:ff. */
1374 #define NXM_OF_ETH_DST    NXM_HEADER  (0x0000,  1, 6)
1375 #define NXM_OF_ETH_DST_W  NXM_HEADER_W(0x0000,  1, 6)
1376 #define NXM_OF_ETH_SRC    NXM_HEADER  (0x0000,  2, 6)
1377 #define NXM_OF_ETH_SRC_W  NXM_HEADER_W(0x0000,  2, 6)
1378
1379 /* Packet's Ethernet type.
1380  *
1381  * For an Ethernet II packet this is taken from the Ethernet header.  For an
1382  * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header.
1383  * A packet that has neither format has value 0x05ff
1384  * (OFP_DL_TYPE_NOT_ETH_TYPE).
1385  *
1386  * For a packet with an 802.1Q header, this is the type of the encapsulated
1387  * frame.
1388  *
1389  * Prereqs: None.
1390  *
1391  * Format: 16-bit integer in network byte order.
1392  *
1393  * Masking: Not maskable. */
1394 #define NXM_OF_ETH_TYPE   NXM_HEADER  (0x0000,  3, 2)
1395
1396 /* 802.1Q TCI.
1397  *
1398  * For a packet with an 802.1Q header, this is the Tag Control Information
1399  * (TCI) field, with the CFI bit forced to 1.  For a packet with no 802.1Q
1400  * header, this has value 0.
1401  *
1402  * Prereqs: None.
1403  *
1404  * Format: 16-bit integer in network byte order.
1405  *
1406  * Masking: Arbitrary masks.
1407  *
1408  * This field can be used in various ways:
1409  *
1410  *   - If it is not constrained at all, the nx_match matches packets without
1411  *     an 802.1Q header or with an 802.1Q header that has any TCI value.
1412  *
1413  *   - Testing for an exact match with 0 matches only packets without an
1414  *     802.1Q header.
1415  *
1416  *   - Testing for an exact match with a TCI value with CFI=1 matches packets
1417  *     that have an 802.1Q header with a specified VID and PCP.
1418  *
1419  *   - Testing for an exact match with a nonzero TCI value with CFI=0 does
1420  *     not make sense.  The switch may reject this combination.
1421  *
1422  *   - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches
1423  *     packets that have an 802.1Q header with that VID (and any PCP).
1424  *
1425  *   - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches
1426  *     packets that have an 802.1Q header with that PCP (and any VID).
1427  *
1428  *   - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q
1429  *     header or with an 802.1Q header with a VID of 0.
1430  *
1431  *   - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q
1432  *     header or with an 802.1Q header with a PCP of 0.
1433  *
1434  *   - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q
1435  *     header or with an 802.1Q header with both VID and PCP of 0.
1436  */
1437 #define NXM_OF_VLAN_TCI   NXM_HEADER  (0x0000,  4, 2)
1438 #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000,  4, 2)
1439
1440 /* The "type of service" byte of the IP header, with the ECN bits forced to 0.
1441  *
1442  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1443  *
1444  * Format: 8-bit integer with 2 least-significant bits forced to 0.
1445  *
1446  * Masking: Not maskable. */
1447 #define NXM_OF_IP_TOS     NXM_HEADER  (0x0000,  5, 1)
1448
1449 /* The "protocol" byte in the IP header.
1450  *
1451  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1452  *
1453  * Format: 8-bit integer.
1454  *
1455  * Masking: Not maskable. */
1456 #define NXM_OF_IP_PROTO   NXM_HEADER  (0x0000,  6, 1)
1457
1458 /* The source or destination address in the IP header.
1459  *
1460  * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly.
1461  *
1462  * Format: 32-bit integer in network byte order.
1463  *
1464  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1465  *   high-order bits set to 1 and the other 32-N bits set to 0. */
1466 #define NXM_OF_IP_SRC     NXM_HEADER  (0x0000,  7, 4)
1467 #define NXM_OF_IP_SRC_W   NXM_HEADER_W(0x0000,  7, 4)
1468 #define NXM_OF_IP_DST     NXM_HEADER  (0x0000,  8, 4)
1469 #define NXM_OF_IP_DST_W   NXM_HEADER_W(0x0000,  8, 4)
1470
1471 /* The source or destination port in the TCP header.
1472  *
1473  * Prereqs:
1474  *   NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1475  *   NXM_OF_IP_PROTO must match 6 exactly.
1476  *
1477  * Format: 16-bit integer in network byte order.
1478  *
1479  * Masking: Fully maskable, in Open vSwitch 1.6 and later.  Not maskable, in
1480  *   earlier versions. */
1481 #define NXM_OF_TCP_SRC    NXM_HEADER  (0x0000,  9, 2)
1482 #define NXM_OF_TCP_SRC_W  NXM_HEADER_W(0x0000,  9, 2)
1483 #define NXM_OF_TCP_DST    NXM_HEADER  (0x0000, 10, 2)
1484 #define NXM_OF_TCP_DST_W  NXM_HEADER_W(0x0000, 10, 2)
1485
1486 /* The source or destination port in the UDP header.
1487  *
1488  * Prereqs:
1489  *   NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd.
1490  *   NXM_OF_IP_PROTO must match 17 exactly.
1491  *
1492  * Format: 16-bit integer in network byte order.
1493  *
1494  * Masking: Fully maskable, in Open vSwitch 1.6 and later.  Not maskable, in
1495  *   earlier versions. */
1496 #define NXM_OF_UDP_SRC    NXM_HEADER  (0x0000, 11, 2)
1497 #define NXM_OF_UDP_SRC_W  NXM_HEADER_W(0x0000, 11, 2)
1498 #define NXM_OF_UDP_DST    NXM_HEADER  (0x0000, 12, 2)
1499 #define NXM_OF_UDP_DST_W  NXM_HEADER_W(0x0000, 12, 2)
1500
1501 /* The type or code in the ICMP header.
1502  *
1503  * Prereqs:
1504  *   NXM_OF_ETH_TYPE must match 0x0800 exactly.
1505  *   NXM_OF_IP_PROTO must match 1 exactly.
1506  *
1507  * Format: 8-bit integer.
1508  *
1509  * Masking: Not maskable. */
1510 #define NXM_OF_ICMP_TYPE  NXM_HEADER  (0x0000, 13, 1)
1511 #define NXM_OF_ICMP_CODE  NXM_HEADER  (0x0000, 14, 1)
1512
1513 /* ARP opcode.
1514  *
1515  * For an Ethernet+IP ARP packet, the opcode in the ARP header.  Always 0
1516  * otherwise.  Only ARP opcodes between 1 and 255 should be specified for
1517  * matching.
1518  *
1519  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1520  *
1521  * Format: 16-bit integer in network byte order.
1522  *
1523  * Masking: Not maskable. */
1524 #define NXM_OF_ARP_OP     NXM_HEADER  (0x0000, 15, 2)
1525
1526 /* For an Ethernet+IP ARP packet, the source or target protocol address
1527  * in the ARP header.  Always 0 otherwise.
1528  *
1529  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1530  *
1531  * Format: 32-bit integer in network byte order.
1532  *
1533  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1534  *   high-order bits set to 1 and the other 32-N bits set to 0. */
1535 #define NXM_OF_ARP_SPA    NXM_HEADER  (0x0000, 16, 4)
1536 #define NXM_OF_ARP_SPA_W  NXM_HEADER_W(0x0000, 16, 4)
1537 #define NXM_OF_ARP_TPA    NXM_HEADER  (0x0000, 17, 4)
1538 #define NXM_OF_ARP_TPA_W  NXM_HEADER_W(0x0000, 17, 4)
1539
1540 /* ## ------------------------ ## */
1541 /* ## Nicira match extensions. ## */
1542 /* ## ------------------------ ## */
1543
1544 /* Metadata registers.
1545  *
1546  * Registers initially have value 0.  Actions allow register values to be
1547  * manipulated.
1548  *
1549  * Prereqs: None.
1550  *
1551  * Format: Array of 32-bit integer registers.  Space is reserved for up to
1552  *   NXM_NX_MAX_REGS registers, but switches may implement fewer.
1553  *
1554  * Masking: Arbitrary masks. */
1555 #define NXM_NX_MAX_REGS 16
1556 #define NXM_NX_REG(IDX)   NXM_HEADER  (0x0001, IDX, 4)
1557 #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4)
1558 #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER)
1559 #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff))
1560 #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff))
1561 #define NXM_NX_REG0       NXM_HEADER  (0x0001, 0, 4)
1562 #define NXM_NX_REG0_W     NXM_HEADER_W(0x0001, 0, 4)
1563 #define NXM_NX_REG1       NXM_HEADER  (0x0001, 1, 4)
1564 #define NXM_NX_REG1_W     NXM_HEADER_W(0x0001, 1, 4)
1565 #define NXM_NX_REG2       NXM_HEADER  (0x0001, 2, 4)
1566 #define NXM_NX_REG2_W     NXM_HEADER_W(0x0001, 2, 4)
1567 #define NXM_NX_REG3       NXM_HEADER  (0x0001, 3, 4)
1568 #define NXM_NX_REG3_W     NXM_HEADER_W(0x0001, 3, 4)
1569 #define NXM_NX_REG4       NXM_HEADER  (0x0001, 4, 4)
1570 #define NXM_NX_REG4_W     NXM_HEADER_W(0x0001, 4, 4)
1571 #define NXM_NX_REG5       NXM_HEADER  (0x0001, 5, 4)
1572 #define NXM_NX_REG5_W     NXM_HEADER_W(0x0001, 5, 4)
1573 #define NXM_NX_REG6       NXM_HEADER  (0x0001, 6, 4)
1574 #define NXM_NX_REG6_W     NXM_HEADER_W(0x0001, 6, 4)
1575 #define NXM_NX_REG7       NXM_HEADER  (0x0001, 7, 4)
1576 #define NXM_NX_REG7_W     NXM_HEADER_W(0x0001, 7, 4)
1577
1578 /* Tunnel ID.
1579  *
1580  * For a packet received via GRE tunnel including a (32-bit) key, the key is
1581  * stored in the low 32-bits and the high bits are zeroed.  For other packets,
1582  * the value is 0.
1583  *
1584  * Prereqs: None.
1585  *
1586  * Format: 64-bit integer in network byte order.
1587  *
1588  * Masking: Arbitrary masks. */
1589 #define NXM_NX_TUN_ID     NXM_HEADER  (0x0001, 16, 8)
1590 #define NXM_NX_TUN_ID_W   NXM_HEADER_W(0x0001, 16, 8)
1591
1592 /* For an Ethernet+IP ARP packet, the source or target hardware address
1593  * in the ARP header.  Always 0 otherwise.
1594  *
1595  * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly.
1596  *
1597  * Format: 48-bit Ethernet MAC address.
1598  *
1599  * Masking: Not maskable. */
1600 #define NXM_NX_ARP_SHA    NXM_HEADER  (0x0001, 17, 6)
1601 #define NXM_NX_ARP_THA    NXM_HEADER  (0x0001, 18, 6)
1602
1603 /* The source or destination address in the IPv6 header.
1604  *
1605  * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1606  *
1607  * Format: 128-bit IPv6 address.
1608  *
1609  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1610  *   high-order bits set to 1 and the other 128-N bits set to 0. */
1611 #define NXM_NX_IPV6_SRC    NXM_HEADER  (0x0001, 19, 16)
1612 #define NXM_NX_IPV6_SRC_W  NXM_HEADER_W(0x0001, 19, 16)
1613 #define NXM_NX_IPV6_DST    NXM_HEADER  (0x0001, 20, 16)
1614 #define NXM_NX_IPV6_DST_W  NXM_HEADER_W(0x0001, 20, 16)
1615
1616 /* The type or code in the ICMPv6 header.
1617  *
1618  * Prereqs:
1619  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1620  *   NXM_OF_IP_PROTO must match 58 exactly.
1621  *
1622  * Format: 8-bit integer.
1623  *
1624  * Masking: Not maskable. */
1625 #define NXM_NX_ICMPV6_TYPE NXM_HEADER  (0x0001, 21, 1)
1626 #define NXM_NX_ICMPV6_CODE NXM_HEADER  (0x0001, 22, 1)
1627
1628 /* The target address in an IPv6 Neighbor Discovery message.
1629  *
1630  * Prereqs:
1631  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1632  *   NXM_OF_IP_PROTO must match 58 exactly.
1633  *   NXM_OF_ICMPV6_TYPE must be either 135 or 136.
1634  *
1635  * Format: 128-bit IPv6 address.
1636  *
1637  * Masking: Only CIDR masks are allowed, that is, masks that consist of N
1638  *   high-order bits set to 1 and the other 128-N bits set to 0. */
1639 #define NXM_NX_ND_TARGET     NXM_HEADER    (0x0001, 23, 16)
1640 #define NXM_NX_ND_TARGET_W   NXM_HEADER_W  (0x0001, 23, 16)
1641
1642 /* The source link-layer address option in an IPv6 Neighbor Discovery
1643  * message.
1644  *
1645  * Prereqs:
1646  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1647  *   NXM_OF_IP_PROTO must match 58 exactly.
1648  *   NXM_OF_ICMPV6_TYPE must be exactly 135.
1649  *
1650  * Format: 48-bit Ethernet MAC address.
1651  *
1652  * Masking: Not maskable. */
1653 #define NXM_NX_ND_SLL      NXM_HEADER  (0x0001, 24, 6)
1654
1655 /* The target link-layer address option in an IPv6 Neighbor Discovery
1656  * message.
1657  *
1658  * Prereqs:
1659  *   NXM_OF_ETH_TYPE must match 0x86dd exactly.
1660  *   NXM_OF_IP_PROTO must match 58 exactly.
1661  *   NXM_OF_ICMPV6_TYPE must be exactly 136.
1662  *
1663  * Format: 48-bit Ethernet MAC address.
1664  *
1665  * Masking: Not maskable. */
1666 #define NXM_NX_ND_TLL      NXM_HEADER  (0x0001, 25, 6)
1667
1668 /* IP fragment information.
1669  *
1670  * Prereqs:
1671  *   NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1672  *
1673  * Format: 8-bit value with one of the values 0, 1, or 3, as described below.
1674  *
1675  * Masking: Fully maskable.
1676  *
1677  * This field has three possible values:
1678  *
1679  *   - A packet that is not an IP fragment has value 0.
1680  *
1681  *   - A packet that is an IP fragment with offset 0 (the first fragment) has
1682  *     bit 0 set and thus value 1.
1683  *
1684  *   - A packet that is an IP fragment with nonzero offset has bits 0 and 1 set
1685  *     and thus value 3.
1686  *
1687  * NX_IP_FRAG_ANY and NX_IP_FRAG_LATER are declared to symbolically represent
1688  * the meanings of bits 0 and 1.
1689  *
1690  * The switch may reject matches against values that can never appear.
1691  *
1692  * It is important to understand how this field interacts with the OpenFlow IP
1693  * fragment handling mode:
1694  *
1695  *   - In OFPC_FRAG_DROP mode, the OpenFlow switch drops all IP fragments
1696  *     before they reach the flow table, so every packet that is available for
1697  *     matching will have value 0 in this field.
1698  *
1699  *   - Open vSwitch does not implement OFPC_FRAG_REASM mode, but if it did then
1700  *     IP fragments would be reassembled before they reached the flow table and
1701  *     again every packet available for matching would always have value 0.
1702  *
1703  *   - In OFPC_FRAG_NORMAL mode, all three values are possible, but OpenFlow
1704  *     1.0 says that fragments' transport ports are always 0, even for the
1705  *     first fragment, so this does not provide much extra information.
1706  *
1707  *   - In OFPC_FRAG_NX_MATCH mode, all three values are possible.  For
1708  *     fragments with offset 0, Open vSwitch makes L4 header information
1709  *     available.
1710  */
1711 #define NXM_NX_IP_FRAG     NXM_HEADER  (0x0001, 26, 1)
1712 #define NXM_NX_IP_FRAG_W   NXM_HEADER_W(0x0001, 26, 1)
1713
1714 /* Bits in the value of NXM_NX_IP_FRAG. */
1715 #define NX_IP_FRAG_ANY   (1 << 0) /* Is this a fragment? */
1716 #define NX_IP_FRAG_LATER (1 << 1) /* Is this a fragment with nonzero offset? */
1717
1718 /* The flow label in the IPv6 header.
1719  *
1720  * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly.
1721  *
1722  * Format: 20-bit IPv6 flow label in least-significant bits.
1723  *
1724  * Masking: Not maskable. */
1725 #define NXM_NX_IPV6_LABEL  NXM_HEADER  (0x0001, 27, 4)
1726
1727 /* The ECN of the IP header.
1728  *
1729  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1730  *
1731  * Format: ECN in the low-order 2 bits.
1732  *
1733  * Masking: Not maskable. */
1734 #define NXM_NX_IP_ECN      NXM_HEADER  (0x0001, 28, 1)
1735
1736 /* The time-to-live/hop limit of the IP header.
1737  *
1738  * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd.
1739  *
1740  * Format: 8-bit integer.
1741  *
1742  * Masking: Not maskable. */
1743 #define NXM_NX_IP_TTL      NXM_HEADER  (0x0001, 29, 1)
1744
1745 /* Flow cookie.
1746  *
1747  * This may be used to gain the OpenFlow 1.1-like ability to restrict
1748  * certain NXM-based Flow Mod and Flow Stats Request messages to flows
1749  * with specific cookies.  See the "nx_flow_mod" and "nx_flow_stats_request"
1750  * structure definitions for more details.  This match is otherwise not
1751  * allowed.
1752  *
1753  * Prereqs: None.
1754  *
1755  * Format: 64-bit integer in network byte order.
1756  *
1757  * Masking: Arbitrary masks. */
1758 #define NXM_NX_COOKIE     NXM_HEADER  (0x0001, 30, 8)
1759 #define NXM_NX_COOKIE_W   NXM_HEADER_W(0x0001, 30, 8)
1760
1761 /* ## --------------------- ## */
1762 /* ## Requests and replies. ## */
1763 /* ## --------------------- ## */
1764
1765 enum nx_flow_format {
1766     NXFF_OPENFLOW10 = 0,         /* Standard OpenFlow 1.0 compatible. */
1767     NXFF_NXM = 2                 /* Nicira extended match. */
1768 };
1769
1770 /* NXT_SET_FLOW_FORMAT request. */
1771 struct nx_set_flow_format {
1772     struct nicira_header nxh;
1773     ovs_be32 format;            /* One of NXFF_*. */
1774 };
1775 OFP_ASSERT(sizeof(struct nx_set_flow_format) == 20);
1776
1777 /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD).
1778  *
1779  * It is possible to limit flow deletions and modifications to certain
1780  * cookies by using the NXM_NX_COOKIE(_W) matches.  The "cookie" field
1781  * is used only to add or modify flow cookies.
1782  */
1783 struct nx_flow_mod {
1784     struct nicira_header nxh;
1785     ovs_be64 cookie;              /* Opaque controller-issued identifier. */
1786     ovs_be16 command;             /* One of OFPFC_*. */
1787     ovs_be16 idle_timeout;        /* Idle time before discarding (seconds). */
1788     ovs_be16 hard_timeout;        /* Max time before discarding (seconds). */
1789     ovs_be16 priority;            /* Priority level of flow entry. */
1790     ovs_be32 buffer_id;           /* Buffered packet to apply to (or -1).
1791                                      Not meaningful for OFPFC_DELETE*. */
1792     ovs_be16 out_port;            /* For OFPFC_DELETE* commands, require
1793                                      matching entries to include this as an
1794                                      output port.  A value of OFPP_NONE
1795                                      indicates no restriction. */
1796     ovs_be16 flags;               /* One of OFPFF_*. */
1797     ovs_be16 match_len;           /* Size of nx_match. */
1798     uint8_t pad[6];               /* Align to 64-bits. */
1799     /* Followed by:
1800      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1801      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1802      *     all-zero bytes, then
1803      *   - Actions to fill out the remainder of the message length (always a
1804      *     multiple of 8).
1805      */
1806 };
1807 OFP_ASSERT(sizeof(struct nx_flow_mod) == 48);
1808
1809 /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */
1810 struct nx_flow_removed {
1811     struct nicira_header nxh;
1812     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
1813     ovs_be16 priority;        /* Priority level of flow entry. */
1814     uint8_t reason;           /* One of OFPRR_*. */
1815     uint8_t pad[1];           /* Align to 32-bits. */
1816     ovs_be32 duration_sec;    /* Time flow was alive in seconds. */
1817     ovs_be32 duration_nsec;   /* Time flow was alive in nanoseconds beyond
1818                                  duration_sec. */
1819     ovs_be16 idle_timeout;    /* Idle timeout from original flow mod. */
1820     ovs_be16 match_len;       /* Size of nx_match. */
1821     ovs_be64 packet_count;
1822     ovs_be64 byte_count;
1823     /* Followed by:
1824      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1825      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1826      *     all-zero bytes. */
1827 };
1828 OFP_ASSERT(sizeof(struct nx_flow_removed) == 56);
1829
1830 /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW
1831  * request).
1832  *
1833  * It is possible to limit matches to certain cookies by using the
1834  * NXM_NX_COOKIE and NXM_NX_COOKIE_W matches.
1835  */
1836 struct nx_flow_stats_request {
1837     struct nicira_stats_msg nsm;
1838     ovs_be16 out_port;        /* Require matching entries to include this
1839                                  as an output port.  A value of OFPP_NONE
1840                                  indicates no restriction. */
1841     ovs_be16 match_len;       /* Length of nx_match. */
1842     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
1843                                  or 0xff for all tables. */
1844     uint8_t pad[3];           /* Align to 64 bits. */
1845     /* Followed by:
1846      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1847      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1848      *     all-zero bytes, which must also exactly fill out the length of the
1849      *     message.
1850      */
1851 };
1852 OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32);
1853
1854 /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to
1855  * OFPST_FLOW reply).
1856  *
1857  * The values of 'idle_age' and 'hard_age' are only meaningful when talking to
1858  * a switch that implements the NXT_FLOW_AGE extension.  Zero means that the
1859  * true value is unknown, perhaps because hardware does not track the value.
1860  * (Zero is also the value that one should ordinarily expect to see talking to
1861  * a switch that does not implement NXT_FLOW_AGE, since those switches zero the
1862  * padding bytes that these fields replaced.)  A nonzero value X represents X-1
1863  * seconds.  A value of 65535 represents 65534 or more seconds.
1864  *
1865  * 'idle_age' is the number of seconds that the flow has been idle, that is,
1866  * the number of seconds since a packet passed through the flow.  'hard_age' is
1867  * the number of seconds since the flow was last modified (e.g. OFPFC_MODIFY or
1868  * OFPFC_MODIFY_STRICT).  (The 'duration_*' fields are the elapsed time since
1869  * the flow was added, regardless of subsequent modifications.)
1870  *
1871  * For a flow with an idle or hard timeout, 'idle_age' or 'hard_age',
1872  * respectively, will ordinarily be smaller than the timeout, but flow
1873  * expiration times are only approximate and so one must be prepared to
1874  * tolerate expirations that occur somewhat early or late.
1875  */
1876 struct nx_flow_stats {
1877     ovs_be16 length;          /* Length of this entry. */
1878     uint8_t table_id;         /* ID of table flow came from. */
1879     uint8_t pad;
1880     ovs_be32 duration_sec;    /* Time flow has been alive in seconds. */
1881     ovs_be32 duration_nsec;   /* Time flow has been alive in nanoseconds
1882                                  beyond duration_sec. */
1883     ovs_be16 priority;        /* Priority of the entry. Only meaningful
1884                                  when this is not an exact-match entry. */
1885     ovs_be16 idle_timeout;    /* Number of seconds idle before expiration. */
1886     ovs_be16 hard_timeout;    /* Number of seconds before expiration. */
1887     ovs_be16 match_len;       /* Length of nx_match. */
1888     ovs_be16 idle_age;        /* Seconds since last packet, plus one. */
1889     ovs_be16 hard_age;        /* Seconds since last modification, plus one. */
1890     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
1891     ovs_be64 packet_count;    /* Number of packets, UINT64_MAX if unknown. */
1892     ovs_be64 byte_count;      /* Number of bytes, UINT64_MAX if unknown. */
1893     /* Followed by:
1894      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1895      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1896      *     all-zero bytes, then
1897      *   - Actions to fill out the remainder 'length' bytes (always a multiple
1898      *     of 8).
1899      */
1900 };
1901 OFP_ASSERT(sizeof(struct nx_flow_stats) == 48);
1902
1903 /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to
1904  * OFPST_AGGREGATE request). */
1905 struct nx_aggregate_stats_request {
1906     struct nicira_stats_msg nsm;
1907     ovs_be16 out_port;        /* Require matching entries to include this
1908                                  as an output port.  A value of OFPP_NONE
1909                                  indicates no restriction. */
1910     ovs_be16 match_len;       /* Length of nx_match. */
1911     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
1912                                  or 0xff for all tables. */
1913     uint8_t pad[3];           /* Align to 64 bits. */
1914     /* Followed by:
1915      *   - Exactly match_len (possibly 0) bytes containing the nx_match, then
1916      *   - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of
1917      *     all-zero bytes, which must also exactly fill out the length of the
1918      *     message.
1919      */
1920 };
1921 OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32);
1922
1923 /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to
1924  * OFPST_AGGREGATE reply). */
1925 struct nx_aggregate_stats_reply {
1926     struct nicira_stats_msg nsm;
1927     ovs_be64 packet_count;     /* Number of packets, UINT64_MAX if unknown. */
1928     ovs_be64 byte_count;       /* Number of bytes, UINT64_MAX if unknown. */
1929     ovs_be32 flow_count;       /* Number of flows. */
1930     uint8_t pad[4];            /* Align to 64 bits. */
1931 };
1932 OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48);
1933 \f
1934 /* NXT_SET_CONTROLLER_ID.
1935  *
1936  * Each OpenFlow controller connection has a 16-bit identifier that is
1937  * initially 0.  This message changes the connection's ID to 'id'.
1938  *
1939  * Controller connection IDs need not be unique.
1940  *
1941  * The NXAST_CONTROLLER action is the only current user of controller
1942  * connection IDs. */
1943 struct nx_controller_id {
1944     struct nicira_header nxh;
1945     uint8_t zero[6];            /* Must be zero. */
1946     ovs_be16 controller_id;     /* New controller connection ID. */
1947 };
1948 OFP_ASSERT(sizeof(struct nx_controller_id) == 24);
1949
1950 /* Action structure for NXAST_CONTROLLER.
1951  *
1952  * This generalizes using OFPAT_OUTPUT to send a packet to OFPP_CONTROLLER.  In
1953  * addition to the 'max_len' that OFPAT_OUTPUT supports, it also allows
1954  * specifying:
1955  *
1956  *    - 'reason': The reason code to use in the ofp_packet_in or nx_packet_in.
1957  *
1958  *    - 'controller_id': The ID of the controller connection to which the
1959  *      ofp_packet_in should be sent.  The ofp_packet_in or nx_packet_in is
1960  *      sent only to controllers that have the specified controller connection
1961  *      ID.  See "struct nx_controller_id" for more information. */
1962 struct nx_action_controller {
1963     ovs_be16 type;                  /* OFPAT_VENDOR. */
1964     ovs_be16 len;                   /* Length is 16. */
1965     ovs_be32 vendor;                /* NX_VENDOR_ID. */
1966     ovs_be16 subtype;               /* NXAST_CONTROLLER. */
1967     ovs_be16 max_len;               /* Maximum length to send to controller. */
1968     ovs_be16 controller_id;         /* Controller ID to send packet-in. */
1969     uint8_t reason;                 /* enum ofp_packet_in_reason (OFPR_*). */
1970     uint8_t zero;                   /* Must be zero. */
1971 };
1972 OFP_ASSERT(sizeof(struct nx_action_controller) == 16);
1973
1974 #endif /* openflow/nicira-ext.h */