2 * Copyright (c) 2008, 2009, 2010, 2011, 2012 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 OFPUTIL_NXT_SET_ASYNC_CONFIG
,
85 /* NXST_* stat requests. */
86 OFPUTIL_NXST_FLOW_REQUEST
,
87 OFPUTIL_NXST_AGGREGATE_REQUEST
,
89 /* NXST_* stat replies. */
90 OFPUTIL_NXST_FLOW_REPLY
,
91 OFPUTIL_NXST_AGGREGATE_REPLY
94 struct ofputil_msg_type
;
95 enum ofperr
ofputil_decode_msg_type(const struct ofp_header
*,
96 const struct ofputil_msg_type
**);
97 enum ofperr
ofputil_decode_msg_type_partial(const struct ofp_header
*,
99 const struct ofputil_msg_type
**);
100 enum ofputil_msg_code
ofputil_msg_type_code(const struct ofputil_msg_type
*);
101 const char *ofputil_msg_type_name(const struct ofputil_msg_type
*);
104 enum ofperr
ofputil_check_output_port(uint16_t ofp_port
, int max_ports
);
105 bool ofputil_port_from_string(const char *, uint16_t *port
);
106 void ofputil_format_port(uint16_t port
, struct ds
*);
108 /* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to
109 * and from IP bitmasks. */
110 ovs_be32
ofputil_wcbits_to_netmask(int wcbits
);
111 int ofputil_netmask_to_wcbits(ovs_be32 netmask
);
113 /* Work with OpenFlow 1.0 ofp_match. */
114 void ofputil_wildcard_from_openflow(uint32_t ofpfw
, struct flow_wildcards
*);
115 void ofputil_cls_rule_from_match(const struct ofp_match
*,
116 unsigned int priority
, struct cls_rule
*);
117 void ofputil_normalize_rule(struct cls_rule
*, enum nx_flow_format
);
118 void ofputil_cls_rule_to_match(const struct cls_rule
*, struct ofp_match
*);
120 /* dl_type translation between OpenFlow and 'struct flow' format. */
121 ovs_be16
ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type
);
122 ovs_be16
ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type
);
125 bool ofputil_flow_format_is_valid(enum nx_flow_format
);
126 const char *ofputil_flow_format_to_string(enum nx_flow_format
);
127 int ofputil_flow_format_from_string(const char *);
128 enum nx_flow_format
ofputil_min_flow_format(const struct cls_rule
*);
130 struct ofpbuf
*ofputil_make_set_flow_format(enum nx_flow_format
);
133 bool ofputil_packet_in_format_is_valid(enum nx_packet_in_format
);
134 int ofputil_packet_in_format_from_string(const char *);
135 const char *ofputil_packet_in_format_to_string(enum nx_packet_in_format
);
136 struct ofpbuf
*ofputil_make_set_packet_in_format(enum nx_packet_in_format
);
138 /* NXT_FLOW_MOD_TABLE_ID extension. */
139 struct ofpbuf
*ofputil_make_flow_mod_table_id(bool flow_mod_table_id
);
141 /* Flow format independent flow_mod. */
142 struct ofputil_flow_mod
{
145 ovs_be64 cookie_mask
;
148 uint16_t idle_timeout
;
149 uint16_t hard_timeout
;
153 union ofp_action
*actions
;
157 enum ofperr
ofputil_decode_flow_mod(struct ofputil_flow_mod
*,
158 const struct ofp_header
*,
159 bool flow_mod_table_id
);
160 struct ofpbuf
*ofputil_encode_flow_mod(const struct ofputil_flow_mod
*,
162 bool flow_mod_table_id
);
164 /* Flow stats or aggregate stats request, independent of flow format. */
165 struct ofputil_flow_stats_request
{
166 bool aggregate
; /* Aggregate results? */
167 struct cls_rule match
;
169 ovs_be64 cookie_mask
;
174 enum ofperr
ofputil_decode_flow_stats_request(
175 struct ofputil_flow_stats_request
*, const struct ofp_header
*);
176 struct ofpbuf
*ofputil_encode_flow_stats_request(
177 const struct ofputil_flow_stats_request
*, enum nx_flow_format
);
179 /* Flow stats reply, independent of flow format. */
180 struct ofputil_flow_stats
{
181 struct cls_rule rule
;
184 uint32_t duration_sec
;
185 uint32_t duration_nsec
;
186 uint16_t idle_timeout
;
187 uint16_t hard_timeout
;
188 int idle_age
; /* Seconds since last packet, -1 if unknown. */
189 int hard_age
; /* Seconds since last change, -1 if unknown. */
190 uint64_t packet_count
; /* Packet count, UINT64_MAX if unknown. */
191 uint64_t byte_count
; /* Byte count, UINT64_MAX if unknown. */
192 union ofp_action
*actions
;
196 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats
*,
198 bool flow_age_extension
);
199 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats
*,
200 struct list
*replies
);
202 /* Aggregate stats reply, independent of flow format. */
203 struct ofputil_aggregate_stats
{
204 uint64_t packet_count
; /* Packet count, UINT64_MAX if unknown. */
205 uint64_t byte_count
; /* Byte count, UINT64_MAX if unknown. */
209 struct ofpbuf
*ofputil_encode_aggregate_stats_reply(
210 const struct ofputil_aggregate_stats
*stats
,
211 const struct ofp_stats_msg
*request
);
213 /* Flow removed message, independent of flow format. */
214 struct ofputil_flow_removed
{
215 struct cls_rule rule
;
217 uint8_t reason
; /* One of OFPRR_*. */
218 uint32_t duration_sec
;
219 uint32_t duration_nsec
;
220 uint16_t idle_timeout
;
221 uint64_t packet_count
; /* Packet count, UINT64_MAX if unknown. */
222 uint64_t byte_count
; /* Byte count, UINT64_MAX if unknown. */
225 enum ofperr
ofputil_decode_flow_removed(struct ofputil_flow_removed
*,
226 const struct ofp_header
*);
227 struct ofpbuf
*ofputil_encode_flow_removed(const struct ofputil_flow_removed
*,
228 enum nx_flow_format
);
230 /* Abstract packet-in message. */
231 struct ofputil_packet_in
{
235 enum ofp_packet_in_reason reason
; /* One of OFPRR_*. */
241 uint16_t total_len
; /* Full length of frame. */
243 struct flow_metadata fmd
; /* Metadata at creation time. */
246 int ofputil_decode_packet_in(struct ofputil_packet_in
*,
247 const struct ofp_header
*);
248 struct ofpbuf
*ofputil_encode_packet_in(const struct ofputil_packet_in
*,
249 enum nx_packet_in_format
);
250 int ofputil_decode_packet_in(struct ofputil_packet_in
*pi
,
251 const struct ofp_header
*oh
);
253 /* Abstract packet-out message. */
254 struct ofputil_packet_out
{
255 const void *packet
; /* Packet data, if buffer_id == UINT32_MAX. */
256 size_t packet_len
; /* Length of packet data in bytes. */
257 uint32_t buffer_id
; /* Buffer id or UINT32_MAX if no buffer. */
258 uint16_t in_port
; /* Packet's input port or OFPP_NONE. */
259 union ofp_action
*actions
; /* Actions. */
260 size_t n_actions
; /* Number of elements in 'actions' array. */
263 enum ofperr
ofputil_decode_packet_out(struct ofputil_packet_out
*,
264 const struct ofp_packet_out
*);
265 struct ofpbuf
*ofputil_encode_packet_out(const struct ofputil_packet_out
*);
267 /* OpenFlow protocol utility functions. */
268 void *make_openflow(size_t openflow_len
, uint8_t type
, struct ofpbuf
**);
269 void *make_nxmsg(size_t openflow_len
, uint32_t subtype
, struct ofpbuf
**);
271 void *make_openflow_xid(size_t openflow_len
, uint8_t type
,
272 ovs_be32 xid
, struct ofpbuf
**);
273 void *make_nxmsg_xid(size_t openflow_len
, uint32_t subtype
, ovs_be32 xid
,
276 void *put_openflow(size_t openflow_len
, uint8_t type
, struct ofpbuf
*);
277 void *put_openflow_xid(size_t openflow_len
, uint8_t type
, ovs_be32 xid
,
280 void *put_nxmsg(size_t openflow_len
, uint32_t subtype
, struct ofpbuf
*);
281 void *put_nxmsg_xid(size_t openflow_len
, uint32_t subtype
, ovs_be32 xid
,
284 void update_openflow_length(struct ofpbuf
*);
286 void *ofputil_make_stats_request(size_t openflow_len
, uint16_t type
,
287 uint32_t subtype
, struct ofpbuf
**);
288 void *ofputil_make_stats_reply(size_t openflow_len
,
289 const struct ofp_stats_msg
*request
,
292 void ofputil_start_stats_reply(const struct ofp_stats_msg
*request
,
294 struct ofpbuf
*ofputil_reserve_stats_reply(size_t len
, struct list
*);
295 void *ofputil_append_stats_reply(size_t len
, struct list
*);
297 const void *ofputil_stats_body(const struct ofp_header
*);
298 size_t ofputil_stats_body_len(const struct ofp_header
*);
300 const void *ofputil_nxstats_body(const struct ofp_header
*);
301 size_t ofputil_nxstats_body_len(const struct ofp_header
*);
303 struct ofpbuf
*make_flow_mod(uint16_t command
, const struct cls_rule
*,
305 struct ofpbuf
*make_add_flow(const struct cls_rule
*, uint32_t buffer_id
,
306 uint16_t max_idle
, size_t actions_len
);
307 struct ofpbuf
*make_del_flow(const struct cls_rule
*);
308 struct ofpbuf
*make_add_simple_flow(const struct cls_rule
*,
309 uint32_t buffer_id
, uint16_t out_port
,
311 struct ofpbuf
*make_packet_in(uint32_t buffer_id
, uint16_t in_port
,
313 const struct ofpbuf
*payload
, int max_send_len
);
314 struct ofpbuf
*make_echo_request(void);
315 struct ofpbuf
*make_echo_reply(const struct ofp_header
*rq
);
317 struct ofpbuf
*ofputil_encode_barrier_request(void);
319 const char *ofputil_frag_handling_to_string(enum ofp_config_flags
);
320 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags
*);
324 /* The type of an action.
326 * For each implemented OFPAT_* and NXAST_* action type, there is a
327 * corresponding constant prefixed with OFPUTIL_, e.g.:
329 * OFPUTIL_OFPAT_OUTPUT
330 * OFPUTIL_OFPAT_SET_VLAN_VID
331 * OFPUTIL_OFPAT_SET_VLAN_PCP
332 * OFPUTIL_OFPAT_STRIP_VLAN
333 * OFPUTIL_OFPAT_SET_DL_SRC
334 * OFPUTIL_OFPAT_SET_DL_DST
335 * OFPUTIL_OFPAT_SET_NW_SRC
336 * OFPUTIL_OFPAT_SET_NW_DST
337 * OFPUTIL_OFPAT_SET_NW_TOS
338 * OFPUTIL_OFPAT_SET_TP_SRC
339 * OFPUTIL_OFPAT_SET_TP_DST
340 * OFPUTIL_OFPAT_ENQUEUE
341 * OFPUTIL_NXAST_RESUBMIT
342 * OFPUTIL_NXAST_SET_TUNNEL
343 * OFPUTIL_NXAST_SET_QUEUE
344 * OFPUTIL_NXAST_POP_QUEUE
345 * OFPUTIL_NXAST_REG_MOVE
346 * OFPUTIL_NXAST_REG_LOAD
348 * OFPUTIL_NXAST_SET_TUNNEL64
349 * OFPUTIL_NXAST_MULTIPATH
350 * OFPUTIL_NXAST_AUTOPATH
351 * OFPUTIL_NXAST_BUNDLE
352 * OFPUTIL_NXAST_BUNDLE_LOAD
353 * OFPUTIL_NXAST_RESUBMIT_TABLE
354 * OFPUTIL_NXAST_OUTPUT_REG
356 * (The above list helps developers who want to "grep" for these definitions.)
358 enum ofputil_action_code
{
359 #define OFPAT_ACTION(ENUM, STRUCT, NAME) OFPUTIL_##ENUM,
360 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
361 #include "ofp-util.def"
364 /* The number of values of "enum ofputil_action_code". */
366 #define OFPAT_ACTION(ENUM, STRUCT, NAME) + 1
367 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
368 OFPUTIL_N_ACTIONS
= 0
369 #include "ofp-util.def"
372 int ofputil_decode_action(const union ofp_action
*);
373 enum ofputil_action_code
ofputil_decode_action_unsafe(
374 const union ofp_action
*);
376 int ofputil_action_code_from_name(const char *);
378 void *ofputil_put_action(enum ofputil_action_code
, struct ofpbuf
*buf
);
380 /* For each OpenFlow action <ENUM> that has a corresponding action structure
381 * struct <STRUCT>, this defines two functions:
383 * void ofputil_init_<ENUM>(struct <STRUCT> *action);
385 * Initializes the parts of 'action' that identify it as having type <ENUM>
386 * and length 'sizeof *action' and zeros the rest. For actions that have
387 * variable length, the length used and cleared is that of struct <STRUCT>.
389 * struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
391 * Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
392 * initializes it with ofputil_init_<ENUM>(), and returns it.
394 #define OFPAT_ACTION(ENUM, STRUCT, NAME) \
395 void ofputil_init_##ENUM(struct STRUCT *); \
396 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
397 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) \
398 void ofputil_init_##ENUM(struct STRUCT *); \
399 struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
400 #include "ofp-util.def"
402 #define OFP_ACTION_ALIGN 8 /* Alignment of ofp_actions. */
404 static inline union ofp_action
*
405 ofputil_action_next(const union ofp_action
*a
)
407 return ((union ofp_action
*) (void *)
408 ((uint8_t *) a
+ ntohs(a
->header
.len
)));
412 ofputil_action_is_valid(const union ofp_action
*a
, size_t n_actions
)
414 uint16_t len
= ntohs(a
->header
.len
);
415 return (!(len
% OFP_ACTION_ALIGN
)
417 && len
/ sizeof *a
<= n_actions
);
420 /* This macro is careful to check for actions with bad lengths. */
421 #define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS) \
422 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
423 (LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT); \
424 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
425 (ITER) = ofputil_action_next(ITER)))
427 /* This macro does not check for actions with bad lengths. It should only be
428 * used with actions from trusted sources or with actions that have already
429 * been validated (e.g. with OFPUTIL_ACTION_FOR_EACH). */
430 #define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS) \
431 for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
433 ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
434 (ITER) = ofputil_action_next(ITER)))
436 enum ofperr
validate_actions(const union ofp_action
*, size_t n_actions
,
437 const struct flow
*, int max_ports
);
438 bool action_outputs_to_port(const union ofp_action
*, ovs_be16 port
);
440 enum ofperr
ofputil_pull_actions(struct ofpbuf
*, unsigned int actions_len
,
441 union ofp_action
**, size_t *);
443 bool ofputil_actions_equal(const union ofp_action
*a
, size_t n_a
,
444 const union ofp_action
*b
, size_t n_b
);
445 union ofp_action
*ofputil_actions_clone(const union ofp_action
*, size_t n
);
447 /* Handy utility for parsing flows and actions. */
448 bool ofputil_parse_key_value(char **stringp
, char **keyp
, char **valuep
);
450 #endif /* ofp-util.h */