4 * Builtin stat command: Give a precise performance counters summary
5 * overview about any workload, CPU or specific PID.
9 $ perf stat ~/hackbench 10
12 Performance counter stats for '/home/mingo/hackbench':
14 1255.538611 task clock ticks # 10.143 CPU utilization factor
15 54011 context switches # 0.043 M/sec
16 385 CPU migrations # 0.000 M/sec
17 17755 pagefaults # 0.014 M/sec
18 3808323185 CPU cycles # 3033.219 M/sec
19 1575111190 instructions # 1254.530 M/sec
20 17367895 cache references # 13.833 M/sec
21 7674421 cache misses # 6.112 M/sec
23 Wall-clock time elapsed: 123.786620 msecs
26 * Copyright (C) 2008, Red Hat Inc, Ingo Molnar <mingo@redhat.com>
28 * Improvements and fixes by:
30 * Arjan van de Ven <arjan@linux.intel.com>
31 * Yanmin Zhang <yanmin.zhang@intel.com>
32 * Wu Fengguang <fengguang.wu@intel.com>
33 * Mike Galbraith <efault@gmx.de>
34 * Paul Mackerras <paulus@samba.org>
36 * Released under the GPL v2. (and only v2, not any later version)
41 #include "util/util.h"
42 #include "util/parse-options.h"
43 #include "util/parse-events.h"
45 #include <sys/prctl.h>
47 static struct perf_counter_attr default_attrs[MAX_COUNTERS] = {
49 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_TASK_CLOCK },
50 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_CONTEXT_SWITCHES },
51 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_CPU_MIGRATIONS },
52 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_PAGE_FAULTS },
54 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_CPU_CYCLES },
55 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_INSTRUCTIONS },
56 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_CACHE_REFERENCES },
57 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_CACHE_MISSES },
60 static int system_wide = 0;
61 static int inherit = 1;
62 static int verbose = 0;
64 static int fd[MAX_NR_CPUS][MAX_COUNTERS];
66 static int target_pid = -1;
67 static int nr_cpus = 0;
68 static unsigned int page_size;
72 static const unsigned int default_count[] = {
81 static __u64 event_res[MAX_COUNTERS][3];
82 static __u64 event_scaled[MAX_COUNTERS];
84 static __u64 runtime_nsecs;
85 static __u64 walltime_nsecs;
87 static void create_perf_stat_counter(int counter)
89 struct perf_counter_attr *attr = attrs + counter;
92 attr->read_format = PERF_FORMAT_TOTAL_TIME_ENABLED |
93 PERF_FORMAT_TOTAL_TIME_RUNNING;
97 for (cpu = 0; cpu < nr_cpus; cpu ++) {
98 fd[cpu][counter] = sys_perf_counter_open(attr, -1, cpu, -1, 0);
99 if (fd[cpu][counter] < 0 && verbose) {
100 printf("Error: counter %d, sys_perf_counter_open() syscall returned with %d (%s)\n", counter, fd[cpu][counter], strerror(errno));
104 attr->inherit = inherit;
107 fd[0][counter] = sys_perf_counter_open(attr, 0, -1, -1, 0);
108 if (fd[0][counter] < 0 && verbose) {
109 printf("Error: counter %d, sys_perf_counter_open() syscall returned with %d (%s)\n", counter, fd[0][counter], strerror(errno));
115 * Does the counter have nsecs as a unit?
117 static inline int nsec_counter(int counter)
119 if (attrs[counter].type != PERF_TYPE_SOFTWARE)
122 if (attrs[counter].config == PERF_COUNT_CPU_CLOCK)
125 if (attrs[counter].config == PERF_COUNT_TASK_CLOCK)
132 * Read out the results of a single counter:
134 static void read_counter(int counter)
136 __u64 *count, single_count[3];
141 count = event_res[counter];
143 count[0] = count[1] = count[2] = 0;
146 for (cpu = 0; cpu < nr_cpus; cpu ++) {
147 if (fd[cpu][counter] < 0)
150 res = read(fd[cpu][counter], single_count, nv * sizeof(__u64));
151 assert(res == nv * sizeof(__u64));
153 count[0] += single_count[0];
155 count[1] += single_count[1];
156 count[2] += single_count[2];
163 event_scaled[counter] = -1;
168 if (count[2] < count[1]) {
169 event_scaled[counter] = 1;
170 count[0] = (unsigned long long)
171 ((double)count[0] * count[1] / count[2] + 0.5);
175 * Save the full runtime - to allow normalization during printout:
177 if (attrs[counter].type == PERF_TYPE_SOFTWARE &&
178 attrs[counter].config == PERF_COUNT_TASK_CLOCK)
179 runtime_nsecs = count[0];
183 * Print out the results of a single counter:
185 static void print_counter(int counter)
190 count = event_res[counter];
191 scaled = event_scaled[counter];
194 fprintf(stderr, " %14s %-20s\n",
195 "<not counted>", event_name(counter));
199 if (nsec_counter(counter)) {
200 double msecs = (double)count[0] / 1000000;
202 fprintf(stderr, " %14.6f %-20s",
203 msecs, event_name(counter));
204 if (attrs[counter].type == PERF_TYPE_SOFTWARE &&
205 attrs[counter].config == PERF_COUNT_TASK_CLOCK) {
208 fprintf(stderr, " # %11.3f CPU utilization factor",
209 (double)count[0] / (double)walltime_nsecs);
212 fprintf(stderr, " %14Ld %-20s",
213 count[0], event_name(counter));
215 fprintf(stderr, " # %11.3f M/sec",
216 (double)count[0]/runtime_nsecs*1000.0);
219 fprintf(stderr, " (scaled from %.2f%%)",
220 (double) count[2] / count[1] * 100);
221 fprintf(stderr, "\n");
224 static int do_perf_stat(int argc, const char **argv)
226 unsigned long long t0, t1;
235 for (counter = 0; counter < nr_counters; counter++)
236 create_perf_stat_counter(counter);
239 * Enable counters and exec the command:
242 prctl(PR_TASK_PERF_COUNTERS_ENABLE);
244 if ((pid = fork()) < 0)
245 perror("failed to fork");
248 if (execvp(argv[0], (char **)argv)) {
254 while (wait(&status) >= 0)
257 prctl(PR_TASK_PERF_COUNTERS_DISABLE);
260 walltime_nsecs = t1 - t0;
264 fprintf(stderr, "\n");
265 fprintf(stderr, " Performance counter stats for \'%s", argv[0]);
267 for (i = 1; i < argc; i++)
268 fprintf(stderr, " %s", argv[i]);
270 fprintf(stderr, "\':\n");
271 fprintf(stderr, "\n");
273 for (counter = 0; counter < nr_counters; counter++)
274 read_counter(counter);
276 for (counter = 0; counter < nr_counters; counter++)
277 print_counter(counter);
280 fprintf(stderr, "\n");
281 fprintf(stderr, " Wall-clock time elapsed: %12.6f msecs\n",
282 (double)(t1-t0)/1e6);
283 fprintf(stderr, "\n");
288 static void skip_signal(int signo)
292 static const char * const stat_usage[] = {
293 "perf stat [<options>] <command>",
297 static const struct option options[] = {
298 OPT_CALLBACK('e', "event", NULL, "event",
299 "event selector. use 'perf list' to list available events",
301 OPT_BOOLEAN('i', "inherit", &inherit,
302 "child tasks inherit counters"),
303 OPT_INTEGER('p', "pid", &target_pid,
304 "stat events on existing pid"),
305 OPT_BOOLEAN('a', "all-cpus", &system_wide,
306 "system-wide collection from all CPUs"),
307 OPT_BOOLEAN('S', "scale", &scale,
308 "scale/normalize counters"),
309 OPT_BOOLEAN('v', "verbose", &verbose,
310 "be more verbose (show counter open errors, etc)"),
314 int cmd_stat(int argc, const char **argv, const char *prefix)
316 page_size = sysconf(_SC_PAGE_SIZE);
318 memcpy(attrs, default_attrs, sizeof(attrs));
320 argc = parse_options(argc, argv, options, stat_usage, 0);
322 usage_with_options(stat_usage, options);
327 nr_cpus = sysconf(_SC_NPROCESSORS_ONLN);
328 assert(nr_cpus <= MAX_NR_CPUS);
329 assert(nr_cpus >= 0);
332 * We dont want to block the signals - that would cause
333 * child tasks to inherit that and Ctrl-C would not work.
334 * What we want is for Ctrl-C to work in the exec()-ed
335 * task, but being ignored by perf stat itself:
337 signal(SIGINT, skip_signal);
338 signal(SIGALRM, skip_signal);
339 signal(SIGABRT, skip_signal);
341 return do_perf_stat(argc, argv);