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 #include <linux/workqueue.h>
  12 #include <linux/file.h>
  13 #include <linux/percpu.h>
  14 #include <linux/err.h>
  15
  16 struct perf_event;
  17 struct bpf_map;
  18
  19 /* map is generic key/value storage optionally accesible by eBPF programs */
  20 struct bpf_map_ops {
  21         /* funcs callable from userspace (via syscall) */
  22         struct bpf_map *(*map_alloc)(union bpf_attr *attr);
  23         void (*map_release)(struct bpf_map *map, struct file *map_file);
  24         void (*map_free)(struct bpf_map *map);
  25         int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key);
  26
  27         /* funcs callable from userspace and from eBPF programs */
  28         void *(*map_lookup_elem)(struct bpf_map *map, void *key);
  29         int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags);
  30         int (*map_delete_elem)(struct bpf_map *map, void *key);
  31
  32         /* funcs called by prog_array and perf_event_array map */
  33         void *(*map_fd_get_ptr)(struct bpf_map *map, struct file *map_file,
  34                                 int fd);
  35         void (*map_fd_put_ptr)(void *ptr);
  36 };
  37
  38 struct bpf_map {
  39         /* 1st cacheline with read-mostly members of which some
  40          * are also accessed in fast-path (e.g. ops, max_entries).
  41          */
  42         const struct bpf_map_ops *ops ____cacheline_aligned;
  43         enum bpf_map_type map_type;
  44         u32 key_size;
  45         u32 value_size;
  46         u32 max_entries;
  47         u32 map_flags;
  48         u32 pages;
  49         bool unpriv_array;
  50         /* 7 bytes hole */
  51
  52         /* 2nd cacheline with misc members to avoid false sharing
  53          * particularly with refcounting.
  54          */
  55         struct user_struct *user ____cacheline_aligned;
  56         atomic_t refcnt;
  57         atomic_t usercnt;
  58         struct work_struct work;
  59 };
  60
  61 struct bpf_map_type_list {
  62         struct list_head list_node;
  63         const struct bpf_map_ops *ops;
  64         enum bpf_map_type type;
  65 };
  66
  67 /* function argument constraints */
  68 enum bpf_arg_type {
  69         ARG_DONTCARE = 0,       /* unused argument in helper function */
  70
  71         /* the following constraints used to prototype
  72          * bpf_map_lookup/update/delete_elem() functions
  73          */
  74         ARG_CONST_MAP_PTR,      /* const argument used as pointer to bpf_map */
  75         ARG_PTR_TO_MAP_KEY,     /* pointer to stack used as map key */
  76         ARG_PTR_TO_MAP_VALUE,   /* pointer to stack used as map value */
  77
  78         /* the following constraints used to prototype bpf_memcmp() and other
  79          * functions that access data on eBPF program stack
  80          */
  81         ARG_PTR_TO_STACK,       /* any pointer to eBPF program stack */
  82         ARG_PTR_TO_RAW_STACK,   /* any pointer to eBPF program stack, area does not
  83                                  * need to be initialized, helper function must fill
  84                                  * all bytes or clear them in error case.
  85                                  */
  86
  87         ARG_CONST_STACK_SIZE,   /* number of bytes accessed from stack */
  88         ARG_CONST_STACK_SIZE_OR_ZERO, /* number of bytes accessed from stack or 0 */
  89
  90         ARG_PTR_TO_CTX,         /* pointer to context */
  91         ARG_ANYTHING,           /* any (initialized) argument is ok */
  92 };
  93
  94 /* type of values returned from helper functions */
  95 enum bpf_return_type {
  96         RET_INTEGER,                    /* function returns integer */
  97         RET_VOID,                       /* function doesn't return anything */
  98         RET_PTR_TO_MAP_VALUE_OR_NULL,   /* returns a pointer to map elem value or NULL */
  99 };
 100
 101 /* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
 102  * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
 103  * instructions after verifying
 104  */
 105 struct bpf_func_proto {
 106         u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
 107         bool gpl_only;
 108         bool pkt_access;
 109         enum bpf_return_type ret_type;
 110         enum bpf_arg_type arg1_type;
 111         enum bpf_arg_type arg2_type;
 112         enum bpf_arg_type arg3_type;
 113         enum bpf_arg_type arg4_type;
 114         enum bpf_arg_type arg5_type;
 115 };
 116
 117 /* bpf_context is intentionally undefined structure. Pointer to bpf_context is
 118  * the first argument to eBPF programs.
 119  * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
 120  */
 121 struct bpf_context;
 122
 123 enum bpf_access_type {
 124         BPF_READ = 1,
 125         BPF_WRITE = 2
 126 };
 127
 128 /* types of values stored in eBPF registers */
 129 enum bpf_reg_type {
 130         NOT_INIT = 0,            /* nothing was written into register */
 131         UNKNOWN_VALUE,           /* reg doesn't contain a valid pointer */
 132         PTR_TO_CTX,              /* reg points to bpf_context */
 133         CONST_PTR_TO_MAP,        /* reg points to struct bpf_map */
 134         PTR_TO_MAP_VALUE,        /* reg points to map element value */
 135         PTR_TO_MAP_VALUE_OR_NULL,/* points to map elem value or NULL */
 136         FRAME_PTR,               /* reg == frame_pointer */
 137         PTR_TO_STACK,            /* reg == frame_pointer + imm */
 138         CONST_IMM,               /* constant integer value */
 139
 140         /* PTR_TO_PACKET represents:
 141          * skb->data
 142          * skb->data + imm
 143          * skb->data + (u16) var
 144          * skb->data + (u16) var + imm
 145          * if (range > 0) then [ptr, ptr + range - off) is safe to access
 146          * if (id > 0) means that some 'var' was added
 147          * if (off > 0) menas that 'imm' was added
 148          */
 149         PTR_TO_PACKET,
 150         PTR_TO_PACKET_END,       /* skb->data + headlen */
 151
 152         /* PTR_TO_MAP_VALUE_ADJ is used for doing pointer math inside of a map
 153          * elem value.  We only allow this if we can statically verify that
 154          * access from this register are going to fall within the size of the
 155          * map element.
 156          */
 157         PTR_TO_MAP_VALUE_ADJ,
 158 };
 159
 160 struct bpf_prog;
 161
 162 struct bpf_verifier_ops {
 163         /* return eBPF function prototype for verification */
 164         const struct bpf_func_proto *(*get_func_proto)(enum bpf_func_id func_id);
 165
 166         /* return true if 'size' wide access at offset 'off' within bpf_context
 167          * with 'type' (read or write) is allowed
 168          */
 169         bool (*is_valid_access)(int off, int size, enum bpf_access_type type,
 170                                 enum bpf_reg_type *reg_type);
 171         int (*gen_prologue)(struct bpf_insn *insn, bool direct_write,
 172                             const struct bpf_prog *prog);
 173         u32 (*convert_ctx_access)(enum bpf_access_type type, int dst_reg,
 174                                   int src_reg, int ctx_off,
 175                                   struct bpf_insn *insn, struct bpf_prog *prog);
 176 };
 177
 178 struct bpf_prog_type_list {
 179         struct list_head list_node;
 180         const struct bpf_verifier_ops *ops;
 181         enum bpf_prog_type type;
 182 };
 183
 184 struct bpf_prog_aux {
 185         atomic_t refcnt;
 186         u32 used_map_cnt;
 187         u32 max_ctx_offset;
 188         const struct bpf_verifier_ops *ops;
 189         struct bpf_map **used_maps;
 190         struct bpf_prog *prog;
 191         struct user_struct *user;
 192         union {
 193                 struct work_struct work;
 194                 struct rcu_head rcu;
 195         };
 196 };
 197
 198 struct bpf_array {
 199         struct bpf_map map;
 200         u32 elem_size;
 201         u32 index_mask;
 202         /* 'ownership' of prog_array is claimed by the first program that
 203          * is going to use this map or by the first program which FD is stored
 204          * in the map to make sure that all callers and callees have the same
 205          * prog_type and JITed flag
 206          */
 207         enum bpf_prog_type owner_prog_type;
 208         bool owner_jited;
 209         union {
 210                 char value[0] __aligned(8);
 211                 void *ptrs[0] __aligned(8);
 212                 void __percpu *pptrs[0] __aligned(8);
 213         };
 214 };
 215
 216 #define MAX_TAIL_CALL_CNT 32
 217
 218 struct bpf_event_entry {
 219         struct perf_event *event;
 220         struct file *perf_file;
 221         struct file *map_file;
 222         struct rcu_head rcu;
 223 };
 224
 225 u64 bpf_tail_call(u64 ctx, u64 r2, u64 index, u64 r4, u64 r5);
 226 u64 bpf_get_stackid(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
 227
 228 bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
 229
 230 const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
 231
 232 typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src,
 233                                         unsigned long off, unsigned long len);
 234
 235 u64 bpf_event_output(struct bpf_map *map, u64 flags, void *meta, u64 meta_size,
 236                      void *ctx, u64 ctx_size, bpf_ctx_copy_t ctx_copy);
 237
 238 #ifdef CONFIG_BPF_SYSCALL
 239 DECLARE_PER_CPU(int, bpf_prog_active);
 240
 241 void bpf_register_prog_type(struct bpf_prog_type_list *tl);
 242 void bpf_register_map_type(struct bpf_map_type_list *tl);
 243
 244 struct bpf_prog *bpf_prog_get(u32 ufd);
 245 struct bpf_prog *bpf_prog_get_type(u32 ufd, enum bpf_prog_type type);
 246 struct bpf_prog *bpf_prog_add(struct bpf_prog *prog, int i);
 247 struct bpf_prog *bpf_prog_inc(struct bpf_prog *prog);
 248 void bpf_prog_put(struct bpf_prog *prog);
 249 int __bpf_prog_charge(struct user_struct *user, u32 pages);
 250 void __bpf_prog_uncharge(struct user_struct *user, u32 pages);
 251
 252 struct bpf_map *bpf_map_get_with_uref(u32 ufd);
 253 struct bpf_map *__bpf_map_get(struct fd f);
 254 struct bpf_map *bpf_map_inc(struct bpf_map *map, bool uref);
 255 void bpf_map_put_with_uref(struct bpf_map *map);
 256 void bpf_map_put(struct bpf_map *map);
 257 int bpf_map_precharge_memlock(u32 pages);
 258 void *bpf_map_area_alloc(size_t size);
 259 void bpf_map_area_free(void *base);
 260
 261 extern int sysctl_unprivileged_bpf_disabled;
 262
 263 int bpf_map_new_fd(struct bpf_map *map);
 264 int bpf_prog_new_fd(struct bpf_prog *prog);
 265
 266 int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
 267 int bpf_obj_get_user(const char __user *pathname);
 268
 269 int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value);
 270 int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value);
 271 int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
 272                            u64 flags);
 273 int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
 274                             u64 flags);
 275
 276 int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value);
 277
 278 int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
 279                                  void *key, void *value, u64 map_flags);
 280 void bpf_fd_array_map_clear(struct bpf_map *map);
 281
 282 /* memcpy that is used with 8-byte aligned pointers, power-of-8 size and
 283  * forced to use 'long' read/writes to try to atomically copy long counters.
 284  * Best-effort only.  No barriers here, since it _will_ race with concurrent
 285  * updates from BPF programs. Called from bpf syscall and mostly used with
 286  * size 8 or 16 bytes, so ask compiler to inline it.
 287  */
 288 static inline void bpf_long_memcpy(void *dst, const void *src, u32 size)
 289 {
 290         const long *lsrc = src;
 291         long *ldst = dst;
 292
 293         size /= sizeof(long);
 294         while (size--)
 295                 *ldst++ = *lsrc++;
 296 }
 297
 298 /* verify correctness of eBPF program */
 299 int bpf_check(struct bpf_prog **fp, union bpf_attr *attr);
 300
 301 static inline bool unprivileged_ebpf_enabled(void)
 302 {
 303         return !sysctl_unprivileged_bpf_disabled;
 304 }
 305 #else
 306 static inline void bpf_register_prog_type(struct bpf_prog_type_list *tl)
 307 {
 308 }
 309
 310 static inline struct bpf_prog *bpf_prog_get(u32 ufd)
 311 {
 312         return ERR_PTR(-EOPNOTSUPP);
 313 }
 314
 315 static inline struct bpf_prog *bpf_prog_get_type(u32 ufd,
 316                                                  enum bpf_prog_type type)
 317 {
 318         return ERR_PTR(-EOPNOTSUPP);
 319 }
 320 static inline struct bpf_prog *bpf_prog_add(struct bpf_prog *prog, int i)
 321 {
 322         return ERR_PTR(-EOPNOTSUPP);
 323 }
 324
 325 static inline void bpf_prog_put(struct bpf_prog *prog)
 326 {
 327 }
 328 static inline struct bpf_prog *bpf_prog_inc(struct bpf_prog *prog)
 329 {
 330         return ERR_PTR(-EOPNOTSUPP);
 331 }
 332
 333 static inline int __bpf_prog_charge(struct user_struct *user, u32 pages)
 334 {
 335         return 0;
 336 }
 337
 338 static inline void __bpf_prog_uncharge(struct user_struct *user, u32 pages)
 339 {
 340 }
 341
 342 static inline bool unprivileged_ebpf_enabled(void)
 343 {
 344         return false;
 345 }
 346
 347 #endif /* CONFIG_BPF_SYSCALL */
 348
 349 /* verifier prototypes for helper functions called from eBPF programs */
 350 extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
 351 extern const struct bpf_func_proto bpf_map_update_elem_proto;
 352 extern const struct bpf_func_proto bpf_map_delete_elem_proto;
 353
 354 extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
 355 extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
 356 extern const struct bpf_func_proto bpf_tail_call_proto;
 357 extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
 358 extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
 359 extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
 360 extern const struct bpf_func_proto bpf_get_current_comm_proto;
 361 extern const struct bpf_func_proto bpf_skb_vlan_push_proto;
 362 extern const struct bpf_func_proto bpf_skb_vlan_pop_proto;
 363 extern const struct bpf_func_proto bpf_get_stackid_proto;
 364
 365 /* Shared helpers among cBPF and eBPF. */
 366 void bpf_user_rnd_init_once(void);
 367 u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
 368
 369 #endif /* _LINUX_BPF_H */