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
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
43   the script.
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
51   'perf record' option.  If <script> has any required args, they
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 -'
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'.
66   [<record-options>] can be passed to the record steps of 'perf script
68   <top-script> 'live-mode' or 'perf script report' variants.
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
100 --gen-script=::
101         Generate perf-script.[ext] starter script for given language,
143 		perf script -F <fields>
147 		perf script -F trace:<fields> -F sw:<fields> -F hw:<fields>
190 		$ perf script -F comm,tid,trace
197         perf script -v -F sw:comm,tid,trace
200 	At this point usage is displayed, and perf-script exits.
265 	With the metric option perf script can compute metrics for
286 	  $ perf script -F +misc ...
331 	It can only be used with the perf script report mode.
421 	perf script --time 10%/2
424 	perf script --time 0%-10%
427 	perf script --time 10%/1,10%/2
430 	perf script --time 0%-10%,30%-40%
468 	perf script --symbols=noploop,0x4007a0
485        perf script -S 0x4007a0 --addr-range 10
521 :GMEXAMPLECMD: script
527 linkperf:perf-record[1], linkperf:perf-script-perl[1],
528 linkperf:perf-script-python[1], linkperf:perf-intel-pt[1],