Ingo Molnar | 0bec253 | 2009-05-26 09:17:18 +0200 | [diff] [blame] | 1 | perf-report(1) |
Ingo Molnar | c1c2365 | 2009-05-30 12:38:51 +0200 | [diff] [blame] | 2 | ============== |
Ingo Molnar | 0bec253 | 2009-05-26 09:17:18 +0200 | [diff] [blame] | 3 | |
| 4 | NAME |
| 5 | ---- |
Ingo Molnar | 23ac9cb | 2009-05-27 09:33:18 +0200 | [diff] [blame] | 6 | perf-report - Read perf.data (created by perf record) and display the profile |
Ingo Molnar | 0bec253 | 2009-05-26 09:17:18 +0200 | [diff] [blame] | 7 | |
| 8 | SYNOPSIS |
| 9 | -------- |
| 10 | [verse] |
| 11 | 'perf report' [-i <file> | --input=file] |
| 12 | |
| 13 | DESCRIPTION |
| 14 | ----------- |
| 15 | This command displays the performance counter profile information recorded |
Ingo Molnar | b0a2858 | 2009-06-23 16:39:53 +0200 | [diff] [blame] | 16 | via perf record. |
Ingo Molnar | 0bec253 | 2009-05-26 09:17:18 +0200 | [diff] [blame] | 17 | |
| 18 | OPTIONS |
| 19 | ------- |
| 20 | -i:: |
| 21 | --input=:: |
Robert Richter | efad141 | 2011-12-07 10:02:54 +0100 | [diff] [blame] | 22 | Input file name. (default: perf.data unless stdin is a fifo) |
Shawn Bohrer | e04fffc | 2010-11-30 19:57:17 -0600 | [diff] [blame] | 23 | |
| 24 | -v:: |
| 25 | --verbose:: |
| 26 | Be more verbose. (show symbol address, etc) |
| 27 | |
Arnaldo Carvalho de Melo | 2590340 | 2009-06-30 19:01:20 -0300 | [diff] [blame] | 28 | -d:: |
| 29 | --dsos=:: |
| 30 | Only consider symbols in these dsos. CSV that understands |
| 31 | file://filename entries. |
Zeev Tarantov | ca2b900 | 2009-11-09 13:26:13 +0200 | [diff] [blame] | 32 | -n:: |
| 33 | --show-nr-samples:: |
Arnaldo Carvalho de Melo | e3d7e18 | 2009-07-11 12:18:37 -0300 | [diff] [blame] | 34 | Show the number of samples for each symbol |
Shawn Bohrer | e04fffc | 2010-11-30 19:57:17 -0600 | [diff] [blame] | 35 | |
| 36 | --showcpuutilization:: |
| 37 | Show sample percentage for different cpu modes. |
| 38 | |
Zeev Tarantov | ca2b900 | 2009-11-09 13:26:13 +0200 | [diff] [blame] | 39 | -T:: |
| 40 | --threads:: |
Brice Goglin | 8d51327 | 2009-08-07 13:55:24 +0200 | [diff] [blame] | 41 | Show per-thread event counters |
David Ahern | c8e6672 | 2011-11-13 11:30:08 -0700 | [diff] [blame] | 42 | -c:: |
Arnaldo Carvalho de Melo | cc8b88b | 2009-06-30 19:01:21 -0300 | [diff] [blame] | 43 | --comms=:: |
| 44 | Only consider symbols in these comms. CSV that understands |
| 45 | file://filename entries. |
Arnaldo Carvalho de Melo | 7bec7a9 | 2009-06-30 19:01:22 -0300 | [diff] [blame] | 46 | -S:: |
| 47 | --symbols=:: |
| 48 | Only consider these symbols. CSV that understands |
| 49 | file://filename entries. |
Ingo Molnar | 0bec253 | 2009-05-26 09:17:18 +0200 | [diff] [blame] | 50 | |
Namhyung Kim | fde0eea | 2012-03-19 11:53:48 +0900 | [diff] [blame] | 51 | --symbol-filter=:: |
| 52 | Only show symbols that match (partially) with this filter. |
| 53 | |
Shawn Bohrer | e04fffc | 2010-11-30 19:57:17 -0600 | [diff] [blame] | 54 | -U:: |
| 55 | --hide-unresolved:: |
| 56 | Only display entries resolved to a symbol. |
| 57 | |
Arnaldo Carvalho de Melo | c351c28 | 2009-12-16 13:49:27 -0200 | [diff] [blame] | 58 | -s:: |
| 59 | --sort=:: |
Namhyung Kim | 9811360 | 2012-12-27 18:11:47 +0900 | [diff] [blame] | 60 | Sort histogram entries by given key(s) - multiple keys can be specified |
| 61 | in CSV format. Following sort keys are available: |
Andi Kleen | 0548429 | 2013-01-24 16:10:29 +0100 | [diff] [blame^] | 62 | pid, comm, dso, symbol, parent, cpu, srcline, weight, local_weight. |
Namhyung Kim | 9811360 | 2012-12-27 18:11:47 +0900 | [diff] [blame] | 63 | |
| 64 | Each key has following meaning: |
| 65 | |
| 66 | - comm: command (name) of the task which can be read via /proc/<pid>/comm |
| 67 | - pid: command and tid of the task |
| 68 | - dso: name of library or module executed at the time of sample |
| 69 | - symbol: name of function executed at the time of sample |
| 70 | - parent: name of function matched to the parent regex filter. Unmatched |
| 71 | entries are displayed as "[other]". |
| 72 | - cpu: cpu number the task ran at the time of sample |
| 73 | - srcline: filename and line number executed at the time of sample. The |
| 74 | DWARF debuggin info must be provided. |
| 75 | |
| 76 | By default, comm, dso and symbol keys are used. |
| 77 | (i.e. --sort comm,dso,symbol) |
| 78 | |
| 79 | If --branch-stack option is used, following sort keys are also |
| 80 | available: |
| 81 | dso_from, dso_to, symbol_from, symbol_to, mispredict. |
| 82 | |
| 83 | - dso_from: name of library or module branched from |
| 84 | - dso_to: name of library or module branched to |
| 85 | - symbol_from: name of function branched from |
| 86 | - symbol_to: name of function branched to |
| 87 | - mispredict: "N" for predicted branch, "Y" for mispredicted branch |
| 88 | |
| 89 | And default sort keys are changed to comm, dso_from, symbol_from, dso_to |
| 90 | and symbol_to, see '--branch-stack'. |
Arnaldo Carvalho de Melo | c351c28 | 2009-12-16 13:49:27 -0200 | [diff] [blame] | 91 | |
Shawn Bohrer | e04fffc | 2010-11-30 19:57:17 -0600 | [diff] [blame] | 92 | -p:: |
| 93 | --parent=<regex>:: |
Namhyung Kim | 9811360 | 2012-12-27 18:11:47 +0900 | [diff] [blame] | 94 | A regex filter to identify parent. The parent is a caller of this |
| 95 | function and searched through the callchain, thus it requires callchain |
| 96 | information recorded. The pattern is in the exteneded regex format and |
| 97 | defaults to "\^sys_|^do_page_fault", see '--sort parent'. |
Shawn Bohrer | e04fffc | 2010-11-30 19:57:17 -0600 | [diff] [blame] | 98 | |
| 99 | -x:: |
| 100 | --exclude-other:: |
| 101 | Only display entries with parent-match. |
| 102 | |
Arnaldo Carvalho de Melo | 52d422d | 2009-07-10 22:47:28 -0300 | [diff] [blame] | 103 | -w:: |
Shawn Bohrer | e04fffc | 2010-11-30 19:57:17 -0600 | [diff] [blame] | 104 | --column-widths=<width[,width...]>:: |
Arnaldo Carvalho de Melo | 52d422d | 2009-07-10 22:47:28 -0300 | [diff] [blame] | 105 | Force each column width to the provided list, for large terminal |
| 106 | readability. |
| 107 | |
| 108 | -t:: |
| 109 | --field-separator=:: |
Arnaldo Carvalho de Melo | 52d422d | 2009-07-10 22:47:28 -0300 | [diff] [blame] | 110 | Use a special separator character and don't pad with spaces, replacing |
Shawn Bohrer | e04fffc | 2010-11-30 19:57:17 -0600 | [diff] [blame] | 111 | all occurrences of this separator in symbol names (and other output) |
Arnaldo Carvalho de Melo | 52d422d | 2009-07-10 22:47:28 -0300 | [diff] [blame] | 112 | with a '.' character, that thus it's the only non valid separator. |
| 113 | |
Shawn Bohrer | e04fffc | 2010-11-30 19:57:17 -0600 | [diff] [blame] | 114 | -D:: |
| 115 | --dump-raw-trace:: |
| 116 | Dump raw trace in ASCII. |
| 117 | |
Namhyung Kim | 6581f6e | 2011-12-13 00:16:50 +0900 | [diff] [blame] | 118 | -g [type,min[,limit],order]:: |
Frederic Weisbecker | ec7ba4e | 2009-08-31 03:32:03 +0200 | [diff] [blame] | 119 | --call-graph:: |
Namhyung Kim | 6581f6e | 2011-12-13 00:16:50 +0900 | [diff] [blame] | 120 | Display call chains using type, min percent threshold, optional print |
| 121 | limit and order. |
Frederic Weisbecker | ec7ba4e | 2009-08-31 03:32:03 +0200 | [diff] [blame] | 122 | type can be either: |
Shawn Bohrer | e04fffc | 2010-11-30 19:57:17 -0600 | [diff] [blame] | 123 | - flat: single column, linear exposure of call chains. |
Frederic Weisbecker | ec7ba4e | 2009-08-31 03:32:03 +0200 | [diff] [blame] | 124 | - graph: use a graph tree, displaying absolute overhead rates. |
| 125 | - fractal: like graph, but displays relative rates. Each branch of |
| 126 | the tree is considered as a new profiled object. + |
Sam Liao | d797fdc | 2011-06-07 23:49:46 +0800 | [diff] [blame] | 127 | |
| 128 | order can be either: |
| 129 | - callee: callee based call graph. |
| 130 | - caller: inverted caller based call graph. |
| 131 | |
| 132 | Default: fractal,0.5,callee. |
| 133 | |
| 134 | -G:: |
| 135 | --inverted:: |
| 136 | alias for inverted caller based call graph. |
Frederic Weisbecker | ec7ba4e | 2009-08-31 03:32:03 +0200 | [diff] [blame] | 137 | |
Shawn Bohrer | e04fffc | 2010-11-30 19:57:17 -0600 | [diff] [blame] | 138 | --pretty=<key>:: |
| 139 | Pretty printing style. key: normal, raw |
| 140 | |
Arnaldo Carvalho de Melo | 8b9e74e | 2010-08-21 10:38:16 -0300 | [diff] [blame] | 141 | --stdio:: Use the stdio interface. |
| 142 | |
| 143 | --tui:: Use the TUI interface, that is integrated with annotate and allows |
| 144 | zooming into DSOs or threads, among other features. Use of --tui |
| 145 | requires a tty, if one is not present, as when piping to other |
| 146 | commands, the stdio interface is used. |
| 147 | |
Pekka Enberg | c31a945 | 2012-03-19 15:13:29 -0300 | [diff] [blame] | 148 | --gtk:: Use the GTK2 interface. |
| 149 | |
Shawn Bohrer | e04fffc | 2010-11-30 19:57:17 -0600 | [diff] [blame] | 150 | -k:: |
| 151 | --vmlinux=<file>:: |
| 152 | vmlinux pathname |
| 153 | |
David Ahern | b226a5a7 | 2010-12-07 19:39:46 -0700 | [diff] [blame] | 154 | --kallsyms=<file>:: |
| 155 | kallsyms pathname |
| 156 | |
Shawn Bohrer | e04fffc | 2010-11-30 19:57:17 -0600 | [diff] [blame] | 157 | -m:: |
| 158 | --modules:: |
| 159 | Load module symbols. WARNING: This should only be used with -k and |
| 160 | a LIVE kernel. |
| 161 | |
| 162 | -f:: |
| 163 | --force:: |
| 164 | Don't complain, do it. |
| 165 | |
David Ahern | ec5761e | 2010-12-09 13:27:07 -0700 | [diff] [blame] | 166 | --symfs=<directory>:: |
| 167 | Look for files with symbols relative to this directory. |
| 168 | |
David Ahern | c8e6672 | 2011-11-13 11:30:08 -0700 | [diff] [blame] | 169 | -C:: |
Anton Blanchard | 5d67be9 | 2011-07-04 21:57:50 +1000 | [diff] [blame] | 170 | --cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can |
| 171 | be provided as a comma-separated list with no space: 0,1. Ranges of |
| 172 | CPUs are specified with -: 0-2. Default is to report samples on all |
| 173 | CPUs. |
| 174 | |
Andi Kleen | f69b64f | 2011-09-15 14:31:41 -0700 | [diff] [blame] | 175 | -M:: |
| 176 | --disassembler-style=:: Set disassembler style for objdump. |
| 177 | |
Arnaldo Carvalho de Melo | 64c6f0c | 2011-10-06 12:48:31 -0300 | [diff] [blame] | 178 | --source:: |
| 179 | Interleave source code with assembly code. Enabled by default, |
| 180 | disable with --no-source. |
| 181 | |
| 182 | --asm-raw:: |
| 183 | Show raw instruction encoding of assembly instructions. |
| 184 | |
Arnaldo Carvalho de Melo | 3f2728b | 2011-10-05 16:10:06 -0300 | [diff] [blame] | 185 | --show-total-period:: Show a column with the sum of periods. |
| 186 | |
Stephane Eranian | fbe96f2 | 2011-09-30 15:40:40 +0200 | [diff] [blame] | 187 | -I:: |
| 188 | --show-info:: |
| 189 | Display extended information about the perf.data file. This adds |
| 190 | information which may be very large and thus may clutter the display. |
| 191 | It currently includes: cpu and numa topology of the host system. |
| 192 | |
Roberto Agostino Vitillo | b50311d | 2012-02-09 23:21:03 +0100 | [diff] [blame] | 193 | -b:: |
| 194 | --branch-stack:: |
| 195 | Use the addresses of sampled taken branches instead of the instruction |
| 196 | address to build the histograms. To generate meaningful output, the |
Stephane Eranian | 993ac88 | 2012-03-08 23:47:47 +0100 | [diff] [blame] | 197 | perf.data file must have been obtained using perf record -b or |
| 198 | perf record --branch-filter xxx where xxx is a branch filter option. |
| 199 | perf report is able to auto-detect whether a perf.data file contains |
| 200 | branch stacks and it will automatically switch to the branch view mode, |
| 201 | unless --no-branch-stack is used. |
Roberto Agostino Vitillo | b50311d | 2012-02-09 23:21:03 +0100 | [diff] [blame] | 202 | |
Maciek Borzecki | 7a4ec93 | 2012-09-04 12:32:30 +0200 | [diff] [blame] | 203 | --objdump=<path>:: |
| 204 | Path to objdump binary. |
| 205 | |
Namhyung Kim | 01d14f1 | 2013-01-22 18:09:45 +0900 | [diff] [blame] | 206 | --group:: |
| 207 | Show event group information together. |
| 208 | |
Namhyung Kim | 328ccda | 2013-03-25 18:18:18 +0900 | [diff] [blame] | 209 | --demangle:: |
| 210 | Demangle symbol names to human readable form. It's enabled by default, |
| 211 | disable with --no-demangle. |
| 212 | |
Ingo Molnar | 0bec253 | 2009-05-26 09:17:18 +0200 | [diff] [blame] | 213 | SEE ALSO |
| 214 | -------- |
Arnaldo Carvalho de Melo | 64c6f0c | 2011-10-06 12:48:31 -0300 | [diff] [blame] | 215 | linkperf:perf-stat[1], linkperf:perf-annotate[1] |