1 perf-report(1) 2 ============== 3 4 NAME 5 ---- 6 perf-report - Read perf.data (created by perf record) and display the profile 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 16 via perf record. 17 18 OPTIONS 19 ------- 20 -i:: 21 --input=:: 22 Input file name. (default: perf.data unless stdin is a fifo) 23 24 -v:: 25 --verbose:: 26 Be more verbose. (show symbol address, etc) 27 28 -d:: 29 --dsos=:: 30 Only consider symbols in these dsos. CSV that understands 31 file://filename entries. 32 -n:: 33 --show-nr-samples:: 34 Show the number of samples for each symbol 35 36 --showcpuutilization:: 37 Show sample percentage for different cpu modes. 38 39 -T:: 40 --threads:: 41 Show per-thread event counters 42 -c:: 43 --comms=:: 44 Only consider symbols in these comms. CSV that understands 45 file://filename entries. 46 -S:: 47 --symbols=:: 48 Only consider these symbols. CSV that understands 49 file://filename entries. 50 51 --symbol-filter=:: 52 Only show symbols that match (partially) with this filter. 53 54 -U:: 55 --hide-unresolved:: 56 Only display entries resolved to a symbol. 57 58 -s:: 59 --sort=:: 60 Sort histogram entries by given key(s) - multiple keys can be specified 61 in CSV format. Following sort keys are available: 62 pid, comm, dso, symbol, parent, cpu, srcline, weight, local_weight. 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'. 91 92 -p:: 93 --parent=<regex>:: 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'. 98 99 -x:: 100 --exclude-other:: 101 Only display entries with parent-match. 102 103 -w:: 104 --column-widths=<width[,width...]>:: 105 Force each column width to the provided list, for large terminal 106 readability. 107 108 -t:: 109 --field-separator=:: 110 Use a special separator character and don't pad with spaces, replacing 111 all occurrences of this separator in symbol names (and other output) 112 with a '.' character, that thus it's the only non valid separator. 113 114 -D:: 115 --dump-raw-trace:: 116 Dump raw trace in ASCII. 117 118 -g [type,min[,limit],order[,key]]:: 119 --call-graph:: 120 Display call chains using type, min percent threshold, optional print 121 limit and order. 122 type can be either: 123 - flat: single column, linear exposure of call chains. 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. + 127 128 order can be either: 129 - callee: callee based call graph. 130 - caller: inverted caller based call graph. 131 132 key can be: 133 - function: compare on functions 134 - address: compare on individual code addresses 135 136 Default: fractal,0.5,callee,function. 137 138 -G:: 139 --inverted:: 140 alias for inverted caller based call graph. 141 142 --ignore-callees=<regex>:: 143 Ignore callees of the function(s) matching the given regex. 144 This has the effect of collecting the callers of each such 145 function into one place in the call-graph tree. 146 147 --pretty=<key>:: 148 Pretty printing style. key: normal, raw 149 150 --stdio:: Use the stdio interface. 151 152 --tui:: Use the TUI interface, that is integrated with annotate and allows 153 zooming into DSOs or threads, among other features. Use of --tui 154 requires a tty, if one is not present, as when piping to other 155 commands, the stdio interface is used. 156 157 --gtk:: Use the GTK2 interface. 158 159 -k:: 160 --vmlinux=<file>:: 161 vmlinux pathname 162 163 --kallsyms=<file>:: 164 kallsyms pathname 165 166 -m:: 167 --modules:: 168 Load module symbols. WARNING: This should only be used with -k and 169 a LIVE kernel. 170 171 -f:: 172 --force:: 173 Don't complain, do it. 174 175 --symfs=<directory>:: 176 Look for files with symbols relative to this directory. 177 178 -C:: 179 --cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can 180 be provided as a comma-separated list with no space: 0,1. Ranges of 181 CPUs are specified with -: 0-2. Default is to report samples on all 182 CPUs. 183 184 -M:: 185 --disassembler-style=:: Set disassembler style for objdump. 186 187 --source:: 188 Interleave source code with assembly code. Enabled by default, 189 disable with --no-source. 190 191 --asm-raw:: 192 Show raw instruction encoding of assembly instructions. 193 194 --show-total-period:: Show a column with the sum of periods. 195 196 -I:: 197 --show-info:: 198 Display extended information about the perf.data file. This adds 199 information which may be very large and thus may clutter the display. 200 It currently includes: cpu and numa topology of the host system. 201 202 -b:: 203 --branch-stack:: 204 Use the addresses of sampled taken branches instead of the instruction 205 address to build the histograms. To generate meaningful output, the 206 perf.data file must have been obtained using perf record -b or 207 perf record --branch-filter xxx where xxx is a branch filter option. 208 perf report is able to auto-detect whether a perf.data file contains 209 branch stacks and it will automatically switch to the branch view mode, 210 unless --no-branch-stack is used. 211 212 --objdump=<path>:: 213 Path to objdump binary. 214 215 --group:: 216 Show event group information together. 217 218 --demangle:: 219 Demangle symbol names to human readable form. It's enabled by default, 220 disable with --no-demangle. 221 222 --percent-limit:: 223 Do not show entries which have an overhead under that percent. 224 (Default: 0). 225 226 SEE ALSO 227 -------- 228 linkperf:perf-stat[1], linkperf:perf-annotate[1] 229
