1 /* Copyright (c) 2011-2014 PLUMgrid, http://plumgrid.com
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.
10 #include <uapi/linux/bpf.h>
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>
21 /* map is generic key/value storage optionally accesible by eBPF programs */
23 /* funcs callable from userspace (via syscall) */
24 struct bpf_map *(*map_alloc)(union bpf_attr *attr);
25 void (*map_release)(struct bpf_map *map, struct file *map_file);
26 void (*map_free)(struct bpf_map *map);
27 int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key);
29 /* funcs callable from userspace and from eBPF programs */
30 void *(*map_lookup_elem)(struct bpf_map *map, void *key);
31 int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags);
32 int (*map_delete_elem)(struct bpf_map *map, void *key);
34 /* funcs called by prog_array and perf_event_array map */
35 void *(*map_fd_get_ptr)(struct bpf_map *map, struct file *map_file,
37 void (*map_fd_put_ptr)(void *ptr);
38 u32 (*map_gen_lookup)(struct bpf_map *map, struct bpf_insn *insn_buf);
43 enum bpf_map_type map_type;
50 struct user_struct *user;
51 const struct bpf_map_ops *ops;
52 struct work_struct work;
54 struct bpf_map *inner_map_meta;
57 /* function argument constraints */
59 ARG_DONTCARE = 0, /* unused argument in helper function */
61 /* the following constraints used to prototype
62 * bpf_map_lookup/update/delete_elem() functions
64 ARG_CONST_MAP_PTR, /* const argument used as pointer to bpf_map */
65 ARG_PTR_TO_MAP_KEY, /* pointer to stack used as map key */
66 ARG_PTR_TO_MAP_VALUE, /* pointer to stack used as map value */
68 /* the following constraints used to prototype bpf_memcmp() and other
69 * functions that access data on eBPF program stack
71 ARG_PTR_TO_MEM, /* pointer to valid memory (stack, packet, map value) */
72 ARG_PTR_TO_UNINIT_MEM, /* pointer to memory does not need to be initialized,
73 * helper function must fill all bytes or clear
77 ARG_CONST_SIZE, /* number of bytes accessed from memory */
78 ARG_CONST_SIZE_OR_ZERO, /* number of bytes accessed from memory or 0 */
80 ARG_PTR_TO_CTX, /* pointer to context */
81 ARG_ANYTHING, /* any (initialized) argument is ok */
84 /* type of values returned from helper functions */
85 enum bpf_return_type {
86 RET_INTEGER, /* function returns integer */
87 RET_VOID, /* function doesn't return anything */
88 RET_PTR_TO_MAP_VALUE_OR_NULL, /* returns a pointer to map elem value or NULL */
91 /* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
92 * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
93 * instructions after verifying
95 struct bpf_func_proto {
96 u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
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;
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 *'
113 enum bpf_access_type {
118 /* types of values stored in eBPF registers */
120 NOT_INIT = 0, /* nothing was written into register */
121 UNKNOWN_VALUE, /* reg doesn't contain a valid pointer */
122 PTR_TO_CTX, /* reg points to bpf_context */
123 CONST_PTR_TO_MAP, /* reg points to struct bpf_map */
124 PTR_TO_MAP_VALUE, /* reg points to map element value */
125 PTR_TO_MAP_VALUE_OR_NULL,/* points to map elem value or NULL */
126 FRAME_PTR, /* reg == frame_pointer */
127 PTR_TO_STACK, /* reg == frame_pointer + imm */
128 CONST_IMM, /* constant integer value */
130 /* PTR_TO_PACKET represents:
133 * skb->data + (u16) var
134 * skb->data + (u16) var + imm
135 * if (range > 0) then [ptr, ptr + range - off) is safe to access
136 * if (id > 0) means that some 'var' was added
137 * if (off > 0) menas that 'imm' was added
140 PTR_TO_PACKET_END, /* skb->data + headlen */
142 /* PTR_TO_MAP_VALUE_ADJ is used for doing pointer math inside of a map
143 * elem value. We only allow this if we can statically verify that
144 * access from this register are going to fall within the size of the
147 PTR_TO_MAP_VALUE_ADJ,
152 /* The information passed from prog-specific *_is_valid_access
153 * back to the verifier.
155 struct bpf_insn_access_aux {
156 enum bpf_reg_type reg_type;
158 int converted_op_size;
161 struct bpf_verifier_ops {
162 /* return eBPF function prototype for verification */
163 const struct bpf_func_proto *(*get_func_proto)(enum bpf_func_id func_id);
165 /* return true if 'size' wide access at offset 'off' within bpf_context
166 * with 'type' (read or write) is allowed
168 bool (*is_valid_access)(int off, int size, enum bpf_access_type type,
169 struct bpf_insn_access_aux *info);
170 int (*gen_prologue)(struct bpf_insn *insn, bool direct_write,
171 const struct bpf_prog *prog);
172 u32 (*convert_ctx_access)(enum bpf_access_type type,
173 const struct bpf_insn *src,
174 struct bpf_insn *dst,
175 struct bpf_prog *prog);
176 int (*test_run)(struct bpf_prog *prog, const union bpf_attr *kattr,
177 union bpf_attr __user *uattr);
180 struct bpf_prog_aux {
186 struct latch_tree_node ksym_tnode;
187 struct list_head ksym_lnode;
188 const struct bpf_verifier_ops *ops;
189 struct bpf_map **used_maps;
190 struct bpf_prog *prog;
191 struct user_struct *user;
193 struct work_struct work;
201 /* 'ownership' of prog_array is claimed by the first program that
202 * is going to use this map or by the first program which FD is stored
203 * in the map to make sure that all callers and callees have the same
204 * prog_type and JITed flag
206 enum bpf_prog_type owner_prog_type;
209 char value[0] __aligned(8);
210 void *ptrs[0] __aligned(8);
211 void __percpu *pptrs[0] __aligned(8);
215 #define MAX_TAIL_CALL_CNT 32
217 struct bpf_event_entry {
218 struct perf_event *event;
219 struct file *perf_file;
220 struct file *map_file;
224 u64 bpf_tail_call(u64 ctx, u64 r2, u64 index, u64 r4, u64 r5);
225 u64 bpf_get_stackid(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
227 bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
228 int bpf_prog_calc_tag(struct bpf_prog *fp);
230 const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
232 typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src,
233 unsigned long off, unsigned long len);
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);
238 int bpf_prog_test_run_xdp(struct bpf_prog *prog, const union bpf_attr *kattr,
239 union bpf_attr __user *uattr);
240 int bpf_prog_test_run_skb(struct bpf_prog *prog, const union bpf_attr *kattr,
241 union bpf_attr __user *uattr);
243 #ifdef CONFIG_BPF_SYSCALL
244 DECLARE_PER_CPU(int, bpf_prog_active);
246 #define BPF_PROG_TYPE(_id, _ops) \
247 extern const struct bpf_verifier_ops _ops;
248 #define BPF_MAP_TYPE(_id, _ops) \
249 extern const struct bpf_map_ops _ops;
250 #include <linux/bpf_types.h>
254 struct bpf_prog *bpf_prog_get(u32 ufd);
255 struct bpf_prog *bpf_prog_get_type(u32 ufd, enum bpf_prog_type type);
256 struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog, int i);
257 void bpf_prog_sub(struct bpf_prog *prog, int i);
258 struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog);
259 void bpf_prog_put(struct bpf_prog *prog);
260 int __bpf_prog_charge(struct user_struct *user, u32 pages);
261 void __bpf_prog_uncharge(struct user_struct *user, u32 pages);
263 struct bpf_map *bpf_map_get_with_uref(u32 ufd);
264 struct bpf_map *__bpf_map_get(struct fd f);
265 struct bpf_map * __must_check bpf_map_inc(struct bpf_map *map, bool uref);
266 void bpf_map_put_with_uref(struct bpf_map *map);
267 void bpf_map_put(struct bpf_map *map);
268 int bpf_map_precharge_memlock(u32 pages);
269 void *bpf_map_area_alloc(size_t size);
270 void bpf_map_area_free(void *base);
272 extern int sysctl_unprivileged_bpf_disabled;
274 int bpf_map_new_fd(struct bpf_map *map);
275 int bpf_prog_new_fd(struct bpf_prog *prog);
277 int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
278 int bpf_obj_get_user(const char __user *pathname);
280 int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value);
281 int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value);
282 int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
284 int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
287 int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value);
289 int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
290 void *key, void *value, u64 map_flags);
291 void bpf_fd_array_map_clear(struct bpf_map *map);
292 int bpf_fd_htab_map_update_elem(struct bpf_map *map, struct file *map_file,
293 void *key, void *value, u64 map_flags);
295 /* memcpy that is used with 8-byte aligned pointers, power-of-8 size and
296 * forced to use 'long' read/writes to try to atomically copy long counters.
297 * Best-effort only. No barriers here, since it _will_ race with concurrent
298 * updates from BPF programs. Called from bpf syscall and mostly used with
299 * size 8 or 16 bytes, so ask compiler to inline it.
301 static inline void bpf_long_memcpy(void *dst, const void *src, u32 size)
303 const long *lsrc = src;
306 size /= sizeof(long);
311 /* verify correctness of eBPF program */
312 int bpf_check(struct bpf_prog **fp, union bpf_attr *attr);
314 static inline struct bpf_prog *bpf_prog_get(u32 ufd)
316 return ERR_PTR(-EOPNOTSUPP);
319 static inline struct bpf_prog *bpf_prog_get_type(u32 ufd,
320 enum bpf_prog_type type)
322 return ERR_PTR(-EOPNOTSUPP);
324 static inline struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog,
327 return ERR_PTR(-EOPNOTSUPP);
330 static inline void bpf_prog_sub(struct bpf_prog *prog, int i)
334 static inline void bpf_prog_put(struct bpf_prog *prog)
338 static inline struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog)
340 return ERR_PTR(-EOPNOTSUPP);
343 static inline int __bpf_prog_charge(struct user_struct *user, u32 pages)
348 static inline void __bpf_prog_uncharge(struct user_struct *user, u32 pages)
351 #endif /* CONFIG_BPF_SYSCALL */
353 /* verifier prototypes for helper functions called from eBPF programs */
354 extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
355 extern const struct bpf_func_proto bpf_map_update_elem_proto;
356 extern const struct bpf_func_proto bpf_map_delete_elem_proto;
358 extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
359 extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
360 extern const struct bpf_func_proto bpf_get_numa_node_id_proto;
361 extern const struct bpf_func_proto bpf_tail_call_proto;
362 extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
363 extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
364 extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
365 extern const struct bpf_func_proto bpf_get_current_comm_proto;
366 extern const struct bpf_func_proto bpf_skb_vlan_push_proto;
367 extern const struct bpf_func_proto bpf_skb_vlan_pop_proto;
368 extern const struct bpf_func_proto bpf_get_stackid_proto;
370 /* Shared helpers among cBPF and eBPF. */
371 void bpf_user_rnd_init_once(void);
372 u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
374 #endif /* _LINUX_BPF_H */