1 /* Copyright (c) 2008, 2011, 2012, 2013 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.
35 * Copyright (c) 2008, 2009, 2010, 2011 Nicira, Inc.
37 * Licensed under the Apache License, Version 2.0 (the "License");
38 * you may not use this file except in compliance with the License.
39 * You may obtain a copy of the License at:
41 * http://www.apache.org/licenses/LICENSE-2.0
43 * Unless required by applicable law or agreed to in writing, software
44 * distributed under the License is distributed on an "AS IS" BASIS,
45 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
46 * See the License for the specific language governing permissions and
47 * limitations under the License.
50 /* OpenFlow: protocol between controller and datapath. */
53 #define OPENFLOW_11_H 1
55 #include "openflow/openflow-common.h"
57 /* OpenFlow 1.1 uses 32-bit port numbers. Open vSwitch, for now, uses OpenFlow
58 * 1.0 port numbers internally. We map them to OpenFlow 1.0 as follows:
61 * ----------------------- ---------------
62 * 0x00000000...0x0000feff <=> 0x0000...0xfeff "physical" ports
63 * 0x0000ff00...0xfffffeff <=> not supported
64 * 0xffffff00...0xffffffff <=> 0xff00...0xffff "reserved" OFPP_* ports
66 * OFPP11_OFFSET is the value that must be added or subtracted to convert
67 * an OpenFlow 1.0 reserved port number to or from, respectively, the
68 * corresponding OpenFlow 1.1 reserved port number.
70 #define OFPP11_MAX OFP11_PORT_C(0xffffff00)
71 #define OFPP11_OFFSET 0xffff0000 /* OFPP11_MAX - OFPP_MAX */
73 /* Reserved wildcard port used only for flow mod (delete) and flow stats
74 * requests. Selects all flows regardless of output port
75 * (including flows with no output port)
77 * Define it via OFPP_NONE (0xFFFF) so that OFPP_ANY is still an enum ofp_port
79 #define OFPP_ANY OFPP_NONE
81 /* OpenFlow 1.1 port config flags are just the common flags. */
83 (OFPPC_PORT_DOWN | OFPPC_NO_RECV | OFPPC_NO_FWD | OFPPC_NO_PACKET_IN)
85 /* OpenFlow 1.1 specific current state of the physical port. These are not
86 * configurable from the controller.
88 enum ofp11_port_state {
89 OFPPS11_BLOCKED = 1 << 1, /* Port is blocked */
90 OFPPS11_LIVE = 1 << 2, /* Live for Fast Failover Group. */
91 #define OFPPS11_ALL (OFPPS_LINK_DOWN | OFPPS11_BLOCKED | OFPPS11_LIVE)
94 /* OpenFlow 1.1 specific features of ports available in a datapath. */
95 enum ofp11_port_features {
96 OFPPF11_40GB_FD = 1 << 7, /* 40 Gb full-duplex rate support. */
97 OFPPF11_100GB_FD = 1 << 8, /* 100 Gb full-duplex rate support. */
98 OFPPF11_1TB_FD = 1 << 9, /* 1 Tb full-duplex rate support. */
99 OFPPF11_OTHER = 1 << 10, /* Other rate, not in the list. */
101 OFPPF11_COPPER = 1 << 11, /* Copper medium. */
102 OFPPF11_FIBER = 1 << 12, /* Fiber medium. */
103 OFPPF11_AUTONEG = 1 << 13, /* Auto-negotiation. */
104 OFPPF11_PAUSE = 1 << 14, /* Pause. */
105 OFPPF11_PAUSE_ASYM = 1 << 15 /* Asymmetric pause. */
106 #define OFPPF11_ALL ((1 << 16) - 1)
109 /* Description of a port */
113 uint8_t hw_addr[OFP_ETH_ALEN];
114 uint8_t pad2[2]; /* Align to 64 bits. */
115 char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
117 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
118 ovs_be32 state; /* Bitmap of OFPPS_* and OFPPS11_* flags. */
120 /* Bitmaps of OFPPF_* and OFPPF11_* that describe features. All bits
121 * zeroed if unsupported or unavailable. */
122 ovs_be32 curr; /* Current features. */
123 ovs_be32 advertised; /* Features being advertised by the port. */
124 ovs_be32 supported; /* Features supported by the port. */
125 ovs_be32 peer; /* Features advertised by peer. */
127 ovs_be32 curr_speed; /* Current port bitrate in kbps. */
128 ovs_be32 max_speed; /* Max port bitrate in kbps */
130 OFP_ASSERT(sizeof(struct ofp11_port) == 64);
132 /* Modify behavior of the physical port */
133 struct ofp11_port_mod {
136 uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
137 configurable. This is used to
138 sanity-check the request, so it must
139 be the same as returned in an
140 ofp11_port struct. */
141 uint8_t pad2[2]; /* Pad to 64 bits. */
142 ovs_be32 config; /* Bitmap of OFPPC_* flags. */
143 ovs_be32 mask; /* Bitmap of OFPPC_* flags to be changed. */
145 ovs_be32 advertise; /* Bitmap of OFPPF_* and OFPPF11_*. Zero all bits
146 to prevent any action taking place. */
147 uint8_t pad3[4]; /* Pad to 64 bits. */
149 OFP_ASSERT(sizeof(struct ofp11_port_mod) == 32);
151 /* Group setup and teardown (controller -> datapath). */
152 struct ofp11_group_mod {
153 ovs_be16 command; /* One of OFPGC11_*. */
154 uint8_t type; /* One of OFPGT11_*. */
155 uint8_t pad; /* Pad to 64 bits. */
156 ovs_be32 group_id; /* Group identifier. */
157 /* struct ofp11_bucket buckets[0]; The bucket length is inferred from the
158 length field in the header. */
160 OFP_ASSERT(sizeof(struct ofp11_group_mod) == 8);
162 /* Query for port queue configuration. */
163 struct ofp11_queue_get_config_request {
165 /* Port to be queried. Should refer
166 to a valid physical port (i.e. < OFPP_MAX) */
169 OFP_ASSERT(sizeof(struct ofp11_queue_get_config_request) == 8);
172 enum ofp11_group_mod_command {
173 OFPGC11_ADD, /* New group. */
174 OFPGC11_MODIFY, /* Modify all matching groups. */
175 OFPGC11_DELETE, /* Delete all matching groups. */
178 /* OpenFlow 1.1 specific capabilities supported by the datapath (struct
179 * ofp_switch_features, member capabilities). */
180 enum ofp11_capabilities {
181 OFPC11_GROUP_STATS = 1 << 3, /* Group statistics. */
184 #define OFPMT11_STANDARD_LENGTH 88
186 struct ofp11_match_header {
187 ovs_be16 type; /* One of OFPMT_* */
188 ovs_be16 length; /* Length of match */
190 OFP_ASSERT(sizeof(struct ofp11_match_header) == 4);
192 /* Fields to match against flows */
194 struct ofp11_match_header omh;
195 ovs_be32 in_port; /* Input switch port. */
196 ovs_be32 wildcards; /* Wildcard fields. */
197 uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
198 uint8_t dl_src_mask[OFP_ETH_ALEN]; /* Ethernet source address mask. */
199 uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
200 uint8_t dl_dst_mask[OFP_ETH_ALEN]; /* Ethernet destination address mask. */
201 ovs_be16 dl_vlan; /* Input VLAN id. */
202 uint8_t dl_vlan_pcp; /* Input VLAN priority. */
203 uint8_t pad1[1]; /* Align to 32-bits */
204 ovs_be16 dl_type; /* Ethernet frame type. */
205 uint8_t nw_tos; /* IP ToS (actually DSCP field, 6 bits). */
206 uint8_t nw_proto; /* IP protocol or lower 8 bits of ARP opcode. */
207 ovs_be32 nw_src; /* IP source address. */
208 ovs_be32 nw_src_mask; /* IP source address mask. */
209 ovs_be32 nw_dst; /* IP destination address. */
210 ovs_be32 nw_dst_mask; /* IP destination address mask. */
211 ovs_be16 tp_src; /* TCP/UDP/SCTP source port. */
212 ovs_be16 tp_dst; /* TCP/UDP/SCTP destination port. */
213 ovs_be32 mpls_label; /* MPLS label. */
214 uint8_t mpls_tc; /* MPLS TC. */
215 uint8_t pad2[3]; /* Align to 64-bits */
216 ovs_be64 metadata; /* Metadata passed between tables. */
217 ovs_be64 metadata_mask; /* Mask for metadata. */
219 OFP_ASSERT(sizeof(struct ofp11_match) == OFPMT11_STANDARD_LENGTH);
221 /* Flow wildcards. */
222 enum ofp11_flow_wildcards {
223 OFPFW11_IN_PORT = 1 << 0, /* Switch input port. */
224 OFPFW11_DL_VLAN = 1 << 1, /* VLAN id. */
225 OFPFW11_DL_VLAN_PCP = 1 << 2, /* VLAN priority. */
226 OFPFW11_DL_TYPE = 1 << 3, /* Ethernet frame type. */
227 OFPFW11_NW_TOS = 1 << 4, /* IP ToS (DSCP field, 6 bits). */
228 OFPFW11_NW_PROTO = 1 << 5, /* IP protocol. */
229 OFPFW11_TP_SRC = 1 << 6, /* TCP/UDP/SCTP source port. */
230 OFPFW11_TP_DST = 1 << 7, /* TCP/UDP/SCTP destination port. */
231 OFPFW11_MPLS_LABEL = 1 << 8, /* MPLS label. */
232 OFPFW11_MPLS_TC = 1 << 9, /* MPLS TC. */
234 /* Wildcard all fields. */
235 OFPFW11_ALL = ((1 << 10) - 1)
238 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
239 * special conditions.
242 OFPVID11_ANY = 0xfffe, /* Indicate that a VLAN id is set but don't care
243 about it's value. Note: only valid when
244 specifying the VLAN id in a match */
245 OFPVID11_NONE = 0xffff, /* No VLAN id was set. */
248 enum ofp11_instruction_type {
249 OFPIT11_GOTO_TABLE = 1, /* Setup the next table in the lookup
251 OFPIT11_WRITE_METADATA = 2, /* Setup the metadata field for use later
253 OFPIT11_WRITE_ACTIONS = 3, /* Write the action(s) onto the datapath
255 OFPIT11_APPLY_ACTIONS = 4, /* Applies the action(s) immediately */
256 OFPIT11_CLEAR_ACTIONS = 5, /* Clears all actions from the datapath
258 OFPIT11_EXPERIMENTER = 0xFFFF /* Experimenter instruction */
261 #define OFP11_INSTRUCTION_ALIGN 8
263 /* Generic ofp_instruction structure. */
264 struct ofp11_instruction {
265 ovs_be16 type; /* Instruction type */
266 ovs_be16 len; /* Length of this struct in bytes. */
267 uint8_t pad[4]; /* Align to 64-bits */
269 OFP_ASSERT(sizeof(struct ofp11_instruction) == 8);
271 /* Instruction structure for OFPIT_GOTO_TABLE */
272 struct ofp11_instruction_goto_table {
273 ovs_be16 type; /* OFPIT_GOTO_TABLE */
274 ovs_be16 len; /* Length of this struct in bytes. */
275 uint8_t table_id; /* Set next table in the lookup pipeline */
276 uint8_t pad[3]; /* Pad to 64 bits. */
278 OFP_ASSERT(sizeof(struct ofp11_instruction_goto_table) == 8);
280 /* Instruction structure for OFPIT_WRITE_METADATA */
281 struct ofp11_instruction_write_metadata {
282 ovs_be16 type; /* OFPIT_WRITE_METADATA */
283 ovs_be16 len; /* Length of this struct in bytes. */
284 uint8_t pad[4]; /* Align to 64-bits */
285 ovs_be64 metadata; /* Metadata value to write */
286 ovs_be64 metadata_mask; /* Metadata write bitmask */
288 OFP_ASSERT(sizeof(struct ofp11_instruction_write_metadata) == 24);
290 /* Instruction structure for OFPIT_WRITE/APPLY/CLEAR_ACTIONS */
291 struct ofp11_instruction_actions {
292 ovs_be16 type; /* One of OFPIT_*_ACTIONS */
293 ovs_be16 len; /* Length of this struct in bytes. */
294 uint8_t pad[4]; /* Align to 64-bits */
295 /* struct ofp_action_header actions[0]; Actions associated with
296 OFPIT_WRITE_ACTIONS and
297 OFPIT_APPLY_ACTIONS */
299 OFP_ASSERT(sizeof(struct ofp11_instruction_actions) == 8);
301 /* Instruction structure for experimental instructions */
302 struct ofp11_instruction_experimenter {
303 ovs_be16 type; /* OFPIT11_EXPERIMENTER */
304 ovs_be16 len; /* Length of this struct in bytes */
305 ovs_be32 experimenter; /* Experimenter ID which takes the same form
306 as in struct ofp_vendor_header. */
307 /* Experimenter-defined arbitrary additional data. */
309 OFP_ASSERT(sizeof(struct ofp11_instruction_experimenter) == 8);
311 /* Configure/Modify behavior of a flow table */
312 struct ofp11_table_mod {
313 uint8_t table_id; /* ID of the table, 0xFF indicates all tables */
314 uint8_t pad[3]; /* Pad to 32 bits */
315 ovs_be32 config; /* Bitmap of OFPTC_* flags */
317 OFP_ASSERT(sizeof(struct ofp11_table_mod) == 8);
319 /* Flow setup and teardown (controller -> datapath). */
320 struct ofp11_flow_mod {
321 ovs_be64 cookie; /* Opaque controller-issued identifier. */
322 ovs_be64 cookie_mask; /* Mask used to restrict the cookie bits
323 that must match when the command is
324 OFPFC_MODIFY* or OFPFC_DELETE*. A value
325 of 0 indicates no restriction. */
327 uint8_t table_id; /* ID of the table to put the flow in */
328 uint8_t command; /* One of OFPFC_*. */
329 ovs_be16 idle_timeout; /* Idle time before discarding (seconds). */
330 ovs_be16 hard_timeout; /* Max time before discarding (seconds). */
331 ovs_be16 priority; /* Priority level of flow entry. */
332 ovs_be32 buffer_id; /* Buffered packet to apply to (or -1).
333 Not meaningful for OFPFC_DELETE*. */
334 ovs_be32 out_port; /* For OFPFC_DELETE* commands, require
335 matching entries to include this as an
336 output port. A value of OFPP_ANY
337 indicates no restriction. */
338 ovs_be32 out_group; /* For OFPFC_DELETE* commands, require
339 matching entries to include this as an
340 output group. A value of OFPG11_ANY
341 indicates no restriction. */
342 ovs_be16 flags; /* One of OFPFF_*. */
343 ovs_be16 importance; /* Eviction precedence (OF1.4+). */
344 /* Followed by an ofp11_match structure. */
345 /* Followed by an instruction set. */
347 OFP_ASSERT(sizeof(struct ofp11_flow_mod) == 40);
349 /* Group types. Values in the range [128, 255] are reserved for experimental
351 enum ofp11_group_type {
352 OFPGT11_ALL, /* All (multicast/broadcast) group. */
353 OFPGT11_SELECT, /* Select group. */
354 OFPGT11_INDIRECT, /* Indirect group. */
355 OFPGT11_FF /* Fast failover group. */
358 /* Group numbering. Groups can use any number up to OFPG_MAX. */
360 /* Last usable group number. */
361 OFPG11_MAX = 0xffffff00,
364 OFPG11_ALL = 0xfffffffc, /* Represents all groups for group delete
366 OFPG11_ANY = 0xffffffff /* Wildcard group used only for flow stats
367 requests. Selects all flows regardless
368 of group (including flows with no
372 /* Bucket for use in groups. */
373 struct ofp11_bucket {
374 ovs_be16 len; /* Length the bucket in bytes, including
375 this header and any padding to make it
377 ovs_be16 weight; /* Relative weight of bucket. Only
378 defined for select groups. */
379 ovs_be32 watch_port; /* Port whose state affects whether this
380 bucket is live. Only required for fast
382 ovs_be32 watch_group; /* Group whose state affects whether this
383 bucket is live. Only required for fast
386 /* struct ofp_action_header actions[0]; The action length is inferred
387 from the length field in the
390 OFP_ASSERT(sizeof(struct ofp11_bucket) == 16);
392 /* Queue configuration for a given port. */
393 struct ofp11_queue_get_config_reply {
396 /* struct ofp_packet_queue queues[0]; List of configured queues. */
398 OFP_ASSERT(sizeof(struct ofp11_queue_get_config_reply) == 8);
400 struct ofp11_stats_msg {
401 struct ofp_header header;
402 ovs_be16 type; /* One of the OFPST_* constants. */
403 ovs_be16 flags; /* OFPSF_REQ_* flags (none yet defined). */
405 /* Followed by the body of the request. */
407 OFP_ASSERT(sizeof(struct ofp11_stats_msg) == 16);
409 /* Vendor extension stats message. */
410 struct ofp11_vendor_stats_msg {
411 struct ofp11_stats_msg osm; /* Type OFPST_VENDOR. */
412 ovs_be32 vendor; /* Vendor ID:
413 * - MSB 0: low-order bytes are IEEE OUI.
414 * - MSB != 0: defined by OpenFlow
416 /* Followed by vendor-defined arbitrary additional data. */
418 OFP_ASSERT(sizeof(struct ofp11_vendor_stats_msg) == 20);
420 /* Stats request of type OFPST_FLOW. */
421 struct ofp11_flow_stats_request {
422 uint8_t table_id; /* ID of table to read (from ofp_table_stats),
423 0xff for all tables. */
424 uint8_t pad[3]; /* Align to 64 bits. */
425 ovs_be32 out_port; /* Require matching entries to include this
426 as an output port. A value of OFPP_ANY
427 indicates no restriction. */
428 ovs_be32 out_group; /* Require matching entries to include this
429 as an output group. A value of OFPG11_ANY
430 indicates no restriction. */
431 uint8_t pad2[4]; /* Align to 64 bits. */
432 ovs_be64 cookie; /* Require matching entries to contain this
434 ovs_be64 cookie_mask; /* Mask used to restrict the cookie bits that
435 must match. A value of 0 indicates
437 /* Followed by an ofp11_match structure. */
439 OFP_ASSERT(sizeof(struct ofp11_flow_stats_request) == 32);
441 /* Body of reply to OFPST_FLOW request. */
442 struct ofp11_flow_stats {
443 ovs_be16 length; /* Length of this entry. */
444 uint8_t table_id; /* ID of table flow came from. */
446 ovs_be32 duration_sec; /* Time flow has been alive in seconds. */
447 ovs_be32 duration_nsec; /* Time flow has been alive in nanoseconds beyond
449 ovs_be16 priority; /* Priority of the entry. Only meaningful
450 when this is not an exact-match entry. */
451 ovs_be16 idle_timeout; /* Number of seconds idle before expiration. */
452 ovs_be16 hard_timeout; /* Number of seconds before expiration. */
453 ovs_be16 flags; /* OF 1.3: Set of OFPFF*. */
454 ovs_be16 importance; /* Eviction precedence (OF1.4+). */
455 uint8_t pad2[2]; /* Align to 64-bits. */
456 ovs_be64 cookie; /* Opaque controller-issued identifier. */
457 ovs_be64 packet_count; /* Number of packets in flow. */
458 ovs_be64 byte_count; /* Number of bytes in flow. */
459 /* Open Flow version specific match */
460 /* struct ofp11_instruction instructions[0]; Instruction set. */
462 OFP_ASSERT(sizeof(struct ofp11_flow_stats) == 48);
464 /* Body for ofp_stats_request of type OFPST_AGGREGATE. */
465 /* Identical to ofp11_flow_stats_request */
467 /* Flow match fields. */
468 enum ofp11_flow_match_fields {
469 OFPFMF11_IN_PORT = 1 << 0, /* Switch input port. */
470 OFPFMF11_DL_VLAN = 1 << 1, /* VLAN id. */
471 OFPFMF11_DL_VLAN_PCP = 1 << 2, /* VLAN priority. */
472 OFPFMF11_DL_TYPE = 1 << 3, /* Ethernet frame type. */
473 OFPFMF11_NW_TOS = 1 << 4, /* IP ToS (DSCP field, 6 bits). */
474 OFPFMF11_NW_PROTO = 1 << 5, /* IP protocol. */
475 OFPFMF11_TP_SRC = 1 << 6, /* TCP/UDP/SCTP source port. */
476 OFPFMF11_TP_DST = 1 << 7, /* TCP/UDP/SCTP destination port. */
477 OFPFMF11_MPLS_LABEL = 1 << 8, /* MPLS label. */
478 OFPFMF11_MPLS_TC = 1 << 9, /* MPLS TC. */
479 OFPFMF11_TYPE = 1 << 10, /* Match type. */
480 OFPFMF11_DL_SRC = 1 << 11, /* Ethernet source address. */
481 OFPFMF11_DL_DST = 1 << 12, /* Ethernet destination address. */
482 OFPFMF11_NW_SRC = 1 << 13, /* IP source address. */
483 OFPFMF11_NW_DST = 1 << 14, /* IP destination address. */
484 OFPFMF11_METADATA = 1 << 15, /* Metadata passed between tables. */
487 /* Body of reply to OFPST_TABLE request. */
488 struct ofp11_table_stats {
489 uint8_t table_id; /* Identifier of table. Lower numbered tables
490 are consulted first. */
491 uint8_t pad[7]; /* Align to 64-bits. */
492 char name[OFP_MAX_TABLE_NAME_LEN];
493 ovs_be32 wildcards; /* Bitmap of OFPFMF_* wildcards that are
494 supported by the table. */
495 ovs_be32 match; /* Bitmap of OFPFMF_* that indicate the fields
496 the table can match on. */
497 ovs_be32 instructions; /* Bitmap of OFPIT_* values supported. */
498 ovs_be32 write_actions; /* Bitmap of OFPAT_* that are supported
499 by the table with OFPIT_WRITE_ACTIONS. */
500 ovs_be32 apply_actions; /* Bitmap of OFPAT_* that are supported
501 by the table with OFPIT_APPLY_ACTIONS. */
502 ovs_be32 config; /* Bitmap of OFPTC_* values */
503 ovs_be32 max_entries; /* Max number of entries supported. */
504 ovs_be32 active_count; /* Number of active entries. */
505 ovs_be64 lookup_count; /* Number of packets looked up in table. */
506 ovs_be64 matched_count; /* Number of packets that hit table. */
508 OFP_ASSERT(sizeof(struct ofp11_table_stats) == 88);
510 /* Body for ofp_stats_request of type OFPST_PORT. */
511 struct ofp11_port_stats_request {
512 ovs_be32 port_no; /* OFPST_PORT message must request statistics
513 * either for a single port (specified in
514 * port_no) or for all ports (if port_no ==
518 OFP_ASSERT(sizeof(struct ofp11_port_stats_request) == 8);
520 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
521 * the field to all ones. */
522 struct ofp11_port_stats {
524 uint8_t pad[4]; /* Align to 64-bits. */
525 ovs_be64 rx_packets; /* Number of received packets. */
526 ovs_be64 tx_packets; /* Number of transmitted packets. */
527 ovs_be64 rx_bytes; /* Number of received bytes. */
528 ovs_be64 tx_bytes; /* Number of transmitted bytes. */
529 ovs_be64 rx_dropped; /* Number of packets dropped by RX. */
530 ovs_be64 tx_dropped; /* Number of packets dropped by TX. */
531 ovs_be64 rx_errors; /* Number of receive errors. This is a
532 super-set of receive errors and should be
533 great than or equal to the sum of all
535 ovs_be64 tx_errors; /* Number of transmit errors. This is a
536 super-set of transmit errors. */
537 ovs_be64 rx_frame_err; /* Number of frame alignment errors. */
538 ovs_be64 rx_over_err; /* Number of packets with RX overrun. */
539 ovs_be64 rx_crc_err; /* Number of CRC errors. */
540 ovs_be64 collisions; /* Number of collisions. */
542 OFP_ASSERT(sizeof(struct ofp11_port_stats) == 104);
544 struct ofp11_queue_stats_request {
545 ovs_be32 port_no; /* All ports if OFPP_ANY. */
546 ovs_be32 queue_id; /* All queues if OFPQ_ALL. */
548 OFP_ASSERT(sizeof(struct ofp11_queue_stats_request) == 8);
550 struct ofp11_queue_stats {
552 ovs_be32 queue_id; /* Queue id. */
553 ovs_be64 tx_bytes; /* Number of transmitted bytes. */
554 ovs_be64 tx_packets; /* Number of transmitted packets. */
555 ovs_be64 tx_errors; /* # of packets dropped due to overrun. */
557 OFP_ASSERT(sizeof(struct ofp11_queue_stats) == 32);
559 struct ofp11_group_stats_request {
560 ovs_be32 group_id; /* All groups if OFPG_ALL. */
561 uint8_t pad[4]; /* Align to 64 bits. */
563 OFP_ASSERT(sizeof(struct ofp11_group_stats_request) == 8);
565 /* Used in group stats replies. */
566 struct ofp11_bucket_counter {
567 ovs_be64 packet_count; /* Number of packets processed by bucket. */
568 ovs_be64 byte_count; /* Number of bytes processed by bucket. */
570 OFP_ASSERT(sizeof(struct ofp11_bucket_counter) == 16);
572 /* Body of reply to OFPST11_GROUP request */
573 struct ofp11_group_stats {
574 ovs_be16 length; /* Length of this entry. */
575 uint8_t pad[2]; /* Align to 64 bits. */
576 ovs_be32 group_id; /* Group identifier. */
577 ovs_be32 ref_count; /* Number of flows or groups that
578 directly forward to this group. */
579 uint8_t pad2[4]; /* Align to 64 bits. */
580 ovs_be64 packet_count; /* Number of packets processed by group. */
581 ovs_be64 byte_count; /* Number of bytes processed by group. */
582 /* struct ofp11_bucket_counter bucket_stats[]; */
584 OFP_ASSERT(sizeof(struct ofp11_group_stats) == 32);
586 /* Body of reply to OFPST11_GROUP_DESC request. */
587 struct ofp11_group_desc_stats {
588 ovs_be16 length; /* Length of this entry. */
589 uint8_t type; /* One of OFPGT11_*. */
590 uint8_t pad; /* Pad to 64 bits. */
591 ovs_be32 group_id; /* Group identifier. */
592 /* struct ofp11_bucket buckets[0]; */
594 OFP_ASSERT(sizeof(struct ofp11_group_desc_stats) == 8);
596 /* Send packet (controller -> datapath). */
597 struct ofp11_packet_out {
598 ovs_be32 buffer_id; /* ID assigned by datapath (-1 if none). */
599 ovs_be32 in_port; /* Packet's input port or OFPP_CONTROLLER. */
600 ovs_be16 actions_len; /* Size of action array in bytes. */
602 /* struct ofp_action_header actions[0]; Action list. */
603 /* uint8_t data[0]; */ /* Packet data. The length is inferred
604 from the length field in the header.
605 (Only meaningful if buffer_id == -1.) */
607 OFP_ASSERT(sizeof(struct ofp11_packet_out) == 16);
609 /* Packet received on port (datapath -> controller). */
610 struct ofp11_packet_in {
611 ovs_be32 buffer_id; /* ID assigned by datapath. */
612 ovs_be32 in_port; /* Port on which frame was received. */
613 ovs_be32 in_phy_port; /* Physical Port on which frame was received. */
614 ovs_be16 total_len; /* Full length of frame. */
615 uint8_t reason; /* Reason packet is being sent (one of OFPR_*) */
616 uint8_t table_id; /* ID of the table that was looked up */
617 /* Followed by Ethernet frame. */
619 OFP_ASSERT(sizeof(struct ofp11_packet_in) == 16);
621 /* Flow removed (datapath -> controller). */
622 struct ofp11_flow_removed {
623 ovs_be64 cookie; /* Opaque controller-issued identifier. */
625 ovs_be16 priority; /* Priority level of flow entry. */
626 uint8_t reason; /* One of OFPRR_*. */
627 uint8_t table_id; /* ID of the table */
629 ovs_be32 duration_sec; /* Time flow was alive in seconds. */
630 ovs_be32 duration_nsec; /* Time flow was alive in nanoseconds beyond
632 ovs_be16 idle_timeout; /* Idle timeout from original flow mod. */
633 uint8_t pad2[2]; /* Align to 64-bits. */
634 ovs_be64 packet_count;
636 /* Followed by an ofp11_match structure. */
638 OFP_ASSERT(sizeof(struct ofp11_flow_removed) == 40);
640 #endif /* openflow/openflow-1.1.h */