kernel/trace/Kconfig

   1 #
   2 # Architectures that offer an FUNCTION_TRACER implementation should
   3 #  select HAVE_FUNCTION_TRACER:
   4 #
   5
   6 config USER_STACKTRACE_SUPPORT
   7         bool
   8
   9 config NOP_TRACER
  10         bool
  11
  12 config HAVE_FTRACE_NMI_ENTER
  13         bool
  14
  15 config HAVE_FUNCTION_TRACER
  16         bool
  17
  18 config HAVE_FUNCTION_GRAPH_TRACER
  19         bool
  20
  21 config HAVE_FUNCTION_GRAPH_FP_TEST
  22         bool
  23         help
  24          An arch may pass in a unique value (frame pointer) to both the
  25          entering and exiting of a function. On exit, the value is compared
  26          and if it does not match, then it will panic the kernel.
  27
  28 config HAVE_FUNCTION_TRACE_MCOUNT_TEST
  29         bool
  30         help
  31          This gets selected when the arch tests the function_trace_stop
  32          variable at the mcount call site. Otherwise, this variable
  33          is tested by the called function.
  34
  35 config HAVE_DYNAMIC_FTRACE
  36         bool
  37
  38 config HAVE_FTRACE_MCOUNT_RECORD
  39         bool
  40
  41 config HAVE_HW_BRANCH_TRACER
  42         bool
  43
  44 config HAVE_SYSCALL_TRACEPOINTS
  45         bool
  46
  47 config TRACER_MAX_TRACE
  48         bool
  49
  50 config RING_BUFFER
  51         bool
  52
  53 config FTRACE_NMI_ENTER
  54        bool
  55        depends on HAVE_FTRACE_NMI_ENTER
  56        default y
  57
  58 config EVENT_TRACING
  59         select CONTEXT_SWITCH_TRACER
  60         bool
  61
  62 config CONTEXT_SWITCH_TRACER
  63         bool
  64
  65 config RING_BUFFER_ALLOW_SWAP
  66         bool
  67         help
  68          Allow the use of ring_buffer_swap_cpu.
  69          Adds a very slight overhead to tracing when enabled.
  70
  71 # All tracer options should select GENERIC_TRACER. For those options that are
  72 # enabled by all tracers (context switch and event tracer) they select TRACING.
  73 # This allows those options to appear when no other tracer is selected. But the
  74 # options do not appear when something else selects it. We need the two options
  75 # GENERIC_TRACER and TRACING to avoid circular dependencies to accomplish the
  76 # hidding of the automatic options options.
  77
  78 config TRACING
  79         bool
  80         select DEBUG_FS
  81         select RING_BUFFER
  82         select STACKTRACE if STACKTRACE_SUPPORT
  83         select TRACEPOINTS
  84         select NOP_TRACER
  85         select BINARY_PRINTF
  86         select EVENT_TRACING
  87
  88 config GENERIC_TRACER
  89         bool
  90         select TRACING
  91
  92 #
  93 # Minimum requirements an architecture has to meet for us to
  94 # be able to offer generic tracing facilities:
  95 #
  96 config TRACING_SUPPORT
  97         bool
  98         # PPC32 has no irqflags tracing support, but it can use most of the
  99         # tracers anyway, they were tested to build and work. Note that new
 100         # exceptions to this list aren't welcomed, better implement the
 101         # irqflags tracing for your architecture.
 102         depends on TRACE_IRQFLAGS_SUPPORT || PPC32
 103         depends on STACKTRACE_SUPPORT
 104         default y
 105
 106 if TRACING_SUPPORT
 107
 108 menuconfig FTRACE
 109         bool "Tracers"
 110         default y if DEBUG_KERNEL
 111         help
 112          Enable the kernel tracing infrastructure.
 113
 114 if FTRACE
 115
 116 config FUNCTION_TRACER
 117         bool "Kernel Function Tracer"
 118         depends on HAVE_FUNCTION_TRACER
 119         select FRAME_POINTER
 120         select KALLSYMS
 121         select GENERIC_TRACER
 122         select CONTEXT_SWITCH_TRACER
 123         help
 124           Enable the kernel to trace every kernel function. This is done
 125           by using a compiler feature to insert a small, 5-byte No-Operation
 126           instruction to the beginning of every kernel function, which NOP
 127           sequence is then dynamically patched into a tracer call when
 128           tracing is enabled by the administrator. If it's runtime disabled
 129           (the bootup default), then the overhead of the instructions is very
 130           small and not measurable even in micro-benchmarks.
 131
 132 config FUNCTION_GRAPH_TRACER
 133         bool "Kernel Function Graph Tracer"
 134         depends on HAVE_FUNCTION_GRAPH_TRACER
 135         depends on FUNCTION_TRACER
 136         depends on !X86_32 || !CC_OPTIMIZE_FOR_SIZE
 137         default y
 138         help
 139           Enable the kernel to trace a function at both its return
 140           and its entry.
 141           Its first purpose is to trace the duration of functions and
 142           draw a call graph for each thread with some information like
 143           the return value. This is done by setting the current return
 144           address on the current task structure into a stack of calls.
 145
 146
 147 config IRQSOFF_TRACER
 148         bool "Interrupts-off Latency Tracer"
 149         default n
 150         depends on TRACE_IRQFLAGS_SUPPORT
 151         depends on GENERIC_TIME
 152         select TRACE_IRQFLAGS
 153         select GENERIC_TRACER
 154         select TRACER_MAX_TRACE
 155         select RING_BUFFER_ALLOW_SWAP
 156         help
 157           This option measures the time spent in irqs-off critical
 158           sections, with microsecond accuracy.
 159
 160           The default measurement method is a maximum search, which is
 161           disabled by default and can be runtime (re-)started
 162           via:
 163
 164               echo 0 > /sys/kernel/debug/tracing/tracing_max_latency
 165
 166           (Note that kernel size and overhead increases with this option
 167           enabled. This option and the preempt-off timing option can be
 168           used together or separately.)
 169
 170 config PREEMPT_TRACER
 171         bool "Preemption-off Latency Tracer"
 172         default n
 173         depends on GENERIC_TIME
 174         depends on PREEMPT
 175         select GENERIC_TRACER
 176         select TRACER_MAX_TRACE
 177         select RING_BUFFER_ALLOW_SWAP
 178         help
 179           This option measures the time spent in preemption off critical
 180           sections, with microsecond accuracy.
 181
 182           The default measurement method is a maximum search, which is
 183           disabled by default and can be runtime (re-)started
 184           via:
 185
 186               echo 0 > /sys/kernel/debug/tracing/tracing_max_latency
 187
 188           (Note that kernel size and overhead increases with this option
 189           enabled. This option and the irqs-off timing option can be
 190           used together or separately.)
 191
 192 config SYSPROF_TRACER
 193         bool "Sysprof Tracer"
 194         depends on X86
 195         select GENERIC_TRACER
 196         select CONTEXT_SWITCH_TRACER
 197         help
 198           This tracer provides the trace needed by the 'Sysprof' userspace
 199           tool.
 200
 201 config SCHED_TRACER
 202         bool "Scheduling Latency Tracer"
 203         select GENERIC_TRACER
 204         select CONTEXT_SWITCH_TRACER
 205         select TRACER_MAX_TRACE
 206         help
 207           This tracer tracks the latency of the highest priority task
 208           to be scheduled in, starting from the point it has woken up.
 209
 210 config ENABLE_DEFAULT_TRACERS
 211         bool "Trace process context switches and events"
 212         depends on !GENERIC_TRACER
 213         select TRACING
 214         help
 215           This tracer hooks to various trace points in the kernel
 216           allowing the user to pick and choose which trace point they
 217           want to trace. It also includes the sched_switch tracer plugin.
 218
 219 config FTRACE_SYSCALLS
 220         bool "Trace syscalls"
 221         depends on HAVE_SYSCALL_TRACEPOINTS
 222         select GENERIC_TRACER
 223         select KALLSYMS
 224         help
 225           Basic tracer to catch the syscall entry and exit events.
 226
 227 config BOOT_TRACER
 228         bool "Trace boot initcalls"
 229         select GENERIC_TRACER
 230         select CONTEXT_SWITCH_TRACER
 231         help
 232           This tracer helps developers to optimize boot times: it records
 233           the timings of the initcalls and traces key events and the identity
 234           of tasks that can cause boot delays, such as context-switches.
 235
 236           Its aim is to be parsed by the scripts/bootgraph.pl tool to
 237           produce pretty graphics about boot inefficiencies, giving a visual
 238           representation of the delays during initcalls - but the raw
 239           /debug/tracing/trace text output is readable too.
 240
 241           You must pass in initcall_debug and ftrace=initcall to the kernel
 242           command line to enable this on bootup.
 243
 244 config TRACE_BRANCH_PROFILING
 245         bool
 246         select GENERIC_TRACER
 247
 248 choice
 249         prompt "Branch Profiling"
 250         default BRANCH_PROFILE_NONE
 251         help
 252          The branch profiling is a software profiler. It will add hooks
 253          into the C conditionals to test which path a branch takes.
 254
 255          The likely/unlikely profiler only looks at the conditions that
 256          are annotated with a likely or unlikely macro.
 257
 258          The "all branch" profiler will profile every if statement in the
 259          kernel. This profiler will also enable the likely/unlikely
 260          profiler as well.
 261
 262          Either of the above profilers add a bit of overhead to the system.
 263          If unsure choose "No branch profiling".
 264
 265 config BRANCH_PROFILE_NONE
 266         bool "No branch profiling"
 267         help
 268          No branch profiling. Branch profiling adds a bit of overhead.
 269          Only enable it if you want to analyse the branching behavior.
 270          Otherwise keep it disabled.
 271
 272 config PROFILE_ANNOTATED_BRANCHES
 273         bool "Trace likely/unlikely profiler"
 274         select TRACE_BRANCH_PROFILING
 275         help
 276           This tracer profiles all the the likely and unlikely macros
 277           in the kernel. It will display the results in:
 278
 279           /sys/kernel/debug/tracing/profile_annotated_branch
 280
 281           Note: this will add a significant overhead, only turn this
 282           on if you need to profile the system's use of these macros.
 283
 284 config PROFILE_ALL_BRANCHES
 285         bool "Profile all if conditionals"
 286         select TRACE_BRANCH_PROFILING
 287         help
 288           This tracer profiles all branch conditions. Every if ()
 289           taken in the kernel is recorded whether it hit or miss.
 290           The results will be displayed in:
 291
 292           /sys/kernel/debug/tracing/profile_branch
 293
 294           This option also enables the likely/unlikely profiler.
 295
 296           This configuration, when enabled, will impose a great overhead
 297           on the system. This should only be enabled when the system
 298           is to be analyzed
 299 endchoice
 300
 301 config TRACING_BRANCHES
 302         bool
 303         help
 304           Selected by tracers that will trace the likely and unlikely
 305           conditions. This prevents the tracers themselves from being
 306           profiled. Profiling the tracing infrastructure can only happen
 307           when the likelys and unlikelys are not being traced.
 308
 309 config BRANCH_TRACER
 310         bool "Trace likely/unlikely instances"
 311         depends on TRACE_BRANCH_PROFILING
 312         select TRACING_BRANCHES
 313         help
 314           This traces the events of likely and unlikely condition
 315           calls in the kernel.  The difference between this and the
 316           "Trace likely/unlikely profiler" is that this is not a
 317           histogram of the callers, but actually places the calling
 318           events into a running trace buffer to see when and where the
 319           events happened, as well as their results.
 320
 321           Say N if unsure.
 322
 323 config POWER_TRACER
 324         bool "Trace power consumption behavior"
 325         depends on X86
 326         select GENERIC_TRACER
 327         help
 328           This tracer helps developers to analyze and optimize the kernels
 329           power management decisions, specifically the C-state and P-state
 330           behavior.
 331
 332 config KSYM_TRACER
 333         bool "Trace read and write access on kernel memory locations"
 334         depends on HAVE_HW_BREAKPOINT
 335         select TRACING
 336         help
 337           This tracer helps find read and write operations on any given kernel
 338           symbol i.e. /proc/kallsyms.
 339
 340 config PROFILE_KSYM_TRACER
 341         bool "Profile all kernel memory accesses on 'watched' variables"
 342         depends on KSYM_TRACER
 343         help
 344           This tracer profiles kernel accesses on variables watched through the
 345           ksym tracer ftrace plugin. Depending upon the hardware, all read
 346           and write operations on kernel variables can be monitored for
 347           accesses.
 348
 349           The results will be displayed in:
 350           /debugfs/tracing/profile_ksym
 351
 352           Say N if unsure.
 353
 354 config STACK_TRACER
 355         bool "Trace max stack"
 356         depends on HAVE_FUNCTION_TRACER
 357         select FUNCTION_TRACER
 358         select STACKTRACE
 359         select KALLSYMS
 360         help
 361           This special tracer records the maximum stack footprint of the
 362           kernel and displays it in /sys/kernel/debug/tracing/stack_trace.
 363
 364           This tracer works by hooking into every function call that the
 365           kernel executes, and keeping a maximum stack depth value and
 366           stack-trace saved.  If this is configured with DYNAMIC_FTRACE
 367           then it will not have any overhead while the stack tracer
 368           is disabled.
 369
 370           To enable the stack tracer on bootup, pass in 'stacktrace'
 371           on the kernel command line.
 372
 373           The stack tracer can also be enabled or disabled via the
 374           sysctl kernel.stack_tracer_enabled
 375
 376           Say N if unsure.
 377
 378 config HW_BRANCH_TRACER
 379         depends on HAVE_HW_BRANCH_TRACER
 380         bool "Trace hw branches"
 381         select GENERIC_TRACER
 382         help
 383           This tracer records all branches on the system in a circular
 384           buffer giving access to the last N branches for each cpu.
 385
 386 config KMEMTRACE
 387         bool "Trace SLAB allocations"
 388         select GENERIC_TRACER
 389         help
 390           kmemtrace provides tracing for slab allocator functions, such as
 391           kmalloc, kfree, kmem_cache_alloc, kmem_cache_free etc.. Collected
 392           data is then fed to the userspace application in order to analyse
 393           allocation hotspots, internal fragmentation and so on, making it
 394           possible to see how well an allocator performs, as well as debug
 395           and profile kernel code.
 396
 397           This requires an userspace application to use. See
 398           Documentation/trace/kmemtrace.txt for more information.
 399
 400           Saying Y will make the kernel somewhat larger and slower. However,
 401           if you disable kmemtrace at run-time or boot-time, the performance
 402           impact is minimal (depending on the arch the kernel is built for).
 403
 404           If unsure, say N.
 405
 406 config WORKQUEUE_TRACER
 407         bool "Trace workqueues"
 408         select GENERIC_TRACER
 409         help
 410           The workqueue tracer provides some statistical informations
 411           about each cpu workqueue thread such as the number of the
 412           works inserted and executed since their creation. It can help
 413           to evaluate the amount of work each of them have to perform.
 414           For example it can help a developer to decide whether he should
 415           choose a per cpu workqueue instead of a singlethreaded one.
 416
 417 config BLK_DEV_IO_TRACE
 418         bool "Support for tracing block io actions"
 419         depends on SYSFS
 420         depends on BLOCK
 421         select RELAY
 422         select DEBUG_FS
 423         select TRACEPOINTS
 424         select GENERIC_TRACER
 425         select STACKTRACE
 426         help
 427           Say Y here if you want to be able to trace the block layer actions
 428           on a given queue. Tracing allows you to see any traffic happening
 429           on a block device queue. For more information (and the userspace
 430           support tools needed), fetch the blktrace tools from:
 431
 432           git://git.kernel.dk/blktrace.git
 433
 434           Tracing also is possible using the ftrace interface, e.g.:
 435
 436             echo 1 > /sys/block/sda/sda1/trace/enable
 437             echo blk > /sys/kernel/debug/tracing/current_tracer
 438             cat /sys/kernel/debug/tracing/trace_pipe
 439
 440           If unsure, say N.
 441
 442 config DYNAMIC_FTRACE
 443         bool "enable/disable ftrace tracepoints dynamically"
 444         depends on FUNCTION_TRACER
 445         depends on HAVE_DYNAMIC_FTRACE
 446         default y
 447         help
 448          This option will modify all the calls to ftrace dynamically
 449          (will patch them out of the binary image and replaces them
 450          with a No-Op instruction) as they are called. A table is
 451          created to dynamically enable them again.
 452
 453          This way a CONFIG_FUNCTION_TRACER kernel is slightly larger, but otherwise
 454          has native performance as long as no tracing is active.
 455
 456          The changes to the code are done by a kernel thread that
 457          wakes up once a second and checks to see if any ftrace calls
 458          were made. If so, it runs stop_machine (stops all CPUS)
 459          and modifies the code to jump over the call to ftrace.
 460
 461 config FUNCTION_PROFILER
 462         bool "Kernel function profiler"
 463         depends on FUNCTION_TRACER
 464         default n
 465         help
 466          This option enables the kernel function profiler. A file is created
 467          in debugfs called function_profile_enabled which defaults to zero.
 468          When a 1 is echoed into this file profiling begins, and when a
 469          zero is entered, profiling stops. A file in the trace_stats
 470          directory called functions, that show the list of functions that
 471          have been hit and their counters.
 472
 473          If in doubt, say N
 474
 475 config FTRACE_MCOUNT_RECORD
 476         def_bool y
 477         depends on DYNAMIC_FTRACE
 478         depends on HAVE_FTRACE_MCOUNT_RECORD
 479
 480 config FTRACE_SELFTEST
 481         bool
 482
 483 config FTRACE_STARTUP_TEST
 484         bool "Perform a startup test on ftrace"
 485         depends on GENERIC_TRACER
 486         select FTRACE_SELFTEST
 487         help
 488           This option performs a series of startup tests on ftrace. On bootup
 489           a series of tests are made to verify that the tracer is
 490           functioning properly. It will do tests on all the configured
 491           tracers of ftrace.
 492
 493 config MMIOTRACE
 494         bool "Memory mapped IO tracing"
 495         depends on HAVE_MMIOTRACE_SUPPORT && PCI
 496         select GENERIC_TRACER
 497         help
 498           Mmiotrace traces Memory Mapped I/O access and is meant for
 499           debugging and reverse engineering. It is called from the ioremap
 500           implementation and works via page faults. Tracing is disabled by
 501           default and can be enabled at run-time.
 502
 503           See Documentation/trace/mmiotrace.txt.
 504           If you are not helping to develop drivers, say N.
 505
 506 config MMIOTRACE_TEST
 507         tristate "Test module for mmiotrace"
 508         depends on MMIOTRACE && m
 509         help
 510           This is a dumb module for testing mmiotrace. It is very dangerous
 511           as it will write garbage to IO memory starting at a given address.
 512           However, it should be safe to use on e.g. unused portion of VRAM.
 513
 514           Say N, unless you absolutely know what you are doing.
 515
 516 config RING_BUFFER_BENCHMARK
 517         tristate "Ring buffer benchmark stress tester"
 518         depends on RING_BUFFER
 519         help
 520           This option creates a test to stress the ring buffer and bench mark it.
 521           It creates its own ring buffer such that it will not interfer with
 522           any other users of the ring buffer (such as ftrace). It then creates
 523           a producer and consumer that will run for 10 seconds and sleep for
 524           10 seconds. Each interval it will print out the number of events
 525           it recorded and give a rough estimate of how long each iteration took.
 526
 527           It does not disable interrupts or raise its priority, so it may be
 528           affected by processes that are running.
 529
 530           If unsure, say N
 531
 532 endif # FTRACE
 533
 534 endif # TRACING_SUPPORT
 535