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 /* Maximum length of a OpenFlow packet. */
  64 #define OFP_MAXLEN (sizeof(struct ofp_switch_features) \
  65         + (sizeof(struct ofp_phy_port) * OFPP_MAX) + 200)
  66
  67
  68 /* The most significant bit being set in the version field indicates an
  69  * experimental OpenFlow version.
  70  */
  71 #define OFP_VERSION   0x90
  72
  73 #define OFP_MAX_TABLE_NAME_LEN 32
  74 #define OFP_MAX_PORT_NAME_LEN  16
  75
  76 #define OFP_TCP_PORT  975
  77 #define OFP_SSL_PORT  976
  78
  79 #define OFP_ETH_ALEN 6          /* Bytes in an Ethernet address. */
  80
  81 /* Port numbering.  Physical ports are numbered starting from 0. */
  82 enum ofp_port {
  83     /* Maximum number of physical switch ports. */
  84     OFPP_MAX = 0x100,
  85
  86     /* Fake output "ports". */
  87     OFPP_IN_PORT    = 0xfff8,  /* Send the packet out the input port.  This
  88                                   virtual port must be explicitly used
  89                                   in order to send back out of the input
  90                                   port. */
  91     OFPP_TABLE      = 0xfff9,  /* Perform actions in flow table.
  92                                   NB: This can only be the destination
  93                                   port for packet-out messages. */
  94     OFPP_NORMAL     = 0xfffa,  /* Process with normal L2/L3 switching. */
  95     OFPP_FLOOD      = 0xfffb,  /* All physical ports except input port and
  96                                   those disabled by STP. */
  97     OFPP_ALL        = 0xfffc,  /* All physical ports except input port. */
  98     OFPP_CONTROLLER = 0xfffd,  /* Send to controller. */
  99     OFPP_LOCAL      = 0xfffe,  /* Local openflow "port". */
 100     OFPP_NONE       = 0xffff   /* Not associated with a physical port. */
 101 };
 102
 103 enum ofp_type {
 104     OFPT_FEATURES_REQUEST,    /*  0 Controller/switch message */
 105     OFPT_FEATURES_REPLY,      /*  1 Controller/switch message */
 106     OFPT_GET_CONFIG_REQUEST,  /*  2 Controller/switch message */
 107     OFPT_GET_CONFIG_REPLY,    /*  3 Controller/switch message */
 108     OFPT_SET_CONFIG,          /*  4 Controller/switch message */
 109     OFPT_PACKET_IN,           /*  5 Async message */
 110     OFPT_PACKET_OUT,          /*  6 Controller/switch message */
 111     OFPT_FLOW_MOD,            /*  7 Controller/switch message */
 112     OFPT_FLOW_EXPIRED,        /*  8 Async message */
 113     OFPT_TABLE,               /*  9 Controller/switch message */
 114     OFPT_PORT_MOD,            /* 10 Controller/switch message */
 115     OFPT_PORT_STATUS,         /* 11 Async message */
 116     OFPT_ERROR_MSG,           /* 12 Async message */
 117     OFPT_STATS_REQUEST,       /* 13 Controller/switch message */
 118     OFPT_STATS_REPLY,         /* 14 Controller/switch message */
 119     OFPT_ECHO_REQUEST,        /* 15 Symmetric message */
 120     OFPT_ECHO_REPLY,          /* 16 Symmetric message */
 121     OFPT_VENDOR = 0xff        /* 255 Vendor extension */
 122 };
 123
 124 /* Header on all OpenFlow packets. */
 125 struct ofp_header {
 126     uint8_t version;    /* OFP_VERSION. */
 127     uint8_t type;       /* One of the OFPT_ constants. */
 128     uint16_t length;    /* Length including this ofp_header. */
 129     uint32_t xid;       /* Transactin id associated with this packet.
 130                            Replies use the same id as was in the request
 131                            to facilitate pairing. */
 132 };
 133 OFP_ASSERT(sizeof(struct ofp_header) == 8);
 134
 135 #define OFP_DEFAULT_MISS_SEND_LEN   128
 136
 137 enum ofp_config_flags {
 138     /* Tells datapath to notify the controller of expired flow entries. */
 139     OFPC_SEND_FLOW_EXP = 1 << 0,
 140
 141     /* Handling of IP fragments. */
 142     OFPC_FRAG_NORMAL   = 0 << 1,  /* No special handling for fragments. */
 143     OFPC_FRAG_DROP     = 1 << 1,    /* Drop fragments. */
 144     OFPC_FRAG_REASM    = 2 << 1,   /* Reassemble (only if OFPC_IP_REASM set). */
 145     OFPC_FRAG_MASK     = 3 << 1
 146 };
 147
 148 /* Switch configuration. */
 149 struct ofp_switch_config {
 150     struct ofp_header header;
 151     uint16_t flags;             /* OFPC_* flags. */
 152     uint16_t miss_send_len;     /* Max bytes of new flow that datapath should
 153                                    send to the controller. */
 154 };
 155 OFP_ASSERT(sizeof(struct ofp_switch_config) == 12);
 156
 157 /* Capabilities supported by the datapath. */
 158 enum ofp_capabilities {
 159     OFPC_FLOW_STATS   = 1 << 0, /* Flow statistics. */
 160     OFPC_TABLE_STATS  = 1 << 1, /* Table statistics. */
 161     OFPC_PORT_STATS   = 1 << 2, /* Port statistics. */
 162     OFPC_STP          = 1 << 3, /* 802.11d spanning tree. */
 163     OFPC_MULTI_PHY_TX = 1 << 4, /* Supports transmitting through multiple
 164                                    physical interfaces */
 165     OFPC_IP_REASM     = 1 << 5  /* Can reassemble IP fragments. */
 166 };
 167
 168 /* Flags to indicate behavior of the physical port. */
 169 enum ofp_port_flags {
 170     /* Read/write bits. */
 171     OFPPFL_PORT_DOWN    = 1 << 1, /* Port is configured down. */
 172     OFPPFL_NO_STP       = 1 << 3, /* Disable 802.1D spanning tree on port. */
 173     OFPPFL_NO_RECV      = 1 << 4, /* Drop most packets received on port. */
 174     OFPPFL_NO_RECV_STP  = 1 << 5, /* Drop received 802.1D STP packets. */
 175     OFPPFL_NO_FWD       = 1 << 6, /* Drop packets forwarded to port. */
 176     OFPPFL_NO_PACKET_IN = 1 << 7, /* Do not send packet-in msgs for port. */
 177
 178     /* Read-only bits. */
 179     OFPPFL_LINK_DOWN    = 1 << 2, /* No physical link present. */
 180
 181     /* Read-only when STP is enabled (when OFPPFL_NO_STP is not set).
 182      * Read/write when STP is disabled (when OFPPFL_NO_STP is set).
 183      *
 184      * The OFPPFL_STP_* bits have no effect on switch operation.  The
 185      * controller must adjust OFPPFL_NO_RECV, OFPPFL_NO_FWD, and
 186      * OFPPFL_NO_PACKET_IN appropriately to fully implement an 802.1D spanning
 187      * tree. */
 188     OFPPFL_NO_FLOOD     = 1 << 0, /* Do not include this port when flooding. */
 189     OFPPFL_STP_LISTEN   = 0 << 8, /* Not learning or relaying frames. */
 190     OFPPFL_STP_LEARN    = 1 << 8, /* Learning but not relaying frames. */
 191     OFPPFL_STP_FORWARD  = 2 << 8, /* Learning and relaying frames. */
 192     OFPPFL_STP_BLOCK    = 3 << 8, /* Not part of spanning tree. */
 193     OFPPFL_STP_MASK     = 3 << 8, /* Bit mask for OFPPFL_STP_* values. */
 194 };
 195
 196 /* Features of physical ports available in a datapath. */
 197 enum ofp_port_features {
 198     OFPPF_10MB_HD    = 1 << 0, /* 10 Mb half-duplex rate support. */
 199     OFPPF_10MB_FD    = 1 << 1, /* 10 Mb full-duplex rate support. */
 200     OFPPF_100MB_HD   = 1 << 2, /* 100 Mb half-duplex rate support. */
 201     OFPPF_100MB_FD   = 1 << 3, /* 100 Mb full-duplex rate support. */
 202     OFPPF_1GB_HD     = 1 << 4, /* 1 Gb half-duplex rate support. */
 203     OFPPF_1GB_FD     = 1 << 5, /* 1 Gb full-duplex rate support. */
 204     OFPPF_10GB_FD    = 1 << 6, /* 10 Gb full-duplex rate support. */
 205     OFPPF_STP        = 1 << 7, /* 802.1D spanning tree supported on port. */
 206 };
 207
 208
 209 /* Description of a physical port */
 210 struct ofp_phy_port {
 211     uint16_t port_no;
 212     uint8_t hw_addr[OFP_ETH_ALEN];
 213     uint8_t name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
 214     uint32_t flags;         /* Bitmap of "ofp_port_flags". */
 215     uint32_t speed;         /* Current speed in Mbps */
 216     uint32_t features;      /* Bitmap of supported "ofp_port_features"s. */
 217 };
 218 OFP_ASSERT(sizeof(struct ofp_phy_port) == 36);
 219
 220 /* Switch features. */
 221 struct ofp_switch_features {
 222     struct ofp_header header;
 223     uint64_t datapath_id;   /* Datapath unique ID.  Only the lower 48-bits
 224                                are meaningful. */
 225
 226     uint32_t n_buffers;     /* Max packets buffered at once. */
 227
 228     uint8_t n_tables;       /* Number of tables supported by datapath. */
 229     uint8_t pad[3];         /* Align to 64-bits. */
 230
 231     /* Features. */
 232     uint32_t capabilities;  /* Bitmap of support "ofp_capabilities". */
 233     uint32_t actions;       /* Bitmap of supported "ofp_action_type"s. */
 234
 235     /* Port info.*/
 236     struct ofp_phy_port ports[0];  /* Port definitions.  The number of ports
 237                                       is inferred from the length field in
 238                                       the header. */
 239 };
 240 OFP_ASSERT(sizeof(struct ofp_switch_features) == 32);
 241
 242 /* What changed about the physical port */
 243 enum ofp_port_reason {
 244     OFPPR_ADD,              /* The port was added */
 245     OFPPR_DELETE,           /* The port was removed */
 246     OFPPR_MOD               /* Some attribute of the port has changed */
 247 };
 248
 249 /* A physical port has changed in the datapath */
 250 struct ofp_port_status {
 251     struct ofp_header header;
 252     uint8_t reason;          /* One of OFPPR_* */
 253     uint8_t pad[3];          /* Align to 32-bits */
 254     struct ofp_phy_port desc;
 255 };
 256 OFP_ASSERT(sizeof(struct ofp_port_status) == 48);
 257
 258 /* Modify behavior of the physical port */
 259 struct ofp_port_mod {
 260     struct ofp_header header;
 261     uint32_t mask;         /* Bitmap of "ofp_port_flags" that should be
 262                               changed. */
 263     struct ofp_phy_port desc;
 264 };
 265 OFP_ASSERT(sizeof(struct ofp_port_mod) == 48);
 266
 267 /* Why is this packet being sent to the controller? */
 268 enum ofp_packet_in_reason {
 269     OFPR_NO_MATCH,          /* No matching flow. */
 270     OFPR_ACTION             /* Action explicitly output to controller. */
 271 };
 272
 273 /* Packet received on port (datapath -> controller). */
 274 struct ofp_packet_in {
 275     struct ofp_header header;
 276     uint32_t buffer_id;     /* ID assigned by datapath. */
 277     uint16_t total_len;     /* Full length of frame. */
 278     uint16_t in_port;       /* Port on which frame was received. */
 279     uint8_t reason;         /* Reason packet is being sent (one of OFPR_*) */
 280     uint8_t pad;
 281     uint8_t data[0];        /* Ethernet frame, halfway through 32-bit word,
 282                                so the IP header is 32-bit aligned.  The
 283                                amount of data is inferred from the length
 284                                field in the header.  Because of padding,
 285                                offsetof(struct ofp_packet_in, data) ==
 286                                sizeof(struct ofp_packet_in) - 2. */
 287 };
 288 OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
 289
 290 enum ofp_action_type {
 291     OFPAT_OUTPUT,           /* Output to switch port. */
 292     OFPAT_SET_DL_VLAN,      /* VLAN. */
 293     OFPAT_SET_DL_SRC,       /* Ethernet source address. */
 294     OFPAT_SET_DL_DST,       /* Ethernet destination address. */
 295     OFPAT_SET_NW_SRC,       /* IP source address. */
 296     OFPAT_SET_NW_DST,       /* IP destination address. */
 297     OFPAT_SET_TP_SRC,       /* TCP/UDP source port. */
 298     OFPAT_SET_TP_DST        /* TCP/UDP destination port. */
 299 };
 300
 301 /* An output action sends packets out 'port'.  When the 'port' is the
 302  * OFPP_CONTROLLER, 'max_len' indicates the max number of bytes to
 303  * send.  A 'max_len' of zero means the entire packet should be sent. */
 304 struct ofp_action_output {
 305     uint16_t max_len;
 306     uint16_t port;
 307 };
 308 OFP_ASSERT(sizeof(struct ofp_action_output) == 4);
 309
 310 /* The VLAN id is 12-bits, so we'll use the entire 16 bits to indicate
 311  * special conditions.  All ones is used to indicate that no VLAN id was
 312  * set, or if used as an action, that the VLAN header should be
 313  * stripped.
 314  */
 315 #define OFP_VLAN_NONE      0xffff
 316
 317 struct ofp_action {
 318     uint16_t type;                       /* One of OFPAT_* */
 319     union {
 320         struct ofp_action_output output; /* OFPAT_OUTPUT: output struct. */
 321         uint16_t vlan_id;                /* OFPAT_SET_DL_VLAN: VLAN id. */
 322         uint8_t  dl_addr[OFP_ETH_ALEN];  /* OFPAT_SET_DL_SRC/DST */
 323         uint32_t nw_addr OFP_PACKED;     /* OFPAT_SET_NW_SRC/DST */
 324         uint16_t tp;                     /* OFPAT_SET_TP_SRC/DST */
 325     } arg;
 326 };
 327 OFP_ASSERT(sizeof(struct ofp_action) == 8);
 328
 329 /* Send packet (controller -> datapath). */
 330 struct ofp_packet_out {
 331     struct ofp_header header;
 332     uint32_t buffer_id;           /* ID assigned by datapath (-1 if none). */
 333     uint16_t in_port;             /* Packet's input port (OFPP_NONE if none). */
 334     uint16_t n_actions;           /* Number of actions. */
 335     struct ofp_action actions[0]; /* Actions. */
 336     /* uint8_t data[0]; */        /* Packet data.  The length is inferred
 337                                      from the length field in the header.
 338                                      (Only meaningful if buffer_id == -1.) */
 339 };
 340 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
 341
 342 enum ofp_flow_mod_command {
 343     OFPFC_ADD,              /* New flow. */
 344     OFPFC_MODIFY,           /* Modify all matching flows. */
 345     OFPFC_MODIFY_STRICT,    /* Strictly match wildcards and priority. */
 346     OFPFC_DELETE,           /* Delete all matching flows. */
 347     OFPFC_DELETE_STRICT     /* Strictly match wildcards and priority. */
 348 };
 349
 350 /* Flow wildcards. */
 351 enum ofp_flow_wildcards {
 352     OFPFW_IN_PORT  = 1 << 0,  /* Switch input port. */
 353     OFPFW_DL_VLAN  = 1 << 1,  /* VLAN. */
 354     OFPFW_DL_SRC   = 1 << 2,  /* Ethernet source address. */
 355     OFPFW_DL_DST   = 1 << 3,  /* Ethernet destination address. */
 356     OFPFW_DL_TYPE  = 1 << 4,  /* Ethernet frame type. */
 357     OFPFW_NW_PROTO = 1 << 5,  /* IP protocol. */
 358     OFPFW_TP_SRC   = 1 << 6,  /* TCP/UDP source port. */
 359     OFPFW_TP_DST   = 1 << 7,  /* TCP/UDP destination port. */
 360
 361     /* IP source address wildcard bit count.  0 is exact match, 1 ignores the
 362      * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
 363      * the entire field.  This is the *opposite* of the usual convention where
 364      * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
 365     OFPFW_NW_SRC_SHIFT = 8,
 366     OFPFW_NW_SRC_BITS = 6,
 367     OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
 368     OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
 369
 370     /* IP destination address wildcard bit count.  Same format as source. */
 371     OFPFW_NW_DST_SHIFT = 14,
 372     OFPFW_NW_DST_BITS = 6,
 373     OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
 374     OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
 375
 376     /* Wildcard all fields. */
 377     OFPFW_ALL = ((1 << 20) - 1)
 378 };
 379
 380 /* Values below this cutoff are 802.3 packets and the two bytes
 381  * following MAC addresses are used as a frame length.  Otherwise, the
 382  * two bytes are used as the Ethernet type.
 383  */
 384 #define OFP_DL_TYPE_ETH2_CUTOFF   0x0600
 385
 386 /* Value of dl_type to indicate that the frame does not include an
 387  * Ethernet type.
 388  */
 389 #define OFP_DL_TYPE_NOT_ETH_TYPE  0x05ff
 390
 391 /* Fields to match against flows */
 392 struct ofp_match {
 393     uint32_t wildcards;        /* Wildcard fields. */
 394     uint16_t in_port;          /* Input switch port. */
 395     uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
 396     uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
 397     uint16_t dl_vlan;          /* Input VLAN. */
 398     uint16_t dl_type;          /* Ethernet frame type. */
 399     uint8_t nw_proto;          /* IP protocol. */
 400     uint8_t pad;               /* Align to 32-bits. */
 401     uint32_t nw_src;           /* IP source address. */
 402     uint32_t nw_dst;           /* IP destination address. */
 403     uint16_t tp_src;           /* TCP/UDP source port. */
 404     uint16_t tp_dst;           /* TCP/UDP destination port. */
 405 };
 406 OFP_ASSERT(sizeof(struct ofp_match) == 36);
 407
 408 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
 409  * is permanent. */
 410 #define OFP_FLOW_PERMANENT 0
 411
 412 /* By default, choose a priority in the middle */
 413 #define OFP_DEFAULT_PRIORITY 0x8000
 414
 415 /* Flow setup and teardown (controller -> datapath). */
 416 struct ofp_flow_mod {
 417     struct ofp_header header;
 418     struct ofp_match match;      /* Fields to match */
 419
 420     /* Flow actions. */
 421     uint16_t command;             /* One of OFPFC_*. */
 422     uint16_t idle_timeout;        /* Idle time before discarding (seconds). */
 423     uint16_t hard_timeout;        /* Max time before discarding (seconds). */
 424     uint16_t priority;            /* Priority level of flow entry. */
 425     uint32_t buffer_id;           /* Buffered packet to apply to (or -1). */
 426     uint32_t reserved;            /* Reserved for future use. */
 427     struct ofp_action actions[0]; /* The number of actions is inferred from
 428                                     the length field in the header. */
 429 };
 430 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 60);
 431
 432 /* Why did this flow expire? */
 433 enum ofp_flow_expired_reason {
 434     OFPER_IDLE_TIMEOUT,         /* Flow idle time exceeded idle_timeout. */
 435     OFPER_HARD_TIMEOUT          /* Time exceeded hard_timeout. */
 436 };
 437
 438 /* Flow expiration (datapath -> controller). */
 439 struct ofp_flow_expired {
 440     struct ofp_header header;
 441     struct ofp_match match;   /* Description of fields */
 442
 443     uint16_t priority;        /* Priority level of flow entry. */
 444     uint8_t reason;           /* One of OFPER_*. */
 445     uint8_t pad[1];           /* Align to 32-bits. */
 446
 447     uint32_t duration;        /* Time flow was alive in seconds. */
 448     uint8_t pad2[4];          /* Align to 64-bits. */
 449     uint64_t packet_count;
 450     uint64_t byte_count;
 451 };
 452 OFP_ASSERT(sizeof(struct ofp_flow_expired) == 72);
 453
 454 /* Error message (datapath -> controller). */
 455 struct ofp_error_msg {
 456     struct ofp_header header;
 457
 458     uint16_t type;
 459     uint16_t code;
 460     uint8_t data[0];          /* Variable-length data.  Interpreted based
 461                                  on the type and code. */
 462 };
 463 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
 464
 465 enum ofp_stats_types {
 466     /* Description of this OpenFlow switch.
 467      * The request body is empty.
 468      * The reply body is struct ofp_desc_stats. */
 469     OFPST_DESC,
 470
 471     /* Individual flow statistics.
 472      * The request body is struct ofp_flow_stats_request.
 473      * The reply body is an array of struct ofp_flow_stats. */
 474     OFPST_FLOW,
 475
 476     /* Aggregate flow statistics.
 477      * The request body is struct ofp_aggregate_stats_request.
 478      * The reply body is struct ofp_aggregate_stats_reply. */
 479     OFPST_AGGREGATE,
 480
 481     /* Flow table statistics.
 482      * The request body is empty.
 483      * The reply body is an array of struct ofp_table_stats. */
 484     OFPST_TABLE,
 485
 486     /* Physical port statistics.
 487      * The request body is empty.
 488      * The reply body is an array of struct ofp_port_stats. */
 489     OFPST_PORT,
 490
 491     /* Switch status.
 492      * The request body is an ASCII string that specifies a prefix of the key
 493      * names to include in the output; if it is the null string, then all
 494      * key-value pairs are included.
 495      * The reply body is an ASCII string of key-value pairs in the form
 496      * "key=value\n". */
 497     OFPST_SWITCH,
 498
 499     /* Vendor extension.
 500      * The request and reply bodies begin with a 32-bit vendor ID, which takes
 501      * the same form as in "struct ofp_vendor".  The request and reply bodies
 502      * are otherwise vendor-defined. */
 503     OFPST_VENDOR = 0xffff
 504 };
 505
 506 struct ofp_stats_request {
 507     struct ofp_header header;
 508     uint16_t type;              /* One of the OFPST_* constants. */
 509     uint16_t flags;             /* OFPSF_REQ_* flags (none yet defined). */
 510     uint8_t body[0];            /* Body of the request. */
 511 };
 512 OFP_ASSERT(sizeof(struct ofp_stats_request) == 12);
 513
 514 enum ofp_stats_reply_flags {
 515     OFPSF_REPLY_MORE  = 1 << 0, /* More replies to follow */
 516 };
 517
 518 struct ofp_stats_reply {
 519     struct ofp_header header;
 520     uint16_t type;              /* One of the OFPST_* constants. */
 521     uint16_t flags;             /* OFPSF_REPLY_* flags. */
 522     uint8_t body[0];            /* Body of the reply. */
 523 };
 524 OFP_ASSERT(sizeof(struct ofp_stats_reply) == 12);
 525
 526 #define DESC_STR_LEN   256
 527 #define SERIAL_NUM_LEN 32
 528 /* Body of reply to OFPST_DESC request.  Each entry is a NULL-terminated
 529  * ASCII string. */
 530 struct ofp_desc_stats {
 531     char mfr_desc[DESC_STR_LEN];       /* Manufacturer description. */
 532     char hw_desc[DESC_STR_LEN];        /* Hardware description. */
 533     char sw_desc[DESC_STR_LEN];        /* Software description. */
 534     char serial_num[SERIAL_NUM_LEN];   /* Serial number. */
 535 };
 536 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 800);
 537
 538 /* Body for ofp_stats_request of type OFPST_FLOW. */
 539 struct ofp_flow_stats_request {
 540     struct ofp_match match;   /* Fields to match */
 541     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
 542                                  or 0xff for all tables. */
 543     uint8_t pad[3];           /* Align to 32 bits. */
 544 };
 545 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 40);
 546
 547 /* Body of reply to OFPST_FLOW request. */
 548 struct ofp_flow_stats {
 549     uint16_t length;          /* Length of this entry. */
 550     uint8_t table_id;         /* ID of table flow came from. */
 551     uint8_t pad;
 552     struct ofp_match match;   /* Description of fields. */
 553     uint32_t duration;        /* Time flow has been alive in seconds. */
 554     uint16_t priority;        /* Priority of the entry. Only meaningful
 555                                  when this is not an exact-match entry. */
 556     uint16_t idle_timeout;    /* Number of seconds idle before expiration. */
 557     uint16_t hard_timeout;    /* Number of seconds before expiration. */
 558     uint16_t pad2[3];         /* Pad to 64 bits. */
 559     uint64_t packet_count;    /* Number of packets in flow. */
 560     uint64_t byte_count;      /* Number of bytes in flow. */
 561     struct ofp_action actions[0]; /* Actions. */
 562 };
 563 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 72);
 564
 565 /* Body for ofp_stats_request of type OFPST_AGGREGATE. */
 566 struct ofp_aggregate_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_aggregate_stats_request) == 40);
 573
 574 /* Body of reply to OFPST_AGGREGATE request. */
 575 struct ofp_aggregate_stats_reply {
 576     uint64_t packet_count;    /* Number of packets in flows. */
 577     uint64_t byte_count;      /* Number of bytes in flows. */
 578     uint32_t flow_count;      /* Number of flows. */
 579     uint8_t pad[4];           /* Align to 64 bits. */
 580 };
 581 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
 582
 583 /* Body of reply to OFPST_TABLE request. */
 584 struct ofp_table_stats {
 585     uint8_t table_id;        /* Identifier of table.  Lower numbered tables
 586                                 are consulted first. */
 587     uint8_t pad[3];          /* Align to 32-bits */
 588     char name[OFP_MAX_TABLE_NAME_LEN];
 589     uint32_t wildcards;      /* Bitmap of OFPFW_* wildcards that are
 590                                 supported by the table. */
 591     uint32_t max_entries;    /* Max number of entries supported */
 592     uint32_t active_count;   /* Number of active entries */
 593     uint64_t matched_count;  /* Number of packets that hit table */
 594 };
 595 OFP_ASSERT(sizeof(struct ofp_table_stats) == 56);
 596
 597 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
 598  * the field to all ones. */
 599 struct ofp_port_stats {
 600     uint16_t port_no;
 601     uint8_t pad[6];          /* Align to 64-bits. */
 602     uint64_t rx_packets;     /* Number of received packets. */
 603     uint64_t tx_packets;     /* Number of transmitted packets. */
 604     uint64_t rx_bytes;       /* Number of received bytes. */
 605     uint64_t tx_bytes;       /* Number of transmitted bytes. */
 606     uint64_t rx_dropped;     /* Number of packets dropped by RX. */
 607     uint64_t tx_dropped;     /* Number of packets dropped by TX. */
 608     uint64_t rx_errors;      /* Number of receive errors.  This is a super-set
 609                                 of receive errors and should be great than or
 610                                 equal to the sum of al rx_*_err values. */
 611     uint64_t tx_errors;      /* Number of transmit errors.  This is a super-set
 612                                 of transmit errors. */
 613     uint64_t rx_frame_err;   /* Number of frame alignment errors. */
 614     uint64_t rx_over_err;    /* Number of packets with RX overrun. */
 615     uint64_t rx_crc_err;     /* Number of CRC errors. */
 616     uint64_t collisions;     /* Number of collisions. */
 617 };
 618 OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
 619
 620 /* Vendor extension. */
 621 struct ofp_vendor {
 622     struct ofp_header header;   /* Type OFPT_VENDOR. */
 623     uint32_t vendor;            /* Vendor ID:
 624                                  * - MSB 0: low-order bytes are Ethernet OUI.
 625                                  * - MSB != 0: defined by OpenFlow
 626                                  *   consortium. */
 627     /* Vendor-defined arbitrary additional data. */
 628 };
 629 OFP_ASSERT(sizeof(struct ofp_vendor) == 12);
 630
 631 #endif /* openflow.h */