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