- Linux-kselftest-mirror - lists.linaro.org

[PATCH bpf-next 0/2] BPF kselftest cross-build/RISC-V fixes

by Björn Töpel

From: Björn Töpel <bjorn(a)rivosinc.com> This series has two minor fixes, found when cross-compiling for the RISC-V architecture. Some RISC-V systems do not define HAVE_EFFICIENT_UNALIGNED_ACCESS, which made some of tests bail out. Fix the failing tests by adding F_NEEDS_EFFICIENT_UNALIGNED_ACCESS. ...and some RISC-V systems *do* define HAVE_EFFICIENT_UNALIGNED_ACCESS. In this case the autoconf.h was not correctly picked up by the build system. Cheers, Björn Björn Töpel (2): selftests/bpf: Add F_NEEDS_EFFICIENT_UNALIGNED_ACCESS to some tests selftests/bpf: Honor $(O) when figuring out paths tools/testing/selftests/bpf/Makefile | 4 ++++ tools/testing/selftests/bpf/verifier/atomic_cmpxchg.c | 1 + tools/testing/selftests/bpf/verifier/ctx_skb.c | 2 ++ tools/testing/selftests/bpf/verifier/jmp32.c | 8 ++++++++ tools/testing/selftests/bpf/verifier/map_kptr.c | 2 ++ tools/testing/selftests/bpf/verifier/precise.c | 2 +- 6 files changed, 18 insertions(+), 1 deletion(-) base-commit: a94098d490e17d652770f2309fcb9b46bc4cf864 -- 2.39.2

1 year, 12 months

2
4
0 0

[PATCH v1] selftests:bpf:Fix repeated initialization

by Wang Ming

In use_missing_map function, value is initialized twice.There is no connection between the two assignment. This patch could fix this bug. Signed-off-by: Wang Ming <machel(a)vivo.com> --- tools/testing/selftests/bpf/progs/test_log_fixup.c | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/tools/testing/selftests/bpf/progs/test_log_fixup.c b/tools/testing/selftests/bpf/progs/test_log_fixup.c index 1bd48feaaa42..1c49b2f9be6c 100644 --- a/tools/testing/selftests/bpf/progs/test_log_fixup.c +++ b/tools/testing/selftests/bpf/progs/test_log_fixup.c @@ -52,13 +52,9 @@ struct { SEC("?raw_tp/sys_enter") int use_missing_map(const void *ctx) { - int zero = 0, *value; + int zero = 0; - value = bpf_map_lookup_elem(&existing_map, &zero); - - value = bpf_map_lookup_elem(&missing_map, &zero); - - return value != NULL; + return bpf_map_lookup_elem(&missing_map, &zero) != NULL; } extern int bpf_nonexistent_kfunc(void) __ksym __weak; -- 2.25.1

1 year, 12 months

3
2
0 0

[PATCH] kselftest/runner.sh: Propagate SIGTERM to runner child

by Björn Töpel

From: Björn Töpel <bjorn(a)rivosinc.com> Timeouts in kselftest are done using the "timeout" command with the "--foreground" option. Without the "foreground" option, it is not possible for a user to cancel the runner using SIGINT, because the signal is not propagated to timeout which is running in a different process group. The "forground" options places the timeout in the same process group as its parent, but only sends the SIGTERM (on timeout) signal to the forked process. Unfortunately, this does not play nice with all kselftests, e.g. "net:fcnal-test.sh", where the child processes will linger because timeout does not send SIGTERM to the group. Some users have noted these hangs [1]. Fix this by nesting the timeout with an additional timeout without the foreground option. Link: https://lore.kernel.org/all/7650b2eb-0aee-a2b0-2e64-c9bc63210f67@alu.unizg.… # [1] Fixes: 651e0d881461 ("kselftest/runner: allow to properly deliver signals to tests") Signed-off-by: Björn Töpel <bjorn(a)rivosinc.com> --- tools/testing/selftests/kselftest/runner.sh | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tools/testing/selftests/kselftest/runner.sh b/tools/testing/selftests/kselftest/runner.sh index 1c952d1401d4..70e0a465e30d 100644 --- a/tools/testing/selftests/kselftest/runner.sh +++ b/tools/testing/selftests/kselftest/runner.sh @@ -36,7 +36,8 @@ tap_timeout() { # Make sure tests will time out if utility is available. if [ -x /usr/bin/timeout ] ; then - /usr/bin/timeout --foreground "$kselftest_timeout" $1 + /usr/bin/timeout --foreground "$kselftest_timeout" \ + /usr/bin/timeout "$kselftest_timeout" $1 else $1 fi base-commit: d528014517f2b0531862c02865b9d4c908019dc4 -- 2.39.2

1 year, 12 months

1
0
0 0

[PATCH][next] selftests: Fix spelling mistake "regesters" -> "registers"

by Colin Ian King

There are spelling mistakes in ksft_test_result_fail messages. Fix them. Signed-off-by: Colin Ian King <colin.i.king(a)gmail.com> --- tools/testing/selftests/riscv/vector/v_initval_nolibc.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/testing/selftests/riscv/vector/v_initval_nolibc.c b/tools/testing/selftests/riscv/vector/v_initval_nolibc.c index 66764edb0d52..62d8884a1a0d 100644 --- a/tools/testing/selftests/riscv/vector/v_initval_nolibc.c +++ b/tools/testing/selftests/riscv/vector/v_initval_nolibc.c @@ -49,14 +49,14 @@ int main(void) ksft_print_msg("vl = %lu\n", vl); if (datap[0] != 0x00 && datap[0] != 0xff) { - ksft_test_result_fail("v-regesters are not properly initialized\n"); + ksft_test_result_fail("v-registers are not properly initialized\n"); dump(datap, vl * 4); exit(-1); } for (i = 1; i < vl * 4; i++) { if (datap[i] != datap[0]) { - ksft_test_result_fail("detect stale values on v-regesters\n"); + ksft_test_result_fail("detect stale values on v-registers\n"); dump(datap, vl * 4); exit(-2); } -- 2.39.2

1 year, 12 months

1
0
0 0

[PATCH net 0/9] mptcp: fixes for v6.5

by Matthieu Baerts

Here is a first batch of fixes for v6.5 and older. The fixes are not linked to each others. Patch 1 ensures subflows are unhashed before cleaning the backlog to avoid races. This fixes another recent fix from v6.4. Patch 2 does not rely on implicit state check in mptcp_listen() to avoid races when receiving an MP_FASTCLOSE. A regression from v5.17. The rest fixes issues in the selftests. Patch 3 makes sure errors when setting up the environment are no longer ignored. For v5.17+. Patch 4 uses 'iptables-legacy' if available to be able to run on older kernels. A fix for v5.13 and newer. Patch 5 catches errors when issues are detected with packet marks. Also for v5.13+. Patch 6 uses the correct variable instead of an undefined one. Even if there was no visible impact, it can help to find regressions later. An issue visible in v5.19+. Patch 7 makes sure errors with some sub-tests are reported to have the selftest marked as failed as expected. Also for v5.19+. Patch 8 adds a kernel config that is required to execute MPTCP selftests. It is valid for v5.9+. Patch 9 fixes issues when validating the userspace path-manager with 32-bit arch, an issue affecting v5.19+. Signed-off-by: Matthieu Baerts <matthieu.baerts(a)tessares.net> --- Matthieu Baerts (7): selftests: mptcp: connect: fail if nft supposed to work selftests: mptcp: sockopt: use 'iptables-legacy' if available selftests: mptcp: sockopt: return error if wrong mark selftests: mptcp: userspace_pm: use correct server port selftests: mptcp: userspace_pm: report errors with 'remove' tests selftests: mptcp: depend on SYN_COOKIES selftests: mptcp: pm_nl_ctl: fix 32-bit support Paolo Abeni (2): mptcp: ensure subflow is unhashed before cleaning the backlog mptcp: do not rely on implicit state check in mptcp_listen() net/mptcp/protocol.c | 7 +++++- tools/testing/selftests/net/mptcp/config | 1 + tools/testing/selftests/net/mptcp/mptcp_connect.sh | 3 +++ tools/testing/selftests/net/mptcp/mptcp_sockopt.sh | 29 ++++++++++++---------- tools/testing/selftests/net/mptcp/pm_nl_ctl.c | 10 ++++---- tools/testing/selftests/net/mptcp/userspace_pm.sh | 4 ++- 6 files changed, 34 insertions(+), 20 deletions(-) --- base-commit: 14bb236b29922c4f57d8c05bfdbcb82677f917c9 change-id: 20230704-upstream-net-20230704-misc-fixes-6-5-rc1-c52608649559 Best regards, -- Matthieu Baerts <matthieu.baerts(a)tessares.net>

1 year, 12 months

2
10
0 0

[PATCH v2 0/2] mm/memfd: fix sysctl MEMFD_NOEXEC_SCOPE_NOEXEC_ENFORCED

by jeffxu＠chromium.org

From: Jeff Xu <jeffxu(a)google.com> When sysctl vm.memfd_noexec is 2 (MEMFD_NOEXEC_SCOPE_NOEXEC_ENFORCED), memfd_create(.., MFD_EXEC) should fail. This complies with how MEMFD_NOEXEC_SCOPE_NOEXEC_ENFORCED is defined - "memfd_create() without MFD_NOEXEC_SEAL will be rejected" Thanks to Dominique Martinet <asmadeus(a)codewreck.org> who reported the bug. see [1] for context. [1] https://lore.kernel.org/linux-mm/CABi2SkXUX_QqTQ10Yx9bBUGpN1wByOi_=gZU6WEy5… History: V2: fix build error when CONFIG_SYSCTL is not defined. V1: initial version https://lore.kernel.org/linux-mm/20230630031721.623955-3-jeffxu@google.com/… Jeff Xu (2): mm/memfd: sysctl: fix MEMFD_NOEXEC_SCOPE_NOEXEC_ENFORCED selftests/memfd: sysctl: fix MEMFD_NOEXEC_SCOPE_NOEXEC_ENFORCED mm/memfd.c | 57 +++++++++++++--------- tools/testing/selftests/memfd/memfd_test.c | 5 ++ 2 files changed, 38 insertions(+), 24 deletions(-) -- 2.41.0.255.g8b1d071c50-goog

1 year, 12 months

1
2
0 0

Loan/Investment offer.

by Frank Dawson

Hello. I am Frank Jody Dawson, I have investors and they are seeking to invest in any lucrative venture worldwide, like aviation, real estate, agriculture, industrial, medical equipment and renewable energy. My investors are mainly from the Arabian countries who are widely in real estate and oil and gas, but now they want to expand their businesses across the globe in any lucrative business. Your profile caught my attention so I decided to message and see if we can work together? Thank you, Frank.

1 year, 12 months

1
0
0 0

[PATCH 0/2] bpf, net: Allow setting SO_TIMESTAMPING* from BPF

by Jörn-Thorben Hinz

BPF applications, e.g., a TCP congestion control, might benefit from precise packet timestamps. These timestamps are already available in __sk_buff and bpf_sock_ops, but could not be requested: A BPF program was not allowed to set SO_TIMESTAMPING* on a socket. This change enables BPF programs to actively request the generation of timestamps from a stream socket. To reuse the setget_sockopt BPF prog test for bpf_{get,set}sockopt(SO_TIMESTAMPING_NEW), also implement the missing getsockopt(SO_TIMESTAMPING_NEW) in the network stack. I reckon the way I added getsockopt(SO_TIMESTAMPING_NEW) causes an API change: For existing users that set SO_TIMESTAMPING_NEW but queried SO_TIMESTAMPING_OLD afterwards, it would now look as if no timestamping flags have been set. Is this an acceptable change? If not, I’m happy to change getsockopt() to only be strict about the newly-implemented getsockopt(SO_TIMESTAMPING_NEW), or not distinguish between SO_TIMESTAMPING_NEW and SO_TIMESTAMPING_OLD at all. Jörn-Thorben Hinz (2): net: Implement missing getsockopt(SO_TIMESTAMPING_NEW) bpf: Allow setting SO_TIMESTAMPING* with bpf_setsockopt() include/uapi/linux/bpf.h | 3 ++- net/core/filter.c | 2 ++ net/core/sock.c | 9 +++++++-- tools/include/uapi/linux/bpf.h | 3 ++- tools/testing/selftests/bpf/progs/bpf_tracing_net.h | 2 ++ tools/testing/selftests/bpf/progs/setget_sockopt.c | 4 ++++ 6 files changed, 19 insertions(+), 4 deletions(-) -- 2.39.2

1 year, 12 months

4
6
0 0

[linux-next:master] BUILD REGRESSION 1c6f93977947dbba1fc4d250c4eb8a7d4cfdecf1

by kernel test robot

tree/branch: https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git master branch HEAD: 1c6f93977947dbba1fc4d250c4eb8a7d4cfdecf1 Add linux-next specific files for 20230704 Error/Warning reports: https://lore.kernel.org/oe-kbuild-all/202306260401.qZlYQpV2-lkp@intel.com https://lore.kernel.org/oe-kbuild-all/202306301709.lvrxzyCj-lkp@intel.com https://lore.kernel.org/oe-kbuild-all/202306301756.x8dgyYnL-lkp@intel.com Error/Warning: (recently discovered and may have been fixed) drivers/bluetooth/btmtk.c:386:32: error: no member named 'dump' in 'struct hci_dev' drivers/bluetooth/btmtk.c:386:44: error: 'struct hci_dev' has no member named 'dump' drivers/char/mem.c:164:25: error: implicit declaration of function 'unxlate_dev_mem_ptr'; did you mean 'xlate_dev_mem_ptr'? [-Werror=implicit-function-declaration] drivers/mfd/max77541.c:176:18: warning: cast to smaller integer type 'enum max7754x_ids' from 'const void *' [-Wvoid-pointer-to-enum-cast] lib/kunit/executor_test.c:138:4: warning: cast from 'void (*)(const void *)' to 'kunit_action_t *' (aka 'void (*)(void *)') converts to incompatible function type [-Wcast-function-type-strict] lib/kunit/test.c:775:38: warning: cast from 'void (*)(const void *)' to 'kunit_action_t *' (aka 'void (*)(void *)') converts to incompatible function type [-Wcast-function-type-strict] Unverified Error/Warning (likely false positive, please contact us if interested): drivers/vhost/vhost.c:1654 vhost_vring_ioctl() error: uninitialized symbol 'vq'. drivers/vhost/vhost.c:1685 vhost_vring_ioctl() error: uninitialized symbol 'idx'. drivers/vhost/vhost.c:763 vhost_worker_ioctl() error: uninitialized symbol 'vq'. drivers/vhost/vhost.c:774 vhost_worker_ioctl() error: uninitialized symbol 'idx'. {standard input}: Error: local label `"2" (instance number 9 of a fb label)' is not defined Error/Warning ids grouped by kconfigs: gcc_recent_errors |-- alpha-randconfig-r002-20230704 | `-- drivers-bluetooth-btmtk.c:error:struct-hci_dev-has-no-member-named-dump |-- loongarch-randconfig-r022-20230704 | `-- drivers-bluetooth-btmtk.c:error:struct-hci_dev-has-no-member-named-dump |-- m68k-randconfig-r016-20230704 | `-- drivers-bluetooth-btmtk.c:error:struct-hci_dev-has-no-member-named-dump |-- microblaze-randconfig-r073-20230703 | `-- drivers-bluetooth-btmtk.c:error:struct-hci_dev-has-no-member-named-dump |-- nios2-randconfig-r034-20230704 | `-- drivers-bluetooth-btmtk.c:error:struct-hci_dev-has-no-member-named-dump |-- riscv-randconfig-m031-20230703 | |-- drivers-vhost-vhost.c-vhost_vring_ioctl()-error:uninitialized-symbol-idx-. | |-- drivers-vhost-vhost.c-vhost_vring_ioctl()-error:uninitialized-symbol-vq-. | |-- drivers-vhost-vhost.c-vhost_worker_ioctl()-error:uninitialized-symbol-idx-. | `-- drivers-vhost-vhost.c-vhost_worker_ioctl()-error:uninitialized-symbol-vq-. |-- sh-allmodconfig | |-- drivers-char-mem.c:error:implicit-declaration-of-function-unxlate_dev_mem_ptr | `-- standard-input:Error:local-label-(instance-number-of-a-fb-label)-is-not-defined |-- sh-randconfig-r015-20230704 | |-- drivers-bluetooth-btmtk.c:error:struct-hci_dev-has-no-member-named-dump | `-- drivers-char-mem.c:error:implicit-declaration-of-function-unxlate_dev_mem_ptr |-- sh-sh7710voipgw_defconfig | `-- drivers-char-mem.c:error:implicit-declaration-of-function-unxlate_dev_mem_ptr |-- sparc-randconfig-r005-20230704 | `-- drivers-bluetooth-btmtk.c:error:struct-hci_dev-has-no-member-named-dump `-- x86_64-buildonly-randconfig-r003-20230703 `-- drivers-bluetooth-btmtk.c:error:struct-hci_dev-has-no-member-named-dump clang_recent_errors |-- arm64-randconfig-r033-20230704 | `-- drivers-mfd-max77541.c:warning:cast-to-smaller-integer-type-enum-max7754x_ids-from-const-void |-- hexagon-randconfig-r041-20230703 | |-- drivers-bluetooth-btmtk.c:error:no-member-named-dump-in-struct-hci_dev | |-- lib-kunit-executor_test.c:warning:cast-from-void-(-)(const-void-)-to-kunit_action_t-(aka-void-(-)(void-)-)-converts-to-incompatible-function-type | `-- lib-kunit-test.c:warning:cast-from-void-(-)(const-void-)-to-kunit_action_t-(aka-void-(-)(void-)-)-converts-to-incompatible-function-type |-- hexagon-randconfig-r045-20230703 | |-- lib-kunit-executor_test.c:warning:cast-from-void-(-)(const-void-)-to-kunit_action_t-(aka-void-(-)(void-)-)-converts-to-incompatible-function-type | `-- lib-kunit-test.c:warning:cast-from-void-(-)(const-void-)-to-kunit_action_t-(aka-void-(-)(void-)-)-converts-to-incompatible-function-type |-- i386-randconfig-i011-20230703 | `-- drivers-bluetooth-btmtk.c:error:no-member-named-dump-in-struct-hci_dev `-- s390-randconfig-r006-20230704 |-- lib-kunit-executor_test.c:warning:cast-from-void-(-)(const-void-)-to-kunit_action_t-(aka-void-(-)(void-)-)-converts-to-incompatible-function-type `-- lib-kunit-test.c:warning:cast-from-void-(-)(const-void-)-to-kunit_action_t-(aka-void-(-)(void-)-)-converts-to-incompatible-function-type elapsed time: 734m configs tested: 148 configs skipped: 9 tested configs: alpha allyesconfig gcc alpha defconfig gcc alpha randconfig-r002-20230704 gcc alpha randconfig-r003-20230704 gcc alpha randconfig-r004-20230704 gcc alpha randconfig-r023-20230703 gcc alpha randconfig-r035-20230704 gcc arc alldefconfig gcc arc allyesconfig gcc arc defconfig gcc arc randconfig-r021-20230704 gcc arc randconfig-r043-20230703 gcc arm allmodconfig gcc arm allyesconfig gcc arm defconfig gcc arm randconfig-r002-20230704 gcc arm randconfig-r014-20230704 clang arm randconfig-r026-20230703 gcc arm randconfig-r032-20230704 gcc arm randconfig-r046-20230703 gcc arm s3c6400_defconfig gcc arm s5pv210_defconfig clang arm u8500_defconfig gcc arm64 allyesconfig gcc arm64 defconfig gcc arm64 randconfig-r033-20230704 clang csky alldefconfig gcc csky defconfig gcc csky randconfig-r022-20230703 gcc hexagon randconfig-r033-20230704 clang hexagon randconfig-r041-20230703 clang hexagon randconfig-r045-20230703 clang i386 allyesconfig gcc i386 buildonly-randconfig-r004-20230703 gcc i386 buildonly-randconfig-r005-20230703 gcc i386 buildonly-randconfig-r006-20230703 gcc i386 debian-10.3 gcc i386 defconfig gcc i386 randconfig-i001-20230704 clang i386 randconfig-i002-20230704 clang i386 randconfig-i003-20230704 clang i386 randconfig-i004-20230704 clang i386 randconfig-i005-20230704 clang i386 randconfig-i006-20230704 clang i386 randconfig-i011-20230703 clang i386 randconfig-i012-20230703 clang i386 randconfig-i013-20230703 clang i386 randconfig-i014-20230703 clang i386 randconfig-i015-20230703 clang i386 randconfig-i016-20230703 clang i386 randconfig-r005-20230704 clang i386 randconfig-r032-20230704 clang loongarch allmodconfig gcc loongarch allnoconfig gcc loongarch defconfig gcc loongarch randconfig-r022-20230704 gcc m68k allmodconfig gcc m68k allyesconfig gcc m68k defconfig gcc m68k randconfig-r016-20230704 gcc microblaze randconfig-r011-20230704 gcc microblaze randconfig-r015-20230704 gcc microblaze randconfig-r023-20230704 gcc mips allmodconfig gcc mips allyesconfig gcc mips ci20_defconfig gcc mips decstation_defconfig gcc mips decstation_r4k_defconfig gcc mips maltaup_defconfig clang mips mtx1_defconfig clang mips qi_lb60_defconfig clang mips randconfig-r013-20230704 clang mips randconfig-r031-20230704 gcc nios2 defconfig gcc nios2 randconfig-r004-20230704 gcc nios2 randconfig-r006-20230704 gcc nios2 randconfig-r012-20230704 gcc nios2 randconfig-r034-20230704 gcc openrisc alldefconfig gcc openrisc or1klitex_defconfig gcc openrisc randconfig-r014-20230704 gcc parisc allyesconfig gcc parisc defconfig gcc parisc randconfig-r001-20230704 gcc parisc randconfig-r012-20230704 gcc parisc64 defconfig gcc powerpc allmodconfig gcc powerpc allnoconfig gcc powerpc microwatt_defconfig clang powerpc randconfig-r001-20230704 clang powerpc randconfig-r011-20230704 gcc powerpc tqm8560_defconfig clang riscv allmodconfig gcc riscv allnoconfig gcc riscv allyesconfig gcc riscv defconfig gcc riscv randconfig-r024-20230704 gcc riscv randconfig-r042-20230703 clang riscv rv32_defconfig gcc s390 randconfig-r006-20230704 clang s390 randconfig-r044-20230703 clang sh allmodconfig gcc sh randconfig-r015-20230704 gcc sh randconfig-r026-20230704 gcc sh rts7751r2dplus_defconfig gcc sh sdk7786_defconfig gcc sh se7750_defconfig gcc sh sh7710voipgw_defconfig gcc sh shx3_defconfig gcc sparc allyesconfig gcc sparc defconfig gcc sparc randconfig-r005-20230704 gcc sparc randconfig-r036-20230704 gcc sparc64 defconfig gcc sparc64 randconfig-r016-20230704 gcc sparc64 randconfig-r024-20230703 gcc sparc64 randconfig-r035-20230704 gcc um alldefconfig gcc um allmodconfig clang um allnoconfig clang um allyesconfig clang um defconfig gcc um i386_defconfig gcc um randconfig-r025-20230704 clang um randconfig-r031-20230704 gcc um randconfig-r034-20230704 gcc um x86_64_defconfig gcc x86_64 allyesconfig gcc x86_64 buildonly-randconfig-r001-20230703 gcc x86_64 buildonly-randconfig-r002-20230703 gcc x86_64 buildonly-randconfig-r003-20230703 gcc x86_64 defconfig gcc x86_64 kexec gcc x86_64 randconfig-x001-20230703 clang x86_64 randconfig-x002-20230703 clang x86_64 randconfig-x003-20230703 clang x86_64 randconfig-x004-20230703 clang x86_64 randconfig-x005-20230703 clang x86_64 randconfig-x006-20230703 clang x86_64 randconfig-x011-20230703 gcc x86_64 randconfig-x012-20230703 gcc x86_64 randconfig-x013-20230703 gcc x86_64 randconfig-x014-20230703 gcc x86_64 randconfig-x015-20230703 gcc x86_64 randconfig-x016-20230703 gcc x86_64 rhel-8.3-rust clang x86_64 rhel-8.3 gcc xtensa common_defconfig gcc -- 0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests/wiki

1 year, 12 months

1
0
0 0

Tests documentation

by Mauro Carvalho Chehab

Hi Jon, Shuah & others, I'd like to discuss with you with regards to test documentation. I had some preliminary discussions with people interested on improving tests during EOSS last week in Prague, as we're working to improve media test coverage as well. During such discussions, I talked with developers from several companies that have been collaboration and/or using Kernel CI. I also talked with Nikolai from Red Hat, who gave a presentation about Kernel CI, which points that one of the areas to be improved there is documentation. So, it seems it is worth having some discussions about how to improve Kernel test documentation. While kernel_doc does a pretty decent job documenting functions and data structures, for tests, the most important things to be documented are: a. what the tests do; b. what functionalities they are testing. This is a lot more important than documenting functions - and the used data structures on tests are typically the ones that are part of the driver's kAPI or uAPI, so they should be documented somewhere else. Usually, (b) is not so simple, as, at least for complex hardware, the tested features are grouped on an hierarchical way, like: 1. hardware 1.1 DMA engine 1.2 output ports ... 2. firmware 2.1 firmware load 2.2 firmware DMA actions ... 3. kernel features 3.1 memory allocation 3.2 mmap 3.3 bind/unbind ... CI engines running the test sets usually want to produce a report that will be providing pass rates for the tested features and functionalites that are available at the driver's and their respective hardware and firmware. I've doing some work at the tool we use to test DRM code [1] in order to have a decent documentation of the tests we have hosted there, focusing mostly on tests for i915 and Xe Intel drivers, also covering documentation for DRM core tests - while providing support for other vendors to also improve their test documentation for IGT - IGT GPU tools and tests. The documentation tool I developed is generic enough to be used for other test sets and I believe it could be useful as well to document Kselftest and KUnit. The core of the tool (at test_list.py) is a Python class, with some callers (igt_doc.py, xls_to_doc.py, doc_to_xls.py), being extensible enough to also have other callers to integrate with external tools. We are developing internally one to integrate with our internal Grafana reports to report the pass rate per documented feature, in an hierarchical way. Something similar to: 1. hardware pass rate: 98% (98 tests passed of 100) 1.1 DMA engine pass rate: 80% (8 tests passed of 10) 1.2 output ports pass rate: 100% (10 tests passed of 10) ... It is based on the concept that test documentation should be placed as close as possible to the actual code implementing the test sets. It was also be developed in a way that the documentation grouping is flexible. The code was written from the scratch in Python and was implemented inside a class that can also be re-used to do do other nice things, like importing/exporting test documentation to spreadsheets and integration with other tools (like Grafana). The actual documentation tags look like this: /** * TEST: Check if new IGT test documentation logic functionality is working * Category: Software build block * Sub-category: documentation * Functionality: test documentation * Issue: none * Description: Complete description of this test * * SUBTEST: foo * Description: do foo things * description continuing on another line * * SUBTEST: bar * Description: do bar things * description continuing on another line * Functionality: bar test doc */ And it has support for wildcards. There, "TEST" is associated to the contents of the file, while "SUBTEST" refers to each specific subtest inside it. The valid fields are imported from JSON config files, and can be placed into an hierarchical way, in order to produce an hierarchical documentation. Fields defined at the "TEST" level are imported on "SUBTEST", but can be overriden. The JSON config file looks like this: https://gitlab.freedesktop.org/drm/igt-gpu-tools/-/blob/158feaa20fa2b9424ee… The output is in ReST, which can be generated in hierarchical or per-file way. The hierarchical output looks like this: $ ./scripts/igt_doc.py --config tests/xe/xe_test_config.json --file fubar_tests.c =============================== Implemented Tests for Xe Driver =============================== Category: Software build block ============================== Sub-category: documentation --------------------------- Functionality: bar test doc ^^^^^^^^^^^^^^^^^^^^^^^^^^^ ``igt@fubar_tests@bar`` :Description: do bar things description continuing on another line :Issue: none Functionality: test documentation ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ``igt@fubar_tests@foo`` :Description: do foo things description continuing on another line :Issue: none (if --file is not used, it will use all C files specified at the configuration) The tool already skips tags like the ones used by kernel-doc[1], so one could have both function documentation and per-test documentation on the same file, if needed. While such tool was conceived to be part of IGT, it doesn't have anything specific for it [2], and I do believe it would be a great contribution to the Kernel to have such tool upstreamed, and integrated as a Sphinx extension. If we decide to go ahead adding it, I can work on a patchset to apply it to the Kernel, modifying the scripts to better fit at the Kernel needs and start with some documentation examples for i915, DRM core and upcoming Xe KUnit tests. Comments? Regards, Mauro [1] It should be trivial to patch kernel-doc for it to skip TEST and SUBTEST tags if we decide to integrate it to the kernel. [2] except that tests there are named after IGT, as <igt <test>@<subtest>@<dynamic_subtest>, but a change to a Kernel-specific namespace would be trivial

1 year, 12 months

3
2
0 0

2025

2024

2023

2022

2021

2020

2019

2018

2017

Linux-kselftest-mirror