bpf: support input __sk_buff context in BPF_PROG_TEST_RUN
Subsystems (7)
PATCH v4 1/3 bpf: support input __sk_buff context in BPF_PROG_TEST_RUN
Add new set of arguments to bpf_attr for BPF_PROG_TEST_RUN:
* ctx_in/ctx_size_in - input context
* ctx_out/ctx_size_out - output context
The intended use case is to pass some meta data to the test runs that operate on skb (this has being brought up on recent LPC).
For programs that use bpf_prog_test_run_skb, support __sk_buff input and output. Initially, from input __sk_buff, copy _only_ cb and priority into skb, all other non-zero fields are prohibited (with EINVAL). If the user has set ctx_out/ctx_size_out, copy the potentially modified __sk_buff back to the userspace.
We require all fields of input __sk_buff except the ones we explicitly support to be set to zero. The expectation is that in the future we might add support for more fields and we want to fail explicitly if the user runs the program on the kernel where we don't yet support them.
The API is intentionally vague (i.e. we don't explicitly add __sk_buff to bpf_attr, but ctx_in) to potentially let other test_run types use this interface in the future (this can be xdp_md for xdp types for example).
v4:
* don't copy more than allowed in bpf_ctx_init [Martin]
v3:
* handle case where ctx_in is NULL, but ctx_out is not [Martin]
* convert size==0 checks to ptr==NULL checks and add some extra ptr checks [Martin]
v2:
* Addressed comments from Martin Lau
--- include/uapi/linux/bpf.h | 7 ++ kernel/bpf/syscall.c | 10 ++- net/bpf/test_run.c | 143 ++++++++++++++++++++++++++++++++++++--- 3 files changed, 151 insertions(+), 9 deletions(-)
include/uapi/linux/bpf.h +7 -0
@@ -396,6 +396,13 @@ union bpf_attr {__aligned_u64 data_out;__u32 repeat;__u32 duration; +__u32 ctx_size_in;/* input: len of ctx_in */ +__u32 ctx_size_out;/* input/output: len of ctx_out +* returns ENOSPC if ctx_out +* is too small. +*/ +__aligned_u64 ctx_in; +__aligned_u64 ctx_out; } test;struct {/* anonymous struct used by BPF_*_GET_*_ID */
kernel/bpf/syscall.c +9 -1
@@ -1949,7 +1949,7 @@ static int bpf_prog_query(const union bpf_attr *attr,return cgroup_bpf_prog_query (attr, uattr); } -#define BPF_PROG_TEST_RUN_LAST_FIELD test.duration +#define BPF_PROG_TEST_RUN_LAST_FIELD test.ctx_outstatic int bpf_prog_test_run (const union bpf_attr *attr,union bpf_attr __user *uattr)
@@ -1962,6 +1962,14 @@ static int bpf_prog_test_run(const union bpf_attr *attr,if (CHECK_ATTR (BPF_PROG_TEST_RUN ))return -EINVAL ; +if ((attr->test.ctx_size_in && !attr->test.ctx_in) || + (!attr->test.ctx_size_in && attr->test.ctx_in)) +return -EINVAL ; + +if ((attr->test.ctx_size_out && !attr->test.ctx_out) || + (!attr->test.ctx_size_out && attr->test.ctx_out)) +return -EINVAL ; + prog =bpf_prog_get (attr->test.prog_fd);if (IS_ERR (prog))return PTR_ERR (prog);
net/bpf/test_run.c +135 -8
197 lines not on this page · raw message
Signature · 1 line
2.21.0.392.gf8f6787159e-goog
PATCH v4 2/3 libbpf: add support for ctx_{size,}_{in,out} in BPF_PROG_TEST_RUN
Support recently introduced input/output context for test runs. We extend only bpf_prog_test_run_xattr. bpf_prog_test_run is unextendable and left as is.
--- tools/include/uapi/linux/bpf.h | 7 +++++++ tools/lib/bpf/bpf.c | 5 +++++ tools/lib/bpf/bpf.h | 5 +++++ 3 files changed, 17 insertions(+)
tools/include/uapi/linux/bpf.h +7 -0
@@ -396,6 +396,13 @@ union bpf_attr {__aligned_u64 data_out;__u32 repeat;__u32 duration; +__u32 ctx_size_in;/* input: len of ctx_in */ +__u32 ctx_size_out;/* input/output: len of ctx_out +* returns ENOSPC if ctx_out +* is too small. +*/ +__aligned_u64 ctx_in; +__aligned_u64 ctx_out; } test;struct {/* anonymous struct used by BPF_*_GET_*_ID */
tools/lib/bpf/bpf.c +5 -0
@@ -545,10 +545,15 @@ int bpf_prog_test_run_xattr(struct bpf_prog_test_run_attr *test_attr) attr.test.data_out =ptr_to_u64 (test_attr->data_out); attr.test.data_size_in = test_attr->data_size_in; attr.test.data_size_out = test_attr->data_size_out; + attr.test.ctx_in =ptr_to_u64 (test_attr->ctx_in); + attr.test.ctx_out =ptr_to_u64 (test_attr->ctx_out); + attr.test.ctx_size_in = test_attr->ctx_size_in; + attr.test.ctx_size_out = test_attr->ctx_size_out; attr.test.repeat = test_attr->repeat; ret =sys_bpf (BPF_PROG_TEST_RUN , &attr,sizeof (attr)); test_attr->data_size_out = attr.test.data_size_out; + test_attr->ctx_size_out = attr.test.ctx_size_out; test_attr->retval = attr.test.retval; test_attr->duration = attr.test.duration;return ret;
tools/lib/bpf/bpf.h +5 -0
@@ -135,6 +135,11 @@ struct bpf_prog_test_run_attr {* out: length of data_out */ __u32 retval;/* out: return code of the BPF program */ __u32 duration;/* out: average per repetition in ns */ +const void *ctx_in;/* optional */ +__u32 ctx_size_in; +void *ctx_out;/* optional */ +__u32 ctx_size_out;/* in: max length of ctx_out +* out: length of cxt_out */ }; LIBBPF_API int bpf_prog_test_run_xattr(struct bpf_prog_test_run_attr *test_attr);
Signature · 1 line
2.21.0.392.gf8f6787159e-goog
PATCH v4 3/3 selftests: bpf: add selftest for __sk_buff context in BPF_PROG_TEST_RUN
In reply to Stanislav FomichevSimple test that sets cb to {1,2,3,4,5} and priority to 6, runs bpf program that fails if cb is not what we expect and increments cb[i] and priority. When the test finishes, we check that cb is now {2,3,4,5,6} and priority is 7.
We also test the sanity checks:
* ctx_in is provided, but ctx_size_in is zero (same for ctx_out/ctx_size_out)
* unexpected non-zero fields in __sk_buff return EINVAL
--- .../selftests/bpf/prog_tests/skb_ctx.c | 89 +++++++++++++++++++ .../selftests/bpf/progs/test_skb_ctx.c | 21 +++++ 2 files changed, 110 insertions(+) create mode 100644 tools/testing/selftests/bpf/prog_tests/skb_ctx.c create mode 100644 tools/testing/selftests/bpf/progs/test_skb_ctx.c
tools/testing/selftests/bpf/prog_tests/skb_ctx.c new file +89 -0
@@ -0,0 +1,89 @@ +// SPDX-License-Identifier: GPL-2.0 +#include <test_progs.h> + +void test_skb_ctx (void ) +{ +struct __sk_buff skb = { + .cb[0 ] =1 , + .cb[1 ] =2 , + .cb[2 ] =3 , + .cb[3 ] =4 , + .cb[4 ] =5 , + .priority =6 , + }; +struct bpf_prog_test_run_attr tattr = { + .data_in = &pkt_v4, + .data_size_in =sizeof (pkt_v4), + .ctx_in = &skb, + .ctx_size_in =sizeof (skb), + .ctx_out = &skb, + .ctx_size_out =sizeof (skb), + }; +struct bpf_object *obj; +int err; +int i; + + err =bpf_prog_load ("./test_skb_ctx.o" ,BPF_PROG_TYPE_SCHED_CLS , &obj, + &tattr.prog_fd); +if (CHECK_ATTR (err,"load" ,"err %d errno %d\n" , err, errno)) +return ; + +/* ctx_in != NULL, ctx_size_in == 0 */ + + tattr.ctx_size_in =0 ; + err =bpf_prog_test_run_xattr (&tattr); +CHECK_ATTR (err ==0 ,"ctx_size_in" ,"err %d errno %d\n" , err, errno); + tattr.ctx_size_in =sizeof (skb); + +/* ctx_out != NULL, ctx_size_out == 0 */ + + tattr.ctx_size_out =0 ; + err =bpf_prog_test_run_xattr (&tattr); +CHECK_ATTR (err ==0 ,"ctx_size_out" ,"err %d errno %d\n" , err, errno); + tattr.ctx_size_out =sizeof (skb); + +/* non-zero [len, tc_index] fields should be rejected*/ + + skb.len =1 ; + err =bpf_prog_test_run_xattr (&tattr); +CHECK_ATTR (err ==0 ,"len" ,"err %d errno %d\n" , err, errno); + skb.len =0 ; + + skb.tc_index =1 ; + err =bpf_prog_test_run_xattr (&tattr); +CHECK_ATTR (err ==0 ,"tc_index" ,"err %d errno %d\n" , err, errno); + skb.tc_index =0 ; + +/* non-zero [hash, sk] fields should be rejected */ + + skb.hash =1 ; + err =bpf_prog_test_run_xattr (&tattr); +CHECK_ATTR (err ==0 ,"hash" ,"err %d errno %d\n" , err, errno); + skb.hash =0 ; + + skb.sk = (struct bpf_sock *)1 ; + err =bpf_prog_test_run_xattr (&tattr); +CHECK_ATTR (err ==0 ,"sk" ,"err %d errno %d\n" , err, errno); + skb.sk =0 ; + + err =bpf_prog_test_run_xattr (&tattr); +CHECK_ATTR (err !=0 || tattr.retval, +"run" , +"err %d errno %d retval %d\n" , + err, errno, tattr.retval); + +CHECK_ATTR (tattr.ctx_size_out !=sizeof (skb), +"ctx_size_out" , +"incorrect output size, want %lu have %u\n" , +sizeof (skb), tattr.ctx_size_out); + +for (i =0 ; i <5 ; i++) +CHECK_ATTR (skb.cb[i] != i +2 , +"ctx_out_cb" , +"skb->cb[i] == %d, expected %d\n" , + skb.cb[i], i +2 ); +CHECK_ATTR (skb.priority !=7 , +"ctx_out_priority" , +"skb->priority == %d, expected %d\n" , + skb.priority,7 ); +}
tools/testing/selftests/bpf/progs/test_skb_ctx.c new file +21 -0
@@ -0,0 +1,21 @@ +// SPDX-License-Identifier: GPL-2.0 + +#include <linux/bpf.h> +#include "bpf_helpers.h" + +int _version SEC("version") = 1; +char _license[] SEC("license") = "GPL"; + +SEC("skb_ctx") +int process (struct __sk_buff *skb) +{ +#pragma clang loop unroll(full) +for (int i =0 ; i <5 ; i++) { +if (skb->cb[i] != i +1 ) +return 1 ; + skb->cb[i]++; + } + skb->priority++; + +return 0 ; +}
Signature · 1 line
2.21.0.392.gf8f6787159e-goog
Quoted 3 lines · Stanislav Fomichev
Add new set of arguments to
bpf_attrforBPF_PROG_TEST_RUN:
* ctx_in/ctx_size_in - input context
* ctx_out/ctx_size_out - output context
Daniel Borkmann
maintainerQuoted 31 lines · Stanislav Fomichev
Add new set of arguments to
bpf_attrforBPF_PROG_TEST_RUN:
* ctx_in/ctx_size_in - input context
* ctx_out/ctx_size_out - output contextThe intended use case is to pass some meta data to the test runs that operate on skb (this has being brought up on recent LPC).
For programs that use
bpf_prog_test_run_skb, support__sk_buffinput and output. Initially, from input__sk_buff, copy _only_ cb and priority into skb, all other non-zero fields are prohibited (with EINVAL). If the user has set ctx_out/ctx_size_out, copy the potentially modified__sk_buffback to the userspace.We require all fields of input
__sk_buffexcept the ones we explicitly support to be set to zero. The expectation is that in the future we might add support for more fields and we want to fail explicitly if the user runs the program on the kernel where we don't yet support them.The API is intentionally vague (i.e. we don't explicitly add
__sk_bufftobpf_attr, butctx_in) to potentially let othertest_runtypes use this interface in the future (this can bexdp_mdfor xdp types for example).v4:
* don't copy more than allowed inbpf_ctx_init[Martin]v3:
* handle case wherectx_inis NULL, butctx_outis not [Martin]
* convert size==0 checks to ptr==NULL checks and add some extra ptr checks [Martin]
Quoted 5 lines
v2:
* Addressed comments from Martin LauCc Martin Lau <[email protected]>Signed-off-by Stanislav Fomichev <[email protected]>
Series applied, thanks!
Daniel Borkmann
maintainerHey Stanislav,
Quoted 31 lines · Stanislav Fomichev
Add new set of arguments to
bpf_attrforBPF_PROG_TEST_RUN:
* ctx_in/ctx_size_in - input context
* ctx_out/ctx_size_out - output contextThe intended use case is to pass some meta data to the test runs that operate on skb (this has being brought up on recent LPC).
For programs that use
bpf_prog_test_run_skb, support__sk_buffinput and output. Initially, from input__sk_buff, copy _only_ cb and priority into skb, all other non-zero fields are prohibited (with EINVAL). If the user has set ctx_out/ctx_size_out, copy the potentially modified__sk_buffback to the userspace.We require all fields of input
__sk_buffexcept the ones we explicitly support to be set to zero. The expectation is that in the future we might add support for more fields and we want to fail explicitly if the user runs the program on the kernel where we don't yet support them.The API is intentionally vague (i.e. we don't explicitly add
__sk_bufftobpf_attr, butctx_in) to potentially let othertest_runtypes use this interface in the future (this can bexdp_mdfor xdp types for example).v4:
* don't copy more than allowed inbpf_ctx_init[Martin]v3:
* handle case wherectx_inis NULL, butctx_outis not [Martin]
* convert size==0 checks to ptr==NULL checks and add some extra ptr checks [Martin]
Quoted 5 lines
v2:
* Addressed comments from Martin LauCc Martin Lau <[email protected]>Signed-off-by Stanislav Fomichev <[email protected]>
This still has a bug in that we need to reject !bpf_prog_test_run_skb() cases, since they are not handled by your set. So for e.g. XDP, flow dissector progs, we need to error out if ctx is set such that it can be safely extended in future. Please follow up.
Thanks,
Daniel
Quoted 38 lines · Daniel Borkmann
Hey Stanislav,
Quoted 34 lines · Stanislav Fomichev
Add new set of arguments to
bpf_attrforBPF_PROG_TEST_RUN:
* ctx_in/ctx_size_in - input context
* ctx_out/ctx_size_out - output contextThe intended use case is to pass some meta data to the test runs that operate on skb (this has being brought up on recent LPC).
For programs that use
bpf_prog_test_run_skb, support__sk_buffinput and output. Initially, from input__sk_buff, copy _only_ cb and priority into skb, all other non-zero fields are prohibited (with EINVAL). If the user has set ctx_out/ctx_size_out, copy the potentially modified__sk_buffback to the userspace.We require all fields of input
__sk_buffexcept the ones we explicitly support to be set to zero. The expectation is that in the future we might add support for more fields and we want to fail explicitly if the user runs the program on the kernel where we don't yet support them.The API is intentionally vague (i.e. we don't explicitly add
__sk_bufftobpf_attr, butctx_in) to potentially let othertest_runtypes use this interface in the future (this can bexdp_mdfor xdp types for example).v4:
* don't copy more than allowed inbpf_ctx_init[Martin]v3:
* handle case wherectx_inis NULL, butctx_outis not [Martin]
* convert size==0 checks to ptr==NULL checks and add some extra ptr checks [Martin]v2:
* Addressed comments from Martin Lau
Quoted 7 lines
Quoted 2 lines
Cc Martin Lau <[email protected]>Signed-off-by Stanislav Fomichev <[email protected]>This still has a bug in that we need to reject !bpf_prog_test_run_skb() cases, since they are not handled by your set. So for e.g. XDP, flow dissector progs, we need to error out if ctx is set such that it can be safely extended in future. Please follow up.
Good point, sure, will follow up on that!
Quoted 2 lines
Thanks,
Daniel