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