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