[deliverable/linux.git] / include / linux / bpf.h

/* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License as published by the Free Software Foundation.
 */
#ifndef _LINUX_BPF_H
#define _LINUX_BPF_H 1

#include <uapi/linux/bpf.h>
#include <linux/workqueue.h>
#include <linux/file.h>

struct bpf_map;

/* map is generic key/value storage optionally accesible by eBPF programs */
struct bpf_map_ops {
	/* funcs callable from userspace (via syscall) */
	struct bpf_map *(*map_alloc)(union bpf_attr *attr);
	void (*map_free)(struct bpf_map *);
	int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key);

	/* funcs callable from userspace and from eBPF programs */
	void *(*map_lookup_elem)(struct bpf_map *map, void *key);
	int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags);
	int (*map_delete_elem)(struct bpf_map *map, void *key);

	/* funcs called by prog_array and perf_event_array map */
	void *(*map_fd_get_ptr) (struct bpf_map *map, int fd);
	void (*map_fd_put_ptr) (void *ptr);
};

struct bpf_map {
	atomic_t refcnt;
	enum bpf_map_type map_type;
	u32 key_size;
	u32 value_size;
	u32 max_entries;
	u32 pages;
	struct user_struct *user;
	const struct bpf_map_ops *ops;
	struct work_struct work;
	atomic_t usercnt;
};

struct bpf_map_type_list {
	struct list_head list_node;
	const struct bpf_map_ops *ops;
	enum bpf_map_type type;
};

/* function argument constraints */
enum bpf_arg_type {
	ARG_DONTCARE = 0,	/* unused argument in helper function */

	/* the following constraints used to prototype
	 * bpf_map_lookup/update/delete_elem() functions
	 */
	ARG_CONST_MAP_PTR,	/* const argument used as pointer to bpf_map */
	ARG_PTR_TO_MAP_KEY,	/* pointer to stack used as map key */
	ARG_PTR_TO_MAP_VALUE,	/* pointer to stack used as map value */

	/* the following constraints used to prototype bpf_memcmp() and other
	 * functions that access data on eBPF program stack
	 */
	ARG_PTR_TO_STACK,	/* any pointer to eBPF program stack */
	ARG_CONST_STACK_SIZE,	/* number of bytes accessed from stack */

	ARG_PTR_TO_CTX,		/* pointer to context */
	ARG_ANYTHING,		/* any (initialized) argument is ok */
};

/* type of values returned from helper functions */
enum bpf_return_type {
	RET_INTEGER,			/* function returns integer */
	RET_VOID,			/* function doesn't return anything */
	RET_PTR_TO_MAP_VALUE_OR_NULL,	/* returns a pointer to map elem value or NULL */
};

/* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
 * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
 * instructions after verifying
 */
struct bpf_func_proto {
	u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
	bool gpl_only;
	enum bpf_return_type ret_type;
	enum bpf_arg_type arg1_type;
	enum bpf_arg_type arg2_type;
	enum bpf_arg_type arg3_type;
	enum bpf_arg_type arg4_type;
	enum bpf_arg_type arg5_type;
};

/* bpf_context is intentionally undefined structure. Pointer to bpf_context is
 * the first argument to eBPF programs.
 * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
 */
struct bpf_context;

enum bpf_access_type {
	BPF_READ = 1,
	BPF_WRITE = 2
};

struct bpf_prog;

struct bpf_verifier_ops {
	/* return eBPF function prototype for verification */
	const struct bpf_func_proto *(*get_func_proto)(enum bpf_func_id func_id);

	/* return true if 'size' wide access at offset 'off' within bpf_context
	 * with 'type' (read or write) is allowed
	 */
	bool (*is_valid_access)(int off, int size, enum bpf_access_type type);

	u32 (*convert_ctx_access)(enum bpf_access_type type, int dst_reg,
				  int src_reg, int ctx_off,
				  struct bpf_insn *insn, struct bpf_prog *prog);
};

struct bpf_prog_type_list {
	struct list_head list_node;
	const struct bpf_verifier_ops *ops;
	enum bpf_prog_type type;
};

struct bpf_prog_aux {
	atomic_t refcnt;
	u32 used_map_cnt;
	const struct bpf_verifier_ops *ops;
	struct bpf_map **used_maps;
	struct bpf_prog *prog;
	struct user_struct *user;
	union {
		struct work_struct work;
		struct rcu_head	rcu;
	};
};

struct bpf_array {
	struct bpf_map map;
	u32 elem_size;
	/* 'ownership' of prog_array is claimed by the first program that
	 * is going to use this map or by the first program which FD is stored
	 * in the map to make sure that all callers and callees have the same
	 * prog_type and JITed flag
	 */
	enum bpf_prog_type owner_prog_type;
	bool owner_jited;
	union {
		char value[0] __aligned(8);
		void *ptrs[0] __aligned(8);
	};
};
#define MAX_TAIL_CALL_CNT 32

u64 bpf_tail_call(u64 ctx, u64 r2, u64 index, u64 r4, u64 r5);
void bpf_fd_array_map_clear(struct bpf_map *map);
bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
const struct bpf_func_proto *bpf_get_trace_printk_proto(void);

#ifdef CONFIG_BPF_SYSCALL
void bpf_register_prog_type(struct bpf_prog_type_list *tl);
void bpf_register_map_type(struct bpf_map_type_list *tl);

struct bpf_prog *bpf_prog_get(u32 ufd);
void bpf_prog_put(struct bpf_prog *prog);
void bpf_prog_put_rcu(struct bpf_prog *prog);

struct bpf_map *bpf_map_get_with_uref(u32 ufd);
struct bpf_map *__bpf_map_get(struct fd f);
void bpf_map_inc(struct bpf_map *map, bool uref);
void bpf_map_put_with_uref(struct bpf_map *map);
void bpf_map_put(struct bpf_map *map);

extern int sysctl_unprivileged_bpf_disabled;

int bpf_map_new_fd(struct bpf_map *map);
int bpf_prog_new_fd(struct bpf_prog *prog);

int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
int bpf_obj_get_user(const char __user *pathname);

/* verify correctness of eBPF program */
int bpf_check(struct bpf_prog **fp, union bpf_attr *attr);
#else
static inline void bpf_register_prog_type(struct bpf_prog_type_list *tl)
{
}

static inline struct bpf_prog *bpf_prog_get(u32 ufd)
{
	return ERR_PTR(-EOPNOTSUPP);
}

static inline void bpf_prog_put(struct bpf_prog *prog)
{
}
#endif /* CONFIG_BPF_SYSCALL */

/* verifier prototypes for helper functions called from eBPF programs */
extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
extern const struct bpf_func_proto bpf_map_update_elem_proto;
extern const struct bpf_func_proto bpf_map_delete_elem_proto;

extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
extern const struct bpf_func_proto bpf_tail_call_proto;
extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
extern const struct bpf_func_proto bpf_get_current_comm_proto;
extern const struct bpf_func_proto bpf_skb_vlan_push_proto;
extern const struct bpf_func_proto bpf_skb_vlan_pop_proto;

/* Shared helpers among cBPF and eBPF. */
void bpf_user_rnd_init_once(void);
u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);

#endif /* _LINUX_BPF_H */
Commit	Line	Data
99c55f7d AS	1	/* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
	2	*
	3	* This program is free software; you can redistribute it and/or
	4	* modify it under the terms of version 2 of the GNU General Public
	5	* License as published by the Free Software Foundation.
	6	*/
	7	#ifndef _LINUX_BPF_H
	8	#define _LINUX_BPF_H 1
	9
	10	#include <uapi/linux/bpf.h>
	11	#include <linux/workqueue.h>
db20fd2b	12	#include <linux/file.h>
99c55f7d AS	13
	14	struct bpf_map;
	15
	16	/* map is generic key/value storage optionally accesible by eBPF programs */
	17	struct bpf_map_ops {
	18	/* funcs callable from userspace (via syscall) */
	19	struct bpf_map (map_alloc)(union bpf_attr *attr);
	20	void (map_free)(struct bpf_map );
db20fd2b AS	21	int (map_get_next_key)(struct bpf_map map, void key, void next_key);
	22
	23	/* funcs callable from userspace and from eBPF programs */
	24	void (map_lookup_elem)(struct bpf_map map, void key);
3274f520	25	int (map_update_elem)(struct bpf_map map, void key, void value, u64 flags);
db20fd2b	26	int (map_delete_elem)(struct bpf_map map, void *key);
2a36f0b9 WN	27
	28	/* funcs called by prog_array and perf_event_array map */
	29	void (map_fd_get_ptr) (struct bpf_map *map, int fd);
	30	void (map_fd_put_ptr) (void ptr);
99c55f7d AS	31	};
	32
	33	struct bpf_map {
	34	atomic_t refcnt;
	35	enum bpf_map_type map_type;
	36	u32 key_size;
	37	u32 value_size;
	38	u32 max_entries;
aaac3ba9 AS	39	u32 pages;
aaac3ba9 AS	40	struct user_struct *user;
a2c83fff	41	const struct bpf_map_ops *ops;
99c55f7d	42	struct work_struct work;
c9da161c	43	atomic_t usercnt;
99c55f7d AS	44	};
	45
	46	struct bpf_map_type_list {
	47	struct list_head list_node;
a2c83fff	48	const struct bpf_map_ops *ops;
99c55f7d AS	49	enum bpf_map_type type;
	50	};
	51
17a52670 AS	52	/* function argument constraints */
17a52670 AS	53	enum bpf_arg_type {
80f1d68c	54	ARG_DONTCARE = 0, /* unused argument in helper function */
17a52670 AS	55
	56	/* the following constraints used to prototype
	57	* bpf_map_lookup/update/delete_elem() functions
	58	*/
	59	ARG_CONST_MAP_PTR, /* const argument used as pointer to bpf_map */
	60	ARG_PTR_TO_MAP_KEY, /* pointer to stack used as map key */
	61	ARG_PTR_TO_MAP_VALUE, /* pointer to stack used as map value */
	62
	63	/* the following constraints used to prototype bpf_memcmp() and other
	64	* functions that access data on eBPF program stack
	65	*/
	66	ARG_PTR_TO_STACK, /* any pointer to eBPF program stack */
	67	ARG_CONST_STACK_SIZE, /* number of bytes accessed from stack */
80f1d68c	68
608cd71a	69	ARG_PTR_TO_CTX, /* pointer to context */
80f1d68c	70	ARG_ANYTHING, /* any (initialized) argument is ok */
17a52670 AS	71	};
	72
	73	/* type of values returned from helper functions */
	74	enum bpf_return_type {
	75	RET_INTEGER, /* function returns integer */
	76	RET_VOID, /* function doesn't return anything */
	77	RET_PTR_TO_MAP_VALUE_OR_NULL, /* returns a pointer to map elem value or NULL */
	78	};
	79
09756af4 AS	80	/* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
	81	* to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
	82	* instructions after verifying
	83	*/
	84	struct bpf_func_proto {
	85	u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
	86	bool gpl_only;
17a52670 AS	87	enum bpf_return_type ret_type;
	88	enum bpf_arg_type arg1_type;
	89	enum bpf_arg_type arg2_type;
	90	enum bpf_arg_type arg3_type;
	91	enum bpf_arg_type arg4_type;
	92	enum bpf_arg_type arg5_type;
	93	};
	94
	95	/* bpf_context is intentionally undefined structure. Pointer to bpf_context is
	96	* the first argument to eBPF programs.
	97	* For socket filters: 'struct bpf_context ' == 'struct sk_buff '
	98	*/
	99	struct bpf_context;
	100
	101	enum bpf_access_type {
	102	BPF_READ = 1,
	103	BPF_WRITE = 2
09756af4 AS	104	};
09756af4 AS	105
ff936a04 AS	106	struct bpf_prog;
ff936a04 AS	107
09756af4 AS	108	struct bpf_verifier_ops {
	109	/* return eBPF function prototype for verification */
	110	const struct bpf_func_proto (get_func_proto)(enum bpf_func_id func_id);
17a52670 AS	111
	112	/* return true if 'size' wide access at offset 'off' within bpf_context
	113	* with 'type' (read or write) is allowed
	114	*/
	115	bool (*is_valid_access)(int off, int size, enum bpf_access_type type);
9bac3d6d	116
d691f9e8 AS	117	u32 (*convert_ctx_access)(enum bpf_access_type type, int dst_reg,
d691f9e8 AS	118	int src_reg, int ctx_off,
ff936a04	119	struct bpf_insn insn, struct bpf_prog prog);
09756af4 AS	120	};
	121
	122	struct bpf_prog_type_list {
	123	struct list_head list_node;
a2c83fff	124	const struct bpf_verifier_ops *ops;
09756af4 AS	125	enum bpf_prog_type type;
	126	};
	127
09756af4 AS	128	struct bpf_prog_aux {
09756af4 AS	129	atomic_t refcnt;
24701ece	130	u32 used_map_cnt;
a2c83fff	131	const struct bpf_verifier_ops *ops;
09756af4	132	struct bpf_map **used_maps;
09756af4	133	struct bpf_prog *prog;
aaac3ba9	134	struct user_struct *user;
abf2e7d6 AS	135	union {
	136	struct work_struct work;
	137	struct rcu_head rcu;
	138	};
09756af4 AS	139	};
09756af4 AS	140
04fd61ab AS	141	struct bpf_array {
	142	struct bpf_map map;
	143	u32 elem_size;
	144	/* 'ownership' of prog_array is claimed by the first program that
	145	* is going to use this map or by the first program which FD is stored
	146	* in the map to make sure that all callers and callees have the same
	147	* prog_type and JITed flag
	148	*/
	149	enum bpf_prog_type owner_prog_type;
	150	bool owner_jited;
	151	union {
	152	char value[0] __aligned(8);
2a36f0b9	153	void *ptrs[0] __aligned(8);
04fd61ab AS	154	};
	155	};
	156	#define MAX_TAIL_CALL_CNT 32
	157
	158	u64 bpf_tail_call(u64 ctx, u64 r2, u64 index, u64 r4, u64 r5);
2a36f0b9	159	void bpf_fd_array_map_clear(struct bpf_map *map);
04fd61ab	160	bool bpf_prog_array_compatible(struct bpf_array array, const struct bpf_prog fp);
0756ea3e	161	const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
04fd61ab	162
89aa0758	163	#ifdef CONFIG_BPF_SYSCALL
0fc174de	164	void bpf_register_prog_type(struct bpf_prog_type_list *tl);
61e021f3	165	void bpf_register_map_type(struct bpf_map_type_list *tl);
0fc174de	166
0fc174de	167	struct bpf_prog *bpf_prog_get(u32 ufd);
61e021f3	168	void bpf_prog_put(struct bpf_prog *prog);
abf2e7d6	169	void bpf_prog_put_rcu(struct bpf_prog *prog);
61e021f3	170
c9da161c	171	struct bpf_map *bpf_map_get_with_uref(u32 ufd);
c2101297	172	struct bpf_map *__bpf_map_get(struct fd f);
c9da161c DB	173	void bpf_map_inc(struct bpf_map *map, bool uref);
c9da161c DB	174	void bpf_map_put_with_uref(struct bpf_map *map);
61e021f3 DB	175	void bpf_map_put(struct bpf_map *map);
61e021f3 DB	176
1be7f75d AS	177	extern int sysctl_unprivileged_bpf_disabled;
1be7f75d AS	178
b2197755 DB	179	int bpf_map_new_fd(struct bpf_map *map);
	180	int bpf_prog_new_fd(struct bpf_prog *prog);
	181
	182	int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
	183	int bpf_obj_get_user(const char __user *pathname);
	184
61e021f3	185	/* verify correctness of eBPF program */
9bac3d6d	186	int bpf_check(struct bpf_prog *fp, union bpf_attr attr);
89aa0758	187	#else
0fc174de DB	188	static inline void bpf_register_prog_type(struct bpf_prog_type_list *tl)
	189	{
	190	}
	191
	192	static inline struct bpf_prog *bpf_prog_get(u32 ufd)
	193	{
	194	return ERR_PTR(-EOPNOTSUPP);
	195	}
	196
	197	static inline void bpf_prog_put(struct bpf_prog *prog)
	198	{
	199	}
61e021f3	200	#endif /* CONFIG_BPF_SYSCALL */
09756af4	201
d0003ec0	202	/* verifier prototypes for helper functions called from eBPF programs */
a2c83fff DB	203	extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
	204	extern const struct bpf_func_proto bpf_map_update_elem_proto;
	205	extern const struct bpf_func_proto bpf_map_delete_elem_proto;
d0003ec0	206
03e69b50	207	extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
c04167ce	208	extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
04fd61ab	209	extern const struct bpf_func_proto bpf_tail_call_proto;
17ca8cbf	210	extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
ffeedafb AS	211	extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
	212	extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
	213	extern const struct bpf_func_proto bpf_get_current_comm_proto;
4e10df9a AS	214	extern const struct bpf_func_proto bpf_skb_vlan_push_proto;
4e10df9a AS	215	extern const struct bpf_func_proto bpf_skb_vlan_pop_proto;
03e69b50	216
3ad00405 DB	217	/* Shared helpers among cBPF and eBPF. */
	218	void bpf_user_rnd_init_once(void);
	219	u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
	220
99c55f7d	221	#endif /* _LINUX_BPF_H */