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 "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 /* Alignment of ofp_actions. */
  33 #define OFP_ACTION_ALIGN 8
  34
  35 /* Basic decoding and length validation of OpenFlow messages. */
  36 enum ofputil_msg_code {
  37     OFPUTIL_INVALID,
  38
  39     /* OFPT_* messages. */
  40     OFPUTIL_OFPT_HELLO,
  41     OFPUTIL_OFPT_ERROR,
  42     OFPUTIL_OFPT_ECHO_REQUEST,
  43     OFPUTIL_OFPT_ECHO_REPLY,
  44     OFPUTIL_OFPT_FEATURES_REQUEST,
  45     OFPUTIL_OFPT_FEATURES_REPLY,
  46     OFPUTIL_OFPT_GET_CONFIG_REQUEST,
  47     OFPUTIL_OFPT_GET_CONFIG_REPLY,
  48     OFPUTIL_OFPT_SET_CONFIG,
  49     OFPUTIL_OFPT_PACKET_IN,
  50     OFPUTIL_OFPT_FLOW_REMOVED,
  51     OFPUTIL_OFPT_PORT_STATUS,
  52     OFPUTIL_OFPT_PACKET_OUT,
  53     OFPUTIL_OFPT_FLOW_MOD,
  54     OFPUTIL_OFPT_PORT_MOD,
  55     OFPUTIL_OFPT_BARRIER_REQUEST,
  56     OFPUTIL_OFPT_BARRIER_REPLY,
  57     OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST,
  58     OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY,
  59
  60     /* OFPST_* stat requests. */
  61     OFPUTIL_OFPST_DESC_REQUEST,
  62     OFPUTIL_OFPST_FLOW_REQUEST,
  63     OFPUTIL_OFPST_AGGREGATE_REQUEST,
  64     OFPUTIL_OFPST_TABLE_REQUEST,
  65     OFPUTIL_OFPST_PORT_REQUEST,
  66     OFPUTIL_OFPST_QUEUE_REQUEST,
  67
  68     /* OFPST_* stat replies. */
  69     OFPUTIL_OFPST_DESC_REPLY,
  70     OFPUTIL_OFPST_FLOW_REPLY,
  71     OFPUTIL_OFPST_QUEUE_REPLY,
  72     OFPUTIL_OFPST_PORT_REPLY,
  73     OFPUTIL_OFPST_TABLE_REPLY,
  74     OFPUTIL_OFPST_AGGREGATE_REPLY,
  75
  76     /* NXT_* messages. */
  77     OFPUTIL_NXT_STATUS_REQUEST,
  78     OFPUTIL_NXT_STATUS_REPLY,
  79     OFPUTIL_NXT_TUN_ID_FROM_COOKIE,
  80     OFPUTIL_NXT_ROLE_REQUEST,
  81     OFPUTIL_NXT_ROLE_REPLY,
  82     OFPUTIL_NXT_SET_FLOW_FORMAT,
  83     OFPUTIL_NXT_FLOW_MOD,
  84     OFPUTIL_NXT_FLOW_REMOVED,
  85
  86     /* NXST_* stat requests. */
  87     OFPUTIL_NXST_FLOW_REQUEST,
  88     OFPUTIL_NXST_AGGREGATE_REQUEST,
  89
  90     /* NXST_* stat replies. */
  91     OFPUTIL_NXST_FLOW_REPLY,
  92     OFPUTIL_NXST_AGGREGATE_REPLY
  93 };
  94
  95 struct ofputil_msg_type;
  96 int ofputil_decode_msg_type(const struct ofp_header *,
  97                             const struct ofputil_msg_type **);
  98 enum ofputil_msg_code ofputil_msg_type_code(const struct ofputil_msg_type *);
  99 const char *ofputil_msg_type_name(const struct ofputil_msg_type *);
 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_cls_rule_from_match(const struct ofp_match *,
 108                                  unsigned int priority, enum nx_flow_format,
 109                                  ovs_be64 cookie, struct cls_rule *);
 110 void ofputil_cls_rule_to_match(const struct cls_rule *, enum nx_flow_format,
 111                                struct ofp_match *);
 112 void normalize_match(struct ofp_match *);
 113 char *ofp_match_to_literal_string(const struct ofp_match *match);
 114
 115 /* Flow formats. */
 116 bool ofputil_flow_format_is_valid(enum nx_flow_format);
 117 const char *ofputil_flow_format_to_string(enum nx_flow_format);
 118 int ofputil_flow_format_from_string(const char *);
 119 enum nx_flow_format ofputil_min_flow_format(const struct cls_rule *,
 120                                             bool cookie_support,
 121                                             ovs_be64 cookie);
 122
 123 struct ofpbuf *ofputil_make_set_flow_format(enum nx_flow_format);
 124
 125 /* Flow format independent flow_mod. */
 126 struct flow_mod {
 127     struct cls_rule cr;
 128     ovs_be64 cookie;
 129     uint16_t command;
 130     uint16_t idle_timeout;
 131     uint16_t hard_timeout;
 132     uint32_t buffer_id;
 133     uint16_t out_port;
 134     uint16_t flags;
 135     union ofp_action *actions;
 136     size_t n_actions;
 137 };
 138
 139 int ofputil_decode_flow_mod(struct flow_mod *, const struct ofp_header *,
 140                             enum nx_flow_format);
 141 struct ofpbuf *ofputil_encode_flow_mod(const struct flow_mod *,
 142                                        enum nx_flow_format);
 143
 144 /* Flow stats or aggregate stats request, independent of flow format. */
 145 struct flow_stats_request {
 146     bool aggregate;             /* Aggregate results? */
 147     struct cls_rule match;
 148     uint16_t out_port;
 149     uint8_t table_id;
 150 };
 151
 152 int ofputil_decode_flow_stats_request(struct flow_stats_request *,
 153                                       const struct ofp_header *,
 154                                       enum nx_flow_format);
 155 struct ofpbuf *ofputil_encode_flow_stats_request(
 156     const struct flow_stats_request *, enum nx_flow_format);
 157
 158 /* Flow removed message, independent of flow format. */
 159 struct ofputil_flow_removed {
 160     struct cls_rule rule;
 161     ovs_be64 cookie;
 162     uint8_t reason;             /* One of OFPRR_*. */
 163     uint32_t duration_sec;
 164     uint32_t duration_nsec;
 165     uint16_t idle_timeout;
 166     uint64_t packet_count;
 167     uint64_t byte_count;
 168 };
 169
 170 int ofputil_decode_flow_removed(struct ofputil_flow_removed *,
 171                                 const struct ofp_header *,
 172                                 enum nx_flow_format);
 173
 174 /* OpenFlow protocol utility functions. */
 175 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
 176 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
 177
 178 void *make_openflow_xid(size_t openflow_len, uint8_t type,
 179                         ovs_be32 xid, struct ofpbuf **);
 180 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 181                      struct ofpbuf **);
 182
 183 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
 184 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
 185                        struct ofpbuf *);
 186
 187 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
 188 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 189                     struct ofpbuf *);
 190
 191 void update_openflow_length(struct ofpbuf *);
 192
 193 void *ofputil_make_stats_request(size_t body_len, uint16_t type,
 194                                  struct ofpbuf **);
 195 void *ofputil_make_nxstats_request(size_t openflow_len, uint32_t subtype,
 196                                    struct ofpbuf **);
 197
 198 const void *ofputil_stats_body(const struct ofp_header *);
 199 size_t ofputil_stats_body_len(const struct ofp_header *);
 200
 201 const void *ofputil_nxstats_body(const struct ofp_header *);
 202 size_t ofputil_nxstats_body_len(const struct ofp_header *);
 203
 204 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
 205                              size_t actions_len);
 206 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
 207                              uint16_t max_idle, size_t actions_len);
 208 struct ofpbuf *make_del_flow(const struct cls_rule *);
 209 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
 210                                     uint32_t buffer_id, uint16_t out_port,
 211                                     uint16_t max_idle);
 212 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
 213                               uint8_t reason,
 214                               const struct ofpbuf *payload, int max_send_len);
 215 struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
 216                                uint16_t in_port,
 217                                const struct ofp_action_header *,
 218                                size_t n_actions);
 219 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
 220                                         uint16_t in_port, uint16_t out_port);
 221 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
 222                                           uint16_t in_port, uint16_t out_port);
 223 struct ofpbuf *make_echo_request(void);
 224 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
 225
 226 struct flow_stats_iterator {
 227     const uint8_t *pos, *end;
 228 };
 229 const struct ofp_flow_stats *flow_stats_first(struct flow_stats_iterator *,
 230                                               const struct ofp_stats_reply *);
 231 const struct ofp_flow_stats *flow_stats_next(struct flow_stats_iterator *);
 232
 233 struct actions_iterator {
 234     const union ofp_action *pos, *end;
 235 };
 236 const union ofp_action *actions_first(struct actions_iterator *,
 237                                       const union ofp_action *,
 238                                       size_t n_actions);
 239 const union ofp_action *actions_next(struct actions_iterator *);
 240 int validate_actions(const union ofp_action *, size_t n_actions,
 241                      const struct flow *, int max_ports);
 242 bool action_outputs_to_port(const union ofp_action *, uint16_t port);
 243
 244 int ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
 245                          union ofp_action **, size_t *);
 246 \f
 247 /* OpenFlow vendors.
 248  *
 249  * These functions map OpenFlow 32-bit vendor IDs (as used in struct
 250  * ofp_vendor_header) into 4-bit values to embed in an "int".  The 4-bit values
 251  * are only used internally in Open vSwitch and never appear on the wire, so
 252  * particular codes used are not important.
 253  */
 254
 255 /* Vendor error numbers currently used in Open vSwitch. */
 256 #define OFPUTIL_VENDORS                                     \
 257     /*             vendor name              vendor value */ \
 258     OFPUTIL_VENDOR(OFPUTIL_VENDOR_OPENFLOW, 0x00000000)     \
 259     OFPUTIL_VENDOR(OFPUTIL_VENDOR_NICIRA,   NX_VENDOR_ID)
 260
 261 /* OFPUTIL_VENDOR_* definitions. */
 262 enum ofputil_vendor_codes {
 263 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) NAME,
 264     OFPUTIL_VENDORS
 265     OFPUTIL_N_VENDORS
 266 #undef OFPUTIL_VENDOR
 267 };
 268 \f
 269 /* Error codes.
 270  *
 271  * We embed system errno values and OpenFlow standard and vendor extension
 272  * error codes into a single 31-bit space using the following encoding.
 273  * (Bit 31 is unused and assumed 0 to avoid negative "int" values.)
 274  *
 275  *   30                                                   0
 276  *  +------------------------------------------------------+
 277  *  |                           0                          |  success
 278  *  +------------------------------------------------------+
 279  *
 280  *   30 29                                                0
 281  *  +--+---------------------------------------------------+
 282  *  | 0|                    errno value                    |  errno value
 283  *  +--+---------------------------------------------------+
 284  *
 285  *   30 29   26 25            16 15                       0
 286  *  +--+-------+----------------+--------------------------+
 287  *  | 1|   0   |      type      |           code           |  standard OpenFlow
 288  *  +--+-------+----------------+--------------------------+  error
 289  *
 290  *   30 29   26 25            16 15                       0
 291  *  +--+-------+----------------+--------------------------+  Nicira
 292  *  | 1| vendor|      type      |           code           |  NXET_VENDOR
 293  *  +--+-------+----------------+--------------------------+  error extension
 294  *
 295  * C and POSIX say that errno values are positive.  We assume that they are
 296  * less than 2**29.  They are actually less than 65536 on at least Linux,
 297  * FreeBSD, OpenBSD, and Windows.
 298  *
 299  * The 'vendor' field holds one of the OFPUTIL_VENDOR_* codes defined above.
 300  * It must be nonzero.
 301  *
 302  * Negative values are not defined.
 303  */
 304
 305 /* Currently 4 bits are allocated to the "vendor" field.  Make sure that all
 306  * the vendor codes can fit. */
 307 BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16);
 308
 309 /* These are macro versions of the functions defined below.  The macro versions
 310  * are intended for use in contexts where function calls are not allowed,
 311  * e.g. static initializers and case labels. */
 312 #define OFP_MKERR(TYPE, CODE) ((1 << 30) | ((TYPE) << 16) | (CODE))
 313 #define OFP_MKERR_VENDOR(VENDOR, TYPE, CODE) \
 314         ((1 << 30) | ((VENDOR) << 26) | ((TYPE) << 16) | (CODE))
 315 #define OFP_MKERR_NICIRA(TYPE, CODE) \
 316         OFP_MKERR_VENDOR(OFPUTIL_VENDOR_NICIRA, TYPE, CODE)
 317
 318 /* Returns the standard OpenFlow error with the specified 'type' and 'code' as
 319  * an integer. */
 320 static inline int
 321 ofp_mkerr(uint16_t type, uint16_t code)
 322 {
 323     return OFP_MKERR(type, code);
 324 }
 325
 326 /* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and
 327  * 'code' as an integer.  'vendor' must be an OFPUTIL_VENDOR_* constant. */
 328 static inline int
 329 ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
 330 {
 331     assert(vendor < OFPUTIL_N_VENDORS);
 332     return OFP_MKERR_VENDOR(vendor, type, code);
 333 }
 334
 335 /* Returns the OpenFlow vendor error with Nicira as vendor, with the specific
 336  * 'type' and 'code', as an integer. */
 337 static inline int
 338 ofp_mkerr_nicira(uint16_t type, uint16_t code)
 339 {
 340     return OFP_MKERR_NICIRA(type, code);
 341 }
 342
 343 /* Returns true if 'error' encodes an OpenFlow standard or vendor extension
 344  * error codes as documented above. */
 345 static inline bool
 346 is_ofp_error(int error)
 347 {
 348     return (error & (1 << 30)) != 0;
 349 }
 350
 351 /* Returns true if 'error' appears to be a system errno value. */
 352 static inline bool
 353 is_errno(int error)
 354 {
 355     return !is_ofp_error(error);
 356 }
 357
 358 /* Returns the "vendor" part of the OpenFlow error code 'error' (which must be
 359  * in the format explained above).  This is normally one of the
 360  * OFPUTIL_VENDOR_* constants.  Returns OFPUTIL_VENDOR_OPENFLOW (0) for a
 361  * standard OpenFlow error. */
 362 static inline uint8_t
 363 get_ofp_err_vendor(int error)
 364 {
 365     return (error >> 26) & 0xf;
 366 }
 367
 368 /* Returns the "type" part of the OpenFlow error code 'error' (which must be in
 369  * the format explained above). */
 370 static inline uint16_t
 371 get_ofp_err_type(int error)
 372 {
 373     return (error >> 16) & 0x3ff;
 374 }
 375
 376 /* Returns the "code" part of the OpenFlow error code 'error' (which must be in
 377  * the format explained above). */
 378 static inline uint16_t
 379 get_ofp_err_code(int error)
 380 {
 381     return error & 0xffff;
 382 }
 383
 384 struct ofpbuf *make_ofp_error_msg(int error, const struct ofp_header *);
 385
 386 #endif /* ofp-util.h */