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