include/openflow/openflow-1.4.h

   1 /* Copyright (c) 2008, 2014 The Board of Trustees of The Leland Stanford
   2 * Junior University
   3 * Copyright (c) 2011, 2012 Open Networking Foundation
   4 *
   5 * We are making the OpenFlow specification and associated documentation
   6 * (Software) available for public use and benefit with the expectation
   7 * that others will use, modify and enhance the Software and contribute
   8 * those enhancements back to the community. However, since we would
   9 * like to make the Software available for broadest use, with as few
  10 * restrictions as possible permission is hereby granted, free of
  11 * charge, to any person obtaining a copy of this Software to deal in
  12 * the Software under the copyrights without restriction, including
  13 * without limitation the rights to use, copy, modify, merge, publish,
  14 * distribute, sublicense, and/or sell copies of the Software, and to
  15 * permit persons to whom the Software is furnished to do so, subject to
  16 * the following conditions:
  17 *
  18 * The above copyright notice and this permission notice shall be
  19 * included in all copies or substantial portions of the Software.
  20 *
  21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  22 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  23 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  24 * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  25 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  26 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  27 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  28 * SOFTWARE.
  29 *
  30 * The name and trademarks of copyright holder(s) may NOT be used in
  31 * advertising or publicity pertaining to the Software or any
  32 * derivatives without specific, written prior permission.
  33 */
  34
  35 /* OpenFlow: protocol between controller and datapath. */
  36
  37 #ifndef OPENFLOW_14_H
  38 #define OPENFLOW_14_H 1
  39
  40 #include "openflow/openflow-1.3.h"
  41 /*
  42  * OpenFlow 1.4 is more extensible by using TLV structures
  43  */
  44
  45 /* Port description property types. */
  46 enum ofp_port_desc_prop_type {
  47     OFPPDPT14_ETHERNET          = 0,      /* Ethernet property. */
  48     OFPPDPT14_OPTICAL           = 1,      /* Optical property. */
  49     OFPPDPT14_EXPERIMENTER      = 0xFFFF, /* Experimenter property. */
  50 };
  51
  52 /* Ethernet port description property. */
  53 struct ofp14_port_desc_prop_ethernet {
  54     ovs_be16         type;    /* OFPPDPT14_ETHERNET. */
  55     ovs_be16         length;  /* Length in bytes of this property. */
  56     uint8_t          pad[4];  /* Align to 64 bits. */
  57     /* Bitmaps of OFPPF_* that describe features.  All bits zeroed if
  58      * unsupported or unavailable. */
  59     ovs_be32 curr;          /* Current features. */
  60     ovs_be32 advertised;    /* Features being advertised by the port. */
  61     ovs_be32 supported;     /* Features supported by the port. */
  62     ovs_be32 peer;          /* Features advertised by peer. */
  63
  64     ovs_be32 curr_speed;    /* Current port bitrate in kbps. */
  65     ovs_be32 max_speed;     /* Max port bitrate in kbps */
  66 };
  67 OFP_ASSERT(sizeof(struct ofp14_port_desc_prop_ethernet) == 32);
  68
  69 struct ofp14_port {
  70     ovs_be32 port_no;
  71     ovs_be16 length;
  72     uint8_t pad[2];
  73     uint8_t hw_addr[OFP_ETH_ALEN];
  74     uint8_t pad2[2];                  /* Align to 64 bits. */
  75     char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
  76
  77     ovs_be32 config;        /* Bitmap of OFPPC_* flags. */
  78     ovs_be32 state;         /* Bitmap of OFPPS_* flags. */
  79
  80     /* Followed by 0 or more OFPPDPT14_* properties. */
  81 };
  82 OFP_ASSERT(sizeof(struct ofp14_port) == 40);
  83
  84 /* Common header for all async config Properties */
  85 struct ofp14_async_config_prop_header {
  86     ovs_be16    type;       /* One of OFPACPT_*. */
  87     ovs_be16    length;     /* Length in bytes of this property. */
  88 };
  89 OFP_ASSERT(sizeof(struct ofp14_async_config_prop_header) == 4);
  90
  91 /* Asynchronous message configuration.
  92  * OFPT_GET_ASYNC_REPLY or OFPT_SET_ASYNC.
  93  */
  94 struct ofp14_async_config {
  95     struct ofp_header header;
  96     /* Async config Property list - 0 or more */
  97     struct ofp14_async_config_prop_header properties[0];
  98 };
  99 OFP_ASSERT(sizeof(struct ofp14_async_config) == 8);
 100
 101 /* Async Config property types.
 102 * Low order bit cleared indicates a property for the slave role.
 103 * Low order bit set indicates a property for the master/equal role.
 104 */
 105 enum ofp14_async_config_prop_type {
 106     OFPACPT_PACKET_IN_SLAVE       = 0, /* Packet-in mask for slave. */
 107     OFPACPT_PACKET_IN_MASTER      = 1, /* Packet-in mask for master. */
 108     OFPACPT_PORT_STATUS_SLAVE     = 2, /* Port-status mask for slave. */
 109     OFPACPT_PORT_STATUS_MASTER    = 3, /* Port-status mask for master. */
 110     OFPACPT_FLOW_REMOVED_SLAVE    = 4, /* Flow removed mask for slave. */
 111     OFPACPT_FLOW_REMOVED_MASTER   = 5, /* Flow removed mask for master. */
 112     OFPACPT_ROLE_STATUS_SLAVE     = 6, /* Role status mask for slave. */
 113     OFPACPT_ROLE_STATUS_MASTER    = 7, /* Role status mask for master. */
 114     OFPACPT_TABLE_STATUS_SLAVE    = 8, /* Table status mask for slave. */
 115     OFPACPT_TABLE_STATUS_MASTER   = 9, /* Table status mask for master. */
 116     OFPACPT_REQUESTFORWARD_SLAVE  = 10, /* RequestForward mask for slave. */
 117     OFPACPT_REQUESTFORWARD_MASTER = 11, /* RequestForward mask for master. */
 118     OFPTFPT_EXPERIMENTER_SLAVE    = 0xFFFE, /* Experimenter for slave. */
 119     OFPTFPT_EXPERIMENTER_MASTER   = 0xFFFF, /* Experimenter for master. */
 120 };
 121
 122 /* Various reason based properties */
 123 struct ofp14_async_config_prop_reasons {
 124     /* 'type' is one of OFPACPT_PACKET_IN_*, OFPACPT_PORT_STATUS_*,
 125      * OFPACPT_FLOW_REMOVED_*, OFPACPT_ROLE_STATUS_*,
 126      * OFPACPT_TABLE_STATUS_*, OFPACPT_REQUESTFORWARD_*. */
 127     ovs_be16    type;
 128     ovs_be16    length; /* Length in bytes of this property. */
 129     ovs_be32    mask;   /* Bitmasks of reason values. */
 130 };
 131 OFP_ASSERT(sizeof(struct ofp14_async_config_prop_reasons) == 8);
 132
 133 /* Experimenter async config property */
 134 struct ofp14_async_config_prop_experimenter {
 135     ovs_be16        type;       /* One of OFPTFPT_EXPERIMENTER_SLAVE,
 136                                    OFPTFPT_EXPERIMENTER_MASTER. */
 137     ovs_be16        length;     /* Length in bytes of this property. */
 138     ovs_be32        experimenter;  /* Experimenter ID which takes the same
 139                                       form as in struct
 140                                       ofp_experimenter_header. */
 141     ovs_be32        exp_type;      /* Experimenter defined. */
 142     /* Followed by:
 143      *   - Exactly (length - 12) bytes containing the experimenter data, then
 144      *   - Exactly (length + 7)/8*8 - (length) (between 0 and 7)
 145      *     bytes of all-zero bytes */
 146 };
 147 OFP_ASSERT(sizeof(struct ofp14_async_config_prop_experimenter) == 12);
 148
 149 /* Common header for all Role Properties */
 150 struct ofp14_role_prop_header {
 151     ovs_be16 type;   /* One of OFPRPT_*. */
 152     ovs_be16 length; /* Length in bytes of this property. */
 153 };
 154 OFP_ASSERT(sizeof(struct ofp14_role_prop_header) == 4);
 155
 156 /* Role status event message. */
 157 struct ofp14_role_status {
 158     ovs_be32 role;              /* One of OFPCR_ROLE_*. */
 159     uint8_t  reason;            /* One of OFPCRR_*. */
 160     uint8_t  pad[3];            /* Align to 64 bits. */
 161     ovs_be64 generation_id;     /* Master Election Generation Id */
 162
 163     /* Followed by a list of struct ofp14_role_prop_header */
 164 };
 165 OFP_ASSERT(sizeof(struct ofp14_role_status) == 16);
 166
 167 /* What changed about the controller role */
 168 enum ofp14_controller_role_reason {
 169     OFPCRR_MASTER_REQUEST = 0,  /* Another controller asked to be master. */
 170     OFPCRR_CONFIG         = 1,  /* Configuration changed on the switch. */
 171     OFPCRR_EXPERIMENTER   = 2,  /* Experimenter data changed. */
 172 };
 173
 174 /* Role property types.
 175 */
 176 enum ofp14_role_prop_type {
 177     OFPRPT_EXPERIMENTER         = 0xFFFF, /* Experimenter property. */
 178 };
 179
 180 /* Experimenter role property */
 181 struct ofp14_role_prop_experimenter {
 182     ovs_be16        type;       /* One of OFPRPT_EXPERIMENTER. */
 183     ovs_be16        length;     /* Length in bytes of this property. */
 184     ovs_be32        experimenter; /* Experimenter ID which takes the same
 185                                      form as in struct
 186                                      ofp_experimenter_header. */
 187     ovs_be32        exp_type;     /* Experimenter defined. */
 188     /* Followed by:
 189      *   - Exactly (length - 12) bytes containing the experimenter data, then
 190      *   - Exactly (length + 7)/8*8 - (length) (between 0 and 7)
 191      *     bytes of all-zero bytes */
 192 };
 193 OFP_ASSERT(sizeof(struct ofp14_role_prop_experimenter) == 12);
 194
 195 /* Bundle control message types */
 196 enum ofp14_bundle_ctrl_type {
 197     OFPBCT_OPEN_REQUEST    = 0,
 198     OFPBCT_OPEN_REPLY      = 1,
 199     OFPBCT_CLOSE_REQUEST   = 2,
 200     OFPBCT_CLOSE_REPLY     = 3,
 201     OFPBCT_COMMIT_REQUEST  = 4,
 202     OFPBCT_COMMIT_REPLY    = 5,
 203     OFPBCT_DISCARD_REQUEST = 6,
 204     OFPBCT_DISCARD_REPLY   = 7,
 205 };
 206
 207 /* Bundle configuration flags. */
 208 enum ofp14_bundle_flags {
 209     OFPBF_ATOMIC  = 1 << 0,  /* Execute atomically. */
 210     OFPBF_ORDERED = 1 << 1,  /* Execute in specified order. */
 211 };
 212
 213 /* Message structure for OFPT_BUNDLE_CONTROL and OFPT_BUNDLE_ADD_MESSAGE. */
 214 struct ofp14_bundle_ctrl_msg {
 215     ovs_be32 bundle_id;     /* Identify the bundle. */
 216     ovs_be16 type;          /* OFPT_BUNDLE_CONTROL: one of OFPBCT_*.
 217                              * OFPT_BUNDLE_ADD_MESSAGE: not used. */
 218     ovs_be16 flags;         /* Bitmap of OFPBF_* flags. */
 219     /* Followed by:
 220      * - For OFPT_BUNDLE_ADD_MESSAGE only, an encapsulated OpenFlow message,
 221      *   beginning with an ofp_header whose xid is identical to this message's
 222      *   outer xid.
 223      * - For OFPT_BUNDLE_ADD_MESSAGE only, and only if at least one property is
 224      *   present, 0 to 7 bytes of padding to align on a 64-bit boundary.
 225      * - Zero or more properties (see struct ofp14_bundle_prop_header). */
 226 };
 227 OFP_ASSERT(sizeof(struct ofp14_bundle_ctrl_msg) == 8);
 228
 229 #endif /* openflow/openflow-1.4.h */