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"
28 #include "openflow/nicira-ext.h"
29 #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 *port);
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 * These are arranged from most portable to least portable, or alternatively
50 * from least powerful to most powerful. Formats earlier on the list are more
51 * likely to be understood for the purpose of making requests, but formats
52 * later on the list are more likely to accurately describe a flow within a
55 * On any given OpenFlow connection, a single protocol is in effect at any
56 * given time. These values use separate bits only because that makes it easy
57 * to test whether a particular protocol is within a given set of protocols and
58 * to implement set union and intersection.
60 enum ofputil_protocol {
61 /* OpenFlow 1.0-based protocols. */
62 OFPUTIL_P_OF10 = 1 << 0, /* OpenFlow 1.0 flow format. */
63 OFPUTIL_P_OF10_TID = 1 << 1, /* OF1.0 + flow_mod_table_id extension. */
64 #define OFPUTIL_P_OF10_ANY (OFPUTIL_P_OF10 | OFPUTIL_P_OF10_TID)
66 /* OpenFlow 1.0 with NXM-based flow formats. */
67 OFPUTIL_P_NXM = 1 << 2, /* Nicira extended match. */
68 OFPUTIL_P_NXM_TID = 1 << 3, /* NXM + flow_mod_table_id extension. */
69 #define OFPUTIL_P_NXM_ANY (OFPUTIL_P_NXM | OFPUTIL_P_NXM_TID)
72 OFPUTIL_P_OF12 = 1 << 4, /* OpenFlow 1.2 flow format. */
75 #define OFPUTIL_P_ANY (OFPUTIL_P_OF10_ANY | OFPUTIL_P_NXM_ANY)
77 /* Protocols in which a specific table may be specified in flow_mods. */
78 #define OFPUTIL_P_TID (OFPUTIL_P_OF10_TID | OFPUTIL_P_NXM_TID)
81 /* Protocols to use for flow dumps, from most to least preferred. */
82 extern enum ofputil_protocol ofputil_flow_dump_protocols[];
83 extern size_t ofputil_n_flow_dump_protocols;
86 ofputil_protocol_from_ofp_version(enum ofp_version version);
87 enum ofp_version ofputil_protocol_to_ofp_version(enum ofputil_protocol);
89 bool ofputil_protocol_is_valid(enum ofputil_protocol);
90 enum ofputil_protocol ofputil_protocol_set_tid(enum ofputil_protocol,
92 enum ofputil_protocol ofputil_protocol_to_base(enum ofputil_protocol);
93 enum ofputil_protocol ofputil_protocol_set_base(
94 enum ofputil_protocol cur, enum ofputil_protocol new_base);
96 const char *ofputil_protocol_to_string(enum ofputil_protocol);
97 char *ofputil_protocols_to_string(enum ofputil_protocol);
98 enum ofputil_protocol ofputil_protocols_from_string(const char *);
99 enum ofputil_protocol ofputil_usable_protocols(const struct cls_rule *);
101 struct ofpbuf *ofputil_encode_set_protocol(enum ofputil_protocol current,
102 enum ofputil_protocol want,
103 enum ofputil_protocol *next);
106 struct ofpbuf *ofputil_encode_nx_set_flow_format(enum nx_flow_format);
107 enum ofputil_protocol ofputil_nx_flow_format_to_protocol(enum nx_flow_format);
108 bool ofputil_nx_flow_format_is_valid(enum nx_flow_format);
109 const char *ofputil_nx_flow_format_to_string(enum nx_flow_format);
111 /* Work with ofp10_match. */
112 void ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *);
113 void ofputil_cls_rule_from_ofp10_match(const struct ofp10_match *,
114 unsigned int priority,
116 void ofputil_normalize_rule(struct cls_rule *);
117 void ofputil_normalize_rule_quiet(struct cls_rule *);
118 void ofputil_cls_rule_to_ofp10_match(const struct cls_rule *,
119 struct ofp10_match *);
121 /* Work with ofp11_match. */
122 enum ofperr ofputil_pull_ofp11_match(struct ofpbuf *, unsigned int priority,
124 uint16_t *padded_match_len);
125 enum ofperr ofputil_cls_rule_from_ofp11_match(const struct ofp11_match *,
126 unsigned int priority,
128 void ofputil_cls_rule_to_ofp11_match(const struct cls_rule *,
129 struct ofp11_match *);
131 /* dl_type translation between OpenFlow and 'struct flow' format. */
132 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
133 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
136 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
137 int ofputil_packet_in_format_from_string(const char *);
138 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
139 struct ofpbuf *ofputil_make_set_packet_in_format(enum nx_packet_in_format);
141 /* NXT_FLOW_MOD_TABLE_ID extension. */
142 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
144 /* Protocol-independent flow_mod.
146 * The handling of cookies across multiple versions of OpenFlow is a bit
147 * confusing. A full description of Open vSwitch's cookie handling is
148 * in the DESIGN file. The following table shows the expected values of
149 * the cookie-related fields for the different flow_mod commands in
150 * OpenFlow 1.0 ("OF10") and NXM. "<used>" and "-" indicate a value
151 * that may be populated and an ignored field, respectively.
153 * cookie cookie_mask new_cookie
154 * ====== =========== ==========
155 * OF10 Add - 0 <used>
156 * OF10 Modify - 0 <used>
159 * NXM Modify <used> <used> <used>
160 * NXM Delete <used> <used> -
162 struct ofputil_flow_mod {
164 ovs_be64 cookie; /* Cookie bits to match. */
165 ovs_be64 cookie_mask; /* 1-bit in each 'cookie' bit to match. */
166 ovs_be64 new_cookie; /* New cookie to install or -1. */
169 uint16_t idle_timeout;
170 uint16_t hard_timeout;
174 struct ofpact *ofpacts; /* Series of "struct ofpact"s. */
175 size_t ofpacts_len; /* Length of ofpacts, in bytes. */
178 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
179 const struct ofp_header *,
180 enum ofputil_protocol,
181 struct ofpbuf *ofpacts);
182 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
183 enum ofputil_protocol);
185 enum ofputil_protocol ofputil_flow_mod_usable_protocols(
186 const struct ofputil_flow_mod *fms, size_t n_fms);
188 /* Flow stats or aggregate stats request, independent of protocol. */
189 struct ofputil_flow_stats_request {
190 bool aggregate; /* Aggregate results? */
191 struct cls_rule match;
193 ovs_be64 cookie_mask;
198 enum ofperr ofputil_decode_flow_stats_request(
199 struct ofputil_flow_stats_request *, const struct ofp_header *);
200 struct ofpbuf *ofputil_encode_flow_stats_request(
201 const struct ofputil_flow_stats_request *, enum ofputil_protocol);
202 enum ofputil_protocol ofputil_flow_stats_request_usable_protocols(
203 const struct ofputil_flow_stats_request *);
205 /* Flow stats reply, independent of protocol. */
206 struct ofputil_flow_stats {
207 struct cls_rule rule;
210 uint32_t duration_sec;
211 uint32_t duration_nsec;
212 uint16_t idle_timeout;
213 uint16_t hard_timeout;
214 int idle_age; /* Seconds since last packet, -1 if unknown. */
215 int hard_age; /* Seconds since last change, -1 if unknown. */
216 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
217 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
218 struct ofpact *ofpacts;
222 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
224 bool flow_age_extension,
225 struct ofpbuf *ofpacts);
226 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
227 struct list *replies);
229 /* Aggregate stats reply, independent of protocol. */
230 struct ofputil_aggregate_stats {
231 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
232 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
236 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
237 const struct ofputil_aggregate_stats *stats,
238 const struct ofp_header *request);
239 enum ofperr ofputil_decode_aggregate_stats_reply(
240 struct ofputil_aggregate_stats *,
241 const struct ofp_header *reply);
243 /* Flow removed message, independent of protocol. */
244 struct ofputil_flow_removed {
245 struct cls_rule rule;
247 uint8_t reason; /* One of OFPRR_*. */
248 uint32_t duration_sec;
249 uint32_t duration_nsec;
250 uint16_t idle_timeout;
251 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
252 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
255 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
256 const struct ofp_header *);
257 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
258 enum ofputil_protocol);
260 /* Abstract packet-in message. */
261 struct ofputil_packet_in {
265 enum ofp_packet_in_reason reason; /* One of OFPR_*. */
266 uint16_t controller_id; /* Controller ID to send to. */
272 uint16_t total_len; /* Full length of frame. */
274 struct flow_metadata fmd; /* Metadata at creation time. */
277 enum ofperr ofputil_decode_packet_in(struct ofputil_packet_in *,
278 const struct ofp_header *);
279 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
280 enum nx_packet_in_format);
282 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason);
283 bool ofputil_packet_in_reason_from_string(const char *,
284 enum ofp_packet_in_reason *);
286 /* Abstract packet-out message.
288 * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
289 * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
290 struct ofputil_packet_out {
291 const void *packet; /* Packet data, if buffer_id == UINT32_MAX. */
292 size_t packet_len; /* Length of packet data in bytes. */
293 uint32_t buffer_id; /* Buffer id or UINT32_MAX if no buffer. */
294 uint16_t in_port; /* Packet's input port. */
295 struct ofpact *ofpacts; /* Actions. */
296 size_t ofpacts_len; /* Size of ofpacts in bytes. */
299 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
300 const struct ofp_header *,
301 struct ofpbuf *ofpacts);
302 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *);
304 enum ofputil_port_config {
305 /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */
306 OFPUTIL_PC_PORT_DOWN = 1 << 0, /* Port is administratively down. */
307 OFPUTIL_PC_NO_RECV = 1 << 2, /* Drop all packets received by port. */
308 OFPUTIL_PC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */
309 OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */
310 /* OpenFlow 1.0 only. */
311 OFPUTIL_PC_NO_STP = 1 << 1, /* No 802.1D spanning tree for port. */
312 OFPUTIL_PC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */
313 OFPUTIL_PC_NO_FLOOD = 1 << 4, /* Do not include port when flooding. */
314 /* There are no OpenFlow 1.1-only bits. */
317 enum ofputil_port_state {
318 /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */
319 OFPUTIL_PS_LINK_DOWN = 1 << 0, /* No physical link present. */
320 /* OpenFlow 1.1 only. */
321 OFPUTIL_PS_BLOCKED = 1 << 1, /* Port is blocked */
322 OFPUTIL_PS_LIVE = 1 << 2, /* Live for Fast Failover Group. */
323 /* OpenFlow 1.0 only. */
324 OFPUTIL_PS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
325 OFPUTIL_PS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
326 OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
327 OFPUTIL_PS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
328 OFPUTIL_PS_STP_MASK = 3 << 8 /* Bit mask for OFPPS10_STP_* values. */
331 /* Abstract ofp10_phy_port or ofp11_port. */
332 struct ofputil_phy_port {
334 uint8_t hw_addr[OFP_ETH_ALEN];
335 char name[OFP_MAX_PORT_NAME_LEN];
336 enum ofputil_port_config config;
337 enum ofputil_port_state state;
339 /* NETDEV_F_* feature bitmasks. */
340 enum netdev_features curr; /* Current features. */
341 enum netdev_features advertised; /* Features advertised by the port. */
342 enum netdev_features supported; /* Features supported by the port. */
343 enum netdev_features peer; /* Features advertised by peer. */
346 uint32_t curr_speed; /* Current speed, in kbps. */
347 uint32_t max_speed; /* Maximum supported speed, in kbps. */
350 enum ofputil_capabilities {
351 /* OpenFlow 1.0, 1.1 and 1.2 share these values for these capabilities. */
352 OFPUTIL_C_FLOW_STATS = 1 << 0, /* Flow statistics. */
353 OFPUTIL_C_TABLE_STATS = 1 << 1, /* Table statistics. */
354 OFPUTIL_C_PORT_STATS = 1 << 2, /* Port statistics. */
355 OFPUTIL_C_IP_REASM = 1 << 5, /* Can reassemble IP fragments. */
356 OFPUTIL_C_QUEUE_STATS = 1 << 6, /* Queue statistics. */
358 /* OpenFlow 1.0 and 1.1 share this capability. */
359 OFPUTIL_C_ARP_MATCH_IP = 1 << 7, /* Match IP addresses in ARP pkts. */
361 /* OpenFlow 1.0 only. */
362 OFPUTIL_C_STP = 1 << 3, /* 802.1d spanning tree. */
364 /* OpenFlow 1.1 and 1.2 share this capability. */
365 OFPUTIL_C_GROUP_STATS = 1 << 4, /* Group statistics. */
367 /* OpenFlow 1.2 only */
368 OFPUTIL_C_PORT_BLOCKED = 1 << 8, /* Switch will block looping ports */
371 enum ofputil_action_bitmap {
372 OFPUTIL_A_OUTPUT = 1 << 0,
373 OFPUTIL_A_SET_VLAN_VID = 1 << 1,
374 OFPUTIL_A_SET_VLAN_PCP = 1 << 2,
375 OFPUTIL_A_STRIP_VLAN = 1 << 3,
376 OFPUTIL_A_SET_DL_SRC = 1 << 4,
377 OFPUTIL_A_SET_DL_DST = 1 << 5,
378 OFPUTIL_A_SET_NW_SRC = 1 << 6,
379 OFPUTIL_A_SET_NW_DST = 1 << 7,
380 OFPUTIL_A_SET_NW_ECN = 1 << 8,
381 OFPUTIL_A_SET_NW_TOS = 1 << 9,
382 OFPUTIL_A_SET_TP_SRC = 1 << 10,
383 OFPUTIL_A_SET_TP_DST = 1 << 11,
384 OFPUTIL_A_ENQUEUE = 1 << 12,
385 OFPUTIL_A_COPY_TTL_OUT = 1 << 13,
386 OFPUTIL_A_COPY_TTL_IN = 1 << 14,
387 OFPUTIL_A_SET_MPLS_LABEL = 1 << 15,
388 OFPUTIL_A_SET_MPLS_TC = 1 << 16,
389 OFPUTIL_A_SET_MPLS_TTL = 1 << 17,
390 OFPUTIL_A_DEC_MPLS_TTL = 1 << 18,
391 OFPUTIL_A_PUSH_VLAN = 1 << 19,
392 OFPUTIL_A_POP_VLAN = 1 << 20,
393 OFPUTIL_A_PUSH_MPLS = 1 << 21,
394 OFPUTIL_A_POP_MPLS = 1 << 22,
395 OFPUTIL_A_SET_QUEUE = 1 << 23,
396 OFPUTIL_A_GROUP = 1 << 24,
397 OFPUTIL_A_SET_NW_TTL = 1 << 25,
398 OFPUTIL_A_DEC_NW_TTL = 1 << 26,
401 /* Abstract ofp_switch_features. */
402 struct ofputil_switch_features {
403 uint64_t datapath_id; /* Datapath unique ID. */
404 uint32_t n_buffers; /* Max packets buffered at once. */
405 uint8_t n_tables; /* Number of tables supported by datapath. */
406 enum ofputil_capabilities capabilities;
407 enum ofputil_action_bitmap actions;
410 enum ofperr ofputil_decode_switch_features(const struct ofp_header *,
411 struct ofputil_switch_features *,
414 struct ofpbuf *ofputil_encode_switch_features(
415 const struct ofputil_switch_features *, enum ofputil_protocol,
417 void ofputil_put_switch_features_port(const struct ofputil_phy_port *,
419 bool ofputil_switch_features_ports_trunc(struct ofpbuf *b);
421 /* phy_port helper functions. */
422 int ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *,
423 struct ofputil_phy_port *);
424 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *);
426 /* Abstract ofp_port_status. */
427 struct ofputil_port_status {
428 enum ofp_port_reason reason;
429 struct ofputil_phy_port desc;
432 enum ofperr ofputil_decode_port_status(const struct ofp_header *,
433 struct ofputil_port_status *);
434 struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *,
435 enum ofputil_protocol);
437 /* Abstract ofp_port_mod. */
438 struct ofputil_port_mod {
440 uint8_t hw_addr[OFP_ETH_ALEN];
441 enum ofputil_port_config config;
442 enum ofputil_port_config mask;
443 enum netdev_features advertise;
446 enum ofperr ofputil_decode_port_mod(const struct ofp_header *,
447 struct ofputil_port_mod *);
448 struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
449 enum ofputil_protocol);
451 /* Abstract nx_flow_monitor_request. */
452 struct ofputil_flow_monitor_request {
454 enum nx_flow_monitor_flags flags;
457 struct cls_rule match;
460 int ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *,
462 void ofputil_append_flow_monitor_request(
463 const struct ofputil_flow_monitor_request *, struct ofpbuf *msg);
465 /* Abstract nx_flow_update. */
466 struct ofputil_flow_update {
467 enum nx_flow_update_event event;
469 /* Used only for NXFME_ADDED, NXFME_DELETED, NXFME_MODIFIED. */
470 enum ofp_flow_removed_reason reason;
471 uint16_t idle_timeout;
472 uint16_t hard_timeout;
475 struct cls_rule *match;
476 struct ofpact *ofpacts;
479 /* Used only for NXFME_ABBREV. */
483 int ofputil_decode_flow_update(struct ofputil_flow_update *,
484 struct ofpbuf *msg, struct ofpbuf *ofpacts);
485 void ofputil_start_flow_update(struct list *replies);
486 void ofputil_append_flow_update(const struct ofputil_flow_update *,
487 struct list *replies);
489 /* Abstract nx_flow_monitor_cancel. */
490 uint32_t ofputil_decode_flow_monitor_cancel(const struct ofp_header *);
491 struct ofpbuf *ofputil_encode_flow_monitor_cancel(uint32_t id);
493 /* Encoding OpenFlow stats messages. */
494 void ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
495 const struct ofputil_phy_port *pp,
496 struct list *replies);
498 /* Encoding simple OpenFlow messages. */
499 struct ofpbuf *make_echo_request(enum ofp_version);
500 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
502 struct ofpbuf *ofputil_encode_barrier_request(enum ofp_version);
504 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
505 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
510 /* The type of an action.
512 * For each implemented OFPAT10_* and NXAST_* action type, there is a
513 * corresponding constant prefixed with OFPUTIL_, e.g.:
515 * OFPUTIL_OFPAT10_OUTPUT
516 * OFPUTIL_OFPAT10_SET_VLAN_VID
517 * OFPUTIL_OFPAT10_SET_VLAN_PCP
518 * OFPUTIL_OFPAT10_STRIP_VLAN
519 * OFPUTIL_OFPAT10_SET_DL_SRC
520 * OFPUTIL_OFPAT10_SET_DL_DST
521 * OFPUTIL_OFPAT10_SET_NW_SRC
522 * OFPUTIL_OFPAT10_SET_NW_DST
523 * OFPUTIL_OFPAT10_SET_NW_TOS
524 * OFPUTIL_OFPAT10_SET_TP_SRC
525 * OFPUTIL_OFPAT10_SET_TP_DST
526 * OFPUTIL_OFPAT10_ENQUEUE
527 * OFPUTIL_NXAST_RESUBMIT
528 * OFPUTIL_NXAST_SET_TUNNEL
529 * OFPUTIL_NXAST_SET_QUEUE
530 * OFPUTIL_NXAST_POP_QUEUE
531 * OFPUTIL_NXAST_REG_MOVE
532 * OFPUTIL_NXAST_REG_LOAD
534 * OFPUTIL_NXAST_SET_TUNNEL64
535 * OFPUTIL_NXAST_MULTIPATH
536 * OFPUTIL_NXAST_AUTOPATH
537 * OFPUTIL_NXAST_BUNDLE
538 * OFPUTIL_NXAST_BUNDLE_LOAD
539 * OFPUTIL_NXAST_RESUBMIT_TABLE
540 * OFPUTIL_NXAST_OUTPUT_REG
541 * OFPUTIL_NXAST_LEARN
542 * OFPUTIL_NXAST_DEC_TTL
543 * OFPUTIL_NXAST_FIN_TIMEOUT
545 * (The above list helps developers who want to "grep" for these definitions.)
547 enum OVS_PACKED_ENUM ofputil_action_code {
548 OFPUTIL_ACTION_INVALID,
549 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM,
550 #define OFPAT11_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM,
551 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
552 #include "ofp-util.def"
555 /* The number of values of "enum ofputil_action_code". */
557 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) + 1
558 #define OFPAT11_ACTION(ENUM, STRUCT, NAME) + 1
559 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
560 OFPUTIL_N_ACTIONS = 1
561 #include "ofp-util.def"
564 int ofputil_action_code_from_name(const char *);
566 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
568 /* For each OpenFlow action <ENUM> that has a corresponding action structure
569 * struct <STRUCT>, this defines two functions:
571 * void ofputil_init_<ENUM>(struct <STRUCT> *action);
573 * Initializes the parts of 'action' that identify it as having type <ENUM>
574 * and length 'sizeof *action' and zeros the rest. For actions that have
575 * variable length, the length used and cleared is that of struct <STRUCT>.
577 * struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
579 * Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
580 * initializes it with ofputil_init_<ENUM>(), and returns it.
582 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
583 void ofputil_init_##ENUM(struct STRUCT *); \
584 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
585 #define OFPAT11_ACTION(ENUM, STRUCT, NAME) \
586 void ofputil_init_##ENUM(struct STRUCT *); \
587 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
588 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
589 void ofputil_init_##ENUM(struct STRUCT *); \
590 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
591 #include "ofp-util.def"
593 #define OFP_ACTION_ALIGN 8 /* Alignment of ofp_actions. */
595 enum ofperr validate_actions(const union ofp_action *, size_t n_actions,
596 const struct flow *, int max_ports);
597 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
599 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
600 union ofp_action **, size_t *);
602 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
603 const union ofp_action *b, size_t n_b);
604 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
606 /* Handy utility for parsing flows and actions. */
607 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
609 #endif /* ofp-util.h */