include/openflow/openflow-common.h

   1 /* Copyright (c) 2008, 2011, 2012, 2013 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, 2009, 2010, 2011 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 };
  80
  81 /* Vendor (aka experimenter) IDs.
  82  *
  83  * These are used in various places in OpenFlow to identify an extension
  84  * defined by some vendor, as opposed to a standardized part of the core
  85  * OpenFlow protocol.
  86  *
  87  * Vendor IDs whose top 8 bits are 0 hold an Ethernet OUI in their low 24 bits.
  88  * The Open Networking Foundation assigns vendor IDs whose top 8 bits are
  89  * nonzero.
  90  *
  91  * A few vendor IDs are special:
  92  *
  93  *    - OF_VENDOR_ID is not a real vendor ID and does not appear in the
  94  *      OpenFlow protocol itself.  It can occasionally be useful within Open
  95  *      vSwitch to identify a standardized part of OpenFlow.
  96  *
  97  *    - ONF_VENDOR_ID is being used within the ONF "extensibility" working
  98  *      group to identify extensions being proposed for standardization.
  99  */
 100 #define OF_VENDOR_ID    0
 101 #define NX_VENDOR_ID    0x00002320 /* Nicira. */
 102 #define ONF_VENDOR_ID   0x4f4e4600 /* Open Networking Foundation. */
 103
 104 #define OFP_MAX_TABLE_NAME_LEN 32
 105 #define OFP_MAX_PORT_NAME_LEN  16
 106
 107 #define OFP_TCP_PORT  6633
 108 #define OFP_SSL_PORT  6633
 109
 110 #define OFP_ETH_ALEN 6          /* Bytes in an Ethernet address. */
 111
 112 #define OFP_DEFAULT_MISS_SEND_LEN   128
 113
 114 /* Values below this cutoff are 802.3 packets and the two bytes
 115  * following MAC addresses are used as a frame length.  Otherwise, the
 116  * two bytes are used as the Ethernet type.
 117  */
 118 #define OFP_DL_TYPE_ETH2_CUTOFF   0x0600
 119
 120 /* Value of dl_type to indicate that the frame does not include an
 121  * Ethernet type.
 122  */
 123 #define OFP_DL_TYPE_NOT_ETH_TYPE  0x05ff
 124
 125 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
 126  * is permanent. */
 127 #define OFP_FLOW_PERMANENT 0
 128
 129 /* By default, choose a priority in the middle. */
 130 #define OFP_DEFAULT_PRIORITY 0x8000
 131
 132
 133 /* Header on all OpenFlow packets. */
 134 struct ofp_header {
 135     uint8_t version;    /* An OpenFlow version number, e.g. OFP10_VERSION. */
 136     uint8_t type;       /* One of the OFPT_ constants. */
 137     ovs_be16 length;    /* Length including this ofp_header. */
 138     ovs_be32 xid;       /* Transaction id associated with this packet.
 139                            Replies use the same id as was in the request
 140                            to facilitate pairing. */
 141 };
 142 OFP_ASSERT(sizeof(struct ofp_header) == 8);
 143
 144 /* OFPT_ERROR: Error message (datapath -> controller). */
 145 struct ofp_error_msg {
 146     ovs_be16 type;
 147     ovs_be16 code;
 148     uint8_t data[0];          /* Variable-length data.  Interpreted based
 149                                  on the type and code. */
 150 };
 151 OFP_ASSERT(sizeof(struct ofp_error_msg) == 4);
 152
 153 enum ofp_config_flags {
 154     /* Handling of IP fragments. */
 155     OFPC_FRAG_NORMAL   = 0,  /* No special handling for fragments. */
 156     OFPC_FRAG_DROP     = 1,  /* Drop fragments. */
 157     OFPC_FRAG_REASM    = 2,  /* Reassemble (only if OFPC_IP_REASM set). */
 158     OFPC_FRAG_NX_MATCH = 3,  /* Make first fragments available for matching. */
 159     OFPC_FRAG_MASK     = 3,
 160
 161     /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OpenFlow 1.3 */
 162
 163     /* TTL processing - applicable for IP and MPLS packets. */
 164     OFPC_INVALID_TTL_TO_CONTROLLER = 1 << 2, /* Send packets with invalid TTL
 165                                                 to the controller. */
 166 };
 167
 168 /* Switch configuration. */
 169 struct ofp_switch_config {
 170     ovs_be16 flags;             /* OFPC_* flags. */
 171     ovs_be16 miss_send_len;     /* Max bytes of new flow that datapath should
 172                                    send to the controller. */
 173 };
 174 OFP_ASSERT(sizeof(struct ofp_switch_config) == 4);
 175
 176
 177 /* Common flags to indicate behavior of the physical port.  These flags are
 178  * used in ofp_port to describe the current configuration.  They are used in
 179  * the ofp_port_mod message to configure the port's behavior.
 180  */
 181 enum ofp_port_config {
 182     OFPPC_PORT_DOWN    = 1 << 0,  /* Port is administratively down. */
 183
 184     OFPPC_NO_RECV      = 1 << 2,  /* Drop all packets received by port. */
 185     OFPPC_NO_FWD       = 1 << 5,  /* Drop packets forwarded to port. */
 186     OFPPC_NO_PACKET_IN = 1 << 6   /* Do not send packet-in msgs for port. */
 187 };
 188
 189 /* Common current state of the physical port.  These are not configurable from
 190  * the controller.
 191  */
 192 enum ofp_port_state {
 193     OFPPS_LINK_DOWN    = 1 << 0,  /* No physical link present. */
 194 };
 195
 196 /* Common features of physical ports available in a datapath. */
 197 enum ofp_port_features {
 198     OFPPF_10MB_HD    = 1 << 0,  /* 10 Mb half-duplex rate support. */
 199     OFPPF_10MB_FD    = 1 << 1,  /* 10 Mb full-duplex rate support. */
 200     OFPPF_100MB_HD   = 1 << 2,  /* 100 Mb half-duplex rate support. */
 201     OFPPF_100MB_FD   = 1 << 3,  /* 100 Mb full-duplex rate support. */
 202     OFPPF_1GB_HD     = 1 << 4,  /* 1 Gb half-duplex rate support. */
 203     OFPPF_1GB_FD     = 1 << 5,  /* 1 Gb full-duplex rate support. */
 204     OFPPF_10GB_FD    = 1 << 6,  /* 10 Gb full-duplex rate support. */
 205 };
 206
 207 struct ofp_packet_queue {
 208     ovs_be32 queue_id;          /* id for the specific queue. */
 209     ovs_be16 len;               /* Length in bytes of this queue desc. */
 210     uint8_t pad[2];             /* 64-bit alignment. */
 211     /* struct ofp_queue_prop_header properties[0]; List of properties.  */
 212 };
 213 OFP_ASSERT(sizeof(struct ofp_packet_queue) == 8);
 214
 215 enum ofp_queue_properties {
 216     OFPQT_NONE = 0,       /* No property defined for queue (default). */
 217     OFPQT_MIN_RATE,       /* Minimum datarate guaranteed. */
 218                           /* Other types should be added here
 219                            * (i.e. max rate, precedence, etc). */
 220 };
 221
 222 /* Common description for a queue. */
 223 struct ofp_queue_prop_header {
 224     ovs_be16 property; /* One of OFPQT_. */
 225     ovs_be16 len;      /* Length of property, including this header. */
 226     uint8_t pad[4];    /* 64-bit alignemnt. */
 227 };
 228 OFP_ASSERT(sizeof(struct ofp_queue_prop_header) == 8);
 229
 230 /* Min-Rate queue property description. */
 231 struct ofp_queue_prop_min_rate {
 232     struct ofp_queue_prop_header prop_header; /* prop: OFPQT_MIN, len: 16. */
 233     ovs_be16 rate;        /* In 1/10 of a percent; >1000 -> disabled. */
 234     uint8_t pad[6];       /* 64-bit alignment */
 235 };
 236 OFP_ASSERT(sizeof(struct ofp_queue_prop_min_rate) == 16);
 237
 238 /* Switch features. */
 239 struct ofp_switch_features {
 240     ovs_be64 datapath_id;   /* Datapath unique ID.  The lower 48-bits are for
 241                                a MAC address, while the upper 16-bits are
 242                                implementer-defined. */
 243
 244     ovs_be32 n_buffers;     /* Max packets buffered at once. */
 245
 246     uint8_t n_tables;       /* Number of tables supported by datapath. */
 247     uint8_t auxiliary_id;   /* OF 1.3: Identify auxiliary connections */
 248     uint8_t pad[2];         /* Align to 64-bits. */
 249
 250     /* Features. */
 251     ovs_be32 capabilities;  /* OFPC_*, OFPC10_*, OFPC11_*, OFPC12_*. */
 252     ovs_be32 actions;       /* Bitmap of supported "ofp_action_type"s.
 253                              * DEPRECATED in OpenFlow 1.1 */
 254
 255     /* Followed by an array of struct ofp10_phy_port or struct ofp11_port
 256      * structures.  The number is inferred from header.length.
 257      * REMOVED in OpenFlow 1.3 */
 258 };
 259 OFP_ASSERT(sizeof(struct ofp_switch_features) == 24);
 260
 261 /* Common capabilities supported by the datapath (struct ofp_switch_features,
 262  * member capabilities). */
 263 enum ofp_capabilities {
 264     OFPC_FLOW_STATS     = 1 << 0,  /* Flow statistics. */
 265     OFPC_TABLE_STATS    = 1 << 1,  /* Table statistics. */
 266     OFPC_PORT_STATS     = 1 << 2,  /* Port statistics. */
 267     OFPC_IP_REASM       = 1 << 5,  /* Can reassemble IP fragments. */
 268     OFPC_QUEUE_STATS    = 1 << 6,  /* Queue statistics. */
 269     OFPC_ARP_MATCH_IP   = 1 << 7   /* Match IP addresses in ARP
 270                                       pkts. */
 271 };
 272
 273 /* Why is this packet being sent to the controller? */
 274 enum ofp_packet_in_reason {
 275     OFPR_NO_MATCH,          /* No matching flow. */
 276     OFPR_ACTION,            /* Action explicitly output to controller. */
 277     OFPR_INVALID_TTL        /* Packet has invalid TTL. */,
 278     OFPR_N_REASONS
 279 };
 280
 281 enum ofp_flow_mod_command {
 282     OFPFC_ADD,              /* New flow. */
 283     OFPFC_MODIFY,           /* Modify all matching flows. */
 284     OFPFC_MODIFY_STRICT,    /* Modify entry strictly matching wildcards */
 285     OFPFC_DELETE,           /* Delete all matching flows. */
 286     OFPFC_DELETE_STRICT     /* Strictly match wildcards and priority. */
 287 };
 288
 289 enum ofp_flow_mod_flags {
 290     OFPFF_SEND_FLOW_REM = 1 << 0,  /* Send flow removed message when flow
 291                                     * expires or is deleted. */
 292     OFPFF_CHECK_OVERLAP = 1 << 1,  /* Check for overlapping entries first. */
 293 };
 294
 295 /* Action header for OFPAT10_VENDOR and OFPAT11_EXPERIMEMNTER.
 296  * The rest of the body is vendor-defined. */
 297 struct ofp_action_vendor_header {
 298     ovs_be16 type;                  /* OFPAT10_VENDOR. */
 299     ovs_be16 len;                   /* Length is a multiple of 8. */
 300     ovs_be32 vendor;                /* Vendor ID, which takes the same form
 301                                        as in "struct ofp_vendor_header". */
 302 };
 303 OFP_ASSERT(sizeof(struct ofp_action_vendor_header) == 8);
 304
 305 /* Action header that is common to all actions.  The length includes the
 306  * header and any padding used to make the action 64-bit aligned.
 307  * NB: The length of an action *must* always be a multiple of eight. */
 308 struct ofp_action_header {
 309     ovs_be16 type;                  /* One of OFPAT10_*. */
 310     ovs_be16 len;                   /* Length of action, including this
 311                                        header.  This is the length of action,
 312                                        including any padding to make it
 313                                        64-bit aligned. */
 314     uint8_t pad[4];
 315 };
 316 OFP_ASSERT(sizeof(struct ofp_action_header) == 8);
 317
 318 /* Action structure for OFPAT10_SET_VLAN_VID and OFPAT11_SET_VLAN_VID. */
 319 struct ofp_action_vlan_vid {
 320     ovs_be16 type;                  /* Type. */
 321     ovs_be16 len;                   /* Length is 8. */
 322     ovs_be16 vlan_vid;              /* VLAN id. */
 323     uint8_t pad[2];
 324 };
 325 OFP_ASSERT(sizeof(struct ofp_action_vlan_vid) == 8);
 326
 327 /* Action structure for OFPAT10_SET_VLAN_PCP and OFPAT11_SET_VLAN_PCP. */
 328 struct ofp_action_vlan_pcp {
 329     ovs_be16 type;                  /* Type. */
 330     ovs_be16 len;                   /* Length is 8. */
 331     uint8_t vlan_pcp;               /* VLAN priority. */
 332     uint8_t pad[3];
 333 };
 334 OFP_ASSERT(sizeof(struct ofp_action_vlan_pcp) == 8);
 335
 336 /* Action structure for OFPAT10_SET_DL_SRC/DST and OFPAT11_SET_DL_SRC/DST. */
 337 struct ofp_action_dl_addr {
 338     ovs_be16 type;                  /* Type. */
 339     ovs_be16 len;                   /* Length is 16. */
 340     uint8_t dl_addr[OFP_ETH_ALEN];  /* Ethernet address. */
 341     uint8_t pad[6];
 342 };
 343 OFP_ASSERT(sizeof(struct ofp_action_dl_addr) == 16);
 344
 345 /* Action structure for OFPAT10_SET_NW_SRC/DST and OFPAT11_SET_NW_SRC/DST. */
 346 struct ofp_action_nw_addr {
 347     ovs_be16 type;                  /* Type. */
 348     ovs_be16 len;                   /* Length is 8. */
 349     ovs_be32 nw_addr;               /* IP address. */
 350 };
 351 OFP_ASSERT(sizeof(struct ofp_action_nw_addr) == 8);
 352
 353 /* Action structure for OFPAT10_SET_NW_TOS and OFPAT11_SET_NW_TOS. */
 354 struct ofp_action_nw_tos {
 355     ovs_be16 type;                  /* Type.. */
 356     ovs_be16 len;                   /* Length is 8. */
 357     uint8_t nw_tos;                 /* DSCP in high 6 bits, rest ignored. */
 358     uint8_t pad[3];
 359 };
 360 OFP_ASSERT(sizeof(struct ofp_action_nw_tos) == 8);
 361
 362 /* Action structure for OFPAT10_SET_TP_SRC/DST and OFPAT11_SET_TP_SRC/DST. */
 363 struct ofp_action_tp_port {
 364     ovs_be16 type;                  /* Type. */
 365     ovs_be16 len;                   /* Length is 8. */
 366     ovs_be16 tp_port;               /* TCP/UDP port. */
 367     uint8_t pad[2];
 368 };
 369 OFP_ASSERT(sizeof(struct ofp_action_tp_port) == 8);
 370
 371 /* Why was this flow removed? */
 372 enum ofp_flow_removed_reason {
 373     OFPRR_IDLE_TIMEOUT,         /* Flow idle time exceeded idle_timeout. */
 374     OFPRR_HARD_TIMEOUT,         /* Time exceeded hard_timeout. */
 375     OFPRR_DELETE,               /* Evicted by a DELETE flow mod. */
 376     OFPRR_GROUP_DELETE,         /* Group was removed. */
 377     OFPRR_EVICTION,             /* Switch eviction to free resources. */
 378     OFPRR_METER_DELETE,         /* Meter was removed. */
 379 };
 380
 381 /* What changed about the physical port */
 382 enum ofp_port_reason {
 383     OFPPR_ADD,              /* The port was added. */
 384     OFPPR_DELETE,           /* The port was removed. */
 385     OFPPR_MODIFY            /* Some attribute of the port has changed. */
 386 };
 387
 388 /* A physical port has changed in the datapath */
 389 struct ofp_port_status {
 390     uint8_t reason;          /* One of OFPPR_*. */
 391     uint8_t pad[7];          /* Align to 64-bits. */
 392     /* Followed by struct ofp10_phy_port or struct ofp11_port.  */
 393 };
 394 OFP_ASSERT(sizeof(struct ofp_port_status) == 8);
 395
 396 enum ofp_stats_reply_flags {
 397     OFPSF_REPLY_MORE  = 1 << 0  /* More replies to follow. */
 398 };
 399
 400 #define DESC_STR_LEN   256
 401 #define SERIAL_NUM_LEN 32
 402 /* Body of reply to OFPST_DESC request.  Each entry is a NULL-terminated ASCII
 403  * string. */
 404 struct ofp_desc_stats {
 405     char mfr_desc[DESC_STR_LEN];       /* Manufacturer description. */
 406     char hw_desc[DESC_STR_LEN];        /* Hardware description. */
 407     char sw_desc[DESC_STR_LEN];        /* Software description. */
 408     char serial_num[SERIAL_NUM_LEN];   /* Serial number. */
 409     char dp_desc[DESC_STR_LEN];        /* Human readable description of
 410                                           the datapath. */
 411 };
 412 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 1056);
 413
 414 /* Reply to OFPST_AGGREGATE request. */
 415 struct ofp_aggregate_stats_reply {
 416     ovs_32aligned_be64 packet_count; /* Number of packets in flows. */
 417     ovs_32aligned_be64 byte_count;   /* Number of bytes in flows. */
 418     ovs_be32 flow_count;      /* Number of flows. */
 419     uint8_t pad[4];           /* Align to 64 bits. */
 420 };
 421 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
 422
 423 /* The match type indicates the match structure (set of fields that compose the
 424  * match) in use. The match type is placed in the type field at the beginning
 425  * of all match structures. The "OpenFlow Extensible Match" type corresponds
 426  * to OXM TLV format described below and must be supported by all OpenFlow
 427  * switches. Extensions that define other match types may be published on the
 428  * ONF wiki. Support for extensions is optional.
 429  */
 430 enum ofp_match_type {
 431     OFPMT_STANDARD = 0,         /* The match fields defined in the ofp11_match
 432                                    structure apply */
 433     OFPMT_OXM = 1,              /* OpenFlow Extensible Match */
 434 };
 435
 436 /* Group numbering. Groups can use any number up to OFPG_MAX. */
 437 enum ofp_group {
 438     /* Last usable group number. */
 439     OFPG_MAX        = 0xffffff00,
 440
 441     /* Fake groups. */
 442     OFPG_ALL        = 0xfffffffc,  /* All groups, for group delete commands. */
 443     OFPG_ANY        = 0xffffffff   /* Wildcard, for flow stats requests. */
 444 };
 445
 446 enum ofp_hello_elem_type {
 447     OFPHET_VERSIONBITMAP          = 1, /* Bitmap of version supported. */
 448 };
 449
 450 /* Common header for all Hello Elements */
 451 struct ofp_hello_elem_header {
 452     ovs_be16    type;        /* One of OFPHET_*. */
 453     ovs_be16    length;      /* Length in bytes of this element. */
 454 };
 455 OFP_ASSERT(sizeof(struct ofp_hello_elem_header) == 4);
 456
 457 /* Vendor extension. */
 458 struct ofp_vendor_header {
 459     struct ofp_header header;   /* Type OFPT_VENDOR or OFPT_EXPERIMENTER. */
 460     ovs_be32 vendor;            /* Vendor ID:
 461                                  * - MSB 0: low-order bytes are IEEE OUI.
 462                                  * - MSB != 0: defined by OpenFlow
 463                                  *   consortium. */
 464     /* Vendor-defined arbitrary additional data. */
 465 };
 466 OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12);
 467
 468 #endif /* openflow/openflow-common.h */