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