include/openflow/openflow-1.1.h

   1 /* Copyright (c) 2008, 2011, 2012 The Board of Trustees of The Leland Stanford
   2  * Junior University
   3  *
   4  * We are making the OpenFlow specification and associated documentation
   5  * (Software) available for public use and benefit with the expectation
   6  * that others will use, modify and enhance the Software and contribute
   7  * those enhancements back to the community. However, since we would
   8  * like to make the Software available for broadest use, with as few
   9  * restrictions as possible permission is hereby granted, free of
  10  * charge, to any person obtaining a copy of this Software to deal in
  11  * the Software under the copyrights without restriction, including
  12  * without limitation the rights to use, copy, modify, merge, publish,
  13  * distribute, sublicense, and/or sell copies of the Software, and to
  14  * permit persons to whom the Software is furnished to do so, subject to
  15  * the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be
  18  * included in all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  *
  29  * The name and trademarks of copyright holder(s) may NOT be used in
  30  * advertising or publicity pertaining to the Software or any
  31  * derivatives without specific, written prior permission.
  32  */
  33
  34 /*
  35  * Copyright (c) 2008, 2009, 2010, 2011 Nicira, Inc.
  36  *
  37  * Licensed under the Apache License, Version 2.0 (the "License");
  38  * you may not use this file except in compliance with the License.
  39  * You may obtain a copy of the License at:
  40  *
  41  *     http://www.apache.org/licenses/LICENSE-2.0
  42  *
  43  * Unless required by applicable law or agreed to in writing, software
  44  * distributed under the License is distributed on an "AS IS" BASIS,
  45  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  46  * See the License for the specific language governing permissions and
  47  * limitations under the License.
  48  */
  49
  50 /* OpenFlow: protocol between controller and datapath. */
  51
  52 #ifndef OPENFLOW_11_H
  53 #define OPENFLOW_11_H 1
  54
  55 #include "openflow/openflow-common.h"
  56
  57 /* OpenFlow 1.1 uses 32-bit port numbers.  Open vSwitch, for now, uses OpenFlow
  58  * 1.0 port numbers internally.  We map them to OpenFlow 1.0 as follows:
  59  *
  60  * OF1.1                    <=>  OF1.0
  61  * -----------------------       ---------------
  62  * 0x00000000...0x0000feff  <=>  0x0000...0xfeff  "physical" ports
  63  * 0x0000ff00...0xfffffeff  <=>  not supported
  64  * 0xffffff00...0xffffffff  <=>  0xff00...0xffff  "reserved" OFPP_* ports
  65  *
  66  * OFPP11_OFFSET is the value that must be added or subtracted to convert
  67  * an OpenFlow 1.0 reserved port number to or from, respectively, the
  68  * corresponding OpenFlow 1.1 reserved port number.
  69  */
  70 #define OFPP11_MAX    0xffffff00
  71 #define OFPP11_OFFSET (OFPP11_MAX - OFPP_MAX)
  72
  73 /* OpenFlow 1.1 port config flags are just the common flags. */
  74 #define OFPPC11_ALL \
  75     (OFPPC_PORT_DOWN | OFPPC_NO_RECV | OFPPC_NO_FWD | OFPPC_NO_PACKET_IN)
  76
  77 /* OpenFlow 1.1 specific current state of the physical port.  These are not
  78  * configurable from the controller.
  79  */
  80 enum ofp11_port_state {
  81     OFPPS11_BLOCKED      = 1 << 1,  /* Port is blocked */
  82     OFPPS11_LIVE         = 1 << 2,  /* Live for Fast Failover Group. */
  83 #define OFPPS11_ALL (OFPPS_LINK_DOWN | OFPPS11_BLOCKED | OFPPS11_LIVE)
  84 };
  85
  86 /* OpenFlow 1.1 specific features of ports available in a datapath. */
  87 enum ofp11_port_features {
  88     OFPPF11_40GB_FD    = 1 << 7,  /* 40 Gb full-duplex rate support. */
  89     OFPPF11_100GB_FD   = 1 << 8,  /* 100 Gb full-duplex rate support. */
  90     OFPPF11_1TB_FD     = 1 << 9,  /* 1 Tb full-duplex rate support. */
  91     OFPPF11_OTHER      = 1 << 10, /* Other rate, not in the list. */
  92
  93     OFPPF11_COPPER     = 1 << 11, /* Copper medium. */
  94     OFPPF11_FIBER      = 1 << 12, /* Fiber medium. */
  95     OFPPF11_AUTONEG    = 1 << 13, /* Auto-negotiation. */
  96     OFPPF11_PAUSE      = 1 << 14, /* Pause. */
  97     OFPPF11_PAUSE_ASYM = 1 << 15  /* Asymmetric pause. */
  98 #define OFPPF11_ALL ((1 << 16) - 1)
  99 };
 100
 101 /* Description of a port */
 102 struct ofp11_port {
 103     ovs_be32 port_no;
 104     uint8_t pad[4];
 105     uint8_t hw_addr[OFP_ETH_ALEN];
 106     uint8_t pad2[2];                  /* Align to 64 bits. */
 107     char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
 108
 109     ovs_be32 config;        /* Bitmap of OFPPC_* flags. */
 110     ovs_be32 state;         /* Bitmap of OFPPS_* and OFPPS11_* flags. */
 111
 112     /* Bitmaps of OFPPF_* and OFPPF11_* that describe features.  All bits
 113      * zeroed if unsupported or unavailable. */
 114     ovs_be32 curr;          /* Current features. */
 115     ovs_be32 advertised;    /* Features being advertised by the port. */
 116     ovs_be32 supported;     /* Features supported by the port. */
 117     ovs_be32 peer;          /* Features advertised by peer. */
 118
 119     ovs_be32 curr_speed;    /* Current port bitrate in kbps. */
 120     ovs_be32 max_speed;     /* Max port bitrate in kbps */
 121 };
 122
 123 /* Modify behavior of the physical port */
 124 struct ofp11_port_mod {
 125     ovs_be32 port_no;
 126     uint8_t pad[4];
 127     uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
 128                                       configurable.  This is used to
 129                                       sanity-check the request, so it must
 130                                       be the same as returned in an
 131                                       ofp11_port struct. */
 132     uint8_t pad2[2];        /* Pad to 64 bits. */
 133     ovs_be32 config;        /* Bitmap of OFPPC_* flags. */
 134     ovs_be32 mask;          /* Bitmap of OFPPC_* flags to be changed. */
 135
 136     ovs_be32 advertise;     /* Bitmap of OFPPF_* and OFPPF11_*.  Zero all bits
 137                                to prevent any action taking place. */
 138     uint8_t pad3[4];        /* Pad to 64 bits. */
 139 };
 140 OFP_ASSERT(sizeof(struct ofp11_port_mod) == 32);
 141
 142 /* Group setup and teardown (controller -> datapath). */
 143 struct ofp11_group_mod {
 144     ovs_be16 command;             /* One of OFPGC_*. */
 145     uint8_t type;                 /* One of OFPGT_*. */
 146     uint8_t pad;                  /* Pad to 64 bits. */
 147     ovs_be32 group_id;            /* Group identifier. */
 148     /* struct ofp11_bucket buckets[0]; The bucket length is inferred from the
 149                                        length field in the header. */
 150 };
 151 OFP_ASSERT(sizeof(struct ofp11_group_mod) == 8);
 152
 153 /* Query for port queue configuration. */
 154 struct ofp11_queue_get_config_request {
 155     ovs_be32 port;
 156     /* Port to be queried. Should refer
 157        to a valid physical port (i.e. < OFPP_MAX) */
 158     uint8_t pad[4];
 159 };
 160 OFP_ASSERT(sizeof(struct ofp11_queue_get_config_request) == 8);
 161
 162 /* Group commands */
 163 enum ofp11_group_mod_command {
 164     OFPGC11_ADD,          /* New group. */
 165     OFPGC11_MODIFY,       /* Modify all matching groups. */
 166     OFPGC11_DELETE,       /* Delete all matching groups. */
 167 };
 168
 169 /* OpenFlow 1.1 specific capabilities supported by the datapath (struct
 170  * ofp_switch_features, member capabilities). */
 171 enum ofp11_capabilities {
 172     OFPC11_GROUP_STATS    = 1 << 3,  /* Group statistics. */
 173 };
 174
 175 enum ofp11_action_type {
 176     OFPAT11_OUTPUT,           /* Output to switch port. */
 177     OFPAT11_SET_VLAN_VID,     /* Set the 802.1q VLAN id. */
 178     OFPAT11_SET_VLAN_PCP,     /* Set the 802.1q priority. */
 179     OFPAT11_SET_DL_SRC,       /* Ethernet source address. */
 180     OFPAT11_SET_DL_DST,       /* Ethernet destination address. */
 181     OFPAT11_SET_NW_SRC,       /* IP source address. */
 182     OFPAT11_SET_NW_DST,       /* IP destination address. */
 183     OFPAT11_SET_NW_TOS,       /* IP ToS (DSCP field, 6 bits). */
 184     OFPAT11_SET_NW_ECN,       /* IP ECN (2 bits). */
 185     OFPAT11_SET_TP_SRC,       /* TCP/UDP/SCTP source port. */
 186     OFPAT11_SET_TP_DST,       /* TCP/UDP/SCTP destination port. */
 187     OFPAT11_COPY_TTL_OUT,     /* Copy TTL "outwards" -- from next-to-outermost
 188                                  to outermost */
 189     OFPAT11_COPY_TTL_IN,      /* Copy TTL "inwards" -- from outermost to
 190                                next-to-outermost */
 191     OFPAT11_SET_MPLS_LABEL,   /* MPLS label */
 192     OFPAT11_SET_MPLS_TC,      /* MPLS TC */
 193     OFPAT11_SET_MPLS_TTL,     /* MPLS TTL */
 194     OFPAT11_DEC_MPLS_TTL,     /* Decrement MPLS TTL */
 195
 196     OFPAT11_PUSH_VLAN,        /* Push a new VLAN tag */
 197     OFPAT11_POP_VLAN,         /* Pop the outer VLAN tag */
 198     OFPAT11_PUSH_MPLS,        /* Push a new MPLS tag */
 199     OFPAT11_POP_MPLS,         /* Pop the outer MPLS tag */
 200     OFPAT11_SET_QUEUE,        /* Set queue id when outputting to a port */
 201     OFPAT11_GROUP,            /* Apply group. */
 202     OFPAT11_SET_NW_TTL,       /* IP TTL. */
 203     OFPAT11_DEC_NW_TTL,       /* Decrement IP TTL. */
 204     OFPAT11_EXPERIMENTER = 0xffff
 205 };
 206
 207 #define OFPMT11_STANDARD_LENGTH 88
 208
 209 struct ofp11_match_header {
 210     ovs_be16 type;             /* One of OFPMT_* */
 211     ovs_be16 length;           /* Length of match */
 212 };
 213 OFP_ASSERT(sizeof(struct ofp11_match_header) == 4);
 214
 215 /* Fields to match against flows */
 216 struct ofp11_match {
 217     struct ofp11_match_header omh;
 218     ovs_be32 in_port;          /* Input switch port. */
 219     ovs_be32 wildcards;        /* Wildcard fields. */
 220     uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
 221     uint8_t dl_src_mask[OFP_ETH_ALEN]; /* Ethernet source address mask.  */
 222     uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
 223     uint8_t dl_dst_mask[OFP_ETH_ALEN]; /* Ethernet destination address mask. */
 224     ovs_be16 dl_vlan;          /* Input VLAN id. */
 225     uint8_t dl_vlan_pcp;       /* Input VLAN priority. */
 226     uint8_t pad1[1];           /* Align to 32-bits */
 227     ovs_be16 dl_type;          /* Ethernet frame type. */
 228     uint8_t nw_tos;            /* IP ToS (actually DSCP field, 6 bits). */
 229     uint8_t nw_proto;          /* IP protocol or lower 8 bits of ARP opcode. */
 230     ovs_be32 nw_src;           /* IP source address. */
 231     ovs_be32 nw_src_mask;      /* IP source address mask. */
 232     ovs_be32 nw_dst;           /* IP destination address. */
 233     ovs_be32 nw_dst_mask;      /* IP destination address mask. */
 234     ovs_be16 tp_src;           /* TCP/UDP/SCTP source port. */
 235     ovs_be16 tp_dst;           /* TCP/UDP/SCTP destination port. */
 236     ovs_be32 mpls_label;       /* MPLS label. */
 237     uint8_t mpls_tc;           /* MPLS TC. */
 238     uint8_t pad2[3];           /* Align to 64-bits */
 239     ovs_be64 metadata;         /* Metadata passed between tables. */
 240     ovs_be64 metadata_mask;    /* Mask for metadata. */
 241 };
 242 OFP_ASSERT(sizeof(struct ofp11_match) == OFPMT11_STANDARD_LENGTH);
 243
 244 /* Flow wildcards. */
 245 enum ofp11_flow_wildcards {
 246     OFPFW11_IN_PORT     = 1 << 0,  /* Switch input port. */
 247     OFPFW11_DL_VLAN     = 1 << 1,  /* VLAN id. */
 248     OFPFW11_DL_VLAN_PCP = 1 << 2,  /* VLAN priority. */
 249     OFPFW11_DL_TYPE     = 1 << 3,  /* Ethernet frame type. */
 250     OFPFW11_NW_TOS      = 1 << 4,  /* IP ToS (DSCP field, 6 bits). */
 251     OFPFW11_NW_PROTO    = 1 << 5,  /* IP protocol. */
 252     OFPFW11_TP_SRC      = 1 << 6,  /* TCP/UDP/SCTP source port. */
 253     OFPFW11_TP_DST      = 1 << 7,  /* TCP/UDP/SCTP destination port. */
 254     OFPFW11_MPLS_LABEL  = 1 << 8,  /* MPLS label. */
 255     OFPFW11_MPLS_TC     = 1 << 9,  /* MPLS TC. */
 256
 257     /* Wildcard all fields. */
 258     OFPFW11_ALL           = ((1 << 10) - 1)
 259 };
 260
 261 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
 262  * special conditions.
 263  */
 264 enum ofp11_vlan_id {
 265     OFPVID11_ANY = 0xfffe,  /* Indicate that a VLAN id is set but don't care
 266                                about it's value. Note: only valid when
 267                                specifying the VLAN id in a match */
 268     OFPVID11_NONE = 0xffff, /* No VLAN id was set. */
 269 };
 270
 271 enum ofp11_instruction_type {
 272     OFPIT11_GOTO_TABLE = 1,        /* Setup the next table in the lookup
 273                                       pipeline */
 274     OFPIT11_WRITE_METADATA = 2,    /* Setup the metadata field for use later
 275                                       in pipeline */
 276     OFPIT11_WRITE_ACTIONS = 3,     /* Write the action(s) onto the datapath
 277                                       action set */
 278     OFPIT11_APPLY_ACTIONS = 4,     /* Applies the action(s) immediately */
 279     OFPIT11_CLEAR_ACTIONS = 5,     /* Clears all actions from the datapath
 280                                       action set */
 281     OFPIT11_EXPERIMENTER = 0xFFFF  /* Experimenter instruction */
 282 };
 283
 284 #define OFPIT11_ALL (OFPIT11_GOTO_TABLE | OFPIT11_WRITE_METADATA |      \
 285                      OFPIT11_WRITE_ACTIONS | OFPIT11_APPLY_ACTIONS |    \
 286                      OFPIT11_CLEAR_ACTIONS)
 287
 288 #define OFP11_INSTRUCTION_ALIGN 8
 289
 290 /* Generic ofp_instruction structure. */
 291 struct ofp11_instruction {
 292     ovs_be16 type;              /* Instruction type */
 293     ovs_be16 len;               /* Length of this struct in bytes. */
 294     uint8_t pad[4];             /* Align to 64-bits */
 295 };
 296 OFP_ASSERT(sizeof(struct ofp11_instruction) == 8);
 297
 298 /* Instruction structure for OFPIT_GOTO_TABLE */
 299 struct ofp11_instruction_goto_table {
 300     ovs_be16 type;                 /* OFPIT_GOTO_TABLE */
 301     ovs_be16 len;                  /* Length of this struct in bytes. */
 302     uint8_t table_id;              /* Set next table in the lookup pipeline */
 303     uint8_t pad[3];                /* Pad to 64 bits. */
 304 };
 305 OFP_ASSERT(sizeof(struct ofp11_instruction_goto_table) == 8);
 306
 307 /* Instruction structure for OFPIT_WRITE_METADATA */
 308 struct ofp11_instruction_write_metadata {
 309     ovs_be16 type;              /* OFPIT_WRITE_METADATA */
 310     ovs_be16 len;               /* Length of this struct in bytes. */
 311     uint8_t pad[4];             /* Align to 64-bits */
 312     ovs_be64 metadata;          /* Metadata value to write */
 313     ovs_be64 metadata_mask;     /* Metadata write bitmask */
 314 };
 315 OFP_ASSERT(sizeof(struct ofp11_instruction_write_metadata) == 24);
 316
 317 /* Instruction structure for OFPIT_WRITE/APPLY/CLEAR_ACTIONS */
 318 struct ofp11_instruction_actions {
 319     ovs_be16 type;              /* One of OFPIT_*_ACTIONS */
 320     ovs_be16 len;               /* Length of this struct in bytes. */
 321     uint8_t pad[4];             /* Align to 64-bits */
 322     /* struct ofp_action_header actions[0];  Actions associated with
 323                                              OFPIT_WRITE_ACTIONS and
 324                                              OFPIT_APPLY_ACTIONS */
 325 };
 326 OFP_ASSERT(sizeof(struct ofp11_instruction_actions) == 8);
 327
 328 /* Instruction structure for experimental instructions */
 329 struct ofp11_instruction_experimenter {
 330     ovs_be16 type;              /* OFPIT11_EXPERIMENTER */
 331     ovs_be16 len;               /* Length of this struct in bytes */
 332     ovs_be32 experimenter;      /* Experimenter ID which takes the same form
 333                                    as in struct ofp_vendor_header. */
 334     /* Experimenter-defined arbitrary additional data. */
 335 };
 336 OFP_ASSERT(sizeof(struct ofp11_instruction_experimenter) == 8);
 337
 338 /* Action structure for OFPAT_OUTPUT, which sends packets out 'port'.
 339    * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
 340    * number of bytes to send. A 'max_len' of zero means no bytes of the
 341    * packet should be sent.*/
 342 struct ofp11_action_output {
 343     ovs_be16 type;                    /* OFPAT11_OUTPUT. */
 344     ovs_be16 len;                     /* Length is 16. */
 345     ovs_be32 port;                    /* Output port. */
 346     ovs_be16 max_len;                 /* Max length to send to controller. */
 347     uint8_t pad[6];                   /* Pad to 64 bits. */
 348 };
 349 OFP_ASSERT(sizeof(struct ofp11_action_output) == 16);
 350
 351 /* Action structure for OFPAT_GROUP. */
 352 struct ofp11_action_group {
 353     ovs_be16 type;                    /* OFPAT11_GROUP. */
 354     ovs_be16 len;                     /* Length is 8. */
 355     ovs_be32 group_id;                /* Group identifier. */
 356 };
 357 OFP_ASSERT(sizeof(struct ofp11_action_group) == 8);
 358
 359 /* OFPAT_SET_QUEUE action struct: send packets to given queue on port. */
 360 struct ofp11_action_set_queue {
 361     ovs_be16 type;                    /* OFPAT11_SET_QUEUE. */
 362     ovs_be16 len;                     /* Len is 8. */
 363     ovs_be32 queue_id;                /* Queue id for the packets. */
 364 };
 365 OFP_ASSERT(sizeof(struct ofp11_action_set_queue) == 8);
 366
 367 /* Action structure for OFPAT11_SET_MPLS_LABEL. */
 368 struct ofp11_action_mpls_label {
 369     ovs_be16 type;                    /* OFPAT11_SET_MPLS_LABEL. */
 370     ovs_be16 len;                     /* Length is 8. */
 371     ovs_be32 mpls_label;              /* MPLS label */
 372 };
 373 OFP_ASSERT(sizeof(struct ofp11_action_mpls_label) == 8);
 374
 375 /* Action structure for OFPAT11_SET_MPLS_TC. */
 376 struct ofp11_action_mpls_tc {
 377     ovs_be16 type;                    /* OFPAT11_SET_MPLS_TC. */
 378     ovs_be16 len;                     /* Length is 8. */
 379     uint8_t mpls_tc;                  /* MPLS TC */
 380     uint8_t pad[3];
 381 };
 382 OFP_ASSERT(sizeof(struct ofp11_action_mpls_tc) == 8);
 383
 384 /* Action structure for OFPAT11_SET_MPLS_TTL. */
 385 struct ofp11_action_mpls_ttl {
 386     ovs_be16 type;                    /* OFPAT11_SET_MPLS_TTL. */
 387     ovs_be16 len;                     /* Length is 8. */
 388     uint8_t mpls_ttl;                 /* MPLS TTL */
 389     uint8_t pad[3];
 390 };
 391 OFP_ASSERT(sizeof(struct ofp11_action_mpls_ttl) == 8);
 392
 393 /* Action structure for OFPAT11_SET_NW_ECN. */
 394 struct ofp11_action_nw_ecn {
 395     ovs_be16 type;                    /* OFPAT11_SET_TW_SRC/DST. */
 396     ovs_be16 len;                     /* Length is 8. */
 397     uint8_t nw_ecn;                   /* IP ECN (2 bits). */
 398     uint8_t pad[3];
 399 };
 400 OFP_ASSERT(sizeof(struct ofp11_action_nw_ecn) == 8);
 401
 402 /* Action structure for OFPAT11_SET_NW_TTL. */
 403 struct ofp11_action_nw_ttl {
 404     ovs_be16 type;                    /* OFPAT11_SET_NW_TTL. */
 405     ovs_be16 len;                     /* Length is 8. */
 406     uint8_t nw_ttl;                   /* IP TTL */
 407     uint8_t pad[3];
 408 };
 409 OFP_ASSERT(sizeof(struct ofp11_action_nw_ttl) == 8);
 410
 411 /* Action structure for OFPAT11_PUSH_VLAN/MPLS. */
 412 struct ofp11_action_push {
 413     ovs_be16 type;                    /* OFPAT11_PUSH_VLAN/MPLS. */
 414     ovs_be16 len;                     /* Length is 8. */
 415     ovs_be16 ethertype;               /* Ethertype */
 416     uint8_t pad[2];
 417 };
 418 OFP_ASSERT(sizeof(struct ofp11_action_push) == 8);
 419
 420 /* Action structure for OFPAT11_POP_MPLS. */
 421 struct ofp11_action_pop_mpls {
 422     ovs_be16 type;                    /* OFPAT11_POP_MPLS. */
 423     ovs_be16 len;                     /* Length is 8. */
 424     ovs_be16 ethertype;               /* Ethertype */
 425     uint8_t pad[2];
 426 };
 427 OFP_ASSERT(sizeof(struct ofp11_action_pop_mpls) == 8);
 428
 429 /* Configure/Modify behavior of a flow table */
 430 struct ofp11_table_mod {
 431     uint8_t table_id;       /* ID of the table, 0xFF indicates all tables */
 432     uint8_t pad[3];         /* Pad to 32 bits */
 433     ovs_be32 config;        /* Bitmap of OFPTC_* flags */
 434 };
 435 OFP_ASSERT(sizeof(struct ofp11_table_mod) == 8);
 436
 437 /* Flags to indicate behavior of the flow table for unmatched packets.
 438    These flags are used in ofp_table_stats messages to describe the current
 439    configuration and in ofp_table_mod messages to configure table behavior.  */
 440 enum ofp11_table_config {
 441     OFPTC11_TABLE_MISS_CONTROLLER = 0,    /* Send to controller. */
 442     OFPTC11_TABLE_MISS_CONTINUE = 1 << 0, /* Continue to the next table in the
 443                                              pipeline (OpenFlow 1.0
 444                                              behavior). */
 445     OFPTC11_TABLE_MISS_DROP = 1 << 1,     /* Drop the packet. */
 446     OFPTC11_TABLE_MISS_MASK = 3
 447 };
 448
 449 /* Flow setup and teardown (controller -> datapath). */
 450 struct ofp11_flow_mod {
 451     ovs_be64 cookie;             /* Opaque controller-issued identifier. */
 452     ovs_be64 cookie_mask;        /* Mask used to restrict the cookie bits
 453                                     that must match when the command is
 454                                     OFPFC_MODIFY* or OFPFC_DELETE*. A value
 455                                     of 0 indicates no restriction. */
 456     /* Flow actions. */
 457     uint8_t table_id;            /* ID of the table to put the flow in */
 458     uint8_t command;             /* One of OFPFC_*. */
 459     ovs_be16 idle_timeout;       /* Idle time before discarding (seconds). */
 460     ovs_be16 hard_timeout;       /* Max time before discarding (seconds). */
 461     ovs_be16 priority;           /* Priority level of flow entry. */
 462     ovs_be32 buffer_id;          /* Buffered packet to apply to (or -1).
 463                                     Not meaningful for OFPFC_DELETE*. */
 464     ovs_be32 out_port;           /* For OFPFC_DELETE* commands, require
 465                                     matching entries to include this as an
 466                                     output port. A value of OFPP_ANY
 467                                     indicates no restriction. */
 468     ovs_be32 out_group;          /* For OFPFC_DELETE* commands, require
 469                                     matching entries to include this as an
 470                                     output group. A value of OFPG11_ANY
 471                                     indicates no restriction. */
 472     ovs_be16 flags;              /* One of OFPFF_*. */
 473     uint8_t pad[2];
 474     /* Followed by an ofp11_match structure. */
 475     /* Followed by an instruction set. */
 476 };
 477 OFP_ASSERT(sizeof(struct ofp11_flow_mod) == 40);
 478
 479 /* Group types. Values in the range [128, 255] are reserved for experimental
 480  * use. */
 481 enum ofp11_group_type {
 482     OFPGT11_ALL,      /* All (multicast/broadcast) group. */
 483     OFPGT11_SELECT,   /* Select group. */
 484     OFPGT11_INDIRECT, /* Indirect group. */
 485     OFPGT11_FF        /* Fast failover group. */
 486 };
 487
 488 /* Group numbering. Groups can use any number up to OFPG_MAX. */
 489 enum ofp11_group {
 490     /* Last usable group number. */
 491     OFPG11_MAX        = 0xffffff00,
 492
 493     /* Fake groups. */
 494     OFPG11_ALL        = 0xfffffffc,  /* Represents all groups for group delete
 495                                         commands. */
 496     OFPG11_ANY        = 0xffffffff   /* Wildcard group used only for flow stats
 497                                         requests. Selects all flows regardless
 498                                         of group (including flows with no
 499                                         group). */
 500 };
 501
 502 /* Bucket for use in groups. */
 503 struct ofp11_bucket {
 504     ovs_be16 len;                    /* Length the bucket in bytes, including
 505                                         this header and any padding to make it
 506                                         64-bit aligned. */
 507     ovs_be16 weight;                 /* Relative weight of bucket. Only
 508                                         defined for select groups. */
 509     ovs_be32 watch_port;             /* Port whose state affects whether this
 510                                         bucket is live. Only required for fast
 511                                         failover groups. */
 512     ovs_be32 watch_group;            /* Group whose state affects whether this
 513                                         bucket is live. Only required for fast
 514                                         failover groups. */
 515     uint8_t pad[4];
 516     /* struct ofp_action_header actions[0]; The action length is inferred
 517                                             from the length field in the
 518                                             header. */
 519 };
 520 OFP_ASSERT(sizeof(struct ofp11_bucket) == 16);
 521
 522 /* Queue configuration for a given port. */
 523 struct ofp11_queue_get_config_reply {
 524     ovs_be32 port;
 525     uint8_t pad[4];
 526     /* struct ofp_packet_queue queues[0];  List of configured queues. */
 527 };
 528 OFP_ASSERT(sizeof(struct ofp11_queue_get_config_reply) == 8);
 529
 530 struct ofp11_stats_msg {
 531     struct ofp_header header;
 532     ovs_be16 type;              /* One of the OFPST_* constants. */
 533     ovs_be16 flags;             /* OFPSF_REQ_* flags (none yet defined). */
 534     uint8_t pad[4];
 535     /* Followed by the body of the request. */
 536 };
 537 OFP_ASSERT(sizeof(struct ofp11_stats_msg) == 16);
 538
 539 /* Vendor extension stats message. */
 540 struct ofp11_vendor_stats_msg {
 541     struct ofp11_stats_msg osm; /* Type OFPST_VENDOR. */
 542     ovs_be32 vendor;            /* Vendor ID:
 543                                  * - MSB 0: low-order bytes are IEEE OUI.
 544                                  * - MSB != 0: defined by OpenFlow
 545                                  *   consortium. */
 546     /* Followed by vendor-defined arbitrary additional data. */
 547 };
 548 OFP_ASSERT(sizeof(struct ofp11_vendor_stats_msg) == 20);
 549
 550 /* Stats request of type OFPST_FLOW. */
 551 struct ofp11_flow_stats_request {
 552     uint8_t table_id;         /* ID of table to read (from ofp_table_stats),
 553                                  0xff for all tables. */
 554     uint8_t pad[3];           /* Align to 64 bits. */
 555     ovs_be32 out_port;        /* Require matching entries to include this
 556                                  as an output port. A value of OFPP_ANY
 557                                  indicates no restriction. */
 558     ovs_be32 out_group;       /* Require matching entries to include this
 559                                  as an output group. A value of OFPG11_ANY
 560                                  indicates no restriction. */
 561     uint8_t pad2[4];          /* Align to 64 bits. */
 562     ovs_be64 cookie;          /* Require matching entries to contain this
 563                                  cookie value */
 564     ovs_be64 cookie_mask;     /* Mask used to restrict the cookie bits that
 565                                  must match. A value of 0 indicates
 566                                  no restriction. */
 567     /* Followed by an ofp11_match structure. */
 568 };
 569 OFP_ASSERT(sizeof(struct ofp11_flow_stats_request) == 32);
 570
 571 /* Body of reply to OFPST_FLOW request. */
 572 struct ofp11_flow_stats {
 573     ovs_be16 length;           /* Length of this entry. */
 574     uint8_t table_id;          /* ID of table flow came from. */
 575     uint8_t pad;
 576     ovs_be32 duration_sec;     /* Time flow has been alive in seconds. */
 577     ovs_be32 duration_nsec;    /* Time flow has been alive in nanoseconds beyond
 578                                   duration_sec. */
 579     ovs_be16 priority;         /* Priority of the entry. Only meaningful
 580                                   when this is not an exact-match entry. */
 581     ovs_be16 idle_timeout;     /* Number of seconds idle before expiration. */
 582     ovs_be16 hard_timeout;     /* Number of seconds before expiration. */
 583     uint8_t pad2[6];           /* Align to 64-bits. */
 584     ovs_be64 cookie;           /* Opaque controller-issued identifier. */
 585     ovs_be64 packet_count;     /* Number of packets in flow. */
 586     ovs_be64 byte_count;       /* Number of bytes in flow. */
 587     /* Open Flow version specific match */
 588     /* struct ofp11_instruction instructions[0];  Instruction set. */
 589 };
 590 OFP_ASSERT(sizeof(struct ofp11_flow_stats) == 48);
 591
 592 /* Body for ofp_stats_request of type OFPST_AGGREGATE. */
 593 /* Identical to ofp11_flow_stats_request */
 594
 595 /* Flow match fields. */
 596 enum ofp11_flow_match_fields {
 597     OFPFMF11_IN_PORT     = 1 << 0,  /* Switch input port. */
 598     OFPFMF11_DL_VLAN     = 1 << 1,  /* VLAN id. */
 599     OFPFMF11_DL_VLAN_PCP = 1 << 2,  /* VLAN priority. */
 600     OFPFMF11_DL_TYPE     = 1 << 3,  /* Ethernet frame type. */
 601     OFPFMF11_NW_TOS      = 1 << 4,  /* IP ToS (DSCP field, 6 bits). */
 602     OFPFMF11_NW_PROTO    = 1 << 5,  /* IP protocol. */
 603     OFPFMF11_TP_SRC      = 1 << 6,  /* TCP/UDP/SCTP source port. */
 604     OFPFMF11_TP_DST      = 1 << 7,  /* TCP/UDP/SCTP destination port. */
 605     OFPFMF11_MPLS_LABEL  = 1 << 8,  /* MPLS label. */
 606     OFPFMF11_MPLS_TC     = 1 << 9,  /* MPLS TC. */
 607     OFPFMF11_TYPE        = 1 << 10, /* Match type. */
 608     OFPFMF11_DL_SRC      = 1 << 11, /* Ethernet source address. */
 609     OFPFMF11_DL_DST      = 1 << 12, /* Ethernet destination address. */
 610     OFPFMF11_NW_SRC      = 1 << 13, /* IP source address. */
 611     OFPFMF11_NW_DST      = 1 << 14, /* IP destination address. */
 612     OFPFMF11_METADATA    = 1 << 15, /* Metadata passed between tables. */
 613 };
 614
 615 /* Body of reply to OFPST_TABLE request. */
 616 struct ofp11_table_stats {
 617     uint8_t table_id;        /* Identifier of table. Lower numbered tables
 618                                 are consulted first. */
 619     uint8_t pad[7];          /* Align to 64-bits. */
 620     char name[OFP_MAX_TABLE_NAME_LEN];
 621     ovs_be32 wildcards;      /* Bitmap of OFPFMF_* wildcards that are
 622                                 supported by the table. */
 623     ovs_be32 match;          /* Bitmap of OFPFMF_* that indicate the fields
 624                                 the table can match on. */
 625     ovs_be32 instructions;   /* Bitmap of OFPIT_* values supported. */
 626     ovs_be32 write_actions;  /* Bitmap of OFPAT_* that are supported
 627                                 by the table with OFPIT_WRITE_ACTIONS.  */
 628     ovs_be32 apply_actions;  /* Bitmap of OFPAT_* that are supported
 629                                 by the table with OFPIT_APPLY_ACTIONS. */
 630     ovs_be32 config;         /* Bitmap of OFPTC_* values */
 631     ovs_be32 max_entries;    /* Max number of entries supported. */
 632     ovs_be32 active_count;   /* Number of active entries. */
 633     ovs_be64 lookup_count;   /* Number of packets looked up in table. */
 634     ovs_be64 matched_count;  /* Number of packets that hit table. */
 635 };
 636 OFP_ASSERT(sizeof(struct ofp11_table_stats) == 88);
 637
 638 /* Body for ofp_stats_request of type OFPST_PORT. */
 639 struct ofp11_port_stats_request {
 640     ovs_be32 port_no;        /* OFPST_PORT message must request statistics
 641                               * either for a single port (specified in
 642                               * port_no) or for all ports (if port_no ==
 643                               * OFPP_ANY). */
 644     uint8_t pad[4];
 645 };
 646 OFP_ASSERT(sizeof(struct ofp11_port_stats_request) == 8);
 647
 648 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
 649  * the field to all ones. */
 650 struct ofp11_port_stats {
 651     ovs_be32 port_no;
 652     uint8_t pad[4];           /* Align to 64-bits. */
 653     ovs_be64 rx_packets;      /* Number of received packets. */
 654     ovs_be64 tx_packets;      /* Number of transmitted packets. */
 655     ovs_be64 rx_bytes;        /* Number of received bytes. */
 656     ovs_be64 tx_bytes;        /* Number of transmitted bytes. */
 657     ovs_be64 rx_dropped;      /* Number of packets dropped by RX. */
 658     ovs_be64 tx_dropped;      /* Number of packets dropped by TX. */
 659     ovs_be64 rx_errors;       /* Number of receive errors.  This is a
 660                                  super-set of receive errors and should be
 661                                  great than or equal to the sum of all
 662                                  rx_*_err values. */
 663     ovs_be64 tx_errors;       /* Number of transmit errors.  This is a
 664                                  super-set of transmit errors. */
 665     ovs_be64 rx_frame_err;    /* Number of frame alignment errors. */
 666     ovs_be64 rx_over_err;     /* Number of packets with RX overrun. */
 667     ovs_be64 rx_crc_err;      /* Number of CRC errors. */
 668     ovs_be64 collisions;      /* Number of collisions. */
 669 };
 670 OFP_ASSERT(sizeof(struct ofp11_port_stats) == 104);
 671
 672 struct ofp11_queue_stats_request {
 673     ovs_be32 port_no;         /* All ports if OFPP_ANY. */
 674     ovs_be32 queue_id;        /* All queues if OFPQ_ALL. */
 675 };
 676 OFP_ASSERT(sizeof(struct ofp11_queue_stats_request) == 8);
 677
 678 struct ofp11_queue_stats {
 679     ovs_be32 port_no;
 680     ovs_be32 queue_id;         /* Queue id. */
 681     ovs_be64 tx_bytes;         /* Number of transmitted bytes. */
 682     ovs_be64 tx_packets;       /* Number of transmitted packets. */
 683     ovs_be64 tx_errors;        /* # of packets dropped due to overrun. */
 684 };
 685 OFP_ASSERT(sizeof(struct ofp11_queue_stats) == 32);
 686
 687 struct ofp11_group_stats_request {
 688     ovs_be32 group_id;         /* All groups if OFPG_ALL. */
 689     uint8_t pad[4];            /* Align to 64 bits. */
 690 };
 691 OFP_ASSERT(sizeof(struct ofp11_group_stats_request) == 8);
 692
 693 /* Body of reply to OFPST11_GROUP request */
 694 struct ofp11_group_stats {
 695     ovs_be16 length;           /* Length of this entry. */
 696     uint8_t pad[2];            /* Align to 64 bits. */
 697     ovs_be32 group_id;         /* Group identifier. */
 698     ovs_be32 ref_count;        /* Number of flows or groups that
 699                                   directly forward to this group. */
 700     uint8_t pad2[4];           /* Align to 64 bits. */
 701     ovs_be64 packet_count;     /* Number of packets processed by group. */
 702     ovs_be64 byte_count;       /* Number of bytes processed by group. */
 703     /* struct ofp11_bucket_counter bucket_stats[0]; */
 704
 705 };
 706 OFP_ASSERT(sizeof(struct ofp11_group_stats) == 32);
 707
 708 /* Used in group stats replies. */
 709 struct ofp11_bucket_counter {
 710     ovs_be64 packet_count;   /* Number of packets processed by bucket. */
 711     ovs_be64 byte_count;     /* Number of bytes processed by bucket. */
 712 };
 713 OFP_ASSERT(sizeof(struct ofp11_bucket_counter) == 16);
 714
 715 /* Body of reply to OFPST11_GROUP_DESC request. */
 716 struct ofp11_group_desc_stats {
 717     ovs_be16 length;            /* Length of this entry. */
 718     uint8_t type;               /* One of OFPGT_*. */
 719     uint8_t pad;                /* Pad to 64 bits. */
 720     ovs_be32 group_id;          /* Group identifier. */
 721     /* struct ofp11_bucket buckets[0]; */
 722 };
 723 OFP_ASSERT(sizeof(struct ofp11_group_desc_stats) == 8);
 724
 725 /* Send packet (controller -> datapath). */
 726 struct ofp11_packet_out {
 727     ovs_be32 buffer_id;       /* ID assigned by datapath (-1 if none). */
 728     ovs_be32 in_port;         /* Packet's input port or OFPP_CONTROLLER. */
 729     ovs_be16 actions_len;     /* Size of action array in bytes. */
 730     uint8_t pad[6];
 731     /* struct ofp_action_header actions[0];  Action list. */
 732     /* uint8_t data[0]; */    /* Packet data. The length is inferred
 733                                  from the length field in the header.
 734                                  (Only meaningful if buffer_id == -1.) */
 735 };
 736 OFP_ASSERT(sizeof(struct ofp11_packet_out) == 16);
 737
 738 /* Packet received on port (datapath -> controller). */
 739 struct ofp11_packet_in {
 740     ovs_be32 buffer_id;     /* ID assigned by datapath. */
 741     ovs_be32 in_port;       /* Port on which frame was received. */
 742     ovs_be32 in_phy_port;   /* Physical Port on which frame was received. */
 743     ovs_be16 total_len;     /* Full length of frame. */
 744     uint8_t reason;         /* Reason packet is being sent (one of OFPR_*) */
 745     uint8_t table_id;       /* ID of the table that was looked up */
 746     uint8_t data[0];        /* Ethernet frame, halfway through 32-bit word,
 747                                so the IP header is 32-bit aligned. The
 748                                amount of data is inferred from the length
 749                                field in the header. Because of padding,
 750                                offsetof(struct ofp_packet_in, data) ==
 751                                sizeof(struct ofp_packet_in) - 2. */
 752 };
 753 OFP_ASSERT(sizeof(struct ofp11_packet_in) == 16);
 754
 755 /* Flow removed (datapath -> controller). */
 756 struct ofp11_flow_removed {
 757     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
 758
 759     ovs_be16 priority;        /* Priority level of flow entry. */
 760     uint8_t reason;           /* One of OFPRR_*. */
 761     uint8_t table_id;         /* ID of the table */
 762
 763     ovs_be32 duration_sec;    /* Time flow was alive in seconds. */
 764     ovs_be32 duration_nsec;   /* Time flow was alive in nanoseconds beyond
 765                                  duration_sec. */
 766     ovs_be16 idle_timeout;    /* Idle timeout from original flow mod. */
 767     uint8_t pad2[2];          /* Align to 64-bits. */
 768     ovs_be64 packet_count;
 769     ovs_be64 byte_count;
 770     /* Followed by an ofp11_match structure. */
 771 };
 772 OFP_ASSERT(sizeof(struct ofp11_flow_removed) == 40);
 773
 774 #endif /* openflow/openflow-1.1.h */