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
  14 struct bpf_map;
  15
  16 /* map is generic key/value storage optionally accesible by eBPF programs */
  17 struct bpf_map_ops {
  18         /* funcs callable from userspace (via syscall) */
  19         struct bpf_map *(*map_alloc)(union bpf_attr *attr);
  20         void (*map_free)(struct bpf_map *);
  21         int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key);
  22
  23         /* funcs callable from userspace and from eBPF programs */
  24         void *(*map_lookup_elem)(struct bpf_map *map, void *key);
  25         int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags);
  26         int (*map_delete_elem)(struct bpf_map *map, void *key);
  27
  28         /* funcs called by prog_array and perf_event_array map */
  29         void *(*map_fd_get_ptr) (struct bpf_map *map, int fd);
  30         void (*map_fd_put_ptr) (void *ptr);
  31 };
  32
  33 struct bpf_map {
  34         /* 1st cacheline with read-mostly members of which some
  35          * are also accessed in fast-path (e.g. ops, max_entries).
  36          */
  37         const struct bpf_map_ops *ops ____cacheline_aligned;
  38         enum bpf_map_type map_type;
  39         u32 key_size;
  40         u32 value_size;
  41         u32 max_entries;
  42         u32 pages;
  43         bool unpriv_array;
  44         /* 7 bytes hole */
  45
  46         /* 2nd cacheline with misc members to avoid false sharing
  47          * particularly with refcounting.
  48          */
  49         struct user_struct *user ____cacheline_aligned;
  50         atomic_t refcnt;
  51         atomic_t usercnt;
  52         struct work_struct work;
  53 };
  54
  55 struct bpf_map_type_list {
  56         struct list_head list_node;
  57         const struct bpf_map_ops *ops;
  58         enum bpf_map_type type;
  59 };
  60
  61 /* function argument constraints */
  62 enum bpf_arg_type {
  63         ARG_DONTCARE = 0,       /* unused argument in helper function */
  64
  65         /* the following constraints used to prototype
  66          * bpf_map_lookup/update/delete_elem() functions
  67          */
  68         ARG_CONST_MAP_PTR,      /* const argument used as pointer to bpf_map */
  69         ARG_PTR_TO_MAP_KEY,     /* pointer to stack used as map key */
  70         ARG_PTR_TO_MAP_VALUE,   /* pointer to stack used as map value */
  71
  72         /* the following constraints used to prototype bpf_memcmp() and other
  73          * functions that access data on eBPF program stack
  74          */
  75         ARG_PTR_TO_STACK,       /* any pointer to eBPF program stack */
  76         ARG_CONST_STACK_SIZE,   /* number of bytes accessed from stack */
  77
  78         ARG_PTR_TO_CTX,         /* pointer to context */
  79         ARG_ANYTHING,           /* any (initialized) argument is ok */
  80 };
  81
  82 /* type of values returned from helper functions */
  83 enum bpf_return_type {
  84         RET_INTEGER,                    /* function returns integer */
  85         RET_VOID,                       /* function doesn't return anything */
  86         RET_PTR_TO_MAP_VALUE_OR_NULL,   /* returns a pointer to map elem value or NULL */
  87 };
  88
  89 /* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
  90  * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
  91  * instructions after verifying
  92  */
  93 struct bpf_func_proto {
  94         u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
  95         bool gpl_only;
  96         enum bpf_return_type ret_type;
  97         enum bpf_arg_type arg1_type;
  98         enum bpf_arg_type arg2_type;
  99         enum bpf_arg_type arg3_type;
 100         enum bpf_arg_type arg4_type;
 101         enum bpf_arg_type arg5_type;
 102 };
 103
 104 /* bpf_context is intentionally undefined structure. Pointer to bpf_context is
 105  * the first argument to eBPF programs.
 106  * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
 107  */
 108 struct bpf_context;
 109
 110 enum bpf_access_type {
 111         BPF_READ = 1,
 112         BPF_WRITE = 2
 113 };
 114
 115 struct bpf_prog;
 116
 117 struct bpf_verifier_ops {
 118         /* return eBPF function prototype for verification */
 119         const struct bpf_func_proto *(*get_func_proto)(enum bpf_func_id func_id);
 120
 121         /* return true if 'size' wide access at offset 'off' within bpf_context
 122          * with 'type' (read or write) is allowed
 123          */
 124         bool (*is_valid_access)(int off, int size, enum bpf_access_type type);
 125
 126         u32 (*convert_ctx_access)(enum bpf_access_type type, int dst_reg,
 127                                   int src_reg, int ctx_off,
 128                                   struct bpf_insn *insn, struct bpf_prog *prog);
 129 };
 130
 131 struct bpf_prog_type_list {
 132         struct list_head list_node;
 133         const struct bpf_verifier_ops *ops;
 134         enum bpf_prog_type type;
 135 };
 136
 137 struct bpf_prog_aux {
 138         atomic_t refcnt;
 139         u32 used_map_cnt;
 140         const struct bpf_verifier_ops *ops;
 141         struct bpf_map **used_maps;
 142         struct bpf_prog *prog;
 143         struct user_struct *user;
 144         union {
 145                 struct work_struct work;
 146                 struct rcu_head rcu;
 147         };
 148 };
 149
 150 struct bpf_array {
 151         struct bpf_map map;
 152         u32 elem_size;
 153         u32 index_mask;
 154         /* 'ownership' of prog_array is claimed by the first program that
 155          * is going to use this map or by the first program which FD is stored
 156          * in the map to make sure that all callers and callees have the same
 157          * prog_type and JITed flag
 158          */
 159         enum bpf_prog_type owner_prog_type;
 160         bool owner_jited;
 161         union {
 162                 char value[0] __aligned(8);
 163                 void *ptrs[0] __aligned(8);
 164         };
 165 };
 166 #define MAX_TAIL_CALL_CNT 32
 167
 168 u64 bpf_tail_call(u64 ctx, u64 r2, u64 index, u64 r4, u64 r5);
 169 void bpf_fd_array_map_clear(struct bpf_map *map);
 170 bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
 171 const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
 172
 173 #ifdef CONFIG_BPF_SYSCALL
 174 void bpf_register_prog_type(struct bpf_prog_type_list *tl);
 175 void bpf_register_map_type(struct bpf_map_type_list *tl);
 176
 177 struct bpf_prog *bpf_prog_get(u32 ufd);
 178 struct bpf_prog *bpf_prog_inc(struct bpf_prog *prog);
 179 void bpf_prog_put(struct bpf_prog *prog);
 180
 181 struct bpf_map *bpf_map_get_with_uref(u32 ufd);
 182 struct bpf_map *__bpf_map_get(struct fd f);
 183 struct bpf_map *bpf_map_inc(struct bpf_map *map, bool uref);
 184 void bpf_map_put_with_uref(struct bpf_map *map);
 185 void bpf_map_put(struct bpf_map *map);
 186
 187 extern int sysctl_unprivileged_bpf_disabled;
 188
 189 int bpf_map_new_fd(struct bpf_map *map);
 190 int bpf_prog_new_fd(struct bpf_prog *prog);
 191
 192 int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
 193 int bpf_obj_get_user(const char __user *pathname);
 194
 195 /* verify correctness of eBPF program */
 196 int bpf_check(struct bpf_prog **fp, union bpf_attr *attr);
 197 #else
 198 static inline void bpf_register_prog_type(struct bpf_prog_type_list *tl)
 199 {
 200 }
 201
 202 static inline struct bpf_prog *bpf_prog_get(u32 ufd)
 203 {
 204         return ERR_PTR(-EOPNOTSUPP);
 205 }
 206
 207 static inline void bpf_prog_put(struct bpf_prog *prog)
 208 {
 209 }
 210 #endif /* CONFIG_BPF_SYSCALL */
 211
 212 /* verifier prototypes for helper functions called from eBPF programs */
 213 extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
 214 extern const struct bpf_func_proto bpf_map_update_elem_proto;
 215 extern const struct bpf_func_proto bpf_map_delete_elem_proto;
 216
 217 extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
 218 extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
 219 extern const struct bpf_func_proto bpf_tail_call_proto;
 220 extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
 221 extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
 222 extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
 223 extern const struct bpf_func_proto bpf_get_current_comm_proto;
 224 extern const struct bpf_func_proto bpf_skb_vlan_push_proto;
 225 extern const struct bpf_func_proto bpf_skb_vlan_pop_proto;
 226
 227 /* Shared helpers among cBPF and eBPF. */
 228 void bpf_user_rnd_init_once(void);
 229 u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
 230
 231 #endif /* _LINUX_BPF_H */