2 * Copyright (c) 2008, 2009, 2010, 2011 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
22 #include "openvswitch/types.h"
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
44 #define OFP10_VERSION 0x01
46 #define OFP_MAX_TABLE_NAME_LEN 32
47 #define OFP_MAX_PORT_NAME_LEN 16
49 #define OFP_TCP_PORT 6633
50 #define OFP_SSL_PORT 6633
52 #define OFP_ETH_ALEN 6 /* Bytes in an Ethernet address. */
54 /* Port numbering. Physical ports are numbered starting from 1. */
56 /* Maximum number of physical switch ports. */
59 /* Fake output "ports". */
60 OFPP_IN_PORT = 0xfff8, /* Send the packet out the input port. This
61 virtual port must be explicitly used
62 in order to send back out of the input
64 OFPP_TABLE = 0xfff9, /* Perform actions in flow table.
65 NB: This can only be the destination
66 port for packet-out messages. */
67 OFPP_NORMAL = 0xfffa, /* Process with normal L2/L3 switching. */
68 OFPP_FLOOD = 0xfffb, /* All physical ports except input port and
69 those disabled by STP. */
70 OFPP_ALL = 0xfffc, /* All physical ports except input port. */
71 OFPP_CONTROLLER = 0xfffd, /* Send to controller. */
72 OFPP_LOCAL = 0xfffe, /* Local openflow "port". */
73 OFPP_NONE = 0xffff /* Not associated with a physical port. */
77 /* Immutable messages. */
78 OFPT_HELLO, /* Symmetric message */
79 OFPT_ERROR, /* Symmetric message */
80 OFPT_ECHO_REQUEST, /* Symmetric message */
81 OFPT_ECHO_REPLY, /* Symmetric message */
82 OFPT_VENDOR, /* Symmetric message */
84 /* Switch configuration messages. */
85 OFPT_FEATURES_REQUEST, /* Controller/switch message */
86 OFPT_FEATURES_REPLY, /* Controller/switch message */
87 OFPT_GET_CONFIG_REQUEST, /* Controller/switch message */
88 OFPT_GET_CONFIG_REPLY, /* Controller/switch message */
89 OFPT_SET_CONFIG, /* Controller/switch message */
91 /* Asynchronous messages. */
92 OFPT_PACKET_IN, /* Async message */
93 OFPT_FLOW_REMOVED, /* Async message */
94 OFPT_PORT_STATUS, /* Async message */
96 /* Controller command messages. */
97 OFPT_PACKET_OUT, /* Controller/switch message */
98 OFPT_FLOW_MOD, /* Controller/switch message */
99 OFPT_PORT_MOD, /* Controller/switch message */
101 /* Statistics messages. */
102 OFPT_STATS_REQUEST, /* Controller/switch message */
103 OFPT_STATS_REPLY, /* Controller/switch message */
105 /* Barrier messages. */
106 OFPT_BARRIER_REQUEST, /* Controller/switch message */
107 OFPT_BARRIER_REPLY, /* Controller/switch message */
109 /* Queue Configuration messages. */
110 OFPT_QUEUE_GET_CONFIG_REQUEST, /* Controller/switch message */
111 OFPT_QUEUE_GET_CONFIG_REPLY /* Controller/switch message */
114 /* Header on all OpenFlow packets. */
116 uint8_t version; /* OFP_VERSION. */
117 uint8_t type; /* One of the OFPT_ constants. */
118 ovs_be16 length; /* Length including this ofp_header. */
119 ovs_be32 xid; /* Transaction id associated with this packet.
120 Replies use the same id as was in the request
121 to facilitate pairing. */
123 OFP_ASSERT(sizeof(struct ofp_header) == 8);
125 /* OFPT_HELLO. This message has an empty body, but implementations must
126 * ignore any data included in the body, to allow for future extensions. */
128 struct ofp_header header;
131 #define OFP_DEFAULT_MISS_SEND_LEN 128
133 enum ofp_config_flags {
134 /* Handling of IP fragments. */
135 OFPC_FRAG_NORMAL = 0, /* No special handling for fragments. */
136 OFPC_FRAG_DROP = 1, /* Drop fragments. */
137 OFPC_FRAG_REASM = 2, /* Reassemble (only if OFPC_IP_REASM set). */
138 OFPC_FRAG_NX_MATCH = 3, /* Make first fragments available for matching. */
142 /* Switch configuration. */
143 struct ofp_switch_config {
144 struct ofp_header header;
145 ovs_be16 flags; /* OFPC_* flags. */
146 ovs_be16 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_RESERVED = 1 << 4, /* Reserved, must not be set. */
158 OFPC_IP_REASM = 1 << 5, /* Can reassemble IP fragments. */
159 OFPC_QUEUE_STATS = 1 << 6, /* Queue statistics. */
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 char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
219 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
220 ovs_be32 state; /* Bitmap of OFPPS_* flags. */
222 /* Bitmaps of OFPPF_* that describe features. All bits zeroed if
223 * unsupported or unavailable. */
224 ovs_be32 curr; /* Current features. */
225 ovs_be32 advertised; /* Features being advertised by the port. */
226 ovs_be32 supported; /* Features supported by the port. */
227 ovs_be32 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 ovs_be64 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 ovs_be32 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 ovs_be32 capabilities; /* Bitmap of support "ofp_capabilities". */
245 ovs_be32 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 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
281 ovs_be32 mask; /* Bitmap of OFPPC_* flags to be changed. */
283 ovs_be32 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 ovs_be32 buffer_id; /* ID assigned by datapath. */
299 ovs_be16 total_len; /* Full length of frame. */
300 ovs_be16 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_ENQUEUE, /* Output to queue. */
325 OFPAT_VENDOR = 0xffff
328 /* Action structure for OFPAT_OUTPUT, which sends packets out 'port'.
329 * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
330 * number of bytes to send. A 'max_len' of zero means no bytes of the
331 * packet should be sent. */
332 struct ofp_action_output {
333 ovs_be16 type; /* OFPAT_OUTPUT. */
334 ovs_be16 len; /* Length is 8. */
335 ovs_be16 port; /* Output port. */
336 ovs_be16 max_len; /* Max length to send to controller. */
338 OFP_ASSERT(sizeof(struct ofp_action_output) == 8);
340 /* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate
341 * special conditions. All ones is used to match that no VLAN id was
343 #define OFP_VLAN_NONE 0xffff
345 /* Action structure for OFPAT_SET_VLAN_VID. */
346 struct ofp_action_vlan_vid {
347 ovs_be16 type; /* OFPAT_SET_VLAN_VID. */
348 ovs_be16 len; /* Length is 8. */
349 ovs_be16 vlan_vid; /* VLAN id. */
352 OFP_ASSERT(sizeof(struct ofp_action_vlan_vid) == 8);
354 /* Action structure for OFPAT_SET_VLAN_PCP. */
355 struct ofp_action_vlan_pcp {
356 ovs_be16 type; /* OFPAT_SET_VLAN_PCP. */
357 ovs_be16 len; /* Length is 8. */
358 uint8_t vlan_pcp; /* VLAN priority. */
361 OFP_ASSERT(sizeof(struct ofp_action_vlan_pcp) == 8);
363 /* Action structure for OFPAT_SET_DL_SRC/DST. */
364 struct ofp_action_dl_addr {
365 ovs_be16 type; /* OFPAT_SET_DL_SRC/DST. */
366 ovs_be16 len; /* Length is 16. */
367 uint8_t dl_addr[OFP_ETH_ALEN]; /* Ethernet address. */
370 OFP_ASSERT(sizeof(struct ofp_action_dl_addr) == 16);
372 /* Action structure for OFPAT_SET_NW_SRC/DST. */
373 struct ofp_action_nw_addr {
374 ovs_be16 type; /* OFPAT_SET_TW_SRC/DST. */
375 ovs_be16 len; /* Length is 8. */
376 ovs_be32 nw_addr; /* IP address. */
378 OFP_ASSERT(sizeof(struct ofp_action_nw_addr) == 8);
380 /* Action structure for OFPAT_SET_NW_TOS. */
381 struct ofp_action_nw_tos {
382 ovs_be16 type; /* OFPAT_SET_TW_TOS. */
383 ovs_be16 len; /* Length is 8. */
384 uint8_t nw_tos; /* IP TOS (DSCP field, 6 bits). */
387 OFP_ASSERT(sizeof(struct ofp_action_nw_tos) == 8);
389 /* Action structure for OFPAT_SET_TP_SRC/DST. */
390 struct ofp_action_tp_port {
391 ovs_be16 type; /* OFPAT_SET_TP_SRC/DST. */
392 ovs_be16 len; /* Length is 8. */
393 ovs_be16 tp_port; /* TCP/UDP port. */
396 OFP_ASSERT(sizeof(struct ofp_action_tp_port) == 8);
398 /* Action header for OFPAT_VENDOR. The rest of the body is vendor-defined. */
399 struct ofp_action_vendor_header {
400 ovs_be16 type; /* OFPAT_VENDOR. */
401 ovs_be16 len; /* Length is a multiple of 8. */
402 ovs_be32 vendor; /* Vendor ID, which takes the same form
403 as in "struct ofp_vendor_header". */
405 OFP_ASSERT(sizeof(struct ofp_action_vendor_header) == 8);
407 /* Action header that is common to all actions. The length includes the
408 * header and any padding used to make the action 64-bit aligned.
409 * NB: The length of an action *must* always be a multiple of eight. */
410 struct ofp_action_header {
411 ovs_be16 type; /* One of OFPAT_*. */
412 ovs_be16 len; /* Length of action, including this
413 header. This is the length of action,
414 including any padding to make it
418 OFP_ASSERT(sizeof(struct ofp_action_header) == 8);
420 /* OFPAT_ENQUEUE action struct: send packets to given queue on port. */
421 struct ofp_action_enqueue {
422 ovs_be16 type; /* OFPAT_ENQUEUE. */
423 ovs_be16 len; /* Len is 16. */
424 ovs_be16 port; /* Port that queue belongs. Should
425 refer to a valid physical port
426 (i.e. < OFPP_MAX) or OFPP_IN_PORT. */
427 uint8_t pad[6]; /* Pad for 64-bit alignment. */
428 ovs_be32 queue_id; /* Where to enqueue the packets. */
430 OFP_ASSERT(sizeof(struct ofp_action_enqueue) == 16);
434 struct ofp_action_header header;
435 struct ofp_action_vendor_header vendor;
436 struct ofp_action_output output;
437 struct ofp_action_vlan_vid vlan_vid;
438 struct ofp_action_vlan_pcp vlan_pcp;
439 struct ofp_action_nw_addr nw_addr;
440 struct ofp_action_nw_tos nw_tos;
441 struct ofp_action_tp_port tp_port;
443 OFP_ASSERT(sizeof(union ofp_action) == 8);
445 /* Send packet (controller -> datapath). */
446 struct ofp_packet_out {
447 struct ofp_header header;
448 ovs_be32 buffer_id; /* ID assigned by datapath (-1 if none). */
449 ovs_be16 in_port; /* Packet's input port (OFPP_NONE if none). */
450 ovs_be16 actions_len; /* Size of action array in bytes. */
451 struct ofp_action_header actions[0]; /* Actions. */
452 /* uint8_t data[0]; */ /* Packet data. The length is inferred
453 from the length field in the header.
454 (Only meaningful if buffer_id == -1.) */
456 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
458 enum ofp_flow_mod_command {
459 OFPFC_ADD, /* New flow. */
460 OFPFC_MODIFY, /* Modify all matching flows. */
461 OFPFC_MODIFY_STRICT, /* Modify entry strictly matching wildcards */
462 OFPFC_DELETE, /* Delete all matching flows. */
463 OFPFC_DELETE_STRICT /* Strictly match wildcards and priority. */
466 /* Flow wildcards. */
467 enum ofp_flow_wildcards {
468 OFPFW_IN_PORT = 1 << 0, /* Switch input port. */
469 OFPFW_DL_VLAN = 1 << 1, /* VLAN vid. */
470 OFPFW_DL_SRC = 1 << 2, /* Ethernet source address. */
471 OFPFW_DL_DST = 1 << 3, /* Ethernet destination address. */
472 OFPFW_DL_TYPE = 1 << 4, /* Ethernet frame type. */
473 OFPFW_NW_PROTO = 1 << 5, /* IP protocol. */
474 OFPFW_TP_SRC = 1 << 6, /* TCP/UDP source port. */
475 OFPFW_TP_DST = 1 << 7, /* TCP/UDP destination port. */
477 /* IP source address wildcard bit count. 0 is exact match, 1 ignores the
478 * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
479 * the entire field. This is the *opposite* of the usual convention where
480 * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
481 OFPFW_NW_SRC_SHIFT = 8,
482 OFPFW_NW_SRC_BITS = 6,
483 OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
484 OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
486 /* IP destination address wildcard bit count. Same format as source. */
487 OFPFW_NW_DST_SHIFT = 14,
488 OFPFW_NW_DST_BITS = 6,
489 OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
490 OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
492 OFPFW_DL_VLAN_PCP = 1 << 20, /* VLAN priority. */
493 OFPFW_NW_TOS = 1 << 21, /* IP ToS (DSCP field, 6 bits). */
495 /* Wildcard all fields. */
496 OFPFW_ALL = ((1 << 22) - 1)
499 /* The wildcards for ICMP type and code fields use the transport source
500 * and destination port fields, respectively. */
501 #define OFPFW_ICMP_TYPE OFPFW_TP_SRC
502 #define OFPFW_ICMP_CODE OFPFW_TP_DST
504 /* Values below this cutoff are 802.3 packets and the two bytes
505 * following MAC addresses are used as a frame length. Otherwise, the
506 * two bytes are used as the Ethernet type.
508 #define OFP_DL_TYPE_ETH2_CUTOFF 0x0600
510 /* Value of dl_type to indicate that the frame does not include an
513 #define OFP_DL_TYPE_NOT_ETH_TYPE 0x05ff
515 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
516 * special conditions. All ones indicates that no VLAN id was set.
518 #define OFP_VLAN_NONE 0xffff
520 /* Fields to match against flows */
522 ovs_be32 wildcards; /* Wildcard fields. */
523 ovs_be16 in_port; /* Input switch port. */
524 uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
525 uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
526 ovs_be16 dl_vlan; /* Input VLAN. */
527 uint8_t dl_vlan_pcp; /* Input VLAN priority. */
528 uint8_t pad1[1]; /* Align to 64-bits. */
529 ovs_be16 dl_type; /* Ethernet frame type. */
530 uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */
531 uint8_t nw_proto; /* IP protocol or lower 8 bits of
533 uint8_t pad2[2]; /* Align to 64-bits. */
534 ovs_be32 nw_src; /* IP source address. */
535 ovs_be32 nw_dst; /* IP destination address. */
536 ovs_be16 tp_src; /* TCP/UDP source port. */
537 ovs_be16 tp_dst; /* TCP/UDP destination port. */
539 OFP_ASSERT(sizeof(struct ofp_match) == 40);
541 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
543 #define OFP_FLOW_PERMANENT 0
545 /* By default, choose a priority in the middle. */
546 #define OFP_DEFAULT_PRIORITY 0x8000
548 enum ofp_flow_mod_flags {
549 OFPFF_SEND_FLOW_REM = 1 << 0, /* Send flow removed message when flow
550 * expires or is deleted. */
551 OFPFF_CHECK_OVERLAP = 1 << 1, /* Check for overlapping entries first. */
552 OFPFF_EMERG = 1 << 2 /* Ramark this is for emergency. */
555 /* Flow setup and teardown (controller -> datapath). */
556 struct ofp_flow_mod {
557 struct ofp_header header;
558 struct ofp_match match; /* Fields to match */
559 ovs_be64 cookie; /* Opaque controller-issued identifier. */
562 ovs_be16 command; /* One of OFPFC_*. */
563 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
564 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
565 ovs_be16 priority; /* Priority level of flow entry. */
566 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
567 Not meaningful for OFPFC_DELETE*. */
568 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
569 matching entries to include this as an
570 output port. A value of OFPP_NONE
571 indicates no restriction. */
572 ovs_be16 flags; /* One of OFPFF_*. */
573 struct ofp_action_header actions[0]; /* The action length is inferred
574 from the length field in the
577 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 72);
579 /* Why was this flow removed? */
580 enum ofp_flow_removed_reason {
581 OFPRR_IDLE_TIMEOUT, /* Flow idle time exceeded idle_timeout. */
582 OFPRR_HARD_TIMEOUT, /* Time exceeded hard_timeout. */
583 OFPRR_DELETE /* Evicted by a DELETE flow mod. */
586 /* Flow removed (datapath -> controller). */
587 struct ofp_flow_removed {
588 struct ofp_header header;
589 struct ofp_match match; /* Description of fields. */
590 ovs_be64 cookie; /* Opaque controller-issued identifier. */
592 ovs_be16 priority; /* Priority level of flow entry. */
593 uint8_t reason; /* One of OFPRR_*. */
594 uint8_t pad[1]; /* Align to 32-bits. */
596 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
597 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
599 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
600 uint8_t pad2[2]; /* Align to 64-bits. */
601 ovs_be64 packet_count;
604 OFP_ASSERT(sizeof(struct ofp_flow_removed) == 88);
606 /* Values for 'type' in ofp_error_message. These values are immutable: they
607 * will not change in future versions of the protocol (although new values may
609 enum ofp_error_type {
610 OFPET_HELLO_FAILED, /* Hello protocol failed. */
611 OFPET_BAD_REQUEST, /* Request was not understood. */
612 OFPET_BAD_ACTION, /* Error in action description. */
613 OFPET_FLOW_MOD_FAILED, /* Problem modifying flow entry. */
614 OFPET_PORT_MOD_FAILED, /* OFPT_PORT_MOD failed. */
615 OFPET_QUEUE_OP_FAILED /* Queue operation failed. */
618 /* ofp_error_msg 'code' values for OFPET_HELLO_FAILED. 'data' contains an
619 * ASCII text string that may give failure details. */
620 enum ofp_hello_failed_code {
621 OFPHFC_INCOMPATIBLE, /* No compatible version. */
622 OFPHFC_EPERM /* Permissions error. */
625 /* ofp_error_msg 'code' values for OFPET_BAD_REQUEST. 'data' contains at least
626 * the first 64 bytes of the failed request. */
627 enum ofp_bad_request_code {
628 OFPBRC_BAD_VERSION, /* ofp_header.version not supported. */
629 OFPBRC_BAD_TYPE, /* ofp_header.type not supported. */
630 OFPBRC_BAD_STAT, /* ofp_stats_msg.type not supported. */
631 OFPBRC_BAD_VENDOR, /* Vendor not supported (in ofp_vendor_header
632 * or ofp_stats_msg). */
633 OFPBRC_BAD_SUBTYPE, /* Vendor subtype not supported. */
634 OFPBRC_EPERM, /* Permissions error. */
635 OFPBRC_BAD_LEN, /* Wrong request length for type. */
636 OFPBRC_BUFFER_EMPTY, /* Specified buffer has already been used. */
637 OFPBRC_BUFFER_UNKNOWN /* Specified buffer does not exist. */
640 /* ofp_error_msg 'code' values for OFPET_BAD_ACTION. 'data' contains at least
641 * the first 64 bytes of the failed request. */
642 enum ofp_bad_action_code {
643 OFPBAC_BAD_TYPE, /* Unknown action type. */
644 OFPBAC_BAD_LEN, /* Length problem in actions. */
645 OFPBAC_BAD_VENDOR, /* Unknown vendor id specified. */
646 OFPBAC_BAD_VENDOR_TYPE, /* Unknown action type for vendor id. */
647 OFPBAC_BAD_OUT_PORT, /* Problem validating output action. */
648 OFPBAC_BAD_ARGUMENT, /* Bad action argument. */
649 OFPBAC_EPERM, /* Permissions error. */
650 OFPBAC_TOO_MANY, /* Can't handle this many actions. */
651 OFPBAC_BAD_QUEUE /* Problem validating output queue. */
654 /* ofp_error_msg 'code' values for OFPET_FLOW_MOD_FAILED. 'data' contains
655 * at least the first 64 bytes of the failed request. */
656 enum ofp_flow_mod_failed_code {
657 OFPFMFC_ALL_TABLES_FULL, /* Flow not added because of full tables. */
658 OFPFMFC_OVERLAP, /* Attempted to add overlapping flow with
659 * CHECK_OVERLAP flag set. */
660 OFPFMFC_EPERM, /* Permissions error. */
661 OFPFMFC_BAD_EMERG_TIMEOUT, /* Flow not added because of non-zero idle/hard
663 OFPFMFC_BAD_COMMAND, /* Unknown command. */
664 OFPFMFC_UNSUPPORTED /* Unsupported action list - cannot process in
665 the order specified. */
668 /* ofp_error_msg 'code' values for OFPET_PORT_MOD_FAILED. 'data' contains
669 * at least the first 64 bytes of the failed request. */
670 enum ofp_port_mod_failed_code {
671 OFPPMFC_BAD_PORT, /* Specified port does not exist. */
672 OFPPMFC_BAD_HW_ADDR, /* Specified hardware address is wrong. */
675 /* ofp_error msg 'code' values for OFPET_QUEUE_OP_FAILED. 'data' contains
676 * at least the first 64 bytes of the failed request */
677 enum ofp_queue_op_failed_code {
678 OFPQOFC_BAD_PORT, /* Invalid port (or port does not exist). */
679 OFPQOFC_BAD_QUEUE, /* Queue does not exist. */
680 OFPQOFC_EPERM /* Permissions error. */
683 /* OFPT_ERROR: Error message (datapath -> controller). */
684 struct ofp_error_msg {
685 struct ofp_header header;
689 uint8_t data[0]; /* Variable-length data. Interpreted based
690 on the type and code. */
692 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
694 enum ofp_stats_types {
695 /* Description of this OpenFlow switch.
696 * The request is struct ofp_stats_msg.
697 * The reply is struct ofp_desc_stats. */
700 /* Individual flow statistics.
701 * The request is struct ofp_flow_stats_request.
702 * The reply body is an array of struct ofp_flow_stats. */
705 /* Aggregate flow statistics.
706 * The request is struct ofp_flow_stats_request.
707 * The reply is struct ofp_aggregate_stats_reply. */
710 /* Flow table statistics.
711 * The request is struct ofp_stats_msg.
712 * The reply body is an array of struct ofp_table_stats. */
715 /* Physical port statistics.
716 * The request is struct ofp_port_stats_request.
717 * The reply body is an array of struct ofp_port_stats. */
720 /* Queue statistics for a port.
721 * The request body is struct ofp_queue_stats_request.
722 * The reply body is an array of struct ofp_queue_stats. */
726 * The request and reply begin with "struct ofp_vendor_stats". */
727 OFPST_VENDOR = 0xffff
730 /* Statistics request or reply message. */
731 struct ofp_stats_msg {
732 struct ofp_header header;
733 ovs_be16 type; /* One of the OFPST_* constants. */
734 ovs_be16 flags; /* Requests: always 0.
735 * Replies: 0 or OFPSF_REPLY_MORE. */
737 OFP_ASSERT(sizeof(struct ofp_stats_msg) == 12);
739 enum ofp_stats_reply_flags {
740 OFPSF_REPLY_MORE = 1 << 0 /* More replies to follow. */
743 #define DESC_STR_LEN 256
744 #define SERIAL_NUM_LEN 32
745 /* Reply to OFPST_DESC request. Each entry is a NULL-terminated ASCII
747 struct ofp_desc_stats {
748 struct ofp_stats_msg osm;
749 char mfr_desc[DESC_STR_LEN]; /* Manufacturer description. */
750 char hw_desc[DESC_STR_LEN]; /* Hardware description. */
751 char sw_desc[DESC_STR_LEN]; /* Software description. */
752 char serial_num[SERIAL_NUM_LEN]; /* Serial number. */
753 char dp_desc[DESC_STR_LEN]; /* Human readable description of
756 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 1068);
758 /* Stats request of type OFPST_AGGREGATE or OFPST_FLOW. */
759 struct ofp_flow_stats_request {
760 struct ofp_stats_msg osm;
761 struct ofp_match match; /* Fields to match. */
762 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
763 or 0xff for all tables. */
764 uint8_t pad; /* Align to 32 bits. */
765 ovs_be16 out_port; /* Require matching entries to include this
766 as an output port. A value of OFPP_NONE
767 indicates no restriction. */
769 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 56);
771 /* Body of reply to OFPST_FLOW request. */
772 struct ofp_flow_stats {
773 ovs_be16 length; /* Length of this entry. */
774 uint8_t table_id; /* ID of table flow came from. */
776 struct ofp_match match; /* Description of fields. */
777 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
778 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
779 beyond duration_sec. */
780 ovs_be16 priority; /* Priority of the entry. Only meaningful
781 when this is not an exact-match entry. */
782 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
783 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
784 uint8_t pad2[6]; /* Align to 64 bits. */
785 ovs_32aligned_be64 cookie; /* Opaque controller-issued identifier. */
786 ovs_32aligned_be64 packet_count; /* Number of packets in flow. */
787 ovs_32aligned_be64 byte_count; /* Number of bytes in flow. */
788 struct ofp_action_header actions[0]; /* Actions. */
790 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 88);
792 /* Reply to OFPST_AGGREGATE request. */
793 struct ofp_aggregate_stats_reply {
794 struct ofp_stats_msg osm;
795 ovs_32aligned_be64 packet_count; /* Number of packets in flows. */
796 ovs_32aligned_be64 byte_count; /* Number of bytes in flows. */
797 ovs_be32 flow_count; /* Number of flows. */
798 uint8_t pad[4]; /* Align to 64 bits. */
800 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 36);
802 /* Body of reply to OFPST_TABLE request. */
803 struct ofp_table_stats {
804 uint8_t table_id; /* Identifier of table. Lower numbered tables
805 are consulted first. */
806 uint8_t pad[3]; /* Align to 32-bits. */
807 char name[OFP_MAX_TABLE_NAME_LEN];
808 ovs_be32 wildcards; /* Bitmap of OFPFW_* wildcards that are
809 supported by the table. */
810 ovs_be32 max_entries; /* Max number of entries supported. */
811 ovs_be32 active_count; /* Number of active entries. */
812 ovs_32aligned_be64 lookup_count; /* # of packets looked up in table. */
813 ovs_32aligned_be64 matched_count; /* Number of packets that hit table. */
815 OFP_ASSERT(sizeof(struct ofp_table_stats) == 64);
817 /* Stats request of type OFPST_PORT. */
818 struct ofp_port_stats_request {
819 struct ofp_stats_msg osm;
820 ovs_be16 port_no; /* OFPST_PORT message may request statistics
821 for a single port (specified with port_no)
822 or for all ports (port_no == OFPP_NONE). */
825 OFP_ASSERT(sizeof(struct ofp_port_stats_request) == 20);
827 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
828 * the field to all ones. */
829 struct ofp_port_stats {
831 uint8_t pad[6]; /* Align to 64-bits. */
832 ovs_32aligned_be64 rx_packets; /* Number of received packets. */
833 ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */
834 ovs_32aligned_be64 rx_bytes; /* Number of received bytes. */
835 ovs_32aligned_be64 tx_bytes; /* Number of transmitted bytes. */
836 ovs_32aligned_be64 rx_dropped; /* Number of packets dropped by RX. */
837 ovs_32aligned_be64 tx_dropped; /* Number of packets dropped by TX. */
838 ovs_32aligned_be64 rx_errors; /* Number of receive errors. This is a
839 super-set of receive errors and should be
840 great than or equal to the sum of all
842 ovs_32aligned_be64 tx_errors; /* Number of transmit errors. This is a
843 super-set of transmit errors. */
844 ovs_32aligned_be64 rx_frame_err; /* Number of frame alignment errors. */
845 ovs_32aligned_be64 rx_over_err; /* Number of packets with RX overrun. */
846 ovs_32aligned_be64 rx_crc_err; /* Number of CRC errors. */
847 ovs_32aligned_be64 collisions; /* Number of collisions. */
849 OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
851 /* All ones is used to indicate all queues in a port (for stats retrieval). */
852 #define OFPQ_ALL 0xffffffff
854 /* Body for stats request of type OFPST_QUEUE. */
855 struct ofp_queue_stats_request {
856 struct ofp_stats_msg osm;
857 ovs_be16 port_no; /* All ports if OFPP_ALL. */
858 uint8_t pad[2]; /* Align to 32-bits. */
859 ovs_be32 queue_id; /* All queues if OFPQ_ALL. */
861 OFP_ASSERT(sizeof(struct ofp_queue_stats_request) == 20);
863 /* Body for stats reply of type OFPST_QUEUE consists of an array of this
865 struct ofp_queue_stats {
867 uint8_t pad[2]; /* Align to 32-bits. */
868 ovs_be32 queue_id; /* Queue id. */
869 ovs_32aligned_be64 tx_bytes; /* Number of transmitted bytes. */
870 ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */
871 ovs_32aligned_be64 tx_errors; /* # of packets dropped due to overrun. */
873 OFP_ASSERT(sizeof(struct ofp_queue_stats) == 32);
875 /* Vendor extension stats message. */
876 struct ofp_vendor_stats_msg {
877 struct ofp_stats_msg osm; /* Type OFPST_VENDOR. */
878 ovs_be32 vendor; /* Vendor ID:
879 * - MSB 0: low-order bytes are IEEE OUI.
880 * - MSB != 0: defined by OpenFlow
882 /* Followed by vendor-defined arbitrary additional data. */
884 OFP_ASSERT(sizeof(struct ofp_vendor_stats_msg) == 16);
886 /* Vendor extension. */
887 struct ofp_vendor_header {
888 struct ofp_header header; /* Type OFPT_VENDOR. */
889 ovs_be32 vendor; /* Vendor ID:
890 * - MSB 0: low-order bytes are IEEE OUI.
891 * - MSB != 0: defined by OpenFlow
893 /* Vendor-defined arbitrary additional data. */
895 OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12);
897 #endif /* openflow/openflow.h */