libbpf: Define s390x syscall regs spec in bpf_tracing.h
[linux-block.git] / tools / lib / bpf / bpf_tracing.h
CommitLineData
3ac4dbe3
AN
1/* SPDX-License-Identifier: (LGPL-2.1 OR BSD-2-Clause) */
2#ifndef __BPF_TRACING_H__
3#define __BPF_TRACING_H__
4
6f5d467d
AN
5#include <bpf/bpf_helpers.h>
6
3ac4dbe3
AN
7/* Scan the ARCH passed in from ARCH env variable (see Makefile) */
8#if defined(__TARGET_ARCH_x86)
9 #define bpf_target_x86
10 #define bpf_target_defined
11#elif defined(__TARGET_ARCH_s390)
12 #define bpf_target_s390
13 #define bpf_target_defined
14#elif defined(__TARGET_ARCH_arm)
15 #define bpf_target_arm
16 #define bpf_target_defined
17#elif defined(__TARGET_ARCH_arm64)
18 #define bpf_target_arm64
19 #define bpf_target_defined
20#elif defined(__TARGET_ARCH_mips)
21 #define bpf_target_mips
22 #define bpf_target_defined
23#elif defined(__TARGET_ARCH_powerpc)
24 #define bpf_target_powerpc
25 #define bpf_target_defined
26#elif defined(__TARGET_ARCH_sparc)
27 #define bpf_target_sparc
28 #define bpf_target_defined
589fed47
BT
29#elif defined(__TARGET_ARCH_riscv)
30 #define bpf_target_riscv
31 #define bpf_target_defined
07385998
VI
32#elif defined(__TARGET_ARCH_arc)
33 #define bpf_target_arc
34 #define bpf_target_defined
00883922
HC
35#elif defined(__TARGET_ARCH_loongarch)
36 #define bpf_target_loongarch
37 #define bpf_target_defined
3ac4dbe3 38#else
3ac4dbe3
AN
39
40/* Fall back to what the compiler says */
3ac4dbe3
AN
41#if defined(__x86_64__)
42 #define bpf_target_x86
4a638d58 43 #define bpf_target_defined
3ac4dbe3
AN
44#elif defined(__s390__)
45 #define bpf_target_s390
4a638d58 46 #define bpf_target_defined
3ac4dbe3
AN
47#elif defined(__arm__)
48 #define bpf_target_arm
4a638d58 49 #define bpf_target_defined
3ac4dbe3
AN
50#elif defined(__aarch64__)
51 #define bpf_target_arm64
4a638d58 52 #define bpf_target_defined
3ac4dbe3
AN
53#elif defined(__mips__)
54 #define bpf_target_mips
4a638d58 55 #define bpf_target_defined
3ac4dbe3
AN
56#elif defined(__powerpc__)
57 #define bpf_target_powerpc
4a638d58 58 #define bpf_target_defined
3ac4dbe3
AN
59#elif defined(__sparc__)
60 #define bpf_target_sparc
4a638d58 61 #define bpf_target_defined
589fed47
BT
62#elif defined(__riscv) && __riscv_xlen == 64
63 #define bpf_target_riscv
64 #define bpf_target_defined
07385998
VI
65#elif defined(__arc__)
66 #define bpf_target_arc
67 #define bpf_target_defined
00883922
HC
68#elif defined(__loongarch__)
69 #define bpf_target_loongarch
70 #define bpf_target_defined
4a638d58
LB
71#endif /* no compiler target */
72
3ac4dbe3 73#endif
4a638d58
LB
74
75#ifndef __BPF_TARGET_MISSING
76#define __BPF_TARGET_MISSING "GCC error \"Must specify a BPF target arch via __TARGET_ARCH_xxx\""
3ac4dbe3
AN
77#endif
78
79#if defined(bpf_target_x86)
80
01329032
AN
81/*
82 * https://en.wikipedia.org/wiki/X86_calling_conventions#System_V_AMD64_ABI
83 */
84
fd56e005 85#if defined(__KERNEL__) || defined(__VMLINUX_H__)
b8ebce86 86
3cc31d79
AN
87#define __PT_PARM1_REG di
88#define __PT_PARM2_REG si
89#define __PT_PARM3_REG dx
90#define __PT_PARM4_REG cx
91#define __PT_PARM5_REG r8
01329032 92#define __PT_PARM6_REG r9
d21fbcee
AN
93/*
94 * Syscall uses r10 for PARM4. See arch/x86/entry/entry_64.S:entry_SYSCALL_64
95 * comments in Linux sources. And refer to syscall(2) manpage.
96 */
97#define __PT_PARM1_SYSCALL_REG __PT_PARM1_REG
98#define __PT_PARM2_SYSCALL_REG __PT_PARM2_REG
99#define __PT_PARM3_SYSCALL_REG __PT_PARM3_REG
100#define __PT_PARM4_SYSCALL_REG r10
101#define __PT_PARM5_SYSCALL_REG __PT_PARM5_REG
102#define __PT_PARM6_SYSCALL_REG __PT_PARM6_REG
103
3cc31d79
AN
104#define __PT_RET_REG sp
105#define __PT_FP_REG bp
106#define __PT_RC_REG ax
107#define __PT_SP_REG sp
108#define __PT_IP_REG ip
b8ebce86 109
3ac4dbe3 110#else
b8ebce86 111
3ac4dbe3 112#ifdef __i386__
b8ebce86 113
3c59623d 114/* i386 kernel is built with -mregparm=3 */
3cc31d79
AN
115#define __PT_PARM1_REG eax
116#define __PT_PARM2_REG edx
117#define __PT_PARM3_REG ecx
ff00f9cb
AN
118/* i386 syscall ABI is very different, refer to syscall(2) manpage */
119#define __PT_PARM1_SYSCALL_REG ebx
120#define __PT_PARM2_SYSCALL_REG ecx
121#define __PT_PARM3_SYSCALL_REG edx
122#define __PT_PARM4_SYSCALL_REG esi
123#define __PT_PARM5_SYSCALL_REG edi
124#define __PT_PARM6_SYSCALL_REG ebp
125
3cc31d79
AN
126#define __PT_RET_REG esp
127#define __PT_FP_REG ebp
128#define __PT_RC_REG eax
129#define __PT_SP_REG esp
130#define __PT_IP_REG eip
131
132#else /* __i386__ */
133
134#define __PT_PARM1_REG rdi
135#define __PT_PARM2_REG rsi
136#define __PT_PARM3_REG rdx
137#define __PT_PARM4_REG rcx
138#define __PT_PARM5_REG r8
01329032 139#define __PT_PARM6_REG r9
d21fbcee
AN
140
141#define __PT_PARM1_SYSCALL_REG __PT_PARM1_REG
142#define __PT_PARM2_SYSCALL_REG __PT_PARM2_REG
143#define __PT_PARM3_SYSCALL_REG __PT_PARM3_REG
144#define __PT_PARM4_SYSCALL_REG r10
145#define __PT_PARM5_SYSCALL_REG __PT_PARM5_REG
146#define __PT_PARM6_SYSCALL_REG __PT_PARM6_REG
147
3cc31d79
AN
148#define __PT_RET_REG rsp
149#define __PT_FP_REG rbp
150#define __PT_RC_REG rax
151#define __PT_SP_REG rsp
152#define __PT_IP_REG rip
153
154#endif /* __i386__ */
155
156#endif /* __KERNEL__ || __VMLINUX_H__ */
3ac4dbe3
AN
157
158#elif defined(bpf_target_s390)
159
e82b96a3
AN
160/*
161 * https://github.com/IBM/s390x-abi/releases/download/v1.6/lzsabi_s390x.pdf
162 */
163
1f22a6f9
IL
164struct pt_regs___s390 {
165 unsigned long orig_gpr2;
166};
167
3ac4dbe3 168/* s390 provides user_pt_regs instead of struct pt_regs to userspace */
3cc31d79
AN
169#define __PT_REGS_CAST(x) ((const user_pt_regs *)(x))
170#define __PT_PARM1_REG gprs[2]
171#define __PT_PARM2_REG gprs[3]
172#define __PT_PARM3_REG gprs[4]
173#define __PT_PARM4_REG gprs[5]
174#define __PT_PARM5_REG gprs[6]
e82b96a3
AN
175
176#define __PT_PARM1_SYSCALL_REG orig_gpr2
177#define __PT_PARM2_SYSCALL_REG __PT_PARM2_REG
178#define __PT_PARM3_SYSCALL_REG __PT_PARM3_REG
179#define __PT_PARM4_SYSCALL_REG __PT_PARM4_REG
180#define __PT_PARM5_SYSCALL_REG __PT_PARM5_REG
181#define __PT_PARM6_SYSCALL_REG gprs[7]
182#define PT_REGS_PARM1_SYSCALL(x) PT_REGS_PARM1_CORE_SYSCALL(x)
183#define PT_REGS_PARM1_CORE_SYSCALL(x) \
184 BPF_CORE_READ((const struct pt_regs___s390 *)(x), __PT_PARM1_SYSCALL_REG)
185
7244eb66 186#define __PT_RET_REG gprs[14]
3cc31d79
AN
187#define __PT_FP_REG gprs[11] /* Works only with CONFIG_FRAME_POINTER */
188#define __PT_RC_REG gprs[2]
189#define __PT_SP_REG gprs[15]
190#define __PT_IP_REG psw.addr
b8ebce86 191
3ac4dbe3
AN
192#elif defined(bpf_target_arm)
193
1dac40ac
AN
194/*
195 * https://github.com/ARM-software/abi-aa/blob/main/aapcs32/aapcs32.rst#machine-registers
196 */
197
3cc31d79
AN
198#define __PT_PARM1_REG uregs[0]
199#define __PT_PARM2_REG uregs[1]
200#define __PT_PARM3_REG uregs[2]
201#define __PT_PARM4_REG uregs[3]
3cc31d79
AN
202#define __PT_RET_REG uregs[14]
203#define __PT_FP_REG uregs[11] /* Works only with CONFIG_FRAME_POINTER */
204#define __PT_RC_REG uregs[0]
205#define __PT_SP_REG uregs[13]
206#define __PT_IP_REG uregs[12]
b8ebce86 207
3ac4dbe3
AN
208#elif defined(bpf_target_arm64)
209
1dac40ac
AN
210/*
211 * https://github.com/ARM-software/abi-aa/blob/main/aapcs64/aapcs64.rst#machine-registers
212 */
213
fbca4a2f
IL
214struct pt_regs___arm64 {
215 unsigned long orig_x0;
216};
217
3ac4dbe3 218/* arm64 provides struct user_pt_regs instead of struct pt_regs to userspace */
3cc31d79
AN
219#define __PT_REGS_CAST(x) ((const struct user_pt_regs *)(x))
220#define __PT_PARM1_REG regs[0]
221#define __PT_PARM2_REG regs[1]
222#define __PT_PARM3_REG regs[2]
223#define __PT_PARM4_REG regs[3]
224#define __PT_PARM5_REG regs[4]
1dac40ac
AN
225#define __PT_PARM6_REG regs[5]
226#define __PT_PARM7_REG regs[6]
227#define __PT_PARM8_REG regs[7]
3cc31d79
AN
228#define __PT_RET_REG regs[30]
229#define __PT_FP_REG regs[29] /* Works only with CONFIG_FRAME_POINTER */
230#define __PT_RC_REG regs[0]
231#define __PT_SP_REG sp
232#define __PT_IP_REG pc
6f5d467d 233#define PT_REGS_PARM1_SYSCALL(x) PT_REGS_PARM1_CORE_SYSCALL(x)
fbca4a2f 234#define PT_REGS_PARM1_CORE_SYSCALL(x) BPF_CORE_READ((const struct pt_regs___arm64 *)(x), orig_x0)
b8ebce86 235
3ac4dbe3
AN
236#elif defined(bpf_target_mips)
237
1222445a
AN
238/*
239 * N64 ABI is assumed right now.
240 * https://en.wikipedia.org/wiki/MIPS_architecture#Calling_conventions
241 */
242
3cc31d79
AN
243#define __PT_PARM1_REG regs[4]
244#define __PT_PARM2_REG regs[5]
245#define __PT_PARM3_REG regs[6]
246#define __PT_PARM4_REG regs[7]
247#define __PT_PARM5_REG regs[8]
1222445a
AN
248#define __PT_PARM6_REG regs[9]
249#define __PT_PARM7_REG regs[10]
250#define __PT_PARM8_REG regs[11]
3cc31d79
AN
251#define __PT_RET_REG regs[31]
252#define __PT_FP_REG regs[30] /* Works only with CONFIG_FRAME_POINTER */
253#define __PT_RC_REG regs[2]
254#define __PT_SP_REG regs[29]
255#define __PT_IP_REG cp0_epc
b8ebce86 256
3ac4dbe3
AN
257#elif defined(bpf_target_powerpc)
258
2eb2be30
AN
259/*
260 * http://refspecs.linux-foundation.org/elf/elfspec_ppc.pdf (page 3-14,
261 * section "Function Calling Sequence")
262 */
263
3cc31d79
AN
264#define __PT_PARM1_REG gpr[3]
265#define __PT_PARM2_REG gpr[4]
266#define __PT_PARM3_REG gpr[5]
267#define __PT_PARM4_REG gpr[6]
268#define __PT_PARM5_REG gpr[7]
2eb2be30
AN
269#define __PT_PARM6_REG gpr[8]
270#define __PT_PARM7_REG gpr[9]
271#define __PT_PARM8_REG gpr[10]
3cc31d79
AN
272#define __PT_RET_REG regs[31]
273#define __PT_FP_REG __unsupported__
274#define __PT_RC_REG gpr[3]
275#define __PT_SP_REG sp
276#define __PT_IP_REG nip
f07f1503
IL
277/* powerpc does not select ARCH_HAS_SYSCALL_WRAPPER. */
278#define PT_REGS_SYSCALL_REGS(ctx) ctx
b8ebce86 279
3ac4dbe3
AN
280#elif defined(bpf_target_sparc)
281
7f60f5d8
AN
282/*
283 * https://en.wikipedia.org/wiki/Calling_convention#SPARC
284 */
285
3cc31d79
AN
286#define __PT_PARM1_REG u_regs[UREG_I0]
287#define __PT_PARM2_REG u_regs[UREG_I1]
288#define __PT_PARM3_REG u_regs[UREG_I2]
289#define __PT_PARM4_REG u_regs[UREG_I3]
290#define __PT_PARM5_REG u_regs[UREG_I4]
7f60f5d8 291#define __PT_PARM6_REG u_regs[UREG_I5]
3cc31d79
AN
292#define __PT_RET_REG u_regs[UREG_I7]
293#define __PT_FP_REG __unsupported__
294#define __PT_RC_REG u_regs[UREG_I0]
295#define __PT_SP_REG u_regs[UREG_FP]
3ac4dbe3
AN
296/* Should this also be a bpf_target check for the sparc case? */
297#if defined(__arch64__)
3cc31d79 298#define __PT_IP_REG tpc
3ac4dbe3 299#else
3cc31d79 300#define __PT_IP_REG pc
3ac4dbe3
AN
301#endif
302
589fed47
BT
303#elif defined(bpf_target_riscv)
304
b13ed8ca
AN
305/*
306 * https://github.com/riscv-non-isa/riscv-elf-psabi-doc/blob/master/riscv-cc.adoc#risc-v-calling-conventions
307 */
308
3cc31d79
AN
309#define __PT_REGS_CAST(x) ((const struct user_regs_struct *)(x))
310#define __PT_PARM1_REG a0
311#define __PT_PARM2_REG a1
312#define __PT_PARM3_REG a2
313#define __PT_PARM4_REG a3
314#define __PT_PARM5_REG a4
b13ed8ca
AN
315#define __PT_PARM6_REG a5
316#define __PT_PARM7_REG a6
317#define __PT_PARM8_REG a7
3cc31d79 318#define __PT_RET_REG ra
5c101153 319#define __PT_FP_REG s0
935dc35c 320#define __PT_RC_REG a0
3cc31d79 321#define __PT_SP_REG sp
5c101153 322#define __PT_IP_REG pc
cf0b5b27
IL
323/* riscv does not select ARCH_HAS_SYSCALL_WRAPPER. */
324#define PT_REGS_SYSCALL_REGS(ctx) ctx
3cc31d79 325
07385998
VI
326#elif defined(bpf_target_arc)
327
0ac08656
AN
328/*
329 * Section "Function Calling Sequence" (page 24):
330 * https://raw.githubusercontent.com/wiki/foss-for-synopsys-dwc-arc-processors/toolchain/files/ARCv2_ABI.pdf
331 */
332
07385998
VI
333/* arc provides struct user_pt_regs instead of struct pt_regs to userspace */
334#define __PT_REGS_CAST(x) ((const struct user_regs_struct *)(x))
335#define __PT_PARM1_REG scratch.r0
336#define __PT_PARM2_REG scratch.r1
337#define __PT_PARM3_REG scratch.r2
338#define __PT_PARM4_REG scratch.r3
339#define __PT_PARM5_REG scratch.r4
0ac08656
AN
340#define __PT_PARM6_REG scratch.r5
341#define __PT_PARM7_REG scratch.r6
342#define __PT_PARM8_REG scratch.r7
07385998 343#define __PT_RET_REG scratch.blink
0ac08656 344#define __PT_FP_REG scratch.fp
07385998
VI
345#define __PT_RC_REG scratch.r0
346#define __PT_SP_REG scratch.sp
347#define __PT_IP_REG scratch.ret
348/* arc does not select ARCH_HAS_SYSCALL_WRAPPER. */
349#define PT_REGS_SYSCALL_REGS(ctx) ctx
350
00883922
HC
351#elif defined(bpf_target_loongarch)
352
55ff00d5
AN
353/*
354 * https://docs.kernel.org/loongarch/introduction.html
355 * https://loongson.github.io/LoongArch-Documentation/LoongArch-ELF-ABI-EN.html
356 */
00883922
HC
357
358#define __PT_PARM1_REG regs[4]
359#define __PT_PARM2_REG regs[5]
360#define __PT_PARM3_REG regs[6]
361#define __PT_PARM4_REG regs[7]
362#define __PT_PARM5_REG regs[8]
55ff00d5
AN
363#define __PT_PARM6_REG regs[9]
364#define __PT_PARM7_REG regs[10]
365#define __PT_PARM8_REG regs[11]
00883922
HC
366#define __PT_RET_REG regs[1]
367#define __PT_FP_REG regs[22]
368#define __PT_RC_REG regs[4]
369#define __PT_SP_REG regs[3]
370#define __PT_IP_REG csr_era
371/* loongarch does not select ARCH_HAS_SYSCALL_WRAPPER. */
372#define PT_REGS_SYSCALL_REGS(ctx) ctx
373
3cc31d79
AN
374#endif
375
376#if defined(bpf_target_defined)
377
589fed47 378struct pt_regs;
589fed47 379
3c59623d 380/* allow some architectures to override `struct pt_regs` */
3cc31d79
AN
381#ifndef __PT_REGS_CAST
382#define __PT_REGS_CAST(x) (x)
3ac4dbe3
AN
383#endif
384
3c59623d
AN
385/*
386 * Different architectures support different number of arguments passed
387 * through registers. i386 supports just 3, some arches support up to 8.
388 */
389#ifndef __PT_PARM4_REG
390#define __PT_PARM4_REG __unsupported__
391#endif
392#ifndef __PT_PARM5_REG
393#define __PT_PARM5_REG __unsupported__
394#endif
395#ifndef __PT_PARM6_REG
396#define __PT_PARM6_REG __unsupported__
397#endif
398#ifndef __PT_PARM7_REG
399#define __PT_PARM7_REG __unsupported__
400#endif
401#ifndef __PT_PARM8_REG
402#define __PT_PARM8_REG __unsupported__
403#endif
8ccabeef
AN
404/*
405 * Similarly, syscall-specific conventions might differ between function call
406 * conventions within each architecutre. All supported architectures pass
407 * either 6 or 7 syscall arguments in registers.
408 *
409 * See syscall(2) manpage for succinct table with information on each arch.
410 */
411#ifndef __PT_PARM1_SYSCALL_REG
412#define __PT_PARM1_SYSCALL_REG __PT_PARM1_REG
413#endif
414#ifndef __PT_PARM2_SYSCALL_REG
415#define __PT_PARM2_SYSCALL_REG __PT_PARM2_REG
416#endif
417#ifndef __PT_PARM3_SYSCALL_REG
418#define __PT_PARM3_SYSCALL_REG __PT_PARM3_REG
419#endif
420#ifndef __PT_PARM4_SYSCALL_REG
421#define __PT_PARM4_SYSCALL_REG __PT_PARM4_REG
422#endif
423#ifndef __PT_PARM5_SYSCALL_REG
424#define __PT_PARM5_SYSCALL_REG __PT_PARM5_REG
425#endif
426#ifndef __PT_PARM6_SYSCALL_REG
427#define __PT_PARM6_SYSCALL_REG __PT_PARM6_REG
428#endif
429#ifndef __PT_PARM7_SYSCALL_REG
430#define __PT_PARM7_SYSCALL_REG __unsupported__
431#endif
3c59623d 432
3cc31d79
AN
433#define PT_REGS_PARM1(x) (__PT_REGS_CAST(x)->__PT_PARM1_REG)
434#define PT_REGS_PARM2(x) (__PT_REGS_CAST(x)->__PT_PARM2_REG)
435#define PT_REGS_PARM3(x) (__PT_REGS_CAST(x)->__PT_PARM3_REG)
436#define PT_REGS_PARM4(x) (__PT_REGS_CAST(x)->__PT_PARM4_REG)
437#define PT_REGS_PARM5(x) (__PT_REGS_CAST(x)->__PT_PARM5_REG)
3c59623d
AN
438#define PT_REGS_PARM6(x) (__PT_REGS_CAST(x)->__PT_PARM6_REG)
439#define PT_REGS_PARM7(x) (__PT_REGS_CAST(x)->__PT_PARM7_REG)
440#define PT_REGS_PARM8(x) (__PT_REGS_CAST(x)->__PT_PARM8_REG)
3cc31d79
AN
441#define PT_REGS_RET(x) (__PT_REGS_CAST(x)->__PT_RET_REG)
442#define PT_REGS_FP(x) (__PT_REGS_CAST(x)->__PT_FP_REG)
443#define PT_REGS_RC(x) (__PT_REGS_CAST(x)->__PT_RC_REG)
444#define PT_REGS_SP(x) (__PT_REGS_CAST(x)->__PT_SP_REG)
445#define PT_REGS_IP(x) (__PT_REGS_CAST(x)->__PT_IP_REG)
446
447#define PT_REGS_PARM1_CORE(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_PARM1_REG)
448#define PT_REGS_PARM2_CORE(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_PARM2_REG)
449#define PT_REGS_PARM3_CORE(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_PARM3_REG)
450#define PT_REGS_PARM4_CORE(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_PARM4_REG)
451#define PT_REGS_PARM5_CORE(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_PARM5_REG)
3c59623d
AN
452#define PT_REGS_PARM6_CORE(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_PARM6_REG)
453#define PT_REGS_PARM7_CORE(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_PARM7_REG)
454#define PT_REGS_PARM8_CORE(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_PARM8_REG)
3cc31d79
AN
455#define PT_REGS_RET_CORE(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_RET_REG)
456#define PT_REGS_FP_CORE(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_FP_REG)
457#define PT_REGS_RC_CORE(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_RC_REG)
458#define PT_REGS_SP_CORE(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_SP_REG)
459#define PT_REGS_IP_CORE(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_IP_REG)
460
3ac4dbe3 461#if defined(bpf_target_powerpc)
3cc31d79 462
3ac4dbe3
AN
463#define BPF_KPROBE_READ_RET_IP(ip, ctx) ({ (ip) = (ctx)->link; })
464#define BPF_KRETPROBE_READ_RET_IP BPF_KPROBE_READ_RET_IP
3cc31d79 465
3ac4dbe3 466#elif defined(bpf_target_sparc)
3cc31d79 467
3ac4dbe3
AN
468#define BPF_KPROBE_READ_RET_IP(ip, ctx) ({ (ip) = PT_REGS_RET(ctx); })
469#define BPF_KRETPROBE_READ_RET_IP BPF_KPROBE_READ_RET_IP
3cc31d79
AN
470
471#else
472
3ac4dbe3 473#define BPF_KPROBE_READ_RET_IP(ip, ctx) \
70785cfb 474 ({ bpf_probe_read_kernel(&(ip), sizeof(ip), (void *)PT_REGS_RET(ctx)); })
3ac4dbe3 475#define BPF_KRETPROBE_READ_RET_IP(ip, ctx) \
3cc31d79
AN
476 ({ bpf_probe_read_kernel(&(ip), sizeof(ip), (void *)(PT_REGS_FP(ctx) + sizeof(ip))); })
477
3ac4dbe3
AN
478#endif
479
60d16c5c 480#ifndef PT_REGS_PARM1_SYSCALL
8ccabeef
AN
481#define PT_REGS_PARM1_SYSCALL(x) (__PT_REGS_CAST(x)->__PT_PARM1_SYSCALL_REG)
482#define PT_REGS_PARM1_CORE_SYSCALL(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_PARM1_SYSCALL_REG)
483#endif
484#ifndef PT_REGS_PARM2_SYSCALL
485#define PT_REGS_PARM2_SYSCALL(x) (__PT_REGS_CAST(x)->__PT_PARM2_SYSCALL_REG)
486#define PT_REGS_PARM2_CORE_SYSCALL(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_PARM2_SYSCALL_REG)
487#endif
488#ifndef PT_REGS_PARM3_SYSCALL
489#define PT_REGS_PARM3_SYSCALL(x) (__PT_REGS_CAST(x)->__PT_PARM3_SYSCALL_REG)
490#define PT_REGS_PARM3_CORE_SYSCALL(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_PARM3_SYSCALL_REG)
60d16c5c 491#endif
60d16c5c 492#ifndef PT_REGS_PARM4_SYSCALL
8ccabeef
AN
493#define PT_REGS_PARM4_SYSCALL(x) (__PT_REGS_CAST(x)->__PT_PARM4_SYSCALL_REG)
494#define PT_REGS_PARM4_CORE_SYSCALL(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_PARM4_SYSCALL_REG)
d084df3b 495#endif
8ccabeef
AN
496#ifndef PT_REGS_PARM5_SYSCALL
497#define PT_REGS_PARM5_SYSCALL(x) (__PT_REGS_CAST(x)->__PT_PARM5_SYSCALL_REG)
498#define PT_REGS_PARM5_CORE_SYSCALL(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_PARM5_SYSCALL_REG)
499#endif
500#ifndef PT_REGS_PARM6_SYSCALL
501#define PT_REGS_PARM6_SYSCALL(x) (__PT_REGS_CAST(x)->__PT_PARM6_SYSCALL_REG)
502#define PT_REGS_PARM6_CORE_SYSCALL(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_PARM6_SYSCALL_REG)
60d16c5c 503#endif
8ccabeef
AN
504#ifndef PT_REGS_PARM7_SYSCALL
505#define PT_REGS_PARM7_SYSCALL(x) (__PT_REGS_CAST(x)->__PT_PARM7_SYSCALL_REG)
506#define PT_REGS_PARM7_CORE_SYSCALL(x) BPF_CORE_READ(__PT_REGS_CAST(x), __PT_PARM7_SYSCALL_REG)
d084df3b 507#endif
d084df3b 508
3cc31d79 509#else /* defined(bpf_target_defined) */
4a638d58
LB
510
511#define PT_REGS_PARM1(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
512#define PT_REGS_PARM2(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
513#define PT_REGS_PARM3(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
514#define PT_REGS_PARM4(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
515#define PT_REGS_PARM5(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
3c59623d
AN
516#define PT_REGS_PARM6(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
517#define PT_REGS_PARM7(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
518#define PT_REGS_PARM8(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
4a638d58
LB
519#define PT_REGS_RET(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
520#define PT_REGS_FP(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
521#define PT_REGS_RC(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
522#define PT_REGS_SP(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
523#define PT_REGS_IP(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
524
525#define PT_REGS_PARM1_CORE(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
526#define PT_REGS_PARM2_CORE(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
527#define PT_REGS_PARM3_CORE(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
528#define PT_REGS_PARM4_CORE(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
529#define PT_REGS_PARM5_CORE(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
3c59623d
AN
530#define PT_REGS_PARM6_CORE(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
531#define PT_REGS_PARM7_CORE(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
532#define PT_REGS_PARM8_CORE(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
4a638d58
LB
533#define PT_REGS_RET_CORE(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
534#define PT_REGS_FP_CORE(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
535#define PT_REGS_RC_CORE(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
536#define PT_REGS_SP_CORE(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
537#define PT_REGS_IP_CORE(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
538
539#define BPF_KPROBE_READ_RET_IP(ip, ctx) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
540#define BPF_KRETPROBE_READ_RET_IP(ip, ctx) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
541
d084df3b
KT
542#define PT_REGS_PARM1_SYSCALL(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
543#define PT_REGS_PARM2_SYSCALL(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
544#define PT_REGS_PARM3_SYSCALL(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
545#define PT_REGS_PARM4_SYSCALL(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
546#define PT_REGS_PARM5_SYSCALL(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
8ccabeef
AN
547#define PT_REGS_PARM6_SYSCALL(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
548#define PT_REGS_PARM7_SYSCALL(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
d084df3b
KT
549
550#define PT_REGS_PARM1_CORE_SYSCALL(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
551#define PT_REGS_PARM2_CORE_SYSCALL(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
552#define PT_REGS_PARM3_CORE_SYSCALL(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
553#define PT_REGS_PARM4_CORE_SYSCALL(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
554#define PT_REGS_PARM5_CORE_SYSCALL(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
8ccabeef
AN
555#define PT_REGS_PARM6_CORE_SYSCALL(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
556#define PT_REGS_PARM7_CORE_SYSCALL(x) ({ _Pragma(__BPF_TARGET_MISSING); 0l; })
d084df3b 557
3cc31d79 558#endif /* defined(bpf_target_defined) */
4a638d58 559
c5a1ffa0
IL
560/*
561 * When invoked from a syscall handler kprobe, returns a pointer to a
562 * struct pt_regs containing syscall arguments and suitable for passing to
563 * PT_REGS_PARMn_SYSCALL() and PT_REGS_PARMn_CORE_SYSCALL().
564 */
565#ifndef PT_REGS_SYSCALL_REGS
566/* By default, assume that the arch selects ARCH_HAS_SYSCALL_WRAPPER. */
567#define PT_REGS_SYSCALL_REGS(ctx) ((struct pt_regs *)PT_REGS_PARM1(ctx))
568#endif
569
d6a6a555 570#ifndef ___bpf_concat
df8ff353 571#define ___bpf_concat(a, b) a ## b
d6a6a555
FR
572#endif
573#ifndef ___bpf_apply
df8ff353 574#define ___bpf_apply(fn, n) ___bpf_concat(fn, n)
d6a6a555
FR
575#endif
576#ifndef ___bpf_nth
df8ff353 577#define ___bpf_nth(_, _1, _2, _3, _4, _5, _6, _7, _8, _9, _a, _b, _c, N, ...) N
d6a6a555
FR
578#endif
579#ifndef ___bpf_narg
f60edf5b 580#define ___bpf_narg(...) ___bpf_nth(_, ##__VA_ARGS__, 12, 11, 10, 9, 8, 7, 6, 5, 4, 3, 2, 1, 0)
d6a6a555 581#endif
df8ff353 582
f60edf5b
AN
583#define ___bpf_ctx_cast0() ctx
584#define ___bpf_ctx_cast1(x) ___bpf_ctx_cast0(), (void *)ctx[0]
585#define ___bpf_ctx_cast2(x, args...) ___bpf_ctx_cast1(args), (void *)ctx[1]
586#define ___bpf_ctx_cast3(x, args...) ___bpf_ctx_cast2(args), (void *)ctx[2]
587#define ___bpf_ctx_cast4(x, args...) ___bpf_ctx_cast3(args), (void *)ctx[3]
588#define ___bpf_ctx_cast5(x, args...) ___bpf_ctx_cast4(args), (void *)ctx[4]
589#define ___bpf_ctx_cast6(x, args...) ___bpf_ctx_cast5(args), (void *)ctx[5]
590#define ___bpf_ctx_cast7(x, args...) ___bpf_ctx_cast6(args), (void *)ctx[6]
591#define ___bpf_ctx_cast8(x, args...) ___bpf_ctx_cast7(args), (void *)ctx[7]
592#define ___bpf_ctx_cast9(x, args...) ___bpf_ctx_cast8(args), (void *)ctx[8]
df8ff353
AN
593#define ___bpf_ctx_cast10(x, args...) ___bpf_ctx_cast9(args), (void *)ctx[9]
594#define ___bpf_ctx_cast11(x, args...) ___bpf_ctx_cast10(args), (void *)ctx[10]
595#define ___bpf_ctx_cast12(x, args...) ___bpf_ctx_cast11(args), (void *)ctx[11]
f60edf5b 596#define ___bpf_ctx_cast(args...) ___bpf_apply(___bpf_ctx_cast, ___bpf_narg(args))(args)
df8ff353
AN
597
598/*
599 * BPF_PROG is a convenience wrapper for generic tp_btf/fentry/fexit and
600 * similar kinds of BPF programs, that accept input arguments as a single
601 * pointer to untyped u64 array, where each u64 can actually be a typed
602 * pointer or integer of different size. Instead of requring user to write
603 * manual casts and work with array elements by index, BPF_PROG macro
604 * allows user to declare a list of named and typed input arguments in the
605 * same syntax as for normal C function. All the casting is hidden and
606 * performed transparently, while user code can just assume working with
607 * function arguments of specified type and name.
608 *
609 * Original raw context argument is preserved as well as 'ctx' argument.
610 * This is useful when using BPF helpers that expect original context
611 * as one of the parameters (e.g., for bpf_perf_event_output()).
612 */
613#define BPF_PROG(name, args...) \
614name(unsigned long long *ctx); \
d25f40ff 615static __always_inline typeof(name(0)) \
df8ff353
AN
616____##name(unsigned long long *ctx, ##args); \
617typeof(name(0)) name(unsigned long long *ctx) \
618{ \
619 _Pragma("GCC diagnostic push") \
620 _Pragma("GCC diagnostic ignored \"-Wint-conversion\"") \
621 return ____##name(___bpf_ctx_cast(args)); \
622 _Pragma("GCC diagnostic pop") \
623} \
d25f40ff 624static __always_inline typeof(name(0)) \
df8ff353
AN
625____##name(unsigned long long *ctx, ##args)
626
9f2f5d78
YS
627#ifndef ___bpf_nth2
628#define ___bpf_nth2(_, _1, _2, _3, _4, _5, _6, _7, _8, _9, _10, _11, _12, _13, \
629 _14, _15, _16, _17, _18, _19, _20, _21, _22, _23, _24, N, ...) N
34586d29 630#endif
9f2f5d78
YS
631#ifndef ___bpf_narg2
632#define ___bpf_narg2(...) \
633 ___bpf_nth2(_, ##__VA_ARGS__, 12, 12, 11, 11, 10, 10, 9, 9, 8, 8, 7, 7, \
634 6, 6, 5, 5, 4, 4, 3, 3, 2, 2, 1, 1, 0)
34586d29
YS
635#endif
636
9f2f5d78
YS
637#define ___bpf_treg_cnt(t) \
638 __builtin_choose_expr(sizeof(t) == 1, 1, \
639 __builtin_choose_expr(sizeof(t) == 2, 1, \
640 __builtin_choose_expr(sizeof(t) == 4, 1, \
641 __builtin_choose_expr(sizeof(t) == 8, 1, \
642 __builtin_choose_expr(sizeof(t) == 16, 2, \
34586d29
YS
643 (void)0)))))
644
9f2f5d78
YS
645#define ___bpf_reg_cnt0() (0)
646#define ___bpf_reg_cnt1(t, x) (___bpf_reg_cnt0() + ___bpf_treg_cnt(t))
647#define ___bpf_reg_cnt2(t, x, args...) (___bpf_reg_cnt1(args) + ___bpf_treg_cnt(t))
648#define ___bpf_reg_cnt3(t, x, args...) (___bpf_reg_cnt2(args) + ___bpf_treg_cnt(t))
649#define ___bpf_reg_cnt4(t, x, args...) (___bpf_reg_cnt3(args) + ___bpf_treg_cnt(t))
650#define ___bpf_reg_cnt5(t, x, args...) (___bpf_reg_cnt4(args) + ___bpf_treg_cnt(t))
651#define ___bpf_reg_cnt6(t, x, args...) (___bpf_reg_cnt5(args) + ___bpf_treg_cnt(t))
652#define ___bpf_reg_cnt7(t, x, args...) (___bpf_reg_cnt6(args) + ___bpf_treg_cnt(t))
653#define ___bpf_reg_cnt8(t, x, args...) (___bpf_reg_cnt7(args) + ___bpf_treg_cnt(t))
654#define ___bpf_reg_cnt9(t, x, args...) (___bpf_reg_cnt8(args) + ___bpf_treg_cnt(t))
655#define ___bpf_reg_cnt10(t, x, args...) (___bpf_reg_cnt9(args) + ___bpf_treg_cnt(t))
656#define ___bpf_reg_cnt11(t, x, args...) (___bpf_reg_cnt10(args) + ___bpf_treg_cnt(t))
657#define ___bpf_reg_cnt12(t, x, args...) (___bpf_reg_cnt11(args) + ___bpf_treg_cnt(t))
658#define ___bpf_reg_cnt(args...) ___bpf_apply(___bpf_reg_cnt, ___bpf_narg2(args))(args)
659
660#define ___bpf_union_arg(t, x, n) \
661 __builtin_choose_expr(sizeof(t) == 1, ({ union { __u8 z[1]; t x; } ___t = { .z = {ctx[n]}}; ___t.x; }), \
662 __builtin_choose_expr(sizeof(t) == 2, ({ union { __u16 z[1]; t x; } ___t = { .z = {ctx[n]} }; ___t.x; }), \
663 __builtin_choose_expr(sizeof(t) == 4, ({ union { __u32 z[1]; t x; } ___t = { .z = {ctx[n]} }; ___t.x; }), \
664 __builtin_choose_expr(sizeof(t) == 8, ({ union { __u64 z[1]; t x; } ___t = {.z = {ctx[n]} }; ___t.x; }), \
665 __builtin_choose_expr(sizeof(t) == 16, ({ union { __u64 z[2]; t x; } ___t = {.z = {ctx[n], ctx[n + 1]} }; ___t.x; }), \
666 (void)0)))))
667
668#define ___bpf_ctx_arg0(n, args...)
669#define ___bpf_ctx_arg1(n, t, x) , ___bpf_union_arg(t, x, n - ___bpf_reg_cnt1(t, x))
670#define ___bpf_ctx_arg2(n, t, x, args...) , ___bpf_union_arg(t, x, n - ___bpf_reg_cnt2(t, x, args)) ___bpf_ctx_arg1(n, args)
671#define ___bpf_ctx_arg3(n, t, x, args...) , ___bpf_union_arg(t, x, n - ___bpf_reg_cnt3(t, x, args)) ___bpf_ctx_arg2(n, args)
672#define ___bpf_ctx_arg4(n, t, x, args...) , ___bpf_union_arg(t, x, n - ___bpf_reg_cnt4(t, x, args)) ___bpf_ctx_arg3(n, args)
673#define ___bpf_ctx_arg5(n, t, x, args...) , ___bpf_union_arg(t, x, n - ___bpf_reg_cnt5(t, x, args)) ___bpf_ctx_arg4(n, args)
674#define ___bpf_ctx_arg6(n, t, x, args...) , ___bpf_union_arg(t, x, n - ___bpf_reg_cnt6(t, x, args)) ___bpf_ctx_arg5(n, args)
675#define ___bpf_ctx_arg7(n, t, x, args...) , ___bpf_union_arg(t, x, n - ___bpf_reg_cnt7(t, x, args)) ___bpf_ctx_arg6(n, args)
676#define ___bpf_ctx_arg8(n, t, x, args...) , ___bpf_union_arg(t, x, n - ___bpf_reg_cnt8(t, x, args)) ___bpf_ctx_arg7(n, args)
677#define ___bpf_ctx_arg9(n, t, x, args...) , ___bpf_union_arg(t, x, n - ___bpf_reg_cnt9(t, x, args)) ___bpf_ctx_arg8(n, args)
678#define ___bpf_ctx_arg10(n, t, x, args...) , ___bpf_union_arg(t, x, n - ___bpf_reg_cnt10(t, x, args)) ___bpf_ctx_arg9(n, args)
679#define ___bpf_ctx_arg11(n, t, x, args...) , ___bpf_union_arg(t, x, n - ___bpf_reg_cnt11(t, x, args)) ___bpf_ctx_arg10(n, args)
680#define ___bpf_ctx_arg12(n, t, x, args...) , ___bpf_union_arg(t, x, n - ___bpf_reg_cnt12(t, x, args)) ___bpf_ctx_arg11(n, args)
681#define ___bpf_ctx_arg(args...) ___bpf_apply(___bpf_ctx_arg, ___bpf_narg2(args))(___bpf_reg_cnt(args), args)
682
683#define ___bpf_ctx_decl0()
684#define ___bpf_ctx_decl1(t, x) , t x
685#define ___bpf_ctx_decl2(t, x, args...) , t x ___bpf_ctx_decl1(args)
686#define ___bpf_ctx_decl3(t, x, args...) , t x ___bpf_ctx_decl2(args)
687#define ___bpf_ctx_decl4(t, x, args...) , t x ___bpf_ctx_decl3(args)
688#define ___bpf_ctx_decl5(t, x, args...) , t x ___bpf_ctx_decl4(args)
689#define ___bpf_ctx_decl6(t, x, args...) , t x ___bpf_ctx_decl5(args)
690#define ___bpf_ctx_decl7(t, x, args...) , t x ___bpf_ctx_decl6(args)
691#define ___bpf_ctx_decl8(t, x, args...) , t x ___bpf_ctx_decl7(args)
692#define ___bpf_ctx_decl9(t, x, args...) , t x ___bpf_ctx_decl8(args)
693#define ___bpf_ctx_decl10(t, x, args...) , t x ___bpf_ctx_decl9(args)
694#define ___bpf_ctx_decl11(t, x, args...) , t x ___bpf_ctx_decl10(args)
695#define ___bpf_ctx_decl12(t, x, args...) , t x ___bpf_ctx_decl11(args)
696#define ___bpf_ctx_decl(args...) ___bpf_apply(___bpf_ctx_decl, ___bpf_narg2(args))(args)
34586d29
YS
697
698/*
9f2f5d78
YS
699 * BPF_PROG2 is an enhanced version of BPF_PROG in order to handle struct
700 * arguments. Since each struct argument might take one or two u64 values
701 * in the trampoline stack, argument type size is needed to place proper number
702 * of u64 values for each argument. Therefore, BPF_PROG2 has different
703 * syntax from BPF_PROG. For example, for the following BPF_PROG syntax:
704 *
705 * int BPF_PROG(test2, int a, int b) { ... }
706 *
707 * the corresponding BPF_PROG2 syntax is:
708 *
709 * int BPF_PROG2(test2, int, a, int, b) { ... }
710 *
711 * where type and the corresponding argument name are separated by comma.
712 *
713 * Use BPF_PROG2 macro if one of the arguments might be a struct/union larger
714 * than 8 bytes:
715 *
716 * int BPF_PROG2(test_struct_arg, struct bpf_testmod_struct_arg_1, a, int, b,
717 * int, c, int, d, struct bpf_testmod_struct_arg_2, e, int, ret)
718 * {
719 * // access a, b, c, d, e, and ret directly
720 * ...
721 * }
34586d29
YS
722 */
723#define BPF_PROG2(name, args...) \
724name(unsigned long long *ctx); \
725static __always_inline typeof(name(0)) \
9f2f5d78 726____##name(unsigned long long *ctx ___bpf_ctx_decl(args)); \
34586d29
YS
727typeof(name(0)) name(unsigned long long *ctx) \
728{ \
9f2f5d78 729 return ____##name(ctx ___bpf_ctx_arg(args)); \
34586d29
YS
730} \
731static __always_inline typeof(name(0)) \
9f2f5d78 732____##name(unsigned long long *ctx ___bpf_ctx_decl(args))
34586d29 733
df8ff353
AN
734struct pt_regs;
735
f60edf5b
AN
736#define ___bpf_kprobe_args0() ctx
737#define ___bpf_kprobe_args1(x) ___bpf_kprobe_args0(), (void *)PT_REGS_PARM1(ctx)
738#define ___bpf_kprobe_args2(x, args...) ___bpf_kprobe_args1(args), (void *)PT_REGS_PARM2(ctx)
739#define ___bpf_kprobe_args3(x, args...) ___bpf_kprobe_args2(args), (void *)PT_REGS_PARM3(ctx)
740#define ___bpf_kprobe_args4(x, args...) ___bpf_kprobe_args3(args), (void *)PT_REGS_PARM4(ctx)
741#define ___bpf_kprobe_args5(x, args...) ___bpf_kprobe_args4(args), (void *)PT_REGS_PARM5(ctx)
3c59623d
AN
742#define ___bpf_kprobe_args6(x, args...) ___bpf_kprobe_args5(args), (void *)PT_REGS_PARM6(ctx)
743#define ___bpf_kprobe_args7(x, args...) ___bpf_kprobe_args6(args), (void *)PT_REGS_PARM7(ctx)
744#define ___bpf_kprobe_args8(x, args...) ___bpf_kprobe_args7(args), (void *)PT_REGS_PARM8(ctx)
f60edf5b 745#define ___bpf_kprobe_args(args...) ___bpf_apply(___bpf_kprobe_args, ___bpf_narg(args))(args)
df8ff353
AN
746
747/*
748 * BPF_KPROBE serves the same purpose for kprobes as BPF_PROG for
749 * tp_btf/fentry/fexit BPF programs. It hides the underlying platform-specific
750 * low-level way of getting kprobe input arguments from struct pt_regs, and
751 * provides a familiar typed and named function arguments syntax and
752 * semantics of accessing kprobe input paremeters.
753 *
754 * Original struct pt_regs* context is preserved as 'ctx' argument. This might
755 * be necessary when using BPF helpers like bpf_perf_event_output().
756 */
757#define BPF_KPROBE(name, args...) \
758name(struct pt_regs *ctx); \
d25f40ff 759static __always_inline typeof(name(0)) \
df8ff353
AN
760____##name(struct pt_regs *ctx, ##args); \
761typeof(name(0)) name(struct pt_regs *ctx) \
762{ \
763 _Pragma("GCC diagnostic push") \
764 _Pragma("GCC diagnostic ignored \"-Wint-conversion\"") \
765 return ____##name(___bpf_kprobe_args(args)); \
766 _Pragma("GCC diagnostic pop") \
767} \
d25f40ff 768static __always_inline typeof(name(0)) \
df8ff353
AN
769____##name(struct pt_regs *ctx, ##args)
770
f60edf5b
AN
771#define ___bpf_kretprobe_args0() ctx
772#define ___bpf_kretprobe_args1(x) ___bpf_kretprobe_args0(), (void *)PT_REGS_RC(ctx)
773#define ___bpf_kretprobe_args(args...) ___bpf_apply(___bpf_kretprobe_args, ___bpf_narg(args))(args)
df8ff353
AN
774
775/*
776 * BPF_KRETPROBE is similar to BPF_KPROBE, except, it only provides optional
777 * return value (in addition to `struct pt_regs *ctx`), but no input
778 * arguments, because they will be clobbered by the time probed function
779 * returns.
780 */
781#define BPF_KRETPROBE(name, args...) \
782name(struct pt_regs *ctx); \
d25f40ff 783static __always_inline typeof(name(0)) \
df8ff353
AN
784____##name(struct pt_regs *ctx, ##args); \
785typeof(name(0)) name(struct pt_regs *ctx) \
786{ \
787 _Pragma("GCC diagnostic push") \
788 _Pragma("GCC diagnostic ignored \"-Wint-conversion\"") \
789 return ____##name(___bpf_kretprobe_args(args)); \
790 _Pragma("GCC diagnostic pop") \
791} \
792static __always_inline typeof(name(0)) ____##name(struct pt_regs *ctx, ##args)
793
6f5d467d 794/* If kernel has CONFIG_ARCH_HAS_SYSCALL_WRAPPER, read pt_regs directly */
816ae109 795#define ___bpf_syscall_args0() ctx
6f5d467d
AN
796#define ___bpf_syscall_args1(x) ___bpf_syscall_args0(), (void *)PT_REGS_PARM1_SYSCALL(regs)
797#define ___bpf_syscall_args2(x, args...) ___bpf_syscall_args1(args), (void *)PT_REGS_PARM2_SYSCALL(regs)
798#define ___bpf_syscall_args3(x, args...) ___bpf_syscall_args2(args), (void *)PT_REGS_PARM3_SYSCALL(regs)
799#define ___bpf_syscall_args4(x, args...) ___bpf_syscall_args3(args), (void *)PT_REGS_PARM4_SYSCALL(regs)
800#define ___bpf_syscall_args5(x, args...) ___bpf_syscall_args4(args), (void *)PT_REGS_PARM5_SYSCALL(regs)
8ccabeef
AN
801#define ___bpf_syscall_args6(x, args...) ___bpf_syscall_args5(args), (void *)PT_REGS_PARM6_SYSCALL(regs)
802#define ___bpf_syscall_args7(x, args...) ___bpf_syscall_args6(args), (void *)PT_REGS_PARM7_SYSCALL(regs)
816ae109
HC
803#define ___bpf_syscall_args(args...) ___bpf_apply(___bpf_syscall_args, ___bpf_narg(args))(args)
804
6f5d467d
AN
805/* If kernel doesn't have CONFIG_ARCH_HAS_SYSCALL_WRAPPER, we have to BPF_CORE_READ from pt_regs */
806#define ___bpf_syswrap_args0() ctx
807#define ___bpf_syswrap_args1(x) ___bpf_syswrap_args0(), (void *)PT_REGS_PARM1_CORE_SYSCALL(regs)
808#define ___bpf_syswrap_args2(x, args...) ___bpf_syswrap_args1(args), (void *)PT_REGS_PARM2_CORE_SYSCALL(regs)
809#define ___bpf_syswrap_args3(x, args...) ___bpf_syswrap_args2(args), (void *)PT_REGS_PARM3_CORE_SYSCALL(regs)
810#define ___bpf_syswrap_args4(x, args...) ___bpf_syswrap_args3(args), (void *)PT_REGS_PARM4_CORE_SYSCALL(regs)
811#define ___bpf_syswrap_args5(x, args...) ___bpf_syswrap_args4(args), (void *)PT_REGS_PARM5_CORE_SYSCALL(regs)
8ccabeef
AN
812#define ___bpf_syswrap_args6(x, args...) ___bpf_syswrap_args5(args), (void *)PT_REGS_PARM6_CORE_SYSCALL(regs)
813#define ___bpf_syswrap_args7(x, args...) ___bpf_syswrap_args6(args), (void *)PT_REGS_PARM7_CORE_SYSCALL(regs)
6f5d467d
AN
814#define ___bpf_syswrap_args(args...) ___bpf_apply(___bpf_syswrap_args, ___bpf_narg(args))(args)
815
816ae109 816/*
6f5d467d 817 * BPF_KSYSCALL is a variant of BPF_KPROBE, which is intended for
816ae109
HC
818 * tracing syscall functions, like __x64_sys_close. It hides the underlying
819 * platform-specific low-level way of getting syscall input arguments from
820 * struct pt_regs, and provides a familiar typed and named function arguments
821 * syntax and semantics of accessing syscall input parameters.
822 *
6f5d467d 823 * Original struct pt_regs * context is preserved as 'ctx' argument. This might
816ae109
HC
824 * be necessary when using BPF helpers like bpf_perf_event_output().
825 *
2d369b4b
IL
826 * At the moment BPF_KSYSCALL does not transparently handle all the calling
827 * convention quirks for the following syscalls:
828 *
829 * - mmap(): __ARCH_WANT_SYS_OLD_MMAP.
830 * - clone(): CONFIG_CLONE_BACKWARDS, CONFIG_CLONE_BACKWARDS2 and
831 * CONFIG_CLONE_BACKWARDS3.
832 * - socket-related syscalls: __ARCH_WANT_SYS_SOCKETCALL.
833 * - compat syscalls.
834 *
835 * This may or may not change in the future. User needs to take extra measures
836 * to handle such quirks explicitly, if necessary.
6f5d467d
AN
837 *
838 * This macro relies on BPF CO-RE support and virtual __kconfig externs.
816ae109 839 */
6f5d467d 840#define BPF_KSYSCALL(name, args...) \
816ae109 841name(struct pt_regs *ctx); \
6f5d467d 842extern _Bool LINUX_HAS_SYSCALL_WRAPPER __kconfig; \
d25f40ff 843static __always_inline typeof(name(0)) \
816ae109
HC
844____##name(struct pt_regs *ctx, ##args); \
845typeof(name(0)) name(struct pt_regs *ctx) \
846{ \
6f5d467d
AN
847 struct pt_regs *regs = LINUX_HAS_SYSCALL_WRAPPER \
848 ? (struct pt_regs *)PT_REGS_PARM1(ctx) \
849 : ctx; \
816ae109
HC
850 _Pragma("GCC diagnostic push") \
851 _Pragma("GCC diagnostic ignored \"-Wint-conversion\"") \
6f5d467d
AN
852 if (LINUX_HAS_SYSCALL_WRAPPER) \
853 return ____##name(___bpf_syswrap_args(args)); \
854 else \
855 return ____##name(___bpf_syscall_args(args)); \
816ae109
HC
856 _Pragma("GCC diagnostic pop") \
857} \
d25f40ff 858static __always_inline typeof(name(0)) \
816ae109
HC
859____##name(struct pt_regs *ctx, ##args)
860
6f5d467d
AN
861#define BPF_KPROBE_SYSCALL BPF_KSYSCALL
862
ac4afd6e
AN
863/* BPF_UPROBE and BPF_URETPROBE are identical to BPF_KPROBE and BPF_KRETPROBE,
864 * but are named way less confusingly for SEC("uprobe") and SEC("uretprobe")
865 * use cases.
866 */
867#define BPF_UPROBE(name, args...) BPF_KPROBE(name, ##args)
868#define BPF_URETPROBE(name, args...) BPF_KRETPROBE(name, ##args)
869
3ac4dbe3 870#endif