xref: /linux/kernel/trace/Kconfig (revision 7a8e76a3829f1067b70f715771ff88baf2fbf3c3)
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
21*7a8e76a3SSteven Rostedtconfig RING_BUFFER
22*7a8e76a3SSteven Rostedt	bool
23*7a8e76a3SSteven Rostedt
24bc0c38d1SSteven Rostedtconfig TRACING
25bc0c38d1SSteven Rostedt	bool
26bc0c38d1SSteven Rostedt	select DEBUG_FS
27*7a8e76a3SSteven Rostedt	select RING_BUFFER
2886387f7eSIngo Molnar	select STACKTRACE
295f87f112SIngo Molnar	select TRACEPOINTS
30bc0c38d1SSteven Rostedt
311b29b018SSteven Rostedtconfig FTRACE
321b29b018SSteven Rostedt	bool "Kernel Function Tracer"
33694379e9SIngo Molnar	depends on HAVE_FTRACE
34d3ee6d99SIngo Molnar	depends on DEBUG_KERNEL
351b29b018SSteven Rostedt	select FRAME_POINTER
361b29b018SSteven Rostedt	select TRACING
3735e8e302SSteven Rostedt	select CONTEXT_SWITCH_TRACER
381b29b018SSteven Rostedt	help
391b29b018SSteven Rostedt	  Enable the kernel to trace every kernel function. This is done
401b29b018SSteven Rostedt	  by using a compiler feature to insert a small, 5-byte No-Operation
411b29b018SSteven Rostedt	  instruction to the beginning of every kernel function, which NOP
421b29b018SSteven Rostedt	  sequence is then dynamically patched into a tracer call when
431b29b018SSteven Rostedt	  tracing is enabled by the administrator. If it's runtime disabled
441b29b018SSteven Rostedt	  (the bootup default), then the overhead of the instructions is very
451b29b018SSteven Rostedt	  small and not measurable even in micro-benchmarks.
4635e8e302SSteven Rostedt
4781d68a96SSteven Rostedtconfig IRQSOFF_TRACER
4881d68a96SSteven Rostedt	bool "Interrupts-off Latency Tracer"
4981d68a96SSteven Rostedt	default n
5081d68a96SSteven Rostedt	depends on TRACE_IRQFLAGS_SUPPORT
5181d68a96SSteven Rostedt	depends on GENERIC_TIME
52c1d2327bSIngo Molnar	depends on HAVE_FTRACE
53d3ee6d99SIngo Molnar	depends on DEBUG_KERNEL
5481d68a96SSteven Rostedt	select TRACE_IRQFLAGS
5581d68a96SSteven Rostedt	select TRACING
5681d68a96SSteven Rostedt	select TRACER_MAX_TRACE
5781d68a96SSteven Rostedt	help
5881d68a96SSteven Rostedt	  This option measures the time spent in irqs-off critical
5981d68a96SSteven Rostedt	  sections, with microsecond accuracy.
6081d68a96SSteven Rostedt
6181d68a96SSteven Rostedt	  The default measurement method is a maximum search, which is
6281d68a96SSteven Rostedt	  disabled by default and can be runtime (re-)started
6381d68a96SSteven Rostedt	  via:
6481d68a96SSteven Rostedt
6581d68a96SSteven Rostedt	      echo 0 > /debugfs/tracing/tracing_max_latency
6681d68a96SSteven Rostedt
676cd8a4bbSSteven Rostedt	  (Note that kernel size and overhead increases with this option
686cd8a4bbSSteven Rostedt	  enabled. This option and the preempt-off timing option can be
696cd8a4bbSSteven Rostedt	  used together or separately.)
706cd8a4bbSSteven Rostedt
716cd8a4bbSSteven Rostedtconfig PREEMPT_TRACER
726cd8a4bbSSteven Rostedt	bool "Preemption-off Latency Tracer"
736cd8a4bbSSteven Rostedt	default n
746cd8a4bbSSteven Rostedt	depends on GENERIC_TIME
756cd8a4bbSSteven Rostedt	depends on PREEMPT
76c1d2327bSIngo Molnar	depends on HAVE_FTRACE
77d3ee6d99SIngo Molnar	depends on DEBUG_KERNEL
786cd8a4bbSSteven Rostedt	select TRACING
796cd8a4bbSSteven Rostedt	select TRACER_MAX_TRACE
806cd8a4bbSSteven Rostedt	help
816cd8a4bbSSteven Rostedt	  This option measures the time spent in preemption off critical
826cd8a4bbSSteven Rostedt	  sections, with microsecond accuracy.
836cd8a4bbSSteven Rostedt
846cd8a4bbSSteven Rostedt	  The default measurement method is a maximum search, which is
856cd8a4bbSSteven Rostedt	  disabled by default and can be runtime (re-)started
866cd8a4bbSSteven Rostedt	  via:
876cd8a4bbSSteven Rostedt
886cd8a4bbSSteven Rostedt	      echo 0 > /debugfs/tracing/tracing_max_latency
896cd8a4bbSSteven Rostedt
906cd8a4bbSSteven Rostedt	  (Note that kernel size and overhead increases with this option
916cd8a4bbSSteven Rostedt	  enabled. This option and the irqs-off timing option can be
926cd8a4bbSSteven Rostedt	  used together or separately.)
936cd8a4bbSSteven Rostedt
94f06c3810SIngo Molnarconfig SYSPROF_TRACER
95f06c3810SIngo Molnar	bool "Sysprof Tracer"
964d2df795SThomas Gleixner	depends on X86
97f06c3810SIngo Molnar	select TRACING
98f06c3810SIngo Molnar	help
99f06c3810SIngo Molnar	  This tracer provides the trace needed by the 'Sysprof' userspace
100f06c3810SIngo Molnar	  tool.
101f06c3810SIngo Molnar
102352ad25aSSteven Rostedtconfig SCHED_TRACER
103352ad25aSSteven Rostedt	bool "Scheduling Latency Tracer"
104c1d2327bSIngo Molnar	depends on HAVE_FTRACE
105d3ee6d99SIngo Molnar	depends on DEBUG_KERNEL
106352ad25aSSteven Rostedt	select TRACING
107352ad25aSSteven Rostedt	select CONTEXT_SWITCH_TRACER
108352ad25aSSteven Rostedt	select TRACER_MAX_TRACE
109352ad25aSSteven Rostedt	help
110352ad25aSSteven Rostedt	  This tracer tracks the latency of the highest priority task
111352ad25aSSteven Rostedt	  to be scheduled in, starting from the point it has woken up.
112352ad25aSSteven Rostedt
11335e8e302SSteven Rostedtconfig CONTEXT_SWITCH_TRACER
11435e8e302SSteven Rostedt	bool "Trace process context switches"
115c1d2327bSIngo Molnar	depends on HAVE_FTRACE
116d3ee6d99SIngo Molnar	depends on DEBUG_KERNEL
11735e8e302SSteven Rostedt	select TRACING
11835e8e302SSteven Rostedt	select MARKERS
11935e8e302SSteven Rostedt	help
12035e8e302SSteven Rostedt	  This tracer gets called from the context switch and records
12135e8e302SSteven Rostedt	  all switching of tasks.
12235e8e302SSteven Rostedt
1231f5c2abbSFrédéric Weisbeckerconfig BOOT_TRACER
1241f5c2abbSFrédéric Weisbecker	bool "Trace boot initcalls"
1251f5c2abbSFrédéric Weisbecker	depends on HAVE_FTRACE
1261f5c2abbSFrédéric Weisbecker	depends on DEBUG_KERNEL
1271f5c2abbSFrédéric Weisbecker	select TRACING
1281f5c2abbSFrédéric Weisbecker	help
1291f5c2abbSFrédéric Weisbecker	  This tracer helps developers to optimize boot times: it records
1301f5c2abbSFrédéric Weisbecker	  the timings of the initcalls. Its aim is to be parsed by the
1311f5c2abbSFrédéric Weisbecker	  /scripts/bootgraph.pl tool to produce pretty graphics about
1321f5c2abbSFrédéric Weisbecker	  boot inefficiencies, giving a visual representation of the
1333ce2b920SFrédéric Weisbecker	  delays during initcalls. Note that tracers self tests can't
1343ce2b920SFrédéric Weisbecker	  be enabled if this tracer is selected since only one tracer
1353ce2b920SFrédéric Weisbecker	  should touch the tracing buffer at a time.
1361f5c2abbSFrédéric Weisbecker
137e5a81b62SSteven Rostedtconfig STACK_TRACER
138e5a81b62SSteven Rostedt	bool "Trace max stack"
139e5a81b62SSteven Rostedt	depends on HAVE_FTRACE
1402ff01c6aSIngo Molnar	depends on DEBUG_KERNEL
141e5a81b62SSteven Rostedt	select FTRACE
142e5a81b62SSteven Rostedt	select STACKTRACE
143e5a81b62SSteven Rostedt	help
144e5a81b62SSteven Rostedt	  This tracer records the max stack of the kernel, and displays
145e5a81b62SSteven Rostedt	  it in debugfs/tracing/stack_trace
146e5a81b62SSteven Rostedt
1473d083395SSteven Rostedtconfig DYNAMIC_FTRACE
1483d083395SSteven Rostedt	bool "enable/disable ftrace tracepoints dynamically"
1493d083395SSteven Rostedt	depends on FTRACE
150677aa9f7SSteven Rostedt	depends on HAVE_DYNAMIC_FTRACE
151d3ee6d99SIngo Molnar	depends on DEBUG_KERNEL
1523d083395SSteven Rostedt	default y
1533d083395SSteven Rostedt	help
1543d083395SSteven Rostedt         This option will modify all the calls to ftrace dynamically
1553d083395SSteven Rostedt	 (will patch them out of the binary image and replaces them
1563d083395SSteven Rostedt	 with a No-Op instruction) as they are called. A table is
1573d083395SSteven Rostedt	 created to dynamically enable them again.
1583d083395SSteven Rostedt
1593d083395SSteven Rostedt	 This way a CONFIG_FTRACE kernel is slightly larger, but otherwise
1603d083395SSteven Rostedt	 has native performance as long as no tracing is active.
1613d083395SSteven Rostedt
1623d083395SSteven Rostedt	 The changes to the code are done by a kernel thread that
1633d083395SSteven Rostedt	 wakes up once a second and checks to see if any ftrace calls
1643d083395SSteven Rostedt	 were made. If so, it runs stop_machine (stops all CPUS)
1653d083395SSteven Rostedt	 and modifies the code to jump over the call to ftrace.
16660a11774SSteven Rostedt
1678da3821bSSteven Rostedtconfig FTRACE_MCOUNT_RECORD
1688da3821bSSteven Rostedt	def_bool y
1698da3821bSSteven Rostedt	depends on DYNAMIC_FTRACE
1708da3821bSSteven Rostedt	depends on HAVE_FTRACE_MCOUNT_RECORD
1718da3821bSSteven Rostedt
17260a11774SSteven Rostedtconfig FTRACE_SELFTEST
17360a11774SSteven Rostedt	bool
17460a11774SSteven Rostedt
17560a11774SSteven Rostedtconfig FTRACE_STARTUP_TEST
17660a11774SSteven Rostedt	bool "Perform a startup test on ftrace"
1773ce2b920SFrédéric Weisbecker	depends on TRACING && DEBUG_KERNEL && !BOOT_TRACER
17860a11774SSteven Rostedt	select FTRACE_SELFTEST
17960a11774SSteven Rostedt	help
18060a11774SSteven Rostedt	  This option performs a series of startup tests on ftrace. On bootup
18160a11774SSteven Rostedt	  a series of tests are made to verify that the tracer is
18260a11774SSteven Rostedt	  functioning properly. It will do tests on all the configured
18360a11774SSteven Rostedt	  tracers of ftrace.
184