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=::
  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 -D::
  43 --dump-raw-trace::
  44         Dump raw trace in ASCII.
  45
  46 -k::
  47 --vmlinux=<file>::
  48         vmlinux pathname.
  49
  50 -m::
  51 --modules::
  52         Load module symbols. WARNING: use only with -k and LIVE kernel.
  53
  54 -l::
  55 --print-line::
  56         Print matching source lines (may be slow).
  57
  58 -P::
  59 --full-paths::
  60         Don't shorten the displayed pathnames.
  61
  62 --stdio:: Use the stdio interface.
  63
  64 --stdio-color::
  65         'always', 'never' or 'auto', allowing configuring color output
  66         via the command line, in addition to via "color.ui" .perfconfig.
  67         Use '--stdio-color always' to generate color even when redirecting
  68         to a pipe or file. Using just '--stdio-color' is equivalent to
  69         using 'always'.
  70
  71 --tui:: Use the TUI interface. Use of --tui requires a tty, if one is not
  72         present, as when piping to other commands, the stdio interface is
  73         used. This interfaces starts by centering on the line with more
  74         samples, TAB/UNTAB cycles through the lines with more samples.
  75
  76 --gtk:: Use the GTK interface.
  77
  78 -C::
  79 --cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can
  80         be provided as a comma-separated list with no space: 0,1. Ranges of
  81         CPUs are specified with -: 0-2. Default is to report samples on all
  82         CPUs.
  83
  84 --asm-raw::
  85         Show raw instruction encoding of assembly instructions.
  86
  87 --source::
  88         Interleave source code with assembly code. Enabled by default,
  89         disable with --no-source.
  90
  91 --symfs=<directory>::
  92         Look for files with symbols relative to this directory.
  93
  94 -M::
  95 --disassembler-style=:: Set disassembler style for objdump.
  96
  97 --objdump=<path>::
  98         Path to objdump binary.
  99
 100 --skip-missing::
 101         Skip symbols that cannot be annotated.
 102
 103 --group::
 104         Show event group information together
 105
 106 SEE ALSO
 107 --------
 108 linkperf:perf-record[1], linkperf:perf-report[1]