Kconfig 16.7 KB
Newer Older
1
#
2 3
# Architectures that offer an FUNCTION_TRACER implementation should
#  select HAVE_FUNCTION_TRACER:
4
#
5

6 7 8
config USER_STACKTRACE_SUPPORT
	bool

9 10 11
config NOP_TRACER
	bool

12 13
config HAVE_FTRACE_NMI_ENTER
	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 28 29
config HAVE_FUNCTION_GRAPH_FP_TEST
	bool
	help
30
	  See Documentation/trace/ftrace-design.txt
31

32 33 34
config HAVE_FUNCTION_TRACE_MCOUNT_TEST
	bool
	help
35
	  See Documentation/trace/ftrace-design.txt
36

37 38
config HAVE_DYNAMIC_FTRACE
	bool
39
	help
40
	  See Documentation/trace/ftrace-design.txt
41

42 43 44
config HAVE_DYNAMIC_FTRACE_WITH_REGS
	bool

45 46
config HAVE_FTRACE_MCOUNT_RECORD
	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 56 57 58 59
config HAVE_FENTRY
	bool
	help
	  Arch supports the gcc options -pg with -mfentry

60
config HAVE_C_RECORDMCOUNT
61 62 63 64
	bool
	help
	  C version of recordmcount available?

65 66 67
config TRACER_MAX_TRACE
	bool

68 69 70
config TRACE_CLOCK
	bool

S
Steven Rostedt 已提交
71 72
config RING_BUFFER
	bool
73
	select TRACE_CLOCK
S
Steven Rostedt 已提交
74

75 76 77 78 79
config FTRACE_NMI_ENTER
       bool
       depends on HAVE_FTRACE_NMI_ENTER
       default y

80
config EVENT_TRACING
81 82 83
	select CONTEXT_SWITCH_TRACER
	bool

84 85 86 87 88 89 90 91 92 93 94 95 96
config EVENT_POWER_TRACING_DEPRECATED
	depends on EVENT_TRACING
	bool "Deprecated power event trace API, to be removed"
	default y
	help
	  Provides old power event types:
	  C-state/idle accounting events:
	  power:power_start
	  power:power_end
	  and old cpufreq accounting event:
	  power:power_frequency
	  This is for userspace compatibility
	  and will vanish after 5 kernel iterations,
97
	  namely 3.1.
98

99
config CONTEXT_SWITCH_TRACER
100 101
	bool

102 103 104 105 106 107
config RING_BUFFER_ALLOW_SWAP
	bool
	help
	 Allow the use of ring_buffer_swap_cpu.
	 Adds a very slight overhead to tracing when enabled.

108 109 110 111 112
# All tracer options should select GENERIC_TRACER. For those options that are
# enabled by all tracers (context switch and event tracer) they select TRACING.
# This allows those options to appear when no other tracer is selected. But the
# options do not appear when something else selects it. We need the two options
# GENERIC_TRACER and TRACING to avoid circular dependencies to accomplish the
113
# hiding of the automatic options.
114

115 116 117
config TRACING
	bool
	select DEBUG_FS
S
Steven Rostedt 已提交
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 128 129 130
config GENERIC_TRACER
	bool
	select TRACING

I
Ingo Molnar 已提交
131 132 133 134 135 136
#
# Minimum requirements an architecture has to meet for us to
# be able to offer generic tracing facilities:
#
config TRACING_SUPPORT
	bool
137 138 139 140 141
	# PPC32 has no irqflags tracing support, but it can use most of the
	# tracers anyway, they were tested to build and work. Note that new
	# exceptions to this list aren't welcomed, better implement the
	# irqflags tracing for your architecture.
	depends on TRACE_IRQFLAGS_SUPPORT || PPC32
I
Ingo Molnar 已提交
142
	depends on STACKTRACE_SUPPORT
143
	default y
I
Ingo Molnar 已提交
144 145 146

if TRACING_SUPPORT

147 148
menuconfig FTRACE
	bool "Tracers"
149
	default y if DEBUG_KERNEL
150
	help
151
	  Enable the kernel tracing infrastructure.
152 153

if FTRACE
P
Peter Zijlstra 已提交
154

155
config FUNCTION_TRACER
S
Steven Rostedt 已提交
156
	bool "Kernel Function Tracer"
157
	depends on HAVE_FUNCTION_TRACER
158
	select KALLSYMS
159
	select GENERIC_TRACER
160
	select CONTEXT_SWITCH_TRACER
S
Steven Rostedt 已提交
161 162 163
	help
	  Enable the kernel to trace every kernel function. This is done
	  by using a compiler feature to insert a small, 5-byte No-Operation
164
	  instruction at the beginning of every kernel function, which NOP
S
Steven Rostedt 已提交
165 166 167 168
	  sequence is then dynamically patched into a tracer call when
	  tracing is enabled by the administrator. If it's runtime disabled
	  (the bootup default), then the overhead of the instructions is very
	  small and not measurable even in micro-benchmarks.
169

170 171 172
config FUNCTION_GRAPH_TRACER
	bool "Kernel Function Graph Tracer"
	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 178
	  Enable the kernel to trace a function at both its return
	  and its entry.
179 180
	  Its first purpose is to trace the duration of functions and
	  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

S
Steven Rostedt 已提交
184

185 186 187 188
config IRQSOFF_TRACER
	bool "Interrupts-off Latency Tracer"
	default n
	depends on TRACE_IRQFLAGS_SUPPORT
J
John Stultz 已提交
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
	select TRACER_SNAPSHOT_PER_CPU_SWAP
196 197 198 199 200 201 202 203
	help
	  This option measures the time spent in irqs-off critical
	  sections, with microsecond accuracy.

	  The default measurement method is a maximum search, which is
	  disabled by default and can be runtime (re-)started
	  via:

204
	      echo 0 > /sys/kernel/debug/tracing/tracing_max_latency
205

206
	  (Note that kernel size and overhead increase with this option
207 208 209 210 211 212
	  enabled. This option and the preempt-off timing option can be
	  used together or separately.)

config PREEMPT_TRACER
	bool "Preemption-off Latency Tracer"
	default n
J
John Stultz 已提交
213
	depends on !ARCH_USES_GETTIMEOFFSET
214
	depends on PREEMPT
215
	select GENERIC_TRACER
216
	select TRACER_MAX_TRACE
217
	select RING_BUFFER_ALLOW_SWAP
218
	select TRACER_SNAPSHOT
219
	select TRACER_SNAPSHOT_PER_CPU_SWAP
220
	help
221
	  This option measures the time spent in preemption-off critical
222 223 224 225 226 227
	  sections, with microsecond accuracy.

	  The default measurement method is a maximum search, which is
	  disabled by default and can be runtime (re-)started
	  via:

228
	      echo 0 > /sys/kernel/debug/tracing/tracing_max_latency
229

230
	  (Note that kernel size and overhead increase with this option
231 232 233
	  enabled. This option and the irqs-off timing option can be
	  used together or separately.)

234 235
config SCHED_TRACER
	bool "Scheduling Latency Tracer"
236
	select GENERIC_TRACER
237 238
	select CONTEXT_SWITCH_TRACER
	select TRACER_MAX_TRACE
239
	select TRACER_SNAPSHOT
240 241 242 243
	help
	  This tracer tracks the latency of the highest priority task
	  to be scheduled in, starting from the point it has woken up.

244 245
config ENABLE_DEFAULT_TRACERS
	bool "Trace process context switches and events"
246
	depends on !GENERIC_TRACER
247 248
	select TRACING
	help
249
	  This tracer hooks to various trace points in the kernel,
250
	  allowing the user to pick and choose which trace point they
251
	  want to trace. It also includes the sched_switch tracer plugin.
252

253 254
config FTRACE_SYSCALLS
	bool "Trace syscalls"
255
	depends on HAVE_SYSCALL_TRACEPOINTS
256
	select GENERIC_TRACER
257
	select KALLSYMS
258 259 260
	help
	  Basic tracer to catch the syscall entry and exit events.

261 262 263 264 265 266 267 268 269 270
config TRACER_SNAPSHOT
	bool "Create a snapshot trace buffer"
	select TRACER_MAX_TRACE
	help
	  Allow tracing users to take snapshot of the current buffer using the
	  ftrace interface, e.g.:

	      echo 1 > /sys/kernel/debug/tracing/snapshot
	      cat snapshot

271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
config TRACER_SNAPSHOT_PER_CPU_SWAP
        bool "Allow snapshot to swap per CPU"
	depends on TRACER_SNAPSHOT
	select RING_BUFFER_ALLOW_SWAP
	help
	  Allow doing a snapshot of a single CPU buffer instead of a
	  full swap (all buffers). If this is set, then the following is
	  allowed:

	      echo 1 > /sys/kernel/debug/tracing/per_cpu/cpu2/snapshot

	  After which, only the tracing buffer for CPU 2 was swapped with
	  the main tracing buffer, and the other CPU buffers remain the same.

	  When this is enabled, this adds a little more overhead to the
	  trace recording, as it needs to add some checks to synchronize
	  recording with swaps. But this does not affect the performance
	  of the overall system. This is enabled by default when the preempt
	  or irq latency tracers are enabled, as those need to swap as well
	  and already adds the overhead (plus a lot more).

292
config TRACE_BRANCH_PROFILING
293
	bool
294
	select GENERIC_TRACER
295 296 297 298 299 300 301 302 303 304 305

choice
	prompt "Branch Profiling"
	default BRANCH_PROFILE_NONE
	help
	 The branch profiling is a software profiler. It will add hooks
	 into the C conditionals to test which path a branch takes.

	 The likely/unlikely profiler only looks at the conditions that
	 are annotated with a likely or unlikely macro.

306
	 The "all branch" profiler will profile every if-statement in the
307
	 kernel. This profiler will also enable the likely/unlikely
308
	 profiler.
309

310 311
	 Either of the above profilers adds a bit of overhead to the system.
	 If unsure, choose "No branch profiling".
312 313 314 315

config BRANCH_PROFILE_NONE
	bool "No branch profiling"
	help
316 317 318
	  No branch profiling. Branch profiling adds a bit of overhead.
	  Only enable it if you want to analyse the branching behavior.
	  Otherwise keep it disabled.
319 320 321 322

config PROFILE_ANNOTATED_BRANCHES
	bool "Trace likely/unlikely profiler"
	select TRACE_BRANCH_PROFILING
323
	help
M
Masanari Iida 已提交
324
	  This tracer profiles all likely and unlikely macros
325 326
	  in the kernel. It will display the results in:

327
	  /sys/kernel/debug/tracing/trace_stat/branch_annotated
328

329
	  Note: this will add a significant overhead; only turn this
330 331
	  on if you need to profile the system's use of these macros.

332 333
config PROFILE_ALL_BRANCHES
	bool "Profile all if conditionals"
334
	select TRACE_BRANCH_PROFILING
335 336 337 338 339
	help
	  This tracer profiles all branch conditions. Every if ()
	  taken in the kernel is recorded whether it hit or miss.
	  The results will be displayed in:

340
	  /sys/kernel/debug/tracing/trace_stat/branch_all
341

342 343
	  This option also enables the likely/unlikely profiler.

344 345
	  This configuration, when enabled, will impose a great overhead
	  on the system. This should only be enabled when the system
346
	  is to be analyzed in much detail.
347
endchoice
348

349
config TRACING_BRANCHES
350 351 352 353 354 355 356
	bool
	help
	  Selected by tracers that will trace the likely and unlikely
	  conditions. This prevents the tracers themselves from being
	  profiled. Profiling the tracing infrastructure can only happen
	  when the likelys and unlikelys are not being traced.

357
config BRANCH_TRACER
358
	bool "Trace likely/unlikely instances"
359 360
	depends on TRACE_BRANCH_PROFILING
	select TRACING_BRANCHES
361 362 363 364 365 366 367 368 369 370
	help
	  This traces the events of likely and unlikely condition
	  calls in the kernel.  The difference between this and the
	  "Trace likely/unlikely profiler" is that this is not a
	  histogram of the callers, but actually places the calling
	  events into a running trace buffer to see when and where the
	  events happened, as well as their results.

	  Say N if unsure.

S
Steven Rostedt 已提交
371 372
config STACK_TRACER
	bool "Trace max stack"
373 374
	depends on HAVE_FUNCTION_TRACER
	select FUNCTION_TRACER
S
Steven Rostedt 已提交
375
	select STACKTRACE
376
	select KALLSYMS
S
Steven Rostedt 已提交
377
	help
378
	  This special tracer records the maximum stack footprint of the
379
	  kernel and displays it in /sys/kernel/debug/tracing/stack_trace.
380 381 382

	  This tracer works by hooking into every function call that the
	  kernel executes, and keeping a maximum stack depth value and
383 384 385 386 387 388 389 390 391
	  stack-trace saved.  If this is configured with DYNAMIC_FTRACE
	  then it will not have any overhead while the stack tracer
	  is disabled.

	  To enable the stack tracer on bootup, pass in 'stacktrace'
	  on the kernel command line.

	  The stack tracer can also be enabled or disabled via the
	  sysctl kernel.stack_tracer_enabled
392 393

	  Say N if unsure.
S
Steven Rostedt 已提交
394

395
config BLK_DEV_IO_TRACE
396
	bool "Support for tracing block IO actions"
397
	depends on SYSFS
398
	depends on BLOCK
399 400 401
	select RELAY
	select DEBUG_FS
	select TRACEPOINTS
402
	select GENERIC_TRACER
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
	select STACKTRACE
	help
	  Say Y here if you want to be able to trace the block layer actions
	  on a given queue. Tracing allows you to see any traffic happening
	  on a block device queue. For more information (and the userspace
	  support tools needed), fetch the blktrace tools from:

	  git://git.kernel.dk/blktrace.git

	  Tracing also is possible using the ftrace interface, e.g.:

	    echo 1 > /sys/block/sda/sda1/trace/enable
	    echo blk > /sys/kernel/debug/tracing/current_tracer
	    cat /sys/kernel/debug/tracing/trace_pipe

	  If unsure, say N.
419

420
config KPROBE_EVENT
421
	depends on KPROBES
422
	depends on HAVE_REGS_AND_STACK_ACCESS_API
423
	bool "Enable kprobes-based dynamic events"
424
	select TRACING
425
	select PROBE_EVENTS
426
	default y
427
	help
428 429 430
	  This allows the user to add tracing events (similar to tracepoints)
	  on the fly via the ftrace interface. See
	  Documentation/trace/kprobetrace.txt for more details.
431 432 433 434

	  Those events can be inserted wherever kprobes can probe, and record
	  various register and memory values.

435 436
	  This option is also required by perf-probe subcommand of perf tools.
	  If you want to use perf tools, this option is strongly recommended.
437

438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453
config UPROBE_EVENT
	bool "Enable uprobes-based dynamic events"
	depends on ARCH_SUPPORTS_UPROBES
	depends on MMU
	select UPROBES
	select PROBE_EVENTS
	select TRACING
	default n
	help
	  This allows the user to add tracing events on top of userspace
	  dynamic events (similar to tracepoints) on the fly via the trace
	  events interface. Those events can be inserted wherever uprobes
	  can probe, and record various registers.
	  This option is required if you plan to use perf-probe subcommand
	  of perf tools on user space applications.

454 455 456
config PROBE_EVENTS
	def_bool n

457
config DYNAMIC_FTRACE
458
	bool "enable/disable function tracing dynamically"
459
	depends on FUNCTION_TRACER
460
	depends on HAVE_DYNAMIC_FTRACE
461 462
	default y
	help
463 464 465 466 467 468 469 470 471 472 473 474 475
	  This option will modify all the calls to function tracing
	  dynamically (will patch them out of the binary image and
	  replace them with a No-Op instruction) on boot up. During
	  compile time, a table is made of all the locations that ftrace
	  can function trace, and this table is linked into the kernel
	  image. When this is enabled, functions can be individually
	  enabled, and the functions not enabled will not affect
	  performance of the system.

	  See the files in /sys/kernel/debug/tracing:
	    available_filter_functions
	    set_ftrace_filter
	    set_ftrace_notrace
476

477 478
	  This way a CONFIG_FUNCTION_TRACER kernel is slightly larger, but
	  otherwise has native performance as long as no tracing is active.
479

480 481 482 483 484
config DYNAMIC_FTRACE_WITH_REGS
	def_bool y
	depends on DYNAMIC_FTRACE
	depends on HAVE_DYNAMIC_FTRACE_WITH_REGS

S
Steven Rostedt 已提交
485 486
config FUNCTION_PROFILER
	bool "Kernel function profiler"
487
	depends on FUNCTION_TRACER
S
Steven Rostedt 已提交
488 489
	default n
	help
490 491 492 493 494 495
	  This option enables the kernel function profiler. A file is created
	  in debugfs called function_profile_enabled which defaults to zero.
	  When a 1 is echoed into this file profiling begins, and when a
	  zero is entered, profiling stops. A "functions" file is created in
	  the trace_stats directory; this file shows the list of functions that
	  have been hit and their counters.
S
Steven Rostedt 已提交
496

497
	  If in doubt, say N.
S
Steven Rostedt 已提交
498

499 500 501 502 503
config FTRACE_MCOUNT_RECORD
	def_bool y
	depends on DYNAMIC_FTRACE
	depends on HAVE_FTRACE_MCOUNT_RECORD

S
Steven Rostedt 已提交
504 505 506 507 508
config FTRACE_SELFTEST
	bool

config FTRACE_STARTUP_TEST
	bool "Perform a startup test on ftrace"
509
	depends on GENERIC_TRACER
S
Steven Rostedt 已提交
510 511 512 513 514 515
	select FTRACE_SELFTEST
	help
	  This option performs a series of startup tests on ftrace. On bootup
	  a series of tests are made to verify that the tracer is
	  functioning properly. It will do tests on all the configured
	  tracers of ftrace.
P
Peter Zijlstra 已提交
516

517 518 519 520 521 522 523 524 525 526 527 528
config EVENT_TRACE_TEST_SYSCALLS
	bool "Run selftest on syscall events"
	depends on FTRACE_STARTUP_TEST
	help
	 This option will also enable testing every syscall event.
	 It only enables the event and disables it and runs various loads
	 with the event enabled. This adds a bit more time for kernel boot
	 up since it runs this on every system call defined.

	 TBD - enable a way to actually call the syscalls as we test their
	       events

529 530
config MMIOTRACE
	bool "Memory mapped IO tracing"
I
Ingo Molnar 已提交
531
	depends on HAVE_MMIOTRACE_SUPPORT && PCI
532
	select GENERIC_TRACER
533 534 535 536 537 538
	help
	  Mmiotrace traces Memory Mapped I/O access and is meant for
	  debugging and reverse engineering. It is called from the ioremap
	  implementation and works via page faults. Tracing is disabled by
	  default and can be enabled at run-time.

L
Li Zefan 已提交
539
	  See Documentation/trace/mmiotrace.txt.
540 541 542 543 544 545 546 547 548 549 550 551
	  If you are not helping to develop drivers, say N.

config MMIOTRACE_TEST
	tristate "Test module for mmiotrace"
	depends on MMIOTRACE && m
	help
	  This is a dumb module for testing mmiotrace. It is very dangerous
	  as it will write garbage to IO memory starting at a given address.
	  However, it should be safe to use on e.g. unused portion of VRAM.

	  Say N, unless you absolutely know what you are doing.

552 553 554 555
config RING_BUFFER_BENCHMARK
	tristate "Ring buffer benchmark stress tester"
	depends on RING_BUFFER
	help
556 557
	  This option creates a test to stress the ring buffer and benchmark it.
	  It creates its own ring buffer such that it will not interfere with
558 559 560 561 562 563 564 565
	  any other users of the ring buffer (such as ftrace). It then creates
	  a producer and consumer that will run for 10 seconds and sleep for
	  10 seconds. Each interval it will print out the number of events
	  it recorded and give a rough estimate of how long each iteration took.

	  It does not disable interrupts or raise its priority, so it may be
	  affected by processes that are running.

566
	  If unsure, say N.
567

568
endif # FTRACE
I
Ingo Molnar 已提交
569 570 571

endif # TRACING_SUPPORT