2 * Copyright (c) 2012 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
20 /* OpenFlow message headers abstraction.
22 * OpenFlow headers are unnecessarily complicated:
24 * - Some messages with the same meaning were renumbered between 1.0 and 1.1.
26 * - "Statistics" (aka multipart) messages have a different format from other
29 * - The 1.0 header for statistics messages is an odd number of 32-bit words
30 * long, leaving 64-bit quantities in the body misaligned. The 1.1 header
31 * for statistics added a padding word to fix this misalignment, although
32 * many statistic message bodies did not change.
34 * - Vendor-defined messages have an additional header but no standard way to
35 * distinguish individual types of message within a given vendor.
37 * This file attempts to abstract out the differences between the various forms
41 #include "openvswitch/types.h"
42 #include "ofp-errors.h"
47 /* Raw identifiers for OpenFlow messages.
49 * Some OpenFlow messages with similar meanings have multiple variants across
50 * OpenFlow versions or vendor extensions. Each variant has a different
51 * OFPRAW_* enumeration constant. More specifically, if two messages have
52 * different types, different numbers, or different arguments, then they must
53 * have different OFPRAW_* values.
55 * The comments here must follow a stylized form because the "extract-ofp-msgs"
56 * program parses them at build time to generate data tables. The syntax of
59 * type versions (number): arguments.
61 * where the syntax of each part is:
63 * - type: One of OFPT (standard OpenFlow message), OFPST (standard OpenFlow
64 * statistics message), NXT (Nicira extension message), or NXST (Nicira
65 * extension statistics message).
67 * As new vendors implement extensions it will make sense to expand the
68 * dictionary of possible types.
70 * - versions: The OpenFlow version or versions in which this message is
71 * supported, e.g. "1.0" or "1.1" or "1.0+".
74 * For OFPT, the 'type' in struct ofp_header.
75 * For OFPST, the 'type' in struct ofp_stats_msg or ofp11_stats_msg.
76 * For NXT, the 'subtype' in struct nicira_header.
77 * For NXST, the 'subtype' in struct nicira10_stats_msg or
80 * - arguments: The types of data that follow the OpenFlow headers (the
81 * message "body"). This can be "void" if the message has no body.
82 * Otherwise, it should be a comma-separated sequence of C types. The
83 * last type in the sequence can end with [] if the body ends in a
84 * variable-length sequence.
86 * The arguments are used to validate the lengths of messages when a
87 * header is parsed. Any message whose length isn't valid as a length of
88 * the specified types will be rejected with OFPERR_OFPBRC_BAD_LEN.
90 * A few OpenFlow messages, such as OFPT_PACKET_IN, intentionally end with
91 * only part of a structure, up to some specified member. The syntax "up
92 * to <member>" indicates this, e.g. "struct ofp11_packet_in up to data".
95 /* Immutable standard messages.
97 * The OpenFlow standard promises to preserve these messages and their numbers
98 * in future versions, so we mark them as <all>, which covers every OpenFlow
99 * version numbered 0x01...0xff, rather than as OF1.0+, which covers only
100 * OpenFlow versions that we otherwise implement.
102 * Without <all> here, then we would fail to decode "hello" messages that
103 * announce a version higher than we understand, even though there still could
104 * be a version in common with the peer that we do understand. The <all>
105 * keyword is less useful for the other messages, because our OpenFlow channels
106 * accept only OpenFlow messages with a previously negotiated version.
109 /* OFPT <all> (0): uint8_t[]. */
112 /* OFPT <all> (1): struct ofp_error_msg, uint8_t[]. */
115 /* OFPT <all> (2): uint8_t[]. */
116 OFPRAW_OFPT_ECHO_REQUEST,
118 /* OFPT <all> (3): uint8_t[]. */
119 OFPRAW_OFPT_ECHO_REPLY,
121 /* Other standard messages.
123 * The meanings of these messages can (and often do) change from one version
124 * of OpenFlow to another. */
126 /* OFPT 1.0+ (5): void. */
127 OFPRAW_OFPT_FEATURES_REQUEST,
129 /* OFPT 1.0 (6): struct ofp_switch_features, struct ofp10_phy_port[]. */
130 OFPRAW_OFPT10_FEATURES_REPLY,
131 /* OFPT 1.1-1.2 (6): struct ofp_switch_features, struct ofp11_port[]. */
132 OFPRAW_OFPT11_FEATURES_REPLY,
133 /* OFPT 1.3+ (6): struct ofp_switch_features. */
134 OFPRAW_OFPT13_FEATURES_REPLY,
136 /* OFPT 1.0+ (7): void. */
137 OFPRAW_OFPT_GET_CONFIG_REQUEST,
139 /* OFPT 1.0+ (8): struct ofp_switch_config. */
140 OFPRAW_OFPT_GET_CONFIG_REPLY,
142 /* OFPT 1.0+ (9): struct ofp_switch_config. */
143 OFPRAW_OFPT_SET_CONFIG,
145 /* OFPT 1.0 (10): struct ofp10_packet_in up to data, uint8_t[]. */
146 OFPRAW_OFPT10_PACKET_IN,
147 /* OFPT 1.1 (10): struct ofp11_packet_in, uint8_t[]. */
148 OFPRAW_OFPT11_PACKET_IN,
149 /* OFPT 1.2 (10): struct ofp12_packet_in, uint8_t[]. */
150 OFPRAW_OFPT12_PACKET_IN,
151 /* OFPT 1.3 (10): struct ofp13_packet_in, uint8_t[]. */
152 OFPRAW_OFPT13_PACKET_IN,
153 /* NXT 1.0+ (17): struct nx_packet_in, uint8_t[]. */
154 OFPRAW_NXT_PACKET_IN,
156 /* OFPT 1.0 (11): struct ofp10_flow_removed. */
157 OFPRAW_OFPT10_FLOW_REMOVED,
158 /* OFPT 1.1+ (11): struct ofp11_flow_removed, uint8_t[8][]. */
159 OFPRAW_OFPT11_FLOW_REMOVED,
160 /* NXT 1.0+ (14): struct nx_flow_removed, uint8_t[8][]. */
161 OFPRAW_NXT_FLOW_REMOVED,
163 /* OFPT 1.0 (12): struct ofp_port_status, struct ofp10_phy_port. */
164 OFPRAW_OFPT10_PORT_STATUS,
165 /* OFPT 1.1+ (12): struct ofp_port_status, struct ofp11_port. */
166 OFPRAW_OFPT11_PORT_STATUS,
168 /* OFPT 1.0 (13): struct ofp10_packet_out, uint8_t[]. */
169 OFPRAW_OFPT10_PACKET_OUT,
170 /* OFPT 1.1+ (13): struct ofp11_packet_out, uint8_t[]. */
171 OFPRAW_OFPT11_PACKET_OUT,
173 /* OFPT 1.0 (14): struct ofp10_flow_mod, struct ofp_action_header[]. */
174 OFPRAW_OFPT10_FLOW_MOD,
175 /* OFPT 1.1+ (14): struct ofp11_flow_mod, struct ofp11_instruction[]. */
176 OFPRAW_OFPT11_FLOW_MOD,
177 /* NXT 1.0+ (13): struct nx_flow_mod, uint8_t[8][]. */
180 /* OFPT 1.0 (15): struct ofp10_port_mod. */
181 OFPRAW_OFPT10_PORT_MOD,
182 /* OFPT 1.1+ (16): struct ofp11_port_mod. */
183 OFPRAW_OFPT11_PORT_MOD,
185 /* OFPT 1.0 (18): void. */
186 OFPRAW_OFPT10_BARRIER_REQUEST,
187 /* OFPT 1.1+ (20): void. */
188 OFPRAW_OFPT11_BARRIER_REQUEST,
190 /* OFPT 1.0 (19): void. */
191 OFPRAW_OFPT10_BARRIER_REPLY,
192 /* OFPT 1.1+ (21): void. */
193 OFPRAW_OFPT11_BARRIER_REPLY,
195 /* OFPT 1.1+ (22): struct ofp11_queue_get_config_request. */
196 OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST,
198 /* OFPT 1.1+ (23): struct ofp11_queue_get_config_reply, struct ofp_packet_queue[]. */
199 OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY,
201 /* OFPT 1.3+ (26): void. */
202 OFPRAW_OFPT13_GET_ASYNC_REQUEST,
203 /* OFPT 1.3+ (27): struct ofp13_async_config. */
204 OFPRAW_OFPT13_GET_ASYNC_REPLY,
205 /* OFPT 1.3+ (28): struct ofp13_async_config. */
206 OFPRAW_OFPT13_SET_ASYNC,
207 /* NXT 1.0+ (19): struct nx_async_config. */
208 OFPRAW_NXT_SET_ASYNC_CONFIG,
210 /* OFPT 1.3+ (29): struct ofp13_meter_mod. */
211 OFPRAW_OFPT13_METER_MOD,
213 /* Standard statistics. */
215 /* OFPST 1.0+ (0): void. */
216 OFPRAW_OFPST_DESC_REQUEST,
218 /* OFPST 1.0+ (0): struct ofp_desc_stats. */
219 OFPRAW_OFPST_DESC_REPLY,
221 /* OFPST 1.0 (1): struct ofp10_flow_stats_request. */
222 OFPRAW_OFPST10_FLOW_REQUEST,
223 /* OFPST 1.1+ (1): struct ofp11_flow_stats_request, uint8_t[8][]. */
224 OFPRAW_OFPST11_FLOW_REQUEST,
225 /* NXST 1.0 (0): struct nx_flow_stats_request, uint8_t[8][]. */
226 OFPRAW_NXST_FLOW_REQUEST,
228 /* OFPST 1.0 (1): uint8_t[]. */
229 OFPRAW_OFPST10_FLOW_REPLY,
230 /* OFPST 1.1-1.2 (1): uint8_t[]. */
231 OFPRAW_OFPST11_FLOW_REPLY,
232 /* OFPST 1.3+ (1): uint8_t[]. */
233 OFPRAW_OFPST13_FLOW_REPLY,
234 /* NXST 1.0 (0): uint8_t[]. */
235 OFPRAW_NXST_FLOW_REPLY,
237 /* OFPST 1.0 (2): struct ofp10_flow_stats_request. */
238 OFPRAW_OFPST10_AGGREGATE_REQUEST,
239 /* OFPST 1.1+ (2): struct ofp11_flow_stats_request, uint8_t[8][]. */
240 OFPRAW_OFPST11_AGGREGATE_REQUEST,
241 /* NXST 1.0 (1): struct nx_flow_stats_request, uint8_t[8][]. */
242 OFPRAW_NXST_AGGREGATE_REQUEST,
244 /* OFPST 1.0+ (2): struct ofp_aggregate_stats_reply. */
245 OFPRAW_OFPST_AGGREGATE_REPLY,
246 /* NXST 1.0 (1): struct ofp_aggregate_stats_reply. */
247 OFPRAW_NXST_AGGREGATE_REPLY,
249 /* OFPST 1.0+ (3): void. */
250 OFPRAW_OFPST_TABLE_REQUEST,
252 /* OFPST 1.0 (3): struct ofp10_table_stats[]. */
253 OFPRAW_OFPST10_TABLE_REPLY,
254 /* OFPST 1.1 (3): struct ofp11_table_stats[]. */
255 OFPRAW_OFPST11_TABLE_REPLY,
256 /* OFPST 1.2 (3): struct ofp12_table_stats[]. */
257 OFPRAW_OFPST12_TABLE_REPLY,
258 /* OFPST 1.3 (3): struct ofp13_table_stats[]. */
259 OFPRAW_OFPST13_TABLE_REPLY,
261 /* OFPST 1.0 (4): struct ofp10_port_stats_request. */
262 OFPRAW_OFPST10_PORT_REQUEST,
263 /* OFPST 1.1+ (4): struct ofp11_port_stats_request. */
264 OFPRAW_OFPST11_PORT_REQUEST,
266 /* OFPST 1.0 (4): struct ofp10_port_stats[]. */
267 OFPRAW_OFPST10_PORT_REPLY,
268 /* OFPST 1.1-1.2 (4): struct ofp11_port_stats[]. */
269 OFPRAW_OFPST11_PORT_REPLY,
270 /* OFPST 1.3+ (4): struct ofp13_port_stats[]. */
271 OFPRAW_OFPST13_PORT_REPLY,
273 /* OFPST 1.0 (5): struct ofp10_queue_stats_request. */
274 OFPRAW_OFPST10_QUEUE_REQUEST,
275 /* OFPST 1.1+ (5): struct ofp11_queue_stats_request. */
276 OFPRAW_OFPST11_QUEUE_REQUEST,
278 /* OFPST 1.0 (5): struct ofp10_queue_stats[]. */
279 OFPRAW_OFPST10_QUEUE_REPLY,
280 /* OFPST 1.1-1.2 (5): struct ofp11_queue_stats[]. */
281 OFPRAW_OFPST11_QUEUE_REPLY,
282 /* OFPST 1.3+ (5): struct ofp13_queue_stats[]. */
283 OFPRAW_OFPST13_QUEUE_REPLY,
285 /* OFPST 1.1+ (6): struct ofp11_group_stats_request. */
286 OFPRAW_OFPST11_GROUP_REQUEST,
288 /* OFPST 1.1-1.2 (6): struct ofp11_group_stats[]. */
289 OFPRAW_OFPST11_GROUP_REPLY,
290 /* OFPST 1.3 (6): struct ofp13_group_stats[]. */
291 OFPRAW_OFPST13_GROUP_REPLY,
293 /* OFPST 1.1+ (7): void. */
294 OFPRAW_OFPST11_GROUP_DESC_REQUEST,
296 /* OFPST 1.1+ (7): struct ofp11_group_desc_stats[]. */
297 OFPRAW_OFPST11_GROUP_DESC_REPLY,
299 /* OFPST 1.2+ (8): void. */
300 OFPRAW_OFPST12_GROUP_FEATURES_REQUEST,
302 /* OFPST 1.2+ (8): struct ofp12_group_features_stats. */
303 OFPRAW_OFPST12_GROUP_FEATURES_REPLY,
305 /* OFPST 1.3+ (9): struct ofp13_meter_multipart_request. */
306 OFPRAW_OFPST13_METER_REQUEST,
308 /* OFPST 1.3+ (9): struct ofp13_meter_stats[]. */
309 OFPRAW_OFPST13_METER_REPLY,
311 /* OFPST 1.3+ (10): struct ofp13_meter_multipart_request. */
312 OFPRAW_OFPST13_METER_CONFIG_REQUEST,
314 /* OFPST 1.3+ (10): struct ofp13_meter_config[]. */
315 OFPRAW_OFPST13_METER_CONFIG_REPLY,
317 /* OFPST 1.3+ (11): void. */
318 OFPRAW_OFPST13_METER_FEATURES_REQUEST,
320 /* OFPST 1.3+ (11): struct ofp13_meter_features. */
321 OFPRAW_OFPST13_METER_FEATURES_REPLY,
323 /* OFPST 1.3+ (12): struct ofp13_table_features[]. */
324 OFPRAW_OFPST13_TABLE_FEATURES_REQUEST,
326 /* OFPST 1.3+ (12): struct ofp13_table_features[]. */
327 OFPRAW_OFPST13_TABLE_FEATURES_REPLY,
329 /* OFPST 1.0+ (13): void. */
330 OFPRAW_OFPST_PORT_DESC_REQUEST,
332 /* OFPST 1.0 (13): struct ofp10_phy_port[]. */
333 OFPRAW_OFPST10_PORT_DESC_REPLY,
334 /* OFPST 1.1+ (13): struct ofp11_port[]. */
335 OFPRAW_OFPST11_PORT_DESC_REPLY,
337 /* Nicira extension messages.
339 * Nicira extensions that correspond to standard OpenFlow messages are listed
340 * alongside the standard versions above. */
342 /* NXT 1.0+ (10): struct nx_role_request. */
343 OFPRAW_NXT_ROLE_REQUEST,
345 /* NXT 1.0+ (11): struct nx_role_request. */
346 OFPRAW_NXT_ROLE_REPLY,
348 /* NXT 1.0 (12): struct nx_set_flow_format. */
349 OFPRAW_NXT_SET_FLOW_FORMAT,
351 /* NXT 1.0+ (15): struct nx_flow_mod_table_id. */
352 OFPRAW_NXT_FLOW_MOD_TABLE_ID,
354 /* NXT 1.0+ (16): struct nx_set_packet_in_format. */
355 OFPRAW_NXT_SET_PACKET_IN_FORMAT,
357 /* NXT 1.0+ (18): void. */
360 /* NXT 1.0+ (20): struct nx_controller_id. */
361 OFPRAW_NXT_SET_CONTROLLER_ID,
363 /* NXT 1.0+ (21): struct nx_flow_monitor_cancel. */
364 OFPRAW_NXT_FLOW_MONITOR_CANCEL,
366 /* NXT 1.0+ (22): void. */
367 OFPRAW_NXT_FLOW_MONITOR_PAUSED,
369 /* NXT 1.0+ (23): void. */
370 OFPRAW_NXT_FLOW_MONITOR_RESUMED,
372 /* Nicira extension statistics.
374 * Nicira extension statistics that correspond to standard OpenFlow statistics
375 * are listed alongside the standard versions above. */
377 /* NXST 1.0 (2): uint8_t[8][]. */
378 OFPRAW_NXST_FLOW_MONITOR_REQUEST,
380 /* NXST 1.0 (2): uint8_t[8][]. */
381 OFPRAW_NXST_FLOW_MONITOR_REPLY,
384 /* Decoding messages into OFPRAW_* values. */
385 enum ofperr ofpraw_decode(enum ofpraw *, const struct ofp_header *);
386 enum ofperr ofpraw_pull(enum ofpraw *, struct ofpbuf *);
387 enum ofpraw ofpraw_pull_assert(struct ofpbuf *);
389 enum ofperr ofpraw_decode_partial(enum ofpraw *,
390 const struct ofp_header *, size_t length);
392 /* Encoding messages using OFPRAW_* values. */
393 struct ofpbuf *ofpraw_alloc(enum ofpraw, uint8_t ofp_version,
394 size_t extra_tailroom);
395 struct ofpbuf *ofpraw_alloc_xid(enum ofpraw, uint8_t ofp_version,
396 ovs_be32 xid, size_t extra_tailroom);
397 struct ofpbuf *ofpraw_alloc_reply(enum ofpraw,
398 const struct ofp_header *request,
399 size_t extra_tailroom);
400 struct ofpbuf *ofpraw_alloc_stats_reply(const struct ofp_header *request,
401 size_t extra_tailroom);
403 void ofpraw_put(enum ofpraw, uint8_t ofp_version, struct ofpbuf *);
404 void ofpraw_put_xid(enum ofpraw, uint8_t ofp_version, ovs_be32 xid,
406 void ofpraw_put_reply(enum ofpraw, const struct ofp_header *request,
408 void ofpraw_put_stats_reply(const struct ofp_header *request, struct ofpbuf *);
410 /* Information about OFPRAW_* values. */
411 const char *ofpraw_get_name(enum ofpraw);
412 enum ofpraw ofpraw_stats_request_to_reply(enum ofpraw, uint8_t version);
414 /* Semantic identifiers for OpenFlow messages.
416 * Each OFPTYPE_* enumeration constant represents one or more concrete format
417 * of OpenFlow message. When two variants of a message have essentially the
418 * same meaning, they are assigned a single OFPTYPE_* value.
420 * The comments here must follow a stylized form because the "extract-ofp-msgs"
421 * program parses them at build time to generate data tables. The format is
422 * simply to list each OFPRAW_* enumeration constant for a given OFPTYPE_*,
423 * each followed by a period. */
425 /* Immutable messages. */
426 OFPTYPE_HELLO, /* OFPRAW_OFPT_HELLO. */
427 OFPTYPE_ERROR, /* OFPRAW_OFPT_ERROR. */
428 OFPTYPE_ECHO_REQUEST, /* OFPRAW_OFPT_ECHO_REQUEST. */
429 OFPTYPE_ECHO_REPLY, /* OFPRAW_OFPT_ECHO_REPLY. */
431 /* Switch configuration messages. */
432 OFPTYPE_FEATURES_REQUEST, /* OFPRAW_OFPT_FEATURES_REQUEST. */
433 OFPTYPE_FEATURES_REPLY, /* OFPRAW_OFPT10_FEATURES_REPLY.
434 * OFPRAW_OFPT11_FEATURES_REPLY.
435 * OFPRAW_OFPT13_FEATURES_REPLY. */
436 OFPTYPE_GET_CONFIG_REQUEST, /* OFPRAW_OFPT_GET_CONFIG_REQUEST. */
437 OFPTYPE_GET_CONFIG_REPLY, /* OFPRAW_OFPT_GET_CONFIG_REPLY. */
438 OFPTYPE_SET_CONFIG, /* OFPRAW_OFPT_SET_CONFIG. */
440 /* Asynchronous messages. */
441 OFPTYPE_PACKET_IN, /* OFPRAW_OFPT10_PACKET_IN.
442 * OFPRAW_OFPT11_PACKET_IN.
443 * OFPRAW_OFPT12_PACKET_IN.
444 * OFPRAW_OFPT13_PACKET_IN.
445 * OFPRAW_NXT_PACKET_IN. */
446 OFPTYPE_FLOW_REMOVED, /* OFPRAW_OFPT10_FLOW_REMOVED.
447 * OFPRAW_OFPT11_FLOW_REMOVED.
448 * OFPRAW_NXT_FLOW_REMOVED. */
449 OFPTYPE_PORT_STATUS, /* OFPRAW_OFPT10_PORT_STATUS.
450 * OFPRAW_OFPT11_PORT_STATUS. */
452 /* Controller command messages. */
453 OFPTYPE_PACKET_OUT, /* OFPRAW_OFPT10_PACKET_OUT.
454 * OFPRAW_OFPT11_PACKET_OUT. */
455 OFPTYPE_FLOW_MOD, /* OFPRAW_OFPT10_FLOW_MOD.
456 * OFPRAW_OFPT11_FLOW_MOD.
457 * OFPRAW_NXT_FLOW_MOD. */
458 OFPTYPE_PORT_MOD, /* OFPRAW_OFPT10_PORT_MOD.
459 * OFPRAW_OFPT11_PORT_MOD. */
461 /* Barrier messages. */
462 OFPTYPE_BARRIER_REQUEST, /* OFPRAW_OFPT10_BARRIER_REQUEST.
463 * OFPRAW_OFPT11_BARRIER_REQUEST. */
464 OFPTYPE_BARRIER_REPLY, /* OFPRAW_OFPT10_BARRIER_REPLY.
465 * OFPRAW_OFPT11_BARRIER_REPLY. */
467 /* Queue Configuration messages. */
468 OFPTYPE_QUEUE_GET_CONFIG_REQUEST, /* OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST. */
469 OFPTYPE_QUEUE_GET_CONFIG_REPLY, /* OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY. */
471 /* Asynchronous message configuration. */
472 OFPTYPE_GET_ASYNC_REQUEST, /* OFPRAW_OFPT13_GET_ASYNC_REQUEST. */
473 OFPTYPE_GET_ASYNC_REPLY, /* OFPRAW_OFPT13_GET_ASYNC_REPLY. */
474 OFPTYPE_SET_ASYNC_CONFIG, /* OFPRAW_NXT_SET_ASYNC_CONFIG.
475 * OFPRAW_OFPT13_SET_ASYNC. */
477 /* Meters and rate limiters configuration messages. */
478 OFPTYPE_METER_MOD, /* OFPRAW_OFPT13_METER_MOD. */
481 OFPTYPE_DESC_STATS_REQUEST, /* OFPRAW_OFPST_DESC_REQUEST. */
482 OFPTYPE_DESC_STATS_REPLY, /* OFPRAW_OFPST_DESC_REPLY. */
483 OFPTYPE_FLOW_STATS_REQUEST, /* OFPRAW_OFPST10_FLOW_REQUEST.
484 * OFPRAW_OFPST11_FLOW_REQUEST.
485 * OFPRAW_NXST_FLOW_REQUEST. */
486 OFPTYPE_FLOW_STATS_REPLY, /* OFPRAW_OFPST10_FLOW_REPLY.
487 * OFPRAW_OFPST11_FLOW_REPLY.
488 * OFPRAW_OFPST13_FLOW_REPLY.
489 * OFPRAW_NXST_FLOW_REPLY. */
490 OFPTYPE_AGGREGATE_STATS_REQUEST, /* OFPRAW_OFPST10_AGGREGATE_REQUEST.
491 * OFPRAW_OFPST11_AGGREGATE_REQUEST.
492 * OFPRAW_NXST_AGGREGATE_REQUEST. */
493 OFPTYPE_AGGREGATE_STATS_REPLY, /* OFPRAW_OFPST_AGGREGATE_REPLY.
494 * OFPRAW_NXST_AGGREGATE_REPLY. */
495 OFPTYPE_TABLE_STATS_REQUEST, /* OFPRAW_OFPST_TABLE_REQUEST. */
496 OFPTYPE_TABLE_STATS_REPLY, /* OFPRAW_OFPST10_TABLE_REPLY.
497 * OFPRAW_OFPST11_TABLE_REPLY.
498 * OFPRAW_OFPST12_TABLE_REPLY.
499 * OFPRAW_OFPST13_TABLE_REPLY. */
500 OFPTYPE_PORT_STATS_REQUEST, /* OFPRAW_OFPST10_PORT_REQUEST.
501 * OFPRAW_OFPST11_PORT_REQUEST. */
502 OFPTYPE_PORT_STATS_REPLY, /* OFPRAW_OFPST10_PORT_REPLY.
503 * OFPRAW_OFPST11_PORT_REPLY.
504 * OFPRAW_OFPST13_PORT_REPLY. */
505 OFPTYPE_QUEUE_STATS_REQUEST, /* OFPRAW_OFPST10_QUEUE_REQUEST.
506 * OFPRAW_OFPST11_QUEUE_REQUEST. */
507 OFPTYPE_QUEUE_STATS_REPLY, /* OFPRAW_OFPST10_QUEUE_REPLY.
508 * OFPRAW_OFPST11_QUEUE_REPLY.
509 * OFPRAW_OFPST13_QUEUE_REPLY. */
511 OFPTYPE_GROUP_REQUEST, /* OFPRAW_OFPST11_GROUP_REQUEST. */
513 OFPTYPE_GROUP_REPLY, /* OFPRAW_OFPST11_GROUP_REPLY.
514 * OFPRAW_OFPST13_GROUP_REPLY. */
516 OFPTYPE_GROUP_DESC_REQUEST, /* OFPRAW_OFPST11_GROUP_DESC_REQUEST. */
518 OFPTYPE_GROUP_DESC_REPLY, /* OFPRAW_OFPST11_GROUP_DESC_REPLY. */
520 OFPTYPE_GROUP_FEATURES_REQUEST, /* OFPRAW_OFPST12_GROUP_FEATURES_REQUEST. */
522 OFPTYPE_GROUP_FEATURES_REPLY, /* OFPRAW_OFPST12_GROUP_FEATURES_REPLY. */
524 OFPTYPE_METER_REQUEST, /* OFPRAW_OFPST13_METER_REQUEST. */
526 OFPTYPE_METER_REPLY, /* OFPRAW_OFPST13_METER_REPLY. */
528 OFPTYPE_METER_CONFIG_REQUEST, /* OFPRAW_OFPST13_METER_CONFIG_REQUEST. */
530 OFPTYPE_METER_CONFIG_REPLY, /* OFPRAW_OFPST13_METER_CONFIG_REPLY. */
532 OFPTYPE_METER_FEATURES_REQUEST, /* OFPRAW_OFPST13_METER_FEATURES_REQUEST. */
534 OFPTYPE_METER_FEATURES_REPLY, /* OFPRAW_OFPST13_METER_FEATURES_REPLY. */
536 OFPTYPE_TABLE_FEATURES_REQUEST, /* OFPRAW_OFPST13_TABLE_FEATURES_REQUEST. */
538 OFPTYPE_TABLE_FEATURES_REPLY, /* OFPRAW_OFPST13_TABLE_FEATURES_REPLY. */
540 OFPTYPE_PORT_DESC_STATS_REQUEST, /* OFPRAW_OFPST_PORT_DESC_REQUEST. */
542 OFPTYPE_PORT_DESC_STATS_REPLY, /* OFPRAW_OFPST10_PORT_DESC_REPLY.
543 * OFPRAW_OFPST11_PORT_DESC_REPLY. */
545 /* Nicira extensions. */
546 OFPTYPE_ROLE_REQUEST, /* OFPRAW_NXT_ROLE_REQUEST. */
547 OFPTYPE_ROLE_REPLY, /* OFPRAW_NXT_ROLE_REPLY. */
548 OFPTYPE_SET_FLOW_FORMAT, /* OFPRAW_NXT_SET_FLOW_FORMAT. */
549 OFPTYPE_FLOW_MOD_TABLE_ID, /* OFPRAW_NXT_FLOW_MOD_TABLE_ID. */
550 OFPTYPE_SET_PACKET_IN_FORMAT, /* OFPRAW_NXT_SET_PACKET_IN_FORMAT. */
551 OFPTYPE_FLOW_AGE, /* OFPRAW_NXT_FLOW_AGE. */
552 OFPTYPE_SET_CONTROLLER_ID, /* OFPRAW_NXT_SET_CONTROLLER_ID. */
554 /* Flow monitor extension. */
555 OFPTYPE_FLOW_MONITOR_STATS_REQUEST, /* OFPRAW_NXST_FLOW_MONITOR_REQUEST. */
556 OFPTYPE_FLOW_MONITOR_STATS_REPLY, /* OFPRAW_NXST_FLOW_MONITOR_REPLY. */
557 OFPTYPE_FLOW_MONITOR_CANCEL, /* OFPRAW_NXT_FLOW_MONITOR_CANCEL. */
558 OFPTYPE_FLOW_MONITOR_PAUSED, /* OFPRAW_NXT_FLOW_MONITOR_PAUSED. */
559 OFPTYPE_FLOW_MONITOR_RESUMED, /* OFPRAW_NXT_FLOW_MONITOR_RESUMED. */
562 /* Decoding messages into OFPTYPE_* values. */
563 enum ofperr ofptype_decode(enum ofptype *, const struct ofp_header *);
564 enum ofperr ofptype_pull(enum ofptype *, struct ofpbuf *);
565 enum ofptype ofptype_from_ofpraw(enum ofpraw);
567 /* OpenFlow message properties. */
568 void ofpmsg_update_length(struct ofpbuf *);
569 const void *ofpmsg_body(const struct ofp_header *);
571 /* Multipart messages (aka "statistics").
573 * Individual OpenFlow messages are limited to 64 kB in size, but some messages
574 * need to be longer. Therefore, multipart messages allow a longer message to
575 * be divided into multiple parts at some convenient boundary. For example,
576 * limiting the response to a "flow dump" request to 64 kB would unreasonably
577 * limit the maximum number of flows in an OpenFlow switch, so a "flow dump" is
578 * expressed as a multipart request/reply pair, with the reply broken into
579 * pieces between flows.
581 * Multipart messages always consist of a request/reply pair.
583 * In OpenFlow 1.0, 1.1, and 1.2, requests must always fit in a single message,
584 * that is, only a multipart reply may have more than one part. OpenFlow 1.3
585 * adds one multipart request. This code does not yet support multipart
588 /* Encoding multipart replies.
590 * These functions are useful for multipart replies that might really require
591 * more than one message. A multipart message that is known in advance to fit
592 * within 64 kB doesn't need any special treatment, so you might as well use
593 * the ofpraw_alloc_*() functions.
595 * These functions work with a "struct list" of "struct ofpbuf"s, each of
596 * which represents one part of a multipart message. */
597 void ofpmp_init(struct list *, const struct ofp_header *request);
598 struct ofpbuf *ofpmp_reserve(struct list *, size_t len);
599 void *ofpmp_append(struct list *, size_t len);
600 void ofpmp_postappend(struct list *, size_t start_ofs);
602 /* Decoding multipart replies. */
603 uint16_t ofpmp_flags(const struct ofp_header *);
604 bool ofpmp_more(const struct ofp_header *);
606 #endif /* ofp-msgs.h */