2 * Copyright (c) 2008, 2009, 2010, 2011, 2012, 2013, 2014 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/nicira-ext.h"
31 #include "openvswitch/types.h"
32 #include "type-props.h"
36 struct ofpact_set_field;
39 enum ofperr ofputil_port_from_ofp11(ovs_be32 ofp11_port,
40 ofp_port_t *ofp10_port);
41 ovs_be32 ofputil_port_to_ofp11(ofp_port_t ofp10_port);
43 bool ofputil_port_from_string(const char *, ofp_port_t *portp);
44 void ofputil_format_port(ofp_port_t port, struct ds *);
45 void ofputil_port_to_string(ofp_port_t, char namebuf[OFP_MAX_PORT_NAME_LEN],
49 enum { MAX_GROUP_NAME_LEN = INT_STRLEN(uint32_t) };
50 bool ofputil_group_from_string(const char *, uint32_t *group_id);
51 void ofputil_format_group(uint32_t group_id, struct ds *);
52 void ofputil_group_to_string(uint32_t group_id,
53 char namebuf[MAX_GROUP_NAME_LEN + 1],
56 /* Converting OFPFW10_NW_SRC_MASK and OFPFW10_NW_DST_MASK wildcard bit counts
57 * to and from IP bitmasks. */
58 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
59 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
63 * A "protocol" is an OpenFlow version plus, for some OpenFlow versions,
64 * a bit extra about the flow match format in use.
66 * These are arranged from most portable to least portable, or alternatively
67 * from least powerful to most powerful. Protocols earlier on the list are
68 * more likely to be understood for the purpose of making requests, but
69 * protocol later on the list are more likely to accurately describe a flow
72 * On any given OpenFlow connection, a single protocol is in effect at any
73 * given time. These values use separate bits only because that makes it easy
74 * to test whether a particular protocol is within a given set of protocols and
75 * to implement set union and intersection.
77 enum ofputil_protocol {
78 /* OpenFlow 1.0 protocols.
80 * The "STD" protocols use the standard OpenFlow 1.0 flow format.
81 * The "NXM" protocols use the Nicira Extensible Match (NXM) flow format.
83 * The protocols with "TID" mean that the nx_flow_mod_table_id Nicira
84 * extension has been enabled. The other protocols have it disabled.
86 #define OFPUTIL_P_NONE 0
87 OFPUTIL_P_OF10_STD = 1 << 0,
88 OFPUTIL_P_OF10_STD_TID = 1 << 1,
89 OFPUTIL_P_OF10_NXM = 1 << 2,
90 OFPUTIL_P_OF10_NXM_TID = 1 << 3,
91 #define OFPUTIL_P_OF10_STD_ANY (OFPUTIL_P_OF10_STD | OFPUTIL_P_OF10_STD_TID)
92 #define OFPUTIL_P_OF10_NXM_ANY (OFPUTIL_P_OF10_NXM | OFPUTIL_P_OF10_NXM_TID)
93 #define OFPUTIL_P_OF10_ANY (OFPUTIL_P_OF10_STD_ANY | OFPUTIL_P_OF10_NXM_ANY)
95 /* OpenFlow 1.1 protocol.
97 * We only support the standard OpenFlow 1.1 flow format.
99 * OpenFlow 1.1 always operates with an equivalent of the
100 * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
102 OFPUTIL_P_OF11_STD = 1 << 4,
104 /* OpenFlow 1.2+ protocols (only one variant each).
106 * These use the standard OpenFlow Extensible Match (OXM) flow format.
108 * OpenFlow 1.2+ always operates with an equivalent of the
109 * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
111 OFPUTIL_P_OF12_OXM = 1 << 5,
112 OFPUTIL_P_OF13_OXM = 1 << 6,
113 OFPUTIL_P_OF14_OXM = 1 << 7,
114 OFPUTIL_P_OF15_OXM = 1 << 8,
115 #define OFPUTIL_P_ANY_OXM (OFPUTIL_P_OF12_OXM | \
116 OFPUTIL_P_OF13_OXM | \
117 OFPUTIL_P_OF14_OXM | \
120 #define OFPUTIL_P_NXM_OF11_UP (OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_OF11_STD | \
123 #define OFPUTIL_P_NXM_OXM_ANY (OFPUTIL_P_OF10_NXM_ANY | OFPUTIL_P_ANY_OXM)
125 #define OFPUTIL_P_OF11_UP (OFPUTIL_P_OF11_STD | OFPUTIL_P_ANY_OXM)
127 #define OFPUTIL_P_OF12_UP (OFPUTIL_P_OF12_OXM | OFPUTIL_P_OF13_UP)
128 #define OFPUTIL_P_OF13_UP (OFPUTIL_P_OF13_OXM | OFPUTIL_P_OF14_UP)
129 #define OFPUTIL_P_OF14_UP (OFPUTIL_P_OF14_OXM | OFPUTIL_P_OF15_UP)
130 #define OFPUTIL_P_OF15_UP OFPUTIL_P_OF15_OXM
133 #define OFPUTIL_P_ANY ((1 << 9) - 1)
135 /* Protocols in which a specific table may be specified in flow_mods. */
136 #define OFPUTIL_P_TID (OFPUTIL_P_OF10_STD_TID | \
137 OFPUTIL_P_OF10_NXM_TID | \
138 OFPUTIL_P_OF11_STD | \
142 /* Protocols to use for flow dumps, from most to least preferred. */
143 extern enum ofputil_protocol ofputil_flow_dump_protocols[];
144 extern size_t ofputil_n_flow_dump_protocols;
146 enum ofputil_protocol ofputil_protocol_from_ofp_version(enum ofp_version);
147 enum ofputil_protocol ofputil_protocols_from_ofp_version(enum ofp_version);
148 enum ofp_version ofputil_protocol_to_ofp_version(enum ofputil_protocol);
150 bool ofputil_protocol_is_valid(enum ofputil_protocol);
151 enum ofputil_protocol ofputil_protocol_set_tid(enum ofputil_protocol,
153 enum ofputil_protocol ofputil_protocol_to_base(enum ofputil_protocol);
154 enum ofputil_protocol ofputil_protocol_set_base(
155 enum ofputil_protocol cur, enum ofputil_protocol new_base);
157 const char *ofputil_protocol_to_string(enum ofputil_protocol);
158 char *ofputil_protocols_to_string(enum ofputil_protocol);
159 enum ofputil_protocol ofputil_protocols_from_string(const char *);
161 void ofputil_format_version(struct ds *, enum ofp_version);
162 void ofputil_format_version_name(struct ds *, enum ofp_version);
164 /* A bitmap of version numbers
166 * Bit offsets correspond to ofp_version numbers which in turn correspond to
167 * wire-protocol numbers for Open Flow versions.. E.g. (1u << OFP11_VERSION)
168 * is the mask for Open Flow 1.1. If the bit for a version is set then it is
169 * allowed, otherwise it is disallowed. */
171 void ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap);
172 void ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap);
174 enum ofp_version ofputil_version_from_string(const char *s);
176 uint32_t ofputil_protocols_to_version_bitmap(enum ofputil_protocol);
177 enum ofputil_protocol ofputil_protocols_from_version_bitmap(uint32_t bitmap);
179 /* Bitmaps of OpenFlow versions that Open vSwitch supports, and that it enables
180 * by default. When Open vSwitch has experimental or incomplete support for
181 * newer versions of OpenFlow, those versions should not be supported by
182 * default and thus should be omitted from the latter bitmap. */
183 #define OFPUTIL_SUPPORTED_VERSIONS ((1u << OFP10_VERSION) | \
184 (1u << OFP11_VERSION) | \
185 (1u << OFP12_VERSION) | \
186 (1u << OFP13_VERSION))
187 #define OFPUTIL_DEFAULT_VERSIONS OFPUTIL_SUPPORTED_VERSIONS
189 enum ofputil_protocol ofputil_protocols_from_string(const char *s);
191 const char *ofputil_version_to_string(enum ofp_version ofp_version);
192 uint32_t ofputil_versions_from_string(const char *s);
193 uint32_t ofputil_versions_from_strings(char ** const s, size_t count);
195 bool ofputil_decode_hello(const struct ofp_header *,
196 uint32_t *allowed_versions);
197 struct ofpbuf *ofputil_encode_hello(uint32_t version_bitmap);
199 struct ofpbuf *ofputil_encode_set_protocol(enum ofputil_protocol current,
200 enum ofputil_protocol want,
201 enum ofputil_protocol *next);
204 struct ofpbuf *ofputil_encode_nx_set_flow_format(enum nx_flow_format);
205 enum ofputil_protocol ofputil_nx_flow_format_to_protocol(enum nx_flow_format);
206 bool ofputil_nx_flow_format_is_valid(enum nx_flow_format);
207 const char *ofputil_nx_flow_format_to_string(enum nx_flow_format);
209 /* Work with ofp10_match. */
210 void ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *);
211 void ofputil_match_from_ofp10_match(const struct ofp10_match *,
213 void ofputil_normalize_match(struct match *);
214 void ofputil_normalize_match_quiet(struct match *);
215 void ofputil_match_to_ofp10_match(const struct match *, struct ofp10_match *);
217 /* Work with ofp11_match. */
218 enum ofperr ofputil_pull_ofp11_match(struct ofpbuf *, struct match *,
219 uint16_t *padded_match_len);
220 enum ofperr ofputil_match_from_ofp11_match(const struct ofp11_match *,
222 int ofputil_put_ofp11_match(struct ofpbuf *, const struct match *,
223 enum ofputil_protocol);
224 void ofputil_match_to_ofp11_match(const struct match *, struct ofp11_match *);
225 int ofputil_match_typical_len(enum ofputil_protocol);
227 /* dl_type translation between OpenFlow and 'struct flow' format. */
228 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
229 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
232 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
233 int ofputil_packet_in_format_from_string(const char *);
234 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
235 struct ofpbuf *ofputil_make_set_packet_in_format(enum ofp_version,
236 enum nx_packet_in_format);
238 /* NXT_FLOW_MOD_TABLE_ID extension. */
239 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
241 /* Protocol-independent flow_mod flags. */
242 enum ofputil_flow_mod_flags {
243 /* Flags that are maintained with a flow as part of its state.
245 * (OFPUTIL_FF_EMERG would be here too, if OVS supported it.) */
246 OFPUTIL_FF_SEND_FLOW_REM = 1 << 0, /* All versions. */
247 OFPUTIL_FF_NO_PKT_COUNTS = 1 << 1, /* OpenFlow 1.3+. */
248 OFPUTIL_FF_NO_BYT_COUNTS = 1 << 2, /* OpenFlow 1.3+. */
249 #define OFPUTIL_FF_STATE (OFPUTIL_FF_SEND_FLOW_REM \
250 | OFPUTIL_FF_NO_PKT_COUNTS \
251 | OFPUTIL_FF_NO_BYT_COUNTS)
253 /* Flags that affect flow_mod behavior but are not part of flow state. */
254 OFPUTIL_FF_CHECK_OVERLAP = 1 << 3, /* All versions. */
255 OFPUTIL_FF_EMERG = 1 << 4, /* OpenFlow 1.0 only. */
256 OFPUTIL_FF_RESET_COUNTS = 1 << 5, /* OpenFlow 1.2+. */
258 /* Flags that are only set by OVS for its internal use. Cannot be set via
260 OFPUTIL_FF_HIDDEN_FIELDS = 1 << 6, /* Allow hidden match fields to be
262 OFPUTIL_FF_NO_READONLY = 1 << 7, /* Allow rules within read only tables
266 /* Protocol-independent flow_mod.
268 * The handling of cookies across multiple versions of OpenFlow is a bit
269 * confusing. See DESIGN for the details. */
270 struct ofputil_flow_mod {
271 struct list list_node; /* For queuing flow_mods. */
274 unsigned int priority;
276 /* Cookie matching. The flow_mod affects only flows that have cookies that
277 * bitwise match 'cookie' bits in positions where 'cookie_mask has 1-bits.
279 * 'cookie_mask' should be zero for OFPFC_ADD flow_mods. */
280 ovs_be64 cookie; /* Cookie bits to match. */
281 ovs_be64 cookie_mask; /* 1-bit in each 'cookie' bit to match. */
285 * OFPFC_ADD uses 'new_cookie' as the new flow's cookie. 'new_cookie'
286 * should not be UINT64_MAX.
288 * OFPFC_MODIFY and OFPFC_MODIFY_STRICT have two cases:
290 * - If one or more matching flows exist and 'modify_cookie' is true,
291 * then the flow_mod changes the existing flows' cookies to
292 * 'new_cookie'. 'new_cookie' should not be UINT64_MAX.
294 * - If no matching flow exists, 'new_cookie' is not UINT64_MAX, and
295 * 'cookie_mask' is 0, then the flow_mod adds a new flow with
296 * 'new_cookie' as its cookie.
298 ovs_be64 new_cookie; /* New cookie to install or UINT64_MAX. */
299 bool modify_cookie; /* Set cookie of existing flow to 'new_cookie'? */
303 uint16_t idle_timeout;
304 uint16_t hard_timeout;
308 enum ofputil_flow_mod_flags flags;
309 struct ofpact *ofpacts; /* Series of "struct ofpact"s. */
310 size_t ofpacts_len; /* Length of ofpacts, in bytes. */
312 /* Reason for delete; ignored for non-delete commands */
313 enum ofp_flow_removed_reason delete_reason;
316 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
317 const struct ofp_header *,
318 enum ofputil_protocol,
319 struct ofpbuf *ofpacts,
322 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
323 enum ofputil_protocol);
325 /* Flow stats or aggregate stats request, independent of protocol. */
326 struct ofputil_flow_stats_request {
327 bool aggregate; /* Aggregate results? */
330 ovs_be64 cookie_mask;
336 enum ofperr ofputil_decode_flow_stats_request(
337 struct ofputil_flow_stats_request *, const struct ofp_header *);
338 struct ofpbuf *ofputil_encode_flow_stats_request(
339 const struct ofputil_flow_stats_request *, enum ofputil_protocol);
341 /* Flow stats reply, independent of protocol. */
342 struct ofputil_flow_stats {
347 uint16_t idle_timeout;
348 uint16_t hard_timeout;
349 uint32_t duration_sec;
350 uint32_t duration_nsec;
351 int idle_age; /* Seconds since last packet, -1 if unknown. */
352 int hard_age; /* Seconds since last change, -1 if unknown. */
353 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
354 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
355 const struct ofpact *ofpacts;
357 enum ofputil_flow_mod_flags flags;
360 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
362 bool flow_age_extension,
363 struct ofpbuf *ofpacts);
364 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
365 struct list *replies);
367 /* Aggregate stats reply, independent of protocol. */
368 struct ofputil_aggregate_stats {
369 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
370 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
374 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
375 const struct ofputil_aggregate_stats *stats,
376 const struct ofp_header *request);
377 enum ofperr ofputil_decode_aggregate_stats_reply(
378 struct ofputil_aggregate_stats *,
379 const struct ofp_header *reply);
381 /* Flow removed message, independent of protocol. */
382 struct ofputil_flow_removed {
386 uint8_t reason; /* One of OFPRR_*. */
387 uint8_t table_id; /* 255 if message didn't include table ID. */
388 uint32_t duration_sec;
389 uint32_t duration_nsec;
390 uint16_t idle_timeout;
391 uint16_t hard_timeout;
392 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
393 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
396 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
397 const struct ofp_header *);
398 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
399 enum ofputil_protocol);
401 /* Abstract packet-in message. */
402 struct ofputil_packet_in {
403 /* Packet data and metadata.
405 * To save bandwidth, in some cases a switch may send only the first
406 * several bytes of a packet, indicated by 'packet_len < total_len'. When
407 * the full packet is included, 'packet_len == total_len'. */
409 size_t packet_len; /* Number of bytes in 'packet'. */
410 size_t total_len; /* Size of packet, pre-truncation. */
411 struct flow_metadata fmd;
413 /* Identifies a buffer in the switch that contains the full packet, to
414 * allow the controller to reference it later without having to send the
415 * entire packet back to the switch.
417 * UINT32_MAX indicates that the packet is not buffered in the switch. A
418 * switch should only use UINT32_MAX when it sends the entire packet. */
421 /* Reason that the packet-in is being sent. */
422 enum ofp_packet_in_reason reason; /* One of OFPR_*. */
424 /* Information about the OpenFlow flow that triggered the packet-in.
426 * A packet-in triggered by a flow table miss has no associated flow. In
427 * that case, 'cookie' is UINT64_MAX. */
428 uint8_t table_id; /* OpenFlow table ID. */
429 ovs_be64 cookie; /* Flow's cookie. */
432 enum ofperr ofputil_decode_packet_in(struct ofputil_packet_in *,
433 const struct ofp_header *);
434 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
435 enum ofputil_protocol protocol,
436 enum nx_packet_in_format);
438 enum { OFPUTIL_PACKET_IN_REASON_BUFSIZE = INT_STRLEN(int) + 1 };
439 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason,
442 bool ofputil_packet_in_reason_from_string(const char *,
443 enum ofp_packet_in_reason *);
445 /* Abstract packet-out message.
447 * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
448 * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
449 struct ofputil_packet_out {
450 const void *packet; /* Packet data, if buffer_id == UINT32_MAX. */
451 size_t packet_len; /* Length of packet data in bytes. */
452 uint32_t buffer_id; /* Buffer id or UINT32_MAX if no buffer. */
453 ofp_port_t in_port; /* Packet's input port. */
454 struct ofpact *ofpacts; /* Actions. */
455 size_t ofpacts_len; /* Size of ofpacts in bytes. */
458 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
459 const struct ofp_header *,
460 struct ofpbuf *ofpacts);
461 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *,
462 enum ofputil_protocol protocol);
464 enum ofputil_port_config {
465 /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */
466 OFPUTIL_PC_PORT_DOWN = 1 << 0, /* Port is administratively down. */
467 OFPUTIL_PC_NO_RECV = 1 << 2, /* Drop all packets received by port. */
468 OFPUTIL_PC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */
469 OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */
470 /* OpenFlow 1.0 only. */
471 OFPUTIL_PC_NO_STP = 1 << 1, /* No 802.1D spanning tree for port. */
472 OFPUTIL_PC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */
473 OFPUTIL_PC_NO_FLOOD = 1 << 4, /* Do not include port when flooding. */
474 /* There are no OpenFlow 1.1-only bits. */
477 enum ofputil_port_state {
478 /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */
479 OFPUTIL_PS_LINK_DOWN = 1 << 0, /* No physical link present. */
480 /* OpenFlow 1.1 only. */
481 OFPUTIL_PS_BLOCKED = 1 << 1, /* Port is blocked */
482 OFPUTIL_PS_LIVE = 1 << 2, /* Live for Fast Failover Group. */
483 /* OpenFlow 1.0 only. */
484 OFPUTIL_PS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
485 OFPUTIL_PS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
486 OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
487 OFPUTIL_PS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
488 OFPUTIL_PS_STP_MASK = 3 << 8 /* Bit mask for OFPPS10_STP_* values. */
491 /* Abstract ofp10_phy_port or ofp11_port. */
492 struct ofputil_phy_port {
494 uint8_t hw_addr[OFP_ETH_ALEN];
495 char name[OFP_MAX_PORT_NAME_LEN];
496 enum ofputil_port_config config;
497 enum ofputil_port_state state;
499 /* NETDEV_F_* feature bitmasks. */
500 enum netdev_features curr; /* Current features. */
501 enum netdev_features advertised; /* Features advertised by the port. */
502 enum netdev_features supported; /* Features supported by the port. */
503 enum netdev_features peer; /* Features advertised by peer. */
506 uint32_t curr_speed; /* Current speed, in kbps. */
507 uint32_t max_speed; /* Maximum supported speed, in kbps. */
510 enum ofputil_capabilities {
511 /* OpenFlow 1.0, 1.1, 1.2, and 1.3 share these capability values. */
512 OFPUTIL_C_FLOW_STATS = 1 << 0, /* Flow statistics. */
513 OFPUTIL_C_TABLE_STATS = 1 << 1, /* Table statistics. */
514 OFPUTIL_C_PORT_STATS = 1 << 2, /* Port statistics. */
515 OFPUTIL_C_IP_REASM = 1 << 5, /* Can reassemble IP fragments. */
516 OFPUTIL_C_QUEUE_STATS = 1 << 6, /* Queue statistics. */
518 /* OpenFlow 1.0 and 1.1 share this capability. */
519 OFPUTIL_C_ARP_MATCH_IP = 1 << 7, /* Match IP addresses in ARP pkts. */
521 /* OpenFlow 1.0 only. */
522 OFPUTIL_C_STP = 1 << 3, /* 802.1d spanning tree. */
524 /* OpenFlow 1.1, 1.2, and 1.3 share this capability. */
525 OFPUTIL_C_GROUP_STATS = 1 << 4, /* Group statistics. */
527 /* OpenFlow 1.2 and 1.3 share this capability */
528 OFPUTIL_C_PORT_BLOCKED = 1 << 8, /* Switch will block looping ports */
531 /* Abstract ofp_switch_features. */
532 struct ofputil_switch_features {
533 uint64_t datapath_id; /* Datapath unique ID. */
534 uint32_t n_buffers; /* Max packets buffered at once. */
535 uint8_t n_tables; /* Number of tables supported by datapath. */
536 uint8_t auxiliary_id; /* Identify auxiliary connections */
537 enum ofputil_capabilities capabilities;
538 uint64_t ofpacts; /* Bitmap of OFPACT_* bits. */
541 enum ofperr ofputil_decode_switch_features(const struct ofp_header *,
542 struct ofputil_switch_features *,
545 struct ofpbuf *ofputil_encode_switch_features(
546 const struct ofputil_switch_features *, enum ofputil_protocol,
548 void ofputil_put_switch_features_port(const struct ofputil_phy_port *,
550 bool ofputil_switch_features_has_ports(struct ofpbuf *b);
552 /* phy_port helper functions. */
553 int ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *,
554 struct ofputil_phy_port *);
556 /* Abstract ofp_port_status. */
557 struct ofputil_port_status {
558 enum ofp_port_reason reason;
559 struct ofputil_phy_port desc;
562 enum ofperr ofputil_decode_port_status(const struct ofp_header *,
563 struct ofputil_port_status *);
564 struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *,
565 enum ofputil_protocol);
567 /* Abstract ofp_port_mod. */
568 struct ofputil_port_mod {
570 uint8_t hw_addr[OFP_ETH_ALEN];
571 enum ofputil_port_config config;
572 enum ofputil_port_config mask;
573 enum netdev_features advertise;
576 enum ofperr ofputil_decode_port_mod(const struct ofp_header *,
577 struct ofputil_port_mod *, bool loose);
578 struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
579 enum ofputil_protocol);
581 /* Abstract ofp_table_mod. */
582 struct ofputil_table_mod {
583 uint8_t table_id; /* ID of the table, 0xff indicates all tables. */
584 enum ofp_table_config config;
587 enum ofperr ofputil_decode_table_mod(const struct ofp_header *,
588 struct ofputil_table_mod *);
589 struct ofpbuf *ofputil_encode_table_mod(const struct ofputil_table_mod *,
590 enum ofputil_protocol);
592 /* Abstract ofp_table_features. */
593 struct ofputil_table_features {
594 uint8_t table_id; /* Identifier of table. Lower numbered tables
595 are consulted first. */
596 char name[OFP_MAX_TABLE_NAME_LEN];
597 ovs_be64 metadata_match; /* Bits of metadata table can match. */
598 ovs_be64 metadata_write; /* Bits of metadata table can write. */
599 uint32_t config; /* Bitmap of OFPTC_* values */
600 uint32_t max_entries; /* Max number of entries supported. */
602 /* Table features related to instructions. There are two instances:
604 * - 'miss' reports features available in the table miss flow.
606 * - 'nonmiss' reports features available in other flows. */
607 struct ofputil_table_instruction_features {
608 /* Tables that "goto-table" may jump to. */
609 unsigned long int next[BITMAP_N_LONGS(255)];
611 /* Bitmap of OVSINST_* for supported instructions. */
612 uint32_t instructions;
614 /* Table features related to actions. There are two instances:
616 * - 'write' reports features available in a "write_actions"
619 * - 'apply' reports features available in an "apply_actions"
621 struct ofputil_table_action_features {
622 uint64_t ofpacts; /* Bitmap of supported OFPACT_*. */
623 struct mf_bitmap set_fields; /* Fields for "set-field". */
629 * For any given field the following combinations are valid:
631 * - match=0, wildcard=0, mask=0: Flows in this table cannot match on
634 * - match=1, wildcard=0, mask=0: Flows in this table must match on all
635 * the bits in this field.
637 * - match=1, wildcard=1, mask=0: Flows in this table must either match
638 * on all the bits in the field or wildcard the field entirely.
640 * - match=1, wildcard=1, mask=1: Flows in this table may arbitrarily
641 * mask this field (as special cases, they may match on all the bits
642 * or wildcard it entirely).
644 * Other combinations do not make sense.
646 struct mf_bitmap match; /* Fields that may be matched. */
647 struct mf_bitmap mask; /* Subset of 'match' that may have masks. */
648 struct mf_bitmap wildcard; /* Subset of 'match' that may be wildcarded. */
651 int ofputil_decode_table_features(struct ofpbuf *,
652 struct ofputil_table_features *, bool loose);
653 struct ofpbuf *ofputil_encode_table_features_request(
654 enum ofp_version ofp_version);
655 void ofputil_append_table_features_reply(
656 const struct ofputil_table_features *tf,
657 struct list *replies);
659 /* Meter band configuration for all supported band types. */
660 struct ofputil_meter_band {
662 uint8_t prec_level; /* Non-zero if type == OFPMBT_DSCP_REMARK. */
667 struct ofputil_meter_band_stats {
668 uint64_t packet_count;
672 struct ofputil_meter_config {
676 struct ofputil_meter_band *bands;
679 /* Abstract ofp_meter_mod. */
680 struct ofputil_meter_mod {
682 struct ofputil_meter_config meter;
685 struct ofputil_meter_stats {
688 uint64_t packet_in_count;
689 uint64_t byte_in_count;
690 uint32_t duration_sec;
691 uint32_t duration_nsec;
693 struct ofputil_meter_band_stats *bands;
696 struct ofputil_meter_features {
697 uint32_t max_meters; /* Maximum number of meters. */
698 uint32_t band_types; /* Can support max 32 band types. */
699 uint32_t capabilities; /* Supported flags. */
704 enum ofperr ofputil_decode_meter_mod(const struct ofp_header *,
705 struct ofputil_meter_mod *,
706 struct ofpbuf *bands);
707 struct ofpbuf *ofputil_encode_meter_mod(enum ofp_version,
708 const struct ofputil_meter_mod *);
710 void ofputil_decode_meter_features(const struct ofp_header *,
711 struct ofputil_meter_features *);
712 struct ofpbuf *ofputil_encode_meter_features_reply(const struct
713 ofputil_meter_features *,
714 const struct ofp_header *
716 void ofputil_decode_meter_request(const struct ofp_header *,
719 void ofputil_append_meter_config(struct list *replies,
720 const struct ofputil_meter_config *);
722 void ofputil_append_meter_stats(struct list *replies,
723 const struct ofputil_meter_stats *);
725 enum ofputil_meter_request_type {
726 OFPUTIL_METER_FEATURES,
727 OFPUTIL_METER_CONFIG,
731 struct ofpbuf *ofputil_encode_meter_request(enum ofp_version,
732 enum ofputil_meter_request_type,
735 int ofputil_decode_meter_stats(struct ofpbuf *,
736 struct ofputil_meter_stats *,
737 struct ofpbuf *bands);
739 int ofputil_decode_meter_config(struct ofpbuf *,
740 struct ofputil_meter_config *,
741 struct ofpbuf *bands);
743 /* Type for meter_id in ofproto provider interface, UINT32_MAX if invalid. */
744 typedef struct { uint32_t uint32; } ofproto_meter_id;
746 /* Abstract ofp_role_request and reply. */
747 struct ofputil_role_request {
748 enum ofp12_controller_role role;
749 bool have_generation_id;
750 uint64_t generation_id;
753 struct ofputil_role_status {
754 enum ofp12_controller_role role;
755 enum ofp14_controller_role_reason reason;
756 uint64_t generation_id;
759 enum ofperr ofputil_decode_role_message(const struct ofp_header *,
760 struct ofputil_role_request *);
761 struct ofpbuf *ofputil_encode_role_reply(const struct ofp_header *,
762 const struct ofputil_role_request *);
764 struct ofpbuf *ofputil_encode_role_status(
765 const struct ofputil_role_status *status,
766 enum ofputil_protocol protocol);
768 enum ofperr ofputil_decode_role_status(const struct ofp_header *oh,
769 struct ofputil_role_status *rs);
770 /* Abstract table stats. */
771 struct ofputil_table_stats {
773 char name[OFP_MAX_TABLE_NAME_LEN];
774 ovs_be64 metadata_match; /* Bits of metadata table can match. */
775 ovs_be64 metadata_write; /* Bits of metadata table can write. */
776 uint32_t config; /* Bitmap of OFPTC_* values */
777 uint32_t max_entries; /* Max number of entries supported. */
779 struct mf_bitmap match; /* Fields table can match. */
780 struct mf_bitmap wildcards; /* Fields table can wildcard. */
781 uint64_t write_ofpacts; /* OFPACT_* supported on Write-Actions. */
782 uint64_t apply_ofpacts; /* OFPACT_* supported on Apply-Actions. */
783 struct mf_bitmap write_setfields; /* Fields that can be set in W-A. */
784 struct mf_bitmap apply_setfields; /* Fields that can be set in A-A. */
785 uint32_t instructions; /* Bitmap of OFPIT_* values supported. */
787 uint32_t active_count; /* Number of active entries. */
788 uint64_t lookup_count; /* Number of packets looked up in table. */
789 uint64_t matched_count; /* Number of packets that hit table. */
792 struct ofpbuf *ofputil_encode_table_stats_reply(
793 const struct ofputil_table_stats[], int n,
794 const struct ofp_header *request);
796 /* Queue configuration request. */
797 struct ofpbuf *ofputil_encode_queue_get_config_request(enum ofp_version,
799 enum ofperr ofputil_decode_queue_get_config_request(const struct ofp_header *,
802 /* Queue configuration reply. */
803 struct ofputil_queue_config {
806 /* Each of these optional values is expressed in tenths of a percent.
807 * Values greater than 1000 indicate that the feature is disabled.
808 * UINT16_MAX indicates that the value is omitted. */
813 struct ofpbuf *ofputil_encode_queue_get_config_reply(
814 const struct ofp_header *request);
815 void ofputil_append_queue_get_config_reply(
816 struct ofpbuf *reply, const struct ofputil_queue_config *);
818 enum ofperr ofputil_decode_queue_get_config_reply(struct ofpbuf *reply,
820 int ofputil_pull_queue_get_config_reply(struct ofpbuf *reply,
821 struct ofputil_queue_config *);
824 /* Abstract nx_flow_monitor_request. */
825 struct ofputil_flow_monitor_request {
827 enum nx_flow_monitor_flags flags;
833 int ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *,
835 void ofputil_append_flow_monitor_request(
836 const struct ofputil_flow_monitor_request *, struct ofpbuf *msg);
838 /* Abstract nx_flow_update. */
839 struct ofputil_flow_update {
840 enum nx_flow_update_event event;
842 /* Used only for NXFME_ADDED, NXFME_DELETED, NXFME_MODIFIED. */
843 enum ofp_flow_removed_reason reason;
844 uint16_t idle_timeout;
845 uint16_t hard_timeout;
850 const struct ofpact *ofpacts;
853 /* Used only for NXFME_ABBREV. */
857 int ofputil_decode_flow_update(struct ofputil_flow_update *,
858 struct ofpbuf *msg, struct ofpbuf *ofpacts);
859 void ofputil_start_flow_update(struct list *replies);
860 void ofputil_append_flow_update(const struct ofputil_flow_update *,
861 struct list *replies);
863 /* Abstract nx_flow_monitor_cancel. */
864 uint32_t ofputil_decode_flow_monitor_cancel(const struct ofp_header *);
865 struct ofpbuf *ofputil_encode_flow_monitor_cancel(uint32_t id);
867 /* Port desc stats requests and replies. */
868 enum ofperr ofputil_decode_port_desc_stats_request(const struct ofp_header *,
870 struct ofpbuf *ofputil_encode_port_desc_stats_request(
871 enum ofp_version ofp_version, ofp_port_t);
873 void ofputil_append_port_desc_stats_reply(const struct ofputil_phy_port *pp,
874 struct list *replies);
876 /* Encoding simple OpenFlow messages. */
877 struct ofpbuf *make_echo_request(enum ofp_version);
878 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
880 struct ofpbuf *ofputil_encode_barrier_request(enum ofp_version);
882 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
883 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
888 /* The type of an action.
890 * For each implemented OFPAT10_* and NXAST_* action type, there is a
891 * corresponding constant prefixed with OFPUTIL_, e.g.:
893 * OFPUTIL_OFPAT10_OUTPUT
894 * OFPUTIL_OFPAT10_SET_VLAN_VID
895 * OFPUTIL_OFPAT10_SET_VLAN_PCP
896 * OFPUTIL_OFPAT10_STRIP_VLAN
897 * OFPUTIL_OFPAT10_SET_DL_SRC
898 * OFPUTIL_OFPAT10_SET_DL_DST
899 * OFPUTIL_OFPAT10_SET_NW_SRC
900 * OFPUTIL_OFPAT10_SET_NW_DST
901 * OFPUTIL_OFPAT10_SET_NW_TOS
902 * OFPUTIL_OFPAT10_SET_TP_SRC
903 * OFPUTIL_OFPAT10_SET_TP_DST
904 * OFPUTIL_OFPAT10_ENQUEUE
905 * OFPUTIL_NXAST_RESUBMIT
906 * OFPUTIL_NXAST_SET_TUNNEL
907 * OFPUTIL_NXAST_SET_METADATA
908 * OFPUTIL_NXAST_SET_QUEUE
909 * OFPUTIL_NXAST_POP_QUEUE
910 * OFPUTIL_NXAST_REG_MOVE
911 * OFPUTIL_NXAST_REG_LOAD
913 * OFPUTIL_NXAST_SET_TUNNEL64
914 * OFPUTIL_NXAST_MULTIPATH
915 * OFPUTIL_NXAST_BUNDLE
916 * OFPUTIL_NXAST_BUNDLE_LOAD
917 * OFPUTIL_NXAST_RESUBMIT_TABLE
918 * OFPUTIL_NXAST_OUTPUT_REG
919 * OFPUTIL_NXAST_LEARN
920 * OFPUTIL_NXAST_DEC_TTL
921 * OFPUTIL_NXAST_FIN_TIMEOUT
923 * (The above list helps developers who want to "grep" for these definitions.)
925 enum OVS_PACKED_ENUM ofputil_action_code {
926 OFPUTIL_ACTION_INVALID,
927 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM,
928 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
929 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
930 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
931 #include "ofp-util.def"
934 /* The number of values of "enum ofputil_action_code". */
936 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) + 1
937 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
938 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
939 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
940 OFPUTIL_N_ACTIONS = 1
941 #include "ofp-util.def"
944 int ofputil_action_code_from_name(const char *);
945 const char * ofputil_action_name_from_code(enum ofputil_action_code code);
946 enum ofputil_action_code ofputil_action_code_from_ofp13_action(
947 enum ofp13_action_type type);
949 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
951 /* For each OpenFlow action <ENUM> that has a corresponding action structure
952 * struct <STRUCT>, this defines two functions:
954 * void ofputil_init_<ENUM>(struct <STRUCT> *action);
956 * Initializes the parts of 'action' that identify it as having type <ENUM>
957 * and length 'sizeof *action' and zeros the rest. For actions that have
958 * variable length, the length used and cleared is that of struct <STRUCT>.
960 * struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
962 * Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
963 * initializes it with ofputil_init_<ENUM>(), and returns it.
965 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
966 void ofputil_init_##ENUM(struct STRUCT *); \
967 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
968 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
969 void ofputil_init_##ENUM(struct STRUCT *); \
970 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
971 #define OFPAT13_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
972 void ofputil_init_##ENUM(struct STRUCT *); \
973 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
974 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
975 void ofputil_init_##ENUM(struct STRUCT *); \
976 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
977 #include "ofp-util.def"
979 #define OFP_ACTION_ALIGN 8 /* Alignment of ofp_actions. */
981 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
983 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
984 union ofp_action **, size_t *);
986 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
987 const union ofp_action *b, size_t n_b);
988 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
990 /* Handy utility for parsing flows and actions. */
991 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
993 struct ofputil_port_stats {
995 struct netdev_stats stats;
996 uint32_t duration_sec; /* UINT32_MAX if unknown. */
997 uint32_t duration_nsec;
1000 struct ofpbuf *ofputil_encode_dump_ports_request(enum ofp_version ofp_version,
1002 void ofputil_append_port_stat(struct list *replies,
1003 const struct ofputil_port_stats *ops);
1004 size_t ofputil_count_port_stats(const struct ofp_header *);
1005 int ofputil_decode_port_stats(struct ofputil_port_stats *, struct ofpbuf *msg);
1006 enum ofperr ofputil_decode_port_stats_request(const struct ofp_header *request,
1007 ofp_port_t *ofp10_port);
1009 struct ofputil_queue_stats_request {
1010 ofp_port_t port_no; /* OFPP_ANY means "all ports". */
1015 ofputil_decode_queue_stats_request(const struct ofp_header *request,
1016 struct ofputil_queue_stats_request *oqsr);
1018 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
1019 const struct ofputil_queue_stats_request *oqsr);
1021 struct ofputil_queue_stats {
1025 /* Values of unsupported statistics are set to all-1-bits (UINT64_MAX). */
1027 uint64_t tx_packets;
1030 /* UINT32_MAX if unknown. */
1031 uint32_t duration_sec;
1032 uint32_t duration_nsec;
1035 size_t ofputil_count_queue_stats(const struct ofp_header *);
1036 int ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg);
1037 void ofputil_append_queue_stat(struct list *replies,
1038 const struct ofputil_queue_stats *oqs);
1040 struct bucket_counter {
1041 uint64_t packet_count; /* Number of packets processed by bucket. */
1042 uint64_t byte_count; /* Number of bytes processed by bucket. */
1045 /* Bucket for use in groups. */
1046 struct ofputil_bucket {
1047 struct list list_node;
1048 uint16_t weight; /* Relative weight, for "select" groups. */
1049 ofp_port_t watch_port; /* Port whose state affects whether this bucket
1050 * is live. Only required for fast failover
1052 uint32_t watch_group; /* Group whose state affects whether this
1053 * bucket is live. Only required for fast
1054 * failover groups. */
1055 struct ofpact *ofpacts; /* Series of "struct ofpact"s. */
1056 size_t ofpacts_len; /* Length of ofpacts, in bytes. */
1058 struct bucket_counter stats;
1061 /* Protocol-independent group_mod. */
1062 struct ofputil_group_mod {
1063 uint16_t command; /* One of OFPGC11_*. */
1064 uint8_t type; /* One of OFPGT11_*. */
1065 uint32_t group_id; /* Group identifier. */
1066 struct list buckets; /* Contains "struct ofputil_bucket"s. */
1069 /* Group stats reply, independent of protocol. */
1070 struct ofputil_group_stats {
1071 uint32_t group_id; /* Group identifier. */
1073 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
1074 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
1075 uint32_t duration_sec; /* UINT32_MAX if unknown. */
1076 uint32_t duration_nsec;
1078 struct bucket_counter *bucket_stats;
1081 /* Group features reply, independent of protocol.
1083 * Only OF1.2 and later support group features replies. */
1084 struct ofputil_group_features {
1085 uint32_t types; /* Bitmap of OFPGT_* values supported. */
1086 uint32_t capabilities; /* Bitmap of OFPGFC12_* capability supported. */
1087 uint32_t max_groups[4]; /* Maximum number of groups for each type. */
1088 uint64_t ofpacts[4]; /* Bitmaps of supported OFPACT_* */
1091 /* Group desc reply, independent of protocol. */
1092 struct ofputil_group_desc {
1093 uint8_t type; /* One of OFPGT_*. */
1094 uint32_t group_id; /* Group identifier. */
1095 struct list buckets; /* Contains "struct ofputil_bucket"s. */
1098 void ofputil_bucket_list_destroy(struct list *buckets);
1101 ofputil_bucket_has_liveness(const struct ofputil_bucket *bucket)
1103 return (bucket->watch_port != OFPP_ANY ||
1104 bucket->watch_group != OFPG_ANY);
1107 struct ofpbuf *ofputil_encode_group_stats_request(enum ofp_version,
1109 enum ofperr ofputil_decode_group_stats_request(
1110 const struct ofp_header *request, uint32_t *group_id);
1111 void ofputil_append_group_stats(struct list *replies,
1112 const struct ofputil_group_stats *);
1113 struct ofpbuf *ofputil_encode_group_features_request(enum ofp_version);
1114 struct ofpbuf *ofputil_encode_group_features_reply(
1115 const struct ofputil_group_features *, const struct ofp_header *request);
1116 void ofputil_decode_group_features_reply(const struct ofp_header *,
1117 struct ofputil_group_features *);
1118 struct ofpbuf *ofputil_encode_group_mod(enum ofp_version ofp_version,
1119 const struct ofputil_group_mod *gm);
1121 enum ofperr ofputil_decode_group_mod(const struct ofp_header *,
1122 struct ofputil_group_mod *);
1124 int ofputil_decode_group_stats_reply(struct ofpbuf *,
1125 struct ofputil_group_stats *);
1127 uint32_t ofputil_decode_group_desc_request(const struct ofp_header *);
1128 struct ofpbuf *ofputil_encode_group_desc_request(enum ofp_version,
1131 int ofputil_decode_group_desc_reply(struct ofputil_group_desc *,
1132 struct ofpbuf *, enum ofp_version);
1134 void ofputil_append_group_desc_reply(const struct ofputil_group_desc *,
1135 struct list *buckets,
1136 struct list *replies);
1138 struct ofputil_bundle_ctrl_msg {
1144 struct ofputil_bundle_add_msg {
1147 const struct ofp_header *msg;
1150 enum ofperr ofputil_decode_bundle_ctrl(const struct ofp_header *,
1151 struct ofputil_bundle_ctrl_msg *);
1153 struct ofpbuf *ofputil_encode_bundle_ctrl_reply(const struct ofp_header *,
1154 struct ofputil_bundle_ctrl_msg *);
1156 struct ofpbuf *ofputil_encode_bundle_add(enum ofp_version ofp_version,
1157 struct ofputil_bundle_add_msg *msg);
1159 enum ofperr ofputil_decode_bundle_add(const struct ofp_header *,
1160 struct ofputil_bundle_add_msg *);
1161 #endif /* ofp-util.h */