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+ protocols (only one variant each).
82 * These use 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,
88 OFPUTIL_P_OF13_OXM = 1 << 5,
91 #define OFPUTIL_P_ANY ((1 << 6) - 1)
93 /* Protocols in which a specific table may be specified in flow_mods. */
94 #define OFPUTIL_P_TID (OFPUTIL_P_OF10_STD_TID | \
95 OFPUTIL_P_OF10_NXM_TID | \
96 OFPUTIL_P_OF12_OXM | \
100 /* Protocols to use for flow dumps, from most to least preferred. */
101 extern enum ofputil_protocol ofputil_flow_dump_protocols[];
102 extern size_t ofputil_n_flow_dump_protocols;
104 enum ofputil_protocol
105 ofputil_protocol_from_ofp_version(enum ofp_version version);
106 enum ofp_version ofputil_protocol_to_ofp_version(enum ofputil_protocol);
108 bool ofputil_protocol_is_valid(enum ofputil_protocol);
109 enum ofputil_protocol ofputil_protocol_set_tid(enum ofputil_protocol,
111 enum ofputil_protocol ofputil_protocol_to_base(enum ofputil_protocol);
112 enum ofputil_protocol ofputil_protocol_set_base(
113 enum ofputil_protocol cur, enum ofputil_protocol new_base);
115 const char *ofputil_protocol_to_string(enum ofputil_protocol);
116 char *ofputil_protocols_to_string(enum ofputil_protocol);
117 enum ofputil_protocol ofputil_protocols_from_string(const char *);
118 enum ofputil_protocol ofputil_usable_protocols(const struct match *);
120 void ofputil_format_version(struct ds *, enum ofp_version);
121 void ofputil_format_version_name(struct ds *, enum ofp_version);
123 /* A bitmap of version numbers
125 * Bit offsets correspond to ofp_version numbers which in turn correspond to
126 * wire-protocol numbers for Open Flow versions.. E.g. (1u << OFP11_VERSION)
127 * is the mask for Open Flow 1.1. If the bit for a version is set then it is
128 * allowed, otherwise it is disallowed. */
130 void ofputil_format_version_bitmap(struct ds *msg, uint32_t bitmap);
131 void ofputil_format_version_bitmap_names(struct ds *msg, uint32_t bitmap);
133 /* Bitmap of OpenFlow versions that Open vSwitch supports. */
134 #define OFPUTIL_SUPPORTED_VERSIONS \
135 ((1u << OFP10_VERSION) | (1u << OFP12_VERSION) | (1u << OFP13_VERSION))
137 /* Bitmap of OpenFlow versions to enable by default (a subset of
138 * OFPUTIL_SUPPORTED_VERSIONS). */
139 #define OFPUTIL_DEFAULT_VERSIONS (1u << OFP10_VERSION)
141 enum ofputil_protocol ofputil_protocols_from_string(const char *s);
143 const char *ofputil_version_to_string(enum ofp_version ofp_version);
144 uint32_t ofputil_versions_from_string(const char *s);
145 uint32_t ofputil_versions_from_strings(char ** const s, size_t count);
147 bool ofputil_decode_hello(const struct ofp_header *,
148 uint32_t *allowed_versions);
149 struct ofpbuf *ofputil_encode_hello(uint32_t version_bitmap);
151 struct ofpbuf *ofputil_encode_set_protocol(enum ofputil_protocol current,
152 enum ofputil_protocol want,
153 enum ofputil_protocol *next);
156 struct ofpbuf *ofputil_encode_nx_set_flow_format(enum nx_flow_format);
157 enum ofputil_protocol ofputil_nx_flow_format_to_protocol(enum nx_flow_format);
158 bool ofputil_nx_flow_format_is_valid(enum nx_flow_format);
159 const char *ofputil_nx_flow_format_to_string(enum nx_flow_format);
161 /* Work with ofp10_match. */
162 void ofputil_wildcard_from_ofpfw10(uint32_t ofpfw, struct flow_wildcards *);
163 void ofputil_match_from_ofp10_match(const struct ofp10_match *,
165 void ofputil_normalize_match(struct match *);
166 void ofputil_normalize_match_quiet(struct match *);
167 void ofputil_match_to_ofp10_match(const struct match *, struct ofp10_match *);
169 /* Work with ofp11_match. */
170 enum ofperr ofputil_pull_ofp11_match(struct ofpbuf *, struct match *,
171 uint16_t *padded_match_len);
172 enum ofperr ofputil_match_from_ofp11_match(const struct ofp11_match *,
174 void ofputil_match_to_ofp11_match(const struct match *, struct ofp11_match *);
176 /* dl_type translation between OpenFlow and 'struct flow' format. */
177 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
178 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
181 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
182 int ofputil_packet_in_format_from_string(const char *);
183 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
184 struct ofpbuf *ofputil_make_set_packet_in_format(enum ofp_version,
185 enum nx_packet_in_format);
187 /* NXT_FLOW_MOD_TABLE_ID extension. */
188 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
190 /* Protocol-independent flow_mod.
192 * The handling of cookies across multiple versions of OpenFlow is a bit
193 * confusing. A full description of Open vSwitch's cookie handling is
194 * in the DESIGN file. The following table shows the expected values of
195 * the cookie-related fields for the different flow_mod commands in
196 * OpenFlow 1.0 ("OF10") and NXM. "<used>" and "-" indicate a value
197 * that may be populated and an ignored field, respectively.
199 * cookie cookie_mask new_cookie
200 * ====== =========== ==========
201 * OF10 Add - 0 <used>
202 * OF10 Modify - 0 <used>
205 * NXM Modify <used> <used> <used>
206 * NXM Delete <used> <used> -
208 struct ofputil_flow_mod {
210 unsigned int priority;
211 ovs_be64 cookie; /* Cookie bits to match. */
212 ovs_be64 cookie_mask; /* 1-bit in each 'cookie' bit to match. */
213 ovs_be64 new_cookie; /* New cookie to install or -1. */
216 uint16_t idle_timeout;
217 uint16_t hard_timeout;
221 struct ofpact *ofpacts; /* Series of "struct ofpact"s. */
222 size_t ofpacts_len; /* Length of ofpacts, in bytes. */
225 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
226 const struct ofp_header *,
227 enum ofputil_protocol,
228 struct ofpbuf *ofpacts);
229 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
230 enum ofputil_protocol);
232 enum ofputil_protocol ofputil_flow_mod_usable_protocols(
233 const struct ofputil_flow_mod *fms, size_t n_fms);
235 /* Flow stats or aggregate stats request, independent of protocol. */
236 struct ofputil_flow_stats_request {
237 bool aggregate; /* Aggregate results? */
240 ovs_be64 cookie_mask;
245 enum ofperr ofputil_decode_flow_stats_request(
246 struct ofputil_flow_stats_request *, const struct ofp_header *);
247 struct ofpbuf *ofputil_encode_flow_stats_request(
248 const struct ofputil_flow_stats_request *, enum ofputil_protocol);
249 enum ofputil_protocol ofputil_flow_stats_request_usable_protocols(
250 const struct ofputil_flow_stats_request *);
252 /* Flow stats reply, independent of protocol. */
253 struct ofputil_flow_stats {
257 uint32_t duration_sec;
258 uint32_t duration_nsec;
260 uint16_t idle_timeout;
261 uint16_t hard_timeout;
262 int idle_age; /* Seconds since last packet, -1 if unknown. */
263 int hard_age; /* Seconds since last change, -1 if unknown. */
264 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
265 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
266 struct ofpact *ofpacts;
268 uint16_t flags; /* Added for OF 1.3 */
271 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
273 bool flow_age_extension,
274 struct ofpbuf *ofpacts);
275 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
276 struct list *replies);
278 /* Aggregate stats reply, independent of protocol. */
279 struct ofputil_aggregate_stats {
280 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
281 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
285 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
286 const struct ofputil_aggregate_stats *stats,
287 const struct ofp_header *request);
288 enum ofperr ofputil_decode_aggregate_stats_reply(
289 struct ofputil_aggregate_stats *,
290 const struct ofp_header *reply);
292 /* Flow removed message, independent of protocol. */
293 struct ofputil_flow_removed {
297 uint8_t reason; /* One of OFPRR_*. */
298 uint8_t table_id; /* 255 if message didn't include table ID. */
299 uint32_t duration_sec;
300 uint32_t duration_nsec;
301 uint16_t idle_timeout;
302 uint16_t hard_timeout;
303 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
304 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
307 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
308 const struct ofp_header *);
309 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
310 enum ofputil_protocol);
312 /* Abstract packet-in message. */
313 struct ofputil_packet_in {
317 enum ofp_packet_in_reason reason; /* One of OFPR_*. */
318 uint16_t controller_id; /* Controller ID to send to. */
324 uint16_t total_len; /* Full length of frame. */
326 struct flow_metadata fmd; /* Metadata at creation time. */
329 enum ofperr ofputil_decode_packet_in(struct ofputil_packet_in *,
330 const struct ofp_header *);
331 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
332 enum ofputil_protocol protocol,
333 enum nx_packet_in_format);
335 const char *ofputil_packet_in_reason_to_string(enum ofp_packet_in_reason);
336 bool ofputil_packet_in_reason_from_string(const char *,
337 enum ofp_packet_in_reason *);
339 /* Abstract packet-out message.
341 * ofputil_decode_packet_out() will ensure that 'in_port' is a physical port
342 * (OFPP_MAX or less) or one of OFPP_LOCAL, OFPP_NONE, or OFPP_CONTROLLER. */
343 struct ofputil_packet_out {
344 const void *packet; /* Packet data, if buffer_id == UINT32_MAX. */
345 size_t packet_len; /* Length of packet data in bytes. */
346 uint32_t buffer_id; /* Buffer id or UINT32_MAX if no buffer. */
347 uint16_t in_port; /* Packet's input port. */
348 struct ofpact *ofpacts; /* Actions. */
349 size_t ofpacts_len; /* Size of ofpacts in bytes. */
352 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
353 const struct ofp_header *,
354 struct ofpbuf *ofpacts);
355 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *,
356 enum ofputil_protocol protocol);
358 enum ofputil_port_config {
359 /* OpenFlow 1.0 and 1.1 share these values for these port config bits. */
360 OFPUTIL_PC_PORT_DOWN = 1 << 0, /* Port is administratively down. */
361 OFPUTIL_PC_NO_RECV = 1 << 2, /* Drop all packets received by port. */
362 OFPUTIL_PC_NO_FWD = 1 << 5, /* Drop packets forwarded to port. */
363 OFPUTIL_PC_NO_PACKET_IN = 1 << 6, /* No send packet-in msgs for port. */
364 /* OpenFlow 1.0 only. */
365 OFPUTIL_PC_NO_STP = 1 << 1, /* No 802.1D spanning tree for port. */
366 OFPUTIL_PC_NO_RECV_STP = 1 << 3, /* Drop received 802.1D STP packets. */
367 OFPUTIL_PC_NO_FLOOD = 1 << 4, /* Do not include port when flooding. */
368 /* There are no OpenFlow 1.1-only bits. */
371 enum ofputil_port_state {
372 /* OpenFlow 1.0 and 1.1 share this values for these port state bits. */
373 OFPUTIL_PS_LINK_DOWN = 1 << 0, /* No physical link present. */
374 /* OpenFlow 1.1 only. */
375 OFPUTIL_PS_BLOCKED = 1 << 1, /* Port is blocked */
376 OFPUTIL_PS_LIVE = 1 << 2, /* Live for Fast Failover Group. */
377 /* OpenFlow 1.0 only. */
378 OFPUTIL_PS_STP_LISTEN = 0 << 8, /* Not learning or relaying frames. */
379 OFPUTIL_PS_STP_LEARN = 1 << 8, /* Learning but not relaying frames. */
380 OFPUTIL_PS_STP_FORWARD = 2 << 8, /* Learning and relaying frames. */
381 OFPUTIL_PS_STP_BLOCK = 3 << 8, /* Not part of spanning tree. */
382 OFPUTIL_PS_STP_MASK = 3 << 8 /* Bit mask for OFPPS10_STP_* values. */
385 /* Abstract ofp10_phy_port or ofp11_port. */
386 struct ofputil_phy_port {
388 uint8_t hw_addr[OFP_ETH_ALEN];
389 char name[OFP_MAX_PORT_NAME_LEN];
390 enum ofputil_port_config config;
391 enum ofputil_port_state state;
393 /* NETDEV_F_* feature bitmasks. */
394 enum netdev_features curr; /* Current features. */
395 enum netdev_features advertised; /* Features advertised by the port. */
396 enum netdev_features supported; /* Features supported by the port. */
397 enum netdev_features peer; /* Features advertised by peer. */
400 uint32_t curr_speed; /* Current speed, in kbps. */
401 uint32_t max_speed; /* Maximum supported speed, in kbps. */
404 enum ofputil_capabilities {
405 /* OpenFlow 1.0, 1.1, 1.2, and 1.3 share these capability values. */
406 OFPUTIL_C_FLOW_STATS = 1 << 0, /* Flow statistics. */
407 OFPUTIL_C_TABLE_STATS = 1 << 1, /* Table statistics. */
408 OFPUTIL_C_PORT_STATS = 1 << 2, /* Port statistics. */
409 OFPUTIL_C_IP_REASM = 1 << 5, /* Can reassemble IP fragments. */
410 OFPUTIL_C_QUEUE_STATS = 1 << 6, /* Queue statistics. */
412 /* OpenFlow 1.0 and 1.1 share this capability. */
413 OFPUTIL_C_ARP_MATCH_IP = 1 << 7, /* Match IP addresses in ARP pkts. */
415 /* OpenFlow 1.0 only. */
416 OFPUTIL_C_STP = 1 << 3, /* 802.1d spanning tree. */
418 /* OpenFlow 1.1, 1.2, and 1.3 share this capability. */
419 OFPUTIL_C_GROUP_STATS = 1 << 4, /* Group statistics. */
421 /* OpenFlow 1.2 and 1.3 share this capability */
422 OFPUTIL_C_PORT_BLOCKED = 1 << 8, /* Switch will block looping ports */
425 enum ofputil_action_bitmap {
426 OFPUTIL_A_OUTPUT = 1 << 0,
427 OFPUTIL_A_SET_VLAN_VID = 1 << 1,
428 OFPUTIL_A_SET_VLAN_PCP = 1 << 2,
429 OFPUTIL_A_STRIP_VLAN = 1 << 3,
430 OFPUTIL_A_SET_DL_SRC = 1 << 4,
431 OFPUTIL_A_SET_DL_DST = 1 << 5,
432 OFPUTIL_A_SET_NW_SRC = 1 << 6,
433 OFPUTIL_A_SET_NW_DST = 1 << 7,
434 OFPUTIL_A_SET_NW_ECN = 1 << 8,
435 OFPUTIL_A_SET_NW_TOS = 1 << 9,
436 OFPUTIL_A_SET_TP_SRC = 1 << 10,
437 OFPUTIL_A_SET_TP_DST = 1 << 11,
438 OFPUTIL_A_ENQUEUE = 1 << 12,
439 OFPUTIL_A_COPY_TTL_OUT = 1 << 13,
440 OFPUTIL_A_COPY_TTL_IN = 1 << 14,
441 OFPUTIL_A_SET_MPLS_LABEL = 1 << 15,
442 OFPUTIL_A_SET_MPLS_TC = 1 << 16,
443 OFPUTIL_A_SET_MPLS_TTL = 1 << 17,
444 OFPUTIL_A_DEC_MPLS_TTL = 1 << 18,
445 OFPUTIL_A_PUSH_VLAN = 1 << 19,
446 OFPUTIL_A_POP_VLAN = 1 << 20,
447 OFPUTIL_A_PUSH_MPLS = 1 << 21,
448 OFPUTIL_A_POP_MPLS = 1 << 22,
449 OFPUTIL_A_SET_QUEUE = 1 << 23,
450 OFPUTIL_A_GROUP = 1 << 24,
451 OFPUTIL_A_SET_NW_TTL = 1 << 25,
452 OFPUTIL_A_DEC_NW_TTL = 1 << 26,
453 OFPUTIL_A_SET_FIELD = 1 << 27,
456 /* Abstract ofp_switch_features. */
457 struct ofputil_switch_features {
458 uint64_t datapath_id; /* Datapath unique ID. */
459 uint32_t n_buffers; /* Max packets buffered at once. */
460 uint8_t n_tables; /* Number of tables supported by datapath. */
461 uint8_t auxiliary_id; /* Identify auxiliary connections */
462 enum ofputil_capabilities capabilities;
463 enum ofputil_action_bitmap actions;
466 enum ofperr ofputil_decode_switch_features(const struct ofp_header *,
467 struct ofputil_switch_features *,
470 struct ofpbuf *ofputil_encode_switch_features(
471 const struct ofputil_switch_features *, enum ofputil_protocol,
473 void ofputil_put_switch_features_port(const struct ofputil_phy_port *,
475 bool ofputil_switch_features_ports_trunc(struct ofpbuf *b);
477 /* phy_port helper functions. */
478 int ofputil_pull_phy_port(enum ofp_version ofp_version, struct ofpbuf *,
479 struct ofputil_phy_port *);
480 size_t ofputil_count_phy_ports(uint8_t ofp_version, struct ofpbuf *);
482 /* Abstract ofp_port_status. */
483 struct ofputil_port_status {
484 enum ofp_port_reason reason;
485 struct ofputil_phy_port desc;
488 enum ofperr ofputil_decode_port_status(const struct ofp_header *,
489 struct ofputil_port_status *);
490 struct ofpbuf *ofputil_encode_port_status(const struct ofputil_port_status *,
491 enum ofputil_protocol);
493 /* Abstract ofp_port_mod. */
494 struct ofputil_port_mod {
496 uint8_t hw_addr[OFP_ETH_ALEN];
497 enum ofputil_port_config config;
498 enum ofputil_port_config mask;
499 enum netdev_features advertise;
502 enum ofperr ofputil_decode_port_mod(const struct ofp_header *,
503 struct ofputil_port_mod *);
504 struct ofpbuf *ofputil_encode_port_mod(const struct ofputil_port_mod *,
505 enum ofputil_protocol);
507 /* Abstract table stats.
509 * For now we use ofp12_table_stats as a superset of the other protocol
510 * versions' table stats. */
512 struct ofpbuf *ofputil_encode_table_stats_reply(
513 const struct ofp12_table_stats[], int n,
514 const struct ofp_header *request);
516 /* Abstract nx_flow_monitor_request. */
517 struct ofputil_flow_monitor_request {
519 enum nx_flow_monitor_flags flags;
525 int ofputil_decode_flow_monitor_request(struct ofputil_flow_monitor_request *,
527 void ofputil_append_flow_monitor_request(
528 const struct ofputil_flow_monitor_request *, struct ofpbuf *msg);
530 /* Abstract nx_flow_update. */
531 struct ofputil_flow_update {
532 enum nx_flow_update_event event;
534 /* Used only for NXFME_ADDED, NXFME_DELETED, NXFME_MODIFIED. */
535 enum ofp_flow_removed_reason reason;
536 uint16_t idle_timeout;
537 uint16_t hard_timeout;
542 struct ofpact *ofpacts;
545 /* Used only for NXFME_ABBREV. */
549 int ofputil_decode_flow_update(struct ofputil_flow_update *,
550 struct ofpbuf *msg, struct ofpbuf *ofpacts);
551 void ofputil_start_flow_update(struct list *replies);
552 void ofputil_append_flow_update(const struct ofputil_flow_update *,
553 struct list *replies);
555 /* Abstract nx_flow_monitor_cancel. */
556 uint32_t ofputil_decode_flow_monitor_cancel(const struct ofp_header *);
557 struct ofpbuf *ofputil_encode_flow_monitor_cancel(uint32_t id);
559 /* Encoding OpenFlow stats messages. */
560 void ofputil_append_port_desc_stats_reply(enum ofp_version ofp_version,
561 const struct ofputil_phy_port *pp,
562 struct list *replies);
564 /* Encoding simple OpenFlow messages. */
565 struct ofpbuf *make_echo_request(enum ofp_version);
566 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
568 struct ofpbuf *ofputil_encode_barrier_request(enum ofp_version);
570 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
571 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
576 /* The type of an action.
578 * For each implemented OFPAT10_* and NXAST_* action type, there is a
579 * corresponding constant prefixed with OFPUTIL_, e.g.:
581 * OFPUTIL_OFPAT10_OUTPUT
582 * OFPUTIL_OFPAT10_SET_VLAN_VID
583 * OFPUTIL_OFPAT10_SET_VLAN_PCP
584 * OFPUTIL_OFPAT10_STRIP_VLAN
585 * OFPUTIL_OFPAT10_SET_DL_SRC
586 * OFPUTIL_OFPAT10_SET_DL_DST
587 * OFPUTIL_OFPAT10_SET_NW_SRC
588 * OFPUTIL_OFPAT10_SET_NW_DST
589 * OFPUTIL_OFPAT10_SET_NW_TOS
590 * OFPUTIL_OFPAT10_SET_TP_SRC
591 * OFPUTIL_OFPAT10_SET_TP_DST
592 * OFPUTIL_OFPAT10_ENQUEUE
593 * OFPUTIL_NXAST_RESUBMIT
594 * OFPUTIL_NXAST_SET_TUNNEL
595 * OFPUTIL_NXAST_SET_METADATA
596 * OFPUTIL_NXAST_SET_QUEUE
597 * OFPUTIL_NXAST_POP_QUEUE
598 * OFPUTIL_NXAST_REG_MOVE
599 * OFPUTIL_NXAST_REG_LOAD
601 * OFPUTIL_NXAST_SET_TUNNEL64
602 * OFPUTIL_NXAST_MULTIPATH
603 * OFPUTIL_NXAST_AUTOPATH
604 * OFPUTIL_NXAST_BUNDLE
605 * OFPUTIL_NXAST_BUNDLE_LOAD
606 * OFPUTIL_NXAST_RESUBMIT_TABLE
607 * OFPUTIL_NXAST_OUTPUT_REG
608 * OFPUTIL_NXAST_LEARN
609 * OFPUTIL_NXAST_DEC_TTL
610 * OFPUTIL_NXAST_FIN_TIMEOUT
612 * (The above list helps developers who want to "grep" for these definitions.)
614 enum OVS_PACKED_ENUM ofputil_action_code {
615 OFPUTIL_ACTION_INVALID,
616 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM,
617 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
618 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
619 #include "ofp-util.def"
622 /* The number of values of "enum ofputil_action_code". */
624 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) + 1
625 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
626 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
627 OFPUTIL_N_ACTIONS = 1
628 #include "ofp-util.def"
631 int ofputil_action_code_from_name(const char *);
633 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
635 /* For each OpenFlow action <ENUM> that has a corresponding action structure
636 * struct <STRUCT>, this defines two functions:
638 * void ofputil_init_<ENUM>(struct <STRUCT> *action);
640 * Initializes the parts of 'action' that identify it as having type <ENUM>
641 * and length 'sizeof *action' and zeros the rest. For actions that have
642 * variable length, the length used and cleared is that of struct <STRUCT>.
644 * struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
646 * Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
647 * initializes it with ofputil_init_<ENUM>(), and returns it.
649 #define OFPAT10_ACTION(ENUM, STRUCT, NAME) \
650 void ofputil_init_##ENUM(struct STRUCT *); \
651 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
652 #define OFPAT11_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
653 void ofputil_init_##ENUM(struct STRUCT *); \
654 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
655 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
656 void ofputil_init_##ENUM(struct STRUCT *); \
657 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
658 #include "ofp-util.def"
660 #define OFP_ACTION_ALIGN 8 /* Alignment of ofp_actions. */
662 enum ofperr validate_actions(const union ofp_action *, size_t n_actions,
663 const struct flow *, int max_ports);
664 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
666 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
667 union ofp_action **, size_t *);
669 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
670 const union ofp_action *b, size_t n_b);
671 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
673 /* Handy utility for parsing flows and actions. */
674 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
676 struct ofpbuf *ofputlil_dump_ports(enum ofp_version ofp_version, int16_t port);
678 struct ofputil_port_stats {
680 struct netdev_stats stats;
683 struct ofpbuf *ofputil_encode_dump_ports_request(enum ofp_version ofp_version,
685 void ofputil_append_port_stat(struct list *replies,
686 const struct ofputil_port_stats *ops);
687 size_t ofputil_count_port_stats(const struct ofp_header *);
688 int ofputil_decode_port_stats(struct ofputil_port_stats *, struct ofpbuf *msg);
689 enum ofperr ofputil_decode_port_stats_request(const struct ofp_header *request,
690 uint16_t *ofp10_port);
692 struct ofputil_queue_stats_request {
693 uint16_t port_no; /* OFPP_ANY means "all ports". */
698 ofputil_decode_queue_stats_request(const struct ofp_header *request,
699 struct ofputil_queue_stats_request *oqsr);
701 ofputil_encode_queue_stats_request(enum ofp_version ofp_version,
702 const struct ofputil_queue_stats_request *oqsr);
704 struct ofputil_queue_stats {
707 struct netdev_queue_stats stats;
710 size_t ofputil_count_queue_stats(const struct ofp_header *);
711 int ofputil_decode_queue_stats(struct ofputil_queue_stats *qs, struct ofpbuf *msg);
712 void ofputil_append_queue_stat(struct list *replies,
713 const struct ofputil_queue_stats *oqs);
715 #endif /* ofp-util.h */