bpf, doc: Document Jump X addressing mode
[linux-2.6-block.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>
d6e1e46f 17#include <linux/numa.h>
ab3f0063 18#include <linux/wait.h>
99c55f7d 19
cae1927c 20struct bpf_verifier_env;
3b1efb19 21struct perf_event;
174a79ff 22struct bpf_prog;
99c55f7d 23struct bpf_map;
4f738adb 24struct sock;
a26ca7c9 25struct seq_file;
e8d2bec0 26struct btf_type;
99c55f7d
AS
27
28/* map is generic key/value storage optionally accesible by eBPF programs */
29struct bpf_map_ops {
30 /* funcs callable from userspace (via syscall) */
1110f3a9 31 int (*map_alloc_check)(union bpf_attr *attr);
99c55f7d 32 struct bpf_map *(*map_alloc)(union bpf_attr *attr);
61d1b6a4
DB
33 void (*map_release)(struct bpf_map *map, struct file *map_file);
34 void (*map_free)(struct bpf_map *map);
db20fd2b 35 int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key);
ba6b8de4 36 void (*map_release_uref)(struct bpf_map *map);
db20fd2b
AS
37
38 /* funcs callable from userspace and from eBPF programs */
39 void *(*map_lookup_elem)(struct bpf_map *map, void *key);
3274f520 40 int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags);
db20fd2b 41 int (*map_delete_elem)(struct bpf_map *map, void *key);
2a36f0b9
WN
42
43 /* funcs called by prog_array and perf_event_array map */
d056a788
DB
44 void *(*map_fd_get_ptr)(struct bpf_map *map, struct file *map_file,
45 int fd);
46 void (*map_fd_put_ptr)(void *ptr);
81ed18ab 47 u32 (*map_gen_lookup)(struct bpf_map *map, struct bpf_insn *insn_buf);
14dc6f04 48 u32 (*map_fd_sys_lookup_elem)(void *ptr);
a26ca7c9
MKL
49 void (*map_seq_show_elem)(struct bpf_map *map, void *key,
50 struct seq_file *m);
e8d2bec0
DB
51 int (*map_check_btf)(const struct bpf_map *map,
52 const struct btf_type *key_type,
53 const struct btf_type *value_type);
99c55f7d
AS
54};
55
56struct bpf_map {
a26ca7c9 57 /* The first two cachelines with read-mostly members of which some
be95a845
DB
58 * are also accessed in fast-path (e.g. ops, max_entries).
59 */
60 const struct bpf_map_ops *ops ____cacheline_aligned;
61 struct bpf_map *inner_map_meta;
62#ifdef CONFIG_SECURITY
63 void *security;
64#endif
99c55f7d
AS
65 enum bpf_map_type map_type;
66 u32 key_size;
67 u32 value_size;
68 u32 max_entries;
6c905981 69 u32 map_flags;
aaac3ba9 70 u32 pages;
f3f1c054 71 u32 id;
96eabe7a 72 int numa_node;
9b2cf328
MKL
73 u32 btf_key_type_id;
74 u32 btf_value_type_id;
a26ca7c9 75 struct btf *btf;
b2157399 76 bool unpriv_array;
a26ca7c9 77 /* 55 bytes hole */
be95a845 78
a26ca7c9 79 /* The 3rd and 4th cacheline with misc members to avoid false sharing
be95a845
DB
80 * particularly with refcounting.
81 */
82 struct user_struct *user ____cacheline_aligned;
83 atomic_t refcnt;
c9da161c 84 atomic_t usercnt;
be95a845 85 struct work_struct work;
067cae47 86 char name[BPF_OBJ_NAME_LEN];
99c55f7d
AS
87};
88
602144c2 89struct bpf_offload_dev;
a3884572
JK
90struct bpf_offloaded_map;
91
92struct bpf_map_dev_ops {
93 int (*map_get_next_key)(struct bpf_offloaded_map *map,
94 void *key, void *next_key);
95 int (*map_lookup_elem)(struct bpf_offloaded_map *map,
96 void *key, void *value);
97 int (*map_update_elem)(struct bpf_offloaded_map *map,
98 void *key, void *value, u64 flags);
99 int (*map_delete_elem)(struct bpf_offloaded_map *map, void *key);
100};
101
102struct bpf_offloaded_map {
103 struct bpf_map map;
104 struct net_device *netdev;
105 const struct bpf_map_dev_ops *dev_ops;
106 void *dev_priv;
107 struct list_head offloads;
108};
109
110static inline struct bpf_offloaded_map *map_to_offmap(struct bpf_map *map)
111{
112 return container_of(map, struct bpf_offloaded_map, map);
113}
114
0cd3cbed
JK
115static inline bool bpf_map_offload_neutral(const struct bpf_map *map)
116{
117 return map->map_type == BPF_MAP_TYPE_PERF_EVENT_ARRAY;
118}
119
a26ca7c9
MKL
120static inline bool bpf_map_support_seq_show(const struct bpf_map *map)
121{
e8d2bec0 122 return map->btf && map->ops->map_seq_show_elem;
a26ca7c9
MKL
123}
124
e8d2bec0
DB
125int map_check_no_btf(const struct bpf_map *map,
126 const struct btf_type *key_type,
127 const struct btf_type *value_type);
128
a3884572
JK
129extern const struct bpf_map_ops bpf_map_offload_ops;
130
17a52670
AS
131/* function argument constraints */
132enum bpf_arg_type {
80f1d68c 133 ARG_DONTCARE = 0, /* unused argument in helper function */
17a52670
AS
134
135 /* the following constraints used to prototype
136 * bpf_map_lookup/update/delete_elem() functions
137 */
138 ARG_CONST_MAP_PTR, /* const argument used as pointer to bpf_map */
139 ARG_PTR_TO_MAP_KEY, /* pointer to stack used as map key */
140 ARG_PTR_TO_MAP_VALUE, /* pointer to stack used as map value */
141
142 /* the following constraints used to prototype bpf_memcmp() and other
143 * functions that access data on eBPF program stack
144 */
39f19ebb 145 ARG_PTR_TO_MEM, /* pointer to valid memory (stack, packet, map value) */
db1ac496 146 ARG_PTR_TO_MEM_OR_NULL, /* pointer to valid memory or NULL */
39f19ebb
AS
147 ARG_PTR_TO_UNINIT_MEM, /* pointer to memory does not need to be initialized,
148 * helper function must fill all bytes or clear
149 * them in error case.
435faee1
DB
150 */
151
39f19ebb
AS
152 ARG_CONST_SIZE, /* number of bytes accessed from memory */
153 ARG_CONST_SIZE_OR_ZERO, /* number of bytes accessed from memory or 0 */
80f1d68c 154
608cd71a 155 ARG_PTR_TO_CTX, /* pointer to context */
80f1d68c 156 ARG_ANYTHING, /* any (initialized) argument is ok */
c64b7983 157 ARG_PTR_TO_SOCKET, /* pointer to bpf_sock */
17a52670
AS
158};
159
160/* type of values returned from helper functions */
161enum bpf_return_type {
162 RET_INTEGER, /* function returns integer */
163 RET_VOID, /* function doesn't return anything */
3e6a4b3e 164 RET_PTR_TO_MAP_VALUE, /* returns a pointer to map elem value */
17a52670 165 RET_PTR_TO_MAP_VALUE_OR_NULL, /* returns a pointer to map elem value or NULL */
c64b7983 166 RET_PTR_TO_SOCKET_OR_NULL, /* returns a pointer to a socket or NULL */
17a52670
AS
167};
168
09756af4
AS
169/* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
170 * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
171 * instructions after verifying
172 */
173struct bpf_func_proto {
174 u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
175 bool gpl_only;
36bbef52 176 bool pkt_access;
17a52670
AS
177 enum bpf_return_type ret_type;
178 enum bpf_arg_type arg1_type;
179 enum bpf_arg_type arg2_type;
180 enum bpf_arg_type arg3_type;
181 enum bpf_arg_type arg4_type;
182 enum bpf_arg_type arg5_type;
183};
184
185/* bpf_context is intentionally undefined structure. Pointer to bpf_context is
186 * the first argument to eBPF programs.
187 * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
188 */
189struct bpf_context;
190
191enum bpf_access_type {
192 BPF_READ = 1,
193 BPF_WRITE = 2
09756af4
AS
194};
195
19de99f7 196/* types of values stored in eBPF registers */
f1174f77
EC
197/* Pointer types represent:
198 * pointer
199 * pointer + imm
200 * pointer + (u16) var
201 * pointer + (u16) var + imm
202 * if (range > 0) then [ptr, ptr + range - off) is safe to access
203 * if (id > 0) means that some 'var' was added
204 * if (off > 0) means that 'imm' was added
205 */
19de99f7
AS
206enum bpf_reg_type {
207 NOT_INIT = 0, /* nothing was written into register */
f1174f77 208 SCALAR_VALUE, /* reg doesn't contain a valid pointer */
19de99f7
AS
209 PTR_TO_CTX, /* reg points to bpf_context */
210 CONST_PTR_TO_MAP, /* reg points to struct bpf_map */
211 PTR_TO_MAP_VALUE, /* reg points to map element value */
212 PTR_TO_MAP_VALUE_OR_NULL,/* points to map elem value or NULL */
f1174f77 213 PTR_TO_STACK, /* reg == frame_pointer + offset */
de8f3a83 214 PTR_TO_PACKET_META, /* skb->data - meta_len */
f1174f77 215 PTR_TO_PACKET, /* reg points to skb->data */
19de99f7 216 PTR_TO_PACKET_END, /* skb->data + headlen */
d58e468b 217 PTR_TO_FLOW_KEYS, /* reg points to bpf_flow_keys */
c64b7983
JS
218 PTR_TO_SOCKET, /* reg points to struct bpf_sock */
219 PTR_TO_SOCKET_OR_NULL, /* reg points to struct bpf_sock or NULL */
19de99f7
AS
220};
221
23994631
YS
222/* The information passed from prog-specific *_is_valid_access
223 * back to the verifier.
224 */
225struct bpf_insn_access_aux {
226 enum bpf_reg_type reg_type;
227 int ctx_field_size;
23994631
YS
228};
229
f96da094
DB
230static inline void
231bpf_ctx_record_field_size(struct bpf_insn_access_aux *aux, u32 size)
232{
233 aux->ctx_field_size = size;
234}
235
7de16e3a
JK
236struct bpf_prog_ops {
237 int (*test_run)(struct bpf_prog *prog, const union bpf_attr *kattr,
238 union bpf_attr __user *uattr);
239};
240
09756af4
AS
241struct bpf_verifier_ops {
242 /* return eBPF function prototype for verification */
5e43f899
AI
243 const struct bpf_func_proto *
244 (*get_func_proto)(enum bpf_func_id func_id,
245 const struct bpf_prog *prog);
17a52670
AS
246
247 /* return true if 'size' wide access at offset 'off' within bpf_context
248 * with 'type' (read or write) is allowed
249 */
19de99f7 250 bool (*is_valid_access)(int off, int size, enum bpf_access_type type,
5e43f899 251 const struct bpf_prog *prog,
23994631 252 struct bpf_insn_access_aux *info);
36bbef52
DB
253 int (*gen_prologue)(struct bpf_insn *insn, bool direct_write,
254 const struct bpf_prog *prog);
e0cea7ce
DB
255 int (*gen_ld_abs)(const struct bpf_insn *orig,
256 struct bpf_insn *insn_buf);
6b8cc1d1
DB
257 u32 (*convert_ctx_access)(enum bpf_access_type type,
258 const struct bpf_insn *src,
259 struct bpf_insn *dst,
f96da094 260 struct bpf_prog *prog, u32 *target_size);
09756af4
AS
261};
262
cae1927c
JK
263struct bpf_prog_offload_ops {
264 int (*insn_hook)(struct bpf_verifier_env *env,
265 int insn_idx, int prev_insn_idx);
266};
267
0a9c1991 268struct bpf_prog_offload {
ab3f0063
JK
269 struct bpf_prog *prog;
270 struct net_device *netdev;
271 void *dev_priv;
272 struct list_head offloads;
273 bool dev_state;
cae1927c 274 const struct bpf_prog_offload_ops *dev_ops;
fcfb126d
JW
275 void *jited_image;
276 u32 jited_len;
ab3f0063
JK
277};
278
8bad74f9
RG
279enum bpf_cgroup_storage_type {
280 BPF_CGROUP_STORAGE_SHARED,
b741f163 281 BPF_CGROUP_STORAGE_PERCPU,
8bad74f9
RG
282 __BPF_CGROUP_STORAGE_MAX
283};
284
285#define MAX_BPF_CGROUP_STORAGE_TYPE __BPF_CGROUP_STORAGE_MAX
286
09756af4
AS
287struct bpf_prog_aux {
288 atomic_t refcnt;
24701ece 289 u32 used_map_cnt;
32bbe007 290 u32 max_ctx_offset;
8726679a 291 u32 stack_depth;
dc4bb0e2 292 u32 id;
1c2a088a 293 u32 func_cnt;
9a18eedb 294 bool offload_requested;
1c2a088a
AS
295 struct bpf_prog **func;
296 void *jit_data; /* JIT specific data. arch dependent */
74451e66
DB
297 struct latch_tree_node ksym_tnode;
298 struct list_head ksym_lnode;
7de16e3a 299 const struct bpf_prog_ops *ops;
09756af4 300 struct bpf_map **used_maps;
09756af4 301 struct bpf_prog *prog;
aaac3ba9 302 struct user_struct *user;
cb4d2b3f 303 u64 load_time; /* ns since boottime */
8bad74f9 304 struct bpf_map *cgroup_storage[MAX_BPF_CGROUP_STORAGE_TYPE];
067cae47 305 char name[BPF_OBJ_NAME_LEN];
afdb09c7
CF
306#ifdef CONFIG_SECURITY
307 void *security;
308#endif
0a9c1991 309 struct bpf_prog_offload *offload;
abf2e7d6
AS
310 union {
311 struct work_struct work;
312 struct rcu_head rcu;
313 };
09756af4
AS
314};
315
04fd61ab
AS
316struct bpf_array {
317 struct bpf_map map;
318 u32 elem_size;
b2157399 319 u32 index_mask;
04fd61ab
AS
320 /* 'ownership' of prog_array is claimed by the first program that
321 * is going to use this map or by the first program which FD is stored
322 * in the map to make sure that all callers and callees have the same
323 * prog_type and JITed flag
324 */
325 enum bpf_prog_type owner_prog_type;
326 bool owner_jited;
327 union {
328 char value[0] __aligned(8);
2a36f0b9 329 void *ptrs[0] __aligned(8);
a10423b8 330 void __percpu *pptrs[0] __aligned(8);
04fd61ab
AS
331 };
332};
3b1efb19 333
04fd61ab
AS
334#define MAX_TAIL_CALL_CNT 32
335
3b1efb19
DB
336struct bpf_event_entry {
337 struct perf_event *event;
338 struct file *perf_file;
339 struct file *map_file;
340 struct rcu_head rcu;
341};
342
04fd61ab 343bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
f1f7714e 344int bpf_prog_calc_tag(struct bpf_prog *fp);
bd570ff9 345
0756ea3e 346const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
555c8a86
DB
347
348typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src,
aa7145c1 349 unsigned long off, unsigned long len);
c64b7983
JS
350typedef u32 (*bpf_convert_ctx_access_t)(enum bpf_access_type type,
351 const struct bpf_insn *src,
352 struct bpf_insn *dst,
353 struct bpf_prog *prog,
354 u32 *target_size);
555c8a86
DB
355
356u64 bpf_event_output(struct bpf_map *map, u64 flags, void *meta, u64 meta_size,
357 void *ctx, u64 ctx_size, bpf_ctx_copy_t ctx_copy);
04fd61ab 358
1cf1cae9
AS
359int bpf_prog_test_run_xdp(struct bpf_prog *prog, const union bpf_attr *kattr,
360 union bpf_attr __user *uattr);
361int bpf_prog_test_run_skb(struct bpf_prog *prog, const union bpf_attr *kattr,
362 union bpf_attr __user *uattr);
363
324bda9e
AS
364/* an array of programs to be executed under rcu_lock.
365 *
366 * Typical usage:
367 * ret = BPF_PROG_RUN_ARRAY(&bpf_prog_array, ctx, BPF_PROG_RUN);
368 *
369 * the structure returned by bpf_prog_array_alloc() should be populated
370 * with program pointers and the last pointer must be NULL.
371 * The user has to keep refcnt on the program and make sure the program
372 * is removed from the array before bpf_prog_put().
373 * The 'struct bpf_prog_array *' should only be replaced with xchg()
374 * since other cpus are walking the array of pointers in parallel.
375 */
394e40a2
RG
376struct bpf_prog_array_item {
377 struct bpf_prog *prog;
8bad74f9 378 struct bpf_cgroup_storage *cgroup_storage[MAX_BPF_CGROUP_STORAGE_TYPE];
394e40a2
RG
379};
380
324bda9e
AS
381struct bpf_prog_array {
382 struct rcu_head rcu;
394e40a2 383 struct bpf_prog_array_item items[0];
324bda9e
AS
384};
385
d29ab6e1 386struct bpf_prog_array *bpf_prog_array_alloc(u32 prog_cnt, gfp_t flags);
324bda9e 387void bpf_prog_array_free(struct bpf_prog_array __rcu *progs);
468e2f64
AS
388int bpf_prog_array_length(struct bpf_prog_array __rcu *progs);
389int bpf_prog_array_copy_to_user(struct bpf_prog_array __rcu *progs,
390 __u32 __user *prog_ids, u32 cnt);
324bda9e 391
e87c6bc3
YS
392void bpf_prog_array_delete_safe(struct bpf_prog_array __rcu *progs,
393 struct bpf_prog *old_prog);
f371b304 394int bpf_prog_array_copy_info(struct bpf_prog_array __rcu *array,
3a38bb98
YS
395 u32 *prog_ids, u32 request_cnt,
396 u32 *prog_cnt);
e87c6bc3
YS
397int bpf_prog_array_copy(struct bpf_prog_array __rcu *old_array,
398 struct bpf_prog *exclude_prog,
399 struct bpf_prog *include_prog,
400 struct bpf_prog_array **new_array);
401
402#define __BPF_PROG_RUN_ARRAY(array, ctx, func, check_non_null) \
324bda9e 403 ({ \
394e40a2
RG
404 struct bpf_prog_array_item *_item; \
405 struct bpf_prog *_prog; \
e87c6bc3 406 struct bpf_prog_array *_array; \
324bda9e 407 u32 _ret = 1; \
6899b32b 408 preempt_disable(); \
324bda9e 409 rcu_read_lock(); \
e87c6bc3
YS
410 _array = rcu_dereference(array); \
411 if (unlikely(check_non_null && !_array))\
412 goto _out; \
394e40a2
RG
413 _item = &_array->items[0]; \
414 while ((_prog = READ_ONCE(_item->prog))) { \
415 bpf_cgroup_storage_set(_item->cgroup_storage); \
416 _ret &= func(_prog, ctx); \
417 _item++; \
e87c6bc3
YS
418 } \
419_out: \
324bda9e 420 rcu_read_unlock(); \
6899b32b 421 preempt_enable_no_resched(); \
324bda9e
AS
422 _ret; \
423 })
424
e87c6bc3
YS
425#define BPF_PROG_RUN_ARRAY(array, ctx, func) \
426 __BPF_PROG_RUN_ARRAY(array, ctx, func, false)
427
428#define BPF_PROG_RUN_ARRAY_CHECK(array, ctx, func) \
429 __BPF_PROG_RUN_ARRAY(array, ctx, func, true)
430
89aa0758 431#ifdef CONFIG_BPF_SYSCALL
b121d1e7
AS
432DECLARE_PER_CPU(int, bpf_prog_active);
433
f66e448c
CF
434extern const struct file_operations bpf_map_fops;
435extern const struct file_operations bpf_prog_fops;
436
7de16e3a
JK
437#define BPF_PROG_TYPE(_id, _name) \
438 extern const struct bpf_prog_ops _name ## _prog_ops; \
439 extern const struct bpf_verifier_ops _name ## _verifier_ops;
40077e0c
JB
440#define BPF_MAP_TYPE(_id, _ops) \
441 extern const struct bpf_map_ops _ops;
be9370a7
JB
442#include <linux/bpf_types.h>
443#undef BPF_PROG_TYPE
40077e0c 444#undef BPF_MAP_TYPE
0fc174de 445
ab3f0063 446extern const struct bpf_prog_ops bpf_offload_prog_ops;
4f9218aa
JK
447extern const struct bpf_verifier_ops tc_cls_act_analyzer_ops;
448extern const struct bpf_verifier_ops xdp_analyzer_ops;
449
0fc174de 450struct bpf_prog *bpf_prog_get(u32 ufd);
248f346f 451struct bpf_prog *bpf_prog_get_type_dev(u32 ufd, enum bpf_prog_type type,
288b3de5 452 bool attach_drv);
6d67942d 453struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog, int i);
c540594f 454void bpf_prog_sub(struct bpf_prog *prog, int i);
6d67942d 455struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog);
a6f6df69 456struct bpf_prog * __must_check bpf_prog_inc_not_zero(struct bpf_prog *prog);
61e021f3 457void bpf_prog_put(struct bpf_prog *prog);
5ccb071e
DB
458int __bpf_prog_charge(struct user_struct *user, u32 pages);
459void __bpf_prog_uncharge(struct user_struct *user, u32 pages);
61e021f3 460
ad8ad79f 461void bpf_prog_free_id(struct bpf_prog *prog, bool do_idr_lock);
a3884572 462void bpf_map_free_id(struct bpf_map *map, bool do_idr_lock);
ad8ad79f 463
c9da161c 464struct bpf_map *bpf_map_get_with_uref(u32 ufd);
c2101297 465struct bpf_map *__bpf_map_get(struct fd f);
6d67942d 466struct bpf_map * __must_check bpf_map_inc(struct bpf_map *map, bool uref);
c9da161c 467void bpf_map_put_with_uref(struct bpf_map *map);
61e021f3 468void bpf_map_put(struct bpf_map *map);
6c905981 469int bpf_map_precharge_memlock(u32 pages);
0a4c58f5
RG
470int bpf_map_charge_memlock(struct bpf_map *map, u32 pages);
471void bpf_map_uncharge_memlock(struct bpf_map *map, u32 pages);
96eabe7a 472void *bpf_map_area_alloc(size_t size, int numa_node);
d407bd25 473void bpf_map_area_free(void *base);
bd475643 474void bpf_map_init_from_attr(struct bpf_map *map, union bpf_attr *attr);
61e021f3 475
1be7f75d
AS
476extern int sysctl_unprivileged_bpf_disabled;
477
6e71b04a 478int bpf_map_new_fd(struct bpf_map *map, int flags);
b2197755
DB
479int bpf_prog_new_fd(struct bpf_prog *prog);
480
481int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
6e71b04a 482int bpf_obj_get_user(const char __user *pathname, int flags);
b2197755 483
15a07b33
AS
484int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value);
485int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value);
486int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
487 u64 flags);
488int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
489 u64 flags);
d056a788 490
557c0c6e 491int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value);
15a07b33 492
d056a788
DB
493int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
494 void *key, void *value, u64 map_flags);
14dc6f04 495int bpf_fd_array_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
bcc6b1b7
MKL
496int bpf_fd_htab_map_update_elem(struct bpf_map *map, struct file *map_file,
497 void *key, void *value, u64 map_flags);
14dc6f04 498int bpf_fd_htab_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
d056a788 499
6e71b04a 500int bpf_get_file_flag(int flags);
dcab51f1
MKL
501int bpf_check_uarg_tail_zero(void __user *uaddr, size_t expected_size,
502 size_t actual_size);
6e71b04a 503
15a07b33
AS
504/* memcpy that is used with 8-byte aligned pointers, power-of-8 size and
505 * forced to use 'long' read/writes to try to atomically copy long counters.
506 * Best-effort only. No barriers here, since it _will_ race with concurrent
507 * updates from BPF programs. Called from bpf syscall and mostly used with
508 * size 8 or 16 bytes, so ask compiler to inline it.
509 */
510static inline void bpf_long_memcpy(void *dst, const void *src, u32 size)
511{
512 const long *lsrc = src;
513 long *ldst = dst;
514
515 size /= sizeof(long);
516 while (size--)
517 *ldst++ = *lsrc++;
518}
519
61e021f3 520/* verify correctness of eBPF program */
9bac3d6d 521int bpf_check(struct bpf_prog **fp, union bpf_attr *attr);
1ea47e01 522void bpf_patch_call_args(struct bpf_insn *insn, u32 stack_depth);
46f55cff
JF
523
524/* Map specifics */
67f29e07 525struct xdp_buff;
6d5fc195 526struct sk_buff;
67f29e07
JDB
527
528struct bpf_dtab_netdev *__dev_map_lookup_elem(struct bpf_map *map, u32 key);
46f55cff
JF
529void __dev_map_insert_ctx(struct bpf_map *map, u32 index);
530void __dev_map_flush(struct bpf_map *map);
38edddb8
JDB
531int dev_map_enqueue(struct bpf_dtab_netdev *dst, struct xdp_buff *xdp,
532 struct net_device *dev_rx);
6d5fc195
TM
533int dev_map_generic_redirect(struct bpf_dtab_netdev *dst, struct sk_buff *skb,
534 struct bpf_prog *xdp_prog);
46f55cff 535
9c270af3
JDB
536struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key);
537void __cpu_map_insert_ctx(struct bpf_map *map, u32 index);
538void __cpu_map_flush(struct bpf_map *map);
9c270af3
JDB
539int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu, struct xdp_buff *xdp,
540 struct net_device *dev_rx);
541
96eabe7a
MKL
542/* Return map's numa specified by userspace */
543static inline int bpf_map_attr_numa_node(const union bpf_attr *attr)
544{
545 return (attr->map_flags & BPF_F_NUMA_NODE) ?
546 attr->numa_node : NUMA_NO_NODE;
547}
548
040ee692 549struct bpf_prog *bpf_prog_get_type_path(const char *name, enum bpf_prog_type type);
5dc4c4b7 550int array_map_alloc_check(union bpf_attr *attr);
040ee692 551
9c270af3 552#else /* !CONFIG_BPF_SYSCALL */
0fc174de
DB
553static inline struct bpf_prog *bpf_prog_get(u32 ufd)
554{
555 return ERR_PTR(-EOPNOTSUPP);
556}
557
248f346f
JK
558static inline struct bpf_prog *bpf_prog_get_type_dev(u32 ufd,
559 enum bpf_prog_type type,
288b3de5 560 bool attach_drv)
248f346f
JK
561{
562 return ERR_PTR(-EOPNOTSUPP);
563}
564
6d67942d
DB
565static inline struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog,
566 int i)
cc2e0b3f
BB
567{
568 return ERR_PTR(-EOPNOTSUPP);
569}
113214be 570
c540594f
DB
571static inline void bpf_prog_sub(struct bpf_prog *prog, int i)
572{
573}
574
0fc174de
DB
575static inline void bpf_prog_put(struct bpf_prog *prog)
576{
577}
6d67942d
DB
578
579static inline struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog)
aa6a5f3c
AS
580{
581 return ERR_PTR(-EOPNOTSUPP);
582}
5ccb071e 583
a6f6df69
JF
584static inline struct bpf_prog *__must_check
585bpf_prog_inc_not_zero(struct bpf_prog *prog)
586{
587 return ERR_PTR(-EOPNOTSUPP);
588}
589
5ccb071e
DB
590static inline int __bpf_prog_charge(struct user_struct *user, u32 pages)
591{
592 return 0;
593}
594
595static inline void __bpf_prog_uncharge(struct user_struct *user, u32 pages)
596{
597}
46f55cff 598
6e71b04a 599static inline int bpf_obj_get_user(const char __user *pathname, int flags)
98589a09
SL
600{
601 return -EOPNOTSUPP;
602}
603
46f55cff
JF
604static inline struct net_device *__dev_map_lookup_elem(struct bpf_map *map,
605 u32 key)
606{
607 return NULL;
608}
609
610static inline void __dev_map_insert_ctx(struct bpf_map *map, u32 index)
611{
612}
613
614static inline void __dev_map_flush(struct bpf_map *map)
615{
616}
9c270af3 617
67f29e07
JDB
618struct xdp_buff;
619struct bpf_dtab_netdev;
620
621static inline
38edddb8
JDB
622int dev_map_enqueue(struct bpf_dtab_netdev *dst, struct xdp_buff *xdp,
623 struct net_device *dev_rx)
67f29e07
JDB
624{
625 return 0;
626}
627
6d5fc195
TM
628struct sk_buff;
629
630static inline int dev_map_generic_redirect(struct bpf_dtab_netdev *dst,
631 struct sk_buff *skb,
632 struct bpf_prog *xdp_prog)
633{
634 return 0;
635}
636
9c270af3
JDB
637static inline
638struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key)
639{
640 return NULL;
641}
642
643static inline void __cpu_map_insert_ctx(struct bpf_map *map, u32 index)
644{
645}
646
647static inline void __cpu_map_flush(struct bpf_map *map)
648{
649}
650
9c270af3
JDB
651static inline int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu,
652 struct xdp_buff *xdp,
653 struct net_device *dev_rx)
654{
655 return 0;
656}
040ee692
AV
657
658static inline struct bpf_prog *bpf_prog_get_type_path(const char *name,
659 enum bpf_prog_type type)
660{
661 return ERR_PTR(-EOPNOTSUPP);
662}
61e021f3 663#endif /* CONFIG_BPF_SYSCALL */
09756af4 664
479321e9
JK
665static inline struct bpf_prog *bpf_prog_get_type(u32 ufd,
666 enum bpf_prog_type type)
667{
668 return bpf_prog_get_type_dev(ufd, type, false);
669}
670
040ee692
AV
671bool bpf_prog_get_ok(struct bpf_prog *, enum bpf_prog_type *, bool);
672
ab3f0063
JK
673int bpf_prog_offload_compile(struct bpf_prog *prog);
674void bpf_prog_offload_destroy(struct bpf_prog *prog);
675fc275
JK
675int bpf_prog_offload_info_fill(struct bpf_prog_info *info,
676 struct bpf_prog *prog);
ab3f0063 677
52775b33
JK
678int bpf_map_offload_info_fill(struct bpf_map_info *info, struct bpf_map *map);
679
a3884572
JK
680int bpf_map_offload_lookup_elem(struct bpf_map *map, void *key, void *value);
681int bpf_map_offload_update_elem(struct bpf_map *map,
682 void *key, void *value, u64 flags);
683int bpf_map_offload_delete_elem(struct bpf_map *map, void *key);
684int bpf_map_offload_get_next_key(struct bpf_map *map,
685 void *key, void *next_key);
686
09728266 687bool bpf_offload_prog_map_match(struct bpf_prog *prog, struct bpf_map *map);
a3884572 688
602144c2
JK
689struct bpf_offload_dev *bpf_offload_dev_create(void);
690void bpf_offload_dev_destroy(struct bpf_offload_dev *offdev);
691int bpf_offload_dev_netdev_register(struct bpf_offload_dev *offdev,
692 struct net_device *netdev);
693void bpf_offload_dev_netdev_unregister(struct bpf_offload_dev *offdev,
694 struct net_device *netdev);
fd4f227d 695bool bpf_offload_dev_match(struct bpf_prog *prog, struct net_device *netdev);
9fd7c555 696
ab3f0063
JK
697#if defined(CONFIG_NET) && defined(CONFIG_BPF_SYSCALL)
698int bpf_prog_offload_init(struct bpf_prog *prog, union bpf_attr *attr);
699
0d830032 700static inline bool bpf_prog_is_dev_bound(const struct bpf_prog_aux *aux)
ab3f0063 701{
9a18eedb 702 return aux->offload_requested;
ab3f0063 703}
a3884572
JK
704
705static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
706{
707 return unlikely(map->ops == &bpf_map_offload_ops);
708}
709
710struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr);
711void bpf_map_offload_map_free(struct bpf_map *map);
ab3f0063
JK
712#else
713static inline int bpf_prog_offload_init(struct bpf_prog *prog,
714 union bpf_attr *attr)
715{
716 return -EOPNOTSUPP;
717}
718
719static inline bool bpf_prog_is_dev_bound(struct bpf_prog_aux *aux)
720{
721 return false;
722}
a3884572
JK
723
724static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
725{
726 return false;
727}
728
729static inline struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr)
730{
731 return ERR_PTR(-EOPNOTSUPP);
732}
733
734static inline void bpf_map_offload_map_free(struct bpf_map *map)
735{
736}
ab3f0063
JK
737#endif /* CONFIG_NET && CONFIG_BPF_SYSCALL */
738
5f103c5d 739#if defined(CONFIG_STREAM_PARSER) && defined(CONFIG_BPF_SYSCALL) && defined(CONFIG_INET)
6bdc9c4c 740struct sock *__sock_map_lookup_elem(struct bpf_map *map, u32 key);
81110384 741struct sock *__sock_hash_lookup_elem(struct bpf_map *map, void *key);
5a67da2a 742int sock_map_prog(struct bpf_map *map, struct bpf_prog *prog, u32 type);
fdb5c453
SY
743int sockmap_get_from_fd(const union bpf_attr *attr, int type,
744 struct bpf_prog *prog);
6bdc9c4c
JF
745#else
746static inline struct sock *__sock_map_lookup_elem(struct bpf_map *map, u32 key)
747{
748 return NULL;
749}
464bc0fd 750
81110384
JF
751static inline struct sock *__sock_hash_lookup_elem(struct bpf_map *map,
752 void *key)
753{
754 return NULL;
755}
756
5a67da2a
JF
757static inline int sock_map_prog(struct bpf_map *map,
758 struct bpf_prog *prog,
759 u32 type)
464bc0fd
JF
760{
761 return -EOPNOTSUPP;
762}
fdb5c453
SY
763
764static inline int sockmap_get_from_fd(const union bpf_attr *attr, int type,
765 struct bpf_prog *prog)
766{
767 return -EINVAL;
768}
6bdc9c4c
JF
769#endif
770
fbfc504a
BT
771#if defined(CONFIG_XDP_SOCKETS)
772struct xdp_sock;
773struct xdp_sock *__xsk_map_lookup_elem(struct bpf_map *map, u32 key);
774int __xsk_map_redirect(struct bpf_map *map, struct xdp_buff *xdp,
775 struct xdp_sock *xs);
776void __xsk_map_flush(struct bpf_map *map);
777#else
778struct xdp_sock;
779static inline struct xdp_sock *__xsk_map_lookup_elem(struct bpf_map *map,
780 u32 key)
781{
782 return NULL;
783}
784
785static inline int __xsk_map_redirect(struct bpf_map *map, struct xdp_buff *xdp,
786 struct xdp_sock *xs)
787{
788 return -EOPNOTSUPP;
789}
790
791static inline void __xsk_map_flush(struct bpf_map *map)
792{
793}
794#endif
795
5dc4c4b7
MKL
796#if defined(CONFIG_INET) && defined(CONFIG_BPF_SYSCALL)
797void bpf_sk_reuseport_detach(struct sock *sk);
798int bpf_fd_reuseport_array_lookup_elem(struct bpf_map *map, void *key,
799 void *value);
800int bpf_fd_reuseport_array_update_elem(struct bpf_map *map, void *key,
801 void *value, u64 map_flags);
802#else
803static inline void bpf_sk_reuseport_detach(struct sock *sk)
804{
805}
806
807#ifdef CONFIG_BPF_SYSCALL
808static inline int bpf_fd_reuseport_array_lookup_elem(struct bpf_map *map,
809 void *key, void *value)
810{
811 return -EOPNOTSUPP;
812}
813
814static inline int bpf_fd_reuseport_array_update_elem(struct bpf_map *map,
815 void *key, void *value,
816 u64 map_flags)
817{
818 return -EOPNOTSUPP;
819}
820#endif /* CONFIG_BPF_SYSCALL */
821#endif /* defined(CONFIG_INET) && defined(CONFIG_BPF_SYSCALL) */
822
d0003ec0 823/* verifier prototypes for helper functions called from eBPF programs */
a2c83fff
DB
824extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
825extern const struct bpf_func_proto bpf_map_update_elem_proto;
826extern const struct bpf_func_proto bpf_map_delete_elem_proto;
d0003ec0 827
03e69b50 828extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
c04167ce 829extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
2d0e30c3 830extern const struct bpf_func_proto bpf_get_numa_node_id_proto;
04fd61ab 831extern const struct bpf_func_proto bpf_tail_call_proto;
17ca8cbf 832extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
ffeedafb
AS
833extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
834extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
835extern const struct bpf_func_proto bpf_get_current_comm_proto;
d5a3b1f6 836extern const struct bpf_func_proto bpf_get_stackid_proto;
c195651e 837extern const struct bpf_func_proto bpf_get_stack_proto;
174a79ff 838extern const struct bpf_func_proto bpf_sock_map_update_proto;
81110384 839extern const struct bpf_func_proto bpf_sock_hash_update_proto;
bf6fa2c8 840extern const struct bpf_func_proto bpf_get_current_cgroup_id_proto;
03e69b50 841
cd339431
RG
842extern const struct bpf_func_proto bpf_get_local_storage_proto;
843
3ad00405
DB
844/* Shared helpers among cBPF and eBPF. */
845void bpf_user_rnd_init_once(void);
846u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
847
c64b7983
JS
848#if defined(CONFIG_NET)
849bool bpf_sock_is_valid_access(int off, int size, enum bpf_access_type type,
850 struct bpf_insn_access_aux *info);
851u32 bpf_sock_convert_ctx_access(enum bpf_access_type type,
852 const struct bpf_insn *si,
853 struct bpf_insn *insn_buf,
854 struct bpf_prog *prog,
855 u32 *target_size);
856#else
857static inline bool bpf_sock_is_valid_access(int off, int size,
858 enum bpf_access_type type,
859 struct bpf_insn_access_aux *info)
860{
861 return false;
862}
863static inline u32 bpf_sock_convert_ctx_access(enum bpf_access_type type,
864 const struct bpf_insn *si,
865 struct bpf_insn *insn_buf,
866 struct bpf_prog *prog,
867 u32 *target_size)
868{
869 return 0;
870}
871#endif
872
99c55f7d 873#endif /* _LINUX_BPF_H */