perf script: Enable printing of branch stack

[cascardo/linux.git] / tools / perf / Documentation / perf-script.txt

diff --git a/tools/perf/Documentation/perf-script.txt b/tools/perf/Documentation/perf-script.txt
index b3b42f9..382ddfb 100644 (file)
--- a/tools/perf/Documentation/perf-script.txt
+++ b/tools/perf/Documentation/perf-script.txt
@@ -112,11 +112,11 @@ OPTIONS
 --debug-mode::
         Do various checks like samples ordering and lost events.
 
--f::
+-F::
 --fields::
         Comma separated list of fields to print. Options are:
         comm, tid, pid, time, cpu, event, trace, ip, sym, dso, addr, symoff,
-       srcline, period, iregs, flags.
+       srcline, period, iregs, brstack, brstacksym, flags.
         Field list can be prepended with the type, trace, sw or hw,
         to indicate to which event type the field list applies.
         e.g., -f sw:comm,tid,time,ip,sym  and -f trace:time,cpu,trace
@@ -175,6 +175,16 @@ OPTIONS
        Finally, a user may not set fields to none for all event types.
        i.e., -f "" is not allowed.
 
+       The brstack output includes branch related information with raw addresses using the
+       /v/v/v/v/ syntax in the following order:
+       FROM: branch source instruction
+       TO  : branch target instruction
+        M/P/-: M=branch target mispredicted or branch direction was mispredicted, P=target predicted or direction predicted, -=not supported
+       X/- : X=branch inside a transactional region, -=not in transaction region or not supported
+       A/- : A=TSX abort entry, -=not aborted region or not supported
+
+       The brstacksym is identical to brstack, except that the FROM and TO addresses are printed in a symbolic form if possible.
+
 -k::
 --vmlinux=<file>::
         vmlinux pathname