Commit | Line | Data |
---|---|---|
16444a8a | 1 | # |
606576ce SR |
2 | # Architectures that offer an FUNCTION_TRACER implementation should |
3 | # select HAVE_FUNCTION_TRACER: | |
16444a8a | 4 | # |
2a3a4f66 | 5 | |
8d26487f TE |
6 | config USER_STACKTRACE_SUPPORT |
7 | bool | |
8 | ||
2a3a4f66 FW |
9 | config NOP_TRACER |
10 | bool | |
11 | ||
78d904b4 SR |
12 | config HAVE_FTRACE_NMI_ENTER |
13 | bool | |
555f386c | 14 | help |
40892367 | 15 | See Documentation/trace/ftrace-design.txt |
78d904b4 | 16 | |
606576ce | 17 | config HAVE_FUNCTION_TRACER |
16444a8a | 18 | bool |
555f386c | 19 | help |
40892367 | 20 | See Documentation/trace/ftrace-design.txt |
bc0c38d1 | 21 | |
fb52607a | 22 | config HAVE_FUNCTION_GRAPH_TRACER |
15e6cb36 | 23 | bool |
555f386c | 24 | help |
40892367 | 25 | See Documentation/trace/ftrace-design.txt |
15e6cb36 | 26 | |
71e308a2 SR |
27 | config HAVE_FUNCTION_GRAPH_FP_TEST |
28 | bool | |
29 | help | |
03688970 | 30 | See Documentation/trace/ftrace-design.txt |
71e308a2 | 31 | |
60a7ecf4 SR |
32 | config HAVE_FUNCTION_TRACE_MCOUNT_TEST |
33 | bool | |
34 | help | |
40892367 | 35 | See Documentation/trace/ftrace-design.txt |
60a7ecf4 | 36 | |
677aa9f7 SR |
37 | config HAVE_DYNAMIC_FTRACE |
38 | bool | |
555f386c | 39 | help |
40892367 | 40 | See Documentation/trace/ftrace-design.txt |
677aa9f7 | 41 | |
8da3821b SR |
42 | config HAVE_FTRACE_MCOUNT_RECORD |
43 | bool | |
555f386c | 44 | help |
40892367 | 45 | See Documentation/trace/ftrace-design.txt |
8da3821b | 46 | |
66700001 | 47 | config HAVE_SYSCALL_TRACEPOINTS |
ee08c6ec | 48 | bool |
555f386c | 49 | help |
40892367 | 50 | See Documentation/trace/ftrace-design.txt |
ee08c6ec | 51 | |
72441cb1 SR |
52 | config HAVE_C_MCOUNT_RECORD |
53 | bool | |
54 | help | |
55 | C version of recordmcount available? | |
56 | ||
352ad25a SR |
57 | config TRACER_MAX_TRACE |
58 | bool | |
59 | ||
7a8e76a3 SR |
60 | config RING_BUFFER |
61 | bool | |
62 | ||
78d904b4 SR |
63 | config FTRACE_NMI_ENTER |
64 | bool | |
65 | depends on HAVE_FTRACE_NMI_ENTER | |
66 | default y | |
67 | ||
5f77a88b | 68 | config EVENT_TRACING |
b11c53e1 Z |
69 | select CONTEXT_SWITCH_TRACER |
70 | bool | |
71 | ||
72 | config CONTEXT_SWITCH_TRACER | |
5f77a88b TZ |
73 | bool |
74 | ||
85bac32c SR |
75 | config RING_BUFFER_ALLOW_SWAP |
76 | bool | |
77 | help | |
78 | Allow the use of ring_buffer_swap_cpu. | |
79 | Adds a very slight overhead to tracing when enabled. | |
80 | ||
5e0a0939 SR |
81 | # All tracer options should select GENERIC_TRACER. For those options that are |
82 | # enabled by all tracers (context switch and event tracer) they select TRACING. | |
83 | # This allows those options to appear when no other tracer is selected. But the | |
84 | # options do not appear when something else selects it. We need the two options | |
85 | # GENERIC_TRACER and TRACING to avoid circular dependencies to accomplish the | |
40892367 | 86 | # hiding of the automatic options. |
5e0a0939 | 87 | |
bc0c38d1 SR |
88 | config TRACING |
89 | bool | |
90 | select DEBUG_FS | |
7a8e76a3 | 91 | select RING_BUFFER |
c2c80529 | 92 | select STACKTRACE if STACKTRACE_SUPPORT |
5f87f112 | 93 | select TRACEPOINTS |
f3384b28 | 94 | select NOP_TRACER |
769b0441 | 95 | select BINARY_PRINTF |
5f77a88b | 96 | select EVENT_TRACING |
bc0c38d1 | 97 | |
5e0a0939 SR |
98 | config GENERIC_TRACER |
99 | bool | |
100 | select TRACING | |
101 | ||
40ada30f IM |
102 | # |
103 | # Minimum requirements an architecture has to meet for us to | |
104 | # be able to offer generic tracing facilities: | |
105 | # | |
106 | config TRACING_SUPPORT | |
107 | bool | |
45b95608 AV |
108 | # PPC32 has no irqflags tracing support, but it can use most of the |
109 | # tracers anyway, they were tested to build and work. Note that new | |
110 | # exceptions to this list aren't welcomed, better implement the | |
111 | # irqflags tracing for your architecture. | |
112 | depends on TRACE_IRQFLAGS_SUPPORT || PPC32 | |
40ada30f | 113 | depends on STACKTRACE_SUPPORT |
422d3c7a | 114 | default y |
40ada30f IM |
115 | |
116 | if TRACING_SUPPORT | |
117 | ||
4ed9f071 SR |
118 | menuconfig FTRACE |
119 | bool "Tracers" | |
65b77242 | 120 | default y if DEBUG_KERNEL |
4ed9f071 | 121 | help |
40892367 | 122 | Enable the kernel tracing infrastructure. |
4ed9f071 SR |
123 | |
124 | if FTRACE | |
17d80fd0 | 125 | |
606576ce | 126 | config FUNCTION_TRACER |
1b29b018 | 127 | bool "Kernel Function Tracer" |
606576ce | 128 | depends on HAVE_FUNCTION_TRACER |
1b29b018 | 129 | select FRAME_POINTER |
4d7a077c | 130 | select KALLSYMS |
5e0a0939 | 131 | select GENERIC_TRACER |
35e8e302 | 132 | select CONTEXT_SWITCH_TRACER |
1b29b018 SR |
133 | help |
134 | Enable the kernel to trace every kernel function. This is done | |
135 | by using a compiler feature to insert a small, 5-byte No-Operation | |
40892367 | 136 | instruction at the beginning of every kernel function, which NOP |
1b29b018 SR |
137 | sequence is then dynamically patched into a tracer call when |
138 | tracing is enabled by the administrator. If it's runtime disabled | |
139 | (the bootup default), then the overhead of the instructions is very | |
140 | small and not measurable even in micro-benchmarks. | |
35e8e302 | 141 | |
fb52607a FW |
142 | config FUNCTION_GRAPH_TRACER |
143 | bool "Kernel Function Graph Tracer" | |
144 | depends on HAVE_FUNCTION_GRAPH_TRACER | |
15e6cb36 | 145 | depends on FUNCTION_TRACER |
eb4a0378 | 146 | depends on !X86_32 || !CC_OPTIMIZE_FOR_SIZE |
764f3b95 | 147 | default y |
15e6cb36 | 148 | help |
fb52607a FW |
149 | Enable the kernel to trace a function at both its return |
150 | and its entry. | |
692105b8 ML |
151 | Its first purpose is to trace the duration of functions and |
152 | draw a call graph for each thread with some information like | |
40892367 | 153 | the return value. This is done by setting the current return |
692105b8 | 154 | address on the current task structure into a stack of calls. |
15e6cb36 | 155 | |
bac429f0 | 156 | |
81d68a96 SR |
157 | config IRQSOFF_TRACER |
158 | bool "Interrupts-off Latency Tracer" | |
159 | default n | |
160 | depends on TRACE_IRQFLAGS_SUPPORT | |
592913ec | 161 | depends on !ARCH_USES_GETTIMEOFFSET |
81d68a96 | 162 | select TRACE_IRQFLAGS |
5e0a0939 | 163 | select GENERIC_TRACER |
81d68a96 | 164 | select TRACER_MAX_TRACE |
85bac32c | 165 | select RING_BUFFER_ALLOW_SWAP |
81d68a96 SR |
166 | help |
167 | This option measures the time spent in irqs-off critical | |
168 | sections, with microsecond accuracy. | |
169 | ||
170 | The default measurement method is a maximum search, which is | |
171 | disabled by default and can be runtime (re-)started | |
172 | via: | |
173 | ||
156f5a78 | 174 | echo 0 > /sys/kernel/debug/tracing/tracing_max_latency |
81d68a96 | 175 | |
40892367 | 176 | (Note that kernel size and overhead increase with this option |
6cd8a4bb SR |
177 | enabled. This option and the preempt-off timing option can be |
178 | used together or separately.) | |
179 | ||
180 | config PREEMPT_TRACER | |
181 | bool "Preemption-off Latency Tracer" | |
182 | default n | |
592913ec | 183 | depends on !ARCH_USES_GETTIMEOFFSET |
6cd8a4bb | 184 | depends on PREEMPT |
5e0a0939 | 185 | select GENERIC_TRACER |
6cd8a4bb | 186 | select TRACER_MAX_TRACE |
85bac32c | 187 | select RING_BUFFER_ALLOW_SWAP |
6cd8a4bb | 188 | help |
40892367 | 189 | This option measures the time spent in preemption-off critical |
6cd8a4bb SR |
190 | sections, with microsecond accuracy. |
191 | ||
192 | The default measurement method is a maximum search, which is | |
193 | disabled by default and can be runtime (re-)started | |
194 | via: | |
195 | ||
156f5a78 | 196 | echo 0 > /sys/kernel/debug/tracing/tracing_max_latency |
6cd8a4bb | 197 | |
40892367 | 198 | (Note that kernel size and overhead increase with this option |
6cd8a4bb SR |
199 | enabled. This option and the irqs-off timing option can be |
200 | used together or separately.) | |
201 | ||
352ad25a SR |
202 | config SCHED_TRACER |
203 | bool "Scheduling Latency Tracer" | |
5e0a0939 | 204 | select GENERIC_TRACER |
352ad25a SR |
205 | select CONTEXT_SWITCH_TRACER |
206 | select TRACER_MAX_TRACE | |
207 | help | |
208 | This tracer tracks the latency of the highest priority task | |
209 | to be scheduled in, starting from the point it has woken up. | |
210 | ||
897f17a6 SR |
211 | config ENABLE_DEFAULT_TRACERS |
212 | bool "Trace process context switches and events" | |
5e0a0939 | 213 | depends on !GENERIC_TRACER |
b77e38aa SR |
214 | select TRACING |
215 | help | |
40892367 | 216 | This tracer hooks to various trace points in the kernel, |
b77e38aa | 217 | allowing the user to pick and choose which trace point they |
897f17a6 | 218 | want to trace. It also includes the sched_switch tracer plugin. |
a7abe97f | 219 | |
ee08c6ec FW |
220 | config FTRACE_SYSCALLS |
221 | bool "Trace syscalls" | |
66700001 | 222 | depends on HAVE_SYSCALL_TRACEPOINTS |
5e0a0939 | 223 | select GENERIC_TRACER |
0ea1c415 | 224 | select KALLSYMS |
ee08c6ec FW |
225 | help |
226 | Basic tracer to catch the syscall entry and exit events. | |
227 | ||
2ed84eeb | 228 | config TRACE_BRANCH_PROFILING |
9ae5b879 | 229 | bool |
5e0a0939 | 230 | select GENERIC_TRACER |
9ae5b879 SR |
231 | |
232 | choice | |
233 | prompt "Branch Profiling" | |
234 | default BRANCH_PROFILE_NONE | |
235 | help | |
236 | The branch profiling is a software profiler. It will add hooks | |
237 | into the C conditionals to test which path a branch takes. | |
238 | ||
239 | The likely/unlikely profiler only looks at the conditions that | |
240 | are annotated with a likely or unlikely macro. | |
241 | ||
40892367 | 242 | The "all branch" profiler will profile every if-statement in the |
9ae5b879 | 243 | kernel. This profiler will also enable the likely/unlikely |
40892367 | 244 | profiler. |
9ae5b879 | 245 | |
40892367 RD |
246 | Either of the above profilers adds a bit of overhead to the system. |
247 | If unsure, choose "No branch profiling". | |
9ae5b879 SR |
248 | |
249 | config BRANCH_PROFILE_NONE | |
250 | bool "No branch profiling" | |
251 | help | |
40892367 RD |
252 | No branch profiling. Branch profiling adds a bit of overhead. |
253 | Only enable it if you want to analyse the branching behavior. | |
254 | Otherwise keep it disabled. | |
9ae5b879 SR |
255 | |
256 | config PROFILE_ANNOTATED_BRANCHES | |
257 | bool "Trace likely/unlikely profiler" | |
258 | select TRACE_BRANCH_PROFILING | |
1f0d69a9 SR |
259 | help |
260 | This tracer profiles all the the likely and unlikely macros | |
261 | in the kernel. It will display the results in: | |
262 | ||
156f5a78 | 263 | /sys/kernel/debug/tracing/profile_annotated_branch |
1f0d69a9 | 264 | |
40892367 | 265 | Note: this will add a significant overhead; only turn this |
1f0d69a9 SR |
266 | on if you need to profile the system's use of these macros. |
267 | ||
2bcd521a SR |
268 | config PROFILE_ALL_BRANCHES |
269 | bool "Profile all if conditionals" | |
9ae5b879 | 270 | select TRACE_BRANCH_PROFILING |
2bcd521a SR |
271 | help |
272 | This tracer profiles all branch conditions. Every if () | |
273 | taken in the kernel is recorded whether it hit or miss. | |
274 | The results will be displayed in: | |
275 | ||
156f5a78 | 276 | /sys/kernel/debug/tracing/profile_branch |
2bcd521a | 277 | |
9ae5b879 SR |
278 | This option also enables the likely/unlikely profiler. |
279 | ||
2bcd521a SR |
280 | This configuration, when enabled, will impose a great overhead |
281 | on the system. This should only be enabled when the system | |
40892367 | 282 | is to be analyzed in much detail. |
9ae5b879 | 283 | endchoice |
2bcd521a | 284 | |
2ed84eeb | 285 | config TRACING_BRANCHES |
52f232cb SR |
286 | bool |
287 | help | |
288 | Selected by tracers that will trace the likely and unlikely | |
289 | conditions. This prevents the tracers themselves from being | |
290 | profiled. Profiling the tracing infrastructure can only happen | |
291 | when the likelys and unlikelys are not being traced. | |
292 | ||
2ed84eeb | 293 | config BRANCH_TRACER |
52f232cb | 294 | bool "Trace likely/unlikely instances" |
2ed84eeb SR |
295 | depends on TRACE_BRANCH_PROFILING |
296 | select TRACING_BRANCHES | |
52f232cb SR |
297 | help |
298 | This traces the events of likely and unlikely condition | |
299 | calls in the kernel. The difference between this and the | |
300 | "Trace likely/unlikely profiler" is that this is not a | |
301 | histogram of the callers, but actually places the calling | |
302 | events into a running trace buffer to see when and where the | |
303 | events happened, as well as their results. | |
304 | ||
305 | Say N if unsure. | |
306 | ||
e5a81b62 SR |
307 | config STACK_TRACER |
308 | bool "Trace max stack" | |
606576ce | 309 | depends on HAVE_FUNCTION_TRACER |
606576ce | 310 | select FUNCTION_TRACER |
e5a81b62 | 311 | select STACKTRACE |
4d7a077c | 312 | select KALLSYMS |
e5a81b62 | 313 | help |
4519d9e5 | 314 | This special tracer records the maximum stack footprint of the |
156f5a78 | 315 | kernel and displays it in /sys/kernel/debug/tracing/stack_trace. |
4519d9e5 IM |
316 | |
317 | This tracer works by hooking into every function call that the | |
318 | kernel executes, and keeping a maximum stack depth value and | |
f38f1d2a SR |
319 | stack-trace saved. If this is configured with DYNAMIC_FTRACE |
320 | then it will not have any overhead while the stack tracer | |
321 | is disabled. | |
322 | ||
323 | To enable the stack tracer on bootup, pass in 'stacktrace' | |
324 | on the kernel command line. | |
325 | ||
326 | The stack tracer can also be enabled or disabled via the | |
327 | sysctl kernel.stack_tracer_enabled | |
4519d9e5 IM |
328 | |
329 | Say N if unsure. | |
e5a81b62 | 330 | |
2db270a8 | 331 | config BLK_DEV_IO_TRACE |
40892367 | 332 | bool "Support for tracing block IO actions" |
2db270a8 | 333 | depends on SYSFS |
1dfba05d | 334 | depends on BLOCK |
2db270a8 FW |
335 | select RELAY |
336 | select DEBUG_FS | |
337 | select TRACEPOINTS | |
5e0a0939 | 338 | select GENERIC_TRACER |
2db270a8 FW |
339 | select STACKTRACE |
340 | help | |
341 | Say Y here if you want to be able to trace the block layer actions | |
342 | on a given queue. Tracing allows you to see any traffic happening | |
343 | on a block device queue. For more information (and the userspace | |
344 | support tools needed), fetch the blktrace tools from: | |
345 | ||
346 | git://git.kernel.dk/blktrace.git | |
347 | ||
348 | Tracing also is possible using the ftrace interface, e.g.: | |
349 | ||
350 | echo 1 > /sys/block/sda/sda1/trace/enable | |
351 | echo blk > /sys/kernel/debug/tracing/current_tracer | |
352 | cat /sys/kernel/debug/tracing/trace_pipe | |
353 | ||
354 | If unsure, say N. | |
36994e58 | 355 | |
77b44d1b | 356 | config KPROBE_EVENT |
413d37d1 | 357 | depends on KPROBES |
f850c30c | 358 | depends on HAVE_REGS_AND_STACK_ACCESS_API |
77b44d1b | 359 | bool "Enable kprobes-based dynamic events" |
413d37d1 | 360 | select TRACING |
77b44d1b | 361 | default y |
413d37d1 | 362 | help |
40892367 RD |
363 | This allows the user to add tracing events (similar to tracepoints) |
364 | on the fly via the ftrace interface. See | |
365 | Documentation/trace/kprobetrace.txt for more details. | |
77b44d1b MH |
366 | |
367 | Those events can be inserted wherever kprobes can probe, and record | |
368 | various register and memory values. | |
369 | ||
40892367 RD |
370 | This option is also required by perf-probe subcommand of perf tools. |
371 | If you want to use perf tools, this option is strongly recommended. | |
413d37d1 | 372 | |
3d083395 SR |
373 | config DYNAMIC_FTRACE |
374 | bool "enable/disable ftrace tracepoints dynamically" | |
606576ce | 375 | depends on FUNCTION_TRACER |
677aa9f7 | 376 | depends on HAVE_DYNAMIC_FTRACE |
3d083395 SR |
377 | default y |
378 | help | |
40892367 RD |
379 | This option will modify all the calls to ftrace dynamically |
380 | (will patch them out of the binary image and replace them | |
381 | with a No-Op instruction) as they are called. A table is | |
382 | created to dynamically enable them again. | |
3d083395 | 383 | |
40892367 RD |
384 | This way a CONFIG_FUNCTION_TRACER kernel is slightly larger, but |
385 | otherwise has native performance as long as no tracing is active. | |
3d083395 | 386 | |
40892367 RD |
387 | The changes to the code are done by a kernel thread that |
388 | wakes up once a second and checks to see if any ftrace calls | |
389 | were made. If so, it runs stop_machine (stops all CPUS) | |
390 | and modifies the code to jump over the call to ftrace. | |
60a11774 | 391 | |
bac429f0 SR |
392 | config FUNCTION_PROFILER |
393 | bool "Kernel function profiler" | |
493762fc | 394 | depends on FUNCTION_TRACER |
bac429f0 SR |
395 | default n |
396 | help | |
40892367 RD |
397 | This option enables the kernel function profiler. A file is created |
398 | in debugfs called function_profile_enabled which defaults to zero. | |
399 | When a 1 is echoed into this file profiling begins, and when a | |
400 | zero is entered, profiling stops. A "functions" file is created in | |
401 | the trace_stats directory; this file shows the list of functions that | |
402 | have been hit and their counters. | |
bac429f0 | 403 | |
40892367 | 404 | If in doubt, say N. |
bac429f0 | 405 | |
8da3821b SR |
406 | config FTRACE_MCOUNT_RECORD |
407 | def_bool y | |
408 | depends on DYNAMIC_FTRACE | |
409 | depends on HAVE_FTRACE_MCOUNT_RECORD | |
410 | ||
60a11774 SR |
411 | config FTRACE_SELFTEST |
412 | bool | |
413 | ||
414 | config FTRACE_STARTUP_TEST | |
415 | bool "Perform a startup test on ftrace" | |
5e0a0939 | 416 | depends on GENERIC_TRACER |
60a11774 SR |
417 | select FTRACE_SELFTEST |
418 | help | |
419 | This option performs a series of startup tests on ftrace. On bootup | |
420 | a series of tests are made to verify that the tracer is | |
421 | functioning properly. It will do tests on all the configured | |
422 | tracers of ftrace. | |
17d80fd0 | 423 | |
1f5a6b45 SR |
424 | config EVENT_TRACE_TEST_SYSCALLS |
425 | bool "Run selftest on syscall events" | |
426 | depends on FTRACE_STARTUP_TEST | |
427 | help | |
428 | This option will also enable testing every syscall event. | |
429 | It only enables the event and disables it and runs various loads | |
430 | with the event enabled. This adds a bit more time for kernel boot | |
431 | up since it runs this on every system call defined. | |
432 | ||
433 | TBD - enable a way to actually call the syscalls as we test their | |
434 | events | |
435 | ||
fe6f90e5 PP |
436 | config MMIOTRACE |
437 | bool "Memory mapped IO tracing" | |
40ada30f | 438 | depends on HAVE_MMIOTRACE_SUPPORT && PCI |
5e0a0939 | 439 | select GENERIC_TRACER |
fe6f90e5 PP |
440 | help |
441 | Mmiotrace traces Memory Mapped I/O access and is meant for | |
442 | debugging and reverse engineering. It is called from the ioremap | |
443 | implementation and works via page faults. Tracing is disabled by | |
444 | default and can be enabled at run-time. | |
445 | ||
4d1f4372 | 446 | See Documentation/trace/mmiotrace.txt. |
fe6f90e5 PP |
447 | If you are not helping to develop drivers, say N. |
448 | ||
449 | config MMIOTRACE_TEST | |
450 | tristate "Test module for mmiotrace" | |
451 | depends on MMIOTRACE && m | |
452 | help | |
453 | This is a dumb module for testing mmiotrace. It is very dangerous | |
454 | as it will write garbage to IO memory starting at a given address. | |
455 | However, it should be safe to use on e.g. unused portion of VRAM. | |
456 | ||
457 | Say N, unless you absolutely know what you are doing. | |
458 | ||
5092dbc9 SR |
459 | config RING_BUFFER_BENCHMARK |
460 | tristate "Ring buffer benchmark stress tester" | |
461 | depends on RING_BUFFER | |
462 | help | |
40892367 RD |
463 | This option creates a test to stress the ring buffer and benchmark it. |
464 | It creates its own ring buffer such that it will not interfere with | |
5092dbc9 SR |
465 | any other users of the ring buffer (such as ftrace). It then creates |
466 | a producer and consumer that will run for 10 seconds and sleep for | |
467 | 10 seconds. Each interval it will print out the number of events | |
468 | it recorded and give a rough estimate of how long each iteration took. | |
469 | ||
470 | It does not disable interrupts or raise its priority, so it may be | |
471 | affected by processes that are running. | |
472 | ||
40892367 | 473 | If unsure, say N. |
5092dbc9 | 474 | |
4ed9f071 | 475 | endif # FTRACE |
40ada30f IM |
476 | |
477 | endif # TRACING_SUPPORT | |
478 |