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[: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'.
  42
  43 --filter=<filter>::
  44         Event filter.
  45
  46 -a::
  47 --all-cpus::
  48         System-wide collection from all CPUs.
  49
  50 -l::
  51         Scale counter values.
  52
  53 -p::
  54 --pid=::
  55         Record events on existing process ID.
  56
  57 -t::
  58 --tid=::
  59         Record events on existing thread ID.
  60
  61 -r::
  62 --realtime=::
  63         Collect data with this RT SCHED_FIFO priority.
  64 -A::
  65 --append::
  66         Append to the output file to do incremental profiling.
  67
  68 -f::
  69 --force::
  70         Overwrite existing data file. (deprecated)
  71
  72 -c::
  73 --count=::
  74         Event period to sample.
  75
  76 -o::
  77 --output=::
  78         Output file name.
  79
  80 -i::
  81 --no-inherit::
  82         Child tasks do not inherit counters.
  83 -F::
  84 --freq=::
  85         Profile at this frequency.
  86
  87 -m::
  88 --mmap-pages=::
  89         Number of mmap data pages.
  90
  91 -g::
  92 --call-graph::
  93         Do call-graph (stack chain/backtrace) recording.
  94
  95 -q::
  96 --quiet::
  97         Don't print any message, useful for scripting.
  98
  99 -v::
 100 --verbose::
 101         Be more verbose (show counter open errors, etc).
 102
 103 -s::
 104 --stat::
 105         Per thread counts.
 106
 107 -d::
 108 --data::
 109         Sample addresses.
 110
 111 -T::
 112 --timestamp::
 113         Sample timestamps. Use it with 'perf report -D' to see the timestamps,
 114         for instance.
 115
 116 -n::
 117 --no-samples::
 118         Don't sample.
 119
 120 -R::
 121 --raw-samples::
 122 Collect raw sample records from all opened counters (default for tracepoint counters).
 123
 124 -C::
 125 --cpu::
 126 Collect samples only on the list of CPUs provided. Multiple CPUs can be provided as a
 127 comma-separated list with no space: 0,1. Ranges of CPUs are specified with -: 0-2.
 128 In per-thread mode with inheritance mode on (default), samples are captured only when
 129 the thread executes on the designated CPUs. Default is to monitor all CPUs.
 130
 131 -N::
 132 --no-buildid-cache::
 133 Do not update the builid cache. This saves some overhead in situations
 134 where the information in the perf.data file (which includes buildids)
 135 is sufficient.
 136
 137 SEE ALSO
 138 --------
 139 linkperf:perf-stat[1], linkperf:perf-list[1]