lib/ofp-msgs.h

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