builtin-top.c 45.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/evsel_config.h"
31
#include "util/event.h"
32
#include "util/machine.h"
33
#include "util/map.h"
34
#include "util/mmap.h"
35 36
#include "util/session.h"
#include "util/symbol.h"
37
#include "util/synthetic-events.h"
38
#include "util/top.h"
39
#include "util/util.h"
40
#include <linux/rbtree.h>
41
#include <subcmd/parse-options.h>
42
#include "util/parse-events.h"
43
#include "util/callchain.h"
44
#include "util/cpumap.h"
45
#include "util/sort.h"
46
#include "util/string2.h"
47
#include "util/term.h"
48
#include "util/intlist.h"
49
#include "util/parse-branch-options.h"
50
#include "arch/common.h"
51
#include "ui/ui.h"
52

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

56
#include <assert.h>
57
#include <elf.h>
58
#include <fcntl.h>
59

60
#include <stdio.h>
61 62
#include <termios.h>
#include <unistd.h>
63
#include <inttypes.h>
64

65 66 67
#include <errno.h>
#include <time.h>
#include <sched.h>
68
#include <signal.h>
69 70 71

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

79
#include <linux/stringify.h>
80
#include <linux/time64.h>
81
#include <linux/types.h>
82
#include <linux/err.h>
83

84
#include <linux/ctype.h>
85
#include <perf/mmap.h>
86

87
static volatile int done;
88
static volatile int resize;
89

N
Namhyung Kim 已提交
90 91
#define HEADER_LINE_NR  5

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

97
static void winch_sig(int sig __maybe_unused)
98
{
99 100
	resize = 1;
}
101

102 103
static void perf_top__resize(struct perf_top *top)
{
104 105
	get_term_dimensions(&top->winsize);
	perf_top__update_print_entries(top);
106 107
}

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

116
	if (!he || !he->ms.sym)
117 118
		return -1;

119 120
	evsel = hists_to_evsel(he->hists);

121 122
	sym = he->ms.sym;
	map = he->ms.map;
123 124 125 126

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

135 136
	notes = symbol__annotation(sym);
	pthread_mutex_lock(&notes->lock);
137

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

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

155
	pthread_mutex_unlock(&notes->lock);
156
	return err;
157 158
}

159
static void __zero_source_counters(struct hist_entry *he)
160
{
161
	struct symbol *sym = he->ms.sym;
162
	symbol__annotate_zero_histograms(sym);
163 164
}

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

189 190 191
	map->erange_warned = true;
}

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

201 202 203
	if (sym == NULL || (use_browser == 0 &&
			    (top->sym_filter_entry == NULL ||
			     top->sym_filter_entry->ms.sym != sym)))
204 205
		return;

206 207 208
	notes = symbol__annotation(sym);

	if (pthread_mutex_trylock(&notes->lock))
209 210
		return;

211
	err = hist_entry__inc_addr_samples(he, sample, evsel, ip);
212

213
	pthread_mutex_unlock(&notes->lock);
214

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

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

242
	if (!he)
243 244
		return;

245 246
	evsel = hists_to_evsel(he->hists);

247
	symbol = he->ms.sym;
248 249 250 251
	notes = symbol__annotation(symbol);

	pthread_mutex_lock(&notes->lock);

252 253
	symbol__calc_percent(symbol, evsel);

254 255
	if (notes->src == NULL)
		goto out_unlock;
256

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

260
	more = symbol__annotate_printf(&he->ms, top->sym_evsel, &top->annotation_opts);
261 262 263 264 265 266 267

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

274
static void perf_top__resort_hists(struct perf_top *t)
275
{
276
	struct evlist *evlist = t->evlist;
277 278 279 280 281
	struct evsel *pos;

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

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

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

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

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

322
	puts(CONSOLE_CLEAR);
323

324
	perf_top__header_snprintf(top, bf, sizeof(bf));
325
	printf("%s\n", bf);
326

327
	printf("%-*.*s\n", win_width, win_width, graph_dotted_line);
328

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

340 341
	if (top->sym_filter_entry) {
		perf_top__show_details(top);
342 343 344
		return;
	}

345
	perf_top__resort_hists(top);
N
Namhyung Kim 已提交
346

347
	hists__output_recalc_col_len(hists, top->print_entries - printed);
348
	putchar('\n');
349
	hists__fprintf(hists, false, top->print_entries - printed, win_width,
350
		       top->min_percent, stdout, !symbol_conf.use_callchain);
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 385 386 387
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;
}

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

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

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

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

out_free:
	free(buf);
}

430
static void perf_top__print_mapped_keys(struct perf_top *top)
431
{
432 433
	char *name = NULL;

434 435
	if (top->sym_filter_entry) {
		struct symbol *sym = top->sym_filter_entry->ms.sym;
436 437 438 439
		name = sym->name;
	}

	fprintf(stdout, "\nMapped keys:\n");
440 441
	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);
442

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

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

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

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

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

	return 0;
484 485
}

486
static bool perf_top__handle_keypress(struct perf_top *top, int c)
487
{
488 489
	bool ret = true;

490
	if (!perf_top__key_mapped(top, c)) {
491
		struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
492
		struct termios save;
493

494
		perf_top__print_mapped_keys(top);
495 496 497
		fprintf(stdout, "\nEnter selection, or unmapped key to continue: ");
		fflush(stdout);

498
		set_term_quiet_input(&save);
499 500 501 502 503

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

		tcsetattr(0, TCSAFLUSH, &save);
504
		if (!perf_top__key_mapped(top, c))
505
			return ret;
506 507
	}

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

528
				fprintf(stderr, "\nAvailable events:");
529

530
				evlist__for_each_entry(top->evlist, top->sym_evsel)
531
					fprintf(stderr, "\n\t%d %s", top->sym_evsel->idx, perf_evsel__name(top->sym_evsel));
532

533
				prompt_integer(&counter, "Enter details event counter");
534

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

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

	return ret;
588 589
}

590 591 592
static void perf_top__sort_new_samples(void *arg)
{
	struct perf_top *t = arg;
593

594 595 596
	if (t->evlist->selected != NULL)
		t->sym_evsel = t->evlist->selected;

597
	perf_top__resort_hists(t);
598

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

603 604 605 606 607 608
static void stop_top(void)
{
	session_done = 1;
	done = 1;
}

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

620 621 622 623 624 625 626
	/* 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);

627 628
	prctl(PR_SET_NAME, "perf-top-UI", 0, 0, 0);

629
	perf_top__sort_new_samples(top);
630 631 632

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

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

647
	stop_top();
648 649 650
	return NULL;
}

651 652
static void display_sig(int sig __maybe_unused)
{
653
	stop_top();
654 655 656 657
}

static void display_setup_sig(void)
{
658 659
	signal(SIGSEGV, sighandler_dump_stack);
	signal(SIGFPE, sighandler_dump_stack);
660 661 662 663 664
	signal(SIGINT,  display_sig);
	signal(SIGQUIT, display_sig);
	signal(SIGTERM, display_sig);
}

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

672 673 674 675 676 677 678
	/* 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);

679 680
	prctl(PR_SET_NAME, "perf-top-UI", 0, 0, 0);

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

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

			if (perf_top__handle_keypress(top, c))
				goto repeat;
708
			stop_top();
709 710
		}
	}
711

712
	tcsetattr(0, TCSAFLUSH, &save);
713 714 715
	return NULL;
}

716 717 718 719 720 721
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;
722
	struct evsel *evsel = iter->evsel;
723

724
	if (perf_hpp_list.sym && single)
725
		perf_top__record_precise_ip(top, he, iter->sample, evsel, al->addr);
726

727
	hist__account_cycles(iter->sample->branch_stack, al, iter->sample,
728 729
		     !(top->record_opts.branch_stack & PERF_SAMPLE_BRANCH_ANY),
		     NULL);
730 731 732
	return 0;
}

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

743
	if (!machine && perf_guest) {
744 745 746
		static struct intlist *seen;

		if (!seen)
747
			seen = intlist__new(NULL);
748

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

757
	if (!machine) {
758
		pr_err("%u unprocessable samples recorded.\r",
759
		       top->session->evlist->stats.nr_unprocessable_samples++);
760 761 762
		return;
	}

763
	if (event->header.misc & PERF_RECORD_MISC_EXACT_IP)
764
		top->exact_samples++;
765

766
	if (machine__resolve(machine, &al, sample) < 0)
767
		return;
768

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

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

			if (use_browser <= 0)
				sleep(5);
812
			top->vmlinux_warned = true;
813
		}
814 815
	}

816
	if (al.sym == NULL || !al.sym->idle) {
817
		struct hists *hists = evsel__hists(evsel);
818
		struct hist_entry_iter iter = {
819 820 821
			.evsel		= evsel,
			.sample 	= sample,
			.add_entry_cb 	= hist_iter__top_callback,
822
		};
823

824 825 826 827
		if (symbol_conf.cumulate_callchain)
			iter.ops = &hist_iter_cumulative;
		else
			iter.ops = &hist_iter_normal;
828

829
		pthread_mutex_lock(&hists->lock);
830

831
		err = hist_entry_iter__add(&iter, &al, top->max_stack, top);
832 833
		if (err < 0)
			pr_err("Problem incrementing symbol period, skipping event\n");
834

835
		pthread_mutex_unlock(&hists->lock);
836
	}
837

838
	addr_location__put(&al);
839 840
}

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

864 865
static u64 last_timestamp;

866
static void perf_top__mmap_read_idx(struct perf_top *top, int idx)
867
{
868
	struct record_opts *opts = &top->record_opts;
869
	struct evlist *evlist = top->evlist;
870
	struct mmap *md;
871
	union perf_event *event;
872

873
	md = opts->overwrite ? &evlist->overwrite_mmap[idx] : &evlist->mmap[idx];
874
	if (perf_mmap__read_init(&md->core) < 0)
875 876
		return;

877
	while ((event = perf_mmap__read_event(&md->core)) != NULL) {
J
Jiri Olsa 已提交
878
		int ret;
879

880
		ret = perf_evlist__parse_sample_timestamp(evlist, event, &last_timestamp);
J
Jiri Olsa 已提交
881
		if (ret && ret != -1)
882 883
			break;

884
		ret = ordered_events__queue(top->qe.in, event, last_timestamp, 0);
J
Jiri Olsa 已提交
885 886
		if (ret)
			break;
887

888
		perf_mmap__consume(&md->core);
889 890 891 892 893 894 895

		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);
		}
896
	}
897

898
	perf_mmap__read_done(&md->core);
899 900
}

901
static void perf_top__mmap_read(struct perf_top *top)
902
{
903
	bool overwrite = top->record_opts.overwrite;
904
	struct evlist *evlist = top->evlist;
905 906
	int i;

907 908 909
	if (overwrite)
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_DATA_PENDING);

910
	for (i = 0; i < top->evlist->core.nr_mmaps; i++)
911
		perf_top__mmap_read_idx(top, i);
912 913 914 915 916

	if (overwrite) {
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_RUNNING);
	}
917 918
}

919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938
/*
 * 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;
939
	struct evlist *evlist = top->evlist;
940 941
	struct perf_evsel_config_term *term;
	struct list_head *config_terms;
942
	struct evsel *evsel;
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
	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 */
968
			if (evsel == evlist__first(evlist))
969 970 971 972 973 974 975 976 977 978 979 980
				overwrite = set;
			else
				return -1;
		}
	}

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

	return 0;
}

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

	if (!opts->overwrite)
		return 0;

	/* only fall back when first event fails */
992
	if (evsel != evlist__first(evlist))
K
Kan Liang 已提交
993 994 995
		return 0;

	evlist__for_each_entry(evlist, counter)
996
		counter->core.attr.write_backward = false;
K
Kan Liang 已提交
997
	opts->overwrite = false;
998
	pr_debug2("fall back to non-overwrite mode\n");
K
Kan Liang 已提交
999 1000 1001
	return 1;
}

1002
static int perf_top__start_counters(struct perf_top *top)
1003
{
1004
	char msg[BUFSIZ];
1005
	struct evsel *counter;
1006
	struct evlist *evlist = top->evlist;
1007
	struct record_opts *opts = &top->record_opts;
1008

1009 1010 1011 1012 1013 1014
	if (perf_top__overwrite_check(top)) {
		ui__error("perf top only support consistent per-event "
			  "overwrite setting for all events\n");
		goto out_err;
	}

1015
	perf_evlist__config(evlist, opts, &callchain_param);
1016

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

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

1036
			if (perf_evsel__fallback(counter, errno, msg, sizeof(msg))) {
1037
				if (verbose > 0)
1038
					ui__warning("%s\n", msg);
1039 1040
				goto try_again;
			}
1041

1042 1043 1044
			perf_evsel__open_strerror(counter, &opts->target,
						  errno, msg, sizeof(msg));
			ui__error("%s\n", msg);
1045
			goto out_err;
1046
		}
1047
	}
1048

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

1055
	return 0;
1056 1057

out_err:
1058
	return -1;
1059 1060
}

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

	return 0;
}

J
Jiri Olsa 已提交
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
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);
1098 1099 1100 1101 1102

		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 已提交
1103 1104 1105 1106 1107 1108 1109 1110

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

	return NULL;
}

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

1138 1139 1140
	if (should_drop(qevent, top)) {
		top->drop++;
		top->drop_total++;
1141
		return 0;
1142
	}
1143

J
Jiri Olsa 已提交
1144 1145 1146 1147 1148 1149 1150 1151 1152
	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);

1153 1154 1155
	if (event->header.type == PERF_RECORD_SAMPLE) {
		if (evswitch__discard(&top->evswitch, evsel))
			return 0;
J
Jiri Olsa 已提交
1156
		++top->samples;
1157
	}
J
Jiri Olsa 已提交
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 1212 1213 1214 1215

	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];
1216 1217
	pthread_mutex_init(&top->qe.mutex, NULL);
	pthread_cond_init(&top->qe.cond, NULL);
J
Jiri Olsa 已提交
1218 1219
}

1220
static int __cmd_top(struct perf_top *top)
1221
{
1222
	struct record_opts *opts = &top->record_opts;
J
Jiri Olsa 已提交
1223
	pthread_t thread, thread_process;
1224
	int ret;
1225

1226 1227 1228
	if (!top->annotation_opts.objdump_path) {
		ret = perf_env__lookup_objdump(&top->session->header.env,
					       &top->annotation_opts.objdump_path);
1229
		if (ret)
1230
			return ret;
1231 1232
	}

1233
	ret = callchain_param__setup_sample_type(&callchain_param);
1234
	if (ret)
1235
		return ret;
1236

1237
	if (perf_session__register_idle_thread(top->session) < 0)
1238
		return ret;
N
Namhyung Kim 已提交
1239

1240 1241
	if (top->nr_threads_synthesize > 1)
		perf_set_multithreaded();
1242

J
Jiri Olsa 已提交
1243 1244
	init_process_thread(top);

N
Namhyung Kim 已提交
1245 1246 1247
	if (opts->record_namespaces)
		top->tool.namespace_events = true;

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

1254
	machine__synthesize_threads(&top->session->machines.host, &opts->target,
1255
				    top->evlist->core.threads, false,
1256
				    top->nr_threads_synthesize);
1257

1258 1259
	if (top->nr_threads_synthesize > 1)
		perf_set_singlethreaded();
1260

1261
	if (perf_hpp_list.socket) {
1262
		ret = perf_env__read_cpu_topology_map(&perf_env);
1263 1264 1265 1266 1267 1268 1269
		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;
		}
1270 1271
	}

1272 1273
	ret = perf_top__start_counters(top);
	if (ret)
1274
		return ret;
1275

1276
	top->session->evlist = top->evlist;
1277
	perf_session__set_id_hdr_size(top->session);
1278

1279 1280 1281 1282 1283 1284 1285 1286
	/*
	 * 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.
	 */
1287
        if (!target__none(&opts->target))
1288
		evlist__enable(top->evlist);
1289

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

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

1302
	if (top->realtime_prio) {
1303 1304
		struct sched_param param;

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

1312
	/* Wait for a minimal set of events before starting the snapshot */
1313
	evlist__poll(top->evlist, 100);
1314 1315 1316

	perf_top__mmap_read(top);

1317
	while (!done) {
1318
		u64 hits = top->samples;
1319

1320
		perf_top__mmap_read(top);
1321

1322
		if (opts->overwrite || (hits == top->samples))
1323
			ret = evlist__poll(top->evlist, 100);
1324 1325 1326 1327 1328

		if (resize) {
			perf_top__resize(top);
			resize = 0;
		}
1329 1330
	}

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

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

J
Jiri Olsa 已提交
1347 1348 1349
static int
parse_callchain_opt(const struct option *opt, const char *arg, int unset)
{
1350
	struct callchain_param *callchain = opt->value;
1351

1352 1353
	callchain->enabled = !unset;
	callchain->record_mode = CALLCHAIN_FP;
1354 1355 1356 1357 1358 1359

	/*
	 * --no-call-graph
	 */
	if (unset) {
		symbol_conf.use_callchain = false;
1360
		callchain->record_mode = CALLCHAIN_NONE;
1361 1362 1363 1364
		return 0;
	}

	return parse_callchain_top_opt(arg);
1365
}
1366

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

1378
	return 0;
1379 1380
}

1381 1382 1383 1384 1385 1386 1387 1388 1389 1390
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;
}

1391 1392
const char top_callchain_help[] = CALLCHAIN_RECORD_HELP CALLCHAIN_REPORT_HELP
	"\n\t\t\t\tDefault: fp,graph,0.5,caller,function";
1393

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

	if (status < 0)
		return status;
1558

1559 1560 1561
	top.annotation_opts.min_pcnt = 5;
	top.annotation_opts.context  = 4;

1562
	top.evlist = evlist__new();
1563
	if (top.evlist == NULL)
1564 1565
		return -ENOMEM;

1566 1567 1568
	status = perf_config(perf_top_config, &top);
	if (status)
		return status;
1569 1570 1571 1572 1573 1574
	/*
	 * Since the per arch annotation init routine may need the cpuid, read
	 * it here, since we are not getting this from the perf.data header.
	 */
	status = perf_env__read_cpuid(&perf_env);
	if (status) {
1575 1576 1577 1578 1579 1580 1581
		/*
		 * Some arches do not provide a get_cpuid(), so just use pr_debug, otherwise
		 * warn the user explicitely.
		 */
		eprintf(status == ENOSYS ? 1 : 0, verbose,
			"Couldn't read the cpuid for this machine: %s\n",
			str_error_r(errno, errbuf, sizeof(errbuf)));
1582 1583
	}
	top.evlist->env = &perf_env;
1584

1585 1586 1587 1588
	argc = parse_options(argc, argv, options, top_usage, 0);
	if (argc)
		usage_with_options(top_usage, options);

1589 1590 1591
	if (annotate_check_args(&top.annotation_opts) < 0)
		goto out_delete_evlist;

1592
	if (!top.evlist->core.nr_entries &&
1593 1594 1595 1596 1597
	    perf_evlist__add_default(top.evlist) < 0) {
		pr_err("Not enough memory for event selector list\n");
		goto out_delete_evlist;
	}

1598 1599 1600 1601
	status = evswitch__init(&top.evswitch, top.evlist, stderr);
	if (status)
		goto out_delete_evlist;

N
Namhyung Kim 已提交
1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614
	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;
		}
	}

1615 1616 1617
	if (opts->branch_stack && callchain_param.enabled)
		symbol_conf.show_branchflag_count = true;

1618
	sort__mode = SORT_MODE__TOP;
1619
	/* display thread wants entries to be collapsed in a different tree */
1620
	perf_hpp_list.need_collapse = 1;
1621

1622 1623 1624 1625 1626 1627 1628
	if (top.use_stdio)
		use_browser = 0;
	else if (top.use_tui)
		use_browser = 1;

	setup_browser(false);

1629
	if (setup_sorting(top.evlist) < 0) {
1630 1631 1632 1633 1634
		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);
1635 1636
		goto out_delete_evlist;
	}
1637

1638
	status = target__validate(target);
1639
	if (status) {
1640
		target__strerror(target, status, errbuf, BUFSIZ);
1641
		ui__warning("%s\n", errbuf);
1642 1643
	}

1644
	status = target__parse_uid(target);
1645 1646
	if (status) {
		int saved_errno = errno;
1647

1648
		target__strerror(target, status, errbuf, BUFSIZ);
1649
		ui__error("%s\n", errbuf);
1650 1651

		status = -saved_errno;
1652
		goto out_delete_evlist;
1653
	}
1654

1655
	if (target__none(target))
1656
		target->system_wide = true;
1657

1658 1659
	if (perf_evlist__create_maps(top.evlist, target) < 0) {
		ui__error("Couldn't create thread/CPU maps: %s\n",
1660
			  errno == ENOENT ? "No such process" : str_error_r(errno, errbuf, sizeof(errbuf)));
1661
		goto out_delete_evlist;
1662
	}
1663

1664 1665
	if (top.delay_secs < 1)
		top.delay_secs = 1;
1666

1667
	if (record_opts__config(opts)) {
1668
		status = -EINVAL;
1669
		goto out_delete_evlist;
1670 1671
	}

1672
	top.sym_evsel = evlist__first(top.evlist);
1673

1674
	if (!callchain_param.enabled) {
N
Namhyung Kim 已提交
1675 1676 1677 1678
		symbol_conf.cumulate_callchain = false;
		perf_hpp__cancel_cumulate();
	}

1679 1680 1681
	if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
		callchain_param.order = ORDER_CALLER;

1682 1683 1684
	status = symbol__annotation_init();
	if (status < 0)
		goto out_delete_evlist;
1685

1686
	annotation_config__init(&top.annotation_opts);
1687

1688
	symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
1689 1690 1691
	status = symbol__init(NULL);
	if (status < 0)
		goto out_delete_evlist;
1692

1693
	sort__setup_elide(stdout);
1694

1695
	get_term_dimensions(&top.winsize);
1696
	if (top.print_entries == 0) {
1697
		perf_top__update_print_entries(&top);
1698
		signal(SIGWINCH, winch_sig);
1699 1700
	}

1701
	top.session = perf_session__new(NULL, false, NULL);
1702 1703
	if (IS_ERR(top.session)) {
		status = PTR_ERR(top.session);
1704 1705 1706
		goto out_delete_evlist;
	}

1707 1708 1709
	if (!top.record_opts.no_bpf_event)
		bpf_event__add_sb_event(&sb_evlist, &perf_env);

1710 1711 1712 1713 1714
	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;
	}

1715
	status = __cmd_top(&top);
1716

1717 1718 1719
	if (!opts->no_bpf_event)
		perf_evlist__stop_sb_thread(sb_evlist);

1720
out_delete_evlist:
1721
	evlist__delete(top.evlist);
1722
	perf_session__delete(top.session);
1723 1724

	return status;
1725
}