1PERF-SCRIPT(1) perf Manual PERF-SCRIPT(1)
2
6 perf-script - Read perf.data (created by perf record) and display trace
7 output
8
10 perf script [<options>]
11 perf script [<options>] record <script> [<record-options>] <command>
12 perf script [<options>] report <script> [script-args]
13 perf script [<options>] <script> <required-script-args> [<record-options>] <command>
14 perf script [<options>] <top-script> [script-args]
15
17 This command reads the input file and displays the trace recorded.
18 There are several variants of perf script:
20 'perf script' to see a detailed trace of the workload that was
22 recorded.
23 You can also run a set of pre-canned scripts that aggregate and
25 summarize the raw trace data in various ways (the list of scripts is
26 available via 'perf script -l'). The following variants allow you to
27 record and run those scripts:
28 'perf script record <script> <command>' to record the events required
30 for 'perf script report'. <script> is the name displayed in the
31 output of 'perf script --list' i.e. the actual script name minus any
32 language extension. If <command> is not specified, the events are
33 recorded using the -a (system-wide) 'perf record' option.
34 'perf script report <script> [args]' to run and display the results
36 of <script>. <script> is the name displayed in the output of 'perf
37 script --list' i.e. the actual script name minus any language
38 extension. The perf.data output from a previous run of 'perf script
39 record <script>' is used and should be present for this command to
40 succeed. [args] refers to the (mainly optional) args expected by
41 the script.
42 'perf script <script> <required-script-args> <command>' to both
44 record the events required for <script> and to run the <script>
45 using 'live-mode' i.e. without writing anything to disk. <script>
46 is the name displayed in the output of 'perf script --list' i.e. the
47 actual script name minus any language extension. If <command> is
48 not specified, the events are recorded using the -a (system-wide)
49 'perf record' option. If <script> has any required args, they
50 should be specified before <command>. This mode doesn't allow for
51 optional script args to be specified; if optional script args are
52 desired, they can be specified using separate 'perf script record'
53 and 'perf script report' commands, with the stdout of the record step
54 piped to the stdin of the report script, using the '-o -' and '-i -'
55 options of the corresponding commands.
56 'perf script <top-script>' to both record the events required for
58 <top-script> and to run the <top-script> using 'live-mode'
59 i.e. without writing anything to disk. <top-script> is the name
60 displayed in the output of 'perf script --list' i.e. the actual
61 script name minus any language extension; a <top-script> is defined
62 as any script name ending with the string 'top'.
63 [<record-options>] can be passed to the record steps of 'perf script
65 record' and 'live-mode' variants; this isn't possible however for
66 <top-script> 'live-mode' or 'perf script report' variants.
67 See the 'SEE ALSO' section for links to language-specific
69 information on how to write and run your own trace scripts.
70
72 <command>...
73 Any command you can specify in a shell.
74 -D, --dump-raw-trace=
76 Display verbose dump of the trace data.
77 -L, --Latency=
79 Show latency attributes (irqs/preemption disabled, etc).
80 -l, --list=
82 Display a list of available trace scripts.
83 -s [lang], --script=
85 Process trace data with the given script ([lang]:script[.ext]). If
86 the string lang is specified in place of a script name, a list of
87 supported languages will be displayed instead.
88 -g, --gen-script=
90 Generate perf-script.[ext] starter script for given language, using
91 current perf.data.
92 -a
94 Force system-wide collection. Scripts run without a <command>
95 normally use -a by default, while scripts run with a <command>
96 normally don’t - this option allows the latter to be run in
97 system-wide mode.
98 -i, --input=
100 Input file name. (default: perf.data unless stdin is a fifo)
101 -d, --debug-mode
103 Do various checks like samples ordering and lost events.
104 -F, --fields
106 Comma separated list of fields to print. Options are: comm, tid,
107 pid, time, cpu, event, trace, ip, sym, dso, addr, symoff, srcline,
108 period, iregs, uregs, brstack, brstacksym, flags, bpf-output,
109 brstackinsn, brstackoff, callindent, insn, insnlen, synth,
110 phys_addr, metric, misc, srccode. Field list can be prepended with
111 the type, trace, sw or hw, to indicate to which event type the
112 field list applies. e.g., -F sw:comm,tid,time,ip,sym and -F
113 trace:time,cpu,trace
114 perf script -F <fields>
116 is equivalent to:
118 perf script -F trace:<fields> -F sw:<fields> -F hw:<fields>
120 i.e., the specified fields apply to all event types if the type string
122 is not given.
123 In addition to overriding fields, it is also possible to add or remove
125 fields from the defaults. For example
126 -F -cpu,+insn
128 removes the cpu field and adds the insn field. Adding/removing fields
130 cannot be mixed with normal overriding.
131 The arguments are processed in the order received. A later usage can
133 reset a prior request. e.g.:
134 -F trace: -F comm,tid,time,ip,sym
136 The first -F suppresses trace events (field list is ""), but then the
138 second invocation sets the fields to comm,tid,time,ip,sym. In this case a
139 warning is given to the user:
140 "Overriding previous field request for all events."
142 Alternatively, consider the order:
144 -F comm,tid,time,ip,sym -F trace:
146 The first -F sets the fields for all events and the second -F
148 suppresses trace events. The user is given a warning message about
149 the override, and the result of the above is that only S/W and H/W
150 events are displayed with the given fields.
151 It's possible tp add/remove fields only for specific event type:
153 -Fsw:-cpu,-period
155 removes cpu and period from software events.
157 For the 'wildcard' option if a user selected field is invalid for an
159 event type, a message is displayed to the user that the option is
160 ignored for that type. For example:
161 $ perf script -F comm,tid,trace
163 'trace' not valid for hardware events. Ignoring.
164 'trace' not valid for software events. Ignoring.
165 Alternatively, if the type is given an invalid field is specified it
167 is an error. For example:
168 perf script -v -F sw:comm,tid,trace
170 'trace' not valid for software events.
171 At this point usage is displayed, and perf-script exits.
173 The flags field is synthesized and may have a value when Instruction
175 Trace decoding. The flags are "bcrosyiABEx" which stand for branch,
176 call, return, conditional, system, asynchronous, interrupt,
177 transaction abort, trace begin, trace end, and in transaction,
178 respectively. Known combinations of flags are printed more nicely e.g.
179 "call" for "bc", "return" for "br", "jcc" for "bo", "jmp" for "b",
180 "int" for "bci", "iret" for "bri", "syscall" for "bcs", "sysret" for "brs",
181 "async" for "by", "hw int" for "bcyi", "tx abrt" for "bA", "tr strt" for "bB",
182 "tr end" for "bE". However the "x" flag will be display separately in those
183 cases e.g. "jcc (x)" for a condition branch within a transaction.
184 The callindent field is synthesized and may have a value when
186 Instruction Trace decoding. For calls and returns, it will display the
187 name of the symbol indented with spaces to reflect the stack depth.
188 When doing instruction trace decoding insn and insnlen give the
190 instruction bytes and the instruction length of the current
191 instruction.
192 The synth field is used by synthesized events which may be created when
194 Instruction Trace decoding.
195 Finally, a user may not set fields to none for all event types.
197 i.e., -F "" is not allowed.
198 The brstack output includes branch related information with raw addresses using the
200 /v/v/v/v/cycles syntax in the following order:
201 FROM: branch source instruction
202 TO : branch target instruction
203 M/P/-: M=branch target mispredicted or branch direction was mispredicted, P=target predicted or direction predicted, -=not supported
204 X/- : X=branch inside a transactional region, -=not in transaction region or not supported
205 A/- : A=TSX abort entry, -=not aborted region or not supported
206 cycles
207 The brstacksym is identical to brstack, except that the FROM and TO addresses are printed in a symbolic form if possible.
209 When brstackinsn is specified the full assembler sequences of branch sequences for each sample
211 is printed. This is the full execution path leading to the sample. This is only supported when the
212 sample was recorded with perf record -b or -j any.
213 The brstackoff field will print an offset into a specific dso/binary.
215 With the metric option perf script can compute metrics for
217 sampling periods, similar to perf stat. This requires
218 specifying a group with multiple metrics with the :S option
219 for perf record. perf will sample on the first event, and
220 compute metrics for all the events in the group. Please note
221 that the metric computed is averaged over the whole sampling
222 period, not just for the sample point.
223 For sample events it's possible to display misc field with -F +misc option,
225 following letters are displayed for each bit:
226 PERF_RECORD_MISC_KERNEL K
228 PERF_RECORD_MISC_USER U
229 PERF_RECORD_MISC_HYPERVISOR H
230 PERF_RECORD_MISC_GUEST_KERNEL G
231 PERF_RECORD_MISC_GUEST_USER g
232 PERF_RECORD_MISC_MMAP_DATA* M
233 PERF_RECORD_MISC_COMM_EXEC E
234 PERF_RECORD_MISC_SWITCH_OUT S
235 PERF_RECORD_MISC_SWITCH_OUT_PREEMPT Sp
236 $ perf script -F +misc ...
238 sched-messaging 1414 K 28690.636582: 4590 cycles ...
239 sched-messaging 1407 U 28690.636600: 325620 cycles ...
240 sched-messaging 1414 K 28690.636608: 19473 cycles ...
241 misc field ___________/
242 -k, --vmlinux=<file>
244 vmlinux pathname
245 --kallsyms=<file>
247 kallsyms pathname
248 --symfs=<directory>
250 Look for files with symbols relative to this directory.
251 -G, --hide-call-graph
253 When printing symbols do not display call chain.
254 --stop-bt
256 Stop display of callgraph at these symbols
257 -C, --cpu
259 Only report samples for the list of CPUs provided. Multiple CPUs
260 can be provided as a comma-separated list with no space: 0,1.
261 Ranges of CPUs are specified with -: 0-2. Default is to report
262 samples on all CPUs.
263 -c, --comms=
265 Only display events for these comms. CSV that understands
266 file://filename entries.
267 --pid=
269 Only show events for given process ID (comma separated list).
270 --tid=
272 Only show events for given thread ID (comma separated list).
273 -I, --show-info
275 Display extended information about the perf.data file. This adds
276 information which may be very large and thus may clutter the
277 display. It currently includes: cpu and numa topology of the host
278 system. It can only be used with the perf script report mode.
279 --show-kernel-path
281 Try to resolve the path of [kernel.kallsyms]
282 --show-task-events Display task related events (e.g. FORK, COMM, EXIT).
284 --show-mmap-events Display mmap related events (e.g. MMAP, MMAP2).
286 --show-namespace-events Display namespace events i.e. events of type
288 PERF_RECORD_NAMESPACES.
289 --show-switch-events Display context switch events i.e. events of type
291 PERF_RECORD_SWITCH or PERF_RECORD_SWITCH_CPU_WIDE.
292 --show-lost-events Display lost events i.e. events of type
294 PERF_RECORD_LOST.
295 --show-round-events Display finished round events i.e. events of type
297 PERF_RECORD_FINISHED_ROUND.
298 --demangle
300 Demangle symbol names to human readable form. It’s enabled by
301 default, disable with --no-demangle.
302 --demangle-kernel
304 Demangle kernel symbol names to human readable form (for C++
305 kernels).
306 --header Show perf.data header.
308 --header-only Show only perf.data header.
310 --itrace
312 Options for decoding instruction tracing data. The options are:
313 i synthesize instructions events
315 b synthesize branches events
316 c synthesize branches events (calls only)
317 r synthesize branches events (returns only)
318 x synthesize transactions events
319 w synthesize ptwrite events
320 p synthesize power events
321 e synthesize error events
322 d create a debug log
323 g synthesize a call chain (use with i or x)
324 l synthesize last branch entries (use with i or x)
325 s skip initial number of events
326 The default is all events i.e. the same as --itrace=ibxwpe,
328 except for perf script where it is --itrace=ce
329 In addition, the period (default 100000, except for perf script where it is 1)
331 for instructions events can be specified in units of:
332 i instructions
334 t ticks
335 ms milliseconds
336 us microseconds
337 ns nanoseconds (default)
338 Also the call chain size (default 16, max. 1024) for instructions or
340 transactions events can be specified.
341 Also the number of last branch entries (default 64, max. 1024) for
343 instructions or transactions events can be specified.
344 It is also possible to skip events generated (instructions, branches, transactions,
346 ptwrite, power) at the beginning. This is useful to ignore initialization code.
347 --itrace=i0nss1000000
349 skips the first million instructions.
351 To disable decoding entirely, use --no-itrace.
353 --full-source-path
355 Show the full path for source files for srcline output.
356 --max-stack
358 Set the stack depth limit when parsing the callchain, anything
359 beyond the specified depth will be ignored. This is a trade-off
360 between information loss and faster processing especially for
361 workloads that can have a very long callchain stack. Note that when
362 using the --itrace option the synthesized callchain size will
363 override this value if the synthesized callchain size is bigger.
364 Default: 127
366 --ns
368 Use 9 decimal places when displaying time (i.e. show the
369 nanoseconds)
370 -f, --force
372 Don’t do ownership validation.
373 --time
375 Only analyze samples within given time window: <start>,<stop>.
376 Times have the format seconds.microseconds. If start is not given
377 (i.e., time string is ,x.y) then analysis starts at the beginning
378 of the file. If stop time is not given (i.e, time string is x.y,)
379 then analysis goes to end of file.
380 Also support time percent with multipe time range. Time string is
382 'a%/n,b%/m,...' or 'a%-b%,c%-%d,...'.
383 For example:
385 Select the second 10% time slice:
386 perf script --time 10%/2
387 Select from 0% to 10% time slice:
389 perf script --time 0%-10%
390 Select the first and second 10% time slices:
392 perf script --time 10%/1,10%/2
393 Select from 0% to 10% and 30% to 40% slices:
395 perf script --time 0%-10%,30%-40%
396 --max-blocks
398 Set the maximum number of program blocks to print with brstackasm
399 for each sample.
400 --reltime
402 Print time stamps relative to trace start.
403 --per-event-dump
405 Create per event files with a "perf.data.EVENT.dump" name instead
406 of printing to stdout, useful, for instance, for generating
407 flamegraphs.
408 --inline
410 If a callgraph address belongs to an inlined function, the inline
411 stack will be printed. Each entry has function name and file/line.
412 Enabled by default, disable with --no-inline.
413 --insn-trace
415 Show instruction stream for intel_pt traces. Combine with --xed to
416 show disassembly.
417 --xed
419 Run xed disassembler on output. Requires installing the xed
420 disassembler.
421 --call-trace
423 Show call stream for intel_pt traces. The CPUs are interleaved, but
424 can be filtered with -C.
425 --call-ret-trace
427 Show call and return stream for intel_pt traces.
428 --graph-function
430 For itrace only show specified functions and their callees for
431 itrace. Multiple functions can be separated by comma.
432
434 perf-record(1), perf-script-perl(1), perf-script-python(1)
435perf 06/03/2019 PERF-SCRIPT(1)