blob: 819229c80ecaed8343cf12f3ec663af7ba031353 [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 */
211 const struct bpf_func_proto *(*get_func_proto)(enum bpf_func_id func_id);
Alexei Starovoitov17a52672014-09-26 00:17:06 -0700212
213 /* return true if 'size' wide access at offset 'off' within bpf_context
214 * with 'type' (read or write) is allowed
215 */
Alexei Starovoitov19de99f2016-06-15 18:25:38 -0700216 bool (*is_valid_access)(int off, int size, enum bpf_access_type type,
Yonghong Song23994632017-06-22 15:07:39 -0700217 struct bpf_insn_access_aux *info);
Daniel Borkmann36bbef52016-09-20 00:26:13 +0200218 int (*gen_prologue)(struct bpf_insn *insn, bool direct_write,
219 const struct bpf_prog *prog);
Daniel Borkmann6b8cc1d2017-01-12 11:51:32 +0100220 u32 (*convert_ctx_access)(enum bpf_access_type type,
221 const struct bpf_insn *src,
222 struct bpf_insn *dst,
Daniel Borkmannf96da092017-07-02 02:13:27 +0200223 struct bpf_prog *prog, u32 *target_size);
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700224};
225
Jakub Kicinskicae19272017-12-27 18:39:05 -0800226struct bpf_prog_offload_ops {
227 int (*insn_hook)(struct bpf_verifier_env *env,
228 int insn_idx, int prev_insn_idx);
229};
230
Jakub Kicinski0a9c1992018-01-11 20:29:07 -0800231struct bpf_prog_offload {
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700232 struct bpf_prog *prog;
233 struct net_device *netdev;
234 void *dev_priv;
235 struct list_head offloads;
236 bool dev_state;
Jakub Kicinskicae19272017-12-27 18:39:05 -0800237 const struct bpf_prog_offload_ops *dev_ops;
Jiong Wangfcfb1262018-01-16 16:05:19 -0800238 void *jited_image;
239 u32 jited_len;
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700240};
241
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700242struct bpf_prog_aux {
243 atomic_t refcnt;
Daniel Borkmann24701ec2015-03-01 12:31:47 +0100244 u32 used_map_cnt;
Alexei Starovoitov32bbe002016-04-06 18:43:28 -0700245 u32 max_ctx_offset;
Alexei Starovoitov87266792017-05-30 13:31:29 -0700246 u32 stack_depth;
Martin KaFai Laudc4bb0e2017-06-05 12:15:46 -0700247 u32 id;
Alexei Starovoitov1c2a0882017-12-14 17:55:15 -0800248 u32 func_cnt;
Jakub Kicinski9a18eed2017-12-27 18:39:04 -0800249 bool offload_requested;
Alexei Starovoitov1c2a0882017-12-14 17:55:15 -0800250 struct bpf_prog **func;
251 void *jit_data; /* JIT specific data. arch dependent */
Daniel Borkmann74451e662017-02-16 22:24:50 +0100252 struct latch_tree_node ksym_tnode;
253 struct list_head ksym_lnode;
Jakub Kicinski7de16e32017-10-16 16:40:53 -0700254 const struct bpf_prog_ops *ops;
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700255 struct bpf_map **used_maps;
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700256 struct bpf_prog *prog;
Alexei Starovoitovaaac3ba2015-10-07 22:23:22 -0700257 struct user_struct *user;
Martin KaFai Laucb4d2b32017-09-27 14:37:52 -0700258 u64 load_time; /* ns since boottime */
Martin KaFai Lau067cae42017-10-05 21:52:12 -0700259 char name[BPF_OBJ_NAME_LEN];
Chenbo Fengafdb09c2017-10-18 13:00:24 -0700260#ifdef CONFIG_SECURITY
261 void *security;
262#endif
Jakub Kicinski0a9c1992018-01-11 20:29:07 -0800263 struct bpf_prog_offload *offload;
Alexei Starovoitovabf2e7d2015-05-28 19:26:02 -0700264 union {
265 struct work_struct work;
266 struct rcu_head rcu;
267 };
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700268};
269
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700270struct bpf_array {
271 struct bpf_map map;
272 u32 elem_size;
Alexei Starovoitovb2157392018-01-07 17:33:02 -0800273 u32 index_mask;
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700274 /* 'ownership' of prog_array is claimed by the first program that
275 * is going to use this map or by the first program which FD is stored
276 * in the map to make sure that all callers and callees have the same
277 * prog_type and JITed flag
278 */
279 enum bpf_prog_type owner_prog_type;
280 bool owner_jited;
281 union {
282 char value[0] __aligned(8);
Wang Nan2a36f0b2015-08-06 07:02:33 +0000283 void *ptrs[0] __aligned(8);
Alexei Starovoitova10423b2016-02-01 22:39:54 -0800284 void __percpu *pptrs[0] __aligned(8);
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700285 };
286};
Daniel Borkmann3b1efb12016-06-15 22:47:14 +0200287
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700288#define MAX_TAIL_CALL_CNT 32
289
Daniel Borkmann3b1efb12016-06-15 22:47:14 +0200290struct bpf_event_entry {
291 struct perf_event *event;
292 struct file *perf_file;
293 struct file *map_file;
294 struct rcu_head rcu;
295};
296
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700297bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
Daniel Borkmannf1f77142017-01-13 23:38:15 +0100298int bpf_prog_calc_tag(struct bpf_prog *fp);
Daniel Borkmannbd570ff2016-04-18 21:01:24 +0200299
Alexei Starovoitov0756ea32015-06-12 19:39:13 -0700300const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
Daniel Borkmann555c8a82016-07-14 18:08:05 +0200301
302typedef unsigned long (*bpf_ctx_copy_t)(void *dst, const void *src,
Daniel Borkmannaa7145c2016-07-22 01:19:42 +0200303 unsigned long off, unsigned long len);
Daniel Borkmann555c8a82016-07-14 18:08:05 +0200304
305u64 bpf_event_output(struct bpf_map *map, u64 flags, void *meta, u64 meta_size,
306 void *ctx, u64 ctx_size, bpf_ctx_copy_t ctx_copy);
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700307
Alexei Starovoitov1cf1cae2017-03-30 21:45:38 -0700308int bpf_prog_test_run_xdp(struct bpf_prog *prog, const union bpf_attr *kattr,
309 union bpf_attr __user *uattr);
310int bpf_prog_test_run_skb(struct bpf_prog *prog, const union bpf_attr *kattr,
311 union bpf_attr __user *uattr);
312
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700313/* an array of programs to be executed under rcu_lock.
314 *
315 * Typical usage:
316 * ret = BPF_PROG_RUN_ARRAY(&bpf_prog_array, ctx, BPF_PROG_RUN);
317 *
318 * the structure returned by bpf_prog_array_alloc() should be populated
319 * with program pointers and the last pointer must be NULL.
320 * The user has to keep refcnt on the program and make sure the program
321 * is removed from the array before bpf_prog_put().
322 * The 'struct bpf_prog_array *' should only be replaced with xchg()
323 * since other cpus are walking the array of pointers in parallel.
324 */
325struct bpf_prog_array {
326 struct rcu_head rcu;
327 struct bpf_prog *progs[0];
328};
329
330struct bpf_prog_array __rcu *bpf_prog_array_alloc(u32 prog_cnt, gfp_t flags);
331void bpf_prog_array_free(struct bpf_prog_array __rcu *progs);
Alexei Starovoitov468e2f62017-10-02 22:50:22 -0700332int bpf_prog_array_length(struct bpf_prog_array __rcu *progs);
333int bpf_prog_array_copy_to_user(struct bpf_prog_array __rcu *progs,
334 __u32 __user *prog_ids, u32 cnt);
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700335
Yonghong Songe87c6bc2017-10-23 23:53:08 -0700336void bpf_prog_array_delete_safe(struct bpf_prog_array __rcu *progs,
337 struct bpf_prog *old_prog);
Yonghong Songf371b302017-12-11 11:39:02 -0800338int bpf_prog_array_copy_info(struct bpf_prog_array __rcu *array,
339 __u32 __user *prog_ids, u32 request_cnt,
340 __u32 __user *prog_cnt);
Yonghong Songe87c6bc2017-10-23 23:53:08 -0700341int bpf_prog_array_copy(struct bpf_prog_array __rcu *old_array,
342 struct bpf_prog *exclude_prog,
343 struct bpf_prog *include_prog,
344 struct bpf_prog_array **new_array);
345
346#define __BPF_PROG_RUN_ARRAY(array, ctx, func, check_non_null) \
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700347 ({ \
Yonghong Songe87c6bc2017-10-23 23:53:08 -0700348 struct bpf_prog **_prog, *__prog; \
349 struct bpf_prog_array *_array; \
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700350 u32 _ret = 1; \
351 rcu_read_lock(); \
Yonghong Songe87c6bc2017-10-23 23:53:08 -0700352 _array = rcu_dereference(array); \
353 if (unlikely(check_non_null && !_array))\
354 goto _out; \
355 _prog = _array->progs; \
356 while ((__prog = READ_ONCE(*_prog))) { \
357 _ret &= func(__prog, ctx); \
358 _prog++; \
359 } \
360_out: \
Alexei Starovoitov324bda9e62017-10-02 22:50:21 -0700361 rcu_read_unlock(); \
362 _ret; \
363 })
364
Yonghong Songe87c6bc2017-10-23 23:53:08 -0700365#define BPF_PROG_RUN_ARRAY(array, ctx, func) \
366 __BPF_PROG_RUN_ARRAY(array, ctx, func, false)
367
368#define BPF_PROG_RUN_ARRAY_CHECK(array, ctx, func) \
369 __BPF_PROG_RUN_ARRAY(array, ctx, func, true)
370
Alexei Starovoitov89aa0752014-12-01 15:06:35 -0800371#ifdef CONFIG_BPF_SYSCALL
Alexei Starovoitovb121d1e2016-03-07 21:57:13 -0800372DECLARE_PER_CPU(int, bpf_prog_active);
373
Chenbo Fengf66e4482017-10-18 13:00:26 -0700374extern const struct file_operations bpf_map_fops;
375extern const struct file_operations bpf_prog_fops;
376
Jakub Kicinski7de16e32017-10-16 16:40:53 -0700377#define BPF_PROG_TYPE(_id, _name) \
378 extern const struct bpf_prog_ops _name ## _prog_ops; \
379 extern const struct bpf_verifier_ops _name ## _verifier_ops;
Johannes Berg40077e02017-04-11 15:34:58 +0200380#define BPF_MAP_TYPE(_id, _ops) \
381 extern const struct bpf_map_ops _ops;
Johannes Bergbe9370a2017-04-11 15:34:57 +0200382#include <linux/bpf_types.h>
383#undef BPF_PROG_TYPE
Johannes Berg40077e02017-04-11 15:34:58 +0200384#undef BPF_MAP_TYPE
Daniel Borkmann0fc174d2015-03-01 12:31:44 +0100385
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700386extern const struct bpf_prog_ops bpf_offload_prog_ops;
Jakub Kicinski4f9218a2017-10-16 16:40:55 -0700387extern const struct bpf_verifier_ops tc_cls_act_analyzer_ops;
388extern const struct bpf_verifier_ops xdp_analyzer_ops;
389
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700390struct bpf_prog *bpf_prog_get(u32 ufd);
Jakub Kicinski248f3462017-11-03 13:56:20 -0700391struct bpf_prog *bpf_prog_get_type_dev(u32 ufd, enum bpf_prog_type type,
Jakub Kicinski288b3de2017-11-20 15:21:54 -0800392 bool attach_drv);
Daniel Borkmann6d67942dd2016-11-19 01:45:03 +0100393struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog, int i);
Daniel Borkmannc5405942016-11-09 22:02:34 +0100394void bpf_prog_sub(struct bpf_prog *prog, int i);
Daniel Borkmann6d67942dd2016-11-19 01:45:03 +0100395struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog);
John Fastabenda6f6df62017-08-15 22:32:22 -0700396struct bpf_prog * __must_check bpf_prog_inc_not_zero(struct bpf_prog *prog);
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100397void bpf_prog_put(struct bpf_prog *prog);
Daniel Borkmann5ccb0712016-12-18 01:52:58 +0100398int __bpf_prog_charge(struct user_struct *user, u32 pages);
399void __bpf_prog_uncharge(struct user_struct *user, u32 pages);
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100400
Jakub Kicinskiad8ad792017-12-27 18:39:07 -0800401void bpf_prog_free_id(struct bpf_prog *prog, bool do_idr_lock);
Jakub Kicinskia3884572018-01-11 20:29:09 -0800402void bpf_map_free_id(struct bpf_map *map, bool do_idr_lock);
Jakub Kicinskiad8ad792017-12-27 18:39:07 -0800403
Daniel Borkmannc9da1612015-11-24 21:28:15 +0100404struct bpf_map *bpf_map_get_with_uref(u32 ufd);
Daniel Borkmannc2101292015-10-29 14:58:07 +0100405struct bpf_map *__bpf_map_get(struct fd f);
Daniel Borkmann6d67942dd2016-11-19 01:45:03 +0100406struct bpf_map * __must_check bpf_map_inc(struct bpf_map *map, bool uref);
Daniel Borkmannc9da1612015-11-24 21:28:15 +0100407void bpf_map_put_with_uref(struct bpf_map *map);
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100408void bpf_map_put(struct bpf_map *map);
Alexei Starovoitov6c905982016-03-07 21:57:15 -0800409int bpf_map_precharge_memlock(u32 pages);
Martin KaFai Lau96eabe72017-08-18 11:28:00 -0700410void *bpf_map_area_alloc(size_t size, int numa_node);
Daniel Borkmannd407bd22017-01-18 15:14:17 +0100411void bpf_map_area_free(void *base);
Jakub Kicinskibd475642018-01-11 20:29:06 -0800412void bpf_map_init_from_attr(struct bpf_map *map, union bpf_attr *attr);
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100413
Alexei Starovoitov1be7f752015-10-07 22:23:21 -0700414extern int sysctl_unprivileged_bpf_disabled;
415
Chenbo Feng6e71b042017-10-18 13:00:22 -0700416int bpf_map_new_fd(struct bpf_map *map, int flags);
Daniel Borkmannb2197752015-10-29 14:58:09 +0100417int bpf_prog_new_fd(struct bpf_prog *prog);
418
419int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
Chenbo Feng6e71b042017-10-18 13:00:22 -0700420int bpf_obj_get_user(const char __user *pathname, int flags);
Daniel Borkmannb2197752015-10-29 14:58:09 +0100421
Alexei Starovoitov15a07b32016-02-01 22:39:55 -0800422int bpf_percpu_hash_copy(struct bpf_map *map, void *key, void *value);
423int bpf_percpu_array_copy(struct bpf_map *map, void *key, void *value);
424int bpf_percpu_hash_update(struct bpf_map *map, void *key, void *value,
425 u64 flags);
426int bpf_percpu_array_update(struct bpf_map *map, void *key, void *value,
427 u64 flags);
Daniel Borkmannd056a782016-06-15 22:47:13 +0200428
Alexei Starovoitov557c0c62016-03-07 21:57:17 -0800429int bpf_stackmap_copy(struct bpf_map *map, void *key, void *value);
Alexei Starovoitov15a07b32016-02-01 22:39:55 -0800430
Daniel Borkmannd056a782016-06-15 22:47:13 +0200431int bpf_fd_array_map_update_elem(struct bpf_map *map, struct file *map_file,
432 void *key, void *value, u64 map_flags);
Martin KaFai Lau14dc6f02017-06-27 23:08:34 -0700433int bpf_fd_array_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
Daniel Borkmannd056a782016-06-15 22:47:13 +0200434void bpf_fd_array_map_clear(struct bpf_map *map);
Martin KaFai Laubcc6b1b2017-03-22 10:00:34 -0700435int bpf_fd_htab_map_update_elem(struct bpf_map *map, struct file *map_file,
436 void *key, void *value, u64 map_flags);
Martin KaFai Lau14dc6f02017-06-27 23:08:34 -0700437int bpf_fd_htab_map_lookup_elem(struct bpf_map *map, void *key, u32 *value);
Daniel Borkmannd056a782016-06-15 22:47:13 +0200438
Chenbo Feng6e71b042017-10-18 13:00:22 -0700439int bpf_get_file_flag(int flags);
440
Alexei Starovoitov15a07b32016-02-01 22:39:55 -0800441/* memcpy that is used with 8-byte aligned pointers, power-of-8 size and
442 * forced to use 'long' read/writes to try to atomically copy long counters.
443 * Best-effort only. No barriers here, since it _will_ race with concurrent
444 * updates from BPF programs. Called from bpf syscall and mostly used with
445 * size 8 or 16 bytes, so ask compiler to inline it.
446 */
447static inline void bpf_long_memcpy(void *dst, const void *src, u32 size)
448{
449 const long *lsrc = src;
450 long *ldst = dst;
451
452 size /= sizeof(long);
453 while (size--)
454 *ldst++ = *lsrc++;
455}
456
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100457/* verify correctness of eBPF program */
Alexei Starovoitov9bac3d62015-03-13 11:57:42 -0700458int bpf_check(struct bpf_prog **fp, union bpf_attr *attr);
Alexei Starovoitov1ea47e02017-12-14 17:55:13 -0800459void bpf_patch_call_args(struct bpf_insn *insn, u32 stack_depth);
John Fastabend46f55cf2017-07-17 21:56:48 -0700460
461/* Map specifics */
462struct net_device *__dev_map_lookup_elem(struct bpf_map *map, u32 key);
463void __dev_map_insert_ctx(struct bpf_map *map, u32 index);
464void __dev_map_flush(struct bpf_map *map);
465
Jesper Dangaard Brouer9c270af2017-10-16 12:19:34 +0200466struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key);
467void __cpu_map_insert_ctx(struct bpf_map *map, u32 index);
468void __cpu_map_flush(struct bpf_map *map);
469struct xdp_buff;
470int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu, struct xdp_buff *xdp,
471 struct net_device *dev_rx);
472
Martin KaFai Lau96eabe72017-08-18 11:28:00 -0700473/* Return map's numa specified by userspace */
474static inline int bpf_map_attr_numa_node(const union bpf_attr *attr)
475{
476 return (attr->map_flags & BPF_F_NUMA_NODE) ?
477 attr->numa_node : NUMA_NO_NODE;
478}
479
Al Viro040ee692017-12-02 20:20:38 -0500480struct bpf_prog *bpf_prog_get_type_path(const char *name, enum bpf_prog_type type);
481
Jesper Dangaard Brouer9c270af2017-10-16 12:19:34 +0200482#else /* !CONFIG_BPF_SYSCALL */
Daniel Borkmann0fc174d2015-03-01 12:31:44 +0100483static inline struct bpf_prog *bpf_prog_get(u32 ufd)
484{
485 return ERR_PTR(-EOPNOTSUPP);
486}
487
Jakub Kicinski248f3462017-11-03 13:56:20 -0700488static inline struct bpf_prog *bpf_prog_get_type_dev(u32 ufd,
489 enum bpf_prog_type type,
Jakub Kicinski288b3de2017-11-20 15:21:54 -0800490 bool attach_drv)
Jakub Kicinski248f3462017-11-03 13:56:20 -0700491{
492 return ERR_PTR(-EOPNOTSUPP);
493}
494
Daniel Borkmann6d67942dd2016-11-19 01:45:03 +0100495static inline struct bpf_prog * __must_check bpf_prog_add(struct bpf_prog *prog,
496 int i)
Brenden Blancocc2e0b32016-07-20 07:55:52 -0700497{
498 return ERR_PTR(-EOPNOTSUPP);
499}
Daniel Borkmann113214b2016-06-30 17:24:44 +0200500
Daniel Borkmannc5405942016-11-09 22:02:34 +0100501static inline void bpf_prog_sub(struct bpf_prog *prog, int i)
502{
503}
504
Daniel Borkmann0fc174d2015-03-01 12:31:44 +0100505static inline void bpf_prog_put(struct bpf_prog *prog)
506{
507}
Daniel Borkmann6d67942dd2016-11-19 01:45:03 +0100508
509static inline struct bpf_prog * __must_check bpf_prog_inc(struct bpf_prog *prog)
Alexei Starovoitovaa6a5f32016-09-01 18:37:24 -0700510{
511 return ERR_PTR(-EOPNOTSUPP);
512}
Daniel Borkmann5ccb0712016-12-18 01:52:58 +0100513
John Fastabenda6f6df62017-08-15 22:32:22 -0700514static inline struct bpf_prog *__must_check
515bpf_prog_inc_not_zero(struct bpf_prog *prog)
516{
517 return ERR_PTR(-EOPNOTSUPP);
518}
519
Daniel Borkmann5ccb0712016-12-18 01:52:58 +0100520static inline int __bpf_prog_charge(struct user_struct *user, u32 pages)
521{
522 return 0;
523}
524
525static inline void __bpf_prog_uncharge(struct user_struct *user, u32 pages)
526{
527}
John Fastabend46f55cf2017-07-17 21:56:48 -0700528
Chenbo Feng6e71b042017-10-18 13:00:22 -0700529static inline int bpf_obj_get_user(const char __user *pathname, int flags)
Shmulik Ladkani98589a02017-10-09 15:27:15 +0300530{
531 return -EOPNOTSUPP;
532}
533
John Fastabend46f55cf2017-07-17 21:56:48 -0700534static inline struct net_device *__dev_map_lookup_elem(struct bpf_map *map,
535 u32 key)
536{
537 return NULL;
538}
539
540static inline void __dev_map_insert_ctx(struct bpf_map *map, u32 index)
541{
542}
543
544static inline void __dev_map_flush(struct bpf_map *map)
545{
546}
Jesper Dangaard Brouer9c270af2017-10-16 12:19:34 +0200547
548static inline
549struct bpf_cpu_map_entry *__cpu_map_lookup_elem(struct bpf_map *map, u32 key)
550{
551 return NULL;
552}
553
554static inline void __cpu_map_insert_ctx(struct bpf_map *map, u32 index)
555{
556}
557
558static inline void __cpu_map_flush(struct bpf_map *map)
559{
560}
561
562struct xdp_buff;
563static inline int cpu_map_enqueue(struct bpf_cpu_map_entry *rcpu,
564 struct xdp_buff *xdp,
565 struct net_device *dev_rx)
566{
567 return 0;
568}
Al Viro040ee692017-12-02 20:20:38 -0500569
570static inline struct bpf_prog *bpf_prog_get_type_path(const char *name,
571 enum bpf_prog_type type)
572{
573 return ERR_PTR(-EOPNOTSUPP);
574}
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100575#endif /* CONFIG_BPF_SYSCALL */
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700576
Jakub Kicinski479321e2017-11-20 15:21:56 -0800577static inline struct bpf_prog *bpf_prog_get_type(u32 ufd,
578 enum bpf_prog_type type)
579{
580 return bpf_prog_get_type_dev(ufd, type, false);
581}
582
Al Viro040ee692017-12-02 20:20:38 -0500583bool bpf_prog_get_ok(struct bpf_prog *, enum bpf_prog_type *, bool);
584
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700585int bpf_prog_offload_compile(struct bpf_prog *prog);
586void bpf_prog_offload_destroy(struct bpf_prog *prog);
Jakub Kicinski675fc272017-12-27 18:39:09 -0800587int bpf_prog_offload_info_fill(struct bpf_prog_info *info,
588 struct bpf_prog *prog);
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700589
Jakub Kicinski52775b32018-01-17 19:13:28 -0800590int bpf_map_offload_info_fill(struct bpf_map_info *info, struct bpf_map *map);
591
Jakub Kicinskia3884572018-01-11 20:29:09 -0800592int bpf_map_offload_lookup_elem(struct bpf_map *map, void *key, void *value);
593int bpf_map_offload_update_elem(struct bpf_map *map,
594 void *key, void *value, u64 flags);
595int bpf_map_offload_delete_elem(struct bpf_map *map, void *key);
596int bpf_map_offload_get_next_key(struct bpf_map *map,
597 void *key, void *next_key);
598
599bool bpf_offload_dev_match(struct bpf_prog *prog, struct bpf_map *map);
600
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700601#if defined(CONFIG_NET) && defined(CONFIG_BPF_SYSCALL)
602int bpf_prog_offload_init(struct bpf_prog *prog, union bpf_attr *attr);
603
604static inline bool bpf_prog_is_dev_bound(struct bpf_prog_aux *aux)
605{
Jakub Kicinski9a18eed2017-12-27 18:39:04 -0800606 return aux->offload_requested;
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700607}
Jakub Kicinskia3884572018-01-11 20:29:09 -0800608
609static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
610{
611 return unlikely(map->ops == &bpf_map_offload_ops);
612}
613
614struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr);
615void bpf_map_offload_map_free(struct bpf_map *map);
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700616#else
617static inline int bpf_prog_offload_init(struct bpf_prog *prog,
618 union bpf_attr *attr)
619{
620 return -EOPNOTSUPP;
621}
622
623static inline bool bpf_prog_is_dev_bound(struct bpf_prog_aux *aux)
624{
625 return false;
626}
Jakub Kicinskia3884572018-01-11 20:29:09 -0800627
628static inline bool bpf_map_is_dev_bound(struct bpf_map *map)
629{
630 return false;
631}
632
633static inline struct bpf_map *bpf_map_offload_map_alloc(union bpf_attr *attr)
634{
635 return ERR_PTR(-EOPNOTSUPP);
636}
637
638static inline void bpf_map_offload_map_free(struct bpf_map *map)
639{
640}
Jakub Kicinskiab3f0062017-11-03 13:56:17 -0700641#endif /* CONFIG_NET && CONFIG_BPF_SYSCALL */
642
John Fastabend5f103c52018-01-03 17:57:56 -0800643#if defined(CONFIG_STREAM_PARSER) && defined(CONFIG_BPF_SYSCALL) && defined(CONFIG_INET)
John Fastabend6bdc9c42017-08-16 15:02:32 -0700644struct sock *__sock_map_lookup_elem(struct bpf_map *map, u32 key);
John Fastabend5a67da22017-09-08 14:00:49 -0700645int sock_map_prog(struct bpf_map *map, struct bpf_prog *prog, u32 type);
John Fastabend6bdc9c42017-08-16 15:02:32 -0700646#else
647static inline struct sock *__sock_map_lookup_elem(struct bpf_map *map, u32 key)
648{
649 return NULL;
650}
John Fastabend464bc0f2017-08-28 07:10:04 -0700651
John Fastabend5a67da22017-09-08 14:00:49 -0700652static inline int sock_map_prog(struct bpf_map *map,
653 struct bpf_prog *prog,
654 u32 type)
John Fastabend464bc0f2017-08-28 07:10:04 -0700655{
656 return -EOPNOTSUPP;
657}
John Fastabend6bdc9c42017-08-16 15:02:32 -0700658#endif
659
Alexei Starovoitovd0003ec2014-11-13 17:36:49 -0800660/* verifier prototypes for helper functions called from eBPF programs */
Daniel Borkmanna2c83ff2015-03-01 12:31:42 +0100661extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
662extern const struct bpf_func_proto bpf_map_update_elem_proto;
663extern const struct bpf_func_proto bpf_map_delete_elem_proto;
Alexei Starovoitovd0003ec2014-11-13 17:36:49 -0800664
Daniel Borkmann03e69b52015-03-14 02:27:16 +0100665extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
Daniel Borkmannc04167c2015-03-14 02:27:17 +0100666extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
Daniel Borkmann2d0e30c2016-10-21 12:46:33 +0200667extern const struct bpf_func_proto bpf_get_numa_node_id_proto;
Alexei Starovoitov04fd61ab2015-05-19 16:59:03 -0700668extern const struct bpf_func_proto bpf_tail_call_proto;
Daniel Borkmann17ca8cb2015-05-29 23:23:06 +0200669extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
Alexei Starovoitovffeedaf2015-06-12 19:39:12 -0700670extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
671extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
672extern const struct bpf_func_proto bpf_get_current_comm_proto;
Alexei Starovoitov4e10df92015-07-20 20:34:18 -0700673extern const struct bpf_func_proto bpf_skb_vlan_push_proto;
674extern const struct bpf_func_proto bpf_skb_vlan_pop_proto;
Alexei Starovoitovd5a3b1f2016-02-17 19:58:58 -0800675extern const struct bpf_func_proto bpf_get_stackid_proto;
John Fastabend174a79f2017-08-15 22:32:47 -0700676extern const struct bpf_func_proto bpf_sock_map_update_proto;
Daniel Borkmann03e69b52015-03-14 02:27:16 +0100677
Daniel Borkmann3ad00402015-10-08 01:20:39 +0200678/* Shared helpers among cBPF and eBPF. */
679void bpf_user_rnd_init_once(void);
680u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
681
Alexei Starovoitov99c55f72014-09-26 00:16:57 -0700682#endif /* _LINUX_BPF_H */