perf report: Documentation average IPC and IPC coverage

Add explanations for new columns "IPC" and "IPC coverage" in perf
documentation.

 v5:
 ---
 Update the description according to Ingo's comments.

Signed-off-by: Jin Yao <[email protected]>
Reviewed-by: Ingo Molnar <[email protected]>
Reviewed-by: Jiri Olsa <[email protected]>
Cc: Alexander Shishkin <[email protected]>
Cc: Andi Kleen <[email protected]>
Cc: Kan Liang <[email protected]>
Cc: Peter Zijlstra <[email protected]>
Link: http://lkml.kernel.org/r/[email protected]
Signed-off-by: Arnaldo Carvalho de Melo <[email protected]>

diff --git a/tools/perf/Documentation/perf-report.txt b/tools/perf/Documentation/perf-report.txt
index 474a4941f65dabdbc29911a7b324a0ff2fcd63e9..ed2bf37ab132f986ec60b33bc090f516f31c63a3 100644 (file)
--- a/tools/perf/Documentation/perf-report.txt
+++ b/tools/perf/Documentation/perf-report.txt
@@ -126,6 +126,14 @@ OPTIONS
        And default sort keys are changed to comm, dso_from, symbol_from, dso_to
        and symbol_to, see '--branch-stack'.
 
+       When the sort key symbol is specified, columns "IPC" and "IPC Coverage"
+       are enabled automatically. Column "IPC" reports the average IPC per function
+       and column "IPC coverage" reports the percentage of instructions with
+       sampled IPC in this function. IPC means Instruction Per Cycle. If it's low,
+       it indicates there may be a performance bottleneck when the function is
+       executed, such as a memory access bottleneck. If a function has high overhead
+       and low IPC, it's worth further analyzing it to optimize its performance.
+
        If the --mem-mode option is used, the following sort keys are also available
        (incompatible with --branch-stack):
        symbol_daddr, dso_daddr, locked, tlb, mem, snoop, dcacheline.