include/openflow/openflow.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 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_OPENFLOW_H
  20 #define OPENFLOW_OPENFLOW_H 1
  21
  22 #ifdef __KERNEL__
  23 #include <linux/types.h>
  24 #else
  25 #include <stdint.h>
  26 #endif
  27
  28 #ifdef SWIG
  29 #define OFP_ASSERT(EXPR)        /* SWIG can't handle OFP_ASSERT. */
  30 #elif !defined(__cplusplus)
  31 /* Build-time assertion for use in a declaration context. */
  32 #define OFP_ASSERT(EXPR)                                                \
  33         extern int (*build_assert(void))[ sizeof(struct {               \
  34                     unsigned int build_assert_failed : (EXPR) ? 1 : -1; })]
  35 #else /* __cplusplus */
  36 #include <boost/static_assert.hpp>
  37 #define OFP_ASSERT BOOST_STATIC_ASSERT
  38 #endif /* __cplusplus */
  39
  40 #ifndef SWIG
  41 #define OFP_PACKED __attribute__((packed))
  42 #else
  43 #define OFP_PACKED              /* SWIG doesn't understand __attribute. */
  44 #endif
  45
  46 /* The most significant bit being set in the version field indicates an
  47  * experimental OpenFlow version.
  48  */
  49 #define OFP_VERSION   0x98
  50
  51 #define OFP_MAX_TABLE_NAME_LEN 32
  52 #define OFP_MAX_PORT_NAME_LEN  16
  53
  54 #define OFP_TCP_PORT  6633
  55 #define OFP_SSL_PORT  6633
  56
  57 #define OFP_ETH_ALEN 6          /* Bytes in an Ethernet address. */
  58
  59 /* Port numbering.  Physical ports are numbered starting from 1. */
  60 enum ofp_port {
  61     /* Maximum number of physical switch ports. */
  62     OFPP_MAX = 0xff00,
  63
  64     /* Fake output "ports". */
  65     OFPP_IN_PORT    = 0xfff8,  /* Send the packet out the input port.  This
  66                                   virtual port must be explicitly used
  67                                   in order to send back out of the input
  68                                   port. */
  69     OFPP_TABLE      = 0xfff9,  /* Perform actions in flow table.
  70                                   NB: This can only be the destination
  71                                   port for packet-out messages. */
  72     OFPP_NORMAL     = 0xfffa,  /* Process with normal L2/L3 switching. */
  73     OFPP_FLOOD      = 0xfffb,  /* All physical ports except input port and
  74                                   those disabled by STP. */
  75     OFPP_ALL        = 0xfffc,  /* All physical ports except input port. */
  76     OFPP_CONTROLLER = 0xfffd,  /* Send to controller. */
  77     OFPP_LOCAL      = 0xfffe,  /* Local openflow "port". */
  78     OFPP_NONE       = 0xffff   /* Not associated with a physical port. */
  79 };
  80
  81 enum ofp_type {
  82     /* Immutable messages. */
  83     OFPT_HELLO,               /* Symmetric message */
  84     OFPT_ERROR,               /* Symmetric message */
  85     OFPT_ECHO_REQUEST,        /* Symmetric message */
  86     OFPT_ECHO_REPLY,          /* Symmetric message */
  87     OFPT_VENDOR,              /* Symmetric message */
  88
  89     /* Switch configuration messages. */
  90     OFPT_FEATURES_REQUEST,    /* Controller/switch message */
  91     OFPT_FEATURES_REPLY,      /* Controller/switch message */
  92     OFPT_GET_CONFIG_REQUEST,  /* Controller/switch message */
  93     OFPT_GET_CONFIG_REPLY,    /* Controller/switch message */
  94     OFPT_SET_CONFIG,          /* Controller/switch message */
  95
  96     /* Asynchronous messages. */
  97     OFPT_PACKET_IN,           /* Async message */
  98     OFPT_FLOW_REMOVED,        /* Async message */
  99     OFPT_PORT_STATUS,         /* Async message */
 100
 101     /* Controller command messages. */
 102     OFPT_PACKET_OUT,          /* Controller/switch message */
 103     OFPT_FLOW_MOD,            /* Controller/switch message */
 104     OFPT_PORT_MOD,            /* Controller/switch message */
 105
 106     /* Statistics messages. */
 107     OFPT_STATS_REQUEST,       /* Controller/switch message */
 108     OFPT_STATS_REPLY,         /* Controller/switch message */
 109
 110     /* Barrier messages. */
 111     OFPT_BARRIER_REQUEST,     /* Controller/switch message */
 112     OFPT_BARRIER_REPLY,       /* Controller/switch message */
 113
 114     /* Queue Configuration messages. */
 115     OFPT_QUEUE_GET_CONFIG_REQUEST,  /* Controller/switch message */
 116     OFPT_QUEUE_GET_CONFIG_REPLY     /* Controller/switch message */
 117 };
 118
 119 /* Header on all OpenFlow packets. */
 120 struct ofp_header {
 121     uint8_t version;    /* OFP_VERSION. */
 122     uint8_t type;       /* One of the OFPT_ constants. */
 123     uint16_t length;    /* Length including this ofp_header. */
 124     uint32_t xid;       /* Transaction id associated with this packet.
 125                            Replies use the same id as was in the request
 126                            to facilitate pairing. */
 127 };
 128 OFP_ASSERT(sizeof(struct ofp_header) == 8);
 129
 130 /* OFPT_HELLO.  This message has an empty body, but implementations must
 131  * ignore any data included in the body, to allow for future extensions. */
 132 struct ofp_hello {
 133     struct ofp_header header;
 134 };
 135
 136 #define OFP_DEFAULT_MISS_SEND_LEN   128
 137
 138 enum ofp_config_flags {
 139     /* Handling of IP fragments. */
 140     OFPC_FRAG_NORMAL   = 0 << 1,  /* No special handling for fragments. */
 141     OFPC_FRAG_DROP     = 1 << 1,  /* Drop fragments. */
 142     OFPC_FRAG_REASM    = 2 << 1,  /* Reassemble (only if OFPC_IP_REASM set). */
 143     OFPC_FRAG_MASK     = 3 << 1
 144 };
 145
 146 /* Switch configuration. */
 147 struct ofp_switch_config {
 148     struct ofp_header header;
 149     uint16_t flags;             /* OFPC_* flags. */
 150     uint16_t miss_send_len;     /* Max bytes of new flow that datapath should
 151                                    send to the controller. */
 152 };
 153 OFP_ASSERT(sizeof(struct ofp_switch_config) == 12);
 154
 155 /* Capabilities supported by the datapath. */
 156 enum ofp_capabilities {
 157     OFPC_FLOW_STATS     = 1 << 0,  /* Flow statistics. */
 158     OFPC_TABLE_STATS    = 1 << 1,  /* Table statistics. */
 159     OFPC_PORT_STATS     = 1 << 2,  /* Port statistics. */
 160     OFPC_STP            = 1 << 3,  /* 802.1d spanning tree. */
 161     OFPC_MULTI_PHY_TX   = 1 << 4,  /* Supports transmitting through multiple
 162                                       physical interfaces */
 163     OFPC_IP_REASM       = 1 << 5,  /* Can reassemble IP fragments. */
 164     OFPC_QUEUE_STATS    = 1 << 6,  /* Queue statistics. */
 165     OFPC_ARP_MATCH_IP   = 1 << 7   /* Match IP addresses in ARP
 166                                       pkts. */
 167 };
 168
 169 /* Flags to indicate behavior of the physical port.  These flags are
 170  * used in ofp_phy_port to describe the current configuration.  They are
 171  * used in the ofp_port_mod message to configure the port's behavior.
 172  */
 173 enum ofp_port_config {
 174     OFPPC_PORT_DOWN    = 1 << 0,  /* Port is administratively down. */
 175
 176     OFPPC_NO_STP       = 1 << 1,  /* Disable 802.1D spanning tree on port. */
 177     OFPPC_NO_RECV      = 1 << 2,  /* Drop all packets except 802.1D
 178                                      spanning tree packets. */
 179     OFPPC_NO_RECV_STP  = 1 << 3,  /* Drop received 802.1D STP packets. */
 180     OFPPC_NO_FLOOD     = 1 << 4,  /* Do not include this port when flooding. */
 181     OFPPC_NO_FWD       = 1 << 5,  /* Drop packets forwarded to port. */
 182     OFPPC_NO_PACKET_IN = 1 << 6   /* Do not send packet-in msgs for port. */
 183 };
 184
 185 /* Current state of the physical port.  These are not configurable from
 186  * the controller.
 187  */
 188 enum ofp_port_state {
 189     OFPPS_LINK_DOWN   = 1 << 0, /* No physical link present. */
 190
 191     /* The OFPPS_STP_* bits have no effect on switch operation.  The
 192      * controller must adjust OFPPC_NO_RECV, OFPPC_NO_FWD, and
 193      * OFPPC_NO_PACKET_IN appropriately to fully implement an 802.1D spanning
 194      * tree. */
 195     OFPPS_STP_LISTEN  = 0 << 8, /* Not learning or relaying frames. */
 196     OFPPS_STP_LEARN   = 1 << 8, /* Learning but not relaying frames. */
 197     OFPPS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
 198     OFPPS_STP_BLOCK   = 3 << 8, /* Not part of spanning tree. */
 199     OFPPS_STP_MASK    = 3 << 8  /* Bit mask for OFPPS_STP_* values. */
 200 };
 201
 202 /* Features of physical ports available in a datapath. */
 203 enum ofp_port_features {
 204     OFPPF_10MB_HD    = 1 << 0,  /* 10 Mb half-duplex rate support. */
 205     OFPPF_10MB_FD    = 1 << 1,  /* 10 Mb full-duplex rate support. */
 206     OFPPF_100MB_HD   = 1 << 2,  /* 100 Mb half-duplex rate support. */
 207     OFPPF_100MB_FD   = 1 << 3,  /* 100 Mb full-duplex rate support. */
 208     OFPPF_1GB_HD     = 1 << 4,  /* 1 Gb half-duplex rate support. */
 209     OFPPF_1GB_FD     = 1 << 5,  /* 1 Gb full-duplex rate support. */
 210     OFPPF_10GB_FD    = 1 << 6,  /* 10 Gb full-duplex rate support. */
 211     OFPPF_COPPER     = 1 << 7,  /* Copper medium. */
 212     OFPPF_FIBER      = 1 << 8,  /* Fiber medium. */
 213     OFPPF_AUTONEG    = 1 << 9,  /* Auto-negotiation. */
 214     OFPPF_PAUSE      = 1 << 10, /* Pause. */
 215     OFPPF_PAUSE_ASYM = 1 << 11  /* Asymmetric pause. */
 216 };
 217
 218 /* Description of a physical port */
 219 struct ofp_phy_port {
 220     uint16_t port_no;
 221     uint8_t hw_addr[OFP_ETH_ALEN];
 222     uint8_t name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
 223
 224     uint32_t config;        /* Bitmap of OFPPC_* flags. */
 225     uint32_t state;         /* Bitmap of OFPPS_* flags. */
 226
 227     /* Bitmaps of OFPPF_* that describe features.  All bits zeroed if
 228      * unsupported or unavailable. */
 229     uint32_t curr;          /* Current features. */
 230     uint32_t advertised;    /* Features being advertised by the port. */
 231     uint32_t supported;     /* Features supported by the port. */
 232     uint32_t peer;          /* Features advertised by peer. */
 233 };
 234 OFP_ASSERT(sizeof(struct ofp_phy_port) == 48);
 235
 236 /* Switch features. */
 237 struct ofp_switch_features {
 238     struct ofp_header header;
 239     uint64_t datapath_id;   /* Datapath unique ID.  The lower 48-bits are for
 240                                a MAC address, while the upper 16-bits are
 241                                implementer-defined. */
 242
 243     uint32_t n_buffers;     /* Max packets buffered at once. */
 244
 245     uint8_t n_tables;       /* Number of tables supported by datapath. */
 246     uint8_t pad[3];         /* Align to 64-bits. */
 247
 248     /* Features. */
 249     uint32_t capabilities;  /* Bitmap of support "ofp_capabilities". */
 250     uint32_t actions;       /* Bitmap of supported "ofp_action_type"s. */
 251
 252     /* Port info.*/
 253     struct ofp_phy_port ports[0];  /* Port definitions.  The number of ports
 254                                       is inferred from the length field in
 255                                       the header. */
 256 };
 257 OFP_ASSERT(sizeof(struct ofp_switch_features) == 32);
 258
 259 /* What changed about the physical port */
 260 enum ofp_port_reason {
 261     OFPPR_ADD,              /* The port was added. */
 262     OFPPR_DELETE,           /* The port was removed. */
 263     OFPPR_MODIFY            /* Some attribute of the port has changed. */
 264 };
 265
 266 /* A physical port has changed in the datapath */
 267 struct ofp_port_status {
 268     struct ofp_header header;
 269     uint8_t reason;          /* One of OFPPR_*. */
 270     uint8_t pad[7];          /* Align to 64-bits. */
 271     struct ofp_phy_port desc;
 272 };
 273 OFP_ASSERT(sizeof(struct ofp_port_status) == 64);
 274
 275 /* Modify behavior of the physical port */
 276 struct ofp_port_mod {
 277     struct ofp_header header;
 278     uint16_t port_no;
 279     uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
 280                                       configurable.  This is used to
 281                                       sanity-check the request, so it must
 282                                       be the same as returned in an
 283                                       ofp_phy_port struct. */
 284
 285     uint32_t config;        /* Bitmap of OFPPC_* flags. */
 286     uint32_t mask;          /* Bitmap of OFPPC_* flags to be changed. */
 287
 288     uint32_t advertise;     /* Bitmap of "ofp_port_features"s.  Zero all
 289                                bits to prevent any action taking place. */
 290     uint8_t pad[4];         /* Pad to 64-bits. */
 291 };
 292 OFP_ASSERT(sizeof(struct ofp_port_mod) == 32);
 293
 294 /* Why is this packet being sent to the controller? */
 295 enum ofp_packet_in_reason {
 296     OFPR_NO_MATCH,          /* No matching flow. */
 297     OFPR_ACTION             /* Action explicitly output to controller. */
 298 };
 299
 300 /* Packet received on port (datapath -> controller). */
 301 struct ofp_packet_in {
 302     struct ofp_header header;
 303     uint32_t buffer_id;     /* ID assigned by datapath. */
 304     uint16_t total_len;     /* Full length of frame. */
 305     uint16_t in_port;       /* Port on which frame was received. */
 306     uint8_t reason;         /* Reason packet is being sent (one of OFPR_*) */
 307     uint8_t pad;
 308     uint8_t data[0];        /* Ethernet frame, halfway through 32-bit word,
 309                                so the IP header is 32-bit aligned.  The
 310                                amount of data is inferred from the length
 311                                field in the header.  Because of padding,
 312                                offsetof(struct ofp_packet_in, data) ==
 313                                sizeof(struct ofp_packet_in) - 2. */
 314 };
 315 OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
 316
 317 enum ofp_action_type {
 318     OFPAT_OUTPUT,           /* Output to switch port. */
 319     OFPAT_SET_VLAN_VID,     /* Set the 802.1q VLAN id. */
 320     OFPAT_SET_VLAN_PCP,     /* Set the 802.1q priority. */
 321     OFPAT_STRIP_VLAN,       /* Strip the 802.1q header. */
 322     OFPAT_SET_DL_SRC,       /* Ethernet source address. */
 323     OFPAT_SET_DL_DST,       /* Ethernet destination address. */
 324     OFPAT_SET_NW_SRC,       /* IP source address. */
 325     OFPAT_SET_NW_DST,       /* IP destination address. */
 326     OFPAT_SET_NW_TOS,       /* IP ToS (DSCP field, 6 bits). */
 327     OFPAT_SET_TP_SRC,       /* TCP/UDP source port. */
 328     OFPAT_SET_TP_DST,       /* TCP/UDP destination port. */
 329     OFPAT_ENQUEUE,          /* Output to queue. */
 330     OFPAT_VENDOR = 0xffff
 331 };
 332
 333 /* Action structure for OFPAT_OUTPUT, which sends packets out 'port'.
 334  * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
 335  * number of bytes to send.  A 'max_len' of zero means no bytes of the
 336  * packet should be sent. */
 337 struct ofp_action_output {
 338     uint16_t type;                  /* OFPAT_OUTPUT. */
 339     uint16_t len;                   /* Length is 8. */
 340     uint16_t port;                  /* Output port. */
 341     uint16_t max_len;               /* Max length to send to controller. */
 342 };
 343 OFP_ASSERT(sizeof(struct ofp_action_output) == 8);
 344
 345 /* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate
 346  * special conditions.  All ones is used to match that no VLAN id was
 347  * set. */
 348 #define OFP_VLAN_NONE      0xffff
 349
 350 /* Action structure for OFPAT_SET_VLAN_VID. */
 351 struct ofp_action_vlan_vid {
 352     uint16_t type;                  /* OFPAT_SET_VLAN_VID. */
 353     uint16_t len;                   /* Length is 8. */
 354     uint16_t vlan_vid;              /* VLAN id. */
 355     uint8_t pad[2];
 356 };
 357 OFP_ASSERT(sizeof(struct ofp_action_vlan_vid) == 8);
 358
 359 /* Action structure for OFPAT_SET_VLAN_PCP. */
 360 struct ofp_action_vlan_pcp {
 361     uint16_t type;                  /* OFPAT_SET_VLAN_PCP. */
 362     uint16_t len;                   /* Length is 8. */
 363     uint8_t vlan_pcp;               /* VLAN priority. */
 364     uint8_t pad[3];
 365 };
 366 OFP_ASSERT(sizeof(struct ofp_action_vlan_pcp) == 8);
 367
 368 /* Action structure for OFPAT_SET_DL_SRC/DST. */
 369 struct ofp_action_dl_addr {
 370     uint16_t type;                  /* OFPAT_SET_DL_SRC/DST. */
 371     uint16_t len;                   /* Length is 16. */
 372     uint8_t dl_addr[OFP_ETH_ALEN];  /* Ethernet address. */
 373     uint8_t pad[6];
 374 };
 375 OFP_ASSERT(sizeof(struct ofp_action_dl_addr) == 16);
 376
 377 /* Action structure for OFPAT_SET_NW_SRC/DST. */
 378 struct ofp_action_nw_addr {
 379     uint16_t type;                  /* OFPAT_SET_TW_SRC/DST. */
 380     uint16_t len;                   /* Length is 8. */
 381     uint32_t nw_addr;               /* IP address. */
 382 };
 383 OFP_ASSERT(sizeof(struct ofp_action_nw_addr) == 8);
 384
 385 /* Action structure for OFPAT_SET_NW_TOS. */
 386 struct ofp_action_nw_tos {
 387     uint16_t type;                  /* OFPAT_SET_TW_TOS. */
 388     uint16_t len;                   /* Length is 8. */
 389     uint8_t nw_tos;                 /* IP TOS (DSCP field, 6 bits). */
 390     uint8_t pad[3];
 391 };
 392 OFP_ASSERT(sizeof(struct ofp_action_nw_tos) == 8);
 393
 394 /* Action structure for OFPAT_SET_TP_SRC/DST. */
 395 struct ofp_action_tp_port {
 396     uint16_t type;                  /* OFPAT_SET_TP_SRC/DST. */
 397     uint16_t len;                   /* Length is 8. */
 398     uint16_t tp_port;               /* TCP/UDP port. */
 399     uint8_t pad[2];
 400 };
 401 OFP_ASSERT(sizeof(struct ofp_action_tp_port) == 8);
 402
 403 /* Action header for OFPAT_VENDOR. The rest of the body is vendor-defined. */
 404 struct ofp_action_vendor_header {
 405     uint16_t type;                  /* OFPAT_VENDOR. */
 406     uint16_t len;                   /* Length is a multiple of 8. */
 407     uint32_t vendor;                /* Vendor ID, which takes the same form
 408                                        as in "struct ofp_vendor_header". */
 409 };
 410 OFP_ASSERT(sizeof(struct ofp_action_vendor_header) == 8);
 411
 412 /* Action header that is common to all actions.  The length includes the
 413  * header and any padding used to make the action 64-bit aligned.
 414  * NB: The length of an action *must* always be a multiple of eight. */
 415 struct ofp_action_header {
 416     uint16_t type;                  /* One of OFPAT_*. */
 417     uint16_t len;                   /* Length of action, including this
 418                                        header.  This is the length of action,
 419                                        including any padding to make it
 420                                        64-bit aligned. */
 421     uint8_t pad[4];
 422 };
 423 OFP_ASSERT(sizeof(struct ofp_action_header) == 8);
 424
 425 union ofp_action {
 426     uint16_t type;
 427     struct ofp_action_header header;
 428     struct ofp_action_vendor_header vendor;
 429     struct ofp_action_output output;
 430     struct ofp_action_vlan_vid vlan_vid;
 431     struct ofp_action_vlan_pcp vlan_pcp;
 432     struct ofp_action_nw_addr nw_addr;
 433     struct ofp_action_nw_tos nw_tos;
 434     struct ofp_action_tp_port tp_port;
 435 };
 436 OFP_ASSERT(sizeof(union ofp_action) == 8);
 437
 438 /* Send packet (controller -> datapath). */
 439 struct ofp_packet_out {
 440     struct ofp_header header;
 441     uint32_t buffer_id;           /* ID assigned by datapath (-1 if none). */
 442     uint16_t in_port;             /* Packet's input port (OFPP_NONE if none). */
 443     uint16_t actions_len;         /* Size of action array in bytes. */
 444     struct ofp_action_header actions[0]; /* Actions. */
 445     /* uint8_t data[0]; */        /* Packet data.  The length is inferred
 446                                      from the length field in the header.
 447                                      (Only meaningful if buffer_id == -1.) */
 448 };
 449 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
 450
 451 enum ofp_flow_mod_command {
 452     OFPFC_ADD,              /* New flow. */
 453     OFPFC_MODIFY,           /* Modify all matching flows. */
 454     OFPFC_MODIFY_STRICT,    /* Modify entry strictly matching wildcards */
 455     OFPFC_DELETE,           /* Delete all matching flows. */
 456     OFPFC_DELETE_STRICT     /* Strictly match wildcards and priority. */
 457 };
 458
 459 /* Flow wildcards. */
 460 enum ofp_flow_wildcards {
 461     OFPFW_IN_PORT    = 1 << 0,  /* Switch input port. */
 462     OFPFW_DL_VLAN    = 1 << 1,  /* VLAN vid. */
 463     OFPFW_DL_SRC     = 1 << 2,  /* Ethernet source address. */
 464     OFPFW_DL_DST     = 1 << 3,  /* Ethernet destination address. */
 465     OFPFW_DL_TYPE    = 1 << 4,  /* Ethernet frame type. */
 466     OFPFW_NW_PROTO   = 1 << 5,  /* IP protocol. */
 467     OFPFW_TP_SRC     = 1 << 6,  /* TCP/UDP source port. */
 468     OFPFW_TP_DST     = 1 << 7,  /* TCP/UDP destination port. */
 469
 470     /* IP source address wildcard bit count.  0 is exact match, 1 ignores the
 471      * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
 472      * the entire field.  This is the *opposite* of the usual convention where
 473      * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
 474     OFPFW_NW_SRC_SHIFT = 8,
 475     OFPFW_NW_SRC_BITS = 6,
 476     OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
 477     OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
 478
 479     /* IP destination address wildcard bit count.  Same format as source. */
 480     OFPFW_NW_DST_SHIFT = 14,
 481     OFPFW_NW_DST_BITS = 6,
 482     OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
 483     OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
 484
 485     OFPFW_DL_VLAN_PCP = 1 << 20, /* VLAN priority. */
 486     OFPFW_NW_TOS = 1 << 21, /* IP ToS (DSCP field, 6 bits). */
 487
 488     /* Wildcard all fields. */
 489     OFPFW_ALL = ((1 << 22) - 1)
 490 };
 491
 492 /* The wildcards for ICMP type and code fields use the transport source
 493  * and destination port fields, respectively. */
 494 #define OFPFW_ICMP_TYPE OFPFW_TP_SRC
 495 #define OFPFW_ICMP_CODE OFPFW_TP_DST
 496
 497 /* Values below this cutoff are 802.3 packets and the two bytes
 498  * following MAC addresses are used as a frame length.  Otherwise, the
 499  * two bytes are used as the Ethernet type.
 500  */
 501 #define OFP_DL_TYPE_ETH2_CUTOFF   0x0600
 502
 503 /* Value of dl_type to indicate that the frame does not include an
 504  * Ethernet type.
 505  */
 506 #define OFP_DL_TYPE_NOT_ETH_TYPE  0x05ff
 507
 508 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
 509  * special conditions.  All ones indicates that no VLAN id was set.
 510  */
 511 #define OFP_VLAN_NONE      0xffff
 512
 513 /* Fields to match against flows */
 514 struct ofp_match {
 515     uint32_t wildcards;        /* Wildcard fields. */
 516     uint16_t in_port;          /* Input switch port. */
 517     uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
 518     uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
 519     uint16_t dl_vlan;          /* Input VLAN. */
 520     uint8_t dl_vlan_pcp;       /* Input VLAN priority. */
 521     uint8_t pad1[1];           /* Align to 64-bits. */
 522     uint16_t dl_type;          /* Ethernet frame type. */
 523     uint8_t nw_tos;            /* IP ToS (DSCP field, 6 bits). */
 524     uint8_t nw_proto;          /* IP protocol or lower 8 bits of
 525                                   ARP opcode. */
 526     uint8_t pad2[2];           /* Align to 64-bits. */
 527     uint32_t nw_src;           /* IP source address. */
 528     uint32_t nw_dst;           /* IP destination address. */
 529     uint16_t tp_src;           /* TCP/UDP source port. */
 530     uint16_t tp_dst;           /* TCP/UDP destination port. */
 531 };
 532 OFP_ASSERT(sizeof(struct ofp_match) == 40);
 533
 534 /* The match fields for ICMP type and code use the transport source and
 535  * destination port fields, respectively. */
 536 #define icmp_type tp_src
 537 #define icmp_code tp_dst
 538
 539 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
 540  * is permanent. */
 541 #define OFP_FLOW_PERMANENT 0
 542
 543 /* By default, choose a priority in the middle. */
 544 #define OFP_DEFAULT_PRIORITY 0x8000
 545
 546 enum ofp_flow_mod_flags {
 547     OFPFF_SEND_FLOW_REM = 1 << 0,  /* Send flow removed message when flow
 548                                     * expires or is deleted. */
 549     OFPFF_CHECK_OVERLAP = 1 << 1,  /* Check for overlapping entries first. */
 550     OFPFF_EMERG         = 1 << 2   /* Ramark this is for emergency. */
 551 };
 552
 553 /* Flow setup and teardown (controller -> datapath). */
 554 struct ofp_flow_mod {
 555     struct ofp_header header;
 556     struct ofp_match match;      /* Fields to match */
 557     uint64_t cookie;             /* Opaque controller-issued identifier. */
 558
 559     /* Flow actions. */
 560     uint16_t command;             /* One of OFPFC_*. */
 561     uint16_t idle_timeout;        /* Idle time before discarding (seconds). */
 562     uint16_t hard_timeout;        /* Max time before discarding (seconds). */
 563     uint16_t priority;            /* Priority level of flow entry. */
 564     uint32_t buffer_id;           /* Buffered packet to apply to (or -1).
 565                                      Not meaningful for OFPFC_DELETE*. */
 566     uint16_t out_port;            /* For OFPFC_DELETE* commands, require
 567                                      matching entries to include this as an
 568                                      output port.  A value of OFPP_NONE
 569                                      indicates no restriction. */
 570     uint16_t flags;               /* One of OFPFF_*. */
 571     struct ofp_action_header actions[0]; /* The action length is inferred
 572                                             from the length field in the
 573                                             header. */
 574 };
 575 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 72);
 576
 577 /* Why was this flow removed? */
 578 enum ofp_flow_removed_reason {
 579     OFPRR_IDLE_TIMEOUT,         /* Flow idle time exceeded idle_timeout. */
 580     OFPRR_HARD_TIMEOUT,         /* Time exceeded hard_timeout. */
 581     OFPRR_DELETE                /* Evicted by a DELETE flow mod. */
 582 };
 583
 584 /* Flow removed (datapath -> controller). */
 585 struct ofp_flow_removed {
 586     struct ofp_header header;
 587     struct ofp_match match;   /* Description of fields. */
 588     uint64_t cookie;          /* Opaque controller-issued identifier. */
 589
 590     uint16_t priority;        /* Priority level of flow entry. */
 591     uint8_t reason;           /* One of OFPRR_*. */
 592     uint8_t pad[1];           /* Align to 32-bits. */
 593
 594     uint32_t duration_sec;    /* Time flow was alive in seconds. */
 595     uint32_t duration_nsec;   /* Time flow was alive in nanoseconds beyond
 596                                  duration_sec. */
 597     uint16_t idle_timeout;    /* Idle timeout from original flow mod. */
 598     uint8_t pad2[2];          /* Align to 64-bits. */
 599     uint64_t packet_count;
 600     uint64_t byte_count;
 601 };
 602 OFP_ASSERT(sizeof(struct ofp_flow_removed) == 88);
 603
 604 /* Values for 'type' in ofp_error_message.  These values are immutable: they
 605  * will not change in future versions of the protocol (although new values may
 606  * be added). */
 607 enum ofp_error_type {
 608     OFPET_HELLO_FAILED,         /* Hello protocol failed. */
 609     OFPET_BAD_REQUEST,          /* Request was not understood. */
 610     OFPET_BAD_ACTION,           /* Error in action description. */
 611     OFPET_FLOW_MOD_FAILED,      /* Problem modifying flow entry. */
 612     OFPET_PORT_MOD_FAILED,      /* OFPT_PORT_MOD failed. */
 613     OFPET_QUEUE_OP_FAILED       /* Queue operation failed. */
 614 };
 615
 616 /* ofp_error_msg 'code' values for OFPET_HELLO_FAILED.  'data' contains an
 617  * ASCII text string that may give failure details. */
 618 enum ofp_hello_failed_code {
 619     OFPHFC_INCOMPATIBLE,        /* No compatible version. */
 620     OFPHFC_EPERM                /* Permissions error. */
 621 };
 622
 623 /* ofp_error_msg 'code' values for OFPET_BAD_REQUEST.  'data' contains at least
 624  * the first 64 bytes of the failed request. */
 625 enum ofp_bad_request_code {
 626     OFPBRC_BAD_VERSION,         /* ofp_header.version not supported. */
 627     OFPBRC_BAD_TYPE,            /* ofp_header.type not supported. */
 628     OFPBRC_BAD_STAT,            /* ofp_stats_request.type not supported. */
 629     OFPBRC_BAD_VENDOR,          /* Vendor not supported (in ofp_vendor_header
 630                                  * or ofp_stats_request or ofp_stats_reply). */
 631     OFPBRC_BAD_SUBTYPE,         /* Vendor subtype not supported. */
 632     OFPBRC_EPERM,               /* Permissions error. */
 633     OFPBRC_BAD_LEN,             /* Wrong request length for type. */
 634     OFPBRC_BUFFER_EMPTY,        /* Specified buffer has already been used. */
 635     OFPBRC_BUFFER_UNKNOWN       /* Specified buffer does not exist. */
 636 };
 637
 638 /* ofp_error_msg 'code' values for OFPET_BAD_ACTION.  'data' contains at least
 639  * the first 64 bytes of the failed request. */
 640 enum ofp_bad_action_code {
 641     OFPBAC_BAD_TYPE,           /* Unknown action type. */
 642     OFPBAC_BAD_LEN,            /* Length problem in actions. */
 643     OFPBAC_BAD_VENDOR,         /* Unknown vendor id specified. */
 644     OFPBAC_BAD_VENDOR_TYPE,    /* Unknown action type for vendor id. */
 645     OFPBAC_BAD_OUT_PORT,       /* Problem validating output action. */
 646     OFPBAC_BAD_ARGUMENT,       /* Bad action argument. */
 647     OFPBAC_EPERM,              /* Permissions error. */
 648     OFPBAC_TOO_MANY,           /* Can't handle this many actions. */
 649     OFPBAC_BAD_QUEUE           /* Problem validating output queue. */
 650 };
 651
 652 /* ofp_error_msg 'code' values for OFPET_FLOW_MOD_FAILED.  'data' contains
 653  * at least the first 64 bytes of the failed request. */
 654 enum ofp_flow_mod_failed_code {
 655     OFPFMFC_ALL_TABLES_FULL,    /* Flow not added because of full tables. */
 656     OFPFMFC_OVERLAP,            /* Attempted to add overlapping flow with
 657                                  * CHECK_OVERLAP flag set. */
 658     OFPFMFC_EPERM,              /* Permissions error. */
 659     OFPFMFC_BAD_EMERG_TIMEOUT,  /* Flow not added because of non-zero idle/hard
 660                                  * timeout. */
 661     OFPFMFC_BAD_COMMAND,        /* Unknown command. */
 662     OFPFMFC_UNSUPPORTED         /* Unsupported action list - cannot process in
 663                                    the order specified. */
 664 };
 665
 666 /* ofp_error_msg 'code' values for OFPET_PORT_MOD_FAILED.  'data' contains
 667  * at least the first 64 bytes of the failed request. */
 668 enum ofp_port_mod_failed_code {
 669     OFPPMFC_BAD_PORT,            /* Specified port does not exist. */
 670     OFPPMFC_BAD_HW_ADDR,         /* Specified hardware address is wrong. */
 671 };
 672
 673 /* ofp_error msg 'code' values for OFPET_QUEUE_OP_FAILED. 'data' contains
 674  * at least the first 64 bytes of the failed request */
 675 enum ofp_queue_op_failed_code {
 676     OFPQOFC_BAD_PORT,           /* Invalid port (or port does not exist). */
 677     OFPQOFC_BAD_QUEUE,          /* Queue does not exist. */
 678     OFPQOFC_EPERM               /* Permissions error. */
 679 };
 680
 681 /* OFPT_ERROR: Error message (datapath -> controller). */
 682 struct ofp_error_msg {
 683     struct ofp_header header;
 684
 685     uint16_t type;
 686     uint16_t code;
 687     uint8_t data[0];          /* Variable-length data.  Interpreted based
 688                                  on the type and code. */
 689 };
 690 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
 691
 692 enum ofp_stats_types {
 693     /* Description of this OpenFlow switch.
 694      * The request body is empty.
 695      * The reply body is struct ofp_desc_stats. */
 696     OFPST_DESC,
 697
 698     /* Individual flow statistics.
 699      * The request body is struct ofp_flow_stats_request.
 700      * The reply body is an array of struct ofp_flow_stats. */
 701     OFPST_FLOW,
 702
 703     /* Aggregate flow statistics.
 704      * The request body is struct ofp_aggregate_stats_request.
 705      * The reply body is struct ofp_aggregate_stats_reply. */
 706     OFPST_AGGREGATE,
 707
 708     /* Flow table statistics.
 709      * The request body is empty.
 710      * The reply body is an array of struct ofp_table_stats. */
 711     OFPST_TABLE,
 712
 713     /* Physical port statistics.
 714      * The request body is struct ofp_port_stats_request.
 715      * The reply body is an array of struct ofp_port_stats. */
 716     OFPST_PORT,
 717
 718     /* Queue statistics for a port
 719      * The request body defines the port
 720      * The reply body is an array of struct ofp_queue_stats */
 721     OFPST_QUEUE,
 722
 723     /* Vendor extension.
 724      * The request and reply bodies begin with a 32-bit vendor ID, which takes
 725      * the same form as in "struct ofp_vendor_header".  The request and reply
 726      * bodies are otherwise vendor-defined. */
 727     OFPST_VENDOR = 0xffff
 728 };
 729
 730 struct ofp_stats_request {
 731     struct ofp_header header;
 732     uint16_t type;              /* One of the OFPST_* constants. */
 733     uint16_t flags;             /* OFPSF_REQ_* flags (none yet defined). */
 734     uint8_t body[0];            /* Body of the request. */
 735 };
 736 OFP_ASSERT(sizeof(struct ofp_stats_request) == 12);
 737
 738 enum ofp_stats_reply_flags {
 739     OFPSF_REPLY_MORE  = 1 << 0  /* More replies to follow. */
 740 };
 741
 742 struct ofp_stats_reply {
 743     struct ofp_header header;
 744     uint16_t type;              /* One of the OFPST_* constants. */
 745     uint16_t flags;             /* OFPSF_REPLY_* flags. */
 746     uint8_t body[0];            /* Body of the reply. */
 747 };
 748 OFP_ASSERT(sizeof(struct ofp_stats_reply) == 12);
 749
 750 #define DESC_STR_LEN   256
 751 #define SERIAL_NUM_LEN 32
 752 /* Body of reply to OFPST_DESC request.  Each entry is a NULL-terminated
 753  * ASCII string. */
 754 struct ofp_desc_stats {
 755     char mfr_desc[DESC_STR_LEN];       /* Manufacturer description. */
 756     char hw_desc[DESC_STR_LEN];        /* Hardware description. */
 757     char sw_desc[DESC_STR_LEN];        /* Software description. */
 758     char serial_num[SERIAL_NUM_LEN];   /* Serial number. */
 759     char dp_desc[DESC_STR_LEN];        /* Human readable description of
 760                                           the datapath. */
 761 };
 762 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 1056);
 763
 764 /* Body for ofp_stats_request of type OFPST_FLOW. */
 765 struct ofp_flow_stats_request {
 766     struct ofp_match match;   /* Fields to match. */
 767     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
 768                                  or 0xff for all tables. */
 769     uint8_t pad;              /* Align to 32 bits. */
 770     uint16_t out_port;        /* Require matching entries to include this
 771                                  as an output port.  A value of OFPP_NONE
 772                                  indicates no restriction. */
 773 };
 774 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 44);
 775
 776 /* Body of reply to OFPST_FLOW request. */
 777 struct ofp_flow_stats {
 778     uint16_t length;          /* Length of this entry. */
 779     uint8_t table_id;         /* ID of table flow came from. */
 780     uint8_t pad;
 781     struct ofp_match match;   /* Description of fields. */
 782     uint32_t duration_sec;    /* Time flow has been alive in seconds. */
 783     uint32_t duration_nsec;   /* Time flow has been alive in nanoseconds
 784                                  beyond duration_sec. */
 785     uint16_t priority;        /* Priority of the entry. Only meaningful
 786                                  when this is not an exact-match entry. */
 787     uint16_t idle_timeout;    /* Number of seconds idle before expiration. */
 788     uint16_t hard_timeout;    /* Number of seconds before expiration. */
 789     uint8_t pad2[6];          /* Align to 64 bits. */
 790     uint64_t cookie;          /* Opaque controller-issued identifier. */
 791     uint64_t packet_count;    /* Number of packets in flow. */
 792     uint64_t byte_count;      /* Number of bytes in flow. */
 793     struct ofp_action_header actions[0]; /* Actions. */
 794 };
 795 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 88);
 796
 797 /* Body for ofp_stats_request of type OFPST_AGGREGATE. */
 798 struct ofp_aggregate_stats_request {
 799     struct ofp_match match;   /* Fields to match. */
 800     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
 801                                  or 0xff for all tables. */
 802     uint8_t pad;              /* Align to 32 bits. */
 803     uint16_t out_port;        /* Require matching entries to include this
 804                                  as an output port.  A value of OFPP_NONE
 805                                  indicates no restriction. */
 806 };
 807 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 44);
 808
 809 /* Body of reply to OFPST_AGGREGATE request. */
 810 struct ofp_aggregate_stats_reply {
 811     uint64_t packet_count;    /* Number of packets in flows. */
 812     uint64_t byte_count;      /* Number of bytes in flows. */
 813     uint32_t flow_count;      /* Number of flows. */
 814     uint8_t pad[4];           /* Align to 64 bits. */
 815 };
 816 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
 817
 818 /* Body of reply to OFPST_TABLE request. */
 819 struct ofp_table_stats {
 820     uint8_t table_id;        /* Identifier of table.  Lower numbered tables
 821                                 are consulted first. */
 822     uint8_t pad[3];          /* Align to 32-bits. */
 823     char name[OFP_MAX_TABLE_NAME_LEN];
 824     uint32_t wildcards;      /* Bitmap of OFPFW_* wildcards that are
 825                                 supported by the table. */
 826     uint32_t max_entries;    /* Max number of entries supported. */
 827     uint32_t active_count;   /* Number of active entries. */
 828     uint64_t lookup_count;   /* Number of packets looked up in table. */
 829     uint64_t matched_count;  /* Number of packets that hit table. */
 830 };
 831 OFP_ASSERT(sizeof(struct ofp_table_stats) == 64);
 832
 833 /* Body for ofp_stats_request of type OFPST_PORT. */
 834 struct ofp_port_stats_request {
 835     uint16_t port_no;        /* OFPST_PORT message may request statistics
 836                                 for a single port (specified with port_no)
 837                                 or for all ports (port_no == OFPP_NONE). */
 838     uint8_t pad[6];
 839 };
 840 OFP_ASSERT(sizeof(struct ofp_port_stats_request) == 8);
 841
 842 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
 843  * the field to all ones. */
 844 struct ofp_port_stats {
 845     uint16_t port_no;
 846     uint8_t pad[6];          /* Align to 64-bits. */
 847     uint64_t rx_packets;     /* Number of received packets. */
 848     uint64_t tx_packets;     /* Number of transmitted packets. */
 849     uint64_t rx_bytes;       /* Number of received bytes. */
 850     uint64_t tx_bytes;       /* Number of transmitted bytes. */
 851     uint64_t rx_dropped;     /* Number of packets dropped by RX. */
 852     uint64_t tx_dropped;     /* Number of packets dropped by TX. */
 853     uint64_t rx_errors;      /* Number of receive errors.  This is a super-set
 854                                 of receive errors and should be great than or
 855                                 equal to the sum of all rx_*_err values. */
 856     uint64_t tx_errors;      /* Number of transmit errors.  This is a super-set
 857                                 of transmit errors. */
 858     uint64_t rx_frame_err;   /* Number of frame alignment errors. */
 859     uint64_t rx_over_err;    /* Number of packets with RX overrun. */
 860     uint64_t rx_crc_err;     /* Number of CRC errors. */
 861     uint64_t collisions;     /* Number of collisions. */
 862 };
 863 OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
 864
 865 /* Vendor extension. */
 866 struct ofp_vendor_header {
 867     struct ofp_header header;   /* Type OFPT_VENDOR. */
 868     uint32_t vendor;            /* Vendor ID:
 869                                  * - MSB 0: low-order bytes are IEEE OUI.
 870                                  * - MSB != 0: defined by OpenFlow
 871                                  *   consortium. */
 872     /* Vendor-defined arbitrary additional data. */
 873 };
 874 OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12);
 875
 876 #endif /* openflow/openflow.h */