2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014, 2015, 2016 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 /* Protocols to use for flow dumps, from most to least preferred. */
144 extern enum ofputil_protocol ofputil_flow_dump_protocols[];
145 extern size_t ofputil_n_flow_dump_protocols;
147 enum ofputil_protocol ofputil_protocol_from_ofp_version(enum ofp_version);
148 enum ofputil_protocol ofputil_protocols_from_ofp_version(enum ofp_version);
149 enum ofp_version ofputil_protocol_to_ofp_version(enum ofputil_protocol);
151 bool ofputil_protocol_is_valid(enum ofputil_protocol);
152 enum ofputil_protocol ofputil_protocol_set_tid(enum ofputil_protocol,
154 enum ofputil_protocol ofputil_protocol_to_base(enum ofputil_protocol);
155 enum ofputil_protocol ofputil_protocol_set_base(
156 enum ofputil_protocol cur, enum ofputil_protocol new_base);
158 const char *ofputil_protocol_to_string(enum ofputil_protocol);
159 char *ofputil_protocols_to_string(enum ofputil_protocol);
160 enum ofputil_protocol ofputil_protocols_from_string(const char *);
162 void ofputil_format_version(struct ds *, enum ofp_version);
163 void ofputil_format_version_name(struct ds *, enum ofp_version);
165 /* A bitmap of version numbers
167 * Bit offsets correspond to ofp_version numbers which in turn correspond to
168 * wire-protocol numbers for OpenFlow versions, e.g. (1u << OFP11_VERSION)
169 * is the mask for OpenFlow 1.1. If the bit for a version is set then it is
170 * allowed, otherwise it is disallowed. */
172 void ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap);
173 void ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap);
175 enum ofp_version ofputil_version_from_string(const char *s);
177 uint32_t ofputil_protocols_to_version_bitmap(enum ofputil_protocol);
178 enum ofputil_protocol ofputil_protocols_from_version_bitmap(uint32_t bitmap);
180 /* Bitmaps of OpenFlow versions that Open vSwitch supports, and that it enables
181 * by default. When Open vSwitch has experimental or incomplete support for
182 * newer versions of OpenFlow, those versions should not be supported by
183 * default and thus should be omitted from the latter bitmap. */
184 #define OFPUTIL_SUPPORTED_VERSIONS ((1u << OFP10_VERSION) | \
185 (1u << OFP11_VERSION) | \
186 (1u << OFP12_VERSION) | \
187 (1u << OFP13_VERSION))
188 #define OFPUTIL_DEFAULT_VERSIONS OFPUTIL_SUPPORTED_VERSIONS
190 enum ofputil_protocol ofputil_protocols_from_string(const char *s);
192 const char *ofputil_version_to_string(enum ofp_version ofp_version);
193 uint32_t ofputil_versions_from_string(const char *s);
194 uint32_t ofputil_versions_from_strings(char ** const s, size_t count);
196 bool ofputil_decode_hello(const struct ofp_header *,
197 uint32_t *allowed_versions);
198 struct ofpbuf *ofputil_encode_hello(uint32_t version_bitmap);
200 struct ofpbuf *ofputil_encode_set_protocol(enum ofputil_protocol current,
201 enum ofputil_protocol want,
202 enum ofputil_protocol *next);
205 struct ofpbuf *ofputil_encode_nx_set_flow_format(enum nx_flow_format);
206 enum ofputil_protocol ofputil_nx_flow_format_to_protocol(enum nx_flow_format);
207 bool ofputil_nx_flow_format_is_valid(enum nx_flow_format);
208 const char *ofputil_nx_flow_format_to_string(enum nx_flow_format);
210 /* Work with ofp10_match. */
211 void ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *);
212 void ofputil_match_from_ofp10_match(const struct ofp10_match *,
214 void ofputil_normalize_match(struct match *);
215 void ofputil_normalize_match_quiet(struct match *);
216 void ofputil_match_to_ofp10_match(const struct match *, struct ofp10_match *);
218 /* Work with ofp11_match. */
219 enum ofperr ofputil_pull_ofp11_match(struct ofpbuf *, struct match *,
220 uint16_t *padded_match_len);
221 enum ofperr ofputil_pull_ofp11_mask(struct ofpbuf *, struct match *,
222 struct mf_bitmap *bm);
223 enum ofperr ofputil_match_from_ofp11_match(const struct ofp11_match *,
225 int ofputil_put_ofp11_match(struct ofpbuf *, const struct match *,
226 enum ofputil_protocol);
227 void ofputil_match_to_ofp11_match(const struct match *, struct ofp11_match *);
228 int ofputil_match_typical_len(enum ofputil_protocol);
230 /* dl_type translation between OpenFlow and 'struct flow' format. */
231 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
232 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
235 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
236 int ofputil_packet_in_format_from_string(const char *);
237 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
238 struct ofpbuf *ofputil_make_set_packet_in_format(enum ofp_version,
239 enum nx_packet_in_format);
241 /* NXT_FLOW_MOD_TABLE_ID extension. */
242 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
244 /* Protocol-independent flow_mod flags. */
245 enum ofputil_flow_mod_flags {
246 /* Flags that are maintained with a flow as part of its state.
248 * (OFPUTIL_FF_EMERG would be here too, if OVS supported it.) */
249 OFPUTIL_FF_SEND_FLOW_REM = 1 << 0, /* All versions. */
250 OFPUTIL_FF_NO_PKT_COUNTS = 1 << 1, /* OpenFlow 1.3+. */
251 OFPUTIL_FF_NO_BYT_COUNTS = 1 << 2, /* OpenFlow 1.3+. */
253 /* These flags primarily affects flow_mod behavior. They are not
254 * particularly useful as part of flow state. We include them in flow
255 * state only because OpenFlow implies that they should be. */
256 OFPUTIL_FF_CHECK_OVERLAP = 1 << 3, /* All versions. */
257 OFPUTIL_FF_RESET_COUNTS = 1 << 4, /* OpenFlow 1.2+. */
259 /* Not supported by OVS. */
260 OFPUTIL_FF_EMERG = 1 << 5, /* OpenFlow 1.0 only. */
262 /* The set of flags maintained as part of a flow table entry. */
263 #define OFPUTIL_FF_STATE (OFPUTIL_FF_SEND_FLOW_REM \
264 | OFPUTIL_FF_NO_PKT_COUNTS \
265 | OFPUTIL_FF_NO_BYT_COUNTS \
266 | OFPUTIL_FF_CHECK_OVERLAP \
267 | OFPUTIL_FF_RESET_COUNTS)
269 /* Flags that are only set by OVS for its internal use. Cannot be set via
271 OFPUTIL_FF_HIDDEN_FIELDS = 1 << 6, /* Allow hidden match fields to be
273 OFPUTIL_FF_NO_READONLY = 1 << 7, /* Allow rules within read only tables
277 /* Protocol-independent flow_mod.
279 * The handling of cookies across multiple versions of OpenFlow is a bit
280 * confusing. See DESIGN for the details. */
281 struct ofputil_flow_mod {
282 struct ovs_list list_node; /* For queuing flow_mods. */
287 /* Cookie matching. The flow_mod affects only flows that have cookies that
288 * bitwise match 'cookie' bits in positions where 'cookie_mask has 1-bits.
290 * 'cookie_mask' should be zero for OFPFC_ADD flow_mods. */
291 ovs_be64 cookie; /* Cookie bits to match. */
292 ovs_be64 cookie_mask; /* 1-bit in each 'cookie' bit to match. */
296 * OFPFC_ADD uses 'new_cookie' as the new flow's cookie. 'new_cookie'
297 * should not be UINT64_MAX.
299 * OFPFC_MODIFY and OFPFC_MODIFY_STRICT have two cases:
301 * - If one or more matching flows exist and 'modify_cookie' is true,
302 * then the flow_mod changes the existing flows' cookies to
303 * 'new_cookie'. 'new_cookie' should not be UINT64_MAX.
305 * - If no matching flow exists, 'new_cookie' is not UINT64_MAX, and
306 * 'cookie_mask' is 0, then the flow_mod adds a new flow with
307 * 'new_cookie' as its cookie.
309 ovs_be64 new_cookie; /* New cookie to install or UINT64_MAX. */
310 bool modify_cookie; /* Set cookie of existing flow to 'new_cookie'? */
314 uint16_t idle_timeout;
315 uint16_t hard_timeout;
319 enum ofputil_flow_mod_flags flags;
320 uint16_t importance; /* Eviction precedence. */
321 struct ofpact *ofpacts; /* Series of "struct ofpact"s. */
322 size_t ofpacts_len; /* Length of ofpacts, in bytes. */
324 /* Reason for delete; ignored for non-delete commands */
325 enum ofp_flow_removed_reason delete_reason;
328 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
329 const struct ofp_header *,
330 enum ofputil_protocol,
331 struct ofpbuf *ofpacts,
334 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
335 enum ofputil_protocol);
337 /* Flow stats or aggregate stats request, independent of protocol. */
338 struct ofputil_flow_stats_request {
339 bool aggregate; /* Aggregate results? */
342 ovs_be64 cookie_mask;
348 enum ofperr ofputil_decode_flow_stats_request(
349 struct ofputil_flow_stats_request *, const struct ofp_header *);
350 struct ofpbuf *ofputil_encode_flow_stats_request(
351 const struct ofputil_flow_stats_request *, enum ofputil_protocol);
353 /* Flow stats reply, independent of protocol. */
354 struct ofputil_flow_stats {
359 uint16_t idle_timeout;
360 uint16_t hard_timeout;
361 uint32_t duration_sec;
362 uint32_t duration_nsec;
363 int idle_age; /* Seconds since last packet, -1 if unknown. */
364 int hard_age; /* Seconds since last change, -1 if unknown. */
365 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
366 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
367 const struct ofpact *ofpacts;
369 enum ofputil_flow_mod_flags flags;
370 uint16_t importance; /* Eviction precedence. */
373 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
375 bool flow_age_extension,
376 struct ofpbuf *ofpacts);
377 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
378 struct ovs_list *replies);
380 /* Aggregate stats reply, independent of protocol. */
381 struct ofputil_aggregate_stats {
382 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
383 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
387 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
388 const struct ofputil_aggregate_stats *stats,
389 const struct ofp_header *request);
390 enum ofperr ofputil_decode_aggregate_stats_reply(
391 struct ofputil_aggregate_stats *,
392 const struct ofp_header *reply);
394 /* Flow removed message, independent of protocol. */
395 struct ofputil_flow_removed {
399 uint8_t reason; /* One of OFPRR_*. */
400 uint8_t table_id; /* 255 if message didn't include table ID. */
401 uint32_t duration_sec;
402 uint32_t duration_nsec;
403 uint16_t idle_timeout;
404 uint16_t hard_timeout;
405 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
406 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
409 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
410 const struct ofp_header *);
411 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
412 enum ofputil_protocol);
414 /* Abstract packet-in message. */
415 struct ofputil_packet_in {
416 /* Packet data and metadata.
418 * To save bandwidth, in some cases a switch may send only the first
419 * several bytes of a packet, indicated by 'packet_len < total_len'. When
420 * the full packet is included, 'packet_len == total_len'. */
422 size_t packet_len; /* Number of bytes in 'packet'. */
423 size_t total_len; /* Size of packet, pre-truncation. */
424 struct match flow_metadata;
426 /* Identifies a buffer in the switch that contains the full packet, to
427 * allow the controller to reference it later without having to send the
428 * entire packet back to the switch.
430 * UINT32_MAX indicates that the packet is not buffered in the switch. A
431 * switch should only use UINT32_MAX when it sends the entire packet. */
434 /* Reason that the packet-in is being sent. */
435 enum ofp_packet_in_reason reason; /* One of OFPR_*. */
437 /* Information about the OpenFlow flow that triggered the packet-in.
439 * A packet-in triggered by a flow table miss has no associated flow. In
440 * that case, 'cookie' is UINT64_MAX. */
441 uint8_t table_id; /* OpenFlow table ID. */
442 ovs_be64 cookie; /* Flow's cookie. */
445 enum ofperr ofputil_decode_packet_in(struct ofputil_packet_in *,
446 const struct ofp_header *);
447 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
448 enum ofputil_protocol protocol,
449 enum nx_packet_in_format);
451 enum { OFPUTIL_PACKET_IN_REASON_BUFSIZE = INT_STRLEN(int) + 1 };
452 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason,
455 bool ofputil_packet_in_reason_from_string(const char *,
456 enum ofp_packet_in_reason *);
458 /* Abstract packet-out message.
460 * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
461 * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
462 struct ofputil_packet_out {
463 const void *packet; /* Packet data, if buffer_id == UINT32_MAX. */
464 size_t packet_len; /* Length of packet data in bytes. */
465 uint32_t buffer_id; /* Buffer id or UINT32_MAX if no buffer. */
466 ofp_port_t in_port; /* Packet's input port. */
467 struct ofpact *ofpacts; /* Actions. */
468 size_t ofpacts_len; /* Size of ofpacts in bytes. */
471 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
472 const struct ofp_header *,
473 struct ofpbuf *ofpacts);
474 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *,
475 enum ofputil_protocol protocol);
477 enum ofputil_frag_handling {
478 OFPUTIL_FRAG_NORMAL = OFPC_FRAG_NORMAL, /* No special handling. */
479 OFPUTIL_FRAG_DROP = OFPC_FRAG_DROP, /* Drop fragments. */
480 OFPUTIL_FRAG_REASM = OFPC_FRAG_REASM, /* Reassemble (if supported). */
481 OFPUTIL_FRAG_NX_MATCH = OFPC_FRAG_NX_MATCH /* Match on frag bits. */
484 const char *ofputil_frag_handling_to_string(enum ofputil_frag_handling);
485 bool ofputil_frag_handling_from_string(const char *,
486 enum ofputil_frag_handling *);
488 /* Abstract struct ofp_switch_config. */
489 struct ofputil_switch_config {
490 /* Fragment handling. */
491 enum ofputil_frag_handling frag;
493 /* 0: Do not send packet to controller when decrementing invalid IP TTL.
494 * 1: Do send packet to controller when decrementing invalid IP TTL.
495 * -1: Unspecified (only OpenFlow 1.1 and 1.2 support this setting. */
496 int invalid_ttl_to_controller;
498 /* Maximum bytes of packet to send to controller on miss. */
499 uint16_t miss_send_len;
502 void ofputil_decode_get_config_reply(const struct ofp_header *,
503 struct ofputil_switch_config *);
504 struct ofpbuf *ofputil_encode_get_config_reply(
505 const struct ofp_header *request, const struct ofputil_switch_config *);
507 enum ofperr ofputil_decode_set_config(const struct ofp_header *,
508 struct ofputil_switch_config *);
509 struct ofpbuf *ofputil_encode_set_config(
510 const struct ofputil_switch_config *, enum ofp_version);
512 enum ofputil_port_config {
513 /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */
514 OFPUTIL_PC_PORT_DOWN = 1 << 0, /* Port is administratively down. */
515 OFPUTIL_PC_NO_RECV = 1 << 2, /* Drop all packets received by port. */
516 OFPUTIL_PC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */
517 OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */
518 /* OpenFlow 1.0 only. */
519 OFPUTIL_PC_NO_STP = 1 << 1, /* No 802.1D spanning tree for port. */
520 OFPUTIL_PC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */
521 OFPUTIL_PC_NO_FLOOD = 1 << 4, /* Do not include port when flooding. */
522 /* There are no OpenFlow 1.1-only bits. */
525 enum ofputil_port_state {
526 /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */
527 OFPUTIL_PS_LINK_DOWN = 1 << 0, /* No physical link present. */
528 /* OpenFlow 1.1 only. */
529 OFPUTIL_PS_BLOCKED = 1 << 1, /* Port is blocked */
530 OFPUTIL_PS_LIVE = 1 << 2, /* Live for Fast Failover Group. */
531 /* OpenFlow 1.0 only. */
532 OFPUTIL_PS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
533 OFPUTIL_PS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
534 OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
535 OFPUTIL_PS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
536 OFPUTIL_PS_STP_MASK = 3 << 8 /* Bit mask for OFPPS10_STP_* values. */
539 /* Abstract ofp10_phy_port or ofp11_port. */
540 struct ofputil_phy_port {
542 struct eth_addr hw_addr;
543 char name[OFP_MAX_PORT_NAME_LEN];
544 enum ofputil_port_config config;
545 enum ofputil_port_state state;
547 /* NETDEV_F_* feature bitmasks. */
548 enum netdev_features curr; /* Current features. */
549 enum netdev_features advertised; /* Features advertised by the port. */
550 enum netdev_features supported; /* Features supported by the port. */
551 enum netdev_features peer; /* Features advertised by peer. */
554 uint32_t curr_speed; /* Current speed, in kbps. */
555 uint32_t max_speed; /* Maximum supported speed, in kbps. */
558 enum ofputil_capabilities {
559 /* OpenFlow 1.0, 1.1, 1.2, and 1.3 share these capability values. */
560 OFPUTIL_C_FLOW_STATS = 1 << 0, /* Flow statistics. */
561 OFPUTIL_C_TABLE_STATS = 1 << 1, /* Table statistics. */
562 OFPUTIL_C_PORT_STATS = 1 << 2, /* Port statistics. */
563 OFPUTIL_C_IP_REASM = 1 << 5, /* Can reassemble IP fragments. */
564 OFPUTIL_C_QUEUE_STATS = 1 << 6, /* Queue statistics. */
566 /* OpenFlow 1.0 and 1.1 share this capability. */
567 OFPUTIL_C_ARP_MATCH_IP = 1 << 7, /* Match IP addresses in ARP pkts. */
569 /* OpenFlow 1.0 only. */
570 OFPUTIL_C_STP = 1 << 3, /* 802.1d spanning tree. */
572 /* OpenFlow 1.1, 1.2, and 1.3 share this capability. */
573 OFPUTIL_C_GROUP_STATS = 1 << 4, /* Group statistics. */
575 /* OpenFlow 1.2 and 1.3 share this capability */
576 OFPUTIL_C_PORT_BLOCKED = 1 << 8, /* Switch will block looping ports */
579 /* Abstract ofp_switch_features. */
580 struct ofputil_switch_features {
581 uint64_t datapath_id; /* Datapath unique ID. */
582 uint32_t n_buffers; /* Max packets buffered at once. */
583 uint8_t n_tables; /* Number of tables supported by datapath. */
584 uint8_t auxiliary_id; /* Identify auxiliary connections */
585 enum ofputil_capabilities capabilities;
586 uint64_t ofpacts; /* Bitmap of OFPACT_* bits. */
589 enum ofperr ofputil_decode_switch_features(const struct ofp_header *,
590 struct ofputil_switch_features *,
593 struct ofpbuf *ofputil_encode_switch_features(
594 const struct ofputil_switch_features *, enum ofputil_protocol,
596 void ofputil_put_switch_features_port(const struct ofputil_phy_port *,
598 bool ofputil_switch_features_has_ports(struct ofpbuf *b);
600 /* phy_port helper functions. */
601 int ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *,
602 struct ofputil_phy_port *);
604 /* Abstract ofp_port_status. */
605 struct ofputil_port_status {
606 enum ofp_port_reason reason;
607 struct ofputil_phy_port desc;
610 enum ofperr ofputil_decode_port_status(const struct ofp_header *,
611 struct ofputil_port_status *);
612 struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *,
613 enum ofputil_protocol);
615 /* Abstract ofp_port_mod. */
616 struct ofputil_port_mod {
618 struct eth_addr hw_addr;
619 enum ofputil_port_config config;
620 enum ofputil_port_config mask;
621 enum netdev_features advertise;
624 enum ofperr ofputil_decode_port_mod(const struct ofp_header *,
625 struct ofputil_port_mod *, bool loose);
626 struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
627 enum ofputil_protocol);
629 /* Abstract version of OFPTC11_TABLE_MISS_*.
631 * OpenFlow 1.0 always sends packets that miss to the next flow table, or to
632 * the controller if they miss in the last flow table.
634 * OpenFlow 1.1 and 1.2 can configure table miss behavior via a "table-mod"
635 * that specifies "send to controller", "miss", or "drop".
637 * OpenFlow 1.3 and later never sends packets that miss to the controller.
639 enum ofputil_table_miss {
640 /* Protocol-specific default behavior. On OpenFlow 1.0 through 1.2
641 * connections, the packet is sent to the controller, and on OpenFlow 1.3
642 * and later connections, the packet is dropped.
644 * This is also used as a result of decoding OpenFlow 1.3+ "config" values
645 * in table-mods, to indicate that no table-miss was specified. */
646 OFPUTIL_TABLE_MISS_DEFAULT, /* Protocol default behavior. */
648 /* These constants have the same meanings as those in OpenFlow with the
650 OFPUTIL_TABLE_MISS_CONTROLLER, /* Send to controller. */
651 OFPUTIL_TABLE_MISS_CONTINUE, /* Go to next table. */
652 OFPUTIL_TABLE_MISS_DROP, /* Drop the packet. */
655 /* Abstract version of OFPTC14_EVICTION.
657 * OpenFlow 1.0 through 1.3 don't know anything about eviction, so decoding a
658 * message for one of these protocols always yields
659 * OFPUTIL_TABLE_EVICTION_DEFAULT. */
660 enum ofputil_table_eviction {
661 OFPUTIL_TABLE_EVICTION_DEFAULT, /* No value. */
662 OFPUTIL_TABLE_EVICTION_ON, /* Enable eviction. */
663 OFPUTIL_TABLE_EVICTION_OFF /* Disable eviction. */
666 /* Abstract version of OFPTC14_VACANCY_EVENTS.
668 * OpenFlow 1.0 through 1.3 don't know anything about vacancy events, so
669 * decoding a message for one of these protocols always yields
670 * OFPUTIL_TABLE_VACANCY_DEFAULT. */
671 enum ofputil_table_vacancy {
672 OFPUTIL_TABLE_VACANCY_DEFAULT, /* No value. */
673 OFPUTIL_TABLE_VACANCY_ON, /* Enable vacancy events. */
674 OFPUTIL_TABLE_VACANCY_OFF /* Disable vacancy events. */
677 /* Abstract version of OFPTMPT_VACANCY.
679 * Openflow 1.4+ defines vacancy events.
680 * The fields vacancy_down and vacancy_up are the threshold for generating
681 * vacancy events that should be configured on the flow table, expressed as
683 * The vacancy field is only used when this property in included in a
684 * OFPMP_TABLE_DESC multipart reply or a OFPT_TABLE_STATUS message and
685 * represent the current vacancy of the table, expressed as a percent. In
686 * OFP_TABLE_MOD requests, this field must be set to 0 */
687 struct ofputil_table_mod_prop_vacancy {
688 uint8_t vacancy_down; /* Vacancy threshold when space decreases (%). */
689 uint8_t vacancy_up; /* Vacancy threshold when space increases (%). */
690 uint8_t vacancy; /* Current vacancy (%). */
693 /* Abstract ofp_table_mod. */
694 struct ofputil_table_mod {
695 uint8_t table_id; /* ID of the table, 0xff indicates all tables. */
697 /* OpenFlow 1.1 and 1.2 only. For other versions, ignored on encoding,
698 * decoded to OFPUTIL_TABLE_MISS_DEFAULT. */
699 enum ofputil_table_miss miss;
701 /* OpenFlow 1.4+ only. For other versions, ignored on encoding, decoded to
702 * OFPUTIL_TABLE_EVICTION_DEFAULT. */
703 enum ofputil_table_eviction eviction;
705 /* OpenFlow 1.4+ only and optional even there; UINT32_MAX indicates
706 * absence. For other versions, ignored on encoding, decoded to
708 uint32_t eviction_flags; /* OFPTMPEF14_*. */
710 /* OpenFlow 1.4+ only. For other versions, ignored on encoding, decoded to
711 * OFPUTIL_TABLE_VACANCY_DEFAULT. */
712 enum ofputil_table_vacancy vacancy;
714 /* Openflow 1.4+ only. Defines threshold values of vacancy expressed as
715 * percent, value of current vacancy is set to zero for table-mod.
716 * For other versions, ignored on encoding, all values decoded to
718 struct ofputil_table_mod_prop_vacancy table_vacancy;
721 /* Abstract ofp14_table_desc. */
722 struct ofputil_table_desc {
723 uint8_t table_id; /* ID of the table. */
724 enum ofputil_table_eviction eviction;
725 uint32_t eviction_flags; /* UINT32_MAX if not present. */
726 enum ofputil_table_vacancy vacancy;
727 struct ofputil_table_mod_prop_vacancy table_vacancy;
730 enum ofperr ofputil_decode_table_mod(const struct ofp_header *,
731 struct ofputil_table_mod *);
732 struct ofpbuf *ofputil_encode_table_mod(const struct ofputil_table_mod *,
733 enum ofputil_protocol);
735 /* Abstract ofp_table_features.
737 * This is used for all versions of OpenFlow, even though ofp_table_features
738 * was only introduced in OpenFlow 1.3, because earlier versions of OpenFlow
739 * include support for a subset of ofp_table_features through OFPST_TABLE (aka
741 struct ofputil_table_features {
742 uint8_t table_id; /* Identifier of table. Lower numbered tables
743 are consulted first. */
744 char name[OFP_MAX_TABLE_NAME_LEN];
745 ovs_be64 metadata_match; /* Bits of metadata table can match. */
746 ovs_be64 metadata_write; /* Bits of metadata table can write. */
747 uint32_t max_entries; /* Max number of entries supported. */
751 * 'miss_config' is relevant for OpenFlow 1.1 and 1.2 only, because those
752 * versions include OFPTC_MISS_* flags in OFPST_TABLE. For other versions,
753 * it is decoded to OFPUTIL_TABLE_MISS_DEFAULT and ignored for encoding.
755 * 'supports_eviction' and 'supports_vacancy_events' are relevant only for
756 * OpenFlow 1.4 and later only. For OF1.4, they are boolean: 1 if
757 * supported, otherwise 0. For other versions, they are decoded as -1 and
758 * ignored for encoding.
760 * See the section "OFPTC_* Table Configuration" in DESIGN.md for more
761 * details of how OpenFlow has changed in this area.
763 enum ofputil_table_miss miss_config; /* OF1.1 and 1.2 only. */
764 int supports_eviction; /* OF1.4+ only. */
765 int supports_vacancy_events; /* OF1.4+ only. */
767 /* Table features related to instructions. There are two instances:
769 * - 'miss' reports features available in the table miss flow.
771 * - 'nonmiss' reports features available in other flows. */
772 struct ofputil_table_instruction_features {
773 /* Tables that "goto-table" may jump to. */
774 unsigned long int next[BITMAP_N_LONGS(255)];
776 /* Bitmap of OVSINST_* for supported instructions. */
777 uint32_t instructions;
779 /* Table features related to actions. There are two instances:
781 * - 'write' reports features available in a "write_actions"
784 * - 'apply' reports features available in an "apply_actions"
786 struct ofputil_table_action_features {
787 uint64_t ofpacts; /* Bitmap of supported OFPACT_*. */
788 struct mf_bitmap set_fields; /* Fields for "set-field". */
794 * For any given field the following combinations are valid:
796 * - match=0, wildcard=0, mask=0: Flows in this table cannot match on
799 * - match=1, wildcard=0, mask=0: Flows in this table must match on all
800 * the bits in this field.
802 * - match=1, wildcard=1, mask=0: Flows in this table must either match
803 * on all the bits in the field or wildcard the field entirely.
805 * - match=1, wildcard=1, mask=1: Flows in this table may arbitrarily
806 * mask this field (as special cases, they may match on all the bits
807 * or wildcard it entirely).
809 * Other combinations do not make sense.
811 struct mf_bitmap match; /* Fields that may be matched. */
812 struct mf_bitmap mask; /* Subset of 'match' that may have masks. */
813 struct mf_bitmap wildcard; /* Subset of 'match' that may be wildcarded. */
816 int ofputil_decode_table_features(struct ofpbuf *,
817 struct ofputil_table_features *, bool loose);
819 int ofputil_decode_table_desc(struct ofpbuf *,
820 struct ofputil_table_desc *,
823 struct ofpbuf *ofputil_encode_table_features_request(enum ofp_version);
825 struct ofpbuf *ofputil_encode_table_desc_request(enum ofp_version);
827 void ofputil_append_table_features_reply(
828 const struct ofputil_table_features *tf, struct ovs_list *replies);
830 void ofputil_append_table_desc_reply(const struct ofputil_table_desc *td,
831 struct ovs_list *replies,
834 /* Meter band configuration for all supported band types. */
835 struct ofputil_meter_band {
837 uint8_t prec_level; /* Non-zero if type == OFPMBT_DSCP_REMARK. */
842 struct ofputil_meter_band_stats {
843 uint64_t packet_count;
847 struct ofputil_meter_config {
851 struct ofputil_meter_band *bands;
854 /* Abstract ofp_meter_mod. */
855 struct ofputil_meter_mod {
857 struct ofputil_meter_config meter;
860 struct ofputil_meter_stats {
863 uint64_t packet_in_count;
864 uint64_t byte_in_count;
865 uint32_t duration_sec;
866 uint32_t duration_nsec;
868 struct ofputil_meter_band_stats *bands;
871 struct ofputil_meter_features {
872 uint32_t max_meters; /* Maximum number of meters. */
873 uint32_t band_types; /* Can support max 32 band types. */
874 uint32_t capabilities; /* Supported flags. */
879 enum ofperr ofputil_decode_meter_mod(const struct ofp_header *,
880 struct ofputil_meter_mod *,
881 struct ofpbuf *bands);
882 struct ofpbuf *ofputil_encode_meter_mod(enum ofp_version,
883 const struct ofputil_meter_mod *);
885 void ofputil_decode_meter_features(const struct ofp_header *,
886 struct ofputil_meter_features *);
887 struct ofpbuf *ofputil_encode_meter_features_reply(const struct
888 ofputil_meter_features *,
889 const struct ofp_header *
891 void ofputil_decode_meter_request(const struct ofp_header *,
894 void ofputil_append_meter_config(struct ovs_list *replies,
895 const struct ofputil_meter_config *);
897 void ofputil_append_meter_stats(struct ovs_list *replies,
898 const struct ofputil_meter_stats *);
900 enum ofputil_meter_request_type {
901 OFPUTIL_METER_FEATURES,
902 OFPUTIL_METER_CONFIG,
906 struct ofpbuf *ofputil_encode_meter_request(enum ofp_version,
907 enum ofputil_meter_request_type,
910 int ofputil_decode_meter_stats(struct ofpbuf *,
911 struct ofputil_meter_stats *,
912 struct ofpbuf *bands);
914 int ofputil_decode_meter_config(struct ofpbuf *,
915 struct ofputil_meter_config *,
916 struct ofpbuf *bands);
918 /* Type for meter_id in ofproto provider interface, UINT32_MAX if invalid. */
919 typedef struct { uint32_t uint32; } ofproto_meter_id;
921 /* Abstract ofp_role_request and reply. */
922 struct ofputil_role_request {
923 enum ofp12_controller_role role;
924 bool have_generation_id;
925 uint64_t generation_id;
928 struct ofputil_role_status {
929 enum ofp12_controller_role role;
930 enum ofp14_controller_role_reason reason;
931 uint64_t generation_id;
934 enum ofperr ofputil_decode_role_message(const struct ofp_header *,
935 struct ofputil_role_request *);
936 struct ofpbuf *ofputil_encode_role_reply(const struct ofp_header *,
937 const struct ofputil_role_request *);
939 struct ofpbuf *ofputil_encode_role_status(
940 const struct ofputil_role_status *status,
941 enum ofputil_protocol protocol);
943 enum ofperr ofputil_decode_role_status(const struct ofp_header *oh,
944 struct ofputil_role_status *rs);
946 /* Abstract table stats.
948 * This corresponds to the OpenFlow 1.3 table statistics structure, which only
949 * includes actual statistics. In earlier versions of OpenFlow, several
950 * members describe table features, so this structure has to be paired with
951 * struct ofputil_table_features to get all information. */
952 struct ofputil_table_stats {
953 uint8_t table_id; /* Identifier of table. */
954 uint32_t active_count; /* Number of active entries. */
955 uint64_t lookup_count; /* Number of packets looked up in table. */
956 uint64_t matched_count; /* Number of packets that hit table. */
959 struct ofpbuf *ofputil_encode_table_stats_reply(const struct ofp_header *rq);
961 struct ofpbuf *ofputil_encode_table_desc_reply(const struct ofp_header *rq);
963 void ofputil_append_table_stats_reply(struct ofpbuf *reply,
964 const struct ofputil_table_stats *,
965 const struct ofputil_table_features *);
967 int ofputil_decode_table_stats_reply(struct ofpbuf *reply,
968 struct ofputil_table_stats *,
969 struct ofputil_table_features *);
971 /* Queue configuration request. */
972 struct ofpbuf *ofputil_encode_queue_get_config_request(enum ofp_version,
975 enum ofperr ofputil_decode_queue_get_config_request(const struct ofp_header *,
979 /* Queue configuration reply. */
980 struct ofputil_queue_config {
984 /* Each of these optional values is expressed in tenths of a percent.
985 * Values greater than 1000 indicate that the feature is disabled.
986 * UINT16_MAX indicates that the value is omitted. */
991 void ofputil_start_queue_get_config_reply(const struct ofp_header *request,
992 struct ovs_list *replies);
993 void ofputil_append_queue_get_config_reply(
994 const struct ofputil_queue_config *, struct ovs_list *replies);
996 int ofputil_pull_queue_get_config_reply(struct ofpbuf *reply,
997 struct ofputil_queue_config *);
1000 /* Abstract nx_flow_monitor_request. */
1001 struct ofputil_flow_monitor_request {
1003 enum nx_flow_monitor_flags flags;
1004 ofp_port_t out_port;
1009 int ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *,
1010 struct ofpbuf *msg);
1011 void ofputil_append_flow_monitor_request(
1012 const struct ofputil_flow_monitor_request *, struct ofpbuf *msg);
1014 /* Abstract nx_flow_update. */
1015 struct ofputil_flow_update {
1016 enum nx_flow_update_event event;
1018 /* Used only for NXFME_ADDED, NXFME_DELETED, NXFME_MODIFIED. */
1019 enum ofp_flow_removed_reason reason;
1020 uint16_t idle_timeout;
1021 uint16_t hard_timeout;
1025 struct match *match;
1026 const struct ofpact *ofpacts;
1029 /* Used only for NXFME_ABBREV. */
1033 int ofputil_decode_flow_update(struct ofputil_flow_update *,
1034 struct ofpbuf *msg, struct ofpbuf *ofpacts);
1035 void ofputil_start_flow_update(struct ovs_list *replies);
1036 void ofputil_append_flow_update(const struct ofputil_flow_update *,
1037 struct ovs_list *replies);
1039 /* Abstract nx_flow_monitor_cancel. */
1040 uint32_t ofputil_decode_flow_monitor_cancel(const struct ofp_header *);
1041 struct ofpbuf *ofputil_encode_flow_monitor_cancel(uint32_t id);
1043 /* Port desc stats requests and replies. */
1044 enum ofperr ofputil_decode_port_desc_stats_request(const struct ofp_header *,
1046 struct ofpbuf *ofputil_encode_port_desc_stats_request(
1047 enum ofp_version ofp_version, ofp_port_t);
1049 void ofputil_append_port_desc_stats_reply(const struct ofputil_phy_port *pp,
1050 struct ovs_list *replies);
1052 /* Encoding simple OpenFlow messages. */
1053 struct ofpbuf *make_echo_request(enum ofp_version);
1054 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
1056 struct ofpbuf *ofputil_encode_barrier_request(enum ofp_version);
1060 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
1062 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
1063 union ofp_action **, size_t *);
1065 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
1066 const union ofp_action *b, size_t n_b);
1067 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
1069 /* Handy utility for parsing flows and actions. */
1070 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
1072 struct ofputil_port_stats {
1074 struct netdev_stats stats;
1075 uint32_t duration_sec; /* UINT32_MAX if unknown. */
1076 uint32_t duration_nsec;
1079 struct ofpbuf *ofputil_encode_dump_ports_request(enum ofp_version ofp_version,
1081 void ofputil_append_port_stat(struct ovs_list *replies,
1082 const struct ofputil_port_stats *ops);
1083 size_t ofputil_count_port_stats(const struct ofp_header *);
1084 int ofputil_decode_port_stats(struct ofputil_port_stats *, struct ofpbuf *msg);
1085 enum ofperr ofputil_decode_port_stats_request(const struct ofp_header *request,
1086 ofp_port_t *ofp10_port);
1088 struct ofputil_queue_stats_request {
1089 ofp_port_t port_no; /* OFPP_ANY means "all ports". */
1094 ofputil_decode_queue_stats_request(const struct ofp_header *request,
1095 struct ofputil_queue_stats_request *oqsr);
1097 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
1098 const struct ofputil_queue_stats_request *oqsr);
1100 struct ofputil_queue_stats {
1104 /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
1106 uint64_t tx_packets;
1109 /* UINT32_MAX if unknown. */
1110 uint32_t duration_sec;
1111 uint32_t duration_nsec;
1114 size_t ofputil_count_queue_stats(const struct ofp_header *);
1115 int ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg);
1116 void ofputil_append_queue_stat(struct ovs_list *replies,
1117 const struct ofputil_queue_stats *oqs);
1119 struct bucket_counter {
1120 uint64_t packet_count; /* Number of packets processed by bucket. */
1121 uint64_t byte_count; /* Number of bytes processed by bucket. */
1124 /* Bucket for use in groups. */
1125 struct ofputil_bucket {
1126 struct ovs_list list_node;
1127 uint16_t weight; /* Relative weight, for "select" groups. */
1128 ofp_port_t watch_port; /* Port whose state affects whether this bucket
1129 * is live. Only required for fast failover
1131 uint32_t watch_group; /* Group whose state affects whether this
1132 * bucket is live. Only required for fast
1133 * failover groups. */
1134 uint32_t bucket_id; /* Bucket Id used to identify bucket*/
1135 struct ofpact *ofpacts; /* Series of "struct ofpact"s. */
1136 size_t ofpacts_len; /* Length of ofpacts, in bytes. */
1138 struct bucket_counter stats;
1141 /* Protocol-independent group_mod. */
1142 struct ofputil_group_props {
1143 /* NTR selection method */
1144 char selection_method[NTR_MAX_SELECTION_METHOD_LEN];
1145 uint64_t selection_method_param;
1146 struct field_array fields;
1149 /* Protocol-independent group_mod. */
1150 struct ofputil_group_mod {
1151 uint16_t command; /* One of OFPGC15_*. */
1152 uint8_t type; /* One of OFPGT11_*. */
1153 uint32_t group_id; /* Group identifier. */
1154 uint32_t command_bucket_id; /* Bucket Id used as part of
1155 * OFPGC15_INSERT_BUCKET and
1156 * OFPGC15_REMOVE_BUCKET commands
1158 struct ovs_list buckets; /* Contains "struct ofputil_bucket"s. */
1159 struct ofputil_group_props props; /* Group properties. */
1162 /* Group stats reply, independent of protocol. */
1163 struct ofputil_group_stats {
1164 uint32_t group_id; /* Group identifier. */
1166 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
1167 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
1168 uint32_t duration_sec; /* UINT32_MAX if unknown. */
1169 uint32_t duration_nsec;
1171 struct bucket_counter *bucket_stats;
1174 /* Group features reply, independent of protocol.
1176 * Only OF1.2 and later support group features replies. */
1177 struct ofputil_group_features {
1178 uint32_t types; /* Bitmap of OFPGT_* values supported. */
1179 uint32_t capabilities; /* Bitmap of OFPGFC12_* capability supported. */
1180 uint32_t max_groups[4]; /* Maximum number of groups for each type. */
1181 uint64_t ofpacts[4]; /* Bitmaps of supported OFPACT_* */
1184 /* Group desc reply, independent of protocol. */
1185 struct ofputil_group_desc {
1186 uint8_t type; /* One of OFPGT_*. */
1187 uint32_t group_id; /* Group identifier. */
1188 struct ovs_list buckets; /* Contains "struct ofputil_bucket"s. */
1189 struct ofputil_group_props props; /* Group properties. */
1192 void ofputil_bucket_list_destroy(struct ovs_list *buckets);
1193 void ofputil_bucket_clone_list(struct ovs_list *dest,
1194 const struct ovs_list *src,
1195 const struct ofputil_bucket *);
1196 struct ofputil_bucket *ofputil_bucket_find(const struct ovs_list *,
1197 uint32_t bucket_id);
1198 bool ofputil_bucket_check_duplicate_id(const struct ovs_list *);
1199 struct ofputil_bucket *ofputil_bucket_list_front(const struct ovs_list *);
1200 struct ofputil_bucket *ofputil_bucket_list_back(const struct ovs_list *);
1203 ofputil_bucket_has_liveness(const struct ofputil_bucket *bucket)
1205 return (bucket->watch_port != OFPP_ANY ||
1206 bucket->watch_group != OFPG_ANY);
1209 struct ofpbuf *ofputil_encode_group_stats_request(enum ofp_version,
1211 enum ofperr ofputil_decode_group_stats_request(
1212 const struct ofp_header *request, uint32_t *group_id);
1213 void ofputil_append_group_stats(struct ovs_list *replies,
1214 const struct ofputil_group_stats *);
1215 struct ofpbuf *ofputil_encode_group_features_request(enum ofp_version);
1216 struct ofpbuf *ofputil_encode_group_features_reply(
1217 const struct ofputil_group_features *, const struct ofp_header *request);
1218 void ofputil_decode_group_features_reply(const struct ofp_header *,
1219 struct ofputil_group_features *);
1220 void ofputil_uninit_group_mod(struct ofputil_group_mod *gm);
1221 struct ofpbuf *ofputil_encode_group_mod(enum ofp_version ofp_version,
1222 const struct ofputil_group_mod *gm);
1224 enum ofperr ofputil_decode_group_mod(const struct ofp_header *,
1225 struct ofputil_group_mod *);
1227 int ofputil_decode_group_stats_reply(struct ofpbuf *,
1228 struct ofputil_group_stats *);
1230 void ofputil_uninit_group_desc(struct ofputil_group_desc *gd);
1231 uint32_t ofputil_decode_group_desc_request(const struct ofp_header *);
1232 struct ofpbuf *ofputil_encode_group_desc_request(enum ofp_version,
1235 int ofputil_decode_group_desc_reply(struct ofputil_group_desc *,
1236 struct ofpbuf *, enum ofp_version);
1238 void ofputil_append_group_desc_reply(const struct ofputil_group_desc *,
1239 const struct ovs_list *buckets,
1240 struct ovs_list *replies);
1242 struct ofputil_bundle_ctrl_msg {
1248 struct ofputil_bundle_add_msg {
1251 const struct ofp_header *msg;
1256 enum ofperr ofputil_decode_bundle_ctrl(const struct ofp_header *,
1257 struct ofputil_bundle_ctrl_msg *);
1259 struct ofpbuf *ofputil_encode_bundle_ctrl_request(enum ofp_version,
1260 struct ofputil_bundle_ctrl_msg *);
1261 struct ofpbuf *ofputil_encode_bundle_ctrl_reply(const struct ofp_header *,
1262 struct ofputil_bundle_ctrl_msg *);
1264 struct ofpbuf *ofputil_encode_bundle_add(enum ofp_version ofp_version,
1265 struct ofputil_bundle_add_msg *msg);
1267 enum ofperr ofputil_decode_bundle_add(const struct ofp_header *,
1268 struct ofputil_bundle_add_msg *,
1269 enum ofptype *type);
1271 struct ofputil_tlv_map {
1272 struct ovs_list list_node;
1274 uint16_t option_class;
1275 uint8_t option_type;
1280 struct ofputil_tlv_table_mod {
1282 struct ovs_list mappings; /* Contains "struct ofputil_tlv_map"s. */
1285 struct ofputil_tlv_table_reply {
1286 uint32_t max_option_space;
1287 uint16_t max_fields;
1288 struct ovs_list mappings; /* Contains "struct ofputil_tlv_map"s. */
1291 struct ofpbuf *ofputil_encode_tlv_table_mod(enum ofp_version ofp_version,
1292 struct ofputil_tlv_table_mod *);
1293 enum ofperr ofputil_decode_tlv_table_mod(const struct ofp_header *,
1294 struct ofputil_tlv_table_mod *);
1295 struct ofpbuf *ofputil_encode_tlv_table_reply(const struct ofp_header *,
1296 struct ofputil_tlv_table_reply *);
1297 enum ofperr ofputil_decode_tlv_table_reply(const struct ofp_header *,
1298 struct ofputil_tlv_table_reply *);
1299 void ofputil_uninit_tlv_table(struct ovs_list *mappings);
1301 enum ofputil_async_msg_type {
1302 /* Standard asynchronous messages. */
1303 OAM_PACKET_IN, /* OFPT_PACKET_IN or NXT_PACKET_IN. */
1304 OAM_PORT_STATUS, /* OFPT_PORT_STATUS. */
1305 OAM_FLOW_REMOVED, /* OFPT_FLOW_REMOVED or NXT_FLOW_REMOVED. */
1306 OAM_ROLE_STATUS, /* OFPT_ROLE_STATUS. */
1307 OAM_TABLE_STATUS, /* OFPT_TABLE_STATUS. */
1308 OAM_REQUESTFORWARD, /* OFPT_REQUESTFORWARD. */
1310 /* Extension asynchronous messages (none yet--coming soon!). */
1311 #define OAM_EXTENSIONS 0 /* Bitmap of all extensions. */
1315 const char *ofputil_async_msg_type_to_string(enum ofputil_async_msg_type);
1317 struct ofputil_async_cfg {
1318 uint32_t master[OAM_N_TYPES];
1319 uint32_t slave[OAM_N_TYPES];
1321 #define OFPUTIL_ASYNC_CFG_INIT (struct ofputil_async_cfg) { .master[0] = 0 }
1323 enum ofperr ofputil_decode_set_async_config(const struct ofp_header *,
1325 const struct ofputil_async_cfg *,
1326 struct ofputil_async_cfg *);
1328 struct ofpbuf *ofputil_encode_get_async_reply(
1329 const struct ofp_header *, const struct ofputil_async_cfg *);
1330 struct ofpbuf *ofputil_encode_set_async_config(
1331 const struct ofputil_async_cfg *, uint32_t oams, enum ofp_version);
1333 struct ofputil_async_cfg ofputil_async_cfg_default(enum ofp_version);
1335 struct ofputil_requestforward {
1337 enum ofp14_requestforward_reason reason;
1339 /* reason == OFPRFR_METER_MOD. */
1341 struct ofputil_meter_mod *meter_mod;
1342 struct ofpbuf bands;
1345 /* reason == OFPRFR_GROUP_MOD. */
1346 struct ofputil_group_mod *group_mod;
1350 struct ofpbuf *ofputil_encode_requestforward(
1351 const struct ofputil_requestforward *, enum ofputil_protocol);
1352 enum ofperr ofputil_decode_requestforward(const struct ofp_header *,
1353 struct ofputil_requestforward *);
1354 void ofputil_destroy_requestforward(struct ofputil_requestforward *);
1356 #endif /* ofp-util.h */