include/linux/bpf.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
   3  */
   4 #ifndef _LINUX_BPF_H
   5 #define _LINUX_BPF_H 1
   6
   7 #include <uapi/linux/bpf.h>
   8
   9 #include <linux/workqueue.h>
  10 #include <linux/file.h>
  11 #include <linux/percpu.h>
  12 #include <linux/err.h>
  13 #include <linux/rbtree_latch.h>
  14 #include <linux/numa.h>
  15 #include <linux/mm_types.h>
  16 #include <linux/wait.h>
  17 #include <linux/u64_stats_sync.h>
  18 #include <linux/refcount.h>
  19 #include <linux/mutex.h>
  20 #include <linux/module.h>
  21
  22 struct bpf_verifier_env;
  23 struct bpf_verifier_log;
  24 struct perf_event;
  25 struct bpf_prog;
  26 struct bpf_prog_aux;
  27 struct bpf_map;
  28 struct sock;
  29 struct seq_file;
  30 struct btf;
  31 struct btf_type;
  32 struct exception_table_entry;
  33
  34 extern struct idr btf_idr;
  35 extern spinlock_t btf_idr_lock;
  36
  37 /* map is generic key/value storage optionally accesible by eBPF programs */
  38 struct bpf_map_ops {
  39         /* funcs callable from userspace (via syscall) */
  40         int (*map_alloc_check)(union bpf_attr *attr);
  41         struct bpf_map *(*map_alloc)(union bpf_attr *attr);
  42         void (*map_release)(struct bpf_map *map, struct file *map_file);
  43         void (*map_free)(struct bpf_map *map);
  44         int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key);
  45         void (*map_release_uref)(struct bpf_map *map);
  46         void *(*map_lookup_elem_sys_only)(struct bpf_map *map, void *key);
  47         int (*map_lookup_batch)(struct bpf_map *map, const union bpf_attr *attr,
  48                                 union bpf_attr __user *uattr);
  49         int (*map_lookup_and_delete_batch)(struct bpf_map *map,
  50                                            const union bpf_attr *attr,
  51                                            union bpf_attr __user *uattr);
  52         int (*map_update_batch)(struct bpf_map *map, const union bpf_attr *attr,
  53                                 union bpf_attr __user *uattr);
  54         int (*map_delete_batch)(struct bpf_map *map, const union bpf_attr *attr,
  55                                 union bpf_attr __user *uattr);
  56
  57         /* funcs callable from userspace and from eBPF programs */
  58         void *(*map_lookup_elem)(struct bpf_map *map, void *key);
  59         int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags);
  60         int (*map_delete_elem)(struct bpf_map *map, void *key);
  61         int (*map_push_elem)(struct bpf_map *map, void *value, u64 flags);
  62         int (*map_pop_elem)(struct bpf_map *map, void *value);
  63         int (*map_peek_elem)(struct bpf_map *map, void *value);
  64
  65         /* funcs called by prog_array and perf_event_array map */
  66         void *(*map_fd_get_ptr)(struct bpf_map *map, struct file *map_file,
  67                                 int fd);
  68         void (*map_fd_put_ptr)(void *ptr);
  69         u32 (*map_gen_lookup)(struct bpf_map *map, struct bpf_insn *insn_buf);
  70         u32 (*map_fd_sys_lookup_elem)(void *ptr);
  71         void (*map_seq_show_elem)(struct bpf_map *map, void *key,
  72                                   struct seq_file *m);
  73         int (*map_check_btf)(const struct bpf_map *map,
  74                              const struct btf *btf,
  75                              const struct btf_type *key_type,
  76                              const struct btf_type *value_type);
  77
  78         /* Prog poke tracking helpers. */
  79         int (*map_poke_track)(struct bpf_map *map, struct bpf_prog_aux *aux);
  80         void (*map_poke_untrack)(struct bpf_map *map, struct bpf_prog_aux *aux);
  81         void (*map_poke_run)(struct bpf_map *map, u32 key, struct bpf_prog *old,
  82                              struct bpf_prog *new);
  83
  84         /* Direct value access helpers. */
  85         int (*map_direct_value_addr)(const struct bpf_map *map,
  86                                      u64 *imm, u32 off);
  87         int (*map_direct_value_meta)(const struct bpf_map *map,
  88                                      u64 imm, u32 *off);
  89         int (*map_mmap)(struct bpf_map *map, struct vm_area_struct *vma);
  90 };
  91
  92 struct bpf_map_memory {
  93         u32 pages;
  94         struct user_struct *user;
  95 };
  96
  97 struct bpf_map {
  98         /* The first two cachelines with read-mostly members of which some
  99          * are also accessed in fast-path (e.g. ops, max_entries).
 100          */
 101         const struct bpf_map_ops *ops ____cacheline_aligned;
 102         struct bpf_map *inner_map_meta;
 103 #ifdef CONFIG_SECURITY
 104         void *security;
 105 #endif
 106         enum bpf_map_type map_type;
 107         u32 key_size;
 108         u32 value_size;
 109         u32 max_entries;
 110         u32 map_flags;
 111         int spin_lock_off; /* >=0 valid offset, <0 error */
 112         u32 id;
 113         int numa_node;
 114         u32 btf_key_type_id;
 115         u32 btf_value_type_id;
 116         struct btf *btf;
 117         struct bpf_map_memory memory;
 118         char name[BPF_OBJ_NAME_LEN];
 119         u32 btf_vmlinux_value_type_id;
 120         bool unpriv_array;
 121         bool frozen; /* write-once; write-protected by freeze_mutex */
 122         /* 22 bytes hole */
 123
 124         /* The 3rd and 4th cacheline with misc members to avoid false sharing
 125          * particularly with refcounting.
 126          */
 127         atomic64_t refcnt ____cacheline_aligned;
 128         atomic64_t usercnt;
 129         struct work_struct work;
 130         struct mutex freeze_mutex;
 131         u64 writecnt; /* writable mmap cnt; protected by freeze_mutex */
 132 };
 133
 134 static inline bool map_value_has_spin_lock(const struct bpf_map *map)
 135 {
 136         return map->spin_lock_off >= 0;
 137 }
 138
 139 static inline void check_and_init_map_lock(struct bpf_map *map, void *dst)
 140 {
 141         if (likely(!map_value_has_spin_lock(map)))
 142                 return;
 143         *(struct bpf_spin_lock *)(dst + map->spin_lock_off) =
 144                 (struct bpf_spin_lock){};
 145 }
 146
 147 /* copy everything but bpf_spin_lock */
 148 static inline void copy_map_value(struct bpf_map *map, void *dst, void *src)
 149 {
 150         if (unlikely(map_value_has_spin_lock(map))) {
 151                 u32 off = map->spin_lock_off;
 152
 153                 memcpy(dst, src, off);
 154                 memcpy(dst + off + sizeof(struct bpf_spin_lock),
 155                        src + off + sizeof(struct bpf_spin_lock),
 156                        map->value_size - off - sizeof(struct bpf_spin_lock));
 157         } else {
 158                 memcpy(dst, src, map->value_size);
 159         }
 160 }
 161 void copy_map_value_locked(struct bpf_map *map, void *dst, void *src,
 162                            bool lock_src);
 163
 164 struct bpf_offload_dev;
 165 struct bpf_offloaded_map;
 166
 167 struct bpf_map_dev_ops {
 168         int (*map_get_next_key)(struct bpf_offloaded_map *map,
 169                                 void *key, void *next_key);
 170         int (*map_lookup_elem)(struct bpf_offloaded_map *map,
 171                                void *key, void *value);
 172         int (*map_update_elem)(struct bpf_offloaded_map *map,
 173                                void *key, void *value, u64 flags);
 174         int (*map_delete_elem)(struct bpf_offloaded_map *map, void *key);
 175 };
 176
 177 struct bpf_offloaded_map {
 178         struct bpf_map map;
 179         struct net_device *netdev;
 180         const struct bpf_map_dev_ops *dev_ops;
 181         void *dev_priv;
 182         struct list_head offloads;
 183 };
 184
 185 static inline struct bpf_offloaded_map *map_to_offmap(struct bpf_map *map)
 186 {
 187         return container_of(map, struct bpf_offloaded_map, map);
 188 }
 189
 190 static inline bool bpf_map_offload_neutral(const struct bpf_map *map)
 191 {
 192         return map->map_type == BPF_MAP_TYPE_PERF_EVENT_ARRAY;
 193 }
 194
 195 static inline bool bpf_map_support_seq_show(const struct bpf_map *map)
 196 {
 197         return (map->btf_value_type_id || map->btf_vmlinux_value_type_id) &&
 198                 map->ops->map_seq_show_elem;
 199 }
 200
 201 int map_check_no_btf(const struct bpf_map *map,
 202                      const struct btf *btf,
 203                      const struct btf_type *key_type,
 204                      const struct btf_type *value_type);
 205
 206 extern const struct bpf_map_ops bpf_map_offload_ops;
 207
 208 /* function argument constraints */
 209 enum bpf_arg_type {
 210         ARG_DONTCARE = 0,       /* unused argument in helper function */
 211
 212         /* the following constraints used to prototype
 213          * bpf_map_lookup/update/delete_elem() functions
 214          */
 215         ARG_CONST_MAP_PTR,      /* const argument used as pointer to bpf_map */
 216         ARG_PTR_TO_MAP_KEY,     /* pointer to stack used as map key */
 217         ARG_PTR_TO_MAP_VALUE,   /* pointer to stack used as map value */
 218         ARG_PTR_TO_UNINIT_MAP_VALUE,    /* pointer to valid memory used to store a map value */
 219         ARG_PTR_TO_MAP_VALUE_OR_NULL,   /* pointer to stack used as map value or NULL */
 220
 221         /* the following constraints used to prototype bpf_memcmp() and other
 222          * functions that access data on eBPF program stack
 223          */
 224         ARG_PTR_TO_MEM,         /* pointer to valid memory (stack, packet, map value) */
 225         ARG_PTR_TO_MEM_OR_NULL, /* pointer to valid memory or NULL */
 226         ARG_PTR_TO_UNINIT_MEM,  /* pointer to memory does not need to be initialized,
 227                                  * helper function must fill all bytes or clear
 228                                  * them in error case.
 229                                  */
 230
 231         ARG_CONST_SIZE,         /* number of bytes accessed from memory */
 232         ARG_CONST_SIZE_OR_ZERO, /* number of bytes accessed from memory or 0 */
 233
 234         ARG_PTR_TO_CTX,         /* pointer to context */
 235         ARG_ANYTHING,           /* any (initialized) argument is ok */
 236         ARG_PTR_TO_SPIN_LOCK,   /* pointer to bpf_spin_lock */
 237         ARG_PTR_TO_SOCK_COMMON, /* pointer to sock_common */
 238         ARG_PTR_TO_INT,         /* pointer to int */
 239         ARG_PTR_TO_LONG,        /* pointer to long */
 240         ARG_PTR_TO_SOCKET,      /* pointer to bpf_sock (fullsock) */
 241         ARG_PTR_TO_BTF_ID,      /* pointer to in-kernel struct */
 242 };
 243
 244 /* type of values returned from helper functions */
 245 enum bpf_return_type {
 246         RET_INTEGER,                    /* function returns integer */
 247         RET_VOID,                       /* function doesn't return anything */
 248         RET_PTR_TO_MAP_VALUE,           /* returns a pointer to map elem value */
 249         RET_PTR_TO_MAP_VALUE_OR_NULL,   /* returns a pointer to map elem value or NULL */
 250         RET_PTR_TO_SOCKET_OR_NULL,      /* returns a pointer to a socket or NULL */
 251         RET_PTR_TO_TCP_SOCK_OR_NULL,    /* returns a pointer to a tcp_sock or NULL */
 252         RET_PTR_TO_SOCK_COMMON_OR_NULL, /* returns a pointer to a sock_common or NULL */
 253 };
 254
 255 /* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
 256  * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
 257  * instructions after verifying
 258  */
 259 struct bpf_func_proto {
 260         u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
 261         bool gpl_only;
 262         bool pkt_access;
 263         enum bpf_return_type ret_type;
 264         union {
 265                 struct {
 266                         enum bpf_arg_type arg1_type;
 267                         enum bpf_arg_type arg2_type;
 268                         enum bpf_arg_type arg3_type;
 269                         enum bpf_arg_type arg4_type;
 270                         enum bpf_arg_type arg5_type;
 271                 };
 272                 enum bpf_arg_type arg_type[5];
 273         };
 274         int *btf_id; /* BTF ids of arguments */
 275 };
 276
 277 /* bpf_context is intentionally undefined structure. Pointer to bpf_context is
 278  * the first argument to eBPF programs.
 279  * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
 280  */
 281 struct bpf_context;
 282
 283 enum bpf_access_type {
 284         BPF_READ = 1,
 285         BPF_WRITE = 2
 286 };
 287
 288 /* types of values stored in eBPF registers */
 289 /* Pointer types represent:
 290  * pointer
 291  * pointer + imm
 292  * pointer + (u16) var
 293  * pointer + (u16) var + imm
 294  * if (range > 0) then [ptr, ptr + range - off) is safe to access
 295  * if (id > 0) means that some 'var' was added
 296  * if (off > 0) means that 'imm' was added
 297  */
 298 enum bpf_reg_type {
 299         NOT_INIT = 0,            /* nothing was written into register */
 300         SCALAR_VALUE,            /* reg doesn't contain a valid pointer */
 301         PTR_TO_CTX,              /* reg points to bpf_context */
 302         CONST_PTR_TO_MAP,        /* reg points to struct bpf_map */
 303         PTR_TO_MAP_VALUE,        /* reg points to map element value */
 304         PTR_TO_MAP_VALUE_OR_NULL,/* points to map elem value or NULL */
 305         PTR_TO_STACK,            /* reg == frame_pointer + offset */
 306         PTR_TO_PACKET_META,      /* skb->data - meta_len */
 307         PTR_TO_PACKET,           /* reg points to skb->data */
 308         PTR_TO_PACKET_END,       /* skb->data + headlen */
 309         PTR_TO_FLOW_KEYS,        /* reg points to bpf_flow_keys */
 310         PTR_TO_SOCKET,           /* reg points to struct bpf_sock */
 311         PTR_TO_SOCKET_OR_NULL,   /* reg points to struct bpf_sock or NULL */
 312         PTR_TO_SOCK_COMMON,      /* reg points to sock_common */
 313         PTR_TO_SOCK_COMMON_OR_NULL, /* reg points to sock_common or NULL */
 314         PTR_TO_TCP_SOCK,         /* reg points to struct tcp_sock */
 315         PTR_TO_TCP_SOCK_OR_NULL, /* reg points to struct tcp_sock or NULL */
 316         PTR_TO_TP_BUFFER,        /* reg points to a writable raw tp's buffer */
 317         PTR_TO_XDP_SOCK,         /* reg points to struct xdp_sock */
 318         PTR_TO_BTF_ID,           /* reg points to kernel struct */
 319 };
 320
 321 /* The information passed from prog-specific *_is_valid_access
 322  * back to the verifier.
 323  */
 324 struct bpf_insn_access_aux {
 325         enum bpf_reg_type reg_type;
 326         union {
 327                 int ctx_field_size;
 328                 u32 btf_id;
 329         };
 330         struct bpf_verifier_log *log; /* for verbose logs */
 331 };
 332
 333 static inline void
 334 bpf_ctx_record_field_size(struct bpf_insn_access_aux *aux, u32 size)
 335 {
 336         aux->ctx_field_size = size;
 337 }
 338
 339 struct bpf_prog_ops {
 340         int (*test_run)(struct bpf_prog *prog, const union bpf_attr *kattr,
 341                         union bpf_attr __user *uattr);
 342 };
 343
 344 struct bpf_verifier_ops {
 345         /* return eBPF function prototype for verification */
 346         const struct bpf_func_proto *
 347         (*get_func_proto)(enum bpf_func_id func_id,
 348                           const struct bpf_prog *prog);
 349
 350         /* return true if 'size' wide access at offset 'off' within bpf_context
 351          * with 'type' (read or write) is allowed
 352          */
 353         bool (*is_valid_access)(int off, int size, enum bpf_access_type type,
 354                                 const struct bpf_prog *prog,
 355                                 struct bpf_insn_access_aux *info);
 356         int (*gen_prologue)(struct bpf_insn *insn, bool direct_write,
 357                             const struct bpf_prog *prog);
 358         int (*gen_ld_abs)(const struct bpf_insn *orig,
 359                           struct bpf_insn *insn_buf);
 360         u32 (*convert_ctx_access)(enum bpf_access_type type,
 361                                   const struct bpf_insn *src,
 362                                   struct bpf_insn *dst,
 363                                   struct bpf_prog *prog, u32 *target_size);
 364         int (*btf_struct_access)(struct bpf_verifier_log *log,
 365                                  const struct btf_type *t, int off, int size,
 366                                  enum bpf_access_type atype,
 367                                  u32 *next_btf_id);
 368 };
 369
 370 struct bpf_prog_offload_ops {
 371         /* verifier basic callbacks */
 372         int (*insn_hook)(struct bpf_verifier_env *env,
 373                          int insn_idx, int prev_insn_idx);
 374         int (*finalize)(struct bpf_verifier_env *env);
 375         /* verifier optimization callbacks (called after .finalize) */
 376         int (*replace_insn)(struct bpf_verifier_env *env, u32 off,
 377                             struct bpf_insn *insn);
 378         int (*remove_insns)(struct bpf_verifier_env *env, u32 off, u32 cnt);
 379         /* program management callbacks */
 380         int (*prepare)(struct bpf_prog *prog);
 381         int (*translate)(struct bpf_prog *prog);
 382         void (*destroy)(struct bpf_prog *prog);
 383 };
 384
 385 struct bpf_prog_offload {
 386         struct bpf_prog         *prog;
 387         struct net_device       *netdev;
 388         struct bpf_offload_dev  *offdev;
 389         void                    *dev_priv;
 390         struct list_head        offloads;
 391         bool                    dev_state;
 392         bool                    opt_failed;
 393         void                    *jited_image;
 394         u32                     jited_len;
 395 };
 396
 397 enum bpf_cgroup_storage_type {
 398         BPF_CGROUP_STORAGE_SHARED,
 399         BPF_CGROUP_STORAGE_PERCPU,
 400         __BPF_CGROUP_STORAGE_MAX
 401 };
 402
 403 #define MAX_BPF_CGROUP_STORAGE_TYPE __BPF_CGROUP_STORAGE_MAX
 404
 405 /* The longest tracepoint has 12 args.
 406  * See include/trace/bpf_probe.h
 407  */
 408 #define MAX_BPF_FUNC_ARGS 12
 409
 410 struct bpf_prog_stats {
 411         u64 cnt;
 412         u64 nsecs;
 413         struct u64_stats_sync syncp;
 414 } __aligned(2 * sizeof(u64));
 415
 416 struct btf_func_model {
 417         u8 ret_size;
 418         u8 nr_args;
 419         u8 arg_size[MAX_BPF_FUNC_ARGS];
 420 };
 421
 422 /* Restore arguments before returning from trampoline to let original function
 423  * continue executing. This flag is used for fentry progs when there are no
 424  * fexit progs.
 425  */
 426 #define BPF_TRAMP_F_RESTORE_REGS        BIT(0)
 427 /* Call original function after fentry progs, but before fexit progs.
 428  * Makes sense for fentry/fexit, normal calls and indirect calls.
 429  */
 430 #define BPF_TRAMP_F_CALL_ORIG           BIT(1)
 431 /* Skip current frame and return to parent.  Makes sense for fentry/fexit
 432  * programs only. Should not be used with normal calls and indirect calls.
 433  */
 434 #define BPF_TRAMP_F_SKIP_FRAME          BIT(2)
 435
 436 /* Each call __bpf_prog_enter + call bpf_func + call __bpf_prog_exit is ~50
 437  * bytes on x86.  Pick a number to fit into BPF_IMAGE_SIZE / 2
 438  */
 439 #define BPF_MAX_TRAMP_PROGS 40
 440
 441 struct bpf_tramp_progs {
 442         struct bpf_prog *progs[BPF_MAX_TRAMP_PROGS];
 443         int nr_progs;
 444 };
 445
 446 /* Different use cases for BPF trampoline:
 447  * 1. replace nop at the function entry (kprobe equivalent)
 448  *    flags = BPF_TRAMP_F_RESTORE_REGS
 449  *    fentry = a set of programs to run before returning from trampoline
 450  *
 451  * 2. replace nop at the function entry (kprobe + kretprobe equivalent)
 452  *    flags = BPF_TRAMP_F_CALL_ORIG | BPF_TRAMP_F_SKIP_FRAME
 453  *    orig_call = fentry_ip + MCOUNT_INSN_SIZE
 454  *    fentry = a set of program to run before calling original function
 455  *    fexit = a set of program to run after original function
 456  *
 457  * 3. replace direct call instruction anywhere in the function body
 458  *    or assign a function pointer for indirect call (like tcp_congestion_ops->cong_avoid)
 459  *    With flags = 0
 460  *      fentry = a set of programs to run before returning from trampoline
 461  *    With flags = BPF_TRAMP_F_CALL_ORIG
 462  *      orig_call = original callback addr or direct function addr
 463  *      fentry = a set of program to run before calling original function
 464  *      fexit = a set of program to run after original function
 465  */
 466 int arch_prepare_bpf_trampoline(void *image, void *image_end,
 467                                 const struct btf_func_model *m, u32 flags,
 468                                 struct bpf_tramp_progs *tprogs,
 469                                 void *orig_call);
 470 /* these two functions are called from generated trampoline */
 471 u64 notrace __bpf_prog_enter(void);
 472 void notrace __bpf_prog_exit(struct bpf_prog *prog, u64 start);
 473
 474 enum bpf_tramp_prog_type {
 475         BPF_TRAMP_FENTRY,
 476         BPF_TRAMP_FEXIT,
 477         BPF_TRAMP_MODIFY_RETURN,
 478         BPF_TRAMP_MAX,
 479         BPF_TRAMP_REPLACE, /* more than MAX */
 480 };
 481
 482 struct bpf_trampoline {
 483         /* hlist for trampoline_table */
 484         struct hlist_node hlist;
 485         /* serializes access to fields of this trampoline */
 486         struct mutex mutex;
 487         refcount_t refcnt;
 488         u64 key;
 489         struct {
 490                 struct btf_func_model model;
 491                 void *addr;
 492                 bool ftrace_managed;
 493         } func;
 494         /* if !NULL this is BPF_PROG_TYPE_EXT program that extends another BPF
 495          * program by replacing one of its functions. func.addr is the address
 496          * of the function it replaced.
 497          */
 498         struct bpf_prog *extension_prog;
 499         /* list of BPF programs using this trampoline */
 500         struct hlist_head progs_hlist[BPF_TRAMP_MAX];
 501         /* Number of attached programs. A counter per kind. */
 502         int progs_cnt[BPF_TRAMP_MAX];
 503         /* Executable image of trampoline */
 504         void *image;
 505         u64 selector;
 506 };
 507
 508 #define BPF_DISPATCHER_MAX 48 /* Fits in 2048B */
 509
 510 struct bpf_dispatcher_prog {
 511         struct bpf_prog *prog;
 512         refcount_t users;
 513 };
 514
 515 struct bpf_dispatcher {
 516         /* dispatcher mutex */
 517         struct mutex mutex;
 518         void *func;
 519         struct bpf_dispatcher_prog progs[BPF_DISPATCHER_MAX];
 520         int num_progs;
 521         void *image;
 522         u32 image_off;
 523 };
 524
 525 static __always_inline unsigned int bpf_dispatcher_nopfunc(
 526         const void *ctx,
 527         const struct bpf_insn *insnsi,
 528         unsigned int (*bpf_func)(const void *,
 529                                  const struct bpf_insn *))
 530 {
 531         return bpf_func(ctx, insnsi);
 532 }
 533 #ifdef CONFIG_BPF_JIT
 534 struct bpf_trampoline *bpf_trampoline_lookup(u64 key);
 535 int bpf_trampoline_link_prog(struct bpf_prog *prog);
 536 int bpf_trampoline_unlink_prog(struct bpf_prog *prog);
 537 void bpf_trampoline_put(struct bpf_trampoline *tr);
 538 #define BPF_DISPATCHER_INIT(name) {                     \
 539         .mutex = __MUTEX_INITIALIZER(name.mutex),       \
 540         .func = &name##func,                            \
 541         .progs = {},                                    \
 542         .num_progs = 0,                                 \
 543         .image = NULL,                                  \
 544         .image_off = 0                                  \
 545 }
 546
 547 #define DEFINE_BPF_DISPATCHER(name)                                     \
 548         noinline unsigned int name##func(                               \
 549                 const void *ctx,                                        \
 550                 const struct bpf_insn *insnsi,                          \
 551                 unsigned int (*bpf_func)(const void *,                  \
 552                                          const struct bpf_insn *))      \
 553         {                                                               \
 554                 return bpf_func(ctx, insnsi);                           \
 555         }                                                               \
 556         EXPORT_SYMBOL(name##func);                      \
 557         struct bpf_dispatcher name = BPF_DISPATCHER_INIT(name);
 558 #define DECLARE_BPF_DISPATCHER(name)                                    \
 559         unsigned int name##func(                                        \
 560                 const void *ctx,                                        \
 561                 const struct bpf_insn *insnsi,                          \
 562                 unsigned int (*bpf_func)(const void *,                  \
 563                                          const struct bpf_insn *));     \
 564         extern struct bpf_dispatcher name;
 565 #define BPF_DISPATCHER_FUNC(name) name##func
 566 #define BPF_DISPATCHER_PTR(name) (&name)
 567 void bpf_dispatcher_change_prog(struct bpf_dispatcher *d, struct bpf_prog *from,
 568                                 struct bpf_prog *to);
 569 struct bpf_image {
 570         struct latch_tree_node tnode;
 571         unsigned char data[];
 572 };
 573 #define BPF_IMAGE_SIZE (PAGE_SIZE - sizeof(struct bpf_image))
 574 bool is_bpf_image_address(unsigned long address);
 575 void *bpf_image_alloc(void);
 576 #else
 577 static inline struct bpf_trampoline *bpf_trampoline_lookup(u64 key)
 578 {
 579         return NULL;
 580 }
 581 static inline int bpf_trampoline_link_prog(struct bpf_prog *prog)
 582 {
 583         return -ENOTSUPP;
 584 }
 585 static inline int bpf_trampoline_unlink_prog(struct bpf_prog *prog)
 586 {
 587         return -ENOTSUPP;
 588 }
 589 static inline void bpf_trampoline_put(struct bpf_trampoline *tr) {}
 590 #define DEFINE_BPF_DISPATCHER(name)
 591 #define DECLARE_BPF_DISPATCHER(name)
 592 #define BPF_DISPATCHER_FUNC(name) bpf_dispatcher_nopfunc
 593 #define BPF_DISPATCHER_PTR(name) NULL
 594 static inline void bpf_dispatcher_change_prog(struct bpf_dispatcher *d,
 595                                               struct bpf_prog *from,
 596                                               struct bpf_prog *to) {}
 597 static inline bool is_bpf_image_address(unsigned long address)
 598 {
 599         return false;
 600 }
 601 #endif
 602
 603 struct bpf_func_info_aux {
 604         u16 linkage;
 605         bool unreliable;
 606 };
 607
 608 enum bpf_jit_poke_reason {
 609         BPF_POKE_REASON_TAIL_CALL,
 610 };
 611
 612 /* Descriptor of pokes pointing /into/ the JITed image. */
 613 struct bpf_jit_poke_descriptor {
 614         void *ip;
 615         union {
 616                 struct {
 617                         struct bpf_map *map;
 618                         u32 key;
 619                 } tail_call;
 620         };
 621         bool ip_stable;
 622         u8 adj_off;
 623         u16 reason;
 624 };
 625
 626 struct bpf_prog_aux {
 627         atomic64_t refcnt;
 628         u32 used_map_cnt;
 629         u32 max_ctx_offset;
 630         u32 max_pkt_offset;
 631         u32 max_tp_access;
 632         u32 stack_depth;
 633         u32 id;
 634         u32 func_cnt; /* used by non-func prog as the number of func progs */
 635         u32 func_idx; /* 0 for non-func prog, the index in func array for func prog */
 636         u32 attach_btf_id; /* in-kernel BTF type id to attach to */
 637         struct bpf_prog *linked_prog;
 638         bool verifier_zext; /* Zero extensions has been inserted by verifier. */
 639         bool offload_requested;
 640         bool attach_btf_trace; /* true if attaching to BTF-enabled raw tp */
 641         bool func_proto_unreliable;
 642         enum bpf_tramp_prog_type trampoline_prog_type;
 643         struct bpf_trampoline *trampoline;
 644         struct hlist_node tramp_hlist;
 645         /* BTF_KIND_FUNC_PROTO for valid attach_btf_id */
 646         const struct btf_type *attach_func_proto;
 647         /* function name for valid attach_btf_id */
 648         const char *attach_func_name;
 649         struct bpf_prog **func;
 650         void *jit_data; /* JIT specific data. arch dependent */
 651         struct bpf_jit_poke_descriptor *poke_tab;
 652         u32 size_poke_tab;
 653         struct latch_tree_node ksym_tnode;
 654         struct list_head ksym_lnode;
 655         const struct bpf_prog_ops *ops;
 656         struct bpf_map **used_maps;
 657         struct bpf_prog *prog;
 658         struct user_struct *user;
 659         u64 load_time; /* ns since boottime */
 660         struct bpf_map *cgroup_storage[MAX_BPF_CGROUP_STORAGE_TYPE];
 661         char name[BPF_OBJ_NAME_LEN];
 662 #ifdef CONFIG_SECURITY
 663         void *security;
 664 #endif
 665         struct bpf_prog_offload *offload;
 666         struct btf *btf;
 667         struct bpf_func_info *func_info;
 668         struct bpf_func_info_aux *func_info_aux;
 669         /* bpf_line_info loaded from userspace.  linfo->insn_off
 670          * has the xlated insn offset.
 671          * Both the main and sub prog share the same linfo.
 672          * The subprog can access its first linfo by
 673          * using the linfo_idx.
 674          */
 675         struct bpf_line_info *linfo;
 676         /* jited_linfo is the jited addr of the linfo.  It has a
 677          * one to one mapping to linfo:
 678          * jited_linfo[i] is the jited addr for the linfo[i]->insn_off.
 679          * Both the main and sub prog share the same jited_linfo.
 680          * The subprog can access its first jited_linfo by
 681          * using the linfo_idx.
 682          */
 683         void **jited_linfo;
 684         u32 func_info_cnt;
 685         u32 nr_linfo;
 686         /* subprog can use linfo_idx to access its first linfo and
 687          * jited_linfo.
 688          * main prog always has linfo_idx == 0
 689          */
 690         u32 linfo_idx;
 691         u32 num_exentries;
 692         struct exception_table_entry *extable;
 693         struct bpf_prog_stats __percpu *stats;
 694         union {
 695                 struct work_struct work;
 696                 struct rcu_head rcu;
 697         };
 698 };
 699
 700 struct bpf_array_aux {
 701         /* 'Ownership' of prog array is claimed by the first program that
 702          * is going to use this map or by the first program which FD is
 703          * stored in the map to make sure that all callers and callees have
 704          * the same prog type and JITed flag.
 705          */
 706         enum bpf_prog_type type;
 707         bool jited;
 708         /* Programs with direct jumps into programs part of this array. */
 709         struct list_head poke_progs;
 710         struct bpf_map *map;
 711         struct mutex poke_mutex;
 712         struct work_struct work;
 713 };
 714
 715 struct bpf_struct_ops_value;
 716 struct btf_type;
 717 struct btf_member;
 718
 719 #define BPF_STRUCT_OPS_MAX_NR_MEMBERS 64
 720 struct bpf_struct_ops {
 721         const struct bpf_verifier_ops *verifier_ops;
 722         int (*init)(struct btf *btf);
 723         int (*check_member)(const struct btf_type *t,
 724                             const struct btf_member *member);
 725         int (*init_member)(const struct btf_type *t,
 726                            const struct btf_member *member,
 727                            void *kdata, const void *udata);
 728         int (*reg)(void *kdata);
 729         void (*unreg)(void *kdata);
 730         const struct btf_type *type;
 731         const struct btf_type *value_type;
 732         const char *name;
 733         struct btf_func_model func_models[BPF_STRUCT_OPS_MAX_NR_MEMBERS];
 734         u32 type_id;
 735         u32 value_id;
 736 };
 737
 738 #if defined(CONFIG_BPF_JIT) && defined(CONFIG_BPF_SYSCALL)
 739 #define BPF_MODULE_OWNER ((void *)((0xeB9FUL << 2) + POISON_POINTER_DELTA))
 740 const struct bpf_struct_ops *bpf_struct_ops_find(u32 type_id);
 741 void bpf_struct_ops_init(struct btf *btf, struct bpf_verifier_log *log);
 742 bool bpf_struct_ops_get(const void *kdata);
 743 void bpf_struct_ops_put(const void *kdata);
 744 int bpf_struct_ops_map_sys_lookup_elem(struct bpf_map *map, void *key,
 745                                        void *value);
 746 static inline bool bpf_try_module_get(const void *data, struct module *owner)
 747 {
 748         if (owner == BPF_MODULE_OWNER)
 749                 return bpf_struct_ops_get(data);
 750         else
 751                 return try_module_get(owner);
 752 }
 753 static inline void bpf_module_put(const void *data, struct module *owner)
 754 {
 755         if (owner == BPF_MODULE_OWNER)
 756                 bpf_struct_ops_put(data);
 757         else
 758                 module_put(owner);
 759 }
 760 #else
 761 static inline const struct bpf_struct_ops *bpf_struct_ops_find(u32 type_id)
 762 {
 763         return NULL;
 764 }
 765 static inline void bpf_struct_ops_init(struct btf *btf,
 766                                        struct bpf_verifier_log *log)
 767 {
 768 }
 769 static inline bool bpf_try_module_get(const void *data, struct module *owner)
 770 {
 771         return try_module_get(owner);
 772 }
 773 static inline void bpf_module_put(const void *data, struct module *owner)
 774 {
 775         module_put(owner);
 776 }
 777 static inline int bpf_struct_ops_map_sys_lookup_elem(struct bpf_map *map,
 778                                                      void *key,
 779                                                      void *value)
 780 {
 781         return -EINVAL;
 782 }
 783 #endif
 784
 785 struct bpf_array {
 786         struct bpf_map map;
 787         u32 elem_size;
 788         u32 index_mask;
 789         struct bpf_array_aux *aux;
 790         union {
 791                 char value[0] __aligned(8);
 792                 void *ptrs[0] __aligned(8);
 793                 void __percpu *pptrs[0] __aligned(8);
 794         };
 795 };
 796
 797 #define BPF_COMPLEXITY_LIMIT_INSNS      1000000 /* yes. 1M insns */
 798 #define MAX_TAIL_CALL_CNT 32
 799
 800 #define BPF_F_ACCESS_MASK       (BPF_F_RDONLY |         \
 801                                  BPF_F_RDONLY_PROG |    \
 802                                  BPF_F_WRONLY |         \
 803                                  BPF_F_WRONLY_PROG)
 804
 805 #define BPF_MAP_CAN_READ        BIT(0)
 806 #define BPF_MAP_CAN_WRITE       BIT(1)
 807
 808 static inline u32 bpf_map_flags_to_cap(struct bpf_map *map)
 809 {
 810         u32 access_flags = map->map_flags & (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG);
 811
 812         /* Combination of BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG is
 813          * not possible.
 814          */
 815         if (access_flags & BPF_F_RDONLY_PROG)
 816                 return BPF_MAP_CAN_READ;
 817         else if (access_flags & BPF_F_WRONLY_PROG)
 818                 return BPF_MAP_CAN_WRITE;
 819         else
 820                 return BPF_MAP_CAN_READ | BPF_MAP_CAN_WRITE;
 821 }
 822
 823 static inline bool bpf_map_flags_access_ok(u32 access_flags)
 824 {
 825         return (access_flags & (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG)) !=
 826                (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG);
 827 }
 828
 829 struct bpf_event_entry {
 830         struct perf_event *event;
 831         struct file *perf_file;
 832         struct file *map_file;
 833         struct rcu_head rcu;
 834 };
 835
 836 bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
 837 int bpf_prog_calc_tag(struct bpf_prog *fp);
 838 const char *kernel_type_name(u32 btf_type_id);
 839
 840 const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
 841
 842 typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src,
 843                                         unsigned long off, unsigned long len);
 844 typedef u32 (*bpf_convert_ctx_access_t)(enum bpf_access_type type,
 845                                         const struct bpf_insn *src,
 846                                         struct bpf_insn *dst,
 847                                         struct bpf_prog *prog,
 848                                         u32 *target_size);
 849
 850 u64 bpf_event_output(struct bpf_map *map, u64 flags, void *meta, u64 meta_size,
 851                      void *ctx, u64 ctx_size, bpf_ctx_copy_t ctx_copy);
 852
 853 /* an array of programs to be executed under rcu_lock.
 854  *
 855  * Typical usage:
 856  * ret = BPF_PROG_RUN_ARRAY(&bpf_prog_array, ctx, BPF_PROG_RUN);
 857  *
 858  * the structure returned by bpf_prog_array_alloc() should be populated
 859  * with program pointers and the last pointer must be NULL.
 860  * The user has to keep refcnt on the program and make sure the program
 861  * is removed from the array before bpf_prog_put().
 862  * The 'struct bpf_prog_array *' should only be replaced with xchg()
 863  * since other cpus are walking the array of pointers in parallel.
 864  */
 865 struct bpf_prog_array_item {
 866         struct bpf_prog *prog;
 867         struct bpf_cgroup_storage *cgroup_storage[MAX_BPF_CGROUP_STORAGE_TYPE];
 868 };
 869
 870 struct bpf_prog_array {
 871         struct rcu_head rcu;
 872         struct bpf_prog_array_item items[];
 873 };
 874
 875 struct bpf_prog_array *bpf_prog_array_alloc(u32 prog_cnt, gfp_t flags);
 876 void bpf_prog_array_free(struct bpf_prog_array *progs);
 877 int bpf_prog_array_length(struct bpf_prog_array *progs);
 878 bool bpf_prog_array_is_empty(struct bpf_prog_array *array);
 879 int bpf_prog_array_copy_to_user(struct bpf_prog_array *progs,
 880                                 __u32 __user *prog_ids, u32 cnt);
 881
 882 void bpf_prog_array_delete_safe(struct bpf_prog_array *progs,
 883                                 struct bpf_prog *old_prog);
 884 int bpf_prog_array_copy_info(struct bpf_prog_array *array,
 885                              u32 *prog_ids, u32 request_cnt,
 886                              u32 *prog_cnt);
 887 int bpf_prog_array_copy(struct bpf_prog_array *old_array,
 888                         struct bpf_prog *exclude_prog,
 889                         struct bpf_prog *include_prog,
 890                         struct bpf_prog_array **new_array);
 891
 892 #define __BPF_PROG_RUN_ARRAY(array, ctx, func, check_non_null)  \
 893         ({                                              \
 894                 struct bpf_prog_array_item *_item;      \
 895                 struct bpf_prog *_prog;                 \
 896                 struct bpf_prog_array *_array;          \
 897                 u32 _ret = 1;                           \
 898                 migrate_disable();                      \
 899                 rcu_read_lock();                        \
 900                 _array = rcu_dereference(array);        \
 901                 if (unlikely(check_non_null && !_array))\
 902                         goto _out;                      \
 903                 _item = &_array->items[0];              \
 904                 while ((_prog = READ_ONCE(_item->prog))) {              \
 905                         bpf_cgroup_storage_set(_item->cgroup_storage);  \
 906                         _ret &= func(_prog, ctx);       \
 907                         _item++;                        \
 908                 }                                       \
 909 _out:                                                   \
 910                 rcu_read_unlock();                      \
 911                 migrate_enable();                       \
 912                 _ret;                                   \
 913          })
 914
 915 /* To be used by __cgroup_bpf_run_filter_skb for EGRESS BPF progs
 916  * so BPF programs can request cwr for TCP packets.
 917  *
 918  * Current cgroup skb programs can only return 0 or 1 (0 to drop the
 919  * packet. This macro changes the behavior so the low order bit
 920  * indicates whether the packet should be dropped (0) or not (1)
 921  * and the next bit is a congestion notification bit. This could be
 922  * used by TCP to call tcp_enter_cwr()
 923  *
 924  * Hence, new allowed return values of CGROUP EGRESS BPF programs are:
 925  *   0: drop packet
 926  *   1: keep packet
 927  *   2: drop packet and cn
 928  *   3: keep packet and cn
 929  *
 930  * This macro then converts it to one of the NET_XMIT or an error
 931  * code that is then interpreted as drop packet (and no cn):
 932  *   0: NET_XMIT_SUCCESS  skb should be transmitted
 933  *   1: NET_XMIT_DROP     skb should be dropped and cn
 934  *   2: NET_XMIT_CN       skb should be transmitted and cn
 935  *   3: -EPERM            skb should be dropped
 936  */
 937 #define BPF_PROG_CGROUP_INET_EGRESS_RUN_ARRAY(array, ctx, func)         \
 938         ({                                              \
 939                 struct bpf_prog_array_item *_item;      \
 940                 struct bpf_prog *_prog;                 \
 941                 struct bpf_prog_array *_array;          \
 942                 u32 ret;                                \
 943                 u32 _ret = 1;                           \
 944                 u32 _cn = 0;                            \
 945                 migrate_disable();                      \
 946                 rcu_read_lock();                        \
 947                 _array = rcu_dereference(array);        \
 948                 _item = &_array->items[0];              \
 949                 while ((_prog = READ_ONCE(_item->prog))) {              \
 950                         bpf_cgroup_storage_set(_item->cgroup_storage);  \
 951                         ret = func(_prog, ctx);         \
 952                         _ret &= (ret & 1);              \
 953                         _cn |= (ret & 2);               \
 954                         _item++;                        \
 955                 }                                       \
 956                 rcu_read_unlock();                      \
 957                 migrate_enable();                       \
 958                 if (_ret)                               \
 959                         _ret = (_cn ? NET_XMIT_CN : NET_XMIT_SUCCESS);  \
 960                 else                                    \
 961                         _ret = (_cn ? NET_XMIT_DROP : -EPERM);          \
 962                 _ret;                                   \
 963         })
 964
 965 #define BPF_PROG_RUN_ARRAY(array, ctx, func)            \
 966         __BPF_PROG_RUN_ARRAY(array, ctx, func, false)
 967
 968 #define BPF_PROG_RUN_ARRAY_CHECK(array, ctx, func)      \
 969         __BPF_PROG_RUN_ARRAY(array, ctx, func, true)
 970
 971 #ifdef CONFIG_BPF_SYSCALL
 972 DECLARE_PER_CPU(int, bpf_prog_active);
 973
 974 /*
 975  * Block execution of BPF programs attached to instrumentation (perf,
 976  * kprobes, tracepoints) to prevent deadlocks on map operations as any of
 977  * these events can happen inside a region which holds a map bucket lock
 978  * and can deadlock on it.
 979  *
 980  * Use the preemption safe inc/dec variants on RT because migrate disable
 981  * is preemptible on RT and preemption in the middle of the RMW operation
 982  * might lead to inconsistent state. Use the raw variants for non RT
 983  * kernels as migrate_disable() maps to preempt_disable() so the slightly
 984  * more expensive save operation can be avoided.
 985  */
 986 static inline void bpf_disable_instrumentation(void)
 987 {
 988         migrate_disable();
 989         if (IS_ENABLED(CONFIG_PREEMPT_RT))
 990                 this_cpu_inc(bpf_prog_active);
 991         else
 992                 __this_cpu_inc(bpf_prog_active);
 993 }
 994
 995 static inline void bpf_enable_instrumentation(void)
 996 {
 997         if (IS_ENABLED(CONFIG_PREEMPT_RT))
 998                 this_cpu_dec(bpf_prog_active);
 999         else
1000                 __this_cpu_dec(bpf_prog_active);
1001         migrate_enable();
1002 }
1003
1004 extern const struct file_operations bpf_map_fops;
1005 extern const struct file_operations bpf_prog_fops;
1006
1007 #define BPF_PROG_TYPE(_id, _name, prog_ctx_type, kern_ctx_type) \
1008         extern const struct bpf_prog_ops _name ## _prog_ops; \
1009         extern const struct bpf_verifier_ops _name ## _verifier_ops;
1010 #define BPF_MAP_TYPE(_id, _ops) \
1011         extern const struct bpf_map_ops _ops;
1012 #include <linux/bpf_types.h>
1013 #undef BPF_PROG_TYPE
1014 #undef BPF_MAP_TYPE
1015
1016 extern const struct bpf_prog_ops bpf_offload_prog_ops;
1017 extern const struct bpf_verifier_ops tc_cls_act_analyzer_ops;
1018 extern const struct bpf_verifier_ops xdp_analyzer_ops;
1019
1020 struct bpf_prog *bpf_prog_get(u32 ufd);
1021 struct bpf_prog *bpf_prog_get_type_dev(u32 ufd, enum bpf_prog_type type,
1022                                        bool attach_drv);
1023 void bpf_prog_add(struct bpf_prog *prog, int i);
1024 void bpf_prog_sub(struct bpf_prog *prog, int i);
1025 void bpf_prog_inc(struct bpf_prog *prog);
1026 struct bpf_prog * __must_check bpf_prog_inc_not_zero(struct bpf_prog *prog);
1027 void bpf_prog_put(struct bpf_prog *prog);
1028 int __bpf_prog_charge(struct user_struct *user, u32 pages);
1029 void __bpf_prog_uncharge(struct user_struct *user, u32 pages);
1030 void __bpf_free_used_maps(struct bpf_prog_aux *aux,
1031                           struct bpf_map **used_maps, u32 len);
1032
1033 void bpf_prog_free_id(struct bpf_prog *prog, bool do_idr_lock);
1034 void bpf_map_free_id(struct bpf_map *map, bool do_idr_lock);
1035
1036 struct bpf_map *bpf_map_get(u32 ufd);
1037 struct bpf_map *bpf_map_get_with_uref(u32 ufd);
1038 struct bpf_map *__bpf_map_get(struct fd f);
1039 void bpf_map_inc(struct bpf_map *map);
1040 void bpf_map_inc_with_uref(struct bpf_map *map);
1041 struct bpf_map * __must_check bpf_map_inc_not_zero(struct bpf_map *map);
1042 void bpf_map_put_with_uref(struct bpf_map *map);
1043 void bpf_map_put(struct bpf_map *map);
1044 int bpf_map_charge_memlock(struct bpf_map *map, u32 pages);
1045 void bpf_map_uncharge_memlock(struct bpf_map *map, u32 pages);
1046 int bpf_map_charge_init(struct bpf_map_memory *mem, u64 size);
1047 void bpf_map_charge_finish(struct bpf_map_memory *mem);
1048 void bpf_map_charge_move(struct bpf_map_memory *dst,
1049                          struct bpf_map_memory *src);
1050 void *bpf_map_area_alloc(u64 size, int numa_node);
1051 void *bpf_map_area_mmapable_alloc(u64 size, int numa_node);
1052 void bpf_map_area_free(void *base);
1053 void bpf_map_init_from_attr(struct bpf_map *map, union bpf_attr *attr);
1054 int  generic_map_lookup_batch(struct bpf_map *map,
1055                               const union bpf_attr *attr,
1056                               union bpf_attr __user *uattr);
1057 int  generic_map_update_batch(struct bpf_map *map,
1058                               const union bpf_attr *attr,
1059                               union bpf_attr __user *uattr);
1060 int  generic_map_delete_batch(struct bpf_map *map,
1061                               const union bpf_attr *attr,
1062                               union bpf_attr __user *uattr);
1063
1064 extern int sysctl_unprivileged_bpf_disabled;
1065
1066 int bpf_map_new_fd(struct bpf_map *map, int flags);
1067 int bpf_prog_new_fd(struct bpf_prog *prog);
1068
1069 struct bpf_link;
1070
1071 struct bpf_link_ops {
1072         void (*release)(struct bpf_link *link);
1073         void (*dealloc)(struct bpf_link *link);
1074 };
1075
1076 void bpf_link_init(struct bpf_link *link, const struct bpf_link_ops *ops,
1077                    struct bpf_prog *prog);
1078 void bpf_link_inc(struct bpf_link *link);
1079 void bpf_link_put(struct bpf_link *link);
1080 int bpf_link_new_fd(struct bpf_link *link);
1081 struct file *bpf_link_new_file(struct bpf_link *link, int *reserved_fd);
1082 struct bpf_link *bpf_link_get_from_fd(u32 ufd);
1083
1084 int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
1085 int bpf_obj_get_user(const char __user *pathname, int flags);
1086
1087 int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value);
1088 int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value);
1089 int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
1090                            u64 flags);
1091 int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
1092                             u64 flags);
1093
1094 int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value);
1095
1096 int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
1097                                  void *key, void *value, u64 map_flags);
1098 int bpf_fd_array_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
1099 int bpf_fd_htab_map_update_elem(struct bpf_map *map, struct file *map_file,
1100                                 void *key, void *value, u64 map_flags);
1101 int bpf_fd_htab_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
1102
1103 int bpf_get_file_flag(int flags);
1104 int bpf_check_uarg_tail_zero(void __user *uaddr, size_t expected_size,
1105                              size_t actual_size);
1106
1107 /* memcpy that is used with 8-byte aligned pointers, power-of-8 size and
1108  * forced to use 'long' read/writes to try to atomically copy long counters.
1109  * Best-effort only.  No barriers here, since it _will_ race with concurrent
1110  * updates from BPF programs. Called from bpf syscall and mostly used with
1111  * size 8 or 16 bytes, so ask compiler to inline it.
1112  */
1113 static inline void bpf_long_memcpy(void *dst, const void *src, u32 size)
1114 {
1115         const long *lsrc = src;
1116         long *ldst = dst;
1117
1118         size /= sizeof(long);
1119         while (size--)
1120                 *ldst++ = *lsrc++;
1121 }
1122
1123 /* verify correctness of eBPF program */
1124 int bpf_check(struct bpf_prog **fp, union bpf_attr *attr,
1125               union bpf_attr __user *uattr);
1126 void bpf_patch_call_args(struct bpf_insn *insn, u32 stack_depth);
1127
1128 /* Map specifics */
1129 struct xdp_buff;
1130 struct sk_buff;
1131
1132 struct bpf_dtab_netdev *__dev_map_lookup_elem(struct bpf_map *map, u32 key);
1133 struct bpf_dtab_netdev *__dev_map_hash_lookup_elem(struct bpf_map *map, u32 key);
1134 void __dev_flush(void);
1135 int dev_xdp_enqueue(struct net_device *dev, struct xdp_buff *xdp,
1136                     struct net_device *dev_rx);
1137 int dev_map_enqueue(struct bpf_dtab_netdev *dst, struct xdp_buff *xdp,
1138                     struct net_device *dev_rx);
1139 int dev_map_generic_redirect(struct bpf_dtab_netdev *dst, struct sk_buff *skb,
1140                              struct bpf_prog *xdp_prog);
1141
1142 struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key);
1143 void __cpu_map_flush(void);
1144 int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu, struct xdp_buff *xdp,
1145                     struct net_device *dev_rx);
1146
1147 /* Return map's numa specified by userspace */
1148 static inline int bpf_map_attr_numa_node(const union bpf_attr *attr)
1149 {
1150         return (attr->map_flags & BPF_F_NUMA_NODE) ?
1151                 attr->numa_node : NUMA_NO_NODE;
1152 }
1153
1154 struct bpf_prog *bpf_prog_get_type_path(const char *name, enum bpf_prog_type type);
1155 int array_map_alloc_check(union bpf_attr *attr);
1156
1157 int bpf_prog_test_run_xdp(struct bpf_prog *prog, const union bpf_attr *kattr,
1158                           union bpf_attr __user *uattr);
1159 int bpf_prog_test_run_skb(struct bpf_prog *prog, const union bpf_attr *kattr,
1160                           union bpf_attr __user *uattr);
1161 int bpf_prog_test_run_tracing(struct bpf_prog *prog,
1162                               const union bpf_attr *kattr,
1163                               union bpf_attr __user *uattr);
1164 int bpf_prog_test_run_flow_dissector(struct bpf_prog *prog,
1165                                      const union bpf_attr *kattr,
1166                                      union bpf_attr __user *uattr);
1167 bool btf_ctx_access(int off, int size, enum bpf_access_type type,
1168                     const struct bpf_prog *prog,
1169                     struct bpf_insn_access_aux *info);
1170 int btf_struct_access(struct bpf_verifier_log *log,
1171                       const struct btf_type *t, int off, int size,
1172                       enum bpf_access_type atype,
1173                       u32 *next_btf_id);
1174 int btf_resolve_helper_id(struct bpf_verifier_log *log,
1175                           const struct bpf_func_proto *fn, int);
1176
1177 int btf_distill_func_proto(struct bpf_verifier_log *log,
1178                            struct btf *btf,
1179                            const struct btf_type *func_proto,
1180                            const char *func_name,
1181                            struct btf_func_model *m);
1182
1183 struct bpf_reg_state;
1184 int btf_check_func_arg_match(struct bpf_verifier_env *env, int subprog,
1185                              struct bpf_reg_state *regs);
1186 int btf_prepare_func_args(struct bpf_verifier_env *env, int subprog,
1187                           struct bpf_reg_state *reg);
1188 int btf_check_type_match(struct bpf_verifier_env *env, struct bpf_prog *prog,
1189                          struct btf *btf, const struct btf_type *t);
1190
1191 struct bpf_prog *bpf_prog_by_id(u32 id);
1192
1193 #else /* !CONFIG_BPF_SYSCALL */
1194 static inline struct bpf_prog *bpf_prog_get(u32 ufd)
1195 {
1196         return ERR_PTR(-EOPNOTSUPP);
1197 }
1198
1199 static inline struct bpf_prog *bpf_prog_get_type_dev(u32 ufd,
1200                                                      enum bpf_prog_type type,
1201                                                      bool attach_drv)
1202 {
1203         return ERR_PTR(-EOPNOTSUPP);
1204 }
1205
1206 static inline void bpf_prog_add(struct bpf_prog *prog, int i)
1207 {
1208 }
1209
1210 static inline void bpf_prog_sub(struct bpf_prog *prog, int i)
1211 {
1212 }
1213
1214 static inline void bpf_prog_put(struct bpf_prog *prog)
1215 {
1216 }
1217
1218 static inline void bpf_prog_inc(struct bpf_prog *prog)
1219 {
1220 }
1221
1222 static inline struct bpf_prog *__must_check
1223 bpf_prog_inc_not_zero(struct bpf_prog *prog)
1224 {
1225         return ERR_PTR(-EOPNOTSUPP);
1226 }
1227
1228 static inline int __bpf_prog_charge(struct user_struct *user, u32 pages)
1229 {
1230         return 0;
1231 }
1232
1233 static inline void __bpf_prog_uncharge(struct user_struct *user, u32 pages)
1234 {
1235 }
1236
1237 static inline int bpf_obj_get_user(const char __user *pathname, int flags)
1238 {
1239         return -EOPNOTSUPP;
1240 }
1241
1242 static inline struct net_device  *__dev_map_lookup_elem(struct bpf_map *map,
1243                                                        u32 key)
1244 {
1245         return NULL;
1246 }
1247
1248 static inline struct net_device  *__dev_map_hash_lookup_elem(struct bpf_map *map,
1249                                                              u32 key)
1250 {
1251         return NULL;
1252 }
1253
1254 static inline void __dev_flush(void)
1255 {
1256 }
1257
1258 struct xdp_buff;
1259 struct bpf_dtab_netdev;
1260
1261 static inline
1262 int dev_xdp_enqueue(struct net_device *dev, struct xdp_buff *xdp,
1263                     struct net_device *dev_rx)
1264 {
1265         return 0;
1266 }
1267
1268 static inline
1269 int dev_map_enqueue(struct bpf_dtab_netdev *dst, struct xdp_buff *xdp,
1270                     struct net_device *dev_rx)
1271 {
1272         return 0;
1273 }
1274
1275 struct sk_buff;
1276
1277 static inline int dev_map_generic_redirect(struct bpf_dtab_netdev *dst,
1278                                            struct sk_buff *skb,
1279                                            struct bpf_prog *xdp_prog)
1280 {
1281         return 0;
1282 }
1283
1284 static inline
1285 struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key)
1286 {
1287         return NULL;
1288 }
1289
1290 static inline void __cpu_map_flush(void)
1291 {
1292 }
1293
1294 static inline int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu,
1295                                   struct xdp_buff *xdp,
1296                                   struct net_device *dev_rx)
1297 {
1298         return 0;
1299 }
1300
1301 static inline struct bpf_prog *bpf_prog_get_type_path(const char *name,
1302                                 enum bpf_prog_type type)
1303 {
1304         return ERR_PTR(-EOPNOTSUPP);
1305 }
1306
1307 static inline int bpf_prog_test_run_xdp(struct bpf_prog *prog,
1308                                         const union bpf_attr *kattr,
1309                                         union bpf_attr __user *uattr)
1310 {
1311         return -ENOTSUPP;
1312 }
1313
1314 static inline int bpf_prog_test_run_skb(struct bpf_prog *prog,
1315                                         const union bpf_attr *kattr,
1316                                         union bpf_attr __user *uattr)
1317 {
1318         return -ENOTSUPP;
1319 }
1320
1321 static inline int bpf_prog_test_run_tracing(struct bpf_prog *prog,
1322                                             const union bpf_attr *kattr,
1323                                             union bpf_attr __user *uattr)
1324 {
1325         return -ENOTSUPP;
1326 }
1327
1328 static inline int bpf_prog_test_run_flow_dissector(struct bpf_prog *prog,
1329                                                    const union bpf_attr *kattr,
1330                                                    union bpf_attr __user *uattr)
1331 {
1332         return -ENOTSUPP;
1333 }
1334
1335 static inline void bpf_map_put(struct bpf_map *map)
1336 {
1337 }
1338
1339 static inline struct bpf_prog *bpf_prog_by_id(u32 id)
1340 {
1341         return ERR_PTR(-ENOTSUPP);
1342 }
1343 #endif /* CONFIG_BPF_SYSCALL */
1344
1345 static inline struct bpf_prog *bpf_prog_get_type(u32 ufd,
1346                                                  enum bpf_prog_type type)
1347 {
1348         return bpf_prog_get_type_dev(ufd, type, false);
1349 }
1350
1351 bool bpf_prog_get_ok(struct bpf_prog *, enum bpf_prog_type *, bool);
1352
1353 int bpf_prog_offload_compile(struct bpf_prog *prog);
1354 void bpf_prog_offload_destroy(struct bpf_prog *prog);
1355 int bpf_prog_offload_info_fill(struct bpf_prog_info *info,
1356                                struct bpf_prog *prog);
1357
1358 int bpf_map_offload_info_fill(struct bpf_map_info *info, struct bpf_map *map);
1359
1360 int bpf_map_offload_lookup_elem(struct bpf_map *map, void *key, void *value);
1361 int bpf_map_offload_update_elem(struct bpf_map *map,
1362                                 void *key, void *value, u64 flags);
1363 int bpf_map_offload_delete_elem(struct bpf_map *map, void *key);
1364 int bpf_map_offload_get_next_key(struct bpf_map *map,
1365                                  void *key, void *next_key);
1366
1367 bool bpf_offload_prog_map_match(struct bpf_prog *prog, struct bpf_map *map);
1368
1369 struct bpf_offload_dev *
1370 bpf_offload_dev_create(const struct bpf_prog_offload_ops *ops, void *priv);
1371 void bpf_offload_dev_destroy(struct bpf_offload_dev *offdev);
1372 void *bpf_offload_dev_priv(struct bpf_offload_dev *offdev);
1373 int bpf_offload_dev_netdev_register(struct bpf_offload_dev *offdev,
1374                                     struct net_device *netdev);
1375 void bpf_offload_dev_netdev_unregister(struct bpf_offload_dev *offdev,
1376                                        struct net_device *netdev);
1377 bool bpf_offload_dev_match(struct bpf_prog *prog, struct net_device *netdev);
1378
1379 #if defined(CONFIG_NET) && defined(CONFIG_BPF_SYSCALL)
1380 int bpf_prog_offload_init(struct bpf_prog *prog, union bpf_attr *attr);
1381
1382 static inline bool bpf_prog_is_dev_bound(const struct bpf_prog_aux *aux)
1383 {
1384         return aux->offload_requested;
1385 }
1386
1387 static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
1388 {
1389         return unlikely(map->ops == &bpf_map_offload_ops);
1390 }
1391
1392 struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr);
1393 void bpf_map_offload_map_free(struct bpf_map *map);
1394 #else
1395 static inline int bpf_prog_offload_init(struct bpf_prog *prog,
1396                                         union bpf_attr *attr)
1397 {
1398         return -EOPNOTSUPP;
1399 }
1400
1401 static inline bool bpf_prog_is_dev_bound(struct bpf_prog_aux *aux)
1402 {
1403         return false;
1404 }
1405
1406 static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
1407 {
1408         return false;
1409 }
1410
1411 static inline struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr)
1412 {
1413         return ERR_PTR(-EOPNOTSUPP);
1414 }
1415
1416 static inline void bpf_map_offload_map_free(struct bpf_map *map)
1417 {
1418 }
1419 #endif /* CONFIG_NET && CONFIG_BPF_SYSCALL */
1420
1421 #if defined(CONFIG_BPF_STREAM_PARSER)
1422 int sock_map_prog_update(struct bpf_map *map, struct bpf_prog *prog, u32 which);
1423 int sock_map_get_from_fd(const union bpf_attr *attr, struct bpf_prog *prog);
1424 void sock_map_unhash(struct sock *sk);
1425 void sock_map_close(struct sock *sk, long timeout);
1426 #else
1427 static inline int sock_map_prog_update(struct bpf_map *map,
1428                                        struct bpf_prog *prog, u32 which)
1429 {
1430         return -EOPNOTSUPP;
1431 }
1432
1433 static inline int sock_map_get_from_fd(const union bpf_attr *attr,
1434                                        struct bpf_prog *prog)
1435 {
1436         return -EINVAL;
1437 }
1438 #endif /* CONFIG_BPF_STREAM_PARSER */
1439
1440 #if defined(CONFIG_INET) && defined(CONFIG_BPF_SYSCALL)
1441 void bpf_sk_reuseport_detach(struct sock *sk);
1442 int bpf_fd_reuseport_array_lookup_elem(struct bpf_map *map, void *key,
1443                                        void *value);
1444 int bpf_fd_reuseport_array_update_elem(struct bpf_map *map, void *key,
1445                                        void *value, u64 map_flags);
1446 #else
1447 static inline void bpf_sk_reuseport_detach(struct sock *sk)
1448 {
1449 }
1450
1451 #ifdef CONFIG_BPF_SYSCALL
1452 static inline int bpf_fd_reuseport_array_lookup_elem(struct bpf_map *map,
1453                                                      void *key, void *value)
1454 {
1455         return -EOPNOTSUPP;
1456 }
1457
1458 static inline int bpf_fd_reuseport_array_update_elem(struct bpf_map *map,
1459                                                      void *key, void *value,
1460                                                      u64 map_flags)
1461 {
1462         return -EOPNOTSUPP;
1463 }
1464 #endif /* CONFIG_BPF_SYSCALL */
1465 #endif /* defined(CONFIG_INET) && defined(CONFIG_BPF_SYSCALL) */
1466
1467 /* verifier prototypes for helper functions called from eBPF programs */
1468 extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
1469 extern const struct bpf_func_proto bpf_map_update_elem_proto;
1470 extern const struct bpf_func_proto bpf_map_delete_elem_proto;
1471 extern const struct bpf_func_proto bpf_map_push_elem_proto;
1472 extern const struct bpf_func_proto bpf_map_pop_elem_proto;
1473 extern const struct bpf_func_proto bpf_map_peek_elem_proto;
1474
1475 extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
1476 extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
1477 extern const struct bpf_func_proto bpf_get_numa_node_id_proto;
1478 extern const struct bpf_func_proto bpf_tail_call_proto;
1479 extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
1480 extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
1481 extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
1482 extern const struct bpf_func_proto bpf_get_current_comm_proto;
1483 extern const struct bpf_func_proto bpf_get_stackid_proto;
1484 extern const struct bpf_func_proto bpf_get_stack_proto;
1485 extern const struct bpf_func_proto bpf_sock_map_update_proto;
1486 extern const struct bpf_func_proto bpf_sock_hash_update_proto;
1487 extern const struct bpf_func_proto bpf_get_current_cgroup_id_proto;
1488 extern const struct bpf_func_proto bpf_msg_redirect_hash_proto;
1489 extern const struct bpf_func_proto bpf_msg_redirect_map_proto;
1490 extern const struct bpf_func_proto bpf_sk_redirect_hash_proto;
1491 extern const struct bpf_func_proto bpf_sk_redirect_map_proto;
1492 extern const struct bpf_func_proto bpf_spin_lock_proto;
1493 extern const struct bpf_func_proto bpf_spin_unlock_proto;
1494 extern const struct bpf_func_proto bpf_get_local_storage_proto;
1495 extern const struct bpf_func_proto bpf_strtol_proto;
1496 extern const struct bpf_func_proto bpf_strtoul_proto;
1497 extern const struct bpf_func_proto bpf_tcp_sock_proto;
1498 extern const struct bpf_func_proto bpf_jiffies64_proto;
1499 extern const struct bpf_func_proto bpf_get_ns_current_pid_tgid_proto;
1500
1501 /* Shared helpers among cBPF and eBPF. */
1502 void bpf_user_rnd_init_once(void);
1503 u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
1504
1505 #if defined(CONFIG_NET)
1506 bool bpf_sock_common_is_valid_access(int off, int size,
1507                                      enum bpf_access_type type,
1508                                      struct bpf_insn_access_aux *info);
1509 bool bpf_sock_is_valid_access(int off, int size, enum bpf_access_type type,
1510                               struct bpf_insn_access_aux *info);
1511 u32 bpf_sock_convert_ctx_access(enum bpf_access_type type,
1512                                 const struct bpf_insn *si,
1513                                 struct bpf_insn *insn_buf,
1514                                 struct bpf_prog *prog,
1515                                 u32 *target_size);
1516 #else
1517 static inline bool bpf_sock_common_is_valid_access(int off, int size,
1518                                                    enum bpf_access_type type,
1519                                                    struct bpf_insn_access_aux *info)
1520 {
1521         return false;
1522 }
1523 static inline bool bpf_sock_is_valid_access(int off, int size,
1524                                             enum bpf_access_type type,
1525                                             struct bpf_insn_access_aux *info)
1526 {
1527         return false;
1528 }
1529 static inline u32 bpf_sock_convert_ctx_access(enum bpf_access_type type,
1530                                               const struct bpf_insn *si,
1531                                               struct bpf_insn *insn_buf,
1532                                               struct bpf_prog *prog,
1533                                               u32 *target_size)
1534 {
1535         return 0;
1536 }
1537 #endif
1538
1539 #ifdef CONFIG_INET
1540 struct sk_reuseport_kern {
1541         struct sk_buff *skb;
1542         struct sock *sk;
1543         struct sock *selected_sk;
1544         void *data_end;
1545         u32 hash;
1546         u32 reuseport_id;
1547         bool bind_inany;
1548 };
1549 bool bpf_tcp_sock_is_valid_access(int off, int size, enum bpf_access_type type,
1550                                   struct bpf_insn_access_aux *info);
1551
1552 u32 bpf_tcp_sock_convert_ctx_access(enum bpf_access_type type,
1553                                     const struct bpf_insn *si,
1554                                     struct bpf_insn *insn_buf,
1555                                     struct bpf_prog *prog,
1556                                     u32 *target_size);
1557
1558 bool bpf_xdp_sock_is_valid_access(int off, int size, enum bpf_access_type type,
1559                                   struct bpf_insn_access_aux *info);
1560
1561 u32 bpf_xdp_sock_convert_ctx_access(enum bpf_access_type type,
1562                                     const struct bpf_insn *si,
1563                                     struct bpf_insn *insn_buf,
1564                                     struct bpf_prog *prog,
1565                                     u32 *target_size);
1566 #else
1567 static inline bool bpf_tcp_sock_is_valid_access(int off, int size,
1568                                                 enum bpf_access_type type,
1569                                                 struct bpf_insn_access_aux *info)
1570 {
1571         return false;
1572 }
1573
1574 static inline u32 bpf_tcp_sock_convert_ctx_access(enum bpf_access_type type,
1575                                                   const struct bpf_insn *si,
1576                                                   struct bpf_insn *insn_buf,
1577                                                   struct bpf_prog *prog,
1578                                                   u32 *target_size)
1579 {
1580         return 0;
1581 }
1582 static inline bool bpf_xdp_sock_is_valid_access(int off, int size,
1583                                                 enum bpf_access_type type,
1584                                                 struct bpf_insn_access_aux *info)
1585 {
1586         return false;
1587 }
1588
1589 static inline u32 bpf_xdp_sock_convert_ctx_access(enum bpf_access_type type,
1590                                                   const struct bpf_insn *si,
1591                                                   struct bpf_insn *insn_buf,
1592                                                   struct bpf_prog *prog,
1593                                                   u32 *target_size)
1594 {
1595         return 0;
1596 }
1597 #endif /* CONFIG_INET */
1598
1599 enum bpf_text_poke_type {
1600         BPF_MOD_CALL,
1601         BPF_MOD_JUMP,
1602 };
1603
1604 int bpf_arch_text_poke(void *ip, enum bpf_text_poke_type t,
1605                        void *addr1, void *addr2);
1606
1607 #endif /* _LINUX_BPF_H */