]>
Commit | Line | Data |
---|---|---|
064af421 | 1 | /* |
6eb59a8f | 2 | * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks |
a14bc59f BP |
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. | |
064af421 BP |
15 | */ |
16 | ||
17 | #ifndef OPENFLOW_NICIRA_EXT_H | |
18 | #define OPENFLOW_NICIRA_EXT_H 1 | |
19 | ||
20 | #include "openflow/openflow.h" | |
26c112c2 | 21 | #include "openvswitch/types.h" |
064af421 | 22 | |
064af421 | 23 | /* The following vendor extensions, proposed by Nicira Networks, are not yet |
26c112c2 BP |
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. */ | |
064af421 BP |
26 | |
27 | #define NX_VENDOR_ID 0x00002320 | |
26c112c2 BP |
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 | |
6eb59a8f | 39 | * and NXVC_VENDOR_ERROR as code, followed by struct nx_vendor_error with |
26c112c2 BP |
40 | * vendor-specific details, followed by at least 64 bytes of the failed |
41 | * request. | |
42 | * | |
a23aab1f | 43 | * It would be better to have a type-specific vendor extension, e.g. so that |
26c112c2 BP |
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 | |
422bb884 BP |
70 | /* Specific Nicira extension error numbers. |
71 | * | |
72 | * These are the "code" values used in nx_vendor_error. So far, the "type" | |
73 | * values in nx_vendor_error are the same as those in ofp_error_msg. That is, | |
74 | * at Nicira so far we've only needed additional vendor-specific 'code' values, | |
75 | * so we're using the existing 'type' values to avoid having to invent new ones | |
76 | * that duplicate the current ones' meanings. */ | |
77 | ||
09246b99 | 78 | /* Additional "code" values for OFPET_BAD_REQUEST. */ |
dc4762ed | 79 | enum nx_bad_request_code { |
09246b99 BP |
80 | /* Nicira Extended Match (NXM) errors. */ |
81 | ||
82 | /* Generic error code used when there is an error in an NXM sent to the | |
83 | * switch. The switch may use one of the more specific error codes below, | |
84 | * if there is an appropriate one, to simplify debugging, but it is not | |
85 | * required to do so. */ | |
86 | NXBRC_NXM_INVALID = 0x100, | |
87 | ||
88 | /* The nxm_type, or nxm_type taken in combination with nxm_hasmask or | |
89 | * nxm_length or both, is invalid or not implemented. */ | |
90 | NXBRC_NXM_BAD_TYPE = 0x101, | |
91 | ||
92 | /* Invalid nxm_value. */ | |
93 | NXBRC_NXM_BAD_VALUE = 0x102, | |
94 | ||
95 | /* Invalid nxm_mask. */ | |
96 | NXBRC_NXM_BAD_MASK = 0x103, | |
97 | ||
98 | /* A prerequisite was not met. */ | |
99 | NXBRC_NXM_BAD_PREREQ = 0x104, | |
100 | ||
101 | /* A given nxm_type was specified more than once. */ | |
102 | NXBRC_NXM_DUP_TYPE = 0x105 | |
103 | }; | |
104 | ||
422bb884 | 105 | /* Additional "code" values for OFPET_FLOW_MOD_FAILED. */ |
dc4762ed | 106 | enum nx_flow_mod_failed_code { |
422bb884 BP |
107 | /* Generic hardware error. */ |
108 | NXFMFC_HARDWARE = 0x100, | |
109 | ||
110 | /* A nonexistent table ID was specified in the "command" field of struct | |
6c1491fb | 111 | * ofp_flow_mod, when the nxt_flow_mod_table_id extension is enabled. */ |
09246b99 | 112 | NXFMFC_BAD_TABLE_ID = 0x101 |
422bb884 BP |
113 | }; |
114 | \f | |
26c112c2 | 115 | /* Nicira vendor requests and replies. */ |
064af421 | 116 | |
09246b99 BP |
117 | /* Header for Nicira vendor requests and replies. */ |
118 | struct nicira_header { | |
119 | struct ofp_header header; | |
120 | ovs_be32 vendor; /* NX_VENDOR_ID. */ | |
121 | ovs_be32 subtype; /* One of NXT_* below. */ | |
122 | }; | |
123 | OFP_ASSERT(sizeof(struct nicira_header) == 16); | |
124 | ||
125 | /* Values for the 'subtype' member of struct nicira_header. */ | |
064af421 | 126 | enum nicira_type { |
898b7f8d | 127 | /* No longer used. */ |
241e8267 BP |
128 | NXT_STATUS_REQUEST__OBSOLETE = 0, |
129 | NXT_STATUS_REPLY__OBSOLETE = 1, | |
130 | NXT_ACT_SET_CONFIG__OBSOLETE = 2, | |
131 | NXT_ACT_GET_CONFIG__OBSOLETE = 3, | |
132 | NXT_COMMAND_REQUEST__OBSOLETE = 4, | |
133 | NXT_COMMAND_REPLY__OBSOLETE = 5, | |
134 | NXT_FLOW_END_CONFIG__OBSOLETE = 6, | |
135 | NXT_FLOW_END__OBSOLETE = 7, | |
136 | NXT_MGMT__OBSOLETE = 8, | |
137 | NXT_TUN_ID_FROM_COOKIE__OBSOLETE = 9, | |
9deba63b BP |
138 | |
139 | /* Controller role support. The request body is struct nx_role_request. | |
140 | * The reply echos the request. */ | |
241e8267 BP |
141 | NXT_ROLE_REQUEST = 10, |
142 | NXT_ROLE_REPLY = 11, | |
09246b99 BP |
143 | |
144 | /* Flexible flow specification (aka NXM = Nicira Extended Match). */ | |
241e8267 BP |
145 | NXT_SET_FLOW_FORMAT = 12, /* Set flow format. */ |
146 | NXT_FLOW_MOD = 13, /* Analogous to OFPT_FLOW_MOD. */ | |
147 | NXT_FLOW_REMOVED = 14, /* Analogous to OFPT_FLOW_REMOVED. */ | |
d1e9b9bf BP |
148 | |
149 | /* Use the upper 8 bits of the 'command' member in struct ofp_flow_mod to | |
150 | * designate the table to which a flow is to be added? See the big comment | |
151 | * on struct nxt_flow_mod_table_id for more information. */ | |
241e8267 | 152 | NXT_FLOW_MOD_TABLE_ID = 15 |
064af421 BP |
153 | }; |
154 | ||
09246b99 BP |
155 | /* Header for Nicira vendor stats request and reply messages. */ |
156 | struct nicira_stats_msg { | |
63f2140a | 157 | struct ofp_vendor_stats_msg vsm; /* Vendor NX_VENDOR_ID. */ |
09246b99 BP |
158 | ovs_be32 subtype; /* One of NXST_* below. */ |
159 | uint8_t pad[4]; /* Align to 64-bits. */ | |
064af421 | 160 | }; |
09246b99 | 161 | OFP_ASSERT(sizeof(struct nicira_stats_msg) == 24); |
064af421 | 162 | |
09246b99 BP |
163 | /* Values for the 'subtype' member of struct nicira_stats_msg. */ |
164 | enum nicira_stats_type { | |
165 | /* Flexible flow specification (aka NXM = Nicira Extended Match). */ | |
166 | NXST_FLOW, /* Analogous to OFPST_FLOW. */ | |
167 | NXST_AGGREGATE /* Analogous to OFPST_AGGREGATE. */ | |
f9bfea14 BP |
168 | }; |
169 | ||
520e9a2a EJ |
170 | /* Fields to use when hashing flows. */ |
171 | enum nx_hash_fields { | |
172 | /* Ethernet source address (NXM_OF_ETH_SRC) only. */ | |
173 | NX_HASH_FIELDS_ETH_SRC, | |
174 | ||
175 | /* L2 through L4, symmetric across src/dst. Specifically, each of the | |
176 | * following fields, if present, is hashed (slashes separate symmetric | |
177 | * pairs): | |
178 | * | |
179 | * - NXM_OF_ETH_DST / NXM_OF_ETH_SRC | |
180 | * - NXM_OF_ETH_TYPE | |
181 | * - The VID bits from NXM_OF_VLAN_TCI, ignoring PCP and CFI. | |
182 | * - NXM_OF_IP_PROTO | |
183 | * - NXM_OF_IP_SRC / NXM_OF_IP_DST | |
184 | * - NXM_OF_TCP_SRC / NXM_OF_TCP_DST | |
185 | */ | |
186 | NX_HASH_FIELDS_SYMMETRIC_L4 | |
187 | }; | |
188 | ||
6c1491fb BP |
189 | /* This command enables or disables an Open vSwitch extension that allows a |
190 | * controller to specify the OpenFlow table to which a flow should be added, | |
191 | * instead of having the switch decide which table is most appropriate as | |
192 | * required by OpenFlow 1.0. By default, the extension is disabled. | |
193 | * | |
194 | * When this feature is enabled, Open vSwitch treats struct ofp_flow_mod's | |
195 | * 16-bit 'command' member as two separate fields. The upper 8 bits are used | |
196 | * as the table ID, the lower 8 bits specify the command as usual. A table ID | |
197 | * of 0xff is treated like a wildcarded table ID. | |
198 | * | |
199 | * The specific treatment of the table ID depends on the type of flow mod: | |
200 | * | |
201 | * - OFPFC_ADD: Given a specific table ID, the flow is always placed in that | |
202 | * table. If an identical flow already exists in that table only, then it | |
203 | * is replaced. If the flow cannot be placed in the specified table, | |
204 | * either because the table is full or because the table cannot support | |
205 | * flows of the given type, the switch replies with an | |
206 | * OFPFMFC_ALL_TABLES_FULL error. (A controller can distinguish these | |
207 | * cases by comparing the current and maximum number of entries reported | |
208 | * in ofp_table_stats.) | |
209 | * | |
210 | * If the table ID is wildcarded, the switch picks an appropriate table | |
211 | * itself. If an identical flow already exist in the selected flow table, | |
212 | * then it is replaced. The choice of table might depend on the flows | |
213 | * that are already in the switch; for example, if one table fills up then | |
214 | * the switch might fall back to another one. | |
215 | * | |
216 | * - OFPFC_MODIFY, OFPFC_DELETE: Given a specific table ID, only flows | |
217 | * within that table are matched and modified or deleted. If the table ID | |
218 | * is wildcarded, flows within any table may be matched and modified or | |
219 | * deleted. | |
220 | * | |
221 | * - OFPFC_MODIFY_STRICT, OFPFC_DELETE_STRICT: Given a specific table ID, | |
222 | * only a flow within that table may be matched and modified or deleted. | |
223 | * If the table ID is wildcarded and exactly one flow within any table | |
224 | * matches, then it is modified or deleted; if flows in more than one | |
225 | * table match, then none is modified or deleted. | |
226 | */ | |
227 | struct nxt_flow_mod_table_id { | |
228 | struct ofp_header header; | |
229 | uint32_t vendor; /* NX_VENDOR_ID. */ | |
230 | uint32_t subtype; /* NXT_FLOW_MOD_TABLE_ID. */ | |
231 | uint8_t set; /* Nonzero to enable, zero to disable. */ | |
232 | uint8_t pad[7]; | |
233 | }; | |
234 | OFP_ASSERT(sizeof(struct nxt_flow_mod_table_id) == 24); | |
235 | ||
9deba63b BP |
236 | /* Configures the "role" of the sending controller. The default role is: |
237 | * | |
238 | * - Other (NX_ROLE_OTHER), which allows the controller access to all | |
239 | * OpenFlow features. | |
240 | * | |
241 | * The other possible roles are a related pair: | |
242 | * | |
243 | * - Master (NX_ROLE_MASTER) is equivalent to Other, except that there may | |
244 | * be at most one Master controller at a time: when a controller | |
245 | * configures itself as Master, any existing Master is demoted to the | |
246 | * Slave role. | |
247 | * | |
248 | * - Slave (NX_ROLE_SLAVE) allows the controller read-only access to | |
249 | * OpenFlow features. In particular attempts to modify the flow table | |
250 | * will be rejected with an OFPBRC_EPERM error. | |
251 | * | |
197a992f BP |
252 | * Slave controllers do not receive OFPT_PACKET_IN or OFPT_FLOW_REMOVED |
253 | * messages, but they do receive OFPT_PORT_STATUS messages. | |
9deba63b BP |
254 | */ |
255 | struct nx_role_request { | |
256 | struct nicira_header nxh; | |
459749fe | 257 | ovs_be32 role; /* One of NX_ROLE_*. */ |
9deba63b BP |
258 | }; |
259 | ||
260 | enum nx_role { | |
261 | NX_ROLE_OTHER, /* Default role, full access. */ | |
262 | NX_ROLE_MASTER, /* Full access, at most one. */ | |
263 | NX_ROLE_SLAVE /* Read-only access. */ | |
264 | }; | |
26c112c2 BP |
265 | \f |
266 | /* Nicira vendor flow actions. */ | |
9deba63b | 267 | |
064af421 | 268 | enum nx_action_subtype { |
39b72738 BP |
269 | NXAST_SNAT__OBSOLETE, /* No longer used. */ |
270 | NXAST_RESUBMIT, /* struct nx_action_resubmit */ | |
271 | NXAST_SET_TUNNEL, /* struct nx_action_set_tunnel */ | |
6c222e55 | 272 | NXAST_DROP_SPOOFED_ARP__OBSOLETE, |
39b72738 | 273 | NXAST_SET_QUEUE, /* struct nx_action_set_queue */ |
b6c9e612 BP |
274 | NXAST_POP_QUEUE, /* struct nx_action_pop_queue */ |
275 | NXAST_REG_MOVE, /* struct nx_action_reg_move */ | |
276 | NXAST_REG_LOAD, /* struct nx_action_reg_load */ | |
b9298d3f BP |
277 | NXAST_NOTE, /* struct nx_action_note */ |
278 | NXAST_SET_TUNNEL64, /* struct nx_action_set_tunnel64 */ | |
3b6a2571 | 279 | NXAST_MULTIPATH, /* struct nx_action_multipath */ |
daff3353 | 280 | NXAST_AUTOPATH, /* struct nx_action_autopath */ |
a368bb53 EJ |
281 | NXAST_BUNDLE, /* struct nx_action_bundle */ |
282 | NXAST_BUNDLE_LOAD /* struct nx_action_bundle */ | |
39b72738 | 283 | }; |
eedc0097 | 284 | |
39b72738 BP |
285 | /* Header for Nicira-defined actions. */ |
286 | struct nx_action_header { | |
459749fe BP |
287 | ovs_be16 type; /* OFPAT_VENDOR. */ |
288 | ovs_be16 len; /* Length is 16. */ | |
289 | ovs_be32 vendor; /* NX_VENDOR_ID. */ | |
290 | ovs_be16 subtype; /* NXAST_*. */ | |
39b72738 | 291 | uint8_t pad[6]; |
064af421 | 292 | }; |
39b72738 | 293 | OFP_ASSERT(sizeof(struct nx_action_header) == 16); |
064af421 | 294 | |
39b72738 BP |
295 | /* Action structure for NXAST_RESUBMIT. |
296 | * | |
297 | * NXAST_RESUBMIT searches the flow table again, using a flow that is slightly | |
298 | * modified from the original lookup: | |
299 | * | |
300 | * - The 'in_port' member of struct nx_action_resubmit is used as the flow's | |
301 | * in_port. | |
302 | * | |
303 | * - If NXAST_RESUBMIT is preceded by actions that affect the flow | |
304 | * (e.g. OFPAT_SET_VLAN_VID), then the flow is updated with the new | |
305 | * values. | |
306 | * | |
307 | * Following the lookup, the original in_port is restored. | |
308 | * | |
309 | * If the modified flow matched in the flow table, then the corresponding | |
310 | * actions are executed. Afterward, actions following NXAST_RESUBMIT in the | |
311 | * original set of actions, if any, are executed; any changes made to the | |
312 | * packet (e.g. changes to VLAN) by secondary actions persist when those | |
313 | * actions are executed, although the original in_port is restored. | |
314 | * | |
315 | * NXAST_RESUBMIT may be used any number of times within a set of actions. | |
316 | * | |
317 | * NXAST_RESUBMIT may nest to an implementation-defined depth. Beyond this | |
318 | * implementation-defined depth, further NXAST_RESUBMIT actions are simply | |
319 | * ignored. (Open vSwitch 1.0.1 and earlier did not support recursion.) | |
320 | */ | |
064af421 | 321 | struct nx_action_resubmit { |
459749fe BP |
322 | ovs_be16 type; /* OFPAT_VENDOR. */ |
323 | ovs_be16 len; /* Length is 16. */ | |
324 | ovs_be32 vendor; /* NX_VENDOR_ID. */ | |
325 | ovs_be16 subtype; /* NXAST_RESUBMIT. */ | |
326 | ovs_be16 in_port; /* New in_port for checking flow table. */ | |
064af421 BP |
327 | uint8_t pad[4]; |
328 | }; | |
329 | OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16); | |
330 | ||
39b72738 BP |
331 | /* Action structure for NXAST_SET_TUNNEL. |
332 | * | |
b9298d3f BP |
333 | * Sets the encapsulating tunnel ID to a 32-bit value. The most-significant 32 |
334 | * bits of the tunnel ID are set to 0. */ | |
659586ef | 335 | struct nx_action_set_tunnel { |
459749fe BP |
336 | ovs_be16 type; /* OFPAT_VENDOR. */ |
337 | ovs_be16 len; /* Length is 16. */ | |
338 | ovs_be32 vendor; /* NX_VENDOR_ID. */ | |
339 | ovs_be16 subtype; /* NXAST_SET_TUNNEL. */ | |
659586ef | 340 | uint8_t pad[2]; |
459749fe | 341 | ovs_be32 tun_id; /* Tunnel ID. */ |
659586ef JG |
342 | }; |
343 | OFP_ASSERT(sizeof(struct nx_action_set_tunnel) == 16); | |
344 | ||
b9298d3f BP |
345 | /* Action structure for NXAST_SET_TUNNEL64. |
346 | * | |
347 | * Sets the encapsulating tunnel ID to a 64-bit value. */ | |
348 | struct nx_action_set_tunnel64 { | |
349 | ovs_be16 type; /* OFPAT_VENDOR. */ | |
350 | ovs_be16 len; /* Length is 16. */ | |
351 | ovs_be32 vendor; /* NX_VENDOR_ID. */ | |
352 | ovs_be16 subtype; /* NXAST_SET_TUNNEL64. */ | |
353 | uint8_t pad[6]; | |
354 | ovs_be64 tun_id; /* Tunnel ID. */ | |
355 | }; | |
356 | OFP_ASSERT(sizeof(struct nx_action_set_tunnel64) == 24); | |
357 | ||
39b72738 BP |
358 | /* Action structure for NXAST_SET_QUEUE. |
359 | * | |
360 | * Set the queue that should be used when packets are output. This is similar | |
361 | * to the OpenFlow OFPAT_ENQUEUE action, but does not take the output port as | |
362 | * an argument. This allows the queue to be defined before the port is | |
363 | * known. */ | |
eedc0097 | 364 | struct nx_action_set_queue { |
459749fe BP |
365 | ovs_be16 type; /* OFPAT_VENDOR. */ |
366 | ovs_be16 len; /* Length is 16. */ | |
367 | ovs_be32 vendor; /* NX_VENDOR_ID. */ | |
368 | ovs_be16 subtype; /* NXAST_SET_QUEUE. */ | |
eedc0097 | 369 | uint8_t pad[2]; |
459749fe | 370 | ovs_be32 queue_id; /* Where to enqueue packets. */ |
eedc0097 JP |
371 | }; |
372 | OFP_ASSERT(sizeof(struct nx_action_set_queue) == 16); | |
373 | ||
39b72738 BP |
374 | /* Action structure for NXAST_POP_QUEUE. |
375 | * | |
376 | * Restores the queue to the value it was before any NXAST_SET_QUEUE actions | |
377 | * were used. Only the original queue can be restored this way; no stack is | |
378 | * maintained. */ | |
379 | struct nx_action_pop_queue { | |
459749fe BP |
380 | ovs_be16 type; /* OFPAT_VENDOR. */ |
381 | ovs_be16 len; /* Length is 16. */ | |
382 | ovs_be32 vendor; /* NX_VENDOR_ID. */ | |
383 | ovs_be16 subtype; /* NXAST_POP_QUEUE. */ | |
064af421 BP |
384 | uint8_t pad[6]; |
385 | }; | |
39b72738 | 386 | OFP_ASSERT(sizeof(struct nx_action_pop_queue) == 16); |
064af421 | 387 | |
b6c9e612 BP |
388 | /* Action structure for NXAST_REG_MOVE. |
389 | * | |
390 | * Copies src[src_ofs:src_ofs+n_bits] to dst[dst_ofs:dst_ofs+n_bits], where | |
391 | * a[b:c] denotes the bits within 'a' numbered 'b' through 'c' (not including | |
392 | * bit 'c'). Bit numbering starts at 0 for the least-significant bit, 1 for | |
393 | * the next most significant bit, and so on. | |
394 | * | |
60d5e0d8 BP |
395 | * 'src' and 'dst' are nxm_header values with nxm_hasmask=0. (It doesn't make |
396 | * sense to use nxm_hasmask=1 because the action does not do any kind of | |
397 | * matching; it uses the actual value of a field.) | |
398 | * | |
399 | * The following nxm_header values are potentially acceptable as 'src': | |
b6c9e612 BP |
400 | * |
401 | * - NXM_OF_IN_PORT | |
402 | * - NXM_OF_ETH_DST | |
403 | * - NXM_OF_ETH_SRC | |
404 | * - NXM_OF_ETH_TYPE | |
405 | * - NXM_OF_VLAN_TCI | |
406 | * - NXM_OF_IP_TOS | |
407 | * - NXM_OF_IP_PROTO | |
408 | * - NXM_OF_IP_SRC | |
409 | * - NXM_OF_IP_DST | |
410 | * - NXM_OF_TCP_SRC | |
411 | * - NXM_OF_TCP_DST | |
412 | * - NXM_OF_UDP_SRC | |
413 | * - NXM_OF_UDP_DST | |
414 | * - NXM_OF_ICMP_TYPE | |
415 | * - NXM_OF_ICMP_CODE | |
416 | * - NXM_OF_ARP_OP | |
417 | * - NXM_OF_ARP_SPA | |
418 | * - NXM_OF_ARP_TPA | |
419 | * - NXM_NX_TUN_ID | |
bad68a99 JP |
420 | * - NXM_NX_ARP_SHA |
421 | * - NXM_NX_ARP_THA | |
d31f1109 JP |
422 | * - NXM_NX_ICMPV6_TYPE |
423 | * - NXM_NX_ICMPV6_CODE | |
685a51a5 JP |
424 | * - NXM_NX_ND_SLL |
425 | * - NXM_NX_ND_TLL | |
b6c9e612 BP |
426 | * - NXM_NX_REG(idx) for idx in the switch's accepted range. |
427 | * | |
428 | * The following nxm_header values are potentially acceptable as 'dst': | |
429 | * | |
430 | * - NXM_NX_REG(idx) for idx in the switch's accepted range. | |
431 | * | |
432 | * - NXM_OF_VLAN_TCI. Modifying this field's value has side effects on the | |
433 | * packet's 802.1Q header. Setting a value with CFI=0 removes the 802.1Q | |
434 | * header (if any), ignoring the other bits. Setting a value with CFI=1 | |
435 | * adds or modifies the 802.1Q header appropriately, setting the TCI field | |
436 | * to the field's new value (with the CFI bit masked out). | |
437 | * | |
438 | * - NXM_NX_TUN_ID. Modifying this value modifies the tunnel ID used for the | |
439 | * packet's next tunnel encapsulation. | |
440 | * | |
441 | * A given nxm_header value may be used as 'src' or 'dst' only on a flow whose | |
442 | * nx_match satisfies its prerequisites. For example, NXM_OF_IP_TOS may be | |
443 | * used only if the flow's nx_match includes an nxm_entry that specifies | |
444 | * nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, and nxm_value=0x0800. | |
445 | * | |
446 | * The switch will reject actions for which src_ofs+n_bits is greater than the | |
447 | * width of 'src' or dst_ofs+n_bits is greater than the width of 'dst' with | |
448 | * error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT. | |
449 | */ | |
450 | struct nx_action_reg_move { | |
451 | ovs_be16 type; /* OFPAT_VENDOR. */ | |
452 | ovs_be16 len; /* Length is 16. */ | |
453 | ovs_be32 vendor; /* NX_VENDOR_ID. */ | |
454 | ovs_be16 subtype; /* NXAST_REG_MOVE. */ | |
455 | ovs_be16 n_bits; /* Number of bits. */ | |
456 | ovs_be16 src_ofs; /* Starting bit offset in source. */ | |
457 | ovs_be16 dst_ofs; /* Starting bit offset in destination. */ | |
458 | ovs_be32 src; /* Source register. */ | |
459 | ovs_be32 dst; /* Destination register. */ | |
460 | }; | |
461 | OFP_ASSERT(sizeof(struct nx_action_reg_move) == 24); | |
462 | ||
463 | /* Action structure for NXAST_REG_LOAD. | |
464 | * | |
465 | * Copies value[0:n_bits] to dst[ofs:ofs+n_bits], where a[b:c] denotes the bits | |
466 | * within 'a' numbered 'b' through 'c' (not including bit 'c'). Bit numbering | |
467 | * starts at 0 for the least-significant bit, 1 for the next most significant | |
468 | * bit, and so on. | |
469 | * | |
7b064a79 BP |
470 | * 'dst' is an nxm_header with nxm_hasmask=0. See the documentation for |
471 | * NXAST_REG_MOVE, above, for the permitted fields and for the side effects of | |
472 | * loading them. | |
b6c9e612 BP |
473 | * |
474 | * The 'ofs' and 'n_bits' fields are combined into a single 'ofs_nbits' field | |
475 | * to avoid enlarging the structure by another 8 bytes. To allow 'n_bits' to | |
476 | * take a value between 1 and 64 (inclusive) while taking up only 6 bits, it is | |
477 | * also stored as one less than its true value: | |
478 | * | |
479 | * 15 6 5 0 | |
480 | * +------------------------------+------------------+ | |
481 | * | ofs | n_bits - 1 | | |
482 | * +------------------------------+------------------+ | |
483 | * | |
484 | * The switch will reject actions for which ofs+n_bits is greater than the | |
485 | * width of 'dst', or in which any bits in 'value' with value 2**n_bits or | |
486 | * greater are set to 1, with error type OFPET_BAD_ACTION, code | |
487 | * OFPBAC_BAD_ARGUMENT. | |
488 | */ | |
489 | struct nx_action_reg_load { | |
490 | ovs_be16 type; /* OFPAT_VENDOR. */ | |
491 | ovs_be16 len; /* Length is 16. */ | |
492 | ovs_be32 vendor; /* NX_VENDOR_ID. */ | |
493 | ovs_be16 subtype; /* NXAST_REG_LOAD. */ | |
494 | ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */ | |
495 | ovs_be32 dst; /* Destination register. */ | |
496 | ovs_be64 value; /* Immediate value. */ | |
497 | }; | |
498 | OFP_ASSERT(sizeof(struct nx_action_reg_load) == 24); | |
499 | ||
96fc46e8 BP |
500 | /* Action structure for NXAST_NOTE. |
501 | * | |
502 | * This action has no effect. It is variable length. The switch does not | |
503 | * attempt to interpret the user-defined 'note' data in any way. A controller | |
504 | * can use this action to attach arbitrary metadata to a flow. | |
505 | * | |
506 | * This action might go away in the future. | |
507 | */ | |
508 | struct nx_action_note { | |
459749fe BP |
509 | ovs_be16 type; /* OFPAT_VENDOR. */ |
510 | ovs_be16 len; /* A multiple of 8, but at least 16. */ | |
511 | ovs_be32 vendor; /* NX_VENDOR_ID. */ | |
512 | ovs_be16 subtype; /* NXAST_NOTE. */ | |
96fc46e8 BP |
513 | uint8_t note[6]; /* Start of user-defined data. */ |
514 | /* Possibly followed by additional user-defined data. */ | |
515 | }; | |
516 | OFP_ASSERT(sizeof(struct nx_action_note) == 16); | |
517 | ||
53ddd40a BP |
518 | /* Action structure for NXAST_MULTIPATH. |
519 | * | |
520 | * This action performs the following steps in sequence: | |
521 | * | |
520e9a2a | 522 | * 1. Hashes the fields designated by 'fields', one of NX_HASH_FIELDS_*. |
53ddd40a BP |
523 | * Refer to the definition of "enum nx_mp_fields" for details. |
524 | * | |
525 | * The 'basis' value is used as a universal hash parameter, that is, | |
526 | * different values of 'basis' yield different hash functions. The | |
527 | * particular universal hash function used is implementation-defined. | |
528 | * | |
529 | * The hashed fields' values are drawn from the current state of the | |
530 | * flow, including all modifications that have been made by actions up to | |
531 | * this point. | |
532 | * | |
533 | * 2. Applies the multipath link choice algorithm specified by 'algorithm', | |
534 | * one of NX_MP_ALG_*. Refer to the definition of "enum nx_mp_algorithm" | |
535 | * for details. | |
536 | * | |
537 | * The output of the algorithm is 'link', an unsigned integer less than | |
538 | * or equal to 'max_link'. | |
539 | * | |
540 | * Some algorithms use 'arg' as an additional argument. | |
541 | * | |
542 | * 3. Stores 'link' in dst[ofs:ofs+n_bits]. The format and semantics of | |
338bd6a0 | 543 | * 'dst' and 'ofs_nbits' are similar to those for the NXAST_REG_LOAD |
43edca57 | 544 | * action. |
53ddd40a BP |
545 | * |
546 | * The switch will reject actions that have an unknown 'fields', or an unknown | |
547 | * 'algorithm', or in which ofs+n_bits is greater than the width of 'dst', or | |
548 | * in which 'max_link' is greater than or equal to 2**n_bits, with error type | |
549 | * OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT. | |
550 | */ | |
551 | struct nx_action_multipath { | |
552 | ovs_be16 type; /* OFPAT_VENDOR. */ | |
553 | ovs_be16 len; /* Length is 32. */ | |
554 | ovs_be32 vendor; /* NX_VENDOR_ID. */ | |
555 | ovs_be16 subtype; /* NXAST_MULTIPATH. */ | |
556 | ||
557 | /* What fields to hash and how. */ | |
520e9a2a | 558 | ovs_be16 fields; /* One of NX_HASH_FIELDS_*. */ |
53ddd40a BP |
559 | ovs_be16 basis; /* Universal hash parameter. */ |
560 | ovs_be16 pad0; | |
561 | ||
562 | /* Multipath link choice algorithm to apply to hash value. */ | |
563 | ovs_be16 algorithm; /* One of NX_MP_ALG_*. */ | |
564 | ovs_be16 max_link; /* Number of output links, minus 1. */ | |
565 | ovs_be32 arg; /* Algorithm-specific argument. */ | |
566 | ovs_be16 pad1; | |
567 | ||
568 | /* Where to store the result. */ | |
569 | ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */ | |
43edca57 | 570 | ovs_be32 dst; /* Destination. */ |
53ddd40a BP |
571 | }; |
572 | OFP_ASSERT(sizeof(struct nx_action_multipath) == 32); | |
573 | ||
53ddd40a BP |
574 | /* NXAST_MULTIPATH: Multipath link choice algorithm to apply. |
575 | * | |
576 | * In the descriptions below, 'n_links' is max_link + 1. */ | |
577 | enum nx_mp_algorithm { | |
578 | /* link = hash(flow) % n_links. | |
579 | * | |
580 | * Redistributes all traffic when n_links changes. O(1) performance. See | |
581 | * RFC 2992. | |
582 | * | |
583 | * Use UINT16_MAX for max_link to get a raw hash value. */ | |
584 | NX_MP_ALG_MODULO_N, | |
585 | ||
586 | /* link = hash(flow) / (MAX_HASH / n_links). | |
587 | * | |
588 | * Redistributes between one-quarter and one-half of traffic when n_links | |
589 | * changes. O(1) performance. See RFC 2992. | |
590 | */ | |
591 | NX_MP_ALG_HASH_THRESHOLD, | |
592 | ||
593 | /* for i in [0,n_links): | |
594 | * weights[i] = hash(flow, i) | |
595 | * link = { i such that weights[i] >= weights[j] for all j != i } | |
596 | * | |
597 | * Redistributes 1/n_links of traffic when n_links changes. O(n_links) | |
598 | * performance. If n_links is greater than a threshold (currently 64, but | |
599 | * subject to change), Open vSwitch will substitute another algorithm | |
600 | * automatically. See RFC 2992. */ | |
601 | NX_MP_ALG_HRW, /* Highest Random Weight. */ | |
602 | ||
603 | /* i = 0 | |
604 | * repeat: | |
605 | * i = i + 1 | |
606 | * link = hash(flow, i) % arg | |
607 | * while link > max_link | |
608 | * | |
609 | * Redistributes 1/n_links of traffic when n_links changes. O(1) | |
610 | * performance when arg/max_link is bounded by a constant. | |
611 | * | |
612 | * Redistributes all traffic when arg changes. | |
613 | * | |
614 | * arg must be greater than max_link and for best performance should be no | |
615 | * more than approximately max_link * 2. If arg is outside the acceptable | |
616 | * range, Open vSwitch will automatically substitute the least power of 2 | |
617 | * greater than max_link. | |
618 | * | |
619 | * This algorithm is specific to Open vSwitch. | |
620 | */ | |
621 | NX_MP_ALG_ITER_HASH /* Iterative Hash. */ | |
622 | }; | |
09246b99 | 623 | \f |
3b6a2571 EJ |
624 | /* Action structure for NXAST_AUTOPATH. |
625 | * | |
626 | * This action performs the following steps in sequence: | |
627 | * | |
628 | * 1. Hashes the flow using an implementation-defined hash function. | |
629 | * | |
630 | * The hashed fields' values are drawn from the current state of the | |
631 | * flow, including all modifications that have been made by actions up to | |
632 | * this point. | |
633 | * | |
634 | * 2. Selects an OpenFlow 'port'. | |
635 | * | |
636 | * 'port' is selected in an implementation-defined manner, taking into | |
637 | * account 'id' and the hash value calculated in step 1. | |
638 | * | |
639 | * Generally a switch will have been configured with a set of ports that | |
640 | * may be chosen given 'id'. The switch may take into account any number | |
641 | * of factors when choosing 'port' from its configured set. Factors may | |
642 | * include carrier, load, and the results of configuration protocols such | |
643 | * as LACP. | |
644 | * | |
645 | * 3. Stores 'port' in dst[ofs:ofs+n_bits]. | |
646 | * | |
647 | * The format and semantics of 'dst' and 'ofs_nbits' are similar to those | |
43edca57 | 648 | * for the NXAST_REG_LOAD action. |
3b6a2571 EJ |
649 | * |
650 | * The switch will reject actions in which ofs+n_bits is greater than the width | |
651 | * of 'dst', with error type OFPET_BAD_ACTION, code OFPBAC_BAD_ARGUMENT. | |
652 | */ | |
653 | struct nx_action_autopath { | |
654 | ovs_be16 type; /* OFPAT_VENDOR. */ | |
655 | ovs_be16 len; /* Length is 20. */ | |
656 | ovs_be32 vendor; /* NX_VENDOR_ID. */ | |
eac7014f | 657 | ovs_be16 subtype; /* NXAST_AUTOPATH. */ |
3b6a2571 EJ |
658 | |
659 | /* Where to store the result. */ | |
660 | ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */ | |
43edca57 | 661 | ovs_be32 dst; /* Destination. */ |
3b6a2571 EJ |
662 | |
663 | ovs_be32 id; /* Autopath ID. */ | |
664 | ovs_be32 pad; | |
665 | }; | |
666 | OFP_ASSERT(sizeof(struct nx_action_autopath) == 24); | |
667 | \f | |
a368bb53 | 668 | /* Action structure for NXAST_BUNDLE and NXAST_BUNDLE_LOAD. |
daff3353 | 669 | * |
a368bb53 EJ |
670 | * The bundle actions choose a slave from a supplied list of options. |
671 | * NXAST_BUNDLE outputs to its selection. NXAST_BUNDLE_LOAD writes its | |
672 | * selection to a register. | |
daff3353 EJ |
673 | * |
674 | * The list of possible slaves follows the nx_action_bundle structure. The size | |
675 | * of each slave is governed by its type as indicated by the 'slave_type' | |
676 | * parameter. The list of slaves should be padded at its end with zeros to make | |
677 | * the total length of the action a multiple of 8. | |
678 | * | |
679 | * Switches infer from the 'slave_type' parameter the size of each slave. All | |
680 | * implementations must support the NXM_OF_IN_PORT 'slave_type' which indicates | |
681 | * that the slaves are OpenFlow port numbers with NXM_LENGTH(NXM_OF_IN_PORT) == | |
682 | * 2 byte width. Switches should reject actions which indicate unknown or | |
683 | * unsupported slave types. | |
684 | * | |
685 | * Switches use a strategy dictated by the 'algorithm' parameter to choose a | |
686 | * slave. If the switch does not support the specified 'algorithm' parameter, | |
687 | * it should reject the action. | |
688 | * | |
689 | * Some slave selection strategies require the use of a hash function, in which | |
690 | * case the 'fields' and 'basis' parameters should be populated. The 'fields' | |
691 | * parameter (one of NX_HASH_FIELDS_*) designates which parts of the flow to | |
692 | * hash. Refer to the definition of "enum nx_hash_fields" for details. The | |
693 | * 'basis' parameter is used as a universal hash parameter. Different values | |
694 | * of 'basis' yield different hash results. | |
695 | * | |
696 | * The 'zero' parameter at the end of the action structure is reserved for | |
697 | * future use. Switches are required to reject actions which have nonzero | |
a368bb53 EJ |
698 | * bytes in the 'zero' field. |
699 | * | |
700 | * NXAST_BUNDLE actions should have 'ofs_nbits' and 'dst' zeroed. Switches | |
701 | * should reject actions which have nonzero bytes in either of these fields. | |
702 | * | |
703 | * NXAST_BUNDLE_LOAD stores the OpenFlow port number of the selected slave in | |
704 | * dst[ofs:ofs+n_bits]. The format and semantics of 'dst' and 'ofs_nbits' are | |
705 | * similar to those for the NXAST_REG_LOAD action. */ | |
daff3353 EJ |
706 | struct nx_action_bundle { |
707 | ovs_be16 type; /* OFPAT_VENDOR. */ | |
708 | ovs_be16 len; /* Length including slaves. */ | |
709 | ovs_be32 vendor; /* NX_VENDOR_ID. */ | |
710 | ovs_be16 subtype; /* NXAST_BUNDLE. */ | |
711 | ||
712 | /* Slave choice algorithm to apply to hash value. */ | |
713 | ovs_be16 algorithm; /* One of NX_BD_ALG_*. */ | |
714 | ||
715 | /* What fields to hash and how. */ | |
716 | ovs_be16 fields; /* One of NX_BD_FIELDS_*. */ | |
717 | ovs_be16 basis; /* Universal hash parameter. */ | |
718 | ||
719 | ovs_be32 slave_type; /* NXM_OF_IN_PORT. */ | |
720 | ovs_be16 n_slaves; /* Number of slaves. */ | |
721 | ||
a368bb53 EJ |
722 | ovs_be16 ofs_nbits; /* (ofs << 6) | (n_bits - 1). */ |
723 | ovs_be32 dst; /* Destination. */ | |
724 | ||
725 | uint8_t zero[4]; /* Reserved. Must be zero. */ | |
daff3353 EJ |
726 | }; |
727 | OFP_ASSERT(sizeof(struct nx_action_bundle) == 32); | |
728 | ||
729 | /* NXAST_BUNDLE: Bundle slave choice algorithm to apply. | |
730 | * | |
731 | * In the descriptions below, 'slaves' is the list of possible slaves in the | |
732 | * order they appear in the OpenFlow action. */ | |
733 | enum nx_bd_algorithm { | |
734 | /* Chooses the first live slave listed in the bundle. | |
735 | * | |
736 | * O(n_slaves) performance. */ | |
737 | NX_BD_ALG_ACTIVE_BACKUP, | |
738 | ||
739 | /* for i in [0,n_slaves): | |
740 | * weights[i] = hash(flow, i) | |
741 | * slave = { slaves[i] such that weights[i] >= weights[j] for all j != i } | |
742 | * | |
743 | * Redistributes 1/n_slaves of traffic when a slave's liveness changes. | |
744 | * O(n_slaves) performance. | |
745 | * | |
746 | * Uses the 'fields' and 'basis' parameters. */ | |
747 | NX_BD_ALG_HRW /* Highest Random Weight. */ | |
748 | }; | |
749 | \f | |
09246b99 BP |
750 | /* Flexible flow specifications (aka NXM = Nicira Extended Match). |
751 | * | |
752 | * OpenFlow 1.0 has "struct ofp_match" for specifying flow matches. This | |
753 | * structure is fixed-length and hence difficult to extend. This section | |
754 | * describes a more flexible, variable-length flow match, called "nx_match" for | |
755 | * short, that is also supported by Open vSwitch. This section also defines a | |
756 | * replacement for each OpenFlow message that includes struct ofp_match. | |
757 | * | |
758 | * | |
759 | * Format | |
760 | * ====== | |
761 | * | |
762 | * An nx_match is a sequence of zero or more "nxm_entry"s, which are | |
763 | * type-length-value (TLV) entries, each 5 to 259 (inclusive) bytes long. | |
764 | * "nxm_entry"s are not aligned on or padded to any multibyte boundary. The | |
765 | * first 4 bytes of an nxm_entry are its "header", followed by the entry's | |
766 | * "body". | |
767 | * | |
768 | * An nxm_entry's header is interpreted as a 32-bit word in network byte order: | |
769 | * | |
770 | * |<-------------------- nxm_type ------------------>| | |
771 | * | | | |
772 | * |31 16 15 9| 8 7 0 | |
773 | * +----------------------------------+---------------+--+------------------+ | |
774 | * | nxm_vendor | nxm_field |hm| nxm_length | | |
775 | * +----------------------------------+---------------+--+------------------+ | |
776 | * | |
777 | * The most-significant 23 bits of the header are collectively "nxm_type". | |
778 | * Bits 16...31 are "nxm_vendor", one of the NXM_VENDOR_* values below. Bits | |
779 | * 9...15 are "nxm_field", which is a vendor-specific value. nxm_type normally | |
780 | * designates a protocol header, such as the Ethernet type, but it can also | |
781 | * refer to packet metadata, such as the switch port on which a packet arrived. | |
782 | * | |
783 | * Bit 8 is "nxm_hasmask" (labeled "hm" above for space reasons). The meaning | |
784 | * of this bit is explained later. | |
785 | * | |
786 | * The least-significant 8 bits are "nxm_length", a positive integer. The | |
787 | * length of the nxm_entry, including the header, is exactly 4 + nxm_length | |
788 | * bytes. | |
789 | * | |
790 | * For a given nxm_vendor, nxm_field, and nxm_hasmask value, nxm_length is a | |
791 | * constant. It is included only to allow software to minimally parse | |
792 | * "nxm_entry"s of unknown types. (Similarly, for a given nxm_vendor, | |
793 | * nxm_field, and nxm_length, nxm_hasmask is a constant.) | |
794 | * | |
795 | * | |
796 | * Semantics | |
797 | * ========= | |
798 | * | |
799 | * A zero-length nx_match (one with no "nxm_entry"s) matches every packet. | |
800 | * | |
801 | * An nxm_entry places a constraint on the packets matched by the nx_match: | |
802 | * | |
803 | * - If nxm_hasmask is 0, the nxm_entry's body contains a value for the | |
804 | * field, called "nxm_value". The nx_match matches only packets in which | |
805 | * the field equals nxm_value. | |
806 | * | |
807 | * - If nxm_hasmask is 1, then the nxm_entry's body contains a value for the | |
808 | * field (nxm_value), followed by a bitmask of the same length as the | |
809 | * value, called "nxm_mask". For each 1-bit in position J in nxm_mask, the | |
810 | * nx_match matches only packets for which bit J in the given field's value | |
811 | * matches bit J in nxm_value. A 0-bit in nxm_mask causes the | |
812 | * corresponding bits in nxm_value and the field's value to be ignored. | |
813 | * (The sense of the nxm_mask bits is the opposite of that used by the | |
814 | * "wildcards" member of struct ofp_match.) | |
815 | * | |
816 | * When nxm_hasmask is 1, nxm_length is always even. | |
817 | * | |
818 | * An all-zero-bits nxm_mask is equivalent to omitting the nxm_entry | |
819 | * entirely. An all-one-bits nxm_mask is equivalent to specifying 0 for | |
820 | * nxm_hasmask. | |
821 | * | |
822 | * When there are multiple "nxm_entry"s, all of the constraints must be met. | |
823 | * | |
824 | * | |
825 | * Mask Restrictions | |
826 | * ================= | |
827 | * | |
828 | * Masks may be restricted: | |
829 | * | |
830 | * - Some nxm_types may not support masked wildcards, that is, nxm_hasmask | |
831 | * must always be 0 when these fields are specified. For example, the | |
832 | * field that identifies the port on which a packet was received may not be | |
833 | * masked. | |
834 | * | |
835 | * - Some nxm_types that do support masked wildcards may only support certain | |
836 | * nxm_mask patterns. For example, fields that have IPv4 address values | |
837 | * may be restricted to CIDR masks. | |
838 | * | |
839 | * These restrictions should be noted in specifications for individual fields. | |
840 | * A switch may accept an nxm_hasmask or nxm_mask value that the specification | |
841 | * disallows, if the switch correctly implements support for that nxm_hasmask | |
842 | * or nxm_mask value. A switch must reject an attempt to set up a flow that | |
843 | * contains a nxm_hasmask or nxm_mask value that it does not support. | |
844 | * | |
845 | * | |
846 | * Prerequisite Restrictions | |
847 | * ========================= | |
848 | * | |
849 | * The presence of an nxm_entry with a given nxm_type may be restricted based | |
850 | * on the presence of or values of other "nxm_entry"s. For example: | |
851 | * | |
852 | * - An nxm_entry for nxm_type=NXM_OF_IP_TOS is allowed only if it is | |
853 | * preceded by another entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, | |
854 | * and nxm_value=0x0800. That is, matching on the IP source address is | |
855 | * allowed only if the Ethernet type is explicitly set to IP. | |
856 | * | |
857 | * - An nxm_entry for nxm_type=NXM_OF_TCP_SRC is allowed only if it is preced | |
858 | * by an entry with nxm_type=NXM_OF_ETH_TYPE, nxm_hasmask=0, | |
859 | * nxm_value=0x0800 and another with nxm_type=NXM_OF_IP_PROTO, | |
860 | * nxm_hasmask=0, nxm_value=6, in that order. That is, matching on the TCP | |
861 | * source port is allowed only if the Ethernet type is IP and the IP | |
862 | * protocol is TCP. | |
863 | * | |
864 | * These restrictions should be noted in specifications for individual fields. | |
865 | * A switch may implement relaxed versions of these restrictions. A switch | |
866 | * must reject an attempt to set up a flow that violates its restrictions. | |
867 | * | |
868 | * | |
869 | * Ordering Restrictions | |
870 | * ===================== | |
871 | * | |
872 | * An nxm_entry that has prerequisite restrictions must appear after the | |
873 | * "nxm_entry"s for its prerequisites. Ordering of "nxm_entry"s within an | |
874 | * nx_match is not otherwise constrained. | |
875 | * | |
876 | * Any given nxm_type may appear in an nx_match at most once. | |
877 | * | |
878 | * | |
879 | * nxm_entry Examples | |
880 | * ================== | |
881 | * | |
882 | * These examples show the format of a single nxm_entry with particular | |
883 | * nxm_hasmask and nxm_length values. The diagrams are labeled with field | |
884 | * numbers and byte indexes. | |
885 | * | |
886 | * | |
887 | * 8-bit nxm_value, nxm_hasmask=1, nxm_length=1: | |
888 | * | |
889 | * 0 3 4 5 | |
890 | * +------------+---+---+ | |
891 | * | header | v | m | | |
892 | * +------------+---+---+ | |
893 | * | |
894 | * | |
895 | * 16-bit nxm_value, nxm_hasmask=0, nxm_length=2: | |
896 | * | |
897 | * 0 3 4 5 | |
898 | * +------------+------+ | |
899 | * | header | value| | |
900 | * +------------+------+ | |
901 | * | |
902 | * | |
903 | * 32-bit nxm_value, nxm_hasmask=0, nxm_length=4: | |
904 | * | |
905 | * 0 3 4 7 | |
906 | * +------------+-------------+ | |
907 | * | header | nxm_value | | |
908 | * +------------+-------------+ | |
909 | * | |
910 | * | |
911 | * 48-bit nxm_value, nxm_hasmask=0, nxm_length=6: | |
912 | * | |
913 | * 0 3 4 9 | |
914 | * +------------+------------------+ | |
915 | * | header | nxm_value | | |
916 | * +------------+------------------+ | |
917 | * | |
918 | * | |
919 | * 48-bit nxm_value, nxm_hasmask=1, nxm_length=12: | |
920 | * | |
921 | * 0 3 4 9 10 15 | |
922 | * +------------+------------------+------------------+ | |
923 | * | header | nxm_value | nxm_mask | | |
924 | * +------------+------------------+------------------+ | |
925 | * | |
926 | * | |
927 | * Error Reporting | |
928 | * =============== | |
929 | * | |
930 | * A switch should report an error in an nx_match using error type | |
931 | * OFPET_BAD_REQUEST and one of the NXBRC_NXM_* codes. Ideally the switch | |
932 | * should report a specific error code, if one is assigned for the particular | |
933 | * problem, but NXBRC_NXM_INVALID is also available to report a generic | |
934 | * nx_match error. | |
935 | */ | |
936 | ||
937 | #define NXM_HEADER__(VENDOR, FIELD, HASMASK, LENGTH) \ | |
938 | (((VENDOR) << 16) | ((FIELD) << 9) | ((HASMASK) << 8) | (LENGTH)) | |
939 | #define NXM_HEADER(VENDOR, FIELD, LENGTH) \ | |
940 | NXM_HEADER__(VENDOR, FIELD, 0, LENGTH) | |
941 | #define NXM_HEADER_W(VENDOR, FIELD, LENGTH) \ | |
942 | NXM_HEADER__(VENDOR, FIELD, 1, (LENGTH) * 2) | |
943 | #define NXM_VENDOR(HEADER) ((HEADER) >> 16) | |
944 | #define NXM_FIELD(HEADER) (((HEADER) >> 9) & 0x7f) | |
945 | #define NXM_TYPE(HEADER) (((HEADER) >> 9) & 0x7fffff) | |
946 | #define NXM_HASMASK(HEADER) (((HEADER) >> 8) & 1) | |
947 | #define NXM_LENGTH(HEADER) ((HEADER) & 0xff) | |
948 | ||
949 | #define NXM_MAKE_WILD_HEADER(HEADER) \ | |
950 | NXM_HEADER_W(NXM_VENDOR(HEADER), NXM_FIELD(HEADER), NXM_LENGTH(HEADER)) | |
951 | ||
952 | /* ## ------------------------------- ## */ | |
953 | /* ## OpenFlow 1.0-compatible fields. ## */ | |
954 | /* ## ------------------------------- ## */ | |
955 | ||
956 | /* Physical or virtual port on which the packet was received. | |
957 | * | |
958 | * Prereqs: None. | |
959 | * | |
960 | * Format: 16-bit integer in network byte order. | |
961 | * | |
962 | * Masking: Not maskable. */ | |
963 | #define NXM_OF_IN_PORT NXM_HEADER (0x0000, 0, 2) | |
964 | ||
965 | /* Source or destination address in Ethernet header. | |
966 | * | |
967 | * Prereqs: None. | |
968 | * | |
969 | * Format: 48-bit Ethernet MAC address. | |
970 | * | |
1e37a2d7 BP |
971 | * Masking: The nxm_mask patterns 01:00:00:00:00:00 and FE:FF:FF:FF:FF:FF must |
972 | * be supported for NXM_OF_ETH_DST_W (as well as the trivial patterns that | |
973 | * are all-0-bits or all-1-bits). Support for other patterns and for masking | |
974 | * of NXM_OF_ETH_SRC is optional. */ | |
09246b99 | 975 | #define NXM_OF_ETH_DST NXM_HEADER (0x0000, 1, 6) |
1e37a2d7 | 976 | #define NXM_OF_ETH_DST_W NXM_HEADER_W(0x0000, 1, 6) |
09246b99 BP |
977 | #define NXM_OF_ETH_SRC NXM_HEADER (0x0000, 2, 6) |
978 | ||
979 | /* Packet's Ethernet type. | |
980 | * | |
981 | * For an Ethernet II packet this is taken from the Ethernet header. For an | |
982 | * 802.2 LLC+SNAP header with OUI 00-00-00 this is taken from the SNAP header. | |
983 | * A packet that has neither format has value 0x05ff | |
984 | * (OFP_DL_TYPE_NOT_ETH_TYPE). | |
985 | * | |
986 | * For a packet with an 802.1Q header, this is the type of the encapsulated | |
987 | * frame. | |
988 | * | |
989 | * Prereqs: None. | |
990 | * | |
991 | * Format: 16-bit integer in network byte order. | |
992 | * | |
993 | * Masking: Not maskable. */ | |
994 | #define NXM_OF_ETH_TYPE NXM_HEADER (0x0000, 3, 2) | |
995 | ||
996 | /* 802.1Q TCI. | |
997 | * | |
998 | * For a packet with an 802.1Q header, this is the Tag Control Information | |
999 | * (TCI) field, with the CFI bit forced to 1. For a packet with no 802.1Q | |
1000 | * header, this has value 0. | |
1001 | * | |
1002 | * Prereqs: None. | |
1003 | * | |
1004 | * Format: 16-bit integer in network byte order. | |
1005 | * | |
1006 | * Masking: Arbitrary masks. | |
1007 | * | |
1008 | * This field can be used in various ways: | |
1009 | * | |
1010 | * - If it is not constrained at all, the nx_match matches packets without | |
1011 | * an 802.1Q header or with an 802.1Q header that has any TCI value. | |
1012 | * | |
1013 | * - Testing for an exact match with 0 matches only packets without an | |
1014 | * 802.1Q header. | |
1015 | * | |
1016 | * - Testing for an exact match with a TCI value with CFI=1 matches packets | |
1017 | * that have an 802.1Q header with a specified VID and PCP. | |
1018 | * | |
1019 | * - Testing for an exact match with a nonzero TCI value with CFI=0 does | |
1020 | * not make sense. The switch may reject this combination. | |
1021 | * | |
1022 | * - Testing with a specific VID and CFI=1, with nxm_mask=0x1fff, matches | |
1023 | * packets that have an 802.1Q header with that VID (and any PCP). | |
1024 | * | |
1025 | * - Testing with a specific PCP and CFI=1, with nxm_mask=0xf000, matches | |
1026 | * packets that have an 802.1Q header with that PCP (and any VID). | |
1027 | * | |
8ca67760 | 1028 | * - Testing with nxm_value=0, nxm_mask=0x0fff matches packets with no 802.1Q |
09246b99 | 1029 | * header or with an 802.1Q header with a VID of 0. |
8ca67760 BP |
1030 | * |
1031 | * - Testing with nxm_value=0, nxm_mask=0xe000 matches packets with no 802.1Q | |
1032 | * header or with an 802.1Q header with a PCP of 0. | |
1033 | * | |
1034 | * - Testing with nxm_value=0, nxm_mask=0xefff matches packets with no 802.1Q | |
1035 | * header or with an 802.1Q header with both VID and PCP of 0. | |
09246b99 BP |
1036 | */ |
1037 | #define NXM_OF_VLAN_TCI NXM_HEADER (0x0000, 4, 2) | |
1038 | #define NXM_OF_VLAN_TCI_W NXM_HEADER_W(0x0000, 4, 2) | |
1039 | ||
1040 | /* The "type of service" byte of the IP header, with the ECN bits forced to 0. | |
1041 | * | |
d31f1109 | 1042 | * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd. |
09246b99 BP |
1043 | * |
1044 | * Format: 8-bit integer with 2 least-significant bits forced to 0. | |
1045 | * | |
1046 | * Masking: Not maskable. */ | |
1047 | #define NXM_OF_IP_TOS NXM_HEADER (0x0000, 5, 1) | |
1048 | ||
1049 | /* The "protocol" byte in the IP header. | |
1050 | * | |
d31f1109 | 1051 | * Prereqs: NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd. |
09246b99 BP |
1052 | * |
1053 | * Format: 8-bit integer. | |
1054 | * | |
1055 | * Masking: Not maskable. */ | |
1056 | #define NXM_OF_IP_PROTO NXM_HEADER (0x0000, 6, 1) | |
1057 | ||
1058 | /* The source or destination address in the IP header. | |
1059 | * | |
1060 | * Prereqs: NXM_OF_ETH_TYPE must match 0x0800 exactly. | |
1061 | * | |
1062 | * Format: 32-bit integer in network byte order. | |
1063 | * | |
1064 | * Masking: Only CIDR masks are allowed, that is, masks that consist of N | |
1065 | * high-order bits set to 1 and the other 32-N bits set to 0. */ | |
1066 | #define NXM_OF_IP_SRC NXM_HEADER (0x0000, 7, 4) | |
1067 | #define NXM_OF_IP_SRC_W NXM_HEADER_W(0x0000, 7, 4) | |
1068 | #define NXM_OF_IP_DST NXM_HEADER (0x0000, 8, 4) | |
1069 | #define NXM_OF_IP_DST_W NXM_HEADER_W(0x0000, 8, 4) | |
1070 | ||
1071 | /* The source or destination port in the TCP header. | |
1072 | * | |
1073 | * Prereqs: | |
d31f1109 | 1074 | * NXM_OF_ETH_TYPE must be either 0x0800 or 0x86dd. |
09246b99 BP |
1075 | * NXM_OF_IP_PROTO must match 6 exactly. |
1076 | * | |
1077 | * Format: 16-bit integer in network byte order. | |
1078 | * | |
1079 | * Masking: Not maskable. */ | |
1080 | #define NXM_OF_TCP_SRC NXM_HEADER (0x0000, 9, 2) | |
1081 | #define NXM_OF_TCP_DST NXM_HEADER (0x0000, 10, 2) | |
1082 | ||
1083 | /* The source or destination port in the UDP header. | |
1084 | * | |
1085 | * Prereqs: | |
d31f1109 | 1086 | * NXM_OF_ETH_TYPE must match either 0x0800 or 0x86dd. |
09246b99 BP |
1087 | * NXM_OF_IP_PROTO must match 17 exactly. |
1088 | * | |
1089 | * Format: 16-bit integer in network byte order. | |
1090 | * | |
1091 | * Masking: Not maskable. */ | |
1092 | #define NXM_OF_UDP_SRC NXM_HEADER (0x0000, 11, 2) | |
1093 | #define NXM_OF_UDP_DST NXM_HEADER (0x0000, 12, 2) | |
1094 | ||
1095 | /* The type or code in the ICMP header. | |
1096 | * | |
1097 | * Prereqs: | |
1098 | * NXM_OF_ETH_TYPE must match 0x0800 exactly. | |
1099 | * NXM_OF_IP_PROTO must match 1 exactly. | |
1100 | * | |
1101 | * Format: 8-bit integer. | |
1102 | * | |
1103 | * Masking: Not maskable. */ | |
1104 | #define NXM_OF_ICMP_TYPE NXM_HEADER (0x0000, 13, 1) | |
1105 | #define NXM_OF_ICMP_CODE NXM_HEADER (0x0000, 14, 1) | |
1106 | ||
1107 | /* ARP opcode. | |
1108 | * | |
1109 | * For an Ethernet+IP ARP packet, the opcode in the ARP header. Always 0 | |
1110 | * otherwise. Only ARP opcodes between 1 and 255 should be specified for | |
1111 | * matching. | |
1112 | * | |
1113 | * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly. | |
1114 | * | |
1115 | * Format: 16-bit integer in network byte order. | |
1116 | * | |
1117 | * Masking: Not maskable. */ | |
1118 | #define NXM_OF_ARP_OP NXM_HEADER (0x0000, 15, 2) | |
1119 | ||
1120 | /* For an Ethernet+IP ARP packet, the source or target protocol address | |
1121 | * in the ARP header. Always 0 otherwise. | |
1122 | * | |
1123 | * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly. | |
1124 | * | |
1125 | * Format: 32-bit integer in network byte order. | |
1126 | * | |
1127 | * Masking: Only CIDR masks are allowed, that is, masks that consist of N | |
1128 | * high-order bits set to 1 and the other 32-N bits set to 0. */ | |
1129 | #define NXM_OF_ARP_SPA NXM_HEADER (0x0000, 16, 4) | |
1130 | #define NXM_OF_ARP_SPA_W NXM_HEADER_W(0x0000, 16, 4) | |
1131 | #define NXM_OF_ARP_TPA NXM_HEADER (0x0000, 17, 4) | |
1132 | #define NXM_OF_ARP_TPA_W NXM_HEADER_W(0x0000, 17, 4) | |
1133 | ||
1134 | /* ## ------------------------ ## */ | |
1135 | /* ## Nicira match extensions. ## */ | |
1136 | /* ## ------------------------ ## */ | |
1137 | ||
b6c9e612 BP |
1138 | /* Metadata registers. |
1139 | * | |
1140 | * Registers initially have value 0. Actions allow register values to be | |
1141 | * manipulated. | |
1142 | * | |
1143 | * Prereqs: None. | |
1144 | * | |
1145 | * Format: Array of 32-bit integer registers. Space is reserved for up to | |
1146 | * NXM_NX_MAX_REGS registers, but switches may implement fewer. | |
1147 | * | |
1148 | * Masking: Arbitrary masks. */ | |
1149 | #define NXM_NX_MAX_REGS 16 | |
1150 | #define NXM_NX_REG(IDX) NXM_HEADER (0x0001, IDX, 4) | |
1151 | #define NXM_NX_REG_W(IDX) NXM_HEADER_W(0x0001, IDX, 4) | |
1152 | #define NXM_NX_REG_IDX(HEADER) NXM_FIELD(HEADER) | |
19e7439c BP |
1153 | #define NXM_IS_NX_REG(HEADER) (!((((HEADER) ^ NXM_NX_REG0)) & 0xffffe1ff)) |
1154 | #define NXM_IS_NX_REG_W(HEADER) (!((((HEADER) ^ NXM_NX_REG0_W)) & 0xffffe1ff)) | |
b6c9e612 BP |
1155 | #define NXM_NX_REG0 NXM_HEADER (0x0001, 0, 4) |
1156 | #define NXM_NX_REG0_W NXM_HEADER_W(0x0001, 0, 4) | |
1157 | #define NXM_NX_REG1 NXM_HEADER (0x0001, 1, 4) | |
1158 | #define NXM_NX_REG1_W NXM_HEADER_W(0x0001, 1, 4) | |
1159 | #define NXM_NX_REG2 NXM_HEADER (0x0001, 2, 4) | |
1160 | #define NXM_NX_REG2_W NXM_HEADER_W(0x0001, 2, 4) | |
1161 | #define NXM_NX_REG3 NXM_HEADER (0x0001, 3, 4) | |
1162 | #define NXM_NX_REG3_W NXM_HEADER_W(0x0001, 3, 4) | |
1163 | ||
09246b99 BP |
1164 | /* Tunnel ID. |
1165 | * | |
1166 | * For a packet received via GRE tunnel including a (32-bit) key, the key is | |
1167 | * stored in the low 32-bits and the high bits are zeroed. For other packets, | |
1168 | * the value is 0. | |
1169 | * | |
1170 | * Prereqs: None. | |
1171 | * | |
1172 | * Format: 64-bit integer in network byte order. | |
1173 | * | |
1174 | * Masking: Arbitrary masks. */ | |
1175 | #define NXM_NX_TUN_ID NXM_HEADER (0x0001, 16, 8) | |
1176 | #define NXM_NX_TUN_ID_W NXM_HEADER_W(0x0001, 16, 8) | |
1177 | ||
bad68a99 JP |
1178 | /* For an Ethernet+IP ARP packet, the source or target hardware address |
1179 | * in the ARP header. Always 0 otherwise. | |
1180 | * | |
1181 | * Prereqs: NXM_OF_ETH_TYPE must match 0x0806 exactly. | |
1182 | * | |
1183 | * Format: 48-bit Ethernet MAC address. | |
1184 | * | |
1185 | * Masking: Not maskable. */ | |
1186 | #define NXM_NX_ARP_SHA NXM_HEADER (0x0001, 17, 6) | |
1187 | #define NXM_NX_ARP_THA NXM_HEADER (0x0001, 18, 6) | |
1188 | ||
d31f1109 JP |
1189 | /* The source or destination address in the IPv6 header. |
1190 | * | |
1191 | * Prereqs: NXM_OF_ETH_TYPE must match 0x86dd exactly. | |
1192 | * | |
1193 | * Format: 128-bit IPv6 address. | |
1194 | * | |
1195 | * Masking: Only CIDR masks are allowed, that is, masks that consist of N | |
1196 | * high-order bits set to 1 and the other 128-N bits set to 0. */ | |
1197 | #define NXM_NX_IPV6_SRC NXM_HEADER (0x0001, 19, 16) | |
1198 | #define NXM_NX_IPV6_SRC_W NXM_HEADER_W(0x0001, 19, 16) | |
1199 | #define NXM_NX_IPV6_DST NXM_HEADER (0x0001, 20, 16) | |
1200 | #define NXM_NX_IPV6_DST_W NXM_HEADER_W(0x0001, 20, 16) | |
1201 | ||
1202 | /* The type or code in the ICMPv6 header. | |
1203 | * | |
1204 | * Prereqs: | |
1205 | * NXM_OF_ETH_TYPE must match 0x86dd exactly. | |
1206 | * NXM_OF_IP_PROTO must match 58 exactly. | |
1207 | * | |
1208 | * Format: 8-bit integer. | |
1209 | * | |
1210 | * Masking: Not maskable. */ | |
1211 | #define NXM_NX_ICMPV6_TYPE NXM_HEADER (0x0001, 21, 1) | |
1212 | #define NXM_NX_ICMPV6_CODE NXM_HEADER (0x0001, 22, 1) | |
1213 | ||
685a51a5 JP |
1214 | /* The target address in an IPv6 Neighbor Discovery message. |
1215 | * | |
1216 | * Prereqs: | |
1217 | * NXM_OF_ETH_TYPE must match 0x86dd exactly. | |
1218 | * NXM_OF_IP_PROTO must match 58 exactly. | |
1219 | * NXM_OF_ICMPV6_TYPE must be either 135 or 136. | |
1220 | * | |
1221 | * Format: 128-bit IPv6 address. | |
1222 | * | |
1223 | * Masking: Not maskable. */ | |
1224 | #define NXM_NX_ND_TARGET NXM_HEADER (0x0001, 23, 16) | |
1225 | ||
1226 | /* The source link-layer address option in an IPv6 Neighbor Discovery | |
1227 | * message. | |
1228 | * | |
1229 | * Prereqs: | |
1230 | * NXM_OF_ETH_TYPE must match 0x86dd exactly. | |
1231 | * NXM_OF_IP_PROTO must match 58 exactly. | |
1232 | * NXM_OF_ICMPV6_TYPE must be exactly 135. | |
1233 | * | |
1234 | * Format: 48-bit Ethernet MAC address. | |
1235 | * | |
1236 | * Masking: Not maskable. */ | |
1237 | #define NXM_NX_ND_SLL NXM_HEADER (0x0001, 24, 6) | |
1238 | ||
1239 | /* The target link-layer address option in an IPv6 Neighbor Discovery | |
1240 | * message. | |
1241 | * | |
1242 | * Prereqs: | |
1243 | * NXM_OF_ETH_TYPE must match 0x86dd exactly. | |
1244 | * NXM_OF_IP_PROTO must match 58 exactly. | |
1245 | * NXM_OF_ICMPV6_TYPE must be exactly 136. | |
1246 | * | |
1247 | * Format: 48-bit Ethernet MAC address. | |
1248 | * | |
1249 | * Masking: Not maskable. */ | |
1250 | #define NXM_NX_ND_TLL NXM_HEADER (0x0001, 25, 6) | |
1251 | ||
d31f1109 | 1252 | |
09246b99 BP |
1253 | /* ## --------------------- ## */ |
1254 | /* ## Requests and replies. ## */ | |
1255 | /* ## --------------------- ## */ | |
1256 | ||
492f7572 | 1257 | enum nx_flow_format { |
09246b99 | 1258 | NXFF_OPENFLOW10 = 0, /* Standard OpenFlow 1.0 compatible. */ |
09246b99 BP |
1259 | NXFF_NXM = 2 /* Nicira extended match. */ |
1260 | }; | |
1261 | ||
1262 | /* NXT_SET_FLOW_FORMAT request. */ | |
1263 | struct nxt_set_flow_format { | |
1264 | struct ofp_header header; | |
1265 | ovs_be32 vendor; /* NX_VENDOR_ID. */ | |
1266 | ovs_be32 subtype; /* NXT_SET_FLOW_FORMAT. */ | |
1267 | ovs_be32 format; /* One of NXFF_*. */ | |
1268 | }; | |
1269 | OFP_ASSERT(sizeof(struct nxt_set_flow_format) == 20); | |
1270 | ||
1271 | /* NXT_FLOW_MOD (analogous to OFPT_FLOW_MOD). */ | |
1272 | struct nx_flow_mod { | |
1273 | struct nicira_header nxh; | |
1274 | ovs_be64 cookie; /* Opaque controller-issued identifier. */ | |
1275 | ovs_be16 command; /* One of OFPFC_*. */ | |
1276 | ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */ | |
1277 | ovs_be16 hard_timeout; /* Max time before discarding (seconds). */ | |
1278 | ovs_be16 priority; /* Priority level of flow entry. */ | |
1279 | ovs_be32 buffer_id; /* Buffered packet to apply to (or -1). | |
1280 | Not meaningful for OFPFC_DELETE*. */ | |
1281 | ovs_be16 out_port; /* For OFPFC_DELETE* commands, require | |
1282 | matching entries to include this as an | |
1283 | output port. A value of OFPP_NONE | |
1284 | indicates no restriction. */ | |
1285 | ovs_be16 flags; /* One of OFPFF_*. */ | |
1286 | ovs_be16 match_len; /* Size of nx_match. */ | |
1287 | uint8_t pad[6]; /* Align to 64-bits. */ | |
1288 | /* Followed by: | |
1289 | * - Exactly match_len (possibly 0) bytes containing the nx_match, then | |
1290 | * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of | |
1291 | * all-zero bytes, then | |
1292 | * - Actions to fill out the remainder of the message length (always a | |
1293 | * multiple of 8). | |
1294 | */ | |
1295 | }; | |
1296 | OFP_ASSERT(sizeof(struct nx_flow_mod) == 48); | |
1297 | ||
1298 | /* NXT_FLOW_REMOVED (analogous to OFPT_FLOW_REMOVED). */ | |
1299 | struct nx_flow_removed { | |
1300 | struct nicira_header nxh; | |
1301 | ovs_be64 cookie; /* Opaque controller-issued identifier. */ | |
1302 | ovs_be16 priority; /* Priority level of flow entry. */ | |
1303 | uint8_t reason; /* One of OFPRR_*. */ | |
1304 | uint8_t pad[1]; /* Align to 32-bits. */ | |
1305 | ovs_be32 duration_sec; /* Time flow was alive in seconds. */ | |
1306 | ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond | |
1307 | duration_sec. */ | |
1308 | ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */ | |
1309 | ovs_be16 match_len; /* Size of nx_match. */ | |
1310 | ovs_be64 packet_count; | |
1311 | ovs_be64 byte_count; | |
1312 | /* Followed by: | |
1313 | * - Exactly match_len (possibly 0) bytes containing the nx_match, then | |
1314 | * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of | |
1315 | * all-zero bytes. */ | |
1316 | }; | |
1317 | OFP_ASSERT(sizeof(struct nx_flow_removed) == 56); | |
1318 | ||
1319 | /* Nicira vendor stats request of type NXST_FLOW (analogous to OFPST_FLOW | |
1320 | * request). */ | |
1321 | struct nx_flow_stats_request { | |
1322 | struct nicira_stats_msg nsm; | |
1323 | ovs_be16 out_port; /* Require matching entries to include this | |
1324 | as an output port. A value of OFPP_NONE | |
1325 | indicates no restriction. */ | |
1326 | ovs_be16 match_len; /* Length of nx_match. */ | |
1327 | uint8_t table_id; /* ID of table to read (from ofp_table_stats) | |
1328 | or 0xff for all tables. */ | |
1329 | uint8_t pad[3]; /* Align to 64 bits. */ | |
1330 | /* Followed by: | |
1331 | * - Exactly match_len (possibly 0) bytes containing the nx_match, then | |
1332 | * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of | |
1333 | * all-zero bytes, which must also exactly fill out the length of the | |
1334 | * message. | |
1335 | */ | |
1336 | }; | |
1337 | OFP_ASSERT(sizeof(struct nx_flow_stats_request) == 32); | |
1338 | ||
1339 | /* Body for Nicira vendor stats reply of type NXST_FLOW (analogous to | |
1340 | * OFPST_FLOW reply). */ | |
1341 | struct nx_flow_stats { | |
1342 | ovs_be16 length; /* Length of this entry. */ | |
1343 | uint8_t table_id; /* ID of table flow came from. */ | |
1344 | uint8_t pad; | |
1345 | ovs_be32 duration_sec; /* Time flow has been alive in seconds. */ | |
1346 | ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds | |
1347 | beyond duration_sec. */ | |
1348 | ovs_be16 priority; /* Priority of the entry. Only meaningful | |
1349 | when this is not an exact-match entry. */ | |
1350 | ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */ | |
1351 | ovs_be16 hard_timeout; /* Number of seconds before expiration. */ | |
1352 | ovs_be16 match_len; /* Length of nx_match. */ | |
1353 | uint8_t pad2[4]; /* Align to 64 bits. */ | |
1354 | ovs_be64 cookie; /* Opaque controller-issued identifier. */ | |
5e9d0469 BP |
1355 | ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */ |
1356 | ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */ | |
09246b99 BP |
1357 | /* Followed by: |
1358 | * - Exactly match_len (possibly 0) bytes containing the nx_match, then | |
1359 | * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of | |
1360 | * all-zero bytes, then | |
1361 | * - Actions to fill out the remainder 'length' bytes (always a multiple | |
1362 | * of 8). | |
1363 | */ | |
1364 | }; | |
1365 | OFP_ASSERT(sizeof(struct nx_flow_stats) == 48); | |
1366 | ||
1367 | /* Nicira vendor stats request of type NXST_AGGREGATE (analogous to | |
1368 | * OFPST_AGGREGATE request). */ | |
1369 | struct nx_aggregate_stats_request { | |
1370 | struct nicira_stats_msg nsm; | |
1371 | ovs_be16 out_port; /* Require matching entries to include this | |
1372 | as an output port. A value of OFPP_NONE | |
1373 | indicates no restriction. */ | |
1374 | ovs_be16 match_len; /* Length of nx_match. */ | |
1375 | uint8_t table_id; /* ID of table to read (from ofp_table_stats) | |
1376 | or 0xff for all tables. */ | |
1377 | uint8_t pad[3]; /* Align to 64 bits. */ | |
1378 | /* Followed by: | |
1379 | * - Exactly match_len (possibly 0) bytes containing the nx_match, then | |
1380 | * - Exactly (match_len + 7)/8*8 - match_len (between 0 and 7) bytes of | |
1381 | * all-zero bytes, which must also exactly fill out the length of the | |
1382 | * message. | |
1383 | */ | |
1384 | }; | |
1385 | OFP_ASSERT(sizeof(struct nx_aggregate_stats_request) == 32); | |
1386 | ||
1387 | /* Body for nicira_stats_msg reply of type NXST_AGGREGATE (analogous to | |
675baf0c | 1388 | * OFPST_AGGREGATE reply). */ |
09246b99 BP |
1389 | struct nx_aggregate_stats_reply { |
1390 | struct nicira_stats_msg nsm; | |
5e9d0469 BP |
1391 | ovs_be64 packet_count; /* Number of packets, UINT64_MAX if unknown. */ |
1392 | ovs_be64 byte_count; /* Number of bytes, UINT64_MAX if unknown. */ | |
1393 | ovs_be32 flow_count; /* Number of flows. */ | |
1394 | uint8_t pad[4]; /* Align to 64 bits. */ | |
09246b99 BP |
1395 | }; |
1396 | OFP_ASSERT(sizeof(struct nx_aggregate_stats_reply) == 48); | |
659586ef | 1397 | |
064af421 | 1398 | #endif /* openflow/nicira-ext.h */ |