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,
81 /* NXST_* stat requests. */
82 OFPUTIL_NXST_FLOW_REQUEST,
83 OFPUTIL_NXST_AGGREGATE_REQUEST,
85 /* NXST_* stat replies. */
86 OFPUTIL_NXST_FLOW_REPLY,
87 OFPUTIL_NXST_AGGREGATE_REPLY
90 struct ofputil_msg_type;
91 int ofputil_decode_msg_type(const struct ofp_header *,
92 const struct ofputil_msg_type **);
93 enum ofputil_msg_code ofputil_msg_type_code(const struct ofputil_msg_type *);
94 const char *ofputil_msg_type_name(const struct ofputil_msg_type *);
97 int ofputil_check_output_port(uint16_t ofp_port, int max_ports);
98 bool ofputil_port_from_string(const char *, uint16_t *port);
99 void ofputil_format_port(uint16_t port, struct ds *);
101 /* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to
102 * and from IP bitmasks. */
103 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
104 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
106 /* Work with OpenFlow 1.0 ofp_match. */
107 void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *);
108 void ofputil_cls_rule_from_match(const struct ofp_match *,
109 unsigned int priority, struct cls_rule *);
110 void ofputil_normalize_rule(struct cls_rule *, enum nx_flow_format);
111 void ofputil_cls_rule_to_match(const struct cls_rule *, struct ofp_match *);
113 /* dl_type translation between OpenFlow and 'struct flow' format. */
114 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
115 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
118 bool ofputil_flow_format_is_valid(enum nx_flow_format);
119 const char *ofputil_flow_format_to_string(enum nx_flow_format);
120 int ofputil_flow_format_from_string(const char *);
121 enum nx_flow_format ofputil_min_flow_format(const struct cls_rule *);
123 struct ofpbuf *ofputil_make_set_flow_format(enum nx_flow_format);
125 /* NXT_FLOW_MOD_TABLE_ID extension. */
126 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
128 /* Flow format independent flow_mod. */
129 struct ofputil_flow_mod {
134 uint16_t idle_timeout;
135 uint16_t hard_timeout;
139 union ofp_action *actions;
143 int ofputil_decode_flow_mod(struct ofputil_flow_mod *,
144 const struct ofp_header *, bool flow_mod_table_id);
145 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
147 bool flow_mod_table_id);
149 /* Flow stats or aggregate stats request, independent of flow format. */
150 struct ofputil_flow_stats_request {
151 bool aggregate; /* Aggregate results? */
152 struct cls_rule match;
157 int ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *,
158 const struct ofp_header *);
159 struct ofpbuf *ofputil_encode_flow_stats_request(
160 const struct ofputil_flow_stats_request *, enum nx_flow_format);
162 /* Flow stats reply, independent of flow format. */
163 struct ofputil_flow_stats {
164 struct cls_rule rule;
167 uint32_t duration_sec;
168 uint32_t duration_nsec;
169 uint16_t idle_timeout;
170 uint16_t hard_timeout;
171 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
172 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
173 union ofp_action *actions;
177 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
179 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
180 struct list *replies);
182 /* Aggregate stats reply, independent of flow format. */
183 struct ofputil_aggregate_stats {
184 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
185 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
189 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
190 const struct ofputil_aggregate_stats *stats,
191 const struct ofp_stats_msg *request);
193 /* Flow removed message, independent of flow format. */
194 struct ofputil_flow_removed {
195 struct cls_rule rule;
197 uint8_t reason; /* One of OFPRR_*. */
198 uint32_t duration_sec;
199 uint32_t duration_nsec;
200 uint16_t idle_timeout;
201 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
202 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
205 int ofputil_decode_flow_removed(struct ofputil_flow_removed *,
206 const struct ofp_header *);
207 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
208 enum nx_flow_format);
210 /* Abstract packet-in message. */
211 struct ofputil_packet_in {
212 struct ofpbuf *packet;
214 uint8_t reason; /* One of OFPR_*. */
220 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
221 struct ofpbuf *rw_packet);
223 /* OpenFlow protocol utility functions. */
224 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
225 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
227 void *make_openflow_xid(size_t openflow_len, uint8_t type,
228 ovs_be32 xid, struct ofpbuf **);
229 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
232 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
233 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
236 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
237 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
240 void update_openflow_length(struct ofpbuf *);
242 void *ofputil_make_stats_request(size_t openflow_len, uint16_t type,
243 uint32_t subtype, struct ofpbuf **);
244 void *ofputil_make_stats_reply(size_t openflow_len,
245 const struct ofp_stats_msg *request,
248 void ofputil_start_stats_reply(const struct ofp_stats_msg *request,
250 struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *);
251 void *ofputil_append_stats_reply(size_t len, struct list *);
253 const void *ofputil_stats_body(const struct ofp_header *);
254 size_t ofputil_stats_body_len(const struct ofp_header *);
256 const void *ofputil_nxstats_body(const struct ofp_header *);
257 size_t ofputil_nxstats_body_len(const struct ofp_header *);
259 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
261 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
262 uint16_t max_idle, size_t actions_len);
263 struct ofpbuf *make_del_flow(const struct cls_rule *);
264 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
265 uint32_t buffer_id, uint16_t out_port,
267 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
269 const struct ofpbuf *payload, int max_send_len);
270 struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
272 const struct ofp_action_header *,
274 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
275 uint16_t in_port, uint16_t out_port);
276 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
277 uint16_t in_port, uint16_t out_port);
278 struct ofpbuf *make_echo_request(void);
279 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
281 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
282 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
286 /* The type of an action.
288 * For each implemented OFPAT_* and NXAST_* action type, there is a
289 * corresponding constant prefixed with OFPUTIL_, e.g.:
291 * OFPUTIL_OFPAT_OUTPUT
292 * OFPUTIL_OFPAT_SET_VLAN_VID
293 * OFPUTIL_OFPAT_SET_VLAN_PCP
294 * OFPUTIL_OFPAT_STRIP_VLAN
295 * OFPUTIL_OFPAT_SET_DL_SRC
296 * OFPUTIL_OFPAT_SET_DL_DST
297 * OFPUTIL_OFPAT_SET_NW_SRC
298 * OFPUTIL_OFPAT_SET_NW_DST
299 * OFPUTIL_OFPAT_SET_NW_TOS
300 * OFPUTIL_OFPAT_SET_TP_SRC
301 * OFPUTIL_OFPAT_SET_TP_DST
302 * OFPUTIL_OFPAT_ENQUEUE
303 * OFPUTIL_NXAST_RESUBMIT
304 * OFPUTIL_NXAST_SET_TUNNEL
305 * OFPUTIL_NXAST_SET_QUEUE
306 * OFPUTIL_NXAST_POP_QUEUE
307 * OFPUTIL_NXAST_REG_MOVE
308 * OFPUTIL_NXAST_REG_LOAD
310 * OFPUTIL_NXAST_SET_TUNNEL64
311 * OFPUTIL_NXAST_MULTIPATH
312 * OFPUTIL_NXAST_AUTOPATH
313 * OFPUTIL_NXAST_BUNDLE
314 * OFPUTIL_NXAST_BUNDLE_LOAD
315 * OFPUTIL_NXAST_RESUBMIT_TABLE
316 * OFPUTIL_NXAST_OUTPUT_REG
318 * (The above list helps developers who want to "grep" for these definitions.)
320 enum ofputil_action_code {
321 #define OFPAT_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM,
322 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
323 #include "ofp-util.def"
326 /* The number of values of "enum ofputil_action_code". */
328 #define OFPAT_ACTION(ENUM, STRUCT, NAME) + 1
329 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
330 OFPUTIL_N_ACTIONS = 0
331 #include "ofp-util.def"
334 int ofputil_decode_action(const union ofp_action *);
335 enum ofputil_action_code ofputil_decode_action_unsafe(
336 const union ofp_action *);
338 int ofputil_action_code_from_name(const char *);
340 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
342 /* For each OpenFlow action <ENUM> that has a corresponding action structure
343 * struct <STRUCT>, this defines two functions:
345 * void ofputil_init_<ENUM>(struct <STRUCT> *action);
347 * Initializes the parts of 'action' that identify it as having type <ENUM>
348 * and length 'sizeof *action' and zeros the rest. For actions that have
349 * variable length, the length used and cleared is that of struct <STRUCT>.
351 * struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
353 * Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
354 * initializes it with ofputil_init_<ENUM>(), and returns it.
356 #define OFPAT_ACTION(ENUM, STRUCT, NAME) \
357 void ofputil_init_##ENUM(struct STRUCT *); \
358 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
359 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
360 void ofputil_init_##ENUM(struct STRUCT *); \
361 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
362 #include "ofp-util.def"
364 #define OFP_ACTION_ALIGN 8 /* Alignment of ofp_actions. */
366 static inline union ofp_action *
367 ofputil_action_next(const union ofp_action *a)
369 return ((union ofp_action *) (void *)
370 ((uint8_t *) a + ntohs(a->header.len)));
374 ofputil_action_is_valid(const union ofp_action *a, size_t n_actions)
376 uint16_t len = ntohs(a->header.len);
377 return (!(len % OFP_ACTION_ALIGN)
379 && len / sizeof *a <= n_actions);
382 /* This macro is careful to check for actions with bad lengths. */
383 #define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS) \
384 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
385 (LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT); \
386 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
387 (ITER) = ofputil_action_next(ITER)))
389 /* This macro does not check for actions with bad lengths. It should only be
390 * used with actions from trusted sources or with actions that have already
391 * been validated (e.g. with OFPUTIL_ACTION_FOR_EACH). */
392 #define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS) \
393 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
395 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
396 (ITER) = ofputil_action_next(ITER)))
398 int validate_actions(const union ofp_action *, size_t n_actions,
399 const struct flow *, int max_ports);
400 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
402 int ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
403 union ofp_action **, size_t *);
405 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
406 const union ofp_action *b, size_t n_b);
407 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
411 * These functions map OpenFlow 32-bit vendor IDs (as used in struct
412 * ofp_vendor_header) into 4-bit values to embed in an "int". The 4-bit values
413 * are only used internally in Open vSwitch and never appear on the wire, so
414 * particular codes used are not important.
417 /* Vendor error numbers currently used in Open vSwitch. */
418 #define OFPUTIL_VENDORS \
419 /* vendor name vendor value */ \
420 OFPUTIL_VENDOR(OFPUTIL_VENDOR_OPENFLOW, 0x00000000) \
421 OFPUTIL_VENDOR(OFPUTIL_VENDOR_NICIRA, NX_VENDOR_ID)
423 /* OFPUTIL_VENDOR_* definitions. */
424 enum ofputil_vendor_codes {
425 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) NAME,
428 #undef OFPUTIL_VENDOR
433 * We embed system errno values and OpenFlow standard and vendor extension
434 * error codes into a single 31-bit space using the following encoding.
435 * (Bit 31 is unused and assumed 0 to avoid negative "int" values.)
438 * +------------------------------------------------------+
440 * +------------------------------------------------------+
443 * +--+---------------------------------------------------+
444 * | 0| errno value | errno value
445 * +--+---------------------------------------------------+
447 * 30 29 26 25 16 15 0
448 * +--+-------+----------------+--------------------------+
449 * | 1| 0 | type | code | standard OpenFlow
450 * +--+-------+----------------+--------------------------+ error
452 * 30 29 26 25 16 15 0
453 * +--+-------+----------------+--------------------------+ Nicira
454 * | 1| vendor| type | code | NXET_VENDOR
455 * +--+-------+----------------+--------------------------+ error extension
457 * C and POSIX say that errno values are positive. We assume that they are
458 * less than 2**29. They are actually less than 65536 on at least Linux,
459 * FreeBSD, OpenBSD, and Windows.
461 * The 'vendor' field holds one of the OFPUTIL_VENDOR_* codes defined above.
462 * It must be nonzero.
464 * Negative values are not defined.
467 /* Currently 4 bits are allocated to the "vendor" field. Make sure that all
468 * the vendor codes can fit. */
469 BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16);
471 /* These are macro versions of the functions defined below. The macro versions
472 * are intended for use in contexts where function calls are not allowed,
473 * e.g. static initializers and case labels. */
474 #define OFP_MKERR(TYPE, CODE) ((1 << 30) | ((TYPE) << 16) | (CODE))
475 #define OFP_MKERR_VENDOR(VENDOR, TYPE, CODE) \
476 ((1 << 30) | ((VENDOR) << 26) | ((TYPE) << 16) | (CODE))
477 #define OFP_MKERR_NICIRA(TYPE, CODE) \
478 OFP_MKERR_VENDOR(OFPUTIL_VENDOR_NICIRA, TYPE, CODE)
480 /* Returns the standard OpenFlow error with the specified 'type' and 'code' as
483 ofp_mkerr(uint16_t type, uint16_t code)
485 return OFP_MKERR(type, code);
488 /* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and
489 * 'code' as an integer. 'vendor' must be an OFPUTIL_VENDOR_* constant. */
491 ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
493 assert(vendor < OFPUTIL_N_VENDORS);
494 return OFP_MKERR_VENDOR(vendor, type, code);
497 /* Returns the OpenFlow vendor error with Nicira as vendor, with the specific
498 * 'type' and 'code', as an integer. */
500 ofp_mkerr_nicira(uint16_t type, uint16_t code)
502 return OFP_MKERR_NICIRA(type, code);
505 /* Returns true if 'error' encodes an OpenFlow standard or vendor extension
506 * error codes as documented above. */
508 is_ofp_error(int error)
510 return (error & (1 << 30)) != 0;
513 /* Returns true if 'error' appears to be a system errno value. */
517 return !is_ofp_error(error);
520 /* Returns the "vendor" part of the OpenFlow error code 'error' (which must be
521 * in the format explained above). This is normally one of the
522 * OFPUTIL_VENDOR_* constants. Returns OFPUTIL_VENDOR_OPENFLOW (0) for a
523 * standard OpenFlow error. */
524 static inline uint8_t
525 get_ofp_err_vendor(int error)
527 return (error >> 26) & 0xf;
530 /* Returns the "type" part of the OpenFlow error code 'error' (which must be in
531 * the format explained above). */
532 static inline uint16_t
533 get_ofp_err_type(int error)
535 return (error >> 16) & 0x3ff;
538 /* Returns the "code" part of the OpenFlow error code 'error' (which must be in
539 * the format explained above). */
540 static inline uint16_t
541 get_ofp_err_code(int error)
543 return error & 0xffff;
546 struct ofpbuf *ofputil_encode_error_msg(int error, const struct ofp_header *);
547 int ofputil_decode_error_msg(const struct ofp_header *, size_t *payload_ofs);
549 /* String versions of errors. */
550 void ofputil_format_error(struct ds *, int error);
551 char *ofputil_error_to_string(int error);
553 /* Handy utility for parsing flows and actions. */
554 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
556 #endif /* ofp-util.h */