builtin-top.c 44.7 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0-only
2
/*
3 4 5 6 7 8
 * builtin-top.c
 *
 * Builtin top command: Display a continuously updated profile of
 * any workload, CPU or specific PID.
 *
 * Copyright (C) 2008, Red Hat Inc, Ingo Molnar <mingo@redhat.com>
9
 *		 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
10 11 12 13 14 15 16 17
 *
 * 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>
18
 */
19
#include "builtin.h"
20

21
#include "perf.h"
22

23
#include "util/annotate.h"
24
#include "util/bpf-event.h"
25
#include "util/config.h"
26
#include "util/color.h"
27
#include "util/dso.h"
28
#include "util/evlist.h"
29
#include "util/evsel.h"
30
#include "util/event.h"
31
#include "util/machine.h"
32
#include "util/map.h"
33 34
#include "util/session.h"
#include "util/symbol.h"
35
#include "util/top.h"
36
#include "util/util.h"
37
#include <linux/rbtree.h>
38
#include <subcmd/parse-options.h>
39
#include "util/parse-events.h"
40
#include "util/callchain.h"
41
#include "util/cpumap.h"
42
#include "util/sort.h"
43
#include "util/string2.h"
44
#include "util/term.h"
45
#include "util/intlist.h"
46
#include "util/parse-branch-options.h"
47
#include "arch/common.h"
48
#include "ui/ui.h"
49

50
#include "util/debug.h"
J
Jiri Olsa 已提交
51
#include "util/ordered-events.h"
52

53
#include <assert.h>
54
#include <elf.h>
55
#include <fcntl.h>
56

57
#include <stdio.h>
58 59
#include <termios.h>
#include <unistd.h>
60
#include <inttypes.h>
61

62 63 64
#include <errno.h>
#include <time.h>
#include <sched.h>
65
#include <signal.h>
66 67 68

#include <sys/syscall.h>
#include <sys/ioctl.h>
69
#include <poll.h>
70 71 72
#include <sys/prctl.h>
#include <sys/wait.h>
#include <sys/uio.h>
73
#include <sys/utsname.h>
74 75
#include <sys/mman.h>

76
#include <linux/stringify.h>
77
#include <linux/time64.h>
78 79
#include <linux/types.h>

80
#include <linux/ctype.h>
81

82
static volatile int done;
83
static volatile int resize;
84

N
Namhyung Kim 已提交
85 86
#define HEADER_LINE_NR  5

87
static void perf_top__update_print_entries(struct perf_top *top)
88
{
N
Namhyung Kim 已提交
89
	top->print_entries = top->winsize.ws_row - HEADER_LINE_NR;
90 91
}

92
static void winch_sig(int sig __maybe_unused)
93
{
94 95
	resize = 1;
}
96

97 98
static void perf_top__resize(struct perf_top *top)
{
99 100
	get_term_dimensions(&top->winsize);
	perf_top__update_print_entries(top);
101 102
}

103
static int perf_top__parse_source(struct perf_top *top, struct hist_entry *he)
104
{
105
	struct evsel *evsel;
106
	struct symbol *sym;
107
	struct annotation *notes;
108
	struct map *map;
109
	int err = -1;
110

111
	if (!he || !he->ms.sym)
112 113
		return -1;

114 115
	evsel = hists_to_evsel(he->hists);

116 117
	sym = he->ms.sym;
	map = he->ms.map;
118 119 120 121

	/*
	 * We can't annotate with just /proc/kallsyms
	 */
122 123
	if (map->dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
	    !dso__is_kcore(map->dso)) {
124 125 126
		pr_err("Can't annotate %s: No vmlinux file was found in the "
		       "path\n", sym->name);
		sleep(1);
127
		return -1;
128 129
	}

130 131
	notes = symbol__annotation(sym);
	pthread_mutex_lock(&notes->lock);
132

133
	if (!symbol__hists(sym, top->evlist->core.nr_entries)) {
134
		pthread_mutex_unlock(&notes->lock);
135 136
		pr_err("Not enough memory for annotating '%s' symbol!\n",
		       sym->name);
137
		sleep(1);
138
		return err;
139
	}
140

141
	err = symbol__annotate(sym, map, evsel, 0, &top->annotation_opts, NULL);
142
	if (err == 0) {
143
		top->sym_filter_entry = he;
144 145 146 147
	} else {
		char msg[BUFSIZ];
		symbol__strerror_disassemble(sym, map, err, msg, sizeof(msg));
		pr_err("Couldn't annotate %s: %s\n", sym->name, msg);
148
	}
149

150
	pthread_mutex_unlock(&notes->lock);
151
	return err;
152 153
}

154
static void __zero_source_counters(struct hist_entry *he)
155
{
156
	struct symbol *sym = he->ms.sym;
157
	symbol__annotate_zero_histograms(sym);
158 159
}

160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
static void ui__warn_map_erange(struct map *map, struct symbol *sym, u64 ip)
{
	struct utsname uts;
	int err = uname(&uts);

	ui__warning("Out of bounds address found:\n\n"
		    "Addr:   %" PRIx64 "\n"
		    "DSO:    %s %c\n"
		    "Map:    %" PRIx64 "-%" PRIx64 "\n"
		    "Symbol: %" PRIx64 "-%" PRIx64 " %c %s\n"
		    "Arch:   %s\n"
		    "Kernel: %s\n"
		    "Tools:  %s\n\n"
		    "Not all samples will be on the annotation output.\n\n"
		    "Please report to linux-kernel@vger.kernel.org\n",
		    ip, map->dso->long_name, dso__symtab_origin(map->dso),
		    map->start, map->end, sym->start, sym->end,
		    sym->binding == STB_GLOBAL ? 'g' :
		    sym->binding == STB_LOCAL  ? 'l' : 'w', sym->name,
		    err ? "[unknown]" : uts.machine,
		    err ? "[unknown]" : uts.release, perf_version_string);
	if (use_browser <= 0)
		sleep(5);
183

184 185 186
	map->erange_warned = true;
}

187 188
static void perf_top__record_precise_ip(struct perf_top *top,
					struct hist_entry *he,
189
					struct perf_sample *sample,
190
					struct evsel *evsel, u64 ip)
191
{
192
	struct annotation *notes;
193
	struct symbol *sym = he->ms.sym;
194
	int err = 0;
195

196 197 198
	if (sym == NULL || (use_browser == 0 &&
			    (top->sym_filter_entry == NULL ||
			     top->sym_filter_entry->ms.sym != sym)))
199 200
		return;

201 202 203
	notes = symbol__annotation(sym);

	if (pthread_mutex_trylock(&notes->lock))
204 205
		return;

206
	err = hist_entry__inc_addr_samples(he, sample, evsel, ip);
207

208
	pthread_mutex_unlock(&notes->lock);
209

210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
	if (unlikely(err)) {
		/*
		 * This function is now called with he->hists->lock held.
		 * Release it before going to sleep.
		 */
		pthread_mutex_unlock(&he->hists->lock);

		if (err == -ERANGE && !he->ms.map->erange_warned)
			ui__warn_map_erange(he->ms.map, sym, ip);
		else if (err == -ENOMEM) {
			pr_err("Not enough memory for annotating '%s' symbol!\n",
			       sym->name);
			sleep(1);
		}

		pthread_mutex_lock(&he->hists->lock);
226
	}
227 228
}

229
static void perf_top__show_details(struct perf_top *top)
230
{
231
	struct hist_entry *he = top->sym_filter_entry;
232
	struct evsel *evsel;
233
	struct annotation *notes;
234
	struct symbol *symbol;
235
	int more;
236

237
	if (!he)
238 239
		return;

240 241
	evsel = hists_to_evsel(he->hists);

242
	symbol = he->ms.sym;
243 244 245 246
	notes = symbol__annotation(symbol);

	pthread_mutex_lock(&notes->lock);

247 248
	symbol__calc_percent(symbol, evsel);

249 250
	if (notes->src == NULL)
		goto out_unlock;
251

252
	printf("Showing %s for %s\n", perf_evsel__name(top->sym_evsel), symbol->name);
253
	printf("  Events  Pcnt (>=%d%%)\n", top->annotation_opts.min_pcnt);
254

255
	more = symbol__annotate_printf(symbol, he->ms.map, top->sym_evsel, &top->annotation_opts);
256 257 258 259 260 261 262

	if (top->evlist->enabled) {
		if (top->zero)
			symbol__annotate_zero_histogram(symbol, top->sym_evsel->idx);
		else
			symbol__annotate_decay_histogram(symbol, top->sym_evsel->idx);
	}
263
	if (more != 0)
264
		printf("%d lines not displayed, maybe increase display entries [e]\n", more);
265 266
out_unlock:
	pthread_mutex_unlock(&notes->lock);
267
}
268

269
static void perf_top__resort_hists(struct perf_top *t)
270
{
271
	struct evlist *evlist = t->evlist;
272 273 274 275 276
	struct evsel *pos;

	evlist__for_each_entry(evlist, pos) {
		struct hists *hists = evsel__hists(pos);

277 278 279 280 281 282
		/*
		 * unlink existing entries so that they can be linked
		 * in a correct order in hists__match() below.
		 */
		hists__unlink(hists);

283 284 285 286 287 288 289 290 291
		if (evlist->enabled) {
			if (t->zero) {
				hists__delete_entries(hists);
			} else {
				hists__decay_entries(hists, t->hide_user_symbols,
						     t->hide_kernel_symbols);
			}
		}

292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
		hists__collapse_resort(hists, NULL);

		/* Non-group events are considered as leader */
		if (symbol_conf.event_group &&
		    !perf_evsel__is_group_leader(pos)) {
			struct hists *leader_hists = evsel__hists(pos->leader);

			hists__match(leader_hists, hists);
			hists__link(leader_hists, hists);
		}
	}

	evlist__for_each_entry(evlist, pos) {
		perf_evsel__output_resort(pos, NULL);
	}
}

309
static void perf_top__print_sym_table(struct perf_top *top)
310
{
311 312
	char bf[160];
	int printed = 0;
313
	const int win_width = top->winsize.ws_col - 1;
314
	struct evsel *evsel = top->sym_evsel;
315
	struct hists *hists = evsel__hists(evsel);
316

317
	puts(CONSOLE_CLEAR);
318

319
	perf_top__header_snprintf(top, bf, sizeof(bf));
320
	printf("%s\n", bf);
321

322
	printf("%-*.*s\n", win_width, win_width, graph_dotted_line);
323

324 325 326
	if (!top->record_opts.overwrite &&
	    (hists->stats.nr_lost_warned !=
	    hists->stats.nr_events[PERF_RECORD_LOST])) {
327 328
		hists->stats.nr_lost_warned =
			      hists->stats.nr_events[PERF_RECORD_LOST];
329 330
		color_fprintf(stdout, PERF_COLOR_RED,
			      "WARNING: LOST %d chunks, Check IO/CPU overload",
331
			      hists->stats.nr_lost_warned);
332
		++printed;
333 334
	}

335 336
	if (top->sym_filter_entry) {
		perf_top__show_details(top);
337 338 339
		return;
	}

340
	perf_top__resort_hists(top);
N
Namhyung Kim 已提交
341

342
	hists__output_recalc_col_len(hists, top->print_entries - printed);
343
	putchar('\n');
344
	hists__fprintf(hists, false, top->print_entries - printed, win_width,
345
		       top->min_percent, stdout, !symbol_conf.use_callchain);
346 347
}

348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382
static void prompt_integer(int *target, const char *msg)
{
	char *buf = malloc(0), *p;
	size_t dummy = 0;
	int tmp;

	fprintf(stdout, "\n%s: ", msg);
	if (getline(&buf, &dummy, stdin) < 0)
		return;

	p = strchr(buf, '\n');
	if (p)
		*p = 0;

	p = buf;
	while(*p) {
		if (!isdigit(*p))
			goto out_free;
		p++;
	}
	tmp = strtoul(buf, NULL, 10);
	*target = tmp;
out_free:
	free(buf);
}

static void prompt_percent(int *target, const char *msg)
{
	int tmp = 0;

	prompt_integer(&tmp, msg);
	if (tmp >= 0 && tmp <= 100)
		*target = tmp;
}

383
static void perf_top__prompt_symbol(struct perf_top *top, const char *msg)
384 385
{
	char *buf = malloc(0), *p;
386
	struct hist_entry *syme = top->sym_filter_entry, *n, *found = NULL;
387
	struct hists *hists = evsel__hists(top->sym_evsel);
388
	struct rb_node *next;
389 390 391 392 393
	size_t dummy = 0;

	/* zero counters of active symbol */
	if (syme) {
		__zero_source_counters(syme);
394
		top->sym_filter_entry = NULL;
395 396 397 398 399 400 401 402 403 404
	}

	fprintf(stdout, "\n%s: ", msg);
	if (getline(&buf, &dummy, stdin) < 0)
		goto out_free;

	p = strchr(buf, '\n');
	if (p)
		*p = 0;

D
Davidlohr Bueso 已提交
405
	next = rb_first_cached(&hists->entries);
406 407 408 409
	while (next) {
		n = rb_entry(next, struct hist_entry, rb_node);
		if (n->ms.sym && !strcmp(buf, n->ms.sym->name)) {
			found = n;
410 411
			break;
		}
412
		next = rb_next(&n->rb_node);
413 414 415
	}

	if (!found) {
416
		fprintf(stderr, "Sorry, %s is not active.\n", buf);
417 418
		sleep(1);
	} else
419
		perf_top__parse_source(top, found);
420 421 422 423 424

out_free:
	free(buf);
}

425
static void perf_top__print_mapped_keys(struct perf_top *top)
426
{
427 428
	char *name = NULL;

429 430
	if (top->sym_filter_entry) {
		struct symbol *sym = top->sym_filter_entry->ms.sym;
431 432 433 434
		name = sym->name;
	}

	fprintf(stdout, "\nMapped keys:\n");
435 436
	fprintf(stdout, "\t[d]     display refresh delay.             \t(%d)\n", top->delay_secs);
	fprintf(stdout, "\t[e]     display entries (lines).           \t(%d)\n", top->print_entries);
437

438
	if (top->evlist->core.nr_entries > 1)
439
		fprintf(stdout, "\t[E]     active event counter.              \t(%s)\n", perf_evsel__name(top->sym_evsel));
440

441
	fprintf(stdout, "\t[f]     profile display filter (count).    \t(%d)\n", top->count_filter);
442

443
	fprintf(stdout, "\t[F]     annotate display filter (percent). \t(%d%%)\n", top->annotation_opts.min_pcnt);
444 445
	fprintf(stdout, "\t[s]     annotate symbol.                   \t(%s)\n", name?: "NULL");
	fprintf(stdout, "\t[S]     stop annotation.\n");
446

447
	fprintf(stdout,
S
Sihyeon Jang 已提交
448
		"\t[K]     hide kernel symbols.             \t(%s)\n",
449
		top->hide_kernel_symbols ? "yes" : "no");
450 451
	fprintf(stdout,
		"\t[U]     hide user symbols.               \t(%s)\n",
452 453
		top->hide_user_symbols ? "yes" : "no");
	fprintf(stdout, "\t[z]     toggle sample zeroing.             \t(%d)\n", top->zero ? 1 : 0);
454 455 456
	fprintf(stdout, "\t[qQ]    quit.\n");
}

457
static int perf_top__key_mapped(struct perf_top *top, int c)
458 459 460 461 462 463 464 465
{
	switch (c) {
		case 'd':
		case 'e':
		case 'f':
		case 'z':
		case 'q':
		case 'Q':
466 467
		case 'K':
		case 'U':
468 469 470
		case 'F':
		case 's':
		case 'S':
471 472
			return 1;
		case 'E':
473
			return top->evlist->core.nr_entries > 1 ? 1 : 0;
474 475
		default:
			break;
476 477 478
	}

	return 0;
479 480
}

481
static bool perf_top__handle_keypress(struct perf_top *top, int c)
482
{
483 484
	bool ret = true;

485
	if (!perf_top__key_mapped(top, c)) {
486
		struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
487
		struct termios save;
488

489
		perf_top__print_mapped_keys(top);
490 491 492
		fprintf(stdout, "\nEnter selection, or unmapped key to continue: ");
		fflush(stdout);

493
		set_term_quiet_input(&save);
494 495 496 497 498

		poll(&stdin_poll, 1, -1);
		c = getc(stdin);

		tcsetattr(0, TCSAFLUSH, &save);
499
		if (!perf_top__key_mapped(top, c))
500
			return ret;
501 502
	}

503 504
	switch (c) {
		case 'd':
505 506 507
			prompt_integer(&top->delay_secs, "Enter display delay");
			if (top->delay_secs < 1)
				top->delay_secs = 1;
508 509
			break;
		case 'e':
510 511
			prompt_integer(&top->print_entries, "Enter display entries (lines)");
			if (top->print_entries == 0) {
512
				perf_top__resize(top);
513
				signal(SIGWINCH, winch_sig);
514
			} else {
515
				signal(SIGWINCH, SIG_DFL);
516
			}
517 518
			break;
		case 'E':
519
			if (top->evlist->core.nr_entries > 1) {
520 521 522
				/* Select 0 as the default event: */
				int counter = 0;

523
				fprintf(stderr, "\nAvailable events:");
524

525
				evlist__for_each_entry(top->evlist, top->sym_evsel)
526
					fprintf(stderr, "\n\t%d %s", top->sym_evsel->idx, perf_evsel__name(top->sym_evsel));
527

528
				prompt_integer(&counter, "Enter details event counter");
529

530
				if (counter >= top->evlist->core.nr_entries) {
531
					top->sym_evsel = perf_evlist__first(top->evlist);
532
					fprintf(stderr, "Sorry, no such event, using %s.\n", perf_evsel__name(top->sym_evsel));
533
					sleep(1);
534
					break;
535
				}
536
				evlist__for_each_entry(top->evlist, top->sym_evsel)
537
					if (top->sym_evsel->idx == counter)
538
						break;
539
			} else
540
				top->sym_evsel = perf_evlist__first(top->evlist);
541 542
			break;
		case 'f':
543
			prompt_integer(&top->count_filter, "Enter display event count filter");
544 545
			break;
		case 'F':
546
			prompt_percent(&top->annotation_opts.min_pcnt,
547
				       "Enter details display event filter (percent)");
548
			break;
549
		case 'K':
550
			top->hide_kernel_symbols = !top->hide_kernel_symbols;
551
			break;
552 553 554
		case 'q':
		case 'Q':
			printf("exiting.\n");
555 556
			if (top->dump_symtab)
				perf_session__fprintf_dsos(top->session, stderr);
557 558
			ret = false;
			break;
559
		case 's':
560
			perf_top__prompt_symbol(top, "Enter details symbol");
561 562
			break;
		case 'S':
563
			if (!top->sym_filter_entry)
564 565
				break;
			else {
566
				struct hist_entry *syme = top->sym_filter_entry;
567

568
				top->sym_filter_entry = NULL;
569 570 571
				__zero_source_counters(syme);
			}
			break;
572
		case 'U':
573
			top->hide_user_symbols = !top->hide_user_symbols;
574
			break;
575
		case 'z':
576
			top->zero = !top->zero;
577
			break;
578 579
		default:
			break;
580
	}
581 582

	return ret;
583 584
}

585 586 587
static void perf_top__sort_new_samples(void *arg)
{
	struct perf_top *t = arg;
588

589 590 591
	if (t->evlist->selected != NULL)
		t->sym_evsel = t->evlist->selected;

592
	perf_top__resort_hists(t);
593

594
	if (t->lost || t->drop)
595
		pr_warning("Too slow to read ring buffer (change period (-c/-F) or limit CPUs (-C)\n");
596 597
}

598 599 600 601 602 603
static void stop_top(void)
{
	session_done = 1;
	done = 1;
}

604
static void *display_thread_tui(void *arg)
605
{
606
	struct evsel *pos;
607
	struct perf_top *top = arg;
608
	const char *help = "For a higher level overview, try: perf top --sort comm,dso";
609 610 611 612 613
	struct hist_browser_timer hbt = {
		.timer		= perf_top__sort_new_samples,
		.arg		= top,
		.refresh	= top->delay_secs,
	};
614

615 616 617 618 619 620 621
	/* In order to read symbols from other namespaces perf to  needs to call
	 * setns(2).  This isn't permitted if the struct_fs has multiple users.
	 * unshare(2) the fs so that we may continue to setns into namespaces
	 * that we're observing.
	 */
	unshare(CLONE_FS);

622 623
	prctl(PR_SET_NAME, "perf-top-UI", 0, 0, 0);

624
	perf_top__sort_new_samples(top);
625 626 627

	/*
	 * Initialize the uid_filter_str, in the future the TUI will allow
628
	 * Zooming in/out UIDs. For now just use whatever the user passed
629 630
	 * via --uid.
	 */
631
	evlist__for_each_entry(top->evlist, pos) {
632 633 634
		struct hists *hists = evsel__hists(pos);
		hists->uid_filter_str = top->record_opts.target.uid_str;
	}
635

636 637
	perf_evlist__tui_browse_hists(top->evlist, help, &hbt,
				      top->min_percent,
638
				      &top->session->header.env,
639 640
				      !top->record_opts.overwrite,
				      &top->annotation_opts);
641

642
	stop_top();
643 644 645
	return NULL;
}

646 647
static void display_sig(int sig __maybe_unused)
{
648
	stop_top();
649 650 651 652
}

static void display_setup_sig(void)
{
653 654
	signal(SIGSEGV, sighandler_dump_stack);
	signal(SIGFPE, sighandler_dump_stack);
655 656 657 658 659
	signal(SIGINT,  display_sig);
	signal(SIGQUIT, display_sig);
	signal(SIGTERM, display_sig);
}

660
static void *display_thread(void *arg)
661
{
662
	struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
663
	struct termios save;
664
	struct perf_top *top = arg;
665 666
	int delay_msecs, c;

667 668 669 670 671 672 673
	/* In order to read symbols from other namespaces perf to  needs to call
	 * setns(2).  This isn't permitted if the struct_fs has multiple users.
	 * unshare(2) the fs so that we may continue to setns into namespaces
	 * that we're observing.
	 */
	unshare(CLONE_FS);

674 675
	prctl(PR_SET_NAME, "perf-top-UI", 0, 0, 0);

676
	display_setup_sig();
677
	pthread__unblock_sigwinch();
678
repeat:
679
	delay_msecs = top->delay_secs * MSEC_PER_SEC;
680
	set_term_quiet_input(&save);
681 682
	/* trash return*/
	getc(stdin);
683

684
	while (!done) {
685
		perf_top__print_sym_table(top);
686 687 688 689 690 691 692 693 694 695
		/*
		 * Either timeout expired or we got an EINTR due to SIGWINCH,
		 * refresh screen in both cases.
		 */
		switch (poll(&stdin_poll, 1, delay_msecs)) {
		case 0:
			continue;
		case -1:
			if (errno == EINTR)
				continue;
696
			__fallthrough;
697
		default:
698 699 700 701 702
			c = getc(stdin);
			tcsetattr(0, TCSAFLUSH, &save);

			if (perf_top__handle_keypress(top, c))
				goto repeat;
703
			stop_top();
704 705
		}
	}
706

707
	tcsetattr(0, TCSAFLUSH, &save);
708 709 710
	return NULL;
}

711 712 713 714 715 716
static int hist_iter__top_callback(struct hist_entry_iter *iter,
				   struct addr_location *al, bool single,
				   void *arg)
{
	struct perf_top *top = arg;
	struct hist_entry *he = iter->he;
717
	struct evsel *evsel = iter->evsel;
718

719
	if (perf_hpp_list.sym && single)
720
		perf_top__record_precise_ip(top, he, iter->sample, evsel, al->addr);
721

722 723
	hist__account_cycles(iter->sample->branch_stack, al, iter->sample,
		     !(top->record_opts.branch_stack & PERF_SAMPLE_BRANCH_ANY));
724 725 726
	return 0;
}

727 728
static void perf_event__process_sample(struct perf_tool *tool,
				       const union perf_event *event,
729
				       struct evsel *evsel,
730
				       struct perf_sample *sample,
731
				       struct machine *machine)
732
{
733
	struct perf_top *top = container_of(tool, struct perf_top, tool);
734
	struct addr_location al;
735
	int err;
736

737
	if (!machine && perf_guest) {
738 739 740
		static struct intlist *seen;

		if (!seen)
741
			seen = intlist__new(NULL);
742

743
		if (!intlist__has_entry(seen, sample->pid)) {
744
			pr_err("Can't find guest [%d]'s kernel information\n",
745 746
				sample->pid);
			intlist__add(seen, sample->pid);
747
		}
748 749 750
		return;
	}

751
	if (!machine) {
752
		pr_err("%u unprocessable samples recorded.\r",
753
		       top->session->evlist->stats.nr_unprocessable_samples++);
754 755 756
		return;
	}

757
	if (event->header.misc & PERF_RECORD_MISC_EXACT_IP)
758
		top->exact_samples++;
759

760
	if (machine__resolve(machine, &al, sample) < 0)
761
		return;
762

763
	if (!machine->kptr_restrict_warned &&
764 765
	    symbol_conf.kptr_restrict &&
	    al.cpumode == PERF_RECORD_MISC_KERNEL) {
766 767
		if (!perf_evlist__exclude_kernel(top->session->evlist)) {
			ui__warning(
768
"Kernel address maps (/proc/{kallsyms,modules}) are restricted.\n\n"
769
"Check /proc/sys/kernel/kptr_restrict and /proc/sys/kernel/perf_event_paranoid.\n\n"
770
"Kernel%s samples will not be resolved.\n",
771
			  al.map && map__has_symbols(al.map) ?
772
			  " modules" : "");
773 774 775
			if (use_browser <= 0)
				sleep(5);
		}
776
		machine->kptr_restrict_warned = true;
777 778
	}

779
	if (al.sym == NULL && al.map != NULL) {
780
		const char *msg = "Kernel samples will not be resolved.\n";
781 782 783 784 785 786 787 788 789 790 791
		/*
		 * As we do lazy loading of symtabs we only will know if the
		 * specified vmlinux file is invalid when we actually have a
		 * hit in kernel space and then try to load it. So if we get
		 * here and there are _no_ symbols in the DSO backing the
		 * kernel map, bail out.
		 *
		 * We may never get here, for instance, if we use -K/
		 * --hide-kernel-symbols, even if the user specifies an
		 * invalid --vmlinux ;-)
		 */
792
		if (!machine->kptr_restrict_warned && !top->vmlinux_warned &&
793
		    __map__is_kernel(al.map) && map__has_symbols(al.map)) {
794
			if (symbol_conf.vmlinux_name) {
795 796 797 798
				char serr[256];
				dso__strerror_load(al.map->dso, serr, sizeof(serr));
				ui__warning("The %s file can't be used: %s\n%s",
					    symbol_conf.vmlinux_name, serr, msg);
799 800 801 802 803 804 805
			} else {
				ui__warning("A vmlinux file was not found.\n%s",
					    msg);
			}

			if (use_browser <= 0)
				sleep(5);
806
			top->vmlinux_warned = true;
807
		}
808 809
	}

810
	if (al.sym == NULL || !al.sym->idle) {
811
		struct hists *hists = evsel__hists(evsel);
812
		struct hist_entry_iter iter = {
813 814 815
			.evsel		= evsel,
			.sample 	= sample,
			.add_entry_cb 	= hist_iter__top_callback,
816
		};
817

818 819 820 821
		if (symbol_conf.cumulate_callchain)
			iter.ops = &hist_iter_cumulative;
		else
			iter.ops = &hist_iter_normal;
822

823
		pthread_mutex_lock(&hists->lock);
824

825
		err = hist_entry_iter__add(&iter, &al, top->max_stack, top);
826 827
		if (err < 0)
			pr_err("Problem incrementing symbol period, skipping event\n");
828

829
		pthread_mutex_unlock(&hists->lock);
830
	}
831

832
	addr_location__put(&al);
833 834
}

835 836
static void
perf_top__process_lost(struct perf_top *top, union perf_event *event,
837
		       struct evsel *evsel)
838 839 840 841 842 843 844 845 846 847 848
{
	struct hists *hists = evsel__hists(evsel);

	top->lost += event->lost.lost;
	top->lost_total += event->lost.lost;
	hists->stats.total_lost += event->lost.lost;
}

static void
perf_top__process_lost_samples(struct perf_top *top,
			       union perf_event *event,
849
			       struct evsel *evsel)
850 851 852 853 854 855 856 857
{
	struct hists *hists = evsel__hists(evsel);

	top->lost += event->lost_samples.lost;
	top->lost_total += event->lost_samples.lost;
	hists->stats.total_lost_samples += event->lost_samples.lost;
}

858 859
static u64 last_timestamp;

860
static void perf_top__mmap_read_idx(struct perf_top *top, int idx)
861
{
862
	struct record_opts *opts = &top->record_opts;
863
	struct evlist *evlist = top->evlist;
864
	struct perf_mmap *md;
865
	union perf_event *event;
866

867
	md = opts->overwrite ? &evlist->overwrite_mmap[idx] : &evlist->mmap[idx];
868
	if (perf_mmap__read_init(md) < 0)
869 870
		return;

871
	while ((event = perf_mmap__read_event(md)) != NULL) {
J
Jiri Olsa 已提交
872
		int ret;
873

874
		ret = perf_evlist__parse_sample_timestamp(evlist, event, &last_timestamp);
J
Jiri Olsa 已提交
875
		if (ret && ret != -1)
876 877
			break;

878
		ret = ordered_events__queue(top->qe.in, event, last_timestamp, 0);
J
Jiri Olsa 已提交
879 880
		if (ret)
			break;
881 882 883 884 885 886 887 888 889

		perf_mmap__consume(md);

		if (top->qe.rotate) {
			pthread_mutex_lock(&top->qe.mutex);
			top->qe.rotate = false;
			pthread_cond_signal(&top->qe.cond);
			pthread_mutex_unlock(&top->qe.mutex);
		}
890
	}
891 892

	perf_mmap__read_done(md);
893 894
}

895
static void perf_top__mmap_read(struct perf_top *top)
896
{
897
	bool overwrite = top->record_opts.overwrite;
898
	struct evlist *evlist = top->evlist;
899 900
	int i;

901 902 903
	if (overwrite)
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_DATA_PENDING);

904 905
	for (i = 0; i < top->evlist->nr_mmaps; i++)
		perf_top__mmap_read_idx(top, i);
906 907 908 909 910

	if (overwrite) {
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_RUNNING);
	}
911 912
}

913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932
/*
 * Check per-event overwrite term.
 * perf top should support consistent term for all events.
 * - All events don't have per-event term
 *   E.g. "cpu/cpu-cycles/,cpu/instructions/"
 *   Nothing change, return 0.
 * - All events have same per-event term
 *   E.g. "cpu/cpu-cycles,no-overwrite/,cpu/instructions,no-overwrite/
 *   Using the per-event setting to replace the opts->overwrite if
 *   they are different, then return 0.
 * - Events have different per-event term
 *   E.g. "cpu/cpu-cycles,overwrite/,cpu/instructions,no-overwrite/"
 *   Return -1
 * - Some of the event set per-event term, but some not.
 *   E.g. "cpu/cpu-cycles/,cpu/instructions,no-overwrite/"
 *   Return -1
 */
static int perf_top__overwrite_check(struct perf_top *top)
{
	struct record_opts *opts = &top->record_opts;
933
	struct evlist *evlist = top->evlist;
934 935
	struct perf_evsel_config_term *term;
	struct list_head *config_terms;
936
	struct evsel *evsel;
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974
	int set, overwrite = -1;

	evlist__for_each_entry(evlist, evsel) {
		set = -1;
		config_terms = &evsel->config_terms;
		list_for_each_entry(term, config_terms, list) {
			if (term->type == PERF_EVSEL__CONFIG_TERM_OVERWRITE)
				set = term->val.overwrite ? 1 : 0;
		}

		/* no term for current and previous event (likely) */
		if ((overwrite < 0) && (set < 0))
			continue;

		/* has term for both current and previous event, compare */
		if ((overwrite >= 0) && (set >= 0) && (overwrite != set))
			return -1;

		/* no term for current event but has term for previous one */
		if ((overwrite >= 0) && (set < 0))
			return -1;

		/* has term for current event */
		if ((overwrite < 0) && (set >= 0)) {
			/* if it's first event, set overwrite */
			if (evsel == perf_evlist__first(evlist))
				overwrite = set;
			else
				return -1;
		}
	}

	if ((overwrite >= 0) && (opts->overwrite != overwrite))
		opts->overwrite = overwrite;

	return 0;
}

K
Kan Liang 已提交
975
static int perf_top_overwrite_fallback(struct perf_top *top,
976
				       struct evsel *evsel)
K
Kan Liang 已提交
977 978
{
	struct record_opts *opts = &top->record_opts;
979
	struct evlist *evlist = top->evlist;
980
	struct evsel *counter;
K
Kan Liang 已提交
981 982 983 984 985 986 987 988 989

	if (!opts->overwrite)
		return 0;

	/* only fall back when first event fails */
	if (evsel != perf_evlist__first(evlist))
		return 0;

	evlist__for_each_entry(evlist, counter)
990
		counter->core.attr.write_backward = false;
K
Kan Liang 已提交
991
	opts->overwrite = false;
992
	pr_debug2("fall back to non-overwrite mode\n");
K
Kan Liang 已提交
993 994 995
	return 1;
}

996
static int perf_top__start_counters(struct perf_top *top)
997
{
998
	char msg[BUFSIZ];
999
	struct evsel *counter;
1000
	struct evlist *evlist = top->evlist;
1001
	struct record_opts *opts = &top->record_opts;
1002

1003 1004 1005 1006 1007 1008
	if (perf_top__overwrite_check(top)) {
		ui__error("perf top only support consistent per-event "
			  "overwrite setting for all events\n");
		goto out_err;
	}

1009
	perf_evlist__config(evlist, opts, &callchain_param);
1010

1011
	evlist__for_each_entry(evlist, counter) {
1012
try_again:
1013
		if (evsel__open(counter, top->evlist->core.cpus,
1014
				     top->evlist->core.threads) < 0) {
K
Kan Liang 已提交
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029

			/*
			 * Specially handle overwrite fall back.
			 * Because perf top is the only tool which has
			 * overwrite mode by default, support
			 * both overwrite and non-overwrite mode, and
			 * require consistent mode for all events.
			 *
			 * May move it to generic code with more tools
			 * have similar attribute.
			 */
			if (perf_missing_features.write_backward &&
			    perf_top_overwrite_fallback(top, counter))
				goto try_again;

1030
			if (perf_evsel__fallback(counter, errno, msg, sizeof(msg))) {
1031
				if (verbose > 0)
1032
					ui__warning("%s\n", msg);
1033 1034
				goto try_again;
			}
1035

1036 1037 1038
			perf_evsel__open_strerror(counter, &opts->target,
						  errno, msg, sizeof(msg));
			ui__error("%s\n", msg);
1039
			goto out_err;
1040
		}
1041
	}
1042

1043
	if (perf_evlist__mmap(evlist, opts->mmap_pages) < 0) {
1044
		ui__error("Failed to mmap with %d (%s)\n",
1045
			    errno, str_error_r(errno, msg, sizeof(msg)));
1046 1047 1048
		goto out_err;
	}

1049
	return 0;
1050 1051

out_err:
1052
	return -1;
1053 1054
}

1055
static int callchain_param__setup_sample_type(struct callchain_param *callchain)
1056
{
1057
	if (callchain->mode != CHAIN_NONE) {
1058
		if (callchain_register_param(callchain) < 0) {
1059
			ui__error("Can't register callchain params.\n");
1060 1061 1062 1063 1064 1065 1066
			return -EINVAL;
		}
	}

	return 0;
}

J
Jiri Olsa 已提交
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
static struct ordered_events *rotate_queues(struct perf_top *top)
{
	struct ordered_events *in = top->qe.in;

	if (top->qe.in == &top->qe.data[1])
		top->qe.in = &top->qe.data[0];
	else
		top->qe.in = &top->qe.data[1];

	return in;
}

static void *process_thread(void *arg)
{
	struct perf_top *top = arg;

	while (!done) {
		struct ordered_events *out, *in = top->qe.in;

		if (!in->nr_events) {
			usleep(100);
			continue;
		}

		out = rotate_queues(top);
1092 1093 1094 1095 1096

		pthread_mutex_lock(&top->qe.mutex);
		top->qe.rotate = true;
		pthread_cond_wait(&top->qe.cond, &top->qe.mutex);
		pthread_mutex_unlock(&top->qe.mutex);
J
Jiri Olsa 已提交
1097 1098 1099 1100 1101 1102 1103 1104

		if (ordered_events__flush(out, OE_FLUSH__TOP))
			pr_err("failed to process events\n");
	}

	return NULL;
}

1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119
/*
 * Allow only 'top->delay_secs' seconds behind samples.
 */
static int should_drop(struct ordered_event *qevent, struct perf_top *top)
{
	union perf_event *event = qevent->event;
	u64 delay_timestamp;

	if (event->header.type != PERF_RECORD_SAMPLE)
		return false;

	delay_timestamp = qevent->timestamp + top->delay_secs * NSEC_PER_SEC;
	return delay_timestamp < last_timestamp;
}

J
Jiri Olsa 已提交
1120 1121 1122 1123
static int deliver_event(struct ordered_events *qe,
			 struct ordered_event *qevent)
{
	struct perf_top *top = qe->data;
1124
	struct evlist *evlist = top->evlist;
J
Jiri Olsa 已提交
1125 1126 1127
	struct perf_session *session = top->session;
	union perf_event *event = qevent->event;
	struct perf_sample sample;
1128
	struct evsel *evsel;
J
Jiri Olsa 已提交
1129 1130 1131
	struct machine *machine;
	int ret = -1;

1132 1133 1134
	if (should_drop(qevent, top)) {
		top->drop++;
		top->drop_total++;
1135
		return 0;
1136
	}
1137

J
Jiri Olsa 已提交
1138 1139 1140 1141 1142 1143 1144 1145 1146
	ret = perf_evlist__parse_sample(evlist, event, &sample);
	if (ret) {
		pr_err("Can't parse sample, err = %d\n", ret);
		goto next_event;
	}

	evsel = perf_evlist__id2evsel(session->evlist, sample.id);
	assert(evsel != NULL);

1147 1148 1149
	if (event->header.type == PERF_RECORD_SAMPLE) {
		if (evswitch__discard(&top->evswitch, evsel))
			return 0;
J
Jiri Olsa 已提交
1150
		++top->samples;
1151
	}
J
Jiri Olsa 已提交
1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209

	switch (sample.cpumode) {
	case PERF_RECORD_MISC_USER:
		++top->us_samples;
		if (top->hide_user_symbols)
			goto next_event;
		machine = &session->machines.host;
		break;
	case PERF_RECORD_MISC_KERNEL:
		++top->kernel_samples;
		if (top->hide_kernel_symbols)
			goto next_event;
		machine = &session->machines.host;
		break;
	case PERF_RECORD_MISC_GUEST_KERNEL:
		++top->guest_kernel_samples;
		machine = perf_session__find_machine(session,
						     sample.pid);
		break;
	case PERF_RECORD_MISC_GUEST_USER:
		++top->guest_us_samples;
		/*
		 * TODO: we don't process guest user from host side
		 * except simple counting.
		 */
		goto next_event;
	default:
		if (event->header.type == PERF_RECORD_SAMPLE)
			goto next_event;
		machine = &session->machines.host;
		break;
	}

	if (event->header.type == PERF_RECORD_SAMPLE) {
		perf_event__process_sample(&top->tool, event, evsel,
					   &sample, machine);
	} else if (event->header.type == PERF_RECORD_LOST) {
		perf_top__process_lost(top, event, evsel);
	} else if (event->header.type == PERF_RECORD_LOST_SAMPLES) {
		perf_top__process_lost_samples(top, event, evsel);
	} else if (event->header.type < PERF_RECORD_MAX) {
		hists__inc_nr_events(evsel__hists(evsel), event->header.type);
		machine__process_event(machine, event, &sample);
	} else
		++session->evlist->stats.nr_unknown_events;

	ret = 0;
next_event:
	return ret;
}

static void init_process_thread(struct perf_top *top)
{
	ordered_events__init(&top->qe.data[0], deliver_event, top);
	ordered_events__init(&top->qe.data[1], deliver_event, top);
	ordered_events__set_copy_on_queue(&top->qe.data[0], true);
	ordered_events__set_copy_on_queue(&top->qe.data[1], true);
	top->qe.in = &top->qe.data[0];
1210 1211
	pthread_mutex_init(&top->qe.mutex, NULL);
	pthread_cond_init(&top->qe.cond, NULL);
J
Jiri Olsa 已提交
1212 1213
}

1214
static int __cmd_top(struct perf_top *top)
1215
{
1216
	struct record_opts *opts = &top->record_opts;
J
Jiri Olsa 已提交
1217
	pthread_t thread, thread_process;
1218
	int ret;
1219

1220 1221 1222
	if (!top->annotation_opts.objdump_path) {
		ret = perf_env__lookup_objdump(&top->session->header.env,
					       &top->annotation_opts.objdump_path);
1223
		if (ret)
1224
			return ret;
1225 1226
	}

1227
	ret = callchain_param__setup_sample_type(&callchain_param);
1228
	if (ret)
1229
		return ret;
1230

1231
	if (perf_session__register_idle_thread(top->session) < 0)
1232
		return ret;
N
Namhyung Kim 已提交
1233

1234 1235
	if (top->nr_threads_synthesize > 1)
		perf_set_multithreaded();
1236

J
Jiri Olsa 已提交
1237 1238
	init_process_thread(top);

N
Namhyung Kim 已提交
1239 1240 1241
	if (opts->record_namespaces)
		top->tool.namespace_events = true;

1242
	ret = perf_event__synthesize_bpf_events(top->session, perf_event__process,
1243 1244 1245
						&top->session->machines.host,
						&top->record_opts);
	if (ret < 0)
1246
		pr_debug("Couldn't synthesize BPF events: Pre-existing BPF programs won't have symbols resolved.\n");
1247

1248
	machine__synthesize_threads(&top->session->machines.host, &opts->target,
1249
				    top->evlist->core.threads, false,
1250
				    top->nr_threads_synthesize);
1251

1252 1253
	if (top->nr_threads_synthesize > 1)
		perf_set_singlethreaded();
1254

1255
	if (perf_hpp_list.socket) {
1256
		ret = perf_env__read_cpu_topology_map(&perf_env);
1257 1258 1259 1260 1261 1262 1263
		if (ret < 0) {
			char errbuf[BUFSIZ];
			const char *err = str_error_r(-ret, errbuf, sizeof(errbuf));

			ui__error("Could not read the CPU topology map: %s\n", err);
			return ret;
		}
1264 1265
	}

1266 1267
	ret = perf_top__start_counters(top);
	if (ret)
1268
		return ret;
1269

1270
	top->session->evlist = top->evlist;
1271
	perf_session__set_id_hdr_size(top->session);
1272

1273 1274 1275 1276 1277 1278 1279 1280
	/*
	 * When perf is starting the traced process, all the events (apart from
	 * group members) have enable_on_exec=1 set, so don't spoil it by
	 * prematurely enabling them.
	 *
	 * XXX 'top' still doesn't start workloads like record, trace, but should,
	 * so leave the check here.
	 */
1281
        if (!target__none(&opts->target))
1282
		evlist__enable(top->evlist);
1283

1284
	ret = -1;
J
Jiri Olsa 已提交
1285 1286
	if (pthread_create(&thread_process, NULL, process_thread, top)) {
		ui__error("Could not create process thread.\n");
1287
		return ret;
J
Jiri Olsa 已提交
1288 1289
	}

1290
	if (pthread_create(&thread, NULL, (use_browser > 0 ? display_thread_tui :
1291
							    display_thread), top)) {
1292
		ui__error("Could not create display thread.\n");
J
Jiri Olsa 已提交
1293
		goto out_join_thread;
1294 1295
	}

1296
	if (top->realtime_prio) {
1297 1298
		struct sched_param param;

1299
		param.sched_priority = top->realtime_prio;
1300
		if (sched_setscheduler(0, SCHED_FIFO, &param)) {
1301
			ui__error("Could not set realtime priority.\n");
1302
			goto out_join;
1303 1304 1305
		}
	}

1306 1307 1308 1309 1310
	/* Wait for a minimal set of events before starting the snapshot */
	perf_evlist__poll(top->evlist, 100);

	perf_top__mmap_read(top);

1311
	while (!done) {
1312
		u64 hits = top->samples;
1313

1314
		perf_top__mmap_read(top);
1315

1316
		if (opts->overwrite || (hits == top->samples))
1317
			ret = perf_evlist__poll(top->evlist, 100);
1318 1319 1320 1321 1322

		if (resize) {
			perf_top__resize(top);
			resize = 0;
		}
1323 1324
	}

1325
	ret = 0;
1326 1327
out_join:
	pthread_join(thread, NULL);
J
Jiri Olsa 已提交
1328
out_join_thread:
1329
	pthread_cond_signal(&top->qe.cond);
J
Jiri Olsa 已提交
1330
	pthread_join(thread_process, NULL);
1331
	return ret;
1332 1333 1334
}

static int
J
Jiri Olsa 已提交
1335
callchain_opt(const struct option *opt, const char *arg, int unset)
1336 1337
{
	symbol_conf.use_callchain = true;
J
Jiri Olsa 已提交
1338 1339
	return record_callchain_opt(opt, arg, unset);
}
1340

J
Jiri Olsa 已提交
1341 1342 1343
static int
parse_callchain_opt(const struct option *opt, const char *arg, int unset)
{
1344
	struct callchain_param *callchain = opt->value;
1345

1346 1347
	callchain->enabled = !unset;
	callchain->record_mode = CALLCHAIN_FP;
1348 1349 1350 1351 1352 1353

	/*
	 * --no-call-graph
	 */
	if (unset) {
		symbol_conf.use_callchain = false;
1354
		callchain->record_mode = CALLCHAIN_NONE;
1355 1356 1357 1358
		return 0;
	}

	return parse_callchain_top_opt(arg);
1359
}
1360

1361
static int perf_top_config(const char *var, const char *value, void *cb __maybe_unused)
1362
{
1363 1364 1365 1366
	if (!strcmp(var, "top.call-graph")) {
		var = "call-graph.record-mode";
		return perf_default_config(var, value, cb);
	}
1367 1368 1369 1370
	if (!strcmp(var, "top.children")) {
		symbol_conf.cumulate_callchain = perf_config_bool(var, value);
		return 0;
	}
1371

1372
	return 0;
1373 1374
}

1375 1376 1377 1378 1379 1380 1381 1382 1383 1384
static int
parse_percent_limit(const struct option *opt, const char *arg,
		    int unset __maybe_unused)
{
	struct perf_top *top = opt->value;

	top->min_percent = strtof(arg, NULL);
	return 0;
}

1385 1386
const char top_callchain_help[] = CALLCHAIN_RECORD_HELP CALLCHAIN_REPORT_HELP
	"\n\t\t\t\tDefault: fp,graph,0.5,caller,function";
1387

1388
int cmd_top(int argc, const char **argv)
1389
{
1390
	char errbuf[BUFSIZ];
1391 1392 1393
	struct perf_top top = {
		.count_filter	     = 5,
		.delay_secs	     = 2,
1394 1395 1396 1397 1398
		.record_opts = {
			.mmap_pages	= UINT_MAX,
			.user_freq	= UINT_MAX,
			.user_interval	= ULLONG_MAX,
			.freq		= 4000, /* 4 KHz */
1399
			.target		= {
1400 1401
				.uses_mmap   = true,
			},
1402 1403 1404 1405 1406 1407 1408 1409
			/*
			 * FIXME: This will lose PERF_RECORD_MMAP and other metadata
			 * when we pause, fix that and reenable. Probably using a
			 * separate evlist with a dummy event, i.e. a non-overwrite
			 * ring buffer just for metadata events, while PERF_RECORD_SAMPLE
			 * stays in overwrite mode. -acme
			 * */
			.overwrite	= 0,
J
Jiri Olsa 已提交
1410
			.sample_time	= true,
1411
			.sample_time_set = true,
N
Namhyung Kim 已提交
1412
		},
1413
		.max_stack	     = sysctl__max_stack(),
1414
		.annotation_opts     = annotation__default_options,
1415
		.nr_threads_synthesize = UINT_MAX,
1416
	};
1417
	struct record_opts *opts = &top.record_opts;
1418
	struct target *target = &opts->target;
1419
	const struct option options[] = {
1420
	OPT_CALLBACK('e', "event", &top.evlist, "event",
1421
		     "event selector. use 'perf list' to list available events",
1422
		     parse_events_option),
1423 1424
	OPT_U64('c', "count", &opts->user_interval, "event period to sample"),
	OPT_STRING('p', "pid", &target->pid, "pid",
1425
		    "profile events on existing process id"),
1426
	OPT_STRING('t', "tid", &target->tid, "tid",
1427
		    "profile events on existing thread id"),
1428
	OPT_BOOLEAN('a', "all-cpus", &target->system_wide,
1429
			    "system-wide collection from all CPUs"),
1430
	OPT_STRING('C', "cpu", &target->cpu_list, "cpu",
1431
		    "list of cpus to monitor"),
1432 1433
	OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
		   "file", "vmlinux pathname"),
1434 1435
	OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux,
		    "don't load vmlinux even if found"),
1436 1437
	OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
		   "file", "kallsyms pathname"),
1438
	OPT_BOOLEAN('K', "hide_kernel_symbols", &top.hide_kernel_symbols,
1439
		    "hide kernel symbols"),
1440 1441 1442
	OPT_CALLBACK('m', "mmap-pages", &opts->mmap_pages, "pages",
		     "number of mmap data pages",
		     perf_evlist__parse_mmap_pages),
1443
	OPT_INTEGER('r', "realtime", &top.realtime_prio,
1444
		    "collect data with this RT SCHED_FIFO priority"),
1445
	OPT_INTEGER('d', "delay", &top.delay_secs,
1446
		    "number of seconds to delay between refreshes"),
1447
	OPT_BOOLEAN('D', "dump-symtab", &top.dump_symtab,
1448
			    "dump the symbol table used for profiling"),
1449
	OPT_INTEGER('f', "count-filter", &top.count_filter,
1450
		    "only display functions with more events than this"),
1451
	OPT_BOOLEAN(0, "group", &opts->group,
1452
			    "put the counters into a counter group"),
1453 1454
	OPT_BOOLEAN('i', "no-inherit", &opts->no_inherit,
		    "child tasks do not inherit counters"),
1455
	OPT_STRING(0, "sym-annotate", &top.sym_filter, "symbol name",
1456
		    "symbol to annotate"),
1457
	OPT_BOOLEAN('z', "zero", &top.zero, "zero history across updates"),
1458 1459 1460
	OPT_CALLBACK('F', "freq", &top.record_opts, "freq or 'max'",
		     "profile at this frequency",
		      record__parse_freq),
1461
	OPT_INTEGER('E', "entries", &top.print_entries,
1462
		    "display this many functions"),
1463
	OPT_BOOLEAN('U', "hide_user_symbols", &top.hide_user_symbols,
1464
		    "hide user symbols"),
1465 1466
	OPT_BOOLEAN(0, "tui", &top.use_tui, "Use the TUI interface"),
	OPT_BOOLEAN(0, "stdio", &top.use_stdio, "Use the stdio interface"),
1467
	OPT_INCR('v', "verbose", &verbose,
1468
		    "be more verbose (show counter open errors, etc)"),
1469
	OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
1470 1471
		   "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
		   " Please refer the man page for the complete list."),
1472 1473
	OPT_STRING(0, "fields", &field_order, "key[,keys...]",
		   "output field(s): overhead, period, sample plus all of sort keys"),
1474 1475
	OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
		    "Show a column with the number of samples"),
1476
	OPT_CALLBACK_NOOPT('g', NULL, &callchain_param,
1477
			   NULL, "enables call-graph recording and display",
J
Jiri Olsa 已提交
1478
			   &callchain_opt),
1479
	OPT_CALLBACK(0, "call-graph", &callchain_param,
1480
		     "record_mode[,record_size],print_type,threshold[,print_limit],order,sort_key[,branch]",
1481
		     top_callchain_help, &parse_callchain_opt),
N
Namhyung Kim 已提交
1482 1483
	OPT_BOOLEAN(0, "children", &symbol_conf.cumulate_callchain,
		    "Accumulate callchains of children and show total overhead as well"),
1484 1485
	OPT_INTEGER(0, "max-stack", &top.max_stack,
		    "Set the maximum stack depth when parsing the callchain. "
1486
		    "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
1487 1488 1489
	OPT_CALLBACK(0, "ignore-callees", NULL, "regex",
		   "ignore callees of these functions in call graphs",
		   report_parse_ignore_callees_opt),
1490 1491 1492 1493 1494 1495 1496 1497
	OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
		    "Show a column with the sum of periods"),
	OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
		   "only consider symbols in these dsos"),
	OPT_STRING(0, "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
		   "only consider symbols in these comms"),
	OPT_STRING(0, "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
		   "only consider these symbols"),
1498
	OPT_BOOLEAN(0, "source", &top.annotation_opts.annotate_src,
1499
		    "Interleave source code with assembly code (default)"),
1500
	OPT_BOOLEAN(0, "asm-raw", &top.annotation_opts.show_asm_raw,
1501
		    "Display raw encoding of assembly instructions (default)"),
1502 1503
	OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
		    "Enable kernel symbol demangling"),
S
Song Liu 已提交
1504
	OPT_BOOLEAN(0, "no-bpf-event", &top.record_opts.no_bpf_event, "do not record bpf events"),
1505
	OPT_STRING(0, "objdump", &top.annotation_opts.objdump_path, "path",
1506
		    "objdump binary to use for disassembly and annotations"),
1507
	OPT_STRING('M', "disassembler-style", &top.annotation_opts.disassembler_style, "disassembler style",
1508
		   "Specify disassembler style (e.g. -M intel for intel syntax)"),
1509
	OPT_STRING('u', "uid", &target->uid_str, "user", "user to profile"),
1510 1511
	OPT_CALLBACK(0, "percent-limit", &top, "percent",
		     "Don't show entries under that percent", parse_percent_limit),
N
Namhyung Kim 已提交
1512 1513
	OPT_CALLBACK(0, "percentage", NULL, "relative|absolute",
		     "How to display percentage of filtered entries", parse_filter_percentage),
1514 1515 1516
	OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
		   "width[,width...]",
		   "don't try to adjust column width, use these fixed values"),
1517
	OPT_UINTEGER(0, "proc-map-timeout", &proc_map_timeout,
1518
			"per thread proc mmap processing timeout in ms"),
1519 1520 1521 1522 1523 1524
	OPT_CALLBACK_NOOPT('b', "branch-any", &opts->branch_stack,
		     "branch any", "sample any taken branches",
		     parse_branch_stack),
	OPT_CALLBACK('j', "branch-filter", &opts->branch_stack,
		     "branch filter mask", "branch stack filter modes",
		     parse_branch_stack),
1525 1526
	OPT_BOOLEAN(0, "raw-trace", &symbol_conf.raw_trace,
		    "Show raw trace event output (do not use print fmt or plugins)"),
N
Namhyung Kim 已提交
1527 1528
	OPT_BOOLEAN(0, "hierarchy", &symbol_conf.report_hierarchy,
		    "Show entries in a hierarchy"),
1529
	OPT_BOOLEAN(0, "overwrite", &top.record_opts.overwrite,
1530
		    "Use a backward ring buffer, default: no"),
1531
	OPT_BOOLEAN(0, "force", &symbol_conf.force, "don't complain, do it"),
1532 1533
	OPT_UINTEGER(0, "num-thread-synthesize", &top.nr_threads_synthesize,
			"number of thread to run event synthesize"),
N
Namhyung Kim 已提交
1534 1535
	OPT_BOOLEAN(0, "namespaces", &opts->record_namespaces,
		    "Record namespaces events"),
1536
	OPTS_EVSWITCH(&top.evswitch),
1537
	OPT_END()
1538
	};
1539
	struct evlist *sb_evlist = NULL;
1540 1541 1542 1543
	const char * const top_usage[] = {
		"perf top [<options>]",
		NULL
	};
1544 1545 1546 1547
	int status = hists__init();

	if (status < 0)
		return status;
1548

1549 1550 1551
	top.annotation_opts.min_pcnt = 5;
	top.annotation_opts.context  = 4;

1552
	top.evlist = evlist__new();
1553
	if (top.evlist == NULL)
1554 1555
		return -ENOMEM;

1556 1557 1558
	status = perf_config(perf_top_config, &top);
	if (status)
		return status;
1559

1560 1561 1562 1563
	argc = parse_options(argc, argv, options, top_usage, 0);
	if (argc)
		usage_with_options(top_usage, options);

1564
	if (!top.evlist->core.nr_entries &&
1565 1566 1567 1568 1569
	    perf_evlist__add_default(top.evlist) < 0) {
		pr_err("Not enough memory for event selector list\n");
		goto out_delete_evlist;
	}

1570 1571 1572 1573
	status = evswitch__init(&top.evswitch, top.evlist, stderr);
	if (status)
		goto out_delete_evlist;

N
Namhyung Kim 已提交
1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586
	if (symbol_conf.report_hierarchy) {
		/* disable incompatible options */
		symbol_conf.event_group = false;
		symbol_conf.cumulate_callchain = false;

		if (field_order) {
			pr_err("Error: --hierarchy and --fields options cannot be used together\n");
			parse_options_usage(top_usage, options, "fields", 0);
			parse_options_usage(NULL, options, "hierarchy", 0);
			goto out_delete_evlist;
		}
	}

1587 1588 1589
	if (opts->branch_stack && callchain_param.enabled)
		symbol_conf.show_branchflag_count = true;

1590
	sort__mode = SORT_MODE__TOP;
1591
	/* display thread wants entries to be collapsed in a different tree */
1592
	perf_hpp_list.need_collapse = 1;
1593

1594 1595 1596 1597 1598 1599 1600
	if (top.use_stdio)
		use_browser = 0;
	else if (top.use_tui)
		use_browser = 1;

	setup_browser(false);

1601
	if (setup_sorting(top.evlist) < 0) {
1602 1603 1604 1605 1606
		if (sort_order)
			parse_options_usage(top_usage, options, "s", 1);
		if (field_order)
			parse_options_usage(sort_order ? NULL : top_usage,
					    options, "fields", 0);
1607 1608
		goto out_delete_evlist;
	}
1609

1610
	status = target__validate(target);
1611
	if (status) {
1612
		target__strerror(target, status, errbuf, BUFSIZ);
1613
		ui__warning("%s\n", errbuf);
1614 1615
	}

1616
	status = target__parse_uid(target);
1617 1618
	if (status) {
		int saved_errno = errno;
1619

1620
		target__strerror(target, status, errbuf, BUFSIZ);
1621
		ui__error("%s\n", errbuf);
1622 1623

		status = -saved_errno;
1624
		goto out_delete_evlist;
1625
	}
1626

1627
	if (target__none(target))
1628
		target->system_wide = true;
1629

1630 1631
	if (perf_evlist__create_maps(top.evlist, target) < 0) {
		ui__error("Couldn't create thread/CPU maps: %s\n",
1632
			  errno == ENOENT ? "No such process" : str_error_r(errno, errbuf, sizeof(errbuf)));
1633
		goto out_delete_evlist;
1634
	}
1635

1636 1637
	if (top.delay_secs < 1)
		top.delay_secs = 1;
1638

1639
	if (record_opts__config(opts)) {
1640
		status = -EINVAL;
1641
		goto out_delete_evlist;
1642 1643
	}

1644
	top.sym_evsel = perf_evlist__first(top.evlist);
1645

1646
	if (!callchain_param.enabled) {
N
Namhyung Kim 已提交
1647 1648 1649 1650
		symbol_conf.cumulate_callchain = false;
		perf_hpp__cancel_cumulate();
	}

1651 1652 1653
	if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
		callchain_param.order = ORDER_CALLER;

1654 1655 1656
	status = symbol__annotation_init();
	if (status < 0)
		goto out_delete_evlist;
1657

1658 1659
	annotation_config__init();

1660
	symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
1661 1662 1663
	status = symbol__init(NULL);
	if (status < 0)
		goto out_delete_evlist;
1664

1665
	sort__setup_elide(stdout);
1666

1667
	get_term_dimensions(&top.winsize);
1668
	if (top.print_entries == 0) {
1669
		perf_top__update_print_entries(&top);
1670
		signal(SIGWINCH, winch_sig);
1671 1672
	}

1673 1674 1675 1676 1677 1678
	top.session = perf_session__new(NULL, false, NULL);
	if (top.session == NULL) {
		status = -1;
		goto out_delete_evlist;
	}

1679 1680 1681
	if (!top.record_opts.no_bpf_event)
		bpf_event__add_sb_event(&sb_evlist, &perf_env);

1682 1683 1684 1685 1686
	if (perf_evlist__start_sb_thread(sb_evlist, target)) {
		pr_debug("Couldn't start the BPF side band thread:\nBPF programs starting from now on won't be annotatable\n");
		opts->no_bpf_event = true;
	}

1687
	status = __cmd_top(&top);
1688

1689 1690 1691
	if (!opts->no_bpf_event)
		perf_evlist__stop_sb_thread(sb_evlist);

1692
out_delete_evlist:
1693
	evlist__delete(top.evlist);
1694
	perf_session__delete(top.session);
1695 1696

	return status;
1697
}