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
config HAVE_FTRACE_MCOUNT_RECORD
	bool
44
	help
45
	  See Documentation/trace/ftrace-design.txt
46

47
config HAVE_SYSCALL_TRACEPOINTS
48
	bool
49
	help
50
	  See Documentation/trace/ftrace-design.txt
51

52 53 54
config TRACER_MAX_TRACE
	bool

S
Steven Rostedt 已提交
55 56 57
config RING_BUFFER
	bool

58 59 60 61 62
config FTRACE_NMI_ENTER
       bool
       depends on HAVE_FTRACE_NMI_ENTER
       default y

63
config EVENT_TRACING
64 65 66 67
	select CONTEXT_SWITCH_TRACER
	bool

config CONTEXT_SWITCH_TRACER
68 69
	bool

70 71 72 73 74 75
config RING_BUFFER_ALLOW_SWAP
	bool
	help
	 Allow the use of ring_buffer_swap_cpu.
	 Adds a very slight overhead to tracing when enabled.

76 77 78 79 80
# 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
81
# hiding of the automatic options.
82

83 84 85
config TRACING
	bool
	select DEBUG_FS
S
Steven Rostedt 已提交
86
	select RING_BUFFER
87
	select STACKTRACE if STACKTRACE_SUPPORT
88
	select TRACEPOINTS
89
	select NOP_TRACER
90
	select BINARY_PRINTF
91
	select EVENT_TRACING
92

93 94 95 96
config GENERIC_TRACER
	bool
	select TRACING

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

if TRACING_SUPPORT

113 114
menuconfig FTRACE
	bool "Tracers"
115
	default y if DEBUG_KERNEL
116
	help
117
	  Enable the kernel tracing infrastructure.
118 119

if FTRACE
P
Peter Zijlstra 已提交
120

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

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

S
Steven Rostedt 已提交
151

152 153 154 155
config IRQSOFF_TRACER
	bool "Interrupts-off Latency Tracer"
	default n
	depends on TRACE_IRQFLAGS_SUPPORT
J
John Stultz 已提交
156
	depends on !ARCH_USES_GETTIMEOFFSET
157
	select TRACE_IRQFLAGS
158
	select GENERIC_TRACER
159
	select TRACER_MAX_TRACE
160
	select RING_BUFFER_ALLOW_SWAP
161 162 163 164 165 166 167 168
	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:

169
	      echo 0 > /sys/kernel/debug/tracing/tracing_max_latency
170

171
	  (Note that kernel size and overhead increase with this option
172 173 174 175 176 177
	  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 已提交
178
	depends on !ARCH_USES_GETTIMEOFFSET
179
	depends on PREEMPT
180
	select GENERIC_TRACER
181
	select TRACER_MAX_TRACE
182
	select RING_BUFFER_ALLOW_SWAP
183
	help
184
	  This option measures the time spent in preemption-off critical
185 186 187 188 189 190
	  sections, with microsecond accuracy.

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

191
	      echo 0 > /sys/kernel/debug/tracing/tracing_max_latency
192

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

I
Ingo Molnar 已提交
197 198
config SYSPROF_TRACER
	bool "Sysprof Tracer"
T
Thomas Gleixner 已提交
199
	depends on X86
200
	select GENERIC_TRACER
201
	select CONTEXT_SWITCH_TRACER
I
Ingo Molnar 已提交
202 203 204 205
	help
	  This tracer provides the trace needed by the 'Sysprof' userspace
	  tool.

206 207
config SCHED_TRACER
	bool "Scheduling Latency Tracer"
208
	select GENERIC_TRACER
209 210 211 212 213 214
	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.

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

224 225
config FTRACE_SYSCALLS
	bool "Trace syscalls"
226
	depends on HAVE_SYSCALL_TRACEPOINTS
227
	select GENERIC_TRACER
228
	select KALLSYMS
229 230 231
	help
	  Basic tracer to catch the syscall entry and exit events.

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

241
	  Its aim is to be parsed by the scripts/bootgraph.pl tool to
I
Ingo Molnar 已提交
242 243 244 245
	  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.

246 247
	  You must pass in initcall_debug and ftrace=initcall to the kernel
	  command line to enable this on bootup.
248

249
config TRACE_BRANCH_PROFILING
250
	bool
251
	select GENERIC_TRACER
252 253 254 255 256 257 258 259 260 261 262

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.

263
	 The "all branch" profiler will profile every if-statement in the
264
	 kernel. This profiler will also enable the likely/unlikely
265
	 profiler.
266

267 268
	 Either of the above profilers adds a bit of overhead to the system.
	 If unsure, choose "No branch profiling".
269 270 271 272

config BRANCH_PROFILE_NONE
	bool "No branch profiling"
	help
273 274 275
	  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.
276 277 278 279

config PROFILE_ANNOTATED_BRANCHES
	bool "Trace likely/unlikely profiler"
	select TRACE_BRANCH_PROFILING
280 281 282 283
	help
	  This tracer profiles all the the likely and unlikely macros
	  in the kernel. It will display the results in:

284
	  /sys/kernel/debug/tracing/profile_annotated_branch
285

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

289 290
config PROFILE_ALL_BRANCHES
	bool "Profile all if conditionals"
291
	select TRACE_BRANCH_PROFILING
292 293 294 295 296
	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:

297
	  /sys/kernel/debug/tracing/profile_branch
298

299 300
	  This option also enables the likely/unlikely profiler.

301 302
	  This configuration, when enabled, will impose a great overhead
	  on the system. This should only be enabled when the system
303
	  is to be analyzed in much detail.
304
endchoice
305

306
config TRACING_BRANCHES
307 308 309 310 311 312 313
	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.

314
config BRANCH_TRACER
315
	bool "Trace likely/unlikely instances"
316 317
	depends on TRACE_BRANCH_PROFILING
	select TRACING_BRANCHES
318 319 320 321 322 323 324 325 326 327
	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.

328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
config KSYM_TRACER
	bool "Trace read and write access on kernel memory locations"
	depends on HAVE_HW_BREAKPOINT
	select TRACING
	help
	  This tracer helps find read and write operations on any given kernel
	  symbol i.e. /proc/kallsyms.

config PROFILE_KSYM_TRACER
	bool "Profile all kernel memory accesses on 'watched' variables"
	depends on KSYM_TRACER
	help
	  This tracer profiles kernel accesses on variables watched through the
	  ksym tracer ftrace plugin. Depending upon the hardware, all read
	  and write operations on kernel variables can be monitored for
	  accesses.

	  The results will be displayed in:
	  /debugfs/tracing/profile_ksym

	  Say N if unsure.
349

S
Steven Rostedt 已提交
350 351
config STACK_TRACER
	bool "Trace max stack"
352 353
	depends on HAVE_FUNCTION_TRACER
	select FUNCTION_TRACER
S
Steven Rostedt 已提交
354
	select STACKTRACE
355
	select KALLSYMS
S
Steven Rostedt 已提交
356
	help
357
	  This special tracer records the maximum stack footprint of the
358
	  kernel and displays it in /sys/kernel/debug/tracing/stack_trace.
359 360 361

	  This tracer works by hooking into every function call that the
	  kernel executes, and keeping a maximum stack depth value and
362 363 364 365 366 367 368 369 370
	  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
371 372

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

374 375
config KMEMTRACE
	bool "Trace SLAB allocations"
376
	select GENERIC_TRACER
377 378
	help
	  kmemtrace provides tracing for slab allocator functions, such as
379
	  kmalloc, kfree, kmem_cache_alloc, kmem_cache_free, etc. Collected
380 381 382 383 384 385
	  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 已提交
386
	  Documentation/trace/kmemtrace.txt for more information.
387 388 389 390 391 392 393

	  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.

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

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

430
config KPROBE_EVENT
431
	depends on KPROBES
432
	depends on HAVE_REGS_AND_STACK_ACCESS_API
433
	bool "Enable kprobes-based dynamic events"
434
	select TRACING
435
	default y
436
	help
437 438 439
	  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.
440 441 442 443

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

444 445
	  This option is also required by perf-probe subcommand of perf tools.
	  If you want to use perf tools, this option is strongly recommended.
446

447 448
config DYNAMIC_FTRACE
	bool "enable/disable ftrace tracepoints dynamically"
449
	depends on FUNCTION_TRACER
450
	depends on HAVE_DYNAMIC_FTRACE
451 452
	default y
	help
453 454 455 456
          This option will modify all the calls to ftrace dynamically
	  (will patch them out of the binary image and replace them
	  with a No-Op instruction) as they are called. A table is
	  created to dynamically enable them again.
457

458 459
	  This way a CONFIG_FUNCTION_TRACER kernel is slightly larger, but
	  otherwise has native performance as long as no tracing is active.
460

461 462 463 464
	  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 已提交
465

S
Steven Rostedt 已提交
466 467
config FUNCTION_PROFILER
	bool "Kernel function profiler"
468
	depends on FUNCTION_TRACER
S
Steven Rostedt 已提交
469 470
	default n
	help
471 472 473 474 475 476
	  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 已提交
477

478
	  If in doubt, say N.
S
Steven Rostedt 已提交
479

480 481 482 483 484
config FTRACE_MCOUNT_RECORD
	def_bool y
	depends on DYNAMIC_FTRACE
	depends on HAVE_FTRACE_MCOUNT_RECORD

S
Steven Rostedt 已提交
485 486 487 488 489
config FTRACE_SELFTEST
	bool

config FTRACE_STARTUP_TEST
	bool "Perform a startup test on ftrace"
490
	depends on GENERIC_TRACER
S
Steven Rostedt 已提交
491 492 493 494 495 496
	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 已提交
497

498 499 500 501 502 503 504 505 506 507 508 509
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

510 511
config MMIOTRACE
	bool "Memory mapped IO tracing"
I
Ingo Molnar 已提交
512
	depends on HAVE_MMIOTRACE_SUPPORT && PCI
513
	select GENERIC_TRACER
514 515 516 517 518 519
	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 已提交
520
	  See Documentation/trace/mmiotrace.txt.
521 522 523 524 525 526 527 528 529 530 531 532
	  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.

533 534 535 536
config RING_BUFFER_BENCHMARK
	tristate "Ring buffer benchmark stress tester"
	depends on RING_BUFFER
	help
537 538
	  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
539 540 541 542 543 544 545 546
	  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.

547
	  If unsure, say N.
548

549
endif # FTRACE
I
Ingo Molnar 已提交
550 551 552

endif # TRACING_SUPPORT