xref: /linux/kernel/trace/Kconfig (revision 61778cd70c1dcef082e5ee6781c7c0c4d7d5b576)
1ec8f24b7SThomas Gleixner# SPDX-License-Identifier: GPL-2.0-only
216444a8aSArnaldo Carvalho de Melo#
3606576ceSSteven Rostedt# Architectures that offer an FUNCTION_TRACER implementation should
4606576ceSSteven Rostedt#  select HAVE_FUNCTION_TRACER:
516444a8aSArnaldo Carvalho de Melo#
62a3a4f66SFrédéric Weisbecker
78d26487fSTörök Edwinconfig USER_STACKTRACE_SUPPORT
88d26487fSTörök Edwin	bool
98d26487fSTörök Edwin
102a3a4f66SFrédéric Weisbeckerconfig NOP_TRACER
112a3a4f66SFrédéric Weisbecker	bool
122a3a4f66SFrédéric Weisbecker
1378d904b4SSteven Rostedtconfig HAVE_FTRACE_NMI_ENTER
1478d904b4SSteven Rostedt	bool
15555f386cSMike Frysinger	help
165fb94e9cSMauro Carvalho Chehab	  See Documentation/trace/ftrace-design.rst
1778d904b4SSteven Rostedt
18606576ceSSteven Rostedtconfig HAVE_FUNCTION_TRACER
1916444a8aSArnaldo Carvalho de Melo	bool
20555f386cSMike Frysinger	help
215fb94e9cSMauro Carvalho Chehab	  See Documentation/trace/ftrace-design.rst
22bc0c38d1SSteven Rostedt
23fb52607aSFrederic Weisbeckerconfig HAVE_FUNCTION_GRAPH_TRACER
2415e6cb36SFrederic Weisbecker	bool
25555f386cSMike Frysinger	help
265fb94e9cSMauro Carvalho Chehab	  See Documentation/trace/ftrace-design.rst
2715e6cb36SFrederic Weisbecker
28677aa9f7SSteven Rostedtconfig HAVE_DYNAMIC_FTRACE
29677aa9f7SSteven Rostedt	bool
30555f386cSMike Frysinger	help
315fb94e9cSMauro Carvalho Chehab	  See Documentation/trace/ftrace-design.rst
32677aa9f7SSteven Rostedt
3306aeaaeaSMasami Hiramatsuconfig HAVE_DYNAMIC_FTRACE_WITH_REGS
3406aeaaeaSMasami Hiramatsu	bool
3506aeaaeaSMasami Hiramatsu
36763e34e7SSteven Rostedt (VMware)config HAVE_DYNAMIC_FTRACE_WITH_DIRECT_CALLS
37763e34e7SSteven Rostedt (VMware)	bool
38763e34e7SSteven Rostedt (VMware)
398da3821bSSteven Rostedtconfig HAVE_FTRACE_MCOUNT_RECORD
408da3821bSSteven Rostedt	bool
41555f386cSMike Frysinger	help
425fb94e9cSMauro Carvalho Chehab	  See Documentation/trace/ftrace-design.rst
438da3821bSSteven Rostedt
4466700001SJosh Stoneconfig HAVE_SYSCALL_TRACEPOINTS
45ee08c6ecSFrederic Weisbecker	bool
46555f386cSMike Frysinger	help
475fb94e9cSMauro Carvalho Chehab	  See Documentation/trace/ftrace-design.rst
48ee08c6ecSFrederic Weisbecker
49a2546faeSSteven Rostedtconfig HAVE_FENTRY
50a2546faeSSteven Rostedt	bool
51a2546faeSSteven Rostedt	help
52a2546faeSSteven Rostedt	  Arch supports the gcc options -pg with -mfentry
53a2546faeSSteven Rostedt
542f4df001SVasily Gorbikconfig HAVE_NOP_MCOUNT
552f4df001SVasily Gorbik	bool
562f4df001SVasily Gorbik	help
572f4df001SVasily Gorbik	  Arch supports the gcc options -pg with -mrecord-mcount and -nop-mcount
582f4df001SVasily Gorbik
59cf4db259SSteven Rostedtconfig HAVE_C_RECORDMCOUNT
6072441cb1SSteven Rostedt	bool
6172441cb1SSteven Rostedt	help
6272441cb1SSteven Rostedt	  C version of recordmcount available?
6372441cb1SSteven Rostedt
64352ad25aSSteven Rostedtconfig TRACER_MAX_TRACE
65352ad25aSSteven Rostedt	bool
66352ad25aSSteven Rostedt
67ea632e9fSJosh Triplettconfig TRACE_CLOCK
68ea632e9fSJosh Triplett	bool
69ea632e9fSJosh Triplett
707a8e76a3SSteven Rostedtconfig RING_BUFFER
717a8e76a3SSteven Rostedt	bool
72ea632e9fSJosh Triplett	select TRACE_CLOCK
7322287688SSteven Rostedt (Red Hat)	select IRQ_WORK
747a8e76a3SSteven Rostedt
7578d904b4SSteven Rostedtconfig FTRACE_NMI_ENTER
7678d904b4SSteven Rostedt       bool
7778d904b4SSteven Rostedt       depends on HAVE_FTRACE_NMI_ENTER
7878d904b4SSteven Rostedt       default y
7978d904b4SSteven Rostedt
805f77a88bSTom Zanussiconfig EVENT_TRACING
81b11c53e1SZhaolei	select CONTEXT_SWITCH_TRACER
8260f1d5e3SMasami Hiramatsu	select GLOB
83b11c53e1SZhaolei	bool
84b11c53e1SZhaolei
85b11c53e1SZhaoleiconfig CONTEXT_SWITCH_TRACER
865f77a88bSTom Zanussi	bool
875f77a88bSTom Zanussi
8885bac32cSSteven Rostedtconfig RING_BUFFER_ALLOW_SWAP
8985bac32cSSteven Rostedt	bool
9085bac32cSSteven Rostedt	help
9185bac32cSSteven Rostedt	 Allow the use of ring_buffer_swap_cpu.
9285bac32cSSteven Rostedt	 Adds a very slight overhead to tracing when enabled.
9385bac32cSSteven Rostedt
94c3bc8fd6SJoel Fernandes (Google)config PREEMPTIRQ_TRACEPOINTS
95c3bc8fd6SJoel Fernandes (Google)	bool
96c3bc8fd6SJoel Fernandes (Google)	depends on TRACE_PREEMPT_TOGGLE || TRACE_IRQFLAGS
97c3bc8fd6SJoel Fernandes (Google)	select TRACING
98c3bc8fd6SJoel Fernandes (Google)	default y
99c3bc8fd6SJoel Fernandes (Google)	help
100c3bc8fd6SJoel Fernandes (Google)	  Create preempt/irq toggle tracepoints if needed, so that other parts
101c3bc8fd6SJoel Fernandes (Google)	  of the kernel can use them to generate or add hooks to them.
102c3bc8fd6SJoel Fernandes (Google)
1035e0a0939SSteven Rostedt# All tracer options should select GENERIC_TRACER. For those options that are
1045e0a0939SSteven Rostedt# enabled by all tracers (context switch and event tracer) they select TRACING.
1055e0a0939SSteven Rostedt# This allows those options to appear when no other tracer is selected. But the
1065e0a0939SSteven Rostedt# options do not appear when something else selects it. We need the two options
1075e0a0939SSteven Rostedt# GENERIC_TRACER and TRACING to avoid circular dependencies to accomplish the
10840892367SRandy Dunlap# hiding of the automatic options.
1095e0a0939SSteven Rostedt
110bc0c38d1SSteven Rostedtconfig TRACING
111bc0c38d1SSteven Rostedt	bool
1127a8e76a3SSteven Rostedt	select RING_BUFFER
113c2c80529SAl Viro	select STACKTRACE if STACKTRACE_SUPPORT
1145f87f112SIngo Molnar	select TRACEPOINTS
115f3384b28SSteven Rostedt	select NOP_TRACER
116769b0441SFrederic Weisbecker	select BINARY_PRINTF
1175f77a88bSTom Zanussi	select EVENT_TRACING
118ea632e9fSJosh Triplett	select TRACE_CLOCK
119bc0c38d1SSteven Rostedt
1205e0a0939SSteven Rostedtconfig GENERIC_TRACER
1215e0a0939SSteven Rostedt	bool
1225e0a0939SSteven Rostedt	select TRACING
1235e0a0939SSteven Rostedt
12440ada30fSIngo Molnar#
12540ada30fSIngo Molnar# Minimum requirements an architecture has to meet for us to
12640ada30fSIngo Molnar# be able to offer generic tracing facilities:
12740ada30fSIngo Molnar#
12840ada30fSIngo Molnarconfig TRACING_SUPPORT
12940ada30fSIngo Molnar	bool
1300ea5ee03SMichael Ellerman	depends on TRACE_IRQFLAGS_SUPPORT
13140ada30fSIngo Molnar	depends on STACKTRACE_SUPPORT
132422d3c7aSKOSAKI Motohiro	default y
13340ada30fSIngo Molnar
13440ada30fSIngo Molnarif TRACING_SUPPORT
13540ada30fSIngo Molnar
1364ed9f071SSteven Rostedtmenuconfig FTRACE
1374ed9f071SSteven Rostedt	bool "Tracers"
13865b77242SSteven Rostedt	default y if DEBUG_KERNEL
1394ed9f071SSteven Rostedt	help
1404ed9f071SSteven Rostedt	  Enable the kernel tracing infrastructure.
1414ed9f071SSteven Rostedt
1424ed9f071SSteven Rostedtif FTRACE
14317d80fd0SPeter Zijlstra
144606576ceSSteven Rostedtconfig FUNCTION_TRACER
1451b29b018SSteven Rostedt	bool "Kernel Function Tracer"
146606576ceSSteven Rostedt	depends on HAVE_FUNCTION_TRACER
1474d7a077cSSteven Rostedt	select KALLSYMS
1485e0a0939SSteven Rostedt	select GENERIC_TRACER
14935e8e302SSteven Rostedt	select CONTEXT_SWITCH_TRACER
15060f1d5e3SMasami Hiramatsu	select GLOB
15101b1d88bSThomas Gleixner	select TASKS_RCU if PREEMPTION
1521b29b018SSteven Rostedt	help
1531b29b018SSteven Rostedt	  Enable the kernel to trace every kernel function. This is done
1541b29b018SSteven Rostedt	  by using a compiler feature to insert a small, 5-byte No-Operation
15540892367SRandy Dunlap	  instruction at the beginning of every kernel function, which NOP
1561b29b018SSteven Rostedt	  sequence is then dynamically patched into a tracer call when
1571b29b018SSteven Rostedt	  tracing is enabled by the administrator. If it's runtime disabled
1581b29b018SSteven Rostedt	  (the bootup default), then the overhead of the instructions is very
1591b29b018SSteven Rostedt	  small and not measurable even in micro-benchmarks.
16035e8e302SSteven Rostedt
161fb52607aSFrederic Weisbeckerconfig FUNCTION_GRAPH_TRACER
162fb52607aSFrederic Weisbecker	bool "Kernel Function Graph Tracer"
163fb52607aSFrederic Weisbecker	depends on HAVE_FUNCTION_GRAPH_TRACER
16415e6cb36SFrederic Weisbecker	depends on FUNCTION_TRACER
165eb4a0378SSteven Rostedt	depends on !X86_32 || !CC_OPTIMIZE_FOR_SIZE
166764f3b95SIngo Molnar	default y
16715e6cb36SFrederic Weisbecker	help
168fb52607aSFrederic Weisbecker	  Enable the kernel to trace a function at both its return
169fb52607aSFrederic Weisbecker	  and its entry.
170692105b8SMatt LaPlante	  Its first purpose is to trace the duration of functions and
171692105b8SMatt LaPlante	  draw a call graph for each thread with some information like
172692105b8SMatt LaPlante	  the return value. This is done by setting the current return
173692105b8SMatt LaPlante	  address on the current task structure into a stack of calls.
17415e6cb36SFrederic Weisbecker
175*61778cd7SSteven Rostedt (VMware)config DYNAMIC_FTRACE
176*61778cd7SSteven Rostedt (VMware)	bool "enable/disable function tracing dynamically"
177*61778cd7SSteven Rostedt (VMware)	depends on FUNCTION_TRACER
178*61778cd7SSteven Rostedt (VMware)	depends on HAVE_DYNAMIC_FTRACE
179*61778cd7SSteven Rostedt (VMware)	default y
180*61778cd7SSteven Rostedt (VMware)	help
181*61778cd7SSteven Rostedt (VMware)	  This option will modify all the calls to function tracing
182*61778cd7SSteven Rostedt (VMware)	  dynamically (will patch them out of the binary image and
183*61778cd7SSteven Rostedt (VMware)	  replace them with a No-Op instruction) on boot up. During
184*61778cd7SSteven Rostedt (VMware)	  compile time, a table is made of all the locations that ftrace
185*61778cd7SSteven Rostedt (VMware)	  can function trace, and this table is linked into the kernel
186*61778cd7SSteven Rostedt (VMware)	  image. When this is enabled, functions can be individually
187*61778cd7SSteven Rostedt (VMware)	  enabled, and the functions not enabled will not affect
188*61778cd7SSteven Rostedt (VMware)	  performance of the system.
189*61778cd7SSteven Rostedt (VMware)
190*61778cd7SSteven Rostedt (VMware)	  See the files in /sys/kernel/debug/tracing:
191*61778cd7SSteven Rostedt (VMware)	    available_filter_functions
192*61778cd7SSteven Rostedt (VMware)	    set_ftrace_filter
193*61778cd7SSteven Rostedt (VMware)	    set_ftrace_notrace
194*61778cd7SSteven Rostedt (VMware)
195*61778cd7SSteven Rostedt (VMware)	  This way a CONFIG_FUNCTION_TRACER kernel is slightly larger, but
196*61778cd7SSteven Rostedt (VMware)	  otherwise has native performance as long as no tracing is active.
197*61778cd7SSteven Rostedt (VMware)
198*61778cd7SSteven Rostedt (VMware)config DYNAMIC_FTRACE_WITH_REGS
199*61778cd7SSteven Rostedt (VMware)	def_bool y
200*61778cd7SSteven Rostedt (VMware)	depends on DYNAMIC_FTRACE
201*61778cd7SSteven Rostedt (VMware)	depends on HAVE_DYNAMIC_FTRACE_WITH_REGS
202*61778cd7SSteven Rostedt (VMware)
203*61778cd7SSteven Rostedt (VMware)config DYNAMIC_FTRACE_WITH_DIRECT_CALLS
204*61778cd7SSteven Rostedt (VMware)	def_bool y
205*61778cd7SSteven Rostedt (VMware)	depends on DYNAMIC_FTRACE
206*61778cd7SSteven Rostedt (VMware)	depends on HAVE_DYNAMIC_FTRACE_WITH_DIRECT_CALLS
207*61778cd7SSteven Rostedt (VMware)
208*61778cd7SSteven Rostedt (VMware)config FUNCTION_PROFILER
209*61778cd7SSteven Rostedt (VMware)	bool "Kernel function profiler"
210*61778cd7SSteven Rostedt (VMware)	depends on FUNCTION_TRACER
211*61778cd7SSteven Rostedt (VMware)	default n
212*61778cd7SSteven Rostedt (VMware)	help
213*61778cd7SSteven Rostedt (VMware)	  This option enables the kernel function profiler. A file is created
214*61778cd7SSteven Rostedt (VMware)	  in debugfs called function_profile_enabled which defaults to zero.
215*61778cd7SSteven Rostedt (VMware)	  When a 1 is echoed into this file profiling begins, and when a
216*61778cd7SSteven Rostedt (VMware)	  zero is entered, profiling stops. A "functions" file is created in
217*61778cd7SSteven Rostedt (VMware)	  the trace_stat directory; this file shows the list of functions that
218*61778cd7SSteven Rostedt (VMware)	  have been hit and their counters.
219*61778cd7SSteven Rostedt (VMware)
220*61778cd7SSteven Rostedt (VMware)	  If in doubt, say N.
221*61778cd7SSteven Rostedt (VMware)
222*61778cd7SSteven Rostedt (VMware)config STACK_TRACER
223*61778cd7SSteven Rostedt (VMware)	bool "Trace max stack"
224*61778cd7SSteven Rostedt (VMware)	depends on HAVE_FUNCTION_TRACER
225*61778cd7SSteven Rostedt (VMware)	select FUNCTION_TRACER
226*61778cd7SSteven Rostedt (VMware)	select STACKTRACE
227*61778cd7SSteven Rostedt (VMware)	select KALLSYMS
228*61778cd7SSteven Rostedt (VMware)	help
229*61778cd7SSteven Rostedt (VMware)	  This special tracer records the maximum stack footprint of the
230*61778cd7SSteven Rostedt (VMware)	  kernel and displays it in /sys/kernel/debug/tracing/stack_trace.
231*61778cd7SSteven Rostedt (VMware)
232*61778cd7SSteven Rostedt (VMware)	  This tracer works by hooking into every function call that the
233*61778cd7SSteven Rostedt (VMware)	  kernel executes, and keeping a maximum stack depth value and
234*61778cd7SSteven Rostedt (VMware)	  stack-trace saved.  If this is configured with DYNAMIC_FTRACE
235*61778cd7SSteven Rostedt (VMware)	  then it will not have any overhead while the stack tracer
236*61778cd7SSteven Rostedt (VMware)	  is disabled.
237*61778cd7SSteven Rostedt (VMware)
238*61778cd7SSteven Rostedt (VMware)	  To enable the stack tracer on bootup, pass in 'stacktrace'
239*61778cd7SSteven Rostedt (VMware)	  on the kernel command line.
240*61778cd7SSteven Rostedt (VMware)
241*61778cd7SSteven Rostedt (VMware)	  The stack tracer can also be enabled or disabled via the
242*61778cd7SSteven Rostedt (VMware)	  sysctl kernel.stack_tracer_enabled
243*61778cd7SSteven Rostedt (VMware)
244*61778cd7SSteven Rostedt (VMware)	  Say N if unsure.
245*61778cd7SSteven Rostedt (VMware)
246c3bc8fd6SJoel Fernandes (Google)config TRACE_PREEMPT_TOGGLE
247c3bc8fd6SJoel Fernandes (Google)	bool
248c3bc8fd6SJoel Fernandes (Google)	help
249c3bc8fd6SJoel Fernandes (Google)	  Enables hooks which will be called when preemption is first disabled,
250c3bc8fd6SJoel Fernandes (Google)	  and last enabled.
251bac429f0SSteven Rostedt
252d5915816SJoel Fernandesconfig PREEMPTIRQ_EVENTS
253d5915816SJoel Fernandes	bool "Enable trace events for preempt and irq disable/enable"
254d5915816SJoel Fernandes	select TRACE_IRQFLAGS
25530c93704SThomas Gleixner	select TRACE_PREEMPT_TOGGLE if PREEMPTION
256c3bc8fd6SJoel Fernandes (Google)	select GENERIC_TRACER
257d5915816SJoel Fernandes	default n
258d5915816SJoel Fernandes	help
259d5915816SJoel Fernandes	  Enable tracing of disable and enable events for preemption and irqs.
260d5915816SJoel Fernandes
26181d68a96SSteven Rostedtconfig IRQSOFF_TRACER
26281d68a96SSteven Rostedt	bool "Interrupts-off Latency Tracer"
26381d68a96SSteven Rostedt	default n
26481d68a96SSteven Rostedt	depends on TRACE_IRQFLAGS_SUPPORT
265592913ecSJohn Stultz	depends on !ARCH_USES_GETTIMEOFFSET
26681d68a96SSteven Rostedt	select TRACE_IRQFLAGS
2675e0a0939SSteven Rostedt	select GENERIC_TRACER
26881d68a96SSteven Rostedt	select TRACER_MAX_TRACE
26985bac32cSSteven Rostedt	select RING_BUFFER_ALLOW_SWAP
27022cffc2bSSteven Rostedt (Red Hat)	select TRACER_SNAPSHOT
2710b85ffc2SSteven Rostedt (Red Hat)	select TRACER_SNAPSHOT_PER_CPU_SWAP
27281d68a96SSteven Rostedt	help
27381d68a96SSteven Rostedt	  This option measures the time spent in irqs-off critical
27481d68a96SSteven Rostedt	  sections, with microsecond accuracy.
27581d68a96SSteven Rostedt
27681d68a96SSteven Rostedt	  The default measurement method is a maximum search, which is
27781d68a96SSteven Rostedt	  disabled by default and can be runtime (re-)started
27881d68a96SSteven Rostedt	  via:
27981d68a96SSteven Rostedt
280156f5a78SGeunSik Lim	      echo 0 > /sys/kernel/debug/tracing/tracing_max_latency
28181d68a96SSteven Rostedt
28240892367SRandy Dunlap	  (Note that kernel size and overhead increase with this option
2836cd8a4bbSSteven Rostedt	  enabled. This option and the preempt-off timing option can be
2846cd8a4bbSSteven Rostedt	  used together or separately.)
2856cd8a4bbSSteven Rostedt
2866cd8a4bbSSteven Rostedtconfig PREEMPT_TRACER
2876cd8a4bbSSteven Rostedt	bool "Preemption-off Latency Tracer"
2886cd8a4bbSSteven Rostedt	default n
289592913ecSJohn Stultz	depends on !ARCH_USES_GETTIMEOFFSET
29030c93704SThomas Gleixner	depends on PREEMPTION
2915e0a0939SSteven Rostedt	select GENERIC_TRACER
2926cd8a4bbSSteven Rostedt	select TRACER_MAX_TRACE
29385bac32cSSteven Rostedt	select RING_BUFFER_ALLOW_SWAP
29422cffc2bSSteven Rostedt (Red Hat)	select TRACER_SNAPSHOT
2950b85ffc2SSteven Rostedt (Red Hat)	select TRACER_SNAPSHOT_PER_CPU_SWAP
296c3bc8fd6SJoel Fernandes (Google)	select TRACE_PREEMPT_TOGGLE
2976cd8a4bbSSteven Rostedt	help
29840892367SRandy Dunlap	  This option measures the time spent in preemption-off critical
2996cd8a4bbSSteven Rostedt	  sections, with microsecond accuracy.
3006cd8a4bbSSteven Rostedt
3016cd8a4bbSSteven Rostedt	  The default measurement method is a maximum search, which is
3026cd8a4bbSSteven Rostedt	  disabled by default and can be runtime (re-)started
3036cd8a4bbSSteven Rostedt	  via:
3046cd8a4bbSSteven Rostedt
305156f5a78SGeunSik Lim	      echo 0 > /sys/kernel/debug/tracing/tracing_max_latency
3066cd8a4bbSSteven Rostedt
30740892367SRandy Dunlap	  (Note that kernel size and overhead increase with this option
3086cd8a4bbSSteven Rostedt	  enabled. This option and the irqs-off timing option can be
3096cd8a4bbSSteven Rostedt	  used together or separately.)
3106cd8a4bbSSteven Rostedt
311352ad25aSSteven Rostedtconfig SCHED_TRACER
312352ad25aSSteven Rostedt	bool "Scheduling Latency Tracer"
3135e0a0939SSteven Rostedt	select GENERIC_TRACER
314352ad25aSSteven Rostedt	select CONTEXT_SWITCH_TRACER
315352ad25aSSteven Rostedt	select TRACER_MAX_TRACE
31622cffc2bSSteven Rostedt (Red Hat)	select TRACER_SNAPSHOT
317352ad25aSSteven Rostedt	help
318352ad25aSSteven Rostedt	  This tracer tracks the latency of the highest priority task
319352ad25aSSteven Rostedt	  to be scheduled in, starting from the point it has woken up.
320352ad25aSSteven Rostedt
321e7c15cd8SSteven Rostedt (Red Hat)config HWLAT_TRACER
322e7c15cd8SSteven Rostedt (Red Hat)	bool "Tracer to detect hardware latencies (like SMIs)"
323e7c15cd8SSteven Rostedt (Red Hat)	select GENERIC_TRACER
324e7c15cd8SSteven Rostedt (Red Hat)	help
325e7c15cd8SSteven Rostedt (Red Hat)	 This tracer, when enabled will create one or more kernel threads,
326c5c1ea75SJesper Dangaard Brouer	 depending on what the cpumask file is set to, which each thread
327e7c15cd8SSteven Rostedt (Red Hat)	 spinning in a loop looking for interruptions caused by
328e7c15cd8SSteven Rostedt (Red Hat)	 something other than the kernel. For example, if a
329e7c15cd8SSteven Rostedt (Red Hat)	 System Management Interrupt (SMI) takes a noticeable amount of
330e7c15cd8SSteven Rostedt (Red Hat)	 time, this tracer will detect it. This is useful for testing
331e7c15cd8SSteven Rostedt (Red Hat)	 if a system is reliable for Real Time tasks.
332e7c15cd8SSteven Rostedt (Red Hat)
333e7c15cd8SSteven Rostedt (Red Hat)	 Some files are created in the tracing directory when this
334e7c15cd8SSteven Rostedt (Red Hat)	 is enabled:
335e7c15cd8SSteven Rostedt (Red Hat)
336e7c15cd8SSteven Rostedt (Red Hat)	   hwlat_detector/width   - time in usecs for how long to spin for
337e7c15cd8SSteven Rostedt (Red Hat)	   hwlat_detector/window  - time in usecs between the start of each
338e7c15cd8SSteven Rostedt (Red Hat)				     iteration
339e7c15cd8SSteven Rostedt (Red Hat)
340e7c15cd8SSteven Rostedt (Red Hat)	 A kernel thread is created that will spin with interrupts disabled
341c5c1ea75SJesper Dangaard Brouer	 for "width" microseconds in every "window" cycle. It will not spin
342e7c15cd8SSteven Rostedt (Red Hat)	 for "window - width" microseconds, where the system can
343e7c15cd8SSteven Rostedt (Red Hat)	 continue to operate.
344e7c15cd8SSteven Rostedt (Red Hat)
345e7c15cd8SSteven Rostedt (Red Hat)	 The output will appear in the trace and trace_pipe files.
346e7c15cd8SSteven Rostedt (Red Hat)
347e7c15cd8SSteven Rostedt (Red Hat)	 When the tracer is not running, it has no affect on the system,
348e7c15cd8SSteven Rostedt (Red Hat)	 but when it is running, it can cause the system to be
349e7c15cd8SSteven Rostedt (Red Hat)	 periodically non responsive. Do not run this tracer on a
350e7c15cd8SSteven Rostedt (Red Hat)	 production system.
351e7c15cd8SSteven Rostedt (Red Hat)
352e7c15cd8SSteven Rostedt (Red Hat)	 To enable this tracer, echo in "hwlat" into the current_tracer
353e7c15cd8SSteven Rostedt (Red Hat)	 file. Every time a latency is greater than tracing_thresh, it will
354e7c15cd8SSteven Rostedt (Red Hat)	 be recorded into the ring buffer.
355e7c15cd8SSteven Rostedt (Red Hat)
356897f17a6SSteven Rostedtconfig ENABLE_DEFAULT_TRACERS
357897f17a6SSteven Rostedt	bool "Trace process context switches and events"
3585e0a0939SSteven Rostedt	depends on !GENERIC_TRACER
359b77e38aaSSteven Rostedt	select TRACING
360b77e38aaSSteven Rostedt	help
36140892367SRandy Dunlap	  This tracer hooks to various trace points in the kernel,
362b77e38aaSSteven Rostedt	  allowing the user to pick and choose which trace point they
363897f17a6SSteven Rostedt	  want to trace. It also includes the sched_switch tracer plugin.
364a7abe97fSSteven Rostedt
365ee08c6ecSFrederic Weisbeckerconfig FTRACE_SYSCALLS
366ee08c6ecSFrederic Weisbecker	bool "Trace syscalls"
36766700001SJosh Stone	depends on HAVE_SYSCALL_TRACEPOINTS
3685e0a0939SSteven Rostedt	select GENERIC_TRACER
3690ea1c415SFrederic Weisbecker	select KALLSYMS
370ee08c6ecSFrederic Weisbecker	help
371ee08c6ecSFrederic Weisbecker	  Basic tracer to catch the syscall entry and exit events.
372ee08c6ecSFrederic Weisbecker
373debdd57fSHiraku Toyookaconfig TRACER_SNAPSHOT
374debdd57fSHiraku Toyooka	bool "Create a snapshot trace buffer"
375debdd57fSHiraku Toyooka	select TRACER_MAX_TRACE
376debdd57fSHiraku Toyooka	help
377debdd57fSHiraku Toyooka	  Allow tracing users to take snapshot of the current buffer using the
378debdd57fSHiraku Toyooka	  ftrace interface, e.g.:
379debdd57fSHiraku Toyooka
380debdd57fSHiraku Toyooka	      echo 1 > /sys/kernel/debug/tracing/snapshot
381debdd57fSHiraku Toyooka	      cat snapshot
382debdd57fSHiraku Toyooka
3830b85ffc2SSteven Rostedt (Red Hat)config TRACER_SNAPSHOT_PER_CPU_SWAP
3840b85ffc2SSteven Rostedt (Red Hat)	bool "Allow snapshot to swap per CPU"
3850b85ffc2SSteven Rostedt (Red Hat)	depends on TRACER_SNAPSHOT
3860b85ffc2SSteven Rostedt (Red Hat)	select RING_BUFFER_ALLOW_SWAP
3870b85ffc2SSteven Rostedt (Red Hat)	help
3880b85ffc2SSteven Rostedt (Red Hat)	  Allow doing a snapshot of a single CPU buffer instead of a
3890b85ffc2SSteven Rostedt (Red Hat)	  full swap (all buffers). If this is set, then the following is
3900b85ffc2SSteven Rostedt (Red Hat)	  allowed:
3910b85ffc2SSteven Rostedt (Red Hat)
3920b85ffc2SSteven Rostedt (Red Hat)	      echo 1 > /sys/kernel/debug/tracing/per_cpu/cpu2/snapshot
3930b85ffc2SSteven Rostedt (Red Hat)
3940b85ffc2SSteven Rostedt (Red Hat)	  After which, only the tracing buffer for CPU 2 was swapped with
3950b85ffc2SSteven Rostedt (Red Hat)	  the main tracing buffer, and the other CPU buffers remain the same.
3960b85ffc2SSteven Rostedt (Red Hat)
3970b85ffc2SSteven Rostedt (Red Hat)	  When this is enabled, this adds a little more overhead to the
3980b85ffc2SSteven Rostedt (Red Hat)	  trace recording, as it needs to add some checks to synchronize
3990b85ffc2SSteven Rostedt (Red Hat)	  recording with swaps. But this does not affect the performance
4000b85ffc2SSteven Rostedt (Red Hat)	  of the overall system. This is enabled by default when the preempt
4010b85ffc2SSteven Rostedt (Red Hat)	  or irq latency tracers are enabled, as those need to swap as well
4020b85ffc2SSteven Rostedt (Red Hat)	  and already adds the overhead (plus a lot more).
4030b85ffc2SSteven Rostedt (Red Hat)
4042ed84eebSSteven Rostedtconfig TRACE_BRANCH_PROFILING
4059ae5b879SSteven Rostedt	bool
4065e0a0939SSteven Rostedt	select GENERIC_TRACER
4079ae5b879SSteven Rostedt
4089ae5b879SSteven Rostedtchoice
4099ae5b879SSteven Rostedt	prompt "Branch Profiling"
4109ae5b879SSteven Rostedt	default BRANCH_PROFILE_NONE
4119ae5b879SSteven Rostedt	help
4129ae5b879SSteven Rostedt	 The branch profiling is a software profiler. It will add hooks
4139ae5b879SSteven Rostedt	 into the C conditionals to test which path a branch takes.
4149ae5b879SSteven Rostedt
4159ae5b879SSteven Rostedt	 The likely/unlikely profiler only looks at the conditions that
4169ae5b879SSteven Rostedt	 are annotated with a likely or unlikely macro.
4179ae5b879SSteven Rostedt
41840892367SRandy Dunlap	 The "all branch" profiler will profile every if-statement in the
4199ae5b879SSteven Rostedt	 kernel. This profiler will also enable the likely/unlikely
42040892367SRandy Dunlap	 profiler.
4219ae5b879SSteven Rostedt
42240892367SRandy Dunlap	 Either of the above profilers adds a bit of overhead to the system.
42340892367SRandy Dunlap	 If unsure, choose "No branch profiling".
4249ae5b879SSteven Rostedt
4259ae5b879SSteven Rostedtconfig BRANCH_PROFILE_NONE
4269ae5b879SSteven Rostedt	bool "No branch profiling"
4279ae5b879SSteven Rostedt	help
4289ae5b879SSteven Rostedt	  No branch profiling. Branch profiling adds a bit of overhead.
4299ae5b879SSteven Rostedt	  Only enable it if you want to analyse the branching behavior.
4309ae5b879SSteven Rostedt	  Otherwise keep it disabled.
4319ae5b879SSteven Rostedt
4329ae5b879SSteven Rostedtconfig PROFILE_ANNOTATED_BRANCHES
4339ae5b879SSteven Rostedt	bool "Trace likely/unlikely profiler"
4349ae5b879SSteven Rostedt	select TRACE_BRANCH_PROFILING
4351f0d69a9SSteven Rostedt	help
43659bf8964SMasanari Iida	  This tracer profiles all likely and unlikely macros
4371f0d69a9SSteven Rostedt	  in the kernel. It will display the results in:
4381f0d69a9SSteven Rostedt
43913e5befaSDavid Rientjes	  /sys/kernel/debug/tracing/trace_stat/branch_annotated
4401f0d69a9SSteven Rostedt
44140892367SRandy Dunlap	  Note: this will add a significant overhead; only turn this
4421f0d69a9SSteven Rostedt	  on if you need to profile the system's use of these macros.
4431f0d69a9SSteven Rostedt
4442bcd521aSSteven Rostedtconfig PROFILE_ALL_BRANCHES
44568e76e03SRandy Dunlap	bool "Profile all if conditionals" if !FORTIFY_SOURCE
4469ae5b879SSteven Rostedt	select TRACE_BRANCH_PROFILING
447b303c6dfSMasahiro Yamada	imply CC_DISABLE_WARN_MAYBE_UNINITIALIZED  # avoid false positives
4482bcd521aSSteven Rostedt	help
4492bcd521aSSteven Rostedt	  This tracer profiles all branch conditions. Every if ()
4502bcd521aSSteven Rostedt	  taken in the kernel is recorded whether it hit or miss.
4512bcd521aSSteven Rostedt	  The results will be displayed in:
4522bcd521aSSteven Rostedt
45313e5befaSDavid Rientjes	  /sys/kernel/debug/tracing/trace_stat/branch_all
4542bcd521aSSteven Rostedt
4559ae5b879SSteven Rostedt	  This option also enables the likely/unlikely profiler.
4569ae5b879SSteven Rostedt
4572bcd521aSSteven Rostedt	  This configuration, when enabled, will impose a great overhead
4582bcd521aSSteven Rostedt	  on the system. This should only be enabled when the system
45940892367SRandy Dunlap	  is to be analyzed in much detail.
4609ae5b879SSteven Rostedtendchoice
4612bcd521aSSteven Rostedt
4622ed84eebSSteven Rostedtconfig TRACING_BRANCHES
46352f232cbSSteven Rostedt	bool
46452f232cbSSteven Rostedt	help
46552f232cbSSteven Rostedt	  Selected by tracers that will trace the likely and unlikely
46652f232cbSSteven Rostedt	  conditions. This prevents the tracers themselves from being
46752f232cbSSteven Rostedt	  profiled. Profiling the tracing infrastructure can only happen
46852f232cbSSteven Rostedt	  when the likelys and unlikelys are not being traced.
46952f232cbSSteven Rostedt
4702ed84eebSSteven Rostedtconfig BRANCH_TRACER
47152f232cbSSteven Rostedt	bool "Trace likely/unlikely instances"
4722ed84eebSSteven Rostedt	depends on TRACE_BRANCH_PROFILING
4732ed84eebSSteven Rostedt	select TRACING_BRANCHES
47452f232cbSSteven Rostedt	help
47552f232cbSSteven Rostedt	  This traces the events of likely and unlikely condition
47652f232cbSSteven Rostedt	  calls in the kernel.  The difference between this and the
47752f232cbSSteven Rostedt	  "Trace likely/unlikely profiler" is that this is not a
47852f232cbSSteven Rostedt	  histogram of the callers, but actually places the calling
47952f232cbSSteven Rostedt	  events into a running trace buffer to see when and where the
48052f232cbSSteven Rostedt	  events happened, as well as their results.
48152f232cbSSteven Rostedt
48252f232cbSSteven Rostedt	  Say N if unsure.
48352f232cbSSteven Rostedt
4842db270a8SFrederic Weisbeckerconfig BLK_DEV_IO_TRACE
48540892367SRandy Dunlap	bool "Support for tracing block IO actions"
4862db270a8SFrederic Weisbecker	depends on SYSFS
4871dfba05dSIngo Molnar	depends on BLOCK
4882db270a8SFrederic Weisbecker	select RELAY
4892db270a8SFrederic Weisbecker	select DEBUG_FS
4902db270a8SFrederic Weisbecker	select TRACEPOINTS
4915e0a0939SSteven Rostedt	select GENERIC_TRACER
4922db270a8SFrederic Weisbecker	select STACKTRACE
4932db270a8SFrederic Weisbecker	help
4942db270a8SFrederic Weisbecker	  Say Y here if you want to be able to trace the block layer actions
4952db270a8SFrederic Weisbecker	  on a given queue. Tracing allows you to see any traffic happening
4962db270a8SFrederic Weisbecker	  on a block device queue. For more information (and the userspace
4972db270a8SFrederic Weisbecker	  support tools needed), fetch the blktrace tools from:
4982db270a8SFrederic Weisbecker
4992db270a8SFrederic Weisbecker	  git://git.kernel.dk/blktrace.git
5002db270a8SFrederic Weisbecker
5012db270a8SFrederic Weisbecker	  Tracing also is possible using the ftrace interface, e.g.:
5022db270a8SFrederic Weisbecker
5032db270a8SFrederic Weisbecker	    echo 1 > /sys/block/sda/sda1/trace/enable
5042db270a8SFrederic Weisbecker	    echo blk > /sys/kernel/debug/tracing/current_tracer
5052db270a8SFrederic Weisbecker	    cat /sys/kernel/debug/tracing/trace_pipe
5062db270a8SFrederic Weisbecker
5072db270a8SFrederic Weisbecker	  If unsure, say N.
50836994e58SFrederic Weisbecker
5096b0b7551SAnton Blanchardconfig KPROBE_EVENTS
510413d37d1SMasami Hiramatsu	depends on KPROBES
511f850c30cSHeiko Carstens	depends on HAVE_REGS_AND_STACK_ACCESS_API
51277b44d1bSMasami Hiramatsu	bool "Enable kprobes-based dynamic events"
513413d37d1SMasami Hiramatsu	select TRACING
5148ab83f56SSrikar Dronamraju	select PROBE_EVENTS
5156212dd29SMasami Hiramatsu	select DYNAMIC_EVENTS
51677b44d1bSMasami Hiramatsu	default y
517413d37d1SMasami Hiramatsu	help
51840892367SRandy Dunlap	  This allows the user to add tracing events (similar to tracepoints)
51940892367SRandy Dunlap	  on the fly via the ftrace interface. See
5205fb94e9cSMauro Carvalho Chehab	  Documentation/trace/kprobetrace.rst for more details.
52177b44d1bSMasami Hiramatsu
52277b44d1bSMasami Hiramatsu	  Those events can be inserted wherever kprobes can probe, and record
52377b44d1bSMasami Hiramatsu	  various register and memory values.
52477b44d1bSMasami Hiramatsu
52540892367SRandy Dunlap	  This option is also required by perf-probe subcommand of perf tools.
52640892367SRandy Dunlap	  If you want to use perf tools, this option is strongly recommended.
527413d37d1SMasami Hiramatsu
52845408c4fSMasami Hiramatsuconfig KPROBE_EVENTS_ON_NOTRACE
52945408c4fSMasami Hiramatsu	bool "Do NOT protect notrace function from kprobe events"
53045408c4fSMasami Hiramatsu	depends on KPROBE_EVENTS
53145408c4fSMasami Hiramatsu	depends on KPROBES_ON_FTRACE
53245408c4fSMasami Hiramatsu	default n
53345408c4fSMasami Hiramatsu	help
53445408c4fSMasami Hiramatsu	  This is only for the developers who want to debug ftrace itself
53545408c4fSMasami Hiramatsu	  using kprobe events.
53645408c4fSMasami Hiramatsu
53745408c4fSMasami Hiramatsu	  If kprobes can use ftrace instead of breakpoint, ftrace related
53845408c4fSMasami Hiramatsu	  functions are protected from kprobe-events to prevent an infinit
53945408c4fSMasami Hiramatsu	  recursion or any unexpected execution path which leads to a kernel
54045408c4fSMasami Hiramatsu	  crash.
54145408c4fSMasami Hiramatsu
54245408c4fSMasami Hiramatsu	  This option disables such protection and allows you to put kprobe
54345408c4fSMasami Hiramatsu	  events on ftrace functions for debugging ftrace by itself.
54445408c4fSMasami Hiramatsu	  Note that this might let you shoot yourself in the foot.
54545408c4fSMasami Hiramatsu
54645408c4fSMasami Hiramatsu	  If unsure, say N.
54745408c4fSMasami Hiramatsu
5486b0b7551SAnton Blanchardconfig UPROBE_EVENTS
549f3f096cfSSrikar Dronamraju	bool "Enable uprobes-based dynamic events"
550f3f096cfSSrikar Dronamraju	depends on ARCH_SUPPORTS_UPROBES
551f3f096cfSSrikar Dronamraju	depends on MMU
55209294e31SDavid A. Long	depends on PERF_EVENTS
553f3f096cfSSrikar Dronamraju	select UPROBES
554f3f096cfSSrikar Dronamraju	select PROBE_EVENTS
5550597c49cSMasami Hiramatsu	select DYNAMIC_EVENTS
556f3f096cfSSrikar Dronamraju	select TRACING
55761f35d75SArnaldo Carvalho de Melo	default y
558f3f096cfSSrikar Dronamraju	help
559f3f096cfSSrikar Dronamraju	  This allows the user to add tracing events on top of userspace
560f3f096cfSSrikar Dronamraju	  dynamic events (similar to tracepoints) on the fly via the trace
561f3f096cfSSrikar Dronamraju	  events interface. Those events can be inserted wherever uprobes
562f3f096cfSSrikar Dronamraju	  can probe, and record various registers.
563f3f096cfSSrikar Dronamraju	  This option is required if you plan to use perf-probe subcommand
564f3f096cfSSrikar Dronamraju	  of perf tools on user space applications.
565f3f096cfSSrikar Dronamraju
566e1abf2ccSIngo Molnarconfig BPF_EVENTS
567e1abf2ccSIngo Molnar	depends on BPF_SYSCALL
5686b0b7551SAnton Blanchard	depends on (KPROBE_EVENTS || UPROBE_EVENTS) && PERF_EVENTS
569e1abf2ccSIngo Molnar	bool
570e1abf2ccSIngo Molnar	default y
571e1abf2ccSIngo Molnar	help
5725cbd22c1SPeter Wu	  This allows the user to attach BPF programs to kprobe, uprobe, and
5735cbd22c1SPeter Wu	  tracepoint events.
574e1abf2ccSIngo Molnar
5755448d44cSMasami Hiramatsuconfig DYNAMIC_EVENTS
5765448d44cSMasami Hiramatsu	def_bool n
5775448d44cSMasami Hiramatsu
5788ab83f56SSrikar Dronamrajuconfig PROBE_EVENTS
5798ab83f56SSrikar Dronamraju	def_bool n
5808ab83f56SSrikar Dronamraju
5819802d865SJosef Bacikconfig BPF_KPROBE_OVERRIDE
5829802d865SJosef Bacik	bool "Enable BPF programs to override a kprobed function"
5839802d865SJosef Bacik	depends on BPF_EVENTS
584540adea3SMasami Hiramatsu	depends on FUNCTION_ERROR_INJECTION
5859802d865SJosef Bacik	default n
5869802d865SJosef Bacik	help
5879802d865SJosef Bacik	 Allows BPF to override the execution of a probed function and
5889802d865SJosef Bacik	 set a different return value.  This is used for error injection.
5899802d865SJosef Bacik
5908da3821bSSteven Rostedtconfig FTRACE_MCOUNT_RECORD
5918da3821bSSteven Rostedt	def_bool y
5928da3821bSSteven Rostedt	depends on DYNAMIC_FTRACE
5938da3821bSSteven Rostedt	depends on HAVE_FTRACE_MCOUNT_RECORD
5948da3821bSSteven Rostedt
59560a11774SSteven Rostedtconfig FTRACE_SELFTEST
59660a11774SSteven Rostedt	bool
59760a11774SSteven Rostedt
59860a11774SSteven Rostedtconfig FTRACE_STARTUP_TEST
59960a11774SSteven Rostedt	bool "Perform a startup test on ftrace"
6005e0a0939SSteven Rostedt	depends on GENERIC_TRACER
60160a11774SSteven Rostedt	select FTRACE_SELFTEST
60260a11774SSteven Rostedt	help
60360a11774SSteven Rostedt	  This option performs a series of startup tests on ftrace. On bootup
60460a11774SSteven Rostedt	  a series of tests are made to verify that the tracer is
60560a11774SSteven Rostedt	  functioning properly. It will do tests on all the configured
60660a11774SSteven Rostedt	  tracers of ftrace.
60717d80fd0SPeter Zijlstra
608b3015fe4SSteven Rostedt (VMware)config EVENT_TRACE_STARTUP_TEST
609b3015fe4SSteven Rostedt (VMware)	bool "Run selftest on trace events"
610b3015fe4SSteven Rostedt (VMware)	depends on FTRACE_STARTUP_TEST
611b3015fe4SSteven Rostedt (VMware)	default y
612b3015fe4SSteven Rostedt (VMware)	help
613b3015fe4SSteven Rostedt (VMware)	  This option performs a test on all trace events in the system.
614b3015fe4SSteven Rostedt (VMware)	  It basically just enables each event and runs some code that
615b3015fe4SSteven Rostedt (VMware)	  will trigger events (not necessarily the event it enables)
616b3015fe4SSteven Rostedt (VMware)	  This may take some time run as there are a lot of events.
617b3015fe4SSteven Rostedt (VMware)
6181f5a6b45SSteven Rostedtconfig EVENT_TRACE_TEST_SYSCALLS
6191f5a6b45SSteven Rostedt	bool "Run selftest on syscall events"
620b3015fe4SSteven Rostedt (VMware)	depends on EVENT_TRACE_STARTUP_TEST
6211f5a6b45SSteven Rostedt	help
6221f5a6b45SSteven Rostedt	 This option will also enable testing every syscall event.
6231f5a6b45SSteven Rostedt	 It only enables the event and disables it and runs various loads
6241f5a6b45SSteven Rostedt	 with the event enabled. This adds a bit more time for kernel boot
6251f5a6b45SSteven Rostedt	 up since it runs this on every system call defined.
6261f5a6b45SSteven Rostedt
6271f5a6b45SSteven Rostedt	 TBD - enable a way to actually call the syscalls as we test their
6281f5a6b45SSteven Rostedt	       events
6291f5a6b45SSteven Rostedt
630fe6f90e5SPekka Paalanenconfig MMIOTRACE
631fe6f90e5SPekka Paalanen	bool "Memory mapped IO tracing"
63240ada30fSIngo Molnar	depends on HAVE_MMIOTRACE_SUPPORT && PCI
6335e0a0939SSteven Rostedt	select GENERIC_TRACER
634fe6f90e5SPekka Paalanen	help
635fe6f90e5SPekka Paalanen	  Mmiotrace traces Memory Mapped I/O access and is meant for
636fe6f90e5SPekka Paalanen	  debugging and reverse engineering. It is called from the ioremap
637fe6f90e5SPekka Paalanen	  implementation and works via page faults. Tracing is disabled by
638fe6f90e5SPekka Paalanen	  default and can be enabled at run-time.
639fe6f90e5SPekka Paalanen
6405fb94e9cSMauro Carvalho Chehab	  See Documentation/trace/mmiotrace.rst.
641fe6f90e5SPekka Paalanen	  If you are not helping to develop drivers, say N.
642fe6f90e5SPekka Paalanen
64308d43a5fSTom Zanussiconfig TRACING_MAP
64408d43a5fSTom Zanussi	bool
64508d43a5fSTom Zanussi	depends on ARCH_HAVE_NMI_SAFE_CMPXCHG
64608d43a5fSTom Zanussi	help
64708d43a5fSTom Zanussi	  tracing_map is a special-purpose lock-free map for tracing,
64808d43a5fSTom Zanussi	  separated out as a stand-alone facility in order to allow it
64908d43a5fSTom Zanussi	  to be shared between multiple tracers.  It isn't meant to be
65008d43a5fSTom Zanussi	  generally used outside of that context, and is normally
65108d43a5fSTom Zanussi	  selected by tracers that use it.
65208d43a5fSTom Zanussi
6537ef224d1STom Zanussiconfig HIST_TRIGGERS
6547ef224d1STom Zanussi	bool "Histogram triggers"
6557ef224d1STom Zanussi	depends on ARCH_HAVE_NMI_SAFE_CMPXCHG
6567ef224d1STom Zanussi	select TRACING_MAP
6577ad8fb61STom Zanussi	select TRACING
6587bbab38dSMasami Hiramatsu	select DYNAMIC_EVENTS
6597ef224d1STom Zanussi	default n
6607ef224d1STom Zanussi	help
6617ef224d1STom Zanussi	  Hist triggers allow one or more arbitrary trace event fields
6627ef224d1STom Zanussi	  to be aggregated into hash tables and dumped to stdout by
6637ef224d1STom Zanussi	  reading a debugfs/tracefs file.  They're useful for
6647ef224d1STom Zanussi	  gathering quick and dirty (though precise) summaries of
6657ef224d1STom Zanussi	  event activity as an initial guide for further investigation
6667ef224d1STom Zanussi	  using more advanced tools.
6677ef224d1STom Zanussi
66889e270c1STom Zanussi	  Inter-event tracing of quantities such as latencies is also
66989e270c1STom Zanussi	  supported using hist triggers under this option.
67089e270c1STom Zanussi
671ea272257SMauro Carvalho Chehab	  See Documentation/trace/histogram.rst.
6727ef224d1STom Zanussi	  If in doubt, say N.
6737ef224d1STom Zanussi
6746c3edaf9SCong Wangconfig TRACE_EVENT_INJECT
6756c3edaf9SCong Wang	bool "Trace event injection"
6766c3edaf9SCong Wang	depends on TRACING
6776c3edaf9SCong Wang	help
6786c3edaf9SCong Wang	  Allow user-space to inject a specific trace event into the ring
6796c3edaf9SCong Wang	  buffer. This is mainly used for testing purpose.
6806c3edaf9SCong Wang
6816c3edaf9SCong Wang	  If unsure, say N.
6826c3edaf9SCong Wang
683fe6f90e5SPekka Paalanenconfig MMIOTRACE_TEST
684fe6f90e5SPekka Paalanen	tristate "Test module for mmiotrace"
685fe6f90e5SPekka Paalanen	depends on MMIOTRACE && m
686fe6f90e5SPekka Paalanen	help
687fe6f90e5SPekka Paalanen	  This is a dumb module for testing mmiotrace. It is very dangerous
688fe6f90e5SPekka Paalanen	  as it will write garbage to IO memory starting at a given address.
689fe6f90e5SPekka Paalanen	  However, it should be safe to use on e.g. unused portion of VRAM.
690fe6f90e5SPekka Paalanen
691fe6f90e5SPekka Paalanen	  Say N, unless you absolutely know what you are doing.
692fe6f90e5SPekka Paalanen
69381dc9f0eSSteven Rostedt (Red Hat)config TRACEPOINT_BENCHMARK
69481dc9f0eSSteven Rostedt (Red Hat)	bool "Add tracepoint that benchmarks tracepoints"
69581dc9f0eSSteven Rostedt (Red Hat)	help
69681dc9f0eSSteven Rostedt (Red Hat)	 This option creates the tracepoint "benchmark:benchmark_event".
69781dc9f0eSSteven Rostedt (Red Hat)	 When the tracepoint is enabled, it kicks off a kernel thread that
69881dc9f0eSSteven Rostedt (Red Hat)	 goes into an infinite loop (calling cond_sched() to let other tasks
69981dc9f0eSSteven Rostedt (Red Hat)	 run), and calls the tracepoint. Each iteration will record the time
70081dc9f0eSSteven Rostedt (Red Hat)	 it took to write to the tracepoint and the next iteration that
70181dc9f0eSSteven Rostedt (Red Hat)	 data will be passed to the tracepoint itself. That is, the tracepoint
70281dc9f0eSSteven Rostedt (Red Hat)	 will report the time it took to do the previous tracepoint.
70381dc9f0eSSteven Rostedt (Red Hat)	 The string written to the tracepoint is a static string of 128 bytes
70481dc9f0eSSteven Rostedt (Red Hat)	 to keep the time the same. The initial string is simply a write of
70581dc9f0eSSteven Rostedt (Red Hat)	 "START". The second string records the cold cache time of the first
70681dc9f0eSSteven Rostedt (Red Hat)	 write which is not added to the rest of the calculations.
70781dc9f0eSSteven Rostedt (Red Hat)
70881dc9f0eSSteven Rostedt (Red Hat)	 As it is a tight loop, it benchmarks as hot cache. That's fine because
70981dc9f0eSSteven Rostedt (Red Hat)	 we care most about hot paths that are probably in cache already.
71081dc9f0eSSteven Rostedt (Red Hat)
71181dc9f0eSSteven Rostedt (Red Hat)	 An example of the output:
71281dc9f0eSSteven Rostedt (Red Hat)
71381dc9f0eSSteven Rostedt (Red Hat)	      START
71481dc9f0eSSteven Rostedt (Red Hat)	      first=3672 [COLD CACHED]
71581dc9f0eSSteven Rostedt (Red Hat)	      last=632 first=3672 max=632 min=632 avg=316 std=446 std^2=199712
71681dc9f0eSSteven Rostedt (Red Hat)	      last=278 first=3672 max=632 min=278 avg=303 std=316 std^2=100337
71781dc9f0eSSteven Rostedt (Red Hat)	      last=277 first=3672 max=632 min=277 avg=296 std=258 std^2=67064
71881dc9f0eSSteven Rostedt (Red Hat)	      last=273 first=3672 max=632 min=273 avg=292 std=224 std^2=50411
71981dc9f0eSSteven Rostedt (Red Hat)	      last=273 first=3672 max=632 min=273 avg=288 std=200 std^2=40389
72081dc9f0eSSteven Rostedt (Red Hat)	      last=281 first=3672 max=632 min=273 avg=287 std=183 std^2=33666
72181dc9f0eSSteven Rostedt (Red Hat)
72281dc9f0eSSteven Rostedt (Red Hat)
7235092dbc9SSteven Rostedtconfig RING_BUFFER_BENCHMARK
7245092dbc9SSteven Rostedt	tristate "Ring buffer benchmark stress tester"
7255092dbc9SSteven Rostedt	depends on RING_BUFFER
7265092dbc9SSteven Rostedt	help
7275092dbc9SSteven Rostedt	  This option creates a test to stress the ring buffer and benchmark it.
72840892367SRandy Dunlap	  It creates its own ring buffer such that it will not interfere with
7295092dbc9SSteven Rostedt	  any other users of the ring buffer (such as ftrace). It then creates
7305092dbc9SSteven Rostedt	  a producer and consumer that will run for 10 seconds and sleep for
7315092dbc9SSteven Rostedt	  10 seconds. Each interval it will print out the number of events
7325092dbc9SSteven Rostedt	  it recorded and give a rough estimate of how long each iteration took.
7335092dbc9SSteven Rostedt
7345092dbc9SSteven Rostedt	  It does not disable interrupts or raise its priority, so it may be
7355092dbc9SSteven Rostedt	  affected by processes that are running.
7365092dbc9SSteven Rostedt
73740892367SRandy Dunlap	  If unsure, say N.
7385092dbc9SSteven Rostedt
7396c43e554SSteven Rostedt (Red Hat)config RING_BUFFER_STARTUP_TEST
7406c43e554SSteven Rostedt (Red Hat)       bool "Ring buffer startup self test"
7416c43e554SSteven Rostedt (Red Hat)       depends on RING_BUFFER
7426c43e554SSteven Rostedt (Red Hat)       help
7436c43e554SSteven Rostedt (Red Hat)	 Run a simple self test on the ring buffer on boot up. Late in the
7446c43e554SSteven Rostedt (Red Hat)	 kernel boot sequence, the test will start that kicks off
7456c43e554SSteven Rostedt (Red Hat)	 a thread per cpu. Each thread will write various size events
7466c43e554SSteven Rostedt (Red Hat)	 into the ring buffer. Another thread is created to send IPIs
7476c43e554SSteven Rostedt (Red Hat)	 to each of the threads, where the IPI handler will also write
7486c43e554SSteven Rostedt (Red Hat)	 to the ring buffer, to test/stress the nesting ability.
7496c43e554SSteven Rostedt (Red Hat)	 If any anomalies are discovered, a warning will be displayed
7506c43e554SSteven Rostedt (Red Hat)	 and all ring buffers will be disabled.
7516c43e554SSteven Rostedt (Red Hat)
7526c43e554SSteven Rostedt (Red Hat)	 The test runs for 10 seconds. This will slow your boot time
7536c43e554SSteven Rostedt (Red Hat)	 by at least 10 more seconds.
7546c43e554SSteven Rostedt (Red Hat)
7556c43e554SSteven Rostedt (Red Hat)	 At the end of the test, statics and more checks are done.
7566c43e554SSteven Rostedt (Red Hat)	 It will output the stats of each per cpu buffer. What
7576c43e554SSteven Rostedt (Red Hat)	 was written, the sizes, what was read, what was lost, and
7586c43e554SSteven Rostedt (Red Hat)	 other similar details.
7596c43e554SSteven Rostedt (Red Hat)
7606c43e554SSteven Rostedt (Red Hat)	 If unsure, say N
7616c43e554SSteven Rostedt (Red Hat)
762f96e8577SJoel Fernandes (Google)config PREEMPTIRQ_DELAY_TEST
763f96e8577SJoel Fernandes (Google)	tristate "Preempt / IRQ disable delay thread to test latency tracers"
764f96e8577SJoel Fernandes (Google)	depends on m
765f96e8577SJoel Fernandes (Google)	help
766f96e8577SJoel Fernandes (Google)	  Select this option to build a test module that can help test latency
767f96e8577SJoel Fernandes (Google)	  tracers by executing a preempt or irq disable section with a user
768f96e8577SJoel Fernandes (Google)	  configurable delay. The module busy waits for the duration of the
769f96e8577SJoel Fernandes (Google)	  critical section.
770f96e8577SJoel Fernandes (Google)
77179393723SViktor Rosendahl (BMW)	  For example, the following invocation generates a burst of three
77279393723SViktor Rosendahl (BMW)	  irq-disabled critical sections for 500us:
77379393723SViktor Rosendahl (BMW)	  modprobe preemptirq_delay_test test_mode=irq delay=500 burst_size=3
774f96e8577SJoel Fernandes (Google)
775f96e8577SJoel Fernandes (Google)	  If unsure, say N
776f96e8577SJoel Fernandes (Google)
7779fe41efaSTom Zanussiconfig SYNTH_EVENT_GEN_TEST
7789fe41efaSTom Zanussi	tristate "Test module for in-kernel synthetic event generation"
7799fe41efaSTom Zanussi	depends on HIST_TRIGGERS
7809fe41efaSTom Zanussi	help
7819fe41efaSTom Zanussi          This option creates a test module to check the base
7829fe41efaSTom Zanussi          functionality of in-kernel synthetic event definition and
7839fe41efaSTom Zanussi          generation.
7849fe41efaSTom Zanussi
7859fe41efaSTom Zanussi          To test, insert the module, and then check the trace buffer
7869fe41efaSTom Zanussi	  for the generated sample events.
7879fe41efaSTom Zanussi
7889fe41efaSTom Zanussi	  If unsure, say N.
7899fe41efaSTom Zanussi
79064836248STom Zanussiconfig KPROBE_EVENT_GEN_TEST
79164836248STom Zanussi	tristate "Test module for in-kernel kprobe event generation"
79264836248STom Zanussi	depends on KPROBE_EVENTS
79364836248STom Zanussi	help
79464836248STom Zanussi          This option creates a test module to check the base
79564836248STom Zanussi          functionality of in-kernel kprobe event definition.
79664836248STom Zanussi
79764836248STom Zanussi          To test, insert the module, and then check the trace buffer
79864836248STom Zanussi	  for the generated kprobe events.
79964836248STom Zanussi
80064836248STom Zanussi	  If unsure, say N.
80164836248STom Zanussi
802681bec03SJeremy Lintonconfig TRACE_EVAL_MAP_FILE
803681bec03SJeremy Linton       bool "Show eval mappings for trace events"
8049828413dSSteven Rostedt (Red Hat)       depends on TRACING
8059828413dSSteven Rostedt (Red Hat)       help
806681bec03SJeremy Linton	The "print fmt" of the trace events will show the enum/sizeof names
807681bec03SJeremy Linton	instead of their values. This can cause problems for user space tools
808681bec03SJeremy Linton	that use this string to parse the raw data as user space does not know
8099828413dSSteven Rostedt (Red Hat)	how to convert the string to its value.
8109828413dSSteven Rostedt (Red Hat)
8119828413dSSteven Rostedt (Red Hat)	To fix this, there's a special macro in the kernel that can be used
812681bec03SJeremy Linton	to convert an enum/sizeof into its value. If this macro is used, then
813681bec03SJeremy Linton	the print fmt strings will be converted to their values.
8149828413dSSteven Rostedt (Red Hat)
8159828413dSSteven Rostedt (Red Hat)	If something does not get converted properly, this option can be
816681bec03SJeremy Linton	used to show what enums/sizeof the kernel tried to convert.
8179828413dSSteven Rostedt (Red Hat)
818681bec03SJeremy Linton	This option is for debugging the conversions. A file is created
819681bec03SJeremy Linton	in the tracing directory called "eval_map" that will show the
8209828413dSSteven Rostedt (Red Hat)	names matched with their values and what trace event system they
8219828413dSSteven Rostedt (Red Hat)	belong too.
8229828413dSSteven Rostedt (Red Hat)
8239828413dSSteven Rostedt (Red Hat)	Normally, the mapping of the strings to values will be freed after
8249828413dSSteven Rostedt (Red Hat)	boot up or module load. With this option, they will not be freed, as
825681bec03SJeremy Linton	they are needed for the "eval_map" file. Enabling this option will
8269828413dSSteven Rostedt (Red Hat)	increase the memory footprint of the running kernel.
8279828413dSSteven Rostedt (Red Hat)
8289b471204SBorislav Petkov	If unsure, say N.
8299828413dSSteven Rostedt (Red Hat)
8306b7dca40SMasami Hiramatsuconfig GCOV_PROFILE_FTRACE
8316b7dca40SMasami Hiramatsu	bool "Enable GCOV profiling on ftrace subsystem"
8326b7dca40SMasami Hiramatsu	depends on GCOV_KERNEL
8336b7dca40SMasami Hiramatsu	help
8346b7dca40SMasami Hiramatsu	  Enable GCOV profiling on ftrace subsystem for checking
8356b7dca40SMasami Hiramatsu	  which functions/lines are tested.
8366b7dca40SMasami Hiramatsu
8376b7dca40SMasami Hiramatsu	  If unsure, say N.
8386b7dca40SMasami Hiramatsu
8396b7dca40SMasami Hiramatsu	  Note that on a kernel compiled with this config, ftrace will
8406b7dca40SMasami Hiramatsu	  run significantly slower.
8416b7dca40SMasami Hiramatsu
8429c5b9d3dSMasami Hiramatsuconfig BOOTTIME_TRACING
8439c5b9d3dSMasami Hiramatsu	bool "Boot-time Tracing support"
8449c5b9d3dSMasami Hiramatsu	depends on BOOT_CONFIG && TRACING
8459c5b9d3dSMasami Hiramatsu	default y
8469c5b9d3dSMasami Hiramatsu	help
8479c5b9d3dSMasami Hiramatsu	  Enable developer to setup ftrace subsystem via supplemental
8489c5b9d3dSMasami Hiramatsu	  kernel cmdline at boot time for debugging (tracing) driver
8499c5b9d3dSMasami Hiramatsu	  initialization and boot process.
8509c5b9d3dSMasami Hiramatsu
8514ed9f071SSteven Rostedtendif # FTRACE
85240ada30fSIngo Molnar
85340ada30fSIngo Molnarendif # TRACING_SUPPORT
85440ada30fSIngo Molnar
855