Commit | Line | Data |
---|---|---|
133dc4c3 | 1 | perf-script(1) |
4778e0e8 | 2 | ============= |
0a02ad93 IM |
3 | |
4 | NAME | |
5 | ---- | |
133dc4c3 | 6 | perf-script - Read perf.data (created by perf record) and display trace output |
0a02ad93 IM |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
10 | [verse] | |
133dc4c3 IM |
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] | |
0a02ad93 IM |
16 | |
17 | DESCRIPTION | |
18 | ----------- | |
19 | This command reads the input file and displays the trace recorded. | |
20 | ||
133dc4c3 | 21 | There are several variants of perf script: |
a6005123 | 22 | |
133dc4c3 | 23 | 'perf script' to see a detailed trace of the workload that was |
a6005123 TZ |
24 | recorded. |
25 | ||
cff68e58 TZ |
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 | |
133dc4c3 | 28 | available via 'perf script -l'). The following variants allow you to |
cff68e58 TZ |
29 | record and run those scripts: |
30 | ||
133dc4c3 IM |
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 | |
d3c4f798 TZ |
34 | language extension. If <command> is not specified, the events are |
35 | recorded using the -a (system-wide) 'perf record' option. | |
a6005123 | 36 | |
133dc4c3 | 37 | 'perf script report <script> [args]' to run and display the results |
d3c4f798 | 38 | of <script>. <script> is the name displayed in the output of 'perf |
5c64f99b | 39 | script --list' i.e. the actual script name minus any language |
133dc4c3 | 40 | extension. The perf.data output from a previous run of 'perf script |
a6005123 | 41 | record <script>' is used and should be present for this command to |
d3c4f798 TZ |
42 | succeed. [args] refers to the (mainly optional) args expected by |
43 | the script. | |
44 | ||
133dc4c3 | 45 | 'perf script <script> <required-script-args> <command>' to both |
d3c4f798 TZ |
46 | record the events required for <script> and to run the <script> |
47 | using 'live-mode' i.e. without writing anything to disk. <script> | |
133dc4c3 | 48 | is the name displayed in the output of 'perf script --list' i.e. the |
d3c4f798 TZ |
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 | |
133dc4c3 IM |
54 | desired, they can be specified using separate 'perf script record' |
55 | and 'perf script report' commands, with the stdout of the record step | |
d3c4f798 TZ |
56 | piped to the stdin of the report script, using the '-o -' and '-i -' |
57 | options of the corresponding commands. | |
58 | ||
133dc4c3 | 59 | 'perf script <top-script>' to both record the events required for |
d3c4f798 TZ |
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 | |
133dc4c3 | 62 | displayed in the output of 'perf script --list' i.e. the actual |
d3c4f798 TZ |
63 | script name minus any language extension; a <top-script> is defined |
64 | as any script name ending with the string 'top'. | |
65 | ||
133dc4c3 | 66 | [<record-options>] can be passed to the record steps of 'perf script |
d3c4f798 | 67 | record' and 'live-mode' variants; this isn't possible however for |
133dc4c3 | 68 | <top-script> 'live-mode' or 'perf script report' variants. |
a6005123 | 69 | |
cff68e58 TZ |
70 | See the 'SEE ALSO' section for links to language-specific |
71 | information on how to write and run your own trace scripts. | |
72 | ||
0a02ad93 IM |
73 | OPTIONS |
74 | ------- | |
d3c4f798 TZ |
75 | <command>...:: |
76 | Any command you can specify in a shell. | |
77 | ||
0a02ad93 | 78 | -D:: |
5c64f99b | 79 | --dump-raw-trace=:: |
0a02ad93 IM |
80 | Display verbose dump of the trace data. |
81 | ||
a6005123 TZ |
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 | ||
f526d68b | 90 | -s ['lang']:: |
89fbf0b8 TZ |
91 | --script=:: |
92 | Process trace data with the given script ([lang]:script[.ext]). | |
f526d68b TZ |
93 | If the string 'lang' is specified in place of a script name, a |
94 | list of supported languages will be displayed instead. | |
89fbf0b8 TZ |
95 | |
96 | -g:: | |
97 | --gen-script=:: | |
133dc4c3 | 98 | Generate perf-script.[ext] starter script for given language, |
89fbf0b8 TZ |
99 | using current perf.data. |
100 | ||
d3c4f798 TZ |
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 | ||
646420f1 SB |
107 | -i:: |
108 | --input=:: | |
efad1415 | 109 | Input file name. (default: perf.data unless stdin is a fifo) |
646420f1 SB |
110 | |
111 | -d:: | |
112 | --debug-mode:: | |
113 | Do various checks like samples ordering and lost events. | |
d3c4f798 | 114 | |
dc323ce8 | 115 | -F:: |
176fcc5c | 116 | --fields:: |
745f43e3 | 117 | Comma separated list of fields to print. Options are: |
400ea6d3 | 118 | comm, tid, pid, time, cpu, event, trace, ip, sym, dso, addr, symoff, |
48d02a1d | 119 | srcline, period, iregs, brstack, brstacksym, flags, bpf-output, brstackinsn, |
224e2c97 | 120 | callindent, insn, insnlen. Field list can be prepended with the type, trace, sw or hw, |
1424dc96 | 121 | to indicate to which event type the field list applies. |
cbb0bba9 | 122 | e.g., -F sw:comm,tid,time,ip,sym and -F trace:time,cpu,trace |
c0230b2b | 123 | |
cbb0bba9 | 124 | perf script -F <fields> |
176fcc5c ACM |
125 | |
126 | is equivalent to: | |
127 | ||
cbb0bba9 | 128 | perf script -F trace:<fields> -F sw:<fields> -F hw:<fields> |
48000a1a | 129 | |
176fcc5c ACM |
130 | i.e., the specified fields apply to all event types if the type string |
131 | is not given. | |
48000a1a | 132 | |
176fcc5c ACM |
133 | The arguments are processed in the order received. A later usage can |
134 | reset a prior request. e.g.: | |
48000a1a | 135 | |
cbb0bba9 | 136 | -F trace: -F comm,tid,time,ip,sym |
48000a1a | 137 | |
cbb0bba9 | 138 | The first -F suppresses trace events (field list is ""), but then the |
787bef17 | 139 | second invocation sets the fields to comm,tid,time,ip,sym. In this case a |
176fcc5c | 140 | warning is given to the user: |
48000a1a | 141 | |
176fcc5c | 142 | "Overriding previous field request for all events." |
48000a1a | 143 | |
96355f2c | 144 | Alternatively, consider the order: |
48000a1a | 145 | |
cbb0bba9 | 146 | -F comm,tid,time,ip,sym -F trace: |
48000a1a | 147 | |
cbb0bba9 | 148 | The first -F sets the fields for all events and the second -F |
176fcc5c ACM |
149 | suppresses trace events. The user is given a warning message about |
150 | the override, and the result of the above is that only S/W and H/W | |
151 | events are displayed with the given fields. | |
48000a1a | 152 | |
176fcc5c ACM |
153 | For the 'wildcard' option if a user selected field is invalid for an |
154 | event type, a message is displayed to the user that the option is | |
155 | ignored for that type. For example: | |
48000a1a | 156 | |
cbb0bba9 | 157 | $ perf script -F comm,tid,trace |
176fcc5c ACM |
158 | 'trace' not valid for hardware events. Ignoring. |
159 | 'trace' not valid for software events. Ignoring. | |
48000a1a | 160 | |
176fcc5c ACM |
161 | Alternatively, if the type is given an invalid field is specified it |
162 | is an error. For example: | |
48000a1a | 163 | |
cbb0bba9 | 164 | perf script -v -F sw:comm,tid,trace |
176fcc5c | 165 | 'trace' not valid for software events. |
48000a1a | 166 | |
176fcc5c | 167 | At this point usage is displayed, and perf-script exits. |
48000a1a | 168 | |
400ea6d3 AH |
169 | The flags field is synthesized and may have a value when Instruction |
170 | Trace decoding. The flags are "bcrosyiABEx" which stand for branch, | |
171 | call, return, conditional, system, asynchronous, interrupt, | |
172 | transaction abort, trace begin, trace end, and in transaction, | |
055cd33d AH |
173 | respectively. Known combinations of flags are printed more nicely e.g. |
174 | "call" for "bc", "return" for "br", "jcc" for "bo", "jmp" for "b", | |
175 | "int" for "bci", "iret" for "bri", "syscall" for "bcs", "sysret" for "brs", | |
176 | "async" for "by", "hw int" for "bcyi", "tx abrt" for "bA", "tr strt" for "bB", | |
177 | "tr end" for "bE". However the "x" flag will be display separately in those | |
178 | cases e.g. "jcc (x)" for a condition branch within a transaction. | |
400ea6d3 | 179 | |
e216708d AH |
180 | The callindent field is synthesized and may have a value when |
181 | Instruction Trace decoding. For calls and returns, it will display the | |
182 | name of the symbol indented with spaces to reflect the stack depth. | |
183 | ||
224e2c97 AK |
184 | When doing instruction trace decoding insn and insnlen give the |
185 | instruction bytes and the instruction length of the current | |
186 | instruction. | |
187 | ||
176fcc5c | 188 | Finally, a user may not set fields to none for all event types. |
cbb0bba9 | 189 | i.e., -F "" is not allowed. |
176fcc5c | 190 | |
dc323ce8 | 191 | The brstack output includes branch related information with raw addresses using the |
48d02a1d | 192 | /v/v/v/v/cycles syntax in the following order: |
dc323ce8 SE |
193 | FROM: branch source instruction |
194 | TO : branch target instruction | |
195 | M/P/-: M=branch target mispredicted or branch direction was mispredicted, P=target predicted or direction predicted, -=not supported | |
196 | X/- : X=branch inside a transactional region, -=not in transaction region or not supported | |
197 | A/- : A=TSX abort entry, -=not aborted region or not supported | |
48d02a1d | 198 | cycles |
dc323ce8 SE |
199 | |
200 | The brstacksym is identical to brstack, except that the FROM and TO addresses are printed in a symbolic form if possible. | |
201 | ||
48d02a1d AK |
202 | When brstackinsn is specified the full assembler sequences of branch sequences for each sample |
203 | is printed. This is the full execution path leading to the sample. This is only supported when the | |
204 | sample was recorded with perf record -b or -j any. | |
205 | ||
c0230b2b DA |
206 | -k:: |
207 | --vmlinux=<file>:: | |
208 | vmlinux pathname | |
209 | ||
210 | --kallsyms=<file>:: | |
211 | kallsyms pathname | |
212 | ||
213 | --symfs=<directory>:: | |
214 | Look for files with symbols relative to this directory. | |
215 | ||
216 | -G:: | |
217 | --hide-call-graph:: | |
218 | When printing symbols do not display call chain. | |
745f43e3 | 219 | |
64eff7d9 DA |
220 | --stop-bt:: |
221 | Stop display of callgraph at these symbols | |
222 | ||
c8e66720 | 223 | -C:: |
5d67be97 AB |
224 | --cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can |
225 | be provided as a comma-separated list with no space: 0,1. Ranges of | |
226 | CPUs are specified with -: 0-2. Default is to report samples on all | |
227 | CPUs. | |
228 | ||
e7984b7b DA |
229 | -c:: |
230 | --comms=:: | |
231 | Only display events for these comms. CSV that understands | |
232 | file://filename entries. | |
233 | ||
e03eaa40 DA |
234 | --pid=:: |
235 | Only show events for given process ID (comma separated list). | |
236 | ||
237 | --tid=:: | |
238 | Only show events for given thread ID (comma separated list). | |
239 | ||
fbe96f29 SE |
240 | -I:: |
241 | --show-info:: | |
242 | Display extended information about the perf.data file. This adds | |
243 | information which may be very large and thus may clutter the display. | |
244 | It currently includes: cpu and numa topology of the host system. | |
245 | It can only be used with the perf script report mode. | |
246 | ||
0bc8d205 AN |
247 | --show-kernel-path:: |
248 | Try to resolve the path of [kernel.kallsyms] | |
249 | ||
ad7ebb9a NK |
250 | --show-task-events |
251 | Display task related events (e.g. FORK, COMM, EXIT). | |
252 | ||
ba1ddf42 NK |
253 | --show-mmap-events |
254 | Display mmap related events (e.g. MMAP, MMAP2). | |
255 | ||
96a44bbc HB |
256 | --show-namespace-events |
257 | Display namespace events i.e. events of type PERF_RECORD_NAMESPACES. | |
258 | ||
7c14898b AH |
259 | --show-switch-events |
260 | Display context switch events i.e. events of type PERF_RECORD_SWITCH or | |
261 | PERF_RECORD_SWITCH_CPU_WIDE. | |
262 | ||
77e0070d MD |
263 | --demangle:: |
264 | Demangle symbol names to human readable form. It's enabled by default, | |
265 | disable with --no-demangle. | |
266 | ||
267 | --demangle-kernel:: | |
268 | Demangle kernel symbol names to human readable form (for C++ kernels). | |
269 | ||
e90debdd JO |
270 | --header |
271 | Show perf.data header. | |
272 | ||
273 | --header-only | |
274 | Show only perf.data header. | |
275 | ||
7a680eb9 AH |
276 | --itrace:: |
277 | Options for decoding instruction tracing data. The options are: | |
278 | ||
60b88d87 | 279 | include::itrace.txt[] |
7a680eb9 AH |
280 | |
281 | To disable decoding entirely, use --no-itrace. | |
282 | ||
a9710ba0 AK |
283 | --full-source-path:: |
284 | Show the full path for source files for srcline output. | |
285 | ||
6125cc8d ACM |
286 | --max-stack:: |
287 | Set the stack depth limit when parsing the callchain, anything | |
288 | beyond the specified depth will be ignored. This is a trade-off | |
289 | between information loss and faster processing especially for | |
290 | workloads that can have a very long callchain stack. | |
291 | Note that when using the --itrace option the synthesized callchain size | |
292 | will override this value if the synthesized callchain size is bigger. | |
293 | ||
fe176085 | 294 | Default: 127 |
6125cc8d | 295 | |
83e19860 AH |
296 | --ns:: |
297 | Use 9 decimal places when displaying time (i.e. show the nanoseconds) | |
298 | ||
e0be62cc JO |
299 | -f:: |
300 | --force:: | |
301 | Don't do ownership validation. | |
302 | ||
a91f4c47 DA |
303 | --time:: |
304 | Only analyze samples within given time window: <start>,<stop>. Times | |
305 | have the format seconds.microseconds. If start is not given (i.e., time | |
306 | string is ',x.y') then analysis starts at the beginning of the file. If | |
307 | stop time is not given (i.e, time string is 'x.y,') then analysis goes | |
308 | to end of file. | |
309 | ||
48d02a1d AK |
310 | --max-blocks:: |
311 | Set the maximum number of program blocks to print with brstackasm for | |
312 | each sample. | |
313 | ||
0a02ad93 IM |
314 | SEE ALSO |
315 | -------- | |
133dc4c3 IM |
316 | linkperf:perf-record[1], linkperf:perf-script-perl[1], |
317 | linkperf:perf-script-python[1] |