]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - include/linux/bpf.h
vmbus: eliminate duplicate cached index
[mirror_ubuntu-artful-kernel.git] / include / linux / bpf.h
CommitLineData
99c55f7d
AS
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>
74451e66 11
99c55f7d 12#include <linux/workqueue.h>
db20fd2b 13#include <linux/file.h>
b121d1e7 14#include <linux/percpu.h>
002245cc 15#include <linux/err.h>
74451e66 16#include <linux/rbtree_latch.h>
99c55f7d 17
3b1efb19 18struct perf_event;
99c55f7d
AS
19struct bpf_map;
20
21/* map is generic key/value storage optionally accesible by eBPF programs */
22struct bpf_map_ops {
23 /* funcs callable from userspace (via syscall) */
24 struct bpf_map *(*map_alloc)(union bpf_attr *attr);
61d1b6a4
DB
25 void (*map_release)(struct bpf_map *map, struct file *map_file);
26 void (*map_free)(struct bpf_map *map);
db20fd2b
AS
27 int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key);
28
29 /* funcs callable from userspace and from eBPF programs */
30 void *(*map_lookup_elem)(struct bpf_map *map, void *key);
3274f520 31 int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags);
db20fd2b 32 int (*map_delete_elem)(struct bpf_map *map, void *key);
2a36f0b9
WN
33
34 /* funcs called by prog_array and perf_event_array map */
d056a788
DB
35 void *(*map_fd_get_ptr)(struct bpf_map *map, struct file *map_file,
36 int fd);
37 void (*map_fd_put_ptr)(void *ptr);
81ed18ab 38 u32 (*map_gen_lookup)(struct bpf_map *map, struct bpf_insn *insn_buf);
14dc6f04 39 u32 (*map_fd_sys_lookup_elem)(void *ptr);
99c55f7d
AS
40};
41
42struct bpf_map {
43 atomic_t refcnt;
44 enum bpf_map_type map_type;
45 u32 key_size;
46 u32 value_size;
47 u32 max_entries;
6c905981 48 u32 map_flags;
aaac3ba9 49 u32 pages;
f3f1c054 50 u32 id;
aaac3ba9 51 struct user_struct *user;
a2c83fff 52 const struct bpf_map_ops *ops;
99c55f7d 53 struct work_struct work;
c9da161c 54 atomic_t usercnt;
56f668df 55 struct bpf_map *inner_map_meta;
99c55f7d
AS
56};
57
17a52670
AS
58/* function argument constraints */
59enum bpf_arg_type {
80f1d68c 60 ARG_DONTCARE = 0, /* unused argument in helper function */
17a52670
AS
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 */
39f19ebb
AS
72 ARG_PTR_TO_MEM, /* pointer to valid memory (stack, packet, map value) */
73 ARG_PTR_TO_UNINIT_MEM, /* pointer to memory does not need to be initialized,
74 * helper function must fill all bytes or clear
75 * them in error case.
435faee1
DB
76 */
77
39f19ebb
AS
78 ARG_CONST_SIZE, /* number of bytes accessed from memory */
79 ARG_CONST_SIZE_OR_ZERO, /* number of bytes accessed from memory or 0 */
80f1d68c 80
608cd71a 81 ARG_PTR_TO_CTX, /* pointer to context */
80f1d68c 82 ARG_ANYTHING, /* any (initialized) argument is ok */
17a52670
AS
83};
84
85/* type of values returned from helper functions */
86enum 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
09756af4
AS
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 */
96struct bpf_func_proto {
97 u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
98 bool gpl_only;
36bbef52 99 bool pkt_access;
17a52670
AS
100 enum bpf_return_type ret_type;
101 enum bpf_arg_type arg1_type;
102 enum bpf_arg_type arg2_type;
103 enum bpf_arg_type arg3_type;
104 enum bpf_arg_type arg4_type;
105 enum bpf_arg_type arg5_type;
106};
107
108/* bpf_context is intentionally undefined structure. Pointer to bpf_context is
109 * the first argument to eBPF programs.
110 * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
111 */
112struct bpf_context;
113
114enum bpf_access_type {
115 BPF_READ = 1,
116 BPF_WRITE = 2
09756af4
AS
117};
118
19de99f7
AS
119/* types of values stored in eBPF registers */
120enum bpf_reg_type {
121 NOT_INIT = 0, /* nothing was written into register */
122 UNKNOWN_VALUE, /* reg doesn't contain a valid pointer */
123 PTR_TO_CTX, /* reg points to bpf_context */
124 CONST_PTR_TO_MAP, /* reg points to struct bpf_map */
125 PTR_TO_MAP_VALUE, /* reg points to map element value */
126 PTR_TO_MAP_VALUE_OR_NULL,/* points to map elem value or NULL */
127 FRAME_PTR, /* reg == frame_pointer */
128 PTR_TO_STACK, /* reg == frame_pointer + imm */
129 CONST_IMM, /* constant integer value */
130
131 /* PTR_TO_PACKET represents:
132 * skb->data
133 * skb->data + imm
134 * skb->data + (u16) var
135 * skb->data + (u16) var + imm
136 * if (range > 0) then [ptr, ptr + range - off) is safe to access
137 * if (id > 0) means that some 'var' was added
138 * if (off > 0) menas that 'imm' was added
139 */
140 PTR_TO_PACKET,
141 PTR_TO_PACKET_END, /* skb->data + headlen */
48461135
JB
142
143 /* PTR_TO_MAP_VALUE_ADJ is used for doing pointer math inside of a map
144 * elem value. We only allow this if we can statically verify that
145 * access from this register are going to fall within the size of the
146 * map element.
147 */
148 PTR_TO_MAP_VALUE_ADJ,
19de99f7
AS
149};
150
ff936a04
AS
151struct bpf_prog;
152
23994631
YS
153/* The information passed from prog-specific *_is_valid_access
154 * back to the verifier.
155 */
156struct bpf_insn_access_aux {
157 enum bpf_reg_type reg_type;
158 int ctx_field_size;
23994631
YS
159};
160
f96da094
DB
161static inline void
162bpf_ctx_record_field_size(struct bpf_insn_access_aux *aux, u32 size)
163{
164 aux->ctx_field_size = size;
165}
166
09756af4
AS
167struct bpf_verifier_ops {
168 /* return eBPF function prototype for verification */
169 const struct bpf_func_proto *(*get_func_proto)(enum bpf_func_id func_id);
17a52670
AS
170
171 /* return true if 'size' wide access at offset 'off' within bpf_context
172 * with 'type' (read or write) is allowed
173 */
19de99f7 174 bool (*is_valid_access)(int off, int size, enum bpf_access_type type,
23994631 175 struct bpf_insn_access_aux *info);
36bbef52
DB
176 int (*gen_prologue)(struct bpf_insn *insn, bool direct_write,
177 const struct bpf_prog *prog);
6b8cc1d1
DB
178 u32 (*convert_ctx_access)(enum bpf_access_type type,
179 const struct bpf_insn *src,
180 struct bpf_insn *dst,
f96da094 181 struct bpf_prog *prog, u32 *target_size);
1cf1cae9
AS
182 int (*test_run)(struct bpf_prog *prog, const union bpf_attr *kattr,
183 union bpf_attr __user *uattr);
09756af4
AS
184};
185
09756af4
AS
186struct bpf_prog_aux {
187 atomic_t refcnt;
24701ece 188 u32 used_map_cnt;
32bbe007 189 u32 max_ctx_offset;
8726679a 190 u32 stack_depth;
dc4bb0e2 191 u32 id;
74451e66
DB
192 struct latch_tree_node ksym_tnode;
193 struct list_head ksym_lnode;
a2c83fff 194 const struct bpf_verifier_ops *ops;
09756af4 195 struct bpf_map **used_maps;
09756af4 196 struct bpf_prog *prog;
aaac3ba9 197 struct user_struct *user;
abf2e7d6
AS
198 union {
199 struct work_struct work;
200 struct rcu_head rcu;
201 };
09756af4
AS
202};
203
04fd61ab
AS
204struct bpf_array {
205 struct bpf_map map;
206 u32 elem_size;
207 /* 'ownership' of prog_array is claimed by the first program that
208 * is going to use this map or by the first program which FD is stored
209 * in the map to make sure that all callers and callees have the same
210 * prog_type and JITed flag
211 */
212 enum bpf_prog_type owner_prog_type;
213 bool owner_jited;
214 union {
215 char value[0] __aligned(8);
2a36f0b9 216 void *ptrs[0] __aligned(8);
a10423b8 217 void __percpu *pptrs[0] __aligned(8);
04fd61ab
AS
218 };
219};
3b1efb19 220
04fd61ab
AS
221#define MAX_TAIL_CALL_CNT 32
222
3b1efb19
DB
223struct bpf_event_entry {
224 struct perf_event *event;
225 struct file *perf_file;
226 struct file *map_file;
227 struct rcu_head rcu;
228};
229
04fd61ab 230u64 bpf_tail_call(u64 ctx, u64 r2, u64 index, u64 r4, u64 r5);
9940d67c 231u64 bpf_get_stackid(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
d056a788 232
04fd61ab 233bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
f1f7714e 234int bpf_prog_calc_tag(struct bpf_prog *fp);
bd570ff9 235
0756ea3e 236const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
555c8a86
DB
237
238typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src,
aa7145c1 239 unsigned long off, unsigned long len);
555c8a86
DB
240
241u64 bpf_event_output(struct bpf_map *map, u64 flags, void *meta, u64 meta_size,
242 void *ctx, u64 ctx_size, bpf_ctx_copy_t ctx_copy);
04fd61ab 243
1cf1cae9
AS
244int bpf_prog_test_run_xdp(struct bpf_prog *prog, const union bpf_attr *kattr,
245 union bpf_attr __user *uattr);
246int bpf_prog_test_run_skb(struct bpf_prog *prog, const union bpf_attr *kattr,
247 union bpf_attr __user *uattr);
248
89aa0758 249#ifdef CONFIG_BPF_SYSCALL
b121d1e7
AS
250DECLARE_PER_CPU(int, bpf_prog_active);
251
be9370a7
JB
252#define BPF_PROG_TYPE(_id, _ops) \
253 extern const struct bpf_verifier_ops _ops;
40077e0c
JB
254#define BPF_MAP_TYPE(_id, _ops) \
255 extern const struct bpf_map_ops _ops;
be9370a7
JB
256#include <linux/bpf_types.h>
257#undef BPF_PROG_TYPE
40077e0c 258#undef BPF_MAP_TYPE
0fc174de 259
0fc174de 260struct bpf_prog *bpf_prog_get(u32 ufd);
113214be 261struct bpf_prog *bpf_prog_get_type(u32 ufd, enum bpf_prog_type type);
6d67942d 262struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog, int i);
c540594f 263void bpf_prog_sub(struct bpf_prog *prog, int i);
6d67942d 264struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog);
61e021f3 265void bpf_prog_put(struct bpf_prog *prog);
5ccb071e
DB
266int __bpf_prog_charge(struct user_struct *user, u32 pages);
267void __bpf_prog_uncharge(struct user_struct *user, u32 pages);
61e021f3 268
c9da161c 269struct bpf_map *bpf_map_get_with_uref(u32 ufd);
c2101297 270struct bpf_map *__bpf_map_get(struct fd f);
6d67942d 271struct bpf_map * __must_check bpf_map_inc(struct bpf_map *map, bool uref);
c9da161c 272void bpf_map_put_with_uref(struct bpf_map *map);
61e021f3 273void bpf_map_put(struct bpf_map *map);
6c905981 274int bpf_map_precharge_memlock(u32 pages);
d407bd25
DB
275void *bpf_map_area_alloc(size_t size);
276void bpf_map_area_free(void *base);
61e021f3 277
1be7f75d
AS
278extern int sysctl_unprivileged_bpf_disabled;
279
b2197755
DB
280int bpf_map_new_fd(struct bpf_map *map);
281int bpf_prog_new_fd(struct bpf_prog *prog);
282
283int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
284int bpf_obj_get_user(const char __user *pathname);
285
15a07b33
AS
286int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value);
287int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value);
288int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
289 u64 flags);
290int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
291 u64 flags);
d056a788 292
557c0c6e 293int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value);
15a07b33 294
d056a788
DB
295int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
296 void *key, void *value, u64 map_flags);
14dc6f04 297int bpf_fd_array_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
d056a788 298void bpf_fd_array_map_clear(struct bpf_map *map);
bcc6b1b7
MKL
299int bpf_fd_htab_map_update_elem(struct bpf_map *map, struct file *map_file,
300 void *key, void *value, u64 map_flags);
14dc6f04 301int bpf_fd_htab_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
d056a788 302
15a07b33
AS
303/* memcpy that is used with 8-byte aligned pointers, power-of-8 size and
304 * forced to use 'long' read/writes to try to atomically copy long counters.
305 * Best-effort only. No barriers here, since it _will_ race with concurrent
306 * updates from BPF programs. Called from bpf syscall and mostly used with
307 * size 8 or 16 bytes, so ask compiler to inline it.
308 */
309static inline void bpf_long_memcpy(void *dst, const void *src, u32 size)
310{
311 const long *lsrc = src;
312 long *ldst = dst;
313
314 size /= sizeof(long);
315 while (size--)
316 *ldst++ = *lsrc++;
317}
318
61e021f3 319/* verify correctness of eBPF program */
9bac3d6d 320int bpf_check(struct bpf_prog **fp, union bpf_attr *attr);
89aa0758 321#else
0fc174de
DB
322static inline struct bpf_prog *bpf_prog_get(u32 ufd)
323{
324 return ERR_PTR(-EOPNOTSUPP);
325}
326
113214be
DB
327static inline struct bpf_prog *bpf_prog_get_type(u32 ufd,
328 enum bpf_prog_type type)
329{
330 return ERR_PTR(-EOPNOTSUPP);
331}
6d67942d
DB
332static inline struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog,
333 int i)
cc2e0b3f
BB
334{
335 return ERR_PTR(-EOPNOTSUPP);
336}
113214be 337
c540594f
DB
338static inline void bpf_prog_sub(struct bpf_prog *prog, int i)
339{
340}
341
0fc174de
DB
342static inline void bpf_prog_put(struct bpf_prog *prog)
343{
344}
6d67942d
DB
345
346static inline struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog)
aa6a5f3c
AS
347{
348 return ERR_PTR(-EOPNOTSUPP);
349}
5ccb071e
DB
350
351static inline int __bpf_prog_charge(struct user_struct *user, u32 pages)
352{
353 return 0;
354}
355
356static inline void __bpf_prog_uncharge(struct user_struct *user, u32 pages)
357{
358}
61e021f3 359#endif /* CONFIG_BPF_SYSCALL */
09756af4 360
d0003ec0 361/* verifier prototypes for helper functions called from eBPF programs */
a2c83fff
DB
362extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
363extern const struct bpf_func_proto bpf_map_update_elem_proto;
364extern const struct bpf_func_proto bpf_map_delete_elem_proto;
d0003ec0 365
03e69b50 366extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
c04167ce 367extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
2d0e30c3 368extern const struct bpf_func_proto bpf_get_numa_node_id_proto;
04fd61ab 369extern const struct bpf_func_proto bpf_tail_call_proto;
17ca8cbf 370extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
ffeedafb
AS
371extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
372extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
373extern const struct bpf_func_proto bpf_get_current_comm_proto;
4e10df9a
AS
374extern const struct bpf_func_proto bpf_skb_vlan_push_proto;
375extern const struct bpf_func_proto bpf_skb_vlan_pop_proto;
d5a3b1f6 376extern const struct bpf_func_proto bpf_get_stackid_proto;
03e69b50 377
3ad00405
DB
378/* Shared helpers among cBPF and eBPF. */
379void bpf_user_rnd_init_once(void);
380u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
381
99c55f7d 382#endif /* _LINUX_BPF_H */