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

/*
 * Linux Socket Filter Data Structures
 */

#ifndef __LINUX_FILTER_H__
#define __LINUX_FILTER_H__

#include <linux/compiler.h>
#include <linux/types.h>

#ifdef __KERNEL__
#include <linux/atomic.h>
#include <linux/compat.h>
#endif

/*
 * Current version of the filter code architecture.
 */
#define BPF_MAJOR_VERSION 1
#define BPF_MINOR_VERSION 1

/*
 *	Try and keep these values and structures similar to BSD, especially
 *	the BPF code definitions which need to match so you can share filters
 */
 
struct sock_filter {	/* Filter block */
	__u16	code;   /* Actual filter code */
	__u8	jt;	/* Jump true */
	__u8	jf;	/* Jump false */
	__u32	k;      /* Generic multiuse field */
};

struct sock_fprog {	/* Required for SO_ATTACH_FILTER. */
	unsigned short		len;	/* Number of filter blocks */
	struct sock_filter __user *filter;
};

/*
 * Instruction classes
 */

#define BPF_CLASS(code) ((code) & 0x07)
#define         BPF_LD          0x00
#define         BPF_LDX         0x01
#define         BPF_ST          0x02
#define         BPF_STX         0x03
#define         BPF_ALU         0x04
#define         BPF_JMP         0x05
#define         BPF_RET         0x06
#define         BPF_MISC        0x07

/* ld/ldx fields */
#define BPF_SIZE(code)  ((code) & 0x18)
#define         BPF_W           0x00
#define         BPF_H           0x08
#define         BPF_B           0x10
#define BPF_MODE(code)  ((code) & 0xe0)
#define         BPF_IMM         0x00
#define         BPF_ABS         0x20
#define         BPF_IND         0x40
#define         BPF_MEM         0x60
#define         BPF_LEN         0x80
#define         BPF_MSH         0xa0

/* alu/jmp fields */
#define BPF_OP(code)    ((code) & 0xf0)
#define         BPF_ADD         0x00
#define         BPF_SUB         0x10
#define         BPF_MUL         0x20
#define         BPF_DIV         0x30
#define         BPF_OR          0x40
#define         BPF_AND         0x50
#define         BPF_LSH         0x60
#define         BPF_RSH         0x70
#define         BPF_NEG         0x80
#define		BPF_MOD		0x90
#define		BPF_XOR		0xa0

#define         BPF_JA          0x00
#define         BPF_JEQ         0x10
#define         BPF_JGT         0x20
#define         BPF_JGE         0x30
#define         BPF_JSET        0x40
#define BPF_SRC(code)   ((code) & 0x08)
#define         BPF_K           0x00
#define         BPF_X           0x08

/* ret - BPF_K and BPF_X also apply */
#define BPF_RVAL(code)  ((code) & 0x18)
#define         BPF_A           0x10

/* misc */
#define BPF_MISCOP(code) ((code) & 0xf8)
#define         BPF_TAX         0x00
#define         BPF_TXA         0x80

#ifndef BPF_MAXINSNS
#define BPF_MAXINSNS 4096
#endif

/*
 * Macros for filter block array initializers.
 */
#ifndef BPF_STMT
#define BPF_STMT(code, k) { (unsigned short)(code), 0, 0, k }
#endif
#ifndef BPF_JUMP
#define BPF_JUMP(code, k, jt, jf) { (unsigned short)(code), jt, jf, k }
#endif

/*
 * Number of scratch memory words for: BPF_ST and BPF_STX
 */
#define BPF_MEMWORDS 16

/* RATIONALE. Negative offsets are invalid in BPF.
   We use them to reference ancillary data.
   Unlike introduction new instructions, it does not break
   existing compilers/optimizers.
 */
#define SKF_AD_OFF    (-0x1000)
#define SKF_AD_PROTOCOL 0
#define SKF_AD_PKTTYPE 	4
#define SKF_AD_IFINDEX 	8
#define SKF_AD_NLATTR	12
#define SKF_AD_NLATTR_NEST	16
#define SKF_AD_MARK 	20
#define SKF_AD_QUEUE	24
#define SKF_AD_HATYPE	28
#define SKF_AD_RXHASH	32
#define SKF_AD_CPU	36
#define SKF_AD_ALU_XOR_X	40
#define SKF_AD_MAX	44
#define SKF_NET_OFF   (-0x100000)
#define SKF_LL_OFF    (-0x200000)

#ifdef __KERNEL__

#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 sk_buff;
struct sock;

struct sk_filter
{
	atomic_t		refcnt;
	unsigned int         	len;	/* Number of filter blocks */
	unsigned int		(*bpf_func)(const struct sk_buff *skb,
					    const struct sock_filter *filter);
	struct rcu_head		rcu;
	struct sock_filter     	insns[0];
};

static inline unsigned int sk_filter_len(const struct sk_filter *fp)
{
	return fp->len * sizeof(struct sock_filter) + sizeof(*fp);
}

extern int sk_filter(struct sock *sk, struct sk_buff *skb);
extern unsigned int sk_run_filter(const struct sk_buff *skb,
				  const struct sock_filter *filter);
extern int sk_unattached_filter_create(struct sk_filter **pfp,
				       struct sock_fprog *fprog);
extern void sk_unattached_filter_destroy(struct sk_filter *fp);
extern int sk_attach_filter(struct sock_fprog *fprog, struct sock *sk);
extern int sk_detach_filter(struct sock *sk);
extern int sk_chk_filter(struct sock_filter *filter, unsigned int flen);

#ifdef CONFIG_BPF_JIT
extern void bpf_jit_compile(struct sk_filter *fp);
extern void bpf_jit_free(struct sk_filter *fp);
#define SK_RUN_FILTER(FILTER, SKB) (*FILTER->bpf_func)(SKB, FILTER->insns)
#else
static inline void bpf_jit_compile(struct sk_filter *fp)
{
}
static inline void bpf_jit_free(struct sk_filter *fp)
{
}
#define SK_RUN_FILTER(FILTER, SKB) sk_run_filter(SKB, FILTER->insns)
#endif

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_SECCOMP_LD_W,
};

#endif /* __KERNEL__ */

#endif /* __LINUX_FILTER_H__ */
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Linux Socket Filter Data Structures
	3	*/
	4
	5	#ifndef __LINUX_FILTER_H__
	6	#define __LINUX_FILTER_H__
	7
	8	#include <linux/compiler.h>
	9	#include <linux/types.h>
	10
	11	#ifdef __KERNEL__
60063497	12	#include <linux/atomic.h>
0c5fe1b4	13	#include <linux/compat.h>
1da177e4 LT	14	#endif
	15
	16	/*
	17	* Current version of the filter code architecture.
	18	*/
	19	#define BPF_MAJOR_VERSION 1
	20	#define BPF_MINOR_VERSION 1
	21
	22	/*
	23	* Try and keep these values and structures similar to BSD, especially
	24	* the BPF code definitions which need to match so you can share filters
	25	*/
	26
d94d9fee	27	struct sock_filter { /* Filter block */
fda9ef5d DM	28	__u16 code; /* Actual filter code */
	29	__u8 jt; /* Jump true */
	30	__u8 jf; /* Jump false */
	31	__u32 k; /* Generic multiuse field */
1da177e4 LT	32	};
1da177e4 LT	33
d94d9fee	34	struct sock_fprog { /* Required for SO_ATTACH_FILTER. */
1da177e4 LT	35	unsigned short len; /* Number of filter blocks */
	36	struct sock_filter __user *filter;
	37	};
	38
1da177e4 LT	39	/*
	40	* Instruction classes
	41	*/
	42
	43	#define BPF_CLASS(code) ((code) & 0x07)
	44	#define BPF_LD 0x00
	45	#define BPF_LDX 0x01
	46	#define BPF_ST 0x02
	47	#define BPF_STX 0x03
	48	#define BPF_ALU 0x04
	49	#define BPF_JMP 0x05
	50	#define BPF_RET 0x06
	51	#define BPF_MISC 0x07
	52
	53	/* ld/ldx fields */
	54	#define BPF_SIZE(code) ((code) & 0x18)
	55	#define BPF_W 0x00
	56	#define BPF_H 0x08
	57	#define BPF_B 0x10
	58	#define BPF_MODE(code) ((code) & 0xe0)
	59	#define BPF_IMM 0x00
	60	#define BPF_ABS 0x20
	61	#define BPF_IND 0x40
	62	#define BPF_MEM 0x60
	63	#define BPF_LEN 0x80
	64	#define BPF_MSH 0xa0
	65
	66	/* alu/jmp fields */
	67	#define BPF_OP(code) ((code) & 0xf0)
	68	#define BPF_ADD 0x00
	69	#define BPF_SUB 0x10
	70	#define BPF_MUL 0x20
	71	#define BPF_DIV 0x30
	72	#define BPF_OR 0x40
	73	#define BPF_AND 0x50
	74	#define BPF_LSH 0x60
	75	#define BPF_RSH 0x70
	76	#define BPF_NEG 0x80
b6069a95	77	#define BPF_MOD 0x90
9e49e889	78	#define BPF_XOR 0xa0
b6069a95	79
1da177e4 LT	80	#define BPF_JA 0x00
	81	#define BPF_JEQ 0x10
	82	#define BPF_JGT 0x20
	83	#define BPF_JGE 0x30
	84	#define BPF_JSET 0x40
	85	#define BPF_SRC(code) ((code) & 0x08)
	86	#define BPF_K 0x00
	87	#define BPF_X 0x08
	88
	89	/* ret - BPF_K and BPF_X also apply */
	90	#define BPF_RVAL(code) ((code) & 0x18)
	91	#define BPF_A 0x10
	92
	93	/* misc */
	94	#define BPF_MISCOP(code) ((code) & 0xf8)
	95	#define BPF_TAX 0x00
	96	#define BPF_TXA 0x80
	97
	98	#ifndef BPF_MAXINSNS
	99	#define BPF_MAXINSNS 4096
	100	#endif
	101
	102	/*
	103	* Macros for filter block array initializers.
	104	*/
	105	#ifndef BPF_STMT
	106	#define BPF_STMT(code, k) { (unsigned short)(code), 0, 0, k }
	107	#endif
	108	#ifndef BPF_JUMP
	109	#define BPF_JUMP(code, k, jt, jf) { (unsigned short)(code), jt, jf, k }
	110	#endif
	111
	112	/*
	113	* Number of scratch memory words for: BPF_ST and BPF_STX
	114	*/
	115	#define BPF_MEMWORDS 16
	116
	117	/* RATIONALE. Negative offsets are invalid in BPF.
	118	We use them to reference ancillary data.
	119	Unlike introduction new instructions, it does not break
	120	existing compilers/optimizers.
	121	*/
	122	#define SKF_AD_OFF (-0x1000)
	123	#define SKF_AD_PROTOCOL 0
	124	#define SKF_AD_PKTTYPE 4
	125	#define SKF_AD_IFINDEX 8
4738c1db	126	#define SKF_AD_NLATTR 12
d214c753	127	#define SKF_AD_NLATTR_NEST 16
7e75f93e	128	#define SKF_AD_MARK 20
d19742fb	129	#define SKF_AD_QUEUE 24
40eaf962	130	#define SKF_AD_HATYPE 28
da2033c2 ED	131	#define SKF_AD_RXHASH 32
da2033c2 ED	132	#define SKF_AD_CPU 36
ffe06c17 JP	133	#define SKF_AD_ALU_XOR_X 40
ffe06c17 JP	134	#define SKF_AD_MAX 44
1da177e4 LT	135	#define SKF_NET_OFF (-0x100000)
	136	#define SKF_LL_OFF (-0x200000)
	137
	138	#ifdef __KERNEL__
792d4b5c	139
0c5fe1b4 WD	140	#ifdef CONFIG_COMPAT
	141	/*
	142	* A struct sock_filter is architecture independent.
	143	*/
	144	struct compat_sock_fprog {
	145	u16 len;
	146	compat_uptr_t filter; /* struct sock_filter * */
	147	};
	148	#endif
	149
792d4b5c HC	150	struct sk_buff;
	151	struct sock;
	152
b715631f SH	153	struct sk_filter
	154	{
	155	atomic_t refcnt;
	156	unsigned int len; /* Number of filter blocks */
0a14842f ED	157	unsigned int (bpf_func)(const struct sk_buff skb,
0a14842f ED	158	const struct sock_filter *filter);
b715631f SH	159	struct rcu_head rcu;
	160	struct sock_filter insns[0];
	161	};
	162
	163	static inline unsigned int sk_filter_len(const struct sk_filter *fp)
	164	{
	165	return fp->len * sizeof(struct sock_filter) + sizeof(*fp);
	166	}
	167
43db6d65	168	extern int sk_filter(struct sock sk, struct sk_buff skb);
62ab0812	169	extern unsigned int sk_run_filter(const struct sk_buff *skb,
93aaae2e	170	const struct sock_filter *filter);
302d6637 JP	171	extern int sk_unattached_filter_create(struct sk_filter **pfp,
	172	struct sock_fprog *fprog);
	173	extern void sk_unattached_filter_destroy(struct sk_filter *fp);
1da177e4	174	extern int sk_attach_filter(struct sock_fprog fprog, struct sock sk);
55b33325	175	extern int sk_detach_filter(struct sock *sk);
4f25af27	176	extern int sk_chk_filter(struct sock_filter *filter, unsigned int flen);
0a14842f ED	177
	178	#ifdef CONFIG_BPF_JIT
	179	extern void bpf_jit_compile(struct sk_filter *fp);
	180	extern void bpf_jit_free(struct sk_filter *fp);
	181	#define SK_RUN_FILTER(FILTER, SKB) (*FILTER->bpf_func)(SKB, FILTER->insns)
	182	#else
	183	static inline void bpf_jit_compile(struct sk_filter *fp)
	184	{
	185	}
	186	static inline void bpf_jit_free(struct sk_filter *fp)
	187	{
	188	}
	189	#define SK_RUN_FILTER(FILTER, SKB) sk_run_filter(SKB, FILTER->insns)
	190	#endif
	191
	192	enum {
	193	BPF_S_RET_K = 1,
	194	BPF_S_RET_A,
	195	BPF_S_ALU_ADD_K,
	196	BPF_S_ALU_ADD_X,
	197	BPF_S_ALU_SUB_K,
	198	BPF_S_ALU_SUB_X,
	199	BPF_S_ALU_MUL_K,
	200	BPF_S_ALU_MUL_X,
	201	BPF_S_ALU_DIV_X,
b6069a95 ED	202	BPF_S_ALU_MOD_K,
b6069a95 ED	203	BPF_S_ALU_MOD_X,
0a14842f ED	204	BPF_S_ALU_AND_K,
	205	BPF_S_ALU_AND_X,
	206	BPF_S_ALU_OR_K,
	207	BPF_S_ALU_OR_X,
9e49e889 DB	208	BPF_S_ALU_XOR_K,
9e49e889 DB	209	BPF_S_ALU_XOR_X,
0a14842f ED	210	BPF_S_ALU_LSH_K,
	211	BPF_S_ALU_LSH_X,
	212	BPF_S_ALU_RSH_K,
	213	BPF_S_ALU_RSH_X,
	214	BPF_S_ALU_NEG,
	215	BPF_S_LD_W_ABS,
	216	BPF_S_LD_H_ABS,
	217	BPF_S_LD_B_ABS,
	218	BPF_S_LD_W_LEN,
	219	BPF_S_LD_W_IND,
	220	BPF_S_LD_H_IND,
	221	BPF_S_LD_B_IND,
	222	BPF_S_LD_IMM,
	223	BPF_S_LDX_W_LEN,
	224	BPF_S_LDX_B_MSH,
	225	BPF_S_LDX_IMM,
	226	BPF_S_MISC_TAX,
	227	BPF_S_MISC_TXA,
	228	BPF_S_ALU_DIV_K,
	229	BPF_S_LD_MEM,
	230	BPF_S_LDX_MEM,
	231	BPF_S_ST,
	232	BPF_S_STX,
	233	BPF_S_JMP_JA,
	234	BPF_S_JMP_JEQ_K,
	235	BPF_S_JMP_JEQ_X,
	236	BPF_S_JMP_JGE_K,
	237	BPF_S_JMP_JGE_X,
	238	BPF_S_JMP_JGT_K,
	239	BPF_S_JMP_JGT_X,
	240	BPF_S_JMP_JSET_K,
	241	BPF_S_JMP_JSET_X,
	242	/* Ancillary data */
	243	BPF_S_ANC_PROTOCOL,
	244	BPF_S_ANC_PKTTYPE,
	245	BPF_S_ANC_IFINDEX,
	246	BPF_S_ANC_NLATTR,
	247	BPF_S_ANC_NLATTR_NEST,
	248	BPF_S_ANC_MARK,
	249	BPF_S_ANC_QUEUE,
	250	BPF_S_ANC_HATYPE,
	251	BPF_S_ANC_RXHASH,
	252	BPF_S_ANC_CPU,
ffe06c17	253	BPF_S_ANC_ALU_XOR_X,
46b325c7	254	BPF_S_ANC_SECCOMP_LD_W,
0a14842f ED	255	};
0a14842f ED	256
1da177e4 LT	257	#endif /* __KERNEL__ */
	258
	259	#endif /* __LINUX_FILTER_H__ */