perf-script.txt 8.7 KB
Newer Older
1
perf-script(1)
2
=============
I
Ingo Molnar 已提交
3 4 5

NAME
----
6
perf-script - Read perf.data (created by perf record) and display trace output
I
Ingo Molnar 已提交
7 8 9 10

SYNOPSIS
--------
[verse]
11 12 13 14 15
'perf script' [<options>]
'perf script' [<options>] record <script> [<record-options>] <command>
'perf script' [<options>] report <script> [script-args]
'perf script' [<options>] <script> <required-script-args> [<record-options>] <command>
'perf script' [<options>] <top-script> [script-args]
I
Ingo Molnar 已提交
16 17 18 19 20

DESCRIPTION
-----------
This command reads the input file and displays the trace recorded.

21
There are several variants of perf script:
22

23
  'perf script' to see a detailed trace of the workload that was
24 25
  recorded.

26 27
  You can also run a set of pre-canned scripts that aggregate and
  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 30
  record and run those scripts:

31 32 33
  'perf script record <script> <command>' to record the events required
  for 'perf script report'.  <script> is the name displayed in the
  output of 'perf script --list' i.e. the actual script name minus any
34 35
  language extension.  If <command> is not specified, the events are
  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 43 44
  succeed.  [args] refers to the (mainly optional) args expected by
  the script.

45
  'perf script <script> <required-script-args> <command>' to both
46 47
  record the events required for <script> and to run the <script>
  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 50 51 52 53
  actual script name minus any language extension.  If <command> is
  not specified, the events are recorded using the -a (system-wide)
  'perf record' option.  If <script> has any required args, they
  should be specified before <command>.  This mode doesn't allow for
  optional script args to be specified; if optional script args are
54 55
  desired, they can be specified using separate 'perf script record'
  and 'perf script report' commands, with the stdout of the record step
56 57 58
  piped to the stdin of the report script, using the '-o -' and '-i -'
  options of the corresponding commands.

59
  'perf script <top-script>' to both record the events required for
60 61
  <top-script> and to run the <top-script> using 'live-mode'
  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 64 65
  script name minus any language extension; a <top-script> is defined
  as any script name ending with the string 'top'.

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 71 72
  See the 'SEE ALSO' section for links to language-specific
  information on how to write and run your own trace scripts.

I
Ingo Molnar 已提交
73 74
OPTIONS
-------
75 76 77
<command>...::
	Any command you can specify in a shell.

I
Ingo Molnar 已提交
78
-D::
79
--dump-raw-script=::
I
Ingo Molnar 已提交
80 81
        Display verbose dump of the trace data.

82 83 84 85 86 87 88 89
-L::
--Latency=::
        Show latency attributes (irqs/preemption disabled, etc).

-l::
--list=::
        Display a list of available trace scripts.

90
-s ['lang']::
91 92
--script=::
        Process trace data with the given script ([lang]:script[.ext]).
93 94
	If the string 'lang' is specified in place of a script name, a
        list of supported languages will be displayed instead.
95 96 97

-g::
--gen-script=::
98
        Generate perf-script.[ext] starter script for given language,
99 100
        using current perf.data.

101 102 103 104 105 106
-a::
        Force system-wide collection.  Scripts run without a <command>
        normally use -a by default, while scripts run with a <command>
        normally don't - this option allows the latter to be run in
        system-wide mode.

107 108
-i::
--input=::
109
        Input file name. (default: perf.data unless stdin is a fifo)
110 111 112 113

-d::
--debug-mode::
        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 119
        comm, tid, pid, time, cpu, event, trace, ip, sym, dso, addr, symoff,
	srcline, period, 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 125 126 127 128
		perf script -f <fields>

	is equivalent to:

		perf script -f trace:<fields> -f sw:<fields> -f hw:<fields>
129

130 131
	i.e., the specified fields apply to all event types if the type string
	is not given.
132

133 134
	The arguments are processed in the order received. A later usage can
	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 149 150 151
	The first -f sets the fields for all events and the second -f
	suppresses trace events. The user is given a warning message about
	the override, and the result of the above is that only S/W and H/W
	events are displayed with the given fields.
152

153 154 155
	For the 'wildcard' option if a user selected field is invalid for an
	event type, a message is displayed to the user that the option is
	ignored for that type. For example:
156

157 158 159
		$ perf script -f comm,tid,trace
		'trace' not valid for hardware events. Ignoring.
		'trace' not valid for software events. Ignoring.
160

161 162
	Alternatively, if the type is given an invalid field is specified it
	is an error. For example:
163

164 165
        perf script -v -f sw:comm,tid,trace
        'trace' not valid for software events.
166

167
	At this point usage is displayed, and perf-script exits.
168

169 170 171 172 173 174
	The flags field is synthesized and may have a value when Instruction
	Trace decoding. The flags are "bcrosyiABEx" which stand for branch,
	call, return, conditional, system, asynchronous, interrupt,
	transaction abort, trace begin, trace end, and in transaction,
	respectively.

175 176 177
	Finally, a user may not set fields to none for all event types.
	i.e., -f "" is not allowed.

178 179 180 181 182 183 184 185 186 187 188 189 190
-k::
--vmlinux=<file>::
        vmlinux pathname

--kallsyms=<file>::
        kallsyms pathname

--symfs=<directory>::
        Look for files with symbols relative to this directory.

-G::
--hide-call-graph::
        When printing symbols do not display call chain.
191

192
-C::
193 194 195 196 197
--cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can
	be provided as a comma-separated list with no space: 0,1. Ranges of
	CPUs are specified with -: 0-2. Default is to report samples on all
	CPUs.

198 199 200 201 202
-c::
--comms=::
	Only display events for these comms. CSV that understands
	file://filename entries.

203 204 205 206 207 208
--pid=::
	Only show events for given process ID (comma separated list).

--tid=::
	Only show events for given thread ID (comma separated list).

209 210 211 212 213 214 215
-I::
--show-info::
	Display extended information about the perf.data file. This adds
	information which may be very large and thus may clutter the display.
	It currently includes: cpu and numa topology of the host system.
	It can only be used with the perf script report mode.

216 217 218
--show-kernel-path::
	Try to resolve the path of [kernel.kallsyms]

219 220 221
--show-task-events
	Display task related events (e.g. FORK, COMM, EXIT).

222 223 224
--show-mmap-events
	Display mmap related events (e.g. MMAP, MMAP2).

225 226 227 228
--show-switch-events
	Display context switch events i.e. events of type PERF_RECORD_SWITCH or
	PERF_RECORD_SWITCH_CPU_WIDE.

229 230 231 232 233 234
--header
	Show perf.data header.

--header-only
	Show only perf.data header.

235 236 237 238 239 240 241
--itrace::
	Options for decoding instruction tracing data. The options are:

		i	synthesize instructions events
		b	synthesize branches events
		c	synthesize branches events (calls only)
		r	synthesize branches events (returns only)
242
		x	synthesize transactions events
243 244
		e	synthesize error events
		d	create a debug log
245
		g	synthesize a call chain (use with i or x)
246

247
	The default is all events i.e. the same as --itrace=ibxe
248 249 250 251 252 253 254 255 256 257

	In addition, the period (default 100000) for instructions events
	can be specified in units of:

		i	instructions
		t	ticks
		ms	milliseconds
		us	microseconds
		ns	nanoseconds (default)

258 259
	Also the call chain size (default 16, max. 1024) for instructions or
	transactions events can be specified.
260 261 262

	To disable decoding entirely, use --no-itrace.

263 264 265
--full-source-path::
	Show the full path for source files for srcline output.

I
Ingo Molnar 已提交
266 267
SEE ALSO
--------
268 269
linkperf:perf-record[1], linkperf:perf-script-perl[1],
linkperf:perf-script-python[1]