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-L::
83--Latency=::
84        Show latency attributes (irqs/preemption disabled, etc).
85
86-l::
87--list=::
88        Display a list of available trace scripts.
89
90-s ['lang']::
91--script=::
92        Process trace data with the given script ([lang]:script[.ext]).
93	If the string 'lang' is specified in place of a script name, a
94        list of supported languages will be displayed instead.
95
96-g::
97--gen-script=::
98        Generate perf-script.[ext] starter script for given language,
99        using current perf.data.
100
101-a::
102        Force system-wide collection.  Scripts run without a <command>
103        normally use -a by default, while scripts run with a <command>
104        normally don't - this option allows the latter to be run in
105        system-wide mode.
106
107-i::
108--input=::
109        Input file name. (default: perf.data unless stdin is a fifo)
110
111-d::
112--debug-mode::
113        Do various checks like samples ordering and lost events.
114
115-F::
116--fields::
117        Comma separated list of fields to print. Options are:
118        comm, tid, pid, time, cpu, event, trace, ip, sym, dso, addr, symoff,
119        srcline, period, iregs, uregs, brstack, brstacksym, flags, bpf-output, brstackinsn,
120        brstackoff, callindent, insn, insnlen, synth, phys_addr, metric, misc, srccode, ipc.
121        Field list can be prepended with the type, trace, sw or hw,
122        to indicate to which event type the field list applies.
123        e.g., -F sw:comm,tid,time,ip,sym  and -F trace:time,cpu,trace
124
125		perf script -F <fields>
126
127	is equivalent to:
128
129		perf script -F trace:<fields> -F sw:<fields> -F hw:<fields>
130
131	i.e., the specified fields apply to all event types if the type string
132	is not given.
133
134	In addition to overriding fields, it is also possible to add or remove
135	fields from the defaults. For example
136
137		-F -cpu,+insn
138
139	removes the cpu field and adds the insn field. Adding/removing fields
140	cannot be mixed with normal overriding.
141
142	The arguments are processed in the order received. A later usage can
143	reset a prior request. e.g.:
144
145		-F trace: -F comm,tid,time,ip,sym
146
147	The first -F suppresses trace events (field list is ""), but then the
148	second invocation sets the fields to comm,tid,time,ip,sym. In this case a
149	warning is given to the user:
150
151		"Overriding previous field request for all events."
152
153	Alternatively, consider the order:
154
155		-F comm,tid,time,ip,sym -F trace:
156
157	The first -F sets the fields for all events and the second -F
158	suppresses trace events. The user is given a warning message about
159	the override, and the result of the above is that only S/W and H/W
160	events are displayed with the given fields.
161
162	It's possible tp add/remove fields only for specific event type:
163
164		-Fsw:-cpu,-period
165
166	removes cpu and period from software events.
167
168	For the 'wildcard' option if a user selected field is invalid for an
169	event type, a message is displayed to the user that the option is
170	ignored for that type. For example:
171
172		$ perf script -F comm,tid,trace
173		'trace' not valid for hardware events. Ignoring.
174		'trace' not valid for software events. Ignoring.
175
176	Alternatively, if the type is given an invalid field is specified it
177	is an error. For example:
178
179        perf script -v -F sw:comm,tid,trace
180        'trace' not valid for software events.
181
182	At this point usage is displayed, and perf-script exits.
183
184	The flags field is synthesized and may have a value when Instruction
185	Trace decoding. The flags are "bcrosyiABEx" which stand for branch,
186	call, return, conditional, system, asynchronous, interrupt,
187	transaction abort, trace begin, trace end, and in transaction,
188	respectively. Known combinations of flags are printed more nicely e.g.
189	"call" for "bc", "return" for "br", "jcc" for "bo", "jmp" for "b",
190	"int" for "bci", "iret" for "bri", "syscall" for "bcs", "sysret" for "brs",
191	"async" for "by", "hw int" for "bcyi", "tx abrt" for "bA", "tr strt" for "bB",
192	"tr end" for "bE". However the "x" flag will be display separately in those
193	cases e.g. "jcc     (x)" for a condition branch within a transaction.
194
195	The callindent field is synthesized and may have a value when
196	Instruction Trace decoding. For calls and returns, it will display the
197	name of the symbol indented with spaces to reflect the stack depth.
198
199	When doing instruction trace decoding insn and insnlen give the
200	instruction bytes and the instruction length of the current
201	instruction.
202
203	The synth field is used by synthesized events which may be created when
204	Instruction Trace decoding.
205
206	The ipc (instructions per cycle) field is synthesized and may have a value when
207	Instruction Trace decoding.
208
209	Finally, a user may not set fields to none for all event types.
210	i.e., -F "" is not allowed.
211
212	The brstack output includes branch related information with raw addresses using the
213	/v/v/v/v/cycles syntax in the following order:
214	FROM: branch source instruction
215	TO  : branch target instruction
216        M/P/-: M=branch target mispredicted or branch direction was mispredicted, P=target predicted or direction predicted, -=not supported
217	X/- : X=branch inside a transactional region, -=not in transaction region or not supported
218	A/- : A=TSX abort entry, -=not aborted region or not supported
219	cycles
220
221	The brstacksym is identical to brstack, except that the FROM and TO addresses are printed in a symbolic form if possible.
222
223	When brstackinsn is specified the full assembler sequences of branch sequences for each sample
224	is printed. This is the full execution path leading to the sample. This is only supported when the
225	sample was recorded with perf record -b or -j any.
226
227	The brstackoff field will print an offset into a specific dso/binary.
228
229	With the metric option perf script can compute metrics for
230	sampling periods, similar to perf stat. This requires
231	specifying a group with multiple events defining metrics with the :S option
232	for perf record. perf will sample on the first event, and
233	print computed metrics for all the events in the group. Please note
234	that the metric computed is averaged over the whole sampling
235	period (since the last sample), not just for the sample point.
236
237	For sample events it's possible to display misc field with -F +misc option,
238	following letters are displayed for each bit:
239
240	  PERF_RECORD_MISC_KERNEL               K
241	  PERF_RECORD_MISC_USER                 U
242	  PERF_RECORD_MISC_HYPERVISOR           H
243	  PERF_RECORD_MISC_GUEST_KERNEL         G
244	  PERF_RECORD_MISC_GUEST_USER           g
245	  PERF_RECORD_MISC_MMAP_DATA*           M
246	  PERF_RECORD_MISC_COMM_EXEC            E
247	  PERF_RECORD_MISC_SWITCH_OUT           S
248	  PERF_RECORD_MISC_SWITCH_OUT_PREEMPT   Sp
249
250	  $ perf script -F +misc ...
251	   sched-messaging  1414 K     28690.636582:       4590 cycles ...
252	   sched-messaging  1407 U     28690.636600:     325620 cycles ...
253	   sched-messaging  1414 K     28690.636608:      19473 cycles ...
254	  misc field ___________/
255
256-k::
257--vmlinux=<file>::
258        vmlinux pathname
259
260--kallsyms=<file>::
261        kallsyms pathname
262
263--symfs=<directory>::
264        Look for files with symbols relative to this directory.
265
266-G::
267--hide-call-graph::
268        When printing symbols do not display call chain.
269
270--stop-bt::
271        Stop display of callgraph at these symbols
272
273-C::
274--cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can
275	be provided as a comma-separated list with no space: 0,1. Ranges of
276	CPUs are specified with -: 0-2. Default is to report samples on all
277	CPUs.
278
279-c::
280--comms=::
281	Only display events for these comms. CSV that understands
282	file://filename entries.
283
284--pid=::
285	Only show events for given process ID (comma separated list).
286
287--tid=::
288	Only show events for given thread ID (comma separated list).
289
290-I::
291--show-info::
292	Display extended information about the perf.data file. This adds
293	information which may be very large and thus may clutter the display.
294	It currently includes: cpu and numa topology of the host system.
295	It can only be used with the perf script report mode.
296
297--show-kernel-path::
298	Try to resolve the path of [kernel.kallsyms]
299
300--show-task-events
301	Display task related events (e.g. FORK, COMM, EXIT).
302
303--show-mmap-events
304	Display mmap related events (e.g. MMAP, MMAP2).
305
306--show-namespace-events
307	Display namespace events i.e. events of type PERF_RECORD_NAMESPACES.
308
309--show-switch-events
310	Display context switch events i.e. events of type PERF_RECORD_SWITCH or
311	PERF_RECORD_SWITCH_CPU_WIDE.
312
313--show-lost-events
314	Display lost events i.e. events of type PERF_RECORD_LOST.
315
316--show-round-events
317	Display finished round events i.e. events of type PERF_RECORD_FINISHED_ROUND.
318
319--show-bpf-events
320	Display bpf events i.e. events of type PERF_RECORD_KSYMBOL and PERF_RECORD_BPF_EVENT.
321
322--demangle::
323	Demangle symbol names to human readable form. It's enabled by default,
324	disable with --no-demangle.
325
326--demangle-kernel::
327	Demangle kernel symbol names to human readable form (for C++ kernels).
328
329--header
330	Show perf.data header.
331
332--header-only
333	Show only perf.data header.
334
335--itrace::
336	Options for decoding instruction tracing data. The options are:
337
338include::itrace.txt[]
339
340	To disable decoding entirely, use --no-itrace.
341
342--full-source-path::
343	Show the full path for source files for srcline output.
344
345--max-stack::
346        Set the stack depth limit when parsing the callchain, anything
347        beyond the specified depth will be ignored. This is a trade-off
348        between information loss and faster processing especially for
349        workloads that can have a very long callchain stack.
350        Note that when using the --itrace option the synthesized callchain size
351        will override this value if the synthesized callchain size is bigger.
352
353        Default: 127
354
355--ns::
356	Use 9 decimal places when displaying time (i.e. show the nanoseconds)
357
358-f::
359--force::
360	Don't do ownership validation.
361
362--time::
363	Only analyze samples within given time window: <start>,<stop>. Times
364	have the format seconds.nanoseconds. If start is not given (i.e. time
365	string is ',x.y') then analysis starts at the beginning of the file. If
366	stop time is not given (i.e. time string is 'x.y,') then analysis goes
367	to end of file. Multiple ranges can be separated by spaces, which
368	requires the argument to be quoted e.g. --time "1234.567,1234.789 1235,"
369
370	Also support time percent with multiple time ranges. Time string is
371	'a%/n,b%/m,...' or 'a%-b%,c%-%d,...'.
372
373	For example:
374	Select the second 10% time slice:
375	perf script --time 10%/2
376
377	Select from 0% to 10% time slice:
378	perf script --time 0%-10%
379
380	Select the first and second 10% time slices:
381	perf script --time 10%/1,10%/2
382
383	Select from 0% to 10% and 30% to 40% slices:
384	perf script --time 0%-10%,30%-40%
385
386--max-blocks::
387	Set the maximum number of program blocks to print with brstackinsn for
388	each sample.
389
390--reltime::
391	Print time stamps relative to trace start.
392
393--per-event-dump::
394	Create per event files with a "perf.data.EVENT.dump" name instead of
395        printing to stdout, useful, for instance, for generating flamegraphs.
396
397--inline::
398	If a callgraph address belongs to an inlined function, the inline stack
399	will be printed. Each entry has function name and file/line. Enabled by
400	default, disable with --no-inline.
401
402--insn-trace::
403	Show instruction stream for intel_pt traces. Combine with --xed to
404	show disassembly.
405
406--xed::
407	Run xed disassembler on output. Requires installing the xed disassembler.
408
409--call-trace::
410	Show call stream for intel_pt traces. The CPUs are interleaved, but
411	can be filtered with -C.
412
413--call-ret-trace::
414	Show call and return stream for intel_pt traces.
415
416--graph-function::
417	For itrace only show specified functions and their callees for
418	itrace. Multiple functions can be separated by comma.
419
420SEE ALSO
421--------
422linkperf:perf-record[1], linkperf:perf-script-perl[1],
423linkperf:perf-script-python[1]
424