[linux-2.6-block.git] / include / linux / filter.h

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

#include <stdarg.h>

#include <linux/atomic.h>
#include <linux/compat.h>
#include <linux/skbuff.h>
#include <linux/linkage.h>
#include <linux/printk.h>
#include <linux/workqueue.h>

#include <asm/cacheflush.h>

#include <uapi/linux/filter.h>
#include <uapi/linux/bpf.h>

struct sk_buff;
struct sock;
struct seccomp_data;
struct bpf_prog_aux;

/* 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 })

/* BPF_LD_IMM64 macro encodes single 'load 64-bit immediate' insn */
#define BPF_LD_IMM64(DST, IMM)					\
	BPF_LD_IMM64_RAW(DST, 0, IMM)

#define BPF_LD_IMM64_RAW(DST, SRC, IMM)				\
	((struct bpf_insn) {					\
		.code  = BPF_LD | BPF_DW | BPF_IMM,		\
		.dst_reg = DST,					\
		.src_reg = SRC,					\
		.off   = 0,					\
		.imm   = (__u32) (IMM) }),			\
	((struct bpf_insn) {					\
		.code  = 0, /* zero is reserved opcode */	\
		.dst_reg = 0,					\
		.src_reg = 0,					\
		.off   = 0,					\
		.imm   = ((__u64) (IMM)) >> 32 })

/* pseudo BPF_LD_IMM64 insn used to refer to process-local map_fd */
#define BPF_LD_MAP_FD(DST, MAP_FD)				\
	BPF_LD_IMM64_RAW(DST, BPF_PSEUDO_MAP_FD, MAP_FD)

/* 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 })

/* Atomic memory add, *(uint *)(dst_reg + off16) += src_reg */

#define BPF_STX_XADD(SIZE, DST, SRC, OFF)			\
	((struct bpf_insn) {					\
		.code  = BPF_STX | BPF_SIZE(SIZE) | BPF_XADD,	\
		.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 })

/* Internal classic blocks for direct assignment */

#define __BPF_STMT(CODE, K)					\
	((struct sock_filter) BPF_STMT(CODE, K))

#define __BPF_JUMP(CODE, K, JT, JF)				\
	((struct sock_filter) BPF_JUMP(CODE, K, JT, JF))

#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)

#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 bpf_binary_header {
	unsigned int pages;
	u8 image[];
};

struct bpf_prog {
	u16			pages;		/* Number of allocated pages */
	bool			jited;		/* Is our filter JIT'ed? */
	bool			gpl_compatible;	/* Is our filter GPL compatible? */
	u32			len;		/* Number of filter blocks */
	enum bpf_prog_type	type;		/* Type of BPF program */
	struct bpf_prog_aux	*aux;		/* Auxiliary fields */
	struct sock_fprog_kern	*orig_prog;	/* Original BPF program */
	unsigned int		(*bpf_func)(const struct sk_buff *skb,
					    const struct bpf_insn *filter);
	/* Instructions for interpreter */
	union {
		struct sock_filter	insns[0];
		struct bpf_insn		insnsi[0];
	};
};

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]))

#ifdef CONFIG_DEBUG_SET_MODULE_RONX
static inline void bpf_prog_lock_ro(struct bpf_prog *fp)
{
	set_memory_ro((unsigned long)fp, fp->pages);
}

static inline void bpf_prog_unlock_ro(struct bpf_prog *fp)
{
	set_memory_rw((unsigned long)fp, fp->pages);
}
#else
static inline void bpf_prog_lock_ro(struct bpf_prog *fp)
{
}

static inline void bpf_prog_unlock_ro(struct bpf_prog *fp)
{
}
#endif /* CONFIG_DEBUG_SET_MODULE_RONX */

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

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

struct bpf_prog *bpf_prog_alloc(unsigned int size, gfp_t gfp_extra_flags);
struct bpf_prog *bpf_prog_realloc(struct bpf_prog *fp_old, unsigned int size,
				  gfp_t gfp_extra_flags);
void __bpf_prog_free(struct bpf_prog *fp);

static inline void bpf_prog_unlock_free(struct bpf_prog *fp)
{
	bpf_prog_unlock_ro(fp);
	__bpf_prog_free(fp);
}

typedef int (*bpf_aux_classic_check_t)(struct sock_filter *filter,
				       unsigned int flen);

int bpf_prog_create(struct bpf_prog **pfp, struct sock_fprog_kern *fprog);
int bpf_prog_create_from_user(struct bpf_prog **pfp, struct sock_fprog *fprog,
			      bpf_aux_classic_check_t trans);
void bpf_prog_destroy(struct bpf_prog *fp);

int sk_attach_filter(struct sock_fprog *fprog, struct sock *sk);
int sk_attach_bpf(u32 ufd, struct sock *sk);
int sk_detach_filter(struct sock *sk);
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);

#ifdef CONFIG_BPF_JIT
typedef void (*bpf_jit_fill_hole_t)(void *area, unsigned int size);

struct bpf_binary_header *
bpf_jit_binary_alloc(unsigned int proglen, u8 **image_ptr,
		     unsigned int alignment,
		     bpf_jit_fill_hole_t bpf_fill_ill_insns);
void bpf_jit_binary_free(struct bpf_binary_header *hdr);

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

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

#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);
		BPF_ANCILLARY(VLAN_TPID);
		}
		/* 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);
}

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
b954d834 DB	7	#include <stdarg.h>
b954d834 DB	8
60063497	9	#include <linux/atomic.h>
0c5fe1b4	10	#include <linux/compat.h>
9f12fbe6	11	#include <linux/skbuff.h>
b954d834 DB	12	#include <linux/linkage.h>
b954d834 DB	13	#include <linux/printk.h>
d45ed4a4	14	#include <linux/workqueue.h>
b954d834	15
60a3b225	16	#include <asm/cacheflush.h>
b954d834 DB	17
b954d834 DB	18	#include <uapi/linux/filter.h>
daedfb22	19	#include <uapi/linux/bpf.h>
60a3b225 DB	20
	21	struct sk_buff;
	22	struct sock;
	23	struct seccomp_data;
09756af4	24	struct bpf_prog_aux;
792d4b5c	25
30743837 DB	26	/* ArgX, context and stack frame pointer register positions. Note,
	27	* Arg1, Arg2, Arg3, etc are used as argument mappings of function
	28	* calls in BPF_CALL instruction.
	29	*/
	30	#define BPF_REG_ARG1 BPF_REG_1
	31	#define BPF_REG_ARG2 BPF_REG_2
	32	#define BPF_REG_ARG3 BPF_REG_3
	33	#define BPF_REG_ARG4 BPF_REG_4
	34	#define BPF_REG_ARG5 BPF_REG_5
	35	#define BPF_REG_CTX BPF_REG_6
	36	#define BPF_REG_FP BPF_REG_10
	37
	38	/* Additional register mappings for converted user programs. */
	39	#define BPF_REG_A BPF_REG_0
	40	#define BPF_REG_X BPF_REG_7
	41	#define BPF_REG_TMP BPF_REG_8
bd4cf0ed AS	42
	43	/* BPF program can access up to 512 bytes of stack space. */
	44	#define MAX_BPF_STACK 512
	45
f8f6d679 DB	46	/* Helper macros for filter block array initializers. */
f8f6d679 DB	47
e430f34e	48	/* ALU ops on registers, bpf_add\|sub\|...: dst_reg += src_reg */
f8f6d679	49
e430f34e	50	#define BPF_ALU64_REG(OP, DST, SRC) \
2695fb55	51	((struct bpf_insn) { \
f8f6d679	52	.code = BPF_ALU64 \| BPF_OP(OP) \| BPF_X, \
e430f34e AS	53	.dst_reg = DST, \
e430f34e AS	54	.src_reg = SRC, \
f8f6d679 DB	55	.off = 0, \
	56	.imm = 0 })
	57
e430f34e	58	#define BPF_ALU32_REG(OP, DST, SRC) \
2695fb55	59	((struct bpf_insn) { \
f8f6d679	60	.code = BPF_ALU \| BPF_OP(OP) \| BPF_X, \
e430f34e AS	61	.dst_reg = DST, \
e430f34e AS	62	.src_reg = SRC, \
f8f6d679 DB	63	.off = 0, \
	64	.imm = 0 })
	65
e430f34e	66	/* ALU ops on immediates, bpf_add\|sub\|...: dst_reg += imm32 */
f8f6d679	67
e430f34e	68	#define BPF_ALU64_IMM(OP, DST, IMM) \
2695fb55	69	((struct bpf_insn) { \
f8f6d679	70	.code = BPF_ALU64 \| BPF_OP(OP) \| BPF_K, \
e430f34e AS	71	.dst_reg = DST, \
e430f34e AS	72	.src_reg = 0, \
f8f6d679 DB	73	.off = 0, \
	74	.imm = IMM })
	75
e430f34e	76	#define BPF_ALU32_IMM(OP, DST, IMM) \
2695fb55	77	((struct bpf_insn) { \
f8f6d679	78	.code = BPF_ALU \| BPF_OP(OP) \| BPF_K, \
e430f34e AS	79	.dst_reg = DST, \
e430f34e AS	80	.src_reg = 0, \
f8f6d679 DB	81	.off = 0, \
	82	.imm = IMM })
	83
	84	/* Endianess conversion, cpu_to_{l,b}e(), {l,b}e_to_cpu() */
	85
e430f34e	86	#define BPF_ENDIAN(TYPE, DST, LEN) \
2695fb55	87	((struct bpf_insn) { \
f8f6d679	88	.code = BPF_ALU \| BPF_END \| BPF_SRC(TYPE), \
e430f34e AS	89	.dst_reg = DST, \
e430f34e AS	90	.src_reg = 0, \
f8f6d679 DB	91	.off = 0, \
	92	.imm = LEN })
	93
e430f34e	94	/* Short form of mov, dst_reg = src_reg */
f8f6d679	95
e430f34e	96	#define BPF_MOV64_REG(DST, SRC) \
2695fb55	97	((struct bpf_insn) { \
f8f6d679	98	.code = BPF_ALU64 \| BPF_MOV \| BPF_X, \
e430f34e AS	99	.dst_reg = DST, \
e430f34e AS	100	.src_reg = SRC, \
f8f6d679 DB	101	.off = 0, \
	102	.imm = 0 })
	103
e430f34e	104	#define BPF_MOV32_REG(DST, SRC) \
2695fb55	105	((struct bpf_insn) { \
f8f6d679	106	.code = BPF_ALU \| BPF_MOV \| BPF_X, \
e430f34e AS	107	.dst_reg = DST, \
e430f34e AS	108	.src_reg = SRC, \
f8f6d679 DB	109	.off = 0, \
	110	.imm = 0 })
	111
e430f34e	112	/* Short form of mov, dst_reg = imm32 */
f8f6d679	113
e430f34e	114	#define BPF_MOV64_IMM(DST, IMM) \
2695fb55	115	((struct bpf_insn) { \
f8f6d679	116	.code = BPF_ALU64 \| BPF_MOV \| BPF_K, \
e430f34e AS	117	.dst_reg = DST, \
e430f34e AS	118	.src_reg = 0, \
f8f6d679 DB	119	.off = 0, \
	120	.imm = IMM })
	121
e430f34e	122	#define BPF_MOV32_IMM(DST, IMM) \
2695fb55	123	((struct bpf_insn) { \
f8f6d679	124	.code = BPF_ALU \| BPF_MOV \| BPF_K, \
e430f34e AS	125	.dst_reg = DST, \
e430f34e AS	126	.src_reg = 0, \
f8f6d679 DB	127	.off = 0, \
	128	.imm = IMM })
	129
02ab695b AS	130	/* BPF_LD_IMM64 macro encodes single 'load 64-bit immediate' insn */
	131	#define BPF_LD_IMM64(DST, IMM) \
	132	BPF_LD_IMM64_RAW(DST, 0, IMM)
	133
	134	#define BPF_LD_IMM64_RAW(DST, SRC, IMM) \
	135	((struct bpf_insn) { \
	136	.code = BPF_LD \| BPF_DW \| BPF_IMM, \
	137	.dst_reg = DST, \
	138	.src_reg = SRC, \
	139	.off = 0, \
	140	.imm = (__u32) (IMM) }), \
	141	((struct bpf_insn) { \
	142	.code = 0, /* zero is reserved opcode */ \
	143	.dst_reg = 0, \
	144	.src_reg = 0, \
	145	.off = 0, \
	146	.imm = ((__u64) (IMM)) >> 32 })
	147
0246e64d AS	148	/* pseudo BPF_LD_IMM64 insn used to refer to process-local map_fd */
	149	#define BPF_LD_MAP_FD(DST, MAP_FD) \
	150	BPF_LD_IMM64_RAW(DST, BPF_PSEUDO_MAP_FD, MAP_FD)
	151
e430f34e	152	/* Short form of mov based on type, BPF_X: dst_reg = src_reg, BPF_K: dst_reg = imm32 */
f8f6d679	153
e430f34e	154	#define BPF_MOV64_RAW(TYPE, DST, SRC, IMM) \
2695fb55	155	((struct bpf_insn) { \
f8f6d679	156	.code = BPF_ALU64 \| BPF_MOV \| BPF_SRC(TYPE), \
e430f34e AS	157	.dst_reg = DST, \
e430f34e AS	158	.src_reg = SRC, \
f8f6d679 DB	159	.off = 0, \
	160	.imm = IMM })
	161
e430f34e	162	#define BPF_MOV32_RAW(TYPE, DST, SRC, IMM) \
2695fb55	163	((struct bpf_insn) { \
f8f6d679	164	.code = BPF_ALU \| BPF_MOV \| BPF_SRC(TYPE), \
e430f34e AS	165	.dst_reg = DST, \
e430f34e AS	166	.src_reg = SRC, \
f8f6d679 DB	167	.off = 0, \
	168	.imm = IMM })
	169
e430f34e	170	/* Direct packet access, R0 = (uint ) (skb->data + imm32) */
f8f6d679	171
e430f34e	172	#define BPF_LD_ABS(SIZE, IMM) \
2695fb55	173	((struct bpf_insn) { \
f8f6d679	174	.code = BPF_LD \| BPF_SIZE(SIZE) \| BPF_ABS, \
e430f34e AS	175	.dst_reg = 0, \
e430f34e AS	176	.src_reg = 0, \
f8f6d679	177	.off = 0, \
e430f34e	178	.imm = IMM })
f8f6d679	179
e430f34e	180	/* Indirect packet access, R0 = (uint ) (skb->data + src_reg + imm32) */
f8f6d679	181
e430f34e	182	#define BPF_LD_IND(SIZE, SRC, IMM) \
2695fb55	183	((struct bpf_insn) { \
f8f6d679	184	.code = BPF_LD \| BPF_SIZE(SIZE) \| BPF_IND, \
e430f34e AS	185	.dst_reg = 0, \
e430f34e AS	186	.src_reg = SRC, \
f8f6d679	187	.off = 0, \
e430f34e	188	.imm = IMM })
f8f6d679	189
e430f34e	190	/* Memory load, dst_reg = (uint ) (src_reg + off16) */
f8f6d679	191
e430f34e	192	#define BPF_LDX_MEM(SIZE, DST, SRC, OFF) \
2695fb55	193	((struct bpf_insn) { \
f8f6d679	194	.code = BPF_LDX \| BPF_SIZE(SIZE) \| BPF_MEM, \
e430f34e AS	195	.dst_reg = DST, \
e430f34e AS	196	.src_reg = SRC, \
f8f6d679 DB	197	.off = OFF, \
	198	.imm = 0 })
	199
e430f34e AS	200	/* Memory store, (uint ) (dst_reg + off16) = src_reg */
	201
	202	#define BPF_STX_MEM(SIZE, DST, SRC, OFF) \
2695fb55	203	((struct bpf_insn) { \
f8f6d679	204	.code = BPF_STX \| BPF_SIZE(SIZE) \| BPF_MEM, \
e430f34e AS	205	.dst_reg = DST, \
e430f34e AS	206	.src_reg = SRC, \
f8f6d679 DB	207	.off = OFF, \
	208	.imm = 0 })
	209
cffc642d MH	210	/* Atomic memory add, (uint )(dst_reg + off16) += src_reg */
	211
	212	#define BPF_STX_XADD(SIZE, DST, SRC, OFF) \
	213	((struct bpf_insn) { \
	214	.code = BPF_STX \| BPF_SIZE(SIZE) \| BPF_XADD, \
	215	.dst_reg = DST, \
	216	.src_reg = SRC, \
	217	.off = OFF, \
	218	.imm = 0 })
	219
e430f34e AS	220	/* Memory store, (uint ) (dst_reg + off16) = imm32 */
	221
	222	#define BPF_ST_MEM(SIZE, DST, OFF, IMM) \
2695fb55	223	((struct bpf_insn) { \
e430f34e AS	224	.code = BPF_ST \| BPF_SIZE(SIZE) \| BPF_MEM, \
	225	.dst_reg = DST, \
	226	.src_reg = 0, \
	227	.off = OFF, \
	228	.imm = IMM })
	229
	230	/* Conditional jumps against registers, if (dst_reg 'op' src_reg) goto pc + off16 */
f8f6d679	231
e430f34e	232	#define BPF_JMP_REG(OP, DST, SRC, OFF) \
2695fb55	233	((struct bpf_insn) { \
f8f6d679	234	.code = BPF_JMP \| BPF_OP(OP) \| BPF_X, \
e430f34e AS	235	.dst_reg = DST, \
e430f34e AS	236	.src_reg = SRC, \
f8f6d679 DB	237	.off = OFF, \
	238	.imm = 0 })
	239
e430f34e	240	/* Conditional jumps against immediates, if (dst_reg 'op' imm32) goto pc + off16 */
f8f6d679	241
e430f34e	242	#define BPF_JMP_IMM(OP, DST, IMM, OFF) \
2695fb55	243	((struct bpf_insn) { \
f8f6d679	244	.code = BPF_JMP \| BPF_OP(OP) \| BPF_K, \
e430f34e AS	245	.dst_reg = DST, \
e430f34e AS	246	.src_reg = 0, \
f8f6d679 DB	247	.off = OFF, \
	248	.imm = IMM })
	249
	250	/* Function call */
	251
	252	#define BPF_EMIT_CALL(FUNC) \
2695fb55	253	((struct bpf_insn) { \
f8f6d679	254	.code = BPF_JMP \| BPF_CALL, \
e430f34e AS	255	.dst_reg = 0, \
e430f34e AS	256	.src_reg = 0, \
f8f6d679 DB	257	.off = 0, \
	258	.imm = ((FUNC) - __bpf_call_base) })
	259
	260	/* Raw code statement block */
	261
e430f34e	262	#define BPF_RAW_INSN(CODE, DST, SRC, OFF, IMM) \
2695fb55	263	((struct bpf_insn) { \
f8f6d679	264	.code = CODE, \
e430f34e AS	265	.dst_reg = DST, \
e430f34e AS	266	.src_reg = SRC, \
f8f6d679 DB	267	.off = OFF, \
	268	.imm = IMM })
	269
	270	/* Program exit */
	271
	272	#define BPF_EXIT_INSN() \
2695fb55	273	((struct bpf_insn) { \
f8f6d679	274	.code = BPF_JMP \| BPF_EXIT, \
e430f34e AS	275	.dst_reg = 0, \
e430f34e AS	276	.src_reg = 0, \
f8f6d679 DB	277	.off = 0, \
	278	.imm = 0 })
	279
a4afd37b DB	280	/* Internal classic blocks for direct assignment */
	281
	282	#define __BPF_STMT(CODE, K) \
	283	((struct sock_filter) BPF_STMT(CODE, K))
	284
	285	#define __BPF_JUMP(CODE, K, JT, JF) \
	286	((struct sock_filter) BPF_JUMP(CODE, K, JT, JF))
	287
f8f6d679 DB	288	#define bytes_to_bpf_size(bytes) \
	289	({ \
	290	int bpf_size = -EINVAL; \
	291	\
	292	if (bytes == sizeof(u8)) \
	293	bpf_size = BPF_B; \
	294	else if (bytes == sizeof(u16)) \
	295	bpf_size = BPF_H; \
	296	else if (bytes == sizeof(u32)) \
	297	bpf_size = BPF_W; \
	298	else if (bytes == sizeof(u64)) \
	299	bpf_size = BPF_DW; \
	300	\
	301	bpf_size; \
	302	})
9739eef1	303
30743837	304	/* Macro to invoke filter function. */
7ae457c1 AS	305	#define SK_RUN_FILTER(filter, ctx) \
7ae457c1 AS	306	(*filter->prog->bpf_func)(ctx, filter->prog->insnsi)
bd4cf0ed	307
bd4cf0ed AS	308	#ifdef CONFIG_COMPAT
bd4cf0ed AS	309	/* A struct sock_filter is architecture independent. */
0c5fe1b4 WD	310	struct compat_sock_fprog {
0c5fe1b4 WD	311	u16 len;
bd4cf0ed	312	compat_uptr_t filter; /* struct sock_filter * */
0c5fe1b4 WD	313	};
	314	#endif
	315
a3ea269b DB	316	struct sock_fprog_kern {
	317	u16 len;
	318	struct sock_filter *filter;
	319	};
	320
738cbe72 DB	321	struct bpf_binary_header {
	322	unsigned int pages;
	323	u8 image[];
	324	};
	325
7ae457c1	326	struct bpf_prog {
286aad3c DB	327	u16 pages; /* Number of allocated pages */
286aad3c DB	328	bool jited; /* Is our filter JIT'ed? */
24701ece	329	bool gpl_compatible; /* Is our filter GPL compatible? */
286aad3c	330	u32 len; /* Number of filter blocks */
24701ece	331	enum bpf_prog_type type; /* Type of BPF program */
09756af4	332	struct bpf_prog_aux aux; / Auxiliary fields */
24701ece	333	struct sock_fprog_kern orig_prog; / Original BPF program */
0a14842f	334	unsigned int (bpf_func)(const struct sk_buff skb,
2695fb55	335	const struct bpf_insn *filter);
60a3b225	336	/* Instructions for interpreter */
d45ed4a4	337	union {
bd4cf0ed	338	struct sock_filter insns[0];
2695fb55	339	struct bpf_insn insnsi[0];
d45ed4a4	340	};
b715631f SH	341	};
b715631f SH	342
7ae457c1 AS	343	struct sk_filter {
	344	atomic_t refcnt;
	345	struct rcu_head rcu;
	346	struct bpf_prog *prog;
	347	};
	348
	349	#define BPF_PROG_RUN(filter, ctx) (*filter->bpf_func)(ctx, filter->insnsi)
	350
	351	static inline unsigned int bpf_prog_size(unsigned int proglen)
b715631f	352	{
7ae457c1 AS	353	return max(sizeof(struct bpf_prog),
7ae457c1 AS	354	offsetof(struct bpf_prog, insns[proglen]));
b715631f SH	355	}
b715631f SH	356
009937e7	357	#define bpf_classic_proglen(fprog) (fprog->len * sizeof(fprog->filter[0]))
a3ea269b	358
60a3b225 DB	359	#ifdef CONFIG_DEBUG_SET_MODULE_RONX
	360	static inline void bpf_prog_lock_ro(struct bpf_prog *fp)
	361	{
	362	set_memory_ro((unsigned long)fp, fp->pages);
	363	}
	364
	365	static inline void bpf_prog_unlock_ro(struct bpf_prog *fp)
	366	{
	367	set_memory_rw((unsigned long)fp, fp->pages);
	368	}
	369	#else
	370	static inline void bpf_prog_lock_ro(struct bpf_prog *fp)
	371	{
	372	}
	373
	374	static inline void bpf_prog_unlock_ro(struct bpf_prog *fp)
	375	{
	376	}
	377	#endif /* CONFIG_DEBUG_SET_MODULE_RONX */
	378
fbc907f0	379	int sk_filter(struct sock sk, struct sk_buff skb);
bd4cf0ed	380
04fd61ab	381	int bpf_prog_select_runtime(struct bpf_prog *fp);
7ae457c1	382	void bpf_prog_free(struct bpf_prog *fp);
bd4cf0ed	383
60a3b225 DB	384	struct bpf_prog *bpf_prog_alloc(unsigned int size, gfp_t gfp_extra_flags);
	385	struct bpf_prog bpf_prog_realloc(struct bpf_prog fp_old, unsigned int size,
	386	gfp_t gfp_extra_flags);
	387	void __bpf_prog_free(struct bpf_prog *fp);
	388
	389	static inline void bpf_prog_unlock_free(struct bpf_prog *fp)
	390	{
	391	bpf_prog_unlock_ro(fp);
	392	__bpf_prog_free(fp);
	393	}
	394
ac67eb2c DB	395	typedef int (bpf_aux_classic_check_t)(struct sock_filter filter,
	396	unsigned int flen);
	397
7ae457c1	398	int bpf_prog_create(struct bpf_prog *pfp, struct sock_fprog_kern fprog);
ac67eb2c DB	399	int bpf_prog_create_from_user(struct bpf_prog *pfp, struct sock_fprog fprog,
ac67eb2c DB	400	bpf_aux_classic_check_t trans);
7ae457c1	401	void bpf_prog_destroy(struct bpf_prog *fp);
a3ea269b	402
fbc907f0	403	int sk_attach_filter(struct sock_fprog fprog, struct sock sk);
89aa0758	404	int sk_attach_bpf(u32 ufd, struct sock *sk);
fbc907f0	405	int sk_detach_filter(struct sock *sk);
fbc907f0 DB	406	int sk_get_filter(struct sock sk, struct sock_filter __user filter,
fbc907f0 DB	407	unsigned int len);
fbc907f0	408
278571ba	409	bool sk_filter_charge(struct sock sk, struct sk_filter fp);
fbc907f0	410	void sk_filter_uncharge(struct sock sk, struct sk_filter fp);
0a14842f	411
62258278	412	u64 __bpf_call_base(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
7ae457c1	413	void bpf_int_jit_compile(struct bpf_prog *fp);
62258278	414
b954d834 DB	415	#ifdef CONFIG_BPF_JIT
	416	typedef void (bpf_jit_fill_hole_t)(void area, unsigned int size);
	417
	418	struct bpf_binary_header *
	419	bpf_jit_binary_alloc(unsigned int proglen, u8 **image_ptr,
	420	unsigned int alignment,
	421	bpf_jit_fill_hole_t bpf_fill_ill_insns);
	422	void bpf_jit_binary_free(struct bpf_binary_header *hdr);
	423
	424	void bpf_jit_compile(struct bpf_prog *fp);
	425	void bpf_jit_free(struct bpf_prog *fp);
	426
	427	static inline void bpf_jit_dump(unsigned int flen, unsigned int proglen,
	428	u32 pass, void *image)
	429	{
	430	pr_err("flen=%u proglen=%u pass=%u image=%pK\n",
	431	flen, proglen, pass, image);
	432	if (image)
	433	print_hex_dump(KERN_ERR, "JIT code: ", DUMP_PREFIX_OFFSET,
	434	16, 1, image, proglen, false);
	435	}
	436	#else
	437	static inline void bpf_jit_compile(struct bpf_prog *fp)
	438	{
	439	}
	440
	441	static inline void bpf_jit_free(struct bpf_prog *fp)
	442	{
	443	bpf_prog_unlock_free(fp);
	444	}
	445	#endif /* CONFIG_BPF_JIT */
	446
34805931 DB	447	#define BPF_ANC BIT(15)
	448
	449	static inline u16 bpf_anc_helper(const struct sock_filter *ftest)
	450	{
	451	BUG_ON(ftest->code & BPF_ANC);
	452
	453	switch (ftest->code) {
	454	case BPF_LD \| BPF_W \| BPF_ABS:
	455	case BPF_LD \| BPF_H \| BPF_ABS:
	456	case BPF_LD \| BPF_B \| BPF_ABS:
	457	#define BPF_ANCILLARY(CODE) case SKF_AD_OFF + SKF_AD_##CODE: \
	458	return BPF_ANC \| SKF_AD_##CODE
	459	switch (ftest->k) {
	460	BPF_ANCILLARY(PROTOCOL);
	461	BPF_ANCILLARY(PKTTYPE);
	462	BPF_ANCILLARY(IFINDEX);
	463	BPF_ANCILLARY(NLATTR);
	464	BPF_ANCILLARY(NLATTR_NEST);
	465	BPF_ANCILLARY(MARK);
	466	BPF_ANCILLARY(QUEUE);
	467	BPF_ANCILLARY(HATYPE);
	468	BPF_ANCILLARY(RXHASH);
	469	BPF_ANCILLARY(CPU);
	470	BPF_ANCILLARY(ALU_XOR_X);
	471	BPF_ANCILLARY(VLAN_TAG);
	472	BPF_ANCILLARY(VLAN_TAG_PRESENT);
	473	BPF_ANCILLARY(PAY_OFFSET);
	474	BPF_ANCILLARY(RANDOM);
27cd5452	475	BPF_ANCILLARY(VLAN_TPID);
34805931 DB	476	}
	477	/* Fallthrough. */
	478	default:
	479	return ftest->code;
	480	}
	481	}
	482
9f12fbe6 ZSL	483	void bpf_internal_load_pointer_neg_helper(const struct sk_buff skb,
	484	int k, unsigned int size);
	485
	486	static inline void bpf_load_pointer(const struct sk_buff skb, int k,
	487	unsigned int size, void *buffer)
	488	{
	489	if (k >= 0)
	490	return skb_header_pointer(skb, k, size, buffer);
	491
	492	return bpf_internal_load_pointer_neg_helper(skb, k, size);
	493	}
	494
ea02f941 MS	495	static inline int bpf_tell_extensions(void)
ea02f941 MS	496	{
37692299	497	return SKF_AD_MAX;
ea02f941 MS	498	}
ea02f941 MS	499
1da177e4	500	#endif /* __LINUX_FILTER_H__ */