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_MSG_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 int ofputil_decode_msg_type_partial(const struct ofp_header *, size_t length,
  94                                     const struct ofputil_msg_type **);
  95 enum ofputil_msg_code ofputil_msg_type_code(const struct ofputil_msg_type *);
  96 const char *ofputil_msg_type_name(const struct ofputil_msg_type *);
  97
  98 /* Port numbers. */
  99 int ofputil_check_output_port(uint16_t ofp_port, int max_ports);
 100 bool ofputil_port_from_string(const char *, uint16_t *port);
 101 void ofputil_format_port(uint16_t port, struct ds *);
 102
 103 /* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to
 104  * and from IP bitmasks. */
 105 ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
 106 int ofputil_netmask_to_wcbits(ovs_be32 netmask);
 107
 108 /* Work with OpenFlow 1.0 ofp_match. */
 109 void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *);
 110 void ofputil_cls_rule_from_match(const struct ofp_match *,
 111                                  unsigned int priority, struct cls_rule *);
 112 void ofputil_normalize_rule(struct cls_rule *, enum nx_flow_format);
 113 void ofputil_cls_rule_to_match(const struct cls_rule *, struct ofp_match *);
 114
 115 /* dl_type translation between OpenFlow and 'struct flow' format. */
 116 ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
 117 ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
 118
 119 /* Flow formats. */
 120 bool ofputil_flow_format_is_valid(enum nx_flow_format);
 121 const char *ofputil_flow_format_to_string(enum nx_flow_format);
 122 int ofputil_flow_format_from_string(const char *);
 123 enum nx_flow_format ofputil_min_flow_format(const struct cls_rule *);
 124
 125 struct ofpbuf *ofputil_make_set_flow_format(enum nx_flow_format);
 126
 127 /* NXT_FLOW_MOD_TABLE_ID extension. */
 128 struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
 129
 130 /* Flow format independent flow_mod. */
 131 struct ofputil_flow_mod {
 132     struct cls_rule cr;
 133     ovs_be64 cookie;
 134     ovs_be64 cookie_mask;
 135     uint8_t table_id;
 136     uint16_t command;
 137     uint16_t idle_timeout;
 138     uint16_t hard_timeout;
 139     uint32_t buffer_id;
 140     uint16_t out_port;
 141     uint16_t flags;
 142     union ofp_action *actions;
 143     size_t n_actions;
 144 };
 145
 146 int ofputil_decode_flow_mod(struct ofputil_flow_mod *,
 147                             const struct ofp_header *, bool flow_mod_table_id);
 148 struct ofpbuf *ofputil_encode_flow_mod(const struct ofputil_flow_mod *,
 149                                        enum nx_flow_format,
 150                                        bool flow_mod_table_id);
 151
 152 /* Flow stats or aggregate stats request, independent of flow format. */
 153 struct ofputil_flow_stats_request {
 154     bool aggregate;             /* Aggregate results? */
 155     struct cls_rule match;
 156     ovs_be64 cookie;
 157     ovs_be64 cookie_mask;
 158     uint16_t out_port;
 159     uint8_t table_id;
 160 };
 161
 162 int ofputil_decode_flow_stats_request(struct ofputil_flow_stats_request *,
 163                                       const struct ofp_header *);
 164 struct ofpbuf *ofputil_encode_flow_stats_request(
 165     const struct ofputil_flow_stats_request *, enum nx_flow_format);
 166
 167 /* Flow stats reply, independent of flow format. */
 168 struct ofputil_flow_stats {
 169     struct cls_rule rule;
 170     ovs_be64 cookie;
 171     uint8_t table_id;
 172     uint32_t duration_sec;
 173     uint32_t duration_nsec;
 174     uint16_t idle_timeout;
 175     uint16_t hard_timeout;
 176     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 177     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 178     union ofp_action *actions;
 179     size_t n_actions;
 180 };
 181
 182 int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
 183                                     struct ofpbuf *msg);
 184 void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
 185                                      struct list *replies);
 186
 187 /* Aggregate stats reply, independent of flow format. */
 188 struct ofputil_aggregate_stats {
 189     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 190     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 191     uint32_t flow_count;
 192 };
 193
 194 struct ofpbuf *ofputil_encode_aggregate_stats_reply(
 195     const struct ofputil_aggregate_stats *stats,
 196     const struct ofp_stats_msg *request);
 197
 198 /* Flow removed message, independent of flow format. */
 199 struct ofputil_flow_removed {
 200     struct cls_rule rule;
 201     ovs_be64 cookie;
 202     uint8_t reason;             /* One of OFPRR_*. */
 203     uint32_t duration_sec;
 204     uint32_t duration_nsec;
 205     uint16_t idle_timeout;
 206     uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
 207     uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
 208 };
 209
 210 int ofputil_decode_flow_removed(struct ofputil_flow_removed *,
 211                                 const struct ofp_header *);
 212 struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
 213                                            enum nx_flow_format);
 214
 215 /* Abstract packet-in message. */
 216 struct ofputil_packet_in {
 217     const void *packet;
 218     size_t packet_len;
 219
 220     uint16_t in_port;
 221     uint8_t reason;             /* One of OFPR_*. */
 222
 223     uint32_t buffer_id;
 224     int send_len;
 225 };
 226
 227 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *);
 228
 229 /* OpenFlow protocol utility functions. */
 230 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
 231 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
 232
 233 void *make_openflow_xid(size_t openflow_len, uint8_t type,
 234                         ovs_be32 xid, struct ofpbuf **);
 235 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 236                      struct ofpbuf **);
 237
 238 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
 239 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
 240                        struct ofpbuf *);
 241
 242 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
 243 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 244                     struct ofpbuf *);
 245
 246 void update_openflow_length(struct ofpbuf *);
 247
 248 void *ofputil_make_stats_request(size_t openflow_len, uint16_t type,
 249                                  uint32_t subtype, struct ofpbuf **);
 250 void *ofputil_make_stats_reply(size_t openflow_len,
 251                                const struct ofp_stats_msg *request,
 252                                struct ofpbuf **);
 253
 254 void ofputil_start_stats_reply(const struct ofp_stats_msg *request,
 255                                struct list *);
 256 struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *);
 257 void *ofputil_append_stats_reply(size_t len, struct list *);
 258
 259 const void *ofputil_stats_body(const struct ofp_header *);
 260 size_t ofputil_stats_body_len(const struct ofp_header *);
 261
 262 const void *ofputil_nxstats_body(const struct ofp_header *);
 263 size_t ofputil_nxstats_body_len(const struct ofp_header *);
 264
 265 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
 266                              size_t actions_len);
 267 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
 268                              uint16_t max_idle, size_t actions_len);
 269 struct ofpbuf *make_del_flow(const struct cls_rule *);
 270 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
 271                                     uint32_t buffer_id, uint16_t out_port,
 272                                     uint16_t max_idle);
 273 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
 274                               uint8_t reason,
 275                               const struct ofpbuf *payload, int max_send_len);
 276 struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
 277                                uint16_t in_port,
 278                                const struct ofp_action_header *,
 279                                size_t n_actions);
 280 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
 281                                         uint16_t in_port, uint16_t out_port);
 282 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
 283                                           uint16_t in_port, uint16_t out_port);
 284 struct ofpbuf *make_echo_request(void);
 285 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
 286
 287 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
 288 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
 289 \f
 290 /* Actions. */
 291
 292 /* The type of an action.
 293  *
 294  * For each implemented OFPAT_* and NXAST_* action type, there is a
 295  * corresponding constant prefixed with OFPUTIL_, e.g.:
 296  *
 297  * OFPUTIL_OFPAT_OUTPUT
 298  * OFPUTIL_OFPAT_SET_VLAN_VID
 299  * OFPUTIL_OFPAT_SET_VLAN_PCP
 300  * OFPUTIL_OFPAT_STRIP_VLAN
 301  * OFPUTIL_OFPAT_SET_DL_SRC
 302  * OFPUTIL_OFPAT_SET_DL_DST
 303  * OFPUTIL_OFPAT_SET_NW_SRC
 304  * OFPUTIL_OFPAT_SET_NW_DST
 305  * OFPUTIL_OFPAT_SET_NW_TOS
 306  * OFPUTIL_OFPAT_SET_TP_SRC
 307  * OFPUTIL_OFPAT_SET_TP_DST
 308  * OFPUTIL_OFPAT_ENQUEUE
 309  * OFPUTIL_NXAST_RESUBMIT
 310  * OFPUTIL_NXAST_SET_TUNNEL
 311  * OFPUTIL_NXAST_SET_QUEUE
 312  * OFPUTIL_NXAST_POP_QUEUE
 313  * OFPUTIL_NXAST_REG_MOVE
 314  * OFPUTIL_NXAST_REG_LOAD
 315  * OFPUTIL_NXAST_NOTE
 316  * OFPUTIL_NXAST_SET_TUNNEL64
 317  * OFPUTIL_NXAST_MULTIPATH
 318  * OFPUTIL_NXAST_AUTOPATH
 319  * OFPUTIL_NXAST_BUNDLE
 320  * OFPUTIL_NXAST_BUNDLE_LOAD
 321  * OFPUTIL_NXAST_RESUBMIT_TABLE
 322  * OFPUTIL_NXAST_OUTPUT_REG
 323  *
 324  * (The above list helps developers who want to "grep" for these definitions.)
 325  */
 326 enum ofputil_action_code {
 327 #define OFPAT_ACTION(ENUM, STRUCT, NAME)             OFPUTIL_##ENUM,
 328 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
 329 #include "ofp-util.def"
 330 };
 331
 332 /* The number of values of "enum ofputil_action_code". */
 333 enum {
 334 #define OFPAT_ACTION(ENUM, STRUCT, NAME)             + 1
 335 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
 336     OFPUTIL_N_ACTIONS = 0
 337 #include "ofp-util.def"
 338 };
 339
 340 int ofputil_decode_action(const union ofp_action *);
 341 enum ofputil_action_code ofputil_decode_action_unsafe(
 342     const union ofp_action *);
 343
 344 int ofputil_action_code_from_name(const char *);
 345
 346 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
 347
 348 /* For each OpenFlow action <ENUM> that has a corresponding action structure
 349  * struct <STRUCT>, this defines two functions:
 350  *
 351  *   void ofputil_init_<ENUM>(struct <STRUCT> *action);
 352  *
 353  *     Initializes the parts of 'action' that identify it as having type <ENUM>
 354  *     and length 'sizeof *action' and zeros the rest.  For actions that have
 355  *     variable length, the length used and cleared is that of struct <STRUCT>.
 356  *
 357  *  struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
 358  *
 359  *     Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
 360  *     initializes it with ofputil_init_<ENUM>(), and returns it.
 361  */
 362 #define OFPAT_ACTION(ENUM, STRUCT, NAME)                \
 363     void ofputil_init_##ENUM(struct STRUCT *);          \
 364     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 365 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)    \
 366     void ofputil_init_##ENUM(struct STRUCT *);          \
 367     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 368 #include "ofp-util.def"
 369
 370 #define OFP_ACTION_ALIGN 8      /* Alignment of ofp_actions. */
 371
 372 static inline union ofp_action *
 373 ofputil_action_next(const union ofp_action *a)
 374 {
 375     return ((union ofp_action *) (void *)
 376             ((uint8_t *) a + ntohs(a->header.len)));
 377 }
 378
 379 static inline bool
 380 ofputil_action_is_valid(const union ofp_action *a, size_t n_actions)
 381 {
 382     uint16_t len = ntohs(a->header.len);
 383     return (!(len % OFP_ACTION_ALIGN)
 384             && len >= sizeof *a
 385             && len / sizeof *a <= n_actions);
 386 }
 387
 388 /* This macro is careful to check for actions with bad lengths. */
 389 #define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS)         \
 390     for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
 391          (LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT);             \
 392          ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
 393           (ITER) = ofputil_action_next(ITER)))
 394
 395 /* This macro does not check for actions with bad lengths.  It should only be
 396  * used with actions from trusted sources or with actions that have already
 397  * been validated (e.g. with OFPUTIL_ACTION_FOR_EACH).  */
 398 #define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS)  \
 399     for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
 400          (LEFT) > 0;                                                    \
 401          ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
 402           (ITER) = ofputil_action_next(ITER)))
 403
 404 int validate_actions(const union ofp_action *, size_t n_actions,
 405                      const struct flow *, int max_ports);
 406 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
 407
 408 int ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
 409                          union ofp_action **, size_t *);
 410
 411 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
 412                            const union ofp_action *b, size_t n_b);
 413 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
 414 \f
 415 /* OpenFlow vendors.
 416  *
 417  * These functions map OpenFlow 32-bit vendor IDs (as used in struct
 418  * ofp_vendor_header) into 4-bit values to embed in an "int".  The 4-bit values
 419  * are only used internally in Open vSwitch and never appear on the wire, so
 420  * particular codes used are not important.
 421  */
 422
 423 /* Vendor error numbers currently used in Open vSwitch. */
 424 #define OFPUTIL_VENDORS                                     \
 425     /*             vendor name              vendor value */ \
 426     OFPUTIL_VENDOR(OFPUTIL_VENDOR_OPENFLOW, 0x00000000)     \
 427     OFPUTIL_VENDOR(OFPUTIL_VENDOR_NICIRA,   NX_VENDOR_ID)
 428
 429 /* OFPUTIL_VENDOR_* definitions. */
 430 enum ofputil_vendor_codes {
 431 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) NAME,
 432     OFPUTIL_VENDORS
 433     OFPUTIL_N_VENDORS
 434 #undef OFPUTIL_VENDOR
 435 };
 436 \f
 437 /* Error codes.
 438  *
 439  * We embed system errno values and OpenFlow standard and vendor extension
 440  * error codes into a single 31-bit space using the following encoding.
 441  * (Bit 31 is unused and assumed 0 to avoid negative "int" values.)
 442  *
 443  *   30                                                   0
 444  *  +------------------------------------------------------+
 445  *  |                           0                          |  success
 446  *  +------------------------------------------------------+
 447  *
 448  *   30 29                                                0
 449  *  +--+---------------------------------------------------+
 450  *  | 0|                    errno value                    |  errno value
 451  *  +--+---------------------------------------------------+
 452  *
 453  *   30 29   26 25            16 15                       0
 454  *  +--+-------+----------------+--------------------------+
 455  *  | 1|   0   |      type      |           code           |  standard OpenFlow
 456  *  +--+-------+----------------+--------------------------+  error
 457  *
 458  *   30 29   26 25            16 15                       0
 459  *  +--+-------+----------------+--------------------------+  Nicira
 460  *  | 1| vendor|      type      |           code           |  NXET_VENDOR
 461  *  +--+-------+----------------+--------------------------+  error extension
 462  *
 463  * C and POSIX say that errno values are positive.  We assume that they are
 464  * less than 2**29.  They are actually less than 65536 on at least Linux,
 465  * FreeBSD, OpenBSD, and Windows.
 466  *
 467  * The 'vendor' field holds one of the OFPUTIL_VENDOR_* codes defined above.
 468  * It must be nonzero.
 469  *
 470  * Negative values are not defined.
 471  */
 472
 473 /* Currently 4 bits are allocated to the "vendor" field.  Make sure that all
 474  * the vendor codes can fit. */
 475 BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16);
 476
 477 /* These are macro versions of the functions defined below.  The macro versions
 478  * are intended for use in contexts where function calls are not allowed,
 479  * e.g. static initializers and case labels. */
 480 #define OFP_MKERR(TYPE, CODE) ((1 << 30) | ((TYPE) << 16) | (CODE))
 481 #define OFP_MKERR_VENDOR(VENDOR, TYPE, CODE) \
 482         ((1 << 30) | ((VENDOR) << 26) | ((TYPE) << 16) | (CODE))
 483 #define OFP_MKERR_NICIRA(TYPE, CODE) \
 484         OFP_MKERR_VENDOR(OFPUTIL_VENDOR_NICIRA, TYPE, CODE)
 485
 486 /* Returns the standard OpenFlow error with the specified 'type' and 'code' as
 487  * an integer. */
 488 static inline int
 489 ofp_mkerr(uint16_t type, uint16_t code)
 490 {
 491     return OFP_MKERR(type, code);
 492 }
 493
 494 /* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and
 495  * 'code' as an integer.  'vendor' must be an OFPUTIL_VENDOR_* constant. */
 496 static inline int
 497 ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
 498 {
 499     assert(vendor < OFPUTIL_N_VENDORS);
 500     return OFP_MKERR_VENDOR(vendor, type, code);
 501 }
 502
 503 /* Returns the OpenFlow vendor error with Nicira as vendor, with the specific
 504  * 'type' and 'code', as an integer. */
 505 static inline int
 506 ofp_mkerr_nicira(uint16_t type, uint16_t code)
 507 {
 508     return OFP_MKERR_NICIRA(type, code);
 509 }
 510
 511 /* Returns true if 'error' encodes an OpenFlow standard or vendor extension
 512  * error codes as documented above. */
 513 static inline bool
 514 is_ofp_error(int error)
 515 {
 516     return (error & (1 << 30)) != 0;
 517 }
 518
 519 /* Returns true if 'error' appears to be a system errno value. */
 520 static inline bool
 521 is_errno(int error)
 522 {
 523     return !is_ofp_error(error);
 524 }
 525
 526 /* Returns the "vendor" part of the OpenFlow error code 'error' (which must be
 527  * in the format explained above).  This is normally one of the
 528  * OFPUTIL_VENDOR_* constants.  Returns OFPUTIL_VENDOR_OPENFLOW (0) for a
 529  * standard OpenFlow error. */
 530 static inline uint8_t
 531 get_ofp_err_vendor(int error)
 532 {
 533     return (error >> 26) & 0xf;
 534 }
 535
 536 /* Returns the "type" part of the OpenFlow error code 'error' (which must be in
 537  * the format explained above). */
 538 static inline uint16_t
 539 get_ofp_err_type(int error)
 540 {
 541     return (error >> 16) & 0x3ff;
 542 }
 543
 544 /* Returns the "code" part of the OpenFlow error code 'error' (which must be in
 545  * the format explained above). */
 546 static inline uint16_t
 547 get_ofp_err_code(int error)
 548 {
 549     return error & 0xffff;
 550 }
 551
 552 struct ofpbuf *ofputil_encode_error_msg(int error, const struct ofp_header *);
 553 int ofputil_decode_error_msg(const struct ofp_header *, size_t *payload_ofs);
 554
 555 /* String versions of errors. */
 556 void ofputil_format_error(struct ds *, int error);
 557 char *ofputil_error_to_string(int error);
 558
 559 /* Handy utility for parsing flows and actions. */
 560 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
 561
 562 #endif /* ofp-util.h */