projects/linux·blob master · refs

548 lines · 19.4 KiB

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