Documentation/dev-tools/kselftest.rst

15 On some systems, hot-plug tests could hang forever waiting for cpu and
16 memory to be ready to be offlined. A special hot-plug target is created
17 to run the full range of hot-plug tests. In default mode, hot-plug tests run
18 in safe mode with a limited scope. In limited mode, cpu-hotplug test is
29 To build the tests::
31   $ make -C tools/testing/selftests
35   $ make -C tools/testing/selftests run_tests
37 To build and run the tests with a single command, use::
49 To build, save output files in a separate directory with O= ::
53 To build, save output files in a separate directory with KBUILD_OUTPUT ::
78   $ make -C tools/testing/selftests TARGETS=ptrace run_tests
80 You can specify multiple tests to build and run::
84 To build, save output files in a separate directory with O= ::
88 To build, save output files in a separate directory with KBUILD_OUTPUT ::
97   $ make -C tools/testing/selftests SKIP_TARGETS=ptrace run_tests
108 See the top-level tools/testing/selftests/Makefile for the list of all
114 To build the hotplug tests::
116   $ make -C tools/testing/selftests hotplug
120   $ make -C tools/testing/selftests run_hotplug
134    $ make -C tools/testing/selftests install
138    $ make -C tools/testing/selftests install INSTALL_PATH=/some/other/path
152 To see the list of available tests, the `-l` option can be used::
154    $ ./run_kselftest.sh -l
156 The `-c` option can be used to run all the tests from a test collection, or
157 the `-t` option for specific single tests. Either can be used multiple times::
159    $ ./run_kselftest.sh -c bpf -c seccomp -t timers:posix_timers -t timer:nanosleep
161 For other features see the script usage output, seen with the `-h` option.
169    $ make -C tools/testing/selftests gen_tar
171 This generates a tarball in the `INSTALL_PATH/kselftest-packages` directory. By
173 specifying a `FORMAT` make variable. Any value recognized by `tar's auto-compress`_
176     $ make -C tools/testing/selftests gen_tar FORMAT=.xz
182     $ make -C tools/testing/selftests gen_tar TARGETS="bpf" FORMAT=.xz
184 .. _tar's auto-compress: https://www.gnu.org/software/tar/manual/html_node/gzip.html#auto_002dcompr…
189 In general, the rules for selftests are
195  * Don't break the build on any architecture, and
197  * Don't cause the top-level "make run_tests" to fail if your feature is
209    TEST_CUSTOM_PROGS should be used by tests that require custom build
210    rules and prevent common build rule use.
242 - ``tools/testing/kselftest/kselftest_module.h``
243 - ``tools/testing/kselftest/kselftest/module.sh``
246 ----------
262 .. code-block:: sh
264    # Assumes you have booted a fresh build of this kernel tree
266    make kselftest-merge
272 --------------
276 .. code-block:: c
278    // SPDX-License-Identifier: GPL-2.0+
305 -------------------
307 .. code-block:: sh
310     # SPDX-License-Identifier: GPL-2.0+
317 The kselftest_harness.h file contains useful helpers to build tests.  The
325 -------
327 .. kernel-doc:: tools/testing/selftests/kselftest_harness.h
332 -------
334 .. kernel-doc:: tools/testing/selftests/kselftest_harness.h
340 ---------
342 .. kernel-doc:: tools/testing/selftests/kselftest_harness.h
345 .. kernel-doc:: tools/testing/selftests/kselftest_harness.h