tools/perf/Documentation/perf-annotate.txt

   1 perf-annotate(1)
   2 ================
   3
   4 NAME
   5 ----
   6 perf-annotate - Read perf.data (created by perf record) and display annotated code
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'perf annotate' [-i <file> | --input=file] [symbol_name]
  12
  13 DESCRIPTION
  14 -----------
  15 This command reads the input file and displays an annotated version of the
  16 code. If the object file has debug symbols then the source code will be
  17 displayed alongside assembly code.
  18
  19 If there is no debug info in the object, then annotated assembly is displayed.
  20
  21 OPTIONS
  22 -------
  23 -i::
  24 --input=<file>::
  25         Input file name. (default: perf.data unless stdin is a fifo)
  26
  27 -d::
  28 --dsos=<dso[,dso...]>::
  29         Only consider symbols in these dsos.
  30 -s::
  31 --symbol=<symbol>::
  32         Symbol to annotate.
  33
  34 -f::
  35 --force::
  36         Don't do ownership validation.
  37
  38 -v::
  39 --verbose::
  40         Be more verbose. (Show symbol address, etc)
  41
  42 -q::
  43 --quiet::
  44         Do not show any message.  (Suppress -v)
  45
  46 -n::
  47 --show-nr-samples::
  48         Show the number of samples for each symbol
  49
  50 -D::
  51 --dump-raw-trace::
  52         Dump raw trace in ASCII.
  53
  54 -k::
  55 --vmlinux=<file>::
  56         vmlinux pathname.
  57
  58 --ignore-vmlinux::
  59         Ignore vmlinux files.
  60
  61 --itrace::
  62         Options for decoding instruction tracing data. The options are:
  63
  64 include::itrace.txt[]
  65
  66         To disable decoding entirely, use --no-itrace.
  67
  68 -m::
  69 --modules::
  70         Load module symbols. WARNING: use only with -k and LIVE kernel.
  71
  72 -l::
  73 --print-line::
  74         Print matching source lines (may be slow).
  75
  76 -P::
  77 --full-paths::
  78         Don't shorten the displayed pathnames.
  79
  80 --stdio:: Use the stdio interface.
  81
  82 --stdio2:: Use the stdio2 interface, non-interactive, uses the TUI formatting.
  83
  84 --stdio-color=<mode>::
  85         'always', 'never' or 'auto', allowing configuring color output
  86         via the command line, in addition to via "color.ui" .perfconfig.
  87         Use '--stdio-color always' to generate color even when redirecting
  88         to a pipe or file. Using just '--stdio-color' is equivalent to
  89         using 'always'.
  90
  91 --tui:: Use the TUI interface. Use of --tui requires a tty, if one is not
  92         present, as when piping to other commands, the stdio interface is
  93         used. This interfaces starts by centering on the line with more
  94         samples, TAB/UNTAB cycles through the lines with more samples.
  95
  96 --gtk:: Use the GTK interface.
  97
  98 -C::
  99 --cpu=<cpu>:: Only report samples for the list of CPUs provided. Multiple CPUs can
 100         be provided as a comma-separated list with no space: 0,1. Ranges of
 101         CPUs are specified with -: 0-2. Default is to report samples on all
 102         CPUs.
 103
 104 --asm-raw::
 105         Show raw instruction encoding of assembly instructions.
 106
 107 --show-total-period:: Show a column with the sum of periods.
 108
 109 --source::
 110         Interleave source code with assembly code. Enabled by default,
 111         disable with --no-source.
 112
 113 --symfs=<directory>::
 114         Look for files with symbols relative to this directory.
 115
 116 -M::
 117 --disassembler-style=:: Set disassembler style for objdump.
 118
 119 --objdump=<path>::
 120         Path to objdump binary.
 121
 122 --prefix=PREFIX::
 123 --prefix-strip=N::
 124         Remove first N entries from source file path names in executables
 125         and add PREFIX. This allows to display source code compiled on systems
 126         with different file system layout.
 127
 128 --skip-missing::
 129         Skip symbols that cannot be annotated.
 130
 131 --group::
 132         Show event group information together
 133
 134 --demangle::
 135         Demangle symbol names to human readable form. It's enabled by default,
 136         disable with --no-demangle.
 137
 138 --demangle-kernel::
 139         Demangle kernel symbol names to human readable form (for C++ kernels).
 140
 141 --percent-type::
 142         Set annotation percent type from following choices:
 143           global-period, local-period, global-hits, local-hits
 144
 145         The local/global keywords set if the percentage is computed
 146         in the scope of the function (local) or the whole data (global).
 147         The period/hits keywords set the base the percentage is computed
 148         on - the samples period or the number of samples (hits).
 149
 150 SEE ALSO
 151 --------
 152 linkperf:perf-record[1], linkperf:perf-report[1]