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