1 perf-script(1) 1 perf-script(1)
2 ============= 2 =============
3 3
4 NAME 4 NAME
5 ---- 5 ----
6 perf-script - Read perf.data (created by perf 6 perf-script - Read perf.data (created by perf record) and display trace output
7 7
8 SYNOPSIS 8 SYNOPSIS
9 -------- 9 --------
10 [verse] 10 [verse]
11 'perf script' [<options>] 11 'perf script' [<options>]
12 'perf script' [<options>] record <script> [<re 12 'perf script' [<options>] record <script> [<record-options>] <command>
13 'perf script' [<options>] report <script> [scr 13 'perf script' [<options>] report <script> [script-args]
14 'perf script' [<options>] <script> <required-s 14 'perf script' [<options>] <script> <required-script-args> [<record-options>] <command>
15 'perf script' [<options>] <top-script> [script 15 'perf script' [<options>] <top-script> [script-args]
16 16
17 DESCRIPTION 17 DESCRIPTION
18 ----------- 18 -----------
19 This command reads the input file and displays 19 This command reads the input file and displays the trace recorded.
20 20
21 There are several variants of perf script: 21 There are several variants of perf script:
22 22
23 'perf script' to see a detailed trace of the 23 'perf script' to see a detailed trace of the workload that was
24 recorded. 24 recorded.
25 25
26 You can also run a set of pre-canned scripts 26 You can also run a set of pre-canned scripts that aggregate and
27 summarize the raw trace data in various ways 27 summarize the raw trace data in various ways (the list of scripts is
28 available via 'perf script -l'). The follow 28 available via 'perf script -l'). The following variants allow you to
29 record and run those scripts: 29 record and run those scripts:
30 30
31 'perf script record <script> <command>' to r 31 'perf script record <script> <command>' to record the events required
32 for 'perf script report'. <script> is the n 32 for 'perf script report'. <script> is the name displayed in the
33 output of 'perf script --list' i.e. the actu 33 output of 'perf script --list' i.e. the actual script name minus any
34 language extension. If <command> is not spe 34 language extension. If <command> is not specified, the events are
35 recorded using the -a (system-wide) 'perf re 35 recorded using the -a (system-wide) 'perf record' option.
36 36
37 'perf script report <script> [args]' to run 37 'perf script report <script> [args]' to run and display the results
38 of <script>. <script> is the name displayed 38 of <script>. <script> is the name displayed in the output of 'perf
39 script --list' i.e. the actual script name m 39 script --list' i.e. the actual script name minus any language
40 extension. The perf.data output from a prev 40 extension. The perf.data output from a previous run of 'perf script
41 record <script>' is used and should be prese 41 record <script>' is used and should be present for this command to
42 succeed. [args] refers to the (mainly optio 42 succeed. [args] refers to the (mainly optional) args expected by
43 the script. 43 the script.
44 44
45 'perf script <script> <required-script-args> 45 'perf script <script> <required-script-args> <command>' to both
46 record the events required for <script> and 46 record the events required for <script> and to run the <script>
47 using 'live-mode' i.e. without writing anyth 47 using 'live-mode' i.e. without writing anything to disk. <script>
48 is the name displayed in the output of 'perf 48 is the name displayed in the output of 'perf script --list' i.e. the
49 actual script name minus any language extens 49 actual script name minus any language extension. If <command> is
50 not specified, the events are recorded using 50 not specified, the events are recorded using the -a (system-wide)
51 'perf record' option. If <script> has any r 51 'perf record' option. If <script> has any required args, they
52 should be specified before <command>. This 52 should be specified before <command>. This mode doesn't allow for
53 optional script args to be specified; if opt 53 optional script args to be specified; if optional script args are
54 desired, they can be specified using separat 54 desired, they can be specified using separate 'perf script record'
55 and 'perf script report' commands, with the 55 and 'perf script report' commands, with the stdout of the record step
56 piped to the stdin of the report script, usi 56 piped to the stdin of the report script, using the '-o -' and '-i -'
57 options of the corresponding commands. 57 options of the corresponding commands.
58 58
59 'perf script <top-script>' to both record th 59 'perf script <top-script>' to both record the events required for
60 <top-script> and to run the <top-script> usi 60 <top-script> and to run the <top-script> using 'live-mode'
61 i.e. without writing anything to disk. <top 61 i.e. without writing anything to disk. <top-script> is the name
62 displayed in the output of 'perf script --li 62 displayed in the output of 'perf script --list' i.e. the actual
63 script name minus any language extension; a 63 script name minus any language extension; a <top-script> is defined
64 as any script name ending with the string 't 64 as any script name ending with the string 'top'.
65 65
66 [<record-options>] can be passed to the reco 66 [<record-options>] can be passed to the record steps of 'perf script
67 record' and 'live-mode' variants; this isn't 67 record' and 'live-mode' variants; this isn't possible however for
68 <top-script> 'live-mode' or 'perf script rep 68 <top-script> 'live-mode' or 'perf script report' variants.
69 69
70 See the 'SEE ALSO' section for links to lang 70 See the 'SEE ALSO' section for links to language-specific
71 information on how to write and run your own 71 information on how to write and run your own trace scripts.
72 72
73 OPTIONS 73 OPTIONS
74 ------- 74 -------
75 <command>...:: 75 <command>...::
76 Any command you can specify in a shell 76 Any command you can specify in a shell.
77 77
78 -D:: 78 -D::
79 --dump-raw-trace=:: 79 --dump-raw-trace=::
80 Display verbose dump of the trace data 80 Display verbose dump of the trace data.
81 81
82 --dump-unsorted-raw-trace=:: <<
83 Same as --dump-raw-trace but not sorte <<
84 <<
85 -L:: 82 -L::
86 --Latency=:: 83 --Latency=::
87 Show latency attributes (irqs/preempti 84 Show latency attributes (irqs/preemption disabled, etc).
88 85
89 -l:: 86 -l::
90 --list=:: 87 --list=::
91 Display a list of available trace scri 88 Display a list of available trace scripts.
92 89
93 -s ['lang']:: 90 -s ['lang']::
94 --script=:: 91 --script=::
95 Process trace data with the given scri 92 Process trace data with the given script ([lang]:script[.ext]).
96 If the string 'lang' is specified in p 93 If the string 'lang' is specified in place of a script name, a
97 list of supported languages will be di 94 list of supported languages will be displayed instead.
98 95
99 -g:: 96 -g::
100 --gen-script=:: 97 --gen-script=::
101 Generate perf-script.[ext] starter scr 98 Generate perf-script.[ext] starter script for given language,
102 using current perf.data. 99 using current perf.data.
103 100
104 --dlfilter=<file>:: 101 --dlfilter=<file>::
105 Filter sample events using the given s 102 Filter sample events using the given shared object file.
106 Refer linkperf:perf-dlfilter[1] 103 Refer linkperf:perf-dlfilter[1]
107 104
108 --dlarg=<arg>:: 105 --dlarg=<arg>::
109 Pass 'arg' as an argument to the dlfil 106 Pass 'arg' as an argument to the dlfilter. --dlarg may be repeated
110 to add more arguments. 107 to add more arguments.
111 108
112 --list-dlfilters:: 109 --list-dlfilters::
113 Display a list of available dlfilters. 110 Display a list of available dlfilters. Use with option -v (must come
114 before option --list-dlfilters) to sho 111 before option --list-dlfilters) to show long descriptions.
115 112
116 -a:: 113 -a::
117 Force system-wide collection. Scripts 114 Force system-wide collection. Scripts run without a <command>
118 normally use -a by default, while scri 115 normally use -a by default, while scripts run with a <command>
119 normally don't - this option allows th 116 normally don't - this option allows the latter to be run in
120 system-wide mode. 117 system-wide mode.
121 118
122 -i:: 119 -i::
123 --input=:: 120 --input=::
124 Input file name. (default: perf.data u 121 Input file name. (default: perf.data unless stdin is a fifo)
125 122
126 -d:: 123 -d::
127 --debug-mode:: 124 --debug-mode::
128 Do various checks like samples orderin 125 Do various checks like samples ordering and lost events.
129 126
130 -F:: 127 -F::
131 --fields:: 128 --fields::
132 Comma separated list of fields to prin 129 Comma separated list of fields to print. Options are:
133 comm, tid, pid, time, cpu, event, trac !! 130 comm, tid, pid, time, cpu, event, trace, ip, sym, dso, addr, symoff,
134 srcline, period, iregs, uregs, brstack 131 srcline, period, iregs, uregs, brstack, brstacksym, flags, bpf-output,
135 brstackinsn, brstackinsnlen, brstackdi !! 132 brstackinsn, brstackinsnlen, brstackoff, callindent, insn, insnlen, synth,
136 insnlen, synth, phys_addr, metric, mis !! 133 phys_addr, metric, misc, srccode, ipc, data_page_size, code_page_size, ins_lat.
137 code_page_size, ins_lat, machine_pid, <<
138 <<
139 Field list can be prepended with the t 134 Field list can be prepended with the type, trace, sw or hw,
140 to indicate to which event type the fi 135 to indicate to which event type the field list applies.
141 e.g., -F sw:comm,tid,time,ip,sym and 136 e.g., -F sw:comm,tid,time,ip,sym and -F trace:time,cpu,trace
142 137
143 perf script -F <fields> 138 perf script -F <fields>
144 139
145 is equivalent to: 140 is equivalent to:
146 141
147 perf script -F trace:<fields> 142 perf script -F trace:<fields> -F sw:<fields> -F hw:<fields>
148 143
149 i.e., the specified fields apply to al 144 i.e., the specified fields apply to all event types if the type string
150 is not given. 145 is not given.
151 146
152 In addition to overriding fields, it i 147 In addition to overriding fields, it is also possible to add or remove
153 fields from the defaults. For example 148 fields from the defaults. For example
154 149
155 -F -cpu,+insn 150 -F -cpu,+insn
156 151
157 removes the cpu field and adds the ins 152 removes the cpu field and adds the insn field. Adding/removing fields
158 cannot be mixed with normal overriding 153 cannot be mixed with normal overriding.
159 154
160 The arguments are processed in the ord 155 The arguments are processed in the order received. A later usage can
161 reset a prior request. e.g.: 156 reset a prior request. e.g.:
162 157
163 -F trace: -F comm,tid,time,ip, 158 -F trace: -F comm,tid,time,ip,sym
164 159
165 The first -F suppresses trace events ( 160 The first -F suppresses trace events (field list is ""), but then the
166 second invocation sets the fields to c 161 second invocation sets the fields to comm,tid,time,ip,sym. In this case a
167 warning is given to the user: 162 warning is given to the user:
168 163
169 "Overriding previous field req 164 "Overriding previous field request for all events."
170 165
171 Alternatively, consider the order: 166 Alternatively, consider the order:
172 167
173 -F comm,tid,time,ip,sym -F tra 168 -F comm,tid,time,ip,sym -F trace:
174 169
175 The first -F sets the fields for all e 170 The first -F sets the fields for all events and the second -F
176 suppresses trace events. The user is g 171 suppresses trace events. The user is given a warning message about
177 the override, and the result of the ab 172 the override, and the result of the above is that only S/W and H/W
178 events are displayed with the given fi 173 events are displayed with the given fields.
179 174
180 It's possible tp add/remove fields onl 175 It's possible tp add/remove fields only for specific event type:
181 176
182 -Fsw:-cpu,-period 177 -Fsw:-cpu,-period
183 178
184 removes cpu and period from software e 179 removes cpu and period from software events.
185 180
186 For the 'wildcard' option if a user se 181 For the 'wildcard' option if a user selected field is invalid for an
187 event type, a message is displayed to 182 event type, a message is displayed to the user that the option is
188 ignored for that type. For example: 183 ignored for that type. For example:
189 184
190 $ perf script -F comm,tid,trac 185 $ perf script -F comm,tid,trace
191 'trace' not valid for hardware 186 'trace' not valid for hardware events. Ignoring.
192 'trace' not valid for software 187 'trace' not valid for software events. Ignoring.
193 188
194 Alternatively, if the type is given an 189 Alternatively, if the type is given an invalid field is specified it
195 is an error. For example: 190 is an error. For example:
196 191
197 perf script -v -F sw:comm,tid,trace 192 perf script -v -F sw:comm,tid,trace
198 'trace' not valid for software events. 193 'trace' not valid for software events.
199 194
200 At this point usage is displayed, and 195 At this point usage is displayed, and perf-script exits.
201 196
202 The flags field is synthesized and may 197 The flags field is synthesized and may have a value when Instruction
203 Trace decoding. The flags are "bcrosyi 198 Trace decoding. The flags are "bcrosyiABExghDt" which stand for branch,
204 call, return, conditional, system, asy 199 call, return, conditional, system, asynchronous, interrupt,
205 transaction abort, trace begin, trace 200 transaction abort, trace begin, trace end, in transaction, VM-Entry,
206 VM-Exit, interrupt disabled and interr 201 VM-Exit, interrupt disabled and interrupt disable toggle respectively.
207 Known combinations of flags are printe 202 Known combinations of flags are printed more nicely e.g.
208 "call" for "bc", "return" for "br", "j 203 "call" for "bc", "return" for "br", "jcc" for "bo", "jmp" for "b",
209 "int" for "bci", "iret" for "bri", "sy 204 "int" for "bci", "iret" for "bri", "syscall" for "bcs", "sysret" for "brs",
210 "async" for "by", "hw int" for "bcyi", 205 "async" for "by", "hw int" for "bcyi", "tx abrt" for "bA", "tr strt" for "bB",
211 "tr end" for "bE", "vmentry" for "bcg" 206 "tr end" for "bE", "vmentry" for "bcg", "vmexit" for "bch".
212 However the "x", "D" and "t" flags wil 207 However the "x", "D" and "t" flags will be displayed separately in those
213 cases e.g. "jcc (xD)" for a condit 208 cases e.g. "jcc (xD)" for a condition branch within a transaction
214 with interrupts disabled. Note, interr 209 with interrupts disabled. Note, interrupts becoming disabled is "t",
215 whereas interrupts becoming enabled is 210 whereas interrupts becoming enabled is "Dt".
216 211
217 The callindent field is synthesized an 212 The callindent field is synthesized and may have a value when
218 Instruction Trace decoding. For calls 213 Instruction Trace decoding. For calls and returns, it will display the
219 name of the symbol indented with space 214 name of the symbol indented with spaces to reflect the stack depth.
220 215
221 When doing instruction trace decoding, !! 216 When doing instruction trace decoding insn and insnlen give the
222 instruction bytes, disassembled instru !! 217 instruction bytes and the instruction length of the current
223 and the instruction length of the curr !! 218 instruction.
224 219
225 The synth field is used by synthesized 220 The synth field is used by synthesized events which may be created when
226 Instruction Trace decoding. 221 Instruction Trace decoding.
227 222
228 The ipc (instructions per cycle) field 223 The ipc (instructions per cycle) field is synthesized and may have a value when
229 Instruction Trace decoding. 224 Instruction Trace decoding.
230 225
231 The machine_pid and vcpu fields are de <<
232 perf inject to insert a perf.data file <<
233 a perf.data file recorded on the host <<
234 <<
235 The cgroup fields requires sample havi <<
236 when "--all-cgroups" option is passed <<
237 <<
238 Finally, a user may not set fields to 226 Finally, a user may not set fields to none for all event types.
239 i.e., -F "" is not allowed. 227 i.e., -F "" is not allowed.
240 228
241 The brstack output includes branch rel 229 The brstack output includes branch related information with raw addresses using the
242 /v/v/v/v/cycles syntax in the followin 230 /v/v/v/v/cycles syntax in the following order:
243 FROM: branch source instruction 231 FROM: branch source instruction
244 TO : branch target instruction 232 TO : branch target instruction
245 M/P/-: M=branch target mispredicted or 233 M/P/-: M=branch target mispredicted or branch direction was mispredicted, P=target predicted or direction predicted, -=not supported
246 X/- : X=branch inside a transactional 234 X/- : X=branch inside a transactional region, -=not in transaction region or not supported
247 A/- : A=TSX abort entry, -=not aborted 235 A/- : A=TSX abort entry, -=not aborted region or not supported
248 cycles 236 cycles
249 237
250 The brstacksym is identical to brstack 238 The brstacksym is identical to brstack, except that the FROM and TO addresses are printed in a symbolic form if possible.
251 239
252 When brstackinsn is specified the full 240 When brstackinsn is specified the full assembler sequences of branch sequences for each sample
253 is printed. This is the full execution 241 is printed. This is the full execution path leading to the sample. This is only supported when the
254 sample was recorded with perf record - 242 sample was recorded with perf record -b or -j any.
255 243
256 Use brstackinsnlen to print the brstac 244 Use brstackinsnlen to print the brstackinsn lenght. For example, you
257 can’t know the next sequential instr 245 can’t know the next sequential instruction after an unconditional branch unless
258 you calculate that based on its length 246 you calculate that based on its length.
259 247
260 brstackdisasm acts like brstackinsn, b <<
261 perf is built with the capstone librar <<
262 <<
263 The brstackoff field will print an off 248 The brstackoff field will print an offset into a specific dso/binary.
264 249
265 With the metric option perf script can 250 With the metric option perf script can compute metrics for
266 sampling periods, similar to perf stat 251 sampling periods, similar to perf stat. This requires
267 specifying a group with multiple event 252 specifying a group with multiple events defining metrics with the :S option
268 for perf record. perf will sample on t 253 for perf record. perf will sample on the first event, and
269 print computed metrics for all the eve 254 print computed metrics for all the events in the group. Please note
270 that the metric computed is averaged o 255 that the metric computed is averaged over the whole sampling
271 period (since the last sample), not ju 256 period (since the last sample), not just for the sample point.
272 257
273 For sample events it's possible to dis 258 For sample events it's possible to display misc field with -F +misc option,
274 following letters are displayed for ea 259 following letters are displayed for each bit:
275 260
276 PERF_RECORD_MISC_KERNEL 261 PERF_RECORD_MISC_KERNEL K
277 PERF_RECORD_MISC_USER 262 PERF_RECORD_MISC_USER U
278 PERF_RECORD_MISC_HYPERVISOR 263 PERF_RECORD_MISC_HYPERVISOR H
279 PERF_RECORD_MISC_GUEST_KERNEL 264 PERF_RECORD_MISC_GUEST_KERNEL G
280 PERF_RECORD_MISC_GUEST_USER 265 PERF_RECORD_MISC_GUEST_USER g
281 PERF_RECORD_MISC_MMAP_DATA* 266 PERF_RECORD_MISC_MMAP_DATA* M
282 PERF_RECORD_MISC_COMM_EXEC 267 PERF_RECORD_MISC_COMM_EXEC E
283 PERF_RECORD_MISC_SWITCH_OUT 268 PERF_RECORD_MISC_SWITCH_OUT S
284 PERF_RECORD_MISC_SWITCH_OUT_PREEMPT 269 PERF_RECORD_MISC_SWITCH_OUT_PREEMPT Sp
285 270
286 $ perf script -F +misc ... 271 $ perf script -F +misc ...
287 sched-messaging 1414 K 28690.6 272 sched-messaging 1414 K 28690.636582: 4590 cycles ...
288 sched-messaging 1407 U 28690.6 273 sched-messaging 1407 U 28690.636600: 325620 cycles ...
289 sched-messaging 1414 K 28690.6 274 sched-messaging 1414 K 28690.636608: 19473 cycles ...
290 misc field ___________/ 275 misc field ___________/
291 276
292 -k:: 277 -k::
293 --vmlinux=<file>:: 278 --vmlinux=<file>::
294 vmlinux pathname 279 vmlinux pathname
295 280
296 --kallsyms=<file>:: 281 --kallsyms=<file>::
297 kallsyms pathname 282 kallsyms pathname
298 283
299 --symfs=<directory>:: 284 --symfs=<directory>::
300 Look for files with symbols relative t 285 Look for files with symbols relative to this directory.
301 286
302 -G:: 287 -G::
303 --hide-call-graph:: 288 --hide-call-graph::
304 When printing symbols do not display c 289 When printing symbols do not display call chain.
305 290
306 --stop-bt:: 291 --stop-bt::
307 Stop display of callgraph at these sym 292 Stop display of callgraph at these symbols
308 293
309 -C:: 294 -C::
310 --cpu:: Only report samples for the list of CP 295 --cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can
311 be provided as a comma-separated list 296 be provided as a comma-separated list with no space: 0,1. Ranges of
312 CPUs are specified with -: 0-2. Defaul 297 CPUs are specified with -: 0-2. Default is to report samples on all
313 CPUs. 298 CPUs.
314 299
315 -c:: 300 -c::
316 --comms=:: 301 --comms=::
317 Only display events for these comms. C 302 Only display events for these comms. CSV that understands
318 file://filename entries. 303 file://filename entries.
319 304
320 --pid=:: 305 --pid=::
321 Only show events for given process ID 306 Only show events for given process ID (comma separated list).
322 307
323 --tid=:: 308 --tid=::
324 Only show events for given thread ID ( 309 Only show events for given thread ID (comma separated list).
325 310
326 -I:: 311 -I::
327 --show-info:: 312 --show-info::
328 Display extended information about the 313 Display extended information about the perf.data file. This adds
329 information which may be very large an 314 information which may be very large and thus may clutter the display.
330 It currently includes: cpu and numa to 315 It currently includes: cpu and numa topology of the host system.
331 It can only be used with the perf scri 316 It can only be used with the perf script report mode.
332 317
333 --show-kernel-path:: 318 --show-kernel-path::
334 Try to resolve the path of [kernel.kal 319 Try to resolve the path of [kernel.kallsyms]
335 320
336 --show-task-events 321 --show-task-events
337 Display task related events (e.g. FORK 322 Display task related events (e.g. FORK, COMM, EXIT).
338 323
339 --show-mmap-events 324 --show-mmap-events
340 Display mmap related events (e.g. MMAP 325 Display mmap related events (e.g. MMAP, MMAP2).
341 326
342 --show-namespace-events 327 --show-namespace-events
343 Display namespace events i.e. events o 328 Display namespace events i.e. events of type PERF_RECORD_NAMESPACES.
344 329
345 --show-switch-events 330 --show-switch-events
346 Display context switch events i.e. eve 331 Display context switch events i.e. events of type PERF_RECORD_SWITCH or
347 PERF_RECORD_SWITCH_CPU_WIDE. 332 PERF_RECORD_SWITCH_CPU_WIDE.
348 333
349 --show-lost-events 334 --show-lost-events
350 Display lost events i.e. events of typ 335 Display lost events i.e. events of type PERF_RECORD_LOST.
351 336
352 --show-round-events 337 --show-round-events
353 Display finished round events i.e. eve 338 Display finished round events i.e. events of type PERF_RECORD_FINISHED_ROUND.
354 339
355 --show-bpf-events 340 --show-bpf-events
356 Display bpf events i.e. events of type 341 Display bpf events i.e. events of type PERF_RECORD_KSYMBOL and PERF_RECORD_BPF_EVENT.
357 342
358 --show-cgroup-events 343 --show-cgroup-events
359 Display cgroup events i.e. events of t 344 Display cgroup events i.e. events of type PERF_RECORD_CGROUP.
360 345
361 --show-text-poke-events 346 --show-text-poke-events
362 Display text poke events i.e. events o 347 Display text poke events i.e. events of type PERF_RECORD_TEXT_POKE and
363 PERF_RECORD_KSYMBOL. 348 PERF_RECORD_KSYMBOL.
364 349
365 --demangle:: 350 --demangle::
366 Demangle symbol names to human readabl 351 Demangle symbol names to human readable form. It's enabled by default,
367 disable with --no-demangle. 352 disable with --no-demangle.
368 353
369 --demangle-kernel:: 354 --demangle-kernel::
370 Demangle kernel symbol names to human 355 Demangle kernel symbol names to human readable form (for C++ kernels).
371 356
372 --addr2line=<path>:: <<
373 Path to addr2line binary. <<
374 <<
375 --header 357 --header
376 Show perf.data header. 358 Show perf.data header.
377 359
378 --header-only 360 --header-only
379 Show only perf.data header. 361 Show only perf.data header.
380 362
381 --itrace:: 363 --itrace::
382 Options for decoding instruction traci 364 Options for decoding instruction tracing data. The options are:
383 365
384 include::itrace.txt[] 366 include::itrace.txt[]
385 367
386 To disable decoding entirely, use --no 368 To disable decoding entirely, use --no-itrace.
387 369
388 --full-source-path:: 370 --full-source-path::
389 Show the full path for source files fo 371 Show the full path for source files for srcline output.
390 372
391 --max-stack:: 373 --max-stack::
392 Set the stack depth limit when parsing 374 Set the stack depth limit when parsing the callchain, anything
393 beyond the specified depth will be ign 375 beyond the specified depth will be ignored. This is a trade-off
394 between information loss and faster pr 376 between information loss and faster processing especially for
395 workloads that can have a very long ca 377 workloads that can have a very long callchain stack.
396 Note that when using the --itrace opti 378 Note that when using the --itrace option the synthesized callchain size
397 will override this value if the synthe 379 will override this value if the synthesized callchain size is bigger.
398 380
399 Default: 127 381 Default: 127
400 382
401 --ns:: 383 --ns::
402 Use 9 decimal places when displaying t 384 Use 9 decimal places when displaying time (i.e. show the nanoseconds)
403 385
404 -f:: 386 -f::
405 --force:: 387 --force::
406 Don't do ownership validation. 388 Don't do ownership validation.
407 389
408 --time:: 390 --time::
409 Only analyze samples within given time 391 Only analyze samples within given time window: <start>,<stop>. Times
410 have the format seconds.nanoseconds. I 392 have the format seconds.nanoseconds. If start is not given (i.e. time
411 string is ',x.y') then analysis starts 393 string is ',x.y') then analysis starts at the beginning of the file. If
412 stop time is not given (i.e. time stri 394 stop time is not given (i.e. time string is 'x.y,') then analysis goes
413 to end of file. Multiple ranges can be 395 to end of file. Multiple ranges can be separated by spaces, which
414 requires the argument to be quoted e.g 396 requires the argument to be quoted e.g. --time "1234.567,1234.789 1235,"
415 397
416 Also support time percent with multipl 398 Also support time percent with multiple time ranges. Time string is
417 'a%/n,b%/m,...' or 'a%-b%,c%-%d,...'. 399 'a%/n,b%/m,...' or 'a%-b%,c%-%d,...'.
418 400
419 For example: 401 For example:
420 Select the second 10% time slice: 402 Select the second 10% time slice:
421 perf script --time 10%/2 403 perf script --time 10%/2
422 404
423 Select from 0% to 10% time slice: 405 Select from 0% to 10% time slice:
424 perf script --time 0%-10% 406 perf script --time 0%-10%
425 407
426 Select the first and second 10% time s 408 Select the first and second 10% time slices:
427 perf script --time 10%/1,10%/2 409 perf script --time 10%/1,10%/2
428 410
429 Select from 0% to 10% and 30% to 40% s 411 Select from 0% to 10% and 30% to 40% slices:
430 perf script --time 0%-10%,30%-40% 412 perf script --time 0%-10%,30%-40%
431 413
432 --max-blocks:: 414 --max-blocks::
433 Set the maximum number of program bloc 415 Set the maximum number of program blocks to print with brstackinsn for
434 each sample. 416 each sample.
435 417
436 --reltime:: 418 --reltime::
437 Print time stamps relative to trace st 419 Print time stamps relative to trace start.
438 420
439 --deltatime:: 421 --deltatime::
440 Print time stamps relative to previous 422 Print time stamps relative to previous event.
441 423
442 --per-event-dump:: 424 --per-event-dump::
443 Create per event files with a "perf.da 425 Create per event files with a "perf.data.EVENT.dump" name instead of
444 printing to stdout, useful, for instan 426 printing to stdout, useful, for instance, for generating flamegraphs.
445 427
446 --inline:: 428 --inline::
447 If a callgraph address belongs to an i 429 If a callgraph address belongs to an inlined function, the inline stack
448 will be printed. Each entry has functi 430 will be printed. Each entry has function name and file/line. Enabled by
449 default, disable with --no-inline. 431 default, disable with --no-inline.
450 432
451 --insn-trace[=<raw|disasm>]:: !! 433 --insn-trace::
452 Show instruction stream in bytes (raw) !! 434 Show instruction stream for intel_pt traces. Combine with --xed to
453 for intel_pt traces. The default is 'r !! 435 show disassembly.
454 'raw' with --xed to show disassembly d <<
455 436
456 --xed:: 437 --xed::
457 Run xed disassembler on output. Requir 438 Run xed disassembler on output. Requires installing the xed disassembler.
458 439
459 -S:: 440 -S::
460 --symbols=symbol[,symbol...]:: 441 --symbols=symbol[,symbol...]::
461 Only consider the listed symbols. Symb 442 Only consider the listed symbols. Symbols are typically a name
462 but they may also be hexadecimal addre 443 but they may also be hexadecimal address.
463 444
464 The hexadecimal address may be the sta 445 The hexadecimal address may be the start address of a symbol or
465 any other address to filter the trace 446 any other address to filter the trace records
466 447
467 For example, to select the symbol nopl 448 For example, to select the symbol noploop or the address 0x4007a0:
468 perf script --symbols=noploop,0x4007a0 449 perf script --symbols=noploop,0x4007a0
469 450
470 Support filtering trace records by sym 451 Support filtering trace records by symbol name, start address of
471 symbol, any hexadecimal address and ad 452 symbol, any hexadecimal address and address range.
472 453
473 The comparison order is: 454 The comparison order is:
474 455
475 1. symbol name comparison 456 1. symbol name comparison
476 2. symbol start address comparison. 457 2. symbol start address comparison.
477 3. any hexadecimal address comparison. 458 3. any hexadecimal address comparison.
478 4. address range comparison (see --add 459 4. address range comparison (see --addr-range).
479 460
480 --addr-range:: 461 --addr-range::
481 Use with -S or --symbols to list traced 462 Use with -S or --symbols to list traced records within address range.
482 463
483 For example, to list the traced records 464 For example, to list the traced records within the address range
484 [0x4007a0, 0x0x4007a9]: 465 [0x4007a0, 0x0x4007a9]:
485 perf script -S 0x4007a0 --addr-range 10 466 perf script -S 0x4007a0 --addr-range 10
486 467
487 --dsos=:: 468 --dsos=::
488 Only consider symbols in these DSOs. 469 Only consider symbols in these DSOs.
489 470
490 --call-trace:: 471 --call-trace::
491 Show call stream for intel_pt traces. 472 Show call stream for intel_pt traces. The CPUs are interleaved, but
492 can be filtered with -C. 473 can be filtered with -C.
493 474
494 --call-ret-trace:: 475 --call-ret-trace::
495 Show call and return stream for intel_ 476 Show call and return stream for intel_pt traces.
496 477
497 --graph-function:: 478 --graph-function::
498 For itrace only show specified functio 479 For itrace only show specified functions and their callees for
499 itrace. Multiple functions can be sepa 480 itrace. Multiple functions can be separated by comma.
500 481
501 --switch-on EVENT_NAME:: 482 --switch-on EVENT_NAME::
502 Only consider events after this event 483 Only consider events after this event is found.
503 484
504 --switch-off EVENT_NAME:: 485 --switch-off EVENT_NAME::
505 Stop considering events after this eve 486 Stop considering events after this event is found.
506 487
507 --show-on-off-events:: 488 --show-on-off-events::
508 Show the --switch-on/off events too. 489 Show the --switch-on/off events too.
509 490
510 --stitch-lbr:: 491 --stitch-lbr::
511 Show callgraph with stitched LBRs, whi 492 Show callgraph with stitched LBRs, which may have more complete
512 callgraph. The perf.data file must hav 493 callgraph. The perf.data file must have been obtained using
513 perf record --call-graph lbr. 494 perf record --call-graph lbr.
514 Disabled by default. In common cases w 495 Disabled by default. In common cases with call stack overflows,
515 it can recreate better call stacks tha 496 it can recreate better call stacks than the default lbr call stack
516 output. But this approach is not foolp !! 497 output. But this approach is not full proof. There can be cases
517 where it creates incorrect call stacks 498 where it creates incorrect call stacks from incorrect matches.
518 The known limitations include exceptio 499 The known limitations include exception handing such as
519 setjmp/longjmp will have calls/returns 500 setjmp/longjmp will have calls/returns not match.
520 501
521 :GMEXAMPLECMD: script !! 502 --guest-code::
522 :GMEXAMPLESUBCMD: !! 503 Indicate that guest code can be found in the hypervisor process,
523 include::guest-files.txt[] !! 504 which is a common case for KVM test programs.
524 505
525 SEE ALSO 506 SEE ALSO
526 -------- 507 --------
527 linkperf:perf-record[1], linkperf:perf-script- 508 linkperf:perf-record[1], linkperf:perf-script-perl[1],
528 linkperf:perf-script-python[1], linkperf:perf- 509 linkperf:perf-script-python[1], linkperf:perf-intel-pt[1],
529 linkperf:perf-dlfilter[1] 510 linkperf:perf-dlfilter[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.