blob: d4da111ef53d842619d229a5c57c87352bcbbef1 [file] [log] [blame]
Ingo Molnare33e0a42009-04-20 15:58:01 +02001perf-record(1)
Ingo Molnarc1c23652009-05-30 12:38:51 +02002==============
Ingo Molnare33e0a42009-04-20 15:58:01 +02003
4NAME
5----
Ingo Molnar23ac9cb2009-05-27 09:33:18 +02006perf-record - Run a command and record its profile into perf.data
Ingo Molnare33e0a42009-04-20 15:58:01 +02007
8SYNOPSIS
9--------
10[verse]
11'perf record' [-e <EVENT> | --event=EVENT] [-l] [-a] <command>
Mike Galbraith9e0967532009-05-28 16:25:34 +020012'perf record' [-e <EVENT> | --event=EVENT] [-l] [-a] -- <command> [<options>]
Ingo Molnare33e0a42009-04-20 15:58:01 +020013
14DESCRIPTION
15-----------
16This command runs a command and gathers a performance counter profile
Ingo Molnar23ac9cb2009-05-27 09:33:18 +020017from it, into perf.data - without displaying anything.
Ingo Molnare33e0a42009-04-20 15:58:01 +020018
19This file can then be inspected later on, using 'perf report'.
20
21
22OPTIONS
23-------
24<command>...::
25 Any command you can specify in a shell.
26
27-e::
28--event=::
Frederic Weisbecker1b290d62009-11-23 15:42:35 +010029 Select the PMU event. Selection can be:
Ingo Molnare33e0a42009-04-20 15:58:01 +020030
Frederic Weisbecker1b290d62009-11-23 15:42:35 +010031 - a symbolic event name (use 'perf list' to list all events)
32
33 - a raw PMU event (eventsel+umask) in the form of rNNN where NNN is a
34 hexadecimal event descriptor.
35
36 - a hardware breakpoint event in the form of '\mem:addr[:access]'
37 where addr is the address in memory you want to break in.
38 Access is the memory access type (read, write, execute) it can
39 be passed as follows: '\mem:addr[:[r][w][x]]'.
40 If you want to profile read-write accesses in 0x1000, just set
41 'mem:0x1000:rw'.
Shawn Bohrer08dbd7e2010-11-30 19:57:16 -060042
43--filter=<filter>::
44 Event filter.
45
Ingo Molnare33e0a42009-04-20 15:58:01 +020046-a::
Shawn Bohrer08dbd7e2010-11-30 19:57:16 -060047--all-cpus::
48 System-wide collection from all CPUs.
Ingo Molnare33e0a42009-04-20 15:58:01 +020049
50-l::
Arnaldo Carvalho de Melo386c0b72009-08-05 10:04:53 -030051 Scale counter values.
52
53-p::
54--pid=::
David Ahernb52956c2012-02-08 09:32:52 -070055 Record events on existing process ID (comma separated list).
Shawn Bohrer08dbd7e2010-11-30 19:57:16 -060056
57-t::
58--tid=::
David Ahernb52956c2012-02-08 09:32:52 -070059 Record events on existing thread ID (comma separated list).
Arnaldo Carvalho de Melo386c0b72009-08-05 10:04:53 -030060
Arnaldo Carvalho de Melo0d37aa32012-01-19 14:08:15 -020061-u::
62--uid=::
63 Record events in threads owned by uid. Name or number.
64
Arnaldo Carvalho de Melo386c0b72009-08-05 10:04:53 -030065-r::
66--realtime=::
67 Collect data with this RT SCHED_FIFO priority.
Kirill Smelkovacac03f2011-01-12 17:59:36 +030068-D::
69--no-delay::
70 Collect data without buffering.
Arnaldo Carvalho de Melo386c0b72009-08-05 10:04:53 -030071-A::
72--append::
73 Append to the output file to do incremental profiling.
74
75-f::
76--force::
Frederic Weisbecker7865e812010-04-14 19:42:07 +020077 Overwrite existing data file. (deprecated)
Arnaldo Carvalho de Melo386c0b72009-08-05 10:04:53 -030078
79-c::
80--count=::
81 Event period to sample.
82
83-o::
84--output=::
85 Output file name.
86
87-i::
Stephane Eranian2e6cdf92010-05-12 10:40:01 +020088--no-inherit::
89 Child tasks do not inherit counters.
Arnaldo Carvalho de Melo386c0b72009-08-05 10:04:53 -030090-F::
91--freq=::
92 Profile at this frequency.
93
94-m::
95--mmap-pages=::
Nelson Elhage41d0d932011-12-19 08:39:32 -050096 Number of mmap data pages. Must be a power of two.
Arnaldo Carvalho de Melo386c0b72009-08-05 10:04:53 -030097
98-g::
99--call-graph::
100 Do call-graph (stack chain/backtrace) recording.
101
Arnaldo Carvalho de Melob44308f2010-10-26 15:20:09 -0200102-q::
103--quiet::
104 Don't print any message, useful for scripting.
105
Arnaldo Carvalho de Melo386c0b72009-08-05 10:04:53 -0300106-v::
107--verbose::
108 Be more verbose (show counter open errors, etc).
109
110-s::
111--stat::
112 Per thread counts.
113
114-d::
115--data::
116 Sample addresses.
117
Arnaldo Carvalho de Melo9c90a612010-12-02 10:25:28 -0200118-T::
119--timestamp::
120 Sample timestamps. Use it with 'perf report -D' to see the timestamps,
121 for instance.
122
Arnaldo Carvalho de Melo386c0b72009-08-05 10:04:53 -0300123-n::
124--no-samples::
125 Don't sample.
Ingo Molnare33e0a42009-04-20 15:58:01 +0200126
Frederic Weisbeckerec7ba4e2009-08-31 03:32:03 +0200127-R::
128--raw-samples::
Frederic Weisbeckerbdef3b02010-04-14 20:05:17 +0200129Collect raw sample records from all opened counters (default for tracepoint counters).
Frederic Weisbeckerec7ba4e2009-08-31 03:32:03 +0200130
Stephane Eranianc45c6ea2010-05-28 12:00:01 +0200131-C::
132--cpu::
Shawn Bohrer08dbd7e2010-11-30 19:57:16 -0600133Collect samples only on the list of CPUs provided. Multiple CPUs can be provided as a
134comma-separated list with no space: 0,1. Ranges of CPUs are specified with -: 0-2.
Stephane Eranianc45c6ea2010-05-28 12:00:01 +0200135In per-thread mode with inheritance mode on (default), samples are captured only when
136the thread executes on the designated CPUs. Default is to monitor all CPUs.
137
Stephane Eraniana1ac1d32010-06-17 11:39:01 +0200138-N::
139--no-buildid-cache::
140Do not update the builid cache. This saves some overhead in situations
141where the information in the perf.data file (which includes buildids)
142is sufficient.
143
Stephane Eranian023695d2011-02-14 11:20:01 +0200144-G name,...::
145--cgroup name,...::
146monitor only in the container (cgroup) called "name". This option is available only
147in per-cpu mode. The cgroup filesystem must be mounted. All threads belonging to
148container "name" are monitored when they run on the monitored CPUs. Multiple cgroups
149can be provided. Each cgroup is applied to the corresponding event, i.e., first cgroup
150to first event, second cgroup to second event and so on. It is possible to provide
151an empty cgroup (monitor all the time) using, e.g., -G foo,,bar. Cgroups must have
152corresponding events, i.e., they always refer to events defined earlier on the command
153line.
154
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100155-b::
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100156--branch-any::
157Enable taken branch stack sampling. Any type of taken branch may be sampled.
158This is a shortcut for --branch-filter any. See --branch-filter for more infos.
159
160-j::
161--branch-filter::
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100162Enable taken branch stack sampling. Each sample captures a series of consecutive
163taken branches. The number of branches captured with each sample depends on the
164underlying hardware, the type of branches of interest, and the executed code.
165It is possible to select the types of branches captured by enabling filters. The
166following filters are defined:
167
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100168 - any: any type of branches
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100169 - any_call: any function call or system call
170 - any_ret: any function return or system call return
Anshuman Khandual2e49a942012-05-18 14:16:50 +0530171 - ind_call: any indirect branch
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100172 - u: only when the branch target is at the user level
173 - k: only when the branch target is in the kernel
174 - hv: only when the target is at the hypervisor level
175
176+
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100177The option requires at least one branch type among any, any_call, any_ret, ind_call.
Masanari Iida9c768202012-11-30 14:10:25 +0900178The privilege levels may be omitted, in which case, the privilege levels of the associated
Stephane Eraniana5aabda2012-03-08 23:47:45 +0100179event are applied to the branch filter. Both kernel (k) and hypervisor (hv) privilege
180levels are subject to permissions. When sampling on multiple events, branch stack sampling
181is enabled for all the sampling events. The sampled branch type is the same for all events.
182The various filters must be specified as a comma separated list: --branch-filter any_ret,u,k
183Note that this feature may not be available on all processors.
Roberto Agostino Vitillobdfebd82012-02-09 23:21:02 +0100184
Andi Kleen05484292013-01-24 16:10:29 +0100185-W::
186--weight::
187Enable weightened sampling. An additional weight is recorded per sample and can be
188displayed with the weight and local_weight sort keys. This currently works for TSX
189abort events and some memory events in precise mode on modern Intel CPUs.
190
Ingo Molnare33e0a42009-04-20 15:58:01 +0200191SEE ALSO
192--------
Thomas Gleixner386b05e2009-06-06 14:56:33 +0200193linkperf:perf-stat[1], linkperf:perf-list[1]