builtin-top.c 44.8 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/synthetic-events.h"
36
#include "util/top.h"
37
#include "util/util.h"
38
#include <linux/rbtree.h>
39
#include <subcmd/parse-options.h>
40
#include "util/parse-events.h"
41
#include "util/callchain.h"
42
#include "util/cpumap.h"
43
#include "util/sort.h"
44
#include "util/string2.h"
45
#include "util/term.h"
46
#include "util/intlist.h"
47
#include "util/parse-branch-options.h"
48
#include "arch/common.h"
49
#include "ui/ui.h"
50

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

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

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

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

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

77
#include <linux/stringify.h>
78
#include <linux/time64.h>
79
#include <linux/types.h>
80
#include <linux/err.h>
81

82
#include <linux/ctype.h>
83

84
static volatile int done;
85
static volatile int resize;
86

N
Namhyung Kim 已提交
87 88
#define HEADER_LINE_NR  5

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

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

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

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

113
	if (!he || !he->ms.sym)
114 115
		return -1;

116 117
	evsel = hists_to_evsel(he->hists);

118 119
	sym = he->ms.sym;
	map = he->ms.map;
120 121 122 123

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

132 133
	notes = symbol__annotation(sym);
	pthread_mutex_lock(&notes->lock);
134

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

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

152
	pthread_mutex_unlock(&notes->lock);
153
	return err;
154 155
}

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

162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
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);
185

186 187 188
	map->erange_warned = true;
}

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

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

203 204 205
	notes = symbol__annotation(sym);

	if (pthread_mutex_trylock(&notes->lock))
206 207
		return;

208
	err = hist_entry__inc_addr_samples(he, sample, evsel, ip);
209

210
	pthread_mutex_unlock(&notes->lock);
211

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
	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);
228
	}
229 230
}

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

239
	if (!he)
240 241
		return;

242 243
	evsel = hists_to_evsel(he->hists);

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

	pthread_mutex_lock(&notes->lock);

249 250
	symbol__calc_percent(symbol, evsel);

251 252
	if (notes->src == NULL)
		goto out_unlock;
253

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

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

	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);
	}
265
	if (more != 0)
266
		printf("%d lines not displayed, maybe increase display entries [e]\n", more);
267 268
out_unlock:
	pthread_mutex_unlock(&notes->lock);
269
}
270

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

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

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

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

294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
		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);
	}
}

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

319
	puts(CONSOLE_CLEAR);
320

321
	perf_top__header_snprintf(top, bf, sizeof(bf));
322
	printf("%s\n", bf);
323

324
	printf("%-*.*s\n", win_width, win_width, graph_dotted_line);
325

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

337 338
	if (top->sym_filter_entry) {
		perf_top__show_details(top);
339 340 341
		return;
	}

342
	perf_top__resort_hists(top);
N
Namhyung Kim 已提交
343

344
	hists__output_recalc_col_len(hists, top->print_entries - printed);
345
	putchar('\n');
346
	hists__fprintf(hists, false, top->print_entries - printed, win_width,
347
		       top->min_percent, stdout, !symbol_conf.use_callchain);
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 383 384
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;
}

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

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

	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 已提交
407
	next = rb_first_cached(&hists->entries);
408 409 410 411
	while (next) {
		n = rb_entry(next, struct hist_entry, rb_node);
		if (n->ms.sym && !strcmp(buf, n->ms.sym->name)) {
			found = n;
412 413
			break;
		}
414
		next = rb_next(&n->rb_node);
415 416 417
	}

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

out_free:
	free(buf);
}

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

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

	fprintf(stdout, "\nMapped keys:\n");
437 438
	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);
439

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

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

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

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

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

	return 0;
481 482
}

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

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

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

495
		set_term_quiet_input(&save);
496 497 498 499 500

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

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

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

525
				fprintf(stderr, "\nAvailable events:");
526

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

530
				prompt_integer(&counter, "Enter details event counter");
531

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

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

	return ret;
585 586
}

587 588 589
static void perf_top__sort_new_samples(void *arg)
{
	struct perf_top *t = arg;
590

591 592 593
	if (t->evlist->selected != NULL)
		t->sym_evsel = t->evlist->selected;

594
	perf_top__resort_hists(t);
595

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

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

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

617 618 619 620 621 622 623
	/* 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);

624 625
	prctl(PR_SET_NAME, "perf-top-UI", 0, 0, 0);

626
	perf_top__sort_new_samples(top);
627 628 629

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

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

644
	stop_top();
645 646 647
	return NULL;
}

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

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

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

669 670 671 672 673 674 675
	/* 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);

676 677
	prctl(PR_SET_NAME, "perf-top-UI", 0, 0, 0);

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

686
	while (!done) {
687
		perf_top__print_sym_table(top);
688 689 690 691 692 693 694 695 696 697
		/*
		 * 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;
698
			__fallthrough;
699
		default:
700 701 702 703 704
			c = getc(stdin);
			tcsetattr(0, TCSAFLUSH, &save);

			if (perf_top__handle_keypress(top, c))
				goto repeat;
705
			stop_top();
706 707
		}
	}
708

709
	tcsetattr(0, TCSAFLUSH, &save);
710 711 712
	return NULL;
}

713 714 715 716 717 718
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;
719
	struct evsel *evsel = iter->evsel;
720

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

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

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

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

		if (!seen)
743
			seen = intlist__new(NULL);
744

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

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

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

762
	if (machine__resolve(machine, &al, sample) < 0)
763
		return;
764

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

781
	if (al.sym == NULL && al.map != NULL) {
782
		const char *msg = "Kernel samples will not be resolved.\n";
783 784 785 786 787 788 789 790 791 792 793
		/*
		 * 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 ;-)
		 */
794
		if (!machine->kptr_restrict_warned && !top->vmlinux_warned &&
795
		    __map__is_kernel(al.map) && map__has_symbols(al.map)) {
796
			if (symbol_conf.vmlinux_name) {
797 798 799 800
				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);
801 802 803 804 805 806 807
			} else {
				ui__warning("A vmlinux file was not found.\n%s",
					    msg);
			}

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

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

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

825
		pthread_mutex_lock(&hists->lock);
826

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

831
		pthread_mutex_unlock(&hists->lock);
832
	}
833

834
	addr_location__put(&al);
835 836
}

837 838
static void
perf_top__process_lost(struct perf_top *top, union perf_event *event,
839
		       struct evsel *evsel)
840 841 842 843 844 845 846 847 848 849 850
{
	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,
851
			       struct evsel *evsel)
852 853 854 855 856 857 858 859
{
	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;
}

860 861
static u64 last_timestamp;

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

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

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

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

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

		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);
		}
892
	}
893 894

	perf_mmap__read_done(md);
895 896
}

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

903 904 905
	if (overwrite)
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_DATA_PENDING);

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

	if (overwrite) {
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_RUNNING);
	}
913 914
}

915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934
/*
 * 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;
935
	struct evlist *evlist = top->evlist;
936 937
	struct perf_evsel_config_term *term;
	struct list_head *config_terms;
938
	struct evsel *evsel;
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 975 976
	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 已提交
977
static int perf_top_overwrite_fallback(struct perf_top *top,
978
				       struct evsel *evsel)
K
Kan Liang 已提交
979 980
{
	struct record_opts *opts = &top->record_opts;
981
	struct evlist *evlist = top->evlist;
982
	struct evsel *counter;
K
Kan Liang 已提交
983 984 985 986 987 988 989 990 991

	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)
992
		counter->core.attr.write_backward = false;
K
Kan Liang 已提交
993
	opts->overwrite = false;
994
	pr_debug2("fall back to non-overwrite mode\n");
K
Kan Liang 已提交
995 996 997
	return 1;
}

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

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

1011
	perf_evlist__config(evlist, opts, &callchain_param);
1012

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

			/*
			 * 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;

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

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

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

1051
	return 0;
1052 1053

out_err:
1054
	return -1;
1055 1056
}

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

	return 0;
}

J
Jiri Olsa 已提交
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
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);
1094 1095 1096 1097 1098

		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 已提交
1099 1100 1101 1102 1103 1104 1105 1106

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

	return NULL;
}

1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
/*
 * 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 已提交
1122 1123 1124 1125
static int deliver_event(struct ordered_events *qe,
			 struct ordered_event *qevent)
{
	struct perf_top *top = qe->data;
1126
	struct evlist *evlist = top->evlist;
J
Jiri Olsa 已提交
1127 1128 1129
	struct perf_session *session = top->session;
	union perf_event *event = qevent->event;
	struct perf_sample sample;
1130
	struct evsel *evsel;
J
Jiri Olsa 已提交
1131 1132 1133
	struct machine *machine;
	int ret = -1;

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

J
Jiri Olsa 已提交
1140 1141 1142 1143 1144 1145 1146 1147 1148
	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);

1149 1150 1151
	if (event->header.type == PERF_RECORD_SAMPLE) {
		if (evswitch__discard(&top->evswitch, evsel))
			return 0;
J
Jiri Olsa 已提交
1152
		++top->samples;
1153
	}
J
Jiri Olsa 已提交
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 1210 1211

	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];
1212 1213
	pthread_mutex_init(&top->qe.mutex, NULL);
	pthread_cond_init(&top->qe.cond, NULL);
J
Jiri Olsa 已提交
1214 1215
}

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

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

1229
	ret = callchain_param__setup_sample_type(&callchain_param);
1230
	if (ret)
1231
		return ret;
1232

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

1236 1237
	if (top->nr_threads_synthesize > 1)
		perf_set_multithreaded();
1238

J
Jiri Olsa 已提交
1239 1240
	init_process_thread(top);

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

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

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

1254 1255
	if (top->nr_threads_synthesize > 1)
		perf_set_singlethreaded();
1256

1257
	if (perf_hpp_list.socket) {
1258
		ret = perf_env__read_cpu_topology_map(&perf_env);
1259 1260 1261 1262 1263 1264 1265
		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;
		}
1266 1267
	}

1268 1269
	ret = perf_top__start_counters(top);
	if (ret)
1270
		return ret;
1271

1272
	top->session->evlist = top->evlist;
1273
	perf_session__set_id_hdr_size(top->session);
1274

1275 1276 1277 1278 1279 1280 1281 1282
	/*
	 * 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.
	 */
1283
        if (!target__none(&opts->target))
1284
		evlist__enable(top->evlist);
1285

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

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

1298
	if (top->realtime_prio) {
1299 1300
		struct sched_param param;

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

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

	perf_top__mmap_read(top);

1313
	while (!done) {
1314
		u64 hits = top->samples;
1315

1316
		perf_top__mmap_read(top);
1317

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

		if (resize) {
			perf_top__resize(top);
			resize = 0;
		}
1325 1326
	}

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

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

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

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

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

	return parse_callchain_top_opt(arg);
1361
}
1362

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

1374
	return 0;
1375 1376
}

1377 1378 1379 1380 1381 1382 1383 1384 1385 1386
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;
}

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

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

	if (status < 0)
		return status;
1550

1551 1552 1553
	top.annotation_opts.min_pcnt = 5;
	top.annotation_opts.context  = 4;

1554
	top.evlist = evlist__new();
1555
	if (top.evlist == NULL)
1556 1557
		return -ENOMEM;

1558 1559 1560
	status = perf_config(perf_top_config, &top);
	if (status)
		return status;
1561

1562 1563 1564 1565
	argc = parse_options(argc, argv, options, top_usage, 0);
	if (argc)
		usage_with_options(top_usage, options);

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

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

N
Namhyung Kim 已提交
1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588
	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;
		}
	}

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

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

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

	setup_browser(false);

1603
	if (setup_sorting(top.evlist) < 0) {
1604 1605 1606 1607 1608
		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);
1609 1610
		goto out_delete_evlist;
	}
1611

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

1618
	status = target__parse_uid(target);
1619 1620
	if (status) {
		int saved_errno = errno;
1621

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

		status = -saved_errno;
1626
		goto out_delete_evlist;
1627
	}
1628

1629
	if (target__none(target))
1630
		target->system_wide = true;
1631

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

1638 1639
	if (top.delay_secs < 1)
		top.delay_secs = 1;
1640

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

1646
	top.sym_evsel = perf_evlist__first(top.evlist);
1647

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

1653 1654 1655
	if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
		callchain_param.order = ORDER_CALLER;

1656 1657 1658
	status = symbol__annotation_init();
	if (status < 0)
		goto out_delete_evlist;
1659

1660 1661
	annotation_config__init();

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

1667
	sort__setup_elide(stdout);
1668

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

1675
	top.session = perf_session__new(NULL, false, NULL);
1676 1677
	if (IS_ERR(top.session)) {
		status = PTR_ERR(top.session);
1678 1679 1680
		goto out_delete_evlist;
	}

1681 1682 1683
	if (!top.record_opts.no_bpf_event)
		bpf_event__add_sb_event(&sb_evlist, &perf_env);

1684 1685 1686 1687 1688
	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;
	}

1689
	status = __cmd_top(&top);
1690

1691 1692 1693
	if (!opts->no_bpf_event)
		perf_evlist__stop_sb_thread(sb_evlist);

1694
out_delete_evlist:
1695
	evlist__delete(top.evlist);
1696
	perf_session__delete(top.session);
1697 1698

	return status;
1699
}