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