2 * Copyright (c) 2008, 2009, 2010 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 /* Alignment of ofp_actions. */
33 #define OFP_ACTION_ALIGN 8
35 /* Basic decoding and length validation of OpenFlow messages. */
36 enum ofputil_msg_code {
39 /* OFPT_* messages. */
42 OFPUTIL_OFPT_ECHO_REQUEST,
43 OFPUTIL_OFPT_ECHO_REPLY,
44 OFPUTIL_OFPT_FEATURES_REQUEST,
45 OFPUTIL_OFPT_FEATURES_REPLY,
46 OFPUTIL_OFPT_GET_CONFIG_REQUEST,
47 OFPUTIL_OFPT_GET_CONFIG_REPLY,
48 OFPUTIL_OFPT_SET_CONFIG,
49 OFPUTIL_OFPT_PACKET_IN,
50 OFPUTIL_OFPT_FLOW_REMOVED,
51 OFPUTIL_OFPT_PORT_STATUS,
52 OFPUTIL_OFPT_PACKET_OUT,
53 OFPUTIL_OFPT_FLOW_MOD,
54 OFPUTIL_OFPT_PORT_MOD,
55 OFPUTIL_OFPT_BARRIER_REQUEST,
56 OFPUTIL_OFPT_BARRIER_REPLY,
57 OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST,
58 OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY,
60 /* OFPST_* stat requests. */
61 OFPUTIL_OFPST_DESC_REQUEST,
62 OFPUTIL_OFPST_FLOW_REQUEST,
63 OFPUTIL_OFPST_AGGREGATE_REQUEST,
64 OFPUTIL_OFPST_TABLE_REQUEST,
65 OFPUTIL_OFPST_PORT_REQUEST,
66 OFPUTIL_OFPST_QUEUE_REQUEST,
68 /* OFPST_* stat replies. */
69 OFPUTIL_OFPST_DESC_REPLY,
70 OFPUTIL_OFPST_FLOW_REPLY,
71 OFPUTIL_OFPST_QUEUE_REPLY,
72 OFPUTIL_OFPST_PORT_REPLY,
73 OFPUTIL_OFPST_TABLE_REPLY,
74 OFPUTIL_OFPST_AGGREGATE_REPLY,
77 OFPUTIL_NXT_STATUS_REQUEST,
78 OFPUTIL_NXT_STATUS_REPLY,
79 OFPUTIL_NXT_TUN_ID_FROM_COOKIE,
80 OFPUTIL_NXT_ROLE_REQUEST,
81 OFPUTIL_NXT_ROLE_REPLY,
82 OFPUTIL_NXT_SET_FLOW_FORMAT,
84 OFPUTIL_NXT_FLOW_REMOVED,
86 /* NXST_* stat requests. */
87 OFPUTIL_NXST_FLOW_REQUEST,
88 OFPUTIL_NXST_AGGREGATE_REQUEST,
90 /* NXST_* stat replies. */
91 OFPUTIL_NXST_FLOW_REPLY,
92 OFPUTIL_NXST_AGGREGATE_REPLY
95 struct ofputil_msg_type;
96 int ofputil_decode_msg_type(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 *);
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_cls_rule_from_match(const struct ofp_match *,
108 unsigned int priority, enum nx_flow_format,
109 uint64_t cookie, struct cls_rule *);
110 void ofputil_cls_rule_to_match(const struct cls_rule *, enum nx_flow_format,
112 void normalize_match(struct ofp_match *);
113 char *ofp_match_to_literal_string(const struct ofp_match *match);
115 /* Flow format independent flow_mod. */
120 uint16_t idle_timeout;
121 uint16_t hard_timeout;
125 union ofp_action *actions;
129 int ofputil_decode_flow_mod(struct flow_mod *, const struct ofp_header *,
130 enum nx_flow_format);
131 struct ofpbuf *ofputil_encode_flow_mod(const struct flow_mod *,
132 enum nx_flow_format);
134 /* Flow stats or aggregate stats request, independent of flow format. */
135 struct flow_stats_request {
136 bool aggregate; /* Aggregate results? */
137 struct cls_rule match;
142 int ofputil_decode_flow_stats_request(struct flow_stats_request *,
143 const struct ofp_header *,
144 enum nx_flow_format);
145 struct ofpbuf *ofputil_encode_flow_stats_request(
146 const struct flow_stats_request *, enum nx_flow_format);
148 /* OpenFlow protocol utility functions. */
149 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
150 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
152 void *make_openflow_xid(size_t openflow_len, uint8_t type,
153 ovs_be32 xid, struct ofpbuf **);
154 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
157 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
158 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
161 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
162 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
165 void update_openflow_length(struct ofpbuf *);
167 void *ofputil_make_stats_request(size_t body_len, uint16_t type,
169 void *ofputil_make_nxstats_request(size_t openflow_len, uint32_t subtype,
172 const void *ofputil_stats_body(const struct ofp_header *);
173 size_t ofputil_stats_body_len(const struct ofp_header *oh);
175 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
177 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
178 uint16_t max_idle, size_t actions_len);
179 struct ofpbuf *make_del_flow(const struct cls_rule *);
180 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
181 uint32_t buffer_id, uint16_t out_port,
183 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
185 const struct ofpbuf *payload, int max_send_len);
186 struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
188 const struct ofp_action_header *,
190 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
191 uint16_t in_port, uint16_t out_port);
192 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
193 uint16_t in_port, uint16_t out_port);
194 struct ofpbuf *make_echo_request(void);
195 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
197 struct flow_stats_iterator {
198 const uint8_t *pos, *end;
200 const struct ofp_flow_stats *flow_stats_first(struct flow_stats_iterator *,
201 const struct ofp_stats_reply *);
202 const struct ofp_flow_stats *flow_stats_next(struct flow_stats_iterator *);
204 struct actions_iterator {
205 const union ofp_action *pos, *end;
207 const union ofp_action *actions_first(struct actions_iterator *,
208 const union ofp_action *,
210 const union ofp_action *actions_next(struct actions_iterator *);
211 int validate_actions(const union ofp_action *, size_t n_actions,
212 const struct flow *, int max_ports);
213 bool action_outputs_to_port(const union ofp_action *, uint16_t port);
215 int ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
216 union ofp_action **, size_t *);
220 * These functions map OpenFlow 32-bit vendor IDs (as used in struct
221 * ofp_vendor_header) into 4-bit values to embed in an "int". The 4-bit values
222 * are only used internally in Open vSwitch and never appear on the wire, so
223 * particular codes used are not important.
226 /* Vendor error numbers currently used in Open vSwitch. */
227 #define OFPUTIL_VENDORS \
228 /* vendor name vendor value */ \
229 OFPUTIL_VENDOR(OFPUTIL_VENDOR_OPENFLOW, 0x00000000) \
230 OFPUTIL_VENDOR(OFPUTIL_VENDOR_NICIRA, NX_VENDOR_ID)
232 /* OFPUTIL_VENDOR_* definitions. */
233 enum ofputil_vendor_codes {
234 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) NAME,
237 #undef OFPUTIL_VENDOR
242 * We embed system errno values and OpenFlow standard and vendor extension
243 * error codes into a single 31-bit space using the following encoding.
244 * (Bit 31 is unused and assumed 0 to avoid negative "int" values.)
247 * +------------------------------------------------------+
249 * +------------------------------------------------------+
252 * +--+---------------------------------------------------+
253 * | 0| errno value | errno value
254 * +--+---------------------------------------------------+
256 * 30 29 26 25 16 15 0
257 * +--+-------+----------------+--------------------------+
258 * | 1| 0 | type | code | standard OpenFlow
259 * +--+-------+----------------+--------------------------+ error
261 * 30 29 26 25 16 15 0
262 * +--+-------+----------------+--------------------------+ Nicira
263 * | 1| vendor| type | code | NXET_VENDOR
264 * +--+-------+----------------+--------------------------+ error extension
266 * C and POSIX say that errno values are positive. We assume that they are
267 * less than 2**29. They are actually less than 65536 on at least Linux,
268 * FreeBSD, OpenBSD, and Windows.
270 * The 'vendor' field holds one of the OFPUTIL_VENDOR_* codes defined above.
271 * It must be nonzero.
273 * Negative values are not defined.
276 /* Currently 4 bits are allocated to the "vendor" field. Make sure that all
277 * the vendor codes can fit. */
278 BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16);
280 /* These are macro versions of the functions defined below. The macro versions
281 * are intended for use in contexts where function calls are not allowed,
282 * e.g. static initializers and case labels. */
283 #define OFP_MKERR(TYPE, CODE) ((1 << 30) | ((TYPE) << 16) | (CODE))
284 #define OFP_MKERR_VENDOR(VENDOR, TYPE, CODE) \
285 ((1 << 30) | ((VENDOR) << 26) | ((TYPE) << 16) | (CODE))
286 #define OFP_MKERR_NICIRA(TYPE, CODE) \
287 OFP_MKERR_VENDOR(OFPUTIL_VENDOR_NICIRA, TYPE, CODE)
289 /* Returns the standard OpenFlow error with the specified 'type' and 'code' as
292 ofp_mkerr(uint16_t type, uint16_t code)
294 return OFP_MKERR(type, code);
297 /* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and
298 * 'code' as an integer. 'vendor' must be an OFPUTIL_VENDOR_* constant. */
300 ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
302 assert(vendor < OFPUTIL_N_VENDORS);
303 return OFP_MKERR_VENDOR(vendor, type, code);
306 /* Returns the OpenFlow vendor error with Nicira as vendor, with the specific
307 * 'type' and 'code', as an integer. */
309 ofp_mkerr_nicira(uint16_t type, uint16_t code)
311 return OFP_MKERR_NICIRA(type, code);
314 /* Returns true if 'error' encodes an OpenFlow standard or vendor extension
315 * error codes as documented above. */
317 is_ofp_error(int error)
319 return (error & (1 << 30)) != 0;
322 /* Returns true if 'error' appears to be a system errno value. */
326 return !is_ofp_error(error);
329 /* Returns the "vendor" part of the OpenFlow error code 'error' (which must be
330 * in the format explained above). This is normally one of the
331 * OFPUTIL_VENDOR_* constants. Returns OFPUTIL_VENDOR_OPENFLOW (0) for a
332 * standard OpenFlow error. */
333 static inline uint8_t
334 get_ofp_err_vendor(int error)
336 return (error >> 26) & 0xf;
339 /* Returns the "type" part of the OpenFlow error code 'error' (which must be in
340 * the format explained above). */
341 static inline uint16_t
342 get_ofp_err_type(int error)
344 return (error >> 16) & 0x3ff;
347 /* Returns the "code" part of the OpenFlow error code 'error' (which must be in
348 * the format explained above). */
349 static inline uint16_t
350 get_ofp_err_code(int error)
352 return error & 0xffff;
355 struct ofpbuf *make_ofp_error_msg(int error, const struct ofp_header *);
357 #endif /* ofp-util.h */