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     uint16_t total_len;         /* Full length of frame. */
 226 };
 227
 228 int ofputil_decode_packet_in(struct ofputil_packet_in *,
 229                              const struct ofp_header *);
 230 struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *);
 231
 232 /* OpenFlow protocol utility functions. */
 233 void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
 234 void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);
 235
 236 void *make_openflow_xid(size_t openflow_len, uint8_t type,
 237                         ovs_be32 xid, struct ofpbuf **);
 238 void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 239                      struct ofpbuf **);
 240
 241 void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
 242 void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
 243                        struct ofpbuf *);
 244
 245 void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
 246 void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
 247                     struct ofpbuf *);
 248
 249 void update_openflow_length(struct ofpbuf *);
 250
 251 void *ofputil_make_stats_request(size_t openflow_len, uint16_t type,
 252                                  uint32_t subtype, struct ofpbuf **);
 253 void *ofputil_make_stats_reply(size_t openflow_len,
 254                                const struct ofp_stats_msg *request,
 255                                struct ofpbuf **);
 256
 257 void ofputil_start_stats_reply(const struct ofp_stats_msg *request,
 258                                struct list *);
 259 struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *);
 260 void *ofputil_append_stats_reply(size_t len, struct list *);
 261
 262 const void *ofputil_stats_body(const struct ofp_header *);
 263 size_t ofputil_stats_body_len(const struct ofp_header *);
 264
 265 const void *ofputil_nxstats_body(const struct ofp_header *);
 266 size_t ofputil_nxstats_body_len(const struct ofp_header *);
 267
 268 struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
 269                              size_t actions_len);
 270 struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
 271                              uint16_t max_idle, size_t actions_len);
 272 struct ofpbuf *make_del_flow(const struct cls_rule *);
 273 struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
 274                                     uint32_t buffer_id, uint16_t out_port,
 275                                     uint16_t max_idle);
 276 struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
 277                               uint8_t reason,
 278                               const struct ofpbuf *payload, int max_send_len);
 279 struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
 280                                uint16_t in_port,
 281                                const struct ofp_action_header *,
 282                                size_t n_actions);
 283 struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
 284                                         uint16_t in_port, uint16_t out_port);
 285 struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
 286                                           uint16_t in_port, uint16_t out_port);
 287 struct ofpbuf *make_echo_request(void);
 288 struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
 289
 290 const char *ofputil_frag_handling_to_string(enum ofp_config_flags);
 291 bool ofputil_frag_handling_from_string(const char *, enum ofp_config_flags *);
 292 \f
 293 /* Actions. */
 294
 295 /* The type of an action.
 296  *
 297  * For each implemented OFPAT_* and NXAST_* action type, there is a
 298  * corresponding constant prefixed with OFPUTIL_, e.g.:
 299  *
 300  * OFPUTIL_OFPAT_OUTPUT
 301  * OFPUTIL_OFPAT_SET_VLAN_VID
 302  * OFPUTIL_OFPAT_SET_VLAN_PCP
 303  * OFPUTIL_OFPAT_STRIP_VLAN
 304  * OFPUTIL_OFPAT_SET_DL_SRC
 305  * OFPUTIL_OFPAT_SET_DL_DST
 306  * OFPUTIL_OFPAT_SET_NW_SRC
 307  * OFPUTIL_OFPAT_SET_NW_DST
 308  * OFPUTIL_OFPAT_SET_NW_TOS
 309  * OFPUTIL_OFPAT_SET_TP_SRC
 310  * OFPUTIL_OFPAT_SET_TP_DST
 311  * OFPUTIL_OFPAT_ENQUEUE
 312  * OFPUTIL_NXAST_RESUBMIT
 313  * OFPUTIL_NXAST_SET_TUNNEL
 314  * OFPUTIL_NXAST_SET_QUEUE
 315  * OFPUTIL_NXAST_POP_QUEUE
 316  * OFPUTIL_NXAST_REG_MOVE
 317  * OFPUTIL_NXAST_REG_LOAD
 318  * OFPUTIL_NXAST_NOTE
 319  * OFPUTIL_NXAST_SET_TUNNEL64
 320  * OFPUTIL_NXAST_MULTIPATH
 321  * OFPUTIL_NXAST_AUTOPATH
 322  * OFPUTIL_NXAST_BUNDLE
 323  * OFPUTIL_NXAST_BUNDLE_LOAD
 324  * OFPUTIL_NXAST_RESUBMIT_TABLE
 325  * OFPUTIL_NXAST_OUTPUT_REG
 326  *
 327  * (The above list helps developers who want to "grep" for these definitions.)
 328  */
 329 enum ofputil_action_code {
 330 #define OFPAT_ACTION(ENUM, STRUCT, NAME)             OFPUTIL_##ENUM,
 331 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) OFPUTIL_##ENUM,
 332 #include "ofp-util.def"
 333 };
 334
 335 /* The number of values of "enum ofputil_action_code". */
 336 enum {
 337 #define OFPAT_ACTION(ENUM, STRUCT, NAME)             + 1
 338 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME) + 1
 339     OFPUTIL_N_ACTIONS = 0
 340 #include "ofp-util.def"
 341 };
 342
 343 int ofputil_decode_action(const union ofp_action *);
 344 enum ofputil_action_code ofputil_decode_action_unsafe(
 345     const union ofp_action *);
 346
 347 int ofputil_action_code_from_name(const char *);
 348
 349 void *ofputil_put_action(enum ofputil_action_code, struct ofpbuf *buf);
 350
 351 /* For each OpenFlow action <ENUM> that has a corresponding action structure
 352  * struct <STRUCT>, this defines two functions:
 353  *
 354  *   void ofputil_init_<ENUM>(struct <STRUCT> *action);
 355  *
 356  *     Initializes the parts of 'action' that identify it as having type <ENUM>
 357  *     and length 'sizeof *action' and zeros the rest.  For actions that have
 358  *     variable length, the length used and cleared is that of struct <STRUCT>.
 359  *
 360  *  struct <STRUCT> *ofputil_put_<ENUM>(struct ofpbuf *buf);
 361  *
 362  *     Appends a new 'action', of length 'sizeof(struct <STRUCT>)', to 'buf',
 363  *     initializes it with ofputil_init_<ENUM>(), and returns it.
 364  */
 365 #define OFPAT_ACTION(ENUM, STRUCT, NAME)                \
 366     void ofputil_init_##ENUM(struct STRUCT *);          \
 367     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 368 #define NXAST_ACTION(ENUM, STRUCT, EXTENSIBLE, NAME)    \
 369     void ofputil_init_##ENUM(struct STRUCT *);          \
 370     struct STRUCT *ofputil_put_##ENUM(struct ofpbuf *);
 371 #include "ofp-util.def"
 372
 373 #define OFP_ACTION_ALIGN 8      /* Alignment of ofp_actions. */
 374
 375 static inline union ofp_action *
 376 ofputil_action_next(const union ofp_action *a)
 377 {
 378     return ((union ofp_action *) (void *)
 379             ((uint8_t *) a + ntohs(a->header.len)));
 380 }
 381
 382 static inline bool
 383 ofputil_action_is_valid(const union ofp_action *a, size_t n_actions)
 384 {
 385     uint16_t len = ntohs(a->header.len);
 386     return (!(len % OFP_ACTION_ALIGN)
 387             && len >= sizeof *a
 388             && len / sizeof *a <= n_actions);
 389 }
 390
 391 /* This macro is careful to check for actions with bad lengths. */
 392 #define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS)         \
 393     for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
 394          (LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT);             \
 395          ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
 396           (ITER) = ofputil_action_next(ITER)))
 397
 398 /* This macro does not check for actions with bad lengths.  It should only be
 399  * used with actions from trusted sources or with actions that have already
 400  * been validated (e.g. with OFPUTIL_ACTION_FOR_EACH).  */
 401 #define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS)  \
 402     for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
 403          (LEFT) > 0;                                                    \
 404          ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
 405           (ITER) = ofputil_action_next(ITER)))
 406
 407 int validate_actions(const union ofp_action *, size_t n_actions,
 408                      const struct flow *, int max_ports);
 409 bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
 410
 411 int ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
 412                          union ofp_action **, size_t *);
 413
 414 bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
 415                            const union ofp_action *b, size_t n_b);
 416 union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
 417 \f
 418 /* OpenFlow vendors.
 419  *
 420  * These functions map OpenFlow 32-bit vendor IDs (as used in struct
 421  * ofp_vendor_header) into 4-bit values to embed in an "int".  The 4-bit values
 422  * are only used internally in Open vSwitch and never appear on the wire, so
 423  * particular codes used are not important.
 424  */
 425
 426 /* Vendor error numbers currently used in Open vSwitch. */
 427 #define OFPUTIL_VENDORS                                     \
 428     /*             vendor name              vendor value */ \
 429     OFPUTIL_VENDOR(OFPUTIL_VENDOR_OPENFLOW, 0x00000000)     \
 430     OFPUTIL_VENDOR(OFPUTIL_VENDOR_NICIRA,   NX_VENDOR_ID)
 431
 432 /* OFPUTIL_VENDOR_* definitions. */
 433 enum ofputil_vendor_codes {
 434 #define OFPUTIL_VENDOR(NAME, VENDOR_ID) NAME,
 435     OFPUTIL_VENDORS
 436     OFPUTIL_N_VENDORS
 437 #undef OFPUTIL_VENDOR
 438 };
 439 \f
 440 /* Error codes.
 441  *
 442  * We embed system errno values and OpenFlow standard and vendor extension
 443  * error codes into a single 31-bit space using the following encoding.
 444  * (Bit 31 is unused and assumed 0 to avoid negative "int" values.)
 445  *
 446  *   30                                                   0
 447  *  +------------------------------------------------------+
 448  *  |                           0                          |  success
 449  *  +------------------------------------------------------+
 450  *
 451  *   30 29                                                0
 452  *  +--+---------------------------------------------------+
 453  *  | 0|                    errno value                    |  errno value
 454  *  +--+---------------------------------------------------+
 455  *
 456  *   30 29   26 25            16 15                       0
 457  *  +--+-------+----------------+--------------------------+
 458  *  | 1|   0   |      type      |           code           |  standard OpenFlow
 459  *  +--+-------+----------------+--------------------------+  error
 460  *
 461  *   30 29   26 25            16 15                       0
 462  *  +--+-------+----------------+--------------------------+  Nicira
 463  *  | 1| vendor|      type      |           code           |  NXET_VENDOR
 464  *  +--+-------+----------------+--------------------------+  error extension
 465  *
 466  * C and POSIX say that errno values are positive.  We assume that they are
 467  * less than 2**29.  They are actually less than 65536 on at least Linux,
 468  * FreeBSD, OpenBSD, and Windows.
 469  *
 470  * The 'vendor' field holds one of the OFPUTIL_VENDOR_* codes defined above.
 471  * It must be nonzero.
 472  *
 473  * Negative values are not defined.
 474  */
 475
 476 /* Currently 4 bits are allocated to the "vendor" field.  Make sure that all
 477  * the vendor codes can fit. */
 478 BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16);
 479
 480 /* These are macro versions of the functions defined below.  The macro versions
 481  * are intended for use in contexts where function calls are not allowed,
 482  * e.g. static initializers and case labels. */
 483 #define OFP_MKERR(TYPE, CODE) ((1 << 30) | ((TYPE) << 16) | (CODE))
 484 #define OFP_MKERR_VENDOR(VENDOR, TYPE, CODE) \
 485         ((1 << 30) | ((VENDOR) << 26) | ((TYPE) << 16) | (CODE))
 486 #define OFP_MKERR_NICIRA(TYPE, CODE) \
 487         OFP_MKERR_VENDOR(OFPUTIL_VENDOR_NICIRA, TYPE, CODE)
 488
 489 /* Returns the standard OpenFlow error with the specified 'type' and 'code' as
 490  * an integer. */
 491 static inline int
 492 ofp_mkerr(uint16_t type, uint16_t code)
 493 {
 494     return OFP_MKERR(type, code);
 495 }
 496
 497 /* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and
 498  * 'code' as an integer.  'vendor' must be an OFPUTIL_VENDOR_* constant. */
 499 static inline int
 500 ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
 501 {
 502     assert(vendor < OFPUTIL_N_VENDORS);
 503     return OFP_MKERR_VENDOR(vendor, type, code);
 504 }
 505
 506 /* Returns the OpenFlow vendor error with Nicira as vendor, with the specific
 507  * 'type' and 'code', as an integer. */
 508 static inline int
 509 ofp_mkerr_nicira(uint16_t type, uint16_t code)
 510 {
 511     return OFP_MKERR_NICIRA(type, code);
 512 }
 513
 514 /* Returns true if 'error' encodes an OpenFlow standard or vendor extension
 515  * error codes as documented above. */
 516 static inline bool
 517 is_ofp_error(int error)
 518 {
 519     return (error & (1 << 30)) != 0;
 520 }
 521
 522 /* Returns true if 'error' appears to be a system errno value. */
 523 static inline bool
 524 is_errno(int error)
 525 {
 526     return !is_ofp_error(error);
 527 }
 528
 529 /* Returns the "vendor" part of the OpenFlow error code 'error' (which must be
 530  * in the format explained above).  This is normally one of the
 531  * OFPUTIL_VENDOR_* constants.  Returns OFPUTIL_VENDOR_OPENFLOW (0) for a
 532  * standard OpenFlow error. */
 533 static inline uint8_t
 534 get_ofp_err_vendor(int error)
 535 {
 536     return (error >> 26) & 0xf;
 537 }
 538
 539 /* Returns the "type" part of the OpenFlow error code 'error' (which must be in
 540  * the format explained above). */
 541 static inline uint16_t
 542 get_ofp_err_type(int error)
 543 {
 544     return (error >> 16) & 0x3ff;
 545 }
 546
 547 /* Returns the "code" part of the OpenFlow error code 'error' (which must be in
 548  * the format explained above). */
 549 static inline uint16_t
 550 get_ofp_err_code(int error)
 551 {
 552     return error & 0xffff;
 553 }
 554
 555 struct ofpbuf *ofputil_encode_error_msg(int error, const struct ofp_header *);
 556 int ofputil_decode_error_msg(const struct ofp_header *, size_t *payload_ofs);
 557
 558 /* String versions of errors. */
 559 void ofputil_format_error(struct ds *, int error);
 560 char *ofputil_error_to_string(int error);
 561
 562 /* Handy utility for parsing flows and actions. */
 563 bool ofputil_parse_key_value(char **stringp, char **keyp, char **valuep);
 564
 565 #endif /* ofp-util.h */