include/openflow/openflow.h

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