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