linux-apfs/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 */

/* 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|...: A += X */

#define BPF_ALU64_REG(OP, A, X)					\
	((struct sock_filter_int) {				\
		.code  = BPF_ALU64 | BPF_OP(OP) | BPF_X,	\
		.a_reg = A,					\
		.x_reg = X,					\
		.off   = 0,					\
		.imm   = 0 })

#define BPF_ALU32_REG(OP, A, X)					\
	((struct sock_filter_int) {				\
		.code  = BPF_ALU | BPF_OP(OP) | BPF_X,		\
		.a_reg = A,					\
		.x_reg = X,					\
		.off   = 0,					\
		.imm   = 0 })

/* ALU ops on immediates, bpf_add|sub|...: A += IMM */

#define BPF_ALU64_IMM(OP, A, IMM)				\
	((struct sock_filter_int) {				\
		.code  = BPF_ALU64 | BPF_OP(OP) | BPF_K,	\
		.a_reg = A,					\
		.x_reg = 0,					\
		.off   = 0,					\
		.imm   = IMM })

#define BPF_ALU32_IMM(OP, A, IMM)				\
	((struct sock_filter_int) {				\
		.code  = BPF_ALU | BPF_OP(OP) | BPF_K,		\
		.a_reg = A,					\
		.x_reg = 0,					\
		.off   = 0,					\
		.imm   = IMM })

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

#define BPF_ENDIAN(TYPE, A, LEN)				\
	((struct sock_filter_int) {				\
		.code  = BPF_ALU | BPF_END | BPF_SRC(TYPE),	\
		.a_reg = A,					\
		.x_reg = 0,					\
		.off   = 0,					\
		.imm   = LEN })

/* Short form of mov, A = X */

#define BPF_MOV64_REG(A, X)					\
	((struct sock_filter_int) {				\
		.code  = BPF_ALU64 | BPF_MOV | BPF_X,		\
		.a_reg = A,					\
		.x_reg = X,					\
		.off   = 0,					\
		.imm   = 0 })

#define BPF_MOV32_REG(A, X)					\
	((struct sock_filter_int) {				\
		.code  = BPF_ALU | BPF_MOV | BPF_X,		\
		.a_reg = A,					\
		.x_reg = X,					\
		.off   = 0,					\
		.imm   = 0 })

/* Short form of mov, A = IMM */

#define BPF_MOV64_IMM(A, IMM)					\
	((struct sock_filter_int) {				\
		.code  = BPF_ALU64 | BPF_MOV | BPF_K,		\
		.a_reg = A,					\
		.x_reg = 0,					\
		.off   = 0,					\
		.imm   = IMM })

#define BPF_MOV32_IMM(A, IMM)					\
	((struct sock_filter_int) {				\
		.code  = BPF_ALU | BPF_MOV | BPF_K,		\
		.a_reg = A,					\
		.x_reg = 0,					\
		.off   = 0,					\
		.imm   = IMM })

/* Short form of mov based on type, BPF_X: A = X,  BPF_K: A = IMM */

#define BPF_MOV64_RAW(TYPE, A, X, IMM)				\
	((struct sock_filter_int) {				\
		.code  = BPF_ALU64 | BPF_MOV | BPF_SRC(TYPE),	\
		.a_reg = A,					\
		.x_reg = X,					\
		.off   = 0,					\
		.imm   = IMM })

#define BPF_MOV32_RAW(TYPE, A, X, IMM)				\
	((struct sock_filter_int) {				\
		.code  = BPF_ALU | BPF_MOV | BPF_SRC(TYPE),	\
		.a_reg = A,					\
		.x_reg = X,					\
		.off   = 0,					\
		.imm   = IMM })

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

#define BPF_LD_ABS(SIZE, OFF)					\
	((struct sock_filter_int) {				\
		.code  = BPF_LD | BPF_SIZE(SIZE) | BPF_ABS,	\
		.a_reg = 0,					\
		.x_reg = 0,					\
		.off   = 0,					\
		.imm   = OFF })

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

#define BPF_LD_IND(SIZE, X, OFF)				\
	((struct sock_filter_int) {				\
		.code  = BPF_LD | BPF_SIZE(SIZE) | BPF_IND,	\
		.a_reg = 0,					\
		.x_reg = X,					\
		.off   = 0,					\
		.imm   = OFF })

/* Memory store, A = *(uint *) (X + OFF), and vice versa */

#define BPF_LDX_MEM(SIZE, A, X, OFF)				\
	((struct sock_filter_int) {				\
		.code  = BPF_LDX | BPF_SIZE(SIZE) | BPF_MEM,	\
		.a_reg = A,					\
		.x_reg = X,					\
		.off   = OFF,					\
		.imm   = 0 })

#define BPF_STX_MEM(SIZE, A, X, OFF)				\
	((struct sock_filter_int) {				\
		.code  = BPF_STX | BPF_SIZE(SIZE) | BPF_MEM,	\
		.a_reg = A,					\
		.x_reg = X,					\
		.off   = OFF,					\
		.imm   = 0 })

/* Conditional jumps against registers, if (A 'op' X) goto pc + OFF */

#define BPF_JMP_REG(OP, A, X, OFF)				\
	((struct sock_filter_int) {				\
		.code  = BPF_JMP | BPF_OP(OP) | BPF_X,		\
		.a_reg = A,					\
		.x_reg = X,					\
		.off   = OFF,					\
		.imm   = 0 })

/* Conditional jumps against immediates, if (A 'op' IMM) goto pc + OFF */

#define BPF_JMP_IMM(OP, A, IMM, OFF)				\
	((struct sock_filter_int) {				\
		.code  = BPF_JMP | BPF_OP(OP) | BPF_K,		\
		.a_reg = A,					\
		.x_reg = 0,					\
		.off   = OFF,					\
		.imm   = IMM })

/* Function call */

#define BPF_EMIT_CALL(FUNC)					\
	((struct sock_filter_int) {				\
		.code  = BPF_JMP | BPF_CALL,			\
		.a_reg = 0,					\
		.x_reg = 0,					\
		.off   = 0,					\
		.imm   = ((FUNC) - __bpf_call_base) })

/* Raw code statement block */

#define BPF_RAW_INSN(CODE, A, X, OFF, IMM)			\
	((struct sock_filter_int) {				\
		.code  = CODE,					\
		.a_reg = A,					\
		.x_reg = X,					\
		.off   = OFF,					\
		.imm   = IMM })

/* Program exit */

#define BPF_EXIT_INSN()						\
	((struct sock_filter_int) {				\
		.code  = BPF_JMP | BPF_EXIT,			\
		.a_reg = 0,					\
		.x_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->bpf_func)(ctx, filter->insnsi)

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

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

void sk_filter_select_runtime(struct sk_filter *fp);
void sk_filter_free(struct sk_filter *fp);

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_kern *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_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 sk_filter *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;
	}
}

#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 /* CONFIG_BPF_JIT */

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

#endif /* __LINUX_FILTER_H__ */