[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,
    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);

/* Flow format independent flow_mod. */
struct flow_mod {
    struct cls_rule cr;
    ovs_be64 cookie;
    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 *);
struct ofpbuf *ofputil_encode_flow_mod(const struct flow_mod *,
                                       enum nx_flow_format);

/* 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);

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