perf report: Add a simple GTK2-based 'perf report' browser
[linux-flexiantxendom0-3.2.10.git] / tools / perf / Documentation / perf-report.txt
index cfa8e51..2d89f02 100644 (file)
@@ -19,7 +19,7 @@ OPTIONS
 -------
 -i::
 --input=::
-        Input file name. (default: perf.data)
+        Input file name. (default: perf.data unless stdin is a fifo)
 
 -v::
 --verbose::
@@ -39,7 +39,7 @@ OPTIONS
 -T::
 --threads::
        Show per-thread event counters
--C::
+-c::
 --comms=::
        Only consider symbols in these comms. CSV that understands
        file://filename entries.
@@ -48,6 +48,9 @@ OPTIONS
        Only consider these symbols. CSV that understands
        file://filename entries.
 
+--symbol-filter=::
+       Only show symbols that match (partially) with this filter.
+
 -U::
 --hide-unresolved::
         Only display entries resolved to a symbol.
@@ -80,9 +83,10 @@ OPTIONS
 --dump-raw-trace::
         Dump raw trace in ASCII.
 
--g [type,min,order]::
+-g [type,min[,limit],order]::
 --call-graph::
-        Display call chains using type, min percent threshold and order.
+        Display call chains using type, min percent threshold, optional print
+       limit and order.
        type can be either:
        - flat: single column, linear exposure of call chains.
        - graph: use a graph tree, displaying absolute overhead rates.
@@ -109,6 +113,8 @@ OPTIONS
        requires a tty, if one is not present, as when piping to other
        commands, the stdio interface is used.
 
+--gtk:: Use the GTK2 interface.
+
 -k::
 --vmlinux=<file>::
         vmlinux pathname
@@ -128,6 +134,40 @@ OPTIONS
 --symfs=<directory>::
         Look for files with symbols relative to this directory.
 
+-C::
+--cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can
+       be provided as a comma-separated list with no space: 0,1. Ranges of
+       CPUs are specified with -: 0-2. Default is to report samples on all
+       CPUs.
+
+-M::
+--disassembler-style=:: Set disassembler style for objdump.
+
+--source::
+       Interleave source code with assembly code. Enabled by default,
+       disable with --no-source.
+
+--asm-raw::
+       Show raw instruction encoding of assembly instructions.
+
+--show-total-period:: Show a column with the sum of periods.
+
+-I::
+--show-info::
+       Display extended information about the perf.data file. This adds
+       information which may be very large and thus may clutter the display.
+       It currently includes: cpu and numa topology of the host system.
+
+-b::
+--branch-stack::
+       Use the addresses of sampled taken branches instead of the instruction
+       address to build the histograms. To generate meaningful output, the
+       perf.data file must have been obtained using perf record -b or
+       perf record --branch-filter xxx where xxx is a branch filter option.
+       perf report is able to auto-detect whether a perf.data file contains
+       branch stacks and it will automatically switch to the branch view mode,
+       unless --no-branch-stack is used.
+
 SEE ALSO
 --------
-linkperf:perf-stat[1]
+linkperf:perf-stat[1], linkperf:perf-annotate[1]