2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 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.
24 #include "classifier.h"
29 #include "openflow/nicira-ext.h"
30 #include "openvswitch/types.h"
35 enum ofperr ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port);
36 ovs_be32 ofputil_port_to_ofp11(uint16_t ofp10_port);
38 enum ofperr ofputil_check_output_port(uint16_t ofp_port, int max_ports);
39 bool ofputil_port_from_string(const char *, uint16_t *portp);
40 void ofputil_format_port(uint16_t port, struct ds *);
42 /* Converting OFPFW10_NW_SRC_MASK and OFPFW10_NW_DST_MASK wildcard bit counts
43 * to and from IP bitmasks. */
44 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
45 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
49 * A "protocol" is an OpenFlow version plus, for some OpenFlow versions,
50 * a bit extra about the flow match format in use.
52 * These are arranged from most portable to least portable, or alternatively
53 * from least powerful to most powerful. Protocols earlier on the list are
54 * more likely to be understood for the purpose of making requests, but
55 * protocol later on the list are more likely to accurately describe a flow
58 * On any given OpenFlow connection, a single protocol is in effect at any
59 * given time. These values use separate bits only because that makes it easy
60 * to test whether a particular protocol is within a given set of protocols and
61 * to implement set union and intersection.
63 enum ofputil_protocol {
64 /* OpenFlow 1.0 protocols.
66 * The "STD" protocols use the standard OpenFlow 1.0 flow format.
67 * The "NXM" protocols use the Nicira Extensible Match (NXM) flow format.
69 * The protocols with "TID" mean that the nx_flow_mod_table_id Nicira
70 * extension has been enabled. The other protocols have it disabled.
72 #define OFPUTIL_P_NONE 0
73 OFPUTIL_P_OF10_STD = 1 << 0,
74 OFPUTIL_P_OF10_STD_TID = 1 << 1,
75 OFPUTIL_P_OF10_NXM = 1 << 2,
76 OFPUTIL_P_OF10_NXM_TID = 1 << 3,
77 #define OFPUTIL_P_OF10_STD_ANY (OFPUTIL_P_OF10_STD | OFPUTIL_P_OF10_STD_TID)
78 #define OFPUTIL_P_OF10_NXM_ANY (OFPUTIL_P_OF10_NXM | OFPUTIL_P_OF10_NXM_TID)
80 /* OpenFlow 1.2 protocol (only one variant).
82 * This uses the standard OpenFlow Extensible Match (OXM) flow format.
84 * OpenFlow 1.2 always operates with an equivalent of the
85 * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
87 OFPUTIL_P_OF12_OXM = 1 << 4,
90 #define OFPUTIL_P_ANY ((1 << 5) - 1)
92 /* Protocols in which a specific table may be specified in flow_mods. */
93 #define OFPUTIL_P_TID (OFPUTIL_P_OF10_STD_TID | \
94 OFPUTIL_P_OF10_NXM_TID | \
98 /* Protocols to use for flow dumps, from most to least preferred. */
99 extern enum ofputil_protocol ofputil_flow_dump_protocols[];
100 extern size_t ofputil_n_flow_dump_protocols;
102 enum ofputil_protocol
103 ofputil_protocol_from_ofp_version(enum ofp_version version);
104 enum ofp_version ofputil_protocol_to_ofp_version(enum ofputil_protocol);
106 bool ofputil_protocol_is_valid(enum ofputil_protocol);
107 enum ofputil_protocol ofputil_protocol_set_tid(enum ofputil_protocol,
109 enum ofputil_protocol ofputil_protocol_to_base(enum ofputil_protocol);
110 enum ofputil_protocol ofputil_protocol_set_base(
111 enum ofputil_protocol cur, enum ofputil_protocol new_base);
113 const char *ofputil_protocol_to_string(enum ofputil_protocol);
114 char *ofputil_protocols_to_string(enum ofputil_protocol);
115 enum ofputil_protocol ofputil_protocols_from_string(const char *);
116 enum ofputil_protocol ofputil_usable_protocols(const struct match *);
118 void ofputil_format_version(struct ds *, enum ofp_version);
119 void ofputil_format_version_name(struct ds *, enum ofp_version);
121 /* A bitmap of version numbers
123 * Bit offsets correspond to ofp_version numbers which in turn correspond to
124 * wire-protocol numbers for Open Flow versions.. E.g. (1u << OFP11_VERSION)
125 * is the mask for Open Flow 1.1. If the bit for a version is set then it is
126 * allowed, otherwise it is disallowed. */
128 void ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap);
129 void ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap);
131 /* Bitmap of OpenFlow versions that Open vSwitch supports. */
132 #define OFPUTIL_SUPPORTED_VERSIONS \
133 ((1u << OFP10_VERSION) | (1u << OFP12_VERSION))
135 /* Bitmap of OpenFlow versions to enable by default (a subset of
136 * OFPUTIL_SUPPORTED_VERSIONS). */
137 #define OFPUTIL_DEFAULT_VERSIONS (1u << OFP10_VERSION)
139 enum ofputil_protocol ofputil_protocols_from_string(const char *s);
141 const char *ofputil_version_to_string(enum ofp_version ofp_version);
142 uint32_t ofputil_versions_from_string(const char *s);
144 bool ofputil_decode_hello(const struct ofp_header *,
145 uint32_t *allowed_versions);
146 struct ofpbuf *ofputil_encode_hello(uint32_t version_bitmap);
148 struct ofpbuf *ofputil_encode_set_protocol(enum ofputil_protocol current,
149 enum ofputil_protocol want,
150 enum ofputil_protocol *next);
153 struct ofpbuf *ofputil_encode_nx_set_flow_format(enum nx_flow_format);
154 enum ofputil_protocol ofputil_nx_flow_format_to_protocol(enum nx_flow_format);
155 bool ofputil_nx_flow_format_is_valid(enum nx_flow_format);
156 const char *ofputil_nx_flow_format_to_string(enum nx_flow_format);
158 /* Work with ofp10_match. */
159 void ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *);
160 void ofputil_match_from_ofp10_match(const struct ofp10_match *,
162 void ofputil_normalize_match(struct match *);
163 void ofputil_normalize_match_quiet(struct match *);
164 void ofputil_match_to_ofp10_match(const struct match *, struct ofp10_match *);
166 /* Work with ofp11_match. */
167 enum ofperr ofputil_pull_ofp11_match(struct ofpbuf *, struct match *,
168 uint16_t *padded_match_len);
169 enum ofperr ofputil_match_from_ofp11_match(const struct ofp11_match *,
171 void ofputil_match_to_ofp11_match(const struct match *, struct ofp11_match *);
173 /* dl_type translation between OpenFlow and 'struct flow' format. */
174 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
175 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
178 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
179 int ofputil_packet_in_format_from_string(const char *);
180 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
181 struct ofpbuf *ofputil_make_set_packet_in_format(enum ofp_version,
182 enum nx_packet_in_format);
184 /* NXT_FLOW_MOD_TABLE_ID extension. */
185 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
187 /* Protocol-independent flow_mod.
189 * The handling of cookies across multiple versions of OpenFlow is a bit
190 * confusing. A full description of Open vSwitch's cookie handling is
191 * in the DESIGN file. The following table shows the expected values of
192 * the cookie-related fields for the different flow_mod commands in
193 * OpenFlow 1.0 ("OF10") and NXM. "<used>" and "-" indicate a value
194 * that may be populated and an ignored field, respectively.
196 * cookie cookie_mask new_cookie
197 * ====== =========== ==========
198 * OF10 Add - 0 <used>
199 * OF10 Modify - 0 <used>
202 * NXM Modify <used> <used> <used>
203 * NXM Delete <used> <used> -
205 struct ofputil_flow_mod {
207 unsigned int priority;
208 ovs_be64 cookie; /* Cookie bits to match. */
209 ovs_be64 cookie_mask; /* 1-bit in each 'cookie' bit to match. */
210 ovs_be64 new_cookie; /* New cookie to install or -1. */
213 uint16_t idle_timeout;
214 uint16_t hard_timeout;
218 struct ofpact *ofpacts; /* Series of "struct ofpact"s. */
219 size_t ofpacts_len; /* Length of ofpacts, in bytes. */
222 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
223 const struct ofp_header *,
224 enum ofputil_protocol,
225 struct ofpbuf *ofpacts);
226 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
227 enum ofputil_protocol);
229 enum ofputil_protocol ofputil_flow_mod_usable_protocols(
230 const struct ofputil_flow_mod *fms, size_t n_fms);
232 /* Flow stats or aggregate stats request, independent of protocol. */
233 struct ofputil_flow_stats_request {
234 bool aggregate; /* Aggregate results? */
237 ovs_be64 cookie_mask;
242 enum ofperr ofputil_decode_flow_stats_request(
243 struct ofputil_flow_stats_request *, const struct ofp_header *);
244 struct ofpbuf *ofputil_encode_flow_stats_request(
245 const struct ofputil_flow_stats_request *, enum ofputil_protocol);
246 enum ofputil_protocol ofputil_flow_stats_request_usable_protocols(
247 const struct ofputil_flow_stats_request *);
249 /* Flow stats reply, independent of protocol. */
250 struct ofputil_flow_stats {
254 uint32_t duration_sec;
255 uint32_t duration_nsec;
257 uint16_t idle_timeout;
258 uint16_t hard_timeout;
259 int idle_age; /* Seconds since last packet, -1 if unknown. */
260 int hard_age; /* Seconds since last change, -1 if unknown. */
261 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
262 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
263 struct ofpact *ofpacts;
267 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
269 bool flow_age_extension,
270 struct ofpbuf *ofpacts);
271 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
272 struct list *replies);
274 /* Aggregate stats reply, independent of protocol. */
275 struct ofputil_aggregate_stats {
276 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
277 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
281 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
282 const struct ofputil_aggregate_stats *stats,
283 const struct ofp_header *request);
284 enum ofperr ofputil_decode_aggregate_stats_reply(
285 struct ofputil_aggregate_stats *,
286 const struct ofp_header *reply);
288 /* Flow removed message, independent of protocol. */
289 struct ofputil_flow_removed {
293 uint8_t reason; /* One of OFPRR_*. */
294 uint8_t table_id; /* 255 if message didn't include table ID. */
295 uint32_t duration_sec;
296 uint32_t duration_nsec;
297 uint16_t idle_timeout;
298 uint16_t hard_timeout;
299 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
300 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
303 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
304 const struct ofp_header *);
305 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
306 enum ofputil_protocol);
308 /* Abstract packet-in message. */
309 struct ofputil_packet_in {
313 enum ofp_packet_in_reason reason; /* One of OFPR_*. */
314 uint16_t controller_id; /* Controller ID to send to. */
320 uint16_t total_len; /* Full length of frame. */
322 struct flow_metadata fmd; /* Metadata at creation time. */
325 enum ofperr ofputil_decode_packet_in(struct ofputil_packet_in *,
326 const struct ofp_header *);
327 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
328 enum ofputil_protocol protocol,
329 enum nx_packet_in_format);
331 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason);
332 bool ofputil_packet_in_reason_from_string(const char *,
333 enum ofp_packet_in_reason *);
335 /* Abstract packet-out message.
337 * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
338 * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
339 struct ofputil_packet_out {
340 const void *packet; /* Packet data, if buffer_id == UINT32_MAX. */
341 size_t packet_len; /* Length of packet data in bytes. */
342 uint32_t buffer_id; /* Buffer id or UINT32_MAX if no buffer. */
343 uint16_t in_port; /* Packet's input port. */
344 struct ofpact *ofpacts; /* Actions. */
345 size_t ofpacts_len; /* Size of ofpacts in bytes. */
348 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
349 const struct ofp_header *,
350 struct ofpbuf *ofpacts);
351 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *,
352 enum ofputil_protocol protocol);
354 enum ofputil_port_config {
355 /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */
356 OFPUTIL_PC_PORT_DOWN = 1 << 0, /* Port is administratively down. */
357 OFPUTIL_PC_NO_RECV = 1 << 2, /* Drop all packets received by port. */
358 OFPUTIL_PC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */
359 OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */
360 /* OpenFlow 1.0 only. */
361 OFPUTIL_PC_NO_STP = 1 << 1, /* No 802.1D spanning tree for port. */
362 OFPUTIL_PC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */
363 OFPUTIL_PC_NO_FLOOD = 1 << 4, /* Do not include port when flooding. */
364 /* There are no OpenFlow 1.1-only bits. */
367 enum ofputil_port_state {
368 /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */
369 OFPUTIL_PS_LINK_DOWN = 1 << 0, /* No physical link present. */
370 /* OpenFlow 1.1 only. */
371 OFPUTIL_PS_BLOCKED = 1 << 1, /* Port is blocked */
372 OFPUTIL_PS_LIVE = 1 << 2, /* Live for Fast Failover Group. */
373 /* OpenFlow 1.0 only. */
374 OFPUTIL_PS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
375 OFPUTIL_PS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
376 OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
377 OFPUTIL_PS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
378 OFPUTIL_PS_STP_MASK = 3 << 8 /* Bit mask for OFPPS10_STP_* values. */
381 /* Abstract ofp10_phy_port or ofp11_port. */
382 struct ofputil_phy_port {
384 uint8_t hw_addr[OFP_ETH_ALEN];
385 char name[OFP_MAX_PORT_NAME_LEN];
386 enum ofputil_port_config config;
387 enum ofputil_port_state state;
389 /* NETDEV_F_* feature bitmasks. */
390 enum netdev_features curr; /* Current features. */
391 enum netdev_features advertised; /* Features advertised by the port. */
392 enum netdev_features supported; /* Features supported by the port. */
393 enum netdev_features peer; /* Features advertised by peer. */
396 uint32_t curr_speed; /* Current speed, in kbps. */
397 uint32_t max_speed; /* Maximum supported speed, in kbps. */
400 enum ofputil_capabilities {
401 /* OpenFlow 1.0, 1.1 and 1.2 share these values for these capabilities. */
402 OFPUTIL_C_FLOW_STATS = 1 << 0, /* Flow statistics. */
403 OFPUTIL_C_TABLE_STATS = 1 << 1, /* Table statistics. */
404 OFPUTIL_C_PORT_STATS = 1 << 2, /* Port statistics. */
405 OFPUTIL_C_IP_REASM = 1 << 5, /* Can reassemble IP fragments. */
406 OFPUTIL_C_QUEUE_STATS = 1 << 6, /* Queue statistics. */
408 /* OpenFlow 1.0 and 1.1 share this capability. */
409 OFPUTIL_C_ARP_MATCH_IP = 1 << 7, /* Match IP addresses in ARP pkts. */
411 /* OpenFlow 1.0 only. */
412 OFPUTIL_C_STP = 1 << 3, /* 802.1d spanning tree. */
414 /* OpenFlow 1.1 and 1.2 share this capability. */
415 OFPUTIL_C_GROUP_STATS = 1 << 4, /* Group statistics. */
417 /* OpenFlow 1.2 only */
418 OFPUTIL_C_PORT_BLOCKED = 1 << 8, /* Switch will block looping ports */
421 enum ofputil_action_bitmap {
422 OFPUTIL_A_OUTPUT = 1 << 0,
423 OFPUTIL_A_SET_VLAN_VID = 1 << 1,
424 OFPUTIL_A_SET_VLAN_PCP = 1 << 2,
425 OFPUTIL_A_STRIP_VLAN = 1 << 3,
426 OFPUTIL_A_SET_DL_SRC = 1 << 4,
427 OFPUTIL_A_SET_DL_DST = 1 << 5,
428 OFPUTIL_A_SET_NW_SRC = 1 << 6,
429 OFPUTIL_A_SET_NW_DST = 1 << 7,
430 OFPUTIL_A_SET_NW_ECN = 1 << 8,
431 OFPUTIL_A_SET_NW_TOS = 1 << 9,
432 OFPUTIL_A_SET_TP_SRC = 1 << 10,
433 OFPUTIL_A_SET_TP_DST = 1 << 11,
434 OFPUTIL_A_ENQUEUE = 1 << 12,
435 OFPUTIL_A_COPY_TTL_OUT = 1 << 13,
436 OFPUTIL_A_COPY_TTL_IN = 1 << 14,
437 OFPUTIL_A_SET_MPLS_LABEL = 1 << 15,
438 OFPUTIL_A_SET_MPLS_TC = 1 << 16,
439 OFPUTIL_A_SET_MPLS_TTL = 1 << 17,
440 OFPUTIL_A_DEC_MPLS_TTL = 1 << 18,
441 OFPUTIL_A_PUSH_VLAN = 1 << 19,
442 OFPUTIL_A_POP_VLAN = 1 << 20,
443 OFPUTIL_A_PUSH_MPLS = 1 << 21,
444 OFPUTIL_A_POP_MPLS = 1 << 22,
445 OFPUTIL_A_SET_QUEUE = 1 << 23,
446 OFPUTIL_A_GROUP = 1 << 24,
447 OFPUTIL_A_SET_NW_TTL = 1 << 25,
448 OFPUTIL_A_DEC_NW_TTL = 1 << 26,
449 OFPUTIL_A_SET_FIELD = 1 << 27,
452 /* Abstract ofp_switch_features. */
453 struct ofputil_switch_features {
454 uint64_t datapath_id; /* Datapath unique ID. */
455 uint32_t n_buffers; /* Max packets buffered at once. */
456 uint8_t n_tables; /* Number of tables supported by datapath. */
457 enum ofputil_capabilities capabilities;
458 enum ofputil_action_bitmap actions;
461 enum ofperr ofputil_decode_switch_features(const struct ofp_header *,
462 struct ofputil_switch_features *,
465 struct ofpbuf *ofputil_encode_switch_features(
466 const struct ofputil_switch_features *, enum ofputil_protocol,
468 void ofputil_put_switch_features_port(const struct ofputil_phy_port *,
470 bool ofputil_switch_features_ports_trunc(struct ofpbuf *b);
472 /* phy_port helper functions. */
473 int ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *,
474 struct ofputil_phy_port *);
475 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *);
477 /* Abstract ofp_port_status. */
478 struct ofputil_port_status {
479 enum ofp_port_reason reason;
480 struct ofputil_phy_port desc;
483 enum ofperr ofputil_decode_port_status(const struct ofp_header *,
484 struct ofputil_port_status *);
485 struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *,
486 enum ofputil_protocol);
488 /* Abstract ofp_port_mod. */
489 struct ofputil_port_mod {
491 uint8_t hw_addr[OFP_ETH_ALEN];
492 enum ofputil_port_config config;
493 enum ofputil_port_config mask;
494 enum netdev_features advertise;
497 enum ofperr ofputil_decode_port_mod(const struct ofp_header *,
498 struct ofputil_port_mod *);
499 struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
500 enum ofputil_protocol);
502 /* Abstract table stats.
504 * For now we use ofp12_table_stats as a superset of the other protocol
505 * versions' table stats. */
507 struct ofpbuf *ofputil_encode_table_stats_reply(
508 const struct ofp12_table_stats[], int n,
509 const struct ofp_header *request);
511 /* Abstract nx_flow_monitor_request. */
512 struct ofputil_flow_monitor_request {
514 enum nx_flow_monitor_flags flags;
520 int ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *,
522 void ofputil_append_flow_monitor_request(
523 const struct ofputil_flow_monitor_request *, struct ofpbuf *msg);
525 /* Abstract nx_flow_update. */
526 struct ofputil_flow_update {
527 enum nx_flow_update_event event;
529 /* Used only for NXFME_ADDED, NXFME_DELETED, NXFME_MODIFIED. */
530 enum ofp_flow_removed_reason reason;
531 uint16_t idle_timeout;
532 uint16_t hard_timeout;
537 struct ofpact *ofpacts;
540 /* Used only for NXFME_ABBREV. */
544 int ofputil_decode_flow_update(struct ofputil_flow_update *,
545 struct ofpbuf *msg, struct ofpbuf *ofpacts);
546 void ofputil_start_flow_update(struct list *replies);
547 void ofputil_append_flow_update(const struct ofputil_flow_update *,
548 struct list *replies);
550 /* Abstract nx_flow_monitor_cancel. */
551 uint32_t ofputil_decode_flow_monitor_cancel(const struct ofp_header *);
552 struct ofpbuf *ofputil_encode_flow_monitor_cancel(uint32_t id);
554 /* Encoding OpenFlow stats messages. */
555 void ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
556 const struct ofputil_phy_port *pp,
557 struct list *replies);
559 /* Encoding simple OpenFlow messages. */
560 struct ofpbuf *make_echo_request(enum ofp_version);
561 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
563 struct ofpbuf *ofputil_encode_barrier_request(enum ofp_version);
565 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
566 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
571 /* The type of an action.
573 * For each implemented OFPAT10_* and NXAST_* action type, there is a
574 * corresponding constant prefixed with OFPUTIL_, e.g.:
576 * OFPUTIL_OFPAT10_OUTPUT
577 * OFPUTIL_OFPAT10_SET_VLAN_VID
578 * OFPUTIL_OFPAT10_SET_VLAN_PCP
579 * OFPUTIL_OFPAT10_STRIP_VLAN
580 * OFPUTIL_OFPAT10_SET_DL_SRC
581 * OFPUTIL_OFPAT10_SET_DL_DST
582 * OFPUTIL_OFPAT10_SET_NW_SRC
583 * OFPUTIL_OFPAT10_SET_NW_DST
584 * OFPUTIL_OFPAT10_SET_NW_TOS
585 * OFPUTIL_OFPAT10_SET_TP_SRC
586 * OFPUTIL_OFPAT10_SET_TP_DST
587 * OFPUTIL_OFPAT10_ENQUEUE
588 * OFPUTIL_NXAST_RESUBMIT
589 * OFPUTIL_NXAST_SET_TUNNEL
590 * OFPUTIL_NXAST_SET_METADATA
591 * OFPUTIL_NXAST_SET_QUEUE
592 * OFPUTIL_NXAST_POP_QUEUE
593 * OFPUTIL_NXAST_REG_MOVE
594 * OFPUTIL_NXAST_REG_LOAD
596 * OFPUTIL_NXAST_SET_TUNNEL64
597 * OFPUTIL_NXAST_MULTIPATH
598 * OFPUTIL_NXAST_AUTOPATH
599 * OFPUTIL_NXAST_BUNDLE
600 * OFPUTIL_NXAST_BUNDLE_LOAD
601 * OFPUTIL_NXAST_RESUBMIT_TABLE
602 * OFPUTIL_NXAST_OUTPUT_REG
603 * OFPUTIL_NXAST_LEARN
604 * OFPUTIL_NXAST_DEC_TTL
605 * OFPUTIL_NXAST_FIN_TIMEOUT
607 * (The above list helps developers who want to "grep" for these definitions.)
609 enum OVS_PACKED_ENUM ofputil_action_code {
610 OFPUTIL_ACTION_INVALID,
611 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM,
612 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
613 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
614 #include "ofp-util.def"
617 /* The number of values of "enum ofputil_action_code". */
619 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) + 1
620 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
621 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
622 OFPUTIL_N_ACTIONS = 1
623 #include "ofp-util.def"
626 int ofputil_action_code_from_name(const char *);
628 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
630 /* For each OpenFlow action <ENUM> that has a corresponding action structure
631 * struct <STRUCT>, this defines two functions:
633 * void ofputil_init_<ENUM>(struct <STRUCT> *action);
635 * Initializes the parts of 'action' that identify it as having type <ENUM>
636 * and length 'sizeof *action' and zeros the rest. For actions that have
637 * variable length, the length used and cleared is that of struct <STRUCT>.
639 * struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
641 * Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
642 * initializes it with ofputil_init_<ENUM>(), and returns it.
644 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
645 void ofputil_init_##ENUM(struct STRUCT *); \
646 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
647 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
648 void ofputil_init_##ENUM(struct STRUCT *); \
649 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
650 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
651 void ofputil_init_##ENUM(struct STRUCT *); \
652 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
653 #include "ofp-util.def"
655 #define OFP_ACTION_ALIGN 8 /* Alignment of ofp_actions. */
657 enum ofperr validate_actions(const union ofp_action *, size_t n_actions,
658 const struct flow *, int max_ports);
659 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
661 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
662 union ofp_action **, size_t *);
664 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
665 const union ofp_action *b, size_t n_b);
666 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
668 /* Handy utility for parsing flows and actions. */
669 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
671 struct ofpbuf *ofputlil_dump_ports(enum ofp_version ofp_version, int16_t port);
673 struct ofputil_port_stats {
675 struct netdev_stats stats;
678 struct ofpbuf *ofputil_encode_dump_ports_request(enum ofp_version ofp_version,
680 void ofputil_append_port_stat(struct list *replies,
681 const struct ofputil_port_stats *ops);
682 size_t ofputil_count_port_stats(const struct ofp_header *);
683 int ofputil_decode_port_stats(struct ofputil_port_stats *, struct ofpbuf *msg);
684 enum ofperr ofputil_decode_port_stats_request(const struct ofp_header *request,
685 uint16_t *ofp10_port);
687 struct ofputil_queue_stats_request {
693 ofputil_decode_queue_stats_request(const struct ofp_header *request,
694 struct ofputil_queue_stats_request *oqsr);
696 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
697 const struct ofputil_queue_stats_request *oqsr);
699 struct ofputil_queue_stats {
702 struct netdev_queue_stats stats;
705 size_t ofputil_count_queue_stats(const struct ofp_header *);
706 int ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg);
707 void ofputil_append_queue_stat(struct list *replies,
708 const struct ofputil_queue_stats *oqs);
710 #endif /* ofp-util.h */