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 a symbolic event name
  30         (use 'perf list' to list all events) or a raw PMU
  31         event (eventsel+umask) in the form of rNNN where NNN is a
  32         hexadecimal event descriptor.
  33
  34 -a::
  35         System-wide collection.
  36
  37 -l::
  38         Scale counter values.
  39
  40 -p::
  41 --pid=::
  42         Record events on existing pid.
  43
  44 -r::
  45 --realtime=::
  46         Collect data with this RT SCHED_FIFO priority.
  47 -A::
  48 --append::
  49         Append to the output file to do incremental profiling.
  50
  51 -f::
  52 --force::
  53         Overwrite existing data file.
  54
  55 -c::
  56 --count=::
  57         Event period to sample.
  58
  59 -o::
  60 --output=::
  61         Output file name.
  62
  63 -i::
  64 --inherit::
  65         Child tasks inherit counters.
  66 -F::
  67 --freq=::
  68         Profile at this frequency.
  69
  70 -m::
  71 --mmap-pages=::
  72         Number of mmap data pages.
  73
  74 -g::
  75 --call-graph::
  76         Do call-graph (stack chain/backtrace) recording.
  77
  78 -v::
  79 --verbose::
  80         Be more verbose (show counter open errors, etc).
  81
  82 -s::
  83 --stat::
  84         Per thread counts.
  85
  86 -d::
  87 --data::
  88         Sample addresses.
  89
  90 -n::
  91 --no-samples::
  92         Don't sample.
  93
  94 -R::
  95 --raw-samples::
  96 Collect raw sample records from all opened counters (typically for tracepoint counters).
  97
  98 SEE ALSO
  99 --------
 100 linkperf:perf-stat[1], linkperf:perf-list[1]