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