blob: 9ef7ce18b4f56195b28a4ae3f189af08700922f0 [file] [log] [blame]
Thomas Gleixnerec8f24b2019-05-19 13:07:45 +01001# SPDX-License-Identifier: GPL-2.0-only
Christoph Hellwig06ec64b2018-07-31 13:39:31 +02002menu "Kernel hacking"
3
Dave Hansen604ff0d2013-07-01 13:04:49 -07004menu "printk and dmesg options"
Linus Torvalds1da177e2005-04-16 15:20:36 -07005
6config PRINTK_TIME
7 bool "Show timing information on printks"
Randy Dunlapd3b8b6e2006-12-06 20:36:38 -08008 depends on PRINTK
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 help
Kay Sievers649e6ee2012-05-10 04:30:45 +020010 Selecting this option causes time stamps of the printk()
11 messages to be added to the output of the syslog() system
12 call and at the console.
13
14 The timestamp is always recorded internally, and exported
15 to /dev/kmsg. This flag just specifies if the timestamp should
16 be included, not that the timestamp is recorded.
17
18 The behavior is also controlled by the kernel command line
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -020019 parameter printk.time=1. See Documentation/admin-guide/kernel-parameters.rst
Linus Torvalds1da177e2005-04-16 15:20:36 -070020
Tetsuo Handa15ff2062018-12-18 06:05:04 +090021config PRINTK_CALLER
22 bool "Show caller information on printks"
23 depends on PRINTK
24 help
25 Selecting this option causes printk() to add a caller "thread id" (if
26 in task context) or a caller "processor id" (if not in task context)
27 to every message.
28
29 This option is intended for environments where multiple threads
30 concurrently call printk() for many times, for it is difficult to
31 interpret without knowing where these lines (or sometimes individual
32 line which was divided into multiple lines due to race) came from.
33
34 Since toggling after boot makes the code racy, currently there is
35 no option to enable/disable at the kernel command line parameter or
36 sysfs interface.
37
Stephen Boyd22f4e662021-07-07 18:09:17 -070038config STACKTRACE_BUILD_ID
39 bool "Show build ID information in stacktraces"
40 depends on PRINTK
41 help
42 Selecting this option adds build ID information for symbols in
43 stacktraces printed with the printk format '%p[SR]b'.
44
45 This option is intended for distros where debuginfo is not easily
46 accessible but can be downloaded given the build ID of the vmlinux or
47 kernel module where the function is located.
48
Olof Johanssona8cfdc62016-12-12 16:45:56 -080049config CONSOLE_LOGLEVEL_DEFAULT
50 int "Default console loglevel (1-15)"
51 range 1 15
52 default "7"
53 help
54 Default loglevel to determine what will be printed on the console.
55
56 Setting a default here is equivalent to passing in loglevel=<x> in
57 the kernel bootargs. loglevel=<x> continues to override whatever
58 value is specified here as well.
59
Borislav Petkov50f4d9b2016-12-19 16:23:15 -080060 Note: This does not affect the log level of un-prefixed printk()
Olof Johanssona8cfdc62016-12-12 16:45:56 -080061 usage in the kernel. That is controlled by the MESSAGE_LOGLEVEL_DEFAULT
62 option.
63
Hans de Goede22eceb82018-06-19 13:57:26 +020064config CONSOLE_LOGLEVEL_QUIET
65 int "quiet console loglevel (1-15)"
66 range 1 15
67 default "4"
68 help
69 loglevel to use when "quiet" is passed on the kernel commandline.
70
71 When "quiet" is passed on the kernel commandline this loglevel
72 will be used as the loglevel. IOW passing "quiet" will be the
73 equivalent of passing "loglevel=<CONSOLE_LOGLEVEL_QUIET>"
74
Alex Elder42a9dc02014-08-06 16:09:01 -070075config MESSAGE_LOGLEVEL_DEFAULT
Mandeep Singh Baines5af5bcb2011-03-22 16:34:23 -070076 int "Default message log level (1-7)"
77 range 1 7
78 default "4"
79 help
80 Default log level for printk statements with no specified priority.
81
82 This was hard-coded to KERN_WARNING since at least 2.6.10 but folks
83 that are auditing their logs closely may want to set it to a lower
84 priority.
85
Olof Johanssona8cfdc62016-12-12 16:45:56 -080086 Note: This does not affect what message level gets printed on the console
87 by default. To change that, use loglevel=<x> in the kernel bootargs,
88 or pick a different CONSOLE_LOGLEVEL_DEFAULT configuration value.
89
Dave Hansen604ff0d2013-07-01 13:04:49 -070090config BOOT_PRINTK_DELAY
91 bool "Delay each boot printk message by N milliseconds"
92 depends on DEBUG_KERNEL && PRINTK && GENERIC_CALIBRATE_DELAY
93 help
94 This build option allows you to read kernel boot messages
95 by inserting a short delay after each one. The delay is
96 specified in milliseconds on the kernel command line,
97 using "boot_delay=N".
98
99 It is likely that you would also need to use "lpj=M" to preset
100 the "loops per jiffie" value.
101 See a previous boot log for the "lpj" value to use for your
102 system, and then set "lpj=M" before setting "boot_delay=N".
103 NOTE: Using this option may adversely affect SMP systems.
104 I.e., processors other than the first one may not boot up.
105 BOOT_PRINTK_DELAY also may cause LOCKUP_DETECTOR to detect
106 what it believes to be lockup conditions.
107
108config DYNAMIC_DEBUG
109 bool "Enable dynamic printk() support"
110 default n
111 depends on PRINTK
Greg Kroah-Hartman239a5792020-02-10 13:11:42 -0800112 depends on (DEBUG_FS || PROC_FS)
Orson Zhaiceabef72020-06-07 21:40:14 -0700113 select DYNAMIC_DEBUG_CORE
Dave Hansen604ff0d2013-07-01 13:04:49 -0700114 help
115
116 Compiles debug level messages into the kernel, which would not
117 otherwise be available at runtime. These messages can then be
118 enabled/disabled based on various levels of scope - per source file,
119 function, module, format string, and line number. This mechanism
120 implicitly compiles in all pr_debug() and dev_dbg() calls, which
121 enlarges the kernel text size by about 2%.
122
123 If a source file is compiled with DEBUG flag set, any
124 pr_debug() calls in it are enabled by default, but can be
125 disabled at runtime as below. Note that DEBUG flag is
126 turned on by many CONFIG_*DEBUG* options.
127
128 Usage:
129
130 Dynamic debugging is controlled via the 'dynamic_debug/control' file,
Greg Kroah-Hartman239a5792020-02-10 13:11:42 -0800131 which is contained in the 'debugfs' filesystem or procfs.
132 Thus, the debugfs or procfs filesystem must first be mounted before
133 making use of this feature.
Dave Hansen604ff0d2013-07-01 13:04:49 -0700134 We refer the control file as: <debugfs>/dynamic_debug/control. This
135 file contains a list of the debug statements that can be enabled. The
136 format for each line of the file is:
137
138 filename:lineno [module]function flags format
139
140 filename : source file of the debug statement
141 lineno : line number of the debug statement
142 module : module that contains the debug statement
143 function : function that contains the debug statement
Krzysztof Kozlowski68d4b3d2019-12-06 17:04:08 -0800144 flags : '=p' means the line is turned 'on' for printing
145 format : the format used for the debug statement
Dave Hansen604ff0d2013-07-01 13:04:49 -0700146
147 From a live system:
148
149 nullarbor:~ # cat <debugfs>/dynamic_debug/control
150 # filename:lineno [module]function flags format
151 fs/aio.c:222 [aio]__put_ioctx =_ "__put_ioctx:\040freeing\040%p\012"
152 fs/aio.c:248 [aio]ioctx_alloc =_ "ENOMEM:\040nr_events\040too\040high\012"
153 fs/aio.c:1770 [aio]sys_io_cancel =_ "calling\040cancel\012"
154
155 Example usage:
156
157 // enable the message at line 1603 of file svcsock.c
158 nullarbor:~ # echo -n 'file svcsock.c line 1603 +p' >
159 <debugfs>/dynamic_debug/control
160
161 // enable all the messages in file svcsock.c
162 nullarbor:~ # echo -n 'file svcsock.c +p' >
163 <debugfs>/dynamic_debug/control
164
165 // enable all the messages in the NFS server module
166 nullarbor:~ # echo -n 'module nfsd +p' >
167 <debugfs>/dynamic_debug/control
168
169 // enable all 12 messages in the function svc_process()
170 nullarbor:~ # echo -n 'func svc_process +p' >
171 <debugfs>/dynamic_debug/control
172
173 // disable all 12 messages in the function svc_process()
174 nullarbor:~ # echo -n 'func svc_process -p' >
175 <debugfs>/dynamic_debug/control
176
Hans Holmbergf8998c22017-03-16 09:37:32 +0100177 See Documentation/admin-guide/dynamic-debug-howto.rst for additional
178 information.
Dave Hansen604ff0d2013-07-01 13:04:49 -0700179
Orson Zhaiceabef72020-06-07 21:40:14 -0700180config DYNAMIC_DEBUG_CORE
181 bool "Enable core function of dynamic debug support"
182 depends on PRINTK
183 depends on (DEBUG_FS || PROC_FS)
184 help
185 Enable core functional support of dynamic debug. It is useful
186 when you want to tie dynamic debug to your kernel modules with
187 DYNAMIC_DEBUG_MODULE defined for each of them, especially for
188 the case of embedded system where the kernel image size is
189 sensitive for people.
190
Rasmus Villemoes57f56772019-10-15 21:07:05 +0200191config SYMBOLIC_ERRNAME
192 bool "Support symbolic error names in printf"
193 default y if PRINTK
194 help
195 If you say Y here, the kernel's printf implementation will
196 be able to print symbolic error names such as ENOSPC instead
197 of the number 28. It makes the kernel image slightly larger
198 (about 3KB), but can make the kernel logs easier to read.
199
Changbin Du2b05bb72019-12-06 17:04:03 -0800200config DEBUG_BUGVERBOSE
201 bool "Verbose BUG() reporting (adds 70K)" if DEBUG_KERNEL && EXPERT
202 depends on BUG && (GENERIC_BUG || HAVE_DEBUG_BUGVERBOSE)
203 default y
204 help
205 Say Y here to make BUG() panics output the file name and line number
206 of the BUG call as well as the EIP and oops trace. This aids
207 debugging but costs about 70-100K of memory.
208
Dave Hansen604ff0d2013-07-01 13:04:49 -0700209endmenu # "printk and dmesg options"
210
Dave Hansen6dfc0662013-07-01 13:04:46 -0700211menu "Compile-time checks and compiler options"
212
213config DEBUG_INFO
214 bool "Compile the kernel with debug info"
Linus Torvalds12b13832014-02-04 12:20:01 -0800215 depends on DEBUG_KERNEL && !COMPILE_TEST
Dave Hansen6dfc0662013-07-01 13:04:46 -0700216 help
Krzysztof Kozlowski68d4b3d2019-12-06 17:04:08 -0800217 If you say Y here the resulting kernel image will include
Dave Hansen6dfc0662013-07-01 13:04:46 -0700218 debugging info resulting in a larger kernel image.
219 This adds debug symbols to the kernel and modules (gcc -g), and
220 is needed if you intend to use kernel crashdump or binary object
221 tools like crash, kgdb, LKCD, gdb, etc on the kernel.
222 Say Y here only if you plan to debug the kernel.
223
224 If unsure, say N.
225
Sedat Dilek695afd32020-08-16 14:32:44 +0200226if DEBUG_INFO
227
Dave Hansen6dfc0662013-07-01 13:04:46 -0700228config DEBUG_INFO_REDUCED
229 bool "Reduce debugging information"
Dave Hansen6dfc0662013-07-01 13:04:46 -0700230 help
231 If you say Y here gcc is instructed to generate less debugging
232 information for structure types. This means that tools that
233 need full debugging information (like kgdb or systemtap) won't
234 be happy. But if you merely need debugging information to
235 resolve line numbers there is no loss. Advantage is that
236 build directory object sizes shrink dramatically over a full
237 DEBUG_INFO build and compile times are reduced too.
238 Only works with newer gcc versions.
239
Nick Desaulniers10e68b022020-05-26 10:18:29 -0700240config DEBUG_INFO_COMPRESSED
241 bool "Compressed debugging information"
Nick Desaulniers10e68b022020-05-26 10:18:29 -0700242 depends on $(cc-option,-gz=zlib)
Nick Desaulniers10e68b022020-05-26 10:18:29 -0700243 depends on $(ld-option,--compress-debug-sections=zlib)
244 help
245 Compress the debug information using zlib. Requires GCC 5.0+ or Clang
246 5.0+, binutils 2.26+, and zlib.
247
248 Users of dpkg-deb via scripts/package/builddeb may find an increase in
249 size of their debug .deb packages with this config set, due to the
250 debug info being compressed with zlib, then the object files being
251 recompressed with a different compression scheme. But this is still
252 preferable to setting $KDEB_COMPRESS to "none" which would be even
253 larger.
254
Andi Kleen866ced92014-07-30 20:50:18 +0200255config DEBUG_INFO_SPLIT
256 bool "Produce split debuginfo in .dwo files"
Masahiro Yamada9d937442019-02-22 16:56:09 +0900257 depends on $(cc-option,-gsplit-dwarf)
Andi Kleen866ced92014-07-30 20:50:18 +0200258 help
259 Generate debug info into separate .dwo files. This significantly
260 reduces the build directory size for builds with DEBUG_INFO,
261 because it stores the information only once on disk in .dwo
262 files instead of multiple times in object files and executables.
263 In addition the debug information is also compressed.
264
265 Requires recent gcc (4.7+) and recent gdb/binutils.
266 Any tool that packages or reads debug information would need
267 to know about the .dwo files and include them.
268 Incompatible with older versions of ccache.
269
Nick Desaulniersa66049e2021-02-05 12:22:19 -0800270choice
271 prompt "DWARF version"
Andi Kleenbfaf2dd2014-07-30 20:50:19 +0200272 help
Nick Desaulniersa66049e2021-02-05 12:22:19 -0800273 Which version of DWARF debug info to emit.
274
275config DEBUG_INFO_DWARF_TOOLCHAIN_DEFAULT
276 bool "Rely on the toolchain's implicit default DWARF version"
277 help
278 The implicit default version of DWARF debug info produced by a
279 toolchain changes over time.
280
281 This can break consumers of the debug info that haven't upgraded to
282 support newer revisions, and prevent testing newer versions, but
283 those should be less common scenarios.
284
285 If unsure, say Y.
286
287config DEBUG_INFO_DWARF4
288 bool "Generate DWARF Version 4 debuginfo"
289 help
290 Generate DWARF v4 debug info. This requires gcc 4.5+ and gdb 7.0+.
291
292 If you have consumers of DWARF debug info that are not ready for
293 newer revisions of DWARF, you may wish to choose this or have your
294 config select this.
295
Nick Desaulniers98cd6f52021-02-05 12:22:20 -0800296config DEBUG_INFO_DWARF5
297 bool "Generate DWARF Version 5 debuginfo"
Nick Desaulniersc0a5c812021-09-10 16:40:41 -0700298 depends on !CC_IS_CLANG || (CC_IS_CLANG && (AS_IS_LLVM || (AS_IS_GNU && AS_VERSION >= 23502)))
Nick Desaulniers98cd6f52021-02-05 12:22:20 -0800299 depends on !DEBUG_INFO_BTF
300 help
301 Generate DWARF v5 debug info. Requires binutils 2.35.2, gcc 5.0+ (gcc
302 5.0+ accepts the -gdwarf-5 flag but only had partial support for some
303 draft features until 7.0), and gdb 8.0+.
304
305 Changes to the structure of debug info in Version 5 allow for around
306 15-18% savings in resulting image and debug info section sizes as
307 compared to DWARF Version 4. DWARF Version 5 standardizes previous
308 extensions such as accelerators for symbol indexing and the format
309 for fission (.dwo/.dwp) files. Users may not want to select this
310 config if they rely on tooling that has not yet been updated to
311 support DWARF Version 5.
312
Nick Desaulniersa66049e2021-02-05 12:22:19 -0800313endchoice # "DWARF version"
Andi Kleenbfaf2dd2014-07-30 20:50:19 +0200314
Andrii Nakryikoe83b9f52019-04-02 09:49:50 -0700315config DEBUG_INFO_BTF
316 bool "Generate BTF typeinfo"
Slava Bacherikov7d32e692020-04-02 23:41:39 +0300317 depends on !DEBUG_INFO_SPLIT && !DEBUG_INFO_REDUCED
318 depends on !GCC_PLUGIN_RANDSTRUCT || COMPILE_TEST
Andrii Nakryikoe83b9f52019-04-02 09:49:50 -0700319 help
320 Generate deduplicated BTF type information from DWARF debug info.
321 Turning this on expects presence of pahole tool, which will convert
322 DWARF type info into equivalent deduplicated BTF type info.
323
Andrii Nakryiko5f9ae912020-11-09 17:19:30 -0800324config PAHOLE_HAS_SPLIT_BTF
325 def_bool $(success, test `$(PAHOLE) --version | sed -E 's/v([0-9]+)\.([0-9]+)/\1\2/'` -ge "119")
326
327config DEBUG_INFO_BTF_MODULES
328 def_bool y
329 depends on DEBUG_INFO_BTF && MODULES && PAHOLE_HAS_SPLIT_BTF
330 help
331 Generate compact split BTF type information for kernel modules.
332
Jan Kiszka3ee7b3f2015-02-17 13:46:36 -0800333config GDB_SCRIPTS
334 bool "Provide GDB scripts for kernel debugging"
Jan Kiszka3ee7b3f2015-02-17 13:46:36 -0800335 help
336 This creates the required links to GDB helper scripts in the
337 build directory. If you load vmlinux into gdb, the helper
338 scripts will be automatically imported by gdb as well, and
339 additional functions are available to analyze a Linux kernel
Andreas Platschek700199b02016-12-14 15:05:40 -0800340 instance. See Documentation/dev-tools/gdb-kernel-debugging.rst
341 for further details.
Jan Kiszka3ee7b3f2015-02-17 13:46:36 -0800342
Sedat Dilek695afd32020-08-16 14:32:44 +0200343endif # DEBUG_INFO
344
Andi Kleen35bb5b12008-02-22 15:15:03 +0100345config FRAME_WARN
Masahiro Yamadaa83e4ca2020-02-17 00:19:36 +0900346 int "Warn for stack frames larger than"
Andi Kleen35bb5b12008-02-22 15:15:03 +0100347 range 0 8192
Kees Cook0e07f662016-10-27 17:46:41 -0700348 default 2048 if GCC_PLUGIN_LATENT_ENTROPY
Guenter Roeck86705022021-09-24 15:43:29 -0700349 default 1536 if (!64BIT && (PARISC || XTENSA))
Helge Deller432654d2017-09-11 21:41:43 +0200350 default 1024 if (!64BIT && !PARISC)
Andi Kleen35bb5b12008-02-22 15:15:03 +0100351 default 2048 if 64BIT
352 help
353 Tell gcc to warn at build time for stack frames larger than this.
354 Setting this too low will cause a lot of warnings.
355 Setting it to 0 disables the warning.
Andi Kleen35bb5b12008-02-22 15:15:03 +0100356
Randy Dunlap99657c72009-09-18 12:49:22 -0700357config STRIP_ASM_SYMS
358 bool "Strip assembler-generated symbols during link"
359 default n
360 help
361 Strip internal assembler-generated symbols during a link (symbols
362 that look like '.Lxxx') so they don't pollute the output of
363 get_wchan() and suchlike.
364
Andi Kleen1873e872012-03-28 11:51:18 -0700365config READABLE_ASM
Krzysztof Kozlowski68d4b3d2019-12-06 17:04:08 -0800366 bool "Generate readable assembler code"
367 depends on DEBUG_KERNEL
Nick Desaulniers7d73c3e2021-08-16 13:25:01 -0700368 depends on CC_IS_GCC
Don Mullisbf4735a2006-12-10 02:18:37 -0800369 help
Krzysztof Kozlowski68d4b3d2019-12-06 17:04:08 -0800370 Disable some compiler optimizations that tend to generate human unreadable
371 assembler output. This may make the kernel slightly slower, but it helps
372 to keep kernel developers who have to stare a lot at assembler listings
373 sane.
Don Mullisbf4735a2006-12-10 02:18:37 -0800374
Masahiro Yamadae949f4c2019-06-04 19:13:59 +0900375config HEADERS_INSTALL
376 bool "Install uapi headers to usr/include"
Don Mullisbf4735a2006-12-10 02:18:37 -0800377 depends on !UML
378 help
Masahiro Yamadae949f4c2019-06-04 19:13:59 +0900379 This option will install uapi headers (headers exported to user-space)
380 into the usr/include directory for use during the kernel build.
381 This is unneeded for building the kernel itself, but needed for some
382 user-space program samples. It is also needed by some features such
383 as uapi header sanity checks.
384
Sam Ravnborg91341d42008-01-21 21:31:44 +0100385config DEBUG_SECTION_MISMATCH
386 bool "Enable full Section mismatch analysis"
Nick Desaulniers7d73c3e2021-08-16 13:25:01 -0700387 depends on CC_IS_GCC
Sam Ravnborg91341d42008-01-21 21:31:44 +0100388 help
389 The section mismatch analysis checks if there are illegal
390 references from one section to another section.
Michael Wittene809ab02011-04-17 04:08:48 +0000391 During linktime or runtime, some sections are dropped;
392 any use of code/data previously in these sections would
Sam Ravnborg91341d42008-01-21 21:31:44 +0100393 most likely result in an oops.
Michael Wittene809ab02011-04-17 04:08:48 +0000394 In the code, functions and variables are annotated with
Paul Gortmaker0db06282013-06-19 14:53:51 -0400395 __init,, etc. (see the full list in include/linux/init.h),
Geert Uytterhoevend6fbfa42008-01-30 11:13:23 +0100396 which results in the code/data being placed in specific sections.
Michael Wittene809ab02011-04-17 04:08:48 +0000397 The section mismatch analysis is always performed after a full
398 kernel build, and enabling this option causes the following
Masahiro Yamadab7dca6d2019-07-17 15:17:57 +0900399 additional step to occur:
Michael Wittene809ab02011-04-17 04:08:48 +0000400 - Add the option -fno-inline-functions-called-once to gcc commands.
401 When inlining a function annotated with __init in a non-init
402 function, we would lose the section information and thus
Sam Ravnborg91341d42008-01-21 21:31:44 +0100403 the analysis would not catch the illegal reference.
Michael Wittene809ab02011-04-17 04:08:48 +0000404 This option tells gcc to inline less (but it does result in
405 a larger kernel).
Sam Ravnborg91341d42008-01-21 21:31:44 +0100406
Nicolas Boichat47490ec2015-10-06 09:44:42 +1030407config SECTION_MISMATCH_WARN_ONLY
408 bool "Make section mismatch errors non-fatal"
409 default y
410 help
411 If you say N here, the build process will fail if there are any
412 section mismatch, instead of just throwing warnings.
413
414 If unsure, say Y.
415
Feng Tangcf536e12021-05-06 15:34:59 +0800416config DEBUG_FORCE_FUNCTION_ALIGN_64B
417 bool "Force all function address 64B aligned" if EXPERT
Feng Tang09c60542020-08-11 18:34:13 -0700418 help
419 There are cases that a commit from one domain changes the function
420 address alignment of other domains, and cause magic performance
421 bump (regression or improvement). Enable this option will help to
422 verify if the bump is caused by function alignment changes, while
423 it will slightly increase the kernel size and affect icache usage.
424
425 It is mainly for debug and performance tuning use.
426
Dave Hansen6dfc0662013-07-01 13:04:46 -0700427#
428# Select this config option from the architecture Kconfig, if it
429# is preferred to always offer frame pointers as a config
430# option on the architecture (regardless of KERNEL_DEBUG):
431#
432config ARCH_WANT_FRAME_POINTERS
433 bool
Dave Hansen6dfc0662013-07-01 13:04:46 -0700434
435config FRAME_POINTER
436 bool "Compile the kernel with frame pointers"
Arnd Bergmanna687a532018-03-07 23:30:54 +0100437 depends on DEBUG_KERNEL && (M68K || UML || SUPERH) || ARCH_WANT_FRAME_POINTERS
Dave Hansen6dfc0662013-07-01 13:04:46 -0700438 default y if (DEBUG_INFO && UML) || ARCH_WANT_FRAME_POINTERS
439 help
440 If you say Y here the resulting kernel image will be slightly
441 larger and slower, but it gives very useful debugging information
442 in case of kernel bugs. (precise oopses/stacktraces/warnings)
443
Josh Poimboeufb9ab5eb2016-02-28 22:22:42 -0600444config STACK_VALIDATION
445 bool "Compile-time stack metadata validation"
446 depends on HAVE_STACK_VALIDATION
447 default n
448 help
449 Add compile-time checks to validate stack metadata, including frame
450 pointers (if CONFIG_FRAME_POINTER is enabled). This helps ensure
451 that runtime stack traces are more reliable.
452
Josh Poimboeufee9f8fc2017-07-24 18:36:57 -0500453 This is also a prerequisite for generation of ORC unwind data, which
Josh Poimboeuf11af8472017-10-13 15:02:00 -0500454 is needed for CONFIG_UNWINDER_ORC.
Josh Poimboeufee9f8fc2017-07-24 18:36:57 -0500455
Josh Poimboeufb9ab5eb2016-02-28 22:22:42 -0600456 For more information, see
457 tools/objtool/Documentation/stack-validation.txt.
458
Peter Zijlstra6804c1a2020-03-18 13:33:54 +0100459config VMLINUX_VALIDATION
460 bool
Peter Zijlstradb2b0c52021-06-24 11:41:23 +0200461 depends on STACK_VALIDATION && DEBUG_ENTRY
Peter Zijlstra6804c1a2020-03-18 13:33:54 +0100462 default y
463
Rasmus Villemoes5cc12472021-03-05 10:27:07 +0100464config VMLINUX_MAP
465 bool "Generate vmlinux.map file when linking"
466 depends on EXPERT
467 help
468 Selecting this option will pass "-Map=vmlinux.map" to ld
469 when linking vmlinux. That file can be useful for verifying
470 and debugging magic section games, and for seeing which
471 pieces of code get eliminated with
472 CONFIG_LD_DEAD_CODE_DATA_ELIMINATION.
473
Dave Hansen6dfc0662013-07-01 13:04:46 -0700474config DEBUG_FORCE_WEAK_PER_CPU
475 bool "Force weak per-cpu definitions"
476 depends on DEBUG_KERNEL
477 help
478 s390 and alpha require percpu variables in modules to be
479 defined weak to work around addressing range issue which
480 puts the following two restrictions on percpu variable
481 definitions.
482
483 1. percpu symbols must be unique whether static or not
484 2. percpu variables can't be defined inside a function
485
486 To ensure that generic code follows the above rules, this
487 option forces all percpu variables to be defined as weak.
488
489endmenu # "Compiler options"
490
Changbin Du6210b642019-12-06 17:03:42 -0800491menu "Generic Kernel Debugging Instruments"
492
Dave Hansen6dfc0662013-07-01 13:04:46 -0700493config MAGIC_SYSRQ
494 bool "Magic SysRq key"
495 depends on !UML
496 help
497 If you say Y here, you will have some control over the system even
498 if the system crashes for example during kernel debugging (e.g., you
499 will be able to flush the buffer cache to disk, reboot the system
500 immediately or dump some status information). This is accomplished
501 by pressing various keys while holding SysRq (Alt+PrintScreen). It
502 also works on a serial console (on PC hardware at least), if you
503 send a BREAK and then within 5 seconds a command keypress. The
Hans Holmbergf8998c22017-03-16 09:37:32 +0100504 keys are documented in <file:Documentation/admin-guide/sysrq.rst>.
505 Don't say Y unless you really know what this hack does.
Dave Hansen6dfc0662013-07-01 13:04:46 -0700506
Ben Hutchings8eaede42013-10-07 01:05:46 +0100507config MAGIC_SYSRQ_DEFAULT_ENABLE
508 hex "Enable magic SysRq key functions by default"
509 depends on MAGIC_SYSRQ
510 default 0x1
511 help
512 Specifies which SysRq key functions are enabled by default.
513 This may be set to 1 or 0 to enable or disable them all, or
Hans Holmbergf8998c22017-03-16 09:37:32 +0100514 to a bitmask as described in Documentation/admin-guide/sysrq.rst.
Ben Hutchings8eaede42013-10-07 01:05:46 +0100515
Felix Fietkau732dbf32016-12-22 08:31:34 +0100516config MAGIC_SYSRQ_SERIAL
517 bool "Enable magic SysRq key over serial"
518 depends on MAGIC_SYSRQ
519 default y
520 help
521 Many embedded boards have a disconnected TTL level serial which can
522 generate some garbage that can lead to spurious false sysrq detects.
523 This option allows you to decide whether you want to enable the
524 magic SysRq key.
525
Dmitry Safonov68af4312020-03-02 17:51:35 +0000526config MAGIC_SYSRQ_SERIAL_SEQUENCE
527 string "Char sequence that enables magic SysRq over serial"
528 depends on MAGIC_SYSRQ_SERIAL
529 default ""
530 help
531 Specifies a sequence of characters that can follow BREAK to enable
532 SysRq on a serial console.
533
Dmitry Safonovd3394b32020-03-06 15:31:56 +0000534 If unsure, leave an empty string and the option will not be enabled.
535
Changbin Duec29a5c2019-12-06 17:04:06 -0800536config DEBUG_FS
537 bool "Debug Filesystem"
538 help
539 debugfs is a virtual file system that kernel developers use to put
540 debugging files into. Enable this option to be able to read and
541 write to these files.
542
543 For detailed documentation on the debugfs API, see
544 Documentation/filesystems/.
545
546 If unsure, say N.
547
Peter Enderborga24c6f72020-07-16 09:15:11 +0200548choice
549 prompt "Debugfs default access"
550 depends on DEBUG_FS
551 default DEBUG_FS_ALLOW_ALL
552 help
553 This selects the default access restrictions for debugfs.
554 It can be overridden with kernel command line option
555 debugfs=[on,no-mount,off]. The restrictions apply for API access
556 and filesystem registration.
557
558config DEBUG_FS_ALLOW_ALL
559 bool "Access normal"
560 help
561 No restrictions apply. Both API and filesystem registration
562 is on. This is the normal default operation.
563
564config DEBUG_FS_DISALLOW_MOUNT
565 bool "Do not register debugfs as filesystem"
566 help
567 The API is open but filesystem is not loaded. Clients can still do
568 their work and read with debug tools that do not need
569 debugfs filesystem.
570
571config DEBUG_FS_ALLOW_NONE
572 bool "No access"
573 help
574 Access is off. Clients get -PERM when trying to create nodes in
575 debugfs tree and debugfs is not registered as a filesystem.
576 Client can then back-off or continue without debugfs access.
577
578endchoice
579
Changbin Du6210b642019-12-06 17:03:42 -0800580source "lib/Kconfig.kgdb"
Changbin Du6210b642019-12-06 17:03:42 -0800581source "lib/Kconfig.ubsan"
Changbin Du2645d432020-09-18 21:20:42 -0700582source "lib/Kconfig.kcsan"
Changbin Du6210b642019-12-06 17:03:42 -0800583
584endmenu
585
Adrian Bunkf346f4b2006-01-09 20:54:51 -0800586config DEBUG_KERNEL
587 bool "Kernel debugging"
588 help
589 Say Y here if you are developing drivers or trying to debug and
590 identify kernel problems.
591
Sinan Kayac66d7a22019-05-14 15:44:00 -0700592config DEBUG_MISC
593 bool "Miscellaneous debug code"
594 default DEBUG_KERNEL
595 depends on DEBUG_KERNEL
596 help
597 Say Y here if you need to enable miscellaneous debug code that should
598 be under a more specific debug option but isn't.
599
600
Dave Hansen0610c8a2013-07-01 13:04:43 -0700601menu "Memory Debugging"
David Woodhousea304e1b2007-02-12 00:52:00 -0800602
Masahiro Yamada8636a1f2018-12-11 20:01:04 +0900603source "mm/Kconfig.debug"
Ingo Molnar82f67cd2007-02-16 01:28:13 -0800604
Thomas Gleixner3ac7fe52008-04-30 00:55:01 -0700605config DEBUG_OBJECTS
606 bool "Debug object operations"
607 depends on DEBUG_KERNEL
608 help
609 If you say Y here, additional code will be inserted into the
610 kernel to track the life time of various objects and validate
611 the operations on those objects.
612
613config DEBUG_OBJECTS_SELFTEST
614 bool "Debug objects selftest"
615 depends on DEBUG_OBJECTS
616 help
617 This enables the selftest of the object debug code.
618
619config DEBUG_OBJECTS_FREE
620 bool "Debug objects in freed memory"
621 depends on DEBUG_OBJECTS
622 help
623 This enables checks whether a k/v free operation frees an area
624 which contains an object which has not been deactivated
625 properly. This can make kmalloc/kfree-intensive workloads
626 much slower.
627
Thomas Gleixnerc6f3a972008-04-30 00:55:03 -0700628config DEBUG_OBJECTS_TIMERS
629 bool "Debug timer objects"
630 depends on DEBUG_OBJECTS
631 help
632 If you say Y here, additional code will be inserted into the
633 timer routines to track the life time of timer objects and
634 validate the timer operations.
635
Thomas Gleixnerdc186ad2009-11-16 01:09:48 +0900636config DEBUG_OBJECTS_WORK
637 bool "Debug work objects"
638 depends on DEBUG_OBJECTS
639 help
640 If you say Y here, additional code will be inserted into the
641 work queue routines to track the life time of work objects and
642 validate the work operations.
643
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -0400644config DEBUG_OBJECTS_RCU_HEAD
645 bool "Debug RCU callbacks objects"
Mathieu Desnoyersfc2ecf72011-02-23 09:42:14 -0800646 depends on DEBUG_OBJECTS
Mathieu Desnoyers551d55a2010-04-17 08:48:42 -0400647 help
648 Enable this to turn on debugging of RCU list heads (call_rcu() usage).
649
Tejun Heoe2852ae2010-10-26 14:23:05 -0700650config DEBUG_OBJECTS_PERCPU_COUNTER
651 bool "Debug percpu counter objects"
652 depends on DEBUG_OBJECTS
653 help
654 If you say Y here, additional code will be inserted into the
655 percpu counter routines to track the life time of percpu counter
656 objects and validate the percpu counter operations.
657
Ingo Molnar3ae70202008-11-26 10:02:00 +0100658config DEBUG_OBJECTS_ENABLE_DEFAULT
659 int "debug_objects bootup default value (0-1)"
Krzysztof Kozlowski68d4b3d2019-12-06 17:04:08 -0800660 range 0 1
661 default "1"
662 depends on DEBUG_OBJECTS
663 help
664 Debug objects boot parameter default value
Ingo Molnar3ae70202008-11-26 10:02:00 +0100665
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666config DEBUG_SLAB
Andrew Morton4a2f0ac2006-03-25 03:07:22 -0800667 bool "Debug slab memory allocations"
Levin, Alexander (Sasha Levin)4675ff02017-11-15 17:36:02 -0800668 depends on DEBUG_KERNEL && SLAB
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 help
670 Say Y here to have the kernel do limited verification on memory
671 allocation as well as poisoning memory on free to catch use of freed
672 memory. This can make kmalloc/kfree-intensive workloads much slower.
673
Christoph Lameterf0630ff2007-07-15 23:38:14 -0700674config SLUB_DEBUG_ON
675 bool "SLUB debugging on by default"
Levin, Alexander (Sasha Levin)4675ff02017-11-15 17:36:02 -0800676 depends on SLUB && SLUB_DEBUG
Christoph Lameterf0630ff2007-07-15 23:38:14 -0700677 default n
678 help
679 Boot with debugging on by default. SLUB boots by default with
680 the runtime debug capabilities switched off. Enabling this is
681 equivalent to specifying the "slub_debug" parameter on boot.
682 There is no support for more fine grained debug control like
683 possible with slub_debug=xxx. SLUB debugging may be switched
684 off in a kernel built with CONFIG_SLUB_DEBUG_ON by specifying
685 "slub_debug=-".
686
Christoph Lameter8ff12cf2008-02-07 17:47:41 -0800687config SLUB_STATS
688 default n
689 bool "Enable SLUB performance statistics"
Christoph Lameterab4d5ed2010-10-05 13:57:26 -0500690 depends on SLUB && SYSFS
Christoph Lameter8ff12cf2008-02-07 17:47:41 -0800691 help
692 SLUB statistics are useful to debug SLUBs allocation behavior in
693 order find ways to optimize the allocator. This should never be
694 enabled for production use since keeping statistics slows down
695 the allocator by a few percentage points. The slabinfo command
696 supports the determination of the most active slabs to figure
697 out which slabs are relevant to a particular load.
698 Try running: slabinfo -DA
699
Catalin Marinasb69ec422012-10-08 16:28:11 -0700700config HAVE_DEBUG_KMEMLEAK
701 bool
702
Catalin Marinas3bba00d2009-06-11 13:24:13 +0100703config DEBUG_KMEMLEAK
704 bool "Kernel memory leak detector"
Kees Cook525c1f92013-01-16 18:54:16 -0800705 depends on DEBUG_KERNEL && HAVE_DEBUG_KMEMLEAK
Catalin Marinas79e0d9b2011-04-27 17:06:19 +0100706 select DEBUG_FS
Catalin Marinas3bba00d2009-06-11 13:24:13 +0100707 select STACKTRACE if STACKTRACE_SUPPORT
708 select KALLSYMS
Randy Dunlapb60e26a2009-11-06 15:33:45 -0800709 select CRC32
Catalin Marinas3bba00d2009-06-11 13:24:13 +0100710 help
711 Say Y here if you want to enable the memory leak
712 detector. The memory allocation/freeing is traced in a way
713 similar to the Boehm's conservative garbage collector, the
714 difference being that the orphan objects are not freed but
715 only shown in /sys/kernel/debug/kmemleak. Enabling this
716 feature will introduce an overhead to memory
Andreas Platschek700199b02016-12-14 15:05:40 -0800717 allocations. See Documentation/dev-tools/kmemleak.rst for more
Catalin Marinas3bba00d2009-06-11 13:24:13 +0100718 details.
719
Catalin Marinasbf96d1e2009-06-23 14:40:27 +0100720 Enabling DEBUG_SLAB or SLUB_DEBUG may increase the chances
721 of finding leaks due to the slab objects poisoning.
722
Catalin Marinas3bba00d2009-06-11 13:24:13 +0100723 In order to access the kmemleak file, debugfs needs to be
724 mounted (usually at /sys/kernel/debug).
725
Catalin Marinasc5665862019-09-23 15:34:05 -0700726config DEBUG_KMEMLEAK_MEM_POOL_SIZE
727 int "Kmemleak memory pool size"
Catalin Marinasa9d90582009-06-25 10:16:11 +0100728 depends on DEBUG_KMEMLEAK
Qian Caic59180a2019-09-23 15:34:10 -0700729 range 200 1000000
Nicolas Boichatb751c522019-09-23 15:33:55 -0700730 default 16000
Catalin Marinasa9d90582009-06-25 10:16:11 +0100731 help
732 Kmemleak must track all the memory allocations to avoid
733 reporting false positives. Since memory may be allocated or
Catalin Marinasc5665862019-09-23 15:34:05 -0700734 freed before kmemleak is fully initialised, use a static pool
735 of metadata objects to track such callbacks. After kmemleak is
736 fully initialised, this memory pool acts as an emergency one
737 if slab allocations fail.
Catalin Marinasa9d90582009-06-25 10:16:11 +0100738
Catalin Marinas0822ee42009-06-11 13:24:14 +0100739config DEBUG_KMEMLEAK_TEST
740 tristate "Simple test for the kernel memory leak detector"
Daniel Baluta97182692011-04-04 15:06:44 -0700741 depends on DEBUG_KMEMLEAK && m
Catalin Marinas0822ee42009-06-11 13:24:14 +0100742 help
Daniel Baluta97182692011-04-04 15:06:44 -0700743 This option enables a module that explicitly leaks memory.
Catalin Marinas0822ee42009-06-11 13:24:14 +0100744
745 If unsure, say N.
746
Jason Baronab0155a2010-07-19 11:54:17 +0100747config DEBUG_KMEMLEAK_DEFAULT_OFF
748 bool "Default kmemleak to off"
749 depends on DEBUG_KMEMLEAK
750 help
751 Say Y here to disable kmemleak by default. It can then be enabled
752 on the command line via kmemleak=on.
753
Sri Krishna chowdaryd53ce042018-12-28 00:38:54 -0800754config DEBUG_KMEMLEAK_AUTO_SCAN
755 bool "Enable kmemleak auto scan thread on boot up"
756 default y
757 depends on DEBUG_KMEMLEAK
758 help
759 Depending on the cpu, kmemleak scan may be cpu intensive and can
760 stall user tasks at times. This option enables/disables automatic
761 kmemleak scan at boot up.
762
763 Say N here to disable kmemleak auto scan thread to stop automatic
764 scanning. Disabling this option disables automatic reporting of
765 memory leaks.
766
767 If unsure, say Y.
768
Dave Hansen0610c8a2013-07-01 13:04:43 -0700769config DEBUG_STACK_USAGE
770 bool "Stack utilization instrumentation"
Helge Deller6c31da32016-03-19 17:54:10 +0100771 depends on DEBUG_KERNEL && !IA64
Dave Hansen0610c8a2013-07-01 13:04:43 -0700772 help
773 Enables the display of the minimum amount of free stack which each
774 task has ever had available in the sysrq-T and sysrq-P debug output.
775
776 This option will slow down process creation somewhat.
777
Changbin Dudc9b9632019-12-06 17:03:57 -0800778config SCHED_STACK_END_CHECK
779 bool "Detect stack corruption on calls to schedule()"
780 depends on DEBUG_KERNEL
781 default n
782 help
783 This option checks for a stack overrun on calls to schedule().
784 If the stack end location is found to be over written always panic as
785 the content of the corrupted region can no longer be trusted.
786 This is to ensure no erroneous behaviour occurs which could result in
787 data corruption or a sporadic crash at a later stage once the region
788 is examined. The runtime overhead introduced is minimal.
789
Anshuman Khandual399145f2020-06-04 16:47:15 -0700790config ARCH_HAS_DEBUG_VM_PGTABLE
791 bool
792 help
793 An architecture should select this when it can successfully
794 build and run DEBUG_VM_PGTABLE.
795
Dave Hansen0610c8a2013-07-01 13:04:43 -0700796config DEBUG_VM
797 bool "Debug VM"
798 depends on DEBUG_KERNEL
799 help
800 Enable this to turn on extended checks in the virtual-memory system
Krzysztof Kozlowski68d4b3d2019-12-06 17:04:08 -0800801 that may impact performance.
Dave Hansen0610c8a2013-07-01 13:04:43 -0700802
803 If unsure, say N.
804
Davidlohr Bueso4f115142014-06-04 16:06:46 -0700805config DEBUG_VM_VMACACHE
806 bool "Debug VMA caching"
807 depends on DEBUG_VM
808 help
809 Enable this to turn on VMA caching debug information. Doing so
810 can cause significant overhead, so only enable it in non-production
811 environments.
812
813 If unsure, say N.
814
Dave Hansen0610c8a2013-07-01 13:04:43 -0700815config DEBUG_VM_RB
816 bool "Debug VM red-black trees"
817 depends on DEBUG_VM
818 help
Davidlohr Buesoa663dad2014-04-18 15:07:22 -0700819 Enable VM red-black tree debugging information and extra validations.
Dave Hansen0610c8a2013-07-01 13:04:43 -0700820
821 If unsure, say N.
822
Kirill A. Shutemov95ad9752016-01-15 16:51:21 -0800823config DEBUG_VM_PGFLAGS
824 bool "Debug page-flags operations"
825 depends on DEBUG_VM
826 help
827 Enables extra validation on page flags operations.
828
829 If unsure, say N.
830
Anshuman Khandual399145f2020-06-04 16:47:15 -0700831config DEBUG_VM_PGTABLE
832 bool "Debug arch page table for semantics compliance"
833 depends on MMU
834 depends on ARCH_HAS_DEBUG_VM_PGTABLE
835 default y if DEBUG_VM
836 help
837 This option provides a debug method which can be used to test
838 architecture page table helper functions on various platforms in
839 verifying if they comply with expected generic MM semantics. This
840 will help architecture code in making sure that any changes or
841 new additions of these helpers still conform to expected
842 semantics of the generic MM. Platforms will have to opt in for
843 this through ARCH_HAS_DEBUG_VM_PGTABLE.
844
845 If unsure, say N.
846
Laura Abbottfa5b6ec2017-01-10 13:35:40 -0800847config ARCH_HAS_DEBUG_VIRTUAL
848 bool
849
Dave Hansen0610c8a2013-07-01 13:04:43 -0700850config DEBUG_VIRTUAL
851 bool "Debug VM translations"
Laura Abbottfa5b6ec2017-01-10 13:35:40 -0800852 depends on DEBUG_KERNEL && ARCH_HAS_DEBUG_VIRTUAL
Dave Hansen0610c8a2013-07-01 13:04:43 -0700853 help
854 Enable some costly sanity checks in virtual to page code. This can
855 catch mistakes with virt_to_page() and friends.
856
857 If unsure, say N.
858
859config DEBUG_NOMMU_REGIONS
860 bool "Debug the global anon/private NOMMU mapping region tree"
861 depends on DEBUG_KERNEL && !MMU
862 help
863 This option causes the global tree of anonymous and private mapping
864 regions to be regularly checked for invalid topology.
865
866config DEBUG_MEMORY_INIT
867 bool "Debug memory initialisation" if EXPERT
868 default !EXPERT
869 help
870 Enable this for additional checks during memory initialisation.
871 The sanity checks verify aspects of the VM such as the memory model
872 and other information provided by the architecture. Verbose
873 information will be printed at KERN_DEBUG loglevel depending
874 on the mminit_loglevel= command-line option.
875
876 If unsure, say Y
877
878config MEMORY_NOTIFIER_ERROR_INJECT
879 tristate "Memory hotplug notifier error injection module"
David Hildenbrand50f94812021-11-05 13:44:24 -0700880 depends on MEMORY_HOTPLUG && NOTIFIER_ERROR_INJECTION
Dave Hansen0610c8a2013-07-01 13:04:43 -0700881 help
882 This option provides the ability to inject artificial errors to
883 memory hotplug notifier chain callbacks. It is controlled through
884 debugfs interface under /sys/kernel/debug/notifier-error-inject/memory
885
886 If the notifier call chain should be failed with some events
887 notified, write the error code to "actions/<notifier event>/error".
888
889 Example: Inject memory hotplug offline error (-12 == -ENOMEM)
890
891 # cd /sys/kernel/debug/notifier-error-inject/memory
892 # echo -12 > actions/MEM_GOING_OFFLINE/error
893 # echo offline > /sys/devices/system/memory/memoryXXX/state
894 bash: echo: write error: Cannot allocate memory
895
896 To compile this code as a module, choose M here: the module will
897 be called memory-notifier-error-inject.
898
899 If unsure, say N.
900
901config DEBUG_PER_CPU_MAPS
902 bool "Debug access to per_cpu maps"
903 depends on DEBUG_KERNEL
904 depends on SMP
905 help
906 Say Y to verify that the per_cpu map being accessed has
907 been set up. This adds a fair amount of code to kernel memory
908 and decreases performance.
909
910 Say N if unsure.
911
Thomas Gleixner6e799cb2020-11-18 20:48:39 +0100912config DEBUG_KMAP_LOCAL
913 bool "Debug kmap_local temporary mappings"
914 depends on DEBUG_KERNEL && KMAP_LOCAL
915 help
916 This option enables additional error checking for the kmap_local
917 infrastructure. Disable for production use.
918
Thomas Gleixner0e91a0c2020-11-18 20:48:40 +0100919config ARCH_SUPPORTS_KMAP_LOCAL_FORCE_MAP
920 bool
921
922config DEBUG_KMAP_LOCAL_FORCE_MAP
923 bool "Enforce kmap_local temporary mappings"
924 depends on DEBUG_KERNEL && ARCH_SUPPORTS_KMAP_LOCAL_FORCE_MAP
925 select KMAP_LOCAL
926 select DEBUG_KMAP_LOCAL
927 help
928 This option enforces temporary mappings through the kmap_local
929 mechanism for non-highmem pages and on non-highmem systems.
930 Disable this for production systems!
931
Dave Hansen0610c8a2013-07-01 13:04:43 -0700932config DEBUG_HIGHMEM
933 bool "Highmem debugging"
934 depends on DEBUG_KERNEL && HIGHMEM
Thomas Gleixner0e91a0c2020-11-18 20:48:40 +0100935 select DEBUG_KMAP_LOCAL_FORCE_MAP if ARCH_SUPPORTS_KMAP_LOCAL_FORCE_MAP
Thomas Gleixner6e799cb2020-11-18 20:48:39 +0100936 select DEBUG_KMAP_LOCAL
Dave Hansen0610c8a2013-07-01 13:04:43 -0700937 help
Geert Uytterhoevenb1357c92014-04-14 18:55:50 +0200938 This option enables additional error checking for high memory
939 systems. Disable for production systems.
Dave Hansen0610c8a2013-07-01 13:04:43 -0700940
941config HAVE_DEBUG_STACKOVERFLOW
942 bool
943
944config DEBUG_STACKOVERFLOW
945 bool "Check for stack overflows"
946 depends on DEBUG_KERNEL && HAVE_DEBUG_STACKOVERFLOW
Masahiro Yamadaa7f7f622020-06-14 01:50:22 +0900947 help
Dave Hansen0610c8a2013-07-01 13:04:43 -0700948 Say Y here if you want to check for overflows of kernel, IRQ
Borislav Petkovedb0ec02015-01-25 19:50:34 +0100949 and exception stacks (if your architecture uses them). This
Dave Hansen0610c8a2013-07-01 13:04:43 -0700950 option will show detailed messages if free stack space drops
951 below a certain limit.
952
953 These kinds of bugs usually occur when call-chains in the
954 kernel get too deep, especially when interrupts are
955 involved.
956
957 Use this in cases where you see apparently random memory
958 corruption, especially if it appears in 'struct thread_info'
959
960 If in doubt, say "N".
961
Andrey Ryabinin0b24bec2015-02-13 14:39:17 -0800962source "lib/Kconfig.kasan"
Alexander Potapenko0ce20dd2021-02-25 17:18:53 -0800963source "lib/Kconfig.kfence"
Andrey Ryabinin0b24bec2015-02-13 14:39:17 -0800964
Dave Hansen0610c8a2013-07-01 13:04:43 -0700965endmenu # "Memory Debugging"
966
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967config DEBUG_SHIRQ
968 bool "Debug shared IRQ handlers"
Martin Schwidefsky0244ad02013-08-30 09:39:53 +0200969 depends on DEBUG_KERNEL
Linus Torvalds1da177e2005-04-16 15:20:36 -0700970 help
Wolfram Sang0a2fae22020-07-03 00:20:24 +0200971 Enable this to generate a spurious interrupt just before a shared
972 interrupt handler is deregistered (generating one when registering
973 is currently disabled). Drivers need to handle this correctly. Some
974 don't and need to be caught.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700975
Changbin Duf43a2892019-12-06 17:03:54 -0800976menu "Debug Oops, Lockups and Hangs"
977
978config PANIC_ON_OOPS
979 bool "Panic on Oops"
980 help
981 Say Y here to enable the kernel to panic when it oopses. This
982 has the same effect as setting oops=panic on the kernel command
983 line.
984
985 This feature is useful to ensure that the kernel does not do
986 anything erroneous after an oops which could result in data
987 corruption or other issues.
988
989 Say N if unsure.
990
991config PANIC_ON_OOPS_VALUE
992 int
993 range 0 1
994 default 0 if !PANIC_ON_OOPS
995 default 1 if PANIC_ON_OOPS
996
997config PANIC_TIMEOUT
998 int "panic timeout"
999 default 0
1000 help
Tiezhu Yang9d5b1342020-08-11 18:36:49 -07001001 Set the timeout value (in seconds) until a reboot occurs when
Changbin Duf43a2892019-12-06 17:03:54 -08001002 the kernel panics. If n = 0, then we wait forever. A timeout
1003 value n > 0 will wait n seconds before rebooting, while a timeout
1004 value n < 0 will reboot immediately.
Dave Hansen92aef8fb2013-07-01 13:04:50 -07001005
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006config LOCKUP_DETECTOR
Nicholas Piggin05a4a952017-07-12 14:35:46 -07001007 bool
1008
1009config SOFTLOCKUP_DETECTOR
1010 bool "Detect Soft Lockups"
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011 depends on DEBUG_KERNEL && !S390
Nicholas Piggin05a4a952017-07-12 14:35:46 -07001012 select LOCKUP_DETECTOR
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013 help
1014 Say Y here to enable the kernel to act as a watchdog to detect
Nicholas Piggin05a4a952017-07-12 14:35:46 -07001015 soft lockups.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016
1017 Softlockups are bugs that cause the kernel to loop in kernel
1018 mode for more than 20 seconds, without giving other tasks a
1019 chance to run. The current stack trace is displayed upon
1020 detection and the system will stay locked up.
1021
Randy Dunlap5f00ae02018-04-10 16:32:51 -07001022config BOOTPARAM_SOFTLOCKUP_PANIC
1023 bool "Panic (Reboot) On Soft Lockups"
1024 depends on SOFTLOCKUP_DETECTOR
1025 help
1026 Say Y here to enable the kernel to panic on "soft lockups",
1027 which are bugs that cause the kernel to loop in kernel
1028 mode for more than 20 seconds (configurable using the watchdog_thresh
1029 sysctl), without giving other tasks a chance to run.
1030
1031 The panic can be used in combination with panic_timeout,
1032 to cause the system to reboot automatically after a
1033 lockup has been detected. This feature is useful for
1034 high-availability systems that have uptime guarantees and
1035 where a lockup must be resolved ASAP.
1036
1037 Say N if unsure.
1038
1039config BOOTPARAM_SOFTLOCKUP_PANIC_VALUE
1040 int
1041 depends on SOFTLOCKUP_DETECTOR
1042 range 0 1
1043 default 0 if !BOOTPARAM_SOFTLOCKUP_PANIC
1044 default 1 if BOOTPARAM_SOFTLOCKUP_PANIC
1045
Nicholas Piggin05a4a952017-07-12 14:35:46 -07001046config HARDLOCKUP_DETECTOR_PERF
1047 bool
1048 select SOFTLOCKUP_DETECTOR
1049
1050#
Thomas Gleixner7edaeb62017-08-15 09:50:13 +02001051# Enables a timestamp based low pass filter to compensate for perf based
1052# hard lockup detection which runs too fast due to turbo modes.
1053#
1054config HARDLOCKUP_CHECK_TIMESTAMP
1055 bool
1056
1057#
Nicholas Piggin05a4a952017-07-12 14:35:46 -07001058# arch/ can define HAVE_HARDLOCKUP_DETECTOR_ARCH to provide their own hard
1059# lockup detector rather than the perf based detector.
1060#
1061config HARDLOCKUP_DETECTOR
1062 bool "Detect Hard Lockups"
1063 depends on DEBUG_KERNEL && !S390
1064 depends on HAVE_HARDLOCKUP_DETECTOR_PERF || HAVE_HARDLOCKUP_DETECTOR_ARCH
1065 select LOCKUP_DETECTOR
1066 select HARDLOCKUP_DETECTOR_PERF if HAVE_HARDLOCKUP_DETECTOR_PERF
Nicholas Piggin05a4a952017-07-12 14:35:46 -07001067 help
1068 Say Y here to enable the kernel to act as a watchdog to detect
1069 hard lockups.
1070
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 Hardlockups are bugs that cause the CPU to loop in kernel mode
1072 for more than 10 seconds, without letting other interrupts have a
1073 chance to run. The current stack trace is displayed upon detection
1074 and the system will stay locked up.
1075
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076config BOOTPARAM_HARDLOCKUP_PANIC
1077 bool "Panic (Reboot) On Hard Lockups"
1078 depends on HARDLOCKUP_DETECTOR
1079 help
1080 Say Y here to enable the kernel to panic on "hard lockups",
1081 which are bugs that cause the kernel to loop in kernel
1082 mode with interrupts disabled for more than 10 seconds (configurable
1083 using the watchdog_thresh sysctl).
1084
1085 Say N if unsure.
1086
1087config BOOTPARAM_HARDLOCKUP_PANIC_VALUE
1088 int
1089 depends on HARDLOCKUP_DETECTOR
1090 range 0 1
1091 default 0 if !BOOTPARAM_HARDLOCKUP_PANIC
1092 default 1 if BOOTPARAM_HARDLOCKUP_PANIC
1093
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094config DETECT_HUNG_TASK
1095 bool "Detect Hung Tasks"
1096 depends on DEBUG_KERNEL
Nicholas Piggin05a4a952017-07-12 14:35:46 -07001097 default SOFTLOCKUP_DETECTOR
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 help
1099 Say Y here to enable the kernel to detect "hung tasks",
1100 which are bugs that cause the task to be stuck in
Vivien Didelot96b03ab2016-09-22 16:55:13 -04001101 uninterruptible "D" state indefinitely.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001102
1103 When a hung task is detected, the kernel will print the
1104 current stack trace (which you should report), but the
1105 task will stay in uninterruptible state. If lockdep is
1106 enabled then all held locks will also be reported. This
1107 feature has negligible overhead.
Al Viro871751e2006-03-25 03:06:39 -08001108
1109config DEFAULT_HUNG_TASK_TIMEOUT
1110 int "Default timeout for hung task detection (in seconds)"
1111 depends on DETECT_HUNG_TASK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 default 120
1113 help
Ingo Molnar8637c092006-07-03 00:24:38 -07001114 This option controls the default timeout (in seconds) used
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 to determine when a task has become non-responsive and should
1116 be considered hung.
1117
1118 It can be adjusted at runtime via the kernel.hung_task_timeout_secs
1119 sysctl or by writing a value to
1120 /proc/sys/kernel/hung_task_timeout_secs.
1121
Ingo Molnare7eebaf2006-06-27 02:54:55 -07001122 A timeout of 0 disables the check. The default is two minutes.
1123 Keeping the default should be fine in most cases.
Ingo Molnare7eebaf2006-06-27 02:54:55 -07001124
1125config BOOTPARAM_HUNG_TASK_PANIC
1126 bool "Panic (Reboot) On Hung Tasks"
1127 depends on DETECT_HUNG_TASK
1128 help
1129 Say Y here to enable the kernel to panic on "hung tasks",
1130 which are bugs that cause the kernel to leave a task stuck
1131 in uninterruptible "D" state.
1132
1133 The panic can be used in combination with panic_timeout,
Thomas Gleixner61a87122006-06-27 02:54:56 -07001134 to cause the system to reboot automatically after a
1135 hung task has been detected. This feature is useful for
Roman Zippela1583d32006-06-27 02:55:00 -07001136 high-availability systems that have uptime guarantees and
Thomas Gleixner61a87122006-06-27 02:54:56 -07001137 where a hung tasks must be resolved ASAP.
1138
1139 Say N if unsure.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140
Hugh Dickins048c8bc2006-11-01 05:44:54 +11001141config BOOTPARAM_HUNG_TASK_PANIC_VALUE
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 int
1143 depends on DETECT_HUNG_TASK
1144 range 0 1
1145 default 0 if !BOOTPARAM_HUNG_TASK_PANIC
1146 default 1 if BOOTPARAM_HUNG_TASK_PANIC
1147
Tejun Heo82607adc2015-12-08 11:28:04 -05001148config WQ_WATCHDOG
1149 bool "Detect Workqueue Stalls"
1150 depends on DEBUG_KERNEL
1151 help
1152 Say Y here to enable stall detection on workqueues. If a
1153 worker pool doesn't make forward progress on a pending work
1154 item for over a given amount of time, 30s by default, a
1155 warning message is printed along with dump of workqueue
1156 state. This can be configured through kernel parameter
1157 "workqueue.watchdog_thresh" and its sysfs counterpart.
1158
Konstantin Khlebnikov30428ef2020-04-06 20:09:47 -07001159config TEST_LOCKUP
1160 tristate "Test module to generate lockups"
Tiezhu Yang63646bc2020-08-11 18:34:44 -07001161 depends on m
Konstantin Khlebnikov30428ef2020-04-06 20:09:47 -07001162 help
1163 This builds the "test_lockup" module that helps to make sure
1164 that watchdogs and lockup detectors are working properly.
1165
1166 Depending on module parameters it could emulate soft or hard
1167 lockup, "hung task", or locking arbitrary lock for a long time.
1168 Also it could generate series of lockups with cooling-down periods.
1169
1170 If unsure, say N.
1171
Dave Hansen92aef8fb2013-07-01 13:04:50 -07001172endmenu # "Debug lockups and hangs"
1173
Changbin Duebebdd02019-12-06 17:04:00 -08001174menu "Scheduler Debugging"
Jason Baron5800dc32013-11-25 23:23:04 +00001175
Linus Torvalds1da177e2005-04-16 15:20:36 -07001176config SCHED_DEBUG
1177 bool "Collect scheduler debugging info"
1178 depends on DEBUG_KERNEL && PROC_FS
1179 default y
1180 help
1181 If you say Y here, the /proc/sched_debug file will be provided
1182 that can help debug the scheduler. The runtime overhead of this
1183 option is minimal.
1184
Naveen N. Raof6db8342015-06-25 23:53:37 +05301185config SCHED_INFO
1186 bool
1187 default n
1188
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189config SCHEDSTATS
1190 bool "Collect scheduler statistics"
1191 depends on DEBUG_KERNEL && PROC_FS
Naveen N. Raof6db8342015-06-25 23:53:37 +05301192 select SCHED_INFO
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 help
1194 If you say Y here, additional code will be inserted into the
1195 scheduler and related routines to collect statistics about
1196 scheduler behavior and provide them in /proc/schedstat. These
1197 stats may be useful for both tuning and debugging the scheduler
1198 If you aren't debugging the scheduler or trying to tune a specific
1199 application, you can say N to avoid the very slight overhead
1200 this adds.
1201
Changbin Duebebdd02019-12-06 17:04:00 -08001202endmenu
Aaron Tomlin0d9e2632014-09-12 14:16:19 +01001203
John Stultz3c17ad12015-03-11 21:16:32 -07001204config DEBUG_TIMEKEEPING
1205 bool "Enable extra timekeeping sanity checking"
1206 help
1207 This option will enable additional timekeeping sanity checks
1208 which may be helpful when diagnosing issues where timekeeping
1209 problems are suspected.
1210
1211 This may include checks in the timekeeping hotpaths, so this
1212 option may have a (very small) performance impact to some
1213 workloads.
1214
1215 If unsure, say N.
1216
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217config DEBUG_PREEMPT
1218 bool "Debug preemptible kernel"
Sebastian Andrzej Siewior9f472862019-10-15 21:18:19 +02001219 depends on DEBUG_KERNEL && PREEMPTION && TRACE_IRQFLAGS_SUPPORT
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 default y
1221 help
1222 If you say Y here then the kernel will use a debug variant of the
1223 commonly used smp_processor_id() function and will print warnings
1224 if kernel code uses it in a preemption-unsafe way. Also, the kernel
1225 will detect preemption count underflows.
1226
Dave Hansen9eade162013-07-01 13:04:47 -07001227menu "Lock Debugging (spinlocks, mutexes, etc...)"
1228
Waiman Longf07cbeb2018-03-30 17:27:59 -04001229config LOCK_DEBUGGING_SUPPORT
1230 bool
1231 depends on TRACE_IRQFLAGS_SUPPORT && STACKTRACE_SUPPORT && LOCKDEP_SUPPORT
1232 default y
1233
Waiman Long19193bc2018-03-30 17:28:00 -04001234config PROVE_LOCKING
1235 bool "Lock debugging: prove locking correctness"
1236 depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT
1237 select LOCKDEP
1238 select DEBUG_SPINLOCK
Thomas Gleixnerbb630f92021-08-15 23:29:01 +02001239 select DEBUG_MUTEXES if !PREEMPT_RT
Waiman Long19193bc2018-03-30 17:28:00 -04001240 select DEBUG_RT_MUTEXES if RT_MUTEXES
Waiman Longc71fd892019-05-20 16:59:00 -04001241 select DEBUG_RWSEMS
Waiman Long19193bc2018-03-30 17:28:00 -04001242 select DEBUG_WW_MUTEX_SLOWPATH
1243 select DEBUG_LOCK_ALLOC
Ahmed S. Darwish8fd8ad52020-07-20 17:55:13 +02001244 select PREEMPT_COUNT if !ARCH_NO_PREEMPT
Waiman Long19193bc2018-03-30 17:28:00 -04001245 select TRACE_IRQFLAGS
1246 default n
1247 help
1248 This feature enables the kernel to prove that all locking
1249 that occurs in the kernel runtime is mathematically
1250 correct: that under no circumstance could an arbitrary (and
1251 not yet triggered) combination of observed locking
1252 sequences (on an arbitrary number of CPUs, running an
1253 arbitrary number of tasks and interrupt contexts) cause a
1254 deadlock.
1255
1256 In short, this feature enables the kernel to report locking
1257 related deadlocks before they actually occur.
1258
1259 The proof does not depend on how hard and complex a
1260 deadlock scenario would be to trigger: how many
1261 participant CPUs, tasks and irq-contexts would be needed
1262 for it to trigger. The proof also does not depend on
1263 timing: if a race and a resulting deadlock is possible
1264 theoretically (no matter how unlikely the race scenario
1265 is), it will be proven so and will immediately be
1266 reported by the kernel (once the event is observed that
1267 makes the deadlock theoretically possible).
1268
1269 If a deadlock is impossible (i.e. the locking rules, as
1270 observed by the kernel, are mathematically correct), the
1271 kernel reports nothing.
1272
1273 NOTE: this feature can also be enabled for rwlocks, mutexes
1274 and rwsems - in which case all dependencies between these
1275 different locking variants are observed and mapped too, and
1276 the proof of observed correctness is also maintained for an
1277 arbitrary combination of these separate locking variants.
1278
Mauro Carvalho Chehab387b1462019-04-10 08:32:41 -03001279 For more details, see Documentation/locking/lockdep-design.rst.
Waiman Long19193bc2018-03-30 17:28:00 -04001280
Peter Zijlstrade8f5e42020-03-21 12:26:01 +01001281config PROVE_RAW_LOCK_NESTING
1282 bool "Enable raw_spinlock - spinlock nesting checks"
1283 depends on PROVE_LOCKING
1284 default n
1285 help
1286 Enable the raw_spinlock vs. spinlock nesting checks which ensure
1287 that the lock nesting rules for PREEMPT_RT enabled kernels are
1288 not violated.
1289
1290 NOTE: There are known nesting problems. So if you enable this
1291 option expect lockdep splats until these problems have been fully
1292 addressed which is work in progress. This config switch allows to
1293 identify and analyze these problems. It will be removed and the
Zhen Lei9dbbc3b2021-07-07 18:07:31 -07001294 check permanently enabled once the main issues have been fixed.
Peter Zijlstrade8f5e42020-03-21 12:26:01 +01001295
1296 If unsure, select N.
1297
Waiman Long19193bc2018-03-30 17:28:00 -04001298config LOCK_STAT
1299 bool "Lock usage statistics"
1300 depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT
1301 select LOCKDEP
1302 select DEBUG_SPINLOCK
Thomas Gleixnerbb630f92021-08-15 23:29:01 +02001303 select DEBUG_MUTEXES if !PREEMPT_RT
Waiman Long19193bc2018-03-30 17:28:00 -04001304 select DEBUG_RT_MUTEXES if RT_MUTEXES
1305 select DEBUG_LOCK_ALLOC
1306 default n
1307 help
1308 This feature enables tracking lock contention points
1309
Mauro Carvalho Chehab387b1462019-04-10 08:32:41 -03001310 For more details, see Documentation/locking/lockstat.rst
Waiman Long19193bc2018-03-30 17:28:00 -04001311
1312 This also enables lock events required by "perf lock",
1313 subcommand of perf.
1314 If you want to use "perf lock", you also need to turn on
1315 CONFIG_EVENT_TRACING.
1316
1317 CONFIG_LOCK_STAT defines "contended" and "acquired" lock events.
1318 (CONFIG_LOCKDEP defines "acquire" and "release" events.)
1319
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320config DEBUG_RT_MUTEXES
1321 bool "RT Mutex debugging, deadlock detection"
1322 depends on DEBUG_KERNEL && RT_MUTEXES
1323 help
1324 This allows rt mutex semantics violations and rt mutex related
1325 deadlocks (lockups) to be detected and reported automatically.
1326
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327config DEBUG_SPINLOCK
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001328 bool "Spinlock and rw-lock debugging: basic checks"
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 depends on DEBUG_KERNEL
Raghavendra K Te335e3e2012-03-22 15:25:08 +05301330 select UNINLINE_SPIN_UNLOCK
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 help
1332 Say Y here and build SMP to catch missing spinlock initialization
1333 and certain other kinds of spinlock errors commonly made. This is
1334 best used in conjunction with the NMI watchdog so that spinlock
1335 deadlocks are also debuggable.
1336
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001337config DEBUG_MUTEXES
1338 bool "Mutex debugging: basic checks"
Thomas Gleixnerbb630f92021-08-15 23:29:01 +02001339 depends on DEBUG_KERNEL && !PREEMPT_RT
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001340 help
1341 This feature allows mutex semantics violations to be detected and
1342 reported.
1343
Daniel Vetter23010022013-06-20 13:31:17 +02001344config DEBUG_WW_MUTEX_SLOWPATH
1345 bool "Wait/wound mutex debugging: Slowpath testing"
Waiman Longf07cbeb2018-03-30 17:27:59 -04001346 depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT
Daniel Vetter23010022013-06-20 13:31:17 +02001347 select DEBUG_LOCK_ALLOC
1348 select DEBUG_SPINLOCK
Thomas Gleixnerbb630f92021-08-15 23:29:01 +02001349 select DEBUG_MUTEXES if !PREEMPT_RT
1350 select DEBUG_RT_MUTEXES if PREEMPT_RT
Daniel Vetter23010022013-06-20 13:31:17 +02001351 help
1352 This feature enables slowpath testing for w/w mutex users by
1353 injecting additional -EDEADLK wound/backoff cases. Together with
1354 the full mutex checks enabled with (CONFIG_PROVE_LOCKING) this
1355 will test all possible w/w mutex interface abuse with the
1356 exception of simply not acquiring all the required locks.
Rob Clark4d692372014-08-27 11:19:26 -04001357 Note that this feature can introduce significant overhead, so
1358 it really should not be enabled in a production or distro kernel,
1359 even a debug kernel. If you are a driver writer, enable it. If
1360 you are a distro, do not.
Daniel Vetter23010022013-06-20 13:31:17 +02001361
Waiman Long5149cba2018-03-30 17:27:58 -04001362config DEBUG_RWSEMS
1363 bool "RW Semaphore debugging: basic checks"
Waiman Longc71fd892019-05-20 16:59:00 -04001364 depends on DEBUG_KERNEL
Waiman Long5149cba2018-03-30 17:27:58 -04001365 help
Waiman Longc71fd892019-05-20 16:59:00 -04001366 This debugging feature allows mismatched rw semaphore locks
1367 and unlocks to be detected and reported.
Waiman Long5149cba2018-03-30 17:27:58 -04001368
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001369config DEBUG_LOCK_ALLOC
1370 bool "Lock debugging: detect incorrect freeing of live locks"
Waiman Longf07cbeb2018-03-30 17:27:59 -04001371 depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001372 select DEBUG_SPINLOCK
Thomas Gleixnerbb630f92021-08-15 23:29:01 +02001373 select DEBUG_MUTEXES if !PREEMPT_RT
Peter Zijlstraf5694782016-09-19 12:15:37 +02001374 select DEBUG_RT_MUTEXES if RT_MUTEXES
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001375 select LOCKDEP
1376 help
1377 This feature will check whether any held lock (spinlock, rwlock,
1378 mutex or rwsem) is incorrectly freed by the kernel, via any of the
1379 memory-freeing routines (kfree(), kmem_cache_free(), free_pages(),
1380 vfree(), etc.), whether a live lock is incorrectly reinitialized via
1381 spin_lock_init()/mutex_init()/etc., or whether there is any lock
1382 held during task exit.
1383
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001384config LOCKDEP
1385 bool
Waiman Longf07cbeb2018-03-30 17:27:59 -04001386 depends on DEBUG_KERNEL && LOCK_DEBUGGING_SUPPORT
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001387 select STACKTRACE
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001388 select KALLSYMS
1389 select KALLSYMS_ALL
1390
Daniel Jordan395102d2017-04-10 11:50:52 -04001391config LOCKDEP_SMALL
1392 bool
1393
Tetsuo Handa5dc33592021-04-05 20:33:57 +09001394config LOCKDEP_BITS
1395 int "Bitsize for MAX_LOCKDEP_ENTRIES"
1396 depends on LOCKDEP && !LOCKDEP_SMALL
1397 range 10 30
1398 default 15
1399 help
1400 Try increasing this value if you hit "BUG: MAX_LOCKDEP_ENTRIES too low!" message.
1401
1402config LOCKDEP_CHAINS_BITS
1403 int "Bitsize for MAX_LOCKDEP_CHAINS"
1404 depends on LOCKDEP && !LOCKDEP_SMALL
1405 range 10 30
1406 default 16
1407 help
1408 Try increasing this value if you hit "BUG: MAX_LOCKDEP_CHAINS too low!" message.
1409
1410config LOCKDEP_STACK_TRACE_BITS
1411 int "Bitsize for MAX_STACK_TRACE_ENTRIES"
1412 depends on LOCKDEP && !LOCKDEP_SMALL
1413 range 10 30
1414 default 19
1415 help
1416 Try increasing this value if you hit "BUG: MAX_STACK_TRACE_ENTRIES too low!" message.
1417
1418config LOCKDEP_STACK_TRACE_HASH_BITS
1419 int "Bitsize for STACK_TRACE_HASH_SIZE"
1420 depends on LOCKDEP && !LOCKDEP_SMALL
1421 range 10 30
1422 default 14
1423 help
1424 Try increasing this value if you need large MAX_STACK_TRACE_ENTRIES.
1425
1426config LOCKDEP_CIRCULAR_QUEUE_BITS
1427 int "Bitsize for elements in circular_queue struct"
1428 depends on LOCKDEP
1429 range 10 30
1430 default 12
1431 help
1432 Try increasing this value if you hit "lockdep bfs error:-1" warning due to __cq_enqueue() failure.
1433
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001434config DEBUG_LOCKDEP
1435 bool "Lock dependency engine debugging"
Adrian Bunk517e7aa2006-07-14 00:24:32 -07001436 depends on DEBUG_KERNEL && LOCKDEP
Mark Rutland997acaf2021-01-11 15:37:07 +00001437 select DEBUG_IRQFLAGS
Ingo Molnar4d9f34a2006-07-03 00:24:55 -07001438 help
1439 If you say Y here, the lock dependency engine will do
1440 additional runtime checks to debug itself, at the price
1441 of more runtime overhead.
1442
Frederic Weisbeckerd902db12011-06-08 19:31:56 +02001443config DEBUG_ATOMIC_SLEEP
1444 bool "Sleep inside atomic section checking"
Frederic Weisbeckere8f7c702011-06-08 01:51:02 +02001445 select PREEMPT_COUNT
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 depends on DEBUG_KERNEL
Christoph Hellwig87a4c372018-07-31 13:39:32 +02001447 depends on !ARCH_NO_PREEMPT
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 help
1449 If you say Y here, various routines which may sleep will become very
Frederic Weisbeckerd902db12011-06-08 19:31:56 +02001450 noisy if they are called inside atomic sections: when a spinlock is
1451 held, inside an rcu read side critical section, inside preempt disabled
1452 sections, inside an interrupt, etc...
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453
Ingo Molnarcae2ed92006-07-03 00:24:48 -07001454config DEBUG_LOCKING_API_SELFTESTS
1455 bool "Locking API boot-time self-tests"
1456 depends on DEBUG_KERNEL
1457 help
1458 Say Y here if you want the kernel to run a short self-test during
1459 bootup. The self-test checks whether common types of locking bugs
1460 are detected by debugging mechanisms or not. (if you disable
Zhen Lei9dbbc3b2021-07-07 18:07:31 -07001461 lock debugging then those bugs won't be detected of course.)
Ingo Molnarcae2ed92006-07-03 00:24:48 -07001462 The following locking APIs are covered: spinlocks, rwlocks,
1463 mutexes and rwsems.
1464
Paul E. McKenney0af3fe12014-02-04 15:51:41 -08001465config LOCK_TORTURE_TEST
1466 tristate "torture tests for locking"
1467 depends on DEBUG_KERNEL
1468 select TORTURE_TEST
Paul E. McKenney0af3fe12014-02-04 15:51:41 -08001469 help
1470 This option provides a kernel module that runs torture tests
1471 on kernel locking primitives. The kernel module may be built
1472 after the fact on the running kernel to be tested, if desired.
1473
1474 Say Y here if you want kernel locking-primitive torture tests
1475 to be built into the kernel.
1476 Say M if you want these torture tests to build as a module.
1477 Say N if you are unsure.
1478
Chris Wilsonf2a5fec2016-12-01 11:47:06 +00001479config WW_MUTEX_SELFTEST
1480 tristate "Wait/wound mutex selftests"
1481 help
1482 This option provides a kernel module that runs tests on the
1483 on the struct ww_mutex locking API.
1484
1485 It is recommended to enable DEBUG_WW_MUTEX_SLOWPATH in conjunction
1486 with this test harness.
1487
1488 Say M if you want these self tests to build as a module.
1489 Say N if you are unsure.
1490
Paul E. McKenneye9d338a2020-06-24 15:59:59 -07001491config SCF_TORTURE_TEST
1492 tristate "torture tests for smp_call_function*()"
1493 depends on DEBUG_KERNEL
1494 select TORTURE_TEST
1495 help
1496 This option provides a kernel module that runs torture tests
1497 on the smp_call_function() family of primitives. The kernel
1498 module may be built after the fact on the running kernel to
1499 be tested, if desired.
1500
Paul E. McKenney35feb602020-06-30 13:22:54 -07001501config CSD_LOCK_WAIT_DEBUG
1502 bool "Debugging for csd_lock_wait(), called from smp_call_function*()"
1503 depends on DEBUG_KERNEL
1504 depends on 64BIT
1505 default n
1506 help
1507 This option enables debug prints when CPUs are slow to respond
1508 to the smp_call_function*() IPI wrappers. These debug prints
1509 include the IPI handler function currently executing (if any)
1510 and relevant stack traces.
1511
Dave Hansen9eade162013-07-01 13:04:47 -07001512endmenu # lock debugging
1513
1514config TRACE_IRQFLAGS
peterz@infradead.orged004952020-07-27 14:48:52 +02001515 depends on TRACE_IRQFLAGS_SUPPORT
Dave Hansen9eade162013-07-01 13:04:47 -07001516 bool
1517 help
1518 Enables hooks to interrupt enabling and disabling for
1519 either tracing or lock debugging.
1520
peterz@infradead.orged004952020-07-27 14:48:52 +02001521config TRACE_IRQFLAGS_NMI
1522 def_bool y
1523 depends on TRACE_IRQFLAGS
1524 depends on TRACE_IRQFLAGS_NMI_SUPPORT
1525
Mark Rutland997acaf2021-01-11 15:37:07 +00001526config DEBUG_IRQFLAGS
1527 bool "Debug IRQ flag manipulation"
1528 help
1529 Enables checks for potentially unsafe enabling or disabling of
1530 interrupts, such as calling raw_local_irq_restore() when interrupts
1531 are enabled.
1532
Ingo Molnar8637c092006-07-03 00:24:38 -07001533config STACKTRACE
Dave Jones0c38e1f2014-08-29 15:18:35 -07001534 bool "Stack backtrace support"
Ingo Molnar8637c092006-07-03 00:24:38 -07001535 depends on STACKTRACE_SUPPORT
Dave Jones0c38e1f2014-08-29 15:18:35 -07001536 help
1537 This option causes the kernel to create a /proc/pid/stack for
1538 every process, showing its current stack trace.
1539 It is also used by various kernel debugging features that require
1540 stack trace generation.
Ingo Molnar8637c092006-07-03 00:24:38 -07001541
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001542config WARN_ALL_UNSEEDED_RANDOM
1543 bool "Warn for all uses of unseeded randomness"
1544 default n
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04001545 help
1546 Some parts of the kernel contain bugs relating to their use of
1547 cryptographically secure random numbers before it's actually possible
1548 to generate those numbers securely. This setting ensures that these
1549 flaws don't go unnoticed, by enabling a message, should this ever
1550 occur. This will allow people with obscure setups to know when things
1551 are going wrong, so that they might contact developers about fixing
1552 it.
1553
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001554 Unfortunately, on some models of some architectures getting
1555 a fully seeded CRNG is extremely difficult, and so this can
1556 result in dmesg getting spammed for a surprisingly long
1557 time. This is really bad from a security perspective, and
1558 so architecture maintainers really need to do what they can
1559 to get the CRNG seeded sooner after the system is booted.
Thibaut Sautereau4c5d1142018-09-04 15:46:23 -07001560 However, since users cannot do anything actionable to
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001561 address this, by default the kernel will issue only a single
1562 warning for the first use of unseeded randomness.
1563
1564 Say Y here if you want to receive warnings for all uses of
1565 unseeded randomness. This will be of use primarily for
Thibaut Sautereau4c5d1142018-09-04 15:46:23 -07001566 those developers interested in improving the security of
Theodore Ts'oeecabf52017-06-08 04:16:59 -04001567 Linux kernels running on their architecture (or
1568 subarchitecture).
Jason A. Donenfeldd06bfd12017-06-07 23:06:55 -04001569
Linus Torvalds1da177e2005-04-16 15:20:36 -07001570config DEBUG_KOBJECT
1571 bool "kobject debugging"
1572 depends on DEBUG_KERNEL
1573 help
1574 If you say Y here, some extra kobject debugging messages will be sent
Mike Rapoportaca52c32018-10-30 15:07:44 -07001575 to the syslog.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576
Russell Kingc817a672013-06-27 15:06:14 +01001577config DEBUG_KOBJECT_RELEASE
1578 bool "kobject release debugging"
Linus Torvalds2a999aa2013-10-29 08:33:36 -07001579 depends on DEBUG_OBJECTS_TIMERS
Russell Kingc817a672013-06-27 15:06:14 +01001580 help
1581 kobjects are reference counted objects. This means that their
1582 last reference count put is not predictable, and the kobject can
1583 live on past the point at which a driver decides to drop it's
1584 initial reference to the kobject gained on allocation. An
1585 example of this would be a struct device which has just been
1586 unregistered.
1587
1588 However, some buggy drivers assume that after such an operation,
1589 the memory backing the kobject can be immediately freed. This
1590 goes completely against the principles of a refcounted object.
1591
1592 If you say Y here, the kernel will delay the release of kobjects
1593 on the last reference count to improve the visibility of this
1594 kind of kobject release bug.
1595
Catalin Marinas9b2a60c2012-10-08 16:28:13 -07001596config HAVE_DEBUG_BUGVERBOSE
1597 bool
1598
Changbin Du3be5cbc2019-12-06 17:03:48 -08001599menu "Debug kernel data structures"
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600
Dave Jones199a9af2006-09-29 01:59:00 -07001601config DEBUG_LIST
1602 bool "Debug linked list manipulation"
Arnd Bergmann4520bcb2016-08-26 17:42:00 +02001603 depends on DEBUG_KERNEL || BUG_ON_DATA_CORRUPTION
Dave Jones199a9af2006-09-29 01:59:00 -07001604 help
1605 Enable this to turn on extended checks in the linked-list
1606 walking routines.
1607
1608 If unsure, say N.
1609
Davidlohr Bueso8e18fae2019-05-14 15:42:46 -07001610config DEBUG_PLIST
Dan Streetmanb8cfff62014-06-04 16:11:54 -07001611 bool "Debug priority linked list manipulation"
1612 depends on DEBUG_KERNEL
1613 help
1614 Enable this to turn on extended checks in the priority-ordered
1615 linked-list (plist) walking routines. This checks the entire
1616 list multiple times during each manipulation.
1617
1618 If unsure, say N.
1619
Jens Axboed6ec0842007-10-22 20:01:06 +02001620config DEBUG_SG
1621 bool "Debug SG table operations"
1622 depends on DEBUG_KERNEL
1623 help
1624 Enable this to turn on checks on scatter-gather tables. This can
1625 help find problems with drivers that do not properly initialize
1626 their sg tables.
1627
1628 If unsure, say N.
1629
Arjan van de Ven1b2439d2008-08-15 15:29:38 -07001630config DEBUG_NOTIFIERS
1631 bool "Debug notifier call chains"
1632 depends on DEBUG_KERNEL
1633 help
1634 Enable this to turn on sanity checking for notifier call chains.
1635 This is most useful for kernel developers to make sure that
1636 modules properly unregister themselves from notifier chains.
1637 This is a relatively cheap check but if you care about maximum
1638 performance, say N.
1639
Changbin Du3be5cbc2019-12-06 17:03:48 -08001640config BUG_ON_DATA_CORRUPTION
1641 bool "Trigger a BUG when data corruption is detected"
1642 select DEBUG_LIST
1643 help
1644 Select this option if the kernel should BUG when it encounters
1645 data corruption in kernel memory structures when they get checked
1646 for validity.
1647
1648 If unsure, say N.
1649
1650endmenu
1651
David Howellse0e81732009-09-02 09:13:40 +01001652config DEBUG_CREDENTIALS
1653 bool "Debug credential management"
1654 depends on DEBUG_KERNEL
1655 help
1656 Enable this to turn on some debug checking for credential
1657 management. The additional code keeps track of the number of
1658 pointers from task_structs to any given cred struct, and checks to
1659 see that this number never exceeds the usage count of the cred
1660 struct.
1661
1662 Furthermore, if SELinux is enabled, this also checks that the
1663 security pointer in the cred struct is never seen to be invalid.
1664
1665 If unsure, say N.
1666
Paul E. McKenney43a0a2a2017-05-17 09:19:44 -07001667source "kernel/rcu/Kconfig.debug"
Dave Hansen2f03e3c2013-01-07 08:19:23 -08001668
Tejun Heof303fccb2016-02-09 17:59:38 -05001669config DEBUG_WQ_FORCE_RR_CPU
1670 bool "Force round-robin CPU selection for unbound work items"
1671 depends on DEBUG_KERNEL
1672 default n
1673 help
1674 Workqueue used to implicitly guarantee that work items queued
1675 without explicit CPU specified are put on the local CPU. This
1676 guarantee is no longer true and while local CPU is still
1677 preferred work items may be put on foreign CPUs. Kernel
1678 parameter "workqueue.debug_force_rr_cpu" is added to force
1679 round-robin CPU selection to flush out usages which depend on the
1680 now broken guarantee. This config option enables the debug
1681 feature by default. When enabled, memory and cache locality will
1682 be impacted.
1683
Thomas Gleixner757c9892016-02-26 18:43:32 +00001684config CPU_HOTPLUG_STATE_CONTROL
1685 bool "Enable CPU hotplug state control"
1686 depends on DEBUG_KERNEL
1687 depends on HOTPLUG_CPU
1688 default n
1689 help
1690 Allows to write steps between "offline" and "online" to the CPUs
1691 sysfs target file so states can be stepped granular. This is a debug
1692 option for now as the hotplug machinery cannot be stopped and
1693 restarted at arbitrary points yet.
1694
1695 Say N if your are unsure.
1696
Changbin Du09a74952019-12-06 17:03:51 -08001697config LATENCYTOP
1698 bool "Latency measuring infrastructure"
1699 depends on DEBUG_KERNEL
1700 depends on STACKTRACE_SUPPORT
1701 depends on PROC_FS
Julian Braha7d37cb22021-04-09 13:27:47 -07001702 depends on FRAME_POINTER || MIPS || PPC || S390 || MICROBLAZE || ARM || ARC || X86
Changbin Du09a74952019-12-06 17:03:51 -08001703 select KALLSYMS
1704 select KALLSYMS_ALL
1705 select STACKTRACE
1706 select SCHEDSTATS
Changbin Du09a74952019-12-06 17:03:51 -08001707 help
1708 Enable this option if you want to use the LatencyTOP tool
1709 to find out which userspace is blocking on what kernel operations.
1710
1711source "kernel/trace/Kconfig"
1712
1713config PROVIDE_OHCI1394_DMA_INIT
1714 bool "Remote debugging over FireWire early on boot"
1715 depends on PCI && X86
1716 help
1717 If you want to debug problems which hang or crash the kernel early
1718 on boot and the crashing machine has a FireWire port, you can use
1719 this feature to remotely access the memory of the crashed machine
1720 over FireWire. This employs remote DMA as part of the OHCI1394
1721 specification which is now the standard for FireWire controllers.
1722
1723 With remote DMA, you can monitor the printk buffer remotely using
1724 firescope and access all memory below 4GB using fireproxy from gdb.
1725 Even controlling a kernel debugger is possible using remote DMA.
1726
1727 Usage:
1728
1729 If ohci1394_dma=early is used as boot parameter, it will initialize
1730 all OHCI1394 controllers which are found in the PCI config space.
1731
1732 As all changes to the FireWire bus such as enabling and disabling
1733 devices cause a bus reset and thereby disable remote DMA for all
1734 devices, be sure to have the cable plugged and FireWire enabled on
1735 the debugging host before booting the debug target for debugging.
1736
1737 This code (~1k) is freed after boot. By then, the firewire stack
1738 in charge of the OHCI-1394 controllers should be used instead.
1739
Mauro Carvalho Chehaba74e2a22020-05-01 17:37:50 +02001740 See Documentation/core-api/debugging-via-ohci1394.rst for more information.
Changbin Du09a74952019-12-06 17:03:51 -08001741
Changbin Du045f6d72019-12-17 20:51:56 -08001742source "samples/Kconfig"
1743
1744config ARCH_HAS_DEVMEM_IS_ALLOWED
1745 bool
1746
1747config STRICT_DEVMEM
1748 bool "Filter access to /dev/mem"
1749 depends on MMU && DEVMEM
Palmer Dabbelt527701e2020-07-09 11:43:21 -07001750 depends on ARCH_HAS_DEVMEM_IS_ALLOWED || GENERIC_LIB_DEVMEM_IS_ALLOWED
Changbin Du045f6d72019-12-17 20:51:56 -08001751 default y if PPC || X86 || ARM64
1752 help
1753 If this option is disabled, you allow userspace (root) access to all
1754 of memory, including kernel and userspace memory. Accidental
1755 access to this is obviously disastrous, but specific access can
1756 be used by people debugging the kernel. Note that with PAT support
1757 enabled, even in this case there are restrictions on /dev/mem
1758 use due to the cache aliasing requirements.
1759
1760 If this option is switched on, and IO_STRICT_DEVMEM=n, the /dev/mem
1761 file only allows userspace access to PCI space and the BIOS code and
1762 data regions. This is sufficient for dosemu and X and all common
1763 users of /dev/mem.
1764
1765 If in doubt, say Y.
1766
1767config IO_STRICT_DEVMEM
1768 bool "Filter I/O access to /dev/mem"
1769 depends on STRICT_DEVMEM
1770 help
1771 If this option is disabled, you allow userspace (root) access to all
1772 io-memory regardless of whether a driver is actively using that
1773 range. Accidental access to this is obviously disastrous, but
1774 specific access can be used by people debugging kernel drivers.
1775
1776 If this option is switched on, the /dev/mem file only allows
1777 userspace access to *idle* io-memory ranges (see /proc/iomem) This
1778 may break traditional users of /dev/mem (dosemu, legacy X, etc...)
1779 if the driver using a given range cannot be disabled.
1780
1781 If in doubt, say Y.
1782
1783menu "$(SRCARCH) Debugging"
1784
1785source "arch/$(SRCARCH)/Kconfig.debug"
1786
1787endmenu
1788
1789menu "Kernel Testing and Coverage"
1790
Changbin Du09a74952019-12-06 17:03:51 -08001791source "lib/kunit/Kconfig"
1792
Akinobu Mita8d438282012-07-30 14:43:02 -07001793config NOTIFIER_ERROR_INJECTION
1794 tristate "Notifier error injection"
1795 depends on DEBUG_KERNEL
1796 select DEBUG_FS
1797 help
Masanari Iidae41e85c2012-11-30 16:44:39 +09001798 This option provides the ability to inject artificial errors to
Akinobu Mita8d438282012-07-30 14:43:02 -07001799 specified notifier chain callbacks. It is useful to test the error
1800 handling of notifier call chain failures.
1801
1802 Say N if unsure.
1803
Akinobu Mita048b9c32012-07-30 14:43:07 -07001804config PM_NOTIFIER_ERROR_INJECT
1805 tristate "PM notifier error injection module"
1806 depends on PM && NOTIFIER_ERROR_INJECTION
1807 default m if PM_DEBUG
1808 help
Masanari Iidae41e85c2012-11-30 16:44:39 +09001809 This option provides the ability to inject artificial errors to
Akinobu Mita048b9c32012-07-30 14:43:07 -07001810 PM notifier chain callbacks. It is controlled through debugfs
1811 interface /sys/kernel/debug/notifier-error-inject/pm
1812
1813 If the notifier call chain should be failed with some events
1814 notified, write the error code to "actions/<notifier event>/error".
1815
1816 Example: Inject PM suspend error (-12 = -ENOMEM)
1817
1818 # cd /sys/kernel/debug/notifier-error-inject/pm/
1819 # echo -12 > actions/PM_SUSPEND_PREPARE/error
1820 # echo mem > /sys/power/state
1821 bash: echo: write error: Cannot allocate memory
1822
1823 To compile this code as a module, choose M here: the module will
1824 be called pm-notifier-error-inject.
1825
1826 If unsure, say N.
1827
Benjamin Herrenschmidtd526e852012-12-14 10:32:52 +11001828config OF_RECONFIG_NOTIFIER_ERROR_INJECT
1829 tristate "OF reconfig notifier error injection module"
1830 depends on OF_DYNAMIC && NOTIFIER_ERROR_INJECTION
Akinobu Mita08dfb4d2012-07-30 14:43:13 -07001831 help
Masanari Iidae41e85c2012-11-30 16:44:39 +09001832 This option provides the ability to inject artificial errors to
Benjamin Herrenschmidtd526e852012-12-14 10:32:52 +11001833 OF reconfig notifier chain callbacks. It is controlled
Akinobu Mita08dfb4d2012-07-30 14:43:13 -07001834 through debugfs interface under
Benjamin Herrenschmidtd526e852012-12-14 10:32:52 +11001835 /sys/kernel/debug/notifier-error-inject/OF-reconfig/
Akinobu Mita08dfb4d2012-07-30 14:43:13 -07001836
1837 If the notifier call chain should be failed with some events
1838 notified, write the error code to "actions/<notifier event>/error".
1839
1840 To compile this code as a module, choose M here: the module will
Akinobu Mitae12a95f2013-04-30 15:28:49 -07001841 be called of-reconfig-notifier-error-inject.
Akinobu Mita08dfb4d2012-07-30 14:43:13 -07001842
1843 If unsure, say N.
1844
Nikolay Aleksandrov02fff962015-11-28 13:45:28 +01001845config NETDEV_NOTIFIER_ERROR_INJECT
1846 tristate "Netdev notifier error injection module"
1847 depends on NET && NOTIFIER_ERROR_INJECTION
1848 help
1849 This option provides the ability to inject artificial errors to
1850 netdevice notifier chain callbacks. It is controlled through debugfs
1851 interface /sys/kernel/debug/notifier-error-inject/netdev
1852
1853 If the notifier call chain should be failed with some events
1854 notified, write the error code to "actions/<notifier event>/error".
1855
1856 Example: Inject netdevice mtu change error (-22 = -EINVAL)
1857
1858 # cd /sys/kernel/debug/notifier-error-inject/netdev
1859 # echo -22 > actions/NETDEV_CHANGEMTU/error
1860 # ip link set eth0 mtu 1024
1861 RTNETLINK answers: Invalid argument
1862
1863 To compile this code as a module, choose M here: the module will
1864 be called netdev-notifier-error-inject.
1865
1866 If unsure, say N.
1867
Mikulas Patockaf1b4bd02018-06-14 15:27:48 -07001868config FUNCTION_ERROR_INJECTION
1869 def_bool y
1870 depends on HAVE_FUNCTION_ERROR_INJECTION && KPROBES
1871
Akinobu Mita6ff1cb32006-12-08 02:39:43 -08001872config FAULT_INJECTION
Andrew Morton1ab8509a2006-12-08 02:39:49 -08001873 bool "Fault-injection framework"
1874 depends on DEBUG_KERNEL
Akinobu Mita329409a2006-12-08 02:39:48 -08001875 help
1876 Provide fault-injection framework.
1877 For more details, see Documentation/fault-injection/.
Akinobu Mita6ff1cb32006-12-08 02:39:43 -08001878
Akinobu Mita8a8b6502006-12-08 02:39:44 -08001879config FAILSLAB
Andrew Morton1ab8509a2006-12-08 02:39:49 -08001880 bool "Fault-injection capability for kmalloc"
1881 depends on FAULT_INJECTION
Akinobu Mita773ff602008-12-23 19:37:01 +09001882 depends on SLAB || SLUB
Akinobu Mita8a8b6502006-12-08 02:39:44 -08001883 help
Andrew Morton1ab8509a2006-12-08 02:39:49 -08001884 Provide fault-injection capability for kmalloc.
Akinobu Mita8a8b6502006-12-08 02:39:44 -08001885
Akinobu Mita933e3122006-12-08 02:39:45 -08001886config FAIL_PAGE_ALLOC
Qiujun Huang29b46fa2020-04-06 20:12:49 -07001887 bool "Fault-injection capability for alloc_pages()"
Andrew Morton1ab8509a2006-12-08 02:39:49 -08001888 depends on FAULT_INJECTION
Akinobu Mita933e3122006-12-08 02:39:45 -08001889 help
Andrew Morton1ab8509a2006-12-08 02:39:49 -08001890 Provide fault-injection capability for alloc_pages().
Akinobu Mita933e3122006-12-08 02:39:45 -08001891
Albert van der Linde2c739ce2020-10-15 20:13:46 -07001892config FAULT_INJECTION_USERCOPY
1893 bool "Fault injection capability for usercopy functions"
1894 depends on FAULT_INJECTION
1895 help
1896 Provides fault-injection capability to inject failures
1897 in usercopy functions (copy_from_user(), get_user(), ...).
1898
Akinobu Mitac17bb492006-12-08 02:39:46 -08001899config FAIL_MAKE_REQUEST
Dave Jones86327d12006-12-12 20:16:36 +01001900 bool "Fault-injection capability for disk IO"
Jens Axboe581d4e22008-09-14 05:56:33 -07001901 depends on FAULT_INJECTION && BLOCK
Akinobu Mitac17bb492006-12-08 02:39:46 -08001902 help
Andrew Morton1ab8509a2006-12-08 02:39:49 -08001903 Provide fault-injection capability for disk IO.
Akinobu Mitac17bb492006-12-08 02:39:46 -08001904
Jens Axboe581d4e22008-09-14 05:56:33 -07001905config FAIL_IO_TIMEOUT
Takuya Yoshikawaf4d01432010-07-21 16:05:53 +09001906 bool "Fault-injection capability for faking disk interrupts"
Jens Axboe581d4e22008-09-14 05:56:33 -07001907 depends on FAULT_INJECTION && BLOCK
1908 help
1909 Provide fault-injection capability on end IO handling. This
1910 will make the block layer "forget" an interrupt as configured,
1911 thus exercising the error handling.
1912
1913 Only works with drivers that use the generic timeout handling,
Zhen Lei9dbbc3b2021-07-07 18:07:31 -07001914 for others it won't do anything.
Jens Axboe581d4e22008-09-14 05:56:33 -07001915
Davidlohr Buesoab51fba2015-06-29 23:26:02 -07001916config FAIL_FUTEX
1917 bool "Fault-injection capability for futexes"
1918 select DEBUG_FS
1919 depends on FAULT_INJECTION && FUTEX
1920 help
1921 Provide fault-injection capability for futexes.
1922
Mikulas Patockaf1b4bd02018-06-14 15:27:48 -07001923config FAULT_INJECTION_DEBUG_FS
1924 bool "Debugfs entries for fault-injection capabilities"
1925 depends on FAULT_INJECTION && SYSFS && DEBUG_FS
1926 help
1927 Enable configuration of fault-injection capabilities via debugfs.
1928
Masami Hiramatsu4b1a29a2018-01-13 02:56:03 +09001929config FAIL_FUNCTION
1930 bool "Fault-injection capability for functions"
1931 depends on FAULT_INJECTION_DEBUG_FS && FUNCTION_ERROR_INJECTION
1932 help
1933 Provide function-based fault-injection capability.
1934 This will allow you to override a specific function with a return
1935 with given return value. As a result, function caller will see
1936 an error value and have to handle it. This is useful to test the
1937 error handling in various subsystems.
1938
Mikulas Patockaf1b4bd02018-06-14 15:27:48 -07001939config FAIL_MMC_REQUEST
1940 bool "Fault-injection capability for MMC IO"
1941 depends on FAULT_INJECTION_DEBUG_FS && MMC
Akinobu Mita6ff1cb32006-12-08 02:39:43 -08001942 help
Mikulas Patockaf1b4bd02018-06-14 15:27:48 -07001943 Provide fault-injection capability for MMC IO.
1944 This will make the mmc core return data errors. This is
1945 useful to test the error handling in the mmc block device
1946 and to test how the mmc host driver handles retries from
1947 the block device.
Akinobu Mita1df49002007-02-20 13:57:56 -08001948
Chuck Leverc782af22021-08-03 15:45:18 -04001949config FAIL_SUNRPC
1950 bool "Fault-injection capability for SunRPC"
1951 depends on FAULT_INJECTION_DEBUG_FS && SUNRPC_DEBUG
1952 help
1953 Provide fault-injection capability for SunRPC and
1954 its consumers.
1955
Akinobu Mita1df49002007-02-20 13:57:56 -08001956config FAULT_INJECTION_STACKTRACE_FILTER
1957 bool "stacktrace filter for fault-injection capabilities"
1958 depends on FAULT_INJECTION_DEBUG_FS && STACKTRACE_SUPPORT
Akinobu Mita6d690dc2007-05-12 10:36:53 -07001959 depends on !X86_64
Akinobu Mita1df49002007-02-20 13:57:56 -08001960 select STACKTRACE
Julian Braha7d37cb22021-04-09 13:27:47 -07001961 depends on FRAME_POINTER || MIPS || PPC || S390 || MICROBLAZE || ARM || ARC || X86
Akinobu Mita1df49002007-02-20 13:57:56 -08001962 help
1963 Provide stacktrace filter for fault-injection capabilities
Mathieu Desnoyers267c4022007-10-18 23:41:07 -07001964
Changbin Du09a74952019-12-06 17:03:51 -08001965config ARCH_HAS_KCOV
1966 bool
Arjan van de Ven97455122008-01-25 21:08:34 +01001967 help
Changbin Du09a74952019-12-06 17:03:51 -08001968 An architecture should select this when it can successfully
1969 build and run with CONFIG_KCOV. This typically requires
1970 disabling instrumentation for some early boot code.
Arjan van de Ven97455122008-01-25 21:08:34 +01001971
Changbin Du09a74952019-12-06 17:03:51 -08001972config CC_HAS_SANCOV_TRACE_PC
1973 def_bool $(cc-option,-fsanitize-coverage=trace-pc)
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +02001974
Changbin Du09a74952019-12-06 17:03:51 -08001975
1976config KCOV
1977 bool "Code coverage for fuzzing"
1978 depends on ARCH_HAS_KCOV
1979 depends on CC_HAS_SANCOV_TRACE_PC || GCC_PLUGINS
1980 select DEBUG_FS
1981 select GCC_PLUGIN_SANCOV if !CC_HAS_SANCOV_TRACE_PC
Randy Dunlapcc3fa842017-10-13 15:57:33 -07001982 help
Changbin Du09a74952019-12-06 17:03:51 -08001983 KCOV exposes kernel code coverage information in a form suitable
1984 for coverage-guided fuzzing (randomized testing).
Randy Dunlapcc3fa842017-10-13 15:57:33 -07001985
Changbin Du09a74952019-12-06 17:03:51 -08001986 If RANDOMIZE_BASE is enabled, PC values will not be stable across
1987 different machines and across reboots. If you need stable PC values,
1988 disable RANDOMIZE_BASE.
Randy Dunlapcc3fa842017-10-13 15:57:33 -07001989
Changbin Du09a74952019-12-06 17:03:51 -08001990 For more details, see Documentation/dev-tools/kcov.rst.
Randy Dunlapcc3fa842017-10-13 15:57:33 -07001991
Changbin Du09a74952019-12-06 17:03:51 -08001992config KCOV_ENABLE_COMPARISONS
1993 bool "Enable comparison operands collection by KCOV"
1994 depends on KCOV
1995 depends on $(cc-option,-fsanitize-coverage=trace-cmp)
1996 help
1997 KCOV also exposes operands of every comparison in the instrumented
1998 code along with operand sizes and PCs of the comparison instructions.
1999 These operands can be used by fuzzing engines to improve the quality
2000 of fuzzing coverage.
Randy Dunlapcc3fa842017-10-13 15:57:33 -07002001
Changbin Du09a74952019-12-06 17:03:51 -08002002config KCOV_INSTRUMENT_ALL
2003 bool "Instrument all code by default"
2004 depends on KCOV
2005 default y
2006 help
2007 If you are doing generic system call fuzzing (like e.g. syzkaller),
2008 then you will want to instrument the whole kernel and you should
2009 say y here. If you are doing more targeted fuzzing (like e.g.
2010 filesystem fuzzing with AFL) then you will want to enable coverage
2011 for more specific subsets of files, and should say n here.
Brendan Higgins84bc8092019-09-23 02:02:36 -07002012
Andrey Konovalov5ff3b302020-06-04 16:46:04 -07002013config KCOV_IRQ_AREA_SIZE
2014 hex "Size of interrupt coverage collection area in words"
2015 depends on KCOV
2016 default 0x40000
2017 help
2018 KCOV uses preallocated per-cpu areas to collect coverage from
2019 soft interrupts. This specifies the size of those areas in the
2020 number of unsigned long words.
2021
Vincent Legolld3deafa2018-02-06 15:38:38 -08002022menuconfig RUNTIME_TESTING_MENU
2023 bool "Runtime Testing"
Anders Roxell908009e82018-02-21 14:46:05 -08002024 def_bool y
Vincent Legolld3deafa2018-02-06 15:38:38 -08002025
2026if RUNTIME_TESTING_MENU
Dave Hansen881c5142013-07-01 13:04:44 -07002027
2028config LKDTM
2029 tristate "Linux Kernel Dump Test Tool Module"
2030 depends on DEBUG_FS
Dave Hansen881c5142013-07-01 13:04:44 -07002031 help
2032 This module enables testing of the different dumping mechanisms by
2033 inducing system failures at predefined crash points.
2034 If you don't need it: say N
2035 Choose M here to compile this code as a module. The module will be
2036 called lkdtm.
2037
2038 Documentation on how to use the module can be found in
Mauro Carvalho Chehab10ffebb2019-06-12 14:52:44 -03002039 Documentation/fault-injection/provoke-crashes.rst
Dave Hansen881c5142013-07-01 13:04:44 -07002040
2041config TEST_LIST_SORT
Daniel Latypovebd09572021-05-03 13:58:35 -07002042 tristate "Linked list sorting test" if !KUNIT_ALL_TESTS
2043 depends on KUNIT
2044 default KUNIT_ALL_TESTS
Dave Hansen881c5142013-07-01 13:04:44 -07002045 help
2046 Enable this to turn on 'list_sort()' function test. This test is
Geert Uytterhoevene327fd72017-05-08 15:55:26 -07002047 executed only once during system boot (so affects only boot time),
2048 or at module load time.
Dave Hansen881c5142013-07-01 13:04:44 -07002049
2050 If unsure, say N.
2051
Ian Rogers6e246282020-02-13 23:51:29 -08002052config 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
Kostenzer Felixc5adae92017-02-24 15:01:07 -08002062config TEST_SORT
Daniel Latypov36f33b52021-09-07 19:58:48 -07002063 tristate "Array-based sort test" if !KUNIT_ALL_TESTS
2064 depends on KUNIT
2065 default KUNIT_ALL_TESTS
Kostenzer Felixc5adae92017-02-24 15:01:07 -08002066 help
Geert Uytterhoeven5c4e6792017-05-08 15:55:23 -07002067 This option enables the self-test function of 'sort()' at boot,
2068 or at module load time.
Kostenzer Felixc5adae92017-02-24 15:01:07 -08002069
2070 If unsure, say N.
2071
Maciej W. Rozycki5086ea42021-04-20 04:50:28 +02002072config 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
Dave Hansen881c5142013-07-01 13:04:44 -07002082config KPROBES_SANITY_TEST
Sven Schnellee44e81c2021-10-21 09:54:24 +09002083 tristate "Kprobes sanity tests"
Dave Hansen881c5142013-07-01 13:04:44 -07002084 depends on DEBUG_KERNEL
2085 depends on KPROBES
Sven Schnellee44e81c2021-10-21 09:54:24 +09002086 depends on KUNIT
Dave Hansen881c5142013-07-01 13:04:44 -07002087 help
2088 This option provides for testing basic kprobes functionality on
Masami Hiramatsu5a6cf772018-06-20 01:05:07 +09002089 boot. Samples of kprobe and kretprobe are inserted and
Dave Hansen881c5142013-07-01 13:04:44 -07002090 verified for functionality.
2091
2092 Say N if you are unsure.
2093
2094config BACKTRACE_SELF_TEST
2095 tristate "Self test for the backtrace code"
2096 depends on DEBUG_KERNEL
Dave Hansen881c5142013-07-01 13:04:44 -07002097 help
2098 This option provides a kernel module that can be used to test
2099 the kernel stack backtrace code. This option is not useful
2100 for distributions or general kernels, but only for kernel
2101 developers working on architecture code.
2102
2103 Note that if you want to also test saved backtraces, you will
2104 have to enable STACKTRACE as well.
2105
2106 Say N if you are unsure.
2107
Michel Lespinasse910a7422012-10-08 16:30:39 -07002108config RBTREE_TEST
2109 tristate "Red-Black tree test"
Cody P Schafer7c993e12013-09-11 14:25:19 -07002110 depends on DEBUG_KERNEL
Michel Lespinasse910a7422012-10-08 16:30:39 -07002111 help
2112 A benchmark measuring the performance of the rbtree library.
2113 Also includes rbtree invariant checks.
2114
Ferdinand Blomqvist4b4f3ac2019-06-20 17:10:33 +03002115config REED_SOLOMON_TEST
2116 tristate "Reed-Solomon library test"
2117 depends on DEBUG_KERNEL || m
2118 select REED_SOLOMON
2119 select REED_SOLOMON_ENC16
2120 select REED_SOLOMON_DEC16
2121 help
2122 This option enables the self-test function of rslib at boot,
2123 or at module load time.
2124
2125 If unsure, say N.
2126
Michel Lespinassefff3fd82012-10-08 16:31:23 -07002127config INTERVAL_TREE_TEST
2128 tristate "Interval tree test"
Davidlohr Bueso0f789b62017-07-10 15:51:43 -07002129 depends on DEBUG_KERNEL
Chris Wilsona88cc102014-03-17 12:21:54 +00002130 select INTERVAL_TREE
Michel Lespinassefff3fd82012-10-08 16:31:23 -07002131 help
2132 A benchmark measuring the performance of the interval tree library
2133
Greg Thelen623fd802013-11-12 15:08:34 -08002134config PERCPU_TEST
2135 tristate "Per cpu operations test"
2136 depends on m && DEBUG_KERNEL
2137 help
2138 Enable this option to build test module which validates per-cpu
2139 operations.
2140
2141 If unsure, say N.
2142
Dave Hansen881c5142013-07-01 13:04:44 -07002143config ATOMIC64_SELFTEST
Geert Uytterhoeven55ded952017-02-24 15:00:55 -08002144 tristate "Perform an atomic64_t self-test"
Dave Hansen881c5142013-07-01 13:04:44 -07002145 help
Geert Uytterhoeven55ded952017-02-24 15:00:55 -08002146 Enable this option to test the atomic64_t functions at boot or
2147 at module load time.
Dave Hansen881c5142013-07-01 13:04:44 -07002148
2149 If unsure, say N.
2150
2151config ASYNC_RAID6_TEST
2152 tristate "Self test for hardware accelerated raid6 recovery"
2153 depends on ASYNC_RAID6_RECOV
2154 select ASYNC_MEMCPY
Masahiro Yamadaa7f7f622020-06-14 01:50:22 +09002155 help
Dave Hansen881c5142013-07-01 13:04:44 -07002156 This is a one-shot self test that permutes through the
2157 recovery of all the possible two disk failure scenarios for a
2158 N-disk array. Recovery is performed with the asynchronous
2159 raid6 recovery routines, and will optionally use an offload
2160 engine if one is available.
2161
2162 If unsure, say N.
2163
Andy Shevchenko64d1d772015-02-12 15:02:21 -08002164config TEST_HEXDUMP
2165 tristate "Test functions located in the hexdump module at runtime"
2166
Matteo Croceb2ff70a2021-07-29 14:53:35 -07002167config STRING_SELFTEST
2168 tristate "Test string functions at runtime"
2169
Dave Hansen881c5142013-07-01 13:04:44 -07002170config TEST_STRING_HELPERS
2171 tristate "Test functions located in the string_helpers module at runtime"
2172
Tobin C. Harding0b0600c82019-04-05 12:58:59 +11002173config TEST_STRSCPY
2174 tristate "Test strscpy*() family of functions at runtime"
2175
Dave Hansen881c5142013-07-01 13:04:44 -07002176config TEST_KSTRTOX
2177 tristate "Test kstrto*() family of functions at runtime"
2178
Rasmus Villemoes707cc722015-11-06 16:30:29 -08002179config TEST_PRINTF
2180 tristate "Test printf() family of functions at runtime"
2181
Richard Fitzgerald50f530e2021-05-14 17:12:05 +01002182config TEST_SCANF
2183 tristate "Test scanf() family of functions at runtime"
2184
David Decotigny5fd003f2016-02-19 09:24:00 -05002185config TEST_BITMAP
2186 tristate "Test bitmap_*() family of functions at runtime"
David Decotigny5fd003f2016-02-19 09:24:00 -05002187 help
2188 Enable this option to test the bitmap functions at boot.
2189
2190 If unsure, say N.
2191
Andy Shevchenkocfaff0e2016-05-30 17:40:41 +03002192config TEST_UUID
2193 tristate "Test functions located in the uuid module at runtime"
2194
Matthew Wilcoxad3d6c72017-11-07 14:57:46 -05002195config TEST_XARRAY
2196 tristate "Test the XArray code at runtime"
2197
Rasmus Villemoes455a35a2018-05-08 00:36:28 +02002198config TEST_OVERFLOW
2199 tristate "Test check_*_overflow() functions at runtime"
2200
Thomas Graf7e1e7762014-08-02 11:47:44 +02002201config TEST_RHASHTABLE
Geert Uytterhoeven9d6dbe12015-01-29 15:40:25 +01002202 tristate "Perform selftest on resizable hash table"
Thomas Graf7e1e7762014-08-02 11:47:44 +02002203 help
2204 Enable this option to test the rhashtable functions at boot.
2205
2206 If unsure, say N.
2207
George Spelvin468a9422016-05-26 22:11:51 -04002208config TEST_HASH
2209 tristate "Perform selftest on hash functions"
George Spelvin468a9422016-05-26 22:11:51 -04002210 help
Jason A. Donenfeld2c956a62017-01-08 13:54:00 +01002211 Enable this option to test the kernel's integer (<linux/hash.h>),
2212 string (<linux/stringhash.h>), and siphash (<linux/siphash.h>)
2213 hash functions on boot (or module load).
George Spelvin468a9422016-05-26 22:11:51 -04002214
2215 This is intended to help people writing architecture-specific
2216 optimized versions. If unsure, say N.
2217
Matthew Wilcox8ab8ba32018-06-18 16:59:29 -04002218config TEST_IDA
2219 tristate "Perform selftest on IDA functions"
2220
Jiri Pirko44091d22017-02-03 10:29:06 +01002221config TEST_PARMAN
2222 tristate "Perform selftest on priority array manager"
Jiri Pirko44091d22017-02-03 10:29:06 +01002223 depends on PARMAN
2224 help
2225 Enable this option to test priority array manager on boot
2226 (or module load).
2227
2228 If unsure, say N.
2229
Daniel Lezcano6aed82d2019-05-27 22:55:19 +02002230config TEST_IRQ_TIMINGS
2231 bool "IRQ timings selftest"
2232 depends on IRQ_TIMINGS
2233 help
2234 Enable this option to test the irq timings code on boot.
2235
2236 If unsure, say N.
2237
Valentin Rothberg8a6f0b42014-10-13 15:51:38 -07002238config TEST_LKM
Kees Cook93e9ef82014-01-23 15:54:37 -08002239 tristate "Test module loading with 'hello world' module"
Kees Cook93e9ef82014-01-23 15:54:37 -08002240 depends on m
2241 help
2242 This builds the "test_module" module that emits "Hello, world"
2243 on printk when loaded. It is designed to be used for basic
2244 evaluation of the module loading subsystem (for example when
2245 validating module verification). It lacks any extra dependencies,
2246 and will not normally be loaded by the system unless explicitly
2247 requested by name.
2248
2249 If unsure, say N.
2250
Jesse Brandeburgc348c162020-06-04 16:50:27 -07002251config TEST_BITOPS
Wei Yang6af132f2020-06-10 18:41:53 -07002252 tristate "Test module for compilation of bitops operations"
Jesse Brandeburgc348c162020-06-04 16:50:27 -07002253 depends on m
2254 help
2255 This builds the "test_bitops" module that is much like the
2256 TEST_LKM module except that it does a basic exercise of the
Wei Yang6af132f2020-06-10 18:41:53 -07002257 set/clear_bit macros and get_count_order/long to make sure there are
2258 no compiler warnings from C=1 sparse checker or -Wextra
2259 compilations. It has no dependencies and doesn't run or load unless
2260 explicitly requested by name. for example: modprobe test_bitops.
Jesse Brandeburgc348c162020-06-04 16:50:27 -07002261
2262 If unsure, say N.
2263
Uladzislau Rezki (Sony)3f21a6b2019-03-05 15:43:34 -08002264config TEST_VMALLOC
2265 tristate "Test module for stress/performance analysis of vmalloc allocator"
2266 default n
2267 depends on MMU
2268 depends on m
2269 help
2270 This builds the "test_vmalloc" module that should be used for
2271 stress and performance analysis. So, any new change for vmalloc
2272 subsystem can be evaluated from performance and stability point
2273 of view.
2274
2275 If unsure, say N.
2276
Kees Cook3e2a4c12014-01-23 15:54:38 -08002277config TEST_USER_COPY
2278 tristate "Test user/kernel boundary protections"
Kees Cook3e2a4c12014-01-23 15:54:38 -08002279 depends on m
2280 help
2281 This builds the "test_user_copy" module that runs sanity checks
2282 on the copy_to/from_user infrastructure, making sure basic
2283 user/kernel boundary testing is working. If it fails to load,
2284 a regression has been detected in the user/kernel memory boundary
2285 protections.
2286
2287 If unsure, say N.
2288
Alexei Starovoitov64a89462014-05-08 14:10:52 -07002289config TEST_BPF
2290 tristate "Test BPF filter functionality"
Randy Dunlap98920ba2014-05-13 09:58:44 -07002291 depends on m && NET
Alexei Starovoitov64a89462014-05-08 14:10:52 -07002292 help
2293 This builds the "test_bpf" module that runs various test vectors
2294 against the BPF interpreter or BPF JIT compiler depending on the
2295 current setting. This is in particular useful for BPF JIT compiler
2296 development, but also to run regression tests against changes in
Alexei Starovoitov3c731eb2014-09-26 00:17:07 -07002297 the interpreter code. It also enables test stubs for eBPF maps and
2298 verifier used by user space verifier testsuite.
Alexei Starovoitov64a89462014-05-08 14:10:52 -07002299
2300 If unsure, say N.
2301
Mahesh Bandewar509e56b2019-07-01 14:39:01 -07002302config TEST_BLACKHOLE_DEV
2303 tristate "Test blackhole netdev functionality"
2304 depends on m && NET
2305 help
2306 This builds the "test_blackhole_dev" module that validates the
2307 data path through this blackhole netdev.
2308
2309 If unsure, say N.
2310
Yury Norovdceeb3e2018-02-06 15:38:27 -08002311config FIND_BIT_BENCHMARK
Yury Norov4441fca2017-11-17 15:28:31 -08002312 tristate "Test find_bit functions"
Yury Norov4441fca2017-11-17 15:28:31 -08002313 help
2314 This builds the "test_find_bit" module that measure find_*_bit()
2315 functions performance.
2316
2317 If unsure, say N.
2318
Kees Cook0a8adf52014-07-14 14:38:12 -07002319config TEST_FIRMWARE
2320 tristate "Test firmware loading via userspace interface"
Kees Cook0a8adf52014-07-14 14:38:12 -07002321 depends on FW_LOADER
2322 help
2323 This builds the "test_firmware" module that creates a userspace
2324 interface for testing firmware loading. This can be used to
2325 control the triggering of firmware loading without needing an
2326 actual firmware-using device. The contents can be rechecked by
2327 userspace.
2328
2329 If unsure, say N.
2330
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -07002331config TEST_SYSCTL
2332 tristate "sysctl test driver"
Luis R. Rodriguez9308f2f2017-07-12 14:33:43 -07002333 depends on PROC_SYSCTL
2334 help
2335 This builds the "test_sysctl" module. This driver enables to test the
2336 proc sysctl interfaces available to drivers safely without affecting
2337 production knobs which might alter system functionality.
2338
2339 If unsure, say N.
2340
Vitor Massaru Ihad2585f52020-07-29 14:58:49 -03002341config BITFIELD_KUNIT
2342 tristate "KUnit test bitfield functions at runtime"
2343 depends on KUNIT
2344 help
2345 Enable this option to test the bitfield functions at boot.
2346
2347 KUnit tests run during boot and output the results to the debug log
2348 in TAP format (http://testanything.org/). Only useful for kernel devs
2349 running the KUnit test harness, and not intended for inclusion into a
2350 production build.
2351
2352 For more information on KUnit and unit tests in general please refer
2353 to the KUnit documentation in Documentation/dev-tools/kunit/.
2354
2355 If unsure, say N.
2356
Andy Shevchenko5df38ca2020-11-03 22:45:08 +02002357config RESOURCE_KUNIT_TEST
2358 tristate "KUnit test for resource API"
2359 depends on KUNIT
2360 help
2361 This builds the resource API unit test.
2362 Tests the logic of API provided by resource.c and ioport.h.
2363 For more information on KUnit and unit tests in general please refer
2364 to the KUnit documentation in Documentation/dev-tools/kunit/.
2365
2366 If unsure, say N.
2367
Iurii Zaikin2cb80db2019-09-23 02:02:47 -07002368config SYSCTL_KUNIT_TEST
Anders Roxell5f215aab2020-05-11 15:14:29 +02002369 tristate "KUnit test for sysctl" if !KUNIT_ALL_TESTS
Iurii Zaikin2cb80db2019-09-23 02:02:47 -07002370 depends on KUNIT
Anders Roxell5f215aab2020-05-11 15:14:29 +02002371 default KUNIT_ALL_TESTS
Iurii Zaikin2cb80db2019-09-23 02:02:47 -07002372 help
2373 This builds the proc sysctl unit test, which runs on boot.
2374 Tests the API contract and implementation correctness of sysctl.
2375 For more information on KUnit and unit tests in general please refer
2376 to the KUnit documentation in Documentation/dev-tools/kunit/.
2377
2378 If unsure, say N.
2379
David Gowea2dd7c2019-10-24 15:46:31 -07002380config LIST_KUNIT_TEST
Anders Roxell5f215aab2020-05-11 15:14:29 +02002381 tristate "KUnit Test for Kernel Linked-list structures" if !KUNIT_ALL_TESTS
David Gowea2dd7c2019-10-24 15:46:31 -07002382 depends on KUNIT
Anders Roxell5f215aab2020-05-11 15:14:29 +02002383 default KUNIT_ALL_TESTS
David Gowea2dd7c2019-10-24 15:46:31 -07002384 help
2385 This builds the linked list KUnit test suite.
2386 It tests that the API and basic functionality of the list_head type
2387 and associated macros.
2388
2389 KUnit tests run during boot and output the results to the debug log
Alexander A. Klimovd89775f2020-08-11 18:34:50 -07002390 in TAP format (https://testanything.org/). Only useful for kernel devs
David Gowea2dd7c2019-10-24 15:46:31 -07002391 running the KUnit test harness, and not intended for inclusion into a
2392 production build.
2393
2394 For more information on KUnit and unit tests in general please refer
2395 to the KUnit documentation in Documentation/dev-tools/kunit/.
2396
2397 If unsure, say N.
2398
Matti Vaittinen33d599f2020-05-08 18:40:43 +03002399config LINEAR_RANGES_TEST
2400 tristate "KUnit test for linear_ranges"
2401 depends on KUNIT
2402 select LINEAR_RANGES
2403 help
2404 This builds the linear_ranges unit test, which runs on boot.
2405 Tests the linear_ranges logic correctness.
2406 For more information on KUnit and unit tests in general please refer
2407 to the KUnit documentation in Documentation/dev-tools/kunit/.
2408
2409 If unsure, say N.
2410
Andy Shevchenko75468612020-12-15 20:43:34 -08002411config CMDLINE_KUNIT_TEST
2412 tristate "KUnit test for cmdline API"
2413 depends on KUNIT
2414 help
2415 This builds the cmdline API unit test.
2416 Tests the logic of API provided by cmdline.c.
2417 For more information on KUnit and unit tests in general please refer
2418 to the KUnit documentation in Documentation/dev-tools/kunit/.
2419
2420 If unsure, say N.
2421
Rikard Falkeborn6d511022020-08-11 18:35:03 -07002422config BITS_TEST
2423 tristate "KUnit test for bits.h"
2424 depends on KUNIT
2425 help
2426 This builds the bits unit test.
2427 Tests the logic of macros defined in bits.h.
2428 For more information on KUnit and unit tests in general please refer
2429 to the KUnit documentation in Documentation/dev-tools/kunit/.
2430
2431 If unsure, say N.
2432
Oliver Glitta1f9f78b2021-06-28 19:34:33 -07002433config SLUB_KUNIT_TEST
2434 tristate "KUnit test for SLUB cache error detection" if !KUNIT_ALL_TESTS
2435 depends on SLUB_DEBUG && KUNIT
2436 default KUNIT_ALL_TESTS
2437 help
2438 This builds SLUB allocator unit test.
2439 Tests SLUB cache debugging functionality.
2440 For more information on KUnit and unit tests in general please refer
2441 to the KUnit documentation in Documentation/dev-tools/kunit/.
2442
2443 If unsure, say N.
2444
Trent Piephob6c75c42021-06-30 18:55:52 -07002445config RATIONAL_KUNIT_TEST
2446 tristate "KUnit test for rational.c" if !KUNIT_ALL_TESTS
Geert Uytterhoeven8ba739e2021-09-07 19:58:36 -07002447 depends on KUNIT && RATIONAL
Trent Piephob6c75c42021-06-30 18:55:52 -07002448 default KUNIT_ALL_TESTS
2449 help
2450 This builds the rational math unit test.
2451 For more information on KUnit and unit tests in general please refer
2452 to the KUnit documentation in Documentation/dev-tools/kunit/.
2453
2454 If unsure, say N.
2455
Kees Cookbb95ebb2021-06-25 17:45:15 -07002456config MEMCPY_KUNIT_TEST
2457 tristate "Test memcpy(), memmove(), and memset() functions at runtime" if !KUNIT_ALL_TESTS
2458 depends on KUNIT
2459 default KUNIT_ALL_TESTS
2460 help
2461 Builds unit tests for memcpy(), memmove(), and memset() functions.
2462 For more information on KUnit and unit tests in general please refer
2463 to the KUnit documentation in Documentation/dev-tools/kunit/.
2464
2465 If unsure, say N.
2466
David Rileye704f932014-06-16 14:58:32 -07002467config TEST_UDELAY
2468 tristate "udelay test driver"
David Rileye704f932014-06-16 14:58:32 -07002469 help
2470 This builds the "udelay_test" module that helps to make sure
2471 that udelay() is working properly.
2472
2473 If unsure, say N.
2474
Ingo Molnar2bf9e0a2015-08-03 11:42:57 +02002475config TEST_STATIC_KEYS
2476 tristate "Test static keys"
Jason Baron579e1ac2015-07-30 03:59:44 +00002477 depends on m
2478 help
Ingo Molnar2bf9e0a2015-08-03 11:42:57 +02002479 Test the static key interfaces.
Jason Baron579e1ac2015-07-30 03:59:44 +00002480
2481 If unsure, say N.
2482
Luis R. Rodriguezd9c6a722017-07-14 14:50:08 -07002483config TEST_KMOD
2484 tristate "kmod stress tester"
Luis R. Rodriguezd9c6a722017-07-14 14:50:08 -07002485 depends on m
Luis R. Rodriguezd9c6a722017-07-14 14:50:08 -07002486 depends on NETDEVICES && NET_CORE && INET # for TUN
YueHaibingae3d6a32019-04-25 22:23:44 -07002487 depends on BLOCK
Luis R. Rodriguezd9c6a722017-07-14 14:50:08 -07002488 select TEST_LKM
2489 select XFS_FS
2490 select TUN
2491 select BTRFS_FS
2492 help
2493 Test the kernel's module loading mechanism: kmod. kmod implements
2494 support to load modules using the Linux kernel's usermode helper.
2495 This test provides a series of tests against kmod.
2496
2497 Although technically you can either build test_kmod as a module or
2498 into the kernel we disallow building it into the kernel since
2499 it stress tests request_module() and this will very likely cause
2500 some issues by taking over precious threads available from other
2501 module load requests, ultimately this could be fatal.
2502
2503 To run tests run:
2504
2505 tools/testing/selftests/kmod/kmod.sh --help
2506
2507 If unsure, say N.
2508
Florian Fainellie4dace32017-09-08 16:15:31 -07002509config TEST_DEBUG_VIRTUAL
2510 tristate "Test CONFIG_DEBUG_VIRTUAL feature"
2511 depends on DEBUG_VIRTUAL
2512 help
2513 Test the kernel's ability to detect incorrect calls to
2514 virt_to_phys() done against the non-linear part of the
2515 kernel's virtual address map.
2516
2517 If unsure, say N.
2518
Alexander Shishkince76d932018-10-05 15:43:05 +03002519config TEST_MEMCAT_P
2520 tristate "Test memcat_p() helper function"
2521 help
2522 Test the memcat_p() helper for correctly merging two
2523 pointer arrays together.
2524
2525 If unsure, say N.
2526
Joe Lawrencea2818ee2019-01-09 13:43:29 +01002527config TEST_LIVEPATCH
2528 tristate "Test livepatching"
2529 default n
Joe Lawrencebae05432019-01-31 11:41:24 -05002530 depends on DYNAMIC_DEBUG
Joe Lawrencea2818ee2019-01-09 13:43:29 +01002531 depends on LIVEPATCH
2532 depends on m
2533 help
2534 Test kernel livepatching features for correctness. The tests will
2535 load test modules that will be livepatched in various scenarios.
2536
2537 To run all the livepatching tests:
2538
2539 make -C tools/testing/selftests TARGETS=livepatch run_tests
2540
2541 Alternatively, individual tests may be invoked:
2542
2543 tools/testing/selftests/livepatch/test-callbacks.sh
2544 tools/testing/selftests/livepatch/test-livepatch.sh
2545 tools/testing/selftests/livepatch/test-shadow-vars.sh
2546
2547 If unsure, say N.
2548
Jiri Pirko0a020d42018-11-14 08:22:28 +00002549config TEST_OBJAGG
2550 tristate "Perform selftest on object aggreration manager"
2551 default n
2552 depends on OBJAGG
2553 help
2554 Enable this option to test object aggregation manager on boot
2555 (or module load).
2556
Jiri Pirko0a020d42018-11-14 08:22:28 +00002557
Kees Cook50ceaa95e2019-01-23 12:24:32 -07002558config TEST_STACKINIT
2559 tristate "Test level of stack variable initialization"
2560 help
2561 Test if the kernel is zero-initializing stack variables and
2562 padding. Coverage is controlled by compiler flags,
2563 CONFIG_GCC_PLUGIN_STRUCTLEAK, CONFIG_GCC_PLUGIN_STRUCTLEAK_BYREF,
2564 or CONFIG_GCC_PLUGIN_STRUCTLEAK_BYREF_ALL.
2565
2566 If unsure, say N.
2567
Alexander Potapenko5015a302019-07-16 16:27:27 -07002568config TEST_MEMINIT
2569 tristate "Test heap/page initialization"
2570 help
2571 Test if the kernel is zero-initializing heap and page allocations.
2572 This can be useful to test init_on_alloc and init_on_free features.
2573
2574 If unsure, say N.
2575
Ralph Campbellb2ef9f52020-04-22 12:50:26 -07002576config TEST_HMM
2577 tristate "Test HMM (Heterogeneous Memory Management)"
2578 depends on TRANSPARENT_HUGEPAGE
2579 depends on DEVICE_PRIVATE
2580 select HMM_MIRROR
2581 select MMU_NOTIFIER
2582 help
2583 This is a pseudo device driver solely for testing HMM.
2584 Say M here if you want to build the HMM test module.
2585 Doing so will allow you to run tools/testing/selftest/vm/hmm-tests.
2586
2587 If unsure, say N.
2588
Matthew Wilcox (Oracle)e320d302020-10-13 16:56:04 -07002589config TEST_FREE_PAGES
2590 tristate "Test freeing pages"
2591 help
2592 Test that a memory leak does not occur due to a race between
2593 freeing a block of pages and a speculative page reference.
2594 Loading this module is safe if your kernel has the bug fixed.
2595 If the bug is not fixed, it will leak gigabytes of memory and
2596 probably OOM your system.
2597
Petteri Aimonen4185b3b2020-06-18 16:37:37 +02002598config TEST_FPU
2599 tristate "Test floating point operations in kernel space"
2600 depends on X86 && !KCOV_INSTRUMENT_ALL
2601 help
2602 Enable this option to add /sys/kernel/debug/selftest_helpers/test_fpu
2603 which will trigger a sequence of floating point operations. This is used
2604 for self-testing floating point control register setting in
2605 kernel_fpu_begin().
2606
2607 If unsure, say N.
2608
Paul E. McKenney1253b9b2021-05-27 12:01:23 -07002609config TEST_CLOCKSOURCE_WATCHDOG
2610 tristate "Test clocksource watchdog in kernel space"
2611 depends on CLOCKSOURCE_WATCHDOG
2612 help
2613 Enable this option to create a kernel module that will trigger
2614 a test of the clocksource watchdog. This module may be loaded
2615 via modprobe or insmod in which case it will run upon being
2616 loaded, or it may be built in, in which case it will run
2617 shortly after boot.
2618
2619 If unsure, say N.
2620
Vincent Legolld3deafa2018-02-06 15:38:38 -08002621endif # RUNTIME_TESTING_MENU
Randy Dunlapcc3fa842017-10-13 15:57:33 -07002622
Anshuman Khandualdce44562021-04-29 22:55:15 -07002623config ARCH_USE_MEMTEST
2624 bool
2625 help
2626 An architecture should select this when it uses early_memtest()
2627 during boot process.
2628
Randy Dunlapcc3fa842017-10-13 15:57:33 -07002629config MEMTEST
2630 bool "Memtest"
Anshuman Khandualdce44562021-04-29 22:55:15 -07002631 depends on ARCH_USE_MEMTEST
Masahiro Yamadaa7f7f622020-06-14 01:50:22 +09002632 help
Randy Dunlapcc3fa842017-10-13 15:57:33 -07002633 This option adds a kernel parameter 'memtest', which allows memtest
Anshuman Khandualdce44562021-04-29 22:55:15 -07002634 to be set and executed.
Randy Dunlapcc3fa842017-10-13 15:57:33 -07002635 memtest=0, mean disabled; -- default
2636 memtest=1, mean do 1 test pattern;
2637 ...
2638 memtest=17, mean do 17 test patterns.
2639 If you are unsure how to answer this question, answer N.
2640
Randy Dunlapcc3fa842017-10-13 15:57:33 -07002641
Christoph Hellwig06ec64b2018-07-31 13:39:31 +02002642
Branden Bonabyaf9ca6f2019-10-03 17:01:49 -04002643config HYPERV_TESTING
2644 bool "Microsoft Hyper-V driver testing"
2645 default n
2646 depends on HYPERV && DEBUG_FS
2647 help
2648 Select this option to enable Hyper-V vmbus testing.
2649
Changbin Du045f6d72019-12-17 20:51:56 -08002650endmenu # "Kernel Testing and Coverage"
2651
Mauro Carvalho Chehab75442fb2020-10-30 08:40:45 +01002652source "Documentation/Kconfig"
2653
Christoph Hellwig06ec64b2018-07-31 13:39:31 +02002654endmenu # Kernel hacking