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. */
141 /* TTL processing - applicable for IP and MPLS packets. */
142 OFPC_INVALID_TTL_TO_CONTROLLER = 1 << 2, /* Send packets with invalid TTL
143 to the controller. */
146 /* Switch configuration. */
147 struct ofp_switch_config {
148 struct ofp_header header;
149 ovs_be16 flags; /* OFPC_* flags. */
150 ovs_be16 miss_send_len; /* Max bytes of new flow that datapath should
151 send to the controller. */
153 OFP_ASSERT(sizeof(struct ofp_switch_config) == 12);
155 /* Capabilities supported by the datapath. */
156 enum ofp_capabilities {
157 OFPC_FLOW_STATS = 1 << 0, /* Flow statistics. */
158 OFPC_TABLE_STATS = 1 << 1, /* Table statistics. */
159 OFPC_PORT_STATS = 1 << 2, /* Port statistics. */
160 OFPC_STP = 1 << 3, /* 802.1d spanning tree. */
161 OFPC_RESERVED = 1 << 4, /* Reserved, must not be set. */
162 OFPC_IP_REASM = 1 << 5, /* Can reassemble IP fragments. */
163 OFPC_QUEUE_STATS = 1 << 6, /* Queue statistics. */
164 OFPC_ARP_MATCH_IP = 1 << 7 /* Match IP addresses in ARP
168 /* Flags to indicate behavior of the physical port. These flags are
169 * used in ofp_phy_port to describe the current configuration. They are
170 * used in the ofp_port_mod message to configure the port's behavior.
172 enum ofp_port_config {
173 OFPPC_PORT_DOWN = 1 << 0, /* Port is administratively down. */
175 OFPPC_NO_STP = 1 << 1, /* Disable 802.1D spanning tree on port. */
176 OFPPC_NO_RECV = 1 << 2, /* Drop all packets except 802.1D
177 spanning tree packets. */
178 OFPPC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */
179 OFPPC_NO_FLOOD = 1 << 4, /* Do not include this port when flooding. */
180 OFPPC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */
181 OFPPC_NO_PACKET_IN = 1 << 6 /* Do not send packet-in msgs for port. */
184 /* Current state of the physical port. These are not configurable from
187 enum ofp_port_state {
188 OFPPS_LINK_DOWN = 1 << 0, /* No physical link present. */
190 /* The OFPPS_STP_* bits have no effect on switch operation. The
191 * controller must adjust OFPPC_NO_RECV, OFPPC_NO_FWD, and
192 * OFPPC_NO_PACKET_IN appropriately to fully implement an 802.1D spanning
194 OFPPS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
195 OFPPS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
196 OFPPS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
197 OFPPS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
198 OFPPS_STP_MASK = 3 << 8 /* Bit mask for OFPPS_STP_* values. */
201 /* Features of physical ports available in a datapath. */
202 enum ofp_port_features {
203 OFPPF_10MB_HD = 1 << 0, /* 10 Mb half-duplex rate support. */
204 OFPPF_10MB_FD = 1 << 1, /* 10 Mb full-duplex rate support. */
205 OFPPF_100MB_HD = 1 << 2, /* 100 Mb half-duplex rate support. */
206 OFPPF_100MB_FD = 1 << 3, /* 100 Mb full-duplex rate support. */
207 OFPPF_1GB_HD = 1 << 4, /* 1 Gb half-duplex rate support. */
208 OFPPF_1GB_FD = 1 << 5, /* 1 Gb full-duplex rate support. */
209 OFPPF_10GB_FD = 1 << 6, /* 10 Gb full-duplex rate support. */
210 OFPPF_COPPER = 1 << 7, /* Copper medium. */
211 OFPPF_FIBER = 1 << 8, /* Fiber medium. */
212 OFPPF_AUTONEG = 1 << 9, /* Auto-negotiation. */
213 OFPPF_PAUSE = 1 << 10, /* Pause. */
214 OFPPF_PAUSE_ASYM = 1 << 11 /* Asymmetric pause. */
217 /* Description of a physical port */
218 struct ofp_phy_port {
220 uint8_t hw_addr[OFP_ETH_ALEN];
221 char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
223 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
224 ovs_be32 state; /* Bitmap of OFPPS_* flags. */
226 /* Bitmaps of OFPPF_* that describe features. All bits zeroed if
227 * unsupported or unavailable. */
228 ovs_be32 curr; /* Current features. */
229 ovs_be32 advertised; /* Features being advertised by the port. */
230 ovs_be32 supported; /* Features supported by the port. */
231 ovs_be32 peer; /* Features advertised by peer. */
233 OFP_ASSERT(sizeof(struct ofp_phy_port) == 48);
235 /* Switch features. */
236 struct ofp_switch_features {
237 struct ofp_header header;
238 ovs_be64 datapath_id; /* Datapath unique ID. The lower 48-bits are for
239 a MAC address, while the upper 16-bits are
240 implementer-defined. */
242 ovs_be32 n_buffers; /* Max packets buffered at once. */
244 uint8_t n_tables; /* Number of tables supported by datapath. */
245 uint8_t pad[3]; /* Align to 64-bits. */
248 ovs_be32 capabilities; /* Bitmap of support "ofp_capabilities". */
249 ovs_be32 actions; /* Bitmap of supported "ofp_action_type"s. */
252 struct ofp_phy_port ports[0]; /* Port definitions. The number of ports
253 is inferred from the length field in
256 OFP_ASSERT(sizeof(struct ofp_switch_features) == 32);
258 /* What changed about the physical port */
259 enum ofp_port_reason {
260 OFPPR_ADD, /* The port was added. */
261 OFPPR_DELETE, /* The port was removed. */
262 OFPPR_MODIFY /* Some attribute of the port has changed. */
265 /* A physical port has changed in the datapath */
266 struct ofp_port_status {
267 struct ofp_header header;
268 uint8_t reason; /* One of OFPPR_*. */
269 uint8_t pad[7]; /* Align to 64-bits. */
270 struct ofp_phy_port desc;
272 OFP_ASSERT(sizeof(struct ofp_port_status) == 64);
274 /* Modify behavior of the physical port */
275 struct ofp_port_mod {
276 struct ofp_header header;
278 uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
279 configurable. This is used to
280 sanity-check the request, so it must
281 be the same as returned in an
282 ofp_phy_port struct. */
284 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
285 ovs_be32 mask; /* Bitmap of OFPPC_* flags to be changed. */
287 ovs_be32 advertise; /* Bitmap of "ofp_port_features"s. Zero all
288 bits to prevent any action taking place. */
289 uint8_t pad[4]; /* Pad to 64-bits. */
291 OFP_ASSERT(sizeof(struct ofp_port_mod) == 32);
293 /* Why is this packet being sent to the controller? */
294 enum ofp_packet_in_reason {
295 OFPR_NO_MATCH, /* No matching flow. */
296 OFPR_ACTION, /* Action explicitly output to controller. */
297 OFPR_INVALID_TTL /* Packet has invalid TTL. */
300 /* Packet received on port (datapath -> controller). */
301 struct ofp_packet_in {
302 struct ofp_header header;
303 ovs_be32 buffer_id; /* ID assigned by datapath. */
304 ovs_be16 total_len; /* Full length of frame. */
305 ovs_be16 in_port; /* Port on which frame was received. */
306 uint8_t reason; /* Reason packet is being sent (one of OFPR_*) */
308 uint8_t data[0]; /* Ethernet frame, halfway through 32-bit word,
309 so the IP header is 32-bit aligned. The
310 amount of data is inferred from the length
311 field in the header. Because of padding,
312 offsetof(struct ofp_packet_in, data) ==
313 sizeof(struct ofp_packet_in) - 2. */
315 OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
317 enum ofp_action_type {
318 OFPAT_OUTPUT, /* Output to switch port. */
319 OFPAT_SET_VLAN_VID, /* Set the 802.1q VLAN id. */
320 OFPAT_SET_VLAN_PCP, /* Set the 802.1q priority. */
321 OFPAT_STRIP_VLAN, /* Strip the 802.1q header. */
322 OFPAT_SET_DL_SRC, /* Ethernet source address. */
323 OFPAT_SET_DL_DST, /* Ethernet destination address. */
324 OFPAT_SET_NW_SRC, /* IP source address. */
325 OFPAT_SET_NW_DST, /* IP destination address. */
326 OFPAT_SET_NW_TOS, /* IP ToS (DSCP field, 6 bits). */
327 OFPAT_SET_TP_SRC, /* TCP/UDP source port. */
328 OFPAT_SET_TP_DST, /* TCP/UDP destination port. */
329 OFPAT_ENQUEUE, /* Output to queue. */
330 OFPAT_VENDOR = 0xffff
333 /* Action structure for OFPAT_OUTPUT, which sends packets out 'port'.
334 * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
335 * number of bytes to send. A 'max_len' of zero means no bytes of the
336 * packet should be sent. */
337 struct ofp_action_output {
338 ovs_be16 type; /* OFPAT_OUTPUT. */
339 ovs_be16 len; /* Length is 8. */
340 ovs_be16 port; /* Output port. */
341 ovs_be16 max_len; /* Max length to send to controller. */
343 OFP_ASSERT(sizeof(struct ofp_action_output) == 8);
345 /* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate
346 * special conditions. All ones is used to match that no VLAN id was
348 #define OFP_VLAN_NONE 0xffff
350 /* Action structure for OFPAT_SET_VLAN_VID. */
351 struct ofp_action_vlan_vid {
352 ovs_be16 type; /* OFPAT_SET_VLAN_VID. */
353 ovs_be16 len; /* Length is 8. */
354 ovs_be16 vlan_vid; /* VLAN id. */
357 OFP_ASSERT(sizeof(struct ofp_action_vlan_vid) == 8);
359 /* Action structure for OFPAT_SET_VLAN_PCP. */
360 struct ofp_action_vlan_pcp {
361 ovs_be16 type; /* OFPAT_SET_VLAN_PCP. */
362 ovs_be16 len; /* Length is 8. */
363 uint8_t vlan_pcp; /* VLAN priority. */
366 OFP_ASSERT(sizeof(struct ofp_action_vlan_pcp) == 8);
368 /* Action structure for OFPAT_SET_DL_SRC/DST. */
369 struct ofp_action_dl_addr {
370 ovs_be16 type; /* OFPAT_SET_DL_SRC/DST. */
371 ovs_be16 len; /* Length is 16. */
372 uint8_t dl_addr[OFP_ETH_ALEN]; /* Ethernet address. */
375 OFP_ASSERT(sizeof(struct ofp_action_dl_addr) == 16);
377 /* Action structure for OFPAT_SET_NW_SRC/DST. */
378 struct ofp_action_nw_addr {
379 ovs_be16 type; /* OFPAT_SET_TW_SRC/DST. */
380 ovs_be16 len; /* Length is 8. */
381 ovs_be32 nw_addr; /* IP address. */
383 OFP_ASSERT(sizeof(struct ofp_action_nw_addr) == 8);
385 /* Action structure for OFPAT_SET_NW_TOS. */
386 struct ofp_action_nw_tos {
387 ovs_be16 type; /* OFPAT_SET_TW_TOS. */
388 ovs_be16 len; /* Length is 8. */
389 uint8_t nw_tos; /* IP TOS (DSCP field, 6 bits). */
392 OFP_ASSERT(sizeof(struct ofp_action_nw_tos) == 8);
394 /* Action structure for OFPAT_SET_TP_SRC/DST. */
395 struct ofp_action_tp_port {
396 ovs_be16 type; /* OFPAT_SET_TP_SRC/DST. */
397 ovs_be16 len; /* Length is 8. */
398 ovs_be16 tp_port; /* TCP/UDP port. */
401 OFP_ASSERT(sizeof(struct ofp_action_tp_port) == 8);
403 /* Action header for OFPAT_VENDOR. The rest of the body is vendor-defined. */
404 struct ofp_action_vendor_header {
405 ovs_be16 type; /* OFPAT_VENDOR. */
406 ovs_be16 len; /* Length is a multiple of 8. */
407 ovs_be32 vendor; /* Vendor ID, which takes the same form
408 as in "struct ofp_vendor_header". */
410 OFP_ASSERT(sizeof(struct ofp_action_vendor_header) == 8);
412 /* Action header that is common to all actions. The length includes the
413 * header and any padding used to make the action 64-bit aligned.
414 * NB: The length of an action *must* always be a multiple of eight. */
415 struct ofp_action_header {
416 ovs_be16 type; /* One of OFPAT_*. */
417 ovs_be16 len; /* Length of action, including this
418 header. This is the length of action,
419 including any padding to make it
423 OFP_ASSERT(sizeof(struct ofp_action_header) == 8);
425 /* OFPAT_ENQUEUE action struct: send packets to given queue on port. */
426 struct ofp_action_enqueue {
427 ovs_be16 type; /* OFPAT_ENQUEUE. */
428 ovs_be16 len; /* Len is 16. */
429 ovs_be16 port; /* Port that queue belongs. Should
430 refer to a valid physical port
431 (i.e. < OFPP_MAX) or OFPP_IN_PORT. */
432 uint8_t pad[6]; /* Pad for 64-bit alignment. */
433 ovs_be32 queue_id; /* Where to enqueue the packets. */
435 OFP_ASSERT(sizeof(struct ofp_action_enqueue) == 16);
439 struct ofp_action_header header;
440 struct ofp_action_vendor_header vendor;
441 struct ofp_action_output output;
442 struct ofp_action_vlan_vid vlan_vid;
443 struct ofp_action_vlan_pcp vlan_pcp;
444 struct ofp_action_nw_addr nw_addr;
445 struct ofp_action_nw_tos nw_tos;
446 struct ofp_action_tp_port tp_port;
448 OFP_ASSERT(sizeof(union ofp_action) == 8);
450 /* Send packet (controller -> datapath). */
451 struct ofp_packet_out {
452 struct ofp_header header;
453 ovs_be32 buffer_id; /* ID assigned by datapath (-1 if none). */
454 ovs_be16 in_port; /* Packet's input port (OFPP_NONE if none). */
455 ovs_be16 actions_len; /* Size of action array in bytes. */
456 struct ofp_action_header actions[0]; /* Actions. */
457 /* uint8_t data[0]; */ /* Packet data. The length is inferred
458 from the length field in the header.
459 (Only meaningful if buffer_id == -1.) */
461 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
463 enum ofp_flow_mod_command {
464 OFPFC_ADD, /* New flow. */
465 OFPFC_MODIFY, /* Modify all matching flows. */
466 OFPFC_MODIFY_STRICT, /* Modify entry strictly matching wildcards */
467 OFPFC_DELETE, /* Delete all matching flows. */
468 OFPFC_DELETE_STRICT /* Strictly match wildcards and priority. */
471 /* Flow wildcards. */
472 enum ofp_flow_wildcards {
473 OFPFW_IN_PORT = 1 << 0, /* Switch input port. */
474 OFPFW_DL_VLAN = 1 << 1, /* VLAN vid. */
475 OFPFW_DL_SRC = 1 << 2, /* Ethernet source address. */
476 OFPFW_DL_DST = 1 << 3, /* Ethernet destination address. */
477 OFPFW_DL_TYPE = 1 << 4, /* Ethernet frame type. */
478 OFPFW_NW_PROTO = 1 << 5, /* IP protocol. */
479 OFPFW_TP_SRC = 1 << 6, /* TCP/UDP source port. */
480 OFPFW_TP_DST = 1 << 7, /* TCP/UDP destination port. */
482 /* IP source address wildcard bit count. 0 is exact match, 1 ignores the
483 * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
484 * the entire field. This is the *opposite* of the usual convention where
485 * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
486 OFPFW_NW_SRC_SHIFT = 8,
487 OFPFW_NW_SRC_BITS = 6,
488 OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
489 OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
491 /* IP destination address wildcard bit count. Same format as source. */
492 OFPFW_NW_DST_SHIFT = 14,
493 OFPFW_NW_DST_BITS = 6,
494 OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
495 OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
497 OFPFW_DL_VLAN_PCP = 1 << 20, /* VLAN priority. */
498 OFPFW_NW_TOS = 1 << 21, /* IP ToS (DSCP field, 6 bits). */
500 /* Wildcard all fields. */
501 OFPFW_ALL = ((1 << 22) - 1)
504 /* The wildcards for ICMP type and code fields use the transport source
505 * and destination port fields, respectively. */
506 #define OFPFW_ICMP_TYPE OFPFW_TP_SRC
507 #define OFPFW_ICMP_CODE OFPFW_TP_DST
509 /* Values below this cutoff are 802.3 packets and the two bytes
510 * following MAC addresses are used as a frame length. Otherwise, the
511 * two bytes are used as the Ethernet type.
513 #define OFP_DL_TYPE_ETH2_CUTOFF 0x0600
515 /* Value of dl_type to indicate that the frame does not include an
518 #define OFP_DL_TYPE_NOT_ETH_TYPE 0x05ff
520 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
521 * special conditions. All ones indicates that no VLAN id was set.
523 #define OFP_VLAN_NONE 0xffff
525 /* Fields to match against flows */
527 ovs_be32 wildcards; /* Wildcard fields. */
528 ovs_be16 in_port; /* Input switch port. */
529 uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
530 uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
531 ovs_be16 dl_vlan; /* Input VLAN. */
532 uint8_t dl_vlan_pcp; /* Input VLAN priority. */
533 uint8_t pad1[1]; /* Align to 64-bits. */
534 ovs_be16 dl_type; /* Ethernet frame type. */
535 uint8_t nw_tos; /* IP ToS (DSCP field, 6 bits). */
536 uint8_t nw_proto; /* IP protocol or lower 8 bits of
538 uint8_t pad2[2]; /* Align to 64-bits. */
539 ovs_be32 nw_src; /* IP source address. */
540 ovs_be32 nw_dst; /* IP destination address. */
541 ovs_be16 tp_src; /* TCP/UDP source port. */
542 ovs_be16 tp_dst; /* TCP/UDP destination port. */
544 OFP_ASSERT(sizeof(struct ofp_match) == 40);
546 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
548 #define OFP_FLOW_PERMANENT 0
550 /* By default, choose a priority in the middle. */
551 #define OFP_DEFAULT_PRIORITY 0x8000
553 enum ofp_flow_mod_flags {
554 OFPFF_SEND_FLOW_REM = 1 << 0, /* Send flow removed message when flow
555 * expires or is deleted. */
556 OFPFF_CHECK_OVERLAP = 1 << 1, /* Check for overlapping entries first. */
557 OFPFF_EMERG = 1 << 2 /* Ramark this is for emergency. */
560 /* Flow setup and teardown (controller -> datapath). */
561 struct ofp_flow_mod {
562 struct ofp_header header;
563 struct ofp_match match; /* Fields to match */
564 ovs_be64 cookie; /* Opaque controller-issued identifier. */
567 ovs_be16 command; /* One of OFPFC_*. */
568 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
569 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
570 ovs_be16 priority; /* Priority level of flow entry. */
571 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
572 Not meaningful for OFPFC_DELETE*. */
573 ovs_be16 out_port; /* For OFPFC_DELETE* commands, require
574 matching entries to include this as an
575 output port. A value of OFPP_NONE
576 indicates no restriction. */
577 ovs_be16 flags; /* One of OFPFF_*. */
578 struct ofp_action_header actions[0]; /* The action length is inferred
579 from the length field in the
582 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 72);
584 /* Why was this flow removed? */
585 enum ofp_flow_removed_reason {
586 OFPRR_IDLE_TIMEOUT, /* Flow idle time exceeded idle_timeout. */
587 OFPRR_HARD_TIMEOUT, /* Time exceeded hard_timeout. */
588 OFPRR_DELETE /* Evicted by a DELETE flow mod. */
591 /* Flow removed (datapath -> controller). */
592 struct ofp_flow_removed {
593 struct ofp_header header;
594 struct ofp_match match; /* Description of fields. */
595 ovs_be64 cookie; /* Opaque controller-issued identifier. */
597 ovs_be16 priority; /* Priority level of flow entry. */
598 uint8_t reason; /* One of OFPRR_*. */
599 uint8_t pad[1]; /* Align to 32-bits. */
601 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
602 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
604 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
605 uint8_t pad2[2]; /* Align to 64-bits. */
606 ovs_be64 packet_count;
609 OFP_ASSERT(sizeof(struct ofp_flow_removed) == 88);
611 /* OFPT_ERROR: Error message (datapath -> controller). */
612 struct ofp_error_msg {
613 struct ofp_header header;
617 uint8_t data[0]; /* Variable-length data. Interpreted based
618 on the type and code. */
620 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
622 enum ofp_stats_types {
623 /* Description of this OpenFlow switch.
624 * The request is struct ofp_stats_msg.
625 * The reply is struct ofp_desc_stats. */
628 /* Individual flow statistics.
629 * The request is struct ofp_flow_stats_request.
630 * The reply body is an array of struct ofp_flow_stats. */
633 /* Aggregate flow statistics.
634 * The request is struct ofp_flow_stats_request.
635 * The reply is struct ofp_aggregate_stats_reply. */
638 /* Flow table statistics.
639 * The request is struct ofp_stats_msg.
640 * The reply body is an array of struct ofp_table_stats. */
643 /* Physical port statistics.
644 * The request is struct ofp_port_stats_request.
645 * The reply body is an array of struct ofp_port_stats. */
648 /* Queue statistics for a port.
649 * The request body is struct ofp_queue_stats_request.
650 * The reply body is an array of struct ofp_queue_stats. */
654 * The request and reply begin with "struct ofp_vendor_stats". */
655 OFPST_VENDOR = 0xffff
658 /* Statistics request or reply message. */
659 struct ofp_stats_msg {
660 struct ofp_header header;
661 ovs_be16 type; /* One of the OFPST_* constants. */
662 ovs_be16 flags; /* Requests: always 0.
663 * Replies: 0 or OFPSF_REPLY_MORE. */
665 OFP_ASSERT(sizeof(struct ofp_stats_msg) == 12);
667 enum ofp_stats_reply_flags {
668 OFPSF_REPLY_MORE = 1 << 0 /* More replies to follow. */
671 #define DESC_STR_LEN 256
672 #define SERIAL_NUM_LEN 32
673 /* Reply to OFPST_DESC request. Each entry is a NULL-terminated ASCII
675 struct ofp_desc_stats {
676 struct ofp_stats_msg osm;
677 char mfr_desc[DESC_STR_LEN]; /* Manufacturer description. */
678 char hw_desc[DESC_STR_LEN]; /* Hardware description. */
679 char sw_desc[DESC_STR_LEN]; /* Software description. */
680 char serial_num[SERIAL_NUM_LEN]; /* Serial number. */
681 char dp_desc[DESC_STR_LEN]; /* Human readable description of
684 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 1068);
686 /* Stats request of type OFPST_AGGREGATE or OFPST_FLOW. */
687 struct ofp_flow_stats_request {
688 struct ofp_stats_msg osm;
689 struct ofp_match match; /* Fields to match. */
690 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
691 or 0xff for all tables. */
692 uint8_t pad; /* Align to 32 bits. */
693 ovs_be16 out_port; /* Require matching entries to include this
694 as an output port. A value of OFPP_NONE
695 indicates no restriction. */
697 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 56);
699 /* Body of reply to OFPST_FLOW request. */
700 struct ofp_flow_stats {
701 ovs_be16 length; /* Length of this entry. */
702 uint8_t table_id; /* ID of table flow came from. */
704 struct ofp_match match; /* Description of fields. */
705 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
706 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds
707 beyond duration_sec. */
708 ovs_be16 priority; /* Priority of the entry. Only meaningful
709 when this is not an exact-match entry. */
710 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
711 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
712 uint8_t pad2[6]; /* Align to 64 bits. */
713 ovs_32aligned_be64 cookie; /* Opaque controller-issued identifier. */
714 ovs_32aligned_be64 packet_count; /* Number of packets in flow. */
715 ovs_32aligned_be64 byte_count; /* Number of bytes in flow. */
716 struct ofp_action_header actions[0]; /* Actions. */
718 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 88);
720 /* Reply to OFPST_AGGREGATE request. */
721 struct ofp_aggregate_stats_reply {
722 struct ofp_stats_msg osm;
723 ovs_32aligned_be64 packet_count; /* Number of packets in flows. */
724 ovs_32aligned_be64 byte_count; /* Number of bytes in flows. */
725 ovs_be32 flow_count; /* Number of flows. */
726 uint8_t pad[4]; /* Align to 64 bits. */
728 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 36);
730 /* Body of reply to OFPST_TABLE request. */
731 struct ofp_table_stats {
732 uint8_t table_id; /* Identifier of table. Lower numbered tables
733 are consulted first. */
734 uint8_t pad[3]; /* Align to 32-bits. */
735 char name[OFP_MAX_TABLE_NAME_LEN];
736 ovs_be32 wildcards; /* Bitmap of OFPFW_* wildcards that are
737 supported by the table. */
738 ovs_be32 max_entries; /* Max number of entries supported. */
739 ovs_be32 active_count; /* Number of active entries. */
740 ovs_32aligned_be64 lookup_count; /* # of packets looked up in table. */
741 ovs_32aligned_be64 matched_count; /* Number of packets that hit table. */
743 OFP_ASSERT(sizeof(struct ofp_table_stats) == 64);
745 /* Stats request of type OFPST_PORT. */
746 struct ofp_port_stats_request {
747 struct ofp_stats_msg osm;
748 ovs_be16 port_no; /* OFPST_PORT message may request statistics
749 for a single port (specified with port_no)
750 or for all ports (port_no == OFPP_NONE). */
753 OFP_ASSERT(sizeof(struct ofp_port_stats_request) == 20);
755 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
756 * the field to all ones. */
757 struct ofp_port_stats {
759 uint8_t pad[6]; /* Align to 64-bits. */
760 ovs_32aligned_be64 rx_packets; /* Number of received packets. */
761 ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */
762 ovs_32aligned_be64 rx_bytes; /* Number of received bytes. */
763 ovs_32aligned_be64 tx_bytes; /* Number of transmitted bytes. */
764 ovs_32aligned_be64 rx_dropped; /* Number of packets dropped by RX. */
765 ovs_32aligned_be64 tx_dropped; /* Number of packets dropped by TX. */
766 ovs_32aligned_be64 rx_errors; /* Number of receive errors. This is a
767 super-set of receive errors and should be
768 great than or equal to the sum of all
770 ovs_32aligned_be64 tx_errors; /* Number of transmit errors. This is a
771 super-set of transmit errors. */
772 ovs_32aligned_be64 rx_frame_err; /* Number of frame alignment errors. */
773 ovs_32aligned_be64 rx_over_err; /* Number of packets with RX overrun. */
774 ovs_32aligned_be64 rx_crc_err; /* Number of CRC errors. */
775 ovs_32aligned_be64 collisions; /* Number of collisions. */
777 OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
779 /* All ones is used to indicate all queues in a port (for stats retrieval). */
780 #define OFPQ_ALL 0xffffffff
782 /* Body for stats request of type OFPST_QUEUE. */
783 struct ofp_queue_stats_request {
784 struct ofp_stats_msg osm;
785 ovs_be16 port_no; /* All ports if OFPP_ALL. */
786 uint8_t pad[2]; /* Align to 32-bits. */
787 ovs_be32 queue_id; /* All queues if OFPQ_ALL. */
789 OFP_ASSERT(sizeof(struct ofp_queue_stats_request) == 20);
791 /* Body for stats reply of type OFPST_QUEUE consists of an array of this
793 struct ofp_queue_stats {
795 uint8_t pad[2]; /* Align to 32-bits. */
796 ovs_be32 queue_id; /* Queue id. */
797 ovs_32aligned_be64 tx_bytes; /* Number of transmitted bytes. */
798 ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */
799 ovs_32aligned_be64 tx_errors; /* # of packets dropped due to overrun. */
801 OFP_ASSERT(sizeof(struct ofp_queue_stats) == 32);
803 /* Vendor extension stats message. */
804 struct ofp_vendor_stats_msg {
805 struct ofp_stats_msg osm; /* Type OFPST_VENDOR. */
806 ovs_be32 vendor; /* Vendor ID:
807 * - MSB 0: low-order bytes are IEEE OUI.
808 * - MSB != 0: defined by OpenFlow
810 /* Followed by vendor-defined arbitrary additional data. */
812 OFP_ASSERT(sizeof(struct ofp_vendor_stats_msg) == 16);
814 /* Vendor extension. */
815 struct ofp_vendor_header {
816 struct ofp_header header; /* Type OFPT_VENDOR. */
817 ovs_be32 vendor; /* Vendor ID:
818 * - MSB 0: low-order bytes are IEEE OUI.
819 * - MSB != 0: defined by OpenFlow
821 /* Vendor-defined arbitrary additional data. */
823 OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12);
825 #endif /* openflow/openflow.h */