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>
35 * Jaswinder Singh Rajput <jaswinder@kernel.org>
37 * Released under the GPL v2. (and only v2, not any later version)
42 #include "util/util.h"
43 #include "util/parse-options.h"
44 #include "util/parse-events.h"
45 #include "util/event.h"
46 #include "util/evlist.h"
47 #include "util/evsel.h"
48 #include "util/debug.h"
49 #include "util/header.h"
50 #include "util/cpumap.h"
51 #include "util/thread.h"
53 #include <sys/prctl.h>
57 #define DEFAULT_SEPARATOR " "
59 static struct perf_event_attr default_attrs
[] = {
61 { .type
= PERF_TYPE_SOFTWARE
, .config
= PERF_COUNT_SW_TASK_CLOCK
},
62 { .type
= PERF_TYPE_SOFTWARE
, .config
= PERF_COUNT_SW_CONTEXT_SWITCHES
},
63 { .type
= PERF_TYPE_SOFTWARE
, .config
= PERF_COUNT_SW_CPU_MIGRATIONS
},
64 { .type
= PERF_TYPE_SOFTWARE
, .config
= PERF_COUNT_SW_PAGE_FAULTS
},
66 { .type
= PERF_TYPE_HARDWARE
, .config
= PERF_COUNT_HW_CPU_CYCLES
},
67 { .type
= PERF_TYPE_HARDWARE
, .config
= PERF_COUNT_HW_INSTRUCTIONS
},
68 { .type
= PERF_TYPE_HARDWARE
, .config
= PERF_COUNT_HW_BRANCH_INSTRUCTIONS
},
69 { .type
= PERF_TYPE_HARDWARE
, .config
= PERF_COUNT_HW_BRANCH_MISSES
},
70 { .type
= PERF_TYPE_HARDWARE
, .config
= PERF_COUNT_HW_CACHE_REFERENCES
},
71 { .type
= PERF_TYPE_HARDWARE
, .config
= PERF_COUNT_HW_CACHE_MISSES
},
75 struct perf_evlist
*evsel_list
;
77 static bool system_wide
= false;
78 static struct cpu_map
*cpus
;
79 static int run_idx
= 0;
81 static int run_count
= 1;
82 static bool no_inherit
= false;
83 static bool scale
= true;
84 static bool no_aggr
= false;
85 static pid_t target_pid
= -1;
86 static pid_t target_tid
= -1;
87 static struct thread_map
*threads
;
88 static pid_t child_pid
= -1;
89 static bool null_run
= false;
90 static bool big_num
= true;
91 static int big_num_opt
= -1;
92 static const char *cpu_list
;
93 static const char *csv_sep
= NULL
;
94 static bool csv_output
= false;
96 static volatile int done
= 0;
104 struct stats res_stats
[3];
107 static int perf_evsel__alloc_stat_priv(struct perf_evsel
*evsel
)
109 evsel
->priv
= zalloc(sizeof(struct perf_stat
));
110 return evsel
->priv
== NULL
? -ENOMEM
: 0;
113 static void perf_evsel__free_stat_priv(struct perf_evsel
*evsel
)
119 static void update_stats(struct stats
*stats
, u64 val
)
124 delta
= val
- stats
->mean
;
125 stats
->mean
+= delta
/ stats
->n
;
126 stats
->M2
+= delta
*(val
- stats
->mean
);
129 static double avg_stats(struct stats
*stats
)
135 * http://en.wikipedia.org/wiki/Algorithms_for_calculating_variance
137 * (\Sum n_i^2) - ((\Sum n_i)^2)/n
138 * s^2 = -------------------------------
141 * http://en.wikipedia.org/wiki/Stddev
143 * The std dev of the mean is related to the std dev by:
150 static double stddev_stats(struct stats
*stats
)
152 double variance
= stats
->M2
/ (stats
->n
- 1);
153 double variance_mean
= variance
/ stats
->n
;
155 return sqrt(variance_mean
);
158 struct stats runtime_nsecs_stats
[MAX_NR_CPUS
];
159 struct stats runtime_cycles_stats
[MAX_NR_CPUS
];
160 struct stats runtime_branches_stats
[MAX_NR_CPUS
];
161 struct stats walltime_nsecs_stats
;
163 static int create_perf_stat_counter(struct perf_evsel
*evsel
)
165 struct perf_event_attr
*attr
= &evsel
->attr
;
168 attr
->read_format
= PERF_FORMAT_TOTAL_TIME_ENABLED
|
169 PERF_FORMAT_TOTAL_TIME_RUNNING
;
172 return perf_evsel__open_per_cpu(evsel
, cpus
, false, false);
174 attr
->inherit
= !no_inherit
;
175 if (target_pid
== -1 && target_tid
== -1) {
177 attr
->enable_on_exec
= 1;
180 return perf_evsel__open_per_thread(evsel
, threads
, false, false);
184 * Does the counter have nsecs as a unit?
186 static inline int nsec_counter(struct perf_evsel
*evsel
)
188 if (perf_evsel__match(evsel
, SOFTWARE
, SW_CPU_CLOCK
) ||
189 perf_evsel__match(evsel
, SOFTWARE
, SW_TASK_CLOCK
))
196 * Read out the results of a single counter:
197 * aggregate counts across CPUs in system-wide mode
199 static int read_counter_aggr(struct perf_evsel
*counter
)
201 struct perf_stat
*ps
= counter
->priv
;
202 u64
*count
= counter
->counts
->aggr
.values
;
205 if (__perf_evsel__read(counter
, cpus
->nr
, threads
->nr
, scale
) < 0)
208 for (i
= 0; i
< 3; i
++)
209 update_stats(&ps
->res_stats
[i
], count
[i
]);
212 fprintf(stderr
, "%s: %" PRIu64
" %" PRIu64
" %" PRIu64
"\n",
213 event_name(counter
), count
[0], count
[1], count
[2]);
217 * Save the full runtime - to allow normalization during printout:
219 if (perf_evsel__match(counter
, SOFTWARE
, SW_TASK_CLOCK
))
220 update_stats(&runtime_nsecs_stats
[0], count
[0]);
221 if (perf_evsel__match(counter
, HARDWARE
, HW_CPU_CYCLES
))
222 update_stats(&runtime_cycles_stats
[0], count
[0]);
223 if (perf_evsel__match(counter
, HARDWARE
, HW_BRANCH_INSTRUCTIONS
))
224 update_stats(&runtime_branches_stats
[0], count
[0]);
230 * Read out the results of a single counter:
231 * do not aggregate counts across CPUs in system-wide mode
233 static int read_counter(struct perf_evsel
*counter
)
238 for (cpu
= 0; cpu
< cpus
->nr
; cpu
++) {
239 if (__perf_evsel__read_on_cpu(counter
, cpu
, 0, scale
) < 0)
242 count
= counter
->counts
->cpu
[cpu
].values
;
244 if (perf_evsel__match(counter
, SOFTWARE
, SW_TASK_CLOCK
))
245 update_stats(&runtime_nsecs_stats
[cpu
], count
[0]);
246 if (perf_evsel__match(counter
, HARDWARE
, HW_CPU_CYCLES
))
247 update_stats(&runtime_cycles_stats
[cpu
], count
[0]);
248 if (perf_evsel__match(counter
, HARDWARE
, HW_BRANCH_INSTRUCTIONS
))
249 update_stats(&runtime_branches_stats
[cpu
], count
[0]);
255 static int run_perf_stat(int argc __used
, const char **argv
)
257 unsigned long long t0
, t1
;
258 struct perf_evsel
*counter
;
260 int child_ready_pipe
[2], go_pipe
[2];
261 const bool forks
= (argc
> 0);
264 if (forks
&& (pipe(child_ready_pipe
) < 0 || pipe(go_pipe
) < 0)) {
265 perror("failed to create pipes");
270 if ((child_pid
= fork()) < 0)
271 perror("failed to fork");
274 close(child_ready_pipe
[0]);
276 fcntl(go_pipe
[0], F_SETFD
, FD_CLOEXEC
);
279 * Do a dummy execvp to get the PLT entry resolved,
280 * so we avoid the resolver overhead on the real
283 execvp("", (char **)argv
);
286 * Tell the parent we're ready to go
288 close(child_ready_pipe
[1]);
291 * Wait until the parent tells us to go.
293 if (read(go_pipe
[0], &buf
, 1) == -1)
294 perror("unable to read pipe");
296 execvp(argv
[0], (char **)argv
);
302 if (target_tid
== -1 && target_pid
== -1 && !system_wide
)
303 threads
->map
[0] = child_pid
;
306 * Wait for the child to be ready to exec.
308 close(child_ready_pipe
[1]);
310 if (read(child_ready_pipe
[0], &buf
, 1) == -1)
311 perror("unable to read pipe");
312 close(child_ready_pipe
[0]);
315 list_for_each_entry(counter
, &evsel_list
->entries
, node
) {
316 if (create_perf_stat_counter(counter
) < 0) {
317 if (errno
== -EPERM
|| errno
== -EACCES
) {
318 error("You may not have permission to collect %sstats.\n"
319 "\t Consider tweaking"
320 " /proc/sys/kernel/perf_event_paranoid or running as root.",
321 system_wide
? "system-wide " : "");
322 } else if (errno
== ENOENT
) {
323 error("%s event is not supported. ", event_name(counter
));
325 error("open_counter returned with %d (%s). "
326 "/bin/dmesg may provide additional information.\n",
327 errno
, strerror(errno
));
330 kill(child_pid
, SIGTERM
);
331 die("Not all events could be opened.\n");
337 * Enable counters and exec the command:
345 while(!done
) sleep(1);
350 update_stats(&walltime_nsecs_stats
, t1
- t0
);
353 list_for_each_entry(counter
, &evsel_list
->entries
, node
) {
354 read_counter(counter
);
355 perf_evsel__close_fd(counter
, cpus
->nr
, 1);
358 list_for_each_entry(counter
, &evsel_list
->entries
, node
) {
359 read_counter_aggr(counter
);
360 perf_evsel__close_fd(counter
, cpus
->nr
, threads
->nr
);
364 return WEXITSTATUS(status
);
367 static void print_noise(struct perf_evsel
*evsel
, double avg
)
369 struct perf_stat
*ps
;
375 fprintf(stderr
, " ( +- %7.3f%% )",
376 100 * stddev_stats(&ps
->res_stats
[0]) / avg
);
379 static void nsec_printout(int cpu
, struct perf_evsel
*evsel
, double avg
)
381 double msecs
= avg
/ 1e6
;
382 char cpustr
[16] = { '\0', };
383 const char *fmt
= csv_output
? "%s%.6f%s%s" : "%s%18.6f%s%-24s";
386 sprintf(cpustr
, "CPU%*d%s",
388 cpus
->map
[cpu
], csv_sep
);
390 fprintf(stderr
, fmt
, cpustr
, msecs
, csv_sep
, event_name(evsel
));
395 if (perf_evsel__match(evsel
, SOFTWARE
, SW_TASK_CLOCK
))
396 fprintf(stderr
, " # %10.3f CPUs ",
397 avg
/ avg_stats(&walltime_nsecs_stats
));
400 static void abs_printout(int cpu
, struct perf_evsel
*evsel
, double avg
)
402 double total
, ratio
= 0.0;
403 char cpustr
[16] = { '\0', };
409 fmt
= "%s%'18.0f%s%-24s";
411 fmt
= "%s%18.0f%s%-24s";
414 sprintf(cpustr
, "CPU%*d%s",
416 cpus
->map
[cpu
], csv_sep
);
420 fprintf(stderr
, fmt
, cpustr
, avg
, csv_sep
, event_name(evsel
));
425 if (perf_evsel__match(evsel
, HARDWARE
, HW_INSTRUCTIONS
)) {
426 total
= avg_stats(&runtime_cycles_stats
[cpu
]);
431 fprintf(stderr
, " # %10.3f IPC ", ratio
);
432 } else if (perf_evsel__match(evsel
, HARDWARE
, HW_BRANCH_MISSES
) &&
433 runtime_branches_stats
[cpu
].n
!= 0) {
434 total
= avg_stats(&runtime_branches_stats
[cpu
]);
437 ratio
= avg
* 100 / total
;
439 fprintf(stderr
, " # %10.3f %% ", ratio
);
441 } else if (runtime_nsecs_stats
[cpu
].n
!= 0) {
442 total
= avg_stats(&runtime_nsecs_stats
[cpu
]);
445 ratio
= 1000.0 * avg
/ total
;
447 fprintf(stderr
, " # %10.3f M/sec", ratio
);
452 * Print out the results of a single counter:
453 * aggregated counts in system-wide mode
455 static void print_counter_aggr(struct perf_evsel
*counter
)
457 struct perf_stat
*ps
= counter
->priv
;
458 double avg
= avg_stats(&ps
->res_stats
[0]);
459 int scaled
= counter
->counts
->scaled
;
462 fprintf(stderr
, "%*s%s%-24s\n",
464 "<not counted>", csv_sep
, event_name(counter
));
468 if (nsec_counter(counter
))
469 nsec_printout(-1, counter
, avg
);
471 abs_printout(-1, counter
, avg
);
478 print_noise(counter
, avg
);
481 double avg_enabled
, avg_running
;
483 avg_enabled
= avg_stats(&ps
->res_stats
[1]);
484 avg_running
= avg_stats(&ps
->res_stats
[2]);
486 fprintf(stderr
, " (scaled from %.2f%%)",
487 100 * avg_running
/ avg_enabled
);
490 fprintf(stderr
, "\n");
494 * Print out the results of a single counter:
495 * does not use aggregated count in system-wide
497 static void print_counter(struct perf_evsel
*counter
)
502 for (cpu
= 0; cpu
< cpus
->nr
; cpu
++) {
503 val
= counter
->counts
->cpu
[cpu
].val
;
504 ena
= counter
->counts
->cpu
[cpu
].ena
;
505 run
= counter
->counts
->cpu
[cpu
].run
;
506 if (run
== 0 || ena
== 0) {
507 fprintf(stderr
, "CPU%*d%s%*s%s%-24s",
509 cpus
->map
[cpu
], csv_sep
,
511 "<not counted>", csv_sep
,
512 event_name(counter
));
514 fprintf(stderr
, "\n");
518 if (nsec_counter(counter
))
519 nsec_printout(cpu
, counter
, val
);
521 abs_printout(cpu
, counter
, val
);
524 print_noise(counter
, 1.0);
527 fprintf(stderr
, " (scaled from %.2f%%)",
531 fprintf(stderr
, "\n");
535 static void print_stat(int argc
, const char **argv
)
537 struct perf_evsel
*counter
;
543 fprintf(stderr
, "\n");
544 fprintf(stderr
, " Performance counter stats for ");
545 if(target_pid
== -1 && target_tid
== -1) {
546 fprintf(stderr
, "\'%s", argv
[0]);
547 for (i
= 1; i
< argc
; i
++)
548 fprintf(stderr
, " %s", argv
[i
]);
549 } else if (target_pid
!= -1)
550 fprintf(stderr
, "process id \'%d", target_pid
);
552 fprintf(stderr
, "thread id \'%d", target_tid
);
554 fprintf(stderr
, "\'");
556 fprintf(stderr
, " (%d runs)", run_count
);
557 fprintf(stderr
, ":\n\n");
561 list_for_each_entry(counter
, &evsel_list
->entries
, node
)
562 print_counter(counter
);
564 list_for_each_entry(counter
, &evsel_list
->entries
, node
)
565 print_counter_aggr(counter
);
569 fprintf(stderr
, "\n");
570 fprintf(stderr
, " %18.9f seconds time elapsed",
571 avg_stats(&walltime_nsecs_stats
)/1e9
);
573 fprintf(stderr
, " ( +- %7.3f%% )",
574 100*stddev_stats(&walltime_nsecs_stats
) /
575 avg_stats(&walltime_nsecs_stats
));
577 fprintf(stderr
, "\n\n");
581 static volatile int signr
= -1;
583 static void skip_signal(int signo
)
591 static void sig_atexit(void)
594 kill(child_pid
, SIGTERM
);
599 signal(signr
, SIG_DFL
);
600 kill(getpid(), signr
);
603 static const char * const stat_usage
[] = {
604 "perf stat [<options>] [<command>]",
608 static int stat__set_big_num(const struct option
*opt __used
,
609 const char *s __used
, int unset
)
611 big_num_opt
= unset
? 0 : 1;
615 static const struct option options
[] = {
616 OPT_CALLBACK('e', "event", &evsel_list
, "event",
617 "event selector. use 'perf list' to list available events",
619 OPT_BOOLEAN('i', "no-inherit", &no_inherit
,
620 "child tasks do not inherit counters"),
621 OPT_INTEGER('p', "pid", &target_pid
,
622 "stat events on existing process id"),
623 OPT_INTEGER('t', "tid", &target_tid
,
624 "stat events on existing thread id"),
625 OPT_BOOLEAN('a', "all-cpus", &system_wide
,
626 "system-wide collection from all CPUs"),
627 OPT_BOOLEAN('c', "scale", &scale
,
628 "scale/normalize counters"),
629 OPT_INCR('v', "verbose", &verbose
,
630 "be more verbose (show counter open errors, etc)"),
631 OPT_INTEGER('r', "repeat", &run_count
,
632 "repeat command and print average + stddev (max: 100)"),
633 OPT_BOOLEAN('n', "null", &null_run
,
634 "null run - dont start any counters"),
635 OPT_CALLBACK_NOOPT('B', "big-num", NULL
, NULL
,
636 "print large numbers with thousands\' separators",
638 OPT_STRING('C', "cpu", &cpu_list
, "cpu",
639 "list of cpus to monitor in system-wide"),
640 OPT_BOOLEAN('A', "no-aggr", &no_aggr
,
641 "disable CPU count aggregation"),
642 OPT_STRING('x', "field-separator", &csv_sep
, "separator",
643 "print counts with custom separator"),
647 int cmd_stat(int argc
, const char **argv
, const char *prefix __used
)
649 struct perf_evsel
*pos
;
650 int status
= -ENOMEM
;
652 setlocale(LC_ALL
, "");
654 evsel_list
= perf_evlist__new();
655 if (evsel_list
== NULL
)
658 argc
= parse_options(argc
, argv
, options
, stat_usage
,
659 PARSE_OPT_STOP_AT_NON_OPTION
);
664 csv_sep
= DEFAULT_SEPARATOR
;
667 * let the spreadsheet do the pretty-printing
670 /* User explicitely passed -B? */
671 if (big_num_opt
== 1) {
672 fprintf(stderr
, "-B option not supported with -x\n");
673 usage_with_options(stat_usage
, options
);
674 } else /* Nope, so disable big number formatting */
676 } else if (big_num_opt
== 0) /* User passed --no-big-num */
679 if (!argc
&& target_pid
== -1 && target_tid
== -1)
680 usage_with_options(stat_usage
, options
);
682 usage_with_options(stat_usage
, options
);
684 /* no_aggr is for system-wide only */
685 if (no_aggr
&& !system_wide
)
686 usage_with_options(stat_usage
, options
);
688 /* Set attrs and nr_counters if no event is selected and !null_run */
689 if (!null_run
&& !evsel_list
->nr_entries
) {
692 for (c
= 0; c
< ARRAY_SIZE(default_attrs
); ++c
) {
693 pos
= perf_evsel__new(&default_attrs
[c
], c
);
696 perf_evlist__add(evsel_list
, pos
);
700 if (target_pid
!= -1)
701 target_tid
= target_pid
;
703 threads
= thread_map__new(target_pid
, target_tid
);
704 if (threads
== NULL
) {
705 pr_err("Problems finding threads of monitor\n");
706 usage_with_options(stat_usage
, options
);
710 cpus
= cpu_map__new(cpu_list
);
712 cpus
= cpu_map__dummy_new();
715 perror("failed to parse CPUs map");
716 usage_with_options(stat_usage
, options
);
720 list_for_each_entry(pos
, &evsel_list
->entries
, node
) {
721 if (perf_evsel__alloc_stat_priv(pos
) < 0 ||
722 perf_evsel__alloc_counts(pos
, cpus
->nr
) < 0 ||
723 perf_evsel__alloc_fd(pos
, cpus
->nr
, threads
->nr
) < 0)
728 * We dont want to block the signals - that would cause
729 * child tasks to inherit that and Ctrl-C would not work.
730 * What we want is for Ctrl-C to work in the exec()-ed
731 * task, but being ignored by perf stat itself:
734 signal(SIGINT
, skip_signal
);
735 signal(SIGALRM
, skip_signal
);
736 signal(SIGABRT
, skip_signal
);
739 for (run_idx
= 0; run_idx
< run_count
; run_idx
++) {
740 if (run_count
!= 1 && verbose
)
741 fprintf(stderr
, "[ perf stat: executing run #%d ... ]\n", run_idx
+ 1);
742 status
= run_perf_stat(argc
, argv
);
746 print_stat(argc
, argv
);
748 list_for_each_entry(pos
, &evsel_list
->entries
, node
)
749 perf_evsel__free_stat_priv(pos
);
750 perf_evlist__delete(evsel_list
);
752 thread_map__delete(threads
);