Clarify perf man pages
This clarifies two common problems in the perf man pages. No code changes.
PATCH 1/2 perf, tools, mem: Clarify load-latency in documentation
From: Andi Kleen <[email protected]>
Clarify in the documentation that perf mem report reports use-latency, not load/store-latency on Intel systems. This often causes confusion with users.
--- tools/perf/Documentation/perf-mem.txt | 4 ++++ 1 file changed, 4 insertions(+)
tools/perf/Documentation/perf-mem.txt +4 -0
@@ -18,6 +18,10 @@ from it, into perf.data. Perf record options are accepted and are passed through "perf mem -t <TYPE> report" displays the result. It invokes perf report with the right set of options to display a memory access profile. +Note that on Intel systems the memory latency reported is the use-latency, +not the pure load (or store latency). Use latency includes any pipeline +queueing delays in addition to the memory subsystem latency. + OPTIONS ------- <command>...::
Signature · 1 line
1.8.5.3
tip-bot for Andi Kleen
merge bot[tip:perf/core] perf mem: Clarify load-latency in documentation
perf mem: Clarify load-latency in documentation
Commit-ID: b63940970492f5f187d546e191bc2c6831491fe3 Gitweb: http://git.kernel.org/tip/b63940970492f5f187d546e191bc2c6831491fe3 Author: Andi Kleen <[email protected]> AuthorDate: Fri, 28 Feb 2014 06:02:14 -0800 Committer: Arnaldo Carvalho de Melo <[email protected]> CommitDate: Fri, 14 Mar 2014 11:20:44 -0300
perf mem: Clarify load-latency in documentation
Clarify in the documentation that 'perf mem report' reports use-latency, not load/store-latency on Intel systems.
This often causes confusion with users.
--- tools/perf/Documentation/perf-mem.txt | 4 ++++ 1 file changed, 4 insertions(+)
tools/perf/Documentation/perf-mem.txt +4 -0
@@ -18,6 +18,10 @@ from it, into perf.data. Perf record options are accepted and are passed through "perf mem -t <TYPE> report" displays the result. It invokes perf report with the right set of options to display a memory access profile. +Note that on Intel systems the memory latency reported is the use-latency, +not the pure load (or store latency). Use latency includes any pipeline +queueing delays in addition to the memory subsystem latency. + OPTIONS ------- <command>...::
PATCH 2/2 perf, tools, probe: Clarify x86 register naming for perf probe
In reply to Andi KleenFrom: Andi Kleen <[email protected]>
Clarify how to specify x86 registers in perf probe. I recently ran into this problem and had to figure it out from the source.
--- tools/perf/Documentation/perf-probe.txt | 2 ++ 1 file changed, 2 insertions(+)
tools/perf/Documentation/perf-probe.txt +2 -0
@@ -136,6 +136,8 @@ Each probe argument follows below syntax. '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'.) '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. + LINE SYNTAX ----------- Line range is described by following syntax.
Signature · 1 line
1.8.5.3
Re: [PATCH 2/2] perf, tools, probe: Clarify x86 register naming for perf probe
Quoted 7 lines · Andi Kleen
From: Andi Kleen <[email protected]>
Clarify how to specify x86 registers in perf probe. I recently ran into this problem and had to figure it out from the source.
Signed-off-by Andi Kleen <[email protected]>
Thanks!
Quoted 18 lines
--- tools/perf/Documentation/perf-probe.txt | 2 ++ 1 file changed, 2 insertions(+)tools/perf/Documentation/perf-probe.txt +2
-0@@ -136,6 +136,8 @@ Each probe argument follows below syntax. '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'.) '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. + LINE SYNTAX ----------- Line range is described by following syntax.
Signature · 4 lines
Masami HIRAMATSU IT Management Research Dept. Linux Technology Center Hitachi, Ltd., Yokohama Research Laboratory E-mail: [email protected]
tip-bot for Andi Kleen
merge bot[tip:perf/core] perf probe: Clarify x86 register naming for perf probe
In reply to Andi Kleenperf probe: Clarify x86 register naming for perf probe
Commit-ID: 5b4398209d646635a4d84c46a5c7193fbce1a07c Gitweb: http://git.kernel.org/tip/5b4398209d646635a4d84c46a5c7193fbce1a07c Author: Andi Kleen <[email protected]> AuthorDate: Fri, 28 Feb 2014 06:02:15 -0800 Committer: Arnaldo Carvalho de Melo <[email protected]> CommitDate: Fri, 14 Mar 2014 11:20:44 -0300
perf probe: Clarify x86 register naming for perf probe
Clarify how to specify x86 registers in perf probe. I recently ran into this problem and had to figure it out from the source.
--- tools/perf/Documentation/perf-probe.txt | 2 ++ 1 file changed, 2 insertions(+)
tools/perf/Documentation/perf-probe.txt +2 -0
@@ -136,6 +136,8 @@ Each probe argument follows below syntax. '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'.) '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. + LINE SYNTAX ----------- Line range is described by following syntax.