include/openflow/openflow-1.0.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /* OpenFlow: protocol between controller and datapath. */
  18
  19 #ifndef OPENFLOW_OPENFLOW10_H
  20 #define OPENFLOW_OPENFLOW10_H 1
  21
  22 #include "openflow/openflow-common.h"
  23
  24 /* Port numbering.  Physical ports are numbered starting from 1. */
  25 enum ofp_port {
  26     /* Maximum number of physical switch ports. */
  27     OFPP_MAX = 0xff00,
  28
  29     /* Fake output "ports". */
  30     OFPP_IN_PORT    = 0xfff8,  /* Send the packet out the input port.  This
  31                                   virtual port must be explicitly used
  32                                   in order to send back out of the input
  33                                   port. */
  34     OFPP_TABLE      = 0xfff9,  /* Perform actions in flow table.
  35                                   NB: This can only be the destination
  36                                   port for packet-out messages. */
  37     OFPP_NORMAL     = 0xfffa,  /* Process with normal L2/L3 switching. */
  38     OFPP_FLOOD      = 0xfffb,  /* All physical ports except input port and
  39                                   those disabled by STP. */
  40     OFPP_ALL        = 0xfffc,  /* All physical ports except input port. */
  41     OFPP_CONTROLLER = 0xfffd,  /* Send to controller. */
  42     OFPP_LOCAL      = 0xfffe,  /* Local openflow "port". */
  43     OFPP_NONE       = 0xffff   /* Not associated with a physical port. */
  44 };
  45
  46 /* OpenFlow 1.0 specific message types, in addition to the common message
  47  * types. */
  48 enum ofp10_type {
  49     /* Controller command messages. */
  50     OFPT10_PACKET_OUT = 13,     /* Controller/switch message */
  51     OFPT10_FLOW_MOD,            /* Controller/switch message */
  52     OFPT10_PORT_MOD,            /* Controller/switch message */
  53
  54     /* Statistics messages. */
  55     OFPT10_STATS_REQUEST,       /* Controller/switch message */
  56     OFPT10_STATS_REPLY,         /* Controller/switch message */
  57
  58     /* Barrier messages. */
  59     OFPT10_BARRIER_REQUEST,     /* Controller/switch message */
  60     OFPT10_BARRIER_REPLY,       /* Controller/switch message */
  61
  62     /* Queue Configuration messages. */
  63     OFPT10_QUEUE_GET_CONFIG_REQUEST,  /* Controller/switch message */
  64     OFPT10_QUEUE_GET_CONFIG_REPLY     /* Controller/switch message */
  65 };
  66
  67 /* OFPT_HELLO.  This message has an empty body, but implementations must
  68  * ignore any data included in the body, to allow for future extensions. */
  69 struct ofp_hello {
  70     struct ofp_header header;
  71 };
  72
  73 #define OFP_DEFAULT_MISS_SEND_LEN   128
  74
  75 enum ofp_config_flags {
  76     /* Handling of IP fragments. */
  77     OFPC_FRAG_NORMAL   = 0,  /* No special handling for fragments. */
  78     OFPC_FRAG_DROP     = 1,  /* Drop fragments. */
  79     OFPC_FRAG_REASM    = 2,  /* Reassemble (only if OFPC_IP_REASM set). */
  80     OFPC_FRAG_NX_MATCH = 3,  /* Make first fragments available for matching. */
  81     OFPC_FRAG_MASK     = 3,
  82
  83     /* TTL processing - applicable for IP and MPLS packets. */
  84     OFPC_INVALID_TTL_TO_CONTROLLER = 1 << 2, /* Send packets with invalid TTL
  85                                                 to the controller. */
  86 };
  87
  88 /* Switch configuration. */
  89 struct ofp_switch_config {
  90     struct ofp_header header;
  91     ovs_be16 flags;             /* OFPC_* flags. */
  92     ovs_be16 miss_send_len;     /* Max bytes of new flow that datapath should
  93                                    send to the controller. */
  94 };
  95 OFP_ASSERT(sizeof(struct ofp_switch_config) == 12);
  96
  97 /* OpenFlow 1.0 specific capabilities supported by the datapath (struct
  98  * ofp_switch_features, member capabilities). */
  99 enum ofp10_capabilities {
 100     OFPC10_STP            = 1 << 3,  /* 802.1d spanning tree. */
 101     OFPC10_RESERVED       = 1 << 4,  /* Reserved, must not be set. */
 102 };
 103
 104 /* OpenFlow 1.0 specific flags to indicate behavior of the physical port.
 105  * These flags are used in ofp10_phy_port to describe the current
 106  * configuration.  They are used in the ofp10_port_mod message to configure the
 107  * port's behavior.
 108  */
 109 enum ofp10_port_config {
 110     OFPPC10_NO_STP       = 1 << 1, /* Disable 802.1D spanning tree on port. */
 111     OFPPC10_NO_RECV_STP  = 1 << 3, /* Drop received 802.1D STP packets. */
 112     OFPPC10_NO_FLOOD     = 1 << 4, /* Do not include port when flooding. */
 113 #define OFPPC10_ALL (OFPPC_PORT_DOWN | OFPPC10_NO_STP | OFPPC_NO_RECV | \
 114                      OFPPC10_NO_RECV_STP | OFPPC10_NO_FLOOD | OFPPC_NO_FWD | \
 115                      OFPPC_NO_PACKET_IN)
 116 };
 117
 118 /* OpenFlow 1.0 specific current state of the physical port.  These are not
 119  * configurable from the controller.
 120  */
 121 enum ofp10_port_state {
 122     /* The OFPPS10_STP_* bits have no effect on switch operation.  The
 123      * controller must adjust OFPPC_NO_RECV, OFPPC_NO_FWD, and
 124      * OFPPC_NO_PACKET_IN appropriately to fully implement an 802.1D spanning
 125      * tree. */
 126     OFPPS10_STP_LISTEN  = 0 << 8, /* Not learning or relaying frames. */
 127     OFPPS10_STP_LEARN   = 1 << 8, /* Learning but not relaying frames. */
 128     OFPPS10_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
 129     OFPPS10_STP_BLOCK   = 3 << 8, /* Not part of spanning tree. */
 130     OFPPS10_STP_MASK    = 3 << 8  /* Bit mask for OFPPS10_STP_* values. */
 131
 132 #define OFPPS10_ALL (OFPPS_LINK_DOWN | OFPPS10_STP_MASK)
 133 };
 134
 135 /* OpenFlow 1.0 specific features of physical ports available in a datapath. */
 136 enum ofp10_port_features {
 137     OFPPF10_COPPER     = 1 << 7,  /* Copper medium. */
 138     OFPPF10_FIBER      = 1 << 8,  /* Fiber medium. */
 139     OFPPF10_AUTONEG    = 1 << 9,  /* Auto-negotiation. */
 140     OFPPF10_PAUSE      = 1 << 10, /* Pause. */
 141     OFPPF10_PAUSE_ASYM = 1 << 11  /* Asymmetric pause. */
 142 };
 143
 144 /* Description of a physical port */
 145 struct ofp10_phy_port {
 146     ovs_be16 port_no;
 147     uint8_t hw_addr[OFP_ETH_ALEN];
 148     char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
 149
 150     ovs_be32 config;        /* Bitmap of OFPPC_* and OFPPC10_* flags. */
 151     ovs_be32 state;         /* Bitmap of OFPPS_* and OFPPS10_* flags. */
 152
 153     /* Bitmaps of OFPPF_* and OFPPF10_* that describe features.  All bits
 154      * zeroed if unsupported or unavailable. */
 155     ovs_be32 curr;          /* Current features. */
 156     ovs_be32 advertised;    /* Features being advertised by the port. */
 157     ovs_be32 supported;     /* Features supported by the port. */
 158     ovs_be32 peer;          /* Features advertised by peer. */
 159 };
 160 OFP_ASSERT(sizeof(struct ofp10_phy_port) == 48);
 161
 162 /* Modify behavior of the physical port */
 163 struct ofp10_port_mod {
 164     struct ofp_header header;
 165     ovs_be16 port_no;
 166     uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
 167                                       configurable.  This is used to
 168                                       sanity-check the request, so it must
 169                                       be the same as returned in an
 170                                       ofp10_phy_port struct. */
 171
 172     ovs_be32 config;        /* Bitmap of OFPPC_* flags. */
 173     ovs_be32 mask;          /* Bitmap of OFPPC_* flags to be changed. */
 174
 175     ovs_be32 advertise;     /* Bitmap of "ofp_port_features"s.  Zero all
 176                                bits to prevent any action taking place. */
 177     uint8_t pad[4];         /* Pad to 64-bits. */
 178 };
 179 OFP_ASSERT(sizeof(struct ofp10_port_mod) == 32);
 180
 181 /* Packet received on port (datapath -> controller). */
 182 struct ofp_packet_in {
 183     struct ofp_header header;
 184     ovs_be32 buffer_id;     /* ID assigned by datapath. */
 185     ovs_be16 total_len;     /* Full length of frame. */
 186     ovs_be16 in_port;       /* Port on which frame was received. */
 187     uint8_t reason;         /* Reason packet is being sent (one of OFPR_*) */
 188     uint8_t pad;
 189     uint8_t data[0];        /* Ethernet frame, halfway through 32-bit word,
 190                                so the IP header is 32-bit aligned.  The
 191                                amount of data is inferred from the length
 192                                field in the header.  Because of padding,
 193                                offsetof(struct ofp_packet_in, data) ==
 194                                sizeof(struct ofp_packet_in) - 2. */
 195 };
 196 OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
 197
 198 enum ofp10_action_type {
 199     OFPAT10_OUTPUT,             /* Output to switch port. */
 200     OFPAT10_SET_VLAN_VID,       /* Set the 802.1q VLAN id. */
 201     OFPAT10_SET_VLAN_PCP,       /* Set the 802.1q priority. */
 202     OFPAT10_STRIP_VLAN,         /* Strip the 802.1q header. */
 203     OFPAT10_SET_DL_SRC,         /* Ethernet source address. */
 204     OFPAT10_SET_DL_DST,         /* Ethernet destination address. */
 205     OFPAT10_SET_NW_SRC,         /* IP source address. */
 206     OFPAT10_SET_NW_DST,         /* IP destination address. */
 207     OFPAT10_SET_NW_TOS,         /* IP ToS (DSCP field, 6 bits). */
 208     OFPAT10_SET_TP_SRC,         /* TCP/UDP source port. */
 209     OFPAT10_SET_TP_DST,         /* TCP/UDP destination port. */
 210     OFPAT10_ENQUEUE,            /* Output to queue. */
 211     OFPAT10_VENDOR = 0xffff
 212 };
 213
 214 /* Action structure for OFPAT10_OUTPUT, which sends packets out 'port'.
 215  * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
 216  * number of bytes to send.  A 'max_len' of zero means no bytes of the
 217  * packet should be sent. */
 218 struct ofp_action_output {
 219     ovs_be16 type;                  /* OFPAT10_OUTPUT. */
 220     ovs_be16 len;                   /* Length is 8. */
 221     ovs_be16 port;                  /* Output port. */
 222     ovs_be16 max_len;               /* Max length to send to controller. */
 223 };
 224 OFP_ASSERT(sizeof(struct ofp_action_output) == 8);
 225
 226 /* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate
 227  * special conditions.  All ones is used to match that no VLAN id was
 228  * set. */
 229 #define OFP_VLAN_NONE      0xffff
 230
 231 /* Action structure for OFPAT10_SET_VLAN_VID. */
 232 struct ofp_action_vlan_vid {
 233     ovs_be16 type;                  /* OFPAT10_SET_VLAN_VID. */
 234     ovs_be16 len;                   /* Length is 8. */
 235     ovs_be16 vlan_vid;              /* VLAN id. */
 236     uint8_t pad[2];
 237 };
 238 OFP_ASSERT(sizeof(struct ofp_action_vlan_vid) == 8);
 239
 240 /* Action structure for OFPAT10_SET_VLAN_PCP. */
 241 struct ofp_action_vlan_pcp {
 242     ovs_be16 type;                  /* OFPAT10_SET_VLAN_PCP. */
 243     ovs_be16 len;                   /* Length is 8. */
 244     uint8_t vlan_pcp;               /* VLAN priority. */
 245     uint8_t pad[3];
 246 };
 247 OFP_ASSERT(sizeof(struct ofp_action_vlan_pcp) == 8);
 248
 249 /* Action structure for OFPAT10_SET_DL_SRC/DST. */
 250 struct ofp_action_dl_addr {
 251     ovs_be16 type;                  /* OFPAT10_SET_DL_SRC/DST. */
 252     ovs_be16 len;                   /* Length is 16. */
 253     uint8_t dl_addr[OFP_ETH_ALEN];  /* Ethernet address. */
 254     uint8_t pad[6];
 255 };
 256 OFP_ASSERT(sizeof(struct ofp_action_dl_addr) == 16);
 257
 258 /* Action structure for OFPAT10_SET_NW_SRC/DST. */
 259 struct ofp_action_nw_addr {
 260     ovs_be16 type;                  /* OFPAT10_SET_TW_SRC/DST. */
 261     ovs_be16 len;                   /* Length is 8. */
 262     ovs_be32 nw_addr;               /* IP address. */
 263 };
 264 OFP_ASSERT(sizeof(struct ofp_action_nw_addr) == 8);
 265
 266 /* Action structure for OFPAT10_SET_NW_TOS. */
 267 struct ofp_action_nw_tos {
 268     ovs_be16 type;                  /* OFPAT10_SET_TW_TOS. */
 269     ovs_be16 len;                   /* Length is 8. */
 270     uint8_t nw_tos;                 /* IP TOS (DSCP field, 6 bits). */
 271     uint8_t pad[3];
 272 };
 273 OFP_ASSERT(sizeof(struct ofp_action_nw_tos) == 8);
 274
 275 /* Action structure for OFPAT10_SET_TP_SRC/DST. */
 276 struct ofp_action_tp_port {
 277     ovs_be16 type;                  /* OFPAT10_SET_TP_SRC/DST. */
 278     ovs_be16 len;                   /* Length is 8. */
 279     ovs_be16 tp_port;               /* TCP/UDP port. */
 280     uint8_t pad[2];
 281 };
 282 OFP_ASSERT(sizeof(struct ofp_action_tp_port) == 8);
 283
 284 /* Action header for OFPAT10_VENDOR. The rest of the body is vendor-defined. */
 285 struct ofp_action_vendor_header {
 286     ovs_be16 type;                  /* OFPAT10_VENDOR. */
 287     ovs_be16 len;                   /* Length is a multiple of 8. */
 288     ovs_be32 vendor;                /* Vendor ID, which takes the same form
 289                                        as in "struct ofp_vendor_header". */
 290 };
 291 OFP_ASSERT(sizeof(struct ofp_action_vendor_header) == 8);
 292
 293 /* Action header that is common to all actions.  The length includes the
 294  * header and any padding used to make the action 64-bit aligned.
 295  * NB: The length of an action *must* always be a multiple of eight. */
 296 struct ofp_action_header {
 297     ovs_be16 type;                  /* One of OFPAT10_*. */
 298     ovs_be16 len;                   /* Length of action, including this
 299                                        header.  This is the length of action,
 300                                        including any padding to make it
 301                                        64-bit aligned. */
 302     uint8_t pad[4];
 303 };
 304 OFP_ASSERT(sizeof(struct ofp_action_header) == 8);
 305
 306 /* OFPAT10_ENQUEUE action struct: send packets to given queue on port. */
 307 struct ofp_action_enqueue {
 308     ovs_be16 type;            /* OFPAT10_ENQUEUE. */
 309     ovs_be16 len;             /* Len is 16. */
 310     ovs_be16 port;            /* Port that queue belongs. Should
 311                                  refer to a valid physical port
 312                                  (i.e. < OFPP_MAX) or OFPP_IN_PORT. */
 313     uint8_t pad[6];           /* Pad for 64-bit alignment. */
 314     ovs_be32 queue_id;        /* Where to enqueue the packets. */
 315 };
 316 OFP_ASSERT(sizeof(struct ofp_action_enqueue) == 16);
 317
 318 union ofp_action {
 319     ovs_be16 type;
 320     struct ofp_action_header header;
 321     struct ofp_action_vendor_header vendor;
 322     struct ofp_action_output output;
 323     struct ofp_action_vlan_vid vlan_vid;
 324     struct ofp_action_vlan_pcp vlan_pcp;
 325     struct ofp_action_nw_addr nw_addr;
 326     struct ofp_action_nw_tos nw_tos;
 327     struct ofp_action_tp_port tp_port;
 328 };
 329 OFP_ASSERT(sizeof(union ofp_action) == 8);
 330
 331 /* Send packet (controller -> datapath). */
 332 struct ofp_packet_out {
 333     struct ofp_header header;
 334     ovs_be32 buffer_id;           /* ID assigned by datapath or UINT32_MAX. */
 335     ovs_be16 in_port;             /* Packet's input port (OFPP_NONE if none). */
 336     ovs_be16 actions_len;         /* Size of action array in bytes. */
 337     /* Followed by:
 338      *   - Exactly 'actions_len' bytes (possibly 0 bytes, and always a multiple
 339      *     of 8) containing actions.
 340      *   - If 'buffer_id' == UINT32_MAX, packet data to fill out the remainder
 341      *     of the message length.
 342      */
 343 };
 344 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
 345
 346 enum ofp_flow_mod_command {
 347     OFPFC_ADD,              /* New flow. */
 348     OFPFC_MODIFY,           /* Modify all matching flows. */
 349     OFPFC_MODIFY_STRICT,    /* Modify entry strictly matching wildcards */
 350     OFPFC_DELETE,           /* Delete all matching flows. */
 351     OFPFC_DELETE_STRICT     /* Strictly match wildcards and priority. */
 352 };
 353
 354 /* Flow wildcards. */
 355 enum ofp_flow_wildcards {
 356     OFPFW_IN_PORT    = 1 << 0,  /* Switch input port. */
 357     OFPFW_DL_VLAN    = 1 << 1,  /* VLAN vid. */
 358     OFPFW_DL_SRC     = 1 << 2,  /* Ethernet source address. */
 359     OFPFW_DL_DST     = 1 << 3,  /* Ethernet destination address. */
 360     OFPFW_DL_TYPE    = 1 << 4,  /* Ethernet frame type. */
 361     OFPFW_NW_PROTO   = 1 << 5,  /* IP protocol. */
 362     OFPFW_TP_SRC     = 1 << 6,  /* TCP/UDP source port. */
 363     OFPFW_TP_DST     = 1 << 7,  /* TCP/UDP destination port. */
 364
 365     /* IP source address wildcard bit count.  0 is exact match, 1 ignores the
 366      * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
 367      * the entire field.  This is the *opposite* of the usual convention where
 368      * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
 369     OFPFW_NW_SRC_SHIFT = 8,
 370     OFPFW_NW_SRC_BITS = 6,
 371     OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
 372     OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
 373
 374     /* IP destination address wildcard bit count.  Same format as source. */
 375     OFPFW_NW_DST_SHIFT = 14,
 376     OFPFW_NW_DST_BITS = 6,
 377     OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
 378     OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
 379
 380     OFPFW_DL_VLAN_PCP = 1 << 20, /* VLAN priority. */
 381     OFPFW_NW_TOS = 1 << 21, /* IP ToS (DSCP field, 6 bits). */
 382
 383     /* Wildcard all fields. */
 384     OFPFW_ALL = ((1 << 22) - 1)
 385 };
 386
 387 /* The wildcards for ICMP type and code fields use the transport source
 388  * and destination port fields, respectively. */
 389 #define OFPFW_ICMP_TYPE OFPFW_TP_SRC
 390 #define OFPFW_ICMP_CODE OFPFW_TP_DST
 391
 392 /* Values below this cutoff are 802.3 packets and the two bytes
 393  * following MAC addresses are used as a frame length.  Otherwise, the
 394  * two bytes are used as the Ethernet type.
 395  */
 396 #define OFP_DL_TYPE_ETH2_CUTOFF   0x0600
 397
 398 /* Value of dl_type to indicate that the frame does not include an
 399  * Ethernet type.
 400  */
 401 #define OFP_DL_TYPE_NOT_ETH_TYPE  0x05ff
 402
 403 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
 404  * special conditions.  All ones indicates that no VLAN id was set.
 405  */
 406 #define OFP_VLAN_NONE      0xffff
 407
 408 /* Fields to match against flows */
 409 struct ofp_match {
 410     ovs_be32 wildcards;        /* Wildcard fields. */
 411     ovs_be16 in_port;          /* Input switch port. */
 412     uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
 413     uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
 414     ovs_be16 dl_vlan;          /* Input VLAN. */
 415     uint8_t dl_vlan_pcp;       /* Input VLAN priority. */
 416     uint8_t pad1[1];           /* Align to 64-bits. */
 417     ovs_be16 dl_type;          /* Ethernet frame type. */
 418     uint8_t nw_tos;            /* IP ToS (DSCP field, 6 bits). */
 419     uint8_t nw_proto;          /* IP protocol or lower 8 bits of
 420                                   ARP opcode. */
 421     uint8_t pad2[2];           /* Align to 64-bits. */
 422     ovs_be32 nw_src;           /* IP source address. */
 423     ovs_be32 nw_dst;           /* IP destination address. */
 424     ovs_be16 tp_src;           /* TCP/UDP source port. */
 425     ovs_be16 tp_dst;           /* TCP/UDP destination port. */
 426 };
 427 OFP_ASSERT(sizeof(struct ofp_match) == 40);
 428
 429 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
 430  * is permanent. */
 431 #define OFP_FLOW_PERMANENT 0
 432
 433 /* By default, choose a priority in the middle. */
 434 #define OFP_DEFAULT_PRIORITY 0x8000
 435
 436 enum ofp_flow_mod_flags {
 437     OFPFF_SEND_FLOW_REM = 1 << 0,  /* Send flow removed message when flow
 438                                     * expires or is deleted. */
 439     OFPFF_CHECK_OVERLAP = 1 << 1,  /* Check for overlapping entries first. */
 440     OFPFF_EMERG         = 1 << 2   /* Ramark this is for emergency. */
 441 };
 442
 443 /* Flow setup and teardown (controller -> datapath). */
 444 struct ofp_flow_mod {
 445     struct ofp_header header;
 446     struct ofp_match match;      /* Fields to match */
 447     ovs_be64 cookie;             /* Opaque controller-issued identifier. */
 448
 449     /* Flow actions. */
 450     ovs_be16 command;             /* One of OFPFC_*. */
 451     ovs_be16 idle_timeout;        /* Idle time before discarding (seconds). */
 452     ovs_be16 hard_timeout;        /* Max time before discarding (seconds). */
 453     ovs_be16 priority;            /* Priority level of flow entry. */
 454     ovs_be32 buffer_id;           /* Buffered packet to apply to (or -1).
 455                                      Not meaningful for OFPFC_DELETE*. */
 456     ovs_be16 out_port;            /* For OFPFC_DELETE* commands, require
 457                                      matching entries to include this as an
 458                                      output port.  A value of OFPP_NONE
 459                                      indicates no restriction. */
 460     ovs_be16 flags;               /* One of OFPFF_*. */
 461     struct ofp_action_header actions[0]; /* The action length is inferred
 462                                             from the length field in the
 463                                             header. */
 464 };
 465 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 72);
 466
 467 /* Flow removed (datapath -> controller). */
 468 struct ofp_flow_removed {
 469     struct ofp_header header;
 470     struct ofp_match match;   /* Description of fields. */
 471     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
 472
 473     ovs_be16 priority;        /* Priority level of flow entry. */
 474     uint8_t reason;           /* One of OFPRR_*. */
 475     uint8_t pad[1];           /* Align to 32-bits. */
 476
 477     ovs_be32 duration_sec;    /* Time flow was alive in seconds. */
 478     ovs_be32 duration_nsec;   /* Time flow was alive in nanoseconds beyond
 479                                  duration_sec. */
 480     ovs_be16 idle_timeout;    /* Idle timeout from original flow mod. */
 481     uint8_t pad2[2];          /* Align to 64-bits. */
 482     ovs_be64 packet_count;
 483     ovs_be64 byte_count;
 484 };
 485 OFP_ASSERT(sizeof(struct ofp_flow_removed) == 88);
 486
 487 /* OFPT_ERROR: Error message (datapath -> controller). */
 488 struct ofp_error_msg {
 489     struct ofp_header header;
 490
 491     ovs_be16 type;
 492     ovs_be16 code;
 493     uint8_t data[0];          /* Variable-length data.  Interpreted based
 494                                  on the type and code. */
 495 };
 496 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
 497
 498 enum ofp_stats_types {
 499     /* Description of this OpenFlow switch.
 500      * The request is struct ofp_stats_msg.
 501      * The reply is struct ofp_desc_stats. */
 502     OFPST_DESC,
 503
 504     /* Individual flow statistics.
 505      * The request is struct ofp_flow_stats_request.
 506      * The reply body is an array of struct ofp_flow_stats. */
 507     OFPST_FLOW,
 508
 509     /* Aggregate flow statistics.
 510      * The request is struct ofp_flow_stats_request.
 511      * The reply is struct ofp_aggregate_stats_reply. */
 512     OFPST_AGGREGATE,
 513
 514     /* Flow table statistics.
 515      * The request is struct ofp_stats_msg.
 516      * The reply body is an array of struct ofp_table_stats. */
 517     OFPST_TABLE,
 518
 519     /* Physical port statistics.
 520      * The request is struct ofp_port_stats_request.
 521      * The reply body is an array of struct ofp_port_stats. */
 522     OFPST_PORT,
 523
 524     /* Queue statistics for a port.
 525      * The request body is struct ofp_queue_stats_request.
 526      * The reply body is an array of struct ofp_queue_stats. */
 527     OFPST_QUEUE,
 528
 529     /* Vendor extension.
 530      * The request and reply begin with "struct ofp_vendor_stats". */
 531     OFPST_VENDOR = 0xffff
 532 };
 533
 534 /* Statistics request or reply message. */
 535 struct ofp_stats_msg {
 536     struct ofp_header header;
 537     ovs_be16 type;              /* One of the OFPST_* constants. */
 538     ovs_be16 flags;             /* Requests: always 0.
 539                                  * Replies: 0 or OFPSF_REPLY_MORE. */
 540 };
 541 OFP_ASSERT(sizeof(struct ofp_stats_msg) == 12);
 542
 543 enum ofp_stats_reply_flags {
 544     OFPSF_REPLY_MORE  = 1 << 0  /* More replies to follow. */
 545 };
 546
 547 #define DESC_STR_LEN   256
 548 #define SERIAL_NUM_LEN 32
 549 /* Reply to OFPST_DESC request.  Each entry is a NULL-terminated ASCII
 550  * string. */
 551 struct ofp_desc_stats {
 552     struct ofp_stats_msg osm;
 553     char mfr_desc[DESC_STR_LEN];       /* Manufacturer description. */
 554     char hw_desc[DESC_STR_LEN];        /* Hardware description. */
 555     char sw_desc[DESC_STR_LEN];        /* Software description. */
 556     char serial_num[SERIAL_NUM_LEN];   /* Serial number. */
 557     char dp_desc[DESC_STR_LEN];        /* Human readable description of
 558                                           the datapath. */
 559 };
 560 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 1068);
 561
 562 /* Stats request of type OFPST_AGGREGATE or OFPST_FLOW. */
 563 struct ofp_flow_stats_request {
 564     struct ofp_stats_msg osm;
 565     struct ofp_match match;   /* Fields to match. */
 566     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
 567                                  or 0xff for all tables. */
 568     uint8_t pad;              /* Align to 32 bits. */
 569     ovs_be16 out_port;        /* Require matching entries to include this
 570                                  as an output port.  A value of OFPP_NONE
 571                                  indicates no restriction. */
 572 };
 573 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 56);
 574
 575 /* Body of reply to OFPST_FLOW request. */
 576 struct ofp_flow_stats {
 577     ovs_be16 length;          /* Length of this entry. */
 578     uint8_t table_id;         /* ID of table flow came from. */
 579     uint8_t pad;
 580     struct ofp_match match;   /* Description of fields. */
 581     ovs_be32 duration_sec;    /* Time flow has been alive in seconds. */
 582     ovs_be32 duration_nsec;   /* Time flow has been alive in nanoseconds
 583                                  beyond duration_sec. */
 584     ovs_be16 priority;        /* Priority of the entry. Only meaningful
 585                                  when this is not an exact-match entry. */
 586     ovs_be16 idle_timeout;    /* Number of seconds idle before expiration. */
 587     ovs_be16 hard_timeout;    /* Number of seconds before expiration. */
 588     uint8_t pad2[6];          /* Align to 64 bits. */
 589     ovs_32aligned_be64 cookie;       /* Opaque controller-issued identifier. */
 590     ovs_32aligned_be64 packet_count; /* Number of packets in flow. */
 591     ovs_32aligned_be64 byte_count;   /* Number of bytes in flow. */
 592     struct ofp_action_header actions[0]; /* Actions. */
 593 };
 594 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 88);
 595
 596 /* Reply to OFPST_AGGREGATE request. */
 597 struct ofp_aggregate_stats_reply {
 598     struct ofp_stats_msg osm;
 599     ovs_32aligned_be64 packet_count; /* Number of packets in flows. */
 600     ovs_32aligned_be64 byte_count;   /* Number of bytes in flows. */
 601     ovs_be32 flow_count;      /* Number of flows. */
 602     uint8_t pad[4];           /* Align to 64 bits. */
 603 };
 604 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 36);
 605
 606 /* Body of reply to OFPST_TABLE request. */
 607 struct ofp_table_stats {
 608     uint8_t table_id;        /* Identifier of table.  Lower numbered tables
 609                                 are consulted first. */
 610     uint8_t pad[3];          /* Align to 32-bits. */
 611     char name[OFP_MAX_TABLE_NAME_LEN];
 612     ovs_be32 wildcards;      /* Bitmap of OFPFW_* wildcards that are
 613                                 supported by the table. */
 614     ovs_be32 max_entries;    /* Max number of entries supported. */
 615     ovs_be32 active_count;   /* Number of active entries. */
 616     ovs_32aligned_be64 lookup_count;  /* # of packets looked up in table. */
 617     ovs_32aligned_be64 matched_count; /* Number of packets that hit table. */
 618 };
 619 OFP_ASSERT(sizeof(struct ofp_table_stats) == 64);
 620
 621 /* Stats request of type OFPST_PORT. */
 622 struct ofp_port_stats_request {
 623     struct ofp_stats_msg osm;
 624     ovs_be16 port_no;        /* OFPST_PORT message may request statistics
 625                                 for a single port (specified with port_no)
 626                                 or for all ports (port_no == OFPP_NONE). */
 627     uint8_t pad[6];
 628 };
 629 OFP_ASSERT(sizeof(struct ofp_port_stats_request) == 20);
 630
 631 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
 632  * the field to all ones. */
 633 struct ofp_port_stats {
 634     ovs_be16 port_no;
 635     uint8_t pad[6];          /* Align to 64-bits. */
 636     ovs_32aligned_be64 rx_packets;     /* Number of received packets. */
 637     ovs_32aligned_be64 tx_packets;     /* Number of transmitted packets. */
 638     ovs_32aligned_be64 rx_bytes;       /* Number of received bytes. */
 639     ovs_32aligned_be64 tx_bytes;       /* Number of transmitted bytes. */
 640     ovs_32aligned_be64 rx_dropped;     /* Number of packets dropped by RX. */
 641     ovs_32aligned_be64 tx_dropped;     /* Number of packets dropped by TX. */
 642     ovs_32aligned_be64 rx_errors; /* Number of receive errors.  This is a
 643                                      super-set of receive errors and should be
 644                                      great than or equal to the sum of all
 645                                      rx_*_err values. */
 646     ovs_32aligned_be64 tx_errors; /* Number of transmit errors.  This is a
 647                                      super-set of transmit errors. */
 648     ovs_32aligned_be64 rx_frame_err; /* Number of frame alignment errors. */
 649     ovs_32aligned_be64 rx_over_err;  /* Number of packets with RX overrun. */
 650     ovs_32aligned_be64 rx_crc_err;   /* Number of CRC errors. */
 651     ovs_32aligned_be64 collisions;   /* Number of collisions. */
 652 };
 653 OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
 654
 655 /* All ones is used to indicate all queues in a port (for stats retrieval). */
 656 #define OFPQ_ALL      0xffffffff
 657
 658 /* Body for stats request of type OFPST_QUEUE. */
 659 struct ofp_queue_stats_request {
 660     struct ofp_stats_msg osm;
 661     ovs_be16 port_no;        /* All ports if OFPP_ALL. */
 662     uint8_t pad[2];          /* Align to 32-bits. */
 663     ovs_be32 queue_id;       /* All queues if OFPQ_ALL. */
 664 };
 665 OFP_ASSERT(sizeof(struct ofp_queue_stats_request) == 20);
 666
 667 /* Body for stats reply of type OFPST_QUEUE consists of an array of this
 668  * structure type. */
 669 struct ofp_queue_stats {
 670     ovs_be16 port_no;
 671     uint8_t pad[2];          /* Align to 32-bits. */
 672     ovs_be32 queue_id;       /* Queue id. */
 673     ovs_32aligned_be64 tx_bytes;   /* Number of transmitted bytes. */
 674     ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */
 675     ovs_32aligned_be64 tx_errors;  /* # of packets dropped due to overrun. */
 676 };
 677 OFP_ASSERT(sizeof(struct ofp_queue_stats) == 32);
 678
 679 /* Vendor extension stats message. */
 680 struct ofp_vendor_stats_msg {
 681     struct ofp_stats_msg osm;   /* Type OFPST_VENDOR. */
 682     ovs_be32 vendor;            /* Vendor ID:
 683                                  * - MSB 0: low-order bytes are IEEE OUI.
 684                                  * - MSB != 0: defined by OpenFlow
 685                                  *   consortium. */
 686     /* Followed by vendor-defined arbitrary additional data. */
 687 };
 688 OFP_ASSERT(sizeof(struct ofp_vendor_stats_msg) == 16);
 689
 690 /* Vendor extension. */
 691 struct ofp_vendor_header {
 692     struct ofp_header header;   /* Type OFPT_VENDOR. */
 693     ovs_be32 vendor;            /* Vendor ID:
 694                                  * - MSB 0: low-order bytes are IEEE OUI.
 695                                  * - MSB != 0: defined by OpenFlow
 696                                  *   consortium. */
 697     /* Vendor-defined arbitrary additional data. */
 698 };
 699 OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12);
 700
 701 #endif /* openflow/openflow-1.0.h */