Kconfig.debug 12.7 KB
Newer Older
1
# SPDX-License-Identifier: GPL-2.0
Linus Torvalds's avatar
Linus Torvalds committed
2 3
menu "Kernel hacking"

4
config TRACE_IRQFLAGS_SUPPORT
5
	def_bool y
6

Linus Torvalds's avatar
Linus Torvalds committed
7 8
source "lib/Kconfig.debug"

9 10 11
config EARLY_PRINTK_USB
	bool

12 13 14
config X86_VERBOSE_BOOTUP
	bool "Enable verbose x86 bootup info messages"
	default y
15
	---help---
16 17 18 19
	  Enables the informational output from the decompression stage
	  (e.g. bzImage) of the boot. If you disable this you will still
	  see errors. Disable this if you want silent bootup.

Linus Torvalds's avatar
Linus Torvalds committed
20
config EARLY_PRINTK
21
	bool "Early printk" if EXPERT
Linus Torvalds's avatar
Linus Torvalds committed
22
	default y
23
	---help---
Linus Torvalds's avatar
Linus Torvalds committed
24 25 26 27 28 29
	  Write kernel log output directly into the VGA buffer or to a serial
	  port.

	  This is useful for kernel debugging when your machine crashes very
	  early before the console code is initialized. For normal operation
	  it is not recommended because it looks ugly and doesn't cooperate
30
	  with klogd/syslogd or the X server. You should normally say N here,
Linus Torvalds's avatar
Linus Torvalds committed
31 32
	  unless you want to debug such a crash.

33 34
config EARLY_PRINTK_DBGP
	bool "Early printk via EHCI debug port"
35
	depends on EARLY_PRINTK && PCI
36
	select EARLY_PRINTK_USB
37
	---help---
38 39 40 41 42
	  Write kernel log output directly into the EHCI debug port.

	  This is useful for kernel debugging when your machine crashes very
	  early before the console code is initialized. For normal operation
	  it is not recommended because it looks ugly and doesn't cooperate
43
	  with klogd/syslogd or the X server. You should normally say N here,
44 45
	  unless you want to debug such a crash. You need usb debug device.

46 47 48 49 50 51 52 53 54 55
config EARLY_PRINTK_EFI
	bool "Early printk via the EFI framebuffer"
	depends on EFI && EARLY_PRINTK
	select FONT_SUPPORT
	---help---
	  Write kernel log output directly into the EFI framebuffer.

	  This is useful for kernel debugging when your machine crashes very
	  early before the console code is initialized.

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
config EARLY_PRINTK_USB_XDBC
	bool "Early printk via the xHCI debug port"
	depends on EARLY_PRINTK && PCI
	select EARLY_PRINTK_USB
	---help---
	  Write kernel log output directly into the xHCI debug port.

	  One use for this feature is kernel debugging, for example when your
	  machine crashes very early before the regular console code is
	  initialized. Other uses include simpler, lockless logging instead of
	  a full-blown printk console driver + klogd.

	  For normal production environments this is normally not recommended,
	  because it doesn't feed events into klogd/syslogd and doesn't try to
	  print anything on the screen.

	  You should normally say N here, unless you want to debug early
	  crashes or need a very simple printk logging facility.

75 76 77
config X86_PTDUMP_CORE
	def_bool n

78
config X86_PTDUMP
79
	tristate "Export kernel pagetable layout to userspace via debugfs"
80
	depends on DEBUG_KERNEL
81
	select DEBUG_FS
82
	select X86_PTDUMP_CORE
83
	---help---
84 85 86 87 88 89 90
	  Say Y here if you want to show the kernel pagetable layout in a
	  debugfs file. This information is only useful for kernel developers
	  who are working in architecture specific areas of the kernel.
	  It is probably not a good idea to enable this feature in a production
	  kernel.
	  If in doubt, say "N"

91 92
config EFI_PGT_DUMP
	bool "Dump the EFI pagetable"
93 94
	depends on EFI
	select X86_PTDUMP_CORE
95 96 97 98 99 100
	---help---
	  Enable this if you want to dump the EFI page table before
	  enabling virtual mode. This can be used to debug miscellaneous
	  issues with the mapping of the EFI runtime regions into that
	  table.

101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127
config DEBUG_WX
	bool "Warn on W+X mappings at boot"
	select X86_PTDUMP_CORE
	---help---
	  Generate a warning if any W+X mappings are found at boot.

	  This is useful for discovering cases where the kernel is leaving
	  W+X mappings after applying NX, as such mappings are a security risk.

	  Look for a message in dmesg output like this:

	    x86/mm: Checked W+X mappings: passed, no W+X pages found.

	  or like this, if the check failed:

	    x86/mm: Checked W+X mappings: FAILED, <N> W+X pages found.

	  Note that even if the check fails, your kernel is possibly
	  still fine, as W+X mappings are not a security hole in
	  themselves, what they do is that they make the exploitation
	  of other unfixed kernel bugs easier.

	  There is no runtime or memory usage effect of this option
	  once the kernel has booted up - it's a one time check.

	  If in doubt, say "Y".

128 129
config DOUBLEFAULT
	default y
130
	bool "Enable doublefault exception handler" if EXPERT
131
	---help---
132 133 134 135 136
	  This option allows trapping of rare doublefault exceptions that
	  would otherwise cause a system to silently reboot. Disabling this
	  option saves about 4k and might cause you much additional grey
	  hair.

137 138
config DEBUG_TLBFLUSH
	bool "Set upper limit of TLB entries to flush one-by-one"
139
	depends on DEBUG_KERNEL
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
	---help---

	X86-only for now.

	This option allows the user to tune the amount of TLB entries the
	kernel flushes one-by-one instead of doing a full TLB flush. In
	certain situations, the former is cheaper. This is controlled by the
	tlb_flushall_shift knob under /sys/kernel/debug/x86. If you set it
	to -1, the code flushes the whole TLB unconditionally. Otherwise,
	for positive values of it, the kernel will use single TLB entry
	invalidating instructions according to the following formula:

	flush_entries <= active_tlb_entries / 2^tlb_flushall_shift

	If in doubt, say "N".

156 157
config IOMMU_DEBUG
	bool "Enable IOMMU debugging"
158
	depends on GART_IOMMU && DEBUG_KERNEL
159
	depends on X86_64
160
	---help---
161 162 163 164 165 166 167 168
	  Force the IOMMU to on even when you have less than 4GB of
	  memory and add debugging code. On overflow always panic. And
	  allow to enable IOMMU leak tracing. Can be disabled at boot
	  time with iommu=noforce. This will also enable scatter gather
	  list merging.  Currently not recommended for production
	  code. When you use it make sure you have a big enough
	  IOMMU/AGP aperture.  Most of the options enabled by this can
	  be set more finegrained using the iommu= command line
Paul Bolle's avatar
Paul Bolle committed
169
	  options. See Documentation/x86/x86_64/boot-options.txt for more
170 171
	  details.

172 173 174 175 176 177 178 179
config IOMMU_STRESS
	bool "Enable IOMMU stress-test mode"
	---help---
	  This option disables various optimizations in IOMMU related
	  code to do real stress testing of the IOMMU code. This option
	  will cause a performance drop and should only be enabled for
	  testing.

180 181
config IOMMU_LEAK
	bool "IOMMU leak tracing"
182
	depends on IOMMU_DEBUG && DMA_API_DEBUG
183
	---help---
184 185 186
	  Add a simple leak tracer to the IOMMU code. This is useful when you
	  are debugging a buggy device driver that leaks IOMMU mappings.

187 188
config HAVE_MMIOTRACE_SUPPORT
	def_bool y
189

190
config X86_DECODER_SELFTEST
191 192
	bool "x86 instruction decoder selftest"
	depends on DEBUG_KERNEL && KPROBES
193
	depends on !COMPILE_TEST
194 195 196 197 198 199
	---help---
	 Perform x86 instruction decoder selftests at build time.
	 This option is useful for checking the sanity of x86 instruction
	 decoder code.
	 If unsure, say "N".

200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
#
# IO delay types:
#

config IO_DELAY_TYPE_0X80
	int
	default "0"

config IO_DELAY_TYPE_0XED
	int
	default "1"

config IO_DELAY_TYPE_UDELAY
	int
	default "2"

config IO_DELAY_TYPE_NONE
	int
	default "3"

choice
	prompt "IO delay type"
222
	default IO_DELAY_0X80
223 224 225

config IO_DELAY_0X80
	bool "port 0x80 based port-IO delay [recommended]"
226
	---help---
227 228 229 230 231
	  This is the traditional Linux IO delay used for in/out_p.
	  It is the most tested hence safest selection here.

config IO_DELAY_0XED
	bool "port 0xed based port-IO delay"
232
	---help---
233 234 235 236 237
	  Use port 0xed as the IO delay. This frees up port 0x80 which is
	  often used as a hardware-debug port.

config IO_DELAY_UDELAY
	bool "udelay based port-IO delay"
238
	---help---
239 240 241 242 243
	  Use udelay(2) as the IO delay method. This provides the delay
	  while not having any side-effect on the IO port space.

config IO_DELAY_NONE
	bool "no port-IO delay"
244
	---help---
245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
	  No port-IO delay. Will break on old boxes that require port-IO
	  delay for certain operations. Should work on most new machines.

endchoice

if IO_DELAY_0X80
config DEFAULT_IO_DELAY_TYPE
	int
	default IO_DELAY_TYPE_0X80
endif

if IO_DELAY_0XED
config DEFAULT_IO_DELAY_TYPE
	int
	default IO_DELAY_TYPE_0XED
endif

if IO_DELAY_UDELAY
config DEFAULT_IO_DELAY_TYPE
	int
	default IO_DELAY_TYPE_UDELAY
endif

if IO_DELAY_NONE
config DEFAULT_IO_DELAY_TYPE
	int
	default IO_DELAY_TYPE_NONE
endif
273

274 275 276 277
config DEBUG_BOOT_PARAMS
	bool "Debug boot parameters"
	depends on DEBUG_KERNEL
	depends on DEBUG_FS
278
	---help---
279 280
	  This option will cause struct boot_params to be exported via debugfs.

281
config CPA_DEBUG
282
	bool "CPA self-test code"
283
	depends on DEBUG_KERNEL
284
	---help---
285
	  Do change_page_attr() self-tests every 30 seconds.
286

287 288
config OPTIMIZE_INLINING
	bool "Allow gcc to uninline functions marked 'inline'"
289
	---help---
290 291 292 293
	  This option determines if the kernel forces gcc to inline the functions
	  developers have marked 'inline'. Doing so takes away freedom from gcc to
	  do what it thinks is best, which is desirable for the gcc 3.x series of
	  compilers. The gcc 4.x series have a rewritten inlining algorithm and
294 295 296 297
	  enabling this option will generate a smaller kernel there. Hopefully
	  this algorithm is so good that allowing gcc 4.x and above to make the
	  decision will become the default in the future. Until then this option
	  is there to test gcc for this.
Ingo Molnar's avatar
Ingo Molnar committed
298

299 300
	  If unsure, say N.

301 302 303 304 305 306 307 308 309 310
config DEBUG_ENTRY
	bool "Debug low-level entry code"
	depends on DEBUG_KERNEL
	---help---
	  This option enables sanity checks in x86's low-level entry code.
	  Some of these sanity checks may slow down kernel entries and
	  exits or otherwise impact performance.

	  If unsure, say N.

311 312
config DEBUG_NMI_SELFTEST
	bool "NMI Selftest"
313
	depends on DEBUG_KERNEL && X86_LOCAL_APIC
314 315 316 317 318 319 320 321 322
	---help---
	  Enabling this option turns on a quick NMI selftest to verify
	  that the NMI behaves correctly.

	  This might help diagnose strange hangs that rely on NMI to
	  function properly.

	  If unsure, say N.

323 324 325 326 327 328 329 330 331 332 333 334 335
config DEBUG_IMR_SELFTEST
	bool "Isolated Memory Region self test"
	default n
	depends on INTEL_IMR
	---help---
	  This option enables automated sanity testing of the IMR code.
	  Some simple tests are run to verify IMR bounds checking, alignment
	  and overlapping. This option is really only useful if you are
	  debugging an IMR memory map or are modifying the IMR code and want to
	  test your changes.

	  If unsure say N here.

336 337 338 339 340 341 342 343 344 345 346 347
config X86_DEBUG_FPU
	bool "Debug the x86 FPU code"
	depends on DEBUG_KERNEL
	default y
	---help---
	  If this option is enabled then there will be extra sanity
	  checks and (boot time) debug printouts added to the kernel.
	  This debugging adds some small amount of runtime overhead
	  to the kernel.

	  If unsure, say N.

348 349
config PUNIT_ATOM_DEBUG
	tristate "ATOM Punit debug driver"
350
	depends on PCI
351 352 353 354 355 356 357 358 359
	select DEBUG_FS
	select IOSF_MBI
	---help---
	  This is a debug driver, which gets the power states
	  of all Punit North Complex devices. The power states of
	  each device is exposed as part of the debugfs interface.
	  The current power state can be read from
	  /sys/kernel/debug/punit_atom/dev_power_state

360 361
choice
	prompt "Choose kernel unwinder"
362 363
	default UNWINDER_ORC if X86_64
	default UNWINDER_FRAME_POINTER if X86_32
364 365 366 367 368
	---help---
	  This determines which method will be used for unwinding kernel stack
	  traces for panics, oopses, bugs, warnings, perf, /proc/<pid>/stack,
	  livepatch, lockdep, and more.

369
config UNWINDER_ORC
370
	bool "ORC unwinder"
371
	depends on X86_64
372 373 374 375 376 377 378
	select STACK_VALIDATION
	---help---
	  This option enables the ORC (Oops Rewind Capability) unwinder for
	  unwinding kernel stack traces.  It uses a custom data format which is
	  a simplified version of the DWARF Call Frame Information standard.

	  This unwinder is more accurate across interrupt entry frames than the
379 380
	  frame pointer unwinder.  It also enables a 5-10% performance
	  improvement across the entire kernel compared to frame pointers.
381 382 383 384

	  Enabling this option will increase the kernel's runtime memory usage
	  by roughly 2-4MB, depending on your kernel config.

385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
config UNWINDER_FRAME_POINTER
	bool "Frame pointer unwinder"
	select FRAME_POINTER
	---help---
	  This option enables the frame pointer unwinder for unwinding kernel
	  stack traces.

	  The unwinder itself is fast and it uses less RAM than the ORC
	  unwinder, but the kernel text size will grow by ~3% and the kernel's
	  overall performance will degrade by roughly 5-10%.

	  This option is recommended if you want to use the livepatch
	  consistency model, as this is currently the only way to get a
	  reliable stack trace (CONFIG_HAVE_RELIABLE_STACKTRACE).

400
config UNWINDER_GUESS
401 402 403 404 405 406 407 408 409 410 411 412 413 414
	bool "Guess unwinder"
	depends on EXPERT
	---help---
	  This option enables the "guess" unwinder for unwinding kernel stack
	  traces.  It scans the stack and reports every kernel text address it
	  finds.  Some of the addresses it reports may be incorrect.

	  While this option often produces false positives, it can still be
	  useful in many cases.  Unlike the other unwinders, it has no runtime
	  overhead.

endchoice

config FRAME_POINTER
415
	depends on !UNWINDER_ORC && !UNWINDER_GUESS
416
	bool
417

Ingo Molnar's avatar
Ingo Molnar committed
418
endmenu