perf_counter tools: Reduce perf stat measurement overhead/skew
[deliverable/linux.git] / tools / perf / builtin-stat.c
CommitLineData
ddcacfa0 1/*
bf9e1876
IM
2 * builtin-stat.c
3 *
4 * Builtin stat command: Give a precise performance counters summary
5 * overview about any workload, CPU or specific PID.
6 *
7 * Sample output:
ddcacfa0 8
bf9e1876
IM
9 $ perf stat ~/hackbench 10
10 Time: 0.104
ddcacfa0 11
bf9e1876 12 Performance counter stats for '/home/mingo/hackbench':
ddcacfa0 13
bf9e1876
IM
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
ddcacfa0 22
bf9e1876 23 Wall-clock time elapsed: 123.786620 msecs
ddcacfa0 24
5242519b
IM
25 *
26 * Copyright (C) 2008, Red Hat Inc, Ingo Molnar <mingo@redhat.com>
27 *
28 * Improvements and fixes by:
29 *
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>
6e750a8f 35 * Jaswinder Singh Rajput <jaswinder@kernel.org>
5242519b
IM
36 *
37 * Released under the GPL v2. (and only v2, not any later version)
ddcacfa0
IM
38 */
39
1a482f38 40#include "perf.h"
16f762a2 41#include "builtin.h"
148be2c1 42#include "util/util.h"
5242519b
IM
43#include "util/parse-options.h"
44#include "util/parse-events.h"
ddcacfa0 45
ddcacfa0 46#include <sys/prctl.h>
42202dd5 47#include <math.h>
16c8a109 48
c3043569 49static struct perf_counter_attr default_attrs[] = {
ddcacfa0 50
f4dbfa8f
PZ
51 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_TASK_CLOCK },
52 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_CONTEXT_SWITCHES},
53 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_CPU_MIGRATIONS },
54 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_PAGE_FAULTS },
55
56 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_CPU_CYCLES },
57 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_INSTRUCTIONS },
58 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_CACHE_REFERENCES},
59 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_CACHE_MISSES },
60
ddcacfa0 61};
5242519b 62
3d632595
JSR
63#define MAX_RUN 100
64
a21ca2ca 65static int system_wide = 0;
743ee1f8 66static int verbose = 0;
ddcacfa0 67static int nr_cpus = 0;
3d632595 68static int run_idx = 0;
ddcacfa0 69
3d632595
JSR
70static int run_count = 1;
71static int inherit = 1;
66cf7829 72static int scale = 1;
3d632595 73static int target_pid = -1;
0cfb7a13 74static int null_run = 0;
ddcacfa0 75
3d632595 76static int fd[MAX_NR_CPUS][MAX_COUNTERS];
42202dd5 77
9cffa8d5
PM
78static u64 runtime_nsecs[MAX_RUN];
79static u64 walltime_nsecs[MAX_RUN];
80static u64 runtime_cycles[MAX_RUN];
42202dd5 81
3d632595
JSR
82static u64 event_res[MAX_RUN][MAX_COUNTERS][3];
83static u64 event_scaled[MAX_RUN][MAX_COUNTERS];
84
9cffa8d5
PM
85static u64 event_res_avg[MAX_COUNTERS][3];
86static u64 event_res_noise[MAX_COUNTERS][3];
42202dd5 87
9cffa8d5 88static u64 event_scaled_avg[MAX_COUNTERS];
42202dd5 89
9cffa8d5
PM
90static u64 runtime_nsecs_avg;
91static u64 runtime_nsecs_noise;
42202dd5 92
9cffa8d5
PM
93static u64 walltime_nsecs_avg;
94static u64 walltime_nsecs_noise;
42202dd5 95
9cffa8d5
PM
96static u64 runtime_cycles_avg;
97static u64 runtime_cycles_noise;
be1ac0d8 98
cca03c0a
JSR
99#define ERR_PERF_OPEN \
100"Error: counter %d, sys_perf_counter_open() syscall returned with %d (%s)\n"
101
051ae7f7 102static void create_perf_stat_counter(int counter, int pid)
ddcacfa0 103{
a21ca2ca 104 struct perf_counter_attr *attr = attrs + counter;
16c8a109 105
ddcacfa0 106 if (scale)
a21ca2ca
IM
107 attr->read_format = PERF_FORMAT_TOTAL_TIME_ENABLED |
108 PERF_FORMAT_TOTAL_TIME_RUNNING;
ddcacfa0
IM
109
110 if (system_wide) {
111 int cpu;
cca03c0a 112 for (cpu = 0; cpu < nr_cpus; cpu++) {
a21ca2ca 113 fd[cpu][counter] = sys_perf_counter_open(attr, -1, cpu, -1, 0);
cca03c0a
JSR
114 if (fd[cpu][counter] < 0 && verbose)
115 fprintf(stderr, ERR_PERF_OPEN, counter,
116 fd[cpu][counter], strerror(errno));
ddcacfa0
IM
117 }
118 } else {
a21ca2ca
IM
119 attr->inherit = inherit;
120 attr->disabled = 1;
ddcacfa0 121
051ae7f7 122 fd[0][counter] = sys_perf_counter_open(attr, pid, -1, -1, 0);
cca03c0a
JSR
123 if (fd[0][counter] < 0 && verbose)
124 fprintf(stderr, ERR_PERF_OPEN, counter,
125 fd[0][counter], strerror(errno));
ddcacfa0
IM
126 }
127}
128
c04f5e5d
IM
129/*
130 * Does the counter have nsecs as a unit?
131 */
132static inline int nsec_counter(int counter)
133{
a21ca2ca
IM
134 if (attrs[counter].type != PERF_TYPE_SOFTWARE)
135 return 0;
136
f4dbfa8f 137 if (attrs[counter].config == PERF_COUNT_SW_CPU_CLOCK)
c04f5e5d 138 return 1;
a21ca2ca 139
f4dbfa8f 140 if (attrs[counter].config == PERF_COUNT_SW_TASK_CLOCK)
c04f5e5d
IM
141 return 1;
142
143 return 0;
144}
145
146/*
2996f5dd 147 * Read out the results of a single counter:
c04f5e5d 148 */
2996f5dd 149static void read_counter(int counter)
c04f5e5d 150{
9cffa8d5 151 u64 *count, single_count[3];
c04f5e5d
IM
152 ssize_t res;
153 int cpu, nv;
154 int scaled;
155
42202dd5 156 count = event_res[run_idx][counter];
2996f5dd 157
c04f5e5d 158 count[0] = count[1] = count[2] = 0;
2996f5dd 159
c04f5e5d 160 nv = scale ? 3 : 1;
cca03c0a 161 for (cpu = 0; cpu < nr_cpus; cpu++) {
743ee1f8
IM
162 if (fd[cpu][counter] < 0)
163 continue;
164
9cffa8d5
PM
165 res = read(fd[cpu][counter], single_count, nv * sizeof(u64));
166 assert(res == nv * sizeof(u64));
42202dd5
IM
167 close(fd[cpu][counter]);
168 fd[cpu][counter] = -1;
c04f5e5d
IM
169
170 count[0] += single_count[0];
171 if (scale) {
172 count[1] += single_count[1];
173 count[2] += single_count[2];
174 }
175 }
176
177 scaled = 0;
178 if (scale) {
179 if (count[2] == 0) {
42202dd5 180 event_scaled[run_idx][counter] = -1;
2996f5dd 181 count[0] = 0;
c04f5e5d
IM
182 return;
183 }
2996f5dd 184
c04f5e5d 185 if (count[2] < count[1]) {
42202dd5 186 event_scaled[run_idx][counter] = 1;
c04f5e5d
IM
187 count[0] = (unsigned long long)
188 ((double)count[0] * count[1] / count[2] + 0.5);
189 }
190 }
be1ac0d8
IM
191 /*
192 * Save the full runtime - to allow normalization during printout:
193 */
a21ca2ca 194 if (attrs[counter].type == PERF_TYPE_SOFTWARE &&
f4dbfa8f 195 attrs[counter].config == PERF_COUNT_SW_TASK_CLOCK)
42202dd5 196 runtime_nsecs[run_idx] = count[0];
e779898a 197 if (attrs[counter].type == PERF_TYPE_HARDWARE &&
f4dbfa8f 198 attrs[counter].config == PERF_COUNT_HW_CPU_CYCLES)
42202dd5 199 runtime_cycles[run_idx] = count[0];
2996f5dd
IM
200}
201
42202dd5
IM
202static int run_perf_stat(int argc, const char **argv)
203{
204 unsigned long long t0, t1;
205 int status = 0;
206 int counter;
207 int pid;
051ae7f7
PM
208 int child_ready_pipe[2], go_pipe[2];
209 char buf;
42202dd5
IM
210
211 if (!system_wide)
212 nr_cpus = 1;
213
051ae7f7
PM
214 if (pipe(child_ready_pipe) < 0 || pipe(go_pipe) < 0) {
215 perror("failed to create pipes");
216 exit(1);
217 }
218
219 if ((pid = fork()) < 0)
220 perror("failed to fork");
221
222 if (!pid) {
223 close(child_ready_pipe[0]);
224 close(go_pipe[1]);
225 fcntl(go_pipe[0], F_SETFD, FD_CLOEXEC);
226
227 /*
228 * Do a dummy execvp to get the PLT entry resolved,
229 * so we avoid the resolver overhead on the real
230 * execvp call.
231 */
232 execvp("", (char **)argv);
233
234 /*
235 * Tell the parent we're ready to go
236 */
237 close(child_ready_pipe[1]);
238
239 /*
240 * Wait until the parent tells us to go.
241 */
242 read(go_pipe[0], &buf, 1);
243
244 execvp(argv[0], (char **)argv);
245
246 perror(argv[0]);
247 exit(-1);
248 }
249
250 /*
251 * Wait for the child to be ready to exec.
252 */
253 close(child_ready_pipe[1]);
254 close(go_pipe[0]);
255 read(child_ready_pipe[0], &buf, 1);
256 close(child_ready_pipe[0]);
257
42202dd5 258 for (counter = 0; counter < nr_counters; counter++)
051ae7f7 259 create_perf_stat_counter(counter, pid);
42202dd5
IM
260
261 /*
262 * Enable counters and exec the command:
263 */
264 t0 = rdclock();
265 prctl(PR_TASK_PERF_COUNTERS_ENABLE);
266
051ae7f7 267 close(go_pipe[1]);
42202dd5
IM
268 wait(&status);
269
42202dd5
IM
270 t1 = rdclock();
271
272 walltime_nsecs[run_idx] = t1 - t0;
273
274 for (counter = 0; counter < nr_counters; counter++)
275 read_counter(counter);
276
277 return WEXITSTATUS(status);
278}
279
9cffa8d5 280static void print_noise(u64 *count, u64 *noise)
42202dd5
IM
281{
282 if (run_count > 1)
283 fprintf(stderr, " ( +- %7.3f%% )",
284 (double)noise[0]/(count[0]+1)*100.0);
285}
286
9cffa8d5 287static void nsec_printout(int counter, u64 *count, u64 *noise)
44175b6f
IM
288{
289 double msecs = (double)count[0] / 1000000;
290
6e750a8f 291 fprintf(stderr, " %14.6f %-24s", msecs, event_name(counter));
44175b6f
IM
292
293 if (attrs[counter].type == PERF_TYPE_SOFTWARE &&
294 attrs[counter].config == PERF_COUNT_SW_TASK_CLOCK) {
295
42202dd5
IM
296 if (walltime_nsecs_avg)
297 fprintf(stderr, " # %10.3f CPUs ",
298 (double)count[0] / (double)walltime_nsecs_avg);
44175b6f 299 }
42202dd5 300 print_noise(count, noise);
44175b6f
IM
301}
302
9cffa8d5 303static void abs_printout(int counter, u64 *count, u64 *noise)
44175b6f 304{
6e750a8f 305 fprintf(stderr, " %14Ld %-24s", count[0], event_name(counter));
44175b6f 306
42202dd5 307 if (runtime_cycles_avg &&
44175b6f
IM
308 attrs[counter].type == PERF_TYPE_HARDWARE &&
309 attrs[counter].config == PERF_COUNT_HW_INSTRUCTIONS) {
310
42202dd5
IM
311 fprintf(stderr, " # %10.3f IPC ",
312 (double)count[0] / (double)runtime_cycles_avg);
313 } else {
314 if (runtime_nsecs_avg) {
315 fprintf(stderr, " # %10.3f M/sec",
316 (double)count[0]/runtime_nsecs_avg*1000.0);
317 }
44175b6f 318 }
42202dd5 319 print_noise(count, noise);
44175b6f
IM
320}
321
2996f5dd
IM
322/*
323 * Print out the results of a single counter:
324 */
325static void print_counter(int counter)
326{
9cffa8d5 327 u64 *count, *noise;
2996f5dd
IM
328 int scaled;
329
42202dd5
IM
330 count = event_res_avg[counter];
331 noise = event_res_noise[counter];
332 scaled = event_scaled_avg[counter];
2996f5dd
IM
333
334 if (scaled == -1) {
6e750a8f 335 fprintf(stderr, " %14s %-24s\n",
2996f5dd
IM
336 "<not counted>", event_name(counter));
337 return;
338 }
c04f5e5d 339
44175b6f 340 if (nsec_counter(counter))
42202dd5 341 nsec_printout(counter, count, noise);
44175b6f 342 else
42202dd5 343 abs_printout(counter, count, noise);
d7c29318 344
c04f5e5d 345 if (scaled)
210ad39f
IM
346 fprintf(stderr, " (scaled from %.2f%%)",
347 (double) count[2] / count[1] * 100);
44175b6f 348
c04f5e5d
IM
349 fprintf(stderr, "\n");
350}
351
42202dd5 352/*
ef281a19 353 * normalize_noise noise values down to stddev:
42202dd5 354 */
9cffa8d5 355static void normalize_noise(u64 *val)
ddcacfa0 356{
42202dd5 357 double res;
ddcacfa0 358
42202dd5 359 res = (double)*val / (run_count * sqrt((double)run_count));
ddcacfa0 360
9cffa8d5 361 *val = (u64)res;
42202dd5 362}
ddcacfa0 363
9cffa8d5 364static void update_avg(const char *name, int idx, u64 *avg, u64 *val)
ef281a19
IM
365{
366 *avg += *val;
367
368 if (verbose > 1)
369 fprintf(stderr, "debug: %20s[%d]: %Ld\n", name, idx, *val);
370}
42202dd5
IM
371/*
372 * Calculate the averages and noises:
373 */
374static void calc_avg(void)
375{
376 int i, j;
377
ef281a19
IM
378 if (verbose > 1)
379 fprintf(stderr, "\n");
380
42202dd5 381 for (i = 0; i < run_count; i++) {
ef281a19
IM
382 update_avg("runtime", 0, &runtime_nsecs_avg, runtime_nsecs + i);
383 update_avg("walltime", 0, &walltime_nsecs_avg, walltime_nsecs + i);
384 update_avg("runtime_cycles", 0, &runtime_cycles_avg, runtime_cycles + i);
42202dd5
IM
385
386 for (j = 0; j < nr_counters; j++) {
ef281a19
IM
387 update_avg("counter/0", j,
388 event_res_avg[j]+0, event_res[i][j]+0);
389 update_avg("counter/1", j,
390 event_res_avg[j]+1, event_res[i][j]+1);
391 update_avg("counter/2", j,
392 event_res_avg[j]+2, event_res[i][j]+2);
566747e6
IM
393 if (event_scaled[i][j] != -1)
394 update_avg("scaled", j,
395 event_scaled_avg + j, event_scaled[i]+j);
396 else
397 event_scaled_avg[j] = -1;
42202dd5
IM
398 }
399 }
400 runtime_nsecs_avg /= run_count;
401 walltime_nsecs_avg /= run_count;
402 runtime_cycles_avg /= run_count;
403
404 for (j = 0; j < nr_counters; j++) {
405 event_res_avg[j][0] /= run_count;
406 event_res_avg[j][1] /= run_count;
407 event_res_avg[j][2] /= run_count;
408 }
44db76c8 409
42202dd5
IM
410 for (i = 0; i < run_count; i++) {
411 runtime_nsecs_noise +=
9cffa8d5 412 abs((s64)(runtime_nsecs[i] - runtime_nsecs_avg));
42202dd5 413 walltime_nsecs_noise +=
9cffa8d5 414 abs((s64)(walltime_nsecs[i] - walltime_nsecs_avg));
42202dd5 415 runtime_cycles_noise +=
9cffa8d5 416 abs((s64)(runtime_cycles[i] - runtime_cycles_avg));
42202dd5
IM
417
418 for (j = 0; j < nr_counters; j++) {
419 event_res_noise[j][0] +=
9cffa8d5 420 abs((s64)(event_res[i][j][0] - event_res_avg[j][0]));
42202dd5 421 event_res_noise[j][1] +=
9cffa8d5 422 abs((s64)(event_res[i][j][1] - event_res_avg[j][1]));
42202dd5 423 event_res_noise[j][2] +=
9cffa8d5 424 abs((s64)(event_res[i][j][2] - event_res_avg[j][2]));
ddcacfa0
IM
425 }
426 }
44db76c8 427
ef281a19
IM
428 normalize_noise(&runtime_nsecs_noise);
429 normalize_noise(&walltime_nsecs_noise);
430 normalize_noise(&runtime_cycles_noise);
44db76c8 431
42202dd5 432 for (j = 0; j < nr_counters; j++) {
ef281a19
IM
433 normalize_noise(&event_res_noise[j][0]);
434 normalize_noise(&event_res_noise[j][1]);
435 normalize_noise(&event_res_noise[j][2]);
42202dd5
IM
436 }
437}
438
439static void print_stat(int argc, const char **argv)
440{
441 int i, counter;
442
443 calc_avg();
ddcacfa0
IM
444
445 fflush(stdout);
446
447 fprintf(stderr, "\n");
44db76c8
IM
448 fprintf(stderr, " Performance counter stats for \'%s", argv[0]);
449
450 for (i = 1; i < argc; i++)
451 fprintf(stderr, " %s", argv[i]);
452
42202dd5
IM
453 fprintf(stderr, "\'");
454 if (run_count > 1)
455 fprintf(stderr, " (%d runs)", run_count);
456 fprintf(stderr, ":\n\n");
2996f5dd 457
c04f5e5d
IM
458 for (counter = 0; counter < nr_counters; counter++)
459 print_counter(counter);
ddcacfa0 460
ddcacfa0 461 fprintf(stderr, "\n");
566747e6 462 fprintf(stderr, " %14.9f seconds time elapsed",
42202dd5 463 (double)walltime_nsecs_avg/1e9);
566747e6
IM
464 if (run_count > 1) {
465 fprintf(stderr, " ( +- %7.3f%% )",
466 100.0*(double)walltime_nsecs_noise/(double)walltime_nsecs_avg);
467 }
468 fprintf(stderr, "\n\n");
ddcacfa0
IM
469}
470
f7b7c26e
PZ
471static volatile int signr = -1;
472
5242519b 473static void skip_signal(int signo)
ddcacfa0 474{
f7b7c26e
PZ
475 signr = signo;
476}
477
478static void sig_atexit(void)
479{
480 if (signr == -1)
481 return;
482
483 signal(signr, SIG_DFL);
484 kill(getpid(), signr);
5242519b
IM
485}
486
487static const char * const stat_usage[] = {
488 "perf stat [<options>] <command>",
489 NULL
490};
491
5242519b
IM
492static const struct option options[] = {
493 OPT_CALLBACK('e', "event", NULL, "event",
86847b62
TG
494 "event selector. use 'perf list' to list available events",
495 parse_events),
5242519b
IM
496 OPT_BOOLEAN('i', "inherit", &inherit,
497 "child tasks inherit counters"),
498 OPT_INTEGER('p', "pid", &target_pid,
499 "stat events on existing pid"),
500 OPT_BOOLEAN('a', "all-cpus", &system_wide,
3d632595 501 "system-wide collection from all CPUs"),
86847b62 502 OPT_BOOLEAN('S', "scale", &scale,
3d632595 503 "scale/normalize counters"),
743ee1f8
IM
504 OPT_BOOLEAN('v', "verbose", &verbose,
505 "be more verbose (show counter open errors, etc)"),
42202dd5
IM
506 OPT_INTEGER('r', "repeat", &run_count,
507 "repeat command and print average + stddev (max: 100)"),
0cfb7a13
IM
508 OPT_BOOLEAN('n', "null", &null_run,
509 "null run - dont start any counters"),
5242519b
IM
510 OPT_END()
511};
512
513int cmd_stat(int argc, const char **argv, const char *prefix)
514{
42202dd5
IM
515 int status;
516
5242519b
IM
517 argc = parse_options(argc, argv, options, stat_usage, 0);
518 if (!argc)
519 usage_with_options(stat_usage, options);
42202dd5
IM
520 if (run_count <= 0 || run_count > MAX_RUN)
521 usage_with_options(stat_usage, options);
ddcacfa0 522
c3043569
JSR
523 /* Set attrs and nr_counters if no event is selected and !null_run */
524 if (!null_run && !nr_counters) {
525 memcpy(attrs, default_attrs, sizeof(default_attrs));
526 nr_counters = ARRAY_SIZE(default_attrs);
527 }
ddcacfa0 528
ddcacfa0
IM
529 nr_cpus = sysconf(_SC_NPROCESSORS_ONLN);
530 assert(nr_cpus <= MAX_NR_CPUS);
531 assert(nr_cpus >= 0);
532
58d7e993
IM
533 /*
534 * We dont want to block the signals - that would cause
535 * child tasks to inherit that and Ctrl-C would not work.
536 * What we want is for Ctrl-C to work in the exec()-ed
537 * task, but being ignored by perf stat itself:
538 */
f7b7c26e 539 atexit(sig_atexit);
58d7e993
IM
540 signal(SIGINT, skip_signal);
541 signal(SIGALRM, skip_signal);
542 signal(SIGABRT, skip_signal);
543
42202dd5
IM
544 status = 0;
545 for (run_idx = 0; run_idx < run_count; run_idx++) {
546 if (run_count != 1 && verbose)
3d632595 547 fprintf(stderr, "[ perf stat: executing run #%d ... ]\n", run_idx + 1);
42202dd5
IM
548 status = run_perf_stat(argc, argv);
549 }
550
551 print_stat(argc, argv);
552
553 return status;
ddcacfa0 554}
This page took 0.082504 seconds and 5 git commands to generate.