Kconfig 16.2 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 15
	help
	  See Documentation/trace/ftrace-implementation.txt
16

17
config HAVE_FUNCTION_TRACER
18
	bool
19 20
	help
	  See Documentation/trace/ftrace-implementation.txt
21

22
config HAVE_FUNCTION_GRAPH_TRACER
23
	bool
24 25
	help
	  See Documentation/trace/ftrace-implementation.txt
26

27 28 29 30 31 32 33
config HAVE_FUNCTION_GRAPH_FP_TEST
	bool
	help
	 An arch may pass in a unique value (frame pointer) to both the
	 entering and exiting of a function. On exit, the value is compared
	 and if it does not match, then it will panic the kernel.

34 35 36
config HAVE_FUNCTION_TRACE_MCOUNT_TEST
	bool
	help
37
	  See Documentation/trace/ftrace-implementation.txt
38

39 40
config HAVE_DYNAMIC_FTRACE
	bool
41 42
	help
	  See Documentation/trace/ftrace-implementation.txt
43

44 45
config HAVE_FTRACE_MCOUNT_RECORD
	bool
46 47
	help
	  See Documentation/trace/ftrace-implementation.txt
48

49 50 51
config HAVE_HW_BRANCH_TRACER
	bool

52
config HAVE_SYSCALL_TRACEPOINTS
53
	bool
54 55
	help
	  See Documentation/trace/ftrace-implementation.txt
56

57 58 59
config TRACER_MAX_TRACE
	bool

S
Steven Rostedt 已提交
60 61 62
config RING_BUFFER
	bool

63 64 65 66 67
config FTRACE_NMI_ENTER
       bool
       depends on HAVE_FTRACE_NMI_ENTER
       default y

68
config EVENT_TRACING
69 70 71 72
	select CONTEXT_SWITCH_TRACER
	bool

config CONTEXT_SWITCH_TRACER
73 74
	bool

75 76 77 78 79 80
config RING_BUFFER_ALLOW_SWAP
	bool
	help
	 Allow the use of ring_buffer_swap_cpu.
	 Adds a very slight overhead to tracing when enabled.

81 82 83 84 85 86 87
# 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
# hidding of the automatic options options.

88 89 90
config TRACING
	bool
	select DEBUG_FS
S
Steven Rostedt 已提交
91
	select RING_BUFFER
92
	select STACKTRACE if STACKTRACE_SUPPORT
93
	select TRACEPOINTS
94
	select NOP_TRACER
95
	select BINARY_PRINTF
96
	select EVENT_TRACING
97

98 99 100 101
config GENERIC_TRACER
	bool
	select TRACING

I
Ingo Molnar 已提交
102 103 104 105 106 107
#
# Minimum requirements an architecture has to meet for us to
# be able to offer generic tracing facilities:
#
config TRACING_SUPPORT
	bool
108 109 110 111 112
	# 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 已提交
113
	depends on STACKTRACE_SUPPORT
114
	default y
I
Ingo Molnar 已提交
115 116 117

if TRACING_SUPPORT

118 119
menuconfig FTRACE
	bool "Tracers"
120
	default y if DEBUG_KERNEL
121 122 123 124
	help
	 Enable the kernel tracing infrastructure.

if FTRACE
P
Peter Zijlstra 已提交
125

126
config FUNCTION_TRACER
S
Steven Rostedt 已提交
127
	bool "Kernel Function Tracer"
128
	depends on HAVE_FUNCTION_TRACER
S
Steven Rostedt 已提交
129
	select FRAME_POINTER
130
	select KALLSYMS
131
	select GENERIC_TRACER
132
	select CONTEXT_SWITCH_TRACER
S
Steven Rostedt 已提交
133 134 135 136 137 138 139 140
	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
	  instruction to the beginning of every kernel function, which NOP
	  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.
141

142 143 144
config FUNCTION_GRAPH_TRACER
	bool "Kernel Function Graph Tracer"
	depends on HAVE_FUNCTION_GRAPH_TRACER
145
	depends on FUNCTION_TRACER
146
	depends on !X86_32 || !CC_OPTIMIZE_FOR_SIZE
147
	default y
148
	help
149 150
	  Enable the kernel to trace a function at both its return
	  and its entry.
151 152 153 154
	  Its first purpose is to trace the duration of functions and
	  draw a call graph for each thread with some information like
	  the return value. This is done by setting the current return 
	  address on the current task structure into a stack of calls.
155

S
Steven Rostedt 已提交
156

157 158 159 160 161 162
config IRQSOFF_TRACER
	bool "Interrupts-off Latency Tracer"
	default n
	depends on TRACE_IRQFLAGS_SUPPORT
	depends on GENERIC_TIME
	select TRACE_IRQFLAGS
163
	select GENERIC_TRACER
164
	select TRACER_MAX_TRACE
165
	select RING_BUFFER_ALLOW_SWAP
166 167 168 169 170 171 172 173
	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:

174
	      echo 0 > /sys/kernel/debug/tracing/tracing_max_latency
175

176 177 178 179 180 181 182 183 184
	  (Note that kernel size and overhead increases with this option
	  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
	depends on GENERIC_TIME
	depends on PREEMPT
185
	select GENERIC_TRACER
186
	select TRACER_MAX_TRACE
187
	select RING_BUFFER_ALLOW_SWAP
188 189 190 191 192 193 194 195
	help
	  This option measures the time spent in preemption 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:

196
	      echo 0 > /sys/kernel/debug/tracing/tracing_max_latency
197 198 199 200 201

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

I
Ingo Molnar 已提交
202 203
config SYSPROF_TRACER
	bool "Sysprof Tracer"
T
Thomas Gleixner 已提交
204
	depends on X86
205
	select GENERIC_TRACER
206
	select CONTEXT_SWITCH_TRACER
I
Ingo Molnar 已提交
207 208 209 210
	help
	  This tracer provides the trace needed by the 'Sysprof' userspace
	  tool.

211 212
config SCHED_TRACER
	bool "Scheduling Latency Tracer"
213
	select GENERIC_TRACER
214 215 216 217 218 219
	select CONTEXT_SWITCH_TRACER
	select TRACER_MAX_TRACE
	help
	  This tracer tracks the latency of the highest priority task
	  to be scheduled in, starting from the point it has woken up.

220 221
config ENABLE_DEFAULT_TRACERS
	bool "Trace process context switches and events"
222
	depends on !GENERIC_TRACER
223 224 225 226
	select TRACING
	help
	  This tracer hooks to various trace points in the kernel
	  allowing the user to pick and choose which trace point they
227
	  want to trace. It also includes the sched_switch tracer plugin.
228

229 230
config FTRACE_SYSCALLS
	bool "Trace syscalls"
231
	depends on HAVE_SYSCALL_TRACEPOINTS
232
	select GENERIC_TRACER
233
	select KALLSYMS
234 235 236
	help
	  Basic tracer to catch the syscall entry and exit events.

237 238
config BOOT_TRACER
	bool "Trace boot initcalls"
239
	select GENERIC_TRACER
240
	select CONTEXT_SWITCH_TRACER
241 242
	help
	  This tracer helps developers to optimize boot times: it records
I
Ingo Molnar 已提交
243 244 245
	  the timings of the initcalls and traces key events and the identity
	  of tasks that can cause boot delays, such as context-switches.

246
	  Its aim is to be parsed by the scripts/bootgraph.pl tool to
I
Ingo Molnar 已提交
247 248 249 250
	  produce pretty graphics about boot inefficiencies, giving a visual
	  representation of the delays during initcalls - but the raw
	  /debug/tracing/trace text output is readable too.

251 252
	  You must pass in initcall_debug and ftrace=initcall to the kernel
	  command line to enable this on bootup.
253

254
config TRACE_BRANCH_PROFILING
255
	bool
256
	select GENERIC_TRACER
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284

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.

	 The "all branch" profiler will profile every if statement in the
	 kernel. This profiler will also enable the likely/unlikely
	 profiler as well.

	 Either of the above profilers add a bit of overhead to the system.
	 If unsure choose "No branch profiling".

config BRANCH_PROFILE_NONE
	bool "No branch profiling"
	help
	 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.

config PROFILE_ANNOTATED_BRANCHES
	bool "Trace likely/unlikely profiler"
	select TRACE_BRANCH_PROFILING
285 286 287 288
	help
	  This tracer profiles all the the likely and unlikely macros
	  in the kernel. It will display the results in:

289
	  /sys/kernel/debug/tracing/profile_annotated_branch
290 291 292 293

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

294 295
config PROFILE_ALL_BRANCHES
	bool "Profile all if conditionals"
296
	select TRACE_BRANCH_PROFILING
297 298 299 300 301
	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:

302
	  /sys/kernel/debug/tracing/profile_branch
303

304 305
	  This option also enables the likely/unlikely profiler.

306 307 308
	  This configuration, when enabled, will impose a great overhead
	  on the system. This should only be enabled when the system
	  is to be analyzed
309
endchoice
310

311
config TRACING_BRANCHES
312 313 314 315 316 317 318
	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.

319
config BRANCH_TRACER
320
	bool "Trace likely/unlikely instances"
321 322
	depends on TRACE_BRANCH_PROFILING
	select TRACING_BRANCHES
323 324 325 326 327 328 329 330 331 332
	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.

333 334 335
config POWER_TRACER
	bool "Trace power consumption behavior"
	depends on X86
336
	select GENERIC_TRACER
337 338 339 340 341 342
	help
	  This tracer helps developers to analyze and optimize the kernels
	  power management decisions, specifically the C-state and P-state
	  behavior.


S
Steven Rostedt 已提交
343 344
config STACK_TRACER
	bool "Trace max stack"
345 346
	depends on HAVE_FUNCTION_TRACER
	select FUNCTION_TRACER
S
Steven Rostedt 已提交
347
	select STACKTRACE
348
	select KALLSYMS
S
Steven Rostedt 已提交
349
	help
350
	  This special tracer records the maximum stack footprint of the
351
	  kernel and displays it in /sys/kernel/debug/tracing/stack_trace.
352 353 354

	  This tracer works by hooking into every function call that the
	  kernel executes, and keeping a maximum stack depth value and
355 356 357 358 359 360 361 362 363
	  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
364 365

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

367
config HW_BRANCH_TRACER
368
	depends on HAVE_HW_BRANCH_TRACER
369
	bool "Trace hw branches"
370
	select GENERIC_TRACER
371 372 373 374
	help
	  This tracer records all branches on the system in a circular
	  buffer giving access to the last N branches for each cpu.

375 376
config KMEMTRACE
	bool "Trace SLAB allocations"
377
	select GENERIC_TRACER
378 379 380 381 382 383 384 385 386
	help
	  kmemtrace provides tracing for slab allocator functions, such as
	  kmalloc, kfree, kmem_cache_alloc, kmem_cache_free etc.. Collected
	  data is then fed to the userspace application in order to analyse
	  allocation hotspots, internal fragmentation and so on, making it
	  possible to see how well an allocator performs, as well as debug
	  and profile kernel code.

	  This requires an userspace application to use. See
L
Li Zefan 已提交
387
	  Documentation/trace/kmemtrace.txt for more information.
388 389 390 391 392 393 394

	  Saying Y will make the kernel somewhat larger and slower. However,
	  if you disable kmemtrace at run-time or boot-time, the performance
	  impact is minimal (depending on the arch the kernel is built for).

	  If unsure, say N.

395 396
config WORKQUEUE_TRACER
	bool "Trace workqueues"
397
	select GENERIC_TRACER
398 399 400 401 402 403 404 405
	help
	  The workqueue tracer provides some statistical informations
          about each cpu workqueue thread such as the number of the
          works inserted and executed since their creation. It can help
          to evaluate the amount of work each of them have to perform.
          For example it can help a developer to decide whether he should
          choose a per cpu workqueue instead of a singlethreaded one.

406 407 408
config BLK_DEV_IO_TRACE
	bool "Support for tracing block io actions"
	depends on SYSFS
409
	depends on BLOCK
410 411 412
	select RELAY
	select DEBUG_FS
	select TRACEPOINTS
413
	select GENERIC_TRACER
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429
	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.
430

431 432
config DYNAMIC_FTRACE
	bool "enable/disable ftrace tracepoints dynamically"
433
	depends on FUNCTION_TRACER
434
	depends on HAVE_DYNAMIC_FTRACE
435 436 437 438 439 440 441
	default y
	help
         This option will modify all the calls to ftrace dynamically
	 (will patch them out of the binary image and replaces them
	 with a No-Op instruction) as they are called. A table is
	 created to dynamically enable them again.

442
	 This way a CONFIG_FUNCTION_TRACER kernel is slightly larger, but otherwise
443 444 445 446 447 448
	 has native performance as long as no tracing is active.

	 The changes to the code are done by a kernel thread that
	 wakes up once a second and checks to see if any ftrace calls
	 were made. If so, it runs stop_machine (stops all CPUS)
	 and modifies the code to jump over the call to ftrace.
S
Steven Rostedt 已提交
449

S
Steven Rostedt 已提交
450 451
config FUNCTION_PROFILER
	bool "Kernel function profiler"
452
	depends on FUNCTION_TRACER
S
Steven Rostedt 已提交
453 454
	default n
	help
455 456
	 This option enables the kernel function profiler. A file is created
	 in debugfs called function_profile_enabled which defaults to zero.
S
Steven Rostedt 已提交
457 458 459 460 461 462 463
	 When a 1 is echoed into this file profiling begins, and when a
	 zero is entered, profiling stops. A file in the trace_stats
	 directory called functions, that show the list of functions that
	 have been hit and their counters.

	 If in doubt, say N

464 465 466 467 468
config FTRACE_MCOUNT_RECORD
	def_bool y
	depends on DYNAMIC_FTRACE
	depends on HAVE_FTRACE_MCOUNT_RECORD

S
Steven Rostedt 已提交
469 470 471 472 473
config FTRACE_SELFTEST
	bool

config FTRACE_STARTUP_TEST
	bool "Perform a startup test on ftrace"
474
	depends on GENERIC_TRACER
S
Steven Rostedt 已提交
475 476 477 478 479 480
	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 已提交
481

482 483 484 485 486 487 488 489 490 491 492 493
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

494 495
config MMIOTRACE
	bool "Memory mapped IO tracing"
I
Ingo Molnar 已提交
496
	depends on HAVE_MMIOTRACE_SUPPORT && PCI
497
	select GENERIC_TRACER
498 499 500 501 502 503
	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 已提交
504
	  See Documentation/trace/mmiotrace.txt.
505 506 507 508 509 510 511 512 513 514 515 516
	  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.

517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
config RING_BUFFER_BENCHMARK
	tristate "Ring buffer benchmark stress tester"
	depends on RING_BUFFER
	help
	  This option creates a test to stress the ring buffer and bench mark it.
	  It creates its own ring buffer such that it will not interfer with
	  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.

	  If unsure, say N

533
endif # FTRACE
I
Ingo Molnar 已提交
534 535 536

endif # TRACING_SUPPORT