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"
27 #include "openflow/nicira-ext.h"
28 #include "openvswitch/types.h"
33 /* Basic decoding and length validation of OpenFlow messages. */
34 enum ofputil_msg_code {
37 /* OFPT_* messages. */
40 OFPUTIL_OFPT_ECHO_REQUEST,
41 OFPUTIL_OFPT_ECHO_REPLY,
42 OFPUTIL_OFPT_FEATURES_REQUEST,
43 OFPUTIL_OFPT_FEATURES_REPLY,
44 OFPUTIL_OFPT_GET_CONFIG_REQUEST,
45 OFPUTIL_OFPT_GET_CONFIG_REPLY,
46 OFPUTIL_OFPT_SET_CONFIG,
47 OFPUTIL_OFPT_PACKET_IN,
48 OFPUTIL_OFPT_FLOW_REMOVED,
49 OFPUTIL_OFPT_PORT_STATUS,
50 OFPUTIL_OFPT_PACKET_OUT,
51 OFPUTIL_OFPT_FLOW_MOD,
52 OFPUTIL_OFPT_PORT_MOD,
53 OFPUTIL_OFPT_BARRIER_REQUEST,
54 OFPUTIL_OFPT_BARRIER_REPLY,
55 OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST,
56 OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY,
58 /* OFPST_* stat requests. */
59 OFPUTIL_OFPST_DESC_REQUEST,
60 OFPUTIL_OFPST_FLOW_REQUEST,
61 OFPUTIL_OFPST_AGGREGATE_REQUEST,
62 OFPUTIL_OFPST_TABLE_REQUEST,
63 OFPUTIL_OFPST_PORT_REQUEST,
64 OFPUTIL_OFPST_QUEUE_REQUEST,
65 OFPUTIL_OFPST_PORT_DESC_REQUEST,
67 /* OFPST_* stat replies. */
68 OFPUTIL_OFPST_DESC_REPLY,
69 OFPUTIL_OFPST_FLOW_REPLY,
70 OFPUTIL_OFPST_QUEUE_REPLY,
71 OFPUTIL_OFPST_PORT_REPLY,
72 OFPUTIL_OFPST_TABLE_REPLY,
73 OFPUTIL_OFPST_AGGREGATE_REPLY,
74 OFPUTIL_OFPST_PORT_DESC_REPLY,
77 OFPUTIL_NXT_ROLE_REQUEST,
78 OFPUTIL_NXT_ROLE_REPLY,
79 OFPUTIL_NXT_SET_FLOW_FORMAT,
80 OFPUTIL_NXT_FLOW_MOD_TABLE_ID,
82 OFPUTIL_NXT_FLOW_REMOVED,
83 OFPUTIL_NXT_SET_PACKET_IN_FORMAT,
84 OFPUTIL_NXT_PACKET_IN,
86 OFPUTIL_NXT_SET_ASYNC_CONFIG,
87 OFPUTIL_NXT_SET_CONTROLLER_ID,
89 /* NXST_* stat requests. */
90 OFPUTIL_NXST_FLOW_REQUEST,
91 OFPUTIL_NXST_AGGREGATE_REQUEST,
93 /* NXST_* stat replies. */
94 OFPUTIL_NXST_FLOW_REPLY,
95 OFPUTIL_NXST_AGGREGATE_REPLY
98 struct ofputil_msg_type;
99 enum ofperr ofputil_decode_msg_type(const struct ofp_header *,
100 const struct ofputil_msg_type **);
101 enum ofperr ofputil_decode_msg_type_partial(const struct ofp_header *,
103 const struct ofputil_msg_type **);
104 enum ofputil_msg_code ofputil_msg_type_code(const struct ofputil_msg_type *);
105 const char *ofputil_msg_type_name(const struct ofputil_msg_type *);
108 enum ofperr ofputil_port_from_ofp11(ovs_be32 ofp11_port, uint16_t *ofp10_port);
109 ovs_be32 ofputil_port_to_ofp11(uint16_t ofp10_port);
111 enum ofperr ofputil_check_output_port(uint16_t ofp_port, int max_ports);
112 bool ofputil_port_from_string(const char *, uint16_t *port);
113 void ofputil_format_port(uint16_t port, struct ds *);
115 /* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to
116 * and from IP bitmasks. */
117 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
118 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
122 * These are arranged from most portable to least portable, or alternatively
123 * from least powerful to most powerful. Formats earlier on the list are more
124 * likely to be understood for the purpose of making requests, but formats
125 * later on the list are more likely to accurately describe a flow within a
128 * On any given OpenFlow connection, a single protocol is in effect at any
129 * given time. These values use separate bits only because that makes it easy
130 * to test whether a particular protocol is within a given set of protocols and
131 * to implement set union and intersection.
133 enum ofputil_protocol {
134 /* OpenFlow 1.0-based protocols. */
135 OFPUTIL_P_OF10 = 1 << 0, /* OpenFlow 1.0 flow format. */
136 OFPUTIL_P_OF10_TID = 1 << 1, /* OF1.0 + flow_mod_table_id extension. */
137 #define OFPUTIL_P_OF10_ANY (OFPUTIL_P_OF10 | OFPUTIL_P_OF10_TID)
139 /* OpenFlow 1.0 with NXM-based flow formats. */
140 OFPUTIL_P_NXM = 1 << 2, /* Nicira extended match. */
141 OFPUTIL_P_NXM_TID = 1 << 3, /* NXM + flow_mod_table_id extension. */
142 #define OFPUTIL_P_NXM_ANY (OFPUTIL_P_NXM | OFPUTIL_P_NXM_TID)
145 #define OFPUTIL_P_ANY (OFPUTIL_P_OF10_ANY | OFPUTIL_P_NXM_ANY)
147 /* Protocols in which a specific table may be specified in flow_mods. */
148 #define OFPUTIL_P_TID (OFPUTIL_P_OF10_TID | OFPUTIL_P_NXM_TID)
151 /* Protocols to use for flow dumps, from most to least preferred. */
152 extern enum ofputil_protocol ofputil_flow_dump_protocols[];
153 extern size_t ofputil_n_flow_dump_protocols;
155 enum ofputil_protocol ofputil_protocol_from_ofp_version(int version);
156 uint8_t ofputil_protocol_to_ofp_version(enum ofputil_protocol);
158 bool ofputil_protocol_is_valid(enum ofputil_protocol);
159 enum ofputil_protocol ofputil_protocol_set_tid(enum ofputil_protocol,
161 enum ofputil_protocol ofputil_protocol_to_base(enum ofputil_protocol);
162 enum ofputil_protocol ofputil_protocol_set_base(
163 enum ofputil_protocol cur, enum ofputil_protocol new_base);
165 const char *ofputil_protocol_to_string(enum ofputil_protocol);
166 char *ofputil_protocols_to_string(enum ofputil_protocol);
167 enum ofputil_protocol ofputil_protocols_from_string(const char *);
168 enum ofputil_protocol ofputil_usable_protocols(const struct cls_rule *);
170 struct ofpbuf *ofputil_encode_set_protocol(enum ofputil_protocol current,
171 enum ofputil_protocol want,
172 enum ofputil_protocol *next);
175 struct ofpbuf *ofputil_encode_nx_set_flow_format(enum nx_flow_format);
176 enum ofputil_protocol ofputil_nx_flow_format_to_protocol(enum nx_flow_format);
177 bool ofputil_nx_flow_format_is_valid(enum nx_flow_format);
178 const char *ofputil_nx_flow_format_to_string(enum nx_flow_format);
180 /* Work with OpenFlow 1.0 ofp_match. */
181 void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *);
182 void ofputil_cls_rule_from_match(const struct ofp_match *,
183 unsigned int priority, struct cls_rule *);
184 void ofputil_normalize_rule(struct cls_rule *);
185 void ofputil_cls_rule_to_match(const struct cls_rule *, struct ofp_match *);
187 /* dl_type translation between OpenFlow and 'struct flow' format. */
188 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
189 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
192 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
193 int ofputil_packet_in_format_from_string(const char *);
194 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
195 struct ofpbuf *ofputil_make_set_packet_in_format(enum nx_packet_in_format);
197 /* NXT_FLOW_MOD_TABLE_ID extension. */
198 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
200 /* Protocol-independent flow_mod.
202 * The handling of cookies across multiple versions of OpenFlow is a bit
203 * confusing. A full description of Open vSwitch's cookie handling is
204 * in the DESIGN file. The following table shows the expected values of
205 * the cookie-related fields for the different flow_mod commands in
206 * OpenFlow 1.0 ("OF10") and NXM. "<used>" and "-" indicate a value
207 * that may be populated and an ignored field, respectively.
209 * cookie cookie_mask new_cookie
210 * ====== =========== ==========
211 * OF10 Add - 0 <used>
212 * OF10 Modify - 0 <used>
215 * NXM Modify <used> <used> <used>
216 * NXM Delete <used> <used> -
218 struct ofputil_flow_mod {
220 ovs_be64 cookie; /* Cookie bits to match. */
221 ovs_be64 cookie_mask; /* 1-bit in each 'cookie' bit to match. */
222 ovs_be64 new_cookie; /* New cookie to install or -1. */
225 uint16_t idle_timeout;
226 uint16_t hard_timeout;
230 union ofp_action *actions;
234 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
235 const struct ofp_header *,
236 enum ofputil_protocol);
237 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
238 enum ofputil_protocol);
240 enum ofputil_protocol ofputil_flow_mod_usable_protocols(
241 const struct ofputil_flow_mod *fms, size_t n_fms);
243 /* Flow stats or aggregate stats request, independent of protocol. */
244 struct ofputil_flow_stats_request {
245 bool aggregate; /* Aggregate results? */
246 struct cls_rule match;
248 ovs_be64 cookie_mask;
253 enum ofperr ofputil_decode_flow_stats_request(
254 struct ofputil_flow_stats_request *, const struct ofp_header *);
255 struct ofpbuf *ofputil_encode_flow_stats_request(
256 const struct ofputil_flow_stats_request *, enum ofputil_protocol);
257 enum ofputil_protocol ofputil_flow_stats_request_usable_protocols(
258 const struct ofputil_flow_stats_request *);
260 /* Flow stats reply, independent of protocol. */
261 struct ofputil_flow_stats {
262 struct cls_rule rule;
265 uint32_t duration_sec;
266 uint32_t duration_nsec;
267 uint16_t idle_timeout;
268 uint16_t hard_timeout;
269 int idle_age; /* Seconds since last packet, -1 if unknown. */
270 int hard_age; /* Seconds since last change, -1 if unknown. */
271 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
272 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
273 union ofp_action *actions;
277 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
279 bool flow_age_extension);
280 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
281 struct list *replies);
283 /* Aggregate stats reply, independent of protocol. */
284 struct ofputil_aggregate_stats {
285 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
286 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
290 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
291 const struct ofputil_aggregate_stats *stats,
292 const struct ofp_stats_msg *request);
294 /* Flow removed message, independent of protocol. */
295 struct ofputil_flow_removed {
296 struct cls_rule rule;
298 uint8_t reason; /* One of OFPRR_*. */
299 uint32_t duration_sec;
300 uint32_t duration_nsec;
301 uint16_t idle_timeout;
302 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
303 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
306 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
307 const struct ofp_header *);
308 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
309 enum ofputil_protocol);
311 /* Abstract packet-in message. */
312 struct ofputil_packet_in {
316 enum ofp_packet_in_reason reason; /* One of OFPR_*. */
317 uint16_t controller_id; /* Controller ID to send to. */
323 uint16_t total_len; /* Full length of frame. */
325 struct flow_metadata fmd; /* Metadata at creation time. */
328 int ofputil_decode_packet_in(struct ofputil_packet_in *,
329 const struct ofp_header *);
330 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
331 enum nx_packet_in_format);
333 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason);
334 bool ofputil_packet_in_reason_from_string(const char *,
335 enum ofp_packet_in_reason *);
337 /* Abstract packet-out message.
339 * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
340 * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
341 struct ofputil_packet_out {
342 const void *packet; /* Packet data, if buffer_id == UINT32_MAX. */
343 size_t packet_len; /* Length of packet data in bytes. */
344 uint32_t buffer_id; /* Buffer id or UINT32_MAX if no buffer. */
345 uint16_t in_port; /* Packet's input port. */
346 union ofp_action *actions; /* Actions. */
347 size_t n_actions; /* Number of elements in 'actions' array. */
350 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
351 const struct ofp_packet_out *);
352 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *);
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 and 1.1 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. */
407 OFPUTIL_C_ARP_MATCH_IP = 1 << 7, /* Match IP addresses in ARP pkts. */
409 /* OpenFlow 1.0 only. */
410 OFPUTIL_C_STP = 1 << 3, /* 802.1d spanning tree. */
412 /* OpenFlow 1.1 only. */
413 OFPUTIL_C_GROUP_STATS = 1 << 4, /* Group statistics. */
416 enum ofputil_action_bitmap {
417 OFPUTIL_A_OUTPUT = 1 << 0,
418 OFPUTIL_A_SET_VLAN_VID = 1 << 1,
419 OFPUTIL_A_SET_VLAN_PCP = 1 << 2,
420 OFPUTIL_A_STRIP_VLAN = 1 << 3,
421 OFPUTIL_A_SET_DL_SRC = 1 << 4,
422 OFPUTIL_A_SET_DL_DST = 1 << 5,
423 OFPUTIL_A_SET_NW_SRC = 1 << 6,
424 OFPUTIL_A_SET_NW_DST = 1 << 7,
425 OFPUTIL_A_SET_NW_ECN = 1 << 8,
426 OFPUTIL_A_SET_NW_TOS = 1 << 9,
427 OFPUTIL_A_SET_TP_SRC = 1 << 10,
428 OFPUTIL_A_SET_TP_DST = 1 << 11,
429 OFPUTIL_A_ENQUEUE = 1 << 12,
430 OFPUTIL_A_COPY_TTL_OUT = 1 << 13,
431 OFPUTIL_A_COPY_TTL_IN = 1 << 14,
432 OFPUTIL_A_SET_MPLS_LABEL = 1 << 15,
433 OFPUTIL_A_SET_MPLS_TC = 1 << 16,
434 OFPUTIL_A_SET_MPLS_TTL = 1 << 17,
435 OFPUTIL_A_DEC_MPLS_TTL = 1 << 18,
436 OFPUTIL_A_PUSH_VLAN = 1 << 19,
437 OFPUTIL_A_POP_VLAN = 1 << 20,
438 OFPUTIL_A_PUSH_MPLS = 1 << 21,
439 OFPUTIL_A_POP_MPLS = 1 << 22,
440 OFPUTIL_A_SET_QUEUE = 1 << 23,
441 OFPUTIL_A_GROUP = 1 << 24,
442 OFPUTIL_A_SET_NW_TTL = 1 << 25,
443 OFPUTIL_A_DEC_NW_TTL = 1 << 26,
446 /* Abstract ofp_switch_features. */
447 struct ofputil_switch_features {
448 uint64_t datapath_id; /* Datapath unique ID. */
449 uint32_t n_buffers; /* Max packets buffered at once. */
450 uint8_t n_tables; /* Number of tables supported by datapath. */
451 enum ofputil_capabilities capabilities;
452 enum ofputil_action_bitmap actions;
455 enum ofperr ofputil_decode_switch_features(const struct ofp_switch_features *,
456 struct ofputil_switch_features *,
459 struct ofpbuf *ofputil_encode_switch_features(
460 const struct ofputil_switch_features *, enum ofputil_protocol,
462 void ofputil_put_switch_features_port(const struct ofputil_phy_port *,
464 bool ofputil_switch_features_ports_trunc(struct ofpbuf *b);
466 /* phy_port helper functions. */
467 int ofputil_pull_phy_port(uint8_t ofp_version, struct ofpbuf *,
468 struct ofputil_phy_port *);
469 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *);
471 /* Abstract ofp_port_status. */
472 struct ofputil_port_status {
473 enum ofp_port_reason reason;
474 struct ofputil_phy_port desc;
477 enum ofperr ofputil_decode_port_status(const struct ofp_port_status *,
478 struct ofputil_port_status *);
479 struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *,
480 enum ofputil_protocol);
482 /* Abstract ofp_port_mod. */
483 struct ofputil_port_mod {
485 uint8_t hw_addr[OFP_ETH_ALEN];
486 enum ofputil_port_config config;
487 enum ofputil_port_config mask;
488 enum netdev_features advertise;
491 enum ofperr ofputil_decode_port_mod(const struct ofp_header *,
492 struct ofputil_port_mod *);
493 struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
494 enum ofputil_protocol);
496 /* OpenFlow protocol utility functions. */
497 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
498 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
500 void *make_openflow_xid(size_t openflow_len, uint8_t type,
501 ovs_be32 xid, struct ofpbuf **);
502 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
505 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
506 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
509 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
510 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
513 void update_openflow_length(struct ofpbuf *);
515 void *ofputil_make_stats_request(size_t openflow_len, uint16_t type,
516 uint32_t subtype, struct ofpbuf **);
517 void *ofputil_make_stats_reply(size_t openflow_len,
518 const struct ofp_stats_msg *request,
521 void ofputil_start_stats_reply(const struct ofp_stats_msg *request,
523 struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *);
524 void *ofputil_append_stats_reply(size_t len, struct list *);
526 void ofputil_append_port_desc_stats_reply(uint8_t ofp_version,
527 const struct ofputil_phy_port *pp,
528 struct list *replies);
530 const void *ofputil_stats_body(const struct ofp_header *);
531 size_t ofputil_stats_body_len(const struct ofp_header *);
533 const void *ofputil_nxstats_body(const struct ofp_header *);
534 size_t ofputil_nxstats_body_len(const struct ofp_header *);
536 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
538 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
539 uint16_t max_idle, size_t actions_len);
540 struct ofpbuf *make_del_flow(const struct cls_rule *);
541 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
542 uint32_t buffer_id, uint16_t out_port,
544 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
546 const struct ofpbuf *payload, int max_send_len);
547 struct ofpbuf *make_echo_request(void);
548 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
550 struct ofpbuf *ofputil_encode_barrier_request(void);
552 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
553 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
558 /* The type of an action.
560 * For each implemented OFPAT10_* and NXAST_* action type, there is a
561 * corresponding constant prefixed with OFPUTIL_, e.g.:
563 * OFPUTIL_OFPAT10_OUTPUT
564 * OFPUTIL_OFPAT10_SET_VLAN_VID
565 * OFPUTIL_OFPAT10_SET_VLAN_PCP
566 * OFPUTIL_OFPAT10_STRIP_VLAN
567 * OFPUTIL_OFPAT10_SET_DL_SRC
568 * OFPUTIL_OFPAT10_SET_DL_DST
569 * OFPUTIL_OFPAT10_SET_NW_SRC
570 * OFPUTIL_OFPAT10_SET_NW_DST
571 * OFPUTIL_OFPAT10_SET_NW_TOS
572 * OFPUTIL_OFPAT10_SET_TP_SRC
573 * OFPUTIL_OFPAT10_SET_TP_DST
574 * OFPUTIL_OFPAT10_ENQUEUE
575 * OFPUTIL_NXAST_RESUBMIT
576 * OFPUTIL_NXAST_SET_TUNNEL
577 * OFPUTIL_NXAST_SET_QUEUE
578 * OFPUTIL_NXAST_POP_QUEUE
579 * OFPUTIL_NXAST_REG_MOVE
580 * OFPUTIL_NXAST_REG_LOAD
582 * OFPUTIL_NXAST_SET_TUNNEL64
583 * OFPUTIL_NXAST_MULTIPATH
584 * OFPUTIL_NXAST_AUTOPATH
585 * OFPUTIL_NXAST_BUNDLE
586 * OFPUTIL_NXAST_BUNDLE_LOAD
587 * OFPUTIL_NXAST_RESUBMIT_TABLE
588 * OFPUTIL_NXAST_OUTPUT_REG
589 * OFPUTIL_NXAST_LEARN
590 * OFPUTIL_NXAST_DEC_TTL
591 * OFPUTIL_NXAST_FIN_TIMEOUT
593 * (The above list helps developers who want to "grep" for these definitions.)
595 enum ofputil_action_code {
596 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM,
597 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
598 #include "ofp-util.def"
601 /* The number of values of "enum ofputil_action_code". */
603 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) + 1
604 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
605 OFPUTIL_N_ACTIONS = 0
606 #include "ofp-util.def"
609 int ofputil_decode_action(const union ofp_action *);
610 enum ofputil_action_code ofputil_decode_action_unsafe(
611 const union ofp_action *);
613 int ofputil_action_code_from_name(const char *);
615 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
617 /* For each OpenFlow action <ENUM> that has a corresponding action structure
618 * struct <STRUCT>, this defines two functions:
620 * void ofputil_init_<ENUM>(struct <STRUCT> *action);
622 * Initializes the parts of 'action' that identify it as having type <ENUM>
623 * and length 'sizeof *action' and zeros the rest. For actions that have
624 * variable length, the length used and cleared is that of struct <STRUCT>.
626 * struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
628 * Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
629 * initializes it with ofputil_init_<ENUM>(), and returns it.
631 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
632 void ofputil_init_##ENUM(struct STRUCT *); \
633 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
634 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
635 void ofputil_init_##ENUM(struct STRUCT *); \
636 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
637 #include "ofp-util.def"
639 #define OFP_ACTION_ALIGN 8 /* Alignment of ofp_actions. */
641 static inline union ofp_action *
642 ofputil_action_next(const union ofp_action *a)
644 return ((union ofp_action *) (void *)
645 ((uint8_t *) a + ntohs(a->header.len)));
649 ofputil_action_is_valid(const union ofp_action *a, size_t n_actions)
651 uint16_t len = ntohs(a->header.len);
652 return (!(len % OFP_ACTION_ALIGN)
654 && len / sizeof *a <= n_actions);
657 /* This macro is careful to check for actions with bad lengths. */
658 #define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS) \
659 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
660 (LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT); \
661 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
662 (ITER) = ofputil_action_next(ITER)))
664 /* This macro does not check for actions with bad lengths. It should only be
665 * used with actions from trusted sources or with actions that have already
666 * been validated (e.g. with OFPUTIL_ACTION_FOR_EACH). */
667 #define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS) \
668 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
670 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
671 (ITER) = ofputil_action_next(ITER)))
673 enum ofperr validate_actions(const union ofp_action *, size_t n_actions,
674 const struct flow *, int max_ports);
675 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
677 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
678 union ofp_action **, size_t *);
680 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
681 const union ofp_action *b, size_t n_b);
682 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
684 /* Handy utility for parsing flows and actions. */
685 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
687 #endif /* ofp-util.h */