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 /* The most significant bit being set in the version field indicates an
64 * experimental OpenFlow version.
66 #define OFP_VERSION 0x96
68 #define OFP_MAX_TABLE_NAME_LEN 32
69 #define OFP_MAX_PORT_NAME_LEN 16
71 #define OFP_TCP_PORT 6633
72 #define OFP_SSL_PORT 6633
74 #define OFP_ETH_ALEN 6 /* Bytes in an Ethernet address. */
76 /* Port numbering. Physical ports are numbered starting from 0. */
78 /* Maximum number of physical switch ports. */
81 /* Fake output "ports". */
82 OFPP_IN_PORT = 0xfff8, /* Send the packet out the input port. This
83 virtual port must be explicitly used
84 in order to send back out of the input
86 OFPP_TABLE = 0xfff9, /* Perform actions in flow table.
87 NB: This can only be the destination
88 port for packet-out messages. */
89 OFPP_NORMAL = 0xfffa, /* Process with normal L2/L3 switching. */
90 OFPP_FLOOD = 0xfffb, /* All physical ports except input port and
91 those disabled by STP. */
92 OFPP_ALL = 0xfffc, /* All physical ports except input port. */
93 OFPP_CONTROLLER = 0xfffd, /* Send to controller. */
94 OFPP_LOCAL = 0xfffe, /* Local openflow "port". */
95 OFPP_NONE = 0xffff /* Not associated with a physical port. */
99 /* Immutable messages. */
100 OFPT_HELLO, /* Symmetric message */
101 OFPT_ERROR, /* Symmetric message */
102 OFPT_ECHO_REQUEST, /* Symmetric message */
103 OFPT_ECHO_REPLY, /* Symmetric message */
104 OFPT_VENDOR, /* Symmetric message */
106 /* Switch configuration messages. */
107 OFPT_FEATURES_REQUEST, /* Controller/switch message */
108 OFPT_FEATURES_REPLY, /* Controller/switch message */
109 OFPT_GET_CONFIG_REQUEST, /* Controller/switch message */
110 OFPT_GET_CONFIG_REPLY, /* Controller/switch message */
111 OFPT_SET_CONFIG, /* Controller/switch message */
113 /* Asynchronous messages. */
114 OFPT_PACKET_IN, /* Async message */
115 OFPT_FLOW_EXPIRED, /* Async message */
116 OFPT_PORT_STATUS, /* Async message */
118 /* Controller command messages. */
119 OFPT_PACKET_OUT, /* Controller/switch message */
120 OFPT_FLOW_MOD, /* Controller/switch message */
121 OFPT_PORT_MOD, /* Controller/switch message */
123 /* Statistics messages. */
124 OFPT_STATS_REQUEST, /* Controller/switch message */
125 OFPT_STATS_REPLY /* Controller/switch message */
128 /* Header on all OpenFlow packets. */
130 uint8_t version; /* OFP_VERSION. */
131 uint8_t type; /* One of the OFPT_ constants. */
132 uint16_t length; /* Length including this ofp_header. */
133 uint32_t xid; /* Transactin id associated with this packet.
134 Replies use the same id as was in the request
135 to facilitate pairing. */
137 OFP_ASSERT(sizeof(struct ofp_header) == 8);
139 /* OFPT_HELLO. This message has an empty body, but implementations must
140 * ignore any data included in the body, to allow for future extensions. */
142 struct ofp_header header;
145 #define OFP_DEFAULT_MISS_SEND_LEN 128
147 enum ofp_config_flags {
148 /* Tells datapath to notify the controller of expired flow entries. */
149 OFPC_SEND_FLOW_EXP = 1 << 0,
151 /* Handling of IP fragments. */
152 OFPC_FRAG_NORMAL = 0 << 1, /* No special handling for fragments. */
153 OFPC_FRAG_DROP = 1 << 1, /* Drop fragments. */
154 OFPC_FRAG_REASM = 2 << 1, /* Reassemble (only if OFPC_IP_REASM set). */
155 OFPC_FRAG_MASK = 3 << 1
158 /* Switch configuration. */
159 struct ofp_switch_config {
160 struct ofp_header header;
161 uint16_t flags; /* OFPC_* flags. */
162 uint16_t miss_send_len; /* Max bytes of new flow that datapath should
163 send to the controller. */
165 OFP_ASSERT(sizeof(struct ofp_switch_config) == 12);
167 /* Capabilities supported by the datapath. */
168 enum ofp_capabilities {
169 OFPC_FLOW_STATS = 1 << 0, /* Flow statistics. */
170 OFPC_TABLE_STATS = 1 << 1, /* Table statistics. */
171 OFPC_PORT_STATS = 1 << 2, /* Port statistics. */
172 OFPC_STP = 1 << 3, /* 802.1d spanning tree. */
173 OFPC_MULTI_PHY_TX = 1 << 4, /* Supports transmitting through multiple
174 physical interfaces */
175 OFPC_IP_REASM = 1 << 5 /* Can reassemble IP fragments. */
178 /* Flags to indicate behavior of the physical port. These flags are
179 * used in ofp_phy_port to describe the current configuration. They are
180 * used in the ofp_port_mod message to configure the port's behavior.
182 enum ofp_port_config {
183 OFPPC_PORT_DOWN = 1 << 0, /* Port is administratively down. */
185 OFPPC_NO_STP = 1 << 1, /* Disable 802.1D spanning tree on port. */
186 OFPPC_NO_RECV = 1 << 2, /* Drop most packets received on port. */
187 OFPPC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */
188 OFPPC_NO_FLOOD = 1 << 4, /* Do not include this port when flooding. */
189 OFPPC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */
190 OFPPC_NO_PACKET_IN = 1 << 6 /* Do not send packet-in msgs for port. */
193 /* Current state of the physical port. These are not configurable from
196 enum ofp_port_state {
197 OFPPS_LINK_DOWN = 1 << 0, /* No physical link present. */
199 /* The OFPPS_STP_* bits have no effect on switch operation. The
200 * controller must adjust OFPPC_NO_RECV, OFPPC_NO_FWD, and
201 * OFPPC_NO_PACKET_IN appropriately to fully implement an 802.1D spanning
203 OFPPS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
204 OFPPS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
205 OFPPS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
206 OFPPS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
207 OFPPS_STP_MASK = 3 << 8 /* Bit mask for OFPPS_STP_* values. */
210 /* Features of physical ports available in a datapath. */
211 enum ofp_port_features {
212 OFPPF_10MB_HD = 1 << 0, /* 10 Mb half-duplex rate support. */
213 OFPPF_10MB_FD = 1 << 1, /* 10 Mb full-duplex rate support. */
214 OFPPF_100MB_HD = 1 << 2, /* 100 Mb half-duplex rate support. */
215 OFPPF_100MB_FD = 1 << 3, /* 100 Mb full-duplex rate support. */
216 OFPPF_1GB_HD = 1 << 4, /* 1 Gb half-duplex rate support. */
217 OFPPF_1GB_FD = 1 << 5, /* 1 Gb full-duplex rate support. */
218 OFPPF_10GB_FD = 1 << 6, /* 10 Gb full-duplex rate support. */
219 OFPPF_COPPER = 1 << 7, /* Copper medium */
220 OFPPF_FIBER = 1 << 8, /* Fiber medium */
221 OFPPF_AUTONEG = 1 << 9, /* Auto-negotiation */
222 OFPPF_PAUSE = 1 << 10, /* Pause */
223 OFPPF_PAUSE_ASYM = 1 << 11 /* Asymmetric pause */
226 /* Description of a physical port */
227 struct ofp_phy_port {
229 uint8_t hw_addr[OFP_ETH_ALEN];
230 uint8_t name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
232 uint32_t config; /* Bitmap of OFPPC_* flags. */
233 uint32_t state; /* Bitmap of OFPPS_* flags. */
235 /* Bitmaps of OFPPF_* that describe features. All bits zeroed if
236 * unsupported or unavailable. */
237 uint32_t curr; /* Current features. */
238 uint32_t advertised; /* Features being advertised by the port. */
239 uint32_t supported; /* Features supported by the port. */
240 uint32_t peer; /* Features advertised by peer. */
242 OFP_ASSERT(sizeof(struct ofp_phy_port) == 48);
244 /* Switch features. */
245 struct ofp_switch_features {
246 struct ofp_header header;
247 uint64_t datapath_id; /* Datapath unique ID. Only the lower 48-bits
250 uint32_t n_buffers; /* Max packets buffered at once. */
252 uint8_t n_tables; /* Number of tables supported by datapath. */
253 uint8_t pad[3]; /* Align to 64-bits. */
256 uint32_t capabilities; /* Bitmap of support "ofp_capabilities". */
257 uint32_t actions; /* Bitmap of supported "ofp_action_type"s. */
260 struct ofp_phy_port ports[0]; /* Port definitions. The number of ports
261 is inferred from the length field in
264 OFP_ASSERT(sizeof(struct ofp_switch_features) == 32);
266 /* What changed about the physical port */
267 enum ofp_port_reason {
268 OFPPR_ADD, /* The port was added */
269 OFPPR_DELETE, /* The port was removed */
270 OFPPR_MODIFY /* Some attribute of the port has changed */
273 /* A physical port has changed in the datapath */
274 struct ofp_port_status {
275 struct ofp_header header;
276 uint8_t reason; /* One of OFPPR_* */
277 uint8_t pad[7]; /* Align to 64-bits */
278 struct ofp_phy_port desc;
280 OFP_ASSERT(sizeof(struct ofp_port_status) == 64);
282 /* Modify behavior of the physical port */
283 struct ofp_port_mod {
284 struct ofp_header header;
286 uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
287 configurable. This is used to
288 sanity-check the request, so it must
289 be the same as returned in an
290 ofp_phy_port struct. */
292 uint32_t config; /* Bitmap of OFPPC_* flags. */
293 uint32_t mask; /* Bitmap of OFPPC_* flags to be changed. */
295 uint32_t advertise; /* Bitmap of "ofp_port_features"s. Zero all
296 bits to prevent any action taking place. */
297 uint8_t pad[4]; /* Pad to 64-bits. */
299 OFP_ASSERT(sizeof(struct ofp_port_mod) == 32);
301 /* Why is this packet being sent to the controller? */
302 enum ofp_packet_in_reason {
303 OFPR_NO_MATCH, /* No matching flow. */
304 OFPR_ACTION /* Action explicitly output to controller. */
307 /* Packet received on port (datapath -> controller). */
308 struct ofp_packet_in {
309 struct ofp_header header;
310 uint32_t buffer_id; /* ID assigned by datapath. */
311 uint16_t total_len; /* Full length of frame. */
312 uint16_t in_port; /* Port on which frame was received. */
313 uint8_t reason; /* Reason packet is being sent (one of OFPR_*) */
315 uint8_t data[0]; /* Ethernet frame, halfway through 32-bit word,
316 so the IP header is 32-bit aligned. The
317 amount of data is inferred from the length
318 field in the header. Because of padding,
319 offsetof(struct ofp_packet_in, data) ==
320 sizeof(struct ofp_packet_in) - 2. */
322 OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
324 enum ofp_action_type {
325 OFPAT_OUTPUT, /* Output to switch port. */
326 OFPAT_SET_VLAN_VID, /* Set the 802.1q VLAN id. */
327 OFPAT_SET_VLAN_PCP, /* Set the 802.1q priority. */
328 OFPAT_STRIP_VLAN, /* Strip the 802.1q header. */
329 OFPAT_SET_DL_SRC, /* Ethernet source address. */
330 OFPAT_SET_DL_DST, /* Ethernet destination address. */
331 OFPAT_SET_NW_SRC, /* IP source address. */
332 OFPAT_SET_NW_DST, /* IP destination address. */
333 OFPAT_SET_TP_SRC, /* TCP/UDP source port. */
334 OFPAT_SET_TP_DST, /* TCP/UDP destination port. */
335 OFPAT_VENDOR = 0xffff
338 /* Action structure for OFPAT_OUTPUT, which sends packets out 'port'.
339 * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
340 * number of bytes to send. A 'max_len' of zero means the entire packet
342 struct ofp_action_output {
343 uint16_t type; /* OFPAT_OUTPUT. */
344 uint16_t len; /* Length is 8. */
345 uint16_t port; /* Output port. */
346 uint16_t max_len; /* Max length to send to controller. */
348 OFP_ASSERT(sizeof(struct ofp_action_output) == 8);
350 /* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate
351 * special conditions. All ones is used to match that no VLAN id was
353 #define OFP_VLAN_NONE 0xffff
355 /* Action structure for OFPAT_SET_VLAN_VID. */
356 struct ofp_action_vlan_vid {
357 uint16_t type; /* OFPAT_SET_VLAN_VID. */
358 uint16_t len; /* Length is 8. */
359 uint16_t vlan_vid; /* VLAN id. */
362 OFP_ASSERT(sizeof(struct ofp_action_vlan_vid) == 8);
364 /* Action structure for OFPAT_SET_VLAN_PCP. */
365 struct ofp_action_vlan_pcp {
366 uint16_t type; /* OFPAT_SET_VLAN_PCP. */
367 uint16_t len; /* Length is 8. */
368 uint8_t vlan_pcp; /* VLAN priority. */
371 OFP_ASSERT(sizeof(struct ofp_action_vlan_vid) == 8);
373 /* Action structure for OFPAT_SET_DL_SRC/DST. */
374 struct ofp_action_dl_addr {
375 uint16_t type; /* OFPAT_SET_DL_SRC/DST. */
376 uint16_t len; /* Length is 16. */
377 uint8_t dl_addr[OFP_ETH_ALEN]; /* Ethernet address. */
380 OFP_ASSERT(sizeof(struct ofp_action_dl_addr) == 16);
382 /* Action structure for OFPAT_SET_NW_SRC/DST. */
383 struct ofp_action_nw_addr {
384 uint16_t type; /* OFPAT_SET_TW_SRC/DST. */
385 uint16_t len; /* Length is 8. */
386 uint32_t nw_addr; /* IP address. */
388 OFP_ASSERT(sizeof(struct ofp_action_nw_addr) == 8);
390 /* Action structure for OFPAT_SET_TP_SRC/DST. */
391 struct ofp_action_tp_port {
392 uint16_t type; /* OFPAT_SET_TP_SRC/DST. */
393 uint16_t len; /* Length is 8. */
394 uint16_t tp_port; /* TCP/UDP port. */
397 OFP_ASSERT(sizeof(struct ofp_action_tp_port) == 8);
399 /* Action header for OFPAT_VENDOR. The rest of the body is vendor-defined. */
400 struct ofp_action_vendor_header {
401 uint16_t type; /* OFPAT_VENDOR. */
402 uint16_t len; /* Length is 8. */
403 uint32_t vendor; /* Vendor ID, which takes the same form
404 as in "struct ofp_vendor". */
406 OFP_ASSERT(sizeof(struct ofp_action_vendor_header) == 8);
408 /* Action header that is common to all actions. The length includes the
409 * header and any padding used to make the action 64-bit aligned.
410 * NB: The length of an action *must* always be a multiple of eight. */
411 struct ofp_action_header {
412 uint16_t type; /* One of OFPAT_*. */
413 uint16_t len; /* Length of action, including this
414 header. This is the length of action,
415 including any padding to make it
419 OFP_ASSERT(sizeof(struct ofp_action_header) == 8);
421 /* Send packet (controller -> datapath). */
422 struct ofp_packet_out {
423 struct ofp_header header;
424 uint32_t buffer_id; /* ID assigned by datapath (-1 if none). */
425 uint16_t in_port; /* Packet's input port (OFPP_NONE if none). */
426 uint16_t actions_len; /* Size of action array in bytes. */
427 struct ofp_action_header actions[0]; /* Actions. */
428 /* uint8_t data[0]; */ /* Packet data. The length is inferred
429 from the length field in the header.
430 (Only meaningful if buffer_id == -1.) */
432 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
434 enum ofp_flow_mod_command {
435 OFPFC_ADD, /* New flow. */
436 OFPFC_MODIFY, /* Modify all matching flows. */
437 OFPFC_MODIFY_STRICT, /* Modify entry strictly matching wildcards */
438 OFPFC_DELETE, /* Delete all matching flows. */
439 OFPFC_DELETE_STRICT /* Strictly match wildcards and priority. */
442 /* Flow wildcards. */
443 enum ofp_flow_wildcards {
444 OFPFW_IN_PORT = 1 << 0, /* Switch input port. */
445 OFPFW_DL_VLAN = 1 << 1, /* VLAN. */
446 OFPFW_DL_SRC = 1 << 2, /* Ethernet source address. */
447 OFPFW_DL_DST = 1 << 3, /* Ethernet destination address. */
448 OFPFW_DL_TYPE = 1 << 4, /* Ethernet frame type. */
449 OFPFW_NW_PROTO = 1 << 5, /* IP protocol. */
450 OFPFW_TP_SRC = 1 << 6, /* TCP/UDP source port. */
451 OFPFW_TP_DST = 1 << 7, /* TCP/UDP destination port. */
453 /* IP source address wildcard bit count. 0 is exact match, 1 ignores the
454 * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
455 * the entire field. This is the *opposite* of the usual convention where
456 * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
457 OFPFW_NW_SRC_SHIFT = 8,
458 OFPFW_NW_SRC_BITS = 6,
459 OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
460 OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
462 /* IP destination address wildcard bit count. Same format as source. */
463 OFPFW_NW_DST_SHIFT = 14,
464 OFPFW_NW_DST_BITS = 6,
465 OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
466 OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
468 /* Wildcard all fields. */
469 OFPFW_ALL = ((1 << 20) - 1)
472 /* Values below this cutoff are 802.3 packets and the two bytes
473 * following MAC addresses are used as a frame length. Otherwise, the
474 * two bytes are used as the Ethernet type.
476 #define OFP_DL_TYPE_ETH2_CUTOFF 0x0600
478 /* Value of dl_type to indicate that the frame does not include an
481 #define OFP_DL_TYPE_NOT_ETH_TYPE 0x05ff
483 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
484 * special conditions. All ones indicates that no VLAN id was set.
486 #define OFP_VLAN_NONE 0xffff
488 /* Fields to match against flows */
490 uint32_t wildcards; /* Wildcard fields. */
491 uint16_t in_port; /* Input switch port. */
492 uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
493 uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
494 uint16_t dl_vlan; /* Input VLAN. */
495 uint16_t dl_type; /* Ethernet frame type. */
496 uint8_t nw_proto; /* IP protocol. */
497 uint8_t pad; /* Align to 32-bits. */
498 uint32_t nw_src; /* IP source address. */
499 uint32_t nw_dst; /* IP destination address. */
500 uint16_t tp_src; /* TCP/UDP source port. */
501 uint16_t tp_dst; /* TCP/UDP destination port. */
503 OFP_ASSERT(sizeof(struct ofp_match) == 36);
505 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
507 #define OFP_FLOW_PERMANENT 0
509 /* By default, choose a priority in the middle */
510 #define OFP_DEFAULT_PRIORITY 0x8000
512 /* Flow setup and teardown (controller -> datapath). */
513 struct ofp_flow_mod {
514 struct ofp_header header;
515 struct ofp_match match; /* Fields to match */
518 uint16_t command; /* One of OFPFC_*. */
519 uint16_t idle_timeout; /* Idle time before discarding (seconds). */
520 uint16_t hard_timeout; /* Max time before discarding (seconds). */
521 uint16_t priority; /* Priority level of flow entry. */
522 uint32_t buffer_id; /* Buffered packet to apply to (or -1).
523 Not meaningful for OFPFC_DELETE*. */
524 uint32_t reserved; /* Reserved for future use. */
525 struct ofp_action_header actions[0]; /* The action length is inferred
526 from the length field in the
529 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 60);
531 /* Why did this flow expire? */
532 enum ofp_flow_expired_reason {
533 OFPER_IDLE_TIMEOUT, /* Flow idle time exceeded idle_timeout. */
534 OFPER_HARD_TIMEOUT /* Time exceeded hard_timeout. */
537 /* Flow expiration (datapath -> controller). */
538 struct ofp_flow_expired {
539 struct ofp_header header;
540 struct ofp_match match; /* Description of fields */
542 uint16_t priority; /* Priority level of flow entry. */
543 uint8_t reason; /* One of OFPER_*. */
544 uint8_t pad[1]; /* Align to 32-bits. */
546 uint32_t duration; /* Time flow was alive in seconds. */
547 uint8_t pad2[4]; /* Align to 64-bits. */
548 uint64_t packet_count;
551 OFP_ASSERT(sizeof(struct ofp_flow_expired) == 72);
553 /* Values for 'type' in ofp_error_message. These values are immutable: they
554 * will not change in future versions of the protocol (although new values may
556 enum ofp_error_type {
557 OFPET_HELLO_FAILED, /* Hello protocol failed. */
558 OFPET_BAD_REQUEST, /* Request was not understood. */
559 OFPET_BAD_ACTION, /* Error in action description. */
560 OFPET_FLOW_MOD_FAILED /* Problem modifying flow entry. */
563 /* ofp_error_msg 'code' values for OFPET_HELLO_FAILED. 'data' contains an
564 * ASCII text string that may give failure details. */
565 enum ofp_hello_failed_code {
566 OFPHFC_INCOMPATIBLE /* No compatible version. */
569 /* ofp_error_msg 'code' values for OFPET_BAD_REQUEST. 'data' contains at least
570 * the first 64 bytes of the failed request. */
571 enum ofp_bad_request_code {
572 OFPBRC_BAD_VERSION, /* ofp_header.version not supported. */
573 OFPBRC_BAD_TYPE, /* ofp_header.type not supported. */
574 OFPBRC_BAD_STAT, /* ofp_stats_request.type not supported. */
575 OFPBRC_BAD_VENDOR, /* Vendor not supported (in ofp_vendor or
576 * ofp_stats_request or ofp_stats_reply). */
577 OFPBRC_BAD_SUBTYPE /* Vendor subtype not supported. */
580 /* ofp_error_msg 'code' values for OFPET_BAD_ACTION. 'data' contains at least
581 * the first 64 bytes of the failed request. */
582 enum ofp_bad_action_code {
583 OFPBAC_BAD_TYPE, /* Unknown action type. */
584 OFPBAC_BAD_LEN, /* Length problem in actions. */
585 OFPBAC_BAD_VENDOR, /* Unknown vendor id specified. */
586 OFPBAC_BAD_VENDOR_TYPE, /* Unknown action type for vendor id. */
587 OFPBAC_BAD_OUT_PORT, /* Problem validating output action. */
588 OFPBAC_BAD_ARGUMENT /* Bad action argument. */
591 /* ofp_error_msg 'code' values for OFPET_FLOW_MOD_FAILED. 'data' contains
592 * at least the first 64 bytes of the failed request. */
593 enum ofp_flow_mod_failed_code {
594 OFPFMFC_ALL_TABLES_FULL /* Flow not added because of full tables. */
597 /* OFPT_ERROR: Error message (datapath -> controller). */
598 struct ofp_error_msg {
599 struct ofp_header header;
603 uint8_t data[0]; /* Variable-length data. Interpreted based
604 on the type and code. */
606 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
608 enum ofp_stats_types {
609 /* Description of this OpenFlow switch.
610 * The request body is empty.
611 * The reply body is struct ofp_desc_stats. */
614 /* Individual flow statistics.
615 * The request body is struct ofp_flow_stats_request.
616 * The reply body is an array of struct ofp_flow_stats. */
619 /* Aggregate flow statistics.
620 * The request body is struct ofp_aggregate_stats_request.
621 * The reply body is struct ofp_aggregate_stats_reply. */
624 /* Flow table statistics.
625 * The request body is empty.
626 * The reply body is an array of struct ofp_table_stats. */
629 /* Physical port statistics.
630 * The request body is empty.
631 * The reply body is an array of struct ofp_port_stats. */
635 * The request and reply bodies begin with a 32-bit vendor ID, which takes
636 * the same form as in "struct ofp_vendor". The request and reply bodies
637 * are otherwise vendor-defined. */
638 OFPST_VENDOR = 0xffff
641 struct ofp_stats_request {
642 struct ofp_header header;
643 uint16_t type; /* One of the OFPST_* constants. */
644 uint16_t flags; /* OFPSF_REQ_* flags (none yet defined). */
645 uint8_t body[0]; /* Body of the request. */
647 OFP_ASSERT(sizeof(struct ofp_stats_request) == 12);
649 enum ofp_stats_reply_flags {
650 OFPSF_REPLY_MORE = 1 << 0 /* More replies to follow */
653 struct ofp_stats_reply {
654 struct ofp_header header;
655 uint16_t type; /* One of the OFPST_* constants. */
656 uint16_t flags; /* OFPSF_REPLY_* flags. */
657 uint8_t body[0]; /* Body of the reply. */
659 OFP_ASSERT(sizeof(struct ofp_stats_reply) == 12);
661 #define DESC_STR_LEN 256
662 #define SERIAL_NUM_LEN 32
663 /* Body of reply to OFPST_DESC request. Each entry is a NULL-terminated
665 struct ofp_desc_stats {
666 char mfr_desc[DESC_STR_LEN]; /* Manufacturer description. */
667 char hw_desc[DESC_STR_LEN]; /* Hardware description. */
668 char sw_desc[DESC_STR_LEN]; /* Software description. */
669 char serial_num[SERIAL_NUM_LEN]; /* Serial number. */
671 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 800);
673 /* Body for ofp_stats_request of type OFPST_FLOW. */
674 struct ofp_flow_stats_request {
675 struct ofp_match match; /* Fields to match */
676 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
677 or 0xff for all tables. */
678 uint8_t pad[3]; /* Align to 32 bits. */
680 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 40);
682 /* Body of reply to OFPST_FLOW request. */
683 struct ofp_flow_stats {
684 uint16_t length; /* Length of this entry. */
685 uint8_t table_id; /* ID of table flow came from. */
687 struct ofp_match match; /* Description of fields. */
688 uint32_t duration; /* Time flow has been alive in seconds. */
689 uint16_t priority; /* Priority of the entry. Only meaningful
690 when this is not an exact-match entry. */
691 uint16_t idle_timeout; /* Number of seconds idle before expiration. */
692 uint16_t hard_timeout; /* Number of seconds before expiration. */
693 uint16_t pad2[3]; /* Pad to 64 bits. */
694 uint64_t packet_count; /* Number of packets in flow. */
695 uint64_t byte_count; /* Number of bytes in flow. */
696 struct ofp_action_header actions[0]; /* Actions. */
698 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 72);
700 /* Body for ofp_stats_request of type OFPST_AGGREGATE. */
701 struct ofp_aggregate_stats_request {
702 struct ofp_match match; /* Fields to match */
703 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
704 or 0xff for all tables. */
705 uint8_t pad[3]; /* Align to 32 bits. */
707 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 40);
709 /* Body of reply to OFPST_AGGREGATE request. */
710 struct ofp_aggregate_stats_reply {
711 uint64_t packet_count; /* Number of packets in flows. */
712 uint64_t byte_count; /* Number of bytes in flows. */
713 uint32_t flow_count; /* Number of flows. */
714 uint8_t pad[4]; /* Align to 64 bits. */
716 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
718 /* Body of reply to OFPST_TABLE request. */
719 struct ofp_table_stats {
720 uint8_t table_id; /* Identifier of table. Lower numbered tables
721 are consulted first. */
722 uint8_t pad[3]; /* Align to 32-bits */
723 char name[OFP_MAX_TABLE_NAME_LEN];
724 uint32_t wildcards; /* Bitmap of OFPFW_* wildcards that are
725 supported by the table. */
726 uint32_t max_entries; /* Max number of entries supported */
727 uint32_t active_count; /* Number of active entries */
728 uint64_t lookup_count; /* Number of packets looked up in table */
729 uint64_t matched_count; /* Number of packets that hit table */
731 OFP_ASSERT(sizeof(struct ofp_table_stats) == 64);
733 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
734 * the field to all ones. */
735 struct ofp_port_stats {
737 uint8_t pad[6]; /* Align to 64-bits. */
738 uint64_t rx_packets; /* Number of received packets. */
739 uint64_t tx_packets; /* Number of transmitted packets. */
740 uint64_t rx_bytes; /* Number of received bytes. */
741 uint64_t tx_bytes; /* Number of transmitted bytes. */
742 uint64_t rx_dropped; /* Number of packets dropped by RX. */
743 uint64_t tx_dropped; /* Number of packets dropped by TX. */
744 uint64_t rx_errors; /* Number of receive errors. This is a super-set
745 of receive errors and should be great than or
746 equal to the sum of al rx_*_err values. */
747 uint64_t tx_errors; /* Number of transmit errors. This is a super-set
748 of transmit errors. */
749 uint64_t rx_frame_err; /* Number of frame alignment errors. */
750 uint64_t rx_over_err; /* Number of packets with RX overrun. */
751 uint64_t rx_crc_err; /* Number of CRC errors. */
752 uint64_t collisions; /* Number of collisions. */
754 OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
756 /* Vendor extension. */
757 struct ofp_vendor_header {
758 struct ofp_header header; /* Type OFPT_VENDOR. */
759 uint32_t vendor; /* Vendor ID:
760 * - MSB 0: low-order bytes are IEEE OUI.
761 * - MSB != 0: defined by OpenFlow
763 /* Vendor-defined arbitrary additional data. */
765 OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12);
767 #endif /* openflow.h */