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