Drop controller-bound traffic that arrives on the controller's port.
[sliver-openvswitch.git] / 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 #ifdef SWIG
46 #define OFP_ASSERT(EXPR)        /* SWIG can't handle OFP_ASSERT. */
47 #elif !defined(__cplusplus)
48 /* Build-time assertion for use in a declaration context. */
49 #define OFP_ASSERT(EXPR)                                                \
50         extern int (*build_assert(void))[ sizeof(struct {               \
51                     unsigned int build_assert_failed : (EXPR) ? 1 : -1; })]
52 #else /* __cplusplus */
53 #include <boost/static_assert.hpp>
54 #define OFP_ASSERT BOOST_STATIC_ASSERT
55 #endif /* __cplusplus */
56
57 #ifndef SWIG
58 #define OFP_PACKED __attribute__((packed))
59 #else
60 #define OFP_PACKED              /* SWIG doesn't understand __attribute. */
61 #endif
62
63 /* Maximum length of a OpenFlow packet. */
64 #define OFP_MAXLEN (sizeof(struct ofp_switch_features) \
65         + (sizeof(struct ofp_phy_port) * OFPP_MAX) + 200)
66
67
68 /* The most significant bit being set in the version field indicates an
69  * experimental OpenFlow version.  
70  */
71 #define OFP_VERSION   0x85
72
73 #define OFP_MAX_TABLE_NAME_LEN 32
74 #define OFP_MAX_PORT_NAME_LEN  16
75
76 #define OFP_TCP_PORT  975
77 #define OFP_SSL_PORT  976
78
79 #define OFP_ETH_ALEN 6          /* Bytes in an Ethernet address. */
80
81 /* Port numbering.  Physical ports are numbered starting from 0. */
82 enum ofp_port {
83     /* Maximum number of physical switch ports. */
84     OFPP_MAX = 0x100,
85
86     /* Fake output "ports". */
87     OFPP_TABLE      = 0xfff9,  /* Perform actions in flow table.  
88                                 * NB: This can only be the destination
89                                 * port for packet-out messages. 
90                                 */
91     OFPP_NORMAL     = 0xfffa,  /* Process with normal L2/L3 switching. */
92     OFPP_FLOOD      = 0xfffb,  /* All physical ports except input port and 
93                                   those disabled by STP. */
94     OFPP_ALL        = 0xfffc,  /* All physical ports except input port. */
95     OFPP_CONTROLLER = 0xfffd,  /* Send to controller. */ 
96     OFPP_LOCAL      = 0xfffe,  /* Local openflow "port". */
97     OFPP_NONE       = 0xffff   /* Not associated with a physical port. */
98 };
99
100 enum ofp_type {
101     OFPT_FEATURES_REQUEST,    /*  0 Controller/switch message */
102     OFPT_FEATURES_REPLY,      /*  1 Controller/switch message */
103     OFPT_GET_CONFIG_REQUEST,  /*  2 Controller/switch message */
104     OFPT_GET_CONFIG_REPLY,    /*  3 Controller/switch message */
105     OFPT_SET_CONFIG,          /*  4 Controller/switch message */
106     OFPT_PACKET_IN,           /*  5 Async message */
107     OFPT_PACKET_OUT,          /*  6 Controller/switch message */
108     OFPT_FLOW_MOD,            /*  7 Controller/switch message */
109     OFPT_FLOW_EXPIRED,        /*  8 Async message */
110     OFPT_TABLE,               /*  9 Controller/switch message */
111     OFPT_PORT_MOD,            /* 10 Controller/switch message */
112     OFPT_PORT_STATUS,         /* 11 Async message */
113     OFPT_ERROR_MSG,           /* 12 Async message */
114     OFPT_STATS_REQUEST,       /* 13 Controller/switch message */
115     OFPT_STATS_REPLY,         /* 14 Controller/switch message */
116     OFPT_ECHO_REQUEST,        /* 15 Symmetric message */
117     OFPT_ECHO_REPLY           /* 16 Symmetric message */
118 };
119
120 /* Header on all OpenFlow packets. */
121 struct ofp_header {
122     uint8_t version;    /* OFP_VERSION. */
123     uint8_t type;       /* One of the OFPT_ constants. */
124     uint16_t length;    /* Length including this ofp_header. */
125     uint32_t xid;       /* Transactin id associated with this packet.
126                            Replies use the same id as was in the request
127                            to facilitate pairing. */
128 };
129 OFP_ASSERT(sizeof(struct ofp_header) == 8);
130
131 #define OFP_DEFAULT_MISS_SEND_LEN   128
132
133 enum ofp_config_flags {
134     /* Tells datapath to notify the controller of expired flow entries. */
135     OFPC_SEND_FLOW_EXP = 1 << 0
136 };
137
138 /* Switch configuration. */
139 struct ofp_switch_config {
140     struct ofp_header header;
141     uint16_t flags;             /* OFPC_* flags. */
142     uint16_t miss_send_len;     /* Max bytes of new flow that datapath should
143                                    send to the controller. */
144 };
145 OFP_ASSERT(sizeof(struct ofp_switch_config) == 12);
146
147 /* Capabilities supported by the datapath. */
148 enum ofp_capabilities {
149     OFPC_FLOW_STATS   = 1 << 0, /* Flow statistics. */
150     OFPC_TABLE_STATS  = 1 << 1, /* Table statistics. */
151     OFPC_PORT_STATS   = 1 << 2, /* Port statistics. */
152     OFPC_STP          = 1 << 3, /* 802.11d spanning tree. */
153     OFPC_MULTI_PHY_TX = 1 << 4  /* Supports transmitting through multiple
154                                    physical interfaces */
155 };
156
157 /* Flags to indicate behavior of the physical port */
158 enum ofp_port_flags {
159     OFPPFL_NO_FLOOD  = 1 << 0, /* Do not include this port when flooding */
160 };
161
162 /* Features of physical ports available in a datapath. */
163 enum ofp_port_features {
164     OFPPF_10MB_HD    = 1 << 0, /* 10 Mb half-duplex rate support. */
165     OFPPF_10MB_FD    = 1 << 1, /* 10 Mb full-duplex rate support. */
166     OFPPF_100MB_HD   = 1 << 2, /* 100 Mb half-duplex rate support. */
167     OFPPF_100MB_FD   = 1 << 3, /* 100 Mb full-duplex rate support. */
168     OFPPF_1GB_HD     = 1 << 4, /* 1 Gb half-duplex rate support. */
169     OFPPF_1GB_FD     = 1 << 5, /* 1 Gb full-duplex rate support. */
170     OFPPF_10GB_FD    = 1 << 6, /* 10 Gb full-duplex rate support. */
171 };
172
173
174 /* Description of a physical port */
175 struct ofp_phy_port {
176     uint16_t port_no;
177     uint8_t hw_addr[OFP_ETH_ALEN];
178     uint8_t name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
179     uint32_t flags;         /* Bitmap of "ofp_port_flags". */
180     uint32_t speed;         /* Current speed in Mbps */
181     uint32_t features;      /* Bitmap of supported "ofp_port_features"s. */
182 };
183 OFP_ASSERT(sizeof(struct ofp_phy_port) == 36);
184
185 /* Switch features. */
186 struct ofp_switch_features {
187     struct ofp_header header;
188     uint64_t datapath_id;   /* Datapath unique ID.  Only the lower 48-bits
189                                are meaningful. */
190
191     /* Table info. */
192     uint32_t n_exact;       /* Max exact-match table entries. */
193     uint32_t n_compression; /* Max entries compressed on service port. */
194     uint32_t n_general;     /* Max entries of arbitrary form. */
195
196     /* Buffer limits.  A datapath that cannot buffer reports 0.*/
197     uint32_t buffer_mb;     /* Space for buffering packets, in MB. */
198     uint32_t n_buffers;     /* Max packets buffered at once. */
199
200     /* Features. */
201     uint32_t capabilities;  /* Bitmap of support "ofp_capabilities". */
202     uint32_t actions;       /* Bitmap of supported "ofp_action_type"s. */
203     uint8_t pad[4];         /* Align to 64-bits. */
204
205     /* Port info.*/
206     struct ofp_phy_port ports[0];   /* Port definitions.  The number of ports
207                                       is inferred from the length field in
208                                       the header. */
209 };
210 OFP_ASSERT(sizeof(struct ofp_switch_features) == 48);
211
212 /* What changed about the physical port */
213 enum ofp_port_reason {
214     OFPPR_ADD,              /* The port was added */
215     OFPPR_DELETE,           /* The port was removed */
216     OFPPR_MOD               /* Some attribute of the port has changed */
217 };
218
219 /* A physical port has changed in the datapath */
220 struct ofp_port_status {
221     struct ofp_header header;
222     uint8_t reason;          /* One of OFPPR_* */
223     uint8_t pad[3];          /* Align to 32-bits */
224     struct ofp_phy_port desc;
225 };
226 OFP_ASSERT(sizeof(struct ofp_port_status) == 48);
227
228 /* Modify behavior of the physical port */
229 struct ofp_port_mod {
230     struct ofp_header header;
231     struct ofp_phy_port desc;
232 };
233 OFP_ASSERT(sizeof(struct ofp_port_mod) == 44);
234
235 /* Why is this packet being sent to the controller? */
236 enum ofp_reason {
237     OFPR_NO_MATCH,          /* No matching flow. */
238     OFPR_ACTION             /* Action explicitly output to controller. */
239 };
240
241 /* Packet received on port (datapath -> controller). */
242 struct ofp_packet_in {
243     struct ofp_header header;
244     uint32_t buffer_id;     /* ID assigned by datapath. */
245     uint16_t total_len;     /* Full length of frame. */
246     uint16_t in_port;       /* Port on which frame was received. */
247     uint8_t reason;         /* Reason packet is being sent (one of OFPR_*) */
248     uint8_t pad;
249     uint8_t data[0];        /* Ethernet frame, halfway through 32-bit word,
250                                so the IP header is 32-bit aligned.  The 
251                                amount of data is inferred from the length
252                                field in the header.  Because of padding,
253                                offsetof(struct ofp_packet_in, data) ==
254                                sizeof(struct ofp_packet_in) - 2. */
255 };
256 OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
257
258 enum ofp_action_type {
259     OFPAT_OUTPUT,           /* Output to switch port. */
260     OFPAT_SET_DL_VLAN,      /* VLAN. */
261     OFPAT_SET_DL_SRC,       /* Ethernet source address. */
262     OFPAT_SET_DL_DST,       /* Ethernet destination address. */
263     OFPAT_SET_NW_SRC,       /* IP source address. */
264     OFPAT_SET_NW_DST,       /* IP destination address. */
265     OFPAT_SET_TP_SRC,       /* TCP/UDP source port. */
266     OFPAT_SET_TP_DST        /* TCP/UDP destination port. */
267 };
268
269 /* An output action sends packets out 'port'.  When the 'port' is the
270  * OFPP_CONTROLLER, 'max_len' indicates the max number of bytes to
271  * send.  A 'max_len' of zero means the entire packet should be sent. */
272 struct ofp_action_output {
273     uint16_t max_len;
274     uint16_t port;
275 };
276 OFP_ASSERT(sizeof(struct ofp_action_output) == 4);
277
278 /* The VLAN id is 12-bits, so we'll use the entire 16 bits to indicate
279  * special conditions.  All ones is used to indicate that no VLAN id was
280  * set, or if used as an action, that the VLAN header should be
281  * stripped.
282  */
283 #define OFP_VLAN_NONE      0xffff
284
285 struct ofp_action {
286     uint16_t type;                       /* One of OFPAT_* */
287     union {
288         struct ofp_action_output output; /* OFPAT_OUTPUT: output struct. */
289         uint16_t vlan_id;                /* OFPAT_SET_DL_VLAN: VLAN id. */
290         uint8_t  dl_addr[OFP_ETH_ALEN];  /* OFPAT_SET_DL_SRC/DST */
291         uint32_t nw_addr OFP_PACKED;     /* OFPAT_SET_NW_SRC/DST */
292         uint16_t tp;                     /* OFPAT_SET_TP_SRC/DST */
293     } arg;
294 };
295 OFP_ASSERT(sizeof(struct ofp_action) == 8);
296
297 /* Send packet (controller -> datapath). */
298 struct ofp_packet_out {
299     struct ofp_header header;
300     uint32_t buffer_id;     /* ID assigned by datapath (-1 if none). */
301     uint16_t in_port;       /* Packet's input port (OFPP_NONE if none). */
302     uint16_t out_port;      /* Output port (if buffer_id == -1). */
303     union {
304         struct ofp_action actions[0]; /* buffer_id != -1 */
305         uint8_t data[0];              /* buffer_id == -1 */
306     } u;
307 };
308 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
309
310 enum ofp_flow_mod_command {
311     OFPFC_ADD,              /* New flow. */
312     OFPFC_DELETE,           /* Delete all matching flows. */
313     OFPFC_DELETE_STRICT     /* Strictly match wildcards and priority. */
314 };
315
316 /* Flow wildcards. */
317 enum ofp_flow_wildcards {
318     OFPFW_IN_PORT  = 1 << 0,  /* Switch input port. */
319     OFPFW_DL_VLAN  = 1 << 1,  /* VLAN. */
320     OFPFW_DL_SRC   = 1 << 2,  /* Ethernet source address. */
321     OFPFW_DL_DST   = 1 << 3,  /* Ethernet destination address. */
322     OFPFW_DL_TYPE  = 1 << 4,  /* Ethernet frame type. */
323     OFPFW_NW_SRC   = 1 << 5,  /* IP source address. */
324     OFPFW_NW_DST   = 1 << 6,  /* IP destination address. */
325     OFPFW_NW_PROTO = 1 << 7,  /* IP protocol. */
326     OFPFW_TP_SRC   = 1 << 8,  /* TCP/UDP source port. */
327     OFPFW_TP_DST   = 1 << 9,  /* TCP/UDP destination port. */
328     OFPFW_ALL      = (1 << 10) - 1
329 };
330
331 /* Values below this cutoff are 802.3 packets and the two bytes
332  * following MAC addresses are used as a frame length.  Otherwise, the
333  * two bytes are used as the Ethernet type.
334  */
335 #define OFP_DL_TYPE_ETH2_CUTOFF   0x0600
336
337 /* Value of dl_type to indicate that the frame does not include an
338  * Ethernet type.
339  */
340 #define OFP_DL_TYPE_NOT_ETH_TYPE  0x05ff
341
342 /* Fields to match against flows */
343 struct ofp_match {
344     uint16_t wildcards;        /* Wildcard fields. */
345     uint16_t in_port;          /* Input switch port. */
346     uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
347     uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
348     uint16_t dl_vlan;          /* Input VLAN. */
349     uint16_t dl_type;          /* Ethernet frame type. */
350     uint32_t nw_src;           /* IP source address. */
351     uint32_t nw_dst;           /* IP destination address. */
352     uint8_t nw_proto;          /* IP protocol. */
353     uint8_t pad[3];            /* Align to 32-bits. */
354     uint16_t tp_src;           /* TCP/UDP source port. */
355     uint16_t tp_dst;           /* TCP/UDP destination port. */
356 };
357 OFP_ASSERT(sizeof(struct ofp_match) == 36);
358
359 /* Value used in "max_idle" to indicate that the entry is permanent */
360 #define OFP_FLOW_PERMANENT 0
361
362 /* By default, choose a priority in the middle */
363 #define OFP_DEFAULT_PRIORITY 0x8000
364
365 /* Flow setup and teardown (controller -> datapath). */
366 struct ofp_flow_mod {
367     struct ofp_header header;
368     struct ofp_match match;      /* Fields to match */
369
370     /* Flow actions. */
371     uint16_t command;             /* One of OFPFC_*. */
372     uint16_t max_idle;            /* Idle time before discarding (seconds). */
373     uint32_t buffer_id;           /* Buffered packet to apply to (or -1). */
374     uint16_t priority;            /* Priority level of flow entry. */
375     uint8_t pad[2];               /* Align to 32-bits. */
376     uint32_t reserved;            /* Reserved for future use. */
377     struct ofp_action actions[0]; /* The number of actions is inferred from
378                                     the length field in the header. */
379 };
380 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 60);
381
382 /* Flow expiration (datapath -> controller). */
383 struct ofp_flow_expired {
384     struct ofp_header header;
385     struct ofp_match match;   /* Description of fields */
386
387     uint16_t priority;        /* Priority level of flow entry. */
388     uint8_t pad[2];           /* Align to 32-bits. */
389
390     uint32_t duration;        /* Time flow was alive in seconds. */
391     uint8_t pad2[4];          /* Align to 64-bits. */
392     uint64_t packet_count;    
393     uint64_t byte_count;
394 };
395 OFP_ASSERT(sizeof(struct ofp_flow_expired) == 72);
396
397 /* Error message (datapath -> controller). */
398 struct ofp_error_msg {
399     struct ofp_header header;
400
401     uint16_t type;
402     uint16_t code;
403     uint8_t data[0];          /* Variable-length data.  Interpreted based 
404                                  on the type and code. */
405 };
406 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
407
408 enum ofp_stats_types {
409     /* Individual flow statistics.
410      * The request body is struct ofp_flow_stats_request.
411      * The reply body is an array of struct ofp_flow_stats. */
412     OFPST_FLOW,
413
414     /* Aggregate flow statistics.
415      * The request body is struct ofp_aggregate_stats_request.
416      * The reply body is struct ofp_aggregate_stats_reply. */
417     OFPST_AGGREGATE,
418
419     /* Flow table statistics.
420      * The request body is empty.
421      * The reply body is an array of struct ofp_table_stats. */
422     OFPST_TABLE,
423
424     /* Physical port statistics.
425      * The request body is empty.
426      * The reply body is an array of struct ofp_port_stats. */
427     OFPST_PORT
428 };
429
430 struct ofp_stats_request {
431     struct ofp_header header;
432     uint16_t type;              /* One of the OFPST_* constants. */
433     uint16_t flags;             /* OFPSF_REQ_* flags (none yet defined). */
434     uint8_t body[0];            /* Body of the request. */
435 };
436 OFP_ASSERT(sizeof(struct ofp_stats_request) == 12);
437
438 enum ofp_stats_reply_flags {
439     OFPSF_REPLY_MORE  = 1 << 0, /* More replies to follow */
440 };
441
442 struct ofp_stats_reply {
443     struct ofp_header header;
444     uint16_t type;              /* One of the OFPST_* constants. */
445     uint16_t flags;             /* OFPSF_REPLY_* flags. */
446     uint8_t body[0];            /* Body of the reply. */
447 };
448 OFP_ASSERT(sizeof(struct ofp_stats_reply) == 12);
449
450 /* Body for ofp_stats_request of type OFPST_FLOW. */
451 struct ofp_flow_stats_request {
452     struct ofp_match match;   /* Fields to match */
453     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
454                                  or 0xff for all tables. */
455     uint8_t pad[3];           /* Align to 32 bits. */
456 };
457 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 40);
458
459 /* Body of reply to OFPST_FLOW request. */
460 struct ofp_flow_stats {
461     uint16_t length;          /* Length of this entry. */
462     uint8_t table_id;         /* ID of table flow came from. */
463     uint8_t pad;
464     struct ofp_match match;   /* Description of fields. */
465     uint32_t duration;        /* Time flow has been alive in seconds. */
466     uint16_t priority;        /* Priority of the entry. Only meaningful
467                                  when this is not an exact-match entry. */
468     uint16_t max_idle;        /* Number of seconds idle before expiration. */
469     uint64_t packet_count;    /* Number of packets in flow. */
470     uint64_t byte_count;      /* Number of bytes in flow. */
471     struct ofp_action actions[0]; /* Actions. */
472 };
473 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 64);
474
475 /* Body for ofp_stats_request of type OFPST_AGGREGATE. */
476 struct ofp_aggregate_stats_request {
477     struct ofp_match match;   /* Fields to match */
478     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
479                                  or 0xff for all tables. */
480     uint8_t pad[3];           /* Align to 32 bits. */
481 };
482 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 40);
483
484 /* Body of reply to OFPST_AGGREGATE request. */
485 struct ofp_aggregate_stats_reply {
486     uint64_t packet_count;    /* Number of packets in flows. */
487     uint64_t byte_count;      /* Number of bytes in flows. */
488     uint32_t flow_count;      /* Number of flows. */
489     uint8_t pad[4];           /* Align to 64 bits. */
490 };
491 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
492
493 /* Body of reply to OFPST_TABLE request. */
494 struct ofp_table_stats {
495     uint8_t table_id;
496     uint8_t pad[3];          /* Align to 32-bits */
497     char name[OFP_MAX_TABLE_NAME_LEN];
498     uint32_t max_entries;    /* Max number of entries supported */
499     uint32_t active_count;   /* Number of active entries */
500     uint8_t pad2[4];         /* Align to 64 bits. */
501     uint64_t matched_count;  /* Number of packets that hit table */
502 };
503 OFP_ASSERT(sizeof(struct ofp_table_stats) == 56);
504
505 /* Statistics about a particular port */
506 struct ofp_port_stats {
507     uint16_t port_no;
508     uint8_t pad[6];          /* Align to 64-bits */
509     uint64_t rx_count;       /* Number of received packets */
510     uint64_t tx_count;       /* Number of transmitted packets */
511     uint64_t drop_count;     /* Number of packets dropped by interface */
512 };
513 OFP_ASSERT(sizeof(struct ofp_port_stats) == 32);
514
515 #endif /* openflow.h */