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   0x91
  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 = 0x100,
  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.11d 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. */
 180 enum ofp_port_flags {
 181     /* Read/write bits. */
 182     OFPPFL_PORT_DOWN    = 1 << 1, /* Port is configured down. */
 183     OFPPFL_NO_STP       = 1 << 3, /* Disable 802.1D spanning tree on port. */
 184     OFPPFL_NO_RECV      = 1 << 4, /* Drop most packets received on port. */
 185     OFPPFL_NO_RECV_STP  = 1 << 5, /* Drop received 802.1D STP packets. */
 186     OFPPFL_NO_FWD       = 1 << 6, /* Drop packets forwarded to port. */
 187     OFPPFL_NO_PACKET_IN = 1 << 7, /* Do not send packet-in msgs for port. */
 188
 189     /* Read-only bits. */
 190     OFPPFL_LINK_DOWN    = 1 << 2, /* No physical link present. */
 191
 192     /* Read-only when STP is enabled (when OFPPFL_NO_STP is not set).
 193      * Read/write when STP is disabled (when OFPPFL_NO_STP is set).
 194      *
 195      * The OFPPFL_STP_* bits have no effect on switch operation.  The
 196      * controller must adjust OFPPFL_NO_RECV, OFPPFL_NO_FWD, and
 197      * OFPPFL_NO_PACKET_IN appropriately to fully implement an 802.1D spanning
 198      * tree. */
 199     OFPPFL_NO_FLOOD     = 1 << 0, /* Do not include this port when flooding. */
 200     OFPPFL_STP_LISTEN   = 0 << 8, /* Not learning or relaying frames. */
 201     OFPPFL_STP_LEARN    = 1 << 8, /* Learning but not relaying frames. */
 202     OFPPFL_STP_FORWARD  = 2 << 8, /* Learning and relaying frames. */
 203     OFPPFL_STP_BLOCK    = 3 << 8, /* Not part of spanning tree. */
 204     OFPPFL_STP_MASK     = 3 << 8, /* Bit mask for OFPPFL_STP_* values. */
 205 };
 206
 207 /* Features of physical ports available in a datapath. */
 208 enum ofp_port_features {
 209     OFPPF_10MB_HD    = 1 << 0, /* 10 Mb half-duplex rate support. */
 210     OFPPF_10MB_FD    = 1 << 1, /* 10 Mb full-duplex rate support. */
 211     OFPPF_100MB_HD   = 1 << 2, /* 100 Mb half-duplex rate support. */
 212     OFPPF_100MB_FD   = 1 << 3, /* 100 Mb full-duplex rate support. */
 213     OFPPF_1GB_HD     = 1 << 4, /* 1 Gb half-duplex rate support. */
 214     OFPPF_1GB_FD     = 1 << 5, /* 1 Gb full-duplex rate support. */
 215     OFPPF_10GB_FD    = 1 << 6, /* 10 Gb full-duplex rate support. */
 216     OFPPF_STP        = 1 << 7, /* 802.1D spanning tree supported on port. */
 217 };
 218
 219
 220 /* Description of a physical port */
 221 struct ofp_phy_port {
 222     uint16_t port_no;
 223     uint8_t hw_addr[OFP_ETH_ALEN];
 224     uint8_t name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
 225     uint32_t flags;         /* Bitmap of "ofp_port_flags". */
 226     uint32_t speed;         /* Current speed in Mbps */
 227     uint32_t features;      /* Bitmap of supported "ofp_port_features"s. */
 228 };
 229 OFP_ASSERT(sizeof(struct ofp_phy_port) == 36);
 230
 231 /* Switch features. */
 232 struct ofp_switch_features {
 233     struct ofp_header header;
 234     uint64_t datapath_id;   /* Datapath unique ID.  Only the lower 48-bits
 235                                are meaningful. */
 236
 237     uint32_t n_buffers;     /* Max packets buffered at once. */
 238
 239     uint8_t n_tables;       /* Number of tables supported by datapath. */
 240     uint8_t pad[3];         /* Align to 64-bits. */
 241
 242     /* Features. */
 243     uint32_t capabilities;  /* Bitmap of support "ofp_capabilities". */
 244     uint32_t actions;       /* Bitmap of supported "ofp_action_type"s. */
 245
 246     /* Port info.*/
 247     struct ofp_phy_port ports[0];  /* Port definitions.  The number of ports
 248                                       is inferred from the length field in
 249                                       the header. */
 250 };
 251 OFP_ASSERT(sizeof(struct ofp_switch_features) == 32);
 252
 253 /* What changed about the physical port */
 254 enum ofp_port_reason {
 255     OFPPR_ADD,              /* The port was added */
 256     OFPPR_DELETE,           /* The port was removed */
 257     OFPPR_MOD               /* Some attribute of the port has changed */
 258 };
 259
 260 /* A physical port has changed in the datapath */
 261 struct ofp_port_status {
 262     struct ofp_header header;
 263     uint8_t reason;          /* One of OFPPR_* */
 264     uint8_t pad[3];          /* Align to 32-bits */
 265     struct ofp_phy_port desc;
 266 };
 267 OFP_ASSERT(sizeof(struct ofp_port_status) == 48);
 268
 269 /* Modify behavior of the physical port */
 270 struct ofp_port_mod {
 271     struct ofp_header header;
 272     uint32_t mask;         /* Bitmap of "ofp_port_flags" that should be
 273                               changed. */
 274     struct ofp_phy_port desc;
 275 };
 276 OFP_ASSERT(sizeof(struct ofp_port_mod) == 48);
 277
 278 /* Why is this packet being sent to the controller? */
 279 enum ofp_packet_in_reason {
 280     OFPR_NO_MATCH,          /* No matching flow. */
 281     OFPR_ACTION             /* Action explicitly output to controller. */
 282 };
 283
 284 /* Packet received on port (datapath -> controller). */
 285 struct ofp_packet_in {
 286     struct ofp_header header;
 287     uint32_t buffer_id;     /* ID assigned by datapath. */
 288     uint16_t total_len;     /* Full length of frame. */
 289     uint16_t in_port;       /* Port on which frame was received. */
 290     uint8_t reason;         /* Reason packet is being sent (one of OFPR_*) */
 291     uint8_t pad;
 292     uint8_t data[0];        /* Ethernet frame, halfway through 32-bit word,
 293                                so the IP header is 32-bit aligned.  The
 294                                amount of data is inferred from the length
 295                                field in the header.  Because of padding,
 296                                offsetof(struct ofp_packet_in, data) ==
 297                                sizeof(struct ofp_packet_in) - 2. */
 298 };
 299 OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
 300
 301 enum ofp_action_type {
 302     OFPAT_OUTPUT,           /* Output to switch port. */
 303     OFPAT_SET_DL_VLAN,      /* VLAN. */
 304     OFPAT_SET_DL_SRC,       /* Ethernet source address. */
 305     OFPAT_SET_DL_DST,       /* Ethernet destination address. */
 306     OFPAT_SET_NW_SRC,       /* IP source address. */
 307     OFPAT_SET_NW_DST,       /* IP destination address. */
 308     OFPAT_SET_TP_SRC,       /* TCP/UDP source port. */
 309     OFPAT_SET_TP_DST        /* TCP/UDP destination port. */
 310 };
 311
 312 /* An output action sends packets out 'port'.  When the 'port' is the
 313  * OFPP_CONTROLLER, 'max_len' indicates the max number of bytes to
 314  * send.  A 'max_len' of zero means the entire packet should be sent. */
 315 struct ofp_action_output {
 316     uint16_t max_len;
 317     uint16_t port;
 318 };
 319 OFP_ASSERT(sizeof(struct ofp_action_output) == 4);
 320
 321 /* The VLAN id is 12-bits, so we'll use the entire 16 bits to indicate
 322  * special conditions.  All ones is used to indicate that no VLAN id was
 323  * set, or if used as an action, that the VLAN header should be
 324  * stripped.
 325  */
 326 #define OFP_VLAN_NONE      0xffff
 327
 328 struct ofp_action {
 329     uint16_t type;                       /* One of OFPAT_* */
 330     union {
 331         struct ofp_action_output output; /* OFPAT_OUTPUT: output struct. */
 332         uint16_t vlan_id;                /* OFPAT_SET_DL_VLAN: VLAN id. */
 333         uint8_t  dl_addr[OFP_ETH_ALEN];  /* OFPAT_SET_DL_SRC/DST */
 334         uint32_t nw_addr OFP_PACKED;     /* OFPAT_SET_NW_SRC/DST */
 335         uint16_t tp;                     /* OFPAT_SET_TP_SRC/DST */
 336     } arg;
 337 };
 338 OFP_ASSERT(sizeof(struct ofp_action) == 8);
 339
 340 /* Send packet (controller -> datapath). */
 341 struct ofp_packet_out {
 342     struct ofp_header header;
 343     uint32_t buffer_id;           /* ID assigned by datapath (-1 if none). */
 344     uint16_t in_port;             /* Packet's input port (OFPP_NONE if none). */
 345     uint16_t n_actions;           /* Number of actions. */
 346     struct ofp_action actions[0]; /* Actions. */
 347     /* uint8_t data[0]; */        /* Packet data.  The length is inferred
 348                                      from the length field in the header.
 349                                      (Only meaningful if buffer_id == -1.) */
 350 };
 351 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
 352
 353 enum ofp_flow_mod_command {
 354     OFPFC_ADD,              /* New flow. */
 355     OFPFC_MODIFY,           /* Modify all matching flows. */
 356     OFPFC_DELETE,           /* Delete all matching flows. */
 357     OFPFC_DELETE_STRICT     /* Strictly match wildcards and priority. */
 358 };
 359
 360 /* Flow wildcards. */
 361 enum ofp_flow_wildcards {
 362     OFPFW_IN_PORT  = 1 << 0,  /* Switch input port. */
 363     OFPFW_DL_VLAN  = 1 << 1,  /* VLAN. */
 364     OFPFW_DL_SRC   = 1 << 2,  /* Ethernet source address. */
 365     OFPFW_DL_DST   = 1 << 3,  /* Ethernet destination address. */
 366     OFPFW_DL_TYPE  = 1 << 4,  /* Ethernet frame type. */
 367     OFPFW_NW_PROTO = 1 << 5,  /* IP protocol. */
 368     OFPFW_TP_SRC   = 1 << 6,  /* TCP/UDP source port. */
 369     OFPFW_TP_DST   = 1 << 7,  /* TCP/UDP destination port. */
 370
 371     /* IP source address wildcard bit count.  0 is exact match, 1 ignores the
 372      * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
 373      * the entire field.  This is the *opposite* of the usual convention where
 374      * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
 375     OFPFW_NW_SRC_SHIFT = 8,
 376     OFPFW_NW_SRC_BITS = 6,
 377     OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
 378     OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
 379
 380     /* IP destination address wildcard bit count.  Same format as source. */
 381     OFPFW_NW_DST_SHIFT = 14,
 382     OFPFW_NW_DST_BITS = 6,
 383     OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
 384     OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
 385
 386     /* Wildcard all fields. */
 387     OFPFW_ALL = ((1 << 20) - 1)
 388 };
 389
 390 /* Values below this cutoff are 802.3 packets and the two bytes
 391  * following MAC addresses are used as a frame length.  Otherwise, the
 392  * two bytes are used as the Ethernet type.
 393  */
 394 #define OFP_DL_TYPE_ETH2_CUTOFF   0x0600
 395
 396 /* Value of dl_type to indicate that the frame does not include an
 397  * Ethernet type.
 398  */
 399 #define OFP_DL_TYPE_NOT_ETH_TYPE  0x05ff
 400
 401 /* Fields to match against flows */
 402 struct ofp_match {
 403     uint32_t wildcards;        /* Wildcard fields. */
 404     uint16_t in_port;          /* Input switch port. */
 405     uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
 406     uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
 407     uint16_t dl_vlan;          /* Input VLAN. */
 408     uint16_t dl_type;          /* Ethernet frame type. */
 409     uint8_t nw_proto;          /* IP protocol. */
 410     uint8_t pad;               /* Align to 32-bits. */
 411     uint32_t nw_src;           /* IP source address. */
 412     uint32_t nw_dst;           /* IP destination address. */
 413     uint16_t tp_src;           /* TCP/UDP source port. */
 414     uint16_t tp_dst;           /* TCP/UDP destination port. */
 415 };
 416 OFP_ASSERT(sizeof(struct ofp_match) == 36);
 417
 418 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
 419  * is permanent. */
 420 #define OFP_FLOW_PERMANENT 0
 421
 422 /* By default, choose a priority in the middle */
 423 #define OFP_DEFAULT_PRIORITY 0x8000
 424
 425 /* Flow setup and teardown (controller -> datapath). */
 426 struct ofp_flow_mod {
 427     struct ofp_header header;
 428     struct ofp_match match;      /* Fields to match */
 429
 430     /* Flow actions. */
 431     uint16_t command;             /* One of OFPFC_*. */
 432     uint16_t idle_timeout;        /* Idle time before discarding (seconds). */
 433     uint16_t hard_timeout;        /* Max time before discarding (seconds). */
 434     uint16_t priority;            /* Priority level of flow entry. */
 435     uint32_t buffer_id;           /* Buffered packet to apply to (or -1).
 436                                      Not meaningful for OFPFC_DELETE*. */
 437     uint32_t reserved;            /* Reserved for future use. */
 438     struct ofp_action actions[0]; /* The number of actions is inferred from
 439                                      the length field in the header. */
 440 };
 441 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 60);
 442
 443 /* Why did this flow expire? */
 444 enum ofp_flow_expired_reason {
 445     OFPER_IDLE_TIMEOUT,         /* Flow idle time exceeded idle_timeout. */
 446     OFPER_HARD_TIMEOUT          /* Time exceeded hard_timeout. */
 447 };
 448
 449 /* Flow expiration (datapath -> controller). */
 450 struct ofp_flow_expired {
 451     struct ofp_header header;
 452     struct ofp_match match;   /* Description of fields */
 453
 454     uint16_t priority;        /* Priority level of flow entry. */
 455     uint8_t reason;           /* One of OFPER_*. */
 456     uint8_t pad[1];           /* Align to 32-bits. */
 457
 458     uint32_t duration;        /* Time flow was alive in seconds. */
 459     uint8_t pad2[4];          /* Align to 64-bits. */
 460     uint64_t packet_count;
 461     uint64_t byte_count;
 462 };
 463 OFP_ASSERT(sizeof(struct ofp_flow_expired) == 72);
 464
 465 /* Values for 'type' in ofp_error_message.  These values are immutable: they
 466  * will not change in future versions of the protocol (although new values may
 467  * be added). */
 468 enum ofp_error_type {
 469     OFPET_HELLO_FAILED,         /* Hello protocol failed. */
 470     OFPET_BAD_REQUEST           /* Request was not understood. */
 471 };
 472
 473 /* ofp_error_msg 'code' values for OFPET_HELLO_FAILED.  'data' contains an
 474  * ASCII text string that may give failure details. */
 475 enum ofp_hello_failed_code {
 476     OFPHFC_INCOMPATIBLE         /* No compatible version. */
 477 };
 478
 479 /* ofp_error_msg 'code' values for OFPET_BAD_REQUEST.  'data' contains at least
 480  * the first 64 bytes of the failed request. */
 481 enum ofp_bad_request_code {
 482     OFPBRC_BAD_VERSION,         /* ofp_header.version not supported. */
 483     OFPBRC_BAD_TYPE,            /* ofp_header.type not supported. */
 484     OFPBRC_BAD_STAT,            /* ofp_stats_request.type not supported. */
 485     OFPBRC_BAD_VENDOR           /* Vendor not supported (in ofp_vendor or
 486                                  * ofp_stats_request or ofp_stats_reply). */
 487 };
 488
 489 /* OFPT_ERROR: Error message (datapath -> controller). */
 490 struct ofp_error_msg {
 491     struct ofp_header header;
 492
 493     uint16_t type;
 494     uint16_t code;
 495     uint8_t data[0];          /* Variable-length data.  Interpreted based
 496                                  on the type and code. */
 497 };
 498 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
 499
 500 enum ofp_stats_types {
 501     /* Description of this OpenFlow switch.
 502      * The request body is empty.
 503      * The reply body is struct ofp_desc_stats. */
 504     OFPST_DESC,
 505
 506     /* Individual flow statistics.
 507      * The request body is struct ofp_flow_stats_request.
 508      * The reply body is an array of struct ofp_flow_stats. */
 509     OFPST_FLOW,
 510
 511     /* Aggregate flow statistics.
 512      * The request body is struct ofp_aggregate_stats_request.
 513      * The reply body is struct ofp_aggregate_stats_reply. */
 514     OFPST_AGGREGATE,
 515
 516     /* Flow table statistics.
 517      * The request body is empty.
 518      * The reply body is an array of struct ofp_table_stats. */
 519     OFPST_TABLE,
 520
 521     /* Physical port statistics.
 522      * The request body is empty.
 523      * The reply body is an array of struct ofp_port_stats. */
 524     OFPST_PORT,
 525
 526     /* Vendor extension.
 527      * The request and reply bodies begin with a 32-bit vendor ID, which takes
 528      * the same form as in "struct ofp_vendor".  The request and reply bodies
 529      * are otherwise vendor-defined. */
 530     OFPST_VENDOR = 0xffff
 531 };
 532
 533 struct ofp_stats_request {
 534     struct ofp_header header;
 535     uint16_t type;              /* One of the OFPST_* constants. */
 536     uint16_t flags;             /* OFPSF_REQ_* flags (none yet defined). */
 537     uint8_t body[0];            /* Body of the request. */
 538 };
 539 OFP_ASSERT(sizeof(struct ofp_stats_request) == 12);
 540
 541 enum ofp_stats_reply_flags {
 542     OFPSF_REPLY_MORE  = 1 << 0, /* More replies to follow */
 543 };
 544
 545 struct ofp_stats_reply {
 546     struct ofp_header header;
 547     uint16_t type;              /* One of the OFPST_* constants. */
 548     uint16_t flags;             /* OFPSF_REPLY_* flags. */
 549     uint8_t body[0];            /* Body of the reply. */
 550 };
 551 OFP_ASSERT(sizeof(struct ofp_stats_reply) == 12);
 552
 553 #define DESC_STR_LEN   256
 554 #define SERIAL_NUM_LEN 32
 555 /* Body of reply to OFPST_DESC request.  Each entry is a NULL-terminated
 556  * ASCII string. */
 557 struct ofp_desc_stats {
 558     char mfr_desc[DESC_STR_LEN];       /* Manufacturer description. */
 559     char hw_desc[DESC_STR_LEN];        /* Hardware description. */
 560     char sw_desc[DESC_STR_LEN];        /* Software description. */
 561     char serial_num[SERIAL_NUM_LEN];   /* Serial number. */
 562 };
 563 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 800);
 564
 565 /* Body for ofp_stats_request of type OFPST_FLOW. */
 566 struct ofp_flow_stats_request {
 567     struct ofp_match match;   /* Fields to match */
 568     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
 569                                  or 0xff for all tables. */
 570     uint8_t pad[3];           /* Align to 32 bits. */
 571 };
 572 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 40);
 573
 574 /* Body of reply to OFPST_FLOW request. */
 575 struct ofp_flow_stats {
 576     uint16_t length;          /* Length of this entry. */
 577     uint8_t table_id;         /* ID of table flow came from. */
 578     uint8_t pad;
 579     struct ofp_match match;   /* Description of fields. */
 580     uint32_t duration;        /* Time flow has been alive in seconds. */
 581     uint16_t priority;        /* Priority of the entry. Only meaningful
 582                                  when this is not an exact-match entry. */
 583     uint16_t idle_timeout;    /* Number of seconds idle before expiration. */
 584     uint16_t hard_timeout;    /* Number of seconds before expiration. */
 585     uint16_t pad2[3];         /* Pad to 64 bits. */
 586     uint64_t packet_count;    /* Number of packets in flow. */
 587     uint64_t byte_count;      /* Number of bytes in flow. */
 588     struct ofp_action actions[0]; /* Actions. */
 589 };
 590 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 72);
 591
 592 /* Body for ofp_stats_request of type OFPST_AGGREGATE. */
 593 struct ofp_aggregate_stats_request {
 594     struct ofp_match match;   /* Fields to match */
 595     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
 596                                  or 0xff for all tables. */
 597     uint8_t pad[3];           /* Align to 32 bits. */
 598 };
 599 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 40);
 600
 601 /* Body of reply to OFPST_AGGREGATE request. */
 602 struct ofp_aggregate_stats_reply {
 603     uint64_t packet_count;    /* Number of packets in flows. */
 604     uint64_t byte_count;      /* Number of bytes in flows. */
 605     uint32_t flow_count;      /* Number of flows. */
 606     uint8_t pad[4];           /* Align to 64 bits. */
 607 };
 608 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
 609
 610 /* Body of reply to OFPST_TABLE request. */
 611 struct ofp_table_stats {
 612     uint8_t table_id;        /* Identifier of table.  Lower numbered tables
 613                                 are consulted first. */
 614     uint8_t pad[3];          /* Align to 32-bits */
 615     char name[OFP_MAX_TABLE_NAME_LEN];
 616     uint32_t wildcards;      /* Bitmap of OFPFW_* wildcards that are
 617                                 supported by the table. */
 618     uint32_t max_entries;    /* Max number of entries supported */
 619     uint32_t active_count;   /* Number of active entries */
 620     uint64_t matched_count;  /* Number of packets that hit table */
 621 };
 622 OFP_ASSERT(sizeof(struct ofp_table_stats) == 56);
 623
 624 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
 625  * the field to all ones. */
 626 struct ofp_port_stats {
 627     uint16_t port_no;
 628     uint8_t pad[6];          /* Align to 64-bits. */
 629     uint64_t rx_packets;     /* Number of received packets. */
 630     uint64_t tx_packets;     /* Number of transmitted packets. */
 631     uint64_t rx_bytes;       /* Number of received bytes. */
 632     uint64_t tx_bytes;       /* Number of transmitted bytes. */
 633     uint64_t rx_dropped;     /* Number of packets dropped by RX. */
 634     uint64_t tx_dropped;     /* Number of packets dropped by TX. */
 635     uint64_t rx_errors;      /* Number of receive errors.  This is a super-set
 636                                 of receive errors and should be great than or
 637                                 equal to the sum of al rx_*_err values. */
 638     uint64_t tx_errors;      /* Number of transmit errors.  This is a super-set
 639                                 of transmit errors. */
 640     uint64_t rx_frame_err;   /* Number of frame alignment errors. */
 641     uint64_t rx_over_err;    /* Number of packets with RX overrun. */
 642     uint64_t rx_crc_err;     /* Number of CRC errors. */
 643     uint64_t collisions;     /* Number of collisions. */
 644 };
 645 OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
 646
 647 /* Vendor extension. */
 648 struct ofp_vendor {
 649     struct ofp_header header;   /* Type OFPT_VENDOR. */
 650     uint32_t vendor;            /* Vendor ID:
 651                                  * - MSB 0: low-order bytes are Ethernet OUI.
 652                                  * - MSB != 0: defined by OpenFlow
 653                                  *   consortium. */
 654     /* Vendor-defined arbitrary additional data. */
 655 };
 656 OFP_ASSERT(sizeof(struct ofp_vendor) == 12);
 657
 658 #endif /* openflow.h */