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         help
  15           See Documentation/trace/ftrace-design.txt
  16
  17 config HAVE_FUNCTION_TRACER
  18         bool
  19         help
  20           See Documentation/trace/ftrace-design.txt
  21
  22 config HAVE_FUNCTION_GRAPH_TRACER
  23         bool
  24         help
  25           See Documentation/trace/ftrace-design.txt
  26
  27 config HAVE_FUNCTION_GRAPH_FP_TEST
  28         bool
  29         help
  30           See Documentation/trace/ftrace-design.txt
  31
  32 config HAVE_FUNCTION_TRACE_MCOUNT_TEST
  33         bool
  34         help
  35           See Documentation/trace/ftrace-design.txt
  36
  37 config HAVE_DYNAMIC_FTRACE
  38         bool
  39         help
  40           See Documentation/trace/ftrace-design.txt
  41
  42 config HAVE_DYNAMIC_FTRACE_WITH_REGS
  43         bool
  44
  45 config HAVE_FTRACE_MCOUNT_RECORD
  46         bool
  47         help
  48           See Documentation/trace/ftrace-design.txt
  49
  50 config HAVE_SYSCALL_TRACEPOINTS
  51         bool
  52         help
  53           See Documentation/trace/ftrace-design.txt
  54
  55 config HAVE_FENTRY
  56         bool
  57         help
  58           Arch supports the gcc options -pg with -mfentry
  59
  60 config HAVE_C_RECORDMCOUNT
  61         bool
  62         help
  63           C version of recordmcount available?
  64
  65 config TRACER_MAX_TRACE
  66         bool
  67
  68 config TRACE_CLOCK
  69         bool
  70
  71 config RING_BUFFER
  72         bool
  73         select TRACE_CLOCK
  74
  75 config FTRACE_NMI_ENTER
  76        bool
  77        depends on HAVE_FTRACE_NMI_ENTER
  78        default y
  79
  80 config EVENT_TRACING
  81         select CONTEXT_SWITCH_TRACER
  82         bool
  83
  84 config EVENT_POWER_TRACING_DEPRECATED
  85         depends on EVENT_TRACING
  86         bool "Deprecated power event trace API, to be removed"
  87         default y
  88         help
  89           Provides old power event types:
  90           C-state/idle accounting events:
  91           power:power_start
  92           power:power_end
  93           and old cpufreq accounting event:
  94           power:power_frequency
  95           This is for userspace compatibility
  96           and will vanish after 5 kernel iterations,
  97           namely 3.1.
  98
  99 config CONTEXT_SWITCH_TRACER
 100         bool
 101
 102 config RING_BUFFER_ALLOW_SWAP
 103         bool
 104         help
 105          Allow the use of ring_buffer_swap_cpu.
 106          Adds a very slight overhead to tracing when enabled.
 107
 108 # All tracer options should select GENERIC_TRACER. For those options that are
 109 # enabled by all tracers (context switch and event tracer) they select TRACING.
 110 # This allows those options to appear when no other tracer is selected. But the
 111 # options do not appear when something else selects it. We need the two options
 112 # GENERIC_TRACER and TRACING to avoid circular dependencies to accomplish the
 113 # hiding of the automatic options.
 114
 115 config TRACING
 116         bool
 117         select DEBUG_FS
 118         select RING_BUFFER
 119         select STACKTRACE if STACKTRACE_SUPPORT
 120         select TRACEPOINTS
 121         select NOP_TRACER
 122         select BINARY_PRINTF
 123         select EVENT_TRACING
 124         select TRACE_CLOCK
 125         select IRQ_WORK
 126
 127 config GENERIC_TRACER
 128         bool
 129         select TRACING
 130
 131 #
 132 # Minimum requirements an architecture has to meet for us to
 133 # be able to offer generic tracing facilities:
 134 #
 135 config TRACING_SUPPORT
 136         bool
 137         # PPC32 has no irqflags tracing support, but it can use most of the
 138         # tracers anyway, they were tested to build and work. Note that new
 139         # exceptions to this list aren't welcomed, better implement the
 140         # irqflags tracing for your architecture.
 141         depends on TRACE_IRQFLAGS_SUPPORT || PPC32
 142         depends on STACKTRACE_SUPPORT
 143         default y
 144
 145 if TRACING_SUPPORT
 146
 147 menuconfig FTRACE
 148         bool "Tracers"
 149         default y if DEBUG_KERNEL
 150         help
 151           Enable the kernel tracing infrastructure.
 152
 153 if FTRACE
 154
 155 config FUNCTION_TRACER
 156         bool "Kernel Function Tracer"
 157         depends on HAVE_FUNCTION_TRACER
 158         select KALLSYMS
 159         select GENERIC_TRACER
 160         select CONTEXT_SWITCH_TRACER
 161         help
 162           Enable the kernel to trace every kernel function. This is done
 163           by using a compiler feature to insert a small, 5-byte No-Operation
 164           instruction at the beginning of every kernel function, which NOP
 165           sequence is then dynamically patched into a tracer call when
 166           tracing is enabled by the administrator. If it's runtime disabled
 167           (the bootup default), then the overhead of the instructions is very
 168           small and not measurable even in micro-benchmarks.
 169
 170 config FUNCTION_GRAPH_TRACER
 171         bool "Kernel Function Graph Tracer"
 172         depends on HAVE_FUNCTION_GRAPH_TRACER
 173         depends on FUNCTION_TRACER
 174         depends on !X86_32 || !CC_OPTIMIZE_FOR_SIZE
 175         default y
 176         help
 177           Enable the kernel to trace a function at both its return
 178           and its entry.
 179           Its first purpose is to trace the duration of functions and
 180           draw a call graph for each thread with some information like
 181           the return value. This is done by setting the current return
 182           address on the current task structure into a stack of calls.
 183
 184
 185 config IRQSOFF_TRACER
 186         bool "Interrupts-off Latency Tracer"
 187         default n
 188         depends on TRACE_IRQFLAGS_SUPPORT
 189         depends on !ARCH_USES_GETTIMEOFFSET
 190         select TRACE_IRQFLAGS
 191         select GENERIC_TRACER
 192         select TRACER_MAX_TRACE
 193         select RING_BUFFER_ALLOW_SWAP
 194         select TRACER_SNAPSHOT
 195         help
 196           This option measures the time spent in irqs-off critical
 197           sections, with microsecond accuracy.
 198
 199           The default measurement method is a maximum search, which is
 200           disabled by default and can be runtime (re-)started
 201           via:
 202
 203               echo 0 > /sys/kernel/debug/tracing/tracing_max_latency
 204
 205           (Note that kernel size and overhead increase with this option
 206           enabled. This option and the preempt-off timing option can be
 207           used together or separately.)
 208
 209 config PREEMPT_TRACER
 210         bool "Preemption-off Latency Tracer"
 211         default n
 212         depends on !ARCH_USES_GETTIMEOFFSET
 213         depends on PREEMPT
 214         select GENERIC_TRACER
 215         select TRACER_MAX_TRACE
 216         select RING_BUFFER_ALLOW_SWAP
 217         select TRACER_SNAPSHOT
 218         help
 219           This option measures the time spent in preemption-off critical
 220           sections, with microsecond accuracy.
 221
 222           The default measurement method is a maximum search, which is
 223           disabled by default and can be runtime (re-)started
 224           via:
 225
 226               echo 0 > /sys/kernel/debug/tracing/tracing_max_latency
 227
 228           (Note that kernel size and overhead increase with this option
 229           enabled. This option and the irqs-off timing option can be
 230           used together or separately.)
 231
 232 config SCHED_TRACER
 233         bool "Scheduling Latency Tracer"
 234         select GENERIC_TRACER
 235         select CONTEXT_SWITCH_TRACER
 236         select TRACER_MAX_TRACE
 237         select TRACER_SNAPSHOT
 238         help
 239           This tracer tracks the latency of the highest priority task
 240           to be scheduled in, starting from the point it has woken up.
 241
 242 config ENABLE_DEFAULT_TRACERS
 243         bool "Trace process context switches and events"
 244         depends on !GENERIC_TRACER
 245         select TRACING
 246         help
 247           This tracer hooks to various trace points in the kernel,
 248           allowing the user to pick and choose which trace point they
 249           want to trace. It also includes the sched_switch tracer plugin.
 250
 251 config FTRACE_SYSCALLS
 252         bool "Trace syscalls"
 253         depends on HAVE_SYSCALL_TRACEPOINTS
 254         select GENERIC_TRACER
 255         select KALLSYMS
 256         help
 257           Basic tracer to catch the syscall entry and exit events.
 258
 259 config TRACER_SNAPSHOT
 260         bool "Create a snapshot trace buffer"
 261         select TRACER_MAX_TRACE
 262         help
 263           Allow tracing users to take snapshot of the current buffer using the
 264           ftrace interface, e.g.:
 265
 266               echo 1 > /sys/kernel/debug/tracing/snapshot
 267               cat snapshot
 268
 269 config TRACE_BRANCH_PROFILING
 270         bool
 271         select GENERIC_TRACER
 272
 273 choice
 274         prompt "Branch Profiling"
 275         default BRANCH_PROFILE_NONE
 276         help
 277          The branch profiling is a software profiler. It will add hooks
 278          into the C conditionals to test which path a branch takes.
 279
 280          The likely/unlikely profiler only looks at the conditions that
 281          are annotated with a likely or unlikely macro.
 282
 283          The "all branch" profiler will profile every if-statement in the
 284          kernel. This profiler will also enable the likely/unlikely
 285          profiler.
 286
 287          Either of the above profilers adds a bit of overhead to the system.
 288          If unsure, choose "No branch profiling".
 289
 290 config BRANCH_PROFILE_NONE
 291         bool "No branch profiling"
 292         help
 293           No branch profiling. Branch profiling adds a bit of overhead.
 294           Only enable it if you want to analyse the branching behavior.
 295           Otherwise keep it disabled.
 296
 297 config PROFILE_ANNOTATED_BRANCHES
 298         bool "Trace likely/unlikely profiler"
 299         select TRACE_BRANCH_PROFILING
 300         help
 301           This tracer profiles all likely and unlikely macros
 302           in the kernel. It will display the results in:
 303
 304           /sys/kernel/debug/tracing/trace_stat/branch_annotated
 305
 306           Note: this will add a significant overhead; only turn this
 307           on if you need to profile the system's use of these macros.
 308
 309 config PROFILE_ALL_BRANCHES
 310         bool "Profile all if conditionals"
 311         select TRACE_BRANCH_PROFILING
 312         help
 313           This tracer profiles all branch conditions. Every if ()
 314           taken in the kernel is recorded whether it hit or miss.
 315           The results will be displayed in:
 316
 317           /sys/kernel/debug/tracing/trace_stat/branch_all
 318
 319           This option also enables the likely/unlikely profiler.
 320
 321           This configuration, when enabled, will impose a great overhead
 322           on the system. This should only be enabled when the system
 323           is to be analyzed in much detail.
 324 endchoice
 325
 326 config TRACING_BRANCHES
 327         bool
 328         help
 329           Selected by tracers that will trace the likely and unlikely
 330           conditions. This prevents the tracers themselves from being
 331           profiled. Profiling the tracing infrastructure can only happen
 332           when the likelys and unlikelys are not being traced.
 333
 334 config BRANCH_TRACER
 335         bool "Trace likely/unlikely instances"
 336         depends on TRACE_BRANCH_PROFILING
 337         select TRACING_BRANCHES
 338         help
 339           This traces the events of likely and unlikely condition
 340           calls in the kernel.  The difference between this and the
 341           "Trace likely/unlikely profiler" is that this is not a
 342           histogram of the callers, but actually places the calling
 343           events into a running trace buffer to see when and where the
 344           events happened, as well as their results.
 345
 346           Say N if unsure.
 347
 348 config STACK_TRACER
 349         bool "Trace max stack"
 350         depends on HAVE_FUNCTION_TRACER
 351         select FUNCTION_TRACER
 352         select STACKTRACE
 353         select KALLSYMS
 354         help
 355           This special tracer records the maximum stack footprint of the
 356           kernel and displays it in /sys/kernel/debug/tracing/stack_trace.
 357
 358           This tracer works by hooking into every function call that the
 359           kernel executes, and keeping a maximum stack depth value and
 360           stack-trace saved.  If this is configured with DYNAMIC_FTRACE
 361           then it will not have any overhead while the stack tracer
 362           is disabled.
 363
 364           To enable the stack tracer on bootup, pass in 'stacktrace'
 365           on the kernel command line.
 366
 367           The stack tracer can also be enabled or disabled via the
 368           sysctl kernel.stack_tracer_enabled
 369
 370           Say N if unsure.
 371
 372 config BLK_DEV_IO_TRACE
 373         bool "Support for tracing block IO actions"
 374         depends on SYSFS
 375         depends on BLOCK
 376         select RELAY
 377         select DEBUG_FS
 378         select TRACEPOINTS
 379         select GENERIC_TRACER
 380         select STACKTRACE
 381         help
 382           Say Y here if you want to be able to trace the block layer actions
 383           on a given queue. Tracing allows you to see any traffic happening
 384           on a block device queue. For more information (and the userspace
 385           support tools needed), fetch the blktrace tools from:
 386
 387           git://git.kernel.dk/blktrace.git
 388
 389           Tracing also is possible using the ftrace interface, e.g.:
 390
 391             echo 1 > /sys/block/sda/sda1/trace/enable
 392             echo blk > /sys/kernel/debug/tracing/current_tracer
 393             cat /sys/kernel/debug/tracing/trace_pipe
 394
 395           If unsure, say N.
 396
 397 config KPROBE_EVENT
 398         depends on KPROBES
 399         depends on HAVE_REGS_AND_STACK_ACCESS_API
 400         bool "Enable kprobes-based dynamic events"
 401         select TRACING
 402         select PROBE_EVENTS
 403         default y
 404         help
 405           This allows the user to add tracing events (similar to tracepoints)
 406           on the fly via the ftrace interface. See
 407           Documentation/trace/kprobetrace.txt for more details.
 408
 409           Those events can be inserted wherever kprobes can probe, and record
 410           various register and memory values.
 411
 412           This option is also required by perf-probe subcommand of perf tools.
 413           If you want to use perf tools, this option is strongly recommended.
 414
 415 config UPROBE_EVENT
 416         bool "Enable uprobes-based dynamic events"
 417         depends on ARCH_SUPPORTS_UPROBES
 418         depends on MMU
 419         select UPROBES
 420         select PROBE_EVENTS
 421         select TRACING
 422         default n
 423         help
 424           This allows the user to add tracing events on top of userspace
 425           dynamic events (similar to tracepoints) on the fly via the trace
 426           events interface. Those events can be inserted wherever uprobes
 427           can probe, and record various registers.
 428           This option is required if you plan to use perf-probe subcommand
 429           of perf tools on user space applications.
 430
 431 config PROBE_EVENTS
 432         def_bool n
 433
 434 config DYNAMIC_FTRACE
 435         bool "enable/disable function tracing dynamically"
 436         depends on FUNCTION_TRACER
 437         depends on HAVE_DYNAMIC_FTRACE
 438         default y
 439         help
 440           This option will modify all the calls to function tracing
 441           dynamically (will patch them out of the binary image and
 442           replace them with a No-Op instruction) on boot up. During
 443           compile time, a table is made of all the locations that ftrace
 444           can function trace, and this table is linked into the kernel
 445           image. When this is enabled, functions can be individually
 446           enabled, and the functions not enabled will not affect
 447           performance of the system.
 448
 449           See the files in /sys/kernel/debug/tracing:
 450             available_filter_functions
 451             set_ftrace_filter
 452             set_ftrace_notrace
 453
 454           This way a CONFIG_FUNCTION_TRACER kernel is slightly larger, but
 455           otherwise has native performance as long as no tracing is active.
 456
 457 config DYNAMIC_FTRACE_WITH_REGS
 458         def_bool y
 459         depends on DYNAMIC_FTRACE
 460         depends on HAVE_DYNAMIC_FTRACE_WITH_REGS
 461
 462 config FUNCTION_PROFILER
 463         bool "Kernel function profiler"
 464         depends on FUNCTION_TRACER
 465         default n
 466         help
 467           This option enables the kernel function profiler. A file is created
 468           in debugfs called function_profile_enabled which defaults to zero.
 469           When a 1 is echoed into this file profiling begins, and when a
 470           zero is entered, profiling stops. A "functions" file is created in
 471           the trace_stats directory; this file shows the list of functions that
 472           have been hit and their counters.
 473
 474           If in doubt, say N.
 475
 476 config FTRACE_MCOUNT_RECORD
 477         def_bool y
 478         depends on DYNAMIC_FTRACE
 479         depends on HAVE_FTRACE_MCOUNT_RECORD
 480
 481 config FTRACE_SELFTEST
 482         bool
 483
 484 config FTRACE_STARTUP_TEST
 485         bool "Perform a startup test on ftrace"
 486         depends on GENERIC_TRACER
 487         select FTRACE_SELFTEST
 488         help
 489           This option performs a series of startup tests on ftrace. On bootup
 490           a series of tests are made to verify that the tracer is
 491           functioning properly. It will do tests on all the configured
 492           tracers of ftrace.
 493
 494 config EVENT_TRACE_TEST_SYSCALLS
 495         bool "Run selftest on syscall events"
 496         depends on FTRACE_STARTUP_TEST
 497         help
 498          This option will also enable testing every syscall event.
 499          It only enables the event and disables it and runs various loads
 500          with the event enabled. This adds a bit more time for kernel boot
 501          up since it runs this on every system call defined.
 502
 503          TBD - enable a way to actually call the syscalls as we test their
 504                events
 505
 506 config MMIOTRACE
 507         bool "Memory mapped IO tracing"
 508         depends on HAVE_MMIOTRACE_SUPPORT && PCI
 509         select GENERIC_TRACER
 510         help
 511           Mmiotrace traces Memory Mapped I/O access and is meant for
 512           debugging and reverse engineering. It is called from the ioremap
 513           implementation and works via page faults. Tracing is disabled by
 514           default and can be enabled at run-time.
 515
 516           See Documentation/trace/mmiotrace.txt.
 517           If you are not helping to develop drivers, say N.
 518
 519 config MMIOTRACE_TEST
 520         tristate "Test module for mmiotrace"
 521         depends on MMIOTRACE && m
 522         help
 523           This is a dumb module for testing mmiotrace. It is very dangerous
 524           as it will write garbage to IO memory starting at a given address.
 525           However, it should be safe to use on e.g. unused portion of VRAM.
 526
 527           Say N, unless you absolutely know what you are doing.
 528
 529 config RING_BUFFER_BENCHMARK
 530         tristate "Ring buffer benchmark stress tester"
 531         depends on RING_BUFFER
 532         help
 533           This option creates a test to stress the ring buffer and benchmark it.
 534           It creates its own ring buffer such that it will not interfere with
 535           any other users of the ring buffer (such as ftrace). It then creates
 536           a producer and consumer that will run for 10 seconds and sleep for
 537           10 seconds. Each interval it will print out the number of events
 538           it recorded and give a rough estimate of how long each iteration took.
 539
 540           It does not disable interrupts or raise its priority, so it may be
 541           affected by processes that are running.
 542
 543           If unsure, say N.
 544
 545 endif # FTRACE
 546
 547 endif # TRACING_SUPPORT
 548