[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>
#include <uapi/linux/pkt_cls.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_FRAG|ENCAPSULATION|F_*)
 */
struct flow_dissector_key_control {
	u16	thoff;
	u16	addr_type;
	u32	flags;
};

/* The control flags are kept in sync with TCA_FLOWER_KEY_FLAGS_*, as those
 * flags are exposed to userspace in some error paths, ie. unsupported flags.
 */
enum flow_dissector_ctrl_flags {
	FLOW_DIS_IS_FRAGMENT		= TCA_FLOWER_KEY_FLAGS_IS_FRAGMENT,
	FLOW_DIS_FIRST_FRAG		= TCA_FLOWER_KEY_FLAGS_FRAG_IS_FIRST,
	FLOW_DIS_F_TUNNEL_CSUM		= TCA_FLOWER_KEY_FLAGS_TUNNEL_CSUM,
	FLOW_DIS_F_TUNNEL_DONT_FRAGMENT	= TCA_FLOWER_KEY_FLAGS_TUNNEL_DONT_FRAGMENT,
	FLOW_DIS_F_TUNNEL_OAM		= TCA_FLOWER_KEY_FLAGS_TUNNEL_OAM,
	FLOW_DIS_F_TUNNEL_CRIT_OPT	= TCA_FLOWER_KEY_FLAGS_TUNNEL_CRIT_OPT,

	/* These flags are internal to the kernel */
	FLOW_DIS_ENCAPSULATION		= (TCA_FLOWER_KEY_FLAGS_MAX << 1),
};

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