tools/perf/Documentation/perf-record.txt

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