[mirror_ovs.git] / lib / ofp-util.h

/*
 * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef OFP_UTIL_H
#define OFP_UTIL_H 1

#include <assert.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include "classifier.h"
#include "flow.h"
#include "openflow/nicira-ext.h"
#include "openvswitch/types.h"

struct cls_rule;
struct ofpbuf;

/* Basic decoding and length validation of OpenFlow messages. */
enum ofputil_msg_code {
    OFPUTIL_MSG_INVALID,

    /* OFPT_* messages. */
    OFPUTIL_OFPT_HELLO,
    OFPUTIL_OFPT_ERROR,
    OFPUTIL_OFPT_ECHO_REQUEST,
    OFPUTIL_OFPT_ECHO_REPLY,
    OFPUTIL_OFPT_FEATURES_REQUEST,
    OFPUTIL_OFPT_FEATURES_REPLY,
    OFPUTIL_OFPT_GET_CONFIG_REQUEST,
    OFPUTIL_OFPT_GET_CONFIG_REPLY,
    OFPUTIL_OFPT_SET_CONFIG,
    OFPUTIL_OFPT_PACKET_IN,
    OFPUTIL_OFPT_FLOW_REMOVED,
    OFPUTIL_OFPT_PORT_STATUS,
    OFPUTIL_OFPT_PACKET_OUT,
    OFPUTIL_OFPT_FLOW_MOD,
    OFPUTIL_OFPT_PORT_MOD,
    OFPUTIL_OFPT_BARRIER_REQUEST,
    OFPUTIL_OFPT_BARRIER_REPLY,
    OFPUTIL_OFPT_QUEUE_GET_CONFIG_REQUEST,
    OFPUTIL_OFPT_QUEUE_GET_CONFIG_REPLY,

    /* OFPST_* stat requests. */
    OFPUTIL_OFPST_DESC_REQUEST,
    OFPUTIL_OFPST_FLOW_REQUEST,
    OFPUTIL_OFPST_AGGREGATE_REQUEST,
    OFPUTIL_OFPST_TABLE_REQUEST,
    OFPUTIL_OFPST_PORT_REQUEST,
    OFPUTIL_OFPST_QUEUE_REQUEST,

    /* OFPST_* stat replies. */
    OFPUTIL_OFPST_DESC_REPLY,
    OFPUTIL_OFPST_FLOW_REPLY,
    OFPUTIL_OFPST_QUEUE_REPLY,
    OFPUTIL_OFPST_PORT_REPLY,
    OFPUTIL_OFPST_TABLE_REPLY,
    OFPUTIL_OFPST_AGGREGATE_REPLY,

    /* NXT_* messages. */
    OFPUTIL_NXT_ROLE_REQUEST,
    OFPUTIL_NXT_ROLE_REPLY,
    OFPUTIL_NXT_SET_FLOW_FORMAT,
    OFPUTIL_NXT_FLOW_MOD_TABLE_ID,
    OFPUTIL_NXT_FLOW_MOD,
    OFPUTIL_NXT_FLOW_REMOVED,

    /* NXST_* stat requests. */
    OFPUTIL_NXST_FLOW_REQUEST,
    OFPUTIL_NXST_AGGREGATE_REQUEST,

    /* NXST_* stat replies. */
    OFPUTIL_NXST_FLOW_REPLY,
    OFPUTIL_NXST_AGGREGATE_REPLY
};

struct ofputil_msg_type;
int ofputil_decode_msg_type(const struct ofp_header *,
                            const struct ofputil_msg_type **);
enum ofputil_msg_code ofputil_msg_type_code(const struct ofputil_msg_type *);
const char *ofputil_msg_type_name(const struct ofputil_msg_type *);
int ofputil_check_output_port(uint16_t ofp_port, int max_ports);

/* Converting OFPFW_NW_SRC_MASK and OFPFW_NW_DST_MASK wildcard bit counts to
 * and from IP bitmasks. */
ovs_be32 ofputil_wcbits_to_netmask(int wcbits);
int ofputil_netmask_to_wcbits(ovs_be32 netmask);

/* Work with OpenFlow 1.0 ofp_match. */
void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *);
void ofputil_cls_rule_from_match(const struct ofp_match *,
                                 unsigned int priority, struct cls_rule *);
void ofputil_normalize_rule(struct cls_rule *, enum nx_flow_format);
void ofputil_cls_rule_to_match(const struct cls_rule *, struct ofp_match *);

/* dl_type translation between OpenFlow and 'struct flow' format. */
ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);

/* Flow formats. */
bool ofputil_flow_format_is_valid(enum nx_flow_format);
const char *ofputil_flow_format_to_string(enum nx_flow_format);
int ofputil_flow_format_from_string(const char *);
enum nx_flow_format ofputil_min_flow_format(const struct cls_rule *);

struct ofpbuf *ofputil_make_set_flow_format(enum nx_flow_format);

/* NXT_FLOW_MOD_TABLE_ID extension. */
struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);

/* Flow format independent flow_mod. */
struct flow_mod {
    struct cls_rule cr;
    ovs_be64 cookie;
    uint8_t table_id;
    uint16_t command;
    uint16_t idle_timeout;
    uint16_t hard_timeout;
    uint32_t buffer_id;
    uint16_t out_port;
    uint16_t flags;
    union ofp_action *actions;
    size_t n_actions;
};

int ofputil_decode_flow_mod(struct flow_mod *, const struct ofp_header *,
                            bool flow_mod_table_id);
struct ofpbuf *ofputil_encode_flow_mod(const struct flow_mod *,
                                       enum nx_flow_format,
                                       bool flow_mod_table_id);

/* Flow stats or aggregate stats request, independent of flow format. */
struct flow_stats_request {
    bool aggregate;             /* Aggregate results? */
    struct cls_rule match;
    uint16_t out_port;
    uint8_t table_id;
};

int ofputil_decode_flow_stats_request(struct flow_stats_request *,
                                      const struct ofp_header *);
struct ofpbuf *ofputil_encode_flow_stats_request(
    const struct flow_stats_request *, enum nx_flow_format);

/* Flow stats reply, independent of flow format. */
struct ofputil_flow_stats {
    struct cls_rule rule;
    ovs_be64 cookie;
    uint8_t table_id;
    uint32_t duration_sec;
    uint32_t duration_nsec;
    uint16_t idle_timeout;
    uint16_t hard_timeout;
    uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
    uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
    union ofp_action *actions;
    size_t n_actions;
};

int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
                                    struct ofpbuf *msg);
void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
                                     struct list *replies);

/* Aggregate stats reply, independent of flow format. */
struct ofputil_aggregate_stats {
    uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
    uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
    uint32_t flow_count;
};

struct ofpbuf *ofputil_encode_aggregate_stats_reply(
    const struct ofputil_aggregate_stats *stats,
    const struct ofp_stats_msg *request);

/* Flow removed message, independent of flow format. */
struct ofputil_flow_removed {
    struct cls_rule rule;
    ovs_be64 cookie;
    uint8_t reason;             /* One of OFPRR_*. */
    uint32_t duration_sec;
    uint32_t duration_nsec;
    uint16_t idle_timeout;
    uint64_t packet_count;      /* Packet count, UINT64_MAX if unknown. */
    uint64_t byte_count;        /* Byte count, UINT64_MAX if unknown. */
};

int ofputil_decode_flow_removed(struct ofputil_flow_removed *,
                                const struct ofp_header *);
struct ofpbuf *ofputil_encode_flow_removed(const struct ofputil_flow_removed *,
                                           enum nx_flow_format);

/* Abstract packet-in message. */
struct ofputil_packet_in {
    struct ofpbuf *packet;
    uint16_t in_port;
    uint8_t reason;             /* One of OFPR_*. */

    uint32_t buffer_id;
    int send_len;
};

struct ofpbuf *ofputil_encode_packet_in(const struct ofputil_packet_in *,
                                        struct ofpbuf *rw_packet);

/* OpenFlow protocol utility functions. */
void *make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf **);
void *make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf **);

void *make_openflow_xid(size_t openflow_len, uint8_t type,
                        ovs_be32 xid, struct ofpbuf **);
void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
                     struct ofpbuf **);

void *put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
                       struct ofpbuf *);

void *put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
                    struct ofpbuf *);

void update_openflow_length(struct ofpbuf *);

void *ofputil_make_stats_request(size_t openflow_len, uint16_t type,
                                 uint32_t subtype, struct ofpbuf **);
void *ofputil_make_stats_reply(size_t openflow_len,
                               const struct ofp_stats_msg *request,
                               struct ofpbuf **);

void ofputil_start_stats_reply(const struct ofp_stats_msg *request,
                               struct list *);
struct ofpbuf *ofputil_reserve_stats_reply(size_t len, struct list *);
void *ofputil_append_stats_reply(size_t len, struct list *);

const void *ofputil_stats_body(const struct ofp_header *);
size_t ofputil_stats_body_len(const struct ofp_header *);

const void *ofputil_nxstats_body(const struct ofp_header *);
size_t ofputil_nxstats_body_len(const struct ofp_header *);

struct ofpbuf *make_flow_mod(uint16_t command, const struct cls_rule *,
                             size_t actions_len);
struct ofpbuf *make_add_flow(const struct cls_rule *, uint32_t buffer_id,
                             uint16_t max_idle, size_t actions_len);
struct ofpbuf *make_del_flow(const struct cls_rule *);
struct ofpbuf *make_add_simple_flow(const struct cls_rule *,
                                    uint32_t buffer_id, uint16_t out_port,
                                    uint16_t max_idle);
struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
                              uint8_t reason,
                              const struct ofpbuf *payload, int max_send_len);
struct ofpbuf *make_packet_out(const struct ofpbuf *packet, uint32_t buffer_id,
                               uint16_t in_port,
                               const struct ofp_action_header *,
                               size_t n_actions);
struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
                                        uint16_t in_port, uint16_t out_port);
struct ofpbuf *make_unbuffered_packet_out(const struct ofpbuf *packet,
                                          uint16_t in_port, uint16_t out_port);
struct ofpbuf *make_echo_request(void);
struct ofpbuf *make_echo_reply(const struct ofp_header *rq);
\f
/* Actions. */

enum ofputil_action_code {
    /* OFPAT_* actions. */
    OFPUTIL_OFPAT_OUTPUT,
    OFPUTIL_OFPAT_SET_VLAN_VID,
    OFPUTIL_OFPAT_SET_VLAN_PCP,
    OFPUTIL_OFPAT_STRIP_VLAN,
    OFPUTIL_OFPAT_SET_DL_SRC,
    OFPUTIL_OFPAT_SET_DL_DST,
    OFPUTIL_OFPAT_SET_NW_SRC,
    OFPUTIL_OFPAT_SET_NW_DST,
    OFPUTIL_OFPAT_SET_NW_TOS,
    OFPUTIL_OFPAT_SET_TP_SRC,
    OFPUTIL_OFPAT_SET_TP_DST,
    OFPUTIL_OFPAT_ENQUEUE,

    /* NXAST_* actions. */
    OFPUTIL_NXAST_RESUBMIT,
    OFPUTIL_NXAST_SET_TUNNEL,
    OFPUTIL_NXAST_SET_QUEUE,
    OFPUTIL_NXAST_POP_QUEUE,
    OFPUTIL_NXAST_REG_MOVE,
    OFPUTIL_NXAST_REG_LOAD,
    OFPUTIL_NXAST_NOTE,
    OFPUTIL_NXAST_SET_TUNNEL64,
    OFPUTIL_NXAST_MULTIPATH,
    OFPUTIL_NXAST_AUTOPATH,
    OFPUTIL_NXAST_BUNDLE,
    OFPUTIL_NXAST_BUNDLE_LOAD,
};

int ofputil_decode_action(const union ofp_action *);
enum ofputil_action_code ofputil_decode_action_unsafe(
    const union ofp_action *);

#define OFP_ACTION_ALIGN 8      /* Alignment of ofp_actions. */

static inline union ofp_action *
ofputil_action_next(const union ofp_action *a)
{
    return (void *) ((uint8_t *) a + ntohs(a->header.len));
}

static inline bool
ofputil_action_is_valid(const union ofp_action *a, size_t n_actions)
{
    uint16_t len = ntohs(a->header.len);
    return (!(len % OFP_ACTION_ALIGN)
            && len >= sizeof *a
            && len / sizeof *a <= n_actions);
}

/* This macro is careful to check for actions with bad lengths. */
#define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS)         \
    for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
         (LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT);             \
         ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
          (ITER) = ofputil_action_next(ITER)))

/* This macro does not check for actions with bad lengths.  It should only be
 * used with actions from trusted sources or with actions that have already
 * been validated (e.g. with OFPUTIL_ACTION_FOR_EACH).  */
#define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS)  \
    for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS);                      \
         (LEFT) > 0;                                                    \
         ((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
          (ITER) = ofputil_action_next(ITER)))

int validate_actions(const union ofp_action *, size_t n_actions,
                     const struct flow *, int max_ports);
bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);

int ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
                         union ofp_action **, size_t *);

bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
                           const union ofp_action *b, size_t n_b);
union ofp_action *ofputil_actions_clone(const union ofp_action *, size_t n);
\f
/* OpenFlow vendors.
 *
 * These functions map OpenFlow 32-bit vendor IDs (as used in struct
 * ofp_vendor_header) into 4-bit values to embed in an "int".  The 4-bit values
 * are only used internally in Open vSwitch and never appear on the wire, so
 * particular codes used are not important.
 */

/* Vendor error numbers currently used in Open vSwitch. */
#define OFPUTIL_VENDORS                                     \
    /*             vendor name              vendor value */ \
    OFPUTIL_VENDOR(OFPUTIL_VENDOR_OPENFLOW, 0x00000000)     \
    OFPUTIL_VENDOR(OFPUTIL_VENDOR_NICIRA,   NX_VENDOR_ID)

/* OFPUTIL_VENDOR_* definitions. */
enum ofputil_vendor_codes {
#define OFPUTIL_VENDOR(NAME, VENDOR_ID) NAME,
    OFPUTIL_VENDORS
    OFPUTIL_N_VENDORS
#undef OFPUTIL_VENDOR
};
\f
/* Error codes.
 *
 * We embed system errno values and OpenFlow standard and vendor extension
 * error codes into a single 31-bit space using the following encoding.
 * (Bit 31 is unused and assumed 0 to avoid negative "int" values.)
 *
 *   30                                                   0
 *  +------------------------------------------------------+
 *  |                           0                          |  success
 *  +------------------------------------------------------+
 *
 *   30 29                                                0
 *  +--+---------------------------------------------------+
 *  | 0|                    errno value                    |  errno value
 *  +--+---------------------------------------------------+
 *
 *   30 29   26 25            16 15                       0
 *  +--+-------+----------------+--------------------------+
 *  | 1|   0   |      type      |           code           |  standard OpenFlow
 *  +--+-------+----------------+--------------------------+  error
 *
 *   30 29   26 25            16 15                       0
 *  +--+-------+----------------+--------------------------+  Nicira
 *  | 1| vendor|      type      |           code           |  NXET_VENDOR
 *  +--+-------+----------------+--------------------------+  error extension
 *
 * C and POSIX say that errno values are positive.  We assume that they are
 * less than 2**29.  They are actually less than 65536 on at least Linux,
 * FreeBSD, OpenBSD, and Windows.
 *
 * The 'vendor' field holds one of the OFPUTIL_VENDOR_* codes defined above.
 * It must be nonzero.
 *
 * Negative values are not defined.
 */

/* Currently 4 bits are allocated to the "vendor" field.  Make sure that all
 * the vendor codes can fit. */
BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16);

/* These are macro versions of the functions defined below.  The macro versions
 * are intended for use in contexts where function calls are not allowed,
 * e.g. static initializers and case labels. */
#define OFP_MKERR(TYPE, CODE) ((1 << 30) | ((TYPE) << 16) | (CODE))
#define OFP_MKERR_VENDOR(VENDOR, TYPE, CODE) \
        ((1 << 30) | ((VENDOR) << 26) | ((TYPE) << 16) | (CODE))
#define OFP_MKERR_NICIRA(TYPE, CODE) \
        OFP_MKERR_VENDOR(OFPUTIL_VENDOR_NICIRA, TYPE, CODE)

/* Returns the standard OpenFlow error with the specified 'type' and 'code' as
 * an integer. */
static inline int
ofp_mkerr(uint16_t type, uint16_t code)
{
    return OFP_MKERR(type, code);
}

/* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and
 * 'code' as an integer.  'vendor' must be an OFPUTIL_VENDOR_* constant. */
static inline int
ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
{
    assert(vendor < OFPUTIL_N_VENDORS);
    return OFP_MKERR_VENDOR(vendor, type, code);
}

/* Returns the OpenFlow vendor error with Nicira as vendor, with the specific
 * 'type' and 'code', as an integer. */
static inline int
ofp_mkerr_nicira(uint16_t type, uint16_t code)
{
    return OFP_MKERR_NICIRA(type, code);
}

/* Returns true if 'error' encodes an OpenFlow standard or vendor extension
 * error codes as documented above. */
static inline bool
is_ofp_error(int error)
{
    return (error & (1 << 30)) != 0;
}

/* Returns true if 'error' appears to be a system errno value. */
static inline bool
is_errno(int error)
{
    return !is_ofp_error(error);
}

/* Returns the "vendor" part of the OpenFlow error code 'error' (which must be
 * in the format explained above).  This is normally one of the
 * OFPUTIL_VENDOR_* constants.  Returns OFPUTIL_VENDOR_OPENFLOW (0) for a
 * standard OpenFlow error. */
static inline uint8_t
get_ofp_err_vendor(int error)
{
    return (error >> 26) & 0xf;
}

/* Returns the "type" part of the OpenFlow error code 'error' (which must be in
 * the format explained above). */
static inline uint16_t
get_ofp_err_type(int error)
{
    return (error >> 16) & 0x3ff;
}

/* Returns the "code" part of the OpenFlow error code 'error' (which must be in
 * the format explained above). */
static inline uint16_t
get_ofp_err_code(int error)
{
    return error & 0xffff;
}

struct ofpbuf *ofputil_encode_error_msg(int error, const struct ofp_header *);
int ofputil_decode_error_msg(const struct ofp_header *, size_t *payload_ofs);

/* String versions of errors. */
void ofputil_format_error(struct ds *, int error);
char *ofputil_error_to_string(int error);

#endif /* ofp-util.h */
Commit	Line	Data
fa37b408	1	/*
4ffd1b43	2	* Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
fa37b408 BP	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>
c1c9c9c4	21	#include <stdbool.h>
fa37b408 BP	22	#include <stddef.h>
fa37b408 BP	23	#include <stdint.h>
d1e2cf21	24	#include "classifier.h"
fa37b408	25	#include "flow.h"
492f7572	26	#include "openflow/nicira-ext.h"
44381c1b	27	#include "openvswitch/types.h"
fa37b408	28
d8ae4d67	29	struct cls_rule;
fa37b408	30	struct ofpbuf;
fa37b408	31
d1e2cf21 BP	32	/* Basic decoding and length validation of OpenFlow messages. */
d1e2cf21 BP	33	enum ofputil_msg_code {
8f93e93c	34	OFPUTIL_MSG_INVALID,
d1e2cf21 BP	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. */
d1e2cf21 BP	74	OFPUTIL_NXT_ROLE_REQUEST,
	75	OFPUTIL_NXT_ROLE_REPLY,
	76	OFPUTIL_NXT_SET_FLOW_FORMAT,
6c1491fb	77	OFPUTIL_NXT_FLOW_MOD_TABLE_ID,
d1e2cf21 BP	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 );
77410139	95	int ofputil_check_output_port(uint16_t ofp_port, int max_ports);
d1e2cf21	96
0596e897 BP	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
d8ae4d67	102	/* Work with OpenFlow 1.0 ofp_match. */
7286b1e1	103	void ofputil_wildcard_from_openflow(uint32_t ofpfw, struct flow_wildcards *);
d8ae4d67	104	void ofputil_cls_rule_from_match(const struct ofp_match *,
b78f6b77	105	unsigned int priority, struct cls_rule *);
b459a924	106	void ofputil_normalize_rule(struct cls_rule *, enum nx_flow_format);
b78f6b77	107	void ofputil_cls_rule_to_match(const struct cls_rule , struct ofp_match );
d8ae4d67	108
36956a7d BP	109	/* dl_type translation between OpenFlow and 'struct flow' format. */
	110	ovs_be16 ofputil_dl_type_to_openflow(ovs_be16 flow_dl_type);
	111	ovs_be16 ofputil_dl_type_from_openflow(ovs_be16 ofp_dl_type);
	112
7fa91113 BP	113	/* Flow formats. */
	114	bool ofputil_flow_format_is_valid(enum nx_flow_format);
	115	const char *ofputil_flow_format_to_string(enum nx_flow_format);
88ca35ee	116	int ofputil_flow_format_from_string(const char *);
b78f6b77	117	enum nx_flow_format ofputil_min_flow_format(const struct cls_rule *);
88ca35ee BP	118
88ca35ee BP	119	struct ofpbuf *ofputil_make_set_flow_format(enum nx_flow_format);
7fa91113	120
6c1491fb BP	121	/* NXT_FLOW_MOD_TABLE_ID extension. */
	122	struct ofpbuf *ofputil_make_flow_mod_table_id(bool flow_mod_table_id);
	123
2e4f5fcf BP	124	/* Flow format independent flow_mod. */
	125	struct flow_mod {
	126	struct cls_rule cr;
	127	ovs_be64 cookie;
6c1491fb	128	uint8_t table_id;
2e4f5fcf BP	129	uint16_t command;
	130	uint16_t idle_timeout;
	131	uint16_t hard_timeout;
	132	uint32_t buffer_id;
	133	uint16_t out_port;
	134	uint16_t flags;
	135	union ofp_action *actions;
	136	size_t n_actions;
	137	};
	138
	139	int ofputil_decode_flow_mod(struct flow_mod , const struct ofp_header ,
00794817	140	bool flow_mod_table_id);
2e4f5fcf	141	struct ofpbuf ofputil_encode_flow_mod(const struct flow_mod ,
6c1491fb BP	142	enum nx_flow_format,
6c1491fb BP	143	bool flow_mod_table_id);
2e4f5fcf BP	144
	145	/* Flow stats or aggregate stats request, independent of flow format. */
	146	struct flow_stats_request {
	147	bool aggregate; /* Aggregate results? */
	148	struct cls_rule match;
	149	uint16_t out_port;
	150	uint8_t table_id;
	151	};
	152
	153	int ofputil_decode_flow_stats_request(struct flow_stats_request *,
b78f6b77	154	const struct ofp_header *);
2e4f5fcf BP	155	struct ofpbuf *ofputil_encode_flow_stats_request(
	156	const struct flow_stats_request *, enum nx_flow_format);
	157
4ffd1b43 BP	158	/* Flow stats reply, independent of flow format. */
	159	struct ofputil_flow_stats {
	160	struct cls_rule rule;
	161	ovs_be64 cookie;
	162	uint8_t table_id;
	163	uint32_t duration_sec;
	164	uint32_t duration_nsec;
	165	uint16_t idle_timeout;
	166	uint16_t hard_timeout;
5e9d0469 BP	167	uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
5e9d0469 BP	168	uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
4ffd1b43 BP	169	union ofp_action *actions;
	170	size_t n_actions;
	171	};
	172
	173	int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
b78f6b77	174	struct ofpbuf *msg);
349adfb2 BP	175	void ofputil_append_flow_stats_reply(const struct ofputil_flow_stats *,
349adfb2 BP	176	struct list *replies);
4ffd1b43	177
76c93b22 BP	178	/* Aggregate stats reply, independent of flow format. */
76c93b22 BP	179	struct ofputil_aggregate_stats {
5e9d0469 BP	180	uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
5e9d0469 BP	181	uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
76c93b22 BP	182	uint32_t flow_count;
	183	};
	184
	185	struct ofpbuf *ofputil_encode_aggregate_stats_reply(
	186	const struct ofputil_aggregate_stats *stats,
	187	const struct ofp_stats_msg *request);
	188
9b045a0c BP	189	/* Flow removed message, independent of flow format. */
	190	struct ofputil_flow_removed {
	191	struct cls_rule rule;
	192	ovs_be64 cookie;
	193	uint8_t reason; /* One of OFPRR_. /
	194	uint32_t duration_sec;
	195	uint32_t duration_nsec;
	196	uint16_t idle_timeout;
5e9d0469 BP	197	uint64_t packet_count; /* Packet count, UINT64_MAX if unknown. */
5e9d0469 BP	198	uint64_t byte_count; /* Byte count, UINT64_MAX if unknown. */
9b045a0c BP	199	};
	200
	201	int ofputil_decode_flow_removed(struct ofputil_flow_removed *,
b78f6b77	202	const struct ofp_header *);
588cd7b5 BP	203	struct ofpbuf ofputil_encode_flow_removed(const struct ofputil_flow_removed ,
588cd7b5 BP	204	enum nx_flow_format);
9b045a0c	205
ebb57021 BP	206	/* Abstract packet-in message. */
	207	struct ofputil_packet_in {
	208	struct ofpbuf *packet;
	209	uint16_t in_port;
	210	uint8_t reason; /* One of OFPR_. /
	211
	212	uint32_t buffer_id;
	213	int send_len;
	214	};
	215
	216	struct ofpbuf ofputil_encode_packet_in(const struct ofputil_packet_in ,
	217	struct ofpbuf *rw_packet);
	218
fa37b408 BP	219	/* OpenFlow protocol utility functions. */
fa37b408 BP	220	void make_openflow(size_t openflow_len, uint8_t type, struct ofpbuf *);
0bd0c660	221	void make_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf *);
dfdfc8d4	222
fa37b408	223	void *make_openflow_xid(size_t openflow_len, uint8_t type,
44381c1b BP	224	ovs_be32 xid, struct ofpbuf **);
44381c1b BP	225	void *make_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
0bd0c660	226	struct ofpbuf **);
dfdfc8d4	227
fa37b408	228	void put_openflow(size_t openflow_len, uint8_t type, struct ofpbuf );
44381c1b	229	void *put_openflow_xid(size_t openflow_len, uint8_t type, ovs_be32 xid,
fa37b408	230	struct ofpbuf *);
dfdfc8d4 BP	231
	232	void put_nxmsg(size_t openflow_len, uint32_t subtype, struct ofpbuf );
	233	void *put_nxmsg_xid(size_t openflow_len, uint32_t subtype, ovs_be32 xid,
	234	struct ofpbuf *);
	235
fa37b408	236	void update_openflow_length(struct ofpbuf *);
d1e2cf21	237
63f2140a BP	238	void *ofputil_make_stats_request(size_t openflow_len, uint16_t type,
	239	uint32_t subtype, struct ofpbuf **);
	240	void *ofputil_make_stats_reply(size_t openflow_len,
	241	const struct ofp_stats_msg *request,
	242	struct ofpbuf **);
	243
	244	void ofputil_start_stats_reply(const struct ofp_stats_msg *request,
	245	struct list *);
	246	struct ofpbuf ofputil_reserve_stats_reply(size_t len, struct list );
	247	void ofputil_append_stats_reply(size_t len, struct list );
dfdfc8d4	248
d1e2cf21	249	const void ofputil_stats_body(const struct ofp_header );
c6430da5 BP	250	size_t ofputil_stats_body_len(const struct ofp_header *);
	251
	252	const void ofputil_nxstats_body(const struct ofp_header );
	253	size_t ofputil_nxstats_body_len(const struct ofp_header *);
d1e2cf21	254
daa68e9f	255	struct ofpbuf make_flow_mod(uint16_t command, const struct cls_rule ,
fa37b408	256	size_t actions_len);
daa68e9f	257	struct ofpbuf make_add_flow(const struct cls_rule , uint32_t buffer_id,
fa37b408	258	uint16_t max_idle, size_t actions_len);
daa68e9f BP	259	struct ofpbuf make_del_flow(const struct cls_rule );
daa68e9f BP	260	struct ofpbuf make_add_simple_flow(const struct cls_rule ,
fa37b408 BP	261	uint32_t buffer_id, uint16_t out_port,
	262	uint16_t max_idle);
	263	struct ofpbuf *make_packet_in(uint32_t buffer_id, uint16_t in_port,
	264	uint8_t reason,
	265	const struct ofpbuf *payload, int max_send_len);
	266	struct ofpbuf make_packet_out(const struct ofpbuf packet, uint32_t buffer_id,
	267	uint16_t in_port,
	268	const struct ofp_action_header *,
	269	size_t n_actions);
	270	struct ofpbuf *make_buffered_packet_out(uint32_t buffer_id,
	271	uint16_t in_port, uint16_t out_port);
	272	struct ofpbuf make_unbuffered_packet_out(const struct ofpbuf packet,
	273	uint16_t in_port, uint16_t out_port);
	274	struct ofpbuf *make_echo_request(void);
	275	struct ofpbuf make_echo_reply(const struct ofp_header rq);
9aee0764 BP	276	\f
	277	/* Actions. */
	278
38f2e360 BP	279	enum ofputil_action_code {
	280	/* OFPAT_* actions. */
	281	OFPUTIL_OFPAT_OUTPUT,
	282	OFPUTIL_OFPAT_SET_VLAN_VID,
	283	OFPUTIL_OFPAT_SET_VLAN_PCP,
	284	OFPUTIL_OFPAT_STRIP_VLAN,
	285	OFPUTIL_OFPAT_SET_DL_SRC,
	286	OFPUTIL_OFPAT_SET_DL_DST,
	287	OFPUTIL_OFPAT_SET_NW_SRC,
	288	OFPUTIL_OFPAT_SET_NW_DST,
	289	OFPUTIL_OFPAT_SET_NW_TOS,
	290	OFPUTIL_OFPAT_SET_TP_SRC,
	291	OFPUTIL_OFPAT_SET_TP_DST,
	292	OFPUTIL_OFPAT_ENQUEUE,
	293
	294	/* NXAST_* actions. */
	295	OFPUTIL_NXAST_RESUBMIT,
	296	OFPUTIL_NXAST_SET_TUNNEL,
	297	OFPUTIL_NXAST_SET_QUEUE,
	298	OFPUTIL_NXAST_POP_QUEUE,
	299	OFPUTIL_NXAST_REG_MOVE,
	300	OFPUTIL_NXAST_REG_LOAD,
	301	OFPUTIL_NXAST_NOTE,
	302	OFPUTIL_NXAST_SET_TUNNEL64,
	303	OFPUTIL_NXAST_MULTIPATH,
daff3353	304	OFPUTIL_NXAST_AUTOPATH,
a368bb53 EJ	305	OFPUTIL_NXAST_BUNDLE,
a368bb53 EJ	306	OFPUTIL_NXAST_BUNDLE_LOAD,
38f2e360 BP	307	};
	308
	309	int ofputil_decode_action(const union ofp_action *);
	310	enum ofputil_action_code ofputil_decode_action_unsafe(
	311	const union ofp_action *);
	312
9aee0764	313	#define OFP_ACTION_ALIGN 8 /* Alignment of ofp_actions. */
fa37b408	314
b4b8c781 BP	315	static inline union ofp_action *
	316	ofputil_action_next(const union ofp_action *a)
	317	{
	318	return (void ) ((uint8_t ) a + ntohs(a->header.len));
	319	}
	320
	321	static inline bool
	322	ofputil_action_is_valid(const union ofp_action *a, size_t n_actions)
	323	{
	324	uint16_t len = ntohs(a->header.len);
	325	return (!(len % OFP_ACTION_ALIGN)
	326	&& len >= sizeof *a
	327	&& len / sizeof *a <= n_actions);
	328	}
	329
	330	/* This macro is careful to check for actions with bad lengths. */
	331	#define OFPUTIL_ACTION_FOR_EACH(ITER, LEFT, ACTIONS, N_ACTIONS) \
	332	for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
	333	(LEFT) > 0 && ofputil_action_is_valid(ITER, LEFT); \
	334	((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
	335	(ITER) = ofputil_action_next(ITER)))
	336
	337	/* This macro does not check for actions with bad lengths. It should only be
	338	* used with actions from trusted sources or with actions that have already
	339	* been validated (e.g. with OFPUTIL_ACTION_FOR_EACH). */
	340	#define OFPUTIL_ACTION_FOR_EACH_UNSAFE(ITER, LEFT, ACTIONS, N_ACTIONS) \
	341	for ((ITER) = (ACTIONS), (LEFT) = (N_ACTIONS); \
	342	(LEFT) > 0; \
	343	((LEFT) -= ntohs((ITER)->header.len) / sizeof(union ofp_action), \
	344	(ITER) = ofputil_action_next(ITER)))
9aee0764	345
fa37b408	346	int validate_actions(const union ofp_action *, size_t n_actions,
f1defbf9	347	const struct flow *, int max_ports);
dbba996b	348	bool action_outputs_to_port(const union ofp_action *, ovs_be16 port);
3052b0c5 BP	349
	350	int ofputil_pull_actions(struct ofpbuf *, unsigned int actions_len,
	351	union ofp_action *, size_t );
18ddadc2 BP	352
	353	bool ofputil_actions_equal(const union ofp_action *a, size_t n_a,
	354	const union ofp_action *b, size_t n_b);
	355	union ofp_action ofputil_actions_clone(const union ofp_action , size_t n);
71ce9235	356	\f
26c112c2	357	/* OpenFlow vendors.
71ce9235	358	*
a23aab1f BP	359	* These functions map OpenFlow 32-bit vendor IDs (as used in struct
	360	* ofp_vendor_header) into 4-bit values to embed in an "int". The 4-bit values
	361	* are only used internally in Open vSwitch and never appear on the wire, so
	362	* particular codes used are not important.
	363	*/
	364
26c112c2 BP	365	/* Vendor error numbers currently used in Open vSwitch. */
	366	#define OFPUTIL_VENDORS \
	367	/* vendor name vendor value */ \
	368	OFPUTIL_VENDOR(OFPUTIL_VENDOR_OPENFLOW, 0x00000000) \
61d8d583	369	OFPUTIL_VENDOR(OFPUTIL_VENDOR_NICIRA, NX_VENDOR_ID)
26c112c2 BP	370
	371	/* OFPUTIL_VENDOR_* definitions. */
	372	enum ofputil_vendor_codes {
	373	#define OFPUTIL_VENDOR(NAME, VENDOR_ID) NAME,
	374	OFPUTIL_VENDORS
	375	OFPUTIL_N_VENDORS
	376	#undef OFPUTIL_VENDOR
	377	};
	378	\f
	379	/* Error codes.
71ce9235	380	*
26c112c2 BP	381	* We embed system errno values and OpenFlow standard and vendor extension
	382	* error codes into a single 31-bit space using the following encoding.
	383	* (Bit 31 is unused and assumed 0 to avoid negative "int" values.)
71ce9235	384	*
a23aab1f	385	* 30 0
26c112c2 BP	386	* +------------------------------------------------------+
	387	* \| 0 \| success
	388	* +------------------------------------------------------+
71ce9235	389	*
26c112c2 BP	390	* 30 29 0
26c112c2 BP	391	* +--+---------------------------------------------------+
a23aab1f	392	* \| 0\| errno value \| errno value
26c112c2	393	* +--+---------------------------------------------------+
71ce9235	394	*
26c112c2 BP	395	* 30 29 26 25 16 15 0
26c112c2 BP	396	* +--+-------+----------------+--------------------------+
a23aab1f	397	* \| 1\| 0 \| type \| code \| standard OpenFlow
26c112c2	398	* +--+-------+----------------+--------------------------+ error
71ce9235	399	*
26c112c2 BP	400	* 30 29 26 25 16 15 0
	401	* +--+-------+----------------+--------------------------+ Nicira
	402	* \| 1\| vendor\| type \| code \| NXET_VENDOR
	403	* +--+-------+----------------+--------------------------+ error extension
71ce9235	404	*
26c112c2 BP	405	* C and POSIX say that errno values are positive. We assume that they are
	406	* less than 2**29. They are actually less than 65536 on at least Linux,
	407	* FreeBSD, OpenBSD, and Windows.
71ce9235	408	*
26c112c2 BP	409	* The 'vendor' field holds one of the OFPUTIL_VENDOR_* codes defined above.
26c112c2 BP	410	* It must be nonzero.
71ce9235	411	*
26c112c2	412	* Negative values are not defined.
71ce9235	413	*/
fa37b408	414
26c112c2 BP	415	/* Currently 4 bits are allocated to the "vendor" field. Make sure that all
	416	* the vendor codes can fit. */
	417	BUILD_ASSERT_DECL(OFPUTIL_N_VENDORS <= 16);
	418
d48a5910 BP	419	/* These are macro versions of the functions defined below. The macro versions
	420	* are intended for use in contexts where function calls are not allowed,
	421	* e.g. static initializers and case labels. */
	422	#define OFP_MKERR(TYPE, CODE) ((1 << 30) \| ((TYPE) << 16) \| (CODE))
	423	#define OFP_MKERR_VENDOR(VENDOR, TYPE, CODE) \
	424	((1 << 30) \| ((VENDOR) << 26) \| ((TYPE) << 16) \| (CODE))
	425	#define OFP_MKERR_NICIRA(TYPE, CODE) \
	426	OFP_MKERR_VENDOR(OFPUTIL_VENDOR_NICIRA, TYPE, CODE)
	427
26c112c2 BP	428	/* Returns the standard OpenFlow error with the specified 'type' and 'code' as
26c112c2 BP	429	* an integer. */
fa37b408 BP	430	static inline int
	431	ofp_mkerr(uint16_t type, uint16_t code)
	432	{
d48a5910	433	return OFP_MKERR(type, code);
26c112c2 BP	434	}
	435
	436	/* Returns the OpenFlow vendor error with the specified 'vendor', 'type', and
	437	* 'code' as an integer. 'vendor' must be an OFPUTIL_VENDOR_* constant. */
	438	static inline int
	439	ofp_mkerr_vendor(uint8_t vendor, uint16_t type, uint16_t code)
	440	{
	441	assert(vendor < OFPUTIL_N_VENDORS);
d48a5910	442	return OFP_MKERR_VENDOR(vendor, type, code);
fa37b408 BP	443	}
fa37b408 BP	444
26c112c2 BP	445	/* Returns the OpenFlow vendor error with Nicira as vendor, with the specific
	446	* 'type' and 'code', as an integer. */
	447	static inline int
	448	ofp_mkerr_nicira(uint16_t type, uint16_t code)
	449	{
d48a5910	450	return OFP_MKERR_NICIRA(type, code);
26c112c2 BP	451	}
	452
	453	/* Returns true if 'error' encodes an OpenFlow standard or vendor extension
	454	* error codes as documented above. */
71ce9235 BP	455	static inline bool
	456	is_ofp_error(int error)
	457	{
26c112c2	458	return (error & (1 << 30)) != 0;
71ce9235 BP	459	}
	460
	461	/* Returns true if 'error' appears to be a system errno value. */
	462	static inline bool
	463	is_errno(int error)
	464	{
26c112c2 BP	465	return !is_ofp_error(error);
	466	}
	467
	468	/* Returns the "vendor" part of the OpenFlow error code 'error' (which must be
	469	* in the format explained above). This is normally one of the
	470	* OFPUTIL_VENDOR_* constants. Returns OFPUTIL_VENDOR_OPENFLOW (0) for a
	471	* standard OpenFlow error. */
	472	static inline uint8_t
	473	get_ofp_err_vendor(int error)
	474	{
	475	return (error >> 26) & 0xf;
71ce9235 BP	476	}
	477
	478	/* Returns the "type" part of the OpenFlow error code 'error' (which must be in
	479	* the format explained above). */
	480	static inline uint16_t
	481	get_ofp_err_type(int error)
	482	{
26c112c2	483	return (error >> 16) & 0x3ff;
71ce9235 BP	484	}
	485
	486	/* Returns the "code" part of the OpenFlow error code 'error' (which must be in
	487	* the format explained above). */
	488	static inline uint16_t
	489	get_ofp_err_code(int error)
	490	{
	491	return error & 0xffff;
	492	}
	493
dc4762ed BP	494	struct ofpbuf ofputil_encode_error_msg(int error, const struct ofp_header );
	495	int ofputil_decode_error_msg(const struct ofp_header , size_t payload_ofs);
	496
	497	/* String versions of errors. */
	498	void ofputil_format_error(struct ds *, int error);
	499	char *ofputil_error_to_string(int error);
26c112c2	500
fa37b408	501	#endif /* ofp-util.h */