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