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"
52 #include "util/thread_map.h"
54 #include <sys/prctl.h>
58 #define DEFAULT_SEPARATOR " "
60 static struct perf_event_attr default_attrs
[] = {
62 { .type
= PERF_TYPE_SOFTWARE
, .config
= PERF_COUNT_SW_TASK_CLOCK
},
63 { .type
= PERF_TYPE_SOFTWARE
, .config
= PERF_COUNT_SW_CONTEXT_SWITCHES
},
64 { .type
= PERF_TYPE_SOFTWARE
, .config
= PERF_COUNT_SW_CPU_MIGRATIONS
},
65 { .type
= PERF_TYPE_SOFTWARE
, .config
= PERF_COUNT_SW_PAGE_FAULTS
},
67 { .type
= PERF_TYPE_HARDWARE
, .config
= PERF_COUNT_HW_CPU_CYCLES
},
68 { .type
= PERF_TYPE_HARDWARE
, .config
= PERF_COUNT_HW_INSTRUCTIONS
},
69 { .type
= PERF_TYPE_HARDWARE
, .config
= PERF_COUNT_HW_BRANCH_INSTRUCTIONS
},
70 { .type
= PERF_TYPE_HARDWARE
, .config
= PERF_COUNT_HW_BRANCH_MISSES
},
71 { .type
= PERF_TYPE_HARDWARE
, .config
= PERF_COUNT_HW_CACHE_REFERENCES
},
72 { .type
= PERF_TYPE_HARDWARE
, .config
= PERF_COUNT_HW_CACHE_MISSES
},
76 struct perf_evlist
*evsel_list
;
78 static bool system_wide
= false;
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 pid_t child_pid
= -1;
88 static bool null_run
= false;
89 static bool big_num
= true;
90 static int big_num_opt
= -1;
91 static const char *cpu_list
;
92 static const char *csv_sep
= NULL
;
93 static bool csv_output
= false;
95 static volatile int done
= 0;
103 struct stats res_stats
[3];
106 static int perf_evsel__alloc_stat_priv(struct perf_evsel
*evsel
)
108 evsel
->priv
= zalloc(sizeof(struct perf_stat
));
109 return evsel
->priv
== NULL
? -ENOMEM
: 0;
112 static void perf_evsel__free_stat_priv(struct perf_evsel
*evsel
)
118 static void update_stats(struct stats
*stats
, u64 val
)
123 delta
= val
- stats
->mean
;
124 stats
->mean
+= delta
/ stats
->n
;
125 stats
->M2
+= delta
*(val
- stats
->mean
);
128 static double avg_stats(struct stats
*stats
)
134 * http://en.wikipedia.org/wiki/Algorithms_for_calculating_variance
136 * (\Sum n_i^2) - ((\Sum n_i)^2)/n
137 * s^2 = -------------------------------
140 * http://en.wikipedia.org/wiki/Stddev
142 * The std dev of the mean is related to the std dev by:
149 static double stddev_stats(struct stats
*stats
)
151 double variance
= stats
->M2
/ (stats
->n
- 1);
152 double variance_mean
= variance
/ stats
->n
;
154 return sqrt(variance_mean
);
157 struct stats runtime_nsecs_stats
[MAX_NR_CPUS
];
158 struct stats runtime_cycles_stats
[MAX_NR_CPUS
];
159 struct stats runtime_branches_stats
[MAX_NR_CPUS
];
160 struct stats runtime_cacherefs_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
;
171 attr
->inherit
= !no_inherit
;
174 return perf_evsel__open_per_cpu(evsel
, evsel_list
->cpus
, false);
176 if (target_pid
== -1 && target_tid
== -1) {
178 attr
->enable_on_exec
= 1;
181 return perf_evsel__open_per_thread(evsel
, evsel_list
->threads
, false);
185 * Does the counter have nsecs as a unit?
187 static inline int nsec_counter(struct perf_evsel
*evsel
)
189 if (perf_evsel__match(evsel
, SOFTWARE
, SW_CPU_CLOCK
) ||
190 perf_evsel__match(evsel
, SOFTWARE
, SW_TASK_CLOCK
))
197 * Read out the results of a single counter:
198 * aggregate counts across CPUs in system-wide mode
200 static int read_counter_aggr(struct perf_evsel
*counter
)
202 struct perf_stat
*ps
= counter
->priv
;
203 u64
*count
= counter
->counts
->aggr
.values
;
206 if (__perf_evsel__read(counter
, evsel_list
->cpus
->nr
,
207 evsel_list
->threads
->nr
, scale
) < 0)
210 for (i
= 0; i
< 3; i
++)
211 update_stats(&ps
->res_stats
[i
], count
[i
]);
214 fprintf(stderr
, "%s: %" PRIu64
" %" PRIu64
" %" PRIu64
"\n",
215 event_name(counter
), count
[0], count
[1], count
[2]);
219 * Save the full runtime - to allow normalization during printout:
221 if (perf_evsel__match(counter
, SOFTWARE
, SW_TASK_CLOCK
))
222 update_stats(&runtime_nsecs_stats
[0], count
[0]);
223 else if (perf_evsel__match(counter
, HARDWARE
, HW_CPU_CYCLES
))
224 update_stats(&runtime_cycles_stats
[0], count
[0]);
225 else if (perf_evsel__match(counter
, HARDWARE
, HW_BRANCH_INSTRUCTIONS
))
226 update_stats(&runtime_branches_stats
[0], count
[0]);
227 else if (perf_evsel__match(counter
, HARDWARE
, HW_CACHE_REFERENCES
))
228 update_stats(&runtime_cacherefs_stats
[0], count
[0]);
234 * Read out the results of a single counter:
235 * do not aggregate counts across CPUs in system-wide mode
237 static int read_counter(struct perf_evsel
*counter
)
242 for (cpu
= 0; cpu
< evsel_list
->cpus
->nr
; cpu
++) {
243 if (__perf_evsel__read_on_cpu(counter
, cpu
, 0, scale
) < 0)
246 count
= counter
->counts
->cpu
[cpu
].values
;
248 if (perf_evsel__match(counter
, SOFTWARE
, SW_TASK_CLOCK
))
249 update_stats(&runtime_nsecs_stats
[cpu
], count
[0]);
250 if (perf_evsel__match(counter
, HARDWARE
, HW_CPU_CYCLES
))
251 update_stats(&runtime_cycles_stats
[cpu
], count
[0]);
252 if (perf_evsel__match(counter
, HARDWARE
, HW_BRANCH_INSTRUCTIONS
))
253 update_stats(&runtime_branches_stats
[cpu
], count
[0]);
259 static int run_perf_stat(int argc __used
, const char **argv
)
261 unsigned long long t0
, t1
;
262 struct perf_evsel
*counter
;
264 int child_ready_pipe
[2], go_pipe
[2];
265 const bool forks
= (argc
> 0);
268 if (forks
&& (pipe(child_ready_pipe
) < 0 || pipe(go_pipe
) < 0)) {
269 perror("failed to create pipes");
274 if ((child_pid
= fork()) < 0)
275 perror("failed to fork");
278 close(child_ready_pipe
[0]);
280 fcntl(go_pipe
[0], F_SETFD
, FD_CLOEXEC
);
283 * Do a dummy execvp to get the PLT entry resolved,
284 * so we avoid the resolver overhead on the real
287 execvp("", (char **)argv
);
290 * Tell the parent we're ready to go
292 close(child_ready_pipe
[1]);
295 * Wait until the parent tells us to go.
297 if (read(go_pipe
[0], &buf
, 1) == -1)
298 perror("unable to read pipe");
300 execvp(argv
[0], (char **)argv
);
306 if (target_tid
== -1 && target_pid
== -1 && !system_wide
)
307 evsel_list
->threads
->map
[0] = child_pid
;
310 * Wait for the child to be ready to exec.
312 close(child_ready_pipe
[1]);
314 if (read(child_ready_pipe
[0], &buf
, 1) == -1)
315 perror("unable to read pipe");
316 close(child_ready_pipe
[0]);
319 list_for_each_entry(counter
, &evsel_list
->entries
, node
) {
320 if (create_perf_stat_counter(counter
) < 0) {
321 if (errno
== -EPERM
|| errno
== -EACCES
) {
322 error("You may not have permission to collect %sstats.\n"
323 "\t Consider tweaking"
324 " /proc/sys/kernel/perf_event_paranoid or running as root.",
325 system_wide
? "system-wide " : "");
326 } else if (errno
== ENOENT
) {
327 error("%s event is not supported. ", event_name(counter
));
329 error("open_counter returned with %d (%s). "
330 "/bin/dmesg may provide additional information.\n",
331 errno
, strerror(errno
));
334 kill(child_pid
, SIGTERM
);
335 die("Not all events could be opened.\n");
340 if (perf_evlist__set_filters(evsel_list
)) {
341 error("failed to set filter with %d (%s)\n", errno
,
347 * Enable counters and exec the command:
355 while(!done
) sleep(1);
360 update_stats(&walltime_nsecs_stats
, t1
- t0
);
363 list_for_each_entry(counter
, &evsel_list
->entries
, node
) {
364 read_counter(counter
);
365 perf_evsel__close_fd(counter
, evsel_list
->cpus
->nr
, 1);
368 list_for_each_entry(counter
, &evsel_list
->entries
, node
) {
369 read_counter_aggr(counter
);
370 perf_evsel__close_fd(counter
, evsel_list
->cpus
->nr
,
371 evsel_list
->threads
->nr
);
375 return WEXITSTATUS(status
);
378 static void print_noise(struct perf_evsel
*evsel
, double avg
)
380 struct perf_stat
*ps
;
386 fprintf(stderr
, " ( +- %7.3f%% )",
387 100 * stddev_stats(&ps
->res_stats
[0]) / avg
);
390 static void nsec_printout(int cpu
, struct perf_evsel
*evsel
, double avg
)
392 double msecs
= avg
/ 1e6
;
393 char cpustr
[16] = { '\0', };
394 const char *fmt
= csv_output
? "%s%.6f%s%s" : "%s%18.6f%s%-24s";
397 sprintf(cpustr
, "CPU%*d%s",
399 evsel_list
->cpus
->map
[cpu
], csv_sep
);
401 fprintf(stderr
, fmt
, cpustr
, msecs
, csv_sep
, event_name(evsel
));
404 fprintf(stderr
, "%s%s", csv_sep
, evsel
->cgrp
->name
);
409 if (perf_evsel__match(evsel
, SOFTWARE
, SW_TASK_CLOCK
))
410 fprintf(stderr
, " # %10.3f CPUs",
411 avg
/ avg_stats(&walltime_nsecs_stats
));
414 static void abs_printout(int cpu
, struct perf_evsel
*evsel
, double avg
)
416 double total
, ratio
= 0.0;
417 char cpustr
[16] = { '\0', };
423 fmt
= "%s%'18.0f%s%-24s";
425 fmt
= "%s%18.0f%s%-24s";
428 sprintf(cpustr
, "CPU%*d%s",
430 evsel_list
->cpus
->map
[cpu
], csv_sep
);
434 fprintf(stderr
, fmt
, cpustr
, avg
, csv_sep
, event_name(evsel
));
437 fprintf(stderr
, "%s%s", csv_sep
, evsel
->cgrp
->name
);
442 if (perf_evsel__match(evsel
, HARDWARE
, HW_INSTRUCTIONS
)) {
443 total
= avg_stats(&runtime_cycles_stats
[cpu
]);
448 fprintf(stderr
, " # ( %4.2f instructions per cycle )", ratio
);
449 } else if (perf_evsel__match(evsel
, HARDWARE
, HW_BRANCH_MISSES
) &&
450 runtime_branches_stats
[cpu
].n
!= 0) {
451 total
= avg_stats(&runtime_branches_stats
[cpu
]);
454 ratio
= avg
* 100 / total
;
456 fprintf(stderr
, " # %10.3f %%", ratio
);
458 } else if (perf_evsel__match(evsel
, HARDWARE
, HW_CACHE_MISSES
) &&
459 runtime_cacherefs_stats
[cpu
].n
!= 0) {
460 total
= avg_stats(&runtime_cacherefs_stats
[cpu
]);
463 ratio
= avg
* 100 / total
;
465 fprintf(stderr
, " # %10.3f %%", ratio
);
467 } else if (runtime_nsecs_stats
[cpu
].n
!= 0) {
468 total
= avg_stats(&runtime_nsecs_stats
[cpu
]);
471 ratio
= 1000.0 * avg
/ total
;
473 fprintf(stderr
, " # %10.3f M/sec", ratio
);
474 } else if (perf_evsel__match(evsel
, HARDWARE
, HW_STALLED_CYCLES
)) {
475 total
= avg_stats(&runtime_cycles_stats
[cpu
]);
478 ratio
= avg
/ total
* 100.0;
480 fprintf(stderr
, " # (%5.2f%% of all cycles )", ratio
);
485 * Print out the results of a single counter:
486 * aggregated counts in system-wide mode
488 static void print_counter_aggr(struct perf_evsel
*counter
)
490 struct perf_stat
*ps
= counter
->priv
;
491 double avg
= avg_stats(&ps
->res_stats
[0]);
492 int scaled
= counter
->counts
->scaled
;
495 fprintf(stderr
, "%*s%s%*s",
499 csv_output
? 0 : -24,
500 event_name(counter
));
503 fprintf(stderr
, "%s%s", csv_sep
, counter
->cgrp
->name
);
509 if (nsec_counter(counter
))
510 nsec_printout(-1, counter
, avg
);
512 abs_printout(-1, counter
, avg
);
519 print_noise(counter
, avg
);
522 double avg_enabled
, avg_running
;
524 avg_enabled
= avg_stats(&ps
->res_stats
[1]);
525 avg_running
= avg_stats(&ps
->res_stats
[2]);
527 fprintf(stderr
, " (scaled from %.2f%%)",
528 100 * avg_running
/ avg_enabled
);
530 fprintf(stderr
, "\n");
534 * Print out the results of a single counter:
535 * does not use aggregated count in system-wide
537 static void print_counter(struct perf_evsel
*counter
)
542 for (cpu
= 0; cpu
< evsel_list
->cpus
->nr
; cpu
++) {
543 val
= counter
->counts
->cpu
[cpu
].val
;
544 ena
= counter
->counts
->cpu
[cpu
].ena
;
545 run
= counter
->counts
->cpu
[cpu
].run
;
546 if (run
== 0 || ena
== 0) {
547 fprintf(stderr
, "CPU%*d%s%*s%s%*s",
549 evsel_list
->cpus
->map
[cpu
], csv_sep
,
551 "<not counted>", csv_sep
,
552 csv_output
? 0 : -24,
553 event_name(counter
));
556 fprintf(stderr
, "%s%s", csv_sep
, counter
->cgrp
->name
);
562 if (nsec_counter(counter
))
563 nsec_printout(cpu
, counter
, val
);
565 abs_printout(cpu
, counter
, val
);
568 print_noise(counter
, 1.0);
571 fprintf(stderr
, " (scaled from %.2f%%)",
579 static void print_stat(int argc
, const char **argv
)
581 struct perf_evsel
*counter
;
587 fprintf(stderr
, "\n");
588 fprintf(stderr
, " Performance counter stats for ");
589 if(target_pid
== -1 && target_tid
== -1) {
590 fprintf(stderr
, "\'%s", argv
[0]);
591 for (i
= 1; i
< argc
; i
++)
592 fprintf(stderr
, " %s", argv
[i
]);
593 } else if (target_pid
!= -1)
594 fprintf(stderr
, "process id \'%d", target_pid
);
596 fprintf(stderr
, "thread id \'%d", target_tid
);
598 fprintf(stderr
, "\'");
600 fprintf(stderr
, " (%d runs)", run_count
);
601 fprintf(stderr
, ":\n\n");
605 list_for_each_entry(counter
, &evsel_list
->entries
, node
)
606 print_counter(counter
);
608 list_for_each_entry(counter
, &evsel_list
->entries
, node
)
609 print_counter_aggr(counter
);
613 fprintf(stderr
, "\n");
614 fprintf(stderr
, " %18.9f seconds time elapsed",
615 avg_stats(&walltime_nsecs_stats
)/1e9
);
617 fprintf(stderr
, " ( +- %7.3f%% )",
618 100*stddev_stats(&walltime_nsecs_stats
) /
619 avg_stats(&walltime_nsecs_stats
));
621 fprintf(stderr
, "\n\n");
625 static volatile int signr
= -1;
627 static void skip_signal(int signo
)
635 static void sig_atexit(void)
638 kill(child_pid
, SIGTERM
);
643 signal(signr
, SIG_DFL
);
644 kill(getpid(), signr
);
647 static const char * const stat_usage
[] = {
648 "perf stat [<options>] [<command>]",
652 static int stat__set_big_num(const struct option
*opt __used
,
653 const char *s __used
, int unset
)
655 big_num_opt
= unset
? 0 : 1;
659 static const struct option options
[] = {
660 OPT_CALLBACK('e', "event", &evsel_list
, "event",
661 "event selector. use 'perf list' to list available events",
663 OPT_CALLBACK(0, "filter", &evsel_list
, "filter",
664 "event filter", parse_filter
),
665 OPT_BOOLEAN('i', "no-inherit", &no_inherit
,
666 "child tasks do not inherit counters"),
667 OPT_INTEGER('p', "pid", &target_pid
,
668 "stat events on existing process id"),
669 OPT_INTEGER('t', "tid", &target_tid
,
670 "stat events on existing thread id"),
671 OPT_BOOLEAN('a', "all-cpus", &system_wide
,
672 "system-wide collection from all CPUs"),
673 OPT_BOOLEAN('c', "scale", &scale
,
674 "scale/normalize counters"),
675 OPT_INCR('v', "verbose", &verbose
,
676 "be more verbose (show counter open errors, etc)"),
677 OPT_INTEGER('r', "repeat", &run_count
,
678 "repeat command and print average + stddev (max: 100)"),
679 OPT_BOOLEAN('n', "null", &null_run
,
680 "null run - dont start any counters"),
681 OPT_CALLBACK_NOOPT('B', "big-num", NULL
, NULL
,
682 "print large numbers with thousands\' separators",
684 OPT_STRING('C', "cpu", &cpu_list
, "cpu",
685 "list of cpus to monitor in system-wide"),
686 OPT_BOOLEAN('A', "no-aggr", &no_aggr
,
687 "disable CPU count aggregation"),
688 OPT_STRING('x', "field-separator", &csv_sep
, "separator",
689 "print counts with custom separator"),
690 OPT_CALLBACK('G', "cgroup", &evsel_list
, "name",
691 "monitor event in cgroup name only",
696 int cmd_stat(int argc
, const char **argv
, const char *prefix __used
)
698 struct perf_evsel
*pos
;
699 int status
= -ENOMEM
;
701 setlocale(LC_ALL
, "");
703 evsel_list
= perf_evlist__new(NULL
, NULL
);
704 if (evsel_list
== NULL
)
707 argc
= parse_options(argc
, argv
, options
, stat_usage
,
708 PARSE_OPT_STOP_AT_NON_OPTION
);
713 csv_sep
= DEFAULT_SEPARATOR
;
716 * let the spreadsheet do the pretty-printing
719 /* User explicitely passed -B? */
720 if (big_num_opt
== 1) {
721 fprintf(stderr
, "-B option not supported with -x\n");
722 usage_with_options(stat_usage
, options
);
723 } else /* Nope, so disable big number formatting */
725 } else if (big_num_opt
== 0) /* User passed --no-big-num */
728 if (!argc
&& target_pid
== -1 && target_tid
== -1)
729 usage_with_options(stat_usage
, options
);
731 usage_with_options(stat_usage
, options
);
733 /* no_aggr, cgroup are for system-wide only */
734 if ((no_aggr
|| nr_cgroups
) && !system_wide
) {
735 fprintf(stderr
, "both cgroup and no-aggregation "
736 "modes only available in system-wide mode\n");
738 usage_with_options(stat_usage
, options
);
741 /* Set attrs and nr_counters if no event is selected and !null_run */
742 if (!null_run
&& !evsel_list
->nr_entries
) {
745 for (c
= 0; c
< ARRAY_SIZE(default_attrs
); ++c
) {
746 pos
= perf_evsel__new(&default_attrs
[c
], c
);
749 perf_evlist__add(evsel_list
, pos
);
753 if (target_pid
!= -1)
754 target_tid
= target_pid
;
756 evsel_list
->threads
= thread_map__new(target_pid
, target_tid
);
757 if (evsel_list
->threads
== NULL
) {
758 pr_err("Problems finding threads of monitor\n");
759 usage_with_options(stat_usage
, options
);
763 evsel_list
->cpus
= cpu_map__new(cpu_list
);
765 evsel_list
->cpus
= cpu_map__dummy_new();
767 if (evsel_list
->cpus
== NULL
) {
768 perror("failed to parse CPUs map");
769 usage_with_options(stat_usage
, options
);
773 list_for_each_entry(pos
, &evsel_list
->entries
, node
) {
774 if (perf_evsel__alloc_stat_priv(pos
) < 0 ||
775 perf_evsel__alloc_counts(pos
, evsel_list
->cpus
->nr
) < 0 ||
776 perf_evsel__alloc_fd(pos
, evsel_list
->cpus
->nr
, evsel_list
->threads
->nr
) < 0)
781 * We dont want to block the signals - that would cause
782 * child tasks to inherit that and Ctrl-C would not work.
783 * What we want is for Ctrl-C to work in the exec()-ed
784 * task, but being ignored by perf stat itself:
787 signal(SIGINT
, skip_signal
);
788 signal(SIGALRM
, skip_signal
);
789 signal(SIGABRT
, skip_signal
);
792 for (run_idx
= 0; run_idx
< run_count
; run_idx
++) {
793 if (run_count
!= 1 && verbose
)
794 fprintf(stderr
, "[ perf stat: executing run #%d ... ]\n", run_idx
+ 1);
795 status
= run_perf_stat(argc
, argv
);
799 print_stat(argc
, argv
);
801 list_for_each_entry(pos
, &evsel_list
->entries
, node
)
802 perf_evsel__free_stat_priv(pos
);
803 perf_evlist__delete_maps(evsel_list
);
805 perf_evlist__delete(evsel_list
);