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