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   0x94
  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 };
 337
 338 /* An output action sends packets out 'port'.  When the 'port' is the
 339  * OFPP_CONTROLLER, 'max_len' indicates the max number of bytes to
 340  * send.  A 'max_len' of zero means the entire packet should be sent. */
 341 struct ofp_action_output {
 342     uint16_t max_len;
 343     uint16_t port;
 344 };
 345 OFP_ASSERT(sizeof(struct ofp_action_output) == 4);
 346
 347 struct ofp_action {
 348     uint16_t type;                       /* One of OFPAT_* */
 349     union {
 350         struct ofp_action_output output; /* OFPAT_OUTPUT: output struct. */
 351         uint8_t vlan_pcp;                /* OFPAT_SET_VLAN_PCP: priority. */
 352         uint16_t vlan_vid;               /* OFPAT_SET_VLAN_VID: VLAN id. */
 353         uint8_t  dl_addr[OFP_ETH_ALEN];  /* OFPAT_SET_DL_SRC/DST */
 354         uint32_t nw_addr OFP_PACKED;     /* OFPAT_SET_NW_SRC/DST */
 355         uint16_t tp;                     /* OFPAT_SET_TP_SRC/DST */
 356     } arg;
 357 };
 358 OFP_ASSERT(sizeof(struct ofp_action) == 8);
 359
 360 /* Send packet (controller -> datapath). */
 361 struct ofp_packet_out {
 362     struct ofp_header header;
 363     uint32_t buffer_id;           /* ID assigned by datapath (-1 if none). */
 364     uint16_t in_port;             /* Packet's input port (OFPP_NONE if none). */
 365     uint16_t n_actions;           /* Number of actions. */
 366     struct ofp_action actions[0]; /* Actions. */
 367     /* uint8_t data[0]; */        /* Packet data.  The length is inferred
 368                                      from the length field in the header.
 369                                      (Only meaningful if buffer_id == -1.) */
 370 };
 371 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
 372
 373 enum ofp_flow_mod_command {
 374     OFPFC_ADD,              /* New flow. */
 375     OFPFC_MODIFY,           /* Modify all matching flows. */
 376     OFPFC_MODIFY_STRICT,    /* Modify entry strictly matching wildcards */
 377     OFPFC_DELETE,           /* Delete all matching flows. */
 378     OFPFC_DELETE_STRICT     /* Strictly match wildcards and priority. */
 379 };
 380
 381 /* Flow wildcards. */
 382 enum ofp_flow_wildcards {
 383     OFPFW_IN_PORT  = 1 << 0,  /* Switch input port. */
 384     OFPFW_DL_VLAN  = 1 << 1,  /* VLAN. */
 385     OFPFW_DL_SRC   = 1 << 2,  /* Ethernet source address. */
 386     OFPFW_DL_DST   = 1 << 3,  /* Ethernet destination address. */
 387     OFPFW_DL_TYPE  = 1 << 4,  /* Ethernet frame type. */
 388     OFPFW_NW_PROTO = 1 << 5,  /* IP protocol. */
 389     OFPFW_TP_SRC   = 1 << 6,  /* TCP/UDP source port. */
 390     OFPFW_TP_DST   = 1 << 7,  /* TCP/UDP destination port. */
 391
 392     /* IP source address wildcard bit count.  0 is exact match, 1 ignores the
 393      * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
 394      * the entire field.  This is the *opposite* of the usual convention where
 395      * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
 396     OFPFW_NW_SRC_SHIFT = 8,
 397     OFPFW_NW_SRC_BITS = 6,
 398     OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
 399     OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
 400
 401     /* IP destination address wildcard bit count.  Same format as source. */
 402     OFPFW_NW_DST_SHIFT = 14,
 403     OFPFW_NW_DST_BITS = 6,
 404     OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
 405     OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
 406
 407     /* Wildcard all fields. */
 408     OFPFW_ALL = ((1 << 20) - 1)
 409 };
 410
 411 /* Values below this cutoff are 802.3 packets and the two bytes
 412  * following MAC addresses are used as a frame length.  Otherwise, the
 413  * two bytes are used as the Ethernet type.
 414  */
 415 #define OFP_DL_TYPE_ETH2_CUTOFF   0x0600
 416
 417 /* Value of dl_type to indicate that the frame does not include an
 418  * Ethernet type.
 419  */
 420 #define OFP_DL_TYPE_NOT_ETH_TYPE  0x05ff
 421
 422 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
 423  * special conditions.  All ones indicates that no VLAN id was set.
 424  */
 425 #define OFP_VLAN_NONE      0xffff
 426
 427 /* Fields to match against flows */
 428 struct ofp_match {
 429     uint32_t wildcards;        /* Wildcard fields. */
 430     uint16_t in_port;          /* Input switch port. */
 431     uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
 432     uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
 433     uint16_t dl_vlan;          /* Input VLAN. */
 434     uint16_t dl_type;          /* Ethernet frame type. */
 435     uint8_t nw_proto;          /* IP protocol. */
 436     uint8_t pad;               /* Align to 32-bits. */
 437     uint32_t nw_src;           /* IP source address. */
 438     uint32_t nw_dst;           /* IP destination address. */
 439     uint16_t tp_src;           /* TCP/UDP source port. */
 440     uint16_t tp_dst;           /* TCP/UDP destination port. */
 441 };
 442 OFP_ASSERT(sizeof(struct ofp_match) == 36);
 443
 444 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
 445  * is permanent. */
 446 #define OFP_FLOW_PERMANENT 0
 447
 448 /* By default, choose a priority in the middle */
 449 #define OFP_DEFAULT_PRIORITY 0x8000
 450
 451 /* Flow setup and teardown (controller -> datapath). */
 452 struct ofp_flow_mod {
 453     struct ofp_header header;
 454     struct ofp_match match;      /* Fields to match */
 455
 456     /* Flow actions. */
 457     uint16_t command;             /* One of OFPFC_*. */
 458     uint16_t idle_timeout;        /* Idle time before discarding (seconds). */
 459     uint16_t hard_timeout;        /* Max time before discarding (seconds). */
 460     uint16_t priority;            /* Priority level of flow entry. */
 461     uint32_t buffer_id;           /* Buffered packet to apply to (or -1).
 462                                      Not meaningful for OFPFC_DELETE*. */
 463     uint32_t reserved;            /* Reserved for future use. */
 464     struct ofp_action actions[0]; /* The number of actions is inferred from
 465                                      the length field in the header. */
 466 };
 467 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 60);
 468
 469 /* Why did this flow expire? */
 470 enum ofp_flow_expired_reason {
 471     OFPER_IDLE_TIMEOUT,         /* Flow idle time exceeded idle_timeout. */
 472     OFPER_HARD_TIMEOUT          /* Time exceeded hard_timeout. */
 473 };
 474
 475 /* Flow expiration (datapath -> controller). */
 476 struct ofp_flow_expired {
 477     struct ofp_header header;
 478     struct ofp_match match;   /* Description of fields */
 479
 480     uint16_t priority;        /* Priority level of flow entry. */
 481     uint8_t reason;           /* One of OFPER_*. */
 482     uint8_t pad[1];           /* Align to 32-bits. */
 483
 484     uint32_t duration;        /* Time flow was alive in seconds. */
 485     uint8_t pad2[4];          /* Align to 64-bits. */
 486     uint64_t packet_count;
 487     uint64_t byte_count;
 488 };
 489 OFP_ASSERT(sizeof(struct ofp_flow_expired) == 72);
 490
 491 /* Values for 'type' in ofp_error_message.  These values are immutable: they
 492  * will not change in future versions of the protocol (although new values may
 493  * be added). */
 494 enum ofp_error_type {
 495     OFPET_HELLO_FAILED,         /* Hello protocol failed. */
 496     OFPET_BAD_REQUEST           /* Request was not understood. */
 497 };
 498
 499 /* ofp_error_msg 'code' values for OFPET_HELLO_FAILED.  'data' contains an
 500  * ASCII text string that may give failure details. */
 501 enum ofp_hello_failed_code {
 502     OFPHFC_INCOMPATIBLE         /* No compatible version. */
 503 };
 504
 505 /* ofp_error_msg 'code' values for OFPET_BAD_REQUEST.  'data' contains at least
 506  * the first 64 bytes of the failed request. */
 507 enum ofp_bad_request_code {
 508     OFPBRC_BAD_VERSION,         /* ofp_header.version not supported. */
 509     OFPBRC_BAD_TYPE,            /* ofp_header.type not supported. */
 510     OFPBRC_BAD_STAT,            /* ofp_stats_request.type not supported. */
 511     OFPBRC_BAD_VENDOR           /* Vendor not supported (in ofp_vendor or
 512                                  * ofp_stats_request or ofp_stats_reply). */
 513 };
 514
 515 /* OFPT_ERROR: Error message (datapath -> controller). */
 516 struct ofp_error_msg {
 517     struct ofp_header header;
 518
 519     uint16_t type;
 520     uint16_t code;
 521     uint8_t data[0];          /* Variable-length data.  Interpreted based
 522                                  on the type and code. */
 523 };
 524 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
 525
 526 enum ofp_stats_types {
 527     /* Description of this OpenFlow switch.
 528      * The request body is empty.
 529      * The reply body is struct ofp_desc_stats. */
 530     OFPST_DESC,
 531
 532     /* Individual flow statistics.
 533      * The request body is struct ofp_flow_stats_request.
 534      * The reply body is an array of struct ofp_flow_stats. */
 535     OFPST_FLOW,
 536
 537     /* Aggregate flow statistics.
 538      * The request body is struct ofp_aggregate_stats_request.
 539      * The reply body is struct ofp_aggregate_stats_reply. */
 540     OFPST_AGGREGATE,
 541
 542     /* Flow table statistics.
 543      * The request body is empty.
 544      * The reply body is an array of struct ofp_table_stats. */
 545     OFPST_TABLE,
 546
 547     /* Physical port statistics.
 548      * The request body is empty.
 549      * The reply body is an array of struct ofp_port_stats. */
 550     OFPST_PORT,
 551
 552     /* Vendor extension.
 553      * The request and reply bodies begin with a 32-bit vendor ID, which takes
 554      * the same form as in "struct ofp_vendor".  The request and reply bodies
 555      * are otherwise vendor-defined. */
 556     OFPST_VENDOR = 0xffff
 557 };
 558
 559 struct ofp_stats_request {
 560     struct ofp_header header;
 561     uint16_t type;              /* One of the OFPST_* constants. */
 562     uint16_t flags;             /* OFPSF_REQ_* flags (none yet defined). */
 563     uint8_t body[0];            /* Body of the request. */
 564 };
 565 OFP_ASSERT(sizeof(struct ofp_stats_request) == 12);
 566
 567 enum ofp_stats_reply_flags {
 568     OFPSF_REPLY_MORE  = 1 << 0  /* More replies to follow */
 569 };
 570
 571 struct ofp_stats_reply {
 572     struct ofp_header header;
 573     uint16_t type;              /* One of the OFPST_* constants. */
 574     uint16_t flags;             /* OFPSF_REPLY_* flags. */
 575     uint8_t body[0];            /* Body of the reply. */
 576 };
 577 OFP_ASSERT(sizeof(struct ofp_stats_reply) == 12);
 578
 579 #define DESC_STR_LEN   256
 580 #define SERIAL_NUM_LEN 32
 581 /* Body of reply to OFPST_DESC request.  Each entry is a NULL-terminated
 582  * ASCII string. */
 583 struct ofp_desc_stats {
 584     char mfr_desc[DESC_STR_LEN];       /* Manufacturer description. */
 585     char hw_desc[DESC_STR_LEN];        /* Hardware description. */
 586     char sw_desc[DESC_STR_LEN];        /* Software description. */
 587     char serial_num[SERIAL_NUM_LEN];   /* Serial number. */
 588 };
 589 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 800);
 590
 591 /* Body for ofp_stats_request of type OFPST_FLOW. */
 592 struct ofp_flow_stats_request {
 593     struct ofp_match match;   /* Fields to match */
 594     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
 595                                  or 0xff for all tables. */
 596     uint8_t pad[3];           /* Align to 32 bits. */
 597 };
 598 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 40);
 599
 600 /* Body of reply to OFPST_FLOW request. */
 601 struct ofp_flow_stats {
 602     uint16_t length;          /* Length of this entry. */
 603     uint8_t table_id;         /* ID of table flow came from. */
 604     uint8_t pad;
 605     struct ofp_match match;   /* Description of fields. */
 606     uint32_t duration;        /* Time flow has been alive in seconds. */
 607     uint16_t priority;        /* Priority of the entry. Only meaningful
 608                                  when this is not an exact-match entry. */
 609     uint16_t idle_timeout;    /* Number of seconds idle before expiration. */
 610     uint16_t hard_timeout;    /* Number of seconds before expiration. */
 611     uint16_t pad2[3];         /* Pad to 64 bits. */
 612     uint64_t packet_count;    /* Number of packets in flow. */
 613     uint64_t byte_count;      /* Number of bytes in flow. */
 614     struct ofp_action actions[0]; /* Actions. */
 615 };
 616 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 72);
 617
 618 /* Body for ofp_stats_request of type OFPST_AGGREGATE. */
 619 struct ofp_aggregate_stats_request {
 620     struct ofp_match match;   /* Fields to match */
 621     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
 622                                  or 0xff for all tables. */
 623     uint8_t pad[3];           /* Align to 32 bits. */
 624 };
 625 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 40);
 626
 627 /* Body of reply to OFPST_AGGREGATE request. */
 628 struct ofp_aggregate_stats_reply {
 629     uint64_t packet_count;    /* Number of packets in flows. */
 630     uint64_t byte_count;      /* Number of bytes in flows. */
 631     uint32_t flow_count;      /* Number of flows. */
 632     uint8_t pad[4];           /* Align to 64 bits. */
 633 };
 634 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
 635
 636 /* Body of reply to OFPST_TABLE request. */
 637 struct ofp_table_stats {
 638     uint8_t table_id;        /* Identifier of table.  Lower numbered tables
 639                                 are consulted first. */
 640     uint8_t pad[3];          /* Align to 32-bits */
 641     char name[OFP_MAX_TABLE_NAME_LEN];
 642     uint32_t wildcards;      /* Bitmap of OFPFW_* wildcards that are
 643                                 supported by the table. */
 644     uint32_t max_entries;    /* Max number of entries supported */
 645     uint32_t active_count;   /* Number of active entries */
 646     uint64_t lookup_count;   /* Number of packets looked up in table */
 647     uint64_t matched_count;  /* Number of packets that hit table */
 648 };
 649 OFP_ASSERT(sizeof(struct ofp_table_stats) == 64);
 650
 651 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
 652  * the field to all ones. */
 653 struct ofp_port_stats {
 654     uint16_t port_no;
 655     uint8_t pad[6];          /* Align to 64-bits. */
 656     uint64_t rx_packets;     /* Number of received packets. */
 657     uint64_t tx_packets;     /* Number of transmitted packets. */
 658     uint64_t rx_bytes;       /* Number of received bytes. */
 659     uint64_t tx_bytes;       /* Number of transmitted bytes. */
 660     uint64_t rx_dropped;     /* Number of packets dropped by RX. */
 661     uint64_t tx_dropped;     /* Number of packets dropped by TX. */
 662     uint64_t rx_errors;      /* Number of receive errors.  This is a super-set
 663                                 of receive errors and should be great than or
 664                                 equal to the sum of al rx_*_err values. */
 665     uint64_t tx_errors;      /* Number of transmit errors.  This is a super-set
 666                                 of transmit errors. */
 667     uint64_t rx_frame_err;   /* Number of frame alignment errors. */
 668     uint64_t rx_over_err;    /* Number of packets with RX overrun. */
 669     uint64_t rx_crc_err;     /* Number of CRC errors. */
 670     uint64_t collisions;     /* Number of collisions. */
 671 };
 672 OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
 673
 674 /* Vendor extension. */
 675 struct ofp_vendor {
 676     struct ofp_header header;   /* Type OFPT_VENDOR. */
 677     uint32_t vendor;            /* Vendor ID:
 678                                  * - MSB 0: low-order bytes are IEEE OUI.
 679                                  * - MSB != 0: defined by OpenFlow
 680                                  *   consortium. */
 681     /* Vendor-defined arbitrary additional data. */
 682 };
 683 OFP_ASSERT(sizeof(struct ofp_vendor) == 12);
 684
 685 #endif /* openflow.h */