Commit 595c3649 authored by Masami Hiramatsu's avatar Masami Hiramatsu Committed by Ingo Molnar

perf: Add perf-probe document

Add perf-probe subcommand document and add it to command-list.
Signed-off-by: default avatarMasami Hiramatsu <mhiramat@redhat.com>
Cc: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Arnaldo Carvalho de Melo <acme@redhat.com>
Cc: Steven Rostedt <rostedt@goodmis.org>
Cc: Paul Mackerras <paulus@samba.org>
Cc: Peter Zijlstra <a.p.zijlstra@chello.nl>
LKML-Reference: <20091017000827.16556.73539.stgit@dhcp-100-2-132.bos.redhat.com>
Signed-off-by: default avatarIngo Molnar <mingo@elte.hu>
parent 9769833b
perf-probe(1)
=============
NAME
----
perf-probe - Define new dynamic tracepoints
SYNOPSIS
--------
[verse]
'perf probe' [-k <file>] -P 'PROBE' [-P 'PROBE' ...]
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::
--vmlinux::
Specify vmlinux path which has debuginfo (Dwarf binary).
-v::
--verbose::
Be more verbose (show parsed arguments, etc).
-P::
--probe::
Define a probe point (see PROBE SYNTAX for detail)
PROBE SYNTAX
------------
Probe points are defined by following syntax.
"TYPE:[GRP/]NAME FUNC[+OFFS][@SRC]|@SRC:LINE [ARG ...]"
'TYPE' specifies the type of probe point, you can use either "p" (kprobe) or "r" (kretprobe) for 'TYPE'. 'GRP' specifies the group name of this probe, and 'NAME' specifies the event name. If 'GRP' is omitted, "kprobes" is used for its group name.
'FUNC' and 'OFFS' specifies function and offset (in byte) where probe will be put. In addition, 'SRC' specifies a source file which has that function (this is mainly for inline functions).
You can specify a probe point by the source line number by using '@SRC:LINE' syntax, where 'SRC' is the source file path and 'LINE' is the line number.
'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).
SEE ALSO
--------
linkperf:perf-trace[1], linkperf:perf-record[1]
......@@ -11,3 +11,4 @@ perf-stat mainporcelain common
perf-timechart mainporcelain common
perf-top mainporcelain common
perf-trace mainporcelain common
perf-probe mainporcelain common
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment