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
25 #define OFP_ASSERT(EXPR) /* SWIG can't handle OFP_ASSERT. */
26 #elif !defined(__cplusplus)
27 /* Build-time assertion for use in a declaration context. */
28 #define OFP_ASSERT(EXPR) \
29 extern int (*build_assert(void))[ sizeof(struct { \
30 unsigned int build_assert_failed : (EXPR) ? 1 : -1; })]
31 #else /* __cplusplus */
32 #include <boost/static_assert.hpp>
33 #define OFP_ASSERT BOOST_STATIC_ASSERT
34 #endif /* __cplusplus */
37 * Non-experimental versions released: 0x01
38 * Experimental versions released: 0x81 -- 0x99
40 /* The most significant bit being set in the version field indicates an
41 * experimental OpenFlow version.
43 #define OFP_VERSION 0x01
45 #define OFP_MAX_TABLE_NAME_LEN 32
46 #define OFP_MAX_PORT_NAME_LEN 16
48 #define OFP_TCP_PORT 6633
49 #define OFP_SSL_PORT 6633
51 #define OFP_ETH_ALEN 6 /* Bytes in an Ethernet address. */
53 /* Port numbering. Physical ports are numbered starting from 1. */
55 /* Maximum number of physical switch ports. */
58 /* Fake output "ports". */
59 OFPP_IN_PORT = 0xfff8, /* Send the packet out the input port. This
60 virtual port must be explicitly used
61 in order to send back out of the input
63 OFPP_TABLE = 0xfff9, /* Perform actions in flow table.
64 NB: This can only be the destination
65 port for packet-out messages. */
66 OFPP_NORMAL = 0xfffa, /* Process with normal L2/L3 switching. */
67 OFPP_FLOOD = 0xfffb, /* All physical ports except input port and
68 those disabled by STP. */
69 OFPP_ALL = 0xfffc, /* All physical ports except input port. */
70 OFPP_CONTROLLER = 0xfffd, /* Send to controller. */
71 OFPP_LOCAL = 0xfffe, /* Local openflow "port". */
72 OFPP_NONE = 0xffff /* Not associated with a physical port. */
76 /* Immutable messages. */
77 OFPT_HELLO, /* Symmetric message */
78 OFPT_ERROR, /* Symmetric message */
79 OFPT_ECHO_REQUEST, /* Symmetric message */
80 OFPT_ECHO_REPLY, /* Symmetric message */
81 OFPT_VENDOR, /* Symmetric message */
83 /* Switch configuration messages. */
84 OFPT_FEATURES_REQUEST, /* Controller/switch message */
85 OFPT_FEATURES_REPLY, /* Controller/switch message */
86 OFPT_GET_CONFIG_REQUEST, /* Controller/switch message */
87 OFPT_GET_CONFIG_REPLY, /* Controller/switch message */
88 OFPT_SET_CONFIG, /* Controller/switch message */
90 /* Asynchronous messages. */
91 OFPT_PACKET_IN, /* Async message */
92 OFPT_FLOW_REMOVED, /* Async message */
93 OFPT_PORT_STATUS, /* Async message */
95 /* Controller command messages. */
96 OFPT_PACKET_OUT, /* Controller/switch message */
97 OFPT_FLOW_MOD, /* Controller/switch message */
98 OFPT_PORT_MOD, /* Controller/switch message */
100 /* Statistics messages. */
101 OFPT_STATS_REQUEST, /* Controller/switch message */
102 OFPT_STATS_REPLY, /* Controller/switch message */
104 /* Barrier messages. */
105 OFPT_BARRIER_REQUEST, /* Controller/switch message */
106 OFPT_BARRIER_REPLY, /* Controller/switch message */
108 /* Queue Configuration messages. */
109 OFPT_QUEUE_GET_CONFIG_REQUEST, /* Controller/switch message */
110 OFPT_QUEUE_GET_CONFIG_REPLY /* Controller/switch message */
113 /* Header on all OpenFlow packets. */
115 uint8_t version; /* OFP_VERSION. */
116 uint8_t type; /* One of the OFPT_ constants. */
117 uint16_t length; /* Length including this ofp_header. */
118 uint32_t xid; /* Transaction id associated with this packet.
119 Replies use the same id as was in the request
120 to facilitate pairing. */
122 OFP_ASSERT(sizeof(struct ofp_header) == 8);
124 /* OFPT_HELLO. This message has an empty body, but implementations must
125 * ignore any data included in the body, to allow for future extensions. */
127 struct ofp_header header;
130 #define OFP_DEFAULT_MISS_SEND_LEN 128
132 enum ofp_config_flags {
133 /* Handling of IP fragments. */
134 OFPC_FRAG_NORMAL = 0, /* No special handling for fragments. */
135 OFPC_FRAG_DROP = 1, /* Drop fragments. */
136 OFPC_FRAG_REASM = 2, /* Reassemble (only if OFPC_IP_REASM set). */
140 /* Switch configuration. */
141 struct ofp_switch_config {
142 struct ofp_header header;
143 uint16_t flags; /* OFPC_* flags. */
144 uint16_t miss_send_len; /* Max bytes of new flow that datapath should
145 send to the controller. */
147 OFP_ASSERT(sizeof(struct ofp_switch_config) == 12);
149 /* Capabilities supported by the datapath. */
150 enum ofp_capabilities {
151 OFPC_FLOW_STATS = 1 << 0, /* Flow statistics. */
152 OFPC_TABLE_STATS = 1 << 1, /* Table statistics. */
153 OFPC_PORT_STATS = 1 << 2, /* Port statistics. */
154 OFPC_STP = 1 << 3, /* 802.1d spanning tree. */
155 OFPC_RESERVED = 1 << 4, /* Reserved, must not be set. */
156 OFPC_IP_REASM = 1 << 5, /* Can reassemble IP fragments. */
157 OFPC_QUEUE_STATS = 1 << 6, /* Queue statistics. */
158 OFPC_ARP_MATCH_IP = 1 << 7 /* Match IP addresses in ARP
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 char 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_ENQUEUE, /* Output to queue. */
323 OFPAT_VENDOR = 0xffff
326 /* Action structure for OFPAT_OUTPUT, which sends packets out 'port'.
327 * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
328 * number of bytes to send. A 'max_len' of zero means no bytes of the
329 * packet should be sent. */
330 struct ofp_action_output {
331 uint16_t type; /* OFPAT_OUTPUT. */
332 uint16_t len; /* Length is 8. */
333 uint16_t port; /* Output port. */
334 uint16_t max_len; /* Max length to send to controller. */
336 OFP_ASSERT(sizeof(struct ofp_action_output) == 8);
338 /* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate
339 * special conditions. All ones is used to match that no VLAN id was
341 #define OFP_VLAN_NONE 0xffff
343 /* Action structure for OFPAT_SET_VLAN_VID. */
344 struct ofp_action_vlan_vid {
345 uint16_t type; /* OFPAT_SET_VLAN_VID. */
346 uint16_t len; /* Length is 8. */
347 uint16_t vlan_vid; /* VLAN id. */
350 OFP_ASSERT(sizeof(struct ofp_action_vlan_vid) == 8);
352 /* Action structure for OFPAT_SET_VLAN_PCP. */
353 struct ofp_action_vlan_pcp {
354 uint16_t type; /* OFPAT_SET_VLAN_PCP. */
355 uint16_t len; /* Length is 8. */
356 uint8_t vlan_pcp; /* VLAN priority. */
359 OFP_ASSERT(sizeof(struct ofp_action_vlan_pcp) == 8);
361 /* Action structure for OFPAT_SET_DL_SRC/DST. */
362 struct ofp_action_dl_addr {
363 uint16_t type; /* OFPAT_SET_DL_SRC/DST. */
364 uint16_t len; /* Length is 16. */
365 uint8_t dl_addr[OFP_ETH_ALEN]; /* Ethernet address. */
368 OFP_ASSERT(sizeof(struct ofp_action_dl_addr) == 16);
370 /* Action structure for OFPAT_SET_NW_SRC/DST. */
371 struct ofp_action_nw_addr {
372 uint16_t type; /* OFPAT_SET_TW_SRC/DST. */
373 uint16_t len; /* Length is 8. */
374 uint32_t nw_addr; /* IP address. */
376 OFP_ASSERT(sizeof(struct ofp_action_nw_addr) == 8);
378 /* Action structure for OFPAT_SET_NW_TOS. */
379 struct ofp_action_nw_tos {
380 uint16_t type; /* OFPAT_SET_TW_TOS. */
381 uint16_t len; /* Length is 8. */
382 uint8_t nw_tos; /* IP TOS (DSCP field, 6 bits). */
385 OFP_ASSERT(sizeof(struct ofp_action_nw_tos) == 8);
387 /* Action structure for OFPAT_SET_TP_SRC/DST. */
388 struct ofp_action_tp_port {
389 uint16_t type; /* OFPAT_SET_TP_SRC/DST. */
390 uint16_t len; /* Length is 8. */
391 uint16_t tp_port; /* TCP/UDP port. */
394 OFP_ASSERT(sizeof(struct ofp_action_tp_port) == 8);
396 /* Action header for OFPAT_VENDOR. The rest of the body is vendor-defined. */
397 struct ofp_action_vendor_header {
398 uint16_t type; /* OFPAT_VENDOR. */
399 uint16_t len; /* Length is a multiple of 8. */
400 uint32_t vendor; /* Vendor ID, which takes the same form
401 as in "struct ofp_vendor_header". */
403 OFP_ASSERT(sizeof(struct ofp_action_vendor_header) == 8);
405 /* Action header that is common to all actions. The length includes the
406 * header and any padding used to make the action 64-bit aligned.
407 * NB: The length of an action *must* always be a multiple of eight. */
408 struct ofp_action_header {
409 uint16_t type; /* One of OFPAT_*. */
410 uint16_t len; /* Length of action, including this
411 header. This is the length of action,
412 including any padding to make it
416 OFP_ASSERT(sizeof(struct ofp_action_header) == 8);
418 /* OFPAT_ENQUEUE action struct: send packets to given queue on port. */
419 struct ofp_action_enqueue {
420 uint16_t type; /* OFPAT_ENQUEUE. */
421 uint16_t len; /* Len is 16. */
422 uint16_t port; /* Port that queue belongs. Should
423 refer to a valid physical port
424 (i.e. < OFPP_MAX) or OFPP_IN_PORT. */
425 uint8_t pad[6]; /* Pad for 64-bit alignment. */
426 uint32_t queue_id; /* Where to enqueue the packets. */
428 OFP_ASSERT(sizeof(struct ofp_action_enqueue) == 16);
432 struct ofp_action_header header;
433 struct ofp_action_vendor_header vendor;
434 struct ofp_action_output output;
435 struct ofp_action_vlan_vid vlan_vid;
436 struct ofp_action_vlan_pcp vlan_pcp;
437 struct ofp_action_nw_addr nw_addr;
438 struct ofp_action_nw_tos nw_tos;
439 struct ofp_action_tp_port tp_port;
441 OFP_ASSERT(sizeof(union ofp_action) == 8);
443 /* Send packet (controller -> datapath). */
444 struct ofp_packet_out {
445 struct ofp_header header;
446 uint32_t buffer_id; /* ID assigned by datapath (-1 if none). */
447 uint16_t in_port; /* Packet's input port (OFPP_NONE if none). */
448 uint16_t actions_len; /* Size of action array in bytes. */
449 struct ofp_action_header actions[0]; /* Actions. */
450 /* uint8_t data[0]; */ /* Packet data. The length is inferred
451 from the length field in the header.
452 (Only meaningful if buffer_id == -1.) */
454 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
456 enum ofp_flow_mod_command {
457 OFPFC_ADD, /* New flow. */
458 OFPFC_MODIFY, /* Modify all matching flows. */
459 OFPFC_MODIFY_STRICT, /* Modify entry strictly matching wildcards */
460 OFPFC_DELETE, /* Delete all matching flows. */
461 OFPFC_DELETE_STRICT /* Strictly match wildcards and priority. */
464 /* Flow wildcards. */
465 enum ofp_flow_wildcards {
466 OFPFW_IN_PORT = 1 << 0, /* Switch input port. */
467 OFPFW_DL_VLAN = 1 << 1, /* VLAN vid. */
468 OFPFW_DL_SRC = 1 << 2, /* Ethernet source address. */
469 OFPFW_DL_DST = 1 << 3, /* Ethernet destination address. */
470 OFPFW_DL_TYPE = 1 << 4, /* Ethernet frame type. */
471 OFPFW_NW_PROTO = 1 << 5, /* IP protocol. */
472 OFPFW_TP_SRC = 1 << 6, /* TCP/UDP source port. */
473 OFPFW_TP_DST = 1 << 7, /* TCP/UDP destination port. */
475 /* IP source address wildcard bit count. 0 is exact match, 1 ignores the
476 * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
477 * the entire field. This is the *opposite* of the usual convention where
478 * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
479 OFPFW_NW_SRC_SHIFT = 8,
480 OFPFW_NW_SRC_BITS = 6,
481 OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
482 OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
484 /* IP destination address wildcard bit count. Same format as source. */
485 OFPFW_NW_DST_SHIFT = 14,
486 OFPFW_NW_DST_BITS = 6,
487 OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
488 OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
490 OFPFW_DL_VLAN_PCP = 1 << 20, /* VLAN priority. */
491 OFPFW_NW_TOS = 1 << 21, /* IP ToS (DSCP field, 6 bits). */
493 /* Wildcard all fields. */
494 OFPFW_ALL = ((1 << 22) - 1)
497 /* The wildcards for ICMP type and code fields use the transport source
498 * and destination port fields, respectively. */
499 #define OFPFW_ICMP_TYPE OFPFW_TP_SRC
500 #define OFPFW_ICMP_CODE OFPFW_TP_DST
502 /* Values below this cutoff are 802.3 packets and the two bytes
503 * following MAC addresses are used as a frame length. Otherwise, the
504 * two bytes are used as the Ethernet type.
506 #define OFP_DL_TYPE_ETH2_CUTOFF 0x0600
508 /* Value of dl_type to indicate that the frame does not include an
511 #define OFP_DL_TYPE_NOT_ETH_TYPE 0x05ff
513 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
514 * special conditions. All ones indicates that no VLAN id was set.
516 #define OFP_VLAN_NONE 0xffff
518 /* Fields to match against flows */
520 uint32_t wildcards; /* Wildcard fields. */
521 uint16_t in_port; /* Input switch port. */
522 uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
523 uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
524 uint16_t dl_vlan; /* Input VLAN. */
525 uint8_t dl_vlan_pcp; /* Input VLAN priority. */
526 uint8_t pad1[1]; /* Align to 64-bits. */
527 uint16_t dl_type; /* Ethernet frame type. */
528 uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */
529 uint8_t nw_proto; /* IP protocol or lower 8 bits of
531 uint8_t pad2[2]; /* Align to 64-bits. */
532 uint32_t nw_src; /* IP source address. */
533 uint32_t nw_dst; /* IP destination address. */
534 uint16_t tp_src; /* TCP/UDP source port. */
535 uint16_t tp_dst; /* TCP/UDP destination port. */
537 OFP_ASSERT(sizeof(struct ofp_match) == 40);
539 /* The match fields for ICMP type and code use the transport source and
540 * destination port fields, respectively. */
541 #define icmp_type tp_src
542 #define icmp_code tp_dst
544 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
546 #define OFP_FLOW_PERMANENT 0
548 /* By default, choose a priority in the middle. */
549 #define OFP_DEFAULT_PRIORITY 0x8000
551 enum ofp_flow_mod_flags {
552 OFPFF_SEND_FLOW_REM = 1 << 0, /* Send flow removed message when flow
553 * expires or is deleted. */
554 OFPFF_CHECK_OVERLAP = 1 << 1, /* Check for overlapping entries first. */
555 OFPFF_EMERG = 1 << 2 /* Ramark this is for emergency. */
558 /* Flow setup and teardown (controller -> datapath). */
559 struct ofp_flow_mod {
560 struct ofp_header header;
561 struct ofp_match match; /* Fields to match */
562 uint64_t cookie; /* Opaque controller-issued identifier. */
565 uint16_t command; /* One of OFPFC_*. */
566 uint16_t idle_timeout; /* Idle time before discarding (seconds). */
567 uint16_t hard_timeout; /* Max time before discarding (seconds). */
568 uint16_t priority; /* Priority level of flow entry. */
569 uint32_t buffer_id; /* Buffered packet to apply to (or -1).
570 Not meaningful for OFPFC_DELETE*. */
571 uint16_t out_port; /* For OFPFC_DELETE* commands, require
572 matching entries to include this as an
573 output port. A value of OFPP_NONE
574 indicates no restriction. */
575 uint16_t flags; /* One of OFPFF_*. */
576 struct ofp_action_header actions[0]; /* The action length is inferred
577 from the length field in the
580 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 72);
582 /* Why was this flow removed? */
583 enum ofp_flow_removed_reason {
584 OFPRR_IDLE_TIMEOUT, /* Flow idle time exceeded idle_timeout. */
585 OFPRR_HARD_TIMEOUT, /* Time exceeded hard_timeout. */
586 OFPRR_DELETE /* Evicted by a DELETE flow mod. */
589 /* Flow removed (datapath -> controller). */
590 struct ofp_flow_removed {
591 struct ofp_header header;
592 struct ofp_match match; /* Description of fields. */
593 uint64_t cookie; /* Opaque controller-issued identifier. */
595 uint16_t priority; /* Priority level of flow entry. */
596 uint8_t reason; /* One of OFPRR_*. */
597 uint8_t pad[1]; /* Align to 32-bits. */
599 uint32_t duration_sec; /* Time flow was alive in seconds. */
600 uint32_t duration_nsec; /* Time flow was alive in nanoseconds beyond
602 uint16_t idle_timeout; /* Idle timeout from original flow mod. */
603 uint8_t pad2[2]; /* Align to 64-bits. */
604 uint64_t packet_count;
607 OFP_ASSERT(sizeof(struct ofp_flow_removed) == 88);
609 /* Values for 'type' in ofp_error_message. These values are immutable: they
610 * will not change in future versions of the protocol (although new values may
612 enum ofp_error_type {
613 OFPET_HELLO_FAILED, /* Hello protocol failed. */
614 OFPET_BAD_REQUEST, /* Request was not understood. */
615 OFPET_BAD_ACTION, /* Error in action description. */
616 OFPET_FLOW_MOD_FAILED, /* Problem modifying flow entry. */
617 OFPET_PORT_MOD_FAILED, /* OFPT_PORT_MOD failed. */
618 OFPET_QUEUE_OP_FAILED /* Queue operation failed. */
621 /* ofp_error_msg 'code' values for OFPET_HELLO_FAILED. 'data' contains an
622 * ASCII text string that may give failure details. */
623 enum ofp_hello_failed_code {
624 OFPHFC_INCOMPATIBLE, /* No compatible version. */
625 OFPHFC_EPERM /* Permissions error. */
628 /* ofp_error_msg 'code' values for OFPET_BAD_REQUEST. 'data' contains at least
629 * the first 64 bytes of the failed request. */
630 enum ofp_bad_request_code {
631 OFPBRC_BAD_VERSION, /* ofp_header.version not supported. */
632 OFPBRC_BAD_TYPE, /* ofp_header.type not supported. */
633 OFPBRC_BAD_STAT, /* ofp_stats_request.type not supported. */
634 OFPBRC_BAD_VENDOR, /* Vendor not supported (in ofp_vendor_header
635 * or ofp_stats_request or ofp_stats_reply). */
636 OFPBRC_BAD_SUBTYPE, /* Vendor subtype not supported. */
637 OFPBRC_EPERM, /* Permissions error. */
638 OFPBRC_BAD_LEN, /* Wrong request length for type. */
639 OFPBRC_BUFFER_EMPTY, /* Specified buffer has already been used. */
640 OFPBRC_BUFFER_UNKNOWN /* Specified buffer does not exist. */
643 /* ofp_error_msg 'code' values for OFPET_BAD_ACTION. 'data' contains at least
644 * the first 64 bytes of the failed request. */
645 enum ofp_bad_action_code {
646 OFPBAC_BAD_TYPE, /* Unknown action type. */
647 OFPBAC_BAD_LEN, /* Length problem in actions. */
648 OFPBAC_BAD_VENDOR, /* Unknown vendor id specified. */
649 OFPBAC_BAD_VENDOR_TYPE, /* Unknown action type for vendor id. */
650 OFPBAC_BAD_OUT_PORT, /* Problem validating output action. */
651 OFPBAC_BAD_ARGUMENT, /* Bad action argument. */
652 OFPBAC_EPERM, /* Permissions error. */
653 OFPBAC_TOO_MANY, /* Can't handle this many actions. */
654 OFPBAC_BAD_QUEUE /* Problem validating output queue. */
657 /* ofp_error_msg 'code' values for OFPET_FLOW_MOD_FAILED. 'data' contains
658 * at least the first 64 bytes of the failed request. */
659 enum ofp_flow_mod_failed_code {
660 OFPFMFC_ALL_TABLES_FULL, /* Flow not added because of full tables. */
661 OFPFMFC_OVERLAP, /* Attempted to add overlapping flow with
662 * CHECK_OVERLAP flag set. */
663 OFPFMFC_EPERM, /* Permissions error. */
664 OFPFMFC_BAD_EMERG_TIMEOUT, /* Flow not added because of non-zero idle/hard
666 OFPFMFC_BAD_COMMAND, /* Unknown command. */
667 OFPFMFC_UNSUPPORTED /* Unsupported action list - cannot process in
668 the order specified. */
671 /* ofp_error_msg 'code' values for OFPET_PORT_MOD_FAILED. 'data' contains
672 * at least the first 64 bytes of the failed request. */
673 enum ofp_port_mod_failed_code {
674 OFPPMFC_BAD_PORT, /* Specified port does not exist. */
675 OFPPMFC_BAD_HW_ADDR, /* Specified hardware address is wrong. */
678 /* ofp_error msg 'code' values for OFPET_QUEUE_OP_FAILED. 'data' contains
679 * at least the first 64 bytes of the failed request */
680 enum ofp_queue_op_failed_code {
681 OFPQOFC_BAD_PORT, /* Invalid port (or port does not exist). */
682 OFPQOFC_BAD_QUEUE, /* Queue does not exist. */
683 OFPQOFC_EPERM /* Permissions error. */
686 /* OFPT_ERROR: Error message (datapath -> controller). */
687 struct ofp_error_msg {
688 struct ofp_header header;
692 uint8_t data[0]; /* Variable-length data. Interpreted based
693 on the type and code. */
695 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
697 enum ofp_stats_types {
698 /* Description of this OpenFlow switch.
699 * The request body is empty.
700 * The reply body is struct ofp_desc_stats. */
703 /* Individual flow statistics.
704 * The request body is struct ofp_flow_stats_request.
705 * The reply body is an array of struct ofp_flow_stats. */
708 /* Aggregate flow statistics.
709 * The request body is struct ofp_aggregate_stats_request.
710 * The reply body is struct ofp_aggregate_stats_reply. */
713 /* Flow table statistics.
714 * The request body is empty.
715 * The reply body is an array of struct ofp_table_stats. */
718 /* Physical port statistics.
719 * The request body is struct ofp_port_stats_request.
720 * The reply body is an array of struct ofp_port_stats. */
723 /* Queue statistics for a port
724 * The request body is struct ofp_queue_stats_request.
725 * The reply body is an array of struct ofp_queue_stats. */
729 * The request and reply bodies begin with a 32-bit vendor ID, which takes
730 * the same form as in "struct ofp_vendor_header". The request and reply
731 * bodies are otherwise vendor-defined. */
732 OFPST_VENDOR = 0xffff
735 struct ofp_stats_request {
736 struct ofp_header header;
737 uint16_t type; /* One of the OFPST_* constants. */
738 uint16_t flags; /* OFPSF_REQ_* flags (none yet defined). */
739 uint8_t body[0]; /* Body of the request. */
741 OFP_ASSERT(sizeof(struct ofp_stats_request) == 12);
743 enum ofp_stats_reply_flags {
744 OFPSF_REPLY_MORE = 1 << 0 /* More replies to follow. */
747 struct ofp_stats_reply {
748 struct ofp_header header;
749 uint16_t type; /* One of the OFPST_* constants. */
750 uint16_t flags; /* OFPSF_REPLY_* flags. */
751 uint8_t body[0]; /* Body of the reply. */
753 OFP_ASSERT(sizeof(struct ofp_stats_reply) == 12);
755 #define DESC_STR_LEN 256
756 #define SERIAL_NUM_LEN 32
757 /* Body of reply to OFPST_DESC request. Each entry is a NULL-terminated
759 struct ofp_desc_stats {
760 char mfr_desc[DESC_STR_LEN]; /* Manufacturer description. */
761 char hw_desc[DESC_STR_LEN]; /* Hardware description. */
762 char sw_desc[DESC_STR_LEN]; /* Software description. */
763 char serial_num[SERIAL_NUM_LEN]; /* Serial number. */
764 char dp_desc[DESC_STR_LEN]; /* Human readable description of
767 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 1056);
769 /* Body for ofp_stats_request of type OFPST_FLOW. */
770 struct ofp_flow_stats_request {
771 struct ofp_match match; /* Fields to match. */
772 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
773 or 0xff for all tables. */
774 uint8_t pad; /* Align to 32 bits. */
775 uint16_t out_port; /* Require matching entries to include this
776 as an output port. A value of OFPP_NONE
777 indicates no restriction. */
779 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 44);
781 /* Body of reply to OFPST_FLOW request. */
782 struct ofp_flow_stats {
783 uint16_t length; /* Length of this entry. */
784 uint8_t table_id; /* ID of table flow came from. */
786 struct ofp_match match; /* Description of fields. */
787 uint32_t duration_sec; /* Time flow has been alive in seconds. */
788 uint32_t duration_nsec; /* Time flow has been alive in nanoseconds
789 beyond duration_sec. */
790 uint16_t priority; /* Priority of the entry. Only meaningful
791 when this is not an exact-match entry. */
792 uint16_t idle_timeout; /* Number of seconds idle before expiration. */
793 uint16_t hard_timeout; /* Number of seconds before expiration. */
794 uint8_t pad2[6]; /* Align to 64 bits. */
795 uint64_t cookie; /* Opaque controller-issued identifier. */
796 uint64_t packet_count; /* Number of packets in flow. */
797 uint64_t byte_count; /* Number of bytes in flow. */
798 struct ofp_action_header actions[0]; /* Actions. */
800 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 88);
802 /* Body for ofp_stats_request of type OFPST_AGGREGATE. */
803 struct ofp_aggregate_stats_request {
804 struct ofp_match match; /* Fields to match. */
805 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
806 or 0xff for all tables. */
807 uint8_t pad; /* Align to 32 bits. */
808 uint16_t out_port; /* Require matching entries to include this
809 as an output port. A value of OFPP_NONE
810 indicates no restriction. */
812 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 44);
814 /* Body of reply to OFPST_AGGREGATE request. */
815 struct ofp_aggregate_stats_reply {
816 uint64_t packet_count; /* Number of packets in flows. */
817 uint64_t byte_count; /* Number of bytes in flows. */
818 uint32_t flow_count; /* Number of flows. */
819 uint8_t pad[4]; /* Align to 64 bits. */
821 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
823 /* Body of reply to OFPST_TABLE request. */
824 struct ofp_table_stats {
825 uint8_t table_id; /* Identifier of table. Lower numbered tables
826 are consulted first. */
827 uint8_t pad[3]; /* Align to 32-bits. */
828 char name[OFP_MAX_TABLE_NAME_LEN];
829 uint32_t wildcards; /* Bitmap of OFPFW_* wildcards that are
830 supported by the table. */
831 uint32_t max_entries; /* Max number of entries supported. */
832 uint32_t active_count; /* Number of active entries. */
833 uint64_t lookup_count; /* Number of packets looked up in table. */
834 uint64_t matched_count; /* Number of packets that hit table. */
836 OFP_ASSERT(sizeof(struct ofp_table_stats) == 64);
838 /* Body for ofp_stats_request of type OFPST_PORT. */
839 struct ofp_port_stats_request {
840 uint16_t port_no; /* OFPST_PORT message may request statistics
841 for a single port (specified with port_no)
842 or for all ports (port_no == OFPP_NONE). */
845 OFP_ASSERT(sizeof(struct ofp_port_stats_request) == 8);
847 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
848 * the field to all ones. */
849 struct ofp_port_stats {
851 uint8_t pad[6]; /* Align to 64-bits. */
852 uint64_t rx_packets; /* Number of received packets. */
853 uint64_t tx_packets; /* Number of transmitted packets. */
854 uint64_t rx_bytes; /* Number of received bytes. */
855 uint64_t tx_bytes; /* Number of transmitted bytes. */
856 uint64_t rx_dropped; /* Number of packets dropped by RX. */
857 uint64_t tx_dropped; /* Number of packets dropped by TX. */
858 uint64_t rx_errors; /* Number of receive errors. This is a super-set
859 of receive errors and should be great than or
860 equal to the sum of all rx_*_err values. */
861 uint64_t tx_errors; /* Number of transmit errors. This is a super-set
862 of transmit errors. */
863 uint64_t rx_frame_err; /* Number of frame alignment errors. */
864 uint64_t rx_over_err; /* Number of packets with RX overrun. */
865 uint64_t rx_crc_err; /* Number of CRC errors. */
866 uint64_t collisions; /* Number of collisions. */
868 OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
870 /* All ones is used to indicate all queues in a port (for stats retrieval). */
871 #define OFPQ_ALL 0xffffffff
873 /* Body for ofp_stats_request of type OFPST_QUEUE. */
874 struct ofp_queue_stats_request {
875 uint16_t port_no; /* All ports if OFPP_ALL. */
876 uint8_t pad[2]; /* Align to 32-bits. */
877 uint32_t queue_id; /* All queues if OFPQ_ALL. */
879 OFP_ASSERT(sizeof(struct ofp_queue_stats_request) == 8);
881 /* Body for ofp_stats_reply of type OFPST_QUEUE consists of an array of this
883 struct ofp_queue_stats {
885 uint8_t pad[2]; /* Align to 32-bits. */
886 uint32_t queue_id; /* Queue id. */
887 uint64_t tx_bytes; /* Number of transmitted bytes. */
888 uint64_t tx_packets; /* Number of transmitted packets. */
889 uint64_t tx_errors; /* Number of packets dropped due to overrun. */
891 OFP_ASSERT(sizeof(struct ofp_queue_stats) == 32);
893 /* Vendor extension. */
894 struct ofp_vendor_header {
895 struct ofp_header header; /* Type OFPT_VENDOR. */
896 uint32_t vendor; /* Vendor ID:
897 * - MSB 0: low-order bytes are IEEE OUI.
898 * - MSB != 0: defined by OpenFlow
900 /* Vendor-defined arbitrary additional data. */
902 OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12);
904 #endif /* openflow/openflow.h */