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