blob: 025b1c2f80532e32c5c12c53c55dfab0f07c8cb4 [file] [log] [blame]
Alexei Starovoitov99c55f72014-09-26 00:16:57 -07001/* 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>
Daniel Borkmann74451e662017-02-16 22:24:50 +010011
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070012#include <linux/workqueue.h>
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -070013#include <linux/file.h>
Alexei Starovoitovb121d1e2016-03-07 21:57:13 -080014#include <linux/percpu.h>
Zi Shen Lim002245c2016-06-08 21:18:47 -070015#include <linux/err.h>
Daniel Borkmann74451e662017-02-16 22:24:50 +010016#include <linux/rbtree_latch.h>
David S. Millerd6e1e462017-08-19 23:34:03 -070017#include <linux/numa.h>
Jakub Kicinskiab3f0062017-11-03 13:56:17 -070018#include <linux/wait.h>
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070019
Jakub Kicinskicae19272017-12-27 18:39:05 -080020struct bpf_verifier_env;
Daniel Borkmann3b1efb12016-06-15 22:47:14 +020021struct perf_event;
John Fastabend174a79f2017-08-15 22:32:47 -070022struct bpf_prog;
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070023struct bpf_map;
24
25/* map is generic key/value storage optionally accesible by eBPF programs */
26struct bpf_map_ops {
27 /* funcs callable from userspace (via syscall) */
Jakub Kicinski1110f3a2018-01-11 20:29:03 -080028 int (*map_alloc_check)(union bpf_attr *attr);
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070029 struct bpf_map *(*map_alloc)(union bpf_attr *attr);
Daniel Borkmann61d1b6a2016-06-15 22:47:12 +020030 void (*map_release)(struct bpf_map *map, struct file *map_file);
31 void (*map_free)(struct bpf_map *map);
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -070032 int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key);
33
34 /* funcs callable from userspace and from eBPF programs */
35 void *(*map_lookup_elem)(struct bpf_map *map, void *key);
Alexei Starovoitov3274f522014-11-13 17:36:44 -080036 int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags);
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -070037 int (*map_delete_elem)(struct bpf_map *map, void *key);
Wang Nan2a36f0b2015-08-06 07:02:33 +000038
39 /* funcs called by prog_array and perf_event_array map */
Daniel Borkmannd056a782016-06-15 22:47:13 +020040 void *(*map_fd_get_ptr)(struct bpf_map *map, struct file *map_file,
41 int fd);
42 void (*map_fd_put_ptr)(void *ptr);
Alexei Starovoitov81ed18a2017-03-15 18:26:42 -070043 u32 (*map_gen_lookup)(struct bpf_map *map, struct bpf_insn *insn_buf);
Martin KaFai Lau14dc6f02017-06-27 23:08:34 -070044 u32 (*map_fd_sys_lookup_elem)(void *ptr);
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070045};
46
47struct bpf_map {
Daniel Borkmannbe95a842018-01-09 13:17:44 +010048 /* 1st cacheline with read-mostly members of which some
49 * are also accessed in fast-path (e.g. ops, max_entries).
50 */
51 const struct bpf_map_ops *ops ____cacheline_aligned;
52 struct bpf_map *inner_map_meta;
53#ifdef CONFIG_SECURITY
54 void *security;
55#endif
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070056 enum bpf_map_type map_type;
57 u32 key_size;
58 u32 value_size;
59 u32 max_entries;
Alexei Starovoitov6c905982016-03-07 21:57:15 -080060 u32 map_flags;
Alexei Starovoitovaaac3ba2015-10-07 22:23:22 -070061 u32 pages;
Martin KaFai Lauf3f1c052017-06-05 12:15:47 -070062 u32 id;
Martin KaFai Lau96eabe72017-08-18 11:28:00 -070063 int numa_node;
Alexei Starovoitovb2157392018-01-07 17:33:02 -080064 bool unpriv_array;
Daniel Borkmannbe95a842018-01-09 13:17:44 +010065 /* 7 bytes hole */
66
67 /* 2nd cacheline with misc members to avoid false sharing
68 * particularly with refcounting.
69 */
70 struct user_struct *user ____cacheline_aligned;
71 atomic_t refcnt;
Daniel Borkmannc9da1612015-11-24 21:28:15 +010072 atomic_t usercnt;
Daniel Borkmannbe95a842018-01-09 13:17:44 +010073 struct work_struct work;
Martin KaFai Lau067cae42017-10-05 21:52:12 -070074 char name[BPF_OBJ_NAME_LEN];
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070075};
76
Jakub Kicinskia3884572018-01-11 20:29:09 -080077struct bpf_offloaded_map;
78
79struct bpf_map_dev_ops {
80 int (*map_get_next_key)(struct bpf_offloaded_map *map,
81 void *key, void *next_key);
82 int (*map_lookup_elem)(struct bpf_offloaded_map *map,
83 void *key, void *value);
84 int (*map_update_elem)(struct bpf_offloaded_map *map,
85 void *key, void *value, u64 flags);
86 int (*map_delete_elem)(struct bpf_offloaded_map *map, void *key);
87};
88
89struct bpf_offloaded_map {
90 struct bpf_map map;
91 struct net_device *netdev;
92 const struct bpf_map_dev_ops *dev_ops;
93 void *dev_priv;
94 struct list_head offloads;
95};
96
97static inline struct bpf_offloaded_map *map_to_offmap(struct bpf_map *map)
98{
99 return container_of(map, struct bpf_offloaded_map, map);
100}
101
102extern const struct bpf_map_ops bpf_map_offload_ops;
103
Alexei Starovoitov17a52672014-09-26 00:17:06 -0700104/* function argument constraints */
105enum bpf_arg_type {
Daniel Borkmann80f1d682015-03-12 17:21:42 +0100106 ARG_DONTCARE = 0, /* unused argument in helper function */
Alexei Starovoitov17a52672014-09-26 00:17:06 -0700107
108 /* the following constraints used to prototype
109 * bpf_map_lookup/update/delete_elem() functions
110 */
111 ARG_CONST_MAP_PTR, /* const argument used as pointer to bpf_map */
112 ARG_PTR_TO_MAP_KEY, /* pointer to stack used as map key */
113 ARG_PTR_TO_MAP_VALUE, /* pointer to stack used as map value */
114
115 /* the following constraints used to prototype bpf_memcmp() and other
116 * functions that access data on eBPF program stack
117 */
Alexei Starovoitov39f19ebb2017-01-09 10:19:50 -0800118 ARG_PTR_TO_MEM, /* pointer to valid memory (stack, packet, map value) */
Gianluca Borellodb1ac492017-11-22 18:32:53 +0000119 ARG_PTR_TO_MEM_OR_NULL, /* pointer to valid memory or NULL */
Alexei Starovoitov39f19ebb2017-01-09 10:19:50 -0800120 ARG_PTR_TO_UNINIT_MEM, /* pointer to memory does not need to be initialized,
121 * helper function must fill all bytes or clear
122 * them in error case.
Daniel Borkmann435faee12016-04-13 00:10:51 +0200123 */
124
Alexei Starovoitov39f19ebb2017-01-09 10:19:50 -0800125 ARG_CONST_SIZE, /* number of bytes accessed from memory */
126 ARG_CONST_SIZE_OR_ZERO, /* number of bytes accessed from memory or 0 */
Daniel Borkmann80f1d682015-03-12 17:21:42 +0100127
Alexei Starovoitov608cd712015-03-26 19:53:57 -0700128 ARG_PTR_TO_CTX, /* pointer to context */
Daniel Borkmann80f1d682015-03-12 17:21:42 +0100129 ARG_ANYTHING, /* any (initialized) argument is ok */
Alexei Starovoitov17a52672014-09-26 00:17:06 -0700130};
131
132/* type of values returned from helper functions */
133enum bpf_return_type {
134 RET_INTEGER, /* function returns integer */
135 RET_VOID, /* function doesn't return anything */
136 RET_PTR_TO_MAP_VALUE_OR_NULL, /* returns a pointer to map elem value or NULL */
137};
138
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700139/* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
140 * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
141 * instructions after verifying
142 */
143struct bpf_func_proto {
144 u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
145 bool gpl_only;
Daniel Borkmann36bbef52016-09-20 00:26:13 +0200146 bool pkt_access;
Alexei Starovoitov17a52672014-09-26 00:17:06 -0700147 enum bpf_return_type ret_type;
148 enum bpf_arg_type arg1_type;
149 enum bpf_arg_type arg2_type;
150 enum bpf_arg_type arg3_type;
151 enum bpf_arg_type arg4_type;
152 enum bpf_arg_type arg5_type;
153};
154
155/* bpf_context is intentionally undefined structure. Pointer to bpf_context is
156 * the first argument to eBPF programs.
157 * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
158 */
159struct bpf_context;
160
161enum bpf_access_type {
162 BPF_READ = 1,
163 BPF_WRITE = 2
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700164};
165
Alexei Starovoitov19de99f2016-06-15 18:25:38 -0700166/* types of values stored in eBPF registers */
Edward Creef1174f72017-08-07 15:26:19 +0100167/* Pointer types represent:
168 * pointer
169 * pointer + imm
170 * pointer + (u16) var
171 * pointer + (u16) var + imm
172 * if (range > 0) then [ptr, ptr + range - off) is safe to access
173 * if (id > 0) means that some 'var' was added
174 * if (off > 0) means that 'imm' was added
175 */
Alexei Starovoitov19de99f2016-06-15 18:25:38 -0700176enum bpf_reg_type {
177 NOT_INIT = 0, /* nothing was written into register */
Edward Creef1174f72017-08-07 15:26:19 +0100178 SCALAR_VALUE, /* reg doesn't contain a valid pointer */
Alexei Starovoitov19de99f2016-06-15 18:25:38 -0700179 PTR_TO_CTX, /* reg points to bpf_context */
180 CONST_PTR_TO_MAP, /* reg points to struct bpf_map */
181 PTR_TO_MAP_VALUE, /* reg points to map element value */
182 PTR_TO_MAP_VALUE_OR_NULL,/* points to map elem value or NULL */
Edward Creef1174f72017-08-07 15:26:19 +0100183 PTR_TO_STACK, /* reg == frame_pointer + offset */
Daniel Borkmannde8f3a82017-09-25 02:25:51 +0200184 PTR_TO_PACKET_META, /* skb->data - meta_len */
Edward Creef1174f72017-08-07 15:26:19 +0100185 PTR_TO_PACKET, /* reg points to skb->data */
Alexei Starovoitov19de99f2016-06-15 18:25:38 -0700186 PTR_TO_PACKET_END, /* skb->data + headlen */
187};
188
Yonghong Song23994632017-06-22 15:07:39 -0700189/* The information passed from prog-specific *_is_valid_access
190 * back to the verifier.
191 */
192struct bpf_insn_access_aux {
193 enum bpf_reg_type reg_type;
194 int ctx_field_size;
Yonghong Song23994632017-06-22 15:07:39 -0700195};
196
Daniel Borkmannf96da092017-07-02 02:13:27 +0200197static inline void
198bpf_ctx_record_field_size(struct bpf_insn_access_aux *aux, u32 size)
199{
200 aux->ctx_field_size = size;
201}
202
Jakub Kicinski7de16e32017-10-16 16:40:53 -0700203struct bpf_prog_ops {
204 int (*test_run)(struct bpf_prog *prog, const union bpf_attr *kattr,
205 union bpf_attr __user *uattr);
206};
207
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700208struct bpf_verifier_ops {
209 /* return eBPF function prototype for verification */
210 const struct bpf_func_proto *(*get_func_proto)(enum bpf_func_id func_id);
Alexei Starovoitov17a52672014-09-26 00:17:06 -0700211
212 /* return true if 'size' wide access at offset 'off' within bpf_context
213 * with 'type' (read or write) is allowed
214 */
Alexei Starovoitov19de99f2016-06-15 18:25:38 -0700215 bool (*is_valid_access)(int off, int size, enum bpf_access_type type,
Yonghong Song23994632017-06-22 15:07:39 -0700216 struct bpf_insn_access_aux *info);
Daniel Borkmann36bbef52016-09-20 00:26:13 +0200217 int (*gen_prologue)(struct bpf_insn *insn, bool direct_write,
218 const struct bpf_prog *prog);
Daniel Borkmann6b8cc1d2017-01-12 11:51:32 +0100219 u32 (*convert_ctx_access)(enum bpf_access_type type,
220 const struct bpf_insn *src,
221 struct bpf_insn *dst,
Daniel Borkmannf96da092017-07-02 02:13:27 +0200222 struct bpf_prog *prog, u32 *target_size);
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700223};
224
Jakub Kicinskicae19272017-12-27 18:39:05 -0800225struct bpf_prog_offload_ops {
226 int (*insn_hook)(struct bpf_verifier_env *env,
227 int insn_idx, int prev_insn_idx);
228};
229
Jakub Kicinski0a9c1992018-01-11 20:29:07 -0800230struct bpf_prog_offload {
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700231 struct bpf_prog *prog;
232 struct net_device *netdev;
233 void *dev_priv;
234 struct list_head offloads;
235 bool dev_state;
Jakub Kicinskicae19272017-12-27 18:39:05 -0800236 const struct bpf_prog_offload_ops *dev_ops;
Jiong Wangfcfb1262018-01-16 16:05:19 -0800237 void *jited_image;
238 u32 jited_len;
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700239};
240
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700241struct bpf_prog_aux {
242 atomic_t refcnt;
Daniel Borkmann24701ec2015-03-01 12:31:47 +0100243 u32 used_map_cnt;
Alexei Starovoitov32bbe002016-04-06 18:43:28 -0700244 u32 max_ctx_offset;
Alexei Starovoitov87266792017-05-30 13:31:29 -0700245 u32 stack_depth;
Martin KaFai Laudc4bb0e2017-06-05 12:15:46 -0700246 u32 id;
Alexei Starovoitov1c2a0882017-12-14 17:55:15 -0800247 u32 func_cnt;
Jakub Kicinski9a18eed2017-12-27 18:39:04 -0800248 bool offload_requested;
Alexei Starovoitov1c2a0882017-12-14 17:55:15 -0800249 struct bpf_prog **func;
250 void *jit_data; /* JIT specific data. arch dependent */
Daniel Borkmann74451e662017-02-16 22:24:50 +0100251 struct latch_tree_node ksym_tnode;
252 struct list_head ksym_lnode;
Jakub Kicinski7de16e32017-10-16 16:40:53 -0700253 const struct bpf_prog_ops *ops;
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700254 struct bpf_map **used_maps;
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700255 struct bpf_prog *prog;
Alexei Starovoitovaaac3ba2015-10-07 22:23:22 -0700256 struct user_struct *user;
Martin KaFai Laucb4d2b32017-09-27 14:37:52 -0700257 u64 load_time; /* ns since boottime */
Martin KaFai Lau067cae42017-10-05 21:52:12 -0700258 char name[BPF_OBJ_NAME_LEN];
Chenbo Fengafdb09c2017-10-18 13:00:24 -0700259#ifdef CONFIG_SECURITY
260 void *security;
261#endif
Jakub Kicinski0a9c1992018-01-11 20:29:07 -0800262 struct bpf_prog_offload *offload;
Alexei Starovoitovabf2e7d2015-05-28 19:26:02 -0700263 union {
264 struct work_struct work;
265 struct rcu_head rcu;
266 };
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700267};
268
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700269struct bpf_array {
270 struct bpf_map map;
271 u32 elem_size;
Alexei Starovoitovb2157392018-01-07 17:33:02 -0800272 u32 index_mask;
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700273 /* 'ownership' of prog_array is claimed by the first program that
274 * is going to use this map or by the first program which FD is stored
275 * in the map to make sure that all callers and callees have the same
276 * prog_type and JITed flag
277 */
278 enum bpf_prog_type owner_prog_type;
279 bool owner_jited;
280 union {
281 char value[0] __aligned(8);
Wang Nan2a36f0b2015-08-06 07:02:33 +0000282 void *ptrs[0] __aligned(8);
Alexei Starovoitova10423b2016-02-01 22:39:54 -0800283 void __percpu *pptrs[0] __aligned(8);
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700284 };
285};
Daniel Borkmann3b1efb12016-06-15 22:47:14 +0200286
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700287#define MAX_TAIL_CALL_CNT 32
288
Daniel Borkmann3b1efb12016-06-15 22:47:14 +0200289struct bpf_event_entry {
290 struct perf_event *event;
291 struct file *perf_file;
292 struct file *map_file;
293 struct rcu_head rcu;
294};
295
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700296bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
Daniel Borkmannf1f77142017-01-13 23:38:15 +0100297int bpf_prog_calc_tag(struct bpf_prog *fp);
Daniel Borkmannbd570ff2016-04-18 21:01:24 +0200298
Alexei Starovoitov0756ea32015-06-12 19:39:13 -0700299const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
Daniel Borkmann555c8a82016-07-14 18:08:05 +0200300
301typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src,
Daniel Borkmannaa7145c2016-07-22 01:19:42 +0200302 unsigned long off, unsigned long len);
Daniel Borkmann555c8a82016-07-14 18:08:05 +0200303
304u64 bpf_event_output(struct bpf_map *map, u64 flags, void *meta, u64 meta_size,
305 void *ctx, u64 ctx_size, bpf_ctx_copy_t ctx_copy);
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700306
Alexei Starovoitov1cf1cae2017-03-30 21:45:38 -0700307int bpf_prog_test_run_xdp(struct bpf_prog *prog, const union bpf_attr *kattr,
308 union bpf_attr __user *uattr);
309int bpf_prog_test_run_skb(struct bpf_prog *prog, const union bpf_attr *kattr,
310 union bpf_attr __user *uattr);
311
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700312/* an array of programs to be executed under rcu_lock.
313 *
314 * Typical usage:
315 * ret = BPF_PROG_RUN_ARRAY(&bpf_prog_array, ctx, BPF_PROG_RUN);
316 *
317 * the structure returned by bpf_prog_array_alloc() should be populated
318 * with program pointers and the last pointer must be NULL.
319 * The user has to keep refcnt on the program and make sure the program
320 * is removed from the array before bpf_prog_put().
321 * The 'struct bpf_prog_array *' should only be replaced with xchg()
322 * since other cpus are walking the array of pointers in parallel.
323 */
324struct bpf_prog_array {
325 struct rcu_head rcu;
326 struct bpf_prog *progs[0];
327};
328
329struct bpf_prog_array __rcu *bpf_prog_array_alloc(u32 prog_cnt, gfp_t flags);
330void bpf_prog_array_free(struct bpf_prog_array __rcu *progs);
Alexei Starovoitov468e2f62017-10-02 22:50:22 -0700331int bpf_prog_array_length(struct bpf_prog_array __rcu *progs);
332int bpf_prog_array_copy_to_user(struct bpf_prog_array __rcu *progs,
333 __u32 __user *prog_ids, u32 cnt);
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700334
Yonghong Songe87c6bc382017-10-23 23:53:08 -0700335void bpf_prog_array_delete_safe(struct bpf_prog_array __rcu *progs,
336 struct bpf_prog *old_prog);
Yonghong Songf371b302017-12-11 11:39:02 -0800337int bpf_prog_array_copy_info(struct bpf_prog_array __rcu *array,
338 __u32 __user *prog_ids, u32 request_cnt,
339 __u32 __user *prog_cnt);
Yonghong Songe87c6bc382017-10-23 23:53:08 -0700340int bpf_prog_array_copy(struct bpf_prog_array __rcu *old_array,
341 struct bpf_prog *exclude_prog,
342 struct bpf_prog *include_prog,
343 struct bpf_prog_array **new_array);
344
345#define __BPF_PROG_RUN_ARRAY(array, ctx, func, check_non_null) \
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700346 ({ \
Yonghong Songe87c6bc382017-10-23 23:53:08 -0700347 struct bpf_prog **_prog, *__prog; \
348 struct bpf_prog_array *_array; \
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700349 u32 _ret = 1; \
350 rcu_read_lock(); \
Yonghong Songe87c6bc382017-10-23 23:53:08 -0700351 _array = rcu_dereference(array); \
352 if (unlikely(check_non_null && !_array))\
353 goto _out; \
354 _prog = _array->progs; \
355 while ((__prog = READ_ONCE(*_prog))) { \
356 _ret &= func(__prog, ctx); \
357 _prog++; \
358 } \
359_out: \
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700360 rcu_read_unlock(); \
361 _ret; \
362 })
363
Yonghong Songe87c6bc382017-10-23 23:53:08 -0700364#define BPF_PROG_RUN_ARRAY(array, ctx, func) \
365 __BPF_PROG_RUN_ARRAY(array, ctx, func, false)
366
367#define BPF_PROG_RUN_ARRAY_CHECK(array, ctx, func) \
368 __BPF_PROG_RUN_ARRAY(array, ctx, func, true)
369
Alexei Starovoitov89aa0752014-12-01 15:06:35 -0800370#ifdef CONFIG_BPF_SYSCALL
Alexei Starovoitovb121d1e2016-03-07 21:57:13 -0800371DECLARE_PER_CPU(int, bpf_prog_active);
372
Chenbo Fengf66e4482017-10-18 13:00:26 -0700373extern const struct file_operations bpf_map_fops;
374extern const struct file_operations bpf_prog_fops;
375
Jakub Kicinski7de16e32017-10-16 16:40:53 -0700376#define BPF_PROG_TYPE(_id, _name) \
377 extern const struct bpf_prog_ops _name ## _prog_ops; \
378 extern const struct bpf_verifier_ops _name ## _verifier_ops;
Johannes Berg40077e02017-04-11 15:34:58 +0200379#define BPF_MAP_TYPE(_id, _ops) \
380 extern const struct bpf_map_ops _ops;
Johannes Bergbe9370a2017-04-11 15:34:57 +0200381#include <linux/bpf_types.h>
382#undef BPF_PROG_TYPE
Johannes Berg40077e02017-04-11 15:34:58 +0200383#undef BPF_MAP_TYPE
Daniel Borkmann0fc174d2015-03-01 12:31:44 +0100384
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700385extern const struct bpf_prog_ops bpf_offload_prog_ops;
Jakub Kicinski4f9218a2017-10-16 16:40:55 -0700386extern const struct bpf_verifier_ops tc_cls_act_analyzer_ops;
387extern const struct bpf_verifier_ops xdp_analyzer_ops;
388
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700389struct bpf_prog *bpf_prog_get(u32 ufd);
Jakub Kicinski248f3462017-11-03 13:56:20 -0700390struct bpf_prog *bpf_prog_get_type_dev(u32 ufd, enum bpf_prog_type type,
Jakub Kicinski288b3de52017-11-20 15:21:54 -0800391 bool attach_drv);
Daniel Borkmann6d67942dd2016-11-19 01:45:03 +0100392struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog, int i);
Daniel Borkmannc5405942016-11-09 22:02:34 +0100393void bpf_prog_sub(struct bpf_prog *prog, int i);
Daniel Borkmann6d67942dd2016-11-19 01:45:03 +0100394struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog);
John Fastabenda6f6df62017-08-15 22:32:22 -0700395struct bpf_prog * __must_check bpf_prog_inc_not_zero(struct bpf_prog *prog);
Daniel Borkmann61e021f32015-03-02 15:21:55 +0100396void bpf_prog_put(struct bpf_prog *prog);
Daniel Borkmann5ccb0712016-12-18 01:52:58 +0100397int __bpf_prog_charge(struct user_struct *user, u32 pages);
398void __bpf_prog_uncharge(struct user_struct *user, u32 pages);
Daniel Borkmann61e021f32015-03-02 15:21:55 +0100399
Jakub Kicinskiad8ad792017-12-27 18:39:07 -0800400void bpf_prog_free_id(struct bpf_prog *prog, bool do_idr_lock);
Jakub Kicinskia3884572018-01-11 20:29:09 -0800401void bpf_map_free_id(struct bpf_map *map, bool do_idr_lock);
Jakub Kicinskiad8ad792017-12-27 18:39:07 -0800402
Daniel Borkmannc9da1612015-11-24 21:28:15 +0100403struct bpf_map *bpf_map_get_with_uref(u32 ufd);
Daniel Borkmannc2101292015-10-29 14:58:07 +0100404struct bpf_map *__bpf_map_get(struct fd f);
Daniel Borkmann6d67942dd2016-11-19 01:45:03 +0100405struct bpf_map * __must_check bpf_map_inc(struct bpf_map *map, bool uref);
Daniel Borkmannc9da1612015-11-24 21:28:15 +0100406void bpf_map_put_with_uref(struct bpf_map *map);
Daniel Borkmann61e021f32015-03-02 15:21:55 +0100407void bpf_map_put(struct bpf_map *map);
Alexei Starovoitov6c905982016-03-07 21:57:15 -0800408int bpf_map_precharge_memlock(u32 pages);
Martin KaFai Lau96eabe72017-08-18 11:28:00 -0700409void *bpf_map_area_alloc(size_t size, int numa_node);
Daniel Borkmannd407bd22017-01-18 15:14:17 +0100410void bpf_map_area_free(void *base);
Jakub Kicinskibd475642018-01-11 20:29:06 -0800411void bpf_map_init_from_attr(struct bpf_map *map, union bpf_attr *attr);
Daniel Borkmann61e021f32015-03-02 15:21:55 +0100412
Alexei Starovoitov1be7f752015-10-07 22:23:21 -0700413extern int sysctl_unprivileged_bpf_disabled;
414
Chenbo Feng6e71b042017-10-18 13:00:22 -0700415int bpf_map_new_fd(struct bpf_map *map, int flags);
Daniel Borkmannb2197752015-10-29 14:58:09 +0100416int bpf_prog_new_fd(struct bpf_prog *prog);
417
418int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
Chenbo Feng6e71b042017-10-18 13:00:22 -0700419int bpf_obj_get_user(const char __user *pathname, int flags);
Daniel Borkmannb2197752015-10-29 14:58:09 +0100420
Alexei Starovoitov15a07b32016-02-01 22:39:55 -0800421int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value);
422int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value);
423int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
424 u64 flags);
425int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
426 u64 flags);
Daniel Borkmannd056a782016-06-15 22:47:13 +0200427
Alexei Starovoitov557c0c62016-03-07 21:57:17 -0800428int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value);
Alexei Starovoitov15a07b32016-02-01 22:39:55 -0800429
Daniel Borkmannd056a782016-06-15 22:47:13 +0200430int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
431 void *key, void *value, u64 map_flags);
Martin KaFai Lau14dc6f02017-06-27 23:08:34 -0700432int bpf_fd_array_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
Daniel Borkmannd056a782016-06-15 22:47:13 +0200433void bpf_fd_array_map_clear(struct bpf_map *map);
Martin KaFai Laubcc6b1b2017-03-22 10:00:34 -0700434int bpf_fd_htab_map_update_elem(struct bpf_map *map, struct file *map_file,
435 void *key, void *value, u64 map_flags);
Martin KaFai Lau14dc6f02017-06-27 23:08:34 -0700436int bpf_fd_htab_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
Daniel Borkmannd056a782016-06-15 22:47:13 +0200437
Chenbo Feng6e71b042017-10-18 13:00:22 -0700438int bpf_get_file_flag(int flags);
439
Alexei Starovoitov15a07b32016-02-01 22:39:55 -0800440/* memcpy that is used with 8-byte aligned pointers, power-of-8 size and
441 * forced to use 'long' read/writes to try to atomically copy long counters.
442 * Best-effort only. No barriers here, since it _will_ race with concurrent
443 * updates from BPF programs. Called from bpf syscall and mostly used with
444 * size 8 or 16 bytes, so ask compiler to inline it.
445 */
446static inline void bpf_long_memcpy(void *dst, const void *src, u32 size)
447{
448 const long *lsrc = src;
449 long *ldst = dst;
450
451 size /= sizeof(long);
452 while (size--)
453 *ldst++ = *lsrc++;
454}
455
Daniel Borkmann61e021f32015-03-02 15:21:55 +0100456/* verify correctness of eBPF program */
Alexei Starovoitov9bac3d62015-03-13 11:57:42 -0700457int bpf_check(struct bpf_prog **fp, union bpf_attr *attr);
Alexei Starovoitov1ea47e02017-12-14 17:55:13 -0800458void bpf_patch_call_args(struct bpf_insn *insn, u32 stack_depth);
John Fastabend46f55cf2017-07-17 21:56:48 -0700459
460/* Map specifics */
461struct net_device *__dev_map_lookup_elem(struct bpf_map *map, u32 key);
462void __dev_map_insert_ctx(struct bpf_map *map, u32 index);
463void __dev_map_flush(struct bpf_map *map);
464
Jesper Dangaard Brouer9c270af2017-10-16 12:19:34 +0200465struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key);
466void __cpu_map_insert_ctx(struct bpf_map *map, u32 index);
467void __cpu_map_flush(struct bpf_map *map);
468struct xdp_buff;
469int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu, struct xdp_buff *xdp,
470 struct net_device *dev_rx);
471
Martin KaFai Lau96eabe72017-08-18 11:28:00 -0700472/* Return map's numa specified by userspace */
473static inline int bpf_map_attr_numa_node(const union bpf_attr *attr)
474{
475 return (attr->map_flags & BPF_F_NUMA_NODE) ?
476 attr->numa_node : NUMA_NO_NODE;
477}
478
Al Viro040ee692017-12-02 20:20:38 -0500479struct bpf_prog *bpf_prog_get_type_path(const char *name, enum bpf_prog_type type);
480
Jesper Dangaard Brouer9c270af2017-10-16 12:19:34 +0200481#else /* !CONFIG_BPF_SYSCALL */
Daniel Borkmann0fc174d2015-03-01 12:31:44 +0100482static inline struct bpf_prog *bpf_prog_get(u32 ufd)
483{
484 return ERR_PTR(-EOPNOTSUPP);
485}
486
Jakub Kicinski248f3462017-11-03 13:56:20 -0700487static inline struct bpf_prog *bpf_prog_get_type_dev(u32 ufd,
488 enum bpf_prog_type type,
Jakub Kicinski288b3de52017-11-20 15:21:54 -0800489 bool attach_drv)
Jakub Kicinski248f3462017-11-03 13:56:20 -0700490{
491 return ERR_PTR(-EOPNOTSUPP);
492}
493
Daniel Borkmann6d67942dd2016-11-19 01:45:03 +0100494static inline struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog,
495 int i)
Brenden Blancocc2e0b32016-07-20 07:55:52 -0700496{
497 return ERR_PTR(-EOPNOTSUPP);
498}
Daniel Borkmann113214b2016-06-30 17:24:44 +0200499
Daniel Borkmannc5405942016-11-09 22:02:34 +0100500static inline void bpf_prog_sub(struct bpf_prog *prog, int i)
501{
502}
503
Daniel Borkmann0fc174d2015-03-01 12:31:44 +0100504static inline void bpf_prog_put(struct bpf_prog *prog)
505{
506}
Daniel Borkmann6d67942dd2016-11-19 01:45:03 +0100507
508static inline struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog)
Alexei Starovoitovaa6a5f32016-09-01 18:37:24 -0700509{
510 return ERR_PTR(-EOPNOTSUPP);
511}
Daniel Borkmann5ccb0712016-12-18 01:52:58 +0100512
John Fastabenda6f6df62017-08-15 22:32:22 -0700513static inline struct bpf_prog *__must_check
514bpf_prog_inc_not_zero(struct bpf_prog *prog)
515{
516 return ERR_PTR(-EOPNOTSUPP);
517}
518
Daniel Borkmann5ccb0712016-12-18 01:52:58 +0100519static inline int __bpf_prog_charge(struct user_struct *user, u32 pages)
520{
521 return 0;
522}
523
524static inline void __bpf_prog_uncharge(struct user_struct *user, u32 pages)
525{
526}
John Fastabend46f55cf2017-07-17 21:56:48 -0700527
Chenbo Feng6e71b042017-10-18 13:00:22 -0700528static inline int bpf_obj_get_user(const char __user *pathname, int flags)
Shmulik Ladkani98589a02017-10-09 15:27:15 +0300529{
530 return -EOPNOTSUPP;
531}
532
John Fastabend46f55cf2017-07-17 21:56:48 -0700533static inline struct net_device *__dev_map_lookup_elem(struct bpf_map *map,
534 u32 key)
535{
536 return NULL;
537}
538
539static inline void __dev_map_insert_ctx(struct bpf_map *map, u32 index)
540{
541}
542
543static inline void __dev_map_flush(struct bpf_map *map)
544{
545}
Jesper Dangaard Brouer9c270af2017-10-16 12:19:34 +0200546
547static inline
548struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key)
549{
550 return NULL;
551}
552
553static inline void __cpu_map_insert_ctx(struct bpf_map *map, u32 index)
554{
555}
556
557static inline void __cpu_map_flush(struct bpf_map *map)
558{
559}
560
561struct xdp_buff;
562static inline int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu,
563 struct xdp_buff *xdp,
564 struct net_device *dev_rx)
565{
566 return 0;
567}
Al Viro040ee692017-12-02 20:20:38 -0500568
569static inline struct bpf_prog *bpf_prog_get_type_path(const char *name,
570 enum bpf_prog_type type)
571{
572 return ERR_PTR(-EOPNOTSUPP);
573}
Daniel Borkmann61e021f32015-03-02 15:21:55 +0100574#endif /* CONFIG_BPF_SYSCALL */
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700575
Jakub Kicinski479321e2017-11-20 15:21:56 -0800576static inline struct bpf_prog *bpf_prog_get_type(u32 ufd,
577 enum bpf_prog_type type)
578{
579 return bpf_prog_get_type_dev(ufd, type, false);
580}
581
Al Viro040ee692017-12-02 20:20:38 -0500582bool bpf_prog_get_ok(struct bpf_prog *, enum bpf_prog_type *, bool);
583
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700584int bpf_prog_offload_compile(struct bpf_prog *prog);
585void bpf_prog_offload_destroy(struct bpf_prog *prog);
Jakub Kicinski675fc272017-12-27 18:39:09 -0800586int bpf_prog_offload_info_fill(struct bpf_prog_info *info,
587 struct bpf_prog *prog);
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700588
Jakub Kicinskia3884572018-01-11 20:29:09 -0800589int bpf_map_offload_lookup_elem(struct bpf_map *map, void *key, void *value);
590int bpf_map_offload_update_elem(struct bpf_map *map,
591 void *key, void *value, u64 flags);
592int bpf_map_offload_delete_elem(struct bpf_map *map, void *key);
593int bpf_map_offload_get_next_key(struct bpf_map *map,
594 void *key, void *next_key);
595
596bool bpf_offload_dev_match(struct bpf_prog *prog, struct bpf_map *map);
597
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700598#if defined(CONFIG_NET) && defined(CONFIG_BPF_SYSCALL)
599int bpf_prog_offload_init(struct bpf_prog *prog, union bpf_attr *attr);
600
601static inline bool bpf_prog_is_dev_bound(struct bpf_prog_aux *aux)
602{
Jakub Kicinski9a18eed2017-12-27 18:39:04 -0800603 return aux->offload_requested;
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700604}
Jakub Kicinskia3884572018-01-11 20:29:09 -0800605
606static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
607{
608 return unlikely(map->ops == &bpf_map_offload_ops);
609}
610
611struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr);
612void bpf_map_offload_map_free(struct bpf_map *map);
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700613#else
614static inline int bpf_prog_offload_init(struct bpf_prog *prog,
615 union bpf_attr *attr)
616{
617 return -EOPNOTSUPP;
618}
619
620static inline bool bpf_prog_is_dev_bound(struct bpf_prog_aux *aux)
621{
622 return false;
623}
Jakub Kicinskia3884572018-01-11 20:29:09 -0800624
625static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
626{
627 return false;
628}
629
630static inline struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr)
631{
632 return ERR_PTR(-EOPNOTSUPP);
633}
634
635static inline void bpf_map_offload_map_free(struct bpf_map *map)
636{
637}
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700638#endif /* CONFIG_NET && CONFIG_BPF_SYSCALL */
639
John Fastabend5f103c52018-01-03 17:57:56 -0800640#if defined(CONFIG_STREAM_PARSER) && defined(CONFIG_BPF_SYSCALL) && defined(CONFIG_INET)
John Fastabend6bdc9c42017-08-16 15:02:32 -0700641struct sock *__sock_map_lookup_elem(struct bpf_map *map, u32 key);
John Fastabend5a67da22017-09-08 14:00:49 -0700642int sock_map_prog(struct bpf_map *map, struct bpf_prog *prog, u32 type);
John Fastabend6bdc9c42017-08-16 15:02:32 -0700643#else
644static inline struct sock *__sock_map_lookup_elem(struct bpf_map *map, u32 key)
645{
646 return NULL;
647}
John Fastabend464bc0f2017-08-28 07:10:04 -0700648
John Fastabend5a67da22017-09-08 14:00:49 -0700649static inline int sock_map_prog(struct bpf_map *map,
650 struct bpf_prog *prog,
651 u32 type)
John Fastabend464bc0f2017-08-28 07:10:04 -0700652{
653 return -EOPNOTSUPP;
654}
John Fastabend6bdc9c42017-08-16 15:02:32 -0700655#endif
656
Alexei Starovoitovd0003ec2014-11-13 17:36:49 -0800657/* verifier prototypes for helper functions called from eBPF programs */
Daniel Borkmanna2c83ff2015-03-01 12:31:42 +0100658extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
659extern const struct bpf_func_proto bpf_map_update_elem_proto;
660extern const struct bpf_func_proto bpf_map_delete_elem_proto;
Alexei Starovoitovd0003ec2014-11-13 17:36:49 -0800661
Daniel Borkmann03e69b52015-03-14 02:27:16 +0100662extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
Daniel Borkmannc04167c2015-03-14 02:27:17 +0100663extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
Daniel Borkmann2d0e30c2016-10-21 12:46:33 +0200664extern const struct bpf_func_proto bpf_get_numa_node_id_proto;
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700665extern const struct bpf_func_proto bpf_tail_call_proto;
Daniel Borkmann17ca8cb2015-05-29 23:23:06 +0200666extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
Alexei Starovoitovffeedaf2015-06-12 19:39:12 -0700667extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
668extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
669extern const struct bpf_func_proto bpf_get_current_comm_proto;
Alexei Starovoitov4e10df92015-07-20 20:34:18 -0700670extern const struct bpf_func_proto bpf_skb_vlan_push_proto;
671extern const struct bpf_func_proto bpf_skb_vlan_pop_proto;
Alexei Starovoitovd5a3b1f2016-02-17 19:58:58 -0800672extern const struct bpf_func_proto bpf_get_stackid_proto;
John Fastabend174a79f2017-08-15 22:32:47 -0700673extern const struct bpf_func_proto bpf_sock_map_update_proto;
Daniel Borkmann03e69b52015-03-14 02:27:16 +0100674
Daniel Borkmann3ad00402015-10-08 01:20:39 +0200675/* Shared helpers among cBPF and eBPF. */
676void bpf_user_rnd_init_once(void);
677u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
678
Alexei Starovoitov99c55f72014-09-26 00:16:57 -0700679#endif /* _LINUX_BPF_H */