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_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,
  78     OFPUTIL_NXT_FLOW_REMOVED,
  79
  80     /* NXST_* stat requests. */
  81     OFPUTIL_NXST_FLOW_REQUEST,
  82     OFPUTIL_NXST_AGGREGATE_REQUEST,
  83
  84     /* NXST_* stat replies. */
  85     OFPUTIL_NXST_FLOW_REPLY,
  86     OFPUTIL_NXST_AGGREGATE_REPLY
  87 };
  88
  89 struct ofputil_msg_type;
  90 int ofputil_decode_msg_type(const struct ofp_header *,
  91                             const struct ofputil_msg_type **);
  92 enum ofputil_msg_code ofputil_msg_type_code(const struct ofputil_msg_type *);
  93 const char *ofputil_msg_type_name(const struct ofputil_msg_type *);
  94
  95 /* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to
  96  * and from IP bitmasks. */
  97 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
  98 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
  99
 100 /* Work with OpenFlow 1.0 ofp_match. */
 101 void ofputil_cls_rule_from_match(const struct ofp_match *,
 102                                  unsigned int priority, struct cls_rule *);
 103 void ofputil_cls_rule_to_match(const struct cls_rule *, struct ofp_match *);
 104 void normalize_match(struct ofp_match *);
 105 char *ofp_match_to_literal_string(const struct ofp_match *match);
 106
 107 /* dl_type translation between OpenFlow and 'struct flow' format. */
 108 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
 109 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
 110
 111 /* Flow formats. */
 112 bool ofputil_flow_format_is_valid(enum nx_flow_format);
 113 const char *ofputil_flow_format_to_string(enum nx_flow_format);
 114 int ofputil_flow_format_from_string(const char *);
 115 enum nx_flow_format ofputil_min_flow_format(const struct cls_rule *);
 116
 117 struct ofpbuf *ofputil_make_set_flow_format(enum nx_flow_format);
 118
 119 /* Flow format independent flow_mod. */
 120 struct flow_mod {
 121     struct cls_rule cr;
 122     ovs_be64 cookie;
 123     uint16_t command;
 124     uint16_t idle_timeout;
 125     uint16_t hard_timeout;
 126     uint32_t buffer_id;
 127     uint16_t out_port;
 128     uint16_t flags;
 129     union ofp_action *actions;
 130     size_t n_actions;
 131 };
 132
 133 int ofputil_decode_flow_mod(struct flow_mod *, const struct ofp_header *);
 134 struct ofpbuf *ofputil_encode_flow_mod(const struct flow_mod *,
 135                                        enum nx_flow_format);
 136
 137 /* Flow stats or aggregate stats request, independent of flow format. */
 138 struct flow_stats_request {
 139     bool aggregate;             /* Aggregate results? */
 140     struct cls_rule match;
 141     uint16_t out_port;
 142     uint8_t table_id;
 143 };
 144
 145 int ofputil_decode_flow_stats_request(struct flow_stats_request *,
 146                                       const struct ofp_header *);
 147 struct ofpbuf *ofputil_encode_flow_stats_request(
 148     const struct flow_stats_request *, enum nx_flow_format);
 149
 150 /* Flow stats reply, independent of flow format. */
 151 struct ofputil_flow_stats {
 152     struct cls_rule rule;
 153     ovs_be64 cookie;
 154     uint8_t table_id;
 155     uint32_t duration_sec;
 156     uint32_t duration_nsec;
 157     uint16_t idle_timeout;
 158     uint16_t hard_timeout;
 159     uint64_t packet_count;
 160     uint64_t byte_count;
 161     union ofp_action *actions;
 162     size_t n_actions;
 163 };
 164
 165 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
 166                                     struct ofpbuf *msg);
 167
 168 /* Flow removed message, independent of flow format. */
 169 struct ofputil_flow_removed {
 170     struct cls_rule rule;
 171     ovs_be64 cookie;
 172     uint8_t reason;             /* One of OFPRR_*. */
 173     uint32_t duration_sec;
 174     uint32_t duration_nsec;
 175     uint16_t idle_timeout;
 176     uint64_t packet_count;
 177     uint64_t byte_count;
 178 };
 179
 180 int ofputil_decode_flow_removed(struct ofputil_flow_removed *,
 181                                 const struct ofp_header *);
 182 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
 183                                            enum nx_flow_format);
 184
 185 /* Abstract packet-in message. */
 186 struct ofputil_packet_in {
 187     struct ofpbuf *packet;
 188     uint16_t in_port;
 189     uint8_t reason;             /* One of OFPR_*. */
 190
 191     uint32_t buffer_id;
 192     int send_len;
 193 };
 194
 195 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
 196                                         struct ofpbuf *rw_packet);
 197
 198 /* OpenFlow protocol utility functions. */
 199 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
 200 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
 201
 202 void *make_openflow_xid(size_t openflow_len, uint8_t type,
 203                         ovs_be32 xid, struct ofpbuf **);
 204 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 205                      struct ofpbuf **);
 206
 207 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
 208 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
 209                        struct ofpbuf *);
 210
 211 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
 212 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 213                     struct ofpbuf *);
 214
 215 void update_openflow_length(struct ofpbuf *);
 216
 217 void *ofputil_make_stats_request(size_t body_len, uint16_t type,
 218                                  struct ofpbuf **);
 219 void *ofputil_make_nxstats_request(size_t openflow_len, uint32_t subtype,
 220                                    struct ofpbuf **);
 221
 222 const void *ofputil_stats_body(const struct ofp_header *);
 223 size_t ofputil_stats_body_len(const struct ofp_header *);
 224
 225 const void *ofputil_nxstats_body(const struct ofp_header *);
 226 size_t ofputil_nxstats_body_len(const struct ofp_header *);
 227
 228 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
 229                              size_t actions_len);
 230 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
 231                              uint16_t max_idle, size_t actions_len);
 232 struct ofpbuf *make_del_flow(const struct cls_rule *);
 233 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
 234                                     uint32_t buffer_id, uint16_t out_port,
 235                                     uint16_t max_idle);
 236 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
 237                               uint8_t reason,
 238                               const struct ofpbuf *payload, int max_send_len);
 239 struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
 240                                uint16_t in_port,
 241                                const struct ofp_action_header *,
 242                                size_t n_actions);
 243 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
 244                                         uint16_t in_port, uint16_t out_port);
 245 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
 246                                           uint16_t in_port, uint16_t out_port);
 247 struct ofpbuf *make_echo_request(void);
 248 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
 249
 250 void hton_ofp_phy_port(struct ofp_phy_port *);
 251 \f
 252 /* Actions. */
 253
 254 #define OFP_ACTION_ALIGN 8      /* Alignment of ofp_actions. */
 255
 256 struct actions_iterator {
 257     const union ofp_action *pos, *end;
 258 };
 259 const union ofp_action *actions_first(struct actions_iterator *,
 260                                       const union ofp_action *,
 261                                       size_t n_actions);
 262 const union ofp_action *actions_next(struct actions_iterator *);
 263
 264 int validate_actions(const union ofp_action *, size_t n_actions,
 265                      const struct flow *, int max_ports);
 266 bool action_outputs_to_port(const union ofp_action *, uint16_t port);
 267
 268 int ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
 269                          union ofp_action **, size_t *);
 270 \f
 271 /* OpenFlow vendors.
 272  *
 273  * These functions map OpenFlow 32-bit vendor IDs (as used in struct
 274  * ofp_vendor_header) into 4-bit values to embed in an "int".  The 4-bit values
 275  * are only used internally in Open vSwitch and never appear on the wire, so
 276  * particular codes used are not important.
 277  */
 278
 279 /* Vendor error numbers currently used in Open vSwitch. */
 280 #define OFPUTIL_VENDORS                                     \
 281     /*             vendor name              vendor value */ \
 282     OFPUTIL_VENDOR(OFPUTIL_VENDOR_OPENFLOW, 0x00000000)     \
 283     OFPUTIL_VENDOR(OFPUTIL_VENDOR_NICIRA,   NX_VENDOR_ID)
 284
 285 /* OFPUTIL_VENDOR_* definitions. */
 286 enum ofputil_vendor_codes {
 287 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) NAME,
 288     OFPUTIL_VENDORS
 289     OFPUTIL_N_VENDORS
 290 #undef OFPUTIL_VENDOR
 291 };
 292 \f
 293 /* Error codes.
 294  *
 295  * We embed system errno values and OpenFlow standard and vendor extension
 296  * error codes into a single 31-bit space using the following encoding.
 297  * (Bit 31 is unused and assumed 0 to avoid negative "int" values.)
 298  *
 299  *   30                                                   0
 300  *  +------------------------------------------------------+
 301  *  |                           0                          |  success
 302  *  +------------------------------------------------------+
 303  *
 304  *   30 29                                                0
 305  *  +--+---------------------------------------------------+
 306  *  | 0|                    errno value                    |  errno value
 307  *  +--+---------------------------------------------------+
 308  *
 309  *   30 29   26 25            16 15                       0
 310  *  +--+-------+----------------+--------------------------+
 311  *  | 1|   0   |      type      |           code           |  standard OpenFlow
 312  *  +--+-------+----------------+--------------------------+  error
 313  *
 314  *   30 29   26 25            16 15                       0
 315  *  +--+-------+----------------+--------------------------+  Nicira
 316  *  | 1| vendor|      type      |           code           |  NXET_VENDOR
 317  *  +--+-------+----------------+--------------------------+  error extension
 318  *
 319  * C and POSIX say that errno values are positive.  We assume that they are
 320  * less than 2**29.  They are actually less than 65536 on at least Linux,
 321  * FreeBSD, OpenBSD, and Windows.
 322  *
 323  * The 'vendor' field holds one of the OFPUTIL_VENDOR_* codes defined above.
 324  * It must be nonzero.
 325  *
 326  * Negative values are not defined.
 327  */
 328
 329 /* Currently 4 bits are allocated to the "vendor" field.  Make sure that all
 330  * the vendor codes can fit. */
 331 BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16);
 332
 333 /* These are macro versions of the functions defined below.  The macro versions
 334  * are intended for use in contexts where function calls are not allowed,
 335  * e.g. static initializers and case labels. */
 336 #define OFP_MKERR(TYPE, CODE) ((1 << 30) | ((TYPE) << 16) | (CODE))
 337 #define OFP_MKERR_VENDOR(VENDOR, TYPE, CODE) \
 338         ((1 << 30) | ((VENDOR) << 26) | ((TYPE) << 16) | (CODE))
 339 #define OFP_MKERR_NICIRA(TYPE, CODE) \
 340         OFP_MKERR_VENDOR(OFPUTIL_VENDOR_NICIRA, TYPE, CODE)
 341
 342 /* Returns the standard OpenFlow error with the specified 'type' and 'code' as
 343  * an integer. */
 344 static inline int
 345 ofp_mkerr(uint16_t type, uint16_t code)
 346 {
 347     return OFP_MKERR(type, code);
 348 }
 349
 350 /* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and
 351  * 'code' as an integer.  'vendor' must be an OFPUTIL_VENDOR_* constant. */
 352 static inline int
 353 ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
 354 {
 355     assert(vendor < OFPUTIL_N_VENDORS);
 356     return OFP_MKERR_VENDOR(vendor, type, code);
 357 }
 358
 359 /* Returns the OpenFlow vendor error with Nicira as vendor, with the specific
 360  * 'type' and 'code', as an integer. */
 361 static inline int
 362 ofp_mkerr_nicira(uint16_t type, uint16_t code)
 363 {
 364     return OFP_MKERR_NICIRA(type, code);
 365 }
 366
 367 /* Returns true if 'error' encodes an OpenFlow standard or vendor extension
 368  * error codes as documented above. */
 369 static inline bool
 370 is_ofp_error(int error)
 371 {
 372     return (error & (1 << 30)) != 0;
 373 }
 374
 375 /* Returns true if 'error' appears to be a system errno value. */
 376 static inline bool
 377 is_errno(int error)
 378 {
 379     return !is_ofp_error(error);
 380 }
 381
 382 /* Returns the "vendor" part of the OpenFlow error code 'error' (which must be
 383  * in the format explained above).  This is normally one of the
 384  * OFPUTIL_VENDOR_* constants.  Returns OFPUTIL_VENDOR_OPENFLOW (0) for a
 385  * standard OpenFlow error. */
 386 static inline uint8_t
 387 get_ofp_err_vendor(int error)
 388 {
 389     return (error >> 26) & 0xf;
 390 }
 391
 392 /* Returns the "type" part of the OpenFlow error code 'error' (which must be in
 393  * the format explained above). */
 394 static inline uint16_t
 395 get_ofp_err_type(int error)
 396 {
 397     return (error >> 16) & 0x3ff;
 398 }
 399
 400 /* Returns the "code" part of the OpenFlow error code 'error' (which must be in
 401  * the format explained above). */
 402 static inline uint16_t
 403 get_ofp_err_code(int error)
 404 {
 405     return error & 0xffff;
 406 }
 407
 408 struct ofpbuf *ofputil_encode_error_msg(int error, const struct ofp_header *);
 409 int ofputil_decode_error_msg(const struct ofp_header *, size_t *payload_ofs);
 410
 411 /* String versions of errors. */
 412 void ofputil_format_error(struct ds *, int error);
 413 char *ofputil_error_to_string(int error);
 414
 415 #endif /* ofp-util.h */