Skip to content

Commit e8763fb

Browse files
viktormalikAlexei Starovoitov
viktormalik
authored and
Alexei Starovoitov
committed
selftests/bpf: Add tests for string kfuncs
Add both positive and negative tests cases using string kfuncs added in the previous patches. Positive tests check that the functions work as expected. Negative tests pass various incorrect strings to the kfuncs and check for the expected error codes: -E2BIG when passing too long strings -EFAULT when trying to read inaccessible kernel memory -ERANGE when passing userspace pointers on arches with non-overlapping address spaces A majority of the tests use the RUN_TESTS helper which executes BPF programs with BPF_PROG_TEST_RUN and check for the expected return value. An exception to this are tests for long strings as we need to memset the long string from userspace (at least I haven't found an ergonomic way to memset it from a BPF program), which cannot be done using the RUN_TESTS infrastructure. Suggested-by: Eduard Zingerman <[email protected]> Signed-off-by: Viktor Malik <[email protected]> Link: https://lore.kernel.org/r/090451a2e60c9ae1dceb4d1bfafa3479db5c7481.1750917800.git.vmalik@redhat.com Signed-off-by: Alexei Starovoitov <[email protected]>
1 parent a55b7d3 commit e8763fb

File tree

4 files changed

+212
-0
lines changed

4 files changed

+212
-0
lines changed

‎tools/testing/selftests/bpf/prog_tests/string_kfuncs.c

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
// SPDX-License-Identifier: GPL-2.0
2+
/* Copyright (C) 2025 Red Hat, Inc.*/
3+
#include <test_progs.h>
4+
#include "string_kfuncs_success.skel.h"
5+
#include "string_kfuncs_failure1.skel.h"
6+
#include "string_kfuncs_failure2.skel.h"
7+
#include <sys/mman.h>
8+
9+
static const char * const test_cases[] = {
10+
"strcmp",
11+
"strchr",
12+
"strchrnul",
13+
"strnchr",
14+
"strrchr",
15+
"strlen",
16+
"strnlen",
17+
"strspn_str",
18+
"strspn_accept",
19+
"strcspn_str",
20+
"strcspn_reject",
21+
"strstr",
22+
"strnstr",
23+
};
24+
25+
void run_too_long_tests(void)
26+
{
27+
struct string_kfuncs_failure2 *skel;
28+
struct bpf_program *prog;
29+
char test_name[256];
30+
int err, i;
31+
32+
skel = string_kfuncs_failure2__open_and_load();
33+
if (!ASSERT_OK_PTR(skel, "string_kfuncs_failure2__open_and_load"))
34+
return;
35+
36+
memset(skel->bss->long_str, 'a', sizeof(skel->bss->long_str));
37+
38+
for (i = 0; i < ARRAY_SIZE(test_cases); i++) {
39+
sprintf(test_name, "test_%s_too_long", test_cases[i]);
40+
if (!test__start_subtest(test_name))
41+
continue;
42+
43+
prog = bpf_object__find_program_by_name(skel->obj, test_name);
44+
if (!ASSERT_OK_PTR(prog, "bpf_object__find_program_by_name"))
45+
goto cleanup;
46+
47+
LIBBPF_OPTS(bpf_test_run_opts, topts);
48+
err = bpf_prog_test_run_opts(bpf_program__fd(prog), &topts);
49+
if (!ASSERT_OK(err, "bpf_prog_test_run"))
50+
goto cleanup;
51+
52+
ASSERT_EQ(topts.retval, -E2BIG, "reading too long string fails with -E2BIG");
53+
}
54+
55+
cleanup:
56+
string_kfuncs_failure2__destroy(skel);
57+
}
58+
59+
void test_string_kfuncs(void)
60+
{
61+
RUN_TESTS(string_kfuncs_success);
62+
RUN_TESTS(string_kfuncs_failure1);
63+
64+
run_too_long_tests();
65+
}

‎tools/testing/selftests/bpf/progs/string_kfuncs_failure1.c

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
// SPDX-License-Identifier: GPL-2.0
2+
/* Copyright (C) 2025 Red Hat, Inc.*/
3+
#include "vmlinux.h"
4+
#include <bpf/bpf_helpers.h>
5+
#include <linux/limits.h>
6+
#include "bpf_misc.h"
7+
#include "errno.h"
8+
9+
char *user_ptr = (char *)1;
10+
char *invalid_kern_ptr = (char *)-1;
11+
12+
/*
13+
* When passing userspace pointers, the error code differs based on arch:
14+
* -ERANGE on arches with non-overlapping address spaces
15+
* -EFAULT on other arches
16+
*/
17+
#if defined(__TARGET_ARCH_arm) || defined(__TARGET_ARCH_loongarch) || \
18+
defined(__TARGET_ARCH_powerpc) || defined(__TARGET_ARCH_x86)
19+
#define USER_PTR_ERR -ERANGE
20+
#else
21+
#define USER_PTR_ERR -EFAULT
22+
#endif
23+
24+
/*
25+
* On s390, __get_kernel_nofault (used in string kfuncs) returns 0 for NULL and
26+
* user_ptr (instead of causing an exception) so the below two groups of tests
27+
* are not applicable.
28+
*/
29+
#ifndef __TARGET_ARCH_s390
30+
31+
/* Passing NULL to string kfuncs (treated as a userspace ptr) */
32+
SEC("syscall") __retval(USER_PTR_ERR) int test_strcmp_null1(void *ctx) { return bpf_strcmp(NULL, "hello"); }
33+
SEC("syscall") __retval(USER_PTR_ERR)int test_strcmp_null2(void *ctx) { return bpf_strcmp("hello", NULL); }
34+
SEC("syscall") __retval(USER_PTR_ERR)int test_strchr_null(void *ctx) { return bpf_strchr(NULL, 'a'); }
35+
SEC("syscall") __retval(USER_PTR_ERR)int test_strchrnul_null(void *ctx) { return bpf_strchrnul(NULL, 'a'); }
36+
SEC("syscall") __retval(USER_PTR_ERR)int test_strnchr_null(void *ctx) { return bpf_strnchr(NULL, 1, 'a'); }
37+
SEC("syscall") __retval(USER_PTR_ERR)int test_strrchr_null(void *ctx) { return bpf_strrchr(NULL, 'a'); }
38+
SEC("syscall") __retval(USER_PTR_ERR)int test_strlen_null(void *ctx) { return bpf_strlen(NULL); }
39+
SEC("syscall") __retval(USER_PTR_ERR)int test_strnlen_null(void *ctx) { return bpf_strnlen(NULL, 1); }
40+
SEC("syscall") __retval(USER_PTR_ERR)int test_strspn_null1(void *ctx) { return bpf_strspn(NULL, "hello"); }
41+
SEC("syscall") __retval(USER_PTR_ERR)int test_strspn_null2(void *ctx) { return bpf_strspn("hello", NULL); }
42+
SEC("syscall") __retval(USER_PTR_ERR)int test_strcspn_null1(void *ctx) { return bpf_strcspn(NULL, "hello"); }
43+
SEC("syscall") __retval(USER_PTR_ERR)int test_strcspn_null2(void *ctx) { return bpf_strcspn("hello", NULL); }
44+
SEC("syscall") __retval(USER_PTR_ERR)int test_strstr_null1(void *ctx) { return bpf_strstr(NULL, "hello"); }
45+
SEC("syscall") __retval(USER_PTR_ERR)int test_strstr_null2(void *ctx) { return bpf_strstr("hello", NULL); }
46+
SEC("syscall") __retval(USER_PTR_ERR)int test_strnstr_null1(void *ctx) { return bpf_strnstr(NULL, "hello", 1); }
47+
SEC("syscall") __retval(USER_PTR_ERR)int test_strnstr_null2(void *ctx) { return bpf_strnstr("hello", NULL, 1); }
48+
49+
/* Passing userspace ptr to string kfuncs */
50+
SEC("syscall") __retval(USER_PTR_ERR) int test_strcmp_user_ptr1(void *ctx) { return bpf_strcmp(user_ptr, "hello"); }
51+
SEC("syscall") __retval(USER_PTR_ERR) int test_strcmp_user_ptr2(void *ctx) { return bpf_strcmp("hello", user_ptr); }
52+
SEC("syscall") __retval(USER_PTR_ERR) int test_strchr_user_ptr(void *ctx) { return bpf_strchr(user_ptr, 'a'); }
53+
SEC("syscall") __retval(USER_PTR_ERR) int test_strchrnul_user_ptr(void *ctx) { return bpf_strchrnul(user_ptr, 'a'); }
54+
SEC("syscall") __retval(USER_PTR_ERR) int test_strnchr_user_ptr(void *ctx) { return bpf_strnchr(user_ptr, 1, 'a'); }
55+
SEC("syscall") __retval(USER_PTR_ERR) int test_strrchr_user_ptr(void *ctx) { return bpf_strrchr(user_ptr, 'a'); }
56+
SEC("syscall") __retval(USER_PTR_ERR) int test_strlen_user_ptr(void *ctx) { return bpf_strlen(user_ptr); }
57+
SEC("syscall") __retval(USER_PTR_ERR) int test_strnlen_user_ptr(void *ctx) { return bpf_strnlen(user_ptr, 1); }
58+
SEC("syscall") __retval(USER_PTR_ERR) int test_strspn_user_ptr1(void *ctx) { return bpf_strspn(user_ptr, "hello"); }
59+
SEC("syscall") __retval(USER_PTR_ERR) int test_strspn_user_ptr2(void *ctx) { return bpf_strspn("hello", user_ptr); }
60+
SEC("syscall") __retval(USER_PTR_ERR) int test_strcspn_user_ptr1(void *ctx) { return bpf_strcspn(user_ptr, "hello"); }
61+
SEC("syscall") __retval(USER_PTR_ERR) int test_strcspn_user_ptr2(void *ctx) { return bpf_strcspn("hello", user_ptr); }
62+
SEC("syscall") __retval(USER_PTR_ERR) int test_strstr_user_ptr1(void *ctx) { return bpf_strstr(user_ptr, "hello"); }
63+
SEC("syscall") __retval(USER_PTR_ERR) int test_strstr_user_ptr2(void *ctx) { return bpf_strstr("hello", user_ptr); }
64+
SEC("syscall") __retval(USER_PTR_ERR) int test_strnstr_user_ptr1(void *ctx) { return bpf_strnstr(user_ptr, "hello", 1); }
65+
SEC("syscall") __retval(USER_PTR_ERR) int test_strnstr_user_ptr2(void *ctx) { return bpf_strnstr("hello", user_ptr, 1); }
66+
67+
#endif /* __TARGET_ARCH_s390 */
68+
69+
/* Passing invalid kernel ptr to string kfuncs should always return -EFAULT */
70+
SEC("syscall") __retval(-EFAULT) int test_strcmp_pagefault1(void *ctx) { return bpf_strcmp(invalid_kern_ptr, "hello"); }
71+
SEC("syscall") __retval(-EFAULT) int test_strcmp_pagefault2(void *ctx) { return bpf_strcmp("hello", invalid_kern_ptr); }
72+
SEC("syscall") __retval(-EFAULT) int test_strchr_pagefault(void *ctx) { return bpf_strchr(invalid_kern_ptr, 'a'); }
73+
SEC("syscall") __retval(-EFAULT) int test_strchrnul_pagefault(void *ctx) { return bpf_strchrnul(invalid_kern_ptr, 'a'); }
74+
SEC("syscall") __retval(-EFAULT) int test_strnchr_pagefault(void *ctx) { return bpf_strnchr(invalid_kern_ptr, 1, 'a'); }
75+
SEC("syscall") __retval(-EFAULT) int test_strrchr_pagefault(void *ctx) { return bpf_strrchr(invalid_kern_ptr, 'a'); }
76+
SEC("syscall") __retval(-EFAULT) int test_strlen_pagefault(void *ctx) { return bpf_strlen(invalid_kern_ptr); }
77+
SEC("syscall") __retval(-EFAULT) int test_strnlen_pagefault(void *ctx) { return bpf_strnlen(invalid_kern_ptr, 1); }
78+
SEC("syscall") __retval(-EFAULT) int test_strspn_pagefault1(void *ctx) { return bpf_strspn(invalid_kern_ptr, "hello"); }
79+
SEC("syscall") __retval(-EFAULT) int test_strspn_pagefault2(void *ctx) { return bpf_strspn("hello", invalid_kern_ptr); }
80+
SEC("syscall") __retval(-EFAULT) int test_strcspn_pagefault1(void *ctx) { return bpf_strcspn(invalid_kern_ptr, "hello"); }
81+
SEC("syscall") __retval(-EFAULT) int test_strcspn_pagefault2(void *ctx) { return bpf_strcspn("hello", invalid_kern_ptr); }
82+
SEC("syscall") __retval(-EFAULT) int test_strstr_pagefault1(void *ctx) { return bpf_strstr(invalid_kern_ptr, "hello"); }
83+
SEC("syscall") __retval(-EFAULT) int test_strstr_pagefault2(void *ctx) { return bpf_strstr("hello", invalid_kern_ptr); }
84+
SEC("syscall") __retval(-EFAULT) int test_strnstr_pagefault1(void *ctx) { return bpf_strnstr(invalid_kern_ptr, "hello", 1); }
85+
SEC("syscall") __retval(-EFAULT) int test_strnstr_pagefault2(void *ctx) { return bpf_strnstr("hello", invalid_kern_ptr, 1); }
86+
87+
char _license[] SEC("license") = "GPL";

‎tools/testing/selftests/bpf/progs/string_kfuncs_failure2.c

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// SPDX-License-Identifier: GPL-2.0
2+
/* Copyright (C) 2025 Red Hat, Inc.*/
3+
#include "vmlinux.h"
4+
#include <bpf/bpf_helpers.h>
5+
#include <linux/limits.h>
6+
7+
char long_str[XATTR_SIZE_MAX + 1];
8+
9+
SEC("syscall") int test_strcmp_too_long(void *ctx) { return bpf_strcmp(long_str, long_str); }
10+
SEC("syscall") int test_strchr_too_long(void *ctx) { return bpf_strchr(long_str, 'b'); }
11+
SEC("syscall") int test_strchrnul_too_long(void *ctx) { return bpf_strchrnul(long_str, 'b'); }
12+
SEC("syscall") int test_strnchr_too_long(void *ctx) { return bpf_strnchr(long_str, sizeof(long_str), 'b'); }
13+
SEC("syscall") int test_strrchr_too_long(void *ctx) { return bpf_strrchr(long_str, 'b'); }
14+
SEC("syscall") int test_strlen_too_long(void *ctx) { return bpf_strlen(long_str); }
15+
SEC("syscall") int test_strnlen_too_long(void *ctx) { return bpf_strnlen(long_str, sizeof(long_str)); }
16+
SEC("syscall") int test_strspn_str_too_long(void *ctx) { return bpf_strspn(long_str, "a"); }
17+
SEC("syscall") int test_strspn_accept_too_long(void *ctx) { return bpf_strspn("b", long_str); }
18+
SEC("syscall") int test_strcspn_str_too_long(void *ctx) { return bpf_strcspn(long_str, "b"); }
19+
SEC("syscall") int test_strcspn_reject_too_long(void *ctx) { return bpf_strcspn("b", long_str); }
20+
SEC("syscall") int test_strstr_too_long(void *ctx) { return bpf_strstr(long_str, "hello"); }
21+
SEC("syscall") int test_strnstr_too_long(void *ctx) { return bpf_strnstr(long_str, "hello", sizeof(long_str)); }
22+
23+
char _license[] SEC("license") = "GPL";

‎tools/testing/selftests/bpf/progs/string_kfuncs_success.c

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
// SPDX-License-Identifier: GPL-2.0
2+
/* Copyright (C) 2025 Red Hat, Inc.*/
3+
#include "vmlinux.h"
4+
#include <bpf/bpf_helpers.h>
5+
#include "bpf_misc.h"
6+
#include "errno.h"
7+
8+
char str[] = "hello world";
9+
10+
#define __test(retval) SEC("syscall") __success __retval(retval)
11+
12+
/* Functional tests */
13+
__test(0) int test_strcmp_eq(void *ctx) { return bpf_strcmp(str, "hello world"); }
14+
__test(1) int test_strcmp_neq(void *ctx) { return bpf_strcmp(str, "hello"); }
15+
__test(1) int test_strchr_found(void *ctx) { return bpf_strchr(str, 'e'); }
16+
__test(11) int test_strchr_null(void *ctx) { return bpf_strchr(str, '\0'); }
17+
__test(-ENOENT) int test_strchr_notfound(void *ctx) { return bpf_strchr(str, 'x'); }
18+
__test(1) int test_strchrnul_found(void *ctx) { return bpf_strchrnul(str, 'e'); }
19+
__test(11) int test_strchrnul_notfound(void *ctx) { return bpf_strchrnul(str, 'x'); }
20+
__test(1) int test_strnchr_found(void *ctx) { return bpf_strnchr(str, 5, 'e'); }
21+
__test(11) int test_strnchr_null(void *ctx) { return bpf_strnchr(str, 12, '\0'); }
22+
__test(-ENOENT) int test_strnchr_notfound(void *ctx) { return bpf_strnchr(str, 5, 'w'); }
23+
__test(9) int test_strrchr_found(void *ctx) { return bpf_strrchr(str, 'l'); }
24+
__test(11) int test_strrchr_null(void *ctx) { return bpf_strrchr(str, '\0'); }
25+
__test(-ENOENT) int test_strrchr_notfound(void *ctx) { return bpf_strrchr(str, 'x'); }
26+
__test(11) int test_strlen(void *ctx) { return bpf_strlen(str); }
27+
__test(11) int test_strnlen(void *ctx) { return bpf_strnlen(str, 12); }
28+
__test(5) int test_strspn(void *ctx) { return bpf_strspn(str, "ehlo"); }
29+
__test(2) int test_strcspn(void *ctx) { return bpf_strcspn(str, "lo"); }
30+
__test(6) int test_strstr_found(void *ctx) { return bpf_strstr(str, "world"); }
31+
__test(-ENOENT) int test_strstr_notfound(void *ctx) { return bpf_strstr(str, "hi"); }
32+
__test(0) int test_strstr_empty(void *ctx) { return bpf_strstr(str, ""); }
33+
__test(0) int test_strnstr_found(void *ctx) { return bpf_strnstr(str, "hello", 6); }
34+
__test(-ENOENT) int test_strnstr_notfound(void *ctx) { return bpf_strnstr(str, "hi", 10); }
35+
__test(0) int test_strnstr_empty(void *ctx) { return bpf_strnstr(str, "", 1); }
36+
37+
char _license[] SEC("license") = "GPL";

0 commit comments

Comments
 (0)