lib/Kconfig.debug

   1
   2 config PRINTK_TIME
   3         bool "Show timing information on printks"
   4         depends on PRINTK
   5         help
   6           Selecting this option causes timing information to be
   7           included in printk output.  This allows you to measure
   8           the interval between kernel operations, including bootup
   9           operations.  This is useful for identifying long delays
  10           in kernel startup.
  11
  12 config ENABLE_WARN_DEPRECATED
  13         bool "Enable __deprecated logic"
  14         default y
  15         help
  16           Enable the __deprecated logic in the kernel build.
  17           Disable this to suppress the "warning: 'foo' is deprecated
  18           (declared at kernel/power/somefile.c:1234)" messages.
  19
  20 config ENABLE_MUST_CHECK
  21         bool "Enable __must_check logic"
  22         default y
  23         help
  24           Enable the __must_check logic in the kernel build.  Disable this to
  25           suppress the "warning: ignoring return value of 'foo', declared with
  26           attribute warn_unused_result" messages.
  27
  28 config MAGIC_SYSRQ
  29         bool "Magic SysRq key"
  30         depends on !UML
  31         help
  32           If you say Y here, you will have some control over the system even
  33           if the system crashes for example during kernel debugging (e.g., you
  34           will be able to flush the buffer cache to disk, reboot the system
  35           immediately or dump some status information). This is accomplished
  36           by pressing various keys while holding SysRq (Alt+PrintScreen). It
  37           also works on a serial console (on PC hardware at least), if you
  38           send a BREAK and then within 5 seconds a command keypress. The
  39           keys are documented in <file:Documentation/sysrq.txt>. Don't say Y
  40           unless you really know what this hack does.
  41
  42 config UNUSED_SYMBOLS
  43         bool "Enable unused/obsolete exported symbols"
  44         default y if X86
  45         help
  46           Unused but exported symbols make the kernel needlessly bigger.  For
  47           that reason most of these unused exports will soon be removed.  This
  48           option is provided temporarily to provide a transition period in case
  49           some external kernel module needs one of these symbols anyway. If you
  50           encounter such a case in your module, consider if you are actually
  51           using the right API.  (rationale: since nobody in the kernel is using
  52           this in a module, there is a pretty good chance it's actually the
  53           wrong interface to use).  If you really need the symbol, please send a
  54           mail to the linux kernel mailing list mentioning the symbol and why
  55           you really need it, and what the merge plan to the mainline kernel for
  56           your module is.
  57
  58 config PAGE_OWNER
  59         bool "Track page owner"
  60         depends on DEBUG_KERNEL
  61         help
  62           This keeps track of what call chain is the owner of a page, may
  63           help to find bare alloc_page(s) leaks. Eats a fair amount of memory.
  64           See Documentation/page_owner.c for user-space helper.
  65
  66           If unsure, say N.
  67
  68 config DEBUG_FS
  69         bool "Debug Filesystem"
  70         depends on SYSFS
  71         help
  72           debugfs is a virtual file system that kernel developers use to put
  73           debugging files into.  Enable this option to be able to read and
  74           write to these files.
  75
  76           If unsure, say N.
  77
  78 config HEADERS_CHECK
  79         bool "Run 'make headers_check' when building vmlinux"
  80         depends on !UML
  81         help
  82           This option will extract the user-visible kernel headers whenever
  83           building the kernel, and will run basic sanity checks on them to
  84           ensure that exported files do not attempt to include files which
  85           were not exported, etc.
  86
  87           If you're making modifications to header files which are
  88           relevant for userspace, say 'Y', and check the headers
  89           exported to $(INSTALL_HDR_PATH) (usually 'usr/include' in
  90           your build tree), to make sure they're suitable.
  91
  92 config DEBUG_KERNEL
  93         bool "Kernel debugging"
  94         help
  95           Say Y here if you are developing drivers or trying to debug and
  96           identify kernel problems.
  97
  98 config DEBUG_SHIRQ
  99         bool "Debug shared IRQ handlers"
 100         depends on DEBUG_KERNEL && GENERIC_HARDIRQS
 101         help
 102           Enable this to generate a spurious interrupt as soon as a shared
 103           interrupt handler is registered, and just before one is deregistered.
 104           Drivers ought to be able to handle interrupts coming in at those
 105           points; some don't and need to be caught.
 106
 107 config DETECT_SOFTLOCKUP
 108         bool "Detect Soft Lockups"
 109         depends on DEBUG_KERNEL && !S390
 110         default y
 111         help
 112           Say Y here to enable the kernel to detect "soft lockups",
 113           which are bugs that cause the kernel to loop in kernel
 114           mode for more than 10 seconds, without giving other tasks a
 115           chance to run.
 116
 117           When a soft-lockup is detected, the kernel will print the
 118           current stack trace (which you should report), but the
 119           system will stay locked up. This feature has negligible
 120           overhead.
 121
 122           (Note that "hard lockups" are separate type of bugs that
 123            can be detected via the NMI-watchdog, on platforms that
 124            support it.)
 125
 126 config SCHED_DEBUG
 127         bool "Collect scheduler debugging info"
 128         depends on DEBUG_KERNEL && PROC_FS
 129         default y
 130         help
 131           If you say Y here, the /proc/sched_debug file will be provided
 132           that can help debug the scheduler. The runtime overhead of this
 133           option is minimal.
 134
 135 config SCHEDSTATS
 136         bool "Collect scheduler statistics"
 137         depends on DEBUG_KERNEL && PROC_FS
 138         help
 139           If you say Y here, additional code will be inserted into the
 140           scheduler and related routines to collect statistics about
 141           scheduler behavior and provide them in /proc/schedstat.  These
 142           stats may be useful for both tuning and debugging the scheduler
 143           If you aren't debugging the scheduler or trying to tune a specific
 144           application, you can say N to avoid the very slight overhead
 145           this adds.
 146
 147 config TIMER_STATS
 148         bool "Collect kernel timers statistics"
 149         depends on DEBUG_KERNEL && PROC_FS
 150         help
 151           If you say Y here, additional code will be inserted into the
 152           timer routines to collect statistics about kernel timers being
 153           reprogrammed. The statistics can be read from /proc/timer_stats.
 154           The statistics collection is started by writing 1 to /proc/timer_stats,
 155           writing 0 stops it. This feature is useful to collect information
 156           about timer usage patterns in kernel and userspace. This feature
 157           is lightweight if enabled in the kernel config but not activated
 158           (it defaults to deactivated on bootup and will only be activated
 159           if some application like powertop activates it explicitly).
 160
 161 config DEBUG_SLAB
 162         bool "Debug slab memory allocations"
 163         depends on DEBUG_KERNEL && SLAB
 164         help
 165           Say Y here to have the kernel do limited verification on memory
 166           allocation as well as poisoning memory on free to catch use of freed
 167           memory. This can make kmalloc/kfree-intensive workloads much slower.
 168
 169 config DEBUG_GPIO
 170         bool "Debug GPIO calls"
 171         depends on DEBUG_KERNEL && GPIO_LIB
 172         help
 173           Say Y here to add some extra checks to GPIO calls, ensuring that
 174           GPIOs have been properly initialized before they are used and
 175           that sleeping calls aren't made from nonsleeping contexts.  This
 176           can make bitbanged serial protocols slower.
 177
 178 config DEBUG_SLAB_LEAK
 179         bool "Slab memory leak debugging"
 180         depends on DEBUG_SLAB
 181         default y
 182         help
 183           Enable /proc/slab_allocators - provides detailed information about
 184           which parts of the kernel are using slab objects.  May be used for
 185           tracking memory leaks and for instrumenting memory usage.
 186
 187 config SLUB_DEBUG_ON
 188         bool "SLUB debugging on by default"
 189         depends on SLUB && SLUB_DEBUG
 190         default n
 191         help
 192           Boot with debugging on by default. SLUB boots by default with
 193           the runtime debug capabilities switched off. Enabling this is
 194           equivalent to specifying the "slub_debug" parameter on boot.
 195           There is no support for more fine grained debug control like
 196           possible with slub_debug=xxx. SLUB debugging may be switched
 197           off in a kernel built with CONFIG_SLUB_DEBUG_ON by specifying
 198           "slub_debug=-".
 199
 200 config DEBUG_PREEMPT
 201         bool "Debug preemptible kernel"
 202         depends on DEBUG_KERNEL && PREEMPT && (TRACE_IRQFLAGS_SUPPORT || PPC64)
 203         default y
 204         help
 205           If you say Y here then the kernel will use a debug variant of the
 206           commonly used smp_processor_id() function and will print warnings
 207           if kernel code uses it in a preemption-unsafe way. Also, the kernel
 208           will detect preemption count underflows.
 209
 210 config DEBUG_RT_MUTEXES
 211         bool "RT Mutex debugging, deadlock detection"
 212         depends on DEBUG_KERNEL && RT_MUTEXES
 213         help
 214          This allows rt mutex semantics violations and rt mutex related
 215          deadlocks (lockups) to be detected and reported automatically.
 216
 217 config DEBUG_PI_LIST
 218         bool
 219         default y
 220         depends on DEBUG_RT_MUTEXES
 221
 222 config RT_MUTEX_TESTER
 223         bool "Built-in scriptable tester for rt-mutexes"
 224         depends on DEBUG_KERNEL && RT_MUTEXES
 225         help
 226           This option enables a rt-mutex tester.
 227
 228 config DEBUG_SPINLOCK
 229         bool "Spinlock and rw-lock debugging: basic checks"
 230         depends on DEBUG_KERNEL
 231         help
 232           Say Y here and build SMP to catch missing spinlock initialization
 233           and certain other kinds of spinlock errors commonly made.  This is
 234           best used in conjunction with the NMI watchdog so that spinlock
 235           deadlocks are also debuggable.
 236
 237 config DEBUG_MUTEXES
 238         bool "Mutex debugging: basic checks"
 239         depends on DEBUG_KERNEL
 240         help
 241          This feature allows mutex semantics violations to be detected and
 242          reported.
 243
 244 config DEBUG_SEMAPHORE
 245         bool "Semaphore debugging"
 246         depends on DEBUG_KERNEL
 247         depends on ALPHA || FRV
 248         default n
 249         help
 250           If you say Y here then semaphore processing will issue lots of
 251           verbose debugging messages.  If you suspect a semaphore problem or a
 252           kernel hacker asks for this option then say Y.  Otherwise say N.
 253
 254 config DEBUG_LOCK_ALLOC
 255         bool "Lock debugging: detect incorrect freeing of live locks"
 256         depends on DEBUG_KERNEL && TRACE_IRQFLAGS_SUPPORT && STACKTRACE_SUPPORT && LOCKDEP_SUPPORT
 257         select DEBUG_SPINLOCK
 258         select DEBUG_MUTEXES
 259         select LOCKDEP
 260         help
 261          This feature will check whether any held lock (spinlock, rwlock,
 262          mutex or rwsem) is incorrectly freed by the kernel, via any of the
 263          memory-freeing routines (kfree(), kmem_cache_free(), free_pages(),
 264          vfree(), etc.), whether a live lock is incorrectly reinitialized via
 265          spin_lock_init()/mutex_init()/etc., or whether there is any lock
 266          held during task exit.
 267
 268 config PROVE_LOCKING
 269         bool "Lock debugging: prove locking correctness"
 270         depends on DEBUG_KERNEL && TRACE_IRQFLAGS_SUPPORT && STACKTRACE_SUPPORT && LOCKDEP_SUPPORT
 271         select LOCKDEP
 272         select DEBUG_SPINLOCK
 273         select DEBUG_MUTEXES
 274         select DEBUG_LOCK_ALLOC
 275         default n
 276         help
 277          This feature enables the kernel to prove that all locking
 278          that occurs in the kernel runtime is mathematically
 279          correct: that under no circumstance could an arbitrary (and
 280          not yet triggered) combination of observed locking
 281          sequences (on an arbitrary number of CPUs, running an
 282          arbitrary number of tasks and interrupt contexts) cause a
 283          deadlock.
 284
 285          In short, this feature enables the kernel to report locking
 286          related deadlocks before they actually occur.
 287
 288          The proof does not depend on how hard and complex a
 289          deadlock scenario would be to trigger: how many
 290          participant CPUs, tasks and irq-contexts would be needed
 291          for it to trigger. The proof also does not depend on
 292          timing: if a race and a resulting deadlock is possible
 293          theoretically (no matter how unlikely the race scenario
 294          is), it will be proven so and will immediately be
 295          reported by the kernel (once the event is observed that
 296          makes the deadlock theoretically possible).
 297
 298          If a deadlock is impossible (i.e. the locking rules, as
 299          observed by the kernel, are mathematically correct), the
 300          kernel reports nothing.
 301
 302          NOTE: this feature can also be enabled for rwlocks, mutexes
 303          and rwsems - in which case all dependencies between these
 304          different locking variants are observed and mapped too, and
 305          the proof of observed correctness is also maintained for an
 306          arbitrary combination of these separate locking variants.
 307
 308          For more details, see Documentation/lockdep-design.txt.
 309
 310 config LOCKDEP
 311         bool
 312         depends on DEBUG_KERNEL && TRACE_IRQFLAGS_SUPPORT && STACKTRACE_SUPPORT && LOCKDEP_SUPPORT
 313         select STACKTRACE
 314         select FRAME_POINTER if !X86 && !MIPS
 315         select KALLSYMS
 316         select KALLSYMS_ALL
 317
 318 config LOCK_STAT
 319         bool "Lock usage statistics"
 320         depends on DEBUG_KERNEL && TRACE_IRQFLAGS_SUPPORT && STACKTRACE_SUPPORT && LOCKDEP_SUPPORT
 321         select LOCKDEP
 322         select DEBUG_SPINLOCK
 323         select DEBUG_MUTEXES
 324         select DEBUG_LOCK_ALLOC
 325         default n
 326         help
 327          This feature enables tracking lock contention points
 328
 329          For more details, see Documentation/lockstat.txt
 330
 331 config DEBUG_LOCKDEP
 332         bool "Lock dependency engine debugging"
 333         depends on DEBUG_KERNEL && LOCKDEP
 334         help
 335           If you say Y here, the lock dependency engine will do
 336           additional runtime checks to debug itself, at the price
 337           of more runtime overhead.
 338
 339 config TRACE_IRQFLAGS
 340         depends on DEBUG_KERNEL
 341         bool
 342         default y
 343         depends on TRACE_IRQFLAGS_SUPPORT
 344         depends on PROVE_LOCKING
 345
 346 config DEBUG_SPINLOCK_SLEEP
 347         bool "Spinlock debugging: sleep-inside-spinlock checking"
 348         depends on DEBUG_KERNEL
 349         help
 350           If you say Y here, various routines which may sleep will become very
 351           noisy if they are called with a spinlock held.
 352
 353 config DEBUG_LOCKING_API_SELFTESTS
 354         bool "Locking API boot-time self-tests"
 355         depends on DEBUG_KERNEL
 356         help
 357           Say Y here if you want the kernel to run a short self-test during
 358           bootup. The self-test checks whether common types of locking bugs
 359           are detected by debugging mechanisms or not. (if you disable
 360           lock debugging then those bugs wont be detected of course.)
 361           The following locking APIs are covered: spinlocks, rwlocks,
 362           mutexes and rwsems.
 363
 364 config STACKTRACE
 365         bool
 366         depends on DEBUG_KERNEL
 367         depends on STACKTRACE_SUPPORT
 368
 369 config DEBUG_KOBJECT
 370         bool "kobject debugging"
 371         depends on DEBUG_KERNEL
 372         help
 373           If you say Y here, some extra kobject debugging messages will be sent
 374           to the syslog.
 375
 376 config DEBUG_HIGHMEM
 377         bool "Highmem debugging"
 378         depends on DEBUG_KERNEL && HIGHMEM
 379         help
 380           This options enables addition error checking for high memory systems.
 381           Disable for production systems.
 382
 383 config DEBUG_BUGVERBOSE
 384         bool "Verbose BUG() reporting (adds 70K)" if DEBUG_KERNEL && EMBEDDED
 385         depends on BUG
 386         depends on ARM || AVR32 || M32R || M68K || SPARC32 || SPARC64 || FRV || SUPERH || GENERIC_BUG || BFIN || MN10300
 387         default !EMBEDDED
 388         help
 389           Say Y here to make BUG() panics output the file name and line number
 390           of the BUG call as well as the EIP and oops trace.  This aids
 391           debugging but costs about 70-100K of memory.
 392
 393 config DEBUG_INFO
 394         bool "Compile the kernel with debug info"
 395         depends on DEBUG_KERNEL
 396         help
 397           If you say Y here the resulting kernel image will include
 398           debugging info resulting in a larger kernel image.
 399           This adds debug symbols to the kernel and modules (gcc -g), and
 400           is needed if you intend to use kernel crashdump or binary object
 401           tools like crash, kgdb, LKCD, gdb, etc on the kernel.
 402           Say Y here only if you plan to debug the kernel.
 403
 404           If unsure, say N.
 405
 406 config DEBUG_VM
 407         bool "Debug VM"
 408         depends on DEBUG_KERNEL
 409         help
 410           Enable this to turn on extended checks in the virtual-memory system
 411           that may impact performance.
 412
 413           If unsure, say N.
 414
 415 config DEBUG_LIST
 416         bool "Debug linked list manipulation"
 417         depends on DEBUG_KERNEL
 418         help
 419           Enable this to turn on extended checks in the linked-list
 420           walking routines.
 421
 422           If unsure, say N.
 423
 424 config DEBUG_SG
 425         bool "Debug SG table operations"
 426         depends on DEBUG_KERNEL
 427         help
 428           Enable this to turn on checks on scatter-gather tables. This can
 429           help find problems with drivers that do not properly initialize
 430           their sg tables.
 431
 432           If unsure, say N.
 433
 434 config FRAME_POINTER
 435         bool "Compile the kernel with frame pointers"
 436         depends on DEBUG_KERNEL && (X86 || CRIS || M68K || M68KNOMMU || FRV || UML || S390 || AVR32 || SUPERH || BFIN || MN10300)
 437         default y
 438         help
 439           If you say Y here the resulting kernel image will be slightly larger
 440           and slower, but it might give very useful debugging information on
 441           some architectures or if you use external debuggers.
 442           If you don't debug the kernel, you can say N.
 443
 444 config  PROFILE_LIKELY
 445         bool "Record return values from likely/unlikely macros"
 446         default n
 447         help
 448           Adds profiling on likely/unlikly macros . To see the
 449           results of the profiling you can view the following,
 450                 /proc/likely_prof
 451
 452 config FORCED_INLINING
 453         bool "Force gcc to inline functions marked 'inline'"
 454         depends on DEBUG_KERNEL
 455         default y
 456         help
 457           This option determines if the kernel forces gcc to inline the functions
 458           developers have marked 'inline'. Doing so takes away freedom from gcc to
 459           do what it thinks is best, which is desirable for the gcc 3.x series of
 460           compilers. The gcc 4.x series have a rewritten inlining algorithm and
 461           disabling this option will generate a smaller kernel there. Hopefully
 462           this algorithm is so good that allowing gcc4 to make the decision can
 463           become the default in the future, until then this option is there to
 464           test gcc for this.
 465
 466 config BOOT_PRINTK_DELAY
 467         bool "Delay each boot printk message by N milliseconds"
 468         depends on DEBUG_KERNEL && PRINTK && GENERIC_CALIBRATE_DELAY
 469         help
 470           This build option allows you to read kernel boot messages
 471           by inserting a short delay after each one.  The delay is
 472           specified in milliseconds on the kernel command line,
 473           using "boot_delay=N".
 474
 475           It is likely that you would also need to use "lpj=M" to preset
 476           the "loops per jiffie" value.
 477           See a previous boot log for the "lpj" value to use for your
 478           system, and then set "lpj=M" before setting "boot_delay=N".
 479           NOTE:  Using this option may adversely affect SMP systems.
 480           I.e., processors other than the first one may not boot up.
 481           BOOT_PRINTK_DELAY also may cause DETECT_SOFTLOCKUP to detect
 482           what it believes to be lockup conditions.
 483
 484 config DEBUG_SYNCHRO_TEST
 485         tristate "Synchronisation primitive testing module"
 486         depends on DEBUG_KERNEL
 487         default n
 488         help
 489           This option provides a kernel module that can thrash the sleepable
 490           synchronisation primitives (mutexes and semaphores).
 491
 492           You should say N or M here. Whilst the module can be built in, it's
 493           not recommended as it requires module parameters supplying to get it
 494           to do anything.
 495
 496           See Documentation/synchro-test.txt.
 497
 498 config RCU_TORTURE_TEST
 499         tristate "torture tests for RCU"
 500         depends on DEBUG_KERNEL
 501         depends on m
 502         default n
 503         help
 504           This option provides a kernel module that runs torture tests
 505           on the RCU infrastructure.  The kernel module may be built
 506           after the fact on the running kernel to be tested, if desired.
 507
 508           Say M if you want the RCU torture tests to build as a module.
 509           Say N if you are unsure.
 510
 511 config LKDTM
 512         tristate "Linux Kernel Dump Test Tool Module"
 513         depends on DEBUG_KERNEL
 514         depends on KPROBES
 515         default n
 516         help
 517         This module enables testing of the different dumping mechanisms by
 518         inducing system failures at predefined crash points.
 519         If you don't need it: say N
 520         Choose M here to compile this code as a module. The module will be
 521         called lkdtm.
 522
 523         Documentation on how to use the module can be found in
 524         drivers/misc/lkdtm.c
 525
 526 config FAULT_INJECTION
 527         bool "Fault-injection framework"
 528         depends on DEBUG_KERNEL
 529         help
 530           Provide fault-injection framework.
 531           For more details, see Documentation/fault-injection/.
 532
 533 config FAILSLAB
 534         bool "Fault-injection capability for kmalloc"
 535         depends on FAULT_INJECTION
 536         help
 537           Provide fault-injection capability for kmalloc.
 538
 539 config FAIL_PAGE_ALLOC
 540         bool "Fault-injection capabilitiy for alloc_pages()"
 541         depends on FAULT_INJECTION
 542         help
 543           Provide fault-injection capability for alloc_pages().
 544
 545 config FAIL_MAKE_REQUEST
 546         bool "Fault-injection capability for disk IO"
 547         depends on FAULT_INJECTION
 548         help
 549           Provide fault-injection capability for disk IO.
 550
 551 config FAULT_INJECTION_DEBUG_FS
 552         bool "Debugfs entries for fault-injection capabilities"
 553         depends on FAULT_INJECTION && SYSFS && DEBUG_FS
 554         help
 555           Enable configuration of fault-injection capabilities via debugfs.
 556
 557 config FAULT_INJECTION_STACKTRACE_FILTER
 558         bool "stacktrace filter for fault-injection capabilities"
 559         depends on FAULT_INJECTION_DEBUG_FS && STACKTRACE_SUPPORT
 560         depends on !X86_64
 561         select STACKTRACE
 562         select FRAME_POINTER
 563         help
 564           Provide stacktrace filter for fault-injection capabilities
 565
 566 source "samples/Kconfig"