openflow: Rename OFP_VLAN_NONE as OFP10_VLAN_NONE
[openvswitch] / include / openflow / openflow-1.0.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira, Inc.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 /* OpenFlow: protocol between controller and datapath. */
18
19 #ifndef OPENFLOW_OPENFLOW10_H
20 #define OPENFLOW_OPENFLOW10_H 1
21
22 #include "openflow/openflow-common.h"
23
24 /* Port numbering.  Physical ports are numbered starting from 1. */
25 enum ofp_port {
26     /* Maximum number of physical switch ports. */
27     OFPP_MAX = 0xff00,
28
29     /* Fake output "ports". */
30     OFPP_IN_PORT    = 0xfff8,  /* Send the packet out the input port.  This
31                                   virtual port must be explicitly used
32                                   in order to send back out of the input
33                                   port. */
34     OFPP_TABLE      = 0xfff9,  /* Perform actions in flow table.
35                                   NB: This can only be the destination
36                                   port for packet-out messages. */
37     OFPP_NORMAL     = 0xfffa,  /* Process with normal L2/L3 switching. */
38     OFPP_FLOOD      = 0xfffb,  /* All physical ports except input port and
39                                   those disabled by STP. */
40     OFPP_ALL        = 0xfffc,  /* All physical ports except input port. */
41     OFPP_CONTROLLER = 0xfffd,  /* Send to controller. */
42     OFPP_LOCAL      = 0xfffe,  /* Local openflow "port". */
43     OFPP_NONE       = 0xffff   /* Not associated with a physical port. */
44 };
45
46 /* OpenFlow 1.0 specific message types, in addition to the common message
47  * types. */
48 enum ofp10_type {
49     /* Controller command messages. */
50     OFPT10_PORT_MOD = 15,       /* Controller/switch message */
51
52     /* Statistics messages. */
53     OFPT10_STATS_REQUEST,       /* Controller/switch message */
54     OFPT10_STATS_REPLY,         /* Controller/switch message */
55
56     /* Barrier messages. */
57     OFPT10_BARRIER_REQUEST,     /* Controller/switch message */
58     OFPT10_BARRIER_REPLY,       /* Controller/switch message */
59
60     /* Queue Configuration messages. */
61     OFPT10_QUEUE_GET_CONFIG_REQUEST,  /* Controller/switch message */
62     OFPT10_QUEUE_GET_CONFIG_REPLY     /* Controller/switch message */
63 };
64
65 /* OFPT_HELLO.  This message has an empty body, but implementations must
66  * ignore any data included in the body, to allow for future extensions. */
67 struct ofp_hello {
68     struct ofp_header header;
69 };
70
71 #define OFP_DEFAULT_MISS_SEND_LEN   128
72
73 enum ofp_config_flags {
74     /* Handling of IP fragments. */
75     OFPC_FRAG_NORMAL   = 0,  /* No special handling for fragments. */
76     OFPC_FRAG_DROP     = 1,  /* Drop fragments. */
77     OFPC_FRAG_REASM    = 2,  /* Reassemble (only if OFPC_IP_REASM set). */
78     OFPC_FRAG_NX_MATCH = 3,  /* Make first fragments available for matching. */
79     OFPC_FRAG_MASK     = 3,
80
81     /* TTL processing - applicable for IP and MPLS packets. */
82     OFPC_INVALID_TTL_TO_CONTROLLER = 1 << 2, /* Send packets with invalid TTL
83                                                 to the controller. */
84 };
85
86 /* Switch configuration. */
87 struct ofp_switch_config {
88     struct ofp_header header;
89     ovs_be16 flags;             /* OFPC_* flags. */
90     ovs_be16 miss_send_len;     /* Max bytes of new flow that datapath should
91                                    send to the controller. */
92 };
93 OFP_ASSERT(sizeof(struct ofp_switch_config) == 12);
94
95 /* OpenFlow 1.0 specific capabilities supported by the datapath (struct
96  * ofp_switch_features, member capabilities). */
97 enum ofp10_capabilities {
98     OFPC10_STP            = 1 << 3,  /* 802.1d spanning tree. */
99     OFPC10_RESERVED       = 1 << 4,  /* Reserved, must not be set. */
100 };
101
102 /* OpenFlow 1.0 specific flags to indicate behavior of the physical port.
103  * These flags are used in ofp10_phy_port to describe the current
104  * configuration.  They are used in the ofp10_port_mod message to configure the
105  * port's behavior.
106  */
107 enum ofp10_port_config {
108     OFPPC10_NO_STP       = 1 << 1, /* Disable 802.1D spanning tree on port. */
109     OFPPC10_NO_RECV_STP  = 1 << 3, /* Drop received 802.1D STP packets. */
110     OFPPC10_NO_FLOOD     = 1 << 4, /* Do not include port when flooding. */
111 #define OFPPC10_ALL (OFPPC_PORT_DOWN | OFPPC10_NO_STP | OFPPC_NO_RECV | \
112                      OFPPC10_NO_RECV_STP | OFPPC10_NO_FLOOD | OFPPC_NO_FWD | \
113                      OFPPC_NO_PACKET_IN)
114 };
115
116 /* OpenFlow 1.0 specific current state of the physical port.  These are not
117  * configurable from the controller.
118  */
119 enum ofp10_port_state {
120     /* The OFPPS10_STP_* bits have no effect on switch operation.  The
121      * controller must adjust OFPPC_NO_RECV, OFPPC_NO_FWD, and
122      * OFPPC_NO_PACKET_IN appropriately to fully implement an 802.1D spanning
123      * tree. */
124     OFPPS10_STP_LISTEN  = 0 << 8, /* Not learning or relaying frames. */
125     OFPPS10_STP_LEARN   = 1 << 8, /* Learning but not relaying frames. */
126     OFPPS10_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
127     OFPPS10_STP_BLOCK   = 3 << 8, /* Not part of spanning tree. */
128     OFPPS10_STP_MASK    = 3 << 8  /* Bit mask for OFPPS10_STP_* values. */
129
130 #define OFPPS10_ALL (OFPPS_LINK_DOWN | OFPPS10_STP_MASK)
131 };
132
133 /* OpenFlow 1.0 specific features of physical ports available in a datapath. */
134 enum ofp10_port_features {
135     OFPPF10_COPPER     = 1 << 7,  /* Copper medium. */
136     OFPPF10_FIBER      = 1 << 8,  /* Fiber medium. */
137     OFPPF10_AUTONEG    = 1 << 9,  /* Auto-negotiation. */
138     OFPPF10_PAUSE      = 1 << 10, /* Pause. */
139     OFPPF10_PAUSE_ASYM = 1 << 11  /* Asymmetric pause. */
140 };
141
142 /* Description of a physical port */
143 struct ofp10_phy_port {
144     ovs_be16 port_no;
145     uint8_t hw_addr[OFP_ETH_ALEN];
146     char name[OFP_MAX_PORT_NAME_LEN]; /* Null-terminated */
147
148     ovs_be32 config;        /* Bitmap of OFPPC_* and OFPPC10_* flags. */
149     ovs_be32 state;         /* Bitmap of OFPPS_* and OFPPS10_* flags. */
150
151     /* Bitmaps of OFPPF_* and OFPPF10_* that describe features.  All bits
152      * zeroed if unsupported or unavailable. */
153     ovs_be32 curr;          /* Current features. */
154     ovs_be32 advertised;    /* Features being advertised by the port. */
155     ovs_be32 supported;     /* Features supported by the port. */
156     ovs_be32 peer;          /* Features advertised by peer. */
157 };
158 OFP_ASSERT(sizeof(struct ofp10_phy_port) == 48);
159
160 /* Modify behavior of the physical port */
161 struct ofp10_port_mod {
162     struct ofp_header header;
163     ovs_be16 port_no;
164     uint8_t hw_addr[OFP_ETH_ALEN]; /* The hardware address is not
165                                       configurable.  This is used to
166                                       sanity-check the request, so it must
167                                       be the same as returned in an
168                                       ofp10_phy_port struct. */
169
170     ovs_be32 config;        /* Bitmap of OFPPC_* flags. */
171     ovs_be32 mask;          /* Bitmap of OFPPC_* flags to be changed. */
172
173     ovs_be32 advertise;     /* Bitmap of "ofp_port_features"s.  Zero all
174                                bits to prevent any action taking place. */
175     uint8_t pad[4];         /* Pad to 64-bits. */
176 };
177 OFP_ASSERT(sizeof(struct ofp10_port_mod) == 32);
178
179 /* Query for port queue configuration. */
180 struct ofp10_queue_get_config_request {
181     struct ofp_header header;
182     ovs_be16 port;          /* Port to be queried. Should refer
183                                to a valid physical port (i.e. < OFPP_MAX) */
184     uint8_t pad[2];
185     /* 32-bit alignment. */
186 };
187 OFP_ASSERT(sizeof(struct ofp10_queue_get_config_request) == 12);
188
189 /* Queue configuration for a given port. */
190 struct ofp10_queue_get_config_reply {
191     struct ofp_header header;
192     ovs_be16 port;
193     uint8_t pad[6];
194     /* struct ofp10_packet_queue queues[0]; List of configured queues. */
195 };
196 OFP_ASSERT(sizeof(struct ofp10_queue_get_config_reply) == 16);
197
198 /* Packet received on port (datapath -> controller). */
199 struct ofp_packet_in {
200     struct ofp_header header;
201     ovs_be32 buffer_id;     /* ID assigned by datapath. */
202     ovs_be16 total_len;     /* Full length of frame. */
203     ovs_be16 in_port;       /* Port on which frame was received. */
204     uint8_t reason;         /* Reason packet is being sent (one of OFPR_*) */
205     uint8_t pad;
206     uint8_t data[0];        /* Ethernet frame, halfway through 32-bit word,
207                                so the IP header is 32-bit aligned.  The
208                                amount of data is inferred from the length
209                                field in the header.  Because of padding,
210                                offsetof(struct ofp_packet_in, data) ==
211                                sizeof(struct ofp_packet_in) - 2. */
212 };
213 OFP_ASSERT(sizeof(struct ofp_packet_in) == 20);
214
215 enum ofp10_action_type {
216     OFPAT10_OUTPUT,             /* Output to switch port. */
217     OFPAT10_SET_VLAN_VID,       /* Set the 802.1q VLAN id. */
218     OFPAT10_SET_VLAN_PCP,       /* Set the 802.1q priority. */
219     OFPAT10_STRIP_VLAN,         /* Strip the 802.1q header. */
220     OFPAT10_SET_DL_SRC,         /* Ethernet source address. */
221     OFPAT10_SET_DL_DST,         /* Ethernet destination address. */
222     OFPAT10_SET_NW_SRC,         /* IP source address. */
223     OFPAT10_SET_NW_DST,         /* IP destination address. */
224     OFPAT10_SET_NW_TOS,         /* IP ToS (DSCP field, 6 bits). */
225     OFPAT10_SET_TP_SRC,         /* TCP/UDP source port. */
226     OFPAT10_SET_TP_DST,         /* TCP/UDP destination port. */
227     OFPAT10_ENQUEUE,            /* Output to queue. */
228     OFPAT10_VENDOR = 0xffff
229 };
230
231 /* Action structure for OFPAT10_OUTPUT, which sends packets out 'port'.
232  * When the 'port' is the OFPP_CONTROLLER, 'max_len' indicates the max
233  * number of bytes to send.  A 'max_len' of zero means no bytes of the
234  * packet should be sent. */
235 struct ofp10_action_output {
236     ovs_be16 type;                  /* OFPAT10_OUTPUT. */
237     ovs_be16 len;                   /* Length is 8. */
238     ovs_be16 port;                  /* Output port. */
239     ovs_be16 max_len;               /* Max length to send to controller. */
240 };
241 OFP_ASSERT(sizeof(struct ofp10_action_output) == 8);
242
243 /* Action header for OFPAT10_VENDOR. The rest of the body is vendor-defined. */
244 struct ofp_action_vendor_header {
245     ovs_be16 type;                  /* OFPAT10_VENDOR. */
246     ovs_be16 len;                   /* Length is a multiple of 8. */
247     ovs_be32 vendor;                /* Vendor ID, which takes the same form
248                                        as in "struct ofp_vendor_header". */
249 };
250 OFP_ASSERT(sizeof(struct ofp_action_vendor_header) == 8);
251
252 /* Action header that is common to all actions.  The length includes the
253  * header and any padding used to make the action 64-bit aligned.
254  * NB: The length of an action *must* always be a multiple of eight. */
255 struct ofp_action_header {
256     ovs_be16 type;                  /* One of OFPAT10_*. */
257     ovs_be16 len;                   /* Length of action, including this
258                                        header.  This is the length of action,
259                                        including any padding to make it
260                                        64-bit aligned. */
261     uint8_t pad[4];
262 };
263 OFP_ASSERT(sizeof(struct ofp_action_header) == 8);
264
265 /* OFPAT10_ENQUEUE action struct: send packets to given queue on port. */
266 struct ofp_action_enqueue {
267     ovs_be16 type;            /* OFPAT10_ENQUEUE. */
268     ovs_be16 len;             /* Len is 16. */
269     ovs_be16 port;            /* Port that queue belongs. Should
270                                  refer to a valid physical port
271                                  (i.e. < OFPP_MAX) or OFPP_IN_PORT. */
272     uint8_t pad[6];           /* Pad for 64-bit alignment. */
273     ovs_be32 queue_id;        /* Where to enqueue the packets. */
274 };
275 OFP_ASSERT(sizeof(struct ofp_action_enqueue) == 16);
276
277 union ofp_action {
278     ovs_be16 type;
279     struct ofp_action_header header;
280     struct ofp_action_vendor_header vendor;
281     struct ofp10_action_output output10;
282     struct ofp_action_vlan_vid vlan_vid;
283     struct ofp_action_vlan_pcp vlan_pcp;
284     struct ofp_action_nw_addr nw_addr;
285     struct ofp_action_nw_tos nw_tos;
286     struct ofp_action_tp_port tp_port;
287 };
288 OFP_ASSERT(sizeof(union ofp_action) == 8);
289
290 /* Send packet (controller -> datapath). */
291 struct ofp_packet_out {
292     struct ofp_header header;
293     ovs_be32 buffer_id;           /* ID assigned by datapath or UINT32_MAX. */
294     ovs_be16 in_port;             /* Packet's input port (OFPP_NONE if none). */
295     ovs_be16 actions_len;         /* Size of action array in bytes. */
296     /* Followed by:
297      *   - Exactly 'actions_len' bytes (possibly 0 bytes, and always a multiple
298      *     of 8) containing actions.
299      *   - If 'buffer_id' == UINT32_MAX, packet data to fill out the remainder
300      *     of the message length.
301      */
302 };
303 OFP_ASSERT(sizeof(struct ofp_packet_out) == 16);
304
305 enum ofp_flow_mod_command {
306     OFPFC_ADD,              /* New flow. */
307     OFPFC_MODIFY,           /* Modify all matching flows. */
308     OFPFC_MODIFY_STRICT,    /* Modify entry strictly matching wildcards */
309     OFPFC_DELETE,           /* Delete all matching flows. */
310     OFPFC_DELETE_STRICT     /* Strictly match wildcards and priority. */
311 };
312
313 /* Flow wildcards. */
314 enum ofp_flow_wildcards {
315     OFPFW10_IN_PORT    = 1 << 0,  /* Switch input port. */
316     OFPFW10_DL_VLAN    = 1 << 1,  /* VLAN vid. */
317     OFPFW10_DL_SRC     = 1 << 2,  /* Ethernet source address. */
318     OFPFW10_DL_DST     = 1 << 3,  /* Ethernet destination address. */
319     OFPFW10_DL_TYPE    = 1 << 4,  /* Ethernet frame type. */
320     OFPFW10_NW_PROTO   = 1 << 5,  /* IP protocol. */
321     OFPFW10_TP_SRC     = 1 << 6,  /* TCP/UDP source port. */
322     OFPFW10_TP_DST     = 1 << 7,  /* TCP/UDP destination port. */
323
324     /* IP source address wildcard bit count.  0 is exact match, 1 ignores the
325      * LSB, 2 ignores the 2 least-significant bits, ..., 32 and higher wildcard
326      * the entire field.  This is the *opposite* of the usual convention where
327      * e.g. /24 indicates that 8 bits (not 24 bits) are wildcarded. */
328     OFPFW10_NW_SRC_SHIFT = 8,
329     OFPFW10_NW_SRC_BITS = 6,
330     OFPFW10_NW_SRC_MASK = (((1 << OFPFW10_NW_SRC_BITS) - 1)
331                            << OFPFW10_NW_SRC_SHIFT),
332     OFPFW10_NW_SRC_ALL = 32 << OFPFW10_NW_SRC_SHIFT,
333
334     /* IP destination address wildcard bit count.  Same format as source. */
335     OFPFW10_NW_DST_SHIFT = 14,
336     OFPFW10_NW_DST_BITS = 6,
337     OFPFW10_NW_DST_MASK = (((1 << OFPFW10_NW_DST_BITS) - 1)
338                            << OFPFW10_NW_DST_SHIFT),
339     OFPFW10_NW_DST_ALL = 32 << OFPFW10_NW_DST_SHIFT,
340
341     OFPFW10_DL_VLAN_PCP = 1 << 20, /* VLAN priority. */
342     OFPFW10_NW_TOS = 1 << 21, /* IP ToS (DSCP field, 6 bits). */
343
344     /* Wildcard all fields. */
345     OFPFW10_ALL = ((1 << 22) - 1)
346 };
347
348 /* The wildcards for ICMP type and code fields use the transport source
349  * and destination port fields, respectively. */
350 #define OFPFW10_ICMP_TYPE OFPFW10_TP_SRC
351 #define OFPFW10_ICMP_CODE OFPFW10_TP_DST
352
353 /* Values below this cutoff are 802.3 packets and the two bytes
354  * following MAC addresses are used as a frame length.  Otherwise, the
355  * two bytes are used as the Ethernet type.
356  */
357 #define OFP_DL_TYPE_ETH2_CUTOFF   0x0600
358
359 /* Value of dl_type to indicate that the frame does not include an
360  * Ethernet type.
361  */
362 #define OFP_DL_TYPE_NOT_ETH_TYPE  0x05ff
363
364 /* The VLAN id is 12-bits, so we can use the entire 16 bits to indicate
365  * special conditions.  All ones indicates that no VLAN id was set.
366  */
367 #define OFP10_VLAN_NONE      0xffff
368
369 /* Fields to match against flows */
370 struct ofp10_match {
371     ovs_be32 wildcards;        /* Wildcard fields. */
372     ovs_be16 in_port;          /* Input switch port. */
373     uint8_t dl_src[OFP_ETH_ALEN]; /* Ethernet source address. */
374     uint8_t dl_dst[OFP_ETH_ALEN]; /* Ethernet destination address. */
375     ovs_be16 dl_vlan;          /* Input VLAN. */
376     uint8_t dl_vlan_pcp;       /* Input VLAN priority. */
377     uint8_t pad1[1];           /* Align to 64-bits. */
378     ovs_be16 dl_type;          /* Ethernet frame type. */
379     uint8_t nw_tos;            /* IP ToS (DSCP field, 6 bits). */
380     uint8_t nw_proto;          /* IP protocol or lower 8 bits of
381                                   ARP opcode. */
382     uint8_t pad2[2];           /* Align to 64-bits. */
383     ovs_be32 nw_src;           /* IP source address. */
384     ovs_be32 nw_dst;           /* IP destination address. */
385     ovs_be16 tp_src;           /* TCP/UDP source port. */
386     ovs_be16 tp_dst;           /* TCP/UDP destination port. */
387 };
388 OFP_ASSERT(sizeof(struct ofp10_match) == 40);
389
390 /* Value used in "idle_timeout" and "hard_timeout" to indicate that the entry
391  * is permanent. */
392 #define OFP_FLOW_PERMANENT 0
393
394 /* By default, choose a priority in the middle. */
395 #define OFP_DEFAULT_PRIORITY 0x8000
396
397 enum ofp_flow_mod_flags {
398     OFPFF_SEND_FLOW_REM = 1 << 0,  /* Send flow removed message when flow
399                                     * expires or is deleted. */
400     OFPFF_CHECK_OVERLAP = 1 << 1,  /* Check for overlapping entries first. */
401     OFPFF_EMERG         = 1 << 2   /* Ramark this is for emergency. */
402 };
403
404 /* Flow setup and teardown (controller -> datapath). */
405 struct ofp_flow_mod {
406     struct ofp_header header;
407     struct ofp10_match match;    /* Fields to match */
408     ovs_be64 cookie;             /* Opaque controller-issued identifier. */
409
410     /* Flow actions. */
411     ovs_be16 command;             /* One of OFPFC_*. */
412     ovs_be16 idle_timeout;        /* Idle time before discarding (seconds). */
413     ovs_be16 hard_timeout;        /* Max time before discarding (seconds). */
414     ovs_be16 priority;            /* Priority level of flow entry. */
415     ovs_be32 buffer_id;           /* Buffered packet to apply to (or -1).
416                                      Not meaningful for OFPFC_DELETE*. */
417     ovs_be16 out_port;            /* For OFPFC_DELETE* commands, require
418                                      matching entries to include this as an
419                                      output port.  A value of OFPP_NONE
420                                      indicates no restriction. */
421     ovs_be16 flags;               /* One of OFPFF_*. */
422     struct ofp_action_header actions[0]; /* The action length is inferred
423                                             from the length field in the
424                                             header. */
425 };
426 OFP_ASSERT(sizeof(struct ofp_flow_mod) == 72);
427
428 /* Flow removed (datapath -> controller). */
429 struct ofp_flow_removed {
430     struct ofp_header header;
431     struct ofp10_match match; /* Description of fields. */
432     ovs_be64 cookie;          /* Opaque controller-issued identifier. */
433
434     ovs_be16 priority;        /* Priority level of flow entry. */
435     uint8_t reason;           /* One of OFPRR_*. */
436     uint8_t pad[1];           /* Align to 32-bits. */
437
438     ovs_be32 duration_sec;    /* Time flow was alive in seconds. */
439     ovs_be32 duration_nsec;   /* Time flow was alive in nanoseconds beyond
440                                  duration_sec. */
441     ovs_be16 idle_timeout;    /* Idle timeout from original flow mod. */
442     uint8_t pad2[2];          /* Align to 64-bits. */
443     ovs_be64 packet_count;
444     ovs_be64 byte_count;
445 };
446 OFP_ASSERT(sizeof(struct ofp_flow_removed) == 88);
447
448 /* OFPT_ERROR: Error message (datapath -> controller). */
449 struct ofp_error_msg {
450     struct ofp_header header;
451
452     ovs_be16 type;
453     ovs_be16 code;
454     uint8_t data[0];          /* Variable-length data.  Interpreted based
455                                  on the type and code. */
456 };
457 OFP_ASSERT(sizeof(struct ofp_error_msg) == 12);
458
459 /* Statistics request or reply message. */
460 struct ofp_stats_msg {
461     struct ofp_header header;
462     ovs_be16 type;              /* One of the OFPST_* constants. */
463     ovs_be16 flags;             /* Requests: always 0.
464                                  * Replies: 0 or OFPSF_REPLY_MORE. */
465 };
466 OFP_ASSERT(sizeof(struct ofp_stats_msg) == 12);
467
468 enum ofp_stats_reply_flags {
469     OFPSF_REPLY_MORE  = 1 << 0  /* More replies to follow. */
470 };
471
472 #define DESC_STR_LEN   256
473 #define SERIAL_NUM_LEN 32
474 /* Reply to OFPST_DESC request.  Each entry is a NULL-terminated ASCII
475  * string. */
476 struct ofp_desc_stats {
477     struct ofp_stats_msg osm;
478     char mfr_desc[DESC_STR_LEN];       /* Manufacturer description. */
479     char hw_desc[DESC_STR_LEN];        /* Hardware description. */
480     char sw_desc[DESC_STR_LEN];        /* Software description. */
481     char serial_num[SERIAL_NUM_LEN];   /* Serial number. */
482     char dp_desc[DESC_STR_LEN];        /* Human readable description of
483                                           the datapath. */
484 };
485 OFP_ASSERT(sizeof(struct ofp_desc_stats) == 1068);
486
487 /* Stats request of type OFPST_AGGREGATE or OFPST_FLOW. */
488 struct ofp_flow_stats_request {
489     struct ofp_stats_msg osm;
490     struct ofp10_match match; /* Fields to match. */
491     uint8_t table_id;         /* ID of table to read (from ofp_table_stats)
492                                  or 0xff for all tables. */
493     uint8_t pad;              /* Align to 32 bits. */
494     ovs_be16 out_port;        /* Require matching entries to include this
495                                  as an output port.  A value of OFPP_NONE
496                                  indicates no restriction. */
497 };
498 OFP_ASSERT(sizeof(struct ofp_flow_stats_request) == 56);
499
500 /* Body of reply to OFPST_FLOW request. */
501 struct ofp_flow_stats {
502     ovs_be16 length;          /* Length of this entry. */
503     uint8_t table_id;         /* ID of table flow came from. */
504     uint8_t pad;
505     struct ofp10_match match; /* Description of fields. */
506     ovs_be32 duration_sec;    /* Time flow has been alive in seconds. */
507     ovs_be32 duration_nsec;   /* Time flow has been alive in nanoseconds
508                                  beyond duration_sec. */
509     ovs_be16 priority;        /* Priority of the entry. Only meaningful
510                                  when this is not an exact-match entry. */
511     ovs_be16 idle_timeout;    /* Number of seconds idle before expiration. */
512     ovs_be16 hard_timeout;    /* Number of seconds before expiration. */
513     uint8_t pad2[6];          /* Align to 64 bits. */
514     ovs_32aligned_be64 cookie;       /* Opaque controller-issued identifier. */
515     ovs_32aligned_be64 packet_count; /* Number of packets in flow. */
516     ovs_32aligned_be64 byte_count;   /* Number of bytes in flow. */
517     struct ofp_action_header actions[0]; /* Actions. */
518 };
519 OFP_ASSERT(sizeof(struct ofp_flow_stats) == 88);
520
521 /* Reply to OFPST_AGGREGATE request. */
522 struct ofp_aggregate_stats_reply {
523     struct ofp_stats_msg osm;
524     ovs_32aligned_be64 packet_count; /* Number of packets in flows. */
525     ovs_32aligned_be64 byte_count;   /* Number of bytes in flows. */
526     ovs_be32 flow_count;      /* Number of flows. */
527     uint8_t pad[4];           /* Align to 64 bits. */
528 };
529 OFP_ASSERT(sizeof(struct ofp_aggregate_stats_reply) == 36);
530
531 /* Body of reply to OFPST_TABLE request. */
532 struct ofp_table_stats {
533     uint8_t table_id;        /* Identifier of table.  Lower numbered tables
534                                 are consulted first. */
535     uint8_t pad[3];          /* Align to 32-bits. */
536     char name[OFP_MAX_TABLE_NAME_LEN];
537     ovs_be32 wildcards;      /* Bitmap of OFPFW10_* wildcards that are
538                                 supported by the table. */
539     ovs_be32 max_entries;    /* Max number of entries supported. */
540     ovs_be32 active_count;   /* Number of active entries. */
541     ovs_32aligned_be64 lookup_count;  /* # of packets looked up in table. */
542     ovs_32aligned_be64 matched_count; /* Number of packets that hit table. */
543 };
544 OFP_ASSERT(sizeof(struct ofp_table_stats) == 64);
545
546 /* Stats request of type OFPST_PORT. */
547 struct ofp_port_stats_request {
548     struct ofp_stats_msg osm;
549     ovs_be16 port_no;        /* OFPST_PORT message may request statistics
550                                 for a single port (specified with port_no)
551                                 or for all ports (port_no == OFPP_NONE). */
552     uint8_t pad[6];
553 };
554 OFP_ASSERT(sizeof(struct ofp_port_stats_request) == 20);
555
556 /* Body of reply to OFPST_PORT request. If a counter is unsupported, set
557  * the field to all ones. */
558 struct ofp_port_stats {
559     ovs_be16 port_no;
560     uint8_t pad[6];          /* Align to 64-bits. */
561     ovs_32aligned_be64 rx_packets;     /* Number of received packets. */
562     ovs_32aligned_be64 tx_packets;     /* Number of transmitted packets. */
563     ovs_32aligned_be64 rx_bytes;       /* Number of received bytes. */
564     ovs_32aligned_be64 tx_bytes;       /* Number of transmitted bytes. */
565     ovs_32aligned_be64 rx_dropped;     /* Number of packets dropped by RX. */
566     ovs_32aligned_be64 tx_dropped;     /* Number of packets dropped by TX. */
567     ovs_32aligned_be64 rx_errors; /* Number of receive errors.  This is a
568                                      super-set of receive errors and should be
569                                      great than or equal to the sum of all
570                                      rx_*_err values. */
571     ovs_32aligned_be64 tx_errors; /* Number of transmit errors.  This is a
572                                      super-set of transmit errors. */
573     ovs_32aligned_be64 rx_frame_err; /* Number of frame alignment errors. */
574     ovs_32aligned_be64 rx_over_err;  /* Number of packets with RX overrun. */
575     ovs_32aligned_be64 rx_crc_err;   /* Number of CRC errors. */
576     ovs_32aligned_be64 collisions;   /* Number of collisions. */
577 };
578 OFP_ASSERT(sizeof(struct ofp_port_stats) == 104);
579
580 /* All ones is used to indicate all queues in a port (for stats retrieval). */
581 #define OFPQ_ALL      0xffffffff
582
583 /* Body for stats request of type OFPST_QUEUE. */
584 struct ofp_queue_stats_request {
585     struct ofp_stats_msg osm;
586     ovs_be16 port_no;        /* All ports if OFPP_ALL. */
587     uint8_t pad[2];          /* Align to 32-bits. */
588     ovs_be32 queue_id;       /* All queues if OFPQ_ALL. */
589 };
590 OFP_ASSERT(sizeof(struct ofp_queue_stats_request) == 20);
591
592 /* Body for stats reply of type OFPST_QUEUE consists of an array of this
593  * structure type. */
594 struct ofp_queue_stats {
595     ovs_be16 port_no;
596     uint8_t pad[2];          /* Align to 32-bits. */
597     ovs_be32 queue_id;       /* Queue id. */
598     ovs_32aligned_be64 tx_bytes;   /* Number of transmitted bytes. */
599     ovs_32aligned_be64 tx_packets; /* Number of transmitted packets. */
600     ovs_32aligned_be64 tx_errors;  /* # of packets dropped due to overrun. */
601 };
602 OFP_ASSERT(sizeof(struct ofp_queue_stats) == 32);
603
604 /* Vendor extension stats message. */
605 struct ofp_vendor_stats_msg {
606     struct ofp_stats_msg osm;   /* Type OFPST_VENDOR. */
607     ovs_be32 vendor;            /* Vendor ID:
608                                  * - MSB 0: low-order bytes are IEEE OUI.
609                                  * - MSB != 0: defined by OpenFlow
610                                  *   consortium. */
611     /* Followed by vendor-defined arbitrary additional data. */
612 };
613 OFP_ASSERT(sizeof(struct ofp_vendor_stats_msg) == 16);
614
615 /* Vendor extension. */
616 struct ofp_vendor_header {
617     struct ofp_header header;   /* Type OFPT_VENDOR. */
618     ovs_be32 vendor;            /* Vendor ID:
619                                  * - MSB 0: low-order bytes are IEEE OUI.
620                                  * - MSB != 0: defined by OpenFlow
621                                  *   consortium. */
622     /* Vendor-defined arbitrary additional data. */
623 };
624 OFP_ASSERT(sizeof(struct ofp_vendor_header) == 12);
625
626 #endif /* openflow/openflow-1.0.h */