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 int ofputil_decode_msg_type(const struct ofp_header *,
94 const struct ofputil_msg_type **);
95 int ofputil_decode_msg_type_partial(const struct ofp_header *, size_t length,
96 const struct ofputil_msg_type **);
97 enum ofputil_msg_code ofputil_msg_type_code(const struct ofputil_msg_type *);
98 const char *ofputil_msg_type_name(const struct ofputil_msg_type *);
101 int ofputil_check_output_port(uint16_t ofp_port, int max_ports);
102 bool ofputil_port_from_string(const char *, uint16_t *port);
103 void ofputil_format_port(uint16_t port, struct ds *);
105 /* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to
106 * and from IP bitmasks. */
107 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
108 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
110 /* Work with OpenFlow 1.0 ofp_match. */
111 void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *);
112 void ofputil_cls_rule_from_match(const struct ofp_match *,
113 unsigned int priority, struct cls_rule *);
114 void ofputil_normalize_rule(struct cls_rule *, enum nx_flow_format);
115 void ofputil_cls_rule_to_match(const struct cls_rule *, struct ofp_match *);
117 /* dl_type translation between OpenFlow and 'struct flow' format. */
118 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
119 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
122 bool ofputil_flow_format_is_valid(enum nx_flow_format);
123 const char *ofputil_flow_format_to_string(enum nx_flow_format);
124 int ofputil_flow_format_from_string(const char *);
125 enum nx_flow_format ofputil_min_flow_format(const struct cls_rule *);
127 struct ofpbuf *ofputil_make_set_flow_format(enum nx_flow_format);
130 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format);
131 int ofputil_packet_in_format_from_string(const char *);
132 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format);
133 struct ofpbuf *ofputil_make_set_packet_in_format(enum nx_packet_in_format);
135 /* NXT_FLOW_MOD_TABLE_ID extension. */
136 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
138 /* Flow format independent flow_mod. */
139 struct ofputil_flow_mod {
142 ovs_be64 cookie_mask;
145 uint16_t idle_timeout;
146 uint16_t hard_timeout;
150 union ofp_action *actions;
154 int ofputil_decode_flow_mod(struct ofputil_flow_mod *,
155 const struct ofp_header *, bool flow_mod_table_id);
156 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
158 bool flow_mod_table_id);
160 /* Flow stats or aggregate stats request, independent of flow format. */
161 struct ofputil_flow_stats_request {
162 bool aggregate; /* Aggregate results? */
163 struct cls_rule match;
165 ovs_be64 cookie_mask;
170 int ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *,
171 const struct ofp_header *);
172 struct ofpbuf *ofputil_encode_flow_stats_request(
173 const struct ofputil_flow_stats_request *, enum nx_flow_format);
175 /* Flow stats reply, independent of flow format. */
176 struct ofputil_flow_stats {
177 struct cls_rule rule;
180 uint32_t duration_sec;
181 uint32_t duration_nsec;
182 uint16_t idle_timeout;
183 uint16_t hard_timeout;
184 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
185 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
186 union ofp_action *actions;
190 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
192 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
193 struct list *replies);
195 /* Aggregate stats reply, independent of flow format. */
196 struct ofputil_aggregate_stats {
197 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
198 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
202 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
203 const struct ofputil_aggregate_stats *stats,
204 const struct ofp_stats_msg *request);
206 /* Flow removed message, independent of flow format. */
207 struct ofputil_flow_removed {
208 struct cls_rule rule;
210 uint8_t reason; /* One of OFPRR_*. */
211 uint32_t duration_sec;
212 uint32_t duration_nsec;
213 uint16_t idle_timeout;
214 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
215 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
218 int ofputil_decode_flow_removed(struct ofputil_flow_removed *,
219 const struct ofp_header *);
220 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
221 enum nx_flow_format);
223 /* Abstract packet-in message. */
224 struct ofputil_packet_in {
228 uint8_t reason; /* One of OFPR_*. */
234 uint16_t total_len; /* Full length of frame. */
236 struct flow_metadata fmd; /* Metadata at creation time. */
239 int ofputil_decode_packet_in(struct ofputil_packet_in *,
240 const struct ofp_header *);
241 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
242 enum nx_packet_in_format);
243 int ofputil_decode_packet_in(struct ofputil_packet_in *pi,
244 const struct ofp_header *oh);
246 /* OpenFlow protocol utility functions. */
247 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
248 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
250 void *make_openflow_xid(size_t openflow_len, uint8_t type,
251 ovs_be32 xid, struct ofpbuf **);
252 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
255 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
256 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
259 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
260 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
263 void update_openflow_length(struct ofpbuf *);
265 void *ofputil_make_stats_request(size_t openflow_len, uint16_t type,
266 uint32_t subtype, struct ofpbuf **);
267 void *ofputil_make_stats_reply(size_t openflow_len,
268 const struct ofp_stats_msg *request,
271 void ofputil_start_stats_reply(const struct ofp_stats_msg *request,
273 struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *);
274 void *ofputil_append_stats_reply(size_t len, struct list *);
276 const void *ofputil_stats_body(const struct ofp_header *);
277 size_t ofputil_stats_body_len(const struct ofp_header *);
279 const void *ofputil_nxstats_body(const struct ofp_header *);
280 size_t ofputil_nxstats_body_len(const struct ofp_header *);
282 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
284 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
285 uint16_t max_idle, size_t actions_len);
286 struct ofpbuf *make_del_flow(const struct cls_rule *);
287 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
288 uint32_t buffer_id, uint16_t out_port,
290 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
292 const struct ofpbuf *payload, int max_send_len);
293 struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
295 const struct ofp_action_header *,
297 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
298 uint16_t in_port, uint16_t out_port);
299 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
300 uint16_t in_port, uint16_t out_port);
301 struct ofpbuf *make_echo_request(void);
302 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
304 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
305 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
309 /* The type of an action.
311 * For each implemented OFPAT_* and NXAST_* action type, there is a
312 * corresponding constant prefixed with OFPUTIL_, e.g.:
314 * OFPUTIL_OFPAT_OUTPUT
315 * OFPUTIL_OFPAT_SET_VLAN_VID
316 * OFPUTIL_OFPAT_SET_VLAN_PCP
317 * OFPUTIL_OFPAT_STRIP_VLAN
318 * OFPUTIL_OFPAT_SET_DL_SRC
319 * OFPUTIL_OFPAT_SET_DL_DST
320 * OFPUTIL_OFPAT_SET_NW_SRC
321 * OFPUTIL_OFPAT_SET_NW_DST
322 * OFPUTIL_OFPAT_SET_NW_TOS
323 * OFPUTIL_OFPAT_SET_TP_SRC
324 * OFPUTIL_OFPAT_SET_TP_DST
325 * OFPUTIL_OFPAT_ENQUEUE
326 * OFPUTIL_NXAST_RESUBMIT
327 * OFPUTIL_NXAST_SET_TUNNEL
328 * OFPUTIL_NXAST_SET_QUEUE
329 * OFPUTIL_NXAST_POP_QUEUE
330 * OFPUTIL_NXAST_REG_MOVE
331 * OFPUTIL_NXAST_REG_LOAD
333 * OFPUTIL_NXAST_SET_TUNNEL64
334 * OFPUTIL_NXAST_MULTIPATH
335 * OFPUTIL_NXAST_AUTOPATH
336 * OFPUTIL_NXAST_BUNDLE
337 * OFPUTIL_NXAST_BUNDLE_LOAD
338 * OFPUTIL_NXAST_RESUBMIT_TABLE
339 * OFPUTIL_NXAST_OUTPUT_REG
341 * (The above list helps developers who want to "grep" for these definitions.)
343 enum ofputil_action_code {
344 #define OFPAT_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM,
345 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
346 #include "ofp-util.def"
349 /* The number of values of "enum ofputil_action_code". */
351 #define OFPAT_ACTION(ENUM, STRUCT, NAME) + 1
352 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
353 OFPUTIL_N_ACTIONS = 0
354 #include "ofp-util.def"
357 int ofputil_decode_action(const union ofp_action *);
358 enum ofputil_action_code ofputil_decode_action_unsafe(
359 const union ofp_action *);
361 int ofputil_action_code_from_name(const char *);
363 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
365 /* For each OpenFlow action <ENUM> that has a corresponding action structure
366 * struct <STRUCT>, this defines two functions:
368 * void ofputil_init_<ENUM>(struct <STRUCT> *action);
370 * Initializes the parts of 'action' that identify it as having type <ENUM>
371 * and length 'sizeof *action' and zeros the rest. For actions that have
372 * variable length, the length used and cleared is that of struct <STRUCT>.
374 * struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
376 * Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
377 * initializes it with ofputil_init_<ENUM>(), and returns it.
379 #define OFPAT_ACTION(ENUM, STRUCT, NAME) \
380 void ofputil_init_##ENUM(struct STRUCT *); \
381 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
382 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
383 void ofputil_init_##ENUM(struct STRUCT *); \
384 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
385 #include "ofp-util.def"
387 #define OFP_ACTION_ALIGN 8 /* Alignment of ofp_actions. */
389 static inline union ofp_action *
390 ofputil_action_next(const union ofp_action *a)
392 return ((union ofp_action *) (void *)
393 ((uint8_t *) a + ntohs(a->header.len)));
397 ofputil_action_is_valid(const union ofp_action *a, size_t n_actions)
399 uint16_t len = ntohs(a->header.len);
400 return (!(len % OFP_ACTION_ALIGN)
402 && len / sizeof *a <= n_actions);
405 /* This macro is careful to check for actions with bad lengths. */
406 #define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS) \
407 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
408 (LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT); \
409 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
410 (ITER) = ofputil_action_next(ITER)))
412 /* This macro does not check for actions with bad lengths. It should only be
413 * used with actions from trusted sources or with actions that have already
414 * been validated (e.g. with OFPUTIL_ACTION_FOR_EACH). */
415 #define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS) \
416 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
418 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
419 (ITER) = ofputil_action_next(ITER)))
421 int validate_actions(const union ofp_action *, size_t n_actions,
422 const struct flow *, int max_ports);
423 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
425 int ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
426 union ofp_action **, size_t *);
428 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
429 const union ofp_action *b, size_t n_b);
430 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
434 * These functions map OpenFlow 32-bit vendor IDs (as used in struct
435 * ofp_vendor_header) into 4-bit values to embed in an "int". The 4-bit values
436 * are only used internally in Open vSwitch and never appear on the wire, so
437 * particular codes used are not important.
440 /* Vendor error numbers currently used in Open vSwitch. */
441 #define OFPUTIL_VENDORS \
442 /* vendor name vendor value */ \
443 OFPUTIL_VENDOR(OFPUTIL_VENDOR_OPENFLOW, 0x00000000) \
444 OFPUTIL_VENDOR(OFPUTIL_VENDOR_NICIRA, NX_VENDOR_ID)
446 /* OFPUTIL_VENDOR_* definitions. */
447 enum ofputil_vendor_codes {
448 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) NAME,
451 #undef OFPUTIL_VENDOR
456 * We embed system errno values and OpenFlow standard and vendor extension
457 * error codes into a single 31-bit space using the following encoding.
458 * (Bit 31 is unused and assumed 0 to avoid negative "int" values.)
461 * +------------------------------------------------------+
463 * +------------------------------------------------------+
466 * +--+---------------------------------------------------+
467 * | 0| errno value | errno value
468 * +--+---------------------------------------------------+
470 * 30 29 26 25 16 15 0
471 * +--+-------+----------------+--------------------------+
472 * | 1| 0 | type | code | standard OpenFlow
473 * +--+-------+----------------+--------------------------+ error
475 * 30 29 26 25 16 15 0
476 * +--+-------+----------------+--------------------------+ Nicira
477 * | 1| vendor| type | code | NXET_VENDOR
478 * +--+-------+----------------+--------------------------+ error extension
480 * C and POSIX say that errno values are positive. We assume that they are
481 * less than 2**29. They are actually less than 65536 on at least Linux,
482 * FreeBSD, OpenBSD, and Windows.
484 * The 'vendor' field holds one of the OFPUTIL_VENDOR_* codes defined above.
485 * It must be nonzero.
487 * Negative values are not defined.
490 /* Currently 4 bits are allocated to the "vendor" field. Make sure that all
491 * the vendor codes can fit. */
492 BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16);
494 /* These are macro versions of the functions defined below. The macro versions
495 * are intended for use in contexts where function calls are not allowed,
496 * e.g. static initializers and case labels. */
497 #define OFP_MKERR(TYPE, CODE) ((1 << 30) | ((TYPE) << 16) | (CODE))
498 #define OFP_MKERR_VENDOR(VENDOR, TYPE, CODE) \
499 ((1 << 30) | ((VENDOR) << 26) | ((TYPE) << 16) | (CODE))
500 #define OFP_MKERR_NICIRA(TYPE, CODE) \
501 OFP_MKERR_VENDOR(OFPUTIL_VENDOR_NICIRA, TYPE, CODE)
503 /* Returns the standard OpenFlow error with the specified 'type' and 'code' as
506 ofp_mkerr(uint16_t type, uint16_t code)
508 return OFP_MKERR(type, code);
511 /* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and
512 * 'code' as an integer. 'vendor' must be an OFPUTIL_VENDOR_* constant. */
514 ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
516 assert(vendor < OFPUTIL_N_VENDORS);
517 return OFP_MKERR_VENDOR(vendor, type, code);
520 /* Returns the OpenFlow vendor error with Nicira as vendor, with the specific
521 * 'type' and 'code', as an integer. */
523 ofp_mkerr_nicira(uint16_t type, uint16_t code)
525 return OFP_MKERR_NICIRA(type, code);
528 /* Returns true if 'error' encodes an OpenFlow standard or vendor extension
529 * error codes as documented above. */
531 is_ofp_error(int error)
533 return (error & (1 << 30)) != 0;
536 /* Returns true if 'error' appears to be a system errno value. */
540 return !is_ofp_error(error);
543 /* Returns the "vendor" part of the OpenFlow error code 'error' (which must be
544 * in the format explained above). This is normally one of the
545 * OFPUTIL_VENDOR_* constants. Returns OFPUTIL_VENDOR_OPENFLOW (0) for a
546 * standard OpenFlow error. */
547 static inline uint8_t
548 get_ofp_err_vendor(int error)
550 return (error >> 26) & 0xf;
553 /* Returns the "type" part of the OpenFlow error code 'error' (which must be in
554 * the format explained above). */
555 static inline uint16_t
556 get_ofp_err_type(int error)
558 return (error >> 16) & 0x3ff;
561 /* Returns the "code" part of the OpenFlow error code 'error' (which must be in
562 * the format explained above). */
563 static inline uint16_t
564 get_ofp_err_code(int error)
566 return error & 0xffff;
569 struct ofpbuf *ofputil_encode_error_msg(int error, const struct ofp_header *);
570 int ofputil_decode_error_msg(const struct ofp_header *, size_t *payload_ofs);
572 /* String versions of errors. */
573 void ofputil_format_error(struct ds *, int error);
574 char *ofputil_error_to_string(int error);
576 /* Handy utility for parsing flows and actions. */
577 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
579 #endif /* ofp-util.h */