lib/ofp-msgs.h

   1 /*
   2  * Copyright (c) 2012, 2013, 2014, 2015 Nicira, Inc.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef OFP_MSGS_H
  18 #define OFP_MSGS_H 1
  19
  20 /* OpenFlow message headers abstraction.
  21  *
  22  * OpenFlow headers are unnecessarily complicated:
  23  *
  24  *   - Some messages with the same meaning were renumbered between 1.0 and 1.1.
  25  *
  26  *   - "Statistics" (aka multipart) messages have a different format from other
  27  *     messages.
  28  *
  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.
  33  *
  34  *   - Vendor-defined messages have an additional header but no standard way to
  35  *     distinguish individual types of message within a given vendor.
  36  *
  37  * This file attempts to abstract out the differences between the various forms
  38  * of headers.
  39  */
  40
  41 #include "openvswitch/types.h"
  42 #include "ofp-errors.h"
  43 #include "util.h"
  44
  45 struct ovs_list;
  46 \f
  47 /* Raw identifiers for OpenFlow messages.
  48  *
  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.
  54  *
  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
  57  * each comment is:
  58  *
  59  *    type versions (number): arguments.
  60  *
  61  * where the syntax of each part is:
  62  *
  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).
  66  *
  67  *      As new vendors implement extensions it will make sense to expand the
  68  *      dictionary of possible types.
  69  *
  70  *    - versions: The OpenFlow version or versions in which this message is
  71  *      supported, e.g. "1.0" or "1.1" or "1.0+".
  72  *
  73  *    - number:
  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
  78  *           nicira11_stats_msg.
  79  *
  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.
  85  *
  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.
  89  *
  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".
  93  */
  94 enum ofpraw {
  95 /* Immutable standard messages.
  96  *
  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.
 101  *
 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.
 107  */
 108
 109     /* OFPT <all> (0): uint8_t[]. */
 110     OFPRAW_OFPT_HELLO,
 111
 112     /* OFPT <all> (1): struct ofp_error_msg, uint8_t[]. */
 113     OFPRAW_OFPT_ERROR,
 114
 115     /* OFPT <all> (2): uint8_t[]. */
 116     OFPRAW_OFPT_ECHO_REQUEST,
 117
 118     /* OFPT <all> (3): uint8_t[]. */
 119     OFPRAW_OFPT_ECHO_REPLY,
 120
 121 /* Other standard messages.
 122  *
 123  * The meanings of these messages can (and often do) change from one version
 124  * of OpenFlow to another. */
 125
 126     /* OFPT 1.0+ (5): void. */
 127     OFPRAW_OFPT_FEATURES_REQUEST,
 128
 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,
 135
 136     /* OFPT 1.0+ (7): void. */
 137     OFPRAW_OFPT_GET_CONFIG_REQUEST,
 138
 139     /* OFPT 1.0+ (8): struct ofp_switch_config. */
 140     OFPRAW_OFPT_GET_CONFIG_REPLY,
 141
 142     /* OFPT 1.0+ (9): struct ofp_switch_config. */
 143     OFPRAW_OFPT_SET_CONFIG,
 144
 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,
 155
 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,
 162
 163     /* OFPT 1.0 (12): struct ofp_port_status, struct ofp10_phy_port. */
 164     OFPRAW_OFPT10_PORT_STATUS,
 165     /* OFPT 1.1-1.3 (12): struct ofp_port_status, struct ofp11_port. */
 166     OFPRAW_OFPT11_PORT_STATUS,
 167     /* OFPT 1.4+ (12): struct ofp_port_status, struct ofp14_port, uint8_t[8][]. */
 168     OFPRAW_OFPT14_PORT_STATUS,
 169
 170     /* OFPT 1.0 (13): struct ofp10_packet_out, uint8_t[]. */
 171     OFPRAW_OFPT10_PACKET_OUT,
 172     /* OFPT 1.1+ (13): struct ofp11_packet_out, uint8_t[]. */
 173     OFPRAW_OFPT11_PACKET_OUT,
 174
 175     /* OFPT 1.0 (14): struct ofp10_flow_mod, uint8_t[8][]. */
 176     OFPRAW_OFPT10_FLOW_MOD,
 177     /* OFPT 1.1+ (14): struct ofp11_flow_mod, struct ofp11_instruction[]. */
 178     OFPRAW_OFPT11_FLOW_MOD,
 179     /* NXT 1.0+ (13): struct nx_flow_mod, uint8_t[8][]. */
 180     OFPRAW_NXT_FLOW_MOD,
 181
 182     /* OFPT 1.1-1.4 (15): struct ofp11_group_mod, uint8_t[8][]. */
 183     OFPRAW_OFPT11_GROUP_MOD,
 184     /* OFPT 1.5+ (15): struct ofp15_group_mod, uint8_t[8][]. */
 185     OFPRAW_OFPT15_GROUP_MOD,
 186
 187     /* OFPT 1.0 (15): struct ofp10_port_mod. */
 188     OFPRAW_OFPT10_PORT_MOD,
 189     /* OFPT 1.1-1.3 (16): struct ofp11_port_mod. */
 190     OFPRAW_OFPT11_PORT_MOD,
 191     /* OFPT 1.4+ (16): struct ofp14_port_mod, uint8_t[8][]. */
 192     OFPRAW_OFPT14_PORT_MOD,
 193
 194     /* OFPT 1.1-1.3 (17): struct ofp11_table_mod. */
 195     OFPRAW_OFPT11_TABLE_MOD,
 196     /* OFPT 1.4+ (17): struct ofp14_table_mod, uint8_t[8][]. */
 197     OFPRAW_OFPT14_TABLE_MOD,
 198
 199     /* OFPT 1.0 (18): void. */
 200     OFPRAW_OFPT10_BARRIER_REQUEST,
 201     /* OFPT 1.1+ (20): void. */
 202     OFPRAW_OFPT11_BARRIER_REQUEST,
 203
 204     /* OFPT 1.0 (19): void. */
 205     OFPRAW_OFPT10_BARRIER_REPLY,
 206     /* OFPT 1.1+ (21): void. */
 207     OFPRAW_OFPT11_BARRIER_REPLY,
 208
 209     /* OFPT 1.0 (20): struct ofp10_queue_get_config_request. */
 210     OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST,
 211     /* OFPT 1.1+ (22): struct ofp11_queue_get_config_request. */
 212     OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST,
 213
 214     /* OFPT 1.0 (21): struct ofp10_queue_get_config_reply, uint8_t[8][]. */
 215     OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY,
 216     /* OFPT 1.1+ (23): struct ofp11_queue_get_config_reply, uint8_t[8][]. */
 217     OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY,
 218
 219     /* OFPT 1.2+ (24): struct ofp12_role_request. */
 220     OFPRAW_OFPT12_ROLE_REQUEST,
 221     /* NXT 1.0+ (10): struct nx_role_request. */
 222     OFPRAW_NXT_ROLE_REQUEST,
 223
 224     /* OFPT 1.2+ (25): struct ofp12_role_request. */
 225     OFPRAW_OFPT12_ROLE_REPLY,
 226     /* NXT 1.0+ (11): struct nx_role_request. */
 227     OFPRAW_NXT_ROLE_REPLY,
 228
 229     /* OFPT 1.3 (26): void. */
 230     OFPRAW_OFPT13_GET_ASYNC_REQUEST,
 231     /* OFPT 1.4+ (26): void. */
 232     OFPRAW_OFPT14_GET_ASYNC_REQUEST,
 233     /* OFPT 1.3 (27): struct ofp13_async_config. */
 234     OFPRAW_OFPT13_GET_ASYNC_REPLY,
 235     /* OFPT 1.4+ (27): struct ofp14_async_config, uint8_t[8][]. */
 236     OFPRAW_OFPT14_GET_ASYNC_REPLY,
 237     /* OFPT 1.3 (28): struct ofp13_async_config. */
 238     OFPRAW_OFPT13_SET_ASYNC,
 239     /* NXT 1.0+ (19): struct nx_async_config. */
 240     OFPRAW_NXT_SET_ASYNC_CONFIG,
 241     /* OFPT 1.4+ (28): struct ofp14_async_config, uint8_t[8][]. */
 242     OFPRAW_OFPT14_SET_ASYNC,
 243
 244     /* OFPT 1.3+ (29): struct ofp13_meter_mod, uint8_t[8][]. */
 245     OFPRAW_OFPT13_METER_MOD,
 246
 247     /* OFPT 1.4+ (30): struct ofp14_role_status, uint8_t[8][]. */
 248     OFPRAW_OFPT14_ROLE_STATUS,
 249
 250     /* OFPT 1.4+ (33): struct ofp14_bundle_ctrl_msg, uint8_t[8][]. */
 251     OFPRAW_OFPT14_BUNDLE_CONTROL,
 252
 253     /* OFPT 1.4+ (34): struct ofp14_bundle_ctrl_msg, uint8_t[]. */
 254     OFPRAW_OFPT14_BUNDLE_ADD_MESSAGE,
 255
 256 /* Standard statistics. */
 257
 258     /* OFPST 1.0+ (0): void. */
 259     OFPRAW_OFPST_DESC_REQUEST,
 260
 261     /* OFPST 1.0+ (0): struct ofp_desc_stats. */
 262     OFPRAW_OFPST_DESC_REPLY,
 263
 264     /* OFPST 1.0 (1): struct ofp10_flow_stats_request. */
 265     OFPRAW_OFPST10_FLOW_REQUEST,
 266     /* OFPST 1.1+ (1): struct ofp11_flow_stats_request, uint8_t[8][]. */
 267     OFPRAW_OFPST11_FLOW_REQUEST,
 268     /* NXST 1.0 (0): struct nx_flow_stats_request, uint8_t[8][]. */
 269     OFPRAW_NXST_FLOW_REQUEST,
 270
 271     /* OFPST 1.0 (1): uint8_t[]. */
 272     OFPRAW_OFPST10_FLOW_REPLY,
 273     /* OFPST 1.1-1.2 (1): uint8_t[]. */
 274     OFPRAW_OFPST11_FLOW_REPLY,
 275     /* OFPST 1.3+ (1): uint8_t[]. */
 276     OFPRAW_OFPST13_FLOW_REPLY,
 277     /* NXST 1.0 (0): uint8_t[]. */
 278     OFPRAW_NXST_FLOW_REPLY,
 279
 280     /* OFPST 1.0 (2): struct ofp10_flow_stats_request. */
 281     OFPRAW_OFPST10_AGGREGATE_REQUEST,
 282     /* OFPST 1.1+ (2): struct ofp11_flow_stats_request, uint8_t[8][]. */
 283     OFPRAW_OFPST11_AGGREGATE_REQUEST,
 284     /* NXST 1.0 (1): struct nx_flow_stats_request, uint8_t[8][]. */
 285     OFPRAW_NXST_AGGREGATE_REQUEST,
 286
 287     /* OFPST 1.0+ (2): struct ofp_aggregate_stats_reply. */
 288     OFPRAW_OFPST_AGGREGATE_REPLY,
 289     /* NXST 1.0 (1): struct ofp_aggregate_stats_reply. */
 290     OFPRAW_NXST_AGGREGATE_REPLY,
 291
 292     /* OFPST 1.0+ (3): void. */
 293     OFPRAW_OFPST_TABLE_REQUEST,
 294
 295     /* OFPST 1.0 (3): struct ofp10_table_stats[]. */
 296     OFPRAW_OFPST10_TABLE_REPLY,
 297     /* OFPST 1.1 (3): struct ofp11_table_stats[]. */
 298     OFPRAW_OFPST11_TABLE_REPLY,
 299     /* OFPST 1.2 (3): struct ofp12_table_stats[]. */
 300     OFPRAW_OFPST12_TABLE_REPLY,
 301     /* OFPST 1.3+ (3): struct ofp13_table_stats[]. */
 302     OFPRAW_OFPST13_TABLE_REPLY,
 303
 304     /* OFPST 1.0 (4): struct ofp10_port_stats_request. */
 305     OFPRAW_OFPST10_PORT_REQUEST,
 306     /* OFPST 1.1+ (4): struct ofp11_port_stats_request. */
 307     OFPRAW_OFPST11_PORT_REQUEST,
 308
 309     /* OFPST 1.0 (4): struct ofp10_port_stats[]. */
 310     OFPRAW_OFPST10_PORT_REPLY,
 311     /* OFPST 1.1-1.2 (4): struct ofp11_port_stats[]. */
 312     OFPRAW_OFPST11_PORT_REPLY,
 313     /* OFPST 1.3 (4): struct ofp13_port_stats[]. */
 314     OFPRAW_OFPST13_PORT_REPLY,
 315     /* OFPST 1.4+ (4): uint8_t[8][]. */
 316     OFPRAW_OFPST14_PORT_REPLY,
 317
 318     /* OFPST 1.0 (5): struct ofp10_queue_stats_request. */
 319     OFPRAW_OFPST10_QUEUE_REQUEST,
 320     /* OFPST 1.1+ (5): struct ofp11_queue_stats_request. */
 321     OFPRAW_OFPST11_QUEUE_REQUEST,
 322
 323     /* OFPST 1.0 (5): struct ofp10_queue_stats[]. */
 324     OFPRAW_OFPST10_QUEUE_REPLY,
 325     /* OFPST 1.1-1.2 (5): struct ofp11_queue_stats[]. */
 326     OFPRAW_OFPST11_QUEUE_REPLY,
 327     /* OFPST 1.3 (5): struct ofp13_queue_stats[]. */
 328     OFPRAW_OFPST13_QUEUE_REPLY,
 329     /* OFPST 1.4+ (5): uint8_t[8][]. */
 330     OFPRAW_OFPST14_QUEUE_REPLY,
 331
 332     /* OFPST 1.1+ (6): struct ofp11_group_stats_request. */
 333     OFPRAW_OFPST11_GROUP_REQUEST,
 334
 335     /* OFPST 1.1-1.2 (6): uint8_t[8][]. */
 336     OFPRAW_OFPST11_GROUP_REPLY,
 337     /* OFPST 1.3+ (6): uint8_t[8][]. */
 338     OFPRAW_OFPST13_GROUP_REPLY,
 339
 340     /* OFPST 1.1-1.4 (7): void. */
 341     OFPRAW_OFPST11_GROUP_DESC_REQUEST,
 342     /* OFPST 1.5+ (7): struct ofp15_group_desc_request. */
 343     OFPRAW_OFPST15_GROUP_DESC_REQUEST,
 344
 345     /* OFPST 1.1+ (7): uint8_t[8][]. */
 346     OFPRAW_OFPST11_GROUP_DESC_REPLY,
 347
 348     /* OFPST 1.2+ (8): void. */
 349     OFPRAW_OFPST12_GROUP_FEATURES_REQUEST,
 350
 351     /* OFPST 1.2+ (8): struct ofp12_group_features_stats. */
 352     OFPRAW_OFPST12_GROUP_FEATURES_REPLY,
 353
 354     /* OFPST 1.3+ (9): struct ofp13_meter_multipart_request. */
 355     OFPRAW_OFPST13_METER_REQUEST,
 356
 357     /* OFPST 1.3+ (9): uint8_t[8][]. */
 358     OFPRAW_OFPST13_METER_REPLY,
 359
 360     /* OFPST 1.3+ (10): struct ofp13_meter_multipart_request. */
 361     OFPRAW_OFPST13_METER_CONFIG_REQUEST,
 362
 363     /* OFPST 1.3+ (10): uint8_t[8][]. */
 364     OFPRAW_OFPST13_METER_CONFIG_REPLY,
 365
 366     /* OFPST 1.3+ (11): void. */
 367     OFPRAW_OFPST13_METER_FEATURES_REQUEST,
 368
 369     /* OFPST 1.3+ (11): struct ofp13_meter_features. */
 370     OFPRAW_OFPST13_METER_FEATURES_REPLY,
 371
 372     /* OFPST 1.3+ (12): void. */
 373     OFPRAW_OFPST13_TABLE_FEATURES_REQUEST,
 374
 375     /* OFPST 1.3+ (12): struct ofp13_table_features, uint8_t[8][]. */
 376     OFPRAW_OFPST13_TABLE_FEATURES_REPLY,
 377
 378     /* OFPST 1.4+ (15): void. */
 379     OFPRAW_OFPST14_TABLE_DESC_REQUEST,
 380
 381     /* OFPST 1.4+ (15): struct ofp14_table_desc, uint8_t[8][]. */
 382     OFPRAW_OFPST14_TABLE_DESC_REPLY,
 383
 384     /* OFPST 1.0-1.4 (13): void. */
 385     OFPRAW_OFPST10_PORT_DESC_REQUEST,
 386     /* OFPST 1.5+ (13): struct ofp15_port_desc_request. */
 387     OFPRAW_OFPST15_PORT_DESC_REQUEST,
 388
 389     /* OFPST 1.0 (13): struct ofp10_phy_port[]. */
 390     OFPRAW_OFPST10_PORT_DESC_REPLY,
 391     /* OFPST 1.1-1.3 (13): struct ofp11_port[]. */
 392     OFPRAW_OFPST11_PORT_DESC_REPLY,
 393     /* OFPST 1.4+ (13): uint8_t[8][]. */
 394     OFPRAW_OFPST14_PORT_DESC_REPLY,
 395
 396     /* OFPST 1.4+ (16): uint8_t[8][]. */
 397     OFPRAW_OFPST14_FLOW_MONITOR_REQUEST,
 398     /* NXST 1.0 (2): uint8_t[8][]. */
 399     OFPRAW_NXST_FLOW_MONITOR_REQUEST,
 400
 401     /* OFPST 1.4+ (16): uint8_t[8][]. */
 402     OFPRAW_OFPST14_FLOW_MONITOR_REPLY,
 403     /* NXST 1.0 (2): uint8_t[8][]. */
 404     OFPRAW_NXST_FLOW_MONITOR_REPLY,
 405
 406 /* Nicira extension messages.
 407  *
 408  * Nicira extensions that correspond to standard OpenFlow messages are listed
 409  * alongside the standard versions above. */
 410
 411     /* NXT 1.0 (12): struct nx_set_flow_format. */
 412     OFPRAW_NXT_SET_FLOW_FORMAT,
 413
 414     /* NXT 1.0+ (15): struct nx_flow_mod_table_id. */
 415     OFPRAW_NXT_FLOW_MOD_TABLE_ID,
 416
 417     /* NXT 1.0+ (16): struct nx_set_packet_in_format. */
 418     OFPRAW_NXT_SET_PACKET_IN_FORMAT,
 419
 420     /* NXT 1.0+ (18): void. */
 421     OFPRAW_NXT_FLOW_AGE,
 422
 423     /* NXT 1.0+ (20): struct nx_controller_id. */
 424     OFPRAW_NXT_SET_CONTROLLER_ID,
 425
 426     /* NXT 1.0+ (21): struct nx_flow_monitor_cancel. */
 427     OFPRAW_NXT_FLOW_MONITOR_CANCEL,
 428
 429     /* NXT 1.0+ (22): void. */
 430     OFPRAW_NXT_FLOW_MONITOR_PAUSED,
 431
 432     /* NXT 1.0+ (23): void. */
 433     OFPRAW_NXT_FLOW_MONITOR_RESUMED,
 434
 435     /* NXT 1.0+ (24): struct nx_geneve_table_mod, struct nx_geneve_map[]. */
 436     OFPRAW_NXT_GENEVE_TABLE_MOD,
 437
 438     /* NXT 1.0+ (25): void. */
 439     OFPRAW_NXT_GENEVE_TABLE_REQUEST,
 440
 441     /* NXT 1.0+ (26): struct nx_geneve_table_reply, struct nx_geneve_map[]. */
 442     OFPRAW_NXT_GENEVE_TABLE_REPLY,
 443 };
 444
 445 /* Decoding messages into OFPRAW_* values. */
 446 enum ofperr ofpraw_decode(enum ofpraw *, const struct ofp_header *);
 447 enum ofpraw ofpraw_decode_assert(const struct ofp_header *);
 448 enum ofperr ofpraw_pull(enum ofpraw *, struct ofpbuf *);
 449 enum ofpraw ofpraw_pull_assert(struct ofpbuf *);
 450
 451 enum ofperr ofpraw_decode_partial(enum ofpraw *,
 452                                   const struct ofp_header *, size_t length);
 453
 454 /* Encoding messages using OFPRAW_* values. */
 455 struct ofpbuf *ofpraw_alloc(enum ofpraw, uint8_t ofp_version,
 456                             size_t extra_tailroom);
 457 struct ofpbuf *ofpraw_alloc_xid(enum ofpraw, uint8_t ofp_version,
 458                                 ovs_be32 xid, size_t extra_tailroom);
 459 struct ofpbuf *ofpraw_alloc_reply(enum ofpraw,
 460                                   const struct ofp_header *request,
 461                                   size_t extra_tailroom);
 462 struct ofpbuf *ofpraw_alloc_stats_reply(const struct ofp_header *request,
 463                                         size_t extra_tailroom);
 464
 465 void ofpraw_put(enum ofpraw, uint8_t ofp_version, struct ofpbuf *);
 466 void ofpraw_put_xid(enum ofpraw, uint8_t ofp_version, ovs_be32 xid,
 467                     struct ofpbuf *);
 468 void ofpraw_put_reply(enum ofpraw, const struct ofp_header *request,
 469                       struct ofpbuf *);
 470 void ofpraw_put_stats_reply(const struct ofp_header *request, struct ofpbuf *);
 471
 472 /* Information about OFPRAW_* values. */
 473 const char *ofpraw_get_name(enum ofpraw);
 474 enum ofpraw ofpraw_stats_request_to_reply(enum ofpraw, uint8_t version);
 475 \f
 476 /* Semantic identifiers for OpenFlow messages.
 477  *
 478  * Each OFPTYPE_* enumeration constant represents one or more concrete format
 479  * of OpenFlow message.  When two variants of a message have essentially the
 480  * same meaning, they are assigned a single OFPTYPE_* value.
 481  *
 482  * The comments here must follow a stylized form because the "extract-ofp-msgs"
 483  * program parses them at build time to generate data tables.  The format is
 484  * simply to list each OFPRAW_* enumeration constant for a given OFPTYPE_*,
 485  * each followed by a period. */
 486 enum ofptype {
 487     /* Immutable messages. */
 488     OFPTYPE_HELLO,               /* OFPRAW_OFPT_HELLO. */
 489     OFPTYPE_ERROR,               /* OFPRAW_OFPT_ERROR. */
 490     OFPTYPE_ECHO_REQUEST,        /* OFPRAW_OFPT_ECHO_REQUEST. */
 491     OFPTYPE_ECHO_REPLY,          /* OFPRAW_OFPT_ECHO_REPLY. */
 492
 493     /* Switch configuration messages. */
 494     OFPTYPE_FEATURES_REQUEST,    /* OFPRAW_OFPT_FEATURES_REQUEST. */
 495     OFPTYPE_FEATURES_REPLY,      /* OFPRAW_OFPT10_FEATURES_REPLY.
 496                                   * OFPRAW_OFPT11_FEATURES_REPLY.
 497                                   * OFPRAW_OFPT13_FEATURES_REPLY. */
 498     OFPTYPE_GET_CONFIG_REQUEST,  /* OFPRAW_OFPT_GET_CONFIG_REQUEST. */
 499     OFPTYPE_GET_CONFIG_REPLY,    /* OFPRAW_OFPT_GET_CONFIG_REPLY. */
 500     OFPTYPE_SET_CONFIG,          /* OFPRAW_OFPT_SET_CONFIG. */
 501
 502     /* Asynchronous messages. */
 503     OFPTYPE_PACKET_IN,           /* OFPRAW_OFPT10_PACKET_IN.
 504                                   * OFPRAW_OFPT11_PACKET_IN.
 505                                   * OFPRAW_OFPT12_PACKET_IN.
 506                                   * OFPRAW_OFPT13_PACKET_IN.
 507                                   * OFPRAW_NXT_PACKET_IN. */
 508     OFPTYPE_FLOW_REMOVED,        /* OFPRAW_OFPT10_FLOW_REMOVED.
 509                                   * OFPRAW_OFPT11_FLOW_REMOVED.
 510                                   * OFPRAW_NXT_FLOW_REMOVED. */
 511     OFPTYPE_PORT_STATUS,         /* OFPRAW_OFPT10_PORT_STATUS.
 512                                   * OFPRAW_OFPT11_PORT_STATUS.
 513                                   * OFPRAW_OFPT14_PORT_STATUS. */
 514
 515     /* Controller command messages. */
 516     OFPTYPE_PACKET_OUT,          /* OFPRAW_OFPT10_PACKET_OUT.
 517                                   * OFPRAW_OFPT11_PACKET_OUT. */
 518     OFPTYPE_FLOW_MOD,            /* OFPRAW_OFPT10_FLOW_MOD.
 519                                   * OFPRAW_OFPT11_FLOW_MOD.
 520                                   * OFPRAW_NXT_FLOW_MOD. */
 521     OFPTYPE_GROUP_MOD,           /* OFPRAW_OFPT11_GROUP_MOD.
 522                                   * OFPRAW_OFPT15_GROUP_MOD. */
 523     OFPTYPE_PORT_MOD,            /* OFPRAW_OFPT10_PORT_MOD.
 524                                   * OFPRAW_OFPT11_PORT_MOD.
 525                                   * OFPRAW_OFPT14_PORT_MOD. */
 526     OFPTYPE_TABLE_MOD,           /* OFPRAW_OFPT11_TABLE_MOD.
 527                                   * OFPRAW_OFPT14_TABLE_MOD. */
 528
 529     /* Barrier messages. */
 530     OFPTYPE_BARRIER_REQUEST,     /* OFPRAW_OFPT10_BARRIER_REQUEST.
 531                                   * OFPRAW_OFPT11_BARRIER_REQUEST. */
 532     OFPTYPE_BARRIER_REPLY,       /* OFPRAW_OFPT10_BARRIER_REPLY.
 533                                   * OFPRAW_OFPT11_BARRIER_REPLY. */
 534
 535     /* Queue Configuration messages. */
 536     OFPTYPE_QUEUE_GET_CONFIG_REQUEST, /* OFPRAW_OFPT10_QUEUE_GET_CONFIG_REQUEST.
 537                                        * OFPRAW_OFPT11_QUEUE_GET_CONFIG_REQUEST. */
 538     OFPTYPE_QUEUE_GET_CONFIG_REPLY, /* OFPRAW_OFPT10_QUEUE_GET_CONFIG_REPLY.
 539                                      * OFPRAW_OFPT11_QUEUE_GET_CONFIG_REPLY. */
 540
 541     /* Controller role change request messages. */
 542     OFPTYPE_ROLE_REQUEST,         /* OFPRAW_OFPT12_ROLE_REQUEST.
 543                                    * OFPRAW_NXT_ROLE_REQUEST. */
 544     OFPTYPE_ROLE_REPLY,           /* OFPRAW_OFPT12_ROLE_REPLY.
 545                                    * OFPRAW_NXT_ROLE_REPLY. */
 546
 547     /* Asynchronous message configuration. */
 548     OFPTYPE_GET_ASYNC_REQUEST,    /* OFPRAW_OFPT13_GET_ASYNC_REQUEST.
 549                                    * OFPRAW_OFPT14_GET_ASYNC_REQUEST. */
 550     OFPTYPE_GET_ASYNC_REPLY,      /* OFPRAW_OFPT13_GET_ASYNC_REPLY.
 551                                    * OFPRAW_OFPT14_GET_ASYNC_REPLY. */
 552     OFPTYPE_SET_ASYNC_CONFIG,     /* OFPRAW_NXT_SET_ASYNC_CONFIG.
 553                                    * OFPRAW_OFPT13_SET_ASYNC.
 554                                    * OFPRAW_OFPT14_SET_ASYNC. */
 555
 556     /* Meters and rate limiters configuration messages. */
 557     OFPTYPE_METER_MOD,            /* OFPRAW_OFPT13_METER_MOD. */
 558
 559     /* Controller role change event messages. */
 560     OFPTYPE_ROLE_STATUS,          /* OFPRAW_OFPT14_ROLE_STATUS. */
 561
 562     OFPTYPE_BUNDLE_CONTROL,       /* OFPRAW_OFPT14_BUNDLE_CONTROL. */
 563
 564     OFPTYPE_BUNDLE_ADD_MESSAGE,   /* OFPRAW_OFPT14_BUNDLE_ADD_MESSAGE. */
 565
 566     /* Statistics. */
 567     OFPTYPE_DESC_STATS_REQUEST,      /* OFPRAW_OFPST_DESC_REQUEST. */
 568     OFPTYPE_DESC_STATS_REPLY,        /* OFPRAW_OFPST_DESC_REPLY. */
 569     OFPTYPE_FLOW_STATS_REQUEST,      /* OFPRAW_OFPST10_FLOW_REQUEST.
 570                                       * OFPRAW_OFPST11_FLOW_REQUEST.
 571                                       * OFPRAW_NXST_FLOW_REQUEST. */
 572     OFPTYPE_FLOW_STATS_REPLY,        /* OFPRAW_OFPST10_FLOW_REPLY.
 573                                       * OFPRAW_OFPST11_FLOW_REPLY.
 574                                       * OFPRAW_OFPST13_FLOW_REPLY.
 575                                       * OFPRAW_NXST_FLOW_REPLY. */
 576     OFPTYPE_AGGREGATE_STATS_REQUEST, /* OFPRAW_OFPST10_AGGREGATE_REQUEST.
 577                                       * OFPRAW_OFPST11_AGGREGATE_REQUEST.
 578                                       * OFPRAW_NXST_AGGREGATE_REQUEST. */
 579     OFPTYPE_AGGREGATE_STATS_REPLY,   /* OFPRAW_OFPST_AGGREGATE_REPLY.
 580                                       * OFPRAW_NXST_AGGREGATE_REPLY. */
 581     OFPTYPE_TABLE_STATS_REQUEST,     /* OFPRAW_OFPST_TABLE_REQUEST. */
 582     OFPTYPE_TABLE_STATS_REPLY,       /* OFPRAW_OFPST10_TABLE_REPLY.
 583                                       * OFPRAW_OFPST11_TABLE_REPLY.
 584                                       * OFPRAW_OFPST12_TABLE_REPLY.
 585                                       * OFPRAW_OFPST13_TABLE_REPLY. */
 586     OFPTYPE_PORT_STATS_REQUEST,      /* OFPRAW_OFPST10_PORT_REQUEST.
 587                                       * OFPRAW_OFPST11_PORT_REQUEST. */
 588     OFPTYPE_PORT_STATS_REPLY,        /* OFPRAW_OFPST10_PORT_REPLY.
 589                                       * OFPRAW_OFPST11_PORT_REPLY.
 590                                       * OFPRAW_OFPST13_PORT_REPLY.
 591                                       * OFPRAW_OFPST14_PORT_REPLY. */
 592     OFPTYPE_QUEUE_STATS_REQUEST,     /* OFPRAW_OFPST10_QUEUE_REQUEST.
 593                                       * OFPRAW_OFPST11_QUEUE_REQUEST. */
 594     OFPTYPE_QUEUE_STATS_REPLY,       /* OFPRAW_OFPST10_QUEUE_REPLY.
 595                                       * OFPRAW_OFPST11_QUEUE_REPLY.
 596                                       * OFPRAW_OFPST13_QUEUE_REPLY.
 597                                       * OFPRAW_OFPST14_QUEUE_REPLY. */
 598
 599     OFPTYPE_GROUP_STATS_REQUEST,     /* OFPRAW_OFPST11_GROUP_REQUEST. */
 600
 601     OFPTYPE_GROUP_STATS_REPLY,       /* OFPRAW_OFPST11_GROUP_REPLY.
 602                                       * OFPRAW_OFPST13_GROUP_REPLY. */
 603
 604     OFPTYPE_GROUP_DESC_STATS_REQUEST, /* OFPRAW_OFPST11_GROUP_DESC_REQUEST.
 605                                        * OFPRAW_OFPST15_GROUP_DESC_REQUEST. */
 606
 607     OFPTYPE_GROUP_DESC_STATS_REPLY,  /* OFPRAW_OFPST11_GROUP_DESC_REPLY. */
 608
 609     OFPTYPE_GROUP_FEATURES_STATS_REQUEST, /* OFPRAW_OFPST12_GROUP_FEATURES_REQUEST. */
 610
 611     OFPTYPE_GROUP_FEATURES_STATS_REPLY, /* OFPRAW_OFPST12_GROUP_FEATURES_REPLY. */
 612
 613     OFPTYPE_METER_STATS_REQUEST,     /* OFPRAW_OFPST13_METER_REQUEST. */
 614
 615     OFPTYPE_METER_STATS_REPLY,       /* OFPRAW_OFPST13_METER_REPLY. */
 616
 617     OFPTYPE_METER_CONFIG_STATS_REQUEST, /* OFPRAW_OFPST13_METER_CONFIG_REQUEST. */
 618
 619     OFPTYPE_METER_CONFIG_STATS_REPLY, /* OFPRAW_OFPST13_METER_CONFIG_REPLY. */
 620
 621     OFPTYPE_METER_FEATURES_STATS_REQUEST, /* OFPRAW_OFPST13_METER_FEATURES_REQUEST. */
 622
 623     OFPTYPE_METER_FEATURES_STATS_REPLY, /* OFPRAW_OFPST13_METER_FEATURES_REPLY. */
 624
 625     OFPTYPE_TABLE_FEATURES_STATS_REQUEST, /* OFPRAW_OFPST13_TABLE_FEATURES_REQUEST. */
 626
 627     OFPTYPE_TABLE_FEATURES_STATS_REPLY, /* OFPRAW_OFPST13_TABLE_FEATURES_REPLY. */
 628
 629     OFPTYPE_TABLE_DESC_REQUEST,      /* OFPRAW_OFPST14_TABLE_DESC_REQUEST. */
 630
 631     OFPTYPE_TABLE_DESC_REPLY,        /* OFPRAW_OFPST14_TABLE_DESC_REPLY. */
 632
 633     OFPTYPE_PORT_DESC_STATS_REQUEST, /* OFPRAW_OFPST10_PORT_DESC_REQUEST.
 634                                       * OFPRAW_OFPST15_PORT_DESC_REQUEST. */
 635
 636     OFPTYPE_PORT_DESC_STATS_REPLY,   /* OFPRAW_OFPST10_PORT_DESC_REPLY.
 637                                       * OFPRAW_OFPST11_PORT_DESC_REPLY.
 638                                       * OFPRAW_OFPST14_PORT_DESC_REPLY. */
 639
 640     OFPTYPE_FLOW_MONITOR_STATS_REQUEST, /* OFPRAW_OFPST14_FLOW_MONITOR_REQUEST.
 641                                          * OFPRAW_NXST_FLOW_MONITOR_REQUEST. */
 642     OFPTYPE_FLOW_MONITOR_STATS_REPLY,   /* OFPRAW_OFPST14_FLOW_MONITOR_REPLY.
 643                                          * OFPRAW_NXST_FLOW_MONITOR_REPLY. */
 644
 645     /* Nicira extensions. */
 646     OFPTYPE_SET_FLOW_FORMAT,      /* OFPRAW_NXT_SET_FLOW_FORMAT. */
 647     OFPTYPE_FLOW_MOD_TABLE_ID,    /* OFPRAW_NXT_FLOW_MOD_TABLE_ID. */
 648     OFPTYPE_SET_PACKET_IN_FORMAT, /* OFPRAW_NXT_SET_PACKET_IN_FORMAT. */
 649     OFPTYPE_FLOW_AGE,             /* OFPRAW_NXT_FLOW_AGE. */
 650     OFPTYPE_SET_CONTROLLER_ID,    /* OFPRAW_NXT_SET_CONTROLLER_ID. */
 651     OFPTYPE_NXT_GENEVE_TABLE_MOD, /* OFPRAW_NXT_GENEVE_TABLE_MOD. */
 652     OFPTYPE_NXT_GENEVE_TABLE_REQUEST, /* OFPRAW_NXT_GENEVE_TABLE_REQUEST. */
 653     OFPTYPE_NXT_GENEVE_TABLE_REPLY, /* OFPRAW_NXT_GENEVE_TABLE_REPLY. */
 654
 655     /* Flow monitor extension. */
 656     OFPTYPE_FLOW_MONITOR_CANCEL,        /* OFPRAW_NXT_FLOW_MONITOR_CANCEL. */
 657     OFPTYPE_FLOW_MONITOR_PAUSED,        /* OFPRAW_NXT_FLOW_MONITOR_PAUSED. */
 658     OFPTYPE_FLOW_MONITOR_RESUMED,       /* OFPRAW_NXT_FLOW_MONITOR_RESUMED. */
 659 };
 660
 661 /* Decoding messages into OFPTYPE_* values. */
 662 enum ofperr ofptype_decode(enum ofptype *, const struct ofp_header *);
 663 enum ofperr ofptype_pull(enum ofptype *, struct ofpbuf *);
 664 enum ofptype ofptype_from_ofpraw(enum ofpraw);
 665
 666 /* Information about OFTYPE_* values. */
 667 const char *ofptype_get_name(enum ofptype);
 668 \f
 669 /* OpenFlow message properties. */
 670 void ofpmsg_update_length(struct ofpbuf *);
 671 const void *ofpmsg_body(const struct ofp_header *);
 672 bool ofpmsg_is_stat_request(const struct ofp_header *);
 673 \f
 674 /* Multipart messages (aka "statistics").
 675  *
 676  * Individual OpenFlow messages are limited to 64 kB in size, but some messages
 677  * need to be longer.  Therefore, multipart messages allow a longer message to
 678  * be divided into multiple parts at some convenient boundary.  For example,
 679  * limiting the response to a "flow dump" request to 64 kB would unreasonably
 680  * limit the maximum number of flows in an OpenFlow switch, so a "flow dump" is
 681  * expressed as a multipart request/reply pair, with the reply broken into
 682  * pieces between flows.
 683  *
 684  * Multipart messages always consist of a request/reply pair.
 685  *
 686  * In OpenFlow 1.0, 1.1, and 1.2, requests must always fit in a single message,
 687  * that is, only a multipart reply may have more than one part.  OpenFlow 1.3
 688  * adds one multipart request.  This code does not yet support multipart
 689  * requests. */
 690
 691 /* Encoding multipart replies.
 692  *
 693  * These functions are useful for multipart replies that might really require
 694  * more than one message.  A multipart message that is known in advance to fit
 695  * within 64 kB doesn't need any special treatment, so you might as well use
 696  * the ofpraw_alloc_*() functions.
 697  *
 698  * These functions work with a "struct ovs_list" of "struct ofpbuf"s, each of
 699  * which represents one part of a multipart message. */
 700 void ofpmp_init(struct ovs_list *, const struct ofp_header *request);
 701 struct ofpbuf *ofpmp_reserve(struct ovs_list *, size_t len);
 702 void *ofpmp_append(struct ovs_list *, size_t len);
 703 void ofpmp_postappend(struct ovs_list *, size_t start_ofs);
 704
 705 enum ofp_version ofpmp_version(struct ovs_list *);
 706 enum ofpraw ofpmp_decode_raw(struct ovs_list *);
 707
 708 /* Decoding multipart replies. */
 709 uint16_t ofpmp_flags(const struct ofp_header *);
 710 bool ofpmp_more(const struct ofp_header *);
 711
 712 #endif /* ofp-msgs.h */