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