175 lines · plain
1perf-annotate(1)2================3 4NAME5----6perf-annotate - Read perf.data (created by perf record) and display annotated code7 8SYNOPSIS9--------10[verse]11'perf annotate' [-i <file> | --input=file] [symbol_name]12 13DESCRIPTION14-----------15This command reads the input file and displays an annotated version of the16code. If the object file has debug symbols then the source code will be17displayed alongside assembly code.18 19If there is no debug info in the object, then annotated assembly is displayed.20 21OPTIONS22-------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 warnings or messages. (Suppress -v)45 46-n::47--show-nr-samples::48 Show the number of samples for each symbol49 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 64include::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 output86 via the command line, in addition to via "color.ui" .perfconfig.87 Use '--stdio-color always' to generate color even when redirecting88 to a pipe or file. Using just '--stdio-color' is equivalent to89 using 'always'.90 91--tui:: Use the TUI interface. Use of --tui requires a tty, if one is not92 present, as when piping to other commands, the stdio interface is93 used. This interfaces starts by centering on the line with more94 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 can100 be provided as a comma-separated list with no space: 0,1. Ranges of101 CPUs are specified with -: 0-2. Default is to report samples on all102 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--addr2line=<path>::120 Path to addr2line binary.121 122--objdump=<path>::123 Path to objdump binary.124 125--prefix=PREFIX::126--prefix-strip=N::127 Remove first N entries from source file path names in executables128 and add PREFIX. This allows to display source code compiled on systems129 with different file system layout.130 131--skip-missing::132 Skip symbols that cannot be annotated.133 134--group::135 Show event group information together136 137--demangle::138 Demangle symbol names to human readable form. It's enabled by default,139 disable with --no-demangle.140 141--demangle-kernel::142 Demangle kernel symbol names to human readable form (for C++ kernels).143 144--percent-type::145 Set annotation percent type from following choices:146 global-period, local-period, global-hits, local-hits147 148 The local/global keywords set if the percentage is computed149 in the scope of the function (local) or the whole data (global).150 The period/hits keywords set the base the percentage is computed151 on - the samples period or the number of samples (hits).152 153--percent-limit::154 Do not show functions which have an overhead under that percent on155 stdio or stdio2 (Default: 0). Note that this is about selection of156 functions to display, not about lines within the function.157 158--data-type[=TYPE_NAME]::159 Display data type annotation instead of code. It infers data type of160 samples (if they are memory accessing instructions) using DWARF debug161 information. It can take an optional argument of data type name. In162 that case it'd show annotation for the type only, otherwise it'd show163 all data types it finds.164 165--type-stat::166 Show stats for the data type annotation.167 168--skip-empty::169 Do not display empty (or dummy) events.170 171 172SEE ALSO173--------174linkperf:perf-record[1], linkperf:perf-report[1]175