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, brstack, brstacksym, flags, bpf-output, brstackinsn, brstackoff, 120 callindent, insn, insnlen, synth. 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 For the 'wildcard' option if a user selected field is invalid for an 163 event type, a message is displayed to the user that the option is 164 ignored for that type. For example: 165 166 $ perf script -F comm,tid,trace 167 'trace' not valid for hardware events. Ignoring. 168 'trace' not valid for software events. Ignoring. 169 170 Alternatively, if the type is given an invalid field is specified it 171 is an error. For example: 172 173 perf script -v -F sw:comm,tid,trace 174 'trace' not valid for software events. 175 176 At this point usage is displayed, and perf-script exits. 177 178 The flags field is synthesized and may have a value when Instruction 179 Trace decoding. The flags are "bcrosyiABEx" which stand for branch, 180 call, return, conditional, system, asynchronous, interrupt, 181 transaction abort, trace begin, trace end, and in transaction, 182 respectively. Known combinations of flags are printed more nicely e.g. 183 "call" for "bc", "return" for "br", "jcc" for "bo", "jmp" for "b", 184 "int" for "bci", "iret" for "bri", "syscall" for "bcs", "sysret" for "brs", 185 "async" for "by", "hw int" for "bcyi", "tx abrt" for "bA", "tr strt" for "bB", 186 "tr end" for "bE". However the "x" flag will be display separately in those 187 cases e.g. "jcc (x)" for a condition branch within a transaction. 188 189 The callindent field is synthesized and may have a value when 190 Instruction Trace decoding. For calls and returns, it will display the 191 name of the symbol indented with spaces to reflect the stack depth. 192 193 When doing instruction trace decoding insn and insnlen give the 194 instruction bytes and the instruction length of the current 195 instruction. 196 197 The synth field is used by synthesized events which may be created when 198 Instruction Trace decoding. 199 200 Finally, a user may not set fields to none for all event types. 201 i.e., -F "" is not allowed. 202 203 The brstack output includes branch related information with raw addresses using the 204 /v/v/v/v/cycles syntax in the following order: 205 FROM: branch source instruction 206 TO : branch target instruction 207 M/P/-: M=branch target mispredicted or branch direction was mispredicted, P=target predicted or direction predicted, -=not supported 208 X/- : X=branch inside a transactional region, -=not in transaction region or not supported 209 A/- : A=TSX abort entry, -=not aborted region or not supported 210 cycles 211 212 The brstacksym is identical to brstack, except that the FROM and TO addresses are printed in a symbolic form if possible. 213 214 When brstackinsn is specified the full assembler sequences of branch sequences for each sample 215 is printed. This is the full execution path leading to the sample. This is only supported when the 216 sample was recorded with perf record -b or -j any. 217 218 The brstackoff field will print an offset into a specific dso/binary. 219 220-k:: 221--vmlinux=<file>:: 222 vmlinux pathname 223 224--kallsyms=<file>:: 225 kallsyms pathname 226 227--symfs=<directory>:: 228 Look for files with symbols relative to this directory. 229 230-G:: 231--hide-call-graph:: 232 When printing symbols do not display call chain. 233 234--stop-bt:: 235 Stop display of callgraph at these symbols 236 237-C:: 238--cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can 239 be provided as a comma-separated list with no space: 0,1. Ranges of 240 CPUs are specified with -: 0-2. Default is to report samples on all 241 CPUs. 242 243-c:: 244--comms=:: 245 Only display events for these comms. CSV that understands 246 file://filename entries. 247 248--pid=:: 249 Only show events for given process ID (comma separated list). 250 251--tid=:: 252 Only show events for given thread ID (comma separated list). 253 254-I:: 255--show-info:: 256 Display extended information about the perf.data file. This adds 257 information which may be very large and thus may clutter the display. 258 It currently includes: cpu and numa topology of the host system. 259 It can only be used with the perf script report mode. 260 261--show-kernel-path:: 262 Try to resolve the path of [kernel.kallsyms] 263 264--show-task-events 265 Display task related events (e.g. FORK, COMM, EXIT). 266 267--show-mmap-events 268 Display mmap related events (e.g. MMAP, MMAP2). 269 270--show-namespace-events 271 Display namespace events i.e. events of type PERF_RECORD_NAMESPACES. 272 273--show-switch-events 274 Display context switch events i.e. events of type PERF_RECORD_SWITCH or 275 PERF_RECORD_SWITCH_CPU_WIDE. 276 277--demangle:: 278 Demangle symbol names to human readable form. It's enabled by default, 279 disable with --no-demangle. 280 281--demangle-kernel:: 282 Demangle kernel symbol names to human readable form (for C++ kernels). 283 284--header 285 Show perf.data header. 286 287--header-only 288 Show only perf.data header. 289 290--itrace:: 291 Options for decoding instruction tracing data. The options are: 292 293include::itrace.txt[] 294 295 To disable decoding entirely, use --no-itrace. 296 297--full-source-path:: 298 Show the full path for source files for srcline output. 299 300--max-stack:: 301 Set the stack depth limit when parsing the callchain, anything 302 beyond the specified depth will be ignored. This is a trade-off 303 between information loss and faster processing especially for 304 workloads that can have a very long callchain stack. 305 Note that when using the --itrace option the synthesized callchain size 306 will override this value if the synthesized callchain size is bigger. 307 308 Default: 127 309 310--ns:: 311 Use 9 decimal places when displaying time (i.e. show the nanoseconds) 312 313-f:: 314--force:: 315 Don't do ownership validation. 316 317--time:: 318 Only analyze samples within given time window: <start>,<stop>. Times 319 have the format seconds.microseconds. If start is not given (i.e., time 320 string is ',x.y') then analysis starts at the beginning of the file. If 321 stop time is not given (i.e, time string is 'x.y,') then analysis goes 322 to end of file. 323 324--max-blocks:: 325 Set the maximum number of program blocks to print with brstackasm for 326 each sample. 327 328--inline:: 329 If a callgraph address belongs to an inlined function, the inline stack 330 will be printed. Each entry has function name and file/line. 331 332SEE ALSO 333-------- 334linkperf:perf-record[1], linkperf:perf-script-perl[1], 335linkperf:perf-script-python[1] 336