Skip to content

Commit

Permalink
selftests/bpf: Test returning referenced kptr from struct_ops programs
Browse files Browse the repository at this point in the history
Test struct_ops programs returning referenced kptr. When the return type
of a struct_ops operator is pointer to struct, the verifier should
only allow programs that return a scalar NULL or a non-local kptr with the
correct type in its unmodified form.

Signed-off-by: Amery Hung <amery.hung@bytedance.com>
Acked-by: Eduard Zingerman <eddyz87@gmail.com>
Acked-by: Martin KaFai Lau <martin.lau@kernel.org>
Link: https://lore.kernel.org/r/20250217190640.1748177-6-ameryhung@gmail.com
Signed-off-by: Alexei Starovoitov <ast@kernel.org>
  • Loading branch information
Amery Hung authored and Alexei Starovoitov committed Feb 18, 2025
1 parent 8d9f547 commit af17bad
Show file tree
Hide file tree
Showing 8 changed files with 173 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#include <test_progs.h>

#include "struct_ops_kptr_return.skel.h"
#include "struct_ops_kptr_return_fail__wrong_type.skel.h"
#include "struct_ops_kptr_return_fail__invalid_scalar.skel.h"
#include "struct_ops_kptr_return_fail__nonzero_offset.skel.h"
#include "struct_ops_kptr_return_fail__local_kptr.skel.h"

void test_struct_ops_kptr_return(void)
{
RUN_TESTS(struct_ops_kptr_return);
RUN_TESTS(struct_ops_kptr_return_fail__wrong_type);
RUN_TESTS(struct_ops_kptr_return_fail__invalid_scalar);
RUN_TESTS(struct_ops_kptr_return_fail__nonzero_offset);
RUN_TESTS(struct_ops_kptr_return_fail__local_kptr);
}
30 changes: 30 additions & 0 deletions tools/testing/selftests/bpf/progs/struct_ops_kptr_return.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
#include <vmlinux.h>
#include <bpf/bpf_tracing.h>
#include "../test_kmods/bpf_testmod.h"
#include "bpf_misc.h"

char _license[] SEC("license") = "GPL";

void bpf_task_release(struct task_struct *p) __ksym;

/* This test struct_ops BPF programs returning referenced kptr. The verifier should
* allow a referenced kptr or a NULL pointer to be returned. A referenced kptr to task
* here is acquried automatically as the task argument is tagged with "__ref".
*/
SEC("struct_ops/test_return_ref_kptr")
struct task_struct *BPF_PROG(kptr_return, int dummy,
struct task_struct *task, struct cgroup *cgrp)
{
if (dummy % 2) {
bpf_task_release(task);
return NULL;
}
return task;
}

SEC(".struct_ops.link")
struct bpf_testmod_ops testmod_kptr_return = {
.test_return_ref_kptr = (void *)kptr_return,
};


Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
#include <vmlinux.h>
#include <bpf/bpf_tracing.h>
#include "../test_kmods/bpf_testmod.h"
#include "bpf_misc.h"

char _license[] SEC("license") = "GPL";

struct cgroup *bpf_cgroup_acquire(struct cgroup *p) __ksym;
void bpf_task_release(struct task_struct *p) __ksym;

/* This test struct_ops BPF programs returning referenced kptr. The verifier should
* reject programs returning a non-zero scalar value.
*/
SEC("struct_ops/test_return_ref_kptr")
__failure __msg("At program exit the register R0 has smin=1 smax=1 should have been in [0, 0]")
struct task_struct *BPF_PROG(kptr_return_fail__invalid_scalar, int dummy,
struct task_struct *task, struct cgroup *cgrp)
{
bpf_task_release(task);
return (struct task_struct *)1;
}

SEC(".struct_ops.link")
struct bpf_testmod_ops testmod_kptr_return = {
.test_return_ref_kptr = (void *)kptr_return_fail__invalid_scalar,
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
#include <vmlinux.h>
#include <bpf/bpf_tracing.h>
#include "../test_kmods/bpf_testmod.h"
#include "bpf_experimental.h"
#include "bpf_misc.h"

char _license[] SEC("license") = "GPL";

struct cgroup *bpf_cgroup_acquire(struct cgroup *p) __ksym;
void bpf_task_release(struct task_struct *p) __ksym;

/* This test struct_ops BPF programs returning referenced kptr. The verifier should
* reject programs returning a local kptr.
*/
SEC("struct_ops/test_return_ref_kptr")
__failure __msg("At program exit the register R0 is not a known value (ptr_or_null_)")
struct task_struct *BPF_PROG(kptr_return_fail__local_kptr, int dummy,
struct task_struct *task, struct cgroup *cgrp)
{
struct task_struct *t;

bpf_task_release(task);

t = bpf_obj_new(typeof(*task));
if (!t)
return NULL;

return t;
}

SEC(".struct_ops.link")
struct bpf_testmod_ops testmod_kptr_return = {
.test_return_ref_kptr = (void *)kptr_return_fail__local_kptr,
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
#include <vmlinux.h>
#include <bpf/bpf_tracing.h>
#include "../test_kmods/bpf_testmod.h"
#include "bpf_misc.h"

char _license[] SEC("license") = "GPL";

struct cgroup *bpf_cgroup_acquire(struct cgroup *p) __ksym;
void bpf_task_release(struct task_struct *p) __ksym;

/* This test struct_ops BPF programs returning referenced kptr. The verifier should
* reject programs returning a modified referenced kptr.
*/
SEC("struct_ops/test_return_ref_kptr")
__failure __msg("dereference of modified trusted_ptr_ ptr R0 off={{[0-9]+}} disallowed")
struct task_struct *BPF_PROG(kptr_return_fail__nonzero_offset, int dummy,
struct task_struct *task, struct cgroup *cgrp)
{
return (struct task_struct *)&task->jobctl;
}

SEC(".struct_ops.link")
struct bpf_testmod_ops testmod_kptr_return = {
.test_return_ref_kptr = (void *)kptr_return_fail__nonzero_offset,
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
#include <vmlinux.h>
#include <bpf/bpf_tracing.h>
#include "../test_kmods/bpf_testmod.h"
#include "bpf_misc.h"

char _license[] SEC("license") = "GPL";

struct cgroup *bpf_cgroup_acquire(struct cgroup *p) __ksym;
void bpf_task_release(struct task_struct *p) __ksym;

/* This test struct_ops BPF programs returning referenced kptr. The verifier should
* reject programs returning a referenced kptr of the wrong type.
*/
SEC("struct_ops/test_return_ref_kptr")
__failure __msg("At program exit the register R0 is not a known value (ptr_or_null_)")
struct task_struct *BPF_PROG(kptr_return_fail__wrong_type, int dummy,
struct task_struct *task, struct cgroup *cgrp)
{
struct task_struct *ret;

ret = (struct task_struct *)bpf_cgroup_acquire(cgrp);
bpf_task_release(task);

return ret;
}

SEC(".struct_ops.link")
struct bpf_testmod_ops testmod_kptr_return = {
.test_return_ref_kptr = (void *)kptr_return_fail__wrong_type,
};
8 changes: 8 additions & 0 deletions tools/testing/selftests/bpf/test_kmods/bpf_testmod.c
Original file line number Diff line number Diff line change
Expand Up @@ -1182,11 +1182,19 @@ static int bpf_testmod_ops__test_refcounted(int dummy,
return 0;
}

static struct task_struct *
bpf_testmod_ops__test_return_ref_kptr(int dummy, struct task_struct *task__ref,
struct cgroup *cgrp)
{
return NULL;
}

static struct bpf_testmod_ops __bpf_testmod_ops = {
.test_1 = bpf_testmod_test_1,
.test_2 = bpf_testmod_test_2,
.test_maybe_null = bpf_testmod_ops__test_maybe_null,
.test_refcounted = bpf_testmod_ops__test_refcounted,
.test_return_ref_kptr = bpf_testmod_ops__test_return_ref_kptr,
};

struct bpf_struct_ops bpf_bpf_testmod_ops = {
Expand Down
4 changes: 4 additions & 0 deletions tools/testing/selftests/bpf/test_kmods/bpf_testmod.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
#include <linux/types.h>

struct task_struct;
struct cgroup;

struct bpf_testmod_test_read_ctx {
char *buf;
Expand Down Expand Up @@ -38,6 +39,9 @@ struct bpf_testmod_ops {
int (*unsupported_ops)(void);
/* Used to test ref_acquired arguments. */
int (*test_refcounted)(int dummy, struct task_struct *task);
/* Used to test returning referenced kptr. */
struct task_struct *(*test_return_ref_kptr)(int dummy, struct task_struct *task,
struct cgroup *cgrp);

/* The following fields are used to test shadow copies. */
char onebyte;
Expand Down

0 comments on commit af17bad

Please sign in to comment.