Commit | Line | Data |
---|---|---|
00b27da3 CD |
1 | ========================================= |
2 | Uprobe-tracer: Uprobe-based Event Tracing | |
3 | ========================================= | |
decc6bfb | 4 | |
00b27da3 | 5 | :Author: Srikar Dronamraju |
decc6bfb | 6 | |
f3f096cf SD |
7 | |
8 | Overview | |
9 | -------- | |
10 | Uprobe based trace events are similar to kprobe based trace events. | |
6b0b7551 | 11 | To enable this feature, build your kernel with CONFIG_UPROBE_EVENTS=y. |
f3f096cf SD |
12 | |
13 | Similar to the kprobe-event tracer, this doesn't need to be activated via | |
14 | current_tracer. Instead of that, add probe points via | |
15 | /sys/kernel/debug/tracing/uprobe_events, and enable it via | |
e50891d6 | 16 | /sys/kernel/debug/tracing/events/uprobes/<EVENT>/enable. |
f3f096cf SD |
17 | |
18 | However unlike kprobe-event tracer, the uprobe event interface expects the | |
decc6bfb | 19 | user to calculate the offset of the probepoint in the object. |
f3f096cf | 20 | |
0597c49c MH |
21 | You can also use /sys/kernel/debug/tracing/dynamic_events instead of |
22 | uprobe_events. That interface will provide unified access to other | |
23 | dynamic events too. | |
24 | ||
f3f096cf SD |
25 | Synopsis of uprobe_tracer |
26 | ------------------------- | |
00b27da3 CD |
27 | :: |
28 | ||
306cfe20 NK |
29 | p[:[GRP/]EVENT] PATH:OFFSET [FETCHARGS] : Set a uprobe |
30 | r[:[GRP/]EVENT] PATH:OFFSET [FETCHARGS] : Set a return uprobe (uretprobe) | |
638e476d | 31 | p[:[GRP/]EVENT] PATH:OFFSET%return [FETCHARGS] : Set a return uprobe (uretprobe) |
306cfe20 | 32 | -:[GRP/]EVENT : Clear uprobe or uretprobe event |
f3f096cf | 33 | |
decc6bfb AA |
34 | GRP : Group name. If omitted, "uprobes" is the default value. |
35 | EVENT : Event name. If omitted, the event name is generated based | |
306cfe20 | 36 | on PATH+OFFSET. |
decc6bfb | 37 | PATH : Path to an executable or a library. |
306cfe20 | 38 | OFFSET : Offset where the probe is inserted. |
638e476d | 39 | OFFSET%return : Offset where the return probe is inserted. |
f3f096cf | 40 | |
decc6bfb AA |
41 | FETCHARGS : Arguments. Each probe can have up to 128 args. |
42 | %REG : Fetch register REG | |
b079d374 | 43 | @ADDR : Fetch memory at ADDR (ADDR should be in userspace) |
b7e0bf34 | 44 | @+OFFSET : Fetch memory at OFFSET (OFFSET from same file as PATH) |
b079d374 NK |
45 | $stackN : Fetch Nth entry of stack (N >= 0) |
46 | $stack : Fetch stack address. | |
e65f7ae7 | 47 | $retval : Fetch return value.(\*1) |
35abb67d | 48 | $comm : Fetch current task comm. |
e65f7ae7 | 49 | +|-[u]OFFS(FETCHARG) : Fetch memory at FETCHARG +|- OFFS address.(\*2)(\*3) |
6218bf9f | 50 | \IMM : Store an immediate value to the argument. |
b079d374 NK |
51 | NAME=FETCHARG : Set NAME as the argument name of FETCHARG. |
52 | FETCHARG:TYPE : Set TYPE as the type of FETCHARG. Currently, basic types | |
17ce3dc7 MH |
53 | (u8/u16/u32/u64/s8/s16/s32/s64), hexadecimal types |
54 | (x8/x16/x32/x64), "string" and bitfield are supported. | |
b079d374 | 55 | |
e65f7ae7 MH |
56 | (\*1) only for return probe. |
57 | (\*2) this is useful for fetching a field of data structures. | |
58 | (\*3) Unlike kprobe event, "u" prefix will just be ignored, becuse uprobe | |
59 | events can access only user-space memory. | |
b079d374 NK |
60 | |
61 | Types | |
62 | ----- | |
63 | Several types are supported for fetch-args. Uprobe tracer will access memory | |
64 | by given type. Prefix 's' and 'u' means those types are signed and unsigned | |
bdca79c2 MH |
65 | respectively. 'x' prefix implies it is unsigned. Traced arguments are shown |
66 | in decimal ('s' and 'u') or hexadecimal ('x'). Without type casting, 'x32' | |
67 | or 'x64' is used depends on the architecture (e.g. x86-32 uses x32, and | |
68 | x86-64 uses x64). | |
b079d374 NK |
69 | String type is a special type, which fetches a "null-terminated" string from |
70 | user space. | |
71 | Bitfield is another special type, which takes 3 parameters, bit-width, bit- | |
00b27da3 | 72 | offset, and container-size (usually 32). The syntax is:: |
b079d374 NK |
73 | |
74 | b<bit-width>@<bit-offset>/<container-size> | |
75 | ||
35abb67d OS |
76 | For $comm, the default type is "string"; any other type is invalid. |
77 | ||
f3f096cf SD |
78 | |
79 | Event Profiling | |
80 | --------------- | |
b689269b SD |
81 | You can check the total number of probe hits per event via |
82 | /sys/kernel/debug/tracing/uprobe_profile. The first column is the filename, | |
83 | the second is the event name, the third is the number of probe hits. | |
f3f096cf SD |
84 | |
85 | Usage examples | |
86 | -------------- | |
decc6bfb | 87 | * Add a probe as a new uprobe event, write a new definition to uprobe_events |
00b27da3 | 88 | as below (sets a uprobe at an offset of 0x4245c0 in the executable /bin/bash):: |
decc6bfb | 89 | |
7058763b | 90 | echo 'p /bin/bash:0x4245c0' > /sys/kernel/debug/tracing/uprobe_events |
decc6bfb | 91 | |
00b27da3 | 92 | * Add a probe as a new uretprobe event:: |
decc6bfb | 93 | |
7058763b | 94 | echo 'r /bin/bash:0x4245c0' > /sys/kernel/debug/tracing/uprobe_events |
decc6bfb | 95 | |
00b27da3 | 96 | * Unset registered event:: |
f3f096cf | 97 | |
7058763b | 98 | echo '-:p_bash_0x4245c0' >> /sys/kernel/debug/tracing/uprobe_events |
f3f096cf | 99 | |
00b27da3 | 100 | * Print out the events that are registered:: |
f3f096cf | 101 | |
decc6bfb | 102 | cat /sys/kernel/debug/tracing/uprobe_events |
f3f096cf | 103 | |
00b27da3 | 104 | * Clear all events:: |
f3f096cf | 105 | |
decc6bfb AA |
106 | echo > /sys/kernel/debug/tracing/uprobe_events |
107 | ||
108 | Following example shows how to dump the instruction pointer and %ax register | |
00b27da3 | 109 | at the probed text address. Probe zfree function in /bin/zsh:: |
f3f096cf SD |
110 | |
111 | # cd /sys/kernel/debug/tracing/ | |
decc6bfb | 112 | # cat /proc/`pgrep zsh`/maps | grep /bin/zsh | grep r-xp |
f3f096cf SD |
113 | 00400000-0048a000 r-xp 00000000 08:03 130904 /bin/zsh |
114 | # objdump -T /bin/zsh | grep -w zfree | |
115 | 0000000000446420 g DF .text 0000000000000012 Base zfree | |
116 | ||
00b27da3 CD |
117 | 0x46420 is the offset of zfree in object /bin/zsh that is loaded at |
118 | 0x00400000. Hence the command to uprobe would be:: | |
decc6bfb AA |
119 | |
120 | # echo 'p:zfree_entry /bin/zsh:0x46420 %ip %ax' > uprobe_events | |
121 | ||
00b27da3 | 122 | And the same for the uretprobe would be:: |
f3f096cf | 123 | |
decc6bfb | 124 | # echo 'r:zfree_exit /bin/zsh:0x46420 %ip %ax' >> uprobe_events |
f3f096cf | 125 | |
00b27da3 CD |
126 | .. note:: User has to explicitly calculate the offset of the probe-point |
127 | in the object. | |
128 | ||
129 | We can see the events that are registered by looking at the uprobe_events file. | |
130 | :: | |
f3f096cf SD |
131 | |
132 | # cat uprobe_events | |
decc6bfb AA |
133 | p:uprobes/zfree_entry /bin/zsh:0x00046420 arg1=%ip arg2=%ax |
134 | r:uprobes/zfree_exit /bin/zsh:0x00046420 arg1=%ip arg2=%ax | |
ec83db0f | 135 | |
00b27da3 CD |
136 | Format of events can be seen by viewing the file events/uprobes/zfree_entry/format. |
137 | :: | |
ec83db0f | 138 | |
decc6bfb AA |
139 | # cat events/uprobes/zfree_entry/format |
140 | name: zfree_entry | |
ec83db0f SD |
141 | ID: 922 |
142 | format: | |
decc6bfb AA |
143 | field:unsigned short common_type; offset:0; size:2; signed:0; |
144 | field:unsigned char common_flags; offset:2; size:1; signed:0; | |
145 | field:unsigned char common_preempt_count; offset:3; size:1; signed:0; | |
146 | field:int common_pid; offset:4; size:4; signed:1; | |
147 | field:int common_padding; offset:8; size:4; signed:1; | |
ec83db0f | 148 | |
decc6bfb AA |
149 | field:unsigned long __probe_ip; offset:12; size:4; signed:0; |
150 | field:u32 arg1; offset:16; size:4; signed:0; | |
151 | field:u32 arg2; offset:20; size:4; signed:0; | |
ec83db0f SD |
152 | |
153 | print fmt: "(%lx) arg1=%lx arg2=%lx", REC->__probe_ip, REC->arg1, REC->arg2 | |
f3f096cf SD |
154 | |
155 | Right after definition, each event is disabled by default. For tracing these | |
00b27da3 | 156 | events, you need to enable it by:: |
f3f096cf SD |
157 | |
158 | # echo 1 > events/uprobes/enable | |
159 | ||
78a89463 | 160 | Lets start tracing, sleep for some time and stop tracing. |
00b27da3 | 161 | :: |
decc6bfb | 162 | |
78a89463 | 163 | # echo 1 > tracing_on |
f3f096cf | 164 | # sleep 20 |
78a89463 LC |
165 | # echo 0 > tracing_on |
166 | ||
167 | Also, you can disable the event by:: | |
168 | ||
f3f096cf SD |
169 | # echo 0 > events/uprobes/enable |
170 | ||
171 | And you can see the traced information via /sys/kernel/debug/tracing/trace. | |
00b27da3 | 172 | :: |
f3f096cf SD |
173 | |
174 | # cat trace | |
175 | # tracer: nop | |
176 | # | |
177 | # TASK-PID CPU# TIMESTAMP FUNCTION | |
178 | # | | | | | | |
decc6bfb AA |
179 | zsh-24842 [006] 258544.995456: zfree_entry: (0x446420) arg1=446420 arg2=79 |
180 | zsh-24842 [007] 258545.000270: zfree_exit: (0x446540 <- 0x446420) arg1=446540 arg2=0 | |
181 | zsh-24842 [002] 258545.043929: zfree_entry: (0x446420) arg1=446420 arg2=79 | |
182 | zsh-24842 [004] 258547.046129: zfree_exit: (0x446540 <- 0x446420) arg1=446540 arg2=0 | |
183 | ||
184 | Output shows us uprobe was triggered for a pid 24842 with ip being 0x446420 | |
185 | and contents of ax register being 79. And uretprobe was triggered with ip at | |
186 | 0x446540 with counterpart function entry at 0x446420. |