Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 8b72805f authored by Masami Hiramatsu's avatar Masami Hiramatsu Committed by Arnaldo Carvalho de Melo
Browse files

perf probe: Update man page 



Update Documentation/perf-probe.txt to add descriptions of some newer
options.

Signed-off-by: default avatarMasami Hiramatsu <masami.hiramatsu.pt@hitachi.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Link: http://lkml.kernel.org/r/20150130093746.30575.8571.stgit@localhost.localdomain


Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent e1ecbbc3

tools/perf/Documentation/perf-probe.txt

+14 −2
Original line number Diff line number Diff line
@@ -47,6 +47,12 @@ OPTIONS 
-v::

--verbose::

        Be more verbose (show parsed arguments, etc).

	Can not use with -q.



-q::

--quiet::

	Be quiet (do not show any messages including errors).

	Can not use with -v.



-a::

--add=::
@@ -96,7 +102,7 @@ OPTIONS 
	Dry run. With this option, --add and --del doesn't execute actual

	adding and removal operations.



--max-probes::

--max-probes=NUM::

	Set the maximum number of probe points for an event. Default is 128.



-x::
@@ -104,8 +110,13 @@ OPTIONS 
	Specify path to the executable or shared library file for user

	space tracing. Can also be used with --funcs option.



--demangle::

	Demangle application symbols. --no-demangle is also available

	for disabling demangling.



--demangle-kernel::

	Demangle kernel symbols.

	Demangle kernel symbols. --no-demangle-kernel is also available

	for disabling kernel demangling.



In absence of -m/-x options, perf probe checks if the first argument after

the options is an absolute path name. If its an absolute path, perf probe
@@ -137,6 +148,7 @@ Each probe argument follows below syntax. 
 [NAME=]LOCALVAR|$retval|%REG|@SYMBOL[:TYPE]



'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'.)

'$vars' special argument is also available for NAME, it is expanded to the local variables which can access at given probe point.

'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.



On x86 systems %REG is always the short form of the register: for example %AX. %RAX or %EAX is not valid.