Allow bpf_user_ringbuf_drain() callbacks to return 1
Subsystems (4)
cover Allow bpf_user_ringbuf_drain() callbacks to return 1
The bpf_user_ringbuf_drain() helper function allows a BPF program to specify a callback that is invoked when draining entries from a BPF_MAP_TYPE_USER_RINGBUF ring buffer map. The API is meant to allow the callback to return 0 if it wants to continue draining samples, and 1 if it's done draining. Unfortunately, bpf_user_ringbuf_drain() landed shortly after commit 1bfe26fb0827 ("bpf: Add verifier support for custom callback return range"), which changed the default behavior of callbacks to only support returning 0, and the corresponding necessary change to bpf_user_ringbuf_drain() callbacks was missed.
This patch set fixes this oversight, and updates the user_ringbuf selftests to return 1 in a callback to catch future instances of regression.
This patch set should be merged to the bpf tree.
David Vernet (2):
bpf: Allow bpf_user_ringbuf_drain() callbacks to return 1 selftests/bpf: Make bpf_user_ringbuf_drain() selftest callback return
1
kernel/bpf/verifier.c | 1 + tools/testing/selftests/bpf/progs/user_ringbuf_success.c | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-)
Signature · 1 line
2.38.0
PATCH 1/2 bpf: Allow bpf_user_ringbuf_drain() callbacks to return 1
The bpf_user_ringbuf_drain() helper function allows a BPF program to specify a callback that is invoked when draining entries from a BPF_MAP_TYPE_USER_RINGBUF ring buffer map. The API is meant to allow the callback to return 0 if it wants to continue draining samples, and 1 if it's done draining. Unfortunately, bpf_user_ringbuf_drain() landed shortly after commit 1bfe26fb0827 ("bpf: Add verifier support for custom callback return range"), which changed the default behavior of callbacks to only support returning 0.
This patch corrects that oversight by allowing bpf_user_ringbuf_drain() callbacks to return 0 or 1. A follow-on patch will update the user_ringbuf selftests to also return 1 from a bpf_user_ringbuf_drain() callback to prevent this from regressing in the future.
--- kernel/bpf/verifier.c | 1 + 1 file changed, 1 insertion(+)
kernel/bpf/verifier.c +1 -0
@@ -6946,6 +6946,7 @@ static int set_user_ringbuf_callback_state(struct bpf_verifier_env *env,__mark_reg_not_init (env, &callee->regs[BPF_REG_5 ]); callee->in_callback_fn = true; + callee->callback_ret_range =tnum_range (0 ,1 );return 0 ; }
Signature · 1 line
2.38.0
PATCH 2/2 selftests/bpf: Make bpf_user_ringbuf_drain() selftest callback return 1
In reply to David VernetIn commit 1bfe26fb0827 ("bpf: Add verifier support for custom callback return range"), the verifier was updated to require callbacks to BPF helpers to explicitly specify the range of values that can be returned. bpf_user_ringbuf_drain() was merged after this in commit 205715673844 ("bpf: Add bpf_user_ringbuf_drain() helper"), and this change in default behavior was missed. This patch updates the BPF_MAP_TYPE_USER_RINGBUF selftests to also return 1 from a bpf_user_ringbuf_drain() callback so as to properly test this going forward.
--- tools/testing/selftests/bpf/progs/user_ringbuf_success.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
tools/testing/selftests/bpf/progs/user_ringbuf_success.c +2 -2
@@ -47,14 +47,14 @@ record_sample(struct bpf_dynptr *dynptr, void *context)if (status) {bpf_printk ("bpf_dynptr_read() failed: %d\n" , status); err =1 ; -return 0 ; +return 1 ; } }else { sample =bpf_dynptr_data (dynptr,0 ,sizeof (*sample));if (!sample) {bpf_printk ("Unexpectedly failed to get sample\n" ); err =2 ; -return 0 ; +return 1 ; } stack_sample = *sample; }
Signature · 1 line
2.38.0
Quoted 11 lines · David Vernet
The
bpf_user_ringbuf_drain()helper function allows a BPF program to specify a callback that is invoked when draining entries from aBPF_MAP_TYPE_USER_RINGBUFring buffer map. The API is meant to allow the callback to return 0 if it wants to continue draining samples, and 1 if it's done draining. Unfortunately,bpf_user_ringbuf_drain()landed shortly after commit1bfe26fb0827("bpf: Add verifier support for custom callback return range"), which changed the default behavior of callbacks to only support returning 0, and the corresponding necessary change tobpf_user_ringbuf_drain()callbacks was missed.
Quoted 5 lines
This patch set fixes this oversight, and updates the
user_ringbufselftests to return 1 in a callback to catch future instances of regression.This patch set should be merged to the bpf tree.
Please tag patch as [PATCH bpf x/N] next time. This will make it clear that it's targeted against the bpf tree and will let our CI know that it should be applied and tested in bpf (it chooses bpf-next by default).
Quoted 13 lines
David Vernet (2):
bpf: Allowbpf_user_ringbuf_drain()callbacks to return 1 selftests/bpf: Makebpf_user_ringbuf_drain()selftest callback return1kernel/bpf/verifier.c | 1 + tools/testing/selftests/bpf/progs/user_ringbuf_success.c | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-)--
2.38.0
This series was applied to bpf/bpf.git (master) by Andrii Nakryiko <[email protected]>:
Hello:
This series was applied to bpf/bpf.git (master)
by Andrii Nakryiko <[email protected]>:
Quoted 11 lines · On Wed, 12 Oct 2022 18:20:13 -0500 you wrote:
The
bpf_user_ringbuf_drain()helper function allows a BPF program to specify a callback that is invoked when draining entries from aBPF_MAP_TYPE_USER_RINGBUFring buffer map. The API is meant to allow the callback to return 0 if it wants to continue draining samples, and 1 if it's done draining. Unfortunately,bpf_user_ringbuf_drain()landed shortly after commit1bfe26fb0827("bpf: Add verifier support for custom callback return range"), which changed the default behavior of callbacks to only support returning 0, and the corresponding necessary change tobpf_user_ringbuf_drain()callbacks was missed.[...]
Here is the summary with links:
- [1/2] bpf: Allow bpf_user_ringbuf_drain() callbacks to return 1
https://git.kernel.org/bpf/bpf/c/c92a7a522438 - [2/2] selftests/bpf: Make bpf_user_ringbuf_drain() selftest callback return 1 https://git.kernel.org/bpf/bpf/c/6e44b9f375a3
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html