[linux-block.git] / include / net / flow_dissector.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _NET_FLOW_DISSECTOR_H
#define _NET_FLOW_DISSECTOR_H

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

struct bpf_prog;
struct net;
struct sk_buff;

/**
 * struct flow_dissector_key_control:
 * @thoff:     Transport header offset
 * @addr_type: Type of key. One of FLOW_DISSECTOR_KEY_*
 * @flags:     Key flags. Any of FLOW_DIS_(IS_FRAGMENT|FIRST_FRAGENCAPSULATION)
 */
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)

enum flow_dissect_ret {
	FLOW_DISSECT_RET_OUT_GOOD,
	FLOW_DISSECT_RET_OUT_BAD,
	FLOW_DISSECT_RET_PROTO_AGAIN,
	FLOW_DISSECT_RET_IPPROTO_AGAIN,
	FLOW_DISSECT_RET_CONTINUE,
};

/**
 * struct flow_dissector_key_basic:
 * @n_proto:  Network header protocol (eg. IPv4/IPv6)
 * @ip_proto: Transport header protocol (eg. TCP/UDP)
 * @padding:  Unused
 */
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 {
	union {
		struct {
			u16	vlan_id:12,
				vlan_dei:1,
				vlan_priority:3;
		};
		__be16	vlan_tci;
	};
	__be16	vlan_tpid;
	__be16	vlan_eth_type;
	u16	padding;
};

struct flow_dissector_mpls_lse {
	u32	mpls_ttl:8,
		mpls_bos:1,
		mpls_tc:3,
		mpls_label:20;
};

#define FLOW_DIS_MPLS_MAX 7
struct flow_dissector_key_mpls {
	struct flow_dissector_mpls_lse ls[FLOW_DIS_MPLS_MAX]; /* Label Stack */
	u8 used_lses; /* One bit set for each Label Stack Entry in use */
};

static inline void dissector_set_mpls_lse(struct flow_dissector_key_mpls *mpls,
					  int lse_index)
{
	mpls->used_lses |= 1 << lse_index;
}

#define FLOW_DIS_TUN_OPTS_MAX 255
/**
 * struct flow_dissector_key_enc_opts:
 * @data: tunnel option data
 * @len: length of tunnel option data
 * @dst_opt_type: tunnel option type
 */
struct flow_dissector_key_enc_opts {
	u8 data[FLOW_DIS_TUN_OPTS_MAX];	/* Using IP_TUNNEL_OPTS_MAX is desired
					 * here but seems difficult to #include
					 */
	u8 len;
	__be16 dst_opt_type;
};

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:
 * @key: source node address combined with selector
 */
struct flow_dissector_key_tipc {
	__be32 key;
};

/**
 * struct flow_dissector_key_addrs:
 * @v4addrs: IPv4 addresses
 * @v6addrs: IPv6 addresses
 * @tipckey: TIPC key
 */
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 tipckey;
	};
};

/**
 * struct flow_dissector_key_arp:
 * @sip: Sender IP address
 * @tip: Target IP address
 * @op:  Operation
 * @sha: Sender hardware address
 * @tha: Target hardware address
 */
struct flow_dissector_key_arp {
	__u32 sip;
	__u32 tip;
	__u8 op;
	unsigned char sha[ETH_ALEN];
	unsigned char tha[ETH_ALEN];
};

/**
 * struct flow_dissector_key_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;
		};
	};
};

/**
 * struct flow_dissector_key_ports_range
 * @tp: port number from packet
 * @tp_min: min port number in range
 * @tp_max: max port number in range
 */
struct flow_dissector_key_ports_range {
	union {
		struct flow_dissector_key_ports tp;
		struct {
			struct flow_dissector_key_ports tp_min;
			struct flow_dissector_key_ports tp_max;
		};
	};
};

/**
 * struct flow_dissector_key_icmp:
 * @type: ICMP type
 * @code: ICMP code
 * @id:   Session identifier
 */
struct flow_dissector_key_icmp {
	struct {
		u8 type;
		u8 code;
	};
	u16 id;
};

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

/**
 * struct flow_dissector_key_tcp:
 * @flags: flags
 */
struct flow_dissector_key_tcp {
	__be16 flags;
};

/**
 * struct flow_dissector_key_ip:
 * @tos: tos
 * @ttl: ttl
 */
struct flow_dissector_key_ip {
	__u8	tos;
	__u8	ttl;
};

/**
 * struct flow_dissector_key_meta:
 * @ingress_ifindex: ingress ifindex
 * @ingress_iftype: ingress interface type
 * @l2_miss: packet did not match an L2 entry during forwarding
 */
struct flow_dissector_key_meta {
	int ingress_ifindex;
	u16 ingress_iftype;
	u8 l2_miss;
};

/**
 * struct flow_dissector_key_ct:
 * @ct_state: conntrack state after converting with map
 * @ct_mark: conttrack mark
 * @ct_zone: conntrack zone
 * @ct_labels: conntrack labels
 */
struct flow_dissector_key_ct {
	u16	ct_state;
	u16	ct_zone;
	u32	ct_mark;
	u32	ct_labels[4];
};

/**
 * struct flow_dissector_key_hash:
 * @hash: hash value
 */
struct flow_dissector_key_hash {
	u32 hash;
};

/**
 * struct flow_dissector_key_num_of_vlans:
 * @num_of_vlans: num_of_vlans value
 */
struct flow_dissector_key_num_of_vlans {
	u8 num_of_vlans;
};

/**
 * struct flow_dissector_key_pppoe:
 * @session_id: pppoe session id
 * @ppp_proto: ppp protocol
 * @type: pppoe eth type
 */
struct flow_dissector_key_pppoe {
	__be16 session_id;
	__be16 ppp_proto;
	__be16 type;
};

/**
 * struct flow_dissector_key_l2tpv3:
 * @session_id: identifier for a l2tp session
 */
struct flow_dissector_key_l2tpv3 {
	__be32 session_id;
};

/**
 * struct flow_dissector_key_ipsec:
 * @spi: identifier for a ipsec connection
 */
struct flow_dissector_key_ipsec {
	__be32 spi;
};

/**
 * struct flow_dissector_key_cfm
 * @mdl_ver: maintenance domain level (mdl) and cfm protocol version
 * @opcode: code specifying a type of cfm protocol packet
 *
 * See 802.1ag, ITU-T G.8013/Y.1731
 *         1               2
 * |7 6 5 4 3 2 1 0|7 6 5 4 3 2 1 0|
 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 * | mdl | version |     opcode    |
 * +-----+---------+-+-+-+-+-+-+-+-+
 */
struct flow_dissector_key_cfm {
	u8	mdl_ver;
	u8	opcode;
};

#define FLOW_DIS_CFM_MDL_MASK GENMASK(7, 5)
#define FLOW_DIS_CFM_MDL_MAX 7

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_PORTS_RANGE, /* 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, /* struct flow_dissector_key_tipc */
	FLOW_DISSECTOR_KEY_ARP, /* struct flow_dissector_key_arp */
	FLOW_DISSECTOR_KEY_VLAN, /* struct flow_dissector_key_vlan */
	FLOW_DISSECTOR_KEY_FLOW_LABEL, /* struct flow_dissector_key_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_TCP, /* struct flow_dissector_key_tcp */
	FLOW_DISSECTOR_KEY_IP, /* struct flow_dissector_key_ip */
	FLOW_DISSECTOR_KEY_CVLAN, /* struct flow_dissector_key_vlan */
	FLOW_DISSECTOR_KEY_ENC_IP, /* struct flow_dissector_key_ip */
	FLOW_DISSECTOR_KEY_ENC_OPTS, /* struct flow_dissector_key_enc_opts */
	FLOW_DISSECTOR_KEY_META, /* struct flow_dissector_key_meta */
	FLOW_DISSECTOR_KEY_CT, /* struct flow_dissector_key_ct */
	FLOW_DISSECTOR_KEY_HASH, /* struct flow_dissector_key_hash */
	FLOW_DISSECTOR_KEY_NUM_OF_VLANS, /* struct flow_dissector_key_num_of_vlans */
	FLOW_DISSECTOR_KEY_PPPOE, /* struct flow_dissector_key_pppoe */
	FLOW_DISSECTOR_KEY_L2TPV3, /* struct flow_dissector_key_l2tpv3 */
	FLOW_DISSECTOR_KEY_CFM, /* struct flow_dissector_key_cfm */
	FLOW_DISSECTOR_KEY_IPSEC, /* struct flow_dissector_key_ipsec */

	FLOW_DISSECTOR_KEY_MAX,
};

#define FLOW_DISSECTOR_F_PARSE_1ST_FRAG		BIT(0)
#define FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL	BIT(1)
#define FLOW_DISSECTOR_F_STOP_AT_ENCAP		BIT(2)
#define FLOW_DISSECTOR_F_STOP_BEFORE_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 long long  used_keys;
		/* each bit represents presence of one key id */
	unsigned short int offset[FLOW_DISSECTOR_KEY_MAX];
};

struct flow_keys_basic {
	struct flow_dissector_key_control control;
	struct flow_dissector_key_basic basic;
};

struct flow_keys {
	struct flow_dissector_key_control control;
#define FLOW_KEYS_HASH_START_FIELD basic
	struct flow_dissector_key_basic basic __aligned(SIPHASH_ALIGNMENT);
	struct flow_dissector_key_tags tags;
	struct flow_dissector_key_vlan vlan;
	struct flow_dissector_key_vlan cvlan;
	struct flow_dissector_key_keyid keyid;
	struct flow_dissector_key_ports ports;
	struct flow_dissector_key_icmp icmp;
	/* 'addrs' must be the last member */
	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_basic_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 be 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);
void skb_flow_get_icmp_tci(const struct sk_buff *skb,
			   struct flow_dissector_key_icmp *key_icmp,
			   const void *data, int thoff, int hlen);

static inline bool dissector_uses_key(const struct flow_dissector *flow_dissector,
				      enum flow_dissector_key_id key_id)
{
	return flow_dissector->used_keys & (1ULL << 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];
}

struct bpf_flow_dissector {
	struct bpf_flow_keys	*flow_keys;
	const struct sk_buff	*skb;
	const void		*data;
	const void		*data_end;
};

static inline void
flow_dissector_init_keys(struct flow_dissector_key_control *key_control,
			 struct flow_dissector_key_basic *key_basic)
{
	memset(key_control, 0, sizeof(*key_control));
	memset(key_basic, 0, sizeof(*key_basic));
}

#ifdef CONFIG_BPF_SYSCALL
int flow_dissector_bpf_prog_attach_check(struct net *net,
					 struct bpf_prog *prog);
#endif /* CONFIG_BPF_SYSCALL */

#endif
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1bd758eb JP	2	#ifndef _NET_FLOW_DISSECTOR_H
1bd758eb JP	3	#define _NET_FLOW_DISSECTOR_H
0744dd00	4
c3f8eaeb	5	#include <linux/types.h>
b924933c	6	#include <linux/in6.h>
55667441	7	#include <linux/siphash.h>
8a9093c7	8	#include <linux/string.h>
67a900cc	9	#include <uapi/linux/if_ether.h>
c3f8eaeb	10
b27f7bb5 JS	11	struct bpf_prog;
b27f7bb5 JS	12	struct net;
5dec597e MC	13	struct sk_buff;
5dec597e MC	14
42aecaa9 TH	15	/**
42aecaa9 TH	16	* struct flow_dissector_key_control:
8c966a10 SH	17	* @thoff: Transport header offset
	18	* @addr_type: Type of key. One of FLOW_DISSECTOR_KEY_*
	19	* @flags: Key flags. Any of FLOW_DIS_(IS_FRAGMENT\|FIRST_FRAGENCAPSULATION)
42aecaa9 TH	20	*/
	21	struct flow_dissector_key_control {
	22	u16 thoff;
c3f83241	23	u16 addr_type;
4b36993d	24	u32 flags;
42aecaa9 TH	25	};
42aecaa9 TH	26
4b36993d DM	27	#define FLOW_DIS_IS_FRAGMENT BIT(0)
	28	#define FLOW_DIS_FIRST_FRAG BIT(1)
	29	#define FLOW_DIS_ENCAPSULATION BIT(2)
	30
3a1214e8 TH	31	enum flow_dissect_ret {
	32	FLOW_DISSECT_RET_OUT_GOOD,
	33	FLOW_DISSECT_RET_OUT_BAD,
	34	FLOW_DISSECT_RET_PROTO_AGAIN,
	35	FLOW_DISSECT_RET_IPPROTO_AGAIN,
	36	FLOW_DISSECT_RET_CONTINUE,
	37	};
	38
fbff949e JP	39	/**
fbff949e JP	40	* struct flow_dissector_key_basic:
8c966a10	41	* @n_proto: Network header protocol (eg. IPv4/IPv6)
fbff949e	42	* @ip_proto: Transport header protocol (eg. TCP/UDP)
8c966a10	43	* @padding: Unused
fbff949e JP	44	*/
fbff949e JP	45	struct flow_dissector_key_basic {
fbff949e JP	46	__be16 n_proto;
fbff949e JP	47	u8 ip_proto;
42aecaa9	48	u8 padding;
fbff949e JP	49	};
fbff949e JP	50
d34af823	51	struct flow_dissector_key_tags {
f6a66927 HHZ	52	u32 flow_label;
	53	};
	54
	55	struct flow_dissector_key_vlan {
a82055af	56	union {
d1746d1e PM	57	struct {
	58	u16 vlan_id:12,
	59	vlan_dei:1,
	60	vlan_priority:3;
	61	};
a82055af PNA	62	__be16 vlan_tci;
a82055af PNA	63	};
2064c3d4	64	__be16 vlan_tpid;
2105f700 VB	65	__be16 vlan_eth_type;
2105f700 VB	66	u16 padding;
d34af823 TH	67	};
d34af823 TH	68
58cff782	69	struct flow_dissector_mpls_lse {
029c1ecb BL	70	u32 mpls_ttl:8,
	71	mpls_bos:1,
	72	mpls_tc:3,
	73	mpls_label:20;
	74	};
	75
58cff782 GN	76	#define FLOW_DIS_MPLS_MAX 7
	77	struct flow_dissector_key_mpls {
	78	struct flow_dissector_mpls_lse ls[FLOW_DIS_MPLS_MAX]; /* Label Stack */
	79	u8 used_lses; /* One bit set for each Label Stack Entry in use */
	80	};
	81
	82	static inline void dissector_set_mpls_lse(struct flow_dissector_key_mpls *mpls,
	83	int lse_index)
	84	{
	85	mpls->used_lses \|= 1 << lse_index;
	86	}
	87
92e2c405 SH	88	#define FLOW_DIS_TUN_OPTS_MAX 255
	89	/**
	90	* struct flow_dissector_key_enc_opts:
	91	* @data: tunnel option data
	92	* @len: length of tunnel option data
	93	* @dst_opt_type: tunnel option type
	94	*/
	95	struct flow_dissector_key_enc_opts {
	96	u8 data[FLOW_DIS_TUN_OPTS_MAX]; /* Using IP_TUNNEL_OPTS_MAX is desired
	97	* here but seems difficult to #include
	98	*/
	99	u8 len;
	100	__be16 dst_opt_type;
	101	};
	102
1fdd512c TH	103	struct flow_dissector_key_keyid {
	104	__be32 keyid;
	105	};
	106
fbff949e	107	/**
c3f83241 TH	108	* struct flow_dissector_key_ipv4_addrs:
	109	* @src: source ip address
	110	* @dst: destination ip address
fbff949e	111	*/
c3f83241	112	struct flow_dissector_key_ipv4_addrs {
fbff949e JP	113	/* (src,dst) must be grouped, in the same way than in IP header */
	114	__be32 src;
	115	__be32 dst;
	116	};
	117
c3f83241 TH	118	/**
	119	* struct flow_dissector_key_ipv6_addrs:
	120	* @src: source ip address
	121	* @dst: destination ip address
	122	*/
	123	struct flow_dissector_key_ipv6_addrs {
	124	/* (src,dst) must be grouped, in the same way than in IP header */
	125	struct in6_addr src;
	126	struct in6_addr dst;
	127	};
	128
9f249089	129	/**
8d6e79d3 JM	130	* struct flow_dissector_key_tipc:
8d6e79d3 JM	131	* @key: source node address combined with selector
9f249089	132	*/
8d6e79d3 JM	133	struct flow_dissector_key_tipc {
8d6e79d3 JM	134	__be32 key;
9f249089 TH	135	};
9f249089 TH	136
c3f83241 TH	137	/**
	138	* struct flow_dissector_key_addrs:
	139	* @v4addrs: IPv4 addresses
	140	* @v6addrs: IPv6 addresses
8c966a10	141	* @tipckey: TIPC key
c3f83241 TH	142	*/
	143	struct flow_dissector_key_addrs {
	144	union {
	145	struct flow_dissector_key_ipv4_addrs v4addrs;
	146	struct flow_dissector_key_ipv6_addrs v6addrs;
8d6e79d3	147	struct flow_dissector_key_tipc tipckey;
c3f83241 TH	148	};
	149	};
	150
55733350	151	/**
8c966a10 SH	152	* struct flow_dissector_key_arp:
	153	* @sip: Sender IP address
	154	* @tip: Target IP address
	155	* @op: Operation
	156	* @sha: Sender hardware address
	157	* @tha: Target hardware address
55733350 SH	158	*/
	159	struct flow_dissector_key_arp {
	160	__u32 sip;
	161	__u32 tip;
	162	__u8 op;
	163	unsigned char sha[ETH_ALEN];
	164	unsigned char tha[ETH_ALEN];
	165	};
	166
fbff949e	167	/**
8c966a10 SH	168	* struct flow_dissector_key_ports:
	169	* @ports: port numbers of Transport header
	170	* @src: source port number
	171	* @dst: destination port number
fbff949e JP	172	*/
	173	struct flow_dissector_key_ports {
	174	union {
	175	__be32 ports;
59346afe JP	176	struct {
	177	__be16 src;
	178	__be16 dst;
	179	};
fbff949e JP	180	};
	181	};
	182
83d85bb0 MG	183	/**
	184	* struct flow_dissector_key_ports_range
	185	* @tp: port number from packet
	186	* @tp_min: min port number in range
	187	* @tp_max: max port number in range
	188	*/
	189	struct flow_dissector_key_ports_range {
	190	union {
	191	struct flow_dissector_key_ports tp;
	192	struct {
	193	struct flow_dissector_key_ports tp_min;
	194	struct flow_dissector_key_ports tp_max;
	195	};
	196	};
	197	};
	198
972d3876	199	/**
8c966a10 SH	200	* struct flow_dissector_key_icmp:
	201	* @type: ICMP type
	202	* @code: ICMP code
	203	* @id: Session identifier
972d3876 SH	204	*/
972d3876 SH	205	struct flow_dissector_key_icmp {
5dec597e MC	206	struct {
	207	u8 type;
	208	u8 code;
972d3876	209	};
5dec597e	210	u16 id;
972d3876	211	};
b924933c	212
67a900cc JP	213	/**
	214	* struct flow_dissector_key_eth_addrs:
	215	* @src: source Ethernet address
	216	* @dst: destination Ethernet address
	217	*/
	218	struct flow_dissector_key_eth_addrs {
	219	/* (dst,src) must be grouped, in the same way than in ETH header */
	220	unsigned char dst[ETH_ALEN];
	221	unsigned char src[ETH_ALEN];
	222	};
	223
ac4bb5de JP	224	/**
	225	* struct flow_dissector_key_tcp:
	226	* @flags: flags
	227	*/
	228	struct flow_dissector_key_tcp {
	229	__be16 flags;
	230	};
	231
518d8a2e OG	232	/**
	233	* struct flow_dissector_key_ip:
	234	* @tos: tos
	235	* @ttl: ttl
	236	*/
	237	struct flow_dissector_key_ip {
	238	__u8 tos;
	239	__u8 ttl;
	240	};
	241
82828b88 JP	242	/**
	243	* struct flow_dissector_key_meta:
	244	* @ingress_ifindex: ingress ifindex
8819efc9	245	* @ingress_iftype: ingress interface type
d5ccfd90	246	* @l2_miss: packet did not match an L2 entry during forwarding
82828b88 JP	247	*/
	248	struct flow_dissector_key_meta {
	249	int ingress_ifindex;
8819efc9	250	u16 ingress_iftype;
d5ccfd90	251	u8 l2_miss;
82828b88 JP	252	};
82828b88 JP	253
75a56758 PB	254	/**
	255	* struct flow_dissector_key_ct:
	256	* @ct_state: conntrack state after converting with map
	257	* @ct_mark: conttrack mark
	258	* @ct_zone: conntrack zone
	259	* @ct_labels: conntrack labels
	260	*/
	261	struct flow_dissector_key_ct {
	262	u16 ct_state;
	263	u16 ct_zone;
	264	u32 ct_mark;
	265	u32 ct_labels[4];
	266	};
	267
0cb09aff AL	268	/**
	269	* struct flow_dissector_key_hash:
	270	* @hash: hash value
	271	*/
	272	struct flow_dissector_key_hash {
	273	u32 hash;
	274	};
	275
34951fcf BS	276	/**
	277	* struct flow_dissector_key_num_of_vlans:
	278	* @num_of_vlans: num_of_vlans value
	279	*/
	280	struct flow_dissector_key_num_of_vlans {
	281	u8 num_of_vlans;
	282	};
	283
46126db9 WD	284	/**
	285	* struct flow_dissector_key_pppoe:
	286	* @session_id: pppoe session id
	287	* @ppp_proto: ppp protocol
	288	* @type: pppoe eth type
	289	*/
	290	struct flow_dissector_key_pppoe {
	291	__be16 session_id;
	292	__be16 ppp_proto;
	293	__be16 type;
	294	};
	295
dda2fa08 WD	296	/**
	297	* struct flow_dissector_key_l2tpv3:
	298	* @session_id: identifier for a l2tp session
	299	*/
	300	struct flow_dissector_key_l2tpv3 {
	301	__be32 session_id;
	302	};
	303
a57c34a8 RK	304	/**
	305	* struct flow_dissector_key_ipsec:
	306	* @spi: identifier for a ipsec connection
	307	*/
	308	struct flow_dissector_key_ipsec {
	309	__be32 spi;
	310	};
	311
d7ad70b5 ZD	312	/**
	313	* struct flow_dissector_key_cfm
	314	* @mdl_ver: maintenance domain level (mdl) and cfm protocol version
	315	* @opcode: code specifying a type of cfm protocol packet
	316	*
	317	* See 802.1ag, ITU-T G.8013/Y.1731
	318	* 1 2
	319	* \|7 6 5 4 3 2 1 0\|7 6 5 4 3 2 1 0\|
	320	* +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
	321	* \| mdl \| version \| opcode \|
	322	* +-----+---------+-+-+-+-+-+-+-+-+
	323	*/
	324	struct flow_dissector_key_cfm {
	325	u8 mdl_ver;
	326	u8 opcode;
	327	};
	328
	329	#define FLOW_DIS_CFM_MDL_MASK GENMASK(7, 5)
	330	#define FLOW_DIS_CFM_MDL_MAX 7
	331
fbff949e	332	enum flow_dissector_key_id {
42aecaa9	333	FLOW_DISSECTOR_KEY_CONTROL, /* struct flow_dissector_key_control */
fbff949e	334	FLOW_DISSECTOR_KEY_BASIC, /* struct flow_dissector_key_basic */
c3f83241 TH	335	FLOW_DISSECTOR_KEY_IPV4_ADDRS, /* struct flow_dissector_key_ipv4_addrs */
c3f83241 TH	336	FLOW_DISSECTOR_KEY_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */
fbff949e	337	FLOW_DISSECTOR_KEY_PORTS, /* struct flow_dissector_key_ports */
8ffb055b	338	FLOW_DISSECTOR_KEY_PORTS_RANGE, /* struct flow_dissector_key_ports */
972d3876	339	FLOW_DISSECTOR_KEY_ICMP, /* struct flow_dissector_key_icmp */
67a900cc	340	FLOW_DISSECTOR_KEY_ETH_ADDRS, /* struct flow_dissector_key_eth_addrs */
8d6e79d3	341	FLOW_DISSECTOR_KEY_TIPC, /* struct flow_dissector_key_tipc */
55733350	342	FLOW_DISSECTOR_KEY_ARP, /* struct flow_dissector_key_arp */
91c45956 EC	343	FLOW_DISSECTOR_KEY_VLAN, /* struct flow_dissector_key_vlan */
91c45956 EC	344	FLOW_DISSECTOR_KEY_FLOW_LABEL, /* struct flow_dissector_key_tags */
1fdd512c	345	FLOW_DISSECTOR_KEY_GRE_KEYID, /* struct flow_dissector_key_keyid */
b3baa0fb	346	FLOW_DISSECTOR_KEY_MPLS_ENTROPY, /* struct flow_dissector_key_keyid */
9ba6a9a9 HHZ	347	FLOW_DISSECTOR_KEY_ENC_KEYID, /* struct flow_dissector_key_keyid */
	348	FLOW_DISSECTOR_KEY_ENC_IPV4_ADDRS, /* struct flow_dissector_key_ipv4_addrs */
	349	FLOW_DISSECTOR_KEY_ENC_IPV6_ADDRS, /* struct flow_dissector_key_ipv6_addrs */
	350	FLOW_DISSECTOR_KEY_ENC_CONTROL, /* struct flow_dissector_key_control */
f4d997fd	351	FLOW_DISSECTOR_KEY_ENC_PORTS, /* struct flow_dissector_key_ports */
029c1ecb	352	FLOW_DISSECTOR_KEY_MPLS, /* struct flow_dissector_key_mpls */
ac4bb5de	353	FLOW_DISSECTOR_KEY_TCP, /* struct flow_dissector_key_tcp */
518d8a2e	354	FLOW_DISSECTOR_KEY_IP, /* struct flow_dissector_key_ip */
91c45956	355	FLOW_DISSECTOR_KEY_CVLAN, /* struct flow_dissector_key_vlan */
5544adb9	356	FLOW_DISSECTOR_KEY_ENC_IP, /* struct flow_dissector_key_ip */
92e2c405	357	FLOW_DISSECTOR_KEY_ENC_OPTS, /* struct flow_dissector_key_enc_opts */
82828b88	358	FLOW_DISSECTOR_KEY_META, /* struct flow_dissector_key_meta */
75a56758	359	FLOW_DISSECTOR_KEY_CT, /* struct flow_dissector_key_ct */
0cb09aff	360	FLOW_DISSECTOR_KEY_HASH, /* struct flow_dissector_key_hash */
34951fcf	361	FLOW_DISSECTOR_KEY_NUM_OF_VLANS, /* struct flow_dissector_key_num_of_vlans */
46126db9	362	FLOW_DISSECTOR_KEY_PPPOE, /* struct flow_dissector_key_pppoe */
dda2fa08	363	FLOW_DISSECTOR_KEY_L2TPV3, /* struct flow_dissector_key_l2tpv3 */
d7ad70b5	364	FLOW_DISSECTOR_KEY_CFM, /* struct flow_dissector_key_cfm */
a57c34a8	365	FLOW_DISSECTOR_KEY_IPSEC, /* struct flow_dissector_key_ipsec */
92e2c405	366
fbff949e JP	367	FLOW_DISSECTOR_KEY_MAX,
	368	};
	369
807e165d	370	#define FLOW_DISSECTOR_F_PARSE_1ST_FRAG BIT(0)
1cc26450 SF	371	#define FLOW_DISSECTOR_F_STOP_AT_FLOW_LABEL BIT(1)
1cc26450 SF	372	#define FLOW_DISSECTOR_F_STOP_AT_ENCAP BIT(2)
6de6e46d	373	#define FLOW_DISSECTOR_F_STOP_BEFORE_ENCAP BIT(3)
807e165d	374
fbff949e JP	375	struct flow_dissector_key {
	376	enum flow_dissector_key_id key_id;
	377	size_t offset; /* offset of struct flow_dissector_key_*
	378	in target the struct */
	379	};
	380
	381	struct flow_dissector {
2b3082c6 RK	382	unsigned long long used_keys;
2b3082c6 RK	383	/* each bit represents presence of one key id */
fbff949e JP	384	unsigned short int offset[FLOW_DISSECTOR_KEY_MAX];
	385	};
	386
72a338bc PA	387	struct flow_keys_basic {
	388	struct flow_dissector_key_control control;
	389	struct flow_dissector_key_basic basic;
	390	};
	391
06635a35	392	struct flow_keys {
42aecaa9 TH	393	struct flow_dissector_key_control control;
42aecaa9 TH	394	#define FLOW_KEYS_HASH_START_FIELD basic
55667441	395	struct flow_dissector_key_basic basic __aligned(SIPHASH_ALIGNMENT);
d34af823	396	struct flow_dissector_key_tags tags;
f6a66927	397	struct flow_dissector_key_vlan vlan;
24c590e3	398	struct flow_dissector_key_vlan cvlan;
1fdd512c	399	struct flow_dissector_key_keyid keyid;
42aecaa9	400	struct flow_dissector_key_ports ports;
5dec597e	401	struct flow_dissector_key_icmp icmp;
98298e6c	402	/* 'addrs' must be the last member */
42aecaa9	403	struct flow_dissector_key_addrs addrs;
06635a35 JP	404	};
06635a35 JP	405
42aecaa9 TH	406	#define FLOW_KEYS_HASH_OFFSET \
	407	offsetof(struct flow_keys, FLOW_KEYS_HASH_START_FIELD)
	408
c3f83241 TH	409	__be32 flow_get_u32_src(const struct flow_keys *flow);
	410	__be32 flow_get_u32_dst(const struct flow_keys *flow);
	411
06635a35	412	extern struct flow_dissector flow_keys_dissector;
72a338bc	413	extern struct flow_dissector flow_keys_basic_dissector;
06635a35	414
2f59e1eb TH	415	/* struct flow_keys_digest:
	416	*
	417	* This structure is used to hold a digest of the full flow keys. This is a
	418	* larger "hash" of a flow to allow definitively matching specific flows where
	419	* the 32 bit skb->hash is not large enough. The size is limited to 16 bytes so
53bc017f	420	* that it can be used in CB of skb (see sch_choke for an example).
2f59e1eb TH	421	*/
	422	#define FLOW_KEYS_DIGEST_LEN 16
	423	struct flow_keys_digest {
	424	u8 data[FLOW_KEYS_DIGEST_LEN];
	425	};
	426
	427	void make_flow_keys_digest(struct flow_keys_digest *digest,
	428	const struct flow_keys *flow);
	429
66fdd05e	430	static inline bool flow_keys_have_l4(const struct flow_keys *keys)
bcc83839 TH	431	{
	432	return (keys->ports.ports \|\| keys->tags.flow_label);
	433	}
	434
c6cc1ca7	435	u32 flow_hash_from_keys(struct flow_keys *keys);
5dec597e MC	436	void skb_flow_get_icmp_tci(const struct sk_buff *skb,
5dec597e MC	437	struct flow_dissector_key_icmp *key_icmp,
f96533cd	438	const void *data, int thoff, int hlen);
c6cc1ca7	439
8de2d793 AV	440	static inline bool dissector_uses_key(const struct flow_dissector *flow_dissector,
	441	enum flow_dissector_key_id key_id)
	442	{
2b3082c6	443	return flow_dissector->used_keys & (1ULL << key_id);
8de2d793 AV	444	}
	445
	446	static inline void skb_flow_dissector_target(struct flow_dissector flow_dissector,
	447	enum flow_dissector_key_id key_id,
	448	void *target_container)
	449	{
	450	return ((char *)target_container) + flow_dissector->offset[key_id];
	451	}
	452
089b19a9 SF	453	struct bpf_flow_dissector {
	454	struct bpf_flow_keys *flow_keys;
	455	const struct sk_buff *skb;
dac06b32 AL	456	const void *data;
dac06b32 AL	457	const void *data_end;
089b19a9 SF	458	};
089b19a9 SF	459
8a9093c7 JB	460	static inline void
	461	flow_dissector_init_keys(struct flow_dissector_key_control *key_control,
	462	struct flow_dissector_key_basic *key_basic)
	463	{
	464	memset(key_control, 0, sizeof(*key_control));
	465	memset(key_basic, 0, sizeof(*key_basic));
	466	}
	467
b27f7bb5	468	#ifdef CONFIG_BPF_SYSCALL
3b701699 JS	469	int flow_dissector_bpf_prog_attach_check(struct net *net,
3b701699 JS	470	struct bpf_prog *prog);
b27f7bb5 JS	471	#endif /* CONFIG_BPF_SYSCALL */
b27f7bb5 JS	472
0744dd00	473	#endif