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