1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
7 #include <uapi/linux/bpf.h>
9 #include <linux/workqueue.h>
10 #include <linux/file.h>
11 #include <linux/percpu.h>
12 #include <linux/err.h>
13 #include <linux/rbtree_latch.h>
14 #include <linux/numa.h>
15 #include <linux/mm_types.h>
16 #include <linux/wait.h>
17 #include <linux/refcount.h>
18 #include <linux/mutex.h>
19 #include <linux/module.h>
20 #include <linux/kallsyms.h>
21 #include <linux/capability.h>
22 #include <linux/sched/mm.h>
23 #include <linux/slab.h>
24 #include <linux/percpu-refcount.h>
25 #include <linux/bpfptr.h>
26 #include <linux/btf.h>
28 struct bpf_verifier_env;
29 struct bpf_verifier_log;
38 struct exception_table_entry;
39 struct seq_operations;
40 struct bpf_iter_aux_info;
41 struct bpf_local_storage;
42 struct bpf_local_storage_map;
46 struct bpf_func_state;
48 extern struct idr btf_idr;
49 extern spinlock_t btf_idr_lock;
50 extern struct kobject *btf_kobj;
52 typedef u64 (*bpf_callback_t)(u64, u64, u64, u64, u64);
53 typedef int (*bpf_iter_init_seq_priv_t)(void *private_data,
54 struct bpf_iter_aux_info *aux);
55 typedef void (*bpf_iter_fini_seq_priv_t)(void *private_data);
56 struct bpf_iter_seq_info {
57 const struct seq_operations *seq_ops;
58 bpf_iter_init_seq_priv_t init_seq_private;
59 bpf_iter_fini_seq_priv_t fini_seq_private;
63 /* map is generic key/value storage optionally accessible by eBPF programs */
65 /* funcs callable from userspace (via syscall) */
66 int (*map_alloc_check)(union bpf_attr *attr);
67 struct bpf_map *(*map_alloc)(union bpf_attr *attr);
68 void (*map_release)(struct bpf_map *map, struct file *map_file);
69 void (*map_free)(struct bpf_map *map);
70 int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key);
71 void (*map_release_uref)(struct bpf_map *map);
72 void *(*map_lookup_elem_sys_only)(struct bpf_map *map, void *key);
73 int (*map_lookup_batch)(struct bpf_map *map, const union bpf_attr *attr,
74 union bpf_attr __user *uattr);
75 int (*map_lookup_and_delete_elem)(struct bpf_map *map, void *key,
76 void *value, u64 flags);
77 int (*map_lookup_and_delete_batch)(struct bpf_map *map,
78 const union bpf_attr *attr,
79 union bpf_attr __user *uattr);
80 int (*map_update_batch)(struct bpf_map *map, const union bpf_attr *attr,
81 union bpf_attr __user *uattr);
82 int (*map_delete_batch)(struct bpf_map *map, const union bpf_attr *attr,
83 union bpf_attr __user *uattr);
85 /* funcs callable from userspace and from eBPF programs */
86 void *(*map_lookup_elem)(struct bpf_map *map, void *key);
87 int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags);
88 int (*map_delete_elem)(struct bpf_map *map, void *key);
89 int (*map_push_elem)(struct bpf_map *map, void *value, u64 flags);
90 int (*map_pop_elem)(struct bpf_map *map, void *value);
91 int (*map_peek_elem)(struct bpf_map *map, void *value);
92 void *(*map_lookup_percpu_elem)(struct bpf_map *map, void *key, u32 cpu);
94 /* funcs called by prog_array and perf_event_array map */
95 void *(*map_fd_get_ptr)(struct bpf_map *map, struct file *map_file,
97 void (*map_fd_put_ptr)(void *ptr);
98 int (*map_gen_lookup)(struct bpf_map *map, struct bpf_insn *insn_buf);
99 u32 (*map_fd_sys_lookup_elem)(void *ptr);
100 void (*map_seq_show_elem)(struct bpf_map *map, void *key,
102 int (*map_check_btf)(const struct bpf_map *map,
103 const struct btf *btf,
104 const struct btf_type *key_type,
105 const struct btf_type *value_type);
107 /* Prog poke tracking helpers. */
108 int (*map_poke_track)(struct bpf_map *map, struct bpf_prog_aux *aux);
109 void (*map_poke_untrack)(struct bpf_map *map, struct bpf_prog_aux *aux);
110 void (*map_poke_run)(struct bpf_map *map, u32 key, struct bpf_prog *old,
111 struct bpf_prog *new);
113 /* Direct value access helpers. */
114 int (*map_direct_value_addr)(const struct bpf_map *map,
116 int (*map_direct_value_meta)(const struct bpf_map *map,
118 int (*map_mmap)(struct bpf_map *map, struct vm_area_struct *vma);
119 __poll_t (*map_poll)(struct bpf_map *map, struct file *filp,
120 struct poll_table_struct *pts);
122 /* Functions called by bpf_local_storage maps */
123 int (*map_local_storage_charge)(struct bpf_local_storage_map *smap,
124 void *owner, u32 size);
125 void (*map_local_storage_uncharge)(struct bpf_local_storage_map *smap,
126 void *owner, u32 size);
127 struct bpf_local_storage __rcu ** (*map_owner_storage_ptr)(void *owner);
130 int (*map_redirect)(struct bpf_map *map, u32 ifindex, u64 flags);
132 /* map_meta_equal must be implemented for maps that can be
133 * used as an inner map. It is a runtime check to ensure
134 * an inner map can be inserted to an outer map.
136 * Some properties of the inner map has been used during the
137 * verification time. When inserting an inner map at the runtime,
138 * map_meta_equal has to ensure the inserting map has the same
139 * properties that the verifier has used earlier.
141 bool (*map_meta_equal)(const struct bpf_map *meta0,
142 const struct bpf_map *meta1);
145 int (*map_set_for_each_callback_args)(struct bpf_verifier_env *env,
146 struct bpf_func_state *caller,
147 struct bpf_func_state *callee);
148 int (*map_for_each_callback)(struct bpf_map *map,
149 bpf_callback_t callback_fn,
150 void *callback_ctx, u64 flags);
152 /* BTF id of struct allocated by map_alloc */
155 /* bpf_iter info used to open a seq_file */
156 const struct bpf_iter_seq_info *iter_seq_info;
160 /* Support at most 8 pointers in a BPF map value */
161 BPF_MAP_VALUE_OFF_MAX = 8,
162 BPF_MAP_OFF_ARR_MAX = BPF_MAP_VALUE_OFF_MAX +
163 1 + /* for bpf_spin_lock */
164 1, /* for bpf_timer */
172 struct bpf_map_value_off_desc {
174 enum bpf_kptr_type type;
177 struct module *module;
178 btf_dtor_kfunc_t dtor;
183 struct bpf_map_value_off {
185 struct bpf_map_value_off_desc off[];
188 struct bpf_map_off_arr {
190 u32 field_off[BPF_MAP_OFF_ARR_MAX];
191 u8 field_sz[BPF_MAP_OFF_ARR_MAX];
195 /* The first two cachelines with read-mostly members of which some
196 * are also accessed in fast-path (e.g. ops, max_entries).
198 const struct bpf_map_ops *ops ____cacheline_aligned;
199 struct bpf_map *inner_map_meta;
200 #ifdef CONFIG_SECURITY
203 enum bpf_map_type map_type;
207 u64 map_extra; /* any per-map-type extra fields */
209 int spin_lock_off; /* >=0 valid offset, <0 error */
210 struct bpf_map_value_off *kptr_off_tab;
211 int timer_off; /* >=0 valid offset, <0 error */
215 u32 btf_value_type_id;
216 u32 btf_vmlinux_value_type_id;
218 #ifdef CONFIG_MEMCG_KMEM
219 struct mem_cgroup *memcg;
221 char name[BPF_OBJ_NAME_LEN];
222 struct bpf_map_off_arr *off_arr;
223 /* The 3rd and 4th cacheline with misc members to avoid false sharing
224 * particularly with refcounting.
226 atomic64_t refcnt ____cacheline_aligned;
228 struct work_struct work;
229 struct mutex freeze_mutex;
231 /* 'Ownership' of program-containing map is claimed by the first program
232 * that is going to use this map or by the first program which FD is
233 * stored in the map to make sure that all callers and callees have the
234 * same prog type, JITed flag and xdp_has_frags flag.
238 enum bpf_prog_type type;
243 bool frozen; /* write-once; write-protected by freeze_mutex */
246 static inline bool map_value_has_spin_lock(const struct bpf_map *map)
248 return map->spin_lock_off >= 0;
251 static inline bool map_value_has_timer(const struct bpf_map *map)
253 return map->timer_off >= 0;
256 static inline bool map_value_has_kptrs(const struct bpf_map *map)
258 return !IS_ERR_OR_NULL(map->kptr_off_tab);
261 static inline void check_and_init_map_value(struct bpf_map *map, void *dst)
263 if (unlikely(map_value_has_spin_lock(map)))
264 memset(dst + map->spin_lock_off, 0, sizeof(struct bpf_spin_lock));
265 if (unlikely(map_value_has_timer(map)))
266 memset(dst + map->timer_off, 0, sizeof(struct bpf_timer));
267 if (unlikely(map_value_has_kptrs(map))) {
268 struct bpf_map_value_off *tab = map->kptr_off_tab;
271 for (i = 0; i < tab->nr_off; i++)
272 *(u64 *)(dst + tab->off[i].offset) = 0;
276 /* copy everything but bpf_spin_lock and bpf_timer. There could be one of each. */
277 static inline void copy_map_value(struct bpf_map *map, void *dst, void *src)
282 if (likely(!map->off_arr)) {
283 memcpy(dst, src, map->value_size);
287 for (i = 0; i < map->off_arr->cnt; i++) {
288 u32 next_off = map->off_arr->field_off[i];
290 memcpy(dst + curr_off, src + curr_off, next_off - curr_off);
291 curr_off += map->off_arr->field_sz[i];
293 memcpy(dst + curr_off, src + curr_off, map->value_size - curr_off);
295 void copy_map_value_locked(struct bpf_map *map, void *dst, void *src,
297 void bpf_timer_cancel_and_free(void *timer);
298 int bpf_obj_name_cpy(char *dst, const char *src, unsigned int size);
300 struct bpf_offload_dev;
301 struct bpf_offloaded_map;
303 struct bpf_map_dev_ops {
304 int (*map_get_next_key)(struct bpf_offloaded_map *map,
305 void *key, void *next_key);
306 int (*map_lookup_elem)(struct bpf_offloaded_map *map,
307 void *key, void *value);
308 int (*map_update_elem)(struct bpf_offloaded_map *map,
309 void *key, void *value, u64 flags);
310 int (*map_delete_elem)(struct bpf_offloaded_map *map, void *key);
313 struct bpf_offloaded_map {
315 struct net_device *netdev;
316 const struct bpf_map_dev_ops *dev_ops;
318 struct list_head offloads;
321 static inline struct bpf_offloaded_map *map_to_offmap(struct bpf_map *map)
323 return container_of(map, struct bpf_offloaded_map, map);
326 static inline bool bpf_map_offload_neutral(const struct bpf_map *map)
328 return map->map_type == BPF_MAP_TYPE_PERF_EVENT_ARRAY;
331 static inline bool bpf_map_support_seq_show(const struct bpf_map *map)
333 return (map->btf_value_type_id || map->btf_vmlinux_value_type_id) &&
334 map->ops->map_seq_show_elem;
337 int map_check_no_btf(const struct bpf_map *map,
338 const struct btf *btf,
339 const struct btf_type *key_type,
340 const struct btf_type *value_type);
342 bool bpf_map_meta_equal(const struct bpf_map *meta0,
343 const struct bpf_map *meta1);
345 extern const struct bpf_map_ops bpf_map_offload_ops;
347 /* bpf_type_flag contains a set of flags that are applicable to the values of
348 * arg_type, ret_type and reg_type. For example, a pointer value may be null,
349 * or a memory is read-only. We classify types into two categories: base types
350 * and extended types. Extended types are base types combined with a type flag.
352 * Currently there are no more than 32 base types in arg_type, ret_type and
355 #define BPF_BASE_TYPE_BITS 8
358 /* PTR may be NULL. */
359 PTR_MAYBE_NULL = BIT(0 + BPF_BASE_TYPE_BITS),
361 /* MEM is read-only. When applied on bpf_arg, it indicates the arg is
362 * compatible with both mutable and immutable memory.
364 MEM_RDONLY = BIT(1 + BPF_BASE_TYPE_BITS),
366 /* MEM was "allocated" from a different helper, and cannot be mixed
367 * with regular non-MEM_ALLOC'ed MEM types.
369 MEM_ALLOC = BIT(2 + BPF_BASE_TYPE_BITS),
371 /* MEM is in user address space. */
372 MEM_USER = BIT(3 + BPF_BASE_TYPE_BITS),
374 /* MEM is a percpu memory. MEM_PERCPU tags PTR_TO_BTF_ID. When tagged
375 * with MEM_PERCPU, PTR_TO_BTF_ID _cannot_ be directly accessed. In
376 * order to drop this tag, it must be passed into bpf_per_cpu_ptr()
377 * or bpf_this_cpu_ptr(), which will return the pointer corresponding
378 * to the specified cpu.
380 MEM_PERCPU = BIT(4 + BPF_BASE_TYPE_BITS),
382 /* Indicates that the argument will be released. */
383 OBJ_RELEASE = BIT(5 + BPF_BASE_TYPE_BITS),
385 /* PTR is not trusted. This is only used with PTR_TO_BTF_ID, to mark
386 * unreferenced and referenced kptr loaded from map value using a load
387 * instruction, so that they can only be dereferenced but not escape the
388 * BPF program into the kernel (i.e. cannot be passed as arguments to
389 * kfunc or bpf helpers).
391 PTR_UNTRUSTED = BIT(6 + BPF_BASE_TYPE_BITS),
393 MEM_UNINIT = BIT(7 + BPF_BASE_TYPE_BITS),
395 /* DYNPTR points to memory local to the bpf program. */
396 DYNPTR_TYPE_LOCAL = BIT(8 + BPF_BASE_TYPE_BITS),
399 __BPF_TYPE_LAST_FLAG = __BPF_TYPE_FLAG_MAX - 1,
402 #define DYNPTR_TYPE_FLAG_MASK DYNPTR_TYPE_LOCAL
404 /* Max number of base types. */
405 #define BPF_BASE_TYPE_LIMIT (1UL << BPF_BASE_TYPE_BITS)
407 /* Max number of all types. */
408 #define BPF_TYPE_LIMIT (__BPF_TYPE_LAST_FLAG | (__BPF_TYPE_LAST_FLAG - 1))
410 /* function argument constraints */
412 ARG_DONTCARE = 0, /* unused argument in helper function */
414 /* the following constraints used to prototype
415 * bpf_map_lookup/update/delete_elem() functions
417 ARG_CONST_MAP_PTR, /* const argument used as pointer to bpf_map */
418 ARG_PTR_TO_MAP_KEY, /* pointer to stack used as map key */
419 ARG_PTR_TO_MAP_VALUE, /* pointer to stack used as map value */
421 /* Used to prototype bpf_memcmp() and other functions that access data
422 * on eBPF program stack
424 ARG_PTR_TO_MEM, /* pointer to valid memory (stack, packet, map value) */
426 ARG_CONST_SIZE, /* number of bytes accessed from memory */
427 ARG_CONST_SIZE_OR_ZERO, /* number of bytes accessed from memory or 0 */
429 ARG_PTR_TO_CTX, /* pointer to context */
430 ARG_ANYTHING, /* any (initialized) argument is ok */
431 ARG_PTR_TO_SPIN_LOCK, /* pointer to bpf_spin_lock */
432 ARG_PTR_TO_SOCK_COMMON, /* pointer to sock_common */
433 ARG_PTR_TO_INT, /* pointer to int */
434 ARG_PTR_TO_LONG, /* pointer to long */
435 ARG_PTR_TO_SOCKET, /* pointer to bpf_sock (fullsock) */
436 ARG_PTR_TO_BTF_ID, /* pointer to in-kernel struct */
437 ARG_PTR_TO_ALLOC_MEM, /* pointer to dynamically allocated memory */
438 ARG_CONST_ALLOC_SIZE_OR_ZERO, /* number of allocated bytes requested */
439 ARG_PTR_TO_BTF_ID_SOCK_COMMON, /* pointer to in-kernel sock_common or bpf-mirrored bpf_sock */
440 ARG_PTR_TO_PERCPU_BTF_ID, /* pointer to in-kernel percpu type */
441 ARG_PTR_TO_FUNC, /* pointer to a bpf program function */
442 ARG_PTR_TO_STACK, /* pointer to stack */
443 ARG_PTR_TO_CONST_STR, /* pointer to a null terminated read-only string */
444 ARG_PTR_TO_TIMER, /* pointer to bpf_timer */
445 ARG_PTR_TO_KPTR, /* pointer to referenced kptr */
446 ARG_PTR_TO_DYNPTR, /* pointer to bpf_dynptr. See bpf_type_flag for dynptr type */
449 /* Extended arg_types. */
450 ARG_PTR_TO_MAP_VALUE_OR_NULL = PTR_MAYBE_NULL | ARG_PTR_TO_MAP_VALUE,
451 ARG_PTR_TO_MEM_OR_NULL = PTR_MAYBE_NULL | ARG_PTR_TO_MEM,
452 ARG_PTR_TO_CTX_OR_NULL = PTR_MAYBE_NULL | ARG_PTR_TO_CTX,
453 ARG_PTR_TO_SOCKET_OR_NULL = PTR_MAYBE_NULL | ARG_PTR_TO_SOCKET,
454 ARG_PTR_TO_ALLOC_MEM_OR_NULL = PTR_MAYBE_NULL | ARG_PTR_TO_ALLOC_MEM,
455 ARG_PTR_TO_STACK_OR_NULL = PTR_MAYBE_NULL | ARG_PTR_TO_STACK,
456 ARG_PTR_TO_BTF_ID_OR_NULL = PTR_MAYBE_NULL | ARG_PTR_TO_BTF_ID,
457 /* pointer to memory does not need to be initialized, helper function must fill
458 * all bytes or clear them in error case.
460 ARG_PTR_TO_UNINIT_MEM = MEM_UNINIT | ARG_PTR_TO_MEM,
462 /* This must be the last entry. Its purpose is to ensure the enum is
463 * wide enough to hold the higher bits reserved for bpf_type_flag.
465 __BPF_ARG_TYPE_LIMIT = BPF_TYPE_LIMIT,
467 static_assert(__BPF_ARG_TYPE_MAX <= BPF_BASE_TYPE_LIMIT);
469 /* type of values returned from helper functions */
470 enum bpf_return_type {
471 RET_INTEGER, /* function returns integer */
472 RET_VOID, /* function doesn't return anything */
473 RET_PTR_TO_MAP_VALUE, /* returns a pointer to map elem value */
474 RET_PTR_TO_SOCKET, /* returns a pointer to a socket */
475 RET_PTR_TO_TCP_SOCK, /* returns a pointer to a tcp_sock */
476 RET_PTR_TO_SOCK_COMMON, /* returns a pointer to a sock_common */
477 RET_PTR_TO_ALLOC_MEM, /* returns a pointer to dynamically allocated memory */
478 RET_PTR_TO_MEM_OR_BTF_ID, /* returns a pointer to a valid memory or a btf_id */
479 RET_PTR_TO_BTF_ID, /* returns a pointer to a btf_id */
482 /* Extended ret_types. */
483 RET_PTR_TO_MAP_VALUE_OR_NULL = PTR_MAYBE_NULL | RET_PTR_TO_MAP_VALUE,
484 RET_PTR_TO_SOCKET_OR_NULL = PTR_MAYBE_NULL | RET_PTR_TO_SOCKET,
485 RET_PTR_TO_TCP_SOCK_OR_NULL = PTR_MAYBE_NULL | RET_PTR_TO_TCP_SOCK,
486 RET_PTR_TO_SOCK_COMMON_OR_NULL = PTR_MAYBE_NULL | RET_PTR_TO_SOCK_COMMON,
487 RET_PTR_TO_ALLOC_MEM_OR_NULL = PTR_MAYBE_NULL | MEM_ALLOC | RET_PTR_TO_ALLOC_MEM,
488 RET_PTR_TO_BTF_ID_OR_NULL = PTR_MAYBE_NULL | RET_PTR_TO_BTF_ID,
490 /* This must be the last entry. Its purpose is to ensure the enum is
491 * wide enough to hold the higher bits reserved for bpf_type_flag.
493 __BPF_RET_TYPE_LIMIT = BPF_TYPE_LIMIT,
495 static_assert(__BPF_RET_TYPE_MAX <= BPF_BASE_TYPE_LIMIT);
497 /* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
498 * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
499 * instructions after verifying
501 struct bpf_func_proto {
502 u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
505 enum bpf_return_type ret_type;
508 enum bpf_arg_type arg1_type;
509 enum bpf_arg_type arg2_type;
510 enum bpf_arg_type arg3_type;
511 enum bpf_arg_type arg4_type;
512 enum bpf_arg_type arg5_type;
514 enum bpf_arg_type arg_type[5];
526 int *ret_btf_id; /* return value btf_id */
527 bool (*allowed)(const struct bpf_prog *prog);
530 /* bpf_context is intentionally undefined structure. Pointer to bpf_context is
531 * the first argument to eBPF programs.
532 * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
536 enum bpf_access_type {
541 /* types of values stored in eBPF registers */
542 /* Pointer types represent:
545 * pointer + (u16) var
546 * pointer + (u16) var + imm
547 * if (range > 0) then [ptr, ptr + range - off) is safe to access
548 * if (id > 0) means that some 'var' was added
549 * if (off > 0) means that 'imm' was added
552 NOT_INIT = 0, /* nothing was written into register */
553 SCALAR_VALUE, /* reg doesn't contain a valid pointer */
554 PTR_TO_CTX, /* reg points to bpf_context */
555 CONST_PTR_TO_MAP, /* reg points to struct bpf_map */
556 PTR_TO_MAP_VALUE, /* reg points to map element value */
557 PTR_TO_MAP_KEY, /* reg points to a map element key */
558 PTR_TO_STACK, /* reg == frame_pointer + offset */
559 PTR_TO_PACKET_META, /* skb->data - meta_len */
560 PTR_TO_PACKET, /* reg points to skb->data */
561 PTR_TO_PACKET_END, /* skb->data + headlen */
562 PTR_TO_FLOW_KEYS, /* reg points to bpf_flow_keys */
563 PTR_TO_SOCKET, /* reg points to struct bpf_sock */
564 PTR_TO_SOCK_COMMON, /* reg points to sock_common */
565 PTR_TO_TCP_SOCK, /* reg points to struct tcp_sock */
566 PTR_TO_TP_BUFFER, /* reg points to a writable raw tp's buffer */
567 PTR_TO_XDP_SOCK, /* reg points to struct xdp_sock */
568 /* PTR_TO_BTF_ID points to a kernel struct that does not need
569 * to be null checked by the BPF program. This does not imply the
570 * pointer is _not_ null and in practice this can easily be a null
571 * pointer when reading pointer chains. The assumption is program
572 * context will handle null pointer dereference typically via fault
573 * handling. The verifier must keep this in mind and can make no
574 * assumptions about null or non-null when doing branch analysis.
575 * Further, when passed into helpers the helpers can not, without
576 * additional context, assume the value is non-null.
579 /* PTR_TO_BTF_ID_OR_NULL points to a kernel struct that has not
580 * been checked for null. Used primarily to inform the verifier
581 * an explicit null check is required for this struct.
583 PTR_TO_MEM, /* reg points to valid memory region */
584 PTR_TO_BUF, /* reg points to a read/write buffer */
585 PTR_TO_FUNC, /* reg points to a bpf program function */
588 /* Extended reg_types. */
589 PTR_TO_MAP_VALUE_OR_NULL = PTR_MAYBE_NULL | PTR_TO_MAP_VALUE,
590 PTR_TO_SOCKET_OR_NULL = PTR_MAYBE_NULL | PTR_TO_SOCKET,
591 PTR_TO_SOCK_COMMON_OR_NULL = PTR_MAYBE_NULL | PTR_TO_SOCK_COMMON,
592 PTR_TO_TCP_SOCK_OR_NULL = PTR_MAYBE_NULL | PTR_TO_TCP_SOCK,
593 PTR_TO_BTF_ID_OR_NULL = PTR_MAYBE_NULL | PTR_TO_BTF_ID,
595 /* This must be the last entry. Its purpose is to ensure the enum is
596 * wide enough to hold the higher bits reserved for bpf_type_flag.
598 __BPF_REG_TYPE_LIMIT = BPF_TYPE_LIMIT,
600 static_assert(__BPF_REG_TYPE_MAX <= BPF_BASE_TYPE_LIMIT);
602 /* The information passed from prog-specific *_is_valid_access
603 * back to the verifier.
605 struct bpf_insn_access_aux {
606 enum bpf_reg_type reg_type;
614 struct bpf_verifier_log *log; /* for verbose logs */
618 bpf_ctx_record_field_size(struct bpf_insn_access_aux *aux, u32 size)
620 aux->ctx_field_size = size;
623 static inline bool bpf_pseudo_func(const struct bpf_insn *insn)
625 return insn->code == (BPF_LD | BPF_IMM | BPF_DW) &&
626 insn->src_reg == BPF_PSEUDO_FUNC;
629 struct bpf_prog_ops {
630 int (*test_run)(struct bpf_prog *prog, const union bpf_attr *kattr,
631 union bpf_attr __user *uattr);
634 struct bpf_verifier_ops {
635 /* return eBPF function prototype for verification */
636 const struct bpf_func_proto *
637 (*get_func_proto)(enum bpf_func_id func_id,
638 const struct bpf_prog *prog);
640 /* return true if 'size' wide access at offset 'off' within bpf_context
641 * with 'type' (read or write) is allowed
643 bool (*is_valid_access)(int off, int size, enum bpf_access_type type,
644 const struct bpf_prog *prog,
645 struct bpf_insn_access_aux *info);
646 int (*gen_prologue)(struct bpf_insn *insn, bool direct_write,
647 const struct bpf_prog *prog);
648 int (*gen_ld_abs)(const struct bpf_insn *orig,
649 struct bpf_insn *insn_buf);
650 u32 (*convert_ctx_access)(enum bpf_access_type type,
651 const struct bpf_insn *src,
652 struct bpf_insn *dst,
653 struct bpf_prog *prog, u32 *target_size);
654 int (*btf_struct_access)(struct bpf_verifier_log *log,
655 const struct btf *btf,
656 const struct btf_type *t, int off, int size,
657 enum bpf_access_type atype,
658 u32 *next_btf_id, enum bpf_type_flag *flag);
661 struct bpf_prog_offload_ops {
662 /* verifier basic callbacks */
663 int (*insn_hook)(struct bpf_verifier_env *env,
664 int insn_idx, int prev_insn_idx);
665 int (*finalize)(struct bpf_verifier_env *env);
666 /* verifier optimization callbacks (called after .finalize) */
667 int (*replace_insn)(struct bpf_verifier_env *env, u32 off,
668 struct bpf_insn *insn);
669 int (*remove_insns)(struct bpf_verifier_env *env, u32 off, u32 cnt);
670 /* program management callbacks */
671 int (*prepare)(struct bpf_prog *prog);
672 int (*translate)(struct bpf_prog *prog);
673 void (*destroy)(struct bpf_prog *prog);
676 struct bpf_prog_offload {
677 struct bpf_prog *prog;
678 struct net_device *netdev;
679 struct bpf_offload_dev *offdev;
681 struct list_head offloads;
688 enum bpf_cgroup_storage_type {
689 BPF_CGROUP_STORAGE_SHARED,
690 BPF_CGROUP_STORAGE_PERCPU,
691 __BPF_CGROUP_STORAGE_MAX
694 #define MAX_BPF_CGROUP_STORAGE_TYPE __BPF_CGROUP_STORAGE_MAX
696 /* The longest tracepoint has 12 args.
697 * See include/trace/bpf_probe.h
699 #define MAX_BPF_FUNC_ARGS 12
701 /* The maximum number of arguments passed through registers
702 * a single function may have.
704 #define MAX_BPF_FUNC_REG_ARGS 5
706 struct btf_func_model {
709 u8 arg_size[MAX_BPF_FUNC_ARGS];
712 /* Restore arguments before returning from trampoline to let original function
713 * continue executing. This flag is used for fentry progs when there are no
716 #define BPF_TRAMP_F_RESTORE_REGS BIT(0)
717 /* Call original function after fentry progs, but before fexit progs.
718 * Makes sense for fentry/fexit, normal calls and indirect calls.
720 #define BPF_TRAMP_F_CALL_ORIG BIT(1)
721 /* Skip current frame and return to parent. Makes sense for fentry/fexit
722 * programs only. Should not be used with normal calls and indirect calls.
724 #define BPF_TRAMP_F_SKIP_FRAME BIT(2)
725 /* Store IP address of the caller on the trampoline stack,
726 * so it's available for trampoline's programs.
728 #define BPF_TRAMP_F_IP_ARG BIT(3)
729 /* Return the return value of fentry prog. Only used by bpf_struct_ops. */
730 #define BPF_TRAMP_F_RET_FENTRY_RET BIT(4)
732 /* Each call __bpf_prog_enter + call bpf_func + call __bpf_prog_exit is ~50
735 #define BPF_MAX_TRAMP_LINKS 38
737 struct bpf_tramp_links {
738 struct bpf_tramp_link *links[BPF_MAX_TRAMP_LINKS];
742 struct bpf_tramp_run_ctx;
744 /* Different use cases for BPF trampoline:
745 * 1. replace nop at the function entry (kprobe equivalent)
746 * flags = BPF_TRAMP_F_RESTORE_REGS
747 * fentry = a set of programs to run before returning from trampoline
749 * 2. replace nop at the function entry (kprobe + kretprobe equivalent)
750 * flags = BPF_TRAMP_F_CALL_ORIG | BPF_TRAMP_F_SKIP_FRAME
751 * orig_call = fentry_ip + MCOUNT_INSN_SIZE
752 * fentry = a set of program to run before calling original function
753 * fexit = a set of program to run after original function
755 * 3. replace direct call instruction anywhere in the function body
756 * or assign a function pointer for indirect call (like tcp_congestion_ops->cong_avoid)
758 * fentry = a set of programs to run before returning from trampoline
759 * With flags = BPF_TRAMP_F_CALL_ORIG
760 * orig_call = original callback addr or direct function addr
761 * fentry = a set of program to run before calling original function
762 * fexit = a set of program to run after original function
764 struct bpf_tramp_image;
765 int arch_prepare_bpf_trampoline(struct bpf_tramp_image *tr, void *image, void *image_end,
766 const struct btf_func_model *m, u32 flags,
767 struct bpf_tramp_links *tlinks,
769 /* these two functions are called from generated trampoline */
770 u64 notrace __bpf_prog_enter(struct bpf_prog *prog, struct bpf_tramp_run_ctx *run_ctx);
771 void notrace __bpf_prog_exit(struct bpf_prog *prog, u64 start, struct bpf_tramp_run_ctx *run_ctx);
772 u64 notrace __bpf_prog_enter_sleepable(struct bpf_prog *prog, struct bpf_tramp_run_ctx *run_ctx);
773 void notrace __bpf_prog_exit_sleepable(struct bpf_prog *prog, u64 start,
774 struct bpf_tramp_run_ctx *run_ctx);
775 void notrace __bpf_tramp_enter(struct bpf_tramp_image *tr);
776 void notrace __bpf_tramp_exit(struct bpf_tramp_image *tr);
781 char name[KSYM_NAME_LEN];
782 struct list_head lnode;
783 struct latch_tree_node tnode;
787 enum bpf_tramp_prog_type {
790 BPF_TRAMP_MODIFY_RETURN,
792 BPF_TRAMP_REPLACE, /* more than MAX */
795 struct bpf_tramp_image {
797 struct bpf_ksym ksym;
798 struct percpu_ref pcref;
803 struct work_struct work;
807 struct bpf_trampoline {
808 /* hlist for trampoline_table */
809 struct hlist_node hlist;
810 /* serializes access to fields of this trampoline */
815 struct btf_func_model model;
819 /* if !NULL this is BPF_PROG_TYPE_EXT program that extends another BPF
820 * program by replacing one of its functions. func.addr is the address
821 * of the function it replaced.
823 struct bpf_prog *extension_prog;
824 /* list of BPF programs using this trampoline */
825 struct hlist_head progs_hlist[BPF_TRAMP_MAX];
826 /* Number of attached programs. A counter per kind. */
827 int progs_cnt[BPF_TRAMP_MAX];
828 /* Executable image of trampoline */
829 struct bpf_tramp_image *cur_image;
834 struct bpf_attach_target_info {
835 struct btf_func_model fmodel;
837 const char *tgt_name;
838 const struct btf_type *tgt_type;
841 #define BPF_DISPATCHER_MAX 48 /* Fits in 2048B */
843 struct bpf_dispatcher_prog {
844 struct bpf_prog *prog;
848 struct bpf_dispatcher {
849 /* dispatcher mutex */
852 struct bpf_dispatcher_prog progs[BPF_DISPATCHER_MAX];
856 struct bpf_ksym ksym;
859 static __always_inline __nocfi unsigned int bpf_dispatcher_nop_func(
861 const struct bpf_insn *insnsi,
862 unsigned int (*bpf_func)(const void *,
863 const struct bpf_insn *))
865 return bpf_func(ctx, insnsi);
868 #ifdef CONFIG_BPF_JIT
869 int bpf_trampoline_link_prog(struct bpf_tramp_link *link, struct bpf_trampoline *tr);
870 int bpf_trampoline_unlink_prog(struct bpf_tramp_link *link, struct bpf_trampoline *tr);
871 struct bpf_trampoline *bpf_trampoline_get(u64 key,
872 struct bpf_attach_target_info *tgt_info);
873 void bpf_trampoline_put(struct bpf_trampoline *tr);
874 int arch_prepare_bpf_dispatcher(void *image, s64 *funcs, int num_funcs);
875 #define BPF_DISPATCHER_INIT(_name) { \
876 .mutex = __MUTEX_INITIALIZER(_name.mutex), \
877 .func = &_name##_func, \
884 .lnode = LIST_HEAD_INIT(_name.ksym.lnode), \
888 #define DEFINE_BPF_DISPATCHER(name) \
889 noinline __nocfi unsigned int bpf_dispatcher_##name##_func( \
891 const struct bpf_insn *insnsi, \
892 unsigned int (*bpf_func)(const void *, \
893 const struct bpf_insn *)) \
895 return bpf_func(ctx, insnsi); \
897 EXPORT_SYMBOL(bpf_dispatcher_##name##_func); \
898 struct bpf_dispatcher bpf_dispatcher_##name = \
899 BPF_DISPATCHER_INIT(bpf_dispatcher_##name);
900 #define DECLARE_BPF_DISPATCHER(name) \
901 unsigned int bpf_dispatcher_##name##_func( \
903 const struct bpf_insn *insnsi, \
904 unsigned int (*bpf_func)(const void *, \
905 const struct bpf_insn *)); \
906 extern struct bpf_dispatcher bpf_dispatcher_##name;
907 #define BPF_DISPATCHER_FUNC(name) bpf_dispatcher_##name##_func
908 #define BPF_DISPATCHER_PTR(name) (&bpf_dispatcher_##name)
909 void bpf_dispatcher_change_prog(struct bpf_dispatcher *d, struct bpf_prog *from,
910 struct bpf_prog *to);
911 /* Called only from JIT-enabled code, so there's no need for stubs. */
912 void *bpf_jit_alloc_exec_page(void);
913 void bpf_image_ksym_add(void *data, struct bpf_ksym *ksym);
914 void bpf_image_ksym_del(struct bpf_ksym *ksym);
915 void bpf_ksym_add(struct bpf_ksym *ksym);
916 void bpf_ksym_del(struct bpf_ksym *ksym);
917 int bpf_jit_charge_modmem(u32 size);
918 void bpf_jit_uncharge_modmem(u32 size);
919 bool bpf_prog_has_trampoline(const struct bpf_prog *prog);
921 static inline int bpf_trampoline_link_prog(struct bpf_tramp_link *link,
922 struct bpf_trampoline *tr)
926 static inline int bpf_trampoline_unlink_prog(struct bpf_tramp_link *link,
927 struct bpf_trampoline *tr)
931 static inline struct bpf_trampoline *bpf_trampoline_get(u64 key,
932 struct bpf_attach_target_info *tgt_info)
934 return ERR_PTR(-EOPNOTSUPP);
936 static inline void bpf_trampoline_put(struct bpf_trampoline *tr) {}
937 #define DEFINE_BPF_DISPATCHER(name)
938 #define DECLARE_BPF_DISPATCHER(name)
939 #define BPF_DISPATCHER_FUNC(name) bpf_dispatcher_nop_func
940 #define BPF_DISPATCHER_PTR(name) NULL
941 static inline void bpf_dispatcher_change_prog(struct bpf_dispatcher *d,
942 struct bpf_prog *from,
943 struct bpf_prog *to) {}
944 static inline bool is_bpf_image_address(unsigned long address)
948 static inline bool bpf_prog_has_trampoline(const struct bpf_prog *prog)
954 struct bpf_func_info_aux {
959 enum bpf_jit_poke_reason {
960 BPF_POKE_REASON_TAIL_CALL,
963 /* Descriptor of pokes pointing /into/ the JITed image. */
964 struct bpf_jit_poke_descriptor {
965 void *tailcall_target;
966 void *tailcall_bypass;
975 bool tailcall_target_stable;
981 /* reg_type info for ctx arguments */
982 struct bpf_ctx_arg_aux {
984 enum bpf_reg_type reg_type;
988 struct btf_mod_pair {
990 struct module *module;
993 struct bpf_kfunc_desc_tab;
995 struct bpf_prog_aux {
1004 u32 func_cnt; /* used by non-func prog as the number of func progs */
1005 u32 func_idx; /* 0 for non-func prog, the index in func array for func prog */
1006 u32 attach_btf_id; /* in-kernel BTF type id to attach to */
1007 u32 ctx_arg_info_size;
1008 u32 max_rdonly_access;
1009 u32 max_rdwr_access;
1010 struct btf *attach_btf;
1011 const struct bpf_ctx_arg_aux *ctx_arg_info;
1012 struct mutex dst_mutex; /* protects dst_* pointers below, *after* prog becomes visible */
1013 struct bpf_prog *dst_prog;
1014 struct bpf_trampoline *dst_trampoline;
1015 enum bpf_prog_type saved_dst_prog_type;
1016 enum bpf_attach_type saved_dst_attach_type;
1017 bool verifier_zext; /* Zero extensions has been inserted by verifier. */
1018 bool offload_requested;
1019 bool attach_btf_trace; /* true if attaching to BTF-enabled raw tp */
1020 bool func_proto_unreliable;
1022 bool tail_call_reachable;
1024 bool use_bpf_prog_pack;
1025 /* BTF_KIND_FUNC_PROTO for valid attach_btf_id */
1026 const struct btf_type *attach_func_proto;
1027 /* function name for valid attach_btf_id */
1028 const char *attach_func_name;
1029 struct bpf_prog **func;
1030 void *jit_data; /* JIT specific data. arch dependent */
1031 struct bpf_jit_poke_descriptor *poke_tab;
1032 struct bpf_kfunc_desc_tab *kfunc_tab;
1033 struct bpf_kfunc_btf_tab *kfunc_btf_tab;
1035 struct bpf_ksym ksym;
1036 const struct bpf_prog_ops *ops;
1037 struct bpf_map **used_maps;
1038 struct mutex used_maps_mutex; /* mutex for used_maps and used_map_cnt */
1039 struct btf_mod_pair *used_btfs;
1040 struct bpf_prog *prog;
1041 struct user_struct *user;
1042 u64 load_time; /* ns since boottime */
1044 struct bpf_map *cgroup_storage[MAX_BPF_CGROUP_STORAGE_TYPE];
1045 char name[BPF_OBJ_NAME_LEN];
1046 #ifdef CONFIG_SECURITY
1049 struct bpf_prog_offload *offload;
1051 struct bpf_func_info *func_info;
1052 struct bpf_func_info_aux *func_info_aux;
1053 /* bpf_line_info loaded from userspace. linfo->insn_off
1054 * has the xlated insn offset.
1055 * Both the main and sub prog share the same linfo.
1056 * The subprog can access its first linfo by
1057 * using the linfo_idx.
1059 struct bpf_line_info *linfo;
1060 /* jited_linfo is the jited addr of the linfo. It has a
1061 * one to one mapping to linfo:
1062 * jited_linfo[i] is the jited addr for the linfo[i]->insn_off.
1063 * Both the main and sub prog share the same jited_linfo.
1064 * The subprog can access its first jited_linfo by
1065 * using the linfo_idx.
1070 /* subprog can use linfo_idx to access its first linfo and
1072 * main prog always has linfo_idx == 0
1076 struct exception_table_entry *extable;
1078 struct work_struct work;
1079 struct rcu_head rcu;
1083 struct bpf_array_aux {
1084 /* Programs with direct jumps into programs part of this array. */
1085 struct list_head poke_progs;
1086 struct bpf_map *map;
1087 struct mutex poke_mutex;
1088 struct work_struct work;
1094 enum bpf_link_type type;
1095 const struct bpf_link_ops *ops;
1096 struct bpf_prog *prog;
1097 struct work_struct work;
1100 struct bpf_link_ops {
1101 void (*release)(struct bpf_link *link);
1102 void (*dealloc)(struct bpf_link *link);
1103 int (*detach)(struct bpf_link *link);
1104 int (*update_prog)(struct bpf_link *link, struct bpf_prog *new_prog,
1105 struct bpf_prog *old_prog);
1106 void (*show_fdinfo)(const struct bpf_link *link, struct seq_file *seq);
1107 int (*fill_link_info)(const struct bpf_link *link,
1108 struct bpf_link_info *info);
1111 struct bpf_tramp_link {
1112 struct bpf_link link;
1113 struct hlist_node tramp_hlist;
1117 struct bpf_tracing_link {
1118 struct bpf_tramp_link link;
1119 enum bpf_attach_type attach_type;
1120 struct bpf_trampoline *trampoline;
1121 struct bpf_prog *tgt_prog;
1124 struct bpf_link_primer {
1125 struct bpf_link *link;
1131 struct bpf_struct_ops_value;
1134 #define BPF_STRUCT_OPS_MAX_NR_MEMBERS 64
1135 struct bpf_struct_ops {
1136 const struct bpf_verifier_ops *verifier_ops;
1137 int (*init)(struct btf *btf);
1138 int (*check_member)(const struct btf_type *t,
1139 const struct btf_member *member);
1140 int (*init_member)(const struct btf_type *t,
1141 const struct btf_member *member,
1142 void *kdata, const void *udata);
1143 int (*reg)(void *kdata);
1144 void (*unreg)(void *kdata);
1145 const struct btf_type *type;
1146 const struct btf_type *value_type;
1148 struct btf_func_model func_models[BPF_STRUCT_OPS_MAX_NR_MEMBERS];
1153 #if defined(CONFIG_BPF_JIT) && defined(CONFIG_BPF_SYSCALL)
1154 #define BPF_MODULE_OWNER ((void *)((0xeB9FUL << 2) + POISON_POINTER_DELTA))
1155 const struct bpf_struct_ops *bpf_struct_ops_find(u32 type_id);
1156 void bpf_struct_ops_init(struct btf *btf, struct bpf_verifier_log *log);
1157 bool bpf_struct_ops_get(const void *kdata);
1158 void bpf_struct_ops_put(const void *kdata);
1159 int bpf_struct_ops_map_sys_lookup_elem(struct bpf_map *map, void *key,
1161 int bpf_struct_ops_prepare_trampoline(struct bpf_tramp_links *tlinks,
1162 struct bpf_tramp_link *link,
1163 const struct btf_func_model *model,
1164 void *image, void *image_end);
1165 static inline bool bpf_try_module_get(const void *data, struct module *owner)
1167 if (owner == BPF_MODULE_OWNER)
1168 return bpf_struct_ops_get(data);
1170 return try_module_get(owner);
1172 static inline void bpf_module_put(const void *data, struct module *owner)
1174 if (owner == BPF_MODULE_OWNER)
1175 bpf_struct_ops_put(data);
1181 /* Define it here to avoid the use of forward declaration */
1182 struct bpf_dummy_ops_state {
1186 struct bpf_dummy_ops {
1187 int (*test_1)(struct bpf_dummy_ops_state *cb);
1188 int (*test_2)(struct bpf_dummy_ops_state *cb, int a1, unsigned short a2,
1189 char a3, unsigned long a4);
1192 int bpf_struct_ops_test_run(struct bpf_prog *prog, const union bpf_attr *kattr,
1193 union bpf_attr __user *uattr);
1196 static inline const struct bpf_struct_ops *bpf_struct_ops_find(u32 type_id)
1200 static inline void bpf_struct_ops_init(struct btf *btf,
1201 struct bpf_verifier_log *log)
1204 static inline bool bpf_try_module_get(const void *data, struct module *owner)
1206 return try_module_get(owner);
1208 static inline void bpf_module_put(const void *data, struct module *owner)
1212 static inline int bpf_struct_ops_map_sys_lookup_elem(struct bpf_map *map,
1224 struct bpf_array_aux *aux;
1226 char value[0] __aligned(8);
1227 void *ptrs[0] __aligned(8);
1228 void __percpu *pptrs[0] __aligned(8);
1232 #define BPF_COMPLEXITY_LIMIT_INSNS 1000000 /* yes. 1M insns */
1233 #define MAX_TAIL_CALL_CNT 33
1235 #define BPF_F_ACCESS_MASK (BPF_F_RDONLY | \
1236 BPF_F_RDONLY_PROG | \
1240 #define BPF_MAP_CAN_READ BIT(0)
1241 #define BPF_MAP_CAN_WRITE BIT(1)
1243 static inline u32 bpf_map_flags_to_cap(struct bpf_map *map)
1245 u32 access_flags = map->map_flags & (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG);
1247 /* Combination of BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG is
1250 if (access_flags & BPF_F_RDONLY_PROG)
1251 return BPF_MAP_CAN_READ;
1252 else if (access_flags & BPF_F_WRONLY_PROG)
1253 return BPF_MAP_CAN_WRITE;
1255 return BPF_MAP_CAN_READ | BPF_MAP_CAN_WRITE;
1258 static inline bool bpf_map_flags_access_ok(u32 access_flags)
1260 return (access_flags & (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG)) !=
1261 (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG);
1264 struct bpf_event_entry {
1265 struct perf_event *event;
1266 struct file *perf_file;
1267 struct file *map_file;
1268 struct rcu_head rcu;
1271 static inline bool map_type_contains_progs(struct bpf_map *map)
1273 return map->map_type == BPF_MAP_TYPE_PROG_ARRAY ||
1274 map->map_type == BPF_MAP_TYPE_DEVMAP ||
1275 map->map_type == BPF_MAP_TYPE_CPUMAP;
1278 bool bpf_prog_map_compatible(struct bpf_map *map, const struct bpf_prog *fp);
1279 int bpf_prog_calc_tag(struct bpf_prog *fp);
1281 const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
1282 const struct bpf_func_proto *bpf_get_trace_vprintk_proto(void);
1284 typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src,
1285 unsigned long off, unsigned long len);
1286 typedef u32 (*bpf_convert_ctx_access_t)(enum bpf_access_type type,
1287 const struct bpf_insn *src,
1288 struct bpf_insn *dst,
1289 struct bpf_prog *prog,
1292 u64 bpf_event_output(struct bpf_map *map, u64 flags, void *meta, u64 meta_size,
1293 void *ctx, u64 ctx_size, bpf_ctx_copy_t ctx_copy);
1295 /* an array of programs to be executed under rcu_lock.
1298 * ret = bpf_prog_run_array(rcu_dereference(&bpf_prog_array), ctx, bpf_prog_run);
1300 * the structure returned by bpf_prog_array_alloc() should be populated
1301 * with program pointers and the last pointer must be NULL.
1302 * The user has to keep refcnt on the program and make sure the program
1303 * is removed from the array before bpf_prog_put().
1304 * The 'struct bpf_prog_array *' should only be replaced with xchg()
1305 * since other cpus are walking the array of pointers in parallel.
1307 struct bpf_prog_array_item {
1308 struct bpf_prog *prog;
1310 struct bpf_cgroup_storage *cgroup_storage[MAX_BPF_CGROUP_STORAGE_TYPE];
1315 struct bpf_prog_array {
1316 struct rcu_head rcu;
1317 struct bpf_prog_array_item items[];
1320 struct bpf_empty_prog_array {
1321 struct bpf_prog_array hdr;
1322 struct bpf_prog *null_prog;
1325 /* to avoid allocating empty bpf_prog_array for cgroups that
1326 * don't have bpf program attached use one global 'bpf_empty_prog_array'
1327 * It will not be modified the caller of bpf_prog_array_alloc()
1328 * (since caller requested prog_cnt == 0)
1329 * that pointer should be 'freed' by bpf_prog_array_free()
1331 extern struct bpf_empty_prog_array bpf_empty_prog_array;
1333 struct bpf_prog_array *bpf_prog_array_alloc(u32 prog_cnt, gfp_t flags);
1334 void bpf_prog_array_free(struct bpf_prog_array *progs);
1335 int bpf_prog_array_length(struct bpf_prog_array *progs);
1336 bool bpf_prog_array_is_empty(struct bpf_prog_array *array);
1337 int bpf_prog_array_copy_to_user(struct bpf_prog_array *progs,
1338 __u32 __user *prog_ids, u32 cnt);
1340 void bpf_prog_array_delete_safe(struct bpf_prog_array *progs,
1341 struct bpf_prog *old_prog);
1342 int bpf_prog_array_delete_safe_at(struct bpf_prog_array *array, int index);
1343 int bpf_prog_array_update_at(struct bpf_prog_array *array, int index,
1344 struct bpf_prog *prog);
1345 int bpf_prog_array_copy_info(struct bpf_prog_array *array,
1346 u32 *prog_ids, u32 request_cnt,
1348 int bpf_prog_array_copy(struct bpf_prog_array *old_array,
1349 struct bpf_prog *exclude_prog,
1350 struct bpf_prog *include_prog,
1352 struct bpf_prog_array **new_array);
1354 struct bpf_run_ctx {};
1356 struct bpf_cg_run_ctx {
1357 struct bpf_run_ctx run_ctx;
1358 const struct bpf_prog_array_item *prog_item;
1362 struct bpf_trace_run_ctx {
1363 struct bpf_run_ctx run_ctx;
1367 struct bpf_tramp_run_ctx {
1368 struct bpf_run_ctx run_ctx;
1370 struct bpf_run_ctx *saved_run_ctx;
1373 static inline struct bpf_run_ctx *bpf_set_run_ctx(struct bpf_run_ctx *new_ctx)
1375 struct bpf_run_ctx *old_ctx = NULL;
1377 #ifdef CONFIG_BPF_SYSCALL
1378 old_ctx = current->bpf_ctx;
1379 current->bpf_ctx = new_ctx;
1384 static inline void bpf_reset_run_ctx(struct bpf_run_ctx *old_ctx)
1386 #ifdef CONFIG_BPF_SYSCALL
1387 current->bpf_ctx = old_ctx;
1391 /* BPF program asks to bypass CAP_NET_BIND_SERVICE in bind. */
1392 #define BPF_RET_BIND_NO_CAP_NET_BIND_SERVICE (1 << 0)
1393 /* BPF program asks to set CN on the packet. */
1394 #define BPF_RET_SET_CN (1 << 0)
1396 typedef u32 (*bpf_prog_run_fn)(const struct bpf_prog *prog, const void *ctx);
1398 static __always_inline u32
1399 bpf_prog_run_array(const struct bpf_prog_array *array,
1400 const void *ctx, bpf_prog_run_fn run_prog)
1402 const struct bpf_prog_array_item *item;
1403 const struct bpf_prog *prog;
1404 struct bpf_run_ctx *old_run_ctx;
1405 struct bpf_trace_run_ctx run_ctx;
1408 RCU_LOCKDEP_WARN(!rcu_read_lock_held(), "no rcu lock held");
1410 if (unlikely(!array))
1414 old_run_ctx = bpf_set_run_ctx(&run_ctx.run_ctx);
1415 item = &array->items[0];
1416 while ((prog = READ_ONCE(item->prog))) {
1417 run_ctx.bpf_cookie = item->bpf_cookie;
1418 ret &= run_prog(prog, ctx);
1421 bpf_reset_run_ctx(old_run_ctx);
1426 #ifdef CONFIG_BPF_SYSCALL
1427 DECLARE_PER_CPU(int, bpf_prog_active);
1428 extern struct mutex bpf_stats_enabled_mutex;
1431 * Block execution of BPF programs attached to instrumentation (perf,
1432 * kprobes, tracepoints) to prevent deadlocks on map operations as any of
1433 * these events can happen inside a region which holds a map bucket lock
1434 * and can deadlock on it.
1436 static inline void bpf_disable_instrumentation(void)
1439 this_cpu_inc(bpf_prog_active);
1442 static inline void bpf_enable_instrumentation(void)
1444 this_cpu_dec(bpf_prog_active);
1448 extern const struct file_operations bpf_map_fops;
1449 extern const struct file_operations bpf_prog_fops;
1450 extern const struct file_operations bpf_iter_fops;
1452 #define BPF_PROG_TYPE(_id, _name, prog_ctx_type, kern_ctx_type) \
1453 extern const struct bpf_prog_ops _name ## _prog_ops; \
1454 extern const struct bpf_verifier_ops _name ## _verifier_ops;
1455 #define BPF_MAP_TYPE(_id, _ops) \
1456 extern const struct bpf_map_ops _ops;
1457 #define BPF_LINK_TYPE(_id, _name)
1458 #include <linux/bpf_types.h>
1459 #undef BPF_PROG_TYPE
1461 #undef BPF_LINK_TYPE
1463 extern const struct bpf_prog_ops bpf_offload_prog_ops;
1464 extern const struct bpf_verifier_ops tc_cls_act_analyzer_ops;
1465 extern const struct bpf_verifier_ops xdp_analyzer_ops;
1467 struct bpf_prog *bpf_prog_get(u32 ufd);
1468 struct bpf_prog *bpf_prog_get_type_dev(u32 ufd, enum bpf_prog_type type,
1470 void bpf_prog_add(struct bpf_prog *prog, int i);
1471 void bpf_prog_sub(struct bpf_prog *prog, int i);
1472 void bpf_prog_inc(struct bpf_prog *prog);
1473 struct bpf_prog * __must_check bpf_prog_inc_not_zero(struct bpf_prog *prog);
1474 void bpf_prog_put(struct bpf_prog *prog);
1476 void bpf_prog_free_id(struct bpf_prog *prog, bool do_idr_lock);
1477 void bpf_map_free_id(struct bpf_map *map, bool do_idr_lock);
1479 struct bpf_map_value_off_desc *bpf_map_kptr_off_contains(struct bpf_map *map, u32 offset);
1480 void bpf_map_free_kptr_off_tab(struct bpf_map *map);
1481 struct bpf_map_value_off *bpf_map_copy_kptr_off_tab(const struct bpf_map *map);
1482 bool bpf_map_equal_kptr_off_tab(const struct bpf_map *map_a, const struct bpf_map *map_b);
1483 void bpf_map_free_kptrs(struct bpf_map *map, void *map_value);
1485 struct bpf_map *bpf_map_get(u32 ufd);
1486 struct bpf_map *bpf_map_get_with_uref(u32 ufd);
1487 struct bpf_map *__bpf_map_get(struct fd f);
1488 void bpf_map_inc(struct bpf_map *map);
1489 void bpf_map_inc_with_uref(struct bpf_map *map);
1490 struct bpf_map * __must_check bpf_map_inc_not_zero(struct bpf_map *map);
1491 void bpf_map_put_with_uref(struct bpf_map *map);
1492 void bpf_map_put(struct bpf_map *map);
1493 void *bpf_map_area_alloc(u64 size, int numa_node);
1494 void *bpf_map_area_mmapable_alloc(u64 size, int numa_node);
1495 void bpf_map_area_free(void *base);
1496 bool bpf_map_write_active(const struct bpf_map *map);
1497 void bpf_map_init_from_attr(struct bpf_map *map, union bpf_attr *attr);
1498 int generic_map_lookup_batch(struct bpf_map *map,
1499 const union bpf_attr *attr,
1500 union bpf_attr __user *uattr);
1501 int generic_map_update_batch(struct bpf_map *map,
1502 const union bpf_attr *attr,
1503 union bpf_attr __user *uattr);
1504 int generic_map_delete_batch(struct bpf_map *map,
1505 const union bpf_attr *attr,
1506 union bpf_attr __user *uattr);
1507 struct bpf_map *bpf_map_get_curr_or_next(u32 *id);
1508 struct bpf_prog *bpf_prog_get_curr_or_next(u32 *id);
1510 #ifdef CONFIG_MEMCG_KMEM
1511 void *bpf_map_kmalloc_node(const struct bpf_map *map, size_t size, gfp_t flags,
1513 void *bpf_map_kzalloc(const struct bpf_map *map, size_t size, gfp_t flags);
1514 void __percpu *bpf_map_alloc_percpu(const struct bpf_map *map, size_t size,
1515 size_t align, gfp_t flags);
1517 static inline void *
1518 bpf_map_kmalloc_node(const struct bpf_map *map, size_t size, gfp_t flags,
1521 return kmalloc_node(size, flags, node);
1524 static inline void *
1525 bpf_map_kzalloc(const struct bpf_map *map, size_t size, gfp_t flags)
1527 return kzalloc(size, flags);
1530 static inline void __percpu *
1531 bpf_map_alloc_percpu(const struct bpf_map *map, size_t size, size_t align,
1534 return __alloc_percpu_gfp(size, align, flags);
1538 extern int sysctl_unprivileged_bpf_disabled;
1540 static inline bool bpf_allow_ptr_leaks(void)
1542 return perfmon_capable();
1545 static inline bool bpf_allow_uninit_stack(void)
1547 return perfmon_capable();
1550 static inline bool bpf_allow_ptr_to_map_access(void)
1552 return perfmon_capable();
1555 static inline bool bpf_bypass_spec_v1(void)
1557 return perfmon_capable();
1560 static inline bool bpf_bypass_spec_v4(void)
1562 return perfmon_capable();
1565 int bpf_map_new_fd(struct bpf_map *map, int flags);
1566 int bpf_prog_new_fd(struct bpf_prog *prog);
1568 void bpf_link_init(struct bpf_link *link, enum bpf_link_type type,
1569 const struct bpf_link_ops *ops, struct bpf_prog *prog);
1570 int bpf_link_prime(struct bpf_link *link, struct bpf_link_primer *primer);
1571 int bpf_link_settle(struct bpf_link_primer *primer);
1572 void bpf_link_cleanup(struct bpf_link_primer *primer);
1573 void bpf_link_inc(struct bpf_link *link);
1574 void bpf_link_put(struct bpf_link *link);
1575 int bpf_link_new_fd(struct bpf_link *link);
1576 struct file *bpf_link_new_file(struct bpf_link *link, int *reserved_fd);
1577 struct bpf_link *bpf_link_get_from_fd(u32 ufd);
1578 struct bpf_link *bpf_link_get_curr_or_next(u32 *id);
1580 int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
1581 int bpf_obj_get_user(const char __user *pathname, int flags);
1583 #define BPF_ITER_FUNC_PREFIX "bpf_iter_"
1584 #define DEFINE_BPF_ITER_FUNC(target, args...) \
1585 extern int bpf_iter_ ## target(args); \
1586 int __init bpf_iter_ ## target(args) { return 0; }
1588 struct bpf_iter_aux_info {
1589 struct bpf_map *map;
1592 typedef int (*bpf_iter_attach_target_t)(struct bpf_prog *prog,
1593 union bpf_iter_link_info *linfo,
1594 struct bpf_iter_aux_info *aux);
1595 typedef void (*bpf_iter_detach_target_t)(struct bpf_iter_aux_info *aux);
1596 typedef void (*bpf_iter_show_fdinfo_t) (const struct bpf_iter_aux_info *aux,
1597 struct seq_file *seq);
1598 typedef int (*bpf_iter_fill_link_info_t)(const struct bpf_iter_aux_info *aux,
1599 struct bpf_link_info *info);
1600 typedef const struct bpf_func_proto *
1601 (*bpf_iter_get_func_proto_t)(enum bpf_func_id func_id,
1602 const struct bpf_prog *prog);
1604 enum bpf_iter_feature {
1605 BPF_ITER_RESCHED = BIT(0),
1608 #define BPF_ITER_CTX_ARG_MAX 2
1609 struct bpf_iter_reg {
1611 bpf_iter_attach_target_t attach_target;
1612 bpf_iter_detach_target_t detach_target;
1613 bpf_iter_show_fdinfo_t show_fdinfo;
1614 bpf_iter_fill_link_info_t fill_link_info;
1615 bpf_iter_get_func_proto_t get_func_proto;
1616 u32 ctx_arg_info_size;
1618 struct bpf_ctx_arg_aux ctx_arg_info[BPF_ITER_CTX_ARG_MAX];
1619 const struct bpf_iter_seq_info *seq_info;
1622 struct bpf_iter_meta {
1623 __bpf_md_ptr(struct seq_file *, seq);
1628 struct bpf_iter__bpf_map_elem {
1629 __bpf_md_ptr(struct bpf_iter_meta *, meta);
1630 __bpf_md_ptr(struct bpf_map *, map);
1631 __bpf_md_ptr(void *, key);
1632 __bpf_md_ptr(void *, value);
1635 int bpf_iter_reg_target(const struct bpf_iter_reg *reg_info);
1636 void bpf_iter_unreg_target(const struct bpf_iter_reg *reg_info);
1637 bool bpf_iter_prog_supported(struct bpf_prog *prog);
1638 const struct bpf_func_proto *
1639 bpf_iter_get_func_proto(enum bpf_func_id func_id, const struct bpf_prog *prog);
1640 int bpf_iter_link_attach(const union bpf_attr *attr, bpfptr_t uattr, struct bpf_prog *prog);
1641 int bpf_iter_new_fd(struct bpf_link *link);
1642 bool bpf_link_is_iter(struct bpf_link *link);
1643 struct bpf_prog *bpf_iter_get_info(struct bpf_iter_meta *meta, bool in_stop);
1644 int bpf_iter_run_prog(struct bpf_prog *prog, void *ctx);
1645 void bpf_iter_map_show_fdinfo(const struct bpf_iter_aux_info *aux,
1646 struct seq_file *seq);
1647 int bpf_iter_map_fill_link_info(const struct bpf_iter_aux_info *aux,
1648 struct bpf_link_info *info);
1650 int map_set_for_each_callback_args(struct bpf_verifier_env *env,
1651 struct bpf_func_state *caller,
1652 struct bpf_func_state *callee);
1654 int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value);
1655 int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value);
1656 int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
1658 int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
1661 int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value);
1663 int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
1664 void *key, void *value, u64 map_flags);
1665 int bpf_fd_array_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
1666 int bpf_fd_htab_map_update_elem(struct bpf_map *map, struct file *map_file,
1667 void *key, void *value, u64 map_flags);
1668 int bpf_fd_htab_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
1670 int bpf_get_file_flag(int flags);
1671 int bpf_check_uarg_tail_zero(bpfptr_t uaddr, size_t expected_size,
1672 size_t actual_size);
1674 /* memcpy that is used with 8-byte aligned pointers, power-of-8 size and
1675 * forced to use 'long' read/writes to try to atomically copy long counters.
1676 * Best-effort only. No barriers here, since it _will_ race with concurrent
1677 * updates from BPF programs. Called from bpf syscall and mostly used with
1678 * size 8 or 16 bytes, so ask compiler to inline it.
1680 static inline void bpf_long_memcpy(void *dst, const void *src, u32 size)
1682 const long *lsrc = src;
1685 size /= sizeof(long);
1690 /* verify correctness of eBPF program */
1691 int bpf_check(struct bpf_prog **fp, union bpf_attr *attr, bpfptr_t uattr);
1693 #ifndef CONFIG_BPF_JIT_ALWAYS_ON
1694 void bpf_patch_call_args(struct bpf_insn *insn, u32 stack_depth);
1697 struct btf *bpf_get_btf_vmlinux(void);
1702 struct bpf_dtab_netdev;
1703 struct bpf_cpu_map_entry;
1705 void __dev_flush(void);
1706 int dev_xdp_enqueue(struct net_device *dev, struct xdp_frame *xdpf,
1707 struct net_device *dev_rx);
1708 int dev_map_enqueue(struct bpf_dtab_netdev *dst, struct xdp_frame *xdpf,
1709 struct net_device *dev_rx);
1710 int dev_map_enqueue_multi(struct xdp_frame *xdpf, struct net_device *dev_rx,
1711 struct bpf_map *map, bool exclude_ingress);
1712 int dev_map_generic_redirect(struct bpf_dtab_netdev *dst, struct sk_buff *skb,
1713 struct bpf_prog *xdp_prog);
1714 int dev_map_redirect_multi(struct net_device *dev, struct sk_buff *skb,
1715 struct bpf_prog *xdp_prog, struct bpf_map *map,
1716 bool exclude_ingress);
1718 void __cpu_map_flush(void);
1719 int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu, struct xdp_frame *xdpf,
1720 struct net_device *dev_rx);
1721 int cpu_map_generic_redirect(struct bpf_cpu_map_entry *rcpu,
1722 struct sk_buff *skb);
1724 /* Return map's numa specified by userspace */
1725 static inline int bpf_map_attr_numa_node(const union bpf_attr *attr)
1727 return (attr->map_flags & BPF_F_NUMA_NODE) ?
1728 attr->numa_node : NUMA_NO_NODE;
1731 struct bpf_prog *bpf_prog_get_type_path(const char *name, enum bpf_prog_type type);
1732 int array_map_alloc_check(union bpf_attr *attr);
1734 int bpf_prog_test_run_xdp(struct bpf_prog *prog, const union bpf_attr *kattr,
1735 union bpf_attr __user *uattr);
1736 int bpf_prog_test_run_skb(struct bpf_prog *prog, const union bpf_attr *kattr,
1737 union bpf_attr __user *uattr);
1738 int bpf_prog_test_run_tracing(struct bpf_prog *prog,
1739 const union bpf_attr *kattr,
1740 union bpf_attr __user *uattr);
1741 int bpf_prog_test_run_flow_dissector(struct bpf_prog *prog,
1742 const union bpf_attr *kattr,
1743 union bpf_attr __user *uattr);
1744 int bpf_prog_test_run_raw_tp(struct bpf_prog *prog,
1745 const union bpf_attr *kattr,
1746 union bpf_attr __user *uattr);
1747 int bpf_prog_test_run_sk_lookup(struct bpf_prog *prog,
1748 const union bpf_attr *kattr,
1749 union bpf_attr __user *uattr);
1750 bool btf_ctx_access(int off, int size, enum bpf_access_type type,
1751 const struct bpf_prog *prog,
1752 struct bpf_insn_access_aux *info);
1754 static inline bool bpf_tracing_ctx_access(int off, int size,
1755 enum bpf_access_type type)
1757 if (off < 0 || off >= sizeof(__u64) * MAX_BPF_FUNC_ARGS)
1759 if (type != BPF_READ)
1761 if (off % size != 0)
1766 static inline bool bpf_tracing_btf_ctx_access(int off, int size,
1767 enum bpf_access_type type,
1768 const struct bpf_prog *prog,
1769 struct bpf_insn_access_aux *info)
1771 if (!bpf_tracing_ctx_access(off, size, type))
1773 return btf_ctx_access(off, size, type, prog, info);
1776 int btf_struct_access(struct bpf_verifier_log *log, const struct btf *btf,
1777 const struct btf_type *t, int off, int size,
1778 enum bpf_access_type atype,
1779 u32 *next_btf_id, enum bpf_type_flag *flag);
1780 bool btf_struct_ids_match(struct bpf_verifier_log *log,
1781 const struct btf *btf, u32 id, int off,
1782 const struct btf *need_btf, u32 need_type_id,
1785 int btf_distill_func_proto(struct bpf_verifier_log *log,
1787 const struct btf_type *func_proto,
1788 const char *func_name,
1789 struct btf_func_model *m);
1791 struct bpf_reg_state;
1792 int btf_check_subprog_arg_match(struct bpf_verifier_env *env, int subprog,
1793 struct bpf_reg_state *regs);
1794 int btf_check_kfunc_arg_match(struct bpf_verifier_env *env,
1795 const struct btf *btf, u32 func_id,
1796 struct bpf_reg_state *regs);
1797 int btf_prepare_func_args(struct bpf_verifier_env *env, int subprog,
1798 struct bpf_reg_state *reg);
1799 int btf_check_type_match(struct bpf_verifier_log *log, const struct bpf_prog *prog,
1800 struct btf *btf, const struct btf_type *t);
1802 struct bpf_prog *bpf_prog_by_id(u32 id);
1803 struct bpf_link *bpf_link_by_id(u32 id);
1805 const struct bpf_func_proto *bpf_base_func_proto(enum bpf_func_id func_id);
1806 void bpf_task_storage_free(struct task_struct *task);
1807 bool bpf_prog_has_kfunc_call(const struct bpf_prog *prog);
1808 const struct btf_func_model *
1809 bpf_jit_find_kfunc_model(const struct bpf_prog *prog,
1810 const struct bpf_insn *insn);
1811 struct bpf_core_ctx {
1812 struct bpf_verifier_log *log;
1813 const struct btf *btf;
1816 int bpf_core_apply(struct bpf_core_ctx *ctx, const struct bpf_core_relo *relo,
1817 int relo_idx, void *insn);
1819 static inline bool unprivileged_ebpf_enabled(void)
1821 return !sysctl_unprivileged_bpf_disabled;
1824 #else /* !CONFIG_BPF_SYSCALL */
1825 static inline struct bpf_prog *bpf_prog_get(u32 ufd)
1827 return ERR_PTR(-EOPNOTSUPP);
1830 static inline struct bpf_prog *bpf_prog_get_type_dev(u32 ufd,
1831 enum bpf_prog_type type,
1834 return ERR_PTR(-EOPNOTSUPP);
1837 static inline void bpf_prog_add(struct bpf_prog *prog, int i)
1841 static inline void bpf_prog_sub(struct bpf_prog *prog, int i)
1845 static inline void bpf_prog_put(struct bpf_prog *prog)
1849 static inline void bpf_prog_inc(struct bpf_prog *prog)
1853 static inline struct bpf_prog *__must_check
1854 bpf_prog_inc_not_zero(struct bpf_prog *prog)
1856 return ERR_PTR(-EOPNOTSUPP);
1859 static inline void bpf_link_init(struct bpf_link *link, enum bpf_link_type type,
1860 const struct bpf_link_ops *ops,
1861 struct bpf_prog *prog)
1865 static inline int bpf_link_prime(struct bpf_link *link,
1866 struct bpf_link_primer *primer)
1871 static inline int bpf_link_settle(struct bpf_link_primer *primer)
1876 static inline void bpf_link_cleanup(struct bpf_link_primer *primer)
1880 static inline void bpf_link_inc(struct bpf_link *link)
1884 static inline void bpf_link_put(struct bpf_link *link)
1888 static inline int bpf_obj_get_user(const char __user *pathname, int flags)
1893 static inline void __dev_flush(void)
1898 struct bpf_dtab_netdev;
1899 struct bpf_cpu_map_entry;
1902 int dev_xdp_enqueue(struct net_device *dev, struct xdp_frame *xdpf,
1903 struct net_device *dev_rx)
1909 int dev_map_enqueue(struct bpf_dtab_netdev *dst, struct xdp_frame *xdpf,
1910 struct net_device *dev_rx)
1916 int dev_map_enqueue_multi(struct xdp_frame *xdpf, struct net_device *dev_rx,
1917 struct bpf_map *map, bool exclude_ingress)
1924 static inline int dev_map_generic_redirect(struct bpf_dtab_netdev *dst,
1925 struct sk_buff *skb,
1926 struct bpf_prog *xdp_prog)
1932 int dev_map_redirect_multi(struct net_device *dev, struct sk_buff *skb,
1933 struct bpf_prog *xdp_prog, struct bpf_map *map,
1934 bool exclude_ingress)
1939 static inline void __cpu_map_flush(void)
1943 static inline int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu,
1944 struct xdp_frame *xdpf,
1945 struct net_device *dev_rx)
1950 static inline int cpu_map_generic_redirect(struct bpf_cpu_map_entry *rcpu,
1951 struct sk_buff *skb)
1956 static inline struct bpf_prog *bpf_prog_get_type_path(const char *name,
1957 enum bpf_prog_type type)
1959 return ERR_PTR(-EOPNOTSUPP);
1962 static inline int bpf_prog_test_run_xdp(struct bpf_prog *prog,
1963 const union bpf_attr *kattr,
1964 union bpf_attr __user *uattr)
1969 static inline int bpf_prog_test_run_skb(struct bpf_prog *prog,
1970 const union bpf_attr *kattr,
1971 union bpf_attr __user *uattr)
1976 static inline int bpf_prog_test_run_tracing(struct bpf_prog *prog,
1977 const union bpf_attr *kattr,
1978 union bpf_attr __user *uattr)
1983 static inline int bpf_prog_test_run_flow_dissector(struct bpf_prog *prog,
1984 const union bpf_attr *kattr,
1985 union bpf_attr __user *uattr)
1990 static inline int bpf_prog_test_run_sk_lookup(struct bpf_prog *prog,
1991 const union bpf_attr *kattr,
1992 union bpf_attr __user *uattr)
1997 static inline void bpf_map_put(struct bpf_map *map)
2001 static inline struct bpf_prog *bpf_prog_by_id(u32 id)
2003 return ERR_PTR(-ENOTSUPP);
2006 static inline const struct bpf_func_proto *
2007 bpf_base_func_proto(enum bpf_func_id func_id)
2012 static inline void bpf_task_storage_free(struct task_struct *task)
2016 static inline bool bpf_prog_has_kfunc_call(const struct bpf_prog *prog)
2021 static inline const struct btf_func_model *
2022 bpf_jit_find_kfunc_model(const struct bpf_prog *prog,
2023 const struct bpf_insn *insn)
2028 static inline bool unprivileged_ebpf_enabled(void)
2033 #endif /* CONFIG_BPF_SYSCALL */
2035 void __bpf_free_used_btfs(struct bpf_prog_aux *aux,
2036 struct btf_mod_pair *used_btfs, u32 len);
2038 static inline struct bpf_prog *bpf_prog_get_type(u32 ufd,
2039 enum bpf_prog_type type)
2041 return bpf_prog_get_type_dev(ufd, type, false);
2044 void __bpf_free_used_maps(struct bpf_prog_aux *aux,
2045 struct bpf_map **used_maps, u32 len);
2047 bool bpf_prog_get_ok(struct bpf_prog *, enum bpf_prog_type *, bool);
2049 int bpf_prog_offload_compile(struct bpf_prog *prog);
2050 void bpf_prog_offload_destroy(struct bpf_prog *prog);
2051 int bpf_prog_offload_info_fill(struct bpf_prog_info *info,
2052 struct bpf_prog *prog);
2054 int bpf_map_offload_info_fill(struct bpf_map_info *info, struct bpf_map *map);
2056 int bpf_map_offload_lookup_elem(struct bpf_map *map, void *key, void *value);
2057 int bpf_map_offload_update_elem(struct bpf_map *map,
2058 void *key, void *value, u64 flags);
2059 int bpf_map_offload_delete_elem(struct bpf_map *map, void *key);
2060 int bpf_map_offload_get_next_key(struct bpf_map *map,
2061 void *key, void *next_key);
2063 bool bpf_offload_prog_map_match(struct bpf_prog *prog, struct bpf_map *map);
2065 struct bpf_offload_dev *
2066 bpf_offload_dev_create(const struct bpf_prog_offload_ops *ops, void *priv);
2067 void bpf_offload_dev_destroy(struct bpf_offload_dev *offdev);
2068 void *bpf_offload_dev_priv(struct bpf_offload_dev *offdev);
2069 int bpf_offload_dev_netdev_register(struct bpf_offload_dev *offdev,
2070 struct net_device *netdev);
2071 void bpf_offload_dev_netdev_unregister(struct bpf_offload_dev *offdev,
2072 struct net_device *netdev);
2073 bool bpf_offload_dev_match(struct bpf_prog *prog, struct net_device *netdev);
2075 #if defined(CONFIG_NET) && defined(CONFIG_BPF_SYSCALL)
2076 int bpf_prog_offload_init(struct bpf_prog *prog, union bpf_attr *attr);
2078 static inline bool bpf_prog_is_dev_bound(const struct bpf_prog_aux *aux)
2080 return aux->offload_requested;
2083 static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
2085 return unlikely(map->ops == &bpf_map_offload_ops);
2088 struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr);
2089 void bpf_map_offload_map_free(struct bpf_map *map);
2090 int bpf_prog_test_run_syscall(struct bpf_prog *prog,
2091 const union bpf_attr *kattr,
2092 union bpf_attr __user *uattr);
2094 int sock_map_get_from_fd(const union bpf_attr *attr, struct bpf_prog *prog);
2095 int sock_map_prog_detach(const union bpf_attr *attr, enum bpf_prog_type ptype);
2096 int sock_map_update_elem_sys(struct bpf_map *map, void *key, void *value, u64 flags);
2097 int sock_map_bpf_prog_query(const union bpf_attr *attr,
2098 union bpf_attr __user *uattr);
2100 void sock_map_unhash(struct sock *sk);
2101 void sock_map_close(struct sock *sk, long timeout);
2103 static inline int bpf_prog_offload_init(struct bpf_prog *prog,
2104 union bpf_attr *attr)
2109 static inline bool bpf_prog_is_dev_bound(struct bpf_prog_aux *aux)
2114 static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
2119 static inline struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr)
2121 return ERR_PTR(-EOPNOTSUPP);
2124 static inline void bpf_map_offload_map_free(struct bpf_map *map)
2128 static inline int bpf_prog_test_run_syscall(struct bpf_prog *prog,
2129 const union bpf_attr *kattr,
2130 union bpf_attr __user *uattr)
2135 #ifdef CONFIG_BPF_SYSCALL
2136 static inline int sock_map_get_from_fd(const union bpf_attr *attr,
2137 struct bpf_prog *prog)
2142 static inline int sock_map_prog_detach(const union bpf_attr *attr,
2143 enum bpf_prog_type ptype)
2148 static inline int sock_map_update_elem_sys(struct bpf_map *map, void *key, void *value,
2154 static inline int sock_map_bpf_prog_query(const union bpf_attr *attr,
2155 union bpf_attr __user *uattr)
2159 #endif /* CONFIG_BPF_SYSCALL */
2160 #endif /* CONFIG_NET && CONFIG_BPF_SYSCALL */
2162 #if defined(CONFIG_INET) && defined(CONFIG_BPF_SYSCALL)
2163 void bpf_sk_reuseport_detach(struct sock *sk);
2164 int bpf_fd_reuseport_array_lookup_elem(struct bpf_map *map, void *key,
2166 int bpf_fd_reuseport_array_update_elem(struct bpf_map *map, void *key,
2167 void *value, u64 map_flags);
2169 static inline void bpf_sk_reuseport_detach(struct sock *sk)
2173 #ifdef CONFIG_BPF_SYSCALL
2174 static inline int bpf_fd_reuseport_array_lookup_elem(struct bpf_map *map,
2175 void *key, void *value)
2180 static inline int bpf_fd_reuseport_array_update_elem(struct bpf_map *map,
2181 void *key, void *value,
2186 #endif /* CONFIG_BPF_SYSCALL */
2187 #endif /* defined(CONFIG_INET) && defined(CONFIG_BPF_SYSCALL) */
2189 /* verifier prototypes for helper functions called from eBPF programs */
2190 extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
2191 extern const struct bpf_func_proto bpf_map_update_elem_proto;
2192 extern const struct bpf_func_proto bpf_map_delete_elem_proto;
2193 extern const struct bpf_func_proto bpf_map_push_elem_proto;
2194 extern const struct bpf_func_proto bpf_map_pop_elem_proto;
2195 extern const struct bpf_func_proto bpf_map_peek_elem_proto;
2196 extern const struct bpf_func_proto bpf_map_lookup_percpu_elem_proto;
2198 extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
2199 extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
2200 extern const struct bpf_func_proto bpf_get_numa_node_id_proto;
2201 extern const struct bpf_func_proto bpf_tail_call_proto;
2202 extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
2203 extern const struct bpf_func_proto bpf_ktime_get_boot_ns_proto;
2204 extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
2205 extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
2206 extern const struct bpf_func_proto bpf_get_current_comm_proto;
2207 extern const struct bpf_func_proto bpf_get_stackid_proto;
2208 extern const struct bpf_func_proto bpf_get_stack_proto;
2209 extern const struct bpf_func_proto bpf_get_task_stack_proto;
2210 extern const struct bpf_func_proto bpf_get_stackid_proto_pe;
2211 extern const struct bpf_func_proto bpf_get_stack_proto_pe;
2212 extern const struct bpf_func_proto bpf_sock_map_update_proto;
2213 extern const struct bpf_func_proto bpf_sock_hash_update_proto;
2214 extern const struct bpf_func_proto bpf_get_current_cgroup_id_proto;
2215 extern const struct bpf_func_proto bpf_get_current_ancestor_cgroup_id_proto;
2216 extern const struct bpf_func_proto bpf_msg_redirect_hash_proto;
2217 extern const struct bpf_func_proto bpf_msg_redirect_map_proto;
2218 extern const struct bpf_func_proto bpf_sk_redirect_hash_proto;
2219 extern const struct bpf_func_proto bpf_sk_redirect_map_proto;
2220 extern const struct bpf_func_proto bpf_spin_lock_proto;
2221 extern const struct bpf_func_proto bpf_spin_unlock_proto;
2222 extern const struct bpf_func_proto bpf_get_local_storage_proto;
2223 extern const struct bpf_func_proto bpf_strtol_proto;
2224 extern const struct bpf_func_proto bpf_strtoul_proto;
2225 extern const struct bpf_func_proto bpf_tcp_sock_proto;
2226 extern const struct bpf_func_proto bpf_jiffies64_proto;
2227 extern const struct bpf_func_proto bpf_get_ns_current_pid_tgid_proto;
2228 extern const struct bpf_func_proto bpf_event_output_data_proto;
2229 extern const struct bpf_func_proto bpf_ringbuf_output_proto;
2230 extern const struct bpf_func_proto bpf_ringbuf_reserve_proto;
2231 extern const struct bpf_func_proto bpf_ringbuf_submit_proto;
2232 extern const struct bpf_func_proto bpf_ringbuf_discard_proto;
2233 extern const struct bpf_func_proto bpf_ringbuf_query_proto;
2234 extern const struct bpf_func_proto bpf_skc_to_tcp6_sock_proto;
2235 extern const struct bpf_func_proto bpf_skc_to_tcp_sock_proto;
2236 extern const struct bpf_func_proto bpf_skc_to_tcp_timewait_sock_proto;
2237 extern const struct bpf_func_proto bpf_skc_to_tcp_request_sock_proto;
2238 extern const struct bpf_func_proto bpf_skc_to_udp6_sock_proto;
2239 extern const struct bpf_func_proto bpf_skc_to_unix_sock_proto;
2240 extern const struct bpf_func_proto bpf_skc_to_mptcp_sock_proto;
2241 extern const struct bpf_func_proto bpf_copy_from_user_proto;
2242 extern const struct bpf_func_proto bpf_snprintf_btf_proto;
2243 extern const struct bpf_func_proto bpf_snprintf_proto;
2244 extern const struct bpf_func_proto bpf_per_cpu_ptr_proto;
2245 extern const struct bpf_func_proto bpf_this_cpu_ptr_proto;
2246 extern const struct bpf_func_proto bpf_ktime_get_coarse_ns_proto;
2247 extern const struct bpf_func_proto bpf_sock_from_file_proto;
2248 extern const struct bpf_func_proto bpf_get_socket_ptr_cookie_proto;
2249 extern const struct bpf_func_proto bpf_task_storage_get_proto;
2250 extern const struct bpf_func_proto bpf_task_storage_delete_proto;
2251 extern const struct bpf_func_proto bpf_for_each_map_elem_proto;
2252 extern const struct bpf_func_proto bpf_btf_find_by_name_kind_proto;
2253 extern const struct bpf_func_proto bpf_sk_setsockopt_proto;
2254 extern const struct bpf_func_proto bpf_sk_getsockopt_proto;
2255 extern const struct bpf_func_proto bpf_kallsyms_lookup_name_proto;
2256 extern const struct bpf_func_proto bpf_find_vma_proto;
2257 extern const struct bpf_func_proto bpf_loop_proto;
2258 extern const struct bpf_func_proto bpf_strncmp_proto;
2259 extern const struct bpf_func_proto bpf_copy_from_user_task_proto;
2260 extern const struct bpf_func_proto bpf_kptr_xchg_proto;
2262 const struct bpf_func_proto *tracing_prog_func_proto(
2263 enum bpf_func_id func_id, const struct bpf_prog *prog);
2265 /* Shared helpers among cBPF and eBPF. */
2266 void bpf_user_rnd_init_once(void);
2267 u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
2268 u64 bpf_get_raw_cpu_id(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
2270 #if defined(CONFIG_NET)
2271 bool bpf_sock_common_is_valid_access(int off, int size,
2272 enum bpf_access_type type,
2273 struct bpf_insn_access_aux *info);
2274 bool bpf_sock_is_valid_access(int off, int size, enum bpf_access_type type,
2275 struct bpf_insn_access_aux *info);
2276 u32 bpf_sock_convert_ctx_access(enum bpf_access_type type,
2277 const struct bpf_insn *si,
2278 struct bpf_insn *insn_buf,
2279 struct bpf_prog *prog,
2282 static inline bool bpf_sock_common_is_valid_access(int off, int size,
2283 enum bpf_access_type type,
2284 struct bpf_insn_access_aux *info)
2288 static inline bool bpf_sock_is_valid_access(int off, int size,
2289 enum bpf_access_type type,
2290 struct bpf_insn_access_aux *info)
2294 static inline u32 bpf_sock_convert_ctx_access(enum bpf_access_type type,
2295 const struct bpf_insn *si,
2296 struct bpf_insn *insn_buf,
2297 struct bpf_prog *prog,
2305 struct sk_reuseport_kern {
2306 struct sk_buff *skb;
2308 struct sock *selected_sk;
2309 struct sock *migrating_sk;
2315 bool bpf_tcp_sock_is_valid_access(int off, int size, enum bpf_access_type type,
2316 struct bpf_insn_access_aux *info);
2318 u32 bpf_tcp_sock_convert_ctx_access(enum bpf_access_type type,
2319 const struct bpf_insn *si,
2320 struct bpf_insn *insn_buf,
2321 struct bpf_prog *prog,
2324 bool bpf_xdp_sock_is_valid_access(int off, int size, enum bpf_access_type type,
2325 struct bpf_insn_access_aux *info);
2327 u32 bpf_xdp_sock_convert_ctx_access(enum bpf_access_type type,
2328 const struct bpf_insn *si,
2329 struct bpf_insn *insn_buf,
2330 struct bpf_prog *prog,
2333 static inline bool bpf_tcp_sock_is_valid_access(int off, int size,
2334 enum bpf_access_type type,
2335 struct bpf_insn_access_aux *info)
2340 static inline u32 bpf_tcp_sock_convert_ctx_access(enum bpf_access_type type,
2341 const struct bpf_insn *si,
2342 struct bpf_insn *insn_buf,
2343 struct bpf_prog *prog,
2348 static inline bool bpf_xdp_sock_is_valid_access(int off, int size,
2349 enum bpf_access_type type,
2350 struct bpf_insn_access_aux *info)
2355 static inline u32 bpf_xdp_sock_convert_ctx_access(enum bpf_access_type type,
2356 const struct bpf_insn *si,
2357 struct bpf_insn *insn_buf,
2358 struct bpf_prog *prog,
2363 #endif /* CONFIG_INET */
2365 enum bpf_text_poke_type {
2370 int bpf_arch_text_poke(void *ip, enum bpf_text_poke_type t,
2371 void *addr1, void *addr2);
2373 void *bpf_arch_text_copy(void *dst, void *src, size_t len);
2374 int bpf_arch_text_invalidate(void *dst, size_t len);
2377 bool btf_id_set_contains(const struct btf_id_set *set, u32 id);
2379 #define MAX_BPRINTF_VARARGS 12
2381 int bpf_bprintf_prepare(char *fmt, u32 fmt_size, const u64 *raw_args,
2382 u32 **bin_buf, u32 num_args);
2383 void bpf_bprintf_cleanup(void);
2385 /* the implementation of the opaque uapi struct bpf_dynptr */
2386 struct bpf_dynptr_kern {
2388 /* Size represents the number of usable bytes of dynptr data.
2389 * If for example the offset is at 4 for a local dynptr whose data is
2390 * of type u64, the number of usable bytes is 4.
2392 * The upper 8 bits are reserved. It is as follows:
2393 * Bits 0 - 23 = size
2394 * Bits 24 - 30 = dynptr type
2395 * Bit 31 = whether dynptr is read-only
2401 enum bpf_dynptr_type {
2402 BPF_DYNPTR_TYPE_INVALID,
2403 /* Points to memory that is local to the bpf program */
2404 BPF_DYNPTR_TYPE_LOCAL,
2407 #endif /* _LINUX_BPF_H */