[linux-block.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_mpls {
	u32	mpls_ttl:8,
		mpls_bos:1,
		mpls_tc:3,
		mpls_label:20;
};

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_arp:
 *	@ports: Operation, source and target addresses for an ARP header
 *              for Ethernet hardware addresses and IPv4 protocol addresses
 *		sip: Sender IP address
 *		tip: Target IP address
 *		op:  Operation
 *		sha: Sender hardware address
 *		tpa: Target hardware address
 */
struct flow_dissector_key_arp {
	__u32 sip;
	__u32 tip;
	__u8 op;
	unsigned char sha[ETH_ALEN];
	unsigned char tha[ETH_ALEN];
};

/**
 * 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_ARP, /* struct flow_dissector_key_arp */
	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_MPLS, /* struct flow_dissector_key_mpls */

	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
029c1ecb BL	44	struct flow_dissector_key_mpls {
	45	u32 mpls_ttl:8,
	46	mpls_bos:1,
	47	mpls_tc:3,
	48	mpls_label:20;
	49	};
	50
1fdd512c TH	51	struct flow_dissector_key_keyid {
	52	__be32 keyid;
	53	};
	54
fbff949e	55	/**
c3f83241 TH	56	* struct flow_dissector_key_ipv4_addrs:
	57	* @src: source ip address
	58	* @dst: destination ip address
fbff949e	59	*/
c3f83241	60	struct flow_dissector_key_ipv4_addrs {
fbff949e JP	61	/* (src,dst) must be grouped, in the same way than in IP header */
	62	__be32 src;
	63	__be32 dst;
	64	};
	65
c3f83241 TH	66	/**
	67	* struct flow_dissector_key_ipv6_addrs:
	68	* @src: source ip address
	69	* @dst: destination ip address
	70	*/
	71	struct flow_dissector_key_ipv6_addrs {
	72	/* (src,dst) must be grouped, in the same way than in IP header */
	73	struct in6_addr src;
	74	struct in6_addr dst;
	75	};
	76
9f249089 TH	77	/**
	78	* struct flow_dissector_key_tipc_addrs:
	79	* @srcnode: source node address
	80	*/
	81	struct flow_dissector_key_tipc_addrs {
	82	__be32 srcnode;
	83	};
	84
c3f83241 TH	85	/**
	86	* struct flow_dissector_key_addrs:
	87	* @v4addrs: IPv4 addresses
	88	* @v6addrs: IPv6 addresses
	89	*/
	90	struct flow_dissector_key_addrs {
	91	union {
	92	struct flow_dissector_key_ipv4_addrs v4addrs;
	93	struct flow_dissector_key_ipv6_addrs v6addrs;
9f249089	94	struct flow_dissector_key_tipc_addrs tipcaddrs;
c3f83241 TH	95	};
	96	};
	97
55733350 SH	98	/**
	99	* flow_dissector_key_arp:
	100	* @ports: Operation, source and target addresses for an ARP header
	101	* for Ethernet hardware addresses and IPv4 protocol addresses
	102	* sip: Sender IP address
	103	* tip: Target IP address
	104	* op: Operation
	105	* sha: Sender hardware address
	106	* tpa: Target hardware address
	107	*/
	108	struct flow_dissector_key_arp {
	109	__u32 sip;
	110	__u32 tip;
	111	__u8 op;
	112	unsigned char sha[ETH_ALEN];
	113	unsigned char tha[ETH_ALEN];
	114	};
	115
fbff949e JP	116	/**
	117	* flow_dissector_key_tp_ports:
	118	* @ports: port numbers of Transport header
59346afe JP	119	* src: source port number
59346afe JP	120	* dst: destination port number
fbff949e JP	121	*/
	122	struct flow_dissector_key_ports {
	123	union {
	124	__be32 ports;
59346afe JP	125	struct {
	126	__be16 src;
	127	__be16 dst;
	128	};
fbff949e JP	129	};
	130	};
	131
972d3876 SH	132	/**
	133	* flow_dissector_key_icmp:
	134	* @ports: type and code of ICMP header
	135	* icmp: ICMP type (high) and code (low)
	136	* type: ICMP type
	137	* code: ICMP code
	138	*/
	139	struct flow_dissector_key_icmp {
	140	union {
	141	__be16 icmp;
	142	struct {
	143	u8 type;
	144	u8 code;
	145	};
	146	};
	147	};
b924933c	148
67a900cc JP	149	/**
	150	* struct flow_dissector_key_eth_addrs:
	151	* @src: source Ethernet address
	152	* @dst: destination Ethernet address
	153	*/
	154	struct flow_dissector_key_eth_addrs {
	155	/* (dst,src) must be grouped, in the same way than in ETH header */
	156	unsigned char dst[ETH_ALEN];
	157	unsigned char src[ETH_ALEN];
	158	};
	159
fbff949e	160	enum flow_dissector_key_id {
42aecaa9	161	FLOW_DISSECTOR_KEY_CONTROL, /* struct flow_dissector_key_control */
fbff949e	162	FLOW_DISSECTOR_KEY_BASIC, /* struct flow_dissector_key_basic */
c3f83241 TH	163	FLOW_DISSECTOR_KEY_IPV4_ADDRS, /* struct flow_dissector_key_ipv4_addrs */
c3f83241 TH	164	FLOW_DISSECTOR_KEY_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */
fbff949e	165	FLOW_DISSECTOR_KEY_PORTS, /* struct flow_dissector_key_ports */
972d3876	166	FLOW_DISSECTOR_KEY_ICMP, /* struct flow_dissector_key_icmp */
67a900cc	167	FLOW_DISSECTOR_KEY_ETH_ADDRS, /* struct flow_dissector_key_eth_addrs */
9f249089	168	FLOW_DISSECTOR_KEY_TIPC_ADDRS, /* struct flow_dissector_key_tipc_addrs */
55733350	169	FLOW_DISSECTOR_KEY_ARP, /* struct flow_dissector_key_arp */
f6a66927	170	FLOW_DISSECTOR_KEY_VLAN, /* struct flow_dissector_key_flow_vlan */
87ee9e52	171	FLOW_DISSECTOR_KEY_FLOW_LABEL, /* struct flow_dissector_key_flow_tags */
1fdd512c	172	FLOW_DISSECTOR_KEY_GRE_KEYID, /* struct flow_dissector_key_keyid */
b3baa0fb	173	FLOW_DISSECTOR_KEY_MPLS_ENTROPY, /* struct flow_dissector_key_keyid */
9ba6a9a9 HHZ	174	FLOW_DISSECTOR_KEY_ENC_KEYID, /* struct flow_dissector_key_keyid */
	175	FLOW_DISSECTOR_KEY_ENC_IPV4_ADDRS, /* struct flow_dissector_key_ipv4_addrs */
	176	FLOW_DISSECTOR_KEY_ENC_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */
	177	FLOW_DISSECTOR_KEY_ENC_CONTROL, /* struct flow_dissector_key_control */
f4d997fd	178	FLOW_DISSECTOR_KEY_ENC_PORTS, /* struct flow_dissector_key_ports */
029c1ecb	179	FLOW_DISSECTOR_KEY_MPLS, /* struct flow_dissector_key_mpls */
fbff949e JP	180
	181	FLOW_DISSECTOR_KEY_MAX,
	182	};
	183
807e165d	184	#define FLOW_DISSECTOR_F_PARSE_1ST_FRAG BIT(0)
8306b688	185	#define FLOW_DISSECTOR_F_STOP_AT_L3 BIT(1)
872b1abb	186	#define FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL BIT(2)
823b9693	187	#define FLOW_DISSECTOR_F_STOP_AT_ENCAP BIT(3)
807e165d	188
fbff949e JP	189	struct flow_dissector_key {
	190	enum flow_dissector_key_id key_id;
	191	size_t offset; /* offset of struct flow_dissector_key_*
	192	in target the struct */
	193	};
	194
	195	struct flow_dissector {
	196	unsigned int used_keys; /* each bit repesents presence of one key id */
	197	unsigned short int offset[FLOW_DISSECTOR_KEY_MAX];
	198	};
	199
06635a35	200	struct flow_keys {
42aecaa9 TH	201	struct flow_dissector_key_control control;
42aecaa9 TH	202	#define FLOW_KEYS_HASH_START_FIELD basic
06635a35	203	struct flow_dissector_key_basic basic;
d34af823	204	struct flow_dissector_key_tags tags;
f6a66927	205	struct flow_dissector_key_vlan vlan;
1fdd512c	206	struct flow_dissector_key_keyid keyid;
42aecaa9 TH	207	struct flow_dissector_key_ports ports;
42aecaa9 TH	208	struct flow_dissector_key_addrs addrs;
06635a35 JP	209	};
06635a35 JP	210
42aecaa9 TH	211	#define FLOW_KEYS_HASH_OFFSET \
	212	offsetof(struct flow_keys, FLOW_KEYS_HASH_START_FIELD)
	213
c3f83241 TH	214	__be32 flow_get_u32_src(const struct flow_keys *flow);
	215	__be32 flow_get_u32_dst(const struct flow_keys *flow);
	216
06635a35 JP	217	extern struct flow_dissector flow_keys_dissector;
	218	extern struct flow_dissector flow_keys_buf_dissector;
	219
2f59e1eb TH	220	/* struct flow_keys_digest:
	221	*
	222	* This structure is used to hold a digest of the full flow keys. This is a
	223	* larger "hash" of a flow to allow definitively matching specific flows where
	224	* the 32 bit skb->hash is not large enough. The size is limited to 16 bytes so
	225	* that it can by used in CB of skb (see sch_choke for an example).
	226	*/
	227	#define FLOW_KEYS_DIGEST_LEN 16
	228	struct flow_keys_digest {
	229	u8 data[FLOW_KEYS_DIGEST_LEN];
	230	};
	231
	232	void make_flow_keys_digest(struct flow_keys_digest *digest,
	233	const struct flow_keys *flow);
	234
66fdd05e	235	static inline bool flow_keys_have_l4(const struct flow_keys *keys)
bcc83839 TH	236	{
	237	return (keys->ports.ports \|\| keys->tags.flow_label);
	238	}
	239
c6cc1ca7 TH	240	u32 flow_hash_from_keys(struct flow_keys *keys);
c6cc1ca7 TH	241
8de2d793 AV	242	static inline bool dissector_uses_key(const struct flow_dissector *flow_dissector,
	243	enum flow_dissector_key_id key_id)
	244	{
	245	return flow_dissector->used_keys & (1 << key_id);
	246	}
	247
	248	static inline void skb_flow_dissector_target(struct flow_dissector flow_dissector,
	249	enum flow_dissector_key_id key_id,
	250	void *target_container)
	251	{
	252	return ((char *)target_container) + flow_dissector->offset[key_id];
	253	}
	254
0744dd00	255	#endif