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         atomic_t refcnt;
  40         enum bpf_map_type map_type;
  41         u32 key_size;
  42         u32 value_size;
  43         u32 max_entries;
  44         u32 map_flags;
  45         u32 pages;
  46         struct user_struct *user;
  47         const struct bpf_map_ops *ops;
  48         struct work_struct work;
  49         atomic_t usercnt;
  50 };
  51
  52 struct bpf_map_type_list {
  53         struct list_head list_node;
  54         const struct bpf_map_ops *ops;
  55         enum bpf_map_type type;
  56 };
  57
  58 /* function argument constraints */
  59 enum bpf_arg_type {
  60         ARG_DONTCARE = 0,       /* unused argument in helper function */
  61
  62         /* the following constraints used to prototype
  63          * bpf_map_lookup/update/delete_elem() functions
  64          */
  65         ARG_CONST_MAP_PTR,      /* const argument used as pointer to bpf_map */
  66         ARG_PTR_TO_MAP_KEY,     /* pointer to stack used as map key */
  67         ARG_PTR_TO_MAP_VALUE,   /* pointer to stack used as map value */
  68
  69         /* the following constraints used to prototype bpf_memcmp() and other
  70          * functions that access data on eBPF program stack
  71          */
  72         ARG_PTR_TO_STACK,       /* any pointer to eBPF program stack */
  73         ARG_PTR_TO_RAW_STACK,   /* any pointer to eBPF program stack, area does not
  74                                  * need to be initialized, helper function must fill
  75                                  * all bytes or clear them in error case.
  76                                  */
  77
  78         ARG_CONST_STACK_SIZE,   /* number of bytes accessed from stack */
  79         ARG_CONST_STACK_SIZE_OR_ZERO, /* number of bytes accessed from stack or 0 */
  80
  81         ARG_PTR_TO_CTX,         /* pointer to context */
  82         ARG_ANYTHING,           /* any (initialized) argument is ok */
  83 };
  84
  85 /* type of values returned from helper functions */
  86 enum bpf_return_type {
  87         RET_INTEGER,                    /* function returns integer */
  88         RET_VOID,                       /* function doesn't return anything */
  89         RET_PTR_TO_MAP_VALUE_OR_NULL,   /* returns a pointer to map elem value or NULL */
  90 };
  91
  92 /* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
  93  * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
  94  * instructions after verifying
  95  */
  96 struct bpf_func_proto {
  97         u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
  98         bool gpl_only;
  99         enum bpf_return_type ret_type;
 100         enum bpf_arg_type arg1_type;
 101         enum bpf_arg_type arg2_type;
 102         enum bpf_arg_type arg3_type;
 103         enum bpf_arg_type arg4_type;
 104         enum bpf_arg_type arg5_type;
 105 };
 106
 107 /* bpf_context is intentionally undefined structure. Pointer to bpf_context is
 108  * the first argument to eBPF programs.
 109  * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
 110  */
 111 struct bpf_context;
 112
 113 enum bpf_access_type {
 114         BPF_READ = 1,
 115         BPF_WRITE = 2
 116 };
 117
 118 struct bpf_prog;
 119
 120 struct bpf_verifier_ops {
 121         /* return eBPF function prototype for verification */
 122         const struct bpf_func_proto *(*get_func_proto)(enum bpf_func_id func_id);
 123
 124         /* return true if 'size' wide access at offset 'off' within bpf_context
 125          * with 'type' (read or write) is allowed
 126          */
 127         bool (*is_valid_access)(int off, int size, enum bpf_access_type type);
 128
 129         u32 (*convert_ctx_access)(enum bpf_access_type type, int dst_reg,
 130                                   int src_reg, int ctx_off,
 131                                   struct bpf_insn *insn, struct bpf_prog *prog);
 132 };
 133
 134 struct bpf_prog_type_list {
 135         struct list_head list_node;
 136         const struct bpf_verifier_ops *ops;
 137         enum bpf_prog_type type;
 138 };
 139
 140 struct bpf_prog_aux {
 141         atomic_t refcnt;
 142         u32 used_map_cnt;
 143         u32 max_ctx_offset;
 144         const struct bpf_verifier_ops *ops;
 145         struct bpf_map **used_maps;
 146         struct bpf_prog *prog;
 147         struct user_struct *user;
 148         union {
 149                 struct work_struct work;
 150                 struct rcu_head rcu;
 151         };
 152 };
 153
 154 struct bpf_array {
 155         struct bpf_map map;
 156         u32 elem_size;
 157         /* 'ownership' of prog_array is claimed by the first program that
 158          * is going to use this map or by the first program which FD is stored
 159          * in the map to make sure that all callers and callees have the same
 160          * prog_type and JITed flag
 161          */
 162         enum bpf_prog_type owner_prog_type;
 163         bool owner_jited;
 164         union {
 165                 char value[0] __aligned(8);
 166                 void *ptrs[0] __aligned(8);
 167                 void __percpu *pptrs[0] __aligned(8);
 168         };
 169 };
 170
 171 #define MAX_TAIL_CALL_CNT 32
 172
 173 struct bpf_event_entry {
 174         struct perf_event *event;
 175         struct file *perf_file;
 176         struct file *map_file;
 177         struct rcu_head rcu;
 178 };
 179
 180 u64 bpf_tail_call(u64 ctx, u64 r2, u64 index, u64 r4, u64 r5);
 181 u64 bpf_get_stackid(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
 182
 183 bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
 184
 185 const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
 186 const struct bpf_func_proto *bpf_get_event_output_proto(void);
 187
 188 #ifdef CONFIG_BPF_SYSCALL
 189 DECLARE_PER_CPU(int, bpf_prog_active);
 190
 191 void bpf_register_prog_type(struct bpf_prog_type_list *tl);
 192 void bpf_register_map_type(struct bpf_map_type_list *tl);
 193
 194 struct bpf_prog *bpf_prog_get(u32 ufd);
 195 struct bpf_prog *bpf_prog_inc(struct bpf_prog *prog);
 196 void bpf_prog_put(struct bpf_prog *prog);
 197 void bpf_prog_put_rcu(struct bpf_prog *prog);
 198
 199 struct bpf_map *bpf_map_get_with_uref(u32 ufd);
 200 struct bpf_map *__bpf_map_get(struct fd f);
 201 struct bpf_map *bpf_map_inc(struct bpf_map *map, bool uref);
 202 void bpf_map_put_with_uref(struct bpf_map *map);
 203 void bpf_map_put(struct bpf_map *map);
 204 int bpf_map_precharge_memlock(u32 pages);
 205
 206 extern int sysctl_unprivileged_bpf_disabled;
 207
 208 int bpf_map_new_fd(struct bpf_map *map);
 209 int bpf_prog_new_fd(struct bpf_prog *prog);
 210
 211 int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
 212 int bpf_obj_get_user(const char __user *pathname);
 213
 214 int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value);
 215 int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value);
 216 int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
 217                            u64 flags);
 218 int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
 219                             u64 flags);
 220
 221 int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value);
 222
 223 int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
 224                                  void *key, void *value, u64 map_flags);
 225 void bpf_fd_array_map_clear(struct bpf_map *map);
 226
 227 /* memcpy that is used with 8-byte aligned pointers, power-of-8 size and
 228  * forced to use 'long' read/writes to try to atomically copy long counters.
 229  * Best-effort only.  No barriers here, since it _will_ race with concurrent
 230  * updates from BPF programs. Called from bpf syscall and mostly used with
 231  * size 8 or 16 bytes, so ask compiler to inline it.
 232  */
 233 static inline void bpf_long_memcpy(void *dst, const void *src, u32 size)
 234 {
 235         const long *lsrc = src;
 236         long *ldst = dst;
 237
 238         size /= sizeof(long);
 239         while (size--)
 240                 *ldst++ = *lsrc++;
 241 }
 242
 243 /* verify correctness of eBPF program */
 244 int bpf_check(struct bpf_prog **fp, union bpf_attr *attr);
 245 #else
 246 static inline void bpf_register_prog_type(struct bpf_prog_type_list *tl)
 247 {
 248 }
 249
 250 static inline struct bpf_prog *bpf_prog_get(u32 ufd)
 251 {
 252         return ERR_PTR(-EOPNOTSUPP);
 253 }
 254
 255 static inline void bpf_prog_put(struct bpf_prog *prog)
 256 {
 257 }
 258 #endif /* CONFIG_BPF_SYSCALL */
 259
 260 /* verifier prototypes for helper functions called from eBPF programs */
 261 extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
 262 extern const struct bpf_func_proto bpf_map_update_elem_proto;
 263 extern const struct bpf_func_proto bpf_map_delete_elem_proto;
 264
 265 extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
 266 extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
 267 extern const struct bpf_func_proto bpf_tail_call_proto;
 268 extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
 269 extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
 270 extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
 271 extern const struct bpf_func_proto bpf_get_current_comm_proto;
 272 extern const struct bpf_func_proto bpf_skb_vlan_push_proto;
 273 extern const struct bpf_func_proto bpf_skb_vlan_pop_proto;
 274 extern const struct bpf_func_proto bpf_get_stackid_proto;
 275
 276 /* Shared helpers among cBPF and eBPF. */
 277 void bpf_user_rnd_init_once(void);
 278 u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
 279
 280 #endif /* _LINUX_BPF_H */