tools/perf/Documentation/perf-report.txt

   1 perf-report(1)
   2 ==============
   3
   4 NAME
   5 ----
   6 perf-report - Read perf.data (created by perf record) and display the profile
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'perf report' [-i <file> | --input=file]
  12
  13 DESCRIPTION
  14 -----------
  15 This command displays the performance counter profile information recorded
  16 via perf record.
  17
  18 OPTIONS
  19 -------
  20 -i::
  21 --input=::
  22         Input file name. (default: perf.data)
  23
  24 -v::
  25 --verbose::
  26         Be more verbose. (show symbol address, etc)
  27
  28 -d::
  29 --dsos=::
  30         Only consider symbols in these dsos. CSV that understands
  31         file://filename entries.
  32 -n::
  33 --show-nr-samples::
  34         Show the number of samples for each symbol
  35
  36 --showcpuutilization::
  37         Show sample percentage for different cpu modes.
  38
  39 -T::
  40 --threads::
  41         Show per-thread event counters
  42 -C::
  43 --comms=::
  44         Only consider symbols in these comms. CSV that understands
  45         file://filename entries.
  46 -S::
  47 --symbols=::
  48         Only consider these symbols. CSV that understands
  49         file://filename entries.
  50
  51 -U::
  52 --hide-unresolved::
  53         Only display entries resolved to a symbol.
  54
  55 -s::
  56 --sort=::
  57         Sort by key(s): pid, comm, dso, symbol, parent.
  58
  59 -p::
  60 --parent=<regex>::
  61         regex filter to identify parent, see: '--sort parent'
  62
  63 -x::
  64 --exclude-other::
  65         Only display entries with parent-match.
  66
  67 -w::
  68 --column-widths=<width[,width...]>::
  69         Force each column width to the provided list, for large terminal
  70         readability.
  71
  72 -t::
  73 --field-separator=::
  74
  75         Use a special separator character and don't pad with spaces, replacing
  76         all occurrences of this separator in symbol names (and other output)
  77         with a '.' character, that thus it's the only non valid separator.
  78
  79 -D::
  80 --dump-raw-trace::
  81         Dump raw trace in ASCII.
  82
  83 -g [type,min,order]::
  84 --call-graph::
  85         Display call chains using type, min percent threshold and order.
  86         type can be either:
  87         - flat: single column, linear exposure of call chains.
  88         - graph: use a graph tree, displaying absolute overhead rates.
  89         - fractal: like graph, but displays relative rates. Each branch of
  90                  the tree is considered as a new profiled object. +
  91
  92         order can be either:
  93         - callee: callee based call graph.
  94         - caller: inverted caller based call graph.
  95
  96         Default: fractal,0.5,callee.
  97
  98 -G::
  99 --inverted::
 100         alias for inverted caller based call graph.
 101
 102 --pretty=<key>::
 103         Pretty printing style.  key: normal, raw
 104
 105 --stdio:: Use the stdio interface.
 106
 107 --tui:: Use the TUI interface, that is integrated with annotate and allows
 108         zooming into DSOs or threads, among other features. Use of --tui
 109         requires a tty, if one is not present, as when piping to other
 110         commands, the stdio interface is used.
 111
 112 -k::
 113 --vmlinux=<file>::
 114         vmlinux pathname
 115
 116 --kallsyms=<file>::
 117         kallsyms pathname
 118
 119 -m::
 120 --modules::
 121         Load module symbols. WARNING: This should only be used with -k and
 122         a LIVE kernel.
 123
 124 -f::
 125 --force::
 126         Don't complain, do it.
 127
 128 --symfs=<directory>::
 129         Look for files with symbols relative to this directory.
 130
 131 -c::
 132 --cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can
 133         be provided as a comma-separated list with no space: 0,1. Ranges of
 134         CPUs are specified with -: 0-2. Default is to report samples on all
 135         CPUs.
 136
 137 -M::
 138 --disassembler-style=:: Set disassembler style for objdump.
 139
 140 --source::
 141         Interleave source code with assembly code. Enabled by default,
 142         disable with --no-source.
 143
 144 --asm-raw::
 145         Show raw instruction encoding of assembly instructions.
 146
 147 --show-total-period:: Show a column with the sum of periods.
 148
 149 -I::
 150 --show-info::
 151         Display extended information about the perf.data file. This adds
 152         information which may be very large and thus may clutter the display.
 153         It currently includes: cpu and numa topology of the host system.
 154
 155 SEE ALSO
 156 --------
 157 linkperf:perf-stat[1], linkperf:perf-annotate[1]