On Mon, Jan 23, 2023 at 6:52 AM Eduard Zingerman <eddyz87@xxxxxxxxx> wrote:
>
> As a part of the discussion started in [2] I developed a script [1]
> that can convert tests specified in test_verifier.c format to inline
> BPF assembly compatible for use with test_loader.c.
>
> For example, test definition like below:
>
> {
> "invalid and of negative number",
> .insns = {
> BPF_ST_MEM(BPF_DW, BPF_REG_10, -8, 0),
> BPF_MOV64_REG(BPF_REG_2, BPF_REG_10),
> BPF_ALU64_IMM(BPF_ADD, BPF_REG_2, -8),
> BPF_LD_MAP_FD(BPF_REG_1, 0),
> BPF_RAW_INSN(BPF_JMP | BPF_CALL, 0, 0, 0, BPF_FUNC_map_lookup_elem),
> BPF_JMP_IMM(BPF_JEQ, BPF_REG_0, 0, 5),
> BPF_LDX_MEM(BPF_B, BPF_REG_1, BPF_REG_0, 0),
> BPF_ALU64_IMM(BPF_AND, BPF_REG_1, -4),
> BPF_ALU64_IMM(BPF_LSH, BPF_REG_1, 2),
> BPF_ALU64_REG(BPF_ADD, BPF_REG_0, BPF_REG_1),
> BPF_ST_MEM(BPF_DW, BPF_REG_0, 0, offsetof(struct test_val, foo)),
> BPF_EXIT_INSN(),
> },
> .fixup_map_hash_48b = { 3 },
> .errstr = "R0 max value is outside of the allowed memory range",
> .result = REJECT,
> .flags = F_NEEDS_EFFICIENT_UNALIGNED_ACCESS,
> },
>
> Is converted to:
>
> struct test_val { ... };
>
> struct { ...} map_hash_48b SEC(".maps");
>
> __description("invalid and of negative number")
> __failure __msg("R0 max value is outside of the allowed memory range")
> __failure_unpriv
> __flag(BPF_F_ANY_ALIGNMENT)
> SEC("socket")
nit: let's make sure that SEC() is the first annotation, makes
grepping easier and is consistent with how we use SEC() with BPF
programs
> __naked void invalid_and_of_negative_number(void)
>
> {
> asm volatile (
> " r1 = 0; \n\
Kumar recently landed similarly formatted inline asm-based test, let's
make sure we stick to common style. \n at the end are pretty
distracting, IMO (though helpful to debug syntax errors in asm, of
course). I'd also move starting " into the same line as asm volatile:
asm volatile (" \
this will make adding/removing asm lines at the beginning simpler (and
you already put closing quote on separate line, so that side is taken
care of)
> *(u64*)(r10 - 8) = r1; \n\
> r2 = r10; \n\
> r2 += -8; \n\
> r1 = %[map_hash_48b] ll; \n\
> call %[bpf_map_lookup_elem]; \n\
> if r0 == 0 goto l0_%=; \n\
> r1 = *(u8*)(r0 + 0); \n\
> r1 &= -4; \n\
> r1 <<= 2; \n\
> r0 += r1; \n\
> r1 = %[test_val_foo_offset]; \n\
> *(u64*)(r0 + 0) = r1; \n\
> l0_%=: \n\
> exit; \n\
> " :
> : [test_val_foo_offset]"i"(offsetof(struct test_val, foo)),
should we use some __imm_const(name, value) macro (or __imm_named, or
__imm_alias, or something like that) for cases like this?
> __imm(bpf_map_lookup_elem),
> __imm_addr(map_hash_48b)
> : __clobber_all);
> }
>
> The script introduces labels for gotos and calls, immediate values for
> complex expressions like `offsetof(...)', takes care of map
> instructions patching, inserts map declarations used in the test,
> transfers comments from test, test fields and instructions. There are
> some issues with BPF_ST_MEM instruction support as described in [4],
> thus the script replaces such instructions with pairs of MOV/STX_MEM
> instructions.
>
> This patch-set introduces changes necessary for test_loader.c and
> includes migration of a single test from test_verifier to test_progs
> format, here are descriptions for individual patches:
>
> 1. "Support custom per-test flags and multiple expected messages"
> This patch was shared by Andrii Nakryiko [3], it adds capability
> to specify flags required by the BPF program.
>
> 2. "Unprivileged tests for test_loader.c"
> Extends test_loader.c by capability to load test programs in
> unprivileged mode and specify separate test outcomes for
> privileged and unprivileged modes.
>
> Note: for a reason I do not understand I had to use different set
> of capabilities compared to test_verifier:
> - test_verifier: CAP_NET_ADMIN, CAP_PERFMON, CAP_BPF;
> - test_loader : CAP_SYS_ADMIN, CAP_PERFMON, CAP_BPF.
CAP_SYS_ADMIN is a superset of PERFMON and BPF, so it should be
NET_ADMIN... Setting CAP_SYS_ADMIN makes PERFMON and BPF meaningless,
so we should investigate.
>
> 3. "Generate boilerplate code for test_loader-based tests"
> Extends selftests/bpf Makefile to automatically generate
> prog_tests/tests.h entry that uses test_loader for progs/*.c
> BPF programs if special marker is present.
>
> 4. "__imm_insn macro to embed raw insns in inline asm"
nit: __raw_insns perhaps, otherwise confusing given __imm and __imm_addr macros
> This macro can be generated by migration script for instructions
> that cannot be expressed in inline assembly, e.g. invalid instructions.
>
> 5. "convert jeq_infer_not_null tests to inline assembly"
> Shows an example of the test migration.
> The test was updated slightly after automatic translation:
> - unnecessary comments removed;
> - functions renamed;
> - some labels renamed.
>
> The migration script has some limitations:
> - Technical, test features that are not yet supported:
> - few instructions like BPF_ENDIAN;
> - macro like BPF_SK_LOOKUP or BPF_LD_MAP_VALUE;
> - program types like BPF_PROG_TYPE_CGROUP_SOCK_ADDR and
> BPF_PROG_TYPE_TRACING;
> - tests that specify fields 'expected_attach_type' or 'insn_processed';
> - a few tests expose complex structure that could not be
> automatically migrated, e.g.: 'atomic_fetch', 'lwt',
> 'bpf_loop_inline'.
> - Tests that use .run field cannot be migrated as test_loader.c tests.
> - Tests with generated bodies, e.g. test_verifier.c:bpf_fill_scale()
> cannot be migrated as test_loader.c tests.
> - LLVM related:
> - BPF_ST instruction is not supported by LLVM BPF assembly yet
> (I'll take care of it);
> - Issues with parsing of some assembly instructions like
> "r0 = cmpxchg_64(r10 - 8, r0, r5)"
> (I'll take care of it);
> - libbpf related:
> - libbpf does not support call instructions within a single
> function, e.g.:
it's more of an issue of not having valid relocation emitted and also
corresponding .BTF.ext line/func info (that's my guess)
>
> 0: r1 = 1
> 1: r2 = 2
> 2: call 1
> 3: exit
> 4: r0 = r1
> 5: r0 += r2
> 6: exit
so libbpf itself doesn't care, but given we use BTF and send .BTF.ext,
I suspect kernel just doesn't like that it can't find func_info
information for subprog. So we'll need to split into proper functions
or disable .BTF.ext somehow.
>
> This pattern is common in verifier tests, I see two possible
> mitigation:
> (a) use an additional libbpf flag to allow such code;
I hope not :)
> (b) extend migration script to split such code in several functions.
> I like (a) more.
see above, this won't be a libbpf flag, rather some code in test
runner to strip away .BTF.ext information
>
> - libbpf does not allow empty programs.
like:
SEC("kprobe")
int prog()
{
return 0;
}
?
>
> All in all the current script stats are as follows:
> - 62 out of 93 files from progs/*.c can be converted w/o warnings;
> - 55 converted files could be compiled;
> - 40 pass testing, 15 fail.
>
> By submitting this RFC I seek the following feedback:
> - is community interested in such migration?
+1
This is a great work!
> - if yes, should I pursue partial or complete tests migration?
I'd start with partial
> - in case of partial migration which tests should be prioritized?
those that work out of the box?
> - should I offer migrated tests one by one or in big butches?
they come grouped in files, would it be possible to live them in
similar groupings?
>
> Thanks,
> Eduard
>
> [1] https://github.com/eddyz87/verifier-tests-migrator
> [2] https://lore.kernel.org/bpf/CAEf4BzYPsDWdRgx+ND1wiKAB62P=WwoLhr2uWkbVpQfbHqi1oA@xxxxxxxxxxxxxx/
> [3] https://lore.kernel.org/bpf/CAEf4BzZH0ZxorCi7nPDbRqSK9f+410RooNwNJGwfw8=0a5i1nw@xxxxxxxxxxxxxx/
> [4] https://lore.kernel.org/bpf/20221231163122.1360813-1-eddyz87@xxxxxxxxx/
>
> Andrii Nakryiko (1):
> selftests/bpf: support custom per-test flags and multiple expected
> messages
>
> Eduard Zingerman (4):
> selftests/bpf: unprivileged tests for test_loader.c
> selftests/bpf: generate boilerplate code for test_loader-based tests
> selftests/bpf: __imm_insn macro to embed raw insns in inline asm
> selftests/bpf: convert jeq_infer_not_null tests to inline assembly
>
> tools/testing/selftests/bpf/Makefile | 41 +-
> tools/testing/selftests/bpf/autoconf_helper.h | 9 +
> .../selftests/bpf/prog_tests/.gitignore | 1 +
> .../bpf/prog_tests/jeq_infer_not_null.c | 9 -
> tools/testing/selftests/bpf/progs/bpf_misc.h | 49 +++
> .../selftests/bpf/progs/jeq_infer_not_null.c | 186 +++++++++
> .../bpf/progs/jeq_infer_not_null_fail.c | 1 +
> tools/testing/selftests/bpf/test_loader.c | 370 +++++++++++++++---
> tools/testing/selftests/bpf/test_progs.h | 1 +
> tools/testing/selftests/bpf/test_verifier.c | 25 +-
> tools/testing/selftests/bpf/unpriv_helpers.c | 26 ++
> tools/testing/selftests/bpf/unpriv_helpers.h | 7 +
> .../bpf/verifier/jeq_infer_not_null.c | 174 --------
> 13 files changed, 625 insertions(+), 274 deletions(-)
> create mode 100644 tools/testing/selftests/bpf/autoconf_helper.h
> delete mode 100644 tools/testing/selftests/bpf/prog_tests/jeq_infer_not_null.c
> create mode 100644 tools/testing/selftests/bpf/progs/jeq_infer_not_null.c
> create mode 100644 tools/testing/selftests/bpf/unpriv_helpers.c
> create mode 100644 tools/testing/selftests/bpf/unpriv_helpers.h
> delete mode 100644 tools/testing/selftests/bpf/verifier/jeq_infer_not_null.c
>
> --
> 2.39.0
>
