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