xref: /linux/kernel/trace/Kconfig (revision 3ce2b9200da8b7170cc7463b7ee4212fad7b291e)
116444a8aSArnaldo Carvalho de Melo#
216444a8aSArnaldo Carvalho de Melo# Architectures that offer an FTRACE implementation should select HAVE_FTRACE:
316444a8aSArnaldo Carvalho de Melo#
42a3a4f66SFrédéric Weisbecker
52a3a4f66SFrédéric Weisbeckerconfig NOP_TRACER
62a3a4f66SFrédéric Weisbecker	bool
72a3a4f66SFrédéric Weisbecker
816444a8aSArnaldo Carvalho de Meloconfig HAVE_FTRACE
916444a8aSArnaldo Carvalho de Melo	bool
102a3a4f66SFré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
1191f5c2abbSFrédéric Weisbeckerconfig BOOT_TRACER
1201f5c2abbSFrédéric Weisbecker	bool "Trace boot initcalls"
1211f5c2abbSFrédéric Weisbecker	depends on HAVE_FTRACE
1221f5c2abbSFrédéric Weisbecker	depends on DEBUG_KERNEL
1231f5c2abbSFrédéric Weisbecker	select TRACING
1241f5c2abbSFrédéric Weisbecker	help
1251f5c2abbSFrédéric Weisbecker	  This tracer helps developers to optimize boot times: it records
1261f5c2abbSFrédéric Weisbecker	  the timings of the initcalls. Its aim is to be parsed by the
1271f5c2abbSFrédéric Weisbecker	  /scripts/bootgraph.pl tool to produce pretty graphics about
1281f5c2abbSFrédéric Weisbecker	  boot inefficiencies, giving a visual representation of the
129*3ce2b920SFrédéric Weisbecker	  delays during initcalls. Note that tracers self tests can't
130*3ce2b920SFrédéric Weisbecker	  be enabled if this tracer is selected since only one tracer
131*3ce2b920SFrédéric Weisbecker	  should touch the tracing buffer at a time.
1321f5c2abbSFrédéric Weisbecker
133e5a81b62SSteven Rostedtconfig STACK_TRACER
134e5a81b62SSteven Rostedt	bool "Trace max stack"
135e5a81b62SSteven Rostedt	depends on HAVE_FTRACE
1362ff01c6aSIngo Molnar	depends on DEBUG_KERNEL
137e5a81b62SSteven Rostedt	select FTRACE
138e5a81b62SSteven Rostedt	select STACKTRACE
139e5a81b62SSteven Rostedt	help
140e5a81b62SSteven Rostedt	  This tracer records the max stack of the kernel, and displays
141e5a81b62SSteven Rostedt	  it in debugfs/tracing/stack_trace
142e5a81b62SSteven Rostedt
1433d083395SSteven Rostedtconfig DYNAMIC_FTRACE
1443d083395SSteven Rostedt	bool "enable/disable ftrace tracepoints dynamically"
1453d083395SSteven Rostedt	depends on FTRACE
146677aa9f7SSteven Rostedt	depends on HAVE_DYNAMIC_FTRACE
147d3ee6d99SIngo Molnar	depends on DEBUG_KERNEL
1483d083395SSteven Rostedt	default y
1493d083395SSteven Rostedt	help
1503d083395SSteven Rostedt         This option will modify all the calls to ftrace dynamically
1513d083395SSteven Rostedt	 (will patch them out of the binary image and replaces them
1523d083395SSteven Rostedt	 with a No-Op instruction) as they are called. A table is
1533d083395SSteven Rostedt	 created to dynamically enable them again.
1543d083395SSteven Rostedt
1553d083395SSteven Rostedt	 This way a CONFIG_FTRACE kernel is slightly larger, but otherwise
1563d083395SSteven Rostedt	 has native performance as long as no tracing is active.
1573d083395SSteven Rostedt
1583d083395SSteven Rostedt	 The changes to the code are done by a kernel thread that
1593d083395SSteven Rostedt	 wakes up once a second and checks to see if any ftrace calls
1603d083395SSteven Rostedt	 were made. If so, it runs stop_machine (stops all CPUS)
1613d083395SSteven Rostedt	 and modifies the code to jump over the call to ftrace.
16260a11774SSteven Rostedt
1638da3821bSSteven Rostedtconfig FTRACE_MCOUNT_RECORD
1648da3821bSSteven Rostedt	def_bool y
1658da3821bSSteven Rostedt	depends on DYNAMIC_FTRACE
1668da3821bSSteven Rostedt	depends on HAVE_FTRACE_MCOUNT_RECORD
1678da3821bSSteven Rostedt
16860a11774SSteven Rostedtconfig FTRACE_SELFTEST
16960a11774SSteven Rostedt	bool
17060a11774SSteven Rostedt
17160a11774SSteven Rostedtconfig FTRACE_STARTUP_TEST
17260a11774SSteven Rostedt	bool "Perform a startup test on ftrace"
173*3ce2b920SFrédéric Weisbecker	depends on TRACING && DEBUG_KERNEL && !BOOT_TRACER
17460a11774SSteven Rostedt	select FTRACE_SELFTEST
17560a11774SSteven Rostedt	help
17660a11774SSteven Rostedt	  This option performs a series of startup tests on ftrace. On bootup
17760a11774SSteven Rostedt	  a series of tests are made to verify that the tracer is
17860a11774SSteven Rostedt	  functioning properly. It will do tests on all the configured
17960a11774SSteven Rostedt	  tracers of ftrace.
180