perf/Documentation/perf-script.txt

1 perf-script(1)
6 perf-script - Read perf.data (created by perf record) and display trace output
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]
21 There are several variants of perf script:
23   'perf script' to see a detailed trace of the workload that was
28   available via 'perf script -l').  The following variants allow you to
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
35   recorded using the -a (system-wide) 'perf record' option.
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
40   extension.  The perf.data output from a previous run of 'perf script
45   'perf script <script> <required-script-args> <command>' to both
48   is the name displayed in the output of 'perf script --list' i.e. the
51   'perf record' option.  If <script> has any required args, they
54   desired, they can be specified using separate 'perf script record'
55   and 'perf script report' commands, with the stdout of the record step
59   'perf script <top-script>' to both record the events required for
62   displayed in the output of 'perf script --list' i.e. the actual
66   [<record-options>] can be passed to the record steps of 'perf script
68   <top-script> 'live-mode' or 'perf script report' variants.
98         Generate perf-script.[ext] starter script for given language,
99         using current perf.data.
109         Input file name. (default: perf.data unless stdin is a fifo)
125 		perf script -F <fields>
129 		perf script -F trace:<fields> -F sw:<fields> -F hw:<fields>
172 		$ perf script -F comm,tid,trace
179         perf script -v -F sw:comm,tid,trace
182 	At this point usage is displayed, and perf-script exits.
225 	sample was recorded with perf record -b or -j any.
229 	With the metric option perf script can compute metrics for
230 	sampling periods, similar to perf stat. This requires
232 	for perf record. perf will sample on the first event, and
250 	  $ perf script -F +misc ...
292 	Display extended information about the perf.data file. This adds
295 	It can only be used with the perf script report mode.
337 	Show perf.data header.
340 	Show only perf.data header.
382 	perf script --time 10%/2
385 	perf script --time 0%-10%
388 	perf script --time 10%/1,10%/2
391 	perf script --time 0%-10%,30%-40%
404 	Create per event files with a "perf.data.EVENT.dump" name instead of
425 	perf script --symbols=noploop,0x4007a0
449 	callgraph. The perf.data file must have been obtained using
450 	perf record --call-graph lbr.
460 linkperf:perf-record[1], linkperf:perf-script-perl[1],
461 linkperf:perf-script-python[1], linkperf:perf-intel-pt[1]