1 perf-config(1) 1 perf-config(1)
2 ============== 2 ==============
3 3
4 NAME 4 NAME
5 ---- 5 ----
6 perf-config - Get and set variables in a confi 6 perf-config - Get and set variables in a configuration file.
7 7
8 SYNOPSIS 8 SYNOPSIS
9 -------- 9 --------
10 [verse] 10 [verse]
11 'perf config' [<file-option>] [section.name[=v 11 'perf config' [<file-option>] [section.name[=value] ...]
12 or 12 or
13 'perf config' [<file-option>] -l | --list 13 'perf config' [<file-option>] -l | --list
14 14
15 DESCRIPTION 15 DESCRIPTION
16 ----------- 16 -----------
17 You can manage variables in a configuration fi 17 You can manage variables in a configuration file with this command.
18 18
19 OPTIONS 19 OPTIONS
20 ------- 20 -------
21 21
22 -l:: 22 -l::
23 --list:: 23 --list::
24 Show current config variables, name an 24 Show current config variables, name and value, for all sections.
25 25
26 --user:: 26 --user::
27 For writing and reading options: write 27 For writing and reading options: write to user
28 '$HOME/.perfconfig' file or read it. 28 '$HOME/.perfconfig' file or read it.
29 29
30 --system:: 30 --system::
31 For writing and reading options: write 31 For writing and reading options: write to system-wide
32 '$(sysconfdir)/perfconfig' or read it. 32 '$(sysconfdir)/perfconfig' or read it.
33 33
34 CONFIGURATION FILE 34 CONFIGURATION FILE
35 ------------------ 35 ------------------
36 36
37 The perf configuration file contains many vari 37 The perf configuration file contains many variables to change various
38 aspects of each of its tools, including output 38 aspects of each of its tools, including output, disk usage, etc.
39 The '$HOME/.perfconfig' file is used to store 39 The '$HOME/.perfconfig' file is used to store a per-user configuration.
40 The file '$(sysconfdir)/perfconfig' can be use 40 The file '$(sysconfdir)/perfconfig' can be used to
41 store a system-wide default configuration. 41 store a system-wide default configuration.
42 42
43 One an disable reading config files by setting 43 One an disable reading config files by setting the PERF_CONFIG environment
44 variable to /dev/null, or provide an alternate 44 variable to /dev/null, or provide an alternate config file by setting that
45 variable. 45 variable.
46 46
47 When reading or writing, the values are read f 47 When reading or writing, the values are read from the system and user
48 configuration files by default, and options '- 48 configuration files by default, and options '--system' and '--user'
49 can be used to tell the command to read from o 49 can be used to tell the command to read from or write to only that location.
50 50
51 Syntax 51 Syntax
52 ~~~~~~ 52 ~~~~~~
53 53
54 The file consist of sections. A section starts 54 The file consist of sections. A section starts with its name
55 surrounded by square brackets and continues ti 55 surrounded by square brackets and continues till the next section
56 begins. Each variable must be in a section, an 56 begins. Each variable must be in a section, and have the form
57 'name = value', for example: 57 'name = value', for example:
58 58
59 [section] 59 [section]
60 name1 = value1 60 name1 = value1
61 name2 = value2 61 name2 = value2
62 62
63 Section names are case sensitive and can conta 63 Section names are case sensitive and can contain any characters except
64 newline (double quote `"` and backslash have t 64 newline (double quote `"` and backslash have to be escaped as `\"` and `\\`,
65 respectively). Section headers can't span mult 65 respectively). Section headers can't span multiple lines.
66 66
67 Example 67 Example
68 ~~~~~~~ 68 ~~~~~~~
69 69
70 Given a $HOME/.perfconfig like this: 70 Given a $HOME/.perfconfig like this:
71 71
72 # 72 #
73 # This is the config file, and 73 # This is the config file, and
74 # a '#' and ';' character indicates a comment 74 # a '#' and ';' character indicates a comment
75 # 75 #
76 76
77 [colors] 77 [colors]
78 # Color variables 78 # Color variables
79 top = red, default 79 top = red, default
80 medium = green, default 80 medium = green, default
81 normal = lightgray, default 81 normal = lightgray, default
82 selected = white, lightgray 82 selected = white, lightgray
83 jump_arrows = blue, default 83 jump_arrows = blue, default
84 addr = magenta, default 84 addr = magenta, default
85 root = white, blue 85 root = white, blue
86 86
87 [tui] 87 [tui]
88 # Defaults if linked with libs 88 # Defaults if linked with libslang
89 report = on 89 report = on
90 annotate = on 90 annotate = on
91 top = on 91 top = on
92 92
93 [buildid] 93 [buildid]
94 # Default, disable using /dev/ 94 # Default, disable using /dev/null
95 dir = ~/.debug 95 dir = ~/.debug
96 96
97 [annotate] 97 [annotate]
98 # Defaults 98 # Defaults
99 hide_src_code = false 99 hide_src_code = false
100 use_offset = true 100 use_offset = true
101 jump_arrows = true 101 jump_arrows = true
102 show_nr_jumps = false 102 show_nr_jumps = false
103 103
104 [help] 104 [help]
105 # Format can be man, info, web 105 # Format can be man, info, web or html
106 format = man 106 format = man
107 autocorrect = 0 107 autocorrect = 0
108 108
109 [ui] 109 [ui]
110 show-headers = true 110 show-headers = true
111 111
112 [call-graph] 112 [call-graph]
113 # fp (framepointer), dwarf 113 # fp (framepointer), dwarf
114 record-mode = fp 114 record-mode = fp
115 print-type = graph 115 print-type = graph
116 order = caller 116 order = caller
117 sort-key = function 117 sort-key = function
118 118
119 [report] 119 [report]
120 # Defaults 120 # Defaults
121 sort_order = comm,dso,symbol 121 sort_order = comm,dso,symbol
122 percent-limit = 0 122 percent-limit = 0
123 queue-size = 0 123 queue-size = 0
124 children = true 124 children = true
125 group = true 125 group = true
126 skip-empty = true 126 skip-empty = true
127 127
128 128
129 You can hide source code of annotate feature s 129 You can hide source code of annotate feature setting the config to false with
130 130
131 % perf config annotate.hide_src_code=t 131 % perf config annotate.hide_src_code=true
132 132
133 If you want to add or modify several config it 133 If you want to add or modify several config items, you can do like
134 134
135 % perf config ui.show-headers=false km 135 % perf config ui.show-headers=false kmem.default=slab
136 136
137 To modify the sort order of report functionali 137 To modify the sort order of report functionality in user config file(i.e. `~/.perfconfig`), do
138 138
139 % perf config --user report.sort-order 139 % perf config --user report.sort-order=srcline
140 140
141 To change colors of selected line to other for 141 To change colors of selected line to other foreground and background colors
142 in system config file (i.e. `$(sysconf)/perfco 142 in system config file (i.e. `$(sysconf)/perfconfig`), do
143 143
144 % perf config --system colors.selected 144 % perf config --system colors.selected=yellow,green
145 145
146 To query the record mode of call graph, do 146 To query the record mode of call graph, do
147 147
148 % perf config call-graph.record-mode 148 % perf config call-graph.record-mode
149 149
150 If you want to know multiple config key/value 150 If you want to know multiple config key/value pairs, you can do like
151 151
152 % perf config report.queue-size call-g 152 % perf config report.queue-size call-graph.order report.children
153 153
154 To query the config value of sort order of cal 154 To query the config value of sort order of call graph in user config file (i.e. `~/.perfconfig`), do
155 155
156 % perf config --user call-graph.sort-o 156 % perf config --user call-graph.sort-order
157 157
158 To query the config value of buildid directory 158 To query the config value of buildid directory in system config file (i.e. `$(sysconf)/perfconfig`), do
159 159
160 % perf config --system buildid.dir 160 % perf config --system buildid.dir
161 161
162 Variables 162 Variables
163 ~~~~~~~~~ 163 ~~~~~~~~~
164 164
165 colors.*:: 165 colors.*::
166 The variables for customizing the colo 166 The variables for customizing the colors used in the output for the
167 'report', 'top' and 'annotate' in the 167 'report', 'top' and 'annotate' in the TUI. They should specify the
168 foreground and background colors, sepa 168 foreground and background colors, separated by a comma, for example:
169 169
170 medium = green, lightgray 170 medium = green, lightgray
171 171
172 If you want to use the color configure 172 If you want to use the color configured for you terminal, just leave it
173 as 'default', for example: 173 as 'default', for example:
174 174
175 medium = default, lightgray 175 medium = default, lightgray
176 176
177 Available colors: 177 Available colors:
178 red, yellow, green, cyan, gray, black, 178 red, yellow, green, cyan, gray, black, blue,
179 white, default, magenta, lightgray 179 white, default, magenta, lightgray
180 180
181 colors.top:: 181 colors.top::
182 'top' means a overhead percent 182 'top' means a overhead percentage which is more than 5%.
183 And values of this variable sp 183 And values of this variable specify percentage colors.
184 Basic key values are foregroun 184 Basic key values are foreground-color 'red' and
185 background-color 'default'. 185 background-color 'default'.
186 colors.medium:: 186 colors.medium::
187 'medium' means a overhead perc 187 'medium' means a overhead percentage which has more than 0.5%.
188 Default values are 'green' and 188 Default values are 'green' and 'default'.
189 colors.normal:: 189 colors.normal::
190 'normal' means the rest of ove 190 'normal' means the rest of overhead percentages
191 except 'top', 'medium', 'selec 191 except 'top', 'medium', 'selected'.
192 Default values are 'lightgray' 192 Default values are 'lightgray' and 'default'.
193 colors.selected:: 193 colors.selected::
194 This selects the colors for th 194 This selects the colors for the current entry in a list of entries
195 from sub-commands (top, report 195 from sub-commands (top, report, annotate).
196 Default values are 'black' and 196 Default values are 'black' and 'lightgray'.
197 colors.jump_arrows:: 197 colors.jump_arrows::
198 Colors for jump arrows on asse 198 Colors for jump arrows on assembly code listings
199 such as 'jns', 'jmp', 'jane', 199 such as 'jns', 'jmp', 'jane', etc.
200 Default values are 'blue', 'de 200 Default values are 'blue', 'default'.
201 colors.addr:: 201 colors.addr::
202 This selects colors for addres 202 This selects colors for addresses from 'annotate'.
203 Default values are 'magenta', 203 Default values are 'magenta', 'default'.
204 colors.root:: 204 colors.root::
205 Colors for headers in the outp 205 Colors for headers in the output of a sub-commands (top, report).
206 Default values are 'white', 'b 206 Default values are 'white', 'blue'.
207 207
208 core.*:: 208 core.*::
209 core.proc-map-timeout:: 209 core.proc-map-timeout::
210 Sets a timeout (in millisecond 210 Sets a timeout (in milliseconds) for parsing /proc/<pid>/maps files.
211 Can be overridden by the --pro 211 Can be overridden by the --proc-map-timeout option on supported
212 subcommands. The default timeo 212 subcommands. The default timeout is 500ms.
213 213
214 tui.*, gtk.*:: 214 tui.*, gtk.*::
215 Subcommands that can be configured her 215 Subcommands that can be configured here are 'top', 'report' and 'annotate'.
216 These values are booleans, for example 216 These values are booleans, for example:
217 217
218 [tui] 218 [tui]
219 top = true 219 top = true
220 220
221 will make the TUI be the default for t 221 will make the TUI be the default for the 'top' subcommand. Those will be
222 available if the required libs were de 222 available if the required libs were detected at tool build time.
223 223
224 buildid.*:: 224 buildid.*::
225 buildid.dir:: 225 buildid.dir::
226 Each executable and shared lib 226 Each executable and shared library in modern distributions comes with a
227 content based identifier that, 227 content based identifier that, if available, will be inserted in a
228 'perf.data' file header to, at 228 'perf.data' file header to, at analysis time find what is needed to do
229 symbol resolution, code annota 229 symbol resolution, code annotation, etc.
230 230
231 The recording tools also store 231 The recording tools also stores a hard link or copy in a per-user
232 directory, $HOME/.debug/, of b 232 directory, $HOME/.debug/, of binaries, shared libraries, /proc/kallsyms
233 and /proc/kcore files to be us 233 and /proc/kcore files to be used at analysis time.
234 234
235 The buildid.dir variable can b 235 The buildid.dir variable can be used to either change this directory
236 cache location, or to disable 236 cache location, or to disable it altogether. If you want to disable it,
237 set buildid.dir to /dev/null. 237 set buildid.dir to /dev/null. The default is $HOME/.debug
238 238
239 buildid-cache.*:: 239 buildid-cache.*::
240 buildid-cache.debuginfod=URLs 240 buildid-cache.debuginfod=URLs
241 Specify debuginfod URLs to be 241 Specify debuginfod URLs to be used when retrieving perf.data binaries,
242 it follows the same syntax as 242 it follows the same syntax as the DEBUGINFOD_URLS variable, like:
243 243
244 buildid-cache.debuginfod=htt 244 buildid-cache.debuginfod=http://192.168.122.174:8002
245 245
246 annotate.*:: 246 annotate.*::
247 These are in control of addresses, jum 247 These are in control of addresses, jump function, source code
248 in lines of assembly code from a speci 248 in lines of assembly code from a specific program.
249 249
250 annotate.addr2line:: 250 annotate.addr2line::
251 addr2line binary to use for fi 251 addr2line binary to use for file names and line numbers.
252 252
253 annotate.objdump:: 253 annotate.objdump::
254 objdump binary to use for disa !! 254 objdump binary to use for disassembly and annotations.
255 including in the 'perf test' c <<
256 255
257 annotate.disassembler_style:: 256 annotate.disassembler_style::
258 Use this to change the default 257 Use this to change the default disassembler style to some other value
259 supported by binutils, such as 258 supported by binutils, such as "intel", see the '-M' option help in the
260 'objdump' man page. 259 'objdump' man page.
261 260
262 annotate.hide_src_code:: 261 annotate.hide_src_code::
263 If a program which is analyzed 262 If a program which is analyzed has source code,
264 this option lets 'annotate' pr 263 this option lets 'annotate' print a list of assembly code with the source code.
265 For example, let's see a part 264 For example, let's see a part of a program. There're four lines.
266 If this option is 'true', they 265 If this option is 'true', they can be printed
267 without source code from a pro 266 without source code from a program as below.
268 267
269 │ push %rbp 268 │ push %rbp
270 │ mov %rsp,%rbp 269 │ mov %rsp,%rbp
271 │ sub $0x10,%rsp 270 │ sub $0x10,%rsp
272 │ mov (%rdi),%rdx 271 │ mov (%rdi),%rdx
273 272
274 But if this option is 'false', 273 But if this option is 'false', source code of the part
275 can be also printed as below. 274 can be also printed as below. Default is 'false'.
276 275
277 │ struct rb_node *rb_ne 276 │ struct rb_node *rb_next(const struct rb_node *node)
278 │ { 277 │ {
279 │ push %rbp 278 │ push %rbp
280 │ mov %rsp,%rbp 279 │ mov %rsp,%rbp
281 │ sub $0x10,%rsp 280 │ sub $0x10,%rsp
282 │ struct rb_nod 281 │ struct rb_node *parent;
283 │ 282 │
284 │ if (RB_EMPTY_ 283 │ if (RB_EMPTY_NODE(node))
285 │ mov (%rdi),%rdx 284 │ mov (%rdi),%rdx
286 │ return n; 285 │ return n;
287 286
288 This option works with tui, st 287 This option works with tui, stdio2 browsers.
289 288
290 annotate.use_offset:: 289 annotate.use_offset::
291 Basing on a first address of a 290 Basing on a first address of a loaded function, offset can be used.
292 Instead of using original addr 291 Instead of using original addresses of assembly code,
293 addresses subtracted from a ba 292 addresses subtracted from a base address can be printed.
294 Let's illustrate an example. 293 Let's illustrate an example.
295 If a base address is 0XFFFFFFF 294 If a base address is 0XFFFFFFFF81624d50 as below,
296 295
297 ffffffff81624d50 <load0> 296 ffffffff81624d50 <load0>
298 297
299 an address on assembly code ha 298 an address on assembly code has a specific absolute address as below
300 299
301 ffffffff816250b8:│ mov 0 300 ffffffff816250b8:│ mov 0x8(%r14),%rdi
302 301
303 but if use_offset is 'true', a 302 but if use_offset is 'true', an address subtracted from a base address is printed.
304 Default is true. This option i 303 Default is true. This option is only applied to TUI.
305 304
306 368:│ mov 0 305 368:│ mov 0x8(%r14),%rdi
307 306
308 This option works with tui, st 307 This option works with tui, stdio2 browsers.
309 308
310 annotate.jump_arrows:: 309 annotate.jump_arrows::
311 There can be jump instruction 310 There can be jump instruction among assembly code.
312 Depending on a boolean value o 311 Depending on a boolean value of jump_arrows,
313 arrows can be printed or not w 312 arrows can be printed or not which represent
314 where do the instruction jump 313 where do the instruction jump into as below.
315 314
316 │ ┌──jmp 1333 315 │ ┌──jmp 1333
317 │ │ xchg %ax,%ax 316 │ │ xchg %ax,%ax
318 │1330:│ mov %r15,%r10 317 │1330:│ mov %r15,%r10
319 │1333:└─→cmp %r15,% 318 │1333:└─→cmp %r15,%r14
320 319
321 If jump_arrow is 'false', the 320 If jump_arrow is 'false', the arrows isn't printed as below.
322 Default is 'false'. 321 Default is 'false'.
323 322
324 │ ↓ jmp 1333 323 │ ↓ jmp 1333
325 │ xchg %ax,%ax 324 │ xchg %ax,%ax
326 │1330: mov %r15,%r10 325 │1330: mov %r15,%r10
327 │1333: cmp %r15,%r14 326 │1333: cmp %r15,%r14
328 327
329 This option works with tui bro 328 This option works with tui browser.
330 329
331 annotate.show_linenr:: 330 annotate.show_linenr::
332 When showing source code if th 331 When showing source code if this option is 'true',
333 line numbers are printed as be 332 line numbers are printed as below.
334 333
335 │1628 if (type & PER 334 │1628 if (type & PERF_SAMPLE_IDENTIFIER) {
336 │ ↓ jne 508 335 │ ↓ jne 508
337 │1628 data-> 336 │1628 data->id = *array;
338 │1629 array+ 337 │1629 array++;
339 │1630 } 338 │1630 }
340 339
341 However if this option is 'fal 340 However if this option is 'false', they aren't printed as below.
342 Default is 'false'. 341 Default is 'false'.
343 342
344 │ if (type & PER 343 │ if (type & PERF_SAMPLE_IDENTIFIER) {
345 │ ↓ jne 508 344 │ ↓ jne 508
346 │ data-> 345 │ data->id = *array;
347 │ array+ 346 │ array++;
348 │ } 347 │ }
349 348
350 This option works with tui, st 349 This option works with tui, stdio2 browsers.
351 350
352 annotate.show_nr_jumps:: 351 annotate.show_nr_jumps::
353 Let's see a part of assembly c 352 Let's see a part of assembly code.
354 353
355 │1382: movb $0x1,-0x270( 354 │1382: movb $0x1,-0x270(%rbp)
356 355
357 If use this, the number of bra 356 If use this, the number of branches jumping to that address can be printed as below.
358 Default is 'false'. 357 Default is 'false'.
359 358
360 │1 1382: movb $0x1,-0x27 359 │1 1382: movb $0x1,-0x270(%rbp)
361 360
362 This option works with tui, st 361 This option works with tui, stdio2 browsers.
363 362
364 annotate.show_total_period:: 363 annotate.show_total_period::
365 To compare two records on an i 364 To compare two records on an instruction base, with this option
366 provided, display total number 365 provided, display total number of samples that belong to a line
367 in assembly code. If this opti 366 in assembly code. If this option is 'true', total periods are printed
368 instead of percent values as b 367 instead of percent values as below.
369 368
370 302 │ mov %eax,%ea 369 302 │ mov %eax,%eax
371 370
372 But if this option is 'false', 371 But if this option is 'false', percent values for overhead are printed i.e.
373 Default is 'false'. 372 Default is 'false'.
374 373
375 99.93 │ mov %eax,%ea 374 99.93 │ mov %eax,%eax
376 375
377 This option works with tui, st 376 This option works with tui, stdio2, stdio browsers.
378 377
379 annotate.show_nr_samples:: 378 annotate.show_nr_samples::
380 By default perf annotate shows 379 By default perf annotate shows percentage of samples. This option
381 can be used to print absolute 380 can be used to print absolute number of samples. Ex, when set as
382 false: 381 false:
383 382
384 Percent│ 383 Percent│
385 74.03 │ mov %fs:0x2 384 74.03 │ mov %fs:0x28,%rax
386 385
387 When set as true: 386 When set as true:
388 387
389 Samples│ 388 Samples│
390 6 │ mov %fs:0x2 389 6 │ mov %fs:0x28,%rax
391 390
392 This option works with tui, st 391 This option works with tui, stdio2, stdio browsers.
393 392
394 annotate.offset_level:: 393 annotate.offset_level::
395 Default is '1', meaning just j 394 Default is '1', meaning just jump targets will have offsets show right beside
396 the instruction. When set to ' 395 the instruction. When set to '2' 'call' instructions will also have its offsets
397 shown, 3 or higher will show o 396 shown, 3 or higher will show offsets for all instructions.
398 397
399 This option works with tui, st 398 This option works with tui, stdio2 browsers.
400 399
401 annotate.demangle:: 400 annotate.demangle::
402 Demangle symbol names to human 401 Demangle symbol names to human readable form. Default is 'true'.
403 402
404 annotate.demangle_kernel:: 403 annotate.demangle_kernel::
405 Demangle kernel symbol names t 404 Demangle kernel symbol names to human readable form. Default is 'true'.
406 405
407 hist.*:: 406 hist.*::
408 hist.percentage:: 407 hist.percentage::
409 This option control the way to 408 This option control the way to calculate overhead of filtered entries -
410 that means the value of this o 409 that means the value of this option is effective only if there's a
411 filter (by comm, dso or symbol 410 filter (by comm, dso or symbol name). Suppose a following example:
412 411
413 Overhead Symbols 412 Overhead Symbols
414 ........ ....... 413 ........ .......
415 33.33% foo 414 33.33% foo
416 33.33% bar 415 33.33% bar
417 33.33% baz 416 33.33% baz
418 417
419 This is an original overhead an 418 This is an original overhead and we'll filter out the first 'foo'
420 entry. The value of 'relative' 419 entry. The value of 'relative' would increase the overhead of 'bar'
421 and 'baz' to 50.00% for each, w 420 and 'baz' to 50.00% for each, while 'absolute' would show their
422 current overhead (33.33%). 421 current overhead (33.33%).
423 422
424 ui.*:: 423 ui.*::
425 ui.show-headers:: 424 ui.show-headers::
426 This option controls display o 425 This option controls display of column headers (like 'Overhead' and 'Symbol')
427 in 'report' and 'top'. If this 426 in 'report' and 'top'. If this option is false, they are hidden.
428 This option is only applied to 427 This option is only applied to TUI.
429 428
430 call-graph.*:: 429 call-graph.*::
431 The following controls the handling of 430 The following controls the handling of call-graphs (obtained via the
432 -g/--call-graph options). 431 -g/--call-graph options).
433 432
434 call-graph.record-mode:: 433 call-graph.record-mode::
435 The mode for user space can be 434 The mode for user space can be 'fp' (frame pointer), 'dwarf'
436 and 'lbr'. The value 'dwarf' 435 and 'lbr'. The value 'dwarf' is effective only if libunwind
437 (or a recent version of libdw) 436 (or a recent version of libdw) is present on the system;
438 the value 'lbr' only works for 437 the value 'lbr' only works for certain cpus. The method for
439 kernel space is controlled not 438 kernel space is controlled not by this option but by the
440 kernel config (CONFIG_UNWINDER 439 kernel config (CONFIG_UNWINDER_*).
441 440
442 call-graph.dump-size:: 441 call-graph.dump-size::
443 The size of stack to dump in o 442 The size of stack to dump in order to do post-unwinding. Default is 8192 (byte).
444 When using dwarf into record-m 443 When using dwarf into record-mode, the default size will be used if omitted.
445 444
446 call-graph.print-type:: 445 call-graph.print-type::
447 The print-types can be graph ( 446 The print-types can be graph (graph absolute), fractal (graph relative),
448 flat and folded. This option c 447 flat and folded. This option controls a way to show overhead for each callchain
449 entry. Suppose a following exa 448 entry. Suppose a following example.
450 449
451 Overhead Symbols 450 Overhead Symbols
452 ........ ....... 451 ........ .......
453 40.00% foo 452 40.00% foo
454 | 453 |
455 ---foo 454 ---foo
456 | 455 |
457 |--50.00%--bar 456 |--50.00%--bar
458 | main 457 | main
459 | 458 |
460 --50.00%--baz 459 --50.00%--baz
461 main 460 main
462 461
463 This output is a 'fractal' for 462 This output is a 'fractal' format. The 'foo' came from 'bar' and 'baz' exactly
464 half and half so 'fractal' sho 463 half and half so 'fractal' shows 50.00% for each
465 (meaning that it assumes 100% 464 (meaning that it assumes 100% total overhead of 'foo').
466 465
467 The 'graph' uses absolute over 466 The 'graph' uses absolute overhead value of 'foo' as total so each of
468 'bar' and 'baz' callchain will 467 'bar' and 'baz' callchain will have 20.00% of overhead.
469 If 'flat' is used, single colu 468 If 'flat' is used, single column and linear exposure of call chains.
470 'folded' mean call chains are 469 'folded' mean call chains are displayed in a line, separated by semicolons.
471 470
472 call-graph.order:: 471 call-graph.order::
473 This option controls print ord 472 This option controls print order of callchains. The default is
474 'callee' which means callee is 473 'callee' which means callee is printed at top and then followed by its
475 caller and so on. The 'caller' 474 caller and so on. The 'caller' prints it in reverse order.
476 475
477 If this option is not set and 476 If this option is not set and report.children or top.children is
478 set to true (or the equivalent 477 set to true (or the equivalent command line option is given),
479 the default value of this opti 478 the default value of this option is changed to 'caller' for the
480 execution of 'perf report' or 479 execution of 'perf report' or 'perf top'. Other commands will
481 still default to 'callee'. 480 still default to 'callee'.
482 481
483 call-graph.sort-key:: 482 call-graph.sort-key::
484 The callchains are merged if t 483 The callchains are merged if they contain same information.
485 The sort-key option determines 484 The sort-key option determines a way to compare the callchains.
486 A value of 'sort-key' can be ' 485 A value of 'sort-key' can be 'function' or 'address'.
487 The default is 'function'. 486 The default is 'function'.
488 487
489 call-graph.threshold:: 488 call-graph.threshold::
490 When there're many callchains 489 When there're many callchains it'd print tons of lines. So perf omits
491 small callchains under a certa 490 small callchains under a certain overhead (threshold) and this option
492 control the threshold. Default 491 control the threshold. Default is 0.5 (%). The overhead is calculated
493 by value depends on call-graph 492 by value depends on call-graph.print-type.
494 493
495 call-graph.print-limit:: 494 call-graph.print-limit::
496 This is a maximum number of li 495 This is a maximum number of lines of callchain printed for a single
497 histogram entry. Default is 0 496 histogram entry. Default is 0 which means no limitation.
498 497
499 report.*:: 498 report.*::
500 report.sort_order:: 499 report.sort_order::
501 Allows changing the default so 500 Allows changing the default sort order from "comm,dso,symbol" to
502 some other default, for instan 501 some other default, for instance "sym,dso" may be more fitting for
503 kernel developers. 502 kernel developers.
504 report.percent-limit:: 503 report.percent-limit::
505 This one is mostly the same as 504 This one is mostly the same as call-graph.threshold but works for
506 histogram entries. Entries hav 505 histogram entries. Entries having an overhead lower than this
507 percentage will not be printed 506 percentage will not be printed. Default is '0'. If percent-limit
508 is '10', only entries which ha 507 is '10', only entries which have more than 10% of overhead will be
509 printed. 508 printed.
510 509
511 report.queue-size:: 510 report.queue-size::
512 This option sets up the maximu 511 This option sets up the maximum allocation size of the internal
513 event queue for ordering event 512 event queue for ordering events. Default is 0, meaning no limit.
514 513
515 report.children:: 514 report.children::
516 'Children' means functions cal 515 'Children' means functions called from another function.
517 If this option is true, 'perf 516 If this option is true, 'perf report' cumulates callchains of children
518 and show (accumulated) total o 517 and show (accumulated) total overhead as well as 'Self' overhead.
519 Please refer to the 'perf repo 518 Please refer to the 'perf report' manual. The default is 'true'.
520 519
521 report.group:: 520 report.group::
522 This option is to show event g 521 This option is to show event group information together.
523 Example output with this turne 522 Example output with this turned on, notice that there is one column
524 per event in the group, ref-cy 523 per event in the group, ref-cycles and cycles:
525 524
526 # group: {ref-cycles,cycles} 525 # group: {ref-cycles,cycles}
527 # ======== 526 # ========
528 # 527 #
529 # Samples: 7K of event 'anon g 528 # Samples: 7K of event 'anon group { ref-cycles, cycles }'
530 # Event count (approx.): 68761 529 # Event count (approx.): 6876107743
531 # 530 #
532 # Overhead Command 531 # Overhead Command Shared Object Symbol
533 # ................ ....... . 532 # ................ ....... ................. ...................
534 # 533 #
535 99.84% 99.76% noploop n 534 99.84% 99.76% noploop noploop [.] main
536 0.07% 0.00% noploop l 535 0.07% 0.00% noploop ld-2.15.so [.] strcmp
537 0.03% 0.00% noploop [ 536 0.03% 0.00% noploop [kernel.kallsyms] [k] timerqueue_del
538 537
539 report.skip-empty:: 538 report.skip-empty::
540 This option can change default 539 This option can change default stat behavior with empty results.
541 If it's set true, 'perf report 540 If it's set true, 'perf report --stat' will not show 0 stats.
542 541
543 top.*:: 542 top.*::
544 top.children:: 543 top.children::
545 Same as 'report.children'. So 544 Same as 'report.children'. So if it is enabled, the output of 'top'
546 command will have 'Children' o 545 command will have 'Children' overhead column as well as 'Self' overhead
547 column by default. 546 column by default.
548 The default is 'true'. 547 The default is 'true'.
549 548
550 top.call-graph:: 549 top.call-graph::
551 This is identical to 'call-gra 550 This is identical to 'call-graph.record-mode', except it is
552 applicable only for 'top' subc 551 applicable only for 'top' subcommand. This option ONLY setup
553 the unwind method. To enable ' 552 the unwind method. To enable 'perf top' to actually use it,
554 the command line option -g mus 553 the command line option -g must be specified.
555 554
556 man.*:: 555 man.*::
557 man.viewer:: 556 man.viewer::
558 This option can assign a tool 557 This option can assign a tool to view manual pages when 'help'
559 subcommand was invoked. Suppor 558 subcommand was invoked. Supported tools are 'man', 'woman'
560 (with emacs client) and 'konqu 559 (with emacs client) and 'konqueror'. Default is 'man'.
561 560
562 New man viewer tool can be als 561 New man viewer tool can be also added using 'man.<tool>.cmd'
563 or use different path using 'm 562 or use different path using 'man.<tool>.path' config option.
564 563
565 pager.*:: 564 pager.*::
566 pager.<subcommand>:: 565 pager.<subcommand>::
567 When the subcommand is run on 566 When the subcommand is run on stdio, determine whether it uses
568 pager or not based on this val 567 pager or not based on this value. Default is 'unspecified'.
569 568
570 kmem.*:: 569 kmem.*::
571 kmem.default:: 570 kmem.default::
572 This option decides which allo 571 This option decides which allocator is to be analyzed if neither
573 '--slab' nor '--page' option i 572 '--slab' nor '--page' option is used. Default is 'slab'.
574 573
575 record.*:: 574 record.*::
576 record.build-id:: 575 record.build-id::
577 This option can be 'cache', 'n 576 This option can be 'cache', 'no-cache', 'skip' or 'mmap'.
578 'cache' is to post-process dat 577 'cache' is to post-process data and save/update the binaries into
579 the build-id cache (in ~/.debu 578 the build-id cache (in ~/.debug). This is the default.
580 But if this option is 'no-cach 579 But if this option is 'no-cache', it will not update the build-id cache.
581 'skip' skips post-processing a 580 'skip' skips post-processing and does not update the cache.
582 'mmap' skips post-processing a 581 'mmap' skips post-processing and reads build-ids from MMAP events.
583 582
584 record.call-graph:: 583 record.call-graph::
585 This is identical to 'call-gra 584 This is identical to 'call-graph.record-mode', except it is
586 applicable only for 'record' s 585 applicable only for 'record' subcommand. This option ONLY setup
587 the unwind method. To enable ' 586 the unwind method. To enable 'perf record' to actually use it,
588 the command line option -g mus 587 the command line option -g must be specified.
589 588
590 record.aio:: 589 record.aio::
591 Use 'n' control blocks in asyn 590 Use 'n' control blocks in asynchronous (Posix AIO) trace writing
592 mode ('n' default: 1, max: 4). 591 mode ('n' default: 1, max: 4).
593 592
594 record.debuginfod:: 593 record.debuginfod::
595 Specify debuginfod URL to be u 594 Specify debuginfod URL to be used when cacheing perf.data binaries,
596 it follows the same syntax as 595 it follows the same syntax as the DEBUGINFOD_URLS variable, like:
597 596
598 http://192.168.122.174:8002 597 http://192.168.122.174:8002
599 598
600 If the URLs is 'system', the v 599 If the URLs is 'system', the value of DEBUGINFOD_URLS system environment
601 variable is used. 600 variable is used.
602 601
603 diff.*:: 602 diff.*::
604 diff.order:: 603 diff.order::
605 This option sets the number of 604 This option sets the number of columns to sort the result.
606 The default is 0, which means 605 The default is 0, which means sorting by baseline.
607 Setting it to 1 will sort the 606 Setting it to 1 will sort the result by delta (or other
608 compute method selected). 607 compute method selected).
609 608
610 diff.compute:: 609 diff.compute::
611 This options sets the method f 610 This options sets the method for computing the diff result.
612 Possible values are 'delta', ' 611 Possible values are 'delta', 'delta-abs', 'ratio' and
613 'wdiff'. Default is 'delta'. 612 'wdiff'. Default is 'delta'.
614 613
615 trace.*:: 614 trace.*::
616 trace.add_events:: 615 trace.add_events::
617 Allows adding a set of events 616 Allows adding a set of events to add to the ones specified
618 by the user, or use as a defau 617 by the user, or use as a default one if none was specified.
619 The initial use case is to add 618 The initial use case is to add augmented_raw_syscalls.o to
620 activate the 'perf trace' logi 619 activate the 'perf trace' logic that looks for syscall
621 pointer contents after the nor 620 pointer contents after the normal tracepoint payload.
622 621
623 trace.args_alignment:: 622 trace.args_alignment::
624 Number of columns to align the 623 Number of columns to align the argument list, default is 70,
625 use 40 for the strace default, 624 use 40 for the strace default, zero to no alignment.
626 625
627 trace.no_inherit:: 626 trace.no_inherit::
628 Do not follow children threads 627 Do not follow children threads.
629 628
630 trace.show_arg_names:: 629 trace.show_arg_names::
631 Should syscall argument names 630 Should syscall argument names be printed? If not then trace.show_zeros
632 will be set. 631 will be set.
633 632
634 trace.show_duration:: 633 trace.show_duration::
635 Show syscall duration. 634 Show syscall duration.
636 635
637 trace.show_prefix:: 636 trace.show_prefix::
638 If set to 'yes' will show comm 637 If set to 'yes' will show common string prefixes in tables. The default
639 is to remove the common prefix 638 is to remove the common prefix in things like "MAP_SHARED", showing just "SHARED".
640 639
641 trace.show_timestamp:: 640 trace.show_timestamp::
642 Show syscall start timestamp. 641 Show syscall start timestamp.
643 642
644 trace.show_zeros:: 643 trace.show_zeros::
645 Do not suppress syscall argume 644 Do not suppress syscall arguments that are equal to zero.
646 645
647 trace.tracepoint_beautifiers:: 646 trace.tracepoint_beautifiers::
648 Use "libtraceevent" to use tha 647 Use "libtraceevent" to use that library to augment the tracepoint arguments,
649 "libbeauty", the default, to u 648 "libbeauty", the default, to use the same argument beautifiers used in the
650 strace-like sys_enter+sys_exit 649 strace-like sys_enter+sys_exit lines.
651 650
652 ftrace.*:: 651 ftrace.*::
653 ftrace.tracer:: 652 ftrace.tracer::
654 Can be used to select the defa 653 Can be used to select the default tracer when neither -G nor
655 -F option is not specified. Po 654 -F option is not specified. Possible values are 'function' and
656 'function_graph'. 655 'function_graph'.
657 656
658 samples.*:: 657 samples.*::
659 658
660 samples.context:: 659 samples.context::
661 Define how many ns worth of ti 660 Define how many ns worth of time to show
662 around samples in perf report 661 around samples in perf report sample context browser.
663 662
664 scripts.*:: 663 scripts.*::
665 664
666 Any option defines a script that is ad 665 Any option defines a script that is added to the scripts menu
667 in the interactive perf browser and wh 666 in the interactive perf browser and whose output is displayed.
668 The name of the option is the name, th 667 The name of the option is the name, the value is a script command line.
669 The script gets the same options passe 668 The script gets the same options passed as a full perf script,
670 in particular -i perfdata file, --cpu, 669 in particular -i perfdata file, --cpu, --tid
671 670
672 convert.*:: 671 convert.*::
673 672
674 convert.queue-size:: 673 convert.queue-size::
675 Limit the size of ordered_even 674 Limit the size of ordered_events queue, so we could control
676 allocation size of perf data f 675 allocation size of perf data files without proper finished
677 round events. 676 round events.
678 stat.*:: 677 stat.*::
679 678
680 stat.big-num:: 679 stat.big-num::
681 (boolean) Change the default f 680 (boolean) Change the default for "--big-num". To make
682 "--no-big-num" the default, se 681 "--no-big-num" the default, set "stat.big-num=false".
683 682
684 intel-pt.*:: 683 intel-pt.*::
685 684
686 intel-pt.cache-divisor:: 685 intel-pt.cache-divisor::
687 686
688 intel-pt.mispred-all:: 687 intel-pt.mispred-all::
689 If set, Intel PT decoder will 688 If set, Intel PT decoder will set the mispred flag on all
690 branches. 689 branches.
691 690
692 intel-pt.max-loops:: 691 intel-pt.max-loops::
693 If set and non-zero, the maxim 692 If set and non-zero, the maximum number of unconditional
694 branches decoded without consu 693 branches decoded without consuming any trace packets. If
695 the maximum is exceeded there 694 the maximum is exceeded there will be a "Never-ending loop"
696 error. The default is 100000. 695 error. The default is 100000.
697 696
698 auxtrace.*:: 697 auxtrace.*::
699 698
700 auxtrace.dumpdir:: 699 auxtrace.dumpdir::
701 s390 only. The directory to sa 700 s390 only. The directory to save the auxiliary trace buffer
702 can be changed using this opti 701 can be changed using this option. Ex, auxtrace.dumpdir=/tmp.
703 If the directory does not exis 702 If the directory does not exist or has the wrong file type,
704 the current directory is used. 703 the current directory is used.
705 704
706 itrace.*:: 705 itrace.*::
707 706
708 debug-log-buffer-size:: 707 debug-log-buffer-size::
709 Log size in bytes to output wh 708 Log size in bytes to output when using the option --itrace=d+e
710 Refer 'itrace' option of linkp 709 Refer 'itrace' option of linkperf:perf-script[1] or
711 linkperf:perf-report[1]. The d 710 linkperf:perf-report[1]. The default is 16384.
712 711
713 daemon.*:: 712 daemon.*::
714 713
715 daemon.base:: 714 daemon.base::
716 Base path for daemon data. All 715 Base path for daemon data. All sessions data are stored under
717 this path. 716 this path.
718 717
719 session-<NAME>.*:: 718 session-<NAME>.*::
720 719
721 session-<NAME>.run:: 720 session-<NAME>.run::
722 721
723 Defines new record session for 722 Defines new record session for daemon. The value is record's
724 command line without the 'reco 723 command line without the 'record' keyword.
>> 724
725 725
726 SEE ALSO 726 SEE ALSO
727 -------- 727 --------
728 linkperf:perf[1] 728 linkperf:perf[1]
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.