tools/perf/Documentation/perf-script.txt

   1 perf-script(1)
   2 =============
   3
   4 NAME
   5 ----
   6 perf-script - Read perf.data (created by perf record) and display trace output
   7
   8 SYNOPSIS
   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
  17 DESCRIPTION
  18 -----------
  19 This command reads the input file and displays the trace recorded.
  20
  21 There 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
  73 OPTIONS
  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, uregs, brstack, brstacksym, flags, bpf-output,
 120         brstackinsn, brstackoff, callindent, insn, insnlen, synth, phys_addr,
 121         metric, misc, srccode, ipc, data_page_size, code_page_size.
 122         Field list can be prepended with the type, trace, sw or hw,
 123         to indicate to which event type the field list applies.
 124         e.g., -F sw:comm,tid,time,ip,sym  and -F trace:time,cpu,trace
 125
 126                 perf script -F <fields>
 127
 128         is equivalent to:
 129
 130                 perf script -F trace:<fields> -F sw:<fields> -F hw:<fields>
 131
 132         i.e., the specified fields apply to all event types if the type string
 133         is not given.
 134
 135         In addition to overriding fields, it is also possible to add or remove
 136         fields from the defaults. For example
 137
 138                 -F -cpu,+insn
 139
 140         removes the cpu field and adds the insn field. Adding/removing fields
 141         cannot be mixed with normal overriding.
 142
 143         The arguments are processed in the order received. A later usage can
 144         reset a prior request. e.g.:
 145
 146                 -F trace: -F comm,tid,time,ip,sym
 147
 148         The first -F suppresses trace events (field list is ""), but then the
 149         second invocation sets the fields to comm,tid,time,ip,sym. In this case a
 150         warning is given to the user:
 151
 152                 "Overriding previous field request for all events."
 153
 154         Alternatively, consider the order:
 155
 156                 -F comm,tid,time,ip,sym -F trace:
 157
 158         The first -F sets the fields for all events and the second -F
 159         suppresses trace events. The user is given a warning message about
 160         the override, and the result of the above is that only S/W and H/W
 161         events are displayed with the given fields.
 162
 163         It's possible tp add/remove fields only for specific event type:
 164
 165                 -Fsw:-cpu,-period
 166
 167         removes cpu and period from software events.
 168
 169         For the 'wildcard' option if a user selected field is invalid for an
 170         event type, a message is displayed to the user that the option is
 171         ignored for that type. For example:
 172
 173                 $ perf script -F comm,tid,trace
 174                 'trace' not valid for hardware events. Ignoring.
 175                 'trace' not valid for software events. Ignoring.
 176
 177         Alternatively, if the type is given an invalid field is specified it
 178         is an error. For example:
 179
 180         perf script -v -F sw:comm,tid,trace
 181         'trace' not valid for software events.
 182
 183         At this point usage is displayed, and perf-script exits.
 184
 185         The flags field is synthesized and may have a value when Instruction
 186         Trace decoding. The flags are "bcrosyiABExgh" which stand for branch,
 187         call, return, conditional, system, asynchronous, interrupt,
 188         transaction abort, trace begin, trace end, in transaction, VM-Entry, and VM-Exit
 189         respectively. Known combinations of flags are printed more nicely e.g.
 190         "call" for "bc", "return" for "br", "jcc" for "bo", "jmp" for "b",
 191         "int" for "bci", "iret" for "bri", "syscall" for "bcs", "sysret" for "brs",
 192         "async" for "by", "hw int" for "bcyi", "tx abrt" for "bA", "tr strt" for "bB",
 193         "tr end" for "bE", "vmentry" for "bcg", "vmexit" for "bch".
 194         However the "x" flag will be displayed separately in those
 195         cases e.g. "jcc     (x)" for a condition branch within a transaction.
 196
 197         The callindent field is synthesized and may have a value when
 198         Instruction Trace decoding. For calls and returns, it will display the
 199         name of the symbol indented with spaces to reflect the stack depth.
 200
 201         When doing instruction trace decoding insn and insnlen give the
 202         instruction bytes and the instruction length of the current
 203         instruction.
 204
 205         The synth field is used by synthesized events which may be created when
 206         Instruction Trace decoding.
 207
 208         The ipc (instructions per cycle) field is synthesized and may have a value when
 209         Instruction Trace decoding.
 210
 211         Finally, a user may not set fields to none for all event types.
 212         i.e., -F "" is not allowed.
 213
 214         The brstack output includes branch related information with raw addresses using the
 215         /v/v/v/v/cycles syntax in the following order:
 216         FROM: branch source instruction
 217         TO  : branch target instruction
 218         M/P/-: M=branch target mispredicted or branch direction was mispredicted, P=target predicted or direction predicted, -=not supported
 219         X/- : X=branch inside a transactional region, -=not in transaction region or not supported
 220         A/- : A=TSX abort entry, -=not aborted region or not supported
 221         cycles
 222
 223         The brstacksym is identical to brstack, except that the FROM and TO addresses are printed in a symbolic form if possible.
 224
 225         When brstackinsn is specified the full assembler sequences of branch sequences for each sample
 226         is printed. This is the full execution path leading to the sample. This is only supported when the
 227         sample was recorded with perf record -b or -j any.
 228
 229         The brstackoff field will print an offset into a specific dso/binary.
 230
 231         With the metric option perf script can compute metrics for
 232         sampling periods, similar to perf stat. This requires
 233         specifying a group with multiple events defining metrics with the :S option
 234         for perf record. perf will sample on the first event, and
 235         print computed metrics for all the events in the group. Please note
 236         that the metric computed is averaged over the whole sampling
 237         period (since the last sample), not just for the sample point.
 238
 239         For sample events it's possible to display misc field with -F +misc option,
 240         following letters are displayed for each bit:
 241
 242           PERF_RECORD_MISC_KERNEL               K
 243           PERF_RECORD_MISC_USER                 U
 244           PERF_RECORD_MISC_HYPERVISOR           H
 245           PERF_RECORD_MISC_GUEST_KERNEL         G
 246           PERF_RECORD_MISC_GUEST_USER           g
 247           PERF_RECORD_MISC_MMAP_DATA*           M
 248           PERF_RECORD_MISC_COMM_EXEC            E
 249           PERF_RECORD_MISC_SWITCH_OUT           S
 250           PERF_RECORD_MISC_SWITCH_OUT_PREEMPT   Sp
 251
 252           $ perf script -F +misc ...
 253            sched-messaging  1414 K     28690.636582:       4590 cycles ...
 254            sched-messaging  1407 U     28690.636600:     325620 cycles ...
 255            sched-messaging  1414 K     28690.636608:      19473 cycles ...
 256           misc field ___________/
 257
 258 -k::
 259 --vmlinux=<file>::
 260         vmlinux pathname
 261
 262 --kallsyms=<file>::
 263         kallsyms pathname
 264
 265 --symfs=<directory>::
 266         Look for files with symbols relative to this directory.
 267
 268 -G::
 269 --hide-call-graph::
 270         When printing symbols do not display call chain.
 271
 272 --stop-bt::
 273         Stop display of callgraph at these symbols
 274
 275 -C::
 276 --cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can
 277         be provided as a comma-separated list with no space: 0,1. Ranges of
 278         CPUs are specified with -: 0-2. Default is to report samples on all
 279         CPUs.
 280
 281 -c::
 282 --comms=::
 283         Only display events for these comms. CSV that understands
 284         file://filename entries.
 285
 286 --pid=::
 287         Only show events for given process ID (comma separated list).
 288
 289 --tid=::
 290         Only show events for given thread ID (comma separated list).
 291
 292 -I::
 293 --show-info::
 294         Display extended information about the perf.data file. This adds
 295         information which may be very large and thus may clutter the display.
 296         It currently includes: cpu and numa topology of the host system.
 297         It can only be used with the perf script report mode.
 298
 299 --show-kernel-path::
 300         Try to resolve the path of [kernel.kallsyms]
 301
 302 --show-task-events
 303         Display task related events (e.g. FORK, COMM, EXIT).
 304
 305 --show-mmap-events
 306         Display mmap related events (e.g. MMAP, MMAP2).
 307
 308 --show-namespace-events
 309         Display namespace events i.e. events of type PERF_RECORD_NAMESPACES.
 310
 311 --show-switch-events
 312         Display context switch events i.e. events of type PERF_RECORD_SWITCH or
 313         PERF_RECORD_SWITCH_CPU_WIDE.
 314
 315 --show-lost-events
 316         Display lost events i.e. events of type PERF_RECORD_LOST.
 317
 318 --show-round-events
 319         Display finished round events i.e. events of type PERF_RECORD_FINISHED_ROUND.
 320
 321 --show-bpf-events
 322         Display bpf events i.e. events of type PERF_RECORD_KSYMBOL and PERF_RECORD_BPF_EVENT.
 323
 324 --show-cgroup-events
 325         Display cgroup events i.e. events of type PERF_RECORD_CGROUP.
 326
 327 --show-text-poke-events
 328         Display text poke events i.e. events of type PERF_RECORD_TEXT_POKE and
 329         PERF_RECORD_KSYMBOL.
 330
 331 --demangle::
 332         Demangle symbol names to human readable form. It's enabled by default,
 333         disable with --no-demangle.
 334
 335 --demangle-kernel::
 336         Demangle kernel symbol names to human readable form (for C++ kernels).
 337
 338 --header
 339         Show perf.data header.
 340
 341 --header-only
 342         Show only perf.data header.
 343
 344 --itrace::
 345         Options for decoding instruction tracing data. The options are:
 346
 347 include::itrace.txt[]
 348
 349         To disable decoding entirely, use --no-itrace.
 350
 351 --full-source-path::
 352         Show the full path for source files for srcline output.
 353
 354 --max-stack::
 355         Set the stack depth limit when parsing the callchain, anything
 356         beyond the specified depth will be ignored. This is a trade-off
 357         between information loss and faster processing especially for
 358         workloads that can have a very long callchain stack.
 359         Note that when using the --itrace option the synthesized callchain size
 360         will override this value if the synthesized callchain size is bigger.
 361
 362         Default: 127
 363
 364 --ns::
 365         Use 9 decimal places when displaying time (i.e. show the nanoseconds)
 366
 367 -f::
 368 --force::
 369         Don't do ownership validation.
 370
 371 --time::
 372         Only analyze samples within given time window: <start>,<stop>. Times
 373         have the format seconds.nanoseconds. If start is not given (i.e. time
 374         string is ',x.y') then analysis starts at the beginning of the file. If
 375         stop time is not given (i.e. time string is 'x.y,') then analysis goes
 376         to end of file. Multiple ranges can be separated by spaces, which
 377         requires the argument to be quoted e.g. --time "1234.567,1234.789 1235,"
 378
 379         Also support time percent with multiple time ranges. Time string is
 380         'a%/n,b%/m,...' or 'a%-b%,c%-%d,...'.
 381
 382         For example:
 383         Select the second 10% time slice:
 384         perf script --time 10%/2
 385
 386         Select from 0% to 10% time slice:
 387         perf script --time 0%-10%
 388
 389         Select the first and second 10% time slices:
 390         perf script --time 10%/1,10%/2
 391
 392         Select from 0% to 10% and 30% to 40% slices:
 393         perf script --time 0%-10%,30%-40%
 394
 395 --max-blocks::
 396         Set the maximum number of program blocks to print with brstackinsn for
 397         each sample.
 398
 399 --reltime::
 400         Print time stamps relative to trace start.
 401
 402 --deltatime::
 403         Print time stamps relative to previous event.
 404
 405 --per-event-dump::
 406         Create per event files with a "perf.data.EVENT.dump" name instead of
 407         printing to stdout, useful, for instance, for generating flamegraphs.
 408
 409 --inline::
 410         If a callgraph address belongs to an inlined function, the inline stack
 411         will be printed. Each entry has function name and file/line. Enabled by
 412         default, disable with --no-inline.
 413
 414 --insn-trace::
 415         Show instruction stream for intel_pt traces. Combine with --xed to
 416         show disassembly.
 417
 418 --xed::
 419         Run xed disassembler on output. Requires installing the xed disassembler.
 420
 421 -S::
 422 --symbols=symbol[,symbol...]::
 423         Only consider the listed symbols. Symbols are typically a name
 424         but they may also be hexadecimal address.
 425
 426         The hexadecimal address may be the start address of a symbol or
 427         any other address to filter the trace records
 428
 429         For example, to select the symbol noploop or the address 0x4007a0:
 430         perf script --symbols=noploop,0x4007a0
 431
 432         Support filtering trace records by symbol name, start address of
 433         symbol, any hexadecimal address and address range.
 434
 435         The comparison order is:
 436
 437         1. symbol name comparison
 438         2. symbol start address comparison.
 439         3. any hexadecimal address comparison.
 440         4. address range comparison (see --addr-range).
 441
 442 --addr-range::
 443        Use with -S or --symbols to list traced records within address range.
 444
 445        For example, to list the traced records within the address range
 446        [0x4007a0, 0x0x4007a9]:
 447        perf script -S 0x4007a0 --addr-range 10
 448
 449 --dsos=::
 450         Only consider symbols in these DSOs.
 451
 452 --call-trace::
 453         Show call stream for intel_pt traces. The CPUs are interleaved, but
 454         can be filtered with -C.
 455
 456 --call-ret-trace::
 457         Show call and return stream for intel_pt traces.
 458
 459 --graph-function::
 460         For itrace only show specified functions and their callees for
 461         itrace. Multiple functions can be separated by comma.
 462
 463 --switch-on EVENT_NAME::
 464         Only consider events after this event is found.
 465
 466 --switch-off EVENT_NAME::
 467         Stop considering events after this event is found.
 468
 469 --show-on-off-events::
 470         Show the --switch-on/off events too.
 471
 472 --stitch-lbr::
 473         Show callgraph with stitched LBRs, which may have more complete
 474         callgraph. The perf.data file must have been obtained using
 475         perf record --call-graph lbr.
 476         Disabled by default. In common cases with call stack overflows,
 477         it can recreate better call stacks than the default lbr call stack
 478         output. But this approach is not full proof. There can be cases
 479         where it creates incorrect call stacks from incorrect matches.
 480         The known limitations include exception handing such as
 481         setjmp/longjmp will have calls/returns not match.
 482
 483 SEE ALSO
 484 --------
 485 linkperf:perf-record[1], linkperf:perf-script-perl[1],
 486 linkperf:perf-script-python[1], linkperf:perf-intel-pt[1]