perf tools: Librarize sample type and attr finding from headers
[GitHub/mt8127/android_kernel_alcatel_ttab.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;
f37a291c 66static unsigned int nr_cpus = 0;
3d632595 67static int run_idx = 0;
ddcacfa0 68
3d632595
JSR
69static int run_count = 1;
70static int inherit = 1;
66cf7829 71static int scale = 1;
3d632595 72static int target_pid = -1;
0cfb7a13 73static int null_run = 0;
ddcacfa0 74
3d632595 75static int fd[MAX_NR_CPUS][MAX_COUNTERS];
42202dd5 76
9cffa8d5
PM
77static u64 runtime_nsecs[MAX_RUN];
78static u64 walltime_nsecs[MAX_RUN];
79static u64 runtime_cycles[MAX_RUN];
42202dd5 80
3d632595
JSR
81static u64 event_res[MAX_RUN][MAX_COUNTERS][3];
82static u64 event_scaled[MAX_RUN][MAX_COUNTERS];
83
9cffa8d5
PM
84static u64 event_res_avg[MAX_COUNTERS][3];
85static u64 event_res_noise[MAX_COUNTERS][3];
42202dd5 86
9cffa8d5 87static u64 event_scaled_avg[MAX_COUNTERS];
42202dd5 88
9cffa8d5
PM
89static u64 runtime_nsecs_avg;
90static u64 runtime_nsecs_noise;
42202dd5 91
9cffa8d5
PM
92static u64 walltime_nsecs_avg;
93static u64 walltime_nsecs_noise;
42202dd5 94
9cffa8d5
PM
95static u64 runtime_cycles_avg;
96static u64 runtime_cycles_noise;
be1ac0d8 97
b9ebdcc0
JSR
98#define MATCH_EVENT(t, c, counter) \
99 (attrs[counter].type == PERF_TYPE_##t && \
100 attrs[counter].config == PERF_COUNT_##c)
101
cca03c0a
JSR
102#define ERR_PERF_OPEN \
103"Error: counter %d, sys_perf_counter_open() syscall returned with %d (%s)\n"
104
051ae7f7 105static void create_perf_stat_counter(int counter, int pid)
ddcacfa0 106{
a21ca2ca 107 struct perf_counter_attr *attr = attrs + counter;
16c8a109 108
ddcacfa0 109 if (scale)
a21ca2ca
IM
110 attr->read_format = PERF_FORMAT_TOTAL_TIME_ENABLED |
111 PERF_FORMAT_TOTAL_TIME_RUNNING;
ddcacfa0
IM
112
113 if (system_wide) {
f37a291c
IM
114 unsigned int cpu;
115
cca03c0a 116 for (cpu = 0; cpu < nr_cpus; cpu++) {
a21ca2ca 117 fd[cpu][counter] = sys_perf_counter_open(attr, -1, cpu, -1, 0);
cca03c0a
JSR
118 if (fd[cpu][counter] < 0 && verbose)
119 fprintf(stderr, ERR_PERF_OPEN, counter,
120 fd[cpu][counter], strerror(errno));
ddcacfa0
IM
121 }
122 } else {
57e7986e
PM
123 attr->inherit = inherit;
124 attr->disabled = 1;
125 attr->enable_on_exec = 1;
ddcacfa0 126
051ae7f7 127 fd[0][counter] = sys_perf_counter_open(attr, pid, -1, -1, 0);
cca03c0a
JSR
128 if (fd[0][counter] < 0 && verbose)
129 fprintf(stderr, ERR_PERF_OPEN, counter,
130 fd[0][counter], strerror(errno));
ddcacfa0
IM
131 }
132}
133
c04f5e5d
IM
134/*
135 * Does the counter have nsecs as a unit?
136 */
137static inline int nsec_counter(int counter)
138{
b9ebdcc0
JSR
139 if (MATCH_EVENT(SOFTWARE, SW_CPU_CLOCK, counter) ||
140 MATCH_EVENT(SOFTWARE, SW_TASK_CLOCK, counter))
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];
f37a291c
IM
152 unsigned int cpu;
153 size_t res, nv;
c04f5e5d
IM
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));
f37a291c 167
42202dd5
IM
168 close(fd[cpu][counter]);
169 fd[cpu][counter] = -1;
c04f5e5d
IM
170
171 count[0] += single_count[0];
172 if (scale) {
173 count[1] += single_count[1];
174 count[2] += single_count[2];
175 }
176 }
177
178 scaled = 0;
179 if (scale) {
180 if (count[2] == 0) {
42202dd5 181 event_scaled[run_idx][counter] = -1;
2996f5dd 182 count[0] = 0;
c04f5e5d
IM
183 return;
184 }
2996f5dd 185
c04f5e5d 186 if (count[2] < count[1]) {
42202dd5 187 event_scaled[run_idx][counter] = 1;
c04f5e5d
IM
188 count[0] = (unsigned long long)
189 ((double)count[0] * count[1] / count[2] + 0.5);
190 }
191 }
be1ac0d8
IM
192 /*
193 * Save the full runtime - to allow normalization during printout:
194 */
b9ebdcc0 195 if (MATCH_EVENT(SOFTWARE, SW_TASK_CLOCK, counter))
42202dd5 196 runtime_nsecs[run_idx] = count[0];
b9ebdcc0 197 if (MATCH_EVENT(HARDWARE, HW_CPU_CYCLES, counter))
42202dd5 198 runtime_cycles[run_idx] = count[0];
2996f5dd
IM
199}
200
f37a291c 201static int run_perf_stat(int argc __used, const char **argv)
42202dd5
IM
202{
203 unsigned long long t0, t1;
204 int status = 0;
205 int counter;
206 int pid;
051ae7f7
PM
207 int child_ready_pipe[2], go_pipe[2];
208 char buf;
42202dd5
IM
209
210 if (!system_wide)
211 nr_cpus = 1;
212
051ae7f7
PM
213 if (pipe(child_ready_pipe) < 0 || pipe(go_pipe) < 0) {
214 perror("failed to create pipes");
215 exit(1);
216 }
217
218 if ((pid = fork()) < 0)
219 perror("failed to fork");
220
221 if (!pid) {
222 close(child_ready_pipe[0]);
223 close(go_pipe[1]);
224 fcntl(go_pipe[0], F_SETFD, FD_CLOEXEC);
225
226 /*
227 * Do a dummy execvp to get the PLT entry resolved,
228 * so we avoid the resolver overhead on the real
229 * execvp call.
230 */
231 execvp("", (char **)argv);
232
233 /*
234 * Tell the parent we're ready to go
235 */
236 close(child_ready_pipe[1]);
237
238 /*
239 * Wait until the parent tells us to go.
240 */
a92bef0f
FW
241 if (read(go_pipe[0], &buf, 1) == -1)
242 perror("unable to read pipe");
051ae7f7
PM
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]);
a92bef0f
FW
255 if (read(child_ready_pipe[0], &buf, 1) == -1)
256 perror("unable to read pipe");
051ae7f7
PM
257 close(child_ready_pipe[0]);
258
42202dd5 259 for (counter = 0; counter < nr_counters; counter++)
051ae7f7 260 create_perf_stat_counter(counter, pid);
42202dd5
IM
261
262 /*
263 * Enable counters and exec the command:
264 */
265 t0 = rdclock();
42202dd5 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 292
b9ebdcc0 293 if (MATCH_EVENT(SOFTWARE, SW_TASK_CLOCK, counter)) {
42202dd5
IM
294 if (walltime_nsecs_avg)
295 fprintf(stderr, " # %10.3f CPUs ",
296 (double)count[0] / (double)walltime_nsecs_avg);
44175b6f 297 }
42202dd5 298 print_noise(count, noise);
44175b6f
IM
299}
300
9cffa8d5 301static void abs_printout(int counter, u64 *count, u64 *noise)
44175b6f 302{
6e750a8f 303 fprintf(stderr, " %14Ld %-24s", count[0], event_name(counter));
44175b6f 304
42202dd5 305 if (runtime_cycles_avg &&
b9ebdcc0 306 MATCH_EVENT(HARDWARE, HW_INSTRUCTIONS, counter)) {
42202dd5
IM
307 fprintf(stderr, " # %10.3f IPC ",
308 (double)count[0] / (double)runtime_cycles_avg);
309 } else {
310 if (runtime_nsecs_avg) {
311 fprintf(stderr, " # %10.3f M/sec",
312 (double)count[0]/runtime_nsecs_avg*1000.0);
313 }
44175b6f 314 }
42202dd5 315 print_noise(count, noise);
44175b6f
IM
316}
317
2996f5dd
IM
318/*
319 * Print out the results of a single counter:
320 */
321static void print_counter(int counter)
322{
9cffa8d5 323 u64 *count, *noise;
2996f5dd
IM
324 int scaled;
325
42202dd5
IM
326 count = event_res_avg[counter];
327 noise = event_res_noise[counter];
328 scaled = event_scaled_avg[counter];
2996f5dd
IM
329
330 if (scaled == -1) {
6e750a8f 331 fprintf(stderr, " %14s %-24s\n",
2996f5dd
IM
332 "<not counted>", event_name(counter));
333 return;
334 }
c04f5e5d 335
44175b6f 336 if (nsec_counter(counter))
42202dd5 337 nsec_printout(counter, count, noise);
44175b6f 338 else
42202dd5 339 abs_printout(counter, count, noise);
d7c29318 340
c04f5e5d 341 if (scaled)
210ad39f
IM
342 fprintf(stderr, " (scaled from %.2f%%)",
343 (double) count[2] / count[1] * 100);
44175b6f 344
c04f5e5d
IM
345 fprintf(stderr, "\n");
346}
347
42202dd5 348/*
ef281a19 349 * normalize_noise noise values down to stddev:
42202dd5 350 */
9cffa8d5 351static void normalize_noise(u64 *val)
ddcacfa0 352{
42202dd5 353 double res;
ddcacfa0 354
42202dd5 355 res = (double)*val / (run_count * sqrt((double)run_count));
ddcacfa0 356
9cffa8d5 357 *val = (u64)res;
42202dd5 358}
ddcacfa0 359
9cffa8d5 360static void update_avg(const char *name, int idx, u64 *avg, u64 *val)
ef281a19
IM
361{
362 *avg += *val;
363
364 if (verbose > 1)
365 fprintf(stderr, "debug: %20s[%d]: %Ld\n", name, idx, *val);
366}
42202dd5
IM
367/*
368 * Calculate the averages and noises:
369 */
370static void calc_avg(void)
371{
372 int i, j;
373
ef281a19
IM
374 if (verbose > 1)
375 fprintf(stderr, "\n");
376
42202dd5 377 for (i = 0; i < run_count; i++) {
ef281a19
IM
378 update_avg("runtime", 0, &runtime_nsecs_avg, runtime_nsecs + i);
379 update_avg("walltime", 0, &walltime_nsecs_avg, walltime_nsecs + i);
380 update_avg("runtime_cycles", 0, &runtime_cycles_avg, runtime_cycles + i);
42202dd5
IM
381
382 for (j = 0; j < nr_counters; j++) {
ef281a19
IM
383 update_avg("counter/0", j,
384 event_res_avg[j]+0, event_res[i][j]+0);
385 update_avg("counter/1", j,
386 event_res_avg[j]+1, event_res[i][j]+1);
387 update_avg("counter/2", j,
388 event_res_avg[j]+2, event_res[i][j]+2);
f37a291c 389 if (event_scaled[i][j] != (u64)-1)
566747e6
IM
390 update_avg("scaled", j,
391 event_scaled_avg + j, event_scaled[i]+j);
392 else
393 event_scaled_avg[j] = -1;
42202dd5
IM
394 }
395 }
396 runtime_nsecs_avg /= run_count;
397 walltime_nsecs_avg /= run_count;
398 runtime_cycles_avg /= run_count;
399
400 for (j = 0; j < nr_counters; j++) {
401 event_res_avg[j][0] /= run_count;
402 event_res_avg[j][1] /= run_count;
403 event_res_avg[j][2] /= run_count;
404 }
44db76c8 405
42202dd5
IM
406 for (i = 0; i < run_count; i++) {
407 runtime_nsecs_noise +=
9cffa8d5 408 abs((s64)(runtime_nsecs[i] - runtime_nsecs_avg));
42202dd5 409 walltime_nsecs_noise +=
9cffa8d5 410 abs((s64)(walltime_nsecs[i] - walltime_nsecs_avg));
42202dd5 411 runtime_cycles_noise +=
9cffa8d5 412 abs((s64)(runtime_cycles[i] - runtime_cycles_avg));
42202dd5
IM
413
414 for (j = 0; j < nr_counters; j++) {
415 event_res_noise[j][0] +=
9cffa8d5 416 abs((s64)(event_res[i][j][0] - event_res_avg[j][0]));
42202dd5 417 event_res_noise[j][1] +=
9cffa8d5 418 abs((s64)(event_res[i][j][1] - event_res_avg[j][1]));
42202dd5 419 event_res_noise[j][2] +=
9cffa8d5 420 abs((s64)(event_res[i][j][2] - event_res_avg[j][2]));
ddcacfa0
IM
421 }
422 }
44db76c8 423
ef281a19
IM
424 normalize_noise(&runtime_nsecs_noise);
425 normalize_noise(&walltime_nsecs_noise);
426 normalize_noise(&runtime_cycles_noise);
44db76c8 427
42202dd5 428 for (j = 0; j < nr_counters; j++) {
ef281a19
IM
429 normalize_noise(&event_res_noise[j][0]);
430 normalize_noise(&event_res_noise[j][1]);
431 normalize_noise(&event_res_noise[j][2]);
42202dd5
IM
432 }
433}
434
435static void print_stat(int argc, const char **argv)
436{
437 int i, counter;
438
439 calc_avg();
ddcacfa0
IM
440
441 fflush(stdout);
442
443 fprintf(stderr, "\n");
44db76c8
IM
444 fprintf(stderr, " Performance counter stats for \'%s", argv[0]);
445
446 for (i = 1; i < argc; i++)
447 fprintf(stderr, " %s", argv[i]);
448
42202dd5
IM
449 fprintf(stderr, "\'");
450 if (run_count > 1)
451 fprintf(stderr, " (%d runs)", run_count);
452 fprintf(stderr, ":\n\n");
2996f5dd 453
c04f5e5d
IM
454 for (counter = 0; counter < nr_counters; counter++)
455 print_counter(counter);
ddcacfa0 456
ddcacfa0 457 fprintf(stderr, "\n");
566747e6 458 fprintf(stderr, " %14.9f seconds time elapsed",
42202dd5 459 (double)walltime_nsecs_avg/1e9);
566747e6
IM
460 if (run_count > 1) {
461 fprintf(stderr, " ( +- %7.3f%% )",
462 100.0*(double)walltime_nsecs_noise/(double)walltime_nsecs_avg);
463 }
464 fprintf(stderr, "\n\n");
ddcacfa0
IM
465}
466
f7b7c26e
PZ
467static volatile int signr = -1;
468
5242519b 469static void skip_signal(int signo)
ddcacfa0 470{
f7b7c26e
PZ
471 signr = signo;
472}
473
474static void sig_atexit(void)
475{
476 if (signr == -1)
477 return;
478
479 signal(signr, SIG_DFL);
480 kill(getpid(), signr);
5242519b
IM
481}
482
483static const char * const stat_usage[] = {
484 "perf stat [<options>] <command>",
485 NULL
486};
487
5242519b
IM
488static const struct option options[] = {
489 OPT_CALLBACK('e', "event", NULL, "event",
86847b62
TG
490 "event selector. use 'perf list' to list available events",
491 parse_events),
5242519b
IM
492 OPT_BOOLEAN('i', "inherit", &inherit,
493 "child tasks inherit counters"),
494 OPT_INTEGER('p', "pid", &target_pid,
495 "stat events on existing pid"),
496 OPT_BOOLEAN('a', "all-cpus", &system_wide,
3d632595 497 "system-wide collection from all CPUs"),
b26bc5a7 498 OPT_BOOLEAN('c', "scale", &scale,
3d632595 499 "scale/normalize counters"),
743ee1f8
IM
500 OPT_BOOLEAN('v', "verbose", &verbose,
501 "be more verbose (show counter open errors, etc)"),
42202dd5
IM
502 OPT_INTEGER('r', "repeat", &run_count,
503 "repeat command and print average + stddev (max: 100)"),
0cfb7a13
IM
504 OPT_BOOLEAN('n', "null", &null_run,
505 "null run - dont start any counters"),
5242519b
IM
506 OPT_END()
507};
508
f37a291c 509int cmd_stat(int argc, const char **argv, const char *prefix __used)
5242519b 510{
42202dd5
IM
511 int status;
512
a0541234
AB
513 argc = parse_options(argc, argv, options, stat_usage,
514 PARSE_OPT_STOP_AT_NON_OPTION);
5242519b
IM
515 if (!argc)
516 usage_with_options(stat_usage, options);
42202dd5
IM
517 if (run_count <= 0 || run_count > MAX_RUN)
518 usage_with_options(stat_usage, options);
ddcacfa0 519
c3043569
JSR
520 /* Set attrs and nr_counters if no event is selected and !null_run */
521 if (!null_run && !nr_counters) {
522 memcpy(attrs, default_attrs, sizeof(default_attrs));
523 nr_counters = ARRAY_SIZE(default_attrs);
524 }
ddcacfa0 525
ddcacfa0
IM
526 nr_cpus = sysconf(_SC_NPROCESSORS_ONLN);
527 assert(nr_cpus <= MAX_NR_CPUS);
f37a291c 528 assert((int)nr_cpus >= 0);
ddcacfa0 529
58d7e993
IM
530 /*
531 * We dont want to block the signals - that would cause
532 * child tasks to inherit that and Ctrl-C would not work.
533 * What we want is for Ctrl-C to work in the exec()-ed
534 * task, but being ignored by perf stat itself:
535 */
f7b7c26e 536 atexit(sig_atexit);
58d7e993
IM
537 signal(SIGINT, skip_signal);
538 signal(SIGALRM, skip_signal);
539 signal(SIGABRT, skip_signal);
540
42202dd5
IM
541 status = 0;
542 for (run_idx = 0; run_idx < run_count; run_idx++) {
543 if (run_count != 1 && verbose)
3d632595 544 fprintf(stderr, "[ perf stat: executing run #%d ... ]\n", run_idx + 1);
42202dd5
IM
545 status = run_perf_stat(argc, argv);
546 }
547
548 print_stat(argc, argv);
549
550 return status;
ddcacfa0 551}