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