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. */
160 OFPC_ARP_MATCH_IP = 1 << 7 /* Match IP addresses in ARP
164 /* Flags to indicate behavior of the physical port. These flags are
165 * used in ofp_phy_port to describe the current configuration. They are
166 * used in the ofp_port_mod message to configure the port's behavior.
168 enum ofp_port_config {
169 OFPPC_PORT_DOWN = 1 << 0, /* Port is administratively down. */
171 OFPPC_NO_STP = 1 << 1, /* Disable 802.1D spanning tree on port. */
172 OFPPC_NO_RECV = 1 << 2, /* Drop all packets except 802.1D
173 spanning tree packets. */
174 OFPPC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */
175 OFPPC_NO_FLOOD = 1 << 4, /* Do not include this port when flooding. */
176 OFPPC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */
177 OFPPC_NO_PACKET_IN = 1 << 6 /* Do not send packet-in msgs for port. */
180 /* Current state of the physical port. These are not configurable from
183 enum ofp_port_state {
184 OFPPS_LINK_DOWN = 1 << 0, /* No physical link present. */
186 /* The OFPPS_STP_* bits have no effect on switch operation. The
187 * controller must adjust OFPPC_NO_RECV, OFPPC_NO_FWD, and
188 * OFPPC_NO_PACKET_IN appropriately to fully implement an 802.1D spanning
190 OFPPS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
191 OFPPS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
192 OFPPS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
193 OFPPS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
194 OFPPS_STP_MASK = 3 << 8 /* Bit mask for OFPPS_STP_* values. */
197 /* Features of physical ports available in a datapath. */
198 enum ofp_port_features {
199 OFPPF_10MB_HD = 1 << 0, /* 10 Mb half-duplex rate support. */
200 OFPPF_10MB_FD = 1 << 1, /* 10 Mb full-duplex rate support. */
201 OFPPF_100MB_HD = 1 << 2, /* 100 Mb half-duplex rate support. */
202 OFPPF_100MB_FD = 1 << 3, /* 100 Mb full-duplex rate support. */
203 OFPPF_1GB_HD = 1 << 4, /* 1 Gb half-duplex rate support. */
204 OFPPF_1GB_FD = 1 << 5, /* 1 Gb full-duplex rate support. */
205 OFPPF_10GB_FD = 1 << 6, /* 10 Gb full-duplex rate support. */
206 OFPPF_COPPER = 1 << 7, /* Copper medium. */
207 OFPPF_FIBER = 1 << 8, /* Fiber medium. */
208 OFPPF_AUTONEG = 1 << 9, /* Auto-negotiation. */
209 OFPPF_PAUSE = 1 << 10, /* Pause. */
210 OFPPF_PAUSE_ASYM = 1 << 11 /* Asymmetric pause. */
213 /* Description of a physical port */
214 struct ofp_phy_port {
216 uint8_t hw_addr[OFP_ETH_ALEN];
217 uint8_t name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
219 uint32_t config; /* Bitmap of OFPPC_* flags. */
220 uint32_t state; /* Bitmap of OFPPS_* flags. */
222 /* Bitmaps of OFPPF_* that describe features. All bits zeroed if
223 * unsupported or unavailable. */
224 uint32_t curr; /* Current features. */
225 uint32_t advertised; /* Features being advertised by the port. */
226 uint32_t supported; /* Features supported by the port. */
227 uint32_t peer; /* Features advertised by peer. */
229 OFP_ASSERT(sizeof(struct ofp_phy_port) == 48);
231 /* Switch features. */
232 struct ofp_switch_features {
233 struct ofp_header header;
234 uint64_t datapath_id; /* Datapath unique ID. The lower 48-bits are for
235 a MAC address, while the upper 16-bits are
236 implementer-defined. */
238 uint32_t n_buffers; /* Max packets buffered at once. */
240 uint8_t n_tables; /* Number of tables supported by datapath. */
241 uint8_t pad[3]; /* Align to 64-bits. */
244 uint32_t capabilities; /* Bitmap of support "ofp_capabilities". */
245 uint32_t actions; /* Bitmap of supported "ofp_action_type"s. */
248 struct ofp_phy_port ports[0]; /* Port definitions. The number of ports
249 is inferred from the length field in
252 OFP_ASSERT(sizeof(struct ofp_switch_features) == 32);
254 /* What changed about the physical port */
255 enum ofp_port_reason {
256 OFPPR_ADD, /* The port was added. */
257 OFPPR_DELETE, /* The port was removed. */
258 OFPPR_MODIFY /* Some attribute of the port has changed. */
261 /* A physical port has changed in the datapath */
262 struct ofp_port_status {
263 struct ofp_header header;
264 uint8_t reason; /* One of OFPPR_*. */
265 uint8_t pad[7]; /* Align to 64-bits. */
266 struct ofp_phy_port desc;
268 OFP_ASSERT(sizeof(struct ofp_port_status) == 64);
270 /* Modify behavior of the physical port */
271 struct ofp_port_mod {
272 struct ofp_header header;
274 uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
275 configurable. This is used to
276 sanity-check the request, so it must
277 be the same as returned in an
278 ofp_phy_port struct. */
280 uint32_t config; /* Bitmap of OFPPC_* flags. */
281 uint32_t mask; /* Bitmap of OFPPC_* flags to be changed. */
283 uint32_t advertise; /* Bitmap of "ofp_port_features"s. Zero all
284 bits to prevent any action taking place. */
285 uint8_t pad[4]; /* Pad to 64-bits. */
287 OFP_ASSERT(sizeof(struct ofp_port_mod) == 32);
289 /* Why is this packet being sent to the controller? */
290 enum ofp_packet_in_reason {
291 OFPR_NO_MATCH, /* No matching flow. */
292 OFPR_ACTION /* Action explicitly output to controller. */
295 /* Packet received on port (datapath -> controller). */
296 struct ofp_packet_in {
297 struct ofp_header header;
298 uint32_t buffer_id; /* ID assigned by datapath. */
299 uint16_t total_len; /* Full length of frame. */
300 uint16_t in_port; /* Port on which frame was received. */
301 uint8_t reason; /* Reason packet is being sent (one of OFPR_*) */
303 uint8_t data[0]; /* Ethernet frame, halfway through 32-bit word,
304 so the IP header is 32-bit aligned. The
305 amount of data is inferred from the length
306 field in the header. Because of padding,
307 offsetof(struct ofp_packet_in, data) ==
308 sizeof(struct ofp_packet_in) - 2. */
310 OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
312 enum ofp_action_type {
313 OFPAT_OUTPUT, /* Output to switch port. */
314 OFPAT_SET_VLAN_VID, /* Set the 802.1q VLAN id. */
315 OFPAT_SET_VLAN_PCP, /* Set the 802.1q priority. */
316 OFPAT_STRIP_VLAN, /* Strip the 802.1q header. */
317 OFPAT_SET_DL_SRC, /* Ethernet source address. */
318 OFPAT_SET_DL_DST, /* Ethernet destination address. */
319 OFPAT_SET_NW_SRC, /* IP source address. */
320 OFPAT_SET_NW_DST, /* IP destination address. */
321 OFPAT_SET_NW_TOS, /* IP ToS/DSCP field (6 bits). */
322 OFPAT_SET_TP_SRC, /* TCP/UDP source port. */
323 OFPAT_SET_TP_DST, /* TCP/UDP destination port. */
324 OFPAT_VENDOR = 0xffff
327 /* Action structure for OFPAT_OUTPUT, which sends packets out 'port'.
328 * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
329 * number of bytes to send. A 'max_len' of zero means no bytes of the
330 * packet should be sent. */
331 struct ofp_action_output {
332 uint16_t type; /* OFPAT_OUTPUT. */
333 uint16_t len; /* Length is 8. */
334 uint16_t port; /* Output port. */
335 uint16_t max_len; /* Max length to send to controller. */
337 OFP_ASSERT(sizeof(struct ofp_action_output) == 8);
339 /* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate
340 * special conditions. All ones is used to match that no VLAN id was
342 #define OFP_VLAN_NONE 0xffff
344 /* Action structure for OFPAT_SET_VLAN_VID. */
345 struct ofp_action_vlan_vid {
346 uint16_t type; /* OFPAT_SET_VLAN_VID. */
347 uint16_t len; /* Length is 8. */
348 uint16_t vlan_vid; /* VLAN id. */
351 OFP_ASSERT(sizeof(struct ofp_action_vlan_vid) == 8);
353 /* Action structure for OFPAT_SET_VLAN_PCP. */
354 struct ofp_action_vlan_pcp {
355 uint16_t type; /* OFPAT_SET_VLAN_PCP. */
356 uint16_t len; /* Length is 8. */
357 uint8_t vlan_pcp; /* VLAN priority. */
360 OFP_ASSERT(sizeof(struct ofp_action_vlan_pcp) == 8);
362 /* Action structure for OFPAT_SET_DL_SRC/DST. */
363 struct ofp_action_dl_addr {
364 uint16_t type; /* OFPAT_SET_DL_SRC/DST. */
365 uint16_t len; /* Length is 16. */
366 uint8_t dl_addr[OFP_ETH_ALEN]; /* Ethernet address. */
369 OFP_ASSERT(sizeof(struct ofp_action_dl_addr) == 16);
371 /* Action structure for OFPAT_SET_NW_SRC/DST. */
372 struct ofp_action_nw_addr {
373 uint16_t type; /* OFPAT_SET_TW_SRC/DST. */
374 uint16_t len; /* Length is 8. */
375 uint32_t nw_addr; /* IP address. */
377 OFP_ASSERT(sizeof(struct ofp_action_nw_addr) == 8);
379 /* Action structure for OFPAT_SET_NW_TOS. */
380 struct ofp_action_nw_tos {
381 uint16_t type; /* OFPAT_SET_TW_TOS. */
382 uint16_t len; /* Length is 8. */
383 uint8_t nw_tos; /* IP ToS/DSCP (6 bits). */
386 OFP_ASSERT(sizeof(struct ofp_action_nw_tos) == 8);
388 /* Action structure for OFPAT_SET_TP_SRC/DST. */
389 struct ofp_action_tp_port {
390 uint16_t type; /* OFPAT_SET_TP_SRC/DST. */
391 uint16_t len; /* Length is 8. */
392 uint16_t tp_port; /* TCP/UDP port. */
395 OFP_ASSERT(sizeof(struct ofp_action_tp_port) == 8);
397 /* Action header for OFPAT_VENDOR. The rest of the body is vendor-defined. */
398 struct ofp_action_vendor_header {
399 uint16_t type; /* OFPAT_VENDOR. */
400 uint16_t len; /* Length is a multiple of 8. */
401 uint32_t vendor; /* Vendor ID, which takes the same form
402 as in "struct ofp_vendor_header". */
404 OFP_ASSERT(sizeof(struct ofp_action_vendor_header) == 8);
406 /* Action header that is common to all actions. The length includes the
407 * header and any padding used to make the action 64-bit aligned.
408 * NB: The length of an action *must* always be a multiple of eight. */
409 struct ofp_action_header {
410 uint16_t type; /* One of OFPAT_*. */
411 uint16_t len; /* Length of action, including this
412 header. This is the length of action,
413 including any padding to make it
417 OFP_ASSERT(sizeof(struct ofp_action_header) == 8);
421 struct ofp_action_header header;
422 struct ofp_action_vendor_header vendor;
423 struct ofp_action_output output;
424 struct ofp_action_vlan_vid vlan_vid;
425 struct ofp_action_vlan_pcp vlan_pcp;
426 struct ofp_action_nw_addr nw_addr;
427 struct ofp_action_nw_tos nw_tos;
428 struct ofp_action_tp_port tp_port;
430 OFP_ASSERT(sizeof(union ofp_action) == 8);
432 /* Send packet (controller -> datapath). */
433 struct ofp_packet_out {
434 struct ofp_header header;
435 uint32_t buffer_id; /* ID assigned by datapath (-1 if none). */
436 uint16_t in_port; /* Packet's input port (OFPP_NONE if none). */
437 uint16_t actions_len; /* Size of action array in bytes. */
438 struct ofp_action_header actions[0]; /* Actions. */
439 /* uint8_t data[0]; */ /* Packet data. The length is inferred
440 from the length field in the header.
441 (Only meaningful if buffer_id == -1.) */
443 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
445 enum ofp_flow_mod_command {
446 OFPFC_ADD, /* New flow. */
447 OFPFC_MODIFY, /* Modify all matching flows. */
448 OFPFC_MODIFY_STRICT, /* Modify entry strictly matching wildcards */
449 OFPFC_DELETE, /* Delete all matching flows. */
450 OFPFC_DELETE_STRICT /* Strictly match wildcards and priority. */
453 /* Flow wildcards. */
454 enum ofp_flow_wildcards {
455 OFPFW_IN_PORT = 1 << 0, /* Switch input port. */
456 OFPFW_DL_VLAN = 1 << 1, /* VLAN vid. */
457 OFPFW_DL_SRC = 1 << 2, /* Ethernet source address. */
458 OFPFW_DL_DST = 1 << 3, /* Ethernet destination address. */
459 OFPFW_DL_TYPE = 1 << 4, /* Ethernet frame type. */
460 OFPFW_NW_PROTO = 1 << 5, /* IP protocol. */
461 OFPFW_TP_SRC = 1 << 6, /* TCP/UDP source port. */
462 OFPFW_TP_DST = 1 << 7, /* TCP/UDP destination port. */
464 /* IP source address wildcard bit count. 0 is exact match, 1 ignores the
465 * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
466 * the entire field. This is the *opposite* of the usual convention where
467 * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
468 OFPFW_NW_SRC_SHIFT = 8,
469 OFPFW_NW_SRC_BITS = 6,
470 OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
471 OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
473 /* IP destination address wildcard bit count. Same format as source. */
474 OFPFW_NW_DST_SHIFT = 14,
475 OFPFW_NW_DST_BITS = 6,
476 OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
477 OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
479 OFPFW_DL_VLAN_PCP = 1 << 20, /* VLAN priority. */
481 /* Wildcard all fields. */
482 OFPFW_ALL = ((1 << 21) - 1)
485 /* The wildcards for ICMP type and code fields use the transport source
486 * and destination port fields, respectively. */
487 #define OFPFW_ICMP_TYPE OFPFW_TP_SRC
488 #define OFPFW_ICMP_CODE OFPFW_TP_DST
490 /* Values below this cutoff are 802.3 packets and the two bytes
491 * following MAC addresses are used as a frame length. Otherwise, the
492 * two bytes are used as the Ethernet type.
494 #define OFP_DL_TYPE_ETH2_CUTOFF 0x0600
496 /* Value of dl_type to indicate that the frame does not include an
499 #define OFP_DL_TYPE_NOT_ETH_TYPE 0x05ff
501 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
502 * special conditions. All ones indicates that no VLAN id was set.
504 #define OFP_VLAN_NONE 0xffff
506 /* Fields to match against flows */
508 uint32_t wildcards; /* Wildcard fields. */
509 uint16_t in_port; /* Input switch port. */
510 uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
511 uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
512 uint16_t dl_vlan; /* Input VLAN. */
513 uint8_t dl_vlan_pcp; /* Input VLAN priority. */
514 uint8_t pad1[1]; /* Align to 64-bits. */
515 uint16_t dl_type; /* Ethernet frame type. */
516 uint8_t nw_proto; /* IP protocol or lower 8 bits of
518 uint8_t pad2[3]; /* Align to 64-bits. */
519 uint32_t nw_src; /* IP source address. */
520 uint32_t nw_dst; /* IP destination address. */
521 uint16_t tp_src; /* TCP/UDP source port. */
522 uint16_t tp_dst; /* TCP/UDP destination port. */
524 OFP_ASSERT(sizeof(struct ofp_match) == 40);
526 /* The match fields for ICMP type and code use the transport source and
527 * destination port fields, respectively. */
528 #define icmp_type tp_src
529 #define icmp_code tp_dst
531 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
533 #define OFP_FLOW_PERMANENT 0
535 /* By default, choose a priority in the middle. */
536 #define OFP_DEFAULT_PRIORITY 0x8000
538 enum ofp_flow_mod_flags {
539 OFPFF_SEND_FLOW_REM = 1 << 0, /* Send flow removed message when flow
540 * expires or is deleted. */
541 OFPFF_CHECK_OVERLAP = 1 << 1, /* Check for overlapping entries first. */
542 OFPFF_EMERG = 1 << 2 /* Ramark this is for emergency. */
545 /* Flow setup and teardown (controller -> datapath). */
546 struct ofp_flow_mod {
547 struct ofp_header header;
548 struct ofp_match match; /* Fields to match */
549 uint64_t cookie; /* Opaque controller-issued identifier. */
552 uint16_t command; /* One of OFPFC_*. */
553 uint16_t idle_timeout; /* Idle time before discarding (seconds). */
554 uint16_t hard_timeout; /* Max time before discarding (seconds). */
555 uint16_t priority; /* Priority level of flow entry. */
556 uint32_t buffer_id; /* Buffered packet to apply to (or -1).
557 Not meaningful for OFPFC_DELETE*. */
558 uint16_t out_port; /* For OFPFC_DELETE* commands, require
559 matching entries to include this as an
560 output port. A value of OFPP_NONE
561 indicates no restriction. */
562 uint16_t flags; /* One of OFPFF_*. */
563 struct ofp_action_header actions[0]; /* The action length is inferred
564 from the length field in the
567 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 72);
569 /* Why was this flow removed? */
570 enum ofp_flow_removed_reason {
571 OFPRR_IDLE_TIMEOUT, /* Flow idle time exceeded idle_timeout. */
572 OFPRR_HARD_TIMEOUT, /* Time exceeded hard_timeout. */
573 OFPRR_DELETE /* Evicted by a DELETE flow mod. */
576 /* Flow removed (datapath -> controller). */
577 struct ofp_flow_removed {
578 struct ofp_header header;
579 struct ofp_match match; /* Description of fields. */
580 uint64_t cookie; /* Opaque controller-issued identifier. */
582 uint16_t priority; /* Priority level of flow entry. */
583 uint8_t reason; /* One of OFPRR_*. */
584 uint8_t pad[1]; /* Align to 32-bits. */
586 uint32_t duration_sec; /* Time flow was alive in seconds. */
587 uint32_t duration_nsec; /* Time flow was alive in nanoseconds beyond
589 uint16_t idle_timeout; /* Idle timeout from original flow mod. */
590 uint8_t pad2[2]; /* Align to 64-bits. */
591 uint64_t packet_count;
594 OFP_ASSERT(sizeof(struct ofp_flow_removed) == 88);
596 /* Values for 'type' in ofp_error_message. These values are immutable: they
597 * will not change in future versions of the protocol (although new values may
599 enum ofp_error_type {
600 OFPET_HELLO_FAILED, /* Hello protocol failed. */
601 OFPET_BAD_REQUEST, /* Request was not understood. */
602 OFPET_BAD_ACTION, /* Error in action description. */
603 OFPET_FLOW_MOD_FAILED, /* Problem modifying flow entry. */
604 OFPET_PORT_MOD_FAILED /* OFPT_PORT_MOD failed. */
607 /* ofp_error_msg 'code' values for OFPET_HELLO_FAILED. 'data' contains an
608 * ASCII text string that may give failure details. */
609 enum ofp_hello_failed_code {
610 OFPHFC_INCOMPATIBLE, /* No compatible version. */
611 OFPHFC_EPERM /* Permissions error. */
614 /* ofp_error_msg 'code' values for OFPET_BAD_REQUEST. 'data' contains at least
615 * the first 64 bytes of the failed request. */
616 enum ofp_bad_request_code {
617 OFPBRC_BAD_VERSION, /* ofp_header.version not supported. */
618 OFPBRC_BAD_TYPE, /* ofp_header.type not supported. */
619 OFPBRC_BAD_STAT, /* ofp_stats_request.type not supported. */
620 OFPBRC_BAD_VENDOR, /* Vendor not supported (in ofp_vendor_header
621 * or ofp_stats_request or ofp_stats_reply). */
622 OFPBRC_BAD_SUBTYPE, /* Vendor subtype not supported. */
623 OFPBRC_EPERM, /* Permissions error. */
624 OFPBRC_BAD_LEN, /* Wrong request length for type. */
625 OFPBRC_BUFFER_EMPTY, /* Specified buffer has already been used. */
626 OFPBRC_BUFFER_UNKNOWN /* Specified buffer does not exist. */
629 /* ofp_error_msg 'code' values for OFPET_BAD_ACTION. 'data' contains at least
630 * the first 64 bytes of the failed request. */
631 enum ofp_bad_action_code {
632 OFPBAC_BAD_TYPE, /* Unknown action type. */
633 OFPBAC_BAD_LEN, /* Length problem in actions. */
634 OFPBAC_BAD_VENDOR, /* Unknown vendor id specified. */
635 OFPBAC_BAD_VENDOR_TYPE, /* Unknown action type for vendor id. */
636 OFPBAC_BAD_OUT_PORT, /* Problem validating output action. */
637 OFPBAC_BAD_ARGUMENT, /* Bad action argument. */
638 OFPBAC_EPERM, /* Permissions error. */
639 OFPBAC_TOO_MANY /* Can't handle this many actions. */
642 /* ofp_error_msg 'code' values for OFPET_FLOW_MOD_FAILED. 'data' contains
643 * at least the first 64 bytes of the failed request. */
644 enum ofp_flow_mod_failed_code {
645 OFPFMFC_ALL_TABLES_FULL, /* Flow not added because of full tables. */
646 OFPFMFC_OVERLAP, /* Attempted to add overlapping flow with
647 * CHECK_OVERLAP flag set. */
648 OFPFMFC_EPERM, /* Permissions error. */
649 OFPFMFC_BAD_EMERG_TIMEOUT, /* Flow not added because of non-zero idle/hard
651 OFPFMFC_BAD_COMMAND /* Unknown command. */
654 /* ofp_error_msg 'code' values for OFPET_PORT_MOD_FAILED. 'data' contains
655 * at least the first 64 bytes of the failed request. */
656 enum ofp_port_mod_failed_code {
657 OFPPMFC_BAD_PORT, /* Specified port does not exist. */
658 OFPPMFC_BAD_HW_ADDR, /* Specified hardware address is wrong. */
661 /* OFPT_ERROR: Error message (datapath -> controller). */
662 struct ofp_error_msg {
663 struct ofp_header header;
667 uint8_t data[0]; /* Variable-length data. Interpreted based
668 on the type and code. */
670 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
672 enum ofp_stats_types {
673 /* Description of this OpenFlow switch.
674 * The request body is empty.
675 * The reply body is struct ofp_desc_stats. */
678 /* Individual flow statistics.
679 * The request body is struct ofp_flow_stats_request.
680 * The reply body is an array of struct ofp_flow_stats. */
683 /* Aggregate flow statistics.
684 * The request body is struct ofp_aggregate_stats_request.
685 * The reply body is struct ofp_aggregate_stats_reply. */
688 /* Flow table statistics.
689 * The request body is empty.
690 * The reply body is an array of struct ofp_table_stats. */
693 /* Physical port statistics.
694 * The request body is empty.
695 * The reply body is an array of struct ofp_port_stats. */
699 * The request and reply bodies begin with a 32-bit vendor ID, which takes
700 * the same form as in "struct ofp_vendor_header". The request and reply
701 * bodies are otherwise vendor-defined. */
702 OFPST_VENDOR = 0xffff
705 struct ofp_stats_request {
706 struct ofp_header header;
707 uint16_t type; /* One of the OFPST_* constants. */
708 uint16_t flags; /* OFPSF_REQ_* flags (none yet defined). */
709 uint8_t body[0]; /* Body of the request. */
711 OFP_ASSERT(sizeof(struct ofp_stats_request) == 12);
713 enum ofp_stats_reply_flags {
714 OFPSF_REPLY_MORE = 1 << 0 /* More replies to follow. */
717 struct ofp_stats_reply {
718 struct ofp_header header;
719 uint16_t type; /* One of the OFPST_* constants. */
720 uint16_t flags; /* OFPSF_REPLY_* flags. */
721 uint8_t body[0]; /* Body of the reply. */
723 OFP_ASSERT(sizeof(struct ofp_stats_reply) == 12);
725 #define DESC_STR_LEN 256
726 #define SERIAL_NUM_LEN 32
727 /* Body of reply to OFPST_DESC request. Each entry is a NULL-terminated
729 struct ofp_desc_stats {
730 char mfr_desc[DESC_STR_LEN]; /* Manufacturer description. */
731 char hw_desc[DESC_STR_LEN]; /* Hardware description. */
732 char sw_desc[DESC_STR_LEN]; /* Software description. */
733 char serial_num[SERIAL_NUM_LEN]; /* Serial number. */
734 char dp_desc[DESC_STR_LEN]; /* Human readable description of
737 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 1056);
739 /* Body for ofp_stats_request of type OFPST_FLOW. */
740 struct ofp_flow_stats_request {
741 struct ofp_match match; /* Fields to match. */
742 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
743 or 0xff for all tables. */
744 uint8_t pad; /* Align to 32 bits. */
745 uint16_t out_port; /* Require matching entries to include this
746 as an output port. A value of OFPP_NONE
747 indicates no restriction. */
749 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 44);
751 /* Body of reply to OFPST_FLOW request. */
752 struct ofp_flow_stats {
753 uint16_t length; /* Length of this entry. */
754 uint8_t table_id; /* ID of table flow came from. */
756 struct ofp_match match; /* Description of fields. */
757 uint32_t duration_sec; /* Time flow has been alive in seconds. */
758 uint32_t duration_nsec; /* Time flow has been alive in nanoseconds
759 beyond duration_sec. */
760 uint16_t priority; /* Priority of the entry. Only meaningful
761 when this is not an exact-match entry. */
762 uint16_t idle_timeout; /* Number of seconds idle before expiration. */
763 uint16_t hard_timeout; /* Number of seconds before expiration. */
764 uint8_t pad2[6]; /* Align to 64 bits. */
765 uint64_t cookie; /* Opaque controller-issued identifier. */
766 uint64_t packet_count; /* Number of packets in flow. */
767 uint64_t byte_count; /* Number of bytes in flow. */
768 struct ofp_action_header actions[0]; /* Actions. */
770 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 88);
772 /* Body for ofp_stats_request of type OFPST_AGGREGATE. */
773 struct ofp_aggregate_stats_request {
774 struct ofp_match match; /* Fields to match. */
775 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
776 or 0xff for all tables. */
777 uint8_t pad; /* Align to 32 bits. */
778 uint16_t out_port; /* Require matching entries to include this
779 as an output port. A value of OFPP_NONE
780 indicates no restriction. */
782 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 44);
784 /* Body of reply to OFPST_AGGREGATE request. */
785 struct ofp_aggregate_stats_reply {
786 uint64_t packet_count; /* Number of packets in flows. */
787 uint64_t byte_count; /* Number of bytes in flows. */
788 uint32_t flow_count; /* Number of flows. */
789 uint8_t pad[4]; /* Align to 64 bits. */
791 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
793 /* Body of reply to OFPST_TABLE request. */
794 struct ofp_table_stats {
795 uint8_t table_id; /* Identifier of table. Lower numbered tables
796 are consulted first. */
797 uint8_t pad[3]; /* Align to 32-bits. */
798 char name[OFP_MAX_TABLE_NAME_LEN];
799 uint32_t wildcards; /* Bitmap of OFPFW_* wildcards that are
800 supported by the table. */
801 uint32_t max_entries; /* Max number of entries supported. */
802 uint32_t active_count; /* Number of active entries. */
803 uint64_t lookup_count; /* Number of packets looked up in table. */
804 uint64_t matched_count; /* Number of packets that hit table. */
806 OFP_ASSERT(sizeof(struct ofp_table_stats) == 64);
808 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
809 * the field to all ones. */
810 struct ofp_port_stats {
812 uint8_t pad[6]; /* Align to 64-bits. */
813 uint64_t rx_packets; /* Number of received packets. */
814 uint64_t tx_packets; /* Number of transmitted packets. */
815 uint64_t rx_bytes; /* Number of received bytes. */
816 uint64_t tx_bytes; /* Number of transmitted bytes. */
817 uint64_t rx_dropped; /* Number of packets dropped by RX. */
818 uint64_t tx_dropped; /* Number of packets dropped by TX. */
819 uint64_t rx_errors; /* Number of receive errors. This is a super-set
820 of receive errors and should be great than or
821 equal to the sum of all rx_*_err values. */
822 uint64_t tx_errors; /* Number of transmit errors. This is a super-set
823 of transmit errors. */
824 uint64_t rx_frame_err; /* Number of frame alignment errors. */
825 uint64_t rx_over_err; /* Number of packets with RX overrun. */
826 uint64_t rx_crc_err; /* Number of CRC errors. */
827 uint64_t collisions; /* Number of collisions. */
829 OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
831 /* Vendor extension. */
832 struct ofp_vendor_header {
833 struct ofp_header header; /* Type OFPT_VENDOR. */
834 uint32_t vendor; /* Vendor ID:
835 * - MSB 0: low-order bytes are IEEE OUI.
836 * - MSB != 0: defined by OpenFlow
838 /* Vendor-defined arbitrary additional data. */
840 OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12);
842 #endif /* openflow/openflow.h */