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