| Ingo Molnar | 8035e42 | 2009-06-06 15:19:13 +0200 | [diff] [blame] | 1 | perf-annotate(1) |
| Arnaldo Carvalho de Melo | 4778e0e | 2010-05-05 11:23:27 -0300 | [diff] [blame] | 2 | ================ |
| Ingo Molnar | 8035e42 | 2009-06-06 15:19:13 +0200 | [diff] [blame] | 3 | |
| 4 | NAME |
| 5 | ---- |
| Ingo Molnar | 0b73da3 | 2009-06-06 15:48:52 +0200 | [diff] [blame] | 6 | perf-annotate - Read perf.data (created by perf record) and display annotated code |
| Ingo Molnar | 8035e42 | 2009-06-06 15:19:13 +0200 | [diff] [blame] | 7 | |
| 8 | SYNOPSIS |
| 9 | -------- |
| 10 | [verse] |
| Arnaldo Carvalho de Melo | 8b9e74e | 2010-08-21 10:38:16 -0300 | [diff] [blame] | 11 | 'perf annotate' [-i <file> | --input=file] [symbol_name] |
| Ingo Molnar | 8035e42 | 2009-06-06 15:19:13 +0200 | [diff] [blame] | 12 | |
| 13 | DESCRIPTION |
| 14 | ----------- |
| Ingo Molnar | 0b73da3 | 2009-06-06 15:48:52 +0200 | [diff] [blame] | 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. |
| Ingo Molnar | 8035e42 | 2009-06-06 15:19:13 +0200 | [diff] [blame] | 20 | |
| 21 | OPTIONS |
| 22 | ------- |
| 23 | -i:: |
| 24 | --input=:: |
| Robert Richter | efad141 | 2011-12-07 10:02:54 +0100 | [diff] [blame] | 25 | Input file name. (default: perf.data unless stdin is a fifo) |
| Ingo Molnar | 8035e42 | 2009-06-06 15:19:13 +0200 | [diff] [blame] | 26 | |
| Shawn Bohrer | 1968ad9 | 2010-11-30 19:57:09 -0600 | [diff] [blame] | 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:: |
| Jiri Olsa | e0be62c | 2016-03-24 13:52:19 +0100 | [diff] [blame] | 36 | Don't do ownership validation. |
| Shawn Bohrer | 1968ad9 | 2010-11-30 19:57:09 -0600 | [diff] [blame] | 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 | |
| Arnaldo Carvalho de Melo | 8b9e74e | 2010-08-21 10:38:16 -0300 | [diff] [blame] | 62 | --stdio:: Use the stdio interface. |
| 63 | |
| Arnaldo Carvalho de Melo | 53fe4ba | 2016-07-05 11:08:17 -0300 | [diff] [blame^] | 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 | |
| Namhyung Kim | 2b676bf | 2013-02-07 18:02:08 +0900 | [diff] [blame] | 71 | --tui:: Use the TUI interface. Use of --tui requires a tty, if one is not |
| Arnaldo Carvalho de Melo | 8b9e74e | 2010-08-21 10:38:16 -0300 | [diff] [blame] | 72 | present, as when piping to other commands, the stdio interface is |
| 73 | used. This interfaces starts by centering on the line with more |
| Shawn Bohrer | 1968ad9 | 2010-11-30 19:57:09 -0600 | [diff] [blame] | 74 | samples, TAB/UNTAB cycles through the lines with more samples. |
| Arnaldo Carvalho de Melo | 8b9e74e | 2010-08-21 10:38:16 -0300 | [diff] [blame] | 75 | |
| Namhyung Kim | 2b676bf | 2013-02-07 18:02:08 +0900 | [diff] [blame] | 76 | --gtk:: Use the GTK interface. |
| 77 | |
| David Ahern | c8e6672 | 2011-11-13 11:30:08 -0700 | [diff] [blame] | 78 | -C:: |
| Anton Blanchard | 5d67be9 | 2011-07-04 21:57:50 +1000 | [diff] [blame] | 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 | |
| Stephane Eranian | 3e6a2a7 | 2011-05-17 17:32:07 +0200 | [diff] [blame] | 84 | --asm-raw:: |
| Arnaldo Carvalho de Melo | 64c6f0c | 2011-10-06 12:48:31 -0300 | [diff] [blame] | 85 | Show raw instruction encoding of assembly instructions. |
| Stephane Eranian | 3e6a2a7 | 2011-05-17 17:32:07 +0200 | [diff] [blame] | 86 | |
| 87 | --source:: |
| 88 | Interleave source code with assembly code. Enabled by default, |
| 89 | disable with --no-source. |
| 90 | |
| Stephane Eranian | e71a059 | 2011-07-30 01:20:40 +0200 | [diff] [blame] | 91 | --symfs=<directory>:: |
| 92 | Look for files with symbols relative to this directory. |
| 93 | |
| Andi Kleen | f69b64f | 2011-09-15 14:31:41 -0700 | [diff] [blame] | 94 | -M:: |
| 95 | --disassembler-style=:: Set disassembler style for objdump. |
| 96 | |
| Maciek Borzecki | 7a4ec93 | 2012-09-04 12:32:30 +0200 | [diff] [blame] | 97 | --objdump=<path>:: |
| 98 | Path to objdump binary. |
| 99 | |
| Namhyung Kim | 18c9e5c | 2013-02-07 18:02:14 +0900 | [diff] [blame] | 100 | --skip-missing:: |
| 101 | Skip symbols that cannot be annotated. |
| 102 | |
| Namhyung Kim | b1dd443 | 2013-03-05 14:53:25 +0900 | [diff] [blame] | 103 | --group:: |
| 104 | Show event group information together |
| 105 | |
| Ingo Molnar | 8035e42 | 2009-06-06 15:19:13 +0200 | [diff] [blame] | 106 | SEE ALSO |
| 107 | -------- |
| Arnaldo Carvalho de Melo | 8b9e74e | 2010-08-21 10:38:16 -0300 | [diff] [blame] | 108 | linkperf:perf-record[1], linkperf:perf-report[1] |