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 int ofputil_decode_msg_type_partial(const struct ofp_header *, size_t length,
94 const struct ofputil_msg_type **);
95 enum ofputil_msg_code ofputil_msg_type_code(const struct ofputil_msg_type *);
96 const char *ofputil_msg_type_name(const struct ofputil_msg_type *);
99 int ofputil_check_output_port(uint16_t ofp_port, int max_ports);
100 bool ofputil_port_from_string(const char *, uint16_t *port);
101 void ofputil_format_port(uint16_t port, struct ds *);
103 /* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to
104 * and from IP bitmasks. */
105 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
106 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
108 /* Work with OpenFlow 1.0 ofp_match. */
109 void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *);
110 void ofputil_cls_rule_from_match(const struct ofp_match *,
111 unsigned int priority, struct cls_rule *);
112 void ofputil_normalize_rule(struct cls_rule *, enum nx_flow_format);
113 void ofputil_cls_rule_to_match(const struct cls_rule *, struct ofp_match *);
115 /* dl_type translation between OpenFlow and 'struct flow' format. */
116 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
117 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
120 bool ofputil_flow_format_is_valid(enum nx_flow_format);
121 const char *ofputil_flow_format_to_string(enum nx_flow_format);
122 int ofputil_flow_format_from_string(const char *);
123 enum nx_flow_format ofputil_min_flow_format(const struct cls_rule *);
125 struct ofpbuf *ofputil_make_set_flow_format(enum nx_flow_format);
127 /* NXT_FLOW_MOD_TABLE_ID extension. */
128 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
130 /* Flow format independent flow_mod. */
131 struct ofputil_flow_mod {
136 uint16_t idle_timeout;
137 uint16_t hard_timeout;
141 union ofp_action *actions;
145 int ofputil_decode_flow_mod(struct ofputil_flow_mod *,
146 const struct ofp_header *, bool flow_mod_table_id);
147 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
149 bool flow_mod_table_id);
151 /* Flow stats or aggregate stats request, independent of flow format. */
152 struct ofputil_flow_stats_request {
153 bool aggregate; /* Aggregate results? */
154 struct cls_rule match;
159 int ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *,
160 const struct ofp_header *);
161 struct ofpbuf *ofputil_encode_flow_stats_request(
162 const struct ofputil_flow_stats_request *, enum nx_flow_format);
164 /* Flow stats reply, independent of flow format. */
165 struct ofputil_flow_stats {
166 struct cls_rule rule;
169 uint32_t duration_sec;
170 uint32_t duration_nsec;
171 uint16_t idle_timeout;
172 uint16_t hard_timeout;
173 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
174 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
175 union ofp_action *actions;
179 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
181 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
182 struct list *replies);
184 /* Aggregate stats reply, independent of flow format. */
185 struct ofputil_aggregate_stats {
186 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
187 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
191 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
192 const struct ofputil_aggregate_stats *stats,
193 const struct ofp_stats_msg *request);
195 /* Flow removed message, independent of flow format. */
196 struct ofputil_flow_removed {
197 struct cls_rule rule;
199 uint8_t reason; /* One of OFPRR_*. */
200 uint32_t duration_sec;
201 uint32_t duration_nsec;
202 uint16_t idle_timeout;
203 uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
204 uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
207 int ofputil_decode_flow_removed(struct ofputil_flow_removed *,
208 const struct ofp_header *);
209 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
210 enum nx_flow_format);
212 /* Abstract packet-in message. */
213 struct ofputil_packet_in {
214 struct ofpbuf *packet;
216 uint8_t reason; /* One of OFPR_*. */
222 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
223 struct ofpbuf *rw_packet);
225 /* OpenFlow protocol utility functions. */
226 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
227 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
229 void *make_openflow_xid(size_t openflow_len, uint8_t type,
230 ovs_be32 xid, struct ofpbuf **);
231 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
234 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
235 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
238 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
239 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
242 void update_openflow_length(struct ofpbuf *);
244 void *ofputil_make_stats_request(size_t openflow_len, uint16_t type,
245 uint32_t subtype, struct ofpbuf **);
246 void *ofputil_make_stats_reply(size_t openflow_len,
247 const struct ofp_stats_msg *request,
250 void ofputil_start_stats_reply(const struct ofp_stats_msg *request,
252 struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *);
253 void *ofputil_append_stats_reply(size_t len, struct list *);
255 const void *ofputil_stats_body(const struct ofp_header *);
256 size_t ofputil_stats_body_len(const struct ofp_header *);
258 const void *ofputil_nxstats_body(const struct ofp_header *);
259 size_t ofputil_nxstats_body_len(const struct ofp_header *);
261 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
263 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
264 uint16_t max_idle, size_t actions_len);
265 struct ofpbuf *make_del_flow(const struct cls_rule *);
266 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
267 uint32_t buffer_id, uint16_t out_port,
269 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
271 const struct ofpbuf *payload, int max_send_len);
272 struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
274 const struct ofp_action_header *,
276 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
277 uint16_t in_port, uint16_t out_port);
278 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
279 uint16_t in_port, uint16_t out_port);
280 struct ofpbuf *make_echo_request(void);
281 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
283 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
284 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
288 /* The type of an action.
290 * For each implemented OFPAT_* and NXAST_* action type, there is a
291 * corresponding constant prefixed with OFPUTIL_, e.g.:
293 * OFPUTIL_OFPAT_OUTPUT
294 * OFPUTIL_OFPAT_SET_VLAN_VID
295 * OFPUTIL_OFPAT_SET_VLAN_PCP
296 * OFPUTIL_OFPAT_STRIP_VLAN
297 * OFPUTIL_OFPAT_SET_DL_SRC
298 * OFPUTIL_OFPAT_SET_DL_DST
299 * OFPUTIL_OFPAT_SET_NW_SRC
300 * OFPUTIL_OFPAT_SET_NW_DST
301 * OFPUTIL_OFPAT_SET_NW_TOS
302 * OFPUTIL_OFPAT_SET_TP_SRC
303 * OFPUTIL_OFPAT_SET_TP_DST
304 * OFPUTIL_OFPAT_ENQUEUE
305 * OFPUTIL_NXAST_RESUBMIT
306 * OFPUTIL_NXAST_SET_TUNNEL
307 * OFPUTIL_NXAST_SET_QUEUE
308 * OFPUTIL_NXAST_POP_QUEUE
309 * OFPUTIL_NXAST_REG_MOVE
310 * OFPUTIL_NXAST_REG_LOAD
312 * OFPUTIL_NXAST_SET_TUNNEL64
313 * OFPUTIL_NXAST_MULTIPATH
314 * OFPUTIL_NXAST_AUTOPATH
315 * OFPUTIL_NXAST_BUNDLE
316 * OFPUTIL_NXAST_BUNDLE_LOAD
317 * OFPUTIL_NXAST_RESUBMIT_TABLE
318 * OFPUTIL_NXAST_OUTPUT_REG
320 * (The above list helps developers who want to "grep" for these definitions.)
322 enum ofputil_action_code {
323 #define OFPAT_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM,
324 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
325 #include "ofp-util.def"
328 /* The number of values of "enum ofputil_action_code". */
330 #define OFPAT_ACTION(ENUM, STRUCT, NAME) + 1
331 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
332 OFPUTIL_N_ACTIONS = 0
333 #include "ofp-util.def"
336 int ofputil_decode_action(const union ofp_action *);
337 enum ofputil_action_code ofputil_decode_action_unsafe(
338 const union ofp_action *);
340 int ofputil_action_code_from_name(const char *);
342 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
344 /* For each OpenFlow action <ENUM> that has a corresponding action structure
345 * struct <STRUCT>, this defines two functions:
347 * void ofputil_init_<ENUM>(struct <STRUCT> *action);
349 * Initializes the parts of 'action' that identify it as having type <ENUM>
350 * and length 'sizeof *action' and zeros the rest. For actions that have
351 * variable length, the length used and cleared is that of struct <STRUCT>.
353 * struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
355 * Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
356 * initializes it with ofputil_init_<ENUM>(), and returns it.
358 #define OFPAT_ACTION(ENUM, STRUCT, NAME) \
359 void ofputil_init_##ENUM(struct STRUCT *); \
360 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
361 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
362 void ofputil_init_##ENUM(struct STRUCT *); \
363 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
364 #include "ofp-util.def"
366 #define OFP_ACTION_ALIGN 8 /* Alignment of ofp_actions. */
368 static inline union ofp_action *
369 ofputil_action_next(const union ofp_action *a)
371 return ((union ofp_action *) (void *)
372 ((uint8_t *) a + ntohs(a->header.len)));
376 ofputil_action_is_valid(const union ofp_action *a, size_t n_actions)
378 uint16_t len = ntohs(a->header.len);
379 return (!(len % OFP_ACTION_ALIGN)
381 && len / sizeof *a <= n_actions);
384 /* This macro is careful to check for actions with bad lengths. */
385 #define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS) \
386 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
387 (LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT); \
388 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
389 (ITER) = ofputil_action_next(ITER)))
391 /* This macro does not check for actions with bad lengths. It should only be
392 * used with actions from trusted sources or with actions that have already
393 * been validated (e.g. with OFPUTIL_ACTION_FOR_EACH). */
394 #define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS) \
395 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
397 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
398 (ITER) = ofputil_action_next(ITER)))
400 int validate_actions(const union ofp_action *, size_t n_actions,
401 const struct flow *, int max_ports);
402 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
404 int ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
405 union ofp_action **, size_t *);
407 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
408 const union ofp_action *b, size_t n_b);
409 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
413 * These functions map OpenFlow 32-bit vendor IDs (as used in struct
414 * ofp_vendor_header) into 4-bit values to embed in an "int". The 4-bit values
415 * are only used internally in Open vSwitch and never appear on the wire, so
416 * particular codes used are not important.
419 /* Vendor error numbers currently used in Open vSwitch. */
420 #define OFPUTIL_VENDORS \
421 /* vendor name vendor value */ \
422 OFPUTIL_VENDOR(OFPUTIL_VENDOR_OPENFLOW, 0x00000000) \
423 OFPUTIL_VENDOR(OFPUTIL_VENDOR_NICIRA, NX_VENDOR_ID)
425 /* OFPUTIL_VENDOR_* definitions. */
426 enum ofputil_vendor_codes {
427 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) NAME,
430 #undef OFPUTIL_VENDOR
435 * We embed system errno values and OpenFlow standard and vendor extension
436 * error codes into a single 31-bit space using the following encoding.
437 * (Bit 31 is unused and assumed 0 to avoid negative "int" values.)
440 * +------------------------------------------------------+
442 * +------------------------------------------------------+
445 * +--+---------------------------------------------------+
446 * | 0| errno value | errno value
447 * +--+---------------------------------------------------+
449 * 30 29 26 25 16 15 0
450 * +--+-------+----------------+--------------------------+
451 * | 1| 0 | type | code | standard OpenFlow
452 * +--+-------+----------------+--------------------------+ error
454 * 30 29 26 25 16 15 0
455 * +--+-------+----------------+--------------------------+ Nicira
456 * | 1| vendor| type | code | NXET_VENDOR
457 * +--+-------+----------------+--------------------------+ error extension
459 * C and POSIX say that errno values are positive. We assume that they are
460 * less than 2**29. They are actually less than 65536 on at least Linux,
461 * FreeBSD, OpenBSD, and Windows.
463 * The 'vendor' field holds one of the OFPUTIL_VENDOR_* codes defined above.
464 * It must be nonzero.
466 * Negative values are not defined.
469 /* Currently 4 bits are allocated to the "vendor" field. Make sure that all
470 * the vendor codes can fit. */
471 BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16);
473 /* These are macro versions of the functions defined below. The macro versions
474 * are intended for use in contexts where function calls are not allowed,
475 * e.g. static initializers and case labels. */
476 #define OFP_MKERR(TYPE, CODE) ((1 << 30) | ((TYPE) << 16) | (CODE))
477 #define OFP_MKERR_VENDOR(VENDOR, TYPE, CODE) \
478 ((1 << 30) | ((VENDOR) << 26) | ((TYPE) << 16) | (CODE))
479 #define OFP_MKERR_NICIRA(TYPE, CODE) \
480 OFP_MKERR_VENDOR(OFPUTIL_VENDOR_NICIRA, TYPE, CODE)
482 /* Returns the standard OpenFlow error with the specified 'type' and 'code' as
485 ofp_mkerr(uint16_t type, uint16_t code)
487 return OFP_MKERR(type, code);
490 /* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and
491 * 'code' as an integer. 'vendor' must be an OFPUTIL_VENDOR_* constant. */
493 ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
495 assert(vendor < OFPUTIL_N_VENDORS);
496 return OFP_MKERR_VENDOR(vendor, type, code);
499 /* Returns the OpenFlow vendor error with Nicira as vendor, with the specific
500 * 'type' and 'code', as an integer. */
502 ofp_mkerr_nicira(uint16_t type, uint16_t code)
504 return OFP_MKERR_NICIRA(type, code);
507 /* Returns true if 'error' encodes an OpenFlow standard or vendor extension
508 * error codes as documented above. */
510 is_ofp_error(int error)
512 return (error & (1 << 30)) != 0;
515 /* Returns true if 'error' appears to be a system errno value. */
519 return !is_ofp_error(error);
522 /* Returns the "vendor" part of the OpenFlow error code 'error' (which must be
523 * in the format explained above). This is normally one of the
524 * OFPUTIL_VENDOR_* constants. Returns OFPUTIL_VENDOR_OPENFLOW (0) for a
525 * standard OpenFlow error. */
526 static inline uint8_t
527 get_ofp_err_vendor(int error)
529 return (error >> 26) & 0xf;
532 /* Returns the "type" part of the OpenFlow error code 'error' (which must be in
533 * the format explained above). */
534 static inline uint16_t
535 get_ofp_err_type(int error)
537 return (error >> 16) & 0x3ff;
540 /* Returns the "code" part of the OpenFlow error code 'error' (which must be in
541 * the format explained above). */
542 static inline uint16_t
543 get_ofp_err_code(int error)
545 return error & 0xffff;
548 struct ofpbuf *ofputil_encode_error_msg(int error, const struct ofp_header *);
549 int ofputil_decode_error_msg(const struct ofp_header *, size_t *payload_ofs);
551 /* String versions of errors. */
552 void ofputil_format_error(struct ds *, int error);
553 char *ofputil_error_to_string(int error);
555 /* Handy utility for parsing flows and actions. */
556 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
558 #endif /* ofp-util.h */