2 * Copyright (c) 2008, 2009, 2010 Nicira Networks.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 /* OpenFlow: protocol between controller and datapath. */
19 #ifndef OPENFLOW_OPENFLOW_H
20 #define OPENFLOW_OPENFLOW_H 1
23 #include <linux/types.h>
29 #define OFP_ASSERT(EXPR) /* SWIG can't handle OFP_ASSERT. */
30 #elif !defined(__cplusplus)
31 /* Build-time assertion for use in a declaration context. */
32 #define OFP_ASSERT(EXPR) \
33 extern int (*build_assert(void))[ sizeof(struct { \
34 unsigned int build_assert_failed : (EXPR) ? 1 : -1; })]
35 #else /* __cplusplus */
36 #include <boost/static_assert.hpp>
37 #define OFP_ASSERT BOOST_STATIC_ASSERT
38 #endif /* __cplusplus */
41 #define OFP_PACKED __attribute__((packed))
43 #define OFP_PACKED /* SWIG doesn't understand __attribute. */
46 /* The most significant bit being set in the version field indicates an
47 * experimental OpenFlow version.
49 #define OFP_VERSION 0x98
51 #define OFP_MAX_TABLE_NAME_LEN 32
52 #define OFP_MAX_PORT_NAME_LEN 16
54 #define OFP_TCP_PORT 6633
55 #define OFP_SSL_PORT 6633
57 #define OFP_ETH_ALEN 6 /* Bytes in an Ethernet address. */
59 /* Port numbering. Physical ports are numbered starting from 1. */
61 /* Maximum number of physical switch ports. */
64 /* Fake output "ports". */
65 OFPP_IN_PORT = 0xfff8, /* Send the packet out the input port. This
66 virtual port must be explicitly used
67 in order to send back out of the input
69 OFPP_TABLE = 0xfff9, /* Perform actions in flow table.
70 NB: This can only be the destination
71 port for packet-out messages. */
72 OFPP_NORMAL = 0xfffa, /* Process with normal L2/L3 switching. */
73 OFPP_FLOOD = 0xfffb, /* All physical ports except input port and
74 those disabled by STP. */
75 OFPP_ALL = 0xfffc, /* All physical ports except input port. */
76 OFPP_CONTROLLER = 0xfffd, /* Send to controller. */
77 OFPP_LOCAL = 0xfffe, /* Local openflow "port". */
78 OFPP_NONE = 0xffff /* Not associated with a physical port. */
82 /* Immutable messages. */
83 OFPT_HELLO, /* Symmetric message */
84 OFPT_ERROR, /* Symmetric message */
85 OFPT_ECHO_REQUEST, /* Symmetric message */
86 OFPT_ECHO_REPLY, /* Symmetric message */
87 OFPT_VENDOR, /* Symmetric message */
89 /* Switch configuration messages. */
90 OFPT_FEATURES_REQUEST, /* Controller/switch message */
91 OFPT_FEATURES_REPLY, /* Controller/switch message */
92 OFPT_GET_CONFIG_REQUEST, /* Controller/switch message */
93 OFPT_GET_CONFIG_REPLY, /* Controller/switch message */
94 OFPT_SET_CONFIG, /* Controller/switch message */
96 /* Asynchronous messages. */
97 OFPT_PACKET_IN, /* Async message */
98 OFPT_FLOW_REMOVED, /* Async message */
99 OFPT_PORT_STATUS, /* Async message */
101 /* Controller command messages. */
102 OFPT_PACKET_OUT, /* Controller/switch message */
103 OFPT_FLOW_MOD, /* Controller/switch message */
104 OFPT_PORT_MOD, /* Controller/switch message */
106 /* Statistics messages. */
107 OFPT_STATS_REQUEST, /* Controller/switch message */
108 OFPT_STATS_REPLY, /* Controller/switch message */
110 /* Barrier messages. */
111 OFPT_BARRIER_REQUEST, /* Controller/switch message */
112 OFPT_BARRIER_REPLY /* Controller/switch message */
115 /* Header on all OpenFlow packets. */
117 uint8_t version; /* OFP_VERSION. */
118 uint8_t type; /* One of the OFPT_ constants. */
119 uint16_t length; /* Length including this ofp_header. */
120 uint32_t xid; /* Transaction id associated with this packet.
121 Replies use the same id as was in the request
122 to facilitate pairing. */
124 OFP_ASSERT(sizeof(struct ofp_header) == 8);
126 /* OFPT_HELLO. This message has an empty body, but implementations must
127 * ignore any data included in the body, to allow for future extensions. */
129 struct ofp_header header;
132 #define OFP_DEFAULT_MISS_SEND_LEN 128
134 enum ofp_config_flags {
135 /* Handling of IP fragments. */
136 OFPC_FRAG_NORMAL = 0 << 1, /* No special handling for fragments. */
137 OFPC_FRAG_DROP = 1 << 1, /* Drop fragments. */
138 OFPC_FRAG_REASM = 2 << 1, /* Reassemble (only if OFPC_IP_REASM set). */
139 OFPC_FRAG_MASK = 3 << 1
142 /* Switch configuration. */
143 struct ofp_switch_config {
144 struct ofp_header header;
145 uint16_t flags; /* OFPC_* flags. */
146 uint16_t miss_send_len; /* Max bytes of new flow that datapath should
147 send to the controller. */
149 OFP_ASSERT(sizeof(struct ofp_switch_config) == 12);
151 /* Capabilities supported by the datapath. */
152 enum ofp_capabilities {
153 OFPC_FLOW_STATS = 1 << 0, /* Flow statistics. */
154 OFPC_TABLE_STATS = 1 << 1, /* Table statistics. */
155 OFPC_PORT_STATS = 1 << 2, /* Port statistics. */
156 OFPC_STP = 1 << 3, /* 802.1d spanning tree. */
157 OFPC_MULTI_PHY_TX = 1 << 4, /* Supports transmitting through multiple
158 physical interfaces */
159 OFPC_IP_REASM = 1 << 5 /* Can reassemble IP fragments. */
162 /* Flags to indicate behavior of the physical port. These flags are
163 * used in ofp_phy_port to describe the current configuration. They are
164 * used in the ofp_port_mod message to configure the port's behavior.
166 enum ofp_port_config {
167 OFPPC_PORT_DOWN = 1 << 0, /* Port is administratively down. */
169 OFPPC_NO_STP = 1 << 1, /* Disable 802.1D spanning tree on port. */
170 OFPPC_NO_RECV = 1 << 2, /* Drop all packets except 802.1D
171 spanning tree packets. */
172 OFPPC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */
173 OFPPC_NO_FLOOD = 1 << 4, /* Do not include this port when flooding. */
174 OFPPC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */
175 OFPPC_NO_PACKET_IN = 1 << 6 /* Do not send packet-in msgs for port. */
178 /* Current state of the physical port. These are not configurable from
181 enum ofp_port_state {
182 OFPPS_LINK_DOWN = 1 << 0, /* No physical link present. */
184 /* The OFPPS_STP_* bits have no effect on switch operation. The
185 * controller must adjust OFPPC_NO_RECV, OFPPC_NO_FWD, and
186 * OFPPC_NO_PACKET_IN appropriately to fully implement an 802.1D spanning
188 OFPPS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
189 OFPPS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
190 OFPPS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
191 OFPPS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
192 OFPPS_STP_MASK = 3 << 8 /* Bit mask for OFPPS_STP_* values. */
195 /* Features of physical ports available in a datapath. */
196 enum ofp_port_features {
197 OFPPF_10MB_HD = 1 << 0, /* 10 Mb half-duplex rate support. */
198 OFPPF_10MB_FD = 1 << 1, /* 10 Mb full-duplex rate support. */
199 OFPPF_100MB_HD = 1 << 2, /* 100 Mb half-duplex rate support. */
200 OFPPF_100MB_FD = 1 << 3, /* 100 Mb full-duplex rate support. */
201 OFPPF_1GB_HD = 1 << 4, /* 1 Gb half-duplex rate support. */
202 OFPPF_1GB_FD = 1 << 5, /* 1 Gb full-duplex rate support. */
203 OFPPF_10GB_FD = 1 << 6, /* 10 Gb full-duplex rate support. */
204 OFPPF_COPPER = 1 << 7, /* Copper medium. */
205 OFPPF_FIBER = 1 << 8, /* Fiber medium. */
206 OFPPF_AUTONEG = 1 << 9, /* Auto-negotiation. */
207 OFPPF_PAUSE = 1 << 10, /* Pause. */
208 OFPPF_PAUSE_ASYM = 1 << 11 /* Asymmetric pause. */
211 /* Description of a physical port */
212 struct ofp_phy_port {
214 uint8_t hw_addr[OFP_ETH_ALEN];
215 uint8_t name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
217 uint32_t config; /* Bitmap of OFPPC_* flags. */
218 uint32_t state; /* Bitmap of OFPPS_* flags. */
220 /* Bitmaps of OFPPF_* that describe features. All bits zeroed if
221 * unsupported or unavailable. */
222 uint32_t curr; /* Current features. */
223 uint32_t advertised; /* Features being advertised by the port. */
224 uint32_t supported; /* Features supported by the port. */
225 uint32_t peer; /* Features advertised by peer. */
227 OFP_ASSERT(sizeof(struct ofp_phy_port) == 48);
229 /* Switch features. */
230 struct ofp_switch_features {
231 struct ofp_header header;
232 uint64_t datapath_id; /* Datapath unique ID. The lower 48-bits are for
233 a MAC address, while the upper 16-bits are
234 implementer-defined. */
236 uint32_t n_buffers; /* Max packets buffered at once. */
238 uint8_t n_tables; /* Number of tables supported by datapath. */
239 uint8_t pad[3]; /* Align to 64-bits. */
242 uint32_t capabilities; /* Bitmap of support "ofp_capabilities". */
243 uint32_t actions; /* Bitmap of supported "ofp_action_type"s. */
246 struct ofp_phy_port ports[0]; /* Port definitions. The number of ports
247 is inferred from the length field in
250 OFP_ASSERT(sizeof(struct ofp_switch_features) == 32);
252 /* What changed about the physical port */
253 enum ofp_port_reason {
254 OFPPR_ADD, /* The port was added. */
255 OFPPR_DELETE, /* The port was removed. */
256 OFPPR_MODIFY /* Some attribute of the port has changed. */
259 /* A physical port has changed in the datapath */
260 struct ofp_port_status {
261 struct ofp_header header;
262 uint8_t reason; /* One of OFPPR_*. */
263 uint8_t pad[7]; /* Align to 64-bits. */
264 struct ofp_phy_port desc;
266 OFP_ASSERT(sizeof(struct ofp_port_status) == 64);
268 /* Modify behavior of the physical port */
269 struct ofp_port_mod {
270 struct ofp_header header;
272 uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
273 configurable. This is used to
274 sanity-check the request, so it must
275 be the same as returned in an
276 ofp_phy_port struct. */
278 uint32_t config; /* Bitmap of OFPPC_* flags. */
279 uint32_t mask; /* Bitmap of OFPPC_* flags to be changed. */
281 uint32_t advertise; /* Bitmap of "ofp_port_features"s. Zero all
282 bits to prevent any action taking place. */
283 uint8_t pad[4]; /* Pad to 64-bits. */
285 OFP_ASSERT(sizeof(struct ofp_port_mod) == 32);
287 /* Why is this packet being sent to the controller? */
288 enum ofp_packet_in_reason {
289 OFPR_NO_MATCH, /* No matching flow. */
290 OFPR_ACTION /* Action explicitly output to controller. */
293 /* Packet received on port (datapath -> controller). */
294 struct ofp_packet_in {
295 struct ofp_header header;
296 uint32_t buffer_id; /* ID assigned by datapath. */
297 uint16_t total_len; /* Full length of frame. */
298 uint16_t in_port; /* Port on which frame was received. */
299 uint8_t reason; /* Reason packet is being sent (one of OFPR_*) */
301 uint8_t data[0]; /* Ethernet frame, halfway through 32-bit word,
302 so the IP header is 32-bit aligned. The
303 amount of data is inferred from the length
304 field in the header. Because of padding,
305 offsetof(struct ofp_packet_in, data) ==
306 sizeof(struct ofp_packet_in) - 2. */
308 OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
310 enum ofp_action_type {
311 OFPAT_OUTPUT, /* Output to switch port. */
312 OFPAT_SET_VLAN_VID, /* Set the 802.1q VLAN id. */
313 OFPAT_SET_VLAN_PCP, /* Set the 802.1q priority. */
314 OFPAT_STRIP_VLAN, /* Strip the 802.1q header. */
315 OFPAT_SET_DL_SRC, /* Ethernet source address. */
316 OFPAT_SET_DL_DST, /* Ethernet destination address. */
317 OFPAT_SET_NW_SRC, /* IP source address. */
318 OFPAT_SET_NW_DST, /* IP destination address. */
319 OFPAT_SET_NW_TOS, /* IP ToS/DSCP field (6 bits). */
320 OFPAT_SET_TP_SRC, /* TCP/UDP source port. */
321 OFPAT_SET_TP_DST, /* TCP/UDP destination port. */
322 OFPAT_VENDOR = 0xffff
325 /* Action structure for OFPAT_OUTPUT, which sends packets out 'port'.
326 * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
327 * number of bytes to send. A 'max_len' of zero means no bytes of the
328 * packet should be sent. */
329 struct ofp_action_output {
330 uint16_t type; /* OFPAT_OUTPUT. */
331 uint16_t len; /* Length is 8. */
332 uint16_t port; /* Output port. */
333 uint16_t max_len; /* Max length to send to controller. */
335 OFP_ASSERT(sizeof(struct ofp_action_output) == 8);
337 /* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate
338 * special conditions. All ones is used to match that no VLAN id was
340 #define OFP_VLAN_NONE 0xffff
342 /* Action structure for OFPAT_SET_VLAN_VID. */
343 struct ofp_action_vlan_vid {
344 uint16_t type; /* OFPAT_SET_VLAN_VID. */
345 uint16_t len; /* Length is 8. */
346 uint16_t vlan_vid; /* VLAN id. */
349 OFP_ASSERT(sizeof(struct ofp_action_vlan_vid) == 8);
351 /* Action structure for OFPAT_SET_VLAN_PCP. */
352 struct ofp_action_vlan_pcp {
353 uint16_t type; /* OFPAT_SET_VLAN_PCP. */
354 uint16_t len; /* Length is 8. */
355 uint8_t vlan_pcp; /* VLAN priority. */
358 OFP_ASSERT(sizeof(struct ofp_action_vlan_pcp) == 8);
360 /* Action structure for OFPAT_SET_DL_SRC/DST. */
361 struct ofp_action_dl_addr {
362 uint16_t type; /* OFPAT_SET_DL_SRC/DST. */
363 uint16_t len; /* Length is 16. */
364 uint8_t dl_addr[OFP_ETH_ALEN]; /* Ethernet address. */
367 OFP_ASSERT(sizeof(struct ofp_action_dl_addr) == 16);
369 /* Action structure for OFPAT_SET_NW_SRC/DST. */
370 struct ofp_action_nw_addr {
371 uint16_t type; /* OFPAT_SET_TW_SRC/DST. */
372 uint16_t len; /* Length is 8. */
373 uint32_t nw_addr; /* IP address. */
375 OFP_ASSERT(sizeof(struct ofp_action_nw_addr) == 8);
377 /* Action structure for OFPAT_SET_NW_TOS. */
378 struct ofp_action_nw_tos {
379 uint16_t type; /* OFPAT_SET_TW_TOS. */
380 uint16_t len; /* Length is 8. */
381 uint8_t nw_tos; /* IP ToS/DSCP (6 bits). */
384 OFP_ASSERT(sizeof(struct ofp_action_nw_tos) == 8);
386 /* Action structure for OFPAT_SET_TP_SRC/DST. */
387 struct ofp_action_tp_port {
388 uint16_t type; /* OFPAT_SET_TP_SRC/DST. */
389 uint16_t len; /* Length is 8. */
390 uint16_t tp_port; /* TCP/UDP port. */
393 OFP_ASSERT(sizeof(struct ofp_action_tp_port) == 8);
395 /* Action header for OFPAT_VENDOR. The rest of the body is vendor-defined. */
396 struct ofp_action_vendor_header {
397 uint16_t type; /* OFPAT_VENDOR. */
398 uint16_t len; /* Length is a multiple of 8. */
399 uint32_t vendor; /* Vendor ID, which takes the same form
400 as in "struct ofp_vendor_header". */
402 OFP_ASSERT(sizeof(struct ofp_action_vendor_header) == 8);
404 /* Action header that is common to all actions. The length includes the
405 * header and any padding used to make the action 64-bit aligned.
406 * NB: The length of an action *must* always be a multiple of eight. */
407 struct ofp_action_header {
408 uint16_t type; /* One of OFPAT_*. */
409 uint16_t len; /* Length of action, including this
410 header. This is the length of action,
411 including any padding to make it
415 OFP_ASSERT(sizeof(struct ofp_action_header) == 8);
419 struct ofp_action_header header;
420 struct ofp_action_vendor_header vendor;
421 struct ofp_action_output output;
422 struct ofp_action_vlan_vid vlan_vid;
423 struct ofp_action_vlan_pcp vlan_pcp;
424 struct ofp_action_nw_addr nw_addr;
425 struct ofp_action_nw_tos nw_tos;
426 struct ofp_action_tp_port tp_port;
428 OFP_ASSERT(sizeof(union ofp_action) == 8);
430 /* Send packet (controller -> datapath). */
431 struct ofp_packet_out {
432 struct ofp_header header;
433 uint32_t buffer_id; /* ID assigned by datapath (-1 if none). */
434 uint16_t in_port; /* Packet's input port (OFPP_NONE if none). */
435 uint16_t actions_len; /* Size of action array in bytes. */
436 struct ofp_action_header actions[0]; /* Actions. */
437 /* uint8_t data[0]; */ /* Packet data. The length is inferred
438 from the length field in the header.
439 (Only meaningful if buffer_id == -1.) */
441 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
443 enum ofp_flow_mod_command {
444 OFPFC_ADD, /* New flow. */
445 OFPFC_MODIFY, /* Modify all matching flows. */
446 OFPFC_MODIFY_STRICT, /* Modify entry strictly matching wildcards */
447 OFPFC_DELETE, /* Delete all matching flows. */
448 OFPFC_DELETE_STRICT /* Strictly match wildcards and priority. */
451 /* Flow wildcards. */
452 enum ofp_flow_wildcards {
453 OFPFW_IN_PORT = 1 << 0, /* Switch input port. */
454 OFPFW_DL_VLAN = 1 << 1, /* VLAN vid. */
455 OFPFW_DL_SRC = 1 << 2, /* Ethernet source address. */
456 OFPFW_DL_DST = 1 << 3, /* Ethernet destination address. */
457 OFPFW_DL_TYPE = 1 << 4, /* Ethernet frame type. */
458 OFPFW_NW_PROTO = 1 << 5, /* IP protocol. */
459 OFPFW_TP_SRC = 1 << 6, /* TCP/UDP source port. */
460 OFPFW_TP_DST = 1 << 7, /* TCP/UDP destination port. */
462 /* IP source address wildcard bit count. 0 is exact match, 1 ignores the
463 * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
464 * the entire field. This is the *opposite* of the usual convention where
465 * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
466 OFPFW_NW_SRC_SHIFT = 8,
467 OFPFW_NW_SRC_BITS = 6,
468 OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
469 OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
471 /* IP destination address wildcard bit count. Same format as source. */
472 OFPFW_NW_DST_SHIFT = 14,
473 OFPFW_NW_DST_BITS = 6,
474 OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
475 OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
477 OFPFW_DL_VLAN_PCP = 1 << 20, /* VLAN priority. */
479 /* Wildcard all fields. */
480 OFPFW_ALL = ((1 << 21) - 1)
483 /* The wildcards for ICMP type and code fields use the transport source
484 * and destination port fields, respectively. */
485 #define OFPFW_ICMP_TYPE OFPFW_TP_SRC
486 #define OFPFW_ICMP_CODE OFPFW_TP_DST
488 /* Values below this cutoff are 802.3 packets and the two bytes
489 * following MAC addresses are used as a frame length. Otherwise, the
490 * two bytes are used as the Ethernet type.
492 #define OFP_DL_TYPE_ETH2_CUTOFF 0x0600
494 /* Value of dl_type to indicate that the frame does not include an
497 #define OFP_DL_TYPE_NOT_ETH_TYPE 0x05ff
499 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
500 * special conditions. All ones indicates that no VLAN id was set.
502 #define OFP_VLAN_NONE 0xffff
504 /* Fields to match against flows */
506 uint32_t wildcards; /* Wildcard fields. */
507 uint16_t in_port; /* Input switch port. */
508 uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
509 uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
510 uint16_t dl_vlan; /* Input VLAN. */
511 uint8_t dl_vlan_pcp; /* Input VLAN priority. */
512 uint8_t pad1[1]; /* Align to 64-bits. */
513 uint16_t dl_type; /* Ethernet frame type. */
514 uint8_t nw_proto; /* IP protocol. */
515 uint8_t pad2[3]; /* Align to 64-bits. */
516 uint32_t nw_src; /* IP source address. */
517 uint32_t nw_dst; /* IP destination address. */
518 uint16_t tp_src; /* TCP/UDP source port. */
519 uint16_t tp_dst; /* TCP/UDP destination port. */
521 OFP_ASSERT(sizeof(struct ofp_match) == 40);
523 /* The match fields for ICMP type and code use the transport source and
524 * destination port fields, respectively. */
525 #define icmp_type tp_src
526 #define icmp_code tp_dst
528 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
530 #define OFP_FLOW_PERMANENT 0
532 /* By default, choose a priority in the middle. */
533 #define OFP_DEFAULT_PRIORITY 0x8000
535 enum ofp_flow_mod_flags {
536 OFPFF_SEND_FLOW_REM = 1 << 0, /* Send flow removed message when flow
537 * expires or is deleted. */
538 OFPFF_CHECK_OVERLAP = 1 << 1, /* Check for overlapping entries first. */
539 OFPFF_EMERG = 1 << 2 /* Ramark this is for emergency. */
542 /* Flow setup and teardown (controller -> datapath). */
543 struct ofp_flow_mod {
544 struct ofp_header header;
545 struct ofp_match match; /* Fields to match */
548 uint16_t command; /* One of OFPFC_*. */
549 uint16_t idle_timeout; /* Idle time before discarding (seconds). */
550 uint16_t hard_timeout; /* Max time before discarding (seconds). */
551 uint16_t priority; /* Priority level of flow entry. */
552 uint32_t buffer_id; /* Buffered packet to apply to (or -1).
553 Not meaningful for OFPFC_DELETE*. */
554 uint16_t out_port; /* For OFPFC_DELETE* commands, require
555 matching entries to include this as an
556 output port. A value of OFPP_NONE
557 indicates no restriction. */
558 uint16_t flags; /* One of OFPFF_*. */
559 uint32_t reserved; /* Reserved for future use. */
560 struct ofp_action_header actions[0]; /* The action length is inferred
561 from the length field in the
564 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 68);
566 /* Why was this flow removed? */
567 enum ofp_flow_removed_reason {
568 OFPRR_IDLE_TIMEOUT, /* Flow idle time exceeded idle_timeout. */
569 OFPRR_HARD_TIMEOUT, /* Time exceeded hard_timeout. */
570 OFPRR_DELETE /* Evicted by a DELETE flow mod. */
573 /* Flow removed (datapath -> controller). */
574 struct ofp_flow_removed {
575 struct ofp_header header;
576 struct ofp_match match; /* Description of fields. */
578 uint16_t priority; /* Priority level of flow entry. */
579 uint8_t reason; /* One of OFPRR_*. */
580 uint8_t pad[1]; /* Align to 32-bits. */
582 uint32_t duration; /* Time flow was alive in seconds. */
583 uint16_t idle_timeout; /* Idle timeout from original flow mod. */
584 uint8_t pad2[6]; /* Align to 64-bits. */
585 uint64_t packet_count;
588 OFP_ASSERT(sizeof(struct ofp_flow_removed) == 80);
590 /* Values for 'type' in ofp_error_message. These values are immutable: they
591 * will not change in future versions of the protocol (although new values may
593 enum ofp_error_type {
594 OFPET_HELLO_FAILED, /* Hello protocol failed. */
595 OFPET_BAD_REQUEST, /* Request was not understood. */
596 OFPET_BAD_ACTION, /* Error in action description. */
597 OFPET_FLOW_MOD_FAILED, /* Problem modifying flow entry. */
598 OFPET_PORT_MOD_FAILED /* OFPT_PORT_MOD failed. */
601 /* ofp_error_msg 'code' values for OFPET_HELLO_FAILED. 'data' contains an
602 * ASCII text string that may give failure details. */
603 enum ofp_hello_failed_code {
604 OFPHFC_INCOMPATIBLE, /* No compatible version. */
605 OFPHFC_EPERM /* Permissions error. */
608 /* ofp_error_msg 'code' values for OFPET_BAD_REQUEST. 'data' contains at least
609 * the first 64 bytes of the failed request. */
610 enum ofp_bad_request_code {
611 OFPBRC_BAD_VERSION, /* ofp_header.version not supported. */
612 OFPBRC_BAD_TYPE, /* ofp_header.type not supported. */
613 OFPBRC_BAD_STAT, /* ofp_stats_request.type not supported. */
614 OFPBRC_BAD_VENDOR, /* Vendor not supported (in ofp_vendor_header
615 * or ofp_stats_request or ofp_stats_reply). */
616 OFPBRC_BAD_SUBTYPE, /* Vendor subtype not supported. */
617 OFPBRC_EPERM, /* Permissions error. */
618 OFPBRC_BAD_LEN, /* Wrong request length for type. */
619 OFPBRC_BUFFER_EMPTY, /* Specified buffer has already been used. */
620 OFPBRC_BUFFER_UNKNOWN /* Specified buffer does not exist. */
623 /* ofp_error_msg 'code' values for OFPET_BAD_ACTION. 'data' contains at least
624 * the first 64 bytes of the failed request. */
625 enum ofp_bad_action_code {
626 OFPBAC_BAD_TYPE, /* Unknown action type. */
627 OFPBAC_BAD_LEN, /* Length problem in actions. */
628 OFPBAC_BAD_VENDOR, /* Unknown vendor id specified. */
629 OFPBAC_BAD_VENDOR_TYPE, /* Unknown action type for vendor id. */
630 OFPBAC_BAD_OUT_PORT, /* Problem validating output action. */
631 OFPBAC_BAD_ARGUMENT, /* Bad action argument. */
632 OFPBAC_EPERM, /* Permissions error. */
633 OFPBAC_TOO_MANY /* Can't handle this many actions. */
636 /* ofp_error_msg 'code' values for OFPET_FLOW_MOD_FAILED. 'data' contains
637 * at least the first 64 bytes of the failed request. */
638 enum ofp_flow_mod_failed_code {
639 OFPFMFC_ALL_TABLES_FULL, /* Flow not added because of full tables. */
640 OFPFMFC_OVERLAP, /* Attempted to add overlapping flow with
641 * CHECK_OVERLAP flag set. */
642 OFPFMFC_EPERM, /* Permissions error. */
643 OFPFMFC_BAD_EMERG_TIMEOUT, /* Flow not added because of non-zero idle/hard
645 OFPFMFC_BAD_COMMAND /* Unknown command. */
648 /* ofp_error_msg 'code' values for OFPET_PORT_MOD_FAILED. 'data' contains
649 * at least the first 64 bytes of the failed request. */
650 enum ofp_port_mod_failed_code {
651 OFPPMFC_BAD_PORT, /* Specified port does not exist. */
652 OFPPMFC_BAD_HW_ADDR, /* Specified hardware address is wrong. */
655 /* OFPT_ERROR: Error message (datapath -> controller). */
656 struct ofp_error_msg {
657 struct ofp_header header;
661 uint8_t data[0]; /* Variable-length data. Interpreted based
662 on the type and code. */
664 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
666 enum ofp_stats_types {
667 /* Description of this OpenFlow switch.
668 * The request body is empty.
669 * The reply body is struct ofp_desc_stats. */
672 /* Individual flow statistics.
673 * The request body is struct ofp_flow_stats_request.
674 * The reply body is an array of struct ofp_flow_stats. */
677 /* Aggregate flow statistics.
678 * The request body is struct ofp_aggregate_stats_request.
679 * The reply body is struct ofp_aggregate_stats_reply. */
682 /* Flow table statistics.
683 * The request body is empty.
684 * The reply body is an array of struct ofp_table_stats. */
687 /* Physical port statistics.
688 * The request body is empty.
689 * The reply body is an array of struct ofp_port_stats. */
693 * The request and reply bodies begin with a 32-bit vendor ID, which takes
694 * the same form as in "struct ofp_vendor_header". The request and reply
695 * bodies are otherwise vendor-defined. */
696 OFPST_VENDOR = 0xffff
699 struct ofp_stats_request {
700 struct ofp_header header;
701 uint16_t type; /* One of the OFPST_* constants. */
702 uint16_t flags; /* OFPSF_REQ_* flags (none yet defined). */
703 uint8_t body[0]; /* Body of the request. */
705 OFP_ASSERT(sizeof(struct ofp_stats_request) == 12);
707 enum ofp_stats_reply_flags {
708 OFPSF_REPLY_MORE = 1 << 0 /* More replies to follow. */
711 struct ofp_stats_reply {
712 struct ofp_header header;
713 uint16_t type; /* One of the OFPST_* constants. */
714 uint16_t flags; /* OFPSF_REPLY_* flags. */
715 uint8_t body[0]; /* Body of the reply. */
717 OFP_ASSERT(sizeof(struct ofp_stats_reply) == 12);
719 #define DESC_STR_LEN 256
720 #define SERIAL_NUM_LEN 32
721 /* Body of reply to OFPST_DESC request. Each entry is a NULL-terminated
723 struct ofp_desc_stats {
724 char mfr_desc[DESC_STR_LEN]; /* Manufacturer description. */
725 char hw_desc[DESC_STR_LEN]; /* Hardware description. */
726 char sw_desc[DESC_STR_LEN]; /* Software description. */
727 char serial_num[SERIAL_NUM_LEN]; /* Serial number. */
728 char dp_desc[DESC_STR_LEN]; /* Human readable description of
731 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 1056);
733 /* Body for ofp_stats_request of type OFPST_FLOW. */
734 struct ofp_flow_stats_request {
735 struct ofp_match match; /* Fields to match. */
736 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
737 or 0xff for all tables. */
738 uint8_t pad; /* Align to 32 bits. */
739 uint16_t out_port; /* Require matching entries to include this
740 as an output port. A value of OFPP_NONE
741 indicates no restriction. */
743 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 44);
745 /* Body of reply to OFPST_FLOW request. */
746 struct ofp_flow_stats {
747 uint16_t length; /* Length of this entry. */
748 uint8_t table_id; /* ID of table flow came from. */
750 struct ofp_match match; /* Description of fields. */
751 uint32_t duration; /* Time flow has been alive in seconds. */
752 uint16_t priority; /* Priority of the entry. Only meaningful
753 when this is not an exact-match entry. */
754 uint16_t idle_timeout; /* Number of seconds idle before expiration. */
755 uint16_t hard_timeout; /* Number of seconds before expiration. */
756 uint16_t pad2; /* Pad to 64 bits. */
757 uint64_t packet_count; /* Number of packets in flow. */
758 uint64_t byte_count; /* Number of bytes in flow. */
759 struct ofp_action_header actions[0]; /* Actions. */
761 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 72);
763 /* Body for ofp_stats_request of type OFPST_AGGREGATE. */
764 struct ofp_aggregate_stats_request {
765 struct ofp_match match; /* Fields to match. */
766 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
767 or 0xff for all tables. */
768 uint8_t pad; /* Align to 32 bits. */
769 uint16_t out_port; /* Require matching entries to include this
770 as an output port. A value of OFPP_NONE
771 indicates no restriction. */
773 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 44);
775 /* Body of reply to OFPST_AGGREGATE request. */
776 struct ofp_aggregate_stats_reply {
777 uint64_t packet_count; /* Number of packets in flows. */
778 uint64_t byte_count; /* Number of bytes in flows. */
779 uint32_t flow_count; /* Number of flows. */
780 uint8_t pad[4]; /* Align to 64 bits. */
782 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
784 /* Body of reply to OFPST_TABLE request. */
785 struct ofp_table_stats {
786 uint8_t table_id; /* Identifier of table. Lower numbered tables
787 are consulted first. */
788 uint8_t pad[3]; /* Align to 32-bits. */
789 char name[OFP_MAX_TABLE_NAME_LEN];
790 uint32_t wildcards; /* Bitmap of OFPFW_* wildcards that are
791 supported by the table. */
792 uint32_t max_entries; /* Max number of entries supported. */
793 uint32_t active_count; /* Number of active entries. */
794 uint64_t lookup_count; /* Number of packets looked up in table. */
795 uint64_t matched_count; /* Number of packets that hit table. */
797 OFP_ASSERT(sizeof(struct ofp_table_stats) == 64);
799 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
800 * the field to all ones. */
801 struct ofp_port_stats {
803 uint8_t pad[6]; /* Align to 64-bits. */
804 uint64_t rx_packets; /* Number of received packets. */
805 uint64_t tx_packets; /* Number of transmitted packets. */
806 uint64_t rx_bytes; /* Number of received bytes. */
807 uint64_t tx_bytes; /* Number of transmitted bytes. */
808 uint64_t rx_dropped; /* Number of packets dropped by RX. */
809 uint64_t tx_dropped; /* Number of packets dropped by TX. */
810 uint64_t rx_errors; /* Number of receive errors. This is a super-set
811 of receive errors and should be great than or
812 equal to the sum of all rx_*_err values. */
813 uint64_t tx_errors; /* Number of transmit errors. This is a super-set
814 of transmit errors. */
815 uint64_t rx_frame_err; /* Number of frame alignment errors. */
816 uint64_t rx_over_err; /* Number of packets with RX overrun. */
817 uint64_t rx_crc_err; /* Number of CRC errors. */
818 uint64_t collisions; /* Number of collisions. */
820 OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
822 /* Vendor extension. */
823 struct ofp_vendor_header {
824 struct ofp_header header; /* Type OFPT_VENDOR. */
825 uint32_t vendor; /* Vendor ID:
826 * - MSB 0: low-order bytes are IEEE OUI.
827 * - MSB != 0: defined by OpenFlow
829 /* Vendor-defined arbitrary additional data. */
831 OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12);
833 #endif /* openflow/openflow.h */