include/openflow/openflow-common.h

   1 /* Copyright (c) 2008, 2011, 2012, 2013, 2014, 2016 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  * The list is sorted numerically.
 103  */
 104 #define OF_VENDOR_ID    0
 105 #define HPL_VENDOR_ID   0x000004EA /* HP Labs. */
 106 #define NTR_VENDOR_ID   0x0000154d /* Netronome. */
 107 #define NTR_COMPAT_VENDOR_ID   0x00001540 /* Incorrect value used in v2.4. */
 108 #define NX_VENDOR_ID    0x00002320 /* Nicira. */
 109 #define ONF_VENDOR_ID   0x4f4e4600 /* Open Networking Foundation. */
 110
 111 #define OFP_MAX_TABLE_NAME_LEN 32
 112 #define OFP_MAX_PORT_NAME_LEN  16
 113
 114 #define OFP_OLD_PORT  6633
 115 #define OFP_PORT  6653
 116
 117 #define OFP_DEFAULT_MISS_SEND_LEN   128
 118
 119 /* Values below this cutoff are 802.3 packets and the two bytes
 120  * following MAC addresses are used as a frame length.  Otherwise, the
 121  * two bytes are used as the Ethernet type.
 122  */
 123 #define OFP_DL_TYPE_ETH2_CUTOFF   0x0600
 124
 125 /* Value of dl_type to indicate that the frame does not include an
 126  * Ethernet type.
 127  */
 128 #define OFP_DL_TYPE_NOT_ETH_TYPE  0x05ff
 129
 130 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
 131  * is permanent. */
 132 #define OFP_FLOW_PERMANENT 0
 133
 134 /* By default, choose a priority in the middle. */
 135 #define OFP_DEFAULT_PRIORITY 0x8000
 136
 137
 138 /* Header on all OpenFlow packets. */
 139 struct ofp_header {
 140     uint8_t version;    /* An OpenFlow version number, e.g. OFP10_VERSION. */
 141     uint8_t type;       /* One of the OFPT_ constants. */
 142     ovs_be16 length;    /* Length including this ofp_header. */
 143     ovs_be32 xid;       /* Transaction id associated with this packet.
 144                            Replies use the same id as was in the request
 145                            to facilitate pairing. */
 146 };
 147 OFP_ASSERT(sizeof(struct ofp_header) == 8);
 148
 149 /* OFPT_ERROR: Error message (datapath -> controller). */
 150 struct ofp_error_msg {
 151     ovs_be16 type;
 152     ovs_be16 code;
 153     uint8_t data[0];          /* Variable-length data.  Interpreted based
 154                                  on the type and code. */
 155 };
 156 OFP_ASSERT(sizeof(struct ofp_error_msg) == 4);
 157
 158 enum ofp_config_flags {
 159     /* Handling of IP fragments. */
 160     OFPC_FRAG_NORMAL   = 0,  /* No special handling for fragments. */
 161     OFPC_FRAG_DROP     = 1,  /* Drop fragments. */
 162     OFPC_FRAG_REASM    = 2,  /* Reassemble (only if OFPC_IP_REASM set). */
 163     OFPC_FRAG_NX_MATCH = 3,  /* Make first fragments available for matching. */
 164     OFPC_FRAG_MASK     = 3,
 165
 166     /* OFPC_INVALID_TTL_TO_CONTROLLER is deprecated in OpenFlow 1.3 */
 167
 168     /* TTL processing - applicable for IP and MPLS packets. */
 169     OFPC_INVALID_TTL_TO_CONTROLLER = 1 << 2, /* Send packets with invalid TTL
 170                                                 to the controller. */
 171 };
 172
 173 /* Switch configuration. */
 174 struct ofp_switch_config {
 175     ovs_be16 flags;             /* OFPC_* flags. */
 176     ovs_be16 miss_send_len;     /* Max bytes of new flow that datapath should
 177                                    send to the controller. */
 178 };
 179 OFP_ASSERT(sizeof(struct ofp_switch_config) == 4);
 180
 181
 182 /* Common flags to indicate behavior of the physical port.  These flags are
 183  * used in ofp_port to describe the current configuration.  They are used in
 184  * the ofp_port_mod message to configure the port's behavior.
 185  */
 186 enum ofp_port_config {
 187     OFPPC_PORT_DOWN    = 1 << 0,  /* Port is administratively down. */
 188
 189     OFPPC_NO_RECV      = 1 << 2,  /* Drop all packets received by port. */
 190     OFPPC_NO_FWD       = 1 << 5,  /* Drop packets forwarded to port. */
 191     OFPPC_NO_PACKET_IN = 1 << 6   /* Do not send packet-in msgs for port. */
 192 };
 193
 194 /* Common current state of the physical port.  These are not configurable from
 195  * the controller.
 196  */
 197 enum ofp_port_state {
 198     OFPPS_LINK_DOWN    = 1 << 0,  /* No physical link present. */
 199 };
 200
 201 /* Common features of physical ports available in a datapath. */
 202 enum ofp_port_features {
 203     OFPPF_10MB_HD    = 1 << 0,  /* 10 Mb half-duplex rate support. */
 204     OFPPF_10MB_FD    = 1 << 1,  /* 10 Mb full-duplex rate support. */
 205     OFPPF_100MB_HD   = 1 << 2,  /* 100 Mb half-duplex rate support. */
 206     OFPPF_100MB_FD   = 1 << 3,  /* 100 Mb full-duplex rate support. */
 207     OFPPF_1GB_HD     = 1 << 4,  /* 1 Gb half-duplex rate support. */
 208     OFPPF_1GB_FD     = 1 << 5,  /* 1 Gb full-duplex rate support. */
 209     OFPPF_10GB_FD    = 1 << 6,  /* 10 Gb full-duplex rate support. */
 210 };
 211
 212 /* Generic OpenFlow property header, as used by various messages in OF1.3+, and
 213  * especially in OF1.4.
 214  *
 215  * The OpenFlow specs prefer to define a new structure with a specialized name
 216  * each time this property structure comes up: struct
 217  * ofp_port_desc_prop_header, struct ofp_controller_status_prop_header, struct
 218  * ofp_table_mod_prop_header, and more.  They're all the same, so it's easier
 219  * to unify them.
 220  */
 221 struct ofp_prop_header {
 222     ovs_be16 type;
 223     ovs_be16 len;
 224 };
 225 OFP_ASSERT(sizeof(struct ofp_prop_header) == 4);
 226
 227 /* Generic OpenFlow experimenter property header.
 228  *
 229  * Again the OpenFlow specs define this over and over again and it's easier to
 230  * unify them. */
 231 struct ofp_prop_experimenter {
 232     ovs_be16 type;          /* Generally 0xffff (in one case 0xfffe). */
 233     ovs_be16 len;           /* Length in bytes of this property. */
 234     ovs_be32 experimenter;  /* Experimenter ID which takes the same form as
 235                              * in struct ofp_experimenter_header. */
 236     ovs_be32 exp_type;      /* Experimenter defined. */
 237 };
 238 OFP_ASSERT(sizeof(struct ofp_prop_experimenter) == 12);
 239
 240 /* Switch features. */
 241 struct ofp_switch_features {
 242     ovs_be64 datapath_id;   /* Datapath unique ID.  The lower 48-bits are for
 243                                a MAC address, while the upper 16-bits are
 244                                implementer-defined. */
 245
 246     ovs_be32 n_buffers;     /* Max packets buffered at once. */
 247
 248     uint8_t n_tables;       /* Number of tables supported by datapath. */
 249     uint8_t auxiliary_id;   /* OF 1.3: Identify auxiliary connections */
 250     uint8_t pad[2];         /* Align to 64-bits. */
 251
 252     /* Features. */
 253     ovs_be32 capabilities;  /* OFPC_*, OFPC10_*, OFPC11_*, OFPC12_*. */
 254     ovs_be32 actions;       /* Bitmap of supported "ofp_action_type"s.
 255                              * DEPRECATED in OpenFlow 1.1 */
 256
 257     /* Followed by an array of struct ofp10_phy_port or struct ofp11_port
 258      * structures.  The number is inferred from header.length.
 259      * REMOVED in OpenFlow 1.3 */
 260 };
 261 OFP_ASSERT(sizeof(struct ofp_switch_features) == 24);
 262
 263 /* Common capabilities supported by the datapath (struct ofp_switch_features,
 264  * member capabilities). */
 265 enum ofp_capabilities {
 266     OFPC_FLOW_STATS     = 1 << 0,  /* Flow statistics. */
 267     OFPC_TABLE_STATS    = 1 << 1,  /* Table statistics. */
 268     OFPC_PORT_STATS     = 1 << 2,  /* Port statistics. */
 269     OFPC_IP_REASM       = 1 << 5,  /* Can reassemble IP fragments. */
 270     OFPC_QUEUE_STATS    = 1 << 6,  /* Queue statistics. */
 271     OFPC_ARP_MATCH_IP   = 1 << 7   /* Match IP addresses in ARP
 272                                       pkts. */
 273 };
 274
 275 /* Why is this packet being sent to the controller? */
 276 enum ofp_packet_in_reason {
 277     OFPR_NO_MATCH,          /* No matching flow. */
 278     OFPR_ACTION,            /* Action explicitly output to controller. */
 279     OFPR_INVALID_TTL,       /* Packet has invalid TTL. */
 280     OFPR_ACTION_SET,        /* Output to controller in action set */
 281     OFPR_GROUP,             /* Output to controller in group bucket */
 282     OFPR_PACKET_OUT,        /* Output to controller in packet-out */
 283
 284 #define OFPR10_BITS                                                     \
 285     ((1u << OFPR_NO_MATCH) | (1u << OFPR_ACTION) | (1u << OFPR_INVALID_TTL))
 286 #define OFPR14_BITS                                                     \
 287     (OFPR10_BITS |                                                      \
 288      (1u << OFPR_ACTION_SET) | (1u << OFPR_GROUP) | (1u << OFPR_PACKET_OUT))
 289
 290     OFPR_N_REASONS
 291 };
 292
 293 enum ofp_flow_mod_command {
 294     OFPFC_ADD,              /* New flow. */
 295     OFPFC_MODIFY,           /* Modify all matching flows. */
 296     OFPFC_MODIFY_STRICT,    /* Modify entry strictly matching wildcards */
 297     OFPFC_DELETE,           /* Delete all matching flows. */
 298     OFPFC_DELETE_STRICT     /* Strictly match wildcards and priority. */
 299 };
 300
 301 enum ofp_flow_mod_flags {
 302     OFPFF_SEND_FLOW_REM = 1 << 0,  /* Send flow removed message when flow
 303                                     * expires or is deleted. */
 304     OFPFF_CHECK_OVERLAP = 1 << 1,  /* Check for overlapping entries first. */
 305 };
 306
 307 /* Why was this flow removed? */
 308 enum ofp_flow_removed_reason {
 309     OFPRR_IDLE_TIMEOUT,         /* Flow idle time exceeded idle_timeout. */
 310     OFPRR_HARD_TIMEOUT,         /* Time exceeded hard_timeout. */
 311     OFPRR_DELETE,               /* Evicted by a DELETE flow mod. */
 312     OFPRR_GROUP_DELETE,         /* Group was removed. */
 313     OFPRR_METER_DELETE,         /* Meter was removed. */
 314     OFPRR_EVICTION,             /* Switch eviction to free resources. */
 315
 316 #define OFPRR10_BITS                            \
 317     ((1u << OFPRR_IDLE_TIMEOUT) |               \
 318      (1u << OFPRR_HARD_TIMEOUT) |               \
 319      (1u << OFPRR_DELETE))
 320 #define OFPRR14_BITS                            \
 321     (OFPRR10_BITS |                             \
 322      (1u << OFPRR_GROUP_DELETE) |               \
 323      (1u << OFPRR_METER_DELETE) |               \
 324      (1u << OFPRR_EVICTION))
 325
 326     OVS_OFPRR_NONE              /* OVS internal_use only, keep last!. */
 327 };
 328
 329 /* What changed about the physical port */
 330 enum ofp_port_reason {
 331     OFPPR_ADD,              /* The port was added. */
 332     OFPPR_DELETE,           /* The port was removed. */
 333     OFPPR_MODIFY,           /* Some attribute of the port has changed. */
 334
 335 #define OFPPR_BITS ((1u << OFPPR_ADD) |         \
 336                     (1u << OFPPR_DELETE) |      \
 337                     (1u << OFPPR_MODIFY))
 338
 339     OFPPR_N_REASONS         /* Denotes number of reasons. */
 340 };
 341
 342 /* A physical port has changed in the datapath */
 343 struct ofp_port_status {
 344     uint8_t reason;          /* One of OFPPR_*. */
 345     uint8_t pad[7];          /* Align to 64-bits. */
 346     /* Followed by struct ofp10_phy_port, struct ofp11_port, or struct
 347      * ofp14_port.  */
 348 };
 349 OFP_ASSERT(sizeof(struct ofp_port_status) == 8);
 350
 351 enum ofp_stats_reply_flags {
 352     OFPSF_REPLY_MORE  = 1 << 0  /* More replies to follow. */
 353 };
 354
 355 #define DESC_STR_LEN   256
 356 #define SERIAL_NUM_LEN 32
 357 /* Body of reply to OFPST_DESC request.  Each entry is a NULL-terminated ASCII
 358  * string. */
 359 struct ofp_desc_stats {
 360     char mfr_desc[DESC_STR_LEN];       /* Manufacturer description. */
 361     char hw_desc[DESC_STR_LEN];        /* Hardware description. */
 362     char sw_desc[DESC_STR_LEN];        /* Software description. */
 363     char serial_num[SERIAL_NUM_LEN];   /* Serial number. */
 364     char dp_desc[DESC_STR_LEN];        /* Human readable description of
 365                                           the datapath. */
 366 };
 367 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 1056);
 368
 369 /* Reply to OFPST_AGGREGATE request. */
 370 struct ofp_aggregate_stats_reply {
 371     ovs_32aligned_be64 packet_count; /* Number of packets in flows. */
 372     ovs_32aligned_be64 byte_count;   /* Number of bytes in flows. */
 373     ovs_be32 flow_count;      /* Number of flows. */
 374     uint8_t pad[4];           /* Align to 64 bits. */
 375 };
 376 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
 377
 378 /* The match type indicates the match structure (set of fields that compose the
 379  * match) in use. The match type is placed in the type field at the beginning
 380  * of all match structures. The "OpenFlow Extensible Match" type corresponds
 381  * to OXM TLV format described below and must be supported by all OpenFlow
 382  * switches. Extensions that define other match types may be published on the
 383  * ONF wiki. Support for extensions is optional.
 384  */
 385 enum ofp_match_type {
 386     OFPMT_STANDARD = 0,         /* The match fields defined in the ofp11_match
 387                                    structure apply */
 388     OFPMT_OXM = 1,              /* OpenFlow Extensible Match */
 389 };
 390
 391 /* Group numbering. Groups can use any number up to OFPG_MAX. */
 392 enum ofp_group {
 393     /* Last usable group number. */
 394     OFPG_MAX        = 0xffffff00,
 395
 396     /* Fake groups. */
 397     OFPG_ALL        = 0xfffffffc,  /* All groups, for group delete commands. */
 398     OFPG_ANY        = 0xffffffff   /* Wildcard, for flow stats requests. */
 399 };
 400
 401 /* Group configuration flags */
 402 enum ofp_group_capabilities {
 403     OFPGFC_SELECT_WEIGHT   = 1 << 0, /* Support weight for select groups */
 404     OFPGFC_SELECT_LIVENESS = 1 << 1, /* Support liveness for select groups */
 405     OFPGFC_CHAINING        = 1 << 2, /* Support chaining groups */
 406     OFPGFC_CHAINING_CHECKS = 1 << 3, /* Check chaining for loops and delete */
 407 };
 408
 409 enum ofp_hello_elem_type {
 410     OFPHET_VERSIONBITMAP          = 1, /* Bitmap of version supported. */
 411 };
 412
 413 /* Common header for all Hello Elements */
 414 struct ofp_hello_elem_header {
 415     ovs_be16    type;        /* One of OFPHET_*. */
 416     ovs_be16    length;      /* Length in bytes of this element. */
 417 };
 418 OFP_ASSERT(sizeof(struct ofp_hello_elem_header) == 4);
 419
 420 /* Vendor extension. */
 421 struct ofp_vendor_header {
 422     struct ofp_header header;   /* Type OFPT_VENDOR or OFPT_EXPERIMENTER. */
 423     ovs_be32 vendor;            /* Vendor ID:
 424                                  * - MSB 0: low-order bytes are IEEE OUI.
 425                                  * - MSB != 0: defined by OpenFlow
 426                                  *   consortium. */
 427     /* Vendor-defined arbitrary additional data. */
 428 };
 429 OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12);
 430
 431 /* Table numbering. Tables can use any number up to OFPT_MAX. */
 432 enum ofp_table {
 433     /* Last usable table number. */
 434     OFPTT_MAX = 0xfe,
 435
 436     /* Fake tables. */
 437     OFPTT_ALL = 0xff         /* Wildcard table used for table config,
 438                                 flow stats and flow deletes. */
 439 };
 440
 441 enum ofp_table_config {
 442     /* OpenFlow 1.1 and 1.2 defined this field as shown.
 443      * OpenFlow 1.3 and later mark this field as deprecated, but have not
 444      * reused it for any new purpose. */
 445     OFPTC11_TABLE_MISS_CONTROLLER = 0 << 0, /* Send to controller. */
 446     OFPTC11_TABLE_MISS_CONTINUE   = 1 << 0, /* Go to next table, like OF1.0. */
 447     OFPTC11_TABLE_MISS_DROP       = 2 << 0, /* Drop the packet. */
 448     OFPTC11_TABLE_MISS_MASK       = 3 << 0,
 449
 450     /* OpenFlow 1.4. */
 451     OFPTC14_EVICTION              = 1 << 2, /* Allow table to evict flows. */
 452     OFPTC14_VACANCY_EVENTS        = 1 << 3, /* Enable vacancy events. */
 453 };
 454
 455 #endif /* openflow/openflow-common.h */