builtin-stat.c 49.4 KB
Newer Older
1
/*
2 3 4 5 6 7
 * builtin-stat.c
 *
 * Builtin stat command: Give a precise performance counters summary
 * overview about any workload, CPU or specific PID.
 *
 * Sample output:
8

9
   $ perf stat ./hackbench 10
10

11
  Time: 0.118
12

13
  Performance counter stats for './hackbench 10':
14

15 16 17 18 19 20 21 22 23 24 25 26 27
       1708.761321 task-clock                #   11.037 CPUs utilized
            41,190 context-switches          #    0.024 M/sec
             6,735 CPU-migrations            #    0.004 M/sec
            17,318 page-faults               #    0.010 M/sec
     5,205,202,243 cycles                    #    3.046 GHz
     3,856,436,920 stalled-cycles-frontend   #   74.09% frontend cycles idle
     1,600,790,871 stalled-cycles-backend    #   30.75% backend  cycles idle
     2,603,501,247 instructions              #    0.50  insns per cycle
                                             #    1.48  stalled cycles per insn
       484,357,498 branches                  #  283.455 M/sec
         6,388,934 branch-misses             #    1.32% of all branches

        0.154822978  seconds time elapsed
28

29
 *
30
 * Copyright (C) 2008-2011, Red Hat Inc, Ingo Molnar <mingo@redhat.com>
31 32 33 34 35 36 37 38
 *
 * Improvements and fixes by:
 *
 *   Arjan van de Ven <arjan@linux.intel.com>
 *   Yanmin Zhang <yanmin.zhang@intel.com>
 *   Wu Fengguang <fengguang.wu@intel.com>
 *   Mike Galbraith <efault@gmx.de>
 *   Paul Mackerras <paulus@samba.org>
39
 *   Jaswinder Singh Rajput <jaswinder@kernel.org>
40 41
 *
 * Released under the GPL v2. (and only v2, not any later version)
42 43
 */

44
#include "perf.h"
45
#include "builtin.h"
46
#include "util/cgroup.h"
47
#include "util/util.h"
48
#include <subcmd/parse-options.h>
49
#include "util/parse-events.h"
50
#include "util/pmu.h"
51
#include "util/event.h"
52
#include "util/evlist.h"
53
#include "util/evsel.h"
54
#include "util/debug.h"
55
#include "util/color.h"
56
#include "util/stat.h"
57
#include "util/header.h"
58
#include "util/cpumap.h"
59
#include "util/thread.h"
60
#include "util/thread_map.h"
61
#include "util/counts.h"
62
#include "util/group.h"
J
Jiri Olsa 已提交
63
#include "util/session.h"
J
Jiri Olsa 已提交
64
#include "util/tool.h"
65
#include "util/string2.h"
66
#include "util/metricgroup.h"
67
#include "util/top.h"
J
Jiri Olsa 已提交
68
#include "asm/bug.h"
69

70
#include <linux/time64.h>
71
#include <api/fs/fs.h>
72
#include <errno.h>
73
#include <signal.h>
74
#include <stdlib.h>
75
#include <sys/prctl.h>
76
#include <inttypes.h>
77
#include <locale.h>
78
#include <math.h>
79 80
#include <sys/types.h>
#include <sys/stat.h>
81
#include <sys/wait.h>
82
#include <unistd.h>
83 84
#include <sys/time.h>
#include <sys/resource.h>
85

86 87
#include "sane_ctype.h"

S
Stephane Eranian 已提交
88
#define DEFAULT_SEPARATOR	" "
89
#define FREEZE_ON_SMI_PATH	"devices/cpu/freeze_on_smi"
S
Stephane Eranian 已提交
90

91
static void print_counters(struct timespec *ts, int argc, const char **argv);
92

93
/* Default events used for perf stat -T */
94 95
static const char *transaction_attrs = {
	"task-clock,"
96 97 98 99 100 101 102 103 104 105 106
	"{"
	"instructions,"
	"cycles,"
	"cpu/cycles-t/,"
	"cpu/tx-start/,"
	"cpu/el-start/,"
	"cpu/cycles-ct/"
	"}"
};

/* More limited version when the CPU does not have all events. */
107 108
static const char * transaction_limited_attrs = {
	"task-clock,"
109 110 111 112 113 114 115 116
	"{"
	"instructions,"
	"cycles,"
	"cpu/cycles-t/,"
	"cpu/tx-start/"
	"}"
};

117 118 119 120 121 122 123 124 125
static const char * topdown_attrs[] = {
	"topdown-total-slots",
	"topdown-slots-retired",
	"topdown-recovery-bubbles",
	"topdown-fetch-bubbles",
	"topdown-slots-issued",
	NULL,
};

126 127 128 129 130 131 132 133
static const char *smi_cost_attrs = {
	"{"
	"msr/aperf/,"
	"msr/smi/,"
	"cycles"
	"}"
};

134
static struct perf_evlist	*evsel_list;
135

136
static struct target target = {
137 138
	.uid	= UINT_MAX,
};
139

140 141
#define METRIC_ONLY_LEN 20

142
static volatile pid_t		child_pid			= -1;
143
static int			detailed_run			=  0;
144
static bool			transaction_run;
145
static bool			topdown_run			= false;
146 147
static bool			smi_cost			= false;
static bool			smi_reset			= false;
S
Stephane Eranian 已提交
148
static int			big_num_opt			=  -1;
149
static bool			group				= false;
150 151 152
static const char		*pre_cmd			= NULL;
static const char		*post_cmd			= NULL;
static bool			sync_run			= false;
153
static bool			forever				= false;
154
static bool			force_metric_only		= false;
155
static struct timespec		ref_time;
J
Jiri Olsa 已提交
156
static bool			append_file;
157
static bool			interval_count;
J
Jiri Olsa 已提交
158 159
static const char		*output_name;
static int			output_fd;
160

J
Jiri Olsa 已提交
161 162
struct perf_stat {
	bool			 record;
163
	struct perf_data	 data;
J
Jiri Olsa 已提交
164 165
	struct perf_session	*session;
	u64			 bytes_written;
J
Jiri Olsa 已提交
166
	struct perf_tool	 tool;
167 168 169
	bool			 maps_allocated;
	struct cpu_map		*cpus;
	struct thread_map	*threads;
170
	enum aggr_mode		 aggr_mode;
J
Jiri Olsa 已提交
171 172 173 174 175
};

static struct perf_stat		perf_stat;
#define STAT_RECORD		perf_stat.record

176 177
static volatile int done = 0;

178
static struct perf_stat_config stat_config = {
179 180 181 182 183 184
	.aggr_mode		= AGGR_GLOBAL,
	.scale			= true,
	.unit_width		= 4, /* strlen("unit") */
	.run_count		= 1,
	.metric_only_len	= METRIC_ONLY_LEN,
	.walltime_nsecs_stats	= &walltime_nsecs_stats,
185
	.big_num		= true,
186 187
};

188 189 190 191 192
static inline void diff_timespec(struct timespec *r, struct timespec *a,
				 struct timespec *b)
{
	r->tv_sec = a->tv_sec - b->tv_sec;
	if (a->tv_nsec < b->tv_nsec) {
193
		r->tv_nsec = a->tv_nsec + NSEC_PER_SEC - b->tv_nsec;
194 195 196 197 198 199
		r->tv_sec--;
	} else {
		r->tv_nsec = a->tv_nsec - b->tv_nsec ;
	}
}

200 201
static void perf_stat__reset_stats(void)
{
202 203
	int i;

204
	perf_evlist__reset_stats(evsel_list);
205
	perf_stat__reset_shadow_stats();
206 207 208

	for (i = 0; i < stat_config.stats_num; i++)
		perf_stat__reset_shadow_per_stat(&stat_config.stats[i]);
209 210
}

211 212 213 214
static int process_synthesized_event(struct perf_tool *tool __maybe_unused,
				     union perf_event *event,
				     struct perf_sample *sample __maybe_unused,
				     struct machine *machine __maybe_unused)
J
Jiri Olsa 已提交
215
{
216
	if (perf_data__write(&perf_stat.data, event, event->header.size) < 0) {
J
Jiri Olsa 已提交
217 218 219 220
		pr_err("failed to write perf data, error: %m\n");
		return -1;
	}

221
	perf_stat.bytes_written += event->header.size;
J
Jiri Olsa 已提交
222 223 224
	return 0;
}

225
static int write_stat_round_event(u64 tm, u64 type)
226
{
227
	return perf_event__synthesize_stat_round(NULL, tm, type,
228 229 230 231 232 233 234
						 process_synthesized_event,
						 NULL);
}

#define WRITE_STAT_ROUND_EVENT(time, interval) \
	write_stat_round_event(time, PERF_STAT_ROUND_TYPE__ ## interval)

235 236 237 238 239 240 241 242 243 244 245 246
#define SID(e, x, y) xyarray__entry(e->sample_id, x, y)

static int
perf_evsel__write_stat_event(struct perf_evsel *counter, u32 cpu, u32 thread,
			     struct perf_counts_values *count)
{
	struct perf_sample_id *sid = SID(counter, cpu, thread);

	return perf_event__synthesize_stat(NULL, cpu, thread, sid->id, count,
					   process_synthesized_event, NULL);
}

247 248 249 250
/*
 * Read out the results of a single counter:
 * do not aggregate counts across CPUs in system-wide mode
 */
251
static int read_counter(struct perf_evsel *counter)
252
{
253
	int nthreads = thread_map__nr(evsel_list->threads);
254 255
	int ncpus, cpu, thread;

256
	if (target__has_cpu(&target) && !target__has_per_thread(&target))
257 258 259
		ncpus = perf_evsel__nr_cpus(counter);
	else
		ncpus = 1;
260

261 262 263
	if (!counter->supported)
		return -ENOENT;

264 265 266 267 268
	if (counter->system_wide)
		nthreads = 1;

	for (thread = 0; thread < nthreads; thread++) {
		for (cpu = 0; cpu < ncpus; cpu++) {
269 270 271
			struct perf_counts_values *count;

			count = perf_counts(counter->counts, cpu, thread);
272 273 274 275 276 277 278

			/*
			 * The leader's group read loads data into its group members
			 * (via perf_evsel__read_counter) and sets threir count->loaded.
			 */
			if (!count->loaded &&
			    perf_evsel__read_counter(counter, cpu, thread)) {
279 280 281
				counter->counts->scaled = -1;
				perf_counts(counter->counts, cpu, thread)->ena = 0;
				perf_counts(counter->counts, cpu, thread)->run = 0;
282
				return -1;
283
			}
284

285 286
			count->loaded = false;

287 288 289 290 291 292
			if (STAT_RECORD) {
				if (perf_evsel__write_stat_event(counter, cpu, thread, count)) {
					pr_err("failed to write stat event\n");
					return -1;
				}
			}
293 294 295 296 297 298 299 300

			if (verbose > 1) {
				fprintf(stat_config.output,
					"%s: %d: %" PRIu64 " %" PRIu64 " %" PRIu64 "\n",
						perf_evsel__name(counter),
						cpu,
						count->val, count->ena, count->run);
			}
301
		}
302
	}
303 304

	return 0;
305 306
}

307
static void read_counters(void)
308 309
{
	struct perf_evsel *counter;
310
	int ret;
311

312
	evlist__for_each_entry(evsel_list, counter) {
313 314
		ret = read_counter(counter);
		if (ret)
315
			pr_debug("failed to read counter %s\n", counter->name);
316

317
		if (ret == 0 && perf_stat_process_counter(&stat_config, counter))
318
			pr_warning("failed to process counter %s\n", counter->name);
319
	}
320 321
}

322
static void process_interval(void)
323 324 325
{
	struct timespec ts, rs;

326
	read_counters();
327

328 329 330
	clock_gettime(CLOCK_MONOTONIC, &ts);
	diff_timespec(&rs, &ts, &ref_time);

331
	if (STAT_RECORD) {
332
		if (WRITE_STAT_ROUND_EVENT(rs.tv_sec * NSEC_PER_SEC + rs.tv_nsec, INTERVAL))
333 334 335
			pr_err("failed to write stat round event\n");
	}

336 337
	init_stats(&walltime_nsecs_stats);
	update_stats(&walltime_nsecs_stats, stat_config.interval * 1000000);
338
	print_counters(&rs, 0, NULL);
339 340
}

J
Jiri Olsa 已提交
341
static void enable_counters(void)
342
{
343 344
	if (stat_config.initial_delay)
		usleep(stat_config.initial_delay * USEC_PER_MSEC);
J
Jiri Olsa 已提交
345 346 347 348 349 350

	/*
	 * We need to enable counters only if:
	 * - we don't have tracee (attaching to task or cpu)
	 * - we have initial delay configured
	 */
351
	if (!target__none(&target) || stat_config.initial_delay)
352
		perf_evlist__enable(evsel_list);
353 354
}

355 356 357 358 359 360 361 362 363 364 365
static void disable_counters(void)
{
	/*
	 * If we don't have tracee (attaching to task or cpu), counters may
	 * still be running. To get accurate group ratios, we must stop groups
	 * from counting before reading their constituent counters.
	 */
	if (!target__none(&target))
		perf_evlist__disable(evsel_list);
}

366
static volatile int workload_exec_errno;
367 368 369 370 371 372

/*
 * perf_evlist__prepare_workload will send a SIGUSR1
 * if the fork fails, since we asked by setting its
 * want_signal to true.
 */
373 374
static void workload_exec_failed_signal(int signo __maybe_unused, siginfo_t *info,
					void *ucontext __maybe_unused)
375
{
376
	workload_exec_errno = info->si_value.sival_int;
377 378
}

379 380 381 382 383
static bool perf_evsel__should_store_id(struct perf_evsel *counter)
{
	return STAT_RECORD || counter->attr.read_format & PERF_FORMAT_ID;
}

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
static bool is_target_alive(struct target *_target,
			    struct thread_map *threads)
{
	struct stat st;
	int i;

	if (!target__has_task(_target))
		return true;

	for (i = 0; i < threads->nr; i++) {
		char path[PATH_MAX];

		scnprintf(path, PATH_MAX, "%s/%d", procfs__mountpoint(),
			  threads->map[i].pid);

		if (!stat(path, &st))
			return true;
	}

	return false;
}

406
static int __run_perf_stat(int argc, const char **argv, int run_idx)
407
{
408
	int interval = stat_config.interval;
409
	int times = stat_config.times;
410
	int timeout = stat_config.timeout;
411
	char msg[BUFSIZ];
412
	unsigned long long t0, t1;
413
	struct perf_evsel *counter;
414
	struct timespec ts;
415
	size_t l;
416
	int status = 0;
417
	const bool forks = (argc > 0);
418
	bool is_pipe = STAT_RECORD ? perf_stat.data.is_pipe : false;
419

420
	if (interval) {
421 422
		ts.tv_sec  = interval / USEC_PER_MSEC;
		ts.tv_nsec = (interval % USEC_PER_MSEC) * NSEC_PER_MSEC;
423 424 425
	} else if (timeout) {
		ts.tv_sec  = timeout / USEC_PER_MSEC;
		ts.tv_nsec = (timeout % USEC_PER_MSEC) * NSEC_PER_MSEC;
426 427 428 429 430
	} else {
		ts.tv_sec  = 1;
		ts.tv_nsec = 0;
	}

431
	if (forks) {
432
		if (perf_evlist__prepare_workload(evsel_list, &target, argv, is_pipe,
433
						  workload_exec_failed_signal) < 0) {
434 435
			perror("failed to prepare workload");
			return -1;
436
		}
437
		child_pid = evsel_list->workload.pid;
438 439
	}

440
	if (group)
441
		perf_evlist__set_leader(evsel_list);
442

443
	evlist__for_each_entry(evsel_list, counter) {
444
try_again:
445
		if (create_perf_stat_counter(counter, &stat_config, &target) < 0) {
446 447

			/* Weak group failed. Reset the group. */
448
			if ((errno == EINVAL || errno == EBADF) &&
449 450
			    counter->leader != counter &&
			    counter->weak_group) {
451
				counter = perf_evlist__reset_weak_group(evsel_list, counter);
452 453 454
				goto try_again;
			}

455 456 457 458
			/*
			 * PPC returns ENXIO for HW counters until 2.6.37
			 * (behavior changed with commit b0a873e).
			 */
459
			if (errno == EINVAL || errno == ENOSYS ||
460 461
			    errno == ENOENT || errno == EOPNOTSUPP ||
			    errno == ENXIO) {
462
				if (verbose > 0)
463
					ui__warning("%s event is not supported by the kernel.\n",
464
						    perf_evsel__name(counter));
465
				counter->supported = false;
466 467 468 469

				if ((counter->leader != counter) ||
				    !(counter->leader->nr_members > 1))
					continue;
470
			} else if (perf_evsel__fallback(counter, errno, msg, sizeof(msg))) {
471
                                if (verbose > 0)
472 473
                                        ui__warning("%s\n", msg);
                                goto try_again;
474 475 476 477 478 479 480 481 482 483 484 485 486
			} else if (target__has_per_thread(&target) &&
				   evsel_list->threads &&
				   evsel_list->threads->err_thread != -1) {
				/*
				 * For global --per-thread case, skip current
				 * error thread.
				 */
				if (!thread_map__remove(evsel_list->threads,
							evsel_list->threads->err_thread)) {
					evsel_list->threads->err_thread = -1;
					goto try_again;
				}
			}
487

488 489 490 491
			perf_evsel__open_strerror(counter, &target,
						  errno, msg, sizeof(msg));
			ui__error("%s\n", msg);

492 493
			if (child_pid != -1)
				kill(child_pid, SIGTERM);
494

495 496
			return -1;
		}
497
		counter->supported = true;
498 499

		l = strlen(counter->unit);
500 501
		if (l > stat_config.unit_width)
			stat_config.unit_width = l;
502

503
		if (perf_evsel__should_store_id(counter) &&
504
		    perf_evsel__store_ids(counter, evsel_list))
505
			return -1;
506
	}
507

508
	if (perf_evlist__apply_filters(evsel_list, &counter)) {
509
		pr_err("failed to set filter \"%s\" on event %s with %d (%s)\n",
510
			counter->filter, perf_evsel__name(counter), errno,
511
			str_error_r(errno, msg, sizeof(msg)));
512 513 514
		return -1;
	}

J
Jiri Olsa 已提交
515
	if (STAT_RECORD) {
516
		int err, fd = perf_data__fd(&perf_stat.data);
J
Jiri Olsa 已提交
517

518
		if (is_pipe) {
519
			err = perf_header__write_pipe(perf_data__fd(&perf_stat.data));
520 521 522 523 524
		} else {
			err = perf_session__write_header(perf_stat.session, evsel_list,
							 fd, false);
		}

J
Jiri Olsa 已提交
525 526
		if (err < 0)
			return err;
527

528
		err = perf_stat_synthesize_config(&stat_config, NULL, evsel_list,
529
						  process_synthesized_event, is_pipe);
530 531
		if (err < 0)
			return err;
J
Jiri Olsa 已提交
532 533
	}

534 535 536 537
	/*
	 * Enable counters and exec the command:
	 */
	t0 = rdclock();
538
	clock_gettime(CLOCK_MONOTONIC, &ref_time);
539

540
	if (forks) {
541
		perf_evlist__start_workload(evsel_list);
J
Jiri Olsa 已提交
542
		enable_counters();
543

544
		if (interval || timeout) {
545 546
			while (!waitpid(child_pid, &status, WNOHANG)) {
				nanosleep(&ts, NULL);
547 548
				if (timeout)
					break;
549
				process_interval();
550 551
				if (interval_count && !(--times))
					break;
552 553
			}
		}
554 555
		if (child_pid != -1)
			wait4(child_pid, &status, 0, &stat_config.ru_data);
556

557
		if (workload_exec_errno) {
558
			const char *emsg = str_error_r(workload_exec_errno, msg, sizeof(msg));
559
			pr_err("Workload failed: %s\n", emsg);
560
			return -1;
561
		}
562

563 564
		if (WIFSIGNALED(status))
			psignal(WTERMSIG(status), argv[0]);
565
	} else {
J
Jiri Olsa 已提交
566
		enable_counters();
567 568
		while (!done) {
			nanosleep(&ts, NULL);
569 570
			if (!is_target_alive(&target, evsel_list->threads))
				break;
571 572
			if (timeout)
				break;
573
			if (interval) {
574
				process_interval();
575 576 577
				if (interval_count && !(--times))
					break;
			}
578
		}
579
	}
580

581 582
	disable_counters();

583 584
	t1 = rdclock();

585 586
	if (stat_config.walltime_run_table)
		stat_config.walltime_run[run_idx] = t1 - t0;
587

588
	update_stats(&walltime_nsecs_stats, t1 - t0);
589

590 591 592 593 594 595 596 597
	/*
	 * Closing a group leader splits the group, and as we only disable
	 * group leaders, results in remaining events becoming enabled. To
	 * avoid arbitrary skew, we must read all counters before closing any
	 * group leaders.
	 */
	read_counters();
	perf_evlist__close(evsel_list);
598

599 600 601
	return WEXITSTATUS(status);
}

602
static int run_perf_stat(int argc, const char **argv, int run_idx)
603 604 605 606 607 608 609 610 611 612 613 614
{
	int ret;

	if (pre_cmd) {
		ret = system(pre_cmd);
		if (ret)
			return ret;
	}

	if (sync_run)
		sync();

615
	ret = __run_perf_stat(argc, argv, run_idx);
616 617 618 619 620 621 622 623 624 625 626 627
	if (ret)
		return ret;

	if (post_cmd) {
		ret = system(post_cmd);
		if (ret)
			return ret;
	}

	return ret;
}

628 629
static void print_counters(struct timespec *ts, int argc, const char **argv)
{
630 631 632 633
	/* Do not print anything if we record to the pipe. */
	if (STAT_RECORD && perf_stat.data.is_pipe)
		return;

634
	perf_evlist__print_counters(evsel_list, &stat_config, &target,
635
				    ts, argc, argv);
636 637
}

638 639
static volatile int signr = -1;

640
static void skip_signal(int signo)
641
{
642
	if ((child_pid == -1) || stat_config.interval)
643 644
		done = 1;

645
	signr = signo;
646 647 648 649 650 651 652
	/*
	 * render child_pid harmless
	 * won't send SIGTERM to a random
	 * process in case of race condition
	 * and fast PID recycling
	 */
	child_pid = -1;
653 654 655 656
}

static void sig_atexit(void)
{
657 658 659 660 661 662 663 664 665 666 667 668
	sigset_t set, oset;

	/*
	 * avoid race condition with SIGCHLD handler
	 * in skip_signal() which is modifying child_pid
	 * goal is to avoid send SIGTERM to a random
	 * process
	 */
	sigemptyset(&set);
	sigaddset(&set, SIGCHLD);
	sigprocmask(SIG_BLOCK, &set, &oset);

669 670 671
	if (child_pid != -1)
		kill(child_pid, SIGTERM);

672 673
	sigprocmask(SIG_SETMASK, &oset, NULL);

674 675 676 677 678
	if (signr == -1)
		return;

	signal(signr, SIG_DFL);
	kill(getpid(), signr);
679 680
}

681 682
static int stat__set_big_num(const struct option *opt __maybe_unused,
			     const char *s __maybe_unused, int unset)
S
Stephane Eranian 已提交
683 684 685 686 687
{
	big_num_opt = unset ? 0 : 1;
	return 0;
}

688 689 690 691
static int enable_metric_only(const struct option *opt __maybe_unused,
			      const char *s __maybe_unused, int unset)
{
	force_metric_only = true;
692
	stat_config.metric_only = !unset;
693 694 695
	return 0;
}

696 697 698 699
static int parse_metric_groups(const struct option *opt,
			       const char *str,
			       int unset __maybe_unused)
{
700
	return metricgroup__parse_groups(opt, str, &stat_config.metric_events);
701 702
}

703
static struct option stat_options[] = {
J
Jiri Olsa 已提交
704 705 706 707 708 709 710
	OPT_BOOLEAN('T', "transaction", &transaction_run,
		    "hardware transaction statistics"),
	OPT_CALLBACK('e', "event", &evsel_list, "event",
		     "event selector. use 'perf list' to list available events",
		     parse_events_option),
	OPT_CALLBACK(0, "filter", &evsel_list, "filter",
		     "event filter", parse_filter),
711
	OPT_BOOLEAN('i', "no-inherit", &stat_config.no_inherit,
J
Jiri Olsa 已提交
712 713 714 715 716 717 718 719 720 721 722 723
		    "child tasks do not inherit counters"),
	OPT_STRING('p', "pid", &target.pid, "pid",
		   "stat events on existing process id"),
	OPT_STRING('t', "tid", &target.tid, "tid",
		   "stat events on existing thread id"),
	OPT_BOOLEAN('a', "all-cpus", &target.system_wide,
		    "system-wide collection from all CPUs"),
	OPT_BOOLEAN('g', "group", &group,
		    "put the counters into a counter group"),
	OPT_BOOLEAN('c', "scale", &stat_config.scale, "scale/normalize counters"),
	OPT_INCR('v', "verbose", &verbose,
		    "be more verbose (show counter open errors, etc)"),
724
	OPT_INTEGER('r', "repeat", &stat_config.run_count,
J
Jiri Olsa 已提交
725
		    "repeat command and print average + stddev (max: 100, forever: 0)"),
726
	OPT_BOOLEAN(0, "table", &stat_config.walltime_run_table,
727
		    "display details about each run (only with -r option)"),
728
	OPT_BOOLEAN('n', "null", &stat_config.null_run,
J
Jiri Olsa 已提交
729 730 731 732 733 734 735 736 737 738 739 740
		    "null run - dont start any counters"),
	OPT_INCR('d', "detailed", &detailed_run,
		    "detailed run - start a lot of events"),
	OPT_BOOLEAN('S', "sync", &sync_run,
		    "call sync() before starting a run"),
	OPT_CALLBACK_NOOPT('B', "big-num", NULL, NULL,
			   "print large numbers with thousands\' separators",
			   stat__set_big_num),
	OPT_STRING('C', "cpu", &target.cpu_list, "cpu",
		    "list of cpus to monitor in system-wide"),
	OPT_SET_UINT('A', "no-aggr", &stat_config.aggr_mode,
		    "disable CPU count aggregation", AGGR_NONE),
741
	OPT_BOOLEAN(0, "no-merge", &stat_config.no_merge, "Do not merge identical named events"),
742
	OPT_STRING('x', "field-separator", &stat_config.csv_sep, "separator",
J
Jiri Olsa 已提交
743 744 745 746 747 748 749 750 751 752 753 754
		   "print counts with custom separator"),
	OPT_CALLBACK('G', "cgroup", &evsel_list, "name",
		     "monitor event in cgroup name only", parse_cgroups),
	OPT_STRING('o', "output", &output_name, "file", "output file name"),
	OPT_BOOLEAN(0, "append", &append_file, "append to the output file"),
	OPT_INTEGER(0, "log-fd", &output_fd,
		    "log output to fd, instead of stderr"),
	OPT_STRING(0, "pre", &pre_cmd, "command",
			"command to run prior to the measured command"),
	OPT_STRING(0, "post", &post_cmd, "command",
			"command to run after to the measured command"),
	OPT_UINTEGER('I', "interval-print", &stat_config.interval,
755 756
		    "print counts at regular interval in ms "
		    "(overhead is possible for values <= 100ms)"),
757 758
	OPT_INTEGER(0, "interval-count", &stat_config.times,
		    "print counts for fixed number of times"),
759
	OPT_BOOLEAN(0, "interval-clear", &stat_config.interval_clear,
760
		    "clear screen in between new interval"),
761 762
	OPT_UINTEGER(0, "timeout", &stat_config.timeout,
		    "stop workload and print counts after a timeout period in ms (>= 10ms)"),
J
Jiri Olsa 已提交
763 764 765 766 767 768
	OPT_SET_UINT(0, "per-socket", &stat_config.aggr_mode,
		     "aggregate counts per processor socket", AGGR_SOCKET),
	OPT_SET_UINT(0, "per-core", &stat_config.aggr_mode,
		     "aggregate counts per physical processor core", AGGR_CORE),
	OPT_SET_UINT(0, "per-thread", &stat_config.aggr_mode,
		     "aggregate counts per thread", AGGR_THREAD),
769
	OPT_UINTEGER('D', "delay", &stat_config.initial_delay,
J
Jiri Olsa 已提交
770
		     "ms to wait before starting measurement after program start"),
771
	OPT_CALLBACK_NOOPT(0, "metric-only", &stat_config.metric_only, NULL,
772 773 774
			"Only print computed metrics. No raw values", enable_metric_only),
	OPT_BOOLEAN(0, "topdown", &topdown_run,
			"measure topdown level 1 statistics"),
775 776
	OPT_BOOLEAN(0, "smi-cost", &smi_cost,
			"measure SMI cost"),
777 778 779
	OPT_CALLBACK('M', "metrics", &evsel_list, "metric/metric group list",
		     "monitor specified metrics or metric groups (separated by ,)",
		     parse_metric_groups),
J
Jiri Olsa 已提交
780 781 782
	OPT_END()
};

783 784
static int perf_stat__get_socket(struct perf_stat_config *config __maybe_unused,
				 struct cpu_map *map, int cpu)
785 786 787 788
{
	return cpu_map__get_socket(map, cpu, NULL);
}

789 790
static int perf_stat__get_core(struct perf_stat_config *config __maybe_unused,
			       struct cpu_map *map, int cpu)
791 792 793 794
{
	return cpu_map__get_core(map, cpu, NULL);
}

795 796 797 798 799 800 801 802 803 804 805 806
static int cpu_map__get_max(struct cpu_map *map)
{
	int i, max = -1;

	for (i = 0; i < map->nr; i++) {
		if (map->map[i] > max)
			max = map->map[i];
	}

	return max;
}

807 808
static int perf_stat__get_aggr(struct perf_stat_config *config,
			       aggr_get_id_t get_id, struct cpu_map *map, int idx)
809 810 811 812 813 814 815 816
{
	int cpu;

	if (idx >= map->nr)
		return -1;

	cpu = map->map[idx];

817 818
	if (config->cpus_aggr_map->map[cpu] == -1)
		config->cpus_aggr_map->map[cpu] = get_id(config, map, idx);
819

820
	return config->cpus_aggr_map->map[cpu];
821 822
}

823 824
static int perf_stat__get_socket_cached(struct perf_stat_config *config,
					struct cpu_map *map, int idx)
825
{
826
	return perf_stat__get_aggr(config, perf_stat__get_socket, map, idx);
827 828
}

829 830
static int perf_stat__get_core_cached(struct perf_stat_config *config,
				      struct cpu_map *map, int idx)
831
{
832
	return perf_stat__get_aggr(config, perf_stat__get_core, map, idx);
833 834
}

835 836
static int perf_stat_init_aggr_mode(void)
{
837 838
	int nr;

839
	switch (stat_config.aggr_mode) {
840
	case AGGR_SOCKET:
841
		if (cpu_map__build_socket_map(evsel_list->cpus, &stat_config.aggr_map)) {
842 843 844
			perror("cannot build socket map");
			return -1;
		}
845
		stat_config.aggr_get_id = perf_stat__get_socket_cached;
846
		break;
847
	case AGGR_CORE:
848
		if (cpu_map__build_core_map(evsel_list->cpus, &stat_config.aggr_map)) {
849 850 851
			perror("cannot build core map");
			return -1;
		}
852
		stat_config.aggr_get_id = perf_stat__get_core_cached;
853
		break;
854 855
	case AGGR_NONE:
	case AGGR_GLOBAL:
856
	case AGGR_THREAD:
J
Jiri Olsa 已提交
857
	case AGGR_UNSET:
858 859 860
	default:
		break;
	}
861 862 863 864 865 866 867

	/*
	 * The evsel_list->cpus is the base we operate on,
	 * taking the highest cpu number to be the size of
	 * the aggregation translate cpumap.
	 */
	nr = cpu_map__get_max(evsel_list->cpus);
868 869
	stat_config.cpus_aggr_map = cpu_map__empty_new(nr + 1);
	return stat_config.cpus_aggr_map ? 0 : -ENOMEM;
870 871
}

872 873
static void perf_stat__exit_aggr_mode(void)
{
874 875 876 877
	cpu_map__put(stat_config.aggr_map);
	cpu_map__put(stat_config.cpus_aggr_map);
	stat_config.aggr_map = NULL;
	stat_config.cpus_aggr_map = NULL;
878 879
}

880 881 882 883 884 885 886 887 888
static inline int perf_env__get_cpu(struct perf_env *env, struct cpu_map *map, int idx)
{
	int cpu;

	if (idx > map->nr)
		return -1;

	cpu = map->map[idx];

889
	if (cpu >= env->nr_cpus_avail)
890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
		return -1;

	return cpu;
}

static int perf_env__get_socket(struct cpu_map *map, int idx, void *data)
{
	struct perf_env *env = data;
	int cpu = perf_env__get_cpu(env, map, idx);

	return cpu == -1 ? -1 : env->cpu[cpu].socket_id;
}

static int perf_env__get_core(struct cpu_map *map, int idx, void *data)
{
	struct perf_env *env = data;
	int core = -1, cpu = perf_env__get_cpu(env, map, idx);

	if (cpu != -1) {
		int socket_id = env->cpu[cpu].socket_id;

		/*
		 * Encode socket in upper 16 bits
		 * core_id is relative to socket, and
		 * we need a global id. So we combine
		 * socket + core id.
		 */
		core = (socket_id << 16) | (env->cpu[cpu].core_id & 0xffff);
	}

	return core;
}

static int perf_env__build_socket_map(struct perf_env *env, struct cpu_map *cpus,
				      struct cpu_map **sockp)
{
	return cpu_map__build_map(cpus, sockp, perf_env__get_socket, env);
}

static int perf_env__build_core_map(struct perf_env *env, struct cpu_map *cpus,
				    struct cpu_map **corep)
{
	return cpu_map__build_map(cpus, corep, perf_env__get_core, env);
}

935 936
static int perf_stat__get_socket_file(struct perf_stat_config *config __maybe_unused,
				      struct cpu_map *map, int idx)
937 938 939 940
{
	return perf_env__get_socket(map, idx, &perf_stat.session->header.env);
}

941 942
static int perf_stat__get_core_file(struct perf_stat_config *config __maybe_unused,
				    struct cpu_map *map, int idx)
943 944 945 946 947 948 949 950 951 952
{
	return perf_env__get_core(map, idx, &perf_stat.session->header.env);
}

static int perf_stat_init_aggr_mode_file(struct perf_stat *st)
{
	struct perf_env *env = &st->session->header.env;

	switch (stat_config.aggr_mode) {
	case AGGR_SOCKET:
953
		if (perf_env__build_socket_map(env, evsel_list->cpus, &stat_config.aggr_map)) {
954 955 956
			perror("cannot build socket map");
			return -1;
		}
957
		stat_config.aggr_get_id = perf_stat__get_socket_file;
958 959
		break;
	case AGGR_CORE:
960
		if (perf_env__build_core_map(env, evsel_list->cpus, &stat_config.aggr_map)) {
961 962 963
			perror("cannot build core map");
			return -1;
		}
964
		stat_config.aggr_get_id = perf_stat__get_core_file;
965 966 967 968 969 970 971 972 973 974 975 976
		break;
	case AGGR_NONE:
	case AGGR_GLOBAL:
	case AGGR_THREAD:
	case AGGR_UNSET:
	default:
		break;
	}

	return 0;
}

977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025
static int topdown_filter_events(const char **attr, char **str, bool use_group)
{
	int off = 0;
	int i;
	int len = 0;
	char *s;

	for (i = 0; attr[i]; i++) {
		if (pmu_have_event("cpu", attr[i])) {
			len += strlen(attr[i]) + 1;
			attr[i - off] = attr[i];
		} else
			off++;
	}
	attr[i - off] = NULL;

	*str = malloc(len + 1 + 2);
	if (!*str)
		return -1;
	s = *str;
	if (i - off == 0) {
		*s = 0;
		return 0;
	}
	if (use_group)
		*s++ = '{';
	for (i = 0; attr[i]; i++) {
		strcpy(s, attr[i]);
		s += strlen(s);
		*s++ = ',';
	}
	if (use_group) {
		s[-1] = '}';
		*s = 0;
	} else
		s[-1] = 0;
	return 0;
}

__weak bool arch_topdown_check_group(bool *warn)
{
	*warn = false;
	return false;
}

__weak void arch_topdown_group_warn(void)
{
}

1026 1027 1028 1029 1030 1031
/*
 * Add default attributes, if there were no attributes specified or
 * if -d/--detailed, -d -d or -d -d -d is used:
 */
static int add_default_attributes(void)
{
1032
	int err;
1033
	struct perf_event_attr default_attrs0[] = {
1034 1035 1036 1037 1038 1039 1040

  { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_TASK_CLOCK		},
  { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_CONTEXT_SWITCHES	},
  { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_CPU_MIGRATIONS		},
  { .type = PERF_TYPE_SOFTWARE, .config = PERF_COUNT_SW_PAGE_FAULTS		},

  { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_CPU_CYCLES		},
1041 1042
};
	struct perf_event_attr frontend_attrs[] = {
1043
  { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_STALLED_CYCLES_FRONTEND	},
1044 1045
};
	struct perf_event_attr backend_attrs[] = {
1046
  { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_STALLED_CYCLES_BACKEND	},
1047 1048
};
	struct perf_event_attr default_attrs1[] = {
1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
  { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_INSTRUCTIONS		},
  { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_BRANCH_INSTRUCTIONS	},
  { .type = PERF_TYPE_HARDWARE, .config = PERF_COUNT_HW_BRANCH_MISSES		},

};

/*
 * Detailed stats (-d), covering the L1 and last level data caches:
 */
	struct perf_event_attr detailed_attrs[] = {

  { .type = PERF_TYPE_HW_CACHE,
    .config =
	 PERF_COUNT_HW_CACHE_L1D		<<  0  |
	(PERF_COUNT_HW_CACHE_OP_READ		<<  8) |
	(PERF_COUNT_HW_CACHE_RESULT_ACCESS	<< 16)				},

  { .type = PERF_TYPE_HW_CACHE,
    .config =
	 PERF_COUNT_HW_CACHE_L1D		<<  0  |
	(PERF_COUNT_HW_CACHE_OP_READ		<<  8) |
	(PERF_COUNT_HW_CACHE_RESULT_MISS	<< 16)				},

  { .type = PERF_TYPE_HW_CACHE,
    .config =
	 PERF_COUNT_HW_CACHE_LL			<<  0  |
	(PERF_COUNT_HW_CACHE_OP_READ		<<  8) |
	(PERF_COUNT_HW_CACHE_RESULT_ACCESS	<< 16)				},

  { .type = PERF_TYPE_HW_CACHE,
    .config =
	 PERF_COUNT_HW_CACHE_LL			<<  0  |
	(PERF_COUNT_HW_CACHE_OP_READ		<<  8) |
	(PERF_COUNT_HW_CACHE_RESULT_MISS	<< 16)				},
};

/*
 * Very detailed stats (-d -d), covering the instruction cache and the TLB caches:
 */
	struct perf_event_attr very_detailed_attrs[] = {

  { .type = PERF_TYPE_HW_CACHE,
    .config =
	 PERF_COUNT_HW_CACHE_L1I		<<  0  |
	(PERF_COUNT_HW_CACHE_OP_READ		<<  8) |
	(PERF_COUNT_HW_CACHE_RESULT_ACCESS	<< 16)				},

  { .type = PERF_TYPE_HW_CACHE,
    .config =
	 PERF_COUNT_HW_CACHE_L1I		<<  0  |
	(PERF_COUNT_HW_CACHE_OP_READ		<<  8) |
	(PERF_COUNT_HW_CACHE_RESULT_MISS	<< 16)				},

  { .type = PERF_TYPE_HW_CACHE,
    .config =
	 PERF_COUNT_HW_CACHE_DTLB		<<  0  |
	(PERF_COUNT_HW_CACHE_OP_READ		<<  8) |
	(PERF_COUNT_HW_CACHE_RESULT_ACCESS	<< 16)				},

  { .type = PERF_TYPE_HW_CACHE,
    .config =
	 PERF_COUNT_HW_CACHE_DTLB		<<  0  |
	(PERF_COUNT_HW_CACHE_OP_READ		<<  8) |
	(PERF_COUNT_HW_CACHE_RESULT_MISS	<< 16)				},

  { .type = PERF_TYPE_HW_CACHE,
    .config =
	 PERF_COUNT_HW_CACHE_ITLB		<<  0  |
	(PERF_COUNT_HW_CACHE_OP_READ		<<  8) |
	(PERF_COUNT_HW_CACHE_RESULT_ACCESS	<< 16)				},

  { .type = PERF_TYPE_HW_CACHE,
    .config =
	 PERF_COUNT_HW_CACHE_ITLB		<<  0  |
	(PERF_COUNT_HW_CACHE_OP_READ		<<  8) |
	(PERF_COUNT_HW_CACHE_RESULT_MISS	<< 16)				},

};

/*
 * Very, very detailed stats (-d -d -d), adding prefetch events:
 */
	struct perf_event_attr very_very_detailed_attrs[] = {

  { .type = PERF_TYPE_HW_CACHE,
    .config =
	 PERF_COUNT_HW_CACHE_L1D		<<  0  |
	(PERF_COUNT_HW_CACHE_OP_PREFETCH	<<  8) |
	(PERF_COUNT_HW_CACHE_RESULT_ACCESS	<< 16)				},

  { .type = PERF_TYPE_HW_CACHE,
    .config =
	 PERF_COUNT_HW_CACHE_L1D		<<  0  |
	(PERF_COUNT_HW_CACHE_OP_PREFETCH	<<  8) |
	(PERF_COUNT_HW_CACHE_RESULT_MISS	<< 16)				},
};
1145
	struct parse_events_error errinfo;
1146

1147
	/* Set attrs if no event is selected and !null_run: */
1148
	if (stat_config.null_run)
1149 1150
		return 0;

1151
	if (transaction_run) {
1152 1153 1154 1155 1156 1157 1158 1159 1160
		/* Handle -T as -M transaction. Once platform specific metrics
		 * support has been added to the json files, all archictures
		 * will use this approach. To determine transaction support
		 * on an architecture test for such a metric name.
		 */
		if (metricgroup__has_metric("transaction")) {
			struct option opt = { .value = &evsel_list };

			return metricgroup__parse_groups(&opt, "transaction",
1161
							 &stat_config.metric_events);
1162 1163
		}

1164 1165
		if (pmu_have_event("cpu", "cycles-ct") &&
		    pmu_have_event("cpu", "el-start"))
1166 1167
			err = parse_events(evsel_list, transaction_attrs,
					   &errinfo);
1168
		else
1169 1170 1171
			err = parse_events(evsel_list,
					   transaction_limited_attrs,
					   &errinfo);
1172
		if (err) {
1173
			fprintf(stderr, "Cannot set up transaction events\n");
1174
			parse_events_print_error(&errinfo, transaction_attrs);
1175 1176 1177 1178 1179
			return -1;
		}
		return 0;
	}

1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198
	if (smi_cost) {
		int smi;

		if (sysfs__read_int(FREEZE_ON_SMI_PATH, &smi) < 0) {
			fprintf(stderr, "freeze_on_smi is not supported.\n");
			return -1;
		}

		if (!smi) {
			if (sysfs__write_int(FREEZE_ON_SMI_PATH, 1) < 0) {
				fprintf(stderr, "Failed to set freeze_on_smi.\n");
				return -1;
			}
			smi_reset = true;
		}

		if (pmu_have_event("msr", "aperf") &&
		    pmu_have_event("msr", "smi")) {
			if (!force_metric_only)
1199
				stat_config.metric_only = true;
1200
			err = parse_events(evsel_list, smi_cost_attrs, &errinfo);
1201 1202 1203
		} else {
			fprintf(stderr, "To measure SMI cost, it needs "
				"msr/aperf/, msr/smi/ and cpu/cycles/ support\n");
1204
			parse_events_print_error(&errinfo, smi_cost_attrs);
1205 1206 1207 1208 1209 1210 1211 1212 1213
			return -1;
		}
		if (err) {
			fprintf(stderr, "Cannot set up SMI cost events\n");
			return -1;
		}
		return 0;
	}

1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229
	if (topdown_run) {
		char *str = NULL;
		bool warn = false;

		if (stat_config.aggr_mode != AGGR_GLOBAL &&
		    stat_config.aggr_mode != AGGR_CORE) {
			pr_err("top down event configuration requires --per-core mode\n");
			return -1;
		}
		stat_config.aggr_mode = AGGR_CORE;
		if (nr_cgroups || !target__has_cpu(&target)) {
			pr_err("top down event configuration requires system-wide mode (-a)\n");
			return -1;
		}

		if (!force_metric_only)
1230
			stat_config.metric_only = true;
1231 1232 1233 1234 1235 1236 1237 1238
		if (topdown_filter_events(topdown_attrs, &str,
				arch_topdown_check_group(&warn)) < 0) {
			pr_err("Out of memory\n");
			return -1;
		}
		if (topdown_attrs[0] && str) {
			if (warn)
				arch_topdown_group_warn();
1239
			err = parse_events(evsel_list, str, &errinfo);
1240 1241 1242 1243 1244
			if (err) {
				fprintf(stderr,
					"Cannot set up top down events %s: %d\n",
					str, err);
				free(str);
1245
				parse_events_print_error(&errinfo, str);
1246 1247 1248 1249 1250 1251 1252 1253 1254
				return -1;
			}
		} else {
			fprintf(stderr, "System does not support topdown\n");
			return -1;
		}
		free(str);
	}

1255
	if (!evsel_list->nr_entries) {
1256 1257 1258
		if (target__has_cpu(&target))
			default_attrs0[0].config = PERF_COUNT_SW_CPU_CLOCK;

1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
		if (perf_evlist__add_default_attrs(evsel_list, default_attrs0) < 0)
			return -1;
		if (pmu_have_event("cpu", "stalled-cycles-frontend")) {
			if (perf_evlist__add_default_attrs(evsel_list,
						frontend_attrs) < 0)
				return -1;
		}
		if (pmu_have_event("cpu", "stalled-cycles-backend")) {
			if (perf_evlist__add_default_attrs(evsel_list,
						backend_attrs) < 0)
				return -1;
		}
		if (perf_evlist__add_default_attrs(evsel_list, default_attrs1) < 0)
1272
			return -1;
1273 1274 1275 1276 1277 1278 1279 1280
	}

	/* Detailed events get appended to the event list: */

	if (detailed_run <  1)
		return 0;

	/* Append detailed run extra attributes: */
1281
	if (perf_evlist__add_default_attrs(evsel_list, detailed_attrs) < 0)
1282
		return -1;
1283 1284 1285 1286 1287

	if (detailed_run < 2)
		return 0;

	/* Append very detailed run extra attributes: */
1288
	if (perf_evlist__add_default_attrs(evsel_list, very_detailed_attrs) < 0)
1289
		return -1;
1290 1291 1292 1293 1294

	if (detailed_run < 3)
		return 0;

	/* Append very, very detailed run extra attributes: */
1295
	return perf_evlist__add_default_attrs(evsel_list, very_very_detailed_attrs);
1296 1297
}

J
Jiri Olsa 已提交
1298
static const char * const stat_record_usage[] = {
J
Jiri Olsa 已提交
1299 1300 1301 1302
	"perf stat record [<options>]",
	NULL,
};

1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315
static void init_features(struct perf_session *session)
{
	int feat;

	for (feat = HEADER_FIRST_FEATURE; feat < HEADER_LAST_FEATURE; feat++)
		perf_header__set_feat(&session->header, feat);

	perf_header__clear_feat(&session->header, HEADER_BUILD_ID);
	perf_header__clear_feat(&session->header, HEADER_TRACING_DATA);
	perf_header__clear_feat(&session->header, HEADER_BRANCH_STACK);
	perf_header__clear_feat(&session->header, HEADER_AUXTRACE);
}

J
Jiri Olsa 已提交
1316 1317 1318
static int __cmd_record(int argc, const char **argv)
{
	struct perf_session *session;
1319
	struct perf_data *data = &perf_stat.data;
J
Jiri Olsa 已提交
1320

J
Jiri Olsa 已提交
1321
	argc = parse_options(argc, argv, stat_options, stat_record_usage,
J
Jiri Olsa 已提交
1322 1323 1324
			     PARSE_OPT_STOP_AT_NON_OPTION);

	if (output_name)
J
Jiri Olsa 已提交
1325
		data->file.path = output_name;
J
Jiri Olsa 已提交
1326

1327
	if (stat_config.run_count != 1 || forever) {
1328 1329 1330 1331
		pr_err("Cannot use -r option with perf stat record.\n");
		return -1;
	}

1332
	session = perf_session__new(data, false, NULL);
J
Jiri Olsa 已提交
1333 1334 1335 1336 1337
	if (session == NULL) {
		pr_err("Perf session creation failed.\n");
		return -1;
	}

1338 1339
	init_features(session);

J
Jiri Olsa 已提交
1340 1341 1342 1343 1344 1345
	session->evlist   = evsel_list;
	perf_stat.session = session;
	perf_stat.record  = true;
	return argc;
}

1346 1347
static int process_stat_round_event(struct perf_session *session,
				    union perf_event *event)
1348
{
1349
	struct stat_round_event *stat_round = &event->stat_round;
1350 1351 1352 1353 1354
	struct perf_evsel *counter;
	struct timespec tsh, *ts = NULL;
	const char **argv = session->header.env.cmdline_argv;
	int argc = session->header.env.nr_cmdline;

1355
	evlist__for_each_entry(evsel_list, counter)
1356 1357
		perf_stat_process_counter(&stat_config, counter);

1358 1359
	if (stat_round->type == PERF_STAT_ROUND_TYPE__FINAL)
		update_stats(&walltime_nsecs_stats, stat_round->time);
1360

1361
	if (stat_config.interval && stat_round->time) {
1362 1363
		tsh.tv_sec  = stat_round->time / NSEC_PER_SEC;
		tsh.tv_nsec = stat_round->time % NSEC_PER_SEC;
1364 1365 1366 1367 1368 1369 1370
		ts = &tsh;
	}

	print_counters(ts, argc, argv);
	return 0;
}

1371
static
1372 1373
int process_stat_config_event(struct perf_session *session,
			      union perf_event *event)
1374
{
1375
	struct perf_tool *tool = session->tool;
1376 1377
	struct perf_stat *st = container_of(tool, struct perf_stat, tool);

1378
	perf_event__read_stat_config(&stat_config, &event->stat_config);
1379

1380 1381 1382 1383 1384 1385 1386 1387 1388
	if (cpu_map__empty(st->cpus)) {
		if (st->aggr_mode != AGGR_UNSET)
			pr_warning("warning: processing task data, aggregation mode not set\n");
		return 0;
	}

	if (st->aggr_mode != AGGR_UNSET)
		stat_config.aggr_mode = st->aggr_mode;

1389
	if (perf_stat.data.is_pipe)
1390 1391 1392 1393
		perf_stat_init_aggr_mode();
	else
		perf_stat_init_aggr_mode_file(st);

1394 1395 1396
	return 0;
}

1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414
static int set_maps(struct perf_stat *st)
{
	if (!st->cpus || !st->threads)
		return 0;

	if (WARN_ONCE(st->maps_allocated, "stats double allocation\n"))
		return -EINVAL;

	perf_evlist__set_maps(evsel_list, st->cpus, st->threads);

	if (perf_evlist__alloc_stats(evsel_list, true))
		return -ENOMEM;

	st->maps_allocated = true;
	return 0;
}

static
1415 1416
int process_thread_map_event(struct perf_session *session,
			     union perf_event *event)
1417
{
1418
	struct perf_tool *tool = session->tool;
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433
	struct perf_stat *st = container_of(tool, struct perf_stat, tool);

	if (st->threads) {
		pr_warning("Extra thread map event, ignoring.\n");
		return 0;
	}

	st->threads = thread_map__new_event(&event->thread_map);
	if (!st->threads)
		return -ENOMEM;

	return set_maps(st);
}

static
1434 1435
int process_cpu_map_event(struct perf_session *session,
			  union perf_event *event)
1436
{
1437
	struct perf_tool *tool = session->tool;
1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453
	struct perf_stat *st = container_of(tool, struct perf_stat, tool);
	struct cpu_map *cpus;

	if (st->cpus) {
		pr_warning("Extra cpu map event, ignoring.\n");
		return 0;
	}

	cpus = cpu_map__new_data(&event->cpu_map.data);
	if (!cpus)
		return -ENOMEM;

	st->cpus = cpus;
	return set_maps(st);
}

1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
static int runtime_stat_new(struct perf_stat_config *config, int nthreads)
{
	int i;

	config->stats = calloc(nthreads, sizeof(struct runtime_stat));
	if (!config->stats)
		return -1;

	config->stats_num = nthreads;

	for (i = 0; i < nthreads; i++)
		runtime_stat__init(&config->stats[i]);

	return 0;
}

static void runtime_stat_delete(struct perf_stat_config *config)
{
	int i;

	if (!config->stats)
		return;

	for (i = 0; i < config->stats_num; i++)
		runtime_stat__exit(&config->stats[i]);

	free(config->stats);
}

J
Jiri Olsa 已提交
1483
static const char * const stat_report_usage[] = {
J
Jiri Olsa 已提交
1484 1485 1486 1487 1488 1489 1490
	"perf stat report [<options>]",
	NULL,
};

static struct perf_stat perf_stat = {
	.tool = {
		.attr		= perf_event__process_attr,
1491
		.event_update	= perf_event__process_event_update,
1492 1493
		.thread_map	= process_thread_map_event,
		.cpu_map	= process_cpu_map_event,
1494
		.stat_config	= process_stat_config_event,
1495 1496
		.stat		= perf_event__process_stat_event,
		.stat_round	= process_stat_round_event,
J
Jiri Olsa 已提交
1497
	},
1498
	.aggr_mode = AGGR_UNSET,
J
Jiri Olsa 已提交
1499 1500 1501 1502 1503 1504 1505
};

static int __cmd_report(int argc, const char **argv)
{
	struct perf_session *session;
	const struct option options[] = {
	OPT_STRING('i', "input", &input_name, "file", "input file name"),
1506 1507 1508 1509 1510 1511
	OPT_SET_UINT(0, "per-socket", &perf_stat.aggr_mode,
		     "aggregate counts per processor socket", AGGR_SOCKET),
	OPT_SET_UINT(0, "per-core", &perf_stat.aggr_mode,
		     "aggregate counts per physical processor core", AGGR_CORE),
	OPT_SET_UINT('A', "no-aggr", &perf_stat.aggr_mode,
		     "disable CPU count aggregation", AGGR_NONE),
J
Jiri Olsa 已提交
1512 1513 1514 1515 1516
	OPT_END()
	};
	struct stat st;
	int ret;

J
Jiri Olsa 已提交
1517
	argc = parse_options(argc, argv, options, stat_report_usage, 0);
J
Jiri Olsa 已提交
1518 1519 1520 1521 1522 1523 1524 1525

	if (!input_name || !strlen(input_name)) {
		if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
			input_name = "-";
		else
			input_name = "perf.data";
	}

J
Jiri Olsa 已提交
1526 1527
	perf_stat.data.file.path = input_name;
	perf_stat.data.mode      = PERF_DATA_MODE_READ;
J
Jiri Olsa 已提交
1528

1529
	session = perf_session__new(&perf_stat.data, false, &perf_stat.tool);
J
Jiri Olsa 已提交
1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544
	if (session == NULL)
		return -1;

	perf_stat.session  = session;
	stat_config.output = stderr;
	evsel_list         = session->evlist;

	ret = perf_session__process_events(session);
	if (ret)
		return ret;

	perf_session__delete(session);
	return 0;
}

1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573
static void setup_system_wide(int forks)
{
	/*
	 * Make system wide (-a) the default target if
	 * no target was specified and one of following
	 * conditions is met:
	 *
	 *   - there's no workload specified
	 *   - there is workload specified but all requested
	 *     events are system wide events
	 */
	if (!target__none(&target))
		return;

	if (!forks)
		target.system_wide = true;
	else {
		struct perf_evsel *counter;

		evlist__for_each_entry(evsel_list, counter) {
			if (!counter->system_wide)
				return;
		}

		if (evsel_list->nr_entries)
			target.system_wide = true;
	}
}

1574
int cmd_stat(int argc, const char **argv)
1575
{
1576 1577 1578 1579
	const char * const stat_usage[] = {
		"perf stat [<options>] [<command>]",
		NULL
	};
1580
	int status = -EINVAL, run_idx;
1581
	const char *mode;
1582
	FILE *output = stderr;
1583
	unsigned int interval, timeout;
J
Jiri Olsa 已提交
1584
	const char * const stat_subcommands[] = { "record", "report" };
1585

1586 1587
	setlocale(LC_ALL, "");

1588
	evsel_list = perf_evlist__new();
1589 1590 1591
	if (evsel_list == NULL)
		return -ENOMEM;

1592
	parse_events__shrink_config_terms();
1593 1594 1595 1596 1597 1598

	/* String-parsing callback-based options would segfault when negated */
	set_option_flag(stat_options, 'e', "event", PARSE_OPT_NONEG);
	set_option_flag(stat_options, 'M', "metrics", PARSE_OPT_NONEG);
	set_option_flag(stat_options, 'G', "cgroup", PARSE_OPT_NONEG);

J
Jiri Olsa 已提交
1599 1600 1601
	argc = parse_options_subcommand(argc, argv, stat_options, stat_subcommands,
					(const char **) stat_usage,
					PARSE_OPT_STOP_AT_NON_OPTION);
1602
	perf_stat__collect_metric_expr(evsel_list);
1603
	perf_stat__init_shadow_stats();
J
Jiri Olsa 已提交
1604

1605 1606 1607 1608
	if (stat_config.csv_sep) {
		stat_config.csv_output = true;
		if (!strcmp(stat_config.csv_sep, "\\t"))
			stat_config.csv_sep = "\t";
1609
	} else
1610
		stat_config.csv_sep = DEFAULT_SEPARATOR;
1611

J
Jiri Olsa 已提交
1612 1613 1614 1615
	if (argc && !strncmp(argv[0], "rec", 3)) {
		argc = __cmd_record(argc, argv);
		if (argc < 0)
			return -1;
J
Jiri Olsa 已提交
1616 1617
	} else if (argc && !strncmp(argv[0], "rep", 3))
		return __cmd_report(argc, argv);
S
Stephane Eranian 已提交
1618

1619
	interval = stat_config.interval;
1620
	timeout = stat_config.timeout;
1621

J
Jiri Olsa 已提交
1622 1623 1624 1625
	/*
	 * For record command the -o is already taken care of.
	 */
	if (!STAT_RECORD && output_name && strcmp(output_name, "-"))
1626 1627
		output = NULL;

1628 1629
	if (output_name && output_fd) {
		fprintf(stderr, "cannot use both --output and --log-fd\n");
J
Jiri Olsa 已提交
1630 1631
		parse_options_usage(stat_usage, stat_options, "o", 1);
		parse_options_usage(NULL, stat_options, "log-fd", 0);
1632
		goto out;
1633
	}
1634

1635
	if (stat_config.metric_only && stat_config.aggr_mode == AGGR_THREAD) {
1636 1637 1638 1639
		fprintf(stderr, "--metric-only is not supported with --per-thread\n");
		goto out;
	}

1640
	if (stat_config.metric_only && stat_config.run_count > 1) {
1641 1642 1643 1644
		fprintf(stderr, "--metric-only is not supported with -r\n");
		goto out;
	}

1645
	if (stat_config.walltime_run_table && stat_config.run_count <= 1) {
1646 1647 1648 1649 1650 1651
		fprintf(stderr, "--table is only supported with -r\n");
		parse_options_usage(stat_usage, stat_options, "r", 1);
		parse_options_usage(NULL, stat_options, "table", 0);
		goto out;
	}

1652 1653
	if (output_fd < 0) {
		fprintf(stderr, "argument to --log-fd must be a > 0\n");
J
Jiri Olsa 已提交
1654
		parse_options_usage(stat_usage, stat_options, "log-fd", 0);
1655
		goto out;
1656 1657
	}

1658 1659 1660 1661 1662 1663 1664
	if (!output) {
		struct timespec tm;
		mode = append_file ? "a" : "w";

		output = fopen(output_name, mode);
		if (!output) {
			perror("failed to create output file");
1665
			return -1;
1666 1667 1668
		}
		clock_gettime(CLOCK_REALTIME, &tm);
		fprintf(output, "# started on %s\n", ctime(&tm.tv_sec));
1669
	} else if (output_fd > 0) {
1670 1671 1672 1673 1674 1675
		mode = append_file ? "a" : "w";
		output = fdopen(output_fd, mode);
		if (!output) {
			perror("Failed opening logfd");
			return -errno;
		}
1676 1677
	}

1678 1679
	stat_config.output = output;

S
Stephane Eranian 已提交
1680 1681 1682
	/*
	 * let the spreadsheet do the pretty-printing
	 */
1683
	if (stat_config.csv_output) {
J
Jim Cromie 已提交
1684
		/* User explicitly passed -B? */
S
Stephane Eranian 已提交
1685 1686
		if (big_num_opt == 1) {
			fprintf(stderr, "-B option not supported with -x\n");
J
Jiri Olsa 已提交
1687 1688
			parse_options_usage(stat_usage, stat_options, "B", 1);
			parse_options_usage(NULL, stat_options, "x", 1);
1689
			goto out;
S
Stephane Eranian 已提交
1690
		} else /* Nope, so disable big number formatting */
1691
			stat_config.big_num = false;
S
Stephane Eranian 已提交
1692
	} else if (big_num_opt == 0) /* User passed --no-big-num */
1693
		stat_config.big_num = false;
S
Stephane Eranian 已提交
1694

1695
	setup_system_wide(argc);
1696

1697 1698 1699 1700
	/*
	 * Display user/system times only for single
	 * run and when there's specified tracee.
	 */
1701
	if ((stat_config.run_count == 1) && target__none(&target))
1702
		stat_config.ru_display = true;
1703

1704
	if (stat_config.run_count < 0) {
1705
		pr_err("Run count must be a positive number\n");
J
Jiri Olsa 已提交
1706
		parse_options_usage(stat_usage, stat_options, "r", 1);
1707
		goto out;
1708
	} else if (stat_config.run_count == 0) {
1709
		forever = true;
1710
		stat_config.run_count = 1;
1711
	}
1712

1713 1714 1715
	if (stat_config.walltime_run_table) {
		stat_config.walltime_run = zalloc(stat_config.run_count * sizeof(stat_config.walltime_run[0]));
		if (!stat_config.walltime_run) {
1716 1717 1718 1719 1720
			pr_err("failed to setup -r option");
			goto out;
		}
	}

1721 1722 1723 1724 1725 1726 1727 1728 1729 1730
	if ((stat_config.aggr_mode == AGGR_THREAD) &&
		!target__has_task(&target)) {
		if (!target.system_wide || target.cpu_list) {
			fprintf(stderr, "The --per-thread option is only "
				"available when monitoring via -p -t -a "
				"options or only --per-thread.\n");
			parse_options_usage(NULL, stat_options, "p", 1);
			parse_options_usage(NULL, stat_options, "t", 1);
			goto out;
		}
1731 1732 1733 1734 1735 1736
	}

	/*
	 * no_aggr, cgroup are for system-wide only
	 * --per-thread is aggregated per thread, we dont mix it with cpu mode
	 */
1737 1738
	if (((stat_config.aggr_mode != AGGR_GLOBAL &&
	      stat_config.aggr_mode != AGGR_THREAD) || nr_cgroups) &&
1739
	    !target__has_cpu(&target)) {
S
Stephane Eranian 已提交
1740 1741 1742
		fprintf(stderr, "both cgroup and no-aggregation "
			"modes only available in system-wide mode\n");

J
Jiri Olsa 已提交
1743 1744 1745
		parse_options_usage(stat_usage, stat_options, "G", 1);
		parse_options_usage(NULL, stat_options, "A", 1);
		parse_options_usage(NULL, stat_options, "a", 1);
1746
		goto out;
1747 1748
	}

1749 1750
	if (add_default_attributes())
		goto out;
1751

1752
	target__validate(&target);
1753

1754 1755 1756
	if ((stat_config.aggr_mode == AGGR_THREAD) && (target.system_wide))
		target.per_thread = true;

1757
	if (perf_evlist__create_maps(evsel_list, &target) < 0) {
1758
		if (target__has_task(&target)) {
1759
			pr_err("Problems finding threads of monitor\n");
J
Jiri Olsa 已提交
1760 1761
			parse_options_usage(stat_usage, stat_options, "p", 1);
			parse_options_usage(NULL, stat_options, "t", 1);
1762
		} else if (target__has_cpu(&target)) {
1763
			perror("failed to parse CPUs map");
J
Jiri Olsa 已提交
1764 1765
			parse_options_usage(stat_usage, stat_options, "C", 1);
			parse_options_usage(NULL, stat_options, "a", 1);
1766 1767
		}
		goto out;
1768
	}
1769 1770 1771 1772 1773

	/*
	 * Initialize thread_map with comm names,
	 * so we could print it out on output.
	 */
1774
	if (stat_config.aggr_mode == AGGR_THREAD) {
1775
		thread_map__read_comms(evsel_list->threads);
1776 1777 1778 1779 1780 1781 1782
		if (target.system_wide) {
			if (runtime_stat_new(&stat_config,
				thread_map__nr(evsel_list->threads))) {
				goto out;
			}
		}
	}
1783

1784 1785 1786 1787 1788 1789 1790 1791 1792
	if (stat_config.times && interval)
		interval_count = true;
	else if (stat_config.times && !interval) {
		pr_err("interval-count option should be used together with "
				"interval-print.\n");
		parse_options_usage(stat_usage, stat_options, "interval-count", 0);
		parse_options_usage(stat_usage, stat_options, "I", 1);
		goto out;
	}
1793

1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810
	if (timeout && timeout < 100) {
		if (timeout < 10) {
			pr_err("timeout must be >= 10ms.\n");
			parse_options_usage(stat_usage, stat_options, "timeout", 0);
			goto out;
		} else
			pr_warning("timeout < 100ms. "
				   "The overhead percentage could be high in some cases. "
				   "Please proceed with caution.\n");
	}
	if (timeout && interval) {
		pr_err("timeout option is not supported with interval-print.\n");
		parse_options_usage(stat_usage, stat_options, "timeout", 0);
		parse_options_usage(stat_usage, stat_options, "I", 1);
		goto out;
	}

1811
	if (perf_evlist__alloc_stats(evsel_list, interval))
1812
		goto out;
1813

1814
	if (perf_stat_init_aggr_mode())
1815
		goto out;
1816

1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827
	/*
	 * Set sample_type to PERF_SAMPLE_IDENTIFIER, which should be harmless
	 * while avoiding that older tools show confusing messages.
	 *
	 * However for pipe sessions we need to keep it zero,
	 * because script's perf_evsel__check_attr is triggered
	 * by attr->sample_type != 0, and we can't run it on
	 * stat sessions.
	 */
	stat_config.identifier = !(STAT_RECORD && perf_stat.data.is_pipe);

I
Ingo Molnar 已提交
1828 1829 1830 1831 1832 1833
	/*
	 * We dont want to block the signals - that would cause
	 * child tasks to inherit that and Ctrl-C would not work.
	 * What we want is for Ctrl-C to work in the exec()-ed
	 * task, but being ignored by perf stat itself:
	 */
1834
	atexit(sig_atexit);
1835 1836
	if (!forever)
		signal(SIGINT,  skip_signal);
1837
	signal(SIGCHLD, skip_signal);
I
Ingo Molnar 已提交
1838 1839 1840
	signal(SIGALRM, skip_signal);
	signal(SIGABRT, skip_signal);

1841
	status = 0;
1842 1843
	for (run_idx = 0; forever || run_idx < stat_config.run_count; run_idx++) {
		if (stat_config.run_count != 1 && verbose > 0)
1844 1845
			fprintf(output, "[ perf stat: executing run #%d ... ]\n",
				run_idx + 1);
I
Ingo Molnar 已提交
1846

1847
		status = run_perf_stat(argc, argv, run_idx);
1848
		if (forever && status != -1) {
1849
			print_counters(NULL, argc, argv);
1850
			perf_stat__reset_stats();
1851
		}
1852 1853
	}

1854
	if (!forever && status != -1 && !interval)
1855
		print_counters(NULL, argc, argv);
1856

J
Jiri Olsa 已提交
1857 1858 1859 1860 1861 1862 1863 1864
	if (STAT_RECORD) {
		/*
		 * We synthesize the kernel mmap record just so that older tools
		 * don't emit warnings about not being able to resolve symbols
		 * due to /proc/sys/kernel/kptr_restrict settings and instear provide
		 * a saner message about no samples being in the perf.data file.
		 *
		 * This also serves to suppress a warning about f_header.data.size == 0
1865 1866 1867 1868
		 * in header.c at the moment 'perf stat record' gets introduced, which
		 * is not really needed once we start adding the stat specific PERF_RECORD_
		 * records, but the need to suppress the kptr_restrict messages in older
		 * tools remain  -acme
J
Jiri Olsa 已提交
1869
		 */
1870
		int fd = perf_data__fd(&perf_stat.data);
J
Jiri Olsa 已提交
1871 1872 1873 1874 1875 1876 1877 1878
		int err = perf_event__synthesize_kernel_mmap((void *)&perf_stat,
							     process_synthesized_event,
							     &perf_stat.session->machines.host);
		if (err) {
			pr_warning("Couldn't synthesize the kernel mmap record, harmless, "
				   "older tools may produce warnings about this file\n.");
		}

1879 1880 1881 1882 1883
		if (!interval) {
			if (WRITE_STAT_ROUND_EVENT(walltime_nsecs_stats.max, FINAL))
				pr_err("failed to write stat round event\n");
		}

1884
		if (!perf_stat.data.is_pipe) {
1885 1886 1887
			perf_stat.session->header.data_size += perf_stat.bytes_written;
			perf_session__write_header(perf_stat.session, evsel_list, fd, true);
		}
J
Jiri Olsa 已提交
1888 1889 1890 1891

		perf_session__delete(perf_stat.session);
	}

1892
	perf_stat__exit_aggr_mode();
1893
	perf_evlist__free_stats(evsel_list);
1894
out:
1895
	free(stat_config.walltime_run);
1896

1897 1898 1899
	if (smi_cost && smi_reset)
		sysfs__write_int(FREEZE_ON_SMI_PATH, 0);

1900
	perf_evlist__delete(evsel_list);
1901 1902 1903

	runtime_stat_delete(&stat_config);

1904
	return status;
1905
}