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 trace --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-script=:: 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, flags. 120 Field list can be prepended with the type, trace, sw or hw, 121 to indicate to which event type the field list applies. 122 e.g., -f sw:comm,tid,time,ip,sym and -f trace:time,cpu,trace 123 124 perf script -f <fields> 125 126 is equivalent to: 127 128 perf script -f trace:<fields> -f sw:<fields> -f hw:<fields> 129 130 i.e., the specified fields apply to all event types if the type string 131 is not given. 132 133 The arguments are processed in the order received. A later usage can 134 reset a prior request. e.g.: 135 136 -f trace: -f comm,tid,time,ip,sym 137 138 The first -f suppresses trace events (field list is ""), but then the 139 second invocation sets the fields to comm,tid,time,ip,sym. In this case a 140 warning is given to the user: 141 142 "Overriding previous field request for all events." 143 144 Alternatively, consider the order: 145 146 -f comm,tid,time,ip,sym -f trace: 147 148 The first -f sets the fields for all events and the second -f 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. 152 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: 156 157 $ perf script -f comm,tid,trace 158 'trace' not valid for hardware events. Ignoring. 159 'trace' not valid for software events. Ignoring. 160 161 Alternatively, if the type is given an invalid field is specified it 162 is an error. For example: 163 164 perf script -v -f sw:comm,tid,trace 165 'trace' not valid for software events. 166 167 At this point usage is displayed, and perf-script exits. 168 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, 173 respectively. 174 175 Finally, a user may not set fields to none for all event types. 176 i.e., -f "" is not allowed. 177 178-k:: 179--vmlinux=<file>:: 180 vmlinux pathname 181 182--kallsyms=<file>:: 183 kallsyms pathname 184 185--symfs=<directory>:: 186 Look for files with symbols relative to this directory. 187 188-G:: 189--hide-call-graph:: 190 When printing symbols do not display call chain. 191 192-C:: 193--cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can 194 be provided as a comma-separated list with no space: 0,1. Ranges of 195 CPUs are specified with -: 0-2. Default is to report samples on all 196 CPUs. 197 198-c:: 199--comms=:: 200 Only display events for these comms. CSV that understands 201 file://filename entries. 202 203--pid=:: 204 Only show events for given process ID (comma separated list). 205 206--tid=:: 207 Only show events for given thread ID (comma separated list). 208 209-I:: 210--show-info:: 211 Display extended information about the perf.data file. This adds 212 information which may be very large and thus may clutter the display. 213 It currently includes: cpu and numa topology of the host system. 214 It can only be used with the perf script report mode. 215 216--show-kernel-path:: 217 Try to resolve the path of [kernel.kallsyms] 218 219--show-task-events 220 Display task related events (e.g. FORK, COMM, EXIT). 221 222--show-mmap-events 223 Display mmap related events (e.g. MMAP, MMAP2). 224 225--show-switch-events 226 Display context switch events i.e. events of type PERF_RECORD_SWITCH or 227 PERF_RECORD_SWITCH_CPU_WIDE. 228 229--demangle:: 230 Demangle symbol names to human readable form. It's enabled by default, 231 disable with --no-demangle. 232 233--demangle-kernel:: 234 Demangle kernel symbol names to human readable form (for C++ kernels). 235 236--header 237 Show perf.data header. 238 239--header-only 240 Show only perf.data header. 241 242--itrace:: 243 Options for decoding instruction tracing data. The options are: 244 245include::itrace.txt[] 246 247 To disable decoding entirely, use --no-itrace. 248 249--full-source-path:: 250 Show the full path for source files for srcline output. 251 252SEE ALSO 253-------- 254linkperf:perf-record[1], linkperf:perf-script-perl[1], 255linkperf:perf-script-python[1] 256