include/openflow/openflow-common.h

   1 /* Copyright (c) 2008, 2011, 2012, 2013, 2014 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 /*
  35  * Copyright (c) 2008-2014 Nicira, Inc.
  36  *
  37  * Licensed under the Apache License, Version 2.0 (the "License");
  38  * you may not use this file except in compliance with the License.
  39  * You may obtain a copy of the License at:
  40  *
  41  *     http://www.apache.org/licenses/LICENSE-2.0
  42  *
  43  * Unless required by applicable law or agreed to in writing, software
  44  * distributed under the License is distributed on an "AS IS" BASIS,
  45  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  46  * See the License for the specific language governing permissions and
  47  * limitations under the License.
  48  */
  49
  50 #ifndef OPENFLOW_COMMON_H
  51 #define OPENFLOW_COMMON_H 1
  52
  53 #include "openvswitch/types.h"
  54
  55 #ifdef SWIG
  56 #define OFP_ASSERT(EXPR)        /* SWIG can't handle OFP_ASSERT. */
  57 #elif !defined(__cplusplus)
  58 /* Build-time assertion for use in a declaration context. */
  59 #define OFP_ASSERT(EXPR)                                                \
  60         extern int (*build_assert(void))[ sizeof(struct {               \
  61                     unsigned int build_assert_failed : (EXPR) ? 1 : -1; })]
  62 #else /* __cplusplus */
  63 #include <boost/static_assert.hpp>
  64 #define OFP_ASSERT BOOST_STATIC_ASSERT
  65 #endif /* __cplusplus */
  66
  67 /* Version number:
  68  * Non-experimental versions released: 0x01 0x02
  69  * Experimental versions released: 0x81 -- 0x99
  70  */
  71 /* The most significant bit being set in the version field indicates an
  72  * experimental OpenFlow version.
  73  */
  74 enum ofp_version {
  75     OFP10_VERSION = 0x01,
  76     OFP11_VERSION = 0x02,
  77     OFP12_VERSION = 0x03,
  78     OFP13_VERSION = 0x04,
  79     OFP14_VERSION = 0x05,
  80     OFP15_VERSION = 0x06
  81 };
  82
  83 /* Vendor (aka experimenter) IDs.
  84  *
  85  * These are used in various places in OpenFlow to identify an extension
  86  * defined by some vendor, as opposed to a standardized part of the core
  87  * OpenFlow protocol.
  88  *
  89  * Vendor IDs whose top 8 bits are 0 hold an Ethernet OUI in their low 24 bits.
  90  * The Open Networking Foundation assigns vendor IDs whose top 8 bits are
  91  * nonzero.
  92  *
  93  * A few vendor IDs are special:
  94  *
  95  *    - OF_VENDOR_ID is not a real vendor ID and does not appear in the
  96  *      OpenFlow protocol itself.  It can occasionally be useful within Open
  97  *      vSwitch to identify a standardized part of OpenFlow.
  98  *
  99  *    - ONF_VENDOR_ID is being used within the ONF "extensibility" working
 100  *      group to identify extensions being proposed for standardization.
 101  */
 102 #define OF_VENDOR_ID    0
 103 #define NX_VENDOR_ID    0x00002320 /* Nicira. */
 104 #define ONF_VENDOR_ID   0x4f4e4600 /* Open Networking Foundation. */
 105
 106 #define OFP_MAX_TABLE_NAME_LEN 32
 107 #define OFP_MAX_PORT_NAME_LEN  16
 108
 109 #define OFP_OLD_PORT  6633
 110 #define OFP_PORT  6653
 111
 112 #define OFP_ETH_ALEN 6          /* Bytes in an Ethernet address. */
 113
 114 #define OFP_DEFAULT_MISS_SEND_LEN   128
 115
 116 /* Values below this cutoff are 802.3 packets and the two bytes
 117  * following MAC addresses are used as a frame length.  Otherwise, the
 118  * two bytes are used as the Ethernet type.
 119  */
 120 #define OFP_DL_TYPE_ETH2_CUTOFF   0x0600
 121
 122 /* Value of dl_type to indicate that the frame does not include an
 123  * Ethernet type.
 124  */
 125 #define OFP_DL_TYPE_NOT_ETH_TYPE  0x05ff
 126
 127 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
 128  * is permanent. */
 129 #define OFP_FLOW_PERMANENT 0
 130
 131 /* By default, choose a priority in the middle. */
 132 #define OFP_DEFAULT_PRIORITY 0x8000
 133
 134
 135 /* Header on all OpenFlow packets. */
 136 struct ofp_header {
 137     uint8_t version;    /* An OpenFlow version number, e.g. OFP10_VERSION. */
 138     uint8_t type;       /* One of the OFPT_ constants. */
 139     ovs_be16 length;    /* Length including this ofp_header. */
 140     ovs_be32 xid;       /* Transaction id associated with this packet.
 141                            Replies use the same id as was in the request
 142                            to facilitate pairing. */
 143 };
 144 OFP_ASSERT(sizeof(struct ofp_header) == 8);
 145
 146 /* OFPT_ERROR: Error message (datapath -> controller). */
 147 struct ofp_error_msg {
 148     ovs_be16 type;
 149     ovs_be16 code;
 150     uint8_t data[0];          /* Variable-length data.  Interpreted based
 151                                  on the type and code. */
 152 };
 153 OFP_ASSERT(sizeof(struct ofp_error_msg) == 4);
 154
 155 enum ofp_config_flags {
 156     /* Handling of IP fragments. */
 157     OFPC_FRAG_NORMAL   = 0,  /* No special handling for fragments. */
 158     OFPC_FRAG_DROP     = 1,  /* Drop fragments. */
 159     OFPC_FRAG_REASM    = 2,  /* Reassemble (only if OFPC_IP_REASM set). */
 160     OFPC_FRAG_NX_MATCH = 3,  /* Make first fragments available for matching. */
 161     OFPC_FRAG_MASK     = 3,
 162
 163     /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OpenFlow 1.3 */
 164
 165     /* TTL processing - applicable for IP and MPLS packets. */
 166     OFPC_INVALID_TTL_TO_CONTROLLER = 1 << 2, /* Send packets with invalid TTL
 167                                                 to the controller. */
 168 };
 169
 170 /* Switch configuration. */
 171 struct ofp_switch_config {
 172     ovs_be16 flags;             /* OFPC_* flags. */
 173     ovs_be16 miss_send_len;     /* Max bytes of new flow that datapath should
 174                                    send to the controller. */
 175 };
 176 OFP_ASSERT(sizeof(struct ofp_switch_config) == 4);
 177
 178
 179 /* Common flags to indicate behavior of the physical port.  These flags are
 180  * used in ofp_port to describe the current configuration.  They are used in
 181  * the ofp_port_mod message to configure the port's behavior.
 182  */
 183 enum ofp_port_config {
 184     OFPPC_PORT_DOWN    = 1 << 0,  /* Port is administratively down. */
 185
 186     OFPPC_NO_RECV      = 1 << 2,  /* Drop all packets received by port. */
 187     OFPPC_NO_FWD       = 1 << 5,  /* Drop packets forwarded to port. */
 188     OFPPC_NO_PACKET_IN = 1 << 6   /* Do not send packet-in msgs for port. */
 189 };
 190
 191 /* Common current state of the physical port.  These are not configurable from
 192  * the controller.
 193  */
 194 enum ofp_port_state {
 195     OFPPS_LINK_DOWN    = 1 << 0,  /* No physical link present. */
 196 };
 197
 198 /* Common features of physical ports available in a datapath. */
 199 enum ofp_port_features {
 200     OFPPF_10MB_HD    = 1 << 0,  /* 10 Mb half-duplex rate support. */
 201     OFPPF_10MB_FD    = 1 << 1,  /* 10 Mb full-duplex rate support. */
 202     OFPPF_100MB_HD   = 1 << 2,  /* 100 Mb half-duplex rate support. */
 203     OFPPF_100MB_FD   = 1 << 3,  /* 100 Mb full-duplex rate support. */
 204     OFPPF_1GB_HD     = 1 << 4,  /* 1 Gb half-duplex rate support. */
 205     OFPPF_1GB_FD     = 1 << 5,  /* 1 Gb full-duplex rate support. */
 206     OFPPF_10GB_FD    = 1 << 6,  /* 10 Gb full-duplex rate support. */
 207 };
 208
 209 enum ofp_queue_properties {
 210     OFPQT_MIN_RATE = 1,          /* Minimum datarate guaranteed. */
 211     OFPQT_MAX_RATE = 2,          /* Maximum guaranteed rate. */
 212     OFPQT_EXPERIMENTER = 0xffff, /* Experimenter defined property. */
 213 };
 214
 215 /* Common description for a queue. */
 216 struct ofp_queue_prop_header {
 217     ovs_be16 property; /* One of OFPQT_. */
 218     ovs_be16 len;      /* Length of property, including this header. */
 219     uint8_t pad[4];    /* 64-bit alignemnt. */
 220 };
 221 OFP_ASSERT(sizeof(struct ofp_queue_prop_header) == 8);
 222
 223 /* Min-Rate and Max-Rate queue property description (OFPQT_MIN and
 224  * OFPQT_MAX). */
 225 struct ofp_queue_prop_rate {
 226     struct ofp_queue_prop_header prop_header;
 227     ovs_be16 rate;        /* In 1/10 of a percent; >1000 -> disabled. */
 228     uint8_t pad[6];       /* 64-bit alignment */
 229 };
 230 OFP_ASSERT(sizeof(struct ofp_queue_prop_rate) == 16);
 231
 232 /* Switch features. */
 233 struct ofp_switch_features {
 234     ovs_be64 datapath_id;   /* Datapath unique ID.  The lower 48-bits are for
 235                                a MAC address, while the upper 16-bits are
 236                                implementer-defined. */
 237
 238     ovs_be32 n_buffers;     /* Max packets buffered at once. */
 239
 240     uint8_t n_tables;       /* Number of tables supported by datapath. */
 241     uint8_t auxiliary_id;   /* OF 1.3: Identify auxiliary connections */
 242     uint8_t pad[2];         /* Align to 64-bits. */
 243
 244     /* Features. */
 245     ovs_be32 capabilities;  /* OFPC_*, OFPC10_*, OFPC11_*, OFPC12_*. */
 246     ovs_be32 actions;       /* Bitmap of supported "ofp_action_type"s.
 247                              * DEPRECATED in OpenFlow 1.1 */
 248
 249     /* Followed by an array of struct ofp10_phy_port or struct ofp11_port
 250      * structures.  The number is inferred from header.length.
 251      * REMOVED in OpenFlow 1.3 */
 252 };
 253 OFP_ASSERT(sizeof(struct ofp_switch_features) == 24);
 254
 255 /* Common capabilities supported by the datapath (struct ofp_switch_features,
 256  * member capabilities). */
 257 enum ofp_capabilities {
 258     OFPC_FLOW_STATS     = 1 << 0,  /* Flow statistics. */
 259     OFPC_TABLE_STATS    = 1 << 1,  /* Table statistics. */
 260     OFPC_PORT_STATS     = 1 << 2,  /* Port statistics. */
 261     OFPC_IP_REASM       = 1 << 5,  /* Can reassemble IP fragments. */
 262     OFPC_QUEUE_STATS    = 1 << 6,  /* Queue statistics. */
 263     OFPC_ARP_MATCH_IP   = 1 << 7   /* Match IP addresses in ARP
 264                                       pkts. */
 265 };
 266
 267 /* Why is this packet being sent to the controller? */
 268 enum ofp_packet_in_reason {
 269     OFPR_NO_MATCH,          /* No matching flow. */
 270     OFPR_ACTION,            /* Action explicitly output to controller. */
 271     OFPR_INVALID_TTL        /* Packet has invalid TTL. */,
 272     OFPR_N_REASONS
 273 };
 274
 275 enum ofp_flow_mod_command {
 276     OFPFC_ADD,              /* New flow. */
 277     OFPFC_MODIFY,           /* Modify all matching flows. */
 278     OFPFC_MODIFY_STRICT,    /* Modify entry strictly matching wildcards */
 279     OFPFC_DELETE,           /* Delete all matching flows. */
 280     OFPFC_DELETE_STRICT     /* Strictly match wildcards and priority. */
 281 };
 282
 283 enum ofp_flow_mod_flags {
 284     OFPFF_SEND_FLOW_REM = 1 << 0,  /* Send flow removed message when flow
 285                                     * expires or is deleted. */
 286     OFPFF_CHECK_OVERLAP = 1 << 1,  /* Check for overlapping entries first. */
 287 };
 288
 289 /* Why was this flow removed? */
 290 enum ofp_flow_removed_reason {
 291     OFPRR_IDLE_TIMEOUT,         /* Flow idle time exceeded idle_timeout. */
 292     OFPRR_HARD_TIMEOUT,         /* Time exceeded hard_timeout. */
 293     OFPRR_DELETE,               /* Evicted by a DELETE flow mod. */
 294     OFPRR_GROUP_DELETE,         /* Group was removed. */
 295     OFPRR_METER_DELETE,         /* Meter was removed. */
 296     OFPRR_EVICTION,             /* Switch eviction to free resources. */
 297 };
 298
 299 /* What changed about the physical port */
 300 enum ofp_port_reason {
 301     OFPPR_ADD,              /* The port was added. */
 302     OFPPR_DELETE,           /* The port was removed. */
 303     OFPPR_MODIFY            /* Some attribute of the port has changed. */
 304 };
 305
 306 /* A physical port has changed in the datapath */
 307 struct ofp_port_status {
 308     uint8_t reason;          /* One of OFPPR_*. */
 309     uint8_t pad[7];          /* Align to 64-bits. */
 310     /* Followed by struct ofp10_phy_port, struct ofp11_port, or struct
 311      * ofp14_port.  */
 312 };
 313 OFP_ASSERT(sizeof(struct ofp_port_status) == 8);
 314
 315 enum ofp_stats_reply_flags {
 316     OFPSF_REPLY_MORE  = 1 << 0  /* More replies to follow. */
 317 };
 318
 319 #define DESC_STR_LEN   256
 320 #define SERIAL_NUM_LEN 32
 321 /* Body of reply to OFPST_DESC request.  Each entry is a NULL-terminated ASCII
 322  * string. */
 323 struct ofp_desc_stats {
 324     char mfr_desc[DESC_STR_LEN];       /* Manufacturer description. */
 325     char hw_desc[DESC_STR_LEN];        /* Hardware description. */
 326     char sw_desc[DESC_STR_LEN];        /* Software description. */
 327     char serial_num[SERIAL_NUM_LEN];   /* Serial number. */
 328     char dp_desc[DESC_STR_LEN];        /* Human readable description of
 329                                           the datapath. */
 330 };
 331 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 1056);
 332
 333 /* Reply to OFPST_AGGREGATE request. */
 334 struct ofp_aggregate_stats_reply {
 335     ovs_32aligned_be64 packet_count; /* Number of packets in flows. */
 336     ovs_32aligned_be64 byte_count;   /* Number of bytes in flows. */
 337     ovs_be32 flow_count;      /* Number of flows. */
 338     uint8_t pad[4];           /* Align to 64 bits. */
 339 };
 340 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
 341
 342 /* The match type indicates the match structure (set of fields that compose the
 343  * match) in use. The match type is placed in the type field at the beginning
 344  * of all match structures. The "OpenFlow Extensible Match" type corresponds
 345  * to OXM TLV format described below and must be supported by all OpenFlow
 346  * switches. Extensions that define other match types may be published on the
 347  * ONF wiki. Support for extensions is optional.
 348  */
 349 enum ofp_match_type {
 350     OFPMT_STANDARD = 0,         /* The match fields defined in the ofp11_match
 351                                    structure apply */
 352     OFPMT_OXM = 1,              /* OpenFlow Extensible Match */
 353 };
 354
 355 /* Group numbering. Groups can use any number up to OFPG_MAX. */
 356 enum ofp_group {
 357     /* Last usable group number. */
 358     OFPG_MAX        = 0xffffff00,
 359
 360     /* Fake groups. */
 361     OFPG_ALL        = 0xfffffffc,  /* All groups, for group delete commands. */
 362     OFPG_ANY        = 0xffffffff   /* Wildcard, for flow stats requests. */
 363 };
 364
 365 /* Group configuration flags */
 366 enum ofp_group_capabilities {
 367     OFPGFC_SELECT_WEIGHT   = 1 << 0, /* Support weight for select groups */
 368     OFPGFC_SELECT_LIVENESS = 1 << 1, /* Support liveness for select groups */
 369     OFPGFC_CHAINING        = 1 << 2, /* Support chaining groups */
 370     OFPGFC_CHAINING_CHECKS = 1 << 3, /* Check chaining for loops and delete */
 371 };
 372
 373 enum ofp_hello_elem_type {
 374     OFPHET_VERSIONBITMAP          = 1, /* Bitmap of version supported. */
 375 };
 376
 377 /* Common header for all Hello Elements */
 378 struct ofp_hello_elem_header {
 379     ovs_be16    type;        /* One of OFPHET_*. */
 380     ovs_be16    length;      /* Length in bytes of this element. */
 381 };
 382 OFP_ASSERT(sizeof(struct ofp_hello_elem_header) == 4);
 383
 384 /* Vendor extension. */
 385 struct ofp_vendor_header {
 386     struct ofp_header header;   /* Type OFPT_VENDOR or OFPT_EXPERIMENTER. */
 387     ovs_be32 vendor;            /* Vendor ID:
 388                                  * - MSB 0: low-order bytes are IEEE OUI.
 389                                  * - MSB != 0: defined by OpenFlow
 390                                  *   consortium. */
 391     /* Vendor-defined arbitrary additional data. */
 392 };
 393 OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12);
 394
 395 /* Table numbering. Tables can use any number up to OFPT_MAX. */
 396 enum ofp_table {
 397     /* Last usable table number. */
 398     OFPTT_MAX = 0xfe,
 399
 400     /* Fake tables. */
 401     OFPTT_ALL = 0xff         /* Wildcard table used for table config,
 402                                 flow stats and flow deletes. */
 403 };
 404
 405 enum ofp_table_config {
 406     /* OpenFlow 1.1 and 1.2 defined this field as shown.
 407      * OpenFlow 1.3 and later mark this field as deprecated, but have not
 408      * reused it for any new purpose. */
 409     OFPTC11_TABLE_MISS_CONTROLLER = 0 << 0, /* Send to controller. */
 410     OFPTC11_TABLE_MISS_CONTINUE   = 1 << 0, /* Go to next table, like OF1.0. */
 411     OFPTC11_TABLE_MISS_DROP       = 2 << 0, /* Drop the packet. */
 412     OFPTC11_TABLE_MISS_MASK       = 3 << 0,
 413
 414     /* OpenFlow 1.4. */
 415     OFPTC14_EVICTION              = 1 << 2, /* Allow table to evict flows. */
 416     OFPTC14_VACANCY_EVENTS        = 1 << 3, /* Enable vacancy events. */
 417 };
 418
 419 #endif /* openflow/openflow-common.h */