include/openflow.h

   1 /* Copyright (c) 2008 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 /* OpenFlow: protocol between controller and datapath. */
  35
  36 #ifndef OPENFLOW_H
  37 #define OPENFLOW_H 1
  38
  39 #ifdef __KERNEL__
  40 #include <linux/types.h>
  41 #else
  42 #include <stdint.h>
  43 #endif
  44
  45 /* Maximum length of a OpenFlow packet. */
  46 #define OFP_MAXLEN (sizeof(struct ofp_switch_features) \
  47         + (sizeof(struct ofp_phy_port) * OFPP_MAX) + 200)
  48
  49
  50 /* The most significant bit being set in the version field indicates an
  51  * experimental OpenFlow version.
  52  */
  53 #define OFP_VERSION   0x82
  54
  55 #define OFP_MAX_TABLE_NAME_LEN 32
  56 #define OFP_MAX_PORT_NAME_LEN  16
  57
  58 #define OFP_TCP_PORT  975
  59 #define OFP_SSL_PORT  976
  60
  61 #define OFP_ETH_ALEN 6          /* Bytes in an Ethernet address. */
  62
  63 /* Port numbering.  Physical ports are numbered starting from 0. */
  64 enum ofp_port {
  65     /* Maximum number of physical switch ports. */
  66     OFPP_MAX = 0x100,
  67
  68     /* Fake output "ports". */
  69     OFPP_TABLE      = 0xfff9,  /* Perform actions in flow table.
  70                                 * NB: This can only be the destination
  71                                 * port for packet-out messages.
  72                                 */
  73     OFPP_NORMAL     = 0xfffa,  /* Process with normal L2/L3 switching. */
  74     OFPP_FLOOD      = 0xfffb,  /* All physical ports except input port and
  75                                   those disabled by STP. */
  76     OFPP_ALL        = 0xfffc,  /* All physical ports except input port. */
  77     OFPP_CONTROLLER = 0xfffd,  /* Send to controller. */
  78     OFPP_LOCAL      = 0xfffe,  /* Local openflow "port". */ /* xxx Want?! */
  79     OFPP_NONE       = 0xffff   /* Not associated with a physical port. */
  80 };
  81
  82 enum ofp_type {
  83     OFPT_FEATURES_REQUEST,    /*  0 Controller/switch message */
  84     OFPT_FEATURES_REPLY,      /*  1 Controller/switch message */
  85     OFPT_GET_CONFIG_REQUEST,  /*  2 Controller/switch message */
  86     OFPT_GET_CONFIG_REPLY,    /*  3 Controller/switch message */
  87     OFPT_SET_CONFIG,          /*  4 Controller/switch message */
  88     OFPT_PACKET_IN,           /*  5 Async message */
  89     OFPT_PACKET_OUT,          /*  6 Controller/switch message */
  90     OFPT_FLOW_MOD,            /*  7 Controller/switch message */
  91     OFPT_FLOW_EXPIRED,        /*  8 Async message */
  92     OFPT_TABLE,               /*  9 Controller/switch message */
  93     OFPT_PORT_MOD,            /* 10 Controller/switch message */
  94     OFPT_PORT_STATUS,         /* 11 Async message */
  95     OFPT_FLOW_STATS_REQUEST,  /* 12 Controller/switch message */
  96     OFPT_FLOW_STATS_REPLY,    /* 13 Controller/switch message */
  97     OFPT_TABLE_STATS_REQUEST, /* 14 Controller/switch message */
  98     OFPT_TABLE_STATS_REPLY,   /* 15 Controller/switch message */
  99     OFPT_PORT_STATS_REQUEST,  /* 16 Controller/switch message */
 100     OFPT_PORT_STATS_REPLY     /* 17 Controller/switch message */
 101 };
 102
 103 /* Header on all OpenFlow packets. */
 104 struct ofp_header {
 105     uint8_t version;    /* OFP_VERSION. */
 106     uint8_t type;       /* One of the OFPT_ constants. */
 107     uint16_t length;    /* Length including this ofp_header. */
 108     uint32_t xid;       /* Transactin id associated with this packet.
 109                            Replies use the same id as was in the request
 110                            to facilitate pairing. */
 111 };
 112
 113 #define OFP_DEFAULT_MISS_SEND_LEN   128
 114
 115 enum ofp_config_flags {
 116     /* Tells datapath to notify the controller of expired flow entries. */
 117     OFPC_SEND_FLOW_EXP = 1 << 0
 118 };
 119
 120 /* Switch configuration. */
 121 struct ofp_switch_config {
 122     struct ofp_header header;
 123     uint16_t flags;             /* OFPC_* flags. */
 124     uint16_t miss_send_len;     /* Max bytes of new flow that datapath should
 125                                    send to the controller. */
 126 };
 127
 128 /* Capabilities supported by the datapath. */
 129 enum ofp_capabilities {
 130     OFPC_FLOW_STATS   = 1 << 0, /* Flow statistics. */
 131     OFPC_TABLE_STATS  = 1 << 1, /* Table statistics. */
 132     OFPC_PORT_STATS   = 1 << 2, /* Port statistics. */
 133     OFPC_STP          = 1 << 3, /* 802.11d spanning tree. */
 134     OFPC_MULTI_PHY_TX = 1 << 4  /* Supports transmitting through multiple
 135                                    physical interfaces */
 136 };
 137
 138 /* Flags to indicate behavior of the physical port */
 139 enum ofp_port_flags {
 140     OFPPFL_NO_FLOOD  = 1 << 0, /* Do not include this port when flooding */
 141 };
 142
 143 /* Features of physical ports available in a datapath. */
 144 enum ofp_port_features {
 145     OFPPF_10MB_HD    = 1 << 0, /* 10 Mb half-duplex rate support. */
 146     OFPPF_10MB_FD    = 1 << 1, /* 10 Mb full-duplex rate support. */
 147     OFPPF_100MB_HD   = 1 << 2, /* 100 Mb half-duplex rate support. */
 148     OFPPF_100MB_FD   = 1 << 3, /* 100 Mb full-duplex rate support. */
 149     OFPPF_1GB_HD     = 1 << 4, /* 1 Gb half-duplex rate support. */
 150     OFPPF_1GB_FD     = 1 << 5, /* 1 Gb full-duplex rate support. */
 151     OFPPF_10GB_FD    = 1 << 6, /* 10 Gb full-duplex rate support. */
 152 };
 153
 154
 155 /* Description of a physical port */
 156 struct ofp_phy_port {
 157     uint16_t port_no;
 158     uint8_t hw_addr[OFP_ETH_ALEN];
 159     uint8_t name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
 160     uint32_t flags;         /* Bitmap of "ofp_port_flags". */
 161     uint32_t speed;         /* Current speed in Mbps */
 162     uint32_t features;      /* Bitmap of supported "ofp_port_features"s. */
 163 };
 164
 165 /* Switch features. */
 166 struct ofp_switch_features {
 167     struct ofp_header header;
 168     uint64_t datapath_id;   /* Datapath unique ID */
 169
 170     /* Table info. */
 171     uint32_t n_exact;       /* Max exact-match table entries. */
 172     uint32_t n_compression; /* Max entries compressed on service port.  */
 173     uint32_t n_general;     /* Max entries of arbitrary form. */
 174
 175     /* Buffer limits.  A datapath that cannot buffer reports 0.*/
 176     uint32_t buffer_mb;     /* Space for buffering packets, in MB. */
 177     uint32_t n_buffers;     /* Max packets buffered at once. */
 178
 179     /* Features. */
 180     uint32_t capabilities;  /* Bitmap of support "ofp_capabilities". */
 181     uint32_t actions;       /* Bitmap of supported "ofp_action_type"s. */
 182
 183     /* Port info.*/
 184     struct ofp_phy_port ports[0];   /* Port definitions.  The number of ports
 185                                       is inferred from the length field in
 186                                       the header. */
 187 };
 188
 189 /* What changed about the phsyical port */
 190 enum ofp_port_reason {
 191     OFPPR_ADD,              /* The port was added */
 192     OFPPR_DELETE,           /* The port was removed */
 193     OFPPR_MOD               /* Some attribute of the port has changed */
 194 };
 195
 196 /* A physical port has changed in the datapath */
 197 struct ofp_port_status {
 198     struct ofp_header header;
 199     uint8_t reason;          /* One of OFPPR_* */
 200     uint8_t pad[3];          /* Align to 32-bits */
 201     struct ofp_phy_port desc;
 202 };
 203
 204 /* Modify behavior of the physical port */
 205 struct ofp_port_mod {
 206     struct ofp_header header;
 207     struct ofp_phy_port desc;
 208 };
 209
 210 /* Why is this packet being sent to the controller? */
 211 enum ofp_reason {
 212     OFPR_NO_MATCH,          /* No matching flow. */
 213     OFPR_ACTION             /* Action explicitly output to controller. */
 214 };
 215
 216 /* Packet received on port (datapath -> controller). */
 217 struct ofp_packet_in {
 218     struct ofp_header header;
 219     uint32_t buffer_id;     /* ID assigned by datapath. */
 220     uint16_t total_len;     /* Full length of frame. */
 221     uint16_t in_port;       /* Port on which frame was received. */
 222     uint8_t reason;         /* Reason packet is being sent (one of OFPR_*) */
 223     uint8_t pad;
 224     uint8_t data[0];        /* Ethernet frame, halfway through 32-bit word,
 225                                so the IP header is 32-bit aligned.  The
 226                                amount of data is inferred from the length
 227                                field in the header.  Because of padding,
 228                                offsetof(struct ofp_packet_in, data) ==
 229                                sizeof(struct ofp_packet_in) - 2. */
 230 };
 231
 232 enum ofp_action_type {
 233     OFPAT_OUTPUT,           /* Output to switch port. */
 234     OFPAT_SET_DL_VLAN,      /* VLAN. */
 235     OFPAT_SET_DL_SRC,       /* Ethernet source address. */
 236     OFPAT_SET_DL_DST,       /* Ethernet destination address. */
 237     OFPAT_SET_NW_SRC,       /* IP source address. */
 238     OFPAT_SET_NW_DST,       /* IP destination address. */
 239     OFPAT_SET_TP_SRC,       /* TCP/UDP source port. */
 240     OFPAT_SET_TP_DST        /* TCP/UDP destination port. */
 241 };
 242
 243 /* An output action sends packets out 'port'.  When the 'port' is the
 244  * OFPP_CONTROLLER, 'max_len' indicates the max number of bytes to
 245  * send.  A 'max_len' of zero means the entire packet should be sent. */
 246 struct ofp_action_output {
 247     uint16_t max_len;
 248     uint16_t port;
 249 };
 250
 251 /* The VLAN id is 12-bits, so we'll use the entire 16 bits to indicate
 252  * special conditions.  All ones is used to indicate that no VLAN id was
 253  * set, or if used as an action, that the VLAN header should be
 254  * stripped.
 255  */
 256 #define OFP_VLAN_NONE      0xffff
 257
 258 struct ofp_action {
 259     uint16_t type;                       /* One of OFPAT_* */
 260     union {
 261         struct ofp_action_output output; /* OFPAT_OUTPUT: output struct. */
 262         uint16_t vlan_id;                /* OFPAT_SET_DL_VLAN: VLAN id. */
 263         uint8_t  dl_addr[OFP_ETH_ALEN];  /* OFPAT_SET_DL_SRC/DST */
 264         uint32_t nw_addr;                /* OFPAT_SET_NW_SRC/DST */
 265         uint16_t tp;                     /* OFPAT_SET_TP_SRC/DST */
 266     } arg;
 267 };
 268
 269 /* Send packet (controller -> datapath). */
 270 struct ofp_packet_out {
 271     struct ofp_header header;
 272     uint32_t buffer_id;     /* ID assigned by datapath (-1 if none). */
 273     uint16_t in_port;       /* Packet's input port (OFPP_NONE if none). */
 274     uint16_t out_port;      /* Output port (if buffer_id == -1). */
 275     union {
 276         struct ofp_action actions[0]; /* buffer_id != -1 */
 277         uint8_t data[0];              /* buffer_id == -1 */
 278     } u;
 279 };
 280
 281 enum ofp_flow_mod_command {
 282     OFPFC_ADD,              /* New flow. */
 283     OFPFC_DELETE,           /* Delete all matching flows. */
 284     OFPFC_DELETE_STRICT     /* Strictly match wildcards and priority. */
 285 };
 286
 287 /* Flow wildcards. */
 288 enum ofp_flow_wildcards {
 289     OFPFW_IN_PORT  = 1 << 0,  /* Switch input port. */
 290     OFPFW_DL_VLAN  = 1 << 1,  /* VLAN. */
 291     OFPFW_DL_SRC   = 1 << 2,  /* Ethernet source address. */
 292     OFPFW_DL_DST   = 1 << 3,  /* Ethernet destination address. */
 293     OFPFW_DL_TYPE  = 1 << 4,  /* Ethernet frame type. */
 294     OFPFW_NW_SRC   = 1 << 5,  /* IP source address. */
 295     OFPFW_NW_DST   = 1 << 6,  /* IP destination address. */
 296     OFPFW_NW_PROTO = 1 << 7,  /* IP protocol. */
 297     OFPFW_TP_SRC   = 1 << 8,  /* TCP/UDP source port. */
 298     OFPFW_TP_DST   = 1 << 9,  /* TCP/UDP destination port. */
 299     OFPFW_ALL      = (1 << 10) - 1
 300 };
 301
 302 /* Values below this cutoff are 802.3 packets and the two bytes
 303  * following MAC addresses are used as a frame length.  Otherwise, the
 304  * two bytes are used as the Ethernet type.
 305  */
 306 #define OFP_DL_TYPE_ETH2_CUTOFF   0x0600
 307
 308 /* Value of dl_type to indicate that the frame does not include an
 309  * Ethernet type.
 310  */
 311 #define OFP_DL_TYPE_NOT_ETH_TYPE  0x05ff
 312
 313 /* Fields to match against flows */
 314 struct ofp_match {
 315     uint16_t wildcards;        /* Wildcard fields. */
 316     uint16_t in_port;          /* Input switch port. */
 317     uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
 318     uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
 319     uint16_t dl_vlan;          /* Input VLAN. */
 320     uint16_t dl_type;          /* Ethernet frame type. */
 321     uint32_t nw_src;           /* IP source address. */
 322     uint32_t nw_dst;           /* IP destination address. */
 323     uint8_t nw_proto;          /* IP protocol. */
 324     uint8_t pad[3];            /* Align to 32-bits. */
 325     uint16_t tp_src;           /* TCP/UDP source port. */
 326     uint16_t tp_dst;           /* TCP/UDP destination port. */
 327 };
 328
 329 /* Value used in "max_idle" to indicate that the entry is permanent */
 330 #define OFP_FLOW_PERMANENT 0
 331
 332 /* By default, choose a priority in the middle */
 333 #define OFP_DEFAULT_PRIORITY 0x8000
 334
 335 /* Flow setup and teardown (controller -> datapath). */
 336 struct ofp_flow_mod {
 337     struct ofp_header header;
 338     struct ofp_match match;      /* Fields to match */
 339
 340     /* Flow actions. */
 341     uint16_t command;             /* One of OFPFC_*. */
 342     uint16_t max_idle;            /* Idle time before discarding (seconds). */
 343     uint32_t buffer_id;           /* Buffered packet to apply to (or -1). */
 344     uint16_t priority;            /* Priority level of flow entry. */
 345     uint8_t pad[2];               /* Align to 32-bits. */
 346     uint32_t reserved;            /* Reserved for future use. */
 347     struct ofp_action actions[0]; /* The number of actions is inferred from
 348                                     the length field in the header. */
 349 };
 350
 351 /* Flow expiration (datapath -> controller). */
 352 struct ofp_flow_expired {
 353     struct ofp_header header;
 354     struct ofp_match match;   /* Description of fields */
 355
 356     uint32_t duration;        /* Time flow was alive in seconds. */
 357     uint64_t packet_count;
 358     uint64_t byte_count;
 359 };
 360
 361 /* Statistics about flows that match the "match" field */
 362 struct ofp_flow_stats {
 363     struct ofp_match match;   /* Description of fields */
 364     uint32_t duration;        /* Time flow has been alive in seconds.  Only
 365                                  used for non-aggregated results. */
 366     uint64_t packet_count;    /* Number of packets in flow. */
 367     uint64_t byte_count;      /* Number of bytes in flow. */
 368     uint16_t priority;        /* Priority of the entry.  Only meaningful
 369                                  when this is not an exact-match entry. */
 370     uint8_t table_id;         /* ID of table flow came from. */
 371     uint8_t pad[5];           /* Align to 64-bits. */
 372 };
 373
 374 enum ofp_stats_type {
 375     OFPFS_INDIV,              /* Send an entry for each matching flow */
 376     OFPFS_AGGREGATE           /* Aggregate matching flows */
 377 };
 378
 379 /* Current flow statistics request */
 380 struct ofp_flow_stats_request {
 381     struct ofp_header header;
 382     struct ofp_match match;   /* Fields to match */
 383     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
 384                                  or 0xff for all tables. */
 385     uint8_t type;             /* One of OFPFS_ */
 386     uint16_t pad;               /* Align to 32-bits */
 387 };
 388
 389 /* Current flow statistics reply */
 390 struct ofp_flow_stats_reply {
 391     struct ofp_header header;
 392
 393     /* If request was of type OFPFS_INDIV, this will contain an array of
 394      * flow statistic entries.  The number of matching flows is likely
 395      * much larger than can fit in a single OpenFlow message, so a
 396      * a response with no flows included is sent to indicate the end.
 397      * If it was a OFPFS_AGGREGATE request, only a single flow stats
 398      * entry will be contained in the response.
 399      */
 400     struct ofp_flow_stats flows[0];
 401 };
 402
 403 /* Current table statistics request */
 404 struct ofp_table_stats_request {
 405     struct ofp_header header;
 406 };
 407
 408 /* Statistics about a particular table */
 409 struct ofp_table_stats {
 410     uint8_t table_id;
 411     uint8_t pad[3];          /* Align to 32-bits */
 412     char name[OFP_MAX_TABLE_NAME_LEN];
 413     uint32_t max_entries;    /* Max number of entries supported */
 414     uint32_t active_count;   /* Number of active entries */
 415     uint64_t matched_count;  /* Number of packets that hit table */
 416 };
 417
 418 /* Current table statistics reply */
 419 struct ofp_table_stats_reply {
 420     struct ofp_header header;
 421     struct ofp_table_stats tables[0]; /* The number of entries is inferred from
 422                                         the length field in the header. */
 423 };
 424
 425 /* Statistics about a particular port */
 426 struct ofp_port_stats {
 427     uint16_t port_no;
 428     uint8_t pad[2];          /* Align to 32-bits */
 429     uint64_t rx_count;       /* Number of received packets */
 430     uint64_t tx_count;       /* Number of transmitted packets */
 431     uint64_t drop_count;     /* Number of packets dropped by interface */
 432 };
 433
 434 /* Current port statistics request */
 435 struct ofp_port_stats_request {
 436     struct ofp_header header;
 437 };
 438
 439 /* Current port statistics reply */
 440 struct ofp_port_stats_reply {
 441     struct ofp_header header;
 442     struct ofp_port_stats ports[0]; /* The number of entries is inferred from
 443                                       the length field in the header. */
 444 };
 445
 446 #endif /* openflow.h */