1 // SPDX-License-Identifier: GPL-2.0-only
5 * Builtin stat command: Give a precise performance counters summary
6 * overview about any workload, CPU or specific PID.
10 $ perf stat ./hackbench 10
14 Performance counter stats for './hackbench 10':
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
28 0.154822978 seconds time elapsed
31 * Copyright (C) 2008-2011, Red Hat Inc, Ingo Molnar <mingo@redhat.com>
33 * Improvements and fixes by:
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>
44 #include "util/cgroup.h"
45 #include <subcmd/parse-options.h>
46 #include "util/parse-events.h"
47 #include "util/pmus.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/topdown.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"
68 #include "util/affinity.h"
70 #include "util/bpf_counter.h"
71 #include "util/iostat.h"
72 #include "util/util.h"
75 #include <linux/time64.h>
76 #include <linux/zalloc.h>
77 #include <api/fs/fs.h>
81 #include <sys/prctl.h>
85 #include <sys/types.h>
90 #include <sys/resource.h>
91 #include <linux/err.h>
93 #include <linux/ctype.h>
94 #include <perf/evlist.h>
95 #include <internal/threadmap.h>
97 #define DEFAULT_SEPARATOR " "
98 #define FREEZE_ON_SMI_PATH "devices/cpu/freeze_on_smi"
100 static void print_counters(struct timespec *ts, int argc, const char **argv);
102 static struct evlist *evsel_list;
103 static struct parse_events_option_args parse_events_option_args = {
104 .evlistp = &evsel_list,
107 static bool all_counters_use_bpf = true;
109 static struct target target = {
113 #define METRIC_ONLY_LEN 20
115 static volatile sig_atomic_t child_pid = -1;
116 static int detailed_run = 0;
117 static bool transaction_run;
118 static bool topdown_run = false;
119 static bool smi_cost = false;
120 static bool smi_reset = false;
121 static int big_num_opt = -1;
122 static const char *pre_cmd = NULL;
123 static const char *post_cmd = NULL;
124 static bool sync_run = false;
125 static bool forever = false;
126 static bool force_metric_only = false;
127 static struct timespec ref_time;
128 static bool append_file;
129 static bool interval_count;
130 static const char *output_name;
131 static int output_fd;
132 static char *metrics;
136 struct perf_data data;
137 struct perf_session *session;
139 struct perf_tool tool;
141 struct perf_cpu_map *cpus;
142 struct perf_thread_map *threads;
143 enum aggr_mode aggr_mode;
147 static struct perf_stat perf_stat;
148 #define STAT_RECORD perf_stat.record
150 static volatile sig_atomic_t done = 0;
152 static struct perf_stat_config stat_config = {
153 .aggr_mode = AGGR_GLOBAL,
154 .aggr_level = MAX_CACHE_LVL + 1,
156 .unit_width = 4, /* strlen("unit") */
158 .metric_only_len = METRIC_ONLY_LEN,
159 .walltime_nsecs_stats = &walltime_nsecs_stats,
160 .ru_stats = &ru_stats,
167 static bool cpus_map_matched(struct evsel *a, struct evsel *b)
169 if (!a->core.cpus && !b->core.cpus)
172 if (!a->core.cpus || !b->core.cpus)
175 if (perf_cpu_map__nr(a->core.cpus) != perf_cpu_map__nr(b->core.cpus))
178 for (int i = 0; i < perf_cpu_map__nr(a->core.cpus); i++) {
179 if (perf_cpu_map__cpu(a->core.cpus, i).cpu !=
180 perf_cpu_map__cpu(b->core.cpus, i).cpu)
187 static void evlist__check_cpu_maps(struct evlist *evlist)
189 struct evsel *evsel, *warned_leader = NULL;
191 evlist__for_each_entry(evlist, evsel) {
192 struct evsel *leader = evsel__leader(evsel);
194 /* Check that leader matches cpus with each member. */
197 if (cpus_map_matched(leader, evsel))
200 /* If there's mismatch disable the group and warn user. */
201 if (warned_leader != leader) {
204 pr_warning("WARNING: grouped events cpus do not match.\n"
205 "Events with CPUs not matching the leader will "
206 "be removed from the group.\n");
207 evsel__group_desc(leader, buf, sizeof(buf));
208 pr_warning(" %s\n", buf);
209 warned_leader = leader;
214 cpu_map__snprint(leader->core.cpus, buf, sizeof(buf));
215 pr_warning(" %s: %s\n", leader->name, buf);
216 cpu_map__snprint(evsel->core.cpus, buf, sizeof(buf));
217 pr_warning(" %s: %s\n", evsel->name, buf);
220 evsel__remove_from_group(evsel, leader);
224 static inline void diff_timespec(struct timespec *r, struct timespec *a,
227 r->tv_sec = a->tv_sec - b->tv_sec;
228 if (a->tv_nsec < b->tv_nsec) {
229 r->tv_nsec = a->tv_nsec + NSEC_PER_SEC - b->tv_nsec;
232 r->tv_nsec = a->tv_nsec - b->tv_nsec ;
236 static void perf_stat__reset_stats(void)
238 evlist__reset_stats(evsel_list);
239 perf_stat__reset_shadow_stats();
242 static int process_synthesized_event(struct perf_tool *tool __maybe_unused,
243 union perf_event *event,
244 struct perf_sample *sample __maybe_unused,
245 struct machine *machine __maybe_unused)
247 if (perf_data__write(&perf_stat.data, event, event->header.size) < 0) {
248 pr_err("failed to write perf data, error: %m\n");
252 perf_stat.bytes_written += event->header.size;
256 static int write_stat_round_event(u64 tm, u64 type)
258 return perf_event__synthesize_stat_round(NULL, tm, type,
259 process_synthesized_event,
263 #define WRITE_STAT_ROUND_EVENT(time, interval) \
264 write_stat_round_event(time, PERF_STAT_ROUND_TYPE__ ## interval)
266 #define SID(e, x, y) xyarray__entry(e->core.sample_id, x, y)
268 static int evsel__write_stat_event(struct evsel *counter, int cpu_map_idx, u32 thread,
269 struct perf_counts_values *count)
271 struct perf_sample_id *sid = SID(counter, cpu_map_idx, thread);
272 struct perf_cpu cpu = perf_cpu_map__cpu(evsel__cpus(counter), cpu_map_idx);
274 return perf_event__synthesize_stat(NULL, cpu, thread, sid->id, count,
275 process_synthesized_event, NULL);
278 static int read_single_counter(struct evsel *counter, int cpu_map_idx,
279 int thread, struct timespec *rs)
281 switch(counter->tool_event) {
282 case PERF_TOOL_DURATION_TIME: {
283 u64 val = rs->tv_nsec + rs->tv_sec*1000000000ULL;
284 struct perf_counts_values *count =
285 perf_counts(counter->counts, cpu_map_idx, thread);
286 count->ena = count->run = val;
290 case PERF_TOOL_USER_TIME:
291 case PERF_TOOL_SYSTEM_TIME: {
293 struct perf_counts_values *count =
294 perf_counts(counter->counts, cpu_map_idx, thread);
295 if (counter->tool_event == PERF_TOOL_USER_TIME)
296 val = ru_stats.ru_utime_usec_stat.mean;
298 val = ru_stats.ru_stime_usec_stat.mean;
299 count->ena = count->run = val;
305 return evsel__read_counter(counter, cpu_map_idx, thread);
307 /* This should never be reached */
313 * Read out the results of a single counter:
314 * do not aggregate counts across CPUs in system-wide mode
316 static int read_counter_cpu(struct evsel *counter, struct timespec *rs, int cpu_map_idx)
318 int nthreads = perf_thread_map__nr(evsel_list->core.threads);
321 if (!counter->supported)
324 for (thread = 0; thread < nthreads; thread++) {
325 struct perf_counts_values *count;
327 count = perf_counts(counter->counts, cpu_map_idx, thread);
330 * The leader's group read loads data into its group members
331 * (via evsel__read_counter()) and sets their count->loaded.
333 if (!perf_counts__is_loaded(counter->counts, cpu_map_idx, thread) &&
334 read_single_counter(counter, cpu_map_idx, thread, rs)) {
335 counter->counts->scaled = -1;
336 perf_counts(counter->counts, cpu_map_idx, thread)->ena = 0;
337 perf_counts(counter->counts, cpu_map_idx, thread)->run = 0;
341 perf_counts__set_loaded(counter->counts, cpu_map_idx, thread, false);
344 if (evsel__write_stat_event(counter, cpu_map_idx, thread, count)) {
345 pr_err("failed to write stat event\n");
351 fprintf(stat_config.output,
352 "%s: %d: %" PRIu64 " %" PRIu64 " %" PRIu64 "\n",
353 evsel__name(counter),
354 perf_cpu_map__cpu(evsel__cpus(counter),
356 count->val, count->ena, count->run);
363 static int read_affinity_counters(struct timespec *rs)
365 struct evlist_cpu_iterator evlist_cpu_itr;
366 struct affinity saved_affinity, *affinity;
368 if (all_counters_use_bpf)
371 if (!target__has_cpu(&target) || target__has_per_thread(&target))
373 else if (affinity__setup(&saved_affinity) < 0)
376 affinity = &saved_affinity;
378 evlist__for_each_cpu(evlist_cpu_itr, evsel_list, affinity) {
379 struct evsel *counter = evlist_cpu_itr.evsel;
381 if (evsel__is_bpf(counter))
385 counter->err = read_counter_cpu(counter, rs,
386 evlist_cpu_itr.cpu_map_idx);
390 affinity__cleanup(&saved_affinity);
395 static int read_bpf_map_counters(void)
397 struct evsel *counter;
400 evlist__for_each_entry(evsel_list, counter) {
401 if (!evsel__is_bpf(counter))
404 err = bpf_counter__read(counter);
411 static int read_counters(struct timespec *rs)
413 if (!stat_config.stop_read_counter) {
414 if (read_bpf_map_counters() ||
415 read_affinity_counters(rs))
421 static void process_counters(void)
423 struct evsel *counter;
425 evlist__for_each_entry(evsel_list, counter) {
427 pr_debug("failed to read counter %s\n", counter->name);
428 if (counter->err == 0 && perf_stat_process_counter(&stat_config, counter))
429 pr_warning("failed to process counter %s\n", counter->name);
433 perf_stat_merge_counters(&stat_config, evsel_list);
434 perf_stat_process_percore(&stat_config, evsel_list);
437 static void process_interval(void)
439 struct timespec ts, rs;
441 clock_gettime(CLOCK_MONOTONIC, &ts);
442 diff_timespec(&rs, &ts, &ref_time);
444 evlist__reset_aggr_stats(evsel_list);
446 if (read_counters(&rs) == 0)
450 if (WRITE_STAT_ROUND_EVENT(rs.tv_sec * NSEC_PER_SEC + rs.tv_nsec, INTERVAL))
451 pr_err("failed to write stat round event\n");
454 init_stats(&walltime_nsecs_stats);
455 update_stats(&walltime_nsecs_stats, stat_config.interval * 1000000ULL);
456 print_counters(&rs, 0, NULL);
459 static bool handle_interval(unsigned int interval, int *times)
463 if (interval_count && !(--(*times)))
469 static int enable_counters(void)
474 evlist__for_each_entry(evsel_list, evsel) {
475 if (!evsel__is_bpf(evsel))
478 err = bpf_counter__enable(evsel);
483 if (!target__enable_on_exec(&target)) {
484 if (!all_counters_use_bpf)
485 evlist__enable(evsel_list);
490 static void disable_counters(void)
492 struct evsel *counter;
495 * If we don't have tracee (attaching to task or cpu), counters may
496 * still be running. To get accurate group ratios, we must stop groups
497 * from counting before reading their constituent counters.
499 if (!target__none(&target)) {
500 evlist__for_each_entry(evsel_list, counter)
501 bpf_counter__disable(counter);
502 if (!all_counters_use_bpf)
503 evlist__disable(evsel_list);
507 static volatile sig_atomic_t workload_exec_errno;
510 * evlist__prepare_workload will send a SIGUSR1
511 * if the fork fails, since we asked by setting its
512 * want_signal to true.
514 static void workload_exec_failed_signal(int signo __maybe_unused, siginfo_t *info,
515 void *ucontext __maybe_unused)
517 workload_exec_errno = info->si_value.sival_int;
520 static bool evsel__should_store_id(struct evsel *counter)
522 return STAT_RECORD || counter->core.attr.read_format & PERF_FORMAT_ID;
525 static bool is_target_alive(struct target *_target,
526 struct perf_thread_map *threads)
531 if (!target__has_task(_target))
534 for (i = 0; i < threads->nr; i++) {
537 scnprintf(path, PATH_MAX, "%s/%d", procfs__mountpoint(),
538 threads->map[i].pid);
540 if (!stat(path, &st))
547 static void process_evlist(struct evlist *evlist, unsigned int interval)
549 enum evlist_ctl_cmd cmd = EVLIST_CTL_CMD_UNSUPPORTED;
551 if (evlist__ctlfd_process(evlist, &cmd) > 0) {
553 case EVLIST_CTL_CMD_ENABLE:
555 case EVLIST_CTL_CMD_DISABLE:
559 case EVLIST_CTL_CMD_SNAPSHOT:
560 case EVLIST_CTL_CMD_ACK:
561 case EVLIST_CTL_CMD_UNSUPPORTED:
562 case EVLIST_CTL_CMD_EVLIST:
563 case EVLIST_CTL_CMD_STOP:
564 case EVLIST_CTL_CMD_PING:
571 static void compute_tts(struct timespec *time_start, struct timespec *time_stop,
574 int tts = *time_to_sleep;
575 struct timespec time_diff;
577 diff_timespec(&time_diff, time_stop, time_start);
579 tts -= time_diff.tv_sec * MSEC_PER_SEC +
580 time_diff.tv_nsec / NSEC_PER_MSEC;
585 *time_to_sleep = tts;
588 static int dispatch_events(bool forks, int timeout, int interval, int *times)
590 int child_exited = 0, status = 0;
591 int time_to_sleep, sleep_time;
592 struct timespec time_start, time_stop;
595 sleep_time = interval;
597 sleep_time = timeout;
601 time_to_sleep = sleep_time;
605 child_exited = waitpid(child_pid, &status, WNOHANG);
607 child_exited = !is_target_alive(&target, evsel_list->core.threads) ? 1 : 0;
612 clock_gettime(CLOCK_MONOTONIC, &time_start);
613 if (!(evlist__poll(evsel_list, time_to_sleep) > 0)) { /* poll timeout or EINTR */
614 if (timeout || handle_interval(interval, times))
616 time_to_sleep = sleep_time;
617 } else { /* fd revent */
618 process_evlist(evsel_list, interval);
619 clock_gettime(CLOCK_MONOTONIC, &time_stop);
620 compute_tts(&time_start, &time_stop, &time_to_sleep);
627 enum counter_recovery {
633 static enum counter_recovery stat_handle_error(struct evsel *counter)
637 * PPC returns ENXIO for HW counters until 2.6.37
638 * (behavior changed with commit b0a873e).
640 if (errno == EINVAL || errno == ENOSYS ||
641 errno == ENOENT || errno == EOPNOTSUPP ||
644 ui__warning("%s event is not supported by the kernel.\n",
645 evsel__name(counter));
646 counter->supported = false;
648 * errored is a sticky flag that means one of the counter's
649 * cpu event had a problem and needs to be reexamined.
651 counter->errored = true;
653 if ((evsel__leader(counter) != counter) ||
654 !(counter->core.leader->nr_members > 1))
656 } else if (evsel__fallback(counter, errno, msg, sizeof(msg))) {
658 ui__warning("%s\n", msg);
659 return COUNTER_RETRY;
660 } else if (target__has_per_thread(&target) &&
661 evsel_list->core.threads &&
662 evsel_list->core.threads->err_thread != -1) {
664 * For global --per-thread case, skip current
667 if (!thread_map__remove(evsel_list->core.threads,
668 evsel_list->core.threads->err_thread)) {
669 evsel_list->core.threads->err_thread = -1;
670 return COUNTER_RETRY;
672 } else if (counter->skippable) {
674 ui__warning("skipping event %s that kernel failed to open .\n",
675 evsel__name(counter));
676 counter->supported = false;
677 counter->errored = true;
681 evsel__open_strerror(counter, &target, errno, msg, sizeof(msg));
682 ui__error("%s\n", msg);
685 kill(child_pid, SIGTERM);
686 return COUNTER_FATAL;
689 static int __run_perf_stat(int argc, const char **argv, int run_idx)
691 int interval = stat_config.interval;
692 int times = stat_config.times;
693 int timeout = stat_config.timeout;
695 unsigned long long t0, t1;
696 struct evsel *counter;
699 const bool forks = (argc > 0);
700 bool is_pipe = STAT_RECORD ? perf_stat.data.is_pipe : false;
701 struct evlist_cpu_iterator evlist_cpu_itr;
702 struct affinity saved_affinity, *affinity = NULL;
704 bool second_pass = false;
707 if (evlist__prepare_workload(evsel_list, &target, argv, is_pipe, workload_exec_failed_signal) < 0) {
708 perror("failed to prepare workload");
711 child_pid = evsel_list->workload.pid;
714 if (!cpu_map__is_dummy(evsel_list->core.user_requested_cpus)) {
715 if (affinity__setup(&saved_affinity) < 0)
717 affinity = &saved_affinity;
720 evlist__for_each_entry(evsel_list, counter) {
721 counter->reset_group = false;
722 if (bpf_counter__load(counter, &target))
724 if (!(evsel__is_bperf(counter)))
725 all_counters_use_bpf = false;
728 evlist__reset_aggr_stats(evsel_list);
730 evlist__for_each_cpu(evlist_cpu_itr, evsel_list, affinity) {
731 counter = evlist_cpu_itr.evsel;
734 * bperf calls evsel__open_per_cpu() in bperf__load(), so
735 * no need to call it again here.
740 if (counter->reset_group || counter->errored)
742 if (evsel__is_bperf(counter))
745 if (create_perf_stat_counter(counter, &stat_config, &target,
746 evlist_cpu_itr.cpu_map_idx) < 0) {
749 * Weak group failed. We cannot just undo this here
750 * because earlier CPUs might be in group mode, and the kernel
751 * doesn't support mixing group and non group reads. Defer
753 * Don't close here because we're in the wrong affinity.
755 if ((errno == EINVAL || errno == EBADF) &&
756 evsel__leader(counter) != counter &&
757 counter->weak_group) {
758 evlist__reset_weak_group(evsel_list, counter, false);
759 assert(counter->reset_group);
764 switch (stat_handle_error(counter)) {
776 counter->supported = true;
781 * Now redo all the weak group after closing them,
782 * and also close errored counters.
785 /* First close errored or weak retry */
786 evlist__for_each_cpu(evlist_cpu_itr, evsel_list, affinity) {
787 counter = evlist_cpu_itr.evsel;
789 if (!counter->reset_group && !counter->errored)
792 perf_evsel__close_cpu(&counter->core, evlist_cpu_itr.cpu_map_idx);
794 /* Now reopen weak */
795 evlist__for_each_cpu(evlist_cpu_itr, evsel_list, affinity) {
796 counter = evlist_cpu_itr.evsel;
798 if (!counter->reset_group)
801 pr_debug2("reopening weak %s\n", evsel__name(counter));
802 if (create_perf_stat_counter(counter, &stat_config, &target,
803 evlist_cpu_itr.cpu_map_idx) < 0) {
805 switch (stat_handle_error(counter)) {
809 goto try_again_reset;
816 counter->supported = true;
819 affinity__cleanup(affinity);
821 evlist__for_each_entry(evsel_list, counter) {
822 if (!counter->supported) {
823 perf_evsel__free_fd(&counter->core);
827 l = strlen(counter->unit);
828 if (l > stat_config.unit_width)
829 stat_config.unit_width = l;
831 if (evsel__should_store_id(counter) &&
832 evsel__store_ids(counter, evsel_list))
836 if (evlist__apply_filters(evsel_list, &counter)) {
837 pr_err("failed to set filter \"%s\" on event %s with %d (%s)\n",
838 counter->filter, evsel__name(counter), errno,
839 str_error_r(errno, msg, sizeof(msg)));
844 int fd = perf_data__fd(&perf_stat.data);
847 err = perf_header__write_pipe(perf_data__fd(&perf_stat.data));
849 err = perf_session__write_header(perf_stat.session, evsel_list,
856 err = perf_event__synthesize_stat_events(&stat_config, NULL, evsel_list,
857 process_synthesized_event, is_pipe);
862 if (target.initial_delay) {
863 pr_info(EVLIST_DISABLED_MSG);
865 err = enable_counters();
870 /* Exec the command, if any */
872 evlist__start_workload(evsel_list);
874 if (target.initial_delay > 0) {
875 usleep(target.initial_delay * USEC_PER_MSEC);
876 err = enable_counters();
880 pr_info(EVLIST_ENABLED_MSG);
884 clock_gettime(CLOCK_MONOTONIC, &ref_time);
887 if (interval || timeout || evlist__ctlfd_initialized(evsel_list))
888 status = dispatch_events(forks, timeout, interval, ×);
889 if (child_pid != -1) {
891 kill(child_pid, SIGTERM);
892 wait4(child_pid, &status, 0, &stat_config.ru_data);
895 if (workload_exec_errno) {
896 const char *emsg = str_error_r(workload_exec_errno, msg, sizeof(msg));
897 pr_err("Workload failed: %s\n", emsg);
901 if (WIFSIGNALED(status))
902 psignal(WTERMSIG(status), argv[0]);
904 status = dispatch_events(forks, timeout, interval, ×);
911 if (stat_config.walltime_run_table)
912 stat_config.walltime_run[run_idx] = t1 - t0;
914 if (interval && stat_config.summary) {
915 stat_config.interval = 0;
916 stat_config.stop_read_counter = true;
917 init_stats(&walltime_nsecs_stats);
918 update_stats(&walltime_nsecs_stats, t1 - t0);
920 evlist__copy_prev_raw_counts(evsel_list);
921 evlist__reset_prev_raw_counts(evsel_list);
922 evlist__reset_aggr_stats(evsel_list);
924 update_stats(&walltime_nsecs_stats, t1 - t0);
925 update_rusage_stats(&ru_stats, &stat_config.ru_data);
929 * Closing a group leader splits the group, and as we only disable
930 * group leaders, results in remaining events becoming enabled. To
931 * avoid arbitrary skew, we must read all counters before closing any
934 if (read_counters(&(struct timespec) { .tv_nsec = t1-t0 }) == 0)
938 * We need to keep evsel_list alive, because it's processed
939 * later the evsel_list will be closed after.
942 evlist__close(evsel_list);
944 return WEXITSTATUS(status);
947 static int run_perf_stat(int argc, const char **argv, int run_idx)
952 ret = system(pre_cmd);
960 ret = __run_perf_stat(argc, argv, run_idx);
965 ret = system(post_cmd);
973 static void print_counters(struct timespec *ts, int argc, const char **argv)
975 /* Do not print anything if we record to the pipe. */
976 if (STAT_RECORD && perf_stat.data.is_pipe)
981 evlist__print_counters(evsel_list, &stat_config, &target, ts, argc, argv);
984 static volatile sig_atomic_t signr = -1;
986 static void skip_signal(int signo)
988 if ((child_pid == -1) || stat_config.interval)
993 * render child_pid harmless
994 * won't send SIGTERM to a random
995 * process in case of race condition
996 * and fast PID recycling
1001 static void sig_atexit(void)
1006 * avoid race condition with SIGCHLD handler
1007 * in skip_signal() which is modifying child_pid
1008 * goal is to avoid send SIGTERM to a random
1012 sigaddset(&set, SIGCHLD);
1013 sigprocmask(SIG_BLOCK, &set, &oset);
1015 if (child_pid != -1)
1016 kill(child_pid, SIGTERM);
1018 sigprocmask(SIG_SETMASK, &oset, NULL);
1023 signal(signr, SIG_DFL);
1024 kill(getpid(), signr);
1027 void perf_stat__set_big_num(int set)
1029 stat_config.big_num = (set != 0);
1032 void perf_stat__set_no_csv_summary(int set)
1034 stat_config.no_csv_summary = (set != 0);
1037 static int stat__set_big_num(const struct option *opt __maybe_unused,
1038 const char *s __maybe_unused, int unset)
1040 big_num_opt = unset ? 0 : 1;
1041 perf_stat__set_big_num(!unset);
1045 static int enable_metric_only(const struct option *opt __maybe_unused,
1046 const char *s __maybe_unused, int unset)
1048 force_metric_only = true;
1049 stat_config.metric_only = !unset;
1053 static int append_metric_groups(const struct option *opt __maybe_unused,
1055 int unset __maybe_unused)
1060 if (asprintf(&tmp, "%s,%s", metrics, str) < 0)
1065 metrics = strdup(str);
1072 static int parse_control_option(const struct option *opt,
1074 int unset __maybe_unused)
1076 struct perf_stat_config *config = opt->value;
1078 return evlist__parse_control(str, &config->ctl_fd, &config->ctl_fd_ack, &config->ctl_fd_close);
1081 static int parse_stat_cgroups(const struct option *opt,
1082 const char *str, int unset)
1084 if (stat_config.cgroup_list) {
1085 pr_err("--cgroup and --for-each-cgroup cannot be used together\n");
1089 return parse_cgroups(opt, str, unset);
1092 static int parse_cputype(const struct option *opt,
1094 int unset __maybe_unused)
1096 const struct perf_pmu *pmu;
1097 struct evlist *evlist = *(struct evlist **)opt->value;
1099 if (!list_empty(&evlist->core.entries)) {
1100 fprintf(stderr, "Must define cputype before events/metrics\n");
1104 pmu = perf_pmus__pmu_for_pmu_filter(str);
1106 fprintf(stderr, "--cputype %s is not supported!\n", str);
1109 parse_events_option_args.pmu_filter = pmu->name;
1114 static int parse_cache_level(const struct option *opt,
1116 int unset __maybe_unused)
1119 u32 *aggr_mode = (u32 *)opt->value;
1120 u32 *aggr_level = (u32 *)opt->data;
1123 * If no string is specified, aggregate based on the topology of
1124 * Last Level Cache (LLC). Since the LLC level can change from
1125 * architecture to architecture, set level greater than
1126 * MAX_CACHE_LVL which will be interpreted as LLC.
1129 level = MAX_CACHE_LVL + 1;
1134 * The format to specify cache level is LX or lX where X is the
1137 if (strlen(str) != 2 || (str[0] != 'l' && str[0] != 'L')) {
1138 pr_err("Cache level must be of form L[1-%d], or l[1-%d]\n",
1144 level = atoi(&str[1]);
1146 pr_err("Cache level must be of form L[1-%d], or l[1-%d]\n",
1152 if (level > MAX_CACHE_LVL) {
1153 pr_err("perf only supports max cache level of %d.\n"
1154 "Consider increasing MAX_CACHE_LVL\n", MAX_CACHE_LVL);
1158 *aggr_mode = AGGR_CACHE;
1159 *aggr_level = level;
1163 static struct option stat_options[] = {
1164 OPT_BOOLEAN('T', "transaction", &transaction_run,
1165 "hardware transaction statistics"),
1166 OPT_CALLBACK('e', "event", &parse_events_option_args, "event",
1167 "event selector. use 'perf list' to list available events",
1168 parse_events_option),
1169 OPT_CALLBACK(0, "filter", &evsel_list, "filter",
1170 "event filter", parse_filter),
1171 OPT_BOOLEAN('i', "no-inherit", &stat_config.no_inherit,
1172 "child tasks do not inherit counters"),
1173 OPT_STRING('p', "pid", &target.pid, "pid",
1174 "stat events on existing process id"),
1175 OPT_STRING('t', "tid", &target.tid, "tid",
1176 "stat events on existing thread id"),
1177 #ifdef HAVE_BPF_SKEL
1178 OPT_STRING('b', "bpf-prog", &target.bpf_str, "bpf-prog-id",
1179 "stat events on existing bpf program id"),
1180 OPT_BOOLEAN(0, "bpf-counters", &target.use_bpf,
1181 "use bpf program to count events"),
1182 OPT_STRING(0, "bpf-attr-map", &target.attr_map, "attr-map-path",
1183 "path to perf_event_attr map"),
1185 OPT_BOOLEAN('a', "all-cpus", &target.system_wide,
1186 "system-wide collection from all CPUs"),
1187 OPT_BOOLEAN(0, "scale", &stat_config.scale,
1188 "Use --no-scale to disable counter scaling for multiplexing"),
1189 OPT_INCR('v', "verbose", &verbose,
1190 "be more verbose (show counter open errors, etc)"),
1191 OPT_INTEGER('r', "repeat", &stat_config.run_count,
1192 "repeat command and print average + stddev (max: 100, forever: 0)"),
1193 OPT_BOOLEAN(0, "table", &stat_config.walltime_run_table,
1194 "display details about each run (only with -r option)"),
1195 OPT_BOOLEAN('n', "null", &stat_config.null_run,
1196 "null run - dont start any counters"),
1197 OPT_INCR('d', "detailed", &detailed_run,
1198 "detailed run - start a lot of events"),
1199 OPT_BOOLEAN('S', "sync", &sync_run,
1200 "call sync() before starting a run"),
1201 OPT_CALLBACK_NOOPT('B', "big-num", NULL, NULL,
1202 "print large numbers with thousands\' separators",
1204 OPT_STRING('C', "cpu", &target.cpu_list, "cpu",
1205 "list of cpus to monitor in system-wide"),
1206 OPT_SET_UINT('A', "no-aggr", &stat_config.aggr_mode,
1207 "disable CPU count aggregation", AGGR_NONE),
1208 OPT_BOOLEAN(0, "no-merge", &stat_config.no_merge, "Do not merge identical named events"),
1209 OPT_BOOLEAN(0, "hybrid-merge", &stat_config.hybrid_merge,
1210 "Merge identical named hybrid events"),
1211 OPT_STRING('x', "field-separator", &stat_config.csv_sep, "separator",
1212 "print counts with custom separator"),
1213 OPT_BOOLEAN('j', "json-output", &stat_config.json_output,
1214 "print counts in JSON format"),
1215 OPT_CALLBACK('G', "cgroup", &evsel_list, "name",
1216 "monitor event in cgroup name only", parse_stat_cgroups),
1217 OPT_STRING(0, "for-each-cgroup", &stat_config.cgroup_list, "name",
1218 "expand events for each cgroup"),
1219 OPT_STRING('o', "output", &output_name, "file", "output file name"),
1220 OPT_BOOLEAN(0, "append", &append_file, "append to the output file"),
1221 OPT_INTEGER(0, "log-fd", &output_fd,
1222 "log output to fd, instead of stderr"),
1223 OPT_STRING(0, "pre", &pre_cmd, "command",
1224 "command to run prior to the measured command"),
1225 OPT_STRING(0, "post", &post_cmd, "command",
1226 "command to run after to the measured command"),
1227 OPT_UINTEGER('I', "interval-print", &stat_config.interval,
1228 "print counts at regular interval in ms "
1229 "(overhead is possible for values <= 100ms)"),
1230 OPT_INTEGER(0, "interval-count", &stat_config.times,
1231 "print counts for fixed number of times"),
1232 OPT_BOOLEAN(0, "interval-clear", &stat_config.interval_clear,
1233 "clear screen in between new interval"),
1234 OPT_UINTEGER(0, "timeout", &stat_config.timeout,
1235 "stop workload and print counts after a timeout period in ms (>= 10ms)"),
1236 OPT_SET_UINT(0, "per-socket", &stat_config.aggr_mode,
1237 "aggregate counts per processor socket", AGGR_SOCKET),
1238 OPT_SET_UINT(0, "per-die", &stat_config.aggr_mode,
1239 "aggregate counts per processor die", AGGR_DIE),
1240 OPT_CALLBACK_OPTARG(0, "per-cache", &stat_config.aggr_mode, &stat_config.aggr_level,
1241 "cache level", "aggregate count at this cache level (Default: LLC)",
1243 OPT_SET_UINT(0, "per-core", &stat_config.aggr_mode,
1244 "aggregate counts per physical processor core", AGGR_CORE),
1245 OPT_SET_UINT(0, "per-thread", &stat_config.aggr_mode,
1246 "aggregate counts per thread", AGGR_THREAD),
1247 OPT_SET_UINT(0, "per-node", &stat_config.aggr_mode,
1248 "aggregate counts per numa node", AGGR_NODE),
1249 OPT_INTEGER('D', "delay", &target.initial_delay,
1250 "ms to wait before starting measurement after program start (-1: start with events disabled)"),
1251 OPT_CALLBACK_NOOPT(0, "metric-only", &stat_config.metric_only, NULL,
1252 "Only print computed metrics. No raw values", enable_metric_only),
1253 OPT_BOOLEAN(0, "metric-no-group", &stat_config.metric_no_group,
1254 "don't group metric events, impacts multiplexing"),
1255 OPT_BOOLEAN(0, "metric-no-merge", &stat_config.metric_no_merge,
1256 "don't try to share events between metrics in a group"),
1257 OPT_BOOLEAN(0, "metric-no-threshold", &stat_config.metric_no_threshold,
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)",
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),
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",
1305 * Calculate the cache instance ID from the map in
1306 * /sys/devices/system/cpu/cpuX/cache/indexY/shared_cpu_list
1307 * Cache instance ID is the first CPU reported in the shared_cpu_list file.
1309 static int cpu__get_cache_id_from_map(struct perf_cpu cpu, char *map)
1312 struct perf_cpu_map *cpu_map = perf_cpu_map__new(map);
1315 * If the map contains no CPU, consider the current CPU to
1316 * be the first online CPU in the cache domain else use the
1317 * first online CPU of the cache domain as the ID.
1319 if (perf_cpu_map__empty(cpu_map))
1322 id = perf_cpu_map__cpu(cpu_map, 0).cpu;
1324 /* Free the perf_cpu_map used to find the cache ID */
1325 perf_cpu_map__put(cpu_map);
1331 * cpu__get_cache_id - Returns 0 if successful in populating the
1332 * cache level and cache id. Cache level is read from
1333 * /sys/devices/system/cpu/cpuX/cache/indexY/level where as cache instance ID
1334 * is the first CPU reported by
1335 * /sys/devices/system/cpu/cpuX/cache/indexY/shared_cpu_list
1337 static int cpu__get_cache_details(struct perf_cpu cpu, struct perf_cache *cache)
1340 u32 cache_level = stat_config.aggr_level;
1341 struct cpu_cache_level caches[MAX_CACHE_LVL];
1342 u32 i = 0, caches_cnt = 0;
1344 cache->cache_lvl = (cache_level > MAX_CACHE_LVL) ? 0 : cache_level;
1347 ret = build_caches_for_cpu(cpu.cpu, caches, &caches_cnt);
1350 * If caches_cnt is not 0, cpu_cache_level data
1351 * was allocated when building the topology.
1352 * Free the allocated data before returning.
1364 * Save the data for the highest level if no
1365 * level was specified by the user.
1367 if (cache_level > MAX_CACHE_LVL) {
1368 int max_level_index = 0;
1370 for (i = 1; i < caches_cnt; ++i) {
1371 if (caches[i].level > caches[max_level_index].level)
1372 max_level_index = i;
1375 cache->cache_lvl = caches[max_level_index].level;
1376 cache->cache = cpu__get_cache_id_from_map(cpu, caches[max_level_index].map);
1378 /* Reset i to 0 to free entire caches[] */
1383 for (i = 0; i < caches_cnt; ++i) {
1384 if (caches[i].level == cache_level) {
1385 cache->cache_lvl = cache_level;
1386 cache->cache = cpu__get_cache_id_from_map(cpu, caches[i].map);
1389 cpu_cache_level__free(&caches[i]);
1394 * Free all the allocated cpu_cache_level data.
1396 while (i < caches_cnt)
1397 cpu_cache_level__free(&caches[i++]);
1403 * aggr_cpu_id__cache - Create an aggr_cpu_id with cache instache ID, cache
1404 * level, die and socket populated with the cache instache ID, cache level,
1405 * die and socket for cpu. The function signature is compatible with
1406 * aggr_cpu_id_get_t.
1408 static struct aggr_cpu_id aggr_cpu_id__cache(struct perf_cpu cpu, void *data)
1411 struct aggr_cpu_id id;
1412 struct perf_cache cache;
1414 id = aggr_cpu_id__die(cpu, data);
1415 if (aggr_cpu_id__is_empty(&id))
1418 ret = cpu__get_cache_details(cpu, &cache);
1422 id.cache_lvl = cache.cache_lvl;
1423 id.cache = cache.cache;
1427 static const char *const aggr_mode__string[] = {
1428 [AGGR_CORE] = "core",
1429 [AGGR_CACHE] = "cache",
1431 [AGGR_GLOBAL] = "global",
1432 [AGGR_NODE] = "node",
1433 [AGGR_NONE] = "none",
1434 [AGGR_SOCKET] = "socket",
1435 [AGGR_THREAD] = "thread",
1436 [AGGR_UNSET] = "unset",
1439 static struct aggr_cpu_id perf_stat__get_socket(struct perf_stat_config *config __maybe_unused,
1440 struct perf_cpu cpu)
1442 return aggr_cpu_id__socket(cpu, /*data=*/NULL);
1445 static struct aggr_cpu_id perf_stat__get_die(struct perf_stat_config *config __maybe_unused,
1446 struct perf_cpu cpu)
1448 return aggr_cpu_id__die(cpu, /*data=*/NULL);
1451 static struct aggr_cpu_id perf_stat__get_cache_id(struct perf_stat_config *config __maybe_unused,
1452 struct perf_cpu cpu)
1454 return aggr_cpu_id__cache(cpu, /*data=*/NULL);
1457 static struct aggr_cpu_id perf_stat__get_core(struct perf_stat_config *config __maybe_unused,
1458 struct perf_cpu cpu)
1460 return aggr_cpu_id__core(cpu, /*data=*/NULL);
1463 static struct aggr_cpu_id perf_stat__get_node(struct perf_stat_config *config __maybe_unused,
1464 struct perf_cpu cpu)
1466 return aggr_cpu_id__node(cpu, /*data=*/NULL);
1469 static struct aggr_cpu_id perf_stat__get_global(struct perf_stat_config *config __maybe_unused,
1470 struct perf_cpu cpu)
1472 return aggr_cpu_id__global(cpu, /*data=*/NULL);
1475 static struct aggr_cpu_id perf_stat__get_cpu(struct perf_stat_config *config __maybe_unused,
1476 struct perf_cpu cpu)
1478 return aggr_cpu_id__cpu(cpu, /*data=*/NULL);
1481 static struct aggr_cpu_id perf_stat__get_aggr(struct perf_stat_config *config,
1482 aggr_get_id_t get_id, struct perf_cpu cpu)
1484 struct aggr_cpu_id id;
1486 /* per-process mode - should use global aggr mode */
1488 return get_id(config, cpu);
1490 if (aggr_cpu_id__is_empty(&config->cpus_aggr_map->map[cpu.cpu]))
1491 config->cpus_aggr_map->map[cpu.cpu] = get_id(config, cpu);
1493 id = config->cpus_aggr_map->map[cpu.cpu];
1497 static struct aggr_cpu_id perf_stat__get_socket_cached(struct perf_stat_config *config,
1498 struct perf_cpu cpu)
1500 return perf_stat__get_aggr(config, perf_stat__get_socket, cpu);
1503 static struct aggr_cpu_id perf_stat__get_die_cached(struct perf_stat_config *config,
1504 struct perf_cpu cpu)
1506 return perf_stat__get_aggr(config, perf_stat__get_die, cpu);
1509 static struct aggr_cpu_id perf_stat__get_cache_id_cached(struct perf_stat_config *config,
1510 struct perf_cpu cpu)
1512 return perf_stat__get_aggr(config, perf_stat__get_cache_id, cpu);
1515 static struct aggr_cpu_id perf_stat__get_core_cached(struct perf_stat_config *config,
1516 struct perf_cpu cpu)
1518 return perf_stat__get_aggr(config, perf_stat__get_core, cpu);
1521 static struct aggr_cpu_id perf_stat__get_node_cached(struct perf_stat_config *config,
1522 struct perf_cpu cpu)
1524 return perf_stat__get_aggr(config, perf_stat__get_node, cpu);
1527 static struct aggr_cpu_id perf_stat__get_global_cached(struct perf_stat_config *config,
1528 struct perf_cpu cpu)
1530 return perf_stat__get_aggr(config, perf_stat__get_global, cpu);
1533 static struct aggr_cpu_id perf_stat__get_cpu_cached(struct perf_stat_config *config,
1534 struct perf_cpu cpu)
1536 return perf_stat__get_aggr(config, perf_stat__get_cpu, cpu);
1539 static aggr_cpu_id_get_t aggr_mode__get_aggr(enum aggr_mode aggr_mode)
1541 switch (aggr_mode) {
1543 return aggr_cpu_id__socket;
1545 return aggr_cpu_id__die;
1547 return aggr_cpu_id__cache;
1549 return aggr_cpu_id__core;
1551 return aggr_cpu_id__node;
1553 return aggr_cpu_id__cpu;
1555 return aggr_cpu_id__global;
1564 static aggr_get_id_t aggr_mode__get_id(enum aggr_mode aggr_mode)
1566 switch (aggr_mode) {
1568 return perf_stat__get_socket_cached;
1570 return perf_stat__get_die_cached;
1572 return perf_stat__get_cache_id_cached;
1574 return perf_stat__get_core_cached;
1576 return perf_stat__get_node_cached;
1578 return perf_stat__get_cpu_cached;
1580 return perf_stat__get_global_cached;
1589 static int perf_stat_init_aggr_mode(void)
1592 aggr_cpu_id_get_t get_id = aggr_mode__get_aggr(stat_config.aggr_mode);
1595 bool needs_sort = stat_config.aggr_mode != AGGR_NONE;
1596 stat_config.aggr_map = cpu_aggr_map__new(evsel_list->core.user_requested_cpus,
1597 get_id, /*data=*/NULL, needs_sort);
1598 if (!stat_config.aggr_map) {
1599 pr_err("cannot build %s map\n", aggr_mode__string[stat_config.aggr_mode]);
1602 stat_config.aggr_get_id = aggr_mode__get_id(stat_config.aggr_mode);
1605 if (stat_config.aggr_mode == AGGR_THREAD) {
1606 nr = perf_thread_map__nr(evsel_list->core.threads);
1607 stat_config.aggr_map = cpu_aggr_map__empty_new(nr);
1608 if (stat_config.aggr_map == NULL)
1611 for (int s = 0; s < nr; s++) {
1612 struct aggr_cpu_id id = aggr_cpu_id__empty();
1615 stat_config.aggr_map->map[s] = id;
1621 * The evsel_list->cpus is the base we operate on,
1622 * taking the highest cpu number to be the size of
1623 * the aggregation translate cpumap.
1625 if (evsel_list->core.user_requested_cpus)
1626 nr = perf_cpu_map__max(evsel_list->core.user_requested_cpus).cpu;
1629 stat_config.cpus_aggr_map = cpu_aggr_map__empty_new(nr + 1);
1630 return stat_config.cpus_aggr_map ? 0 : -ENOMEM;
1633 static void cpu_aggr_map__delete(struct cpu_aggr_map *map)
1636 WARN_ONCE(refcount_read(&map->refcnt) != 0,
1637 "cpu_aggr_map refcnt unbalanced\n");
1642 static void cpu_aggr_map__put(struct cpu_aggr_map *map)
1644 if (map && refcount_dec_and_test(&map->refcnt))
1645 cpu_aggr_map__delete(map);
1648 static void perf_stat__exit_aggr_mode(void)
1650 cpu_aggr_map__put(stat_config.aggr_map);
1651 cpu_aggr_map__put(stat_config.cpus_aggr_map);
1652 stat_config.aggr_map = NULL;
1653 stat_config.cpus_aggr_map = NULL;
1656 static struct aggr_cpu_id perf_env__get_socket_aggr_by_cpu(struct perf_cpu cpu, void *data)
1658 struct perf_env *env = data;
1659 struct aggr_cpu_id id = aggr_cpu_id__empty();
1662 id.socket = env->cpu[cpu.cpu].socket_id;
1667 static struct aggr_cpu_id perf_env__get_die_aggr_by_cpu(struct perf_cpu cpu, void *data)
1669 struct perf_env *env = data;
1670 struct aggr_cpu_id id = aggr_cpu_id__empty();
1672 if (cpu.cpu != -1) {
1674 * die_id is relative to socket, so start
1675 * with the socket ID and then add die to
1678 id.socket = env->cpu[cpu.cpu].socket_id;
1679 id.die = env->cpu[cpu.cpu].die_id;
1685 static void perf_env__get_cache_id_for_cpu(struct perf_cpu cpu, struct perf_env *env,
1686 u32 cache_level, struct aggr_cpu_id *id)
1689 int caches_cnt = env->caches_cnt;
1690 struct cpu_cache_level *caches = env->caches;
1692 id->cache_lvl = (cache_level > MAX_CACHE_LVL) ? 0 : cache_level;
1698 for (i = caches_cnt - 1; i > -1; --i) {
1699 struct perf_cpu_map *cpu_map;
1700 int map_contains_cpu;
1703 * If user has not specified a level, find the fist level with
1704 * the cpu in the map. Since building the map is expensive, do
1705 * this only if levels match.
1707 if (cache_level <= MAX_CACHE_LVL && caches[i].level != cache_level)
1710 cpu_map = perf_cpu_map__new(caches[i].map);
1711 map_contains_cpu = perf_cpu_map__idx(cpu_map, cpu);
1712 perf_cpu_map__put(cpu_map);
1714 if (map_contains_cpu != -1) {
1715 id->cache_lvl = caches[i].level;
1716 id->cache = cpu__get_cache_id_from_map(cpu, caches[i].map);
1722 static struct aggr_cpu_id perf_env__get_cache_aggr_by_cpu(struct perf_cpu cpu,
1725 struct perf_env *env = data;
1726 struct aggr_cpu_id id = aggr_cpu_id__empty();
1728 if (cpu.cpu != -1) {
1729 u32 cache_level = (perf_stat.aggr_level) ?: stat_config.aggr_level;
1731 id.socket = env->cpu[cpu.cpu].socket_id;
1732 id.die = env->cpu[cpu.cpu].die_id;
1733 perf_env__get_cache_id_for_cpu(cpu, env, cache_level, &id);
1739 static struct aggr_cpu_id perf_env__get_core_aggr_by_cpu(struct perf_cpu cpu, void *data)
1741 struct perf_env *env = data;
1742 struct aggr_cpu_id id = aggr_cpu_id__empty();
1744 if (cpu.cpu != -1) {
1746 * core_id is relative to socket and die,
1747 * we need a global id. So we set
1748 * socket, die id and core id
1750 id.socket = env->cpu[cpu.cpu].socket_id;
1751 id.die = env->cpu[cpu.cpu].die_id;
1752 id.core = env->cpu[cpu.cpu].core_id;
1758 static struct aggr_cpu_id perf_env__get_cpu_aggr_by_cpu(struct perf_cpu cpu, void *data)
1760 struct perf_env *env = data;
1761 struct aggr_cpu_id id = aggr_cpu_id__empty();
1763 if (cpu.cpu != -1) {
1765 * core_id is relative to socket and die,
1766 * we need a global id. So we set
1767 * socket, die id and core id
1769 id.socket = env->cpu[cpu.cpu].socket_id;
1770 id.die = env->cpu[cpu.cpu].die_id;
1771 id.core = env->cpu[cpu.cpu].core_id;
1778 static struct aggr_cpu_id perf_env__get_node_aggr_by_cpu(struct perf_cpu cpu, void *data)
1780 struct aggr_cpu_id id = aggr_cpu_id__empty();
1782 id.node = perf_env__numa_node(data, cpu);
1786 static struct aggr_cpu_id perf_env__get_global_aggr_by_cpu(struct perf_cpu cpu __maybe_unused,
1787 void *data __maybe_unused)
1789 struct aggr_cpu_id id = aggr_cpu_id__empty();
1791 /* it always aggregates to the cpu 0 */
1792 id.cpu = (struct perf_cpu){ .cpu = 0 };
1796 static struct aggr_cpu_id perf_stat__get_socket_file(struct perf_stat_config *config __maybe_unused,
1797 struct perf_cpu cpu)
1799 return perf_env__get_socket_aggr_by_cpu(cpu, &perf_stat.session->header.env);
1801 static struct aggr_cpu_id perf_stat__get_die_file(struct perf_stat_config *config __maybe_unused,
1802 struct perf_cpu cpu)
1804 return perf_env__get_die_aggr_by_cpu(cpu, &perf_stat.session->header.env);
1807 static struct aggr_cpu_id perf_stat__get_cache_file(struct perf_stat_config *config __maybe_unused,
1808 struct perf_cpu cpu)
1810 return perf_env__get_cache_aggr_by_cpu(cpu, &perf_stat.session->header.env);
1813 static struct aggr_cpu_id perf_stat__get_core_file(struct perf_stat_config *config __maybe_unused,
1814 struct perf_cpu cpu)
1816 return perf_env__get_core_aggr_by_cpu(cpu, &perf_stat.session->header.env);
1819 static struct aggr_cpu_id perf_stat__get_cpu_file(struct perf_stat_config *config __maybe_unused,
1820 struct perf_cpu cpu)
1822 return perf_env__get_cpu_aggr_by_cpu(cpu, &perf_stat.session->header.env);
1825 static struct aggr_cpu_id perf_stat__get_node_file(struct perf_stat_config *config __maybe_unused,
1826 struct perf_cpu cpu)
1828 return perf_env__get_node_aggr_by_cpu(cpu, &perf_stat.session->header.env);
1831 static struct aggr_cpu_id perf_stat__get_global_file(struct perf_stat_config *config __maybe_unused,
1832 struct perf_cpu cpu)
1834 return perf_env__get_global_aggr_by_cpu(cpu, &perf_stat.session->header.env);
1837 static aggr_cpu_id_get_t aggr_mode__get_aggr_file(enum aggr_mode aggr_mode)
1839 switch (aggr_mode) {
1841 return perf_env__get_socket_aggr_by_cpu;
1843 return perf_env__get_die_aggr_by_cpu;
1845 return perf_env__get_cache_aggr_by_cpu;
1847 return perf_env__get_core_aggr_by_cpu;
1849 return perf_env__get_node_aggr_by_cpu;
1851 return perf_env__get_global_aggr_by_cpu;
1853 return perf_env__get_cpu_aggr_by_cpu;
1862 static aggr_get_id_t aggr_mode__get_id_file(enum aggr_mode aggr_mode)
1864 switch (aggr_mode) {
1866 return perf_stat__get_socket_file;
1868 return perf_stat__get_die_file;
1870 return perf_stat__get_cache_file;
1872 return perf_stat__get_core_file;
1874 return perf_stat__get_node_file;
1876 return perf_stat__get_global_file;
1878 return perf_stat__get_cpu_file;
1887 static int perf_stat_init_aggr_mode_file(struct perf_stat *st)
1889 struct perf_env *env = &st->session->header.env;
1890 aggr_cpu_id_get_t get_id = aggr_mode__get_aggr_file(stat_config.aggr_mode);
1891 bool needs_sort = stat_config.aggr_mode != AGGR_NONE;
1893 if (stat_config.aggr_mode == AGGR_THREAD) {
1894 int nr = perf_thread_map__nr(evsel_list->core.threads);
1896 stat_config.aggr_map = cpu_aggr_map__empty_new(nr);
1897 if (stat_config.aggr_map == NULL)
1900 for (int s = 0; s < nr; s++) {
1901 struct aggr_cpu_id id = aggr_cpu_id__empty();
1904 stat_config.aggr_map->map[s] = id;
1912 stat_config.aggr_map = cpu_aggr_map__new(evsel_list->core.user_requested_cpus,
1913 get_id, env, needs_sort);
1914 if (!stat_config.aggr_map) {
1915 pr_err("cannot build %s map\n", aggr_mode__string[stat_config.aggr_mode]);
1918 stat_config.aggr_get_id = aggr_mode__get_id_file(stat_config.aggr_mode);
1923 * Add default attributes, if there were no attributes specified or
1924 * if -d/--detailed, -d -d or -d -d -d is used:
1926 static int add_default_attributes(void)
1928 struct perf_event_attr default_attrs0[] = {
1930 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_TASK_CLOCK },
1931 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_CONTEXT_SWITCHES },
1932 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_CPU_MIGRATIONS },
1933 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_PAGE_FAULTS },
1935 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_CPU_CYCLES },
1937 struct perf_event_attr frontend_attrs[] = {
1938 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_STALLED_CYCLES_FRONTEND },
1940 struct perf_event_attr backend_attrs[] = {
1941 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_STALLED_CYCLES_BACKEND },
1943 struct perf_event_attr default_attrs1[] = {
1944 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_INSTRUCTIONS },
1945 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_BRANCH_INSTRUCTIONS },
1946 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_BRANCH_MISSES },
1951 * Detailed stats (-d), covering the L1 and last level data caches:
1953 struct perf_event_attr detailed_attrs[] = {
1955 { .type = PERF_TYPE_HW_CACHE,
1957 PERF_COUNT_HW_CACHE_L1D << 0 |
1958 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1959 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1961 { .type = PERF_TYPE_HW_CACHE,
1963 PERF_COUNT_HW_CACHE_L1D << 0 |
1964 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1965 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1967 { .type = PERF_TYPE_HW_CACHE,
1969 PERF_COUNT_HW_CACHE_LL << 0 |
1970 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1971 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1973 { .type = PERF_TYPE_HW_CACHE,
1975 PERF_COUNT_HW_CACHE_LL << 0 |
1976 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1977 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1981 * Very detailed stats (-d -d), covering the instruction cache and the TLB caches:
1983 struct perf_event_attr very_detailed_attrs[] = {
1985 { .type = PERF_TYPE_HW_CACHE,
1987 PERF_COUNT_HW_CACHE_L1I << 0 |
1988 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1989 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1991 { .type = PERF_TYPE_HW_CACHE,
1993 PERF_COUNT_HW_CACHE_L1I << 0 |
1994 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1995 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1997 { .type = PERF_TYPE_HW_CACHE,
1999 PERF_COUNT_HW_CACHE_DTLB << 0 |
2000 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
2001 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
2003 { .type = PERF_TYPE_HW_CACHE,
2005 PERF_COUNT_HW_CACHE_DTLB << 0 |
2006 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
2007 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
2009 { .type = PERF_TYPE_HW_CACHE,
2011 PERF_COUNT_HW_CACHE_ITLB << 0 |
2012 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
2013 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
2015 { .type = PERF_TYPE_HW_CACHE,
2017 PERF_COUNT_HW_CACHE_ITLB << 0 |
2018 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
2019 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
2024 * Very, very detailed stats (-d -d -d), adding prefetch events:
2026 struct perf_event_attr very_very_detailed_attrs[] = {
2028 { .type = PERF_TYPE_HW_CACHE,
2030 PERF_COUNT_HW_CACHE_L1D << 0 |
2031 (PERF_COUNT_HW_CACHE_OP_PREFETCH << 8) |
2032 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
2034 { .type = PERF_TYPE_HW_CACHE,
2036 PERF_COUNT_HW_CACHE_L1D << 0 |
2037 (PERF_COUNT_HW_CACHE_OP_PREFETCH << 8) |
2038 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
2041 struct perf_event_attr default_null_attrs[] = {};
2042 const char *pmu = parse_events_option_args.pmu_filter ?: "all";
2044 /* Set attrs if no event is selected and !null_run: */
2045 if (stat_config.null_run)
2048 if (transaction_run) {
2049 /* Handle -T as -M transaction. Once platform specific metrics
2050 * support has been added to the json files, all architectures
2051 * will use this approach. To determine transaction support
2052 * on an architecture test for such a metric name.
2054 if (!metricgroup__has_metric(pmu, "transaction")) {
2055 pr_err("Missing transaction metrics\n");
2058 return metricgroup__parse_groups(evsel_list, pmu, "transaction",
2059 stat_config.metric_no_group,
2060 stat_config.metric_no_merge,
2061 stat_config.metric_no_threshold,
2062 stat_config.user_requested_cpu_list,
2063 stat_config.system_wide,
2064 &stat_config.metric_events);
2070 if (sysfs__read_int(FREEZE_ON_SMI_PATH, &smi) < 0) {
2071 pr_err("freeze_on_smi is not supported.\n");
2076 if (sysfs__write_int(FREEZE_ON_SMI_PATH, 1) < 0) {
2077 fprintf(stderr, "Failed to set freeze_on_smi.\n");
2083 if (!metricgroup__has_metric(pmu, "smi")) {
2084 pr_err("Missing smi metrics\n");
2088 if (!force_metric_only)
2089 stat_config.metric_only = true;
2091 return metricgroup__parse_groups(evsel_list, pmu, "smi",
2092 stat_config.metric_no_group,
2093 stat_config.metric_no_merge,
2094 stat_config.metric_no_threshold,
2095 stat_config.user_requested_cpu_list,
2096 stat_config.system_wide,
2097 &stat_config.metric_events);
2101 unsigned int max_level = metricgroups__topdown_max_level();
2102 char str[] = "TopdownL1";
2104 if (!force_metric_only)
2105 stat_config.metric_only = true;
2108 pr_err("Topdown requested but the topdown metric groups aren't present.\n"
2109 "(See perf list the metric groups have names like TopdownL1)\n");
2112 if (stat_config.topdown_level > max_level) {
2113 pr_err("Invalid top-down metrics level. The max level is %u.\n", max_level);
2115 } else if (!stat_config.topdown_level)
2116 stat_config.topdown_level = 1;
2118 if (!stat_config.interval && !stat_config.metric_only) {
2119 fprintf(stat_config.output,
2120 "Topdown accuracy may decrease when measuring long periods.\n"
2121 "Please print the result regularly, e.g. -I1000\n");
2123 str[8] = stat_config.topdown_level + '0';
2124 if (metricgroup__parse_groups(evsel_list,
2126 /*metric_no_group=*/false,
2127 /*metric_no_merge=*/false,
2128 /*metric_no_threshold=*/true,
2129 stat_config.user_requested_cpu_list,
2130 stat_config.system_wide,
2131 &stat_config.metric_events) < 0)
2135 if (!stat_config.topdown_level)
2136 stat_config.topdown_level = 1;
2138 if (!evsel_list->core.nr_entries) {
2139 /* No events so add defaults. */
2140 if (target__has_cpu(&target))
2141 default_attrs0[0].config = PERF_COUNT_SW_CPU_CLOCK;
2143 if (evlist__add_default_attrs(evsel_list, default_attrs0) < 0)
2145 if (perf_pmus__have_event("cpu", "stalled-cycles-frontend")) {
2146 if (evlist__add_default_attrs(evsel_list, frontend_attrs) < 0)
2149 if (perf_pmus__have_event("cpu", "stalled-cycles-backend")) {
2150 if (evlist__add_default_attrs(evsel_list, backend_attrs) < 0)
2153 if (evlist__add_default_attrs(evsel_list, default_attrs1) < 0)
2156 * Add TopdownL1 metrics if they exist. To minimize
2157 * multiplexing, don't request threshold computation.
2159 if (metricgroup__has_metric(pmu, "Default")) {
2160 struct evlist *metric_evlist = evlist__new();
2161 struct evsel *metric_evsel;
2166 if (metricgroup__parse_groups(metric_evlist, pmu, "Default",
2167 /*metric_no_group=*/false,
2168 /*metric_no_merge=*/false,
2169 /*metric_no_threshold=*/true,
2170 stat_config.user_requested_cpu_list,
2171 stat_config.system_wide,
2172 &stat_config.metric_events) < 0)
2175 evlist__for_each_entry(metric_evlist, metric_evsel) {
2176 metric_evsel->skippable = true;
2177 metric_evsel->default_metricgroup = true;
2179 evlist__splice_list_tail(evsel_list, &metric_evlist->core.entries);
2180 evlist__delete(metric_evlist);
2183 /* Platform specific attrs */
2184 if (evlist__add_default_attrs(evsel_list, default_null_attrs) < 0)
2188 /* Detailed events get appended to the event list: */
2190 if (detailed_run < 1)
2193 /* Append detailed run extra attributes: */
2194 if (evlist__add_default_attrs(evsel_list, detailed_attrs) < 0)
2197 if (detailed_run < 2)
2200 /* Append very detailed run extra attributes: */
2201 if (evlist__add_default_attrs(evsel_list, very_detailed_attrs) < 0)
2204 if (detailed_run < 3)
2207 /* Append very, very detailed run extra attributes: */
2208 return evlist__add_default_attrs(evsel_list, very_very_detailed_attrs);
2211 static const char * const stat_record_usage[] = {
2212 "perf stat record [<options>]",
2216 static void init_features(struct perf_session *session)
2220 for (feat = HEADER_FIRST_FEATURE; feat < HEADER_LAST_FEATURE; feat++)
2221 perf_header__set_feat(&session->header, feat);
2223 perf_header__clear_feat(&session->header, HEADER_DIR_FORMAT);
2224 perf_header__clear_feat(&session->header, HEADER_BUILD_ID);
2225 perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);
2226 perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
2227 perf_header__clear_feat(&session->header, HEADER_AUXTRACE);
2230 static int __cmd_record(int argc, const char **argv)
2232 struct perf_session *session;
2233 struct perf_data *data = &perf_stat.data;
2235 argc = parse_options(argc, argv, stat_options, stat_record_usage,
2236 PARSE_OPT_STOP_AT_NON_OPTION);
2239 data->path = output_name;
2241 if (stat_config.run_count != 1 || forever) {
2242 pr_err("Cannot use -r option with perf stat record.\n");
2246 session = perf_session__new(data, NULL);
2247 if (IS_ERR(session)) {
2248 pr_err("Perf session creation failed\n");
2249 return PTR_ERR(session);
2252 init_features(session);
2254 session->evlist = evsel_list;
2255 perf_stat.session = session;
2256 perf_stat.record = true;
2260 static int process_stat_round_event(struct perf_session *session,
2261 union perf_event *event)
2263 struct perf_record_stat_round *stat_round = &event->stat_round;
2264 struct timespec tsh, *ts = NULL;
2265 const char **argv = session->header.env.cmdline_argv;
2266 int argc = session->header.env.nr_cmdline;
2270 if (stat_round->type == PERF_STAT_ROUND_TYPE__FINAL)
2271 update_stats(&walltime_nsecs_stats, stat_round->time);
2273 if (stat_config.interval && stat_round->time) {
2274 tsh.tv_sec = stat_round->time / NSEC_PER_SEC;
2275 tsh.tv_nsec = stat_round->time % NSEC_PER_SEC;
2279 print_counters(ts, argc, argv);
2284 int process_stat_config_event(struct perf_session *session,
2285 union perf_event *event)
2287 struct perf_tool *tool = session->tool;
2288 struct perf_stat *st = container_of(tool, struct perf_stat, tool);
2290 perf_event__read_stat_config(&stat_config, &event->stat_config);
2292 if (perf_cpu_map__empty(st->cpus)) {
2293 if (st->aggr_mode != AGGR_UNSET)
2294 pr_warning("warning: processing task data, aggregation mode not set\n");
2295 } else if (st->aggr_mode != AGGR_UNSET) {
2296 stat_config.aggr_mode = st->aggr_mode;
2299 if (perf_stat.data.is_pipe)
2300 perf_stat_init_aggr_mode();
2302 perf_stat_init_aggr_mode_file(st);
2304 if (stat_config.aggr_map) {
2305 int nr_aggr = stat_config.aggr_map->nr;
2307 if (evlist__alloc_aggr_stats(session->evlist, nr_aggr) < 0) {
2308 pr_err("cannot allocate aggr counts\n");
2315 static int set_maps(struct perf_stat *st)
2317 if (!st->cpus || !st->threads)
2320 if (WARN_ONCE(st->maps_allocated, "stats double allocation\n"))
2323 perf_evlist__set_maps(&evsel_list->core, st->cpus, st->threads);
2325 if (evlist__alloc_stats(&stat_config, evsel_list, /*alloc_raw=*/true))
2328 st->maps_allocated = true;
2333 int process_thread_map_event(struct perf_session *session,
2334 union perf_event *event)
2336 struct perf_tool *tool = session->tool;
2337 struct perf_stat *st = container_of(tool, struct perf_stat, tool);
2340 pr_warning("Extra thread map event, ignoring.\n");
2344 st->threads = thread_map__new_event(&event->thread_map);
2348 return set_maps(st);
2352 int process_cpu_map_event(struct perf_session *session,
2353 union perf_event *event)
2355 struct perf_tool *tool = session->tool;
2356 struct perf_stat *st = container_of(tool, struct perf_stat, tool);
2357 struct perf_cpu_map *cpus;
2360 pr_warning("Extra cpu map event, ignoring.\n");
2364 cpus = cpu_map__new_data(&event->cpu_map.data);
2369 return set_maps(st);
2372 static const char * const stat_report_usage[] = {
2373 "perf stat report [<options>]",
2377 static struct perf_stat perf_stat = {
2379 .attr = perf_event__process_attr,
2380 .event_update = perf_event__process_event_update,
2381 .thread_map = process_thread_map_event,
2382 .cpu_map = process_cpu_map_event,
2383 .stat_config = process_stat_config_event,
2384 .stat = perf_event__process_stat_event,
2385 .stat_round = process_stat_round_event,
2387 .aggr_mode = AGGR_UNSET,
2391 static int __cmd_report(int argc, const char **argv)
2393 struct perf_session *session;
2394 const struct option options[] = {
2395 OPT_STRING('i', "input", &input_name, "file", "input file name"),
2396 OPT_SET_UINT(0, "per-socket", &perf_stat.aggr_mode,
2397 "aggregate counts per processor socket", AGGR_SOCKET),
2398 OPT_SET_UINT(0, "per-die", &perf_stat.aggr_mode,
2399 "aggregate counts per processor die", AGGR_DIE),
2400 OPT_CALLBACK_OPTARG(0, "per-cache", &perf_stat.aggr_mode, &perf_stat.aggr_level,
2402 "aggregate count at this cache level (Default: LLC)",
2404 OPT_SET_UINT(0, "per-core", &perf_stat.aggr_mode,
2405 "aggregate counts per physical processor core", AGGR_CORE),
2406 OPT_SET_UINT(0, "per-node", &perf_stat.aggr_mode,
2407 "aggregate counts per numa node", AGGR_NODE),
2408 OPT_SET_UINT('A', "no-aggr", &perf_stat.aggr_mode,
2409 "disable CPU count aggregation", AGGR_NONE),
2415 argc = parse_options(argc, argv, options, stat_report_usage, 0);
2417 if (!input_name || !strlen(input_name)) {
2418 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
2421 input_name = "perf.data";
2424 perf_stat.data.path = input_name;
2425 perf_stat.data.mode = PERF_DATA_MODE_READ;
2427 session = perf_session__new(&perf_stat.data, &perf_stat.tool);
2428 if (IS_ERR(session))
2429 return PTR_ERR(session);
2431 perf_stat.session = session;
2432 stat_config.output = stderr;
2433 evlist__delete(evsel_list);
2434 evsel_list = session->evlist;
2436 ret = perf_session__process_events(session);
2440 perf_session__delete(session);
2444 static void setup_system_wide(int forks)
2447 * Make system wide (-a) the default target if
2448 * no target was specified and one of following
2449 * conditions is met:
2451 * - there's no workload specified
2452 * - there is workload specified but all requested
2453 * events are system wide events
2455 if (!target__none(&target))
2459 target.system_wide = true;
2461 struct evsel *counter;
2463 evlist__for_each_entry(evsel_list, counter) {
2464 if (!counter->core.requires_cpu &&
2465 !evsel__name_is(counter, "duration_time")) {
2470 if (evsel_list->core.nr_entries)
2471 target.system_wide = true;
2475 int cmd_stat(int argc, const char **argv)
2477 const char * const stat_usage[] = {
2478 "perf stat [<options>] [<command>]",
2481 int status = -EINVAL, run_idx, err;
2483 FILE *output = stderr;
2484 unsigned int interval, timeout;
2485 const char * const stat_subcommands[] = { "record", "report" };
2486 char errbuf[BUFSIZ];
2488 setlocale(LC_ALL, "");
2490 evsel_list = evlist__new();
2491 if (evsel_list == NULL)
2494 parse_events__shrink_config_terms();
2496 /* String-parsing callback-based options would segfault when negated */
2497 set_option_flag(stat_options, 'e', "event", PARSE_OPT_NONEG);
2498 set_option_flag(stat_options, 'M', "metrics", PARSE_OPT_NONEG);
2499 set_option_flag(stat_options, 'G', "cgroup", PARSE_OPT_NONEG);
2501 argc = parse_options_subcommand(argc, argv, stat_options, stat_subcommands,
2502 (const char **) stat_usage,
2503 PARSE_OPT_STOP_AT_NON_OPTION);
2505 if (stat_config.csv_sep) {
2506 stat_config.csv_output = true;
2507 if (!strcmp(stat_config.csv_sep, "\\t"))
2508 stat_config.csv_sep = "\t";
2510 stat_config.csv_sep = DEFAULT_SEPARATOR;
2512 if (argc && strlen(argv[0]) > 2 && strstarts("record", argv[0])) {
2513 argc = __cmd_record(argc, argv);
2516 } else if (argc && strlen(argv[0]) > 2 && strstarts("report", argv[0]))
2517 return __cmd_report(argc, argv);
2519 interval = stat_config.interval;
2520 timeout = stat_config.timeout;
2523 * For record command the -o is already taken care of.
2525 if (!STAT_RECORD && output_name && strcmp(output_name, "-"))
2528 if (output_name && output_fd) {
2529 fprintf(stderr, "cannot use both --output and --log-fd\n");
2530 parse_options_usage(stat_usage, stat_options, "o", 1);
2531 parse_options_usage(NULL, stat_options, "log-fd", 0);
2535 if (stat_config.metric_only && stat_config.aggr_mode == AGGR_THREAD) {
2536 fprintf(stderr, "--metric-only is not supported with --per-thread\n");
2540 if (stat_config.metric_only && stat_config.run_count > 1) {
2541 fprintf(stderr, "--metric-only is not supported with -r\n");
2545 if (stat_config.walltime_run_table && stat_config.run_count <= 1) {
2546 fprintf(stderr, "--table is only supported with -r\n");
2547 parse_options_usage(stat_usage, stat_options, "r", 1);
2548 parse_options_usage(NULL, stat_options, "table", 0);
2552 if (output_fd < 0) {
2553 fprintf(stderr, "argument to --log-fd must be a > 0\n");
2554 parse_options_usage(stat_usage, stat_options, "log-fd", 0);
2558 if (!output && !quiet) {
2560 mode = append_file ? "a" : "w";
2562 output = fopen(output_name, mode);
2564 perror("failed to create output file");
2567 if (!stat_config.json_output) {
2568 clock_gettime(CLOCK_REALTIME, &tm);
2569 fprintf(output, "# started on %s\n", ctime(&tm.tv_sec));
2571 } else if (output_fd > 0) {
2572 mode = append_file ? "a" : "w";
2573 output = fdopen(output_fd, mode);
2575 perror("Failed opening logfd");
2580 if (stat_config.interval_clear && !isatty(fileno(output))) {
2581 fprintf(stderr, "--interval-clear does not work with output\n");
2582 parse_options_usage(stat_usage, stat_options, "o", 1);
2583 parse_options_usage(NULL, stat_options, "log-fd", 0);
2584 parse_options_usage(NULL, stat_options, "interval-clear", 0);
2588 stat_config.output = output;
2591 * let the spreadsheet do the pretty-printing
2593 if (stat_config.csv_output) {
2594 /* User explicitly passed -B? */
2595 if (big_num_opt == 1) {
2596 fprintf(stderr, "-B option not supported with -x\n");
2597 parse_options_usage(stat_usage, stat_options, "B", 1);
2598 parse_options_usage(NULL, stat_options, "x", 1);
2600 } else /* Nope, so disable big number formatting */
2601 stat_config.big_num = false;
2602 } else if (big_num_opt == 0) /* User passed --no-big-num */
2603 stat_config.big_num = false;
2605 err = target__validate(&target);
2607 target__strerror(&target, err, errbuf, BUFSIZ);
2608 pr_warning("%s\n", errbuf);
2611 setup_system_wide(argc);
2614 * Display user/system times only for single
2615 * run and when there's specified tracee.
2617 if ((stat_config.run_count == 1) && target__none(&target))
2618 stat_config.ru_display = true;
2620 if (stat_config.run_count < 0) {
2621 pr_err("Run count must be a positive number\n");
2622 parse_options_usage(stat_usage, stat_options, "r", 1);
2624 } else if (stat_config.run_count == 0) {
2626 stat_config.run_count = 1;
2629 if (stat_config.walltime_run_table) {
2630 stat_config.walltime_run = zalloc(stat_config.run_count * sizeof(stat_config.walltime_run[0]));
2631 if (!stat_config.walltime_run) {
2632 pr_err("failed to setup -r option");
2637 if ((stat_config.aggr_mode == AGGR_THREAD) &&
2638 !target__has_task(&target)) {
2639 if (!target.system_wide || target.cpu_list) {
2640 fprintf(stderr, "The --per-thread option is only "
2641 "available when monitoring via -p -t -a "
2642 "options or only --per-thread.\n");
2643 parse_options_usage(NULL, stat_options, "p", 1);
2644 parse_options_usage(NULL, stat_options, "t", 1);
2650 * no_aggr, cgroup are for system-wide only
2651 * --per-thread is aggregated per thread, we dont mix it with cpu mode
2653 if (((stat_config.aggr_mode != AGGR_GLOBAL &&
2654 stat_config.aggr_mode != AGGR_THREAD) ||
2655 (nr_cgroups || stat_config.cgroup_list)) &&
2656 !target__has_cpu(&target)) {
2657 fprintf(stderr, "both cgroup and no-aggregation "
2658 "modes only available in system-wide mode\n");
2660 parse_options_usage(stat_usage, stat_options, "G", 1);
2661 parse_options_usage(NULL, stat_options, "A", 1);
2662 parse_options_usage(NULL, stat_options, "a", 1);
2663 parse_options_usage(NULL, stat_options, "for-each-cgroup", 0);
2667 if (stat_config.iostat_run) {
2668 status = iostat_prepare(evsel_list, &stat_config);
2671 if (iostat_mode == IOSTAT_LIST) {
2672 iostat_list(evsel_list, &stat_config);
2674 } else if (verbose > 0)
2675 iostat_list(evsel_list, &stat_config);
2676 if (iostat_mode == IOSTAT_RUN && !target__has_cpu(&target))
2677 target.system_wide = true;
2680 if ((stat_config.aggr_mode == AGGR_THREAD) && (target.system_wide))
2681 target.per_thread = true;
2683 stat_config.system_wide = target.system_wide;
2684 if (target.cpu_list) {
2685 stat_config.user_requested_cpu_list = strdup(target.cpu_list);
2686 if (!stat_config.user_requested_cpu_list) {
2693 * Metric parsing needs to be delayed as metrics may optimize events
2694 * knowing the target is system-wide.
2697 const char *pmu = parse_events_option_args.pmu_filter ?: "all";
2699 metricgroup__parse_groups(evsel_list, pmu, metrics,
2700 stat_config.metric_no_group,
2701 stat_config.metric_no_merge,
2702 stat_config.metric_no_threshold,
2703 stat_config.user_requested_cpu_list,
2704 stat_config.system_wide,
2705 &stat_config.metric_events);
2709 if (add_default_attributes())
2712 if (stat_config.cgroup_list) {
2713 if (nr_cgroups > 0) {
2714 pr_err("--cgroup and --for-each-cgroup cannot be used together\n");
2715 parse_options_usage(stat_usage, stat_options, "G", 1);
2716 parse_options_usage(NULL, stat_options, "for-each-cgroup", 0);
2720 if (evlist__expand_cgroup(evsel_list, stat_config.cgroup_list,
2721 &stat_config.metric_events, true) < 0) {
2722 parse_options_usage(stat_usage, stat_options,
2723 "for-each-cgroup", 0);
2728 evlist__warn_user_requested_cpus(evsel_list, target.cpu_list);
2730 if (evlist__create_maps(evsel_list, &target) < 0) {
2731 if (target__has_task(&target)) {
2732 pr_err("Problems finding threads of monitor\n");
2733 parse_options_usage(stat_usage, stat_options, "p", 1);
2734 parse_options_usage(NULL, stat_options, "t", 1);
2735 } else if (target__has_cpu(&target)) {
2736 perror("failed to parse CPUs map");
2737 parse_options_usage(stat_usage, stat_options, "C", 1);
2738 parse_options_usage(NULL, stat_options, "a", 1);
2743 evlist__check_cpu_maps(evsel_list);
2746 * Initialize thread_map with comm names,
2747 * so we could print it out on output.
2749 if (stat_config.aggr_mode == AGGR_THREAD) {
2750 thread_map__read_comms(evsel_list->core.threads);
2753 if (stat_config.aggr_mode == AGGR_NODE)
2754 cpu__setup_cpunode_map();
2756 if (stat_config.times && interval)
2757 interval_count = true;
2758 else if (stat_config.times && !interval) {
2759 pr_err("interval-count option should be used together with "
2760 "interval-print.\n");
2761 parse_options_usage(stat_usage, stat_options, "interval-count", 0);
2762 parse_options_usage(stat_usage, stat_options, "I", 1);
2766 if (timeout && timeout < 100) {
2768 pr_err("timeout must be >= 10ms.\n");
2769 parse_options_usage(stat_usage, stat_options, "timeout", 0);
2772 pr_warning("timeout < 100ms. "
2773 "The overhead percentage could be high in some cases. "
2774 "Please proceed with caution.\n");
2776 if (timeout && interval) {
2777 pr_err("timeout option is not supported with interval-print.\n");
2778 parse_options_usage(stat_usage, stat_options, "timeout", 0);
2779 parse_options_usage(stat_usage, stat_options, "I", 1);
2783 if (perf_stat_init_aggr_mode())
2786 if (evlist__alloc_stats(&stat_config, evsel_list, interval))
2790 * Set sample_type to PERF_SAMPLE_IDENTIFIER, which should be harmless
2791 * while avoiding that older tools show confusing messages.
2793 * However for pipe sessions we need to keep it zero,
2794 * because script's perf_evsel__check_attr is triggered
2795 * by attr->sample_type != 0, and we can't run it on
2798 stat_config.identifier = !(STAT_RECORD && perf_stat.data.is_pipe);
2801 * We dont want to block the signals - that would cause
2802 * child tasks to inherit that and Ctrl-C would not work.
2803 * What we want is for Ctrl-C to work in the exec()-ed
2804 * task, but being ignored by perf stat itself:
2808 signal(SIGINT, skip_signal);
2809 signal(SIGCHLD, skip_signal);
2810 signal(SIGALRM, skip_signal);
2811 signal(SIGABRT, skip_signal);
2813 if (evlist__initialize_ctlfd(evsel_list, stat_config.ctl_fd, stat_config.ctl_fd_ack))
2816 /* Enable ignoring missing threads when -p option is defined. */
2817 evlist__first(evsel_list)->ignore_missing_thread = target.pid;
2819 for (run_idx = 0; forever || run_idx < stat_config.run_count; run_idx++) {
2820 if (stat_config.run_count != 1 && verbose > 0)
2821 fprintf(output, "[ perf stat: executing run #%d ... ]\n",
2825 evlist__reset_prev_raw_counts(evsel_list);
2827 status = run_perf_stat(argc, argv, run_idx);
2828 if (forever && status != -1 && !interval) {
2829 print_counters(NULL, argc, argv);
2830 perf_stat__reset_stats();
2834 if (!forever && status != -1 && (!interval || stat_config.summary)) {
2835 if (stat_config.run_count > 1)
2836 evlist__copy_res_stats(&stat_config, evsel_list);
2837 print_counters(NULL, argc, argv);
2840 evlist__finalize_ctlfd(evsel_list);
2844 * We synthesize the kernel mmap record just so that older tools
2845 * don't emit warnings about not being able to resolve symbols
2846 * due to /proc/sys/kernel/kptr_restrict settings and instead provide
2847 * a saner message about no samples being in the perf.data file.
2849 * This also serves to suppress a warning about f_header.data.size == 0
2850 * in header.c at the moment 'perf stat record' gets introduced, which
2851 * is not really needed once we start adding the stat specific PERF_RECORD_
2852 * records, but the need to suppress the kptr_restrict messages in older
2853 * tools remain -acme
2855 int fd = perf_data__fd(&perf_stat.data);
2857 err = perf_event__synthesize_kernel_mmap((void *)&perf_stat,
2858 process_synthesized_event,
2859 &perf_stat.session->machines.host);
2861 pr_warning("Couldn't synthesize the kernel mmap record, harmless, "
2862 "older tools may produce warnings about this file\n.");
2866 if (WRITE_STAT_ROUND_EVENT(walltime_nsecs_stats.max, FINAL))
2867 pr_err("failed to write stat round event\n");
2870 if (!perf_stat.data.is_pipe) {
2871 perf_stat.session->header.data_size += perf_stat.bytes_written;
2872 perf_session__write_header(perf_stat.session, evsel_list, fd, true);
2875 evlist__close(evsel_list);
2876 perf_session__delete(perf_stat.session);
2879 perf_stat__exit_aggr_mode();
2880 evlist__free_stats(evsel_list);
2882 if (stat_config.iostat_run)
2883 iostat_release(evsel_list);
2885 zfree(&stat_config.walltime_run);
2886 zfree(&stat_config.user_requested_cpu_list);
2888 if (smi_cost && smi_reset)
2889 sysfs__write_int(FREEZE_ON_SMI_PATH, 0);
2891 evlist__delete(evsel_list);
2893 metricgroup__rblist_exit(&stat_config.metric_events);
2894 evlist__close_control(stat_config.ctl_fd, stat_config.ctl_fd_ack, &stat_config.ctl_fd_close);