include/openflow.h

   1 /* Copyright (c) 2008 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 /* OpenFlow: protocol between controller and datapath. */
  35
  36 #ifndef OPENFLOW_H
  37 #define OPENFLOW_H 1
  38
  39 #ifdef __KERNEL__
  40 #include <linux/types.h>
  41 #else
  42 #include <stdint.h>
  43 #endif
  44
  45 #ifdef SWIG
  46 #define OFP_ASSERT(EXPR)        /* SWIG can't handle OFP_ASSERT. */
  47 #elif !defined(__cplusplus)
  48 /* Build-time assertion for use in a declaration context. */
  49 #define OFP_ASSERT(EXPR)                                                \
  50         extern int (*build_assert(void))[ sizeof(struct {               \
  51                     unsigned int build_assert_failed : (EXPR) ? 1 : -1; })]
  52 #else /* __cplusplus */
  53 #include <boost/static_assert.hpp>
  54 #define OFP_ASSERT BOOST_STATIC_ASSERT
  55 #endif /* __cplusplus */
  56
  57 #ifndef SWIG
  58 #define OFP_PACKED __attribute__((packed))
  59 #else
  60 #define OFP_PACKED              /* SWIG doesn't understand __attribute. */
  61 #endif
  62
  63 /* The most significant bit being set in the version field indicates an
  64  * experimental OpenFlow version.
  65  */
  66 #define OFP_VERSION   0x95
  67
  68 #define OFP_MAX_TABLE_NAME_LEN 32
  69 #define OFP_MAX_PORT_NAME_LEN  16
  70
  71 #define OFP_TCP_PORT  975
  72 #define OFP_SSL_PORT  976
  73
  74 #define OFP_ETH_ALEN 6          /* Bytes in an Ethernet address. */
  75
  76 /* Port numbering.  Physical ports are numbered starting from 0. */
  77 enum ofp_port {
  78     /* Maximum number of physical switch ports. */
  79     OFPP_MAX = 255,
  80
  81     /* Fake output "ports". */
  82     OFPP_IN_PORT    = 0xfff8,  /* Send the packet out the input port.  This
  83                                   virtual port must be explicitly used
  84                                   in order to send back out of the input
  85                                   port. */
  86     OFPP_TABLE      = 0xfff9,  /* Perform actions in flow table.
  87                                   NB: This can only be the destination
  88                                   port for packet-out messages. */
  89     OFPP_NORMAL     = 0xfffa,  /* Process with normal L2/L3 switching. */
  90     OFPP_FLOOD      = 0xfffb,  /* All physical ports except input port and
  91                                   those disabled by STP. */
  92     OFPP_ALL        = 0xfffc,  /* All physical ports except input port. */
  93     OFPP_CONTROLLER = 0xfffd,  /* Send to controller. */
  94     OFPP_LOCAL      = 0xfffe,  /* Local openflow "port". */
  95     OFPP_NONE       = 0xffff   /* Not associated with a physical port. */
  96 };
  97
  98 enum ofp_type {
  99     /* Immutable messages. */
 100     OFPT_HELLO,               /* Symmetric message */
 101     OFPT_ERROR,               /* Symmetric message */
 102     OFPT_ECHO_REQUEST,        /* Symmetric message */
 103     OFPT_ECHO_REPLY,          /* Symmetric message */
 104     OFPT_VENDOR,              /* Symmetric message */
 105
 106     /* Switch configuration messages. */
 107     OFPT_FEATURES_REQUEST,    /* Controller/switch message */
 108     OFPT_FEATURES_REPLY,      /* Controller/switch message */
 109     OFPT_GET_CONFIG_REQUEST,  /* Controller/switch message */
 110     OFPT_GET_CONFIG_REPLY,    /* Controller/switch message */
 111     OFPT_SET_CONFIG,          /* Controller/switch message */
 112
 113     /* Asynchronous messages. */
 114     OFPT_PACKET_IN,           /* Async message */
 115     OFPT_FLOW_EXPIRED,        /* Async message */
 116     OFPT_PORT_STATUS,         /* Async message */
 117
 118     /* Controller command messages. */
 119     OFPT_PACKET_OUT,          /* Controller/switch message */
 120     OFPT_FLOW_MOD,            /* Controller/switch message */
 121     OFPT_PORT_MOD,            /* Controller/switch message */
 122     OFPT_TABLE,               /* Controller/switch message */
 123
 124     /* Statistics messages. */
 125     OFPT_STATS_REQUEST,       /* Controller/switch message */
 126     OFPT_STATS_REPLY          /* Controller/switch message */
 127 };
 128
 129 /* Header on all OpenFlow packets. */
 130 struct ofp_header {
 131     uint8_t version;    /* OFP_VERSION. */
 132     uint8_t type;       /* One of the OFPT_ constants. */
 133     uint16_t length;    /* Length including this ofp_header. */
 134     uint32_t xid;       /* Transactin id associated with this packet.
 135                            Replies use the same id as was in the request
 136                            to facilitate pairing. */
 137 };
 138 OFP_ASSERT(sizeof(struct ofp_header) == 8);
 139
 140 /* OFPT_HELLO.  This message has an empty body, but implementations must
 141  * ignore any data included in the body, to allow for future extensions. */
 142 struct ofp_hello {
 143     struct ofp_header header;
 144 };
 145
 146 #define OFP_DEFAULT_MISS_SEND_LEN   128
 147
 148 enum ofp_config_flags {
 149     /* Tells datapath to notify the controller of expired flow entries. */
 150     OFPC_SEND_FLOW_EXP = 1 << 0,
 151
 152     /* Handling of IP fragments. */
 153     OFPC_FRAG_NORMAL   = 0 << 1,  /* No special handling for fragments. */
 154     OFPC_FRAG_DROP     = 1 << 1,    /* Drop fragments. */
 155     OFPC_FRAG_REASM    = 2 << 1,   /* Reassemble (only if OFPC_IP_REASM set). */
 156     OFPC_FRAG_MASK     = 3 << 1
 157 };
 158
 159 /* Switch configuration. */
 160 struct ofp_switch_config {
 161     struct ofp_header header;
 162     uint16_t flags;             /* OFPC_* flags. */
 163     uint16_t miss_send_len;     /* Max bytes of new flow that datapath should
 164                                    send to the controller. */
 165 };
 166 OFP_ASSERT(sizeof(struct ofp_switch_config) == 12);
 167
 168 /* Capabilities supported by the datapath. */
 169 enum ofp_capabilities {
 170     OFPC_FLOW_STATS     = 1 << 0,  /* Flow statistics. */
 171     OFPC_TABLE_STATS    = 1 << 1,  /* Table statistics. */
 172     OFPC_PORT_STATS     = 1 << 2,  /* Port statistics. */
 173     OFPC_STP            = 1 << 3,  /* 802.1d spanning tree. */
 174     OFPC_MULTI_PHY_TX   = 1 << 4,  /* Supports transmitting through multiple
 175                                       physical interfaces */
 176     OFPC_IP_REASM       = 1 << 5   /* Can reassemble IP fragments. */
 177 };
 178
 179 /* Flags to indicate behavior of the physical port.  These flags are
 180  * used in ofp_phy_port to describe the current configuration.  They are
 181  * used in 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_STP       = 1 << 1,  /* Disable 802.1D spanning tree on port. */
 187     OFPPC_NO_RECV      = 1 << 2,  /* Drop most packets received on port. */
 188     OFPPC_NO_RECV_STP  = 1 << 3,  /* Drop received 802.1D STP packets. */
 189     OFPPC_NO_FLOOD     = 1 << 4,  /* Do not include this port when flooding. */
 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 /* 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     /* The OFPPS_STP_* bits have no effect on switch operation.  The
 201      * controller must adjust OFPPC_NO_RECV, OFPPC_NO_FWD, and
 202      * OFPPC_NO_PACKET_IN appropriately to fully implement an 802.1D spanning
 203      * tree. */
 204     OFPPS_STP_LISTEN  = 0 << 8, /* Not learning or relaying frames. */
 205     OFPPS_STP_LEARN   = 1 << 8, /* Learning but not relaying frames. */
 206     OFPPS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
 207     OFPPS_STP_BLOCK   = 3 << 8, /* Not part of spanning tree. */
 208     OFPPS_STP_MASK    = 3 << 8  /* Bit mask for OFPPS_STP_* values. */
 209 };
 210
 211 /* Features of physical ports available in a datapath. */
 212 enum ofp_port_features {
 213     OFPPF_10MB_HD    = 1 << 0,  /* 10 Mb half-duplex rate support. */
 214     OFPPF_10MB_FD    = 1 << 1,  /* 10 Mb full-duplex rate support. */
 215     OFPPF_100MB_HD   = 1 << 2,  /* 100 Mb half-duplex rate support. */
 216     OFPPF_100MB_FD   = 1 << 3,  /* 100 Mb full-duplex rate support. */
 217     OFPPF_1GB_HD     = 1 << 4,  /* 1 Gb half-duplex rate support. */
 218     OFPPF_1GB_FD     = 1 << 5,  /* 1 Gb full-duplex rate support. */
 219     OFPPF_10GB_FD    = 1 << 6,  /* 10 Gb full-duplex rate support. */
 220     OFPPF_COPPER     = 1 << 7,  /* Copper medium */
 221     OFPPF_FIBER      = 1 << 8,  /* Fiber medium */
 222     OFPPF_AUTONEG    = 1 << 9,  /* Auto-negotiation */
 223     OFPPF_PAUSE      = 1 << 10, /* Pause */
 224     OFPPF_PAUSE_ASYM = 1 << 11  /* Asymmetric pause */
 225 };
 226
 227 /* Description of a physical port */
 228 struct ofp_phy_port {
 229     uint16_t port_no;
 230     uint8_t hw_addr[OFP_ETH_ALEN];
 231     uint8_t name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
 232
 233     uint32_t config;        /* Bitmap of OFPPC_* flags. */
 234     uint32_t state;         /* Bitmap of OFPPS_* flags. */
 235
 236     /* Bitmaps of OFPPF_* that describe features.  All bits zeroed if
 237      * unsupported or unavailable. */
 238     uint32_t curr;          /* Current features. */
 239     uint32_t advertised;    /* Features being advertised by the port. */
 240     uint32_t supported;     /* Features supported by the port. */
 241     uint32_t peer;          /* Features advertised by peer. */
 242 };
 243 OFP_ASSERT(sizeof(struct ofp_phy_port) == 48);
 244
 245 /* Switch features. */
 246 struct ofp_switch_features {
 247     struct ofp_header header;
 248     uint64_t datapath_id;   /* Datapath unique ID.  Only the lower 48-bits
 249                                are meaningful. */
 250
 251     uint32_t n_buffers;     /* Max packets buffered at once. */
 252
 253     uint8_t n_tables;       /* Number of tables supported by datapath. */
 254     uint8_t pad[3];         /* Align to 64-bits. */
 255
 256     /* Features. */
 257     uint32_t capabilities;  /* Bitmap of support "ofp_capabilities". */
 258     uint32_t actions;       /* Bitmap of supported "ofp_action_type"s. */
 259
 260     /* Port info.*/
 261     struct ofp_phy_port ports[0];  /* Port definitions.  The number of ports
 262                                       is inferred from the length field in
 263                                       the header. */
 264 };
 265 OFP_ASSERT(sizeof(struct ofp_switch_features) == 32);
 266
 267 /* What changed about the physical port */
 268 enum ofp_port_reason {
 269     OFPPR_ADD,              /* The port was added */
 270     OFPPR_DELETE,           /* The port was removed */
 271     OFPPR_MODIFY            /* Some attribute of the port has changed */
 272 };
 273
 274 /* A physical port has changed in the datapath */
 275 struct ofp_port_status {
 276     struct ofp_header header;
 277     uint8_t reason;          /* One of OFPPR_* */
 278     uint8_t pad[7];          /* Align to 64-bits */
 279     struct ofp_phy_port desc;
 280 };
 281 OFP_ASSERT(sizeof(struct ofp_port_status) == 64);
 282
 283 /* Modify behavior of the physical port */
 284 struct ofp_port_mod {
 285     struct ofp_header header;
 286     uint16_t port_no;
 287     uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
 288                                       configurable.  This is used to
 289                                       sanity-check the request, so it must
 290                                       be the same as returned in an
 291                                       ofp_phy_port struct. */
 292
 293     uint32_t config;        /* Bitmap of OFPPC_* flags. */
 294     uint32_t mask;          /* Bitmap of OFPPC_* flags to be changed. */
 295
 296     uint32_t advertise;     /* Bitmap of "ofp_port_features"s.  Zero all
 297                                bits to prevent any action taking place. */
 298     uint8_t pad[4];         /* Pad to 64-bits. */
 299 };
 300 OFP_ASSERT(sizeof(struct ofp_port_mod) == 32);
 301
 302 /* Why is this packet being sent to the controller? */
 303 enum ofp_packet_in_reason {
 304     OFPR_NO_MATCH,          /* No matching flow. */
 305     OFPR_ACTION             /* Action explicitly output to controller. */
 306 };
 307
 308 /* Packet received on port (datapath -> controller). */
 309 struct ofp_packet_in {
 310     struct ofp_header header;
 311     uint32_t buffer_id;     /* ID assigned by datapath. */
 312     uint16_t total_len;     /* Full length of frame. */
 313     uint16_t in_port;       /* Port on which frame was received. */
 314     uint8_t reason;         /* Reason packet is being sent (one of OFPR_*) */
 315     uint8_t pad;
 316     uint8_t data[0];        /* Ethernet frame, halfway through 32-bit word,
 317                                so the IP header is 32-bit aligned.  The
 318                                amount of data is inferred from the length
 319                                field in the header.  Because of padding,
 320                                offsetof(struct ofp_packet_in, data) ==
 321                                sizeof(struct ofp_packet_in) - 2. */
 322 };
 323 OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
 324
 325 enum ofp_action_type {
 326     OFPAT_OUTPUT,           /* Output to switch port. */
 327     OFPAT_SET_VLAN_VID,     /* Set the 802.1q VLAN id. */
 328     OFPAT_SET_VLAN_PCP,     /* Set the 802.1q priority. */
 329     OFPAT_STRIP_VLAN,       /* Strip the 802.1q header. */
 330     OFPAT_SET_DL_SRC,       /* Ethernet source address. */
 331     OFPAT_SET_DL_DST,       /* Ethernet destination address. */
 332     OFPAT_SET_NW_SRC,       /* IP source address. */
 333     OFPAT_SET_NW_DST,       /* IP destination address. */
 334     OFPAT_SET_TP_SRC,       /* TCP/UDP source port. */
 335     OFPAT_SET_TP_DST,       /* TCP/UDP destination port. */
 336     OFPAT_VENDOR = 0xffff
 337 };
 338
 339 /* Action structure for OFPAT_OUTPUT, which sends packets out 'port'.
 340  * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
 341  * number of bytes to send.  A 'max_len' of zero means the entire packet
 342  * should be sent. */
 343 struct ofp_action_output {
 344     uint16_t type;                  /* OFPAT_OUTPUT. */
 345     uint16_t len;                   /* Length is 8. */
 346     uint16_t port;                  /* Ouptut port. */
 347     uint16_t max_len;               /* Max length to send to controller. */
 348 };
 349 OFP_ASSERT(sizeof(struct ofp_action_output) == 8);
 350
 351 /* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate
 352  * special conditions.  All ones is used to match that no VLAN id was
 353  * set. */
 354 #define OFP_VLAN_NONE      0xffff
 355
 356 /* Action structure for OFPAT_SET_VLAN_VID. */
 357 struct ofp_action_vlan_vid {
 358     uint16_t type;                  /* OFPAT_SET_VLAN_VID. */
 359     uint16_t len;                   /* Length is 8. */
 360     uint16_t vlan_vid;              /* VLAN id. */
 361     uint8_t pad[2];
 362 };
 363 OFP_ASSERT(sizeof(struct ofp_action_vlan_vid) == 8);
 364
 365 /* Action structure for OFPAT_SET_VLAN_PCP. */
 366 struct ofp_action_vlan_pcp {
 367     uint16_t type;                  /* OFPAT_SET_VLAN_PCP. */
 368     uint16_t len;                   /* Length is 8. */
 369     uint8_t vlan_pcp;               /* VLAN priority. */
 370     uint8_t pad[3];
 371 };
 372 OFP_ASSERT(sizeof(struct ofp_action_vlan_vid) == 8);
 373
 374 /* Action structure for OFPAT_SET_DL_SRC/DST. */
 375 struct ofp_action_dl_addr {
 376     uint16_t type;                  /* OFPAT_SET_DL_SRC/DST. */
 377     uint16_t len;                   /* Length is 16. */
 378     uint8_t dl_addr[OFP_ETH_ALEN];  /* Ethernet address. */
 379     uint8_t pad[6];
 380 };
 381 OFP_ASSERT(sizeof(struct ofp_action_dl_addr) == 16);
 382
 383 /* Action structure for OFPAT_SET_NW_SRC/DST. */
 384 struct ofp_action_nw_addr {
 385     uint16_t type;                  /* OFPAT_SET_TW_SRC/DST. */
 386     uint16_t len;                   /* Length is 8. */
 387     uint32_t nw_addr;               /* IP address. */
 388 };
 389 OFP_ASSERT(sizeof(struct ofp_action_nw_addr) == 8);
 390
 391 /* Action structure for OFPAT_SET_TP_SRC/DST. */
 392 struct ofp_action_tp_port {
 393     uint16_t type;                  /* OFPAT_SET_TP_SRC/DST. */
 394     uint16_t len;                   /* Length is 8. */
 395     uint16_t tp_port;               /* TCP/UDP port. */
 396     uint8_t pad[2];
 397 };
 398 OFP_ASSERT(sizeof(struct ofp_action_tp_port) == 8);
 399
 400 /* Action header for OFPAT_VENDOR. The rest of the body is vendor-defined. */
 401 struct ofp_action_vendor_header {
 402     uint16_t type;                  /* OFPAT_VENDOR. */
 403     uint16_t len;                   /* Length is 8. */
 404     uint32_t vendor;                /* Vendor ID, which takes the same form
 405                                        as in "struct ofp_vendor". */
 406 };
 407 OFP_ASSERT(sizeof(struct ofp_action_vendor_header) == 8);
 408
 409 /* Action header that is common to all actions.  The length includes the
 410  * header and any padding used to make the action 64-bit aligned.
 411  * NB: The length of an action *must* always be a multiple of eight. */
 412 struct ofp_action_header {
 413     uint16_t type;                  /* One of OFPAT_*. */
 414     uint16_t len;                   /* Length of action, including this
 415                                        header.  This is the length of action,
 416                                        including any padding to make it
 417                                        64-bit aligned. */
 418     uint8_t pad[4];
 419 };
 420 OFP_ASSERT(sizeof(struct ofp_action_header) == 8);
 421
 422 /* Send packet (controller -> datapath). */
 423 struct ofp_packet_out {
 424     struct ofp_header header;
 425     uint32_t buffer_id;           /* ID assigned by datapath (-1 if none). */
 426     uint16_t in_port;             /* Packet's input port (OFPP_NONE if none). */
 427     uint16_t actions_len;          /* Size of action array in bytes. */
 428     struct ofp_action_header actions[0]; /* Actions. */
 429     /* uint8_t data[0]; */        /* Packet data.  The length is inferred
 430                                      from the length field in the header.
 431                                      (Only meaningful if buffer_id == -1.) */
 432 };
 433 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
 434
 435 enum ofp_flow_mod_command {
 436     OFPFC_ADD,              /* New flow. */
 437     OFPFC_MODIFY,           /* Modify all matching flows. */
 438     OFPFC_MODIFY_STRICT,    /* Modify entry strictly matching wildcards */
 439     OFPFC_DELETE,           /* Delete all matching flows. */
 440     OFPFC_DELETE_STRICT     /* Strictly match wildcards and priority. */
 441 };
 442
 443 /* Flow wildcards. */
 444 enum ofp_flow_wildcards {
 445     OFPFW_IN_PORT  = 1 << 0,  /* Switch input port. */
 446     OFPFW_DL_VLAN  = 1 << 1,  /* VLAN. */
 447     OFPFW_DL_SRC   = 1 << 2,  /* Ethernet source address. */
 448     OFPFW_DL_DST   = 1 << 3,  /* Ethernet destination address. */
 449     OFPFW_DL_TYPE  = 1 << 4,  /* Ethernet frame type. */
 450     OFPFW_NW_PROTO = 1 << 5,  /* IP protocol. */
 451     OFPFW_TP_SRC   = 1 << 6,  /* TCP/UDP source port. */
 452     OFPFW_TP_DST   = 1 << 7,  /* TCP/UDP destination port. */
 453
 454     /* IP source address wildcard bit count.  0 is exact match, 1 ignores the
 455      * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
 456      * the entire field.  This is the *opposite* of the usual convention where
 457      * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
 458     OFPFW_NW_SRC_SHIFT = 8,
 459     OFPFW_NW_SRC_BITS = 6,
 460     OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
 461     OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
 462
 463     /* IP destination address wildcard bit count.  Same format as source. */
 464     OFPFW_NW_DST_SHIFT = 14,
 465     OFPFW_NW_DST_BITS = 6,
 466     OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
 467     OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
 468
 469     /* Wildcard all fields. */
 470     OFPFW_ALL = ((1 << 20) - 1)
 471 };
 472
 473 /* Values below this cutoff are 802.3 packets and the two bytes
 474  * following MAC addresses are used as a frame length.  Otherwise, the
 475  * two bytes are used as the Ethernet type.
 476  */
 477 #define OFP_DL_TYPE_ETH2_CUTOFF   0x0600
 478
 479 /* Value of dl_type to indicate that the frame does not include an
 480  * Ethernet type.
 481  */
 482 #define OFP_DL_TYPE_NOT_ETH_TYPE  0x05ff
 483
 484 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
 485  * special conditions.  All ones indicates that no VLAN id was set.
 486  */
 487 #define OFP_VLAN_NONE      0xffff
 488
 489 /* Fields to match against flows */
 490 struct ofp_match {
 491     uint32_t wildcards;        /* Wildcard fields. */
 492     uint16_t in_port;          /* Input switch port. */
 493     uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
 494     uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
 495     uint16_t dl_vlan;          /* Input VLAN. */
 496     uint16_t dl_type;          /* Ethernet frame type. */
 497     uint8_t nw_proto;          /* IP protocol. */
 498     uint8_t pad;               /* Align to 32-bits. */
 499     uint32_t nw_src;           /* IP source address. */
 500     uint32_t nw_dst;           /* IP destination address. */
 501     uint16_t tp_src;           /* TCP/UDP source port. */
 502     uint16_t tp_dst;           /* TCP/UDP destination port. */
 503 };
 504 OFP_ASSERT(sizeof(struct ofp_match) == 36);
 505
 506 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
 507  * is permanent. */
 508 #define OFP_FLOW_PERMANENT 0
 509
 510 /* By default, choose a priority in the middle */
 511 #define OFP_DEFAULT_PRIORITY 0x8000
 512
 513 /* Flow setup and teardown (controller -> datapath). */
 514 struct ofp_flow_mod {
 515     struct ofp_header header;
 516     struct ofp_match match;      /* Fields to match */
 517
 518     /* Flow actions. */
 519     uint16_t command;             /* One of OFPFC_*. */
 520     uint16_t idle_timeout;        /* Idle time before discarding (seconds). */
 521     uint16_t hard_timeout;        /* Max time before discarding (seconds). */
 522     uint16_t priority;            /* Priority level of flow entry. */
 523     uint32_t buffer_id;           /* Buffered packet to apply to (or -1).
 524                                      Not meaningful for OFPFC_DELETE*. */
 525     uint32_t reserved;            /* Reserved for future use. */
 526     struct ofp_action_header actions[0]; /* The action length is inferred
 527                                             from the length field in the
 528                                             header. */
 529 };
 530 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 60);
 531
 532 /* Why did this flow expire? */
 533 enum ofp_flow_expired_reason {
 534     OFPER_IDLE_TIMEOUT,         /* Flow idle time exceeded idle_timeout. */
 535     OFPER_HARD_TIMEOUT          /* Time exceeded hard_timeout. */
 536 };
 537
 538 /* Flow expiration (datapath -> controller). */
 539 struct ofp_flow_expired {
 540     struct ofp_header header;
 541     struct ofp_match match;   /* Description of fields */
 542
 543     uint16_t priority;        /* Priority level of flow entry. */
 544     uint8_t reason;           /* One of OFPER_*. */
 545     uint8_t pad[1];           /* Align to 32-bits. */
 546
 547     uint32_t duration;        /* Time flow was alive in seconds. */
 548     uint8_t pad2[4];          /* Align to 64-bits. */
 549     uint64_t packet_count;
 550     uint64_t byte_count;
 551 };
 552 OFP_ASSERT(sizeof(struct ofp_flow_expired) == 72);
 553
 554 /* Values for 'type' in ofp_error_message.  These values are immutable: they
 555  * will not change in future versions of the protocol (although new values may
 556  * be added). */
 557 enum ofp_error_type {
 558     OFPET_HELLO_FAILED,         /* Hello protocol failed. */
 559     OFPET_BAD_REQUEST,          /* Request was not understood. */
 560     OFPET_BAD_ACTION            /* Error in action description. */
 561 };
 562
 563 /* ofp_error_msg 'code' values for OFPET_HELLO_FAILED.  'data' contains an
 564  * ASCII text string that may give failure details. */
 565 enum ofp_hello_failed_code {
 566     OFPHFC_INCOMPATIBLE         /* No compatible version. */
 567 };
 568
 569 /* ofp_error_msg 'code' values for OFPET_BAD_REQUEST.  'data' contains at least
 570  * the first 64 bytes of the failed request. */
 571 enum ofp_bad_request_code {
 572     OFPBRC_BAD_VERSION,         /* ofp_header.version not supported. */
 573     OFPBRC_BAD_TYPE,            /* ofp_header.type not supported. */
 574     OFPBRC_BAD_STAT,            /* ofp_stats_request.type not supported. */
 575     OFPBRC_BAD_VENDOR,          /* Vendor not supported (in ofp_vendor or
 576                                  * ofp_stats_request or ofp_stats_reply). */
 577     OFPBRC_BAD_SUBTYPE          /* Vendor subtype not supported. */
 578 };
 579
 580 /* ofp_error_msg 'code' values for OFPET_BAD_ACTION.  'data' contains at least
 581  * the first 64 bytes of the failed request. */
 582 enum ofp_bad_action_code {
 583     OFPBAC_BAD_TYPE,           /* Unknown action type. */
 584     OFPBAC_BAD_LEN,            /* Length problem in actions. */
 585     OFPBAC_BAD_VENDOR,         /* Unknown vendor id specified. */
 586     OFPBAC_BAD_VENDOR_TYPE,    /* Unknown action type for vendor id. */
 587     OFPBAC_BAD_OUT_PORT,       /* Problem validating output action. */
 588     OFPBAC_BAD_ARGUMENT        /* Bad action argument. */
 589 };
 590
 591 /* OFPT_ERROR: Error message (datapath -> controller). */
 592 struct ofp_error_msg {
 593     struct ofp_header header;
 594
 595     uint16_t type;
 596     uint16_t code;
 597     uint8_t data[0];          /* Variable-length data.  Interpreted based
 598                                  on the type and code. */
 599 };
 600 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
 601
 602 enum ofp_stats_types {
 603     /* Description of this OpenFlow switch.
 604      * The request body is empty.
 605      * The reply body is struct ofp_desc_stats. */
 606     OFPST_DESC,
 607
 608     /* Individual flow statistics.
 609      * The request body is struct ofp_flow_stats_request.
 610      * The reply body is an array of struct ofp_flow_stats. */
 611     OFPST_FLOW,
 612
 613     /* Aggregate flow statistics.
 614      * The request body is struct ofp_aggregate_stats_request.
 615      * The reply body is struct ofp_aggregate_stats_reply. */
 616     OFPST_AGGREGATE,
 617
 618     /* Flow table statistics.
 619      * The request body is empty.
 620      * The reply body is an array of struct ofp_table_stats. */
 621     OFPST_TABLE,
 622
 623     /* Physical port statistics.
 624      * The request body is empty.
 625      * The reply body is an array of struct ofp_port_stats. */
 626     OFPST_PORT,
 627
 628     /* Vendor extension.
 629      * The request and reply bodies begin with a 32-bit vendor ID, which takes
 630      * the same form as in "struct ofp_vendor".  The request and reply bodies
 631      * are otherwise vendor-defined. */
 632     OFPST_VENDOR = 0xffff
 633 };
 634
 635 struct ofp_stats_request {
 636     struct ofp_header header;
 637     uint16_t type;              /* One of the OFPST_* constants. */
 638     uint16_t flags;             /* OFPSF_REQ_* flags (none yet defined). */
 639     uint8_t body[0];            /* Body of the request. */
 640 };
 641 OFP_ASSERT(sizeof(struct ofp_stats_request) == 12);
 642
 643 enum ofp_stats_reply_flags {
 644     OFPSF_REPLY_MORE  = 1 << 0  /* More replies to follow */
 645 };
 646
 647 struct ofp_stats_reply {
 648     struct ofp_header header;
 649     uint16_t type;              /* One of the OFPST_* constants. */
 650     uint16_t flags;             /* OFPSF_REPLY_* flags. */
 651     uint8_t body[0];            /* Body of the reply. */
 652 };
 653 OFP_ASSERT(sizeof(struct ofp_stats_reply) == 12);
 654
 655 #define DESC_STR_LEN   256
 656 #define SERIAL_NUM_LEN 32
 657 /* Body of reply to OFPST_DESC request.  Each entry is a NULL-terminated
 658  * ASCII string. */
 659 struct ofp_desc_stats {
 660     char mfr_desc[DESC_STR_LEN];       /* Manufacturer description. */
 661     char hw_desc[DESC_STR_LEN];        /* Hardware description. */
 662     char sw_desc[DESC_STR_LEN];        /* Software description. */
 663     char serial_num[SERIAL_NUM_LEN];   /* Serial number. */
 664 };
 665 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 800);
 666
 667 /* Body for ofp_stats_request of type OFPST_FLOW. */
 668 struct ofp_flow_stats_request {
 669     struct ofp_match match;   /* Fields to match */
 670     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
 671                                  or 0xff for all tables. */
 672     uint8_t pad[3];           /* Align to 32 bits. */
 673 };
 674 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 40);
 675
 676 /* Body of reply to OFPST_FLOW request. */
 677 struct ofp_flow_stats {
 678     uint16_t length;          /* Length of this entry. */
 679     uint8_t table_id;         /* ID of table flow came from. */
 680     uint8_t pad;
 681     struct ofp_match match;   /* Description of fields. */
 682     uint32_t duration;        /* Time flow has been alive in seconds. */
 683     uint16_t priority;        /* Priority of the entry. Only meaningful
 684                                  when this is not an exact-match entry. */
 685     uint16_t idle_timeout;    /* Number of seconds idle before expiration. */
 686     uint16_t hard_timeout;    /* Number of seconds before expiration. */
 687     uint16_t pad2[3];         /* Pad to 64 bits. */
 688     uint64_t packet_count;    /* Number of packets in flow. */
 689     uint64_t byte_count;      /* Number of bytes in flow. */
 690     struct ofp_action_header actions[0]; /* Actions. */
 691 };
 692 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 72);
 693
 694 /* Body for ofp_stats_request of type OFPST_AGGREGATE. */
 695 struct ofp_aggregate_stats_request {
 696     struct ofp_match match;   /* Fields to match */
 697     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
 698                                  or 0xff for all tables. */
 699     uint8_t pad[3];           /* Align to 32 bits. */
 700 };
 701 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 40);
 702
 703 /* Body of reply to OFPST_AGGREGATE request. */
 704 struct ofp_aggregate_stats_reply {
 705     uint64_t packet_count;    /* Number of packets in flows. */
 706     uint64_t byte_count;      /* Number of bytes in flows. */
 707     uint32_t flow_count;      /* Number of flows. */
 708     uint8_t pad[4];           /* Align to 64 bits. */
 709 };
 710 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
 711
 712 /* Body of reply to OFPST_TABLE request. */
 713 struct ofp_table_stats {
 714     uint8_t table_id;        /* Identifier of table.  Lower numbered tables
 715                                 are consulted first. */
 716     uint8_t pad[3];          /* Align to 32-bits */
 717     char name[OFP_MAX_TABLE_NAME_LEN];
 718     uint32_t wildcards;      /* Bitmap of OFPFW_* wildcards that are
 719                                 supported by the table. */
 720     uint32_t max_entries;    /* Max number of entries supported */
 721     uint32_t active_count;   /* Number of active entries */
 722     uint64_t lookup_count;   /* Number of packets looked up in table */
 723     uint64_t matched_count;  /* Number of packets that hit table */
 724 };
 725 OFP_ASSERT(sizeof(struct ofp_table_stats) == 64);
 726
 727 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
 728  * the field to all ones. */
 729 struct ofp_port_stats {
 730     uint16_t port_no;
 731     uint8_t pad[6];          /* Align to 64-bits. */
 732     uint64_t rx_packets;     /* Number of received packets. */
 733     uint64_t tx_packets;     /* Number of transmitted packets. */
 734     uint64_t rx_bytes;       /* Number of received bytes. */
 735     uint64_t tx_bytes;       /* Number of transmitted bytes. */
 736     uint64_t rx_dropped;     /* Number of packets dropped by RX. */
 737     uint64_t tx_dropped;     /* Number of packets dropped by TX. */
 738     uint64_t rx_errors;      /* Number of receive errors.  This is a super-set
 739                                 of receive errors and should be great than or
 740                                 equal to the sum of al rx_*_err values. */
 741     uint64_t tx_errors;      /* Number of transmit errors.  This is a super-set
 742                                 of transmit errors. */
 743     uint64_t rx_frame_err;   /* Number of frame alignment errors. */
 744     uint64_t rx_over_err;    /* Number of packets with RX overrun. */
 745     uint64_t rx_crc_err;     /* Number of CRC errors. */
 746     uint64_t collisions;     /* Number of collisions. */
 747 };
 748 OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
 749
 750 /* Vendor extension. */
 751 struct ofp_vendor_header {
 752     struct ofp_header header;   /* Type OFPT_VENDOR. */
 753     uint32_t vendor;            /* Vendor ID:
 754                                  * - MSB 0: low-order bytes are IEEE OUI.
 755                                  * - MSB != 0: defined by OpenFlow
 756                                  *   consortium. */
 757     /* Vendor-defined arbitrary additional data. */
 758 };
 759 OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12);
 760
 761 #endif /* openflow.h */