[linux-2.6-block.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/skbuff.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 */

/* Register numbers */
enum {
	BPF_REG_0 = 0,
	BPF_REG_1,
	BPF_REG_2,
	BPF_REG_3,
	BPF_REG_4,
	BPF_REG_5,
	BPF_REG_6,
	BPF_REG_7,
	BPF_REG_8,
	BPF_REG_9,
	BPF_REG_10,
	__MAX_BPF_REG,
};

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

/* ArgX, context and stack frame pointer register positions. Note,
 * Arg1, Arg2, Arg3, etc are used as argument mappings of function
 * calls in BPF_CALL instruction.
 */
#define BPF_REG_ARG1	BPF_REG_1
#define BPF_REG_ARG2	BPF_REG_2
#define BPF_REG_ARG3	BPF_REG_3
#define BPF_REG_ARG4	BPF_REG_4
#define BPF_REG_ARG5	BPF_REG_5
#define BPF_REG_CTX	BPF_REG_6
#define BPF_REG_FP	BPF_REG_10

/* Additional register mappings for converted user programs. */
#define BPF_REG_A	BPF_REG_0
#define BPF_REG_X	BPF_REG_7
#define BPF_REG_TMP	BPF_REG_8

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

/* Helper macros for filter block array initializers. */

/* ALU ops on registers, bpf_add|sub|...: dst_reg += src_reg */

#define BPF_ALU64_REG(OP, DST, SRC)				\
	((struct bpf_insn) {					\
		.code  = BPF_ALU64 | BPF_OP(OP) | BPF_X,	\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = 0,					\
		.imm   = 0 })

#define BPF_ALU32_REG(OP, DST, SRC)				\
	((struct bpf_insn) {					\
		.code  = BPF_ALU | BPF_OP(OP) | BPF_X,		\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = 0,					\
		.imm   = 0 })

/* ALU ops on immediates, bpf_add|sub|...: dst_reg += imm32 */

#define BPF_ALU64_IMM(OP, DST, IMM)				\
	((struct bpf_insn) {					\
		.code  = BPF_ALU64 | BPF_OP(OP) | BPF_K,	\
		.dst_reg = DST,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = IMM })

#define BPF_ALU32_IMM(OP, DST, IMM)				\
	((struct bpf_insn) {					\
		.code  = BPF_ALU | BPF_OP(OP) | BPF_K,		\
		.dst_reg = DST,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = IMM })

/* Endianess conversion, cpu_to_{l,b}e(), {l,b}e_to_cpu() */

#define BPF_ENDIAN(TYPE, DST, LEN)				\
	((struct bpf_insn) {					\
		.code  = BPF_ALU | BPF_END | BPF_SRC(TYPE),	\
		.dst_reg = DST,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = LEN })

/* Short form of mov, dst_reg = src_reg */

#define BPF_MOV64_REG(DST, SRC)					\
	((struct bpf_insn) {					\
		.code  = BPF_ALU64 | BPF_MOV | BPF_X,		\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = 0,					\
		.imm   = 0 })

#define BPF_MOV32_REG(DST, SRC)					\
	((struct bpf_insn) {					\
		.code  = BPF_ALU | BPF_MOV | BPF_X,		\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = 0,					\
		.imm   = 0 })

/* Short form of mov, dst_reg = imm32 */

#define BPF_MOV64_IMM(DST, IMM)					\
	((struct bpf_insn) {					\
		.code  = BPF_ALU64 | BPF_MOV | BPF_K,		\
		.dst_reg = DST,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = IMM })

#define BPF_MOV32_IMM(DST, IMM)					\
	((struct bpf_insn) {					\
		.code  = BPF_ALU | BPF_MOV | BPF_K,		\
		.dst_reg = DST,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = IMM })

/* Short form of mov based on type, BPF_X: dst_reg = src_reg, BPF_K: dst_reg = imm32 */

#define BPF_MOV64_RAW(TYPE, DST, SRC, IMM)			\
	((struct bpf_insn) {					\
		.code  = BPF_ALU64 | BPF_MOV | BPF_SRC(TYPE),	\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = 0,					\
		.imm   = IMM })

#define BPF_MOV32_RAW(TYPE, DST, SRC, IMM)			\
	((struct bpf_insn) {					\
		.code  = BPF_ALU | BPF_MOV | BPF_SRC(TYPE),	\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = 0,					\
		.imm   = IMM })

/* Direct packet access, R0 = *(uint *) (skb->data + imm32) */

#define BPF_LD_ABS(SIZE, IMM)					\
	((struct bpf_insn) {					\
		.code  = BPF_LD | BPF_SIZE(SIZE) | BPF_ABS,	\
		.dst_reg = 0,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = IMM })

/* Indirect packet access, R0 = *(uint *) (skb->data + src_reg + imm32) */

#define BPF_LD_IND(SIZE, SRC, IMM)				\
	((struct bpf_insn) {					\
		.code  = BPF_LD | BPF_SIZE(SIZE) | BPF_IND,	\
		.dst_reg = 0,					\
		.src_reg = SRC,					\
		.off   = 0,					\
		.imm   = IMM })

/* Memory load, dst_reg = *(uint *) (src_reg + off16) */

#define BPF_LDX_MEM(SIZE, DST, SRC, OFF)			\
	((struct bpf_insn) {					\
		.code  = BPF_LDX | BPF_SIZE(SIZE) | BPF_MEM,	\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = OFF,					\
		.imm   = 0 })

/* Memory store, *(uint *) (dst_reg + off16) = src_reg */

#define BPF_STX_MEM(SIZE, DST, SRC, OFF)			\
	((struct bpf_insn) {					\
		.code  = BPF_STX | BPF_SIZE(SIZE) | BPF_MEM,	\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = OFF,					\
		.imm   = 0 })

/* Memory store, *(uint *) (dst_reg + off16) = imm32 */

#define BPF_ST_MEM(SIZE, DST, OFF, IMM)				\
	((struct bpf_insn) {					\
		.code  = BPF_ST | BPF_SIZE(SIZE) | BPF_MEM,	\
		.dst_reg = DST,					\
		.src_reg = 0,					\
		.off   = OFF,					\
		.imm   = IMM })

/* Conditional jumps against registers, if (dst_reg 'op' src_reg) goto pc + off16 */

#define BPF_JMP_REG(OP, DST, SRC, OFF)				\
	((struct bpf_insn) {					\
		.code  = BPF_JMP | BPF_OP(OP) | BPF_X,		\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = OFF,					\
		.imm   = 0 })

/* Conditional jumps against immediates, if (dst_reg 'op' imm32) goto pc + off16 */

#define BPF_JMP_IMM(OP, DST, IMM, OFF)				\
	((struct bpf_insn) {					\
		.code  = BPF_JMP | BPF_OP(OP) | BPF_K,		\
		.dst_reg = DST,					\
		.src_reg = 0,					\
		.off   = OFF,					\
		.imm   = IMM })

/* Function call */

#define BPF_EMIT_CALL(FUNC)					\
	((struct bpf_insn) {					\
		.code  = BPF_JMP | BPF_CALL,			\
		.dst_reg = 0,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = ((FUNC) - __bpf_call_base) })

/* Raw code statement block */

#define BPF_RAW_INSN(CODE, DST, SRC, OFF, IMM)			\
	((struct bpf_insn) {					\
		.code  = CODE,					\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = OFF,					\
		.imm   = IMM })

/* Program exit */

#define BPF_EXIT_INSN()						\
	((struct bpf_insn) {					\
		.code  = BPF_JMP | BPF_EXIT,			\
		.dst_reg = 0,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = 0 })

#define bytes_to_bpf_size(bytes)				\
({								\
	int bpf_size = -EINVAL;					\
								\
	if (bytes == sizeof(u8))				\
		bpf_size = BPF_B;				\
	else if (bytes == sizeof(u16))				\
		bpf_size = BPF_H;				\
	else if (bytes == sizeof(u32))				\
		bpf_size = BPF_W;				\
	else if (bytes == sizeof(u64))				\
		bpf_size = BPF_DW;				\
								\
	bpf_size;						\
})

/* Macro to invoke filter function. */
#define SK_RUN_FILTER(filter, ctx) \
	(*filter->prog->bpf_func)(ctx, filter->prog->insnsi)

struct bpf_insn {
	__u8	code;		/* opcode */
	__u8	dst_reg:4;	/* dest register */
	__u8	src_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 bpf_prog {
	u32			jited:1,	/* Is our filter JIT'ed? */
				len:31;		/* Number of filter blocks */
	struct sock_fprog_kern	*orig_prog;	/* Original BPF program */
	unsigned int		(*bpf_func)(const struct sk_buff *skb,
					    const struct bpf_insn *filter);
	union {
		struct sock_filter	insns[0];
		struct bpf_insn		insnsi[0];
		struct work_struct	work;
	};
};

struct sk_filter {
	atomic_t	refcnt;
	struct rcu_head	rcu;
	struct bpf_prog	*prog;
};

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

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

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

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

void bpf_prog_select_runtime(struct bpf_prog *fp);
void bpf_prog_free(struct bpf_prog *fp);

int bpf_convert_filter(struct sock_filter *prog, int len,
		       struct bpf_insn *new_prog, int *new_len);

int bpf_prog_create(struct bpf_prog **pfp, struct sock_fprog_kern *fprog);
void bpf_prog_destroy(struct bpf_prog *fp);

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

int bpf_check_classic(const struct sock_filter *filter, unsigned int flen);
int sk_get_filter(struct sock *sk, struct sock_filter __user *filter,
		  unsigned int len);

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

u64 __bpf_call_base(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
void bpf_int_jit_compile(struct bpf_prog *fp);

#define BPF_ANC		BIT(15)

static inline u16 bpf_anc_helper(const struct sock_filter *ftest)
{
	BUG_ON(ftest->code & BPF_ANC);

	switch (ftest->code) {
	case BPF_LD | BPF_W | BPF_ABS:
	case BPF_LD | BPF_H | BPF_ABS:
	case BPF_LD | BPF_B | BPF_ABS:
#define BPF_ANCILLARY(CODE)	case SKF_AD_OFF + SKF_AD_##CODE:	\
				return BPF_ANC | SKF_AD_##CODE
		switch (ftest->k) {
		BPF_ANCILLARY(PROTOCOL);
		BPF_ANCILLARY(PKTTYPE);
		BPF_ANCILLARY(IFINDEX);
		BPF_ANCILLARY(NLATTR);
		BPF_ANCILLARY(NLATTR_NEST);
		BPF_ANCILLARY(MARK);
		BPF_ANCILLARY(QUEUE);
		BPF_ANCILLARY(HATYPE);
		BPF_ANCILLARY(RXHASH);
		BPF_ANCILLARY(CPU);
		BPF_ANCILLARY(ALU_XOR_X);
		BPF_ANCILLARY(VLAN_TAG);
		BPF_ANCILLARY(VLAN_TAG_PRESENT);
		BPF_ANCILLARY(PAY_OFFSET);
		BPF_ANCILLARY(RANDOM);
		}
		/* Fallthrough. */
	default:
		return ftest->code;
	}
}

void *bpf_internal_load_pointer_neg_helper(const struct sk_buff *skb,
					   int k, unsigned int size);

static inline void *bpf_load_pointer(const struct sk_buff *skb, int k,
				     unsigned int size, void *buffer)
{
	if (k >= 0)
		return skb_header_pointer(skb, k, size, buffer);

	return bpf_internal_load_pointer_neg_helper(skb, k, size);
}

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

void bpf_jit_compile(struct bpf_prog *fp);
void bpf_jit_free(struct bpf_prog *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 bpf_prog *fp)
{
}

static inline void bpf_jit_free(struct bpf_prog *fp)
{
	kfree(fp);
}
#endif /* CONFIG_BPF_JIT */

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

#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>
9f12fbe6	9	#include <linux/skbuff.h>
d45ed4a4	10	#include <linux/workqueue.h>
607ca46e	11	#include <uapi/linux/filter.h>
792d4b5c	12
bd4cf0ed AS	13	/* Internally used and optimized filter representation with extended
bd4cf0ed AS	14	* instruction set based on top of classic BPF.
0c5fe1b4	15	*/
bd4cf0ed AS	16
	17	/* instruction classes */
	18	#define BPF_ALU64 0x07 /* alu mode in double word width */
	19
	20	/* ld/ldx fields */
	21	#define BPF_DW 0x18 /* double word */
	22	#define BPF_XADD 0xc0 /* exclusive add */
	23
	24	/* alu/jmp fields */
	25	#define BPF_MOV 0xb0 /* mov reg to reg */
	26	#define BPF_ARSH 0xc0 /* sign extending arithmetic shift right */
	27
	28	/* change endianness of a register */
	29	#define BPF_END 0xd0 /* flags for endianness conversion: */
	30	#define BPF_TO_LE 0x00 /* convert to little-endian */
	31	#define BPF_TO_BE 0x08 /* convert to big-endian */
	32	#define BPF_FROM_LE BPF_TO_LE
	33	#define BPF_FROM_BE BPF_TO_BE
	34
	35	#define BPF_JNE 0x50 /* jump != */
	36	#define BPF_JSGT 0x60 /* SGT is signed '>', GT in x86 */
	37	#define BPF_JSGE 0x70 /* SGE is signed '>=', GE in x86 */
	38	#define BPF_CALL 0x80 /* function call */
	39	#define BPF_EXIT 0x90 /* function return */
	40
30743837 DB	41	/* Register numbers */
	42	enum {
	43	BPF_REG_0 = 0,
	44	BPF_REG_1,
	45	BPF_REG_2,
	46	BPF_REG_3,
	47	BPF_REG_4,
	48	BPF_REG_5,
	49	BPF_REG_6,
	50	BPF_REG_7,
	51	BPF_REG_8,
	52	BPF_REG_9,
	53	BPF_REG_10,
	54	__MAX_BPF_REG,
	55	};
	56
bd4cf0ed	57	/* BPF has 10 general purpose 64-bit registers and stack frame. */
30743837 DB	58	#define MAX_BPF_REG __MAX_BPF_REG
	59
	60	/* ArgX, context and stack frame pointer register positions. Note,
	61	* Arg1, Arg2, Arg3, etc are used as argument mappings of function
	62	* calls in BPF_CALL instruction.
	63	*/
	64	#define BPF_REG_ARG1 BPF_REG_1
	65	#define BPF_REG_ARG2 BPF_REG_2
	66	#define BPF_REG_ARG3 BPF_REG_3
	67	#define BPF_REG_ARG4 BPF_REG_4
	68	#define BPF_REG_ARG5 BPF_REG_5
	69	#define BPF_REG_CTX BPF_REG_6
	70	#define BPF_REG_FP BPF_REG_10
	71
	72	/* Additional register mappings for converted user programs. */
	73	#define BPF_REG_A BPF_REG_0
	74	#define BPF_REG_X BPF_REG_7
	75	#define BPF_REG_TMP BPF_REG_8
bd4cf0ed AS	76
	77	/* BPF program can access up to 512 bytes of stack space. */
	78	#define MAX_BPF_STACK 512
	79
f8f6d679 DB	80	/* Helper macros for filter block array initializers. */
f8f6d679 DB	81
e430f34e	82	/* ALU ops on registers, bpf_add\|sub\|...: dst_reg += src_reg */
f8f6d679	83
e430f34e	84	#define BPF_ALU64_REG(OP, DST, SRC) \
2695fb55	85	((struct bpf_insn) { \
f8f6d679	86	.code = BPF_ALU64 \| BPF_OP(OP) \| BPF_X, \
e430f34e AS	87	.dst_reg = DST, \
e430f34e AS	88	.src_reg = SRC, \
f8f6d679 DB	89	.off = 0, \
	90	.imm = 0 })
	91
e430f34e	92	#define BPF_ALU32_REG(OP, DST, SRC) \
2695fb55	93	((struct bpf_insn) { \
f8f6d679	94	.code = BPF_ALU \| BPF_OP(OP) \| BPF_X, \
e430f34e AS	95	.dst_reg = DST, \
e430f34e AS	96	.src_reg = SRC, \
f8f6d679 DB	97	.off = 0, \
	98	.imm = 0 })
	99
e430f34e	100	/* ALU ops on immediates, bpf_add\|sub\|...: dst_reg += imm32 */
f8f6d679	101
e430f34e	102	#define BPF_ALU64_IMM(OP, DST, IMM) \
2695fb55	103	((struct bpf_insn) { \
f8f6d679	104	.code = BPF_ALU64 \| BPF_OP(OP) \| BPF_K, \
e430f34e AS	105	.dst_reg = DST, \
e430f34e AS	106	.src_reg = 0, \
f8f6d679 DB	107	.off = 0, \
	108	.imm = IMM })
	109
e430f34e	110	#define BPF_ALU32_IMM(OP, DST, IMM) \
2695fb55	111	((struct bpf_insn) { \
f8f6d679	112	.code = BPF_ALU \| BPF_OP(OP) \| BPF_K, \
e430f34e AS	113	.dst_reg = DST, \
e430f34e AS	114	.src_reg = 0, \
f8f6d679 DB	115	.off = 0, \
	116	.imm = IMM })
	117
	118	/* Endianess conversion, cpu_to_{l,b}e(), {l,b}e_to_cpu() */
	119
e430f34e	120	#define BPF_ENDIAN(TYPE, DST, LEN) \
2695fb55	121	((struct bpf_insn) { \
f8f6d679	122	.code = BPF_ALU \| BPF_END \| BPF_SRC(TYPE), \
e430f34e AS	123	.dst_reg = DST, \
e430f34e AS	124	.src_reg = 0, \
f8f6d679 DB	125	.off = 0, \
	126	.imm = LEN })
	127
e430f34e	128	/* Short form of mov, dst_reg = src_reg */
f8f6d679	129
e430f34e	130	#define BPF_MOV64_REG(DST, SRC) \
2695fb55	131	((struct bpf_insn) { \
f8f6d679	132	.code = BPF_ALU64 \| BPF_MOV \| BPF_X, \
e430f34e AS	133	.dst_reg = DST, \
e430f34e AS	134	.src_reg = SRC, \
f8f6d679 DB	135	.off = 0, \
	136	.imm = 0 })
	137
e430f34e	138	#define BPF_MOV32_REG(DST, SRC) \
2695fb55	139	((struct bpf_insn) { \
f8f6d679	140	.code = BPF_ALU \| BPF_MOV \| BPF_X, \
e430f34e AS	141	.dst_reg = DST, \
e430f34e AS	142	.src_reg = SRC, \
f8f6d679 DB	143	.off = 0, \
	144	.imm = 0 })
	145
e430f34e	146	/* Short form of mov, dst_reg = imm32 */
f8f6d679	147
e430f34e	148	#define BPF_MOV64_IMM(DST, IMM) \
2695fb55	149	((struct bpf_insn) { \
f8f6d679	150	.code = BPF_ALU64 \| BPF_MOV \| BPF_K, \
e430f34e AS	151	.dst_reg = DST, \
e430f34e AS	152	.src_reg = 0, \
f8f6d679 DB	153	.off = 0, \
	154	.imm = IMM })
	155
e430f34e	156	#define BPF_MOV32_IMM(DST, IMM) \
2695fb55	157	((struct bpf_insn) { \
f8f6d679	158	.code = BPF_ALU \| BPF_MOV \| BPF_K, \
e430f34e AS	159	.dst_reg = DST, \
e430f34e AS	160	.src_reg = 0, \
f8f6d679 DB	161	.off = 0, \
	162	.imm = IMM })
	163
e430f34e	164	/* Short form of mov based on type, BPF_X: dst_reg = src_reg, BPF_K: dst_reg = imm32 */
f8f6d679	165
e430f34e	166	#define BPF_MOV64_RAW(TYPE, DST, SRC, IMM) \
2695fb55	167	((struct bpf_insn) { \
f8f6d679	168	.code = BPF_ALU64 \| BPF_MOV \| BPF_SRC(TYPE), \
e430f34e AS	169	.dst_reg = DST, \
e430f34e AS	170	.src_reg = SRC, \
f8f6d679 DB	171	.off = 0, \
	172	.imm = IMM })
	173
e430f34e	174	#define BPF_MOV32_RAW(TYPE, DST, SRC, IMM) \
2695fb55	175	((struct bpf_insn) { \
f8f6d679	176	.code = BPF_ALU \| BPF_MOV \| BPF_SRC(TYPE), \
e430f34e AS	177	.dst_reg = DST, \
e430f34e AS	178	.src_reg = SRC, \
f8f6d679 DB	179	.off = 0, \
	180	.imm = IMM })
	181
e430f34e	182	/* Direct packet access, R0 = (uint ) (skb->data + imm32) */
f8f6d679	183
e430f34e	184	#define BPF_LD_ABS(SIZE, IMM) \
2695fb55	185	((struct bpf_insn) { \
f8f6d679	186	.code = BPF_LD \| BPF_SIZE(SIZE) \| BPF_ABS, \
e430f34e AS	187	.dst_reg = 0, \
e430f34e AS	188	.src_reg = 0, \
f8f6d679	189	.off = 0, \
e430f34e	190	.imm = IMM })
f8f6d679	191
e430f34e	192	/* Indirect packet access, R0 = (uint ) (skb->data + src_reg + imm32) */
f8f6d679	193
e430f34e	194	#define BPF_LD_IND(SIZE, SRC, IMM) \
2695fb55	195	((struct bpf_insn) { \
f8f6d679	196	.code = BPF_LD \| BPF_SIZE(SIZE) \| BPF_IND, \
e430f34e AS	197	.dst_reg = 0, \
e430f34e AS	198	.src_reg = SRC, \
f8f6d679	199	.off = 0, \
e430f34e	200	.imm = IMM })
f8f6d679	201
e430f34e	202	/* Memory load, dst_reg = (uint ) (src_reg + off16) */
f8f6d679	203
e430f34e	204	#define BPF_LDX_MEM(SIZE, DST, SRC, OFF) \
2695fb55	205	((struct bpf_insn) { \
f8f6d679	206	.code = BPF_LDX \| BPF_SIZE(SIZE) \| BPF_MEM, \
e430f34e AS	207	.dst_reg = DST, \
e430f34e AS	208	.src_reg = SRC, \
f8f6d679 DB	209	.off = OFF, \
	210	.imm = 0 })
	211
e430f34e AS	212	/* Memory store, (uint ) (dst_reg + off16) = src_reg */
	213
	214	#define BPF_STX_MEM(SIZE, DST, SRC, OFF) \
2695fb55	215	((struct bpf_insn) { \
f8f6d679	216	.code = BPF_STX \| BPF_SIZE(SIZE) \| BPF_MEM, \
e430f34e AS	217	.dst_reg = DST, \
e430f34e AS	218	.src_reg = SRC, \
f8f6d679 DB	219	.off = OFF, \
	220	.imm = 0 })
	221
e430f34e AS	222	/* Memory store, (uint ) (dst_reg + off16) = imm32 */
	223
	224	#define BPF_ST_MEM(SIZE, DST, OFF, IMM) \
2695fb55	225	((struct bpf_insn) { \
e430f34e AS	226	.code = BPF_ST \| BPF_SIZE(SIZE) \| BPF_MEM, \
	227	.dst_reg = DST, \
	228	.src_reg = 0, \
	229	.off = OFF, \
	230	.imm = IMM })
	231
	232	/* Conditional jumps against registers, if (dst_reg 'op' src_reg) goto pc + off16 */
f8f6d679	233
e430f34e	234	#define BPF_JMP_REG(OP, DST, SRC, OFF) \
2695fb55	235	((struct bpf_insn) { \
f8f6d679	236	.code = BPF_JMP \| BPF_OP(OP) \| BPF_X, \
e430f34e AS	237	.dst_reg = DST, \
e430f34e AS	238	.src_reg = SRC, \
f8f6d679 DB	239	.off = OFF, \
	240	.imm = 0 })
	241
e430f34e	242	/* Conditional jumps against immediates, if (dst_reg 'op' imm32) goto pc + off16 */
f8f6d679	243
e430f34e	244	#define BPF_JMP_IMM(OP, DST, IMM, OFF) \
2695fb55	245	((struct bpf_insn) { \
f8f6d679	246	.code = BPF_JMP \| BPF_OP(OP) \| BPF_K, \
e430f34e AS	247	.dst_reg = DST, \
e430f34e AS	248	.src_reg = 0, \
f8f6d679 DB	249	.off = OFF, \
	250	.imm = IMM })
	251
	252	/* Function call */
	253
	254	#define BPF_EMIT_CALL(FUNC) \
2695fb55	255	((struct bpf_insn) { \
f8f6d679	256	.code = BPF_JMP \| BPF_CALL, \
e430f34e AS	257	.dst_reg = 0, \
e430f34e AS	258	.src_reg = 0, \
f8f6d679 DB	259	.off = 0, \
	260	.imm = ((FUNC) - __bpf_call_base) })
	261
	262	/* Raw code statement block */
	263
e430f34e	264	#define BPF_RAW_INSN(CODE, DST, SRC, OFF, IMM) \
2695fb55	265	((struct bpf_insn) { \
f8f6d679	266	.code = CODE, \
e430f34e AS	267	.dst_reg = DST, \
e430f34e AS	268	.src_reg = SRC, \
f8f6d679 DB	269	.off = OFF, \
	270	.imm = IMM })
	271
	272	/* Program exit */
	273
	274	#define BPF_EXIT_INSN() \
2695fb55	275	((struct bpf_insn) { \
f8f6d679	276	.code = BPF_JMP \| BPF_EXIT, \
e430f34e AS	277	.dst_reg = 0, \
e430f34e AS	278	.src_reg = 0, \
f8f6d679 DB	279	.off = 0, \
	280	.imm = 0 })
	281
	282	#define bytes_to_bpf_size(bytes) \
	283	({ \
	284	int bpf_size = -EINVAL; \
	285	\
	286	if (bytes == sizeof(u8)) \
	287	bpf_size = BPF_B; \
	288	else if (bytes == sizeof(u16)) \
	289	bpf_size = BPF_H; \
	290	else if (bytes == sizeof(u32)) \
	291	bpf_size = BPF_W; \
	292	else if (bytes == sizeof(u64)) \
	293	bpf_size = BPF_DW; \
	294	\
	295	bpf_size; \
	296	})
9739eef1	297
30743837	298	/* Macro to invoke filter function. */
7ae457c1 AS	299	#define SK_RUN_FILTER(filter, ctx) \
7ae457c1 AS	300	(*filter->prog->bpf_func)(ctx, filter->prog->insnsi)
bd4cf0ed	301
2695fb55	302	struct bpf_insn {
bd4cf0ed	303	__u8 code; /* opcode */
e430f34e AS	304	__u8 dst_reg:4; /* dest register */
e430f34e AS	305	__u8 src_reg:4; /* source register */
bd4cf0ed AS	306	__s16 off; /* signed offset */
	307	__s32 imm; /* signed immediate constant */
	308	};
	309
	310	#ifdef CONFIG_COMPAT
	311	/* A struct sock_filter is architecture independent. */
0c5fe1b4 WD	312	struct compat_sock_fprog {
0c5fe1b4 WD	313	u16 len;
bd4cf0ed	314	compat_uptr_t filter; /* struct sock_filter * */
0c5fe1b4 WD	315	};
	316	#endif
	317
a3ea269b DB	318	struct sock_fprog_kern {
	319	u16 len;
	320	struct sock_filter *filter;
	321	};
	322
792d4b5c HC	323	struct sk_buff;
792d4b5c HC	324	struct sock;
bd4cf0ed	325	struct seccomp_data;
792d4b5c	326
7ae457c1	327	struct bpf_prog {
f8bbbfc3 DB	328	u32 jited:1, /* Is our filter JIT'ed? */
f8bbbfc3 DB	329	len:31; /* Number of filter blocks */
a3ea269b	330	struct sock_fprog_kern orig_prog; / Original BPF program */
0a14842f	331	unsigned int (bpf_func)(const struct sk_buff skb,
2695fb55	332	const struct bpf_insn *filter);
d45ed4a4	333	union {
bd4cf0ed	334	struct sock_filter insns[0];
2695fb55	335	struct bpf_insn insnsi[0];
d45ed4a4 AS	336	struct work_struct work;
d45ed4a4 AS	337	};
b715631f SH	338	};
b715631f SH	339
7ae457c1 AS	340	struct sk_filter {
	341	atomic_t refcnt;
	342	struct rcu_head rcu;
	343	struct bpf_prog *prog;
	344	};
	345
	346	#define BPF_PROG_RUN(filter, ctx) (*filter->bpf_func)(ctx, filter->insnsi)
	347
	348	static inline unsigned int bpf_prog_size(unsigned int proglen)
b715631f	349	{
7ae457c1 AS	350	return max(sizeof(struct bpf_prog),
7ae457c1 AS	351	offsetof(struct bpf_prog, insns[proglen]));
b715631f SH	352	}
b715631f SH	353
009937e7	354	#define bpf_classic_proglen(fprog) (fprog->len * sizeof(fprog->filter[0]))
a3ea269b	355
fbc907f0	356	int sk_filter(struct sock sk, struct sk_buff skb);
bd4cf0ed	357
7ae457c1 AS	358	void bpf_prog_select_runtime(struct bpf_prog *fp);
7ae457c1 AS	359	void bpf_prog_free(struct bpf_prog *fp);
bd4cf0ed	360
8fb575ca AS	361	int bpf_convert_filter(struct sock_filter *prog, int len,
8fb575ca AS	362	struct bpf_insn new_prog, int new_len);
a3ea269b	363
7ae457c1 AS	364	int bpf_prog_create(struct bpf_prog *pfp, struct sock_fprog_kern fprog);
7ae457c1 AS	365	void bpf_prog_destroy(struct bpf_prog *fp);
a3ea269b	366
fbc907f0 DB	367	int sk_attach_filter(struct sock_fprog fprog, struct sock sk);
fbc907f0 DB	368	int sk_detach_filter(struct sock *sk);
a3ea269b	369
4df95ff4	370	int bpf_check_classic(const struct sock_filter *filter, unsigned int flen);
fbc907f0 DB	371	int sk_get_filter(struct sock sk, struct sock_filter __user filter,
fbc907f0 DB	372	unsigned int len);
fbc907f0	373
278571ba	374	bool sk_filter_charge(struct sock sk, struct sk_filter fp);
fbc907f0	375	void sk_filter_uncharge(struct sock sk, struct sk_filter fp);
0a14842f	376
62258278	377	u64 __bpf_call_base(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
7ae457c1	378	void bpf_int_jit_compile(struct bpf_prog *fp);
62258278	379
34805931 DB	380	#define BPF_ANC BIT(15)
	381
	382	static inline u16 bpf_anc_helper(const struct sock_filter *ftest)
	383	{
	384	BUG_ON(ftest->code & BPF_ANC);
	385
	386	switch (ftest->code) {
	387	case BPF_LD \| BPF_W \| BPF_ABS:
	388	case BPF_LD \| BPF_H \| BPF_ABS:
	389	case BPF_LD \| BPF_B \| BPF_ABS:
	390	#define BPF_ANCILLARY(CODE) case SKF_AD_OFF + SKF_AD_##CODE: \
	391	return BPF_ANC \| SKF_AD_##CODE
	392	switch (ftest->k) {
	393	BPF_ANCILLARY(PROTOCOL);
	394	BPF_ANCILLARY(PKTTYPE);
	395	BPF_ANCILLARY(IFINDEX);
	396	BPF_ANCILLARY(NLATTR);
	397	BPF_ANCILLARY(NLATTR_NEST);
	398	BPF_ANCILLARY(MARK);
	399	BPF_ANCILLARY(QUEUE);
	400	BPF_ANCILLARY(HATYPE);
	401	BPF_ANCILLARY(RXHASH);
	402	BPF_ANCILLARY(CPU);
	403	BPF_ANCILLARY(ALU_XOR_X);
	404	BPF_ANCILLARY(VLAN_TAG);
	405	BPF_ANCILLARY(VLAN_TAG_PRESENT);
	406	BPF_ANCILLARY(PAY_OFFSET);
	407	BPF_ANCILLARY(RANDOM);
	408	}
	409	/* Fallthrough. */
	410	default:
	411	return ftest->code;
	412	}
	413	}
	414
9f12fbe6 ZSL	415	void bpf_internal_load_pointer_neg_helper(const struct sk_buff skb,
	416	int k, unsigned int size);
	417
	418	static inline void bpf_load_pointer(const struct sk_buff skb, int k,
	419	unsigned int size, void *buffer)
	420	{
	421	if (k >= 0)
	422	return skb_header_pointer(skb, k, size, buffer);
	423
	424	return bpf_internal_load_pointer_neg_helper(skb, k, size);
	425	}
	426
0a14842f	427	#ifdef CONFIG_BPF_JIT
20074f35	428	#include <stdarg.h>
a691ce7f CG	429	#include <linux/linkage.h>
	430	#include <linux/printk.h>
	431
7ae457c1 AS	432	void bpf_jit_compile(struct bpf_prog *fp);
7ae457c1 AS	433	void bpf_jit_free(struct bpf_prog *fp);
79617801 DB	434
	435	static inline void bpf_jit_dump(unsigned int flen, unsigned int proglen,
	436	u32 pass, void *image)
	437	{
16495445	438	pr_err("flen=%u proglen=%u pass=%u image=%pK\n",
79617801 DB	439	flen, proglen, pass, image);
79617801 DB	440	if (image)
16495445	441	print_hex_dump(KERN_ERR, "JIT code: ", DUMP_PREFIX_OFFSET,
79617801 DB	442	16, 1, image, proglen, false);
79617801 DB	443	}
0a14842f	444	#else
d45ed4a4	445	#include <linux/slab.h>
34805931	446
7ae457c1	447	static inline void bpf_jit_compile(struct bpf_prog *fp)
0a14842f ED	448	{
0a14842f ED	449	}
34805931	450
7ae457c1	451	static inline void bpf_jit_free(struct bpf_prog *fp)
0a14842f	452	{
d45ed4a4	453	kfree(fp);
0a14842f	454	}
34805931	455	#endif /* CONFIG_BPF_JIT */
0a14842f	456
ea02f941 MS	457	static inline int bpf_tell_extensions(void)
ea02f941 MS	458	{
37692299	459	return SKF_AD_MAX;
ea02f941 MS	460	}
ea02f941 MS	461
1da177e4	462	#endif /* __LINUX_FILTER_H__ */