blob: dc586cc64bc2544b51e99d8aeb35e6bc2d11359a [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;
John Fastabend4f738ad2018-03-18 12:57:10 -070024struct sock;
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070025
26/* map is generic key/value storage optionally accesible by eBPF programs */
27struct bpf_map_ops {
28 /* funcs callable from userspace (via syscall) */
Jakub Kicinski1110f3a2018-01-11 20:29:03 -080029 int (*map_alloc_check)(union bpf_attr *attr);
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070030 struct bpf_map *(*map_alloc)(union bpf_attr *attr);
Daniel Borkmann61d1b6a2016-06-15 22:47:12 +020031 void (*map_release)(struct bpf_map *map, struct file *map_file);
32 void (*map_free)(struct bpf_map *map);
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -070033 int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key);
34
35 /* funcs callable from userspace and from eBPF programs */
36 void *(*map_lookup_elem)(struct bpf_map *map, void *key);
Alexei Starovoitov3274f522014-11-13 17:36:44 -080037 int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags);
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -070038 int (*map_delete_elem)(struct bpf_map *map, void *key);
Wang Nan2a36f0b2015-08-06 07:02:33 +000039
40 /* funcs called by prog_array and perf_event_array map */
Daniel Borkmannd056a782016-06-15 22:47:13 +020041 void *(*map_fd_get_ptr)(struct bpf_map *map, struct file *map_file,
42 int fd);
43 void (*map_fd_put_ptr)(void *ptr);
Alexei Starovoitov81ed18a2017-03-15 18:26:42 -070044 u32 (*map_gen_lookup)(struct bpf_map *map, struct bpf_insn *insn_buf);
Martin KaFai Lau14dc6f02017-06-27 23:08:34 -070045 u32 (*map_fd_sys_lookup_elem)(void *ptr);
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070046};
47
48struct bpf_map {
Daniel Borkmannbe95a842018-01-09 13:17:44 +010049 /* 1st cacheline with read-mostly members of which some
50 * are also accessed in fast-path (e.g. ops, max_entries).
51 */
52 const struct bpf_map_ops *ops ____cacheline_aligned;
53 struct bpf_map *inner_map_meta;
54#ifdef CONFIG_SECURITY
55 void *security;
56#endif
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070057 enum bpf_map_type map_type;
58 u32 key_size;
59 u32 value_size;
60 u32 max_entries;
Alexei Starovoitov6c905982016-03-07 21:57:15 -080061 u32 map_flags;
Alexei Starovoitovaaac3ba2015-10-07 22:23:22 -070062 u32 pages;
Martin KaFai Lauf3f1c052017-06-05 12:15:47 -070063 u32 id;
Martin KaFai Lau96eabe72017-08-18 11:28:00 -070064 int numa_node;
Alexei Starovoitovb2157392018-01-07 17:33:02 -080065 bool unpriv_array;
Daniel Borkmannbe95a842018-01-09 13:17:44 +010066 /* 7 bytes hole */
67
68 /* 2nd cacheline with misc members to avoid false sharing
69 * particularly with refcounting.
70 */
71 struct user_struct *user ____cacheline_aligned;
72 atomic_t refcnt;
Daniel Borkmannc9da1612015-11-24 21:28:15 +010073 atomic_t usercnt;
Daniel Borkmannbe95a842018-01-09 13:17:44 +010074 struct work_struct work;
Martin KaFai Lau067cae42017-10-05 21:52:12 -070075 char name[BPF_OBJ_NAME_LEN];
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070076};
77
Jakub Kicinskia3884572018-01-11 20:29:09 -080078struct bpf_offloaded_map;
79
80struct bpf_map_dev_ops {
81 int (*map_get_next_key)(struct bpf_offloaded_map *map,
82 void *key, void *next_key);
83 int (*map_lookup_elem)(struct bpf_offloaded_map *map,
84 void *key, void *value);
85 int (*map_update_elem)(struct bpf_offloaded_map *map,
86 void *key, void *value, u64 flags);
87 int (*map_delete_elem)(struct bpf_offloaded_map *map, void *key);
88};
89
90struct bpf_offloaded_map {
91 struct bpf_map map;
92 struct net_device *netdev;
93 const struct bpf_map_dev_ops *dev_ops;
94 void *dev_priv;
95 struct list_head offloads;
96};
97
98static inline struct bpf_offloaded_map *map_to_offmap(struct bpf_map *map)
99{
100 return container_of(map, struct bpf_offloaded_map, map);
101}
102
103extern const struct bpf_map_ops bpf_map_offload_ops;
104
Alexei Starovoitov17a52672014-09-26 00:17:06 -0700105/* function argument constraints */
106enum bpf_arg_type {
Daniel Borkmann80f1d682015-03-12 17:21:42 +0100107 ARG_DONTCARE = 0, /* unused argument in helper function */
Alexei Starovoitov17a52672014-09-26 00:17:06 -0700108
109 /* the following constraints used to prototype
110 * bpf_map_lookup/update/delete_elem() functions
111 */
112 ARG_CONST_MAP_PTR, /* const argument used as pointer to bpf_map */
113 ARG_PTR_TO_MAP_KEY, /* pointer to stack used as map key */
114 ARG_PTR_TO_MAP_VALUE, /* pointer to stack used as map value */
115
116 /* the following constraints used to prototype bpf_memcmp() and other
117 * functions that access data on eBPF program stack
118 */
Alexei Starovoitov39f19ebb2017-01-09 10:19:50 -0800119 ARG_PTR_TO_MEM, /* pointer to valid memory (stack, packet, map value) */
Gianluca Borellodb1ac492017-11-22 18:32:53 +0000120 ARG_PTR_TO_MEM_OR_NULL, /* pointer to valid memory or NULL */
Alexei Starovoitov39f19ebb2017-01-09 10:19:50 -0800121 ARG_PTR_TO_UNINIT_MEM, /* pointer to memory does not need to be initialized,
122 * helper function must fill all bytes or clear
123 * them in error case.
Daniel Borkmann435faee12016-04-13 00:10:51 +0200124 */
125
Alexei Starovoitov39f19ebb2017-01-09 10:19:50 -0800126 ARG_CONST_SIZE, /* number of bytes accessed from memory */
127 ARG_CONST_SIZE_OR_ZERO, /* number of bytes accessed from memory or 0 */
Daniel Borkmann80f1d682015-03-12 17:21:42 +0100128
Alexei Starovoitov608cd712015-03-26 19:53:57 -0700129 ARG_PTR_TO_CTX, /* pointer to context */
Daniel Borkmann80f1d682015-03-12 17:21:42 +0100130 ARG_ANYTHING, /* any (initialized) argument is ok */
Alexei Starovoitov17a52672014-09-26 00:17:06 -0700131};
132
133/* type of values returned from helper functions */
134enum bpf_return_type {
135 RET_INTEGER, /* function returns integer */
136 RET_VOID, /* function doesn't return anything */
137 RET_PTR_TO_MAP_VALUE_OR_NULL, /* returns a pointer to map elem value or NULL */
138};
139
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700140/* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
141 * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
142 * instructions after verifying
143 */
144struct bpf_func_proto {
145 u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
146 bool gpl_only;
Daniel Borkmann36bbef52016-09-20 00:26:13 +0200147 bool pkt_access;
Alexei Starovoitov17a52672014-09-26 00:17:06 -0700148 enum bpf_return_type ret_type;
149 enum bpf_arg_type arg1_type;
150 enum bpf_arg_type arg2_type;
151 enum bpf_arg_type arg3_type;
152 enum bpf_arg_type arg4_type;
153 enum bpf_arg_type arg5_type;
154};
155
156/* bpf_context is intentionally undefined structure. Pointer to bpf_context is
157 * the first argument to eBPF programs.
158 * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
159 */
160struct bpf_context;
161
162enum bpf_access_type {
163 BPF_READ = 1,
164 BPF_WRITE = 2
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700165};
166
Alexei Starovoitov19de99f2016-06-15 18:25:38 -0700167/* types of values stored in eBPF registers */
Edward Creef1174f72017-08-07 15:26:19 +0100168/* Pointer types represent:
169 * pointer
170 * pointer + imm
171 * pointer + (u16) var
172 * pointer + (u16) var + imm
173 * if (range > 0) then [ptr, ptr + range - off) is safe to access
174 * if (id > 0) means that some 'var' was added
175 * if (off > 0) means that 'imm' was added
176 */
Alexei Starovoitov19de99f2016-06-15 18:25:38 -0700177enum bpf_reg_type {
178 NOT_INIT = 0, /* nothing was written into register */
Edward Creef1174f72017-08-07 15:26:19 +0100179 SCALAR_VALUE, /* reg doesn't contain a valid pointer */
Alexei Starovoitov19de99f2016-06-15 18:25:38 -0700180 PTR_TO_CTX, /* reg points to bpf_context */
181 CONST_PTR_TO_MAP, /* reg points to struct bpf_map */
182 PTR_TO_MAP_VALUE, /* reg points to map element value */
183 PTR_TO_MAP_VALUE_OR_NULL,/* points to map elem value or NULL */
Edward Creef1174f72017-08-07 15:26:19 +0100184 PTR_TO_STACK, /* reg == frame_pointer + offset */
Daniel Borkmannde8f3a82017-09-25 02:25:51 +0200185 PTR_TO_PACKET_META, /* skb->data - meta_len */
Edward Creef1174f72017-08-07 15:26:19 +0100186 PTR_TO_PACKET, /* reg points to skb->data */
Alexei Starovoitov19de99f2016-06-15 18:25:38 -0700187 PTR_TO_PACKET_END, /* skb->data + headlen */
188};
189
Yonghong Song23994632017-06-22 15:07:39 -0700190/* The information passed from prog-specific *_is_valid_access
191 * back to the verifier.
192 */
193struct bpf_insn_access_aux {
194 enum bpf_reg_type reg_type;
195 int ctx_field_size;
Yonghong Song23994632017-06-22 15:07:39 -0700196};
197
Daniel Borkmannf96da092017-07-02 02:13:27 +0200198static inline void
199bpf_ctx_record_field_size(struct bpf_insn_access_aux *aux, u32 size)
200{
201 aux->ctx_field_size = size;
202}
203
Jakub Kicinski7de16e32017-10-16 16:40:53 -0700204struct bpf_prog_ops {
205 int (*test_run)(struct bpf_prog *prog, const union bpf_attr *kattr,
206 union bpf_attr __user *uattr);
207};
208
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700209struct bpf_verifier_ops {
210 /* return eBPF function prototype for verification */
Andrey Ignatov5e43f892018-03-30 15:08:00 -0700211 const struct bpf_func_proto *
212 (*get_func_proto)(enum bpf_func_id func_id,
213 const struct bpf_prog *prog);
Alexei Starovoitov17a52672014-09-26 00:17:06 -0700214
215 /* return true if 'size' wide access at offset 'off' within bpf_context
216 * with 'type' (read or write) is allowed
217 */
Alexei Starovoitov19de99f2016-06-15 18:25:38 -0700218 bool (*is_valid_access)(int off, int size, enum bpf_access_type type,
Andrey Ignatov5e43f892018-03-30 15:08:00 -0700219 const struct bpf_prog *prog,
Yonghong Song23994632017-06-22 15:07:39 -0700220 struct bpf_insn_access_aux *info);
Daniel Borkmann36bbef52016-09-20 00:26:13 +0200221 int (*gen_prologue)(struct bpf_insn *insn, bool direct_write,
222 const struct bpf_prog *prog);
Daniel Borkmann6b8cc1d2017-01-12 11:51:32 +0100223 u32 (*convert_ctx_access)(enum bpf_access_type type,
224 const struct bpf_insn *src,
225 struct bpf_insn *dst,
Daniel Borkmannf96da092017-07-02 02:13:27 +0200226 struct bpf_prog *prog, u32 *target_size);
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700227};
228
Jakub Kicinskicae19272017-12-27 18:39:05 -0800229struct bpf_prog_offload_ops {
230 int (*insn_hook)(struct bpf_verifier_env *env,
231 int insn_idx, int prev_insn_idx);
232};
233
Jakub Kicinski0a9c1992018-01-11 20:29:07 -0800234struct bpf_prog_offload {
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700235 struct bpf_prog *prog;
236 struct net_device *netdev;
237 void *dev_priv;
238 struct list_head offloads;
239 bool dev_state;
Jakub Kicinskicae19272017-12-27 18:39:05 -0800240 const struct bpf_prog_offload_ops *dev_ops;
Jiong Wangfcfb1262018-01-16 16:05:19 -0800241 void *jited_image;
242 u32 jited_len;
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700243};
244
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700245struct bpf_prog_aux {
246 atomic_t refcnt;
Daniel Borkmann24701ec2015-03-01 12:31:47 +0100247 u32 used_map_cnt;
Alexei Starovoitov32bbe002016-04-06 18:43:28 -0700248 u32 max_ctx_offset;
Alexei Starovoitov87266792017-05-30 13:31:29 -0700249 u32 stack_depth;
Martin KaFai Laudc4bb0e2017-06-05 12:15:46 -0700250 u32 id;
Alexei Starovoitov1c2a0882017-12-14 17:55:15 -0800251 u32 func_cnt;
Jakub Kicinski9a18eed2017-12-27 18:39:04 -0800252 bool offload_requested;
Alexei Starovoitov1c2a0882017-12-14 17:55:15 -0800253 struct bpf_prog **func;
254 void *jit_data; /* JIT specific data. arch dependent */
Daniel Borkmann74451e662017-02-16 22:24:50 +0100255 struct latch_tree_node ksym_tnode;
256 struct list_head ksym_lnode;
Jakub Kicinski7de16e32017-10-16 16:40:53 -0700257 const struct bpf_prog_ops *ops;
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700258 struct bpf_map **used_maps;
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700259 struct bpf_prog *prog;
Alexei Starovoitovaaac3ba2015-10-07 22:23:22 -0700260 struct user_struct *user;
Martin KaFai Laucb4d2b32017-09-27 14:37:52 -0700261 u64 load_time; /* ns since boottime */
Martin KaFai Lau067cae42017-10-05 21:52:12 -0700262 char name[BPF_OBJ_NAME_LEN];
Chenbo Fengafdb09c2017-10-18 13:00:24 -0700263#ifdef CONFIG_SECURITY
264 void *security;
265#endif
Jakub Kicinski0a9c1992018-01-11 20:29:07 -0800266 struct bpf_prog_offload *offload;
Alexei Starovoitovabf2e7d2015-05-28 19:26:02 -0700267 union {
268 struct work_struct work;
269 struct rcu_head rcu;
270 };
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700271};
272
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700273struct bpf_array {
274 struct bpf_map map;
275 u32 elem_size;
Alexei Starovoitovb2157392018-01-07 17:33:02 -0800276 u32 index_mask;
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700277 /* 'ownership' of prog_array is claimed by the first program that
278 * is going to use this map or by the first program which FD is stored
279 * in the map to make sure that all callers and callees have the same
280 * prog_type and JITed flag
281 */
282 enum bpf_prog_type owner_prog_type;
283 bool owner_jited;
284 union {
285 char value[0] __aligned(8);
Wang Nan2a36f0b2015-08-06 07:02:33 +0000286 void *ptrs[0] __aligned(8);
Alexei Starovoitova10423b2016-02-01 22:39:54 -0800287 void __percpu *pptrs[0] __aligned(8);
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700288 };
289};
Daniel Borkmann3b1efb12016-06-15 22:47:14 +0200290
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700291#define MAX_TAIL_CALL_CNT 32
292
Daniel Borkmann3b1efb12016-06-15 22:47:14 +0200293struct bpf_event_entry {
294 struct perf_event *event;
295 struct file *perf_file;
296 struct file *map_file;
297 struct rcu_head rcu;
298};
299
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700300bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
Daniel Borkmannf1f77142017-01-13 23:38:15 +0100301int bpf_prog_calc_tag(struct bpf_prog *fp);
Daniel Borkmannbd570ff2016-04-18 21:01:24 +0200302
Alexei Starovoitov0756ea32015-06-12 19:39:13 -0700303const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
Daniel Borkmann555c8a82016-07-14 18:08:05 +0200304
305typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src,
Daniel Borkmannaa7145c2016-07-22 01:19:42 +0200306 unsigned long off, unsigned long len);
Daniel Borkmann555c8a82016-07-14 18:08:05 +0200307
308u64 bpf_event_output(struct bpf_map *map, u64 flags, void *meta, u64 meta_size,
309 void *ctx, u64 ctx_size, bpf_ctx_copy_t ctx_copy);
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700310
Alexei Starovoitov1cf1cae2017-03-30 21:45:38 -0700311int bpf_prog_test_run_xdp(struct bpf_prog *prog, const union bpf_attr *kattr,
312 union bpf_attr __user *uattr);
313int bpf_prog_test_run_skb(struct bpf_prog *prog, const union bpf_attr *kattr,
314 union bpf_attr __user *uattr);
315
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700316/* an array of programs to be executed under rcu_lock.
317 *
318 * Typical usage:
319 * ret = BPF_PROG_RUN_ARRAY(&bpf_prog_array, ctx, BPF_PROG_RUN);
320 *
321 * the structure returned by bpf_prog_array_alloc() should be populated
322 * with program pointers and the last pointer must be NULL.
323 * The user has to keep refcnt on the program and make sure the program
324 * is removed from the array before bpf_prog_put().
325 * The 'struct bpf_prog_array *' should only be replaced with xchg()
326 * since other cpus are walking the array of pointers in parallel.
327 */
328struct bpf_prog_array {
329 struct rcu_head rcu;
330 struct bpf_prog *progs[0];
331};
332
333struct bpf_prog_array __rcu *bpf_prog_array_alloc(u32 prog_cnt, gfp_t flags);
334void bpf_prog_array_free(struct bpf_prog_array __rcu *progs);
Alexei Starovoitov468e2f62017-10-02 22:50:22 -0700335int bpf_prog_array_length(struct bpf_prog_array __rcu *progs);
336int bpf_prog_array_copy_to_user(struct bpf_prog_array __rcu *progs,
337 __u32 __user *prog_ids, u32 cnt);
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700338
Yonghong Songe87c6bc2017-10-23 23:53:08 -0700339void bpf_prog_array_delete_safe(struct bpf_prog_array __rcu *progs,
340 struct bpf_prog *old_prog);
Yonghong Songf371b302017-12-11 11:39:02 -0800341int bpf_prog_array_copy_info(struct bpf_prog_array __rcu *array,
Yonghong Song3a38bb92018-04-10 09:37:32 -0700342 u32 *prog_ids, u32 request_cnt,
343 u32 *prog_cnt);
Yonghong Songe87c6bc2017-10-23 23:53:08 -0700344int bpf_prog_array_copy(struct bpf_prog_array __rcu *old_array,
345 struct bpf_prog *exclude_prog,
346 struct bpf_prog *include_prog,
347 struct bpf_prog_array **new_array);
348
349#define __BPF_PROG_RUN_ARRAY(array, ctx, func, check_non_null) \
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700350 ({ \
Yonghong Songe87c6bc2017-10-23 23:53:08 -0700351 struct bpf_prog **_prog, *__prog; \
352 struct bpf_prog_array *_array; \
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700353 u32 _ret = 1; \
Roman Gushchin6899b322018-04-23 18:09:21 +0100354 preempt_disable(); \
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700355 rcu_read_lock(); \
Yonghong Songe87c6bc2017-10-23 23:53:08 -0700356 _array = rcu_dereference(array); \
357 if (unlikely(check_non_null && !_array))\
358 goto _out; \
359 _prog = _array->progs; \
360 while ((__prog = READ_ONCE(*_prog))) { \
361 _ret &= func(__prog, ctx); \
362 _prog++; \
363 } \
364_out: \
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700365 rcu_read_unlock(); \
Roman Gushchin6899b322018-04-23 18:09:21 +0100366 preempt_enable_no_resched(); \
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700367 _ret; \
368 })
369
Yonghong Songe87c6bc2017-10-23 23:53:08 -0700370#define BPF_PROG_RUN_ARRAY(array, ctx, func) \
371 __BPF_PROG_RUN_ARRAY(array, ctx, func, false)
372
373#define BPF_PROG_RUN_ARRAY_CHECK(array, ctx, func) \
374 __BPF_PROG_RUN_ARRAY(array, ctx, func, true)
375
Alexei Starovoitov89aa0752014-12-01 15:06:35 -0800376#ifdef CONFIG_BPF_SYSCALL
Alexei Starovoitovb121d1e2016-03-07 21:57:13 -0800377DECLARE_PER_CPU(int, bpf_prog_active);
378
Chenbo Fengf66e4482017-10-18 13:00:26 -0700379extern const struct file_operations bpf_map_fops;
380extern const struct file_operations bpf_prog_fops;
381
Jakub Kicinski7de16e32017-10-16 16:40:53 -0700382#define BPF_PROG_TYPE(_id, _name) \
383 extern const struct bpf_prog_ops _name ## _prog_ops; \
384 extern const struct bpf_verifier_ops _name ## _verifier_ops;
Johannes Berg40077e02017-04-11 15:34:58 +0200385#define BPF_MAP_TYPE(_id, _ops) \
386 extern const struct bpf_map_ops _ops;
Johannes Bergbe9370a2017-04-11 15:34:57 +0200387#include <linux/bpf_types.h>
388#undef BPF_PROG_TYPE
Johannes Berg40077e02017-04-11 15:34:58 +0200389#undef BPF_MAP_TYPE
Daniel Borkmann0fc174d2015-03-01 12:31:44 +0100390
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700391extern const struct bpf_prog_ops bpf_offload_prog_ops;
Jakub Kicinski4f9218a2017-10-16 16:40:55 -0700392extern const struct bpf_verifier_ops tc_cls_act_analyzer_ops;
393extern const struct bpf_verifier_ops xdp_analyzer_ops;
394
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700395struct bpf_prog *bpf_prog_get(u32 ufd);
Jakub Kicinski248f3462017-11-03 13:56:20 -0700396struct bpf_prog *bpf_prog_get_type_dev(u32 ufd, enum bpf_prog_type type,
Jakub Kicinski288b3de2017-11-20 15:21:54 -0800397 bool attach_drv);
Daniel Borkmann6d67942dd2016-11-19 01:45:03 +0100398struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog, int i);
Daniel Borkmannc5405942016-11-09 22:02:34 +0100399void bpf_prog_sub(struct bpf_prog *prog, int i);
Daniel Borkmann6d67942dd2016-11-19 01:45:03 +0100400struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog);
John Fastabenda6f6df62017-08-15 22:32:22 -0700401struct bpf_prog * __must_check bpf_prog_inc_not_zero(struct bpf_prog *prog);
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100402void bpf_prog_put(struct bpf_prog *prog);
Daniel Borkmann5ccb0712016-12-18 01:52:58 +0100403int __bpf_prog_charge(struct user_struct *user, u32 pages);
404void __bpf_prog_uncharge(struct user_struct *user, u32 pages);
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100405
Jakub Kicinskiad8ad792017-12-27 18:39:07 -0800406void bpf_prog_free_id(struct bpf_prog *prog, bool do_idr_lock);
Jakub Kicinskia3884572018-01-11 20:29:09 -0800407void bpf_map_free_id(struct bpf_map *map, bool do_idr_lock);
Jakub Kicinskiad8ad792017-12-27 18:39:07 -0800408
Daniel Borkmannc9da1612015-11-24 21:28:15 +0100409struct bpf_map *bpf_map_get_with_uref(u32 ufd);
Daniel Borkmannc2101292015-10-29 14:58:07 +0100410struct bpf_map *__bpf_map_get(struct fd f);
Daniel Borkmann6d67942dd2016-11-19 01:45:03 +0100411struct bpf_map * __must_check bpf_map_inc(struct bpf_map *map, bool uref);
Daniel Borkmannc9da1612015-11-24 21:28:15 +0100412void bpf_map_put_with_uref(struct bpf_map *map);
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100413void bpf_map_put(struct bpf_map *map);
Alexei Starovoitov6c905982016-03-07 21:57:15 -0800414int bpf_map_precharge_memlock(u32 pages);
Martin KaFai Lau96eabe72017-08-18 11:28:00 -0700415void *bpf_map_area_alloc(size_t size, int numa_node);
Daniel Borkmannd407bd22017-01-18 15:14:17 +0100416void bpf_map_area_free(void *base);
Jakub Kicinskibd475642018-01-11 20:29:06 -0800417void bpf_map_init_from_attr(struct bpf_map *map, union bpf_attr *attr);
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100418
Alexei Starovoitov1be7f752015-10-07 22:23:21 -0700419extern int sysctl_unprivileged_bpf_disabled;
420
Chenbo Feng6e71b042017-10-18 13:00:22 -0700421int bpf_map_new_fd(struct bpf_map *map, int flags);
Daniel Borkmannb2197752015-10-29 14:58:09 +0100422int bpf_prog_new_fd(struct bpf_prog *prog);
423
424int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
Chenbo Feng6e71b042017-10-18 13:00:22 -0700425int bpf_obj_get_user(const char __user *pathname, int flags);
Daniel Borkmannb2197752015-10-29 14:58:09 +0100426
Alexei Starovoitov15a07b32016-02-01 22:39:55 -0800427int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value);
428int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value);
429int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
430 u64 flags);
431int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
432 u64 flags);
Daniel Borkmannd056a782016-06-15 22:47:13 +0200433
Alexei Starovoitov557c0c62016-03-07 21:57:17 -0800434int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value);
Alexei Starovoitov15a07b32016-02-01 22:39:55 -0800435
Daniel Borkmannd056a782016-06-15 22:47:13 +0200436int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
437 void *key, void *value, u64 map_flags);
Martin KaFai Lau14dc6f02017-06-27 23:08:34 -0700438int bpf_fd_array_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
Daniel Borkmannd056a782016-06-15 22:47:13 +0200439void bpf_fd_array_map_clear(struct bpf_map *map);
Martin KaFai Laubcc6b1b2017-03-22 10:00:34 -0700440int bpf_fd_htab_map_update_elem(struct bpf_map *map, struct file *map_file,
441 void *key, void *value, u64 map_flags);
Martin KaFai Lau14dc6f02017-06-27 23:08:34 -0700442int bpf_fd_htab_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
Daniel Borkmannd056a782016-06-15 22:47:13 +0200443
Chenbo Feng6e71b042017-10-18 13:00:22 -0700444int bpf_get_file_flag(int flags);
445
Alexei Starovoitov15a07b32016-02-01 22:39:55 -0800446/* memcpy that is used with 8-byte aligned pointers, power-of-8 size and
447 * forced to use 'long' read/writes to try to atomically copy long counters.
448 * Best-effort only. No barriers here, since it _will_ race with concurrent
449 * updates from BPF programs. Called from bpf syscall and mostly used with
450 * size 8 or 16 bytes, so ask compiler to inline it.
451 */
452static inline void bpf_long_memcpy(void *dst, const void *src, u32 size)
453{
454 const long *lsrc = src;
455 long *ldst = dst;
456
457 size /= sizeof(long);
458 while (size--)
459 *ldst++ = *lsrc++;
460}
461
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100462/* verify correctness of eBPF program */
Alexei Starovoitov9bac3d62015-03-13 11:57:42 -0700463int bpf_check(struct bpf_prog **fp, union bpf_attr *attr);
Alexei Starovoitov1ea47e02017-12-14 17:55:13 -0800464void bpf_patch_call_args(struct bpf_insn *insn, u32 stack_depth);
John Fastabend46f55cf2017-07-17 21:56:48 -0700465
466/* Map specifics */
467struct net_device *__dev_map_lookup_elem(struct bpf_map *map, u32 key);
468void __dev_map_insert_ctx(struct bpf_map *map, u32 index);
469void __dev_map_flush(struct bpf_map *map);
470
Jesper Dangaard Brouer9c270af2017-10-16 12:19:34 +0200471struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key);
472void __cpu_map_insert_ctx(struct bpf_map *map, u32 index);
473void __cpu_map_flush(struct bpf_map *map);
474struct xdp_buff;
475int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu, struct xdp_buff *xdp,
476 struct net_device *dev_rx);
477
Martin KaFai Lau96eabe72017-08-18 11:28:00 -0700478/* Return map's numa specified by userspace */
479static inline int bpf_map_attr_numa_node(const union bpf_attr *attr)
480{
481 return (attr->map_flags & BPF_F_NUMA_NODE) ?
482 attr->numa_node : NUMA_NO_NODE;
483}
484
Al Viro040ee692017-12-02 20:20:38 -0500485struct bpf_prog *bpf_prog_get_type_path(const char *name, enum bpf_prog_type type);
486
Jesper Dangaard Brouer9c270af2017-10-16 12:19:34 +0200487#else /* !CONFIG_BPF_SYSCALL */
Daniel Borkmann0fc174d2015-03-01 12:31:44 +0100488static inline struct bpf_prog *bpf_prog_get(u32 ufd)
489{
490 return ERR_PTR(-EOPNOTSUPP);
491}
492
Jakub Kicinski248f3462017-11-03 13:56:20 -0700493static inline struct bpf_prog *bpf_prog_get_type_dev(u32 ufd,
494 enum bpf_prog_type type,
Jakub Kicinski288b3de2017-11-20 15:21:54 -0800495 bool attach_drv)
Jakub Kicinski248f3462017-11-03 13:56:20 -0700496{
497 return ERR_PTR(-EOPNOTSUPP);
498}
499
Daniel Borkmann6d67942dd2016-11-19 01:45:03 +0100500static inline struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog,
501 int i)
Brenden Blancocc2e0b32016-07-20 07:55:52 -0700502{
503 return ERR_PTR(-EOPNOTSUPP);
504}
Daniel Borkmann113214b2016-06-30 17:24:44 +0200505
Daniel Borkmannc5405942016-11-09 22:02:34 +0100506static inline void bpf_prog_sub(struct bpf_prog *prog, int i)
507{
508}
509
Daniel Borkmann0fc174d2015-03-01 12:31:44 +0100510static inline void bpf_prog_put(struct bpf_prog *prog)
511{
512}
Daniel Borkmann6d67942dd2016-11-19 01:45:03 +0100513
514static inline struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog)
Alexei Starovoitovaa6a5f32016-09-01 18:37:24 -0700515{
516 return ERR_PTR(-EOPNOTSUPP);
517}
Daniel Borkmann5ccb0712016-12-18 01:52:58 +0100518
John Fastabenda6f6df62017-08-15 22:32:22 -0700519static inline struct bpf_prog *__must_check
520bpf_prog_inc_not_zero(struct bpf_prog *prog)
521{
522 return ERR_PTR(-EOPNOTSUPP);
523}
524
Daniel Borkmann5ccb0712016-12-18 01:52:58 +0100525static inline int __bpf_prog_charge(struct user_struct *user, u32 pages)
526{
527 return 0;
528}
529
530static inline void __bpf_prog_uncharge(struct user_struct *user, u32 pages)
531{
532}
John Fastabend46f55cf2017-07-17 21:56:48 -0700533
Chenbo Feng6e71b042017-10-18 13:00:22 -0700534static inline int bpf_obj_get_user(const char __user *pathname, int flags)
Shmulik Ladkani98589a02017-10-09 15:27:15 +0300535{
536 return -EOPNOTSUPP;
537}
538
John Fastabend46f55cf2017-07-17 21:56:48 -0700539static inline struct net_device *__dev_map_lookup_elem(struct bpf_map *map,
540 u32 key)
541{
542 return NULL;
543}
544
545static inline void __dev_map_insert_ctx(struct bpf_map *map, u32 index)
546{
547}
548
549static inline void __dev_map_flush(struct bpf_map *map)
550{
551}
Jesper Dangaard Brouer9c270af2017-10-16 12:19:34 +0200552
553static inline
554struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key)
555{
556 return NULL;
557}
558
559static inline void __cpu_map_insert_ctx(struct bpf_map *map, u32 index)
560{
561}
562
563static inline void __cpu_map_flush(struct bpf_map *map)
564{
565}
566
567struct xdp_buff;
568static inline int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu,
569 struct xdp_buff *xdp,
570 struct net_device *dev_rx)
571{
572 return 0;
573}
Al Viro040ee692017-12-02 20:20:38 -0500574
575static inline struct bpf_prog *bpf_prog_get_type_path(const char *name,
576 enum bpf_prog_type type)
577{
578 return ERR_PTR(-EOPNOTSUPP);
579}
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100580#endif /* CONFIG_BPF_SYSCALL */
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700581
Jakub Kicinski479321e2017-11-20 15:21:56 -0800582static inline struct bpf_prog *bpf_prog_get_type(u32 ufd,
583 enum bpf_prog_type type)
584{
585 return bpf_prog_get_type_dev(ufd, type, false);
586}
587
Al Viro040ee692017-12-02 20:20:38 -0500588bool bpf_prog_get_ok(struct bpf_prog *, enum bpf_prog_type *, bool);
589
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700590int bpf_prog_offload_compile(struct bpf_prog *prog);
591void bpf_prog_offload_destroy(struct bpf_prog *prog);
Jakub Kicinski675fc272017-12-27 18:39:09 -0800592int bpf_prog_offload_info_fill(struct bpf_prog_info *info,
593 struct bpf_prog *prog);
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700594
Jakub Kicinski52775b32018-01-17 19:13:28 -0800595int bpf_map_offload_info_fill(struct bpf_map_info *info, struct bpf_map *map);
596
Jakub Kicinskia3884572018-01-11 20:29:09 -0800597int bpf_map_offload_lookup_elem(struct bpf_map *map, void *key, void *value);
598int bpf_map_offload_update_elem(struct bpf_map *map,
599 void *key, void *value, u64 flags);
600int bpf_map_offload_delete_elem(struct bpf_map *map, void *key);
601int bpf_map_offload_get_next_key(struct bpf_map *map,
602 void *key, void *next_key);
603
604bool bpf_offload_dev_match(struct bpf_prog *prog, struct bpf_map *map);
605
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700606#if defined(CONFIG_NET) && defined(CONFIG_BPF_SYSCALL)
607int bpf_prog_offload_init(struct bpf_prog *prog, union bpf_attr *attr);
608
609static inline bool bpf_prog_is_dev_bound(struct bpf_prog_aux *aux)
610{
Jakub Kicinski9a18eed2017-12-27 18:39:04 -0800611 return aux->offload_requested;
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700612}
Jakub Kicinskia3884572018-01-11 20:29:09 -0800613
614static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
615{
616 return unlikely(map->ops == &bpf_map_offload_ops);
617}
618
619struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr);
620void bpf_map_offload_map_free(struct bpf_map *map);
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700621#else
622static inline int bpf_prog_offload_init(struct bpf_prog *prog,
623 union bpf_attr *attr)
624{
625 return -EOPNOTSUPP;
626}
627
628static inline bool bpf_prog_is_dev_bound(struct bpf_prog_aux *aux)
629{
630 return false;
631}
Jakub Kicinskia3884572018-01-11 20:29:09 -0800632
633static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
634{
635 return false;
636}
637
638static inline struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr)
639{
640 return ERR_PTR(-EOPNOTSUPP);
641}
642
643static inline void bpf_map_offload_map_free(struct bpf_map *map)
644{
645}
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700646#endif /* CONFIG_NET && CONFIG_BPF_SYSCALL */
647
John Fastabend5f103c52018-01-03 17:57:56 -0800648#if defined(CONFIG_STREAM_PARSER) && defined(CONFIG_BPF_SYSCALL) && defined(CONFIG_INET)
John Fastabend6bdc9c42017-08-16 15:02:32 -0700649struct sock *__sock_map_lookup_elem(struct bpf_map *map, u32 key);
John Fastabend5a67da22017-09-08 14:00:49 -0700650int sock_map_prog(struct bpf_map *map, struct bpf_prog *prog, u32 type);
John Fastabend6bdc9c42017-08-16 15:02:32 -0700651#else
652static inline struct sock *__sock_map_lookup_elem(struct bpf_map *map, u32 key)
653{
654 return NULL;
655}
John Fastabend464bc0f2017-08-28 07:10:04 -0700656
John Fastabend5a67da22017-09-08 14:00:49 -0700657static inline int sock_map_prog(struct bpf_map *map,
658 struct bpf_prog *prog,
659 u32 type)
John Fastabend464bc0f2017-08-28 07:10:04 -0700660{
661 return -EOPNOTSUPP;
662}
John Fastabend6bdc9c42017-08-16 15:02:32 -0700663#endif
664
Alexei Starovoitovd0003ec2014-11-13 17:36:49 -0800665/* verifier prototypes for helper functions called from eBPF programs */
Daniel Borkmanna2c83ff2015-03-01 12:31:42 +0100666extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
667extern const struct bpf_func_proto bpf_map_update_elem_proto;
668extern const struct bpf_func_proto bpf_map_delete_elem_proto;
Alexei Starovoitovd0003ec2014-11-13 17:36:49 -0800669
Daniel Borkmann03e69b52015-03-14 02:27:16 +0100670extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
Daniel Borkmannc04167c2015-03-14 02:27:17 +0100671extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
Daniel Borkmann2d0e30c2016-10-21 12:46:33 +0200672extern const struct bpf_func_proto bpf_get_numa_node_id_proto;
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700673extern const struct bpf_func_proto bpf_tail_call_proto;
Daniel Borkmann17ca8cb2015-05-29 23:23:06 +0200674extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
Alexei Starovoitovffeedaf2015-06-12 19:39:12 -0700675extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
676extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
677extern const struct bpf_func_proto bpf_get_current_comm_proto;
Alexei Starovoitov4e10df92015-07-20 20:34:18 -0700678extern const struct bpf_func_proto bpf_skb_vlan_push_proto;
679extern const struct bpf_func_proto bpf_skb_vlan_pop_proto;
Alexei Starovoitovd5a3b1f2016-02-17 19:58:58 -0800680extern const struct bpf_func_proto bpf_get_stackid_proto;
John Fastabend174a79f2017-08-15 22:32:47 -0700681extern const struct bpf_func_proto bpf_sock_map_update_proto;
Daniel Borkmann03e69b52015-03-14 02:27:16 +0100682
Daniel Borkmann3ad00402015-10-08 01:20:39 +0200683/* Shared helpers among cBPF and eBPF. */
684void bpf_user_rnd_init_once(void);
685u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
686
Alexei Starovoitov99c55f72014-09-26 00:16:57 -0700687#endif /* _LINUX_BPF_H */