Ingo Molnar | e33e0a4 | 2009-04-20 15:58:01 +0200 | [diff] [blame] | 1 | perf-record(1) |
Ingo Molnar | c1c2365 | 2009-05-30 12:38:51 +0200 | [diff] [blame] | 2 | ============== |
Ingo Molnar | e33e0a4 | 2009-04-20 15:58:01 +0200 | [diff] [blame] | 3 | |
| 4 | NAME |
| 5 | ---- |
Ingo Molnar | 23ac9cb | 2009-05-27 09:33:18 +0200 | [diff] [blame] | 6 | perf-record - Run a command and record its profile into perf.data |
Ingo Molnar | e33e0a4 | 2009-04-20 15:58:01 +0200 | [diff] [blame] | 7 | |
| 8 | SYNOPSIS |
| 9 | -------- |
| 10 | [verse] |
| 11 | 'perf record' [-e <EVENT> | --event=EVENT] [-l] [-a] <command> |
Mike Galbraith | 9e09675 | 2009-05-28 16:25:34 +0200 | [diff] [blame] | 12 | 'perf record' [-e <EVENT> | --event=EVENT] [-l] [-a] -- <command> [<options>] |
Ingo Molnar | e33e0a4 | 2009-04-20 15:58:01 +0200 | [diff] [blame] | 13 | |
| 14 | DESCRIPTION |
| 15 | ----------- |
| 16 | This command runs a command and gathers a performance counter profile |
Ingo Molnar | 23ac9cb | 2009-05-27 09:33:18 +0200 | [diff] [blame] | 17 | from it, into perf.data - without displaying anything. |
Ingo Molnar | e33e0a4 | 2009-04-20 15:58:01 +0200 | [diff] [blame] | 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=:: |
Frederic Weisbecker | 1b290d6 | 2009-11-23 15:42:35 +0100 | [diff] [blame] | 29 | Select the PMU event. Selection can be: |
Ingo Molnar | e33e0a4 | 2009-04-20 15:58:01 +0200 | [diff] [blame] | 30 | |
Frederic Weisbecker | 1b290d6 | 2009-11-23 15:42:35 +0100 | [diff] [blame] | 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'. |
Shawn Bohrer | 08dbd7e | 2010-11-30 19:57:16 -0600 | [diff] [blame] | 42 | |
| 43 | --filter=<filter>:: |
| 44 | Event filter. |
| 45 | |
Ingo Molnar | e33e0a4 | 2009-04-20 15:58:01 +0200 | [diff] [blame] | 46 | -a:: |
Shawn Bohrer | 08dbd7e | 2010-11-30 19:57:16 -0600 | [diff] [blame] | 47 | --all-cpus:: |
| 48 | System-wide collection from all CPUs. |
Ingo Molnar | e33e0a4 | 2009-04-20 15:58:01 +0200 | [diff] [blame] | 49 | |
| 50 | -l:: |
Arnaldo Carvalho de Melo | 386c0b7 | 2009-08-05 10:04:53 -0300 | [diff] [blame] | 51 | Scale counter values. |
| 52 | |
| 53 | -p:: |
| 54 | --pid=:: |
Shawn Bohrer | 08dbd7e | 2010-11-30 19:57:16 -0600 | [diff] [blame] | 55 | Record events on existing process ID. |
| 56 | |
| 57 | -t:: |
| 58 | --tid=:: |
| 59 | Record events on existing thread ID. |
Arnaldo Carvalho de Melo | 386c0b7 | 2009-08-05 10:04:53 -0300 | [diff] [blame] | 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:: |
Frederic Weisbecker | 7865e81 | 2010-04-14 19:42:07 +0200 | [diff] [blame] | 70 | Overwrite existing data file. (deprecated) |
Arnaldo Carvalho de Melo | 386c0b7 | 2009-08-05 10:04:53 -0300 | [diff] [blame] | 71 | |
| 72 | -c:: |
| 73 | --count=:: |
| 74 | Event period to sample. |
| 75 | |
| 76 | -o:: |
| 77 | --output=:: |
| 78 | Output file name. |
| 79 | |
| 80 | -i:: |
Stephane Eranian | 2e6cdf9 | 2010-05-12 10:40:01 +0200 | [diff] [blame] | 81 | --no-inherit:: |
| 82 | Child tasks do not inherit counters. |
Arnaldo Carvalho de Melo | 386c0b7 | 2009-08-05 10:04:53 -0300 | [diff] [blame] | 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 | |
Arnaldo Carvalho de Melo | b44308f | 2010-10-26 15:20:09 -0200 | [diff] [blame] | 95 | -q:: |
| 96 | --quiet:: |
| 97 | Don't print any message, useful for scripting. |
| 98 | |
Arnaldo Carvalho de Melo | 386c0b7 | 2009-08-05 10:04:53 -0300 | [diff] [blame] | 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 | |
Arnaldo Carvalho de Melo | 9c90a61 | 2010-12-02 10:25:28 -0200 | [diff] [blame] | 111 | -T:: |
| 112 | --timestamp:: |
| 113 | Sample timestamps. Use it with 'perf report -D' to see the timestamps, |
| 114 | for instance. |
| 115 | |
Arnaldo Carvalho de Melo | 386c0b7 | 2009-08-05 10:04:53 -0300 | [diff] [blame] | 116 | -n:: |
| 117 | --no-samples:: |
| 118 | Don't sample. |
Ingo Molnar | e33e0a4 | 2009-04-20 15:58:01 +0200 | [diff] [blame] | 119 | |
Frederic Weisbecker | ec7ba4e | 2009-08-31 03:32:03 +0200 | [diff] [blame] | 120 | -R:: |
| 121 | --raw-samples:: |
Frederic Weisbecker | bdef3b0 | 2010-04-14 20:05:17 +0200 | [diff] [blame] | 122 | Collect raw sample records from all opened counters (default for tracepoint counters). |
Frederic Weisbecker | ec7ba4e | 2009-08-31 03:32:03 +0200 | [diff] [blame] | 123 | |
Stephane Eranian | c45c6ea | 2010-05-28 12:00:01 +0200 | [diff] [blame] | 124 | -C:: |
| 125 | --cpu:: |
Shawn Bohrer | 08dbd7e | 2010-11-30 19:57:16 -0600 | [diff] [blame] | 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. |
Stephane Eranian | c45c6ea | 2010-05-28 12:00:01 +0200 | [diff] [blame] | 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 | |
Stephane Eranian | a1ac1d3 | 2010-06-17 11:39:01 +0200 | [diff] [blame] | 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 | |
Ingo Molnar | e33e0a4 | 2009-04-20 15:58:01 +0200 | [diff] [blame] | 137 | SEE ALSO |
| 138 | -------- |
Thomas Gleixner | 386b05e | 2009-06-06 14:56:33 +0200 | [diff] [blame] | 139 | linkperf:perf-stat[1], linkperf:perf-list[1] |