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