bpf: Add bpf_copy_from_user_str kfunc
Subsystems (3)
PATCH v4 1/2 bpf: Add bpf_copy_from_user_str kfunc
This adds a kfunc wrapper around strncpy_from_user, which can be called from sleepable BPF programs.
This matches the non-sleepable 'bpf_probe_read_user_str' helper except it includes an additional 'flags' param, which allows consumers to clear the entire destination buffer on success.
--- include/uapi/linux/bpf.h | 8 +++++++ kernel/bpf/helpers.c | 42 ++++++++++++++++++++++++++++++++++ tools/include/uapi/linux/bpf.h | 8 +++++++ 3 files changed, 58 insertions(+)
include/uapi/linux/bpf.h +8 -0
@@ -7513,4 +7513,12 @@ struct bpf_iter_num {__u64 __opaque[1 ]; } __attribute__((aligned(8))); +/* +* Flags to control bpf_copy_from_user_str() behaviour. +* - BPF_ZERO_BUFFER: Memset 0 the tail of the destination buffer on success +*/ +enum { +BPF_ZERO_BUFFER = (1ULL <<0 ) +}; +#endif /* _UAPI__LINUX_BPF_H__ */
kernel/bpf/helpers.c +42 -0
54 lines not on this page · raw message
tools/include/uapi/linux/bpf.h +8 -0
@@ -7513,4 +7513,12 @@ struct bpf_iter_num {__u64 __opaque[1 ]; } __attribute__((aligned(8))); +/* +* Flags to control bpf_copy_from_user_str() behaviour. +* - BPF_ZERO_BUFFER: Memset 0 the entire destination buffer on success +*/ +enum { +BPF_ZERO_BUFFER = (1ULL <<0 ) +}; +#endif /* _UAPI__LINUX_BPF_H__ */
--
2.43.5
PATCH v4 2/2 bpf: Add tests for bpf_copy_from_user_str kfunc
This adds tests for both the happy path and
the error path.
--- .../selftests/bpf/prog_tests/attach_probe.c | 8 ++-- .../selftests/bpf/prog_tests/read_vsyscall.c | 1 + .../selftests/bpf/progs/read_vsyscall.c | 9 ++++- .../selftests/bpf/progs/test_attach_probe.c | 38 +++++++++++++++++-- 4 files changed, 49 insertions(+), 7 deletions(-)
tools/testing/selftests/bpf/prog_tests/attach_probe.c +5 -3
@@ -283,9 +283,11 @@ static void test_uprobe_sleepable(struct test_attach_probe *skel)trigger_func3 ();ASSERT_EQ (skel->bss->uprobe_byname3_sleepable_res,9 ,"check_uprobe_byname3_sleepable_res" ); -ASSERT_EQ (skel->bss->uprobe_byname3_res,10 ,"check_uprobe_byname3_res" ); -ASSERT_EQ (skel->bss->uretprobe_byname3_sleepable_res,11 ,"check_uretprobe_byname3_sleepable_res" ); -ASSERT_EQ (skel->bss->uretprobe_byname3_res,12 ,"check_uretprobe_byname3_res" ); +ASSERT_EQ (skel->bss->uprobe_byname3_str_sleepable_res,10 ,"check_uprobe_byname3_str_sleepable_res" ); +ASSERT_EQ (skel->bss->uprobe_byname3_res,11 ,"check_uprobe_byname3_res" ); +ASSERT_EQ (skel->bss->uretprobe_byname3_sleepable_res,12 ,"check_uretprobe_byname3_sleepable_res" ); +ASSERT_EQ (skel->bss->uretprobe_byname3_str_sleepable_res,13 ,"check_uretprobe_byname3_str_sleepable_res" ); +ASSERT_EQ (skel->bss->uretprobe_byname3_res,14 ,"check_uretprobe_byname3_res" ); }void test_attach_probe (void )
tools/testing/selftests/bpf/prog_tests/read_vsyscall.c +1 -0
@@ -23,6 +23,7 @@ struct read_ret_desc { { .name = "probe_read_user_str", .ret = -EFAULT }, { .name = "copy_from_user", .ret = -EFAULT }, { .name = "copy_from_user_task", .ret = -EFAULT }, + { .name = "copy_from_user_str", .ret = -EFAULT }, };void test_read_vsyscall (void )
tools/testing/selftests/bpf/progs/read_vsyscall.c +8 -1
@@ -1,5 +1,6 @@// SPDX-License-Identifier: GPL-2.0 /* Copyright (C) 2024. Huawei Technologies Co., Ltd */ +#include "vmlinux.h" #include <linux/types.h> #include <bpf/bpf_helpers.h>
@@ -7,10 +8,15 @@int target_pid =0 ;void *user_ptr =0 ; -int read_ret[8 ]; +int read_ret[9 ]; char _license[] SEC("license") = "GPL"; +/* +* This is the only kfunc, the others are helpers +*/ +int bpf_copy_from_user_str(void *dst, u32, const void *, u64) __weak __ksym; + SEC("fentry/" SYS_PREFIX "sys_nanosleep")int do_probe_read (void *ctx) {
@@ -40,6 +46,7 @@ int do_copy_from_user(void *ctx) read_ret[6 ] =bpf_copy_from_user (buf,sizeof (buf), user_ptr); read_ret[7 ] =bpf_copy_from_user_task (buf,sizeof (buf), user_ptr,bpf_get_current_task_btf (),0 ); + read_ret[8 ] =bpf_copy_from_user_str ((char *)buf,sizeof (buf), user_ptr,0 );return 0 ; }
tools/testing/selftests/bpf/progs/test_attach_probe.c +35 -3
@@ -14,11 +14,15 @@ int uretprobe_byname_res = 0;int uprobe_byname2_res =0 ;int uretprobe_byname2_res =0 ;int uprobe_byname3_sleepable_res =0 ; +int uprobe_byname3_str_sleepable_res =0 ;int uprobe_byname3_res =0 ;int uretprobe_byname3_sleepable_res =0 ; +int uretprobe_byname3_str_sleepable_res =0 ;int uretprobe_byname3_res =0 ;void *user_ptr =0 ; +int bpf_copy_from_user_str(void *dst, u32, const void *, u64) __weak __ksym; + SEC("ksyscall/nanosleep")int BPF_KSYSCALL (handle_kprobe_auto ,struct __kernel_timespec *req,struct __kernel_timespec *rem) {
@@ -87,11 +91,37 @@ static __always_inline bool verify_sleepable_user_copy(void)return bpf_strncmp (data,sizeof (data),"test_data" ) ==0 ; } +static __always_inline bool verify_sleepable_user_copy_str(void) +{ +int ret; +char data_long[20 ]; +char data_short[4 ]; + + ret =bpf_copy_from_user_str (data_short,sizeof (data_short), user_ptr,0 ); + +if (bpf_strncmp (data_short,4 ,"tes\0" ) !=0 || ret !=4 ) +return false; + + ret =bpf_copy_from_user_str (data_long,sizeof (data_long), user_ptr,BPF_ZERO_BUFFER ); + +if (bpf_strncmp (data_long,10 ,"test_data\0" ) !=0 || ret !=10 || data_long[19 ] !='\0' ) +return false; + + ret =bpf_copy_from_user_str (data_long,sizeof (data_long), user_ptr,0 ); + +if (bpf_strncmp (data_long,10 ,"test_data\0" ) !=0 || ret !=10 ) +return false; + +return true; +} + SEC("uprobe.s//proc/self/exe:trigger_func3")int handle_uprobe_byname3_sleepable (struct pt_regs *ctx) {if (verify_sleepable_user_copy ()) uprobe_byname3_sleepable_res =9 ; +if (verify_sleepable_user_copy_str ()) + uprobe_byname3_str_sleepable_res =10 ;return 0 ; }
@@ -102,7 +132,7 @@ int handle_uprobe_byname3_sleepable(struct pt_regs *ctx) SEC("uprobe//proc/self/exe:trigger_func3")int handle_uprobe_byname3 (struct pt_regs *ctx) { - uprobe_byname3_res =10 ; + uprobe_byname3_res =11 ;return 0 ; }
@@ -110,14 +140,16 @@ SEC("uretprobe.s//proc/self/exe:trigger_func3")int handle_uretprobe_byname3_sleepable (struct pt_regs *ctx) {if (verify_sleepable_user_copy ()) - uretprobe_byname3_sleepable_res =11 ; + uretprobe_byname3_sleepable_res =12 ; +if (verify_sleepable_user_copy_str ()) + uretprobe_byname3_str_sleepable_res =13 ;return 0 ; } SEC("uretprobe//proc/self/exe:trigger_func3")int handle_uretprobe_byname3 (struct pt_regs *ctx) { - uretprobe_byname3_res =12 ; + uretprobe_byname3_res =14 ;return 0 ; }
--
2.43.5
kernel test robot
build botkernel test robot noticed the following build warnings:
Hi Jordan,
kernel test robot noticed the following build warnings:
[auto build test WARNING on bpf-next/master]
url: https://github.com/intel-lab-lkp/linux/commits/Jordan-Rome/bpf-Add-tests-for-bpf_copy_from_user_str-kfunc/20240814-232043 base: https://git.kernel.org/pub/scm/linux/kernel/git/bpf/bpf-next.git master patch link: https://lore.kernel.org/r/20240814004531.352157-1-linux%40jordanrome.com patch subject: [bpf-next v4 1/2] bpf: Add bpf_copy_from_user_str kfunc config: x86_64-buildonly-randconfig-002-20240815 (https://download.01.org/0day-ci/archive/20240815/[email protected]/config) compiler: gcc-11 (Debian 11.3.0-12) 11.3.0 reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240815/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
All warnings (new ones prefixed by >>):
kernel/bpf/helpers.c: In function 'bpf_copy_from_user_str':
>> kernel/bpf/helpers.c:2972:20: warning: suggest explicit braces to avoid ambiguous 'else' [-Wdangling-else]
2972 | if (ret <= count)
| ^
vim +/else +2972 kernel/bpf/helpers.c
2941
2942 /**
2943 * bpf_copy_from_user_str() - Copy a string from an unsafe user address
2944 * @dst: Destination address, in kernel space. This buffer must be at
2945 * least @dst__szk bytes long.
2946 * @dst__szk: Maximum number of bytes to copy, including the trailing NUL.
2947 * @unsafe_ptr__ign: Source address, in user space.
2948 * @flags: The only supported flag is BPF_ZERO_BUFFER
2949 *
2950 * Copies a NUL-terminated string from userspace to BPF space. If user string is
2951 * too long this will still ensure zero termination in the dst buffer unless
2952 * buffer size is 0.
2953 *
2954 * If BPF_ZERO_BUFFER flag is set, memset the tail of @dst to 0 on success.
2955 */
2956 __bpf_kfunc int bpf_copy_from_user_str(void *dst, u32 dst__szk, const void __user *unsafe_ptr__ign, u64 flags)
2957 {
2958 int ret;
2959 int count;
2960
2961 if (unlikely(!dst__szk))
2962 return 0;
2963
2964 count = dst__szk - 1;
2965 if (unlikely(!count)) {
2966 ((char *)dst)[0] = '\0';
2967 return 1;
2968 }
2969
2970 ret = strncpy_from_user(dst, unsafe_ptr__ign, count);
2971 if (ret >= 0) {
> 2972 if (ret <= count) 2973 if (flags & BPF_ZERO_BUFFER)
2974 memset((char *)dst + ret, 0, dst__szk - ret);
2975 else
2976 ((char *)dst)[ret] = '\0';
2977 ret++;
2978 }
2979
2980 return ret;
2981 }
2982
Signature · 2 lines
0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests/wiki
kernel test robot
build botkernel test robot noticed the following build warnings:
Hi Jordan,
kernel test robot noticed the following build warnings:
[auto build test WARNING on bpf-next/master]
url: https://github.com/intel-lab-lkp/linux/commits/Jordan-Rome/bpf-Add-tests-for-bpf_copy_from_user_str-kfunc/20240814-232043 base: https://git.kernel.org/pub/scm/linux/kernel/git/bpf/bpf-next.git master patch link: https://lore.kernel.org/r/20240814004531.352157-1-linux%40jordanrome.com patch subject: [bpf-next v4 1/2] bpf: Add bpf_copy_from_user_str kfunc config: i386-buildonly-randconfig-002-20240815 (https://download.01.org/0day-ci/archive/20240815/[email protected]/config) compiler: clang version 18.1.5 (https://github.com/llvm/llvm-project 617a15a9eac96088ae5e9134248d8236e34b91b1) reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240815/[email protected]/reproduce)
If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
All warnings (new ones prefixed by >>):
>> kernel/bpf/helpers.c:2975:4: warning: add explicit braces to avoid dangling else [-Wdangling-else]
2975 | else
| ^1 warning generated.
vim +2975 kernel/bpf/helpers.c
2941
2942 /**
2943 * bpf_copy_from_user_str() - Copy a string from an unsafe user address
2944 * @dst: Destination address, in kernel space. This buffer must be at
2945 * least @dst__szk bytes long.
2946 * @dst__szk: Maximum number of bytes to copy, including the trailing NUL.
2947 * @unsafe_ptr__ign: Source address, in user space.
2948 * @flags: The only supported flag is BPF_ZERO_BUFFER
2949 *
2950 * Copies a NUL-terminated string from userspace to BPF space. If user string is
2951 * too long this will still ensure zero termination in the dst buffer unless
2952 * buffer size is 0.
2953 *
2954 * If BPF_ZERO_BUFFER flag is set, memset the tail of @dst to 0 on success.
2955 */
2956 __bpf_kfunc int bpf_copy_from_user_str(void *dst, u32 dst__szk, const void __user *unsafe_ptr__ign, u64 flags)
2957 {
2958 int ret;
2959 int count;
2960
2961 if (unlikely(!dst__szk))
2962 return 0;
2963
2964 count = dst__szk - 1;
2965 if (unlikely(!count)) {
2966 ((char *)dst)[0] = '\0';
2967 return 1;
2968 }
2969
2970 ret = strncpy_from_user(dst, unsafe_ptr__ign, count);
2971 if (ret >= 0) {
2972 if (ret <= count)
2973 if (flags & BPF_ZERO_BUFFER)
2974 memset((char *)dst + ret, 0, dst__szk - ret);
> 2975 else 2976 ((char *)dst)[ret] = '\0';
2977 ret++;
2978 }
2979
2980 return ret;
2981 }
2982
Signature · 2 lines
0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests/wiki