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