?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
perf stat: Define MATCH_EVENT for easy attr checking
[linux-2.6/linux-2.6-openrd.git] / tools / perf / builtin-stat.c
blob01cc07efb728ae4f267ae93b67df77320f6593ca
1 /*
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:
8
9 $ perf stat ~/hackbench 10
10 Time: 0.104
11
12 Performance counter stats for '/home/mingo/hackbench':
13
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
22
23 Wall-clock time elapsed: 123.786620 msecs
24
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>
35 * Jaswinder Singh Rajput <jaswinder@kernel.org>
36 *
37 * Released under the GPL v2. (and only v2, not any later version)
38 */
39
40 #include "perf.h"
41 #include "builtin.h"
42 #include "util/util.h"
43 #include "util/parse-options.h"
44 #include "util/parse-events.h"
45
46 #include <sys/prctl.h>
47 #include <math.h>
48
49 static struct perf_counter_attr default_attrs[] = {
50
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
61 };
62
63 #define MAX_RUN 100
64
65 static int system_wide = 0;
66 static int verbose = 0;
67 static unsigned int nr_cpus = 0;
68 static int run_idx = 0;
69
70 static int run_count = 1;
71 static int inherit = 1;
72 static int scale = 1;
73 static int target_pid = -1;
74 static int null_run = 0;
75
76 static int fd[MAX_NR_CPUS][MAX_COUNTERS];
77
78 static u64 runtime_nsecs[MAX_RUN];
79 static u64 walltime_nsecs[MAX_RUN];
80 static u64 runtime_cycles[MAX_RUN];
81
82 static u64 event_res[MAX_RUN][MAX_COUNTERS][3];
83 static u64 event_scaled[MAX_RUN][MAX_COUNTERS];
84
85 static u64 event_res_avg[MAX_COUNTERS][3];
86 static u64 event_res_noise[MAX_COUNTERS][3];
87
88 static u64 event_scaled_avg[MAX_COUNTERS];
89
90 static u64 runtime_nsecs_avg;
91 static u64 runtime_nsecs_noise;
92
93 static u64 walltime_nsecs_avg;
94 static u64 walltime_nsecs_noise;
95
96 static u64 runtime_cycles_avg;
97 static u64 runtime_cycles_noise;
98
99 #define MATCH_EVENT(t, c, counter) \
100 (attrs[counter].type == PERF_TYPE_##t && \
101 attrs[counter].config == PERF_COUNT_##c)
102
103 #define ERR_PERF_OPEN \
104 "Error: counter %d, sys_perf_counter_open() syscall returned with %d (%s)\n"
105
106 static void create_perf_stat_counter(int counter, int pid)
107 {
108 struct perf_counter_attr *attr = attrs + counter;
109
110 if (scale)
111 attr->read_format = PERF_FORMAT_TOTAL_TIME_ENABLED |
112 PERF_FORMAT_TOTAL_TIME_RUNNING;
113
114 if (system_wide) {
115 unsigned int cpu;
116
117 for (cpu = 0; cpu < nr_cpus; cpu++) {
118 fd[cpu][counter] = sys_perf_counter_open(attr, -1, cpu, -1, 0);
119 if (fd[cpu][counter] < 0 && verbose)
120 fprintf(stderr, ERR_PERF_OPEN, counter,
121 fd[cpu][counter], strerror(errno));
122 }
123 } else {
124 attr->inherit = inherit;
125 attr->disabled = 1;
126 attr->enable_on_exec = 1;
127
128 fd[0][counter] = sys_perf_counter_open(attr, pid, -1, -1, 0);
129 if (fd[0][counter] < 0 && verbose)
130 fprintf(stderr, ERR_PERF_OPEN, counter,
131 fd[0][counter], strerror(errno));
132 }
133 }
134
135 /*
136 * Does the counter have nsecs as a unit?
137 */
138 static inline int nsec_counter(int counter)
139 {
140 if (MATCH_EVENT(SOFTWARE, SW_CPU_CLOCK, counter) ||
141 MATCH_EVENT(SOFTWARE, SW_TASK_CLOCK, counter))
142 return 1;
143
144 return 0;
145 }
146
147 /*
148 * Read out the results of a single counter:
149 */
150 static void read_counter(int counter)
151 {
152 u64 *count, single_count[3];
153 unsigned int cpu;
154 size_t res, nv;
155 int scaled;
156
157 count = event_res[run_idx][counter];
158
159 count[0] = count[1] = count[2] = 0;
160
161 nv = scale ? 3 : 1;
162 for (cpu = 0; cpu < nr_cpus; cpu++) {
163 if (fd[cpu][counter] < 0)
164 continue;
165
166 res = read(fd[cpu][counter], single_count, nv * sizeof(u64));
167 assert(res == nv * sizeof(u64));
168
169 close(fd[cpu][counter]);
170 fd[cpu][counter] = -1;
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) {
182 event_scaled[run_idx][counter] = -1;
183 count[0] = 0;
184 return;
185 }
186
187 if (count[2] < count[1]) {
188 event_scaled[run_idx][counter] = 1;
189 count[0] = (unsigned long long)
190 ((double)count[0] * count[1] / count[2] + 0.5);
191 }
192 }
193 /*
194 * Save the full runtime - to allow normalization during printout:
195 */
196 if (MATCH_EVENT(SOFTWARE, SW_TASK_CLOCK, counter))
197 runtime_nsecs[run_idx] = count[0];
198 if (MATCH_EVENT(HARDWARE, HW_CPU_CYCLES, counter))
199 runtime_cycles[run_idx] = count[0];
200 }
201
202 static int run_perf_stat(int argc __used, const char **argv)
203 {
204 unsigned long long t0, t1;
205 int status = 0;
206 int counter;
207 int pid;
208 int child_ready_pipe[2], go_pipe[2];
209 char buf;
210
211 if (!system_wide)
212 nr_cpus = 1;
213
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
258 for (counter = 0; counter < nr_counters; counter++)
259 create_perf_stat_counter(counter, pid);
260
261 /*
262 * Enable counters and exec the command:
263 */
264 t0 = rdclock();
265
266 close(go_pipe[1]);
267 wait(&status);
268
269 t1 = rdclock();
270
271 walltime_nsecs[run_idx] = t1 - t0;
272
273 for (counter = 0; counter < nr_counters; counter++)
274 read_counter(counter);
275
276 return WEXITSTATUS(status);
277 }
278
279 static void print_noise(u64 *count, u64 *noise)
280 {
281 if (run_count > 1)
282 fprintf(stderr, " ( +- %7.3f%% )",
283 (double)noise[0]/(count[0]+1)*100.0);
284 }
285
286 static void nsec_printout(int counter, u64 *count, u64 *noise)
287 {
288 double msecs = (double)count[0] / 1000000;
289
290 fprintf(stderr, " %14.6f %-24s", msecs, event_name(counter));
291
292 if (MATCH_EVENT(SOFTWARE, SW_TASK_CLOCK, counter)) {
293 if (walltime_nsecs_avg)
294 fprintf(stderr, " # %10.3f CPUs ",
295 (double)count[0] / (double)walltime_nsecs_avg);
296 }
297 print_noise(count, noise);
298 }
299
300 static void abs_printout(int counter, u64 *count, u64 *noise)
301 {
302 fprintf(stderr, " %14Ld %-24s", count[0], event_name(counter));
303
304 if (runtime_cycles_avg &&
305 MATCH_EVENT(HARDWARE, HW_INSTRUCTIONS, counter)) {
306 fprintf(stderr, " # %10.3f IPC ",
307 (double)count[0] / (double)runtime_cycles_avg);
308 } else {
309 if (runtime_nsecs_avg) {
310 fprintf(stderr, " # %10.3f M/sec",
311 (double)count[0]/runtime_nsecs_avg*1000.0);
312 }
313 }
314 print_noise(count, noise);
315 }
316
317 /*
318 * Print out the results of a single counter:
319 */
320 static void print_counter(int counter)
321 {
322 u64 *count, *noise;
323 int scaled;
324
325 count = event_res_avg[counter];
326 noise = event_res_noise[counter];
327 scaled = event_scaled_avg[counter];
328
329 if (scaled == -1) {
330 fprintf(stderr, " %14s %-24s\n",
331 "<not counted>", event_name(counter));
332 return;
333 }
334
335 if (nsec_counter(counter))
336 nsec_printout(counter, count, noise);
337 else
338 abs_printout(counter, count, noise);
339
340 if (scaled)
341 fprintf(stderr, " (scaled from %.2f%%)",
342 (double) count[2] / count[1] * 100);
343
344 fprintf(stderr, "\n");
345 }
346
347 /*
348 * normalize_noise noise values down to stddev:
349 */
350 static void normalize_noise(u64 *val)
351 {
352 double res;
353
354 res = (double)*val / (run_count * sqrt((double)run_count));
355
356 *val = (u64)res;
357 }
358
359 static void update_avg(const char *name, int idx, u64 *avg, u64 *val)
360 {
361 *avg += *val;
362
363 if (verbose > 1)
364 fprintf(stderr, "debug: %20s[%d]: %Ld\n", name, idx, *val);
365 }
366 /*
367 * Calculate the averages and noises:
368 */
369 static void calc_avg(void)
370 {
371 int i, j;
372
373 if (verbose > 1)
374 fprintf(stderr, "\n");
375
376 for (i = 0; i < run_count; i++) {
377 update_avg("runtime", 0, &runtime_nsecs_avg, runtime_nsecs + i);
378 update_avg("walltime", 0, &walltime_nsecs_avg, walltime_nsecs + i);
379 update_avg("runtime_cycles", 0, &runtime_cycles_avg, runtime_cycles + i);
380
381 for (j = 0; j < nr_counters; j++) {
382 update_avg("counter/0", j,
383 event_res_avg[j]+0, event_res[i][j]+0);
384 update_avg("counter/1", j,
385 event_res_avg[j]+1, event_res[i][j]+1);
386 update_avg("counter/2", j,
387 event_res_avg[j]+2, event_res[i][j]+2);
388 if (event_scaled[i][j] != (u64)-1)
389 update_avg("scaled", j,
390 event_scaled_avg + j, event_scaled[i]+j);
391 else
392 event_scaled_avg[j] = -1;
393 }
394 }
395 runtime_nsecs_avg /= run_count;
396 walltime_nsecs_avg /= run_count;
397 runtime_cycles_avg /= run_count;
398
399 for (j = 0; j < nr_counters; j++) {
400 event_res_avg[j][0] /= run_count;
401 event_res_avg[j][1] /= run_count;
402 event_res_avg[j][2] /= run_count;
403 }
404
405 for (i = 0; i < run_count; i++) {
406 runtime_nsecs_noise +=
407 abs((s64)(runtime_nsecs[i] - runtime_nsecs_avg));
408 walltime_nsecs_noise +=
409 abs((s64)(walltime_nsecs[i] - walltime_nsecs_avg));
410 runtime_cycles_noise +=
411 abs((s64)(runtime_cycles[i] - runtime_cycles_avg));
412
413 for (j = 0; j < nr_counters; j++) {
414 event_res_noise[j][0] +=
415 abs((s64)(event_res[i][j][0] - event_res_avg[j][0]));
416 event_res_noise[j][1] +=
417 abs((s64)(event_res[i][j][1] - event_res_avg[j][1]));
418 event_res_noise[j][2] +=
419 abs((s64)(event_res[i][j][2] - event_res_avg[j][2]));
420 }
421 }
422
423 normalize_noise(&runtime_nsecs_noise);
424 normalize_noise(&walltime_nsecs_noise);
425 normalize_noise(&runtime_cycles_noise);
426
427 for (j = 0; j < nr_counters; j++) {
428 normalize_noise(&event_res_noise[j][0]);
429 normalize_noise(&event_res_noise[j][1]);
430 normalize_noise(&event_res_noise[j][2]);
431 }
432 }
433
434 static void print_stat(int argc, const char **argv)
435 {
436 int i, counter;
437
438 calc_avg();
439
440 fflush(stdout);
441
442 fprintf(stderr, "\n");
443 fprintf(stderr, " Performance counter stats for \'%s", argv[0]);
444
445 for (i = 1; i < argc; i++)
446 fprintf(stderr, " %s", argv[i]);
447
448 fprintf(stderr, "\'");
449 if (run_count > 1)
450 fprintf(stderr, " (%d runs)", run_count);
451 fprintf(stderr, ":\n\n");
452
453 for (counter = 0; counter < nr_counters; counter++)
454 print_counter(counter);
455
456 fprintf(stderr, "\n");
457 fprintf(stderr, " %14.9f seconds time elapsed",
458 (double)walltime_nsecs_avg/1e9);
459 if (run_count > 1) {
460 fprintf(stderr, " ( +- %7.3f%% )",
461 100.0*(double)walltime_nsecs_noise/(double)walltime_nsecs_avg);
462 }
463 fprintf(stderr, "\n\n");
464 }
465
466 static volatile int signr = -1;
467
468 static void skip_signal(int signo)
469 {
470 signr = signo;
471 }
472
473 static void sig_atexit(void)
474 {
475 if (signr == -1)
476 return;
477
478 signal(signr, SIG_DFL);
479 kill(getpid(), signr);
480 }
481
482 static const char * const stat_usage[] = {
483 "perf stat [<options>] <command>",
484 NULL
485 };
486
487 static const struct option options[] = {
488 OPT_CALLBACK('e', "event", NULL, "event",
489 "event selector. use 'perf list' to list available events",
490 parse_events),
491 OPT_BOOLEAN('i', "inherit", &inherit,
492 "child tasks inherit counters"),
493 OPT_INTEGER('p', "pid", &target_pid,
494 "stat events on existing pid"),
495 OPT_BOOLEAN('a', "all-cpus", &system_wide,
496 "system-wide collection from all CPUs"),
497 OPT_BOOLEAN('S', "scale", &scale,
498 "scale/normalize counters"),
499 OPT_BOOLEAN('v', "verbose", &verbose,
500 "be more verbose (show counter open errors, etc)"),
501 OPT_INTEGER('r', "repeat", &run_count,
502 "repeat command and print average + stddev (max: 100)"),
503 OPT_BOOLEAN('n', "null", &null_run,
504 "null run - dont start any counters"),
505 OPT_END()
506 };
507
508 int cmd_stat(int argc, const char **argv, const char *prefix __used)
509 {
510 int status;
511
512 argc = parse_options(argc, argv, options, stat_usage, 0);
513 if (!argc)
514 usage_with_options(stat_usage, options);
515 if (run_count <= 0 || run_count > MAX_RUN)
516 usage_with_options(stat_usage, options);
517
518 /* Set attrs and nr_counters if no event is selected and !null_run */
519 if (!null_run && !nr_counters) {
520 memcpy(attrs, default_attrs, sizeof(default_attrs));
521 nr_counters = ARRAY_SIZE(default_attrs);
522 }
523
524 nr_cpus = sysconf(_SC_NPROCESSORS_ONLN);
525 assert(nr_cpus <= MAX_NR_CPUS);
526 assert((int)nr_cpus >= 0);
527
528 /*
529 * We dont want to block the signals - that would cause
530 * child tasks to inherit that and Ctrl-C would not work.
531 * What we want is for Ctrl-C to work in the exec()-ed
532 * task, but being ignored by perf stat itself:
533 */
534 atexit(sig_atexit);
535 signal(SIGINT, skip_signal);
536 signal(SIGALRM, skip_signal);
537 signal(SIGABRT, skip_signal);
538
539 status = 0;
540 for (run_idx = 0; run_idx < run_count; run_idx++) {
541 if (run_count != 1 && verbose)
542 fprintf(stderr, "[ perf stat: executing run #%d ... ]\n", run_idx + 1);
543 status = run_perf_stat(argc, argv);
544 }
545
546 print_stat(argc, argv);
547
548 return status;
549 }
linux 2.6 git repository for openrd