Commit | Line | Data |
---|---|---|
e33e0a43 | 1 | perf-record(1) |
c1c2365a | 2 | ============== |
e33e0a43 IM |
3 | |
4 | NAME | |
5 | ---- | |
23ac9cbe | 6 | perf-record - Run a command and record its profile into perf.data |
e33e0a43 IM |
7 | |
8 | SYNOPSIS | |
9 | -------- | |
10 | [verse] | |
11 | 'perf record' [-e <EVENT> | --event=EVENT] [-l] [-a] <command> | |
9e096753 | 12 | 'perf record' [-e <EVENT> | --event=EVENT] [-l] [-a] -- <command> [<options>] |
e33e0a43 IM |
13 | |
14 | DESCRIPTION | |
15 | ----------- | |
16 | This command runs a command and gathers a performance counter profile | |
23ac9cbe | 17 | from it, into perf.data - without displaying anything. |
e33e0a43 IM |
18 | |
19 | This file can then be inspected later on, using 'perf report'. | |
20 | ||
21 | ||
22 | OPTIONS | |
23 | ------- | |
24 | <command>...:: | |
25 | Any command you can specify in a shell. | |
26 | ||
27 | -e:: | |
28 | --event=:: | |
1b290d67 | 29 | Select the PMU event. Selection can be: |
e33e0a43 | 30 | |
1b290d67 FW |
31 | - 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'. | |
08dbd7e3 SB |
42 | |
43 | --filter=<filter>:: | |
44 | Event filter. | |
45 | ||
e33e0a43 | 46 | -a:: |
08dbd7e3 SB |
47 | --all-cpus:: |
48 | System-wide collection from all CPUs. | |
e33e0a43 IM |
49 | |
50 | -l:: | |
386c0b70 ACM |
51 | Scale counter values. |
52 | ||
53 | -p:: | |
54 | --pid=:: | |
b52956c9 | 55 | Record events on existing process ID (comma separated list). |
08dbd7e3 SB |
56 | |
57 | -t:: | |
58 | --tid=:: | |
b52956c9 | 59 | Record events on existing thread ID (comma separated list). |
69e7e5b0 AH |
60 | This option also disables inheritance by default. Enable it by adding |
61 | --inherit. | |
386c0b70 | 62 | |
0d37aa34 ACM |
63 | -u:: |
64 | --uid=:: | |
65 | Record events in threads owned by uid. Name or number. | |
66 | ||
386c0b70 ACM |
67 | -r:: |
68 | --realtime=:: | |
69 | Collect data with this RT SCHED_FIFO priority. | |
563aecb2 | 70 | |
509051ea | 71 | --no-buffering:: |
acac03fa | 72 | Collect data without buffering. |
386c0b70 | 73 | |
386c0b70 ACM |
74 | -c:: |
75 | --count=:: | |
76 | Event period to sample. | |
77 | ||
78 | -o:: | |
79 | --output=:: | |
80 | Output file name. | |
81 | ||
82 | -i:: | |
2e6cdf99 SE |
83 | --no-inherit:: |
84 | Child tasks do not inherit counters. | |
386c0b70 ACM |
85 | -F:: |
86 | --freq=:: | |
87 | Profile at this frequency. | |
88 | ||
89 | -m:: | |
90 | --mmap-pages=:: | |
27050f53 JO |
91 | Number of mmap data pages (must be a power of two) or size |
92 | specification with appended unit character - B/K/M/G. The | |
93 | size is rounded up to have nearest pages power of two value. | |
386c0b70 ACM |
94 | |
95 | -g:: | |
09b0fd45 JO |
96 | Enables call-graph (stack chain/backtrace) recording. |
97 | ||
386c0b70 | 98 | --call-graph:: |
09b0fd45 JO |
99 | Setup and enable call-graph (stack chain/backtrace) recording, |
100 | implies -g. | |
101 | ||
102 | Allows specifying "fp" (frame pointer) or "dwarf" | |
103 | (DWARF's CFI - Call Frame Information) as the method to collect | |
104 | the information used to show the call graphs. | |
105 | ||
106 | In some systems, where binaries are build with gcc | |
107 | --fomit-frame-pointer, using the "fp" method will produce bogus | |
108 | call graphs, using "dwarf", if available (perf tools linked to | |
109 | the libunwind library) should be used instead. | |
386c0b70 | 110 | |
b44308f5 ACM |
111 | -q:: |
112 | --quiet:: | |
113 | Don't print any message, useful for scripting. | |
114 | ||
386c0b70 ACM |
115 | -v:: |
116 | --verbose:: | |
117 | Be more verbose (show counter open errors, etc). | |
118 | ||
119 | -s:: | |
120 | --stat:: | |
121 | Per thread counts. | |
122 | ||
123 | -d:: | |
124 | --data:: | |
125 | Sample addresses. | |
126 | ||
9c90a61c ACM |
127 | -T:: |
128 | --timestamp:: | |
129 | Sample timestamps. Use it with 'perf report -D' to see the timestamps, | |
130 | for instance. | |
131 | ||
386c0b70 ACM |
132 | -n:: |
133 | --no-samples:: | |
134 | Don't sample. | |
e33e0a43 | 135 | |
ec7ba4ea FW |
136 | -R:: |
137 | --raw-samples:: | |
bdef3b02 | 138 | Collect raw sample records from all opened counters (default for tracepoint counters). |
ec7ba4ea | 139 | |
c45c6ea2 SE |
140 | -C:: |
141 | --cpu:: | |
08dbd7e3 SB |
142 | Collect samples only on the list of CPUs provided. Multiple CPUs can be provided as a |
143 | comma-separated list with no space: 0,1. Ranges of CPUs are specified with -: 0-2. | |
c45c6ea2 SE |
144 | In per-thread mode with inheritance mode on (default), samples are captured only when |
145 | the thread executes on the designated CPUs. Default is to monitor all CPUs. | |
146 | ||
a1ac1d3c SE |
147 | -N:: |
148 | --no-buildid-cache:: | |
149 | Do not update the builid cache. This saves some overhead in situations | |
150 | where the information in the perf.data file (which includes buildids) | |
151 | is sufficient. | |
152 | ||
023695d9 SE |
153 | -G name,...:: |
154 | --cgroup name,...:: | |
155 | monitor only in the container (cgroup) called "name". This option is available only | |
156 | in per-cpu mode. The cgroup filesystem must be mounted. All threads belonging to | |
157 | container "name" are monitored when they run on the monitored CPUs. Multiple cgroups | |
158 | can be provided. Each cgroup is applied to the corresponding event, i.e., first cgroup | |
159 | to first event, second cgroup to second event and so on. It is possible to provide | |
160 | an empty cgroup (monitor all the time) using, e.g., -G foo,,bar. Cgroups must have | |
161 | corresponding events, i.e., they always refer to events defined earlier on the command | |
162 | line. | |
163 | ||
bdfebd84 | 164 | -b:: |
a5aabdac SE |
165 | --branch-any:: |
166 | Enable taken branch stack sampling. Any type of taken branch may be sampled. | |
167 | This is a shortcut for --branch-filter any. See --branch-filter for more infos. | |
168 | ||
169 | -j:: | |
170 | --branch-filter:: | |
bdfebd84 RAV |
171 | Enable taken branch stack sampling. Each sample captures a series of consecutive |
172 | taken branches. The number of branches captured with each sample depends on the | |
173 | underlying hardware, the type of branches of interest, and the executed code. | |
174 | It is possible to select the types of branches captured by enabling filters. The | |
175 | following filters are defined: | |
176 | ||
a5aabdac | 177 | - any: any type of branches |
bdfebd84 RAV |
178 | - any_call: any function call or system call |
179 | - any_ret: any function return or system call return | |
2e49a948 | 180 | - ind_call: any indirect branch |
bdfebd84 RAV |
181 | - u: only when the branch target is at the user level |
182 | - k: only when the branch target is in the kernel | |
183 | - hv: only when the target is at the hypervisor level | |
0126d493 AK |
184 | - in_tx: only when the target is in a hardware transaction |
185 | - no_tx: only when the target is not in a hardware transaction | |
186 | - abort_tx: only when the target is a hardware transaction abort | |
3e39db4a | 187 | - cond: conditional branches |
bdfebd84 RAV |
188 | |
189 | + | |
3e39db4a | 190 | The option requires at least one branch type among any, any_call, any_ret, ind_call, cond. |
9c768207 | 191 | The privilege levels may be omitted, in which case, the privilege levels of the associated |
a5aabdac SE |
192 | event are applied to the branch filter. Both kernel (k) and hypervisor (hv) privilege |
193 | levels are subject to permissions. When sampling on multiple events, branch stack sampling | |
194 | is enabled for all the sampling events. The sampled branch type is the same for all events. | |
195 | The various filters must be specified as a comma separated list: --branch-filter any_ret,u,k | |
196 | Note that this feature may not be available on all processors. | |
bdfebd84 | 197 | |
05484298 AK |
198 | --weight:: |
199 | Enable weightened sampling. An additional weight is recorded per sample and can be | |
200 | displayed with the weight and local_weight sort keys. This currently works for TSX | |
201 | abort events and some memory events in precise mode on modern Intel CPUs. | |
202 | ||
475eeab9 AK |
203 | --transaction:: |
204 | Record transaction flags for transaction related events. | |
205 | ||
3aa5939d AH |
206 | --per-thread:: |
207 | Use per-thread mmaps. By default per-cpu mmaps are created. This option | |
208 | overrides that and uses per-thread mmaps. A side-effect of that is that | |
209 | inheritance is automatically disabled. --per-thread is ignored with a warning | |
210 | if combined with -a or -C options. | |
539e6bb7 | 211 | |
a6205a35 ACM |
212 | -D:: |
213 | --delay=:: | |
6619a53e AK |
214 | After starting the program, wait msecs before measuring. This is useful to |
215 | filter out the startup phase of the program, which is often very different. | |
216 | ||
e33e0a43 IM |
217 | SEE ALSO |
218 | -------- | |
386b05e3 | 219 | linkperf:perf-stat[1], linkperf:perf-list[1] |