Skip to contentSkip to conversation

bpf: Add bpf_copy_from_user_str kfunc

PATCH Superseded Jordan Rome 2 participants 6 messages Aug 23, 2024

Subsystems (3)

v8 of 10 Superseded Latest is v10 →

lore
Share & tools
lore
#0 lore raw

PATCH v8 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 or failure.

---
 include/uapi/linux/bpf.h       |  9 ++++++++
 kernel/bpf/helpers.c           | 42 ++++++++++++++++++++++++++++++++++
 tools/include/uapi/linux/bpf.h |  9 ++++++++
 3 files changed, 60 insertions(+)
include/uapi/linux/bpf.h +9 -0
index e05b39e39c3f..8556f65da4f8 100644
@@ -7513,4 +7513,13 @@ struct bpf_iter_num {
 	__u64 __opaque[1];
 } __attribute__((aligned(8)));
 
+/*
+ * Flags to control bpf_copy_from_user_str() behaviour.
+ *     - BPF_F_PAD_ZEROS: Pad destination buffer with zeros. (See the respective
+ *       helper documentation for details.)
+ */
+enum {
+	BPF_F_PAD_ZEROS = (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 +9 -0
index e05b39e39c3f..8556f65da4f8 100644
@@ -7513,4 +7513,13 @@ struct bpf_iter_num {
 	__u64 __opaque[1];
 } __attribute__((aligned(8)));
 
+/*
+ * Flags to control bpf_copy_from_user_str() behaviour.
+ *     - BPF_F_PAD_ZEROS: Pad destination buffer with zeros. (See the respective
+ *       helper documentation for details.)
+ */
+enum {
+	BPF_F_PAD_ZEROS = (1ULL << 0),
+};
+
 #endif /* _UAPI__LINUX_BPF_H__ */

--
2.43.5

#1 lore raw

PATCH v8 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   | 57 ++++++++++++++++++-
 4 files changed, 68 insertions(+), 7 deletions(-)
tools/testing/selftests/bpf/prog_tests/attach_probe.c +5 -3
index 7175af39134f..329c7862b52d 100644
@@ -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
index 3405923fe4e6..c7b9ba8b1d06 100644
@@ -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
index 986f96687ae1..39ebef430059 100644
@@ -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 +54 -3

103 lines not on this page · raw message

--
2.43.5

#2 lore raw
In reply to Jordan Rome
Quoted 7 lines · Jordan Rome
kernel/bpf/helpers.c +6 -0
+/**
+ * bpf_copy_from_user_str() - Copy a string from an unsafe user address
+ * @dst:             Destination address, in kernel space.  This buffer must be at
+ *                   least @dst__szk bytes long.
+ * @dst__szk:        Maximum number of bytes to copy, including the trailing NUL.
+ * @unsafe_ptr__ign: Source address, in user space.

kernel/bpf/helpers.c __bpf_kfunc void bpf_iter_bits_destroy(struct bpf_iter_bits *it) · line 2957

Quoted 10 lines
kernel/bpf/helpers.c +10 -0
+ * @flags:           The only supported flag is BPF_F_PAD_ZEROS
+ *
+ * Copies a NUL-terminated string from userspace to BPF space. 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.
+ */
+__bpf_kfunc int bpf_copy_from_user_str(void *dst, u32 dst__szk, const void __user *unsafe_ptr__ign, u64 flags)

Did you miss my previous comment re __szk vs __sz ?

include/uapi/linux/bpf.h struct bpf_iter_num { · line 7523

Quoted 3 lines
include/uapi/linux/bpf.h +3 -0
+enum {
+       BPF_F_PAD_ZEROS = (1ULL << 0),
+};

Pls give enum a name, so it's easier for CORE logic to detect the presence of this feature in the kernel.

#3 lore raw
Quoted 13 lines · Alexei Starovoitov
Quoted 11 lines · Jordan Rome

+/**
+ * bpf_copy_from_user_str() - Copy a string from an unsafe user address

+ * @dst:             Destination address, in kernel space.  This buffer must be at
+ *                   least @dst__szk bytes long.
+ * @dst__szk:        Maximum number of bytes to copy, including the trailing NUL.

+ * @unsafe_ptr__ign: Source address, in user space.
+ * @flags: The only supported flag is BPF_F_PAD_ZEROS
+ *
+ * Copies a NUL-terminated string from userspace to BPF space. If user string is
+ * too long this will still ensure zero termination in the dst buffer unless

Quoted 9 lines
Quoted 6 lines

+ * 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.
+ */
+__bpf_kfunc int bpf_copy_from_user_str(void *dst, u32 dst__szk, const void __user *unsafe_ptr__ign, u64 flags)

Did you miss my previous comment re __szk vs __sz ?

Ah, yes, I did miss it. Will fix.

Quoted 6 lines

include/uapi/linux/bpf.h struct bpf_iter_num { · line 7523

Quoted 3 lines
include/uapi/linux/bpf.h +3 -0
+enum {
+       BPF_F_PAD_ZEROS = (1ULL << 0),
+};

Pls give enum a name, so it's easier for CORE logic to detect the presence of this feature in the kernel.

How about 'bpf_copy_str_flags' ? As I imagine we will use this flag on 'bpf_copy_from_user_task_str', when I add that.

#4 lore raw
Quoted 35 lines · Jordan Rome
Quoted 13 lines · Alexei Starovoitov
Quoted 11 lines · Jordan Rome

+/**
+ * bpf_copy_from_user_str() - Copy a string from an unsafe user address

+ * @dst:             Destination address, in kernel space.  This buffer must be at
+ *                   least @dst__szk bytes long.
+ * @dst__szk:        Maximum number of bytes to copy, including the trailing NUL.

+ * @unsafe_ptr__ign: Source address, in user space.
+ * @flags: The only supported flag is BPF_F_PAD_ZEROS
+ *
+ * Copies a NUL-terminated string from userspace to BPF space. If user string is
+ * too long this will still ensure zero termination in the dst buffer unless

Quoted 9 lines
Quoted 6 lines

+ * 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.
+ */
+__bpf_kfunc int bpf_copy_from_user_str(void *dst, u32 dst__szk, const void __user *unsafe_ptr__ign, u64 flags)

Did you miss my previous comment re __szk vs __sz ?

Ah, yes, I did miss it. Will fix.

Quoted 6 lines

include/uapi/linux/bpf.h struct bpf_iter_num { · line 7523

Quoted 3 lines
include/uapi/linux/bpf.h +3 -0
+enum {
+       BPF_F_PAD_ZEROS = (1ULL << 0),
+};

Pls give enum a name, so it's easier for CORE logic to detect the presence of this feature in the kernel.

Quoted 2 lines

How about 'bpf_copy_str_flags' ? As I imagine we will use this flag on 'bpf_copy_from_user_task_str', when I add that.

Maybe 'enum bpf_kfunc_flags' ?
since BPF_F_PAD_ZEROS is supposed to be generic and apply to various kfuncs.

#5 lore raw
Quoted 37 lines · Alexei Starovoitov
Quoted 35 lines · Jordan Rome
Quoted 13 lines · Alexei Starovoitov
Quoted 11 lines · Jordan Rome

+/**
+ * bpf_copy_from_user_str() - Copy a string from an unsafe user address

+ * @dst:             Destination address, in kernel space.  This buffer must be at
+ *                   least @dst__szk bytes long.
+ * @dst__szk:        Maximum number of bytes to copy, including the trailing NUL.

+ * @unsafe_ptr__ign: Source address, in user space.
+ * @flags: The only supported flag is BPF_F_PAD_ZEROS
+ *
+ * Copies a NUL-terminated string from userspace to BPF space. If user string is
+ * too long this will still ensure zero termination in the dst buffer unless

Quoted 9 lines
Quoted 6 lines

+ * 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.
+ */
+__bpf_kfunc int bpf_copy_from_user_str(void *dst, u32 dst__szk, const void __user *unsafe_ptr__ign, u64 flags)

Did you miss my previous comment re __szk vs __sz ?

Ah, yes, I did miss it. Will fix.

Quoted 6 lines

include/uapi/linux/bpf.h struct bpf_iter_num { · line 7523

Quoted 3 lines
include/uapi/linux/bpf.h +3 -0
+enum {
+       BPF_F_PAD_ZEROS = (1ULL << 0),
+};

Pls give enum a name, so it's easier for CORE logic to detect the presence of this feature in the kernel.

Quoted 5 lines
Quoted 2 lines

How about 'bpf_copy_str_flags' ? As I imagine we will use this flag on 'bpf_copy_from_user_task_str', when I add that.

Maybe 'enum bpf_kfunc_flags' ?
since BPF_F_PAD_ZEROS is supposed to be generic and apply to various kfuncs.

Works for me.