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