perf-annotate(1) — Linux manual page

PERF-ANNOTATE(1)               perf Manual              PERF-ANNOTATE(1)

NAME         top

       perf-annotate - Read perf.data (created by perf record) and
       display annotated code

SYNOPSIS         top

       perf annotate [-i <file> | --input=file] [symbol_name]

DESCRIPTION         top

       This command reads the input file and displays an annotated
       version of the code. If the object file has debug symbols then
       the source code will be displayed alongside assembly code.

       If there is no debug info in the object, then annotated assembly
       is displayed.

OPTIONS         top

       -i, --input=<file>
           Input file name. (default: perf.data unless stdin is a fifo)

       -d, --dsos=<dso[,dso...]>
           Only consider symbols in these dsos.

       -s, --symbol=<symbol>
           Symbol to annotate.

       -f, --force
           Don’t do ownership validation.

       -v, --verbose
           Be more verbose. (Show symbol address, etc)

       -q, --quiet
           Do not show any message. (Suppress -v)

       -n, --show-nr-samples
           Show the number of samples for each symbol

       -D, --dump-raw-trace
           Dump raw trace in ASCII.

       -k, --vmlinux=<file>
           vmlinux pathname.

       --ignore-vmlinux
           Ignore vmlinux files.

       -m, --modules
           Load module symbols. WARNING: use only with -k and LIVE
           kernel.

       -l, --print-line
           Print matching source lines (may be slow).

       -P, --full-paths
           Don’t shorten the displayed pathnames.

       --stdio
           Use the stdio interface.

       --stdio2
           Use the stdio2 interface, non-interactive, uses the TUI
           formatting.

       --stdio-color=<mode>
           always, never or auto, allowing configuring color output via
           the command line, in addition to via "color.ui" .perfconfig.
           Use --stdio-color always to generate color even when
           redirecting to a pipe or file. Using just --stdio-color is
           equivalent to using always.

       --tui
           Use the TUI interface. Use of --tui requires a tty, if one is
           not present, as when piping to other commands, the stdio
           interface is used. This interfaces starts by centering on the
           line with more samples, TAB/UNTAB cycles through the lines
           with more samples.

       --gtk
           Use the GTK interface.

       -C, --cpu=<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.

       --asm-raw
           Show raw instruction encoding of assembly instructions.

       --show-total-period
           Show a column with the sum of periods.

       --source
           Interleave source code with assembly code. Enabled by
           default, disable with --no-source.

       --symfs=<directory>
           Look for files with symbols relative to this directory.

       -M, --disassembler-style=
           Set disassembler style for objdump.

       --objdump=<path>
           Path to objdump binary.

       --prefix=PREFIX, --prefix-strip=N
           Remove first N entries from source file path names in
           executables and add PREFIX. This allows to display source
           code compiled on systems with different file system layout.

       --skip-missing
           Skip symbols that cannot be annotated.

       --group
           Show event group information together

       --percent-type
           Set annotation percent type from following choices:
           global-period, local-period, global-hits, local-hits

               The local/global keywords set if the percentage is computed
               in the scope of the function (local) or the whole data (global).
               The period/hits keywords set the base the percentage is computed
               on - the samples period or the number of samples (hits).

SEE ALSO         top

       perf-record(1), perf-report(1)

COLOPHON         top

       This page is part of the perf (Performance analysis tools for
       Linux (in Linux source tree)) project.  Information about the
       project can be found at 
       ⟨https://perf.wiki.kernel.org/index.php/Main_Page⟩.  If you have a
       bug report for this manual page, send it to
       linux-kernel@vger.kernel.org.  This page was obtained from the
       project's upstream Git repository
       ⟨http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git⟩
       on 2020-12-18.  (At that time, the date of the most recent commit
       that was found in the repository was 2020-12-17.)  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for
       the page, or you have corrections or improvements to the
       information in this COLOPHON (which is not part of the original
       manual page), send a mail to man-pages@man7.org

perf                           2020-01-14               PERF-ANNOTATE(1)

Pages that refer to this page: perf-report(1)

HTML rendering created 2020-12-21 by Michael Kerrisk, author of The Linux Programming Interface, maintainer of the Linux man-pages project. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.