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 *);
96 /* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to
97 * and from IP bitmasks. */
98 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
99 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
101 /* Work with OpenFlow 1.0 ofp_match. */
102 void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *);
103 void ofputil_cls_rule_from_match(const struct ofp_match *,
104 unsigned int priority, struct cls_rule *);
105 void ofputil_normalize_rule(struct cls_rule *, enum nx_flow_format);
106 void ofputil_cls_rule_to_match(const struct cls_rule *, struct ofp_match *);
108 /* dl_type translation between OpenFlow and 'struct flow' format. */
109 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
110 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
113 bool ofputil_flow_format_is_valid(enum nx_flow_format);
114 const char *ofputil_flow_format_to_string(enum nx_flow_format);
115 int ofputil_flow_format_from_string(const char *);
116 enum nx_flow_format ofputil_min_flow_format(const struct cls_rule *);
118 struct ofpbuf *ofputil_make_set_flow_format(enum nx_flow_format);
120 /* NXT_FLOW_MOD_TABLE_ID extension. */
121 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
123 /* Flow format independent flow_mod. */
129 uint16_t idle_timeout;
130 uint16_t hard_timeout;
134 union ofp_action *actions;
138 int ofputil_decode_flow_mod(struct flow_mod *, const struct ofp_header *,
139 bool flow_mod_table_id);
140 struct ofpbuf *ofputil_encode_flow_mod(const struct flow_mod *,
142 bool flow_mod_table_id);
144 /* Flow stats or aggregate stats request, independent of flow format. */
145 struct flow_stats_request {
146 bool aggregate; /* Aggregate results? */
147 struct cls_rule match;
152 int ofputil_decode_flow_stats_request(struct flow_stats_request *,
153 const struct ofp_header *);
154 struct ofpbuf *ofputil_encode_flow_stats_request(
155 const struct flow_stats_request *, enum nx_flow_format);
157 /* Flow stats reply, independent of flow format. */
158 struct ofputil_flow_stats {
159 struct cls_rule rule;
162 uint32_t duration_sec;
163 uint32_t duration_nsec;
164 uint16_t idle_timeout;
165 uint16_t hard_timeout;
166 uint64_t packet_count;
168 union ofp_action *actions;
172 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
175 /* Aggregate stats reply, independent of flow format. */
176 struct ofputil_aggregate_stats {
177 uint64_t packet_count;
182 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
183 const struct ofputil_aggregate_stats *stats,
184 const struct ofp_stats_msg *request);
186 /* Flow removed message, independent of flow format. */
187 struct ofputil_flow_removed {
188 struct cls_rule rule;
190 uint8_t reason; /* One of OFPRR_*. */
191 uint32_t duration_sec;
192 uint32_t duration_nsec;
193 uint16_t idle_timeout;
194 uint64_t packet_count;
198 int ofputil_decode_flow_removed(struct ofputil_flow_removed *,
199 const struct ofp_header *);
200 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
201 enum nx_flow_format);
203 /* Abstract packet-in message. */
204 struct ofputil_packet_in {
205 struct ofpbuf *packet;
207 uint8_t reason; /* One of OFPR_*. */
213 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
214 struct ofpbuf *rw_packet);
216 /* OpenFlow protocol utility functions. */
217 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
218 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
220 void *make_openflow_xid(size_t openflow_len, uint8_t type,
221 ovs_be32 xid, struct ofpbuf **);
222 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
225 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
226 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
229 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
230 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
233 void update_openflow_length(struct ofpbuf *);
235 void *ofputil_make_stats_request(size_t openflow_len, uint16_t type,
236 uint32_t subtype, struct ofpbuf **);
237 void *ofputil_make_stats_reply(size_t openflow_len,
238 const struct ofp_stats_msg *request,
241 void ofputil_start_stats_reply(const struct ofp_stats_msg *request,
243 struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *);
244 void *ofputil_append_stats_reply(size_t len, struct list *);
246 const void *ofputil_stats_body(const struct ofp_header *);
247 size_t ofputil_stats_body_len(const struct ofp_header *);
249 const void *ofputil_nxstats_body(const struct ofp_header *);
250 size_t ofputil_nxstats_body_len(const struct ofp_header *);
252 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
254 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
255 uint16_t max_idle, size_t actions_len);
256 struct ofpbuf *make_del_flow(const struct cls_rule *);
257 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
258 uint32_t buffer_id, uint16_t out_port,
260 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
262 const struct ofpbuf *payload, int max_send_len);
263 struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
265 const struct ofp_action_header *,
267 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
268 uint16_t in_port, uint16_t out_port);
269 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
270 uint16_t in_port, uint16_t out_port);
271 struct ofpbuf *make_echo_request(void);
272 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
276 #define OFP_ACTION_ALIGN 8 /* Alignment of ofp_actions. */
278 struct actions_iterator {
279 const union ofp_action *pos, *end;
281 const union ofp_action *actions_first(struct actions_iterator *,
282 const union ofp_action *,
284 const union ofp_action *actions_next(struct actions_iterator *);
286 int validate_actions(const union ofp_action *, size_t n_actions,
287 const struct flow *, int max_ports);
288 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
290 int ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
291 union ofp_action **, size_t *);
295 * These functions map OpenFlow 32-bit vendor IDs (as used in struct
296 * ofp_vendor_header) into 4-bit values to embed in an "int". The 4-bit values
297 * are only used internally in Open vSwitch and never appear on the wire, so
298 * particular codes used are not important.
301 /* Vendor error numbers currently used in Open vSwitch. */
302 #define OFPUTIL_VENDORS \
303 /* vendor name vendor value */ \
304 OFPUTIL_VENDOR(OFPUTIL_VENDOR_OPENFLOW, 0x00000000) \
305 OFPUTIL_VENDOR(OFPUTIL_VENDOR_NICIRA, NX_VENDOR_ID)
307 /* OFPUTIL_VENDOR_* definitions. */
308 enum ofputil_vendor_codes {
309 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) NAME,
312 #undef OFPUTIL_VENDOR
317 * We embed system errno values and OpenFlow standard and vendor extension
318 * error codes into a single 31-bit space using the following encoding.
319 * (Bit 31 is unused and assumed 0 to avoid negative "int" values.)
322 * +------------------------------------------------------+
324 * +------------------------------------------------------+
327 * +--+---------------------------------------------------+
328 * | 0| errno value | errno value
329 * +--+---------------------------------------------------+
331 * 30 29 26 25 16 15 0
332 * +--+-------+----------------+--------------------------+
333 * | 1| 0 | type | code | standard OpenFlow
334 * +--+-------+----------------+--------------------------+ error
336 * 30 29 26 25 16 15 0
337 * +--+-------+----------------+--------------------------+ Nicira
338 * | 1| vendor| type | code | NXET_VENDOR
339 * +--+-------+----------------+--------------------------+ error extension
341 * C and POSIX say that errno values are positive. We assume that they are
342 * less than 2**29. They are actually less than 65536 on at least Linux,
343 * FreeBSD, OpenBSD, and Windows.
345 * The 'vendor' field holds one of the OFPUTIL_VENDOR_* codes defined above.
346 * It must be nonzero.
348 * Negative values are not defined.
351 /* Currently 4 bits are allocated to the "vendor" field. Make sure that all
352 * the vendor codes can fit. */
353 BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16);
355 /* These are macro versions of the functions defined below. The macro versions
356 * are intended for use in contexts where function calls are not allowed,
357 * e.g. static initializers and case labels. */
358 #define OFP_MKERR(TYPE, CODE) ((1 << 30) | ((TYPE) << 16) | (CODE))
359 #define OFP_MKERR_VENDOR(VENDOR, TYPE, CODE) \
360 ((1 << 30) | ((VENDOR) << 26) | ((TYPE) << 16) | (CODE))
361 #define OFP_MKERR_NICIRA(TYPE, CODE) \
362 OFP_MKERR_VENDOR(OFPUTIL_VENDOR_NICIRA, TYPE, CODE)
364 /* Returns the standard OpenFlow error with the specified 'type' and 'code' as
367 ofp_mkerr(uint16_t type, uint16_t code)
369 return OFP_MKERR(type, code);
372 /* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and
373 * 'code' as an integer. 'vendor' must be an OFPUTIL_VENDOR_* constant. */
375 ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
377 assert(vendor < OFPUTIL_N_VENDORS);
378 return OFP_MKERR_VENDOR(vendor, type, code);
381 /* Returns the OpenFlow vendor error with Nicira as vendor, with the specific
382 * 'type' and 'code', as an integer. */
384 ofp_mkerr_nicira(uint16_t type, uint16_t code)
386 return OFP_MKERR_NICIRA(type, code);
389 /* Returns true if 'error' encodes an OpenFlow standard or vendor extension
390 * error codes as documented above. */
392 is_ofp_error(int error)
394 return (error & (1 << 30)) != 0;
397 /* Returns true if 'error' appears to be a system errno value. */
401 return !is_ofp_error(error);
404 /* Returns the "vendor" part of the OpenFlow error code 'error' (which must be
405 * in the format explained above). This is normally one of the
406 * OFPUTIL_VENDOR_* constants. Returns OFPUTIL_VENDOR_OPENFLOW (0) for a
407 * standard OpenFlow error. */
408 static inline uint8_t
409 get_ofp_err_vendor(int error)
411 return (error >> 26) & 0xf;
414 /* Returns the "type" part of the OpenFlow error code 'error' (which must be in
415 * the format explained above). */
416 static inline uint16_t
417 get_ofp_err_type(int error)
419 return (error >> 16) & 0x3ff;
422 /* Returns the "code" part of the OpenFlow error code 'error' (which must be in
423 * the format explained above). */
424 static inline uint16_t
425 get_ofp_err_code(int error)
427 return error & 0xffff;
430 struct ofpbuf *ofputil_encode_error_msg(int error, const struct ofp_header *);
431 int ofputil_decode_error_msg(const struct ofp_header *, size_t *payload_ofs);
433 /* String versions of errors. */
434 void ofputil_format_error(struct ds *, int error);
435 char *ofputil_error_to_string(int error);
437 #endif /* ofp-util.h */