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>
45 #include "util/cgroup.h"
46 #include <subcmd/parse-options.h>
47 #include "util/parse-events.h"
49 #include "util/event.h"
50 #include "util/evlist.h"
51 #include "util/evsel.h"
52 #include "util/debug.h"
53 #include "util/color.h"
54 #include "util/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"
72 #include <linux/time64.h>
73 #include <linux/zalloc.h>
74 #include <api/fs/fs.h>
78 #include <sys/prctl.h>
82 #include <sys/types.h>
87 #include <sys/resource.h>
88 #include <linux/err.h>
90 #include <linux/ctype.h>
91 #include <perf/evlist.h>
93 #define DEFAULT_SEPARATOR " "
94 #define FREEZE_ON_SMI_PATH "devices/cpu/freeze_on_smi"
96 static void print_counters(struct timespec *ts, int argc, const char **argv);
98 /* Default events used for perf stat -T */
99 static const char *transaction_attrs = {
111 /* More limited version when the CPU does not have all events. */
112 static const char * transaction_limited_attrs = {
122 static const char * topdown_attrs[] = {
123 "topdown-total-slots",
124 "topdown-slots-retired",
125 "topdown-recovery-bubbles",
126 "topdown-fetch-bubbles",
127 "topdown-slots-issued",
131 static const char *topdown_metric_attrs[] = {
140 static const char *smi_cost_attrs = {
148 static struct evlist *evsel_list;
150 static struct target target = {
154 #define METRIC_ONLY_LEN 20
156 static volatile pid_t child_pid = -1;
157 static int detailed_run = 0;
158 static bool transaction_run;
159 static bool topdown_run = false;
160 static bool smi_cost = false;
161 static bool smi_reset = false;
162 static int big_num_opt = -1;
163 static bool group = false;
164 static const char *pre_cmd = NULL;
165 static const char *post_cmd = NULL;
166 static bool sync_run = false;
167 static bool forever = false;
168 static bool force_metric_only = false;
169 static struct timespec ref_time;
170 static bool append_file;
171 static bool interval_count;
172 static const char *output_name;
173 static int output_fd;
177 struct perf_data data;
178 struct perf_session *session;
180 struct perf_tool tool;
182 struct perf_cpu_map *cpus;
183 struct perf_thread_map *threads;
184 enum aggr_mode aggr_mode;
187 static struct perf_stat perf_stat;
188 #define STAT_RECORD perf_stat.record
190 static volatile int done = 0;
192 static struct perf_stat_config stat_config = {
193 .aggr_mode = AGGR_GLOBAL,
195 .unit_width = 4, /* strlen("unit") */
197 .metric_only_len = METRIC_ONLY_LEN,
198 .walltime_nsecs_stats = &walltime_nsecs_stats,
204 static bool cpus_map_matched(struct evsel *a, struct evsel *b)
206 if (!a->core.cpus && !b->core.cpus)
209 if (!a->core.cpus || !b->core.cpus)
212 if (a->core.cpus->nr != b->core.cpus->nr)
215 for (int i = 0; i < a->core.cpus->nr; i++) {
216 if (a->core.cpus->map[i] != b->core.cpus->map[i])
223 static void evlist__check_cpu_maps(struct evlist *evlist)
225 struct evsel *evsel, *pos, *leader;
228 evlist__for_each_entry(evlist, evsel) {
229 leader = evsel->leader;
231 /* Check that leader matches cpus with each member. */
234 if (cpus_map_matched(leader, evsel))
237 /* If there's mismatch disable the group and warn user. */
238 WARN_ONCE(1, "WARNING: grouped events cpus do not match, disabling group:\n");
239 evsel__group_desc(leader, buf, sizeof(buf));
240 pr_warning(" %s\n", buf);
243 cpu_map__snprint(leader->core.cpus, buf, sizeof(buf));
244 pr_warning(" %s: %s\n", leader->name, buf);
245 cpu_map__snprint(evsel->core.cpus, buf, sizeof(buf));
246 pr_warning(" %s: %s\n", evsel->name, buf);
249 for_each_group_evsel(pos, leader) {
251 pos->core.nr_members = 0;
253 evsel->leader->core.nr_members = 0;
257 static inline void diff_timespec(struct timespec *r, struct timespec *a,
260 r->tv_sec = a->tv_sec - b->tv_sec;
261 if (a->tv_nsec < b->tv_nsec) {
262 r->tv_nsec = a->tv_nsec + NSEC_PER_SEC - b->tv_nsec;
265 r->tv_nsec = a->tv_nsec - b->tv_nsec ;
269 static void perf_stat__reset_stats(void)
273 perf_evlist__reset_stats(evsel_list);
274 perf_stat__reset_shadow_stats();
276 for (i = 0; i < stat_config.stats_num; i++)
277 perf_stat__reset_shadow_per_stat(&stat_config.stats[i]);
280 static int process_synthesized_event(struct perf_tool *tool __maybe_unused,
281 union perf_event *event,
282 struct perf_sample *sample __maybe_unused,
283 struct machine *machine __maybe_unused)
285 if (perf_data__write(&perf_stat.data, event, event->header.size) < 0) {
286 pr_err("failed to write perf data, error: %m\n");
290 perf_stat.bytes_written += event->header.size;
294 static int write_stat_round_event(u64 tm, u64 type)
296 return perf_event__synthesize_stat_round(NULL, tm, type,
297 process_synthesized_event,
301 #define WRITE_STAT_ROUND_EVENT(time, interval) \
302 write_stat_round_event(time, PERF_STAT_ROUND_TYPE__ ## interval)
304 #define SID(e, x, y) xyarray__entry(e->core.sample_id, x, y)
306 static int evsel__write_stat_event(struct evsel *counter, u32 cpu, u32 thread,
307 struct perf_counts_values *count)
309 struct perf_sample_id *sid = SID(counter, cpu, thread);
311 return perf_event__synthesize_stat(NULL, cpu, thread, sid->id, count,
312 process_synthesized_event, NULL);
315 static int read_single_counter(struct evsel *counter, int cpu,
316 int thread, struct timespec *rs)
318 if (counter->tool_event == PERF_TOOL_DURATION_TIME) {
319 u64 val = rs->tv_nsec + rs->tv_sec*1000000000ULL;
320 struct perf_counts_values *count =
321 perf_counts(counter->counts, cpu, thread);
322 count->ena = count->run = val;
326 return evsel__read_counter(counter, cpu, thread);
330 * Read out the results of a single counter:
331 * do not aggregate counts across CPUs in system-wide mode
333 static int read_counter_cpu(struct evsel *counter, struct timespec *rs, int cpu)
335 int nthreads = perf_thread_map__nr(evsel_list->core.threads);
338 if (!counter->supported)
341 if (counter->core.system_wide)
344 for (thread = 0; thread < nthreads; thread++) {
345 struct perf_counts_values *count;
347 count = perf_counts(counter->counts, cpu, thread);
350 * The leader's group read loads data into its group members
351 * (via evsel__read_counter()) and sets their count->loaded.
353 if (!perf_counts__is_loaded(counter->counts, cpu, thread) &&
354 read_single_counter(counter, cpu, thread, rs)) {
355 counter->counts->scaled = -1;
356 perf_counts(counter->counts, cpu, thread)->ena = 0;
357 perf_counts(counter->counts, cpu, thread)->run = 0;
361 perf_counts__set_loaded(counter->counts, cpu, thread, false);
364 if (evsel__write_stat_event(counter, cpu, thread, count)) {
365 pr_err("failed to write stat event\n");
371 fprintf(stat_config.output,
372 "%s: %d: %" PRIu64 " %" PRIu64 " %" PRIu64 "\n",
373 evsel__name(counter),
375 count->val, count->ena, count->run);
382 static int read_affinity_counters(struct timespec *rs)
384 struct evsel *counter;
385 struct affinity affinity;
388 if (affinity__setup(&affinity) < 0)
391 ncpus = perf_cpu_map__nr(evsel_list->core.all_cpus);
392 if (!target__has_cpu(&target) || target__has_per_thread(&target))
394 evlist__for_each_cpu(evsel_list, i, cpu) {
397 affinity__set(&affinity, cpu);
399 evlist__for_each_entry(evsel_list, counter) {
400 if (evsel__cpu_iter_skip(counter, cpu))
403 counter->err = read_counter_cpu(counter, rs,
404 counter->cpu_iter - 1);
408 affinity__cleanup(&affinity);
412 static void read_counters(struct timespec *rs)
414 struct evsel *counter;
416 if (!stat_config.stop_read_counter && (read_affinity_counters(rs) < 0))
419 evlist__for_each_entry(evsel_list, counter) {
421 pr_debug("failed to read counter %s\n", counter->name);
422 if (counter->err == 0 && perf_stat_process_counter(&stat_config, counter))
423 pr_warning("failed to process counter %s\n", counter->name);
428 static int runtime_stat_new(struct perf_stat_config *config, int nthreads)
432 config->stats = calloc(nthreads, sizeof(struct runtime_stat));
436 config->stats_num = nthreads;
438 for (i = 0; i < nthreads; i++)
439 runtime_stat__init(&config->stats[i]);
444 static void runtime_stat_delete(struct perf_stat_config *config)
451 for (i = 0; i < config->stats_num; i++)
452 runtime_stat__exit(&config->stats[i]);
454 zfree(&config->stats);
457 static void runtime_stat_reset(struct perf_stat_config *config)
464 for (i = 0; i < config->stats_num; i++)
465 perf_stat__reset_shadow_per_stat(&config->stats[i]);
468 static void process_interval(void)
470 struct timespec ts, rs;
472 clock_gettime(CLOCK_MONOTONIC, &ts);
473 diff_timespec(&rs, &ts, &ref_time);
475 perf_stat__reset_shadow_per_stat(&rt_stat);
476 runtime_stat_reset(&stat_config);
480 if (WRITE_STAT_ROUND_EVENT(rs.tv_sec * NSEC_PER_SEC + rs.tv_nsec, INTERVAL))
481 pr_err("failed to write stat round event\n");
484 init_stats(&walltime_nsecs_stats);
485 update_stats(&walltime_nsecs_stats, stat_config.interval * 1000000ULL);
486 print_counters(&rs, 0, NULL);
489 static bool handle_interval(unsigned int interval, int *times)
493 if (interval_count && !(--(*times)))
499 static void enable_counters(void)
501 if (stat_config.initial_delay < 0) {
502 pr_info(EVLIST_DISABLED_MSG);
506 if (stat_config.initial_delay > 0) {
507 pr_info(EVLIST_DISABLED_MSG);
508 usleep(stat_config.initial_delay * USEC_PER_MSEC);
512 * We need to enable counters only if:
513 * - we don't have tracee (attaching to task or cpu)
514 * - we have initial delay configured
516 if (!target__none(&target) || stat_config.initial_delay) {
517 evlist__enable(evsel_list);
518 if (stat_config.initial_delay > 0)
519 pr_info(EVLIST_ENABLED_MSG);
523 static void disable_counters(void)
526 * If we don't have tracee (attaching to task or cpu), counters may
527 * still be running. To get accurate group ratios, we must stop groups
528 * from counting before reading their constituent counters.
530 if (!target__none(&target))
531 evlist__disable(evsel_list);
534 static volatile int workload_exec_errno;
537 * perf_evlist__prepare_workload will send a SIGUSR1
538 * if the fork fails, since we asked by setting its
539 * want_signal to true.
541 static void workload_exec_failed_signal(int signo __maybe_unused, siginfo_t *info,
542 void *ucontext __maybe_unused)
544 workload_exec_errno = info->si_value.sival_int;
547 static bool evsel__should_store_id(struct evsel *counter)
549 return STAT_RECORD || counter->core.attr.read_format & PERF_FORMAT_ID;
552 static bool is_target_alive(struct target *_target,
553 struct perf_thread_map *threads)
558 if (!target__has_task(_target))
561 for (i = 0; i < threads->nr; i++) {
564 scnprintf(path, PATH_MAX, "%s/%d", procfs__mountpoint(),
565 threads->map[i].pid);
567 if (!stat(path, &st))
574 static void process_evlist(struct evlist *evlist, unsigned int interval)
576 enum evlist_ctl_cmd cmd = EVLIST_CTL_CMD_UNSUPPORTED;
578 if (evlist__ctlfd_process(evlist, &cmd) > 0) {
580 case EVLIST_CTL_CMD_ENABLE:
581 pr_info(EVLIST_ENABLED_MSG);
585 case EVLIST_CTL_CMD_DISABLE:
588 pr_info(EVLIST_DISABLED_MSG);
590 case EVLIST_CTL_CMD_SNAPSHOT:
591 case EVLIST_CTL_CMD_ACK:
592 case EVLIST_CTL_CMD_UNSUPPORTED:
599 static void compute_tts(struct timespec *time_start, struct timespec *time_stop,
602 int tts = *time_to_sleep;
603 struct timespec time_diff;
605 diff_timespec(&time_diff, time_stop, time_start);
607 tts -= time_diff.tv_sec * MSEC_PER_SEC +
608 time_diff.tv_nsec / NSEC_PER_MSEC;
613 *time_to_sleep = tts;
616 static int dispatch_events(bool forks, int timeout, int interval, int *times)
618 int child_exited = 0, status = 0;
619 int time_to_sleep, sleep_time;
620 struct timespec time_start, time_stop;
623 sleep_time = interval;
625 sleep_time = timeout;
629 time_to_sleep = sleep_time;
633 child_exited = waitpid(child_pid, &status, WNOHANG);
635 child_exited = !is_target_alive(&target, evsel_list->core.threads) ? 1 : 0;
640 clock_gettime(CLOCK_MONOTONIC, &time_start);
641 if (!(evlist__poll(evsel_list, time_to_sleep) > 0)) { /* poll timeout or EINTR */
642 if (timeout || handle_interval(interval, times))
644 time_to_sleep = sleep_time;
645 } else { /* fd revent */
646 process_evlist(evsel_list, interval);
647 clock_gettime(CLOCK_MONOTONIC, &time_stop);
648 compute_tts(&time_start, &time_stop, &time_to_sleep);
655 enum counter_recovery {
661 static enum counter_recovery stat_handle_error(struct evsel *counter)
665 * PPC returns ENXIO for HW counters until 2.6.37
666 * (behavior changed with commit b0a873e).
668 if (errno == EINVAL || errno == ENOSYS ||
669 errno == ENOENT || errno == EOPNOTSUPP ||
672 ui__warning("%s event is not supported by the kernel.\n",
673 evsel__name(counter));
674 counter->supported = false;
676 * errored is a sticky flag that means one of the counter's
677 * cpu event had a problem and needs to be reexamined.
679 counter->errored = true;
681 if ((counter->leader != counter) ||
682 !(counter->leader->core.nr_members > 1))
684 } else if (evsel__fallback(counter, errno, msg, sizeof(msg))) {
686 ui__warning("%s\n", msg);
687 return COUNTER_RETRY;
688 } else if (target__has_per_thread(&target) &&
689 evsel_list->core.threads &&
690 evsel_list->core.threads->err_thread != -1) {
692 * For global --per-thread case, skip current
695 if (!thread_map__remove(evsel_list->core.threads,
696 evsel_list->core.threads->err_thread)) {
697 evsel_list->core.threads->err_thread = -1;
698 return COUNTER_RETRY;
702 evsel__open_strerror(counter, &target, errno, msg, sizeof(msg));
703 ui__error("%s\n", msg);
706 kill(child_pid, SIGTERM);
707 return COUNTER_FATAL;
710 static int __run_perf_stat(int argc, const char **argv, int run_idx)
712 int interval = stat_config.interval;
713 int times = stat_config.times;
714 int timeout = stat_config.timeout;
716 unsigned long long t0, t1;
717 struct evsel *counter;
720 const bool forks = (argc > 0);
721 bool is_pipe = STAT_RECORD ? perf_stat.data.is_pipe : false;
722 struct affinity affinity;
724 bool second_pass = false;
727 if (perf_evlist__prepare_workload(evsel_list, &target, argv, is_pipe,
728 workload_exec_failed_signal) < 0) {
729 perror("failed to prepare workload");
732 child_pid = evsel_list->workload.pid;
736 perf_evlist__set_leader(evsel_list);
738 if (affinity__setup(&affinity) < 0)
741 evlist__for_each_cpu (evsel_list, i, cpu) {
742 affinity__set(&affinity, cpu);
744 evlist__for_each_entry(evsel_list, counter) {
745 if (evsel__cpu_iter_skip(counter, cpu))
747 if (counter->reset_group || counter->errored)
750 if (create_perf_stat_counter(counter, &stat_config, &target,
751 counter->cpu_iter - 1) < 0) {
754 * Weak group failed. We cannot just undo this here
755 * because earlier CPUs might be in group mode, and the kernel
756 * doesn't support mixing group and non group reads. Defer
758 * Don't close here because we're in the wrong affinity.
760 if ((errno == EINVAL || errno == EBADF) &&
761 counter->leader != counter &&
762 counter->weak_group) {
763 perf_evlist__reset_weak_group(evsel_list, counter, false);
764 assert(counter->reset_group);
769 switch (stat_handle_error(counter)) {
781 counter->supported = true;
787 * Now redo all the weak group after closing them,
788 * and also close errored counters.
791 evlist__for_each_cpu(evsel_list, i, cpu) {
792 affinity__set(&affinity, cpu);
793 /* First close errored or weak retry */
794 evlist__for_each_entry(evsel_list, counter) {
795 if (!counter->reset_group && !counter->errored)
797 if (evsel__cpu_iter_skip_no_inc(counter, cpu))
799 perf_evsel__close_cpu(&counter->core, counter->cpu_iter);
801 /* Now reopen weak */
802 evlist__for_each_entry(evsel_list, counter) {
803 if (!counter->reset_group && !counter->errored)
805 if (evsel__cpu_iter_skip(counter, cpu))
807 if (!counter->reset_group)
810 pr_debug2("reopening weak %s\n", evsel__name(counter));
811 if (create_perf_stat_counter(counter, &stat_config, &target,
812 counter->cpu_iter - 1) < 0) {
814 switch (stat_handle_error(counter)) {
818 goto try_again_reset;
825 counter->supported = true;
829 affinity__cleanup(&affinity);
831 evlist__for_each_entry(evsel_list, counter) {
832 if (!counter->supported) {
833 perf_evsel__free_fd(&counter->core);
837 l = strlen(counter->unit);
838 if (l > stat_config.unit_width)
839 stat_config.unit_width = l;
841 if (evsel__should_store_id(counter) &&
842 evsel__store_ids(counter, evsel_list))
846 if (perf_evlist__apply_filters(evsel_list, &counter)) {
847 pr_err("failed to set filter \"%s\" on event %s with %d (%s)\n",
848 counter->filter, evsel__name(counter), errno,
849 str_error_r(errno, msg, sizeof(msg)));
854 int err, fd = perf_data__fd(&perf_stat.data);
857 err = perf_header__write_pipe(perf_data__fd(&perf_stat.data));
859 err = perf_session__write_header(perf_stat.session, evsel_list,
866 err = perf_event__synthesize_stat_events(&stat_config, NULL, evsel_list,
867 process_synthesized_event, is_pipe);
873 * Enable counters and exec the command:
876 clock_gettime(CLOCK_MONOTONIC, &ref_time);
879 perf_evlist__start_workload(evsel_list);
882 if (interval || timeout || evlist__ctlfd_initialized(evsel_list))
883 status = dispatch_events(forks, timeout, interval, ×);
884 if (child_pid != -1) {
886 kill(child_pid, SIGTERM);
887 wait4(child_pid, &status, 0, &stat_config.ru_data);
890 if (workload_exec_errno) {
891 const char *emsg = str_error_r(workload_exec_errno, msg, sizeof(msg));
892 pr_err("Workload failed: %s\n", emsg);
896 if (WIFSIGNALED(status))
897 psignal(WTERMSIG(status), argv[0]);
900 status = dispatch_events(forks, timeout, interval, ×);
907 if (stat_config.walltime_run_table)
908 stat_config.walltime_run[run_idx] = t1 - t0;
910 if (interval && stat_config.summary) {
911 stat_config.interval = 0;
912 stat_config.stop_read_counter = true;
913 init_stats(&walltime_nsecs_stats);
914 update_stats(&walltime_nsecs_stats, t1 - t0);
916 if (stat_config.aggr_mode == AGGR_GLOBAL)
917 perf_evlist__save_aggr_prev_raw_counts(evsel_list);
919 perf_evlist__copy_prev_raw_counts(evsel_list);
920 perf_evlist__reset_prev_raw_counts(evsel_list);
921 runtime_stat_reset(&stat_config);
922 perf_stat__reset_shadow_per_stat(&rt_stat);
924 update_stats(&walltime_nsecs_stats, t1 - t0);
927 * Closing a group leader splits the group, and as we only disable
928 * group leaders, results in remaining events becoming enabled. To
929 * avoid arbitrary skew, we must read all counters before closing any
932 read_counters(&(struct timespec) { .tv_nsec = t1-t0 });
935 * We need to keep evsel_list alive, because it's processed
936 * later the evsel_list will be closed after.
939 evlist__close(evsel_list);
941 return WEXITSTATUS(status);
944 static int run_perf_stat(int argc, const char **argv, int run_idx)
949 ret = system(pre_cmd);
957 ret = __run_perf_stat(argc, argv, run_idx);
962 ret = system(post_cmd);
970 static void print_counters(struct timespec *ts, int argc, const char **argv)
972 /* Do not print anything if we record to the pipe. */
973 if (STAT_RECORD && perf_stat.data.is_pipe)
975 if (stat_config.quiet)
978 perf_evlist__print_counters(evsel_list, &stat_config, &target,
982 static volatile int signr = -1;
984 static void skip_signal(int signo)
986 if ((child_pid == -1) || stat_config.interval)
991 * render child_pid harmless
992 * won't send SIGTERM to a random
993 * process in case of race condition
994 * and fast PID recycling
999 static void sig_atexit(void)
1004 * avoid race condition with SIGCHLD handler
1005 * in skip_signal() which is modifying child_pid
1006 * goal is to avoid send SIGTERM to a random
1010 sigaddset(&set, SIGCHLD);
1011 sigprocmask(SIG_BLOCK, &set, &oset);
1013 if (child_pid != -1)
1014 kill(child_pid, SIGTERM);
1016 sigprocmask(SIG_SETMASK, &oset, NULL);
1021 signal(signr, SIG_DFL);
1022 kill(getpid(), signr);
1025 void perf_stat__set_big_num(int set)
1027 stat_config.big_num = (set != 0);
1030 static int stat__set_big_num(const struct option *opt __maybe_unused,
1031 const char *s __maybe_unused, int unset)
1033 big_num_opt = unset ? 0 : 1;
1034 perf_stat__set_big_num(!unset);
1038 static int enable_metric_only(const struct option *opt __maybe_unused,
1039 const char *s __maybe_unused, int unset)
1041 force_metric_only = true;
1042 stat_config.metric_only = !unset;
1046 static int parse_metric_groups(const struct option *opt,
1048 int unset __maybe_unused)
1050 return metricgroup__parse_groups(opt, str,
1051 stat_config.metric_no_group,
1052 stat_config.metric_no_merge,
1053 &stat_config.metric_events);
1056 static int parse_control_option(const struct option *opt,
1058 int unset __maybe_unused)
1060 struct perf_stat_config *config = opt->value;
1062 return evlist__parse_control(str, &config->ctl_fd, &config->ctl_fd_ack, &config->ctl_fd_close);
1065 static int parse_stat_cgroups(const struct option *opt,
1066 const char *str, int unset)
1068 if (stat_config.cgroup_list) {
1069 pr_err("--cgroup and --for-each-cgroup cannot be used together\n");
1073 return parse_cgroups(opt, str, unset);
1076 static struct option stat_options[] = {
1077 OPT_BOOLEAN('T', "transaction", &transaction_run,
1078 "hardware transaction statistics"),
1079 OPT_CALLBACK('e', "event", &evsel_list, "event",
1080 "event selector. use 'perf list' to list available events",
1081 parse_events_option),
1082 OPT_CALLBACK(0, "filter", &evsel_list, "filter",
1083 "event filter", parse_filter),
1084 OPT_BOOLEAN('i', "no-inherit", &stat_config.no_inherit,
1085 "child tasks do not inherit counters"),
1086 OPT_STRING('p', "pid", &target.pid, "pid",
1087 "stat events on existing process id"),
1088 OPT_STRING('t', "tid", &target.tid, "tid",
1089 "stat events on existing thread id"),
1090 OPT_BOOLEAN('a', "all-cpus", &target.system_wide,
1091 "system-wide collection from all CPUs"),
1092 OPT_BOOLEAN('g', "group", &group,
1093 "put the counters into a counter group"),
1094 OPT_BOOLEAN(0, "scale", &stat_config.scale,
1095 "Use --no-scale to disable counter scaling for multiplexing"),
1096 OPT_INCR('v', "verbose", &verbose,
1097 "be more verbose (show counter open errors, etc)"),
1098 OPT_INTEGER('r', "repeat", &stat_config.run_count,
1099 "repeat command and print average + stddev (max: 100, forever: 0)"),
1100 OPT_BOOLEAN(0, "table", &stat_config.walltime_run_table,
1101 "display details about each run (only with -r option)"),
1102 OPT_BOOLEAN('n', "null", &stat_config.null_run,
1103 "null run - dont start any counters"),
1104 OPT_INCR('d', "detailed", &detailed_run,
1105 "detailed run - start a lot of events"),
1106 OPT_BOOLEAN('S', "sync", &sync_run,
1107 "call sync() before starting a run"),
1108 OPT_CALLBACK_NOOPT('B', "big-num", NULL, NULL,
1109 "print large numbers with thousands\' separators",
1111 OPT_STRING('C', "cpu", &target.cpu_list, "cpu",
1112 "list of cpus to monitor in system-wide"),
1113 OPT_SET_UINT('A', "no-aggr", &stat_config.aggr_mode,
1114 "disable CPU count aggregation", AGGR_NONE),
1115 OPT_BOOLEAN(0, "no-merge", &stat_config.no_merge, "Do not merge identical named events"),
1116 OPT_STRING('x', "field-separator", &stat_config.csv_sep, "separator",
1117 "print counts with custom separator"),
1118 OPT_CALLBACK('G', "cgroup", &evsel_list, "name",
1119 "monitor event in cgroup name only", parse_stat_cgroups),
1120 OPT_STRING(0, "for-each-cgroup", &stat_config.cgroup_list, "name",
1121 "expand events for each cgroup"),
1122 OPT_STRING('o', "output", &output_name, "file", "output file name"),
1123 OPT_BOOLEAN(0, "append", &append_file, "append to the output file"),
1124 OPT_INTEGER(0, "log-fd", &output_fd,
1125 "log output to fd, instead of stderr"),
1126 OPT_STRING(0, "pre", &pre_cmd, "command",
1127 "command to run prior to the measured command"),
1128 OPT_STRING(0, "post", &post_cmd, "command",
1129 "command to run after to the measured command"),
1130 OPT_UINTEGER('I', "interval-print", &stat_config.interval,
1131 "print counts at regular interval in ms "
1132 "(overhead is possible for values <= 100ms)"),
1133 OPT_INTEGER(0, "interval-count", &stat_config.times,
1134 "print counts for fixed number of times"),
1135 OPT_BOOLEAN(0, "interval-clear", &stat_config.interval_clear,
1136 "clear screen in between new interval"),
1137 OPT_UINTEGER(0, "timeout", &stat_config.timeout,
1138 "stop workload and print counts after a timeout period in ms (>= 10ms)"),
1139 OPT_SET_UINT(0, "per-socket", &stat_config.aggr_mode,
1140 "aggregate counts per processor socket", AGGR_SOCKET),
1141 OPT_SET_UINT(0, "per-die", &stat_config.aggr_mode,
1142 "aggregate counts per processor die", AGGR_DIE),
1143 OPT_SET_UINT(0, "per-core", &stat_config.aggr_mode,
1144 "aggregate counts per physical processor core", AGGR_CORE),
1145 OPT_SET_UINT(0, "per-thread", &stat_config.aggr_mode,
1146 "aggregate counts per thread", AGGR_THREAD),
1147 OPT_SET_UINT(0, "per-node", &stat_config.aggr_mode,
1148 "aggregate counts per numa node", AGGR_NODE),
1149 OPT_INTEGER('D', "delay", &stat_config.initial_delay,
1150 "ms to wait before starting measurement after program start (-1: start with events disabled)"),
1151 OPT_CALLBACK_NOOPT(0, "metric-only", &stat_config.metric_only, NULL,
1152 "Only print computed metrics. No raw values", enable_metric_only),
1153 OPT_BOOLEAN(0, "metric-no-group", &stat_config.metric_no_group,
1154 "don't group metric events, impacts multiplexing"),
1155 OPT_BOOLEAN(0, "metric-no-merge", &stat_config.metric_no_merge,
1156 "don't try to share events between metrics in a group"),
1157 OPT_BOOLEAN(0, "topdown", &topdown_run,
1158 "measure topdown level 1 statistics"),
1159 OPT_BOOLEAN(0, "smi-cost", &smi_cost,
1160 "measure SMI cost"),
1161 OPT_CALLBACK('M', "metrics", &evsel_list, "metric/metric group list",
1162 "monitor specified metrics or metric groups (separated by ,)",
1163 parse_metric_groups),
1164 OPT_BOOLEAN_FLAG(0, "all-kernel", &stat_config.all_kernel,
1165 "Configure all used events to run in kernel space.",
1166 PARSE_OPT_EXCLUSIVE),
1167 OPT_BOOLEAN_FLAG(0, "all-user", &stat_config.all_user,
1168 "Configure all used events to run in user space.",
1169 PARSE_OPT_EXCLUSIVE),
1170 OPT_BOOLEAN(0, "percore-show-thread", &stat_config.percore_show_thread,
1171 "Use with 'percore' event qualifier to show the event "
1172 "counts of one hardware thread by sum up total hardware "
1173 "threads of same physical core"),
1174 OPT_BOOLEAN(0, "summary", &stat_config.summary,
1175 "print summary for interval mode"),
1176 OPT_BOOLEAN(0, "quiet", &stat_config.quiet,
1177 "don't print output (useful with record)"),
1179 OPT_CALLBACK(0, "pfm-events", &evsel_list, "event",
1180 "libpfm4 event selector. use 'perf list' to list available events",
1181 parse_libpfm_events_option),
1183 OPT_CALLBACK(0, "control", &stat_config, "fd:ctl-fd[,ack-fd] or fifo:ctl-fifo[,ack-fifo]",
1184 "Listen on ctl-fd descriptor for command to control measurement ('enable': enable events, 'disable': disable events).\n"
1185 "\t\t\t Optionally send control command completion ('ack\\n') to ack-fd descriptor.\n"
1186 "\t\t\t Alternatively, ctl-fifo / ack-fifo will be opened and used as ctl-fd / ack-fd.",
1187 parse_control_option),
1191 static int perf_stat__get_socket(struct perf_stat_config *config __maybe_unused,
1192 struct perf_cpu_map *map, int cpu)
1194 return cpu_map__get_socket(map, cpu, NULL);
1197 static int perf_stat__get_die(struct perf_stat_config *config __maybe_unused,
1198 struct perf_cpu_map *map, int cpu)
1200 return cpu_map__get_die(map, cpu, NULL);
1203 static int perf_stat__get_core(struct perf_stat_config *config __maybe_unused,
1204 struct perf_cpu_map *map, int cpu)
1206 return cpu_map__get_core(map, cpu, NULL);
1209 static int perf_stat__get_node(struct perf_stat_config *config __maybe_unused,
1210 struct perf_cpu_map *map, int cpu)
1212 return cpu_map__get_node(map, cpu, NULL);
1215 static int perf_stat__get_aggr(struct perf_stat_config *config,
1216 aggr_get_id_t get_id, struct perf_cpu_map *map, int idx)
1223 cpu = map->map[idx];
1225 if (config->cpus_aggr_map->map[cpu] == -1)
1226 config->cpus_aggr_map->map[cpu] = get_id(config, map, idx);
1228 return config->cpus_aggr_map->map[cpu];
1231 static int perf_stat__get_socket_cached(struct perf_stat_config *config,
1232 struct perf_cpu_map *map, int idx)
1234 return perf_stat__get_aggr(config, perf_stat__get_socket, map, idx);
1237 static int perf_stat__get_die_cached(struct perf_stat_config *config,
1238 struct perf_cpu_map *map, int idx)
1240 return perf_stat__get_aggr(config, perf_stat__get_die, map, idx);
1243 static int perf_stat__get_core_cached(struct perf_stat_config *config,
1244 struct perf_cpu_map *map, int idx)
1246 return perf_stat__get_aggr(config, perf_stat__get_core, map, idx);
1249 static int perf_stat__get_node_cached(struct perf_stat_config *config,
1250 struct perf_cpu_map *map, int idx)
1252 return perf_stat__get_aggr(config, perf_stat__get_node, map, idx);
1255 static bool term_percore_set(void)
1257 struct evsel *counter;
1259 evlist__for_each_entry(evsel_list, counter) {
1260 if (counter->percore)
1267 static int perf_stat_init_aggr_mode(void)
1271 switch (stat_config.aggr_mode) {
1273 if (cpu_map__build_socket_map(evsel_list->core.cpus, &stat_config.aggr_map)) {
1274 perror("cannot build socket map");
1277 stat_config.aggr_get_id = perf_stat__get_socket_cached;
1280 if (cpu_map__build_die_map(evsel_list->core.cpus, &stat_config.aggr_map)) {
1281 perror("cannot build die map");
1284 stat_config.aggr_get_id = perf_stat__get_die_cached;
1287 if (cpu_map__build_core_map(evsel_list->core.cpus, &stat_config.aggr_map)) {
1288 perror("cannot build core map");
1291 stat_config.aggr_get_id = perf_stat__get_core_cached;
1294 if (cpu_map__build_node_map(evsel_list->core.cpus, &stat_config.aggr_map)) {
1295 perror("cannot build core map");
1298 stat_config.aggr_get_id = perf_stat__get_node_cached;
1301 if (term_percore_set()) {
1302 if (cpu_map__build_core_map(evsel_list->core.cpus,
1303 &stat_config.aggr_map)) {
1304 perror("cannot build core map");
1307 stat_config.aggr_get_id = perf_stat__get_core_cached;
1318 * The evsel_list->cpus is the base we operate on,
1319 * taking the highest cpu number to be the size of
1320 * the aggregation translate cpumap.
1322 nr = perf_cpu_map__max(evsel_list->core.cpus);
1323 stat_config.cpus_aggr_map = perf_cpu_map__empty_new(nr + 1);
1324 return stat_config.cpus_aggr_map ? 0 : -ENOMEM;
1327 static void perf_stat__exit_aggr_mode(void)
1329 perf_cpu_map__put(stat_config.aggr_map);
1330 perf_cpu_map__put(stat_config.cpus_aggr_map);
1331 stat_config.aggr_map = NULL;
1332 stat_config.cpus_aggr_map = NULL;
1335 static inline int perf_env__get_cpu(struct perf_env *env, struct perf_cpu_map *map, int idx)
1342 cpu = map->map[idx];
1344 if (cpu >= env->nr_cpus_avail)
1350 static int perf_env__get_socket(struct perf_cpu_map *map, int idx, void *data)
1352 struct perf_env *env = data;
1353 int cpu = perf_env__get_cpu(env, map, idx);
1355 return cpu == -1 ? -1 : env->cpu[cpu].socket_id;
1358 static int perf_env__get_die(struct perf_cpu_map *map, int idx, void *data)
1360 struct perf_env *env = data;
1361 int die_id = -1, cpu = perf_env__get_cpu(env, map, idx);
1365 * Encode socket in bit range 15:8
1366 * die_id is relative to socket,
1367 * we need a global id. So we combine
1370 if (WARN_ONCE(env->cpu[cpu].socket_id >> 8, "The socket id number is too big.\n"))
1373 if (WARN_ONCE(env->cpu[cpu].die_id >> 8, "The die id number is too big.\n"))
1376 die_id = (env->cpu[cpu].socket_id << 8) | (env->cpu[cpu].die_id & 0xff);
1382 static int perf_env__get_core(struct perf_cpu_map *map, int idx, void *data)
1384 struct perf_env *env = data;
1385 int core = -1, cpu = perf_env__get_cpu(env, map, idx);
1389 * Encode socket in bit range 31:24
1390 * encode die id in bit range 23:16
1391 * core_id is relative to socket and die,
1392 * we need a global id. So we combine
1393 * socket + die id + core id
1395 if (WARN_ONCE(env->cpu[cpu].socket_id >> 8, "The socket id number is too big.\n"))
1398 if (WARN_ONCE(env->cpu[cpu].die_id >> 8, "The die id number is too big.\n"))
1401 if (WARN_ONCE(env->cpu[cpu].core_id >> 16, "The core id number is too big.\n"))
1404 core = (env->cpu[cpu].socket_id << 24) |
1405 (env->cpu[cpu].die_id << 16) |
1406 (env->cpu[cpu].core_id & 0xffff);
1412 static int perf_env__get_node(struct perf_cpu_map *map, int idx, void *data)
1414 int cpu = perf_env__get_cpu(data, map, idx);
1416 return perf_env__numa_node(data, cpu);
1419 static int perf_env__build_socket_map(struct perf_env *env, struct perf_cpu_map *cpus,
1420 struct perf_cpu_map **sockp)
1422 return cpu_map__build_map(cpus, sockp, perf_env__get_socket, env);
1425 static int perf_env__build_die_map(struct perf_env *env, struct perf_cpu_map *cpus,
1426 struct perf_cpu_map **diep)
1428 return cpu_map__build_map(cpus, diep, perf_env__get_die, env);
1431 static int perf_env__build_core_map(struct perf_env *env, struct perf_cpu_map *cpus,
1432 struct perf_cpu_map **corep)
1434 return cpu_map__build_map(cpus, corep, perf_env__get_core, env);
1437 static int perf_env__build_node_map(struct perf_env *env, struct perf_cpu_map *cpus,
1438 struct perf_cpu_map **nodep)
1440 return cpu_map__build_map(cpus, nodep, perf_env__get_node, env);
1443 static int perf_stat__get_socket_file(struct perf_stat_config *config __maybe_unused,
1444 struct perf_cpu_map *map, int idx)
1446 return perf_env__get_socket(map, idx, &perf_stat.session->header.env);
1448 static int perf_stat__get_die_file(struct perf_stat_config *config __maybe_unused,
1449 struct perf_cpu_map *map, int idx)
1451 return perf_env__get_die(map, idx, &perf_stat.session->header.env);
1454 static int perf_stat__get_core_file(struct perf_stat_config *config __maybe_unused,
1455 struct perf_cpu_map *map, int idx)
1457 return perf_env__get_core(map, idx, &perf_stat.session->header.env);
1460 static int perf_stat__get_node_file(struct perf_stat_config *config __maybe_unused,
1461 struct perf_cpu_map *map, int idx)
1463 return perf_env__get_node(map, idx, &perf_stat.session->header.env);
1466 static int perf_stat_init_aggr_mode_file(struct perf_stat *st)
1468 struct perf_env *env = &st->session->header.env;
1470 switch (stat_config.aggr_mode) {
1472 if (perf_env__build_socket_map(env, evsel_list->core.cpus, &stat_config.aggr_map)) {
1473 perror("cannot build socket map");
1476 stat_config.aggr_get_id = perf_stat__get_socket_file;
1479 if (perf_env__build_die_map(env, evsel_list->core.cpus, &stat_config.aggr_map)) {
1480 perror("cannot build die map");
1483 stat_config.aggr_get_id = perf_stat__get_die_file;
1486 if (perf_env__build_core_map(env, evsel_list->core.cpus, &stat_config.aggr_map)) {
1487 perror("cannot build core map");
1490 stat_config.aggr_get_id = perf_stat__get_core_file;
1493 if (perf_env__build_node_map(env, evsel_list->core.cpus, &stat_config.aggr_map)) {
1494 perror("cannot build core map");
1497 stat_config.aggr_get_id = perf_stat__get_node_file;
1511 * Add default attributes, if there were no attributes specified or
1512 * if -d/--detailed, -d -d or -d -d -d is used:
1514 static int add_default_attributes(void)
1517 struct perf_event_attr default_attrs0[] = {
1519 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_TASK_CLOCK },
1520 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_CONTEXT_SWITCHES },
1521 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_CPU_MIGRATIONS },
1522 { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_PAGE_FAULTS },
1524 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_CPU_CYCLES },
1526 struct perf_event_attr frontend_attrs[] = {
1527 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_STALLED_CYCLES_FRONTEND },
1529 struct perf_event_attr backend_attrs[] = {
1530 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_STALLED_CYCLES_BACKEND },
1532 struct perf_event_attr default_attrs1[] = {
1533 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_INSTRUCTIONS },
1534 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_BRANCH_INSTRUCTIONS },
1535 { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_BRANCH_MISSES },
1540 * Detailed stats (-d), covering the L1 and last level data caches:
1542 struct perf_event_attr detailed_attrs[] = {
1544 { .type = PERF_TYPE_HW_CACHE,
1546 PERF_COUNT_HW_CACHE_L1D << 0 |
1547 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1548 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1550 { .type = PERF_TYPE_HW_CACHE,
1552 PERF_COUNT_HW_CACHE_L1D << 0 |
1553 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1554 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1556 { .type = PERF_TYPE_HW_CACHE,
1558 PERF_COUNT_HW_CACHE_LL << 0 |
1559 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1560 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1562 { .type = PERF_TYPE_HW_CACHE,
1564 PERF_COUNT_HW_CACHE_LL << 0 |
1565 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1566 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1570 * Very detailed stats (-d -d), covering the instruction cache and the TLB caches:
1572 struct perf_event_attr very_detailed_attrs[] = {
1574 { .type = PERF_TYPE_HW_CACHE,
1576 PERF_COUNT_HW_CACHE_L1I << 0 |
1577 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1578 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1580 { .type = PERF_TYPE_HW_CACHE,
1582 PERF_COUNT_HW_CACHE_L1I << 0 |
1583 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1584 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1586 { .type = PERF_TYPE_HW_CACHE,
1588 PERF_COUNT_HW_CACHE_DTLB << 0 |
1589 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1590 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1592 { .type = PERF_TYPE_HW_CACHE,
1594 PERF_COUNT_HW_CACHE_DTLB << 0 |
1595 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1596 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1598 { .type = PERF_TYPE_HW_CACHE,
1600 PERF_COUNT_HW_CACHE_ITLB << 0 |
1601 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1602 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1604 { .type = PERF_TYPE_HW_CACHE,
1606 PERF_COUNT_HW_CACHE_ITLB << 0 |
1607 (PERF_COUNT_HW_CACHE_OP_READ << 8) |
1608 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1613 * Very, very detailed stats (-d -d -d), adding prefetch events:
1615 struct perf_event_attr very_very_detailed_attrs[] = {
1617 { .type = PERF_TYPE_HW_CACHE,
1619 PERF_COUNT_HW_CACHE_L1D << 0 |
1620 (PERF_COUNT_HW_CACHE_OP_PREFETCH << 8) |
1621 (PERF_COUNT_HW_CACHE_RESULT_ACCESS << 16) },
1623 { .type = PERF_TYPE_HW_CACHE,
1625 PERF_COUNT_HW_CACHE_L1D << 0 |
1626 (PERF_COUNT_HW_CACHE_OP_PREFETCH << 8) |
1627 (PERF_COUNT_HW_CACHE_RESULT_MISS << 16) },
1629 struct parse_events_error errinfo;
1631 /* Set attrs if no event is selected and !null_run: */
1632 if (stat_config.null_run)
1635 bzero(&errinfo, sizeof(errinfo));
1636 if (transaction_run) {
1637 /* Handle -T as -M transaction. Once platform specific metrics
1638 * support has been added to the json files, all archictures
1639 * will use this approach. To determine transaction support
1640 * on an architecture test for such a metric name.
1642 if (metricgroup__has_metric("transaction")) {
1643 struct option opt = { .value = &evsel_list };
1645 return metricgroup__parse_groups(&opt, "transaction",
1646 stat_config.metric_no_group,
1647 stat_config.metric_no_merge,
1648 &stat_config.metric_events);
1651 if (pmu_have_event("cpu", "cycles-ct") &&
1652 pmu_have_event("cpu", "el-start"))
1653 err = parse_events(evsel_list, transaction_attrs,
1656 err = parse_events(evsel_list,
1657 transaction_limited_attrs,
1660 fprintf(stderr, "Cannot set up transaction events\n");
1661 parse_events_print_error(&errinfo, transaction_attrs);
1670 if (sysfs__read_int(FREEZE_ON_SMI_PATH, &smi) < 0) {
1671 fprintf(stderr, "freeze_on_smi is not supported.\n");
1676 if (sysfs__write_int(FREEZE_ON_SMI_PATH, 1) < 0) {
1677 fprintf(stderr, "Failed to set freeze_on_smi.\n");
1683 if (pmu_have_event("msr", "aperf") &&
1684 pmu_have_event("msr", "smi")) {
1685 if (!force_metric_only)
1686 stat_config.metric_only = true;
1687 err = parse_events(evsel_list, smi_cost_attrs, &errinfo);
1689 fprintf(stderr, "To measure SMI cost, it needs "
1690 "msr/aperf/, msr/smi/ and cpu/cycles/ support\n");
1691 parse_events_print_error(&errinfo, smi_cost_attrs);
1695 parse_events_print_error(&errinfo, smi_cost_attrs);
1696 fprintf(stderr, "Cannot set up SMI cost events\n");
1706 if (!force_metric_only)
1707 stat_config.metric_only = true;
1709 if (topdown_filter_events(topdown_metric_attrs, &str, 1) < 0) {
1710 pr_err("Out of memory\n");
1713 if (topdown_metric_attrs[0] && str) {
1714 if (!stat_config.interval && !stat_config.metric_only) {
1715 fprintf(stat_config.output,
1716 "Topdown accuracy may decrease when measuring long periods.\n"
1717 "Please print the result regularly, e.g. -I1000\n");
1724 if (stat_config.aggr_mode != AGGR_GLOBAL &&
1725 stat_config.aggr_mode != AGGR_CORE) {
1726 pr_err("top down event configuration requires --per-core mode\n");
1729 stat_config.aggr_mode = AGGR_CORE;
1730 if (nr_cgroups || !target__has_cpu(&target)) {
1731 pr_err("top down event configuration requires system-wide mode (-a)\n");
1735 if (topdown_filter_events(topdown_attrs, &str,
1736 arch_topdown_check_group(&warn)) < 0) {
1737 pr_err("Out of memory\n");
1740 if (topdown_attrs[0] && str) {
1742 arch_topdown_group_warn();
1744 err = parse_events(evsel_list, str, &errinfo);
1747 "Cannot set up top down events %s: %d\n",
1749 parse_events_print_error(&errinfo, str);
1754 fprintf(stderr, "System does not support topdown\n");
1760 if (!evsel_list->core.nr_entries) {
1761 if (target__has_cpu(&target))
1762 default_attrs0[0].config = PERF_COUNT_SW_CPU_CLOCK;
1764 if (evlist__add_default_attrs(evsel_list, default_attrs0) < 0)
1766 if (pmu_have_event("cpu", "stalled-cycles-frontend")) {
1767 if (evlist__add_default_attrs(evsel_list, frontend_attrs) < 0)
1770 if (pmu_have_event("cpu", "stalled-cycles-backend")) {
1771 if (evlist__add_default_attrs(evsel_list, backend_attrs) < 0)
1774 if (evlist__add_default_attrs(evsel_list, default_attrs1) < 0)
1778 /* Detailed events get appended to the event list: */
1780 if (detailed_run < 1)
1783 /* Append detailed run extra attributes: */
1784 if (evlist__add_default_attrs(evsel_list, detailed_attrs) < 0)
1787 if (detailed_run < 2)
1790 /* Append very detailed run extra attributes: */
1791 if (evlist__add_default_attrs(evsel_list, very_detailed_attrs) < 0)
1794 if (detailed_run < 3)
1797 /* Append very, very detailed run extra attributes: */
1798 return evlist__add_default_attrs(evsel_list, very_very_detailed_attrs);
1801 static const char * const stat_record_usage[] = {
1802 "perf stat record [<options>]",
1806 static void init_features(struct perf_session *session)
1810 for (feat = HEADER_FIRST_FEATURE; feat < HEADER_LAST_FEATURE; feat++)
1811 perf_header__set_feat(&session->header, feat);
1813 perf_header__clear_feat(&session->header, HEADER_DIR_FORMAT);
1814 perf_header__clear_feat(&session->header, HEADER_BUILD_ID);
1815 perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);
1816 perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
1817 perf_header__clear_feat(&session->header, HEADER_AUXTRACE);
1820 static int __cmd_record(int argc, const char **argv)
1822 struct perf_session *session;
1823 struct perf_data *data = &perf_stat.data;
1825 argc = parse_options(argc, argv, stat_options, stat_record_usage,
1826 PARSE_OPT_STOP_AT_NON_OPTION);
1829 data->path = output_name;
1831 if (stat_config.run_count != 1 || forever) {
1832 pr_err("Cannot use -r option with perf stat record.\n");
1836 session = perf_session__new(data, false, NULL);
1837 if (IS_ERR(session)) {
1838 pr_err("Perf session creation failed\n");
1839 return PTR_ERR(session);
1842 init_features(session);
1844 session->evlist = evsel_list;
1845 perf_stat.session = session;
1846 perf_stat.record = true;
1850 static int process_stat_round_event(struct perf_session *session,
1851 union perf_event *event)
1853 struct perf_record_stat_round *stat_round = &event->stat_round;
1854 struct evsel *counter;
1855 struct timespec tsh, *ts = NULL;
1856 const char **argv = session->header.env.cmdline_argv;
1857 int argc = session->header.env.nr_cmdline;
1859 evlist__for_each_entry(evsel_list, counter)
1860 perf_stat_process_counter(&stat_config, counter);
1862 if (stat_round->type == PERF_STAT_ROUND_TYPE__FINAL)
1863 update_stats(&walltime_nsecs_stats, stat_round->time);
1865 if (stat_config.interval && stat_round->time) {
1866 tsh.tv_sec = stat_round->time / NSEC_PER_SEC;
1867 tsh.tv_nsec = stat_round->time % NSEC_PER_SEC;
1871 print_counters(ts, argc, argv);
1876 int process_stat_config_event(struct perf_session *session,
1877 union perf_event *event)
1879 struct perf_tool *tool = session->tool;
1880 struct perf_stat *st = container_of(tool, struct perf_stat, tool);
1882 perf_event__read_stat_config(&stat_config, &event->stat_config);
1884 if (perf_cpu_map__empty(st->cpus)) {
1885 if (st->aggr_mode != AGGR_UNSET)
1886 pr_warning("warning: processing task data, aggregation mode not set\n");
1890 if (st->aggr_mode != AGGR_UNSET)
1891 stat_config.aggr_mode = st->aggr_mode;
1893 if (perf_stat.data.is_pipe)
1894 perf_stat_init_aggr_mode();
1896 perf_stat_init_aggr_mode_file(st);
1901 static int set_maps(struct perf_stat *st)
1903 if (!st->cpus || !st->threads)
1906 if (WARN_ONCE(st->maps_allocated, "stats double allocation\n"))
1909 perf_evlist__set_maps(&evsel_list->core, st->cpus, st->threads);
1911 if (perf_evlist__alloc_stats(evsel_list, true))
1914 st->maps_allocated = true;
1919 int process_thread_map_event(struct perf_session *session,
1920 union perf_event *event)
1922 struct perf_tool *tool = session->tool;
1923 struct perf_stat *st = container_of(tool, struct perf_stat, tool);
1926 pr_warning("Extra thread map event, ignoring.\n");
1930 st->threads = thread_map__new_event(&event->thread_map);
1934 return set_maps(st);
1938 int process_cpu_map_event(struct perf_session *session,
1939 union perf_event *event)
1941 struct perf_tool *tool = session->tool;
1942 struct perf_stat *st = container_of(tool, struct perf_stat, tool);
1943 struct perf_cpu_map *cpus;
1946 pr_warning("Extra cpu map event, ignoring.\n");
1950 cpus = cpu_map__new_data(&event->cpu_map.data);
1955 return set_maps(st);
1958 static const char * const stat_report_usage[] = {
1959 "perf stat report [<options>]",
1963 static struct perf_stat perf_stat = {
1965 .attr = perf_event__process_attr,
1966 .event_update = perf_event__process_event_update,
1967 .thread_map = process_thread_map_event,
1968 .cpu_map = process_cpu_map_event,
1969 .stat_config = process_stat_config_event,
1970 .stat = perf_event__process_stat_event,
1971 .stat_round = process_stat_round_event,
1973 .aggr_mode = AGGR_UNSET,
1976 static int __cmd_report(int argc, const char **argv)
1978 struct perf_session *session;
1979 const struct option options[] = {
1980 OPT_STRING('i', "input", &input_name, "file", "input file name"),
1981 OPT_SET_UINT(0, "per-socket", &perf_stat.aggr_mode,
1982 "aggregate counts per processor socket", AGGR_SOCKET),
1983 OPT_SET_UINT(0, "per-die", &perf_stat.aggr_mode,
1984 "aggregate counts per processor die", AGGR_DIE),
1985 OPT_SET_UINT(0, "per-core", &perf_stat.aggr_mode,
1986 "aggregate counts per physical processor core", AGGR_CORE),
1987 OPT_SET_UINT(0, "per-node", &perf_stat.aggr_mode,
1988 "aggregate counts per numa node", AGGR_NODE),
1989 OPT_SET_UINT('A', "no-aggr", &perf_stat.aggr_mode,
1990 "disable CPU count aggregation", AGGR_NONE),
1996 argc = parse_options(argc, argv, options, stat_report_usage, 0);
1998 if (!input_name || !strlen(input_name)) {
1999 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
2002 input_name = "perf.data";
2005 perf_stat.data.path = input_name;
2006 perf_stat.data.mode = PERF_DATA_MODE_READ;
2008 session = perf_session__new(&perf_stat.data, false, &perf_stat.tool);
2009 if (IS_ERR(session))
2010 return PTR_ERR(session);
2012 perf_stat.session = session;
2013 stat_config.output = stderr;
2014 evsel_list = session->evlist;
2016 ret = perf_session__process_events(session);
2020 perf_session__delete(session);
2024 static void setup_system_wide(int forks)
2027 * Make system wide (-a) the default target if
2028 * no target was specified and one of following
2029 * conditions is met:
2031 * - there's no workload specified
2032 * - there is workload specified but all requested
2033 * events are system wide events
2035 if (!target__none(&target))
2039 target.system_wide = true;
2041 struct evsel *counter;
2043 evlist__for_each_entry(evsel_list, counter) {
2044 if (!counter->core.system_wide &&
2045 strcmp(counter->name, "duration_time")) {
2050 if (evsel_list->core.nr_entries)
2051 target.system_wide = true;
2055 int cmd_stat(int argc, const char **argv)
2057 const char * const stat_usage[] = {
2058 "perf stat [<options>] [<command>]",
2061 int status = -EINVAL, run_idx;
2063 FILE *output = stderr;
2064 unsigned int interval, timeout;
2065 const char * const stat_subcommands[] = { "record", "report" };
2067 setlocale(LC_ALL, "");
2069 evsel_list = evlist__new();
2070 if (evsel_list == NULL)
2073 parse_events__shrink_config_terms();
2075 /* String-parsing callback-based options would segfault when negated */
2076 set_option_flag(stat_options, 'e', "event", PARSE_OPT_NONEG);
2077 set_option_flag(stat_options, 'M', "metrics", PARSE_OPT_NONEG);
2078 set_option_flag(stat_options, 'G', "cgroup", PARSE_OPT_NONEG);
2080 argc = parse_options_subcommand(argc, argv, stat_options, stat_subcommands,
2081 (const char **) stat_usage,
2082 PARSE_OPT_STOP_AT_NON_OPTION);
2083 perf_stat__collect_metric_expr(evsel_list);
2084 perf_stat__init_shadow_stats();
2086 if (stat_config.csv_sep) {
2087 stat_config.csv_output = true;
2088 if (!strcmp(stat_config.csv_sep, "\\t"))
2089 stat_config.csv_sep = "\t";
2091 stat_config.csv_sep = DEFAULT_SEPARATOR;
2093 if (argc && !strncmp(argv[0], "rec", 3)) {
2094 argc = __cmd_record(argc, argv);
2097 } else if (argc && !strncmp(argv[0], "rep", 3))
2098 return __cmd_report(argc, argv);
2100 interval = stat_config.interval;
2101 timeout = stat_config.timeout;
2104 * For record command the -o is already taken care of.
2106 if (!STAT_RECORD && output_name && strcmp(output_name, "-"))
2109 if (output_name && output_fd) {
2110 fprintf(stderr, "cannot use both --output and --log-fd\n");
2111 parse_options_usage(stat_usage, stat_options, "o", 1);
2112 parse_options_usage(NULL, stat_options, "log-fd", 0);
2116 if (stat_config.metric_only && stat_config.aggr_mode == AGGR_THREAD) {
2117 fprintf(stderr, "--metric-only is not supported with --per-thread\n");
2121 if (stat_config.metric_only && stat_config.run_count > 1) {
2122 fprintf(stderr, "--metric-only is not supported with -r\n");
2126 if (stat_config.walltime_run_table && stat_config.run_count <= 1) {
2127 fprintf(stderr, "--table is only supported with -r\n");
2128 parse_options_usage(stat_usage, stat_options, "r", 1);
2129 parse_options_usage(NULL, stat_options, "table", 0);
2133 if (output_fd < 0) {
2134 fprintf(stderr, "argument to --log-fd must be a > 0\n");
2135 parse_options_usage(stat_usage, stat_options, "log-fd", 0);
2139 if (!output && !stat_config.quiet) {
2141 mode = append_file ? "a" : "w";
2143 output = fopen(output_name, mode);
2145 perror("failed to create output file");
2148 clock_gettime(CLOCK_REALTIME, &tm);
2149 fprintf(output, "# started on %s\n", ctime(&tm.tv_sec));
2150 } else if (output_fd > 0) {
2151 mode = append_file ? "a" : "w";
2152 output = fdopen(output_fd, mode);
2154 perror("Failed opening logfd");
2159 stat_config.output = output;
2162 * let the spreadsheet do the pretty-printing
2164 if (stat_config.csv_output) {
2165 /* User explicitly passed -B? */
2166 if (big_num_opt == 1) {
2167 fprintf(stderr, "-B option not supported with -x\n");
2168 parse_options_usage(stat_usage, stat_options, "B", 1);
2169 parse_options_usage(NULL, stat_options, "x", 1);
2171 } else /* Nope, so disable big number formatting */
2172 stat_config.big_num = false;
2173 } else if (big_num_opt == 0) /* User passed --no-big-num */
2174 stat_config.big_num = false;
2176 setup_system_wide(argc);
2179 * Display user/system times only for single
2180 * run and when there's specified tracee.
2182 if ((stat_config.run_count == 1) && target__none(&target))
2183 stat_config.ru_display = true;
2185 if (stat_config.run_count < 0) {
2186 pr_err("Run count must be a positive number\n");
2187 parse_options_usage(stat_usage, stat_options, "r", 1);
2189 } else if (stat_config.run_count == 0) {
2191 stat_config.run_count = 1;
2194 if (stat_config.walltime_run_table) {
2195 stat_config.walltime_run = zalloc(stat_config.run_count * sizeof(stat_config.walltime_run[0]));
2196 if (!stat_config.walltime_run) {
2197 pr_err("failed to setup -r option");
2202 if ((stat_config.aggr_mode == AGGR_THREAD) &&
2203 !target__has_task(&target)) {
2204 if (!target.system_wide || target.cpu_list) {
2205 fprintf(stderr, "The --per-thread option is only "
2206 "available when monitoring via -p -t -a "
2207 "options or only --per-thread.\n");
2208 parse_options_usage(NULL, stat_options, "p", 1);
2209 parse_options_usage(NULL, stat_options, "t", 1);
2215 * no_aggr, cgroup are for system-wide only
2216 * --per-thread is aggregated per thread, we dont mix it with cpu mode
2218 if (((stat_config.aggr_mode != AGGR_GLOBAL &&
2219 stat_config.aggr_mode != AGGR_THREAD) || nr_cgroups) &&
2220 !target__has_cpu(&target)) {
2221 fprintf(stderr, "both cgroup and no-aggregation "
2222 "modes only available in system-wide mode\n");
2224 parse_options_usage(stat_usage, stat_options, "G", 1);
2225 parse_options_usage(NULL, stat_options, "A", 1);
2226 parse_options_usage(NULL, stat_options, "a", 1);
2230 if (add_default_attributes())
2233 if (stat_config.cgroup_list) {
2234 if (nr_cgroups > 0) {
2235 pr_err("--cgroup and --for-each-cgroup cannot be used together\n");
2236 parse_options_usage(stat_usage, stat_options, "G", 1);
2237 parse_options_usage(NULL, stat_options, "for-each-cgroup", 0);
2241 if (evlist__expand_cgroup(evsel_list, stat_config.cgroup_list,
2242 &stat_config.metric_events, true) < 0) {
2243 parse_options_usage(stat_usage, stat_options,
2244 "for-each-cgroup", 0);
2249 target__validate(&target);
2251 if ((stat_config.aggr_mode == AGGR_THREAD) && (target.system_wide))
2252 target.per_thread = true;
2254 if (perf_evlist__create_maps(evsel_list, &target) < 0) {
2255 if (target__has_task(&target)) {
2256 pr_err("Problems finding threads of monitor\n");
2257 parse_options_usage(stat_usage, stat_options, "p", 1);
2258 parse_options_usage(NULL, stat_options, "t", 1);
2259 } else if (target__has_cpu(&target)) {
2260 perror("failed to parse CPUs map");
2261 parse_options_usage(stat_usage, stat_options, "C", 1);
2262 parse_options_usage(NULL, stat_options, "a", 1);
2267 evlist__check_cpu_maps(evsel_list);
2270 * Initialize thread_map with comm names,
2271 * so we could print it out on output.
2273 if (stat_config.aggr_mode == AGGR_THREAD) {
2274 thread_map__read_comms(evsel_list->core.threads);
2275 if (target.system_wide) {
2276 if (runtime_stat_new(&stat_config,
2277 perf_thread_map__nr(evsel_list->core.threads))) {
2283 if (stat_config.aggr_mode == AGGR_NODE)
2284 cpu__setup_cpunode_map();
2286 if (stat_config.times && interval)
2287 interval_count = true;
2288 else if (stat_config.times && !interval) {
2289 pr_err("interval-count option should be used together with "
2290 "interval-print.\n");
2291 parse_options_usage(stat_usage, stat_options, "interval-count", 0);
2292 parse_options_usage(stat_usage, stat_options, "I", 1);
2296 if (timeout && timeout < 100) {
2298 pr_err("timeout must be >= 10ms.\n");
2299 parse_options_usage(stat_usage, stat_options, "timeout", 0);
2302 pr_warning("timeout < 100ms. "
2303 "The overhead percentage could be high in some cases. "
2304 "Please proceed with caution.\n");
2306 if (timeout && interval) {
2307 pr_err("timeout option is not supported with interval-print.\n");
2308 parse_options_usage(stat_usage, stat_options, "timeout", 0);
2309 parse_options_usage(stat_usage, stat_options, "I", 1);
2313 if (perf_evlist__alloc_stats(evsel_list, interval))
2316 if (perf_stat_init_aggr_mode())
2320 * Set sample_type to PERF_SAMPLE_IDENTIFIER, which should be harmless
2321 * while avoiding that older tools show confusing messages.
2323 * However for pipe sessions we need to keep it zero,
2324 * because script's perf_evsel__check_attr is triggered
2325 * by attr->sample_type != 0, and we can't run it on
2328 stat_config.identifier = !(STAT_RECORD && perf_stat.data.is_pipe);
2331 * We dont want to block the signals - that would cause
2332 * child tasks to inherit that and Ctrl-C would not work.
2333 * What we want is for Ctrl-C to work in the exec()-ed
2334 * task, but being ignored by perf stat itself:
2338 signal(SIGINT, skip_signal);
2339 signal(SIGCHLD, skip_signal);
2340 signal(SIGALRM, skip_signal);
2341 signal(SIGABRT, skip_signal);
2343 if (evlist__initialize_ctlfd(evsel_list, stat_config.ctl_fd, stat_config.ctl_fd_ack))
2347 for (run_idx = 0; forever || run_idx < stat_config.run_count; run_idx++) {
2348 if (stat_config.run_count != 1 && verbose > 0)
2349 fprintf(output, "[ perf stat: executing run #%d ... ]\n",
2353 perf_evlist__reset_prev_raw_counts(evsel_list);
2355 status = run_perf_stat(argc, argv, run_idx);
2356 if (forever && status != -1 && !interval) {
2357 print_counters(NULL, argc, argv);
2358 perf_stat__reset_stats();
2362 if (!forever && status != -1 && (!interval || stat_config.summary))
2363 print_counters(NULL, argc, argv);
2365 evlist__finalize_ctlfd(evsel_list);
2369 * We synthesize the kernel mmap record just so that older tools
2370 * don't emit warnings about not being able to resolve symbols
2371 * due to /proc/sys/kernel/kptr_restrict settings and instear provide
2372 * a saner message about no samples being in the perf.data file.
2374 * This also serves to suppress a warning about f_header.data.size == 0
2375 * in header.c at the moment 'perf stat record' gets introduced, which
2376 * is not really needed once we start adding the stat specific PERF_RECORD_
2377 * records, but the need to suppress the kptr_restrict messages in older
2378 * tools remain -acme
2380 int fd = perf_data__fd(&perf_stat.data);
2381 int err = perf_event__synthesize_kernel_mmap((void *)&perf_stat,
2382 process_synthesized_event,
2383 &perf_stat.session->machines.host);
2385 pr_warning("Couldn't synthesize the kernel mmap record, harmless, "
2386 "older tools may produce warnings about this file\n.");
2390 if (WRITE_STAT_ROUND_EVENT(walltime_nsecs_stats.max, FINAL))
2391 pr_err("failed to write stat round event\n");
2394 if (!perf_stat.data.is_pipe) {
2395 perf_stat.session->header.data_size += perf_stat.bytes_written;
2396 perf_session__write_header(perf_stat.session, evsel_list, fd, true);
2399 evlist__close(evsel_list);
2400 perf_session__delete(perf_stat.session);
2403 perf_stat__exit_aggr_mode();
2404 perf_evlist__free_stats(evsel_list);
2406 zfree(&stat_config.walltime_run);
2408 if (smi_cost && smi_reset)
2409 sysfs__write_int(FREEZE_ON_SMI_PATH, 0);
2411 evlist__delete(evsel_list);
2413 metricgroup__rblist_exit(&stat_config.metric_events);
2414 runtime_stat_delete(&stat_config);
2415 evlist__close_control(stat_config.ctl_fd, stat_config.ctl_fd_ack, &stat_config.ctl_fd_close);