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 OFPUTIL_P_OF10_STD = 1 << 0,
73 OFPUTIL_P_OF10_STD_TID = 1 << 1,
74 OFPUTIL_P_OF10_NXM = 1 << 2,
75 OFPUTIL_P_OF10_NXM_TID = 1 << 3,
76 #define OFPUTIL_P_OF10_STD_ANY (OFPUTIL_P_OF10_STD | OFPUTIL_P_OF10_STD_TID)
77 #define OFPUTIL_P_OF10_NXM_ANY (OFPUTIL_P_OF10_NXM | OFPUTIL_P_OF10_NXM_TID)
79 /* OpenFlow 1.2 protocol (only one variant).
81 * This uses the standard OpenFlow Extensible Match (OXM) flow format.
83 * OpenFlow 1.2 always operates with an equivalent of the
84 * nx_flow_mod_table_id Nicira extension enabled, so there is no "TID"
86 OFPUTIL_P_OF12_OXM = 1 << 4,
89 #define OFPUTIL_P_ANY (OFPUTIL_P_OF10_STD_ANY | OFPUTIL_P_OF10_NXM_ANY)
91 /* Protocols in which a specific table may be specified in flow_mods. */
92 #define OFPUTIL_P_TID (OFPUTIL_P_OF10_STD_TID | OFPUTIL_P_OF10_NXM_TID)
95 /* Protocols to use for flow dumps, from most to least preferred. */
96 extern enum ofputil_protocol ofputil_flow_dump_protocols[];
97 extern size_t ofputil_n_flow_dump_protocols;
100 ofputil_protocol_from_ofp_version(enum ofp_version version);
101 enum ofp_version ofputil_protocol_to_ofp_version(enum ofputil_protocol);
103 bool ofputil_protocol_is_valid(enum ofputil_protocol);
104 enum ofputil_protocol ofputil_protocol_set_tid(enum ofputil_protocol,
106 enum ofputil_protocol ofputil_protocol_to_base(enum ofputil_protocol);
107 enum ofputil_protocol ofputil_protocol_set_base(
108 enum ofputil_protocol cur, enum ofputil_protocol new_base);
110 const char *ofputil_protocol_to_string(enum ofputil_protocol);
111 char *ofputil_protocols_to_string(enum ofputil_protocol);
112 enum ofputil_protocol ofputil_protocols_from_string(const char *);
113 enum ofputil_protocol ofputil_usable_protocols(const struct match *);
115 void ofputil_format_version(struct ds *, enum ofp_version);
116 void ofputil_format_version_name(struct ds *, enum ofp_version);
118 /* A bitmap of version numbers
120 * Bit offsets correspond to ofp_version numbers which in turn correspond to
121 * wire-protocol numbers for Open Flow versions.. E.g. (1u << OFP11_VERSION)
122 * is the mask for Open Flow 1.1. If the bit for a version is set then it is
123 * allowed, otherwise it is disallowed. */
125 void ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap);
126 void ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap);
128 /* Bitmap of OpenFlow versions that Open vSwitch supports. */
129 #define OFPUTIL_SUPPORTED_VERSIONS \
130 ((1u << OFP10_VERSION) | (1u << OFP12_VERSION))
132 /* Bitmap of OpenFlow versions to enable by default (a subset of
133 * OFPUTIL_SUPPORTED_VERSIONS). */
134 #define OFPUTIL_DEFAULT_VERSIONS (1u << OFP10_VERSION)
136 enum ofputil_protocol ofputil_protocols_from_string(const char *s);
138 const char *ofputil_version_to_string(enum ofp_version ofp_version);
139 uint32_t ofputil_versions_from_string(const char *s);
141 bool ofputil_decode_hello(const struct ofp_header *,
142 uint32_t *allowed_versions);
143 struct ofpbuf *ofputil_encode_hello(uint32_t version_bitmap);
145 struct ofpbuf *ofputil_encode_set_protocol(enum ofputil_protocol current,
146 enum ofputil_protocol want,
147 enum ofputil_protocol *next);
150 struct ofpbuf *ofputil_encode_nx_set_flow_format(enum nx_flow_format);
151 enum ofputil_protocol ofputil_nx_flow_format_to_protocol(enum nx_flow_format);
152 bool ofputil_nx_flow_format_is_valid(enum nx_flow_format);
153 const char *ofputil_nx_flow_format_to_string(enum nx_flow_format);
155 /* Work with ofp10_match. */
156 void ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *);
157 void ofputil_match_from_ofp10_match(const struct ofp10_match *,
159 void ofputil_normalize_match(struct match *);
160 void ofputil_normalize_match_quiet(struct match *);
161 void ofputil_match_to_ofp10_match(const struct match *, struct ofp10_match *);
163 /* Work with ofp11_match. */
164 enum ofperr ofputil_pull_ofp11_match(struct ofpbuf *, struct match *,
165 uint16_t *padded_match_len);
166 enum ofperr ofputil_match_from_ofp11_match(const struct ofp11_match *,
168 void ofputil_match_to_ofp11_match(const struct match *, struct ofp11_match *);
170 /* dl_type translation between OpenFlow and 'struct flow' format. */
171 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
172 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
175 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
176 int ofputil_packet_in_format_from_string(const char *);
177 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
178 struct ofpbuf *ofputil_make_set_packet_in_format(enum ofp_version,
179 enum nx_packet_in_format);
181 /* NXT_FLOW_MOD_TABLE_ID extension. */
182 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
184 /* Protocol-independent flow_mod.
186 * The handling of cookies across multiple versions of OpenFlow is a bit
187 * confusing. A full description of Open vSwitch's cookie handling is
188 * in the DESIGN file. The following table shows the expected values of
189 * the cookie-related fields for the different flow_mod commands in
190 * OpenFlow 1.0 ("OF10") and NXM. "<used>" and "-" indicate a value
191 * that may be populated and an ignored field, respectively.
193 * cookie cookie_mask new_cookie
194 * ====== =========== ==========
195 * OF10 Add - 0 <used>
196 * OF10 Modify - 0 <used>
199 * NXM Modify <used> <used> <used>
200 * NXM Delete <used> <used> -
202 struct ofputil_flow_mod {
204 unsigned int priority;
205 ovs_be64 cookie; /* Cookie bits to match. */
206 ovs_be64 cookie_mask; /* 1-bit in each 'cookie' bit to match. */
207 ovs_be64 new_cookie; /* New cookie to install or -1. */
210 uint16_t idle_timeout;
211 uint16_t hard_timeout;
215 struct ofpact *ofpacts; /* Series of "struct ofpact"s. */
216 size_t ofpacts_len; /* Length of ofpacts, in bytes. */
219 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
220 const struct ofp_header *,
221 enum ofputil_protocol,
222 struct ofpbuf *ofpacts);
223 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
224 enum ofputil_protocol);
226 enum ofputil_protocol ofputil_flow_mod_usable_protocols(
227 const struct ofputil_flow_mod *fms, size_t n_fms);
229 /* Flow stats or aggregate stats request, independent of protocol. */
230 struct ofputil_flow_stats_request {
231 bool aggregate; /* Aggregate results? */
234 ovs_be64 cookie_mask;
239 enum ofperr ofputil_decode_flow_stats_request(
240 struct ofputil_flow_stats_request *, const struct ofp_header *);
241 struct ofpbuf *ofputil_encode_flow_stats_request(
242 const struct ofputil_flow_stats_request *, enum ofputil_protocol);
243 enum ofputil_protocol ofputil_flow_stats_request_usable_protocols(
244 const struct ofputil_flow_stats_request *);
246 /* Flow stats reply, independent of protocol. */
247 struct ofputil_flow_stats {
251 uint32_t duration_sec;
252 uint32_t duration_nsec;
254 uint16_t idle_timeout;
255 uint16_t hard_timeout;
256 int idle_age; /* Seconds since last packet, -1 if unknown. */
257 int hard_age; /* Seconds since last change, -1 if unknown. */
258 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
259 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
260 struct ofpact *ofpacts;
264 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
266 bool flow_age_extension,
267 struct ofpbuf *ofpacts);
268 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
269 struct list *replies);
271 /* Aggregate stats reply, independent of protocol. */
272 struct ofputil_aggregate_stats {
273 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
274 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
278 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
279 const struct ofputil_aggregate_stats *stats,
280 const struct ofp_header *request);
281 enum ofperr ofputil_decode_aggregate_stats_reply(
282 struct ofputil_aggregate_stats *,
283 const struct ofp_header *reply);
285 /* Flow removed message, independent of protocol. */
286 struct ofputil_flow_removed {
290 uint8_t reason; /* One of OFPRR_*. */
291 uint8_t table_id; /* 255 if message didn't include table ID. */
292 uint32_t duration_sec;
293 uint32_t duration_nsec;
294 uint16_t idle_timeout;
295 uint16_t hard_timeout;
296 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
297 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
300 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
301 const struct ofp_header *);
302 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
303 enum ofputil_protocol);
305 /* Abstract packet-in message. */
306 struct ofputil_packet_in {
310 enum ofp_packet_in_reason reason; /* One of OFPR_*. */
311 uint16_t controller_id; /* Controller ID to send to. */
317 uint16_t total_len; /* Full length of frame. */
319 struct flow_metadata fmd; /* Metadata at creation time. */
322 enum ofperr ofputil_decode_packet_in(struct ofputil_packet_in *,
323 const struct ofp_header *);
324 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
325 enum ofputil_protocol protocol,
326 enum nx_packet_in_format);
328 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason);
329 bool ofputil_packet_in_reason_from_string(const char *,
330 enum ofp_packet_in_reason *);
332 /* Abstract packet-out message.
334 * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
335 * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
336 struct ofputil_packet_out {
337 const void *packet; /* Packet data, if buffer_id == UINT32_MAX. */
338 size_t packet_len; /* Length of packet data in bytes. */
339 uint32_t buffer_id; /* Buffer id or UINT32_MAX if no buffer. */
340 uint16_t in_port; /* Packet's input port. */
341 struct ofpact *ofpacts; /* Actions. */
342 size_t ofpacts_len; /* Size of ofpacts in bytes. */
345 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
346 const struct ofp_header *,
347 struct ofpbuf *ofpacts);
348 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *,
349 enum ofputil_protocol protocol);
351 enum ofputil_port_config {
352 /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */
353 OFPUTIL_PC_PORT_DOWN = 1 << 0, /* Port is administratively down. */
354 OFPUTIL_PC_NO_RECV = 1 << 2, /* Drop all packets received by port. */
355 OFPUTIL_PC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */
356 OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */
357 /* OpenFlow 1.0 only. */
358 OFPUTIL_PC_NO_STP = 1 << 1, /* No 802.1D spanning tree for port. */
359 OFPUTIL_PC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */
360 OFPUTIL_PC_NO_FLOOD = 1 << 4, /* Do not include port when flooding. */
361 /* There are no OpenFlow 1.1-only bits. */
364 enum ofputil_port_state {
365 /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */
366 OFPUTIL_PS_LINK_DOWN = 1 << 0, /* No physical link present. */
367 /* OpenFlow 1.1 only. */
368 OFPUTIL_PS_BLOCKED = 1 << 1, /* Port is blocked */
369 OFPUTIL_PS_LIVE = 1 << 2, /* Live for Fast Failover Group. */
370 /* OpenFlow 1.0 only. */
371 OFPUTIL_PS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
372 OFPUTIL_PS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
373 OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
374 OFPUTIL_PS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
375 OFPUTIL_PS_STP_MASK = 3 << 8 /* Bit mask for OFPPS10_STP_* values. */
378 /* Abstract ofp10_phy_port or ofp11_port. */
379 struct ofputil_phy_port {
381 uint8_t hw_addr[OFP_ETH_ALEN];
382 char name[OFP_MAX_PORT_NAME_LEN];
383 enum ofputil_port_config config;
384 enum ofputil_port_state state;
386 /* NETDEV_F_* feature bitmasks. */
387 enum netdev_features curr; /* Current features. */
388 enum netdev_features advertised; /* Features advertised by the port. */
389 enum netdev_features supported; /* Features supported by the port. */
390 enum netdev_features peer; /* Features advertised by peer. */
393 uint32_t curr_speed; /* Current speed, in kbps. */
394 uint32_t max_speed; /* Maximum supported speed, in kbps. */
397 enum ofputil_capabilities {
398 /* OpenFlow 1.0, 1.1 and 1.2 share these values for these capabilities. */
399 OFPUTIL_C_FLOW_STATS = 1 << 0, /* Flow statistics. */
400 OFPUTIL_C_TABLE_STATS = 1 << 1, /* Table statistics. */
401 OFPUTIL_C_PORT_STATS = 1 << 2, /* Port statistics. */
402 OFPUTIL_C_IP_REASM = 1 << 5, /* Can reassemble IP fragments. */
403 OFPUTIL_C_QUEUE_STATS = 1 << 6, /* Queue statistics. */
405 /* OpenFlow 1.0 and 1.1 share this capability. */
406 OFPUTIL_C_ARP_MATCH_IP = 1 << 7, /* Match IP addresses in ARP pkts. */
408 /* OpenFlow 1.0 only. */
409 OFPUTIL_C_STP = 1 << 3, /* 802.1d spanning tree. */
411 /* OpenFlow 1.1 and 1.2 share this capability. */
412 OFPUTIL_C_GROUP_STATS = 1 << 4, /* Group statistics. */
414 /* OpenFlow 1.2 only */
415 OFPUTIL_C_PORT_BLOCKED = 1 << 8, /* Switch will block looping ports */
418 enum ofputil_action_bitmap {
419 OFPUTIL_A_OUTPUT = 1 << 0,
420 OFPUTIL_A_SET_VLAN_VID = 1 << 1,
421 OFPUTIL_A_SET_VLAN_PCP = 1 << 2,
422 OFPUTIL_A_STRIP_VLAN = 1 << 3,
423 OFPUTIL_A_SET_DL_SRC = 1 << 4,
424 OFPUTIL_A_SET_DL_DST = 1 << 5,
425 OFPUTIL_A_SET_NW_SRC = 1 << 6,
426 OFPUTIL_A_SET_NW_DST = 1 << 7,
427 OFPUTIL_A_SET_NW_ECN = 1 << 8,
428 OFPUTIL_A_SET_NW_TOS = 1 << 9,
429 OFPUTIL_A_SET_TP_SRC = 1 << 10,
430 OFPUTIL_A_SET_TP_DST = 1 << 11,
431 OFPUTIL_A_ENQUEUE = 1 << 12,
432 OFPUTIL_A_COPY_TTL_OUT = 1 << 13,
433 OFPUTIL_A_COPY_TTL_IN = 1 << 14,
434 OFPUTIL_A_SET_MPLS_LABEL = 1 << 15,
435 OFPUTIL_A_SET_MPLS_TC = 1 << 16,
436 OFPUTIL_A_SET_MPLS_TTL = 1 << 17,
437 OFPUTIL_A_DEC_MPLS_TTL = 1 << 18,
438 OFPUTIL_A_PUSH_VLAN = 1 << 19,
439 OFPUTIL_A_POP_VLAN = 1 << 20,
440 OFPUTIL_A_PUSH_MPLS = 1 << 21,
441 OFPUTIL_A_POP_MPLS = 1 << 22,
442 OFPUTIL_A_SET_QUEUE = 1 << 23,
443 OFPUTIL_A_GROUP = 1 << 24,
444 OFPUTIL_A_SET_NW_TTL = 1 << 25,
445 OFPUTIL_A_DEC_NW_TTL = 1 << 26,
446 OFPUTIL_A_SET_FIELD = 1 << 27,
449 /* Abstract ofp_switch_features. */
450 struct ofputil_switch_features {
451 uint64_t datapath_id; /* Datapath unique ID. */
452 uint32_t n_buffers; /* Max packets buffered at once. */
453 uint8_t n_tables; /* Number of tables supported by datapath. */
454 enum ofputil_capabilities capabilities;
455 enum ofputil_action_bitmap actions;
458 enum ofperr ofputil_decode_switch_features(const struct ofp_header *,
459 struct ofputil_switch_features *,
462 struct ofpbuf *ofputil_encode_switch_features(
463 const struct ofputil_switch_features *, enum ofputil_protocol,
465 void ofputil_put_switch_features_port(const struct ofputil_phy_port *,
467 bool ofputil_switch_features_ports_trunc(struct ofpbuf *b);
469 /* phy_port helper functions. */
470 int ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *,
471 struct ofputil_phy_port *);
472 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *);
474 /* Abstract ofp_port_status. */
475 struct ofputil_port_status {
476 enum ofp_port_reason reason;
477 struct ofputil_phy_port desc;
480 enum ofperr ofputil_decode_port_status(const struct ofp_header *,
481 struct ofputil_port_status *);
482 struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *,
483 enum ofputil_protocol);
485 /* Abstract ofp_port_mod. */
486 struct ofputil_port_mod {
488 uint8_t hw_addr[OFP_ETH_ALEN];
489 enum ofputil_port_config config;
490 enum ofputil_port_config mask;
491 enum netdev_features advertise;
494 enum ofperr ofputil_decode_port_mod(const struct ofp_header *,
495 struct ofputil_port_mod *);
496 struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
497 enum ofputil_protocol);
499 /* Abstract table stats.
501 * For now we use ofp12_table_stats as a superset of the other protocol
502 * versions' table stats. */
504 struct ofpbuf *ofputil_encode_table_stats_reply(
505 const struct ofp12_table_stats[], int n,
506 const struct ofp_header *request);
508 /* Abstract nx_flow_monitor_request. */
509 struct ofputil_flow_monitor_request {
511 enum nx_flow_monitor_flags flags;
517 int ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *,
519 void ofputil_append_flow_monitor_request(
520 const struct ofputil_flow_monitor_request *, struct ofpbuf *msg);
522 /* Abstract nx_flow_update. */
523 struct ofputil_flow_update {
524 enum nx_flow_update_event event;
526 /* Used only for NXFME_ADDED, NXFME_DELETED, NXFME_MODIFIED. */
527 enum ofp_flow_removed_reason reason;
528 uint16_t idle_timeout;
529 uint16_t hard_timeout;
534 struct ofpact *ofpacts;
537 /* Used only for NXFME_ABBREV. */
541 int ofputil_decode_flow_update(struct ofputil_flow_update *,
542 struct ofpbuf *msg, struct ofpbuf *ofpacts);
543 void ofputil_start_flow_update(struct list *replies);
544 void ofputil_append_flow_update(const struct ofputil_flow_update *,
545 struct list *replies);
547 /* Abstract nx_flow_monitor_cancel. */
548 uint32_t ofputil_decode_flow_monitor_cancel(const struct ofp_header *);
549 struct ofpbuf *ofputil_encode_flow_monitor_cancel(uint32_t id);
551 /* Encoding OpenFlow stats messages. */
552 void ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
553 const struct ofputil_phy_port *pp,
554 struct list *replies);
556 /* Encoding simple OpenFlow messages. */
557 struct ofpbuf *make_echo_request(enum ofp_version);
558 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
560 struct ofpbuf *ofputil_encode_barrier_request(enum ofp_version);
562 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
563 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
568 /* The type of an action.
570 * For each implemented OFPAT10_* and NXAST_* action type, there is a
571 * corresponding constant prefixed with OFPUTIL_, e.g.:
573 * OFPUTIL_OFPAT10_OUTPUT
574 * OFPUTIL_OFPAT10_SET_VLAN_VID
575 * OFPUTIL_OFPAT10_SET_VLAN_PCP
576 * OFPUTIL_OFPAT10_STRIP_VLAN
577 * OFPUTIL_OFPAT10_SET_DL_SRC
578 * OFPUTIL_OFPAT10_SET_DL_DST
579 * OFPUTIL_OFPAT10_SET_NW_SRC
580 * OFPUTIL_OFPAT10_SET_NW_DST
581 * OFPUTIL_OFPAT10_SET_NW_TOS
582 * OFPUTIL_OFPAT10_SET_TP_SRC
583 * OFPUTIL_OFPAT10_SET_TP_DST
584 * OFPUTIL_OFPAT10_ENQUEUE
585 * OFPUTIL_NXAST_RESUBMIT
586 * OFPUTIL_NXAST_SET_TUNNEL
587 * OFPUTIL_NXAST_SET_METADATA
588 * OFPUTIL_NXAST_SET_QUEUE
589 * OFPUTIL_NXAST_POP_QUEUE
590 * OFPUTIL_NXAST_REG_MOVE
591 * OFPUTIL_NXAST_REG_LOAD
593 * OFPUTIL_NXAST_SET_TUNNEL64
594 * OFPUTIL_NXAST_MULTIPATH
595 * OFPUTIL_NXAST_AUTOPATH
596 * OFPUTIL_NXAST_BUNDLE
597 * OFPUTIL_NXAST_BUNDLE_LOAD
598 * OFPUTIL_NXAST_RESUBMIT_TABLE
599 * OFPUTIL_NXAST_OUTPUT_REG
600 * OFPUTIL_NXAST_LEARN
601 * OFPUTIL_NXAST_DEC_TTL
602 * OFPUTIL_NXAST_FIN_TIMEOUT
604 * (The above list helps developers who want to "grep" for these definitions.)
606 enum OVS_PACKED_ENUM ofputil_action_code {
607 OFPUTIL_ACTION_INVALID,
608 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM,
609 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
610 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
611 #include "ofp-util.def"
614 /* The number of values of "enum ofputil_action_code". */
616 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) + 1
617 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
618 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
619 OFPUTIL_N_ACTIONS = 1
620 #include "ofp-util.def"
623 int ofputil_action_code_from_name(const char *);
625 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
627 /* For each OpenFlow action <ENUM> that has a corresponding action structure
628 * struct <STRUCT>, this defines two functions:
630 * void ofputil_init_<ENUM>(struct <STRUCT> *action);
632 * Initializes the parts of 'action' that identify it as having type <ENUM>
633 * and length 'sizeof *action' and zeros the rest. For actions that have
634 * variable length, the length used and cleared is that of struct <STRUCT>.
636 * struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
638 * Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
639 * initializes it with ofputil_init_<ENUM>(), and returns it.
641 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
642 void ofputil_init_##ENUM(struct STRUCT *); \
643 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
644 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
645 void ofputil_init_##ENUM(struct STRUCT *); \
646 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
647 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
648 void ofputil_init_##ENUM(struct STRUCT *); \
649 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
650 #include "ofp-util.def"
652 #define OFP_ACTION_ALIGN 8 /* Alignment of ofp_actions. */
654 enum ofperr validate_actions(const union ofp_action *, size_t n_actions,
655 const struct flow *, int max_ports);
656 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
658 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
659 union ofp_action **, size_t *);
661 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
662 const union ofp_action *b, size_t n_b);
663 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
665 /* Handy utility for parsing flows and actions. */
666 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
668 struct ofpbuf *ofputlil_dump_ports(enum ofp_version ofp_version, int16_t port);
670 struct ofputil_port_stats {
672 struct netdev_stats stats;
675 struct ofpbuf *ofputil_encode_dump_ports_request(enum ofp_version ofp_version,
677 void ofputil_append_port_stat(struct list *replies,
678 const struct ofputil_port_stats *ops);
679 size_t ofputil_count_port_stats(const struct ofp_header *);
680 int ofputil_decode_port_stats(struct ofputil_port_stats *, struct ofpbuf *msg);
681 enum ofperr ofputil_decode_port_stats_request(const struct ofp_header *request,
682 uint16_t *ofp10_port);
684 struct ofputil_queue_stats_request {
690 ofputil_decode_queue_stats_request(const struct ofp_header *request,
691 struct ofputil_queue_stats_request *oqsr);
693 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
694 const struct ofputil_queue_stats_request *oqsr);
696 struct ofputil_queue_stats {
699 struct netdev_queue_stats stats;
702 size_t ofputil_count_queue_stats(const struct ofp_header *);
703 int ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg);
704 void ofputil_append_queue_stat(struct list *replies,
705 const struct ofputil_queue_stats *oqs);
707 #endif /* ofp-util.h */