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 flow_t *,
  38                              size_t actions_len);
  39 struct ofpbuf *make_add_flow(const flow_t *, uint32_t buffer_id,
  40                              uint16_t max_idle, size_t actions_len);
  41 struct ofpbuf *make_del_flow(const flow_t *);
  42 struct ofpbuf *make_add_simple_flow(const flow_t *,
  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
  86 void hton_ofp_phy_port(struct ofp_phy_port *);
  87 void ntoh_ofp_phy_port(struct ofp_phy_port *);
  88 \f
  89 /* OpenFlow vendors.
  90  *
  91  * These functions map vendor */
  92 /* Vendor error numbers currently used in Open vSwitch. */
  93 #define OFPUTIL_VENDORS                                     \
  94     /*             vendor name              vendor value */ \
  95     OFPUTIL_VENDOR(OFPUTIL_VENDOR_OPENFLOW, 0x00000000)     \
  96     OFPUTIL_VENDOR(OFPUTIL_VENDOR_NICIRA,   0x00002320)
  97
  98 /* OFPUTIL_VENDOR_* definitions. */
  99 enum ofputil_vendor_codes {
 100 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) NAME,
 101     OFPUTIL_VENDORS
 102     OFPUTIL_N_VENDORS
 103 #undef OFPUTIL_VENDOR
 104 };
 105 \f
 106 /* Error codes.
 107  *
 108  * We embed system errno values and OpenFlow standard and vendor extension
 109  * error codes into a single 31-bit space using the following encoding.
 110  * (Bit 31 is unused and assumed 0 to avoid negative "int" values.)
 111  *
 112  *   31                                                   0
 113  *  +------------------------------------------------------+
 114  *  |                           0                          |  success
 115  *  +------------------------------------------------------+
 116  *
 117  *   30 29                                                0
 118  *  +--+---------------------------------------------------+
 119  *  |0 |                    errno value                    |  errno value
 120  *  +--+---------------------------------------------------+
 121  *
 122  *   30 29   26 25            16 15                       0
 123  *  +--+-------+----------------+--------------------------+
 124  *  |1 |   0   |      type      |           code           |  standard OpenFlow
 125  *  +--+-------+----------------+--------------------------+  error
 126  *
 127  *   30 29   26 25            16 15                       0
 128  *  +--+-------+----------------+--------------------------+  Nicira
 129  *  | 1| vendor|      type      |           code           |  NXET_VENDOR
 130  *  +--+-------+----------------+--------------------------+  error extension
 131  *
 132  * C and POSIX say that errno values are positive.  We assume that they are
 133  * less than 2**29.  They are actually less than 65536 on at least Linux,
 134  * FreeBSD, OpenBSD, and Windows.
 135  *
 136  * The 'vendor' field holds one of the OFPUTIL_VENDOR_* codes defined above.
 137  * It must be nonzero.
 138  *
 139  * Negative values are not defined.
 140  */
 141
 142 /* Currently 4 bits are allocated to the "vendor" field.  Make sure that all
 143  * the vendor codes can fit. */
 144 BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16);
 145
 146 /* Returns the standard OpenFlow error with the specified 'type' and 'code' as
 147  * an integer. */
 148 static inline int
 149 ofp_mkerr(uint16_t type, uint16_t code)
 150 {
 151     return (1 << 30) | (type << 16) | code;
 152 }
 153
 154 /* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and
 155  * 'code' as an integer.  'vendor' must be an OFPUTIL_VENDOR_* constant. */
 156 static inline int
 157 ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
 158 {
 159     assert(vendor < OFPUTIL_N_VENDORS);
 160     return (1 << 30) | (vendor << 26) | (type << 16) | code;
 161 }
 162
 163 /* Returns the OpenFlow vendor error with Nicira as vendor, with the specific
 164  * 'type' and 'code', as an integer. */
 165 static inline int
 166 ofp_mkerr_nicira(uint16_t type, uint16_t code)
 167 {
 168     return ofp_mkerr_vendor(OFPUTIL_VENDOR_NICIRA, type, code);
 169 }
 170
 171 /* Returns true if 'error' encodes an OpenFlow standard or vendor extension
 172  * error codes as documented above. */
 173 static inline bool
 174 is_ofp_error(int error)
 175 {
 176     return (error & (1 << 30)) != 0;
 177 }
 178
 179 /* Returns true if 'error' appears to be a system errno value. */
 180 static inline bool
 181 is_errno(int error)
 182 {
 183     return !is_ofp_error(error);
 184 }
 185
 186 /* Returns the "vendor" part of the OpenFlow error code 'error' (which must be
 187  * in the format explained above).  This is normally one of the
 188  * OFPUTIL_VENDOR_* constants.  Returns OFPUTIL_VENDOR_OPENFLOW (0) for a
 189  * standard OpenFlow error. */
 190 static inline uint8_t
 191 get_ofp_err_vendor(int error)
 192 {
 193     return (error >> 26) & 0xf;
 194 }
 195
 196 /* Returns the "type" part of the OpenFlow error code 'error' (which must be in
 197  * the format explained above). */
 198 static inline uint16_t
 199 get_ofp_err_type(int error)
 200 {
 201     return (error >> 16) & 0x3ff;
 202 }
 203
 204 /* Returns the "code" part of the OpenFlow error code 'error' (which must be in
 205  * the format explained above). */
 206 static inline uint16_t
 207 get_ofp_err_code(int error)
 208 {
 209     return error & 0xffff;
 210 }
 211
 212 struct ofpbuf *make_ofp_error_msg(int error, const struct ofp_header *);
 213
 214 #endif /* ofp-util.h */