Documentation/dev-tools/kselftest.rst

5 The kernel contains a set of "self tests" under the tools/testing/selftests/
23 On some systems, hot-plug tests could hang forever waiting for cpu and
24 memory to be ready to be offlined. A special hot-plug target is created
25 to run the full range of hot-plug tests. In default mode, hot-plug tests run
26 in safe mode with a limited scope. In limited mode, cpu-hotplug test is
28 hotplug test is run on 2% of hotplug capable memory instead of 10%.
40   $ make -C tools/testing/selftests
44   $ make -C tools/testing/selftests run_tests
54 are supported. In both cases the working directory must be the root of the
55 kernel src. This is applicable to "Running a subset of selftests" section
73 to "Running a subset of selftests" section below.
79 Running a subset of selftests
83 single test to run, or a list of tests to run.
87   $ make -C tools/testing/selftests TARGETS=ptrace run_tests
106   $ make -C tools/testing/selftests SKIP_TARGETS=ptrace run_tests
112 You can also specify a restricted list of tests to run together with a
117 See the top-level tools/testing/selftests/Makefile for the list of all
125   $ make -C tools/testing/selftests hotplug
129   $ make -C tools/testing/selftests run_hotplug
137 You can use the "install" target of "make" (which calls the `kselftest_install.sh`
143    $ make -C tools/testing/selftests install
147    $ make -C tools/testing/selftests install INSTALL_PATH=/some/other/path
161 To see the list of available tests, the `-l` option can be used::
163    $ ./run_kselftest.sh -l
165 The `-c` option can be used to run all the tests from a test collection, or
166 the `-t` option for specific single tests. Either can be used multiple times::
168    $ ./run_kselftest.sh -c size -c seccomp -t timers:posix_timers -t timer:nanosleep
170 For other features see the script usage output, seen with the `-h` option.
175 Selftests are designed to be quick and so a default timeout is used of 45
184 use a greater or lower timeout on the command line as with the `-o` or
185 the `--override-timeout` argument. For example to use 165 seconds instead
188    $ ./run_kselftest.sh --override-timeout 165
200    $ make -C tools/testing/selftests gen_tar
202 This generates a tarball in the `INSTALL_PATH/kselftest-packages` directory. By
204 specifying a `FORMAT` make variable. Any value recognized by `tar's auto-compress`_
207     $ make -C tools/testing/selftests gen_tar FORMAT=.xz
209 `make gen_tar` invokes `make install` so you can use it to package a subset of
210 tests by using variables specified in `Running a subset of selftests`_
213     $ make -C tools/testing/selftests gen_tar TARGETS="size" FORMAT=.xz
215 .. _tar's auto-compress: https://www.gnu.org/software/tar/manual/html_node/gzip.html#auto_002dcompr…
228  * Don't cause the top-level "make run_tests" to fail if your feature is
231  * The output of tests must conform to the TAP standard to ensure high
241  * In your Makefile, use facilities from lib.mk by including it instead of
256    before the test starts. The variable will contain the name of the directory
278     * the part of paths below tools/testing/selftests/ is preserved when
281    TEST_INCLUDES is meant to list dependencies located in other directories of
304     kselftest-{all,install,clean,gen_tar}
305     kselftest-{all,install,clean,gen_tar} O=abo_path
306     kselftest-{all,install,clean,gen_tar} O=rel_path
307     make -C tools/testing/selftests {all,install,clean,gen_tar}
308     make -C tools/testing/selftests {all,install,clean,gen_tar} O=abs_path
309     make -C tools/testing/selftests {all,install,clean,gen_tar} O=rel_path
315 testing from within the kernel, one method of doing this is to create a
321 - ``tools/testing/selftests/kselftest_module.h``
322 - ``tools/testing/selftests/kselftest/module.sh``
329 kernel, but in cases where a non-test module is loaded, TEST_TAINT can be
333 ----------
349 .. code-block:: sh
351    # Assumes you have booted a fresh build of this kernel tree
353    make kselftest-merge
359 --------------
363 .. code-block:: c
365    // SPDX-License-Identifier: GPL-2.0+
393 -------------------
395 .. code-block:: sh
398     # SPDX-License-Identifier: GPL-2.0+
413 -------
415 .. kernel-doc:: tools/testing/selftests/kselftest_harness.h
420 -------
422 .. kernel-doc:: tools/testing/selftests/kselftest_harness.h
428 ---------
430 .. kernel-doc:: tools/testing/selftests/kselftest_harness.h
433 .. kernel-doc:: tools/testing/selftests/kselftest_harness.h