2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015 Nicira, Inc.
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at:
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
28 #include "meta-flow.h"
30 #include "openflow/netronome-ext.h"
31 #include "openflow/nicira-ext.h"
32 #include "openvswitch/types.h"
33 #include "type-props.h"
37 struct ofpact_set_field;
40 enum ofperr ofputil_port_from_ofp11(ovs_be32 ofp11_port,
41 ofp_port_t *ofp10_port);
42 ovs_be32 ofputil_port_to_ofp11(ofp_port_t ofp10_port);
44 bool ofputil_port_from_string(const char *, ofp_port_t *portp);
45 void ofputil_format_port(ofp_port_t port, struct ds *);
46 void ofputil_port_to_string(ofp_port_t, char namebuf[OFP_MAX_PORT_NAME_LEN],
50 enum { MAX_GROUP_NAME_LEN = INT_STRLEN(uint32_t) };
51 bool ofputil_group_from_string(const char *, uint32_t *group_id);
52 void ofputil_format_group(uint32_t group_id, struct ds *);
53 void ofputil_group_to_string(uint32_t group_id,
54 char namebuf[MAX_GROUP_NAME_LEN + 1],
57 /* Converting OFPFW10_NW_SRC_MASK and OFPFW10_NW_DST_MASK wildcard bit counts
58 * to and from IP bitmasks. */
59 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
60 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
64 * A "protocol" is an OpenFlow version plus, for some OpenFlow versions,
65 * a bit extra about the flow match format in use.
67 * These are arranged from most portable to least portable, or alternatively
68 * from least powerful to most powerful. Protocols earlier on the list are
69 * more likely to be understood for the purpose of making requests, but
70 * protocol later on the list are more likely to accurately describe a flow
73 * On any given OpenFlow connection, a single protocol is in effect at any
74 * given time. These values use separate bits only because that makes it easy
75 * to test whether a particular protocol is within a given set of protocols and
76 * to implement set union and intersection.
78 enum ofputil_protocol {
79 /* OpenFlow 1.0 protocols.
81 * The "STD" protocols use the standard OpenFlow 1.0 flow format.
82 * The "NXM" protocols use the Nicira Extensible Match (NXM) flow format.
84 * The protocols with "TID" mean that the nx_flow_mod_table_id Nicira
85 * extension has been enabled. The other protocols have it disabled.
87 #define OFPUTIL_P_NONE 0
88 OFPUTIL_P_OF10_STD = 1 << 0,
89 OFPUTIL_P_OF10_STD_TID = 1 << 1,
90 OFPUTIL_P_OF10_NXM = 1 << 2,
91 OFPUTIL_P_OF10_NXM_TID = 1 << 3,
92 #define OFPUTIL_P_OF10_STD_ANY (OFPUTIL_P_OF10_STD | OFPUTIL_P_OF10_STD_TID)
93 #define OFPUTIL_P_OF10_NXM_ANY (OFPUTIL_P_OF10_NXM | OFPUTIL_P_OF10_NXM_TID)
94 #define OFPUTIL_P_OF10_ANY (OFPUTIL_P_OF10_STD_ANY | OFPUTIL_P_OF10_NXM_ANY)
96 /* OpenFlow 1.1 protocol.
98 * We only support the standard OpenFlow 1.1 flow format.
100 * OpenFlow 1.1 always operates with an equivalent of the
101 * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
103 OFPUTIL_P_OF11_STD = 1 << 4,
105 /* OpenFlow 1.2+ protocols (only one variant each).
107 * These use the standard OpenFlow Extensible Match (OXM) flow format.
109 * OpenFlow 1.2+ always operates with an equivalent of the
110 * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
112 OFPUTIL_P_OF12_OXM = 1 << 5,
113 OFPUTIL_P_OF13_OXM = 1 << 6,
114 OFPUTIL_P_OF14_OXM = 1 << 7,
115 OFPUTIL_P_OF15_OXM = 1 << 8,
116 #define OFPUTIL_P_ANY_OXM (OFPUTIL_P_OF12_OXM | \
117 OFPUTIL_P_OF13_OXM | \
118 OFPUTIL_P_OF14_OXM | \
121 #define OFPUTIL_P_NXM_OF11_UP (OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF11_STD | \
124 #define OFPUTIL_P_NXM_OXM_ANY (OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_ANY_OXM)
126 #define OFPUTIL_P_OF11_UP (OFPUTIL_P_OF11_STD | OFPUTIL_P_ANY_OXM)
128 #define OFPUTIL_P_OF12_UP (OFPUTIL_P_OF12_OXM | OFPUTIL_P_OF13_UP)
129 #define OFPUTIL_P_OF13_UP (OFPUTIL_P_OF13_OXM | OFPUTIL_P_OF14_UP)
130 #define OFPUTIL_P_OF14_UP (OFPUTIL_P_OF14_OXM | OFPUTIL_P_OF15_UP)
131 #define OFPUTIL_P_OF15_UP OFPUTIL_P_OF15_OXM
134 #define OFPUTIL_P_ANY ((1 << 9) - 1)
136 /* Protocols in which a specific table may be specified in flow_mods. */
137 #define OFPUTIL_P_TID (OFPUTIL_P_OF10_STD_TID | \
138 OFPUTIL_P_OF10_NXM_TID | \
139 OFPUTIL_P_OF11_STD | \
143 /* Valid value of mask for asynchronous messages. */
144 #define MAXIMUM_MASK_PACKET_IN ((1 << OFPR_N_REASONS) - 1)
146 #define MAXIMUM_MASK_FLOW_REMOVED ((1 << OVS_OFPRR_NONE) - 1)
148 #define MAXIMUM_MASK_PORT_STATUS ((1 << OFPPR_N_REASONS) - 1)
150 #define MAXIMUM_MASK_ROLE_STATUS ((1 << OFPCRR_N_REASONS) - 1)
152 #define MINIMUM_MASK_TABLE_STATUS (1 << OFPTR_VACANCY_DOWN)
154 #define MAXIMUM_MASK_TABLE_STATUS ((1 << OFPTR_N_REASONS) - \
155 MINIMUM_MASK_TABLE_STATUS)
157 #define MAXIMUM_MASK_REQUESTFORWARD ((1 << OFPRFR_N_REASONS) - 1)
159 /* Protocols to use for flow dumps, from most to least preferred. */
160 extern enum ofputil_protocol ofputil_flow_dump_protocols[];
161 extern size_t ofputil_n_flow_dump_protocols;
163 enum ofputil_protocol ofputil_protocol_from_ofp_version(enum ofp_version);
164 enum ofputil_protocol ofputil_protocols_from_ofp_version(enum ofp_version);
165 enum ofp_version ofputil_protocol_to_ofp_version(enum ofputil_protocol);
167 bool ofputil_protocol_is_valid(enum ofputil_protocol);
168 enum ofputil_protocol ofputil_protocol_set_tid(enum ofputil_protocol,
170 enum ofputil_protocol ofputil_protocol_to_base(enum ofputil_protocol);
171 enum ofputil_protocol ofputil_protocol_set_base(
172 enum ofputil_protocol cur, enum ofputil_protocol new_base);
174 const char *ofputil_protocol_to_string(enum ofputil_protocol);
175 char *ofputil_protocols_to_string(enum ofputil_protocol);
176 enum ofputil_protocol ofputil_protocols_from_string(const char *);
178 void ofputil_format_version(struct ds *, enum ofp_version);
179 void ofputil_format_version_name(struct ds *, enum ofp_version);
181 /* A bitmap of version numbers
183 * Bit offsets correspond to ofp_version numbers which in turn correspond to
184 * wire-protocol numbers for OpenFlow versions, e.g. (1u << OFP11_VERSION)
185 * is the mask for OpenFlow 1.1. If the bit for a version is set then it is
186 * allowed, otherwise it is disallowed. */
188 void ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap);
189 void ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap);
191 enum ofp_version ofputil_version_from_string(const char *s);
193 uint32_t ofputil_protocols_to_version_bitmap(enum ofputil_protocol);
194 enum ofputil_protocol ofputil_protocols_from_version_bitmap(uint32_t bitmap);
196 /* Bitmaps of OpenFlow versions that Open vSwitch supports, and that it enables
197 * by default. When Open vSwitch has experimental or incomplete support for
198 * newer versions of OpenFlow, those versions should not be supported by
199 * default and thus should be omitted from the latter bitmap. */
200 #define OFPUTIL_SUPPORTED_VERSIONS ((1u << OFP10_VERSION) | \
201 (1u << OFP11_VERSION) | \
202 (1u << OFP12_VERSION) | \
203 (1u << OFP13_VERSION))
204 #define OFPUTIL_DEFAULT_VERSIONS OFPUTIL_SUPPORTED_VERSIONS
206 enum ofputil_protocol ofputil_protocols_from_string(const char *s);
208 const char *ofputil_version_to_string(enum ofp_version ofp_version);
209 uint32_t ofputil_versions_from_string(const char *s);
210 uint32_t ofputil_versions_from_strings(char ** const s, size_t count);
212 bool ofputil_decode_hello(const struct ofp_header *,
213 uint32_t *allowed_versions);
214 struct ofpbuf *ofputil_encode_hello(uint32_t version_bitmap);
216 struct ofpbuf *ofputil_encode_set_protocol(enum ofputil_protocol current,
217 enum ofputil_protocol want,
218 enum ofputil_protocol *next);
221 struct ofpbuf *ofputil_encode_nx_set_flow_format(enum nx_flow_format);
222 enum ofputil_protocol ofputil_nx_flow_format_to_protocol(enum nx_flow_format);
223 bool ofputil_nx_flow_format_is_valid(enum nx_flow_format);
224 const char *ofputil_nx_flow_format_to_string(enum nx_flow_format);
226 /* Work with ofp10_match. */
227 void ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *);
228 void ofputil_match_from_ofp10_match(const struct ofp10_match *,
230 void ofputil_normalize_match(struct match *);
231 void ofputil_normalize_match_quiet(struct match *);
232 void ofputil_match_to_ofp10_match(const struct match *, struct ofp10_match *);
234 /* Work with ofp11_match. */
235 enum ofperr ofputil_pull_ofp11_match(struct ofpbuf *, struct match *,
236 uint16_t *padded_match_len);
237 enum ofperr ofputil_pull_ofp11_mask(struct ofpbuf *, struct match *,
238 struct mf_bitmap *bm);
239 enum ofperr ofputil_match_from_ofp11_match(const struct ofp11_match *,
241 int ofputil_put_ofp11_match(struct ofpbuf *, const struct match *,
242 enum ofputil_protocol);
243 void ofputil_match_to_ofp11_match(const struct match *, struct ofp11_match *);
244 int ofputil_match_typical_len(enum ofputil_protocol);
246 /* dl_type translation between OpenFlow and 'struct flow' format. */
247 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
248 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
251 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
252 int ofputil_packet_in_format_from_string(const char *);
253 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
254 struct ofpbuf *ofputil_make_set_packet_in_format(enum ofp_version,
255 enum nx_packet_in_format);
257 /* NXT_FLOW_MOD_TABLE_ID extension. */
258 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
260 /* Protocol-independent flow_mod flags. */
261 enum ofputil_flow_mod_flags {
262 /* Flags that are maintained with a flow as part of its state.
264 * (OFPUTIL_FF_EMERG would be here too, if OVS supported it.) */
265 OFPUTIL_FF_SEND_FLOW_REM = 1 << 0, /* All versions. */
266 OFPUTIL_FF_NO_PKT_COUNTS = 1 << 1, /* OpenFlow 1.3+. */
267 OFPUTIL_FF_NO_BYT_COUNTS = 1 << 2, /* OpenFlow 1.3+. */
269 /* These flags primarily affects flow_mod behavior. They are not
270 * particularly useful as part of flow state. We include them in flow
271 * state only because OpenFlow implies that they should be. */
272 OFPUTIL_FF_CHECK_OVERLAP = 1 << 3, /* All versions. */
273 OFPUTIL_FF_RESET_COUNTS = 1 << 4, /* OpenFlow 1.2+. */
275 /* Not supported by OVS. */
276 OFPUTIL_FF_EMERG = 1 << 5, /* OpenFlow 1.0 only. */
278 /* The set of flags maintained as part of a flow table entry. */
279 #define OFPUTIL_FF_STATE (OFPUTIL_FF_SEND_FLOW_REM \
280 | OFPUTIL_FF_NO_PKT_COUNTS \
281 | OFPUTIL_FF_NO_BYT_COUNTS \
282 | OFPUTIL_FF_CHECK_OVERLAP \
283 | OFPUTIL_FF_RESET_COUNTS)
285 /* Flags that are only set by OVS for its internal use. Cannot be set via
287 OFPUTIL_FF_HIDDEN_FIELDS = 1 << 6, /* Allow hidden match fields to be
289 OFPUTIL_FF_NO_READONLY = 1 << 7, /* Allow rules within read only tables
293 /* Protocol-independent flow_mod.
295 * The handling of cookies across multiple versions of OpenFlow is a bit
296 * confusing. See DESIGN for the details. */
297 struct ofputil_flow_mod {
298 struct ovs_list list_node; /* For queuing flow_mods. */
303 /* Cookie matching. The flow_mod affects only flows that have cookies that
304 * bitwise match 'cookie' bits in positions where 'cookie_mask has 1-bits.
306 * 'cookie_mask' should be zero for OFPFC_ADD flow_mods. */
307 ovs_be64 cookie; /* Cookie bits to match. */
308 ovs_be64 cookie_mask; /* 1-bit in each 'cookie' bit to match. */
312 * OFPFC_ADD uses 'new_cookie' as the new flow's cookie. 'new_cookie'
313 * should not be UINT64_MAX.
315 * OFPFC_MODIFY and OFPFC_MODIFY_STRICT have two cases:
317 * - If one or more matching flows exist and 'modify_cookie' is true,
318 * then the flow_mod changes the existing flows' cookies to
319 * 'new_cookie'. 'new_cookie' should not be UINT64_MAX.
321 * - If no matching flow exists, 'new_cookie' is not UINT64_MAX, and
322 * 'cookie_mask' is 0, then the flow_mod adds a new flow with
323 * 'new_cookie' as its cookie.
325 ovs_be64 new_cookie; /* New cookie to install or UINT64_MAX. */
326 bool modify_cookie; /* Set cookie of existing flow to 'new_cookie'? */
330 uint16_t idle_timeout;
331 uint16_t hard_timeout;
335 enum ofputil_flow_mod_flags flags;
336 uint16_t importance; /* Eviction precedence. */
337 struct ofpact *ofpacts; /* Series of "struct ofpact"s. */
338 size_t ofpacts_len; /* Length of ofpacts, in bytes. */
340 /* Reason for delete; ignored for non-delete commands */
341 enum ofp_flow_removed_reason delete_reason;
344 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
345 const struct ofp_header *,
346 enum ofputil_protocol,
347 struct ofpbuf *ofpacts,
350 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
351 enum ofputil_protocol);
353 /* Flow stats or aggregate stats request, independent of protocol. */
354 struct ofputil_flow_stats_request {
355 bool aggregate; /* Aggregate results? */
358 ovs_be64 cookie_mask;
364 enum ofperr ofputil_decode_flow_stats_request(
365 struct ofputil_flow_stats_request *, const struct ofp_header *);
366 struct ofpbuf *ofputil_encode_flow_stats_request(
367 const struct ofputil_flow_stats_request *, enum ofputil_protocol);
369 /* Flow stats reply, independent of protocol. */
370 struct ofputil_flow_stats {
375 uint16_t idle_timeout;
376 uint16_t hard_timeout;
377 uint32_t duration_sec;
378 uint32_t duration_nsec;
379 int idle_age; /* Seconds since last packet, -1 if unknown. */
380 int hard_age; /* Seconds since last change, -1 if unknown. */
381 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
382 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
383 const struct ofpact *ofpacts;
385 enum ofputil_flow_mod_flags flags;
386 uint16_t importance; /* Eviction precedence. */
389 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
391 bool flow_age_extension,
392 struct ofpbuf *ofpacts);
393 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
394 struct ovs_list *replies);
396 /* Aggregate stats reply, independent of protocol. */
397 struct ofputil_aggregate_stats {
398 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
399 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
403 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
404 const struct ofputil_aggregate_stats *stats,
405 const struct ofp_header *request);
406 enum ofperr ofputil_decode_aggregate_stats_reply(
407 struct ofputil_aggregate_stats *,
408 const struct ofp_header *reply);
410 /* Flow removed message, independent of protocol. */
411 struct ofputil_flow_removed {
415 uint8_t reason; /* One of OFPRR_*. */
416 uint8_t table_id; /* 255 if message didn't include table ID. */
417 uint32_t duration_sec;
418 uint32_t duration_nsec;
419 uint16_t idle_timeout;
420 uint16_t hard_timeout;
421 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
422 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
425 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
426 const struct ofp_header *);
427 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
428 enum ofputil_protocol);
430 /* Abstract packet-in message. */
431 struct ofputil_packet_in {
432 /* Packet data and metadata.
434 * To save bandwidth, in some cases a switch may send only the first
435 * several bytes of a packet, indicated by 'packet_len < total_len'. When
436 * the full packet is included, 'packet_len == total_len'. */
438 size_t packet_len; /* Number of bytes in 'packet'. */
439 size_t total_len; /* Size of packet, pre-truncation. */
440 struct match flow_metadata;
442 /* Identifies a buffer in the switch that contains the full packet, to
443 * allow the controller to reference it later without having to send the
444 * entire packet back to the switch.
446 * UINT32_MAX indicates that the packet is not buffered in the switch. A
447 * switch should only use UINT32_MAX when it sends the entire packet. */
450 /* Reason that the packet-in is being sent. */
451 enum ofp_packet_in_reason reason; /* One of OFPR_*. */
453 /* Information about the OpenFlow flow that triggered the packet-in.
455 * A packet-in triggered by a flow table miss has no associated flow. In
456 * that case, 'cookie' is UINT64_MAX. */
457 uint8_t table_id; /* OpenFlow table ID. */
458 ovs_be64 cookie; /* Flow's cookie. */
461 enum ofperr ofputil_decode_packet_in(struct ofputil_packet_in *,
462 const struct ofp_header *);
463 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
464 enum ofputil_protocol protocol,
465 enum nx_packet_in_format);
467 enum { OFPUTIL_PACKET_IN_REASON_BUFSIZE = INT_STRLEN(int) + 1 };
468 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason,
471 bool ofputil_packet_in_reason_from_string(const char *,
472 enum ofp_packet_in_reason *);
474 /* Abstract packet-out message.
476 * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
477 * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
478 struct ofputil_packet_out {
479 const void *packet; /* Packet data, if buffer_id == UINT32_MAX. */
480 size_t packet_len; /* Length of packet data in bytes. */
481 uint32_t buffer_id; /* Buffer id or UINT32_MAX if no buffer. */
482 ofp_port_t in_port; /* Packet's input port. */
483 struct ofpact *ofpacts; /* Actions. */
484 size_t ofpacts_len; /* Size of ofpacts in bytes. */
487 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
488 const struct ofp_header *,
489 struct ofpbuf *ofpacts);
490 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *,
491 enum ofputil_protocol protocol);
493 enum ofputil_port_config {
494 /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */
495 OFPUTIL_PC_PORT_DOWN = 1 << 0, /* Port is administratively down. */
496 OFPUTIL_PC_NO_RECV = 1 << 2, /* Drop all packets received by port. */
497 OFPUTIL_PC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */
498 OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */
499 /* OpenFlow 1.0 only. */
500 OFPUTIL_PC_NO_STP = 1 << 1, /* No 802.1D spanning tree for port. */
501 OFPUTIL_PC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */
502 OFPUTIL_PC_NO_FLOOD = 1 << 4, /* Do not include port when flooding. */
503 /* There are no OpenFlow 1.1-only bits. */
506 enum ofputil_port_state {
507 /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */
508 OFPUTIL_PS_LINK_DOWN = 1 << 0, /* No physical link present. */
509 /* OpenFlow 1.1 only. */
510 OFPUTIL_PS_BLOCKED = 1 << 1, /* Port is blocked */
511 OFPUTIL_PS_LIVE = 1 << 2, /* Live for Fast Failover Group. */
512 /* OpenFlow 1.0 only. */
513 OFPUTIL_PS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
514 OFPUTIL_PS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
515 OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
516 OFPUTIL_PS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
517 OFPUTIL_PS_STP_MASK = 3 << 8 /* Bit mask for OFPPS10_STP_* values. */
520 /* Abstract ofp10_phy_port or ofp11_port. */
521 struct ofputil_phy_port {
523 struct eth_addr hw_addr;
524 char name[OFP_MAX_PORT_NAME_LEN];
525 enum ofputil_port_config config;
526 enum ofputil_port_state state;
528 /* NETDEV_F_* feature bitmasks. */
529 enum netdev_features curr; /* Current features. */
530 enum netdev_features advertised; /* Features advertised by the port. */
531 enum netdev_features supported; /* Features supported by the port. */
532 enum netdev_features peer; /* Features advertised by peer. */
535 uint32_t curr_speed; /* Current speed, in kbps. */
536 uint32_t max_speed; /* Maximum supported speed, in kbps. */
539 enum ofputil_capabilities {
540 /* OpenFlow 1.0, 1.1, 1.2, and 1.3 share these capability values. */
541 OFPUTIL_C_FLOW_STATS = 1 << 0, /* Flow statistics. */
542 OFPUTIL_C_TABLE_STATS = 1 << 1, /* Table statistics. */
543 OFPUTIL_C_PORT_STATS = 1 << 2, /* Port statistics. */
544 OFPUTIL_C_IP_REASM = 1 << 5, /* Can reassemble IP fragments. */
545 OFPUTIL_C_QUEUE_STATS = 1 << 6, /* Queue statistics. */
547 /* OpenFlow 1.0 and 1.1 share this capability. */
548 OFPUTIL_C_ARP_MATCH_IP = 1 << 7, /* Match IP addresses in ARP pkts. */
550 /* OpenFlow 1.0 only. */
551 OFPUTIL_C_STP = 1 << 3, /* 802.1d spanning tree. */
553 /* OpenFlow 1.1, 1.2, and 1.3 share this capability. */
554 OFPUTIL_C_GROUP_STATS = 1 << 4, /* Group statistics. */
556 /* OpenFlow 1.2 and 1.3 share this capability */
557 OFPUTIL_C_PORT_BLOCKED = 1 << 8, /* Switch will block looping ports */
560 /* Abstract ofp_switch_features. */
561 struct ofputil_switch_features {
562 uint64_t datapath_id; /* Datapath unique ID. */
563 uint32_t n_buffers; /* Max packets buffered at once. */
564 uint8_t n_tables; /* Number of tables supported by datapath. */
565 uint8_t auxiliary_id; /* Identify auxiliary connections */
566 enum ofputil_capabilities capabilities;
567 uint64_t ofpacts; /* Bitmap of OFPACT_* bits. */
570 enum ofperr ofputil_decode_switch_features(const struct ofp_header *,
571 struct ofputil_switch_features *,
574 struct ofpbuf *ofputil_encode_switch_features(
575 const struct ofputil_switch_features *, enum ofputil_protocol,
577 void ofputil_put_switch_features_port(const struct ofputil_phy_port *,
579 bool ofputil_switch_features_has_ports(struct ofpbuf *b);
581 /* phy_port helper functions. */
582 int ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *,
583 struct ofputil_phy_port *);
585 /* Abstract ofp_port_status. */
586 struct ofputil_port_status {
587 enum ofp_port_reason reason;
588 struct ofputil_phy_port desc;
591 enum ofperr ofputil_decode_port_status(const struct ofp_header *,
592 struct ofputil_port_status *);
593 struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *,
594 enum ofputil_protocol);
596 /* Abstract ofp_port_mod. */
597 struct ofputil_port_mod {
599 struct eth_addr hw_addr;
600 enum ofputil_port_config config;
601 enum ofputil_port_config mask;
602 enum netdev_features advertise;
605 enum ofperr ofputil_decode_port_mod(const struct ofp_header *,
606 struct ofputil_port_mod *, bool loose);
607 struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
608 enum ofputil_protocol);
610 /* Abstract version of OFPTC11_TABLE_MISS_*.
612 * OpenFlow 1.0 always sends packets that miss to the next flow table, or to
613 * the controller if they miss in the last flow table.
615 * OpenFlow 1.1 and 1.2 can configure table miss behavior via a "table-mod"
616 * that specifies "send to controller", "miss", or "drop".
618 * OpenFlow 1.3 and later never sends packets that miss to the controller.
620 enum ofputil_table_miss {
621 /* Protocol-specific default behavior. On OpenFlow 1.0 through 1.2
622 * connections, the packet is sent to the controller, and on OpenFlow 1.3
623 * and later connections, the packet is dropped.
625 * This is also used as a result of decoding OpenFlow 1.3+ "config" values
626 * in table-mods, to indicate that no table-miss was specified. */
627 OFPUTIL_TABLE_MISS_DEFAULT, /* Protocol default behavior. */
629 /* These constants have the same meanings as those in OpenFlow with the
631 OFPUTIL_TABLE_MISS_CONTROLLER, /* Send to controller. */
632 OFPUTIL_TABLE_MISS_CONTINUE, /* Go to next table. */
633 OFPUTIL_TABLE_MISS_DROP, /* Drop the packet. */
636 /* Abstract version of OFPTC14_EVICTION.
638 * OpenFlow 1.0 through 1.3 don't know anything about eviction, so decoding a
639 * message for one of these protocols always yields
640 * OFPUTIL_TABLE_EVICTION_DEFAULT. */
641 enum ofputil_table_eviction {
642 OFPUTIL_TABLE_EVICTION_DEFAULT, /* No value. */
643 OFPUTIL_TABLE_EVICTION_ON, /* Enable eviction. */
644 OFPUTIL_TABLE_EVICTION_OFF /* Disable eviction. */
647 /* Abstract version of OFPTC14_VACANCY_EVENTS.
649 * OpenFlow 1.0 through 1.3 don't know anything about vacancy events, so
650 * decoding a message for one of these protocols always yields
651 * OFPUTIL_TABLE_VACANCY_DEFAULT. */
652 enum ofputil_table_vacancy {
653 OFPUTIL_TABLE_VACANCY_DEFAULT, /* No value. */
654 OFPUTIL_TABLE_VACANCY_ON, /* Enable vacancy events. */
655 OFPUTIL_TABLE_VACANCY_OFF /* Disable vacancy events. */
658 /* Abstract version of OFPTMPT_VACANCY.
660 * Openflow 1.4+ defines vacancy events.
661 * The fields vacancy_down and vacancy_up are the threshold for generating
662 * vacancy events that should be configured on the flow table, expressed as
664 * The vacancy field is only used when this property in included in a
665 * OFPMP_TABLE_DESC multipart reply or a OFPT_TABLE_STATUS message and
666 * represent the current vacancy of the table, expressed as a percent. In
667 * OFP_TABLE_MOD requests, this field must be set to 0 */
668 struct ofputil_table_mod_prop_vacancy {
669 uint8_t vacancy_down; /* Vacancy threshold when space decreases (%). */
670 uint8_t vacancy_up; /* Vacancy threshold when space increases (%). */
671 uint8_t vacancy; /* Current vacancy (%). */
674 /* Abstract ofp_table_mod. */
675 struct ofputil_table_mod {
676 uint8_t table_id; /* ID of the table, 0xff indicates all tables. */
678 /* OpenFlow 1.1 and 1.2 only. For other versions, ignored on encoding,
679 * decoded to OFPUTIL_TABLE_MISS_DEFAULT. */
680 enum ofputil_table_miss miss;
682 /* OpenFlow 1.4+ only. For other versions, ignored on encoding, decoded to
683 * OFPUTIL_TABLE_EVICTION_DEFAULT. */
684 enum ofputil_table_eviction eviction;
686 /* OpenFlow 1.4+ only and optional even there; UINT32_MAX indicates
687 * absence. For other versions, ignored on encoding, decoded to
689 uint32_t eviction_flags; /* OFPTMPEF14_*. */
691 /* OpenFlow 1.4+ only. For other versions, ignored on encoding, decoded to
692 * OFPUTIL_TABLE_VACANCY_DEFAULT. */
693 enum ofputil_table_vacancy vacancy;
695 /* Openflow 1.4+ only. Defines threshold values of vacancy expressed as
696 * percent, value of current vacancy is set to zero for table-mod.
697 * For other versions, ignored on encoding, all values decoded to
699 struct ofputil_table_mod_prop_vacancy table_vacancy;
702 /* Abstract ofp14_table_desc. */
703 struct ofputil_table_desc {
704 uint8_t table_id; /* ID of the table. */
705 enum ofputil_table_eviction eviction;
706 uint32_t eviction_flags; /* UINT32_MAX if not present. */
707 enum ofputil_table_vacancy vacancy;
708 struct ofputil_table_mod_prop_vacancy table_vacancy;
711 enum ofperr ofputil_decode_table_mod(const struct ofp_header *,
712 struct ofputil_table_mod *);
713 struct ofpbuf *ofputil_encode_table_mod(const struct ofputil_table_mod *,
714 enum ofputil_protocol);
716 /* Abstract ofp_table_features.
718 * This is used for all versions of OpenFlow, even though ofp_table_features
719 * was only introduced in OpenFlow 1.3, because earlier versions of OpenFlow
720 * include support for a subset of ofp_table_features through OFPST_TABLE (aka
722 struct ofputil_table_features {
723 uint8_t table_id; /* Identifier of table. Lower numbered tables
724 are consulted first. */
725 char name[OFP_MAX_TABLE_NAME_LEN];
726 ovs_be64 metadata_match; /* Bits of metadata table can match. */
727 ovs_be64 metadata_write; /* Bits of metadata table can write. */
728 uint32_t max_entries; /* Max number of entries supported. */
732 * 'miss_config' is relevant for OpenFlow 1.1 and 1.2 only, because those
733 * versions include OFPTC_MISS_* flags in OFPST_TABLE. For other versions,
734 * it is decoded to OFPUTIL_TABLE_MISS_DEFAULT and ignored for encoding.
736 * 'supports_eviction' and 'supports_vacancy_events' are relevant only for
737 * OpenFlow 1.4 and later only. For OF1.4, they are boolean: 1 if
738 * supported, otherwise 0. For other versions, they are decoded as -1 and
739 * ignored for encoding.
741 * See the section "OFPTC_* Table Configuration" in DESIGN.md for more
742 * details of how OpenFlow has changed in this area.
744 enum ofputil_table_miss miss_config; /* OF1.1 and 1.2 only. */
745 int supports_eviction; /* OF1.4+ only. */
746 int supports_vacancy_events; /* OF1.4+ only. */
748 /* Table features related to instructions. There are two instances:
750 * - 'miss' reports features available in the table miss flow.
752 * - 'nonmiss' reports features available in other flows. */
753 struct ofputil_table_instruction_features {
754 /* Tables that "goto-table" may jump to. */
755 unsigned long int next[BITMAP_N_LONGS(255)];
757 /* Bitmap of OVSINST_* for supported instructions. */
758 uint32_t instructions;
760 /* Table features related to actions. There are two instances:
762 * - 'write' reports features available in a "write_actions"
765 * - 'apply' reports features available in an "apply_actions"
767 struct ofputil_table_action_features {
768 uint64_t ofpacts; /* Bitmap of supported OFPACT_*. */
769 struct mf_bitmap set_fields; /* Fields for "set-field". */
775 * For any given field the following combinations are valid:
777 * - match=0, wildcard=0, mask=0: Flows in this table cannot match on
780 * - match=1, wildcard=0, mask=0: Flows in this table must match on all
781 * the bits in this field.
783 * - match=1, wildcard=1, mask=0: Flows in this table must either match
784 * on all the bits in the field or wildcard the field entirely.
786 * - match=1, wildcard=1, mask=1: Flows in this table may arbitrarily
787 * mask this field (as special cases, they may match on all the bits
788 * or wildcard it entirely).
790 * Other combinations do not make sense.
792 struct mf_bitmap match; /* Fields that may be matched. */
793 struct mf_bitmap mask; /* Subset of 'match' that may have masks. */
794 struct mf_bitmap wildcard; /* Subset of 'match' that may be wildcarded. */
797 int ofputil_decode_table_features(struct ofpbuf *,
798 struct ofputil_table_features *, bool loose);
800 int ofputil_decode_table_desc(struct ofpbuf *,
801 struct ofputil_table_desc *,
804 struct ofpbuf *ofputil_encode_table_features_request(enum ofp_version);
806 struct ofpbuf *ofputil_encode_table_desc_request(enum ofp_version);
808 void ofputil_append_table_features_reply(
809 const struct ofputil_table_features *tf, struct ovs_list *replies);
811 void ofputil_append_table_desc_reply(const struct ofputil_table_desc *td,
812 struct ovs_list *replies,
815 /* Meter band configuration for all supported band types. */
816 struct ofputil_meter_band {
818 uint8_t prec_level; /* Non-zero if type == OFPMBT_DSCP_REMARK. */
823 struct ofputil_meter_band_stats {
824 uint64_t packet_count;
828 struct ofputil_meter_config {
832 struct ofputil_meter_band *bands;
835 /* Abstract ofp_meter_mod. */
836 struct ofputil_meter_mod {
838 struct ofputil_meter_config meter;
841 struct ofputil_meter_stats {
844 uint64_t packet_in_count;
845 uint64_t byte_in_count;
846 uint32_t duration_sec;
847 uint32_t duration_nsec;
849 struct ofputil_meter_band_stats *bands;
852 struct ofputil_meter_features {
853 uint32_t max_meters; /* Maximum number of meters. */
854 uint32_t band_types; /* Can support max 32 band types. */
855 uint32_t capabilities; /* Supported flags. */
860 enum ofperr ofputil_decode_meter_mod(const struct ofp_header *,
861 struct ofputil_meter_mod *,
862 struct ofpbuf *bands);
863 struct ofpbuf *ofputil_encode_meter_mod(enum ofp_version,
864 const struct ofputil_meter_mod *);
866 void ofputil_decode_meter_features(const struct ofp_header *,
867 struct ofputil_meter_features *);
868 struct ofpbuf *ofputil_encode_meter_features_reply(const struct
869 ofputil_meter_features *,
870 const struct ofp_header *
872 void ofputil_decode_meter_request(const struct ofp_header *,
875 void ofputil_append_meter_config(struct ovs_list *replies,
876 const struct ofputil_meter_config *);
878 void ofputil_append_meter_stats(struct ovs_list *replies,
879 const struct ofputil_meter_stats *);
881 enum ofputil_meter_request_type {
882 OFPUTIL_METER_FEATURES,
883 OFPUTIL_METER_CONFIG,
887 struct ofpbuf *ofputil_encode_meter_request(enum ofp_version,
888 enum ofputil_meter_request_type,
891 int ofputil_decode_meter_stats(struct ofpbuf *,
892 struct ofputil_meter_stats *,
893 struct ofpbuf *bands);
895 int ofputil_decode_meter_config(struct ofpbuf *,
896 struct ofputil_meter_config *,
897 struct ofpbuf *bands);
899 /* Type for meter_id in ofproto provider interface, UINT32_MAX if invalid. */
900 typedef struct { uint32_t uint32; } ofproto_meter_id;
902 /* Abstract ofp_role_request and reply. */
903 struct ofputil_role_request {
904 enum ofp12_controller_role role;
905 bool have_generation_id;
906 uint64_t generation_id;
909 struct ofputil_role_status {
910 enum ofp12_controller_role role;
911 enum ofp14_controller_role_reason reason;
912 uint64_t generation_id;
915 enum ofperr ofputil_decode_role_message(const struct ofp_header *,
916 struct ofputil_role_request *);
917 struct ofpbuf *ofputil_encode_role_reply(const struct ofp_header *,
918 const struct ofputil_role_request *);
920 struct ofpbuf *ofputil_encode_role_status(
921 const struct ofputil_role_status *status,
922 enum ofputil_protocol protocol);
924 enum ofperr ofputil_decode_role_status(const struct ofp_header *oh,
925 struct ofputil_role_status *rs);
927 /* Abstract table stats.
929 * This corresponds to the OpenFlow 1.3 table statistics structure, which only
930 * includes actual statistics. In earlier versions of OpenFlow, several
931 * members describe table features, so this structure has to be paired with
932 * struct ofputil_table_features to get all information. */
933 struct ofputil_table_stats {
934 uint8_t table_id; /* Identifier of table. */
935 uint32_t active_count; /* Number of active entries. */
936 uint64_t lookup_count; /* Number of packets looked up in table. */
937 uint64_t matched_count; /* Number of packets that hit table. */
940 struct ofpbuf *ofputil_encode_table_stats_reply(const struct ofp_header *rq);
942 struct ofpbuf *ofputil_encode_table_desc_reply(const struct ofp_header *rq);
944 void ofputil_append_table_stats_reply(struct ofpbuf *reply,
945 const struct ofputil_table_stats *,
946 const struct ofputil_table_features *);
948 int ofputil_decode_table_stats_reply(struct ofpbuf *reply,
949 struct ofputil_table_stats *,
950 struct ofputil_table_features *);
952 /* Queue configuration request. */
953 struct ofpbuf *ofputil_encode_queue_get_config_request(enum ofp_version,
955 enum ofperr ofputil_decode_queue_get_config_request(const struct ofp_header *,
958 /* Queue configuration reply. */
959 struct ofputil_queue_config {
962 /* Each of these optional values is expressed in tenths of a percent.
963 * Values greater than 1000 indicate that the feature is disabled.
964 * UINT16_MAX indicates that the value is omitted. */
969 struct ofpbuf *ofputil_encode_queue_get_config_reply(
970 const struct ofp_header *request);
971 void ofputil_append_queue_get_config_reply(
972 struct ofpbuf *reply, const struct ofputil_queue_config *);
974 enum ofperr ofputil_decode_queue_get_config_reply(struct ofpbuf *reply,
976 int ofputil_pull_queue_get_config_reply(struct ofpbuf *reply,
977 struct ofputil_queue_config *);
980 /* Abstract nx_flow_monitor_request. */
981 struct ofputil_flow_monitor_request {
983 enum nx_flow_monitor_flags flags;
989 int ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *,
991 void ofputil_append_flow_monitor_request(
992 const struct ofputil_flow_monitor_request *, struct ofpbuf *msg);
994 /* Abstract nx_flow_update. */
995 struct ofputil_flow_update {
996 enum nx_flow_update_event event;
998 /* Used only for NXFME_ADDED, NXFME_DELETED, NXFME_MODIFIED. */
999 enum ofp_flow_removed_reason reason;
1000 uint16_t idle_timeout;
1001 uint16_t hard_timeout;
1005 struct match *match;
1006 const struct ofpact *ofpacts;
1009 /* Used only for NXFME_ABBREV. */
1013 int ofputil_decode_flow_update(struct ofputil_flow_update *,
1014 struct ofpbuf *msg, struct ofpbuf *ofpacts);
1015 void ofputil_start_flow_update(struct ovs_list *replies);
1016 void ofputil_append_flow_update(const struct ofputil_flow_update *,
1017 struct ovs_list *replies);
1019 /* Abstract nx_flow_monitor_cancel. */
1020 uint32_t ofputil_decode_flow_monitor_cancel(const struct ofp_header *);
1021 struct ofpbuf *ofputil_encode_flow_monitor_cancel(uint32_t id);
1023 /* Port desc stats requests and replies. */
1024 enum ofperr ofputil_decode_port_desc_stats_request(const struct ofp_header *,
1026 struct ofpbuf *ofputil_encode_port_desc_stats_request(
1027 enum ofp_version ofp_version, ofp_port_t);
1029 void ofputil_append_port_desc_stats_reply(const struct ofputil_phy_port *pp,
1030 struct ovs_list *replies);
1032 /* Encoding simple OpenFlow messages. */
1033 struct ofpbuf *make_echo_request(enum ofp_version);
1034 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
1036 struct ofpbuf *ofputil_encode_barrier_request(enum ofp_version);
1038 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
1039 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
1044 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
1046 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
1047 union ofp_action **, size_t *);
1049 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
1050 const union ofp_action *b, size_t n_b);
1051 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
1053 /* Handy utility for parsing flows and actions. */
1054 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
1056 struct ofputil_port_stats {
1058 struct netdev_stats stats;
1059 uint32_t duration_sec; /* UINT32_MAX if unknown. */
1060 uint32_t duration_nsec;
1063 struct ofpbuf *ofputil_encode_dump_ports_request(enum ofp_version ofp_version,
1065 void ofputil_append_port_stat(struct ovs_list *replies,
1066 const struct ofputil_port_stats *ops);
1067 size_t ofputil_count_port_stats(const struct ofp_header *);
1068 int ofputil_decode_port_stats(struct ofputil_port_stats *, struct ofpbuf *msg);
1069 enum ofperr ofputil_decode_port_stats_request(const struct ofp_header *request,
1070 ofp_port_t *ofp10_port);
1072 struct ofputil_queue_stats_request {
1073 ofp_port_t port_no; /* OFPP_ANY means "all ports". */
1078 ofputil_decode_queue_stats_request(const struct ofp_header *request,
1079 struct ofputil_queue_stats_request *oqsr);
1081 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
1082 const struct ofputil_queue_stats_request *oqsr);
1084 struct ofputil_queue_stats {
1088 /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
1090 uint64_t tx_packets;
1093 /* UINT32_MAX if unknown. */
1094 uint32_t duration_sec;
1095 uint32_t duration_nsec;
1098 size_t ofputil_count_queue_stats(const struct ofp_header *);
1099 int ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg);
1100 void ofputil_append_queue_stat(struct ovs_list *replies,
1101 const struct ofputil_queue_stats *oqs);
1103 struct bucket_counter {
1104 uint64_t packet_count; /* Number of packets processed by bucket. */
1105 uint64_t byte_count; /* Number of bytes processed by bucket. */
1108 /* Bucket for use in groups. */
1109 struct ofputil_bucket {
1110 struct ovs_list list_node;
1111 uint16_t weight; /* Relative weight, for "select" groups. */
1112 ofp_port_t watch_port; /* Port whose state affects whether this bucket
1113 * is live. Only required for fast failover
1115 uint32_t watch_group; /* Group whose state affects whether this
1116 * bucket is live. Only required for fast
1117 * failover groups. */
1118 uint32_t bucket_id; /* Bucket Id used to identify bucket*/
1119 struct ofpact *ofpacts; /* Series of "struct ofpact"s. */
1120 size_t ofpacts_len; /* Length of ofpacts, in bytes. */
1122 struct bucket_counter stats;
1125 /* Protocol-independent group_mod. */
1126 struct ofputil_group_props {
1127 /* NTR selection method */
1128 char selection_method[NTR_MAX_SELECTION_METHOD_LEN];
1129 uint64_t selection_method_param;
1130 struct field_array fields;
1133 /* Protocol-independent group_mod. */
1134 struct ofputil_group_mod {
1135 uint16_t command; /* One of OFPGC15_*. */
1136 uint8_t type; /* One of OFPGT11_*. */
1137 uint32_t group_id; /* Group identifier. */
1138 uint32_t command_bucket_id; /* Bucket Id used as part of
1139 * OFPGC15_INSERT_BUCKET and
1140 * OFPGC15_REMOVE_BUCKET commands
1142 struct ovs_list buckets; /* Contains "struct ofputil_bucket"s. */
1143 struct ofputil_group_props props; /* Group properties. */
1146 /* Group stats reply, independent of protocol. */
1147 struct ofputil_group_stats {
1148 uint32_t group_id; /* Group identifier. */
1150 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
1151 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
1152 uint32_t duration_sec; /* UINT32_MAX if unknown. */
1153 uint32_t duration_nsec;
1155 struct bucket_counter *bucket_stats;
1158 /* Group features reply, independent of protocol.
1160 * Only OF1.2 and later support group features replies. */
1161 struct ofputil_group_features {
1162 uint32_t types; /* Bitmap of OFPGT_* values supported. */
1163 uint32_t capabilities; /* Bitmap of OFPGFC12_* capability supported. */
1164 uint32_t max_groups[4]; /* Maximum number of groups for each type. */
1165 uint64_t ofpacts[4]; /* Bitmaps of supported OFPACT_* */
1168 /* Group desc reply, independent of protocol. */
1169 struct ofputil_group_desc {
1170 uint8_t type; /* One of OFPGT_*. */
1171 uint32_t group_id; /* Group identifier. */
1172 struct ovs_list buckets; /* Contains "struct ofputil_bucket"s. */
1173 struct ofputil_group_props props; /* Group properties. */
1176 void ofputil_bucket_list_destroy(struct ovs_list *buckets);
1177 void ofputil_bucket_clone_list(struct ovs_list *dest,
1178 const struct ovs_list *src,
1179 const struct ofputil_bucket *);
1180 struct ofputil_bucket *ofputil_bucket_find(const struct ovs_list *,
1181 uint32_t bucket_id);
1182 bool ofputil_bucket_check_duplicate_id(const struct ovs_list *);
1183 struct ofputil_bucket *ofputil_bucket_list_front(const struct ovs_list *);
1184 struct ofputil_bucket *ofputil_bucket_list_back(const struct ovs_list *);
1187 ofputil_bucket_has_liveness(const struct ofputil_bucket *bucket)
1189 return (bucket->watch_port != OFPP_ANY ||
1190 bucket->watch_group != OFPG_ANY);
1193 struct ofpbuf *ofputil_encode_group_stats_request(enum ofp_version,
1195 enum ofperr ofputil_decode_group_stats_request(
1196 const struct ofp_header *request, uint32_t *group_id);
1197 void ofputil_append_group_stats(struct ovs_list *replies,
1198 const struct ofputil_group_stats *);
1199 struct ofpbuf *ofputil_encode_group_features_request(enum ofp_version);
1200 struct ofpbuf *ofputil_encode_group_features_reply(
1201 const struct ofputil_group_features *, const struct ofp_header *request);
1202 void ofputil_decode_group_features_reply(const struct ofp_header *,
1203 struct ofputil_group_features *);
1204 void ofputil_uninit_group_mod(struct ofputil_group_mod *gm);
1205 struct ofpbuf *ofputil_encode_group_mod(enum ofp_version ofp_version,
1206 const struct ofputil_group_mod *gm);
1208 enum ofperr ofputil_decode_group_mod(const struct ofp_header *,
1209 struct ofputil_group_mod *);
1211 int ofputil_decode_group_stats_reply(struct ofpbuf *,
1212 struct ofputil_group_stats *);
1214 void ofputil_uninit_group_desc(struct ofputil_group_desc *gd);
1215 uint32_t ofputil_decode_group_desc_request(const struct ofp_header *);
1216 struct ofpbuf *ofputil_encode_group_desc_request(enum ofp_version,
1219 int ofputil_decode_group_desc_reply(struct ofputil_group_desc *,
1220 struct ofpbuf *, enum ofp_version);
1222 void ofputil_append_group_desc_reply(const struct ofputil_group_desc *,
1223 const struct ovs_list *buckets,
1224 struct ovs_list *replies);
1226 struct ofputil_bundle_ctrl_msg {
1232 struct ofputil_bundle_add_msg {
1235 const struct ofp_header *msg;
1240 enum ofperr ofputil_decode_bundle_ctrl(const struct ofp_header *,
1241 struct ofputil_bundle_ctrl_msg *);
1243 struct ofpbuf *ofputil_encode_bundle_ctrl_request(enum ofp_version,
1244 struct ofputil_bundle_ctrl_msg *);
1245 struct ofpbuf *ofputil_encode_bundle_ctrl_reply(const struct ofp_header *,
1246 struct ofputil_bundle_ctrl_msg *);
1248 struct ofpbuf *ofputil_encode_bundle_add(enum ofp_version ofp_version,
1249 struct ofputil_bundle_add_msg *msg);
1251 enum ofperr ofputil_decode_bundle_add(const struct ofp_header *,
1252 struct ofputil_bundle_add_msg *,
1253 enum ofptype *type);
1255 struct ofputil_tlv_map {
1256 struct ovs_list list_node;
1258 uint16_t option_class;
1259 uint8_t option_type;
1264 struct ofputil_tlv_table_mod {
1266 struct ovs_list mappings; /* Contains "struct ofputil_tlv_map"s. */
1269 struct ofputil_tlv_table_reply {
1270 uint32_t max_option_space;
1271 uint16_t max_fields;
1272 struct ovs_list mappings; /* Contains "struct ofputil_tlv_map"s. */
1275 struct ofpbuf *ofputil_encode_tlv_table_mod(enum ofp_version ofp_version,
1276 struct ofputil_tlv_table_mod *);
1277 enum ofperr ofputil_decode_tlv_table_mod(const struct ofp_header *,
1278 struct ofputil_tlv_table_mod *);
1279 struct ofpbuf *ofputil_encode_tlv_table_reply(const struct ofp_header *,
1280 struct ofputil_tlv_table_reply *);
1281 enum ofperr ofputil_decode_tlv_table_reply(const struct ofp_header *,
1282 struct ofputil_tlv_table_reply *);
1283 void ofputil_uninit_tlv_table(struct ovs_list *mappings);
1285 enum ofputil_async_msg_type {
1286 OAM_PACKET_IN, /* OFPT_PACKET_IN or NXT_PACKET_IN. */
1287 OAM_PORT_STATUS, /* OFPT_PORT_STATUS. */
1288 OAM_FLOW_REMOVED, /* OFPT_FLOW_REMOVED or
1289 * NXT_FLOW_REMOVED. */
1290 OAM_ROLE_STATUS, /* OFPT_ROLE_STATUS. */
1291 OAM_TABLE_STATUS, /* OFPT_TABLE_STATUS. */
1292 OAM_REQUESTFORWARD, /* OFPT_REQUESTFORWARD. */
1296 enum ofperr ofputil_decode_set_async_config(const struct ofp_header *,
1297 uint32_t master[OAM_N_TYPES],
1298 uint32_t slave[OAM_N_TYPES],
1301 struct ofpbuf *ofputil_encode_get_async_config(const struct ofp_header *,
1302 uint32_t master[OAM_N_TYPES],
1303 uint32_t slave[OAM_N_TYPES]);
1305 struct ofputil_requestforward {
1307 enum ofp14_requestforward_reason reason;
1309 /* reason == OFPRFR_METER_MOD. */
1311 struct ofputil_meter_mod *meter_mod;
1312 struct ofpbuf bands;
1315 /* reason == OFPRFR_GROUP_MOD. */
1316 struct ofputil_group_mod *group_mod;
1320 struct ofpbuf *ofputil_encode_requestforward(
1321 const struct ofputil_requestforward *, enum ofputil_protocol);
1322 enum ofperr ofputil_decode_requestforward(const struct ofp_header *,
1323 struct ofputil_requestforward *);
1324 void ofputil_destroy_requestforward(struct ofputil_requestforward *);
1326 #endif /* ofp-util.h */