Skip to content

Commit

Permalink
perf probe: Update perf probe document
Browse files Browse the repository at this point in the history
Update perf-probe.txt to suit to current perf-probe command
and add some examples.

Signed-off-by: Masami Hiramatsu <mhiramat@redhat.com>
Cc: systemtap <systemtap@sources.redhat.com>
Cc: DLE <dle-develop@lists.sourceforge.net>
Cc: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Arnaldo Carvalho de Melo <acme@redhat.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Paul Mackerras <paulus@samba.org>
Cc: Mike Galbraith <efault@gmx.de>
Cc: K.Prasad <prasad@linux.vnet.ibm.com>
Cc: Frederic Weisbecker <fweisbec@gmail.com>
Cc: Ananth N Mavinakayanahalli <ananth@in.ibm.com>
LKML-Reference: <20100225133519.6725.58816.stgit@localhost6.localdomain6>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
  • Loading branch information
Masami Hiramatsu authored and Ingo Molnar committed Feb 25, 2010
1 parent f3ab481 commit ee391de
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions tools/perf/Documentation/perf-probe.txt
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ OPTIONS

-d::
--del=::
Delete a probe event.
Delete probe events. This accepts glob wildcards('*', '?') and character
classes(e.g. [a-z], [!A-Z]).

-l::
--list::
Expand All @@ -50,7 +51,11 @@ OPTIONS
-L::
--line=::
Show source code lines which can be probed. This needs an argument
which specifies a range of the source code.
which specifies a range of the source code. (see LINE SYNTAX for detail)

-f::
--force::
Forcibly add events with existing name.

PROBE SYNTAX
------------
Expand All @@ -76,6 +81,25 @@ 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.

EXAMPLES
--------
Display which lines in schedule() can be probed:

./perf probe --line schedule

Add a probe on schedule() function 12th line with recording cpu local variable:

./perf probe schedule:12 cpu
or
./perf probe --add='schedule:12 cpu'

this will add one or more probes which has the name start with "schedule".

Delete all probes on schedule().

./perf probe --del='schedule*'


SEE ALSO
--------
linkperf:perf-trace[1], linkperf:perf-record[1]

0 comments on commit ee391de

Please sign in to comment.