bpf: Add bpf_stream_print_stack kfunc
Subsystems (4)
Emil Tsalapatis
reviewercover bpf: Add bpf_stream_print_stack kfunc
Add a new bpf_stream_print_stack kfunc for printing a BPF program stack into a BPF stream. Update the verifier to allow the new kfunc to be called with BPF spinlocks held, along with bpf_stream_vprintk.
Patchset spun out of the larger libarena + ASAN patchset.
(https://lore.kernel.org/bpf/[email protected]/)
Changeset:
- Update bpf_stream_print_stack to take stream_id arg (Kumar)
- Added selftest for the bpf_stream_print_stack
- Add selftest for calling the streams kfuncs under lock
Emil Tsalapatis (4):
bpf: Add bpf_stream_print_stack stack dumping kfunc selftests/bpf: Add selftests for bpf_stream_print_stack
bpf: Allow BPF stream kfuncs while holding a lock selftests/bpf: Add selftests for stream functions under lock
kernel/bpf/helpers.c | 1 + kernel/bpf/stream.c | 19 ++++++++ kernel/bpf/verifier.c | 13 +++++- tools/testing/selftests/bpf/progs/stream.c | 53 ++++++++++++++++++++++ 4 files changed, 85 insertions(+), 1 deletion(-)
Signature · 1 line
2.49.0
Emil Tsalapatis
reviewerPATCH 1/4 bpf: Add bpf_stream_print_stack stack dumping kfunc
From: Emil Tsalapatis <[email protected]>
Add a new kfunc called bpf_stream_print_stack to be used by programs that need to print out their current BPF stack. The kfunc is essentially a wrapper around the existing bpf_stream_dump_stack functionality used to generate stack traces for error events like may_goto violations and BPF-side arena page faults.
--- kernel/bpf/helpers.c | 1 + kernel/bpf/stream.c | 19 +++++++++++++++++++ 2 files changed, 20 insertions(+)
kernel/bpf/helpers.c +1 -0
@@ -4562,6 +4562,7 @@ BTF_ID_FLAGS(func, bpf_strncasestr); BTF_ID_FLAGS(func, bpf_cgroup_read_xattr, KF_RCU)#endif BTF_ID_FLAGS(func, bpf_stream_vprintk, KF_IMPLICIT_ARGS) +BTF_ID_FLAGS(func, bpf_stream_print_stack, KF_IMPLICIT_ARGS) BTF_ID_FLAGS(func, bpf_task_work_schedule_signal, KF_IMPLICIT_ARGS) BTF_ID_FLAGS(func, bpf_task_work_schedule_resume, KF_IMPLICIT_ARGS)BTF_ID_FLAGS (func, bpf_dynptr_from_file)
kernel/bpf/stream.c +19 -0
@@ -245,6 +245,25 @@ __bpf_kfunc int bpf_stream_vprintk(int stream_id, const char *fmt__str, const voreturn ret; } +/* Directly trigger a stack dump from the program. */ +__bpf_kfunc int bpf_stream_print_stack(int stream_id, struct bpf_prog_aux *aux) +{ +struct bpf_stream_stage ss; +struct bpf_prog *prog; + +/* Make sure the stream ID is valid. */ +if (!bpf_stream_get (stream_id, aux)) +return -ENOENT ; + + prog = aux->main_prog_aux->prog; + +bpf_stream_stage (ss, prog, stream_id, ({ +bpf_stream_dump_stack (ss); + })); + +return 0 ; +} +__bpf_kfunc_end_defs ();/* Added kfunc to common_btf_ids */
Signature · 1 line
2.49.0
Re: [PATCH 1/4] bpf: Add bpf_stream_print_stack stack dumping kfunc
Quoted 10 lines · Emil Tsalapatis
From: Emil Tsalapatis <[email protected]>
Add a new kfunc called
bpf_stream_print_stackto be used by programs that need to print out their current BPF stack. The kfunc is essentially a wrapper around the existingbpf_stream_dump_stackfunctionality used to generate stack traces for error events likemay_gotoviolations and BPF-side arena page faults.Signed-off-by Emil Tsalapatis (Meta) <[email protected]>
Pls respin, since it fails check:
Commit 69310da6192e ("bpf: Add bpf_stream_print_stack stack dumping kfunc")
author Signed-off-by missing
author email: [email protected]
committer email: [email protected]
Author: must be the same as SOB:
pw-bot: cr
Emil Tsalapatis
reviewerRe: [PATCH 1/4] bpf: Add bpf_stream_print_stack stack dumping kfunc
Quoted 14 lines · Alexei Starovoitov
Quoted 10 lines · Emil Tsalapatis
From: Emil Tsalapatis <[email protected]>
Add a new kfunc called
bpf_stream_print_stackto be used by programs that need to print out their current BPF stack. The kfunc is essentially a wrapper around the existingbpf_stream_dump_stackfunctionality used to generate stack traces for error events likemay_gotoviolations and BPF-side arena page faults.Signed-off-by Emil Tsalapatis (Meta) <[email protected]>Pls respin, since it fails check:
Quoted 8 lines
Commit
69310da6192e("bpf: Addbpf_stream_print_stackstack dumping kfunc")
author Signed-off-by missing
author email: [email protected]
committer email: [email protected]Signed-off-by Emil Tsalapatis (Meta) <[email protected]>Signed-off-by Alexei Starovoitov <[email protected]>Author: must be the same as SOB:
Will do, sorry about that. I will also update the Signed-off-by for consistency.
Quoted 2 lines
pw-bot: cr
Emil Tsalapatis
reviewerPATCH 2/4 selftests/bpf: Add selftests for bpf_stream_print_stack
In reply to Emil TsalapatisAdd selftests for the new bpf_stream_print_stack kfunc.
--- tools/testing/selftests/bpf/progs/stream.c | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+)
tools/testing/selftests/bpf/progs/stream.c +21 -0
@@ -234,4 +234,25 @@ int stream_arena_callback_fault(void *ctx)return 0 ; } +SEC("syscall") +__arch_x86_64 +__arch_arm64 +__success __retval(0) +__stderr("CPU: {{[0-9]+}} UID: 0 PID: {{[0-9]+}} Comm: {{.*}}") +__stderr ("Call trace:\n" +"{{([a-zA-Z_][a-zA-Z0-9_]*\\+0x[0-9a-fA-F]+/0x[0-9a-fA-F]+\n" +"|[ \t]+[^\n]+\n)*}}") +int stream_print_stack_kfunc (void *ctx) +{ +return bpf_stream_print_stack (BPF_STDERR ); +} + +SEC("syscall") +__success __retval(-2) +int stream_print_stack_invalid_id(void *ctx) +{ +/* Try to pass an invalid stream ID. */ +return bpf_stream_print_stack ((enum bpf_stream_id )0xbadcafe ); +} + char _license[] SEC("license") = "GPL";
Signature · 1 line
2.49.0
Emil Tsalapatis
reviewerPATCH 3/4 bpf: Allow BPF stream kfuncs while holding a lock
In reply to Emil TsalapatisFrom: Emil Tsalapatis <[email protected]>
The BPF stream kfuncs bpf_stream_vprintk and bpf_stream_print_stack do not sleep and so are safe to call while holding a lock. Amend the verifier to allow that.
--- kernel/bpf/verifier.c | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-)
kernel/bpf/verifier.c +12 -1
@@ -12485,6 +12485,8 @@ enum special_kfunc_type { KF_bpf_arena_free_pages, KF_bpf_arena_reserve_pages, KF_bpf_session_is_return, + KF_bpf_stream_vprintk, + KF_bpf_stream_print_stack, };BTF_ID_LIST (special_kfunc_list)
@@ -12563,6 +12565,8 @@ BTF_ID(func, bpf_arena_alloc_pages) BTF_ID(func, bpf_arena_free_pages) BTF_ID(func, bpf_arena_reserve_pages) BTF_ID(func, bpf_session_is_return) +BTF_ID(func, bpf_stream_vprintk) +BTF_ID(func, bpf_stream_print_stack)static bool is_task_work_add_kfunc (u32 func_id) {
@@ -13007,10 +13011,17 @@ static bool is_bpf_arena_kfunc(u32 btf_id) btf_id == special_kfunc_list[KF_bpf_arena_reserve_pages]; } +static bool is_bpf_stream_kfunc (u32 btf_id) +{ +return btf_id == special_kfunc_list[KF_bpf_stream_vprintk] || + btf_id == special_kfunc_list[KF_bpf_stream_print_stack]; +} +static bool kfunc_spin_allowed (u32 btf_id) {return is_bpf_graph_api_kfunc (btf_id) ||is_bpf_iter_num_api_kfunc (btf_id) || -is_bpf_res_spin_lock_kfunc (btf_id) ||is_bpf_arena_kfunc (btf_id); +is_bpf_res_spin_lock_kfunc (btf_id) ||is_bpf_arena_kfunc (btf_id) || +is_bpf_stream_kfunc (btf_id); }static bool is_sync_callback_calling_kfunc (u32 btf_id)
Signature · 1 line
2.49.0
Emil Tsalapatis
reviewerPATCH 4/4 selftests/bpf: Add selftests for stream functions under lock
In reply to Emil TsalapatisAdd a selftest to ensure BPF stream functions can now be called while holding a lock.
--- tools/testing/selftests/bpf/progs/stream.c | 32 ++++++++++++++++++++++ 1 file changed, 32 insertions(+)
tools/testing/selftests/bpf/progs/stream.c +32 -0
@@ -42,6 +42,10 @@ int size;u64 fault_addr;void *arena_ptr; +#define private (name) SEC(".bss." #name) __hidden __attribute__((aligned(8))) + +private(STREAM) struct bpf_spin_lock block; + SEC("syscall") __success __retval(0) int stream_exhaust(void *ctx)
@@ -255,4 +259,32 @@ int stream_print_stack_invalid_id(void *ctx)return bpf_stream_print_stack ((enum bpf_stream_id )0xbadcafe ); } +SEC("syscall") +__arch_x86_64 +__arch_arm64 +__success __retval(0) +__stdout(_STR) +__stderr("CPU: {{[0-9]+}} UID: 0 PID: {{[0-9]+}} Comm: {{.*}}") +__stderr ("Call trace:\n" +"{{([a-zA-Z_][a-zA-Z0-9_]*\\+0x[0-9a-fA-F]+/0x[0-9a-fA-F]+\n" +"|[ \t]+[^\n]+\n)*}}") +int stream_print_kfuncs_locked (void *ctx) +{ +int ret; + +bpf_spin_lock (&block); + + ret =bpf_stream_printk (BPF_STDOUT , _STR); +if (ret) + goto out; + + ret =bpf_stream_print_stack (BPF_STDERR ); + +out: +bpf_spin_unlock (&block); + +return ret; +} + + char _license[] SEC("license") = "GPL";
Signature · 1 line
2.49.0
Quoted 13 lines · Emil Tsalapatis
Add a new
bpf_stream_print_stackkfunc for printing a BPF program stack into a BPF stream. Update the verifier to allow the new kfunc to be called with BPF spinlocks held, along withbpf_stream_vprintk.Patchset spun out of the larger libarena + ASAN patchset.
(https://lore.kernel.org/bpf/[email protected]/)Changeset:
- Updatebpf_stream_print_stackto takestream_idarg (Kumar)
- Added selftest for thebpf_stream_print_stack
- Add selftest for calling the streams kfuncs under lock
Quoted 9 lines
Cc Kumar Kartikeya Dwivedi <[email protected]>Signed-off-by Emil Tsalapatis (Meta) <[email protected]>Emil Tsalapatis (4):
bpf: Addbpf_stream_print_stackstack dumping kfunc selftests/bpf: Add selftests forbpf_stream_print_stack
bpf: Allow BPF stream kfuncs while holding a lock selftests/bpf: Add selftests for stream functions under lock
For the set:
Quoted 9 lines
kernel/bpf/helpers.c | 1 + kernel/bpf/stream.c | 19 ++++++++ kernel/bpf/verifier.c | 13 +++++- tools/testing/selftests/bpf/progs/stream.c | 53 ++++++++++++++++++++++ 4 files changed, 85 insertions(+), 1 deletion(-)--
2.49.0