]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/linux/bpf.h
Merge branch 'spi-5.1' into spi-linus
[mirror_ubuntu-jammy-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>
d6e1e46f 17#include <linux/numa.h>
ab3f0063 18#include <linux/wait.h>
492ecee8 19#include <linux/u64_stats_sync.h>
99c55f7d 20
cae1927c 21struct bpf_verifier_env;
3b1efb19 22struct perf_event;
174a79ff 23struct bpf_prog;
99c55f7d 24struct bpf_map;
4f738adb 25struct sock;
a26ca7c9 26struct seq_file;
1b2b234b 27struct btf;
e8d2bec0 28struct btf_type;
99c55f7d
AS
29
30/* map is generic key/value storage optionally accesible by eBPF programs */
31struct bpf_map_ops {
32 /* funcs callable from userspace (via syscall) */
1110f3a9 33 int (*map_alloc_check)(union bpf_attr *attr);
99c55f7d 34 struct bpf_map *(*map_alloc)(union bpf_attr *attr);
61d1b6a4
DB
35 void (*map_release)(struct bpf_map *map, struct file *map_file);
36 void (*map_free)(struct bpf_map *map);
db20fd2b 37 int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key);
ba6b8de4 38 void (*map_release_uref)(struct bpf_map *map);
db20fd2b
AS
39
40 /* funcs callable from userspace and from eBPF programs */
41 void *(*map_lookup_elem)(struct bpf_map *map, void *key);
3274f520 42 int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags);
db20fd2b 43 int (*map_delete_elem)(struct bpf_map *map, void *key);
f1a2e44a
MV
44 int (*map_push_elem)(struct bpf_map *map, void *value, u64 flags);
45 int (*map_pop_elem)(struct bpf_map *map, void *value);
46 int (*map_peek_elem)(struct bpf_map *map, void *value);
2a36f0b9
WN
47
48 /* funcs called by prog_array and perf_event_array map */
d056a788
DB
49 void *(*map_fd_get_ptr)(struct bpf_map *map, struct file *map_file,
50 int fd);
51 void (*map_fd_put_ptr)(void *ptr);
81ed18ab 52 u32 (*map_gen_lookup)(struct bpf_map *map, struct bpf_insn *insn_buf);
14dc6f04 53 u32 (*map_fd_sys_lookup_elem)(void *ptr);
a26ca7c9
MKL
54 void (*map_seq_show_elem)(struct bpf_map *map, void *key,
55 struct seq_file *m);
e8d2bec0 56 int (*map_check_btf)(const struct bpf_map *map,
1b2b234b 57 const struct btf *btf,
e8d2bec0
DB
58 const struct btf_type *key_type,
59 const struct btf_type *value_type);
99c55f7d
AS
60};
61
62struct bpf_map {
a26ca7c9 63 /* The first two cachelines with read-mostly members of which some
be95a845
DB
64 * are also accessed in fast-path (e.g. ops, max_entries).
65 */
66 const struct bpf_map_ops *ops ____cacheline_aligned;
67 struct bpf_map *inner_map_meta;
68#ifdef CONFIG_SECURITY
69 void *security;
70#endif
99c55f7d
AS
71 enum bpf_map_type map_type;
72 u32 key_size;
73 u32 value_size;
74 u32 max_entries;
6c905981 75 u32 map_flags;
d83525ca 76 int spin_lock_off; /* >=0 valid offset, <0 error */
f3f1c054 77 u32 id;
96eabe7a 78 int numa_node;
9b2cf328
MKL
79 u32 btf_key_type_id;
80 u32 btf_value_type_id;
a26ca7c9 81 struct btf *btf;
d83525ca 82 u32 pages;
b2157399 83 bool unpriv_array;
d83525ca 84 /* 51 bytes hole */
be95a845 85
a26ca7c9 86 /* The 3rd and 4th cacheline with misc members to avoid false sharing
be95a845
DB
87 * particularly with refcounting.
88 */
89 struct user_struct *user ____cacheline_aligned;
90 atomic_t refcnt;
c9da161c 91 atomic_t usercnt;
be95a845 92 struct work_struct work;
067cae47 93 char name[BPF_OBJ_NAME_LEN];
99c55f7d
AS
94};
95
d83525ca
AS
96static inline bool map_value_has_spin_lock(const struct bpf_map *map)
97{
98 return map->spin_lock_off >= 0;
99}
100
101static inline void check_and_init_map_lock(struct bpf_map *map, void *dst)
102{
103 if (likely(!map_value_has_spin_lock(map)))
104 return;
105 *(struct bpf_spin_lock *)(dst + map->spin_lock_off) =
106 (struct bpf_spin_lock){};
107}
108
109/* copy everything but bpf_spin_lock */
110static inline void copy_map_value(struct bpf_map *map, void *dst, void *src)
111{
112 if (unlikely(map_value_has_spin_lock(map))) {
113 u32 off = map->spin_lock_off;
114
115 memcpy(dst, src, off);
116 memcpy(dst + off + sizeof(struct bpf_spin_lock),
117 src + off + sizeof(struct bpf_spin_lock),
118 map->value_size - off - sizeof(struct bpf_spin_lock));
119 } else {
120 memcpy(dst, src, map->value_size);
121 }
122}
96049f3a
AS
123void copy_map_value_locked(struct bpf_map *map, void *dst, void *src,
124 bool lock_src);
d83525ca 125
602144c2 126struct bpf_offload_dev;
a3884572
JK
127struct bpf_offloaded_map;
128
129struct bpf_map_dev_ops {
130 int (*map_get_next_key)(struct bpf_offloaded_map *map,
131 void *key, void *next_key);
132 int (*map_lookup_elem)(struct bpf_offloaded_map *map,
133 void *key, void *value);
134 int (*map_update_elem)(struct bpf_offloaded_map *map,
135 void *key, void *value, u64 flags);
136 int (*map_delete_elem)(struct bpf_offloaded_map *map, void *key);
137};
138
139struct bpf_offloaded_map {
140 struct bpf_map map;
141 struct net_device *netdev;
142 const struct bpf_map_dev_ops *dev_ops;
143 void *dev_priv;
144 struct list_head offloads;
145};
146
147static inline struct bpf_offloaded_map *map_to_offmap(struct bpf_map *map)
148{
149 return container_of(map, struct bpf_offloaded_map, map);
150}
151
0cd3cbed
JK
152static inline bool bpf_map_offload_neutral(const struct bpf_map *map)
153{
154 return map->map_type == BPF_MAP_TYPE_PERF_EVENT_ARRAY;
155}
156
a26ca7c9
MKL
157static inline bool bpf_map_support_seq_show(const struct bpf_map *map)
158{
e8d2bec0 159 return map->btf && map->ops->map_seq_show_elem;
a26ca7c9
MKL
160}
161
e8d2bec0 162int map_check_no_btf(const struct bpf_map *map,
1b2b234b 163 const struct btf *btf,
e8d2bec0
DB
164 const struct btf_type *key_type,
165 const struct btf_type *value_type);
166
a3884572
JK
167extern const struct bpf_map_ops bpf_map_offload_ops;
168
17a52670
AS
169/* function argument constraints */
170enum bpf_arg_type {
80f1d68c 171 ARG_DONTCARE = 0, /* unused argument in helper function */
17a52670
AS
172
173 /* the following constraints used to prototype
174 * bpf_map_lookup/update/delete_elem() functions
175 */
176 ARG_CONST_MAP_PTR, /* const argument used as pointer to bpf_map */
177 ARG_PTR_TO_MAP_KEY, /* pointer to stack used as map key */
178 ARG_PTR_TO_MAP_VALUE, /* pointer to stack used as map value */
2ea864c5 179 ARG_PTR_TO_UNINIT_MAP_VALUE, /* pointer to valid memory used to store a map value */
17a52670
AS
180
181 /* the following constraints used to prototype bpf_memcmp() and other
182 * functions that access data on eBPF program stack
183 */
39f19ebb 184 ARG_PTR_TO_MEM, /* pointer to valid memory (stack, packet, map value) */
db1ac496 185 ARG_PTR_TO_MEM_OR_NULL, /* pointer to valid memory or NULL */
39f19ebb
AS
186 ARG_PTR_TO_UNINIT_MEM, /* pointer to memory does not need to be initialized,
187 * helper function must fill all bytes or clear
188 * them in error case.
435faee1
DB
189 */
190
39f19ebb
AS
191 ARG_CONST_SIZE, /* number of bytes accessed from memory */
192 ARG_CONST_SIZE_OR_ZERO, /* number of bytes accessed from memory or 0 */
80f1d68c 193
608cd71a 194 ARG_PTR_TO_CTX, /* pointer to context */
80f1d68c 195 ARG_ANYTHING, /* any (initialized) argument is ok */
d83525ca 196 ARG_PTR_TO_SPIN_LOCK, /* pointer to bpf_spin_lock */
46f8bc92 197 ARG_PTR_TO_SOCK_COMMON, /* pointer to sock_common */
17a52670
AS
198};
199
200/* type of values returned from helper functions */
201enum bpf_return_type {
202 RET_INTEGER, /* function returns integer */
203 RET_VOID, /* function doesn't return anything */
3e6a4b3e 204 RET_PTR_TO_MAP_VALUE, /* returns a pointer to map elem value */
17a52670 205 RET_PTR_TO_MAP_VALUE_OR_NULL, /* returns a pointer to map elem value or NULL */
c64b7983 206 RET_PTR_TO_SOCKET_OR_NULL, /* returns a pointer to a socket or NULL */
655a51e5 207 RET_PTR_TO_TCP_SOCK_OR_NULL, /* returns a pointer to a tcp_sock or NULL */
17a52670
AS
208};
209
09756af4
AS
210/* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
211 * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
212 * instructions after verifying
213 */
214struct bpf_func_proto {
215 u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
216 bool gpl_only;
36bbef52 217 bool pkt_access;
17a52670
AS
218 enum bpf_return_type ret_type;
219 enum bpf_arg_type arg1_type;
220 enum bpf_arg_type arg2_type;
221 enum bpf_arg_type arg3_type;
222 enum bpf_arg_type arg4_type;
223 enum bpf_arg_type arg5_type;
224};
225
226/* bpf_context is intentionally undefined structure. Pointer to bpf_context is
227 * the first argument to eBPF programs.
228 * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
229 */
230struct bpf_context;
231
232enum bpf_access_type {
233 BPF_READ = 1,
234 BPF_WRITE = 2
09756af4
AS
235};
236
19de99f7 237/* types of values stored in eBPF registers */
f1174f77
EC
238/* Pointer types represent:
239 * pointer
240 * pointer + imm
241 * pointer + (u16) var
242 * pointer + (u16) var + imm
243 * if (range > 0) then [ptr, ptr + range - off) is safe to access
244 * if (id > 0) means that some 'var' was added
245 * if (off > 0) means that 'imm' was added
246 */
19de99f7
AS
247enum bpf_reg_type {
248 NOT_INIT = 0, /* nothing was written into register */
f1174f77 249 SCALAR_VALUE, /* reg doesn't contain a valid pointer */
19de99f7
AS
250 PTR_TO_CTX, /* reg points to bpf_context */
251 CONST_PTR_TO_MAP, /* reg points to struct bpf_map */
252 PTR_TO_MAP_VALUE, /* reg points to map element value */
253 PTR_TO_MAP_VALUE_OR_NULL,/* points to map elem value or NULL */
f1174f77 254 PTR_TO_STACK, /* reg == frame_pointer + offset */
de8f3a83 255 PTR_TO_PACKET_META, /* skb->data - meta_len */
f1174f77 256 PTR_TO_PACKET, /* reg points to skb->data */
19de99f7 257 PTR_TO_PACKET_END, /* skb->data + headlen */
d58e468b 258 PTR_TO_FLOW_KEYS, /* reg points to bpf_flow_keys */
c64b7983
JS
259 PTR_TO_SOCKET, /* reg points to struct bpf_sock */
260 PTR_TO_SOCKET_OR_NULL, /* reg points to struct bpf_sock or NULL */
46f8bc92
MKL
261 PTR_TO_SOCK_COMMON, /* reg points to sock_common */
262 PTR_TO_SOCK_COMMON_OR_NULL, /* reg points to sock_common or NULL */
655a51e5
MKL
263 PTR_TO_TCP_SOCK, /* reg points to struct tcp_sock */
264 PTR_TO_TCP_SOCK_OR_NULL, /* reg points to struct tcp_sock or NULL */
19de99f7
AS
265};
266
23994631
YS
267/* The information passed from prog-specific *_is_valid_access
268 * back to the verifier.
269 */
270struct bpf_insn_access_aux {
271 enum bpf_reg_type reg_type;
272 int ctx_field_size;
23994631
YS
273};
274
f96da094
DB
275static inline void
276bpf_ctx_record_field_size(struct bpf_insn_access_aux *aux, u32 size)
277{
278 aux->ctx_field_size = size;
279}
280
7de16e3a
JK
281struct bpf_prog_ops {
282 int (*test_run)(struct bpf_prog *prog, const union bpf_attr *kattr,
283 union bpf_attr __user *uattr);
284};
285
09756af4
AS
286struct bpf_verifier_ops {
287 /* return eBPF function prototype for verification */
5e43f899
AI
288 const struct bpf_func_proto *
289 (*get_func_proto)(enum bpf_func_id func_id,
290 const struct bpf_prog *prog);
17a52670
AS
291
292 /* return true if 'size' wide access at offset 'off' within bpf_context
293 * with 'type' (read or write) is allowed
294 */
19de99f7 295 bool (*is_valid_access)(int off, int size, enum bpf_access_type type,
5e43f899 296 const struct bpf_prog *prog,
23994631 297 struct bpf_insn_access_aux *info);
36bbef52
DB
298 int (*gen_prologue)(struct bpf_insn *insn, bool direct_write,
299 const struct bpf_prog *prog);
e0cea7ce
DB
300 int (*gen_ld_abs)(const struct bpf_insn *orig,
301 struct bpf_insn *insn_buf);
6b8cc1d1
DB
302 u32 (*convert_ctx_access)(enum bpf_access_type type,
303 const struct bpf_insn *src,
304 struct bpf_insn *dst,
f96da094 305 struct bpf_prog *prog, u32 *target_size);
09756af4
AS
306};
307
cae1927c 308struct bpf_prog_offload_ops {
08ca90af 309 /* verifier basic callbacks */
cae1927c
JK
310 int (*insn_hook)(struct bpf_verifier_env *env,
311 int insn_idx, int prev_insn_idx);
c941ce9c 312 int (*finalize)(struct bpf_verifier_env *env);
08ca90af
JK
313 /* verifier optimization callbacks (called after .finalize) */
314 int (*replace_insn)(struct bpf_verifier_env *env, u32 off,
315 struct bpf_insn *insn);
316 int (*remove_insns)(struct bpf_verifier_env *env, u32 off, u32 cnt);
317 /* program management callbacks */
16a8cb5c
QM
318 int (*prepare)(struct bpf_prog *prog);
319 int (*translate)(struct bpf_prog *prog);
eb911947 320 void (*destroy)(struct bpf_prog *prog);
cae1927c
JK
321};
322
0a9c1991 323struct bpf_prog_offload {
ab3f0063
JK
324 struct bpf_prog *prog;
325 struct net_device *netdev;
341b3e7b 326 struct bpf_offload_dev *offdev;
ab3f0063
JK
327 void *dev_priv;
328 struct list_head offloads;
329 bool dev_state;
08ca90af 330 bool opt_failed;
fcfb126d
JW
331 void *jited_image;
332 u32 jited_len;
ab3f0063
JK
333};
334
8bad74f9
RG
335enum bpf_cgroup_storage_type {
336 BPF_CGROUP_STORAGE_SHARED,
b741f163 337 BPF_CGROUP_STORAGE_PERCPU,
8bad74f9
RG
338 __BPF_CGROUP_STORAGE_MAX
339};
340
341#define MAX_BPF_CGROUP_STORAGE_TYPE __BPF_CGROUP_STORAGE_MAX
342
492ecee8
AS
343struct bpf_prog_stats {
344 u64 cnt;
345 u64 nsecs;
346 struct u64_stats_sync syncp;
347};
348
09756af4
AS
349struct bpf_prog_aux {
350 atomic_t refcnt;
24701ece 351 u32 used_map_cnt;
32bbe007 352 u32 max_ctx_offset;
e647815a 353 u32 max_pkt_offset;
8726679a 354 u32 stack_depth;
dc4bb0e2 355 u32 id;
ba64e7d8
YS
356 u32 func_cnt; /* used by non-func prog as the number of func progs */
357 u32 func_idx; /* 0 for non-func prog, the index in func array for func prog */
9a18eedb 358 bool offload_requested;
1c2a088a
AS
359 struct bpf_prog **func;
360 void *jit_data; /* JIT specific data. arch dependent */
74451e66
DB
361 struct latch_tree_node ksym_tnode;
362 struct list_head ksym_lnode;
7de16e3a 363 const struct bpf_prog_ops *ops;
09756af4 364 struct bpf_map **used_maps;
09756af4 365 struct bpf_prog *prog;
aaac3ba9 366 struct user_struct *user;
cb4d2b3f 367 u64 load_time; /* ns since boottime */
8bad74f9 368 struct bpf_map *cgroup_storage[MAX_BPF_CGROUP_STORAGE_TYPE];
067cae47 369 char name[BPF_OBJ_NAME_LEN];
afdb09c7
CF
370#ifdef CONFIG_SECURITY
371 void *security;
372#endif
0a9c1991 373 struct bpf_prog_offload *offload;
838e9690 374 struct btf *btf;
ba64e7d8 375 struct bpf_func_info *func_info;
c454a46b
MKL
376 /* bpf_line_info loaded from userspace. linfo->insn_off
377 * has the xlated insn offset.
378 * Both the main and sub prog share the same linfo.
379 * The subprog can access its first linfo by
380 * using the linfo_idx.
381 */
382 struct bpf_line_info *linfo;
383 /* jited_linfo is the jited addr of the linfo. It has a
384 * one to one mapping to linfo:
385 * jited_linfo[i] is the jited addr for the linfo[i]->insn_off.
386 * Both the main and sub prog share the same jited_linfo.
387 * The subprog can access its first jited_linfo by
388 * using the linfo_idx.
389 */
390 void **jited_linfo;
ba64e7d8 391 u32 func_info_cnt;
c454a46b
MKL
392 u32 nr_linfo;
393 /* subprog can use linfo_idx to access its first linfo and
394 * jited_linfo.
395 * main prog always has linfo_idx == 0
396 */
397 u32 linfo_idx;
492ecee8 398 struct bpf_prog_stats __percpu *stats;
abf2e7d6
AS
399 union {
400 struct work_struct work;
401 struct rcu_head rcu;
402 };
09756af4
AS
403};
404
04fd61ab
AS
405struct bpf_array {
406 struct bpf_map map;
407 u32 elem_size;
b2157399 408 u32 index_mask;
04fd61ab
AS
409 /* 'ownership' of prog_array is claimed by the first program that
410 * is going to use this map or by the first program which FD is stored
411 * in the map to make sure that all callers and callees have the same
412 * prog_type and JITed flag
413 */
414 enum bpf_prog_type owner_prog_type;
415 bool owner_jited;
416 union {
417 char value[0] __aligned(8);
2a36f0b9 418 void *ptrs[0] __aligned(8);
a10423b8 419 void __percpu *pptrs[0] __aligned(8);
04fd61ab
AS
420 };
421};
3b1efb19 422
04fd61ab
AS
423#define MAX_TAIL_CALL_CNT 32
424
3b1efb19
DB
425struct bpf_event_entry {
426 struct perf_event *event;
427 struct file *perf_file;
428 struct file *map_file;
429 struct rcu_head rcu;
430};
431
04fd61ab 432bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
f1f7714e 433int bpf_prog_calc_tag(struct bpf_prog *fp);
bd570ff9 434
0756ea3e 435const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
555c8a86
DB
436
437typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src,
aa7145c1 438 unsigned long off, unsigned long len);
c64b7983
JS
439typedef u32 (*bpf_convert_ctx_access_t)(enum bpf_access_type type,
440 const struct bpf_insn *src,
441 struct bpf_insn *dst,
442 struct bpf_prog *prog,
443 u32 *target_size);
555c8a86
DB
444
445u64 bpf_event_output(struct bpf_map *map, u64 flags, void *meta, u64 meta_size,
446 void *ctx, u64 ctx_size, bpf_ctx_copy_t ctx_copy);
04fd61ab 447
1cf1cae9
AS
448int bpf_prog_test_run_xdp(struct bpf_prog *prog, const union bpf_attr *kattr,
449 union bpf_attr __user *uattr);
450int bpf_prog_test_run_skb(struct bpf_prog *prog, const union bpf_attr *kattr,
451 union bpf_attr __user *uattr);
b7a1848e
SF
452int bpf_prog_test_run_flow_dissector(struct bpf_prog *prog,
453 const union bpf_attr *kattr,
454 union bpf_attr __user *uattr);
1cf1cae9 455
324bda9e
AS
456/* an array of programs to be executed under rcu_lock.
457 *
458 * Typical usage:
459 * ret = BPF_PROG_RUN_ARRAY(&bpf_prog_array, ctx, BPF_PROG_RUN);
460 *
461 * the structure returned by bpf_prog_array_alloc() should be populated
462 * with program pointers and the last pointer must be NULL.
463 * The user has to keep refcnt on the program and make sure the program
464 * is removed from the array before bpf_prog_put().
465 * The 'struct bpf_prog_array *' should only be replaced with xchg()
466 * since other cpus are walking the array of pointers in parallel.
467 */
394e40a2
RG
468struct bpf_prog_array_item {
469 struct bpf_prog *prog;
8bad74f9 470 struct bpf_cgroup_storage *cgroup_storage[MAX_BPF_CGROUP_STORAGE_TYPE];
394e40a2
RG
471};
472
324bda9e
AS
473struct bpf_prog_array {
474 struct rcu_head rcu;
394e40a2 475 struct bpf_prog_array_item items[0];
324bda9e
AS
476};
477
d29ab6e1 478struct bpf_prog_array *bpf_prog_array_alloc(u32 prog_cnt, gfp_t flags);
324bda9e 479void bpf_prog_array_free(struct bpf_prog_array __rcu *progs);
468e2f64
AS
480int bpf_prog_array_length(struct bpf_prog_array __rcu *progs);
481int bpf_prog_array_copy_to_user(struct bpf_prog_array __rcu *progs,
482 __u32 __user *prog_ids, u32 cnt);
324bda9e 483
e87c6bc3
YS
484void bpf_prog_array_delete_safe(struct bpf_prog_array __rcu *progs,
485 struct bpf_prog *old_prog);
f371b304 486int bpf_prog_array_copy_info(struct bpf_prog_array __rcu *array,
3a38bb98
YS
487 u32 *prog_ids, u32 request_cnt,
488 u32 *prog_cnt);
e87c6bc3
YS
489int bpf_prog_array_copy(struct bpf_prog_array __rcu *old_array,
490 struct bpf_prog *exclude_prog,
491 struct bpf_prog *include_prog,
492 struct bpf_prog_array **new_array);
493
494#define __BPF_PROG_RUN_ARRAY(array, ctx, func, check_non_null) \
324bda9e 495 ({ \
394e40a2
RG
496 struct bpf_prog_array_item *_item; \
497 struct bpf_prog *_prog; \
e87c6bc3 498 struct bpf_prog_array *_array; \
324bda9e 499 u32 _ret = 1; \
6899b32b 500 preempt_disable(); \
324bda9e 501 rcu_read_lock(); \
e87c6bc3
YS
502 _array = rcu_dereference(array); \
503 if (unlikely(check_non_null && !_array))\
504 goto _out; \
394e40a2
RG
505 _item = &_array->items[0]; \
506 while ((_prog = READ_ONCE(_item->prog))) { \
507 bpf_cgroup_storage_set(_item->cgroup_storage); \
508 _ret &= func(_prog, ctx); \
509 _item++; \
e87c6bc3
YS
510 } \
511_out: \
324bda9e 512 rcu_read_unlock(); \
6899b32b 513 preempt_enable_no_resched(); \
324bda9e
AS
514 _ret; \
515 })
516
e87c6bc3
YS
517#define BPF_PROG_RUN_ARRAY(array, ctx, func) \
518 __BPF_PROG_RUN_ARRAY(array, ctx, func, false)
519
520#define BPF_PROG_RUN_ARRAY_CHECK(array, ctx, func) \
521 __BPF_PROG_RUN_ARRAY(array, ctx, func, true)
522
89aa0758 523#ifdef CONFIG_BPF_SYSCALL
b121d1e7
AS
524DECLARE_PER_CPU(int, bpf_prog_active);
525
f66e448c
CF
526extern const struct file_operations bpf_map_fops;
527extern const struct file_operations bpf_prog_fops;
528
7de16e3a
JK
529#define BPF_PROG_TYPE(_id, _name) \
530 extern const struct bpf_prog_ops _name ## _prog_ops; \
531 extern const struct bpf_verifier_ops _name ## _verifier_ops;
40077e0c
JB
532#define BPF_MAP_TYPE(_id, _ops) \
533 extern const struct bpf_map_ops _ops;
be9370a7
JB
534#include <linux/bpf_types.h>
535#undef BPF_PROG_TYPE
40077e0c 536#undef BPF_MAP_TYPE
0fc174de 537
ab3f0063 538extern const struct bpf_prog_ops bpf_offload_prog_ops;
4f9218aa
JK
539extern const struct bpf_verifier_ops tc_cls_act_analyzer_ops;
540extern const struct bpf_verifier_ops xdp_analyzer_ops;
541
0fc174de 542struct bpf_prog *bpf_prog_get(u32 ufd);
248f346f 543struct bpf_prog *bpf_prog_get_type_dev(u32 ufd, enum bpf_prog_type type,
288b3de5 544 bool attach_drv);
6d67942d 545struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog, int i);
c540594f 546void bpf_prog_sub(struct bpf_prog *prog, int i);
6d67942d 547struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog);
a6f6df69 548struct bpf_prog * __must_check bpf_prog_inc_not_zero(struct bpf_prog *prog);
61e021f3 549void bpf_prog_put(struct bpf_prog *prog);
5ccb071e
DB
550int __bpf_prog_charge(struct user_struct *user, u32 pages);
551void __bpf_prog_uncharge(struct user_struct *user, u32 pages);
61e021f3 552
ad8ad79f 553void bpf_prog_free_id(struct bpf_prog *prog, bool do_idr_lock);
a3884572 554void bpf_map_free_id(struct bpf_map *map, bool do_idr_lock);
ad8ad79f 555
c9da161c 556struct bpf_map *bpf_map_get_with_uref(u32 ufd);
c2101297 557struct bpf_map *__bpf_map_get(struct fd f);
6d67942d 558struct bpf_map * __must_check bpf_map_inc(struct bpf_map *map, bool uref);
c9da161c 559void bpf_map_put_with_uref(struct bpf_map *map);
61e021f3 560void bpf_map_put(struct bpf_map *map);
6c905981 561int bpf_map_precharge_memlock(u32 pages);
0a4c58f5
RG
562int bpf_map_charge_memlock(struct bpf_map *map, u32 pages);
563void bpf_map_uncharge_memlock(struct bpf_map *map, u32 pages);
96eabe7a 564void *bpf_map_area_alloc(size_t size, int numa_node);
d407bd25 565void bpf_map_area_free(void *base);
bd475643 566void bpf_map_init_from_attr(struct bpf_map *map, union bpf_attr *attr);
61e021f3 567
1be7f75d 568extern int sysctl_unprivileged_bpf_disabled;
492ecee8 569extern int sysctl_bpf_stats_enabled;
1be7f75d 570
6e71b04a 571int bpf_map_new_fd(struct bpf_map *map, int flags);
b2197755
DB
572int bpf_prog_new_fd(struct bpf_prog *prog);
573
574int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
6e71b04a 575int bpf_obj_get_user(const char __user *pathname, int flags);
b2197755 576
15a07b33
AS
577int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value);
578int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value);
579int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
580 u64 flags);
581int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
582 u64 flags);
d056a788 583
557c0c6e 584int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value);
15a07b33 585
d056a788
DB
586int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
587 void *key, void *value, u64 map_flags);
14dc6f04 588int bpf_fd_array_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
bcc6b1b7
MKL
589int bpf_fd_htab_map_update_elem(struct bpf_map *map, struct file *map_file,
590 void *key, void *value, u64 map_flags);
14dc6f04 591int bpf_fd_htab_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
d056a788 592
6e71b04a 593int bpf_get_file_flag(int flags);
dcab51f1
MKL
594int bpf_check_uarg_tail_zero(void __user *uaddr, size_t expected_size,
595 size_t actual_size);
6e71b04a 596
15a07b33
AS
597/* memcpy that is used with 8-byte aligned pointers, power-of-8 size and
598 * forced to use 'long' read/writes to try to atomically copy long counters.
599 * Best-effort only. No barriers here, since it _will_ race with concurrent
600 * updates from BPF programs. Called from bpf syscall and mostly used with
601 * size 8 or 16 bytes, so ask compiler to inline it.
602 */
603static inline void bpf_long_memcpy(void *dst, const void *src, u32 size)
604{
605 const long *lsrc = src;
606 long *ldst = dst;
607
608 size /= sizeof(long);
609 while (size--)
610 *ldst++ = *lsrc++;
611}
612
61e021f3 613/* verify correctness of eBPF program */
838e9690
YS
614int bpf_check(struct bpf_prog **fp, union bpf_attr *attr,
615 union bpf_attr __user *uattr);
1ea47e01 616void bpf_patch_call_args(struct bpf_insn *insn, u32 stack_depth);
46f55cff
JF
617
618/* Map specifics */
67f29e07 619struct xdp_buff;
6d5fc195 620struct sk_buff;
67f29e07
JDB
621
622struct bpf_dtab_netdev *__dev_map_lookup_elem(struct bpf_map *map, u32 key);
46f55cff
JF
623void __dev_map_insert_ctx(struct bpf_map *map, u32 index);
624void __dev_map_flush(struct bpf_map *map);
38edddb8
JDB
625int dev_map_enqueue(struct bpf_dtab_netdev *dst, struct xdp_buff *xdp,
626 struct net_device *dev_rx);
6d5fc195
TM
627int dev_map_generic_redirect(struct bpf_dtab_netdev *dst, struct sk_buff *skb,
628 struct bpf_prog *xdp_prog);
46f55cff 629
9c270af3
JDB
630struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key);
631void __cpu_map_insert_ctx(struct bpf_map *map, u32 index);
632void __cpu_map_flush(struct bpf_map *map);
9c270af3
JDB
633int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu, struct xdp_buff *xdp,
634 struct net_device *dev_rx);
635
96eabe7a
MKL
636/* Return map's numa specified by userspace */
637static inline int bpf_map_attr_numa_node(const union bpf_attr *attr)
638{
639 return (attr->map_flags & BPF_F_NUMA_NODE) ?
640 attr->numa_node : NUMA_NO_NODE;
641}
642
040ee692 643struct bpf_prog *bpf_prog_get_type_path(const char *name, enum bpf_prog_type type);
5dc4c4b7 644int array_map_alloc_check(union bpf_attr *attr);
040ee692 645
9c270af3 646#else /* !CONFIG_BPF_SYSCALL */
0fc174de
DB
647static inline struct bpf_prog *bpf_prog_get(u32 ufd)
648{
649 return ERR_PTR(-EOPNOTSUPP);
650}
651
248f346f
JK
652static inline struct bpf_prog *bpf_prog_get_type_dev(u32 ufd,
653 enum bpf_prog_type type,
288b3de5 654 bool attach_drv)
248f346f
JK
655{
656 return ERR_PTR(-EOPNOTSUPP);
657}
658
6d67942d
DB
659static inline struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog,
660 int i)
cc2e0b3f
BB
661{
662 return ERR_PTR(-EOPNOTSUPP);
663}
113214be 664
c540594f
DB
665static inline void bpf_prog_sub(struct bpf_prog *prog, int i)
666{
667}
668
0fc174de
DB
669static inline void bpf_prog_put(struct bpf_prog *prog)
670{
671}
6d67942d
DB
672
673static inline struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog)
aa6a5f3c
AS
674{
675 return ERR_PTR(-EOPNOTSUPP);
676}
5ccb071e 677
a6f6df69
JF
678static inline struct bpf_prog *__must_check
679bpf_prog_inc_not_zero(struct bpf_prog *prog)
680{
681 return ERR_PTR(-EOPNOTSUPP);
682}
683
5ccb071e
DB
684static inline int __bpf_prog_charge(struct user_struct *user, u32 pages)
685{
686 return 0;
687}
688
689static inline void __bpf_prog_uncharge(struct user_struct *user, u32 pages)
690{
691}
46f55cff 692
6e71b04a 693static inline int bpf_obj_get_user(const char __user *pathname, int flags)
98589a09
SL
694{
695 return -EOPNOTSUPP;
696}
697
46f55cff
JF
698static inline struct net_device *__dev_map_lookup_elem(struct bpf_map *map,
699 u32 key)
700{
701 return NULL;
702}
703
704static inline void __dev_map_insert_ctx(struct bpf_map *map, u32 index)
705{
706}
707
708static inline void __dev_map_flush(struct bpf_map *map)
709{
710}
9c270af3 711
67f29e07
JDB
712struct xdp_buff;
713struct bpf_dtab_netdev;
714
715static inline
38edddb8
JDB
716int dev_map_enqueue(struct bpf_dtab_netdev *dst, struct xdp_buff *xdp,
717 struct net_device *dev_rx)
67f29e07
JDB
718{
719 return 0;
720}
721
6d5fc195
TM
722struct sk_buff;
723
724static inline int dev_map_generic_redirect(struct bpf_dtab_netdev *dst,
725 struct sk_buff *skb,
726 struct bpf_prog *xdp_prog)
727{
728 return 0;
729}
730
9c270af3
JDB
731static inline
732struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key)
733{
734 return NULL;
735}
736
737static inline void __cpu_map_insert_ctx(struct bpf_map *map, u32 index)
738{
739}
740
741static inline void __cpu_map_flush(struct bpf_map *map)
742{
743}
744
9c270af3
JDB
745static inline int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu,
746 struct xdp_buff *xdp,
747 struct net_device *dev_rx)
748{
749 return 0;
750}
040ee692
AV
751
752static inline struct bpf_prog *bpf_prog_get_type_path(const char *name,
753 enum bpf_prog_type type)
754{
755 return ERR_PTR(-EOPNOTSUPP);
756}
61e021f3 757#endif /* CONFIG_BPF_SYSCALL */
09756af4 758
479321e9
JK
759static inline struct bpf_prog *bpf_prog_get_type(u32 ufd,
760 enum bpf_prog_type type)
761{
762 return bpf_prog_get_type_dev(ufd, type, false);
763}
764
040ee692
AV
765bool bpf_prog_get_ok(struct bpf_prog *, enum bpf_prog_type *, bool);
766
ab3f0063
JK
767int bpf_prog_offload_compile(struct bpf_prog *prog);
768void bpf_prog_offload_destroy(struct bpf_prog *prog);
675fc275
JK
769int bpf_prog_offload_info_fill(struct bpf_prog_info *info,
770 struct bpf_prog *prog);
ab3f0063 771
52775b33
JK
772int bpf_map_offload_info_fill(struct bpf_map_info *info, struct bpf_map *map);
773
a3884572
JK
774int bpf_map_offload_lookup_elem(struct bpf_map *map, void *key, void *value);
775int bpf_map_offload_update_elem(struct bpf_map *map,
776 void *key, void *value, u64 flags);
777int bpf_map_offload_delete_elem(struct bpf_map *map, void *key);
778int bpf_map_offload_get_next_key(struct bpf_map *map,
779 void *key, void *next_key);
780
09728266 781bool bpf_offload_prog_map_match(struct bpf_prog *prog, struct bpf_map *map);
a3884572 782
1385d755 783struct bpf_offload_dev *
dd27c2e3 784bpf_offload_dev_create(const struct bpf_prog_offload_ops *ops, void *priv);
602144c2 785void bpf_offload_dev_destroy(struct bpf_offload_dev *offdev);
dd27c2e3 786void *bpf_offload_dev_priv(struct bpf_offload_dev *offdev);
602144c2
JK
787int bpf_offload_dev_netdev_register(struct bpf_offload_dev *offdev,
788 struct net_device *netdev);
789void bpf_offload_dev_netdev_unregister(struct bpf_offload_dev *offdev,
790 struct net_device *netdev);
fd4f227d 791bool bpf_offload_dev_match(struct bpf_prog *prog, struct net_device *netdev);
9fd7c555 792
ab3f0063
JK
793#if defined(CONFIG_NET) && defined(CONFIG_BPF_SYSCALL)
794int bpf_prog_offload_init(struct bpf_prog *prog, union bpf_attr *attr);
795
0d830032 796static inline bool bpf_prog_is_dev_bound(const struct bpf_prog_aux *aux)
ab3f0063 797{
9a18eedb 798 return aux->offload_requested;
ab3f0063 799}
a3884572
JK
800
801static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
802{
803 return unlikely(map->ops == &bpf_map_offload_ops);
804}
805
806struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr);
807void bpf_map_offload_map_free(struct bpf_map *map);
ab3f0063
JK
808#else
809static inline int bpf_prog_offload_init(struct bpf_prog *prog,
810 union bpf_attr *attr)
811{
812 return -EOPNOTSUPP;
813}
814
815static inline bool bpf_prog_is_dev_bound(struct bpf_prog_aux *aux)
816{
817 return false;
818}
a3884572
JK
819
820static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
821{
822 return false;
823}
824
825static inline struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr)
826{
827 return ERR_PTR(-EOPNOTSUPP);
828}
829
830static inline void bpf_map_offload_map_free(struct bpf_map *map)
831{
832}
ab3f0063
JK
833#endif /* CONFIG_NET && CONFIG_BPF_SYSCALL */
834
604326b4
DB
835#if defined(CONFIG_BPF_STREAM_PARSER)
836int sock_map_prog_update(struct bpf_map *map, struct bpf_prog *prog, u32 which);
837int sock_map_get_from_fd(const union bpf_attr *attr, struct bpf_prog *prog);
6bdc9c4c 838#else
604326b4
DB
839static inline int sock_map_prog_update(struct bpf_map *map,
840 struct bpf_prog *prog, u32 which)
464bc0fd
JF
841{
842 return -EOPNOTSUPP;
843}
fdb5c453 844
604326b4
DB
845static inline int sock_map_get_from_fd(const union bpf_attr *attr,
846 struct bpf_prog *prog)
fdb5c453
SY
847{
848 return -EINVAL;
849}
6bdc9c4c
JF
850#endif
851
fbfc504a
BT
852#if defined(CONFIG_XDP_SOCKETS)
853struct xdp_sock;
854struct xdp_sock *__xsk_map_lookup_elem(struct bpf_map *map, u32 key);
855int __xsk_map_redirect(struct bpf_map *map, struct xdp_buff *xdp,
856 struct xdp_sock *xs);
857void __xsk_map_flush(struct bpf_map *map);
858#else
859struct xdp_sock;
860static inline struct xdp_sock *__xsk_map_lookup_elem(struct bpf_map *map,
861 u32 key)
862{
863 return NULL;
864}
865
866static inline int __xsk_map_redirect(struct bpf_map *map, struct xdp_buff *xdp,
867 struct xdp_sock *xs)
868{
869 return -EOPNOTSUPP;
870}
871
872static inline void __xsk_map_flush(struct bpf_map *map)
873{
874}
875#endif
876
5dc4c4b7
MKL
877#if defined(CONFIG_INET) && defined(CONFIG_BPF_SYSCALL)
878void bpf_sk_reuseport_detach(struct sock *sk);
879int bpf_fd_reuseport_array_lookup_elem(struct bpf_map *map, void *key,
880 void *value);
881int bpf_fd_reuseport_array_update_elem(struct bpf_map *map, void *key,
882 void *value, u64 map_flags);
883#else
884static inline void bpf_sk_reuseport_detach(struct sock *sk)
885{
886}
887
888#ifdef CONFIG_BPF_SYSCALL
889static inline int bpf_fd_reuseport_array_lookup_elem(struct bpf_map *map,
890 void *key, void *value)
891{
892 return -EOPNOTSUPP;
893}
894
895static inline int bpf_fd_reuseport_array_update_elem(struct bpf_map *map,
896 void *key, void *value,
897 u64 map_flags)
898{
899 return -EOPNOTSUPP;
900}
901#endif /* CONFIG_BPF_SYSCALL */
902#endif /* defined(CONFIG_INET) && defined(CONFIG_BPF_SYSCALL) */
903
d0003ec0 904/* verifier prototypes for helper functions called from eBPF programs */
a2c83fff
DB
905extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
906extern const struct bpf_func_proto bpf_map_update_elem_proto;
907extern const struct bpf_func_proto bpf_map_delete_elem_proto;
f1a2e44a
MV
908extern const struct bpf_func_proto bpf_map_push_elem_proto;
909extern const struct bpf_func_proto bpf_map_pop_elem_proto;
910extern const struct bpf_func_proto bpf_map_peek_elem_proto;
d0003ec0 911
03e69b50 912extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
c04167ce 913extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
2d0e30c3 914extern const struct bpf_func_proto bpf_get_numa_node_id_proto;
04fd61ab 915extern const struct bpf_func_proto bpf_tail_call_proto;
17ca8cbf 916extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
ffeedafb
AS
917extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
918extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
919extern const struct bpf_func_proto bpf_get_current_comm_proto;
d5a3b1f6 920extern const struct bpf_func_proto bpf_get_stackid_proto;
c195651e 921extern const struct bpf_func_proto bpf_get_stack_proto;
174a79ff 922extern const struct bpf_func_proto bpf_sock_map_update_proto;
81110384 923extern const struct bpf_func_proto bpf_sock_hash_update_proto;
bf6fa2c8 924extern const struct bpf_func_proto bpf_get_current_cgroup_id_proto;
604326b4
DB
925extern const struct bpf_func_proto bpf_msg_redirect_hash_proto;
926extern const struct bpf_func_proto bpf_msg_redirect_map_proto;
927extern const struct bpf_func_proto bpf_sk_redirect_hash_proto;
928extern const struct bpf_func_proto bpf_sk_redirect_map_proto;
d83525ca
AS
929extern const struct bpf_func_proto bpf_spin_lock_proto;
930extern const struct bpf_func_proto bpf_spin_unlock_proto;
cd339431
RG
931extern const struct bpf_func_proto bpf_get_local_storage_proto;
932
3ad00405
DB
933/* Shared helpers among cBPF and eBPF. */
934void bpf_user_rnd_init_once(void);
935u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
936
c64b7983 937#if defined(CONFIG_NET)
46f8bc92
MKL
938bool bpf_sock_common_is_valid_access(int off, int size,
939 enum bpf_access_type type,
940 struct bpf_insn_access_aux *info);
c64b7983
JS
941bool bpf_sock_is_valid_access(int off, int size, enum bpf_access_type type,
942 struct bpf_insn_access_aux *info);
943u32 bpf_sock_convert_ctx_access(enum bpf_access_type type,
944 const struct bpf_insn *si,
945 struct bpf_insn *insn_buf,
946 struct bpf_prog *prog,
947 u32 *target_size);
948#else
46f8bc92
MKL
949static inline bool bpf_sock_common_is_valid_access(int off, int size,
950 enum bpf_access_type type,
951 struct bpf_insn_access_aux *info)
952{
953 return false;
954}
c64b7983
JS
955static inline bool bpf_sock_is_valid_access(int off, int size,
956 enum bpf_access_type type,
957 struct bpf_insn_access_aux *info)
958{
959 return false;
960}
961static inline u32 bpf_sock_convert_ctx_access(enum bpf_access_type type,
962 const struct bpf_insn *si,
963 struct bpf_insn *insn_buf,
964 struct bpf_prog *prog,
965 u32 *target_size)
966{
967 return 0;
968}
969#endif
970
655a51e5
MKL
971#ifdef CONFIG_INET
972bool bpf_tcp_sock_is_valid_access(int off, int size, enum bpf_access_type type,
973 struct bpf_insn_access_aux *info);
974
975u32 bpf_tcp_sock_convert_ctx_access(enum bpf_access_type type,
976 const struct bpf_insn *si,
977 struct bpf_insn *insn_buf,
978 struct bpf_prog *prog,
979 u32 *target_size);
980#else
981static inline bool bpf_tcp_sock_is_valid_access(int off, int size,
982 enum bpf_access_type type,
983 struct bpf_insn_access_aux *info)
984{
985 return false;
986}
987
988static inline u32 bpf_tcp_sock_convert_ctx_access(enum bpf_access_type type,
989 const struct bpf_insn *si,
990 struct bpf_insn *insn_buf,
991 struct bpf_prog *prog,
992 u32 *target_size)
993{
994 return 0;
995}
996#endif /* CONFIG_INET */
997
99c55f7d 998#endif /* _LINUX_BPF_H */