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