Loading...
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
11 Time: 0.118
12
13 Performance counter stats for './hackbench 10':
14
15 1708.761321 task-clock # 11.037 CPUs utilized
16 41,190 context-switches # 0.024 M/sec
17 6,735 CPU-migrations # 0.004 M/sec
18 17,318 page-faults # 0.010 M/sec
19 5,205,202,243 cycles # 3.046 GHz
20 3,856,436,920 stalled-cycles-frontend # 74.09% frontend cycles idle
21 1,600,790,871 stalled-cycles-backend # 30.75% backend cycles idle
22 2,603,501,247 instructions # 0.50 insns per cycle
23 # 1.48 stalled cycles per insn
24 484,357,498 branches # 283.455 M/sec
25 6,388,934 branch-misses # 1.32% of all branches
26
27 0.154822978 seconds time elapsed
28
29 *
30 * Copyright (C) 2008-2011, Red Hat Inc, Ingo Molnar <mingo@redhat.com>
31 *
32 * Improvements and fixes by:
33 *
34 * Arjan van de Ven <arjan@linux.intel.com>
35 * Yanmin Zhang <yanmin.zhang@intel.com>
36 * Wu Fengguang <fengguang.wu@intel.com>
37 * Mike Galbraith <efault@gmx.de>
38 * Paul Mackerras <paulus@samba.org>
39 * Jaswinder Singh Rajput <jaswinder@kernel.org>
40 *
41 * Released under the GPL v2. (and only v2, not any later version)
42 */
43
44#include "perf.h"
45#include "builtin.h"
46#include "util/util.h"
47#include "util/parse-options.h"
48#include "util/parse-events.h"
49#include "util/event.h"
50#include "util/evlist.h"
51#include "util/evsel.h"
52#include "util/debug.h"
53#include "util/color.h"
54#include "util/header.h"
55#include "util/cpumap.h"
56#include "util/thread.h"
57#include "util/thread_map.h"
58
59#include <sys/prctl.h>
60#include <math.h>
61#include <locale.h>
62
63#define DEFAULT_SEPARATOR " "
64#define CNTR_NOT_SUPPORTED "<not supported>"
65#define CNTR_NOT_COUNTED "<not counted>"
66
67static struct perf_event_attr default_attrs[] = {
68
69 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_TASK_CLOCK },
70 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_CONTEXT_SWITCHES },
71 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_CPU_MIGRATIONS },
72 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_PAGE_FAULTS },
73
74 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_CPU_CYCLES },
75 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_STALLED_CYCLES_FRONTEND },
76 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_STALLED_CYCLES_BACKEND },
77 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_INSTRUCTIONS },
78 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_BRANCH_INSTRUCTIONS },
79 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_BRANCH_MISSES },
80
81};
82
83/*
84 * Detailed stats (-d), covering the L1 and last level data caches:
85 */
86static struct perf_event_attr detailed_attrs[] = {
87
88 { .type = PERF_TYPE_HW_CACHE,
89 .config =
90 PERF_COUNT_HW_CACHE_L1D << 0 |
91 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
92 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
93
94 { .type = PERF_TYPE_HW_CACHE,
95 .config =
96 PERF_COUNT_HW_CACHE_L1D << 0 |
97 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
98 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
99
100 { .type = PERF_TYPE_HW_CACHE,
101 .config =
102 PERF_COUNT_HW_CACHE_LL << 0 |
103 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
104 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
105
106 { .type = PERF_TYPE_HW_CACHE,
107 .config =
108 PERF_COUNT_HW_CACHE_LL << 0 |
109 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
110 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
111};
112
113/*
114 * Very detailed stats (-d -d), covering the instruction cache and the TLB caches:
115 */
116static struct perf_event_attr very_detailed_attrs[] = {
117
118 { .type = PERF_TYPE_HW_CACHE,
119 .config =
120 PERF_COUNT_HW_CACHE_L1I << 0 |
121 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
122 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
123
124 { .type = PERF_TYPE_HW_CACHE,
125 .config =
126 PERF_COUNT_HW_CACHE_L1I << 0 |
127 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
128 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
129
130 { .type = PERF_TYPE_HW_CACHE,
131 .config =
132 PERF_COUNT_HW_CACHE_DTLB << 0 |
133 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
134 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
135
136 { .type = PERF_TYPE_HW_CACHE,
137 .config =
138 PERF_COUNT_HW_CACHE_DTLB << 0 |
139 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
140 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
141
142 { .type = PERF_TYPE_HW_CACHE,
143 .config =
144 PERF_COUNT_HW_CACHE_ITLB << 0 |
145 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
146 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
147
148 { .type = PERF_TYPE_HW_CACHE,
149 .config =
150 PERF_COUNT_HW_CACHE_ITLB << 0 |
151 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
152 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
153
154};
155
156/*
157 * Very, very detailed stats (-d -d -d), adding prefetch events:
158 */
159static struct perf_event_attr very_very_detailed_attrs[] = {
160
161 { .type = PERF_TYPE_HW_CACHE,
162 .config =
163 PERF_COUNT_HW_CACHE_L1D << 0 |
164 (PERF_COUNT_HW_CACHE_OP_PREFETCH << 8) |
165 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
166
167 { .type = PERF_TYPE_HW_CACHE,
168 .config =
169 PERF_COUNT_HW_CACHE_L1D << 0 |
170 (PERF_COUNT_HW_CACHE_OP_PREFETCH << 8) |
171 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
172};
173
174
175
176static struct perf_evlist *evsel_list;
177
178static struct perf_target target = {
179 .uid = UINT_MAX,
180};
181
182static int run_idx = 0;
183static int run_count = 1;
184static bool no_inherit = false;
185static bool scale = true;
186static bool no_aggr = false;
187static pid_t child_pid = -1;
188static bool null_run = false;
189static int detailed_run = 0;
190static bool sync_run = false;
191static bool big_num = true;
192static int big_num_opt = -1;
193static const char *csv_sep = NULL;
194static bool csv_output = false;
195static bool group = false;
196static const char *output_name = NULL;
197static FILE *output = NULL;
198static int output_fd;
199
200static volatile int done = 0;
201
202struct stats
203{
204 double n, mean, M2;
205};
206
207struct perf_stat {
208 struct stats res_stats[3];
209};
210
211static int perf_evsel__alloc_stat_priv(struct perf_evsel *evsel)
212{
213 evsel->priv = zalloc(sizeof(struct perf_stat));
214 return evsel->priv == NULL ? -ENOMEM : 0;
215}
216
217static void perf_evsel__free_stat_priv(struct perf_evsel *evsel)
218{
219 free(evsel->priv);
220 evsel->priv = NULL;
221}
222
223static void update_stats(struct stats *stats, u64 val)
224{
225 double delta;
226
227 stats->n++;
228 delta = val - stats->mean;
229 stats->mean += delta / stats->n;
230 stats->M2 += delta*(val - stats->mean);
231}
232
233static double avg_stats(struct stats *stats)
234{
235 return stats->mean;
236}
237
238/*
239 * http://en.wikipedia.org/wiki/Algorithms_for_calculating_variance
240 *
241 * (\Sum n_i^2) - ((\Sum n_i)^2)/n
242 * s^2 = -------------------------------
243 * n - 1
244 *
245 * http://en.wikipedia.org/wiki/Stddev
246 *
247 * The std dev of the mean is related to the std dev by:
248 *
249 * s
250 * s_mean = -------
251 * sqrt(n)
252 *
253 */
254static double stddev_stats(struct stats *stats)
255{
256 double variance, variance_mean;
257
258 if (!stats->n)
259 return 0.0;
260
261 variance = stats->M2 / (stats->n - 1);
262 variance_mean = variance / stats->n;
263
264 return sqrt(variance_mean);
265}
266
267static struct stats runtime_nsecs_stats[MAX_NR_CPUS];
268static struct stats runtime_cycles_stats[MAX_NR_CPUS];
269static struct stats runtime_stalled_cycles_front_stats[MAX_NR_CPUS];
270static struct stats runtime_stalled_cycles_back_stats[MAX_NR_CPUS];
271static struct stats runtime_branches_stats[MAX_NR_CPUS];
272static struct stats runtime_cacherefs_stats[MAX_NR_CPUS];
273static struct stats runtime_l1_dcache_stats[MAX_NR_CPUS];
274static struct stats runtime_l1_icache_stats[MAX_NR_CPUS];
275static struct stats runtime_ll_cache_stats[MAX_NR_CPUS];
276static struct stats runtime_itlb_cache_stats[MAX_NR_CPUS];
277static struct stats runtime_dtlb_cache_stats[MAX_NR_CPUS];
278static struct stats walltime_nsecs_stats;
279
280static int create_perf_stat_counter(struct perf_evsel *evsel,
281 struct perf_evsel *first)
282{
283 struct perf_event_attr *attr = &evsel->attr;
284 struct xyarray *group_fd = NULL;
285 bool exclude_guest_missing = false;
286 int ret;
287
288 if (group && evsel != first)
289 group_fd = first->fd;
290
291 if (scale)
292 attr->read_format = PERF_FORMAT_TOTAL_TIME_ENABLED |
293 PERF_FORMAT_TOTAL_TIME_RUNNING;
294
295 attr->inherit = !no_inherit;
296
297retry:
298 if (exclude_guest_missing)
299 evsel->attr.exclude_guest = evsel->attr.exclude_host = 0;
300
301 if (perf_target__has_cpu(&target)) {
302 ret = perf_evsel__open_per_cpu(evsel, evsel_list->cpus,
303 group, group_fd);
304 if (ret)
305 goto check_ret;
306 return 0;
307 }
308
309 if (!perf_target__has_task(&target) && (!group || evsel == first)) {
310 attr->disabled = 1;
311 attr->enable_on_exec = 1;
312 }
313
314 ret = perf_evsel__open_per_thread(evsel, evsel_list->threads,
315 group, group_fd);
316 if (!ret)
317 return 0;
318 /* fall through */
319check_ret:
320 if (ret && errno == EINVAL) {
321 if (!exclude_guest_missing &&
322 (evsel->attr.exclude_guest || evsel->attr.exclude_host)) {
323 pr_debug("Old kernel, cannot exclude "
324 "guest or host samples.\n");
325 exclude_guest_missing = true;
326 goto retry;
327 }
328 }
329 return ret;
330}
331
332/*
333 * Does the counter have nsecs as a unit?
334 */
335static inline int nsec_counter(struct perf_evsel *evsel)
336{
337 if (perf_evsel__match(evsel, SOFTWARE, SW_CPU_CLOCK) ||
338 perf_evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK))
339 return 1;
340
341 return 0;
342}
343
344/*
345 * Update various tracking values we maintain to print
346 * more semantic information such as miss/hit ratios,
347 * instruction rates, etc:
348 */
349static void update_shadow_stats(struct perf_evsel *counter, u64 *count)
350{
351 if (perf_evsel__match(counter, SOFTWARE, SW_TASK_CLOCK))
352 update_stats(&runtime_nsecs_stats[0], count[0]);
353 else if (perf_evsel__match(counter, HARDWARE, HW_CPU_CYCLES))
354 update_stats(&runtime_cycles_stats[0], count[0]);
355 else if (perf_evsel__match(counter, HARDWARE, HW_STALLED_CYCLES_FRONTEND))
356 update_stats(&runtime_stalled_cycles_front_stats[0], count[0]);
357 else if (perf_evsel__match(counter, HARDWARE, HW_STALLED_CYCLES_BACKEND))
358 update_stats(&runtime_stalled_cycles_back_stats[0], count[0]);
359 else if (perf_evsel__match(counter, HARDWARE, HW_BRANCH_INSTRUCTIONS))
360 update_stats(&runtime_branches_stats[0], count[0]);
361 else if (perf_evsel__match(counter, HARDWARE, HW_CACHE_REFERENCES))
362 update_stats(&runtime_cacherefs_stats[0], count[0]);
363 else if (perf_evsel__match(counter, HW_CACHE, HW_CACHE_L1D))
364 update_stats(&runtime_l1_dcache_stats[0], count[0]);
365 else if (perf_evsel__match(counter, HW_CACHE, HW_CACHE_L1I))
366 update_stats(&runtime_l1_icache_stats[0], count[0]);
367 else if (perf_evsel__match(counter, HW_CACHE, HW_CACHE_LL))
368 update_stats(&runtime_ll_cache_stats[0], count[0]);
369 else if (perf_evsel__match(counter, HW_CACHE, HW_CACHE_DTLB))
370 update_stats(&runtime_dtlb_cache_stats[0], count[0]);
371 else if (perf_evsel__match(counter, HW_CACHE, HW_CACHE_ITLB))
372 update_stats(&runtime_itlb_cache_stats[0], count[0]);
373}
374
375/*
376 * Read out the results of a single counter:
377 * aggregate counts across CPUs in system-wide mode
378 */
379static int read_counter_aggr(struct perf_evsel *counter)
380{
381 struct perf_stat *ps = counter->priv;
382 u64 *count = counter->counts->aggr.values;
383 int i;
384
385 if (__perf_evsel__read(counter, evsel_list->cpus->nr,
386 evsel_list->threads->nr, scale) < 0)
387 return -1;
388
389 for (i = 0; i < 3; i++)
390 update_stats(&ps->res_stats[i], count[i]);
391
392 if (verbose) {
393 fprintf(output, "%s: %" PRIu64 " %" PRIu64 " %" PRIu64 "\n",
394 event_name(counter), count[0], count[1], count[2]);
395 }
396
397 /*
398 * Save the full runtime - to allow normalization during printout:
399 */
400 update_shadow_stats(counter, count);
401
402 return 0;
403}
404
405/*
406 * Read out the results of a single counter:
407 * do not aggregate counts across CPUs in system-wide mode
408 */
409static int read_counter(struct perf_evsel *counter)
410{
411 u64 *count;
412 int cpu;
413
414 for (cpu = 0; cpu < evsel_list->cpus->nr; cpu++) {
415 if (__perf_evsel__read_on_cpu(counter, cpu, 0, scale) < 0)
416 return -1;
417
418 count = counter->counts->cpu[cpu].values;
419
420 update_shadow_stats(counter, count);
421 }
422
423 return 0;
424}
425
426static int run_perf_stat(int argc __used, const char **argv)
427{
428 unsigned long long t0, t1;
429 struct perf_evsel *counter, *first;
430 int status = 0;
431 int child_ready_pipe[2], go_pipe[2];
432 const bool forks = (argc > 0);
433 char buf;
434
435 if (forks && (pipe(child_ready_pipe) < 0 || pipe(go_pipe) < 0)) {
436 perror("failed to create pipes");
437 exit(1);
438 }
439
440 if (forks) {
441 if ((child_pid = fork()) < 0)
442 perror("failed to fork");
443
444 if (!child_pid) {
445 close(child_ready_pipe[0]);
446 close(go_pipe[1]);
447 fcntl(go_pipe[0], F_SETFD, FD_CLOEXEC);
448
449 /*
450 * Do a dummy execvp to get the PLT entry resolved,
451 * so we avoid the resolver overhead on the real
452 * execvp call.
453 */
454 execvp("", (char **)argv);
455
456 /*
457 * Tell the parent we're ready to go
458 */
459 close(child_ready_pipe[1]);
460
461 /*
462 * Wait until the parent tells us to go.
463 */
464 if (read(go_pipe[0], &buf, 1) == -1)
465 perror("unable to read pipe");
466
467 execvp(argv[0], (char **)argv);
468
469 perror(argv[0]);
470 exit(-1);
471 }
472
473 if (perf_target__none(&target))
474 evsel_list->threads->map[0] = child_pid;
475
476 /*
477 * Wait for the child to be ready to exec.
478 */
479 close(child_ready_pipe[1]);
480 close(go_pipe[0]);
481 if (read(child_ready_pipe[0], &buf, 1) == -1)
482 perror("unable to read pipe");
483 close(child_ready_pipe[0]);
484 }
485
486 first = list_entry(evsel_list->entries.next, struct perf_evsel, node);
487
488 list_for_each_entry(counter, &evsel_list->entries, node) {
489 if (create_perf_stat_counter(counter, first) < 0) {
490 /*
491 * PPC returns ENXIO for HW counters until 2.6.37
492 * (behavior changed with commit b0a873e).
493 */
494 if (errno == EINVAL || errno == ENOSYS ||
495 errno == ENOENT || errno == EOPNOTSUPP ||
496 errno == ENXIO) {
497 if (verbose)
498 ui__warning("%s event is not supported by the kernel.\n",
499 event_name(counter));
500 counter->supported = false;
501 continue;
502 }
503
504 if (errno == EPERM || errno == EACCES) {
505 error("You may not have permission to collect %sstats.\n"
506 "\t Consider tweaking"
507 " /proc/sys/kernel/perf_event_paranoid or running as root.",
508 target.system_wide ? "system-wide " : "");
509 } else {
510 error("open_counter returned with %d (%s). "
511 "/bin/dmesg may provide additional information.\n",
512 errno, strerror(errno));
513 }
514 if (child_pid != -1)
515 kill(child_pid, SIGTERM);
516 die("Not all events could be opened.\n");
517 return -1;
518 }
519 counter->supported = true;
520 }
521
522 if (perf_evlist__set_filters(evsel_list)) {
523 error("failed to set filter with %d (%s)\n", errno,
524 strerror(errno));
525 return -1;
526 }
527
528 /*
529 * Enable counters and exec the command:
530 */
531 t0 = rdclock();
532
533 if (forks) {
534 close(go_pipe[1]);
535 wait(&status);
536 if (WIFSIGNALED(status))
537 psignal(WTERMSIG(status), argv[0]);
538 } else {
539 while(!done) sleep(1);
540 }
541
542 t1 = rdclock();
543
544 update_stats(&walltime_nsecs_stats, t1 - t0);
545
546 if (no_aggr) {
547 list_for_each_entry(counter, &evsel_list->entries, node) {
548 read_counter(counter);
549 perf_evsel__close_fd(counter, evsel_list->cpus->nr, 1);
550 }
551 } else {
552 list_for_each_entry(counter, &evsel_list->entries, node) {
553 read_counter_aggr(counter);
554 perf_evsel__close_fd(counter, evsel_list->cpus->nr,
555 evsel_list->threads->nr);
556 }
557 }
558
559 return WEXITSTATUS(status);
560}
561
562static void print_noise_pct(double total, double avg)
563{
564 double pct = 0.0;
565
566 if (avg)
567 pct = 100.0*total/avg;
568
569 if (csv_output)
570 fprintf(output, "%s%.2f%%", csv_sep, pct);
571 else if (pct)
572 fprintf(output, " ( +-%6.2f%% )", pct);
573}
574
575static void print_noise(struct perf_evsel *evsel, double avg)
576{
577 struct perf_stat *ps;
578
579 if (run_count == 1)
580 return;
581
582 ps = evsel->priv;
583 print_noise_pct(stddev_stats(&ps->res_stats[0]), avg);
584}
585
586static void nsec_printout(int cpu, struct perf_evsel *evsel, double avg)
587{
588 double msecs = avg / 1e6;
589 char cpustr[16] = { '\0', };
590 const char *fmt = csv_output ? "%s%.6f%s%s" : "%s%18.6f%s%-25s";
591
592 if (no_aggr)
593 sprintf(cpustr, "CPU%*d%s",
594 csv_output ? 0 : -4,
595 evsel_list->cpus->map[cpu], csv_sep);
596
597 fprintf(output, fmt, cpustr, msecs, csv_sep, event_name(evsel));
598
599 if (evsel->cgrp)
600 fprintf(output, "%s%s", csv_sep, evsel->cgrp->name);
601
602 if (csv_output)
603 return;
604
605 if (perf_evsel__match(evsel, SOFTWARE, SW_TASK_CLOCK))
606 fprintf(output, " # %8.3f CPUs utilized ",
607 avg / avg_stats(&walltime_nsecs_stats));
608 else
609 fprintf(output, " ");
610}
611
612/* used for get_ratio_color() */
613enum grc_type {
614 GRC_STALLED_CYCLES_FE,
615 GRC_STALLED_CYCLES_BE,
616 GRC_CACHE_MISSES,
617 GRC_MAX_NR
618};
619
620static const char *get_ratio_color(enum grc_type type, double ratio)
621{
622 static const double grc_table[GRC_MAX_NR][3] = {
623 [GRC_STALLED_CYCLES_FE] = { 50.0, 30.0, 10.0 },
624 [GRC_STALLED_CYCLES_BE] = { 75.0, 50.0, 20.0 },
625 [GRC_CACHE_MISSES] = { 20.0, 10.0, 5.0 },
626 };
627 const char *color = PERF_COLOR_NORMAL;
628
629 if (ratio > grc_table[type][0])
630 color = PERF_COLOR_RED;
631 else if (ratio > grc_table[type][1])
632 color = PERF_COLOR_MAGENTA;
633 else if (ratio > grc_table[type][2])
634 color = PERF_COLOR_YELLOW;
635
636 return color;
637}
638
639static void print_stalled_cycles_frontend(int cpu, struct perf_evsel *evsel __used, double avg)
640{
641 double total, ratio = 0.0;
642 const char *color;
643
644 total = avg_stats(&runtime_cycles_stats[cpu]);
645
646 if (total)
647 ratio = avg / total * 100.0;
648
649 color = get_ratio_color(GRC_STALLED_CYCLES_FE, ratio);
650
651 fprintf(output, " # ");
652 color_fprintf(output, color, "%6.2f%%", ratio);
653 fprintf(output, " frontend cycles idle ");
654}
655
656static void print_stalled_cycles_backend(int cpu, struct perf_evsel *evsel __used, double avg)
657{
658 double total, ratio = 0.0;
659 const char *color;
660
661 total = avg_stats(&runtime_cycles_stats[cpu]);
662
663 if (total)
664 ratio = avg / total * 100.0;
665
666 color = get_ratio_color(GRC_STALLED_CYCLES_BE, ratio);
667
668 fprintf(output, " # ");
669 color_fprintf(output, color, "%6.2f%%", ratio);
670 fprintf(output, " backend cycles idle ");
671}
672
673static void print_branch_misses(int cpu, struct perf_evsel *evsel __used, double avg)
674{
675 double total, ratio = 0.0;
676 const char *color;
677
678 total = avg_stats(&runtime_branches_stats[cpu]);
679
680 if (total)
681 ratio = avg / total * 100.0;
682
683 color = get_ratio_color(GRC_CACHE_MISSES, ratio);
684
685 fprintf(output, " # ");
686 color_fprintf(output, color, "%6.2f%%", ratio);
687 fprintf(output, " of all branches ");
688}
689
690static void print_l1_dcache_misses(int cpu, struct perf_evsel *evsel __used, double avg)
691{
692 double total, ratio = 0.0;
693 const char *color;
694
695 total = avg_stats(&runtime_l1_dcache_stats[cpu]);
696
697 if (total)
698 ratio = avg / total * 100.0;
699
700 color = get_ratio_color(GRC_CACHE_MISSES, ratio);
701
702 fprintf(output, " # ");
703 color_fprintf(output, color, "%6.2f%%", ratio);
704 fprintf(output, " of all L1-dcache hits ");
705}
706
707static void print_l1_icache_misses(int cpu, struct perf_evsel *evsel __used, double avg)
708{
709 double total, ratio = 0.0;
710 const char *color;
711
712 total = avg_stats(&runtime_l1_icache_stats[cpu]);
713
714 if (total)
715 ratio = avg / total * 100.0;
716
717 color = get_ratio_color(GRC_CACHE_MISSES, ratio);
718
719 fprintf(output, " # ");
720 color_fprintf(output, color, "%6.2f%%", ratio);
721 fprintf(output, " of all L1-icache hits ");
722}
723
724static void print_dtlb_cache_misses(int cpu, struct perf_evsel *evsel __used, double avg)
725{
726 double total, ratio = 0.0;
727 const char *color;
728
729 total = avg_stats(&runtime_dtlb_cache_stats[cpu]);
730
731 if (total)
732 ratio = avg / total * 100.0;
733
734 color = get_ratio_color(GRC_CACHE_MISSES, ratio);
735
736 fprintf(output, " # ");
737 color_fprintf(output, color, "%6.2f%%", ratio);
738 fprintf(output, " of all dTLB cache hits ");
739}
740
741static void print_itlb_cache_misses(int cpu, struct perf_evsel *evsel __used, double avg)
742{
743 double total, ratio = 0.0;
744 const char *color;
745
746 total = avg_stats(&runtime_itlb_cache_stats[cpu]);
747
748 if (total)
749 ratio = avg / total * 100.0;
750
751 color = get_ratio_color(GRC_CACHE_MISSES, ratio);
752
753 fprintf(output, " # ");
754 color_fprintf(output, color, "%6.2f%%", ratio);
755 fprintf(output, " of all iTLB cache hits ");
756}
757
758static void print_ll_cache_misses(int cpu, struct perf_evsel *evsel __used, double avg)
759{
760 double total, ratio = 0.0;
761 const char *color;
762
763 total = avg_stats(&runtime_ll_cache_stats[cpu]);
764
765 if (total)
766 ratio = avg / total * 100.0;
767
768 color = get_ratio_color(GRC_CACHE_MISSES, ratio);
769
770 fprintf(output, " # ");
771 color_fprintf(output, color, "%6.2f%%", ratio);
772 fprintf(output, " of all LL-cache hits ");
773}
774
775static void abs_printout(int cpu, struct perf_evsel *evsel, double avg)
776{
777 double total, ratio = 0.0;
778 char cpustr[16] = { '\0', };
779 const char *fmt;
780
781 if (csv_output)
782 fmt = "%s%.0f%s%s";
783 else if (big_num)
784 fmt = "%s%'18.0f%s%-25s";
785 else
786 fmt = "%s%18.0f%s%-25s";
787
788 if (no_aggr)
789 sprintf(cpustr, "CPU%*d%s",
790 csv_output ? 0 : -4,
791 evsel_list->cpus->map[cpu], csv_sep);
792 else
793 cpu = 0;
794
795 fprintf(output, fmt, cpustr, avg, csv_sep, event_name(evsel));
796
797 if (evsel->cgrp)
798 fprintf(output, "%s%s", csv_sep, evsel->cgrp->name);
799
800 if (csv_output)
801 return;
802
803 if (perf_evsel__match(evsel, HARDWARE, HW_INSTRUCTIONS)) {
804 total = avg_stats(&runtime_cycles_stats[cpu]);
805
806 if (total)
807 ratio = avg / total;
808
809 fprintf(output, " # %5.2f insns per cycle ", ratio);
810
811 total = avg_stats(&runtime_stalled_cycles_front_stats[cpu]);
812 total = max(total, avg_stats(&runtime_stalled_cycles_back_stats[cpu]));
813
814 if (total && avg) {
815 ratio = total / avg;
816 fprintf(output, "\n # %5.2f stalled cycles per insn", ratio);
817 }
818
819 } else if (perf_evsel__match(evsel, HARDWARE, HW_BRANCH_MISSES) &&
820 runtime_branches_stats[cpu].n != 0) {
821 print_branch_misses(cpu, evsel, avg);
822 } else if (
823 evsel->attr.type == PERF_TYPE_HW_CACHE &&
824 evsel->attr.config == ( PERF_COUNT_HW_CACHE_L1D |
825 ((PERF_COUNT_HW_CACHE_OP_READ) << 8) |
826 ((PERF_COUNT_HW_CACHE_RESULT_MISS) << 16)) &&
827 runtime_l1_dcache_stats[cpu].n != 0) {
828 print_l1_dcache_misses(cpu, evsel, avg);
829 } else if (
830 evsel->attr.type == PERF_TYPE_HW_CACHE &&
831 evsel->attr.config == ( PERF_COUNT_HW_CACHE_L1I |
832 ((PERF_COUNT_HW_CACHE_OP_READ) << 8) |
833 ((PERF_COUNT_HW_CACHE_RESULT_MISS) << 16)) &&
834 runtime_l1_icache_stats[cpu].n != 0) {
835 print_l1_icache_misses(cpu, evsel, avg);
836 } else if (
837 evsel->attr.type == PERF_TYPE_HW_CACHE &&
838 evsel->attr.config == ( PERF_COUNT_HW_CACHE_DTLB |
839 ((PERF_COUNT_HW_CACHE_OP_READ) << 8) |
840 ((PERF_COUNT_HW_CACHE_RESULT_MISS) << 16)) &&
841 runtime_dtlb_cache_stats[cpu].n != 0) {
842 print_dtlb_cache_misses(cpu, evsel, avg);
843 } else if (
844 evsel->attr.type == PERF_TYPE_HW_CACHE &&
845 evsel->attr.config == ( PERF_COUNT_HW_CACHE_ITLB |
846 ((PERF_COUNT_HW_CACHE_OP_READ) << 8) |
847 ((PERF_COUNT_HW_CACHE_RESULT_MISS) << 16)) &&
848 runtime_itlb_cache_stats[cpu].n != 0) {
849 print_itlb_cache_misses(cpu, evsel, avg);
850 } else if (
851 evsel->attr.type == PERF_TYPE_HW_CACHE &&
852 evsel->attr.config == ( PERF_COUNT_HW_CACHE_LL |
853 ((PERF_COUNT_HW_CACHE_OP_READ) << 8) |
854 ((PERF_COUNT_HW_CACHE_RESULT_MISS) << 16)) &&
855 runtime_ll_cache_stats[cpu].n != 0) {
856 print_ll_cache_misses(cpu, evsel, avg);
857 } else if (perf_evsel__match(evsel, HARDWARE, HW_CACHE_MISSES) &&
858 runtime_cacherefs_stats[cpu].n != 0) {
859 total = avg_stats(&runtime_cacherefs_stats[cpu]);
860
861 if (total)
862 ratio = avg * 100 / total;
863
864 fprintf(output, " # %8.3f %% of all cache refs ", ratio);
865
866 } else if (perf_evsel__match(evsel, HARDWARE, HW_STALLED_CYCLES_FRONTEND)) {
867 print_stalled_cycles_frontend(cpu, evsel, avg);
868 } else if (perf_evsel__match(evsel, HARDWARE, HW_STALLED_CYCLES_BACKEND)) {
869 print_stalled_cycles_backend(cpu, evsel, avg);
870 } else if (perf_evsel__match(evsel, HARDWARE, HW_CPU_CYCLES)) {
871 total = avg_stats(&runtime_nsecs_stats[cpu]);
872
873 if (total)
874 ratio = 1.0 * avg / total;
875
876 fprintf(output, " # %8.3f GHz ", ratio);
877 } else if (runtime_nsecs_stats[cpu].n != 0) {
878 char unit = 'M';
879
880 total = avg_stats(&runtime_nsecs_stats[cpu]);
881
882 if (total)
883 ratio = 1000.0 * avg / total;
884 if (ratio < 0.001) {
885 ratio *= 1000;
886 unit = 'K';
887 }
888
889 fprintf(output, " # %8.3f %c/sec ", ratio, unit);
890 } else {
891 fprintf(output, " ");
892 }
893}
894
895/*
896 * Print out the results of a single counter:
897 * aggregated counts in system-wide mode
898 */
899static void print_counter_aggr(struct perf_evsel *counter)
900{
901 struct perf_stat *ps = counter->priv;
902 double avg = avg_stats(&ps->res_stats[0]);
903 int scaled = counter->counts->scaled;
904
905 if (scaled == -1) {
906 fprintf(output, "%*s%s%*s",
907 csv_output ? 0 : 18,
908 counter->supported ? CNTR_NOT_COUNTED : CNTR_NOT_SUPPORTED,
909 csv_sep,
910 csv_output ? 0 : -24,
911 event_name(counter));
912
913 if (counter->cgrp)
914 fprintf(output, "%s%s", csv_sep, counter->cgrp->name);
915
916 fputc('\n', output);
917 return;
918 }
919
920 if (nsec_counter(counter))
921 nsec_printout(-1, counter, avg);
922 else
923 abs_printout(-1, counter, avg);
924
925 print_noise(counter, avg);
926
927 if (csv_output) {
928 fputc('\n', output);
929 return;
930 }
931
932 if (scaled) {
933 double avg_enabled, avg_running;
934
935 avg_enabled = avg_stats(&ps->res_stats[1]);
936 avg_running = avg_stats(&ps->res_stats[2]);
937
938 fprintf(output, " [%5.2f%%]", 100 * avg_running / avg_enabled);
939 }
940 fprintf(output, "\n");
941}
942
943/*
944 * Print out the results of a single counter:
945 * does not use aggregated count in system-wide
946 */
947static void print_counter(struct perf_evsel *counter)
948{
949 u64 ena, run, val;
950 int cpu;
951
952 for (cpu = 0; cpu < evsel_list->cpus->nr; cpu++) {
953 val = counter->counts->cpu[cpu].val;
954 ena = counter->counts->cpu[cpu].ena;
955 run = counter->counts->cpu[cpu].run;
956 if (run == 0 || ena == 0) {
957 fprintf(output, "CPU%*d%s%*s%s%*s",
958 csv_output ? 0 : -4,
959 evsel_list->cpus->map[cpu], csv_sep,
960 csv_output ? 0 : 18,
961 counter->supported ? CNTR_NOT_COUNTED : CNTR_NOT_SUPPORTED,
962 csv_sep,
963 csv_output ? 0 : -24,
964 event_name(counter));
965
966 if (counter->cgrp)
967 fprintf(output, "%s%s",
968 csv_sep, counter->cgrp->name);
969
970 fputc('\n', output);
971 continue;
972 }
973
974 if (nsec_counter(counter))
975 nsec_printout(cpu, counter, val);
976 else
977 abs_printout(cpu, counter, val);
978
979 if (!csv_output) {
980 print_noise(counter, 1.0);
981
982 if (run != ena)
983 fprintf(output, " (%.2f%%)",
984 100.0 * run / ena);
985 }
986 fputc('\n', output);
987 }
988}
989
990static void print_stat(int argc, const char **argv)
991{
992 struct perf_evsel *counter;
993 int i;
994
995 fflush(stdout);
996
997 if (!csv_output) {
998 fprintf(output, "\n");
999 fprintf(output, " Performance counter stats for ");
1000 if (!perf_target__has_task(&target)) {
1001 fprintf(output, "\'%s", argv[0]);
1002 for (i = 1; i < argc; i++)
1003 fprintf(output, " %s", argv[i]);
1004 } else if (target.pid)
1005 fprintf(output, "process id \'%s", target.pid);
1006 else
1007 fprintf(output, "thread id \'%s", target.tid);
1008
1009 fprintf(output, "\'");
1010 if (run_count > 1)
1011 fprintf(output, " (%d runs)", run_count);
1012 fprintf(output, ":\n\n");
1013 }
1014
1015 if (no_aggr) {
1016 list_for_each_entry(counter, &evsel_list->entries, node)
1017 print_counter(counter);
1018 } else {
1019 list_for_each_entry(counter, &evsel_list->entries, node)
1020 print_counter_aggr(counter);
1021 }
1022
1023 if (!csv_output) {
1024 if (!null_run)
1025 fprintf(output, "\n");
1026 fprintf(output, " %17.9f seconds time elapsed",
1027 avg_stats(&walltime_nsecs_stats)/1e9);
1028 if (run_count > 1) {
1029 fprintf(output, " ");
1030 print_noise_pct(stddev_stats(&walltime_nsecs_stats),
1031 avg_stats(&walltime_nsecs_stats));
1032 }
1033 fprintf(output, "\n\n");
1034 }
1035}
1036
1037static volatile int signr = -1;
1038
1039static void skip_signal(int signo)
1040{
1041 if(child_pid == -1)
1042 done = 1;
1043
1044 signr = signo;
1045}
1046
1047static void sig_atexit(void)
1048{
1049 if (child_pid != -1)
1050 kill(child_pid, SIGTERM);
1051
1052 if (signr == -1)
1053 return;
1054
1055 signal(signr, SIG_DFL);
1056 kill(getpid(), signr);
1057}
1058
1059static const char * const stat_usage[] = {
1060 "perf stat [<options>] [<command>]",
1061 NULL
1062};
1063
1064static int stat__set_big_num(const struct option *opt __used,
1065 const char *s __used, int unset)
1066{
1067 big_num_opt = unset ? 0 : 1;
1068 return 0;
1069}
1070
1071static bool append_file;
1072
1073static const struct option options[] = {
1074 OPT_CALLBACK('e', "event", &evsel_list, "event",
1075 "event selector. use 'perf list' to list available events",
1076 parse_events_option),
1077 OPT_CALLBACK(0, "filter", &evsel_list, "filter",
1078 "event filter", parse_filter),
1079 OPT_BOOLEAN('i', "no-inherit", &no_inherit,
1080 "child tasks do not inherit counters"),
1081 OPT_STRING('p', "pid", &target.pid, "pid",
1082 "stat events on existing process id"),
1083 OPT_STRING('t', "tid", &target.tid, "tid",
1084 "stat events on existing thread id"),
1085 OPT_BOOLEAN('a', "all-cpus", &target.system_wide,
1086 "system-wide collection from all CPUs"),
1087 OPT_BOOLEAN('g', "group", &group,
1088 "put the counters into a counter group"),
1089 OPT_BOOLEAN('c', "scale", &scale,
1090 "scale/normalize counters"),
1091 OPT_INCR('v', "verbose", &verbose,
1092 "be more verbose (show counter open errors, etc)"),
1093 OPT_INTEGER('r', "repeat", &run_count,
1094 "repeat command and print average + stddev (max: 100)"),
1095 OPT_BOOLEAN('n', "null", &null_run,
1096 "null run - dont start any counters"),
1097 OPT_INCR('d', "detailed", &detailed_run,
1098 "detailed run - start a lot of events"),
1099 OPT_BOOLEAN('S', "sync", &sync_run,
1100 "call sync() before starting a run"),
1101 OPT_CALLBACK_NOOPT('B', "big-num", NULL, NULL,
1102 "print large numbers with thousands\' separators",
1103 stat__set_big_num),
1104 OPT_STRING('C', "cpu", &target.cpu_list, "cpu",
1105 "list of cpus to monitor in system-wide"),
1106 OPT_BOOLEAN('A', "no-aggr", &no_aggr,
1107 "disable CPU count aggregation"),
1108 OPT_STRING('x', "field-separator", &csv_sep, "separator",
1109 "print counts with custom separator"),
1110 OPT_CALLBACK('G', "cgroup", &evsel_list, "name",
1111 "monitor event in cgroup name only",
1112 parse_cgroups),
1113 OPT_STRING('o', "output", &output_name, "file",
1114 "output file name"),
1115 OPT_BOOLEAN(0, "append", &append_file, "append to the output file"),
1116 OPT_INTEGER(0, "log-fd", &output_fd,
1117 "log output to fd, instead of stderr"),
1118 OPT_END()
1119};
1120
1121/*
1122 * Add default attributes, if there were no attributes specified or
1123 * if -d/--detailed, -d -d or -d -d -d is used:
1124 */
1125static int add_default_attributes(void)
1126{
1127 /* Set attrs if no event is selected and !null_run: */
1128 if (null_run)
1129 return 0;
1130
1131 if (!evsel_list->nr_entries) {
1132 if (perf_evlist__add_default_attrs(evsel_list, default_attrs) < 0)
1133 return -1;
1134 }
1135
1136 /* Detailed events get appended to the event list: */
1137
1138 if (detailed_run < 1)
1139 return 0;
1140
1141 /* Append detailed run extra attributes: */
1142 if (perf_evlist__add_default_attrs(evsel_list, detailed_attrs) < 0)
1143 return -1;
1144
1145 if (detailed_run < 2)
1146 return 0;
1147
1148 /* Append very detailed run extra attributes: */
1149 if (perf_evlist__add_default_attrs(evsel_list, very_detailed_attrs) < 0)
1150 return -1;
1151
1152 if (detailed_run < 3)
1153 return 0;
1154
1155 /* Append very, very detailed run extra attributes: */
1156 return perf_evlist__add_default_attrs(evsel_list, very_very_detailed_attrs);
1157}
1158
1159int cmd_stat(int argc, const char **argv, const char *prefix __used)
1160{
1161 struct perf_evsel *pos;
1162 int status = -ENOMEM;
1163 const char *mode;
1164
1165 setlocale(LC_ALL, "");
1166
1167 evsel_list = perf_evlist__new(NULL, NULL);
1168 if (evsel_list == NULL)
1169 return -ENOMEM;
1170
1171 argc = parse_options(argc, argv, options, stat_usage,
1172 PARSE_OPT_STOP_AT_NON_OPTION);
1173
1174 output = stderr;
1175 if (output_name && strcmp(output_name, "-"))
1176 output = NULL;
1177
1178 if (output_name && output_fd) {
1179 fprintf(stderr, "cannot use both --output and --log-fd\n");
1180 usage_with_options(stat_usage, options);
1181 }
1182
1183 if (output_fd < 0) {
1184 fprintf(stderr, "argument to --log-fd must be a > 0\n");
1185 usage_with_options(stat_usage, options);
1186 }
1187
1188 if (!output) {
1189 struct timespec tm;
1190 mode = append_file ? "a" : "w";
1191
1192 output = fopen(output_name, mode);
1193 if (!output) {
1194 perror("failed to create output file");
1195 exit(-1);
1196 }
1197 clock_gettime(CLOCK_REALTIME, &tm);
1198 fprintf(output, "# started on %s\n", ctime(&tm.tv_sec));
1199 } else if (output_fd > 0) {
1200 mode = append_file ? "a" : "w";
1201 output = fdopen(output_fd, mode);
1202 if (!output) {
1203 perror("Failed opening logfd");
1204 return -errno;
1205 }
1206 }
1207
1208 if (csv_sep) {
1209 csv_output = true;
1210 if (!strcmp(csv_sep, "\\t"))
1211 csv_sep = "\t";
1212 } else
1213 csv_sep = DEFAULT_SEPARATOR;
1214
1215 /*
1216 * let the spreadsheet do the pretty-printing
1217 */
1218 if (csv_output) {
1219 /* User explicitly passed -B? */
1220 if (big_num_opt == 1) {
1221 fprintf(stderr, "-B option not supported with -x\n");
1222 usage_with_options(stat_usage, options);
1223 } else /* Nope, so disable big number formatting */
1224 big_num = false;
1225 } else if (big_num_opt == 0) /* User passed --no-big-num */
1226 big_num = false;
1227
1228 if (!argc && !perf_target__has_task(&target))
1229 usage_with_options(stat_usage, options);
1230 if (run_count <= 0)
1231 usage_with_options(stat_usage, options);
1232
1233 /* no_aggr, cgroup are for system-wide only */
1234 if ((no_aggr || nr_cgroups) && !perf_target__has_cpu(&target)) {
1235 fprintf(stderr, "both cgroup and no-aggregation "
1236 "modes only available in system-wide mode\n");
1237
1238 usage_with_options(stat_usage, options);
1239 }
1240
1241 if (add_default_attributes())
1242 goto out;
1243
1244 perf_target__validate(&target);
1245
1246 if (perf_evlist__create_maps(evsel_list, &target) < 0) {
1247 if (perf_target__has_task(&target))
1248 pr_err("Problems finding threads of monitor\n");
1249 if (perf_target__has_cpu(&target))
1250 perror("failed to parse CPUs map");
1251
1252 usage_with_options(stat_usage, options);
1253 return -1;
1254 }
1255
1256 list_for_each_entry(pos, &evsel_list->entries, node) {
1257 if (perf_evsel__alloc_stat_priv(pos) < 0 ||
1258 perf_evsel__alloc_counts(pos, evsel_list->cpus->nr) < 0)
1259 goto out_free_fd;
1260 }
1261
1262 /*
1263 * We dont want to block the signals - that would cause
1264 * child tasks to inherit that and Ctrl-C would not work.
1265 * What we want is for Ctrl-C to work in the exec()-ed
1266 * task, but being ignored by perf stat itself:
1267 */
1268 atexit(sig_atexit);
1269 signal(SIGINT, skip_signal);
1270 signal(SIGALRM, skip_signal);
1271 signal(SIGABRT, skip_signal);
1272
1273 status = 0;
1274 for (run_idx = 0; run_idx < run_count; run_idx++) {
1275 if (run_count != 1 && verbose)
1276 fprintf(output, "[ perf stat: executing run #%d ... ]\n",
1277 run_idx + 1);
1278
1279 if (sync_run)
1280 sync();
1281
1282 status = run_perf_stat(argc, argv);
1283 }
1284
1285 if (status != -1)
1286 print_stat(argc, argv);
1287out_free_fd:
1288 list_for_each_entry(pos, &evsel_list->entries, node)
1289 perf_evsel__free_stat_priv(pos);
1290 perf_evlist__delete_maps(evsel_list);
1291out:
1292 perf_evlist__delete(evsel_list);
1293 return status;
1294}
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * builtin-stat.c
4 *
5 * Builtin stat command: Give a precise performance counters summary
6 * overview about any workload, CPU or specific PID.
7 *
8 * Sample output:
9
10 $ perf stat ./hackbench 10
11
12 Time: 0.118
13
14 Performance counter stats for './hackbench 10':
15
16 1708.761321 task-clock # 11.037 CPUs utilized
17 41,190 context-switches # 0.024 M/sec
18 6,735 CPU-migrations # 0.004 M/sec
19 17,318 page-faults # 0.010 M/sec
20 5,205,202,243 cycles # 3.046 GHz
21 3,856,436,920 stalled-cycles-frontend # 74.09% frontend cycles idle
22 1,600,790,871 stalled-cycles-backend # 30.75% backend cycles idle
23 2,603,501,247 instructions # 0.50 insns per cycle
24 # 1.48 stalled cycles per insn
25 484,357,498 branches # 283.455 M/sec
26 6,388,934 branch-misses # 1.32% of all branches
27
28 0.154822978 seconds time elapsed
29
30 *
31 * Copyright (C) 2008-2011, Red Hat Inc, Ingo Molnar <mingo@redhat.com>
32 *
33 * Improvements and fixes by:
34 *
35 * Arjan van de Ven <arjan@linux.intel.com>
36 * Yanmin Zhang <yanmin.zhang@intel.com>
37 * Wu Fengguang <fengguang.wu@intel.com>
38 * Mike Galbraith <efault@gmx.de>
39 * Paul Mackerras <paulus@samba.org>
40 * Jaswinder Singh Rajput <jaswinder@kernel.org>
41 */
42
43#include "builtin.h"
44#include "perf.h"
45#include "util/cgroup.h"
46#include <subcmd/parse-options.h>
47#include "util/parse-events.h"
48#include "util/pmu.h"
49#include "util/event.h"
50#include "util/evlist.h"
51#include "util/evlist-hybrid.h"
52#include "util/evsel.h"
53#include "util/debug.h"
54#include "util/color.h"
55#include "util/stat.h"
56#include "util/header.h"
57#include "util/cpumap.h"
58#include "util/thread_map.h"
59#include "util/counts.h"
60#include "util/topdown.h"
61#include "util/session.h"
62#include "util/tool.h"
63#include "util/string2.h"
64#include "util/metricgroup.h"
65#include "util/synthetic-events.h"
66#include "util/target.h"
67#include "util/time-utils.h"
68#include "util/top.h"
69#include "util/affinity.h"
70#include "util/pfm.h"
71#include "util/bpf_counter.h"
72#include "util/iostat.h"
73#include "util/pmu-hybrid.h"
74#include "asm/bug.h"
75
76#include <linux/time64.h>
77#include <linux/zalloc.h>
78#include <api/fs/fs.h>
79#include <errno.h>
80#include <signal.h>
81#include <stdlib.h>
82#include <sys/prctl.h>
83#include <inttypes.h>
84#include <locale.h>
85#include <math.h>
86#include <sys/types.h>
87#include <sys/stat.h>
88#include <sys/wait.h>
89#include <unistd.h>
90#include <sys/time.h>
91#include <sys/resource.h>
92#include <linux/err.h>
93
94#include <linux/ctype.h>
95#include <perf/evlist.h>
96#include <internal/threadmap.h>
97
98#define DEFAULT_SEPARATOR " "
99#define FREEZE_ON_SMI_PATH "devices/cpu/freeze_on_smi"
100
101static void print_counters(struct timespec *ts, int argc, const char **argv);
102
103/* Default events used for perf stat -T */
104static const char *transaction_attrs = {
105 "task-clock,"
106 "{"
107 "instructions,"
108 "cycles,"
109 "cpu/cycles-t/,"
110 "cpu/tx-start/,"
111 "cpu/el-start/,"
112 "cpu/cycles-ct/"
113 "}"
114};
115
116/* More limited version when the CPU does not have all events. */
117static const char * transaction_limited_attrs = {
118 "task-clock,"
119 "{"
120 "instructions,"
121 "cycles,"
122 "cpu/cycles-t/,"
123 "cpu/tx-start/"
124 "}"
125};
126
127static const char * topdown_attrs[] = {
128 "topdown-total-slots",
129 "topdown-slots-retired",
130 "topdown-recovery-bubbles",
131 "topdown-fetch-bubbles",
132 "topdown-slots-issued",
133 NULL,
134};
135
136static const char *topdown_metric_attrs[] = {
137 "slots",
138 "topdown-retiring",
139 "topdown-bad-spec",
140 "topdown-fe-bound",
141 "topdown-be-bound",
142 NULL,
143};
144
145static const char *topdown_metric_L2_attrs[] = {
146 "slots",
147 "topdown-retiring",
148 "topdown-bad-spec",
149 "topdown-fe-bound",
150 "topdown-be-bound",
151 "topdown-heavy-ops",
152 "topdown-br-mispredict",
153 "topdown-fetch-lat",
154 "topdown-mem-bound",
155 NULL,
156};
157
158#define TOPDOWN_MAX_LEVEL 2
159
160static const char *smi_cost_attrs = {
161 "{"
162 "msr/aperf/,"
163 "msr/smi/,"
164 "cycles"
165 "}"
166};
167
168static struct evlist *evsel_list;
169static bool all_counters_use_bpf = true;
170
171static struct target target = {
172 .uid = UINT_MAX,
173};
174
175#define METRIC_ONLY_LEN 20
176
177static volatile sig_atomic_t child_pid = -1;
178static int detailed_run = 0;
179static bool transaction_run;
180static bool topdown_run = false;
181static bool smi_cost = false;
182static bool smi_reset = false;
183static int big_num_opt = -1;
184static const char *pre_cmd = NULL;
185static const char *post_cmd = NULL;
186static bool sync_run = false;
187static bool forever = false;
188static bool force_metric_only = false;
189static struct timespec ref_time;
190static bool append_file;
191static bool interval_count;
192static const char *output_name;
193static int output_fd;
194static char *metrics;
195
196struct perf_stat {
197 bool record;
198 struct perf_data data;
199 struct perf_session *session;
200 u64 bytes_written;
201 struct perf_tool tool;
202 bool maps_allocated;
203 struct perf_cpu_map *cpus;
204 struct perf_thread_map *threads;
205 enum aggr_mode aggr_mode;
206};
207
208static struct perf_stat perf_stat;
209#define STAT_RECORD perf_stat.record
210
211static volatile sig_atomic_t done = 0;
212
213static struct perf_stat_config stat_config = {
214 .aggr_mode = AGGR_GLOBAL,
215 .scale = true,
216 .unit_width = 4, /* strlen("unit") */
217 .run_count = 1,
218 .metric_only_len = METRIC_ONLY_LEN,
219 .walltime_nsecs_stats = &walltime_nsecs_stats,
220 .ru_stats = &ru_stats,
221 .big_num = true,
222 .ctl_fd = -1,
223 .ctl_fd_ack = -1,
224 .iostat_run = false,
225};
226
227static bool cpus_map_matched(struct evsel *a, struct evsel *b)
228{
229 if (!a->core.cpus && !b->core.cpus)
230 return true;
231
232 if (!a->core.cpus || !b->core.cpus)
233 return false;
234
235 if (perf_cpu_map__nr(a->core.cpus) != perf_cpu_map__nr(b->core.cpus))
236 return false;
237
238 for (int i = 0; i < perf_cpu_map__nr(a->core.cpus); i++) {
239 if (perf_cpu_map__cpu(a->core.cpus, i).cpu !=
240 perf_cpu_map__cpu(b->core.cpus, i).cpu)
241 return false;
242 }
243
244 return true;
245}
246
247static void evlist__check_cpu_maps(struct evlist *evlist)
248{
249 struct evsel *evsel, *pos, *leader;
250 char buf[1024];
251
252 if (evlist__has_hybrid(evlist))
253 evlist__warn_hybrid_group(evlist);
254
255 evlist__for_each_entry(evlist, evsel) {
256 leader = evsel__leader(evsel);
257
258 /* Check that leader matches cpus with each member. */
259 if (leader == evsel)
260 continue;
261 if (cpus_map_matched(leader, evsel))
262 continue;
263
264 /* If there's mismatch disable the group and warn user. */
265 WARN_ONCE(1, "WARNING: grouped events cpus do not match, disabling group:\n");
266 evsel__group_desc(leader, buf, sizeof(buf));
267 pr_warning(" %s\n", buf);
268
269 if (verbose > 0) {
270 cpu_map__snprint(leader->core.cpus, buf, sizeof(buf));
271 pr_warning(" %s: %s\n", leader->name, buf);
272 cpu_map__snprint(evsel->core.cpus, buf, sizeof(buf));
273 pr_warning(" %s: %s\n", evsel->name, buf);
274 }
275
276 for_each_group_evsel(pos, leader)
277 evsel__remove_from_group(pos, leader);
278 }
279}
280
281static inline void diff_timespec(struct timespec *r, struct timespec *a,
282 struct timespec *b)
283{
284 r->tv_sec = a->tv_sec - b->tv_sec;
285 if (a->tv_nsec < b->tv_nsec) {
286 r->tv_nsec = a->tv_nsec + NSEC_PER_SEC - b->tv_nsec;
287 r->tv_sec--;
288 } else {
289 r->tv_nsec = a->tv_nsec - b->tv_nsec ;
290 }
291}
292
293static void perf_stat__reset_stats(void)
294{
295 evlist__reset_stats(evsel_list);
296 perf_stat__reset_shadow_stats();
297}
298
299static int process_synthesized_event(struct perf_tool *tool __maybe_unused,
300 union perf_event *event,
301 struct perf_sample *sample __maybe_unused,
302 struct machine *machine __maybe_unused)
303{
304 if (perf_data__write(&perf_stat.data, event, event->header.size) < 0) {
305 pr_err("failed to write perf data, error: %m\n");
306 return -1;
307 }
308
309 perf_stat.bytes_written += event->header.size;
310 return 0;
311}
312
313static int write_stat_round_event(u64 tm, u64 type)
314{
315 return perf_event__synthesize_stat_round(NULL, tm, type,
316 process_synthesized_event,
317 NULL);
318}
319
320#define WRITE_STAT_ROUND_EVENT(time, interval) \
321 write_stat_round_event(time, PERF_STAT_ROUND_TYPE__ ## interval)
322
323#define SID(e, x, y) xyarray__entry(e->core.sample_id, x, y)
324
325static int evsel__write_stat_event(struct evsel *counter, int cpu_map_idx, u32 thread,
326 struct perf_counts_values *count)
327{
328 struct perf_sample_id *sid = SID(counter, cpu_map_idx, thread);
329 struct perf_cpu cpu = perf_cpu_map__cpu(evsel__cpus(counter), cpu_map_idx);
330
331 return perf_event__synthesize_stat(NULL, cpu, thread, sid->id, count,
332 process_synthesized_event, NULL);
333}
334
335static int read_single_counter(struct evsel *counter, int cpu_map_idx,
336 int thread, struct timespec *rs)
337{
338 switch(counter->tool_event) {
339 case PERF_TOOL_DURATION_TIME: {
340 u64 val = rs->tv_nsec + rs->tv_sec*1000000000ULL;
341 struct perf_counts_values *count =
342 perf_counts(counter->counts, cpu_map_idx, thread);
343 count->ena = count->run = val;
344 count->val = val;
345 return 0;
346 }
347 case PERF_TOOL_USER_TIME:
348 case PERF_TOOL_SYSTEM_TIME: {
349 u64 val;
350 struct perf_counts_values *count =
351 perf_counts(counter->counts, cpu_map_idx, thread);
352 if (counter->tool_event == PERF_TOOL_USER_TIME)
353 val = ru_stats.ru_utime_usec_stat.mean;
354 else
355 val = ru_stats.ru_stime_usec_stat.mean;
356 count->ena = count->run = val;
357 count->val = val;
358 return 0;
359 }
360 default:
361 case PERF_TOOL_NONE:
362 return evsel__read_counter(counter, cpu_map_idx, thread);
363 case PERF_TOOL_MAX:
364 /* This should never be reached */
365 return 0;
366 }
367}
368
369/*
370 * Read out the results of a single counter:
371 * do not aggregate counts across CPUs in system-wide mode
372 */
373static int read_counter_cpu(struct evsel *counter, struct timespec *rs, int cpu_map_idx)
374{
375 int nthreads = perf_thread_map__nr(evsel_list->core.threads);
376 int thread;
377
378 if (!counter->supported)
379 return -ENOENT;
380
381 for (thread = 0; thread < nthreads; thread++) {
382 struct perf_counts_values *count;
383
384 count = perf_counts(counter->counts, cpu_map_idx, thread);
385
386 /*
387 * The leader's group read loads data into its group members
388 * (via evsel__read_counter()) and sets their count->loaded.
389 */
390 if (!perf_counts__is_loaded(counter->counts, cpu_map_idx, thread) &&
391 read_single_counter(counter, cpu_map_idx, thread, rs)) {
392 counter->counts->scaled = -1;
393 perf_counts(counter->counts, cpu_map_idx, thread)->ena = 0;
394 perf_counts(counter->counts, cpu_map_idx, thread)->run = 0;
395 return -1;
396 }
397
398 perf_counts__set_loaded(counter->counts, cpu_map_idx, thread, false);
399
400 if (STAT_RECORD) {
401 if (evsel__write_stat_event(counter, cpu_map_idx, thread, count)) {
402 pr_err("failed to write stat event\n");
403 return -1;
404 }
405 }
406
407 if (verbose > 1) {
408 fprintf(stat_config.output,
409 "%s: %d: %" PRIu64 " %" PRIu64 " %" PRIu64 "\n",
410 evsel__name(counter),
411 perf_cpu_map__cpu(evsel__cpus(counter),
412 cpu_map_idx).cpu,
413 count->val, count->ena, count->run);
414 }
415 }
416
417 return 0;
418}
419
420static int read_affinity_counters(struct timespec *rs)
421{
422 struct evlist_cpu_iterator evlist_cpu_itr;
423 struct affinity saved_affinity, *affinity;
424
425 if (all_counters_use_bpf)
426 return 0;
427
428 if (!target__has_cpu(&target) || target__has_per_thread(&target))
429 affinity = NULL;
430 else if (affinity__setup(&saved_affinity) < 0)
431 return -1;
432 else
433 affinity = &saved_affinity;
434
435 evlist__for_each_cpu(evlist_cpu_itr, evsel_list, affinity) {
436 struct evsel *counter = evlist_cpu_itr.evsel;
437
438 if (evsel__is_bpf(counter))
439 continue;
440
441 if (!counter->err) {
442 counter->err = read_counter_cpu(counter, rs,
443 evlist_cpu_itr.cpu_map_idx);
444 }
445 }
446 if (affinity)
447 affinity__cleanup(&saved_affinity);
448
449 return 0;
450}
451
452static int read_bpf_map_counters(void)
453{
454 struct evsel *counter;
455 int err;
456
457 evlist__for_each_entry(evsel_list, counter) {
458 if (!evsel__is_bpf(counter))
459 continue;
460
461 err = bpf_counter__read(counter);
462 if (err)
463 return err;
464 }
465 return 0;
466}
467
468static int read_counters(struct timespec *rs)
469{
470 if (!stat_config.stop_read_counter) {
471 if (read_bpf_map_counters() ||
472 read_affinity_counters(rs))
473 return -1;
474 }
475 return 0;
476}
477
478static void process_counters(void)
479{
480 struct evsel *counter;
481
482 evlist__for_each_entry(evsel_list, counter) {
483 if (counter->err)
484 pr_debug("failed to read counter %s\n", counter->name);
485 if (counter->err == 0 && perf_stat_process_counter(&stat_config, counter))
486 pr_warning("failed to process counter %s\n", counter->name);
487 counter->err = 0;
488 }
489
490 perf_stat_merge_counters(&stat_config, evsel_list);
491 perf_stat_process_percore(&stat_config, evsel_list);
492 perf_stat_process_shadow_stats(&stat_config, evsel_list);
493}
494
495static void process_interval(void)
496{
497 struct timespec ts, rs;
498
499 clock_gettime(CLOCK_MONOTONIC, &ts);
500 diff_timespec(&rs, &ts, &ref_time);
501
502 perf_stat__reset_shadow_per_stat(&rt_stat);
503 evlist__reset_aggr_stats(evsel_list);
504
505 if (read_counters(&rs) == 0)
506 process_counters();
507
508 if (STAT_RECORD) {
509 if (WRITE_STAT_ROUND_EVENT(rs.tv_sec * NSEC_PER_SEC + rs.tv_nsec, INTERVAL))
510 pr_err("failed to write stat round event\n");
511 }
512
513 init_stats(&walltime_nsecs_stats);
514 update_stats(&walltime_nsecs_stats, stat_config.interval * 1000000ULL);
515 print_counters(&rs, 0, NULL);
516}
517
518static bool handle_interval(unsigned int interval, int *times)
519{
520 if (interval) {
521 process_interval();
522 if (interval_count && !(--(*times)))
523 return true;
524 }
525 return false;
526}
527
528static int enable_counters(void)
529{
530 struct evsel *evsel;
531 int err;
532
533 evlist__for_each_entry(evsel_list, evsel) {
534 if (!evsel__is_bpf(evsel))
535 continue;
536
537 err = bpf_counter__enable(evsel);
538 if (err)
539 return err;
540 }
541
542 /*
543 * We need to enable counters only if:
544 * - we don't have tracee (attaching to task or cpu)
545 * - we have initial delay configured
546 */
547 if (!target__none(&target)) {
548 if (!all_counters_use_bpf)
549 evlist__enable(evsel_list);
550 }
551 return 0;
552}
553
554static void disable_counters(void)
555{
556 struct evsel *counter;
557
558 /*
559 * If we don't have tracee (attaching to task or cpu), counters may
560 * still be running. To get accurate group ratios, we must stop groups
561 * from counting before reading their constituent counters.
562 */
563 if (!target__none(&target)) {
564 evlist__for_each_entry(evsel_list, counter)
565 bpf_counter__disable(counter);
566 if (!all_counters_use_bpf)
567 evlist__disable(evsel_list);
568 }
569}
570
571static volatile sig_atomic_t workload_exec_errno;
572
573/*
574 * evlist__prepare_workload will send a SIGUSR1
575 * if the fork fails, since we asked by setting its
576 * want_signal to true.
577 */
578static void workload_exec_failed_signal(int signo __maybe_unused, siginfo_t *info,
579 void *ucontext __maybe_unused)
580{
581 workload_exec_errno = info->si_value.sival_int;
582}
583
584static bool evsel__should_store_id(struct evsel *counter)
585{
586 return STAT_RECORD || counter->core.attr.read_format & PERF_FORMAT_ID;
587}
588
589static bool is_target_alive(struct target *_target,
590 struct perf_thread_map *threads)
591{
592 struct stat st;
593 int i;
594
595 if (!target__has_task(_target))
596 return true;
597
598 for (i = 0; i < threads->nr; i++) {
599 char path[PATH_MAX];
600
601 scnprintf(path, PATH_MAX, "%s/%d", procfs__mountpoint(),
602 threads->map[i].pid);
603
604 if (!stat(path, &st))
605 return true;
606 }
607
608 return false;
609}
610
611static void process_evlist(struct evlist *evlist, unsigned int interval)
612{
613 enum evlist_ctl_cmd cmd = EVLIST_CTL_CMD_UNSUPPORTED;
614
615 if (evlist__ctlfd_process(evlist, &cmd) > 0) {
616 switch (cmd) {
617 case EVLIST_CTL_CMD_ENABLE:
618 __fallthrough;
619 case EVLIST_CTL_CMD_DISABLE:
620 if (interval)
621 process_interval();
622 break;
623 case EVLIST_CTL_CMD_SNAPSHOT:
624 case EVLIST_CTL_CMD_ACK:
625 case EVLIST_CTL_CMD_UNSUPPORTED:
626 case EVLIST_CTL_CMD_EVLIST:
627 case EVLIST_CTL_CMD_STOP:
628 case EVLIST_CTL_CMD_PING:
629 default:
630 break;
631 }
632 }
633}
634
635static void compute_tts(struct timespec *time_start, struct timespec *time_stop,
636 int *time_to_sleep)
637{
638 int tts = *time_to_sleep;
639 struct timespec time_diff;
640
641 diff_timespec(&time_diff, time_stop, time_start);
642
643 tts -= time_diff.tv_sec * MSEC_PER_SEC +
644 time_diff.tv_nsec / NSEC_PER_MSEC;
645
646 if (tts < 0)
647 tts = 0;
648
649 *time_to_sleep = tts;
650}
651
652static int dispatch_events(bool forks, int timeout, int interval, int *times)
653{
654 int child_exited = 0, status = 0;
655 int time_to_sleep, sleep_time;
656 struct timespec time_start, time_stop;
657
658 if (interval)
659 sleep_time = interval;
660 else if (timeout)
661 sleep_time = timeout;
662 else
663 sleep_time = 1000;
664
665 time_to_sleep = sleep_time;
666
667 while (!done) {
668 if (forks)
669 child_exited = waitpid(child_pid, &status, WNOHANG);
670 else
671 child_exited = !is_target_alive(&target, evsel_list->core.threads) ? 1 : 0;
672
673 if (child_exited)
674 break;
675
676 clock_gettime(CLOCK_MONOTONIC, &time_start);
677 if (!(evlist__poll(evsel_list, time_to_sleep) > 0)) { /* poll timeout or EINTR */
678 if (timeout || handle_interval(interval, times))
679 break;
680 time_to_sleep = sleep_time;
681 } else { /* fd revent */
682 process_evlist(evsel_list, interval);
683 clock_gettime(CLOCK_MONOTONIC, &time_stop);
684 compute_tts(&time_start, &time_stop, &time_to_sleep);
685 }
686 }
687
688 return status;
689}
690
691enum counter_recovery {
692 COUNTER_SKIP,
693 COUNTER_RETRY,
694 COUNTER_FATAL,
695};
696
697static enum counter_recovery stat_handle_error(struct evsel *counter)
698{
699 char msg[BUFSIZ];
700 /*
701 * PPC returns ENXIO for HW counters until 2.6.37
702 * (behavior changed with commit b0a873e).
703 */
704 if (errno == EINVAL || errno == ENOSYS ||
705 errno == ENOENT || errno == EOPNOTSUPP ||
706 errno == ENXIO) {
707 if (verbose > 0)
708 ui__warning("%s event is not supported by the kernel.\n",
709 evsel__name(counter));
710 counter->supported = false;
711 /*
712 * errored is a sticky flag that means one of the counter's
713 * cpu event had a problem and needs to be reexamined.
714 */
715 counter->errored = true;
716
717 if ((evsel__leader(counter) != counter) ||
718 !(counter->core.leader->nr_members > 1))
719 return COUNTER_SKIP;
720 } else if (evsel__fallback(counter, errno, msg, sizeof(msg))) {
721 if (verbose > 0)
722 ui__warning("%s\n", msg);
723 return COUNTER_RETRY;
724 } else if (target__has_per_thread(&target) &&
725 evsel_list->core.threads &&
726 evsel_list->core.threads->err_thread != -1) {
727 /*
728 * For global --per-thread case, skip current
729 * error thread.
730 */
731 if (!thread_map__remove(evsel_list->core.threads,
732 evsel_list->core.threads->err_thread)) {
733 evsel_list->core.threads->err_thread = -1;
734 return COUNTER_RETRY;
735 }
736 }
737
738 evsel__open_strerror(counter, &target, errno, msg, sizeof(msg));
739 ui__error("%s\n", msg);
740
741 if (child_pid != -1)
742 kill(child_pid, SIGTERM);
743 return COUNTER_FATAL;
744}
745
746static int __run_perf_stat(int argc, const char **argv, int run_idx)
747{
748 int interval = stat_config.interval;
749 int times = stat_config.times;
750 int timeout = stat_config.timeout;
751 char msg[BUFSIZ];
752 unsigned long long t0, t1;
753 struct evsel *counter;
754 size_t l;
755 int status = 0;
756 const bool forks = (argc > 0);
757 bool is_pipe = STAT_RECORD ? perf_stat.data.is_pipe : false;
758 struct evlist_cpu_iterator evlist_cpu_itr;
759 struct affinity saved_affinity, *affinity = NULL;
760 int err;
761 bool second_pass = false;
762
763 if (forks) {
764 if (evlist__prepare_workload(evsel_list, &target, argv, is_pipe, workload_exec_failed_signal) < 0) {
765 perror("failed to prepare workload");
766 return -1;
767 }
768 child_pid = evsel_list->workload.pid;
769 }
770
771 if (!cpu_map__is_dummy(evsel_list->core.user_requested_cpus)) {
772 if (affinity__setup(&saved_affinity) < 0)
773 return -1;
774 affinity = &saved_affinity;
775 }
776
777 evlist__for_each_entry(evsel_list, counter) {
778 counter->reset_group = false;
779 if (bpf_counter__load(counter, &target))
780 return -1;
781 if (!evsel__is_bpf(counter))
782 all_counters_use_bpf = false;
783 }
784
785 evlist__for_each_cpu(evlist_cpu_itr, evsel_list, affinity) {
786 counter = evlist_cpu_itr.evsel;
787
788 /*
789 * bperf calls evsel__open_per_cpu() in bperf__load(), so
790 * no need to call it again here.
791 */
792 if (target.use_bpf)
793 break;
794
795 if (counter->reset_group || counter->errored)
796 continue;
797 if (evsel__is_bpf(counter))
798 continue;
799try_again:
800 if (create_perf_stat_counter(counter, &stat_config, &target,
801 evlist_cpu_itr.cpu_map_idx) < 0) {
802
803 /*
804 * Weak group failed. We cannot just undo this here
805 * because earlier CPUs might be in group mode, and the kernel
806 * doesn't support mixing group and non group reads. Defer
807 * it to later.
808 * Don't close here because we're in the wrong affinity.
809 */
810 if ((errno == EINVAL || errno == EBADF) &&
811 evsel__leader(counter) != counter &&
812 counter->weak_group) {
813 evlist__reset_weak_group(evsel_list, counter, false);
814 assert(counter->reset_group);
815 second_pass = true;
816 continue;
817 }
818
819 switch (stat_handle_error(counter)) {
820 case COUNTER_FATAL:
821 return -1;
822 case COUNTER_RETRY:
823 goto try_again;
824 case COUNTER_SKIP:
825 continue;
826 default:
827 break;
828 }
829
830 }
831 counter->supported = true;
832 }
833
834 if (second_pass) {
835 /*
836 * Now redo all the weak group after closing them,
837 * and also close errored counters.
838 */
839
840 /* First close errored or weak retry */
841 evlist__for_each_cpu(evlist_cpu_itr, evsel_list, affinity) {
842 counter = evlist_cpu_itr.evsel;
843
844 if (!counter->reset_group && !counter->errored)
845 continue;
846
847 perf_evsel__close_cpu(&counter->core, evlist_cpu_itr.cpu_map_idx);
848 }
849 /* Now reopen weak */
850 evlist__for_each_cpu(evlist_cpu_itr, evsel_list, affinity) {
851 counter = evlist_cpu_itr.evsel;
852
853 if (!counter->reset_group)
854 continue;
855try_again_reset:
856 pr_debug2("reopening weak %s\n", evsel__name(counter));
857 if (create_perf_stat_counter(counter, &stat_config, &target,
858 evlist_cpu_itr.cpu_map_idx) < 0) {
859
860 switch (stat_handle_error(counter)) {
861 case COUNTER_FATAL:
862 return -1;
863 case COUNTER_RETRY:
864 goto try_again_reset;
865 case COUNTER_SKIP:
866 continue;
867 default:
868 break;
869 }
870 }
871 counter->supported = true;
872 }
873 }
874 affinity__cleanup(affinity);
875
876 evlist__for_each_entry(evsel_list, counter) {
877 if (!counter->supported) {
878 perf_evsel__free_fd(&counter->core);
879 continue;
880 }
881
882 l = strlen(counter->unit);
883 if (l > stat_config.unit_width)
884 stat_config.unit_width = l;
885
886 if (evsel__should_store_id(counter) &&
887 evsel__store_ids(counter, evsel_list))
888 return -1;
889 }
890
891 if (evlist__apply_filters(evsel_list, &counter)) {
892 pr_err("failed to set filter \"%s\" on event %s with %d (%s)\n",
893 counter->filter, evsel__name(counter), errno,
894 str_error_r(errno, msg, sizeof(msg)));
895 return -1;
896 }
897
898 if (STAT_RECORD) {
899 int fd = perf_data__fd(&perf_stat.data);
900
901 if (is_pipe) {
902 err = perf_header__write_pipe(perf_data__fd(&perf_stat.data));
903 } else {
904 err = perf_session__write_header(perf_stat.session, evsel_list,
905 fd, false);
906 }
907
908 if (err < 0)
909 return err;
910
911 err = perf_event__synthesize_stat_events(&stat_config, NULL, evsel_list,
912 process_synthesized_event, is_pipe);
913 if (err < 0)
914 return err;
915 }
916
917 if (stat_config.initial_delay) {
918 pr_info(EVLIST_DISABLED_MSG);
919 } else {
920 err = enable_counters();
921 if (err)
922 return -1;
923 }
924
925 /* Exec the command, if any */
926 if (forks)
927 evlist__start_workload(evsel_list);
928
929 if (stat_config.initial_delay > 0) {
930 usleep(stat_config.initial_delay * USEC_PER_MSEC);
931 err = enable_counters();
932 if (err)
933 return -1;
934
935 pr_info(EVLIST_ENABLED_MSG);
936 }
937
938 t0 = rdclock();
939 clock_gettime(CLOCK_MONOTONIC, &ref_time);
940
941 if (forks) {
942 if (interval || timeout || evlist__ctlfd_initialized(evsel_list))
943 status = dispatch_events(forks, timeout, interval, ×);
944 if (child_pid != -1) {
945 if (timeout)
946 kill(child_pid, SIGTERM);
947 wait4(child_pid, &status, 0, &stat_config.ru_data);
948 }
949
950 if (workload_exec_errno) {
951 const char *emsg = str_error_r(workload_exec_errno, msg, sizeof(msg));
952 pr_err("Workload failed: %s\n", emsg);
953 return -1;
954 }
955
956 if (WIFSIGNALED(status))
957 psignal(WTERMSIG(status), argv[0]);
958 } else {
959 status = dispatch_events(forks, timeout, interval, ×);
960 }
961
962 disable_counters();
963
964 t1 = rdclock();
965
966 if (stat_config.walltime_run_table)
967 stat_config.walltime_run[run_idx] = t1 - t0;
968
969 if (interval && stat_config.summary) {
970 stat_config.interval = 0;
971 stat_config.stop_read_counter = true;
972 init_stats(&walltime_nsecs_stats);
973 update_stats(&walltime_nsecs_stats, t1 - t0);
974
975 evlist__copy_prev_raw_counts(evsel_list);
976 evlist__reset_prev_raw_counts(evsel_list);
977 evlist__reset_aggr_stats(evsel_list);
978 perf_stat__reset_shadow_per_stat(&rt_stat);
979 } else {
980 update_stats(&walltime_nsecs_stats, t1 - t0);
981 update_rusage_stats(&ru_stats, &stat_config.ru_data);
982 }
983
984 /*
985 * Closing a group leader splits the group, and as we only disable
986 * group leaders, results in remaining events becoming enabled. To
987 * avoid arbitrary skew, we must read all counters before closing any
988 * group leaders.
989 */
990 if (read_counters(&(struct timespec) { .tv_nsec = t1-t0 }) == 0)
991 process_counters();
992
993 /*
994 * We need to keep evsel_list alive, because it's processed
995 * later the evsel_list will be closed after.
996 */
997 if (!STAT_RECORD)
998 evlist__close(evsel_list);
999
1000 return WEXITSTATUS(status);
1001}
1002
1003static int run_perf_stat(int argc, const char **argv, int run_idx)
1004{
1005 int ret;
1006
1007 if (pre_cmd) {
1008 ret = system(pre_cmd);
1009 if (ret)
1010 return ret;
1011 }
1012
1013 if (sync_run)
1014 sync();
1015
1016 ret = __run_perf_stat(argc, argv, run_idx);
1017 if (ret)
1018 return ret;
1019
1020 if (post_cmd) {
1021 ret = system(post_cmd);
1022 if (ret)
1023 return ret;
1024 }
1025
1026 return ret;
1027}
1028
1029static void print_counters(struct timespec *ts, int argc, const char **argv)
1030{
1031 /* Do not print anything if we record to the pipe. */
1032 if (STAT_RECORD && perf_stat.data.is_pipe)
1033 return;
1034 if (quiet)
1035 return;
1036
1037 evlist__print_counters(evsel_list, &stat_config, &target, ts, argc, argv);
1038}
1039
1040static volatile sig_atomic_t signr = -1;
1041
1042static void skip_signal(int signo)
1043{
1044 if ((child_pid == -1) || stat_config.interval)
1045 done = 1;
1046
1047 signr = signo;
1048 /*
1049 * render child_pid harmless
1050 * won't send SIGTERM to a random
1051 * process in case of race condition
1052 * and fast PID recycling
1053 */
1054 child_pid = -1;
1055}
1056
1057static void sig_atexit(void)
1058{
1059 sigset_t set, oset;
1060
1061 /*
1062 * avoid race condition with SIGCHLD handler
1063 * in skip_signal() which is modifying child_pid
1064 * goal is to avoid send SIGTERM to a random
1065 * process
1066 */
1067 sigemptyset(&set);
1068 sigaddset(&set, SIGCHLD);
1069 sigprocmask(SIG_BLOCK, &set, &oset);
1070
1071 if (child_pid != -1)
1072 kill(child_pid, SIGTERM);
1073
1074 sigprocmask(SIG_SETMASK, &oset, NULL);
1075
1076 if (signr == -1)
1077 return;
1078
1079 signal(signr, SIG_DFL);
1080 kill(getpid(), signr);
1081}
1082
1083void perf_stat__set_big_num(int set)
1084{
1085 stat_config.big_num = (set != 0);
1086}
1087
1088void perf_stat__set_no_csv_summary(int set)
1089{
1090 stat_config.no_csv_summary = (set != 0);
1091}
1092
1093static int stat__set_big_num(const struct option *opt __maybe_unused,
1094 const char *s __maybe_unused, int unset)
1095{
1096 big_num_opt = unset ? 0 : 1;
1097 perf_stat__set_big_num(!unset);
1098 return 0;
1099}
1100
1101static int enable_metric_only(const struct option *opt __maybe_unused,
1102 const char *s __maybe_unused, int unset)
1103{
1104 force_metric_only = true;
1105 stat_config.metric_only = !unset;
1106 return 0;
1107}
1108
1109static int append_metric_groups(const struct option *opt __maybe_unused,
1110 const char *str,
1111 int unset __maybe_unused)
1112{
1113 if (metrics) {
1114 char *tmp;
1115
1116 if (asprintf(&tmp, "%s,%s", metrics, str) < 0)
1117 return -ENOMEM;
1118 free(metrics);
1119 metrics = tmp;
1120 } else {
1121 metrics = strdup(str);
1122 if (!metrics)
1123 return -ENOMEM;
1124 }
1125 return 0;
1126}
1127
1128static int parse_control_option(const struct option *opt,
1129 const char *str,
1130 int unset __maybe_unused)
1131{
1132 struct perf_stat_config *config = opt->value;
1133
1134 return evlist__parse_control(str, &config->ctl_fd, &config->ctl_fd_ack, &config->ctl_fd_close);
1135}
1136
1137static int parse_stat_cgroups(const struct option *opt,
1138 const char *str, int unset)
1139{
1140 if (stat_config.cgroup_list) {
1141 pr_err("--cgroup and --for-each-cgroup cannot be used together\n");
1142 return -1;
1143 }
1144
1145 return parse_cgroups(opt, str, unset);
1146}
1147
1148static int parse_hybrid_type(const struct option *opt,
1149 const char *str,
1150 int unset __maybe_unused)
1151{
1152 struct evlist *evlist = *(struct evlist **)opt->value;
1153
1154 if (!list_empty(&evlist->core.entries)) {
1155 fprintf(stderr, "Must define cputype before events/metrics\n");
1156 return -1;
1157 }
1158
1159 evlist->hybrid_pmu_name = perf_pmu__hybrid_type_to_pmu(str);
1160 if (!evlist->hybrid_pmu_name) {
1161 fprintf(stderr, "--cputype %s is not supported!\n", str);
1162 return -1;
1163 }
1164
1165 return 0;
1166}
1167
1168static struct option stat_options[] = {
1169 OPT_BOOLEAN('T', "transaction", &transaction_run,
1170 "hardware transaction statistics"),
1171 OPT_CALLBACK('e', "event", &evsel_list, "event",
1172 "event selector. use 'perf list' to list available events",
1173 parse_events_option),
1174 OPT_CALLBACK(0, "filter", &evsel_list, "filter",
1175 "event filter", parse_filter),
1176 OPT_BOOLEAN('i', "no-inherit", &stat_config.no_inherit,
1177 "child tasks do not inherit counters"),
1178 OPT_STRING('p', "pid", &target.pid, "pid",
1179 "stat events on existing process id"),
1180 OPT_STRING('t', "tid", &target.tid, "tid",
1181 "stat events on existing thread id"),
1182#ifdef HAVE_BPF_SKEL
1183 OPT_STRING('b', "bpf-prog", &target.bpf_str, "bpf-prog-id",
1184 "stat events on existing bpf program id"),
1185 OPT_BOOLEAN(0, "bpf-counters", &target.use_bpf,
1186 "use bpf program to count events"),
1187 OPT_STRING(0, "bpf-attr-map", &target.attr_map, "attr-map-path",
1188 "path to perf_event_attr map"),
1189#endif
1190 OPT_BOOLEAN('a', "all-cpus", &target.system_wide,
1191 "system-wide collection from all CPUs"),
1192 OPT_BOOLEAN(0, "scale", &stat_config.scale,
1193 "Use --no-scale to disable counter scaling for multiplexing"),
1194 OPT_INCR('v', "verbose", &verbose,
1195 "be more verbose (show counter open errors, etc)"),
1196 OPT_INTEGER('r', "repeat", &stat_config.run_count,
1197 "repeat command and print average + stddev (max: 100, forever: 0)"),
1198 OPT_BOOLEAN(0, "table", &stat_config.walltime_run_table,
1199 "display details about each run (only with -r option)"),
1200 OPT_BOOLEAN('n', "null", &stat_config.null_run,
1201 "null run - dont start any counters"),
1202 OPT_INCR('d', "detailed", &detailed_run,
1203 "detailed run - start a lot of events"),
1204 OPT_BOOLEAN('S', "sync", &sync_run,
1205 "call sync() before starting a run"),
1206 OPT_CALLBACK_NOOPT('B', "big-num", NULL, NULL,
1207 "print large numbers with thousands\' separators",
1208 stat__set_big_num),
1209 OPT_STRING('C', "cpu", &target.cpu_list, "cpu",
1210 "list of cpus to monitor in system-wide"),
1211 OPT_SET_UINT('A', "no-aggr", &stat_config.aggr_mode,
1212 "disable CPU count aggregation", AGGR_NONE),
1213 OPT_BOOLEAN(0, "no-merge", &stat_config.no_merge, "Do not merge identical named events"),
1214 OPT_BOOLEAN(0, "hybrid-merge", &stat_config.hybrid_merge,
1215 "Merge identical named hybrid events"),
1216 OPT_STRING('x', "field-separator", &stat_config.csv_sep, "separator",
1217 "print counts with custom separator"),
1218 OPT_BOOLEAN('j', "json-output", &stat_config.json_output,
1219 "print counts in JSON format"),
1220 OPT_CALLBACK('G', "cgroup", &evsel_list, "name",
1221 "monitor event in cgroup name only", parse_stat_cgroups),
1222 OPT_STRING(0, "for-each-cgroup", &stat_config.cgroup_list, "name",
1223 "expand events for each cgroup"),
1224 OPT_STRING('o', "output", &output_name, "file", "output file name"),
1225 OPT_BOOLEAN(0, "append", &append_file, "append to the output file"),
1226 OPT_INTEGER(0, "log-fd", &output_fd,
1227 "log output to fd, instead of stderr"),
1228 OPT_STRING(0, "pre", &pre_cmd, "command",
1229 "command to run prior to the measured command"),
1230 OPT_STRING(0, "post", &post_cmd, "command",
1231 "command to run after to the measured command"),
1232 OPT_UINTEGER('I', "interval-print", &stat_config.interval,
1233 "print counts at regular interval in ms "
1234 "(overhead is possible for values <= 100ms)"),
1235 OPT_INTEGER(0, "interval-count", &stat_config.times,
1236 "print counts for fixed number of times"),
1237 OPT_BOOLEAN(0, "interval-clear", &stat_config.interval_clear,
1238 "clear screen in between new interval"),
1239 OPT_UINTEGER(0, "timeout", &stat_config.timeout,
1240 "stop workload and print counts after a timeout period in ms (>= 10ms)"),
1241 OPT_SET_UINT(0, "per-socket", &stat_config.aggr_mode,
1242 "aggregate counts per processor socket", AGGR_SOCKET),
1243 OPT_SET_UINT(0, "per-die", &stat_config.aggr_mode,
1244 "aggregate counts per processor die", AGGR_DIE),
1245 OPT_SET_UINT(0, "per-core", &stat_config.aggr_mode,
1246 "aggregate counts per physical processor core", AGGR_CORE),
1247 OPT_SET_UINT(0, "per-thread", &stat_config.aggr_mode,
1248 "aggregate counts per thread", AGGR_THREAD),
1249 OPT_SET_UINT(0, "per-node", &stat_config.aggr_mode,
1250 "aggregate counts per numa node", AGGR_NODE),
1251 OPT_INTEGER('D', "delay", &stat_config.initial_delay,
1252 "ms to wait before starting measurement after program start (-1: start with events disabled)"),
1253 OPT_CALLBACK_NOOPT(0, "metric-only", &stat_config.metric_only, NULL,
1254 "Only print computed metrics. No raw values", enable_metric_only),
1255 OPT_BOOLEAN(0, "metric-no-group", &stat_config.metric_no_group,
1256 "don't group metric events, impacts multiplexing"),
1257 OPT_BOOLEAN(0, "metric-no-merge", &stat_config.metric_no_merge,
1258 "don't try to share events between metrics in a group"),
1259 OPT_BOOLEAN(0, "topdown", &topdown_run,
1260 "measure top-down statistics"),
1261 OPT_UINTEGER(0, "td-level", &stat_config.topdown_level,
1262 "Set the metrics level for the top-down statistics (0: max level)"),
1263 OPT_BOOLEAN(0, "smi-cost", &smi_cost,
1264 "measure SMI cost"),
1265 OPT_CALLBACK('M', "metrics", &evsel_list, "metric/metric group list",
1266 "monitor specified metrics or metric groups (separated by ,)",
1267 append_metric_groups),
1268 OPT_BOOLEAN_FLAG(0, "all-kernel", &stat_config.all_kernel,
1269 "Configure all used events to run in kernel space.",
1270 PARSE_OPT_EXCLUSIVE),
1271 OPT_BOOLEAN_FLAG(0, "all-user", &stat_config.all_user,
1272 "Configure all used events to run in user space.",
1273 PARSE_OPT_EXCLUSIVE),
1274 OPT_BOOLEAN(0, "percore-show-thread", &stat_config.percore_show_thread,
1275 "Use with 'percore' event qualifier to show the event "
1276 "counts of one hardware thread by sum up total hardware "
1277 "threads of same physical core"),
1278 OPT_BOOLEAN(0, "summary", &stat_config.summary,
1279 "print summary for interval mode"),
1280 OPT_BOOLEAN(0, "no-csv-summary", &stat_config.no_csv_summary,
1281 "don't print 'summary' for CSV summary output"),
1282 OPT_BOOLEAN(0, "quiet", &quiet,
1283 "don't print any output, messages or warnings (useful with record)"),
1284 OPT_CALLBACK(0, "cputype", &evsel_list, "hybrid cpu type",
1285 "Only enable events on applying cpu with this type "
1286 "for hybrid platform (e.g. core or atom)",
1287 parse_hybrid_type),
1288#ifdef HAVE_LIBPFM
1289 OPT_CALLBACK(0, "pfm-events", &evsel_list, "event",
1290 "libpfm4 event selector. use 'perf list' to list available events",
1291 parse_libpfm_events_option),
1292#endif
1293 OPT_CALLBACK(0, "control", &stat_config, "fd:ctl-fd[,ack-fd] or fifo:ctl-fifo[,ack-fifo]",
1294 "Listen on ctl-fd descriptor for command to control measurement ('enable': enable events, 'disable': disable events).\n"
1295 "\t\t\t Optionally send control command completion ('ack\\n') to ack-fd descriptor.\n"
1296 "\t\t\t Alternatively, ctl-fifo / ack-fifo will be opened and used as ctl-fd / ack-fd.",
1297 parse_control_option),
1298 OPT_CALLBACK_OPTARG(0, "iostat", &evsel_list, &stat_config, "default",
1299 "measure I/O performance metrics provided by arch/platform",
1300 iostat_parse),
1301 OPT_END()
1302};
1303
1304static const char *const aggr_mode__string[] = {
1305 [AGGR_CORE] = "core",
1306 [AGGR_DIE] = "die",
1307 [AGGR_GLOBAL] = "global",
1308 [AGGR_NODE] = "node",
1309 [AGGR_NONE] = "none",
1310 [AGGR_SOCKET] = "socket",
1311 [AGGR_THREAD] = "thread",
1312 [AGGR_UNSET] = "unset",
1313};
1314
1315static struct aggr_cpu_id perf_stat__get_socket(struct perf_stat_config *config __maybe_unused,
1316 struct perf_cpu cpu)
1317{
1318 return aggr_cpu_id__socket(cpu, /*data=*/NULL);
1319}
1320
1321static struct aggr_cpu_id perf_stat__get_die(struct perf_stat_config *config __maybe_unused,
1322 struct perf_cpu cpu)
1323{
1324 return aggr_cpu_id__die(cpu, /*data=*/NULL);
1325}
1326
1327static struct aggr_cpu_id perf_stat__get_core(struct perf_stat_config *config __maybe_unused,
1328 struct perf_cpu cpu)
1329{
1330 return aggr_cpu_id__core(cpu, /*data=*/NULL);
1331}
1332
1333static struct aggr_cpu_id perf_stat__get_node(struct perf_stat_config *config __maybe_unused,
1334 struct perf_cpu cpu)
1335{
1336 return aggr_cpu_id__node(cpu, /*data=*/NULL);
1337}
1338
1339static struct aggr_cpu_id perf_stat__get_global(struct perf_stat_config *config __maybe_unused,
1340 struct perf_cpu cpu)
1341{
1342 return aggr_cpu_id__global(cpu, /*data=*/NULL);
1343}
1344
1345static struct aggr_cpu_id perf_stat__get_cpu(struct perf_stat_config *config __maybe_unused,
1346 struct perf_cpu cpu)
1347{
1348 return aggr_cpu_id__cpu(cpu, /*data=*/NULL);
1349}
1350
1351static struct aggr_cpu_id perf_stat__get_aggr(struct perf_stat_config *config,
1352 aggr_get_id_t get_id, struct perf_cpu cpu)
1353{
1354 struct aggr_cpu_id id;
1355
1356 /* per-process mode - should use global aggr mode */
1357 if (cpu.cpu == -1)
1358 return get_id(config, cpu);
1359
1360 if (aggr_cpu_id__is_empty(&config->cpus_aggr_map->map[cpu.cpu]))
1361 config->cpus_aggr_map->map[cpu.cpu] = get_id(config, cpu);
1362
1363 id = config->cpus_aggr_map->map[cpu.cpu];
1364 return id;
1365}
1366
1367static struct aggr_cpu_id perf_stat__get_socket_cached(struct perf_stat_config *config,
1368 struct perf_cpu cpu)
1369{
1370 return perf_stat__get_aggr(config, perf_stat__get_socket, cpu);
1371}
1372
1373static struct aggr_cpu_id perf_stat__get_die_cached(struct perf_stat_config *config,
1374 struct perf_cpu cpu)
1375{
1376 return perf_stat__get_aggr(config, perf_stat__get_die, cpu);
1377}
1378
1379static struct aggr_cpu_id perf_stat__get_core_cached(struct perf_stat_config *config,
1380 struct perf_cpu cpu)
1381{
1382 return perf_stat__get_aggr(config, perf_stat__get_core, cpu);
1383}
1384
1385static struct aggr_cpu_id perf_stat__get_node_cached(struct perf_stat_config *config,
1386 struct perf_cpu cpu)
1387{
1388 return perf_stat__get_aggr(config, perf_stat__get_node, cpu);
1389}
1390
1391static struct aggr_cpu_id perf_stat__get_global_cached(struct perf_stat_config *config,
1392 struct perf_cpu cpu)
1393{
1394 return perf_stat__get_aggr(config, perf_stat__get_global, cpu);
1395}
1396
1397static struct aggr_cpu_id perf_stat__get_cpu_cached(struct perf_stat_config *config,
1398 struct perf_cpu cpu)
1399{
1400 return perf_stat__get_aggr(config, perf_stat__get_cpu, cpu);
1401}
1402
1403static aggr_cpu_id_get_t aggr_mode__get_aggr(enum aggr_mode aggr_mode)
1404{
1405 switch (aggr_mode) {
1406 case AGGR_SOCKET:
1407 return aggr_cpu_id__socket;
1408 case AGGR_DIE:
1409 return aggr_cpu_id__die;
1410 case AGGR_CORE:
1411 return aggr_cpu_id__core;
1412 case AGGR_NODE:
1413 return aggr_cpu_id__node;
1414 case AGGR_NONE:
1415 return aggr_cpu_id__cpu;
1416 case AGGR_GLOBAL:
1417 return aggr_cpu_id__global;
1418 case AGGR_THREAD:
1419 case AGGR_UNSET:
1420 case AGGR_MAX:
1421 default:
1422 return NULL;
1423 }
1424}
1425
1426static aggr_get_id_t aggr_mode__get_id(enum aggr_mode aggr_mode)
1427{
1428 switch (aggr_mode) {
1429 case AGGR_SOCKET:
1430 return perf_stat__get_socket_cached;
1431 case AGGR_DIE:
1432 return perf_stat__get_die_cached;
1433 case AGGR_CORE:
1434 return perf_stat__get_core_cached;
1435 case AGGR_NODE:
1436 return perf_stat__get_node_cached;
1437 case AGGR_NONE:
1438 return perf_stat__get_cpu_cached;
1439 case AGGR_GLOBAL:
1440 return perf_stat__get_global_cached;
1441 case AGGR_THREAD:
1442 case AGGR_UNSET:
1443 case AGGR_MAX:
1444 default:
1445 return NULL;
1446 }
1447}
1448
1449static int perf_stat_init_aggr_mode(void)
1450{
1451 int nr;
1452 aggr_cpu_id_get_t get_id = aggr_mode__get_aggr(stat_config.aggr_mode);
1453
1454 if (get_id) {
1455 bool needs_sort = stat_config.aggr_mode != AGGR_NONE;
1456 stat_config.aggr_map = cpu_aggr_map__new(evsel_list->core.user_requested_cpus,
1457 get_id, /*data=*/NULL, needs_sort);
1458 if (!stat_config.aggr_map) {
1459 pr_err("cannot build %s map", aggr_mode__string[stat_config.aggr_mode]);
1460 return -1;
1461 }
1462 stat_config.aggr_get_id = aggr_mode__get_id(stat_config.aggr_mode);
1463 }
1464
1465 if (stat_config.aggr_mode == AGGR_THREAD) {
1466 nr = perf_thread_map__nr(evsel_list->core.threads);
1467 stat_config.aggr_map = cpu_aggr_map__empty_new(nr);
1468 if (stat_config.aggr_map == NULL)
1469 return -ENOMEM;
1470
1471 for (int s = 0; s < nr; s++) {
1472 struct aggr_cpu_id id = aggr_cpu_id__empty();
1473
1474 id.thread_idx = s;
1475 stat_config.aggr_map->map[s] = id;
1476 }
1477 return 0;
1478 }
1479
1480 /*
1481 * The evsel_list->cpus is the base we operate on,
1482 * taking the highest cpu number to be the size of
1483 * the aggregation translate cpumap.
1484 */
1485 if (evsel_list->core.user_requested_cpus)
1486 nr = perf_cpu_map__max(evsel_list->core.user_requested_cpus).cpu;
1487 else
1488 nr = 0;
1489 stat_config.cpus_aggr_map = cpu_aggr_map__empty_new(nr + 1);
1490 return stat_config.cpus_aggr_map ? 0 : -ENOMEM;
1491}
1492
1493static void cpu_aggr_map__delete(struct cpu_aggr_map *map)
1494{
1495 if (map) {
1496 WARN_ONCE(refcount_read(&map->refcnt) != 0,
1497 "cpu_aggr_map refcnt unbalanced\n");
1498 free(map);
1499 }
1500}
1501
1502static void cpu_aggr_map__put(struct cpu_aggr_map *map)
1503{
1504 if (map && refcount_dec_and_test(&map->refcnt))
1505 cpu_aggr_map__delete(map);
1506}
1507
1508static void perf_stat__exit_aggr_mode(void)
1509{
1510 cpu_aggr_map__put(stat_config.aggr_map);
1511 cpu_aggr_map__put(stat_config.cpus_aggr_map);
1512 stat_config.aggr_map = NULL;
1513 stat_config.cpus_aggr_map = NULL;
1514}
1515
1516static struct aggr_cpu_id perf_env__get_socket_aggr_by_cpu(struct perf_cpu cpu, void *data)
1517{
1518 struct perf_env *env = data;
1519 struct aggr_cpu_id id = aggr_cpu_id__empty();
1520
1521 if (cpu.cpu != -1)
1522 id.socket = env->cpu[cpu.cpu].socket_id;
1523
1524 return id;
1525}
1526
1527static struct aggr_cpu_id perf_env__get_die_aggr_by_cpu(struct perf_cpu cpu, void *data)
1528{
1529 struct perf_env *env = data;
1530 struct aggr_cpu_id id = aggr_cpu_id__empty();
1531
1532 if (cpu.cpu != -1) {
1533 /*
1534 * die_id is relative to socket, so start
1535 * with the socket ID and then add die to
1536 * make a unique ID.
1537 */
1538 id.socket = env->cpu[cpu.cpu].socket_id;
1539 id.die = env->cpu[cpu.cpu].die_id;
1540 }
1541
1542 return id;
1543}
1544
1545static struct aggr_cpu_id perf_env__get_core_aggr_by_cpu(struct perf_cpu cpu, void *data)
1546{
1547 struct perf_env *env = data;
1548 struct aggr_cpu_id id = aggr_cpu_id__empty();
1549
1550 if (cpu.cpu != -1) {
1551 /*
1552 * core_id is relative to socket and die,
1553 * we need a global id. So we set
1554 * socket, die id and core id
1555 */
1556 id.socket = env->cpu[cpu.cpu].socket_id;
1557 id.die = env->cpu[cpu.cpu].die_id;
1558 id.core = env->cpu[cpu.cpu].core_id;
1559 }
1560
1561 return id;
1562}
1563
1564static struct aggr_cpu_id perf_env__get_cpu_aggr_by_cpu(struct perf_cpu cpu, void *data)
1565{
1566 struct perf_env *env = data;
1567 struct aggr_cpu_id id = aggr_cpu_id__empty();
1568
1569 if (cpu.cpu != -1) {
1570 /*
1571 * core_id is relative to socket and die,
1572 * we need a global id. So we set
1573 * socket, die id and core id
1574 */
1575 id.socket = env->cpu[cpu.cpu].socket_id;
1576 id.die = env->cpu[cpu.cpu].die_id;
1577 id.core = env->cpu[cpu.cpu].core_id;
1578 id.cpu = cpu;
1579 }
1580
1581 return id;
1582}
1583
1584static struct aggr_cpu_id perf_env__get_node_aggr_by_cpu(struct perf_cpu cpu, void *data)
1585{
1586 struct aggr_cpu_id id = aggr_cpu_id__empty();
1587
1588 id.node = perf_env__numa_node(data, cpu);
1589 return id;
1590}
1591
1592static struct aggr_cpu_id perf_env__get_global_aggr_by_cpu(struct perf_cpu cpu __maybe_unused,
1593 void *data __maybe_unused)
1594{
1595 struct aggr_cpu_id id = aggr_cpu_id__empty();
1596
1597 /* it always aggregates to the cpu 0 */
1598 id.cpu = (struct perf_cpu){ .cpu = 0 };
1599 return id;
1600}
1601
1602static struct aggr_cpu_id perf_stat__get_socket_file(struct perf_stat_config *config __maybe_unused,
1603 struct perf_cpu cpu)
1604{
1605 return perf_env__get_socket_aggr_by_cpu(cpu, &perf_stat.session->header.env);
1606}
1607static struct aggr_cpu_id perf_stat__get_die_file(struct perf_stat_config *config __maybe_unused,
1608 struct perf_cpu cpu)
1609{
1610 return perf_env__get_die_aggr_by_cpu(cpu, &perf_stat.session->header.env);
1611}
1612
1613static struct aggr_cpu_id perf_stat__get_core_file(struct perf_stat_config *config __maybe_unused,
1614 struct perf_cpu cpu)
1615{
1616 return perf_env__get_core_aggr_by_cpu(cpu, &perf_stat.session->header.env);
1617}
1618
1619static struct aggr_cpu_id perf_stat__get_cpu_file(struct perf_stat_config *config __maybe_unused,
1620 struct perf_cpu cpu)
1621{
1622 return perf_env__get_cpu_aggr_by_cpu(cpu, &perf_stat.session->header.env);
1623}
1624
1625static struct aggr_cpu_id perf_stat__get_node_file(struct perf_stat_config *config __maybe_unused,
1626 struct perf_cpu cpu)
1627{
1628 return perf_env__get_node_aggr_by_cpu(cpu, &perf_stat.session->header.env);
1629}
1630
1631static struct aggr_cpu_id perf_stat__get_global_file(struct perf_stat_config *config __maybe_unused,
1632 struct perf_cpu cpu)
1633{
1634 return perf_env__get_global_aggr_by_cpu(cpu, &perf_stat.session->header.env);
1635}
1636
1637static aggr_cpu_id_get_t aggr_mode__get_aggr_file(enum aggr_mode aggr_mode)
1638{
1639 switch (aggr_mode) {
1640 case AGGR_SOCKET:
1641 return perf_env__get_socket_aggr_by_cpu;
1642 case AGGR_DIE:
1643 return perf_env__get_die_aggr_by_cpu;
1644 case AGGR_CORE:
1645 return perf_env__get_core_aggr_by_cpu;
1646 case AGGR_NODE:
1647 return perf_env__get_node_aggr_by_cpu;
1648 case AGGR_GLOBAL:
1649 return perf_env__get_global_aggr_by_cpu;
1650 case AGGR_NONE:
1651 return perf_env__get_cpu_aggr_by_cpu;
1652 case AGGR_THREAD:
1653 case AGGR_UNSET:
1654 case AGGR_MAX:
1655 default:
1656 return NULL;
1657 }
1658}
1659
1660static aggr_get_id_t aggr_mode__get_id_file(enum aggr_mode aggr_mode)
1661{
1662 switch (aggr_mode) {
1663 case AGGR_SOCKET:
1664 return perf_stat__get_socket_file;
1665 case AGGR_DIE:
1666 return perf_stat__get_die_file;
1667 case AGGR_CORE:
1668 return perf_stat__get_core_file;
1669 case AGGR_NODE:
1670 return perf_stat__get_node_file;
1671 case AGGR_GLOBAL:
1672 return perf_stat__get_global_file;
1673 case AGGR_NONE:
1674 return perf_stat__get_cpu_file;
1675 case AGGR_THREAD:
1676 case AGGR_UNSET:
1677 case AGGR_MAX:
1678 default:
1679 return NULL;
1680 }
1681}
1682
1683static int perf_stat_init_aggr_mode_file(struct perf_stat *st)
1684{
1685 struct perf_env *env = &st->session->header.env;
1686 aggr_cpu_id_get_t get_id = aggr_mode__get_aggr_file(stat_config.aggr_mode);
1687 bool needs_sort = stat_config.aggr_mode != AGGR_NONE;
1688
1689 if (stat_config.aggr_mode == AGGR_THREAD) {
1690 int nr = perf_thread_map__nr(evsel_list->core.threads);
1691
1692 stat_config.aggr_map = cpu_aggr_map__empty_new(nr);
1693 if (stat_config.aggr_map == NULL)
1694 return -ENOMEM;
1695
1696 for (int s = 0; s < nr; s++) {
1697 struct aggr_cpu_id id = aggr_cpu_id__empty();
1698
1699 id.thread_idx = s;
1700 stat_config.aggr_map->map[s] = id;
1701 }
1702 return 0;
1703 }
1704
1705 if (!get_id)
1706 return 0;
1707
1708 stat_config.aggr_map = cpu_aggr_map__new(evsel_list->core.user_requested_cpus,
1709 get_id, env, needs_sort);
1710 if (!stat_config.aggr_map) {
1711 pr_err("cannot build %s map", aggr_mode__string[stat_config.aggr_mode]);
1712 return -1;
1713 }
1714 stat_config.aggr_get_id = aggr_mode__get_id_file(stat_config.aggr_mode);
1715 return 0;
1716}
1717
1718/*
1719 * Add default attributes, if there were no attributes specified or
1720 * if -d/--detailed, -d -d or -d -d -d is used:
1721 */
1722static int add_default_attributes(void)
1723{
1724 int err;
1725 struct perf_event_attr default_attrs0[] = {
1726
1727 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_TASK_CLOCK },
1728 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_CONTEXT_SWITCHES },
1729 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_CPU_MIGRATIONS },
1730 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_PAGE_FAULTS },
1731
1732 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_CPU_CYCLES },
1733};
1734 struct perf_event_attr frontend_attrs[] = {
1735 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_STALLED_CYCLES_FRONTEND },
1736};
1737 struct perf_event_attr backend_attrs[] = {
1738 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_STALLED_CYCLES_BACKEND },
1739};
1740 struct perf_event_attr default_attrs1[] = {
1741 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_INSTRUCTIONS },
1742 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_BRANCH_INSTRUCTIONS },
1743 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_BRANCH_MISSES },
1744
1745};
1746
1747/*
1748 * Detailed stats (-d), covering the L1 and last level data caches:
1749 */
1750 struct perf_event_attr detailed_attrs[] = {
1751
1752 { .type = PERF_TYPE_HW_CACHE,
1753 .config =
1754 PERF_COUNT_HW_CACHE_L1D << 0 |
1755 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1756 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1757
1758 { .type = PERF_TYPE_HW_CACHE,
1759 .config =
1760 PERF_COUNT_HW_CACHE_L1D << 0 |
1761 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1762 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1763
1764 { .type = PERF_TYPE_HW_CACHE,
1765 .config =
1766 PERF_COUNT_HW_CACHE_LL << 0 |
1767 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1768 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1769
1770 { .type = PERF_TYPE_HW_CACHE,
1771 .config =
1772 PERF_COUNT_HW_CACHE_LL << 0 |
1773 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1774 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1775};
1776
1777/*
1778 * Very detailed stats (-d -d), covering the instruction cache and the TLB caches:
1779 */
1780 struct perf_event_attr very_detailed_attrs[] = {
1781
1782 { .type = PERF_TYPE_HW_CACHE,
1783 .config =
1784 PERF_COUNT_HW_CACHE_L1I << 0 |
1785 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1786 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1787
1788 { .type = PERF_TYPE_HW_CACHE,
1789 .config =
1790 PERF_COUNT_HW_CACHE_L1I << 0 |
1791 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1792 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1793
1794 { .type = PERF_TYPE_HW_CACHE,
1795 .config =
1796 PERF_COUNT_HW_CACHE_DTLB << 0 |
1797 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1798 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1799
1800 { .type = PERF_TYPE_HW_CACHE,
1801 .config =
1802 PERF_COUNT_HW_CACHE_DTLB << 0 |
1803 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1804 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1805
1806 { .type = PERF_TYPE_HW_CACHE,
1807 .config =
1808 PERF_COUNT_HW_CACHE_ITLB << 0 |
1809 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1810 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1811
1812 { .type = PERF_TYPE_HW_CACHE,
1813 .config =
1814 PERF_COUNT_HW_CACHE_ITLB << 0 |
1815 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1816 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1817
1818};
1819
1820/*
1821 * Very, very detailed stats (-d -d -d), adding prefetch events:
1822 */
1823 struct perf_event_attr very_very_detailed_attrs[] = {
1824
1825 { .type = PERF_TYPE_HW_CACHE,
1826 .config =
1827 PERF_COUNT_HW_CACHE_L1D << 0 |
1828 (PERF_COUNT_HW_CACHE_OP_PREFETCH << 8) |
1829 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1830
1831 { .type = PERF_TYPE_HW_CACHE,
1832 .config =
1833 PERF_COUNT_HW_CACHE_L1D << 0 |
1834 (PERF_COUNT_HW_CACHE_OP_PREFETCH << 8) |
1835 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1836};
1837
1838 struct perf_event_attr default_null_attrs[] = {};
1839
1840 /* Set attrs if no event is selected and !null_run: */
1841 if (stat_config.null_run)
1842 return 0;
1843
1844 if (transaction_run) {
1845 struct parse_events_error errinfo;
1846 /* Handle -T as -M transaction. Once platform specific metrics
1847 * support has been added to the json files, all architectures
1848 * will use this approach. To determine transaction support
1849 * on an architecture test for such a metric name.
1850 */
1851 if (metricgroup__has_metric("transaction")) {
1852 return metricgroup__parse_groups(evsel_list, "transaction",
1853 stat_config.metric_no_group,
1854 stat_config.metric_no_merge,
1855 stat_config.user_requested_cpu_list,
1856 stat_config.system_wide,
1857 &stat_config.metric_events);
1858 }
1859
1860 parse_events_error__init(&errinfo);
1861 if (pmu_have_event("cpu", "cycles-ct") &&
1862 pmu_have_event("cpu", "el-start"))
1863 err = parse_events(evsel_list, transaction_attrs,
1864 &errinfo);
1865 else
1866 err = parse_events(evsel_list,
1867 transaction_limited_attrs,
1868 &errinfo);
1869 if (err) {
1870 fprintf(stderr, "Cannot set up transaction events\n");
1871 parse_events_error__print(&errinfo, transaction_attrs);
1872 }
1873 parse_events_error__exit(&errinfo);
1874 return err ? -1 : 0;
1875 }
1876
1877 if (smi_cost) {
1878 struct parse_events_error errinfo;
1879 int smi;
1880
1881 if (sysfs__read_int(FREEZE_ON_SMI_PATH, &smi) < 0) {
1882 fprintf(stderr, "freeze_on_smi is not supported.\n");
1883 return -1;
1884 }
1885
1886 if (!smi) {
1887 if (sysfs__write_int(FREEZE_ON_SMI_PATH, 1) < 0) {
1888 fprintf(stderr, "Failed to set freeze_on_smi.\n");
1889 return -1;
1890 }
1891 smi_reset = true;
1892 }
1893
1894 if (!pmu_have_event("msr", "aperf") ||
1895 !pmu_have_event("msr", "smi")) {
1896 fprintf(stderr, "To measure SMI cost, it needs "
1897 "msr/aperf/, msr/smi/ and cpu/cycles/ support\n");
1898 return -1;
1899 }
1900 if (!force_metric_only)
1901 stat_config.metric_only = true;
1902
1903 parse_events_error__init(&errinfo);
1904 err = parse_events(evsel_list, smi_cost_attrs, &errinfo);
1905 if (err) {
1906 parse_events_error__print(&errinfo, smi_cost_attrs);
1907 fprintf(stderr, "Cannot set up SMI cost events\n");
1908 }
1909 parse_events_error__exit(&errinfo);
1910 return err ? -1 : 0;
1911 }
1912
1913 if (topdown_run) {
1914 const char **metric_attrs = topdown_metric_attrs;
1915 unsigned int max_level = 1;
1916 char *str = NULL;
1917 bool warn = false;
1918 const char *pmu_name = arch_get_topdown_pmu_name(evsel_list, true);
1919
1920 if (!force_metric_only)
1921 stat_config.metric_only = true;
1922
1923 if (pmu_have_event(pmu_name, topdown_metric_L2_attrs[5])) {
1924 metric_attrs = topdown_metric_L2_attrs;
1925 max_level = 2;
1926 }
1927
1928 if (stat_config.topdown_level > max_level) {
1929 pr_err("Invalid top-down metrics level. The max level is %u.\n", max_level);
1930 return -1;
1931 } else if (!stat_config.topdown_level)
1932 stat_config.topdown_level = max_level;
1933
1934 if (topdown_filter_events(metric_attrs, &str, 1, pmu_name) < 0) {
1935 pr_err("Out of memory\n");
1936 return -1;
1937 }
1938
1939 if (metric_attrs[0] && str) {
1940 if (!stat_config.interval && !stat_config.metric_only) {
1941 fprintf(stat_config.output,
1942 "Topdown accuracy may decrease when measuring long periods.\n"
1943 "Please print the result regularly, e.g. -I1000\n");
1944 }
1945 goto setup_metrics;
1946 }
1947
1948 zfree(&str);
1949
1950 if (stat_config.aggr_mode != AGGR_GLOBAL &&
1951 stat_config.aggr_mode != AGGR_CORE) {
1952 pr_err("top down event configuration requires --per-core mode\n");
1953 return -1;
1954 }
1955 stat_config.aggr_mode = AGGR_CORE;
1956 if (nr_cgroups || !target__has_cpu(&target)) {
1957 pr_err("top down event configuration requires system-wide mode (-a)\n");
1958 return -1;
1959 }
1960
1961 if (topdown_filter_events(topdown_attrs, &str,
1962 arch_topdown_check_group(&warn),
1963 pmu_name) < 0) {
1964 pr_err("Out of memory\n");
1965 return -1;
1966 }
1967
1968 if (topdown_attrs[0] && str) {
1969 struct parse_events_error errinfo;
1970 if (warn)
1971 arch_topdown_group_warn();
1972setup_metrics:
1973 parse_events_error__init(&errinfo);
1974 err = parse_events(evsel_list, str, &errinfo);
1975 if (err) {
1976 fprintf(stderr,
1977 "Cannot set up top down events %s: %d\n",
1978 str, err);
1979 parse_events_error__print(&errinfo, str);
1980 parse_events_error__exit(&errinfo);
1981 free(str);
1982 return -1;
1983 }
1984 parse_events_error__exit(&errinfo);
1985 } else {
1986 fprintf(stderr, "System does not support topdown\n");
1987 return -1;
1988 }
1989 free(str);
1990 }
1991
1992 if (!stat_config.topdown_level)
1993 stat_config.topdown_level = TOPDOWN_MAX_LEVEL;
1994
1995 if (!evsel_list->core.nr_entries) {
1996 if (target__has_cpu(&target))
1997 default_attrs0[0].config = PERF_COUNT_SW_CPU_CLOCK;
1998
1999 if (evlist__add_default_attrs(evsel_list, default_attrs0) < 0)
2000 return -1;
2001 if (pmu_have_event("cpu", "stalled-cycles-frontend")) {
2002 if (evlist__add_default_attrs(evsel_list, frontend_attrs) < 0)
2003 return -1;
2004 }
2005 if (pmu_have_event("cpu", "stalled-cycles-backend")) {
2006 if (evlist__add_default_attrs(evsel_list, backend_attrs) < 0)
2007 return -1;
2008 }
2009 if (evlist__add_default_attrs(evsel_list, default_attrs1) < 0)
2010 return -1;
2011 /* Platform specific attrs */
2012 if (evlist__add_default_attrs(evsel_list, default_null_attrs) < 0)
2013 return -1;
2014 }
2015
2016 /* Detailed events get appended to the event list: */
2017
2018 if (detailed_run < 1)
2019 return 0;
2020
2021 /* Append detailed run extra attributes: */
2022 if (evlist__add_default_attrs(evsel_list, detailed_attrs) < 0)
2023 return -1;
2024
2025 if (detailed_run < 2)
2026 return 0;
2027
2028 /* Append very detailed run extra attributes: */
2029 if (evlist__add_default_attrs(evsel_list, very_detailed_attrs) < 0)
2030 return -1;
2031
2032 if (detailed_run < 3)
2033 return 0;
2034
2035 /* Append very, very detailed run extra attributes: */
2036 return evlist__add_default_attrs(evsel_list, very_very_detailed_attrs);
2037}
2038
2039static const char * const stat_record_usage[] = {
2040 "perf stat record [<options>]",
2041 NULL,
2042};
2043
2044static void init_features(struct perf_session *session)
2045{
2046 int feat;
2047
2048 for (feat = HEADER_FIRST_FEATURE; feat < HEADER_LAST_FEATURE; feat++)
2049 perf_header__set_feat(&session->header, feat);
2050
2051 perf_header__clear_feat(&session->header, HEADER_DIR_FORMAT);
2052 perf_header__clear_feat(&session->header, HEADER_BUILD_ID);
2053 perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);
2054 perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
2055 perf_header__clear_feat(&session->header, HEADER_AUXTRACE);
2056}
2057
2058static int __cmd_record(int argc, const char **argv)
2059{
2060 struct perf_session *session;
2061 struct perf_data *data = &perf_stat.data;
2062
2063 argc = parse_options(argc, argv, stat_options, stat_record_usage,
2064 PARSE_OPT_STOP_AT_NON_OPTION);
2065
2066 if (output_name)
2067 data->path = output_name;
2068
2069 if (stat_config.run_count != 1 || forever) {
2070 pr_err("Cannot use -r option with perf stat record.\n");
2071 return -1;
2072 }
2073
2074 session = perf_session__new(data, NULL);
2075 if (IS_ERR(session)) {
2076 pr_err("Perf session creation failed\n");
2077 return PTR_ERR(session);
2078 }
2079
2080 init_features(session);
2081
2082 session->evlist = evsel_list;
2083 perf_stat.session = session;
2084 perf_stat.record = true;
2085 return argc;
2086}
2087
2088static int process_stat_round_event(struct perf_session *session,
2089 union perf_event *event)
2090{
2091 struct perf_record_stat_round *stat_round = &event->stat_round;
2092 struct timespec tsh, *ts = NULL;
2093 const char **argv = session->header.env.cmdline_argv;
2094 int argc = session->header.env.nr_cmdline;
2095
2096 process_counters();
2097
2098 if (stat_round->type == PERF_STAT_ROUND_TYPE__FINAL)
2099 update_stats(&walltime_nsecs_stats, stat_round->time);
2100
2101 if (stat_config.interval && stat_round->time) {
2102 tsh.tv_sec = stat_round->time / NSEC_PER_SEC;
2103 tsh.tv_nsec = stat_round->time % NSEC_PER_SEC;
2104 ts = &tsh;
2105 }
2106
2107 print_counters(ts, argc, argv);
2108 return 0;
2109}
2110
2111static
2112int process_stat_config_event(struct perf_session *session,
2113 union perf_event *event)
2114{
2115 struct perf_tool *tool = session->tool;
2116 struct perf_stat *st = container_of(tool, struct perf_stat, tool);
2117
2118 perf_event__read_stat_config(&stat_config, &event->stat_config);
2119
2120 if (perf_cpu_map__empty(st->cpus)) {
2121 if (st->aggr_mode != AGGR_UNSET)
2122 pr_warning("warning: processing task data, aggregation mode not set\n");
2123 } else if (st->aggr_mode != AGGR_UNSET) {
2124 stat_config.aggr_mode = st->aggr_mode;
2125 }
2126
2127 if (perf_stat.data.is_pipe)
2128 perf_stat_init_aggr_mode();
2129 else
2130 perf_stat_init_aggr_mode_file(st);
2131
2132 if (stat_config.aggr_map) {
2133 int nr_aggr = stat_config.aggr_map->nr;
2134
2135 if (evlist__alloc_aggr_stats(session->evlist, nr_aggr) < 0) {
2136 pr_err("cannot allocate aggr counts\n");
2137 return -1;
2138 }
2139 }
2140 return 0;
2141}
2142
2143static int set_maps(struct perf_stat *st)
2144{
2145 if (!st->cpus || !st->threads)
2146 return 0;
2147
2148 if (WARN_ONCE(st->maps_allocated, "stats double allocation\n"))
2149 return -EINVAL;
2150
2151 perf_evlist__set_maps(&evsel_list->core, st->cpus, st->threads);
2152
2153 if (evlist__alloc_stats(&stat_config, evsel_list, /*alloc_raw=*/true))
2154 return -ENOMEM;
2155
2156 st->maps_allocated = true;
2157 return 0;
2158}
2159
2160static
2161int process_thread_map_event(struct perf_session *session,
2162 union perf_event *event)
2163{
2164 struct perf_tool *tool = session->tool;
2165 struct perf_stat *st = container_of(tool, struct perf_stat, tool);
2166
2167 if (st->threads) {
2168 pr_warning("Extra thread map event, ignoring.\n");
2169 return 0;
2170 }
2171
2172 st->threads = thread_map__new_event(&event->thread_map);
2173 if (!st->threads)
2174 return -ENOMEM;
2175
2176 return set_maps(st);
2177}
2178
2179static
2180int process_cpu_map_event(struct perf_session *session,
2181 union perf_event *event)
2182{
2183 struct perf_tool *tool = session->tool;
2184 struct perf_stat *st = container_of(tool, struct perf_stat, tool);
2185 struct perf_cpu_map *cpus;
2186
2187 if (st->cpus) {
2188 pr_warning("Extra cpu map event, ignoring.\n");
2189 return 0;
2190 }
2191
2192 cpus = cpu_map__new_data(&event->cpu_map.data);
2193 if (!cpus)
2194 return -ENOMEM;
2195
2196 st->cpus = cpus;
2197 return set_maps(st);
2198}
2199
2200static const char * const stat_report_usage[] = {
2201 "perf stat report [<options>]",
2202 NULL,
2203};
2204
2205static struct perf_stat perf_stat = {
2206 .tool = {
2207 .attr = perf_event__process_attr,
2208 .event_update = perf_event__process_event_update,
2209 .thread_map = process_thread_map_event,
2210 .cpu_map = process_cpu_map_event,
2211 .stat_config = process_stat_config_event,
2212 .stat = perf_event__process_stat_event,
2213 .stat_round = process_stat_round_event,
2214 },
2215 .aggr_mode = AGGR_UNSET,
2216};
2217
2218static int __cmd_report(int argc, const char **argv)
2219{
2220 struct perf_session *session;
2221 const struct option options[] = {
2222 OPT_STRING('i', "input", &input_name, "file", "input file name"),
2223 OPT_SET_UINT(0, "per-socket", &perf_stat.aggr_mode,
2224 "aggregate counts per processor socket", AGGR_SOCKET),
2225 OPT_SET_UINT(0, "per-die", &perf_stat.aggr_mode,
2226 "aggregate counts per processor die", AGGR_DIE),
2227 OPT_SET_UINT(0, "per-core", &perf_stat.aggr_mode,
2228 "aggregate counts per physical processor core", AGGR_CORE),
2229 OPT_SET_UINT(0, "per-node", &perf_stat.aggr_mode,
2230 "aggregate counts per numa node", AGGR_NODE),
2231 OPT_SET_UINT('A', "no-aggr", &perf_stat.aggr_mode,
2232 "disable CPU count aggregation", AGGR_NONE),
2233 OPT_END()
2234 };
2235 struct stat st;
2236 int ret;
2237
2238 argc = parse_options(argc, argv, options, stat_report_usage, 0);
2239
2240 if (!input_name || !strlen(input_name)) {
2241 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
2242 input_name = "-";
2243 else
2244 input_name = "perf.data";
2245 }
2246
2247 perf_stat__init_shadow_stats();
2248
2249 perf_stat.data.path = input_name;
2250 perf_stat.data.mode = PERF_DATA_MODE_READ;
2251
2252 session = perf_session__new(&perf_stat.data, &perf_stat.tool);
2253 if (IS_ERR(session))
2254 return PTR_ERR(session);
2255
2256 perf_stat.session = session;
2257 stat_config.output = stderr;
2258 evsel_list = session->evlist;
2259
2260 ret = perf_session__process_events(session);
2261 if (ret)
2262 return ret;
2263
2264 perf_session__delete(session);
2265 return 0;
2266}
2267
2268static void setup_system_wide(int forks)
2269{
2270 /*
2271 * Make system wide (-a) the default target if
2272 * no target was specified and one of following
2273 * conditions is met:
2274 *
2275 * - there's no workload specified
2276 * - there is workload specified but all requested
2277 * events are system wide events
2278 */
2279 if (!target__none(&target))
2280 return;
2281
2282 if (!forks)
2283 target.system_wide = true;
2284 else {
2285 struct evsel *counter;
2286
2287 evlist__for_each_entry(evsel_list, counter) {
2288 if (!counter->core.requires_cpu &&
2289 strcmp(counter->name, "duration_time")) {
2290 return;
2291 }
2292 }
2293
2294 if (evsel_list->core.nr_entries)
2295 target.system_wide = true;
2296 }
2297}
2298
2299int cmd_stat(int argc, const char **argv)
2300{
2301 const char * const stat_usage[] = {
2302 "perf stat [<options>] [<command>]",
2303 NULL
2304 };
2305 int status = -EINVAL, run_idx, err;
2306 const char *mode;
2307 FILE *output = stderr;
2308 unsigned int interval, timeout;
2309 const char * const stat_subcommands[] = { "record", "report" };
2310 char errbuf[BUFSIZ];
2311
2312 setlocale(LC_ALL, "");
2313
2314 evsel_list = evlist__new();
2315 if (evsel_list == NULL)
2316 return -ENOMEM;
2317
2318 parse_events__shrink_config_terms();
2319
2320 /* String-parsing callback-based options would segfault when negated */
2321 set_option_flag(stat_options, 'e', "event", PARSE_OPT_NONEG);
2322 set_option_flag(stat_options, 'M', "metrics", PARSE_OPT_NONEG);
2323 set_option_flag(stat_options, 'G', "cgroup", PARSE_OPT_NONEG);
2324
2325 argc = parse_options_subcommand(argc, argv, stat_options, stat_subcommands,
2326 (const char **) stat_usage,
2327 PARSE_OPT_STOP_AT_NON_OPTION);
2328
2329 if (stat_config.csv_sep) {
2330 stat_config.csv_output = true;
2331 if (!strcmp(stat_config.csv_sep, "\\t"))
2332 stat_config.csv_sep = "\t";
2333 } else
2334 stat_config.csv_sep = DEFAULT_SEPARATOR;
2335
2336 if (argc && strlen(argv[0]) > 2 && strstarts("record", argv[0])) {
2337 argc = __cmd_record(argc, argv);
2338 if (argc < 0)
2339 return -1;
2340 } else if (argc && strlen(argv[0]) > 2 && strstarts("report", argv[0]))
2341 return __cmd_report(argc, argv);
2342
2343 interval = stat_config.interval;
2344 timeout = stat_config.timeout;
2345
2346 /*
2347 * For record command the -o is already taken care of.
2348 */
2349 if (!STAT_RECORD && output_name && strcmp(output_name, "-"))
2350 output = NULL;
2351
2352 if (output_name && output_fd) {
2353 fprintf(stderr, "cannot use both --output and --log-fd\n");
2354 parse_options_usage(stat_usage, stat_options, "o", 1);
2355 parse_options_usage(NULL, stat_options, "log-fd", 0);
2356 goto out;
2357 }
2358
2359 if (stat_config.metric_only && stat_config.aggr_mode == AGGR_THREAD) {
2360 fprintf(stderr, "--metric-only is not supported with --per-thread\n");
2361 goto out;
2362 }
2363
2364 if (stat_config.metric_only && stat_config.run_count > 1) {
2365 fprintf(stderr, "--metric-only is not supported with -r\n");
2366 goto out;
2367 }
2368
2369 if (stat_config.walltime_run_table && stat_config.run_count <= 1) {
2370 fprintf(stderr, "--table is only supported with -r\n");
2371 parse_options_usage(stat_usage, stat_options, "r", 1);
2372 parse_options_usage(NULL, stat_options, "table", 0);
2373 goto out;
2374 }
2375
2376 if (output_fd < 0) {
2377 fprintf(stderr, "argument to --log-fd must be a > 0\n");
2378 parse_options_usage(stat_usage, stat_options, "log-fd", 0);
2379 goto out;
2380 }
2381
2382 if (!output && !quiet) {
2383 struct timespec tm;
2384 mode = append_file ? "a" : "w";
2385
2386 output = fopen(output_name, mode);
2387 if (!output) {
2388 perror("failed to create output file");
2389 return -1;
2390 }
2391 clock_gettime(CLOCK_REALTIME, &tm);
2392 fprintf(output, "# started on %s\n", ctime(&tm.tv_sec));
2393 } else if (output_fd > 0) {
2394 mode = append_file ? "a" : "w";
2395 output = fdopen(output_fd, mode);
2396 if (!output) {
2397 perror("Failed opening logfd");
2398 return -errno;
2399 }
2400 }
2401
2402 if (stat_config.interval_clear && !isatty(fileno(output))) {
2403 fprintf(stderr, "--interval-clear does not work with output\n");
2404 parse_options_usage(stat_usage, stat_options, "o", 1);
2405 parse_options_usage(NULL, stat_options, "log-fd", 0);
2406 parse_options_usage(NULL, stat_options, "interval-clear", 0);
2407 return -1;
2408 }
2409
2410 stat_config.output = output;
2411
2412 /*
2413 * let the spreadsheet do the pretty-printing
2414 */
2415 if (stat_config.csv_output) {
2416 /* User explicitly passed -B? */
2417 if (big_num_opt == 1) {
2418 fprintf(stderr, "-B option not supported with -x\n");
2419 parse_options_usage(stat_usage, stat_options, "B", 1);
2420 parse_options_usage(NULL, stat_options, "x", 1);
2421 goto out;
2422 } else /* Nope, so disable big number formatting */
2423 stat_config.big_num = false;
2424 } else if (big_num_opt == 0) /* User passed --no-big-num */
2425 stat_config.big_num = false;
2426
2427 err = target__validate(&target);
2428 if (err) {
2429 target__strerror(&target, err, errbuf, BUFSIZ);
2430 pr_warning("%s\n", errbuf);
2431 }
2432
2433 setup_system_wide(argc);
2434
2435 /*
2436 * Display user/system times only for single
2437 * run and when there's specified tracee.
2438 */
2439 if ((stat_config.run_count == 1) && target__none(&target))
2440 stat_config.ru_display = true;
2441
2442 if (stat_config.run_count < 0) {
2443 pr_err("Run count must be a positive number\n");
2444 parse_options_usage(stat_usage, stat_options, "r", 1);
2445 goto out;
2446 } else if (stat_config.run_count == 0) {
2447 forever = true;
2448 stat_config.run_count = 1;
2449 }
2450
2451 if (stat_config.walltime_run_table) {
2452 stat_config.walltime_run = zalloc(stat_config.run_count * sizeof(stat_config.walltime_run[0]));
2453 if (!stat_config.walltime_run) {
2454 pr_err("failed to setup -r option");
2455 goto out;
2456 }
2457 }
2458
2459 if ((stat_config.aggr_mode == AGGR_THREAD) &&
2460 !target__has_task(&target)) {
2461 if (!target.system_wide || target.cpu_list) {
2462 fprintf(stderr, "The --per-thread option is only "
2463 "available when monitoring via -p -t -a "
2464 "options or only --per-thread.\n");
2465 parse_options_usage(NULL, stat_options, "p", 1);
2466 parse_options_usage(NULL, stat_options, "t", 1);
2467 goto out;
2468 }
2469 }
2470
2471 /*
2472 * no_aggr, cgroup are for system-wide only
2473 * --per-thread is aggregated per thread, we dont mix it with cpu mode
2474 */
2475 if (((stat_config.aggr_mode != AGGR_GLOBAL &&
2476 stat_config.aggr_mode != AGGR_THREAD) ||
2477 (nr_cgroups || stat_config.cgroup_list)) &&
2478 !target__has_cpu(&target)) {
2479 fprintf(stderr, "both cgroup and no-aggregation "
2480 "modes only available in system-wide mode\n");
2481
2482 parse_options_usage(stat_usage, stat_options, "G", 1);
2483 parse_options_usage(NULL, stat_options, "A", 1);
2484 parse_options_usage(NULL, stat_options, "a", 1);
2485 parse_options_usage(NULL, stat_options, "for-each-cgroup", 0);
2486 goto out;
2487 }
2488
2489 if (stat_config.iostat_run) {
2490 status = iostat_prepare(evsel_list, &stat_config);
2491 if (status)
2492 goto out;
2493 if (iostat_mode == IOSTAT_LIST) {
2494 iostat_list(evsel_list, &stat_config);
2495 goto out;
2496 } else if (verbose > 0)
2497 iostat_list(evsel_list, &stat_config);
2498 if (iostat_mode == IOSTAT_RUN && !target__has_cpu(&target))
2499 target.system_wide = true;
2500 }
2501
2502 if ((stat_config.aggr_mode == AGGR_THREAD) && (target.system_wide))
2503 target.per_thread = true;
2504
2505 stat_config.system_wide = target.system_wide;
2506 if (target.cpu_list) {
2507 stat_config.user_requested_cpu_list = strdup(target.cpu_list);
2508 if (!stat_config.user_requested_cpu_list) {
2509 status = -ENOMEM;
2510 goto out;
2511 }
2512 }
2513
2514 /*
2515 * Metric parsing needs to be delayed as metrics may optimize events
2516 * knowing the target is system-wide.
2517 */
2518 if (metrics) {
2519 metricgroup__parse_groups(evsel_list, metrics,
2520 stat_config.metric_no_group,
2521 stat_config.metric_no_merge,
2522 stat_config.user_requested_cpu_list,
2523 stat_config.system_wide,
2524 &stat_config.metric_events);
2525 zfree(&metrics);
2526 }
2527 perf_stat__collect_metric_expr(evsel_list);
2528 perf_stat__init_shadow_stats();
2529
2530 if (add_default_attributes())
2531 goto out;
2532
2533 if (stat_config.cgroup_list) {
2534 if (nr_cgroups > 0) {
2535 pr_err("--cgroup and --for-each-cgroup cannot be used together\n");
2536 parse_options_usage(stat_usage, stat_options, "G", 1);
2537 parse_options_usage(NULL, stat_options, "for-each-cgroup", 0);
2538 goto out;
2539 }
2540
2541 if (evlist__expand_cgroup(evsel_list, stat_config.cgroup_list,
2542 &stat_config.metric_events, true) < 0) {
2543 parse_options_usage(stat_usage, stat_options,
2544 "for-each-cgroup", 0);
2545 goto out;
2546 }
2547 }
2548
2549 if (evlist__fix_hybrid_cpus(evsel_list, target.cpu_list)) {
2550 pr_err("failed to use cpu list %s\n", target.cpu_list);
2551 goto out;
2552 }
2553
2554 target.hybrid = perf_pmu__has_hybrid();
2555 if (evlist__create_maps(evsel_list, &target) < 0) {
2556 if (target__has_task(&target)) {
2557 pr_err("Problems finding threads of monitor\n");
2558 parse_options_usage(stat_usage, stat_options, "p", 1);
2559 parse_options_usage(NULL, stat_options, "t", 1);
2560 } else if (target__has_cpu(&target)) {
2561 perror("failed to parse CPUs map");
2562 parse_options_usage(stat_usage, stat_options, "C", 1);
2563 parse_options_usage(NULL, stat_options, "a", 1);
2564 }
2565 goto out;
2566 }
2567
2568 evlist__check_cpu_maps(evsel_list);
2569
2570 /*
2571 * Initialize thread_map with comm names,
2572 * so we could print it out on output.
2573 */
2574 if (stat_config.aggr_mode == AGGR_THREAD) {
2575 thread_map__read_comms(evsel_list->core.threads);
2576 }
2577
2578 if (stat_config.aggr_mode == AGGR_NODE)
2579 cpu__setup_cpunode_map();
2580
2581 if (stat_config.times && interval)
2582 interval_count = true;
2583 else if (stat_config.times && !interval) {
2584 pr_err("interval-count option should be used together with "
2585 "interval-print.\n");
2586 parse_options_usage(stat_usage, stat_options, "interval-count", 0);
2587 parse_options_usage(stat_usage, stat_options, "I", 1);
2588 goto out;
2589 }
2590
2591 if (timeout && timeout < 100) {
2592 if (timeout < 10) {
2593 pr_err("timeout must be >= 10ms.\n");
2594 parse_options_usage(stat_usage, stat_options, "timeout", 0);
2595 goto out;
2596 } else
2597 pr_warning("timeout < 100ms. "
2598 "The overhead percentage could be high in some cases. "
2599 "Please proceed with caution.\n");
2600 }
2601 if (timeout && interval) {
2602 pr_err("timeout option is not supported with interval-print.\n");
2603 parse_options_usage(stat_usage, stat_options, "timeout", 0);
2604 parse_options_usage(stat_usage, stat_options, "I", 1);
2605 goto out;
2606 }
2607
2608 if (perf_stat_init_aggr_mode())
2609 goto out;
2610
2611 if (evlist__alloc_stats(&stat_config, evsel_list, interval))
2612 goto out;
2613
2614 /*
2615 * Set sample_type to PERF_SAMPLE_IDENTIFIER, which should be harmless
2616 * while avoiding that older tools show confusing messages.
2617 *
2618 * However for pipe sessions we need to keep it zero,
2619 * because script's perf_evsel__check_attr is triggered
2620 * by attr->sample_type != 0, and we can't run it on
2621 * stat sessions.
2622 */
2623 stat_config.identifier = !(STAT_RECORD && perf_stat.data.is_pipe);
2624
2625 /*
2626 * We dont want to block the signals - that would cause
2627 * child tasks to inherit that and Ctrl-C would not work.
2628 * What we want is for Ctrl-C to work in the exec()-ed
2629 * task, but being ignored by perf stat itself:
2630 */
2631 atexit(sig_atexit);
2632 if (!forever)
2633 signal(SIGINT, skip_signal);
2634 signal(SIGCHLD, skip_signal);
2635 signal(SIGALRM, skip_signal);
2636 signal(SIGABRT, skip_signal);
2637
2638 if (evlist__initialize_ctlfd(evsel_list, stat_config.ctl_fd, stat_config.ctl_fd_ack))
2639 goto out;
2640
2641 /* Enable ignoring missing threads when -p option is defined. */
2642 evlist__first(evsel_list)->ignore_missing_thread = target.pid;
2643 status = 0;
2644 for (run_idx = 0; forever || run_idx < stat_config.run_count; run_idx++) {
2645 if (stat_config.run_count != 1 && verbose > 0)
2646 fprintf(output, "[ perf stat: executing run #%d ... ]\n",
2647 run_idx + 1);
2648
2649 if (run_idx != 0)
2650 evlist__reset_prev_raw_counts(evsel_list);
2651
2652 status = run_perf_stat(argc, argv, run_idx);
2653 if (forever && status != -1 && !interval) {
2654 print_counters(NULL, argc, argv);
2655 perf_stat__reset_stats();
2656 }
2657 }
2658
2659 if (!forever && status != -1 && (!interval || stat_config.summary))
2660 print_counters(NULL, argc, argv);
2661
2662 evlist__finalize_ctlfd(evsel_list);
2663
2664 if (STAT_RECORD) {
2665 /*
2666 * We synthesize the kernel mmap record just so that older tools
2667 * don't emit warnings about not being able to resolve symbols
2668 * due to /proc/sys/kernel/kptr_restrict settings and instead provide
2669 * a saner message about no samples being in the perf.data file.
2670 *
2671 * This also serves to suppress a warning about f_header.data.size == 0
2672 * in header.c at the moment 'perf stat record' gets introduced, which
2673 * is not really needed once we start adding the stat specific PERF_RECORD_
2674 * records, but the need to suppress the kptr_restrict messages in older
2675 * tools remain -acme
2676 */
2677 int fd = perf_data__fd(&perf_stat.data);
2678
2679 err = perf_event__synthesize_kernel_mmap((void *)&perf_stat,
2680 process_synthesized_event,
2681 &perf_stat.session->machines.host);
2682 if (err) {
2683 pr_warning("Couldn't synthesize the kernel mmap record, harmless, "
2684 "older tools may produce warnings about this file\n.");
2685 }
2686
2687 if (!interval) {
2688 if (WRITE_STAT_ROUND_EVENT(walltime_nsecs_stats.max, FINAL))
2689 pr_err("failed to write stat round event\n");
2690 }
2691
2692 if (!perf_stat.data.is_pipe) {
2693 perf_stat.session->header.data_size += perf_stat.bytes_written;
2694 perf_session__write_header(perf_stat.session, evsel_list, fd, true);
2695 }
2696
2697 evlist__close(evsel_list);
2698 perf_session__delete(perf_stat.session);
2699 }
2700
2701 perf_stat__exit_aggr_mode();
2702 evlist__free_stats(evsel_list);
2703out:
2704 if (stat_config.iostat_run)
2705 iostat_release(evsel_list);
2706
2707 zfree(&stat_config.walltime_run);
2708 zfree(&stat_config.user_requested_cpu_list);
2709
2710 if (smi_cost && smi_reset)
2711 sysfs__write_int(FREEZE_ON_SMI_PATH, 0);
2712
2713 evlist__delete(evsel_list);
2714
2715 metricgroup__rblist_exit(&stat_config.metric_events);
2716 evlist__close_control(stat_config.ctl_fd, stat_config.ctl_fd_ack, &stat_config.ctl_fd_close);
2717
2718 return status;
2719}