From: Mickaël Salaün Date: Fri, 26 May 2017 18:43:59 +0000 (+0200) Subject: Documentation/dev-tools: Add kselftest X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=55c70f11e729f17c86f2400a457138682e03b00f;p=GitHub%2Fmoto-9609%2Fandroid_kernel_motorola_exynos9610.git Documentation/dev-tools: Add kselftest Move kselftest.txt to dev-tools/kselftest.rst . Signed-off-by: Mickaël Salaün Acked-by: Kees Cook Cc: Jonathan Corbet Cc: Shuah Khan Signed-off-by: Shuah Khan --- diff --git a/Documentation/00-INDEX b/Documentation/00-INDEX index ed3e5e949fce..6daf51536153 100644 --- a/Documentation/00-INDEX +++ b/Documentation/00-INDEX @@ -246,8 +246,6 @@ kprobes.txt - documents the kernel probes debugging feature. kref.txt - docs on adding reference counters (krefs) to kernel objects. -kselftest.txt - - small unittests for (some) individual codepaths in the kernel. laptops/ - directory with laptop related info and laptop driver documentation. ldm.txt diff --git a/Documentation/dev-tools/kselftest.rst b/Documentation/dev-tools/kselftest.rst new file mode 100644 index 000000000000..5bd590335839 --- /dev/null +++ b/Documentation/dev-tools/kselftest.rst @@ -0,0 +1,109 @@ +Linux Kernel Selftests + +The kernel contains a set of "self tests" under the tools/testing/selftests/ +directory. These are intended to be small tests to exercise individual code +paths in the kernel. Tests are intended to be run after building, installing +and booting a kernel. + +On some systems, hot-plug tests could hang forever waiting for cpu and +memory to be ready to be offlined. A special hot-plug target is created +to run full range of hot-plug tests. In default mode, hot-plug tests run +in safe mode with a limited scope. In limited mode, cpu-hotplug test is +run on a single cpu as opposed to all hotplug capable cpus, and memory +hotplug test is run on 2% of hotplug capable memory instead of 10%. + +Running the selftests (hotplug tests are run in limited mode) +============================================================= + +To build the tests: + $ make -C tools/testing/selftests + + +To run the tests: + $ make -C tools/testing/selftests run_tests + +To build and run the tests with a single command, use: + $ make kselftest + +- note that some tests will require root privileges. + + +Running a subset of selftests +======================================== +You can use the "TARGETS" variable on the make command line to specify +single test to run, or a list of tests to run. + +To run only tests targeted for a single subsystem: + $ make -C tools/testing/selftests TARGETS=ptrace run_tests + +You can specify multiple tests to build and run: + $ make TARGETS="size timers" kselftest + +See the top-level tools/testing/selftests/Makefile for the list of all +possible targets. + + +Running the full range hotplug selftests +======================================== + +To build the hotplug tests: + $ make -C tools/testing/selftests hotplug + +To run the hotplug tests: + $ make -C tools/testing/selftests run_hotplug + +- note that some tests will require root privileges. + + +Install selftests +================= + +You can use kselftest_install.sh tool installs selftests in default +location which is tools/testing/selftests/kselftest or a user specified +location. + +To install selftests in default location: + $ cd tools/testing/selftests + $ ./kselftest_install.sh + +To install selftests in a user specified location: + $ cd tools/testing/selftests + $ ./kselftest_install.sh install_dir + +Running installed selftests +=========================== + +Kselftest install as well as the Kselftest tarball provide a script +named "run_kselftest.sh" to run the tests. + +You can simply do the following to run the installed Kselftests. Please +note some tests will require root privileges. + +cd kselftest +./run_kselftest.sh + +Contributing new tests +====================== + +In general, the rules for selftests are + + * Do as much as you can if you're not root; + + * Don't take too long; + + * Don't break the build on any architecture, and + + * Don't cause the top-level "make run_tests" to fail if your feature is + unconfigured. + +Contributing new tests(details) +=============================== + + * Use TEST_GEN_XXX if such binaries or files are generated during + compiling. + TEST_PROGS, TEST_GEN_PROGS mean it is the excutable tested by + default. + TEST_PROGS_EXTENDED, TEST_GEN_PROGS_EXTENDED mean it is the + executable which is not tested by default. + TEST_FILES, TEST_GEN_FILES mean it is the file which is used by + test. diff --git a/Documentation/kselftest.txt b/Documentation/kselftest.txt deleted file mode 100644 index 5bd590335839..000000000000 --- a/Documentation/kselftest.txt +++ /dev/null @@ -1,109 +0,0 @@ -Linux Kernel Selftests - -The kernel contains a set of "self tests" under the tools/testing/selftests/ -directory. These are intended to be small tests to exercise individual code -paths in the kernel. Tests are intended to be run after building, installing -and booting a kernel. - -On some systems, hot-plug tests could hang forever waiting for cpu and -memory to be ready to be offlined. A special hot-plug target is created -to run full range of hot-plug tests. In default mode, hot-plug tests run -in safe mode with a limited scope. In limited mode, cpu-hotplug test is -run on a single cpu as opposed to all hotplug capable cpus, and memory -hotplug test is run on 2% of hotplug capable memory instead of 10%. - -Running the selftests (hotplug tests are run in limited mode) -============================================================= - -To build the tests: - $ make -C tools/testing/selftests - - -To run the tests: - $ make -C tools/testing/selftests run_tests - -To build and run the tests with a single command, use: - $ make kselftest - -- note that some tests will require root privileges. - - -Running a subset of selftests -======================================== -You can use the "TARGETS" variable on the make command line to specify -single test to run, or a list of tests to run. - -To run only tests targeted for a single subsystem: - $ make -C tools/testing/selftests TARGETS=ptrace run_tests - -You can specify multiple tests to build and run: - $ make TARGETS="size timers" kselftest - -See the top-level tools/testing/selftests/Makefile for the list of all -possible targets. - - -Running the full range hotplug selftests -======================================== - -To build the hotplug tests: - $ make -C tools/testing/selftests hotplug - -To run the hotplug tests: - $ make -C tools/testing/selftests run_hotplug - -- note that some tests will require root privileges. - - -Install selftests -================= - -You can use kselftest_install.sh tool installs selftests in default -location which is tools/testing/selftests/kselftest or a user specified -location. - -To install selftests in default location: - $ cd tools/testing/selftests - $ ./kselftest_install.sh - -To install selftests in a user specified location: - $ cd tools/testing/selftests - $ ./kselftest_install.sh install_dir - -Running installed selftests -=========================== - -Kselftest install as well as the Kselftest tarball provide a script -named "run_kselftest.sh" to run the tests. - -You can simply do the following to run the installed Kselftests. Please -note some tests will require root privileges. - -cd kselftest -./run_kselftest.sh - -Contributing new tests -====================== - -In general, the rules for selftests are - - * Do as much as you can if you're not root; - - * Don't take too long; - - * Don't break the build on any architecture, and - - * Don't cause the top-level "make run_tests" to fail if your feature is - unconfigured. - -Contributing new tests(details) -=============================== - - * Use TEST_GEN_XXX if such binaries or files are generated during - compiling. - TEST_PROGS, TEST_GEN_PROGS mean it is the excutable tested by - default. - TEST_PROGS_EXTENDED, TEST_GEN_PROGS_EXTENDED mean it is the - executable which is not tested by default. - TEST_FILES, TEST_GEN_FILES mean it is the file which is used by - test.