Merge tag 'net-next-5.18' of git://git.kernel.org/pub/scm/linux/kernel/git/netdev...
[linux-block.git] / lib / Kconfig.debug
CommitLineData
ec8f24b7 1# SPDX-License-Identifier: GPL-2.0-only
06ec64b8
CH
2menu "Kernel hacking"
3
604ff0dc 4menu "printk and dmesg options"
1da177e4
LT
5
6config PRINTK_TIME
7 bool "Show timing information on printks"
d3b8b6e5 8 depends on PRINTK
1da177e4 9 help
649e6ee3
KS
10 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
8c27ceff 19 parameter printk.time=1. See Documentation/admin-guide/kernel-parameters.rst
1da177e4 20
15ff2069
TH
21config 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
22f4e66d
SB
38config 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
a8cfdc68
OJ
49config 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
50f4d9bd 60 Note: This does not affect the log level of un-prefixed printk()
a8cfdc68
OJ
61 usage in the kernel. That is controlled by the MESSAGE_LOGLEVEL_DEFAULT
62 option.
63
22eceb8b
HG
64config 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
42a9dc0b 75config MESSAGE_LOGLEVEL_DEFAULT
5af5bcb8
MSB
76 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
a8cfdc68
OJ
86 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
604ff0dc
DH
90config 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
239a5791 112 depends on (DEBUG_FS || PROC_FS)
ceabef7d 113 select DYNAMIC_DEBUG_CORE
604ff0dc
DH
114 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,
239a5791
GKH
131 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.
604ff0dc
DH
134 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
68d4b3df
KK
144 flags : '=p' means the line is turned 'on' for printing
145 format : the format used for the debug statement
604ff0dc
DH
146
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
f8998c22
HH
177 See Documentation/admin-guide/dynamic-debug-howto.rst for additional
178 information.
604ff0dc 179
ceabef7d
OZ
180config 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
57f5677e
RV
191config 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
2b05bb75
CD
200config 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
604ff0dc
DH
209endmenu # "printk and dmesg options"
210
6dfc0665
DH
211menu "Compile-time checks and compiler options"
212
213config DEBUG_INFO
214 bool "Compile the kernel with debug info"
12b13835 215 depends on DEBUG_KERNEL && !COMPILE_TEST
6dfc0665 216 help
68d4b3df 217 If you say Y here the resulting kernel image will include
6dfc0665
DH
218 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
695afd3d
SD
226if DEBUG_INFO
227
6dfc0665
DH
228config DEBUG_INFO_REDUCED
229 bool "Reduce debugging information"
6dfc0665
DH
230 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
10e68b02
ND
240config DEBUG_INFO_COMPRESSED
241 bool "Compressed debugging information"
10e68b02 242 depends on $(cc-option,-gz=zlib)
10e68b02
ND
243 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
866ced95
AK
255config DEBUG_INFO_SPLIT
256 bool "Produce split debuginfo in .dwo files"
9d937444 257 depends on $(cc-option,-gsplit-dwarf)
866ced95
AK
258 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
a66049e2
ND
270choice
271 prompt "DWARF version"
272 help
273 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
bfaf2dd3 287config DEBUG_INFO_DWARF4
a66049e2 288 bool "Generate DWARF Version 4 debuginfo"
bfaf2dd3 289 help
a66049e2
ND
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
98cd6f52
ND
296config DEBUG_INFO_DWARF5
297 bool "Generate DWARF Version 5 debuginfo"
c0a5c81c 298 depends on !CC_IS_CLANG || (CC_IS_CLANG && (AS_IS_LLVM || (AS_IS_GNU && AS_VERSION >= 23502)))
42d9b379 299 depends on !DEBUG_INFO_BTF || PAHOLE_VERSION >= 121
bfaf2dd3 300 help
98cd6f52
ND
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
a66049e2 313endchoice # "DWARF version"
bfaf2dd3 314
e83b9f55
AN
315config DEBUG_INFO_BTF
316 bool "Generate BTF typeinfo"
7d32e693
SB
317 depends on !DEBUG_INFO_SPLIT && !DEBUG_INFO_REDUCED
318 depends on !GCC_PLUGIN_RANDSTRUCT || COMPILE_TEST
d9847eb8 319 depends on BPF_SYSCALL
e83b9f55
AN
320 help
321 Generate deduplicated BTF type information from DWARF debug info.
322 Turning this on expects presence of pahole tool, which will convert
323 DWARF type info into equivalent deduplicated BTF type info.
324
5f9ae91f 325config PAHOLE_HAS_SPLIT_BTF
6323c813 326 def_bool PAHOLE_VERSION >= 119
5f9ae91f 327
7472d5a6 328config PAHOLE_HAS_BTF_TAG
6323c813 329 def_bool PAHOLE_VERSION >= 123
7472d5a6
YS
330 depends on CC_IS_CLANG
331 help
332 Decide whether pahole emits btf_tag attributes (btf_type_tag and
333 btf_decl_tag) or not. Currently only clang compiler implements
334 these attributes, so make the config depend on CC_IS_CLANG.
5f9ae91f
AN
335
336config DEBUG_INFO_BTF_MODULES
337 def_bool y
338 depends on DEBUG_INFO_BTF && MODULES && PAHOLE_HAS_SPLIT_BTF
339 help
340 Generate compact split BTF type information for kernel modules.
341
5e214f2e
CB
342config MODULE_ALLOW_BTF_MISMATCH
343 bool "Allow loading modules with non-matching BTF type info"
344 depends on DEBUG_INFO_BTF_MODULES
345 help
346 For modules whose split BTF does not match vmlinux, load without
347 BTF rather than refusing to load. The default behavior with
348 module BTF enabled is to reject modules with such mismatches;
349 this option will still load module BTF where possible but ignore
350 it when a mismatch is found.
351
3ee7b3fa
JK
352config GDB_SCRIPTS
353 bool "Provide GDB scripts for kernel debugging"
3ee7b3fa
JK
354 help
355 This creates the required links to GDB helper scripts in the
356 build directory. If you load vmlinux into gdb, the helper
357 scripts will be automatically imported by gdb as well, and
358 additional functions are available to analyze a Linux kernel
700199b0
AP
359 instance. See Documentation/dev-tools/gdb-kernel-debugging.rst
360 for further details.
3ee7b3fa 361
695afd3d
SD
362endif # DEBUG_INFO
363
35bb5b1e 364config FRAME_WARN
a83e4ca2 365 int "Warn for stack frames larger than"
35bb5b1e 366 range 0 8192
0e07f663 367 default 2048 if GCC_PLUGIN_LATENT_ENTROPY
8d192bec
HD
368 default 2048 if PARISC
369 default 1536 if (!64BIT && XTENSA)
370 default 1024 if !64BIT
35bb5b1e
AK
371 default 2048 if 64BIT
372 help
373 Tell gcc to warn at build time for stack frames larger than this.
374 Setting this too low will cause a lot of warnings.
375 Setting it to 0 disables the warning.
35bb5b1e 376
99657c78
RD
377config STRIP_ASM_SYMS
378 bool "Strip assembler-generated symbols during link"
379 default n
380 help
381 Strip internal assembler-generated symbols during a link (symbols
382 that look like '.Lxxx') so they don't pollute the output of
383 get_wchan() and suchlike.
384
1873e870 385config READABLE_ASM
68d4b3df
KK
386 bool "Generate readable assembler code"
387 depends on DEBUG_KERNEL
7d73c3e9 388 depends on CC_IS_GCC
bf4735a4 389 help
68d4b3df
KK
390 Disable some compiler optimizations that tend to generate human unreadable
391 assembler output. This may make the kernel slightly slower, but it helps
392 to keep kernel developers who have to stare a lot at assembler listings
393 sane.
bf4735a4 394
e949f4c2
MY
395config HEADERS_INSTALL
396 bool "Install uapi headers to usr/include"
bf4735a4
DM
397 depends on !UML
398 help
e949f4c2
MY
399 This option will install uapi headers (headers exported to user-space)
400 into the usr/include directory for use during the kernel build.
401 This is unneeded for building the kernel itself, but needed for some
402 user-space program samples. It is also needed by some features such
403 as uapi header sanity checks.
404
91341d4b
SR
405config DEBUG_SECTION_MISMATCH
406 bool "Enable full Section mismatch analysis"
7d73c3e9 407 depends on CC_IS_GCC
91341d4b
SR
408 help
409 The section mismatch analysis checks if there are illegal
410 references from one section to another section.
e809ab01
MW
411 During linktime or runtime, some sections are dropped;
412 any use of code/data previously in these sections would
91341d4b 413 most likely result in an oops.
e809ab01 414 In the code, functions and variables are annotated with
0db0628d 415 __init,, etc. (see the full list in include/linux/init.h),
d6fbfa4f 416 which results in the code/data being placed in specific sections.
e809ab01
MW
417 The section mismatch analysis is always performed after a full
418 kernel build, and enabling this option causes the following
b7dca6dd 419 additional step to occur:
e809ab01
MW
420 - Add the option -fno-inline-functions-called-once to gcc commands.
421 When inlining a function annotated with __init in a non-init
422 function, we would lose the section information and thus
91341d4b 423 the analysis would not catch the illegal reference.
e809ab01
MW
424 This option tells gcc to inline less (but it does result in
425 a larger kernel).
91341d4b 426
47490ec1
NB
427config SECTION_MISMATCH_WARN_ONLY
428 bool "Make section mismatch errors non-fatal"
429 default y
430 help
431 If you say N here, the build process will fail if there are any
432 section mismatch, instead of just throwing warnings.
433
434 If unsure, say Y.
435
cf536e18
FT
436config DEBUG_FORCE_FUNCTION_ALIGN_64B
437 bool "Force all function address 64B aligned" if EXPERT
09c60546
FT
438 help
439 There are cases that a commit from one domain changes the function
440 address alignment of other domains, and cause magic performance
441 bump (regression or improvement). Enable this option will help to
442 verify if the bump is caused by function alignment changes, while
443 it will slightly increase the kernel size and affect icache usage.
444
445 It is mainly for debug and performance tuning use.
446
6dfc0665
DH
447#
448# Select this config option from the architecture Kconfig, if it
449# is preferred to always offer frame pointers as a config
450# option on the architecture (regardless of KERNEL_DEBUG):
451#
452config ARCH_WANT_FRAME_POINTERS
453 bool
f346f4b3 454
6dfc0665
DH
455config FRAME_POINTER
456 bool "Compile the kernel with frame pointers"
a687a533 457 depends on DEBUG_KERNEL && (M68K || UML || SUPERH) || ARCH_WANT_FRAME_POINTERS
6dfc0665 458 default y if (DEBUG_INFO && UML) || ARCH_WANT_FRAME_POINTERS
a304e1b8 459 help
6dfc0665
DH
460 If you say Y here the resulting kernel image will be slightly
461 larger and slower, but it gives very useful debugging information
462 in case of kernel bugs. (precise oopses/stacktraces/warnings)
a304e1b8 463
b9ab5ebb
JP
464config STACK_VALIDATION
465 bool "Compile-time stack metadata validation"
466 depends on HAVE_STACK_VALIDATION
467 default n
468 help
469 Add compile-time checks to validate stack metadata, including frame
470 pointers (if CONFIG_FRAME_POINTER is enabled). This helps ensure
471 that runtime stack traces are more reliable.
472
ee9f8fce 473 This is also a prerequisite for generation of ORC unwind data, which
11af8474 474 is needed for CONFIG_UNWINDER_ORC.
ee9f8fce 475
b9ab5ebb
JP
476 For more information, see
477 tools/objtool/Documentation/stack-validation.txt.
478
6804c1af
PZ
479config VMLINUX_VALIDATION
480 bool
db2b0c5d 481 depends on STACK_VALIDATION && DEBUG_ENTRY
6804c1af
PZ
482 default y
483
5cc12472
RV
484config VMLINUX_MAP
485 bool "Generate vmlinux.map file when linking"
486 depends on EXPERT
487 help
488 Selecting this option will pass "-Map=vmlinux.map" to ld
489 when linking vmlinux. That file can be useful for verifying
490 and debugging magic section games, and for seeing which
491 pieces of code get eliminated with
492 CONFIG_LD_DEAD_CODE_DATA_ELIMINATION.
493
6dfc0665
DH
494config DEBUG_FORCE_WEAK_PER_CPU
495 bool "Force weak per-cpu definitions"
496 depends on DEBUG_KERNEL
8446f1d3 497 help
6dfc0665
DH
498 s390 and alpha require percpu variables in modules to be
499 defined weak to work around addressing range issue which
500 puts the following two restrictions on percpu variable
501 definitions.
8446f1d3 502
6dfc0665
DH
503 1. percpu symbols must be unique whether static or not
504 2. percpu variables can't be defined inside a function
8446f1d3 505
6dfc0665
DH
506 To ensure that generic code follows the above rules, this
507 option forces all percpu variables to be defined as weak.
5f329089 508
6dfc0665 509endmenu # "Compiler options"
8446f1d3 510
6210b640
CD
511menu "Generic Kernel Debugging Instruments"
512
6dfc0665
DH
513config MAGIC_SYSRQ
514 bool "Magic SysRq key"
515 depends on !UML
516 help
517 If you say Y here, you will have some control over the system even
518 if the system crashes for example during kernel debugging (e.g., you
519 will be able to flush the buffer cache to disk, reboot the system
520 immediately or dump some status information). This is accomplished
521 by pressing various keys while holding SysRq (Alt+PrintScreen). It
522 also works on a serial console (on PC hardware at least), if you
523 send a BREAK and then within 5 seconds a command keypress. The
f8998c22
HH
524 keys are documented in <file:Documentation/admin-guide/sysrq.rst>.
525 Don't say Y unless you really know what this hack does.
8446f1d3 526
8eaede49
BH
527config MAGIC_SYSRQ_DEFAULT_ENABLE
528 hex "Enable magic SysRq key functions by default"
529 depends on MAGIC_SYSRQ
530 default 0x1
531 help
532 Specifies which SysRq key functions are enabled by default.
533 This may be set to 1 or 0 to enable or disable them all, or
f8998c22 534 to a bitmask as described in Documentation/admin-guide/sysrq.rst.
8eaede49 535
732dbf3a
FF
536config MAGIC_SYSRQ_SERIAL
537 bool "Enable magic SysRq key over serial"
538 depends on MAGIC_SYSRQ
539 default y
540 help
541 Many embedded boards have a disconnected TTL level serial which can
542 generate some garbage that can lead to spurious false sysrq detects.
543 This option allows you to decide whether you want to enable the
544 magic SysRq key.
545
68af4317
DS
546config MAGIC_SYSRQ_SERIAL_SEQUENCE
547 string "Char sequence that enables magic SysRq over serial"
548 depends on MAGIC_SYSRQ_SERIAL
549 default ""
550 help
551 Specifies a sequence of characters that can follow BREAK to enable
552 SysRq on a serial console.
553
d3394b3d
DS
554 If unsure, leave an empty string and the option will not be enabled.
555
ec29a5c1
CD
556config DEBUG_FS
557 bool "Debug Filesystem"
558 help
559 debugfs is a virtual file system that kernel developers use to put
560 debugging files into. Enable this option to be able to read and
561 write to these files.
562
563 For detailed documentation on the debugfs API, see
564 Documentation/filesystems/.
565
566 If unsure, say N.
567
a24c6f7b
PE
568choice
569 prompt "Debugfs default access"
570 depends on DEBUG_FS
571 default DEBUG_FS_ALLOW_ALL
572 help
573 This selects the default access restrictions for debugfs.
574 It can be overridden with kernel command line option
575 debugfs=[on,no-mount,off]. The restrictions apply for API access
576 and filesystem registration.
577
578config DEBUG_FS_ALLOW_ALL
579 bool "Access normal"
580 help
581 No restrictions apply. Both API and filesystem registration
582 is on. This is the normal default operation.
583
584config DEBUG_FS_DISALLOW_MOUNT
585 bool "Do not register debugfs as filesystem"
586 help
587 The API is open but filesystem is not loaded. Clients can still do
588 their work and read with debug tools that do not need
589 debugfs filesystem.
590
591config DEBUG_FS_ALLOW_NONE
592 bool "No access"
593 help
594 Access is off. Clients get -PERM when trying to create nodes in
595 debugfs tree and debugfs is not registered as a filesystem.
596 Client can then back-off or continue without debugfs access.
597
598endchoice
599
6210b640 600source "lib/Kconfig.kgdb"
6210b640 601source "lib/Kconfig.ubsan"
2645d432 602source "lib/Kconfig.kcsan"
6210b640
CD
603
604endmenu
605
f346f4b3
AB
606config DEBUG_KERNEL
607 bool "Kernel debugging"
fef2c9bc 608 help
f346f4b3
AB
609 Say Y here if you are developing drivers or trying to debug and
610 identify kernel problems.
fef2c9bc 611
c66d7a27
SK
612config DEBUG_MISC
613 bool "Miscellaneous debug code"
614 default DEBUG_KERNEL
615 depends on DEBUG_KERNEL
616 help
617 Say Y here if you need to enable miscellaneous debug code that should
618 be under a more specific debug option but isn't.
619
4d92b95f
ED
620menu "Networking Debugging"
621
622source "net/Kconfig.debug"
623
624endmenu # "Networking Debugging"
c66d7a27 625
0610c8a8 626menu "Memory Debugging"
fef2c9bc 627
8636a1f9 628source "mm/Kconfig.debug"
fef2c9bc 629
0610c8a8
DH
630config DEBUG_OBJECTS
631 bool "Debug object operations"
632 depends on DEBUG_KERNEL
9c44bc03 633 help
0610c8a8
DH
634 If you say Y here, additional code will be inserted into the
635 kernel to track the life time of various objects and validate
636 the operations on those objects.
9c44bc03 637
0610c8a8
DH
638config DEBUG_OBJECTS_SELFTEST
639 bool "Debug objects selftest"
640 depends on DEBUG_OBJECTS
641 help
642 This enables the selftest of the object debug code.
9c44bc03 643
0610c8a8
DH
644config DEBUG_OBJECTS_FREE
645 bool "Debug objects in freed memory"
646 depends on DEBUG_OBJECTS
647 help
648 This enables checks whether a k/v free operation frees an area
649 which contains an object which has not been deactivated
650 properly. This can make kmalloc/kfree-intensive workloads
651 much slower.
3ac7fe5a 652
c6f3a97f
TG
653config DEBUG_OBJECTS_TIMERS
654 bool "Debug timer objects"
655 depends on DEBUG_OBJECTS
656 help
657 If you say Y here, additional code will be inserted into the
658 timer routines to track the life time of timer objects and
659 validate the timer operations.
660
dc186ad7
TG
661config DEBUG_OBJECTS_WORK
662 bool "Debug work objects"
663 depends on DEBUG_OBJECTS
664 help
665 If you say Y here, additional code will be inserted into the
666 work queue routines to track the life time of work objects and
667 validate the work operations.
668
551d55a9
MD
669config DEBUG_OBJECTS_RCU_HEAD
670 bool "Debug RCU callbacks objects"
fc2ecf7e 671 depends on DEBUG_OBJECTS
551d55a9
MD
672 help
673 Enable this to turn on debugging of RCU list heads (call_rcu() usage).
674
e2852ae8
TH
675config DEBUG_OBJECTS_PERCPU_COUNTER
676 bool "Debug percpu counter objects"
677 depends on DEBUG_OBJECTS
678 help
679 If you say Y here, additional code will be inserted into the
680 percpu counter routines to track the life time of percpu counter
681 objects and validate the percpu counter operations.
682
3ae70205
IM
683config DEBUG_OBJECTS_ENABLE_DEFAULT
684 int "debug_objects bootup default value (0-1)"
68d4b3df
KK
685 range 0 1
686 default "1"
687 depends on DEBUG_OBJECTS
688 help
689 Debug objects boot parameter default value
3ae70205 690
1da177e4 691config DEBUG_SLAB
4a2f0acf 692 bool "Debug slab memory allocations"
4675ff05 693 depends on DEBUG_KERNEL && SLAB
1da177e4
LT
694 help
695 Say Y here to have the kernel do limited verification on memory
696 allocation as well as poisoning memory on free to catch use of freed
697 memory. This can make kmalloc/kfree-intensive workloads much slower.
698
f0630fff
CL
699config SLUB_DEBUG_ON
700 bool "SLUB debugging on by default"
4675ff05 701 depends on SLUB && SLUB_DEBUG
f0630fff
CL
702 default n
703 help
704 Boot with debugging on by default. SLUB boots by default with
705 the runtime debug capabilities switched off. Enabling this is
706 equivalent to specifying the "slub_debug" parameter on boot.
707 There is no support for more fine grained debug control like
708 possible with slub_debug=xxx. SLUB debugging may be switched
709 off in a kernel built with CONFIG_SLUB_DEBUG_ON by specifying
710 "slub_debug=-".
711
8ff12cfc
CL
712config SLUB_STATS
713 default n
714 bool "Enable SLUB performance statistics"
ab4d5ed5 715 depends on SLUB && SYSFS
8ff12cfc
CL
716 help
717 SLUB statistics are useful to debug SLUBs allocation behavior in
718 order find ways to optimize the allocator. This should never be
719 enabled for production use since keeping statistics slows down
720 the allocator by a few percentage points. The slabinfo command
721 supports the determination of the most active slabs to figure
722 out which slabs are relevant to a particular load.
723 Try running: slabinfo -DA
724
b69ec42b
CM
725config HAVE_DEBUG_KMEMLEAK
726 bool
727
3bba00d7
CM
728config DEBUG_KMEMLEAK
729 bool "Kernel memory leak detector"
525c1f92 730 depends on DEBUG_KERNEL && HAVE_DEBUG_KMEMLEAK
79e0d9bd 731 select DEBUG_FS
3bba00d7
CM
732 select STACKTRACE if STACKTRACE_SUPPORT
733 select KALLSYMS
b60e26a2 734 select CRC32
3bba00d7
CM
735 help
736 Say Y here if you want to enable the memory leak
737 detector. The memory allocation/freeing is traced in a way
738 similar to the Boehm's conservative garbage collector, the
739 difference being that the orphan objects are not freed but
740 only shown in /sys/kernel/debug/kmemleak. Enabling this
741 feature will introduce an overhead to memory
700199b0 742 allocations. See Documentation/dev-tools/kmemleak.rst for more
3bba00d7
CM
743 details.
744
0610c8a8
DH
745 Enabling DEBUG_SLAB or SLUB_DEBUG may increase the chances
746 of finding leaks due to the slab objects poisoning.
747
748 In order to access the kmemleak file, debugfs needs to be
749 mounted (usually at /sys/kernel/debug).
750
c5665868
CM
751config DEBUG_KMEMLEAK_MEM_POOL_SIZE
752 int "Kmemleak memory pool size"
0610c8a8 753 depends on DEBUG_KMEMLEAK
c59180ae 754 range 200 1000000
b751c52b 755 default 16000
0610c8a8
DH
756 help
757 Kmemleak must track all the memory allocations to avoid
758 reporting false positives. Since memory may be allocated or
c5665868
CM
759 freed before kmemleak is fully initialised, use a static pool
760 of metadata objects to track such callbacks. After kmemleak is
761 fully initialised, this memory pool acts as an emergency one
762 if slab allocations fail.
0610c8a8
DH
763
764config DEBUG_KMEMLEAK_TEST
765 tristate "Simple test for the kernel memory leak detector"
766 depends on DEBUG_KMEMLEAK && m
767 help
768 This option enables a module that explicitly leaks memory.
769
770 If unsure, say N.
771
772config DEBUG_KMEMLEAK_DEFAULT_OFF
773 bool "Default kmemleak to off"
774 depends on DEBUG_KMEMLEAK
775 help
776 Say Y here to disable kmemleak by default. It can then be enabled
777 on the command line via kmemleak=on.
778
d53ce042
SK
779config DEBUG_KMEMLEAK_AUTO_SCAN
780 bool "Enable kmemleak auto scan thread on boot up"
781 default y
782 depends on DEBUG_KMEMLEAK
783 help
784 Depending on the cpu, kmemleak scan may be cpu intensive and can
785 stall user tasks at times. This option enables/disables automatic
786 kmemleak scan at boot up.
787
788 Say N here to disable kmemleak auto scan thread to stop automatic
789 scanning. Disabling this option disables automatic reporting of
790 memory leaks.
791
792 If unsure, say Y.
793
0610c8a8
DH
794config DEBUG_STACK_USAGE
795 bool "Stack utilization instrumentation"
6c31da34 796 depends on DEBUG_KERNEL && !IA64
0610c8a8
DH
797 help
798 Enables the display of the minimum amount of free stack which each
799 task has ever had available in the sysrq-T and sysrq-P debug output.
800
801 This option will slow down process creation somewhat.
802
dc9b9638
CD
803config SCHED_STACK_END_CHECK
804 bool "Detect stack corruption on calls to schedule()"
805 depends on DEBUG_KERNEL
806 default n
807 help
808 This option checks for a stack overrun on calls to schedule().
809 If the stack end location is found to be over written always panic as
810 the content of the corrupted region can no longer be trusted.
811 This is to ensure no erroneous behaviour occurs which could result in
812 data corruption or a sporadic crash at a later stage once the region
813 is examined. The runtime overhead introduced is minimal.
814
399145f9
AK
815config ARCH_HAS_DEBUG_VM_PGTABLE
816 bool
817 help
818 An architecture should select this when it can successfully
819 build and run DEBUG_VM_PGTABLE.
820
0610c8a8
DH
821config DEBUG_VM
822 bool "Debug VM"
823 depends on DEBUG_KERNEL
824 help
825 Enable this to turn on extended checks in the virtual-memory system
68d4b3df 826 that may impact performance.
0610c8a8
DH
827
828 If unsure, say N.
829
4f115147
DB
830config DEBUG_VM_VMACACHE
831 bool "Debug VMA caching"
832 depends on DEBUG_VM
833 help
834 Enable this to turn on VMA caching debug information. Doing so
835 can cause significant overhead, so only enable it in non-production
836 environments.
837
838 If unsure, say N.
839
0610c8a8
DH
840config DEBUG_VM_RB
841 bool "Debug VM red-black trees"
842 depends on DEBUG_VM
843 help
a663dad6 844 Enable VM red-black tree debugging information and extra validations.
0610c8a8
DH
845
846 If unsure, say N.
847
95ad9755
KS
848config DEBUG_VM_PGFLAGS
849 bool "Debug page-flags operations"
850 depends on DEBUG_VM
851 help
852 Enables extra validation on page flags operations.
853
854 If unsure, say N.
855
399145f9
AK
856config DEBUG_VM_PGTABLE
857 bool "Debug arch page table for semantics compliance"
858 depends on MMU
859 depends on ARCH_HAS_DEBUG_VM_PGTABLE
860 default y if DEBUG_VM
861 help
862 This option provides a debug method which can be used to test
863 architecture page table helper functions on various platforms in
864 verifying if they comply with expected generic MM semantics. This
865 will help architecture code in making sure that any changes or
866 new additions of these helpers still conform to expected
867 semantics of the generic MM. Platforms will have to opt in for
868 this through ARCH_HAS_DEBUG_VM_PGTABLE.
869
870 If unsure, say N.
871
fa5b6ec9
LA
872config ARCH_HAS_DEBUG_VIRTUAL
873 bool
874
0610c8a8
DH
875config DEBUG_VIRTUAL
876 bool "Debug VM translations"
fa5b6ec9 877 depends on DEBUG_KERNEL && ARCH_HAS_DEBUG_VIRTUAL
0610c8a8
DH
878 help
879 Enable some costly sanity checks in virtual to page code. This can
880 catch mistakes with virt_to_page() and friends.
881
882 If unsure, say N.
883
884config DEBUG_NOMMU_REGIONS
885 bool "Debug the global anon/private NOMMU mapping region tree"
886 depends on DEBUG_KERNEL && !MMU
887 help
888 This option causes the global tree of anonymous and private mapping
889 regions to be regularly checked for invalid topology.
890
891config DEBUG_MEMORY_INIT
892 bool "Debug memory initialisation" if EXPERT
893 default !EXPERT
894 help
895 Enable this for additional checks during memory initialisation.
896 The sanity checks verify aspects of the VM such as the memory model
897 and other information provided by the architecture. Verbose
898 information will be printed at KERN_DEBUG loglevel depending
899 on the mminit_loglevel= command-line option.
900
901 If unsure, say Y
902
903config MEMORY_NOTIFIER_ERROR_INJECT
904 tristate "Memory hotplug notifier error injection module"
50f9481e 905 depends on MEMORY_HOTPLUG && NOTIFIER_ERROR_INJECTION
0610c8a8
DH
906 help
907 This option provides the ability to inject artificial errors to
908 memory hotplug notifier chain callbacks. It is controlled through
909 debugfs interface under /sys/kernel/debug/notifier-error-inject/memory
910
911 If the notifier call chain should be failed with some events
912 notified, write the error code to "actions/<notifier event>/error".
913
914 Example: Inject memory hotplug offline error (-12 == -ENOMEM)
915
916 # cd /sys/kernel/debug/notifier-error-inject/memory
917 # echo -12 > actions/MEM_GOING_OFFLINE/error
918 # echo offline > /sys/devices/system/memory/memoryXXX/state
919 bash: echo: write error: Cannot allocate memory
920
921 To compile this code as a module, choose M here: the module will
922 be called memory-notifier-error-inject.
923
924 If unsure, say N.
925
926config DEBUG_PER_CPU_MAPS
927 bool "Debug access to per_cpu maps"
928 depends on DEBUG_KERNEL
929 depends on SMP
930 help
931 Say Y to verify that the per_cpu map being accessed has
932 been set up. This adds a fair amount of code to kernel memory
933 and decreases performance.
934
935 Say N if unsure.
936
6e799cb6
TG
937config DEBUG_KMAP_LOCAL
938 bool "Debug kmap_local temporary mappings"
939 depends on DEBUG_KERNEL && KMAP_LOCAL
940 help
941 This option enables additional error checking for the kmap_local
942 infrastructure. Disable for production use.
943
0e91a0c6
TG
944config ARCH_SUPPORTS_KMAP_LOCAL_FORCE_MAP
945 bool
946
947config DEBUG_KMAP_LOCAL_FORCE_MAP
948 bool "Enforce kmap_local temporary mappings"
949 depends on DEBUG_KERNEL && ARCH_SUPPORTS_KMAP_LOCAL_FORCE_MAP
950 select KMAP_LOCAL
951 select DEBUG_KMAP_LOCAL
952 help
953 This option enforces temporary mappings through the kmap_local
954 mechanism for non-highmem pages and on non-highmem systems.
955 Disable this for production systems!
956
0610c8a8
DH
957config DEBUG_HIGHMEM
958 bool "Highmem debugging"
959 depends on DEBUG_KERNEL && HIGHMEM
0e91a0c6 960 select DEBUG_KMAP_LOCAL_FORCE_MAP if ARCH_SUPPORTS_KMAP_LOCAL_FORCE_MAP
6e799cb6 961 select DEBUG_KMAP_LOCAL
0610c8a8 962 help
b1357c9f
GU
963 This option enables additional error checking for high memory
964 systems. Disable for production systems.
0610c8a8
DH
965
966config HAVE_DEBUG_STACKOVERFLOW
967 bool
968
969config DEBUG_STACKOVERFLOW
970 bool "Check for stack overflows"
971 depends on DEBUG_KERNEL && HAVE_DEBUG_STACKOVERFLOW
a7f7f624 972 help
0610c8a8 973 Say Y here if you want to check for overflows of kernel, IRQ
edb0ec07 974 and exception stacks (if your architecture uses them). This
0610c8a8
DH
975 option will show detailed messages if free stack space drops
976 below a certain limit.
977
978 These kinds of bugs usually occur when call-chains in the
979 kernel get too deep, especially when interrupts are
980 involved.
981
982 Use this in cases where you see apparently random memory
983 corruption, especially if it appears in 'struct thread_info'
984
985 If in doubt, say "N".
986
0b24becc 987source "lib/Kconfig.kasan"
0ce20dd8 988source "lib/Kconfig.kfence"
0b24becc 989
0610c8a8
DH
990endmenu # "Memory Debugging"
991
a304e1b8
DW
992config DEBUG_SHIRQ
993 bool "Debug shared IRQ handlers"
0244ad00 994 depends on DEBUG_KERNEL
a304e1b8 995 help
0a2fae2a
WS
996 Enable this to generate a spurious interrupt just before a shared
997 interrupt handler is deregistered (generating one when registering
998 is currently disabled). Drivers need to handle this correctly. Some
999 don't and need to be caught.
a304e1b8 1000
f43a289d
CD
1001menu "Debug Oops, Lockups and Hangs"
1002
1003config PANIC_ON_OOPS
1004 bool "Panic on Oops"
1005 help
1006 Say Y here to enable the kernel to panic when it oopses. This
1007 has the same effect as setting oops=panic on the kernel command
1008 line.
1009
1010 This feature is useful to ensure that the kernel does not do
1011 anything erroneous after an oops which could result in data
1012 corruption or other issues.
1013
1014 Say N if unsure.
1015
1016config PANIC_ON_OOPS_VALUE
1017 int
1018 range 0 1
1019 default 0 if !PANIC_ON_OOPS
1020 default 1 if PANIC_ON_OOPS
1021
1022config PANIC_TIMEOUT
1023 int "panic timeout"
1024 default 0
1025 help
9d5b134f 1026 Set the timeout value (in seconds) until a reboot occurs when
f43a289d
CD
1027 the kernel panics. If n = 0, then we wait forever. A timeout
1028 value n > 0 will wait n seconds before rebooting, while a timeout
1029 value n < 0 will reboot immediately.
92aef8fb 1030
58687acb 1031config LOCKUP_DETECTOR
05a4a952
NP
1032 bool
1033
1034config SOFTLOCKUP_DETECTOR
1035 bool "Detect Soft Lockups"
dea20a3f 1036 depends on DEBUG_KERNEL && !S390
05a4a952 1037 select LOCKUP_DETECTOR
8446f1d3 1038 help
58687acb 1039 Say Y here to enable the kernel to act as a watchdog to detect
05a4a952 1040 soft lockups.
58687acb
DZ
1041
1042 Softlockups are bugs that cause the kernel to loop in kernel
5f329089 1043 mode for more than 20 seconds, without giving other tasks a
58687acb
DZ
1044 chance to run. The current stack trace is displayed upon
1045 detection and the system will stay locked up.
8446f1d3 1046
5f00ae0d
RD
1047config BOOTPARAM_SOFTLOCKUP_PANIC
1048 bool "Panic (Reboot) On Soft Lockups"
1049 depends on SOFTLOCKUP_DETECTOR
1050 help
1051 Say Y here to enable the kernel to panic on "soft lockups",
1052 which are bugs that cause the kernel to loop in kernel
1053 mode for more than 20 seconds (configurable using the watchdog_thresh
1054 sysctl), without giving other tasks a chance to run.
1055
1056 The panic can be used in combination with panic_timeout,
1057 to cause the system to reboot automatically after a
1058 lockup has been detected. This feature is useful for
1059 high-availability systems that have uptime guarantees and
1060 where a lockup must be resolved ASAP.
1061
1062 Say N if unsure.
1063
1064config BOOTPARAM_SOFTLOCKUP_PANIC_VALUE
1065 int
1066 depends on SOFTLOCKUP_DETECTOR
1067 range 0 1
1068 default 0 if !BOOTPARAM_SOFTLOCKUP_PANIC
1069 default 1 if BOOTPARAM_SOFTLOCKUP_PANIC
1070
05a4a952
NP
1071config HARDLOCKUP_DETECTOR_PERF
1072 bool
1073 select SOFTLOCKUP_DETECTOR
1074
7edaeb68
TG
1075#
1076# Enables a timestamp based low pass filter to compensate for perf based
1077# hard lockup detection which runs too fast due to turbo modes.
1078#
1079config HARDLOCKUP_CHECK_TIMESTAMP
1080 bool
1081
05a4a952
NP
1082#
1083# arch/ can define HAVE_HARDLOCKUP_DETECTOR_ARCH to provide their own hard
1084# lockup detector rather than the perf based detector.
1085#
1086config HARDLOCKUP_DETECTOR
1087 bool "Detect Hard Lockups"
1088 depends on DEBUG_KERNEL && !S390
1089 depends on HAVE_HARDLOCKUP_DETECTOR_PERF || HAVE_HARDLOCKUP_DETECTOR_ARCH
1090 select LOCKUP_DETECTOR
1091 select HARDLOCKUP_DETECTOR_PERF if HAVE_HARDLOCKUP_DETECTOR_PERF
05a4a952
NP
1092 help
1093 Say Y here to enable the kernel to act as a watchdog to detect
1094 hard lockups.
1095
58687acb 1096 Hardlockups are bugs that cause the CPU to loop in kernel mode
5f329089 1097 for more than 10 seconds, without letting other interrupts have a
58687acb
DZ
1098 chance to run. The current stack trace is displayed upon detection
1099 and the system will stay locked up.
8446f1d3 1100
fef2c9bc
DZ
1101config BOOTPARAM_HARDLOCKUP_PANIC
1102 bool "Panic (Reboot) On Hard Lockups"
8f1f66ed 1103 depends on HARDLOCKUP_DETECTOR
fef2c9bc
DZ
1104 help
1105 Say Y here to enable the kernel to panic on "hard lockups",
1106 which are bugs that cause the kernel to loop in kernel
5f329089
FLVC
1107 mode with interrupts disabled for more than 10 seconds (configurable
1108 using the watchdog_thresh sysctl).
fef2c9bc
DZ
1109
1110 Say N if unsure.
1111
1112config BOOTPARAM_HARDLOCKUP_PANIC_VALUE
1113 int
8f1f66ed 1114 depends on HARDLOCKUP_DETECTOR
fef2c9bc
DZ
1115 range 0 1
1116 default 0 if !BOOTPARAM_HARDLOCKUP_PANIC
1117 default 1 if BOOTPARAM_HARDLOCKUP_PANIC
1118
e162b39a
MSB
1119config DETECT_HUNG_TASK
1120 bool "Detect Hung Tasks"
1121 depends on DEBUG_KERNEL
05a4a952 1122 default SOFTLOCKUP_DETECTOR
e162b39a 1123 help
0610c8a8
DH
1124 Say Y here to enable the kernel to detect "hung tasks",
1125 which are bugs that cause the task to be stuck in
96b03ab8 1126 uninterruptible "D" state indefinitely.
1da177e4 1127
0610c8a8
DH
1128 When a hung task is detected, the kernel will print the
1129 current stack trace (which you should report), but the
1130 task will stay in uninterruptible state. If lockdep is
1131 enabled then all held locks will also be reported. This
1132 feature has negligible overhead.
871751e2 1133
0610c8a8
DH
1134config DEFAULT_HUNG_TASK_TIMEOUT
1135 int "Default timeout for hung task detection (in seconds)"
1136 depends on DETECT_HUNG_TASK
1137 default 120
f0630fff 1138 help
0610c8a8
DH
1139 This option controls the default timeout (in seconds) used
1140 to determine when a task has become non-responsive and should
1141 be considered hung.
f0630fff 1142
0610c8a8
DH
1143 It can be adjusted at runtime via the kernel.hung_task_timeout_secs
1144 sysctl or by writing a value to
1145 /proc/sys/kernel/hung_task_timeout_secs.
8ff12cfc 1146
0610c8a8
DH
1147 A timeout of 0 disables the check. The default is two minutes.
1148 Keeping the default should be fine in most cases.
b69ec42b 1149
0610c8a8
DH
1150config BOOTPARAM_HUNG_TASK_PANIC
1151 bool "Panic (Reboot) On Hung Tasks"
1152 depends on DETECT_HUNG_TASK
3bba00d7 1153 help
0610c8a8
DH
1154 Say Y here to enable the kernel to panic on "hung tasks",
1155 which are bugs that cause the kernel to leave a task stuck
1156 in uninterruptible "D" state.
3bba00d7 1157
0610c8a8
DH
1158 The panic can be used in combination with panic_timeout,
1159 to cause the system to reboot automatically after a
1160 hung task has been detected. This feature is useful for
1161 high-availability systems that have uptime guarantees and
1162 where a hung tasks must be resolved ASAP.
bf96d1e3 1163
0610c8a8 1164 Say N if unsure.
bf96d1e3 1165
0610c8a8
DH
1166config BOOTPARAM_HUNG_TASK_PANIC_VALUE
1167 int
1168 depends on DETECT_HUNG_TASK
1169 range 0 1
1170 default 0 if !BOOTPARAM_HUNG_TASK_PANIC
1171 default 1 if BOOTPARAM_HUNG_TASK_PANIC
3bba00d7 1172
82607adc
TH
1173config WQ_WATCHDOG
1174 bool "Detect Workqueue Stalls"
1175 depends on DEBUG_KERNEL
1176 help
1177 Say Y here to enable stall detection on workqueues. If a
1178 worker pool doesn't make forward progress on a pending work
1179 item for over a given amount of time, 30s by default, a
1180 warning message is printed along with dump of workqueue
1181 state. This can be configured through kernel parameter
1182 "workqueue.watchdog_thresh" and its sysfs counterpart.
1183
30428ef5
KK
1184config TEST_LOCKUP
1185 tristate "Test module to generate lockups"
63646bc9 1186 depends on m
30428ef5
KK
1187 help
1188 This builds the "test_lockup" module that helps to make sure
1189 that watchdogs and lockup detectors are working properly.
1190
1191 Depending on module parameters it could emulate soft or hard
1192 lockup, "hung task", or locking arbitrary lock for a long time.
1193 Also it could generate series of lockups with cooling-down periods.
1194
1195 If unsure, say N.
1196
92aef8fb
DH
1197endmenu # "Debug lockups and hangs"
1198
ebebdd09 1199menu "Scheduler Debugging"
5800dc3c 1200
0610c8a8
DH
1201config SCHED_DEBUG
1202 bool "Collect scheduler debugging info"
1203 depends on DEBUG_KERNEL && PROC_FS
1204 default y
0822ee4a 1205 help
0610c8a8
DH
1206 If you say Y here, the /proc/sched_debug file will be provided
1207 that can help debug the scheduler. The runtime overhead of this
1208 option is minimal.
0822ee4a 1209
f6db8347
NR
1210config SCHED_INFO
1211 bool
1212 default n
1213
0610c8a8
DH
1214config SCHEDSTATS
1215 bool "Collect scheduler statistics"
1216 depends on DEBUG_KERNEL && PROC_FS
f6db8347 1217 select SCHED_INFO
0610c8a8
DH
1218 help
1219 If you say Y here, additional code will be inserted into the
1220 scheduler and related routines to collect statistics about
1221 scheduler behavior and provide them in /proc/schedstat. These
1222 stats may be useful for both tuning and debugging the scheduler
1223 If you aren't debugging the scheduler or trying to tune a specific
1224 application, you can say N to avoid the very slight overhead
1225 this adds.
0822ee4a 1226
ebebdd09 1227endmenu
0d9e2632 1228
3c17ad19
JS
1229config DEBUG_TIMEKEEPING
1230 bool "Enable extra timekeeping sanity checking"
1231 help
1232 This option will enable additional timekeeping sanity checks
1233 which may be helpful when diagnosing issues where timekeeping
1234 problems are suspected.
1235
1236 This may include checks in the timekeeping hotpaths, so this
1237 option may have a (very small) performance impact to some
1238 workloads.
1239
1240 If unsure, say N.
1241
1da177e4
LT
1242config DEBUG_PREEMPT
1243 bool "Debug preemptible kernel"
9f472869 1244 depends on DEBUG_KERNEL && PREEMPTION && TRACE_IRQFLAGS_SUPPORT
1da177e4
LT
1245 default y
1246 help
1247 If you say Y here then the kernel will use a debug variant of the
1248 commonly used smp_processor_id() function and will print warnings
1249 if kernel code uses it in a preemption-unsafe way. Also, the kernel
1250 will detect preemption count underflows.
1251
9eade16b
DH
1252menu "Lock Debugging (spinlocks, mutexes, etc...)"
1253
f07cbebb
WL
1254config LOCK_DEBUGGING_SUPPORT
1255 bool
1256 depends on TRACE_IRQFLAGS_SUPPORT && STACKTRACE_SUPPORT && LOCKDEP_SUPPORT
1257 default y
1258
19193bca
WL
1259config PROVE_LOCKING
1260 bool "Lock debugging: prove locking correctness"
1261 depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT
1262 select LOCKDEP
1263 select DEBUG_SPINLOCK
bb630f9f 1264 select DEBUG_MUTEXES if !PREEMPT_RT
19193bca 1265 select DEBUG_RT_MUTEXES if RT_MUTEXES
c71fd893 1266 select DEBUG_RWSEMS
19193bca
WL
1267 select DEBUG_WW_MUTEX_SLOWPATH
1268 select DEBUG_LOCK_ALLOC
8fd8ad5c 1269 select PREEMPT_COUNT if !ARCH_NO_PREEMPT
19193bca
WL
1270 select TRACE_IRQFLAGS
1271 default n
1272 help
1273 This feature enables the kernel to prove that all locking
1274 that occurs in the kernel runtime is mathematically
1275 correct: that under no circumstance could an arbitrary (and
1276 not yet triggered) combination of observed locking
1277 sequences (on an arbitrary number of CPUs, running an
1278 arbitrary number of tasks and interrupt contexts) cause a
1279 deadlock.
1280
1281 In short, this feature enables the kernel to report locking
1282 related deadlocks before they actually occur.
1283
1284 The proof does not depend on how hard and complex a
1285 deadlock scenario would be to trigger: how many
1286 participant CPUs, tasks and irq-contexts would be needed
1287 for it to trigger. The proof also does not depend on
1288 timing: if a race and a resulting deadlock is possible
1289 theoretically (no matter how unlikely the race scenario
1290 is), it will be proven so and will immediately be
1291 reported by the kernel (once the event is observed that
1292 makes the deadlock theoretically possible).
1293
1294 If a deadlock is impossible (i.e. the locking rules, as
1295 observed by the kernel, are mathematically correct), the
1296 kernel reports nothing.
1297
1298 NOTE: this feature can also be enabled for rwlocks, mutexes
1299 and rwsems - in which case all dependencies between these
1300 different locking variants are observed and mapped too, and
1301 the proof of observed correctness is also maintained for an
1302 arbitrary combination of these separate locking variants.
1303
387b1468 1304 For more details, see Documentation/locking/lockdep-design.rst.
19193bca 1305
de8f5e4f
PZ
1306config PROVE_RAW_LOCK_NESTING
1307 bool "Enable raw_spinlock - spinlock nesting checks"
1308 depends on PROVE_LOCKING
1309 default n
1310 help
1311 Enable the raw_spinlock vs. spinlock nesting checks which ensure
1312 that the lock nesting rules for PREEMPT_RT enabled kernels are
1313 not violated.
1314
1315 NOTE: There are known nesting problems. So if you enable this
1316 option expect lockdep splats until these problems have been fully
1317 addressed which is work in progress. This config switch allows to
1318 identify and analyze these problems. It will be removed and the
9dbbc3b9 1319 check permanently enabled once the main issues have been fixed.
de8f5e4f
PZ
1320
1321 If unsure, select N.
1322
19193bca
WL
1323config LOCK_STAT
1324 bool "Lock usage statistics"
1325 depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT
1326 select LOCKDEP
1327 select DEBUG_SPINLOCK
bb630f9f 1328 select DEBUG_MUTEXES if !PREEMPT_RT
19193bca
WL
1329 select DEBUG_RT_MUTEXES if RT_MUTEXES
1330 select DEBUG_LOCK_ALLOC
1331 default n
1332 help
1333 This feature enables tracking lock contention points
1334
387b1468 1335 For more details, see Documentation/locking/lockstat.rst
19193bca
WL
1336
1337 This also enables lock events required by "perf lock",
1338 subcommand of perf.
1339 If you want to use "perf lock", you also need to turn on
1340 CONFIG_EVENT_TRACING.
1341
1342 CONFIG_LOCK_STAT defines "contended" and "acquired" lock events.
1343 (CONFIG_LOCKDEP defines "acquire" and "release" events.)
1344
e7eebaf6
IM
1345config DEBUG_RT_MUTEXES
1346 bool "RT Mutex debugging, deadlock detection"
e7eebaf6
IM
1347 depends on DEBUG_KERNEL && RT_MUTEXES
1348 help
1349 This allows rt mutex semantics violations and rt mutex related
1350 deadlocks (lockups) to be detected and reported automatically.
1351
1da177e4 1352config DEBUG_SPINLOCK
4d9f34ad 1353 bool "Spinlock and rw-lock debugging: basic checks"
1da177e4 1354 depends on DEBUG_KERNEL
e335e3eb 1355 select UNINLINE_SPIN_UNLOCK
1da177e4
LT
1356 help
1357 Say Y here and build SMP to catch missing spinlock initialization
1358 and certain other kinds of spinlock errors commonly made. This is
1359 best used in conjunction with the NMI watchdog so that spinlock
1360 deadlocks are also debuggable.
1361
4d9f34ad
IM
1362config DEBUG_MUTEXES
1363 bool "Mutex debugging: basic checks"
bb630f9f 1364 depends on DEBUG_KERNEL && !PREEMPT_RT
4d9f34ad
IM
1365 help
1366 This feature allows mutex semantics violations to be detected and
1367 reported.
1368
23010027
DV
1369config DEBUG_WW_MUTEX_SLOWPATH
1370 bool "Wait/wound mutex debugging: Slowpath testing"
f07cbebb 1371 depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT
23010027
DV
1372 select DEBUG_LOCK_ALLOC
1373 select DEBUG_SPINLOCK
bb630f9f
TG
1374 select DEBUG_MUTEXES if !PREEMPT_RT
1375 select DEBUG_RT_MUTEXES if PREEMPT_RT
23010027
DV
1376 help
1377 This feature enables slowpath testing for w/w mutex users by
1378 injecting additional -EDEADLK wound/backoff cases. Together with
1379 the full mutex checks enabled with (CONFIG_PROVE_LOCKING) this
1380 will test all possible w/w mutex interface abuse with the
1381 exception of simply not acquiring all the required locks.
4d692373
RC
1382 Note that this feature can introduce significant overhead, so
1383 it really should not be enabled in a production or distro kernel,
1384 even a debug kernel. If you are a driver writer, enable it. If
1385 you are a distro, do not.
23010027 1386
5149cbac
WL
1387config DEBUG_RWSEMS
1388 bool "RW Semaphore debugging: basic checks"
c71fd893 1389 depends on DEBUG_KERNEL
5149cbac 1390 help
c71fd893
WL
1391 This debugging feature allows mismatched rw semaphore locks
1392 and unlocks to be detected and reported.
5149cbac 1393
4d9f34ad
IM
1394config DEBUG_LOCK_ALLOC
1395 bool "Lock debugging: detect incorrect freeing of live locks"
f07cbebb 1396 depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT
4d9f34ad 1397 select DEBUG_SPINLOCK
bb630f9f 1398 select DEBUG_MUTEXES if !PREEMPT_RT
f5694788 1399 select DEBUG_RT_MUTEXES if RT_MUTEXES
4d9f34ad
IM
1400 select LOCKDEP
1401 help
1402 This feature will check whether any held lock (spinlock, rwlock,
1403 mutex or rwsem) is incorrectly freed by the kernel, via any of the
1404 memory-freeing routines (kfree(), kmem_cache_free(), free_pages(),
1405 vfree(), etc.), whether a live lock is incorrectly reinitialized via
1406 spin_lock_init()/mutex_init()/etc., or whether there is any lock
1407 held during task exit.
1408
4d9f34ad
IM
1409config LOCKDEP
1410 bool
f07cbebb 1411 depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT
4d9f34ad 1412 select STACKTRACE
4d9f34ad
IM
1413 select KALLSYMS
1414 select KALLSYMS_ALL
1415
395102db
DJ
1416config LOCKDEP_SMALL
1417 bool
1418
5dc33592
TH
1419config LOCKDEP_BITS
1420 int "Bitsize for MAX_LOCKDEP_ENTRIES"
1421 depends on LOCKDEP && !LOCKDEP_SMALL
1422 range 10 30
1423 default 15
1424 help
1425 Try increasing this value if you hit "BUG: MAX_LOCKDEP_ENTRIES too low!" message.
1426
1427config LOCKDEP_CHAINS_BITS
1428 int "Bitsize for MAX_LOCKDEP_CHAINS"
1429 depends on LOCKDEP && !LOCKDEP_SMALL
1430 range 10 30
1431 default 16
1432 help
1433 Try increasing this value if you hit "BUG: MAX_LOCKDEP_CHAINS too low!" message.
1434
1435config LOCKDEP_STACK_TRACE_BITS
1436 int "Bitsize for MAX_STACK_TRACE_ENTRIES"
1437 depends on LOCKDEP && !LOCKDEP_SMALL
1438 range 10 30
1439 default 19
1440 help
1441 Try increasing this value if you hit "BUG: MAX_STACK_TRACE_ENTRIES too low!" message.
1442
1443config LOCKDEP_STACK_TRACE_HASH_BITS
1444 int "Bitsize for STACK_TRACE_HASH_SIZE"
1445 depends on LOCKDEP && !LOCKDEP_SMALL
1446 range 10 30
1447 default 14
1448 help
1449 Try increasing this value if you need large MAX_STACK_TRACE_ENTRIES.
1450
1451config LOCKDEP_CIRCULAR_QUEUE_BITS
1452 int "Bitsize for elements in circular_queue struct"
1453 depends on LOCKDEP
1454 range 10 30
1455 default 12
1456 help
1457 Try increasing this value if you hit "lockdep bfs error:-1" warning due to __cq_enqueue() failure.
1458
4d9f34ad
IM
1459config DEBUG_LOCKDEP
1460 bool "Lock dependency engine debugging"
517e7aa5 1461 depends on DEBUG_KERNEL && LOCKDEP
997acaf6 1462 select DEBUG_IRQFLAGS
4d9f34ad
IM
1463 help
1464 If you say Y here, the lock dependency engine will do
1465 additional runtime checks to debug itself, at the price
1466 of more runtime overhead.
1467
d902db1e
FW
1468config DEBUG_ATOMIC_SLEEP
1469 bool "Sleep inside atomic section checking"
e8f7c70f 1470 select PREEMPT_COUNT
1da177e4 1471 depends on DEBUG_KERNEL
87a4c375 1472 depends on !ARCH_NO_PREEMPT
1da177e4
LT
1473 help
1474 If you say Y here, various routines which may sleep will become very
d902db1e
FW
1475 noisy if they are called inside atomic sections: when a spinlock is
1476 held, inside an rcu read side critical section, inside preempt disabled
1477 sections, inside an interrupt, etc...
1da177e4 1478
cae2ed9a
IM
1479config DEBUG_LOCKING_API_SELFTESTS
1480 bool "Locking API boot-time self-tests"
1481 depends on DEBUG_KERNEL
1482 help
1483 Say Y here if you want the kernel to run a short self-test during
1484 bootup. The self-test checks whether common types of locking bugs
1485 are detected by debugging mechanisms or not. (if you disable
9dbbc3b9 1486 lock debugging then those bugs won't be detected of course.)
cae2ed9a
IM
1487 The following locking APIs are covered: spinlocks, rwlocks,
1488 mutexes and rwsems.
1489
0af3fe1e
PM
1490config LOCK_TORTURE_TEST
1491 tristate "torture tests for locking"
1492 depends on DEBUG_KERNEL
1493 select TORTURE_TEST
0af3fe1e
PM
1494 help
1495 This option provides a kernel module that runs torture tests
1496 on kernel locking primitives. The kernel module may be built
1497 after the fact on the running kernel to be tested, if desired.
1498
1499 Say Y here if you want kernel locking-primitive torture tests
1500 to be built into the kernel.
1501 Say M if you want these torture tests to build as a module.
1502 Say N if you are unsure.
1503
f2a5fec1
CW
1504config WW_MUTEX_SELFTEST
1505 tristate "Wait/wound mutex selftests"
1506 help
1507 This option provides a kernel module that runs tests on the
1508 on the struct ww_mutex locking API.
1509
1510 It is recommended to enable DEBUG_WW_MUTEX_SLOWPATH in conjunction
1511 with this test harness.
1512
1513 Say M if you want these self tests to build as a module.
1514 Say N if you are unsure.
1515
e9d338a0
PM
1516config SCF_TORTURE_TEST
1517 tristate "torture tests for smp_call_function*()"
1518 depends on DEBUG_KERNEL
1519 select TORTURE_TEST
1520 help
1521 This option provides a kernel module that runs torture tests
1522 on the smp_call_function() family of primitives. The kernel
1523 module may be built after the fact on the running kernel to
1524 be tested, if desired.
1525
35feb604
PM
1526config CSD_LOCK_WAIT_DEBUG
1527 bool "Debugging for csd_lock_wait(), called from smp_call_function*()"
1528 depends on DEBUG_KERNEL
1529 depends on 64BIT
1530 default n
1531 help
1532 This option enables debug prints when CPUs are slow to respond
1533 to the smp_call_function*() IPI wrappers. These debug prints
1534 include the IPI handler function currently executing (if any)
1535 and relevant stack traces.
1536
9eade16b 1537endmenu # lock debugging
8637c099 1538
9eade16b 1539config TRACE_IRQFLAGS
ed004953 1540 depends on TRACE_IRQFLAGS_SUPPORT
9eade16b 1541 bool
5ca43f6c 1542 help
9eade16b
DH
1543 Enables hooks to interrupt enabling and disabling for
1544 either tracing or lock debugging.
5ca43f6c 1545
ed004953 1546config TRACE_IRQFLAGS_NMI
1547 def_bool y
1548 depends on TRACE_IRQFLAGS
1549 depends on TRACE_IRQFLAGS_NMI_SUPPORT
1550
997acaf6
MR
1551config DEBUG_IRQFLAGS
1552 bool "Debug IRQ flag manipulation"
1553 help
1554 Enables checks for potentially unsafe enabling or disabling of
1555 interrupts, such as calling raw_local_irq_restore() when interrupts
1556 are enabled.
1557
8637c099 1558config STACKTRACE
0c38e1fe 1559 bool "Stack backtrace support"
8637c099 1560 depends on STACKTRACE_SUPPORT
0c38e1fe
DJ
1561 help
1562 This option causes the kernel to create a /proc/pid/stack for
1563 every process, showing its current stack trace.
1564 It is also used by various kernel debugging features that require
1565 stack trace generation.
5ca43f6c 1566
eecabf56
TT
1567config WARN_ALL_UNSEEDED_RANDOM
1568 bool "Warn for all uses of unseeded randomness"
1569 default n
d06bfd19
JD
1570 help
1571 Some parts of the kernel contain bugs relating to their use of
1572 cryptographically secure random numbers before it's actually possible
1573 to generate those numbers securely. This setting ensures that these
1574 flaws don't go unnoticed, by enabling a message, should this ever
1575 occur. This will allow people with obscure setups to know when things
1576 are going wrong, so that they might contact developers about fixing
1577 it.
1578
eecabf56
TT
1579 Unfortunately, on some models of some architectures getting
1580 a fully seeded CRNG is extremely difficult, and so this can
1581 result in dmesg getting spammed for a surprisingly long
1582 time. This is really bad from a security perspective, and
1583 so architecture maintainers really need to do what they can
1584 to get the CRNG seeded sooner after the system is booted.
4c5d114e 1585 However, since users cannot do anything actionable to
eecabf56
TT
1586 address this, by default the kernel will issue only a single
1587 warning for the first use of unseeded randomness.
1588
1589 Say Y here if you want to receive warnings for all uses of
1590 unseeded randomness. This will be of use primarily for
4c5d114e 1591 those developers interested in improving the security of
eecabf56
TT
1592 Linux kernels running on their architecture (or
1593 subarchitecture).
d06bfd19 1594
1da177e4
LT
1595config DEBUG_KOBJECT
1596 bool "kobject debugging"
1597 depends on DEBUG_KERNEL
1598 help
1599 If you say Y here, some extra kobject debugging messages will be sent
aca52c39 1600 to the syslog.
1da177e4 1601
c817a67e
RK
1602config DEBUG_KOBJECT_RELEASE
1603 bool "kobject release debugging"
2a999aa0 1604 depends on DEBUG_OBJECTS_TIMERS
c817a67e
RK
1605 help
1606 kobjects are reference counted objects. This means that their
1607 last reference count put is not predictable, and the kobject can
1608 live on past the point at which a driver decides to drop it's
1609 initial reference to the kobject gained on allocation. An
1610 example of this would be a struct device which has just been
1611 unregistered.
1612
1613 However, some buggy drivers assume that after such an operation,
1614 the memory backing the kobject can be immediately freed. This
1615 goes completely against the principles of a refcounted object.
1616
1617 If you say Y here, the kernel will delay the release of kobjects
1618 on the last reference count to improve the visibility of this
1619 kind of kobject release bug.
1620
9b2a60c4
CM
1621config HAVE_DEBUG_BUGVERBOSE
1622 bool
1623
3be5cbcd 1624menu "Debug kernel data structures"
1da177e4 1625
199a9afc
DJ
1626config DEBUG_LIST
1627 bool "Debug linked list manipulation"
4520bcb2 1628 depends on DEBUG_KERNEL || BUG_ON_DATA_CORRUPTION
199a9afc
DJ
1629 help
1630 Enable this to turn on extended checks in the linked-list
1631 walking routines.
1632
1633 If unsure, say N.
1634
8e18faea 1635config DEBUG_PLIST
b8cfff68
DS
1636 bool "Debug priority linked list manipulation"
1637 depends on DEBUG_KERNEL
1638 help
1639 Enable this to turn on extended checks in the priority-ordered
1640 linked-list (plist) walking routines. This checks the entire
1641 list multiple times during each manipulation.
1642
1643 If unsure, say N.
1644
d6ec0842
JA
1645config DEBUG_SG
1646 bool "Debug SG table operations"
1647 depends on DEBUG_KERNEL
1648 help
1649 Enable this to turn on checks on scatter-gather tables. This can
1650 help find problems with drivers that do not properly initialize
1651 their sg tables.
1652
1653 If unsure, say N.
1654
1b2439db
AV
1655config DEBUG_NOTIFIERS
1656 bool "Debug notifier call chains"
1657 depends on DEBUG_KERNEL
1658 help
1659 Enable this to turn on sanity checking for notifier call chains.
1660 This is most useful for kernel developers to make sure that
1661 modules properly unregister themselves from notifier chains.
1662 This is a relatively cheap check but if you care about maximum
1663 performance, say N.
1664
3be5cbcd
CD
1665config BUG_ON_DATA_CORRUPTION
1666 bool "Trigger a BUG when data corruption is detected"
1667 select DEBUG_LIST
1668 help
1669 Select this option if the kernel should BUG when it encounters
1670 data corruption in kernel memory structures when they get checked
1671 for validity.
1672
1673 If unsure, say N.
1674
1675endmenu
1676
e0e81739
DH
1677config DEBUG_CREDENTIALS
1678 bool "Debug credential management"
1679 depends on DEBUG_KERNEL
1680 help
1681 Enable this to turn on some debug checking for credential
1682 management. The additional code keeps track of the number of
1683 pointers from task_structs to any given cred struct, and checks to
1684 see that this number never exceeds the usage count of the cred
1685 struct.
1686
1687 Furthermore, if SELinux is enabled, this also checks that the
1688 security pointer in the cred struct is never seen to be invalid.
1689
1690 If unsure, say N.
1691
43a0a2a7 1692source "kernel/rcu/Kconfig.debug"
2f03e3ca 1693
f303fccb
TH
1694config DEBUG_WQ_FORCE_RR_CPU
1695 bool "Force round-robin CPU selection for unbound work items"
1696 depends on DEBUG_KERNEL
1697 default n
1698 help
1699 Workqueue used to implicitly guarantee that work items queued
1700 without explicit CPU specified are put on the local CPU. This
1701 guarantee is no longer true and while local CPU is still
1702 preferred work items may be put on foreign CPUs. Kernel
1703 parameter "workqueue.debug_force_rr_cpu" is added to force
1704 round-robin CPU selection to flush out usages which depend on the
1705 now broken guarantee. This config option enables the debug
1706 feature by default. When enabled, memory and cache locality will
1707 be impacted.
1708
757c989b
TG
1709config 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
09a74952
CD
1722config LATENCYTOP
1723 bool "Latency measuring infrastructure"
1724 depends on DEBUG_KERNEL
1725 depends on STACKTRACE_SUPPORT
1726 depends on PROC_FS
7d37cb2c 1727 depends on FRAME_POINTER || MIPS || PPC || S390 || MICROBLAZE || ARM || ARC || X86
09a74952
CD
1728 select KALLSYMS
1729 select KALLSYMS_ALL
1730 select STACKTRACE
1731 select SCHEDSTATS
09a74952
CD
1732 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
a74e2a22 1765 See Documentation/core-api/debugging-via-ohci1394.rst for more information.
09a74952 1766
045f6d79
CD
1767source "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
527701ed 1775 depends on ARCH_HAS_DEVMEM_IS_ALLOWED || GENERIC_LIB_DEVMEM_IS_ALLOWED
045f6d79
CD
1776 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
09a74952
CD
1816source "lib/kunit/Kconfig"
1817
8d438288
AM
1818config NOTIFIER_ERROR_INJECTION
1819 tristate "Notifier error injection"
1820 depends on DEBUG_KERNEL
1821 select DEBUG_FS
1822 help
e41e85cc 1823 This option provides the ability to inject artificial errors to
8d438288
AM
1824 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
048b9c35
AM
1829config 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
e41e85cc 1834 This option provides the ability to inject artificial errors to
048b9c35
AM
1835 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
d526e85f
BH
1853config OF_RECONFIG_NOTIFIER_ERROR_INJECT
1854 tristate "OF reconfig notifier error injection module"
1855 depends on OF_DYNAMIC && NOTIFIER_ERROR_INJECTION
08dfb4dd 1856 help
e41e85cc 1857 This option provides the ability to inject artificial errors to
d526e85f 1858 OF reconfig notifier chain callbacks. It is controlled
08dfb4dd 1859 through debugfs interface under
d526e85f 1860 /sys/kernel/debug/notifier-error-inject/OF-reconfig/
08dfb4dd
AM
1861
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
e12a95f4 1866 be called of-reconfig-notifier-error-inject.
08dfb4dd
AM
1867
1868 If unsure, say N.
1869
02fff96a
NA
1870config 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
f1b4bd06
MP
1893config FUNCTION_ERROR_INJECTION
1894 def_bool y
1895 depends on HAVE_FUNCTION_ERROR_INJECTION && KPROBES
1896
6ff1cb35 1897config FAULT_INJECTION
1ab8509a
AM
1898 bool "Fault-injection framework"
1899 depends on DEBUG_KERNEL
329409ae
AM
1900 help
1901 Provide fault-injection framework.
1902 For more details, see Documentation/fault-injection/.
6ff1cb35 1903
8a8b6502 1904config FAILSLAB
1ab8509a
AM
1905 bool "Fault-injection capability for kmalloc"
1906 depends on FAULT_INJECTION
773ff60e 1907 depends on SLAB || SLUB
8a8b6502 1908 help
1ab8509a 1909 Provide fault-injection capability for kmalloc.
8a8b6502 1910
933e312e 1911config FAIL_PAGE_ALLOC
29b46fa3 1912 bool "Fault-injection capability for alloc_pages()"
1ab8509a 1913 depends on FAULT_INJECTION
933e312e 1914 help
1ab8509a 1915 Provide fault-injection capability for alloc_pages().
933e312e 1916
2c739ced
AL
1917config 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
c17bb495 1924config FAIL_MAKE_REQUEST
86327d19 1925 bool "Fault-injection capability for disk IO"
581d4e28 1926 depends on FAULT_INJECTION && BLOCK
c17bb495 1927 help
1ab8509a 1928 Provide fault-injection capability for disk IO.
c17bb495 1929
581d4e28 1930config FAIL_IO_TIMEOUT
f4d01439 1931 bool "Fault-injection capability for faking disk interrupts"
581d4e28
JA
1932 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,
9dbbc3b9 1939 for others it won't do anything.
581d4e28 1940
ab51fbab
DB
1941config 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
f1b4bd06
MP
1948config 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
4b1a29a7
MH
1954config 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
f1b4bd06
MP
1964config FAIL_MMC_REQUEST
1965 bool "Fault-injection capability for MMC IO"
1966 depends on FAULT_INJECTION_DEBUG_FS && MMC
6ff1cb35 1967 help
f1b4bd06
MP
1968 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.
1df49008 1973
c782af25
CL
1974config 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
1df49008
AM
1981config FAULT_INJECTION_STACKTRACE_FILTER
1982 bool "stacktrace filter for fault-injection capabilities"
1983 depends on FAULT_INJECTION_DEBUG_FS && STACKTRACE_SUPPORT
6d690dca 1984 depends on !X86_64
1df49008 1985 select STACKTRACE
7d37cb2c 1986 depends on FRAME_POINTER || MIPS || PPC || S390 || MICROBLAZE || ARM || ARC || X86
1df49008
AM
1987 help
1988 Provide stacktrace filter for fault-injection capabilities
267c4025 1989
09a74952
CD
1990config ARCH_HAS_KCOV
1991 bool
cc3fa840 1992 help
09a74952
CD
1993 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.
cc3fa840 1996
09a74952
CD
1997config CC_HAS_SANCOV_TRACE_PC
1998 def_bool $(cc-option,-fsanitize-coverage=trace-pc)
cc3fa840 1999
cc3fa840 2000
09a74952
CD
2001config KCOV
2002 bool "Code coverage for fuzzing"
2003 depends on ARCH_HAS_KCOV
2004 depends on CC_HAS_SANCOV_TRACE_PC || GCC_PLUGINS
bece04b5
ME
2005 depends on !ARCH_WANTS_NO_INSTR || STACK_VALIDATION || \
2006 GCC_VERSION >= 120000 || CLANG_VERSION >= 130000
09a74952
CD
2007 select DEBUG_FS
2008 select GCC_PLUGIN_SANCOV if !CC_HAS_SANCOV_TRACE_PC
2009 help
2010 KCOV exposes kernel code coverage information in a form suitable
2011 for coverage-guided fuzzing (randomized testing).
cc3fa840 2012
09a74952
CD
2013 If RANDOMIZE_BASE is enabled, PC values will not be stable across
2014 different machines and across reboots. If you need stable PC values,
2015 disable RANDOMIZE_BASE.
cc3fa840 2016
09a74952 2017 For more details, see Documentation/dev-tools/kcov.rst.
cc3fa840 2018
09a74952
CD
2019config KCOV_ENABLE_COMPARISONS
2020 bool "Enable comparison operands collection by KCOV"
2021 depends on KCOV
2022 depends on $(cc-option,-fsanitize-coverage=trace-cmp)
2023 help
2024 KCOV also exposes operands of every comparison in the instrumented
2025 code along with operand sizes and PCs of the comparison instructions.
2026 These operands can be used by fuzzing engines to improve the quality
2027 of fuzzing coverage.
cc3fa840 2028
09a74952
CD
2029config KCOV_INSTRUMENT_ALL
2030 bool "Instrument all code by default"
2031 depends on KCOV
2032 default y
2033 help
2034 If you are doing generic system call fuzzing (like e.g. syzkaller),
2035 then you will want to instrument the whole kernel and you should
2036 say y here. If you are doing more targeted fuzzing (like e.g.
2037 filesystem fuzzing with AFL) then you will want to enable coverage
2038 for more specific subsets of files, and should say n here.
84bc809e 2039
5ff3b30a
AK
2040config KCOV_IRQ_AREA_SIZE
2041 hex "Size of interrupt coverage collection area in words"
2042 depends on KCOV
2043 default 0x40000
2044 help
2045 KCOV uses preallocated per-cpu areas to collect coverage from
2046 soft interrupts. This specifies the size of those areas in the
2047 number of unsigned long words.
2048
d3deafaa
VL
2049menuconfig RUNTIME_TESTING_MENU
2050 bool "Runtime Testing"
908009e8 2051 def_bool y
d3deafaa
VL
2052
2053if RUNTIME_TESTING_MENU
881c5149
DH
2054
2055config LKDTM
2056 tristate "Linux Kernel Dump Test Tool Module"
2057 depends on DEBUG_FS
881c5149
DH
2058 help
2059 This module enables testing of the different dumping mechanisms by
2060 inducing system failures at predefined crash points.
2061 If you don't need it: say N
2062 Choose M here to compile this code as a module. The module will be
2063 called lkdtm.
2064
2065 Documentation on how to use the module can be found in
10ffebbe 2066 Documentation/fault-injection/provoke-crashes.rst
881c5149
DH
2067
2068config TEST_LIST_SORT
ebd09577
DL
2069 tristate "Linked list sorting test" if !KUNIT_ALL_TESTS
2070 depends on KUNIT
2071 default KUNIT_ALL_TESTS
881c5149
DH
2072 help
2073 Enable this to turn on 'list_sort()' function test. This test is
e327fd7c
GU
2074 executed only once during system boot (so affects only boot time),
2075 or at module load time.
881c5149
DH
2076
2077 If unsure, say N.
2078
6e24628d
IR
2079config TEST_MIN_HEAP
2080 tristate "Min heap test"
2081 depends on DEBUG_KERNEL || m
2082 help
2083 Enable this to turn on min heap function tests. This test is
2084 executed only once during system boot (so affects only boot time),
2085 or at module load time.
2086
2087 If unsure, say N.
2088
c5adae95 2089config TEST_SORT
36f33b56
DL
2090 tristate "Array-based sort test" if !KUNIT_ALL_TESTS
2091 depends on KUNIT
2092 default KUNIT_ALL_TESTS
c5adae95 2093 help
5c4e6798
GU
2094 This option enables the self-test function of 'sort()' at boot,
2095 or at module load time.
c5adae95
KF
2096
2097 If unsure, say N.
2098
5086ea4b
MR
2099config TEST_DIV64
2100 tristate "64bit/32bit division and modulo test"
2101 depends on DEBUG_KERNEL || m
2102 help
2103 Enable this to turn on 'do_div()' function test. This test is
2104 executed only once during system boot (so affects only boot time),
2105 or at module load time.
2106
2107 If unsure, say N.
2108
881c5149 2109config KPROBES_SANITY_TEST
e44e81c5 2110 tristate "Kprobes sanity tests"
881c5149
DH
2111 depends on DEBUG_KERNEL
2112 depends on KPROBES
e44e81c5 2113 depends on KUNIT
881c5149
DH
2114 help
2115 This option provides for testing basic kprobes functionality on
5a6cf77f 2116 boot. Samples of kprobe and kretprobe are inserted and
881c5149
DH
2117 verified for functionality.
2118
2119 Say N if you are unsure.
2120
f4616fab
MH
2121config FPROBE_SANITY_TEST
2122 bool "Self test for fprobe"
2123 depends on DEBUG_KERNEL
2124 depends on FPROBE
2125 depends on KUNIT=y
2126 help
2127 This option will enable testing the fprobe when the system boot.
2128 A series of tests are made to verify that the fprobe is functioning
2129 properly.
2130
2131 Say N if you are unsure.
2132
881c5149
DH
2133config BACKTRACE_SELF_TEST
2134 tristate "Self test for the backtrace code"
2135 depends on DEBUG_KERNEL
881c5149
DH
2136 help
2137 This option provides a kernel module that can be used to test
2138 the kernel stack backtrace code. This option is not useful
2139 for distributions or general kernels, but only for kernel
2140 developers working on architecture code.
2141
2142 Note that if you want to also test saved backtraces, you will
2143 have to enable STACKTRACE as well.
2144
2145 Say N if you are unsure.
2146
914a7b50
ED
2147config TEST_REF_TRACKER
2148 tristate "Self test for reference tracker"
2149 depends on DEBUG_KERNEL && STACKTRACE_SUPPORT
2150 select REF_TRACKER
2151 help
2152 This option provides a kernel module performing tests
2153 using reference tracker infrastructure.
2154
2155 Say N if you are unsure.
2156
910a742d
ML
2157config RBTREE_TEST
2158 tristate "Red-Black tree test"
7c993e11 2159 depends on DEBUG_KERNEL
910a742d
ML
2160 help
2161 A benchmark measuring the performance of the rbtree library.
2162 Also includes rbtree invariant checks.
2163
4b4f3acc
FB
2164config REED_SOLOMON_TEST
2165 tristate "Reed-Solomon library test"
2166 depends on DEBUG_KERNEL || m
2167 select REED_SOLOMON
2168 select REED_SOLOMON_ENC16
2169 select REED_SOLOMON_DEC16
2170 help
2171 This option enables the self-test function of rslib at boot,
2172 or at module load time.
2173
2174 If unsure, say N.
2175
fff3fd8a
ML
2176config INTERVAL_TREE_TEST
2177 tristate "Interval tree test"
0f789b67 2178 depends on DEBUG_KERNEL
a88cc108 2179 select INTERVAL_TREE
fff3fd8a
ML
2180 help
2181 A benchmark measuring the performance of the interval tree library
2182
623fd807
GT
2183config PERCPU_TEST
2184 tristate "Per cpu operations test"
2185 depends on m && DEBUG_KERNEL
2186 help
2187 Enable this option to build test module which validates per-cpu
2188 operations.
2189
2190 If unsure, say N.
2191
881c5149 2192config ATOMIC64_SELFTEST
55ded955 2193 tristate "Perform an atomic64_t self-test"
881c5149 2194 help
55ded955
GU
2195 Enable this option to test the atomic64_t functions at boot or
2196 at module load time.
881c5149
DH
2197
2198 If unsure, say N.
2199
2200config ASYNC_RAID6_TEST
2201 tristate "Self test for hardware accelerated raid6 recovery"
2202 depends on ASYNC_RAID6_RECOV
2203 select ASYNC_MEMCPY
a7f7f624 2204 help
881c5149
DH
2205 This is a one-shot self test that permutes through the
2206 recovery of all the possible two disk failure scenarios for a
2207 N-disk array. Recovery is performed with the asynchronous
2208 raid6 recovery routines, and will optionally use an offload
2209 engine if one is available.
2210
2211 If unsure, say N.
2212
64d1d77a
AS
2213config TEST_HEXDUMP
2214 tristate "Test functions located in the hexdump module at runtime"
2215
b2ff70a0
MC
2216config STRING_SELFTEST
2217 tristate "Test string functions at runtime"
2218
881c5149
DH
2219config TEST_STRING_HELPERS
2220 tristate "Test functions located in the string_helpers module at runtime"
2221
0b0600c8
TH
2222config TEST_STRSCPY
2223 tristate "Test strscpy*() family of functions at runtime"
2224
881c5149
DH
2225config TEST_KSTRTOX
2226 tristate "Test kstrto*() family of functions at runtime"
2227
707cc728
RV
2228config TEST_PRINTF
2229 tristate "Test printf() family of functions at runtime"
2230
50f530e1
RF
2231config TEST_SCANF
2232 tristate "Test scanf() family of functions at runtime"
2233
5fd003f5
DD
2234config TEST_BITMAP
2235 tristate "Test bitmap_*() family of functions at runtime"
5fd003f5
DD
2236 help
2237 Enable this option to test the bitmap functions at boot.
2238
2239 If unsure, say N.
2240
cfaff0e5
AS
2241config TEST_UUID
2242 tristate "Test functions located in the uuid module at runtime"
2243
ad3d6c72
MW
2244config TEST_XARRAY
2245 tristate "Test the XArray code at runtime"
2246
7e1e7763 2247config TEST_RHASHTABLE
9d6dbe1b 2248 tristate "Perform selftest on resizable hash table"
7e1e7763
TG
2249 help
2250 Enable this option to test the rhashtable functions at boot.
2251
2252 If unsure, say N.
2253
88168bf3
IB
2254config TEST_SIPHASH
2255 tristate "Perform selftest on siphash functions"
468a9428 2256 help
88168bf3
IB
2257 Enable this option to test the kernel's siphash (<linux/siphash.h>) hash
2258 functions on boot (or module load).
468a9428
GS
2259
2260 This is intended to help people writing architecture-specific
2261 optimized versions. If unsure, say N.
2262
8ab8ba38
MW
2263config TEST_IDA
2264 tristate "Perform selftest on IDA functions"
2265
44091d29
JP
2266config TEST_PARMAN
2267 tristate "Perform selftest on priority array manager"
44091d29
JP
2268 depends on PARMAN
2269 help
2270 Enable this option to test priority array manager on boot
2271 (or module load).
2272
2273 If unsure, say N.
2274
6aed82de
DL
2275config TEST_IRQ_TIMINGS
2276 bool "IRQ timings selftest"
2277 depends on IRQ_TIMINGS
2278 help
2279 Enable this option to test the irq timings code on boot.
2280
2281 If unsure, say N.
2282
8a6f0b47 2283config TEST_LKM
93e9ef83 2284 tristate "Test module loading with 'hello world' module"
93e9ef83
KC
2285 depends on m
2286 help
2287 This builds the "test_module" module that emits "Hello, world"
2288 on printk when loaded. It is designed to be used for basic
2289 evaluation of the module loading subsystem (for example when
2290 validating module verification). It lacks any extra dependencies,
2291 and will not normally be loaded by the system unless explicitly
2292 requested by name.
2293
2294 If unsure, say N.
2295
c348c163 2296config TEST_BITOPS
6af132f3 2297 tristate "Test module for compilation of bitops operations"
c348c163
JB
2298 depends on m
2299 help
2300 This builds the "test_bitops" module that is much like the
2301 TEST_LKM module except that it does a basic exercise of the
6af132f3
WY
2302 set/clear_bit macros and get_count_order/long to make sure there are
2303 no compiler warnings from C=1 sparse checker or -Wextra
2304 compilations. It has no dependencies and doesn't run or load unless
2305 explicitly requested by name. for example: modprobe test_bitops.
c348c163
JB
2306
2307 If unsure, say N.
2308
3f21a6b7
URS
2309config TEST_VMALLOC
2310 tristate "Test module for stress/performance analysis of vmalloc allocator"
2311 default n
2312 depends on MMU
2313 depends on m
2314 help
2315 This builds the "test_vmalloc" module that should be used for
2316 stress and performance analysis. So, any new change for vmalloc
2317 subsystem can be evaluated from performance and stability point
2318 of view.
2319
2320 If unsure, say N.
2321
3e2a4c18
KC
2322config TEST_USER_COPY
2323 tristate "Test user/kernel boundary protections"
3e2a4c18
KC
2324 depends on m
2325 help
2326 This builds the "test_user_copy" module that runs sanity checks
2327 on the copy_to/from_user infrastructure, making sure basic
2328 user/kernel boundary testing is working. If it fails to load,
2329 a regression has been detected in the user/kernel memory boundary
2330 protections.
2331
2332 If unsure, say N.
2333
64a8946b
AS
2334config TEST_BPF
2335 tristate "Test BPF filter functionality"
98920ba6 2336 depends on m && NET
64a8946b
AS
2337 help
2338 This builds the "test_bpf" module that runs various test vectors
2339 against the BPF interpreter or BPF JIT compiler depending on the
2340 current setting. This is in particular useful for BPF JIT compiler
2341 development, but also to run regression tests against changes in
3c731eba
AS
2342 the interpreter code. It also enables test stubs for eBPF maps and
2343 verifier used by user space verifier testsuite.
64a8946b
AS
2344
2345 If unsure, say N.
2346
509e56b3
MB
2347config TEST_BLACKHOLE_DEV
2348 tristate "Test blackhole netdev functionality"
2349 depends on m && NET
2350 help
2351 This builds the "test_blackhole_dev" module that validates the
2352 data path through this blackhole netdev.
2353
2354 If unsure, say N.
2355
dceeb3e7 2356config FIND_BIT_BENCHMARK
4441fca0 2357 tristate "Test find_bit functions"
4441fca0
YN
2358 help
2359 This builds the "test_find_bit" module that measure find_*_bit()
2360 functions performance.
2361
2362 If unsure, say N.
2363
0a8adf58
KC
2364config TEST_FIRMWARE
2365 tristate "Test firmware loading via userspace interface"
0a8adf58
KC
2366 depends on FW_LOADER
2367 help
2368 This builds the "test_firmware" module that creates a userspace
2369 interface for testing firmware loading. This can be used to
2370 control the triggering of firmware loading without needing an
2371 actual firmware-using device. The contents can be rechecked by
2372 userspace.
2373
2374 If unsure, say N.
2375
9308f2f9
LR
2376config TEST_SYSCTL
2377 tristate "sysctl test driver"
9308f2f9
LR
2378 depends on PROC_SYSCTL
2379 help
2380 This builds the "test_sysctl" module. This driver enables to test the
2381 proc sysctl interfaces available to drivers safely without affecting
2382 production knobs which might alter system functionality.
2383
2384 If unsure, say N.
2385
d2585f51
VMI
2386config BITFIELD_KUNIT
2387 tristate "KUnit test bitfield functions at runtime"
2388 depends on KUNIT
2389 help
2390 Enable this option to test the bitfield functions at boot.
2391
2392 KUnit tests run during boot and output the results to the debug log
2393 in TAP format (http://testanything.org/). Only useful for kernel devs
2394 running the KUnit test harness, and not intended for inclusion into a
2395 production build.
2396
2397 For more information on KUnit and unit tests in general please refer
2398 to the KUnit documentation in Documentation/dev-tools/kunit/.
2399
2400 If unsure, say N.
2401
0acc968f
IB
2402config HASH_KUNIT_TEST
2403 tristate "KUnit Test for integer hash functions" if !KUNIT_ALL_TESTS
2404 depends on KUNIT
2405 default KUNIT_ALL_TESTS
2406 help
2407 Enable this option to test the kernel's string (<linux/stringhash.h>), and
2408 integer (<linux/hash.h>) hash functions on boot.
2409
2410 KUnit tests run during boot and output the results to the debug log
2411 in TAP format (https://testanything.org/). Only useful for kernel devs
2412 running the KUnit test harness, and not intended for inclusion into a
2413 production build.
2414
2415 For more information on KUnit and unit tests in general please refer
2416 to the KUnit documentation in Documentation/dev-tools/kunit/.
2417
2418 This is intended to help people writing architecture-specific
2419 optimized versions. If unsure, say N.
2420
5df38ca6
AS
2421config RESOURCE_KUNIT_TEST
2422 tristate "KUnit test for resource API"
2423 depends on KUNIT
2424 help
2425 This builds the resource API unit test.
2426 Tests the logic of API provided by resource.c and ioport.h.
2427 For more information on KUnit and unit tests in general please refer
2428 to the KUnit documentation in Documentation/dev-tools/kunit/.
2429
2430 If unsure, say N.
2431
2cb80dbb 2432config SYSCTL_KUNIT_TEST
5f215aab 2433 tristate "KUnit test for sysctl" if !KUNIT_ALL_TESTS
2cb80dbb 2434 depends on KUNIT
5f215aab 2435 default KUNIT_ALL_TESTS
2cb80dbb
IZ
2436 help
2437 This builds the proc sysctl unit test, which runs on boot.
2438 Tests the API contract and implementation correctness of sysctl.
2439 For more information on KUnit and unit tests in general please refer
2440 to the KUnit documentation in Documentation/dev-tools/kunit/.
2441
2442 If unsure, say N.
2443
ea2dd7c0 2444config LIST_KUNIT_TEST
5f215aab 2445 tristate "KUnit Test for Kernel Linked-list structures" if !KUNIT_ALL_TESTS
ea2dd7c0 2446 depends on KUNIT
5f215aab 2447 default KUNIT_ALL_TESTS
ea2dd7c0
DG
2448 help
2449 This builds the linked list KUnit test suite.
2450 It tests that the API and basic functionality of the list_head type
2451 and associated macros.
2452
2453 KUnit tests run during boot and output the results to the debug log
d89775fc 2454 in TAP format (https://testanything.org/). Only useful for kernel devs
ea2dd7c0
DG
2455 running the KUnit test harness, and not intended for inclusion into a
2456 production build.
2457
2458 For more information on KUnit and unit tests in general please refer
2459 to the KUnit documentation in Documentation/dev-tools/kunit/.
2460
2461 If unsure, say N.
2462
33d599f0
MV
2463config LINEAR_RANGES_TEST
2464 tristate "KUnit test for linear_ranges"
2465 depends on KUNIT
2466 select LINEAR_RANGES
2467 help
2468 This builds the linear_ranges unit test, which runs on boot.
2469 Tests the linear_ranges logic correctness.
2470 For more information on KUnit and unit tests in general please refer
7546861a
AS
2471 to the KUnit documentation in Documentation/dev-tools/kunit/.
2472
2473 If unsure, say N.
2474
2475config CMDLINE_KUNIT_TEST
2476 tristate "KUnit test for cmdline API"
2477 depends on KUNIT
2478 help
2479 This builds the cmdline API unit test.
2480 Tests the logic of API provided by cmdline.c.
2481 For more information on KUnit and unit tests in general please refer
33d599f0
MV
2482 to the KUnit documentation in Documentation/dev-tools/kunit/.
2483
2484 If unsure, say N.
2485
6d511020
RF
2486config BITS_TEST
2487 tristate "KUnit test for bits.h"
2488 depends on KUNIT
2489 help
2490 This builds the bits unit test.
2491 Tests the logic of macros defined in bits.h.
2492 For more information on KUnit and unit tests in general please refer
2493 to the KUnit documentation in Documentation/dev-tools/kunit/.
2494
2495 If unsure, say N.
2496
1f9f78b1
OG
2497config SLUB_KUNIT_TEST
2498 tristate "KUnit test for SLUB cache error detection" if !KUNIT_ALL_TESTS
2499 depends on SLUB_DEBUG && KUNIT
2500 default KUNIT_ALL_TESTS
2501 help
2502 This builds SLUB allocator unit test.
2503 Tests SLUB cache debugging functionality.
2504 For more information on KUnit and unit tests in general please refer
2505 to the KUnit documentation in Documentation/dev-tools/kunit/.
2506
2507 If unsure, say N.
2508
b6c75c4a
TP
2509config RATIONAL_KUNIT_TEST
2510 tristate "KUnit test for rational.c" if !KUNIT_ALL_TESTS
8ba739ed 2511 depends on KUNIT && RATIONAL
b6c75c4a
TP
2512 default KUNIT_ALL_TESTS
2513 help
2514 This builds the rational math unit test.
2515 For more information on KUnit and unit tests in general please refer
2516 to the KUnit documentation in Documentation/dev-tools/kunit/.
2517
2518 If unsure, say N.
2519
bb95ebbe
KC
2520config MEMCPY_KUNIT_TEST
2521 tristate "Test memcpy(), memmove(), and memset() functions at runtime" if !KUNIT_ALL_TESTS
2522 depends on KUNIT
2523 default KUNIT_ALL_TESTS
2524 help
2525 Builds unit tests for memcpy(), memmove(), and memset() functions.
2526 For more information on KUnit and unit tests in general please refer
2527 to the KUnit documentation in Documentation/dev-tools/kunit/.
2528
2529 If unsure, say N.
2530
617f55e2
KC
2531config OVERFLOW_KUNIT_TEST
2532 tristate "Test check_*_overflow() functions at runtime" if !KUNIT_ALL_TESTS
2533 depends on KUNIT
2534 default KUNIT_ALL_TESTS
2535 help
2536 Builds unit tests for the check_*_overflow(), size_*(), allocation, and
2537 related functions.
2538
2539 For more information on KUnit and unit tests in general please refer
2540 to the KUnit documentation in Documentation/dev-tools/kunit/.
2541
2542 If unsure, say N.
2543
02788ebc
KC
2544config STACKINIT_KUNIT_TEST
2545 tristate "Test level of stack variable initialization" if !KUNIT_ALL_TESTS
2546 depends on KUNIT
2547 default KUNIT_ALL_TESTS
2548 help
2549 Test if the kernel is zero-initializing stack variables and
2550 padding. Coverage is controlled by compiler flags,
2551 CONFIG_INIT_STACK_ALL_PATTERN, CONFIG_INIT_STACK_ALL_ZERO,
2552 CONFIG_GCC_PLUGIN_STRUCTLEAK, CONFIG_GCC_PLUGIN_STRUCTLEAK_BYREF,
2553 or CONFIG_GCC_PLUGIN_STRUCTLEAK_BYREF_ALL.
2554
e704f93a
DR
2555config TEST_UDELAY
2556 tristate "udelay test driver"
e704f93a
DR
2557 help
2558 This builds the "udelay_test" module that helps to make sure
2559 that udelay() is working properly.
2560
2561 If unsure, say N.
2562
2bf9e0ab
IM
2563config TEST_STATIC_KEYS
2564 tristate "Test static keys"
579e1acb
JB
2565 depends on m
2566 help
2bf9e0ab 2567 Test the static key interfaces.
579e1acb
JB
2568
2569 If unsure, say N.
2570
d9c6a72d
LR
2571config TEST_KMOD
2572 tristate "kmod stress tester"
d9c6a72d 2573 depends on m
d9c6a72d 2574 depends on NETDEVICES && NET_CORE && INET # for TUN
ae3d6a32 2575 depends on BLOCK
bbd2e05f 2576 depends on PAGE_SIZE_LESS_THAN_256KB # for BTRFS
d9c6a72d
LR
2577 select TEST_LKM
2578 select XFS_FS
2579 select TUN
2580 select BTRFS_FS
2581 help
2582 Test the kernel's module loading mechanism: kmod. kmod implements
2583 support to load modules using the Linux kernel's usermode helper.
2584 This test provides a series of tests against kmod.
2585
2586 Although technically you can either build test_kmod as a module or
2587 into the kernel we disallow building it into the kernel since
2588 it stress tests request_module() and this will very likely cause
2589 some issues by taking over precious threads available from other
2590 module load requests, ultimately this could be fatal.
2591
2592 To run tests run:
2593
2594 tools/testing/selftests/kmod/kmod.sh --help
2595
2596 If unsure, say N.
2597
e4dace36
FF
2598config TEST_DEBUG_VIRTUAL
2599 tristate "Test CONFIG_DEBUG_VIRTUAL feature"
2600 depends on DEBUG_VIRTUAL
2601 help
2602 Test the kernel's ability to detect incorrect calls to
2603 virt_to_phys() done against the non-linear part of the
2604 kernel's virtual address map.
2605
2606 If unsure, say N.
2607
ce76d938
AS
2608config TEST_MEMCAT_P
2609 tristate "Test memcat_p() helper function"
2610 help
2611 Test the memcat_p() helper for correctly merging two
2612 pointer arrays together.
2613
2614 If unsure, say N.
2615
a2818ee4
JL
2616config TEST_LIVEPATCH
2617 tristate "Test livepatching"
2618 default n
bae05437 2619 depends on DYNAMIC_DEBUG
a2818ee4
JL
2620 depends on LIVEPATCH
2621 depends on m
2622 help
2623 Test kernel livepatching features for correctness. The tests will
2624 load test modules that will be livepatched in various scenarios.
2625
2626 To run all the livepatching tests:
2627
2628 make -C tools/testing/selftests TARGETS=livepatch run_tests
2629
2630 Alternatively, individual tests may be invoked:
2631
2632 tools/testing/selftests/livepatch/test-callbacks.sh
2633 tools/testing/selftests/livepatch/test-livepatch.sh
2634 tools/testing/selftests/livepatch/test-shadow-vars.sh
2635
2636 If unsure, say N.
2637
0a020d41
JP
2638config TEST_OBJAGG
2639 tristate "Perform selftest on object aggreration manager"
2640 default n
2641 depends on OBJAGG
2642 help
2643 Enable this option to test object aggregation manager on boot
2644 (or module load).
2645
5015a300
AP
2646config TEST_MEMINIT
2647 tristate "Test heap/page initialization"
2648 help
2649 Test if the kernel is zero-initializing heap and page allocations.
2650 This can be useful to test init_on_alloc and init_on_free features.
2651
2652 If unsure, say N.
2653
b2ef9f5a
RC
2654config TEST_HMM
2655 tristate "Test HMM (Heterogeneous Memory Management)"
2656 depends on TRANSPARENT_HUGEPAGE
2657 depends on DEVICE_PRIVATE
2658 select HMM_MIRROR
2659 select MMU_NOTIFIER
2660 help
2661 This is a pseudo device driver solely for testing HMM.
2662 Say M here if you want to build the HMM test module.
2663 Doing so will allow you to run tools/testing/selftest/vm/hmm-tests.
2664
2665 If unsure, say N.
2666
e320d301
MWO
2667config TEST_FREE_PAGES
2668 tristate "Test freeing pages"
2669 help
2670 Test that a memory leak does not occur due to a race between
2671 freeing a block of pages and a speculative page reference.
2672 Loading this module is safe if your kernel has the bug fixed.
2673 If the bug is not fixed, it will leak gigabytes of memory and
2674 probably OOM your system.
2675
4185b3b9
PA
2676config TEST_FPU
2677 tristate "Test floating point operations in kernel space"
2678 depends on X86 && !KCOV_INSTRUMENT_ALL
2679 help
2680 Enable this option to add /sys/kernel/debug/selftest_helpers/test_fpu
2681 which will trigger a sequence of floating point operations. This is used
2682 for self-testing floating point control register setting in
2683 kernel_fpu_begin().
2684
2685 If unsure, say N.
2686
1253b9b8
PM
2687config TEST_CLOCKSOURCE_WATCHDOG
2688 tristate "Test clocksource watchdog in kernel space"
2689 depends on CLOCKSOURCE_WATCHDOG
2690 help
2691 Enable this option to create a kernel module that will trigger
2692 a test of the clocksource watchdog. This module may be loaded
2693 via modprobe or insmod in which case it will run upon being
2694 loaded, or it may be built in, in which case it will run
2695 shortly after boot.
2696
2697 If unsure, say N.
2698
d3deafaa 2699endif # RUNTIME_TESTING_MENU
cc3fa840 2700
dce44566
AK
2701config ARCH_USE_MEMTEST
2702 bool
2703 help
2704 An architecture should select this when it uses early_memtest()
2705 during boot process.
2706
cc3fa840
RD
2707config MEMTEST
2708 bool "Memtest"
dce44566 2709 depends on ARCH_USE_MEMTEST
a7f7f624 2710 help
cc3fa840 2711 This option adds a kernel parameter 'memtest', which allows memtest
dce44566 2712 to be set and executed.
cc3fa840
RD
2713 memtest=0, mean disabled; -- default
2714 memtest=1, mean do 1 test pattern;
2715 ...
2716 memtest=17, mean do 17 test patterns.
2717 If you are unsure how to answer this question, answer N.
2718
21266be9 2719
06ec64b8 2720
af9ca6f9
BB
2721config HYPERV_TESTING
2722 bool "Microsoft Hyper-V driver testing"
2723 default n
2724 depends on HYPERV && DEBUG_FS
2725 help
2726 Select this option to enable Hyper-V vmbus testing.
2727
045f6d79
CD
2728endmenu # "Kernel Testing and Coverage"
2729
75442fb0
MCC
2730source "Documentation/Kconfig"
2731
06ec64b8 2732endmenu # Kernel hacking