blob: de464e6683b68f247492d69a02b463f6bfb4b3df [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>
11#include <linux/workqueue.h>
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -070012#include <linux/file.h>
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070013
14struct bpf_map;
15
16/* map is generic key/value storage optionally accesible by eBPF programs */
17struct bpf_map_ops {
18 /* funcs callable from userspace (via syscall) */
19 struct bpf_map *(*map_alloc)(union bpf_attr *attr);
20 void (*map_free)(struct bpf_map *);
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -070021 int (*map_get_next_key)(struct bpf_map *map, void *key, void *next_key);
22
23 /* funcs callable from userspace and from eBPF programs */
24 void *(*map_lookup_elem)(struct bpf_map *map, void *key);
Alexei Starovoitov3274f522014-11-13 17:36:44 -080025 int (*map_update_elem)(struct bpf_map *map, void *key, void *value, u64 flags);
Alexei Starovoitovdb20fd22014-09-26 00:16:59 -070026 int (*map_delete_elem)(struct bpf_map *map, void *key);
Wang Nan2a36f0b2015-08-06 07:02:33 +000027
28 /* funcs called by prog_array and perf_event_array map */
29 void *(*map_fd_get_ptr) (struct bpf_map *map, int fd);
30 void (*map_fd_put_ptr) (void *ptr);
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070031};
32
33struct bpf_map {
34 atomic_t refcnt;
35 enum bpf_map_type map_type;
36 u32 key_size;
37 u32 value_size;
38 u32 max_entries;
Alexei Starovoitovaaac3ba2015-10-07 22:23:22 -070039 u32 pages;
40 struct user_struct *user;
Daniel Borkmanna2c83ff2015-03-01 12:31:42 +010041 const struct bpf_map_ops *ops;
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070042 struct work_struct work;
43};
44
45struct bpf_map_type_list {
46 struct list_head list_node;
Daniel Borkmanna2c83ff2015-03-01 12:31:42 +010047 const struct bpf_map_ops *ops;
Alexei Starovoitov99c55f72014-09-26 00:16:57 -070048 enum bpf_map_type type;
49};
50
Alexei Starovoitov17a52672014-09-26 00:17:06 -070051/* function argument constraints */
52enum bpf_arg_type {
Daniel Borkmann80f1d682015-03-12 17:21:42 +010053 ARG_DONTCARE = 0, /* unused argument in helper function */
Alexei Starovoitov17a52672014-09-26 00:17:06 -070054
55 /* the following constraints used to prototype
56 * bpf_map_lookup/update/delete_elem() functions
57 */
58 ARG_CONST_MAP_PTR, /* const argument used as pointer to bpf_map */
59 ARG_PTR_TO_MAP_KEY, /* pointer to stack used as map key */
60 ARG_PTR_TO_MAP_VALUE, /* pointer to stack used as map value */
61
62 /* the following constraints used to prototype bpf_memcmp() and other
63 * functions that access data on eBPF program stack
64 */
65 ARG_PTR_TO_STACK, /* any pointer to eBPF program stack */
66 ARG_CONST_STACK_SIZE, /* number of bytes accessed from stack */
Daniel Borkmann80f1d682015-03-12 17:21:42 +010067
Alexei Starovoitov608cd712015-03-26 19:53:57 -070068 ARG_PTR_TO_CTX, /* pointer to context */
Daniel Borkmann80f1d682015-03-12 17:21:42 +010069 ARG_ANYTHING, /* any (initialized) argument is ok */
Alexei Starovoitov17a52672014-09-26 00:17:06 -070070};
71
72/* type of values returned from helper functions */
73enum bpf_return_type {
74 RET_INTEGER, /* function returns integer */
75 RET_VOID, /* function doesn't return anything */
76 RET_PTR_TO_MAP_VALUE_OR_NULL, /* returns a pointer to map elem value or NULL */
77};
78
Alexei Starovoitov09756af2014-09-26 00:17:00 -070079/* eBPF function prototype used by verifier to allow BPF_CALLs from eBPF programs
80 * to in-kernel helper functions and for adjusting imm32 field in BPF_CALL
81 * instructions after verifying
82 */
83struct bpf_func_proto {
84 u64 (*func)(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
85 bool gpl_only;
Alexei Starovoitov17a52672014-09-26 00:17:06 -070086 enum bpf_return_type ret_type;
87 enum bpf_arg_type arg1_type;
88 enum bpf_arg_type arg2_type;
89 enum bpf_arg_type arg3_type;
90 enum bpf_arg_type arg4_type;
91 enum bpf_arg_type arg5_type;
92};
93
94/* bpf_context is intentionally undefined structure. Pointer to bpf_context is
95 * the first argument to eBPF programs.
96 * For socket filters: 'struct bpf_context *' == 'struct sk_buff *'
97 */
98struct bpf_context;
99
100enum bpf_access_type {
101 BPF_READ = 1,
102 BPF_WRITE = 2
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700103};
104
Alexei Starovoitovff936a02015-10-07 10:55:41 -0700105struct bpf_prog;
106
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700107struct bpf_verifier_ops {
108 /* return eBPF function prototype for verification */
109 const struct bpf_func_proto *(*get_func_proto)(enum bpf_func_id func_id);
Alexei Starovoitov17a52672014-09-26 00:17:06 -0700110
111 /* return true if 'size' wide access at offset 'off' within bpf_context
112 * with 'type' (read or write) is allowed
113 */
114 bool (*is_valid_access)(int off, int size, enum bpf_access_type type);
Alexei Starovoitov9bac3d62015-03-13 11:57:42 -0700115
Alexei Starovoitovd691f9e2015-06-04 10:11:54 -0700116 u32 (*convert_ctx_access)(enum bpf_access_type type, int dst_reg,
117 int src_reg, int ctx_off,
Alexei Starovoitovff936a02015-10-07 10:55:41 -0700118 struct bpf_insn *insn, struct bpf_prog *prog);
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700119};
120
121struct bpf_prog_type_list {
122 struct list_head list_node;
Daniel Borkmanna2c83ff2015-03-01 12:31:42 +0100123 const struct bpf_verifier_ops *ops;
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700124 enum bpf_prog_type type;
125};
126
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700127struct bpf_prog_aux {
128 atomic_t refcnt;
Daniel Borkmann24701ec2015-03-01 12:31:47 +0100129 u32 used_map_cnt;
Daniel Borkmanna2c83ff2015-03-01 12:31:42 +0100130 const struct bpf_verifier_ops *ops;
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700131 struct bpf_map **used_maps;
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700132 struct bpf_prog *prog;
Alexei Starovoitovaaac3ba2015-10-07 22:23:22 -0700133 struct user_struct *user;
Alexei Starovoitovabf2e7d2015-05-28 19:26:02 -0700134 union {
135 struct work_struct work;
136 struct rcu_head rcu;
137 };
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700138};
139
Alexei Starovoitov04fd61a2015-05-19 16:59:03 -0700140struct bpf_array {
141 struct bpf_map map;
142 u32 elem_size;
143 /* 'ownership' of prog_array is claimed by the first program that
144 * is going to use this map or by the first program which FD is stored
145 * in the map to make sure that all callers and callees have the same
146 * prog_type and JITed flag
147 */
148 enum bpf_prog_type owner_prog_type;
149 bool owner_jited;
150 union {
151 char value[0] __aligned(8);
Wang Nan2a36f0b2015-08-06 07:02:33 +0000152 void *ptrs[0] __aligned(8);
Alexei Starovoitov04fd61a2015-05-19 16:59:03 -0700153 };
154};
155#define MAX_TAIL_CALL_CNT 32
156
157u64 bpf_tail_call(u64 ctx, u64 r2, u64 index, u64 r4, u64 r5);
Wang Nan2a36f0b2015-08-06 07:02:33 +0000158void bpf_fd_array_map_clear(struct bpf_map *map);
Alexei Starovoitov04fd61a2015-05-19 16:59:03 -0700159bool bpf_prog_array_compatible(struct bpf_array *array, const struct bpf_prog *fp);
Alexei Starovoitov0756ea32015-06-12 19:39:13 -0700160const struct bpf_func_proto *bpf_get_trace_printk_proto(void);
Alexei Starovoitov04fd61a2015-05-19 16:59:03 -0700161
Alexei Starovoitov89aa0752014-12-01 15:06:35 -0800162#ifdef CONFIG_BPF_SYSCALL
Daniel Borkmann0fc174d2015-03-01 12:31:44 +0100163void bpf_register_prog_type(struct bpf_prog_type_list *tl);
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100164void bpf_register_map_type(struct bpf_map_type_list *tl);
Daniel Borkmann0fc174d2015-03-01 12:31:44 +0100165
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700166struct bpf_prog *bpf_prog_get(u32 ufd);
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100167void bpf_prog_put(struct bpf_prog *prog);
Alexei Starovoitovabf2e7d2015-05-28 19:26:02 -0700168void bpf_prog_put_rcu(struct bpf_prog *prog);
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100169
Daniel Borkmannb2197752015-10-29 14:58:09 +0100170struct bpf_map *bpf_map_get(u32 ufd);
Daniel Borkmannc2101292015-10-29 14:58:07 +0100171struct bpf_map *__bpf_map_get(struct fd f);
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100172void bpf_map_put(struct bpf_map *map);
173
Alexei Starovoitov1be7f752015-10-07 22:23:21 -0700174extern int sysctl_unprivileged_bpf_disabled;
175
Daniel Borkmannb2197752015-10-29 14:58:09 +0100176int bpf_map_new_fd(struct bpf_map *map);
177int bpf_prog_new_fd(struct bpf_prog *prog);
178
179int bpf_obj_pin_user(u32 ufd, const char __user *pathname);
180int bpf_obj_get_user(const char __user *pathname);
181
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100182/* verify correctness of eBPF program */
Alexei Starovoitov9bac3d62015-03-13 11:57:42 -0700183int bpf_check(struct bpf_prog **fp, union bpf_attr *attr);
Daniel Borkmann0fc174d2015-03-01 12:31:44 +0100184#else
185static inline void bpf_register_prog_type(struct bpf_prog_type_list *tl)
186{
187}
188
189static inline struct bpf_prog *bpf_prog_get(u32 ufd)
190{
191 return ERR_PTR(-EOPNOTSUPP);
192}
193
194static inline void bpf_prog_put(struct bpf_prog *prog)
195{
196}
Daniel Borkmann61e021f2015-03-02 15:21:55 +0100197#endif /* CONFIG_BPF_SYSCALL */
Alexei Starovoitov09756af2014-09-26 00:17:00 -0700198
Alexei Starovoitovd0003ec2014-11-13 17:36:49 -0800199/* verifier prototypes for helper functions called from eBPF programs */
Daniel Borkmanna2c83ff2015-03-01 12:31:42 +0100200extern const struct bpf_func_proto bpf_map_lookup_elem_proto;
201extern const struct bpf_func_proto bpf_map_update_elem_proto;
202extern const struct bpf_func_proto bpf_map_delete_elem_proto;
Alexei Starovoitovd0003ec2014-11-13 17:36:49 -0800203
Daniel Borkmann03e69b52015-03-14 02:27:16 +0100204extern const struct bpf_func_proto bpf_get_prandom_u32_proto;
Daniel Borkmannc04167c2015-03-14 02:27:17 +0100205extern const struct bpf_func_proto bpf_get_smp_processor_id_proto;
Alexei Starovoitov04fd61a2015-05-19 16:59:03 -0700206extern const struct bpf_func_proto bpf_tail_call_proto;
Daniel Borkmann17ca8cb2015-05-29 23:23:06 +0200207extern const struct bpf_func_proto bpf_ktime_get_ns_proto;
Alexei Starovoitovffeedaf2015-06-12 19:39:12 -0700208extern const struct bpf_func_proto bpf_get_current_pid_tgid_proto;
209extern const struct bpf_func_proto bpf_get_current_uid_gid_proto;
210extern const struct bpf_func_proto bpf_get_current_comm_proto;
Alexei Starovoitov4e10df92015-07-20 20:34:18 -0700211extern const struct bpf_func_proto bpf_skb_vlan_push_proto;
212extern const struct bpf_func_proto bpf_skb_vlan_pop_proto;
Daniel Borkmann03e69b52015-03-14 02:27:16 +0100213
Daniel Borkmann3ad00402015-10-08 01:20:39 +0200214/* Shared helpers among cBPF and eBPF. */
215void bpf_user_rnd_init_once(void);
216u64 bpf_user_rnd_u32(u64 r1, u64 r2, u64 r3, u64 r4, u64 r5);
217
Alexei Starovoitov99c55f72014-09-26 00:16:57 -0700218#endif /* _LINUX_BPF_H */