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

/*
 * Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
 *
 * 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 ODP_UTIL_H
#define ODP_UTIL_H 1

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <string.h>
#include <linux/openvswitch.h>
#include "hash.h"
#include "openflow/openflow.h"
#include "util.h"

struct ds;
struct flow;
struct flow_tnl;
struct flow_wildcards;
struct nlattr;
struct ofpbuf;
struct simap;

#define ODPP_LOCAL ODP_PORT_C(OVSP_LOCAL)
#define ODPP_NONE  ODP_PORT_C(UINT32_MAX)

void format_odp_actions(struct ds *, const struct nlattr *odp_actions,
                        size_t actions_len);
int odp_actions_from_string(const char *, const struct simap *port_names,
                            struct ofpbuf *odp_actions);

/* The maximum number of bytes that odp_flow_key_from_flow() appends to a
 * buffer.  This is the upper bound on the length of a nlattr-formatted flow
 * key that ovs-vswitchd fully understands.
 *
 * OVS doesn't insist that ovs-vswitchd and the datapath have exactly the same
 * idea of a flow, so therefore this value isn't necessarily an upper bound on
 * the length of a flow key that the datapath can pass to ovs-vswitchd.
 *
 * The longest nlattr-formatted flow key appended by odp_flow_key_from_flow()
 * would be:
 *
 *                                     struct  pad  nl hdr  total
 *                                     ------  ---  ------  -----
 *  OVS_KEY_ATTR_PRIORITY                4    --     4      8
 *  OVS_KEY_ATTR_TUNNEL                  0    --     4      4
 *  - OVS_TUNNEL_KEY_ATTR_ID             8    --     4     12
 *  - OVS_TUNNEL_KEY_ATTR_IPV4_SRC       4    --     4      8
 *  - OVS_TUNNEL_KEY_ATTR_IPV4_DST       4    --     4      8
 *  - OVS_TUNNEL_KEY_ATTR_TOS            1    3      4      8
 *  - OVS_TUNNEL_KEY_ATTR_TTL            1    3      4      8
 *  - OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT  0    --     4      4
 *  - OVS_TUNNEL_KEY_ATTR_CSUM           0    --     4      4
 *  OVS_KEY_ATTR_IN_PORT                 4    --     4      8
 *  OVS_KEY_ATTR_SKB_MARK                4    --     4      8
 *  OVS_KEY_ATTR_ETHERNET               12    --     4     16
 *  OVS_KEY_ATTR_ETHERTYPE               2     2     4      8  (outer VLAN ethertype)
 *  OVS_KEY_ATTR_8021Q                   4    --     4      8
 *  OVS_KEY_ATTR_ENCAP                   0    --     4      4  (VLAN encapsulation)
 *  OVS_KEY_ATTR_ETHERTYPE               2     2     4      8  (inner VLAN ethertype)
 *  OVS_KEY_ATTR_IPV6                   40    --     4     44
 *  OVS_KEY_ATTR_ICMPV6                  2     2     4      8
 *  OVS_KEY_ATTR_ND                     28    --     4     32
 *  ----------------------------------------------------------
 *  total                                                 208
 *
 * We include some slack space in case the calculation isn't quite right or we
 * add another field and forget to adjust this value.
 */
#define ODPUTIL_FLOW_KEY_BYTES 256

/* A buffer with sufficient size and alignment to hold an nlattr-formatted flow
 * key.  An array of "struct nlattr" might not, in theory, be sufficiently
 * aligned because it only contains 16-bit types. */
struct odputil_keybuf {
    uint32_t keybuf[DIV_ROUND_UP(ODPUTIL_FLOW_KEY_BYTES, 4)];
};

enum odp_key_fitness odp_tun_key_from_attr(const struct nlattr *,
                                           struct flow_tnl *);

void odp_flow_format(const struct nlattr *key, size_t key_len,
                     const struct nlattr *mask, size_t mask_len,
                     struct ds *, bool verbose);
void odp_flow_key_format(const struct nlattr *, size_t, struct ds *);
int odp_flow_from_string(const char *s,
                         const struct simap *port_names,
                         struct ofpbuf *, struct ofpbuf *);

void odp_flow_key_from_flow(struct ofpbuf *, const struct flow *,
                            odp_port_t odp_in_port);
void odp_flow_key_from_mask(struct ofpbuf *, const struct flow *mask,
                            const struct flow *flow, uint32_t odp_in_port);

uint32_t odp_flow_key_hash(const struct nlattr *, size_t);

/* How well a kernel-provided flow key (a sequence of OVS_KEY_ATTR_*
 * attributes) matches OVS userspace expectations.
 *
 * These values are arranged so that greater values are "more important" than
 * lesser ones.  In particular, a single flow key can fit the descriptions for
 * both ODP_FIT_TOO_LITTLE and ODP_FIT_TOO_MUCH.  Such a key is treated as
 * ODP_FIT_TOO_LITTLE. */
enum odp_key_fitness {
    ODP_FIT_PERFECT,            /* The key had exactly the fields we expect. */
    ODP_FIT_TOO_MUCH,           /* The key had fields we don't understand. */
    ODP_FIT_TOO_LITTLE,         /* The key lacked fields we expected to see. */
    ODP_FIT_ERROR,              /* The key was invalid. */
};
enum odp_key_fitness odp_flow_key_to_flow(const struct nlattr *, size_t,
                                          struct flow *);
const char *odp_key_fitness_to_string(enum odp_key_fitness);

void commit_odp_tunnel_action(const struct flow *, struct flow *base,
                              struct ofpbuf *odp_actions);
void commit_odp_actions(const struct flow *, struct flow *base,
                        struct ofpbuf *odp_actions,
                        struct flow_wildcards *wc);
\f
/* ofproto-dpif interface.
 *
 * The following types and functions are logically part of ofproto-dpif.
 * ofproto-dpif puts values of these types into the flows that it installs in
 * the kernel datapath, though, so ovs-dpctl needs to interpret them so that
 * it can print flows in a more human-readable manner. */

enum user_action_cookie_type {
    USER_ACTION_COOKIE_UNSPEC,
    USER_ACTION_COOKIE_SFLOW,        /* Packet for per-bridge sFlow sampling. */
    USER_ACTION_COOKIE_SLOW_PATH,    /* Userspace must process this flow. */
    USER_ACTION_COOKIE_FLOW_SAMPLE,  /* Packet for per-flow sampling. */
    USER_ACTION_COOKIE_IPFIX,        /* Packet for per-bridge IPFIX sampling. */
};

/* user_action_cookie is passed as argument to OVS_ACTION_ATTR_USERSPACE.
 * Since it is passed to kernel as u64, its size has to be 8 bytes. */
union user_action_cookie {
    uint16_t type;              /* enum user_action_cookie_type. */

    struct {
        uint16_t type;          /* USER_ACTION_COOKIE_SFLOW. */
        ovs_be16 vlan_tci;      /* Destination VLAN TCI. */
        uint32_t output;        /* SFL_FLOW_SAMPLE_TYPE 'output' value. */
    } sflow;

    struct {
        uint16_t type;          /* USER_ACTION_COOKIE_SLOW_PATH. */
        uint16_t unused;
        uint32_t reason;        /* enum slow_path_reason. */
    } slow_path;

    struct {
        uint16_t type;          /* USER_ACTION_COOKIE_FLOW_SAMPLE. */
        uint16_t probability;   /* Sampling probability. */
        uint32_t collector_set_id; /* ID of IPFIX collector set. */
        uint32_t obs_domain_id; /* Observation Domain ID. */
        uint32_t obs_point_id;  /* Observation Point ID. */
    } flow_sample;

    struct {
        uint16_t type;          /* USER_ACTION_COOKIE_IPFIX. */
    } ipfix;
};
BUILD_ASSERT_DECL(sizeof(union user_action_cookie) == 16);

size_t odp_put_userspace_action(uint32_t pid,
                                const void *userdata, size_t userdata_size,
                                struct ofpbuf *odp_actions);
void odp_put_tunnel_action(const struct flow_tnl *tunnel,
                           struct ofpbuf *odp_actions);
void odp_put_pkt_mark_action(const uint32_t pkt_mark,
                             struct ofpbuf *odp_actions);

/* Reasons why a subfacet might not be fast-pathable. */
enum slow_path_reason {
    SLOW_CFM = 1,               /* CFM packets need per-packet processing. */
    SLOW_LACP,                  /* LACP packets need per-packet processing. */
    SLOW_STP,                   /* STP packets need per-packet processing. */
    SLOW_BFD,                   /* BFD packets need per-packet processing. */
    SLOW_CONTROLLER,            /* Packets must go to OpenFlow controller. */
    __SLOW_MAX
};

#endif /* odp-util.h */
Commit	Line	Data
064af421	1	/*
b9ad7294	2	* Copyright (c) 2009, 2010, 2011, 2012, 2013 Nicira, Inc.
064af421	3	*
a14bc59f BP	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:
064af421	7	*
a14bc59f BP	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.
064af421 BP	15	*/
	16
	17	#ifndef ODP_UTIL_H
	18	#define ODP_UTIL_H 1
	19
	20	#include <stdbool.h>
3762274e	21	#include <stddef.h>
064af421	22	#include <stdint.h>
14608a15	23	#include <string.h>
077257b8	24	#include <linux/openvswitch.h>
14608a15	25	#include "hash.h"
064af421	26	#include "openflow/openflow.h"
9026bf34	27	#include "util.h"
064af421 BP	28
064af421 BP	29	struct ds;
14608a15	30	struct flow;
b9ad7294	31	struct flow_tnl;
1dd35f8a	32	struct flow_wildcards;
5fa27009	33	struct nlattr;
36956a7d	34	struct ofpbuf;
44bac24b	35	struct simap;
064af421	36
4e022ec0 AW	37	#define ODPP_LOCAL ODP_PORT_C(OVSP_LOCAL)
4e022ec0 AW	38	#define ODPP_NONE ODP_PORT_C(UINT32_MAX)
c75d4dcf	39
cdee00fd BP	40	void format_odp_actions(struct ds , const struct nlattr odp_actions,
cdee00fd BP	41	size_t actions_len);
44bac24b	42	int odp_actions_from_string(const char , const struct simap port_names,
7202cbe5	43	struct ofpbuf *odp_actions);
064af421	44
2508ac16 BP	45	/* The maximum number of bytes that odp_flow_key_from_flow() appends to a
	46	* buffer. This is the upper bound on the length of a nlattr-formatted flow
	47	* key that ovs-vswitchd fully understands.
	48	*
	49	* OVS doesn't insist that ovs-vswitchd and the datapath have exactly the same
	50	* idea of a flow, so therefore this value isn't necessarily an upper bound on
	51	* the length of a flow key that the datapath can pass to ovs-vswitchd.
	52	*
	53	* The longest nlattr-formatted flow key appended by odp_flow_key_from_flow()
	54	* would be:
36956a7d	55	*
354d4c98 PS	56	* struct pad nl hdr total
	57	* ------ --- ------ -----
	58	* OVS_KEY_ATTR_PRIORITY 4 -- 4 8
354d4c98 PS	59	* OVS_KEY_ATTR_TUNNEL 0 -- 4 4
	60	* - OVS_TUNNEL_KEY_ATTR_ID 8 -- 4 12
	61	* - OVS_TUNNEL_KEY_ATTR_IPV4_SRC 4 -- 4 8
	62	* - OVS_TUNNEL_KEY_ATTR_IPV4_DST 4 -- 4 8
	63	* - OVS_TUNNEL_KEY_ATTR_TOS 1 3 4 8
	64	* - OVS_TUNNEL_KEY_ATTR_TTL 1 3 4 8
	65	* - OVS_TUNNEL_KEY_ATTR_DONT_FRAGMENT 0 -- 4 4
	66	* - OVS_TUNNEL_KEY_ATTR_CSUM 0 -- 4 4
	67	* OVS_KEY_ATTR_IN_PORT 4 -- 4 8
	68	* OVS_KEY_ATTR_SKB_MARK 4 -- 4 8
	69	* OVS_KEY_ATTR_ETHERNET 12 -- 4 16
	70	* OVS_KEY_ATTR_ETHERTYPE 2 2 4 8 (outer VLAN ethertype)
	71	* OVS_KEY_ATTR_8021Q 4 -- 4 8
	72	* OVS_KEY_ATTR_ENCAP 0 -- 4 4 (VLAN encapsulation)
	73	* OVS_KEY_ATTR_ETHERTYPE 2 2 4 8 (inner VLAN ethertype)
	74	* OVS_KEY_ATTR_IPV6 40 -- 4 44
	75	* OVS_KEY_ATTR_ICMPV6 2 2 4 8
	76	* OVS_KEY_ATTR_ND 28 -- 4 32
	77	* ----------------------------------------------------------
85c9de19	78	* total 208
2508ac16 BP	79	*
	80	* We include some slack space in case the calculation isn't quite right or we
	81	* add another field and forget to adjust this value.
18c43631	82	*/
72e8bf28	83	#define ODPUTIL_FLOW_KEY_BYTES 256
18c43631	84
19cf4069 BP	85	/* A buffer with sufficient size and alignment to hold an nlattr-formatted flow
	86	* key. An array of "struct nlattr" might not, in theory, be sufficiently
	87	* aligned because it only contains 16-bit types. */
	88	struct odputil_keybuf {
	89	uint32_t keybuf[DIV_ROUND_UP(ODPUTIL_FLOW_KEY_BYTES, 4)];
	90	};
14608a15	91
617e10e7 SH	92	enum odp_key_fitness odp_tun_key_from_attr(const struct nlattr *,
	93	struct flow_tnl *);
	94
e6cc0bab AZ	95	void odp_flow_format(const struct nlattr *key, size_t key_len,
e6cc0bab AZ	96	const struct nlattr *mask, size_t mask_len,
041e7168	97	struct ds *, bool verbose);
36956a7d	98	void odp_flow_key_format(const struct nlattr , size_t, struct ds );
e6cc0bab AZ	99	int odp_flow_from_string(const char *s,
	100	const struct simap *port_names,
	101	struct ofpbuf , struct ofpbuf );
14608a15	102
ddbfda84	103	void odp_flow_key_from_flow(struct ofpbuf , const struct flow ,
4e022ec0	104	odp_port_t odp_in_port);
661cbcd5 JP	105	void odp_flow_key_from_mask(struct ofpbuf , const struct flow mask,
661cbcd5 JP	106	const struct flow *flow, uint32_t odp_in_port);
b0f7b9b5 BP	107
	108	uint32_t odp_flow_key_hash(const struct nlattr *, size_t);
	109
	110	/* How well a kernel-provided flow key (a sequence of OVS_KEY_ATTR_*
	111	* attributes) matches OVS userspace expectations.
	112	*
	113	* These values are arranged so that greater values are "more important" than
	114	* lesser ones. In particular, a single flow key can fit the descriptions for
	115	* both ODP_FIT_TOO_LITTLE and ODP_FIT_TOO_MUCH. Such a key is treated as
	116	* ODP_FIT_TOO_LITTLE. */
	117	enum odp_key_fitness {
	118	ODP_FIT_PERFECT, /* The key had exactly the fields we expect. */
	119	ODP_FIT_TOO_MUCH, /* The key had fields we don't understand. */
	120	ODP_FIT_TOO_LITTLE, /* The key lacked fields we expected to see. */
	121	ODP_FIT_ERROR, /* The key was invalid. */
	122	};
	123	enum odp_key_fitness odp_flow_key_to_flow(const struct nlattr *, size_t,
	124	struct flow *);
6814e51f	125	const char *odp_key_fitness_to_string(enum odp_key_fitness);
14608a15	126
b9ad7294 EJ	127	void commit_odp_tunnel_action(const struct flow , struct flow base,
b9ad7294 EJ	128	struct ofpbuf *odp_actions);
6a7e895f	129	void commit_odp_actions(const struct flow , struct flow base,
1dd35f8a JP	130	struct ofpbuf *odp_actions,
1dd35f8a JP	131	struct flow_wildcards *wc);
6a7e895f BP	132	\f
	133	/* ofproto-dpif interface.
	134	*
	135	* The following types and functions are logically part of ofproto-dpif.
	136	* ofproto-dpif puts values of these types into the flows that it installs in
	137	* the kernel datapath, though, so ovs-dpctl needs to interpret them so that
	138	* it can print flows in a more human-readable manner. */
	139
6ff686f2 PS	140	enum user_action_cookie_type {
6ff686f2 PS	141	USER_ACTION_COOKIE_UNSPEC,
29089a54 RL	142	USER_ACTION_COOKIE_SFLOW, /* Packet for per-bridge sFlow sampling. */
	143	USER_ACTION_COOKIE_SLOW_PATH, /* Userspace must process this flow. */
	144	USER_ACTION_COOKIE_FLOW_SAMPLE, /* Packet for per-flow sampling. */
	145	USER_ACTION_COOKIE_IPFIX, /* Packet for per-bridge IPFIX sampling. */
6ff686f2 PS	146	};
	147
	148	/* user_action_cookie is passed as argument to OVS_ACTION_ATTR_USERSPACE.
0a18743a	149	* Since it is passed to kernel as u64, its size has to be 8 bytes. */
1673e0e4	150	union user_action_cookie {
36fc5f18 BP	151	uint16_t type; /* enum user_action_cookie_type. */
36fc5f18 BP	152
1673e0e4 BP	153	struct {
	154	uint16_t type; /* USER_ACTION_COOKIE_SFLOW. */
	155	ovs_be16 vlan_tci; /* Destination VLAN TCI. */
	156	uint32_t output; /* SFL_FLOW_SAMPLE_TYPE 'output' value. */
	157	} sflow;
6ff686f2	158
6a7e895f BP	159	struct {
	160	uint16_t type; /* USER_ACTION_COOKIE_SLOW_PATH. */
	161	uint16_t unused;
	162	uint32_t reason; /* enum slow_path_reason. */
	163	} slow_path;
29089a54 RL	164
	165	struct {
	166	uint16_t type; /* USER_ACTION_COOKIE_FLOW_SAMPLE. */
	167	uint16_t probability; /* Sampling probability. */
	168	uint32_t collector_set_id; /* ID of IPFIX collector set. */
	169	uint32_t obs_domain_id; /* Observation Domain ID. */
	170	uint32_t obs_point_id; /* Observation Point ID. */
	171	} flow_sample;
	172
	173	struct {
	174	uint16_t type; /* USER_ACTION_COOKIE_IPFIX. */
	175	} ipfix;
6a7e895f	176	};
29089a54	177	BUILD_ASSERT_DECL(sizeof(union user_action_cookie) == 16);
6ff686f2	178
39db78a0	179	size_t odp_put_userspace_action(uint32_t pid,
e995e3df	180	const void *userdata, size_t userdata_size,
39db78a0	181	struct ofpbuf *odp_actions);
b9ad7294 EJ	182	void odp_put_tunnel_action(const struct flow_tnl *tunnel,
b9ad7294 EJ	183	struct ofpbuf *odp_actions);
1362e248	184	void odp_put_pkt_mark_action(const uint32_t pkt_mark,
09a0d2e7	185	struct ofpbuf *odp_actions);
5bbda0aa	186
6a7e895f BP	187	/* Reasons why a subfacet might not be fast-pathable. */
6a7e895f BP	188	enum slow_path_reason {
98f0520f EJ	189	SLOW_CFM = 1, /* CFM packets need per-packet processing. */
	190	SLOW_LACP, /* LACP packets need per-packet processing. */
	191	SLOW_STP, /* STP packets need per-packet processing. */
	192	SLOW_BFD, /* BFD packets need per-packet processing. */
	193	SLOW_CONTROLLER, /* Packets must go to OpenFlow controller. */
	194	__SLOW_MAX
6a7e895f BP	195	};
6a7e895f BP	196
064af421	197	#endif /* odp-util.h */