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
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 ovs_be16 length; /* Length including this ofp_header. */
118 ovs_be32 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). */
137 OFPC_FRAG_NX_MATCH = 3, /* Make first fragments available for matching. */
141 /* Switch configuration. */
142 struct ofp_switch_config {
143 struct ofp_header header;
144 ovs_be16 flags; /* OFPC_* flags. */
145 ovs_be16 miss_send_len; /* Max bytes of new flow that datapath should
146 send to the controller. */
148 OFP_ASSERT(sizeof(struct ofp_switch_config) == 12);
150 /* Capabilities supported by the datapath. */
151 enum ofp_capabilities {
152 OFPC_FLOW_STATS = 1 << 0, /* Flow statistics. */
153 OFPC_TABLE_STATS = 1 << 1, /* Table statistics. */
154 OFPC_PORT_STATS = 1 << 2, /* Port statistics. */
155 OFPC_STP = 1 << 3, /* 802.1d spanning tree. */
156 OFPC_RESERVED = 1 << 4, /* Reserved, must not be set. */
157 OFPC_IP_REASM = 1 << 5, /* Can reassemble IP fragments. */
158 OFPC_QUEUE_STATS = 1 << 6, /* Queue statistics. */
159 OFPC_ARP_MATCH_IP = 1 << 7 /* Match IP addresses in ARP
163 /* Flags to indicate behavior of the physical port. These flags are
164 * used in ofp_phy_port to describe the current configuration. They are
165 * used in the ofp_port_mod message to configure the port's behavior.
167 enum ofp_port_config {
168 OFPPC_PORT_DOWN = 1 << 0, /* Port is administratively down. */
170 OFPPC_NO_STP = 1 << 1, /* Disable 802.1D spanning tree on port. */
171 OFPPC_NO_RECV = 1 << 2, /* Drop all packets except 802.1D
172 spanning tree packets. */
173 OFPPC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */
174 OFPPC_NO_FLOOD = 1 << 4, /* Do not include this port when flooding. */
175 OFPPC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */
176 OFPPC_NO_PACKET_IN = 1 << 6 /* Do not send packet-in msgs for port. */
179 /* Current state of the physical port. These are not configurable from
182 enum ofp_port_state {
183 OFPPS_LINK_DOWN = 1 << 0, /* No physical link present. */
185 /* The OFPPS_STP_* bits have no effect on switch operation. The
186 * controller must adjust OFPPC_NO_RECV, OFPPC_NO_FWD, and
187 * OFPPC_NO_PACKET_IN appropriately to fully implement an 802.1D spanning
189 OFPPS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
190 OFPPS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
191 OFPPS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
192 OFPPS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
193 OFPPS_STP_MASK = 3 << 8 /* Bit mask for OFPPS_STP_* values. */
196 /* Features of physical ports available in a datapath. */
197 enum ofp_port_features {
198 OFPPF_10MB_HD = 1 << 0, /* 10 Mb half-duplex rate support. */
199 OFPPF_10MB_FD = 1 << 1, /* 10 Mb full-duplex rate support. */
200 OFPPF_100MB_HD = 1 << 2, /* 100 Mb half-duplex rate support. */
201 OFPPF_100MB_FD = 1 << 3, /* 100 Mb full-duplex rate support. */
202 OFPPF_1GB_HD = 1 << 4, /* 1 Gb half-duplex rate support. */
203 OFPPF_1GB_FD = 1 << 5, /* 1 Gb full-duplex rate support. */
204 OFPPF_10GB_FD = 1 << 6, /* 10 Gb full-duplex rate support. */
205 OFPPF_COPPER = 1 << 7, /* Copper medium. */
206 OFPPF_FIBER = 1 << 8, /* Fiber medium. */
207 OFPPF_AUTONEG = 1 << 9, /* Auto-negotiation. */
208 OFPPF_PAUSE = 1 << 10, /* Pause. */
209 OFPPF_PAUSE_ASYM = 1 << 11 /* Asymmetric pause. */
212 /* Description of a physical port */
213 struct ofp_phy_port {
215 uint8_t hw_addr[OFP_ETH_ALEN];
216 char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
218 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
219 ovs_be32 state; /* Bitmap of OFPPS_* flags. */
221 /* Bitmaps of OFPPF_* that describe features. All bits zeroed if
222 * unsupported or unavailable. */
223 ovs_be32 curr; /* Current features. */
224 ovs_be32 advertised; /* Features being advertised by the port. */
225 ovs_be32 supported; /* Features supported by the port. */
226 ovs_be32 peer; /* Features advertised by peer. */
228 OFP_ASSERT(sizeof(struct ofp_phy_port) == 48);
230 /* Switch features. */
231 struct ofp_switch_features {
232 struct ofp_header header;
233 ovs_be64 datapath_id; /* Datapath unique ID. The lower 48-bits are for
234 a MAC address, while the upper 16-bits are
235 implementer-defined. */
237 ovs_be32 n_buffers; /* Max packets buffered at once. */
239 uint8_t n_tables; /* Number of tables supported by datapath. */
240 uint8_t pad[3]; /* Align to 64-bits. */
243 ovs_be32 capabilities; /* Bitmap of support "ofp_capabilities". */
244 ovs_be32 actions; /* Bitmap of supported "ofp_action_type"s. */
247 struct ofp_phy_port ports[0]; /* Port definitions. The number of ports
248 is inferred from the length field in
251 OFP_ASSERT(sizeof(struct ofp_switch_features) == 32);
253 /* What changed about the physical port */
254 enum ofp_port_reason {
255 OFPPR_ADD, /* The port was added. */
256 OFPPR_DELETE, /* The port was removed. */
257 OFPPR_MODIFY /* Some attribute of the port has changed. */
260 /* A physical port has changed in the datapath */
261 struct ofp_port_status {
262 struct ofp_header header;
263 uint8_t reason; /* One of OFPPR_*. */
264 uint8_t pad[7]; /* Align to 64-bits. */
265 struct ofp_phy_port desc;
267 OFP_ASSERT(sizeof(struct ofp_port_status) == 64);
269 /* Modify behavior of the physical port */
270 struct ofp_port_mod {
271 struct ofp_header header;
273 uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
274 configurable. This is used to
275 sanity-check the request, so it must
276 be the same as returned in an
277 ofp_phy_port struct. */
279 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
280 ovs_be32 mask; /* Bitmap of OFPPC_* flags to be changed. */
282 ovs_be32 advertise; /* Bitmap of "ofp_port_features"s. Zero all
283 bits to prevent any action taking place. */
284 uint8_t pad[4]; /* Pad to 64-bits. */
286 OFP_ASSERT(sizeof(struct ofp_port_mod) == 32);
288 /* Why is this packet being sent to the controller? */
289 enum ofp_packet_in_reason {
290 OFPR_NO_MATCH, /* No matching flow. */
291 OFPR_ACTION /* Action explicitly output to controller. */
294 /* Packet received on port (datapath -> controller). */
295 struct ofp_packet_in {
296 struct ofp_header header;
297 ovs_be32 buffer_id; /* ID assigned by datapath. */
298 ovs_be16 total_len; /* Full length of frame. */
299 ovs_be16 in_port; /* Port on which frame was received. */
300 uint8_t reason; /* Reason packet is being sent (one of OFPR_*) */
302 uint8_t data[0]; /* Ethernet frame, halfway through 32-bit word,
303 so the IP header is 32-bit aligned. The
304 amount of data is inferred from the length
305 field in the header. Because of padding,
306 offsetof(struct ofp_packet_in, data) ==
307 sizeof(struct ofp_packet_in) - 2. */
309 OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
311 enum ofp_action_type {
312 OFPAT_OUTPUT, /* Output to switch port. */
313 OFPAT_SET_VLAN_VID, /* Set the 802.1q VLAN id. */
314 OFPAT_SET_VLAN_PCP, /* Set the 802.1q priority. */
315 OFPAT_STRIP_VLAN, /* Strip the 802.1q header. */
316 OFPAT_SET_DL_SRC, /* Ethernet source address. */
317 OFPAT_SET_DL_DST, /* Ethernet destination address. */
318 OFPAT_SET_NW_SRC, /* IP source address. */
319 OFPAT_SET_NW_DST, /* IP destination address. */
320 OFPAT_SET_NW_TOS, /* IP ToS (DSCP field, 6 bits). */
321 OFPAT_SET_TP_SRC, /* TCP/UDP source port. */
322 OFPAT_SET_TP_DST, /* TCP/UDP destination port. */
323 OFPAT_ENQUEUE, /* Output to queue. */
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 ovs_be16 type; /* OFPAT_OUTPUT. */
333 ovs_be16 len; /* Length is 8. */
334 ovs_be16 port; /* Output port. */
335 ovs_be16 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 ovs_be16 type; /* OFPAT_SET_VLAN_VID. */
347 ovs_be16 len; /* Length is 8. */
348 ovs_be16 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 ovs_be16 type; /* OFPAT_SET_VLAN_PCP. */
356 ovs_be16 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 ovs_be16 type; /* OFPAT_SET_DL_SRC/DST. */
365 ovs_be16 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 ovs_be16 type; /* OFPAT_SET_TW_SRC/DST. */
374 ovs_be16 len; /* Length is 8. */
375 ovs_be32 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 ovs_be16 type; /* OFPAT_SET_TW_TOS. */
382 ovs_be16 len; /* Length is 8. */
383 uint8_t nw_tos; /* IP TOS (DSCP field, 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 ovs_be16 type; /* OFPAT_SET_TP_SRC/DST. */
391 ovs_be16 len; /* Length is 8. */
392 ovs_be16 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 ovs_be16 type; /* OFPAT_VENDOR. */
400 ovs_be16 len; /* Length is a multiple of 8. */
401 ovs_be32 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 ovs_be16 type; /* One of OFPAT_*. */
411 ovs_be16 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);
419 /* OFPAT_ENQUEUE action struct: send packets to given queue on port. */
420 struct ofp_action_enqueue {
421 ovs_be16 type; /* OFPAT_ENQUEUE. */
422 ovs_be16 len; /* Len is 16. */
423 ovs_be16 port; /* Port that queue belongs. Should
424 refer to a valid physical port
425 (i.e. < OFPP_MAX) or OFPP_IN_PORT. */
426 uint8_t pad[6]; /* Pad for 64-bit alignment. */
427 ovs_be32 queue_id; /* Where to enqueue the packets. */
429 OFP_ASSERT(sizeof(struct ofp_action_enqueue) == 16);
433 struct ofp_action_header header;
434 struct ofp_action_vendor_header vendor;
435 struct ofp_action_output output;
436 struct ofp_action_vlan_vid vlan_vid;
437 struct ofp_action_vlan_pcp vlan_pcp;
438 struct ofp_action_nw_addr nw_addr;
439 struct ofp_action_nw_tos nw_tos;
440 struct ofp_action_tp_port tp_port;
442 OFP_ASSERT(sizeof(union ofp_action) == 8);
444 /* Send packet (controller -> datapath). */
445 struct ofp_packet_out {
446 struct ofp_header header;
447 ovs_be32 buffer_id; /* ID assigned by datapath (-1 if none). */
448 ovs_be16 in_port; /* Packet's input port (OFPP_NONE if none). */
449 ovs_be16 actions_len; /* Size of action array in bytes. */
450 struct ofp_action_header actions[0]; /* Actions. */
451 /* uint8_t data[0]; */ /* Packet data. The length is inferred
452 from the length field in the header.
453 (Only meaningful if buffer_id == -1.) */
455 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
457 enum ofp_flow_mod_command {
458 OFPFC_ADD, /* New flow. */
459 OFPFC_MODIFY, /* Modify all matching flows. */
460 OFPFC_MODIFY_STRICT, /* Modify entry strictly matching wildcards */
461 OFPFC_DELETE, /* Delete all matching flows. */
462 OFPFC_DELETE_STRICT /* Strictly match wildcards and priority. */
465 /* Flow wildcards. */
466 enum ofp_flow_wildcards {
467 OFPFW_IN_PORT = 1 << 0, /* Switch input port. */
468 OFPFW_DL_VLAN = 1 << 1, /* VLAN vid. */
469 OFPFW_DL_SRC = 1 << 2, /* Ethernet source address. */
470 OFPFW_DL_DST = 1 << 3, /* Ethernet destination address. */
471 OFPFW_DL_TYPE = 1 << 4, /* Ethernet frame type. */
472 OFPFW_NW_PROTO = 1 << 5, /* IP protocol. */
473 OFPFW_TP_SRC = 1 << 6, /* TCP/UDP source port. */
474 OFPFW_TP_DST = 1 << 7, /* TCP/UDP destination port. */
476 /* IP source address wildcard bit count. 0 is exact match, 1 ignores the
477 * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
478 * the entire field. This is the *opposite* of the usual convention where
479 * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
480 OFPFW_NW_SRC_SHIFT = 8,
481 OFPFW_NW_SRC_BITS = 6,
482 OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
483 OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
485 /* IP destination address wildcard bit count. Same format as source. */
486 OFPFW_NW_DST_SHIFT = 14,
487 OFPFW_NW_DST_BITS = 6,
488 OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
489 OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
491 OFPFW_DL_VLAN_PCP = 1 << 20, /* VLAN priority. */
492 OFPFW_NW_TOS = 1 << 21, /* IP ToS (DSCP field, 6 bits). */
494 /* Wildcard all fields. */
495 OFPFW_ALL = ((1 << 22) - 1)
498 /* The wildcards for ICMP type and code fields use the transport source
499 * and destination port fields, respectively. */
500 #define OFPFW_ICMP_TYPE OFPFW_TP_SRC
501 #define OFPFW_ICMP_CODE OFPFW_TP_DST
503 /* Values below this cutoff are 802.3 packets and the two bytes
504 * following MAC addresses are used as a frame length. Otherwise, the
505 * two bytes are used as the Ethernet type.
507 #define OFP_DL_TYPE_ETH2_CUTOFF 0x0600
509 /* Value of dl_type to indicate that the frame does not include an
512 #define OFP_DL_TYPE_NOT_ETH_TYPE 0x05ff
514 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
515 * special conditions. All ones indicates that no VLAN id was set.
517 #define OFP_VLAN_NONE 0xffff
519 /* Fields to match against flows */
521 ovs_be32 wildcards; /* Wildcard fields. */
522 ovs_be16 in_port; /* Input switch port. */
523 uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
524 uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
525 ovs_be16 dl_vlan; /* Input VLAN. */
526 uint8_t dl_vlan_pcp; /* Input VLAN priority. */
527 uint8_t pad1[1]; /* Align to 64-bits. */
528 ovs_be16 dl_type; /* Ethernet frame type. */
529 uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */
530 uint8_t nw_proto; /* IP protocol or lower 8 bits of
532 uint8_t pad2[2]; /* Align to 64-bits. */
533 ovs_be32 nw_src; /* IP source address. */
534 ovs_be32 nw_dst; /* IP destination address. */
535 ovs_be16 tp_src; /* TCP/UDP source port. */
536 ovs_be16 tp_dst; /* TCP/UDP destination port. */
538 OFP_ASSERT(sizeof(struct ofp_match) == 40);
540 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
542 #define OFP_FLOW_PERMANENT 0
544 /* By default, choose a priority in the middle. */
545 #define OFP_DEFAULT_PRIORITY 0x8000
547 enum ofp_flow_mod_flags {
548 OFPFF_SEND_FLOW_REM = 1 << 0, /* Send flow removed message when flow
549 * expires or is deleted. */
550 OFPFF_CHECK_OVERLAP = 1 << 1, /* Check for overlapping entries first. */
551 OFPFF_EMERG = 1 << 2 /* Ramark this is for emergency. */
554 /* Flow setup and teardown (controller -> datapath). */
555 struct ofp_flow_mod {
556 struct ofp_header header;
557 struct ofp_match match; /* Fields to match */
558 ovs_be64 cookie; /* Opaque controller-issued identifier. */
561 ovs_be16 command; /* One of OFPFC_*. */
562 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
563 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
564 ovs_be16 priority; /* Priority level of flow entry. */
565 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
566 Not meaningful for OFPFC_DELETE*. */
567 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
568 matching entries to include this as an
569 output port. A value of OFPP_NONE
570 indicates no restriction. */
571 ovs_be16 flags; /* One of OFPFF_*. */
572 struct ofp_action_header actions[0]; /* The action length is inferred
573 from the length field in the
576 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 72);
578 /* Why was this flow removed? */
579 enum ofp_flow_removed_reason {
580 OFPRR_IDLE_TIMEOUT, /* Flow idle time exceeded idle_timeout. */
581 OFPRR_HARD_TIMEOUT, /* Time exceeded hard_timeout. */
582 OFPRR_DELETE /* Evicted by a DELETE flow mod. */
585 /* Flow removed (datapath -> controller). */
586 struct ofp_flow_removed {
587 struct ofp_header header;
588 struct ofp_match match; /* Description of fields. */
589 ovs_be64 cookie; /* Opaque controller-issued identifier. */
591 ovs_be16 priority; /* Priority level of flow entry. */
592 uint8_t reason; /* One of OFPRR_*. */
593 uint8_t pad[1]; /* Align to 32-bits. */
595 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
596 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
598 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
599 uint8_t pad2[2]; /* Align to 64-bits. */
600 ovs_be64 packet_count;
603 OFP_ASSERT(sizeof(struct ofp_flow_removed) == 88);
605 /* Values for 'type' in ofp_error_message. These values are immutable: they
606 * will not change in future versions of the protocol (although new values may
608 enum ofp_error_type {
609 OFPET_HELLO_FAILED, /* Hello protocol failed. */
610 OFPET_BAD_REQUEST, /* Request was not understood. */
611 OFPET_BAD_ACTION, /* Error in action description. */
612 OFPET_FLOW_MOD_FAILED, /* Problem modifying flow entry. */
613 OFPET_PORT_MOD_FAILED, /* OFPT_PORT_MOD failed. */
614 OFPET_QUEUE_OP_FAILED /* Queue operation failed. */
617 /* ofp_error_msg 'code' values for OFPET_HELLO_FAILED. 'data' contains an
618 * ASCII text string that may give failure details. */
619 enum ofp_hello_failed_code {
620 OFPHFC_INCOMPATIBLE, /* No compatible version. */
621 OFPHFC_EPERM /* Permissions error. */
624 /* ofp_error_msg 'code' values for OFPET_BAD_REQUEST. 'data' contains at least
625 * the first 64 bytes of the failed request. */
626 enum ofp_bad_request_code {
627 OFPBRC_BAD_VERSION, /* ofp_header.version not supported. */
628 OFPBRC_BAD_TYPE, /* ofp_header.type not supported. */
629 OFPBRC_BAD_STAT, /* ofp_stats_msg.type not supported. */
630 OFPBRC_BAD_VENDOR, /* Vendor not supported (in ofp_vendor_header
631 * or ofp_stats_msg). */
632 OFPBRC_BAD_SUBTYPE, /* Vendor subtype not supported. */
633 OFPBRC_EPERM, /* Permissions error. */
634 OFPBRC_BAD_LEN, /* Wrong request length for type. */
635 OFPBRC_BUFFER_EMPTY, /* Specified buffer has already been used. */
636 OFPBRC_BUFFER_UNKNOWN /* Specified buffer does not exist. */
639 /* ofp_error_msg 'code' values for OFPET_BAD_ACTION. 'data' contains at least
640 * the first 64 bytes of the failed request. */
641 enum ofp_bad_action_code {
642 OFPBAC_BAD_TYPE, /* Unknown action type. */
643 OFPBAC_BAD_LEN, /* Length problem in actions. */
644 OFPBAC_BAD_VENDOR, /* Unknown vendor id specified. */
645 OFPBAC_BAD_VENDOR_TYPE, /* Unknown action type for vendor id. */
646 OFPBAC_BAD_OUT_PORT, /* Problem validating output action. */
647 OFPBAC_BAD_ARGUMENT, /* Bad action argument. */
648 OFPBAC_EPERM, /* Permissions error. */
649 OFPBAC_TOO_MANY, /* Can't handle this many actions. */
650 OFPBAC_BAD_QUEUE /* Problem validating output queue. */
653 /* ofp_error_msg 'code' values for OFPET_FLOW_MOD_FAILED. 'data' contains
654 * at least the first 64 bytes of the failed request. */
655 enum ofp_flow_mod_failed_code {
656 OFPFMFC_ALL_TABLES_FULL, /* Flow not added because of full tables. */
657 OFPFMFC_OVERLAP, /* Attempted to add overlapping flow with
658 * CHECK_OVERLAP flag set. */
659 OFPFMFC_EPERM, /* Permissions error. */
660 OFPFMFC_BAD_EMERG_TIMEOUT, /* Flow not added because of non-zero idle/hard
662 OFPFMFC_BAD_COMMAND, /* Unknown command. */
663 OFPFMFC_UNSUPPORTED /* Unsupported action list - cannot process in
664 the order specified. */
667 /* ofp_error_msg 'code' values for OFPET_PORT_MOD_FAILED. 'data' contains
668 * at least the first 64 bytes of the failed request. */
669 enum ofp_port_mod_failed_code {
670 OFPPMFC_BAD_PORT, /* Specified port does not exist. */
671 OFPPMFC_BAD_HW_ADDR, /* Specified hardware address is wrong. */
674 /* ofp_error msg 'code' values for OFPET_QUEUE_OP_FAILED. 'data' contains
675 * at least the first 64 bytes of the failed request */
676 enum ofp_queue_op_failed_code {
677 OFPQOFC_BAD_PORT, /* Invalid port (or port does not exist). */
678 OFPQOFC_BAD_QUEUE, /* Queue does not exist. */
679 OFPQOFC_EPERM /* Permissions error. */
682 /* OFPT_ERROR: Error message (datapath -> controller). */
683 struct ofp_error_msg {
684 struct ofp_header header;
688 uint8_t data[0]; /* Variable-length data. Interpreted based
689 on the type and code. */
691 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
693 enum ofp_stats_types {
694 /* Description of this OpenFlow switch.
695 * The request is struct ofp_stats_msg.
696 * The reply is struct ofp_desc_stats. */
699 /* Individual flow statistics.
700 * The request is struct ofp_flow_stats_request.
701 * The reply body is an array of struct ofp_flow_stats. */
704 /* Aggregate flow statistics.
705 * The request is struct ofp_flow_stats_request.
706 * The reply is struct ofp_aggregate_stats_reply. */
709 /* Flow table statistics.
710 * The request is struct ofp_stats_msg.
711 * The reply body is an array of struct ofp_table_stats. */
714 /* Physical port statistics.
715 * The request is struct ofp_port_stats_request.
716 * The reply body is an array of struct ofp_port_stats. */
719 /* Queue statistics for a port.
720 * The request body is struct ofp_queue_stats_request.
721 * The reply body is an array of struct ofp_queue_stats. */
725 * The request and reply begin with "struct ofp_vendor_stats". */
726 OFPST_VENDOR = 0xffff
729 /* Statistics request or reply message. */
730 struct ofp_stats_msg {
731 struct ofp_header header;
732 ovs_be16 type; /* One of the OFPST_* constants. */
733 ovs_be16 flags; /* Requests: always 0.
734 * Replies: 0 or OFPSF_REPLY_MORE. */
736 OFP_ASSERT(sizeof(struct ofp_stats_msg) == 12);
738 enum ofp_stats_reply_flags {
739 OFPSF_REPLY_MORE = 1 << 0 /* More replies to follow. */
742 #define DESC_STR_LEN 256
743 #define SERIAL_NUM_LEN 32
744 /* Reply to OFPST_DESC request. Each entry is a NULL-terminated ASCII
746 struct ofp_desc_stats {
747 struct ofp_stats_msg osm;
748 char mfr_desc[DESC_STR_LEN]; /* Manufacturer description. */
749 char hw_desc[DESC_STR_LEN]; /* Hardware description. */
750 char sw_desc[DESC_STR_LEN]; /* Software description. */
751 char serial_num[SERIAL_NUM_LEN]; /* Serial number. */
752 char dp_desc[DESC_STR_LEN]; /* Human readable description of
755 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 1068);
757 /* Stats request of type OFPST_AGGREGATE or OFPST_FLOW. */
758 struct ofp_flow_stats_request {
759 struct ofp_stats_msg osm;
760 struct ofp_match match; /* Fields to match. */
761 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
762 or 0xff for all tables. */
763 uint8_t pad; /* Align to 32 bits. */
764 ovs_be16 out_port; /* Require matching entries to include this
765 as an output port. A value of OFPP_NONE
766 indicates no restriction. */
768 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 56);
770 /* Body of reply to OFPST_FLOW request. */
771 struct ofp_flow_stats {
772 ovs_be16 length; /* Length of this entry. */
773 uint8_t table_id; /* ID of table flow came from. */
775 struct ofp_match match; /* Description of fields. */
776 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
777 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
778 beyond duration_sec. */
779 ovs_be16 priority; /* Priority of the entry. Only meaningful
780 when this is not an exact-match entry. */
781 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
782 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
783 uint8_t pad2[6]; /* Align to 64 bits. */
784 ovs_32aligned_be64 cookie; /* Opaque controller-issued identifier. */
785 ovs_32aligned_be64 packet_count; /* Number of packets in flow. */
786 ovs_32aligned_be64 byte_count; /* Number of bytes in flow. */
787 struct ofp_action_header actions[0]; /* Actions. */
789 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 88);
791 /* Reply to OFPST_AGGREGATE request. */
792 struct ofp_aggregate_stats_reply {
793 struct ofp_stats_msg osm;
794 ovs_32aligned_be64 packet_count; /* Number of packets in flows. */
795 ovs_32aligned_be64 byte_count; /* Number of bytes in flows. */
796 ovs_be32 flow_count; /* Number of flows. */
797 uint8_t pad[4]; /* Align to 64 bits. */
799 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 36);
801 /* Body of reply to OFPST_TABLE request. */
802 struct ofp_table_stats {
803 uint8_t table_id; /* Identifier of table. Lower numbered tables
804 are consulted first. */
805 uint8_t pad[3]; /* Align to 32-bits. */
806 char name[OFP_MAX_TABLE_NAME_LEN];
807 ovs_be32 wildcards; /* Bitmap of OFPFW_* wildcards that are
808 supported by the table. */
809 ovs_be32 max_entries; /* Max number of entries supported. */
810 ovs_be32 active_count; /* Number of active entries. */
811 ovs_32aligned_be64 lookup_count; /* # of packets looked up in table. */
812 ovs_32aligned_be64 matched_count; /* Number of packets that hit table. */
814 OFP_ASSERT(sizeof(struct ofp_table_stats) == 64);
816 /* Stats request of type OFPST_PORT. */
817 struct ofp_port_stats_request {
818 struct ofp_stats_msg osm;
819 ovs_be16 port_no; /* OFPST_PORT message may request statistics
820 for a single port (specified with port_no)
821 or for all ports (port_no == OFPP_NONE). */
824 OFP_ASSERT(sizeof(struct ofp_port_stats_request) == 20);
826 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
827 * the field to all ones. */
828 struct ofp_port_stats {
830 uint8_t pad[6]; /* Align to 64-bits. */
831 ovs_32aligned_be64 rx_packets; /* Number of received packets. */
832 ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */
833 ovs_32aligned_be64 rx_bytes; /* Number of received bytes. */
834 ovs_32aligned_be64 tx_bytes; /* Number of transmitted bytes. */
835 ovs_32aligned_be64 rx_dropped; /* Number of packets dropped by RX. */
836 ovs_32aligned_be64 tx_dropped; /* Number of packets dropped by TX. */
837 ovs_32aligned_be64 rx_errors; /* Number of receive errors. This is a
838 super-set of receive errors and should be
839 great than or equal to the sum of all
841 ovs_32aligned_be64 tx_errors; /* Number of transmit errors. This is a
842 super-set of transmit errors. */
843 ovs_32aligned_be64 rx_frame_err; /* Number of frame alignment errors. */
844 ovs_32aligned_be64 rx_over_err; /* Number of packets with RX overrun. */
845 ovs_32aligned_be64 rx_crc_err; /* Number of CRC errors. */
846 ovs_32aligned_be64 collisions; /* Number of collisions. */
848 OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
850 /* All ones is used to indicate all queues in a port (for stats retrieval). */
851 #define OFPQ_ALL 0xffffffff
853 /* Body for stats request of type OFPST_QUEUE. */
854 struct ofp_queue_stats_request {
855 struct ofp_stats_msg osm;
856 ovs_be16 port_no; /* All ports if OFPP_ALL. */
857 uint8_t pad[2]; /* Align to 32-bits. */
858 ovs_be32 queue_id; /* All queues if OFPQ_ALL. */
860 OFP_ASSERT(sizeof(struct ofp_queue_stats_request) == 20);
862 /* Body for stats reply of type OFPST_QUEUE consists of an array of this
864 struct ofp_queue_stats {
866 uint8_t pad[2]; /* Align to 32-bits. */
867 ovs_be32 queue_id; /* Queue id. */
868 ovs_32aligned_be64 tx_bytes; /* Number of transmitted bytes. */
869 ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */
870 ovs_32aligned_be64 tx_errors; /* # of packets dropped due to overrun. */
872 OFP_ASSERT(sizeof(struct ofp_queue_stats) == 32);
874 /* Vendor extension stats message. */
875 struct ofp_vendor_stats_msg {
876 struct ofp_stats_msg osm; /* Type OFPST_VENDOR. */
877 ovs_be32 vendor; /* Vendor ID:
878 * - MSB 0: low-order bytes are IEEE OUI.
879 * - MSB != 0: defined by OpenFlow
881 /* Followed by vendor-defined arbitrary additional data. */
883 OFP_ASSERT(sizeof(struct ofp_vendor_stats_msg) == 16);
885 /* Vendor extension. */
886 struct ofp_vendor_header {
887 struct ofp_header header; /* Type OFPT_VENDOR. */
888 ovs_be32 vendor; /* Vendor ID:
889 * - MSB 0: low-order bytes are IEEE OUI.
890 * - MSB != 0: defined by OpenFlow
892 /* Vendor-defined arbitrary additional data. */
894 OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12);
896 #endif /* openflow/openflow.h */