[mirror_ubuntu-zesty-kernel.git] / include / net / flow_dissector.h

#ifndef _NET_FLOW_DISSECTOR_H
#define _NET_FLOW_DISSECTOR_H

#include <linux/types.h>
#include <linux/in6.h>
#include <uapi/linux/if_ether.h>

/**
 * struct flow_dissector_key_control:
 * @thoff: Transport header offset
 */
struct flow_dissector_key_control {
	u16	thoff;
	u16	addr_type;
	u32	flags;
};

#define FLOW_DIS_IS_FRAGMENT	BIT(0)
#define FLOW_DIS_FIRST_FRAG	BIT(1)
#define FLOW_DIS_ENCAPSULATION	BIT(2)

/**
 * struct flow_dissector_key_basic:
 * @thoff: Transport header offset
 * @n_proto: Network header protocol (eg. IPv4/IPv6)
 * @ip_proto: Transport header protocol (eg. TCP/UDP)
 */
struct flow_dissector_key_basic {
	__be16	n_proto;
	u8	ip_proto;
	u8	padding;
};

struct flow_dissector_key_tags {
	u32	flow_label;
};

struct flow_dissector_key_vlan {
	u16	vlan_id:12,
		vlan_priority:3;
	u16	padding;
};

struct flow_dissector_key_keyid {
	__be32	keyid;
};

/**
 * struct flow_dissector_key_ipv4_addrs:
 * @src: source ip address
 * @dst: destination ip address
 */
struct flow_dissector_key_ipv4_addrs {
	/* (src,dst) must be grouped, in the same way than in IP header */
	__be32 src;
	__be32 dst;
};

/**
 * struct flow_dissector_key_ipv6_addrs:
 * @src: source ip address
 * @dst: destination ip address
 */
struct flow_dissector_key_ipv6_addrs {
	/* (src,dst) must be grouped, in the same way than in IP header */
	struct in6_addr src;
	struct in6_addr dst;
};

/**
 * struct flow_dissector_key_tipc_addrs:
 * @srcnode: source node address
 */
struct flow_dissector_key_tipc_addrs {
	__be32 srcnode;
};

/**
 * struct flow_dissector_key_addrs:
 * @v4addrs: IPv4 addresses
 * @v6addrs: IPv6 addresses
 */
struct flow_dissector_key_addrs {
	union {
		struct flow_dissector_key_ipv4_addrs v4addrs;
		struct flow_dissector_key_ipv6_addrs v6addrs;
		struct flow_dissector_key_tipc_addrs tipcaddrs;
	};
};

/**
 * flow_dissector_key_tp_ports:
 *	@ports: port numbers of Transport header
 *		src: source port number
 *		dst: destination port number
 */
struct flow_dissector_key_ports {
	union {
		__be32 ports;
		struct {
			__be16 src;
			__be16 dst;
		};
	};
};

/**
 * flow_dissector_key_icmp:
 *	@ports: type and code of ICMP header
 *		icmp: ICMP type (high) and code (low)
 *		type: ICMP type
 *		code: ICMP code
 */
struct flow_dissector_key_icmp {
	union {
		__be16 icmp;
		struct {
			u8 type;
			u8 code;
		};
	};
};

/**
 * struct flow_dissector_key_eth_addrs:
 * @src: source Ethernet address
 * @dst: destination Ethernet address
 */
struct flow_dissector_key_eth_addrs {
	/* (dst,src) must be grouped, in the same way than in ETH header */
	unsigned char dst[ETH_ALEN];
	unsigned char src[ETH_ALEN];
};

enum flow_dissector_key_id {
	FLOW_DISSECTOR_KEY_CONTROL, /* struct flow_dissector_key_control */
	FLOW_DISSECTOR_KEY_BASIC, /* struct flow_dissector_key_basic */
	FLOW_DISSECTOR_KEY_IPV4_ADDRS, /* struct flow_dissector_key_ipv4_addrs */
	FLOW_DISSECTOR_KEY_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */
	FLOW_DISSECTOR_KEY_PORTS, /* struct flow_dissector_key_ports */
	FLOW_DISSECTOR_KEY_ICMP, /* struct flow_dissector_key_icmp */
	FLOW_DISSECTOR_KEY_ETH_ADDRS, /* struct flow_dissector_key_eth_addrs */
	FLOW_DISSECTOR_KEY_TIPC_ADDRS, /* struct flow_dissector_key_tipc_addrs */
	FLOW_DISSECTOR_KEY_VLAN, /* struct flow_dissector_key_flow_vlan */
	FLOW_DISSECTOR_KEY_FLOW_LABEL, /* struct flow_dissector_key_flow_tags */
	FLOW_DISSECTOR_KEY_GRE_KEYID, /* struct flow_dissector_key_keyid */
	FLOW_DISSECTOR_KEY_MPLS_ENTROPY, /* struct flow_dissector_key_keyid */
	FLOW_DISSECTOR_KEY_ENC_KEYID, /* struct flow_dissector_key_keyid */
	FLOW_DISSECTOR_KEY_ENC_IPV4_ADDRS, /* struct flow_dissector_key_ipv4_addrs */
	FLOW_DISSECTOR_KEY_ENC_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */
	FLOW_DISSECTOR_KEY_ENC_CONTROL, /* struct flow_dissector_key_control */
	FLOW_DISSECTOR_KEY_ENC_PORTS, /* struct flow_dissector_key_ports */

	FLOW_DISSECTOR_KEY_MAX,
};

#define FLOW_DISSECTOR_F_PARSE_1ST_FRAG		BIT(0)
#define FLOW_DISSECTOR_F_STOP_AT_L3		BIT(1)
#define FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL	BIT(2)
#define FLOW_DISSECTOR_F_STOP_AT_ENCAP		BIT(3)

struct flow_dissector_key {
	enum flow_dissector_key_id key_id;
	size_t offset; /* offset of struct flow_dissector_key_*
			  in target the struct */
};

struct flow_dissector {
	unsigned int used_keys; /* each bit repesents presence of one key id */
	unsigned short int offset[FLOW_DISSECTOR_KEY_MAX];
};

struct flow_keys {
	struct flow_dissector_key_control control;
#define FLOW_KEYS_HASH_START_FIELD basic
	struct flow_dissector_key_basic basic;
	struct flow_dissector_key_tags tags;
	struct flow_dissector_key_vlan vlan;
	struct flow_dissector_key_keyid keyid;
	struct flow_dissector_key_ports ports;
	struct flow_dissector_key_addrs addrs;
};

#define FLOW_KEYS_HASH_OFFSET		\
	offsetof(struct flow_keys, FLOW_KEYS_HASH_START_FIELD)

__be32 flow_get_u32_src(const struct flow_keys *flow);
__be32 flow_get_u32_dst(const struct flow_keys *flow);

extern struct flow_dissector flow_keys_dissector;
extern struct flow_dissector flow_keys_buf_dissector;

/* struct flow_keys_digest:
 *
 * This structure is used to hold a digest of the full flow keys. This is a
 * larger "hash" of a flow to allow definitively matching specific flows where
 * the 32 bit skb->hash is not large enough. The size is limited to 16 bytes so
 * that it can by used in CB of skb (see sch_choke for an example).
 */
#define FLOW_KEYS_DIGEST_LEN	16
struct flow_keys_digest {
	u8	data[FLOW_KEYS_DIGEST_LEN];
};

void make_flow_keys_digest(struct flow_keys_digest *digest,
			   const struct flow_keys *flow);

static inline bool flow_keys_have_l4(const struct flow_keys *keys)
{
	return (keys->ports.ports || keys->tags.flow_label);
}

u32 flow_hash_from_keys(struct flow_keys *keys);

static inline bool dissector_uses_key(const struct flow_dissector *flow_dissector,
				      enum flow_dissector_key_id key_id)
{
	return flow_dissector->used_keys & (1 << key_id);
}

static inline void *skb_flow_dissector_target(struct flow_dissector *flow_dissector,
					      enum flow_dissector_key_id key_id,
					      void *target_container)
{
	return ((char *)target_container) + flow_dissector->offset[key_id];
}

#endif
Commit	Line	Data
1bd758eb JP	1	#ifndef _NET_FLOW_DISSECTOR_H
1bd758eb JP	2	#define _NET_FLOW_DISSECTOR_H
0744dd00	3
c3f8eaeb	4	#include <linux/types.h>
b924933c	5	#include <linux/in6.h>
67a900cc	6	#include <uapi/linux/if_ether.h>
c3f8eaeb	7
42aecaa9 TH	8	/**
	9	* struct flow_dissector_key_control:
	10	* @thoff: Transport header offset
	11	*/
	12	struct flow_dissector_key_control {
	13	u16 thoff;
c3f83241	14	u16 addr_type;
4b36993d	15	u32 flags;
42aecaa9 TH	16	};
42aecaa9 TH	17
4b36993d DM	18	#define FLOW_DIS_IS_FRAGMENT BIT(0)
	19	#define FLOW_DIS_FIRST_FRAG BIT(1)
	20	#define FLOW_DIS_ENCAPSULATION BIT(2)
	21
fbff949e JP	22	/**
	23	* struct flow_dissector_key_basic:
	24	* @thoff: Transport header offset
	25	* @n_proto: Network header protocol (eg. IPv4/IPv6)
	26	* @ip_proto: Transport header protocol (eg. TCP/UDP)
	27	*/
	28	struct flow_dissector_key_basic {
fbff949e JP	29	__be16 n_proto;
fbff949e JP	30	u8 ip_proto;
42aecaa9	31	u8 padding;
fbff949e JP	32	};
fbff949e JP	33
d34af823	34	struct flow_dissector_key_tags {
f6a66927 HHZ	35	u32 flow_label;
	36	};
	37
	38	struct flow_dissector_key_vlan {
	39	u16 vlan_id:12,
	40	vlan_priority:3;
	41	u16 padding;
d34af823 TH	42	};
d34af823 TH	43
1fdd512c TH	44	struct flow_dissector_key_keyid {
	45	__be32 keyid;
	46	};
	47
fbff949e	48	/**
c3f83241 TH	49	* struct flow_dissector_key_ipv4_addrs:
	50	* @src: source ip address
	51	* @dst: destination ip address
fbff949e	52	*/
c3f83241	53	struct flow_dissector_key_ipv4_addrs {
fbff949e JP	54	/* (src,dst) must be grouped, in the same way than in IP header */
	55	__be32 src;
	56	__be32 dst;
	57	};
	58
c3f83241 TH	59	/**
	60	* struct flow_dissector_key_ipv6_addrs:
	61	* @src: source ip address
	62	* @dst: destination ip address
	63	*/
	64	struct flow_dissector_key_ipv6_addrs {
	65	/* (src,dst) must be grouped, in the same way than in IP header */
	66	struct in6_addr src;
	67	struct in6_addr dst;
	68	};
	69
9f249089 TH	70	/**
	71	* struct flow_dissector_key_tipc_addrs:
	72	* @srcnode: source node address
	73	*/
	74	struct flow_dissector_key_tipc_addrs {
	75	__be32 srcnode;
	76	};
	77
c3f83241 TH	78	/**
	79	* struct flow_dissector_key_addrs:
	80	* @v4addrs: IPv4 addresses
	81	* @v6addrs: IPv6 addresses
	82	*/
	83	struct flow_dissector_key_addrs {
	84	union {
	85	struct flow_dissector_key_ipv4_addrs v4addrs;
	86	struct flow_dissector_key_ipv6_addrs v6addrs;
9f249089	87	struct flow_dissector_key_tipc_addrs tipcaddrs;
c3f83241 TH	88	};
	89	};
	90
fbff949e JP	91	/**
	92	* flow_dissector_key_tp_ports:
	93	* @ports: port numbers of Transport header
59346afe JP	94	* src: source port number
59346afe JP	95	* dst: destination port number
fbff949e JP	96	*/
	97	struct flow_dissector_key_ports {
	98	union {
	99	__be32 ports;
59346afe JP	100	struct {
	101	__be16 src;
	102	__be16 dst;
	103	};
fbff949e JP	104	};
	105	};
	106
972d3876 SH	107	/**
	108	* flow_dissector_key_icmp:
	109	* @ports: type and code of ICMP header
	110	* icmp: ICMP type (high) and code (low)
	111	* type: ICMP type
	112	* code: ICMP code
	113	*/
	114	struct flow_dissector_key_icmp {
	115	union {
	116	__be16 icmp;
	117	struct {
	118	u8 type;
	119	u8 code;
	120	};
	121	};
	122	};
b924933c	123
67a900cc JP	124	/**
	125	* struct flow_dissector_key_eth_addrs:
	126	* @src: source Ethernet address
	127	* @dst: destination Ethernet address
	128	*/
	129	struct flow_dissector_key_eth_addrs {
	130	/* (dst,src) must be grouped, in the same way than in ETH header */
	131	unsigned char dst[ETH_ALEN];
	132	unsigned char src[ETH_ALEN];
	133	};
	134
fbff949e	135	enum flow_dissector_key_id {
42aecaa9	136	FLOW_DISSECTOR_KEY_CONTROL, /* struct flow_dissector_key_control */
fbff949e	137	FLOW_DISSECTOR_KEY_BASIC, /* struct flow_dissector_key_basic */
c3f83241 TH	138	FLOW_DISSECTOR_KEY_IPV4_ADDRS, /* struct flow_dissector_key_ipv4_addrs */
c3f83241 TH	139	FLOW_DISSECTOR_KEY_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */
fbff949e	140	FLOW_DISSECTOR_KEY_PORTS, /* struct flow_dissector_key_ports */
972d3876	141	FLOW_DISSECTOR_KEY_ICMP, /* struct flow_dissector_key_icmp */
67a900cc	142	FLOW_DISSECTOR_KEY_ETH_ADDRS, /* struct flow_dissector_key_eth_addrs */
9f249089	143	FLOW_DISSECTOR_KEY_TIPC_ADDRS, /* struct flow_dissector_key_tipc_addrs */
f6a66927	144	FLOW_DISSECTOR_KEY_VLAN, /* struct flow_dissector_key_flow_vlan */
87ee9e52	145	FLOW_DISSECTOR_KEY_FLOW_LABEL, /* struct flow_dissector_key_flow_tags */
1fdd512c	146	FLOW_DISSECTOR_KEY_GRE_KEYID, /* struct flow_dissector_key_keyid */
b3baa0fb	147	FLOW_DISSECTOR_KEY_MPLS_ENTROPY, /* struct flow_dissector_key_keyid */
9ba6a9a9 HHZ	148	FLOW_DISSECTOR_KEY_ENC_KEYID, /* struct flow_dissector_key_keyid */
	149	FLOW_DISSECTOR_KEY_ENC_IPV4_ADDRS, /* struct flow_dissector_key_ipv4_addrs */
	150	FLOW_DISSECTOR_KEY_ENC_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */
	151	FLOW_DISSECTOR_KEY_ENC_CONTROL, /* struct flow_dissector_key_control */
f4d997fd	152	FLOW_DISSECTOR_KEY_ENC_PORTS, /* struct flow_dissector_key_ports */
fbff949e JP	153
	154	FLOW_DISSECTOR_KEY_MAX,
	155	};
	156
807e165d	157	#define FLOW_DISSECTOR_F_PARSE_1ST_FRAG BIT(0)
8306b688	158	#define FLOW_DISSECTOR_F_STOP_AT_L3 BIT(1)
872b1abb	159	#define FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL BIT(2)
823b9693	160	#define FLOW_DISSECTOR_F_STOP_AT_ENCAP BIT(3)
807e165d	161
fbff949e JP	162	struct flow_dissector_key {
	163	enum flow_dissector_key_id key_id;
	164	size_t offset; /* offset of struct flow_dissector_key_*
	165	in target the struct */
	166	};
	167
	168	struct flow_dissector {
	169	unsigned int used_keys; /* each bit repesents presence of one key id */
	170	unsigned short int offset[FLOW_DISSECTOR_KEY_MAX];
	171	};
	172
06635a35	173	struct flow_keys {
42aecaa9 TH	174	struct flow_dissector_key_control control;
42aecaa9 TH	175	#define FLOW_KEYS_HASH_START_FIELD basic
06635a35	176	struct flow_dissector_key_basic basic;
d34af823	177	struct flow_dissector_key_tags tags;
f6a66927	178	struct flow_dissector_key_vlan vlan;
1fdd512c	179	struct flow_dissector_key_keyid keyid;
42aecaa9 TH	180	struct flow_dissector_key_ports ports;
42aecaa9 TH	181	struct flow_dissector_key_addrs addrs;
06635a35 JP	182	};
06635a35 JP	183
42aecaa9 TH	184	#define FLOW_KEYS_HASH_OFFSET \
	185	offsetof(struct flow_keys, FLOW_KEYS_HASH_START_FIELD)
	186
c3f83241 TH	187	__be32 flow_get_u32_src(const struct flow_keys *flow);
	188	__be32 flow_get_u32_dst(const struct flow_keys *flow);
	189
06635a35 JP	190	extern struct flow_dissector flow_keys_dissector;
	191	extern struct flow_dissector flow_keys_buf_dissector;
	192
2f59e1eb TH	193	/* struct flow_keys_digest:
	194	*
	195	* This structure is used to hold a digest of the full flow keys. This is a
	196	* larger "hash" of a flow to allow definitively matching specific flows where
	197	* the 32 bit skb->hash is not large enough. The size is limited to 16 bytes so
	198	* that it can by used in CB of skb (see sch_choke for an example).
	199	*/
	200	#define FLOW_KEYS_DIGEST_LEN 16
	201	struct flow_keys_digest {
	202	u8 data[FLOW_KEYS_DIGEST_LEN];
	203	};
	204
	205	void make_flow_keys_digest(struct flow_keys_digest *digest,
	206	const struct flow_keys *flow);
	207
66fdd05e	208	static inline bool flow_keys_have_l4(const struct flow_keys *keys)
bcc83839 TH	209	{
	210	return (keys->ports.ports \|\| keys->tags.flow_label);
	211	}
	212
c6cc1ca7 TH	213	u32 flow_hash_from_keys(struct flow_keys *keys);
c6cc1ca7 TH	214
8de2d793 AV	215	static inline bool dissector_uses_key(const struct flow_dissector *flow_dissector,
	216	enum flow_dissector_key_id key_id)
	217	{
	218	return flow_dissector->used_keys & (1 << key_id);
	219	}
	220
	221	static inline void skb_flow_dissector_target(struct flow_dissector flow_dissector,
	222	enum flow_dissector_key_id key_id,
	223	void *target_container)
	224	{
	225	return ((char *)target_container) + flow_dissector->offset[key_id];
	226	}
	227
0744dd00	228	#endif