builtin-top.c 44.0 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/evlist.h"
28
#include "util/evsel.h"
29
#include "util/event.h"
30
#include "util/machine.h"
31
#include "util/map.h"
32 33
#include "util/session.h"
#include "util/symbol.h"
34
#include "util/thread.h"
35
#include "util/thread_map.h"
36
#include "util/top.h"
37
#include <linux/rbtree.h>
38
#include <subcmd/parse-options.h>
39
#include "util/parse-events.h"
40
#include "util/cpumap.h"
41
#include "util/xyarray.h"
42
#include "util/sort.h"
43
#include "util/string2.h"
44
#include "util/term.h"
45
#include "util/intlist.h"
46
#include "util/parse-branch-options.h"
47
#include "arch/common.h"
48

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

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

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

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

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

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

79
#include <linux/ctype.h>
80

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

183 184 185
	map->erange_warned = true;
}

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

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

200 201 202
	notes = symbol__annotation(sym);

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

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

207
	pthread_mutex_unlock(&notes->lock);
208

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

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

236
	if (!he)
237 238
		return;

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

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

	pthread_mutex_lock(&notes->lock);

246 247
	symbol__calc_percent(symbol, evsel);

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

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

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

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

268
static void perf_top__print_sym_table(struct perf_top *top)
269
{
270 271
	char bf[160];
	int printed = 0;
272
	const int win_width = top->winsize.ws_col - 1;
273
	struct evsel *evsel = top->sym_evsel;
274
	struct hists *hists = evsel__hists(evsel);
275

276
	puts(CONSOLE_CLEAR);
277

278
	perf_top__header_snprintf(top, bf, sizeof(bf));
279
	printf("%s\n", bf);
280

281
	printf("%-*.*s\n", win_width, win_width, graph_dotted_line);
282

283 284 285
	if (!top->record_opts.overwrite &&
	    (hists->stats.nr_lost_warned !=
	    hists->stats.nr_events[PERF_RECORD_LOST])) {
286 287
		hists->stats.nr_lost_warned =
			      hists->stats.nr_events[PERF_RECORD_LOST];
288 289
		color_fprintf(stdout, PERF_COLOR_RED,
			      "WARNING: LOST %d chunks, Check IO/CPU overload",
290
			      hists->stats.nr_lost_warned);
291
		++printed;
292 293
	}

294 295
	if (top->sym_filter_entry) {
		perf_top__show_details(top);
296 297 298
		return;
	}

299 300 301 302 303 304 305
	if (top->evlist->enabled) {
		if (top->zero) {
			hists__delete_entries(hists);
		} else {
			hists__decay_entries(hists, top->hide_user_symbols,
					     top->hide_kernel_symbols);
		}
N
Namhyung Kim 已提交
306 307
	}

308
	hists__collapse_resort(hists, NULL);
309
	perf_evsel__output_resort(evsel, NULL);
N
Namhyung Kim 已提交
310

311
	hists__output_recalc_col_len(hists, top->print_entries - printed);
312
	putchar('\n');
313
	hists__fprintf(hists, false, top->print_entries - printed, win_width,
314
		       top->min_percent, stdout, !symbol_conf.use_callchain);
315 316
}

317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
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;
}

352
static void perf_top__prompt_symbol(struct perf_top *top, const char *msg)
353 354
{
	char *buf = malloc(0), *p;
355
	struct hist_entry *syme = top->sym_filter_entry, *n, *found = NULL;
356
	struct hists *hists = evsel__hists(top->sym_evsel);
357
	struct rb_node *next;
358 359 360 361 362
	size_t dummy = 0;

	/* zero counters of active symbol */
	if (syme) {
		__zero_source_counters(syme);
363
		top->sym_filter_entry = NULL;
364 365 366 367 368 369 370 371 372 373
	}

	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 已提交
374
	next = rb_first_cached(&hists->entries);
375 376 377 378
	while (next) {
		n = rb_entry(next, struct hist_entry, rb_node);
		if (n->ms.sym && !strcmp(buf, n->ms.sym->name)) {
			found = n;
379 380
			break;
		}
381
		next = rb_next(&n->rb_node);
382 383 384
	}

	if (!found) {
385
		fprintf(stderr, "Sorry, %s is not active.\n", buf);
386 387
		sleep(1);
	} else
388
		perf_top__parse_source(top, found);
389 390 391 392 393

out_free:
	free(buf);
}

394
static void perf_top__print_mapped_keys(struct perf_top *top)
395
{
396 397
	char *name = NULL;

398 399
	if (top->sym_filter_entry) {
		struct symbol *sym = top->sym_filter_entry->ms.sym;
400 401 402 403
		name = sym->name;
	}

	fprintf(stdout, "\nMapped keys:\n");
404 405
	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);
406

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

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

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

416
	fprintf(stdout,
S
Sihyeon Jang 已提交
417
		"\t[K]     hide kernel symbols.             \t(%s)\n",
418
		top->hide_kernel_symbols ? "yes" : "no");
419 420
	fprintf(stdout,
		"\t[U]     hide user symbols.               \t(%s)\n",
421 422
		top->hide_user_symbols ? "yes" : "no");
	fprintf(stdout, "\t[z]     toggle sample zeroing.             \t(%d)\n", top->zero ? 1 : 0);
423 424 425
	fprintf(stdout, "\t[qQ]    quit.\n");
}

426
static int perf_top__key_mapped(struct perf_top *top, int c)
427 428 429 430 431 432 433 434
{
	switch (c) {
		case 'd':
		case 'e':
		case 'f':
		case 'z':
		case 'q':
		case 'Q':
435 436
		case 'K':
		case 'U':
437 438 439
		case 'F':
		case 's':
		case 'S':
440 441
			return 1;
		case 'E':
442
			return top->evlist->nr_entries > 1 ? 1 : 0;
443 444
		default:
			break;
445 446 447
	}

	return 0;
448 449
}

450
static bool perf_top__handle_keypress(struct perf_top *top, int c)
451
{
452 453
	bool ret = true;

454
	if (!perf_top__key_mapped(top, c)) {
455
		struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
456
		struct termios save;
457

458
		perf_top__print_mapped_keys(top);
459 460 461
		fprintf(stdout, "\nEnter selection, or unmapped key to continue: ");
		fflush(stdout);

462
		set_term_quiet_input(&save);
463 464 465 466 467

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

		tcsetattr(0, TCSAFLUSH, &save);
468
		if (!perf_top__key_mapped(top, c))
469
			return ret;
470 471
	}

472 473
	switch (c) {
		case 'd':
474 475 476
			prompt_integer(&top->delay_secs, "Enter display delay");
			if (top->delay_secs < 1)
				top->delay_secs = 1;
477 478
			break;
		case 'e':
479 480
			prompt_integer(&top->print_entries, "Enter display entries (lines)");
			if (top->print_entries == 0) {
481
				perf_top__resize(top);
482
				signal(SIGWINCH, winch_sig);
483
			} else {
484
				signal(SIGWINCH, SIG_DFL);
485
			}
486 487
			break;
		case 'E':
488
			if (top->evlist->nr_entries > 1) {
489 490 491
				/* Select 0 as the default event: */
				int counter = 0;

492
				fprintf(stderr, "\nAvailable events:");
493

494
				evlist__for_each_entry(top->evlist, top->sym_evsel)
495
					fprintf(stderr, "\n\t%d %s", top->sym_evsel->idx, perf_evsel__name(top->sym_evsel));
496

497
				prompt_integer(&counter, "Enter details event counter");
498

499
				if (counter >= top->evlist->nr_entries) {
500
					top->sym_evsel = perf_evlist__first(top->evlist);
501
					fprintf(stderr, "Sorry, no such event, using %s.\n", perf_evsel__name(top->sym_evsel));
502
					sleep(1);
503
					break;
504
				}
505
				evlist__for_each_entry(top->evlist, top->sym_evsel)
506
					if (top->sym_evsel->idx == counter)
507
						break;
508
			} else
509
				top->sym_evsel = perf_evlist__first(top->evlist);
510 511
			break;
		case 'f':
512
			prompt_integer(&top->count_filter, "Enter display event count filter");
513 514
			break;
		case 'F':
515
			prompt_percent(&top->annotation_opts.min_pcnt,
516
				       "Enter details display event filter (percent)");
517
			break;
518
		case 'K':
519
			top->hide_kernel_symbols = !top->hide_kernel_symbols;
520
			break;
521 522 523
		case 'q':
		case 'Q':
			printf("exiting.\n");
524 525
			if (top->dump_symtab)
				perf_session__fprintf_dsos(top->session, stderr);
526 527
			ret = false;
			break;
528
		case 's':
529
			perf_top__prompt_symbol(top, "Enter details symbol");
530 531
			break;
		case 'S':
532
			if (!top->sym_filter_entry)
533 534
				break;
			else {
535
				struct hist_entry *syme = top->sym_filter_entry;
536

537
				top->sym_filter_entry = NULL;
538 539 540
				__zero_source_counters(syme);
			}
			break;
541
		case 'U':
542
			top->hide_user_symbols = !top->hide_user_symbols;
543
			break;
544
		case 'z':
545
			top->zero = !top->zero;
546
			break;
547 548
		default:
			break;
549
	}
550 551

	return ret;
552 553
}

554 555 556
static void perf_top__sort_new_samples(void *arg)
{
	struct perf_top *t = arg;
557
	struct evsel *evsel = t->sym_evsel;
558 559
	struct hists *hists;

560 561 562
	if (t->evlist->selected != NULL)
		t->sym_evsel = t->evlist->selected;

563
	hists = evsel__hists(evsel);
564

565 566 567 568 569 570 571
	if (t->evlist->enabled) {
		if (t->zero) {
			hists__delete_entries(hists);
		} else {
			hists__decay_entries(hists, t->hide_user_symbols,
					     t->hide_kernel_symbols);
		}
N
Namhyung Kim 已提交
572 573
	}

574
	hists__collapse_resort(hists, NULL);
575
	perf_evsel__output_resort(evsel, NULL);
576

577
	if (t->lost || t->drop)
578
		pr_warning("Too slow to read ring buffer (change period (-c/-F) or limit CPUs (-C)\n");
579 580
}

581 582 583 584 585 586
static void stop_top(void)
{
	session_done = 1;
	done = 1;
}

587
static void *display_thread_tui(void *arg)
588
{
589
	struct evsel *pos;
590
	struct perf_top *top = arg;
591
	const char *help = "For a higher level overview, try: perf top --sort comm,dso";
592 593 594 595 596
	struct hist_browser_timer hbt = {
		.timer		= perf_top__sort_new_samples,
		.arg		= top,
		.refresh	= top->delay_secs,
	};
597

598 599 600 601 602 603 604
	/* 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);

605
	perf_top__sort_new_samples(top);
606 607 608

	/*
	 * Initialize the uid_filter_str, in the future the TUI will allow
609
	 * Zooming in/out UIDs. For now just use whatever the user passed
610 611
	 * via --uid.
	 */
612
	evlist__for_each_entry(top->evlist, pos) {
613 614 615
		struct hists *hists = evsel__hists(pos);
		hists->uid_filter_str = top->record_opts.target.uid_str;
	}
616

617 618
	perf_evlist__tui_browse_hists(top->evlist, help, &hbt,
				      top->min_percent,
619
				      &top->session->header.env,
620 621
				      !top->record_opts.overwrite,
				      &top->annotation_opts);
622

623
	stop_top();
624 625 626
	return NULL;
}

627 628
static void display_sig(int sig __maybe_unused)
{
629
	stop_top();
630 631 632 633
}

static void display_setup_sig(void)
{
634 635
	signal(SIGSEGV, sighandler_dump_stack);
	signal(SIGFPE, sighandler_dump_stack);
636 637 638 639 640
	signal(SIGINT,  display_sig);
	signal(SIGQUIT, display_sig);
	signal(SIGTERM, display_sig);
}

641
static void *display_thread(void *arg)
642
{
643
	struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
644
	struct termios save;
645
	struct perf_top *top = arg;
646 647
	int delay_msecs, c;

648 649 650 651 652 653 654
	/* 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);

655
	display_setup_sig();
656
	pthread__unblock_sigwinch();
657
repeat:
658
	delay_msecs = top->delay_secs * MSEC_PER_SEC;
659
	set_term_quiet_input(&save);
660 661
	/* trash return*/
	getc(stdin);
662

663
	while (!done) {
664
		perf_top__print_sym_table(top);
665 666 667 668 669 670 671 672 673 674
		/*
		 * 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;
675
			__fallthrough;
676
		default:
677 678 679 680 681
			c = getc(stdin);
			tcsetattr(0, TCSAFLUSH, &save);

			if (perf_top__handle_keypress(top, c))
				goto repeat;
682
			stop_top();
683 684
		}
	}
685

686
	tcsetattr(0, TCSAFLUSH, &save);
687 688 689
	return NULL;
}

690 691 692 693 694 695
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;
696
	struct evsel *evsel = iter->evsel;
697

698
	if (perf_hpp_list.sym && single)
699
		perf_top__record_precise_ip(top, he, iter->sample, evsel, al->addr);
700

701 702
	hist__account_cycles(iter->sample->branch_stack, al, iter->sample,
		     !(top->record_opts.branch_stack & PERF_SAMPLE_BRANCH_ANY));
703 704 705
	return 0;
}

706 707
static void perf_event__process_sample(struct perf_tool *tool,
				       const union perf_event *event,
708
				       struct evsel *evsel,
709
				       struct perf_sample *sample,
710
				       struct machine *machine)
711
{
712
	struct perf_top *top = container_of(tool, struct perf_top, tool);
713
	struct addr_location al;
714
	int err;
715

716
	if (!machine && perf_guest) {
717 718 719
		static struct intlist *seen;

		if (!seen)
720
			seen = intlist__new(NULL);
721

722
		if (!intlist__has_entry(seen, sample->pid)) {
723
			pr_err("Can't find guest [%d]'s kernel information\n",
724 725
				sample->pid);
			intlist__add(seen, sample->pid);
726
		}
727 728 729
		return;
	}

730
	if (!machine) {
731
		pr_err("%u unprocessable samples recorded.\r",
732
		       top->session->evlist->stats.nr_unprocessable_samples++);
733 734 735
		return;
	}

736
	if (event->header.misc & PERF_RECORD_MISC_EXACT_IP)
737
		top->exact_samples++;
738

739
	if (machine__resolve(machine, &al, sample) < 0)
740
		return;
741

742
	if (!machine->kptr_restrict_warned &&
743 744
	    symbol_conf.kptr_restrict &&
	    al.cpumode == PERF_RECORD_MISC_KERNEL) {
745 746
		if (!perf_evlist__exclude_kernel(top->session->evlist)) {
			ui__warning(
747 748 749
"Kernel address maps (/proc/{kallsyms,modules}) are restricted.\n\n"
"Check /proc/sys/kernel/kptr_restrict.\n\n"
"Kernel%s samples will not be resolved.\n",
750
			  al.map && map__has_symbols(al.map) ?
751
			  " modules" : "");
752 753 754
			if (use_browser <= 0)
				sleep(5);
		}
755
		machine->kptr_restrict_warned = true;
756 757
	}

758
	if (al.sym == NULL && al.map != NULL) {
759
		const char *msg = "Kernel samples will not be resolved.\n";
760 761 762 763 764 765 766 767 768 769 770
		/*
		 * 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 ;-)
		 */
771
		if (!machine->kptr_restrict_warned && !top->vmlinux_warned &&
772
		    __map__is_kernel(al.map) && map__has_symbols(al.map)) {
773
			if (symbol_conf.vmlinux_name) {
774 775 776 777
				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);
778 779 780 781 782 783 784
			} else {
				ui__warning("A vmlinux file was not found.\n%s",
					    msg);
			}

			if (use_browser <= 0)
				sleep(5);
785
			top->vmlinux_warned = true;
786
		}
787 788
	}

789
	if (al.sym == NULL || !al.sym->idle) {
790
		struct hists *hists = evsel__hists(evsel);
791
		struct hist_entry_iter iter = {
792 793 794
			.evsel		= evsel,
			.sample 	= sample,
			.add_entry_cb 	= hist_iter__top_callback,
795
		};
796

797 798 799 800
		if (symbol_conf.cumulate_callchain)
			iter.ops = &hist_iter_cumulative;
		else
			iter.ops = &hist_iter_normal;
801

802
		pthread_mutex_lock(&hists->lock);
803

804
		err = hist_entry_iter__add(&iter, &al, top->max_stack, top);
805 806
		if (err < 0)
			pr_err("Problem incrementing symbol period, skipping event\n");
807

808
		pthread_mutex_unlock(&hists->lock);
809
	}
810

811
	addr_location__put(&al);
812 813
}

814 815
static void
perf_top__process_lost(struct perf_top *top, union perf_event *event,
816
		       struct evsel *evsel)
817 818 819 820 821 822 823 824 825 826 827
{
	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,
828
			       struct evsel *evsel)
829 830 831 832 833 834 835 836
{
	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;
}

837 838
static u64 last_timestamp;

839
static void perf_top__mmap_read_idx(struct perf_top *top, int idx)
840
{
841
	struct record_opts *opts = &top->record_opts;
842
	struct evlist *evlist = top->evlist;
843
	struct perf_mmap *md;
844
	union perf_event *event;
845

846
	md = opts->overwrite ? &evlist->overwrite_mmap[idx] : &evlist->mmap[idx];
847
	if (perf_mmap__read_init(md) < 0)
848 849
		return;

850
	while ((event = perf_mmap__read_event(md)) != NULL) {
J
Jiri Olsa 已提交
851
		int ret;
852

853
		ret = perf_evlist__parse_sample_timestamp(evlist, event, &last_timestamp);
J
Jiri Olsa 已提交
854
		if (ret && ret != -1)
855 856
			break;

857
		ret = ordered_events__queue(top->qe.in, event, last_timestamp, 0);
J
Jiri Olsa 已提交
858 859
		if (ret)
			break;
860 861 862 863 864 865 866 867 868

		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);
		}
869
	}
870 871

	perf_mmap__read_done(md);
872 873
}

874
static void perf_top__mmap_read(struct perf_top *top)
875
{
876
	bool overwrite = top->record_opts.overwrite;
877
	struct evlist *evlist = top->evlist;
878 879
	int i;

880 881 882
	if (overwrite)
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_DATA_PENDING);

883 884
	for (i = 0; i < top->evlist->nr_mmaps; i++)
		perf_top__mmap_read_idx(top, i);
885 886 887 888 889

	if (overwrite) {
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_RUNNING);
	}
890 891
}

892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911
/*
 * 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;
912
	struct evlist *evlist = top->evlist;
913 914
	struct perf_evsel_config_term *term;
	struct list_head *config_terms;
915
	struct evsel *evsel;
916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
	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 已提交
954
static int perf_top_overwrite_fallback(struct perf_top *top,
955
				       struct evsel *evsel)
K
Kan Liang 已提交
956 957
{
	struct record_opts *opts = &top->record_opts;
958
	struct evlist *evlist = top->evlist;
959
	struct evsel *counter;
K
Kan Liang 已提交
960 961 962 963 964 965 966 967 968 969 970

	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)
		counter->attr.write_backward = false;
	opts->overwrite = false;
971
	pr_debug2("fall back to non-overwrite mode\n");
K
Kan Liang 已提交
972 973 974
	return 1;
}

975
static int perf_top__start_counters(struct perf_top *top)
976
{
977
	char msg[BUFSIZ];
978
	struct evsel *counter;
979
	struct evlist *evlist = top->evlist;
980
	struct record_opts *opts = &top->record_opts;
981

982 983 984 985 986 987
	if (perf_top__overwrite_check(top)) {
		ui__error("perf top only support consistent per-event "
			  "overwrite setting for all events\n");
		goto out_err;
	}

988
	perf_evlist__config(evlist, opts, &callchain_param);
989

990
	evlist__for_each_entry(evlist, counter) {
991
try_again:
992
		if (perf_evsel__open(counter, top->evlist->cpus,
993
				     top->evlist->threads) < 0) {
K
Kan Liang 已提交
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008

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

1009
			if (perf_evsel__fallback(counter, errno, msg, sizeof(msg))) {
1010
				if (verbose > 0)
1011
					ui__warning("%s\n", msg);
1012 1013
				goto try_again;
			}
1014

1015 1016 1017
			perf_evsel__open_strerror(counter, &opts->target,
						  errno, msg, sizeof(msg));
			ui__error("%s\n", msg);
1018
			goto out_err;
1019
		}
1020
	}
1021

1022
	if (perf_evlist__mmap(evlist, opts->mmap_pages) < 0) {
1023
		ui__error("Failed to mmap with %d (%s)\n",
1024
			    errno, str_error_r(errno, msg, sizeof(msg)));
1025 1026 1027
		goto out_err;
	}

1028
	return 0;
1029 1030

out_err:
1031
	return -1;
1032 1033
}

1034
static int callchain_param__setup_sample_type(struct callchain_param *callchain)
1035
{
1036
	if (callchain->mode != CHAIN_NONE) {
1037
		if (callchain_register_param(callchain) < 0) {
1038
			ui__error("Can't register callchain params.\n");
1039 1040 1041 1042 1043 1044 1045
			return -EINVAL;
		}
	}

	return 0;
}

J
Jiri Olsa 已提交
1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
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);
1071 1072 1073 1074 1075

		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 已提交
1076 1077 1078 1079 1080 1081 1082 1083

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

	return NULL;
}

1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
/*
 * 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 已提交
1099 1100 1101 1102
static int deliver_event(struct ordered_events *qe,
			 struct ordered_event *qevent)
{
	struct perf_top *top = qe->data;
1103
	struct evlist *evlist = top->evlist;
J
Jiri Olsa 已提交
1104 1105 1106
	struct perf_session *session = top->session;
	union perf_event *event = qevent->event;
	struct perf_sample sample;
1107
	struct evsel *evsel;
J
Jiri Olsa 已提交
1108 1109 1110
	struct machine *machine;
	int ret = -1;

1111 1112 1113
	if (should_drop(qevent, top)) {
		top->drop++;
		top->drop_total++;
1114
		return 0;
1115
	}
1116

J
Jiri Olsa 已提交
1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
	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);

	if (event->header.type == PERF_RECORD_SAMPLE)
		++top->samples;

	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];
1186 1187
	pthread_mutex_init(&top->qe.mutex, NULL);
	pthread_cond_init(&top->qe.cond, NULL);
J
Jiri Olsa 已提交
1188 1189
}

1190
static int __cmd_top(struct perf_top *top)
1191
{
1192
	struct record_opts *opts = &top->record_opts;
J
Jiri Olsa 已提交
1193
	pthread_t thread, thread_process;
1194
	int ret;
1195

1196 1197 1198
	if (!top->annotation_opts.objdump_path) {
		ret = perf_env__lookup_objdump(&top->session->header.env,
					       &top->annotation_opts.objdump_path);
1199
		if (ret)
1200
			return ret;
1201 1202
	}

1203
	ret = callchain_param__setup_sample_type(&callchain_param);
1204
	if (ret)
1205
		return ret;
1206

1207
	if (perf_session__register_idle_thread(top->session) < 0)
1208
		return ret;
N
Namhyung Kim 已提交
1209

1210 1211
	if (top->nr_threads_synthesize > 1)
		perf_set_multithreaded();
1212

J
Jiri Olsa 已提交
1213 1214
	init_process_thread(top);

N
Namhyung Kim 已提交
1215 1216 1217
	if (opts->record_namespaces)
		top->tool.namespace_events = true;

1218
	ret = perf_event__synthesize_bpf_events(top->session, perf_event__process,
1219 1220 1221
						&top->session->machines.host,
						&top->record_opts);
	if (ret < 0)
1222
		pr_debug("Couldn't synthesize BPF events: Pre-existing BPF programs won't have symbols resolved.\n");
1223

1224
	machine__synthesize_threads(&top->session->machines.host, &opts->target,
1225
				    top->evlist->threads, false,
1226
				    top->nr_threads_synthesize);
1227

1228 1229
	if (top->nr_threads_synthesize > 1)
		perf_set_singlethreaded();
1230

1231
	if (perf_hpp_list.socket) {
1232
		ret = perf_env__read_cpu_topology_map(&perf_env);
1233 1234 1235 1236 1237 1238 1239
		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;
		}
1240 1241
	}

1242 1243
	ret = perf_top__start_counters(top);
	if (ret)
1244
		return ret;
1245

1246
	top->session->evlist = top->evlist;
1247
	perf_session__set_id_hdr_size(top->session);
1248

1249 1250 1251 1252 1253 1254 1255 1256
	/*
	 * 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.
	 */
1257
        if (!target__none(&opts->target))
1258 1259
                perf_evlist__enable(top->evlist);

1260
	ret = -1;
J
Jiri Olsa 已提交
1261 1262
	if (pthread_create(&thread_process, NULL, process_thread, top)) {
		ui__error("Could not create process thread.\n");
1263
		return ret;
J
Jiri Olsa 已提交
1264 1265
	}

1266
	if (pthread_create(&thread, NULL, (use_browser > 0 ? display_thread_tui :
1267
							    display_thread), top)) {
1268
		ui__error("Could not create display thread.\n");
J
Jiri Olsa 已提交
1269
		goto out_join_thread;
1270 1271
	}

1272
	if (top->realtime_prio) {
1273 1274
		struct sched_param param;

1275
		param.sched_priority = top->realtime_prio;
1276
		if (sched_setscheduler(0, SCHED_FIFO, &param)) {
1277
			ui__error("Could not set realtime priority.\n");
1278
			goto out_join;
1279 1280 1281
		}
	}

1282 1283 1284 1285 1286
	/* Wait for a minimal set of events before starting the snapshot */
	perf_evlist__poll(top->evlist, 100);

	perf_top__mmap_read(top);

1287
	while (!done) {
1288
		u64 hits = top->samples;
1289

1290
		perf_top__mmap_read(top);
1291

1292
		if (opts->overwrite || (hits == top->samples))
1293
			ret = perf_evlist__poll(top->evlist, 100);
1294 1295 1296 1297 1298

		if (resize) {
			perf_top__resize(top);
			resize = 0;
		}
1299 1300
	}

1301
	ret = 0;
1302 1303
out_join:
	pthread_join(thread, NULL);
J
Jiri Olsa 已提交
1304
out_join_thread:
1305
	pthread_cond_signal(&top->qe.cond);
J
Jiri Olsa 已提交
1306
	pthread_join(thread_process, NULL);
1307
	return ret;
1308 1309 1310
}

static int
J
Jiri Olsa 已提交
1311
callchain_opt(const struct option *opt, const char *arg, int unset)
1312 1313
{
	symbol_conf.use_callchain = true;
J
Jiri Olsa 已提交
1314 1315
	return record_callchain_opt(opt, arg, unset);
}
1316

J
Jiri Olsa 已提交
1317 1318 1319
static int
parse_callchain_opt(const struct option *opt, const char *arg, int unset)
{
1320
	struct callchain_param *callchain = opt->value;
1321

1322 1323
	callchain->enabled = !unset;
	callchain->record_mode = CALLCHAIN_FP;
1324 1325 1326 1327 1328 1329

	/*
	 * --no-call-graph
	 */
	if (unset) {
		symbol_conf.use_callchain = false;
1330
		callchain->record_mode = CALLCHAIN_NONE;
1331 1332 1333 1334
		return 0;
	}

	return parse_callchain_top_opt(arg);
1335
}
1336

1337
static int perf_top_config(const char *var, const char *value, void *cb __maybe_unused)
1338
{
1339 1340 1341 1342
	if (!strcmp(var, "top.call-graph")) {
		var = "call-graph.record-mode";
		return perf_default_config(var, value, cb);
	}
1343 1344 1345 1346
	if (!strcmp(var, "top.children")) {
		symbol_conf.cumulate_callchain = perf_config_bool(var, value);
		return 0;
	}
1347

1348
	return 0;
1349 1350
}

1351 1352 1353 1354 1355 1356 1357 1358 1359 1360
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;
}

1361 1362
const char top_callchain_help[] = CALLCHAIN_RECORD_HELP CALLCHAIN_REPORT_HELP
	"\n\t\t\t\tDefault: fp,graph,0.5,caller,function";
1363

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

	if (status < 0)
		return status;
1523

1524 1525 1526
	top.annotation_opts.min_pcnt = 5;
	top.annotation_opts.context  = 4;

1527
	top.evlist = evlist__new();
1528
	if (top.evlist == NULL)
1529 1530
		return -ENOMEM;

1531 1532 1533
	status = perf_config(perf_top_config, &top);
	if (status)
		return status;
1534

1535 1536 1537 1538
	argc = parse_options(argc, argv, options, top_usage, 0);
	if (argc)
		usage_with_options(top_usage, options);

1539 1540 1541 1542 1543 1544
	if (!top.evlist->nr_entries &&
	    perf_evlist__add_default(top.evlist) < 0) {
		pr_err("Not enough memory for event selector list\n");
		goto out_delete_evlist;
	}

N
Namhyung Kim 已提交
1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557
	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;
		}
	}

1558 1559 1560
	if (opts->branch_stack && callchain_param.enabled)
		symbol_conf.show_branchflag_count = true;

1561
	sort__mode = SORT_MODE__TOP;
1562
	/* display thread wants entries to be collapsed in a different tree */
1563
	perf_hpp_list.need_collapse = 1;
1564

1565 1566 1567 1568 1569 1570 1571
	if (top.use_stdio)
		use_browser = 0;
	else if (top.use_tui)
		use_browser = 1;

	setup_browser(false);

1572
	if (setup_sorting(top.evlist) < 0) {
1573 1574 1575 1576 1577
		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);
1578 1579
		goto out_delete_evlist;
	}
1580

1581
	status = target__validate(target);
1582
	if (status) {
1583
		target__strerror(target, status, errbuf, BUFSIZ);
1584
		ui__warning("%s\n", errbuf);
1585 1586
	}

1587
	status = target__parse_uid(target);
1588 1589
	if (status) {
		int saved_errno = errno;
1590

1591
		target__strerror(target, status, errbuf, BUFSIZ);
1592
		ui__error("%s\n", errbuf);
1593 1594

		status = -saved_errno;
1595
		goto out_delete_evlist;
1596
	}
1597

1598
	if (target__none(target))
1599
		target->system_wide = true;
1600

1601 1602
	if (perf_evlist__create_maps(top.evlist, target) < 0) {
		ui__error("Couldn't create thread/CPU maps: %s\n",
1603
			  errno == ENOENT ? "No such process" : str_error_r(errno, errbuf, sizeof(errbuf)));
1604
		goto out_delete_evlist;
1605
	}
1606

1607 1608
	if (top.delay_secs < 1)
		top.delay_secs = 1;
1609

1610
	if (record_opts__config(opts)) {
1611
		status = -EINVAL;
1612
		goto out_delete_evlist;
1613 1614
	}

1615
	top.sym_evsel = perf_evlist__first(top.evlist);
1616

1617
	if (!callchain_param.enabled) {
N
Namhyung Kim 已提交
1618 1619 1620 1621
		symbol_conf.cumulate_callchain = false;
		perf_hpp__cancel_cumulate();
	}

1622 1623 1624
	if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
		callchain_param.order = ORDER_CALLER;

1625 1626 1627
	status = symbol__annotation_init();
	if (status < 0)
		goto out_delete_evlist;
1628

1629 1630
	annotation_config__init();

1631
	symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
1632 1633 1634
	status = symbol__init(NULL);
	if (status < 0)
		goto out_delete_evlist;
1635

1636
	sort__setup_elide(stdout);
1637

1638
	get_term_dimensions(&top.winsize);
1639
	if (top.print_entries == 0) {
1640
		perf_top__update_print_entries(&top);
1641
		signal(SIGWINCH, winch_sig);
1642 1643
	}

1644 1645 1646 1647 1648 1649
	top.session = perf_session__new(NULL, false, NULL);
	if (top.session == NULL) {
		status = -1;
		goto out_delete_evlist;
	}

1650 1651 1652
	if (!top.record_opts.no_bpf_event)
		bpf_event__add_sb_event(&sb_evlist, &perf_env);

1653 1654 1655 1656 1657
	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;
	}

1658
	status = __cmd_top(&top);
1659

1660 1661 1662
	if (!opts->no_bpf_event)
		perf_evlist__stop_sb_thread(sb_evlist);

1663
out_delete_evlist:
1664
	evlist__delete(top.evlist);
1665
	perf_session__delete(top.session);
1666 1667

	return status;
1668
}