Thomas Gleixner | ec8f24b | 2019-05-19 13:07:45 +0100 | [diff] [blame] | 1 | # SPDX-License-Identifier: GPL-2.0-only |
Arnaldo Carvalho de Melo | 16444a8 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 2 | # |
Steven Rostedt | 606576c | 2008-10-06 19:06:12 -0400 | [diff] [blame] | 3 | # Architectures that offer an FUNCTION_TRACER implementation should |
| 4 | # select HAVE_FUNCTION_TRACER: |
Arnaldo Carvalho de Melo | 16444a8 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 5 | # |
Frédéric Weisbecker | 2a3a4f6 | 2008-09-21 20:12:14 +0200 | [diff] [blame] | 6 | |
Török Edwin | 8d26487 | 2008-11-23 12:39:08 +0200 | [diff] [blame] | 7 | config USER_STACKTRACE_SUPPORT |
| 8 | bool |
| 9 | |
Frédéric Weisbecker | 2a3a4f6 | 2008-09-21 20:12:14 +0200 | [diff] [blame] | 10 | config NOP_TRACER |
| 11 | bool |
| 12 | |
Steven Rostedt | 78d904b | 2009-02-05 18:43:07 -0500 | [diff] [blame] | 13 | config HAVE_FTRACE_NMI_ENTER |
| 14 | bool |
Mike Frysinger | 555f386 | 2009-09-14 20:10:15 -0400 | [diff] [blame] | 15 | help |
Mauro Carvalho Chehab | 5fb94e9 | 2018-05-08 15:14:57 -0300 | [diff] [blame] | 16 | See Documentation/trace/ftrace-design.rst |
Steven Rostedt | 78d904b | 2009-02-05 18:43:07 -0500 | [diff] [blame] | 17 | |
Steven Rostedt | 606576c | 2008-10-06 19:06:12 -0400 | [diff] [blame] | 18 | config HAVE_FUNCTION_TRACER |
Arnaldo Carvalho de Melo | 16444a8 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 19 | bool |
Mike Frysinger | 555f386 | 2009-09-14 20:10:15 -0400 | [diff] [blame] | 20 | help |
Mauro Carvalho Chehab | 5fb94e9 | 2018-05-08 15:14:57 -0300 | [diff] [blame] | 21 | See Documentation/trace/ftrace-design.rst |
Steven Rostedt | bc0c38d | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 22 | |
Frederic Weisbecker | fb52607 | 2008-11-25 21:07:04 +0100 | [diff] [blame] | 23 | config HAVE_FUNCTION_GRAPH_TRACER |
Frederic Weisbecker | 15e6cb3 | 2008-11-11 07:14:25 +0100 | [diff] [blame] | 24 | bool |
Mike Frysinger | 555f386 | 2009-09-14 20:10:15 -0400 | [diff] [blame] | 25 | help |
Mauro Carvalho Chehab | 5fb94e9 | 2018-05-08 15:14:57 -0300 | [diff] [blame] | 26 | See Documentation/trace/ftrace-design.rst |
Frederic Weisbecker | 15e6cb3 | 2008-11-11 07:14:25 +0100 | [diff] [blame] | 27 | |
Steven Rostedt | 677aa9f | 2008-05-17 00:01:36 -0400 | [diff] [blame] | 28 | config HAVE_DYNAMIC_FTRACE |
| 29 | bool |
Mike Frysinger | 555f386 | 2009-09-14 20:10:15 -0400 | [diff] [blame] | 30 | help |
Mauro Carvalho Chehab | 5fb94e9 | 2018-05-08 15:14:57 -0300 | [diff] [blame] | 31 | See Documentation/trace/ftrace-design.rst |
Steven Rostedt | 677aa9f | 2008-05-17 00:01:36 -0400 | [diff] [blame] | 32 | |
Masami Hiramatsu | 06aeaae | 2012-09-28 17:15:17 +0900 | [diff] [blame] | 33 | config HAVE_DYNAMIC_FTRACE_WITH_REGS |
| 34 | bool |
| 35 | |
Steven Rostedt (VMware) | 763e34e | 2019-11-08 13:07:06 -0500 | [diff] [blame^] | 36 | config HAVE_DYNAMIC_FTRACE_WITH_DIRECT_CALLS |
| 37 | bool |
| 38 | |
Steven Rostedt | 8da3821 | 2008-08-14 15:45:07 -0400 | [diff] [blame] | 39 | config HAVE_FTRACE_MCOUNT_RECORD |
| 40 | bool |
Mike Frysinger | 555f386 | 2009-09-14 20:10:15 -0400 | [diff] [blame] | 41 | help |
Mauro Carvalho Chehab | 5fb94e9 | 2018-05-08 15:14:57 -0300 | [diff] [blame] | 42 | See Documentation/trace/ftrace-design.rst |
Steven Rostedt | 8da3821 | 2008-08-14 15:45:07 -0400 | [diff] [blame] | 43 | |
Josh Stone | 6670000 | 2009-08-24 14:43:11 -0700 | [diff] [blame] | 44 | config HAVE_SYSCALL_TRACEPOINTS |
Frederic Weisbecker | ee08c6e | 2009-03-07 05:52:59 +0100 | [diff] [blame] | 45 | bool |
Mike Frysinger | 555f386 | 2009-09-14 20:10:15 -0400 | [diff] [blame] | 46 | help |
Mauro Carvalho Chehab | 5fb94e9 | 2018-05-08 15:14:57 -0300 | [diff] [blame] | 47 | See Documentation/trace/ftrace-design.rst |
Frederic Weisbecker | ee08c6e | 2009-03-07 05:52:59 +0100 | [diff] [blame] | 48 | |
Steven Rostedt | a2546fa | 2011-02-09 13:15:59 -0500 | [diff] [blame] | 49 | config HAVE_FENTRY |
| 50 | bool |
| 51 | help |
| 52 | Arch supports the gcc options -pg with -mfentry |
| 53 | |
Vasily Gorbik | 2f4df00 | 2018-08-06 15:17:46 +0200 | [diff] [blame] | 54 | config HAVE_NOP_MCOUNT |
| 55 | bool |
| 56 | help |
| 57 | Arch supports the gcc options -pg with -mrecord-mcount and -nop-mcount |
| 58 | |
Steven Rostedt | cf4db25 | 2010-10-14 23:32:44 -0400 | [diff] [blame] | 59 | config HAVE_C_RECORDMCOUNT |
Steven Rostedt | 72441cb | 2010-10-13 17:12:30 -0400 | [diff] [blame] | 60 | bool |
| 61 | help |
| 62 | C version of recordmcount available? |
| 63 | |
Steven Rostedt | 352ad25 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 64 | config TRACER_MAX_TRACE |
| 65 | bool |
| 66 | |
Josh Triplett | ea632e9 | 2012-09-02 19:45:14 -0700 | [diff] [blame] | 67 | config TRACE_CLOCK |
| 68 | bool |
| 69 | |
Steven Rostedt | 7a8e76a | 2008-09-29 23:02:38 -0400 | [diff] [blame] | 70 | config RING_BUFFER |
| 71 | bool |
Josh Triplett | ea632e9 | 2012-09-02 19:45:14 -0700 | [diff] [blame] | 72 | select TRACE_CLOCK |
Steven Rostedt (Red Hat) | 2228768 | 2013-05-03 11:16:18 -0400 | [diff] [blame] | 73 | select IRQ_WORK |
Steven Rostedt | 7a8e76a | 2008-09-29 23:02:38 -0400 | [diff] [blame] | 74 | |
Steven Rostedt | 78d904b | 2009-02-05 18:43:07 -0500 | [diff] [blame] | 75 | config FTRACE_NMI_ENTER |
| 76 | bool |
| 77 | depends on HAVE_FTRACE_NMI_ENTER |
| 78 | default y |
| 79 | |
Tom Zanussi | 5f77a88 | 2009-04-08 03:14:01 -0500 | [diff] [blame] | 80 | config EVENT_TRACING |
Zhaolei | b11c53e | 2009-05-25 18:11:59 +0800 | [diff] [blame] | 81 | select CONTEXT_SWITCH_TRACER |
Masami Hiramatsu | 60f1d5e | 2016-10-05 20:58:15 +0900 | [diff] [blame] | 82 | select GLOB |
Zhaolei | b11c53e | 2009-05-25 18:11:59 +0800 | [diff] [blame] | 83 | bool |
| 84 | |
| 85 | config CONTEXT_SWITCH_TRACER |
Tom Zanussi | 5f77a88 | 2009-04-08 03:14:01 -0500 | [diff] [blame] | 86 | bool |
| 87 | |
Steven Rostedt | 85bac32 | 2009-09-04 14:24:40 -0400 | [diff] [blame] | 88 | config RING_BUFFER_ALLOW_SWAP |
| 89 | bool |
| 90 | help |
| 91 | Allow the use of ring_buffer_swap_cpu. |
| 92 | Adds a very slight overhead to tracing when enabled. |
| 93 | |
Joel Fernandes (Google) | c3bc8fd | 2018-07-30 15:24:23 -0700 | [diff] [blame] | 94 | config PREEMPTIRQ_TRACEPOINTS |
| 95 | bool |
| 96 | depends on TRACE_PREEMPT_TOGGLE || TRACE_IRQFLAGS |
| 97 | select TRACING |
| 98 | default y |
| 99 | help |
| 100 | Create preempt/irq toggle tracepoints if needed, so that other parts |
| 101 | of the kernel can use them to generate or add hooks to them. |
| 102 | |
Steven Rostedt | 5e0a093 | 2009-05-28 15:50:13 -0400 | [diff] [blame] | 103 | # All tracer options should select GENERIC_TRACER. For those options that are |
| 104 | # enabled by all tracers (context switch and event tracer) they select TRACING. |
| 105 | # This allows those options to appear when no other tracer is selected. But the |
| 106 | # options do not appear when something else selects it. We need the two options |
| 107 | # GENERIC_TRACER and TRACING to avoid circular dependencies to accomplish the |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 108 | # hiding of the automatic options. |
Steven Rostedt | 5e0a093 | 2009-05-28 15:50:13 -0400 | [diff] [blame] | 109 | |
Steven Rostedt | bc0c38d | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 110 | config TRACING |
| 111 | bool |
| 112 | select DEBUG_FS |
Steven Rostedt | 7a8e76a | 2008-09-29 23:02:38 -0400 | [diff] [blame] | 113 | select RING_BUFFER |
Al Viro | c2c8052 | 2008-10-31 19:50:41 +0000 | [diff] [blame] | 114 | select STACKTRACE if STACKTRACE_SUPPORT |
Ingo Molnar | 5f87f11 | 2008-07-23 14:15:22 +0200 | [diff] [blame] | 115 | select TRACEPOINTS |
Steven Rostedt | f3384b2 | 2008-10-29 11:15:57 -0400 | [diff] [blame] | 116 | select NOP_TRACER |
Frederic Weisbecker | 769b044 | 2009-03-06 17:21:49 +0100 | [diff] [blame] | 117 | select BINARY_PRINTF |
Tom Zanussi | 5f77a88 | 2009-04-08 03:14:01 -0500 | [diff] [blame] | 118 | select EVENT_TRACING |
Josh Triplett | ea632e9 | 2012-09-02 19:45:14 -0700 | [diff] [blame] | 119 | select TRACE_CLOCK |
Steven Rostedt | bc0c38d | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 120 | |
Steven Rostedt | 5e0a093 | 2009-05-28 15:50:13 -0400 | [diff] [blame] | 121 | config GENERIC_TRACER |
| 122 | bool |
| 123 | select TRACING |
| 124 | |
Ingo Molnar | 40ada30 | 2009-03-05 21:19:55 +0100 | [diff] [blame] | 125 | # |
| 126 | # Minimum requirements an architecture has to meet for us to |
| 127 | # be able to offer generic tracing facilities: |
| 128 | # |
| 129 | config TRACING_SUPPORT |
| 130 | bool |
Michael Ellerman | 0ea5ee0 | 2018-05-02 21:29:48 +1000 | [diff] [blame] | 131 | depends on TRACE_IRQFLAGS_SUPPORT |
Ingo Molnar | 40ada30 | 2009-03-05 21:19:55 +0100 | [diff] [blame] | 132 | depends on STACKTRACE_SUPPORT |
KOSAKI Motohiro | 422d3c7 | 2009-03-06 10:40:53 +0900 | [diff] [blame] | 133 | default y |
Ingo Molnar | 40ada30 | 2009-03-05 21:19:55 +0100 | [diff] [blame] | 134 | |
| 135 | if TRACING_SUPPORT |
| 136 | |
Steven Rostedt | 4ed9f07 | 2009-04-20 10:47:36 -0400 | [diff] [blame] | 137 | menuconfig FTRACE |
| 138 | bool "Tracers" |
Steven Rostedt | 65b7724 | 2009-05-07 12:49:27 -0400 | [diff] [blame] | 139 | default y if DEBUG_KERNEL |
Steven Rostedt | 4ed9f07 | 2009-04-20 10:47:36 -0400 | [diff] [blame] | 140 | help |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 141 | Enable the kernel tracing infrastructure. |
Steven Rostedt | 4ed9f07 | 2009-04-20 10:47:36 -0400 | [diff] [blame] | 142 | |
| 143 | if FTRACE |
Peter Zijlstra | 17d80fd | 2008-10-21 16:31:18 +0200 | [diff] [blame] | 144 | |
Steven Rostedt | 606576c | 2008-10-06 19:06:12 -0400 | [diff] [blame] | 145 | config FUNCTION_TRACER |
Steven Rostedt | 1b29b01 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 146 | bool "Kernel Function Tracer" |
Steven Rostedt | 606576c | 2008-10-06 19:06:12 -0400 | [diff] [blame] | 147 | depends on HAVE_FUNCTION_TRACER |
Steven Rostedt | 4d7a077 | 2009-02-18 22:06:18 -0500 | [diff] [blame] | 148 | select KALLSYMS |
Steven Rostedt | 5e0a093 | 2009-05-28 15:50:13 -0400 | [diff] [blame] | 149 | select GENERIC_TRACER |
Steven Rostedt | 35e8e30 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 150 | select CONTEXT_SWITCH_TRACER |
Steven Rostedt (VMware) | 0598e4f | 2017-04-06 10:28:12 -0400 | [diff] [blame] | 151 | select GLOB |
Thomas Gleixner | 01b1d88 | 2019-07-26 23:19:38 +0200 | [diff] [blame] | 152 | select TASKS_RCU if PREEMPTION |
Steven Rostedt | 1b29b01 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 153 | help |
| 154 | Enable the kernel to trace every kernel function. This is done |
| 155 | by using a compiler feature to insert a small, 5-byte No-Operation |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 156 | instruction at the beginning of every kernel function, which NOP |
Steven Rostedt | 1b29b01 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 157 | sequence is then dynamically patched into a tracer call when |
| 158 | tracing is enabled by the administrator. If it's runtime disabled |
| 159 | (the bootup default), then the overhead of the instructions is very |
| 160 | small and not measurable even in micro-benchmarks. |
Steven Rostedt | 35e8e30 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 161 | |
Frederic Weisbecker | fb52607 | 2008-11-25 21:07:04 +0100 | [diff] [blame] | 162 | config FUNCTION_GRAPH_TRACER |
| 163 | bool "Kernel Function Graph Tracer" |
| 164 | depends on HAVE_FUNCTION_GRAPH_TRACER |
Frederic Weisbecker | 15e6cb3 | 2008-11-11 07:14:25 +0100 | [diff] [blame] | 165 | depends on FUNCTION_TRACER |
Steven Rostedt | eb4a037 | 2009-06-18 12:53:21 -0400 | [diff] [blame] | 166 | depends on !X86_32 || !CC_OPTIMIZE_FOR_SIZE |
Ingo Molnar | 764f3b9 | 2008-12-03 10:33:58 +0100 | [diff] [blame] | 167 | default y |
Frederic Weisbecker | 15e6cb3 | 2008-11-11 07:14:25 +0100 | [diff] [blame] | 168 | help |
Frederic Weisbecker | fb52607 | 2008-11-25 21:07:04 +0100 | [diff] [blame] | 169 | Enable the kernel to trace a function at both its return |
| 170 | and its entry. |
Matt LaPlante | 692105b | 2009-01-26 11:12:25 +0100 | [diff] [blame] | 171 | Its first purpose is to trace the duration of functions and |
| 172 | draw a call graph for each thread with some information like |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 173 | the return value. This is done by setting the current return |
Matt LaPlante | 692105b | 2009-01-26 11:12:25 +0100 | [diff] [blame] | 174 | address on the current task structure into a stack of calls. |
Frederic Weisbecker | 15e6cb3 | 2008-11-11 07:14:25 +0100 | [diff] [blame] | 175 | |
Joel Fernandes (Google) | c3bc8fd | 2018-07-30 15:24:23 -0700 | [diff] [blame] | 176 | config TRACE_PREEMPT_TOGGLE |
| 177 | bool |
| 178 | help |
| 179 | Enables hooks which will be called when preemption is first disabled, |
| 180 | and last enabled. |
Steven Rostedt | bac429f | 2009-03-20 12:50:56 -0400 | [diff] [blame] | 181 | |
Joel Fernandes | d591581 | 2017-10-10 15:51:37 -0700 | [diff] [blame] | 182 | config PREEMPTIRQ_EVENTS |
| 183 | bool "Enable trace events for preempt and irq disable/enable" |
| 184 | select TRACE_IRQFLAGS |
Thomas Gleixner | 30c9370 | 2019-07-26 23:19:40 +0200 | [diff] [blame] | 185 | select TRACE_PREEMPT_TOGGLE if PREEMPTION |
Joel Fernandes (Google) | c3bc8fd | 2018-07-30 15:24:23 -0700 | [diff] [blame] | 186 | select GENERIC_TRACER |
Joel Fernandes | d591581 | 2017-10-10 15:51:37 -0700 | [diff] [blame] | 187 | default n |
| 188 | help |
| 189 | Enable tracing of disable and enable events for preemption and irqs. |
Joel Fernandes | d591581 | 2017-10-10 15:51:37 -0700 | [diff] [blame] | 190 | |
Steven Rostedt | 81d68a9 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 191 | config IRQSOFF_TRACER |
| 192 | bool "Interrupts-off Latency Tracer" |
| 193 | default n |
| 194 | depends on TRACE_IRQFLAGS_SUPPORT |
John Stultz | 592913e | 2010-07-13 17:56:20 -0700 | [diff] [blame] | 195 | depends on !ARCH_USES_GETTIMEOFFSET |
Steven Rostedt | 81d68a9 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 196 | select TRACE_IRQFLAGS |
Steven Rostedt | 5e0a093 | 2009-05-28 15:50:13 -0400 | [diff] [blame] | 197 | select GENERIC_TRACER |
Steven Rostedt | 81d68a9 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 198 | select TRACER_MAX_TRACE |
Steven Rostedt | 85bac32 | 2009-09-04 14:24:40 -0400 | [diff] [blame] | 199 | select RING_BUFFER_ALLOW_SWAP |
Steven Rostedt (Red Hat) | 22cffc2 | 2013-03-05 07:30:24 -0500 | [diff] [blame] | 200 | select TRACER_SNAPSHOT |
Steven Rostedt (Red Hat) | 0b85ffc | 2013-03-05 14:50:23 -0500 | [diff] [blame] | 201 | select TRACER_SNAPSHOT_PER_CPU_SWAP |
Steven Rostedt | 81d68a9 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 202 | help |
| 203 | This option measures the time spent in irqs-off critical |
| 204 | sections, with microsecond accuracy. |
| 205 | |
| 206 | The default measurement method is a maximum search, which is |
| 207 | disabled by default and can be runtime (re-)started |
| 208 | via: |
| 209 | |
GeunSik Lim | 156f5a7 | 2009-06-02 15:01:37 +0900 | [diff] [blame] | 210 | echo 0 > /sys/kernel/debug/tracing/tracing_max_latency |
Steven Rostedt | 81d68a9 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 211 | |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 212 | (Note that kernel size and overhead increase with this option |
Steven Rostedt | 6cd8a4b | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 213 | enabled. This option and the preempt-off timing option can be |
| 214 | used together or separately.) |
| 215 | |
| 216 | config PREEMPT_TRACER |
| 217 | bool "Preemption-off Latency Tracer" |
| 218 | default n |
John Stultz | 592913e | 2010-07-13 17:56:20 -0700 | [diff] [blame] | 219 | depends on !ARCH_USES_GETTIMEOFFSET |
Thomas Gleixner | 30c9370 | 2019-07-26 23:19:40 +0200 | [diff] [blame] | 220 | depends on PREEMPTION |
Steven Rostedt | 5e0a093 | 2009-05-28 15:50:13 -0400 | [diff] [blame] | 221 | select GENERIC_TRACER |
Steven Rostedt | 6cd8a4b | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 222 | select TRACER_MAX_TRACE |
Steven Rostedt | 85bac32 | 2009-09-04 14:24:40 -0400 | [diff] [blame] | 223 | select RING_BUFFER_ALLOW_SWAP |
Steven Rostedt (Red Hat) | 22cffc2 | 2013-03-05 07:30:24 -0500 | [diff] [blame] | 224 | select TRACER_SNAPSHOT |
Steven Rostedt (Red Hat) | 0b85ffc | 2013-03-05 14:50:23 -0500 | [diff] [blame] | 225 | select TRACER_SNAPSHOT_PER_CPU_SWAP |
Joel Fernandes (Google) | c3bc8fd | 2018-07-30 15:24:23 -0700 | [diff] [blame] | 226 | select TRACE_PREEMPT_TOGGLE |
Steven Rostedt | 6cd8a4b | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 227 | help |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 228 | This option measures the time spent in preemption-off critical |
Steven Rostedt | 6cd8a4b | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 229 | sections, with microsecond accuracy. |
| 230 | |
| 231 | The default measurement method is a maximum search, which is |
| 232 | disabled by default and can be runtime (re-)started |
| 233 | via: |
| 234 | |
GeunSik Lim | 156f5a7 | 2009-06-02 15:01:37 +0900 | [diff] [blame] | 235 | echo 0 > /sys/kernel/debug/tracing/tracing_max_latency |
Steven Rostedt | 6cd8a4b | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 236 | |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 237 | (Note that kernel size and overhead increase with this option |
Steven Rostedt | 6cd8a4b | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 238 | enabled. This option and the irqs-off timing option can be |
| 239 | used together or separately.) |
| 240 | |
Steven Rostedt | 352ad25 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 241 | config SCHED_TRACER |
| 242 | bool "Scheduling Latency Tracer" |
Steven Rostedt | 5e0a093 | 2009-05-28 15:50:13 -0400 | [diff] [blame] | 243 | select GENERIC_TRACER |
Steven Rostedt | 352ad25 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 244 | select CONTEXT_SWITCH_TRACER |
| 245 | select TRACER_MAX_TRACE |
Steven Rostedt (Red Hat) | 22cffc2 | 2013-03-05 07:30:24 -0500 | [diff] [blame] | 246 | select TRACER_SNAPSHOT |
Steven Rostedt | 352ad25 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 247 | help |
| 248 | This tracer tracks the latency of the highest priority task |
| 249 | to be scheduled in, starting from the point it has woken up. |
| 250 | |
Steven Rostedt (Red Hat) | e7c15cd | 2016-06-23 12:45:36 -0400 | [diff] [blame] | 251 | config HWLAT_TRACER |
| 252 | bool "Tracer to detect hardware latencies (like SMIs)" |
| 253 | select GENERIC_TRACER |
| 254 | help |
| 255 | This tracer, when enabled will create one or more kernel threads, |
Jesper Dangaard Brouer | c5c1ea7 | 2017-06-13 13:06:59 +0200 | [diff] [blame] | 256 | depending on what the cpumask file is set to, which each thread |
Steven Rostedt (Red Hat) | e7c15cd | 2016-06-23 12:45:36 -0400 | [diff] [blame] | 257 | spinning in a loop looking for interruptions caused by |
| 258 | something other than the kernel. For example, if a |
| 259 | System Management Interrupt (SMI) takes a noticeable amount of |
| 260 | time, this tracer will detect it. This is useful for testing |
| 261 | if a system is reliable for Real Time tasks. |
| 262 | |
| 263 | Some files are created in the tracing directory when this |
| 264 | is enabled: |
| 265 | |
| 266 | hwlat_detector/width - time in usecs for how long to spin for |
| 267 | hwlat_detector/window - time in usecs between the start of each |
| 268 | iteration |
| 269 | |
| 270 | A kernel thread is created that will spin with interrupts disabled |
Jesper Dangaard Brouer | c5c1ea7 | 2017-06-13 13:06:59 +0200 | [diff] [blame] | 271 | for "width" microseconds in every "window" cycle. It will not spin |
Steven Rostedt (Red Hat) | e7c15cd | 2016-06-23 12:45:36 -0400 | [diff] [blame] | 272 | for "window - width" microseconds, where the system can |
| 273 | continue to operate. |
| 274 | |
| 275 | The output will appear in the trace and trace_pipe files. |
| 276 | |
| 277 | When the tracer is not running, it has no affect on the system, |
| 278 | but when it is running, it can cause the system to be |
| 279 | periodically non responsive. Do not run this tracer on a |
| 280 | production system. |
| 281 | |
| 282 | To enable this tracer, echo in "hwlat" into the current_tracer |
| 283 | file. Every time a latency is greater than tracing_thresh, it will |
| 284 | be recorded into the ring buffer. |
| 285 | |
Steven Rostedt | 897f17a | 2009-05-28 16:31:21 -0400 | [diff] [blame] | 286 | config ENABLE_DEFAULT_TRACERS |
| 287 | bool "Trace process context switches and events" |
Steven Rostedt | 5e0a093 | 2009-05-28 15:50:13 -0400 | [diff] [blame] | 288 | depends on !GENERIC_TRACER |
Steven Rostedt | b77e38a | 2009-02-24 10:21:36 -0500 | [diff] [blame] | 289 | select TRACING |
| 290 | help |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 291 | This tracer hooks to various trace points in the kernel, |
Steven Rostedt | b77e38a | 2009-02-24 10:21:36 -0500 | [diff] [blame] | 292 | allowing the user to pick and choose which trace point they |
Steven Rostedt | 897f17a | 2009-05-28 16:31:21 -0400 | [diff] [blame] | 293 | want to trace. It also includes the sched_switch tracer plugin. |
Steven Rostedt | a7abe97 | 2009-04-20 10:59:34 -0400 | [diff] [blame] | 294 | |
Frederic Weisbecker | ee08c6e | 2009-03-07 05:52:59 +0100 | [diff] [blame] | 295 | config FTRACE_SYSCALLS |
| 296 | bool "Trace syscalls" |
Josh Stone | 6670000 | 2009-08-24 14:43:11 -0700 | [diff] [blame] | 297 | depends on HAVE_SYSCALL_TRACEPOINTS |
Steven Rostedt | 5e0a093 | 2009-05-28 15:50:13 -0400 | [diff] [blame] | 298 | select GENERIC_TRACER |
Frederic Weisbecker | 0ea1c41 | 2009-03-15 22:10:38 +0100 | [diff] [blame] | 299 | select KALLSYMS |
Frederic Weisbecker | ee08c6e | 2009-03-07 05:52:59 +0100 | [diff] [blame] | 300 | help |
| 301 | Basic tracer to catch the syscall entry and exit events. |
| 302 | |
Hiraku Toyooka | debdd57 | 2012-12-26 11:53:00 +0900 | [diff] [blame] | 303 | config TRACER_SNAPSHOT |
| 304 | bool "Create a snapshot trace buffer" |
| 305 | select TRACER_MAX_TRACE |
| 306 | help |
| 307 | Allow tracing users to take snapshot of the current buffer using the |
| 308 | ftrace interface, e.g.: |
| 309 | |
| 310 | echo 1 > /sys/kernel/debug/tracing/snapshot |
| 311 | cat snapshot |
| 312 | |
Steven Rostedt (Red Hat) | 0b85ffc | 2013-03-05 14:50:23 -0500 | [diff] [blame] | 313 | config TRACER_SNAPSHOT_PER_CPU_SWAP |
| 314 | bool "Allow snapshot to swap per CPU" |
| 315 | depends on TRACER_SNAPSHOT |
| 316 | select RING_BUFFER_ALLOW_SWAP |
| 317 | help |
| 318 | Allow doing a snapshot of a single CPU buffer instead of a |
| 319 | full swap (all buffers). If this is set, then the following is |
| 320 | allowed: |
| 321 | |
| 322 | echo 1 > /sys/kernel/debug/tracing/per_cpu/cpu2/snapshot |
| 323 | |
| 324 | After which, only the tracing buffer for CPU 2 was swapped with |
| 325 | the main tracing buffer, and the other CPU buffers remain the same. |
| 326 | |
| 327 | When this is enabled, this adds a little more overhead to the |
| 328 | trace recording, as it needs to add some checks to synchronize |
| 329 | recording with swaps. But this does not affect the performance |
| 330 | of the overall system. This is enabled by default when the preempt |
| 331 | or irq latency tracers are enabled, as those need to swap as well |
| 332 | and already adds the overhead (plus a lot more). |
| 333 | |
Steven Rostedt | 2ed84ee | 2008-11-12 15:24:24 -0500 | [diff] [blame] | 334 | config TRACE_BRANCH_PROFILING |
Steven Rostedt | 9ae5b87 | 2009-04-20 10:27:58 -0400 | [diff] [blame] | 335 | bool |
Steven Rostedt | 5e0a093 | 2009-05-28 15:50:13 -0400 | [diff] [blame] | 336 | select GENERIC_TRACER |
Steven Rostedt | 9ae5b87 | 2009-04-20 10:27:58 -0400 | [diff] [blame] | 337 | |
| 338 | choice |
| 339 | prompt "Branch Profiling" |
| 340 | default BRANCH_PROFILE_NONE |
| 341 | help |
| 342 | The branch profiling is a software profiler. It will add hooks |
| 343 | into the C conditionals to test which path a branch takes. |
| 344 | |
| 345 | The likely/unlikely profiler only looks at the conditions that |
| 346 | are annotated with a likely or unlikely macro. |
| 347 | |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 348 | The "all branch" profiler will profile every if-statement in the |
Steven Rostedt | 9ae5b87 | 2009-04-20 10:27:58 -0400 | [diff] [blame] | 349 | kernel. This profiler will also enable the likely/unlikely |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 350 | profiler. |
Steven Rostedt | 9ae5b87 | 2009-04-20 10:27:58 -0400 | [diff] [blame] | 351 | |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 352 | Either of the above profilers adds a bit of overhead to the system. |
| 353 | If unsure, choose "No branch profiling". |
Steven Rostedt | 9ae5b87 | 2009-04-20 10:27:58 -0400 | [diff] [blame] | 354 | |
| 355 | config BRANCH_PROFILE_NONE |
| 356 | bool "No branch profiling" |
| 357 | help |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 358 | No branch profiling. Branch profiling adds a bit of overhead. |
| 359 | Only enable it if you want to analyse the branching behavior. |
| 360 | Otherwise keep it disabled. |
Steven Rostedt | 9ae5b87 | 2009-04-20 10:27:58 -0400 | [diff] [blame] | 361 | |
| 362 | config PROFILE_ANNOTATED_BRANCHES |
| 363 | bool "Trace likely/unlikely profiler" |
| 364 | select TRACE_BRANCH_PROFILING |
Steven Rostedt | 1f0d69a | 2008-11-12 00:14:39 -0500 | [diff] [blame] | 365 | help |
Masanari Iida | 59bf896 | 2012-04-18 00:01:21 +0900 | [diff] [blame] | 366 | This tracer profiles all likely and unlikely macros |
Steven Rostedt | 1f0d69a | 2008-11-12 00:14:39 -0500 | [diff] [blame] | 367 | in the kernel. It will display the results in: |
| 368 | |
David Rientjes | 13e5bef | 2011-03-16 17:17:08 -0700 | [diff] [blame] | 369 | /sys/kernel/debug/tracing/trace_stat/branch_annotated |
Steven Rostedt | 1f0d69a | 2008-11-12 00:14:39 -0500 | [diff] [blame] | 370 | |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 371 | Note: this will add a significant overhead; only turn this |
Steven Rostedt | 1f0d69a | 2008-11-12 00:14:39 -0500 | [diff] [blame] | 372 | on if you need to profile the system's use of these macros. |
| 373 | |
Steven Rostedt | 2bcd521 | 2008-11-21 01:30:54 -0500 | [diff] [blame] | 374 | config PROFILE_ALL_BRANCHES |
Randy Dunlap | 68e76e0 | 2018-01-15 11:07:27 -0800 | [diff] [blame] | 375 | bool "Profile all if conditionals" if !FORTIFY_SOURCE |
Steven Rostedt | 9ae5b87 | 2009-04-20 10:27:58 -0400 | [diff] [blame] | 376 | select TRACE_BRANCH_PROFILING |
Masahiro Yamada | b303c6d | 2019-02-21 13:13:38 +0900 | [diff] [blame] | 377 | imply CC_DISABLE_WARN_MAYBE_UNINITIALIZED # avoid false positives |
Steven Rostedt | 2bcd521 | 2008-11-21 01:30:54 -0500 | [diff] [blame] | 378 | help |
| 379 | This tracer profiles all branch conditions. Every if () |
| 380 | taken in the kernel is recorded whether it hit or miss. |
| 381 | The results will be displayed in: |
| 382 | |
David Rientjes | 13e5bef | 2011-03-16 17:17:08 -0700 | [diff] [blame] | 383 | /sys/kernel/debug/tracing/trace_stat/branch_all |
Steven Rostedt | 2bcd521 | 2008-11-21 01:30:54 -0500 | [diff] [blame] | 384 | |
Steven Rostedt | 9ae5b87 | 2009-04-20 10:27:58 -0400 | [diff] [blame] | 385 | This option also enables the likely/unlikely profiler. |
| 386 | |
Steven Rostedt | 2bcd521 | 2008-11-21 01:30:54 -0500 | [diff] [blame] | 387 | This configuration, when enabled, will impose a great overhead |
| 388 | on the system. This should only be enabled when the system |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 389 | is to be analyzed in much detail. |
Steven Rostedt | 9ae5b87 | 2009-04-20 10:27:58 -0400 | [diff] [blame] | 390 | endchoice |
Steven Rostedt | 2bcd521 | 2008-11-21 01:30:54 -0500 | [diff] [blame] | 391 | |
Steven Rostedt | 2ed84ee | 2008-11-12 15:24:24 -0500 | [diff] [blame] | 392 | config TRACING_BRANCHES |
Steven Rostedt | 52f232c | 2008-11-12 00:14:40 -0500 | [diff] [blame] | 393 | bool |
| 394 | help |
| 395 | Selected by tracers that will trace the likely and unlikely |
| 396 | conditions. This prevents the tracers themselves from being |
| 397 | profiled. Profiling the tracing infrastructure can only happen |
| 398 | when the likelys and unlikelys are not being traced. |
| 399 | |
Steven Rostedt | 2ed84ee | 2008-11-12 15:24:24 -0500 | [diff] [blame] | 400 | config BRANCH_TRACER |
Steven Rostedt | 52f232c | 2008-11-12 00:14:40 -0500 | [diff] [blame] | 401 | bool "Trace likely/unlikely instances" |
Steven Rostedt | 2ed84ee | 2008-11-12 15:24:24 -0500 | [diff] [blame] | 402 | depends on TRACE_BRANCH_PROFILING |
| 403 | select TRACING_BRANCHES |
Steven Rostedt | 52f232c | 2008-11-12 00:14:40 -0500 | [diff] [blame] | 404 | help |
| 405 | This traces the events of likely and unlikely condition |
| 406 | calls in the kernel. The difference between this and the |
| 407 | "Trace likely/unlikely profiler" is that this is not a |
| 408 | histogram of the callers, but actually places the calling |
| 409 | events into a running trace buffer to see when and where the |
| 410 | events happened, as well as their results. |
| 411 | |
| 412 | Say N if unsure. |
| 413 | |
Steven Rostedt | e5a81b6 | 2008-08-27 23:31:01 -0400 | [diff] [blame] | 414 | config STACK_TRACER |
| 415 | bool "Trace max stack" |
Steven Rostedt | 606576c | 2008-10-06 19:06:12 -0400 | [diff] [blame] | 416 | depends on HAVE_FUNCTION_TRACER |
Steven Rostedt | 606576c | 2008-10-06 19:06:12 -0400 | [diff] [blame] | 417 | select FUNCTION_TRACER |
Steven Rostedt | e5a81b6 | 2008-08-27 23:31:01 -0400 | [diff] [blame] | 418 | select STACKTRACE |
Steven Rostedt | 4d7a077 | 2009-02-18 22:06:18 -0500 | [diff] [blame] | 419 | select KALLSYMS |
Steven Rostedt | e5a81b6 | 2008-08-27 23:31:01 -0400 | [diff] [blame] | 420 | help |
Ingo Molnar | 4519d9e | 2008-10-14 14:15:43 +0200 | [diff] [blame] | 421 | This special tracer records the maximum stack footprint of the |
GeunSik Lim | 156f5a7 | 2009-06-02 15:01:37 +0900 | [diff] [blame] | 422 | kernel and displays it in /sys/kernel/debug/tracing/stack_trace. |
Ingo Molnar | 4519d9e | 2008-10-14 14:15:43 +0200 | [diff] [blame] | 423 | |
| 424 | This tracer works by hooking into every function call that the |
| 425 | kernel executes, and keeping a maximum stack depth value and |
Steven Rostedt | f38f1d2 | 2008-12-16 23:06:40 -0500 | [diff] [blame] | 426 | stack-trace saved. If this is configured with DYNAMIC_FTRACE |
| 427 | then it will not have any overhead while the stack tracer |
| 428 | is disabled. |
| 429 | |
| 430 | To enable the stack tracer on bootup, pass in 'stacktrace' |
| 431 | on the kernel command line. |
| 432 | |
| 433 | The stack tracer can also be enabled or disabled via the |
| 434 | sysctl kernel.stack_tracer_enabled |
Ingo Molnar | 4519d9e | 2008-10-14 14:15:43 +0200 | [diff] [blame] | 435 | |
| 436 | Say N if unsure. |
Steven Rostedt | e5a81b6 | 2008-08-27 23:31:01 -0400 | [diff] [blame] | 437 | |
Frederic Weisbecker | 2db270a | 2009-02-07 20:46:45 +0100 | [diff] [blame] | 438 | config BLK_DEV_IO_TRACE |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 439 | bool "Support for tracing block IO actions" |
Frederic Weisbecker | 2db270a | 2009-02-07 20:46:45 +0100 | [diff] [blame] | 440 | depends on SYSFS |
Ingo Molnar | 1dfba05 | 2009-02-09 12:06:54 +0100 | [diff] [blame] | 441 | depends on BLOCK |
Frederic Weisbecker | 2db270a | 2009-02-07 20:46:45 +0100 | [diff] [blame] | 442 | select RELAY |
| 443 | select DEBUG_FS |
| 444 | select TRACEPOINTS |
Steven Rostedt | 5e0a093 | 2009-05-28 15:50:13 -0400 | [diff] [blame] | 445 | select GENERIC_TRACER |
Frederic Weisbecker | 2db270a | 2009-02-07 20:46:45 +0100 | [diff] [blame] | 446 | select STACKTRACE |
| 447 | help |
| 448 | Say Y here if you want to be able to trace the block layer actions |
| 449 | on a given queue. Tracing allows you to see any traffic happening |
| 450 | on a block device queue. For more information (and the userspace |
| 451 | support tools needed), fetch the blktrace tools from: |
| 452 | |
| 453 | git://git.kernel.dk/blktrace.git |
| 454 | |
| 455 | Tracing also is possible using the ftrace interface, e.g.: |
| 456 | |
| 457 | echo 1 > /sys/block/sda/sda1/trace/enable |
| 458 | echo blk > /sys/kernel/debug/tracing/current_tracer |
| 459 | cat /sys/kernel/debug/tracing/trace_pipe |
| 460 | |
| 461 | If unsure, say N. |
Frederic Weisbecker | 36994e5 | 2008-12-29 13:42:23 -0800 | [diff] [blame] | 462 | |
Anton Blanchard | 6b0b755 | 2017-02-16 17:00:50 +1100 | [diff] [blame] | 463 | config KPROBE_EVENTS |
Masami Hiramatsu | 413d37d | 2009-08-13 16:35:11 -0400 | [diff] [blame] | 464 | depends on KPROBES |
Heiko Carstens | f850c30c | 2010-02-10 17:25:17 +0100 | [diff] [blame] | 465 | depends on HAVE_REGS_AND_STACK_ACCESS_API |
Masami Hiramatsu | 77b44d1 | 2009-11-03 19:12:47 -0500 | [diff] [blame] | 466 | bool "Enable kprobes-based dynamic events" |
Masami Hiramatsu | 413d37d | 2009-08-13 16:35:11 -0400 | [diff] [blame] | 467 | select TRACING |
Srikar Dronamraju | 8ab83f5 | 2012-04-09 14:41:44 +0530 | [diff] [blame] | 468 | select PROBE_EVENTS |
Masami Hiramatsu | 6212dd2 | 2018-11-05 18:02:36 +0900 | [diff] [blame] | 469 | select DYNAMIC_EVENTS |
Masami Hiramatsu | 77b44d1 | 2009-11-03 19:12:47 -0500 | [diff] [blame] | 470 | default y |
Masami Hiramatsu | 413d37d | 2009-08-13 16:35:11 -0400 | [diff] [blame] | 471 | help |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 472 | This allows the user to add tracing events (similar to tracepoints) |
| 473 | on the fly via the ftrace interface. See |
Mauro Carvalho Chehab | 5fb94e9 | 2018-05-08 15:14:57 -0300 | [diff] [blame] | 474 | Documentation/trace/kprobetrace.rst for more details. |
Masami Hiramatsu | 77b44d1 | 2009-11-03 19:12:47 -0500 | [diff] [blame] | 475 | |
| 476 | Those events can be inserted wherever kprobes can probe, and record |
| 477 | various register and memory values. |
| 478 | |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 479 | This option is also required by perf-probe subcommand of perf tools. |
| 480 | If you want to use perf tools, this option is strongly recommended. |
Masami Hiramatsu | 413d37d | 2009-08-13 16:35:11 -0400 | [diff] [blame] | 481 | |
Masami Hiramatsu | 45408c4 | 2018-07-30 19:20:14 +0900 | [diff] [blame] | 482 | config KPROBE_EVENTS_ON_NOTRACE |
| 483 | bool "Do NOT protect notrace function from kprobe events" |
| 484 | depends on KPROBE_EVENTS |
| 485 | depends on KPROBES_ON_FTRACE |
| 486 | default n |
| 487 | help |
| 488 | This is only for the developers who want to debug ftrace itself |
| 489 | using kprobe events. |
| 490 | |
| 491 | If kprobes can use ftrace instead of breakpoint, ftrace related |
| 492 | functions are protected from kprobe-events to prevent an infinit |
| 493 | recursion or any unexpected execution path which leads to a kernel |
| 494 | crash. |
| 495 | |
| 496 | This option disables such protection and allows you to put kprobe |
| 497 | events on ftrace functions for debugging ftrace by itself. |
| 498 | Note that this might let you shoot yourself in the foot. |
| 499 | |
| 500 | If unsure, say N. |
| 501 | |
Anton Blanchard | 6b0b755 | 2017-02-16 17:00:50 +1100 | [diff] [blame] | 502 | config UPROBE_EVENTS |
Srikar Dronamraju | f3f096c | 2012-04-11 16:00:43 +0530 | [diff] [blame] | 503 | bool "Enable uprobes-based dynamic events" |
| 504 | depends on ARCH_SUPPORTS_UPROBES |
| 505 | depends on MMU |
David A. Long | 09294e3 | 2014-03-07 10:32:22 -0500 | [diff] [blame] | 506 | depends on PERF_EVENTS |
Srikar Dronamraju | f3f096c | 2012-04-11 16:00:43 +0530 | [diff] [blame] | 507 | select UPROBES |
| 508 | select PROBE_EVENTS |
Masami Hiramatsu | 0597c49 | 2018-11-05 18:03:04 +0900 | [diff] [blame] | 509 | select DYNAMIC_EVENTS |
Srikar Dronamraju | f3f096c | 2012-04-11 16:00:43 +0530 | [diff] [blame] | 510 | select TRACING |
Arnaldo Carvalho de Melo | 61f35d7 | 2017-03-16 12:42:02 -0300 | [diff] [blame] | 511 | default y |
Srikar Dronamraju | f3f096c | 2012-04-11 16:00:43 +0530 | [diff] [blame] | 512 | help |
| 513 | This allows the user to add tracing events on top of userspace |
| 514 | dynamic events (similar to tracepoints) on the fly via the trace |
| 515 | events interface. Those events can be inserted wherever uprobes |
| 516 | can probe, and record various registers. |
| 517 | This option is required if you plan to use perf-probe subcommand |
| 518 | of perf tools on user space applications. |
| 519 | |
Ingo Molnar | e1abf2c | 2015-04-02 15:51:39 +0200 | [diff] [blame] | 520 | config BPF_EVENTS |
| 521 | depends on BPF_SYSCALL |
Anton Blanchard | 6b0b755 | 2017-02-16 17:00:50 +1100 | [diff] [blame] | 522 | depends on (KPROBE_EVENTS || UPROBE_EVENTS) && PERF_EVENTS |
Ingo Molnar | e1abf2c | 2015-04-02 15:51:39 +0200 | [diff] [blame] | 523 | bool |
| 524 | default y |
| 525 | help |
Peter Wu | 5cbd22c | 2019-08-21 00:08:57 +0100 | [diff] [blame] | 526 | This allows the user to attach BPF programs to kprobe, uprobe, and |
| 527 | tracepoint events. |
Ingo Molnar | e1abf2c | 2015-04-02 15:51:39 +0200 | [diff] [blame] | 528 | |
Masami Hiramatsu | 5448d44 | 2018-11-05 18:02:08 +0900 | [diff] [blame] | 529 | config DYNAMIC_EVENTS |
| 530 | def_bool n |
| 531 | |
Srikar Dronamraju | 8ab83f5 | 2012-04-09 14:41:44 +0530 | [diff] [blame] | 532 | config PROBE_EVENTS |
| 533 | def_bool n |
| 534 | |
Steven Rostedt | 3d08339 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 535 | config DYNAMIC_FTRACE |
Steven Rostedt | db05021 | 2013-02-27 21:48:09 -0500 | [diff] [blame] | 536 | bool "enable/disable function tracing dynamically" |
Steven Rostedt | 606576c | 2008-10-06 19:06:12 -0400 | [diff] [blame] | 537 | depends on FUNCTION_TRACER |
Steven Rostedt | 677aa9f | 2008-05-17 00:01:36 -0400 | [diff] [blame] | 538 | depends on HAVE_DYNAMIC_FTRACE |
Steven Rostedt | 3d08339 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 539 | default y |
| 540 | help |
Steven Rostedt | db05021 | 2013-02-27 21:48:09 -0500 | [diff] [blame] | 541 | This option will modify all the calls to function tracing |
| 542 | dynamically (will patch them out of the binary image and |
| 543 | replace them with a No-Op instruction) on boot up. During |
| 544 | compile time, a table is made of all the locations that ftrace |
| 545 | can function trace, and this table is linked into the kernel |
| 546 | image. When this is enabled, functions can be individually |
| 547 | enabled, and the functions not enabled will not affect |
| 548 | performance of the system. |
| 549 | |
| 550 | See the files in /sys/kernel/debug/tracing: |
| 551 | available_filter_functions |
| 552 | set_ftrace_filter |
| 553 | set_ftrace_notrace |
Steven Rostedt | 3d08339 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 554 | |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 555 | This way a CONFIG_FUNCTION_TRACER kernel is slightly larger, but |
| 556 | otherwise has native performance as long as no tracing is active. |
Steven Rostedt | 3d08339 | 2008-05-12 21:20:42 +0200 | [diff] [blame] | 557 | |
Masami Hiramatsu | 06aeaae | 2012-09-28 17:15:17 +0900 | [diff] [blame] | 558 | config DYNAMIC_FTRACE_WITH_REGS |
| 559 | def_bool y |
| 560 | depends on DYNAMIC_FTRACE |
| 561 | depends on HAVE_DYNAMIC_FTRACE_WITH_REGS |
| 562 | |
Steven Rostedt (VMware) | 763e34e | 2019-11-08 13:07:06 -0500 | [diff] [blame^] | 563 | config DYNAMIC_FTRACE_WITH_DIRECT_CALLS |
| 564 | def_bool y |
| 565 | depends on DYNAMIC_FTRACE |
| 566 | depends on HAVE_DYNAMIC_FTRACE_WITH_DIRECT_CALLS |
| 567 | |
Steven Rostedt | bac429f | 2009-03-20 12:50:56 -0400 | [diff] [blame] | 568 | config FUNCTION_PROFILER |
| 569 | bool "Kernel function profiler" |
Steven Rostedt | 493762f | 2009-03-23 17:12:36 -0400 | [diff] [blame] | 570 | depends on FUNCTION_TRACER |
Steven Rostedt | bac429f | 2009-03-20 12:50:56 -0400 | [diff] [blame] | 571 | default n |
| 572 | help |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 573 | This option enables the kernel function profiler. A file is created |
| 574 | in debugfs called function_profile_enabled which defaults to zero. |
| 575 | When a 1 is echoed into this file profiling begins, and when a |
| 576 | zero is entered, profiling stops. A "functions" file is created in |
Masami Hiramatsu | 1fee4f7 | 2018-07-26 21:43:36 +0900 | [diff] [blame] | 577 | the trace_stat directory; this file shows the list of functions that |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 578 | have been hit and their counters. |
Steven Rostedt | bac429f | 2009-03-20 12:50:56 -0400 | [diff] [blame] | 579 | |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 580 | If in doubt, say N. |
Steven Rostedt | bac429f | 2009-03-20 12:50:56 -0400 | [diff] [blame] | 581 | |
Josef Bacik | 9802d86 | 2017-12-11 11:36:48 -0500 | [diff] [blame] | 582 | config BPF_KPROBE_OVERRIDE |
| 583 | bool "Enable BPF programs to override a kprobed function" |
| 584 | depends on BPF_EVENTS |
Masami Hiramatsu | 540adea | 2018-01-13 02:55:03 +0900 | [diff] [blame] | 585 | depends on FUNCTION_ERROR_INJECTION |
Josef Bacik | 9802d86 | 2017-12-11 11:36:48 -0500 | [diff] [blame] | 586 | default n |
| 587 | help |
| 588 | Allows BPF to override the execution of a probed function and |
| 589 | set a different return value. This is used for error injection. |
| 590 | |
Steven Rostedt | 8da3821 | 2008-08-14 15:45:07 -0400 | [diff] [blame] | 591 | config FTRACE_MCOUNT_RECORD |
| 592 | def_bool y |
| 593 | depends on DYNAMIC_FTRACE |
| 594 | depends on HAVE_FTRACE_MCOUNT_RECORD |
| 595 | |
Steven Rostedt | 60a1177 | 2008-05-12 21:20:44 +0200 | [diff] [blame] | 596 | config FTRACE_SELFTEST |
| 597 | bool |
| 598 | |
| 599 | config FTRACE_STARTUP_TEST |
| 600 | bool "Perform a startup test on ftrace" |
Steven Rostedt | 5e0a093 | 2009-05-28 15:50:13 -0400 | [diff] [blame] | 601 | depends on GENERIC_TRACER |
Steven Rostedt | 60a1177 | 2008-05-12 21:20:44 +0200 | [diff] [blame] | 602 | select FTRACE_SELFTEST |
| 603 | help |
| 604 | This option performs a series of startup tests on ftrace. On bootup |
| 605 | a series of tests are made to verify that the tracer is |
| 606 | functioning properly. It will do tests on all the configured |
| 607 | tracers of ftrace. |
Peter Zijlstra | 17d80fd | 2008-10-21 16:31:18 +0200 | [diff] [blame] | 608 | |
Steven Rostedt (VMware) | b3015fe | 2019-05-23 19:40:17 -0400 | [diff] [blame] | 609 | config EVENT_TRACE_STARTUP_TEST |
| 610 | bool "Run selftest on trace events" |
| 611 | depends on FTRACE_STARTUP_TEST |
| 612 | default y |
| 613 | help |
| 614 | This option performs a test on all trace events in the system. |
| 615 | It basically just enables each event and runs some code that |
| 616 | will trigger events (not necessarily the event it enables) |
| 617 | This may take some time run as there are a lot of events. |
| 618 | |
Steven Rostedt | 1f5a6b4 | 2009-09-14 11:58:24 -0400 | [diff] [blame] | 619 | config EVENT_TRACE_TEST_SYSCALLS |
| 620 | bool "Run selftest on syscall events" |
Steven Rostedt (VMware) | b3015fe | 2019-05-23 19:40:17 -0400 | [diff] [blame] | 621 | depends on EVENT_TRACE_STARTUP_TEST |
Steven Rostedt | 1f5a6b4 | 2009-09-14 11:58:24 -0400 | [diff] [blame] | 622 | help |
| 623 | This option will also enable testing every syscall event. |
| 624 | It only enables the event and disables it and runs various loads |
| 625 | with the event enabled. This adds a bit more time for kernel boot |
| 626 | up since it runs this on every system call defined. |
| 627 | |
| 628 | TBD - enable a way to actually call the syscalls as we test their |
| 629 | events |
| 630 | |
Pekka Paalanen | fe6f90e | 2009-01-03 21:23:51 +0200 | [diff] [blame] | 631 | config MMIOTRACE |
| 632 | bool "Memory mapped IO tracing" |
Ingo Molnar | 40ada30 | 2009-03-05 21:19:55 +0100 | [diff] [blame] | 633 | depends on HAVE_MMIOTRACE_SUPPORT && PCI |
Steven Rostedt | 5e0a093 | 2009-05-28 15:50:13 -0400 | [diff] [blame] | 634 | select GENERIC_TRACER |
Pekka Paalanen | fe6f90e | 2009-01-03 21:23:51 +0200 | [diff] [blame] | 635 | help |
| 636 | Mmiotrace traces Memory Mapped I/O access and is meant for |
| 637 | debugging and reverse engineering. It is called from the ioremap |
| 638 | implementation and works via page faults. Tracing is disabled by |
| 639 | default and can be enabled at run-time. |
| 640 | |
Mauro Carvalho Chehab | 5fb94e9 | 2018-05-08 15:14:57 -0300 | [diff] [blame] | 641 | See Documentation/trace/mmiotrace.rst. |
Pekka Paalanen | fe6f90e | 2009-01-03 21:23:51 +0200 | [diff] [blame] | 642 | If you are not helping to develop drivers, say N. |
| 643 | |
Tom Zanussi | 08d43a5 | 2015-12-10 12:50:50 -0600 | [diff] [blame] | 644 | config TRACING_MAP |
| 645 | bool |
| 646 | depends on ARCH_HAVE_NMI_SAFE_CMPXCHG |
Tom Zanussi | 08d43a5 | 2015-12-10 12:50:50 -0600 | [diff] [blame] | 647 | help |
| 648 | tracing_map is a special-purpose lock-free map for tracing, |
| 649 | separated out as a stand-alone facility in order to allow it |
| 650 | to be shared between multiple tracers. It isn't meant to be |
| 651 | generally used outside of that context, and is normally |
| 652 | selected by tracers that use it. |
| 653 | |
Tom Zanussi | 7ef224d | 2016-03-03 12:54:42 -0600 | [diff] [blame] | 654 | config HIST_TRIGGERS |
| 655 | bool "Histogram triggers" |
| 656 | depends on ARCH_HAVE_NMI_SAFE_CMPXCHG |
| 657 | select TRACING_MAP |
Tom Zanussi | 7ad8fb6 | 2016-07-03 08:51:34 -0500 | [diff] [blame] | 658 | select TRACING |
Masami Hiramatsu | 7bbab38 | 2018-11-05 18:03:33 +0900 | [diff] [blame] | 659 | select DYNAMIC_EVENTS |
Tom Zanussi | 7ef224d | 2016-03-03 12:54:42 -0600 | [diff] [blame] | 660 | default n |
| 661 | help |
| 662 | Hist triggers allow one or more arbitrary trace event fields |
| 663 | to be aggregated into hash tables and dumped to stdout by |
| 664 | reading a debugfs/tracefs file. They're useful for |
| 665 | gathering quick and dirty (though precise) summaries of |
| 666 | event activity as an initial guide for further investigation |
| 667 | using more advanced tools. |
| 668 | |
Tom Zanussi | 89e270c | 2018-01-15 20:52:10 -0600 | [diff] [blame] | 669 | Inter-event tracing of quantities such as latencies is also |
| 670 | supported using hist triggers under this option. |
| 671 | |
Mauro Carvalho Chehab | ea27225 | 2018-06-26 06:49:11 -0300 | [diff] [blame] | 672 | See Documentation/trace/histogram.rst. |
Tom Zanussi | 7ef224d | 2016-03-03 12:54:42 -0600 | [diff] [blame] | 673 | If in doubt, say N. |
| 674 | |
Pekka Paalanen | fe6f90e | 2009-01-03 21:23:51 +0200 | [diff] [blame] | 675 | config MMIOTRACE_TEST |
| 676 | tristate "Test module for mmiotrace" |
| 677 | depends on MMIOTRACE && m |
| 678 | help |
| 679 | This is a dumb module for testing mmiotrace. It is very dangerous |
| 680 | as it will write garbage to IO memory starting at a given address. |
| 681 | However, it should be safe to use on e.g. unused portion of VRAM. |
| 682 | |
| 683 | Say N, unless you absolutely know what you are doing. |
| 684 | |
Steven Rostedt (Red Hat) | 81dc9f0 | 2014-05-29 22:49:07 -0400 | [diff] [blame] | 685 | config TRACEPOINT_BENCHMARK |
| 686 | bool "Add tracepoint that benchmarks tracepoints" |
| 687 | help |
| 688 | This option creates the tracepoint "benchmark:benchmark_event". |
| 689 | When the tracepoint is enabled, it kicks off a kernel thread that |
| 690 | goes into an infinite loop (calling cond_sched() to let other tasks |
| 691 | run), and calls the tracepoint. Each iteration will record the time |
| 692 | it took to write to the tracepoint and the next iteration that |
| 693 | data will be passed to the tracepoint itself. That is, the tracepoint |
| 694 | will report the time it took to do the previous tracepoint. |
| 695 | The string written to the tracepoint is a static string of 128 bytes |
| 696 | to keep the time the same. The initial string is simply a write of |
| 697 | "START". The second string records the cold cache time of the first |
| 698 | write which is not added to the rest of the calculations. |
| 699 | |
| 700 | As it is a tight loop, it benchmarks as hot cache. That's fine because |
| 701 | we care most about hot paths that are probably in cache already. |
| 702 | |
| 703 | An example of the output: |
| 704 | |
| 705 | START |
| 706 | first=3672 [COLD CACHED] |
| 707 | last=632 first=3672 max=632 min=632 avg=316 std=446 std^2=199712 |
| 708 | last=278 first=3672 max=632 min=278 avg=303 std=316 std^2=100337 |
| 709 | last=277 first=3672 max=632 min=277 avg=296 std=258 std^2=67064 |
| 710 | last=273 first=3672 max=632 min=273 avg=292 std=224 std^2=50411 |
| 711 | last=273 first=3672 max=632 min=273 avg=288 std=200 std^2=40389 |
| 712 | last=281 first=3672 max=632 min=273 avg=287 std=183 std^2=33666 |
| 713 | |
| 714 | |
Steven Rostedt | 5092dbc | 2009-05-05 22:47:18 -0400 | [diff] [blame] | 715 | config RING_BUFFER_BENCHMARK |
| 716 | tristate "Ring buffer benchmark stress tester" |
| 717 | depends on RING_BUFFER |
| 718 | help |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 719 | This option creates a test to stress the ring buffer and benchmark it. |
| 720 | It creates its own ring buffer such that it will not interfere with |
Steven Rostedt | 5092dbc | 2009-05-05 22:47:18 -0400 | [diff] [blame] | 721 | any other users of the ring buffer (such as ftrace). It then creates |
| 722 | a producer and consumer that will run for 10 seconds and sleep for |
| 723 | 10 seconds. Each interval it will print out the number of events |
| 724 | it recorded and give a rough estimate of how long each iteration took. |
| 725 | |
| 726 | It does not disable interrupts or raise its priority, so it may be |
| 727 | affected by processes that are running. |
| 728 | |
Randy Dunlap | 4089236 | 2009-12-21 12:01:17 -0800 | [diff] [blame] | 729 | If unsure, say N. |
Steven Rostedt | 5092dbc | 2009-05-05 22:47:18 -0400 | [diff] [blame] | 730 | |
Steven Rostedt (Red Hat) | 6c43e55 | 2013-03-15 11:32:53 -0400 | [diff] [blame] | 731 | config RING_BUFFER_STARTUP_TEST |
| 732 | bool "Ring buffer startup self test" |
| 733 | depends on RING_BUFFER |
| 734 | help |
| 735 | Run a simple self test on the ring buffer on boot up. Late in the |
| 736 | kernel boot sequence, the test will start that kicks off |
| 737 | a thread per cpu. Each thread will write various size events |
| 738 | into the ring buffer. Another thread is created to send IPIs |
| 739 | to each of the threads, where the IPI handler will also write |
| 740 | to the ring buffer, to test/stress the nesting ability. |
| 741 | If any anomalies are discovered, a warning will be displayed |
| 742 | and all ring buffers will be disabled. |
| 743 | |
| 744 | The test runs for 10 seconds. This will slow your boot time |
| 745 | by at least 10 more seconds. |
| 746 | |
| 747 | At the end of the test, statics and more checks are done. |
| 748 | It will output the stats of each per cpu buffer. What |
| 749 | was written, the sizes, what was read, what was lost, and |
| 750 | other similar details. |
| 751 | |
| 752 | If unsure, say N |
| 753 | |
Joel Fernandes (Google) | f96e857 | 2018-07-12 14:36:11 -0700 | [diff] [blame] | 754 | config PREEMPTIRQ_DELAY_TEST |
| 755 | tristate "Preempt / IRQ disable delay thread to test latency tracers" |
| 756 | depends on m |
| 757 | help |
| 758 | Select this option to build a test module that can help test latency |
| 759 | tracers by executing a preempt or irq disable section with a user |
| 760 | configurable delay. The module busy waits for the duration of the |
| 761 | critical section. |
| 762 | |
| 763 | For example, the following invocation forces a one-time irq-disabled |
| 764 | critical section for 500us: |
| 765 | modprobe preemptirq_delay_test test_mode=irq delay=500000 |
| 766 | |
| 767 | If unsure, say N |
| 768 | |
Jeremy Linton | 681bec0 | 2017-05-31 16:56:53 -0500 | [diff] [blame] | 769 | config TRACE_EVAL_MAP_FILE |
| 770 | bool "Show eval mappings for trace events" |
Steven Rostedt (Red Hat) | 9828413 | 2015-03-31 17:23:45 -0400 | [diff] [blame] | 771 | depends on TRACING |
| 772 | help |
Jeremy Linton | 681bec0 | 2017-05-31 16:56:53 -0500 | [diff] [blame] | 773 | The "print fmt" of the trace events will show the enum/sizeof names |
| 774 | instead of their values. This can cause problems for user space tools |
| 775 | that use this string to parse the raw data as user space does not know |
Steven Rostedt (Red Hat) | 9828413 | 2015-03-31 17:23:45 -0400 | [diff] [blame] | 776 | how to convert the string to its value. |
| 777 | |
| 778 | To fix this, there's a special macro in the kernel that can be used |
Jeremy Linton | 681bec0 | 2017-05-31 16:56:53 -0500 | [diff] [blame] | 779 | to convert an enum/sizeof into its value. If this macro is used, then |
| 780 | the print fmt strings will be converted to their values. |
Steven Rostedt (Red Hat) | 9828413 | 2015-03-31 17:23:45 -0400 | [diff] [blame] | 781 | |
| 782 | If something does not get converted properly, this option can be |
Jeremy Linton | 681bec0 | 2017-05-31 16:56:53 -0500 | [diff] [blame] | 783 | used to show what enums/sizeof the kernel tried to convert. |
Steven Rostedt (Red Hat) | 9828413 | 2015-03-31 17:23:45 -0400 | [diff] [blame] | 784 | |
Jeremy Linton | 681bec0 | 2017-05-31 16:56:53 -0500 | [diff] [blame] | 785 | This option is for debugging the conversions. A file is created |
| 786 | in the tracing directory called "eval_map" that will show the |
Steven Rostedt (Red Hat) | 9828413 | 2015-03-31 17:23:45 -0400 | [diff] [blame] | 787 | names matched with their values and what trace event system they |
| 788 | belong too. |
| 789 | |
| 790 | Normally, the mapping of the strings to values will be freed after |
| 791 | boot up or module load. With this option, they will not be freed, as |
Jeremy Linton | 681bec0 | 2017-05-31 16:56:53 -0500 | [diff] [blame] | 792 | they are needed for the "eval_map" file. Enabling this option will |
Steven Rostedt (Red Hat) | 9828413 | 2015-03-31 17:23:45 -0400 | [diff] [blame] | 793 | increase the memory footprint of the running kernel. |
| 794 | |
| 795 | If unsure, say N |
| 796 | |
Masami Hiramatsu | 6b7dca4 | 2018-08-21 16:27:58 +0900 | [diff] [blame] | 797 | config GCOV_PROFILE_FTRACE |
| 798 | bool "Enable GCOV profiling on ftrace subsystem" |
| 799 | depends on GCOV_KERNEL |
| 800 | help |
| 801 | Enable GCOV profiling on ftrace subsystem for checking |
| 802 | which functions/lines are tested. |
| 803 | |
| 804 | If unsure, say N. |
| 805 | |
| 806 | Note that on a kernel compiled with this config, ftrace will |
| 807 | run significantly slower. |
| 808 | |
Steven Rostedt | 4ed9f07 | 2009-04-20 10:47:36 -0400 | [diff] [blame] | 809 | endif # FTRACE |
Ingo Molnar | 40ada30 | 2009-03-05 21:19:55 +0100 | [diff] [blame] | 810 | |
| 811 | endif # TRACING_SUPPORT |
| 812 | |