[mirror_ubuntu-bionic-kernel.git] / include / linux / filter.h

/*
 * Linux Socket Filter Data Structures
 */
#ifndef __LINUX_FILTER_H__
#define __LINUX_FILTER_H__

#include <linux/atomic.h>
#include <linux/compat.h>
#include <linux/workqueue.h>
#include <uapi/linux/filter.h>

/* Internally used and optimized filter representation with extended
 * instruction set based on top of classic BPF.
 */

/* instruction classes */
#define BPF_ALU64	0x07	/* alu mode in double word width */

/* ld/ldx fields */
#define BPF_DW		0x18	/* double word */
#define BPF_XADD	0xc0	/* exclusive add */

/* alu/jmp fields */
#define BPF_MOV		0xb0	/* mov reg to reg */
#define BPF_ARSH	0xc0	/* sign extending arithmetic shift right */

/* change endianness of a register */
#define BPF_END		0xd0	/* flags for endianness conversion: */
#define BPF_TO_LE	0x00	/* convert to little-endian */
#define BPF_TO_BE	0x08	/* convert to big-endian */
#define BPF_FROM_LE	BPF_TO_LE
#define BPF_FROM_BE	BPF_TO_BE

#define BPF_JNE		0x50	/* jump != */
#define BPF_JSGT	0x60	/* SGT is signed '>', GT in x86 */
#define BPF_JSGE	0x70	/* SGE is signed '>=', GE in x86 */
#define BPF_CALL	0x80	/* function call */
#define BPF_EXIT	0x90	/* function return */

/* BPF has 10 general purpose 64-bit registers and stack frame. */
#define MAX_BPF_REG	11

/* BPF program can access up to 512 bytes of stack space. */
#define MAX_BPF_STACK	512

/* Arg1, context and stack frame pointer register positions. */
#define ARG1_REG	1
#define CTX_REG		6
#define FP_REG		10

struct sock_filter_int {
	__u8	code;		/* opcode */
	__u8	a_reg:4;	/* dest register */
	__u8	x_reg:4;	/* source register */
	__s16	off;		/* signed offset */
	__s32	imm;		/* signed immediate constant */
};

#ifdef CONFIG_COMPAT
/* A struct sock_filter is architecture independent. */
struct compat_sock_fprog {
	u16		len;
	compat_uptr_t	filter;	/* struct sock_filter * */
};
#endif

struct sock_fprog_kern {
	u16			len;
	struct sock_filter	*filter;
};

struct sk_buff;
struct sock;
struct seccomp_data;

struct sk_filter {
	atomic_t		refcnt;
	u32			jited:1,	/* Is our filter JIT'ed? */
				len:31;		/* Number of filter blocks */
	struct sock_fprog_kern	*orig_prog;	/* Original BPF program */
	struct rcu_head		rcu;
	unsigned int		(*bpf_func)(const struct sk_buff *skb,
					    const struct sock_filter_int *filter);
	union {
		struct sock_filter	insns[0];
		struct sock_filter_int	insnsi[0];
		struct work_struct	work;
	};
};

static inline unsigned int sk_filter_size(unsigned int proglen)
{
	return max(sizeof(struct sk_filter),
		   offsetof(struct sk_filter, insns[proglen]));
}

#define sk_filter_proglen(fprog)			\
		(fprog->len * sizeof(fprog->filter[0]))

#define SK_RUN_FILTER(filter, ctx)			\
		(*filter->bpf_func)(ctx, filter->insnsi)

int sk_filter(struct sock *sk, struct sk_buff *skb);

u32 sk_run_filter_int_seccomp(const struct seccomp_data *ctx,
			      const struct sock_filter_int *insni);
u32 sk_run_filter_int_skb(const struct sk_buff *ctx,
			  const struct sock_filter_int *insni);

int sk_convert_filter(struct sock_filter *prog, int len,
		      struct sock_filter_int *new_prog, int *new_len);

int sk_unattached_filter_create(struct sk_filter **pfp,
				struct sock_fprog *fprog);
void sk_unattached_filter_destroy(struct sk_filter *fp);

int sk_attach_filter(struct sock_fprog *fprog, struct sock *sk);
int sk_detach_filter(struct sock *sk);

int sk_chk_filter(struct sock_filter *filter, unsigned int flen);
int sk_get_filter(struct sock *sk, struct sock_filter __user *filter,
		  unsigned int len);
void sk_decode_filter(struct sock_filter *filt, struct sock_filter *to);

void sk_filter_charge(struct sock *sk, struct sk_filter *fp);
void sk_filter_uncharge(struct sock *sk, struct sk_filter *fp);

#ifdef CONFIG_BPF_JIT
#include <stdarg.h>
#include <linux/linkage.h>
#include <linux/printk.h>

void bpf_jit_compile(struct sk_filter *fp);
void bpf_jit_free(struct sk_filter *fp);

static inline void bpf_jit_dump(unsigned int flen, unsigned int proglen,
				u32 pass, void *image)
{
	pr_err("flen=%u proglen=%u pass=%u image=%pK\n",
	       flen, proglen, pass, image);
	if (image)
		print_hex_dump(KERN_ERR, "JIT code: ", DUMP_PREFIX_OFFSET,
			       16, 1, image, proglen, false);
}
#else
#include <linux/slab.h>
static inline void bpf_jit_compile(struct sk_filter *fp)
{
}
static inline void bpf_jit_free(struct sk_filter *fp)
{
	kfree(fp);
}
#endif

static inline int bpf_tell_extensions(void)
{
	return SKF_AD_MAX;
}

enum {
	BPF_S_RET_K = 1,
	BPF_S_RET_A,
	BPF_S_ALU_ADD_K,
	BPF_S_ALU_ADD_X,
	BPF_S_ALU_SUB_K,
	BPF_S_ALU_SUB_X,
	BPF_S_ALU_MUL_K,
	BPF_S_ALU_MUL_X,
	BPF_S_ALU_DIV_X,
	BPF_S_ALU_MOD_K,
	BPF_S_ALU_MOD_X,
	BPF_S_ALU_AND_K,
	BPF_S_ALU_AND_X,
	BPF_S_ALU_OR_K,
	BPF_S_ALU_OR_X,
	BPF_S_ALU_XOR_K,
	BPF_S_ALU_XOR_X,
	BPF_S_ALU_LSH_K,
	BPF_S_ALU_LSH_X,
	BPF_S_ALU_RSH_K,
	BPF_S_ALU_RSH_X,
	BPF_S_ALU_NEG,
	BPF_S_LD_W_ABS,
	BPF_S_LD_H_ABS,
	BPF_S_LD_B_ABS,
	BPF_S_LD_W_LEN,
	BPF_S_LD_W_IND,
	BPF_S_LD_H_IND,
	BPF_S_LD_B_IND,
	BPF_S_LD_IMM,
	BPF_S_LDX_W_LEN,
	BPF_S_LDX_B_MSH,
	BPF_S_LDX_IMM,
	BPF_S_MISC_TAX,
	BPF_S_MISC_TXA,
	BPF_S_ALU_DIV_K,
	BPF_S_LD_MEM,
	BPF_S_LDX_MEM,
	BPF_S_ST,
	BPF_S_STX,
	BPF_S_JMP_JA,
	BPF_S_JMP_JEQ_K,
	BPF_S_JMP_JEQ_X,
	BPF_S_JMP_JGE_K,
	BPF_S_JMP_JGE_X,
	BPF_S_JMP_JGT_K,
	BPF_S_JMP_JGT_X,
	BPF_S_JMP_JSET_K,
	BPF_S_JMP_JSET_X,
	/* Ancillary data */
	BPF_S_ANC_PROTOCOL,
	BPF_S_ANC_PKTTYPE,
	BPF_S_ANC_IFINDEX,
	BPF_S_ANC_NLATTR,
	BPF_S_ANC_NLATTR_NEST,
	BPF_S_ANC_MARK,
	BPF_S_ANC_QUEUE,
	BPF_S_ANC_HATYPE,
	BPF_S_ANC_RXHASH,
	BPF_S_ANC_CPU,
	BPF_S_ANC_ALU_XOR_X,
	BPF_S_ANC_VLAN_TAG,
	BPF_S_ANC_VLAN_TAG_PRESENT,
	BPF_S_ANC_PAY_OFFSET,
};

#endif /* __LINUX_FILTER_H__ */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Linux Socket Filter Data Structures
	3	*/
1da177e4 LT	4	#ifndef __LINUX_FILTER_H__
	5	#define __LINUX_FILTER_H__
	6
60063497	7	#include <linux/atomic.h>
0c5fe1b4	8	#include <linux/compat.h>
d45ed4a4	9	#include <linux/workqueue.h>
607ca46e	10	#include <uapi/linux/filter.h>
792d4b5c	11
bd4cf0ed AS	12	/* Internally used and optimized filter representation with extended
bd4cf0ed AS	13	* instruction set based on top of classic BPF.
0c5fe1b4	14	*/
bd4cf0ed AS	15
	16	/* instruction classes */
	17	#define BPF_ALU64 0x07 /* alu mode in double word width */
	18
	19	/* ld/ldx fields */
	20	#define BPF_DW 0x18 /* double word */
	21	#define BPF_XADD 0xc0 /* exclusive add */
	22
	23	/* alu/jmp fields */
	24	#define BPF_MOV 0xb0 /* mov reg to reg */
	25	#define BPF_ARSH 0xc0 /* sign extending arithmetic shift right */
	26
	27	/* change endianness of a register */
	28	#define BPF_END 0xd0 /* flags for endianness conversion: */
	29	#define BPF_TO_LE 0x00 /* convert to little-endian */
	30	#define BPF_TO_BE 0x08 /* convert to big-endian */
	31	#define BPF_FROM_LE BPF_TO_LE
	32	#define BPF_FROM_BE BPF_TO_BE
	33
	34	#define BPF_JNE 0x50 /* jump != */
	35	#define BPF_JSGT 0x60 /* SGT is signed '>', GT in x86 */
	36	#define BPF_JSGE 0x70 /* SGE is signed '>=', GE in x86 */
	37	#define BPF_CALL 0x80 /* function call */
	38	#define BPF_EXIT 0x90 /* function return */
	39
	40	/* BPF has 10 general purpose 64-bit registers and stack frame. */
	41	#define MAX_BPF_REG 11
	42
	43	/* BPF program can access up to 512 bytes of stack space. */
	44	#define MAX_BPF_STACK 512
	45
	46	/* Arg1, context and stack frame pointer register positions. */
	47	#define ARG1_REG 1
	48	#define CTX_REG 6
	49	#define FP_REG 10
	50
	51	struct sock_filter_int {
	52	__u8 code; /* opcode */
	53	__u8 a_reg:4; /* dest register */
	54	__u8 x_reg:4; /* source register */
	55	__s16 off; /* signed offset */
	56	__s32 imm; /* signed immediate constant */
	57	};
	58
	59	#ifdef CONFIG_COMPAT
	60	/* A struct sock_filter is architecture independent. */
0c5fe1b4 WD	61	struct compat_sock_fprog {
0c5fe1b4 WD	62	u16 len;
bd4cf0ed	63	compat_uptr_t filter; /* struct sock_filter * */
0c5fe1b4 WD	64	};
	65	#endif
	66
a3ea269b DB	67	struct sock_fprog_kern {
	68	u16 len;
	69	struct sock_filter *filter;
	70	};
	71
792d4b5c HC	72	struct sk_buff;
792d4b5c HC	73	struct sock;
bd4cf0ed	74	struct seccomp_data;
792d4b5c	75
a3ea269b	76	struct sk_filter {
b715631f	77	atomic_t refcnt;
f8bbbfc3 DB	78	u32 jited:1, /* Is our filter JIT'ed? */
f8bbbfc3 DB	79	len:31; /* Number of filter blocks */
a3ea269b	80	struct sock_fprog_kern orig_prog; / Original BPF program */
d45ed4a4	81	struct rcu_head rcu;
0a14842f	82	unsigned int (bpf_func)(const struct sk_buff skb,
bd4cf0ed	83	const struct sock_filter_int *filter);
d45ed4a4	84	union {
bd4cf0ed AS	85	struct sock_filter insns[0];
bd4cf0ed AS	86	struct sock_filter_int insnsi[0];
d45ed4a4 AS	87	struct work_struct work;
d45ed4a4 AS	88	};
b715631f SH	89	};
b715631f SH	90
d45ed4a4	91	static inline unsigned int sk_filter_size(unsigned int proglen)
b715631f	92	{
d45ed4a4 AS	93	return max(sizeof(struct sk_filter),
d45ed4a4 AS	94	offsetof(struct sk_filter, insns[proglen]));
b715631f SH	95	}
b715631f SH	96
a3ea269b DB	97	#define sk_filter_proglen(fprog) \
	98	(fprog->len * sizeof(fprog->filter[0]))
	99
bd4cf0ed AS	100	#define SK_RUN_FILTER(filter, ctx) \
	101	(*filter->bpf_func)(ctx, filter->insnsi)
	102
fbc907f0	103	int sk_filter(struct sock sk, struct sk_buff skb);
bd4cf0ed AS	104
	105	u32 sk_run_filter_int_seccomp(const struct seccomp_data *ctx,
	106	const struct sock_filter_int *insni);
	107	u32 sk_run_filter_int_skb(const struct sk_buff *ctx,
	108	const struct sock_filter_int *insni);
	109
	110	int sk_convert_filter(struct sock_filter *prog, int len,
	111	struct sock_filter_int new_prog, int new_len);
a3ea269b	112
fbc907f0 DB	113	int sk_unattached_filter_create(struct sk_filter **pfp,
	114	struct sock_fprog *fprog);
	115	void sk_unattached_filter_destroy(struct sk_filter *fp);
a3ea269b	116
fbc907f0 DB	117	int sk_attach_filter(struct sock_fprog fprog, struct sock sk);
fbc907f0 DB	118	int sk_detach_filter(struct sock *sk);
a3ea269b	119
fbc907f0 DB	120	int sk_chk_filter(struct sock_filter *filter, unsigned int flen);
	121	int sk_get_filter(struct sock sk, struct sock_filter __user filter,
	122	unsigned int len);
	123	void sk_decode_filter(struct sock_filter filt, struct sock_filter to);
	124
	125	void sk_filter_charge(struct sock sk, struct sk_filter fp);
	126	void sk_filter_uncharge(struct sock sk, struct sk_filter fp);
0a14842f ED	127
0a14842f ED	128	#ifdef CONFIG_BPF_JIT
20074f35	129	#include <stdarg.h>
a691ce7f CG	130	#include <linux/linkage.h>
	131	#include <linux/printk.h>
	132
fbc907f0 DB	133	void bpf_jit_compile(struct sk_filter *fp);
fbc907f0 DB	134	void bpf_jit_free(struct sk_filter *fp);
79617801 DB	135
	136	static inline void bpf_jit_dump(unsigned int flen, unsigned int proglen,
	137	u32 pass, void *image)
	138	{
16495445	139	pr_err("flen=%u proglen=%u pass=%u image=%pK\n",
79617801 DB	140	flen, proglen, pass, image);
79617801 DB	141	if (image)
16495445	142	print_hex_dump(KERN_ERR, "JIT code: ", DUMP_PREFIX_OFFSET,
79617801 DB	143	16, 1, image, proglen, false);
79617801 DB	144	}
0a14842f	145	#else
d45ed4a4	146	#include <linux/slab.h>
0a14842f ED	147	static inline void bpf_jit_compile(struct sk_filter *fp)
	148	{
	149	}
	150	static inline void bpf_jit_free(struct sk_filter *fp)
	151	{
d45ed4a4	152	kfree(fp);
0a14842f	153	}
0a14842f ED	154	#endif
0a14842f ED	155
ea02f941 MS	156	static inline int bpf_tell_extensions(void)
ea02f941 MS	157	{
37692299	158	return SKF_AD_MAX;
ea02f941 MS	159	}
ea02f941 MS	160
0a14842f ED	161	enum {
	162	BPF_S_RET_K = 1,
	163	BPF_S_RET_A,
	164	BPF_S_ALU_ADD_K,
	165	BPF_S_ALU_ADD_X,
	166	BPF_S_ALU_SUB_K,
	167	BPF_S_ALU_SUB_X,
	168	BPF_S_ALU_MUL_K,
	169	BPF_S_ALU_MUL_X,
	170	BPF_S_ALU_DIV_X,
b6069a95 ED	171	BPF_S_ALU_MOD_K,
b6069a95 ED	172	BPF_S_ALU_MOD_X,
0a14842f ED	173	BPF_S_ALU_AND_K,
	174	BPF_S_ALU_AND_X,
	175	BPF_S_ALU_OR_K,
	176	BPF_S_ALU_OR_X,
9e49e889 DB	177	BPF_S_ALU_XOR_K,
9e49e889 DB	178	BPF_S_ALU_XOR_X,
0a14842f ED	179	BPF_S_ALU_LSH_K,
	180	BPF_S_ALU_LSH_X,
	181	BPF_S_ALU_RSH_K,
	182	BPF_S_ALU_RSH_X,
	183	BPF_S_ALU_NEG,
	184	BPF_S_LD_W_ABS,
	185	BPF_S_LD_H_ABS,
	186	BPF_S_LD_B_ABS,
	187	BPF_S_LD_W_LEN,
	188	BPF_S_LD_W_IND,
	189	BPF_S_LD_H_IND,
	190	BPF_S_LD_B_IND,
	191	BPF_S_LD_IMM,
	192	BPF_S_LDX_W_LEN,
	193	BPF_S_LDX_B_MSH,
	194	BPF_S_LDX_IMM,
	195	BPF_S_MISC_TAX,
	196	BPF_S_MISC_TXA,
	197	BPF_S_ALU_DIV_K,
	198	BPF_S_LD_MEM,
	199	BPF_S_LDX_MEM,
	200	BPF_S_ST,
	201	BPF_S_STX,
	202	BPF_S_JMP_JA,
	203	BPF_S_JMP_JEQ_K,
	204	BPF_S_JMP_JEQ_X,
	205	BPF_S_JMP_JGE_K,
	206	BPF_S_JMP_JGE_X,
	207	BPF_S_JMP_JGT_K,
	208	BPF_S_JMP_JGT_X,
	209	BPF_S_JMP_JSET_K,
	210	BPF_S_JMP_JSET_X,
	211	/* Ancillary data */
	212	BPF_S_ANC_PROTOCOL,
	213	BPF_S_ANC_PKTTYPE,
	214	BPF_S_ANC_IFINDEX,
	215	BPF_S_ANC_NLATTR,
	216	BPF_S_ANC_NLATTR_NEST,
	217	BPF_S_ANC_MARK,
	218	BPF_S_ANC_QUEUE,
	219	BPF_S_ANC_HATYPE,
	220	BPF_S_ANC_RXHASH,
	221	BPF_S_ANC_CPU,
ffe06c17	222	BPF_S_ANC_ALU_XOR_X,
f3335031 ED	223	BPF_S_ANC_VLAN_TAG,
f3335031 ED	224	BPF_S_ANC_VLAN_TAG_PRESENT,
3e5289d5	225	BPF_S_ANC_PAY_OFFSET,
0a14842f ED	226	};
0a14842f ED	227
1da177e4	228	#endif /* __LINUX_FILTER_H__ */