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