include/openflow/openflow.h

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