pintos-os.org Git - openvswitch/blob - include/openflow/openflow-1.0.h

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