xref: /linux/kernel/trace/Kconfig (revision 2a3a4f669df2164288d11406d11d5e4933bf5e53)
116444a8aSArnaldo Carvalho de Melo#
216444a8aSArnaldo Carvalho de Melo# Architectures that offer an FTRACE implementation should select HAVE_FTRACE:
316444a8aSArnaldo Carvalho de Melo#
4*2a3a4f66SFrédéric Weisbecker
5*2a3a4f66SFrédéric Weisbeckerconfig NOP_TRACER
6*2a3a4f66SFrédéric Weisbecker	bool
7*2a3a4f66SFrédéric Weisbecker
816444a8aSArnaldo Carvalho de Meloconfig HAVE_FTRACE
916444a8aSArnaldo Carvalho de Melo	bool
10*2a3a4f66SFrédéric Weisbecker	select NOP_TRACER
11bc0c38d1SSteven Rostedt
12677aa9f7SSteven Rostedtconfig HAVE_DYNAMIC_FTRACE
13677aa9f7SSteven Rostedt	bool
14677aa9f7SSteven Rostedt
158da3821bSSteven Rostedtconfig HAVE_FTRACE_MCOUNT_RECORD
168da3821bSSteven Rostedt	bool
178da3821bSSteven Rostedt
18352ad25aSSteven Rostedtconfig TRACER_MAX_TRACE
19352ad25aSSteven Rostedt	bool
20352ad25aSSteven Rostedt
21bc0c38d1SSteven Rostedtconfig TRACING
22bc0c38d1SSteven Rostedt	bool
23bc0c38d1SSteven Rostedt	select DEBUG_FS
2486387f7eSIngo Molnar	select STACKTRACE
255f87f112SIngo Molnar	select TRACEPOINTS
26bc0c38d1SSteven Rostedt
271b29b018SSteven Rostedtconfig FTRACE
281b29b018SSteven Rostedt	bool "Kernel Function Tracer"
29694379e9SIngo Molnar	depends on HAVE_FTRACE
30d3ee6d99SIngo Molnar	depends on DEBUG_KERNEL
311b29b018SSteven Rostedt	select FRAME_POINTER
321b29b018SSteven Rostedt	select TRACING
3335e8e302SSteven Rostedt	select CONTEXT_SWITCH_TRACER
341b29b018SSteven Rostedt	help
351b29b018SSteven Rostedt	  Enable the kernel to trace every kernel function. This is done
361b29b018SSteven Rostedt	  by using a compiler feature to insert a small, 5-byte No-Operation
371b29b018SSteven Rostedt	  instruction to the beginning of every kernel function, which NOP
381b29b018SSteven Rostedt	  sequence is then dynamically patched into a tracer call when
391b29b018SSteven Rostedt	  tracing is enabled by the administrator. If it's runtime disabled
401b29b018SSteven Rostedt	  (the bootup default), then the overhead of the instructions is very
411b29b018SSteven Rostedt	  small and not measurable even in micro-benchmarks.
4235e8e302SSteven Rostedt
4381d68a96SSteven Rostedtconfig IRQSOFF_TRACER
4481d68a96SSteven Rostedt	bool "Interrupts-off Latency Tracer"
4581d68a96SSteven Rostedt	default n
4681d68a96SSteven Rostedt	depends on TRACE_IRQFLAGS_SUPPORT
4781d68a96SSteven Rostedt	depends on GENERIC_TIME
48c1d2327bSIngo Molnar	depends on HAVE_FTRACE
49d3ee6d99SIngo Molnar	depends on DEBUG_KERNEL
5081d68a96SSteven Rostedt	select TRACE_IRQFLAGS
5181d68a96SSteven Rostedt	select TRACING
5281d68a96SSteven Rostedt	select TRACER_MAX_TRACE
5381d68a96SSteven Rostedt	help
5481d68a96SSteven Rostedt	  This option measures the time spent in irqs-off critical
5581d68a96SSteven Rostedt	  sections, with microsecond accuracy.
5681d68a96SSteven Rostedt
5781d68a96SSteven Rostedt	  The default measurement method is a maximum search, which is
5881d68a96SSteven Rostedt	  disabled by default and can be runtime (re-)started
5981d68a96SSteven Rostedt	  via:
6081d68a96SSteven Rostedt
6181d68a96SSteven Rostedt	      echo 0 > /debugfs/tracing/tracing_max_latency
6281d68a96SSteven Rostedt
636cd8a4bbSSteven Rostedt	  (Note that kernel size and overhead increases with this option
646cd8a4bbSSteven Rostedt	  enabled. This option and the preempt-off timing option can be
656cd8a4bbSSteven Rostedt	  used together or separately.)
666cd8a4bbSSteven Rostedt
676cd8a4bbSSteven Rostedtconfig PREEMPT_TRACER
686cd8a4bbSSteven Rostedt	bool "Preemption-off Latency Tracer"
696cd8a4bbSSteven Rostedt	default n
706cd8a4bbSSteven Rostedt	depends on GENERIC_TIME
716cd8a4bbSSteven Rostedt	depends on PREEMPT
72c1d2327bSIngo Molnar	depends on HAVE_FTRACE
73d3ee6d99SIngo Molnar	depends on DEBUG_KERNEL
746cd8a4bbSSteven Rostedt	select TRACING
756cd8a4bbSSteven Rostedt	select TRACER_MAX_TRACE
766cd8a4bbSSteven Rostedt	help
776cd8a4bbSSteven Rostedt	  This option measures the time spent in preemption off critical
786cd8a4bbSSteven Rostedt	  sections, with microsecond accuracy.
796cd8a4bbSSteven Rostedt
806cd8a4bbSSteven Rostedt	  The default measurement method is a maximum search, which is
816cd8a4bbSSteven Rostedt	  disabled by default and can be runtime (re-)started
826cd8a4bbSSteven Rostedt	  via:
836cd8a4bbSSteven Rostedt
846cd8a4bbSSteven Rostedt	      echo 0 > /debugfs/tracing/tracing_max_latency
856cd8a4bbSSteven Rostedt
866cd8a4bbSSteven Rostedt	  (Note that kernel size and overhead increases with this option
876cd8a4bbSSteven Rostedt	  enabled. This option and the irqs-off timing option can be
886cd8a4bbSSteven Rostedt	  used together or separately.)
896cd8a4bbSSteven Rostedt
90f06c3810SIngo Molnarconfig SYSPROF_TRACER
91f06c3810SIngo Molnar	bool "Sysprof Tracer"
924d2df795SThomas Gleixner	depends on X86
93f06c3810SIngo Molnar	select TRACING
94f06c3810SIngo Molnar	help
95f06c3810SIngo Molnar	  This tracer provides the trace needed by the 'Sysprof' userspace
96f06c3810SIngo Molnar	  tool.
97f06c3810SIngo Molnar
98352ad25aSSteven Rostedtconfig SCHED_TRACER
99352ad25aSSteven Rostedt	bool "Scheduling Latency Tracer"
100c1d2327bSIngo Molnar	depends on HAVE_FTRACE
101d3ee6d99SIngo Molnar	depends on DEBUG_KERNEL
102352ad25aSSteven Rostedt	select TRACING
103352ad25aSSteven Rostedt	select CONTEXT_SWITCH_TRACER
104352ad25aSSteven Rostedt	select TRACER_MAX_TRACE
105352ad25aSSteven Rostedt	help
106352ad25aSSteven Rostedt	  This tracer tracks the latency of the highest priority task
107352ad25aSSteven Rostedt	  to be scheduled in, starting from the point it has woken up.
108352ad25aSSteven Rostedt
10935e8e302SSteven Rostedtconfig CONTEXT_SWITCH_TRACER
11035e8e302SSteven Rostedt	bool "Trace process context switches"
111c1d2327bSIngo Molnar	depends on HAVE_FTRACE
112d3ee6d99SIngo Molnar	depends on DEBUG_KERNEL
11335e8e302SSteven Rostedt	select TRACING
11435e8e302SSteven Rostedt	select MARKERS
11535e8e302SSteven Rostedt	help
11635e8e302SSteven Rostedt	  This tracer gets called from the context switch and records
11735e8e302SSteven Rostedt	  all switching of tasks.
11835e8e302SSteven Rostedt
119e5a81b62SSteven Rostedtconfig STACK_TRACER
120e5a81b62SSteven Rostedt	bool "Trace max stack"
121e5a81b62SSteven Rostedt	depends on HAVE_FTRACE
1222ff01c6aSIngo Molnar	depends on DEBUG_KERNEL
123e5a81b62SSteven Rostedt	select FTRACE
124e5a81b62SSteven Rostedt	select STACKTRACE
125e5a81b62SSteven Rostedt	help
126e5a81b62SSteven Rostedt	  This tracer records the max stack of the kernel, and displays
127e5a81b62SSteven Rostedt	  it in debugfs/tracing/stack_trace
128e5a81b62SSteven Rostedt
1293d083395SSteven Rostedtconfig DYNAMIC_FTRACE
1303d083395SSteven Rostedt	bool "enable/disable ftrace tracepoints dynamically"
1313d083395SSteven Rostedt	depends on FTRACE
132677aa9f7SSteven Rostedt	depends on HAVE_DYNAMIC_FTRACE
133d3ee6d99SIngo Molnar	depends on DEBUG_KERNEL
1343d083395SSteven Rostedt	default y
1353d083395SSteven Rostedt	help
1363d083395SSteven Rostedt         This option will modify all the calls to ftrace dynamically
1373d083395SSteven Rostedt	 (will patch them out of the binary image and replaces them
1383d083395SSteven Rostedt	 with a No-Op instruction) as they are called. A table is
1393d083395SSteven Rostedt	 created to dynamically enable them again.
1403d083395SSteven Rostedt
1413d083395SSteven Rostedt	 This way a CONFIG_FTRACE kernel is slightly larger, but otherwise
1423d083395SSteven Rostedt	 has native performance as long as no tracing is active.
1433d083395SSteven Rostedt
1443d083395SSteven Rostedt	 The changes to the code are done by a kernel thread that
1453d083395SSteven Rostedt	 wakes up once a second and checks to see if any ftrace calls
1463d083395SSteven Rostedt	 were made. If so, it runs stop_machine (stops all CPUS)
1473d083395SSteven Rostedt	 and modifies the code to jump over the call to ftrace.
14860a11774SSteven Rostedt
1498da3821bSSteven Rostedtconfig FTRACE_MCOUNT_RECORD
1508da3821bSSteven Rostedt	def_bool y
1518da3821bSSteven Rostedt	depends on DYNAMIC_FTRACE
1528da3821bSSteven Rostedt	depends on HAVE_FTRACE_MCOUNT_RECORD
1538da3821bSSteven Rostedt
15460a11774SSteven Rostedtconfig FTRACE_SELFTEST
15560a11774SSteven Rostedt	bool
15660a11774SSteven Rostedt
15760a11774SSteven Rostedtconfig FTRACE_STARTUP_TEST
15860a11774SSteven Rostedt	bool "Perform a startup test on ftrace"
15960a11774SSteven Rostedt	depends on TRACING
160d3ee6d99SIngo Molnar	depends on DEBUG_KERNEL
16160a11774SSteven Rostedt	select FTRACE_SELFTEST
16260a11774SSteven Rostedt	help
16360a11774SSteven Rostedt	  This option performs a series of startup tests on ftrace. On bootup
16460a11774SSteven Rostedt	  a series of tests are made to verify that the tracer is
16560a11774SSteven Rostedt	  functioning properly. It will do tests on all the configured
16660a11774SSteven Rostedt	  tracers of ftrace.
167