[deliverable/linux.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>

#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 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 *filter);
	union {
		struct sock_filter     	insns[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);
unsigned int sk_run_filter(const struct sk_buff *skb,
			   const struct sock_filter *filter);

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);
}
#define SK_RUN_FILTER(FILTER, SKB) (*FILTER->bpf_func)(SKB, FILTER->insns)
#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);
}
#define SK_RUN_FILTER(FILTER, SKB) sk_run_filter(SKB, FILTER->insns)
#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_SECCOMP_LD_W,
	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
0c5fe1b4 WD	12	#ifdef CONFIG_COMPAT
	13	/*
	14	* A struct sock_filter is architecture independent.
	15	*/
	16	struct compat_sock_fprog {
	17	u16 len;
	18	compat_uptr_t filter; /* struct sock_filter * */
	19	};
	20	#endif
	21
a3ea269b DB	22	struct sock_fprog_kern {
	23	u16 len;
	24	struct sock_filter *filter;
	25	};
	26
792d4b5c HC	27	struct sk_buff;
	28	struct sock;
	29
a3ea269b	30	struct sk_filter {
b715631f	31	atomic_t refcnt;
f8bbbfc3 DB	32	u32 jited:1, /* Is our filter JIT'ed? */
f8bbbfc3 DB	33	len:31; /* Number of filter blocks */
a3ea269b	34	struct sock_fprog_kern orig_prog; / Original BPF program */
d45ed4a4	35	struct rcu_head rcu;
0a14842f ED	36	unsigned int (bpf_func)(const struct sk_buff skb,
0a14842f ED	37	const struct sock_filter *filter);
d45ed4a4 AS	38	union {
	39	struct sock_filter insns[0];
	40	struct work_struct work;
	41	};
b715631f SH	42	};
b715631f SH	43
d45ed4a4	44	static inline unsigned int sk_filter_size(unsigned int proglen)
b715631f	45	{
d45ed4a4 AS	46	return max(sizeof(struct sk_filter),
d45ed4a4 AS	47	offsetof(struct sk_filter, insns[proglen]));
b715631f SH	48	}
b715631f SH	49
a3ea269b DB	50	#define sk_filter_proglen(fprog) \
	51	(fprog->len * sizeof(fprog->filter[0]))
	52
fbc907f0 DB	53	int sk_filter(struct sock sk, struct sk_buff skb);
	54	unsigned int sk_run_filter(const struct sk_buff *skb,
	55	const struct sock_filter *filter);
a3ea269b	56
fbc907f0 DB	57	int sk_unattached_filter_create(struct sk_filter **pfp,
	58	struct sock_fprog *fprog);
	59	void sk_unattached_filter_destroy(struct sk_filter *fp);
a3ea269b	60
fbc907f0 DB	61	int sk_attach_filter(struct sock_fprog fprog, struct sock sk);
fbc907f0 DB	62	int sk_detach_filter(struct sock *sk);
a3ea269b	63
fbc907f0 DB	64	int sk_chk_filter(struct sock_filter *filter, unsigned int flen);
	65	int sk_get_filter(struct sock sk, struct sock_filter __user filter,
	66	unsigned int len);
	67	void sk_decode_filter(struct sock_filter filt, struct sock_filter to);
	68
	69	void sk_filter_charge(struct sock sk, struct sk_filter fp);
	70	void sk_filter_uncharge(struct sock sk, struct sk_filter fp);
0a14842f ED	71
0a14842f ED	72	#ifdef CONFIG_BPF_JIT
20074f35	73	#include <stdarg.h>
a691ce7f CG	74	#include <linux/linkage.h>
	75	#include <linux/printk.h>
	76
fbc907f0 DB	77	void bpf_jit_compile(struct sk_filter *fp);
fbc907f0 DB	78	void bpf_jit_free(struct sk_filter *fp);
79617801 DB	79
	80	static inline void bpf_jit_dump(unsigned int flen, unsigned int proglen,
	81	u32 pass, void *image)
	82	{
16495445	83	pr_err("flen=%u proglen=%u pass=%u image=%pK\n",
79617801 DB	84	flen, proglen, pass, image);
79617801 DB	85	if (image)
16495445	86	print_hex_dump(KERN_ERR, "JIT code: ", DUMP_PREFIX_OFFSET,
79617801 DB	87	16, 1, image, proglen, false);
79617801 DB	88	}
0a14842f ED	89	#define SK_RUN_FILTER(FILTER, SKB) (*FILTER->bpf_func)(SKB, FILTER->insns)
0a14842f ED	90	#else
d45ed4a4	91	#include <linux/slab.h>
0a14842f ED	92	static inline void bpf_jit_compile(struct sk_filter *fp)
	93	{
	94	}
	95	static inline void bpf_jit_free(struct sk_filter *fp)
	96	{
d45ed4a4	97	kfree(fp);
0a14842f ED	98	}
	99	#define SK_RUN_FILTER(FILTER, SKB) sk_run_filter(SKB, FILTER->insns)
	100	#endif
	101
ea02f941 MS	102	static inline int bpf_tell_extensions(void)
ea02f941 MS	103	{
37692299	104	return SKF_AD_MAX;
ea02f941 MS	105	}
ea02f941 MS	106
0a14842f ED	107	enum {
	108	BPF_S_RET_K = 1,
	109	BPF_S_RET_A,
	110	BPF_S_ALU_ADD_K,
	111	BPF_S_ALU_ADD_X,
	112	BPF_S_ALU_SUB_K,
	113	BPF_S_ALU_SUB_X,
	114	BPF_S_ALU_MUL_K,
	115	BPF_S_ALU_MUL_X,
	116	BPF_S_ALU_DIV_X,
b6069a95 ED	117	BPF_S_ALU_MOD_K,
b6069a95 ED	118	BPF_S_ALU_MOD_X,
0a14842f ED	119	BPF_S_ALU_AND_K,
	120	BPF_S_ALU_AND_X,
	121	BPF_S_ALU_OR_K,
	122	BPF_S_ALU_OR_X,
9e49e889 DB	123	BPF_S_ALU_XOR_K,
9e49e889 DB	124	BPF_S_ALU_XOR_X,
0a14842f ED	125	BPF_S_ALU_LSH_K,
	126	BPF_S_ALU_LSH_X,
	127	BPF_S_ALU_RSH_K,
	128	BPF_S_ALU_RSH_X,
	129	BPF_S_ALU_NEG,
	130	BPF_S_LD_W_ABS,
	131	BPF_S_LD_H_ABS,
	132	BPF_S_LD_B_ABS,
	133	BPF_S_LD_W_LEN,
	134	BPF_S_LD_W_IND,
	135	BPF_S_LD_H_IND,
	136	BPF_S_LD_B_IND,
	137	BPF_S_LD_IMM,
	138	BPF_S_LDX_W_LEN,
	139	BPF_S_LDX_B_MSH,
	140	BPF_S_LDX_IMM,
	141	BPF_S_MISC_TAX,
	142	BPF_S_MISC_TXA,
	143	BPF_S_ALU_DIV_K,
	144	BPF_S_LD_MEM,
	145	BPF_S_LDX_MEM,
	146	BPF_S_ST,
	147	BPF_S_STX,
	148	BPF_S_JMP_JA,
	149	BPF_S_JMP_JEQ_K,
	150	BPF_S_JMP_JEQ_X,
	151	BPF_S_JMP_JGE_K,
	152	BPF_S_JMP_JGE_X,
	153	BPF_S_JMP_JGT_K,
	154	BPF_S_JMP_JGT_X,
	155	BPF_S_JMP_JSET_K,
	156	BPF_S_JMP_JSET_X,
	157	/* Ancillary data */
	158	BPF_S_ANC_PROTOCOL,
	159	BPF_S_ANC_PKTTYPE,
	160	BPF_S_ANC_IFINDEX,
	161	BPF_S_ANC_NLATTR,
	162	BPF_S_ANC_NLATTR_NEST,
	163	BPF_S_ANC_MARK,
	164	BPF_S_ANC_QUEUE,
	165	BPF_S_ANC_HATYPE,
	166	BPF_S_ANC_RXHASH,
	167	BPF_S_ANC_CPU,
ffe06c17	168	BPF_S_ANC_ALU_XOR_X,
46b325c7	169	BPF_S_ANC_SECCOMP_LD_W,
f3335031 ED	170	BPF_S_ANC_VLAN_TAG,
f3335031 ED	171	BPF_S_ANC_VLAN_TAG_PRESENT,
3e5289d5	172	BPF_S_ANC_PAY_OFFSET,
0a14842f ED	173	};
0a14842f ED	174
1da177e4	175	#endif /* __LINUX_FILTER_H__ */