[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_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 *);

/* 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_cls_rule_from_match(const struct ofp_match *,
                                 unsigned int priority, struct cls_rule *);
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;
    uint64_t byte_count;
    union ofp_action *actions;
    size_t n_actions;
};

int ofputil_decode_flow_stats_reply(struct ofputil_flow_stats *,
                                    struct ofpbuf *msg);

/* 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;
    uint64_t byte_count;
};

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 body_len, uint16_t type,
                                 struct ofpbuf **);
void *ofputil_make_nxstats_request(size_t openflow_len, uint32_t subtype,
                                   struct ofpbuf **);

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. */

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

struct actions_iterator {
    const union ofp_action *pos, *end;
};
const union ofp_action *actions_first(struct actions_iterator *,
                                      const union ofp_action *,
                                      size_t n_actions);
const union ofp_action *actions_next(struct actions_iterator *);

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