186470930SIngo Molnarperf-annotate(1)
24778e0e8SArnaldo Carvalho de Melo================
386470930SIngo Molnar
486470930SIngo MolnarNAME
586470930SIngo Molnar----
686470930SIngo Molnarperf-annotate - Read perf.data (created by perf record) and display annotated code
786470930SIngo Molnar
886470930SIngo MolnarSYNOPSIS
986470930SIngo Molnar--------
1086470930SIngo Molnar[verse]
118b9e74ebSArnaldo Carvalho de Melo'perf annotate' [-i <file> | --input=file] [symbol_name]
1286470930SIngo Molnar
1386470930SIngo MolnarDESCRIPTION
1486470930SIngo Molnar-----------
1586470930SIngo MolnarThis command reads the input file and displays an annotated version of the
1686470930SIngo Molnarcode. If the object file has debug symbols then the source code will be
1786470930SIngo Molnardisplayed alongside assembly code.
1886470930SIngo Molnar
1986470930SIngo MolnarIf there is no debug info in the object, then annotated assembly is displayed.
2086470930SIngo Molnar
2186470930SIngo MolnarOPTIONS
2286470930SIngo Molnar-------
2386470930SIngo Molnar-i::
2486470930SIngo Molnar--input=::
2586470930SIngo Molnar        Input file name. (default: perf.data)
2686470930SIngo Molnar
271968ad91SShawn Bohrer-d::
281968ad91SShawn Bohrer--dsos=<dso[,dso...]>::
291968ad91SShawn Bohrer        Only consider symbols in these dsos.
301968ad91SShawn Bohrer-s::
311968ad91SShawn Bohrer--symbol=<symbol>::
321968ad91SShawn Bohrer        Symbol to annotate.
331968ad91SShawn Bohrer
341968ad91SShawn Bohrer-f::
351968ad91SShawn Bohrer--force::
361968ad91SShawn Bohrer        Don't complain, do it.
371968ad91SShawn Bohrer
381968ad91SShawn Bohrer-v::
391968ad91SShawn Bohrer--verbose::
401968ad91SShawn Bohrer        Be more verbose. (Show symbol address, etc)
411968ad91SShawn Bohrer
421968ad91SShawn Bohrer-D::
431968ad91SShawn Bohrer--dump-raw-trace::
441968ad91SShawn Bohrer        Dump raw trace in ASCII.
451968ad91SShawn Bohrer
461968ad91SShawn Bohrer-k::
471968ad91SShawn Bohrer--vmlinux=<file>::
481968ad91SShawn Bohrer        vmlinux pathname.
491968ad91SShawn Bohrer
501968ad91SShawn Bohrer-m::
511968ad91SShawn Bohrer--modules::
521968ad91SShawn Bohrer        Load module symbols. WARNING: use only with -k and LIVE kernel.
531968ad91SShawn Bohrer
541968ad91SShawn Bohrer-l::
551968ad91SShawn Bohrer--print-line::
561968ad91SShawn Bohrer        Print matching source lines (may be slow).
571968ad91SShawn Bohrer
581968ad91SShawn Bohrer-P::
591968ad91SShawn Bohrer--full-paths::
601968ad91SShawn Bohrer        Don't shorten the displayed pathnames.
611968ad91SShawn Bohrer
628b9e74ebSArnaldo Carvalho de Melo--stdio:: Use the stdio interface.
638b9e74ebSArnaldo Carvalho de Melo
648b9e74ebSArnaldo Carvalho de Melo--tui:: Use the TUI interface Use of --tui requires a tty, if one is not
658b9e74ebSArnaldo Carvalho de Melo	present, as when piping to other commands, the stdio interface is
668b9e74ebSArnaldo Carvalho de Melo	used. This interfaces starts by centering on the line with more
671968ad91SShawn Bohrer	samples, TAB/UNTAB cycles through the lines with more samples.
688b9e74ebSArnaldo Carvalho de Melo
69c8e66720SDavid Ahern-C::
705d67be97SAnton Blanchard--cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can
715d67be97SAnton Blanchard	be provided as a comma-separated list with no space: 0,1. Ranges of
725d67be97SAnton Blanchard	CPUs are specified with -: 0-2. Default is to report samples on all
735d67be97SAnton Blanchard	CPUs.
745d67be97SAnton Blanchard
753e6a2a7fSStephane Eranian--asm-raw::
7664c6f0c7SArnaldo Carvalho de Melo	Show raw instruction encoding of assembly instructions.
773e6a2a7fSStephane Eranian
783e6a2a7fSStephane Eranian--source::
793e6a2a7fSStephane Eranian	Interleave source code with assembly code. Enabled by default,
803e6a2a7fSStephane Eranian	disable with --no-source.
813e6a2a7fSStephane Eranian
82e71a0598SStephane Eranian--symfs=<directory>::
83e71a0598SStephane Eranian        Look for files with symbols relative to this directory.
84e71a0598SStephane Eranian
85f69b64f7SAndi Kleen-M::
86f69b64f7SAndi Kleen--disassembler-style=:: Set disassembler style for objdump.
87f69b64f7SAndi Kleen
8886470930SIngo MolnarSEE ALSO
8986470930SIngo Molnar--------
908b9e74ebSArnaldo Carvalho de Melolinkperf:perf-record[1], linkperf:perf-report[1]
91