bpf: Add bpf_copy_from_user_task_str kfunc
Subsystems (4)
PATCH v3 2/3 bpf: Add bpf_copy_from_user_task_str kfunc
This new kfunc will be able to copy a string from another process's/task's address space. This is similar to bpf_copy_from_user_str but accepts a struct task_struct* argument.
--- kernel/bpf/helpers.c | 51 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+)
kernel/bpf/helpers.c +51 -0
@@ -3082,6 +3082,56 @@ __bpf_kfunc void bpf_local_irq_restore(unsigned long *flags__irq_flag)local_irq_restore (*flags__irq_flag); } +/** +* bpf_copy_from_user_task_str() - Copy a string from an task's address space +* @dst: Destination address, in kernel space. This buffer must be +* at least @dst__sz bytes long. +* @dst__sz: Maximum number of bytes to copy, includes the trailing NUL. +* @unsafe_ptr__ign: Source address in the task's address space. +* @tsk: The task whose address space will be used +* @flags: The only supported flag is BPF_F_PAD_ZEROS +* +* Copies a NULL-terminated string from a task's address space to *dst* buffer. +* If user string is too long this will still ensure zero termination in the +* dst buffer unless buffer size is 0. +* +* If BPF_F_PAD_ZEROS flag is set, memset the tail of @dst to 0 on success and +* memset all of @dst on failure. +* +* Return: The number of copied bytes on success, including the NULL-terminator. +* A negative error code on failure. +*/ +__bpf_kfunc int bpf_copy_from_user_task_str(void *dst, +u32 dst__sz, +const void __user *unsafe_ptr__ign, +struct task_struct *tsk, +u64 flags) +{ +int ret =0 ; + +if (unlikely (flags & ~BPF_F_PAD_ZEROS )) +return -EINVAL ; + +if (unlikely (!dst__sz)) +return 0 ; + + ret =copy_remote_vm_str (tsk, (unsigned long )unsafe_ptr__ign, dst, dst__sz,0 ); + +if (ret <=0 ) { +if (flags &BPF_F_PAD_ZEROS ) +memset (dst,0 , dst__sz); +return ret ?: -EINVAL ; + } + +if (ret < dst__sz) { +if (flags &BPF_F_PAD_ZEROS ) +memset (dst + ret,0 , dst__sz - ret); +return ret +1 ; + } + +return ret; +} +__bpf_kfunc_end_defs ();BTF_KFUNCS_START (generic_btf_ids)
@@ -3174,6 +3224,7 @@ BTF_ID_FLAGS(func, bpf_iter_bits_new, KF_ITER_NEW) BTF_ID_FLAGS(func, bpf_iter_bits_next, KF_ITER_NEXT | KF_RET_NULL) BTF_ID_FLAGS(func, bpf_iter_bits_destroy, KF_ITER_DESTROY) BTF_ID_FLAGS(func, bpf_copy_from_user_str, KF_SLEEPABLE) +BTF_ID_FLAGS(func, bpf_copy_from_user_task_str, KF_SLEEPABLE) BTF_ID_FLAGS(func, bpf_get_kmem_cache) BTF_ID_FLAGS(func, bpf_iter_kmem_cache_new, KF_ITER_NEW | KF_SLEEPABLE)BTF_ID_FLAGS (func, bpf_iter_kmem_cache_next,KF_ITER_NEXT |KF_RET_NULL |KF_SLEEPABLE )
--
2.43.5
PATCH v3 3/3 selftests/bpf: Add tests for bpf_copy_from_user_task_str
This adds tests for both the happy path and the error path (with and without the BPF_F_PAD_ZEROS flag).
--- .../selftests/bpf/prog_tests/bpf_iter.c | 68 ++++++++++++ .../selftests/bpf/prog_tests/read_vsyscall.c | 1 + .../selftests/bpf/progs/bpf_iter_tasks.c | 103 ++++++++++++++++++ .../selftests/bpf/progs/read_vsyscall.c | 11 +- 4 files changed, 181 insertions(+), 2 deletions(-)
tools/testing/selftests/bpf/prog_tests/bpf_iter.c +68 -0
@@ -323,19 +323,87 @@ static void test_task_pidfd(void)static void test_task_sleepable (void ) {struct bpf_iter_tasks *skel; +int pid, status, err, data_pipe[2 ], finish_pipe[2 ], c; +char *test_data =NULL ; +char *test_data_long =NULL ; +char *data[2 ]; + +if (!ASSERT_OK (pipe (data_pipe),"data_pipe" ) || + !ASSERT_OK (pipe (finish_pipe),"finish_pipe" )) +return ; skel =bpf_iter_tasks__open_and_load ();if (!ASSERT_OK_PTR (skel,"bpf_iter_tasks__open_and_load" ))return ; + pid =fork (); +if (!ASSERT_GE (pid,0 ,"fork" )) +return ; + +if (pid ==0 ) { +/* child */ +close (data_pipe[0 ]); +close (finish_pipe[1 ]); + + test_data =malloc (sizeof (char ) *10 ); +strncpy (test_data,"test_data" ,10 ); + test_data[9 ] ='\0' ; + + test_data_long =malloc (sizeof (char ) *5000 ); +for (int i =0 ; i <5000 ; ++i) { +if (i %2 ==0 ) + test_data_long[i] ='b' ; +else + test_data_long[i] ='a' ; + } + test_data_long[4999 ] ='\0' ; + + data[0 ] = test_data; + data[1 ] = test_data_long; + +write (data_pipe[1 ], &data,sizeof (data)); + +/* keep child alive until after the test */ + err =read (finish_pipe[0 ], &c,1 ); +if (err !=1 ) +exit (-1 ); + +close (data_pipe[1 ]); +close (finish_pipe[0 ]); +_exit (0 ); + } + +/* parent */ +close (data_pipe[1 ]); +close (finish_pipe[0 ]); + + err =read (data_pipe[0 ], &data,sizeof (data)); +ASSERT_EQ (err,sizeof (data),"read_check" ); + + skel->bss->user_ptr = data[0 ]; + skel->bss->user_ptr_long = data[1 ]; + skel->bss->pid = pid; +do_dummy_read (skel->progs.dump_task_sleepable);ASSERT_GT (skel->bss->num_expected_failure_copy_from_user_task,0 ,"num_expected_failure_copy_from_user_task" );ASSERT_GT (skel->bss->num_success_copy_from_user_task,0 ,"num_success_copy_from_user_task" ); +ASSERT_GT (skel->bss->num_expected_failure_copy_from_user_task_str,0 , +"num_expected_failure_copy_from_user_task_str" ); +ASSERT_GT (skel->bss->num_success_copy_from_user_task_str,0 , +"num_success_copy_from_user_task_str" );bpf_iter_tasks__destroy (skel); + +write (finish_pipe[1 ], &c,1 ); + err =waitpid (pid, &status,0 ); +ASSERT_EQ (err, pid,"waitpid" ); +ASSERT_EQ (status,0 ,"zero_child_exit" ); + +close (data_pipe[0 ]); +close (finish_pipe[1 ]); }static void test_task_stack (void )
tools/testing/selftests/bpf/prog_tests/read_vsyscall.c +1 -0
@@ -24,6 +24,7 @@ struct read_ret_desc { { .name = "copy_from_user", .ret = -EFAULT }, { .name = "copy_from_user_task", .ret = -EFAULT }, { .name = "copy_from_user_str", .ret = -EFAULT }, + { .name = "copy_from_user_task_str", .ret = -EFAULT }, };void test_read_vsyscall (void )
tools/testing/selftests/bpf/progs/bpf_iter_tasks.c +103 -0
130 lines not on this page · raw message
tools/testing/selftests/bpf/progs/read_vsyscall.c +9 -2
@@ -8,14 +8,16 @@int target_pid =0 ;void *user_ptr =0 ; -int read_ret[9 ]; +int read_ret[10 ]; char _license[] SEC("license") = "GPL";/* -* This is the only kfunc, the others are helpers +* These are the kfuncs, the others are helpers */ int bpf_copy_from_user_str(void *dst, u32, const void *, u64) __weak __ksym; +int bpf_copy_from_user_task_str(void *dst, u32, const void *, + struct task_struct *, u64) __weak __ksym; SEC("fentry/" SYS_PREFIX "sys_nanosleep")int do_probe_read (void *ctx)
@@ -47,6 +49,11 @@ int do_copy_from_user(void *ctx) 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 ); + read_ret[9 ] =bpf_copy_from_user_task_str ((char *)buf, +sizeof (buf), + user_ptr, +bpf_get_current_task_btf (), +0 );return 0 ; }
--
2.43.5
Quoted 26 lines · Jordan Rome
This new kfunc will be able to copy a string from another process's/task's address space. This is similar to
bpf_copy_from_user_strbut accepts astruct task_struct*argument.Signed-off-by Jordan Rome <[email protected]>--- kernel/bpf/helpers.c | 51 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+)kernel/bpf/helpers.c +7
-0@@ -3082,6 +3082,56 @@ __bpf_kfunc void bpf_local_irq_restore(unsigned long *flags__irq_flag)local_irq_restore (*flags__irq_flag); } +/** +* bpf_copy_from_user_task_str() - Copy a string from an task's address space +* @dst: Destination address, in kernel space. This buffer must be +* at least @dst__sz bytes long. +* @dst__sz: Maximum number of bytes to copy, includes the trailing NUL. +* @unsafe_ptr__ign: Source address in the task's address space. +* @tsk: The task whose address space will be used
kernel/bpf/helpers.c __bpf_kfunc void bpf_local_irq_restore(unsigned long *flags__irq_flag) · line 3101
Quoted 10 lines
kernel/bpf/helpers.c +10
-0+* @flags: The only supported flag is BPF_F_PAD_ZEROS +* +* Copies a NULL-terminated string from a task's address space to *dst* buffer. +* If user string is too long this will still ensure zero termination in the +* dst buffer unless buffer size is 0. +* +* If BPF_F_PAD_ZEROS flag is set, memset the tail of @dst to 0 on success and +* memset all of @dst on failure. +* +* Return: The number of copied bytes on success, including the NULL-terminator.
s/NULL/NUL/
Other than that, LGTM:
kernel/bpf/helpers.c __bpf_kfunc void bpf_local_irq_restore(unsigned long *flags__irq_flag) · line 3110
Quoted 9 lines
kernel/bpf/helpers.c +9
-0+* A negative error code on failure. +*/ +__bpf_kfunc int bpf_copy_from_user_task_str(void *dst, +u32 dst__sz, +const void __user *unsafe_ptr__ign, +struct task_struct *tsk, +u64 flags) +{ +int ret =0 ;
nit: no need to zero initialize, you'll overwrite it unconditionally below
Quoted 38 lines
kernel/bpf/helpers.c +25
-1+ +if (unlikely (flags & ~BPF_F_PAD_ZEROS )) +return -EINVAL ; + +if (unlikely (!dst__sz)) +return 0 ; + + ret =copy_remote_vm_str (tsk, (unsigned long )unsafe_ptr__ign, dst, dst__sz,0 ); + +if (ret <=0 ) { +if (flags &BPF_F_PAD_ZEROS ) +memset (dst,0 , dst__sz); +return ret ?: -EINVAL ; + } + +if (ret < dst__sz) { +if (flags &BPF_F_PAD_ZEROS ) +memset (dst + ret,0 , dst__sz - ret); +return ret +1 ; + } + +return ret; +} +__bpf_kfunc_end_defs ();BTF_KFUNCS_START (generic_btf_ids)@@ -3174,6 +3224,7 @@ BTF_ID_FLAGS(func, bpf_iter_bits_new, KF_ITER_NEW) BTF_ID_FLAGS(func, bpf_iter_bits_next, KF_ITER_NEXT | KF_RET_NULL) BTF_ID_FLAGS(func, bpf_iter_bits_destroy, KF_ITER_DESTROY) BTF_ID_FLAGS(func, bpf_copy_from_user_str, KF_SLEEPABLE) +BTF_ID_FLAGS(func, bpf_copy_from_user_task_str, KF_SLEEPABLE) BTF_ID_FLAGS(func, bpf_get_kmem_cache) BTF_ID_FLAGS(func, bpf_iter_kmem_cache_new, KF_ITER_NEW | KF_SLEEPABLE)BTF_ID_FLAGS (func, bpf_iter_kmem_cache_next,KF_ITER_NEXT |KF_RET_NULL |KF_SLEEPABLE ) --2.43.5