1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
4 * We are making the OpenFlow specification and associated documentation
5 * (Software) available for public use and benefit with the expectation
6 * that others will use, modify and enhance the Software and contribute
7 * those enhancements back to the community. However, since we would
8 * like to make the Software available for broadest use, with as few
9 * restrictions as possible permission is hereby granted, free of
10 * charge, to any person obtaining a copy of this Software to deal in
11 * the Software under the copyrights without restriction, including
12 * without limitation the rights to use, copy, modify, merge, publish,
13 * distribute, sublicense, and/or sell copies of the Software, and to
14 * permit persons to whom the Software is furnished to do so, subject to
15 * the following conditions:
17 * The above copyright notice and this permission notice shall be
18 * included in all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 * The name and trademarks of copyright holder(s) may NOT be used in
30 * advertising or publicity pertaining to the Software or any
31 * derivatives without specific, written prior permission.
34 /* OpenFlow: protocol between controller and datapath. */
40 #include <linux/types.h>
46 #define OFP_ASSERT(EXPR) /* SWIG can't handle OFP_ASSERT. */
47 #elif !defined(__cplusplus)
48 /* Build-time assertion for use in a declaration context. */
49 #define OFP_ASSERT(EXPR) \
50 extern int (*build_assert(void))[ sizeof(struct { \
51 unsigned int build_assert_failed : (EXPR) ? 1 : -1; })]
52 #else /* __cplusplus */
53 #include <boost/static_assert.hpp>
54 #define OFP_ASSERT BOOST_STATIC_ASSERT
55 #endif /* __cplusplus */
58 #define OFP_PACKED __attribute__((packed))
60 #define OFP_PACKED /* SWIG doesn't understand __attribute. */
63 /* The most significant bit being set in the version field indicates an
64 * experimental OpenFlow version.
66 #define OFP_VERSION 0x90
68 #define OFP_MAX_TABLE_NAME_LEN 32
69 #define OFP_MAX_PORT_NAME_LEN 16
71 #define OFP_TCP_PORT 975
72 #define OFP_SSL_PORT 976
74 #define OFP_ETH_ALEN 6 /* Bytes in an Ethernet address. */
76 /* Port numbering. Physical ports are numbered starting from 0. */
78 /* Maximum number of physical switch ports. */
81 /* Fake output "ports". */
82 OFPP_IN_PORT = 0xfff8, /* Send the packet out the input port. This
83 virtual port must be explicitly used
84 in order to send back out of the input
86 OFPP_TABLE = 0xfff9, /* Perform actions in flow table.
87 NB: This can only be the destination
88 port for packet-out messages. */
89 OFPP_NORMAL = 0xfffa, /* Process with normal L2/L3 switching. */
90 OFPP_FLOOD = 0xfffb, /* All physical ports except input port and
91 those disabled by STP. */
92 OFPP_ALL = 0xfffc, /* All physical ports except input port. */
93 OFPP_CONTROLLER = 0xfffd, /* Send to controller. */
94 OFPP_LOCAL = 0xfffe, /* Local openflow "port". */
95 OFPP_NONE = 0xffff /* Not associated with a physical port. */
99 OFPT_FEATURES_REQUEST, /* 0 Controller/switch message */
100 OFPT_FEATURES_REPLY, /* 1 Controller/switch message */
101 OFPT_GET_CONFIG_REQUEST, /* 2 Controller/switch message */
102 OFPT_GET_CONFIG_REPLY, /* 3 Controller/switch message */
103 OFPT_SET_CONFIG, /* 4 Controller/switch message */
104 OFPT_PACKET_IN, /* 5 Async message */
105 OFPT_PACKET_OUT, /* 6 Controller/switch message */
106 OFPT_FLOW_MOD, /* 7 Controller/switch message */
107 OFPT_FLOW_EXPIRED, /* 8 Async message */
108 OFPT_TABLE, /* 9 Controller/switch message */
109 OFPT_PORT_MOD, /* 10 Controller/switch message */
110 OFPT_PORT_STATUS, /* 11 Async message */
111 OFPT_ERROR_MSG, /* 12 Async message */
112 OFPT_STATS_REQUEST, /* 13 Controller/switch message */
113 OFPT_STATS_REPLY, /* 14 Controller/switch message */
114 OFPT_ECHO_REQUEST, /* 15 Symmetric message */
115 OFPT_ECHO_REPLY, /* 16 Symmetric message */
116 OFPT_VENDOR = 0xff /* 255 Vendor extension */
119 /* Header on all OpenFlow packets. */
121 uint8_t version; /* OFP_VERSION. */
122 uint8_t type; /* One of the OFPT_ constants. */
123 uint16_t length; /* Length including this ofp_header. */
124 uint32_t xid; /* Transactin id associated with this packet.
125 Replies use the same id as was in the request
126 to facilitate pairing. */
128 OFP_ASSERT(sizeof(struct ofp_header) == 8);
130 #define OFP_DEFAULT_MISS_SEND_LEN 128
132 enum ofp_config_flags {
133 /* Tells datapath to notify the controller of expired flow entries. */
134 OFPC_SEND_FLOW_EXP = 1 << 0,
136 /* Handling of IP fragments. */
137 OFPC_FRAG_NORMAL = 0 << 1, /* No special handling for fragments. */
138 OFPC_FRAG_DROP = 1 << 1, /* Drop fragments. */
139 OFPC_FRAG_REASM = 2 << 1, /* Reassemble (only if OFPC_IP_REASM set). */
140 OFPC_FRAG_MASK = 3 << 1
143 /* Switch configuration. */
144 struct ofp_switch_config {
145 struct ofp_header header;
146 uint16_t flags; /* OFPC_* flags. */
147 uint16_t miss_send_len; /* Max bytes of new flow that datapath should
148 send to the controller. */
150 OFP_ASSERT(sizeof(struct ofp_switch_config) == 12);
152 /* Capabilities supported by the datapath. */
153 enum ofp_capabilities {
154 OFPC_FLOW_STATS = 1 << 0, /* Flow statistics. */
155 OFPC_TABLE_STATS = 1 << 1, /* Table statistics. */
156 OFPC_PORT_STATS = 1 << 2, /* Port statistics. */
157 OFPC_STP = 1 << 3, /* 802.11d spanning tree. */
158 OFPC_MULTI_PHY_TX = 1 << 4, /* Supports transmitting through multiple
159 physical interfaces */
160 OFPC_IP_REASM = 1 << 5 /* Can reassemble IP fragments. */
163 /* Flags to indicate behavior of the physical port. */
164 enum ofp_port_flags {
165 /* Read/write bits. */
166 OFPPFL_PORT_DOWN = 1 << 1, /* Port is configured down. */
167 OFPPFL_NO_STP = 1 << 3, /* Disable 802.1D spanning tree on port. */
168 OFPPFL_NO_RECV = 1 << 4, /* Drop most packets received on port. */
169 OFPPFL_NO_RECV_STP = 1 << 5, /* Drop received 802.1D STP packets. */
170 OFPPFL_NO_FWD = 1 << 6, /* Drop packets forwarded to port. */
171 OFPPFL_NO_PACKET_IN = 1 << 7, /* Do not send packet-in msgs for port. */
173 /* Read-only bits. */
174 OFPPFL_LINK_DOWN = 1 << 2, /* No physical link present. */
176 /* Read-only when STP is enabled (when OFPPFL_NO_STP is not set).
177 * Read/write when STP is disabled (when OFPPFL_NO_STP is set).
179 * The OFPPFL_STP_* bits have no effect on switch operation. The
180 * controller must adjust OFPPFL_NO_RECV, OFPPFL_NO_FWD, and
181 * OFPPFL_NO_PACKET_IN appropriately to fully implement an 802.1D spanning
183 OFPPFL_NO_FLOOD = 1 << 0, /* Do not include this port when flooding. */
184 OFPPFL_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
185 OFPPFL_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
186 OFPPFL_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
187 OFPPFL_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
188 OFPPFL_STP_MASK = 3 << 8, /* Bit mask for OFPPFL_STP_* values. */
191 /* Features of physical ports available in a datapath. */
192 enum ofp_port_features {
193 OFPPF_10MB_HD = 1 << 0, /* 10 Mb half-duplex rate support. */
194 OFPPF_10MB_FD = 1 << 1, /* 10 Mb full-duplex rate support. */
195 OFPPF_100MB_HD = 1 << 2, /* 100 Mb half-duplex rate support. */
196 OFPPF_100MB_FD = 1 << 3, /* 100 Mb full-duplex rate support. */
197 OFPPF_1GB_HD = 1 << 4, /* 1 Gb half-duplex rate support. */
198 OFPPF_1GB_FD = 1 << 5, /* 1 Gb full-duplex rate support. */
199 OFPPF_10GB_FD = 1 << 6, /* 10 Gb full-duplex rate support. */
200 OFPPF_STP = 1 << 7, /* 802.1D spanning tree supported on port. */
204 /* Description of a physical port */
205 struct ofp_phy_port {
207 uint8_t hw_addr[OFP_ETH_ALEN];
208 uint8_t name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
209 uint32_t flags; /* Bitmap of "ofp_port_flags". */
210 uint32_t speed; /* Current speed in Mbps */
211 uint32_t features; /* Bitmap of supported "ofp_port_features"s. */
213 OFP_ASSERT(sizeof(struct ofp_phy_port) == 36);
215 /* Switch features. */
216 struct ofp_switch_features {
217 struct ofp_header header;
218 uint64_t datapath_id; /* Datapath unique ID. Only the lower 48-bits
221 uint32_t n_buffers; /* Max packets buffered at once. */
223 uint8_t n_tables; /* Number of tables supported by datapath. */
224 uint8_t pad[3]; /* Align to 64-bits. */
227 uint32_t capabilities; /* Bitmap of support "ofp_capabilities". */
228 uint32_t actions; /* Bitmap of supported "ofp_action_type"s. */
231 struct ofp_phy_port ports[0]; /* Port definitions. The number of ports
232 is inferred from the length field in
235 OFP_ASSERT(sizeof(struct ofp_switch_features) == 32);
237 /* What changed about the physical port */
238 enum ofp_port_reason {
239 OFPPR_ADD, /* The port was added */
240 OFPPR_DELETE, /* The port was removed */
241 OFPPR_MOD /* Some attribute of the port has changed */
244 /* A physical port has changed in the datapath */
245 struct ofp_port_status {
246 struct ofp_header header;
247 uint8_t reason; /* One of OFPPR_* */
248 uint8_t pad[3]; /* Align to 32-bits */
249 struct ofp_phy_port desc;
251 OFP_ASSERT(sizeof(struct ofp_port_status) == 48);
253 /* Modify behavior of the physical port */
254 struct ofp_port_mod {
255 struct ofp_header header;
256 uint32_t mask; /* Bitmap of "ofp_port_flags" that should be
258 struct ofp_phy_port desc;
260 OFP_ASSERT(sizeof(struct ofp_port_mod) == 48);
262 /* Why is this packet being sent to the controller? */
263 enum ofp_packet_in_reason {
264 OFPR_NO_MATCH, /* No matching flow. */
265 OFPR_ACTION /* Action explicitly output to controller. */
268 /* Packet received on port (datapath -> controller). */
269 struct ofp_packet_in {
270 struct ofp_header header;
271 uint32_t buffer_id; /* ID assigned by datapath. */
272 uint16_t total_len; /* Full length of frame. */
273 uint16_t in_port; /* Port on which frame was received. */
274 uint8_t reason; /* Reason packet is being sent (one of OFPR_*) */
276 uint8_t data[0]; /* Ethernet frame, halfway through 32-bit word,
277 so the IP header is 32-bit aligned. The
278 amount of data is inferred from the length
279 field in the header. Because of padding,
280 offsetof(struct ofp_packet_in, data) ==
281 sizeof(struct ofp_packet_in) - 2. */
283 OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
285 enum ofp_action_type {
286 OFPAT_OUTPUT, /* Output to switch port. */
287 OFPAT_SET_DL_VLAN, /* VLAN. */
288 OFPAT_SET_DL_SRC, /* Ethernet source address. */
289 OFPAT_SET_DL_DST, /* Ethernet destination address. */
290 OFPAT_SET_NW_SRC, /* IP source address. */
291 OFPAT_SET_NW_DST, /* IP destination address. */
292 OFPAT_SET_TP_SRC, /* TCP/UDP source port. */
293 OFPAT_SET_TP_DST /* TCP/UDP destination port. */
296 /* An output action sends packets out 'port'. When the 'port' is the
297 * OFPP_CONTROLLER, 'max_len' indicates the max number of bytes to
298 * send. A 'max_len' of zero means the entire packet should be sent. */
299 struct ofp_action_output {
303 OFP_ASSERT(sizeof(struct ofp_action_output) == 4);
305 /* The VLAN id is 12-bits, so we'll use the entire 16 bits to indicate
306 * special conditions. All ones is used to indicate that no VLAN id was
307 * set, or if used as an action, that the VLAN header should be
310 #define OFP_VLAN_NONE 0xffff
313 uint16_t type; /* One of OFPAT_* */
315 struct ofp_action_output output; /* OFPAT_OUTPUT: output struct. */
316 uint16_t vlan_id; /* OFPAT_SET_DL_VLAN: VLAN id. */
317 uint8_t dl_addr[OFP_ETH_ALEN]; /* OFPAT_SET_DL_SRC/DST */
318 uint32_t nw_addr OFP_PACKED; /* OFPAT_SET_NW_SRC/DST */
319 uint16_t tp; /* OFPAT_SET_TP_SRC/DST */
322 OFP_ASSERT(sizeof(struct ofp_action) == 8);
324 /* Send packet (controller -> datapath). */
325 struct ofp_packet_out {
326 struct ofp_header header;
327 uint32_t buffer_id; /* ID assigned by datapath (-1 if none). */
328 uint16_t in_port; /* Packet's input port (OFPP_NONE if none). */
329 uint16_t n_actions; /* Number of actions. */
330 struct ofp_action actions[0]; /* Actions. */
331 /* uint8_t data[0]; */ /* Packet data. The length is inferred
332 from the length field in the header.
333 (Only meaningful if buffer_id == -1.) */
335 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
337 enum ofp_flow_mod_command {
338 OFPFC_ADD, /* New flow. */
339 OFPFC_MODIFY, /* Modify all matching flows. */
340 OFPFC_MODIFY_STRICT, /* Strictly match wildcards and priority. */
341 OFPFC_DELETE, /* Delete all matching flows. */
342 OFPFC_DELETE_STRICT /* Strictly match wildcards and priority. */
345 /* Flow wildcards. */
346 enum ofp_flow_wildcards {
347 OFPFW_IN_PORT = 1 << 0, /* Switch input port. */
348 OFPFW_DL_VLAN = 1 << 1, /* VLAN. */
349 OFPFW_DL_SRC = 1 << 2, /* Ethernet source address. */
350 OFPFW_DL_DST = 1 << 3, /* Ethernet destination address. */
351 OFPFW_DL_TYPE = 1 << 4, /* Ethernet frame type. */
352 OFPFW_NW_PROTO = 1 << 5, /* IP protocol. */
353 OFPFW_TP_SRC = 1 << 6, /* TCP/UDP source port. */
354 OFPFW_TP_DST = 1 << 7, /* TCP/UDP destination port. */
356 /* IP source address wildcard bit count. 0 is exact match, 1 ignores the
357 * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
358 * the entire field. This is the *opposite* of the usual convention where
359 * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
360 OFPFW_NW_SRC_SHIFT = 8,
361 OFPFW_NW_SRC_BITS = 6,
362 OFPFW_NW_SRC_MASK = ((1 << OFPFW_NW_SRC_BITS) - 1) << OFPFW_NW_SRC_SHIFT,
363 OFPFW_NW_SRC_ALL = 32 << OFPFW_NW_SRC_SHIFT,
365 /* IP destination address wildcard bit count. Same format as source. */
366 OFPFW_NW_DST_SHIFT = 14,
367 OFPFW_NW_DST_BITS = 6,
368 OFPFW_NW_DST_MASK = ((1 << OFPFW_NW_DST_BITS) - 1) << OFPFW_NW_DST_SHIFT,
369 OFPFW_NW_DST_ALL = 32 << OFPFW_NW_DST_SHIFT,
371 /* Wildcard all fields. */
372 OFPFW_ALL = ((1 << 20) - 1)
375 /* Values below this cutoff are 802.3 packets and the two bytes
376 * following MAC addresses are used as a frame length. Otherwise, the
377 * two bytes are used as the Ethernet type.
379 #define OFP_DL_TYPE_ETH2_CUTOFF 0x0600
381 /* Value of dl_type to indicate that the frame does not include an
384 #define OFP_DL_TYPE_NOT_ETH_TYPE 0x05ff
386 /* Fields to match against flows */
388 uint32_t wildcards; /* Wildcard fields. */
389 uint16_t in_port; /* Input switch port. */
390 uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
391 uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
392 uint16_t dl_vlan; /* Input VLAN. */
393 uint16_t dl_type; /* Ethernet frame type. */
394 uint8_t nw_proto; /* IP protocol. */
395 uint8_t pad; /* Align to 32-bits. */
396 uint32_t nw_src; /* IP source address. */
397 uint32_t nw_dst; /* IP destination address. */
398 uint16_t tp_src; /* TCP/UDP source port. */
399 uint16_t tp_dst; /* TCP/UDP destination port. */
401 OFP_ASSERT(sizeof(struct ofp_match) == 36);
403 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
405 #define OFP_FLOW_PERMANENT 0
407 /* By default, choose a priority in the middle */
408 #define OFP_DEFAULT_PRIORITY 0x8000
410 /* Flow setup and teardown (controller -> datapath). */
411 struct ofp_flow_mod {
412 struct ofp_header header;
413 struct ofp_match match; /* Fields to match */
416 uint16_t command; /* One of OFPFC_*. */
417 uint16_t idle_timeout; /* Idle time before discarding (seconds). */
418 uint16_t hard_timeout; /* Max time before discarding (seconds). */
419 uint16_t priority; /* Priority level of flow entry. */
420 uint32_t buffer_id; /* Buffered packet to apply to (or -1). */
421 uint32_t reserved; /* Reserved for future use. */
422 struct ofp_action actions[0]; /* The number of actions is inferred from
423 the length field in the header. */
425 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 60);
427 /* Why did this flow expire? */
428 enum ofp_flow_expired_reason {
429 OFPER_IDLE_TIMEOUT, /* Flow idle time exceeded idle_timeout. */
430 OFPER_HARD_TIMEOUT /* Time exceeded hard_timeout. */
433 /* Flow expiration (datapath -> controller). */
434 struct ofp_flow_expired {
435 struct ofp_header header;
436 struct ofp_match match; /* Description of fields */
438 uint16_t priority; /* Priority level of flow entry. */
439 uint8_t reason; /* One of OFPER_*. */
440 uint8_t pad[1]; /* Align to 32-bits. */
442 uint32_t duration; /* Time flow was alive in seconds. */
443 uint8_t pad2[4]; /* Align to 64-bits. */
444 uint64_t packet_count;
447 OFP_ASSERT(sizeof(struct ofp_flow_expired) == 72);
449 enum ofp_error_type {
450 OFPET_BAD_REQUEST /* Request was not understood. */
453 enum ofp_bad_request_code {
454 OFPBRC_BAD_VERSION, /* ofp_header.version not supported. */
455 OFPBRC_BAD_TYPE, /* ofp_header.type not supported. */
456 OFPBRC_BAD_STAT, /* ofp_stats_request.type not supported. */
457 OFPBRC_BAD_VENDOR /* Vendor not supported (in ofp_vendor or
458 * ofp_stats_request or ofp_stats_reply). */
461 /* Error message (datapath -> controller). */
462 struct ofp_error_msg {
463 struct ofp_header header;
467 uint8_t data[0]; /* Variable-length data. Interpreted based
468 on the type and code. */
470 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
472 enum ofp_stats_types {
473 /* Description of this OpenFlow switch.
474 * The request body is empty.
475 * The reply body is struct ofp_desc_stats. */
478 /* Individual flow statistics.
479 * The request body is struct ofp_flow_stats_request.
480 * The reply body is an array of struct ofp_flow_stats. */
483 /* Aggregate flow statistics.
484 * The request body is struct ofp_aggregate_stats_request.
485 * The reply body is struct ofp_aggregate_stats_reply. */
488 /* Flow table statistics.
489 * The request body is empty.
490 * The reply body is an array of struct ofp_table_stats. */
493 /* Physical port statistics.
494 * The request body is empty.
495 * The reply body is an array of struct ofp_port_stats. */
499 * The request and reply bodies begin with a 32-bit vendor ID, which takes
500 * the same form as in "struct ofp_vendor". The request and reply bodies
501 * are otherwise vendor-defined. */
502 OFPST_VENDOR = 0xffff
505 struct ofp_stats_request {
506 struct ofp_header header;
507 uint16_t type; /* One of the OFPST_* constants. */
508 uint16_t flags; /* OFPSF_REQ_* flags (none yet defined). */
509 uint8_t body[0]; /* Body of the request. */
511 OFP_ASSERT(sizeof(struct ofp_stats_request) == 12);
513 enum ofp_stats_reply_flags {
514 OFPSF_REPLY_MORE = 1 << 0, /* More replies to follow */
517 struct ofp_stats_reply {
518 struct ofp_header header;
519 uint16_t type; /* One of the OFPST_* constants. */
520 uint16_t flags; /* OFPSF_REPLY_* flags. */
521 uint8_t body[0]; /* Body of the reply. */
523 OFP_ASSERT(sizeof(struct ofp_stats_reply) == 12);
525 #define DESC_STR_LEN 256
526 #define SERIAL_NUM_LEN 32
527 /* Body of reply to OFPST_DESC request. Each entry is a NULL-terminated
529 struct ofp_desc_stats {
530 char mfr_desc[DESC_STR_LEN]; /* Manufacturer description. */
531 char hw_desc[DESC_STR_LEN]; /* Hardware description. */
532 char sw_desc[DESC_STR_LEN]; /* Software description. */
533 char serial_num[SERIAL_NUM_LEN]; /* Serial number. */
535 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 800);
537 /* Body for ofp_stats_request of type OFPST_FLOW. */
538 struct ofp_flow_stats_request {
539 struct ofp_match match; /* Fields to match */
540 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
541 or 0xff for all tables. */
542 uint8_t pad[3]; /* Align to 32 bits. */
544 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 40);
546 /* Body of reply to OFPST_FLOW request. */
547 struct ofp_flow_stats {
548 uint16_t length; /* Length of this entry. */
549 uint8_t table_id; /* ID of table flow came from. */
551 struct ofp_match match; /* Description of fields. */
552 uint32_t duration; /* Time flow has been alive in seconds. */
553 uint16_t priority; /* Priority of the entry. Only meaningful
554 when this is not an exact-match entry. */
555 uint16_t idle_timeout; /* Number of seconds idle before expiration. */
556 uint16_t hard_timeout; /* Number of seconds before expiration. */
557 uint16_t pad2[3]; /* Pad to 64 bits. */
558 uint64_t packet_count; /* Number of packets in flow. */
559 uint64_t byte_count; /* Number of bytes in flow. */
560 struct ofp_action actions[0]; /* Actions. */
562 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 72);
564 /* Body for ofp_stats_request of type OFPST_AGGREGATE. */
565 struct ofp_aggregate_stats_request {
566 struct ofp_match match; /* Fields to match */
567 uint8_t table_id; /* ID of table to read (from ofp_table_stats)
568 or 0xff for all tables. */
569 uint8_t pad[3]; /* Align to 32 bits. */
571 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_request) == 40);
573 /* Body of reply to OFPST_AGGREGATE request. */
574 struct ofp_aggregate_stats_reply {
575 uint64_t packet_count; /* Number of packets in flows. */
576 uint64_t byte_count; /* Number of bytes in flows. */
577 uint32_t flow_count; /* Number of flows. */
578 uint8_t pad[4]; /* Align to 64 bits. */
580 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 24);
582 /* Body of reply to OFPST_TABLE request. */
583 struct ofp_table_stats {
584 uint8_t table_id; /* Identifier of table. Lower numbered tables
585 are consulted first. */
586 uint8_t pad[3]; /* Align to 32-bits */
587 char name[OFP_MAX_TABLE_NAME_LEN];
588 uint32_t wildcards; /* Bitmap of OFPFW_* wildcards that are
589 supported by the table. */
590 uint32_t max_entries; /* Max number of entries supported */
591 uint32_t active_count; /* Number of active entries */
592 uint64_t matched_count; /* Number of packets that hit table */
594 OFP_ASSERT(sizeof(struct ofp_table_stats) == 56);
596 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
597 * the field to all ones. */
598 struct ofp_port_stats {
600 uint8_t pad[6]; /* Align to 64-bits. */
601 uint64_t rx_packets; /* Number of received packets. */
602 uint64_t tx_packets; /* Number of transmitted packets. */
603 uint64_t rx_bytes; /* Number of received bytes. */
604 uint64_t tx_bytes; /* Number of transmitted bytes. */
605 uint64_t rx_dropped; /* Number of packets dropped by RX. */
606 uint64_t tx_dropped; /* Number of packets dropped by TX. */
607 uint64_t rx_errors; /* Number of receive errors. This is a super-set
608 of receive errors and should be great than or
609 equal to the sum of al rx_*_err values. */
610 uint64_t tx_errors; /* Number of transmit errors. This is a super-set
611 of transmit errors. */
612 uint64_t rx_frame_err; /* Number of frame alignment errors. */
613 uint64_t rx_over_err; /* Number of packets with RX overrun. */
614 uint64_t rx_crc_err; /* Number of CRC errors. */
615 uint64_t collisions; /* Number of collisions. */
617 OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
619 /* Vendor extension. */
621 struct ofp_header header; /* Type OFPT_VENDOR. */
622 uint32_t vendor; /* Vendor ID:
623 * - MSB 0: low-order bytes are Ethernet OUI.
624 * - MSB != 0: defined by OpenFlow
626 /* Vendor-defined arbitrary additional data. */
628 OFP_ASSERT(sizeof(struct ofp_vendor) == 12);
630 #endif /* openflow.h */