2 * Copyright (c) 2008, 2009 Nicira Networks.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 /* OpenFlow: protocol between controller and datapath. */
19 #ifndef OPENFLOW_OPENFLOW_H
20 #define OPENFLOW_OPENFLOW_H 1
23 #include <linux/types.h>
29 #define OFP_ASSERT(EXPR) /* SWIG can't handle OFP_ASSERT. */
30 #elif !defined(__cplusplus)
31 /* Build-time assertion for use in a declaration context. */
32 #define OFP_ASSERT(EXPR) \
33 extern int (*build_assert(void))[ sizeof(struct { \
34 unsigned int build_assert_failed : (EXPR) ? 1 : -1; })]
35 #else /* __cplusplus */
36 #include <boost/static_assert.hpp>
37 #define OFP_ASSERT BOOST_STATIC_ASSERT
38 #endif /* __cplusplus */
41 #define OFP_PACKED __attribute__((packed))
43 #define OFP_PACKED /* SWIG doesn't understand __attribute. */
46 /* The most significant bit being set in the version field indicates an
47 * experimental OpenFlow version.
49 #define OFP_VERSION 0x97
51 #define OFP_MAX_TABLE_NAME_LEN 32
52 #define OFP_MAX_PORT_NAME_LEN 16
54 #define OFP_TCP_PORT 6633
55 #define OFP_SSL_PORT 6633
57 #define OFP_ETH_ALEN 6 /* Bytes in an Ethernet address. */
59 /* Port numbering. Physical ports are numbered starting from 0. */
61 /* Maximum number of physical switch ports. */
64 /* Fake output "ports". */
65 OFPP_IN_PORT = 0xfff8, /* Send the packet out the input port. This
66 virtual port must be explicitly used
67 in order to send back out of the input
69 OFPP_TABLE = 0xfff9, /* Perform actions in flow table.
70 NB: This can only be the destination
71 port for packet-out messages. */
72 OFPP_NORMAL = 0xfffa, /* Process with normal L2/L3 switching. */
73 OFPP_FLOOD = 0xfffb, /* All physical ports except input port and
74 those disabled by STP. */
75 OFPP_ALL = 0xfffc, /* All physical ports except input port. */
76 OFPP_CONTROLLER = 0xfffd, /* Send to controller. */
77 OFPP_LOCAL = 0xfffe, /* Local openflow "port". */
78 OFPP_NONE = 0xffff /* Not associated with a physical port. */
82 /* Immutable messages. */
83 OFPT_HELLO, /* Symmetric message */
84 OFPT_ERROR, /* Symmetric message */
85 OFPT_ECHO_REQUEST, /* Symmetric message */
86 OFPT_ECHO_REPLY, /* Symmetric message */
87 OFPT_VENDOR, /* Symmetric message */
89 /* Switch configuration messages. */
90 OFPT_FEATURES_REQUEST, /* Controller/switch message */
91 OFPT_FEATURES_REPLY, /* Controller/switch message */
92 OFPT_GET_CONFIG_REQUEST, /* Controller/switch message */
93 OFPT_GET_CONFIG_REPLY, /* Controller/switch message */
94 OFPT_SET_CONFIG, /* Controller/switch message */
96 /* Asynchronous messages. */
97 OFPT_PACKET_IN, /* Async message */
98 OFPT_FLOW_EXPIRED, /* Async message */
99 OFPT_PORT_STATUS, /* Async message */
101 /* Controller command messages. */
102 OFPT_PACKET_OUT, /* Controller/switch message */
103 OFPT_FLOW_MOD, /* Controller/switch message */
104 OFPT_PORT_MOD, /* Controller/switch message */
106 /* Statistics messages. */
107 OFPT_STATS_REQUEST, /* Controller/switch message */
108 OFPT_STATS_REPLY /* Controller/switch message */
111 /* Header on all OpenFlow packets. */
113 uint8_t version; /* OFP_VERSION. */
114 uint8_t type; /* One of the OFPT_ constants. */
115 uint16_t length; /* Length including this ofp_header. */
116 uint32_t xid; /* Transaction id associated with this packet.
117 Replies use the same id as was in the request
118 to facilitate pairing. */
120 OFP_ASSERT(sizeof(struct ofp_header) == 8);
122 /* OFPT_HELLO. This message has an empty body, but implementations must
123 * ignore any data included in the body, to allow for future extensions. */
125 struct ofp_header header;
128 #define OFP_DEFAULT_MISS_SEND_LEN 128
130 enum ofp_config_flags {
131 /* Tells datapath to notify the controller of expired flow entries. */
132 OFPC_SEND_FLOW_EXP = 1 << 0,
134 /* Handling of IP fragments. */
135 OFPC_FRAG_NORMAL = 0 << 1, /* No special handling for fragments. */
136 OFPC_FRAG_DROP = 1 << 1, /* Drop fragments. */
137 OFPC_FRAG_REASM = 2 << 1, /* Reassemble (only if OFPC_IP_REASM set). */
138 OFPC_FRAG_MASK = 3 << 1
141 /* Switch configuration. */
142 struct ofp_switch_config {
143 struct ofp_header header;
144 uint16_t flags; /* OFPC_* flags. */
145 uint16_t 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_MULTI_PHY_TX = 1 << 4, /* Supports transmitting through multiple
157 physical interfaces */
158 OFPC_IP_REASM = 1 << 5 /* Can reassemble IP fragments. */
161 /* Flags to indicate behavior of the physical port. These flags are
162 * used in ofp_phy_port to describe the current configuration. They are
163 * used in the ofp_port_mod message to configure the port's behavior.
165 enum ofp_port_config {
166 OFPPC_PORT_DOWN = 1 << 0, /* Port is administratively down. */
168 OFPPC_NO_STP = 1 << 1, /* Disable 802.1D spanning tree on port. */
169 OFPPC_NO_RECV = 1 << 2, /* Drop most packets received on port. */
170 OFPPC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */
171 OFPPC_NO_FLOOD = 1 << 4, /* Do not include this port when flooding. */
172 OFPPC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */
173 OFPPC_NO_PACKET_IN = 1 << 6 /* Do not send packet-in msgs for port. */
176 /* Current state of the physical port. These are not configurable from
179 enum ofp_port_state {
180 OFPPS_LINK_DOWN = 1 << 0, /* No physical link present. */
182 /* The OFPPS_STP_* bits have no effect on switch operation. The
183 * controller must adjust OFPPC_NO_RECV, OFPPC_NO_FWD, and
184 * OFPPC_NO_PACKET_IN appropriately to fully implement an 802.1D spanning
186 OFPPS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
187 OFPPS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
188 OFPPS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
189 OFPPS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
190 OFPPS_STP_MASK = 3 << 8 /* Bit mask for OFPPS_STP_* values. */
193 /* Features of physical ports available in a datapath. */
194 enum ofp_port_features {
195 OFPPF_10MB_HD = 1 << 0, /* 10 Mb half-duplex rate support. */
196 OFPPF_10MB_FD = 1 << 1, /* 10 Mb full-duplex rate support. */
197 OFPPF_100MB_HD = 1 << 2, /* 100 Mb half-duplex rate support. */
198 OFPPF_100MB_FD = 1 << 3, /* 100 Mb full-duplex rate support. */
199 OFPPF_1GB_HD = 1 << 4, /* 1 Gb half-duplex rate support. */
200 OFPPF_1GB_FD = 1 << 5, /* 1 Gb full-duplex rate support. */
201 OFPPF_10GB_FD = 1 << 6, /* 10 Gb full-duplex rate support. */
202 OFPPF_COPPER = 1 << 7, /* Copper medium. */
203 OFPPF_FIBER = 1 << 8, /* Fiber medium. */
204 OFPPF_AUTONEG = 1 << 9, /* Auto-negotiation. */
205 OFPPF_PAUSE = 1 << 10, /* Pause. */
206 OFPPF_PAUSE_ASYM = 1 << 11 /* Asymmetric pause. */
209 /* Description of a physical port */
210 struct ofp_phy_port {
212 uint8_t hw_addr[OFP_ETH_ALEN];
213 uint8_t name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
215 uint32_t config; /* Bitmap of OFPPC_* flags. */
216 uint32_t state; /* Bitmap of OFPPS_* flags. */
218 /* Bitmaps of OFPPF_* that describe features. All bits zeroed if
219 * unsupported or unavailable. */
220 uint32_t curr; /* Current features. */
221 uint32_t advertised; /* Features being advertised by the port. */
222 uint32_t supported; /* Features supported by the port. */
223 uint32_t peer; /* Features advertised by peer. */
225 OFP_ASSERT(sizeof(struct ofp_phy_port) == 48);
227 /* Switch features. */
228 struct ofp_switch_features {
229 struct ofp_header header;
230 uint64_t datapath_id; /* Datapath unique ID. Only the lower 48-bits
233 uint32_t n_buffers; /* Max packets buffered at once. */
235 uint8_t n_tables; /* Number of tables supported by datapath. */
236 uint8_t pad[3]; /* Align to 64-bits. */
239 uint32_t capabilities; /* Bitmap of support "ofp_capabilities". */
240 uint32_t actions; /* Bitmap of supported "ofp_action_type"s. */
243 struct ofp_phy_port ports[0]; /* Port definitions. The number of ports
244 is inferred from the length field in
247 OFP_ASSERT(sizeof(struct ofp_switch_features) == 32);
249 /* What changed about the physical port */
250 enum ofp_port_reason {
251 OFPPR_ADD, /* The port was added. */
252 OFPPR_DELETE, /* The port was removed. */
253 OFPPR_MODIFY /* Some attribute of the port has changed. */
256 /* A physical port has changed in the datapath */
257 struct ofp_port_status {
258 struct ofp_header header;
259 uint8_t reason; /* One of OFPPR_*. */
260 uint8_t pad[7]; /* Align to 64-bits. */
261 struct ofp_phy_port desc;
263 OFP_ASSERT(sizeof(struct ofp_port_status) == 64);
265 /* Modify behavior of the physical port */
266 struct ofp_port_mod {
267 struct ofp_header header;
269 uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
270 configurable. This is used to
271 sanity-check the request, so it must
272 be the same as returned in an
273 ofp_phy_port struct. */
275 uint32_t config; /* Bitmap of OFPPC_* flags. */
276 uint32_t mask; /* Bitmap of OFPPC_* flags to be changed. */
278 uint32_t advertise; /* Bitmap of "ofp_port_features"s. Zero all
279 bits to prevent any action taking place. */
280 uint8_t pad[4]; /* Pad to 64-bits. */
282 OFP_ASSERT(sizeof(struct ofp_port_mod) == 32);
284 /* Why is this packet being sent to the controller? */
285 enum ofp_packet_in_reason {
286 OFPR_NO_MATCH, /* No matching flow. */
287 OFPR_ACTION /* Action explicitly output to controller. */
290 /* Packet received on port (datapath -> controller). */
291 struct ofp_packet_in {
292 struct ofp_header header;
293 uint32_t buffer_id; /* ID assigned by datapath. */
294 uint16_t total_len; /* Full length of frame. */
295 uint16_t in_port; /* Port on which frame was received. */
296 uint8_t reason; /* Reason packet is being sent (one of OFPR_*) */
298 uint8_t data[0]; /* Ethernet frame, halfway through 32-bit word,
299 so the IP header is 32-bit aligned. The
300 amount of data is inferred from the length
301 field in the header. Because of padding,
302 offsetof(struct ofp_packet_in, data) ==
303 sizeof(struct ofp_packet_in) - 2. */
305 OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
307 enum ofp_action_type {
308 OFPAT_OUTPUT, /* Output to switch port. */
309 OFPAT_SET_VLAN_VID, /* Set the 802.1q VLAN id. */
310 OFPAT_SET_VLAN_PCP, /* Set the 802.1q priority. */
311 OFPAT_STRIP_VLAN, /* Strip the 802.1q header. */
312 OFPAT_SET_DL_SRC, /* Ethernet source address. */
313 OFPAT_SET_DL_DST, /* Ethernet destination address. */
314 OFPAT_SET_NW_SRC, /* IP source address. */
315 OFPAT_SET_NW_DST, /* IP destination address. */
316 OFPAT_SET_TP_SRC, /* TCP/UDP source port. */
317 OFPAT_SET_TP_DST, /* TCP/UDP destination port. */
318 OFPAT_VENDOR = 0xffff
321 /* Action structure for OFPAT_OUTPUT, which sends packets out 'port'.
322 * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
323 * number of bytes to send. A 'max_len' of zero means no bytes of the
324 * packet should be sent. */
325 struct ofp_action_output {
326 uint16_t type; /* OFPAT_OUTPUT. */
327 uint16_t len; /* Length is 8. */
328 uint16_t port; /* Output port. */
329 uint16_t max_len; /* Max length to send to controller. */
331 OFP_ASSERT(sizeof(struct ofp_action_output) == 8);
333 /* The VLAN id is 12 bits, so we can use the entire 16 bits to indicate
334 * special conditions. All ones is used to match that no VLAN id was
336 #define OFP_VLAN_NONE 0xffff
338 /* Action structure for OFPAT_SET_VLAN_VID. */
339 struct ofp_action_vlan_vid {
340 uint16_t type; /* OFPAT_SET_VLAN_VID. */
341 uint16_t len; /* Length is 8. */
342 uint16_t vlan_vid; /* VLAN id. */
345 OFP_ASSERT(sizeof(struct ofp_action_vlan_vid) == 8);
347 /* Action structure for OFPAT_SET_VLAN_PCP. */
348 struct ofp_action_vlan_pcp {
349 uint16_t type; /* OFPAT_SET_VLAN_PCP. */
350 uint16_t len; /* Length is 8. */
351 uint8_t vlan_pcp; /* VLAN priority. */
354 OFP_ASSERT(sizeof(struct ofp_action_vlan_pcp) == 8);
356 /* Action structure for OFPAT_SET_DL_SRC/DST. */
357 struct ofp_action_dl_addr {
358 uint16_t type; /* OFPAT_SET_DL_SRC/DST. */
359 uint16_t len; /* Length is 16. */
360 uint8_t dl_addr[OFP_ETH_ALEN]; /* Ethernet address. */
363 OFP_ASSERT(sizeof(struct ofp_action_dl_addr) == 16);
365 /* Action structure for OFPAT_SET_NW_SRC/DST. */
366 struct ofp_action_nw_addr {
367 uint16_t type; /* OFPAT_SET_TW_SRC/DST. */
368 uint16_t len; /* Length is 8. */
369 uint32_t nw_addr; /* IP address. */
371 OFP_ASSERT(sizeof(struct ofp_action_nw_addr) == 8);
373 /* Action structure for OFPAT_SET_TP_SRC/DST. */
374 struct ofp_action_tp_port {
375 uint16_t type; /* OFPAT_SET_TP_SRC/DST. */
376 uint16_t len; /* Length is 8. */
377 uint16_t tp_port; /* TCP/UDP port. */
380 OFP_ASSERT(sizeof(struct ofp_action_tp_port) == 8);
382 /* Action header for OFPAT_VENDOR. The rest of the body is vendor-defined. */
383 struct ofp_action_vendor_header {
384 uint16_t type; /* OFPAT_VENDOR. */
385 uint16_t len; /* Length is a multiple of 8. */
386 uint32_t vendor; /* Vendor ID, which takes the same form
387 as in "struct ofp_vendor_header". */
389 OFP_ASSERT(sizeof(struct ofp_action_vendor_header) == 8);
391 /* Action header that is common to all actions. The length includes the
392 * header and any padding used to make the action 64-bit aligned.
393 * NB: The length of an action *must* always be a multiple of eight. */
394 struct ofp_action_header {
395 uint16_t type; /* One of OFPAT_*. */
396 uint16_t len; /* Length of action, including this
397 header. This is the length of action,
398 including any padding to make it
402 OFP_ASSERT(sizeof(struct ofp_action_header) == 8);
406 struct ofp_action_header header;
407 struct ofp_action_vendor_header vendor;
408 struct ofp_action_output output;
409 struct ofp_action_vlan_vid vlan_vid;
410 struct ofp_action_vlan_pcp vlan_pcp;
411 struct ofp_action_nw_addr nw_addr;
412 struct ofp_action_tp_port tp_port;
414 OFP_ASSERT(sizeof(union ofp_action) == 8);
416 /* Send packet (controller -> datapath). */
417 struct ofp_packet_out {
418 struct ofp_header header;
419 uint32_t buffer_id; /* ID assigned by datapath (-1 if none). */
420 uint16_t in_port; /* Packet's input port (OFPP_NONE if none). */
421 uint16_t actions_len; /* Size of action array in bytes. */
422 struct ofp_action_header actions[0]; /* Actions. */
423 /* uint8_t data[0]; */ /* Packet data. The length is inferred
424 from the length field in the header.
425 (Only meaningful if buffer_id == -1.) */
427 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
429 enum ofp_flow_mod_command {
430 OFPFC_ADD, /* New flow. */
431 OFPFC_MODIFY, /* Modify all matching flows. */
432 OFPFC_MODIFY_STRICT, /* Modify entry strictly matching wildcards */
433 OFPFC_DELETE, /* Delete all matching flows. */
434 OFPFC_DELETE_STRICT /* Strictly match wildcards and priority. */
437 /* Flow wildcards. */
438 enum ofp_flow_wildcards {
439 OFPFW_IN_PORT = 1 << 0, /* Switch input port. */
440 OFPFW_DL_VLAN = 1 << 1, /* VLAN. */
441 OFPFW_DL_SRC = 1 << 2, /* Ethernet source address. */
442 OFPFW_DL_DST = 1 << 3, /* Ethernet destination address. */
443 OFPFW_DL_TYPE = 1 << 4, /* Ethernet frame type. */
444 OFPFW_NW_PROTO = 1 << 5, /* IP protocol. */
445 OFPFW_TP_SRC = 1 << 6, /* TCP/UDP source port. */
446 OFPFW_TP_DST = 1 << 7, /* TCP/UDP destination port. */
448 /* IP source address wildcard bit count. 0 is exact match, 1 ignores the
449 * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
450 * the entire field. This is the *opposite* of the usual convention where
451 * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
452 OFPFW_NW_SRC_SHIFT = 8,
453 OFPFW_NW_SRC_BITS = 6,
454 OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
455 OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
457 /* IP destination address wildcard bit count. Same format as source. */
458 OFPFW_NW_DST_SHIFT = 14,
459 OFPFW_NW_DST_BITS = 6,
460 OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
461 OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
463 /* Wildcard all fields. */
464 OFPFW_ALL = ((1 << 20) - 1)
467 /* The wildcards for ICMP type and code fields use the transport source
468 * and destination port fields, respectively. */
469 #define OFPFW_ICMP_TYPE OFPFW_TP_SRC
470 #define OFPFW_ICMP_CODE OFPFW_TP_DST
472 /* Values below this cutoff are 802.3 packets and the two bytes
473 * following MAC addresses are used as a frame length. Otherwise, the
474 * two bytes are used as the Ethernet type.
476 #define OFP_DL_TYPE_ETH2_CUTOFF 0x0600
478 /* Value of dl_type to indicate that the frame does not include an
481 #define OFP_DL_TYPE_NOT_ETH_TYPE 0x05ff
483 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
484 * special conditions. All ones indicates that no VLAN id was set.
486 #define OFP_VLAN_NONE 0xffff
488 /* Fields to match against flows */
490 uint32_t wildcards; /* Wildcard fields. */
491 uint16_t in_port; /* Input switch port. */
492 uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
493 uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
494 uint16_t dl_vlan; /* Input VLAN. */
495 uint16_t dl_type; /* Ethernet frame type. */
496 uint8_t nw_proto; /* IP protocol. */
497 uint8_t pad; /* Align to 32-bits. */
498 uint32_t nw_src; /* IP source address. */
499 uint32_t nw_dst; /* IP destination address. */
500 uint16_t tp_src; /* TCP/UDP source port. */
501 uint16_t tp_dst; /* TCP/UDP destination port. */
503 OFP_ASSERT(sizeof(struct ofp_match) == 36);
505 /* The match fields for ICMP type and code use the transport source and
506 * destination port fields, respectively. */
507 #define icmp_type tp_src
508 #define icmp_code tp_dst
510 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
512 #define OFP_FLOW_PERMANENT 0
514 /* By default, choose a priority in the middle. */
515 #define OFP_DEFAULT_PRIORITY 0x8000
517 /* Flow setup and teardown (controller -> datapath). */
518 struct ofp_flow_mod {
519 struct ofp_header header;
520 struct ofp_match match; /* Fields to match */
523 uint16_t command; /* One of OFPFC_*. */
524 uint16_t idle_timeout; /* Idle time before discarding (seconds). */
525 uint16_t hard_timeout; /* Max time before discarding (seconds). */
526 uint16_t priority; /* Priority level of flow entry. */
527 uint32_t buffer_id; /* Buffered packet to apply to (or -1).
528 Not meaningful for OFPFC_DELETE*. */
529 uint16_t out_port; /* For OFPFC_DELETE* commands, require
530 matching entries to include this as an
531 output port. A value of OFPP_NONE
532 indicates no restriction. */
533 uint8_t pad[2]; /* Align to 32-bits. */
534 uint32_t reserved; /* Reserved for future use. */
535 struct ofp_action_header actions[0]; /* The action length is inferred
536 from the length field in the
539 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 64);
541 /* Why did this flow expire? */
542 enum ofp_flow_expired_reason {
543 OFPER_IDLE_TIMEOUT, /* Flow idle time exceeded idle_timeout. */
544 OFPER_HARD_TIMEOUT /* Time exceeded hard_timeout. */
547 /* Flow expiration (datapath -> controller). */
548 struct ofp_flow_expired {
549 struct ofp_header header;
550 struct ofp_match match; /* Description of fields. */
552 uint16_t priority; /* Priority level of flow entry. */
553 uint8_t reason; /* One of OFPER_*. */
554 uint8_t pad[1]; /* Align to 32-bits. */
556 uint32_t duration; /* Time flow was alive in seconds. */
557 uint8_t pad2[4]; /* Align to 64-bits. */
558 uint64_t packet_count;
561 OFP_ASSERT(sizeof(struct ofp_flow_expired) == 72);
563 /* Values for 'type' in ofp_error_message. These values are immutable: they
564 * will not change in future versions of the protocol (although new values may
566 enum ofp_error_type {
567 OFPET_HELLO_FAILED, /* Hello protocol failed. */
568 OFPET_BAD_REQUEST, /* Request was not understood. */
569 OFPET_BAD_ACTION, /* Error in action description. */
570 OFPET_FLOW_MOD_FAILED, /* Problem modifying flow entry. */
571 OFPET_PORT_MOD_FAILED /* OFPT_PORT_MOD failed. */
574 /* ofp_error_msg 'code' values for OFPET_HELLO_FAILED. 'data' contains an
575 * ASCII text string that may give failure details. */
576 enum ofp_hello_failed_code {
577 OFPHFC_INCOMPATIBLE /* No compatible version. */
580 /* ofp_error_msg 'code' values for OFPET_BAD_REQUEST. 'data' contains at least
581 * the first 64 bytes of the failed request. */
582 enum ofp_bad_request_code {
583 OFPBRC_BAD_VERSION, /* ofp_header.version not supported. */
584 OFPBRC_BAD_TYPE, /* ofp_header.type not supported. */
585 OFPBRC_BAD_STAT, /* ofp_stats_request.type not supported. */
586 OFPBRC_BAD_VENDOR, /* Vendor not supported (in ofp_vendor_header
587 * or ofp_stats_request or ofp_stats_reply). */
588 OFPBRC_BAD_SUBTYPE, /* Vendor subtype not supported. */
589 OFPBRC_BAD_LENGTH, /* Wrong request length for type. */
590 OFPBRC_BUFFER_EMPTY, /* Specified buffer has already been used. */
591 OFPBRC_BAD_COOKIE /* Specified buffer does not exist. */
594 /* ofp_error_msg 'code' values for OFPET_BAD_ACTION. 'data' contains at least
595 * the first 64 bytes of the failed request. */
596 enum ofp_bad_action_code {
597 OFPBAC_BAD_TYPE, /* Unknown action type. */
598 OFPBAC_BAD_LEN, /* Length problem in actions. */
599 OFPBAC_BAD_VENDOR, /* Unknown vendor id specified. */
600 OFPBAC_BAD_VENDOR_TYPE, /* Unknown action type for vendor id. */
601 OFPBAC_BAD_OUT_PORT, /* Problem validating output action. */
602 OFPBAC_BAD_ARGUMENT, /* Bad action argument. */
603 OFPBAC_TOO_MANY /* Can't handle this many actions. */
606 /* ofp_error_msg 'code' values for OFPET_FLOW_MOD_FAILED. 'data' contains
607 * at least the first 64 bytes of the failed request. */
608 enum ofp_flow_mod_failed_code {
609 OFPFMFC_ALL_TABLES_FULL, /* Flow not added because of full tables. */
610 OFPFMFC_BAD_COMMAND /* Unknown command. */
613 /* ofp_error_msg 'code' values for OFPET_PORT_MOD_FAILED. 'data' contains
614 * at least the first 64 bytes of the failed request. */
615 enum ofp_port_mod_failed_code {
616 OFPPMFC_BAD_PORT, /* Specified port does not exist. */
617 OFPPMFC_BAD_HW_ADDR, /* Specified hardware address is wrong. */
620 /* OFPT_ERROR: Error message (datapath -> controller). */
621 struct ofp_error_msg {
622 struct ofp_header header;
626 uint8_t data[0]; /* Variable-length data. Interpreted based
627 on the type and code. */
629 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
631 enum ofp_stats_types {
632 /* Description of this OpenFlow switch.
633 * The request body is empty.
634 * The reply body is struct ofp_desc_stats. */
637 /* Individual flow statistics.
638 * The request body is struct ofp_flow_stats_request.
639 * The reply body is an array of struct ofp_flow_stats. */
642 /* Aggregate flow statistics.
643 * The request body is struct ofp_aggregate_stats_request.
644 * The reply body is struct ofp_aggregate_stats_reply. */
647 /* Flow table statistics.
648 * The request body is empty.
649 * The reply body is an array of struct ofp_table_stats. */
652 /* Physical port statistics.
653 * The request body is empty.
654 * The reply body is an array of struct ofp_port_stats. */
658 * The request and reply bodies begin with a 32-bit vendor ID, which takes
659 * the same form as in "struct ofp_vendor_header". The request and reply
660 * bodies are otherwise vendor-defined. */
661 OFPST_VENDOR = 0xffff
664 struct ofp_stats_request {
665 struct ofp_header header;
666 uint16_t type; /* One of the OFPST_* constants. */
667 uint16_t flags; /* OFPSF_REQ_* flags (none yet defined). */
668 uint8_t body[0]; /* Body of the request. */
670 OFP_ASSERT(sizeof(struct ofp_stats_request) == 12);
672 enum ofp_stats_reply_flags {
673 OFPSF_REPLY_MORE = 1 << 0 /* More replies to follow. */
676 struct ofp_stats_reply {
677 struct ofp_header header;
678 uint16_t type; /* One of the OFPST_* constants. */
679 uint16_t flags; /* OFPSF_REPLY_* flags. */
680 uint8_t body[0]; /* Body of the reply. */
682 OFP_ASSERT(sizeof(struct ofp_stats_reply) == 12);
684 #define DESC_STR_LEN 256
685 #define SERIAL_NUM_LEN 32
686 /* Body of reply to OFPST_DESC request. Each entry is a NULL-terminated
688 struct ofp_desc_stats {
689 char mfr_desc[DESC_STR_LEN]; /* Manufacturer description. */
690 char hw_desc[DESC_STR_LEN]; /* Hardware description. */
691 char sw_desc[DESC_STR_LEN]; /* Software description. */
692 char serial_num[SERIAL_NUM_LEN]; /* Serial number. */
694 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 800);
696 /* Body for ofp_stats_request of type OFPST_FLOW. */
697 struct ofp_flow_stats_request {
698 struct ofp_match match; /* Fields to match. */
699 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
700 or 0xff for all tables. */
701 uint8_t pad; /* Align to 32 bits. */
702 uint16_t out_port; /* Require matching entries to include this
703 as an output port. A value of OFPP_NONE
704 indicates no restriction. */
706 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 40);
708 /* Body of reply to OFPST_FLOW request. */
709 struct ofp_flow_stats {
710 uint16_t length; /* Length of this entry. */
711 uint8_t table_id; /* ID of table flow came from. */
713 struct ofp_match match; /* Description of fields. */
714 uint32_t duration; /* Time flow has been alive in seconds. */
715 uint16_t priority; /* Priority of the entry. Only meaningful
716 when this is not an exact-match entry. */
717 uint16_t idle_timeout; /* Number of seconds idle before expiration. */
718 uint16_t hard_timeout; /* Number of seconds before expiration. */
719 uint16_t pad2[3]; /* Pad to 64 bits. */
720 uint64_t packet_count; /* Number of packets in flow. */
721 uint64_t byte_count; /* Number of bytes in flow. */
722 struct ofp_action_header actions[0]; /* Actions. */
724 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 72);
726 /* Body for ofp_stats_request of type OFPST_AGGREGATE. */
727 struct ofp_aggregate_stats_request {
728 struct ofp_match match; /* Fields to match. */
729 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
730 or 0xff for all tables. */
731 uint8_t pad; /* Align to 32 bits. */
732 uint16_t out_port; /* Require matching entries to include this
733 as an output port. A value of OFPP_NONE
734 indicates no restriction. */
736 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 40);
738 /* Body of reply to OFPST_AGGREGATE request. */
739 struct ofp_aggregate_stats_reply {
740 uint64_t packet_count; /* Number of packets in flows. */
741 uint64_t byte_count; /* Number of bytes in flows. */
742 uint32_t flow_count; /* Number of flows. */
743 uint8_t pad[4]; /* Align to 64 bits. */
745 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
747 /* Body of reply to OFPST_TABLE request. */
748 struct ofp_table_stats {
749 uint8_t table_id; /* Identifier of table. Lower numbered tables
750 are consulted first. */
751 uint8_t pad[3]; /* Align to 32-bits. */
752 char name[OFP_MAX_TABLE_NAME_LEN];
753 uint32_t wildcards; /* Bitmap of OFPFW_* wildcards that are
754 supported by the table. */
755 uint32_t max_entries; /* Max number of entries supported. */
756 uint32_t active_count; /* Number of active entries. */
757 uint64_t lookup_count; /* Number of packets looked up in table. */
758 uint64_t matched_count; /* Number of packets that hit table. */
760 OFP_ASSERT(sizeof(struct ofp_table_stats) == 64);
762 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
763 * the field to all ones. */
764 struct ofp_port_stats {
766 uint8_t pad[6]; /* Align to 64-bits. */
767 uint64_t rx_packets; /* Number of received packets. */
768 uint64_t tx_packets; /* Number of transmitted packets. */
769 uint64_t rx_bytes; /* Number of received bytes. */
770 uint64_t tx_bytes; /* Number of transmitted bytes. */
771 uint64_t rx_dropped; /* Number of packets dropped by RX. */
772 uint64_t tx_dropped; /* Number of packets dropped by TX. */
773 uint64_t rx_errors; /* Number of receive errors. This is a super-set
774 of receive errors and should be great than or
775 equal to the sum of all rx_*_err values. */
776 uint64_t tx_errors; /* Number of transmit errors. This is a super-set
777 of transmit errors. */
778 uint64_t rx_frame_err; /* Number of frame alignment errors. */
779 uint64_t rx_over_err; /* Number of packets with RX overrun. */
780 uint64_t rx_crc_err; /* Number of CRC errors. */
781 uint64_t collisions; /* Number of collisions. */
783 OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
785 /* Vendor extension. */
786 struct ofp_vendor_header {
787 struct ofp_header header; /* Type OFPT_VENDOR. */
788 uint32_t vendor; /* Vendor ID:
789 * - MSB 0: low-order bytes are IEEE OUI.
790 * - MSB != 0: defined by OpenFlow
792 /* Vendor-defined arbitrary additional data. */
794 OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12);
796 #endif /* openflow/openflow.h */