1perf-stat(1)
2============
3
4NAME
5----
6perf-stat - Run a command and gather performance counter statistics
7
8SYNOPSIS
9--------
10[verse]
11'perf stat' [-e <EVENT> | --event=EVENT] [-a] <command>
12'perf stat' [-e <EVENT> | --event=EVENT] [-a] -- <command> [<options>]
13
14DESCRIPTION
15-----------
16This command runs a command and gathers performance counter statistics
17from it.
18
19
20OPTIONS
21-------
22<command>...::
23	Any command you can specify in a shell.
24
25
26-e::
27--event=::
28	Select the PMU event. Selection can be a symbolic event name
29	(use 'perf list' to list all events) or a raw PMU
30	event (eventsel+umask) in the form of rNNN where NNN is a
31	 hexadecimal event descriptor.
32
33-i::
34--no-inherit::
35        child tasks do not inherit counters
36-p::
37--pid=<pid>::
38        stat events on existing process id
39
40-t::
41--tid=<tid>::
42        stat events on existing thread id
43
44
45-a::
46--all-cpus::
47        system-wide collection from all CPUs
48
49-c::
50--scale::
51	scale/normalize counter values
52
53-r::
54--repeat=<n>::
55	repeat command and print average + stddev (max: 100)
56
57-B::
58--big-num::
59        print large numbers with thousands' separators according to locale
60
61-C::
62--cpu=::
63Count only on the list of CPUs provided. Multiple CPUs can be provided as a
64comma-separated list with no space: 0,1. Ranges of CPUs are specified with -: 0-2.
65In per-thread mode, this option is ignored. The -a option is still necessary
66to activate system-wide monitoring. Default is to count on all CPUs.
67
68-A::
69--no-aggr::
70Do not aggregate counts across all monitored CPUs in system-wide mode (-a).
71This option is only valid in system-wide mode.
72
73-n::
74--null::
75        null run - don't start any counters
76
77-v::
78--verbose::
79        be more verbose (show counter open errors, etc)
80
81-x SEP::
82--field-separator SEP::
83print counts using a CSV-style output to make it easy to import directly into
84spreadsheets. Columns are separated by the string specified in SEP.
85
86-G name::
87--cgroup name::
88monitor only in the container (cgroup) called "name". This option is available only
89in per-cpu mode. The cgroup filesystem must be mounted. All threads belonging to
90container "name" are monitored when they run on the monitored CPUs. Multiple cgroups
91can be provided. Each cgroup is applied to the corresponding event, i.e., first cgroup
92to first event, second cgroup to second event and so on. It is possible to provide
93an empty cgroup (monitor all the time) using, e.g., -G foo,,bar. Cgroups must have
94corresponding events, i.e., they always refer to events defined earlier on the command
95line.
96
97EXAMPLES
98--------
99
100$ perf stat -- make -j
101
102 Performance counter stats for 'make -j':
103
104    8117.370256  task clock ticks     #      11.281 CPU utilization factor
105            678  context switches     #       0.000 M/sec
106            133  CPU migrations       #       0.000 M/sec
107         235724  pagefaults           #       0.029 M/sec
108    24821162526  CPU cycles           #    3057.784 M/sec
109    18687303457  instructions         #    2302.138 M/sec
110      172158895  cache references     #      21.209 M/sec
111       27075259  cache misses         #       3.335 M/sec
112
113 Wall-clock time elapsed:   719.554352 msecs
114
115SEE ALSO
116--------
117linkperf:perf-top[1], linkperf:perf-list[1]
118