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