1 ========================== 1 ==========================
2 Kprobe-based Event Tracing 2 Kprobe-based Event Tracing
3 ========================== 3 ==========================
4 4
5 :Author: Masami Hiramatsu 5 :Author: Masami Hiramatsu
6 6
7 Overview 7 Overview
8 -------- 8 --------
9 These events are similar to tracepoint-based e !! 9 These events are similar to tracepoint based events. Instead of Tracepoint,
10 this is based on kprobes (kprobe and kretprobe 10 this is based on kprobes (kprobe and kretprobe). So it can probe wherever
11 kprobes can probe (this means, all functions e 11 kprobes can probe (this means, all functions except those with
12 __kprobes/nokprobe_inline annotation and those 12 __kprobes/nokprobe_inline annotation and those marked NOKPROBE_SYMBOL).
13 Unlike the tracepoint-based event, this can be !! 13 Unlike the Tracepoint based event, this can be added and removed
14 dynamically, on the fly. 14 dynamically, on the fly.
15 15
16 To enable this feature, build your kernel with 16 To enable this feature, build your kernel with CONFIG_KPROBE_EVENTS=y.
17 17
18 Similar to the event tracer, this doesn't need !! 18 Similar to the events tracer, this doesn't need to be activated via
19 current_tracer. Instead of that, add probe poi 19 current_tracer. Instead of that, add probe points via
20 /sys/kernel/tracing/kprobe_events, and enable !! 20 /sys/kernel/debug/tracing/kprobe_events, and enable it via
21 /sys/kernel/tracing/events/kprobes/<EVENT>/ena !! 21 /sys/kernel/debug/tracing/events/kprobes/<EVENT>/enable.
22 22
23 You can also use /sys/kernel/tracing/dynamic_e !! 23 You can also use /sys/kernel/debug/tracing/dynamic_events instead of
24 kprobe_events. That interface will provide uni 24 kprobe_events. That interface will provide unified access to other
25 dynamic events too. 25 dynamic events too.
26 26
27 Synopsis of kprobe_events 27 Synopsis of kprobe_events
28 ------------------------- 28 -------------------------
29 :: 29 ::
30 30
31 p[:[GRP/][EVENT]] [MOD:]SYM[+offs]|MEMADDR [ !! 31 p[:[GRP/]EVENT] [MOD:]SYM[+offs]|MEMADDR [FETCHARGS] : Set a probe
32 r[MAXACTIVE][:[GRP/][EVENT]] [MOD:]SYM[+0] [ !! 32 r[MAXACTIVE][:[GRP/]EVENT] [MOD:]SYM[+0] [FETCHARGS] : Set a return probe
33 p[:[GRP/][EVENT]] [MOD:]SYM[+0]%return [FETC !! 33 -:[GRP/]EVENT : Clear a probe
34 -:[GRP/][EVENT] <<
35 34
36 GRP : Group name. If omitted, use 35 GRP : Group name. If omitted, use "kprobes" for it.
37 EVENT : Event name. If omitted, the 36 EVENT : Event name. If omitted, the event name is generated
38 based on SYM+offs or MEMADDR 37 based on SYM+offs or MEMADDR.
39 MOD : Module name which has given 38 MOD : Module name which has given SYM.
40 SYM[+offs] : Symbol+offset where the prob 39 SYM[+offs] : Symbol+offset where the probe is inserted.
41 SYM%return : Return address of the symbol <<
42 MEMADDR : Address where the probe is i 40 MEMADDR : Address where the probe is inserted.
43 MAXACTIVE : Maximum number of instances 41 MAXACTIVE : Maximum number of instances of the specified function that
44 can be probed simultaneously 42 can be probed simultaneously, or 0 for the default value
45 as defined in Documentation/ !! 43 as defined in Documentation/kprobes.txt section 1.3.1.
46 44
47 FETCHARGS : Arguments. Each probe can ha 45 FETCHARGS : Arguments. Each probe can have up to 128 args.
48 %REG : Fetch register REG 46 %REG : Fetch register REG
49 @ADDR : Fetch memory at ADDR (ADDR s 47 @ADDR : Fetch memory at ADDR (ADDR should be in kernel)
50 @SYM[+|-offs] : Fetch memory at SYM +|- offs 48 @SYM[+|-offs] : Fetch memory at SYM +|- offs (SYM should be a data symbol)
51 $stackN : Fetch Nth entry of stack (N 49 $stackN : Fetch Nth entry of stack (N >= 0)
52 $stack : Fetch stack address. 50 $stack : Fetch stack address.
53 $argN : Fetch the Nth function argum 51 $argN : Fetch the Nth function argument. (N >= 1) (\*1)
54 $retval : Fetch return value.(\*2) 52 $retval : Fetch return value.(\*2)
55 $comm : Fetch current task comm. 53 $comm : Fetch current task comm.
56 +|-[u]OFFS(FETCHARG) : Fetch memory at FETCH !! 54 +|-offs(FETCHARG) : Fetch memory at FETCHARG +|- offs address.(\*3)
57 \IMM : Store an immediate value to <<
58 NAME=FETCHARG : Set NAME as the argument nam 55 NAME=FETCHARG : Set NAME as the argument name of FETCHARG.
59 FETCHARG:TYPE : Set TYPE as the type of FETC 56 FETCHARG:TYPE : Set TYPE as the type of FETCHARG. Currently, basic types
60 (u8/u16/u32/u64/s8/s16/s32/s 57 (u8/u16/u32/u64/s8/s16/s32/s64), hexadecimal types
61 (x8/x16/x32/x64), VFS layer !! 58 (x8/x16/x32/x64), "string" and bitfield are supported.
62 "string", "ustring", "symbol <<
63 supported. <<
64 <<
65 (\*1) only for the probe on function entry ( <<
66 is best effort, because depending on t <<
67 the stack. But this only support the a <<
68 (\*2) only for return probe. Note that this <<
69 return value type, it might be passed <<
70 accesses one register. <<
71 (\*3) this is useful for fetching a field of <<
72 (\*4) "u" means user-space dereference. See <<
73 <<
74 Function arguments at kretprobe <<
75 ------------------------------- <<
76 Function arguments can be accessed at kretprob <<
77 is useful to record the function parameter and <<
78 trace the difference of structure fields (for <<
79 correctly updates the given data structure or <<
80 See the :ref:`sample<fprobetrace_exit_args_sam <<
81 it works. <<
82 59
83 .. _kprobetrace_types: !! 60 (\*1) only for the probe on function entry (offs == 0).
>> 61 (\*2) only for return probe.
>> 62 (\*3) this is useful for fetching a field of data structures.
84 63
85 Types 64 Types
86 ----- 65 -----
87 Several types are supported for fetchargs. Kpr !! 66 Several types are supported for fetch-args. Kprobe tracer will access memory
88 by given type. Prefix 's' and 'u' means those 67 by given type. Prefix 's' and 'u' means those types are signed and unsigned
89 respectively. 'x' prefix implies it is unsigne 68 respectively. 'x' prefix implies it is unsigned. Traced arguments are shown
90 in decimal ('s' and 'u') or hexadecimal ('x'). 69 in decimal ('s' and 'u') or hexadecimal ('x'). Without type casting, 'x32'
91 or 'x64' is used depends on the architecture ( 70 or 'x64' is used depends on the architecture (e.g. x86-32 uses x32, and
92 x86-64 uses x64). 71 x86-64 uses x64).
93 <<
94 These value types can be an array. To record a 72 These value types can be an array. To record array data, you can add '[N]'
95 (where N is a fixed number, less than 64) to t 73 (where N is a fixed number, less than 64) to the base type.
96 E.g. 'x16[4]' means an array of x16 (2-byte he !! 74 E.g. 'x16[4]' means an array of x16 (2bytes hex) with 4 elements.
97 Note that the array can be applied to memory t 75 Note that the array can be applied to memory type fetchargs, you can not
98 apply it to registers/stack-entries etc. (for 76 apply it to registers/stack-entries etc. (for example, '$stack1:x8[8]' is
99 wrong, but '+8($stack):x8[8]' is OK.) 77 wrong, but '+8($stack):x8[8]' is OK.)
100 <<
101 Char type can be used to show the character va <<
102 <<
103 String type is a special type, which fetches a 78 String type is a special type, which fetches a "null-terminated" string from
104 kernel space. This means it will fail and stor 79 kernel space. This means it will fail and store NULL if the string container
105 has been paged out. "ustring" type is an alter !! 80 has been paged out.
106 See :ref:`user_mem_access` for more info. <<
107 <<
108 The string array type is a bit different from 81 The string array type is a bit different from other types. For other base
109 types, <base-type>[1] is equal to <base-type> 82 types, <base-type>[1] is equal to <base-type> (e.g. +0(%di):x32[1] is same
110 as +0(%di):x32.) But string[1] is not equal to 83 as +0(%di):x32.) But string[1] is not equal to string. The string type itself
111 represents "char array", but string array type 84 represents "char array", but string array type represents "char * array".
112 So, for example, +0(%di):string[1] is equal to 85 So, for example, +0(%di):string[1] is equal to +0(+0(%di)):string.
113 Bitfield is another special type, which takes 86 Bitfield is another special type, which takes 3 parameters, bit-width, bit-
114 offset, and container-size (usually 32). The s 87 offset, and container-size (usually 32). The syntax is::
115 88
116 b<bit-width>@<bit-offset>/<container-size> 89 b<bit-width>@<bit-offset>/<container-size>
117 90
118 Symbol type('symbol') is an alias of u32 or u6 91 Symbol type('symbol') is an alias of u32 or u64 type (depends on BITS_PER_LONG)
119 which shows given pointer in "symbol+offset" s 92 which shows given pointer in "symbol+offset" style.
120 On the other hand, symbol-string type ('symstr <<
121 "symbol+offset/symbolsize" style and stores it <<
122 With 'symstr' type, you can filter the event w <<
123 symbols, and you don't need to solve symbol na <<
124 For $comm, the default type is "string"; any o 93 For $comm, the default type is "string"; any other type is invalid.
125 94
126 VFS layer common type(%pd/%pD) is a special ty <<
127 file's name from struct dentry's address or st <<
128 <<
129 .. _user_mem_access: <<
130 <<
131 User Memory Access <<
132 ------------------ <<
133 Kprobe events supports user-space memory acces <<
134 either user-space dereference syntax or 'ustri <<
135 <<
136 The user-space dereference syntax allows you t <<
137 structure in user-space. This is done by addin <<
138 dereference syntax. For example, +u4(%si) mean <<
139 address in the register %si offset by 4, and t <<
140 user-space. You can use this for strings too, <<
141 a string from the address in the register %si <<
142 space. 'ustring' is a shortcut way of performi <<
143 +0(%si):ustring is equivalent to +u0(%si):stri <<
144 <<
145 Note that kprobe-event provides the user-memor <<
146 use it transparently. This means if you use no <<
147 for user memory, it might fail, and may always <<
148 user has to carefully check if the target data <<
149 95
150 Per-Probe Event Filtering 96 Per-Probe Event Filtering
151 ------------------------- 97 -------------------------
152 Per-probe event filtering feature allows you t 98 Per-probe event filtering feature allows you to set different filter on each
153 probe and gives you what arguments will be sho 99 probe and gives you what arguments will be shown in trace buffer. If an event
154 name is specified right after 'p:' or 'r:' in 100 name is specified right after 'p:' or 'r:' in kprobe_events, it adds an event
155 under tracing/events/kprobes/<EVENT>, at the d 101 under tracing/events/kprobes/<EVENT>, at the directory you can see 'id',
156 'enable', 'format', 'filter' and 'trigger'. 102 'enable', 'format', 'filter' and 'trigger'.
157 103
158 enable: 104 enable:
159 You can enable/disable the probe by writing 105 You can enable/disable the probe by writing 1 or 0 on it.
160 106
161 format: 107 format:
162 This shows the format of this probe event. 108 This shows the format of this probe event.
163 109
164 filter: 110 filter:
165 You can write filtering rules of this event. 111 You can write filtering rules of this event.
166 112
167 id: 113 id:
168 This shows the id of this probe event. 114 This shows the id of this probe event.
169 115
170 trigger: 116 trigger:
171 This allows to install trigger commands whic 117 This allows to install trigger commands which are executed when the event is
172 hit (for details, see Documentation/trace/ev 118 hit (for details, see Documentation/trace/events.rst, section 6).
173 119
174 Event Profiling 120 Event Profiling
175 --------------- 121 ---------------
176 You can check the total number of probe hits a 122 You can check the total number of probe hits and probe miss-hits via
177 /sys/kernel/tracing/kprobe_profile. !! 123 /sys/kernel/debug/tracing/kprobe_profile.
178 The first column is event name, the second is 124 The first column is event name, the second is the number of probe hits,
179 the third is the number of probe miss-hits. 125 the third is the number of probe miss-hits.
180 126
181 Kernel Boot Parameter <<
182 --------------------- <<
183 You can add and enable new kprobe events when <<
184 "kprobe_event=" parameter. The parameter accep <<
185 kprobe events, which format is similar to the <<
186 The difference is that the probe definition pa <<
187 instead of space. For example, adding myprobe <<
188 <<
189 p:myprobe do_sys_open dfd=%ax filename=%dx f <<
190 <<
191 should be below for kernel boot parameter (jus <<
192 <<
193 p:myprobe,do_sys_open,dfd=%ax,filename=%dx,f <<
194 <<
195 127
196 Usage examples 128 Usage examples
197 -------------- 129 --------------
198 To add a probe as a new event, write a new def 130 To add a probe as a new event, write a new definition to kprobe_events
199 as below:: 131 as below::
200 132
201 echo 'p:myprobe do_sys_open dfd=%ax filename !! 133 echo 'p:myprobe do_sys_open dfd=%ax filename=%dx flags=%cx mode=+4($stack)' > /sys/kernel/debug/tracing/kprobe_events
202 134
203 This sets a kprobe on the top of do_sys_open() 135 This sets a kprobe on the top of do_sys_open() function with recording
204 1st to 4th arguments as "myprobe" event. Note, 136 1st to 4th arguments as "myprobe" event. Note, which register/stack entry is
205 assigned to each function argument depends on 137 assigned to each function argument depends on arch-specific ABI. If you unsure
206 the ABI, please try to use probe subcommand of 138 the ABI, please try to use probe subcommand of perf-tools (you can find it
207 under tools/perf/). 139 under tools/perf/).
208 As this example shows, users can choose more f 140 As this example shows, users can choose more familiar names for each arguments.
209 :: 141 ::
210 142
211 echo 'r:myretprobe do_sys_open $retval' >> / !! 143 echo 'r:myretprobe do_sys_open $retval' >> /sys/kernel/debug/tracing/kprobe_events
212 144
213 This sets a kretprobe on the return point of d 145 This sets a kretprobe on the return point of do_sys_open() function with
214 recording return value as "myretprobe" event. 146 recording return value as "myretprobe" event.
215 You can see the format of these events via 147 You can see the format of these events via
216 /sys/kernel/tracing/events/kprobes/<EVENT>/for !! 148 /sys/kernel/debug/tracing/events/kprobes/<EVENT>/format.
217 :: 149 ::
218 150
219 cat /sys/kernel/tracing/events/kprobes/mypro !! 151 cat /sys/kernel/debug/tracing/events/kprobes/myprobe/format
220 name: myprobe 152 name: myprobe
221 ID: 780 153 ID: 780
222 format: 154 format:
223 field:unsigned short common_type; 155 field:unsigned short common_type; offset:0; size:2; signed:0;
224 field:unsigned char common_flags; 156 field:unsigned char common_flags; offset:2; size:1; signed:0;
225 field:unsigned char common_preempt_c 157 field:unsigned char common_preempt_count; offset:3; size:1;signed:0;
226 field:int common_pid; offset:4; 158 field:int common_pid; offset:4; size:4; signed:1;
227 159
228 field:unsigned long __probe_ip; offs 160 field:unsigned long __probe_ip; offset:12; size:4; signed:0;
229 field:int __probe_nargs; offs 161 field:int __probe_nargs; offset:16; size:4; signed:1;
230 field:unsigned long dfd; offs 162 field:unsigned long dfd; offset:20; size:4; signed:0;
231 field:unsigned long filename; offs 163 field:unsigned long filename; offset:24; size:4; signed:0;
232 field:unsigned long flags; offs 164 field:unsigned long flags; offset:28; size:4; signed:0;
233 field:unsigned long mode; offs 165 field:unsigned long mode; offset:32; size:4; signed:0;
234 166
235 167
236 print fmt: "(%lx) dfd=%lx filename=%lx flags 168 print fmt: "(%lx) dfd=%lx filename=%lx flags=%lx mode=%lx", REC->__probe_ip,
237 REC->dfd, REC->filename, REC->flags, REC->mo 169 REC->dfd, REC->filename, REC->flags, REC->mode
238 170
239 You can see that the event has 4 arguments as 171 You can see that the event has 4 arguments as in the expressions you specified.
240 :: 172 ::
241 173
242 echo > /sys/kernel/tracing/kprobe_events !! 174 echo > /sys/kernel/debug/tracing/kprobe_events
243 175
244 This clears all probe points. 176 This clears all probe points.
245 177
246 Or, 178 Or,
247 :: 179 ::
248 180
249 echo -:myprobe >> kprobe_events 181 echo -:myprobe >> kprobe_events
250 182
251 This clears probe points selectively. 183 This clears probe points selectively.
252 184
253 Right after definition, each event is disabled 185 Right after definition, each event is disabled by default. For tracing these
254 events, you need to enable it. 186 events, you need to enable it.
255 :: 187 ::
256 188
257 echo 1 > /sys/kernel/tracing/events/kprobes/ !! 189 echo 1 > /sys/kernel/debug/tracing/events/kprobes/myprobe/enable
258 echo 1 > /sys/kernel/tracing/events/kprobes/ !! 190 echo 1 > /sys/kernel/debug/tracing/events/kprobes/myretprobe/enable
259 191
260 Use the following command to start tracing in !! 192 And you can see the traced information via /sys/kernel/debug/tracing/trace.
261 :: 193 ::
262 194
263 # echo 1 > tracing_on !! 195 cat /sys/kernel/debug/tracing/trace
264 Open something... <<
265 # echo 0 > tracing_on <<
266 <<
267 And you can see the traced information via /sy <<
268 :: <<
269 <<
270 cat /sys/kernel/tracing/trace <<
271 # tracer: nop 196 # tracer: nop
272 # 197 #
273 # TASK-PID CPU# TIMESTAMP F 198 # TASK-PID CPU# TIMESTAMP FUNCTION
274 # | | | | 199 # | | | | |
275 <...>-1447 [001] 1038282.286875: 200 <...>-1447 [001] 1038282.286875: myprobe: (do_sys_open+0x0/0xd6) dfd=3 filename=7fffd1ec4440 flags=8000 mode=0
276 <...>-1447 [001] 1038282.286878: 201 <...>-1447 [001] 1038282.286878: myretprobe: (sys_openat+0xc/0xe <- do_sys_open) $retval=fffffffffffffffe
277 <...>-1447 [001] 1038282.286885: 202 <...>-1447 [001] 1038282.286885: myprobe: (do_sys_open+0x0/0xd6) dfd=ffffff9c filename=40413c flags=8000 mode=1b6
278 <...>-1447 [001] 1038282.286915: 203 <...>-1447 [001] 1038282.286915: myretprobe: (sys_open+0x1b/0x1d <- do_sys_open) $retval=3
279 <...>-1447 [001] 1038282.286969: 204 <...>-1447 [001] 1038282.286969: myprobe: (do_sys_open+0x0/0xd6) dfd=ffffff9c filename=4041c6 flags=98800 mode=10
280 <...>-1447 [001] 1038282.286976: 205 <...>-1447 [001] 1038282.286976: myretprobe: (sys_open+0x1b/0x1d <- do_sys_open) $retval=3
281 206
282 207
283 Each line shows when the kernel hits an event, 208 Each line shows when the kernel hits an event, and <- SYMBOL means kernel
284 returns from SYMBOL(e.g. "sys_open+0x1b/0x1d < 209 returns from SYMBOL(e.g. "sys_open+0x1b/0x1d <- do_sys_open" means kernel
285 returns from do_sys_open to sys_open+0x1b). 210 returns from do_sys_open to sys_open+0x1b).
>> 211
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.