blob: 3a8a9ba2b0412aba28f1796e283106f84ec63266 [file] [log] [blame]
Masami Hiramatsu595c3642009-10-16 20:08:27 -04001perf-probe(1)
2=============
3
4NAME
5----
6perf-probe - Define new dynamic tracepoints
7
8SYNOPSIS
9--------
10[verse]
Masami Hiramatsuc937fe22009-12-08 17:03:30 -050011'perf probe' [options] --add='PROBE' [...]
Masami Hiramatsuc43f9d12009-11-03 19:12:13 -050012or
Masami Hiramatsuc937fe22009-12-08 17:03:30 -050013'perf probe' [options] PROBE
14or
15'perf probe' [options] --del='[GROUP:]EVENT' [...]
16or
Masami Hiramatsub6a89642015-04-24 18:47:50 +090017'perf probe' --list[=[GROUP:]EVENT]
Masami Hiramatsu631c9de2010-01-06 09:45:34 -050018or
Masami Hiramatsue116dfa2011-02-10 18:08:10 +090019'perf probe' [options] --line='LINE'
Masami Hiramatsucf6eb482010-10-21 19:13:23 +090020or
Masami Hiramatsu469b9b82010-10-21 19:13:41 +090021'perf probe' [options] --vars='PROBEPOINT'
Masami Hiramatsub3ac0322015-04-23 22:46:12 +090022or
23'perf probe' [options] --funcs
Masami Hiramatsu595c3642009-10-16 20:08:27 -040024
25DESCRIPTION
26-----------
27This command defines dynamic tracepoint events, by symbol and registers
28without debuginfo, or by C expressions (C line numbers, C function names,
29and C local variables) with debuginfo.
30
31
32OPTIONS
33-------
34-k::
Masami Hiramatsuc43f9d12009-11-03 19:12:13 -050035--vmlinux=PATH::
Masami Hiramatsu595c3642009-10-16 20:08:27 -040036 Specify vmlinux path which has debuginfo (Dwarf binary).
37
Masami Hiramatsu469b9b82010-10-21 19:13:41 +090038-m::
Masami Hiramatsu14a8fd72011-06-27 16:27:51 +090039--module=MODNAME|PATH::
Masami Hiramatsu469b9b82010-10-21 19:13:41 +090040 Specify module name in which perf-probe searches probe points
Masami Hiramatsu14a8fd72011-06-27 16:27:51 +090041 or lines. If a path of module file is passed, perf-probe
42 treat it as an offline module (this means you can add a probe on
43 a module which has not been loaded yet).
Masami Hiramatsu469b9b82010-10-21 19:13:41 +090044
Chase Douglas9ed7e1b2010-06-14 15:26:30 -040045-s::
46--source=PATH::
47 Specify path to kernel source.
48
Masami Hiramatsu595c3642009-10-16 20:08:27 -040049-v::
50--verbose::
51 Be more verbose (show parsed arguments, etc).
Masami Hiramatsu8b728052015-01-30 18:37:46 +090052 Can not use with -q.
53
54-q::
55--quiet::
56 Be quiet (do not show any messages including errors).
57 Can not use with -v.
Masami Hiramatsu595c3642009-10-16 20:08:27 -040058
Masami Hiramatsuc43f9d12009-11-03 19:12:13 -050059-a::
Masami Hiramatsuc937fe22009-12-08 17:03:30 -050060--add=::
61 Define a probe event (see PROBE SYNTAX for detail).
62
63-d::
64--del=::
Masami Hiramatsuee391de2010-02-25 08:35:19 -050065 Delete probe events. This accepts glob wildcards('*', '?') and character
66 classes(e.g. [a-z], [!A-Z]).
Masami Hiramatsuc937fe22009-12-08 17:03:30 -050067
68-l::
Masami Hiramatsub6a89642015-04-24 18:47:50 +090069--list[=[GROUP:]EVENT]::
70 List up current probe events. This can also accept filtering patterns of event names.
Masami Hiramatsu595c3642009-10-16 20:08:27 -040071
Masami Hiramatsu631c9de2010-01-06 09:45:34 -050072-L::
73--line=::
74 Show source code lines which can be probed. This needs an argument
Masami Hiramatsuee391de2010-02-25 08:35:19 -050075 which specifies a range of the source code. (see LINE SYNTAX for detail)
76
Masami Hiramatsucf6eb482010-10-21 19:13:23 +090077-V::
78--vars=::
79 Show available local variables at given probe point. The argument
80 syntax is same as PROBE SYNTAX, but NO ARGs.
81
Masami Hiramatsufb8c5a52010-10-21 19:13:35 +090082--externs::
83 (Only for --vars) Show external defined variables in addition to local
84 variables.
85
Masami Hiramatsu6cfd1f62015-05-08 10:03:33 +090086--no-inlines::
87 (Only for --add) Search only for non-inlined functions. The functions
88 which do not have instances are ignored.
89
Masami Hiramatsue80711c2011-01-13 21:46:11 +090090-F::
Masami Hiramatsu9f7811d2015-05-05 11:29:50 +090091--funcs[=FILTER]::
Srikar Dronamraju225466f2012-04-16 17:39:09 +053092 Show available functions in given module or kernel. With -x/--exec,
93 can also list functions in a user space executable / shared library.
Masami Hiramatsu9f7811d2015-05-05 11:29:50 +090094 This also can accept a FILTER rule argument.
Masami Hiramatsue80711c2011-01-13 21:46:11 +090095
Masami Hiramatsubd09d7b2011-01-20 23:15:39 +090096--filter=FILTER::
Masami Hiramatsu3c422582011-01-20 23:15:45 +090097 (Only for --vars and --funcs) Set filter. FILTER is a combination of glob
98 pattern, see FILTER PATTERN for detail.
99 Default FILTER is "!__k???tab_* & !__crc_*" for --vars, and "!_*"
100 for --funcs.
101 If several filters are specified, only the last filter is used.
Masami Hiramatsubd09d7b2011-01-20 23:15:39 +0900102
Masami Hiramatsuee391de2010-02-25 08:35:19 -0500103-f::
104--force::
105 Forcibly add events with existing name.
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500106
Masami Hiramatsuf4d7da42010-03-16 18:06:05 -0400107-n::
108--dry-run::
109 Dry run. With this option, --add and --del doesn't execute actual
110 adding and removal operations.
111
Masami Hiramatsu8b728052015-01-30 18:37:46 +0900112--max-probes=NUM::
Masami Hiramatsuef4a3562010-04-21 15:56:40 -0400113 Set the maximum number of probe points for an event. Default is 128.
114
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530115-x::
116--exec=PATH::
117 Specify path to the executable or shared library file for user
118 space tracing. Can also be used with --funcs option.
119
Masami Hiramatsu8b728052015-01-30 18:37:46 +0900120--demangle::
121 Demangle application symbols. --no-demangle is also available
122 for disabling demangling.
123
Avi Kivity763122a2014-09-13 07:15:05 +0300124--demangle-kernel::
Masami Hiramatsu8b728052015-01-30 18:37:46 +0900125 Demangle kernel symbols. --no-demangle-kernel is also available
126 for disabling kernel demangling.
Avi Kivity763122a2014-09-13 07:15:05 +0300127
Srikar Dronamraju73eff9f2012-04-16 17:39:25 +0530128In absence of -m/-x options, perf probe checks if the first argument after
129the options is an absolute path name. If its an absolute path, perf probe
130uses it as a target module/target user space binary to probe.
131
Masami Hiramatsu595c3642009-10-16 20:08:27 -0400132PROBE SYNTAX
133------------
134Probe points are defined by following syntax.
135
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500136 1) Define event based on function name
137 [EVENT=]FUNC[@SRC][:RLN|+OFFS|%return|;PTN] [ARG ...]
138
139 2) Define event based on source file with line number
140 [EVENT=]SRC:ALN [ARG ...]
141
142 3) Define event based on source file with lazy pattern
143 [EVENT=]SRC;PTN [ARG ...]
144
Masami Hiramatsu595c3642009-10-16 20:08:27 -0400145
Masami Hiramatsuaf663d72009-12-15 10:32:18 -0500146'EVENT' specifies the name of new event, if omitted, it will be set the name of the probed function. Currently, event group name is set as 'probe'.
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500147'FUNC' specifies a probed function name, and it may have one of the following options; '+OFFS' is the offset from function entry address in bytes, ':RLN' is the relative-line number from function entry line, and '%return' means that it probes function return. And ';PTN' means lazy matching pattern (see LAZY MATCHING). Note that ';PTN' must be the end of the probe point definition. In addition, '@SRC' specifies a source file which has that function.
148It is also possible to specify a probe point by the source line number or lazy matching by using 'SRC:ALN' or 'SRC;PTN' syntax, where 'SRC' is the source file path, ':ALN' is the line number and ';PTN' is the lazy matching pattern.
Masami Hiramatsu48481932010-04-12 13:16:53 -0400149'ARG' specifies the arguments of this probe point, (see PROBE ARGUMENT).
150
151PROBE ARGUMENT
152--------------
153Each probe argument follows below syntax.
154
Masami Hiramatsu11a1ca32010-04-12 13:17:22 -0400155 [NAME=]LOCALVAR|$retval|%REG|@SYMBOL[:TYPE]
Masami Hiramatsu48481932010-04-12 13:16:53 -0400156
Masami Hiramatsub2a3c122010-05-19 15:57:42 -0400157'NAME' specifies the name of this argument (optional). You can use the name of local variable, local data structure member (e.g. var->field, var.field2), local array with fixed index (e.g. array[1], var->array[0], var->pointer[2]), or kprobe-tracer argument format (e.g. $retval, %ax, etc). Note that the name of this argument will be set as the last member name if you specify a local data structure member (e.g. field2 for 'var->field1.field2'.)
Masami Hiramatsuf8bffbf2015-05-06 21:46:53 +0900158'$vars' and '$params' special arguments are also available for NAME, '$vars' is expanded to the local variables (including function parameters) which can access at given probe point. '$params' is expanded to only the function parameters.
Masami Hiramatsu73317b92010-05-19 15:57:35 -0400159'TYPE' casts the type of this argument (optional). If omitted, perf probe automatically set the type based on debuginfo. You can specify 'string' type only for the local variable or structure member which is an array of or a pointer to 'char' or 'unsigned char' type.
Masami Hiramatsu595c3642009-10-16 20:08:27 -0400160
Andi Kleen5b439822014-02-28 06:02:15 -0800161On x86 systems %REG is always the short form of the register: for example %AX. %RAX or %EAX is not valid.
162
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500163LINE SYNTAX
164-----------
Shawn Bohrer9d5b7f52010-11-30 19:57:15 -0600165Line range is described by following syntax.
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500166
Masami Hiramatsue116dfa2011-02-10 18:08:10 +0900167 "FUNC[@SRC][:RLN[+NUM|-RLN2]]|SRC[:ALN[+NUM|-ALN2]]"
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500168
169FUNC specifies the function name of showing lines. 'RLN' is the start line
170number from function entry line, and 'RLN2' is the end line number. As same as
171probe syntax, 'SRC' means the source file path, 'ALN' is start line number,
172and 'ALN2' is end line number in the file. It is also possible to specify how
Masami Hiramatsue116dfa2011-02-10 18:08:10 +0900173many lines to show by using 'NUM'. Moreover, 'FUNC@SRC' combination is good
174for searching a specific function when several functions share same name.
Masami Hiramatsu631c9de2010-01-06 09:45:34 -0500175So, "source.c:100-120" shows lines between 100th to l20th in source.c file. And "func:10+20" shows 20 lines from 10th line of func function.
176
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500177LAZY MATCHING
178-------------
179 The lazy line matching is similar to glob matching but ignoring spaces in both of pattern and target. So this accepts wildcards('*', '?') and character classes(e.g. [a-z], [!A-Z]).
180
181e.g.
182 'a=*' can matches 'a=b', 'a = b', 'a == b' and so on.
183
184This provides some sort of flexibility and robustness to probe point definitions against minor code changes. For example, actual 10th line of schedule() can be moved easily by modifying schedule(), but the same line matching 'rq=cpu_rq*' may still exist in the function.)
185
Masami Hiramatsubd09d7b2011-01-20 23:15:39 +0900186FILTER PATTERN
187--------------
188 The filter pattern is a glob matching pattern(s) to filter variables.
189 In addition, you can use "!" for specifying filter-out rule. You also can give several rules combined with "&" or "|", and fold those rules as one rule by using "(" ")".
190
191e.g.
192 With --filter "foo* | bar*", perf probe -V shows variables which start with "foo" or "bar".
193 With --filter "!foo* & *bar", perf probe -V shows variables which don't start with "foo" and end with "bar", like "fizzbar". But "foobar" is filtered out.
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500194
Masami Hiramatsuee391de2010-02-25 08:35:19 -0500195EXAMPLES
196--------
197Display which lines in schedule() can be probed:
198
199 ./perf probe --line schedule
200
201Add a probe on schedule() function 12th line with recording cpu local variable:
202
203 ./perf probe schedule:12 cpu
204 or
205 ./perf probe --add='schedule:12 cpu'
206
207 this will add one or more probes which has the name start with "schedule".
208
Masami Hiramatsu2a9c8c32010-02-25 08:36:12 -0500209 Add probes on lines in schedule() function which calls update_rq_clock().
210
211 ./perf probe 'schedule;update_rq_clock*'
212 or
213 ./perf probe --add='schedule;update_rq_clock*'
214
Masami Hiramatsuee391de2010-02-25 08:35:19 -0500215Delete all probes on schedule().
216
217 ./perf probe --del='schedule*'
218
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530219Add probes at zfree() function on /bin/zsh
220
Srikar Dronamraju73eff9f2012-04-16 17:39:25 +0530221 ./perf probe -x /bin/zsh zfree or ./perf probe /bin/zsh zfree
Srikar Dronamraju225466f2012-04-16 17:39:09 +0530222
223Add probes at malloc() function on libc
224
Srikar Dronamraju73eff9f2012-04-16 17:39:25 +0530225 ./perf probe -x /lib/libc.so.6 malloc or ./perf probe /lib/libc.so.6 malloc
Masami Hiramatsuee391de2010-02-25 08:35:19 -0500226
Masami Hiramatsu595c3642009-10-16 20:08:27 -0400227SEE ALSO
228--------
229linkperf:perf-trace[1], linkperf:perf-record[1]