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