]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/bpf.h
bpf: dynamically allocate digest scratch buffer
[mirror_ubuntu-bionic-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>
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;
36bbef52 99 bool pkt_access;
17a52670
AS
100 enum bpf_return_type ret_type;
101 enum bpf_arg_type arg1_type;
102 enum bpf_arg_type arg2_type;
103 enum bpf_arg_type arg3_type;
104 enum bpf_arg_type arg4_type;
105 enum bpf_arg_type arg5_type;
106};
107
108/* bpf_context is intentionally undefined structure. Pointer to bpf_context is
109 * the first argument to eBPF programs.
110 * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
111 */
112struct bpf_context;
113
114enum bpf_access_type {
115 BPF_READ = 1,
116 BPF_WRITE = 2
09756af4
AS
117};
118
19de99f7
AS
119/* types of values stored in eBPF registers */
120enum bpf_reg_type {
121 NOT_INIT = 0, /* nothing was written into register */
122 UNKNOWN_VALUE, /* reg doesn't contain a valid pointer */
123 PTR_TO_CTX, /* reg points to bpf_context */
124 CONST_PTR_TO_MAP, /* reg points to struct bpf_map */
125 PTR_TO_MAP_VALUE, /* reg points to map element value */
126 PTR_TO_MAP_VALUE_OR_NULL,/* points to map elem value or NULL */
127 FRAME_PTR, /* reg == frame_pointer */
128 PTR_TO_STACK, /* reg == frame_pointer + imm */
129 CONST_IMM, /* constant integer value */
130
131 /* PTR_TO_PACKET represents:
132 * skb->data
133 * skb->data + imm
134 * skb->data + (u16) var
135 * skb->data + (u16) var + imm
136 * if (range > 0) then [ptr, ptr + range - off) is safe to access
137 * if (id > 0) means that some 'var' was added
138 * if (off > 0) menas that 'imm' was added
139 */
140 PTR_TO_PACKET,
141 PTR_TO_PACKET_END, /* skb->data + headlen */
48461135
JB
142
143 /* PTR_TO_MAP_VALUE_ADJ is used for doing pointer math inside of a map
144 * elem value. We only allow this if we can statically verify that
145 * access from this register are going to fall within the size of the
146 * map element.
147 */
148 PTR_TO_MAP_VALUE_ADJ,
19de99f7
AS
149};
150
ff936a04
AS
151struct bpf_prog;
152
09756af4
AS
153struct bpf_verifier_ops {
154 /* return eBPF function prototype for verification */
155 const struct bpf_func_proto *(*get_func_proto)(enum bpf_func_id func_id);
17a52670
AS
156
157 /* return true if 'size' wide access at offset 'off' within bpf_context
158 * with 'type' (read or write) is allowed
159 */
19de99f7
AS
160 bool (*is_valid_access)(int off, int size, enum bpf_access_type type,
161 enum bpf_reg_type *reg_type);
36bbef52
DB
162 int (*gen_prologue)(struct bpf_insn *insn, bool direct_write,
163 const struct bpf_prog *prog);
d691f9e8
AS
164 u32 (*convert_ctx_access)(enum bpf_access_type type, int dst_reg,
165 int src_reg, int ctx_off,
ff936a04 166 struct bpf_insn *insn, struct bpf_prog *prog);
09756af4
AS
167};
168
169struct bpf_prog_type_list {
170 struct list_head list_node;
a2c83fff 171 const struct bpf_verifier_ops *ops;
09756af4
AS
172 enum bpf_prog_type type;
173};
174
09756af4
AS
175struct bpf_prog_aux {
176 atomic_t refcnt;
24701ece 177 u32 used_map_cnt;
32bbe007 178 u32 max_ctx_offset;
a2c83fff 179 const struct bpf_verifier_ops *ops;
09756af4 180 struct bpf_map **used_maps;
09756af4 181 struct bpf_prog *prog;
aaac3ba9 182 struct user_struct *user;
abf2e7d6
AS
183 union {
184 struct work_struct work;
185 struct rcu_head rcu;
186 };
09756af4
AS
187};
188
04fd61ab
AS
189struct bpf_array {
190 struct bpf_map map;
191 u32 elem_size;
192 /* 'ownership' of prog_array is claimed by the first program that
193 * is going to use this map or by the first program which FD is stored
194 * in the map to make sure that all callers and callees have the same
195 * prog_type and JITed flag
196 */
197 enum bpf_prog_type owner_prog_type;
198 bool owner_jited;
199 union {
200 char value[0] __aligned(8);
2a36f0b9 201 void *ptrs[0] __aligned(8);
a10423b8 202 void __percpu *pptrs[0] __aligned(8);
04fd61ab
AS
203 };
204};
3b1efb19 205
04fd61ab
AS
206#define MAX_TAIL_CALL_CNT 32
207
3b1efb19
DB
208struct bpf_event_entry {
209 struct perf_event *event;
210 struct file *perf_file;
211 struct file *map_file;
212 struct rcu_head rcu;
213};
214
04fd61ab 215u64 bpf_tail_call(u64 ctx, u64 r2, u64 index, u64 r4, u64 r5);
9940d67c 216u64 bpf_get_stackid(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
d056a788 217
04fd61ab 218bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
aafe6ae9 219int bpf_prog_calc_digest(struct bpf_prog *fp);
bd570ff9 220
0756ea3e 221const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
555c8a86
DB
222
223typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src,
aa7145c1 224 unsigned long off, unsigned long len);
555c8a86
DB
225
226u64 bpf_event_output(struct bpf_map *map, u64 flags, void *meta, u64 meta_size,
227 void *ctx, u64 ctx_size, bpf_ctx_copy_t ctx_copy);
04fd61ab 228
89aa0758 229#ifdef CONFIG_BPF_SYSCALL
b121d1e7
AS
230DECLARE_PER_CPU(int, bpf_prog_active);
231
0fc174de 232void bpf_register_prog_type(struct bpf_prog_type_list *tl);
61e021f3 233void bpf_register_map_type(struct bpf_map_type_list *tl);
0fc174de 234
0fc174de 235struct bpf_prog *bpf_prog_get(u32 ufd);
113214be 236struct bpf_prog *bpf_prog_get_type(u32 ufd, enum bpf_prog_type type);
6d67942d 237struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog, int i);
c540594f 238void bpf_prog_sub(struct bpf_prog *prog, int i);
6d67942d 239struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog);
61e021f3
DB
240void bpf_prog_put(struct bpf_prog *prog);
241
c9da161c 242struct bpf_map *bpf_map_get_with_uref(u32 ufd);
c2101297 243struct bpf_map *__bpf_map_get(struct fd f);
6d67942d 244struct bpf_map * __must_check bpf_map_inc(struct bpf_map *map, bool uref);
c9da161c 245void bpf_map_put_with_uref(struct bpf_map *map);
61e021f3 246void bpf_map_put(struct bpf_map *map);
6c905981 247int bpf_map_precharge_memlock(u32 pages);
61e021f3 248
1be7f75d
AS
249extern int sysctl_unprivileged_bpf_disabled;
250
b2197755
DB
251int bpf_map_new_fd(struct bpf_map *map);
252int bpf_prog_new_fd(struct bpf_prog *prog);
253
254int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
255int bpf_obj_get_user(const char __user *pathname);
256
15a07b33
AS
257int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value);
258int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value);
259int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
260 u64 flags);
261int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
262 u64 flags);
d056a788 263
557c0c6e 264int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value);
15a07b33 265
d056a788
DB
266int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
267 void *key, void *value, u64 map_flags);
268void bpf_fd_array_map_clear(struct bpf_map *map);
269
15a07b33
AS
270/* memcpy that is used with 8-byte aligned pointers, power-of-8 size and
271 * forced to use 'long' read/writes to try to atomically copy long counters.
272 * Best-effort only. No barriers here, since it _will_ race with concurrent
273 * updates from BPF programs. Called from bpf syscall and mostly used with
274 * size 8 or 16 bytes, so ask compiler to inline it.
275 */
276static inline void bpf_long_memcpy(void *dst, const void *src, u32 size)
277{
278 const long *lsrc = src;
279 long *ldst = dst;
280
281 size /= sizeof(long);
282 while (size--)
283 *ldst++ = *lsrc++;
284}
285
61e021f3 286/* verify correctness of eBPF program */
9bac3d6d 287int bpf_check(struct bpf_prog **fp, union bpf_attr *attr);
89aa0758 288#else
0fc174de
DB
289static inline void bpf_register_prog_type(struct bpf_prog_type_list *tl)
290{
291}
292
293static inline struct bpf_prog *bpf_prog_get(u32 ufd)
294{
295 return ERR_PTR(-EOPNOTSUPP);
296}
297
113214be
DB
298static inline struct bpf_prog *bpf_prog_get_type(u32 ufd,
299 enum bpf_prog_type type)
300{
301 return ERR_PTR(-EOPNOTSUPP);
302}
6d67942d
DB
303static inline struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog,
304 int i)
cc2e0b3f
BB
305{
306 return ERR_PTR(-EOPNOTSUPP);
307}
113214be 308
c540594f
DB
309static inline void bpf_prog_sub(struct bpf_prog *prog, int i)
310{
311}
312
0fc174de
DB
313static inline void bpf_prog_put(struct bpf_prog *prog)
314{
315}
6d67942d
DB
316
317static inline struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog)
aa6a5f3c
AS
318{
319 return ERR_PTR(-EOPNOTSUPP);
320}
61e021f3 321#endif /* CONFIG_BPF_SYSCALL */
09756af4 322
d0003ec0 323/* verifier prototypes for helper functions called from eBPF programs */
a2c83fff
DB
324extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
325extern const struct bpf_func_proto bpf_map_update_elem_proto;
326extern const struct bpf_func_proto bpf_map_delete_elem_proto;
d0003ec0 327
03e69b50 328extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
c04167ce 329extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
2d0e30c3 330extern const struct bpf_func_proto bpf_get_numa_node_id_proto;
04fd61ab 331extern const struct bpf_func_proto bpf_tail_call_proto;
17ca8cbf 332extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
ffeedafb
AS
333extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
334extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
335extern const struct bpf_func_proto bpf_get_current_comm_proto;
4e10df9a
AS
336extern const struct bpf_func_proto bpf_skb_vlan_push_proto;
337extern const struct bpf_func_proto bpf_skb_vlan_pop_proto;
d5a3b1f6 338extern const struct bpf_func_proto bpf_get_stackid_proto;
03e69b50 339
3ad00405
DB
340/* Shared helpers among cBPF and eBPF. */
341void bpf_user_rnd_init_once(void);
342u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
343
99c55f7d 344#endif /* _LINUX_BPF_H */