334d3e8c5e891691cb48d96b4f8d224876a27b94
[linux-2.6-block.git] / tools / testing / selftests / bpf / bpf_helpers.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef __BPF_HELPERS_H
3 #define __BPF_HELPERS_H
4
5 /* helper macro to place programs, maps, license in
6  * different sections in elf_bpf file. Section names
7  * are interpreted by elf_bpf loader
8  */
9 #define SEC(NAME) __attribute__((section(NAME), used))
10
11 /* helper functions called from eBPF programs written in C */
12 static void *(*bpf_map_lookup_elem)(void *map, void *key) =
13         (void *) BPF_FUNC_map_lookup_elem;
14 static int (*bpf_map_update_elem)(void *map, void *key, void *value,
15                                   unsigned long long flags) =
16         (void *) BPF_FUNC_map_update_elem;
17 static int (*bpf_map_delete_elem)(void *map, void *key) =
18         (void *) BPF_FUNC_map_delete_elem;
19 static int (*bpf_probe_read)(void *dst, int size, void *unsafe_ptr) =
20         (void *) BPF_FUNC_probe_read;
21 static unsigned long long (*bpf_ktime_get_ns)(void) =
22         (void *) BPF_FUNC_ktime_get_ns;
23 static int (*bpf_trace_printk)(const char *fmt, int fmt_size, ...) =
24         (void *) BPF_FUNC_trace_printk;
25 static void (*bpf_tail_call)(void *ctx, void *map, int index) =
26         (void *) BPF_FUNC_tail_call;
27 static unsigned long long (*bpf_get_smp_processor_id)(void) =
28         (void *) BPF_FUNC_get_smp_processor_id;
29 static unsigned long long (*bpf_get_current_pid_tgid)(void) =
30         (void *) BPF_FUNC_get_current_pid_tgid;
31 static unsigned long long (*bpf_get_current_uid_gid)(void) =
32         (void *) BPF_FUNC_get_current_uid_gid;
33 static int (*bpf_get_current_comm)(void *buf, int buf_size) =
34         (void *) BPF_FUNC_get_current_comm;
35 static unsigned long long (*bpf_perf_event_read)(void *map,
36                                                  unsigned long long flags) =
37         (void *) BPF_FUNC_perf_event_read;
38 static int (*bpf_clone_redirect)(void *ctx, int ifindex, int flags) =
39         (void *) BPF_FUNC_clone_redirect;
40 static int (*bpf_redirect)(int ifindex, int flags) =
41         (void *) BPF_FUNC_redirect;
42 static int (*bpf_redirect_map)(void *map, int key, int flags) =
43         (void *) BPF_FUNC_redirect_map;
44 static int (*bpf_perf_event_output)(void *ctx, void *map,
45                                     unsigned long long flags, void *data,
46                                     int size) =
47         (void *) BPF_FUNC_perf_event_output;
48 static int (*bpf_get_stackid)(void *ctx, void *map, int flags) =
49         (void *) BPF_FUNC_get_stackid;
50 static int (*bpf_probe_write_user)(void *dst, void *src, int size) =
51         (void *) BPF_FUNC_probe_write_user;
52 static int (*bpf_current_task_under_cgroup)(void *map, int index) =
53         (void *) BPF_FUNC_current_task_under_cgroup;
54 static int (*bpf_skb_get_tunnel_key)(void *ctx, void *key, int size, int flags) =
55         (void *) BPF_FUNC_skb_get_tunnel_key;
56 static int (*bpf_skb_set_tunnel_key)(void *ctx, void *key, int size, int flags) =
57         (void *) BPF_FUNC_skb_set_tunnel_key;
58 static int (*bpf_skb_get_tunnel_opt)(void *ctx, void *md, int size) =
59         (void *) BPF_FUNC_skb_get_tunnel_opt;
60 static int (*bpf_skb_set_tunnel_opt)(void *ctx, void *md, int size) =
61         (void *) BPF_FUNC_skb_set_tunnel_opt;
62 static unsigned long long (*bpf_get_prandom_u32)(void) =
63         (void *) BPF_FUNC_get_prandom_u32;
64 static int (*bpf_xdp_adjust_head)(void *ctx, int offset) =
65         (void *) BPF_FUNC_xdp_adjust_head;
66 static int (*bpf_xdp_adjust_meta)(void *ctx, int offset) =
67         (void *) BPF_FUNC_xdp_adjust_meta;
68 static int (*bpf_setsockopt)(void *ctx, int level, int optname, void *optval,
69                              int optlen) =
70         (void *) BPF_FUNC_setsockopt;
71 static int (*bpf_getsockopt)(void *ctx, int level, int optname, void *optval,
72                              int optlen) =
73         (void *) BPF_FUNC_getsockopt;
74 static int (*bpf_sock_ops_cb_flags_set)(void *ctx, int flags) =
75         (void *) BPF_FUNC_sock_ops_cb_flags_set;
76 static int (*bpf_sk_redirect_map)(void *ctx, void *map, int key, int flags) =
77         (void *) BPF_FUNC_sk_redirect_map;
78 static int (*bpf_sk_redirect_hash)(void *ctx, void *map, void *key, int flags) =
79         (void *) BPF_FUNC_sk_redirect_hash;
80 static int (*bpf_sock_map_update)(void *map, void *key, void *value,
81                                   unsigned long long flags) =
82         (void *) BPF_FUNC_sock_map_update;
83 static int (*bpf_sock_hash_update)(void *map, void *key, void *value,
84                                    unsigned long long flags) =
85         (void *) BPF_FUNC_sock_hash_update;
86 static int (*bpf_perf_event_read_value)(void *map, unsigned long long flags,
87                                         void *buf, unsigned int buf_size) =
88         (void *) BPF_FUNC_perf_event_read_value;
89 static int (*bpf_perf_prog_read_value)(void *ctx, void *buf,
90                                        unsigned int buf_size) =
91         (void *) BPF_FUNC_perf_prog_read_value;
92 static int (*bpf_override_return)(void *ctx, unsigned long rc) =
93         (void *) BPF_FUNC_override_return;
94 static int (*bpf_msg_redirect_map)(void *ctx, void *map, int key, int flags) =
95         (void *) BPF_FUNC_msg_redirect_map;
96 static int (*bpf_msg_redirect_hash)(void *ctx,
97                                     void *map, void *key, int flags) =
98         (void *) BPF_FUNC_msg_redirect_hash;
99 static int (*bpf_msg_apply_bytes)(void *ctx, int len) =
100         (void *) BPF_FUNC_msg_apply_bytes;
101 static int (*bpf_msg_cork_bytes)(void *ctx, int len) =
102         (void *) BPF_FUNC_msg_cork_bytes;
103 static int (*bpf_msg_pull_data)(void *ctx, int start, int end, int flags) =
104         (void *) BPF_FUNC_msg_pull_data;
105 static int (*bpf_bind)(void *ctx, void *addr, int addr_len) =
106         (void *) BPF_FUNC_bind;
107 static int (*bpf_xdp_adjust_tail)(void *ctx, int offset) =
108         (void *) BPF_FUNC_xdp_adjust_tail;
109 static int (*bpf_skb_get_xfrm_state)(void *ctx, int index, void *state,
110                                      int size, int flags) =
111         (void *) BPF_FUNC_skb_get_xfrm_state;
112 static int (*bpf_get_stack)(void *ctx, void *buf, int size, int flags) =
113         (void *) BPF_FUNC_get_stack;
114 static int (*bpf_fib_lookup)(void *ctx, struct bpf_fib_lookup *params,
115                              int plen, __u32 flags) =
116         (void *) BPF_FUNC_fib_lookup;
117 static int (*bpf_lwt_push_encap)(void *ctx, unsigned int type, void *hdr,
118                                  unsigned int len) =
119         (void *) BPF_FUNC_lwt_push_encap;
120 static int (*bpf_lwt_seg6_store_bytes)(void *ctx, unsigned int offset,
121                                        void *from, unsigned int len) =
122         (void *) BPF_FUNC_lwt_seg6_store_bytes;
123 static int (*bpf_lwt_seg6_action)(void *ctx, unsigned int action, void *param,
124                                   unsigned int param_len) =
125         (void *) BPF_FUNC_lwt_seg6_action;
126 static int (*bpf_lwt_seg6_adjust_srh)(void *ctx, unsigned int offset,
127                                       unsigned int len) =
128         (void *) BPF_FUNC_lwt_seg6_adjust_srh;
129
130 /* llvm builtin functions that eBPF C program may use to
131  * emit BPF_LD_ABS and BPF_LD_IND instructions
132  */
133 struct sk_buff;
134 unsigned long long load_byte(void *skb,
135                              unsigned long long off) asm("llvm.bpf.load.byte");
136 unsigned long long load_half(void *skb,
137                              unsigned long long off) asm("llvm.bpf.load.half");
138 unsigned long long load_word(void *skb,
139                              unsigned long long off) asm("llvm.bpf.load.word");
140
141 /* a helper structure used by eBPF C program
142  * to describe map attributes to elf_bpf loader
143  */
144 struct bpf_map_def {
145         unsigned int type;
146         unsigned int key_size;
147         unsigned int value_size;
148         unsigned int max_entries;
149         unsigned int map_flags;
150         unsigned int inner_map_idx;
151         unsigned int numa_node;
152 };
153
154 static int (*bpf_skb_load_bytes)(void *ctx, int off, void *to, int len) =
155         (void *) BPF_FUNC_skb_load_bytes;
156 static int (*bpf_skb_store_bytes)(void *ctx, int off, void *from, int len, int flags) =
157         (void *) BPF_FUNC_skb_store_bytes;
158 static int (*bpf_l3_csum_replace)(void *ctx, int off, int from, int to, int flags) =
159         (void *) BPF_FUNC_l3_csum_replace;
160 static int (*bpf_l4_csum_replace)(void *ctx, int off, int from, int to, int flags) =
161         (void *) BPF_FUNC_l4_csum_replace;
162 static int (*bpf_csum_diff)(void *from, int from_size, void *to, int to_size, int seed) =
163         (void *) BPF_FUNC_csum_diff;
164 static int (*bpf_skb_under_cgroup)(void *ctx, void *map, int index) =
165         (void *) BPF_FUNC_skb_under_cgroup;
166 static int (*bpf_skb_change_head)(void *, int len, int flags) =
167         (void *) BPF_FUNC_skb_change_head;
168 static int (*bpf_skb_pull_data)(void *, int len) =
169         (void *) BPF_FUNC_skb_pull_data;
170
171 /* Scan the ARCH passed in from ARCH env variable (see Makefile) */
172 #if defined(__TARGET_ARCH_x86)
173         #define bpf_target_x86
174         #define bpf_target_defined
175 #elif defined(__TARGET_ARCH_s930x)
176         #define bpf_target_s930x
177         #define bpf_target_defined
178 #elif defined(__TARGET_ARCH_arm64)
179         #define bpf_target_arm64
180         #define bpf_target_defined
181 #elif defined(__TARGET_ARCH_mips)
182         #define bpf_target_mips
183         #define bpf_target_defined
184 #elif defined(__TARGET_ARCH_powerpc)
185         #define bpf_target_powerpc
186         #define bpf_target_defined
187 #elif defined(__TARGET_ARCH_sparc)
188         #define bpf_target_sparc
189         #define bpf_target_defined
190 #else
191         #undef bpf_target_defined
192 #endif
193
194 /* Fall back to what the compiler says */
195 #ifndef bpf_target_defined
196 #if defined(__x86_64__)
197         #define bpf_target_x86
198 #elif defined(__s390x__)
199         #define bpf_target_s930x
200 #elif defined(__aarch64__)
201         #define bpf_target_arm64
202 #elif defined(__mips__)
203         #define bpf_target_mips
204 #elif defined(__powerpc__)
205         #define bpf_target_powerpc
206 #elif defined(__sparc__)
207         #define bpf_target_sparc
208 #endif
209 #endif
210
211 #if defined(bpf_target_x86)
212
213 #define PT_REGS_PARM1(x) ((x)->di)
214 #define PT_REGS_PARM2(x) ((x)->si)
215 #define PT_REGS_PARM3(x) ((x)->dx)
216 #define PT_REGS_PARM4(x) ((x)->cx)
217 #define PT_REGS_PARM5(x) ((x)->r8)
218 #define PT_REGS_RET(x) ((x)->sp)
219 #define PT_REGS_FP(x) ((x)->bp)
220 #define PT_REGS_RC(x) ((x)->ax)
221 #define PT_REGS_SP(x) ((x)->sp)
222 #define PT_REGS_IP(x) ((x)->ip)
223
224 #elif defined(bpf_target_s390x)
225
226 #define PT_REGS_PARM1(x) ((x)->gprs[2])
227 #define PT_REGS_PARM2(x) ((x)->gprs[3])
228 #define PT_REGS_PARM3(x) ((x)->gprs[4])
229 #define PT_REGS_PARM4(x) ((x)->gprs[5])
230 #define PT_REGS_PARM5(x) ((x)->gprs[6])
231 #define PT_REGS_RET(x) ((x)->gprs[14])
232 #define PT_REGS_FP(x) ((x)->gprs[11]) /* Works only with CONFIG_FRAME_POINTER */
233 #define PT_REGS_RC(x) ((x)->gprs[2])
234 #define PT_REGS_SP(x) ((x)->gprs[15])
235 #define PT_REGS_IP(x) ((x)->psw.addr)
236
237 #elif defined(bpf_target_arm64)
238
239 #define PT_REGS_PARM1(x) ((x)->regs[0])
240 #define PT_REGS_PARM2(x) ((x)->regs[1])
241 #define PT_REGS_PARM3(x) ((x)->regs[2])
242 #define PT_REGS_PARM4(x) ((x)->regs[3])
243 #define PT_REGS_PARM5(x) ((x)->regs[4])
244 #define PT_REGS_RET(x) ((x)->regs[30])
245 #define PT_REGS_FP(x) ((x)->regs[29]) /* Works only with CONFIG_FRAME_POINTER */
246 #define PT_REGS_RC(x) ((x)->regs[0])
247 #define PT_REGS_SP(x) ((x)->sp)
248 #define PT_REGS_IP(x) ((x)->pc)
249
250 #elif defined(bpf_target_mips)
251
252 #define PT_REGS_PARM1(x) ((x)->regs[4])
253 #define PT_REGS_PARM2(x) ((x)->regs[5])
254 #define PT_REGS_PARM3(x) ((x)->regs[6])
255 #define PT_REGS_PARM4(x) ((x)->regs[7])
256 #define PT_REGS_PARM5(x) ((x)->regs[8])
257 #define PT_REGS_RET(x) ((x)->regs[31])
258 #define PT_REGS_FP(x) ((x)->regs[30]) /* Works only with CONFIG_FRAME_POINTER */
259 #define PT_REGS_RC(x) ((x)->regs[1])
260 #define PT_REGS_SP(x) ((x)->regs[29])
261 #define PT_REGS_IP(x) ((x)->cp0_epc)
262
263 #elif defined(bpf_target_powerpc)
264
265 #define PT_REGS_PARM1(x) ((x)->gpr[3])
266 #define PT_REGS_PARM2(x) ((x)->gpr[4])
267 #define PT_REGS_PARM3(x) ((x)->gpr[5])
268 #define PT_REGS_PARM4(x) ((x)->gpr[6])
269 #define PT_REGS_PARM5(x) ((x)->gpr[7])
270 #define PT_REGS_RC(x) ((x)->gpr[3])
271 #define PT_REGS_SP(x) ((x)->sp)
272 #define PT_REGS_IP(x) ((x)->nip)
273
274 #elif defined(bpf_target_sparc)
275
276 #define PT_REGS_PARM1(x) ((x)->u_regs[UREG_I0])
277 #define PT_REGS_PARM2(x) ((x)->u_regs[UREG_I1])
278 #define PT_REGS_PARM3(x) ((x)->u_regs[UREG_I2])
279 #define PT_REGS_PARM4(x) ((x)->u_regs[UREG_I3])
280 #define PT_REGS_PARM5(x) ((x)->u_regs[UREG_I4])
281 #define PT_REGS_RET(x) ((x)->u_regs[UREG_I7])
282 #define PT_REGS_RC(x) ((x)->u_regs[UREG_I0])
283 #define PT_REGS_SP(x) ((x)->u_regs[UREG_FP])
284
285 /* Should this also be a bpf_target check for the sparc case? */
286 #if defined(__arch64__)
287 #define PT_REGS_IP(x) ((x)->tpc)
288 #else
289 #define PT_REGS_IP(x) ((x)->pc)
290 #endif
291
292 #endif
293
294 #ifdef bpf_target_powerpc
295 #define BPF_KPROBE_READ_RET_IP(ip, ctx)         ({ (ip) = (ctx)->link; })
296 #define BPF_KRETPROBE_READ_RET_IP               BPF_KPROBE_READ_RET_IP
297 #elif bpf_target_sparc
298 #define BPF_KPROBE_READ_RET_IP(ip, ctx)         ({ (ip) = PT_REGS_RET(ctx); })
299 #define BPF_KRETPROBE_READ_RET_IP               BPF_KPROBE_READ_RET_IP
300 #else
301 #define BPF_KPROBE_READ_RET_IP(ip, ctx)         ({                              \
302                 bpf_probe_read(&(ip), sizeof(ip), (void *)PT_REGS_RET(ctx)); })
303 #define BPF_KRETPROBE_READ_RET_IP(ip, ctx)      ({                              \
304                 bpf_probe_read(&(ip), sizeof(ip),                               \
305                                 (void *)(PT_REGS_FP(ctx) + sizeof(ip))); })
306 #endif
307
308 #endif