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/wait.h>
16 #include <linux/u64_stats_sync.h>
18 struct bpf_verifier_env;
27 extern struct idr btf_idr;
28 extern spinlock_t btf_idr_lock;
30 /* map is generic key/value storage optionally accesible by eBPF programs */
32 /* funcs callable from userspace (via syscall) */
33 int (*map_alloc_check)(union bpf_attr *attr);
34 struct bpf_map *(*map_alloc)(union bpf_attr *attr);
35 void (*map_release)(struct bpf_map *map, struct file *map_file);
36 void (*map_free)(struct bpf_map *map);
37 int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key);
38 void (*map_release_uref)(struct bpf_map *map);
39 void *(*map_lookup_elem_sys_only)(struct bpf_map *map, void *key);
41 /* funcs callable from userspace and from eBPF programs */
42 void *(*map_lookup_elem)(struct bpf_map *map, void *key);
43 int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags);
44 int (*map_delete_elem)(struct bpf_map *map, void *key);
45 int (*map_push_elem)(struct bpf_map *map, void *value, u64 flags);
46 int (*map_pop_elem)(struct bpf_map *map, void *value);
47 int (*map_peek_elem)(struct bpf_map *map, void *value);
49 /* funcs called by prog_array and perf_event_array map */
50 void *(*map_fd_get_ptr)(struct bpf_map *map, struct file *map_file,
52 void (*map_fd_put_ptr)(void *ptr);
53 u32 (*map_gen_lookup)(struct bpf_map *map, struct bpf_insn *insn_buf);
54 u32 (*map_fd_sys_lookup_elem)(void *ptr);
55 void (*map_seq_show_elem)(struct bpf_map *map, void *key,
57 int (*map_check_btf)(const struct bpf_map *map,
58 const struct btf *btf,
59 const struct btf_type *key_type,
60 const struct btf_type *value_type);
62 /* Direct value access helpers. */
63 int (*map_direct_value_addr)(const struct bpf_map *map,
65 int (*map_direct_value_meta)(const struct bpf_map *map,
69 struct bpf_map_memory {
71 struct user_struct *user;
75 /* The first two cachelines with read-mostly members of which some
76 * are also accessed in fast-path (e.g. ops, max_entries).
78 const struct bpf_map_ops *ops ____cacheline_aligned;
79 struct bpf_map *inner_map_meta;
80 #ifdef CONFIG_SECURITY
83 enum bpf_map_type map_type;
88 int spin_lock_off; /* >=0 valid offset, <0 error */
92 u32 btf_value_type_id;
94 struct bpf_map_memory memory;
96 bool frozen; /* write-once */
99 /* The 3rd and 4th cacheline with misc members to avoid false sharing
100 * particularly with refcounting.
102 atomic_t refcnt ____cacheline_aligned;
104 struct work_struct work;
105 char name[BPF_OBJ_NAME_LEN];
108 static inline bool map_value_has_spin_lock(const struct bpf_map *map)
110 return map->spin_lock_off >= 0;
113 static inline void check_and_init_map_lock(struct bpf_map *map, void *dst)
115 if (likely(!map_value_has_spin_lock(map)))
117 *(struct bpf_spin_lock *)(dst + map->spin_lock_off) =
118 (struct bpf_spin_lock){};
121 /* copy everything but bpf_spin_lock */
122 static inline void copy_map_value(struct bpf_map *map, void *dst, void *src)
124 if (unlikely(map_value_has_spin_lock(map))) {
125 u32 off = map->spin_lock_off;
127 memcpy(dst, src, off);
128 memcpy(dst + off + sizeof(struct bpf_spin_lock),
129 src + off + sizeof(struct bpf_spin_lock),
130 map->value_size - off - sizeof(struct bpf_spin_lock));
132 memcpy(dst, src, map->value_size);
135 void copy_map_value_locked(struct bpf_map *map, void *dst, void *src,
138 struct bpf_offload_dev;
139 struct bpf_offloaded_map;
141 struct bpf_map_dev_ops {
142 int (*map_get_next_key)(struct bpf_offloaded_map *map,
143 void *key, void *next_key);
144 int (*map_lookup_elem)(struct bpf_offloaded_map *map,
145 void *key, void *value);
146 int (*map_update_elem)(struct bpf_offloaded_map *map,
147 void *key, void *value, u64 flags);
148 int (*map_delete_elem)(struct bpf_offloaded_map *map, void *key);
151 struct bpf_offloaded_map {
153 struct net_device *netdev;
154 const struct bpf_map_dev_ops *dev_ops;
156 struct list_head offloads;
159 static inline struct bpf_offloaded_map *map_to_offmap(struct bpf_map *map)
161 return container_of(map, struct bpf_offloaded_map, map);
164 static inline bool bpf_map_offload_neutral(const struct bpf_map *map)
166 return map->map_type == BPF_MAP_TYPE_PERF_EVENT_ARRAY;
169 static inline bool bpf_map_support_seq_show(const struct bpf_map *map)
171 return map->btf && map->ops->map_seq_show_elem;
174 int map_check_no_btf(const struct bpf_map *map,
175 const struct btf *btf,
176 const struct btf_type *key_type,
177 const struct btf_type *value_type);
179 extern const struct bpf_map_ops bpf_map_offload_ops;
181 /* function argument constraints */
183 ARG_DONTCARE = 0, /* unused argument in helper function */
185 /* the following constraints used to prototype
186 * bpf_map_lookup/update/delete_elem() functions
188 ARG_CONST_MAP_PTR, /* const argument used as pointer to bpf_map */
189 ARG_PTR_TO_MAP_KEY, /* pointer to stack used as map key */
190 ARG_PTR_TO_MAP_VALUE, /* pointer to stack used as map value */
191 ARG_PTR_TO_UNINIT_MAP_VALUE, /* pointer to valid memory used to store a map value */
192 ARG_PTR_TO_MAP_VALUE_OR_NULL, /* pointer to stack used as map value or NULL */
194 /* the following constraints used to prototype bpf_memcmp() and other
195 * functions that access data on eBPF program stack
197 ARG_PTR_TO_MEM, /* pointer to valid memory (stack, packet, map value) */
198 ARG_PTR_TO_MEM_OR_NULL, /* pointer to valid memory or NULL */
199 ARG_PTR_TO_UNINIT_MEM, /* pointer to memory does not need to be initialized,
200 * helper function must fill all bytes or clear
201 * them in error case.
204 ARG_CONST_SIZE, /* number of bytes accessed from memory */
205 ARG_CONST_SIZE_OR_ZERO, /* number of bytes accessed from memory or 0 */
207 ARG_PTR_TO_CTX, /* pointer to context */
208 ARG_ANYTHING, /* any (initialized) argument is ok */
209 ARG_PTR_TO_SPIN_LOCK, /* pointer to bpf_spin_lock */
210 ARG_PTR_TO_SOCK_COMMON, /* pointer to sock_common */
211 ARG_PTR_TO_INT, /* pointer to int */
212 ARG_PTR_TO_LONG, /* pointer to long */
213 ARG_PTR_TO_SOCKET, /* pointer to bpf_sock (fullsock) */
216 /* type of values returned from helper functions */
217 enum bpf_return_type {
218 RET_INTEGER, /* function returns integer */
219 RET_VOID, /* function doesn't return anything */
220 RET_PTR_TO_MAP_VALUE, /* returns a pointer to map elem value */
221 RET_PTR_TO_MAP_VALUE_OR_NULL, /* returns a pointer to map elem value or NULL */
222 RET_PTR_TO_SOCKET_OR_NULL, /* returns a pointer to a socket or NULL */
223 RET_PTR_TO_TCP_SOCK_OR_NULL, /* returns a pointer to a tcp_sock or NULL */
224 RET_PTR_TO_SOCK_COMMON_OR_NULL, /* returns a pointer to a sock_common or NULL */
227 /* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
228 * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
229 * instructions after verifying
231 struct bpf_func_proto {
232 u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
235 enum bpf_return_type ret_type;
236 enum bpf_arg_type arg1_type;
237 enum bpf_arg_type arg2_type;
238 enum bpf_arg_type arg3_type;
239 enum bpf_arg_type arg4_type;
240 enum bpf_arg_type arg5_type;
243 /* bpf_context is intentionally undefined structure. Pointer to bpf_context is
244 * the first argument to eBPF programs.
245 * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
249 enum bpf_access_type {
254 /* types of values stored in eBPF registers */
255 /* Pointer types represent:
258 * pointer + (u16) var
259 * pointer + (u16) var + imm
260 * if (range > 0) then [ptr, ptr + range - off) is safe to access
261 * if (id > 0) means that some 'var' was added
262 * if (off > 0) means that 'imm' was added
265 NOT_INIT = 0, /* nothing was written into register */
266 SCALAR_VALUE, /* reg doesn't contain a valid pointer */
267 PTR_TO_CTX, /* reg points to bpf_context */
268 CONST_PTR_TO_MAP, /* reg points to struct bpf_map */
269 PTR_TO_MAP_VALUE, /* reg points to map element value */
270 PTR_TO_MAP_VALUE_OR_NULL,/* points to map elem value or NULL */
271 PTR_TO_STACK, /* reg == frame_pointer + offset */
272 PTR_TO_PACKET_META, /* skb->data - meta_len */
273 PTR_TO_PACKET, /* reg points to skb->data */
274 PTR_TO_PACKET_END, /* skb->data + headlen */
275 PTR_TO_FLOW_KEYS, /* reg points to bpf_flow_keys */
276 PTR_TO_SOCKET, /* reg points to struct bpf_sock */
277 PTR_TO_SOCKET_OR_NULL, /* reg points to struct bpf_sock or NULL */
278 PTR_TO_SOCK_COMMON, /* reg points to sock_common */
279 PTR_TO_SOCK_COMMON_OR_NULL, /* reg points to sock_common or NULL */
280 PTR_TO_TCP_SOCK, /* reg points to struct tcp_sock */
281 PTR_TO_TCP_SOCK_OR_NULL, /* reg points to struct tcp_sock or NULL */
282 PTR_TO_TP_BUFFER, /* reg points to a writable raw tp's buffer */
283 PTR_TO_XDP_SOCK, /* reg points to struct xdp_sock */
286 /* The information passed from prog-specific *_is_valid_access
287 * back to the verifier.
289 struct bpf_insn_access_aux {
290 enum bpf_reg_type reg_type;
295 bpf_ctx_record_field_size(struct bpf_insn_access_aux *aux, u32 size)
297 aux->ctx_field_size = size;
300 struct bpf_prog_ops {
301 int (*test_run)(struct bpf_prog *prog, const union bpf_attr *kattr,
302 union bpf_attr __user *uattr);
305 struct bpf_verifier_ops {
306 /* return eBPF function prototype for verification */
307 const struct bpf_func_proto *
308 (*get_func_proto)(enum bpf_func_id func_id,
309 const struct bpf_prog *prog);
311 /* return true if 'size' wide access at offset 'off' within bpf_context
312 * with 'type' (read or write) is allowed
314 bool (*is_valid_access)(int off, int size, enum bpf_access_type type,
315 const struct bpf_prog *prog,
316 struct bpf_insn_access_aux *info);
317 int (*gen_prologue)(struct bpf_insn *insn, bool direct_write,
318 const struct bpf_prog *prog);
319 int (*gen_ld_abs)(const struct bpf_insn *orig,
320 struct bpf_insn *insn_buf);
321 u32 (*convert_ctx_access)(enum bpf_access_type type,
322 const struct bpf_insn *src,
323 struct bpf_insn *dst,
324 struct bpf_prog *prog, u32 *target_size);
327 struct bpf_prog_offload_ops {
328 /* verifier basic callbacks */
329 int (*insn_hook)(struct bpf_verifier_env *env,
330 int insn_idx, int prev_insn_idx);
331 int (*finalize)(struct bpf_verifier_env *env);
332 /* verifier optimization callbacks (called after .finalize) */
333 int (*replace_insn)(struct bpf_verifier_env *env, u32 off,
334 struct bpf_insn *insn);
335 int (*remove_insns)(struct bpf_verifier_env *env, u32 off, u32 cnt);
336 /* program management callbacks */
337 int (*prepare)(struct bpf_prog *prog);
338 int (*translate)(struct bpf_prog *prog);
339 void (*destroy)(struct bpf_prog *prog);
342 struct bpf_prog_offload {
343 struct bpf_prog *prog;
344 struct net_device *netdev;
345 struct bpf_offload_dev *offdev;
347 struct list_head offloads;
354 enum bpf_cgroup_storage_type {
355 BPF_CGROUP_STORAGE_SHARED,
356 BPF_CGROUP_STORAGE_PERCPU,
357 __BPF_CGROUP_STORAGE_MAX
360 #define MAX_BPF_CGROUP_STORAGE_TYPE __BPF_CGROUP_STORAGE_MAX
362 struct bpf_prog_stats {
365 struct u64_stats_sync syncp;
368 struct bpf_prog_aux {
376 u32 func_cnt; /* used by non-func prog as the number of func progs */
377 u32 func_idx; /* 0 for non-func prog, the index in func array for func prog */
378 bool verifier_zext; /* Zero extensions has been inserted by verifier. */
379 bool offload_requested;
380 struct bpf_prog **func;
381 void *jit_data; /* JIT specific data. arch dependent */
382 struct latch_tree_node ksym_tnode;
383 struct list_head ksym_lnode;
384 const struct bpf_prog_ops *ops;
385 struct bpf_map **used_maps;
386 struct bpf_prog *prog;
387 struct user_struct *user;
388 u64 load_time; /* ns since boottime */
389 struct bpf_map *cgroup_storage[MAX_BPF_CGROUP_STORAGE_TYPE];
390 char name[BPF_OBJ_NAME_LEN];
391 #ifdef CONFIG_SECURITY
394 struct bpf_prog_offload *offload;
396 struct bpf_func_info *func_info;
397 /* bpf_line_info loaded from userspace. linfo->insn_off
398 * has the xlated insn offset.
399 * Both the main and sub prog share the same linfo.
400 * The subprog can access its first linfo by
401 * using the linfo_idx.
403 struct bpf_line_info *linfo;
404 /* jited_linfo is the jited addr of the linfo. It has a
405 * one to one mapping to linfo:
406 * jited_linfo[i] is the jited addr for the linfo[i]->insn_off.
407 * Both the main and sub prog share the same jited_linfo.
408 * The subprog can access its first jited_linfo by
409 * using the linfo_idx.
414 /* subprog can use linfo_idx to access its first linfo and
416 * main prog always has linfo_idx == 0
419 struct bpf_prog_stats __percpu *stats;
421 struct work_struct work;
430 /* 'ownership' of prog_array is claimed by the first program that
431 * is going to use this map or by the first program which FD is stored
432 * in the map to make sure that all callers and callees have the same
433 * prog_type and JITed flag
435 enum bpf_prog_type owner_prog_type;
438 char value[0] __aligned(8);
439 void *ptrs[0] __aligned(8);
440 void __percpu *pptrs[0] __aligned(8);
444 #define BPF_COMPLEXITY_LIMIT_INSNS 1000000 /* yes. 1M insns */
445 #define MAX_TAIL_CALL_CNT 32
447 #define BPF_F_ACCESS_MASK (BPF_F_RDONLY | \
448 BPF_F_RDONLY_PROG | \
452 #define BPF_MAP_CAN_READ BIT(0)
453 #define BPF_MAP_CAN_WRITE BIT(1)
455 static inline u32 bpf_map_flags_to_cap(struct bpf_map *map)
457 u32 access_flags = map->map_flags & (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG);
459 /* Combination of BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG is
462 if (access_flags & BPF_F_RDONLY_PROG)
463 return BPF_MAP_CAN_READ;
464 else if (access_flags & BPF_F_WRONLY_PROG)
465 return BPF_MAP_CAN_WRITE;
467 return BPF_MAP_CAN_READ | BPF_MAP_CAN_WRITE;
470 static inline bool bpf_map_flags_access_ok(u32 access_flags)
472 return (access_flags & (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG)) !=
473 (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG);
476 struct bpf_event_entry {
477 struct perf_event *event;
478 struct file *perf_file;
479 struct file *map_file;
483 bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
484 int bpf_prog_calc_tag(struct bpf_prog *fp);
486 const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
488 typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src,
489 unsigned long off, unsigned long len);
490 typedef u32 (*bpf_convert_ctx_access_t)(enum bpf_access_type type,
491 const struct bpf_insn *src,
492 struct bpf_insn *dst,
493 struct bpf_prog *prog,
496 u64 bpf_event_output(struct bpf_map *map, u64 flags, void *meta, u64 meta_size,
497 void *ctx, u64 ctx_size, bpf_ctx_copy_t ctx_copy);
499 /* an array of programs to be executed under rcu_lock.
502 * ret = BPF_PROG_RUN_ARRAY(&bpf_prog_array, ctx, BPF_PROG_RUN);
504 * the structure returned by bpf_prog_array_alloc() should be populated
505 * with program pointers and the last pointer must be NULL.
506 * The user has to keep refcnt on the program and make sure the program
507 * is removed from the array before bpf_prog_put().
508 * The 'struct bpf_prog_array *' should only be replaced with xchg()
509 * since other cpus are walking the array of pointers in parallel.
511 struct bpf_prog_array_item {
512 struct bpf_prog *prog;
513 struct bpf_cgroup_storage *cgroup_storage[MAX_BPF_CGROUP_STORAGE_TYPE];
516 struct bpf_prog_array {
518 struct bpf_prog_array_item items[0];
521 struct bpf_prog_array *bpf_prog_array_alloc(u32 prog_cnt, gfp_t flags);
522 void bpf_prog_array_free(struct bpf_prog_array *progs);
523 int bpf_prog_array_length(struct bpf_prog_array *progs);
524 bool bpf_prog_array_is_empty(struct bpf_prog_array *array);
525 int bpf_prog_array_copy_to_user(struct bpf_prog_array *progs,
526 __u32 __user *prog_ids, u32 cnt);
528 void bpf_prog_array_delete_safe(struct bpf_prog_array *progs,
529 struct bpf_prog *old_prog);
530 int bpf_prog_array_copy_info(struct bpf_prog_array *array,
531 u32 *prog_ids, u32 request_cnt,
533 int bpf_prog_array_copy(struct bpf_prog_array *old_array,
534 struct bpf_prog *exclude_prog,
535 struct bpf_prog *include_prog,
536 struct bpf_prog_array **new_array);
538 #define __BPF_PROG_RUN_ARRAY(array, ctx, func, check_non_null, set_cg_storage) \
540 struct bpf_prog_array_item *_item; \
541 struct bpf_prog *_prog; \
542 struct bpf_prog_array *_array; \
546 _array = rcu_dereference(array); \
547 if (unlikely(check_non_null && !_array))\
549 _item = &_array->items[0]; \
550 while ((_prog = READ_ONCE(_item->prog))) { \
551 if (set_cg_storage) \
552 bpf_cgroup_storage_set(_item->cgroup_storage); \
553 _ret &= func(_prog, ctx); \
562 /* To be used by __cgroup_bpf_run_filter_skb for EGRESS BPF progs
563 * so BPF programs can request cwr for TCP packets.
565 * Current cgroup skb programs can only return 0 or 1 (0 to drop the
566 * packet. This macro changes the behavior so the low order bit
567 * indicates whether the packet should be dropped (0) or not (1)
568 * and the next bit is a congestion notification bit. This could be
569 * used by TCP to call tcp_enter_cwr()
571 * Hence, new allowed return values of CGROUP EGRESS BPF programs are:
574 * 2: drop packet and cn
575 * 3: keep packet and cn
577 * This macro then converts it to one of the NET_XMIT or an error
578 * code that is then interpreted as drop packet (and no cn):
579 * 0: NET_XMIT_SUCCESS skb should be transmitted
580 * 1: NET_XMIT_DROP skb should be dropped and cn
581 * 2: NET_XMIT_CN skb should be transmitted and cn
582 * 3: -EPERM skb should be dropped
584 #define BPF_PROG_CGROUP_INET_EGRESS_RUN_ARRAY(array, ctx, func) \
586 struct bpf_prog_array_item *_item; \
587 struct bpf_prog *_prog; \
588 struct bpf_prog_array *_array; \
594 _array = rcu_dereference(array); \
595 _item = &_array->items[0]; \
596 while ((_prog = READ_ONCE(_item->prog))) { \
597 bpf_cgroup_storage_set(_item->cgroup_storage); \
598 ret = func(_prog, ctx); \
606 _ret = (_cn ? NET_XMIT_CN : NET_XMIT_SUCCESS); \
608 _ret = (_cn ? NET_XMIT_DROP : -EPERM); \
612 #define BPF_PROG_RUN_ARRAY(array, ctx, func) \
613 __BPF_PROG_RUN_ARRAY(array, ctx, func, false, true)
615 #define BPF_PROG_RUN_ARRAY_CHECK(array, ctx, func) \
616 __BPF_PROG_RUN_ARRAY(array, ctx, func, true, false)
618 #ifdef CONFIG_BPF_SYSCALL
619 DECLARE_PER_CPU(int, bpf_prog_active);
621 extern const struct file_operations bpf_map_fops;
622 extern const struct file_operations bpf_prog_fops;
624 #define BPF_PROG_TYPE(_id, _name) \
625 extern const struct bpf_prog_ops _name ## _prog_ops; \
626 extern const struct bpf_verifier_ops _name ## _verifier_ops;
627 #define BPF_MAP_TYPE(_id, _ops) \
628 extern const struct bpf_map_ops _ops;
629 #include <linux/bpf_types.h>
633 extern const struct bpf_prog_ops bpf_offload_prog_ops;
634 extern const struct bpf_verifier_ops tc_cls_act_analyzer_ops;
635 extern const struct bpf_verifier_ops xdp_analyzer_ops;
637 struct bpf_prog *bpf_prog_get(u32 ufd);
638 struct bpf_prog *bpf_prog_get_type_dev(u32 ufd, enum bpf_prog_type type,
640 struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog, int i);
641 void bpf_prog_sub(struct bpf_prog *prog, int i);
642 struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog);
643 struct bpf_prog * __must_check bpf_prog_inc_not_zero(struct bpf_prog *prog);
644 void bpf_prog_put(struct bpf_prog *prog);
645 int __bpf_prog_charge(struct user_struct *user, u32 pages);
646 void __bpf_prog_uncharge(struct user_struct *user, u32 pages);
648 void bpf_prog_free_id(struct bpf_prog *prog, bool do_idr_lock);
649 void bpf_map_free_id(struct bpf_map *map, bool do_idr_lock);
651 struct bpf_map *bpf_map_get_with_uref(u32 ufd);
652 struct bpf_map *__bpf_map_get(struct fd f);
653 struct bpf_map * __must_check bpf_map_inc(struct bpf_map *map, bool uref);
654 struct bpf_map * __must_check bpf_map_inc_not_zero(struct bpf_map *map,
656 void bpf_map_put_with_uref(struct bpf_map *map);
657 void bpf_map_put(struct bpf_map *map);
658 int bpf_map_charge_memlock(struct bpf_map *map, u32 pages);
659 void bpf_map_uncharge_memlock(struct bpf_map *map, u32 pages);
660 int bpf_map_charge_init(struct bpf_map_memory *mem, u64 size);
661 void bpf_map_charge_finish(struct bpf_map_memory *mem);
662 void bpf_map_charge_move(struct bpf_map_memory *dst,
663 struct bpf_map_memory *src);
664 void *bpf_map_area_alloc(u64 size, int numa_node);
665 void bpf_map_area_free(void *base);
666 void bpf_map_init_from_attr(struct bpf_map *map, union bpf_attr *attr);
668 extern int sysctl_unprivileged_bpf_disabled;
670 int bpf_map_new_fd(struct bpf_map *map, int flags);
671 int bpf_prog_new_fd(struct bpf_prog *prog);
673 int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
674 int bpf_obj_get_user(const char __user *pathname, int flags);
676 int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value);
677 int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value);
678 int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
680 int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
683 int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value);
685 int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
686 void *key, void *value, u64 map_flags);
687 int bpf_fd_array_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
688 int bpf_fd_htab_map_update_elem(struct bpf_map *map, struct file *map_file,
689 void *key, void *value, u64 map_flags);
690 int bpf_fd_htab_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
692 int bpf_get_file_flag(int flags);
693 int bpf_check_uarg_tail_zero(void __user *uaddr, size_t expected_size,
696 /* memcpy that is used with 8-byte aligned pointers, power-of-8 size and
697 * forced to use 'long' read/writes to try to atomically copy long counters.
698 * Best-effort only. No barriers here, since it _will_ race with concurrent
699 * updates from BPF programs. Called from bpf syscall and mostly used with
700 * size 8 or 16 bytes, so ask compiler to inline it.
702 static inline void bpf_long_memcpy(void *dst, const void *src, u32 size)
704 const long *lsrc = src;
707 size /= sizeof(long);
712 /* verify correctness of eBPF program */
713 int bpf_check(struct bpf_prog **fp, union bpf_attr *attr,
714 union bpf_attr __user *uattr);
716 #ifndef CONFIG_BPF_JIT_ALWAYS_ON
717 void bpf_patch_call_args(struct bpf_insn *insn, u32 stack_depth);
724 struct bpf_dtab_netdev *__dev_map_lookup_elem(struct bpf_map *map, u32 key);
725 struct bpf_dtab_netdev *__dev_map_hash_lookup_elem(struct bpf_map *map, u32 key);
726 void __dev_map_flush(struct bpf_map *map);
727 int dev_map_enqueue(struct bpf_dtab_netdev *dst, struct xdp_buff *xdp,
728 struct net_device *dev_rx);
729 int dev_map_generic_redirect(struct bpf_dtab_netdev *dst, struct sk_buff *skb,
730 struct bpf_prog *xdp_prog);
732 struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key);
733 void __cpu_map_flush(struct bpf_map *map);
734 int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu, struct xdp_buff *xdp,
735 struct net_device *dev_rx);
737 /* Return map's numa specified by userspace */
738 static inline int bpf_map_attr_numa_node(const union bpf_attr *attr)
740 return (attr->map_flags & BPF_F_NUMA_NODE) ?
741 attr->numa_node : NUMA_NO_NODE;
744 struct bpf_prog *bpf_prog_get_type_path(const char *name, enum bpf_prog_type type);
745 int array_map_alloc_check(union bpf_attr *attr);
747 int bpf_prog_test_run_xdp(struct bpf_prog *prog, const union bpf_attr *kattr,
748 union bpf_attr __user *uattr);
749 int bpf_prog_test_run_skb(struct bpf_prog *prog, const union bpf_attr *kattr,
750 union bpf_attr __user *uattr);
751 int bpf_prog_test_run_flow_dissector(struct bpf_prog *prog,
752 const union bpf_attr *kattr,
753 union bpf_attr __user *uattr);
755 static inline bool unprivileged_ebpf_enabled(void)
757 return !sysctl_unprivileged_bpf_disabled;
760 #else /* !CONFIG_BPF_SYSCALL */
761 static inline struct bpf_prog *bpf_prog_get(u32 ufd)
763 return ERR_PTR(-EOPNOTSUPP);
766 static inline struct bpf_prog *bpf_prog_get_type_dev(u32 ufd,
767 enum bpf_prog_type type,
770 return ERR_PTR(-EOPNOTSUPP);
773 static inline struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog,
776 return ERR_PTR(-EOPNOTSUPP);
779 static inline void bpf_prog_sub(struct bpf_prog *prog, int i)
783 static inline void bpf_prog_put(struct bpf_prog *prog)
787 static inline struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog)
789 return ERR_PTR(-EOPNOTSUPP);
792 static inline struct bpf_prog *__must_check
793 bpf_prog_inc_not_zero(struct bpf_prog *prog)
795 return ERR_PTR(-EOPNOTSUPP);
798 static inline int __bpf_prog_charge(struct user_struct *user, u32 pages)
803 static inline void __bpf_prog_uncharge(struct user_struct *user, u32 pages)
807 static inline int bpf_obj_get_user(const char __user *pathname, int flags)
812 static inline struct net_device *__dev_map_lookup_elem(struct bpf_map *map,
818 static inline struct net_device *__dev_map_hash_lookup_elem(struct bpf_map *map,
824 static inline void __dev_map_flush(struct bpf_map *map)
829 struct bpf_dtab_netdev;
832 int dev_map_enqueue(struct bpf_dtab_netdev *dst, struct xdp_buff *xdp,
833 struct net_device *dev_rx)
840 static inline int dev_map_generic_redirect(struct bpf_dtab_netdev *dst,
842 struct bpf_prog *xdp_prog)
848 struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key)
853 static inline void __cpu_map_flush(struct bpf_map *map)
857 static inline int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu,
858 struct xdp_buff *xdp,
859 struct net_device *dev_rx)
864 static inline struct bpf_prog *bpf_prog_get_type_path(const char *name,
865 enum bpf_prog_type type)
867 return ERR_PTR(-EOPNOTSUPP);
870 static inline int bpf_prog_test_run_xdp(struct bpf_prog *prog,
871 const union bpf_attr *kattr,
872 union bpf_attr __user *uattr)
877 static inline int bpf_prog_test_run_skb(struct bpf_prog *prog,
878 const union bpf_attr *kattr,
879 union bpf_attr __user *uattr)
884 static inline int bpf_prog_test_run_flow_dissector(struct bpf_prog *prog,
885 const union bpf_attr *kattr,
886 union bpf_attr __user *uattr)
891 static inline bool unprivileged_ebpf_enabled(void)
896 #endif /* CONFIG_BPF_SYSCALL */
898 static inline struct bpf_prog *bpf_prog_get_type(u32 ufd,
899 enum bpf_prog_type type)
901 return bpf_prog_get_type_dev(ufd, type, false);
904 bool bpf_prog_get_ok(struct bpf_prog *, enum bpf_prog_type *, bool);
906 int bpf_prog_offload_compile(struct bpf_prog *prog);
907 void bpf_prog_offload_destroy(struct bpf_prog *prog);
908 int bpf_prog_offload_info_fill(struct bpf_prog_info *info,
909 struct bpf_prog *prog);
911 int bpf_map_offload_info_fill(struct bpf_map_info *info, struct bpf_map *map);
913 int bpf_map_offload_lookup_elem(struct bpf_map *map, void *key, void *value);
914 int bpf_map_offload_update_elem(struct bpf_map *map,
915 void *key, void *value, u64 flags);
916 int bpf_map_offload_delete_elem(struct bpf_map *map, void *key);
917 int bpf_map_offload_get_next_key(struct bpf_map *map,
918 void *key, void *next_key);
920 bool bpf_offload_prog_map_match(struct bpf_prog *prog, struct bpf_map *map);
922 struct bpf_offload_dev *
923 bpf_offload_dev_create(const struct bpf_prog_offload_ops *ops, void *priv);
924 void bpf_offload_dev_destroy(struct bpf_offload_dev *offdev);
925 void *bpf_offload_dev_priv(struct bpf_offload_dev *offdev);
926 int bpf_offload_dev_netdev_register(struct bpf_offload_dev *offdev,
927 struct net_device *netdev);
928 void bpf_offload_dev_netdev_unregister(struct bpf_offload_dev *offdev,
929 struct net_device *netdev);
930 bool bpf_offload_dev_match(struct bpf_prog *prog, struct net_device *netdev);
932 void unpriv_ebpf_notify(int new_state);
934 #if defined(CONFIG_NET) && defined(CONFIG_BPF_SYSCALL)
935 int bpf_prog_offload_init(struct bpf_prog *prog, union bpf_attr *attr);
937 static inline bool bpf_prog_is_dev_bound(const struct bpf_prog_aux *aux)
939 return aux->offload_requested;
942 static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
944 return unlikely(map->ops == &bpf_map_offload_ops);
947 struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr);
948 void bpf_map_offload_map_free(struct bpf_map *map);
950 static inline int bpf_prog_offload_init(struct bpf_prog *prog,
951 union bpf_attr *attr)
956 static inline bool bpf_prog_is_dev_bound(struct bpf_prog_aux *aux)
961 static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
966 static inline struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr)
968 return ERR_PTR(-EOPNOTSUPP);
971 static inline void bpf_map_offload_map_free(struct bpf_map *map)
974 #endif /* CONFIG_NET && CONFIG_BPF_SYSCALL */
976 #if defined(CONFIG_BPF_STREAM_PARSER)
977 int sock_map_prog_update(struct bpf_map *map, struct bpf_prog *prog,
978 struct bpf_prog *old, u32 which);
979 int sock_map_get_from_fd(const union bpf_attr *attr, struct bpf_prog *prog);
980 int sock_map_prog_detach(const union bpf_attr *attr, enum bpf_prog_type ptype);
982 static inline int sock_map_prog_update(struct bpf_map *map,
983 struct bpf_prog *prog,
984 struct bpf_prog *old, u32 which)
989 static inline int sock_map_get_from_fd(const union bpf_attr *attr,
990 struct bpf_prog *prog)
995 static inline int sock_map_prog_detach(const union bpf_attr *attr,
996 enum bpf_prog_type ptype)
1002 #if defined(CONFIG_XDP_SOCKETS)
1004 struct xdp_sock *__xsk_map_lookup_elem(struct bpf_map *map, u32 key);
1005 int __xsk_map_redirect(struct bpf_map *map, struct xdp_buff *xdp,
1006 struct xdp_sock *xs);
1007 void __xsk_map_flush(struct bpf_map *map);
1010 static inline struct xdp_sock *__xsk_map_lookup_elem(struct bpf_map *map,
1016 static inline int __xsk_map_redirect(struct bpf_map *map, struct xdp_buff *xdp,
1017 struct xdp_sock *xs)
1022 static inline void __xsk_map_flush(struct bpf_map *map)
1027 #if defined(CONFIG_INET) && defined(CONFIG_BPF_SYSCALL)
1028 void bpf_sk_reuseport_detach(struct sock *sk);
1029 int bpf_fd_reuseport_array_lookup_elem(struct bpf_map *map, void *key,
1031 int bpf_fd_reuseport_array_update_elem(struct bpf_map *map, void *key,
1032 void *value, u64 map_flags);
1034 static inline void bpf_sk_reuseport_detach(struct sock *sk)
1038 #ifdef CONFIG_BPF_SYSCALL
1039 static inline int bpf_fd_reuseport_array_lookup_elem(struct bpf_map *map,
1040 void *key, void *value)
1045 static inline int bpf_fd_reuseport_array_update_elem(struct bpf_map *map,
1046 void *key, void *value,
1051 #endif /* CONFIG_BPF_SYSCALL */
1052 #endif /* defined(CONFIG_INET) && defined(CONFIG_BPF_SYSCALL) */
1054 /* verifier prototypes for helper functions called from eBPF programs */
1055 extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
1056 extern const struct bpf_func_proto bpf_map_update_elem_proto;
1057 extern const struct bpf_func_proto bpf_map_delete_elem_proto;
1058 extern const struct bpf_func_proto bpf_map_push_elem_proto;
1059 extern const struct bpf_func_proto bpf_map_pop_elem_proto;
1060 extern const struct bpf_func_proto bpf_map_peek_elem_proto;
1062 extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
1063 extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
1064 extern const struct bpf_func_proto bpf_get_numa_node_id_proto;
1065 extern const struct bpf_func_proto bpf_tail_call_proto;
1066 extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
1067 extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
1068 extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
1069 extern const struct bpf_func_proto bpf_get_current_comm_proto;
1070 extern const struct bpf_func_proto bpf_get_stackid_proto;
1071 extern const struct bpf_func_proto bpf_get_stack_proto;
1072 extern const struct bpf_func_proto bpf_sock_map_update_proto;
1073 extern const struct bpf_func_proto bpf_sock_hash_update_proto;
1074 extern const struct bpf_func_proto bpf_get_current_cgroup_id_proto;
1075 extern const struct bpf_func_proto bpf_msg_redirect_hash_proto;
1076 extern const struct bpf_func_proto bpf_msg_redirect_map_proto;
1077 extern const struct bpf_func_proto bpf_sk_redirect_hash_proto;
1078 extern const struct bpf_func_proto bpf_sk_redirect_map_proto;
1079 extern const struct bpf_func_proto bpf_spin_lock_proto;
1080 extern const struct bpf_func_proto bpf_spin_unlock_proto;
1081 extern const struct bpf_func_proto bpf_get_local_storage_proto;
1082 extern const struct bpf_func_proto bpf_strtol_proto;
1083 extern const struct bpf_func_proto bpf_strtoul_proto;
1084 extern const struct bpf_func_proto bpf_tcp_sock_proto;
1086 /* Shared helpers among cBPF and eBPF. */
1087 void bpf_user_rnd_init_once(void);
1088 u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
1090 #if defined(CONFIG_NET)
1091 bool bpf_sock_common_is_valid_access(int off, int size,
1092 enum bpf_access_type type,
1093 struct bpf_insn_access_aux *info);
1094 bool bpf_sock_is_valid_access(int off, int size, enum bpf_access_type type,
1095 struct bpf_insn_access_aux *info);
1096 u32 bpf_sock_convert_ctx_access(enum bpf_access_type type,
1097 const struct bpf_insn *si,
1098 struct bpf_insn *insn_buf,
1099 struct bpf_prog *prog,
1102 static inline bool bpf_sock_common_is_valid_access(int off, int size,
1103 enum bpf_access_type type,
1104 struct bpf_insn_access_aux *info)
1108 static inline bool bpf_sock_is_valid_access(int off, int size,
1109 enum bpf_access_type type,
1110 struct bpf_insn_access_aux *info)
1114 static inline u32 bpf_sock_convert_ctx_access(enum bpf_access_type type,
1115 const struct bpf_insn *si,
1116 struct bpf_insn *insn_buf,
1117 struct bpf_prog *prog,
1125 bool bpf_tcp_sock_is_valid_access(int off, int size, enum bpf_access_type type,
1126 struct bpf_insn_access_aux *info);
1128 u32 bpf_tcp_sock_convert_ctx_access(enum bpf_access_type type,
1129 const struct bpf_insn *si,
1130 struct bpf_insn *insn_buf,
1131 struct bpf_prog *prog,
1134 bool bpf_xdp_sock_is_valid_access(int off, int size, enum bpf_access_type type,
1135 struct bpf_insn_access_aux *info);
1137 u32 bpf_xdp_sock_convert_ctx_access(enum bpf_access_type type,
1138 const struct bpf_insn *si,
1139 struct bpf_insn *insn_buf,
1140 struct bpf_prog *prog,
1143 static inline bool bpf_tcp_sock_is_valid_access(int off, int size,
1144 enum bpf_access_type type,
1145 struct bpf_insn_access_aux *info)
1150 static inline u32 bpf_tcp_sock_convert_ctx_access(enum bpf_access_type type,
1151 const struct bpf_insn *si,
1152 struct bpf_insn *insn_buf,
1153 struct bpf_prog *prog,
1158 static inline bool bpf_xdp_sock_is_valid_access(int off, int size,
1159 enum bpf_access_type type,
1160 struct bpf_insn_access_aux *info)
1165 static inline u32 bpf_xdp_sock_convert_ctx_access(enum bpf_access_type type,
1166 const struct bpf_insn *si,
1167 struct bpf_insn *insn_buf,
1168 struct bpf_prog *prog,
1173 #endif /* CONFIG_INET */
1175 #endif /* _LINUX_BPF_H */