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