ofp-util: New functions for parsing and formatting OpenFlow port numbers.
[sliver-openvswitch.git] / lib / ofp-util.h
1 /*
2  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
3  *
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:
7  *
8  *     http://www.apache.org/licenses/LICENSE-2.0
9  *
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.
15  */
16
17 #ifndef OFP_UTIL_H
18 #define OFP_UTIL_H 1
19
20 #include <assert.h>
21 #include <stdbool.h>
22 #include <stddef.h>
23 #include <stdint.h>
24 #include "classifier.h"
25 #include "flow.h"
26 #include "openflow/nicira-ext.h"
27 #include "openvswitch/types.h"
28
29 struct cls_rule;
30 struct ofpbuf;
31
32 /* Basic decoding and length validation of OpenFlow messages. */
33 enum ofputil_msg_code {
34     OFPUTIL_MSG_INVALID,
35
36     /* OFPT_* messages. */
37     OFPUTIL_OFPT_HELLO,
38     OFPUTIL_OFPT_ERROR,
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,
56
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,
64
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,
72
73     /* NXT_* messages. */
74     OFPUTIL_NXT_ROLE_REQUEST,
75     OFPUTIL_NXT_ROLE_REPLY,
76     OFPUTIL_NXT_SET_FLOW_FORMAT,
77     OFPUTIL_NXT_FLOW_MOD_TABLE_ID,
78     OFPUTIL_NXT_FLOW_MOD,
79     OFPUTIL_NXT_FLOW_REMOVED,
80
81     /* NXST_* stat requests. */
82     OFPUTIL_NXST_FLOW_REQUEST,
83     OFPUTIL_NXST_AGGREGATE_REQUEST,
84
85     /* NXST_* stat replies. */
86     OFPUTIL_NXST_FLOW_REPLY,
87     OFPUTIL_NXST_AGGREGATE_REPLY
88 };
89
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 *);
95
96 /* Port numbers. */
97 int ofputil_check_output_port(uint16_t ofp_port, int max_ports);
98 bool ofputil_port_from_string(const char *, uint16_t *port);
99 void ofputil_format_port(uint16_t port, struct ds *);
100
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);
105
106 /* Work with OpenFlow 1.0 ofp_match. */
107 void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *);
108 void ofputil_cls_rule_from_match(const struct ofp_match *,
109                                  unsigned int priority, struct cls_rule *);
110 void ofputil_normalize_rule(struct cls_rule *, enum nx_flow_format);
111 void ofputil_cls_rule_to_match(const struct cls_rule *, struct ofp_match *);
112
113 /* dl_type translation between OpenFlow and 'struct flow' format. */
114 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
115 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
116
117 /* Flow formats. */
118 bool ofputil_flow_format_is_valid(enum nx_flow_format);
119 const char *ofputil_flow_format_to_string(enum nx_flow_format);
120 int ofputil_flow_format_from_string(const char *);
121 enum nx_flow_format ofputil_min_flow_format(const struct cls_rule *);
122
123 struct ofpbuf *ofputil_make_set_flow_format(enum nx_flow_format);
124
125 /* NXT_FLOW_MOD_TABLE_ID extension. */
126 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
127
128 /* Flow format independent flow_mod. */
129 struct ofputil_flow_mod {
130     struct cls_rule cr;
131     ovs_be64 cookie;
132     uint8_t table_id;
133     uint16_t command;
134     uint16_t idle_timeout;
135     uint16_t hard_timeout;
136     uint32_t buffer_id;
137     uint16_t out_port;
138     uint16_t flags;
139     union ofp_action *actions;
140     size_t n_actions;
141 };
142
143 int ofputil_decode_flow_mod(struct ofputil_flow_mod *,
144                             const struct ofp_header *, bool flow_mod_table_id);
145 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
146                                        enum nx_flow_format,
147                                        bool flow_mod_table_id);
148
149 /* Flow stats or aggregate stats request, independent of flow format. */
150 struct ofputil_flow_stats_request {
151     bool aggregate;             /* Aggregate results? */
152     struct cls_rule match;
153     uint16_t out_port;
154     uint8_t table_id;
155 };
156
157 int ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *,
158                                       const struct ofp_header *);
159 struct ofpbuf *ofputil_encode_flow_stats_request(
160     const struct ofputil_flow_stats_request *, enum nx_flow_format);
161
162 /* Flow stats reply, independent of flow format. */
163 struct ofputil_flow_stats {
164     struct cls_rule rule;
165     ovs_be64 cookie;
166     uint8_t table_id;
167     uint32_t duration_sec;
168     uint32_t duration_nsec;
169     uint16_t idle_timeout;
170     uint16_t hard_timeout;
171     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
172     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
173     union ofp_action *actions;
174     size_t n_actions;
175 };
176
177 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
178                                     struct ofpbuf *msg);
179 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
180                                      struct list *replies);
181
182 /* Aggregate stats reply, independent of flow format. */
183 struct ofputil_aggregate_stats {
184     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
185     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
186     uint32_t flow_count;
187 };
188
189 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
190     const struct ofputil_aggregate_stats *stats,
191     const struct ofp_stats_msg *request);
192
193 /* Flow removed message, independent of flow format. */
194 struct ofputil_flow_removed {
195     struct cls_rule rule;
196     ovs_be64 cookie;
197     uint8_t reason;             /* One of OFPRR_*. */
198     uint32_t duration_sec;
199     uint32_t duration_nsec;
200     uint16_t idle_timeout;
201     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
202     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
203 };
204
205 int ofputil_decode_flow_removed(struct ofputil_flow_removed *,
206                                 const struct ofp_header *);
207 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
208                                            enum nx_flow_format);
209
210 /* Abstract packet-in message. */
211 struct ofputil_packet_in {
212     struct ofpbuf *packet;
213     uint16_t in_port;
214     uint8_t reason;             /* One of OFPR_*. */
215
216     uint32_t buffer_id;
217     int send_len;
218 };
219
220 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
221                                         struct ofpbuf *rw_packet);
222
223 /* OpenFlow protocol utility functions. */
224 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
225 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
226
227 void *make_openflow_xid(size_t openflow_len, uint8_t type,
228                         ovs_be32 xid, struct ofpbuf **);
229 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
230                      struct ofpbuf **);
231
232 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
233 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
234                        struct ofpbuf *);
235
236 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
237 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
238                     struct ofpbuf *);
239
240 void update_openflow_length(struct ofpbuf *);
241
242 void *ofputil_make_stats_request(size_t openflow_len, uint16_t type,
243                                  uint32_t subtype, struct ofpbuf **);
244 void *ofputil_make_stats_reply(size_t openflow_len,
245                                const struct ofp_stats_msg *request,
246                                struct ofpbuf **);
247
248 void ofputil_start_stats_reply(const struct ofp_stats_msg *request,
249                                struct list *);
250 struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *);
251 void *ofputil_append_stats_reply(size_t len, struct list *);
252
253 const void *ofputil_stats_body(const struct ofp_header *);
254 size_t ofputil_stats_body_len(const struct ofp_header *);
255
256 const void *ofputil_nxstats_body(const struct ofp_header *);
257 size_t ofputil_nxstats_body_len(const struct ofp_header *);
258
259 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
260                              size_t actions_len);
261 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
262                              uint16_t max_idle, size_t actions_len);
263 struct ofpbuf *make_del_flow(const struct cls_rule *);
264 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
265                                     uint32_t buffer_id, uint16_t out_port,
266                                     uint16_t max_idle);
267 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
268                               uint8_t reason,
269                               const struct ofpbuf *payload, int max_send_len);
270 struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
271                                uint16_t in_port,
272                                const struct ofp_action_header *,
273                                size_t n_actions);
274 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
275                                         uint16_t in_port, uint16_t out_port);
276 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
277                                           uint16_t in_port, uint16_t out_port);
278 struct ofpbuf *make_echo_request(void);
279 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
280 \f
281 /* Actions. */
282
283 enum ofputil_action_code {
284     /* OFPAT_* actions. */
285     OFPUTIL_OFPAT_OUTPUT,
286     OFPUTIL_OFPAT_SET_VLAN_VID,
287     OFPUTIL_OFPAT_SET_VLAN_PCP,
288     OFPUTIL_OFPAT_STRIP_VLAN,
289     OFPUTIL_OFPAT_SET_DL_SRC,
290     OFPUTIL_OFPAT_SET_DL_DST,
291     OFPUTIL_OFPAT_SET_NW_SRC,
292     OFPUTIL_OFPAT_SET_NW_DST,
293     OFPUTIL_OFPAT_SET_NW_TOS,
294     OFPUTIL_OFPAT_SET_TP_SRC,
295     OFPUTIL_OFPAT_SET_TP_DST,
296     OFPUTIL_OFPAT_ENQUEUE,
297
298     /* NXAST_* actions. */
299     OFPUTIL_NXAST_RESUBMIT,
300     OFPUTIL_NXAST_SET_TUNNEL,
301     OFPUTIL_NXAST_SET_QUEUE,
302     OFPUTIL_NXAST_POP_QUEUE,
303     OFPUTIL_NXAST_REG_MOVE,
304     OFPUTIL_NXAST_REG_LOAD,
305     OFPUTIL_NXAST_NOTE,
306     OFPUTIL_NXAST_SET_TUNNEL64,
307     OFPUTIL_NXAST_MULTIPATH,
308     OFPUTIL_NXAST_AUTOPATH,
309     OFPUTIL_NXAST_BUNDLE,
310     OFPUTIL_NXAST_BUNDLE_LOAD,
311     OFPUTIL_NXAST_RESUBMIT_TABLE,
312     OFPUTIL_NXAST_OUTPUT_REG
313 };
314
315 int ofputil_decode_action(const union ofp_action *);
316 enum ofputil_action_code ofputil_decode_action_unsafe(
317     const union ofp_action *);
318
319 #define OFP_ACTION_ALIGN 8      /* Alignment of ofp_actions. */
320
321 static inline union ofp_action *
322 ofputil_action_next(const union ofp_action *a)
323 {
324     return ((union ofp_action *) (void *)
325             ((uint8_t *) a + ntohs(a->header.len)));
326 }
327
328 static inline bool
329 ofputil_action_is_valid(const union ofp_action *a, size_t n_actions)
330 {
331     uint16_t len = ntohs(a->header.len);
332     return (!(len % OFP_ACTION_ALIGN)
333             && len >= sizeof *a
334             && len / sizeof *a <= n_actions);
335 }
336
337 /* This macro is careful to check for actions with bad lengths. */
338 #define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS)         \
339     for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
340          (LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT);             \
341          ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
342           (ITER) = ofputil_action_next(ITER)))
343
344 /* This macro does not check for actions with bad lengths.  It should only be
345  * used with actions from trusted sources or with actions that have already
346  * been validated (e.g. with OFPUTIL_ACTION_FOR_EACH).  */
347 #define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS)  \
348     for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
349          (LEFT) > 0;                                                    \
350          ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
351           (ITER) = ofputil_action_next(ITER)))
352
353 int validate_actions(const union ofp_action *, size_t n_actions,
354                      const struct flow *, int max_ports);
355 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
356
357 int ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
358                          union ofp_action **, size_t *);
359
360 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
361                            const union ofp_action *b, size_t n_b);
362 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
363 \f
364 /* OpenFlow vendors.
365  *
366  * These functions map OpenFlow 32-bit vendor IDs (as used in struct
367  * ofp_vendor_header) into 4-bit values to embed in an "int".  The 4-bit values
368  * are only used internally in Open vSwitch and never appear on the wire, so
369  * particular codes used are not important.
370  */
371
372 /* Vendor error numbers currently used in Open vSwitch. */
373 #define OFPUTIL_VENDORS                                     \
374     /*             vendor name              vendor value */ \
375     OFPUTIL_VENDOR(OFPUTIL_VENDOR_OPENFLOW, 0x00000000)     \
376     OFPUTIL_VENDOR(OFPUTIL_VENDOR_NICIRA,   NX_VENDOR_ID)
377
378 /* OFPUTIL_VENDOR_* definitions. */
379 enum ofputil_vendor_codes {
380 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) NAME,
381     OFPUTIL_VENDORS
382     OFPUTIL_N_VENDORS
383 #undef OFPUTIL_VENDOR
384 };
385 \f
386 /* Error codes.
387  *
388  * We embed system errno values and OpenFlow standard and vendor extension
389  * error codes into a single 31-bit space using the following encoding.
390  * (Bit 31 is unused and assumed 0 to avoid negative "int" values.)
391  *
392  *   30                                                   0
393  *  +------------------------------------------------------+
394  *  |                           0                          |  success
395  *  +------------------------------------------------------+
396  *
397  *   30 29                                                0
398  *  +--+---------------------------------------------------+
399  *  | 0|                    errno value                    |  errno value
400  *  +--+---------------------------------------------------+
401  *
402  *   30 29   26 25            16 15                       0
403  *  +--+-------+----------------+--------------------------+
404  *  | 1|   0   |      type      |           code           |  standard OpenFlow
405  *  +--+-------+----------------+--------------------------+  error
406  *
407  *   30 29   26 25            16 15                       0
408  *  +--+-------+----------------+--------------------------+  Nicira
409  *  | 1| vendor|      type      |           code           |  NXET_VENDOR
410  *  +--+-------+----------------+--------------------------+  error extension
411  *
412  * C and POSIX say that errno values are positive.  We assume that they are
413  * less than 2**29.  They are actually less than 65536 on at least Linux,
414  * FreeBSD, OpenBSD, and Windows.
415  *
416  * The 'vendor' field holds one of the OFPUTIL_VENDOR_* codes defined above.
417  * It must be nonzero.
418  *
419  * Negative values are not defined.
420  */
421
422 /* Currently 4 bits are allocated to the "vendor" field.  Make sure that all
423  * the vendor codes can fit. */
424 BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16);
425
426 /* These are macro versions of the functions defined below.  The macro versions
427  * are intended for use in contexts where function calls are not allowed,
428  * e.g. static initializers and case labels. */
429 #define OFP_MKERR(TYPE, CODE) ((1 << 30) | ((TYPE) << 16) | (CODE))
430 #define OFP_MKERR_VENDOR(VENDOR, TYPE, CODE) \
431         ((1 << 30) | ((VENDOR) << 26) | ((TYPE) << 16) | (CODE))
432 #define OFP_MKERR_NICIRA(TYPE, CODE) \
433         OFP_MKERR_VENDOR(OFPUTIL_VENDOR_NICIRA, TYPE, CODE)
434
435 /* Returns the standard OpenFlow error with the specified 'type' and 'code' as
436  * an integer. */
437 static inline int
438 ofp_mkerr(uint16_t type, uint16_t code)
439 {
440     return OFP_MKERR(type, code);
441 }
442
443 /* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and
444  * 'code' as an integer.  'vendor' must be an OFPUTIL_VENDOR_* constant. */
445 static inline int
446 ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
447 {
448     assert(vendor < OFPUTIL_N_VENDORS);
449     return OFP_MKERR_VENDOR(vendor, type, code);
450 }
451
452 /* Returns the OpenFlow vendor error with Nicira as vendor, with the specific
453  * 'type' and 'code', as an integer. */
454 static inline int
455 ofp_mkerr_nicira(uint16_t type, uint16_t code)
456 {
457     return OFP_MKERR_NICIRA(type, code);
458 }
459
460 /* Returns true if 'error' encodes an OpenFlow standard or vendor extension
461  * error codes as documented above. */
462 static inline bool
463 is_ofp_error(int error)
464 {
465     return (error & (1 << 30)) != 0;
466 }
467
468 /* Returns true if 'error' appears to be a system errno value. */
469 static inline bool
470 is_errno(int error)
471 {
472     return !is_ofp_error(error);
473 }
474
475 /* Returns the "vendor" part of the OpenFlow error code 'error' (which must be
476  * in the format explained above).  This is normally one of the
477  * OFPUTIL_VENDOR_* constants.  Returns OFPUTIL_VENDOR_OPENFLOW (0) for a
478  * standard OpenFlow error. */
479 static inline uint8_t
480 get_ofp_err_vendor(int error)
481 {
482     return (error >> 26) & 0xf;
483 }
484
485 /* Returns the "type" part of the OpenFlow error code 'error' (which must be in
486  * the format explained above). */
487 static inline uint16_t
488 get_ofp_err_type(int error)
489 {
490     return (error >> 16) & 0x3ff;
491 }
492
493 /* Returns the "code" part of the OpenFlow error code 'error' (which must be in
494  * the format explained above). */
495 static inline uint16_t
496 get_ofp_err_code(int error)
497 {
498     return error & 0xffff;
499 }
500
501 struct ofpbuf *ofputil_encode_error_msg(int error, const struct ofp_header *);
502 int ofputil_decode_error_msg(const struct ofp_header *, size_t *payload_ofs);
503
504 /* String versions of errors. */
505 void ofputil_format_error(struct ds *, int error);
506 char *ofputil_error_to_string(int error);
507
508 #endif /* ofp-util.h */