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