1 ====================== 1 ======================
2 Linux Kernel Selftests 2 Linux Kernel Selftests
3 ====================== 3 ======================
4 4
5 The kernel contains a set of "self tests" unde 5 The kernel contains a set of "self tests" under the tools/testing/selftests/
6 directory. These are intended to be small test 6 directory. These are intended to be small tests to exercise individual code
7 paths in the kernel. Tests are intended to be 7 paths in the kernel. Tests are intended to be run after building, installing
8 and booting a kernel. 8 and booting a kernel.
9 9
10 Kselftest from mainline can be run on older st <<
11 from mainline offers the best coverage. Severa <<
12 kselftest suite on stable releases. The reason <<
13 gets added to test existing code to regression <<
14 able to run that test on an older kernel. Henc <<
15 code that can still test an older kernel and m <<
16 gracefully on newer releases. <<
17 <<
18 You can find additional information on Kselfte 10 You can find additional information on Kselftest framework, how to
19 write new tests using the framework on Kselfte 11 write new tests using the framework on Kselftest wiki:
20 12
21 https://kselftest.wiki.kernel.org/ 13 https://kselftest.wiki.kernel.org/
22 14
23 On some systems, hot-plug tests could hang for 15 On some systems, hot-plug tests could hang forever waiting for cpu and
24 memory to be ready to be offlined. A special h 16 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 de 17 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 18 in safe mode with a limited scope. In limited mode, cpu-hotplug test is
27 run on a single cpu as opposed to all hotplug 19 run on a single cpu as opposed to all hotplug capable cpus, and memory
28 hotplug test is run on 2% of hotplug capable m 20 hotplug test is run on 2% of hotplug capable memory instead of 10%.
29 21
30 kselftest runs as a userspace process. Tests 22 kselftest runs as a userspace process. Tests that can be written/run in
31 userspace may wish to use the `Test Harness`_. 23 userspace may wish to use the `Test Harness`_. Tests that need to be
32 run in kernel space may wish to use a `Test Mo 24 run in kernel space may wish to use a `Test Module`_.
33 25
34 Running the selftests (hotplug tests are run i 26 Running the selftests (hotplug tests are run in limited mode)
35 ============================================== 27 =============================================================
36 28
37 To build the tests:: 29 To build the tests::
38 30
39 $ make headers <<
40 $ make -C tools/testing/selftests 31 $ make -C tools/testing/selftests
41 32
42 To run the tests:: 33 To run the tests::
43 34
44 $ make -C tools/testing/selftests run_tests 35 $ make -C tools/testing/selftests run_tests
45 36
46 To build and run the tests with a single comma 37 To build and run the tests with a single command, use::
47 38
48 $ make kselftest 39 $ make kselftest
49 40
50 Note that some tests will require root privile 41 Note that some tests will require root privileges.
51 42
52 Kselftest supports saving output files in a se 43 Kselftest supports saving output files in a separate directory and then
53 running tests. To locate output files in a sep 44 running tests. To locate output files in a separate directory two syntaxes
54 are supported. In both cases the working direc 45 are supported. In both cases the working directory must be the root of the
55 kernel src. This is applicable to "Running a s 46 kernel src. This is applicable to "Running a subset of selftests" section
56 below. 47 below.
57 48
58 To build, save output files in a separate dire 49 To build, save output files in a separate directory with O= ::
59 50
60 $ make O=/tmp/kselftest kselftest 51 $ make O=/tmp/kselftest kselftest
61 52
62 To build, save output files in a separate dire 53 To build, save output files in a separate directory with KBUILD_OUTPUT ::
63 54
64 $ export KBUILD_OUTPUT=/tmp/kselftest; make 55 $ export KBUILD_OUTPUT=/tmp/kselftest; make kselftest
65 56
66 The O= assignment takes precedence over the KB 57 The O= assignment takes precedence over the KBUILD_OUTPUT environment
67 variable. 58 variable.
68 59
69 The above commands by default run the tests an 60 The above commands by default run the tests and print full pass/fail report.
70 Kselftest supports "summary" option to make it 61 Kselftest supports "summary" option to make it easier to understand the test
71 results. Please find the detailed individual t 62 results. Please find the detailed individual test results for each test in
72 /tmp/testname file(s) when summary option is s 63 /tmp/testname file(s) when summary option is specified. This is applicable
73 to "Running a subset of selftests" section bel 64 to "Running a subset of selftests" section below.
74 65
75 To run kselftest with summary option enabled : 66 To run kselftest with summary option enabled ::
76 67
77 $ make summary=1 kselftest 68 $ make summary=1 kselftest
78 69
79 Running a subset of selftests 70 Running a subset of selftests
80 ============================= 71 =============================
81 72
82 You can use the "TARGETS" variable on the make 73 You can use the "TARGETS" variable on the make command line to specify
83 single test to run, or a list of tests to run. 74 single test to run, or a list of tests to run.
84 75
85 To run only tests targeted for a single subsys 76 To run only tests targeted for a single subsystem::
86 77
87 $ make -C tools/testing/selftests TARGETS=pt 78 $ make -C tools/testing/selftests TARGETS=ptrace run_tests
88 79
89 You can specify multiple tests to build and ru 80 You can specify multiple tests to build and run::
90 81
91 $ make TARGETS="size timers" kselftest 82 $ make TARGETS="size timers" kselftest
92 83
93 To build, save output files in a separate dire 84 To build, save output files in a separate directory with O= ::
94 85
95 $ make O=/tmp/kselftest TARGETS="size timers 86 $ make O=/tmp/kselftest TARGETS="size timers" kselftest
96 87
97 To build, save output files in a separate dire 88 To build, save output files in a separate directory with KBUILD_OUTPUT ::
98 89
99 $ export KBUILD_OUTPUT=/tmp/kselftest; make 90 $ export KBUILD_OUTPUT=/tmp/kselftest; make TARGETS="size timers" kselftest
100 91
101 Additionally you can use the "SKIP_TARGETS" va 92 Additionally you can use the "SKIP_TARGETS" variable on the make command
102 line to specify one or more targets to exclude 93 line to specify one or more targets to exclude from the TARGETS list.
103 94
104 To run all tests but a single subsystem:: 95 To run all tests but a single subsystem::
105 96
106 $ make -C tools/testing/selftests SKIP_TARGE 97 $ make -C tools/testing/selftests SKIP_TARGETS=ptrace run_tests
107 98
108 You can specify multiple tests to skip:: 99 You can specify multiple tests to skip::
109 100
110 $ make SKIP_TARGETS="size timers" kselftest 101 $ make SKIP_TARGETS="size timers" kselftest
111 102
112 You can also specify a restricted list of test 103 You can also specify a restricted list of tests to run together with a
113 dedicated skiplist:: 104 dedicated skiplist::
114 105
115 $ make TARGETS="breakpoints size timers" SK !! 106 $ make TARGETS="bpf breakpoints size timers" SKIP_TARGETS=bpf kselftest
116 107
117 See the top-level tools/testing/selftests/Make 108 See the top-level tools/testing/selftests/Makefile for the list of all
118 possible targets. 109 possible targets.
119 110
120 Running the full range hotplug selftests 111 Running the full range hotplug selftests
121 ======================================== 112 ========================================
122 113
123 To build the hotplug tests:: 114 To build the hotplug tests::
124 115
125 $ make -C tools/testing/selftests hotplug 116 $ make -C tools/testing/selftests hotplug
126 117
127 To run the hotplug tests:: 118 To run the hotplug tests::
128 119
129 $ make -C tools/testing/selftests run_hotplu 120 $ make -C tools/testing/selftests run_hotplug
130 121
131 Note that some tests will require root privile 122 Note that some tests will require root privileges.
132 123
133 124
134 Install selftests 125 Install selftests
135 ================= 126 =================
136 127
137 You can use the "install" target of "make" (wh !! 128 You can use the kselftest_install.sh tool to install selftests in the
138 tool) to install selftests in the default loca !! 129 default location, which is tools/testing/selftests/kselftest, or in a
139 or in a user specified location via the `INSTA !! 130 user specified location.
140 131
141 To install selftests in default location:: 132 To install selftests in default location::
142 133
143 $ make -C tools/testing/selftests install !! 134 $ cd tools/testing/selftests
>> 135 $ ./kselftest_install.sh
144 136
145 To install selftests in a user specified locat 137 To install selftests in a user specified location::
146 138
147 $ make -C tools/testing/selftests install I !! 139 $ cd tools/testing/selftests
>> 140 $ ./kselftest_install.sh install_dir
148 141
149 Running installed selftests 142 Running installed selftests
150 =========================== 143 ===========================
151 144
152 Found in the install directory, as well as in !! 145 Kselftest install as well as the Kselftest tarball provide a script
153 is a script named `run_kselftest.sh` to run th !! 146 named "run_kselftest.sh" to run the tests.
154 147
155 You can simply do the following to run the ins 148 You can simply do the following to run the installed Kselftests. Please
156 note some tests will require root privileges:: 149 note some tests will require root privileges::
157 150
158 $ cd kselftest_install !! 151 $ cd kselftest
159 $ ./run_kselftest.sh 152 $ ./run_kselftest.sh
160 153
161 To see the list of available tests, the `-l` o <<
162 <<
163 $ ./run_kselftest.sh -l <<
164 <<
165 The `-c` option can be used to run all the tes <<
166 the `-t` option for specific single tests. Eit <<
167 <<
168 $ ./run_kselftest.sh -c size -c seccomp -t <<
169 <<
170 For other features see the script usage output <<
171 <<
172 Timeout for selftests <<
173 ===================== <<
174 <<
175 Selftests are designed to be quick and so a de <<
176 seconds for each test. Tests can override the <<
177 a settings file in their directory and set a t <<
178 configured a desired upper timeout for the tes <<
179 the timeout with a value higher than 45 second <<
180 it that way. Timeouts in selftests are not con <<
181 system under which a test runs may change and <<
182 expected time it takes to run a test. If you h <<
183 which will run the tests you can configure a t <<
184 use a greater or lower timeout on the command <<
185 the `--override-timeout` argument. For example <<
186 one would use:: <<
187 <<
188 $ ./run_kselftest.sh --override-timeout 165 <<
189 <<
190 You can look at the TAP output to see if you r <<
191 runners which know a test must run under a spe <<
192 treat these timeouts then as fatal. <<
193 <<
194 Packaging selftests 154 Packaging selftests
195 =================== 155 ===================
196 156
197 In some cases packaging is desired, such as wh 157 In some cases packaging is desired, such as when tests need to run on a
198 different system. To package selftests, run:: 158 different system. To package selftests, run::
199 159
200 $ make -C tools/testing/selftests gen_tar 160 $ make -C tools/testing/selftests gen_tar
201 161
202 This generates a tarball in the `INSTALL_PATH/ 162 This generates a tarball in the `INSTALL_PATH/kselftest-packages` directory. By
203 default, `.gz` format is used. The tar compres !! 163 default, `.gz` format is used. The tar format can be overridden by specifying
204 specifying a `FORMAT` make variable. Any value !! 164 a `FORMAT` make variable. Any value recognized by `tar's auto-compress`_ option
205 option is supported, such as:: !! 165 is supported, such as::
206 166
207 $ make -C tools/testing/selftests gen_tar 167 $ make -C tools/testing/selftests gen_tar FORMAT=.xz
208 168
209 `make gen_tar` invokes `make install` so you c 169 `make gen_tar` invokes `make install` so you can use it to package a subset of
210 tests by using variables specified in `Running 170 tests by using variables specified in `Running a subset of selftests`_
211 section:: 171 section::
212 172
213 $ make -C tools/testing/selftests gen_tar !! 173 $ make -C tools/testing/selftests gen_tar TARGETS="bpf" FORMAT=.xz
214 174
215 .. _tar's auto-compress: https://www.gnu.org/s 175 .. _tar's auto-compress: https://www.gnu.org/software/tar/manual/html_node/gzip.html#auto_002dcompress
216 176
217 Contributing new tests 177 Contributing new tests
218 ====================== 178 ======================
219 179
220 In general, the rules for selftests are 180 In general, the rules for selftests are
221 181
222 * Do as much as you can if you're not root; 182 * Do as much as you can if you're not root;
223 183
224 * Don't take too long; 184 * Don't take too long;
225 185
226 * Don't break the build on any architecture, 186 * Don't break the build on any architecture, and
227 187
228 * Don't cause the top-level "make run_tests" 188 * Don't cause the top-level "make run_tests" to fail if your feature is
229 unconfigured. 189 unconfigured.
230 190
231 * The output of tests must conform to the TAP <<
232 testing quality and to capture failures/err <<
233 The kselftest.h and kselftest_harness.h hea <<
234 outputting test results. These wrappers sho <<
235 fail, exit, and skip messages. CI systems c <<
236 messages to detect test results. <<
237 <<
238 Contributing new tests (details) 191 Contributing new tests (details)
239 ================================ 192 ================================
240 193
241 * In your Makefile, use facilities from lib.m <<
242 reinventing the wheel. Specify flags and bi <<
243 need basis before including lib.mk. :: <<
244 <<
245 CFLAGS = $(KHDR_INCLUDES) <<
246 TEST_GEN_PROGS := close_range_test <<
247 include ../lib.mk <<
248 <<
249 * Use TEST_GEN_XXX if such binaries or files 194 * Use TEST_GEN_XXX if such binaries or files are generated during
250 compiling. 195 compiling.
251 196
252 TEST_PROGS, TEST_GEN_PROGS mean it is the e 197 TEST_PROGS, TEST_GEN_PROGS mean it is the executable tested by
253 default. 198 default.
254 199
255 TEST_GEN_MODS_DIR should be used by tests t <<
256 before the test starts. The variable will c <<
257 containing the modules. <<
258 <<
259 TEST_CUSTOM_PROGS should be used by tests t 200 TEST_CUSTOM_PROGS should be used by tests that require custom build
260 rules and prevent common build rule use. 201 rules and prevent common build rule use.
261 202
262 TEST_PROGS are for test shell scripts. Plea 203 TEST_PROGS are for test shell scripts. Please ensure shell script has
263 its exec bit set. Otherwise, lib.mk run_tes 204 its exec bit set. Otherwise, lib.mk run_tests will generate a warning.
264 205
265 TEST_CUSTOM_PROGS and TEST_PROGS will be ru 206 TEST_CUSTOM_PROGS and TEST_PROGS will be run by common run_tests.
266 207
267 TEST_PROGS_EXTENDED, TEST_GEN_PROGS_EXTENDE 208 TEST_PROGS_EXTENDED, TEST_GEN_PROGS_EXTENDED mean it is the
268 executable which is not tested by default. 209 executable which is not tested by default.
269 <<
270 TEST_FILES, TEST_GEN_FILES mean it is the f 210 TEST_FILES, TEST_GEN_FILES mean it is the file which is used by
271 test. 211 test.
272 212
273 TEST_INCLUDES is similar to TEST_FILES, it <<
274 included when exporting or installing the t <<
275 differences: <<
276 <<
277 * symlinks to files in other directories a <<
278 * the part of paths below tools/testing/se <<
279 copying the files to the output director <<
280 <<
281 TEST_INCLUDES is meant to list dependencies <<
282 the selftests hierarchy. <<
283 <<
284 * First use the headers inside the kernel sou 213 * First use the headers inside the kernel source and/or git repo, and then the
285 system headers. Headers for the kernel rel 214 system headers. Headers for the kernel release as opposed to headers
286 installed by the distro on the system shoul 215 installed by the distro on the system should be the primary focus to be able
287 to find regressions. Use KHDR_INCLUDES in M !! 216 to find regressions.
288 the kernel source. <<
289 217
290 * If a test needs specific kernel config opti 218 * If a test needs specific kernel config options enabled, add a config file in
291 the test directory to enable them. 219 the test directory to enable them.
292 220
293 e.g: tools/testing/selftests/android/config 221 e.g: tools/testing/selftests/android/config
294 222
295 * Create a .gitignore file inside test direct <<
296 in it. <<
297 <<
298 * Add new test name in TARGETS in selftests/M <<
299 <<
300 TARGETS += android <<
301 <<
302 * All changes should pass:: <<
303 <<
304 kselftest-{all,install,clean,gen_tar} <<
305 kselftest-{all,install,clean,gen_tar} O=ab <<
306 kselftest-{all,install,clean,gen_tar} O=re <<
307 make -C tools/testing/selftests {all,insta <<
308 make -C tools/testing/selftests {all,insta <<
309 make -C tools/testing/selftests {all,insta <<
310 <<
311 Test Module 223 Test Module
312 =========== 224 ===========
313 225
314 Kselftest tests the kernel from userspace. So 226 Kselftest tests the kernel from userspace. Sometimes things need
315 testing from within the kernel, one method of 227 testing from within the kernel, one method of doing this is to create a
316 test module. We can tie the module into the k 228 test module. We can tie the module into the kselftest framework by
317 using a shell script test runner. ``kselftest 229 using a shell script test runner. ``kselftest/module.sh`` is designed
318 to facilitate this process. There is also a h 230 to facilitate this process. There is also a header file provided to
319 assist writing kernel modules that are for use 231 assist writing kernel modules that are for use with kselftest:
320 232
321 - ``tools/testing/selftests/kselftest_module.h !! 233 - ``tools/testing/kselftest/kselftest_module.h``
322 - ``tools/testing/selftests/kselftest/module.s !! 234 - ``tools/testing/kselftest/kselftest/module.sh``
323 <<
324 Note that test modules should taint the kernel <<
325 happen automatically for modules which are in <<
326 directory, or for modules which use the ``ksel <<
327 Otherwise, you'll need to add ``MODULE_INFO(te <<
328 source. selftests which do not load modules ty <<
329 kernel, but in cases where a non-test module i <<
330 applied from userspace by writing to ``/proc/s <<
331 235
332 How to use 236 How to use
333 ---------- 237 ----------
334 238
335 Here we show the typical steps to create a tes 239 Here we show the typical steps to create a test module and tie it into
336 kselftest. We use kselftests for lib/ as an e 240 kselftest. We use kselftests for lib/ as an example.
337 241
338 1. Create the test module 242 1. Create the test module
339 243
340 2. Create the test script that will run (load/ 244 2. Create the test script that will run (load/unload) the module
341 e.g. ``tools/testing/selftests/lib/printf.s 245 e.g. ``tools/testing/selftests/lib/printf.sh``
342 246
343 3. Add line to config file e.g. ``tools/testin 247 3. Add line to config file e.g. ``tools/testing/selftests/lib/config``
344 248
345 4. Add test script to makefile e.g. ``tools/t 249 4. Add test script to makefile e.g. ``tools/testing/selftests/lib/Makefile``
346 250
347 5. Verify it works: 251 5. Verify it works:
348 252
349 .. code-block:: sh 253 .. code-block:: sh
350 254
351 # Assumes you have booted a fresh build of 255 # Assumes you have booted a fresh build of this kernel tree
352 cd /path/to/linux/tree 256 cd /path/to/linux/tree
353 make kselftest-merge 257 make kselftest-merge
354 make modules 258 make modules
355 sudo make modules_install 259 sudo make modules_install
356 make TARGETS=lib kselftest 260 make TARGETS=lib kselftest
357 261
358 Example Module 262 Example Module
359 -------------- 263 --------------
360 264
361 A bare bones test module might look like this: 265 A bare bones test module might look like this:
362 266
363 .. code-block:: c 267 .. code-block:: c
364 268
365 // SPDX-License-Identifier: GPL-2.0+ 269 // SPDX-License-Identifier: GPL-2.0+
366 270
367 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt 271 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
368 272
369 #include "../tools/testing/selftests/kselft !! 273 #include "../tools/testing/selftests/kselftest/module.h"
370 274
371 KSTM_MODULE_GLOBALS(); 275 KSTM_MODULE_GLOBALS();
372 276
373 /* 277 /*
374 * Kernel module for testing the foobinator 278 * Kernel module for testing the foobinator
375 */ 279 */
376 280
377 static int __init test_function() 281 static int __init test_function()
378 { 282 {
379 ... 283 ...
380 } 284 }
381 285
382 static void __init selftest(void) 286 static void __init selftest(void)
383 { 287 {
384 KSTM_CHECK_ZERO(do_test_case("", 0) 288 KSTM_CHECK_ZERO(do_test_case("", 0));
385 } 289 }
386 290
387 KSTM_MODULE_LOADERS(test_foo); 291 KSTM_MODULE_LOADERS(test_foo);
388 MODULE_AUTHOR("John Developer <jd@fooman.org 292 MODULE_AUTHOR("John Developer <jd@fooman.org>");
389 MODULE_LICENSE("GPL"); 293 MODULE_LICENSE("GPL");
390 MODULE_INFO(test, "Y"); <<
391 294
392 Example test script 295 Example test script
393 ------------------- 296 -------------------
394 297
395 .. code-block:: sh 298 .. code-block:: sh
396 299
397 #!/bin/bash 300 #!/bin/bash
398 # SPDX-License-Identifier: GPL-2.0+ 301 # SPDX-License-Identifier: GPL-2.0+
399 $(dirname $0)/../kselftest/module.sh "foo" 302 $(dirname $0)/../kselftest/module.sh "foo" test_foo
400 303
401 304
402 Test Harness 305 Test Harness
403 ============ 306 ============
404 307
405 The kselftest_harness.h file contains useful h 308 The kselftest_harness.h file contains useful helpers to build tests. The
406 test harness is for userspace testing, for ker 309 test harness is for userspace testing, for kernel space testing see `Test
407 Module`_ above. 310 Module`_ above.
408 311
409 The tests from tools/testing/selftests/seccomp 312 The tests from tools/testing/selftests/seccomp/seccomp_bpf.c can be used as
410 example. 313 example.
411 314
412 Example 315 Example
413 ------- 316 -------
414 317
415 .. kernel-doc:: tools/testing/selftests/kselft 318 .. kernel-doc:: tools/testing/selftests/kselftest_harness.h
416 :doc: example 319 :doc: example
417 320
418 321
419 Helpers 322 Helpers
420 ------- 323 -------
421 324
422 .. kernel-doc:: tools/testing/selftests/kselft 325 .. kernel-doc:: tools/testing/selftests/kselftest_harness.h
423 :functions: TH_LOG TEST TEST_SIGNAL FIXTUR 326 :functions: TH_LOG TEST TEST_SIGNAL FIXTURE FIXTURE_DATA FIXTURE_SETUP
424 FIXTURE_TEARDOWN TEST_F TEST_H 327 FIXTURE_TEARDOWN TEST_F TEST_HARNESS_MAIN FIXTURE_VARIANT
425 FIXTURE_VARIANT_ADD 328 FIXTURE_VARIANT_ADD
426 329
427 Operators 330 Operators
428 --------- 331 ---------
429 332
430 .. kernel-doc:: tools/testing/selftests/kselft 333 .. kernel-doc:: tools/testing/selftests/kselftest_harness.h
431 :doc: operators 334 :doc: operators
432 335
433 .. kernel-doc:: tools/testing/selftests/kselft 336 .. kernel-doc:: tools/testing/selftests/kselftest_harness.h
434 :functions: ASSERT_EQ ASSERT_NE ASSERT_LT 337 :functions: ASSERT_EQ ASSERT_NE ASSERT_LT ASSERT_LE ASSERT_GT ASSERT_GE
435 ASSERT_NULL ASSERT_TRUE ASSERT 338 ASSERT_NULL ASSERT_TRUE ASSERT_NULL ASSERT_TRUE ASSERT_FALSE
436 ASSERT_STREQ ASSERT_STRNE EXPE 339 ASSERT_STREQ ASSERT_STRNE EXPECT_EQ EXPECT_NE EXPECT_LT
437 EXPECT_LE EXPECT_GT EXPECT_GE 340 EXPECT_LE EXPECT_GT EXPECT_GE EXPECT_NULL EXPECT_TRUE
438 EXPECT_FALSE EXPECT_STREQ EXPE 341 EXPECT_FALSE EXPECT_STREQ EXPECT_STRNE
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.