1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
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:
17 * The above copyright notice and this permission notice shall be
18 * included in all copies or substantial portions of the Software.
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
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.
34 /* OpenFlow: protocol between controller and datapath. */
40 #include <linux/types.h>
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 */
58 #define OFP_PACKED __attribute__((packed))
60 #define OFP_PACKED /* SWIG doesn't understand __attribute. */
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)
68 /* The most significant bit being set in the version field indicates an
69 * experimental OpenFlow version.
71 #define OFP_VERSION 0x86
73 #define OFP_MAX_TABLE_NAME_LEN 32
74 #define OFP_MAX_PORT_NAME_LEN 16
76 #define OFP_TCP_PORT 975
77 #define OFP_SSL_PORT 976
79 #define OFP_ETH_ALEN 6 /* Bytes in an Ethernet address. */
81 /* Port numbering. Physical ports are numbered starting from 0. */
83 /* Maximum number of physical switch ports. */
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.
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. */
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 */
120 /* Header on all OpenFlow packets. */
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. */
129 OFP_ASSERT(sizeof(struct ofp_header) == 8);
131 #define OFP_DEFAULT_MISS_SEND_LEN 128
133 enum ofp_config_flags {
134 /* Tells datapath to notify the controller of expired flow entries. */
135 OFPC_SEND_FLOW_EXP = 1 << 0,
137 /* Handling of IP fragments. */
138 OFPC_FRAG_NORMAL = 0 << 1, /* No special handling for fragments. */
139 OFPC_FRAG_DROP = 1 << 1, /* Drop fragments. */
140 OFPC_FRAG_REASM = 2 << 1, /* Reassemble (only if OFPC_IP_REASM set). */
141 OFPC_FRAG_MASK = 3 << 1
144 /* Switch configuration. */
145 struct ofp_switch_config {
146 struct ofp_header header;
147 uint16_t flags; /* OFPC_* flags. */
148 uint16_t miss_send_len; /* Max bytes of new flow that datapath should
149 send to the controller. */
151 OFP_ASSERT(sizeof(struct ofp_switch_config) == 12);
153 /* Capabilities supported by the datapath. */
154 enum ofp_capabilities {
155 OFPC_FLOW_STATS = 1 << 0, /* Flow statistics. */
156 OFPC_TABLE_STATS = 1 << 1, /* Table statistics. */
157 OFPC_PORT_STATS = 1 << 2, /* Port statistics. */
158 OFPC_STP = 1 << 3, /* 802.11d spanning tree. */
159 OFPC_MULTI_PHY_TX = 1 << 4, /* Supports transmitting through multiple
160 physical interfaces */
161 OFPC_IP_REASM = 1 << 5 /* Can reassemble IP fragments. */
164 /* Flags to indicate behavior of the physical port */
165 enum ofp_port_flags {
166 OFPPFL_NO_FLOOD = 1 << 0, /* Do not include this port when flooding */
169 /* Features of physical ports available in a datapath. */
170 enum ofp_port_features {
171 OFPPF_10MB_HD = 1 << 0, /* 10 Mb half-duplex rate support. */
172 OFPPF_10MB_FD = 1 << 1, /* 10 Mb full-duplex rate support. */
173 OFPPF_100MB_HD = 1 << 2, /* 100 Mb half-duplex rate support. */
174 OFPPF_100MB_FD = 1 << 3, /* 100 Mb full-duplex rate support. */
175 OFPPF_1GB_HD = 1 << 4, /* 1 Gb half-duplex rate support. */
176 OFPPF_1GB_FD = 1 << 5, /* 1 Gb full-duplex rate support. */
177 OFPPF_10GB_FD = 1 << 6, /* 10 Gb full-duplex rate support. */
181 /* Description of a physical port */
182 struct ofp_phy_port {
184 uint8_t hw_addr[OFP_ETH_ALEN];
185 uint8_t name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
186 uint32_t flags; /* Bitmap of "ofp_port_flags". */
187 uint32_t speed; /* Current speed in Mbps */
188 uint32_t features; /* Bitmap of supported "ofp_port_features"s. */
190 OFP_ASSERT(sizeof(struct ofp_phy_port) == 36);
192 /* Switch features. */
193 struct ofp_switch_features {
194 struct ofp_header header;
195 uint64_t datapath_id; /* Datapath unique ID. Only the lower 48-bits
199 uint32_t n_exact; /* Max exact-match table entries. */
200 uint32_t n_compression; /* Max entries compressed on service port. */
201 uint32_t n_general; /* Max entries of arbitrary form. */
203 /* Buffer limits. A datapath that cannot buffer reports 0.*/
204 uint32_t buffer_mb; /* Space for buffering packets, in MB. */
205 uint32_t n_buffers; /* Max packets buffered at once. */
208 uint32_t capabilities; /* Bitmap of support "ofp_capabilities". */
209 uint32_t actions; /* Bitmap of supported "ofp_action_type"s. */
210 uint8_t pad[4]; /* Align to 64-bits. */
213 struct ofp_phy_port ports[0]; /* Port definitions. The number of ports
214 is inferred from the length field in
217 OFP_ASSERT(sizeof(struct ofp_switch_features) == 48);
219 /* What changed about the physical port */
220 enum ofp_port_reason {
221 OFPPR_ADD, /* The port was added */
222 OFPPR_DELETE, /* The port was removed */
223 OFPPR_MOD /* Some attribute of the port has changed */
226 /* A physical port has changed in the datapath */
227 struct ofp_port_status {
228 struct ofp_header header;
229 uint8_t reason; /* One of OFPPR_* */
230 uint8_t pad[3]; /* Align to 32-bits */
231 struct ofp_phy_port desc;
233 OFP_ASSERT(sizeof(struct ofp_port_status) == 48);
235 /* Modify behavior of the physical port */
236 struct ofp_port_mod {
237 struct ofp_header header;
238 struct ofp_phy_port desc;
240 OFP_ASSERT(sizeof(struct ofp_port_mod) == 44);
242 /* Why is this packet being sent to the controller? */
243 enum ofp_packet_in_reason {
244 OFPR_NO_MATCH, /* No matching flow. */
245 OFPR_ACTION /* Action explicitly output to controller. */
248 /* Packet received on port (datapath -> controller). */
249 struct ofp_packet_in {
250 struct ofp_header header;
251 uint32_t buffer_id; /* ID assigned by datapath. */
252 uint16_t total_len; /* Full length of frame. */
253 uint16_t in_port; /* Port on which frame was received. */
254 uint8_t reason; /* Reason packet is being sent (one of OFPR_*) */
256 uint8_t data[0]; /* Ethernet frame, halfway through 32-bit word,
257 so the IP header is 32-bit aligned. The
258 amount of data is inferred from the length
259 field in the header. Because of padding,
260 offsetof(struct ofp_packet_in, data) ==
261 sizeof(struct ofp_packet_in) - 2. */
263 OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
265 enum ofp_action_type {
266 OFPAT_OUTPUT, /* Output to switch port. */
267 OFPAT_SET_DL_VLAN, /* VLAN. */
268 OFPAT_SET_DL_SRC, /* Ethernet source address. */
269 OFPAT_SET_DL_DST, /* Ethernet destination address. */
270 OFPAT_SET_NW_SRC, /* IP source address. */
271 OFPAT_SET_NW_DST, /* IP destination address. */
272 OFPAT_SET_TP_SRC, /* TCP/UDP source port. */
273 OFPAT_SET_TP_DST /* TCP/UDP destination port. */
276 /* An output action sends packets out 'port'. When the 'port' is the
277 * OFPP_CONTROLLER, 'max_len' indicates the max number of bytes to
278 * send. A 'max_len' of zero means the entire packet should be sent. */
279 struct ofp_action_output {
283 OFP_ASSERT(sizeof(struct ofp_action_output) == 4);
285 /* The VLAN id is 12-bits, so we'll use the entire 16 bits to indicate
286 * special conditions. All ones is used to indicate that no VLAN id was
287 * set, or if used as an action, that the VLAN header should be
290 #define OFP_VLAN_NONE 0xffff
293 uint16_t type; /* One of OFPAT_* */
295 struct ofp_action_output output; /* OFPAT_OUTPUT: output struct. */
296 uint16_t vlan_id; /* OFPAT_SET_DL_VLAN: VLAN id. */
297 uint8_t dl_addr[OFP_ETH_ALEN]; /* OFPAT_SET_DL_SRC/DST */
298 uint32_t nw_addr OFP_PACKED; /* OFPAT_SET_NW_SRC/DST */
299 uint16_t tp; /* OFPAT_SET_TP_SRC/DST */
302 OFP_ASSERT(sizeof(struct ofp_action) == 8);
304 /* Send packet (controller -> datapath). */
305 struct ofp_packet_out {
306 struct ofp_header header;
307 uint32_t buffer_id; /* ID assigned by datapath (-1 if none). */
308 uint16_t in_port; /* Packet's input port (OFPP_NONE if none). */
309 uint16_t out_port; /* Output port (if buffer_id == -1). */
311 struct ofp_action actions[0]; /* buffer_id != -1 */
312 uint8_t data[0]; /* buffer_id == -1 */
315 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
317 enum ofp_flow_mod_command {
318 OFPFC_ADD, /* New flow. */
319 OFPFC_DELETE, /* Delete all matching flows. */
320 OFPFC_DELETE_STRICT /* Strictly match wildcards and priority. */
323 /* Flow wildcards. */
324 enum ofp_flow_wildcards {
325 OFPFW_IN_PORT = 1 << 0, /* Switch input port. */
326 OFPFW_DL_VLAN = 1 << 1, /* VLAN. */
327 OFPFW_DL_SRC = 1 << 2, /* Ethernet source address. */
328 OFPFW_DL_DST = 1 << 3, /* Ethernet destination address. */
329 OFPFW_DL_TYPE = 1 << 4, /* Ethernet frame type. */
330 OFPFW_NW_SRC = 1 << 5, /* IP source address. */
331 OFPFW_NW_DST = 1 << 6, /* IP destination address. */
332 OFPFW_NW_PROTO = 1 << 7, /* IP protocol. */
333 OFPFW_TP_SRC = 1 << 8, /* TCP/UDP source port. */
334 OFPFW_TP_DST = 1 << 9, /* TCP/UDP destination port. */
335 OFPFW_ALL = (1 << 10) - 1
338 /* Values below this cutoff are 802.3 packets and the two bytes
339 * following MAC addresses are used as a frame length. Otherwise, the
340 * two bytes are used as the Ethernet type.
342 #define OFP_DL_TYPE_ETH2_CUTOFF 0x0600
344 /* Value of dl_type to indicate that the frame does not include an
347 #define OFP_DL_TYPE_NOT_ETH_TYPE 0x05ff
349 /* Fields to match against flows */
351 uint16_t wildcards; /* Wildcard fields. */
352 uint16_t in_port; /* Input switch port. */
353 uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
354 uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
355 uint16_t dl_vlan; /* Input VLAN. */
356 uint16_t dl_type; /* Ethernet frame type. */
357 uint32_t nw_src; /* IP source address. */
358 uint32_t nw_dst; /* IP destination address. */
359 uint8_t nw_proto; /* IP protocol. */
360 uint8_t pad[3]; /* Align to 32-bits. */
361 uint16_t tp_src; /* TCP/UDP source port. */
362 uint16_t tp_dst; /* TCP/UDP destination port. */
364 OFP_ASSERT(sizeof(struct ofp_match) == 36);
366 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
368 #define OFP_FLOW_PERMANENT 0
370 /* By default, choose a priority in the middle */
371 #define OFP_DEFAULT_PRIORITY 0x8000
373 /* Flow setup and teardown (controller -> datapath). */
374 struct ofp_flow_mod {
375 struct ofp_header header;
376 struct ofp_match match; /* Fields to match */
379 uint16_t command; /* One of OFPFC_*. */
380 uint16_t idle_timeout; /* Idle time before discarding (seconds). */
381 uint16_t hard_timeout; /* Max time before discarding (seconds). */
382 uint16_t priority; /* Priority level of flow entry. */
383 uint32_t buffer_id; /* Buffered packet to apply to (or -1). */
384 uint32_t reserved; /* Reserved for future use. */
385 struct ofp_action actions[0]; /* The number of actions is inferred from
386 the length field in the header. */
388 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 60);
390 /* Why did this flow expire? */
391 enum ofp_flow_expired_reason {
392 OFPER_IDLE_TIMEOUT, /* Flow idle time exceeded idle_timeout. */
393 OFPER_HARD_TIMEOUT /* Time exceeded hard_timeout. */
396 /* Flow expiration (datapath -> controller). */
397 struct ofp_flow_expired {
398 struct ofp_header header;
399 struct ofp_match match; /* Description of fields */
401 uint16_t priority; /* Priority level of flow entry. */
402 uint8_t reason; /* One of OFPER_*. */
403 uint8_t pad[1]; /* Align to 32-bits. */
405 uint32_t duration; /* Time flow was alive in seconds. */
406 uint8_t pad2[4]; /* Align to 64-bits. */
407 uint64_t packet_count;
410 OFP_ASSERT(sizeof(struct ofp_flow_expired) == 72);
412 /* Error message (datapath -> controller). */
413 struct ofp_error_msg {
414 struct ofp_header header;
418 uint8_t data[0]; /* Variable-length data. Interpreted based
419 on the type and code. */
421 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
423 enum ofp_stats_types {
424 /* Individual flow statistics.
425 * The request body is struct ofp_flow_stats_request.
426 * The reply body is an array of struct ofp_flow_stats. */
429 /* Aggregate flow statistics.
430 * The request body is struct ofp_aggregate_stats_request.
431 * The reply body is struct ofp_aggregate_stats_reply. */
434 /* Flow table statistics.
435 * The request body is empty.
436 * The reply body is an array of struct ofp_table_stats. */
439 /* Physical port statistics.
440 * The request body is empty.
441 * The reply body is an array of struct ofp_port_stats. */
445 struct ofp_stats_request {
446 struct ofp_header header;
447 uint16_t type; /* One of the OFPST_* constants. */
448 uint16_t flags; /* OFPSF_REQ_* flags (none yet defined). */
449 uint8_t body[0]; /* Body of the request. */
451 OFP_ASSERT(sizeof(struct ofp_stats_request) == 12);
453 enum ofp_stats_reply_flags {
454 OFPSF_REPLY_MORE = 1 << 0, /* More replies to follow */
457 struct ofp_stats_reply {
458 struct ofp_header header;
459 uint16_t type; /* One of the OFPST_* constants. */
460 uint16_t flags; /* OFPSF_REPLY_* flags. */
461 uint8_t body[0]; /* Body of the reply. */
463 OFP_ASSERT(sizeof(struct ofp_stats_reply) == 12);
465 /* Body for ofp_stats_request of type OFPST_FLOW. */
466 struct ofp_flow_stats_request {
467 struct ofp_match match; /* Fields to match */
468 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
469 or 0xff for all tables. */
470 uint8_t pad[3]; /* Align to 32 bits. */
472 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 40);
474 /* Body of reply to OFPST_FLOW request. */
475 struct ofp_flow_stats {
476 uint16_t length; /* Length of this entry. */
477 uint8_t table_id; /* ID of table flow came from. */
479 struct ofp_match match; /* Description of fields. */
480 uint32_t duration; /* Time flow has been alive in seconds. */
481 uint16_t priority; /* Priority of the entry. Only meaningful
482 when this is not an exact-match entry. */
483 uint16_t idle_timeout; /* Number of seconds idle before expiration. */
484 uint16_t hard_timeout; /* Number of seconds before expiration. */
485 uint16_t pad2[3]; /* Pad to 64 bits. */
486 uint64_t packet_count; /* Number of packets in flow. */
487 uint64_t byte_count; /* Number of bytes in flow. */
488 struct ofp_action actions[0]; /* Actions. */
490 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 72);
492 /* Body for ofp_stats_request of type OFPST_AGGREGATE. */
493 struct ofp_aggregate_stats_request {
494 struct ofp_match match; /* Fields to match */
495 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
496 or 0xff for all tables. */
497 uint8_t pad[3]; /* Align to 32 bits. */
499 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 40);
501 /* Body of reply to OFPST_AGGREGATE request. */
502 struct ofp_aggregate_stats_reply {
503 uint64_t packet_count; /* Number of packets in flows. */
504 uint64_t byte_count; /* Number of bytes in flows. */
505 uint32_t flow_count; /* Number of flows. */
506 uint8_t pad[4]; /* Align to 64 bits. */
508 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
510 /* Body of reply to OFPST_TABLE request. */
511 struct ofp_table_stats {
513 uint8_t pad[3]; /* Align to 32-bits */
514 char name[OFP_MAX_TABLE_NAME_LEN];
515 uint32_t max_entries; /* Max number of entries supported */
516 uint32_t active_count; /* Number of active entries */
517 uint8_t pad2[4]; /* Align to 64 bits. */
518 uint64_t matched_count; /* Number of packets that hit table */
520 OFP_ASSERT(sizeof(struct ofp_table_stats) == 56);
522 /* Statistics about a particular port */
523 struct ofp_port_stats {
525 uint8_t pad[6]; /* Align to 64-bits */
526 uint64_t rx_count; /* Number of received packets */
527 uint64_t tx_count; /* Number of transmitted packets */
528 uint64_t drop_count; /* Number of packets dropped by interface */
530 OFP_ASSERT(sizeof(struct ofp_port_stats) == 32);
532 #endif /* openflow.h */