]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - tools/perf/builtin-stat.c
perf report: Add debug help for the finding of symbol bugs - show the symtab origin...
[mirror_ubuntu-hirsute-kernel.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;
f37a291c 67static unsigned 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
b9ebdcc0
JSR
99#define MATCH_EVENT(t, c, counter) \
100 (attrs[counter].type == PERF_TYPE_##t && \
101 attrs[counter].config == PERF_COUNT_##c)
102
cca03c0a
JSR
103#define ERR_PERF_OPEN \
104"Error: counter %d, sys_perf_counter_open() syscall returned with %d (%s)\n"
105
051ae7f7 106static void create_perf_stat_counter(int counter, int pid)
ddcacfa0 107{
a21ca2ca 108 struct perf_counter_attr *attr = attrs + counter;
16c8a109 109
ddcacfa0 110 if (scale)
a21ca2ca
IM
111 attr->read_format = PERF_FORMAT_TOTAL_TIME_ENABLED |
112 PERF_FORMAT_TOTAL_TIME_RUNNING;
ddcacfa0
IM
113
114 if (system_wide) {
f37a291c
IM
115 unsigned int cpu;
116
cca03c0a 117 for (cpu = 0; cpu < nr_cpus; cpu++) {
a21ca2ca 118 fd[cpu][counter] = sys_perf_counter_open(attr, -1, cpu, -1, 0);
cca03c0a
JSR
119 if (fd[cpu][counter] < 0 && verbose)
120 fprintf(stderr, ERR_PERF_OPEN, counter,
121 fd[cpu][counter], strerror(errno));
ddcacfa0
IM
122 }
123 } else {
57e7986e
PM
124 attr->inherit = inherit;
125 attr->disabled = 1;
126 attr->enable_on_exec = 1;
ddcacfa0 127
051ae7f7 128 fd[0][counter] = sys_perf_counter_open(attr, pid, -1, -1, 0);
cca03c0a
JSR
129 if (fd[0][counter] < 0 && verbose)
130 fprintf(stderr, ERR_PERF_OPEN, counter,
131 fd[0][counter], strerror(errno));
ddcacfa0
IM
132 }
133}
134
c04f5e5d
IM
135/*
136 * Does the counter have nsecs as a unit?
137 */
138static inline int nsec_counter(int counter)
139{
b9ebdcc0
JSR
140 if (MATCH_EVENT(SOFTWARE, SW_CPU_CLOCK, counter) ||
141 MATCH_EVENT(SOFTWARE, SW_TASK_CLOCK, counter))
c04f5e5d
IM
142 return 1;
143
144 return 0;
145}
146
147/*
2996f5dd 148 * Read out the results of a single counter:
c04f5e5d 149 */
2996f5dd 150static void read_counter(int counter)
c04f5e5d 151{
9cffa8d5 152 u64 *count, single_count[3];
f37a291c
IM
153 unsigned int cpu;
154 size_t res, nv;
c04f5e5d
IM
155 int scaled;
156
42202dd5 157 count = event_res[run_idx][counter];
2996f5dd 158
c04f5e5d 159 count[0] = count[1] = count[2] = 0;
2996f5dd 160
c04f5e5d 161 nv = scale ? 3 : 1;
cca03c0a 162 for (cpu = 0; cpu < nr_cpus; cpu++) {
743ee1f8
IM
163 if (fd[cpu][counter] < 0)
164 continue;
165
9cffa8d5
PM
166 res = read(fd[cpu][counter], single_count, nv * sizeof(u64));
167 assert(res == nv * sizeof(u64));
f37a291c 168
42202dd5
IM
169 close(fd[cpu][counter]);
170 fd[cpu][counter] = -1;
c04f5e5d
IM
171
172 count[0] += single_count[0];
173 if (scale) {
174 count[1] += single_count[1];
175 count[2] += single_count[2];
176 }
177 }
178
179 scaled = 0;
180 if (scale) {
181 if (count[2] == 0) {
42202dd5 182 event_scaled[run_idx][counter] = -1;
2996f5dd 183 count[0] = 0;
c04f5e5d
IM
184 return;
185 }
2996f5dd 186
c04f5e5d 187 if (count[2] < count[1]) {
42202dd5 188 event_scaled[run_idx][counter] = 1;
c04f5e5d
IM
189 count[0] = (unsigned long long)
190 ((double)count[0] * count[1] / count[2] + 0.5);
191 }
192 }
be1ac0d8
IM
193 /*
194 * Save the full runtime - to allow normalization during printout:
195 */
b9ebdcc0 196 if (MATCH_EVENT(SOFTWARE, SW_TASK_CLOCK, counter))
42202dd5 197 runtime_nsecs[run_idx] = count[0];
b9ebdcc0 198 if (MATCH_EVENT(HARDWARE, HW_CPU_CYCLES, counter))
42202dd5 199 runtime_cycles[run_idx] = count[0];
2996f5dd
IM
200}
201
f37a291c 202static int run_perf_stat(int argc __used, const char **argv)
42202dd5
IM
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 */
a92bef0f
FW
242 if (read(go_pipe[0], &buf, 1) == -1)
243 perror("unable to read pipe");
051ae7f7
PM
244
245 execvp(argv[0], (char **)argv);
246
247 perror(argv[0]);
248 exit(-1);
249 }
250
251 /*
252 * Wait for the child to be ready to exec.
253 */
254 close(child_ready_pipe[1]);
255 close(go_pipe[0]);
a92bef0f
FW
256 if (read(child_ready_pipe[0], &buf, 1) == -1)
257 perror("unable to read pipe");
051ae7f7
PM
258 close(child_ready_pipe[0]);
259
42202dd5 260 for (counter = 0; counter < nr_counters; counter++)
051ae7f7 261 create_perf_stat_counter(counter, pid);
42202dd5
IM
262
263 /*
264 * Enable counters and exec the command:
265 */
266 t0 = rdclock();
42202dd5 267
051ae7f7 268 close(go_pipe[1]);
42202dd5
IM
269 wait(&status);
270
42202dd5
IM
271 t1 = rdclock();
272
273 walltime_nsecs[run_idx] = t1 - t0;
274
275 for (counter = 0; counter < nr_counters; counter++)
276 read_counter(counter);
277
278 return WEXITSTATUS(status);
279}
280
9cffa8d5 281static void print_noise(u64 *count, u64 *noise)
42202dd5
IM
282{
283 if (run_count > 1)
284 fprintf(stderr, " ( +- %7.3f%% )",
285 (double)noise[0]/(count[0]+1)*100.0);
286}
287
9cffa8d5 288static void nsec_printout(int counter, u64 *count, u64 *noise)
44175b6f
IM
289{
290 double msecs = (double)count[0] / 1000000;
291
6e750a8f 292 fprintf(stderr, " %14.6f %-24s", msecs, event_name(counter));
44175b6f 293
b9ebdcc0 294 if (MATCH_EVENT(SOFTWARE, SW_TASK_CLOCK, counter)) {
42202dd5
IM
295 if (walltime_nsecs_avg)
296 fprintf(stderr, " # %10.3f CPUs ",
297 (double)count[0] / (double)walltime_nsecs_avg);
44175b6f 298 }
42202dd5 299 print_noise(count, noise);
44175b6f
IM
300}
301
9cffa8d5 302static void abs_printout(int counter, u64 *count, u64 *noise)
44175b6f 303{
6e750a8f 304 fprintf(stderr, " %14Ld %-24s", count[0], event_name(counter));
44175b6f 305
42202dd5 306 if (runtime_cycles_avg &&
b9ebdcc0 307 MATCH_EVENT(HARDWARE, HW_INSTRUCTIONS, counter)) {
42202dd5
IM
308 fprintf(stderr, " # %10.3f IPC ",
309 (double)count[0] / (double)runtime_cycles_avg);
310 } else {
311 if (runtime_nsecs_avg) {
312 fprintf(stderr, " # %10.3f M/sec",
313 (double)count[0]/runtime_nsecs_avg*1000.0);
314 }
44175b6f 315 }
42202dd5 316 print_noise(count, noise);
44175b6f
IM
317}
318
2996f5dd
IM
319/*
320 * Print out the results of a single counter:
321 */
322static void print_counter(int counter)
323{
9cffa8d5 324 u64 *count, *noise;
2996f5dd
IM
325 int scaled;
326
42202dd5
IM
327 count = event_res_avg[counter];
328 noise = event_res_noise[counter];
329 scaled = event_scaled_avg[counter];
2996f5dd
IM
330
331 if (scaled == -1) {
6e750a8f 332 fprintf(stderr, " %14s %-24s\n",
2996f5dd
IM
333 "<not counted>", event_name(counter));
334 return;
335 }
c04f5e5d 336
44175b6f 337 if (nsec_counter(counter))
42202dd5 338 nsec_printout(counter, count, noise);
44175b6f 339 else
42202dd5 340 abs_printout(counter, count, noise);
d7c29318 341
c04f5e5d 342 if (scaled)
210ad39f
IM
343 fprintf(stderr, " (scaled from %.2f%%)",
344 (double) count[2] / count[1] * 100);
44175b6f 345
c04f5e5d
IM
346 fprintf(stderr, "\n");
347}
348
42202dd5 349/*
ef281a19 350 * normalize_noise noise values down to stddev:
42202dd5 351 */
9cffa8d5 352static void normalize_noise(u64 *val)
ddcacfa0 353{
42202dd5 354 double res;
ddcacfa0 355
42202dd5 356 res = (double)*val / (run_count * sqrt((double)run_count));
ddcacfa0 357
9cffa8d5 358 *val = (u64)res;
42202dd5 359}
ddcacfa0 360
9cffa8d5 361static void update_avg(const char *name, int idx, u64 *avg, u64 *val)
ef281a19
IM
362{
363 *avg += *val;
364
365 if (verbose > 1)
366 fprintf(stderr, "debug: %20s[%d]: %Ld\n", name, idx, *val);
367}
42202dd5
IM
368/*
369 * Calculate the averages and noises:
370 */
371static void calc_avg(void)
372{
373 int i, j;
374
ef281a19
IM
375 if (verbose > 1)
376 fprintf(stderr, "\n");
377
42202dd5 378 for (i = 0; i < run_count; i++) {
ef281a19
IM
379 update_avg("runtime", 0, &runtime_nsecs_avg, runtime_nsecs + i);
380 update_avg("walltime", 0, &walltime_nsecs_avg, walltime_nsecs + i);
381 update_avg("runtime_cycles", 0, &runtime_cycles_avg, runtime_cycles + i);
42202dd5
IM
382
383 for (j = 0; j < nr_counters; j++) {
ef281a19
IM
384 update_avg("counter/0", j,
385 event_res_avg[j]+0, event_res[i][j]+0);
386 update_avg("counter/1", j,
387 event_res_avg[j]+1, event_res[i][j]+1);
388 update_avg("counter/2", j,
389 event_res_avg[j]+2, event_res[i][j]+2);
f37a291c 390 if (event_scaled[i][j] != (u64)-1)
566747e6
IM
391 update_avg("scaled", j,
392 event_scaled_avg + j, event_scaled[i]+j);
393 else
394 event_scaled_avg[j] = -1;
42202dd5
IM
395 }
396 }
397 runtime_nsecs_avg /= run_count;
398 walltime_nsecs_avg /= run_count;
399 runtime_cycles_avg /= run_count;
400
401 for (j = 0; j < nr_counters; j++) {
402 event_res_avg[j][0] /= run_count;
403 event_res_avg[j][1] /= run_count;
404 event_res_avg[j][2] /= run_count;
405 }
44db76c8 406
42202dd5
IM
407 for (i = 0; i < run_count; i++) {
408 runtime_nsecs_noise +=
9cffa8d5 409 abs((s64)(runtime_nsecs[i] - runtime_nsecs_avg));
42202dd5 410 walltime_nsecs_noise +=
9cffa8d5 411 abs((s64)(walltime_nsecs[i] - walltime_nsecs_avg));
42202dd5 412 runtime_cycles_noise +=
9cffa8d5 413 abs((s64)(runtime_cycles[i] - runtime_cycles_avg));
42202dd5
IM
414
415 for (j = 0; j < nr_counters; j++) {
416 event_res_noise[j][0] +=
9cffa8d5 417 abs((s64)(event_res[i][j][0] - event_res_avg[j][0]));
42202dd5 418 event_res_noise[j][1] +=
9cffa8d5 419 abs((s64)(event_res[i][j][1] - event_res_avg[j][1]));
42202dd5 420 event_res_noise[j][2] +=
9cffa8d5 421 abs((s64)(event_res[i][j][2] - event_res_avg[j][2]));
ddcacfa0
IM
422 }
423 }
44db76c8 424
ef281a19
IM
425 normalize_noise(&runtime_nsecs_noise);
426 normalize_noise(&walltime_nsecs_noise);
427 normalize_noise(&runtime_cycles_noise);
44db76c8 428
42202dd5 429 for (j = 0; j < nr_counters; j++) {
ef281a19
IM
430 normalize_noise(&event_res_noise[j][0]);
431 normalize_noise(&event_res_noise[j][1]);
432 normalize_noise(&event_res_noise[j][2]);
42202dd5
IM
433 }
434}
435
436static void print_stat(int argc, const char **argv)
437{
438 int i, counter;
439
440 calc_avg();
ddcacfa0
IM
441
442 fflush(stdout);
443
444 fprintf(stderr, "\n");
44db76c8
IM
445 fprintf(stderr, " Performance counter stats for \'%s", argv[0]);
446
447 for (i = 1; i < argc; i++)
448 fprintf(stderr, " %s", argv[i]);
449
42202dd5
IM
450 fprintf(stderr, "\'");
451 if (run_count > 1)
452 fprintf(stderr, " (%d runs)", run_count);
453 fprintf(stderr, ":\n\n");
2996f5dd 454
c04f5e5d
IM
455 for (counter = 0; counter < nr_counters; counter++)
456 print_counter(counter);
ddcacfa0 457
ddcacfa0 458 fprintf(stderr, "\n");
566747e6 459 fprintf(stderr, " %14.9f seconds time elapsed",
42202dd5 460 (double)walltime_nsecs_avg/1e9);
566747e6
IM
461 if (run_count > 1) {
462 fprintf(stderr, " ( +- %7.3f%% )",
463 100.0*(double)walltime_nsecs_noise/(double)walltime_nsecs_avg);
464 }
465 fprintf(stderr, "\n\n");
ddcacfa0
IM
466}
467
f7b7c26e
PZ
468static volatile int signr = -1;
469
5242519b 470static void skip_signal(int signo)
ddcacfa0 471{
f7b7c26e
PZ
472 signr = signo;
473}
474
475static void sig_atexit(void)
476{
477 if (signr == -1)
478 return;
479
480 signal(signr, SIG_DFL);
481 kill(getpid(), signr);
5242519b
IM
482}
483
484static const char * const stat_usage[] = {
485 "perf stat [<options>] <command>",
486 NULL
487};
488
5242519b
IM
489static const struct option options[] = {
490 OPT_CALLBACK('e', "event", NULL, "event",
86847b62
TG
491 "event selector. use 'perf list' to list available events",
492 parse_events),
5242519b
IM
493 OPT_BOOLEAN('i', "inherit", &inherit,
494 "child tasks inherit counters"),
495 OPT_INTEGER('p', "pid", &target_pid,
496 "stat events on existing pid"),
497 OPT_BOOLEAN('a', "all-cpus", &system_wide,
3d632595 498 "system-wide collection from all CPUs"),
86847b62 499 OPT_BOOLEAN('S', "scale", &scale,
3d632595 500 "scale/normalize counters"),
743ee1f8
IM
501 OPT_BOOLEAN('v', "verbose", &verbose,
502 "be more verbose (show counter open errors, etc)"),
42202dd5
IM
503 OPT_INTEGER('r', "repeat", &run_count,
504 "repeat command and print average + stddev (max: 100)"),
0cfb7a13
IM
505 OPT_BOOLEAN('n', "null", &null_run,
506 "null run - dont start any counters"),
5242519b
IM
507 OPT_END()
508};
509
f37a291c 510int cmd_stat(int argc, const char **argv, const char *prefix __used)
5242519b 511{
42202dd5
IM
512 int status;
513
a0541234
AB
514 argc = parse_options(argc, argv, options, stat_usage,
515 PARSE_OPT_STOP_AT_NON_OPTION);
5242519b
IM
516 if (!argc)
517 usage_with_options(stat_usage, options);
42202dd5
IM
518 if (run_count <= 0 || run_count > MAX_RUN)
519 usage_with_options(stat_usage, options);
ddcacfa0 520
c3043569
JSR
521 /* Set attrs and nr_counters if no event is selected and !null_run */
522 if (!null_run && !nr_counters) {
523 memcpy(attrs, default_attrs, sizeof(default_attrs));
524 nr_counters = ARRAY_SIZE(default_attrs);
525 }
ddcacfa0 526
ddcacfa0
IM
527 nr_cpus = sysconf(_SC_NPROCESSORS_ONLN);
528 assert(nr_cpus <= MAX_NR_CPUS);
f37a291c 529 assert((int)nr_cpus >= 0);
ddcacfa0 530
58d7e993
IM
531 /*
532 * We dont want to block the signals - that would cause
533 * child tasks to inherit that and Ctrl-C would not work.
534 * What we want is for Ctrl-C to work in the exec()-ed
535 * task, but being ignored by perf stat itself:
536 */
f7b7c26e 537 atexit(sig_atexit);
58d7e993
IM
538 signal(SIGINT, skip_signal);
539 signal(SIGALRM, skip_signal);
540 signal(SIGABRT, skip_signal);
541
42202dd5
IM
542 status = 0;
543 for (run_idx = 0; run_idx < run_count; run_idx++) {
544 if (run_count != 1 && verbose)
3d632595 545 fprintf(stderr, "[ perf stat: executing run #%d ... ]\n", run_idx + 1);
42202dd5
IM
546 status = run_perf_stat(argc, argv);
547 }
548
549 print_stat(argc, argv);
550
551 return status;
ddcacfa0 552}