Merge remote-tracking branch 'selinux/next'
[deliverable/linux.git] / include / linux / bpf.h
CommitLineData
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>
b121d1e7 13#include <linux/percpu.h>
002245cc 14#include <linux/err.h>
99c55f7d 15
3b1efb19 16struct perf_event;
99c55f7d
AS
17struct bpf_map;
18
19/* map is generic key/value storage optionally accesible by eBPF programs */
20struct bpf_map_ops {
21 /* funcs callable from userspace (via syscall) */
22 struct bpf_map *(*map_alloc)(union bpf_attr *attr);
61d1b6a4
DB
23 void (*map_release)(struct bpf_map *map, struct file *map_file);
24 void (*map_free)(struct bpf_map *map);
db20fd2b
AS
25 int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key);
26
27 /* funcs callable from userspace and from eBPF programs */
28 void *(*map_lookup_elem)(struct bpf_map *map, void *key);
3274f520 29 int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags);
db20fd2b 30 int (*map_delete_elem)(struct bpf_map *map, void *key);
2a36f0b9
WN
31
32 /* funcs called by prog_array and perf_event_array map */
d056a788
DB
33 void *(*map_fd_get_ptr)(struct bpf_map *map, struct file *map_file,
34 int fd);
35 void (*map_fd_put_ptr)(void *ptr);
99c55f7d
AS
36};
37
38struct bpf_map {
39 atomic_t refcnt;
40 enum bpf_map_type map_type;
41 u32 key_size;
42 u32 value_size;
43 u32 max_entries;
6c905981 44 u32 map_flags;
aaac3ba9
AS
45 u32 pages;
46 struct user_struct *user;
a2c83fff 47 const struct bpf_map_ops *ops;
99c55f7d 48 struct work_struct work;
c9da161c 49 atomic_t usercnt;
99c55f7d
AS
50};
51
52struct bpf_map_type_list {
53 struct list_head list_node;
a2c83fff 54 const struct bpf_map_ops *ops;
99c55f7d
AS
55 enum bpf_map_type type;
56};
57
17a52670
AS
58/* function argument constraints */
59enum bpf_arg_type {
80f1d68c 60 ARG_DONTCARE = 0, /* unused argument in helper function */
17a52670
AS
61
62 /* the following constraints used to prototype
63 * bpf_map_lookup/update/delete_elem() functions
64 */
65 ARG_CONST_MAP_PTR, /* const argument used as pointer to bpf_map */
66 ARG_PTR_TO_MAP_KEY, /* pointer to stack used as map key */
67 ARG_PTR_TO_MAP_VALUE, /* pointer to stack used as map value */
68
69 /* the following constraints used to prototype bpf_memcmp() and other
70 * functions that access data on eBPF program stack
71 */
72 ARG_PTR_TO_STACK, /* any pointer to eBPF program stack */
435faee1
DB
73 ARG_PTR_TO_RAW_STACK, /* any pointer to eBPF program stack, area does not
74 * need to be initialized, helper function must fill
75 * all bytes or clear them in error case.
76 */
77
17a52670 78 ARG_CONST_STACK_SIZE, /* number of bytes accessed from stack */
8e2fe1d9 79 ARG_CONST_STACK_SIZE_OR_ZERO, /* number of bytes accessed from stack or 0 */
80f1d68c 80
608cd71a 81 ARG_PTR_TO_CTX, /* pointer to context */
80f1d68c 82 ARG_ANYTHING, /* any (initialized) argument is ok */
17a52670
AS
83};
84
85/* type of values returned from helper functions */
86enum bpf_return_type {
87 RET_INTEGER, /* function returns integer */
88 RET_VOID, /* function doesn't return anything */
89 RET_PTR_TO_MAP_VALUE_OR_NULL, /* returns a pointer to map elem value or NULL */
90};
91
09756af4
AS
92/* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
93 * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
94 * instructions after verifying
95 */
96struct bpf_func_proto {
97 u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
98 bool gpl_only;
17a52670
AS
99 enum bpf_return_type ret_type;
100 enum bpf_arg_type arg1_type;
101 enum bpf_arg_type arg2_type;
102 enum bpf_arg_type arg3_type;
103 enum bpf_arg_type arg4_type;
104 enum bpf_arg_type arg5_type;
105};
106
107/* bpf_context is intentionally undefined structure. Pointer to bpf_context is
108 * the first argument to eBPF programs.
109 * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
110 */
111struct bpf_context;
112
113enum bpf_access_type {
114 BPF_READ = 1,
115 BPF_WRITE = 2
09756af4
AS
116};
117
19de99f7
AS
118/* types of values stored in eBPF registers */
119enum bpf_reg_type {
120 NOT_INIT = 0, /* nothing was written into register */
121 UNKNOWN_VALUE, /* reg doesn't contain a valid pointer */
122 PTR_TO_CTX, /* reg points to bpf_context */
123 CONST_PTR_TO_MAP, /* reg points to struct bpf_map */
124 PTR_TO_MAP_VALUE, /* reg points to map element value */
125 PTR_TO_MAP_VALUE_OR_NULL,/* points to map elem value or NULL */
126 FRAME_PTR, /* reg == frame_pointer */
127 PTR_TO_STACK, /* reg == frame_pointer + imm */
128 CONST_IMM, /* constant integer value */
129
130 /* PTR_TO_PACKET represents:
131 * skb->data
132 * skb->data + imm
133 * skb->data + (u16) var
134 * skb->data + (u16) var + imm
135 * if (range > 0) then [ptr, ptr + range - off) is safe to access
136 * if (id > 0) means that some 'var' was added
137 * if (off > 0) menas that 'imm' was added
138 */
139 PTR_TO_PACKET,
140 PTR_TO_PACKET_END, /* skb->data + headlen */
141};
142
ff936a04
AS
143struct bpf_prog;
144
09756af4
AS
145struct bpf_verifier_ops {
146 /* return eBPF function prototype for verification */
147 const struct bpf_func_proto *(*get_func_proto)(enum bpf_func_id func_id);
17a52670
AS
148
149 /* return true if 'size' wide access at offset 'off' within bpf_context
150 * with 'type' (read or write) is allowed
151 */
19de99f7
AS
152 bool (*is_valid_access)(int off, int size, enum bpf_access_type type,
153 enum bpf_reg_type *reg_type);
9bac3d6d 154
d691f9e8
AS
155 u32 (*convert_ctx_access)(enum bpf_access_type type, int dst_reg,
156 int src_reg, int ctx_off,
ff936a04 157 struct bpf_insn *insn, struct bpf_prog *prog);
09756af4
AS
158};
159
160struct bpf_prog_type_list {
161 struct list_head list_node;
a2c83fff 162 const struct bpf_verifier_ops *ops;
09756af4
AS
163 enum bpf_prog_type type;
164};
165
09756af4
AS
166struct bpf_prog_aux {
167 atomic_t refcnt;
24701ece 168 u32 used_map_cnt;
32bbe007 169 u32 max_ctx_offset;
a2c83fff 170 const struct bpf_verifier_ops *ops;
09756af4 171 struct bpf_map **used_maps;
09756af4 172 struct bpf_prog *prog;
aaac3ba9 173 struct user_struct *user;
abf2e7d6
AS
174 union {
175 struct work_struct work;
176 struct rcu_head rcu;
177 };
09756af4
AS
178};
179
04fd61ab
AS
180struct bpf_array {
181 struct bpf_map map;
182 u32 elem_size;
183 /* 'ownership' of prog_array is claimed by the first program that
184 * is going to use this map or by the first program which FD is stored
185 * in the map to make sure that all callers and callees have the same
186 * prog_type and JITed flag
187 */
188 enum bpf_prog_type owner_prog_type;
189 bool owner_jited;
190 union {
191 char value[0] __aligned(8);
2a36f0b9 192 void *ptrs[0] __aligned(8);
a10423b8 193 void __percpu *pptrs[0] __aligned(8);
04fd61ab
AS
194 };
195};
3b1efb19 196
04fd61ab
AS
197#define MAX_TAIL_CALL_CNT 32
198
3b1efb19
DB
199struct bpf_event_entry {
200 struct perf_event *event;
201 struct file *perf_file;
202 struct file *map_file;
203 struct rcu_head rcu;
204};
205
04fd61ab 206u64 bpf_tail_call(u64 ctx, u64 r2, u64 index, u64 r4, u64 r5);
9940d67c 207u64 bpf_get_stackid(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
d056a788 208
04fd61ab 209bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
bd570ff9 210
0756ea3e 211const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
555c8a86
DB
212
213typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src,
aa7145c1 214 unsigned long off, unsigned long len);
555c8a86
DB
215
216u64 bpf_event_output(struct bpf_map *map, u64 flags, void *meta, u64 meta_size,
217 void *ctx, u64 ctx_size, bpf_ctx_copy_t ctx_copy);
04fd61ab 218
89aa0758 219#ifdef CONFIG_BPF_SYSCALL
b121d1e7
AS
220DECLARE_PER_CPU(int, bpf_prog_active);
221
0fc174de 222void bpf_register_prog_type(struct bpf_prog_type_list *tl);
61e021f3 223void bpf_register_map_type(struct bpf_map_type_list *tl);
0fc174de 224
0fc174de 225struct bpf_prog *bpf_prog_get(u32 ufd);
113214be 226struct bpf_prog *bpf_prog_get_type(u32 ufd, enum bpf_prog_type type);
59d3656d 227struct bpf_prog *bpf_prog_add(struct bpf_prog *prog, int i);
92117d84 228struct bpf_prog *bpf_prog_inc(struct bpf_prog *prog);
61e021f3
DB
229void bpf_prog_put(struct bpf_prog *prog);
230
c9da161c 231struct bpf_map *bpf_map_get_with_uref(u32 ufd);
c2101297 232struct bpf_map *__bpf_map_get(struct fd f);
92117d84 233struct bpf_map *bpf_map_inc(struct bpf_map *map, bool uref);
c9da161c 234void bpf_map_put_with_uref(struct bpf_map *map);
61e021f3 235void bpf_map_put(struct bpf_map *map);
6c905981 236int bpf_map_precharge_memlock(u32 pages);
61e021f3 237
1be7f75d
AS
238extern int sysctl_unprivileged_bpf_disabled;
239
b2197755
DB
240int bpf_map_new_fd(struct bpf_map *map);
241int bpf_prog_new_fd(struct bpf_prog *prog);
242
243int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
244int bpf_obj_get_user(const char __user *pathname);
245
15a07b33
AS
246int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value);
247int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value);
248int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
249 u64 flags);
250int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
251 u64 flags);
d056a788 252
557c0c6e 253int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value);
15a07b33 254
d056a788
DB
255int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
256 void *key, void *value, u64 map_flags);
257void bpf_fd_array_map_clear(struct bpf_map *map);
258
15a07b33
AS
259/* memcpy that is used with 8-byte aligned pointers, power-of-8 size and
260 * forced to use 'long' read/writes to try to atomically copy long counters.
261 * Best-effort only. No barriers here, since it _will_ race with concurrent
262 * updates from BPF programs. Called from bpf syscall and mostly used with
263 * size 8 or 16 bytes, so ask compiler to inline it.
264 */
265static inline void bpf_long_memcpy(void *dst, const void *src, u32 size)
266{
267 const long *lsrc = src;
268 long *ldst = dst;
269
270 size /= sizeof(long);
271 while (size--)
272 *ldst++ = *lsrc++;
273}
274
61e021f3 275/* verify correctness of eBPF program */
9bac3d6d 276int bpf_check(struct bpf_prog **fp, union bpf_attr *attr);
89aa0758 277#else
0fc174de
DB
278static inline void bpf_register_prog_type(struct bpf_prog_type_list *tl)
279{
280}
281
282static inline struct bpf_prog *bpf_prog_get(u32 ufd)
283{
284 return ERR_PTR(-EOPNOTSUPP);
285}
286
113214be
DB
287static inline struct bpf_prog *bpf_prog_get_type(u32 ufd,
288 enum bpf_prog_type type)
289{
290 return ERR_PTR(-EOPNOTSUPP);
291}
cc2e0b3f
BB
292static inline struct bpf_prog *bpf_prog_add(struct bpf_prog *prog, int i)
293{
294 return ERR_PTR(-EOPNOTSUPP);
295}
113214be 296
0fc174de
DB
297static inline void bpf_prog_put(struct bpf_prog *prog)
298{
299}
aa6a5f3c
AS
300static inline struct bpf_prog *bpf_prog_inc(struct bpf_prog *prog)
301{
302 return ERR_PTR(-EOPNOTSUPP);
303}
61e021f3 304#endif /* CONFIG_BPF_SYSCALL */
09756af4 305
d0003ec0 306/* verifier prototypes for helper functions called from eBPF programs */
a2c83fff
DB
307extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
308extern const struct bpf_func_proto bpf_map_update_elem_proto;
309extern const struct bpf_func_proto bpf_map_delete_elem_proto;
d0003ec0 310
03e69b50 311extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
c04167ce 312extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
04fd61ab 313extern const struct bpf_func_proto bpf_tail_call_proto;
17ca8cbf 314extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
ffeedafb
AS
315extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
316extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
317extern const struct bpf_func_proto bpf_get_current_comm_proto;
4e10df9a
AS
318extern const struct bpf_func_proto bpf_skb_vlan_push_proto;
319extern const struct bpf_func_proto bpf_skb_vlan_pop_proto;
d5a3b1f6 320extern const struct bpf_func_proto bpf_get_stackid_proto;
03e69b50 321
3ad00405
DB
322/* Shared helpers among cBPF and eBPF. */
323void bpf_user_rnd_init_once(void);
324u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
325
99c55f7d 326#endif /* _LINUX_BPF_H */
This page took 0.189119 seconds and 5 git commands to generate.