include/linux/bpf.h

   1 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
   2  *
   3  * This program is free software; you can redistribute it and/or
   4  * modify it under the terms of version 2 of the GNU General Public
   5  * License as published by the Free Software Foundation.
   6  */
   7 #ifndef _LINUX_BPF_H
   8 #define _LINUX_BPF_H 1
   9
  10 #include <uapi/linux/bpf.h>
  11
  12 #include <linux/workqueue.h>
  13 #include <linux/file.h>
  14 #include <linux/percpu.h>
  15 #include <linux/err.h>
  16 #include <linux/rbtree_latch.h>
  17 #include <linux/numa.h>
  18 #include <linux/wait.h>
  19 #include <linux/u64_stats_sync.h>
  20
  21 struct bpf_verifier_env;
  22 struct perf_event;
  23 struct bpf_prog;
  24 struct bpf_map;
  25 struct sock;
  26 struct seq_file;
  27 struct btf;
  28 struct btf_type;
  29
  30 /* map is generic key/value storage optionally accesible by eBPF programs */
  31 struct bpf_map_ops {
  32         /* funcs callable from userspace (via syscall) */
  33         int (*map_alloc_check)(union bpf_attr *attr);
  34         struct bpf_map *(*map_alloc)(union bpf_attr *attr);
  35         void (*map_release)(struct bpf_map *map, struct file *map_file);
  36         void (*map_free)(struct bpf_map *map);
  37         int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key);
  38         void (*map_release_uref)(struct bpf_map *map);
  39
  40         /* funcs callable from userspace and from eBPF programs */
  41         void *(*map_lookup_elem)(struct bpf_map *map, void *key);
  42         int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags);
  43         int (*map_delete_elem)(struct bpf_map *map, void *key);
  44         int (*map_push_elem)(struct bpf_map *map, void *value, u64 flags);
  45         int (*map_pop_elem)(struct bpf_map *map, void *value);
  46         int (*map_peek_elem)(struct bpf_map *map, void *value);
  47
  48         /* funcs called by prog_array and perf_event_array map */
  49         void *(*map_fd_get_ptr)(struct bpf_map *map, struct file *map_file,
  50                                 int fd);
  51         void (*map_fd_put_ptr)(void *ptr);
  52         u32 (*map_gen_lookup)(struct bpf_map *map, struct bpf_insn *insn_buf);
  53         u32 (*map_fd_sys_lookup_elem)(void *ptr);
  54         void (*map_seq_show_elem)(struct bpf_map *map, void *key,
  55                                   struct seq_file *m);
  56         int (*map_check_btf)(const struct bpf_map *map,
  57                              const struct btf *btf,
  58                              const struct btf_type *key_type,
  59                              const struct btf_type *value_type);
  60
  61         /* Direct value access helpers. */
  62         int (*map_direct_value_addr)(const struct bpf_map *map,
  63                                      u64 *imm, u32 off);
  64         int (*map_direct_value_meta)(const struct bpf_map *map,
  65                                      u64 imm, u32 *off);
  66 };
  67
  68 struct bpf_map {
  69         /* The first two cachelines with read-mostly members of which some
  70          * are also accessed in fast-path (e.g. ops, max_entries).
  71          */
  72         const struct bpf_map_ops *ops ____cacheline_aligned;
  73         struct bpf_map *inner_map_meta;
  74 #ifdef CONFIG_SECURITY
  75         void *security;
  76 #endif
  77         enum bpf_map_type map_type;
  78         u32 key_size;
  79         u32 value_size;
  80         u32 max_entries;
  81         u32 map_flags;
  82         int spin_lock_off; /* >=0 valid offset, <0 error */
  83         u32 id;
  84         int numa_node;
  85         u32 btf_key_type_id;
  86         u32 btf_value_type_id;
  87         struct btf *btf;
  88         u32 pages;
  89         bool unpriv_array;
  90         /* 51 bytes hole */
  91
  92         /* The 3rd and 4th cacheline with misc members to avoid false sharing
  93          * particularly with refcounting.
  94          */
  95         struct user_struct *user ____cacheline_aligned;
  96         atomic_t refcnt;
  97         atomic_t usercnt;
  98         struct work_struct work;
  99         char name[BPF_OBJ_NAME_LEN];
 100 };
 101
 102 static inline bool map_value_has_spin_lock(const struct bpf_map *map)
 103 {
 104         return map->spin_lock_off >= 0;
 105 }
 106
 107 static inline void check_and_init_map_lock(struct bpf_map *map, void *dst)
 108 {
 109         if (likely(!map_value_has_spin_lock(map)))
 110                 return;
 111         *(struct bpf_spin_lock *)(dst + map->spin_lock_off) =
 112                 (struct bpf_spin_lock){};
 113 }
 114
 115 /* copy everything but bpf_spin_lock */
 116 static inline void copy_map_value(struct bpf_map *map, void *dst, void *src)
 117 {
 118         if (unlikely(map_value_has_spin_lock(map))) {
 119                 u32 off = map->spin_lock_off;
 120
 121                 memcpy(dst, src, off);
 122                 memcpy(dst + off + sizeof(struct bpf_spin_lock),
 123                        src + off + sizeof(struct bpf_spin_lock),
 124                        map->value_size - off - sizeof(struct bpf_spin_lock));
 125         } else {
 126                 memcpy(dst, src, map->value_size);
 127         }
 128 }
 129 void copy_map_value_locked(struct bpf_map *map, void *dst, void *src,
 130                            bool lock_src);
 131
 132 struct bpf_offload_dev;
 133 struct bpf_offloaded_map;
 134
 135 struct bpf_map_dev_ops {
 136         int (*map_get_next_key)(struct bpf_offloaded_map *map,
 137                                 void *key, void *next_key);
 138         int (*map_lookup_elem)(struct bpf_offloaded_map *map,
 139                                void *key, void *value);
 140         int (*map_update_elem)(struct bpf_offloaded_map *map,
 141                                void *key, void *value, u64 flags);
 142         int (*map_delete_elem)(struct bpf_offloaded_map *map, void *key);
 143 };
 144
 145 struct bpf_offloaded_map {
 146         struct bpf_map map;
 147         struct net_device *netdev;
 148         const struct bpf_map_dev_ops *dev_ops;
 149         void *dev_priv;
 150         struct list_head offloads;
 151 };
 152
 153 static inline struct bpf_offloaded_map *map_to_offmap(struct bpf_map *map)
 154 {
 155         return container_of(map, struct bpf_offloaded_map, map);
 156 }
 157
 158 static inline bool bpf_map_offload_neutral(const struct bpf_map *map)
 159 {
 160         return map->map_type == BPF_MAP_TYPE_PERF_EVENT_ARRAY;
 161 }
 162
 163 static inline bool bpf_map_support_seq_show(const struct bpf_map *map)
 164 {
 165         return map->btf && map->ops->map_seq_show_elem;
 166 }
 167
 168 int map_check_no_btf(const struct bpf_map *map,
 169                      const struct btf *btf,
 170                      const struct btf_type *key_type,
 171                      const struct btf_type *value_type);
 172
 173 extern const struct bpf_map_ops bpf_map_offload_ops;
 174
 175 /* function argument constraints */
 176 enum bpf_arg_type {
 177         ARG_DONTCARE = 0,       /* unused argument in helper function */
 178
 179         /* the following constraints used to prototype
 180          * bpf_map_lookup/update/delete_elem() functions
 181          */
 182         ARG_CONST_MAP_PTR,      /* const argument used as pointer to bpf_map */
 183         ARG_PTR_TO_MAP_KEY,     /* pointer to stack used as map key */
 184         ARG_PTR_TO_MAP_VALUE,   /* pointer to stack used as map value */
 185         ARG_PTR_TO_UNINIT_MAP_VALUE,    /* pointer to valid memory used to store a map value */
 186
 187         /* the following constraints used to prototype bpf_memcmp() and other
 188          * functions that access data on eBPF program stack
 189          */
 190         ARG_PTR_TO_MEM,         /* pointer to valid memory (stack, packet, map value) */
 191         ARG_PTR_TO_MEM_OR_NULL, /* pointer to valid memory or NULL */
 192         ARG_PTR_TO_UNINIT_MEM,  /* pointer to memory does not need to be initialized,
 193                                  * helper function must fill all bytes or clear
 194                                  * them in error case.
 195                                  */
 196
 197         ARG_CONST_SIZE,         /* number of bytes accessed from memory */
 198         ARG_CONST_SIZE_OR_ZERO, /* number of bytes accessed from memory or 0 */
 199
 200         ARG_PTR_TO_CTX,         /* pointer to context */
 201         ARG_ANYTHING,           /* any (initialized) argument is ok */
 202         ARG_PTR_TO_SPIN_LOCK,   /* pointer to bpf_spin_lock */
 203         ARG_PTR_TO_SOCK_COMMON, /* pointer to sock_common */
 204 };
 205
 206 /* type of values returned from helper functions */
 207 enum bpf_return_type {
 208         RET_INTEGER,                    /* function returns integer */
 209         RET_VOID,                       /* function doesn't return anything */
 210         RET_PTR_TO_MAP_VALUE,           /* returns a pointer to map elem value */
 211         RET_PTR_TO_MAP_VALUE_OR_NULL,   /* returns a pointer to map elem value or NULL */
 212         RET_PTR_TO_SOCKET_OR_NULL,      /* returns a pointer to a socket or NULL */
 213         RET_PTR_TO_TCP_SOCK_OR_NULL,    /* returns a pointer to a tcp_sock or NULL */
 214         RET_PTR_TO_SOCK_COMMON_OR_NULL, /* returns a pointer to a sock_common or NULL */
 215 };
 216
 217 /* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
 218  * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
 219  * instructions after verifying
 220  */
 221 struct bpf_func_proto {
 222         u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
 223         bool gpl_only;
 224         bool pkt_access;
 225         enum bpf_return_type ret_type;
 226         enum bpf_arg_type arg1_type;
 227         enum bpf_arg_type arg2_type;
 228         enum bpf_arg_type arg3_type;
 229         enum bpf_arg_type arg4_type;
 230         enum bpf_arg_type arg5_type;
 231 };
 232
 233 /* bpf_context is intentionally undefined structure. Pointer to bpf_context is
 234  * the first argument to eBPF programs.
 235  * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
 236  */
 237 struct bpf_context;
 238
 239 enum bpf_access_type {
 240         BPF_READ = 1,
 241         BPF_WRITE = 2
 242 };
 243
 244 /* types of values stored in eBPF registers */
 245 /* Pointer types represent:
 246  * pointer
 247  * pointer + imm
 248  * pointer + (u16) var
 249  * pointer + (u16) var + imm
 250  * if (range > 0) then [ptr, ptr + range - off) is safe to access
 251  * if (id > 0) means that some 'var' was added
 252  * if (off > 0) means that 'imm' was added
 253  */
 254 enum bpf_reg_type {
 255         NOT_INIT = 0,            /* nothing was written into register */
 256         SCALAR_VALUE,            /* reg doesn't contain a valid pointer */
 257         PTR_TO_CTX,              /* reg points to bpf_context */
 258         CONST_PTR_TO_MAP,        /* reg points to struct bpf_map */
 259         PTR_TO_MAP_VALUE,        /* reg points to map element value */
 260         PTR_TO_MAP_VALUE_OR_NULL,/* points to map elem value or NULL */
 261         PTR_TO_STACK,            /* reg == frame_pointer + offset */
 262         PTR_TO_PACKET_META,      /* skb->data - meta_len */
 263         PTR_TO_PACKET,           /* reg points to skb->data */
 264         PTR_TO_PACKET_END,       /* skb->data + headlen */
 265         PTR_TO_FLOW_KEYS,        /* reg points to bpf_flow_keys */
 266         PTR_TO_SOCKET,           /* reg points to struct bpf_sock */
 267         PTR_TO_SOCKET_OR_NULL,   /* reg points to struct bpf_sock or NULL */
 268         PTR_TO_SOCK_COMMON,      /* reg points to sock_common */
 269         PTR_TO_SOCK_COMMON_OR_NULL, /* reg points to sock_common or NULL */
 270         PTR_TO_TCP_SOCK,         /* reg points to struct tcp_sock */
 271         PTR_TO_TCP_SOCK_OR_NULL, /* reg points to struct tcp_sock or NULL */
 272 };
 273
 274 /* The information passed from prog-specific *_is_valid_access
 275  * back to the verifier.
 276  */
 277 struct bpf_insn_access_aux {
 278         enum bpf_reg_type reg_type;
 279         int ctx_field_size;
 280 };
 281
 282 static inline void
 283 bpf_ctx_record_field_size(struct bpf_insn_access_aux *aux, u32 size)
 284 {
 285         aux->ctx_field_size = size;
 286 }
 287
 288 struct bpf_prog_ops {
 289         int (*test_run)(struct bpf_prog *prog, const union bpf_attr *kattr,
 290                         union bpf_attr __user *uattr);
 291 };
 292
 293 struct bpf_verifier_ops {
 294         /* return eBPF function prototype for verification */
 295         const struct bpf_func_proto *
 296         (*get_func_proto)(enum bpf_func_id func_id,
 297                           const struct bpf_prog *prog);
 298
 299         /* return true if 'size' wide access at offset 'off' within bpf_context
 300          * with 'type' (read or write) is allowed
 301          */
 302         bool (*is_valid_access)(int off, int size, enum bpf_access_type type,
 303                                 const struct bpf_prog *prog,
 304                                 struct bpf_insn_access_aux *info);
 305         int (*gen_prologue)(struct bpf_insn *insn, bool direct_write,
 306                             const struct bpf_prog *prog);
 307         int (*gen_ld_abs)(const struct bpf_insn *orig,
 308                           struct bpf_insn *insn_buf);
 309         u32 (*convert_ctx_access)(enum bpf_access_type type,
 310                                   const struct bpf_insn *src,
 311                                   struct bpf_insn *dst,
 312                                   struct bpf_prog *prog, u32 *target_size);
 313 };
 314
 315 struct bpf_prog_offload_ops {
 316         /* verifier basic callbacks */
 317         int (*insn_hook)(struct bpf_verifier_env *env,
 318                          int insn_idx, int prev_insn_idx);
 319         int (*finalize)(struct bpf_verifier_env *env);
 320         /* verifier optimization callbacks (called after .finalize) */
 321         int (*replace_insn)(struct bpf_verifier_env *env, u32 off,
 322                             struct bpf_insn *insn);
 323         int (*remove_insns)(struct bpf_verifier_env *env, u32 off, u32 cnt);
 324         /* program management callbacks */
 325         int (*prepare)(struct bpf_prog *prog);
 326         int (*translate)(struct bpf_prog *prog);
 327         void (*destroy)(struct bpf_prog *prog);
 328 };
 329
 330 struct bpf_prog_offload {
 331         struct bpf_prog         *prog;
 332         struct net_device       *netdev;
 333         struct bpf_offload_dev  *offdev;
 334         void                    *dev_priv;
 335         struct list_head        offloads;
 336         bool                    dev_state;
 337         bool                    opt_failed;
 338         void                    *jited_image;
 339         u32                     jited_len;
 340 };
 341
 342 enum bpf_cgroup_storage_type {
 343         BPF_CGROUP_STORAGE_SHARED,
 344         BPF_CGROUP_STORAGE_PERCPU,
 345         __BPF_CGROUP_STORAGE_MAX
 346 };
 347
 348 #define MAX_BPF_CGROUP_STORAGE_TYPE __BPF_CGROUP_STORAGE_MAX
 349
 350 struct bpf_prog_stats {
 351         u64 cnt;
 352         u64 nsecs;
 353         struct u64_stats_sync syncp;
 354 };
 355
 356 struct bpf_prog_aux {
 357         atomic_t refcnt;
 358         u32 used_map_cnt;
 359         u32 max_ctx_offset;
 360         u32 max_pkt_offset;
 361         u32 stack_depth;
 362         u32 id;
 363         u32 func_cnt; /* used by non-func prog as the number of func progs */
 364         u32 func_idx; /* 0 for non-func prog, the index in func array for func prog */
 365         bool offload_requested;
 366         struct bpf_prog **func;
 367         void *jit_data; /* JIT specific data. arch dependent */
 368         struct latch_tree_node ksym_tnode;
 369         struct list_head ksym_lnode;
 370         const struct bpf_prog_ops *ops;
 371         struct bpf_map **used_maps;
 372         struct bpf_prog *prog;
 373         struct user_struct *user;
 374         u64 load_time; /* ns since boottime */
 375         struct bpf_map *cgroup_storage[MAX_BPF_CGROUP_STORAGE_TYPE];
 376         char name[BPF_OBJ_NAME_LEN];
 377 #ifdef CONFIG_SECURITY
 378         void *security;
 379 #endif
 380         struct bpf_prog_offload *offload;
 381         struct btf *btf;
 382         struct bpf_func_info *func_info;
 383         /* bpf_line_info loaded from userspace.  linfo->insn_off
 384          * has the xlated insn offset.
 385          * Both the main and sub prog share the same linfo.
 386          * The subprog can access its first linfo by
 387          * using the linfo_idx.
 388          */
 389         struct bpf_line_info *linfo;
 390         /* jited_linfo is the jited addr of the linfo.  It has a
 391          * one to one mapping to linfo:
 392          * jited_linfo[i] is the jited addr for the linfo[i]->insn_off.
 393          * Both the main and sub prog share the same jited_linfo.
 394          * The subprog can access its first jited_linfo by
 395          * using the linfo_idx.
 396          */
 397         void **jited_linfo;
 398         u32 func_info_cnt;
 399         u32 nr_linfo;
 400         /* subprog can use linfo_idx to access its first linfo and
 401          * jited_linfo.
 402          * main prog always has linfo_idx == 0
 403          */
 404         u32 linfo_idx;
 405         struct bpf_prog_stats __percpu *stats;
 406         union {
 407                 struct work_struct work;
 408                 struct rcu_head rcu;
 409         };
 410 };
 411
 412 struct bpf_array {
 413         struct bpf_map map;
 414         u32 elem_size;
 415         u32 index_mask;
 416         /* 'ownership' of prog_array is claimed by the first program that
 417          * is going to use this map or by the first program which FD is stored
 418          * in the map to make sure that all callers and callees have the same
 419          * prog_type and JITed flag
 420          */
 421         enum bpf_prog_type owner_prog_type;
 422         bool owner_jited;
 423         union {
 424                 char value[0] __aligned(8);
 425                 void *ptrs[0] __aligned(8);
 426                 void __percpu *pptrs[0] __aligned(8);
 427         };
 428 };
 429
 430 #define BPF_COMPLEXITY_LIMIT_INSNS      1000000 /* yes. 1M insns */
 431 #define MAX_TAIL_CALL_CNT 32
 432
 433 #define BPF_F_ACCESS_MASK       (BPF_F_RDONLY |         \
 434                                  BPF_F_RDONLY_PROG |    \
 435                                  BPF_F_WRONLY |         \
 436                                  BPF_F_WRONLY_PROG)
 437
 438 #define BPF_MAP_CAN_READ        BIT(0)
 439 #define BPF_MAP_CAN_WRITE       BIT(1)
 440
 441 static inline u32 bpf_map_flags_to_cap(struct bpf_map *map)
 442 {
 443         u32 access_flags = map->map_flags & (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG);
 444
 445         /* Combination of BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG is
 446          * not possible.
 447          */
 448         if (access_flags & BPF_F_RDONLY_PROG)
 449                 return BPF_MAP_CAN_READ;
 450         else if (access_flags & BPF_F_WRONLY_PROG)
 451                 return BPF_MAP_CAN_WRITE;
 452         else
 453                 return BPF_MAP_CAN_READ | BPF_MAP_CAN_WRITE;
 454 }
 455
 456 static inline bool bpf_map_flags_access_ok(u32 access_flags)
 457 {
 458         return (access_flags & (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG)) !=
 459                (BPF_F_RDONLY_PROG | BPF_F_WRONLY_PROG);
 460 }
 461
 462 struct bpf_event_entry {
 463         struct perf_event *event;
 464         struct file *perf_file;
 465         struct file *map_file;
 466         struct rcu_head rcu;
 467 };
 468
 469 bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
 470 int bpf_prog_calc_tag(struct bpf_prog *fp);
 471
 472 const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
 473
 474 typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src,
 475                                         unsigned long off, unsigned long len);
 476 typedef u32 (*bpf_convert_ctx_access_t)(enum bpf_access_type type,
 477                                         const struct bpf_insn *src,
 478                                         struct bpf_insn *dst,
 479                                         struct bpf_prog *prog,
 480                                         u32 *target_size);
 481
 482 u64 bpf_event_output(struct bpf_map *map, u64 flags, void *meta, u64 meta_size,
 483                      void *ctx, u64 ctx_size, bpf_ctx_copy_t ctx_copy);
 484
 485 int bpf_prog_test_run_xdp(struct bpf_prog *prog, const union bpf_attr *kattr,
 486                           union bpf_attr __user *uattr);
 487 int bpf_prog_test_run_skb(struct bpf_prog *prog, const union bpf_attr *kattr,
 488                           union bpf_attr __user *uattr);
 489 int bpf_prog_test_run_flow_dissector(struct bpf_prog *prog,
 490                                      const union bpf_attr *kattr,
 491                                      union bpf_attr __user *uattr);
 492
 493 /* an array of programs to be executed under rcu_lock.
 494  *
 495  * Typical usage:
 496  * ret = BPF_PROG_RUN_ARRAY(&bpf_prog_array, ctx, BPF_PROG_RUN);
 497  *
 498  * the structure returned by bpf_prog_array_alloc() should be populated
 499  * with program pointers and the last pointer must be NULL.
 500  * The user has to keep refcnt on the program and make sure the program
 501  * is removed from the array before bpf_prog_put().
 502  * The 'struct bpf_prog_array *' should only be replaced with xchg()
 503  * since other cpus are walking the array of pointers in parallel.
 504  */
 505 struct bpf_prog_array_item {
 506         struct bpf_prog *prog;
 507         struct bpf_cgroup_storage *cgroup_storage[MAX_BPF_CGROUP_STORAGE_TYPE];
 508 };
 509
 510 struct bpf_prog_array {
 511         struct rcu_head rcu;
 512         struct bpf_prog_array_item items[0];
 513 };
 514
 515 struct bpf_prog_array *bpf_prog_array_alloc(u32 prog_cnt, gfp_t flags);
 516 void bpf_prog_array_free(struct bpf_prog_array __rcu *progs);
 517 int bpf_prog_array_length(struct bpf_prog_array __rcu *progs);
 518 int bpf_prog_array_copy_to_user(struct bpf_prog_array __rcu *progs,
 519                                 __u32 __user *prog_ids, u32 cnt);
 520
 521 void bpf_prog_array_delete_safe(struct bpf_prog_array __rcu *progs,
 522                                 struct bpf_prog *old_prog);
 523 int bpf_prog_array_copy_info(struct bpf_prog_array __rcu *array,
 524                              u32 *prog_ids, u32 request_cnt,
 525                              u32 *prog_cnt);
 526 int bpf_prog_array_copy(struct bpf_prog_array __rcu *old_array,
 527                         struct bpf_prog *exclude_prog,
 528                         struct bpf_prog *include_prog,
 529                         struct bpf_prog_array **new_array);
 530
 531 #define __BPF_PROG_RUN_ARRAY(array, ctx, func, check_non_null)  \
 532         ({                                              \
 533                 struct bpf_prog_array_item *_item;      \
 534                 struct bpf_prog *_prog;                 \
 535                 struct bpf_prog_array *_array;          \
 536                 u32 _ret = 1;                           \
 537                 preempt_disable();                      \
 538                 rcu_read_lock();                        \
 539                 _array = rcu_dereference(array);        \
 540                 if (unlikely(check_non_null && !_array))\
 541                         goto _out;                      \
 542                 _item = &_array->items[0];              \
 543                 while ((_prog = READ_ONCE(_item->prog))) {              \
 544                         bpf_cgroup_storage_set(_item->cgroup_storage);  \
 545                         _ret &= func(_prog, ctx);       \
 546                         _item++;                        \
 547                 }                                       \
 548 _out:                                                   \
 549                 rcu_read_unlock();                      \
 550                 preempt_enable_no_resched();            \
 551                 _ret;                                   \
 552          })
 553
 554 #define BPF_PROG_RUN_ARRAY(array, ctx, func)            \
 555         __BPF_PROG_RUN_ARRAY(array, ctx, func, false)
 556
 557 #define BPF_PROG_RUN_ARRAY_CHECK(array, ctx, func)      \
 558         __BPF_PROG_RUN_ARRAY(array, ctx, func, true)
 559
 560 #ifdef CONFIG_BPF_SYSCALL
 561 DECLARE_PER_CPU(int, bpf_prog_active);
 562
 563 extern const struct file_operations bpf_map_fops;
 564 extern const struct file_operations bpf_prog_fops;
 565
 566 #define BPF_PROG_TYPE(_id, _name) \
 567         extern const struct bpf_prog_ops _name ## _prog_ops; \
 568         extern const struct bpf_verifier_ops _name ## _verifier_ops;
 569 #define BPF_MAP_TYPE(_id, _ops) \
 570         extern const struct bpf_map_ops _ops;
 571 #include <linux/bpf_types.h>
 572 #undef BPF_PROG_TYPE
 573 #undef BPF_MAP_TYPE
 574
 575 extern const struct bpf_prog_ops bpf_offload_prog_ops;
 576 extern const struct bpf_verifier_ops tc_cls_act_analyzer_ops;
 577 extern const struct bpf_verifier_ops xdp_analyzer_ops;
 578
 579 struct bpf_prog *bpf_prog_get(u32 ufd);
 580 struct bpf_prog *bpf_prog_get_type_dev(u32 ufd, enum bpf_prog_type type,
 581                                        bool attach_drv);
 582 struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog, int i);
 583 void bpf_prog_sub(struct bpf_prog *prog, int i);
 584 struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog);
 585 struct bpf_prog * __must_check bpf_prog_inc_not_zero(struct bpf_prog *prog);
 586 void bpf_prog_put(struct bpf_prog *prog);
 587 int __bpf_prog_charge(struct user_struct *user, u32 pages);
 588 void __bpf_prog_uncharge(struct user_struct *user, u32 pages);
 589
 590 void bpf_prog_free_id(struct bpf_prog *prog, bool do_idr_lock);
 591 void bpf_map_free_id(struct bpf_map *map, bool do_idr_lock);
 592
 593 struct bpf_map *bpf_map_get_with_uref(u32 ufd);
 594 struct bpf_map *__bpf_map_get(struct fd f);
 595 struct bpf_map * __must_check bpf_map_inc(struct bpf_map *map, bool uref);
 596 void bpf_map_put_with_uref(struct bpf_map *map);
 597 void bpf_map_put(struct bpf_map *map);
 598 int bpf_map_precharge_memlock(u32 pages);
 599 int bpf_map_charge_memlock(struct bpf_map *map, u32 pages);
 600 void bpf_map_uncharge_memlock(struct bpf_map *map, u32 pages);
 601 void *bpf_map_area_alloc(size_t size, int numa_node);
 602 void bpf_map_area_free(void *base);
 603 void bpf_map_init_from_attr(struct bpf_map *map, union bpf_attr *attr);
 604
 605 extern int sysctl_unprivileged_bpf_disabled;
 606 extern int sysctl_bpf_stats_enabled;
 607
 608 int bpf_map_new_fd(struct bpf_map *map, int flags);
 609 int bpf_prog_new_fd(struct bpf_prog *prog);
 610
 611 int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
 612 int bpf_obj_get_user(const char __user *pathname, int flags);
 613
 614 int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value);
 615 int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value);
 616 int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
 617                            u64 flags);
 618 int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
 619                             u64 flags);
 620
 621 int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value);
 622
 623 int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
 624                                  void *key, void *value, u64 map_flags);
 625 int bpf_fd_array_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
 626 int bpf_fd_htab_map_update_elem(struct bpf_map *map, struct file *map_file,
 627                                 void *key, void *value, u64 map_flags);
 628 int bpf_fd_htab_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
 629
 630 int bpf_get_file_flag(int flags);
 631 int bpf_check_uarg_tail_zero(void __user *uaddr, size_t expected_size,
 632                              size_t actual_size);
 633
 634 /* memcpy that is used with 8-byte aligned pointers, power-of-8 size and
 635  * forced to use 'long' read/writes to try to atomically copy long counters.
 636  * Best-effort only.  No barriers here, since it _will_ race with concurrent
 637  * updates from BPF programs. Called from bpf syscall and mostly used with
 638  * size 8 or 16 bytes, so ask compiler to inline it.
 639  */
 640 static inline void bpf_long_memcpy(void *dst, const void *src, u32 size)
 641 {
 642         const long *lsrc = src;
 643         long *ldst = dst;
 644
 645         size /= sizeof(long);
 646         while (size--)
 647                 *ldst++ = *lsrc++;
 648 }
 649
 650 /* verify correctness of eBPF program */
 651 int bpf_check(struct bpf_prog **fp, union bpf_attr *attr,
 652               union bpf_attr __user *uattr);
 653 void bpf_patch_call_args(struct bpf_insn *insn, u32 stack_depth);
 654
 655 /* Map specifics */
 656 struct xdp_buff;
 657 struct sk_buff;
 658
 659 struct bpf_dtab_netdev *__dev_map_lookup_elem(struct bpf_map *map, u32 key);
 660 void __dev_map_insert_ctx(struct bpf_map *map, u32 index);
 661 void __dev_map_flush(struct bpf_map *map);
 662 int dev_map_enqueue(struct bpf_dtab_netdev *dst, struct xdp_buff *xdp,
 663                     struct net_device *dev_rx);
 664 int dev_map_generic_redirect(struct bpf_dtab_netdev *dst, struct sk_buff *skb,
 665                              struct bpf_prog *xdp_prog);
 666
 667 struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key);
 668 void __cpu_map_insert_ctx(struct bpf_map *map, u32 index);
 669 void __cpu_map_flush(struct bpf_map *map);
 670 int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu, struct xdp_buff *xdp,
 671                     struct net_device *dev_rx);
 672
 673 /* Return map's numa specified by userspace */
 674 static inline int bpf_map_attr_numa_node(const union bpf_attr *attr)
 675 {
 676         return (attr->map_flags & BPF_F_NUMA_NODE) ?
 677                 attr->numa_node : NUMA_NO_NODE;
 678 }
 679
 680 struct bpf_prog *bpf_prog_get_type_path(const char *name, enum bpf_prog_type type);
 681 int array_map_alloc_check(union bpf_attr *attr);
 682
 683 #else /* !CONFIG_BPF_SYSCALL */
 684 static inline struct bpf_prog *bpf_prog_get(u32 ufd)
 685 {
 686         return ERR_PTR(-EOPNOTSUPP);
 687 }
 688
 689 static inline struct bpf_prog *bpf_prog_get_type_dev(u32 ufd,
 690                                                      enum bpf_prog_type type,
 691                                                      bool attach_drv)
 692 {
 693         return ERR_PTR(-EOPNOTSUPP);
 694 }
 695
 696 static inline struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog,
 697                                                           int i)
 698 {
 699         return ERR_PTR(-EOPNOTSUPP);
 700 }
 701
 702 static inline void bpf_prog_sub(struct bpf_prog *prog, int i)
 703 {
 704 }
 705
 706 static inline void bpf_prog_put(struct bpf_prog *prog)
 707 {
 708 }
 709
 710 static inline struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog)
 711 {
 712         return ERR_PTR(-EOPNOTSUPP);
 713 }
 714
 715 static inline struct bpf_prog *__must_check
 716 bpf_prog_inc_not_zero(struct bpf_prog *prog)
 717 {
 718         return ERR_PTR(-EOPNOTSUPP);
 719 }
 720
 721 static inline int __bpf_prog_charge(struct user_struct *user, u32 pages)
 722 {
 723         return 0;
 724 }
 725
 726 static inline void __bpf_prog_uncharge(struct user_struct *user, u32 pages)
 727 {
 728 }
 729
 730 static inline int bpf_obj_get_user(const char __user *pathname, int flags)
 731 {
 732         return -EOPNOTSUPP;
 733 }
 734
 735 static inline struct net_device  *__dev_map_lookup_elem(struct bpf_map *map,
 736                                                        u32 key)
 737 {
 738         return NULL;
 739 }
 740
 741 static inline void __dev_map_insert_ctx(struct bpf_map *map, u32 index)
 742 {
 743 }
 744
 745 static inline void __dev_map_flush(struct bpf_map *map)
 746 {
 747 }
 748
 749 struct xdp_buff;
 750 struct bpf_dtab_netdev;
 751
 752 static inline
 753 int dev_map_enqueue(struct bpf_dtab_netdev *dst, struct xdp_buff *xdp,
 754                     struct net_device *dev_rx)
 755 {
 756         return 0;
 757 }
 758
 759 struct sk_buff;
 760
 761 static inline int dev_map_generic_redirect(struct bpf_dtab_netdev *dst,
 762                                            struct sk_buff *skb,
 763                                            struct bpf_prog *xdp_prog)
 764 {
 765         return 0;
 766 }
 767
 768 static inline
 769 struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key)
 770 {
 771         return NULL;
 772 }
 773
 774 static inline void __cpu_map_insert_ctx(struct bpf_map *map, u32 index)
 775 {
 776 }
 777
 778 static inline void __cpu_map_flush(struct bpf_map *map)
 779 {
 780 }
 781
 782 static inline int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu,
 783                                   struct xdp_buff *xdp,
 784                                   struct net_device *dev_rx)
 785 {
 786         return 0;
 787 }
 788
 789 static inline struct bpf_prog *bpf_prog_get_type_path(const char *name,
 790                                 enum bpf_prog_type type)
 791 {
 792         return ERR_PTR(-EOPNOTSUPP);
 793 }
 794 #endif /* CONFIG_BPF_SYSCALL */
 795
 796 static inline struct bpf_prog *bpf_prog_get_type(u32 ufd,
 797                                                  enum bpf_prog_type type)
 798 {
 799         return bpf_prog_get_type_dev(ufd, type, false);
 800 }
 801
 802 bool bpf_prog_get_ok(struct bpf_prog *, enum bpf_prog_type *, bool);
 803
 804 int bpf_prog_offload_compile(struct bpf_prog *prog);
 805 void bpf_prog_offload_destroy(struct bpf_prog *prog);
 806 int bpf_prog_offload_info_fill(struct bpf_prog_info *info,
 807                                struct bpf_prog *prog);
 808
 809 int bpf_map_offload_info_fill(struct bpf_map_info *info, struct bpf_map *map);
 810
 811 int bpf_map_offload_lookup_elem(struct bpf_map *map, void *key, void *value);
 812 int bpf_map_offload_update_elem(struct bpf_map *map,
 813                                 void *key, void *value, u64 flags);
 814 int bpf_map_offload_delete_elem(struct bpf_map *map, void *key);
 815 int bpf_map_offload_get_next_key(struct bpf_map *map,
 816                                  void *key, void *next_key);
 817
 818 bool bpf_offload_prog_map_match(struct bpf_prog *prog, struct bpf_map *map);
 819
 820 struct bpf_offload_dev *
 821 bpf_offload_dev_create(const struct bpf_prog_offload_ops *ops, void *priv);
 822 void bpf_offload_dev_destroy(struct bpf_offload_dev *offdev);
 823 void *bpf_offload_dev_priv(struct bpf_offload_dev *offdev);
 824 int bpf_offload_dev_netdev_register(struct bpf_offload_dev *offdev,
 825                                     struct net_device *netdev);
 826 void bpf_offload_dev_netdev_unregister(struct bpf_offload_dev *offdev,
 827                                        struct net_device *netdev);
 828 bool bpf_offload_dev_match(struct bpf_prog *prog, struct net_device *netdev);
 829
 830 #if defined(CONFIG_NET) && defined(CONFIG_BPF_SYSCALL)
 831 int bpf_prog_offload_init(struct bpf_prog *prog, union bpf_attr *attr);
 832
 833 static inline bool bpf_prog_is_dev_bound(const struct bpf_prog_aux *aux)
 834 {
 835         return aux->offload_requested;
 836 }
 837
 838 static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
 839 {
 840         return unlikely(map->ops == &bpf_map_offload_ops);
 841 }
 842
 843 struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr);
 844 void bpf_map_offload_map_free(struct bpf_map *map);
 845 #else
 846 static inline int bpf_prog_offload_init(struct bpf_prog *prog,
 847                                         union bpf_attr *attr)
 848 {
 849         return -EOPNOTSUPP;
 850 }
 851
 852 static inline bool bpf_prog_is_dev_bound(struct bpf_prog_aux *aux)
 853 {
 854         return false;
 855 }
 856
 857 static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
 858 {
 859         return false;
 860 }
 861
 862 static inline struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr)
 863 {
 864         return ERR_PTR(-EOPNOTSUPP);
 865 }
 866
 867 static inline void bpf_map_offload_map_free(struct bpf_map *map)
 868 {
 869 }
 870 #endif /* CONFIG_NET && CONFIG_BPF_SYSCALL */
 871
 872 #if defined(CONFIG_BPF_STREAM_PARSER)
 873 int sock_map_prog_update(struct bpf_map *map, struct bpf_prog *prog, u32 which);
 874 int sock_map_get_from_fd(const union bpf_attr *attr, struct bpf_prog *prog);
 875 #else
 876 static inline int sock_map_prog_update(struct bpf_map *map,
 877                                        struct bpf_prog *prog, u32 which)
 878 {
 879         return -EOPNOTSUPP;
 880 }
 881
 882 static inline int sock_map_get_from_fd(const union bpf_attr *attr,
 883                                        struct bpf_prog *prog)
 884 {
 885         return -EINVAL;
 886 }
 887 #endif
 888
 889 #if defined(CONFIG_XDP_SOCKETS)
 890 struct xdp_sock;
 891 struct xdp_sock *__xsk_map_lookup_elem(struct bpf_map *map, u32 key);
 892 int __xsk_map_redirect(struct bpf_map *map, struct xdp_buff *xdp,
 893                        struct xdp_sock *xs);
 894 void __xsk_map_flush(struct bpf_map *map);
 895 #else
 896 struct xdp_sock;
 897 static inline struct xdp_sock *__xsk_map_lookup_elem(struct bpf_map *map,
 898                                                      u32 key)
 899 {
 900         return NULL;
 901 }
 902
 903 static inline int __xsk_map_redirect(struct bpf_map *map, struct xdp_buff *xdp,
 904                                      struct xdp_sock *xs)
 905 {
 906         return -EOPNOTSUPP;
 907 }
 908
 909 static inline void __xsk_map_flush(struct bpf_map *map)
 910 {
 911 }
 912 #endif
 913
 914 #if defined(CONFIG_INET) && defined(CONFIG_BPF_SYSCALL)
 915 void bpf_sk_reuseport_detach(struct sock *sk);
 916 int bpf_fd_reuseport_array_lookup_elem(struct bpf_map *map, void *key,
 917                                        void *value);
 918 int bpf_fd_reuseport_array_update_elem(struct bpf_map *map, void *key,
 919                                        void *value, u64 map_flags);
 920 #else
 921 static inline void bpf_sk_reuseport_detach(struct sock *sk)
 922 {
 923 }
 924
 925 #ifdef CONFIG_BPF_SYSCALL
 926 static inline int bpf_fd_reuseport_array_lookup_elem(struct bpf_map *map,
 927                                                      void *key, void *value)
 928 {
 929         return -EOPNOTSUPP;
 930 }
 931
 932 static inline int bpf_fd_reuseport_array_update_elem(struct bpf_map *map,
 933                                                      void *key, void *value,
 934                                                      u64 map_flags)
 935 {
 936         return -EOPNOTSUPP;
 937 }
 938 #endif /* CONFIG_BPF_SYSCALL */
 939 #endif /* defined(CONFIG_INET) && defined(CONFIG_BPF_SYSCALL) */
 940
 941 /* verifier prototypes for helper functions called from eBPF programs */
 942 extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
 943 extern const struct bpf_func_proto bpf_map_update_elem_proto;
 944 extern const struct bpf_func_proto bpf_map_delete_elem_proto;
 945 extern const struct bpf_func_proto bpf_map_push_elem_proto;
 946 extern const struct bpf_func_proto bpf_map_pop_elem_proto;
 947 extern const struct bpf_func_proto bpf_map_peek_elem_proto;
 948
 949 extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
 950 extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
 951 extern const struct bpf_func_proto bpf_get_numa_node_id_proto;
 952 extern const struct bpf_func_proto bpf_tail_call_proto;
 953 extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
 954 extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
 955 extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
 956 extern const struct bpf_func_proto bpf_get_current_comm_proto;
 957 extern const struct bpf_func_proto bpf_get_stackid_proto;
 958 extern const struct bpf_func_proto bpf_get_stack_proto;
 959 extern const struct bpf_func_proto bpf_sock_map_update_proto;
 960 extern const struct bpf_func_proto bpf_sock_hash_update_proto;
 961 extern const struct bpf_func_proto bpf_get_current_cgroup_id_proto;
 962 extern const struct bpf_func_proto bpf_msg_redirect_hash_proto;
 963 extern const struct bpf_func_proto bpf_msg_redirect_map_proto;
 964 extern const struct bpf_func_proto bpf_sk_redirect_hash_proto;
 965 extern const struct bpf_func_proto bpf_sk_redirect_map_proto;
 966 extern const struct bpf_func_proto bpf_spin_lock_proto;
 967 extern const struct bpf_func_proto bpf_spin_unlock_proto;
 968 extern const struct bpf_func_proto bpf_get_local_storage_proto;
 969
 970 /* Shared helpers among cBPF and eBPF. */
 971 void bpf_user_rnd_init_once(void);
 972 u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
 973
 974 #if defined(CONFIG_NET)
 975 bool bpf_sock_common_is_valid_access(int off, int size,
 976                                      enum bpf_access_type type,
 977                                      struct bpf_insn_access_aux *info);
 978 bool bpf_sock_is_valid_access(int off, int size, enum bpf_access_type type,
 979                               struct bpf_insn_access_aux *info);
 980 u32 bpf_sock_convert_ctx_access(enum bpf_access_type type,
 981                                 const struct bpf_insn *si,
 982                                 struct bpf_insn *insn_buf,
 983                                 struct bpf_prog *prog,
 984                                 u32 *target_size);
 985 #else
 986 static inline bool bpf_sock_common_is_valid_access(int off, int size,
 987                                                    enum bpf_access_type type,
 988                                                    struct bpf_insn_access_aux *info)
 989 {
 990         return false;
 991 }
 992 static inline bool bpf_sock_is_valid_access(int off, int size,
 993                                             enum bpf_access_type type,
 994                                             struct bpf_insn_access_aux *info)
 995 {
 996         return false;
 997 }
 998 static inline u32 bpf_sock_convert_ctx_access(enum bpf_access_type type,
 999                                               const struct bpf_insn *si,
1000                                               struct bpf_insn *insn_buf,
1001                                               struct bpf_prog *prog,
1002                                               u32 *target_size)
1003 {
1004         return 0;
1005 }
1006 #endif
1007
1008 #ifdef CONFIG_INET
1009 bool bpf_tcp_sock_is_valid_access(int off, int size, enum bpf_access_type type,
1010                                   struct bpf_insn_access_aux *info);
1011
1012 u32 bpf_tcp_sock_convert_ctx_access(enum bpf_access_type type,
1013                                     const struct bpf_insn *si,
1014                                     struct bpf_insn *insn_buf,
1015                                     struct bpf_prog *prog,
1016                                     u32 *target_size);
1017 #else
1018 static inline bool bpf_tcp_sock_is_valid_access(int off, int size,
1019                                                 enum bpf_access_type type,
1020                                                 struct bpf_insn_access_aux *info)
1021 {
1022         return false;
1023 }
1024
1025 static inline u32 bpf_tcp_sock_convert_ctx_access(enum bpf_access_type type,
1026                                                   const struct bpf_insn *si,
1027                                                   struct bpf_insn *insn_buf,
1028                                                   struct bpf_prog *prog,
1029                                                   u32 *target_size)
1030 {
1031         return 0;
1032 }
1033 #endif /* CONFIG_INET */
1034
1035 #endif /* _LINUX_BPF_H */