lib/ofp-util.h

   1 /*
   2  * Copyright (c) 2008, 2009, 2010 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 "flow.h"
  25
  26 struct ofpbuf;
  27 struct ofp_action_header;
  28
  29 /* OpenFlow protocol utility functions. */
  30 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
  31 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
  32 void *make_openflow_xid(size_t openflow_len, uint8_t type,
  33                         uint32_t xid, struct ofpbuf **);
  34 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, uint32_t xid,
  35                      struct ofpbuf **);
  36 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
  37 void *put_openflow_xid(size_t openflow_len, uint8_t type, uint32_t xid,
  38                        struct ofpbuf *);
  39 void update_openflow_length(struct ofpbuf *);
  40 struct ofpbuf *make_flow_mod(uint16_t command, const struct flow *,
  41                              size_t actions_len);
  42 struct ofpbuf *make_add_flow(const struct flow *, uint32_t buffer_id,
  43                              uint16_t max_idle, size_t actions_len);
  44 struct ofpbuf *make_del_flow(const struct flow *);
  45 struct ofpbuf *make_add_simple_flow(const struct flow *,
  46                                     uint32_t buffer_id, uint16_t out_port,
  47                                     uint16_t max_idle);
  48 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
  49                               uint8_t reason,
  50                               const struct ofpbuf *payload, int max_send_len);
  51 struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
  52                                uint16_t in_port,
  53                                const struct ofp_action_header *,
  54                                size_t n_actions);
  55 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
  56                                         uint16_t in_port, uint16_t out_port);
  57 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
  58                                           uint16_t in_port, uint16_t out_port);
  59 struct ofpbuf *make_echo_request(void);
  60 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
  61 int check_ofp_message(const struct ofp_header *, uint8_t type, size_t size);
  62 int check_ofp_message_array(const struct ofp_header *, uint8_t type,
  63                             size_t size, size_t array_elt_size,
  64                             size_t *n_array_elts);
  65 int check_ofp_packet_out(const struct ofp_header *, struct ofpbuf *data,
  66                          int *n_actions, int max_ports);
  67
  68 struct flow_stats_iterator {
  69     const uint8_t *pos, *end;
  70 };
  71 const struct ofp_flow_stats *flow_stats_first(struct flow_stats_iterator *,
  72                                               const struct ofp_stats_reply *);
  73 const struct ofp_flow_stats *flow_stats_next(struct flow_stats_iterator *);
  74
  75 struct actions_iterator {
  76     const union ofp_action *pos, *end;
  77 };
  78 const union ofp_action *actions_first(struct actions_iterator *,
  79                                       const union ofp_action *,
  80                                       size_t n_actions);
  81 const union ofp_action *actions_next(struct actions_iterator *);
  82 int validate_actions(const union ofp_action *, size_t n_actions,
  83                      int max_ports);
  84 bool action_outputs_to_port(const union ofp_action *, uint16_t port);
  85
  86 void normalize_match(struct ofp_match *);
  87 char *ofp_match_to_literal_string(const struct ofp_match *match);
  88 \f
  89 /* OpenFlow vendors.
  90  *
  91  * These functions map OpenFlow 32-bit vendor IDs (as used in struct
  92  * ofp_vendor_header) into 4-bit values to embed in an "int".  The 4-bit values
  93  * are only used internally in Open vSwitch and never appear on the wire, so
  94  * particular codes used are not important.
  95  */
  96
  97 /* Vendor error numbers currently used in Open vSwitch. */
  98 #define OFPUTIL_VENDORS                                     \
  99     /*             vendor name              vendor value */ \
 100     OFPUTIL_VENDOR(OFPUTIL_VENDOR_OPENFLOW, 0x00000000)     \
 101     OFPUTIL_VENDOR(OFPUTIL_VENDOR_NICIRA,   NX_VENDOR_ID)
 102
 103 /* OFPUTIL_VENDOR_* definitions. */
 104 enum ofputil_vendor_codes {
 105 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) NAME,
 106     OFPUTIL_VENDORS
 107     OFPUTIL_N_VENDORS
 108 #undef OFPUTIL_VENDOR
 109 };
 110 \f
 111 /* Error codes.
 112  *
 113  * We embed system errno values and OpenFlow standard and vendor extension
 114  * error codes into a single 31-bit space using the following encoding.
 115  * (Bit 31 is unused and assumed 0 to avoid negative "int" values.)
 116  *
 117  *   30                                                   0
 118  *  +------------------------------------------------------+
 119  *  |                           0                          |  success
 120  *  +------------------------------------------------------+
 121  *
 122  *   30 29                                                0
 123  *  +--+---------------------------------------------------+
 124  *  | 0|                    errno value                    |  errno value
 125  *  +--+---------------------------------------------------+
 126  *
 127  *   30 29   26 25            16 15                       0
 128  *  +--+-------+----------------+--------------------------+
 129  *  | 1|   0   |      type      |           code           |  standard OpenFlow
 130  *  +--+-------+----------------+--------------------------+  error
 131  *
 132  *   30 29   26 25            16 15                       0
 133  *  +--+-------+----------------+--------------------------+  Nicira
 134  *  | 1| vendor|      type      |           code           |  NXET_VENDOR
 135  *  +--+-------+----------------+--------------------------+  error extension
 136  *
 137  * C and POSIX say that errno values are positive.  We assume that they are
 138  * less than 2**29.  They are actually less than 65536 on at least Linux,
 139  * FreeBSD, OpenBSD, and Windows.
 140  *
 141  * The 'vendor' field holds one of the OFPUTIL_VENDOR_* codes defined above.
 142  * It must be nonzero.
 143  *
 144  * Negative values are not defined.
 145  */
 146
 147 /* Currently 4 bits are allocated to the "vendor" field.  Make sure that all
 148  * the vendor codes can fit. */
 149 BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16);
 150
 151 /* These are macro versions of the functions defined below.  The macro versions
 152  * are intended for use in contexts where function calls are not allowed,
 153  * e.g. static initializers and case labels. */
 154 #define OFP_MKERR(TYPE, CODE) ((1 << 30) | ((TYPE) << 16) | (CODE))
 155 #define OFP_MKERR_VENDOR(VENDOR, TYPE, CODE) \
 156         ((1 << 30) | ((VENDOR) << 26) | ((TYPE) << 16) | (CODE))
 157 #define OFP_MKERR_NICIRA(TYPE, CODE) \
 158         OFP_MKERR_VENDOR(OFPUTIL_VENDOR_NICIRA, TYPE, CODE)
 159
 160 /* Returns the standard OpenFlow error with the specified 'type' and 'code' as
 161  * an integer. */
 162 static inline int
 163 ofp_mkerr(uint16_t type, uint16_t code)
 164 {
 165     return OFP_MKERR(type, code);
 166 }
 167
 168 /* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and
 169  * 'code' as an integer.  'vendor' must be an OFPUTIL_VENDOR_* constant. */
 170 static inline int
 171 ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
 172 {
 173     assert(vendor < OFPUTIL_N_VENDORS);
 174     return OFP_MKERR_VENDOR(vendor, type, code);
 175 }
 176
 177 /* Returns the OpenFlow vendor error with Nicira as vendor, with the specific
 178  * 'type' and 'code', as an integer. */
 179 static inline int
 180 ofp_mkerr_nicira(uint16_t type, uint16_t code)
 181 {
 182     return OFP_MKERR_NICIRA(type, code);
 183 }
 184
 185 /* Returns true if 'error' encodes an OpenFlow standard or vendor extension
 186  * error codes as documented above. */
 187 static inline bool
 188 is_ofp_error(int error)
 189 {
 190     return (error & (1 << 30)) != 0;
 191 }
 192
 193 /* Returns true if 'error' appears to be a system errno value. */
 194 static inline bool
 195 is_errno(int error)
 196 {
 197     return !is_ofp_error(error);
 198 }
 199
 200 /* Returns the "vendor" part of the OpenFlow error code 'error' (which must be
 201  * in the format explained above).  This is normally one of the
 202  * OFPUTIL_VENDOR_* constants.  Returns OFPUTIL_VENDOR_OPENFLOW (0) for a
 203  * standard OpenFlow error. */
 204 static inline uint8_t
 205 get_ofp_err_vendor(int error)
 206 {
 207     return (error >> 26) & 0xf;
 208 }
 209
 210 /* Returns the "type" part of the OpenFlow error code 'error' (which must be in
 211  * the format explained above). */
 212 static inline uint16_t
 213 get_ofp_err_type(int error)
 214 {
 215     return (error >> 16) & 0x3ff;
 216 }
 217
 218 /* Returns the "code" part of the OpenFlow error code 'error' (which must be in
 219  * the format explained above). */
 220 static inline uint16_t
 221 get_ofp_err_code(int error)
 222 {
 223     return error & 0xffff;
 224 }
 225
 226 struct ofpbuf *make_ofp_error_msg(int error, const struct ofp_header *);
 227
 228 #endif /* ofp-util.h */