blob: cd78bb0a7dd9ba298b542df03362eddbf3a28337 [file] [log] [blame]
Thomas Gleixnerec8f24b2019-05-19 13:07:45 +01001# SPDX-License-Identifier: GPL-2.0-only
Christoph Hellwig06ec64b2018-07-31 13:39:31 +02002menu "Kernel hacking"
3
Dave Hansen604ff0d2013-07-01 13:04:49 -07004menu "printk and dmesg options"
Linus Torvalds1da177e2005-04-16 15:20:36 -07005
6config PRINTK_TIME
7 bool "Show timing information on printks"
Randy Dunlapd3b8b6e2006-12-06 20:36:38 -08008 depends on PRINTK
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 help
Kay Sievers649e6ee2012-05-10 04:30:45 +020010 Selecting this option causes time stamps of the printk()
11 messages to be added to the output of the syslog() system
12 call and at the console.
13
14 The timestamp is always recorded internally, and exported
15 to /dev/kmsg. This flag just specifies if the timestamp should
16 be included, not that the timestamp is recorded.
17
18 The behavior is also controlled by the kernel command line
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -020019 parameter printk.time=1. See Documentation/admin-guide/kernel-parameters.rst
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
Tetsuo Handa15ff2062018-12-18 06:05:04 +090021config PRINTK_CALLER
22 bool "Show caller information on printks"
23 depends on PRINTK
24 help
25 Selecting this option causes printk() to add a caller "thread id" (if
26 in task context) or a caller "processor id" (if not in task context)
27 to every message.
28
29 This option is intended for environments where multiple threads
30 concurrently call printk() for many times, for it is difficult to
31 interpret without knowing where these lines (or sometimes individual
32 line which was divided into multiple lines due to race) came from.
33
34 Since toggling after boot makes the code racy, currently there is
35 no option to enable/disable at the kernel command line parameter or
36 sysfs interface.
37
Stephen Boyd22f4e662021-07-07 18:09:17 -070038config STACKTRACE_BUILD_ID
39 bool "Show build ID information in stacktraces"
40 depends on PRINTK
41 help
42 Selecting this option adds build ID information for symbols in
43 stacktraces printed with the printk format '%p[SR]b'.
44
45 This option is intended for distros where debuginfo is not easily
46 accessible but can be downloaded given the build ID of the vmlinux or
47 kernel module where the function is located.
48
Olof Johanssona8cfdc62016-12-12 16:45:56 -080049config CONSOLE_LOGLEVEL_DEFAULT
50 int "Default console loglevel (1-15)"
51 range 1 15
52 default "7"
53 help
54 Default loglevel to determine what will be printed on the console.
55
56 Setting a default here is equivalent to passing in loglevel=<x> in
57 the kernel bootargs. loglevel=<x> continues to override whatever
58 value is specified here as well.
59
Borislav Petkov50f4d9b2016-12-19 16:23:15 -080060 Note: This does not affect the log level of un-prefixed printk()
Olof Johanssona8cfdc62016-12-12 16:45:56 -080061 usage in the kernel. That is controlled by the MESSAGE_LOGLEVEL_DEFAULT
62 option.
63
Hans de Goede22eceb82018-06-19 13:57:26 +020064config CONSOLE_LOGLEVEL_QUIET
65 int "quiet console loglevel (1-15)"
66 range 1 15
67 default "4"
68 help
69 loglevel to use when "quiet" is passed on the kernel commandline.
70
71 When "quiet" is passed on the kernel commandline this loglevel
72 will be used as the loglevel. IOW passing "quiet" will be the
73 equivalent of passing "loglevel=<CONSOLE_LOGLEVEL_QUIET>"
74
Alex Elder42a9dc02014-08-06 16:09:01 -070075config MESSAGE_LOGLEVEL_DEFAULT
Mandeep Singh Baines5af5bcb2011-03-22 16:34:23 -070076 int "Default message log level (1-7)"
77 range 1 7
78 default "4"
79 help
80 Default log level for printk statements with no specified priority.
81
82 This was hard-coded to KERN_WARNING since at least 2.6.10 but folks
83 that are auditing their logs closely may want to set it to a lower
84 priority.
85
Olof Johanssona8cfdc62016-12-12 16:45:56 -080086 Note: This does not affect what message level gets printed on the console
87 by default. To change that, use loglevel=<x> in the kernel bootargs,
88 or pick a different CONSOLE_LOGLEVEL_DEFAULT configuration value.
89
Dave Hansen604ff0d2013-07-01 13:04:49 -070090config BOOT_PRINTK_DELAY
91 bool "Delay each boot printk message by N milliseconds"
92 depends on DEBUG_KERNEL && PRINTK && GENERIC_CALIBRATE_DELAY
93 help
94 This build option allows you to read kernel boot messages
95 by inserting a short delay after each one. The delay is
96 specified in milliseconds on the kernel command line,
97 using "boot_delay=N".
98
99 It is likely that you would also need to use "lpj=M" to preset
100 the "loops per jiffie" value.
101 See a previous boot log for the "lpj" value to use for your
102 system, and then set "lpj=M" before setting "boot_delay=N".
103 NOTE: Using this option may adversely affect SMP systems.
104 I.e., processors other than the first one may not boot up.
105 BOOT_PRINTK_DELAY also may cause LOCKUP_DETECTOR to detect
106 what it believes to be lockup conditions.
107
108config DYNAMIC_DEBUG
109 bool "Enable dynamic printk() support"
110 default n
111 depends on PRINTK
Greg Kroah-Hartman239a5792020-02-10 13:11:42 -0800112 depends on (DEBUG_FS || PROC_FS)
Orson Zhaiceabef72020-06-07 21:40:14 -0700113 select DYNAMIC_DEBUG_CORE
Dave Hansen604ff0d2013-07-01 13:04:49 -0700114 help
115
116 Compiles debug level messages into the kernel, which would not
117 otherwise be available at runtime. These messages can then be
118 enabled/disabled based on various levels of scope - per source file,
119 function, module, format string, and line number. This mechanism
120 implicitly compiles in all pr_debug() and dev_dbg() calls, which
121 enlarges the kernel text size by about 2%.
122
123 If a source file is compiled with DEBUG flag set, any
124 pr_debug() calls in it are enabled by default, but can be
125 disabled at runtime as below. Note that DEBUG flag is
126 turned on by many CONFIG_*DEBUG* options.
127
128 Usage:
129
130 Dynamic debugging is controlled via the 'dynamic_debug/control' file,
Greg Kroah-Hartman239a5792020-02-10 13:11:42 -0800131 which is contained in the 'debugfs' filesystem or procfs.
132 Thus, the debugfs or procfs filesystem must first be mounted before
133 making use of this feature.
Dave Hansen604ff0d2013-07-01 13:04:49 -0700134 We refer the control file as: <debugfs>/dynamic_debug/control. This
135 file contains a list of the debug statements that can be enabled. The
136 format for each line of the file is:
137
138 filename:lineno [module]function flags format
139
140 filename : source file of the debug statement
141 lineno : line number of the debug statement
142 module : module that contains the debug statement
143 function : function that contains the debug statement
Krzysztof Kozlowski68d4b3d2019-12-06 17:04:08 -0800144 flags : '=p' means the line is turned 'on' for printing
145 format : the format used for the debug statement
Dave Hansen604ff0d2013-07-01 13:04:49 -0700146
147 From a live system:
148
149 nullarbor:~ # cat <debugfs>/dynamic_debug/control
150 # filename:lineno [module]function flags format
151 fs/aio.c:222 [aio]__put_ioctx =_ "__put_ioctx:\040freeing\040%p\012"
152 fs/aio.c:248 [aio]ioctx_alloc =_ "ENOMEM:\040nr_events\040too\040high\012"
153 fs/aio.c:1770 [aio]sys_io_cancel =_ "calling\040cancel\012"
154
155 Example usage:
156
157 // enable the message at line 1603 of file svcsock.c
158 nullarbor:~ # echo -n 'file svcsock.c line 1603 +p' >
159 <debugfs>/dynamic_debug/control
160
161 // enable all the messages in file svcsock.c
162 nullarbor:~ # echo -n 'file svcsock.c +p' >
163 <debugfs>/dynamic_debug/control
164
165 // enable all the messages in the NFS server module
166 nullarbor:~ # echo -n 'module nfsd +p' >
167 <debugfs>/dynamic_debug/control
168
169 // enable all 12 messages in the function svc_process()
170 nullarbor:~ # echo -n 'func svc_process +p' >
171 <debugfs>/dynamic_debug/control
172
173 // disable all 12 messages in the function svc_process()
174 nullarbor:~ # echo -n 'func svc_process -p' >
175 <debugfs>/dynamic_debug/control
176
Hans Holmbergf8998c22017-03-16 09:37:32 +0100177 See Documentation/admin-guide/dynamic-debug-howto.rst for additional
178 information.
Dave Hansen604ff0d2013-07-01 13:04:49 -0700179
Orson Zhaiceabef72020-06-07 21:40:14 -0700180config DYNAMIC_DEBUG_CORE
181 bool "Enable core function of dynamic debug support"
182 depends on PRINTK
183 depends on (DEBUG_FS || PROC_FS)
184 help
185 Enable core functional support of dynamic debug. It is useful
186 when you want to tie dynamic debug to your kernel modules with
187 DYNAMIC_DEBUG_MODULE defined for each of them, especially for
188 the case of embedded system where the kernel image size is
189 sensitive for people.
190
Rasmus Villemoes57f56772019-10-15 21:07:05 +0200191config SYMBOLIC_ERRNAME
192 bool "Support symbolic error names in printf"
193 default y if PRINTK
194 help
195 If you say Y here, the kernel's printf implementation will
196 be able to print symbolic error names such as ENOSPC instead
197 of the number 28. It makes the kernel image slightly larger
198 (about 3KB), but can make the kernel logs easier to read.
199
Changbin Du2b05bb72019-12-06 17:04:03 -0800200config DEBUG_BUGVERBOSE
201 bool "Verbose BUG() reporting (adds 70K)" if DEBUG_KERNEL && EXPERT
202 depends on BUG && (GENERIC_BUG || HAVE_DEBUG_BUGVERBOSE)
203 default y
204 help
205 Say Y here to make BUG() panics output the file name and line number
206 of the BUG call as well as the EIP and oops trace. This aids
207 debugging but costs about 70-100K of memory.
208
Dave Hansen604ff0d2013-07-01 13:04:49 -0700209endmenu # "printk and dmesg options"
210
Dave Hansen6dfc0662013-07-01 13:04:46 -0700211menu "Compile-time checks and compiler options"
212
213config DEBUG_INFO
214 bool "Compile the kernel with debug info"
Linus Torvalds12b13832014-02-04 12:20:01 -0800215 depends on DEBUG_KERNEL && !COMPILE_TEST
Dave Hansen6dfc0662013-07-01 13:04:46 -0700216 help
Krzysztof Kozlowski68d4b3d2019-12-06 17:04:08 -0800217 If you say Y here the resulting kernel image will include
Dave Hansen6dfc0662013-07-01 13:04:46 -0700218 debugging info resulting in a larger kernel image.
219 This adds debug symbols to the kernel and modules (gcc -g), and
220 is needed if you intend to use kernel crashdump or binary object
221 tools like crash, kgdb, LKCD, gdb, etc on the kernel.
222 Say Y here only if you plan to debug the kernel.
223
224 If unsure, say N.
225
Sedat Dilek695afd32020-08-16 14:32:44 +0200226if DEBUG_INFO
227
Dave Hansen6dfc0662013-07-01 13:04:46 -0700228config DEBUG_INFO_REDUCED
229 bool "Reduce debugging information"
Dave Hansen6dfc0662013-07-01 13:04:46 -0700230 help
231 If you say Y here gcc is instructed to generate less debugging
232 information for structure types. This means that tools that
233 need full debugging information (like kgdb or systemtap) won't
234 be happy. But if you merely need debugging information to
235 resolve line numbers there is no loss. Advantage is that
236 build directory object sizes shrink dramatically over a full
237 DEBUG_INFO build and compile times are reduced too.
238 Only works with newer gcc versions.
239
Nick Desaulniers10e68b022020-05-26 10:18:29 -0700240config DEBUG_INFO_COMPRESSED
241 bool "Compressed debugging information"
Nick Desaulniers10e68b022020-05-26 10:18:29 -0700242 depends on $(cc-option,-gz=zlib)
Nick Desaulniers10e68b022020-05-26 10:18:29 -0700243 depends on $(ld-option,--compress-debug-sections=zlib)
244 help
245 Compress the debug information using zlib. Requires GCC 5.0+ or Clang
246 5.0+, binutils 2.26+, and zlib.
247
248 Users of dpkg-deb via scripts/package/builddeb may find an increase in
249 size of their debug .deb packages with this config set, due to the
250 debug info being compressed with zlib, then the object files being
251 recompressed with a different compression scheme. But this is still
252 preferable to setting $KDEB_COMPRESS to "none" which would be even
253 larger.
254
Andi Kleen866ced92014-07-30 20:50:18 +0200255config DEBUG_INFO_SPLIT
256 bool "Produce split debuginfo in .dwo files"
Masahiro Yamada9d937442019-02-22 16:56:09 +0900257 depends on $(cc-option,-gsplit-dwarf)
Andi Kleen866ced92014-07-30 20:50:18 +0200258 help
259 Generate debug info into separate .dwo files. This significantly
260 reduces the build directory size for builds with DEBUG_INFO,
261 because it stores the information only once on disk in .dwo
262 files instead of multiple times in object files and executables.
263 In addition the debug information is also compressed.
264
265 Requires recent gcc (4.7+) and recent gdb/binutils.
266 Any tool that packages or reads debug information would need
267 to know about the .dwo files and include them.
268 Incompatible with older versions of ccache.
269
Nick Desaulniersa66049e2021-02-05 12:22:19 -0800270choice
271 prompt "DWARF version"
Andi Kleenbfaf2dd2014-07-30 20:50:19 +0200272 help
Nick Desaulniersa66049e2021-02-05 12:22:19 -0800273 Which version of DWARF debug info to emit.
274
275config DEBUG_INFO_DWARF_TOOLCHAIN_DEFAULT
276 bool "Rely on the toolchain's implicit default DWARF version"
277 help
278 The implicit default version of DWARF debug info produced by a
279 toolchain changes over time.
280
281 This can break consumers of the debug info that haven't upgraded to
282 support newer revisions, and prevent testing newer versions, but
283 those should be less common scenarios.
284
285 If unsure, say Y.
286
287config DEBUG_INFO_DWARF4
288 bool "Generate DWARF Version 4 debuginfo"
289 help
290 Generate DWARF v4 debug info. This requires gcc 4.5+ and gdb 7.0+.
291
292 If you have consumers of DWARF debug info that are not ready for
293 newer revisions of DWARF, you may wish to choose this or have your
294 config select this.
295
Nick Desaulniers98cd6f52021-02-05 12:22:20 -0800296config DEBUG_INFO_DWARF5
297 bool "Generate DWARF Version 5 debuginfo"
Masahiro Yamada2e988152021-03-16 01:12:57 +0900298 depends on GCC_VERSION >= 50000 || (CC_IS_CLANG && (AS_IS_LLVM || (AS_IS_GNU && AS_VERSION >= 23502)))
Nick Desaulniers98cd6f52021-02-05 12:22:20 -0800299 depends on !DEBUG_INFO_BTF
300 help
301 Generate DWARF v5 debug info. Requires binutils 2.35.2, gcc 5.0+ (gcc
302 5.0+ accepts the -gdwarf-5 flag but only had partial support for some
303 draft features until 7.0), and gdb 8.0+.
304
305 Changes to the structure of debug info in Version 5 allow for around
306 15-18% savings in resulting image and debug info section sizes as
307 compared to DWARF Version 4. DWARF Version 5 standardizes previous
308 extensions such as accelerators for symbol indexing and the format
309 for fission (.dwo/.dwp) files. Users may not want to select this
310 config if they rely on tooling that has not yet been updated to
311 support DWARF Version 5.
312
Nick Desaulniersa66049e2021-02-05 12:22:19 -0800313endchoice # "DWARF version"
Andi Kleenbfaf2dd2014-07-30 20:50:19 +0200314
Andrii Nakryikoe83b9f52019-04-02 09:49:50 -0700315config DEBUG_INFO_BTF
316 bool "Generate BTF typeinfo"
Slava Bacherikov7d32e692020-04-02 23:41:39 +0300317 depends on !DEBUG_INFO_SPLIT && !DEBUG_INFO_REDUCED
318 depends on !GCC_PLUGIN_RANDSTRUCT || COMPILE_TEST
Andrii Nakryikoe83b9f52019-04-02 09:49:50 -0700319 help
320 Generate deduplicated BTF type information from DWARF debug info.
321 Turning this on expects presence of pahole tool, which will convert
322 DWARF type info into equivalent deduplicated BTF type info.
323
Andrii Nakryiko5f9ae912020-11-09 17:19:30 -0800324config PAHOLE_HAS_SPLIT_BTF
325 def_bool $(success, test `$(PAHOLE) --version | sed -E 's/v([0-9]+)\.([0-9]+)/\1\2/'` -ge "119")
326
327config DEBUG_INFO_BTF_MODULES
328 def_bool y
329 depends on DEBUG_INFO_BTF && MODULES && PAHOLE_HAS_SPLIT_BTF
330 help
331 Generate compact split BTF type information for kernel modules.
332
Jan Kiszka3ee7b3f2015-02-17 13:46:36 -0800333config GDB_SCRIPTS
334 bool "Provide GDB scripts for kernel debugging"
Jan Kiszka3ee7b3f2015-02-17 13:46:36 -0800335 help
336 This creates the required links to GDB helper scripts in the
337 build directory. If you load vmlinux into gdb, the helper
338 scripts will be automatically imported by gdb as well, and
339 additional functions are available to analyze a Linux kernel
Andreas Platschek700199b02016-12-14 15:05:40 -0800340 instance. See Documentation/dev-tools/gdb-kernel-debugging.rst
341 for further details.
Jan Kiszka3ee7b3f2015-02-17 13:46:36 -0800342
Sedat Dilek695afd32020-08-16 14:32:44 +0200343endif # DEBUG_INFO
344
Andi Kleen35bb5b12008-02-22 15:15:03 +0100345config FRAME_WARN
Masahiro Yamadaa83e4ca2020-02-17 00:19:36 +0900346 int "Warn for stack frames larger than"
Andi Kleen35bb5b12008-02-22 15:15:03 +0100347 range 0 8192
Kees Cook0e07f662016-10-27 17:46:41 -0700348 default 2048 if GCC_PLUGIN_LATENT_ENTROPY
Helge Deller432654d2017-09-11 21:41:43 +0200349 default 1280 if (!64BIT && PARISC)
350 default 1024 if (!64BIT && !PARISC)
Andi Kleen35bb5b12008-02-22 15:15:03 +0100351 default 2048 if 64BIT
352 help
353 Tell gcc to warn at build time for stack frames larger than this.
354 Setting this too low will cause a lot of warnings.
355 Setting it to 0 disables the warning.
Andi Kleen35bb5b12008-02-22 15:15:03 +0100356
Randy Dunlap99657c72009-09-18 12:49:22 -0700357config STRIP_ASM_SYMS
358 bool "Strip assembler-generated symbols during link"
359 default n
360 help
361 Strip internal assembler-generated symbols during a link (symbols
362 that look like '.Lxxx') so they don't pollute the output of
363 get_wchan() and suchlike.
364
Andi Kleen1873e872012-03-28 11:51:18 -0700365config READABLE_ASM
Krzysztof Kozlowski68d4b3d2019-12-06 17:04:08 -0800366 bool "Generate readable assembler code"
367 depends on DEBUG_KERNEL
Don Mullisbf4735a2006-12-10 02:18:37 -0800368 help
Krzysztof Kozlowski68d4b3d2019-12-06 17:04:08 -0800369 Disable some compiler optimizations that tend to generate human unreadable
370 assembler output. This may make the kernel slightly slower, but it helps
371 to keep kernel developers who have to stare a lot at assembler listings
372 sane.
Don Mullisbf4735a2006-12-10 02:18:37 -0800373
Masahiro Yamadae949f4c2019-06-04 19:13:59 +0900374config HEADERS_INSTALL
375 bool "Install uapi headers to usr/include"
Don Mullisbf4735a2006-12-10 02:18:37 -0800376 depends on !UML
377 help
Masahiro Yamadae949f4c2019-06-04 19:13:59 +0900378 This option will install uapi headers (headers exported to user-space)
379 into the usr/include directory for use during the kernel build.
380 This is unneeded for building the kernel itself, but needed for some
381 user-space program samples. It is also needed by some features such
382 as uapi header sanity checks.
383
Sam Ravnborg91341d42008-01-21 21:31:44 +0100384config DEBUG_SECTION_MISMATCH
385 bool "Enable full Section mismatch analysis"
Sam Ravnborg91341d42008-01-21 21:31:44 +0100386 help
387 The section mismatch analysis checks if there are illegal
388 references from one section to another section.
Michael Wittene809ab02011-04-17 04:08:48 +0000389 During linktime or runtime, some sections are dropped;
390 any use of code/data previously in these sections would
Sam Ravnborg91341d42008-01-21 21:31:44 +0100391 most likely result in an oops.
Michael Wittene809ab02011-04-17 04:08:48 +0000392 In the code, functions and variables are annotated with
Paul Gortmaker0db06282013-06-19 14:53:51 -0400393 __init,, etc. (see the full list in include/linux/init.h),
Geert Uytterhoevend6fbfa42008-01-30 11:13:23 +0100394 which results in the code/data being placed in specific sections.
Michael Wittene809ab02011-04-17 04:08:48 +0000395 The section mismatch analysis is always performed after a full
396 kernel build, and enabling this option causes the following
Masahiro Yamadab7dca6d2019-07-17 15:17:57 +0900397 additional step to occur:
Michael Wittene809ab02011-04-17 04:08:48 +0000398 - Add the option -fno-inline-functions-called-once to gcc commands.
399 When inlining a function annotated with __init in a non-init
400 function, we would lose the section information and thus
Sam Ravnborg91341d42008-01-21 21:31:44 +0100401 the analysis would not catch the illegal reference.
Michael Wittene809ab02011-04-17 04:08:48 +0000402 This option tells gcc to inline less (but it does result in
403 a larger kernel).
Sam Ravnborg91341d42008-01-21 21:31:44 +0100404
Nicolas Boichat47490ec2015-10-06 09:44:42 +1030405config SECTION_MISMATCH_WARN_ONLY
406 bool "Make section mismatch errors non-fatal"
407 default y
408 help
409 If you say N here, the build process will fail if there are any
410 section mismatch, instead of just throwing warnings.
411
412 If unsure, say Y.
413
Feng Tangcf536e12021-05-06 15:34:59 +0800414config DEBUG_FORCE_FUNCTION_ALIGN_64B
415 bool "Force all function address 64B aligned" if EXPERT
Feng Tang09c60542020-08-11 18:34:13 -0700416 help
417 There are cases that a commit from one domain changes the function
418 address alignment of other domains, and cause magic performance
419 bump (regression or improvement). Enable this option will help to
420 verify if the bump is caused by function alignment changes, while
421 it will slightly increase the kernel size and affect icache usage.
422
423 It is mainly for debug and performance tuning use.
424
Dave Hansen6dfc0662013-07-01 13:04:46 -0700425#
426# Select this config option from the architecture Kconfig, if it
427# is preferred to always offer frame pointers as a config
428# option on the architecture (regardless of KERNEL_DEBUG):
429#
430config ARCH_WANT_FRAME_POINTERS
431 bool
Dave Hansen6dfc0662013-07-01 13:04:46 -0700432
433config FRAME_POINTER
434 bool "Compile the kernel with frame pointers"
Arnd Bergmanna687a532018-03-07 23:30:54 +0100435 depends on DEBUG_KERNEL && (M68K || UML || SUPERH) || ARCH_WANT_FRAME_POINTERS
Dave Hansen6dfc0662013-07-01 13:04:46 -0700436 default y if (DEBUG_INFO && UML) || ARCH_WANT_FRAME_POINTERS
437 help
438 If you say Y here the resulting kernel image will be slightly
439 larger and slower, but it gives very useful debugging information
440 in case of kernel bugs. (precise oopses/stacktraces/warnings)
441
Josh Poimboeufb9ab5eb2016-02-28 22:22:42 -0600442config STACK_VALIDATION
443 bool "Compile-time stack metadata validation"
444 depends on HAVE_STACK_VALIDATION
445 default n
446 help
447 Add compile-time checks to validate stack metadata, including frame
448 pointers (if CONFIG_FRAME_POINTER is enabled). This helps ensure
449 that runtime stack traces are more reliable.
450
Josh Poimboeufee9f8fc2017-07-24 18:36:57 -0500451 This is also a prerequisite for generation of ORC unwind data, which
Josh Poimboeuf11af8472017-10-13 15:02:00 -0500452 is needed for CONFIG_UNWINDER_ORC.
Josh Poimboeufee9f8fc2017-07-24 18:36:57 -0500453
Josh Poimboeufb9ab5eb2016-02-28 22:22:42 -0600454 For more information, see
455 tools/objtool/Documentation/stack-validation.txt.
456
Peter Zijlstra6804c1a2020-03-18 13:33:54 +0100457config VMLINUX_VALIDATION
458 bool
459 depends on STACK_VALIDATION && DEBUG_ENTRY && !PARAVIRT
460 default y
461
Rasmus Villemoes5cc12472021-03-05 10:27:07 +0100462config VMLINUX_MAP
463 bool "Generate vmlinux.map file when linking"
464 depends on EXPERT
465 help
466 Selecting this option will pass "-Map=vmlinux.map" to ld
467 when linking vmlinux. That file can be useful for verifying
468 and debugging magic section games, and for seeing which
469 pieces of code get eliminated with
470 CONFIG_LD_DEAD_CODE_DATA_ELIMINATION.
471
Dave Hansen6dfc0662013-07-01 13:04:46 -0700472config DEBUG_FORCE_WEAK_PER_CPU
473 bool "Force weak per-cpu definitions"
474 depends on DEBUG_KERNEL
475 help
476 s390 and alpha require percpu variables in modules to be
477 defined weak to work around addressing range issue which
478 puts the following two restrictions on percpu variable
479 definitions.
480
481 1. percpu symbols must be unique whether static or not
482 2. percpu variables can't be defined inside a function
483
484 To ensure that generic code follows the above rules, this
485 option forces all percpu variables to be defined as weak.
486
487endmenu # "Compiler options"
488
Changbin Du6210b642019-12-06 17:03:42 -0800489menu "Generic Kernel Debugging Instruments"
490
Dave Hansen6dfc0662013-07-01 13:04:46 -0700491config MAGIC_SYSRQ
492 bool "Magic SysRq key"
493 depends on !UML
494 help
495 If you say Y here, you will have some control over the system even
496 if the system crashes for example during kernel debugging (e.g., you
497 will be able to flush the buffer cache to disk, reboot the system
498 immediately or dump some status information). This is accomplished
499 by pressing various keys while holding SysRq (Alt+PrintScreen). It
500 also works on a serial console (on PC hardware at least), if you
501 send a BREAK and then within 5 seconds a command keypress. The
Hans Holmbergf8998c22017-03-16 09:37:32 +0100502 keys are documented in <file:Documentation/admin-guide/sysrq.rst>.
503 Don't say Y unless you really know what this hack does.
Dave Hansen6dfc0662013-07-01 13:04:46 -0700504
Ben Hutchings8eaede42013-10-07 01:05:46 +0100505config MAGIC_SYSRQ_DEFAULT_ENABLE
506 hex "Enable magic SysRq key functions by default"
507 depends on MAGIC_SYSRQ
508 default 0x1
509 help
510 Specifies which SysRq key functions are enabled by default.
511 This may be set to 1 or 0 to enable or disable them all, or
Hans Holmbergf8998c22017-03-16 09:37:32 +0100512 to a bitmask as described in Documentation/admin-guide/sysrq.rst.
Ben Hutchings8eaede42013-10-07 01:05:46 +0100513
Felix Fietkau732dbf32016-12-22 08:31:34 +0100514config MAGIC_SYSRQ_SERIAL
515 bool "Enable magic SysRq key over serial"
516 depends on MAGIC_SYSRQ
517 default y
518 help
519 Many embedded boards have a disconnected TTL level serial which can
520 generate some garbage that can lead to spurious false sysrq detects.
521 This option allows you to decide whether you want to enable the
522 magic SysRq key.
523
Dmitry Safonov68af4312020-03-02 17:51:35 +0000524config MAGIC_SYSRQ_SERIAL_SEQUENCE
525 string "Char sequence that enables magic SysRq over serial"
526 depends on MAGIC_SYSRQ_SERIAL
527 default ""
528 help
529 Specifies a sequence of characters that can follow BREAK to enable
530 SysRq on a serial console.
531
Dmitry Safonovd3394b32020-03-06 15:31:56 +0000532 If unsure, leave an empty string and the option will not be enabled.
533
Changbin Duec29a5c2019-12-06 17:04:06 -0800534config DEBUG_FS
535 bool "Debug Filesystem"
536 help
537 debugfs is a virtual file system that kernel developers use to put
538 debugging files into. Enable this option to be able to read and
539 write to these files.
540
541 For detailed documentation on the debugfs API, see
542 Documentation/filesystems/.
543
544 If unsure, say N.
545
Peter Enderborga24c6f72020-07-16 09:15:11 +0200546choice
547 prompt "Debugfs default access"
548 depends on DEBUG_FS
549 default DEBUG_FS_ALLOW_ALL
550 help
551 This selects the default access restrictions for debugfs.
552 It can be overridden with kernel command line option
553 debugfs=[on,no-mount,off]. The restrictions apply for API access
554 and filesystem registration.
555
556config DEBUG_FS_ALLOW_ALL
557 bool "Access normal"
558 help
559 No restrictions apply. Both API and filesystem registration
560 is on. This is the normal default operation.
561
562config DEBUG_FS_DISALLOW_MOUNT
563 bool "Do not register debugfs as filesystem"
564 help
565 The API is open but filesystem is not loaded. Clients can still do
566 their work and read with debug tools that do not need
567 debugfs filesystem.
568
569config DEBUG_FS_ALLOW_NONE
570 bool "No access"
571 help
572 Access is off. Clients get -PERM when trying to create nodes in
573 debugfs tree and debugfs is not registered as a filesystem.
574 Client can then back-off or continue without debugfs access.
575
576endchoice
577
Changbin Du6210b642019-12-06 17:03:42 -0800578source "lib/Kconfig.kgdb"
Changbin Du6210b642019-12-06 17:03:42 -0800579source "lib/Kconfig.ubsan"
Changbin Du2645d432020-09-18 21:20:42 -0700580source "lib/Kconfig.kcsan"
Changbin Du6210b642019-12-06 17:03:42 -0800581
582endmenu
583
Adrian Bunkf346f4b2006-01-09 20:54:51 -0800584config DEBUG_KERNEL
585 bool "Kernel debugging"
586 help
587 Say Y here if you are developing drivers or trying to debug and
588 identify kernel problems.
589
Sinan Kayac66d7a22019-05-14 15:44:00 -0700590config DEBUG_MISC
591 bool "Miscellaneous debug code"
592 default DEBUG_KERNEL
593 depends on DEBUG_KERNEL
594 help
595 Say Y here if you need to enable miscellaneous debug code that should
596 be under a more specific debug option but isn't.
597
598
Dave Hansen0610c8a2013-07-01 13:04:43 -0700599menu "Memory Debugging"
David Woodhousea304e1b2007-02-12 00:52:00 -0800600
Masahiro Yamada8636a1f2018-12-11 20:01:04 +0900601source "mm/Kconfig.debug"
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800602
Thomas Gleixner3ac7fe52008-04-30 00:55:01 -0700603config DEBUG_OBJECTS
604 bool "Debug object operations"
605 depends on DEBUG_KERNEL
606 help
607 If you say Y here, additional code will be inserted into the
608 kernel to track the life time of various objects and validate
609 the operations on those objects.
610
611config DEBUG_OBJECTS_SELFTEST
612 bool "Debug objects selftest"
613 depends on DEBUG_OBJECTS
614 help
615 This enables the selftest of the object debug code.
616
617config DEBUG_OBJECTS_FREE
618 bool "Debug objects in freed memory"
619 depends on DEBUG_OBJECTS
620 help
621 This enables checks whether a k/v free operation frees an area
622 which contains an object which has not been deactivated
623 properly. This can make kmalloc/kfree-intensive workloads
624 much slower.
625
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700626config DEBUG_OBJECTS_TIMERS
627 bool "Debug timer objects"
628 depends on DEBUG_OBJECTS
629 help
630 If you say Y here, additional code will be inserted into the
631 timer routines to track the life time of timer objects and
632 validate the timer operations.
633
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900634config DEBUG_OBJECTS_WORK
635 bool "Debug work objects"
636 depends on DEBUG_OBJECTS
637 help
638 If you say Y here, additional code will be inserted into the
639 work queue routines to track the life time of work objects and
640 validate the work operations.
641
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -0400642config DEBUG_OBJECTS_RCU_HEAD
643 bool "Debug RCU callbacks objects"
Mathieu Desnoyersfc2ecf72011-02-23 09:42:14 -0800644 depends on DEBUG_OBJECTS
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -0400645 help
646 Enable this to turn on debugging of RCU list heads (call_rcu() usage).
647
Tejun Heoe2852ae2010-10-26 14:23:05 -0700648config DEBUG_OBJECTS_PERCPU_COUNTER
649 bool "Debug percpu counter objects"
650 depends on DEBUG_OBJECTS
651 help
652 If you say Y here, additional code will be inserted into the
653 percpu counter routines to track the life time of percpu counter
654 objects and validate the percpu counter operations.
655
Ingo Molnar3ae70202008-11-26 10:02:00 +0100656config DEBUG_OBJECTS_ENABLE_DEFAULT
657 int "debug_objects bootup default value (0-1)"
Krzysztof Kozlowski68d4b3d2019-12-06 17:04:08 -0800658 range 0 1
659 default "1"
660 depends on DEBUG_OBJECTS
661 help
662 Debug objects boot parameter default value
Ingo Molnar3ae70202008-11-26 10:02:00 +0100663
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664config DEBUG_SLAB
Andrew Morton4a2f0ac2006-03-25 03:07:22 -0800665 bool "Debug slab memory allocations"
Levin, Alexander (Sasha Levin)4675ff02017-11-15 17:36:02 -0800666 depends on DEBUG_KERNEL && SLAB
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 help
668 Say Y here to have the kernel do limited verification on memory
669 allocation as well as poisoning memory on free to catch use of freed
670 memory. This can make kmalloc/kfree-intensive workloads much slower.
671
Christoph Lameterf0630ff2007-07-15 23:38:14 -0700672config SLUB_DEBUG_ON
673 bool "SLUB debugging on by default"
Levin, Alexander (Sasha Levin)4675ff02017-11-15 17:36:02 -0800674 depends on SLUB && SLUB_DEBUG
Christoph Lameterf0630ff2007-07-15 23:38:14 -0700675 default n
676 help
677 Boot with debugging on by default. SLUB boots by default with
678 the runtime debug capabilities switched off. Enabling this is
679 equivalent to specifying the "slub_debug" parameter on boot.
680 There is no support for more fine grained debug control like
681 possible with slub_debug=xxx. SLUB debugging may be switched
682 off in a kernel built with CONFIG_SLUB_DEBUG_ON by specifying
683 "slub_debug=-".
684
Christoph Lameter8ff12cf2008-02-07 17:47:41 -0800685config SLUB_STATS
686 default n
687 bool "Enable SLUB performance statistics"
Christoph Lameterab4d5ed2010-10-05 13:57:26 -0500688 depends on SLUB && SYSFS
Christoph Lameter8ff12cf2008-02-07 17:47:41 -0800689 help
690 SLUB statistics are useful to debug SLUBs allocation behavior in
691 order find ways to optimize the allocator. This should never be
692 enabled for production use since keeping statistics slows down
693 the allocator by a few percentage points. The slabinfo command
694 supports the determination of the most active slabs to figure
695 out which slabs are relevant to a particular load.
696 Try running: slabinfo -DA
697
Catalin Marinasb69ec422012-10-08 16:28:11 -0700698config HAVE_DEBUG_KMEMLEAK
699 bool
700
Catalin Marinas3bba00d2009-06-11 13:24:13 +0100701config DEBUG_KMEMLEAK
702 bool "Kernel memory leak detector"
Kees Cook525c1f92013-01-16 18:54:16 -0800703 depends on DEBUG_KERNEL && HAVE_DEBUG_KMEMLEAK
Catalin Marinas79e0d9b2011-04-27 17:06:19 +0100704 select DEBUG_FS
Catalin Marinas3bba00d2009-06-11 13:24:13 +0100705 select STACKTRACE if STACKTRACE_SUPPORT
706 select KALLSYMS
Randy Dunlapb60e26a2009-11-06 15:33:45 -0800707 select CRC32
Catalin Marinas3bba00d2009-06-11 13:24:13 +0100708 help
709 Say Y here if you want to enable the memory leak
710 detector. The memory allocation/freeing is traced in a way
711 similar to the Boehm's conservative garbage collector, the
712 difference being that the orphan objects are not freed but
713 only shown in /sys/kernel/debug/kmemleak. Enabling this
714 feature will introduce an overhead to memory
Andreas Platschek700199b02016-12-14 15:05:40 -0800715 allocations. See Documentation/dev-tools/kmemleak.rst for more
Catalin Marinas3bba00d2009-06-11 13:24:13 +0100716 details.
717
Catalin Marinasbf96d1e2009-06-23 14:40:27 +0100718 Enabling DEBUG_SLAB or SLUB_DEBUG may increase the chances
719 of finding leaks due to the slab objects poisoning.
720
Catalin Marinas3bba00d2009-06-11 13:24:13 +0100721 In order to access the kmemleak file, debugfs needs to be
722 mounted (usually at /sys/kernel/debug).
723
Catalin Marinasc5665862019-09-23 15:34:05 -0700724config DEBUG_KMEMLEAK_MEM_POOL_SIZE
725 int "Kmemleak memory pool size"
Catalin Marinasa9d90582009-06-25 10:16:11 +0100726 depends on DEBUG_KMEMLEAK
Qian Caic59180a2019-09-23 15:34:10 -0700727 range 200 1000000
Nicolas Boichatb751c522019-09-23 15:33:55 -0700728 default 16000
Catalin Marinasa9d90582009-06-25 10:16:11 +0100729 help
730 Kmemleak must track all the memory allocations to avoid
731 reporting false positives. Since memory may be allocated or
Catalin Marinasc5665862019-09-23 15:34:05 -0700732 freed before kmemleak is fully initialised, use a static pool
733 of metadata objects to track such callbacks. After kmemleak is
734 fully initialised, this memory pool acts as an emergency one
735 if slab allocations fail.
Catalin Marinasa9d90582009-06-25 10:16:11 +0100736
Catalin Marinas0822ee42009-06-11 13:24:14 +0100737config DEBUG_KMEMLEAK_TEST
738 tristate "Simple test for the kernel memory leak detector"
Daniel Baluta97182692011-04-04 15:06:44 -0700739 depends on DEBUG_KMEMLEAK && m
Catalin Marinas0822ee42009-06-11 13:24:14 +0100740 help
Daniel Baluta97182692011-04-04 15:06:44 -0700741 This option enables a module that explicitly leaks memory.
Catalin Marinas0822ee42009-06-11 13:24:14 +0100742
743 If unsure, say N.
744
Jason Baronab0155a2010-07-19 11:54:17 +0100745config DEBUG_KMEMLEAK_DEFAULT_OFF
746 bool "Default kmemleak to off"
747 depends on DEBUG_KMEMLEAK
748 help
749 Say Y here to disable kmemleak by default. It can then be enabled
750 on the command line via kmemleak=on.
751
Sri Krishna chowdaryd53ce042018-12-28 00:38:54 -0800752config DEBUG_KMEMLEAK_AUTO_SCAN
753 bool "Enable kmemleak auto scan thread on boot up"
754 default y
755 depends on DEBUG_KMEMLEAK
756 help
757 Depending on the cpu, kmemleak scan may be cpu intensive and can
758 stall user tasks at times. This option enables/disables automatic
759 kmemleak scan at boot up.
760
761 Say N here to disable kmemleak auto scan thread to stop automatic
762 scanning. Disabling this option disables automatic reporting of
763 memory leaks.
764
765 If unsure, say Y.
766
Dave Hansen0610c8a2013-07-01 13:04:43 -0700767config DEBUG_STACK_USAGE
768 bool "Stack utilization instrumentation"
Helge Deller6c31da32016-03-19 17:54:10 +0100769 depends on DEBUG_KERNEL && !IA64
Dave Hansen0610c8a2013-07-01 13:04:43 -0700770 help
771 Enables the display of the minimum amount of free stack which each
772 task has ever had available in the sysrq-T and sysrq-P debug output.
773
774 This option will slow down process creation somewhat.
775
Changbin Dudc9b9632019-12-06 17:03:57 -0800776config SCHED_STACK_END_CHECK
777 bool "Detect stack corruption on calls to schedule()"
778 depends on DEBUG_KERNEL
779 default n
780 help
781 This option checks for a stack overrun on calls to schedule().
782 If the stack end location is found to be over written always panic as
783 the content of the corrupted region can no longer be trusted.
784 This is to ensure no erroneous behaviour occurs which could result in
785 data corruption or a sporadic crash at a later stage once the region
786 is examined. The runtime overhead introduced is minimal.
787
Anshuman Khandual399145f2020-06-04 16:47:15 -0700788config ARCH_HAS_DEBUG_VM_PGTABLE
789 bool
790 help
791 An architecture should select this when it can successfully
792 build and run DEBUG_VM_PGTABLE.
793
Dave Hansen0610c8a2013-07-01 13:04:43 -0700794config DEBUG_VM
795 bool "Debug VM"
796 depends on DEBUG_KERNEL
797 help
798 Enable this to turn on extended checks in the virtual-memory system
Krzysztof Kozlowski68d4b3d2019-12-06 17:04:08 -0800799 that may impact performance.
Dave Hansen0610c8a2013-07-01 13:04:43 -0700800
801 If unsure, say N.
802
Davidlohr Bueso4f115142014-06-04 16:06:46 -0700803config DEBUG_VM_VMACACHE
804 bool "Debug VMA caching"
805 depends on DEBUG_VM
806 help
807 Enable this to turn on VMA caching debug information. Doing so
808 can cause significant overhead, so only enable it in non-production
809 environments.
810
811 If unsure, say N.
812
Dave Hansen0610c8a2013-07-01 13:04:43 -0700813config DEBUG_VM_RB
814 bool "Debug VM red-black trees"
815 depends on DEBUG_VM
816 help
Davidlohr Buesoa663dad2014-04-18 15:07:22 -0700817 Enable VM red-black tree debugging information and extra validations.
Dave Hansen0610c8a2013-07-01 13:04:43 -0700818
819 If unsure, say N.
820
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800821config DEBUG_VM_PGFLAGS
822 bool "Debug page-flags operations"
823 depends on DEBUG_VM
824 help
825 Enables extra validation on page flags operations.
826
827 If unsure, say N.
828
Anshuman Khandual399145f2020-06-04 16:47:15 -0700829config DEBUG_VM_PGTABLE
830 bool "Debug arch page table for semantics compliance"
831 depends on MMU
832 depends on ARCH_HAS_DEBUG_VM_PGTABLE
833 default y if DEBUG_VM
834 help
835 This option provides a debug method which can be used to test
836 architecture page table helper functions on various platforms in
837 verifying if they comply with expected generic MM semantics. This
838 will help architecture code in making sure that any changes or
839 new additions of these helpers still conform to expected
840 semantics of the generic MM. Platforms will have to opt in for
841 this through ARCH_HAS_DEBUG_VM_PGTABLE.
842
843 If unsure, say N.
844
Laura Abbottfa5b6ec2017-01-10 13:35:40 -0800845config ARCH_HAS_DEBUG_VIRTUAL
846 bool
847
Dave Hansen0610c8a2013-07-01 13:04:43 -0700848config DEBUG_VIRTUAL
849 bool "Debug VM translations"
Laura Abbottfa5b6ec2017-01-10 13:35:40 -0800850 depends on DEBUG_KERNEL && ARCH_HAS_DEBUG_VIRTUAL
Dave Hansen0610c8a2013-07-01 13:04:43 -0700851 help
852 Enable some costly sanity checks in virtual to page code. This can
853 catch mistakes with virt_to_page() and friends.
854
855 If unsure, say N.
856
857config DEBUG_NOMMU_REGIONS
858 bool "Debug the global anon/private NOMMU mapping region tree"
859 depends on DEBUG_KERNEL && !MMU
860 help
861 This option causes the global tree of anonymous and private mapping
862 regions to be regularly checked for invalid topology.
863
864config DEBUG_MEMORY_INIT
865 bool "Debug memory initialisation" if EXPERT
866 default !EXPERT
867 help
868 Enable this for additional checks during memory initialisation.
869 The sanity checks verify aspects of the VM such as the memory model
870 and other information provided by the architecture. Verbose
871 information will be printed at KERN_DEBUG loglevel depending
872 on the mminit_loglevel= command-line option.
873
874 If unsure, say Y
875
876config MEMORY_NOTIFIER_ERROR_INJECT
877 tristate "Memory hotplug notifier error injection module"
878 depends on MEMORY_HOTPLUG_SPARSE && NOTIFIER_ERROR_INJECTION
879 help
880 This option provides the ability to inject artificial errors to
881 memory hotplug notifier chain callbacks. It is controlled through
882 debugfs interface under /sys/kernel/debug/notifier-error-inject/memory
883
884 If the notifier call chain should be failed with some events
885 notified, write the error code to "actions/<notifier event>/error".
886
887 Example: Inject memory hotplug offline error (-12 == -ENOMEM)
888
889 # cd /sys/kernel/debug/notifier-error-inject/memory
890 # echo -12 > actions/MEM_GOING_OFFLINE/error
891 # echo offline > /sys/devices/system/memory/memoryXXX/state
892 bash: echo: write error: Cannot allocate memory
893
894 To compile this code as a module, choose M here: the module will
895 be called memory-notifier-error-inject.
896
897 If unsure, say N.
898
899config DEBUG_PER_CPU_MAPS
900 bool "Debug access to per_cpu maps"
901 depends on DEBUG_KERNEL
902 depends on SMP
903 help
904 Say Y to verify that the per_cpu map being accessed has
905 been set up. This adds a fair amount of code to kernel memory
906 and decreases performance.
907
908 Say N if unsure.
909
Thomas Gleixner6e799cb2020-11-18 20:48:39 +0100910config DEBUG_KMAP_LOCAL
911 bool "Debug kmap_local temporary mappings"
912 depends on DEBUG_KERNEL && KMAP_LOCAL
913 help
914 This option enables additional error checking for the kmap_local
915 infrastructure. Disable for production use.
916
Thomas Gleixner0e91a0c2020-11-18 20:48:40 +0100917config ARCH_SUPPORTS_KMAP_LOCAL_FORCE_MAP
918 bool
919
920config DEBUG_KMAP_LOCAL_FORCE_MAP
921 bool "Enforce kmap_local temporary mappings"
922 depends on DEBUG_KERNEL && ARCH_SUPPORTS_KMAP_LOCAL_FORCE_MAP
923 select KMAP_LOCAL
924 select DEBUG_KMAP_LOCAL
925 help
926 This option enforces temporary mappings through the kmap_local
927 mechanism for non-highmem pages and on non-highmem systems.
928 Disable this for production systems!
929
Dave Hansen0610c8a2013-07-01 13:04:43 -0700930config DEBUG_HIGHMEM
931 bool "Highmem debugging"
932 depends on DEBUG_KERNEL && HIGHMEM
Thomas Gleixner0e91a0c2020-11-18 20:48:40 +0100933 select DEBUG_KMAP_LOCAL_FORCE_MAP if ARCH_SUPPORTS_KMAP_LOCAL_FORCE_MAP
Thomas Gleixner6e799cb2020-11-18 20:48:39 +0100934 select DEBUG_KMAP_LOCAL
Dave Hansen0610c8a2013-07-01 13:04:43 -0700935 help
Geert Uytterhoevenb1357c92014-04-14 18:55:50 +0200936 This option enables additional error checking for high memory
937 systems. Disable for production systems.
Dave Hansen0610c8a2013-07-01 13:04:43 -0700938
939config HAVE_DEBUG_STACKOVERFLOW
940 bool
941
942config DEBUG_STACKOVERFLOW
943 bool "Check for stack overflows"
944 depends on DEBUG_KERNEL && HAVE_DEBUG_STACKOVERFLOW
Masahiro Yamadaa7f7f622020-06-14 01:50:22 +0900945 help
Dave Hansen0610c8a2013-07-01 13:04:43 -0700946 Say Y here if you want to check for overflows of kernel, IRQ
Borislav Petkovedb0ec02015-01-25 19:50:34 +0100947 and exception stacks (if your architecture uses them). This
Dave Hansen0610c8a2013-07-01 13:04:43 -0700948 option will show detailed messages if free stack space drops
949 below a certain limit.
950
951 These kinds of bugs usually occur when call-chains in the
952 kernel get too deep, especially when interrupts are
953 involved.
954
955 Use this in cases where you see apparently random memory
956 corruption, especially if it appears in 'struct thread_info'
957
958 If in doubt, say "N".
959
Andrey Ryabinin0b24bec2015-02-13 14:39:17 -0800960source "lib/Kconfig.kasan"
Alexander Potapenko0ce20dd2021-02-25 17:18:53 -0800961source "lib/Kconfig.kfence"
Andrey Ryabinin0b24bec2015-02-13 14:39:17 -0800962
Dave Hansen0610c8a2013-07-01 13:04:43 -0700963endmenu # "Memory Debugging"
964
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965config DEBUG_SHIRQ
966 bool "Debug shared IRQ handlers"
Martin Schwidefsky0244ad02013-08-30 09:39:53 +0200967 depends on DEBUG_KERNEL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968 help
Wolfram Sang0a2fae22020-07-03 00:20:24 +0200969 Enable this to generate a spurious interrupt just before a shared
970 interrupt handler is deregistered (generating one when registering
971 is currently disabled). Drivers need to handle this correctly. Some
972 don't and need to be caught.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973
Changbin Duf43a2892019-12-06 17:03:54 -0800974menu "Debug Oops, Lockups and Hangs"
975
976config PANIC_ON_OOPS
977 bool "Panic on Oops"
978 help
979 Say Y here to enable the kernel to panic when it oopses. This
980 has the same effect as setting oops=panic on the kernel command
981 line.
982
983 This feature is useful to ensure that the kernel does not do
984 anything erroneous after an oops which could result in data
985 corruption or other issues.
986
987 Say N if unsure.
988
989config PANIC_ON_OOPS_VALUE
990 int
991 range 0 1
992 default 0 if !PANIC_ON_OOPS
993 default 1 if PANIC_ON_OOPS
994
995config PANIC_TIMEOUT
996 int "panic timeout"
997 default 0
998 help
Tiezhu Yang9d5b1342020-08-11 18:36:49 -0700999 Set the timeout value (in seconds) until a reboot occurs when
Changbin Duf43a2892019-12-06 17:03:54 -08001000 the kernel panics. If n = 0, then we wait forever. A timeout
1001 value n > 0 will wait n seconds before rebooting, while a timeout
1002 value n < 0 will reboot immediately.
Dave Hansen92aef8fb2013-07-01 13:04:50 -07001003
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004config LOCKUP_DETECTOR
Nicholas Piggin05a4a952017-07-12 14:35:46 -07001005 bool
1006
1007config SOFTLOCKUP_DETECTOR
1008 bool "Detect Soft Lockups"
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 depends on DEBUG_KERNEL && !S390
Nicholas Piggin05a4a952017-07-12 14:35:46 -07001010 select LOCKUP_DETECTOR
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 help
1012 Say Y here to enable the kernel to act as a watchdog to detect
Nicholas Piggin05a4a952017-07-12 14:35:46 -07001013 soft lockups.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014
1015 Softlockups are bugs that cause the kernel to loop in kernel
1016 mode for more than 20 seconds, without giving other tasks a
1017 chance to run. The current stack trace is displayed upon
1018 detection and the system will stay locked up.
1019
Randy Dunlap5f00ae02018-04-10 16:32:51 -07001020config BOOTPARAM_SOFTLOCKUP_PANIC
1021 bool "Panic (Reboot) On Soft Lockups"
1022 depends on SOFTLOCKUP_DETECTOR
1023 help
1024 Say Y here to enable the kernel to panic on "soft lockups",
1025 which are bugs that cause the kernel to loop in kernel
1026 mode for more than 20 seconds (configurable using the watchdog_thresh
1027 sysctl), without giving other tasks a chance to run.
1028
1029 The panic can be used in combination with panic_timeout,
1030 to cause the system to reboot automatically after a
1031 lockup has been detected. This feature is useful for
1032 high-availability systems that have uptime guarantees and
1033 where a lockup must be resolved ASAP.
1034
1035 Say N if unsure.
1036
1037config BOOTPARAM_SOFTLOCKUP_PANIC_VALUE
1038 int
1039 depends on SOFTLOCKUP_DETECTOR
1040 range 0 1
1041 default 0 if !BOOTPARAM_SOFTLOCKUP_PANIC
1042 default 1 if BOOTPARAM_SOFTLOCKUP_PANIC
1043
Nicholas Piggin05a4a952017-07-12 14:35:46 -07001044config HARDLOCKUP_DETECTOR_PERF
1045 bool
1046 select SOFTLOCKUP_DETECTOR
1047
1048#
Thomas Gleixner7edaeb62017-08-15 09:50:13 +02001049# Enables a timestamp based low pass filter to compensate for perf based
1050# hard lockup detection which runs too fast due to turbo modes.
1051#
1052config HARDLOCKUP_CHECK_TIMESTAMP
1053 bool
1054
1055#
Nicholas Piggin05a4a952017-07-12 14:35:46 -07001056# arch/ can define HAVE_HARDLOCKUP_DETECTOR_ARCH to provide their own hard
1057# lockup detector rather than the perf based detector.
1058#
1059config HARDLOCKUP_DETECTOR
1060 bool "Detect Hard Lockups"
1061 depends on DEBUG_KERNEL && !S390
1062 depends on HAVE_HARDLOCKUP_DETECTOR_PERF || HAVE_HARDLOCKUP_DETECTOR_ARCH
1063 select LOCKUP_DETECTOR
1064 select HARDLOCKUP_DETECTOR_PERF if HAVE_HARDLOCKUP_DETECTOR_PERF
1065 select HARDLOCKUP_DETECTOR_ARCH if HAVE_HARDLOCKUP_DETECTOR_ARCH
1066 help
1067 Say Y here to enable the kernel to act as a watchdog to detect
1068 hard lockups.
1069
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070 Hardlockups are bugs that cause the CPU to loop in kernel mode
1071 for more than 10 seconds, without letting other interrupts have a
1072 chance to run. The current stack trace is displayed upon detection
1073 and the system will stay locked up.
1074
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075config BOOTPARAM_HARDLOCKUP_PANIC
1076 bool "Panic (Reboot) On Hard Lockups"
1077 depends on HARDLOCKUP_DETECTOR
1078 help
1079 Say Y here to enable the kernel to panic on "hard lockups",
1080 which are bugs that cause the kernel to loop in kernel
1081 mode with interrupts disabled for more than 10 seconds (configurable
1082 using the watchdog_thresh sysctl).
1083
1084 Say N if unsure.
1085
1086config BOOTPARAM_HARDLOCKUP_PANIC_VALUE
1087 int
1088 depends on HARDLOCKUP_DETECTOR
1089 range 0 1
1090 default 0 if !BOOTPARAM_HARDLOCKUP_PANIC
1091 default 1 if BOOTPARAM_HARDLOCKUP_PANIC
1092
Linus Torvalds1da177e2005-04-16 15:20:36 -07001093config DETECT_HUNG_TASK
1094 bool "Detect Hung Tasks"
1095 depends on DEBUG_KERNEL
Nicholas Piggin05a4a952017-07-12 14:35:46 -07001096 default SOFTLOCKUP_DETECTOR
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 help
1098 Say Y here to enable the kernel to detect "hung tasks",
1099 which are bugs that cause the task to be stuck in
Vivien Didelot96b03ab2016-09-22 16:55:13 -04001100 uninterruptible "D" state indefinitely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101
1102 When a hung task is detected, the kernel will print the
1103 current stack trace (which you should report), but the
1104 task will stay in uninterruptible state. If lockdep is
1105 enabled then all held locks will also be reported. This
1106 feature has negligible overhead.
Al Viro871751e2006-03-25 03:06:39 -08001107
1108config DEFAULT_HUNG_TASK_TIMEOUT
1109 int "Default timeout for hung task detection (in seconds)"
1110 depends on DETECT_HUNG_TASK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001111 default 120
1112 help
Ingo Molnar8637c092006-07-03 00:24:38 -07001113 This option controls the default timeout (in seconds) used
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 to determine when a task has become non-responsive and should
1115 be considered hung.
1116
1117 It can be adjusted at runtime via the kernel.hung_task_timeout_secs
1118 sysctl or by writing a value to
1119 /proc/sys/kernel/hung_task_timeout_secs.
1120
Ingo Molnare7eebaf2006-06-27 02:54:55 -07001121 A timeout of 0 disables the check. The default is two minutes.
1122 Keeping the default should be fine in most cases.
Ingo Molnare7eebaf2006-06-27 02:54:55 -07001123
1124config BOOTPARAM_HUNG_TASK_PANIC
1125 bool "Panic (Reboot) On Hung Tasks"
1126 depends on DETECT_HUNG_TASK
1127 help
1128 Say Y here to enable the kernel to panic on "hung tasks",
1129 which are bugs that cause the kernel to leave a task stuck
1130 in uninterruptible "D" state.
1131
1132 The panic can be used in combination with panic_timeout,
Thomas Gleixner61a87122006-06-27 02:54:56 -07001133 to cause the system to reboot automatically after a
1134 hung task has been detected. This feature is useful for
Roman Zippela1583d32006-06-27 02:55:00 -07001135 high-availability systems that have uptime guarantees and
Thomas Gleixner61a87122006-06-27 02:54:56 -07001136 where a hung tasks must be resolved ASAP.
1137
1138 Say N if unsure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001139
Hugh Dickins048c8bc2006-11-01 05:44:54 +11001140config BOOTPARAM_HUNG_TASK_PANIC_VALUE
Linus Torvalds1da177e2005-04-16 15:20:36 -07001141 int
1142 depends on DETECT_HUNG_TASK
1143 range 0 1
1144 default 0 if !BOOTPARAM_HUNG_TASK_PANIC
1145 default 1 if BOOTPARAM_HUNG_TASK_PANIC
1146
Tejun Heo82607adc2015-12-08 11:28:04 -05001147config WQ_WATCHDOG
1148 bool "Detect Workqueue Stalls"
1149 depends on DEBUG_KERNEL
1150 help
1151 Say Y here to enable stall detection on workqueues. If a
1152 worker pool doesn't make forward progress on a pending work
1153 item for over a given amount of time, 30s by default, a
1154 warning message is printed along with dump of workqueue
1155 state. This can be configured through kernel parameter
1156 "workqueue.watchdog_thresh" and its sysfs counterpart.
1157
Konstantin Khlebnikov30428ef2020-04-06 20:09:47 -07001158config TEST_LOCKUP
1159 tristate "Test module to generate lockups"
Tiezhu Yang63646bc2020-08-11 18:34:44 -07001160 depends on m
Konstantin Khlebnikov30428ef2020-04-06 20:09:47 -07001161 help
1162 This builds the "test_lockup" module that helps to make sure
1163 that watchdogs and lockup detectors are working properly.
1164
1165 Depending on module parameters it could emulate soft or hard
1166 lockup, "hung task", or locking arbitrary lock for a long time.
1167 Also it could generate series of lockups with cooling-down periods.
1168
1169 If unsure, say N.
1170
Dave Hansen92aef8fb2013-07-01 13:04:50 -07001171endmenu # "Debug lockups and hangs"
1172
Changbin Duebebdd02019-12-06 17:04:00 -08001173menu "Scheduler Debugging"
Jason Baron5800dc32013-11-25 23:23:04 +00001174
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175config SCHED_DEBUG
1176 bool "Collect scheduler debugging info"
1177 depends on DEBUG_KERNEL && PROC_FS
1178 default y
1179 help
1180 If you say Y here, the /proc/sched_debug file will be provided
1181 that can help debug the scheduler. The runtime overhead of this
1182 option is minimal.
1183
Naveen N. Raof6db8342015-06-25 23:53:37 +05301184config SCHED_INFO
1185 bool
1186 default n
1187
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188config SCHEDSTATS
1189 bool "Collect scheduler statistics"
1190 depends on DEBUG_KERNEL && PROC_FS
Naveen N. Raof6db8342015-06-25 23:53:37 +05301191 select SCHED_INFO
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 help
1193 If you say Y here, additional code will be inserted into the
1194 scheduler and related routines to collect statistics about
1195 scheduler behavior and provide them in /proc/schedstat. These
1196 stats may be useful for both tuning and debugging the scheduler
1197 If you aren't debugging the scheduler or trying to tune a specific
1198 application, you can say N to avoid the very slight overhead
1199 this adds.
1200
Changbin Duebebdd02019-12-06 17:04:00 -08001201endmenu
Aaron Tomlin0d9e2632014-09-12 14:16:19 +01001202
John Stultz3c17ad12015-03-11 21:16:32 -07001203config DEBUG_TIMEKEEPING
1204 bool "Enable extra timekeeping sanity checking"
1205 help
1206 This option will enable additional timekeeping sanity checks
1207 which may be helpful when diagnosing issues where timekeeping
1208 problems are suspected.
1209
1210 This may include checks in the timekeeping hotpaths, so this
1211 option may have a (very small) performance impact to some
1212 workloads.
1213
1214 If unsure, say N.
1215
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216config DEBUG_PREEMPT
1217 bool "Debug preemptible kernel"
Sebastian Andrzej Siewior9f472862019-10-15 21:18:19 +02001218 depends on DEBUG_KERNEL && PREEMPTION && TRACE_IRQFLAGS_SUPPORT
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 default y
1220 help
1221 If you say Y here then the kernel will use a debug variant of the
1222 commonly used smp_processor_id() function and will print warnings
1223 if kernel code uses it in a preemption-unsafe way. Also, the kernel
1224 will detect preemption count underflows.
1225
Dave Hansen9eade162013-07-01 13:04:47 -07001226menu "Lock Debugging (spinlocks, mutexes, etc...)"
1227
Waiman Longf07cbeb2018-03-30 17:27:59 -04001228config LOCK_DEBUGGING_SUPPORT
1229 bool
1230 depends on TRACE_IRQFLAGS_SUPPORT && STACKTRACE_SUPPORT && LOCKDEP_SUPPORT
1231 default y
1232
Waiman Long19193bc2018-03-30 17:28:00 -04001233config PROVE_LOCKING
1234 bool "Lock debugging: prove locking correctness"
1235 depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT
1236 select LOCKDEP
1237 select DEBUG_SPINLOCK
1238 select DEBUG_MUTEXES
1239 select DEBUG_RT_MUTEXES if RT_MUTEXES
Waiman Longc71fd892019-05-20 16:59:00 -04001240 select DEBUG_RWSEMS
Waiman Long19193bc2018-03-30 17:28:00 -04001241 select DEBUG_WW_MUTEX_SLOWPATH
1242 select DEBUG_LOCK_ALLOC
Ahmed S. Darwish8fd8ad52020-07-20 17:55:13 +02001243 select PREEMPT_COUNT if !ARCH_NO_PREEMPT
Waiman Long19193bc2018-03-30 17:28:00 -04001244 select TRACE_IRQFLAGS
1245 default n
1246 help
1247 This feature enables the kernel to prove that all locking
1248 that occurs in the kernel runtime is mathematically
1249 correct: that under no circumstance could an arbitrary (and
1250 not yet triggered) combination of observed locking
1251 sequences (on an arbitrary number of CPUs, running an
1252 arbitrary number of tasks and interrupt contexts) cause a
1253 deadlock.
1254
1255 In short, this feature enables the kernel to report locking
1256 related deadlocks before they actually occur.
1257
1258 The proof does not depend on how hard and complex a
1259 deadlock scenario would be to trigger: how many
1260 participant CPUs, tasks and irq-contexts would be needed
1261 for it to trigger. The proof also does not depend on
1262 timing: if a race and a resulting deadlock is possible
1263 theoretically (no matter how unlikely the race scenario
1264 is), it will be proven so and will immediately be
1265 reported by the kernel (once the event is observed that
1266 makes the deadlock theoretically possible).
1267
1268 If a deadlock is impossible (i.e. the locking rules, as
1269 observed by the kernel, are mathematically correct), the
1270 kernel reports nothing.
1271
1272 NOTE: this feature can also be enabled for rwlocks, mutexes
1273 and rwsems - in which case all dependencies between these
1274 different locking variants are observed and mapped too, and
1275 the proof of observed correctness is also maintained for an
1276 arbitrary combination of these separate locking variants.
1277
Mauro Carvalho Chehab387b1462019-04-10 08:32:41 -03001278 For more details, see Documentation/locking/lockdep-design.rst.
Waiman Long19193bc2018-03-30 17:28:00 -04001279
Peter Zijlstrade8f5e42020-03-21 12:26:01 +01001280config PROVE_RAW_LOCK_NESTING
1281 bool "Enable raw_spinlock - spinlock nesting checks"
1282 depends on PROVE_LOCKING
1283 default n
1284 help
1285 Enable the raw_spinlock vs. spinlock nesting checks which ensure
1286 that the lock nesting rules for PREEMPT_RT enabled kernels are
1287 not violated.
1288
1289 NOTE: There are known nesting problems. So if you enable this
1290 option expect lockdep splats until these problems have been fully
1291 addressed which is work in progress. This config switch allows to
1292 identify and analyze these problems. It will be removed and the
Zhen Lei9dbbc3b2021-07-07 18:07:31 -07001293 check permanently enabled once the main issues have been fixed.
Peter Zijlstrade8f5e42020-03-21 12:26:01 +01001294
1295 If unsure, select N.
1296
Waiman Long19193bc2018-03-30 17:28:00 -04001297config LOCK_STAT
1298 bool "Lock usage statistics"
1299 depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT
1300 select LOCKDEP
1301 select DEBUG_SPINLOCK
1302 select DEBUG_MUTEXES
1303 select DEBUG_RT_MUTEXES if RT_MUTEXES
1304 select DEBUG_LOCK_ALLOC
1305 default n
1306 help
1307 This feature enables tracking lock contention points
1308
Mauro Carvalho Chehab387b1462019-04-10 08:32:41 -03001309 For more details, see Documentation/locking/lockstat.rst
Waiman Long19193bc2018-03-30 17:28:00 -04001310
1311 This also enables lock events required by "perf lock",
1312 subcommand of perf.
1313 If you want to use "perf lock", you also need to turn on
1314 CONFIG_EVENT_TRACING.
1315
1316 CONFIG_LOCK_STAT defines "contended" and "acquired" lock events.
1317 (CONFIG_LOCKDEP defines "acquire" and "release" events.)
1318
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319config DEBUG_RT_MUTEXES
1320 bool "RT Mutex debugging, deadlock detection"
1321 depends on DEBUG_KERNEL && RT_MUTEXES
1322 help
1323 This allows rt mutex semantics violations and rt mutex related
1324 deadlocks (lockups) to be detected and reported automatically.
1325
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326config DEBUG_SPINLOCK
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001327 bool "Spinlock and rw-lock debugging: basic checks"
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 depends on DEBUG_KERNEL
Raghavendra K Te335e3e2012-03-22 15:25:08 +05301329 select UNINLINE_SPIN_UNLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 help
1331 Say Y here and build SMP to catch missing spinlock initialization
1332 and certain other kinds of spinlock errors commonly made. This is
1333 best used in conjunction with the NMI watchdog so that spinlock
1334 deadlocks are also debuggable.
1335
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001336config DEBUG_MUTEXES
1337 bool "Mutex debugging: basic checks"
1338 depends on DEBUG_KERNEL
1339 help
1340 This feature allows mutex semantics violations to be detected and
1341 reported.
1342
Daniel Vetter23010022013-06-20 13:31:17 +02001343config DEBUG_WW_MUTEX_SLOWPATH
1344 bool "Wait/wound mutex debugging: Slowpath testing"
Waiman Longf07cbeb2018-03-30 17:27:59 -04001345 depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT
Daniel Vetter23010022013-06-20 13:31:17 +02001346 select DEBUG_LOCK_ALLOC
1347 select DEBUG_SPINLOCK
1348 select DEBUG_MUTEXES
1349 help
1350 This feature enables slowpath testing for w/w mutex users by
1351 injecting additional -EDEADLK wound/backoff cases. Together with
1352 the full mutex checks enabled with (CONFIG_PROVE_LOCKING) this
1353 will test all possible w/w mutex interface abuse with the
1354 exception of simply not acquiring all the required locks.
Rob Clark4d692372014-08-27 11:19:26 -04001355 Note that this feature can introduce significant overhead, so
1356 it really should not be enabled in a production or distro kernel,
1357 even a debug kernel. If you are a driver writer, enable it. If
1358 you are a distro, do not.
Daniel Vetter23010022013-06-20 13:31:17 +02001359
Waiman Long5149cba2018-03-30 17:27:58 -04001360config DEBUG_RWSEMS
1361 bool "RW Semaphore debugging: basic checks"
Waiman Longc71fd892019-05-20 16:59:00 -04001362 depends on DEBUG_KERNEL
Waiman Long5149cba2018-03-30 17:27:58 -04001363 help
Waiman Longc71fd892019-05-20 16:59:00 -04001364 This debugging feature allows mismatched rw semaphore locks
1365 and unlocks to be detected and reported.
Waiman Long5149cba2018-03-30 17:27:58 -04001366
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001367config DEBUG_LOCK_ALLOC
1368 bool "Lock debugging: detect incorrect freeing of live locks"
Waiman Longf07cbeb2018-03-30 17:27:59 -04001369 depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001370 select DEBUG_SPINLOCK
1371 select DEBUG_MUTEXES
Peter Zijlstraf5694782016-09-19 12:15:37 +02001372 select DEBUG_RT_MUTEXES if RT_MUTEXES
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001373 select LOCKDEP
1374 help
1375 This feature will check whether any held lock (spinlock, rwlock,
1376 mutex or rwsem) is incorrectly freed by the kernel, via any of the
1377 memory-freeing routines (kfree(), kmem_cache_free(), free_pages(),
1378 vfree(), etc.), whether a live lock is incorrectly reinitialized via
1379 spin_lock_init()/mutex_init()/etc., or whether there is any lock
1380 held during task exit.
1381
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001382config LOCKDEP
1383 bool
Waiman Longf07cbeb2018-03-30 17:27:59 -04001384 depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001385 select STACKTRACE
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001386 select KALLSYMS
1387 select KALLSYMS_ALL
1388
Daniel Jordan395102d2017-04-10 11:50:52 -04001389config LOCKDEP_SMALL
1390 bool
1391
Tetsuo Handa5dc33592021-04-05 20:33:57 +09001392config LOCKDEP_BITS
1393 int "Bitsize for MAX_LOCKDEP_ENTRIES"
1394 depends on LOCKDEP && !LOCKDEP_SMALL
1395 range 10 30
1396 default 15
1397 help
1398 Try increasing this value if you hit "BUG: MAX_LOCKDEP_ENTRIES too low!" message.
1399
1400config LOCKDEP_CHAINS_BITS
1401 int "Bitsize for MAX_LOCKDEP_CHAINS"
1402 depends on LOCKDEP && !LOCKDEP_SMALL
1403 range 10 30
1404 default 16
1405 help
1406 Try increasing this value if you hit "BUG: MAX_LOCKDEP_CHAINS too low!" message.
1407
1408config LOCKDEP_STACK_TRACE_BITS
1409 int "Bitsize for MAX_STACK_TRACE_ENTRIES"
1410 depends on LOCKDEP && !LOCKDEP_SMALL
1411 range 10 30
1412 default 19
1413 help
1414 Try increasing this value if you hit "BUG: MAX_STACK_TRACE_ENTRIES too low!" message.
1415
1416config LOCKDEP_STACK_TRACE_HASH_BITS
1417 int "Bitsize for STACK_TRACE_HASH_SIZE"
1418 depends on LOCKDEP && !LOCKDEP_SMALL
1419 range 10 30
1420 default 14
1421 help
1422 Try increasing this value if you need large MAX_STACK_TRACE_ENTRIES.
1423
1424config LOCKDEP_CIRCULAR_QUEUE_BITS
1425 int "Bitsize for elements in circular_queue struct"
1426 depends on LOCKDEP
1427 range 10 30
1428 default 12
1429 help
1430 Try increasing this value if you hit "lockdep bfs error:-1" warning due to __cq_enqueue() failure.
1431
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001432config DEBUG_LOCKDEP
1433 bool "Lock dependency engine debugging"
Adrian Bunk517e7aa2006-07-14 00:24:32 -07001434 depends on DEBUG_KERNEL && LOCKDEP
Mark Rutland997acaf2021-01-11 15:37:07 +00001435 select DEBUG_IRQFLAGS
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001436 help
1437 If you say Y here, the lock dependency engine will do
1438 additional runtime checks to debug itself, at the price
1439 of more runtime overhead.
1440
Frederic Weisbeckerd902db12011-06-08 19:31:56 +02001441config DEBUG_ATOMIC_SLEEP
1442 bool "Sleep inside atomic section checking"
Frederic Weisbeckere8f7c702011-06-08 01:51:02 +02001443 select PREEMPT_COUNT
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 depends on DEBUG_KERNEL
Christoph Hellwig87a4c372018-07-31 13:39:32 +02001445 depends on !ARCH_NO_PREEMPT
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 help
1447 If you say Y here, various routines which may sleep will become very
Frederic Weisbeckerd902db12011-06-08 19:31:56 +02001448 noisy if they are called inside atomic sections: when a spinlock is
1449 held, inside an rcu read side critical section, inside preempt disabled
1450 sections, inside an interrupt, etc...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451
Ingo Molnarcae2ed92006-07-03 00:24:48 -07001452config DEBUG_LOCKING_API_SELFTESTS
1453 bool "Locking API boot-time self-tests"
1454 depends on DEBUG_KERNEL
1455 help
1456 Say Y here if you want the kernel to run a short self-test during
1457 bootup. The self-test checks whether common types of locking bugs
1458 are detected by debugging mechanisms or not. (if you disable
Zhen Lei9dbbc3b2021-07-07 18:07:31 -07001459 lock debugging then those bugs won't be detected of course.)
Ingo Molnarcae2ed92006-07-03 00:24:48 -07001460 The following locking APIs are covered: spinlocks, rwlocks,
1461 mutexes and rwsems.
1462
Paul E. McKenney0af3fe12014-02-04 15:51:41 -08001463config LOCK_TORTURE_TEST
1464 tristate "torture tests for locking"
1465 depends on DEBUG_KERNEL
1466 select TORTURE_TEST
Paul E. McKenney0af3fe12014-02-04 15:51:41 -08001467 help
1468 This option provides a kernel module that runs torture tests
1469 on kernel locking primitives. The kernel module may be built
1470 after the fact on the running kernel to be tested, if desired.
1471
1472 Say Y here if you want kernel locking-primitive torture tests
1473 to be built into the kernel.
1474 Say M if you want these torture tests to build as a module.
1475 Say N if you are unsure.
1476
Chris Wilsonf2a5fec2016-12-01 11:47:06 +00001477config WW_MUTEX_SELFTEST
1478 tristate "Wait/wound mutex selftests"
1479 help
1480 This option provides a kernel module that runs tests on the
1481 on the struct ww_mutex locking API.
1482
1483 It is recommended to enable DEBUG_WW_MUTEX_SLOWPATH in conjunction
1484 with this test harness.
1485
1486 Say M if you want these self tests to build as a module.
1487 Say N if you are unsure.
1488
Paul E. McKenneye9d338a2020-06-24 15:59:59 -07001489config SCF_TORTURE_TEST
1490 tristate "torture tests for smp_call_function*()"
1491 depends on DEBUG_KERNEL
1492 select TORTURE_TEST
1493 help
1494 This option provides a kernel module that runs torture tests
1495 on the smp_call_function() family of primitives. The kernel
1496 module may be built after the fact on the running kernel to
1497 be tested, if desired.
1498
Paul E. McKenney35feb602020-06-30 13:22:54 -07001499config CSD_LOCK_WAIT_DEBUG
1500 bool "Debugging for csd_lock_wait(), called from smp_call_function*()"
1501 depends on DEBUG_KERNEL
1502 depends on 64BIT
1503 default n
1504 help
1505 This option enables debug prints when CPUs are slow to respond
1506 to the smp_call_function*() IPI wrappers. These debug prints
1507 include the IPI handler function currently executing (if any)
1508 and relevant stack traces.
1509
Dave Hansen9eade162013-07-01 13:04:47 -07001510endmenu # lock debugging
1511
1512config TRACE_IRQFLAGS
peterz@infradead.orged004952020-07-27 14:48:52 +02001513 depends on TRACE_IRQFLAGS_SUPPORT
Dave Hansen9eade162013-07-01 13:04:47 -07001514 bool
1515 help
1516 Enables hooks to interrupt enabling and disabling for
1517 either tracing or lock debugging.
1518
peterz@infradead.orged004952020-07-27 14:48:52 +02001519config TRACE_IRQFLAGS_NMI
1520 def_bool y
1521 depends on TRACE_IRQFLAGS
1522 depends on TRACE_IRQFLAGS_NMI_SUPPORT
1523
Mark Rutland997acaf2021-01-11 15:37:07 +00001524config DEBUG_IRQFLAGS
1525 bool "Debug IRQ flag manipulation"
1526 help
1527 Enables checks for potentially unsafe enabling or disabling of
1528 interrupts, such as calling raw_local_irq_restore() when interrupts
1529 are enabled.
1530
Ingo Molnar8637c092006-07-03 00:24:38 -07001531config STACKTRACE
Dave Jones0c38e1f2014-08-29 15:18:35 -07001532 bool "Stack backtrace support"
Ingo Molnar8637c092006-07-03 00:24:38 -07001533 depends on STACKTRACE_SUPPORT
Dave Jones0c38e1f2014-08-29 15:18:35 -07001534 help
1535 This option causes the kernel to create a /proc/pid/stack for
1536 every process, showing its current stack trace.
1537 It is also used by various kernel debugging features that require
1538 stack trace generation.
Ingo Molnar8637c092006-07-03 00:24:38 -07001539
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001540config WARN_ALL_UNSEEDED_RANDOM
1541 bool "Warn for all uses of unseeded randomness"
1542 default n
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04001543 help
1544 Some parts of the kernel contain bugs relating to their use of
1545 cryptographically secure random numbers before it's actually possible
1546 to generate those numbers securely. This setting ensures that these
1547 flaws don't go unnoticed, by enabling a message, should this ever
1548 occur. This will allow people with obscure setups to know when things
1549 are going wrong, so that they might contact developers about fixing
1550 it.
1551
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001552 Unfortunately, on some models of some architectures getting
1553 a fully seeded CRNG is extremely difficult, and so this can
1554 result in dmesg getting spammed for a surprisingly long
1555 time. This is really bad from a security perspective, and
1556 so architecture maintainers really need to do what they can
1557 to get the CRNG seeded sooner after the system is booted.
Thibaut Sautereau4c5d1142018-09-04 15:46:23 -07001558 However, since users cannot do anything actionable to
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001559 address this, by default the kernel will issue only a single
1560 warning for the first use of unseeded randomness.
1561
1562 Say Y here if you want to receive warnings for all uses of
1563 unseeded randomness. This will be of use primarily for
Thibaut Sautereau4c5d1142018-09-04 15:46:23 -07001564 those developers interested in improving the security of
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001565 Linux kernels running on their architecture (or
1566 subarchitecture).
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04001567
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568config DEBUG_KOBJECT
1569 bool "kobject debugging"
1570 depends on DEBUG_KERNEL
1571 help
1572 If you say Y here, some extra kobject debugging messages will be sent
Mike Rapoportaca52c32018-10-30 15:07:44 -07001573 to the syslog.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001574
Russell Kingc817a672013-06-27 15:06:14 +01001575config DEBUG_KOBJECT_RELEASE
1576 bool "kobject release debugging"
Linus Torvalds2a999aa2013-10-29 08:33:36 -07001577 depends on DEBUG_OBJECTS_TIMERS
Russell Kingc817a672013-06-27 15:06:14 +01001578 help
1579 kobjects are reference counted objects. This means that their
1580 last reference count put is not predictable, and the kobject can
1581 live on past the point at which a driver decides to drop it's
1582 initial reference to the kobject gained on allocation. An
1583 example of this would be a struct device which has just been
1584 unregistered.
1585
1586 However, some buggy drivers assume that after such an operation,
1587 the memory backing the kobject can be immediately freed. This
1588 goes completely against the principles of a refcounted object.
1589
1590 If you say Y here, the kernel will delay the release of kobjects
1591 on the last reference count to improve the visibility of this
1592 kind of kobject release bug.
1593
Catalin Marinas9b2a60c2012-10-08 16:28:13 -07001594config HAVE_DEBUG_BUGVERBOSE
1595 bool
1596
Changbin Du3be5cbc2019-12-06 17:03:48 -08001597menu "Debug kernel data structures"
Linus Torvalds1da177e2005-04-16 15:20:36 -07001598
Dave Jones199a9af2006-09-29 01:59:00 -07001599config DEBUG_LIST
1600 bool "Debug linked list manipulation"
Arnd Bergmann4520bcb2016-08-26 17:42:00 +02001601 depends on DEBUG_KERNEL || BUG_ON_DATA_CORRUPTION
Dave Jones199a9af2006-09-29 01:59:00 -07001602 help
1603 Enable this to turn on extended checks in the linked-list
1604 walking routines.
1605
1606 If unsure, say N.
1607
Davidlohr Bueso8e18fae2019-05-14 15:42:46 -07001608config DEBUG_PLIST
Dan Streetmanb8cfff62014-06-04 16:11:54 -07001609 bool "Debug priority linked list manipulation"
1610 depends on DEBUG_KERNEL
1611 help
1612 Enable this to turn on extended checks in the priority-ordered
1613 linked-list (plist) walking routines. This checks the entire
1614 list multiple times during each manipulation.
1615
1616 If unsure, say N.
1617
Jens Axboed6ec0842007-10-22 20:01:06 +02001618config DEBUG_SG
1619 bool "Debug SG table operations"
1620 depends on DEBUG_KERNEL
1621 help
1622 Enable this to turn on checks on scatter-gather tables. This can
1623 help find problems with drivers that do not properly initialize
1624 their sg tables.
1625
1626 If unsure, say N.
1627
Arjan van de Ven1b2439d2008-08-15 15:29:38 -07001628config DEBUG_NOTIFIERS
1629 bool "Debug notifier call chains"
1630 depends on DEBUG_KERNEL
1631 help
1632 Enable this to turn on sanity checking for notifier call chains.
1633 This is most useful for kernel developers to make sure that
1634 modules properly unregister themselves from notifier chains.
1635 This is a relatively cheap check but if you care about maximum
1636 performance, say N.
1637
Changbin Du3be5cbc2019-12-06 17:03:48 -08001638config BUG_ON_DATA_CORRUPTION
1639 bool "Trigger a BUG when data corruption is detected"
1640 select DEBUG_LIST
1641 help
1642 Select this option if the kernel should BUG when it encounters
1643 data corruption in kernel memory structures when they get checked
1644 for validity.
1645
1646 If unsure, say N.
1647
1648endmenu
1649
David Howellse0e81732009-09-02 09:13:40 +01001650config DEBUG_CREDENTIALS
1651 bool "Debug credential management"
1652 depends on DEBUG_KERNEL
1653 help
1654 Enable this to turn on some debug checking for credential
1655 management. The additional code keeps track of the number of
1656 pointers from task_structs to any given cred struct, and checks to
1657 see that this number never exceeds the usage count of the cred
1658 struct.
1659
1660 Furthermore, if SELinux is enabled, this also checks that the
1661 security pointer in the cred struct is never seen to be invalid.
1662
1663 If unsure, say N.
1664
Paul E. McKenney43a0a2a2017-05-17 09:19:44 -07001665source "kernel/rcu/Kconfig.debug"
Dave Hansen2f03e3c2013-01-07 08:19:23 -08001666
Tejun Heof303fccb2016-02-09 17:59:38 -05001667config DEBUG_WQ_FORCE_RR_CPU
1668 bool "Force round-robin CPU selection for unbound work items"
1669 depends on DEBUG_KERNEL
1670 default n
1671 help
1672 Workqueue used to implicitly guarantee that work items queued
1673 without explicit CPU specified are put on the local CPU. This
1674 guarantee is no longer true and while local CPU is still
1675 preferred work items may be put on foreign CPUs. Kernel
1676 parameter "workqueue.debug_force_rr_cpu" is added to force
1677 round-robin CPU selection to flush out usages which depend on the
1678 now broken guarantee. This config option enables the debug
1679 feature by default. When enabled, memory and cache locality will
1680 be impacted.
1681
Tejun Heo870d6652008-08-25 19:47:25 +09001682config DEBUG_BLOCK_EXT_DEVT
Krzysztof Kozlowski68d4b3d2019-12-06 17:04:08 -08001683 bool "Force extended block device numbers and spread them"
Tejun Heo870d6652008-08-25 19:47:25 +09001684 depends on DEBUG_KERNEL
1685 depends on BLOCK
Jens Axboe759f8ca2008-08-29 09:06:29 +02001686 default n
Tejun Heo870d6652008-08-25 19:47:25 +09001687 help
Tejun Heo0e11e342008-10-13 10:46:01 +02001688 BIG FAT WARNING: ENABLING THIS OPTION MIGHT BREAK BOOTING ON
1689 SOME DISTRIBUTIONS. DO NOT ENABLE THIS UNLESS YOU KNOW WHAT
1690 YOU ARE DOING. Distros, please enable this and fix whatever
1691 is broken.
1692
Tejun Heo870d6652008-08-25 19:47:25 +09001693 Conventionally, block device numbers are allocated from
1694 predetermined contiguous area. However, extended block area
1695 may introduce non-contiguous block device numbers. This
1696 option forces most block device numbers to be allocated from
1697 the extended space and spreads them to discover kernel or
1698 userland code paths which assume predetermined contiguous
1699 device number allocation.
1700
Tejun Heo55dc7db2008-09-01 13:44:35 +02001701 Note that turning on this debug option shuffles all the
1702 device numbers for all IDE and SCSI devices including libata
1703 ones, so root partition specified using device number
1704 directly (via rdev or root=MAJ:MIN) won't work anymore.
1705 Textual device names (root=/dev/sdXn) will continue to work.
1706
Tejun Heo870d6652008-08-25 19:47:25 +09001707 Say N if you are unsure.
1708
Thomas Gleixner757c9892016-02-26 18:43:32 +00001709config CPU_HOTPLUG_STATE_CONTROL
1710 bool "Enable CPU hotplug state control"
1711 depends on DEBUG_KERNEL
1712 depends on HOTPLUG_CPU
1713 default n
1714 help
1715 Allows to write steps between "offline" and "online" to the CPUs
1716 sysfs target file so states can be stepped granular. This is a debug
1717 option for now as the hotplug machinery cannot be stopped and
1718 restarted at arbitrary points yet.
1719
1720 Say N if your are unsure.
1721
Changbin Du09a74952019-12-06 17:03:51 -08001722config LATENCYTOP
1723 bool "Latency measuring infrastructure"
1724 depends on DEBUG_KERNEL
1725 depends on STACKTRACE_SUPPORT
1726 depends on PROC_FS
Julian Braha7d37cb22021-04-09 13:27:47 -07001727 depends on FRAME_POINTER || MIPS || PPC || S390 || MICROBLAZE || ARM || ARC || X86
Changbin Du09a74952019-12-06 17:03:51 -08001728 select KALLSYMS
1729 select KALLSYMS_ALL
1730 select STACKTRACE
1731 select SCHEDSTATS
Changbin Du09a74952019-12-06 17:03:51 -08001732 help
1733 Enable this option if you want to use the LatencyTOP tool
1734 to find out which userspace is blocking on what kernel operations.
1735
1736source "kernel/trace/Kconfig"
1737
1738config PROVIDE_OHCI1394_DMA_INIT
1739 bool "Remote debugging over FireWire early on boot"
1740 depends on PCI && X86
1741 help
1742 If you want to debug problems which hang or crash the kernel early
1743 on boot and the crashing machine has a FireWire port, you can use
1744 this feature to remotely access the memory of the crashed machine
1745 over FireWire. This employs remote DMA as part of the OHCI1394
1746 specification which is now the standard for FireWire controllers.
1747
1748 With remote DMA, you can monitor the printk buffer remotely using
1749 firescope and access all memory below 4GB using fireproxy from gdb.
1750 Even controlling a kernel debugger is possible using remote DMA.
1751
1752 Usage:
1753
1754 If ohci1394_dma=early is used as boot parameter, it will initialize
1755 all OHCI1394 controllers which are found in the PCI config space.
1756
1757 As all changes to the FireWire bus such as enabling and disabling
1758 devices cause a bus reset and thereby disable remote DMA for all
1759 devices, be sure to have the cable plugged and FireWire enabled on
1760 the debugging host before booting the debug target for debugging.
1761
1762 This code (~1k) is freed after boot. By then, the firewire stack
1763 in charge of the OHCI-1394 controllers should be used instead.
1764
Mauro Carvalho Chehaba74e2a22020-05-01 17:37:50 +02001765 See Documentation/core-api/debugging-via-ohci1394.rst for more information.
Changbin Du09a74952019-12-06 17:03:51 -08001766
Changbin Du045f6d72019-12-17 20:51:56 -08001767source "samples/Kconfig"
1768
1769config ARCH_HAS_DEVMEM_IS_ALLOWED
1770 bool
1771
1772config STRICT_DEVMEM
1773 bool "Filter access to /dev/mem"
1774 depends on MMU && DEVMEM
Palmer Dabbelt527701e2020-07-09 11:43:21 -07001775 depends on ARCH_HAS_DEVMEM_IS_ALLOWED || GENERIC_LIB_DEVMEM_IS_ALLOWED
Changbin Du045f6d72019-12-17 20:51:56 -08001776 default y if PPC || X86 || ARM64
1777 help
1778 If this option is disabled, you allow userspace (root) access to all
1779 of memory, including kernel and userspace memory. Accidental
1780 access to this is obviously disastrous, but specific access can
1781 be used by people debugging the kernel. Note that with PAT support
1782 enabled, even in this case there are restrictions on /dev/mem
1783 use due to the cache aliasing requirements.
1784
1785 If this option is switched on, and IO_STRICT_DEVMEM=n, the /dev/mem
1786 file only allows userspace access to PCI space and the BIOS code and
1787 data regions. This is sufficient for dosemu and X and all common
1788 users of /dev/mem.
1789
1790 If in doubt, say Y.
1791
1792config IO_STRICT_DEVMEM
1793 bool "Filter I/O access to /dev/mem"
1794 depends on STRICT_DEVMEM
1795 help
1796 If this option is disabled, you allow userspace (root) access to all
1797 io-memory regardless of whether a driver is actively using that
1798 range. Accidental access to this is obviously disastrous, but
1799 specific access can be used by people debugging kernel drivers.
1800
1801 If this option is switched on, the /dev/mem file only allows
1802 userspace access to *idle* io-memory ranges (see /proc/iomem) This
1803 may break traditional users of /dev/mem (dosemu, legacy X, etc...)
1804 if the driver using a given range cannot be disabled.
1805
1806 If in doubt, say Y.
1807
1808menu "$(SRCARCH) Debugging"
1809
1810source "arch/$(SRCARCH)/Kconfig.debug"
1811
1812endmenu
1813
1814menu "Kernel Testing and Coverage"
1815
Changbin Du09a74952019-12-06 17:03:51 -08001816source "lib/kunit/Kconfig"
1817
Akinobu Mita8d438282012-07-30 14:43:02 -07001818config NOTIFIER_ERROR_INJECTION
1819 tristate "Notifier error injection"
1820 depends on DEBUG_KERNEL
1821 select DEBUG_FS
1822 help
Masanari Iidae41e85c2012-11-30 16:44:39 +09001823 This option provides the ability to inject artificial errors to
Akinobu Mita8d438282012-07-30 14:43:02 -07001824 specified notifier chain callbacks. It is useful to test the error
1825 handling of notifier call chain failures.
1826
1827 Say N if unsure.
1828
Akinobu Mita048b9c32012-07-30 14:43:07 -07001829config PM_NOTIFIER_ERROR_INJECT
1830 tristate "PM notifier error injection module"
1831 depends on PM && NOTIFIER_ERROR_INJECTION
1832 default m if PM_DEBUG
1833 help
Masanari Iidae41e85c2012-11-30 16:44:39 +09001834 This option provides the ability to inject artificial errors to
Akinobu Mita048b9c32012-07-30 14:43:07 -07001835 PM notifier chain callbacks. It is controlled through debugfs
1836 interface /sys/kernel/debug/notifier-error-inject/pm
1837
1838 If the notifier call chain should be failed with some events
1839 notified, write the error code to "actions/<notifier event>/error".
1840
1841 Example: Inject PM suspend error (-12 = -ENOMEM)
1842
1843 # cd /sys/kernel/debug/notifier-error-inject/pm/
1844 # echo -12 > actions/PM_SUSPEND_PREPARE/error
1845 # echo mem > /sys/power/state
1846 bash: echo: write error: Cannot allocate memory
1847
1848 To compile this code as a module, choose M here: the module will
1849 be called pm-notifier-error-inject.
1850
1851 If unsure, say N.
1852
Benjamin Herrenschmidtd526e852012-12-14 10:32:52 +11001853config OF_RECONFIG_NOTIFIER_ERROR_INJECT
1854 tristate "OF reconfig notifier error injection module"
1855 depends on OF_DYNAMIC && NOTIFIER_ERROR_INJECTION
Akinobu Mita08dfb4d2012-07-30 14:43:13 -07001856 help
Masanari Iidae41e85c2012-11-30 16:44:39 +09001857 This option provides the ability to inject artificial errors to
Benjamin Herrenschmidtd526e852012-12-14 10:32:52 +11001858 OF reconfig notifier chain callbacks. It is controlled
Akinobu Mita08dfb4d2012-07-30 14:43:13 -07001859 through debugfs interface under
Benjamin Herrenschmidtd526e852012-12-14 10:32:52 +11001860 /sys/kernel/debug/notifier-error-inject/OF-reconfig/
Akinobu Mita08dfb4d2012-07-30 14:43:13 -07001861
1862 If the notifier call chain should be failed with some events
1863 notified, write the error code to "actions/<notifier event>/error".
1864
1865 To compile this code as a module, choose M here: the module will
Akinobu Mitae12a95f2013-04-30 15:28:49 -07001866 be called of-reconfig-notifier-error-inject.
Akinobu Mita08dfb4d2012-07-30 14:43:13 -07001867
1868 If unsure, say N.
1869
Nikolay Aleksandrov02fff962015-11-28 13:45:28 +01001870config NETDEV_NOTIFIER_ERROR_INJECT
1871 tristate "Netdev notifier error injection module"
1872 depends on NET && NOTIFIER_ERROR_INJECTION
1873 help
1874 This option provides the ability to inject artificial errors to
1875 netdevice notifier chain callbacks. It is controlled through debugfs
1876 interface /sys/kernel/debug/notifier-error-inject/netdev
1877
1878 If the notifier call chain should be failed with some events
1879 notified, write the error code to "actions/<notifier event>/error".
1880
1881 Example: Inject netdevice mtu change error (-22 = -EINVAL)
1882
1883 # cd /sys/kernel/debug/notifier-error-inject/netdev
1884 # echo -22 > actions/NETDEV_CHANGEMTU/error
1885 # ip link set eth0 mtu 1024
1886 RTNETLINK answers: Invalid argument
1887
1888 To compile this code as a module, choose M here: the module will
1889 be called netdev-notifier-error-inject.
1890
1891 If unsure, say N.
1892
Mikulas Patockaf1b4bd02018-06-14 15:27:48 -07001893config FUNCTION_ERROR_INJECTION
1894 def_bool y
1895 depends on HAVE_FUNCTION_ERROR_INJECTION && KPROBES
1896
Akinobu Mita6ff1cb32006-12-08 02:39:43 -08001897config FAULT_INJECTION
Andrew Morton1ab8509a2006-12-08 02:39:49 -08001898 bool "Fault-injection framework"
1899 depends on DEBUG_KERNEL
Akinobu Mita329409a2006-12-08 02:39:48 -08001900 help
1901 Provide fault-injection framework.
1902 For more details, see Documentation/fault-injection/.
Akinobu Mita6ff1cb32006-12-08 02:39:43 -08001903
Akinobu Mita8a8b6502006-12-08 02:39:44 -08001904config FAILSLAB
Andrew Morton1ab8509a2006-12-08 02:39:49 -08001905 bool "Fault-injection capability for kmalloc"
1906 depends on FAULT_INJECTION
Akinobu Mita773ff602008-12-23 19:37:01 +09001907 depends on SLAB || SLUB
Akinobu Mita8a8b6502006-12-08 02:39:44 -08001908 help
Andrew Morton1ab8509a2006-12-08 02:39:49 -08001909 Provide fault-injection capability for kmalloc.
Akinobu Mita8a8b6502006-12-08 02:39:44 -08001910
Akinobu Mita933e3122006-12-08 02:39:45 -08001911config FAIL_PAGE_ALLOC
Qiujun Huang29b46fa2020-04-06 20:12:49 -07001912 bool "Fault-injection capability for alloc_pages()"
Andrew Morton1ab8509a2006-12-08 02:39:49 -08001913 depends on FAULT_INJECTION
Akinobu Mita933e3122006-12-08 02:39:45 -08001914 help
Andrew Morton1ab8509a2006-12-08 02:39:49 -08001915 Provide fault-injection capability for alloc_pages().
Akinobu Mita933e3122006-12-08 02:39:45 -08001916
Albert van der Linde2c739ce2020-10-15 20:13:46 -07001917config FAULT_INJECTION_USERCOPY
1918 bool "Fault injection capability for usercopy functions"
1919 depends on FAULT_INJECTION
1920 help
1921 Provides fault-injection capability to inject failures
1922 in usercopy functions (copy_from_user(), get_user(), ...).
1923
Akinobu Mitac17bb492006-12-08 02:39:46 -08001924config FAIL_MAKE_REQUEST
Dave Jones86327d12006-12-12 20:16:36 +01001925 bool "Fault-injection capability for disk IO"
Jens Axboe581d4e22008-09-14 05:56:33 -07001926 depends on FAULT_INJECTION && BLOCK
Akinobu Mitac17bb492006-12-08 02:39:46 -08001927 help
Andrew Morton1ab8509a2006-12-08 02:39:49 -08001928 Provide fault-injection capability for disk IO.
Akinobu Mitac17bb492006-12-08 02:39:46 -08001929
Jens Axboe581d4e22008-09-14 05:56:33 -07001930config FAIL_IO_TIMEOUT
Takuya Yoshikawaf4d01432010-07-21 16:05:53 +09001931 bool "Fault-injection capability for faking disk interrupts"
Jens Axboe581d4e22008-09-14 05:56:33 -07001932 depends on FAULT_INJECTION && BLOCK
1933 help
1934 Provide fault-injection capability on end IO handling. This
1935 will make the block layer "forget" an interrupt as configured,
1936 thus exercising the error handling.
1937
1938 Only works with drivers that use the generic timeout handling,
Zhen Lei9dbbc3b2021-07-07 18:07:31 -07001939 for others it won't do anything.
Jens Axboe581d4e22008-09-14 05:56:33 -07001940
Davidlohr Buesoab51fba2015-06-29 23:26:02 -07001941config FAIL_FUTEX
1942 bool "Fault-injection capability for futexes"
1943 select DEBUG_FS
1944 depends on FAULT_INJECTION && FUTEX
1945 help
1946 Provide fault-injection capability for futexes.
1947
Mikulas Patockaf1b4bd02018-06-14 15:27:48 -07001948config FAULT_INJECTION_DEBUG_FS
1949 bool "Debugfs entries for fault-injection capabilities"
1950 depends on FAULT_INJECTION && SYSFS && DEBUG_FS
1951 help
1952 Enable configuration of fault-injection capabilities via debugfs.
1953
Masami Hiramatsu4b1a29a2018-01-13 02:56:03 +09001954config FAIL_FUNCTION
1955 bool "Fault-injection capability for functions"
1956 depends on FAULT_INJECTION_DEBUG_FS && FUNCTION_ERROR_INJECTION
1957 help
1958 Provide function-based fault-injection capability.
1959 This will allow you to override a specific function with a return
1960 with given return value. As a result, function caller will see
1961 an error value and have to handle it. This is useful to test the
1962 error handling in various subsystems.
1963
Mikulas Patockaf1b4bd02018-06-14 15:27:48 -07001964config FAIL_MMC_REQUEST
1965 bool "Fault-injection capability for MMC IO"
1966 depends on FAULT_INJECTION_DEBUG_FS && MMC
Akinobu Mita6ff1cb32006-12-08 02:39:43 -08001967 help
Mikulas Patockaf1b4bd02018-06-14 15:27:48 -07001968 Provide fault-injection capability for MMC IO.
1969 This will make the mmc core return data errors. This is
1970 useful to test the error handling in the mmc block device
1971 and to test how the mmc host driver handles retries from
1972 the block device.
Akinobu Mita1df49002007-02-20 13:57:56 -08001973
Chuck Leverc782af22021-08-03 15:45:18 -04001974config FAIL_SUNRPC
1975 bool "Fault-injection capability for SunRPC"
1976 depends on FAULT_INJECTION_DEBUG_FS && SUNRPC_DEBUG
1977 help
1978 Provide fault-injection capability for SunRPC and
1979 its consumers.
1980
Akinobu Mita1df49002007-02-20 13:57:56 -08001981config FAULT_INJECTION_STACKTRACE_FILTER
1982 bool "stacktrace filter for fault-injection capabilities"
1983 depends on FAULT_INJECTION_DEBUG_FS && STACKTRACE_SUPPORT
Akinobu Mita6d690dc2007-05-12 10:36:53 -07001984 depends on !X86_64
Akinobu Mita1df49002007-02-20 13:57:56 -08001985 select STACKTRACE
Julian Braha7d37cb22021-04-09 13:27:47 -07001986 depends on FRAME_POINTER || MIPS || PPC || S390 || MICROBLAZE || ARM || ARC || X86
Akinobu Mita1df49002007-02-20 13:57:56 -08001987 help
1988 Provide stacktrace filter for fault-injection capabilities
Mathieu Desnoyers267c4022007-10-18 23:41:07 -07001989
Changbin Du09a74952019-12-06 17:03:51 -08001990config ARCH_HAS_KCOV
1991 bool
Arjan van de Ven97455122008-01-25 21:08:34 +01001992 help
Changbin Du09a74952019-12-06 17:03:51 -08001993 An architecture should select this when it can successfully
1994 build and run with CONFIG_KCOV. This typically requires
1995 disabling instrumentation for some early boot code.
Arjan van de Ven97455122008-01-25 21:08:34 +01001996
Changbin Du09a74952019-12-06 17:03:51 -08001997config CC_HAS_SANCOV_TRACE_PC
1998 def_bool $(cc-option,-fsanitize-coverage=trace-pc)
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +02001999
Changbin Du09a74952019-12-06 17:03:51 -08002000
2001config KCOV
2002 bool "Code coverage for fuzzing"
2003 depends on ARCH_HAS_KCOV
2004 depends on CC_HAS_SANCOV_TRACE_PC || GCC_PLUGINS
2005 select DEBUG_FS
2006 select GCC_PLUGIN_SANCOV if !CC_HAS_SANCOV_TRACE_PC
Randy Dunlapcc3fa842017-10-13 15:57:33 -07002007 help
Changbin Du09a74952019-12-06 17:03:51 -08002008 KCOV exposes kernel code coverage information in a form suitable
2009 for coverage-guided fuzzing (randomized testing).
Randy Dunlapcc3fa842017-10-13 15:57:33 -07002010
Changbin Du09a74952019-12-06 17:03:51 -08002011 If RANDOMIZE_BASE is enabled, PC values will not be stable across
2012 different machines and across reboots. If you need stable PC values,
2013 disable RANDOMIZE_BASE.
Randy Dunlapcc3fa842017-10-13 15:57:33 -07002014
Changbin Du09a74952019-12-06 17:03:51 -08002015 For more details, see Documentation/dev-tools/kcov.rst.
Randy Dunlapcc3fa842017-10-13 15:57:33 -07002016
Changbin Du09a74952019-12-06 17:03:51 -08002017config KCOV_ENABLE_COMPARISONS
2018 bool "Enable comparison operands collection by KCOV"
2019 depends on KCOV
2020 depends on $(cc-option,-fsanitize-coverage=trace-cmp)
2021 help
2022 KCOV also exposes operands of every comparison in the instrumented
2023 code along with operand sizes and PCs of the comparison instructions.
2024 These operands can be used by fuzzing engines to improve the quality
2025 of fuzzing coverage.
Randy Dunlapcc3fa842017-10-13 15:57:33 -07002026
Changbin Du09a74952019-12-06 17:03:51 -08002027config KCOV_INSTRUMENT_ALL
2028 bool "Instrument all code by default"
2029 depends on KCOV
2030 default y
2031 help
2032 If you are doing generic system call fuzzing (like e.g. syzkaller),
2033 then you will want to instrument the whole kernel and you should
2034 say y here. If you are doing more targeted fuzzing (like e.g.
2035 filesystem fuzzing with AFL) then you will want to enable coverage
2036 for more specific subsets of files, and should say n here.
Brendan Higgins84bc8092019-09-23 02:02:36 -07002037
Andrey Konovalov5ff3b302020-06-04 16:46:04 -07002038config KCOV_IRQ_AREA_SIZE
2039 hex "Size of interrupt coverage collection area in words"
2040 depends on KCOV
2041 default 0x40000
2042 help
2043 KCOV uses preallocated per-cpu areas to collect coverage from
2044 soft interrupts. This specifies the size of those areas in the
2045 number of unsigned long words.
2046
Vincent Legolld3deafa2018-02-06 15:38:38 -08002047menuconfig RUNTIME_TESTING_MENU
2048 bool "Runtime Testing"
Anders Roxell908009e82018-02-21 14:46:05 -08002049 def_bool y
Vincent Legolld3deafa2018-02-06 15:38:38 -08002050
2051if RUNTIME_TESTING_MENU
Dave Hansen881c5142013-07-01 13:04:44 -07002052
2053config LKDTM
2054 tristate "Linux Kernel Dump Test Tool Module"
2055 depends on DEBUG_FS
Dave Hansen881c5142013-07-01 13:04:44 -07002056 help
2057 This module enables testing of the different dumping mechanisms by
2058 inducing system failures at predefined crash points.
2059 If you don't need it: say N
2060 Choose M here to compile this code as a module. The module will be
2061 called lkdtm.
2062
2063 Documentation on how to use the module can be found in
Mauro Carvalho Chehab10ffebb2019-06-12 14:52:44 -03002064 Documentation/fault-injection/provoke-crashes.rst
Dave Hansen881c5142013-07-01 13:04:44 -07002065
2066config TEST_LIST_SORT
Daniel Latypovebd09572021-05-03 13:58:35 -07002067 tristate "Linked list sorting test" if !KUNIT_ALL_TESTS
2068 depends on KUNIT
2069 default KUNIT_ALL_TESTS
Dave Hansen881c5142013-07-01 13:04:44 -07002070 help
2071 Enable this to turn on 'list_sort()' function test. This test is
Geert Uytterhoevene327fd72017-05-08 15:55:26 -07002072 executed only once during system boot (so affects only boot time),
2073 or at module load time.
Dave Hansen881c5142013-07-01 13:04:44 -07002074
2075 If unsure, say N.
2076
Ian Rogers6e246282020-02-13 23:51:29 -08002077config TEST_MIN_HEAP
2078 tristate "Min heap test"
2079 depends on DEBUG_KERNEL || m
2080 help
2081 Enable this to turn on min heap function tests. This test is
2082 executed only once during system boot (so affects only boot time),
2083 or at module load time.
2084
2085 If unsure, say N.
2086
Kostenzer Felixc5adae92017-02-24 15:01:07 -08002087config TEST_SORT
Geert Uytterhoeven5c4e6792017-05-08 15:55:23 -07002088 tristate "Array-based sort test"
2089 depends on DEBUG_KERNEL || m
Kostenzer Felixc5adae92017-02-24 15:01:07 -08002090 help
Geert Uytterhoeven5c4e6792017-05-08 15:55:23 -07002091 This option enables the self-test function of 'sort()' at boot,
2092 or at module load time.
Kostenzer Felixc5adae92017-02-24 15:01:07 -08002093
2094 If unsure, say N.
2095
Maciej W. Rozycki5086ea42021-04-20 04:50:28 +02002096config TEST_DIV64
2097 tristate "64bit/32bit division and modulo test"
2098 depends on DEBUG_KERNEL || m
2099 help
2100 Enable this to turn on 'do_div()' function test. This test is
2101 executed only once during system boot (so affects only boot time),
2102 or at module load time.
2103
2104 If unsure, say N.
2105
Dave Hansen881c5142013-07-01 13:04:44 -07002106config KPROBES_SANITY_TEST
2107 bool "Kprobes sanity tests"
2108 depends on DEBUG_KERNEL
2109 depends on KPROBES
Dave Hansen881c5142013-07-01 13:04:44 -07002110 help
2111 This option provides for testing basic kprobes functionality on
Masami Hiramatsu5a6cf772018-06-20 01:05:07 +09002112 boot. Samples of kprobe and kretprobe are inserted and
Dave Hansen881c5142013-07-01 13:04:44 -07002113 verified for functionality.
2114
2115 Say N if you are unsure.
2116
2117config BACKTRACE_SELF_TEST
2118 tristate "Self test for the backtrace code"
2119 depends on DEBUG_KERNEL
Dave Hansen881c5142013-07-01 13:04:44 -07002120 help
2121 This option provides a kernel module that can be used to test
2122 the kernel stack backtrace code. This option is not useful
2123 for distributions or general kernels, but only for kernel
2124 developers working on architecture code.
2125
2126 Note that if you want to also test saved backtraces, you will
2127 have to enable STACKTRACE as well.
2128
2129 Say N if you are unsure.
2130
Michel Lespinasse910a7422012-10-08 16:30:39 -07002131config RBTREE_TEST
2132 tristate "Red-Black tree test"
Cody P Schafer7c993e12013-09-11 14:25:19 -07002133 depends on DEBUG_KERNEL
Michel Lespinasse910a7422012-10-08 16:30:39 -07002134 help
2135 A benchmark measuring the performance of the rbtree library.
2136 Also includes rbtree invariant checks.
2137
Ferdinand Blomqvist4b4f3ac2019-06-20 17:10:33 +03002138config REED_SOLOMON_TEST
2139 tristate "Reed-Solomon library test"
2140 depends on DEBUG_KERNEL || m
2141 select REED_SOLOMON
2142 select REED_SOLOMON_ENC16
2143 select REED_SOLOMON_DEC16
2144 help
2145 This option enables the self-test function of rslib at boot,
2146 or at module load time.
2147
2148 If unsure, say N.
2149
Michel Lespinassefff3fd82012-10-08 16:31:23 -07002150config INTERVAL_TREE_TEST
2151 tristate "Interval tree test"
Davidlohr Bueso0f789b62017-07-10 15:51:43 -07002152 depends on DEBUG_KERNEL
Chris Wilsona88cc102014-03-17 12:21:54 +00002153 select INTERVAL_TREE
Michel Lespinassefff3fd82012-10-08 16:31:23 -07002154 help
2155 A benchmark measuring the performance of the interval tree library
2156
Greg Thelen623fd802013-11-12 15:08:34 -08002157config PERCPU_TEST
2158 tristate "Per cpu operations test"
2159 depends on m && DEBUG_KERNEL
2160 help
2161 Enable this option to build test module which validates per-cpu
2162 operations.
2163
2164 If unsure, say N.
2165
Dave Hansen881c5142013-07-01 13:04:44 -07002166config ATOMIC64_SELFTEST
Geert Uytterhoeven55ded952017-02-24 15:00:55 -08002167 tristate "Perform an atomic64_t self-test"
Dave Hansen881c5142013-07-01 13:04:44 -07002168 help
Geert Uytterhoeven55ded952017-02-24 15:00:55 -08002169 Enable this option to test the atomic64_t functions at boot or
2170 at module load time.
Dave Hansen881c5142013-07-01 13:04:44 -07002171
2172 If unsure, say N.
2173
2174config ASYNC_RAID6_TEST
2175 tristate "Self test for hardware accelerated raid6 recovery"
2176 depends on ASYNC_RAID6_RECOV
2177 select ASYNC_MEMCPY
Masahiro Yamadaa7f7f622020-06-14 01:50:22 +09002178 help
Dave Hansen881c5142013-07-01 13:04:44 -07002179 This is a one-shot self test that permutes through the
2180 recovery of all the possible two disk failure scenarios for a
2181 N-disk array. Recovery is performed with the asynchronous
2182 raid6 recovery routines, and will optionally use an offload
2183 engine if one is available.
2184
2185 If unsure, say N.
2186
Andy Shevchenko64d1d772015-02-12 15:02:21 -08002187config TEST_HEXDUMP
2188 tristate "Test functions located in the hexdump module at runtime"
2189
Matteo Croceb2ff70a2021-07-29 14:53:35 -07002190config STRING_SELFTEST
2191 tristate "Test string functions at runtime"
2192
Dave Hansen881c5142013-07-01 13:04:44 -07002193config TEST_STRING_HELPERS
2194 tristate "Test functions located in the string_helpers module at runtime"
2195
Tobin C. Harding0b0600c82019-04-05 12:58:59 +11002196config TEST_STRSCPY
2197 tristate "Test strscpy*() family of functions at runtime"
2198
Dave Hansen881c5142013-07-01 13:04:44 -07002199config TEST_KSTRTOX
2200 tristate "Test kstrto*() family of functions at runtime"
2201
Rasmus Villemoes707cc722015-11-06 16:30:29 -08002202config TEST_PRINTF
2203 tristate "Test printf() family of functions at runtime"
2204
Richard Fitzgerald50f530e2021-05-14 17:12:05 +01002205config TEST_SCANF
2206 tristate "Test scanf() family of functions at runtime"
2207
David Decotigny5fd003f2016-02-19 09:24:00 -05002208config TEST_BITMAP
2209 tristate "Test bitmap_*() family of functions at runtime"
David Decotigny5fd003f2016-02-19 09:24:00 -05002210 help
2211 Enable this option to test the bitmap functions at boot.
2212
2213 If unsure, say N.
2214
Andy Shevchenkocfaff0e2016-05-30 17:40:41 +03002215config TEST_UUID
2216 tristate "Test functions located in the uuid module at runtime"
2217
Matthew Wilcoxad3d6c72017-11-07 14:57:46 -05002218config TEST_XARRAY
2219 tristate "Test the XArray code at runtime"
2220
Rasmus Villemoes455a35a2018-05-08 00:36:28 +02002221config TEST_OVERFLOW
2222 tristate "Test check_*_overflow() functions at runtime"
2223
Thomas Graf7e1e7762014-08-02 11:47:44 +02002224config TEST_RHASHTABLE
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +01002225 tristate "Perform selftest on resizable hash table"
Thomas Graf7e1e7762014-08-02 11:47:44 +02002226 help
2227 Enable this option to test the rhashtable functions at boot.
2228
2229 If unsure, say N.
2230
George Spelvin468a9422016-05-26 22:11:51 -04002231config TEST_HASH
2232 tristate "Perform selftest on hash functions"
George Spelvin468a9422016-05-26 22:11:51 -04002233 help
Jason A. Donenfeld2c956a62017-01-08 13:54:00 +01002234 Enable this option to test the kernel's integer (<linux/hash.h>),
2235 string (<linux/stringhash.h>), and siphash (<linux/siphash.h>)
2236 hash functions on boot (or module load).
George Spelvin468a9422016-05-26 22:11:51 -04002237
2238 This is intended to help people writing architecture-specific
2239 optimized versions. If unsure, say N.
2240
Matthew Wilcox8ab8ba32018-06-18 16:59:29 -04002241config TEST_IDA
2242 tristate "Perform selftest on IDA functions"
2243
Jiri Pirko44091d22017-02-03 10:29:06 +01002244config TEST_PARMAN
2245 tristate "Perform selftest on priority array manager"
Jiri Pirko44091d22017-02-03 10:29:06 +01002246 depends on PARMAN
2247 help
2248 Enable this option to test priority array manager on boot
2249 (or module load).
2250
2251 If unsure, say N.
2252
Daniel Lezcano6aed82d2019-05-27 22:55:19 +02002253config TEST_IRQ_TIMINGS
2254 bool "IRQ timings selftest"
2255 depends on IRQ_TIMINGS
2256 help
2257 Enable this option to test the irq timings code on boot.
2258
2259 If unsure, say N.
2260
Valentin Rothberg8a6f0b42014-10-13 15:51:38 -07002261config TEST_LKM
Kees Cook93e9ef82014-01-23 15:54:37 -08002262 tristate "Test module loading with 'hello world' module"
Kees Cook93e9ef82014-01-23 15:54:37 -08002263 depends on m
2264 help
2265 This builds the "test_module" module that emits "Hello, world"
2266 on printk when loaded. It is designed to be used for basic
2267 evaluation of the module loading subsystem (for example when
2268 validating module verification). It lacks any extra dependencies,
2269 and will not normally be loaded by the system unless explicitly
2270 requested by name.
2271
2272 If unsure, say N.
2273
Jesse Brandeburgc348c162020-06-04 16:50:27 -07002274config TEST_BITOPS
Wei Yang6af132f2020-06-10 18:41:53 -07002275 tristate "Test module for compilation of bitops operations"
Jesse Brandeburgc348c162020-06-04 16:50:27 -07002276 depends on m
2277 help
2278 This builds the "test_bitops" module that is much like the
2279 TEST_LKM module except that it does a basic exercise of the
Wei Yang6af132f2020-06-10 18:41:53 -07002280 set/clear_bit macros and get_count_order/long to make sure there are
2281 no compiler warnings from C=1 sparse checker or -Wextra
2282 compilations. It has no dependencies and doesn't run or load unless
2283 explicitly requested by name. for example: modprobe test_bitops.
Jesse Brandeburgc348c162020-06-04 16:50:27 -07002284
2285 If unsure, say N.
2286
Uladzislau Rezki (Sony)3f21a6b2019-03-05 15:43:34 -08002287config TEST_VMALLOC
2288 tristate "Test module for stress/performance analysis of vmalloc allocator"
2289 default n
2290 depends on MMU
2291 depends on m
2292 help
2293 This builds the "test_vmalloc" module that should be used for
2294 stress and performance analysis. So, any new change for vmalloc
2295 subsystem can be evaluated from performance and stability point
2296 of view.
2297
2298 If unsure, say N.
2299
Kees Cook3e2a4c12014-01-23 15:54:38 -08002300config TEST_USER_COPY
2301 tristate "Test user/kernel boundary protections"
Kees Cook3e2a4c12014-01-23 15:54:38 -08002302 depends on m
2303 help
2304 This builds the "test_user_copy" module that runs sanity checks
2305 on the copy_to/from_user infrastructure, making sure basic
2306 user/kernel boundary testing is working. If it fails to load,
2307 a regression has been detected in the user/kernel memory boundary
2308 protections.
2309
2310 If unsure, say N.
2311
Alexei Starovoitov64a89462014-05-08 14:10:52 -07002312config TEST_BPF
2313 tristate "Test BPF filter functionality"
Randy Dunlap98920ba2014-05-13 09:58:44 -07002314 depends on m && NET
Alexei Starovoitov64a89462014-05-08 14:10:52 -07002315 help
2316 This builds the "test_bpf" module that runs various test vectors
2317 against the BPF interpreter or BPF JIT compiler depending on the
2318 current setting. This is in particular useful for BPF JIT compiler
2319 development, but also to run regression tests against changes in
Alexei Starovoitov3c731eb2014-09-26 00:17:07 -07002320 the interpreter code. It also enables test stubs for eBPF maps and
2321 verifier used by user space verifier testsuite.
Alexei Starovoitov64a89462014-05-08 14:10:52 -07002322
2323 If unsure, say N.
2324
Mahesh Bandewar509e56b2019-07-01 14:39:01 -07002325config TEST_BLACKHOLE_DEV
2326 tristate "Test blackhole netdev functionality"
2327 depends on m && NET
2328 help
2329 This builds the "test_blackhole_dev" module that validates the
2330 data path through this blackhole netdev.
2331
2332 If unsure, say N.
2333
Yury Norovdceeb3e2018-02-06 15:38:27 -08002334config FIND_BIT_BENCHMARK
Yury Norov4441fca2017-11-17 15:28:31 -08002335 tristate "Test find_bit functions"
Yury Norov4441fca2017-11-17 15:28:31 -08002336 help
2337 This builds the "test_find_bit" module that measure find_*_bit()
2338 functions performance.
2339
2340 If unsure, say N.
2341
Kees Cook0a8adf52014-07-14 14:38:12 -07002342config TEST_FIRMWARE
2343 tristate "Test firmware loading via userspace interface"
Kees Cook0a8adf52014-07-14 14:38:12 -07002344 depends on FW_LOADER
2345 help
2346 This builds the "test_firmware" module that creates a userspace
2347 interface for testing firmware loading. This can be used to
2348 control the triggering of firmware loading without needing an
2349 actual firmware-using device. The contents can be rechecked by
2350 userspace.
2351
2352 If unsure, say N.
2353
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -07002354config TEST_SYSCTL
2355 tristate "sysctl test driver"
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -07002356 depends on PROC_SYSCTL
2357 help
2358 This builds the "test_sysctl" module. This driver enables to test the
2359 proc sysctl interfaces available to drivers safely without affecting
2360 production knobs which might alter system functionality.
2361
2362 If unsure, say N.
2363
Vitor Massaru Ihad2585f52020-07-29 14:58:49 -03002364config BITFIELD_KUNIT
2365 tristate "KUnit test bitfield functions at runtime"
2366 depends on KUNIT
2367 help
2368 Enable this option to test the bitfield functions at boot.
2369
2370 KUnit tests run during boot and output the results to the debug log
2371 in TAP format (http://testanything.org/). Only useful for kernel devs
2372 running the KUnit test harness, and not intended for inclusion into a
2373 production build.
2374
2375 For more information on KUnit and unit tests in general please refer
2376 to the KUnit documentation in Documentation/dev-tools/kunit/.
2377
2378 If unsure, say N.
2379
Andy Shevchenko5df38ca2020-11-03 22:45:08 +02002380config RESOURCE_KUNIT_TEST
2381 tristate "KUnit test for resource API"
2382 depends on KUNIT
2383 help
2384 This builds the resource API unit test.
2385 Tests the logic of API provided by resource.c and ioport.h.
2386 For more information on KUnit and unit tests in general please refer
2387 to the KUnit documentation in Documentation/dev-tools/kunit/.
2388
2389 If unsure, say N.
2390
Iurii Zaikin2cb80db2019-09-23 02:02:47 -07002391config SYSCTL_KUNIT_TEST
Anders Roxell5f215aab2020-05-11 15:14:29 +02002392 tristate "KUnit test for sysctl" if !KUNIT_ALL_TESTS
Iurii Zaikin2cb80db2019-09-23 02:02:47 -07002393 depends on KUNIT
Anders Roxell5f215aab2020-05-11 15:14:29 +02002394 default KUNIT_ALL_TESTS
Iurii Zaikin2cb80db2019-09-23 02:02:47 -07002395 help
2396 This builds the proc sysctl unit test, which runs on boot.
2397 Tests the API contract and implementation correctness of sysctl.
2398 For more information on KUnit and unit tests in general please refer
2399 to the KUnit documentation in Documentation/dev-tools/kunit/.
2400
2401 If unsure, say N.
2402
David Gowea2dd7c2019-10-24 15:46:31 -07002403config LIST_KUNIT_TEST
Anders Roxell5f215aab2020-05-11 15:14:29 +02002404 tristate "KUnit Test for Kernel Linked-list structures" if !KUNIT_ALL_TESTS
David Gowea2dd7c2019-10-24 15:46:31 -07002405 depends on KUNIT
Anders Roxell5f215aab2020-05-11 15:14:29 +02002406 default KUNIT_ALL_TESTS
David Gowea2dd7c2019-10-24 15:46:31 -07002407 help
2408 This builds the linked list KUnit test suite.
2409 It tests that the API and basic functionality of the list_head type
2410 and associated macros.
2411
2412 KUnit tests run during boot and output the results to the debug log
Alexander A. Klimovd89775f2020-08-11 18:34:50 -07002413 in TAP format (https://testanything.org/). Only useful for kernel devs
David Gowea2dd7c2019-10-24 15:46:31 -07002414 running the KUnit test harness, and not intended for inclusion into a
2415 production build.
2416
2417 For more information on KUnit and unit tests in general please refer
2418 to the KUnit documentation in Documentation/dev-tools/kunit/.
2419
2420 If unsure, say N.
2421
Matti Vaittinen33d599f2020-05-08 18:40:43 +03002422config LINEAR_RANGES_TEST
2423 tristate "KUnit test for linear_ranges"
2424 depends on KUNIT
2425 select LINEAR_RANGES
2426 help
2427 This builds the linear_ranges unit test, which runs on boot.
2428 Tests the linear_ranges logic correctness.
2429 For more information on KUnit and unit tests in general please refer
2430 to the KUnit documentation in Documentation/dev-tools/kunit/.
2431
2432 If unsure, say N.
2433
Andy Shevchenko75468612020-12-15 20:43:34 -08002434config CMDLINE_KUNIT_TEST
2435 tristate "KUnit test for cmdline API"
2436 depends on KUNIT
2437 help
2438 This builds the cmdline API unit test.
2439 Tests the logic of API provided by cmdline.c.
2440 For more information on KUnit and unit tests in general please refer
2441 to the KUnit documentation in Documentation/dev-tools/kunit/.
2442
2443 If unsure, say N.
2444
Rikard Falkeborn6d511022020-08-11 18:35:03 -07002445config BITS_TEST
2446 tristate "KUnit test for bits.h"
2447 depends on KUNIT
2448 help
2449 This builds the bits unit test.
2450 Tests the logic of macros defined in bits.h.
2451 For more information on KUnit and unit tests in general please refer
2452 to the KUnit documentation in Documentation/dev-tools/kunit/.
2453
2454 If unsure, say N.
2455
Oliver Glitta1f9f78b2021-06-28 19:34:33 -07002456config SLUB_KUNIT_TEST
2457 tristate "KUnit test for SLUB cache error detection" if !KUNIT_ALL_TESTS
2458 depends on SLUB_DEBUG && KUNIT
2459 default KUNIT_ALL_TESTS
2460 help
2461 This builds SLUB allocator unit test.
2462 Tests SLUB cache debugging functionality.
2463 For more information on KUnit and unit tests in general please refer
2464 to the KUnit documentation in Documentation/dev-tools/kunit/.
2465
2466 If unsure, say N.
2467
Trent Piephob6c75c42021-06-30 18:55:52 -07002468config RATIONAL_KUNIT_TEST
2469 tristate "KUnit test for rational.c" if !KUNIT_ALL_TESTS
2470 depends on KUNIT
2471 select RATIONAL
2472 default KUNIT_ALL_TESTS
2473 help
2474 This builds the rational math unit test.
2475 For more information on KUnit and unit tests in general please refer
2476 to the KUnit documentation in Documentation/dev-tools/kunit/.
2477
2478 If unsure, say N.
2479
David Rileye704f932014-06-16 14:58:32 -07002480config TEST_UDELAY
2481 tristate "udelay test driver"
David Rileye704f932014-06-16 14:58:32 -07002482 help
2483 This builds the "udelay_test" module that helps to make sure
2484 that udelay() is working properly.
2485
2486 If unsure, say N.
2487
Ingo Molnar2bf9e0a2015-08-03 11:42:57 +02002488config TEST_STATIC_KEYS
2489 tristate "Test static keys"
Jason Baron579e1ac2015-07-30 03:59:44 +00002490 depends on m
2491 help
Ingo Molnar2bf9e0a2015-08-03 11:42:57 +02002492 Test the static key interfaces.
Jason Baron579e1ac2015-07-30 03:59:44 +00002493
2494 If unsure, say N.
2495
Luis R. Rodriguezd9c6a722017-07-14 14:50:08 -07002496config TEST_KMOD
2497 tristate "kmod stress tester"
Luis R. Rodriguezd9c6a722017-07-14 14:50:08 -07002498 depends on m
Luis R. Rodriguezd9c6a722017-07-14 14:50:08 -07002499 depends on NETDEVICES && NET_CORE && INET # for TUN
YueHaibingae3d6a32019-04-25 22:23:44 -07002500 depends on BLOCK
Luis R. Rodriguezd9c6a722017-07-14 14:50:08 -07002501 select TEST_LKM
2502 select XFS_FS
2503 select TUN
2504 select BTRFS_FS
2505 help
2506 Test the kernel's module loading mechanism: kmod. kmod implements
2507 support to load modules using the Linux kernel's usermode helper.
2508 This test provides a series of tests against kmod.
2509
2510 Although technically you can either build test_kmod as a module or
2511 into the kernel we disallow building it into the kernel since
2512 it stress tests request_module() and this will very likely cause
2513 some issues by taking over precious threads available from other
2514 module load requests, ultimately this could be fatal.
2515
2516 To run tests run:
2517
2518 tools/testing/selftests/kmod/kmod.sh --help
2519
2520 If unsure, say N.
2521
Florian Fainellie4dace32017-09-08 16:15:31 -07002522config TEST_DEBUG_VIRTUAL
2523 tristate "Test CONFIG_DEBUG_VIRTUAL feature"
2524 depends on DEBUG_VIRTUAL
2525 help
2526 Test the kernel's ability to detect incorrect calls to
2527 virt_to_phys() done against the non-linear part of the
2528 kernel's virtual address map.
2529
2530 If unsure, say N.
2531
Alexander Shishkince76d932018-10-05 15:43:05 +03002532config TEST_MEMCAT_P
2533 tristate "Test memcat_p() helper function"
2534 help
2535 Test the memcat_p() helper for correctly merging two
2536 pointer arrays together.
2537
2538 If unsure, say N.
2539
Joe Lawrencea2818ee2019-01-09 13:43:29 +01002540config TEST_LIVEPATCH
2541 tristate "Test livepatching"
2542 default n
Joe Lawrencebae05432019-01-31 11:41:24 -05002543 depends on DYNAMIC_DEBUG
Joe Lawrencea2818ee2019-01-09 13:43:29 +01002544 depends on LIVEPATCH
2545 depends on m
2546 help
2547 Test kernel livepatching features for correctness. The tests will
2548 load test modules that will be livepatched in various scenarios.
2549
2550 To run all the livepatching tests:
2551
2552 make -C tools/testing/selftests TARGETS=livepatch run_tests
2553
2554 Alternatively, individual tests may be invoked:
2555
2556 tools/testing/selftests/livepatch/test-callbacks.sh
2557 tools/testing/selftests/livepatch/test-livepatch.sh
2558 tools/testing/selftests/livepatch/test-shadow-vars.sh
2559
2560 If unsure, say N.
2561
Jiri Pirko0a020d42018-11-14 08:22:28 +00002562config TEST_OBJAGG
2563 tristate "Perform selftest on object aggreration manager"
2564 default n
2565 depends on OBJAGG
2566 help
2567 Enable this option to test object aggregation manager on boot
2568 (or module load).
2569
Jiri Pirko0a020d42018-11-14 08:22:28 +00002570
Kees Cook50ceaa95e2019-01-23 12:24:32 -07002571config TEST_STACKINIT
2572 tristate "Test level of stack variable initialization"
2573 help
2574 Test if the kernel is zero-initializing stack variables and
2575 padding. Coverage is controlled by compiler flags,
2576 CONFIG_GCC_PLUGIN_STRUCTLEAK, CONFIG_GCC_PLUGIN_STRUCTLEAK_BYREF,
2577 or CONFIG_GCC_PLUGIN_STRUCTLEAK_BYREF_ALL.
2578
2579 If unsure, say N.
2580
Alexander Potapenko5015a302019-07-16 16:27:27 -07002581config TEST_MEMINIT
2582 tristate "Test heap/page initialization"
2583 help
2584 Test if the kernel is zero-initializing heap and page allocations.
2585 This can be useful to test init_on_alloc and init_on_free features.
2586
2587 If unsure, say N.
2588
Ralph Campbellb2ef9f52020-04-22 12:50:26 -07002589config TEST_HMM
2590 tristate "Test HMM (Heterogeneous Memory Management)"
2591 depends on TRANSPARENT_HUGEPAGE
2592 depends on DEVICE_PRIVATE
2593 select HMM_MIRROR
2594 select MMU_NOTIFIER
2595 help
2596 This is a pseudo device driver solely for testing HMM.
2597 Say M here if you want to build the HMM test module.
2598 Doing so will allow you to run tools/testing/selftest/vm/hmm-tests.
2599
2600 If unsure, say N.
2601
Matthew Wilcox (Oracle)e320d302020-10-13 16:56:04 -07002602config TEST_FREE_PAGES
2603 tristate "Test freeing pages"
2604 help
2605 Test that a memory leak does not occur due to a race between
2606 freeing a block of pages and a speculative page reference.
2607 Loading this module is safe if your kernel has the bug fixed.
2608 If the bug is not fixed, it will leak gigabytes of memory and
2609 probably OOM your system.
2610
Petteri Aimonen4185b3b2020-06-18 16:37:37 +02002611config TEST_FPU
2612 tristate "Test floating point operations in kernel space"
2613 depends on X86 && !KCOV_INSTRUMENT_ALL
2614 help
2615 Enable this option to add /sys/kernel/debug/selftest_helpers/test_fpu
2616 which will trigger a sequence of floating point operations. This is used
2617 for self-testing floating point control register setting in
2618 kernel_fpu_begin().
2619
2620 If unsure, say N.
2621
Paul E. McKenney1253b9b2021-05-27 12:01:23 -07002622config TEST_CLOCKSOURCE_WATCHDOG
2623 tristate "Test clocksource watchdog in kernel space"
2624 depends on CLOCKSOURCE_WATCHDOG
2625 help
2626 Enable this option to create a kernel module that will trigger
2627 a test of the clocksource watchdog. This module may be loaded
2628 via modprobe or insmod in which case it will run upon being
2629 loaded, or it may be built in, in which case it will run
2630 shortly after boot.
2631
2632 If unsure, say N.
2633
Vincent Legolld3deafa2018-02-06 15:38:38 -08002634endif # RUNTIME_TESTING_MENU
Randy Dunlapcc3fa842017-10-13 15:57:33 -07002635
Anshuman Khandualdce44562021-04-29 22:55:15 -07002636config ARCH_USE_MEMTEST
2637 bool
2638 help
2639 An architecture should select this when it uses early_memtest()
2640 during boot process.
2641
Randy Dunlapcc3fa842017-10-13 15:57:33 -07002642config MEMTEST
2643 bool "Memtest"
Anshuman Khandualdce44562021-04-29 22:55:15 -07002644 depends on ARCH_USE_MEMTEST
Masahiro Yamadaa7f7f622020-06-14 01:50:22 +09002645 help
Randy Dunlapcc3fa842017-10-13 15:57:33 -07002646 This option adds a kernel parameter 'memtest', which allows memtest
Anshuman Khandualdce44562021-04-29 22:55:15 -07002647 to be set and executed.
Randy Dunlapcc3fa842017-10-13 15:57:33 -07002648 memtest=0, mean disabled; -- default
2649 memtest=1, mean do 1 test pattern;
2650 ...
2651 memtest=17, mean do 17 test patterns.
2652 If you are unsure how to answer this question, answer N.
2653
Randy Dunlapcc3fa842017-10-13 15:57:33 -07002654
Christoph Hellwig06ec64b2018-07-31 13:39:31 +02002655
Branden Bonabyaf9ca6f2019-10-03 17:01:49 -04002656config HYPERV_TESTING
2657 bool "Microsoft Hyper-V driver testing"
2658 default n
2659 depends on HYPERV && DEBUG_FS
2660 help
2661 Select this option to enable Hyper-V vmbus testing.
2662
Changbin Du045f6d72019-12-17 20:51:56 -08002663endmenu # "Kernel Testing and Coverage"
2664
Mauro Carvalho Chehab75442fb2020-10-30 08:40:45 +01002665source "Documentation/Kconfig"
2666
Christoph Hellwig06ec64b2018-07-31 13:39:31 +02002667endmenu # Kernel hacking