2 * Copyright (c) 2012, 2013 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
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.1+ (15): struct ofp11_group_mod, uint8_t[8][]. */
181 OFPRAW_OFPT11_GROUP_MOD,
183 /* OFPT 1.0 (15): struct ofp10_port_mod. */
184 OFPRAW_OFPT10_PORT_MOD,
185 /* OFPT 1.1+ (16): struct ofp11_port_mod. */
186 OFPRAW_OFPT11_PORT_MOD,
188 /* OFPT 1.1+ (17): struct ofp11_table_mod. */
189 OFPRAW_OFPT11_TABLE_MOD,
191 /* OFPT 1.0 (18): void. */
192 OFPRAW_OFPT10_BARRIER_REQUEST,
193 /* OFPT 1.1+ (20): void. */
194 OFPRAW_OFPT11_BARRIER_REQUEST,
196 /* OFPT 1.0 (19): void. */
197 OFPRAW_OFPT10_BARRIER_REPLY,
198 /* OFPT 1.1+ (21): void. */
199 OFPRAW_OFPT11_BARRIER_REPLY,
201 /* OFPT 1.0 (22): struct ofp10_queue_get_config_request. */
202 OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST,
203 /* OFPT 1.1+ (22): struct ofp11_queue_get_config_request. */
204 OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST,
206 /* OFPT 1.0 (23): struct ofp10_queue_get_config_reply, uint8_t[8][]. */
207 OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY,
208 /* OFPT 1.1+ (23): struct ofp11_queue_get_config_reply, uint8_t[8][]. */
209 OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY,
211 /* OFPT 1.2+ (24): struct ofp12_role_request. */
212 OFPRAW_OFPT12_ROLE_REQUEST,
213 /* NXT 1.0+ (10): struct nx_role_request. */
214 OFPRAW_NXT_ROLE_REQUEST,
216 /* OFPT 1.2+ (25): struct ofp12_role_request. */
217 OFPRAW_OFPT12_ROLE_REPLY,
218 /* NXT 1.0+ (11): struct nx_role_request. */
219 OFPRAW_NXT_ROLE_REPLY,
221 /* OFPT 1.3+ (26): void. */
222 OFPRAW_OFPT13_GET_ASYNC_REQUEST,
223 /* OFPT 1.3+ (27): struct ofp13_async_config. */
224 OFPRAW_OFPT13_GET_ASYNC_REPLY,
225 /* OFPT 1.3+ (28): struct ofp13_async_config. */
226 OFPRAW_OFPT13_SET_ASYNC,
227 /* NXT 1.0+ (19): struct nx_async_config. */
228 OFPRAW_NXT_SET_ASYNC_CONFIG,
230 /* OFPT 1.3+ (29): struct ofp13_meter_mod, uint8_t[8][]. */
231 OFPRAW_OFPT13_METER_MOD,
233 /* OFPT 1.4+ (30): struct ofp14_role_status, uint8_t[8][]. */
234 OFPRAW_OFPT14_ROLE_STATUS,
236 /* Standard statistics. */
238 /* OFPST 1.0+ (0): void. */
239 OFPRAW_OFPST_DESC_REQUEST,
241 /* OFPST 1.0+ (0): struct ofp_desc_stats. */
242 OFPRAW_OFPST_DESC_REPLY,
244 /* OFPST 1.0 (1): struct ofp10_flow_stats_request. */
245 OFPRAW_OFPST10_FLOW_REQUEST,
246 /* OFPST 1.1+ (1): struct ofp11_flow_stats_request, uint8_t[8][]. */
247 OFPRAW_OFPST11_FLOW_REQUEST,
248 /* NXST 1.0 (0): struct nx_flow_stats_request, uint8_t[8][]. */
249 OFPRAW_NXST_FLOW_REQUEST,
251 /* OFPST 1.0 (1): uint8_t[]. */
252 OFPRAW_OFPST10_FLOW_REPLY,
253 /* OFPST 1.1-1.2 (1): uint8_t[]. */
254 OFPRAW_OFPST11_FLOW_REPLY,
255 /* OFPST 1.3+ (1): uint8_t[]. */
256 OFPRAW_OFPST13_FLOW_REPLY,
257 /* NXST 1.0 (0): uint8_t[]. */
258 OFPRAW_NXST_FLOW_REPLY,
260 /* OFPST 1.0 (2): struct ofp10_flow_stats_request. */
261 OFPRAW_OFPST10_AGGREGATE_REQUEST,
262 /* OFPST 1.1+ (2): struct ofp11_flow_stats_request, uint8_t[8][]. */
263 OFPRAW_OFPST11_AGGREGATE_REQUEST,
264 /* NXST 1.0 (1): struct nx_flow_stats_request, uint8_t[8][]. */
265 OFPRAW_NXST_AGGREGATE_REQUEST,
267 /* OFPST 1.0+ (2): struct ofp_aggregate_stats_reply. */
268 OFPRAW_OFPST_AGGREGATE_REPLY,
269 /* NXST 1.0 (1): struct ofp_aggregate_stats_reply. */
270 OFPRAW_NXST_AGGREGATE_REPLY,
272 /* OFPST 1.0+ (3): void. */
273 OFPRAW_OFPST_TABLE_REQUEST,
275 /* OFPST 1.0 (3): struct ofp10_table_stats[]. */
276 OFPRAW_OFPST10_TABLE_REPLY,
277 /* OFPST 1.1 (3): struct ofp11_table_stats[]. */
278 OFPRAW_OFPST11_TABLE_REPLY,
279 /* OFPST 1.2 (3): struct ofp12_table_stats[]. */
280 OFPRAW_OFPST12_TABLE_REPLY,
281 /* OFPST 1.3+ (3): struct ofp13_table_stats[]. */
282 OFPRAW_OFPST13_TABLE_REPLY,
284 /* OFPST 1.0 (4): struct ofp10_port_stats_request. */
285 OFPRAW_OFPST10_PORT_REQUEST,
286 /* OFPST 1.1+ (4): struct ofp11_port_stats_request. */
287 OFPRAW_OFPST11_PORT_REQUEST,
289 /* OFPST 1.0 (4): struct ofp10_port_stats[]. */
290 OFPRAW_OFPST10_PORT_REPLY,
291 /* OFPST 1.1-1.2 (4): struct ofp11_port_stats[]. */
292 OFPRAW_OFPST11_PORT_REPLY,
293 /* OFPST 1.3+ (4): struct ofp13_port_stats[]. */
294 OFPRAW_OFPST13_PORT_REPLY,
296 /* OFPST 1.0 (5): struct ofp10_queue_stats_request. */
297 OFPRAW_OFPST10_QUEUE_REQUEST,
298 /* OFPST 1.1+ (5): struct ofp11_queue_stats_request. */
299 OFPRAW_OFPST11_QUEUE_REQUEST,
301 /* OFPST 1.0 (5): struct ofp10_queue_stats[]. */
302 OFPRAW_OFPST10_QUEUE_REPLY,
303 /* OFPST 1.1-1.2 (5): struct ofp11_queue_stats[]. */
304 OFPRAW_OFPST11_QUEUE_REPLY,
305 /* OFPST 1.3+ (5): struct ofp13_queue_stats[]. */
306 OFPRAW_OFPST13_QUEUE_REPLY,
308 /* OFPST 1.1+ (6): struct ofp11_group_stats_request. */
309 OFPRAW_OFPST11_GROUP_REQUEST,
311 /* OFPST 1.1-1.2 (6): uint8_t[8][]. */
312 OFPRAW_OFPST11_GROUP_REPLY,
313 /* OFPST 1.3+ (6): uint8_t[8][]. */
314 OFPRAW_OFPST13_GROUP_REPLY,
316 /* OFPST 1.1+ (7): void. */
317 OFPRAW_OFPST11_GROUP_DESC_REQUEST,
319 /* OFPST 1.1+ (7): uint8_t[8][]. */
320 OFPRAW_OFPST11_GROUP_DESC_REPLY,
322 /* OFPST 1.2+ (8): void. */
323 OFPRAW_OFPST12_GROUP_FEATURES_REQUEST,
325 /* OFPST 1.2+ (8): struct ofp12_group_features_stats. */
326 OFPRAW_OFPST12_GROUP_FEATURES_REPLY,
328 /* OFPST 1.3+ (9): struct ofp13_meter_multipart_request. */
329 OFPRAW_OFPST13_METER_REQUEST,
331 /* OFPST 1.3+ (9): uint8_t[8][]. */
332 OFPRAW_OFPST13_METER_REPLY,
334 /* OFPST 1.3+ (10): struct ofp13_meter_multipart_request. */
335 OFPRAW_OFPST13_METER_CONFIG_REQUEST,
337 /* OFPST 1.3+ (10): uint8_t[8][]. */
338 OFPRAW_OFPST13_METER_CONFIG_REPLY,
340 /* OFPST 1.3+ (11): void. */
341 OFPRAW_OFPST13_METER_FEATURES_REQUEST,
343 /* OFPST 1.3+ (11): struct ofp13_meter_features. */
344 OFPRAW_OFPST13_METER_FEATURES_REPLY,
346 /* OFPST 1.3+ (12): void. */
347 OFPRAW_OFPST13_TABLE_FEATURES_REQUEST,
349 /* OFPST 1.3+ (12): struct ofp13_table_features, uint8_t[8][]. */
350 OFPRAW_OFPST13_TABLE_FEATURES_REPLY,
352 /* OFPST 1.0+ (13): void. */
353 OFPRAW_OFPST_PORT_DESC_REQUEST,
355 /* OFPST 1.0 (13): struct ofp10_phy_port[]. */
356 OFPRAW_OFPST10_PORT_DESC_REPLY,
357 /* OFPST 1.1+ (13): struct ofp11_port[]. */
358 OFPRAW_OFPST11_PORT_DESC_REPLY,
360 /* Nicira extension messages.
362 * Nicira extensions that correspond to standard OpenFlow messages are listed
363 * alongside the standard versions above. */
365 /* NXT 1.0 (12): struct nx_set_flow_format. */
366 OFPRAW_NXT_SET_FLOW_FORMAT,
368 /* NXT 1.0+ (15): struct nx_flow_mod_table_id. */
369 OFPRAW_NXT_FLOW_MOD_TABLE_ID,
371 /* NXT 1.0+ (16): struct nx_set_packet_in_format. */
372 OFPRAW_NXT_SET_PACKET_IN_FORMAT,
374 /* NXT 1.0+ (18): void. */
377 /* NXT 1.0+ (20): struct nx_controller_id. */
378 OFPRAW_NXT_SET_CONTROLLER_ID,
380 /* NXT 1.0+ (21): struct nx_flow_monitor_cancel. */
381 OFPRAW_NXT_FLOW_MONITOR_CANCEL,
383 /* NXT 1.0+ (22): void. */
384 OFPRAW_NXT_FLOW_MONITOR_PAUSED,
386 /* NXT 1.0+ (23): void. */
387 OFPRAW_NXT_FLOW_MONITOR_RESUMED,
389 /* Nicira extension statistics.
391 * Nicira extension statistics that correspond to standard OpenFlow statistics
392 * are listed alongside the standard versions above. */
394 /* NXST 1.0 (2): uint8_t[8][]. */
395 OFPRAW_NXST_FLOW_MONITOR_REQUEST,
397 /* NXST 1.0 (2): uint8_t[8][]. */
398 OFPRAW_NXST_FLOW_MONITOR_REPLY,
401 /* Decoding messages into OFPRAW_* values. */
402 enum ofperr ofpraw_decode(enum ofpraw *, const struct ofp_header *);
403 enum ofpraw ofpraw_decode_assert(const struct ofp_header *);
404 enum ofperr ofpraw_pull(enum ofpraw *, struct ofpbuf *);
405 enum ofpraw ofpraw_pull_assert(struct ofpbuf *);
407 enum ofperr ofpraw_decode_partial(enum ofpraw *,
408 const struct ofp_header *, size_t length);
410 /* Encoding messages using OFPRAW_* values. */
411 struct ofpbuf *ofpraw_alloc(enum ofpraw, uint8_t ofp_version,
412 size_t extra_tailroom);
413 struct ofpbuf *ofpraw_alloc_xid(enum ofpraw, uint8_t ofp_version,
414 ovs_be32 xid, size_t extra_tailroom);
415 struct ofpbuf *ofpraw_alloc_reply(enum ofpraw,
416 const struct ofp_header *request,
417 size_t extra_tailroom);
418 struct ofpbuf *ofpraw_alloc_stats_reply(const struct ofp_header *request,
419 size_t extra_tailroom);
421 void ofpraw_put(enum ofpraw, uint8_t ofp_version, struct ofpbuf *);
422 void ofpraw_put_xid(enum ofpraw, uint8_t ofp_version, ovs_be32 xid,
424 void ofpraw_put_reply(enum ofpraw, const struct ofp_header *request,
426 void ofpraw_put_stats_reply(const struct ofp_header *request, struct ofpbuf *);
428 /* Information about OFPRAW_* values. */
429 const char *ofpraw_get_name(enum ofpraw);
430 enum ofpraw ofpraw_stats_request_to_reply(enum ofpraw, uint8_t version);
432 /* Semantic identifiers for OpenFlow messages.
434 * Each OFPTYPE_* enumeration constant represents one or more concrete format
435 * of OpenFlow message. When two variants of a message have essentially the
436 * same meaning, they are assigned a single OFPTYPE_* value.
438 * The comments here must follow a stylized form because the "extract-ofp-msgs"
439 * program parses them at build time to generate data tables. The format is
440 * simply to list each OFPRAW_* enumeration constant for a given OFPTYPE_*,
441 * each followed by a period. */
443 /* Immutable messages. */
444 OFPTYPE_HELLO, /* OFPRAW_OFPT_HELLO. */
445 OFPTYPE_ERROR, /* OFPRAW_OFPT_ERROR. */
446 OFPTYPE_ECHO_REQUEST, /* OFPRAW_OFPT_ECHO_REQUEST. */
447 OFPTYPE_ECHO_REPLY, /* OFPRAW_OFPT_ECHO_REPLY. */
449 /* Switch configuration messages. */
450 OFPTYPE_FEATURES_REQUEST, /* OFPRAW_OFPT_FEATURES_REQUEST. */
451 OFPTYPE_FEATURES_REPLY, /* OFPRAW_OFPT10_FEATURES_REPLY.
452 * OFPRAW_OFPT11_FEATURES_REPLY.
453 * OFPRAW_OFPT13_FEATURES_REPLY. */
454 OFPTYPE_GET_CONFIG_REQUEST, /* OFPRAW_OFPT_GET_CONFIG_REQUEST. */
455 OFPTYPE_GET_CONFIG_REPLY, /* OFPRAW_OFPT_GET_CONFIG_REPLY. */
456 OFPTYPE_SET_CONFIG, /* OFPRAW_OFPT_SET_CONFIG. */
458 /* Asynchronous messages. */
459 OFPTYPE_PACKET_IN, /* OFPRAW_OFPT10_PACKET_IN.
460 * OFPRAW_OFPT11_PACKET_IN.
461 * OFPRAW_OFPT12_PACKET_IN.
462 * OFPRAW_OFPT13_PACKET_IN.
463 * OFPRAW_NXT_PACKET_IN. */
464 OFPTYPE_FLOW_REMOVED, /* OFPRAW_OFPT10_FLOW_REMOVED.
465 * OFPRAW_OFPT11_FLOW_REMOVED.
466 * OFPRAW_NXT_FLOW_REMOVED. */
467 OFPTYPE_PORT_STATUS, /* OFPRAW_OFPT10_PORT_STATUS.
468 * OFPRAW_OFPT11_PORT_STATUS. */
470 /* Controller command messages. */
471 OFPTYPE_PACKET_OUT, /* OFPRAW_OFPT10_PACKET_OUT.
472 * OFPRAW_OFPT11_PACKET_OUT. */
473 OFPTYPE_FLOW_MOD, /* OFPRAW_OFPT10_FLOW_MOD.
474 * OFPRAW_OFPT11_FLOW_MOD.
475 * OFPRAW_NXT_FLOW_MOD. */
476 OFPTYPE_GROUP_MOD, /* OFPRAW_OFPT11_GROUP_MOD. */
477 OFPTYPE_PORT_MOD, /* OFPRAW_OFPT10_PORT_MOD.
478 * OFPRAW_OFPT11_PORT_MOD. */
479 OFPTYPE_TABLE_MOD, /* OFPRAW_OFPT11_TABLE_MOD. */
481 /* Barrier messages. */
482 OFPTYPE_BARRIER_REQUEST, /* OFPRAW_OFPT10_BARRIER_REQUEST.
483 * OFPRAW_OFPT11_BARRIER_REQUEST. */
484 OFPTYPE_BARRIER_REPLY, /* OFPRAW_OFPT10_BARRIER_REPLY.
485 * OFPRAW_OFPT11_BARRIER_REPLY. */
487 /* Queue Configuration messages. */
488 OFPTYPE_QUEUE_GET_CONFIG_REQUEST, /* OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST.
489 * OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST. */
490 OFPTYPE_QUEUE_GET_CONFIG_REPLY, /* OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY.
491 * OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY. */
493 /* Controller role change request messages. */
494 OFPTYPE_ROLE_REQUEST, /* OFPRAW_OFPT12_ROLE_REQUEST.
495 * OFPRAW_NXT_ROLE_REQUEST. */
496 OFPTYPE_ROLE_REPLY, /* OFPRAW_OFPT12_ROLE_REPLY.
497 * OFPRAW_NXT_ROLE_REPLY. */
499 /* Asynchronous message configuration. */
500 OFPTYPE_GET_ASYNC_REQUEST, /* OFPRAW_OFPT13_GET_ASYNC_REQUEST. */
501 OFPTYPE_GET_ASYNC_REPLY, /* OFPRAW_OFPT13_GET_ASYNC_REPLY. */
502 OFPTYPE_SET_ASYNC_CONFIG, /* OFPRAW_NXT_SET_ASYNC_CONFIG.
503 * OFPRAW_OFPT13_SET_ASYNC. */
505 /* Meters and rate limiters configuration messages. */
506 OFPTYPE_METER_MOD, /* OFPRAW_OFPT13_METER_MOD. */
508 /* Controller role change event messages. */
509 OFPTYPE_ROLE_STATUS, /* OFPRAW_OFPT14_ROLE_STATUS. */
512 OFPTYPE_DESC_STATS_REQUEST, /* OFPRAW_OFPST_DESC_REQUEST. */
513 OFPTYPE_DESC_STATS_REPLY, /* OFPRAW_OFPST_DESC_REPLY. */
514 OFPTYPE_FLOW_STATS_REQUEST, /* OFPRAW_OFPST10_FLOW_REQUEST.
515 * OFPRAW_OFPST11_FLOW_REQUEST.
516 * OFPRAW_NXST_FLOW_REQUEST. */
517 OFPTYPE_FLOW_STATS_REPLY, /* OFPRAW_OFPST10_FLOW_REPLY.
518 * OFPRAW_OFPST11_FLOW_REPLY.
519 * OFPRAW_OFPST13_FLOW_REPLY.
520 * OFPRAW_NXST_FLOW_REPLY. */
521 OFPTYPE_AGGREGATE_STATS_REQUEST, /* OFPRAW_OFPST10_AGGREGATE_REQUEST.
522 * OFPRAW_OFPST11_AGGREGATE_REQUEST.
523 * OFPRAW_NXST_AGGREGATE_REQUEST. */
524 OFPTYPE_AGGREGATE_STATS_REPLY, /* OFPRAW_OFPST_AGGREGATE_REPLY.
525 * OFPRAW_NXST_AGGREGATE_REPLY. */
526 OFPTYPE_TABLE_STATS_REQUEST, /* OFPRAW_OFPST_TABLE_REQUEST. */
527 OFPTYPE_TABLE_STATS_REPLY, /* OFPRAW_OFPST10_TABLE_REPLY.
528 * OFPRAW_OFPST11_TABLE_REPLY.
529 * OFPRAW_OFPST12_TABLE_REPLY.
530 * OFPRAW_OFPST13_TABLE_REPLY. */
531 OFPTYPE_PORT_STATS_REQUEST, /* OFPRAW_OFPST10_PORT_REQUEST.
532 * OFPRAW_OFPST11_PORT_REQUEST. */
533 OFPTYPE_PORT_STATS_REPLY, /* OFPRAW_OFPST10_PORT_REPLY.
534 * OFPRAW_OFPST11_PORT_REPLY.
535 * OFPRAW_OFPST13_PORT_REPLY. */
536 OFPTYPE_QUEUE_STATS_REQUEST, /* OFPRAW_OFPST10_QUEUE_REQUEST.
537 * OFPRAW_OFPST11_QUEUE_REQUEST. */
538 OFPTYPE_QUEUE_STATS_REPLY, /* OFPRAW_OFPST10_QUEUE_REPLY.
539 * OFPRAW_OFPST11_QUEUE_REPLY.
540 * OFPRAW_OFPST13_QUEUE_REPLY. */
542 OFPTYPE_GROUP_STATS_REQUEST, /* OFPRAW_OFPST11_GROUP_REQUEST. */
544 OFPTYPE_GROUP_STATS_REPLY, /* OFPRAW_OFPST11_GROUP_REPLY.
545 * OFPRAW_OFPST13_GROUP_REPLY. */
547 OFPTYPE_GROUP_DESC_STATS_REQUEST, /* OFPRAW_OFPST11_GROUP_DESC_REQUEST. */
549 OFPTYPE_GROUP_DESC_STATS_REPLY, /* OFPRAW_OFPST11_GROUP_DESC_REPLY. */
551 OFPTYPE_GROUP_FEATURES_STATS_REQUEST, /* OFPRAW_OFPST12_GROUP_FEATURES_REQUEST. */
553 OFPTYPE_GROUP_FEATURES_STATS_REPLY, /* OFPRAW_OFPST12_GROUP_FEATURES_REPLY. */
555 OFPTYPE_METER_STATS_REQUEST, /* OFPRAW_OFPST13_METER_REQUEST. */
557 OFPTYPE_METER_STATS_REPLY, /* OFPRAW_OFPST13_METER_REPLY. */
559 OFPTYPE_METER_CONFIG_STATS_REQUEST, /* OFPRAW_OFPST13_METER_CONFIG_REQUEST. */
561 OFPTYPE_METER_CONFIG_STATS_REPLY, /* OFPRAW_OFPST13_METER_CONFIG_REPLY. */
563 OFPTYPE_METER_FEATURES_STATS_REQUEST, /* OFPRAW_OFPST13_METER_FEATURES_REQUEST. */
565 OFPTYPE_METER_FEATURES_STATS_REPLY, /* OFPRAW_OFPST13_METER_FEATURES_REPLY. */
567 OFPTYPE_TABLE_FEATURES_STATS_REQUEST, /* OFPRAW_OFPST13_TABLE_FEATURES_REQUEST. */
569 OFPTYPE_TABLE_FEATURES_STATS_REPLY, /* OFPRAW_OFPST13_TABLE_FEATURES_REPLY. */
571 OFPTYPE_PORT_DESC_STATS_REQUEST, /* OFPRAW_OFPST_PORT_DESC_REQUEST. */
573 OFPTYPE_PORT_DESC_STATS_REPLY, /* OFPRAW_OFPST10_PORT_DESC_REPLY.
574 * OFPRAW_OFPST11_PORT_DESC_REPLY. */
576 /* Nicira extensions. */
577 OFPTYPE_SET_FLOW_FORMAT, /* OFPRAW_NXT_SET_FLOW_FORMAT. */
578 OFPTYPE_FLOW_MOD_TABLE_ID, /* OFPRAW_NXT_FLOW_MOD_TABLE_ID. */
579 OFPTYPE_SET_PACKET_IN_FORMAT, /* OFPRAW_NXT_SET_PACKET_IN_FORMAT. */
580 OFPTYPE_FLOW_AGE, /* OFPRAW_NXT_FLOW_AGE. */
581 OFPTYPE_SET_CONTROLLER_ID, /* OFPRAW_NXT_SET_CONTROLLER_ID. */
583 /* Flow monitor extension. */
584 OFPTYPE_FLOW_MONITOR_STATS_REQUEST, /* OFPRAW_NXST_FLOW_MONITOR_REQUEST. */
585 OFPTYPE_FLOW_MONITOR_STATS_REPLY, /* OFPRAW_NXST_FLOW_MONITOR_REPLY. */
586 OFPTYPE_FLOW_MONITOR_CANCEL, /* OFPRAW_NXT_FLOW_MONITOR_CANCEL. */
587 OFPTYPE_FLOW_MONITOR_PAUSED, /* OFPRAW_NXT_FLOW_MONITOR_PAUSED. */
588 OFPTYPE_FLOW_MONITOR_RESUMED, /* OFPRAW_NXT_FLOW_MONITOR_RESUMED. */
591 /* Decoding messages into OFPTYPE_* values. */
592 enum ofperr ofptype_decode(enum ofptype *, const struct ofp_header *);
593 enum ofperr ofptype_pull(enum ofptype *, struct ofpbuf *);
594 enum ofptype ofptype_from_ofpraw(enum ofpraw);
596 /* OpenFlow message properties. */
597 void ofpmsg_update_length(struct ofpbuf *);
598 const void *ofpmsg_body(const struct ofp_header *);
599 bool ofpmsg_is_stat_request(const struct ofp_header *);
601 /* Multipart messages (aka "statistics").
603 * Individual OpenFlow messages are limited to 64 kB in size, but some messages
604 * need to be longer. Therefore, multipart messages allow a longer message to
605 * be divided into multiple parts at some convenient boundary. For example,
606 * limiting the response to a "flow dump" request to 64 kB would unreasonably
607 * limit the maximum number of flows in an OpenFlow switch, so a "flow dump" is
608 * expressed as a multipart request/reply pair, with the reply broken into
609 * pieces between flows.
611 * Multipart messages always consist of a request/reply pair.
613 * In OpenFlow 1.0, 1.1, and 1.2, requests must always fit in a single message,
614 * that is, only a multipart reply may have more than one part. OpenFlow 1.3
615 * adds one multipart request. This code does not yet support multipart
618 /* Encoding multipart replies.
620 * These functions are useful for multipart replies that might really require
621 * more than one message. A multipart message that is known in advance to fit
622 * within 64 kB doesn't need any special treatment, so you might as well use
623 * the ofpraw_alloc_*() functions.
625 * These functions work with a "struct list" of "struct ofpbuf"s, each of
626 * which represents one part of a multipart message. */
627 void ofpmp_init(struct list *, const struct ofp_header *request);
628 struct ofpbuf *ofpmp_reserve(struct list *, size_t len);
629 void *ofpmp_append(struct list *, size_t len);
630 void ofpmp_postappend(struct list *, size_t start_ofs);
632 /* Decoding multipart replies. */
633 uint16_t ofpmp_flags(const struct ofp_header *);
634 bool ofpmp_more(const struct ofp_header *);
636 #endif /* ofp-msgs.h */