Loading...
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/evsel.h"
52#include "util/debug.h"
53#include "util/color.h"
54#include "util/stat.h"
55#include "util/header.h"
56#include "util/cpumap.h"
57#include "util/thread_map.h"
58#include "util/counts.h"
59#include "util/group.h"
60#include "util/session.h"
61#include "util/tool.h"
62#include "util/string2.h"
63#include "util/metricgroup.h"
64#include "util/synthetic-events.h"
65#include "util/target.h"
66#include "util/time-utils.h"
67#include "util/top.h"
68#include "asm/bug.h"
69
70#include <linux/time64.h>
71#include <linux/zalloc.h>
72#include <api/fs/fs.h>
73#include <errno.h>
74#include <signal.h>
75#include <stdlib.h>
76#include <sys/prctl.h>
77#include <inttypes.h>
78#include <locale.h>
79#include <math.h>
80#include <sys/types.h>
81#include <sys/stat.h>
82#include <sys/wait.h>
83#include <unistd.h>
84#include <sys/time.h>
85#include <sys/resource.h>
86#include <linux/err.h>
87
88#include <linux/ctype.h>
89#include <perf/evlist.h>
90
91#define DEFAULT_SEPARATOR " "
92#define FREEZE_ON_SMI_PATH "devices/cpu/freeze_on_smi"
93
94static void print_counters(struct timespec *ts, int argc, const char **argv);
95
96/* Default events used for perf stat -T */
97static const char *transaction_attrs = {
98 "task-clock,"
99 "{"
100 "instructions,"
101 "cycles,"
102 "cpu/cycles-t/,"
103 "cpu/tx-start/,"
104 "cpu/el-start/,"
105 "cpu/cycles-ct/"
106 "}"
107};
108
109/* More limited version when the CPU does not have all events. */
110static const char * transaction_limited_attrs = {
111 "task-clock,"
112 "{"
113 "instructions,"
114 "cycles,"
115 "cpu/cycles-t/,"
116 "cpu/tx-start/"
117 "}"
118};
119
120static const char * topdown_attrs[] = {
121 "topdown-total-slots",
122 "topdown-slots-retired",
123 "topdown-recovery-bubbles",
124 "topdown-fetch-bubbles",
125 "topdown-slots-issued",
126 NULL,
127};
128
129static const char *smi_cost_attrs = {
130 "{"
131 "msr/aperf/,"
132 "msr/smi/,"
133 "cycles"
134 "}"
135};
136
137static struct evlist *evsel_list;
138
139static struct target target = {
140 .uid = UINT_MAX,
141};
142
143#define METRIC_ONLY_LEN 20
144
145static volatile pid_t child_pid = -1;
146static int detailed_run = 0;
147static bool transaction_run;
148static bool topdown_run = false;
149static bool smi_cost = false;
150static bool smi_reset = false;
151static int big_num_opt = -1;
152static bool group = false;
153static const char *pre_cmd = NULL;
154static const char *post_cmd = NULL;
155static bool sync_run = false;
156static bool forever = false;
157static bool force_metric_only = false;
158static struct timespec ref_time;
159static bool append_file;
160static bool interval_count;
161static const char *output_name;
162static int output_fd;
163
164struct perf_stat {
165 bool record;
166 struct perf_data data;
167 struct perf_session *session;
168 u64 bytes_written;
169 struct perf_tool tool;
170 bool maps_allocated;
171 struct perf_cpu_map *cpus;
172 struct perf_thread_map *threads;
173 enum aggr_mode aggr_mode;
174};
175
176static struct perf_stat perf_stat;
177#define STAT_RECORD perf_stat.record
178
179static volatile int done = 0;
180
181static struct perf_stat_config stat_config = {
182 .aggr_mode = AGGR_GLOBAL,
183 .scale = true,
184 .unit_width = 4, /* strlen("unit") */
185 .run_count = 1,
186 .metric_only_len = METRIC_ONLY_LEN,
187 .walltime_nsecs_stats = &walltime_nsecs_stats,
188 .big_num = true,
189};
190
191static inline void diff_timespec(struct timespec *r, struct timespec *a,
192 struct timespec *b)
193{
194 r->tv_sec = a->tv_sec - b->tv_sec;
195 if (a->tv_nsec < b->tv_nsec) {
196 r->tv_nsec = a->tv_nsec + NSEC_PER_SEC - b->tv_nsec;
197 r->tv_sec--;
198 } else {
199 r->tv_nsec = a->tv_nsec - b->tv_nsec ;
200 }
201}
202
203static void perf_stat__reset_stats(void)
204{
205 int i;
206
207 perf_evlist__reset_stats(evsel_list);
208 perf_stat__reset_shadow_stats();
209
210 for (i = 0; i < stat_config.stats_num; i++)
211 perf_stat__reset_shadow_per_stat(&stat_config.stats[i]);
212}
213
214static int process_synthesized_event(struct perf_tool *tool __maybe_unused,
215 union perf_event *event,
216 struct perf_sample *sample __maybe_unused,
217 struct machine *machine __maybe_unused)
218{
219 if (perf_data__write(&perf_stat.data, event, event->header.size) < 0) {
220 pr_err("failed to write perf data, error: %m\n");
221 return -1;
222 }
223
224 perf_stat.bytes_written += event->header.size;
225 return 0;
226}
227
228static int write_stat_round_event(u64 tm, u64 type)
229{
230 return perf_event__synthesize_stat_round(NULL, tm, type,
231 process_synthesized_event,
232 NULL);
233}
234
235#define WRITE_STAT_ROUND_EVENT(time, interval) \
236 write_stat_round_event(time, PERF_STAT_ROUND_TYPE__ ## interval)
237
238#define SID(e, x, y) xyarray__entry(e->core.sample_id, x, y)
239
240static int
241perf_evsel__write_stat_event(struct evsel *counter, u32 cpu, u32 thread,
242 struct perf_counts_values *count)
243{
244 struct perf_sample_id *sid = SID(counter, cpu, thread);
245
246 return perf_event__synthesize_stat(NULL, cpu, thread, sid->id, count,
247 process_synthesized_event, NULL);
248}
249
250static int read_single_counter(struct evsel *counter, int cpu,
251 int thread, struct timespec *rs)
252{
253 if (counter->tool_event == PERF_TOOL_DURATION_TIME) {
254 u64 val = rs->tv_nsec + rs->tv_sec*1000000000ULL;
255 struct perf_counts_values *count =
256 perf_counts(counter->counts, cpu, thread);
257 count->ena = count->run = val;
258 count->val = val;
259 return 0;
260 }
261 return perf_evsel__read_counter(counter, cpu, thread);
262}
263
264/*
265 * Read out the results of a single counter:
266 * do not aggregate counts across CPUs in system-wide mode
267 */
268static int read_counter(struct evsel *counter, struct timespec *rs)
269{
270 int nthreads = perf_thread_map__nr(evsel_list->core.threads);
271 int ncpus, cpu, thread;
272
273 if (target__has_cpu(&target) && !target__has_per_thread(&target))
274 ncpus = perf_evsel__nr_cpus(counter);
275 else
276 ncpus = 1;
277
278 if (!counter->supported)
279 return -ENOENT;
280
281 if (counter->core.system_wide)
282 nthreads = 1;
283
284 for (thread = 0; thread < nthreads; thread++) {
285 for (cpu = 0; cpu < ncpus; cpu++) {
286 struct perf_counts_values *count;
287
288 count = perf_counts(counter->counts, cpu, thread);
289
290 /*
291 * The leader's group read loads data into its group members
292 * (via perf_evsel__read_counter) and sets threir count->loaded.
293 */
294 if (!perf_counts__is_loaded(counter->counts, cpu, thread) &&
295 read_single_counter(counter, cpu, thread, rs)) {
296 counter->counts->scaled = -1;
297 perf_counts(counter->counts, cpu, thread)->ena = 0;
298 perf_counts(counter->counts, cpu, thread)->run = 0;
299 return -1;
300 }
301
302 perf_counts__set_loaded(counter->counts, cpu, thread, false);
303
304 if (STAT_RECORD) {
305 if (perf_evsel__write_stat_event(counter, cpu, thread, count)) {
306 pr_err("failed to write stat event\n");
307 return -1;
308 }
309 }
310
311 if (verbose > 1) {
312 fprintf(stat_config.output,
313 "%s: %d: %" PRIu64 " %" PRIu64 " %" PRIu64 "\n",
314 perf_evsel__name(counter),
315 cpu,
316 count->val, count->ena, count->run);
317 }
318 }
319 }
320
321 return 0;
322}
323
324static void read_counters(struct timespec *rs)
325{
326 struct evsel *counter;
327 int ret;
328
329 evlist__for_each_entry(evsel_list, counter) {
330 ret = read_counter(counter, rs);
331 if (ret)
332 pr_debug("failed to read counter %s\n", counter->name);
333
334 if (ret == 0 && perf_stat_process_counter(&stat_config, counter))
335 pr_warning("failed to process counter %s\n", counter->name);
336 }
337}
338
339static void process_interval(void)
340{
341 struct timespec ts, rs;
342
343 clock_gettime(CLOCK_MONOTONIC, &ts);
344 diff_timespec(&rs, &ts, &ref_time);
345
346 read_counters(&rs);
347
348 if (STAT_RECORD) {
349 if (WRITE_STAT_ROUND_EVENT(rs.tv_sec * NSEC_PER_SEC + rs.tv_nsec, INTERVAL))
350 pr_err("failed to write stat round event\n");
351 }
352
353 init_stats(&walltime_nsecs_stats);
354 update_stats(&walltime_nsecs_stats, stat_config.interval * 1000000);
355 print_counters(&rs, 0, NULL);
356}
357
358static void enable_counters(void)
359{
360 if (stat_config.initial_delay)
361 usleep(stat_config.initial_delay * USEC_PER_MSEC);
362
363 /*
364 * We need to enable counters only if:
365 * - we don't have tracee (attaching to task or cpu)
366 * - we have initial delay configured
367 */
368 if (!target__none(&target) || stat_config.initial_delay)
369 evlist__enable(evsel_list);
370}
371
372static void disable_counters(void)
373{
374 /*
375 * If we don't have tracee (attaching to task or cpu), counters may
376 * still be running. To get accurate group ratios, we must stop groups
377 * from counting before reading their constituent counters.
378 */
379 if (!target__none(&target))
380 evlist__disable(evsel_list);
381}
382
383static volatile int workload_exec_errno;
384
385/*
386 * perf_evlist__prepare_workload will send a SIGUSR1
387 * if the fork fails, since we asked by setting its
388 * want_signal to true.
389 */
390static void workload_exec_failed_signal(int signo __maybe_unused, siginfo_t *info,
391 void *ucontext __maybe_unused)
392{
393 workload_exec_errno = info->si_value.sival_int;
394}
395
396static bool perf_evsel__should_store_id(struct evsel *counter)
397{
398 return STAT_RECORD || counter->core.attr.read_format & PERF_FORMAT_ID;
399}
400
401static bool is_target_alive(struct target *_target,
402 struct perf_thread_map *threads)
403{
404 struct stat st;
405 int i;
406
407 if (!target__has_task(_target))
408 return true;
409
410 for (i = 0; i < threads->nr; i++) {
411 char path[PATH_MAX];
412
413 scnprintf(path, PATH_MAX, "%s/%d", procfs__mountpoint(),
414 threads->map[i].pid);
415
416 if (!stat(path, &st))
417 return true;
418 }
419
420 return false;
421}
422
423static int __run_perf_stat(int argc, const char **argv, int run_idx)
424{
425 int interval = stat_config.interval;
426 int times = stat_config.times;
427 int timeout = stat_config.timeout;
428 char msg[BUFSIZ];
429 unsigned long long t0, t1;
430 struct evsel *counter;
431 struct timespec ts;
432 size_t l;
433 int status = 0;
434 const bool forks = (argc > 0);
435 bool is_pipe = STAT_RECORD ? perf_stat.data.is_pipe : false;
436
437 if (interval) {
438 ts.tv_sec = interval / USEC_PER_MSEC;
439 ts.tv_nsec = (interval % USEC_PER_MSEC) * NSEC_PER_MSEC;
440 } else if (timeout) {
441 ts.tv_sec = timeout / USEC_PER_MSEC;
442 ts.tv_nsec = (timeout % USEC_PER_MSEC) * NSEC_PER_MSEC;
443 } else {
444 ts.tv_sec = 1;
445 ts.tv_nsec = 0;
446 }
447
448 if (forks) {
449 if (perf_evlist__prepare_workload(evsel_list, &target, argv, is_pipe,
450 workload_exec_failed_signal) < 0) {
451 perror("failed to prepare workload");
452 return -1;
453 }
454 child_pid = evsel_list->workload.pid;
455 }
456
457 if (group)
458 perf_evlist__set_leader(evsel_list);
459
460 evlist__for_each_entry(evsel_list, counter) {
461try_again:
462 if (create_perf_stat_counter(counter, &stat_config, &target) < 0) {
463
464 /* Weak group failed. Reset the group. */
465 if ((errno == EINVAL || errno == EBADF) &&
466 counter->leader != counter &&
467 counter->weak_group) {
468 counter = perf_evlist__reset_weak_group(evsel_list, counter);
469 goto try_again;
470 }
471
472 /*
473 * PPC returns ENXIO for HW counters until 2.6.37
474 * (behavior changed with commit b0a873e).
475 */
476 if (errno == EINVAL || errno == ENOSYS ||
477 errno == ENOENT || errno == EOPNOTSUPP ||
478 errno == ENXIO) {
479 if (verbose > 0)
480 ui__warning("%s event is not supported by the kernel.\n",
481 perf_evsel__name(counter));
482 counter->supported = false;
483
484 if ((counter->leader != counter) ||
485 !(counter->leader->core.nr_members > 1))
486 continue;
487 } else if (perf_evsel__fallback(counter, errno, msg, sizeof(msg))) {
488 if (verbose > 0)
489 ui__warning("%s\n", msg);
490 goto try_again;
491 } else if (target__has_per_thread(&target) &&
492 evsel_list->core.threads &&
493 evsel_list->core.threads->err_thread != -1) {
494 /*
495 * For global --per-thread case, skip current
496 * error thread.
497 */
498 if (!thread_map__remove(evsel_list->core.threads,
499 evsel_list->core.threads->err_thread)) {
500 evsel_list->core.threads->err_thread = -1;
501 goto try_again;
502 }
503 }
504
505 perf_evsel__open_strerror(counter, &target,
506 errno, msg, sizeof(msg));
507 ui__error("%s\n", msg);
508
509 if (child_pid != -1)
510 kill(child_pid, SIGTERM);
511
512 return -1;
513 }
514 counter->supported = true;
515
516 l = strlen(counter->unit);
517 if (l > stat_config.unit_width)
518 stat_config.unit_width = l;
519
520 if (perf_evsel__should_store_id(counter) &&
521 perf_evsel__store_ids(counter, evsel_list))
522 return -1;
523 }
524
525 if (perf_evlist__apply_filters(evsel_list, &counter)) {
526 pr_err("failed to set filter \"%s\" on event %s with %d (%s)\n",
527 counter->filter, perf_evsel__name(counter), errno,
528 str_error_r(errno, msg, sizeof(msg)));
529 return -1;
530 }
531
532 if (STAT_RECORD) {
533 int err, fd = perf_data__fd(&perf_stat.data);
534
535 if (is_pipe) {
536 err = perf_header__write_pipe(perf_data__fd(&perf_stat.data));
537 } else {
538 err = perf_session__write_header(perf_stat.session, evsel_list,
539 fd, false);
540 }
541
542 if (err < 0)
543 return err;
544
545 err = perf_event__synthesize_stat_events(&stat_config, NULL, evsel_list,
546 process_synthesized_event, is_pipe);
547 if (err < 0)
548 return err;
549 }
550
551 /*
552 * Enable counters and exec the command:
553 */
554 t0 = rdclock();
555 clock_gettime(CLOCK_MONOTONIC, &ref_time);
556
557 if (forks) {
558 perf_evlist__start_workload(evsel_list);
559 enable_counters();
560
561 if (interval || timeout) {
562 while (!waitpid(child_pid, &status, WNOHANG)) {
563 nanosleep(&ts, NULL);
564 if (timeout)
565 break;
566 process_interval();
567 if (interval_count && !(--times))
568 break;
569 }
570 }
571 if (child_pid != -1)
572 wait4(child_pid, &status, 0, &stat_config.ru_data);
573
574 if (workload_exec_errno) {
575 const char *emsg = str_error_r(workload_exec_errno, msg, sizeof(msg));
576 pr_err("Workload failed: %s\n", emsg);
577 return -1;
578 }
579
580 if (WIFSIGNALED(status))
581 psignal(WTERMSIG(status), argv[0]);
582 } else {
583 enable_counters();
584 while (!done) {
585 nanosleep(&ts, NULL);
586 if (!is_target_alive(&target, evsel_list->core.threads))
587 break;
588 if (timeout)
589 break;
590 if (interval) {
591 process_interval();
592 if (interval_count && !(--times))
593 break;
594 }
595 }
596 }
597
598 disable_counters();
599
600 t1 = rdclock();
601
602 if (stat_config.walltime_run_table)
603 stat_config.walltime_run[run_idx] = t1 - t0;
604
605 update_stats(&walltime_nsecs_stats, t1 - t0);
606
607 /*
608 * Closing a group leader splits the group, and as we only disable
609 * group leaders, results in remaining events becoming enabled. To
610 * avoid arbitrary skew, we must read all counters before closing any
611 * group leaders.
612 */
613 read_counters(&(struct timespec) { .tv_nsec = t1-t0 });
614
615 /*
616 * We need to keep evsel_list alive, because it's processed
617 * later the evsel_list will be closed after.
618 */
619 if (!STAT_RECORD)
620 evlist__close(evsel_list);
621
622 return WEXITSTATUS(status);
623}
624
625static int run_perf_stat(int argc, const char **argv, int run_idx)
626{
627 int ret;
628
629 if (pre_cmd) {
630 ret = system(pre_cmd);
631 if (ret)
632 return ret;
633 }
634
635 if (sync_run)
636 sync();
637
638 ret = __run_perf_stat(argc, argv, run_idx);
639 if (ret)
640 return ret;
641
642 if (post_cmd) {
643 ret = system(post_cmd);
644 if (ret)
645 return ret;
646 }
647
648 return ret;
649}
650
651static void print_counters(struct timespec *ts, int argc, const char **argv)
652{
653 /* Do not print anything if we record to the pipe. */
654 if (STAT_RECORD && perf_stat.data.is_pipe)
655 return;
656
657 perf_evlist__print_counters(evsel_list, &stat_config, &target,
658 ts, argc, argv);
659}
660
661static volatile int signr = -1;
662
663static void skip_signal(int signo)
664{
665 if ((child_pid == -1) || stat_config.interval)
666 done = 1;
667
668 signr = signo;
669 /*
670 * render child_pid harmless
671 * won't send SIGTERM to a random
672 * process in case of race condition
673 * and fast PID recycling
674 */
675 child_pid = -1;
676}
677
678static void sig_atexit(void)
679{
680 sigset_t set, oset;
681
682 /*
683 * avoid race condition with SIGCHLD handler
684 * in skip_signal() which is modifying child_pid
685 * goal is to avoid send SIGTERM to a random
686 * process
687 */
688 sigemptyset(&set);
689 sigaddset(&set, SIGCHLD);
690 sigprocmask(SIG_BLOCK, &set, &oset);
691
692 if (child_pid != -1)
693 kill(child_pid, SIGTERM);
694
695 sigprocmask(SIG_SETMASK, &oset, NULL);
696
697 if (signr == -1)
698 return;
699
700 signal(signr, SIG_DFL);
701 kill(getpid(), signr);
702}
703
704static int stat__set_big_num(const struct option *opt __maybe_unused,
705 const char *s __maybe_unused, int unset)
706{
707 big_num_opt = unset ? 0 : 1;
708 return 0;
709}
710
711static int enable_metric_only(const struct option *opt __maybe_unused,
712 const char *s __maybe_unused, int unset)
713{
714 force_metric_only = true;
715 stat_config.metric_only = !unset;
716 return 0;
717}
718
719static int parse_metric_groups(const struct option *opt,
720 const char *str,
721 int unset __maybe_unused)
722{
723 return metricgroup__parse_groups(opt, str, &stat_config.metric_events);
724}
725
726static struct option stat_options[] = {
727 OPT_BOOLEAN('T', "transaction", &transaction_run,
728 "hardware transaction statistics"),
729 OPT_CALLBACK('e', "event", &evsel_list, "event",
730 "event selector. use 'perf list' to list available events",
731 parse_events_option),
732 OPT_CALLBACK(0, "filter", &evsel_list, "filter",
733 "event filter", parse_filter),
734 OPT_BOOLEAN('i', "no-inherit", &stat_config.no_inherit,
735 "child tasks do not inherit counters"),
736 OPT_STRING('p', "pid", &target.pid, "pid",
737 "stat events on existing process id"),
738 OPT_STRING('t', "tid", &target.tid, "tid",
739 "stat events on existing thread id"),
740 OPT_BOOLEAN('a', "all-cpus", &target.system_wide,
741 "system-wide collection from all CPUs"),
742 OPT_BOOLEAN('g', "group", &group,
743 "put the counters into a counter group"),
744 OPT_BOOLEAN(0, "scale", &stat_config.scale,
745 "Use --no-scale to disable counter scaling for multiplexing"),
746 OPT_INCR('v', "verbose", &verbose,
747 "be more verbose (show counter open errors, etc)"),
748 OPT_INTEGER('r', "repeat", &stat_config.run_count,
749 "repeat command and print average + stddev (max: 100, forever: 0)"),
750 OPT_BOOLEAN(0, "table", &stat_config.walltime_run_table,
751 "display details about each run (only with -r option)"),
752 OPT_BOOLEAN('n', "null", &stat_config.null_run,
753 "null run - dont start any counters"),
754 OPT_INCR('d', "detailed", &detailed_run,
755 "detailed run - start a lot of events"),
756 OPT_BOOLEAN('S', "sync", &sync_run,
757 "call sync() before starting a run"),
758 OPT_CALLBACK_NOOPT('B', "big-num", NULL, NULL,
759 "print large numbers with thousands\' separators",
760 stat__set_big_num),
761 OPT_STRING('C', "cpu", &target.cpu_list, "cpu",
762 "list of cpus to monitor in system-wide"),
763 OPT_SET_UINT('A', "no-aggr", &stat_config.aggr_mode,
764 "disable CPU count aggregation", AGGR_NONE),
765 OPT_BOOLEAN(0, "no-merge", &stat_config.no_merge, "Do not merge identical named events"),
766 OPT_STRING('x', "field-separator", &stat_config.csv_sep, "separator",
767 "print counts with custom separator"),
768 OPT_CALLBACK('G', "cgroup", &evsel_list, "name",
769 "monitor event in cgroup name only", parse_cgroups),
770 OPT_STRING('o', "output", &output_name, "file", "output file name"),
771 OPT_BOOLEAN(0, "append", &append_file, "append to the output file"),
772 OPT_INTEGER(0, "log-fd", &output_fd,
773 "log output to fd, instead of stderr"),
774 OPT_STRING(0, "pre", &pre_cmd, "command",
775 "command to run prior to the measured command"),
776 OPT_STRING(0, "post", &post_cmd, "command",
777 "command to run after to the measured command"),
778 OPT_UINTEGER('I', "interval-print", &stat_config.interval,
779 "print counts at regular interval in ms "
780 "(overhead is possible for values <= 100ms)"),
781 OPT_INTEGER(0, "interval-count", &stat_config.times,
782 "print counts for fixed number of times"),
783 OPT_BOOLEAN(0, "interval-clear", &stat_config.interval_clear,
784 "clear screen in between new interval"),
785 OPT_UINTEGER(0, "timeout", &stat_config.timeout,
786 "stop workload and print counts after a timeout period in ms (>= 10ms)"),
787 OPT_SET_UINT(0, "per-socket", &stat_config.aggr_mode,
788 "aggregate counts per processor socket", AGGR_SOCKET),
789 OPT_SET_UINT(0, "per-die", &stat_config.aggr_mode,
790 "aggregate counts per processor die", AGGR_DIE),
791 OPT_SET_UINT(0, "per-core", &stat_config.aggr_mode,
792 "aggregate counts per physical processor core", AGGR_CORE),
793 OPT_SET_UINT(0, "per-thread", &stat_config.aggr_mode,
794 "aggregate counts per thread", AGGR_THREAD),
795 OPT_UINTEGER('D', "delay", &stat_config.initial_delay,
796 "ms to wait before starting measurement after program start"),
797 OPT_CALLBACK_NOOPT(0, "metric-only", &stat_config.metric_only, NULL,
798 "Only print computed metrics. No raw values", enable_metric_only),
799 OPT_BOOLEAN(0, "topdown", &topdown_run,
800 "measure topdown level 1 statistics"),
801 OPT_BOOLEAN(0, "smi-cost", &smi_cost,
802 "measure SMI cost"),
803 OPT_CALLBACK('M', "metrics", &evsel_list, "metric/metric group list",
804 "monitor specified metrics or metric groups (separated by ,)",
805 parse_metric_groups),
806 OPT_END()
807};
808
809static int perf_stat__get_socket(struct perf_stat_config *config __maybe_unused,
810 struct perf_cpu_map *map, int cpu)
811{
812 return cpu_map__get_socket(map, cpu, NULL);
813}
814
815static int perf_stat__get_die(struct perf_stat_config *config __maybe_unused,
816 struct perf_cpu_map *map, int cpu)
817{
818 return cpu_map__get_die(map, cpu, NULL);
819}
820
821static int perf_stat__get_core(struct perf_stat_config *config __maybe_unused,
822 struct perf_cpu_map *map, int cpu)
823{
824 return cpu_map__get_core(map, cpu, NULL);
825}
826
827static int perf_stat__get_aggr(struct perf_stat_config *config,
828 aggr_get_id_t get_id, struct perf_cpu_map *map, int idx)
829{
830 int cpu;
831
832 if (idx >= map->nr)
833 return -1;
834
835 cpu = map->map[idx];
836
837 if (config->cpus_aggr_map->map[cpu] == -1)
838 config->cpus_aggr_map->map[cpu] = get_id(config, map, idx);
839
840 return config->cpus_aggr_map->map[cpu];
841}
842
843static int perf_stat__get_socket_cached(struct perf_stat_config *config,
844 struct perf_cpu_map *map, int idx)
845{
846 return perf_stat__get_aggr(config, perf_stat__get_socket, map, idx);
847}
848
849static int perf_stat__get_die_cached(struct perf_stat_config *config,
850 struct perf_cpu_map *map, int idx)
851{
852 return perf_stat__get_aggr(config, perf_stat__get_die, map, idx);
853}
854
855static int perf_stat__get_core_cached(struct perf_stat_config *config,
856 struct perf_cpu_map *map, int idx)
857{
858 return perf_stat__get_aggr(config, perf_stat__get_core, map, idx);
859}
860
861static bool term_percore_set(void)
862{
863 struct evsel *counter;
864
865 evlist__for_each_entry(evsel_list, counter) {
866 if (counter->percore)
867 return true;
868 }
869
870 return false;
871}
872
873static int perf_stat_init_aggr_mode(void)
874{
875 int nr;
876
877 switch (stat_config.aggr_mode) {
878 case AGGR_SOCKET:
879 if (cpu_map__build_socket_map(evsel_list->core.cpus, &stat_config.aggr_map)) {
880 perror("cannot build socket map");
881 return -1;
882 }
883 stat_config.aggr_get_id = perf_stat__get_socket_cached;
884 break;
885 case AGGR_DIE:
886 if (cpu_map__build_die_map(evsel_list->core.cpus, &stat_config.aggr_map)) {
887 perror("cannot build die map");
888 return -1;
889 }
890 stat_config.aggr_get_id = perf_stat__get_die_cached;
891 break;
892 case AGGR_CORE:
893 if (cpu_map__build_core_map(evsel_list->core.cpus, &stat_config.aggr_map)) {
894 perror("cannot build core map");
895 return -1;
896 }
897 stat_config.aggr_get_id = perf_stat__get_core_cached;
898 break;
899 case AGGR_NONE:
900 if (term_percore_set()) {
901 if (cpu_map__build_core_map(evsel_list->core.cpus,
902 &stat_config.aggr_map)) {
903 perror("cannot build core map");
904 return -1;
905 }
906 stat_config.aggr_get_id = perf_stat__get_core_cached;
907 }
908 break;
909 case AGGR_GLOBAL:
910 case AGGR_THREAD:
911 case AGGR_UNSET:
912 default:
913 break;
914 }
915
916 /*
917 * The evsel_list->cpus is the base we operate on,
918 * taking the highest cpu number to be the size of
919 * the aggregation translate cpumap.
920 */
921 nr = perf_cpu_map__max(evsel_list->core.cpus);
922 stat_config.cpus_aggr_map = perf_cpu_map__empty_new(nr + 1);
923 return stat_config.cpus_aggr_map ? 0 : -ENOMEM;
924}
925
926static void perf_stat__exit_aggr_mode(void)
927{
928 perf_cpu_map__put(stat_config.aggr_map);
929 perf_cpu_map__put(stat_config.cpus_aggr_map);
930 stat_config.aggr_map = NULL;
931 stat_config.cpus_aggr_map = NULL;
932}
933
934static inline int perf_env__get_cpu(struct perf_env *env, struct perf_cpu_map *map, int idx)
935{
936 int cpu;
937
938 if (idx > map->nr)
939 return -1;
940
941 cpu = map->map[idx];
942
943 if (cpu >= env->nr_cpus_avail)
944 return -1;
945
946 return cpu;
947}
948
949static int perf_env__get_socket(struct perf_cpu_map *map, int idx, void *data)
950{
951 struct perf_env *env = data;
952 int cpu = perf_env__get_cpu(env, map, idx);
953
954 return cpu == -1 ? -1 : env->cpu[cpu].socket_id;
955}
956
957static int perf_env__get_die(struct perf_cpu_map *map, int idx, void *data)
958{
959 struct perf_env *env = data;
960 int die_id = -1, cpu = perf_env__get_cpu(env, map, idx);
961
962 if (cpu != -1) {
963 /*
964 * Encode socket in bit range 15:8
965 * die_id is relative to socket,
966 * we need a global id. So we combine
967 * socket + die id
968 */
969 if (WARN_ONCE(env->cpu[cpu].socket_id >> 8, "The socket id number is too big.\n"))
970 return -1;
971
972 if (WARN_ONCE(env->cpu[cpu].die_id >> 8, "The die id number is too big.\n"))
973 return -1;
974
975 die_id = (env->cpu[cpu].socket_id << 8) | (env->cpu[cpu].die_id & 0xff);
976 }
977
978 return die_id;
979}
980
981static int perf_env__get_core(struct perf_cpu_map *map, int idx, void *data)
982{
983 struct perf_env *env = data;
984 int core = -1, cpu = perf_env__get_cpu(env, map, idx);
985
986 if (cpu != -1) {
987 /*
988 * Encode socket in bit range 31:24
989 * encode die id in bit range 23:16
990 * core_id is relative to socket and die,
991 * we need a global id. So we combine
992 * socket + die id + core id
993 */
994 if (WARN_ONCE(env->cpu[cpu].socket_id >> 8, "The socket id number is too big.\n"))
995 return -1;
996
997 if (WARN_ONCE(env->cpu[cpu].die_id >> 8, "The die id number is too big.\n"))
998 return -1;
999
1000 if (WARN_ONCE(env->cpu[cpu].core_id >> 16, "The core id number is too big.\n"))
1001 return -1;
1002
1003 core = (env->cpu[cpu].socket_id << 24) |
1004 (env->cpu[cpu].die_id << 16) |
1005 (env->cpu[cpu].core_id & 0xffff);
1006 }
1007
1008 return core;
1009}
1010
1011static int perf_env__build_socket_map(struct perf_env *env, struct perf_cpu_map *cpus,
1012 struct perf_cpu_map **sockp)
1013{
1014 return cpu_map__build_map(cpus, sockp, perf_env__get_socket, env);
1015}
1016
1017static int perf_env__build_die_map(struct perf_env *env, struct perf_cpu_map *cpus,
1018 struct perf_cpu_map **diep)
1019{
1020 return cpu_map__build_map(cpus, diep, perf_env__get_die, env);
1021}
1022
1023static int perf_env__build_core_map(struct perf_env *env, struct perf_cpu_map *cpus,
1024 struct perf_cpu_map **corep)
1025{
1026 return cpu_map__build_map(cpus, corep, perf_env__get_core, env);
1027}
1028
1029static int perf_stat__get_socket_file(struct perf_stat_config *config __maybe_unused,
1030 struct perf_cpu_map *map, int idx)
1031{
1032 return perf_env__get_socket(map, idx, &perf_stat.session->header.env);
1033}
1034static int perf_stat__get_die_file(struct perf_stat_config *config __maybe_unused,
1035 struct perf_cpu_map *map, int idx)
1036{
1037 return perf_env__get_die(map, idx, &perf_stat.session->header.env);
1038}
1039
1040static int perf_stat__get_core_file(struct perf_stat_config *config __maybe_unused,
1041 struct perf_cpu_map *map, int idx)
1042{
1043 return perf_env__get_core(map, idx, &perf_stat.session->header.env);
1044}
1045
1046static int perf_stat_init_aggr_mode_file(struct perf_stat *st)
1047{
1048 struct perf_env *env = &st->session->header.env;
1049
1050 switch (stat_config.aggr_mode) {
1051 case AGGR_SOCKET:
1052 if (perf_env__build_socket_map(env, evsel_list->core.cpus, &stat_config.aggr_map)) {
1053 perror("cannot build socket map");
1054 return -1;
1055 }
1056 stat_config.aggr_get_id = perf_stat__get_socket_file;
1057 break;
1058 case AGGR_DIE:
1059 if (perf_env__build_die_map(env, evsel_list->core.cpus, &stat_config.aggr_map)) {
1060 perror("cannot build die map");
1061 return -1;
1062 }
1063 stat_config.aggr_get_id = perf_stat__get_die_file;
1064 break;
1065 case AGGR_CORE:
1066 if (perf_env__build_core_map(env, evsel_list->core.cpus, &stat_config.aggr_map)) {
1067 perror("cannot build core map");
1068 return -1;
1069 }
1070 stat_config.aggr_get_id = perf_stat__get_core_file;
1071 break;
1072 case AGGR_NONE:
1073 case AGGR_GLOBAL:
1074 case AGGR_THREAD:
1075 case AGGR_UNSET:
1076 default:
1077 break;
1078 }
1079
1080 return 0;
1081}
1082
1083static int topdown_filter_events(const char **attr, char **str, bool use_group)
1084{
1085 int off = 0;
1086 int i;
1087 int len = 0;
1088 char *s;
1089
1090 for (i = 0; attr[i]; i++) {
1091 if (pmu_have_event("cpu", attr[i])) {
1092 len += strlen(attr[i]) + 1;
1093 attr[i - off] = attr[i];
1094 } else
1095 off++;
1096 }
1097 attr[i - off] = NULL;
1098
1099 *str = malloc(len + 1 + 2);
1100 if (!*str)
1101 return -1;
1102 s = *str;
1103 if (i - off == 0) {
1104 *s = 0;
1105 return 0;
1106 }
1107 if (use_group)
1108 *s++ = '{';
1109 for (i = 0; attr[i]; i++) {
1110 strcpy(s, attr[i]);
1111 s += strlen(s);
1112 *s++ = ',';
1113 }
1114 if (use_group) {
1115 s[-1] = '}';
1116 *s = 0;
1117 } else
1118 s[-1] = 0;
1119 return 0;
1120}
1121
1122__weak bool arch_topdown_check_group(bool *warn)
1123{
1124 *warn = false;
1125 return false;
1126}
1127
1128__weak void arch_topdown_group_warn(void)
1129{
1130}
1131
1132/*
1133 * Add default attributes, if there were no attributes specified or
1134 * if -d/--detailed, -d -d or -d -d -d is used:
1135 */
1136static int add_default_attributes(void)
1137{
1138 int err;
1139 struct perf_event_attr default_attrs0[] = {
1140
1141 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_TASK_CLOCK },
1142 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_CONTEXT_SWITCHES },
1143 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_CPU_MIGRATIONS },
1144 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_PAGE_FAULTS },
1145
1146 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_CPU_CYCLES },
1147};
1148 struct perf_event_attr frontend_attrs[] = {
1149 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_STALLED_CYCLES_FRONTEND },
1150};
1151 struct perf_event_attr backend_attrs[] = {
1152 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_STALLED_CYCLES_BACKEND },
1153};
1154 struct perf_event_attr default_attrs1[] = {
1155 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_INSTRUCTIONS },
1156 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_BRANCH_INSTRUCTIONS },
1157 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_BRANCH_MISSES },
1158
1159};
1160
1161/*
1162 * Detailed stats (-d), covering the L1 and last level data caches:
1163 */
1164 struct perf_event_attr detailed_attrs[] = {
1165
1166 { .type = PERF_TYPE_HW_CACHE,
1167 .config =
1168 PERF_COUNT_HW_CACHE_L1D << 0 |
1169 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1170 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1171
1172 { .type = PERF_TYPE_HW_CACHE,
1173 .config =
1174 PERF_COUNT_HW_CACHE_L1D << 0 |
1175 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1176 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1177
1178 { .type = PERF_TYPE_HW_CACHE,
1179 .config =
1180 PERF_COUNT_HW_CACHE_LL << 0 |
1181 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1182 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1183
1184 { .type = PERF_TYPE_HW_CACHE,
1185 .config =
1186 PERF_COUNT_HW_CACHE_LL << 0 |
1187 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1188 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1189};
1190
1191/*
1192 * Very detailed stats (-d -d), covering the instruction cache and the TLB caches:
1193 */
1194 struct perf_event_attr very_detailed_attrs[] = {
1195
1196 { .type = PERF_TYPE_HW_CACHE,
1197 .config =
1198 PERF_COUNT_HW_CACHE_L1I << 0 |
1199 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1200 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1201
1202 { .type = PERF_TYPE_HW_CACHE,
1203 .config =
1204 PERF_COUNT_HW_CACHE_L1I << 0 |
1205 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1206 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1207
1208 { .type = PERF_TYPE_HW_CACHE,
1209 .config =
1210 PERF_COUNT_HW_CACHE_DTLB << 0 |
1211 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1212 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1213
1214 { .type = PERF_TYPE_HW_CACHE,
1215 .config =
1216 PERF_COUNT_HW_CACHE_DTLB << 0 |
1217 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1218 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1219
1220 { .type = PERF_TYPE_HW_CACHE,
1221 .config =
1222 PERF_COUNT_HW_CACHE_ITLB << 0 |
1223 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1224 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1225
1226 { .type = PERF_TYPE_HW_CACHE,
1227 .config =
1228 PERF_COUNT_HW_CACHE_ITLB << 0 |
1229 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1230 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1231
1232};
1233
1234/*
1235 * Very, very detailed stats (-d -d -d), adding prefetch events:
1236 */
1237 struct perf_event_attr very_very_detailed_attrs[] = {
1238
1239 { .type = PERF_TYPE_HW_CACHE,
1240 .config =
1241 PERF_COUNT_HW_CACHE_L1D << 0 |
1242 (PERF_COUNT_HW_CACHE_OP_PREFETCH << 8) |
1243 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1244
1245 { .type = PERF_TYPE_HW_CACHE,
1246 .config =
1247 PERF_COUNT_HW_CACHE_L1D << 0 |
1248 (PERF_COUNT_HW_CACHE_OP_PREFETCH << 8) |
1249 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1250};
1251 struct parse_events_error errinfo;
1252
1253 /* Set attrs if no event is selected and !null_run: */
1254 if (stat_config.null_run)
1255 return 0;
1256
1257 if (transaction_run) {
1258 /* Handle -T as -M transaction. Once platform specific metrics
1259 * support has been added to the json files, all archictures
1260 * will use this approach. To determine transaction support
1261 * on an architecture test for such a metric name.
1262 */
1263 if (metricgroup__has_metric("transaction")) {
1264 struct option opt = { .value = &evsel_list };
1265
1266 return metricgroup__parse_groups(&opt, "transaction",
1267 &stat_config.metric_events);
1268 }
1269
1270 if (pmu_have_event("cpu", "cycles-ct") &&
1271 pmu_have_event("cpu", "el-start"))
1272 err = parse_events(evsel_list, transaction_attrs,
1273 &errinfo);
1274 else
1275 err = parse_events(evsel_list,
1276 transaction_limited_attrs,
1277 &errinfo);
1278 if (err) {
1279 fprintf(stderr, "Cannot set up transaction events\n");
1280 parse_events_print_error(&errinfo, transaction_attrs);
1281 return -1;
1282 }
1283 return 0;
1284 }
1285
1286 if (smi_cost) {
1287 int smi;
1288
1289 if (sysfs__read_int(FREEZE_ON_SMI_PATH, &smi) < 0) {
1290 fprintf(stderr, "freeze_on_smi is not supported.\n");
1291 return -1;
1292 }
1293
1294 if (!smi) {
1295 if (sysfs__write_int(FREEZE_ON_SMI_PATH, 1) < 0) {
1296 fprintf(stderr, "Failed to set freeze_on_smi.\n");
1297 return -1;
1298 }
1299 smi_reset = true;
1300 }
1301
1302 if (pmu_have_event("msr", "aperf") &&
1303 pmu_have_event("msr", "smi")) {
1304 if (!force_metric_only)
1305 stat_config.metric_only = true;
1306 err = parse_events(evsel_list, smi_cost_attrs, &errinfo);
1307 } else {
1308 fprintf(stderr, "To measure SMI cost, it needs "
1309 "msr/aperf/, msr/smi/ and cpu/cycles/ support\n");
1310 parse_events_print_error(&errinfo, smi_cost_attrs);
1311 return -1;
1312 }
1313 if (err) {
1314 fprintf(stderr, "Cannot set up SMI cost events\n");
1315 return -1;
1316 }
1317 return 0;
1318 }
1319
1320 if (topdown_run) {
1321 char *str = NULL;
1322 bool warn = false;
1323
1324 if (stat_config.aggr_mode != AGGR_GLOBAL &&
1325 stat_config.aggr_mode != AGGR_CORE) {
1326 pr_err("top down event configuration requires --per-core mode\n");
1327 return -1;
1328 }
1329 stat_config.aggr_mode = AGGR_CORE;
1330 if (nr_cgroups || !target__has_cpu(&target)) {
1331 pr_err("top down event configuration requires system-wide mode (-a)\n");
1332 return -1;
1333 }
1334
1335 if (!force_metric_only)
1336 stat_config.metric_only = true;
1337 if (topdown_filter_events(topdown_attrs, &str,
1338 arch_topdown_check_group(&warn)) < 0) {
1339 pr_err("Out of memory\n");
1340 return -1;
1341 }
1342 if (topdown_attrs[0] && str) {
1343 if (warn)
1344 arch_topdown_group_warn();
1345 err = parse_events(evsel_list, str, &errinfo);
1346 if (err) {
1347 fprintf(stderr,
1348 "Cannot set up top down events %s: %d\n",
1349 str, err);
1350 parse_events_print_error(&errinfo, str);
1351 free(str);
1352 return -1;
1353 }
1354 } else {
1355 fprintf(stderr, "System does not support topdown\n");
1356 return -1;
1357 }
1358 free(str);
1359 }
1360
1361 if (!evsel_list->core.nr_entries) {
1362 if (target__has_cpu(&target))
1363 default_attrs0[0].config = PERF_COUNT_SW_CPU_CLOCK;
1364
1365 if (perf_evlist__add_default_attrs(evsel_list, default_attrs0) < 0)
1366 return -1;
1367 if (pmu_have_event("cpu", "stalled-cycles-frontend")) {
1368 if (perf_evlist__add_default_attrs(evsel_list,
1369 frontend_attrs) < 0)
1370 return -1;
1371 }
1372 if (pmu_have_event("cpu", "stalled-cycles-backend")) {
1373 if (perf_evlist__add_default_attrs(evsel_list,
1374 backend_attrs) < 0)
1375 return -1;
1376 }
1377 if (perf_evlist__add_default_attrs(evsel_list, default_attrs1) < 0)
1378 return -1;
1379 }
1380
1381 /* Detailed events get appended to the event list: */
1382
1383 if (detailed_run < 1)
1384 return 0;
1385
1386 /* Append detailed run extra attributes: */
1387 if (perf_evlist__add_default_attrs(evsel_list, detailed_attrs) < 0)
1388 return -1;
1389
1390 if (detailed_run < 2)
1391 return 0;
1392
1393 /* Append very detailed run extra attributes: */
1394 if (perf_evlist__add_default_attrs(evsel_list, very_detailed_attrs) < 0)
1395 return -1;
1396
1397 if (detailed_run < 3)
1398 return 0;
1399
1400 /* Append very, very detailed run extra attributes: */
1401 return perf_evlist__add_default_attrs(evsel_list, very_very_detailed_attrs);
1402}
1403
1404static const char * const stat_record_usage[] = {
1405 "perf stat record [<options>]",
1406 NULL,
1407};
1408
1409static void init_features(struct perf_session *session)
1410{
1411 int feat;
1412
1413 for (feat = HEADER_FIRST_FEATURE; feat < HEADER_LAST_FEATURE; feat++)
1414 perf_header__set_feat(&session->header, feat);
1415
1416 perf_header__clear_feat(&session->header, HEADER_DIR_FORMAT);
1417 perf_header__clear_feat(&session->header, HEADER_BUILD_ID);
1418 perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);
1419 perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
1420 perf_header__clear_feat(&session->header, HEADER_AUXTRACE);
1421}
1422
1423static int __cmd_record(int argc, const char **argv)
1424{
1425 struct perf_session *session;
1426 struct perf_data *data = &perf_stat.data;
1427
1428 argc = parse_options(argc, argv, stat_options, stat_record_usage,
1429 PARSE_OPT_STOP_AT_NON_OPTION);
1430
1431 if (output_name)
1432 data->path = output_name;
1433
1434 if (stat_config.run_count != 1 || forever) {
1435 pr_err("Cannot use -r option with perf stat record.\n");
1436 return -1;
1437 }
1438
1439 session = perf_session__new(data, false, NULL);
1440 if (IS_ERR(session)) {
1441 pr_err("Perf session creation failed\n");
1442 return PTR_ERR(session);
1443 }
1444
1445 init_features(session);
1446
1447 session->evlist = evsel_list;
1448 perf_stat.session = session;
1449 perf_stat.record = true;
1450 return argc;
1451}
1452
1453static int process_stat_round_event(struct perf_session *session,
1454 union perf_event *event)
1455{
1456 struct perf_record_stat_round *stat_round = &event->stat_round;
1457 struct evsel *counter;
1458 struct timespec tsh, *ts = NULL;
1459 const char **argv = session->header.env.cmdline_argv;
1460 int argc = session->header.env.nr_cmdline;
1461
1462 evlist__for_each_entry(evsel_list, counter)
1463 perf_stat_process_counter(&stat_config, counter);
1464
1465 if (stat_round->type == PERF_STAT_ROUND_TYPE__FINAL)
1466 update_stats(&walltime_nsecs_stats, stat_round->time);
1467
1468 if (stat_config.interval && stat_round->time) {
1469 tsh.tv_sec = stat_round->time / NSEC_PER_SEC;
1470 tsh.tv_nsec = stat_round->time % NSEC_PER_SEC;
1471 ts = &tsh;
1472 }
1473
1474 print_counters(ts, argc, argv);
1475 return 0;
1476}
1477
1478static
1479int process_stat_config_event(struct perf_session *session,
1480 union perf_event *event)
1481{
1482 struct perf_tool *tool = session->tool;
1483 struct perf_stat *st = container_of(tool, struct perf_stat, tool);
1484
1485 perf_event__read_stat_config(&stat_config, &event->stat_config);
1486
1487 if (perf_cpu_map__empty(st->cpus)) {
1488 if (st->aggr_mode != AGGR_UNSET)
1489 pr_warning("warning: processing task data, aggregation mode not set\n");
1490 return 0;
1491 }
1492
1493 if (st->aggr_mode != AGGR_UNSET)
1494 stat_config.aggr_mode = st->aggr_mode;
1495
1496 if (perf_stat.data.is_pipe)
1497 perf_stat_init_aggr_mode();
1498 else
1499 perf_stat_init_aggr_mode_file(st);
1500
1501 return 0;
1502}
1503
1504static int set_maps(struct perf_stat *st)
1505{
1506 if (!st->cpus || !st->threads)
1507 return 0;
1508
1509 if (WARN_ONCE(st->maps_allocated, "stats double allocation\n"))
1510 return -EINVAL;
1511
1512 perf_evlist__set_maps(&evsel_list->core, st->cpus, st->threads);
1513
1514 if (perf_evlist__alloc_stats(evsel_list, true))
1515 return -ENOMEM;
1516
1517 st->maps_allocated = true;
1518 return 0;
1519}
1520
1521static
1522int process_thread_map_event(struct perf_session *session,
1523 union perf_event *event)
1524{
1525 struct perf_tool *tool = session->tool;
1526 struct perf_stat *st = container_of(tool, struct perf_stat, tool);
1527
1528 if (st->threads) {
1529 pr_warning("Extra thread map event, ignoring.\n");
1530 return 0;
1531 }
1532
1533 st->threads = thread_map__new_event(&event->thread_map);
1534 if (!st->threads)
1535 return -ENOMEM;
1536
1537 return set_maps(st);
1538}
1539
1540static
1541int process_cpu_map_event(struct perf_session *session,
1542 union perf_event *event)
1543{
1544 struct perf_tool *tool = session->tool;
1545 struct perf_stat *st = container_of(tool, struct perf_stat, tool);
1546 struct perf_cpu_map *cpus;
1547
1548 if (st->cpus) {
1549 pr_warning("Extra cpu map event, ignoring.\n");
1550 return 0;
1551 }
1552
1553 cpus = cpu_map__new_data(&event->cpu_map.data);
1554 if (!cpus)
1555 return -ENOMEM;
1556
1557 st->cpus = cpus;
1558 return set_maps(st);
1559}
1560
1561static int runtime_stat_new(struct perf_stat_config *config, int nthreads)
1562{
1563 int i;
1564
1565 config->stats = calloc(nthreads, sizeof(struct runtime_stat));
1566 if (!config->stats)
1567 return -1;
1568
1569 config->stats_num = nthreads;
1570
1571 for (i = 0; i < nthreads; i++)
1572 runtime_stat__init(&config->stats[i]);
1573
1574 return 0;
1575}
1576
1577static void runtime_stat_delete(struct perf_stat_config *config)
1578{
1579 int i;
1580
1581 if (!config->stats)
1582 return;
1583
1584 for (i = 0; i < config->stats_num; i++)
1585 runtime_stat__exit(&config->stats[i]);
1586
1587 zfree(&config->stats);
1588}
1589
1590static const char * const stat_report_usage[] = {
1591 "perf stat report [<options>]",
1592 NULL,
1593};
1594
1595static struct perf_stat perf_stat = {
1596 .tool = {
1597 .attr = perf_event__process_attr,
1598 .event_update = perf_event__process_event_update,
1599 .thread_map = process_thread_map_event,
1600 .cpu_map = process_cpu_map_event,
1601 .stat_config = process_stat_config_event,
1602 .stat = perf_event__process_stat_event,
1603 .stat_round = process_stat_round_event,
1604 },
1605 .aggr_mode = AGGR_UNSET,
1606};
1607
1608static int __cmd_report(int argc, const char **argv)
1609{
1610 struct perf_session *session;
1611 const struct option options[] = {
1612 OPT_STRING('i', "input", &input_name, "file", "input file name"),
1613 OPT_SET_UINT(0, "per-socket", &perf_stat.aggr_mode,
1614 "aggregate counts per processor socket", AGGR_SOCKET),
1615 OPT_SET_UINT(0, "per-die", &perf_stat.aggr_mode,
1616 "aggregate counts per processor die", AGGR_DIE),
1617 OPT_SET_UINT(0, "per-core", &perf_stat.aggr_mode,
1618 "aggregate counts per physical processor core", AGGR_CORE),
1619 OPT_SET_UINT('A', "no-aggr", &perf_stat.aggr_mode,
1620 "disable CPU count aggregation", AGGR_NONE),
1621 OPT_END()
1622 };
1623 struct stat st;
1624 int ret;
1625
1626 argc = parse_options(argc, argv, options, stat_report_usage, 0);
1627
1628 if (!input_name || !strlen(input_name)) {
1629 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
1630 input_name = "-";
1631 else
1632 input_name = "perf.data";
1633 }
1634
1635 perf_stat.data.path = input_name;
1636 perf_stat.data.mode = PERF_DATA_MODE_READ;
1637
1638 session = perf_session__new(&perf_stat.data, false, &perf_stat.tool);
1639 if (IS_ERR(session))
1640 return PTR_ERR(session);
1641
1642 perf_stat.session = session;
1643 stat_config.output = stderr;
1644 evsel_list = session->evlist;
1645
1646 ret = perf_session__process_events(session);
1647 if (ret)
1648 return ret;
1649
1650 perf_session__delete(session);
1651 return 0;
1652}
1653
1654static void setup_system_wide(int forks)
1655{
1656 /*
1657 * Make system wide (-a) the default target if
1658 * no target was specified and one of following
1659 * conditions is met:
1660 *
1661 * - there's no workload specified
1662 * - there is workload specified but all requested
1663 * events are system wide events
1664 */
1665 if (!target__none(&target))
1666 return;
1667
1668 if (!forks)
1669 target.system_wide = true;
1670 else {
1671 struct evsel *counter;
1672
1673 evlist__for_each_entry(evsel_list, counter) {
1674 if (!counter->core.system_wide)
1675 return;
1676 }
1677
1678 if (evsel_list->core.nr_entries)
1679 target.system_wide = true;
1680 }
1681}
1682
1683int cmd_stat(int argc, const char **argv)
1684{
1685 const char * const stat_usage[] = {
1686 "perf stat [<options>] [<command>]",
1687 NULL
1688 };
1689 int status = -EINVAL, run_idx;
1690 const char *mode;
1691 FILE *output = stderr;
1692 unsigned int interval, timeout;
1693 const char * const stat_subcommands[] = { "record", "report" };
1694
1695 setlocale(LC_ALL, "");
1696
1697 evsel_list = evlist__new();
1698 if (evsel_list == NULL)
1699 return -ENOMEM;
1700
1701 parse_events__shrink_config_terms();
1702
1703 /* String-parsing callback-based options would segfault when negated */
1704 set_option_flag(stat_options, 'e', "event", PARSE_OPT_NONEG);
1705 set_option_flag(stat_options, 'M', "metrics", PARSE_OPT_NONEG);
1706 set_option_flag(stat_options, 'G', "cgroup", PARSE_OPT_NONEG);
1707
1708 argc = parse_options_subcommand(argc, argv, stat_options, stat_subcommands,
1709 (const char **) stat_usage,
1710 PARSE_OPT_STOP_AT_NON_OPTION);
1711 perf_stat__collect_metric_expr(evsel_list);
1712 perf_stat__init_shadow_stats();
1713
1714 if (stat_config.csv_sep) {
1715 stat_config.csv_output = true;
1716 if (!strcmp(stat_config.csv_sep, "\\t"))
1717 stat_config.csv_sep = "\t";
1718 } else
1719 stat_config.csv_sep = DEFAULT_SEPARATOR;
1720
1721 if (argc && !strncmp(argv[0], "rec", 3)) {
1722 argc = __cmd_record(argc, argv);
1723 if (argc < 0)
1724 return -1;
1725 } else if (argc && !strncmp(argv[0], "rep", 3))
1726 return __cmd_report(argc, argv);
1727
1728 interval = stat_config.interval;
1729 timeout = stat_config.timeout;
1730
1731 /*
1732 * For record command the -o is already taken care of.
1733 */
1734 if (!STAT_RECORD && output_name && strcmp(output_name, "-"))
1735 output = NULL;
1736
1737 if (output_name && output_fd) {
1738 fprintf(stderr, "cannot use both --output and --log-fd\n");
1739 parse_options_usage(stat_usage, stat_options, "o", 1);
1740 parse_options_usage(NULL, stat_options, "log-fd", 0);
1741 goto out;
1742 }
1743
1744 if (stat_config.metric_only && stat_config.aggr_mode == AGGR_THREAD) {
1745 fprintf(stderr, "--metric-only is not supported with --per-thread\n");
1746 goto out;
1747 }
1748
1749 if (stat_config.metric_only && stat_config.run_count > 1) {
1750 fprintf(stderr, "--metric-only is not supported with -r\n");
1751 goto out;
1752 }
1753
1754 if (stat_config.walltime_run_table && stat_config.run_count <= 1) {
1755 fprintf(stderr, "--table is only supported with -r\n");
1756 parse_options_usage(stat_usage, stat_options, "r", 1);
1757 parse_options_usage(NULL, stat_options, "table", 0);
1758 goto out;
1759 }
1760
1761 if (output_fd < 0) {
1762 fprintf(stderr, "argument to --log-fd must be a > 0\n");
1763 parse_options_usage(stat_usage, stat_options, "log-fd", 0);
1764 goto out;
1765 }
1766
1767 if (!output) {
1768 struct timespec tm;
1769 mode = append_file ? "a" : "w";
1770
1771 output = fopen(output_name, mode);
1772 if (!output) {
1773 perror("failed to create output file");
1774 return -1;
1775 }
1776 clock_gettime(CLOCK_REALTIME, &tm);
1777 fprintf(output, "# started on %s\n", ctime(&tm.tv_sec));
1778 } else if (output_fd > 0) {
1779 mode = append_file ? "a" : "w";
1780 output = fdopen(output_fd, mode);
1781 if (!output) {
1782 perror("Failed opening logfd");
1783 return -errno;
1784 }
1785 }
1786
1787 stat_config.output = output;
1788
1789 /*
1790 * let the spreadsheet do the pretty-printing
1791 */
1792 if (stat_config.csv_output) {
1793 /* User explicitly passed -B? */
1794 if (big_num_opt == 1) {
1795 fprintf(stderr, "-B option not supported with -x\n");
1796 parse_options_usage(stat_usage, stat_options, "B", 1);
1797 parse_options_usage(NULL, stat_options, "x", 1);
1798 goto out;
1799 } else /* Nope, so disable big number formatting */
1800 stat_config.big_num = false;
1801 } else if (big_num_opt == 0) /* User passed --no-big-num */
1802 stat_config.big_num = false;
1803
1804 setup_system_wide(argc);
1805
1806 /*
1807 * Display user/system times only for single
1808 * run and when there's specified tracee.
1809 */
1810 if ((stat_config.run_count == 1) && target__none(&target))
1811 stat_config.ru_display = true;
1812
1813 if (stat_config.run_count < 0) {
1814 pr_err("Run count must be a positive number\n");
1815 parse_options_usage(stat_usage, stat_options, "r", 1);
1816 goto out;
1817 } else if (stat_config.run_count == 0) {
1818 forever = true;
1819 stat_config.run_count = 1;
1820 }
1821
1822 if (stat_config.walltime_run_table) {
1823 stat_config.walltime_run = zalloc(stat_config.run_count * sizeof(stat_config.walltime_run[0]));
1824 if (!stat_config.walltime_run) {
1825 pr_err("failed to setup -r option");
1826 goto out;
1827 }
1828 }
1829
1830 if ((stat_config.aggr_mode == AGGR_THREAD) &&
1831 !target__has_task(&target)) {
1832 if (!target.system_wide || target.cpu_list) {
1833 fprintf(stderr, "The --per-thread option is only "
1834 "available when monitoring via -p -t -a "
1835 "options or only --per-thread.\n");
1836 parse_options_usage(NULL, stat_options, "p", 1);
1837 parse_options_usage(NULL, stat_options, "t", 1);
1838 goto out;
1839 }
1840 }
1841
1842 /*
1843 * no_aggr, cgroup are for system-wide only
1844 * --per-thread is aggregated per thread, we dont mix it with cpu mode
1845 */
1846 if (((stat_config.aggr_mode != AGGR_GLOBAL &&
1847 stat_config.aggr_mode != AGGR_THREAD) || nr_cgroups) &&
1848 !target__has_cpu(&target)) {
1849 fprintf(stderr, "both cgroup and no-aggregation "
1850 "modes only available in system-wide mode\n");
1851
1852 parse_options_usage(stat_usage, stat_options, "G", 1);
1853 parse_options_usage(NULL, stat_options, "A", 1);
1854 parse_options_usage(NULL, stat_options, "a", 1);
1855 goto out;
1856 }
1857
1858 if (add_default_attributes())
1859 goto out;
1860
1861 target__validate(&target);
1862
1863 if ((stat_config.aggr_mode == AGGR_THREAD) && (target.system_wide))
1864 target.per_thread = true;
1865
1866 if (perf_evlist__create_maps(evsel_list, &target) < 0) {
1867 if (target__has_task(&target)) {
1868 pr_err("Problems finding threads of monitor\n");
1869 parse_options_usage(stat_usage, stat_options, "p", 1);
1870 parse_options_usage(NULL, stat_options, "t", 1);
1871 } else if (target__has_cpu(&target)) {
1872 perror("failed to parse CPUs map");
1873 parse_options_usage(stat_usage, stat_options, "C", 1);
1874 parse_options_usage(NULL, stat_options, "a", 1);
1875 }
1876 goto out;
1877 }
1878
1879 /*
1880 * Initialize thread_map with comm names,
1881 * so we could print it out on output.
1882 */
1883 if (stat_config.aggr_mode == AGGR_THREAD) {
1884 thread_map__read_comms(evsel_list->core.threads);
1885 if (target.system_wide) {
1886 if (runtime_stat_new(&stat_config,
1887 perf_thread_map__nr(evsel_list->core.threads))) {
1888 goto out;
1889 }
1890 }
1891 }
1892
1893 if (stat_config.times && interval)
1894 interval_count = true;
1895 else if (stat_config.times && !interval) {
1896 pr_err("interval-count option should be used together with "
1897 "interval-print.\n");
1898 parse_options_usage(stat_usage, stat_options, "interval-count", 0);
1899 parse_options_usage(stat_usage, stat_options, "I", 1);
1900 goto out;
1901 }
1902
1903 if (timeout && timeout < 100) {
1904 if (timeout < 10) {
1905 pr_err("timeout must be >= 10ms.\n");
1906 parse_options_usage(stat_usage, stat_options, "timeout", 0);
1907 goto out;
1908 } else
1909 pr_warning("timeout < 100ms. "
1910 "The overhead percentage could be high in some cases. "
1911 "Please proceed with caution.\n");
1912 }
1913 if (timeout && interval) {
1914 pr_err("timeout option is not supported with interval-print.\n");
1915 parse_options_usage(stat_usage, stat_options, "timeout", 0);
1916 parse_options_usage(stat_usage, stat_options, "I", 1);
1917 goto out;
1918 }
1919
1920 if (perf_evlist__alloc_stats(evsel_list, interval))
1921 goto out;
1922
1923 if (perf_stat_init_aggr_mode())
1924 goto out;
1925
1926 /*
1927 * Set sample_type to PERF_SAMPLE_IDENTIFIER, which should be harmless
1928 * while avoiding that older tools show confusing messages.
1929 *
1930 * However for pipe sessions we need to keep it zero,
1931 * because script's perf_evsel__check_attr is triggered
1932 * by attr->sample_type != 0, and we can't run it on
1933 * stat sessions.
1934 */
1935 stat_config.identifier = !(STAT_RECORD && perf_stat.data.is_pipe);
1936
1937 /*
1938 * We dont want to block the signals - that would cause
1939 * child tasks to inherit that and Ctrl-C would not work.
1940 * What we want is for Ctrl-C to work in the exec()-ed
1941 * task, but being ignored by perf stat itself:
1942 */
1943 atexit(sig_atexit);
1944 if (!forever)
1945 signal(SIGINT, skip_signal);
1946 signal(SIGCHLD, skip_signal);
1947 signal(SIGALRM, skip_signal);
1948 signal(SIGABRT, skip_signal);
1949
1950 status = 0;
1951 for (run_idx = 0; forever || run_idx < stat_config.run_count; run_idx++) {
1952 if (stat_config.run_count != 1 && verbose > 0)
1953 fprintf(output, "[ perf stat: executing run #%d ... ]\n",
1954 run_idx + 1);
1955
1956 if (run_idx != 0)
1957 perf_evlist__reset_prev_raw_counts(evsel_list);
1958
1959 status = run_perf_stat(argc, argv, run_idx);
1960 if (forever && status != -1 && !interval) {
1961 print_counters(NULL, argc, argv);
1962 perf_stat__reset_stats();
1963 }
1964 }
1965
1966 if (!forever && status != -1 && !interval)
1967 print_counters(NULL, argc, argv);
1968
1969 if (STAT_RECORD) {
1970 /*
1971 * We synthesize the kernel mmap record just so that older tools
1972 * don't emit warnings about not being able to resolve symbols
1973 * due to /proc/sys/kernel/kptr_restrict settings and instear provide
1974 * a saner message about no samples being in the perf.data file.
1975 *
1976 * This also serves to suppress a warning about f_header.data.size == 0
1977 * in header.c at the moment 'perf stat record' gets introduced, which
1978 * is not really needed once we start adding the stat specific PERF_RECORD_
1979 * records, but the need to suppress the kptr_restrict messages in older
1980 * tools remain -acme
1981 */
1982 int fd = perf_data__fd(&perf_stat.data);
1983 int err = perf_event__synthesize_kernel_mmap((void *)&perf_stat,
1984 process_synthesized_event,
1985 &perf_stat.session->machines.host);
1986 if (err) {
1987 pr_warning("Couldn't synthesize the kernel mmap record, harmless, "
1988 "older tools may produce warnings about this file\n.");
1989 }
1990
1991 if (!interval) {
1992 if (WRITE_STAT_ROUND_EVENT(walltime_nsecs_stats.max, FINAL))
1993 pr_err("failed to write stat round event\n");
1994 }
1995
1996 if (!perf_stat.data.is_pipe) {
1997 perf_stat.session->header.data_size += perf_stat.bytes_written;
1998 perf_session__write_header(perf_stat.session, evsel_list, fd, true);
1999 }
2000
2001 evlist__close(evsel_list);
2002 perf_session__delete(perf_stat.session);
2003 }
2004
2005 perf_stat__exit_aggr_mode();
2006 perf_evlist__free_stats(evsel_list);
2007out:
2008 zfree(&stat_config.walltime_run);
2009
2010 if (smi_cost && smi_reset)
2011 sysfs__write_int(FREEZE_ON_SMI_PATH, 0);
2012
2013 evlist__delete(evsel_list);
2014
2015 runtime_stat_delete(&stat_config);
2016
2017 return status;
2018}
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}