blob: 1f89ca0ad5635023deb4d2a1f77d60beb4d16076 [file] [log] [blame]
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +02001#
Steven Rostedt606576c2008-10-06 19:06:12 -04002# Architectures that offer an FUNCTION_TRACER implementation should
3# select HAVE_FUNCTION_TRACER:
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +02004#
Frédéric Weisbecker2a3a4f62008-09-21 20:12:14 +02005
Török Edwin8d264872008-11-23 12:39:08 +02006config USER_STACKTRACE_SUPPORT
7 bool
8
Frédéric Weisbecker2a3a4f62008-09-21 20:12:14 +02009config NOP_TRACER
10 bool
11
Steven Rostedt78d904b2009-02-05 18:43:07 -050012config HAVE_FTRACE_NMI_ENTER
13 bool
Mike Frysinger555f3862009-09-14 20:10:15 -040014 help
Randy Dunlap40892362009-12-21 12:01:17 -080015 See Documentation/trace/ftrace-design.txt
Steven Rostedt78d904b2009-02-05 18:43:07 -050016
Steven Rostedt606576c2008-10-06 19:06:12 -040017config HAVE_FUNCTION_TRACER
Arnaldo Carvalho de Melo16444a82008-05-12 21:20:42 +020018 bool
Mike Frysinger555f3862009-09-14 20:10:15 -040019 help
Randy Dunlap40892362009-12-21 12:01:17 -080020 See Documentation/trace/ftrace-design.txt
Steven Rostedtbc0c38d2008-05-12 21:20:42 +020021
Frederic Weisbeckerfb526072008-11-25 21:07:04 +010022config HAVE_FUNCTION_GRAPH_TRACER
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +010023 bool
Mike Frysinger555f3862009-09-14 20:10:15 -040024 help
Randy Dunlap40892362009-12-21 12:01:17 -080025 See Documentation/trace/ftrace-design.txt
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +010026
Steven Rostedt677aa9f2008-05-17 00:01:36 -040027config HAVE_DYNAMIC_FTRACE
28 bool
Mike Frysinger555f3862009-09-14 20:10:15 -040029 help
Randy Dunlap40892362009-12-21 12:01:17 -080030 See Documentation/trace/ftrace-design.txt
Steven Rostedt677aa9f2008-05-17 00:01:36 -040031
Masami Hiramatsu06aeaae2012-09-28 17:15:17 +090032config HAVE_DYNAMIC_FTRACE_WITH_REGS
33 bool
34
Steven Rostedt8da38212008-08-14 15:45:07 -040035config HAVE_FTRACE_MCOUNT_RECORD
36 bool
Mike Frysinger555f3862009-09-14 20:10:15 -040037 help
Randy Dunlap40892362009-12-21 12:01:17 -080038 See Documentation/trace/ftrace-design.txt
Steven Rostedt8da38212008-08-14 15:45:07 -040039
Josh Stone66700002009-08-24 14:43:11 -070040config HAVE_SYSCALL_TRACEPOINTS
Frederic Weisbeckeree08c6e2009-03-07 05:52:59 +010041 bool
Mike Frysinger555f3862009-09-14 20:10:15 -040042 help
Randy Dunlap40892362009-12-21 12:01:17 -080043 See Documentation/trace/ftrace-design.txt
Frederic Weisbeckeree08c6e2009-03-07 05:52:59 +010044
Steven Rostedta2546fa2011-02-09 13:15:59 -050045config HAVE_FENTRY
46 bool
47 help
48 Arch supports the gcc options -pg with -mfentry
49
Steven Rostedtcf4db252010-10-14 23:32:44 -040050config HAVE_C_RECORDMCOUNT
Steven Rostedt72441cb2010-10-13 17:12:30 -040051 bool
52 help
53 C version of recordmcount available?
54
Steven Rostedt352ad252008-05-12 21:20:42 +020055config TRACER_MAX_TRACE
56 bool
57
Josh Triplettea632e92012-09-02 19:45:14 -070058config TRACE_CLOCK
59 bool
60
Steven Rostedt7a8e76a2008-09-29 23:02:38 -040061config RING_BUFFER
62 bool
Josh Triplettea632e92012-09-02 19:45:14 -070063 select TRACE_CLOCK
Steven Rostedt (Red Hat)22287682013-05-03 11:16:18 -040064 select IRQ_WORK
Steven Rostedt7a8e76a2008-09-29 23:02:38 -040065
Steven Rostedt78d904b2009-02-05 18:43:07 -050066config FTRACE_NMI_ENTER
67 bool
68 depends on HAVE_FTRACE_NMI_ENTER
69 default y
70
Tom Zanussi5f77a882009-04-08 03:14:01 -050071config EVENT_TRACING
Zhaoleib11c53e2009-05-25 18:11:59 +080072 select CONTEXT_SWITCH_TRACER
73 bool
74
Jamie Gennisdcaf3d62013-02-21 17:55:28 -080075config GPU_TRACEPOINTS
76 bool
77
Zhaoleib11c53e2009-05-25 18:11:59 +080078config CONTEXT_SWITCH_TRACER
Tom Zanussi5f77a882009-04-08 03:14:01 -050079 bool
80
Steven Rostedt85bac322009-09-04 14:24:40 -040081config RING_BUFFER_ALLOW_SWAP
82 bool
83 help
84 Allow the use of ring_buffer_swap_cpu.
85 Adds a very slight overhead to tracing when enabled.
86
Karthikeyan Ramasubramanian44dc7702016-09-16 15:39:37 -060087config IPC_LOGGING
88 bool "Debug Logging for IPC Drivers"
89 select GENERIC_TRACER
90 help
91 IPC Logging driver provides a logging option for IPC Drivers.
92 This provides a cyclic buffer based logging support in a driver
93 specific context. This driver also provides a debugfs interface
94 to dump the logs in a live fashion.
95
96 If in doubt, say no.
97
Bhargav Gurappadi0084bbd2016-08-04 14:44:23 -070098config QCOM_RTB
99 bool "Register tracing"
100 help
101 Enable the kernel to trace every kernel function. This is done
102 Add support for logging different events to a small uncached
103 region. This is designed to aid in debugging reset cases where the
104 caches may not be flushed before the target resets.
105
106config QCOM_RTB_SEPARATE_CPUS
107 bool "Separate entries for each cpu"
108 depends on QCOM_RTB
109 depends on SMP
110 help
111 Under some circumstances, it may be beneficial to give dedicated space
112 for each cpu to log accesses. Selecting this option will log each cpu
113 separately. This will guarantee that the last acesses for each cpu
114 will be logged but there will be fewer entries per cpu
115
Steven Rostedt5e0a0932009-05-28 15:50:13 -0400116# All tracer options should select GENERIC_TRACER. For those options that are
117# enabled by all tracers (context switch and event tracer) they select TRACING.
118# This allows those options to appear when no other tracer is selected. But the
119# options do not appear when something else selects it. We need the two options
120# GENERIC_TRACER and TRACING to avoid circular dependencies to accomplish the
Randy Dunlap40892362009-12-21 12:01:17 -0800121# hiding of the automatic options.
Steven Rostedt5e0a0932009-05-28 15:50:13 -0400122
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200123config TRACING
124 bool
125 select DEBUG_FS
Steven Rostedt7a8e76a2008-09-29 23:02:38 -0400126 select RING_BUFFER
Al Viroc2c80522008-10-31 19:50:41 +0000127 select STACKTRACE if STACKTRACE_SUPPORT
Ingo Molnar5f87f112008-07-23 14:15:22 +0200128 select TRACEPOINTS
Steven Rostedtf3384b22008-10-29 11:15:57 -0400129 select NOP_TRACER
Frederic Weisbecker769b0442009-03-06 17:21:49 +0100130 select BINARY_PRINTF
Tom Zanussi5f77a882009-04-08 03:14:01 -0500131 select EVENT_TRACING
Josh Triplettea632e92012-09-02 19:45:14 -0700132 select TRACE_CLOCK
Steven Rostedtbc0c38d2008-05-12 21:20:42 +0200133
Steven Rostedt5e0a0932009-05-28 15:50:13 -0400134config GENERIC_TRACER
135 bool
136 select TRACING
137
Ingo Molnar40ada302009-03-05 21:19:55 +0100138#
139# Minimum requirements an architecture has to meet for us to
140# be able to offer generic tracing facilities:
141#
142config TRACING_SUPPORT
143 bool
Anton Vorontsov45b95602009-03-24 01:07:24 +0300144 # PPC32 has no irqflags tracing support, but it can use most of the
145 # tracers anyway, they were tested to build and work. Note that new
146 # exceptions to this list aren't welcomed, better implement the
147 # irqflags tracing for your architecture.
148 depends on TRACE_IRQFLAGS_SUPPORT || PPC32
Ingo Molnar40ada302009-03-05 21:19:55 +0100149 depends on STACKTRACE_SUPPORT
KOSAKI Motohiro422d3c72009-03-06 10:40:53 +0900150 default y
Ingo Molnar40ada302009-03-05 21:19:55 +0100151
152if TRACING_SUPPORT
153
Steven Rostedt4ed9f072009-04-20 10:47:36 -0400154menuconfig FTRACE
155 bool "Tracers"
Steven Rostedt65b77242009-05-07 12:49:27 -0400156 default y if DEBUG_KERNEL
Steven Rostedt4ed9f072009-04-20 10:47:36 -0400157 help
Randy Dunlap40892362009-12-21 12:01:17 -0800158 Enable the kernel tracing infrastructure.
Steven Rostedt4ed9f072009-04-20 10:47:36 -0400159
160if FTRACE
Peter Zijlstra17d80fd2008-10-21 16:31:18 +0200161
Steven Rostedt606576c2008-10-06 19:06:12 -0400162config FUNCTION_TRACER
Steven Rostedt1b29b012008-05-12 21:20:42 +0200163 bool "Kernel Function Tracer"
Steven Rostedt606576c2008-10-06 19:06:12 -0400164 depends on HAVE_FUNCTION_TRACER
Steven Rostedt4d7a0772009-02-18 22:06:18 -0500165 select KALLSYMS
Steven Rostedt5e0a0932009-05-28 15:50:13 -0400166 select GENERIC_TRACER
Steven Rostedt35e8e302008-05-12 21:20:42 +0200167 select CONTEXT_SWITCH_TRACER
Steven Rostedt1b29b012008-05-12 21:20:42 +0200168 help
169 Enable the kernel to trace every kernel function. This is done
170 by using a compiler feature to insert a small, 5-byte No-Operation
Randy Dunlap40892362009-12-21 12:01:17 -0800171 instruction at the beginning of every kernel function, which NOP
Steven Rostedt1b29b012008-05-12 21:20:42 +0200172 sequence is then dynamically patched into a tracer call when
173 tracing is enabled by the administrator. If it's runtime disabled
174 (the bootup default), then the overhead of the instructions is very
175 small and not measurable even in micro-benchmarks.
Steven Rostedt35e8e302008-05-12 21:20:42 +0200176
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100177config FUNCTION_GRAPH_TRACER
178 bool "Kernel Function Graph Tracer"
179 depends on HAVE_FUNCTION_GRAPH_TRACER
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100180 depends on FUNCTION_TRACER
Steven Rostedteb4a0372009-06-18 12:53:21 -0400181 depends on !X86_32 || !CC_OPTIMIZE_FOR_SIZE
Ingo Molnar764f3b92008-12-03 10:33:58 +0100182 default y
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100183 help
Frederic Weisbeckerfb526072008-11-25 21:07:04 +0100184 Enable the kernel to trace a function at both its return
185 and its entry.
Matt LaPlante692105b2009-01-26 11:12:25 +0100186 Its first purpose is to trace the duration of functions and
187 draw a call graph for each thread with some information like
Randy Dunlap40892362009-12-21 12:01:17 -0800188 the return value. This is done by setting the current return
Matt LaPlante692105b2009-01-26 11:12:25 +0100189 address on the current task structure into a stack of calls.
Frederic Weisbecker15e6cb32008-11-11 07:14:25 +0100190
Steven Rostedtbac429f2009-03-20 12:50:56 -0400191
Joel Fernandes2b3a26c2017-10-05 17:54:32 -0700192config PREEMPTIRQ_EVENTS
193 bool "Enable trace events for preempt and irq disable/enable"
194 select TRACE_IRQFLAGS
195 depends on DEBUG_PREEMPT || !PROVE_LOCKING
196 default n
197 help
198 Enable tracing of disable and enable events for preemption and irqs.
199 For tracing preempt disable/enable events, DEBUG_PREEMPT must be
200 enabled. For tracing irq disable/enable events, PROVE_LOCKING must
201 be disabled.
202
Steven Rostedt81d68a92008-05-12 21:20:42 +0200203config IRQSOFF_TRACER
204 bool "Interrupts-off Latency Tracer"
205 default n
206 depends on TRACE_IRQFLAGS_SUPPORT
John Stultz592913e2010-07-13 17:56:20 -0700207 depends on !ARCH_USES_GETTIMEOFFSET
Steven Rostedt81d68a92008-05-12 21:20:42 +0200208 select TRACE_IRQFLAGS
Steven Rostedt5e0a0932009-05-28 15:50:13 -0400209 select GENERIC_TRACER
Steven Rostedt81d68a92008-05-12 21:20:42 +0200210 select TRACER_MAX_TRACE
Steven Rostedt85bac322009-09-04 14:24:40 -0400211 select RING_BUFFER_ALLOW_SWAP
Steven Rostedt (Red Hat)22cffc22013-03-05 07:30:24 -0500212 select TRACER_SNAPSHOT
Steven Rostedt (Red Hat)0b85ffc2013-03-05 14:50:23 -0500213 select TRACER_SNAPSHOT_PER_CPU_SWAP
Steven Rostedt81d68a92008-05-12 21:20:42 +0200214 help
215 This option measures the time spent in irqs-off critical
216 sections, with microsecond accuracy.
217
218 The default measurement method is a maximum search, which is
219 disabled by default and can be runtime (re-)started
220 via:
221
GeunSik Lim156f5a72009-06-02 15:01:37 +0900222 echo 0 > /sys/kernel/debug/tracing/tracing_max_latency
Steven Rostedt81d68a92008-05-12 21:20:42 +0200223
Randy Dunlap40892362009-12-21 12:01:17 -0800224 (Note that kernel size and overhead increase with this option
Steven Rostedt6cd8a4b2008-05-12 21:20:42 +0200225 enabled. This option and the preempt-off timing option can be
226 used together or separately.)
227
228config PREEMPT_TRACER
229 bool "Preemption-off Latency Tracer"
230 default n
John Stultz592913e2010-07-13 17:56:20 -0700231 depends on !ARCH_USES_GETTIMEOFFSET
Steven Rostedt6cd8a4b2008-05-12 21:20:42 +0200232 depends on PREEMPT
Steven Rostedt5e0a0932009-05-28 15:50:13 -0400233 select GENERIC_TRACER
Steven Rostedt6cd8a4b2008-05-12 21:20:42 +0200234 select TRACER_MAX_TRACE
Steven Rostedt85bac322009-09-04 14:24:40 -0400235 select RING_BUFFER_ALLOW_SWAP
Steven Rostedt (Red Hat)22cffc22013-03-05 07:30:24 -0500236 select TRACER_SNAPSHOT
Steven Rostedt (Red Hat)0b85ffc2013-03-05 14:50:23 -0500237 select TRACER_SNAPSHOT_PER_CPU_SWAP
Steven Rostedt6cd8a4b2008-05-12 21:20:42 +0200238 help
Randy Dunlap40892362009-12-21 12:01:17 -0800239 This option measures the time spent in preemption-off critical
Steven Rostedt6cd8a4b2008-05-12 21:20:42 +0200240 sections, with microsecond accuracy.
241
242 The default measurement method is a maximum search, which is
243 disabled by default and can be runtime (re-)started
244 via:
245
GeunSik Lim156f5a72009-06-02 15:01:37 +0900246 echo 0 > /sys/kernel/debug/tracing/tracing_max_latency
Steven Rostedt6cd8a4b2008-05-12 21:20:42 +0200247
Randy Dunlap40892362009-12-21 12:01:17 -0800248 (Note that kernel size and overhead increase with this option
Steven Rostedt6cd8a4b2008-05-12 21:20:42 +0200249 enabled. This option and the irqs-off timing option can be
250 used together or separately.)
251
Steven Rostedt352ad252008-05-12 21:20:42 +0200252config SCHED_TRACER
253 bool "Scheduling Latency Tracer"
Steven Rostedt5e0a0932009-05-28 15:50:13 -0400254 select GENERIC_TRACER
Steven Rostedt352ad252008-05-12 21:20:42 +0200255 select CONTEXT_SWITCH_TRACER
256 select TRACER_MAX_TRACE
Steven Rostedt (Red Hat)22cffc22013-03-05 07:30:24 -0500257 select TRACER_SNAPSHOT
Steven Rostedt352ad252008-05-12 21:20:42 +0200258 help
259 This tracer tracks the latency of the highest priority task
260 to be scheduled in, starting from the point it has woken up.
261
Steven Rostedt (Red Hat)e7c15cd2016-06-23 12:45:36 -0400262config HWLAT_TRACER
263 bool "Tracer to detect hardware latencies (like SMIs)"
264 select GENERIC_TRACER
265 help
266 This tracer, when enabled will create one or more kernel threads,
267 depening on what the cpumask file is set to, which each thread
268 spinning in a loop looking for interruptions caused by
269 something other than the kernel. For example, if a
270 System Management Interrupt (SMI) takes a noticeable amount of
271 time, this tracer will detect it. This is useful for testing
272 if a system is reliable for Real Time tasks.
273
274 Some files are created in the tracing directory when this
275 is enabled:
276
277 hwlat_detector/width - time in usecs for how long to spin for
278 hwlat_detector/window - time in usecs between the start of each
279 iteration
280
281 A kernel thread is created that will spin with interrupts disabled
282 for "width" microseconds in every "widow" cycle. It will not spin
283 for "window - width" microseconds, where the system can
284 continue to operate.
285
286 The output will appear in the trace and trace_pipe files.
287
288 When the tracer is not running, it has no affect on the system,
289 but when it is running, it can cause the system to be
290 periodically non responsive. Do not run this tracer on a
291 production system.
292
293 To enable this tracer, echo in "hwlat" into the current_tracer
294 file. Every time a latency is greater than tracing_thresh, it will
295 be recorded into the ring buffer.
296
Steven Rostedt897f17a2009-05-28 16:31:21 -0400297config ENABLE_DEFAULT_TRACERS
298 bool "Trace process context switches and events"
Steven Rostedt5e0a0932009-05-28 15:50:13 -0400299 depends on !GENERIC_TRACER
Steven Rostedtb77e38a2009-02-24 10:21:36 -0500300 select TRACING
301 help
Randy Dunlap40892362009-12-21 12:01:17 -0800302 This tracer hooks to various trace points in the kernel,
Steven Rostedtb77e38a2009-02-24 10:21:36 -0500303 allowing the user to pick and choose which trace point they
Steven Rostedt897f17a2009-05-28 16:31:21 -0400304 want to trace. It also includes the sched_switch tracer plugin.
Steven Rostedta7abe972009-04-20 10:59:34 -0400305
Frederic Weisbeckeree08c6e2009-03-07 05:52:59 +0100306config FTRACE_SYSCALLS
307 bool "Trace syscalls"
Josh Stone66700002009-08-24 14:43:11 -0700308 depends on HAVE_SYSCALL_TRACEPOINTS
Steven Rostedt5e0a0932009-05-28 15:50:13 -0400309 select GENERIC_TRACER
Frederic Weisbecker0ea1c412009-03-15 22:10:38 +0100310 select KALLSYMS
Frederic Weisbeckeree08c6e2009-03-07 05:52:59 +0100311 help
312 Basic tracer to catch the syscall entry and exit events.
313
Hiraku Toyookadebdd572012-12-26 11:53:00 +0900314config TRACER_SNAPSHOT
315 bool "Create a snapshot trace buffer"
316 select TRACER_MAX_TRACE
317 help
318 Allow tracing users to take snapshot of the current buffer using the
319 ftrace interface, e.g.:
320
321 echo 1 > /sys/kernel/debug/tracing/snapshot
322 cat snapshot
323
Steven Rostedt (Red Hat)0b85ffc2013-03-05 14:50:23 -0500324config TRACER_SNAPSHOT_PER_CPU_SWAP
325 bool "Allow snapshot to swap per CPU"
326 depends on TRACER_SNAPSHOT
327 select RING_BUFFER_ALLOW_SWAP
328 help
329 Allow doing a snapshot of a single CPU buffer instead of a
330 full swap (all buffers). If this is set, then the following is
331 allowed:
332
333 echo 1 > /sys/kernel/debug/tracing/per_cpu/cpu2/snapshot
334
335 After which, only the tracing buffer for CPU 2 was swapped with
336 the main tracing buffer, and the other CPU buffers remain the same.
337
338 When this is enabled, this adds a little more overhead to the
339 trace recording, as it needs to add some checks to synchronize
340 recording with swaps. But this does not affect the performance
341 of the overall system. This is enabled by default when the preempt
342 or irq latency tracers are enabled, as those need to swap as well
343 and already adds the overhead (plus a lot more).
344
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500345config TRACE_BRANCH_PROFILING
Steven Rostedt9ae5b872009-04-20 10:27:58 -0400346 bool
Steven Rostedt5e0a0932009-05-28 15:50:13 -0400347 select GENERIC_TRACER
Steven Rostedt9ae5b872009-04-20 10:27:58 -0400348
349choice
350 prompt "Branch Profiling"
351 default BRANCH_PROFILE_NONE
352 help
353 The branch profiling is a software profiler. It will add hooks
354 into the C conditionals to test which path a branch takes.
355
356 The likely/unlikely profiler only looks at the conditions that
357 are annotated with a likely or unlikely macro.
358
Randy Dunlap40892362009-12-21 12:01:17 -0800359 The "all branch" profiler will profile every if-statement in the
Steven Rostedt9ae5b872009-04-20 10:27:58 -0400360 kernel. This profiler will also enable the likely/unlikely
Randy Dunlap40892362009-12-21 12:01:17 -0800361 profiler.
Steven Rostedt9ae5b872009-04-20 10:27:58 -0400362
Randy Dunlap40892362009-12-21 12:01:17 -0800363 Either of the above profilers adds a bit of overhead to the system.
364 If unsure, choose "No branch profiling".
Steven Rostedt9ae5b872009-04-20 10:27:58 -0400365
366config BRANCH_PROFILE_NONE
367 bool "No branch profiling"
368 help
Randy Dunlap40892362009-12-21 12:01:17 -0800369 No branch profiling. Branch profiling adds a bit of overhead.
370 Only enable it if you want to analyse the branching behavior.
371 Otherwise keep it disabled.
Steven Rostedt9ae5b872009-04-20 10:27:58 -0400372
373config PROFILE_ANNOTATED_BRANCHES
374 bool "Trace likely/unlikely profiler"
375 select TRACE_BRANCH_PROFILING
Steven Rostedt1f0d69a2008-11-12 00:14:39 -0500376 help
Masanari Iida59bf8962012-04-18 00:01:21 +0900377 This tracer profiles all likely and unlikely macros
Steven Rostedt1f0d69a2008-11-12 00:14:39 -0500378 in the kernel. It will display the results in:
379
David Rientjes13e5bef2011-03-16 17:17:08 -0700380 /sys/kernel/debug/tracing/trace_stat/branch_annotated
Steven Rostedt1f0d69a2008-11-12 00:14:39 -0500381
Randy Dunlap40892362009-12-21 12:01:17 -0800382 Note: this will add a significant overhead; only turn this
Steven Rostedt1f0d69a2008-11-12 00:14:39 -0500383 on if you need to profile the system's use of these macros.
384
Steven Rostedt2bcd5212008-11-21 01:30:54 -0500385config PROFILE_ALL_BRANCHES
386 bool "Profile all if conditionals"
Steven Rostedt9ae5b872009-04-20 10:27:58 -0400387 select TRACE_BRANCH_PROFILING
Steven Rostedt2bcd5212008-11-21 01:30:54 -0500388 help
389 This tracer profiles all branch conditions. Every if ()
390 taken in the kernel is recorded whether it hit or miss.
391 The results will be displayed in:
392
David Rientjes13e5bef2011-03-16 17:17:08 -0700393 /sys/kernel/debug/tracing/trace_stat/branch_all
Steven Rostedt2bcd5212008-11-21 01:30:54 -0500394
Steven Rostedt9ae5b872009-04-20 10:27:58 -0400395 This option also enables the likely/unlikely profiler.
396
Steven Rostedt2bcd5212008-11-21 01:30:54 -0500397 This configuration, when enabled, will impose a great overhead
398 on the system. This should only be enabled when the system
Randy Dunlap40892362009-12-21 12:01:17 -0800399 is to be analyzed in much detail.
Steven Rostedt9ae5b872009-04-20 10:27:58 -0400400endchoice
Steven Rostedt2bcd5212008-11-21 01:30:54 -0500401
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500402config TRACING_BRANCHES
Steven Rostedt52f232c2008-11-12 00:14:40 -0500403 bool
404 help
405 Selected by tracers that will trace the likely and unlikely
406 conditions. This prevents the tracers themselves from being
407 profiled. Profiling the tracing infrastructure can only happen
408 when the likelys and unlikelys are not being traced.
409
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500410config BRANCH_TRACER
Steven Rostedt52f232c2008-11-12 00:14:40 -0500411 bool "Trace likely/unlikely instances"
Steven Rostedt2ed84ee2008-11-12 15:24:24 -0500412 depends on TRACE_BRANCH_PROFILING
413 select TRACING_BRANCHES
Steven Rostedt52f232c2008-11-12 00:14:40 -0500414 help
415 This traces the events of likely and unlikely condition
416 calls in the kernel. The difference between this and the
417 "Trace likely/unlikely profiler" is that this is not a
418 histogram of the callers, but actually places the calling
419 events into a running trace buffer to see when and where the
420 events happened, as well as their results.
421
422 Say N if unsure.
423
Steven Rostedte5a81b62008-08-27 23:31:01 -0400424config STACK_TRACER
425 bool "Trace max stack"
Steven Rostedt606576c2008-10-06 19:06:12 -0400426 depends on HAVE_FUNCTION_TRACER
Steven Rostedt606576c2008-10-06 19:06:12 -0400427 select FUNCTION_TRACER
Steven Rostedte5a81b62008-08-27 23:31:01 -0400428 select STACKTRACE
Steven Rostedt4d7a0772009-02-18 22:06:18 -0500429 select KALLSYMS
Steven Rostedte5a81b62008-08-27 23:31:01 -0400430 help
Ingo Molnar4519d9e2008-10-14 14:15:43 +0200431 This special tracer records the maximum stack footprint of the
GeunSik Lim156f5a72009-06-02 15:01:37 +0900432 kernel and displays it in /sys/kernel/debug/tracing/stack_trace.
Ingo Molnar4519d9e2008-10-14 14:15:43 +0200433
434 This tracer works by hooking into every function call that the
435 kernel executes, and keeping a maximum stack depth value and
Steven Rostedtf38f1d22008-12-16 23:06:40 -0500436 stack-trace saved. If this is configured with DYNAMIC_FTRACE
437 then it will not have any overhead while the stack tracer
438 is disabled.
439
440 To enable the stack tracer on bootup, pass in 'stacktrace'
441 on the kernel command line.
442
443 The stack tracer can also be enabled or disabled via the
444 sysctl kernel.stack_tracer_enabled
Ingo Molnar4519d9e2008-10-14 14:15:43 +0200445
446 Say N if unsure.
Steven Rostedte5a81b62008-08-27 23:31:01 -0400447
Frederic Weisbecker2db270a2009-02-07 20:46:45 +0100448config BLK_DEV_IO_TRACE
Randy Dunlap40892362009-12-21 12:01:17 -0800449 bool "Support for tracing block IO actions"
Frederic Weisbecker2db270a2009-02-07 20:46:45 +0100450 depends on SYSFS
Ingo Molnar1dfba052009-02-09 12:06:54 +0100451 depends on BLOCK
Frederic Weisbecker2db270a2009-02-07 20:46:45 +0100452 select RELAY
453 select DEBUG_FS
454 select TRACEPOINTS
Steven Rostedt5e0a0932009-05-28 15:50:13 -0400455 select GENERIC_TRACER
Frederic Weisbecker2db270a2009-02-07 20:46:45 +0100456 select STACKTRACE
457 help
458 Say Y here if you want to be able to trace the block layer actions
459 on a given queue. Tracing allows you to see any traffic happening
460 on a block device queue. For more information (and the userspace
461 support tools needed), fetch the blktrace tools from:
462
463 git://git.kernel.dk/blktrace.git
464
465 Tracing also is possible using the ftrace interface, e.g.:
466
467 echo 1 > /sys/block/sda/sda1/trace/enable
468 echo blk > /sys/kernel/debug/tracing/current_tracer
469 cat /sys/kernel/debug/tracing/trace_pipe
470
471 If unsure, say N.
Frederic Weisbecker36994e52008-12-29 13:42:23 -0800472
Masami Hiramatsu77b44d12009-11-03 19:12:47 -0500473config KPROBE_EVENT
Masami Hiramatsu413d37d2009-08-13 16:35:11 -0400474 depends on KPROBES
Heiko Carstensf850c30c2010-02-10 17:25:17 +0100475 depends on HAVE_REGS_AND_STACK_ACCESS_API
Masami Hiramatsu77b44d12009-11-03 19:12:47 -0500476 bool "Enable kprobes-based dynamic events"
Masami Hiramatsu413d37d2009-08-13 16:35:11 -0400477 select TRACING
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530478 select PROBE_EVENTS
Masami Hiramatsu77b44d12009-11-03 19:12:47 -0500479 default y
Masami Hiramatsu413d37d2009-08-13 16:35:11 -0400480 help
Randy Dunlap40892362009-12-21 12:01:17 -0800481 This allows the user to add tracing events (similar to tracepoints)
482 on the fly via the ftrace interface. See
483 Documentation/trace/kprobetrace.txt for more details.
Masami Hiramatsu77b44d12009-11-03 19:12:47 -0500484
485 Those events can be inserted wherever kprobes can probe, and record
486 various register and memory values.
487
Randy Dunlap40892362009-12-21 12:01:17 -0800488 This option is also required by perf-probe subcommand of perf tools.
489 If you want to use perf tools, this option is strongly recommended.
Masami Hiramatsu413d37d2009-08-13 16:35:11 -0400490
Srikar Dronamrajuf3f096c2012-04-11 16:00:43 +0530491config UPROBE_EVENT
492 bool "Enable uprobes-based dynamic events"
493 depends on ARCH_SUPPORTS_UPROBES
494 depends on MMU
David A. Long09294e32014-03-07 10:32:22 -0500495 depends on PERF_EVENTS
Srikar Dronamrajuf3f096c2012-04-11 16:00:43 +0530496 select UPROBES
497 select PROBE_EVENTS
498 select TRACING
499 default n
500 help
501 This allows the user to add tracing events on top of userspace
502 dynamic events (similar to tracepoints) on the fly via the trace
503 events interface. Those events can be inserted wherever uprobes
504 can probe, and record various registers.
505 This option is required if you plan to use perf-probe subcommand
506 of perf tools on user space applications.
507
Ingo Molnare1abf2c2015-04-02 15:51:39 +0200508config BPF_EVENTS
509 depends on BPF_SYSCALL
Steven Rostedta31d82d2015-11-10 15:28:17 -0500510 depends on (KPROBE_EVENT || UPROBE_EVENT) && PERF_EVENTS
Ingo Molnare1abf2c2015-04-02 15:51:39 +0200511 bool
512 default y
513 help
514 This allows the user to attach BPF programs to kprobe events.
515
Srikar Dronamraju8ab83f52012-04-09 14:41:44 +0530516config PROBE_EVENTS
517 def_bool n
518
Steven Rostedt3d083392008-05-12 21:20:42 +0200519config DYNAMIC_FTRACE
Steven Rostedtdb050212013-02-27 21:48:09 -0500520 bool "enable/disable function tracing dynamically"
Steven Rostedt606576c2008-10-06 19:06:12 -0400521 depends on FUNCTION_TRACER
Steven Rostedt677aa9f2008-05-17 00:01:36 -0400522 depends on HAVE_DYNAMIC_FTRACE
Steven Rostedt3d083392008-05-12 21:20:42 +0200523 default y
524 help
Steven Rostedtdb050212013-02-27 21:48:09 -0500525 This option will modify all the calls to function tracing
526 dynamically (will patch them out of the binary image and
527 replace them with a No-Op instruction) on boot up. During
528 compile time, a table is made of all the locations that ftrace
529 can function trace, and this table is linked into the kernel
530 image. When this is enabled, functions can be individually
531 enabled, and the functions not enabled will not affect
532 performance of the system.
533
534 See the files in /sys/kernel/debug/tracing:
535 available_filter_functions
536 set_ftrace_filter
537 set_ftrace_notrace
Steven Rostedt3d083392008-05-12 21:20:42 +0200538
Randy Dunlap40892362009-12-21 12:01:17 -0800539 This way a CONFIG_FUNCTION_TRACER kernel is slightly larger, but
540 otherwise has native performance as long as no tracing is active.
Steven Rostedt3d083392008-05-12 21:20:42 +0200541
Masami Hiramatsu06aeaae2012-09-28 17:15:17 +0900542config DYNAMIC_FTRACE_WITH_REGS
543 def_bool y
544 depends on DYNAMIC_FTRACE
545 depends on HAVE_DYNAMIC_FTRACE_WITH_REGS
546
Steven Rostedtbac429f2009-03-20 12:50:56 -0400547config FUNCTION_PROFILER
548 bool "Kernel function profiler"
Steven Rostedt493762f2009-03-23 17:12:36 -0400549 depends on FUNCTION_TRACER
Steven Rostedtbac429f2009-03-20 12:50:56 -0400550 default n
551 help
Randy Dunlap40892362009-12-21 12:01:17 -0800552 This option enables the kernel function profiler. A file is created
553 in debugfs called function_profile_enabled which defaults to zero.
554 When a 1 is echoed into this file profiling begins, and when a
555 zero is entered, profiling stops. A "functions" file is created in
556 the trace_stats directory; this file shows the list of functions that
557 have been hit and their counters.
Steven Rostedtbac429f2009-03-20 12:50:56 -0400558
Randy Dunlap40892362009-12-21 12:01:17 -0800559 If in doubt, say N.
Steven Rostedtbac429f2009-03-20 12:50:56 -0400560
Matt Wagantallc481c782012-08-01 19:10:10 -0700561config CPU_FREQ_SWITCH_PROFILER
562 bool "CPU frequency switch time profiler"
563 select GENERIC_TRACER
564 help
565 This option enables the CPU frequency switch profiler. A file is
566 created in debugfs called "cpu_freq_switch_profile_enabled", which
567 defaults to zero. When a 1 is echoed into this file, profiling begins.
568 When a zero is echoed, profiling stops. A "cpu_freq_switch" file is
569 also created in the trace_stats directory; this file shows the
570 switches that have occurred and duration statistics.
571
572 If in doubt, say N.
573
Steven Rostedt8da38212008-08-14 15:45:07 -0400574config FTRACE_MCOUNT_RECORD
575 def_bool y
576 depends on DYNAMIC_FTRACE
577 depends on HAVE_FTRACE_MCOUNT_RECORD
578
Steven Rostedt60a11772008-05-12 21:20:44 +0200579config FTRACE_SELFTEST
580 bool
581
582config FTRACE_STARTUP_TEST
583 bool "Perform a startup test on ftrace"
Steven Rostedt5e0a0932009-05-28 15:50:13 -0400584 depends on GENERIC_TRACER
Steven Rostedt60a11772008-05-12 21:20:44 +0200585 select FTRACE_SELFTEST
586 help
587 This option performs a series of startup tests on ftrace. On bootup
588 a series of tests are made to verify that the tracer is
589 functioning properly. It will do tests on all the configured
590 tracers of ftrace.
Peter Zijlstra17d80fd2008-10-21 16:31:18 +0200591
Steven Rostedt1f5a6b42009-09-14 11:58:24 -0400592config EVENT_TRACE_TEST_SYSCALLS
593 bool "Run selftest on syscall events"
594 depends on FTRACE_STARTUP_TEST
595 help
596 This option will also enable testing every syscall event.
597 It only enables the event and disables it and runs various loads
598 with the event enabled. This adds a bit more time for kernel boot
599 up since it runs this on every system call defined.
600
601 TBD - enable a way to actually call the syscalls as we test their
602 events
603
Pekka Paalanenfe6f90e2009-01-03 21:23:51 +0200604config MMIOTRACE
605 bool "Memory mapped IO tracing"
Ingo Molnar40ada302009-03-05 21:19:55 +0100606 depends on HAVE_MMIOTRACE_SUPPORT && PCI
Steven Rostedt5e0a0932009-05-28 15:50:13 -0400607 select GENERIC_TRACER
Pekka Paalanenfe6f90e2009-01-03 21:23:51 +0200608 help
609 Mmiotrace traces Memory Mapped I/O access and is meant for
610 debugging and reverse engineering. It is called from the ioremap
611 implementation and works via page faults. Tracing is disabled by
612 default and can be enabled at run-time.
613
Li Zefan4d1f4372009-04-10 08:48:36 +0800614 See Documentation/trace/mmiotrace.txt.
Pekka Paalanenfe6f90e2009-01-03 21:23:51 +0200615 If you are not helping to develop drivers, say N.
616
Tom Zanussi08d43a52015-12-10 12:50:50 -0600617config TRACING_MAP
618 bool
619 depends on ARCH_HAVE_NMI_SAFE_CMPXCHG
Tom Zanussi08d43a52015-12-10 12:50:50 -0600620 help
621 tracing_map is a special-purpose lock-free map for tracing,
622 separated out as a stand-alone facility in order to allow it
623 to be shared between multiple tracers. It isn't meant to be
624 generally used outside of that context, and is normally
625 selected by tracers that use it.
626
Tom Zanussi7ef224d2016-03-03 12:54:42 -0600627config HIST_TRIGGERS
628 bool "Histogram triggers"
629 depends on ARCH_HAVE_NMI_SAFE_CMPXCHG
630 select TRACING_MAP
Tom Zanussi7ad8fb62016-07-03 08:51:34 -0500631 select TRACING
Tom Zanussi7ef224d2016-03-03 12:54:42 -0600632 default n
633 help
634 Hist triggers allow one or more arbitrary trace event fields
635 to be aggregated into hash tables and dumped to stdout by
636 reading a debugfs/tracefs file. They're useful for
637 gathering quick and dirty (though precise) summaries of
638 event activity as an initial guide for further investigation
639 using more advanced tools.
640
641 See Documentation/trace/events.txt.
642 If in doubt, say N.
643
Pekka Paalanenfe6f90e2009-01-03 21:23:51 +0200644config MMIOTRACE_TEST
645 tristate "Test module for mmiotrace"
646 depends on MMIOTRACE && m
647 help
648 This is a dumb module for testing mmiotrace. It is very dangerous
649 as it will write garbage to IO memory starting at a given address.
650 However, it should be safe to use on e.g. unused portion of VRAM.
651
652 Say N, unless you absolutely know what you are doing.
653
Steven Rostedt (Red Hat)81dc9f02014-05-29 22:49:07 -0400654config TRACEPOINT_BENCHMARK
655 bool "Add tracepoint that benchmarks tracepoints"
656 help
657 This option creates the tracepoint "benchmark:benchmark_event".
658 When the tracepoint is enabled, it kicks off a kernel thread that
659 goes into an infinite loop (calling cond_sched() to let other tasks
660 run), and calls the tracepoint. Each iteration will record the time
661 it took to write to the tracepoint and the next iteration that
662 data will be passed to the tracepoint itself. That is, the tracepoint
663 will report the time it took to do the previous tracepoint.
664 The string written to the tracepoint is a static string of 128 bytes
665 to keep the time the same. The initial string is simply a write of
666 "START". The second string records the cold cache time of the first
667 write which is not added to the rest of the calculations.
668
669 As it is a tight loop, it benchmarks as hot cache. That's fine because
670 we care most about hot paths that are probably in cache already.
671
672 An example of the output:
673
674 START
675 first=3672 [COLD CACHED]
676 last=632 first=3672 max=632 min=632 avg=316 std=446 std^2=199712
677 last=278 first=3672 max=632 min=278 avg=303 std=316 std^2=100337
678 last=277 first=3672 max=632 min=277 avg=296 std=258 std^2=67064
679 last=273 first=3672 max=632 min=273 avg=292 std=224 std^2=50411
680 last=273 first=3672 max=632 min=273 avg=288 std=200 std^2=40389
681 last=281 first=3672 max=632 min=273 avg=287 std=183 std^2=33666
682
683
Steven Rostedt5092dbc2009-05-05 22:47:18 -0400684config RING_BUFFER_BENCHMARK
685 tristate "Ring buffer benchmark stress tester"
686 depends on RING_BUFFER
687 help
Randy Dunlap40892362009-12-21 12:01:17 -0800688 This option creates a test to stress the ring buffer and benchmark it.
689 It creates its own ring buffer such that it will not interfere with
Steven Rostedt5092dbc2009-05-05 22:47:18 -0400690 any other users of the ring buffer (such as ftrace). It then creates
691 a producer and consumer that will run for 10 seconds and sleep for
692 10 seconds. Each interval it will print out the number of events
693 it recorded and give a rough estimate of how long each iteration took.
694
695 It does not disable interrupts or raise its priority, so it may be
696 affected by processes that are running.
697
Randy Dunlap40892362009-12-21 12:01:17 -0800698 If unsure, say N.
Steven Rostedt5092dbc2009-05-05 22:47:18 -0400699
Steven Rostedt (Red Hat)6c43e552013-03-15 11:32:53 -0400700config RING_BUFFER_STARTUP_TEST
701 bool "Ring buffer startup self test"
702 depends on RING_BUFFER
703 help
704 Run a simple self test on the ring buffer on boot up. Late in the
705 kernel boot sequence, the test will start that kicks off
706 a thread per cpu. Each thread will write various size events
707 into the ring buffer. Another thread is created to send IPIs
708 to each of the threads, where the IPI handler will also write
709 to the ring buffer, to test/stress the nesting ability.
710 If any anomalies are discovered, a warning will be displayed
711 and all ring buffers will be disabled.
712
713 The test runs for 10 seconds. This will slow your boot time
714 by at least 10 more seconds.
715
716 At the end of the test, statics and more checks are done.
717 It will output the stats of each per cpu buffer. What
718 was written, the sizes, what was read, what was lost, and
719 other similar details.
720
721 If unsure, say N
722
Steven Rostedt (Red Hat)98284132015-03-31 17:23:45 -0400723config TRACE_ENUM_MAP_FILE
724 bool "Show enum mappings for trace events"
725 depends on TRACING
726 help
727 The "print fmt" of the trace events will show the enum names instead
728 of their values. This can cause problems for user space tools that
729 use this string to parse the raw data as user space does not know
730 how to convert the string to its value.
731
732 To fix this, there's a special macro in the kernel that can be used
733 to convert the enum into its value. If this macro is used, then the
734 print fmt strings will have the enums converted to their values.
735
736 If something does not get converted properly, this option can be
737 used to show what enums the kernel tried to convert.
738
739 This option is for debugging the enum conversions. A file is created
740 in the tracing directory called "enum_map" that will show the enum
741 names matched with their values and what trace event system they
742 belong too.
743
744 Normally, the mapping of the strings to values will be freed after
745 boot up or module load. With this option, they will not be freed, as
746 they are needed for the "enum_map" file. Enabling this option will
747 increase the memory footprint of the running kernel.
748
749 If unsure, say N
750
Tal Shorerddd70282015-08-01 15:27:58 +0300751config TRACING_EVENTS_GPIO
752 bool "Trace gpio events"
753 depends on GPIOLIB
754 default y
755 help
756 Enable tracing events for gpio subsystem
757
Steven Rostedt4ed9f072009-04-20 10:47:36 -0400758endif # FTRACE
Ingo Molnar40ada302009-03-05 21:19:55 +0100759
760endif # TRACING_SUPPORT
761