2009-10-17 00:08:27 +00:00
perf-probe(1)
=============
NAME
----
perf-probe - Define new dynamic tracepoints
SYNOPSIS
--------
[verse]
2009-12-08 22:03:30 +00:00
'perf probe' [options] --add='PROBE' [...]
2009-11-04 00:12:13 +00:00
or
2009-12-08 22:03:30 +00:00
'perf probe' [options] PROBE
or
'perf probe' [options] --del='[GROUP:]EVENT' [...]
or
'perf probe' --list
2010-01-06 14:45:34 +00:00
or
'perf probe' --line='FUNC[:RLN[+NUM|:RLN2]]|SRC:ALN[+NUM|:ALN2]'
2009-10-17 00:08:27 +00:00
DESCRIPTION
-----------
This command defines dynamic tracepoint events, by symbol and registers
without debuginfo, or by C expressions (C line numbers, C function names,
and C local variables) with debuginfo.
OPTIONS
-------
-k::
2009-11-04 00:12:13 +00:00
--vmlinux=PATH::
2009-10-17 00:08:27 +00:00
Specify vmlinux path which has debuginfo (Dwarf binary).
-v::
--verbose::
Be more verbose (show parsed arguments, etc).
2009-11-04 00:12:13 +00:00
-a::
2009-12-08 22:03:30 +00:00
--add=::
Define a probe event (see PROBE SYNTAX for detail).
-d::
--del=::
Delete a probe event.
-l::
--list::
List up current probe events.
2009-10-17 00:08:27 +00:00
2010-01-06 14:45:34 +00:00
-L::
--line=::
Show source code lines which can be probed. This needs an argument
which specifies a range of the source code.
2009-10-17 00:08:27 +00:00
PROBE SYNTAX
------------
Probe points are defined by following syntax.
2009-12-15 15:32:18 +00:00
"[EVENT=]FUNC[+OFFS|:RLN|%return][@SRC]|SRC:ALN [ARG ...]"
2009-10-17 00:08:27 +00:00
2009-12-15 15:32:18 +00:00
'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'.
2009-11-04 00:12:13 +00:00
'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. In addition, 'SRC' specifies a source file which has that function.
It is also possible to specify a probe point by the source line number by using 'SRC:ALN' syntax, where 'SRC' is the source file path and 'ALN' is the line number.
2009-10-17 00:08:27 +00:00
'ARG' specifies the arguments of this probe point. You can use the name of local variable, or kprobe-tracer argument format (e.g. $retval, %ax, etc).
2010-01-06 14:45:34 +00:00
LINE SYNTAX
-----------
Line range is descripted by following syntax.
"FUNC[:RLN[+NUM|:RLN2]]|SRC:ALN[+NUM|:ALN2]"
FUNC specifies the function name of showing lines. 'RLN' is the start line
number from function entry line, and 'RLN2' is the end line number. As same as
probe syntax, 'SRC' means the source file path, 'ALN' is start line number,
and 'ALN2' is end line number in the file. It is also possible to specify how
many lines to show by using 'NUM'.
So, "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.
2009-10-17 00:08:27 +00:00
SEE ALSO
--------
linkperf:perf-trace[1], linkperf:perf-record[1]
