1perf-record(1) 2============== 3 4NAME 5---- 6perf-record - Run a command and record its profile into perf.data 7 8SYNOPSIS 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 14DESCRIPTION 15----------- 16This command runs a command and gathers a performance counter profile 17from it, into perf.data - without displaying anything. 18 19This file can then be inspected later on, using 'perf report'. 20 21 22OPTIONS 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 (comma separated list). 56 57-t:: 58--tid=:: 59 Record events on existing thread ID (comma separated list). 60 61-u:: 62--uid=:: 63 Record events in threads owned by uid. Name or number. 64 65-r:: 66--realtime=:: 67 Collect data with this RT SCHED_FIFO priority. 68 69-D:: 70--no-delay:: 71 Collect data without buffering. 72 73-c:: 74--count=:: 75 Event period to sample. 76 77-o:: 78--output=:: 79 Output file name. 80 81-i:: 82--no-inherit:: 83 Child tasks do not inherit counters. 84-F:: 85--freq=:: 86 Profile at this frequency. 87 88-m:: 89--mmap-pages=:: 90 Number of mmap data pages. Must be a power of two. 91 92-g:: 93--call-graph:: 94 Do call-graph (stack chain/backtrace) recording. 95 96-q:: 97--quiet:: 98 Don't print any message, useful for scripting. 99 100-v:: 101--verbose:: 102 Be more verbose (show counter open errors, etc). 103 104-s:: 105--stat:: 106 Per thread counts. 107 108-d:: 109--data:: 110 Sample addresses. 111 112-T:: 113--timestamp:: 114 Sample timestamps. Use it with 'perf report -D' to see the timestamps, 115 for instance. 116 117-n:: 118--no-samples:: 119 Don't sample. 120 121-R:: 122--raw-samples:: 123Collect raw sample records from all opened counters (default for tracepoint counters). 124 125-C:: 126--cpu:: 127Collect samples only on the list of CPUs provided. Multiple CPUs can be provided as a 128comma-separated list with no space: 0,1. Ranges of CPUs are specified with -: 0-2. 129In per-thread mode with inheritance mode on (default), samples are captured only when 130the thread executes on the designated CPUs. Default is to monitor all CPUs. 131 132-N:: 133--no-buildid-cache:: 134Do not update the builid cache. This saves some overhead in situations 135where the information in the perf.data file (which includes buildids) 136is sufficient. 137 138-G name,...:: 139--cgroup name,...:: 140monitor only in the container (cgroup) called "name". This option is available only 141in per-cpu mode. The cgroup filesystem must be mounted. All threads belonging to 142container "name" are monitored when they run on the monitored CPUs. Multiple cgroups 143can be provided. Each cgroup is applied to the corresponding event, i.e., first cgroup 144to first event, second cgroup to second event and so on. It is possible to provide 145an empty cgroup (monitor all the time) using, e.g., -G foo,,bar. Cgroups must have 146corresponding events, i.e., they always refer to events defined earlier on the command 147line. 148 149-b:: 150--branch-any:: 151Enable taken branch stack sampling. Any type of taken branch may be sampled. 152This is a shortcut for --branch-filter any. See --branch-filter for more infos. 153 154-j:: 155--branch-filter:: 156Enable taken branch stack sampling. Each sample captures a series of consecutive 157taken branches. The number of branches captured with each sample depends on the 158underlying hardware, the type of branches of interest, and the executed code. 159It is possible to select the types of branches captured by enabling filters. The 160following filters are defined: 161 162 - any: any type of branches 163 - any_call: any function call or system call 164 - any_ret: any function return or system call return 165 - ind_call: any indirect branch 166 - u: only when the branch target is at the user level 167 - k: only when the branch target is in the kernel 168 - hv: only when the target is at the hypervisor level 169 - in_tx: only when the target is in a hardware transaction 170 - no_tx: only when the target is not in a hardware transaction 171 - abort_tx: only when the target is a hardware transaction abort 172 173+ 174The option requires at least one branch type among any, any_call, any_ret, ind_call. 175The privilege levels may be omitted, in which case, the privilege levels of the associated 176event are applied to the branch filter. Both kernel (k) and hypervisor (hv) privilege 177levels are subject to permissions. When sampling on multiple events, branch stack sampling 178is enabled for all the sampling events. The sampled branch type is the same for all events. 179The various filters must be specified as a comma separated list: --branch-filter any_ret,u,k 180Note that this feature may not be available on all processors. 181 182--weight:: 183Enable weightened sampling. An additional weight is recorded per sample and can be 184displayed with the weight and local_weight sort keys. This currently works for TSX 185abort events and some memory events in precise mode on modern Intel CPUs. 186 187--transaction:: 188Record transaction flags for transaction related events. 189 190SEE ALSO 191-------- 192linkperf:perf-stat[1], linkperf:perf-list[1] 193