xref: /linux-6.15/include/linux/bpf.h (revision d261ea23)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
3  */
4 #ifndef _LINUX_BPF_H
5 #define _LINUX_BPF_H 1
6 
7 #include <uapi/linux/bpf.h>
8 
9 #include <linux/workqueue.h>
10 #include <linux/file.h>
11 #include <linux/percpu.h>
12 #include <linux/err.h>
13 #include <linux/rbtree_latch.h>
14 #include <linux/numa.h>
15 #include <linux/mm_types.h>
16 #include <linux/wait.h>
17 #include <linux/refcount.h>
18 #include <linux/mutex.h>
19 #include <linux/module.h>
20 #include <linux/kallsyms.h>
21 #include <linux/capability.h>
22 #include <linux/sched/mm.h>
23 #include <linux/slab.h>
24 #include <linux/percpu-refcount.h>
25 #include <linux/bpfptr.h>
26 #include <linux/btf.h>
27 
28 struct bpf_verifier_env;
29 struct bpf_verifier_log;
30 struct perf_event;
31 struct bpf_prog;
32 struct bpf_prog_aux;
33 struct bpf_map;
34 struct sock;
35 struct seq_file;
36 struct btf;
37 struct btf_type;
38 struct exception_table_entry;
39 struct seq_operations;
40 struct bpf_iter_aux_info;
41 struct bpf_local_storage;
42 struct bpf_local_storage_map;
43 struct kobject;
44 struct mem_cgroup;
45 struct module;
46 struct bpf_func_state;
47 
48 extern struct idr btf_idr;
49 extern spinlock_t btf_idr_lock;
50 extern struct kobject *btf_kobj;
51 
52 typedef u64 (*bpf_callback_t)(u64, u64, u64, u64, u64);
53 typedef int (*bpf_iter_init_seq_priv_t)(void *private_data,
54 					struct bpf_iter_aux_info *aux);
55 typedef void (*bpf_iter_fini_seq_priv_t)(void *private_data);
56 struct bpf_iter_seq_info {
57 	const struct seq_operations *seq_ops;
58 	bpf_iter_init_seq_priv_t init_seq_private;
59 	bpf_iter_fini_seq_priv_t fini_seq_private;
60 	u32 seq_priv_size;
61 };
62 
63 /* map is generic key/value storage optionally accessible by eBPF programs */
64 struct bpf_map_ops {
65 	/* funcs callable from userspace (via syscall) */
66 	int (*map_alloc_check)(union bpf_attr *attr);
67 	struct bpf_map *(*map_alloc)(union bpf_attr *attr);
68 	void (*map_release)(struct bpf_map *map, struct file *map_file);
69 	void (*map_free)(struct bpf_map *map);
70 	int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key);
71 	void (*map_release_uref)(struct bpf_map *map);
72 	void *(*map_lookup_elem_sys_only)(struct bpf_map *map, void *key);
73 	int (*map_lookup_batch)(struct bpf_map *map, const union bpf_attr *attr,
74 				union bpf_attr __user *uattr);
75 	int (*map_lookup_and_delete_elem)(struct bpf_map *map, void *key,
76 					  void *value, u64 flags);
77 	int (*map_lookup_and_delete_batch)(struct bpf_map *map,
78 					   const union bpf_attr *attr,
79 					   union bpf_attr __user *uattr);
80 	int (*map_update_batch)(struct bpf_map *map, const union bpf_attr *attr,
81 				union bpf_attr __user *uattr);
82 	int (*map_delete_batch)(struct bpf_map *map, const union bpf_attr *attr,
83 				union bpf_attr __user *uattr);
84 
85 	/* funcs callable from userspace and from eBPF programs */
86 	void *(*map_lookup_elem)(struct bpf_map *map, void *key);
87 	int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags);
88 	int (*map_delete_elem)(struct bpf_map *map, void *key);
89 	int (*map_push_elem)(struct bpf_map *map, void *value, u64 flags);
90 	int (*map_pop_elem)(struct bpf_map *map, void *value);
91 	int (*map_peek_elem)(struct bpf_map *map, void *value);
92 	void *(*map_lookup_percpu_elem)(struct bpf_map *map, void *key, u32 cpu);
93 
94 	/* funcs called by prog_array and perf_event_array map */
95 	void *(*map_fd_get_ptr)(struct bpf_map *map, struct file *map_file,
96 				int fd);
97 	void (*map_fd_put_ptr)(void *ptr);
98 	int (*map_gen_lookup)(struct bpf_map *map, struct bpf_insn *insn_buf);
99 	u32 (*map_fd_sys_lookup_elem)(void *ptr);
100 	void (*map_seq_show_elem)(struct bpf_map *map, void *key,
101 				  struct seq_file *m);
102 	int (*map_check_btf)(const struct bpf_map *map,
103 			     const struct btf *btf,
104 			     const struct btf_type *key_type,
105 			     const struct btf_type *value_type);
106 
107 	/* Prog poke tracking helpers. */
108 	int (*map_poke_track)(struct bpf_map *map, struct bpf_prog_aux *aux);
109 	void (*map_poke_untrack)(struct bpf_map *map, struct bpf_prog_aux *aux);
110 	void (*map_poke_run)(struct bpf_map *map, u32 key, struct bpf_prog *old,
111 			     struct bpf_prog *new);
112 
113 	/* Direct value access helpers. */
114 	int (*map_direct_value_addr)(const struct bpf_map *map,
115 				     u64 *imm, u32 off);
116 	int (*map_direct_value_meta)(const struct bpf_map *map,
117 				     u64 imm, u32 *off);
118 	int (*map_mmap)(struct bpf_map *map, struct vm_area_struct *vma);
119 	__poll_t (*map_poll)(struct bpf_map *map, struct file *filp,
120 			     struct poll_table_struct *pts);
121 
122 	/* Functions called by bpf_local_storage maps */
123 	int (*map_local_storage_charge)(struct bpf_local_storage_map *smap,
124 					void *owner, u32 size);
125 	void (*map_local_storage_uncharge)(struct bpf_local_storage_map *smap,
126 					   void *owner, u32 size);
127 	struct bpf_local_storage __rcu ** (*map_owner_storage_ptr)(void *owner);
128 
129 	/* Misc helpers.*/
130 	int (*map_redirect)(struct bpf_map *map, u32 ifindex, u64 flags);
131 
132 	/* map_meta_equal must be implemented for maps that can be
133 	 * used as an inner map.  It is a runtime check to ensure
134 	 * an inner map can be inserted to an outer map.
135 	 *
136 	 * Some properties of the inner map has been used during the
137 	 * verification time.  When inserting an inner map at the runtime,
138 	 * map_meta_equal has to ensure the inserting map has the same
139 	 * properties that the verifier has used earlier.
140 	 */
141 	bool (*map_meta_equal)(const struct bpf_map *meta0,
142 			       const struct bpf_map *meta1);
143 
144 
145 	int (*map_set_for_each_callback_args)(struct bpf_verifier_env *env,
146 					      struct bpf_func_state *caller,
147 					      struct bpf_func_state *callee);
148 	int (*map_for_each_callback)(struct bpf_map *map,
149 				     bpf_callback_t callback_fn,
150 				     void *callback_ctx, u64 flags);
151 
152 	/* BTF id of struct allocated by map_alloc */
153 	int *map_btf_id;
154 
155 	/* bpf_iter info used to open a seq_file */
156 	const struct bpf_iter_seq_info *iter_seq_info;
157 };
158 
159 enum {
160 	/* Support at most 8 pointers in a BPF map value */
161 	BPF_MAP_VALUE_OFF_MAX = 8,
162 	BPF_MAP_OFF_ARR_MAX   = BPF_MAP_VALUE_OFF_MAX +
163 				1 + /* for bpf_spin_lock */
164 				1,  /* for bpf_timer */
165 };
166 
167 enum bpf_kptr_type {
168 	BPF_KPTR_UNREF,
169 	BPF_KPTR_REF,
170 };
171 
172 struct bpf_map_value_off_desc {
173 	u32 offset;
174 	enum bpf_kptr_type type;
175 	struct {
176 		struct btf *btf;
177 		struct module *module;
178 		btf_dtor_kfunc_t dtor;
179 		u32 btf_id;
180 	} kptr;
181 };
182 
183 struct bpf_map_value_off {
184 	u32 nr_off;
185 	struct bpf_map_value_off_desc off[];
186 };
187 
188 struct bpf_map_off_arr {
189 	u32 cnt;
190 	u32 field_off[BPF_MAP_OFF_ARR_MAX];
191 	u8 field_sz[BPF_MAP_OFF_ARR_MAX];
192 };
193 
194 struct bpf_map {
195 	/* The first two cachelines with read-mostly members of which some
196 	 * are also accessed in fast-path (e.g. ops, max_entries).
197 	 */
198 	const struct bpf_map_ops *ops ____cacheline_aligned;
199 	struct bpf_map *inner_map_meta;
200 #ifdef CONFIG_SECURITY
201 	void *security;
202 #endif
203 	enum bpf_map_type map_type;
204 	u32 key_size;
205 	u32 value_size;
206 	u32 max_entries;
207 	u64 map_extra; /* any per-map-type extra fields */
208 	u32 map_flags;
209 	int spin_lock_off; /* >=0 valid offset, <0 error */
210 	struct bpf_map_value_off *kptr_off_tab;
211 	int timer_off; /* >=0 valid offset, <0 error */
212 	u32 id;
213 	int numa_node;
214 	u32 btf_key_type_id;
215 	u32 btf_value_type_id;
216 	u32 btf_vmlinux_value_type_id;
217 	struct btf *btf;
218 #ifdef CONFIG_MEMCG_KMEM
219 	struct mem_cgroup *memcg;
220 #endif
221 	char name[BPF_OBJ_NAME_LEN];
222 	struct bpf_map_off_arr *off_arr;
223 	/* The 3rd and 4th cacheline with misc members to avoid false sharing
224 	 * particularly with refcounting.
225 	 */
226 	atomic64_t refcnt ____cacheline_aligned;
227 	atomic64_t usercnt;
228 	struct work_struct work;
229 	struct mutex freeze_mutex;
230 	atomic64_t writecnt;
231 	/* 'Ownership' of program-containing map is claimed by the first program
232 	 * that is going to use this map or by the first program which FD is
233 	 * stored in the map to make sure that all callers and callees have the
234 	 * same prog type, JITed flag and xdp_has_frags flag.
235 	 */
236 	struct {
237 		spinlock_t lock;
238 		enum bpf_prog_type type;
239 		bool jited;
240 		bool xdp_has_frags;
241 	} owner;
242 	bool bypass_spec_v1;
243 	bool frozen; /* write-once; write-protected by freeze_mutex */
244 };
245 
246 static inline bool map_value_has_spin_lock(const struct bpf_map *map)
247 {
248 	return map->spin_lock_off >= 0;
249 }
250 
251 static inline bool map_value_has_timer(const struct bpf_map *map)
252 {
253 	return map->timer_off >= 0;
254 }
255 
256 static inline bool map_value_has_kptrs(const struct bpf_map *map)
257 {
258 	return !IS_ERR_OR_NULL(map->kptr_off_tab);
259 }
260 
261 static inline void check_and_init_map_value(struct bpf_map *map, void *dst)
262 {
263 	if (unlikely(map_value_has_spin_lock(map)))
264 		memset(dst + map->spin_lock_off, 0, sizeof(struct bpf_spin_lock));
265 	if (unlikely(map_value_has_timer(map)))
266 		memset(dst + map->timer_off, 0, sizeof(struct bpf_timer));
267 	if (unlikely(map_value_has_kptrs(map))) {
268 		struct bpf_map_value_off *tab = map->kptr_off_tab;
269 		int i;
270 
271 		for (i = 0; i < tab->nr_off; i++)
272 			*(u64 *)(dst + tab->off[i].offset) = 0;
273 	}
274 }
275 
276 /* copy everything but bpf_spin_lock and bpf_timer. There could be one of each. */
277 static inline void copy_map_value(struct bpf_map *map, void *dst, void *src)
278 {
279 	u32 curr_off = 0;
280 	int i;
281 
282 	if (likely(!map->off_arr)) {
283 		memcpy(dst, src, map->value_size);
284 		return;
285 	}
286 
287 	for (i = 0; i < map->off_arr->cnt; i++) {
288 		u32 next_off = map->off_arr->field_off[i];
289 
290 		memcpy(dst + curr_off, src + curr_off, next_off - curr_off);
291 		curr_off += map->off_arr->field_sz[i];
292 	}
293 	memcpy(dst + curr_off, src + curr_off, map->value_size - curr_off);
294 }
295 void copy_map_value_locked(struct bpf_map *map, void *dst, void *src,
296 			   bool lock_src);
297 void bpf_timer_cancel_and_free(void *timer);
298 int bpf_obj_name_cpy(char *dst, const char *src, unsigned int size);
299 
300 struct bpf_offload_dev;
301 struct bpf_offloaded_map;
302 
303 struct bpf_map_dev_ops {
304 	int (*map_get_next_key)(struct bpf_offloaded_map *map,
305 				void *key, void *next_key);
306 	int (*map_lookup_elem)(struct bpf_offloaded_map *map,
307 			       void *key, void *value);
308 	int (*map_update_elem)(struct bpf_offloaded_map *map,
309 			       void *key, void *value, u64 flags);
310 	int (*map_delete_elem)(struct bpf_offloaded_map *map, void *key);
311 };
312 
313 struct bpf_offloaded_map {
314 	struct bpf_map map;
315 	struct net_device *netdev;
316 	const struct bpf_map_dev_ops *dev_ops;
317 	void *dev_priv;
318 	struct list_head offloads;
319 };
320 
321 static inline struct bpf_offloaded_map *map_to_offmap(struct bpf_map *map)
322 {
323 	return container_of(map, struct bpf_offloaded_map, map);
324 }
325 
326 static inline bool bpf_map_offload_neutral(const struct bpf_map *map)
327 {
328 	return map->map_type == BPF_MAP_TYPE_PERF_EVENT_ARRAY;
329 }
330 
331 static inline bool bpf_map_support_seq_show(const struct bpf_map *map)
332 {
333 	return (map->btf_value_type_id || map->btf_vmlinux_value_type_id) &&
334 		map->ops->map_seq_show_elem;
335 }
336 
337 int map_check_no_btf(const struct bpf_map *map,
338 		     const struct btf *btf,
339 		     const struct btf_type *key_type,
340 		     const struct btf_type *value_type);
341 
342 bool bpf_map_meta_equal(const struct bpf_map *meta0,
343 			const struct bpf_map *meta1);
344 
345 extern const struct bpf_map_ops bpf_map_offload_ops;
346 
347 /* bpf_type_flag contains a set of flags that are applicable to the values of
348  * arg_type, ret_type and reg_type. For example, a pointer value may be null,
349  * or a memory is read-only. We classify types into two categories: base types
350  * and extended types. Extended types are base types combined with a type flag.
351  *
352  * Currently there are no more than 32 base types in arg_type, ret_type and
353  * reg_types.
354  */
355 #define BPF_BASE_TYPE_BITS	8
356 
357 enum bpf_type_flag {
358 	/* PTR may be NULL. */
359 	PTR_MAYBE_NULL		= BIT(0 + BPF_BASE_TYPE_BITS),
360 
361 	/* MEM is read-only. When applied on bpf_arg, it indicates the arg is
362 	 * compatible with both mutable and immutable memory.
363 	 */
364 	MEM_RDONLY		= BIT(1 + BPF_BASE_TYPE_BITS),
365 
366 	/* MEM was "allocated" from a different helper, and cannot be mixed
367 	 * with regular non-MEM_ALLOC'ed MEM types.
368 	 */
369 	MEM_ALLOC		= BIT(2 + BPF_BASE_TYPE_BITS),
370 
371 	/* MEM is in user address space. */
372 	MEM_USER		= BIT(3 + BPF_BASE_TYPE_BITS),
373 
374 	/* MEM is a percpu memory. MEM_PERCPU tags PTR_TO_BTF_ID. When tagged
375 	 * with MEM_PERCPU, PTR_TO_BTF_ID _cannot_ be directly accessed. In
376 	 * order to drop this tag, it must be passed into bpf_per_cpu_ptr()
377 	 * or bpf_this_cpu_ptr(), which will return the pointer corresponding
378 	 * to the specified cpu.
379 	 */
380 	MEM_PERCPU		= BIT(4 + BPF_BASE_TYPE_BITS),
381 
382 	/* Indicates that the argument will be released. */
383 	OBJ_RELEASE		= BIT(5 + BPF_BASE_TYPE_BITS),
384 
385 	/* PTR is not trusted. This is only used with PTR_TO_BTF_ID, to mark
386 	 * unreferenced and referenced kptr loaded from map value using a load
387 	 * instruction, so that they can only be dereferenced but not escape the
388 	 * BPF program into the kernel (i.e. cannot be passed as arguments to
389 	 * kfunc or bpf helpers).
390 	 */
391 	PTR_UNTRUSTED		= BIT(6 + BPF_BASE_TYPE_BITS),
392 
393 	MEM_UNINIT		= BIT(7 + BPF_BASE_TYPE_BITS),
394 
395 	/* DYNPTR points to memory local to the bpf program. */
396 	DYNPTR_TYPE_LOCAL	= BIT(8 + BPF_BASE_TYPE_BITS),
397 
398 	/* DYNPTR points to a ringbuf record. */
399 	DYNPTR_TYPE_RINGBUF	= BIT(9 + BPF_BASE_TYPE_BITS),
400 
401 	__BPF_TYPE_FLAG_MAX,
402 	__BPF_TYPE_LAST_FLAG	= __BPF_TYPE_FLAG_MAX - 1,
403 };
404 
405 #define DYNPTR_TYPE_FLAG_MASK	(DYNPTR_TYPE_LOCAL | DYNPTR_TYPE_RINGBUF)
406 
407 /* Max number of base types. */
408 #define BPF_BASE_TYPE_LIMIT	(1UL << BPF_BASE_TYPE_BITS)
409 
410 /* Max number of all types. */
411 #define BPF_TYPE_LIMIT		(__BPF_TYPE_LAST_FLAG | (__BPF_TYPE_LAST_FLAG - 1))
412 
413 /* function argument constraints */
414 enum bpf_arg_type {
415 	ARG_DONTCARE = 0,	/* unused argument in helper function */
416 
417 	/* the following constraints used to prototype
418 	 * bpf_map_lookup/update/delete_elem() functions
419 	 */
420 	ARG_CONST_MAP_PTR,	/* const argument used as pointer to bpf_map */
421 	ARG_PTR_TO_MAP_KEY,	/* pointer to stack used as map key */
422 	ARG_PTR_TO_MAP_VALUE,	/* pointer to stack used as map value */
423 
424 	/* Used to prototype bpf_memcmp() and other functions that access data
425 	 * on eBPF program stack
426 	 */
427 	ARG_PTR_TO_MEM,		/* pointer to valid memory (stack, packet, map value) */
428 
429 	ARG_CONST_SIZE,		/* number of bytes accessed from memory */
430 	ARG_CONST_SIZE_OR_ZERO,	/* number of bytes accessed from memory or 0 */
431 
432 	ARG_PTR_TO_CTX,		/* pointer to context */
433 	ARG_ANYTHING,		/* any (initialized) argument is ok */
434 	ARG_PTR_TO_SPIN_LOCK,	/* pointer to bpf_spin_lock */
435 	ARG_PTR_TO_SOCK_COMMON,	/* pointer to sock_common */
436 	ARG_PTR_TO_INT,		/* pointer to int */
437 	ARG_PTR_TO_LONG,	/* pointer to long */
438 	ARG_PTR_TO_SOCKET,	/* pointer to bpf_sock (fullsock) */
439 	ARG_PTR_TO_BTF_ID,	/* pointer to in-kernel struct */
440 	ARG_PTR_TO_ALLOC_MEM,	/* pointer to dynamically allocated memory */
441 	ARG_CONST_ALLOC_SIZE_OR_ZERO,	/* number of allocated bytes requested */
442 	ARG_PTR_TO_BTF_ID_SOCK_COMMON,	/* pointer to in-kernel sock_common or bpf-mirrored bpf_sock */
443 	ARG_PTR_TO_PERCPU_BTF_ID,	/* pointer to in-kernel percpu type */
444 	ARG_PTR_TO_FUNC,	/* pointer to a bpf program function */
445 	ARG_PTR_TO_STACK,	/* pointer to stack */
446 	ARG_PTR_TO_CONST_STR,	/* pointer to a null terminated read-only string */
447 	ARG_PTR_TO_TIMER,	/* pointer to bpf_timer */
448 	ARG_PTR_TO_KPTR,	/* pointer to referenced kptr */
449 	ARG_PTR_TO_DYNPTR,      /* pointer to bpf_dynptr. See bpf_type_flag for dynptr type */
450 	__BPF_ARG_TYPE_MAX,
451 
452 	/* Extended arg_types. */
453 	ARG_PTR_TO_MAP_VALUE_OR_NULL	= PTR_MAYBE_NULL | ARG_PTR_TO_MAP_VALUE,
454 	ARG_PTR_TO_MEM_OR_NULL		= PTR_MAYBE_NULL | ARG_PTR_TO_MEM,
455 	ARG_PTR_TO_CTX_OR_NULL		= PTR_MAYBE_NULL | ARG_PTR_TO_CTX,
456 	ARG_PTR_TO_SOCKET_OR_NULL	= PTR_MAYBE_NULL | ARG_PTR_TO_SOCKET,
457 	ARG_PTR_TO_ALLOC_MEM_OR_NULL	= PTR_MAYBE_NULL | ARG_PTR_TO_ALLOC_MEM,
458 	ARG_PTR_TO_STACK_OR_NULL	= PTR_MAYBE_NULL | ARG_PTR_TO_STACK,
459 	ARG_PTR_TO_BTF_ID_OR_NULL	= PTR_MAYBE_NULL | ARG_PTR_TO_BTF_ID,
460 	/* pointer to memory does not need to be initialized, helper function must fill
461 	 * all bytes or clear them in error case.
462 	 */
463 	ARG_PTR_TO_UNINIT_MEM		= MEM_UNINIT | ARG_PTR_TO_MEM,
464 
465 	/* This must be the last entry. Its purpose is to ensure the enum is
466 	 * wide enough to hold the higher bits reserved for bpf_type_flag.
467 	 */
468 	__BPF_ARG_TYPE_LIMIT	= BPF_TYPE_LIMIT,
469 };
470 static_assert(__BPF_ARG_TYPE_MAX <= BPF_BASE_TYPE_LIMIT);
471 
472 /* type of values returned from helper functions */
473 enum bpf_return_type {
474 	RET_INTEGER,			/* function returns integer */
475 	RET_VOID,			/* function doesn't return anything */
476 	RET_PTR_TO_MAP_VALUE,		/* returns a pointer to map elem value */
477 	RET_PTR_TO_SOCKET,		/* returns a pointer to a socket */
478 	RET_PTR_TO_TCP_SOCK,		/* returns a pointer to a tcp_sock */
479 	RET_PTR_TO_SOCK_COMMON,		/* returns a pointer to a sock_common */
480 	RET_PTR_TO_ALLOC_MEM,		/* returns a pointer to dynamically allocated memory */
481 	RET_PTR_TO_MEM_OR_BTF_ID,	/* returns a pointer to a valid memory or a btf_id */
482 	RET_PTR_TO_BTF_ID,		/* returns a pointer to a btf_id */
483 	__BPF_RET_TYPE_MAX,
484 
485 	/* Extended ret_types. */
486 	RET_PTR_TO_MAP_VALUE_OR_NULL	= PTR_MAYBE_NULL | RET_PTR_TO_MAP_VALUE,
487 	RET_PTR_TO_SOCKET_OR_NULL	= PTR_MAYBE_NULL | RET_PTR_TO_SOCKET,
488 	RET_PTR_TO_TCP_SOCK_OR_NULL	= PTR_MAYBE_NULL | RET_PTR_TO_TCP_SOCK,
489 	RET_PTR_TO_SOCK_COMMON_OR_NULL	= PTR_MAYBE_NULL | RET_PTR_TO_SOCK_COMMON,
490 	RET_PTR_TO_ALLOC_MEM_OR_NULL	= PTR_MAYBE_NULL | MEM_ALLOC | RET_PTR_TO_ALLOC_MEM,
491 	RET_PTR_TO_DYNPTR_MEM_OR_NULL	= PTR_MAYBE_NULL | RET_PTR_TO_ALLOC_MEM,
492 	RET_PTR_TO_BTF_ID_OR_NULL	= PTR_MAYBE_NULL | RET_PTR_TO_BTF_ID,
493 
494 	/* This must be the last entry. Its purpose is to ensure the enum is
495 	 * wide enough to hold the higher bits reserved for bpf_type_flag.
496 	 */
497 	__BPF_RET_TYPE_LIMIT	= BPF_TYPE_LIMIT,
498 };
499 static_assert(__BPF_RET_TYPE_MAX <= BPF_BASE_TYPE_LIMIT);
500 
501 /* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
502  * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
503  * instructions after verifying
504  */
505 struct bpf_func_proto {
506 	u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
507 	bool gpl_only;
508 	bool pkt_access;
509 	enum bpf_return_type ret_type;
510 	union {
511 		struct {
512 			enum bpf_arg_type arg1_type;
513 			enum bpf_arg_type arg2_type;
514 			enum bpf_arg_type arg3_type;
515 			enum bpf_arg_type arg4_type;
516 			enum bpf_arg_type arg5_type;
517 		};
518 		enum bpf_arg_type arg_type[5];
519 	};
520 	union {
521 		struct {
522 			u32 *arg1_btf_id;
523 			u32 *arg2_btf_id;
524 			u32 *arg3_btf_id;
525 			u32 *arg4_btf_id;
526 			u32 *arg5_btf_id;
527 		};
528 		u32 *arg_btf_id[5];
529 	};
530 	int *ret_btf_id; /* return value btf_id */
531 	bool (*allowed)(const struct bpf_prog *prog);
532 };
533 
534 /* bpf_context is intentionally undefined structure. Pointer to bpf_context is
535  * the first argument to eBPF programs.
536  * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
537  */
538 struct bpf_context;
539 
540 enum bpf_access_type {
541 	BPF_READ = 1,
542 	BPF_WRITE = 2
543 };
544 
545 /* types of values stored in eBPF registers */
546 /* Pointer types represent:
547  * pointer
548  * pointer + imm
549  * pointer + (u16) var
550  * pointer + (u16) var + imm
551  * if (range > 0) then [ptr, ptr + range - off) is safe to access
552  * if (id > 0) means that some 'var' was added
553  * if (off > 0) means that 'imm' was added
554  */
555 enum bpf_reg_type {
556 	NOT_INIT = 0,		 /* nothing was written into register */
557 	SCALAR_VALUE,		 /* reg doesn't contain a valid pointer */
558 	PTR_TO_CTX,		 /* reg points to bpf_context */
559 	CONST_PTR_TO_MAP,	 /* reg points to struct bpf_map */
560 	PTR_TO_MAP_VALUE,	 /* reg points to map element value */
561 	PTR_TO_MAP_KEY,		 /* reg points to a map element key */
562 	PTR_TO_STACK,		 /* reg == frame_pointer + offset */
563 	PTR_TO_PACKET_META,	 /* skb->data - meta_len */
564 	PTR_TO_PACKET,		 /* reg points to skb->data */
565 	PTR_TO_PACKET_END,	 /* skb->data + headlen */
566 	PTR_TO_FLOW_KEYS,	 /* reg points to bpf_flow_keys */
567 	PTR_TO_SOCKET,		 /* reg points to struct bpf_sock */
568 	PTR_TO_SOCK_COMMON,	 /* reg points to sock_common */
569 	PTR_TO_TCP_SOCK,	 /* reg points to struct tcp_sock */
570 	PTR_TO_TP_BUFFER,	 /* reg points to a writable raw tp's buffer */
571 	PTR_TO_XDP_SOCK,	 /* reg points to struct xdp_sock */
572 	/* PTR_TO_BTF_ID points to a kernel struct that does not need
573 	 * to be null checked by the BPF program. This does not imply the
574 	 * pointer is _not_ null and in practice this can easily be a null
575 	 * pointer when reading pointer chains. The assumption is program
576 	 * context will handle null pointer dereference typically via fault
577 	 * handling. The verifier must keep this in mind and can make no
578 	 * assumptions about null or non-null when doing branch analysis.
579 	 * Further, when passed into helpers the helpers can not, without
580 	 * additional context, assume the value is non-null.
581 	 */
582 	PTR_TO_BTF_ID,
583 	/* PTR_TO_BTF_ID_OR_NULL points to a kernel struct that has not
584 	 * been checked for null. Used primarily to inform the verifier
585 	 * an explicit null check is required for this struct.
586 	 */
587 	PTR_TO_MEM,		 /* reg points to valid memory region */
588 	PTR_TO_BUF,		 /* reg points to a read/write buffer */
589 	PTR_TO_FUNC,		 /* reg points to a bpf program function */
590 	__BPF_REG_TYPE_MAX,
591 
592 	/* Extended reg_types. */
593 	PTR_TO_MAP_VALUE_OR_NULL	= PTR_MAYBE_NULL | PTR_TO_MAP_VALUE,
594 	PTR_TO_SOCKET_OR_NULL		= PTR_MAYBE_NULL | PTR_TO_SOCKET,
595 	PTR_TO_SOCK_COMMON_OR_NULL	= PTR_MAYBE_NULL | PTR_TO_SOCK_COMMON,
596 	PTR_TO_TCP_SOCK_OR_NULL		= PTR_MAYBE_NULL | PTR_TO_TCP_SOCK,
597 	PTR_TO_BTF_ID_OR_NULL		= PTR_MAYBE_NULL | PTR_TO_BTF_ID,
598 
599 	/* This must be the last entry. Its purpose is to ensure the enum is
600 	 * wide enough to hold the higher bits reserved for bpf_type_flag.
601 	 */
602 	__BPF_REG_TYPE_LIMIT	= BPF_TYPE_LIMIT,
603 };
604 static_assert(__BPF_REG_TYPE_MAX <= BPF_BASE_TYPE_LIMIT);
605 
606 /* The information passed from prog-specific *_is_valid_access
607  * back to the verifier.
608  */
609 struct bpf_insn_access_aux {
610 	enum bpf_reg_type reg_type;
611 	union {
612 		int ctx_field_size;
613 		struct {
614 			struct btf *btf;
615 			u32 btf_id;
616 		};
617 	};
618 	struct bpf_verifier_log *log; /* for verbose logs */
619 };
620 
621 static inline void
622 bpf_ctx_record_field_size(struct bpf_insn_access_aux *aux, u32 size)
623 {
624 	aux->ctx_field_size = size;
625 }
626 
627 static inline bool bpf_pseudo_func(const struct bpf_insn *insn)
628 {
629 	return insn->code == (BPF_LD | BPF_IMM | BPF_DW) &&
630 	       insn->src_reg == BPF_PSEUDO_FUNC;
631 }
632 
633 struct bpf_prog_ops {
634 	int (*test_run)(struct bpf_prog *prog, const union bpf_attr *kattr,
635 			union bpf_attr __user *uattr);
636 };
637 
638 struct bpf_verifier_ops {
639 	/* return eBPF function prototype for verification */
640 	const struct bpf_func_proto *
641 	(*get_func_proto)(enum bpf_func_id func_id,
642 			  const struct bpf_prog *prog);
643 
644 	/* return true if 'size' wide access at offset 'off' within bpf_context
645 	 * with 'type' (read or write) is allowed
646 	 */
647 	bool (*is_valid_access)(int off, int size, enum bpf_access_type type,
648 				const struct bpf_prog *prog,
649 				struct bpf_insn_access_aux *info);
650 	int (*gen_prologue)(struct bpf_insn *insn, bool direct_write,
651 			    const struct bpf_prog *prog);
652 	int (*gen_ld_abs)(const struct bpf_insn *orig,
653 			  struct bpf_insn *insn_buf);
654 	u32 (*convert_ctx_access)(enum bpf_access_type type,
655 				  const struct bpf_insn *src,
656 				  struct bpf_insn *dst,
657 				  struct bpf_prog *prog, u32 *target_size);
658 	int (*btf_struct_access)(struct bpf_verifier_log *log,
659 				 const struct btf *btf,
660 				 const struct btf_type *t, int off, int size,
661 				 enum bpf_access_type atype,
662 				 u32 *next_btf_id, enum bpf_type_flag *flag);
663 };
664 
665 struct bpf_prog_offload_ops {
666 	/* verifier basic callbacks */
667 	int (*insn_hook)(struct bpf_verifier_env *env,
668 			 int insn_idx, int prev_insn_idx);
669 	int (*finalize)(struct bpf_verifier_env *env);
670 	/* verifier optimization callbacks (called after .finalize) */
671 	int (*replace_insn)(struct bpf_verifier_env *env, u32 off,
672 			    struct bpf_insn *insn);
673 	int (*remove_insns)(struct bpf_verifier_env *env, u32 off, u32 cnt);
674 	/* program management callbacks */
675 	int (*prepare)(struct bpf_prog *prog);
676 	int (*translate)(struct bpf_prog *prog);
677 	void (*destroy)(struct bpf_prog *prog);
678 };
679 
680 struct bpf_prog_offload {
681 	struct bpf_prog		*prog;
682 	struct net_device	*netdev;
683 	struct bpf_offload_dev	*offdev;
684 	void			*dev_priv;
685 	struct list_head	offloads;
686 	bool			dev_state;
687 	bool			opt_failed;
688 	void			*jited_image;
689 	u32			jited_len;
690 };
691 
692 enum bpf_cgroup_storage_type {
693 	BPF_CGROUP_STORAGE_SHARED,
694 	BPF_CGROUP_STORAGE_PERCPU,
695 	__BPF_CGROUP_STORAGE_MAX
696 };
697 
698 #define MAX_BPF_CGROUP_STORAGE_TYPE __BPF_CGROUP_STORAGE_MAX
699 
700 /* The longest tracepoint has 12 args.
701  * See include/trace/bpf_probe.h
702  */
703 #define MAX_BPF_FUNC_ARGS 12
704 
705 /* The maximum number of arguments passed through registers
706  * a single function may have.
707  */
708 #define MAX_BPF_FUNC_REG_ARGS 5
709 
710 struct btf_func_model {
711 	u8 ret_size;
712 	u8 nr_args;
713 	u8 arg_size[MAX_BPF_FUNC_ARGS];
714 };
715 
716 /* Restore arguments before returning from trampoline to let original function
717  * continue executing. This flag is used for fentry progs when there are no
718  * fexit progs.
719  */
720 #define BPF_TRAMP_F_RESTORE_REGS	BIT(0)
721 /* Call original function after fentry progs, but before fexit progs.
722  * Makes sense for fentry/fexit, normal calls and indirect calls.
723  */
724 #define BPF_TRAMP_F_CALL_ORIG		BIT(1)
725 /* Skip current frame and return to parent.  Makes sense for fentry/fexit
726  * programs only. Should not be used with normal calls and indirect calls.
727  */
728 #define BPF_TRAMP_F_SKIP_FRAME		BIT(2)
729 /* Store IP address of the caller on the trampoline stack,
730  * so it's available for trampoline's programs.
731  */
732 #define BPF_TRAMP_F_IP_ARG		BIT(3)
733 /* Return the return value of fentry prog. Only used by bpf_struct_ops. */
734 #define BPF_TRAMP_F_RET_FENTRY_RET	BIT(4)
735 
736 /* Each call __bpf_prog_enter + call bpf_func + call __bpf_prog_exit is ~50
737  * bytes on x86.
738  */
739 #define BPF_MAX_TRAMP_LINKS 38
740 
741 struct bpf_tramp_links {
742 	struct bpf_tramp_link *links[BPF_MAX_TRAMP_LINKS];
743 	int nr_links;
744 };
745 
746 struct bpf_tramp_run_ctx;
747 
748 /* Different use cases for BPF trampoline:
749  * 1. replace nop at the function entry (kprobe equivalent)
750  *    flags = BPF_TRAMP_F_RESTORE_REGS
751  *    fentry = a set of programs to run before returning from trampoline
752  *
753  * 2. replace nop at the function entry (kprobe + kretprobe equivalent)
754  *    flags = BPF_TRAMP_F_CALL_ORIG | BPF_TRAMP_F_SKIP_FRAME
755  *    orig_call = fentry_ip + MCOUNT_INSN_SIZE
756  *    fentry = a set of program to run before calling original function
757  *    fexit = a set of program to run after original function
758  *
759  * 3. replace direct call instruction anywhere in the function body
760  *    or assign a function pointer for indirect call (like tcp_congestion_ops->cong_avoid)
761  *    With flags = 0
762  *      fentry = a set of programs to run before returning from trampoline
763  *    With flags = BPF_TRAMP_F_CALL_ORIG
764  *      orig_call = original callback addr or direct function addr
765  *      fentry = a set of program to run before calling original function
766  *      fexit = a set of program to run after original function
767  */
768 struct bpf_tramp_image;
769 int arch_prepare_bpf_trampoline(struct bpf_tramp_image *tr, void *image, void *image_end,
770 				const struct btf_func_model *m, u32 flags,
771 				struct bpf_tramp_links *tlinks,
772 				void *orig_call);
773 /* these two functions are called from generated trampoline */
774 u64 notrace __bpf_prog_enter(struct bpf_prog *prog, struct bpf_tramp_run_ctx *run_ctx);
775 void notrace __bpf_prog_exit(struct bpf_prog *prog, u64 start, struct bpf_tramp_run_ctx *run_ctx);
776 u64 notrace __bpf_prog_enter_sleepable(struct bpf_prog *prog, struct bpf_tramp_run_ctx *run_ctx);
777 void notrace __bpf_prog_exit_sleepable(struct bpf_prog *prog, u64 start,
778 				       struct bpf_tramp_run_ctx *run_ctx);
779 void notrace __bpf_tramp_enter(struct bpf_tramp_image *tr);
780 void notrace __bpf_tramp_exit(struct bpf_tramp_image *tr);
781 
782 struct bpf_ksym {
783 	unsigned long		 start;
784 	unsigned long		 end;
785 	char			 name[KSYM_NAME_LEN];
786 	struct list_head	 lnode;
787 	struct latch_tree_node	 tnode;
788 	bool			 prog;
789 };
790 
791 enum bpf_tramp_prog_type {
792 	BPF_TRAMP_FENTRY,
793 	BPF_TRAMP_FEXIT,
794 	BPF_TRAMP_MODIFY_RETURN,
795 	BPF_TRAMP_MAX,
796 	BPF_TRAMP_REPLACE, /* more than MAX */
797 };
798 
799 struct bpf_tramp_image {
800 	void *image;
801 	struct bpf_ksym ksym;
802 	struct percpu_ref pcref;
803 	void *ip_after_call;
804 	void *ip_epilogue;
805 	union {
806 		struct rcu_head rcu;
807 		struct work_struct work;
808 	};
809 };
810 
811 struct bpf_trampoline {
812 	/* hlist for trampoline_table */
813 	struct hlist_node hlist;
814 	/* serializes access to fields of this trampoline */
815 	struct mutex mutex;
816 	refcount_t refcnt;
817 	u64 key;
818 	struct {
819 		struct btf_func_model model;
820 		void *addr;
821 		bool ftrace_managed;
822 	} func;
823 	/* if !NULL this is BPF_PROG_TYPE_EXT program that extends another BPF
824 	 * program by replacing one of its functions. func.addr is the address
825 	 * of the function it replaced.
826 	 */
827 	struct bpf_prog *extension_prog;
828 	/* list of BPF programs using this trampoline */
829 	struct hlist_head progs_hlist[BPF_TRAMP_MAX];
830 	/* Number of attached programs. A counter per kind. */
831 	int progs_cnt[BPF_TRAMP_MAX];
832 	/* Executable image of trampoline */
833 	struct bpf_tramp_image *cur_image;
834 	u64 selector;
835 	struct module *mod;
836 };
837 
838 struct bpf_attach_target_info {
839 	struct btf_func_model fmodel;
840 	long tgt_addr;
841 	const char *tgt_name;
842 	const struct btf_type *tgt_type;
843 };
844 
845 #define BPF_DISPATCHER_MAX 48 /* Fits in 2048B */
846 
847 struct bpf_dispatcher_prog {
848 	struct bpf_prog *prog;
849 	refcount_t users;
850 };
851 
852 struct bpf_dispatcher {
853 	/* dispatcher mutex */
854 	struct mutex mutex;
855 	void *func;
856 	struct bpf_dispatcher_prog progs[BPF_DISPATCHER_MAX];
857 	int num_progs;
858 	void *image;
859 	u32 image_off;
860 	struct bpf_ksym ksym;
861 };
862 
863 static __always_inline __nocfi unsigned int bpf_dispatcher_nop_func(
864 	const void *ctx,
865 	const struct bpf_insn *insnsi,
866 	unsigned int (*bpf_func)(const void *,
867 				 const struct bpf_insn *))
868 {
869 	return bpf_func(ctx, insnsi);
870 }
871 
872 #ifdef CONFIG_BPF_JIT
873 int bpf_trampoline_link_prog(struct bpf_tramp_link *link, struct bpf_trampoline *tr);
874 int bpf_trampoline_unlink_prog(struct bpf_tramp_link *link, struct bpf_trampoline *tr);
875 struct bpf_trampoline *bpf_trampoline_get(u64 key,
876 					  struct bpf_attach_target_info *tgt_info);
877 void bpf_trampoline_put(struct bpf_trampoline *tr);
878 int arch_prepare_bpf_dispatcher(void *image, s64 *funcs, int num_funcs);
879 #define BPF_DISPATCHER_INIT(_name) {				\
880 	.mutex = __MUTEX_INITIALIZER(_name.mutex),		\
881 	.func = &_name##_func,					\
882 	.progs = {},						\
883 	.num_progs = 0,						\
884 	.image = NULL,						\
885 	.image_off = 0,						\
886 	.ksym = {						\
887 		.name  = #_name,				\
888 		.lnode = LIST_HEAD_INIT(_name.ksym.lnode),	\
889 	},							\
890 }
891 
892 #define DEFINE_BPF_DISPATCHER(name)					\
893 	noinline __nocfi unsigned int bpf_dispatcher_##name##_func(	\
894 		const void *ctx,					\
895 		const struct bpf_insn *insnsi,				\
896 		unsigned int (*bpf_func)(const void *,			\
897 					 const struct bpf_insn *))	\
898 	{								\
899 		return bpf_func(ctx, insnsi);				\
900 	}								\
901 	EXPORT_SYMBOL(bpf_dispatcher_##name##_func);			\
902 	struct bpf_dispatcher bpf_dispatcher_##name =			\
903 		BPF_DISPATCHER_INIT(bpf_dispatcher_##name);
904 #define DECLARE_BPF_DISPATCHER(name)					\
905 	unsigned int bpf_dispatcher_##name##_func(			\
906 		const void *ctx,					\
907 		const struct bpf_insn *insnsi,				\
908 		unsigned int (*bpf_func)(const void *,			\
909 					 const struct bpf_insn *));	\
910 	extern struct bpf_dispatcher bpf_dispatcher_##name;
911 #define BPF_DISPATCHER_FUNC(name) bpf_dispatcher_##name##_func
912 #define BPF_DISPATCHER_PTR(name) (&bpf_dispatcher_##name)
913 void bpf_dispatcher_change_prog(struct bpf_dispatcher *d, struct bpf_prog *from,
914 				struct bpf_prog *to);
915 /* Called only from JIT-enabled code, so there's no need for stubs. */
916 void *bpf_jit_alloc_exec_page(void);
917 void bpf_image_ksym_add(void *data, struct bpf_ksym *ksym);
918 void bpf_image_ksym_del(struct bpf_ksym *ksym);
919 void bpf_ksym_add(struct bpf_ksym *ksym);
920 void bpf_ksym_del(struct bpf_ksym *ksym);
921 int bpf_jit_charge_modmem(u32 size);
922 void bpf_jit_uncharge_modmem(u32 size);
923 bool bpf_prog_has_trampoline(const struct bpf_prog *prog);
924 #else
925 static inline int bpf_trampoline_link_prog(struct bpf_tramp_link *link,
926 					   struct bpf_trampoline *tr)
927 {
928 	return -ENOTSUPP;
929 }
930 static inline int bpf_trampoline_unlink_prog(struct bpf_tramp_link *link,
931 					     struct bpf_trampoline *tr)
932 {
933 	return -ENOTSUPP;
934 }
935 static inline struct bpf_trampoline *bpf_trampoline_get(u64 key,
936 							struct bpf_attach_target_info *tgt_info)
937 {
938 	return ERR_PTR(-EOPNOTSUPP);
939 }
940 static inline void bpf_trampoline_put(struct bpf_trampoline *tr) {}
941 #define DEFINE_BPF_DISPATCHER(name)
942 #define DECLARE_BPF_DISPATCHER(name)
943 #define BPF_DISPATCHER_FUNC(name) bpf_dispatcher_nop_func
944 #define BPF_DISPATCHER_PTR(name) NULL
945 static inline void bpf_dispatcher_change_prog(struct bpf_dispatcher *d,
946 					      struct bpf_prog *from,
947 					      struct bpf_prog *to) {}
948 static inline bool is_bpf_image_address(unsigned long address)
949 {
950 	return false;
951 }
952 static inline bool bpf_prog_has_trampoline(const struct bpf_prog *prog)
953 {
954 	return false;
955 }
956 #endif
957 
958 struct bpf_func_info_aux {
959 	u16 linkage;
960 	bool unreliable;
961 };
962 
963 enum bpf_jit_poke_reason {
964 	BPF_POKE_REASON_TAIL_CALL,
965 };
966 
967 /* Descriptor of pokes pointing /into/ the JITed image. */
968 struct bpf_jit_poke_descriptor {
969 	void *tailcall_target;
970 	void *tailcall_bypass;
971 	void *bypass_addr;
972 	void *aux;
973 	union {
974 		struct {
975 			struct bpf_map *map;
976 			u32 key;
977 		} tail_call;
978 	};
979 	bool tailcall_target_stable;
980 	u8 adj_off;
981 	u16 reason;
982 	u32 insn_idx;
983 };
984 
985 /* reg_type info for ctx arguments */
986 struct bpf_ctx_arg_aux {
987 	u32 offset;
988 	enum bpf_reg_type reg_type;
989 	u32 btf_id;
990 };
991 
992 struct btf_mod_pair {
993 	struct btf *btf;
994 	struct module *module;
995 };
996 
997 struct bpf_kfunc_desc_tab;
998 
999 struct bpf_prog_aux {
1000 	atomic64_t refcnt;
1001 	u32 used_map_cnt;
1002 	u32 used_btf_cnt;
1003 	u32 max_ctx_offset;
1004 	u32 max_pkt_offset;
1005 	u32 max_tp_access;
1006 	u32 stack_depth;
1007 	u32 id;
1008 	u32 func_cnt; /* used by non-func prog as the number of func progs */
1009 	u32 func_idx; /* 0 for non-func prog, the index in func array for func prog */
1010 	u32 attach_btf_id; /* in-kernel BTF type id to attach to */
1011 	u32 ctx_arg_info_size;
1012 	u32 max_rdonly_access;
1013 	u32 max_rdwr_access;
1014 	struct btf *attach_btf;
1015 	const struct bpf_ctx_arg_aux *ctx_arg_info;
1016 	struct mutex dst_mutex; /* protects dst_* pointers below, *after* prog becomes visible */
1017 	struct bpf_prog *dst_prog;
1018 	struct bpf_trampoline *dst_trampoline;
1019 	enum bpf_prog_type saved_dst_prog_type;
1020 	enum bpf_attach_type saved_dst_attach_type;
1021 	bool verifier_zext; /* Zero extensions has been inserted by verifier. */
1022 	bool offload_requested;
1023 	bool attach_btf_trace; /* true if attaching to BTF-enabled raw tp */
1024 	bool func_proto_unreliable;
1025 	bool sleepable;
1026 	bool tail_call_reachable;
1027 	bool xdp_has_frags;
1028 	bool use_bpf_prog_pack;
1029 	/* BTF_KIND_FUNC_PROTO for valid attach_btf_id */
1030 	const struct btf_type *attach_func_proto;
1031 	/* function name for valid attach_btf_id */
1032 	const char *attach_func_name;
1033 	struct bpf_prog **func;
1034 	void *jit_data; /* JIT specific data. arch dependent */
1035 	struct bpf_jit_poke_descriptor *poke_tab;
1036 	struct bpf_kfunc_desc_tab *kfunc_tab;
1037 	struct bpf_kfunc_btf_tab *kfunc_btf_tab;
1038 	u32 size_poke_tab;
1039 	struct bpf_ksym ksym;
1040 	const struct bpf_prog_ops *ops;
1041 	struct bpf_map **used_maps;
1042 	struct mutex used_maps_mutex; /* mutex for used_maps and used_map_cnt */
1043 	struct btf_mod_pair *used_btfs;
1044 	struct bpf_prog *prog;
1045 	struct user_struct *user;
1046 	u64 load_time; /* ns since boottime */
1047 	u32 verified_insns;
1048 	struct bpf_map *cgroup_storage[MAX_BPF_CGROUP_STORAGE_TYPE];
1049 	char name[BPF_OBJ_NAME_LEN];
1050 #ifdef CONFIG_SECURITY
1051 	void *security;
1052 #endif
1053 	struct bpf_prog_offload *offload;
1054 	struct btf *btf;
1055 	struct bpf_func_info *func_info;
1056 	struct bpf_func_info_aux *func_info_aux;
1057 	/* bpf_line_info loaded from userspace.  linfo->insn_off
1058 	 * has the xlated insn offset.
1059 	 * Both the main and sub prog share the same linfo.
1060 	 * The subprog can access its first linfo by
1061 	 * using the linfo_idx.
1062 	 */
1063 	struct bpf_line_info *linfo;
1064 	/* jited_linfo is the jited addr of the linfo.  It has a
1065 	 * one to one mapping to linfo:
1066 	 * jited_linfo[i] is the jited addr for the linfo[i]->insn_off.
1067 	 * Both the main and sub prog share the same jited_linfo.
1068 	 * The subprog can access its first jited_linfo by
1069 	 * using the linfo_idx.
1070 	 */
1071 	void **jited_linfo;
1072 	u32 func_info_cnt;
1073 	u32 nr_linfo;
1074 	/* subprog can use linfo_idx to access its first linfo and
1075 	 * jited_linfo.
1076 	 * main prog always has linfo_idx == 0
1077 	 */
1078 	u32 linfo_idx;
1079 	u32 num_exentries;
1080 	struct exception_table_entry *extable;
1081 	union {
1082 		struct work_struct work;
1083 		struct rcu_head	rcu;
1084 	};
1085 };
1086 
1087 struct bpf_array_aux {
1088 	/* Programs with direct jumps into programs part of this array. */
1089 	struct list_head poke_progs;
1090 	struct bpf_map *map;
1091 	struct mutex poke_mutex;
1092 	struct work_struct work;
1093 };
1094 
1095 struct bpf_link {
1096 	atomic64_t refcnt;
1097 	u32 id;
1098 	enum bpf_link_type type;
1099 	const struct bpf_link_ops *ops;
1100 	struct bpf_prog *prog;
1101 	struct work_struct work;
1102 };
1103 
1104 struct bpf_link_ops {
1105 	void (*release)(struct bpf_link *link);
1106 	void (*dealloc)(struct bpf_link *link);
1107 	int (*detach)(struct bpf_link *link);
1108 	int (*update_prog)(struct bpf_link *link, struct bpf_prog *new_prog,
1109 			   struct bpf_prog *old_prog);
1110 	void (*show_fdinfo)(const struct bpf_link *link, struct seq_file *seq);
1111 	int (*fill_link_info)(const struct bpf_link *link,
1112 			      struct bpf_link_info *info);
1113 };
1114 
1115 struct bpf_tramp_link {
1116 	struct bpf_link link;
1117 	struct hlist_node tramp_hlist;
1118 	u64 cookie;
1119 };
1120 
1121 struct bpf_tracing_link {
1122 	struct bpf_tramp_link link;
1123 	enum bpf_attach_type attach_type;
1124 	struct bpf_trampoline *trampoline;
1125 	struct bpf_prog *tgt_prog;
1126 };
1127 
1128 struct bpf_link_primer {
1129 	struct bpf_link *link;
1130 	struct file *file;
1131 	int fd;
1132 	u32 id;
1133 };
1134 
1135 struct bpf_struct_ops_value;
1136 struct btf_member;
1137 
1138 #define BPF_STRUCT_OPS_MAX_NR_MEMBERS 64
1139 struct bpf_struct_ops {
1140 	const struct bpf_verifier_ops *verifier_ops;
1141 	int (*init)(struct btf *btf);
1142 	int (*check_member)(const struct btf_type *t,
1143 			    const struct btf_member *member);
1144 	int (*init_member)(const struct btf_type *t,
1145 			   const struct btf_member *member,
1146 			   void *kdata, const void *udata);
1147 	int (*reg)(void *kdata);
1148 	void (*unreg)(void *kdata);
1149 	const struct btf_type *type;
1150 	const struct btf_type *value_type;
1151 	const char *name;
1152 	struct btf_func_model func_models[BPF_STRUCT_OPS_MAX_NR_MEMBERS];
1153 	u32 type_id;
1154 	u32 value_id;
1155 };
1156 
1157 #if defined(CONFIG_BPF_JIT) && defined(CONFIG_BPF_SYSCALL)
1158 #define BPF_MODULE_OWNER ((void *)((0xeB9FUL << 2) + POISON_POINTER_DELTA))
1159 const struct bpf_struct_ops *bpf_struct_ops_find(u32 type_id);
1160 void bpf_struct_ops_init(struct btf *btf, struct bpf_verifier_log *log);
1161 bool bpf_struct_ops_get(const void *kdata);
1162 void bpf_struct_ops_put(const void *kdata);
1163 int bpf_struct_ops_map_sys_lookup_elem(struct bpf_map *map, void *key,
1164 				       void *value);
1165 int bpf_struct_ops_prepare_trampoline(struct bpf_tramp_links *tlinks,
1166 				      struct bpf_tramp_link *link,
1167 				      const struct btf_func_model *model,
1168 				      void *image, void *image_end);
1169 static inline bool bpf_try_module_get(const void *data, struct module *owner)
1170 {
1171 	if (owner == BPF_MODULE_OWNER)
1172 		return bpf_struct_ops_get(data);
1173 	else
1174 		return try_module_get(owner);
1175 }
1176 static inline void bpf_module_put(const void *data, struct module *owner)
1177 {
1178 	if (owner == BPF_MODULE_OWNER)
1179 		bpf_struct_ops_put(data);
1180 	else
1181 		module_put(owner);
1182 }
1183 
1184 #ifdef CONFIG_NET
1185 /* Define it here to avoid the use of forward declaration */
1186 struct bpf_dummy_ops_state {
1187 	int val;
1188 };
1189 
1190 struct bpf_dummy_ops {
1191 	int (*test_1)(struct bpf_dummy_ops_state *cb);
1192 	int (*test_2)(struct bpf_dummy_ops_state *cb, int a1, unsigned short a2,
1193 		      char a3, unsigned long a4);
1194 };
1195 
1196 int bpf_struct_ops_test_run(struct bpf_prog *prog, const union bpf_attr *kattr,
1197 			    union bpf_attr __user *uattr);
1198 #endif
1199 #else
1200 static inline const struct bpf_struct_ops *bpf_struct_ops_find(u32 type_id)
1201 {
1202 	return NULL;
1203 }
1204 static inline void bpf_struct_ops_init(struct btf *btf,
1205 				       struct bpf_verifier_log *log)
1206 {
1207 }
1208 static inline bool bpf_try_module_get(const void *data, struct module *owner)
1209 {
1210 	return try_module_get(owner);
1211 }
1212 static inline void bpf_module_put(const void *data, struct module *owner)
1213 {
1214 	module_put(owner);
1215 }
1216 static inline int bpf_struct_ops_map_sys_lookup_elem(struct bpf_map *map,
1217 						     void *key,
1218 						     void *value)
1219 {
1220 	return -EINVAL;
1221 }
1222 #endif
1223 
1224 struct bpf_array {
1225 	struct bpf_map map;
1226 	u32 elem_size;
1227 	u32 index_mask;
1228 	struct bpf_array_aux *aux;
1229 	union {
1230 		char value[0] __aligned(8);
1231 		void *ptrs[0] __aligned(8);
1232 		void __percpu *pptrs[0] __aligned(8);
1233 	};
1234 };
1235 
1236 #define BPF_COMPLEXITY_LIMIT_INSNS      1000000 /* yes. 1M insns */
1237 #define MAX_TAIL_CALL_CNT 33
1238 
1239 #define BPF_F_ACCESS_MASK	(BPF_F_RDONLY |		\
1240 				 BPF_F_RDONLY_PROG |	\
1241 				 BPF_F_WRONLY |		\
1242 				 BPF_F_WRONLY_PROG)
1243 
1244 #define BPF_MAP_CAN_READ	BIT(0)
1245 #define BPF_MAP_CAN_WRITE	BIT(1)
1246 
1247 static inline u32 bpf_map_flags_to_cap(struct bpf_map *map)
1248 {
1249 	u32 access_flags = map->map_flags & (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG);
1250 
1251 	/* Combination of BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG is
1252 	 * not possible.
1253 	 */
1254 	if (access_flags & BPF_F_RDONLY_PROG)
1255 		return BPF_MAP_CAN_READ;
1256 	else if (access_flags & BPF_F_WRONLY_PROG)
1257 		return BPF_MAP_CAN_WRITE;
1258 	else
1259 		return BPF_MAP_CAN_READ | BPF_MAP_CAN_WRITE;
1260 }
1261 
1262 static inline bool bpf_map_flags_access_ok(u32 access_flags)
1263 {
1264 	return (access_flags & (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG)) !=
1265 	       (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG);
1266 }
1267 
1268 struct bpf_event_entry {
1269 	struct perf_event *event;
1270 	struct file *perf_file;
1271 	struct file *map_file;
1272 	struct rcu_head rcu;
1273 };
1274 
1275 static inline bool map_type_contains_progs(struct bpf_map *map)
1276 {
1277 	return map->map_type == BPF_MAP_TYPE_PROG_ARRAY ||
1278 	       map->map_type == BPF_MAP_TYPE_DEVMAP ||
1279 	       map->map_type == BPF_MAP_TYPE_CPUMAP;
1280 }
1281 
1282 bool bpf_prog_map_compatible(struct bpf_map *map, const struct bpf_prog *fp);
1283 int bpf_prog_calc_tag(struct bpf_prog *fp);
1284 
1285 const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
1286 const struct bpf_func_proto *bpf_get_trace_vprintk_proto(void);
1287 
1288 typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src,
1289 					unsigned long off, unsigned long len);
1290 typedef u32 (*bpf_convert_ctx_access_t)(enum bpf_access_type type,
1291 					const struct bpf_insn *src,
1292 					struct bpf_insn *dst,
1293 					struct bpf_prog *prog,
1294 					u32 *target_size);
1295 
1296 u64 bpf_event_output(struct bpf_map *map, u64 flags, void *meta, u64 meta_size,
1297 		     void *ctx, u64 ctx_size, bpf_ctx_copy_t ctx_copy);
1298 
1299 /* an array of programs to be executed under rcu_lock.
1300  *
1301  * Typical usage:
1302  * ret = bpf_prog_run_array(rcu_dereference(&bpf_prog_array), ctx, bpf_prog_run);
1303  *
1304  * the structure returned by bpf_prog_array_alloc() should be populated
1305  * with program pointers and the last pointer must be NULL.
1306  * The user has to keep refcnt on the program and make sure the program
1307  * is removed from the array before bpf_prog_put().
1308  * The 'struct bpf_prog_array *' should only be replaced with xchg()
1309  * since other cpus are walking the array of pointers in parallel.
1310  */
1311 struct bpf_prog_array_item {
1312 	struct bpf_prog *prog;
1313 	union {
1314 		struct bpf_cgroup_storage *cgroup_storage[MAX_BPF_CGROUP_STORAGE_TYPE];
1315 		u64 bpf_cookie;
1316 	};
1317 };
1318 
1319 struct bpf_prog_array {
1320 	struct rcu_head rcu;
1321 	struct bpf_prog_array_item items[];
1322 };
1323 
1324 struct bpf_empty_prog_array {
1325 	struct bpf_prog_array hdr;
1326 	struct bpf_prog *null_prog;
1327 };
1328 
1329 /* to avoid allocating empty bpf_prog_array for cgroups that
1330  * don't have bpf program attached use one global 'bpf_empty_prog_array'
1331  * It will not be modified the caller of bpf_prog_array_alloc()
1332  * (since caller requested prog_cnt == 0)
1333  * that pointer should be 'freed' by bpf_prog_array_free()
1334  */
1335 extern struct bpf_empty_prog_array bpf_empty_prog_array;
1336 
1337 struct bpf_prog_array *bpf_prog_array_alloc(u32 prog_cnt, gfp_t flags);
1338 void bpf_prog_array_free(struct bpf_prog_array *progs);
1339 int bpf_prog_array_length(struct bpf_prog_array *progs);
1340 bool bpf_prog_array_is_empty(struct bpf_prog_array *array);
1341 int bpf_prog_array_copy_to_user(struct bpf_prog_array *progs,
1342 				__u32 __user *prog_ids, u32 cnt);
1343 
1344 void bpf_prog_array_delete_safe(struct bpf_prog_array *progs,
1345 				struct bpf_prog *old_prog);
1346 int bpf_prog_array_delete_safe_at(struct bpf_prog_array *array, int index);
1347 int bpf_prog_array_update_at(struct bpf_prog_array *array, int index,
1348 			     struct bpf_prog *prog);
1349 int bpf_prog_array_copy_info(struct bpf_prog_array *array,
1350 			     u32 *prog_ids, u32 request_cnt,
1351 			     u32 *prog_cnt);
1352 int bpf_prog_array_copy(struct bpf_prog_array *old_array,
1353 			struct bpf_prog *exclude_prog,
1354 			struct bpf_prog *include_prog,
1355 			u64 bpf_cookie,
1356 			struct bpf_prog_array **new_array);
1357 
1358 struct bpf_run_ctx {};
1359 
1360 struct bpf_cg_run_ctx {
1361 	struct bpf_run_ctx run_ctx;
1362 	const struct bpf_prog_array_item *prog_item;
1363 	int retval;
1364 };
1365 
1366 struct bpf_trace_run_ctx {
1367 	struct bpf_run_ctx run_ctx;
1368 	u64 bpf_cookie;
1369 };
1370 
1371 struct bpf_tramp_run_ctx {
1372 	struct bpf_run_ctx run_ctx;
1373 	u64 bpf_cookie;
1374 	struct bpf_run_ctx *saved_run_ctx;
1375 };
1376 
1377 static inline struct bpf_run_ctx *bpf_set_run_ctx(struct bpf_run_ctx *new_ctx)
1378 {
1379 	struct bpf_run_ctx *old_ctx = NULL;
1380 
1381 #ifdef CONFIG_BPF_SYSCALL
1382 	old_ctx = current->bpf_ctx;
1383 	current->bpf_ctx = new_ctx;
1384 #endif
1385 	return old_ctx;
1386 }
1387 
1388 static inline void bpf_reset_run_ctx(struct bpf_run_ctx *old_ctx)
1389 {
1390 #ifdef CONFIG_BPF_SYSCALL
1391 	current->bpf_ctx = old_ctx;
1392 #endif
1393 }
1394 
1395 /* BPF program asks to bypass CAP_NET_BIND_SERVICE in bind. */
1396 #define BPF_RET_BIND_NO_CAP_NET_BIND_SERVICE			(1 << 0)
1397 /* BPF program asks to set CN on the packet. */
1398 #define BPF_RET_SET_CN						(1 << 0)
1399 
1400 typedef u32 (*bpf_prog_run_fn)(const struct bpf_prog *prog, const void *ctx);
1401 
1402 static __always_inline u32
1403 bpf_prog_run_array(const struct bpf_prog_array *array,
1404 		   const void *ctx, bpf_prog_run_fn run_prog)
1405 {
1406 	const struct bpf_prog_array_item *item;
1407 	const struct bpf_prog *prog;
1408 	struct bpf_run_ctx *old_run_ctx;
1409 	struct bpf_trace_run_ctx run_ctx;
1410 	u32 ret = 1;
1411 
1412 	RCU_LOCKDEP_WARN(!rcu_read_lock_held(), "no rcu lock held");
1413 
1414 	if (unlikely(!array))
1415 		return ret;
1416 
1417 	migrate_disable();
1418 	old_run_ctx = bpf_set_run_ctx(&run_ctx.run_ctx);
1419 	item = &array->items[0];
1420 	while ((prog = READ_ONCE(item->prog))) {
1421 		run_ctx.bpf_cookie = item->bpf_cookie;
1422 		ret &= run_prog(prog, ctx);
1423 		item++;
1424 	}
1425 	bpf_reset_run_ctx(old_run_ctx);
1426 	migrate_enable();
1427 	return ret;
1428 }
1429 
1430 #ifdef CONFIG_BPF_SYSCALL
1431 DECLARE_PER_CPU(int, bpf_prog_active);
1432 extern struct mutex bpf_stats_enabled_mutex;
1433 
1434 /*
1435  * Block execution of BPF programs attached to instrumentation (perf,
1436  * kprobes, tracepoints) to prevent deadlocks on map operations as any of
1437  * these events can happen inside a region which holds a map bucket lock
1438  * and can deadlock on it.
1439  */
1440 static inline void bpf_disable_instrumentation(void)
1441 {
1442 	migrate_disable();
1443 	this_cpu_inc(bpf_prog_active);
1444 }
1445 
1446 static inline void bpf_enable_instrumentation(void)
1447 {
1448 	this_cpu_dec(bpf_prog_active);
1449 	migrate_enable();
1450 }
1451 
1452 extern const struct file_operations bpf_map_fops;
1453 extern const struct file_operations bpf_prog_fops;
1454 extern const struct file_operations bpf_iter_fops;
1455 
1456 #define BPF_PROG_TYPE(_id, _name, prog_ctx_type, kern_ctx_type) \
1457 	extern const struct bpf_prog_ops _name ## _prog_ops; \
1458 	extern const struct bpf_verifier_ops _name ## _verifier_ops;
1459 #define BPF_MAP_TYPE(_id, _ops) \
1460 	extern const struct bpf_map_ops _ops;
1461 #define BPF_LINK_TYPE(_id, _name)
1462 #include <linux/bpf_types.h>
1463 #undef BPF_PROG_TYPE
1464 #undef BPF_MAP_TYPE
1465 #undef BPF_LINK_TYPE
1466 
1467 extern const struct bpf_prog_ops bpf_offload_prog_ops;
1468 extern const struct bpf_verifier_ops tc_cls_act_analyzer_ops;
1469 extern const struct bpf_verifier_ops xdp_analyzer_ops;
1470 
1471 struct bpf_prog *bpf_prog_get(u32 ufd);
1472 struct bpf_prog *bpf_prog_get_type_dev(u32 ufd, enum bpf_prog_type type,
1473 				       bool attach_drv);
1474 void bpf_prog_add(struct bpf_prog *prog, int i);
1475 void bpf_prog_sub(struct bpf_prog *prog, int i);
1476 void bpf_prog_inc(struct bpf_prog *prog);
1477 struct bpf_prog * __must_check bpf_prog_inc_not_zero(struct bpf_prog *prog);
1478 void bpf_prog_put(struct bpf_prog *prog);
1479 
1480 void bpf_prog_free_id(struct bpf_prog *prog, bool do_idr_lock);
1481 void bpf_map_free_id(struct bpf_map *map, bool do_idr_lock);
1482 
1483 struct bpf_map_value_off_desc *bpf_map_kptr_off_contains(struct bpf_map *map, u32 offset);
1484 void bpf_map_free_kptr_off_tab(struct bpf_map *map);
1485 struct bpf_map_value_off *bpf_map_copy_kptr_off_tab(const struct bpf_map *map);
1486 bool bpf_map_equal_kptr_off_tab(const struct bpf_map *map_a, const struct bpf_map *map_b);
1487 void bpf_map_free_kptrs(struct bpf_map *map, void *map_value);
1488 
1489 struct bpf_map *bpf_map_get(u32 ufd);
1490 struct bpf_map *bpf_map_get_with_uref(u32 ufd);
1491 struct bpf_map *__bpf_map_get(struct fd f);
1492 void bpf_map_inc(struct bpf_map *map);
1493 void bpf_map_inc_with_uref(struct bpf_map *map);
1494 struct bpf_map * __must_check bpf_map_inc_not_zero(struct bpf_map *map);
1495 void bpf_map_put_with_uref(struct bpf_map *map);
1496 void bpf_map_put(struct bpf_map *map);
1497 void *bpf_map_area_alloc(u64 size, int numa_node);
1498 void *bpf_map_area_mmapable_alloc(u64 size, int numa_node);
1499 void bpf_map_area_free(void *base);
1500 bool bpf_map_write_active(const struct bpf_map *map);
1501 void bpf_map_init_from_attr(struct bpf_map *map, union bpf_attr *attr);
1502 int  generic_map_lookup_batch(struct bpf_map *map,
1503 			      const union bpf_attr *attr,
1504 			      union bpf_attr __user *uattr);
1505 int  generic_map_update_batch(struct bpf_map *map,
1506 			      const union bpf_attr *attr,
1507 			      union bpf_attr __user *uattr);
1508 int  generic_map_delete_batch(struct bpf_map *map,
1509 			      const union bpf_attr *attr,
1510 			      union bpf_attr __user *uattr);
1511 struct bpf_map *bpf_map_get_curr_or_next(u32 *id);
1512 struct bpf_prog *bpf_prog_get_curr_or_next(u32 *id);
1513 
1514 #ifdef CONFIG_MEMCG_KMEM
1515 void *bpf_map_kmalloc_node(const struct bpf_map *map, size_t size, gfp_t flags,
1516 			   int node);
1517 void *bpf_map_kzalloc(const struct bpf_map *map, size_t size, gfp_t flags);
1518 void __percpu *bpf_map_alloc_percpu(const struct bpf_map *map, size_t size,
1519 				    size_t align, gfp_t flags);
1520 #else
1521 static inline void *
1522 bpf_map_kmalloc_node(const struct bpf_map *map, size_t size, gfp_t flags,
1523 		     int node)
1524 {
1525 	return kmalloc_node(size, flags, node);
1526 }
1527 
1528 static inline void *
1529 bpf_map_kzalloc(const struct bpf_map *map, size_t size, gfp_t flags)
1530 {
1531 	return kzalloc(size, flags);
1532 }
1533 
1534 static inline void __percpu *
1535 bpf_map_alloc_percpu(const struct bpf_map *map, size_t size, size_t align,
1536 		     gfp_t flags)
1537 {
1538 	return __alloc_percpu_gfp(size, align, flags);
1539 }
1540 #endif
1541 
1542 extern int sysctl_unprivileged_bpf_disabled;
1543 
1544 static inline bool bpf_allow_ptr_leaks(void)
1545 {
1546 	return perfmon_capable();
1547 }
1548 
1549 static inline bool bpf_allow_uninit_stack(void)
1550 {
1551 	return perfmon_capable();
1552 }
1553 
1554 static inline bool bpf_allow_ptr_to_map_access(void)
1555 {
1556 	return perfmon_capable();
1557 }
1558 
1559 static inline bool bpf_bypass_spec_v1(void)
1560 {
1561 	return perfmon_capable();
1562 }
1563 
1564 static inline bool bpf_bypass_spec_v4(void)
1565 {
1566 	return perfmon_capable();
1567 }
1568 
1569 int bpf_map_new_fd(struct bpf_map *map, int flags);
1570 int bpf_prog_new_fd(struct bpf_prog *prog);
1571 
1572 void bpf_link_init(struct bpf_link *link, enum bpf_link_type type,
1573 		   const struct bpf_link_ops *ops, struct bpf_prog *prog);
1574 int bpf_link_prime(struct bpf_link *link, struct bpf_link_primer *primer);
1575 int bpf_link_settle(struct bpf_link_primer *primer);
1576 void bpf_link_cleanup(struct bpf_link_primer *primer);
1577 void bpf_link_inc(struct bpf_link *link);
1578 void bpf_link_put(struct bpf_link *link);
1579 int bpf_link_new_fd(struct bpf_link *link);
1580 struct file *bpf_link_new_file(struct bpf_link *link, int *reserved_fd);
1581 struct bpf_link *bpf_link_get_from_fd(u32 ufd);
1582 struct bpf_link *bpf_link_get_curr_or_next(u32 *id);
1583 
1584 int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
1585 int bpf_obj_get_user(const char __user *pathname, int flags);
1586 
1587 #define BPF_ITER_FUNC_PREFIX "bpf_iter_"
1588 #define DEFINE_BPF_ITER_FUNC(target, args...)			\
1589 	extern int bpf_iter_ ## target(args);			\
1590 	int __init bpf_iter_ ## target(args) { return 0; }
1591 
1592 struct bpf_iter_aux_info {
1593 	struct bpf_map *map;
1594 };
1595 
1596 typedef int (*bpf_iter_attach_target_t)(struct bpf_prog *prog,
1597 					union bpf_iter_link_info *linfo,
1598 					struct bpf_iter_aux_info *aux);
1599 typedef void (*bpf_iter_detach_target_t)(struct bpf_iter_aux_info *aux);
1600 typedef void (*bpf_iter_show_fdinfo_t) (const struct bpf_iter_aux_info *aux,
1601 					struct seq_file *seq);
1602 typedef int (*bpf_iter_fill_link_info_t)(const struct bpf_iter_aux_info *aux,
1603 					 struct bpf_link_info *info);
1604 typedef const struct bpf_func_proto *
1605 (*bpf_iter_get_func_proto_t)(enum bpf_func_id func_id,
1606 			     const struct bpf_prog *prog);
1607 
1608 enum bpf_iter_feature {
1609 	BPF_ITER_RESCHED	= BIT(0),
1610 };
1611 
1612 #define BPF_ITER_CTX_ARG_MAX 2
1613 struct bpf_iter_reg {
1614 	const char *target;
1615 	bpf_iter_attach_target_t attach_target;
1616 	bpf_iter_detach_target_t detach_target;
1617 	bpf_iter_show_fdinfo_t show_fdinfo;
1618 	bpf_iter_fill_link_info_t fill_link_info;
1619 	bpf_iter_get_func_proto_t get_func_proto;
1620 	u32 ctx_arg_info_size;
1621 	u32 feature;
1622 	struct bpf_ctx_arg_aux ctx_arg_info[BPF_ITER_CTX_ARG_MAX];
1623 	const struct bpf_iter_seq_info *seq_info;
1624 };
1625 
1626 struct bpf_iter_meta {
1627 	__bpf_md_ptr(struct seq_file *, seq);
1628 	u64 session_id;
1629 	u64 seq_num;
1630 };
1631 
1632 struct bpf_iter__bpf_map_elem {
1633 	__bpf_md_ptr(struct bpf_iter_meta *, meta);
1634 	__bpf_md_ptr(struct bpf_map *, map);
1635 	__bpf_md_ptr(void *, key);
1636 	__bpf_md_ptr(void *, value);
1637 };
1638 
1639 int bpf_iter_reg_target(const struct bpf_iter_reg *reg_info);
1640 void bpf_iter_unreg_target(const struct bpf_iter_reg *reg_info);
1641 bool bpf_iter_prog_supported(struct bpf_prog *prog);
1642 const struct bpf_func_proto *
1643 bpf_iter_get_func_proto(enum bpf_func_id func_id, const struct bpf_prog *prog);
1644 int bpf_iter_link_attach(const union bpf_attr *attr, bpfptr_t uattr, struct bpf_prog *prog);
1645 int bpf_iter_new_fd(struct bpf_link *link);
1646 bool bpf_link_is_iter(struct bpf_link *link);
1647 struct bpf_prog *bpf_iter_get_info(struct bpf_iter_meta *meta, bool in_stop);
1648 int bpf_iter_run_prog(struct bpf_prog *prog, void *ctx);
1649 void bpf_iter_map_show_fdinfo(const struct bpf_iter_aux_info *aux,
1650 			      struct seq_file *seq);
1651 int bpf_iter_map_fill_link_info(const struct bpf_iter_aux_info *aux,
1652 				struct bpf_link_info *info);
1653 
1654 int map_set_for_each_callback_args(struct bpf_verifier_env *env,
1655 				   struct bpf_func_state *caller,
1656 				   struct bpf_func_state *callee);
1657 
1658 int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value);
1659 int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value);
1660 int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
1661 			   u64 flags);
1662 int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
1663 			    u64 flags);
1664 
1665 int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value);
1666 
1667 int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
1668 				 void *key, void *value, u64 map_flags);
1669 int bpf_fd_array_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
1670 int bpf_fd_htab_map_update_elem(struct bpf_map *map, struct file *map_file,
1671 				void *key, void *value, u64 map_flags);
1672 int bpf_fd_htab_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
1673 
1674 int bpf_get_file_flag(int flags);
1675 int bpf_check_uarg_tail_zero(bpfptr_t uaddr, size_t expected_size,
1676 			     size_t actual_size);
1677 
1678 /* memcpy that is used with 8-byte aligned pointers, power-of-8 size and
1679  * forced to use 'long' read/writes to try to atomically copy long counters.
1680  * Best-effort only.  No barriers here, since it _will_ race with concurrent
1681  * updates from BPF programs. Called from bpf syscall and mostly used with
1682  * size 8 or 16 bytes, so ask compiler to inline it.
1683  */
1684 static inline void bpf_long_memcpy(void *dst, const void *src, u32 size)
1685 {
1686 	const long *lsrc = src;
1687 	long *ldst = dst;
1688 
1689 	size /= sizeof(long);
1690 	while (size--)
1691 		*ldst++ = *lsrc++;
1692 }
1693 
1694 /* verify correctness of eBPF program */
1695 int bpf_check(struct bpf_prog **fp, union bpf_attr *attr, bpfptr_t uattr);
1696 
1697 #ifndef CONFIG_BPF_JIT_ALWAYS_ON
1698 void bpf_patch_call_args(struct bpf_insn *insn, u32 stack_depth);
1699 #endif
1700 
1701 struct btf *bpf_get_btf_vmlinux(void);
1702 
1703 /* Map specifics */
1704 struct xdp_frame;
1705 struct sk_buff;
1706 struct bpf_dtab_netdev;
1707 struct bpf_cpu_map_entry;
1708 
1709 void __dev_flush(void);
1710 int dev_xdp_enqueue(struct net_device *dev, struct xdp_frame *xdpf,
1711 		    struct net_device *dev_rx);
1712 int dev_map_enqueue(struct bpf_dtab_netdev *dst, struct xdp_frame *xdpf,
1713 		    struct net_device *dev_rx);
1714 int dev_map_enqueue_multi(struct xdp_frame *xdpf, struct net_device *dev_rx,
1715 			  struct bpf_map *map, bool exclude_ingress);
1716 int dev_map_generic_redirect(struct bpf_dtab_netdev *dst, struct sk_buff *skb,
1717 			     struct bpf_prog *xdp_prog);
1718 int dev_map_redirect_multi(struct net_device *dev, struct sk_buff *skb,
1719 			   struct bpf_prog *xdp_prog, struct bpf_map *map,
1720 			   bool exclude_ingress);
1721 
1722 void __cpu_map_flush(void);
1723 int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu, struct xdp_frame *xdpf,
1724 		    struct net_device *dev_rx);
1725 int cpu_map_generic_redirect(struct bpf_cpu_map_entry *rcpu,
1726 			     struct sk_buff *skb);
1727 
1728 /* Return map's numa specified by userspace */
1729 static inline int bpf_map_attr_numa_node(const union bpf_attr *attr)
1730 {
1731 	return (attr->map_flags & BPF_F_NUMA_NODE) ?
1732 		attr->numa_node : NUMA_NO_NODE;
1733 }
1734 
1735 struct bpf_prog *bpf_prog_get_type_path(const char *name, enum bpf_prog_type type);
1736 int array_map_alloc_check(union bpf_attr *attr);
1737 
1738 int bpf_prog_test_run_xdp(struct bpf_prog *prog, const union bpf_attr *kattr,
1739 			  union bpf_attr __user *uattr);
1740 int bpf_prog_test_run_skb(struct bpf_prog *prog, const union bpf_attr *kattr,
1741 			  union bpf_attr __user *uattr);
1742 int bpf_prog_test_run_tracing(struct bpf_prog *prog,
1743 			      const union bpf_attr *kattr,
1744 			      union bpf_attr __user *uattr);
1745 int bpf_prog_test_run_flow_dissector(struct bpf_prog *prog,
1746 				     const union bpf_attr *kattr,
1747 				     union bpf_attr __user *uattr);
1748 int bpf_prog_test_run_raw_tp(struct bpf_prog *prog,
1749 			     const union bpf_attr *kattr,
1750 			     union bpf_attr __user *uattr);
1751 int bpf_prog_test_run_sk_lookup(struct bpf_prog *prog,
1752 				const union bpf_attr *kattr,
1753 				union bpf_attr __user *uattr);
1754 bool btf_ctx_access(int off, int size, enum bpf_access_type type,
1755 		    const struct bpf_prog *prog,
1756 		    struct bpf_insn_access_aux *info);
1757 
1758 static inline bool bpf_tracing_ctx_access(int off, int size,
1759 					  enum bpf_access_type type)
1760 {
1761 	if (off < 0 || off >= sizeof(__u64) * MAX_BPF_FUNC_ARGS)
1762 		return false;
1763 	if (type != BPF_READ)
1764 		return false;
1765 	if (off % size != 0)
1766 		return false;
1767 	return true;
1768 }
1769 
1770 static inline bool bpf_tracing_btf_ctx_access(int off, int size,
1771 					      enum bpf_access_type type,
1772 					      const struct bpf_prog *prog,
1773 					      struct bpf_insn_access_aux *info)
1774 {
1775 	if (!bpf_tracing_ctx_access(off, size, type))
1776 		return false;
1777 	return btf_ctx_access(off, size, type, prog, info);
1778 }
1779 
1780 int btf_struct_access(struct bpf_verifier_log *log, const struct btf *btf,
1781 		      const struct btf_type *t, int off, int size,
1782 		      enum bpf_access_type atype,
1783 		      u32 *next_btf_id, enum bpf_type_flag *flag);
1784 bool btf_struct_ids_match(struct bpf_verifier_log *log,
1785 			  const struct btf *btf, u32 id, int off,
1786 			  const struct btf *need_btf, u32 need_type_id,
1787 			  bool strict);
1788 
1789 int btf_distill_func_proto(struct bpf_verifier_log *log,
1790 			   struct btf *btf,
1791 			   const struct btf_type *func_proto,
1792 			   const char *func_name,
1793 			   struct btf_func_model *m);
1794 
1795 struct bpf_reg_state;
1796 int btf_check_subprog_arg_match(struct bpf_verifier_env *env, int subprog,
1797 				struct bpf_reg_state *regs);
1798 int btf_check_kfunc_arg_match(struct bpf_verifier_env *env,
1799 			      const struct btf *btf, u32 func_id,
1800 			      struct bpf_reg_state *regs);
1801 int btf_prepare_func_args(struct bpf_verifier_env *env, int subprog,
1802 			  struct bpf_reg_state *reg);
1803 int btf_check_type_match(struct bpf_verifier_log *log, const struct bpf_prog *prog,
1804 			 struct btf *btf, const struct btf_type *t);
1805 
1806 struct bpf_prog *bpf_prog_by_id(u32 id);
1807 struct bpf_link *bpf_link_by_id(u32 id);
1808 
1809 const struct bpf_func_proto *bpf_base_func_proto(enum bpf_func_id func_id);
1810 void bpf_task_storage_free(struct task_struct *task);
1811 bool bpf_prog_has_kfunc_call(const struct bpf_prog *prog);
1812 const struct btf_func_model *
1813 bpf_jit_find_kfunc_model(const struct bpf_prog *prog,
1814 			 const struct bpf_insn *insn);
1815 struct bpf_core_ctx {
1816 	struct bpf_verifier_log *log;
1817 	const struct btf *btf;
1818 };
1819 
1820 int bpf_core_apply(struct bpf_core_ctx *ctx, const struct bpf_core_relo *relo,
1821 		   int relo_idx, void *insn);
1822 
1823 static inline bool unprivileged_ebpf_enabled(void)
1824 {
1825 	return !sysctl_unprivileged_bpf_disabled;
1826 }
1827 
1828 #else /* !CONFIG_BPF_SYSCALL */
1829 static inline struct bpf_prog *bpf_prog_get(u32 ufd)
1830 {
1831 	return ERR_PTR(-EOPNOTSUPP);
1832 }
1833 
1834 static inline struct bpf_prog *bpf_prog_get_type_dev(u32 ufd,
1835 						     enum bpf_prog_type type,
1836 						     bool attach_drv)
1837 {
1838 	return ERR_PTR(-EOPNOTSUPP);
1839 }
1840 
1841 static inline void bpf_prog_add(struct bpf_prog *prog, int i)
1842 {
1843 }
1844 
1845 static inline void bpf_prog_sub(struct bpf_prog *prog, int i)
1846 {
1847 }
1848 
1849 static inline void bpf_prog_put(struct bpf_prog *prog)
1850 {
1851 }
1852 
1853 static inline void bpf_prog_inc(struct bpf_prog *prog)
1854 {
1855 }
1856 
1857 static inline struct bpf_prog *__must_check
1858 bpf_prog_inc_not_zero(struct bpf_prog *prog)
1859 {
1860 	return ERR_PTR(-EOPNOTSUPP);
1861 }
1862 
1863 static inline void bpf_link_init(struct bpf_link *link, enum bpf_link_type type,
1864 				 const struct bpf_link_ops *ops,
1865 				 struct bpf_prog *prog)
1866 {
1867 }
1868 
1869 static inline int bpf_link_prime(struct bpf_link *link,
1870 				 struct bpf_link_primer *primer)
1871 {
1872 	return -EOPNOTSUPP;
1873 }
1874 
1875 static inline int bpf_link_settle(struct bpf_link_primer *primer)
1876 {
1877 	return -EOPNOTSUPP;
1878 }
1879 
1880 static inline void bpf_link_cleanup(struct bpf_link_primer *primer)
1881 {
1882 }
1883 
1884 static inline void bpf_link_inc(struct bpf_link *link)
1885 {
1886 }
1887 
1888 static inline void bpf_link_put(struct bpf_link *link)
1889 {
1890 }
1891 
1892 static inline int bpf_obj_get_user(const char __user *pathname, int flags)
1893 {
1894 	return -EOPNOTSUPP;
1895 }
1896 
1897 static inline void __dev_flush(void)
1898 {
1899 }
1900 
1901 struct xdp_frame;
1902 struct bpf_dtab_netdev;
1903 struct bpf_cpu_map_entry;
1904 
1905 static inline
1906 int dev_xdp_enqueue(struct net_device *dev, struct xdp_frame *xdpf,
1907 		    struct net_device *dev_rx)
1908 {
1909 	return 0;
1910 }
1911 
1912 static inline
1913 int dev_map_enqueue(struct bpf_dtab_netdev *dst, struct xdp_frame *xdpf,
1914 		    struct net_device *dev_rx)
1915 {
1916 	return 0;
1917 }
1918 
1919 static inline
1920 int dev_map_enqueue_multi(struct xdp_frame *xdpf, struct net_device *dev_rx,
1921 			  struct bpf_map *map, bool exclude_ingress)
1922 {
1923 	return 0;
1924 }
1925 
1926 struct sk_buff;
1927 
1928 static inline int dev_map_generic_redirect(struct bpf_dtab_netdev *dst,
1929 					   struct sk_buff *skb,
1930 					   struct bpf_prog *xdp_prog)
1931 {
1932 	return 0;
1933 }
1934 
1935 static inline
1936 int dev_map_redirect_multi(struct net_device *dev, struct sk_buff *skb,
1937 			   struct bpf_prog *xdp_prog, struct bpf_map *map,
1938 			   bool exclude_ingress)
1939 {
1940 	return 0;
1941 }
1942 
1943 static inline void __cpu_map_flush(void)
1944 {
1945 }
1946 
1947 static inline int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu,
1948 				  struct xdp_frame *xdpf,
1949 				  struct net_device *dev_rx)
1950 {
1951 	return 0;
1952 }
1953 
1954 static inline int cpu_map_generic_redirect(struct bpf_cpu_map_entry *rcpu,
1955 					   struct sk_buff *skb)
1956 {
1957 	return -EOPNOTSUPP;
1958 }
1959 
1960 static inline struct bpf_prog *bpf_prog_get_type_path(const char *name,
1961 				enum bpf_prog_type type)
1962 {
1963 	return ERR_PTR(-EOPNOTSUPP);
1964 }
1965 
1966 static inline int bpf_prog_test_run_xdp(struct bpf_prog *prog,
1967 					const union bpf_attr *kattr,
1968 					union bpf_attr __user *uattr)
1969 {
1970 	return -ENOTSUPP;
1971 }
1972 
1973 static inline int bpf_prog_test_run_skb(struct bpf_prog *prog,
1974 					const union bpf_attr *kattr,
1975 					union bpf_attr __user *uattr)
1976 {
1977 	return -ENOTSUPP;
1978 }
1979 
1980 static inline int bpf_prog_test_run_tracing(struct bpf_prog *prog,
1981 					    const union bpf_attr *kattr,
1982 					    union bpf_attr __user *uattr)
1983 {
1984 	return -ENOTSUPP;
1985 }
1986 
1987 static inline int bpf_prog_test_run_flow_dissector(struct bpf_prog *prog,
1988 						   const union bpf_attr *kattr,
1989 						   union bpf_attr __user *uattr)
1990 {
1991 	return -ENOTSUPP;
1992 }
1993 
1994 static inline int bpf_prog_test_run_sk_lookup(struct bpf_prog *prog,
1995 					      const union bpf_attr *kattr,
1996 					      union bpf_attr __user *uattr)
1997 {
1998 	return -ENOTSUPP;
1999 }
2000 
2001 static inline void bpf_map_put(struct bpf_map *map)
2002 {
2003 }
2004 
2005 static inline struct bpf_prog *bpf_prog_by_id(u32 id)
2006 {
2007 	return ERR_PTR(-ENOTSUPP);
2008 }
2009 
2010 static inline const struct bpf_func_proto *
2011 bpf_base_func_proto(enum bpf_func_id func_id)
2012 {
2013 	return NULL;
2014 }
2015 
2016 static inline void bpf_task_storage_free(struct task_struct *task)
2017 {
2018 }
2019 
2020 static inline bool bpf_prog_has_kfunc_call(const struct bpf_prog *prog)
2021 {
2022 	return false;
2023 }
2024 
2025 static inline const struct btf_func_model *
2026 bpf_jit_find_kfunc_model(const struct bpf_prog *prog,
2027 			 const struct bpf_insn *insn)
2028 {
2029 	return NULL;
2030 }
2031 
2032 static inline bool unprivileged_ebpf_enabled(void)
2033 {
2034 	return false;
2035 }
2036 
2037 #endif /* CONFIG_BPF_SYSCALL */
2038 
2039 void __bpf_free_used_btfs(struct bpf_prog_aux *aux,
2040 			  struct btf_mod_pair *used_btfs, u32 len);
2041 
2042 static inline struct bpf_prog *bpf_prog_get_type(u32 ufd,
2043 						 enum bpf_prog_type type)
2044 {
2045 	return bpf_prog_get_type_dev(ufd, type, false);
2046 }
2047 
2048 void __bpf_free_used_maps(struct bpf_prog_aux *aux,
2049 			  struct bpf_map **used_maps, u32 len);
2050 
2051 bool bpf_prog_get_ok(struct bpf_prog *, enum bpf_prog_type *, bool);
2052 
2053 int bpf_prog_offload_compile(struct bpf_prog *prog);
2054 void bpf_prog_offload_destroy(struct bpf_prog *prog);
2055 int bpf_prog_offload_info_fill(struct bpf_prog_info *info,
2056 			       struct bpf_prog *prog);
2057 
2058 int bpf_map_offload_info_fill(struct bpf_map_info *info, struct bpf_map *map);
2059 
2060 int bpf_map_offload_lookup_elem(struct bpf_map *map, void *key, void *value);
2061 int bpf_map_offload_update_elem(struct bpf_map *map,
2062 				void *key, void *value, u64 flags);
2063 int bpf_map_offload_delete_elem(struct bpf_map *map, void *key);
2064 int bpf_map_offload_get_next_key(struct bpf_map *map,
2065 				 void *key, void *next_key);
2066 
2067 bool bpf_offload_prog_map_match(struct bpf_prog *prog, struct bpf_map *map);
2068 
2069 struct bpf_offload_dev *
2070 bpf_offload_dev_create(const struct bpf_prog_offload_ops *ops, void *priv);
2071 void bpf_offload_dev_destroy(struct bpf_offload_dev *offdev);
2072 void *bpf_offload_dev_priv(struct bpf_offload_dev *offdev);
2073 int bpf_offload_dev_netdev_register(struct bpf_offload_dev *offdev,
2074 				    struct net_device *netdev);
2075 void bpf_offload_dev_netdev_unregister(struct bpf_offload_dev *offdev,
2076 				       struct net_device *netdev);
2077 bool bpf_offload_dev_match(struct bpf_prog *prog, struct net_device *netdev);
2078 
2079 void unpriv_ebpf_notify(int new_state);
2080 
2081 #if defined(CONFIG_NET) && defined(CONFIG_BPF_SYSCALL)
2082 int bpf_prog_offload_init(struct bpf_prog *prog, union bpf_attr *attr);
2083 
2084 static inline bool bpf_prog_is_dev_bound(const struct bpf_prog_aux *aux)
2085 {
2086 	return aux->offload_requested;
2087 }
2088 
2089 static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
2090 {
2091 	return unlikely(map->ops == &bpf_map_offload_ops);
2092 }
2093 
2094 struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr);
2095 void bpf_map_offload_map_free(struct bpf_map *map);
2096 int bpf_prog_test_run_syscall(struct bpf_prog *prog,
2097 			      const union bpf_attr *kattr,
2098 			      union bpf_attr __user *uattr);
2099 
2100 int sock_map_get_from_fd(const union bpf_attr *attr, struct bpf_prog *prog);
2101 int sock_map_prog_detach(const union bpf_attr *attr, enum bpf_prog_type ptype);
2102 int sock_map_update_elem_sys(struct bpf_map *map, void *key, void *value, u64 flags);
2103 int sock_map_bpf_prog_query(const union bpf_attr *attr,
2104 			    union bpf_attr __user *uattr);
2105 
2106 void sock_map_unhash(struct sock *sk);
2107 void sock_map_close(struct sock *sk, long timeout);
2108 #else
2109 static inline int bpf_prog_offload_init(struct bpf_prog *prog,
2110 					union bpf_attr *attr)
2111 {
2112 	return -EOPNOTSUPP;
2113 }
2114 
2115 static inline bool bpf_prog_is_dev_bound(struct bpf_prog_aux *aux)
2116 {
2117 	return false;
2118 }
2119 
2120 static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
2121 {
2122 	return false;
2123 }
2124 
2125 static inline struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr)
2126 {
2127 	return ERR_PTR(-EOPNOTSUPP);
2128 }
2129 
2130 static inline void bpf_map_offload_map_free(struct bpf_map *map)
2131 {
2132 }
2133 
2134 static inline int bpf_prog_test_run_syscall(struct bpf_prog *prog,
2135 					    const union bpf_attr *kattr,
2136 					    union bpf_attr __user *uattr)
2137 {
2138 	return -ENOTSUPP;
2139 }
2140 
2141 #ifdef CONFIG_BPF_SYSCALL
2142 static inline int sock_map_get_from_fd(const union bpf_attr *attr,
2143 				       struct bpf_prog *prog)
2144 {
2145 	return -EINVAL;
2146 }
2147 
2148 static inline int sock_map_prog_detach(const union bpf_attr *attr,
2149 				       enum bpf_prog_type ptype)
2150 {
2151 	return -EOPNOTSUPP;
2152 }
2153 
2154 static inline int sock_map_update_elem_sys(struct bpf_map *map, void *key, void *value,
2155 					   u64 flags)
2156 {
2157 	return -EOPNOTSUPP;
2158 }
2159 
2160 static inline int sock_map_bpf_prog_query(const union bpf_attr *attr,
2161 					  union bpf_attr __user *uattr)
2162 {
2163 	return -EINVAL;
2164 }
2165 #endif /* CONFIG_BPF_SYSCALL */
2166 #endif /* CONFIG_NET && CONFIG_BPF_SYSCALL */
2167 
2168 #if defined(CONFIG_INET) && defined(CONFIG_BPF_SYSCALL)
2169 void bpf_sk_reuseport_detach(struct sock *sk);
2170 int bpf_fd_reuseport_array_lookup_elem(struct bpf_map *map, void *key,
2171 				       void *value);
2172 int bpf_fd_reuseport_array_update_elem(struct bpf_map *map, void *key,
2173 				       void *value, u64 map_flags);
2174 #else
2175 static inline void bpf_sk_reuseport_detach(struct sock *sk)
2176 {
2177 }
2178 
2179 #ifdef CONFIG_BPF_SYSCALL
2180 static inline int bpf_fd_reuseport_array_lookup_elem(struct bpf_map *map,
2181 						     void *key, void *value)
2182 {
2183 	return -EOPNOTSUPP;
2184 }
2185 
2186 static inline int bpf_fd_reuseport_array_update_elem(struct bpf_map *map,
2187 						     void *key, void *value,
2188 						     u64 map_flags)
2189 {
2190 	return -EOPNOTSUPP;
2191 }
2192 #endif /* CONFIG_BPF_SYSCALL */
2193 #endif /* defined(CONFIG_INET) && defined(CONFIG_BPF_SYSCALL) */
2194 
2195 /* verifier prototypes for helper functions called from eBPF programs */
2196 extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
2197 extern const struct bpf_func_proto bpf_map_update_elem_proto;
2198 extern const struct bpf_func_proto bpf_map_delete_elem_proto;
2199 extern const struct bpf_func_proto bpf_map_push_elem_proto;
2200 extern const struct bpf_func_proto bpf_map_pop_elem_proto;
2201 extern const struct bpf_func_proto bpf_map_peek_elem_proto;
2202 extern const struct bpf_func_proto bpf_map_lookup_percpu_elem_proto;
2203 
2204 extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
2205 extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
2206 extern const struct bpf_func_proto bpf_get_numa_node_id_proto;
2207 extern const struct bpf_func_proto bpf_tail_call_proto;
2208 extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
2209 extern const struct bpf_func_proto bpf_ktime_get_boot_ns_proto;
2210 extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
2211 extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
2212 extern const struct bpf_func_proto bpf_get_current_comm_proto;
2213 extern const struct bpf_func_proto bpf_get_stackid_proto;
2214 extern const struct bpf_func_proto bpf_get_stack_proto;
2215 extern const struct bpf_func_proto bpf_get_task_stack_proto;
2216 extern const struct bpf_func_proto bpf_get_stackid_proto_pe;
2217 extern const struct bpf_func_proto bpf_get_stack_proto_pe;
2218 extern const struct bpf_func_proto bpf_sock_map_update_proto;
2219 extern const struct bpf_func_proto bpf_sock_hash_update_proto;
2220 extern const struct bpf_func_proto bpf_get_current_cgroup_id_proto;
2221 extern const struct bpf_func_proto bpf_get_current_ancestor_cgroup_id_proto;
2222 extern const struct bpf_func_proto bpf_msg_redirect_hash_proto;
2223 extern const struct bpf_func_proto bpf_msg_redirect_map_proto;
2224 extern const struct bpf_func_proto bpf_sk_redirect_hash_proto;
2225 extern const struct bpf_func_proto bpf_sk_redirect_map_proto;
2226 extern const struct bpf_func_proto bpf_spin_lock_proto;
2227 extern const struct bpf_func_proto bpf_spin_unlock_proto;
2228 extern const struct bpf_func_proto bpf_get_local_storage_proto;
2229 extern const struct bpf_func_proto bpf_strtol_proto;
2230 extern const struct bpf_func_proto bpf_strtoul_proto;
2231 extern const struct bpf_func_proto bpf_tcp_sock_proto;
2232 extern const struct bpf_func_proto bpf_jiffies64_proto;
2233 extern const struct bpf_func_proto bpf_get_ns_current_pid_tgid_proto;
2234 extern const struct bpf_func_proto bpf_event_output_data_proto;
2235 extern const struct bpf_func_proto bpf_ringbuf_output_proto;
2236 extern const struct bpf_func_proto bpf_ringbuf_reserve_proto;
2237 extern const struct bpf_func_proto bpf_ringbuf_submit_proto;
2238 extern const struct bpf_func_proto bpf_ringbuf_discard_proto;
2239 extern const struct bpf_func_proto bpf_ringbuf_query_proto;
2240 extern const struct bpf_func_proto bpf_ringbuf_reserve_dynptr_proto;
2241 extern const struct bpf_func_proto bpf_ringbuf_submit_dynptr_proto;
2242 extern const struct bpf_func_proto bpf_ringbuf_discard_dynptr_proto;
2243 extern const struct bpf_func_proto bpf_skc_to_tcp6_sock_proto;
2244 extern const struct bpf_func_proto bpf_skc_to_tcp_sock_proto;
2245 extern const struct bpf_func_proto bpf_skc_to_tcp_timewait_sock_proto;
2246 extern const struct bpf_func_proto bpf_skc_to_tcp_request_sock_proto;
2247 extern const struct bpf_func_proto bpf_skc_to_udp6_sock_proto;
2248 extern const struct bpf_func_proto bpf_skc_to_unix_sock_proto;
2249 extern const struct bpf_func_proto bpf_skc_to_mptcp_sock_proto;
2250 extern const struct bpf_func_proto bpf_copy_from_user_proto;
2251 extern const struct bpf_func_proto bpf_snprintf_btf_proto;
2252 extern const struct bpf_func_proto bpf_snprintf_proto;
2253 extern const struct bpf_func_proto bpf_per_cpu_ptr_proto;
2254 extern const struct bpf_func_proto bpf_this_cpu_ptr_proto;
2255 extern const struct bpf_func_proto bpf_ktime_get_coarse_ns_proto;
2256 extern const struct bpf_func_proto bpf_sock_from_file_proto;
2257 extern const struct bpf_func_proto bpf_get_socket_ptr_cookie_proto;
2258 extern const struct bpf_func_proto bpf_task_storage_get_proto;
2259 extern const struct bpf_func_proto bpf_task_storage_delete_proto;
2260 extern const struct bpf_func_proto bpf_for_each_map_elem_proto;
2261 extern const struct bpf_func_proto bpf_btf_find_by_name_kind_proto;
2262 extern const struct bpf_func_proto bpf_sk_setsockopt_proto;
2263 extern const struct bpf_func_proto bpf_sk_getsockopt_proto;
2264 extern const struct bpf_func_proto bpf_kallsyms_lookup_name_proto;
2265 extern const struct bpf_func_proto bpf_find_vma_proto;
2266 extern const struct bpf_func_proto bpf_loop_proto;
2267 extern const struct bpf_func_proto bpf_strncmp_proto;
2268 extern const struct bpf_func_proto bpf_copy_from_user_task_proto;
2269 extern const struct bpf_func_proto bpf_kptr_xchg_proto;
2270 
2271 const struct bpf_func_proto *tracing_prog_func_proto(
2272   enum bpf_func_id func_id, const struct bpf_prog *prog);
2273 
2274 /* Shared helpers among cBPF and eBPF. */
2275 void bpf_user_rnd_init_once(void);
2276 u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
2277 u64 bpf_get_raw_cpu_id(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
2278 
2279 #if defined(CONFIG_NET)
2280 bool bpf_sock_common_is_valid_access(int off, int size,
2281 				     enum bpf_access_type type,
2282 				     struct bpf_insn_access_aux *info);
2283 bool bpf_sock_is_valid_access(int off, int size, enum bpf_access_type type,
2284 			      struct bpf_insn_access_aux *info);
2285 u32 bpf_sock_convert_ctx_access(enum bpf_access_type type,
2286 				const struct bpf_insn *si,
2287 				struct bpf_insn *insn_buf,
2288 				struct bpf_prog *prog,
2289 				u32 *target_size);
2290 #else
2291 static inline bool bpf_sock_common_is_valid_access(int off, int size,
2292 						   enum bpf_access_type type,
2293 						   struct bpf_insn_access_aux *info)
2294 {
2295 	return false;
2296 }
2297 static inline bool bpf_sock_is_valid_access(int off, int size,
2298 					    enum bpf_access_type type,
2299 					    struct bpf_insn_access_aux *info)
2300 {
2301 	return false;
2302 }
2303 static inline u32 bpf_sock_convert_ctx_access(enum bpf_access_type type,
2304 					      const struct bpf_insn *si,
2305 					      struct bpf_insn *insn_buf,
2306 					      struct bpf_prog *prog,
2307 					      u32 *target_size)
2308 {
2309 	return 0;
2310 }
2311 #endif
2312 
2313 #ifdef CONFIG_INET
2314 struct sk_reuseport_kern {
2315 	struct sk_buff *skb;
2316 	struct sock *sk;
2317 	struct sock *selected_sk;
2318 	struct sock *migrating_sk;
2319 	void *data_end;
2320 	u32 hash;
2321 	u32 reuseport_id;
2322 	bool bind_inany;
2323 };
2324 bool bpf_tcp_sock_is_valid_access(int off, int size, enum bpf_access_type type,
2325 				  struct bpf_insn_access_aux *info);
2326 
2327 u32 bpf_tcp_sock_convert_ctx_access(enum bpf_access_type type,
2328 				    const struct bpf_insn *si,
2329 				    struct bpf_insn *insn_buf,
2330 				    struct bpf_prog *prog,
2331 				    u32 *target_size);
2332 
2333 bool bpf_xdp_sock_is_valid_access(int off, int size, enum bpf_access_type type,
2334 				  struct bpf_insn_access_aux *info);
2335 
2336 u32 bpf_xdp_sock_convert_ctx_access(enum bpf_access_type type,
2337 				    const struct bpf_insn *si,
2338 				    struct bpf_insn *insn_buf,
2339 				    struct bpf_prog *prog,
2340 				    u32 *target_size);
2341 #else
2342 static inline bool bpf_tcp_sock_is_valid_access(int off, int size,
2343 						enum bpf_access_type type,
2344 						struct bpf_insn_access_aux *info)
2345 {
2346 	return false;
2347 }
2348 
2349 static inline u32 bpf_tcp_sock_convert_ctx_access(enum bpf_access_type type,
2350 						  const struct bpf_insn *si,
2351 						  struct bpf_insn *insn_buf,
2352 						  struct bpf_prog *prog,
2353 						  u32 *target_size)
2354 {
2355 	return 0;
2356 }
2357 static inline bool bpf_xdp_sock_is_valid_access(int off, int size,
2358 						enum bpf_access_type type,
2359 						struct bpf_insn_access_aux *info)
2360 {
2361 	return false;
2362 }
2363 
2364 static inline u32 bpf_xdp_sock_convert_ctx_access(enum bpf_access_type type,
2365 						  const struct bpf_insn *si,
2366 						  struct bpf_insn *insn_buf,
2367 						  struct bpf_prog *prog,
2368 						  u32 *target_size)
2369 {
2370 	return 0;
2371 }
2372 #endif /* CONFIG_INET */
2373 
2374 enum bpf_text_poke_type {
2375 	BPF_MOD_CALL,
2376 	BPF_MOD_JUMP,
2377 };
2378 
2379 int bpf_arch_text_poke(void *ip, enum bpf_text_poke_type t,
2380 		       void *addr1, void *addr2);
2381 
2382 void *bpf_arch_text_copy(void *dst, void *src, size_t len);
2383 int bpf_arch_text_invalidate(void *dst, size_t len);
2384 
2385 struct btf_id_set;
2386 bool btf_id_set_contains(const struct btf_id_set *set, u32 id);
2387 
2388 #define MAX_BPRINTF_VARARGS		12
2389 
2390 int bpf_bprintf_prepare(char *fmt, u32 fmt_size, const u64 *raw_args,
2391 			u32 **bin_buf, u32 num_args);
2392 void bpf_bprintf_cleanup(void);
2393 
2394 /* the implementation of the opaque uapi struct bpf_dynptr */
2395 struct bpf_dynptr_kern {
2396 	void *data;
2397 	/* Size represents the number of usable bytes of dynptr data.
2398 	 * If for example the offset is at 4 for a local dynptr whose data is
2399 	 * of type u64, the number of usable bytes is 4.
2400 	 *
2401 	 * The upper 8 bits are reserved. It is as follows:
2402 	 * Bits 0 - 23 = size
2403 	 * Bits 24 - 30 = dynptr type
2404 	 * Bit 31 = whether dynptr is read-only
2405 	 */
2406 	u32 size;
2407 	u32 offset;
2408 } __aligned(8);
2409 
2410 enum bpf_dynptr_type {
2411 	BPF_DYNPTR_TYPE_INVALID,
2412 	/* Points to memory that is local to the bpf program */
2413 	BPF_DYNPTR_TYPE_LOCAL,
2414 	/* Underlying data is a ringbuf record */
2415 	BPF_DYNPTR_TYPE_RINGBUF,
2416 };
2417 
2418 void bpf_dynptr_init(struct bpf_dynptr_kern *ptr, void *data,
2419 		     enum bpf_dynptr_type type, u32 offset, u32 size);
2420 void bpf_dynptr_set_null(struct bpf_dynptr_kern *ptr);
2421 int bpf_dynptr_check_size(u32 size);
2422 
2423 #endif /* _LINUX_BPF_H */
2424