2 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
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"
26 #include "openflow/nicira-ext.h"
27 #include "openvswitch/types.h"
32 /* Basic decoding and length validation of OpenFlow messages. */
33 enum ofputil_msg_code {
36 /* OFPT_* messages. */
39 OFPUTIL_OFPT_ECHO_REQUEST,
40 OFPUTIL_OFPT_ECHO_REPLY,
41 OFPUTIL_OFPT_FEATURES_REQUEST,
42 OFPUTIL_OFPT_FEATURES_REPLY,
43 OFPUTIL_OFPT_GET_CONFIG_REQUEST,
44 OFPUTIL_OFPT_GET_CONFIG_REPLY,
45 OFPUTIL_OFPT_SET_CONFIG,
46 OFPUTIL_OFPT_PACKET_IN,
47 OFPUTIL_OFPT_FLOW_REMOVED,
48 OFPUTIL_OFPT_PORT_STATUS,
49 OFPUTIL_OFPT_PACKET_OUT,
50 OFPUTIL_OFPT_FLOW_MOD,
51 OFPUTIL_OFPT_PORT_MOD,
52 OFPUTIL_OFPT_BARRIER_REQUEST,
53 OFPUTIL_OFPT_BARRIER_REPLY,
54 OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST,
55 OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY,
57 /* OFPST_* stat requests. */
58 OFPUTIL_OFPST_DESC_REQUEST,
59 OFPUTIL_OFPST_FLOW_REQUEST,
60 OFPUTIL_OFPST_AGGREGATE_REQUEST,
61 OFPUTIL_OFPST_TABLE_REQUEST,
62 OFPUTIL_OFPST_PORT_REQUEST,
63 OFPUTIL_OFPST_QUEUE_REQUEST,
65 /* OFPST_* stat replies. */
66 OFPUTIL_OFPST_DESC_REPLY,
67 OFPUTIL_OFPST_FLOW_REPLY,
68 OFPUTIL_OFPST_QUEUE_REPLY,
69 OFPUTIL_OFPST_PORT_REPLY,
70 OFPUTIL_OFPST_TABLE_REPLY,
71 OFPUTIL_OFPST_AGGREGATE_REPLY,
74 OFPUTIL_NXT_ROLE_REQUEST,
75 OFPUTIL_NXT_ROLE_REPLY,
76 OFPUTIL_NXT_SET_FLOW_FORMAT,
77 OFPUTIL_NXT_FLOW_MOD_TABLE_ID,
79 OFPUTIL_NXT_FLOW_REMOVED,
80 OFPUTIL_NXT_SET_PACKET_IN_FORMAT,
81 OFPUTIL_NXT_PACKET_IN,
83 /* NXST_* stat requests. */
84 OFPUTIL_NXST_FLOW_REQUEST,
85 OFPUTIL_NXST_AGGREGATE_REQUEST,
87 /* NXST_* stat replies. */
88 OFPUTIL_NXST_FLOW_REPLY,
89 OFPUTIL_NXST_AGGREGATE_REPLY
92 struct ofputil_msg_type;
93 enum ofperr ofputil_decode_msg_type(const struct ofp_header *,
94 const struct ofputil_msg_type **);
95 enum ofperr ofputil_decode_msg_type_partial(const struct ofp_header *,
97 const struct ofputil_msg_type **);
98 enum ofputil_msg_code ofputil_msg_type_code(const struct ofputil_msg_type *);
99 const char *ofputil_msg_type_name(const struct ofputil_msg_type *);
102 enum ofperr ofputil_check_output_port(uint16_t ofp_port, int max_ports);
103 bool ofputil_port_from_string(const char *, uint16_t *port);
104 void ofputil_format_port(uint16_t port, struct ds *);
106 /* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to
107 * and from IP bitmasks. */
108 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
109 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
111 /* Work with OpenFlow 1.0 ofp_match. */
112 void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *);
113 void ofputil_cls_rule_from_match(const struct ofp_match *,
114 unsigned int priority, struct cls_rule *);
115 void ofputil_normalize_rule(struct cls_rule *, enum nx_flow_format);
116 void ofputil_cls_rule_to_match(const struct cls_rule *, struct ofp_match *);
118 /* dl_type translation between OpenFlow and 'struct flow' format. */
119 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
120 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
123 bool ofputil_flow_format_is_valid(enum nx_flow_format);
124 const char *ofputil_flow_format_to_string(enum nx_flow_format);
125 int ofputil_flow_format_from_string(const char *);
126 enum nx_flow_format ofputil_min_flow_format(const struct cls_rule *);
128 struct ofpbuf *ofputil_make_set_flow_format(enum nx_flow_format);
131 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
132 int ofputil_packet_in_format_from_string(const char *);
133 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
134 struct ofpbuf *ofputil_make_set_packet_in_format(enum nx_packet_in_format);
136 /* NXT_FLOW_MOD_TABLE_ID extension. */
137 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
139 /* Flow format independent flow_mod. */
140 struct ofputil_flow_mod {
143 ovs_be64 cookie_mask;
146 uint16_t idle_timeout;
147 uint16_t hard_timeout;
151 union ofp_action *actions;
155 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
156 const struct ofp_header *,
157 bool flow_mod_table_id);
158 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
160 bool flow_mod_table_id);
162 /* Flow stats or aggregate stats request, independent of flow format. */
163 struct ofputil_flow_stats_request {
164 bool aggregate; /* Aggregate results? */
165 struct cls_rule match;
167 ovs_be64 cookie_mask;
172 enum ofperr ofputil_decode_flow_stats_request(
173 struct ofputil_flow_stats_request *, const struct ofp_header *);
174 struct ofpbuf *ofputil_encode_flow_stats_request(
175 const struct ofputil_flow_stats_request *, enum nx_flow_format);
177 /* Flow stats reply, independent of flow format. */
178 struct ofputil_flow_stats {
179 struct cls_rule rule;
182 uint32_t duration_sec;
183 uint32_t duration_nsec;
184 uint16_t idle_timeout;
185 uint16_t hard_timeout;
186 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
187 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
188 union ofp_action *actions;
192 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
194 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
195 struct list *replies);
197 /* Aggregate stats reply, independent of flow format. */
198 struct ofputil_aggregate_stats {
199 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
200 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
204 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
205 const struct ofputil_aggregate_stats *stats,
206 const struct ofp_stats_msg *request);
208 /* Flow removed message, independent of flow format. */
209 struct ofputil_flow_removed {
210 struct cls_rule rule;
212 uint8_t reason; /* One of OFPRR_*. */
213 uint32_t duration_sec;
214 uint32_t duration_nsec;
215 uint16_t idle_timeout;
216 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
217 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
220 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
221 const struct ofp_header *);
222 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
223 enum nx_flow_format);
225 /* Abstract packet-in message. */
226 struct ofputil_packet_in {
230 uint8_t reason; /* One of OFPR_*. */
236 uint16_t total_len; /* Full length of frame. */
238 struct flow_metadata fmd; /* Metadata at creation time. */
241 int ofputil_decode_packet_in(struct ofputil_packet_in *,
242 const struct ofp_header *);
243 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
244 enum nx_packet_in_format);
245 int ofputil_decode_packet_in(struct ofputil_packet_in *pi,
246 const struct ofp_header *oh);
248 /* OpenFlow protocol utility functions. */
249 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
250 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
252 void *make_openflow_xid(size_t openflow_len, uint8_t type,
253 ovs_be32 xid, struct ofpbuf **);
254 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
257 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
258 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
261 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
262 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
265 void update_openflow_length(struct ofpbuf *);
267 void *ofputil_make_stats_request(size_t openflow_len, uint16_t type,
268 uint32_t subtype, struct ofpbuf **);
269 void *ofputil_make_stats_reply(size_t openflow_len,
270 const struct ofp_stats_msg *request,
273 void ofputil_start_stats_reply(const struct ofp_stats_msg *request,
275 struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *);
276 void *ofputil_append_stats_reply(size_t len, struct list *);
278 const void *ofputil_stats_body(const struct ofp_header *);
279 size_t ofputil_stats_body_len(const struct ofp_header *);
281 const void *ofputil_nxstats_body(const struct ofp_header *);
282 size_t ofputil_nxstats_body_len(const struct ofp_header *);
284 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
286 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
287 uint16_t max_idle, size_t actions_len);
288 struct ofpbuf *make_del_flow(const struct cls_rule *);
289 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
290 uint32_t buffer_id, uint16_t out_port,
292 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
294 const struct ofpbuf *payload, int max_send_len);
295 struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
297 const struct ofp_action_header *,
299 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
300 uint16_t in_port, uint16_t out_port);
301 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
302 uint16_t in_port, uint16_t out_port);
303 struct ofpbuf *make_echo_request(void);
304 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
306 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
307 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
311 /* The type of an action.
313 * For each implemented OFPAT_* and NXAST_* action type, there is a
314 * corresponding constant prefixed with OFPUTIL_, e.g.:
316 * OFPUTIL_OFPAT_OUTPUT
317 * OFPUTIL_OFPAT_SET_VLAN_VID
318 * OFPUTIL_OFPAT_SET_VLAN_PCP
319 * OFPUTIL_OFPAT_STRIP_VLAN
320 * OFPUTIL_OFPAT_SET_DL_SRC
321 * OFPUTIL_OFPAT_SET_DL_DST
322 * OFPUTIL_OFPAT_SET_NW_SRC
323 * OFPUTIL_OFPAT_SET_NW_DST
324 * OFPUTIL_OFPAT_SET_NW_TOS
325 * OFPUTIL_OFPAT_SET_TP_SRC
326 * OFPUTIL_OFPAT_SET_TP_DST
327 * OFPUTIL_OFPAT_ENQUEUE
328 * OFPUTIL_NXAST_RESUBMIT
329 * OFPUTIL_NXAST_SET_TUNNEL
330 * OFPUTIL_NXAST_SET_QUEUE
331 * OFPUTIL_NXAST_POP_QUEUE
332 * OFPUTIL_NXAST_REG_MOVE
333 * OFPUTIL_NXAST_REG_LOAD
335 * OFPUTIL_NXAST_SET_TUNNEL64
336 * OFPUTIL_NXAST_MULTIPATH
337 * OFPUTIL_NXAST_AUTOPATH
338 * OFPUTIL_NXAST_BUNDLE
339 * OFPUTIL_NXAST_BUNDLE_LOAD
340 * OFPUTIL_NXAST_RESUBMIT_TABLE
341 * OFPUTIL_NXAST_OUTPUT_REG
343 * (The above list helps developers who want to "grep" for these definitions.)
345 enum ofputil_action_code {
346 #define OFPAT_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM,
347 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
348 #include "ofp-util.def"
351 /* The number of values of "enum ofputil_action_code". */
353 #define OFPAT_ACTION(ENUM, STRUCT, NAME) + 1
354 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
355 OFPUTIL_N_ACTIONS = 0
356 #include "ofp-util.def"
359 int ofputil_decode_action(const union ofp_action *);
360 enum ofputil_action_code ofputil_decode_action_unsafe(
361 const union ofp_action *);
363 int ofputil_action_code_from_name(const char *);
365 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
367 /* For each OpenFlow action <ENUM> that has a corresponding action structure
368 * struct <STRUCT>, this defines two functions:
370 * void ofputil_init_<ENUM>(struct <STRUCT> *action);
372 * Initializes the parts of 'action' that identify it as having type <ENUM>
373 * and length 'sizeof *action' and zeros the rest. For actions that have
374 * variable length, the length used and cleared is that of struct <STRUCT>.
376 * struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
378 * Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
379 * initializes it with ofputil_init_<ENUM>(), and returns it.
381 #define OFPAT_ACTION(ENUM, STRUCT, NAME) \
382 void ofputil_init_##ENUM(struct STRUCT *); \
383 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
384 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
385 void ofputil_init_##ENUM(struct STRUCT *); \
386 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
387 #include "ofp-util.def"
389 #define OFP_ACTION_ALIGN 8 /* Alignment of ofp_actions. */
391 static inline union ofp_action *
392 ofputil_action_next(const union ofp_action *a)
394 return ((union ofp_action *) (void *)
395 ((uint8_t *) a + ntohs(a->header.len)));
399 ofputil_action_is_valid(const union ofp_action *a, size_t n_actions)
401 uint16_t len = ntohs(a->header.len);
402 return (!(len % OFP_ACTION_ALIGN)
404 && len / sizeof *a <= n_actions);
407 /* This macro is careful to check for actions with bad lengths. */
408 #define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS) \
409 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
410 (LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT); \
411 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
412 (ITER) = ofputil_action_next(ITER)))
414 /* This macro does not check for actions with bad lengths. It should only be
415 * used with actions from trusted sources or with actions that have already
416 * been validated (e.g. with OFPUTIL_ACTION_FOR_EACH). */
417 #define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS) \
418 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
420 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
421 (ITER) = ofputil_action_next(ITER)))
423 enum ofperr validate_actions(const union ofp_action *, size_t n_actions,
424 const struct flow *, int max_ports);
425 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
427 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
428 union ofp_action **, size_t *);
430 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
431 const union ofp_action *b, size_t n_b);
432 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
434 /* Handy utility for parsing flows and actions. */
435 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
437 #endif /* ofp-util.h */