2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 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,
84 /* NXST_* stat requests. */
85 OFPUTIL_NXST_FLOW_REQUEST,
86 OFPUTIL_NXST_AGGREGATE_REQUEST,
88 /* NXST_* stat replies. */
89 OFPUTIL_NXST_FLOW_REPLY,
90 OFPUTIL_NXST_AGGREGATE_REPLY
93 struct ofputil_msg_type;
94 enum ofperr ofputil_decode_msg_type(const struct ofp_header *,
95 const struct ofputil_msg_type **);
96 enum ofperr ofputil_decode_msg_type_partial(const struct ofp_header *,
98 const struct ofputil_msg_type **);
99 enum ofputil_msg_code ofputil_msg_type_code(const struct ofputil_msg_type *);
100 const char *ofputil_msg_type_name(const struct ofputil_msg_type *);
103 enum ofperr ofputil_check_output_port(uint16_t ofp_port, int max_ports);
104 bool ofputil_port_from_string(const char *, uint16_t *port);
105 void ofputil_format_port(uint16_t port, struct ds *);
107 /* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to
108 * and from IP bitmasks. */
109 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
110 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
112 /* Work with OpenFlow 1.0 ofp_match. */
113 void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *);
114 void ofputil_cls_rule_from_match(const struct ofp_match *,
115 unsigned int priority, struct cls_rule *);
116 void ofputil_normalize_rule(struct cls_rule *, enum nx_flow_format);
117 void ofputil_cls_rule_to_match(const struct cls_rule *, struct ofp_match *);
119 /* dl_type translation between OpenFlow and 'struct flow' format. */
120 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
121 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
124 bool ofputil_flow_format_is_valid(enum nx_flow_format);
125 const char *ofputil_flow_format_to_string(enum nx_flow_format);
126 int ofputil_flow_format_from_string(const char *);
127 enum nx_flow_format ofputil_min_flow_format(const struct cls_rule *);
129 struct ofpbuf *ofputil_make_set_flow_format(enum nx_flow_format);
132 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
133 int ofputil_packet_in_format_from_string(const char *);
134 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
135 struct ofpbuf *ofputil_make_set_packet_in_format(enum nx_packet_in_format);
137 /* NXT_FLOW_MOD_TABLE_ID extension. */
138 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
140 /* Flow format independent flow_mod. */
141 struct ofputil_flow_mod {
144 ovs_be64 cookie_mask;
147 uint16_t idle_timeout;
148 uint16_t hard_timeout;
152 union ofp_action *actions;
156 enum ofperr ofputil_decode_flow_mod(struct ofputil_flow_mod *,
157 const struct ofp_header *,
158 bool flow_mod_table_id);
159 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
161 bool flow_mod_table_id);
163 /* Flow stats or aggregate stats request, independent of flow format. */
164 struct ofputil_flow_stats_request {
165 bool aggregate; /* Aggregate results? */
166 struct cls_rule match;
168 ovs_be64 cookie_mask;
173 enum ofperr ofputil_decode_flow_stats_request(
174 struct ofputil_flow_stats_request *, const struct ofp_header *);
175 struct ofpbuf *ofputil_encode_flow_stats_request(
176 const struct ofputil_flow_stats_request *, enum nx_flow_format);
178 /* Flow stats reply, independent of flow format. */
179 struct ofputil_flow_stats {
180 struct cls_rule rule;
183 uint32_t duration_sec;
184 uint32_t duration_nsec;
185 uint16_t idle_timeout;
186 uint16_t hard_timeout;
187 int idle_age; /* Seconds since last packet, -1 if unknown. */
188 int hard_age; /* Seconds since last change, -1 if unknown. */
189 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
190 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
191 union ofp_action *actions;
195 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
197 bool flow_age_extension);
198 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
199 struct list *replies);
201 /* Aggregate stats reply, independent of flow format. */
202 struct ofputil_aggregate_stats {
203 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
204 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
208 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
209 const struct ofputil_aggregate_stats *stats,
210 const struct ofp_stats_msg *request);
212 /* Flow removed message, independent of flow format. */
213 struct ofputil_flow_removed {
214 struct cls_rule rule;
216 uint8_t reason; /* One of OFPRR_*. */
217 uint32_t duration_sec;
218 uint32_t duration_nsec;
219 uint16_t idle_timeout;
220 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
221 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
224 enum ofperr ofputil_decode_flow_removed(struct ofputil_flow_removed *,
225 const struct ofp_header *);
226 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
227 enum nx_flow_format);
229 /* Abstract packet-in message. */
230 struct ofputil_packet_in {
234 enum ofp_packet_in_reason reason; /* One of OFPRR_*. */
240 uint16_t total_len; /* Full length of frame. */
242 struct flow_metadata fmd; /* Metadata at creation time. */
245 int ofputil_decode_packet_in(struct ofputil_packet_in *,
246 const struct ofp_header *);
247 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
248 enum nx_packet_in_format);
249 int ofputil_decode_packet_in(struct ofputil_packet_in *pi,
250 const struct ofp_header *oh);
252 /* Abstract packet-out message. */
253 struct ofputil_packet_out {
254 const void *packet; /* Packet data, if buffer_id == UINT32_MAX. */
255 size_t packet_len; /* Length of packet data in bytes. */
256 uint32_t buffer_id; /* Buffer id or UINT32_MAX if no buffer. */
257 uint16_t in_port; /* Packet's input port or OFPP_NONE. */
258 union ofp_action *actions; /* Actions. */
259 size_t n_actions; /* Number of elements in 'actions' array. */
262 enum ofperr ofputil_decode_packet_out(struct ofputil_packet_out *,
263 const struct ofp_packet_out *);
264 struct ofpbuf *ofputil_encode_packet_out(const struct ofputil_packet_out *);
266 /* OpenFlow protocol utility functions. */
267 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
268 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
270 void *make_openflow_xid(size_t openflow_len, uint8_t type,
271 ovs_be32 xid, struct ofpbuf **);
272 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
275 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
276 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
279 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
280 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
283 void update_openflow_length(struct ofpbuf *);
285 void *ofputil_make_stats_request(size_t openflow_len, uint16_t type,
286 uint32_t subtype, struct ofpbuf **);
287 void *ofputil_make_stats_reply(size_t openflow_len,
288 const struct ofp_stats_msg *request,
291 void ofputil_start_stats_reply(const struct ofp_stats_msg *request,
293 struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *);
294 void *ofputil_append_stats_reply(size_t len, struct list *);
296 const void *ofputil_stats_body(const struct ofp_header *);
297 size_t ofputil_stats_body_len(const struct ofp_header *);
299 const void *ofputil_nxstats_body(const struct ofp_header *);
300 size_t ofputil_nxstats_body_len(const struct ofp_header *);
302 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
304 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
305 uint16_t max_idle, size_t actions_len);
306 struct ofpbuf *make_del_flow(const struct cls_rule *);
307 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
308 uint32_t buffer_id, uint16_t out_port,
310 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
312 const struct ofpbuf *payload, int max_send_len);
313 struct ofpbuf *make_echo_request(void);
314 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
316 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
317 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
321 /* The type of an action.
323 * For each implemented OFPAT_* and NXAST_* action type, there is a
324 * corresponding constant prefixed with OFPUTIL_, e.g.:
326 * OFPUTIL_OFPAT_OUTPUT
327 * OFPUTIL_OFPAT_SET_VLAN_VID
328 * OFPUTIL_OFPAT_SET_VLAN_PCP
329 * OFPUTIL_OFPAT_STRIP_VLAN
330 * OFPUTIL_OFPAT_SET_DL_SRC
331 * OFPUTIL_OFPAT_SET_DL_DST
332 * OFPUTIL_OFPAT_SET_NW_SRC
333 * OFPUTIL_OFPAT_SET_NW_DST
334 * OFPUTIL_OFPAT_SET_NW_TOS
335 * OFPUTIL_OFPAT_SET_TP_SRC
336 * OFPUTIL_OFPAT_SET_TP_DST
337 * OFPUTIL_OFPAT_ENQUEUE
338 * OFPUTIL_NXAST_RESUBMIT
339 * OFPUTIL_NXAST_SET_TUNNEL
340 * OFPUTIL_NXAST_SET_QUEUE
341 * OFPUTIL_NXAST_POP_QUEUE
342 * OFPUTIL_NXAST_REG_MOVE
343 * OFPUTIL_NXAST_REG_LOAD
345 * OFPUTIL_NXAST_SET_TUNNEL64
346 * OFPUTIL_NXAST_MULTIPATH
347 * OFPUTIL_NXAST_AUTOPATH
348 * OFPUTIL_NXAST_BUNDLE
349 * OFPUTIL_NXAST_BUNDLE_LOAD
350 * OFPUTIL_NXAST_RESUBMIT_TABLE
351 * OFPUTIL_NXAST_OUTPUT_REG
353 * (The above list helps developers who want to "grep" for these definitions.)
355 enum ofputil_action_code {
356 #define OFPAT_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM,
357 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
358 #include "ofp-util.def"
361 /* The number of values of "enum ofputil_action_code". */
363 #define OFPAT_ACTION(ENUM, STRUCT, NAME) + 1
364 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
365 OFPUTIL_N_ACTIONS = 0
366 #include "ofp-util.def"
369 int ofputil_decode_action(const union ofp_action *);
370 enum ofputil_action_code ofputil_decode_action_unsafe(
371 const union ofp_action *);
373 int ofputil_action_code_from_name(const char *);
375 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
377 /* For each OpenFlow action <ENUM> that has a corresponding action structure
378 * struct <STRUCT>, this defines two functions:
380 * void ofputil_init_<ENUM>(struct <STRUCT> *action);
382 * Initializes the parts of 'action' that identify it as having type <ENUM>
383 * and length 'sizeof *action' and zeros the rest. For actions that have
384 * variable length, the length used and cleared is that of struct <STRUCT>.
386 * struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
388 * Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
389 * initializes it with ofputil_init_<ENUM>(), and returns it.
391 #define OFPAT_ACTION(ENUM, STRUCT, NAME) \
392 void ofputil_init_##ENUM(struct STRUCT *); \
393 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
394 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
395 void ofputil_init_##ENUM(struct STRUCT *); \
396 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
397 #include "ofp-util.def"
399 #define OFP_ACTION_ALIGN 8 /* Alignment of ofp_actions. */
401 static inline union ofp_action *
402 ofputil_action_next(const union ofp_action *a)
404 return ((union ofp_action *) (void *)
405 ((uint8_t *) a + ntohs(a->header.len)));
409 ofputil_action_is_valid(const union ofp_action *a, size_t n_actions)
411 uint16_t len = ntohs(a->header.len);
412 return (!(len % OFP_ACTION_ALIGN)
414 && len / sizeof *a <= n_actions);
417 /* This macro is careful to check for actions with bad lengths. */
418 #define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS) \
419 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
420 (LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT); \
421 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
422 (ITER) = ofputil_action_next(ITER)))
424 /* This macro does not check for actions with bad lengths. It should only be
425 * used with actions from trusted sources or with actions that have already
426 * been validated (e.g. with OFPUTIL_ACTION_FOR_EACH). */
427 #define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS) \
428 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
430 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
431 (ITER) = ofputil_action_next(ITER)))
433 enum ofperr validate_actions(const union ofp_action *, size_t n_actions,
434 const struct flow *, int max_ports);
435 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
437 enum ofperr ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
438 union ofp_action **, size_t *);
440 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
441 const union ofp_action *b, size_t n_b);
442 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
444 /* Handy utility for parsing flows and actions. */
445 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
447 #endif /* ofp-util.h */