datapath: handle recirculation loop detection
[sliver-openvswitch.git] / lib / ofp-util.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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 #ifndef OFP_UTIL_H
18 #define OFP_UTIL_H 1
19
20 #include <stdbool.h>
21 #include <stddef.h>
22 #include <stdint.h>
23 #include "bitmap.h"
24 #include "compiler.h"
25 #include "flow.h"
26 #include "list.h"
27 #include "match.h"
28 #include "netdev.h"
29 #include "openflow/nicira-ext.h"
30 #include "openvswitch/types.h"
31 #include "type-props.h"
32
33 struct ofpbuf;
34 union ofp_action;
35 struct ofpact_set_field;
36
37 /* Port numbers. */
38 enum ofperr ofputil_port_from_ofp11(ovs_be32 ofp11_port,
39                                     ofp_port_t *ofp10_port);
40 ovs_be32 ofputil_port_to_ofp11(ofp_port_t ofp10_port);
41
42 bool ofputil_port_from_string(const char *, ofp_port_t *portp);
43 void ofputil_format_port(ofp_port_t port, struct ds *);
44 void ofputil_port_to_string(ofp_port_t, char namebuf[OFP_MAX_PORT_NAME_LEN],
45                             size_t bufsize);
46
47 /* Group numbers. */
48 enum { MAX_GROUP_NAME_LEN = INT_STRLEN(uint32_t) };
49 bool ofputil_group_from_string(const char *, uint32_t *group_id);
50 void ofputil_format_group(uint32_t group_id, struct ds *);
51 void ofputil_group_to_string(uint32_t group_id,
52                              char namebuf[MAX_GROUP_NAME_LEN + 1],
53                              size_t bufsize);
54
55 /* Converting OFPFW10_NW_SRC_MASK and OFPFW10_NW_DST_MASK wildcard bit counts
56  * to and from IP bitmasks. */
57 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
58 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
59
60 /* Protocols.
61  *
62  * A "protocol" is an OpenFlow version plus, for some OpenFlow versions,
63  * a bit extra about the flow match format in use.
64  *
65  * These are arranged from most portable to least portable, or alternatively
66  * from least powerful to most powerful.  Protocols earlier on the list are
67  * more likely to be understood for the purpose of making requests, but
68  * protocol later on the list are more likely to accurately describe a flow
69  * within a switch.
70  *
71  * On any given OpenFlow connection, a single protocol is in effect at any
72  * given time.  These values use separate bits only because that makes it easy
73  * to test whether a particular protocol is within a given set of protocols and
74  * to implement set union and intersection.
75  */
76 enum ofputil_protocol {
77     /* OpenFlow 1.0 protocols.
78      *
79      * The "STD" protocols use the standard OpenFlow 1.0 flow format.
80      * The "NXM" protocols use the Nicira Extensible Match (NXM) flow format.
81      *
82      * The protocols with "TID" mean that the nx_flow_mod_table_id Nicira
83      * extension has been enabled.  The other protocols have it disabled.
84      */
85 #define OFPUTIL_P_NONE 0
86     OFPUTIL_P_OF10_STD     = 1 << 0,
87     OFPUTIL_P_OF10_STD_TID = 1 << 1,
88     OFPUTIL_P_OF10_NXM     = 1 << 2,
89     OFPUTIL_P_OF10_NXM_TID = 1 << 3,
90 #define OFPUTIL_P_OF10_STD_ANY (OFPUTIL_P_OF10_STD | OFPUTIL_P_OF10_STD_TID)
91 #define OFPUTIL_P_OF10_NXM_ANY (OFPUTIL_P_OF10_NXM | OFPUTIL_P_OF10_NXM_TID)
92 #define OFPUTIL_P_OF10_ANY (OFPUTIL_P_OF10_STD_ANY | OFPUTIL_P_OF10_NXM_ANY)
93
94     /* OpenFlow 1.1 protocol.
95      *
96      * We only support the standard OpenFlow 1.1 flow format.
97      *
98      * OpenFlow 1.1 always operates with an equivalent of the
99      * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
100      * variant. */
101     OFPUTIL_P_OF11_STD     = 1 << 4,
102
103     /* OpenFlow 1.2+ protocols (only one variant each).
104      *
105      * These use the standard OpenFlow Extensible Match (OXM) flow format.
106      *
107      * OpenFlow 1.2+ always operates with an equivalent of the
108      * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
109      * variant. */
110     OFPUTIL_P_OF12_OXM      = 1 << 5,
111     OFPUTIL_P_OF13_OXM      = 1 << 6,
112     OFPUTIL_P_OF14_OXM      = 1 << 7,
113 #define OFPUTIL_P_ANY_OXM (OFPUTIL_P_OF12_OXM | OFPUTIL_P_OF13_OXM | OFPUTIL_P_OF14_OXM)
114
115 #define OFPUTIL_P_NXM_OF11_UP (OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF11_STD | \
116                                OFPUTIL_P_ANY_OXM)
117
118 #define OFPUTIL_P_NXM_OXM_ANY (OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_ANY_OXM)
119
120 #define OFPUTIL_P_OF11_UP (OFPUTIL_P_OF11_STD | OFPUTIL_P_ANY_OXM)
121
122 #define OFPUTIL_P_OF12_UP (OFPUTIL_P_ANY_OXM)
123
124 #define OFPUTIL_P_OF13_UP (OFPUTIL_P_OF13_OXM)
125
126 #define OFPUTIL_P_OF14_UP (OFPUTIL_P_OF14_OXM)
127
128     /* All protocols. */
129 #define OFPUTIL_P_ANY ((1 << 8) - 1)
130
131     /* Protocols in which a specific table may be specified in flow_mods. */
132 #define OFPUTIL_P_TID (OFPUTIL_P_OF10_STD_TID | \
133                        OFPUTIL_P_OF10_NXM_TID | \
134                        OFPUTIL_P_OF11_STD |     \
135                        OFPUTIL_P_ANY_OXM)
136 };
137
138 /* Protocols to use for flow dumps, from most to least preferred. */
139 extern enum ofputil_protocol ofputil_flow_dump_protocols[];
140 extern size_t ofputil_n_flow_dump_protocols;
141
142 enum ofputil_protocol ofputil_protocol_from_ofp_version(enum ofp_version);
143 enum ofputil_protocol ofputil_protocols_from_ofp_version(enum ofp_version);
144 enum ofp_version ofputil_protocol_to_ofp_version(enum ofputil_protocol);
145
146 bool ofputil_protocol_is_valid(enum ofputil_protocol);
147 enum ofputil_protocol ofputil_protocol_set_tid(enum ofputil_protocol,
148                                                bool enable);
149 enum ofputil_protocol ofputil_protocol_to_base(enum ofputil_protocol);
150 enum ofputil_protocol ofputil_protocol_set_base(
151     enum ofputil_protocol cur, enum ofputil_protocol new_base);
152
153 const char *ofputil_protocol_to_string(enum ofputil_protocol);
154 char *ofputil_protocols_to_string(enum ofputil_protocol);
155 enum ofputil_protocol ofputil_protocols_from_string(const char *);
156
157 void ofputil_format_version(struct ds *, enum ofp_version);
158 void ofputil_format_version_name(struct ds *, enum ofp_version);
159
160 /* A bitmap of version numbers
161  *
162  * Bit offsets correspond to ofp_version numbers which in turn correspond to
163  * wire-protocol numbers for Open Flow versions..  E.g. (1u << OFP11_VERSION)
164  * is the mask for Open Flow 1.1.  If the bit for a version is set then it is
165  * allowed, otherwise it is disallowed. */
166
167 void ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap);
168 void ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap);
169
170 uint32_t ofputil_protocols_to_version_bitmap(enum ofputil_protocol);
171 enum ofputil_protocol ofputil_protocols_from_version_bitmap(uint32_t bitmap);
172
173 /* Bitmaps of OpenFlow versions that Open vSwitch supports, and that it enables
174  * by default.  When Open vSwitch has experimental or incomplete support for
175  * newer versions of OpenFlow, those versions should not be supported by
176  * default and thus should be omitted from the latter bitmap. */
177 #define OFPUTIL_SUPPORTED_VERSIONS ((1u << OFP10_VERSION) | \
178                                     (1u << OFP11_VERSION) | \
179                                     (1u << OFP12_VERSION) | \
180                                     (1u << OFP13_VERSION))
181 #define OFPUTIL_DEFAULT_VERSIONS OFPUTIL_SUPPORTED_VERSIONS
182
183 enum ofputil_protocol ofputil_protocols_from_string(const char *s);
184
185 const char *ofputil_version_to_string(enum ofp_version ofp_version);
186 uint32_t ofputil_versions_from_string(const char *s);
187 uint32_t ofputil_versions_from_strings(char ** const s, size_t count);
188
189 bool ofputil_decode_hello(const struct ofp_header *,
190                           uint32_t *allowed_versions);
191 struct ofpbuf *ofputil_encode_hello(uint32_t version_bitmap);
192
193 struct ofpbuf *ofputil_encode_set_protocol(enum ofputil_protocol current,
194                                            enum ofputil_protocol want,
195                                            enum ofputil_protocol *next);
196
197 /* nx_flow_format */
198 struct ofpbuf *ofputil_encode_nx_set_flow_format(enum nx_flow_format);
199 enum ofputil_protocol ofputil_nx_flow_format_to_protocol(enum nx_flow_format);
200 bool ofputil_nx_flow_format_is_valid(enum nx_flow_format);
201 const char *ofputil_nx_flow_format_to_string(enum nx_flow_format);
202
203 /* Work with ofp10_match. */
204 void ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *);
205 void ofputil_match_from_ofp10_match(const struct ofp10_match *,
206                                     struct match *);
207 void ofputil_normalize_match(struct match *);
208 void ofputil_normalize_match_quiet(struct match *);
209 void ofputil_match_to_ofp10_match(const struct match *, struct ofp10_match *);
210
211 /* Work with ofp11_match. */
212 enum ofperr ofputil_pull_ofp11_match(struct ofpbuf *, struct match *,
213                                      uint16_t *padded_match_len);
214 enum ofperr ofputil_match_from_ofp11_match(const struct ofp11_match *,
215                                            struct match *);
216 int ofputil_put_ofp11_match(struct ofpbuf *, const struct match *,
217                             enum ofputil_protocol);
218 void ofputil_match_to_ofp11_match(const struct match *, struct ofp11_match *);
219 int ofputil_match_typical_len(enum ofputil_protocol);
220
221 /* dl_type translation between OpenFlow and 'struct flow' format. */
222 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
223 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
224
225 /* PACKET_IN. */
226 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
227 int ofputil_packet_in_format_from_string(const char *);
228 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
229 struct ofpbuf *ofputil_make_set_packet_in_format(enum ofp_version,
230                                                  enum nx_packet_in_format);
231
232 /* NXT_FLOW_MOD_TABLE_ID extension. */
233 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
234
235 /* Protocol-independent flow_mod flags. */
236 enum ofputil_flow_mod_flags {
237     /* Flags that are maintained with a flow as part of its state.
238      *
239      * (OFPUTIL_FF_EMERG would be here too, if OVS supported it.) */
240     OFPUTIL_FF_SEND_FLOW_REM = 1 << 0, /* All versions. */
241     OFPUTIL_FF_NO_PKT_COUNTS = 1 << 1, /* OpenFlow 1.3+. */
242     OFPUTIL_FF_NO_BYT_COUNTS = 1 << 2, /* OpenFlow 1.3+. */
243 #define OFPUTIL_FF_STATE (OFPUTIL_FF_SEND_FLOW_REM      \
244                           | OFPUTIL_FF_NO_PKT_COUNTS    \
245                           | OFPUTIL_FF_NO_BYT_COUNTS)
246
247     /* Flags that affect flow_mod behavior but are not part of flow state. */
248     OFPUTIL_FF_CHECK_OVERLAP = 1 << 3, /* All versions. */
249     OFPUTIL_FF_EMERG         = 1 << 4, /* OpenFlow 1.0 only. */
250     OFPUTIL_FF_RESET_COUNTS  = 1 << 5, /* OpenFlow 1.2+. */
251
252     /* Flags that are only set by OVS for its internal use.  Cannot be set via
253      * OpenFlow. */
254     OFPUTIL_FF_HIDDEN_FIELDS = 1 << 6, /* Allow hidden match fields to be
255                                           set or modified. */
256     OFPUTIL_FF_NO_READONLY   = 1 << 7, /* Allow rules within read only tables
257                                           to be modified */
258 };
259
260 /* Protocol-independent flow_mod.
261  *
262  * The handling of cookies across multiple versions of OpenFlow is a bit
263  * confusing.  See DESIGN for the details. */
264 struct ofputil_flow_mod {
265     struct list list_node;    /* For queuing flow_mods. */
266
267     struct match match;
268     unsigned int priority;
269
270     /* Cookie matching.  The flow_mod affects only flows that have cookies that
271      * bitwise match 'cookie' bits in positions where 'cookie_mask has 1-bits.
272      *
273      * 'cookie_mask' should be zero for OFPFC_ADD flow_mods. */
274     ovs_be64 cookie;         /* Cookie bits to match. */
275     ovs_be64 cookie_mask;    /* 1-bit in each 'cookie' bit to match. */
276
277     /* Cookie changes.
278      *
279      * OFPFC_ADD uses 'new_cookie' as the new flow's cookie.  'new_cookie'
280      * should not be UINT64_MAX.
281      *
282      * OFPFC_MODIFY and OFPFC_MODIFY_STRICT have two cases:
283      *
284      *   - If one or more matching flows exist and 'modify_cookie' is true,
285      *     then the flow_mod changes the existing flows' cookies to
286      *     'new_cookie'.  'new_cookie' should not be UINT64_MAX.
287      *
288      *   - If no matching flow exists, 'new_cookie' is not UINT64_MAX, and
289      *     'cookie_mask' is 0, then the flow_mod adds a new flow with
290      *     'new_cookie' as its cookie.
291      */
292     ovs_be64 new_cookie;     /* New cookie to install or UINT64_MAX. */
293     bool modify_cookie;      /* Set cookie of existing flow to 'new_cookie'? */
294
295     uint8_t table_id;
296     uint16_t command;
297     uint16_t idle_timeout;
298     uint16_t hard_timeout;
299     uint32_t buffer_id;
300     ofp_port_t out_port;
301     uint32_t out_group;
302     enum ofputil_flow_mod_flags flags;
303     struct ofpact *ofpacts;  /* Series of "struct ofpact"s. */
304     size_t ofpacts_len;      /* Length of ofpacts, in bytes. */
305 };
306
307 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
308                                     const struct ofp_header *,
309                                     enum ofputil_protocol,
310                                     struct ofpbuf *ofpacts,
311                                     ofp_port_t max_port,
312                                     uint8_t max_table);
313 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
314                                        enum ofputil_protocol);
315
316 /* Flow stats or aggregate stats request, independent of protocol. */
317 struct ofputil_flow_stats_request {
318     bool aggregate;             /* Aggregate results? */
319     struct match match;
320     ovs_be64 cookie;
321     ovs_be64 cookie_mask;
322     ofp_port_t out_port;
323     uint32_t out_group;
324     uint8_t table_id;
325 };
326
327 enum ofperr ofputil_decode_flow_stats_request(
328     struct ofputil_flow_stats_request *, const struct ofp_header *);
329 struct ofpbuf *ofputil_encode_flow_stats_request(
330     const struct ofputil_flow_stats_request *, enum ofputil_protocol);
331
332 /* Flow stats reply, independent of protocol. */
333 struct ofputil_flow_stats {
334     struct match match;
335     ovs_be64 cookie;
336     uint8_t table_id;
337     uint16_t priority;
338     uint16_t idle_timeout;
339     uint16_t hard_timeout;
340     uint32_t duration_sec;
341     uint32_t duration_nsec;
342     int idle_age;               /* Seconds since last packet, -1 if unknown. */
343     int hard_age;               /* Seconds since last change, -1 if unknown. */
344     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
345     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
346     const struct ofpact *ofpacts;
347     size_t ofpacts_len;
348     enum ofputil_flow_mod_flags flags;
349 };
350
351 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
352                                     struct ofpbuf *msg,
353                                     bool flow_age_extension,
354                                     struct ofpbuf *ofpacts);
355 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
356                                      struct list *replies);
357
358 /* Aggregate stats reply, independent of protocol. */
359 struct ofputil_aggregate_stats {
360     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
361     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
362     uint32_t flow_count;
363 };
364
365 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
366     const struct ofputil_aggregate_stats *stats,
367     const struct ofp_header *request);
368 enum ofperr ofputil_decode_aggregate_stats_reply(
369     struct ofputil_aggregate_stats *,
370     const struct ofp_header *reply);
371
372 /* Flow removed message, independent of protocol. */
373 struct ofputil_flow_removed {
374     struct match match;
375     ovs_be64 cookie;
376     uint16_t priority;
377     uint8_t reason;             /* One of OFPRR_*. */
378     uint8_t table_id;           /* 255 if message didn't include table ID. */
379     uint32_t duration_sec;
380     uint32_t duration_nsec;
381     uint16_t idle_timeout;
382     uint16_t hard_timeout;
383     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
384     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
385 };
386
387 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
388                                         const struct ofp_header *);
389 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
390                                            enum ofputil_protocol);
391
392 /* Abstract packet-in message. */
393 struct ofputil_packet_in {
394     /* Packet data and metadata.
395      *
396      * To save bandwidth, in some cases a switch may send only the first
397      * several bytes of a packet, indicated by 'packet_len < total_len'.  When
398      * the full packet is included, 'packet_len == total_len'. */
399     const void *packet;
400     size_t packet_len;          /* Number of bytes in 'packet'. */
401     size_t total_len;           /* Size of packet, pre-truncation. */
402     struct flow_metadata fmd;
403
404     /* Identifies a buffer in the switch that contains the full packet, to
405      * allow the controller to reference it later without having to send the
406      * entire packet back to the switch.
407      *
408      * UINT32_MAX indicates that the packet is not buffered in the switch.  A
409      * switch should only use UINT32_MAX when it sends the entire packet. */
410     uint32_t buffer_id;
411
412     /* Reason that the packet-in is being sent. */
413     enum ofp_packet_in_reason reason;    /* One of OFPR_*. */
414
415     /* Information about the OpenFlow flow that triggered the packet-in.
416      *
417      * A packet-in triggered by a flow table miss has no associated flow.  In
418      * that case, 'cookie' is UINT64_MAX. */
419     uint8_t table_id;                    /* OpenFlow table ID. */
420     ovs_be64 cookie;                     /* Flow's cookie. */
421 };
422
423 enum ofperr ofputil_decode_packet_in(struct ofputil_packet_in *,
424                                      const struct ofp_header *);
425 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
426                                         enum ofputil_protocol protocol,
427                                         enum nx_packet_in_format);
428
429 enum { OFPUTIL_PACKET_IN_REASON_BUFSIZE = INT_STRLEN(int) + 1 };
430 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason,
431                                                char *reasonbuf,
432                                                size_t bufsize);
433 bool ofputil_packet_in_reason_from_string(const char *,
434                                           enum ofp_packet_in_reason *);
435
436 /* Abstract packet-out message.
437  *
438  * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
439  * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
440 struct ofputil_packet_out {
441     const void *packet;         /* Packet data, if buffer_id == UINT32_MAX. */
442     size_t packet_len;          /* Length of packet data in bytes. */
443     uint32_t buffer_id;         /* Buffer id or UINT32_MAX if no buffer. */
444     ofp_port_t in_port;         /* Packet's input port. */
445     struct ofpact *ofpacts;     /* Actions. */
446     size_t ofpacts_len;         /* Size of ofpacts in bytes. */
447 };
448
449 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
450                                       const struct ofp_header *,
451                                       struct ofpbuf *ofpacts);
452 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *,
453                                          enum ofputil_protocol protocol);
454
455 enum ofputil_port_config {
456     /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */
457     OFPUTIL_PC_PORT_DOWN    = 1 << 0, /* Port is administratively down. */
458     OFPUTIL_PC_NO_RECV      = 1 << 2, /* Drop all packets received by port. */
459     OFPUTIL_PC_NO_FWD       = 1 << 5, /* Drop packets forwarded to port. */
460     OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */
461     /* OpenFlow 1.0 only. */
462     OFPUTIL_PC_NO_STP       = 1 << 1, /* No 802.1D spanning tree for port. */
463     OFPUTIL_PC_NO_RECV_STP  = 1 << 3, /* Drop received 802.1D STP packets. */
464     OFPUTIL_PC_NO_FLOOD     = 1 << 4, /* Do not include port when flooding. */
465     /* There are no OpenFlow 1.1-only bits. */
466 };
467
468 enum ofputil_port_state {
469     /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */
470     OFPUTIL_PS_LINK_DOWN   = 1 << 0, /* No physical link present. */
471     /* OpenFlow 1.1 only. */
472     OFPUTIL_PS_BLOCKED     = 1 << 1, /* Port is blocked */
473     OFPUTIL_PS_LIVE        = 1 << 2, /* Live for Fast Failover Group. */
474     /* OpenFlow 1.0 only. */
475     OFPUTIL_PS_STP_LISTEN  = 0 << 8, /* Not learning or relaying frames. */
476     OFPUTIL_PS_STP_LEARN   = 1 << 8, /* Learning but not relaying frames. */
477     OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
478     OFPUTIL_PS_STP_BLOCK   = 3 << 8, /* Not part of spanning tree. */
479     OFPUTIL_PS_STP_MASK    = 3 << 8  /* Bit mask for OFPPS10_STP_* values. */
480 };
481
482 /* Abstract ofp10_phy_port or ofp11_port. */
483 struct ofputil_phy_port {
484     ofp_port_t port_no;
485     uint8_t hw_addr[OFP_ETH_ALEN];
486     char name[OFP_MAX_PORT_NAME_LEN];
487     enum ofputil_port_config config;
488     enum ofputil_port_state state;
489
490     /* NETDEV_F_* feature bitmasks. */
491     enum netdev_features curr;       /* Current features. */
492     enum netdev_features advertised; /* Features advertised by the port. */
493     enum netdev_features supported;  /* Features supported by the port. */
494     enum netdev_features peer;       /* Features advertised by peer. */
495
496     /* Speed. */
497     uint32_t curr_speed;        /* Current speed, in kbps. */
498     uint32_t max_speed;         /* Maximum supported speed, in kbps. */
499 };
500
501 enum ofputil_capabilities {
502     /* OpenFlow 1.0, 1.1, 1.2, and 1.3 share these capability values. */
503     OFPUTIL_C_FLOW_STATS     = 1 << 0,  /* Flow statistics. */
504     OFPUTIL_C_TABLE_STATS    = 1 << 1,  /* Table statistics. */
505     OFPUTIL_C_PORT_STATS     = 1 << 2,  /* Port statistics. */
506     OFPUTIL_C_IP_REASM       = 1 << 5,  /* Can reassemble IP fragments. */
507     OFPUTIL_C_QUEUE_STATS    = 1 << 6,  /* Queue statistics. */
508
509     /* OpenFlow 1.0 and 1.1 share this capability. */
510     OFPUTIL_C_ARP_MATCH_IP   = 1 << 7,  /* Match IP addresses in ARP pkts. */
511
512     /* OpenFlow 1.0 only. */
513     OFPUTIL_C_STP            = 1 << 3,  /* 802.1d spanning tree. */
514
515     /* OpenFlow 1.1, 1.2, and 1.3 share this capability. */
516     OFPUTIL_C_GROUP_STATS    = 1 << 4,  /* Group statistics. */
517
518     /* OpenFlow 1.2 and 1.3 share this capability */
519     OFPUTIL_C_PORT_BLOCKED   = 1 << 8,  /* Switch will block looping ports */
520 };
521
522 enum ofputil_action_bitmap {
523     OFPUTIL_A_OUTPUT         = 1 << 0,
524     OFPUTIL_A_SET_VLAN_VID   = 1 << 1,
525     OFPUTIL_A_SET_VLAN_PCP   = 1 << 2,
526     OFPUTIL_A_STRIP_VLAN     = 1 << 3,
527     OFPUTIL_A_SET_DL_SRC     = 1 << 4,
528     OFPUTIL_A_SET_DL_DST     = 1 << 5,
529     OFPUTIL_A_SET_NW_SRC     = 1 << 6,
530     OFPUTIL_A_SET_NW_DST     = 1 << 7,
531     OFPUTIL_A_SET_NW_ECN     = 1 << 8,
532     OFPUTIL_A_SET_NW_TOS     = 1 << 9,
533     OFPUTIL_A_SET_TP_SRC     = 1 << 10,
534     OFPUTIL_A_SET_TP_DST     = 1 << 11,
535     OFPUTIL_A_ENQUEUE        = 1 << 12,
536     OFPUTIL_A_COPY_TTL_OUT   = 1 << 13,
537     OFPUTIL_A_COPY_TTL_IN    = 1 << 14,
538     OFPUTIL_A_SET_MPLS_LABEL = 1 << 15,
539     OFPUTIL_A_SET_MPLS_TC    = 1 << 16,
540     OFPUTIL_A_SET_MPLS_TTL   = 1 << 17,
541     OFPUTIL_A_DEC_MPLS_TTL   = 1 << 18,
542     OFPUTIL_A_PUSH_VLAN      = 1 << 19,
543     OFPUTIL_A_POP_VLAN       = 1 << 20,
544     OFPUTIL_A_PUSH_MPLS      = 1 << 21,
545     OFPUTIL_A_POP_MPLS       = 1 << 22,
546     OFPUTIL_A_SET_QUEUE      = 1 << 23,
547     OFPUTIL_A_GROUP          = 1 << 24,
548     OFPUTIL_A_SET_NW_TTL     = 1 << 25,
549     OFPUTIL_A_DEC_NW_TTL     = 1 << 26,
550     OFPUTIL_A_SET_FIELD      = 1 << 27,
551 };
552
553 /* Abstract ofp_switch_features. */
554 struct ofputil_switch_features {
555     uint64_t datapath_id;       /* Datapath unique ID. */
556     uint32_t n_buffers;         /* Max packets buffered at once. */
557     uint8_t n_tables;           /* Number of tables supported by datapath. */
558     uint8_t auxiliary_id;       /* Identify auxiliary connections */
559     enum ofputil_capabilities capabilities;
560     enum ofputil_action_bitmap actions;
561 };
562
563 enum ofperr ofputil_decode_switch_features(const struct ofp_header *,
564                                            struct ofputil_switch_features *,
565                                            struct ofpbuf *);
566
567 struct ofpbuf *ofputil_encode_switch_features(
568     const struct ofputil_switch_features *, enum ofputil_protocol,
569     ovs_be32 xid);
570 void ofputil_put_switch_features_port(const struct ofputil_phy_port *,
571                                       struct ofpbuf *);
572 bool ofputil_switch_features_ports_trunc(struct ofpbuf *b);
573
574 /* phy_port helper functions. */
575 int ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *,
576                           struct ofputil_phy_port *);
577 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *);
578
579 /* Abstract ofp_port_status. */
580 struct ofputil_port_status {
581     enum ofp_port_reason reason;
582     struct ofputil_phy_port desc;
583 };
584
585 enum ofperr ofputil_decode_port_status(const struct ofp_header *,
586                                        struct ofputil_port_status *);
587 struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *,
588                                           enum ofputil_protocol);
589
590 /* Abstract ofp_port_mod. */
591 struct ofputil_port_mod {
592     ofp_port_t port_no;
593     uint8_t hw_addr[OFP_ETH_ALEN];
594     enum ofputil_port_config config;
595     enum ofputil_port_config mask;
596     enum netdev_features advertise;
597 };
598
599 enum ofperr ofputil_decode_port_mod(const struct ofp_header *,
600                                     struct ofputil_port_mod *);
601 struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
602                                        enum ofputil_protocol);
603
604 /* Abstract ofp_table_mod. */
605 struct ofputil_table_mod {
606     uint8_t table_id;         /* ID of the table, 0xff indicates all tables. */
607     enum ofp_table_config config;
608 };
609
610 enum ofperr ofputil_decode_table_mod(const struct ofp_header *,
611                                     struct ofputil_table_mod *);
612 struct ofpbuf *ofputil_encode_table_mod(const struct ofputil_table_mod *,
613                                        enum ofputil_protocol);
614
615 /* Abstract ofp_table_features. */
616 struct ofputil_table_features {
617     uint8_t table_id;         /* Identifier of table. Lower numbered tables
618                                  are consulted first. */
619     char name[OFP_MAX_TABLE_NAME_LEN];
620     ovs_be64 metadata_match;  /* Bits of metadata table can match. */
621     ovs_be64 metadata_write;  /* Bits of metadata table can write. */
622     uint32_t config;          /* Bitmap of OFPTC_* values */
623     uint32_t max_entries;     /* Max number of entries supported. */
624
625     /* Table features related to instructions.  There are two instances:
626      *
627      *   - 'miss' reports features available in the table miss flow.
628      *
629      *   - 'nonmiss' reports features available in other flows. */
630     struct ofputil_table_instruction_features {
631         /* Tables that "goto-table" may jump to. */
632         unsigned long int next[BITMAP_N_LONGS(255)];
633
634         /* Bitmap of OVSINST_* for supported instructions. */
635         uint32_t instructions;
636
637         /* Table features related to actions.  There are two instances:
638          *
639          *    - 'write' reports features available in a "write_actions"
640          *      instruction.
641          *
642          *    - 'apply' reports features available in an "apply_actions"
643          *      instruction. */
644         struct ofputil_table_action_features {
645             uint32_t actions;     /* Bitmap of supported OFPAT*. */
646             uint64_t set_fields;  /* Bitmap of MFF_* "set-field" supports. */
647         } write, apply;
648     } nonmiss, miss;
649
650     /* MFF_* bitmaps.
651      *
652      * For any given field the following combinations are valid:
653      *
654      *    - match=0, wildcard=0, mask=0: Flows in this table cannot match on
655      *      this field.
656      *
657      *    - match=1, wildcard=0, mask=0: Flows in this table must match on all
658      *      the bits in this field.
659      *
660      *    - match=1, wildcard=1, mask=0: Flows in this table must either match
661      *      on all the bits in the field or wildcard the field entirely.
662      *
663      *    - match=1, wildcard=1, mask=1: Flows in this table may arbitrarily
664      *      mask this field (as special cases, they may match on all the bits
665      *      or wildcard it entirely).
666      *
667      * Other combinations do not make sense.
668      */
669     uint64_t match;             /* Fields that may be matched. */
670     uint64_t mask;              /* Subset of 'match' that may have masks. */
671     uint64_t wildcard;          /* Subset of 'match' that may be wildcarded. */
672 };
673
674 int ofputil_decode_table_features(struct ofpbuf *,
675                                   struct ofputil_table_features *, bool loose);
676 struct ofpbuf *ofputil_encode_table_features_request(
677                             enum ofp_version ofp_version);
678 void ofputil_append_table_features_reply(
679                             const struct ofputil_table_features *tf,
680                             struct list *replies);
681
682 uint16_t table_feature_prop_get_size(enum ofp13_table_feature_prop_type type);
683 char *table_feature_prop_get_name(enum ofp13_table_feature_prop_type type);
684
685 /* Meter band configuration for all supported band types. */
686 struct ofputil_meter_band {
687     uint16_t type;
688     uint8_t prec_level;         /* Non-zero if type == OFPMBT_DSCP_REMARK. */
689     uint32_t rate;
690     uint32_t burst_size;
691 };
692
693 struct ofputil_meter_band_stats {
694     uint64_t packet_count;
695     uint64_t byte_count;
696 };
697
698 struct ofputil_meter_config {
699     uint32_t meter_id;
700     uint16_t flags;
701     uint16_t n_bands;
702     struct ofputil_meter_band *bands;
703 };
704
705 /* Abstract ofp_meter_mod. */
706 struct ofputil_meter_mod {
707     uint16_t command;
708     struct ofputil_meter_config meter;
709 };
710
711 struct ofputil_meter_stats {
712     uint32_t meter_id;
713     uint32_t flow_count;
714     uint64_t packet_in_count;
715     uint64_t byte_in_count;
716     uint32_t duration_sec;
717     uint32_t duration_nsec;
718     uint16_t n_bands;
719     struct ofputil_meter_band_stats *bands;
720 };
721
722 struct ofputil_meter_features {
723     uint32_t max_meters;        /* Maximum number of meters. */
724     uint32_t band_types;        /* Can support max 32 band types. */
725     uint32_t capabilities;      /* Supported flags. */
726     uint8_t  max_bands;
727     uint8_t  max_color;
728 };
729
730 enum ofperr ofputil_decode_meter_mod(const struct ofp_header *,
731                                      struct ofputil_meter_mod *,
732                                      struct ofpbuf *bands);
733 struct ofpbuf *ofputil_encode_meter_mod(enum ofp_version,
734                                         const struct ofputil_meter_mod *);
735
736 void ofputil_decode_meter_features(const struct ofp_header *,
737                                    struct ofputil_meter_features *);
738 struct ofpbuf *ofputil_encode_meter_features_reply(const struct
739                                                    ofputil_meter_features *,
740                                                    const struct ofp_header *
741                                                    request);
742 void ofputil_decode_meter_request(const struct ofp_header *,
743                                   uint32_t *meter_id);
744
745 void ofputil_append_meter_config(struct list *replies,
746                                  const struct ofputil_meter_config *);
747
748 void ofputil_append_meter_stats(struct list *replies,
749                                 const struct ofputil_meter_stats *);
750
751 enum ofputil_meter_request_type {
752     OFPUTIL_METER_FEATURES,
753     OFPUTIL_METER_CONFIG,
754     OFPUTIL_METER_STATS
755 };
756
757 struct ofpbuf *ofputil_encode_meter_request(enum ofp_version,
758                                             enum ofputil_meter_request_type,
759                                             uint32_t meter_id);
760
761 int ofputil_decode_meter_stats(struct ofpbuf *,
762                                struct ofputil_meter_stats *,
763                                struct ofpbuf *bands);
764
765 int ofputil_decode_meter_config(struct ofpbuf *,
766                                 struct ofputil_meter_config *,
767                                 struct ofpbuf *bands);
768
769 /* Type for meter_id in ofproto provider interface, UINT32_MAX if invalid. */
770 typedef struct { uint32_t uint32; } ofproto_meter_id;
771
772 /* Abstract ofp_role_request and reply. */
773 struct ofputil_role_request {
774     enum ofp12_controller_role role;
775     bool have_generation_id;
776     uint64_t generation_id;
777 };
778
779 struct ofputil_role_status {
780     enum ofp12_controller_role role;
781     enum ofp14_controller_role_reason reason;
782     uint64_t generation_id;
783 };
784
785 enum ofperr ofputil_decode_role_message(const struct ofp_header *,
786                                         struct ofputil_role_request *);
787 struct ofpbuf *ofputil_encode_role_reply(const struct ofp_header *,
788                                          const struct ofputil_role_request *);
789
790 struct ofpbuf *ofputil_encode_role_status(
791                                 const struct ofputil_role_status *status,
792                                 enum ofputil_protocol protocol);
793
794 enum ofperr ofputil_decode_role_status(const struct ofp_header *oh,
795                                        struct ofputil_role_status *rs);
796 /* Abstract table stats.
797  *
798  * For now we use ofp12_table_stats as a superset of the other protocol
799  * versions' table stats. */
800
801 struct ofpbuf *ofputil_encode_table_stats_reply(
802     const struct ofp12_table_stats[], int n,
803     const struct ofp_header *request);
804
805 /* Queue configuration request. */
806 struct ofpbuf *ofputil_encode_queue_get_config_request(enum ofp_version,
807                                                        ofp_port_t port);
808 enum ofperr ofputil_decode_queue_get_config_request(const struct ofp_header *,
809                                                     ofp_port_t *port);
810
811 /* Queue configuration reply. */
812 struct ofputil_queue_config {
813     uint32_t queue_id;
814
815     /* Each of these optional values is expressed in tenths of a percent.
816      * Values greater than 1000 indicate that the feature is disabled.
817      * UINT16_MAX indicates that the value is omitted. */
818     uint16_t min_rate;
819     uint16_t max_rate;
820 };
821
822 struct ofpbuf *ofputil_encode_queue_get_config_reply(
823     const struct ofp_header *request);
824 void ofputil_append_queue_get_config_reply(
825     struct ofpbuf *reply, const struct ofputil_queue_config *);
826
827 enum ofperr ofputil_decode_queue_get_config_reply(struct ofpbuf *reply,
828                                                   ofp_port_t *);
829 int ofputil_pull_queue_get_config_reply(struct ofpbuf *reply,
830                                         struct ofputil_queue_config *);
831
832
833 /* Abstract nx_flow_monitor_request. */
834 struct ofputil_flow_monitor_request {
835     uint32_t id;
836     enum nx_flow_monitor_flags flags;
837     ofp_port_t out_port;
838     uint8_t table_id;
839     struct match match;
840 };
841
842 int ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *,
843                                         struct ofpbuf *msg);
844 void ofputil_append_flow_monitor_request(
845     const struct ofputil_flow_monitor_request *, struct ofpbuf *msg);
846
847 /* Abstract nx_flow_update. */
848 struct ofputil_flow_update {
849     enum nx_flow_update_event event;
850
851     /* Used only for NXFME_ADDED, NXFME_DELETED, NXFME_MODIFIED. */
852     enum ofp_flow_removed_reason reason;
853     uint16_t idle_timeout;
854     uint16_t hard_timeout;
855     uint8_t table_id;
856     uint16_t priority;
857     ovs_be64 cookie;
858     struct match *match;
859     const struct ofpact *ofpacts;
860     size_t ofpacts_len;
861
862     /* Used only for NXFME_ABBREV. */
863     ovs_be32 xid;
864 };
865
866 int ofputil_decode_flow_update(struct ofputil_flow_update *,
867                                struct ofpbuf *msg, struct ofpbuf *ofpacts);
868 void ofputil_start_flow_update(struct list *replies);
869 void ofputil_append_flow_update(const struct ofputil_flow_update *,
870                                 struct list *replies);
871
872 /* Abstract nx_flow_monitor_cancel. */
873 uint32_t ofputil_decode_flow_monitor_cancel(const struct ofp_header *);
874 struct ofpbuf *ofputil_encode_flow_monitor_cancel(uint32_t id);
875
876 /* Encoding OpenFlow stats messages. */
877 void ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
878                                           const struct ofputil_phy_port *pp,
879                                           struct list *replies);
880
881 /* Encoding simple OpenFlow messages. */
882 struct ofpbuf *make_echo_request(enum ofp_version);
883 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
884
885 struct ofpbuf *ofputil_encode_barrier_request(enum ofp_version);
886
887 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
888 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
889
890 \f
891 /* Actions. */
892
893 /* The type of an action.
894  *
895  * For each implemented OFPAT10_* and NXAST_* action type, there is a
896  * corresponding constant prefixed with OFPUTIL_, e.g.:
897  *
898  * OFPUTIL_OFPAT10_OUTPUT
899  * OFPUTIL_OFPAT10_SET_VLAN_VID
900  * OFPUTIL_OFPAT10_SET_VLAN_PCP
901  * OFPUTIL_OFPAT10_STRIP_VLAN
902  * OFPUTIL_OFPAT10_SET_DL_SRC
903  * OFPUTIL_OFPAT10_SET_DL_DST
904  * OFPUTIL_OFPAT10_SET_NW_SRC
905  * OFPUTIL_OFPAT10_SET_NW_DST
906  * OFPUTIL_OFPAT10_SET_NW_TOS
907  * OFPUTIL_OFPAT10_SET_TP_SRC
908  * OFPUTIL_OFPAT10_SET_TP_DST
909  * OFPUTIL_OFPAT10_ENQUEUE
910  * OFPUTIL_NXAST_RESUBMIT
911  * OFPUTIL_NXAST_SET_TUNNEL
912  * OFPUTIL_NXAST_SET_METADATA
913  * OFPUTIL_NXAST_SET_QUEUE
914  * OFPUTIL_NXAST_POP_QUEUE
915  * OFPUTIL_NXAST_REG_MOVE
916  * OFPUTIL_NXAST_REG_LOAD
917  * OFPUTIL_NXAST_NOTE
918  * OFPUTIL_NXAST_SET_TUNNEL64
919  * OFPUTIL_NXAST_MULTIPATH
920  * OFPUTIL_NXAST_BUNDLE
921  * OFPUTIL_NXAST_BUNDLE_LOAD
922  * OFPUTIL_NXAST_RESUBMIT_TABLE
923  * OFPUTIL_NXAST_OUTPUT_REG
924  * OFPUTIL_NXAST_LEARN
925  * OFPUTIL_NXAST_DEC_TTL
926  * OFPUTIL_NXAST_FIN_TIMEOUT
927  *
928  * (The above list helps developers who want to "grep" for these definitions.)
929  */
930 enum OVS_PACKED_ENUM ofputil_action_code {
931     OFPUTIL_ACTION_INVALID,
932 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             OFPUTIL_##ENUM,
933 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
934 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
935 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)   OFPUTIL_##ENUM,
936 #include "ofp-util.def"
937 };
938
939 /* The number of values of "enum ofputil_action_code". */
940 enum {
941 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)             + 1
942 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
943 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
944 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)   + 1
945     OFPUTIL_N_ACTIONS = 1
946 #include "ofp-util.def"
947 };
948
949 int ofputil_action_code_from_name(const char *);
950 const char * ofputil_action_name_from_code(enum ofputil_action_code code);
951 enum ofputil_action_code ofputil_action_code_from_ofp13_action(
952     enum ofp13_action_type type);
953
954 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
955
956 /* For each OpenFlow action <ENUM> that has a corresponding action structure
957  * struct <STRUCT>, this defines two functions:
958  *
959  *   void ofputil_init_<ENUM>(struct <STRUCT> *action);
960  *
961  *     Initializes the parts of 'action' that identify it as having type <ENUM>
962  *     and length 'sizeof *action' and zeros the rest.  For actions that have
963  *     variable length, the length used and cleared is that of struct <STRUCT>.
964  *
965  *  struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
966  *
967  *     Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
968  *     initializes it with ofputil_init_<ENUM>(), and returns it.
969  */
970 #define OFPAT10_ACTION(ENUM, STRUCT, NAME)              \
971     void ofputil_init_##ENUM(struct STRUCT *);          \
972     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
973 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)  \
974     void ofputil_init_##ENUM(struct STRUCT *);          \
975     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
976 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)  \
977     void ofputil_init_##ENUM(struct STRUCT *);          \
978     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
979 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)    \
980     void ofputil_init_##ENUM(struct STRUCT *);          \
981     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
982 #include "ofp-util.def"
983
984 #define OFP_ACTION_ALIGN 8      /* Alignment of ofp_actions. */
985
986 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
987
988 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
989                                  union ofp_action **, size_t *);
990
991 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
992                            const union ofp_action *b, size_t n_b);
993 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
994
995 /* Handy utility for parsing flows and actions. */
996 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
997
998 struct ofputil_port_stats {
999     ofp_port_t port_no;
1000     struct netdev_stats stats;
1001     uint32_t duration_sec;      /* UINT32_MAX if unknown. */
1002     uint32_t duration_nsec;
1003 };
1004
1005 struct ofpbuf *ofputil_encode_dump_ports_request(enum ofp_version ofp_version,
1006                                                  ofp_port_t port);
1007 void ofputil_append_port_stat(struct list *replies,
1008                               const struct ofputil_port_stats *ops);
1009 size_t ofputil_count_port_stats(const struct ofp_header *);
1010 int ofputil_decode_port_stats(struct ofputil_port_stats *, struct ofpbuf *msg);
1011 enum ofperr ofputil_decode_port_stats_request(const struct ofp_header *request,
1012                                               ofp_port_t *ofp10_port);
1013
1014 struct ofputil_queue_stats_request {
1015     ofp_port_t port_no;           /* OFPP_ANY means "all ports". */
1016     uint32_t queue_id;
1017 };
1018
1019 enum ofperr
1020 ofputil_decode_queue_stats_request(const struct ofp_header *request,
1021                                    struct ofputil_queue_stats_request *oqsr);
1022 struct ofpbuf *
1023 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
1024                                    const struct ofputil_queue_stats_request *oqsr);
1025
1026 struct ofputil_queue_stats {
1027     ofp_port_t port_no;
1028     uint32_t queue_id;
1029
1030     /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
1031     uint64_t tx_bytes;
1032     uint64_t tx_packets;
1033     uint64_t tx_errors;
1034
1035     /* UINT32_MAX if unknown. */
1036     uint32_t duration_sec;
1037     uint32_t duration_nsec;
1038 };
1039
1040 size_t ofputil_count_queue_stats(const struct ofp_header *);
1041 int ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg);
1042 void ofputil_append_queue_stat(struct list *replies,
1043                                const struct ofputil_queue_stats *oqs);
1044
1045 /* Bucket for use in groups. */
1046 struct ofputil_bucket {
1047     struct list list_node;
1048     uint16_t weight;            /* Relative weight, for "select" groups. */
1049     ofp_port_t watch_port;      /* Port whose state affects whether this bucket
1050                                  * is live. Only required for fast failover
1051                                  * groups. */
1052     uint32_t watch_group;       /* Group whose state affects whether this
1053                                  * bucket is live. Only required for fast
1054                                  * failover groups. */
1055     struct ofpact *ofpacts;     /* Series of "struct ofpact"s. */
1056     size_t ofpacts_len;         /* Length of ofpacts, in bytes. */
1057 };
1058
1059 /* Protocol-independent group_mod. */
1060 struct ofputil_group_mod {
1061     uint16_t command;             /* One of OFPGC11_*. */
1062     uint8_t type;                 /* One of OFPGT11_*. */
1063     uint32_t group_id;            /* Group identifier. */
1064     struct list buckets;          /* Contains "struct ofputil_bucket"s. */
1065 };
1066
1067 struct bucket_counter {
1068     uint64_t packet_count;   /* Number of packets processed by bucket. */
1069     uint64_t byte_count;     /* Number of bytes processed by bucket. */
1070 };
1071
1072 /* Group stats reply, independent of protocol. */
1073 struct ofputil_group_stats {
1074     uint32_t group_id;    /* Group identifier. */
1075     uint32_t ref_count;
1076     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
1077     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
1078     uint32_t duration_sec;      /* UINT32_MAX if unknown. */
1079     uint32_t duration_nsec;
1080     uint32_t n_buckets;
1081     struct bucket_counter *bucket_stats;
1082 };
1083
1084 /* Group features reply, independent of protocol.
1085  *
1086  * Only OF1.2 and later support group features replies. */
1087 struct ofputil_group_features {
1088     uint32_t  types;           /* Bitmap of OFPGT_* values supported. */
1089     uint32_t  capabilities;    /* Bitmap of OFPGFC12_* capability supported. */
1090     uint32_t  max_groups[4];   /* Maximum number of groups for each type. */
1091
1092     /* Bitmaps of OFPAT_* that are supported.  OF1.2+ actions only. */
1093     uint32_t  actions[4];
1094 };
1095
1096 /* Group desc reply, independent of protocol. */
1097 struct ofputil_group_desc {
1098     uint8_t type;               /* One of OFPGT_*. */
1099     uint32_t group_id;          /* Group identifier. */
1100     struct list buckets;        /* Contains "struct ofputil_bucket"s. */
1101 };
1102
1103 void ofputil_bucket_list_destroy(struct list *buckets);
1104
1105 static inline bool
1106 ofputil_bucket_has_liveness(const struct ofputil_bucket *bucket)
1107 {
1108     return (bucket->watch_port != OFPP_ANY ||
1109             bucket->watch_group != OFPG_ANY);
1110 }
1111
1112 struct ofpbuf *ofputil_encode_group_stats_request(enum ofp_version,
1113                                                   uint32_t group_id);
1114 enum ofperr ofputil_decode_group_stats_request(
1115     const struct ofp_header *request, uint32_t *group_id);
1116 void ofputil_append_group_stats(struct list *replies,
1117                                 const struct ofputil_group_stats *);
1118 struct ofpbuf *ofputil_encode_group_features_request(enum ofp_version);
1119 struct ofpbuf *ofputil_encode_group_features_reply(
1120     const struct ofputil_group_features *, const struct ofp_header *request);
1121 void ofputil_decode_group_features_reply(const struct ofp_header *,
1122                                          struct ofputil_group_features *);
1123 struct ofpbuf *ofputil_encode_group_mod(enum ofp_version ofp_version,
1124                                         const struct ofputil_group_mod *gm);
1125
1126 enum ofperr ofputil_decode_group_mod(const struct ofp_header *,
1127                                      struct ofputil_group_mod *);
1128
1129 int ofputil_decode_group_stats_reply(struct ofpbuf *,
1130                                      struct ofputil_group_stats *);
1131
1132 int ofputil_decode_group_desc_reply(struct ofputil_group_desc *,
1133                                     struct ofpbuf *, enum ofp_version);
1134
1135 void ofputil_append_group_desc_reply(const struct ofputil_group_desc *,
1136                                      struct list *buckets,
1137                                      struct list *replies);
1138 struct ofpbuf *ofputil_encode_group_desc_request(enum ofp_version);
1139
1140 #endif /* ofp-util.h */