builtin-top.c 43.8 KB
Newer Older
1
/*
2 3 4 5 6 7
 * 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>
8
 *		 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
9 10 11 12 13 14 15 16 17 18
 *
 * 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>
 *
 * Released under the GPL v2. (and only v2, not any later version)
19
 */
20
#include "builtin.h"
21

22
#include "perf.h"
23

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

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

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

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

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

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

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

80 81
#include "sane_ctype.h"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

182 183 184
	map->erange_warned = true;
}

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

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

199 200 201
	notes = symbol__annotation(sym);

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

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

206
	pthread_mutex_unlock(&notes->lock);
207

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

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

235
	if (!he)
236 237
		return;

238
	symbol = he->ms.sym;
239 240 241 242
	notes = symbol__annotation(symbol);

	pthread_mutex_lock(&notes->lock);

243 244
	symbol__calc_percent(symbol, evsel);

245 246
	if (notes->src == NULL)
		goto out_unlock;
247

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

251
	more = symbol__annotate_printf(symbol, he->ms.map, top->sym_evsel, &top->annotation_opts);
252 253 254 255 256 257 258

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

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

273
	puts(CONSOLE_CLEAR);
274

275
	perf_top__header_snprintf(top, bf, sizeof(bf));
276
	printf("%s\n", bf);
277

278
	printf("%-*.*s\n", win_width, win_width, graph_dotted_line);
279

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

291 292
	if (top->sym_filter_entry) {
		perf_top__show_details(top);
293 294 295
		return;
	}

296 297 298 299 300 301 302
	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 已提交
303 304
	}

305
	hists__collapse_resort(hists, NULL);
306
	perf_evsel__output_resort(evsel, NULL);
N
Namhyung Kim 已提交
307

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

314 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
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;
}

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

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

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

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

out_free:
	free(buf);
}

391
static void perf_top__print_mapped_keys(struct perf_top *top)
392
{
393 394
	char *name = NULL;

395 396
	if (top->sym_filter_entry) {
		struct symbol *sym = top->sym_filter_entry->ms.sym;
397 398 399 400
		name = sym->name;
	}

	fprintf(stdout, "\nMapped keys:\n");
401 402
	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);
403

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

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

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

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

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

	return 0;
445 446
}

447
static bool perf_top__handle_keypress(struct perf_top *top, int c)
448
{
449 450
	bool ret = true;

451
	if (!perf_top__key_mapped(top, c)) {
452
		struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
453
		struct termios save;
454

455
		perf_top__print_mapped_keys(top);
456 457 458
		fprintf(stdout, "\nEnter selection, or unmapped key to continue: ");
		fflush(stdout);

459
		set_term_quiet_input(&save);
460 461 462 463 464

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

		tcsetattr(0, TCSAFLUSH, &save);
465
		if (!perf_top__key_mapped(top, c))
466
			return ret;
467 468
	}

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

489
				fprintf(stderr, "\nAvailable events:");
490

491
				evlist__for_each_entry(top->evlist, top->sym_evsel)
492
					fprintf(stderr, "\n\t%d %s", top->sym_evsel->idx, perf_evsel__name(top->sym_evsel));
493

494
				prompt_integer(&counter, "Enter details event counter");
495

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

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

	return ret;
549 550
}

551 552 553
static void perf_top__sort_new_samples(void *arg)
{
	struct perf_top *t = arg;
554
	struct perf_evsel *evsel = t->sym_evsel;
555 556
	struct hists *hists;

557 558 559
	if (t->evlist->selected != NULL)
		t->sym_evsel = t->evlist->selected;

560
	hists = evsel__hists(evsel);
561

562 563 564 565 566 567 568
	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 已提交
569 570
	}

571
	hists__collapse_resort(hists, NULL);
572
	perf_evsel__output_resort(evsel, NULL);
573

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

578 579 580 581 582 583
static void stop_top(void)
{
	session_done = 1;
	done = 1;
}

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

595 596 597 598 599 600 601
	/* 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);

602
	perf_top__sort_new_samples(top);
603 604 605

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

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

620
	stop_top();
621 622 623
	return NULL;
}

624 625
static void display_sig(int sig __maybe_unused)
{
626
	stop_top();
627 628 629 630
}

static void display_setup_sig(void)
{
631 632
	signal(SIGSEGV, sighandler_dump_stack);
	signal(SIGFPE, sighandler_dump_stack);
633 634 635 636 637
	signal(SIGINT,  display_sig);
	signal(SIGQUIT, display_sig);
	signal(SIGTERM, display_sig);
}

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

645 646 647 648 649 650 651
	/* 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);

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

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

			if (perf_top__handle_keypress(top, c))
				goto repeat;
679
			stop_top();
680 681
		}
	}
682

683
	tcsetattr(0, TCSAFLUSH, &save);
684 685 686
	return NULL;
}

687 688 689 690 691 692 693 694
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;
	struct perf_evsel *evsel = iter->evsel;

695
	if (perf_hpp_list.sym && single)
696
		perf_top__record_precise_ip(top, he, iter->sample, evsel, al->addr);
697

698 699
	hist__account_cycles(iter->sample->branch_stack, al, iter->sample,
		     !(top->record_opts.branch_stack & PERF_SAMPLE_BRANCH_ANY));
700 701 702
	return 0;
}

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

713
	if (!machine && perf_guest) {
714 715 716
		static struct intlist *seen;

		if (!seen)
717
			seen = intlist__new(NULL);
718

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

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

733
	if (event->header.misc & PERF_RECORD_MISC_EXACT_IP)
734
		top->exact_samples++;
735

736
	if (machine__resolve(machine, &al, sample) < 0)
737
		return;
738

739
	if (!machine->kptr_restrict_warned &&
740 741
	    symbol_conf.kptr_restrict &&
	    al.cpumode == PERF_RECORD_MISC_KERNEL) {
742 743
		if (!perf_evlist__exclude_kernel(top->session->evlist)) {
			ui__warning(
744 745 746
"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",
747
			  al.map && map__has_symbols(al.map) ?
748
			  " modules" : "");
749 750 751
			if (use_browser <= 0)
				sleep(5);
		}
752
		machine->kptr_restrict_warned = true;
753 754
	}

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

			if (use_browser <= 0)
				sleep(5);
782
			top->vmlinux_warned = true;
783
		}
784 785
	}

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

794 795 796 797
		if (symbol_conf.cumulate_callchain)
			iter.ops = &hist_iter_cumulative;
		else
			iter.ops = &hist_iter_normal;
798

799
		pthread_mutex_lock(&hists->lock);
800

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

805
		pthread_mutex_unlock(&hists->lock);
806
	}
807

808
	addr_location__put(&al);
809 810
}

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

834 835
static u64 last_timestamp;

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

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

847
	while ((event = perf_mmap__read_event(md)) != NULL) {
J
Jiri Olsa 已提交
848
		int ret;
849

850
		ret = perf_evlist__parse_sample_timestamp(evlist, event, &last_timestamp);
J
Jiri Olsa 已提交
851
		if (ret && ret != -1)
852 853
			break;

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

		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);
		}
866
	}
867 868

	perf_mmap__read_done(md);
869 870
}

871
static void perf_top__mmap_read(struct perf_top *top)
872
{
873 874
	bool overwrite = top->record_opts.overwrite;
	struct perf_evlist *evlist = top->evlist;
875 876
	int i;

877 878 879
	if (overwrite)
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_DATA_PENDING);

880 881
	for (i = 0; i < top->evlist->nr_mmaps; i++)
		perf_top__mmap_read_idx(top, i);
882 883 884 885 886

	if (overwrite) {
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_RUNNING);
	}
887 888
}

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

	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;
968
	pr_debug2("fall back to non-overwrite mode\n");
K
Kan Liang 已提交
969 970 971
	return 1;
}

972
static int perf_top__start_counters(struct perf_top *top)
973
{
974
	char msg[BUFSIZ];
975
	struct perf_evsel *counter;
976
	struct perf_evlist *evlist = top->evlist;
977
	struct record_opts *opts = &top->record_opts;
978

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

985
	perf_evlist__config(evlist, opts, &callchain_param);
986

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

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

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

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

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

1025
	return 0;
1026 1027

out_err:
1028
	return -1;
1029 1030
}

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

	return 0;
}

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

		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 已提交
1073 1074 1075 1076 1077 1078 1079 1080

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

	return NULL;
}

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

1108 1109 1110
	if (should_drop(qevent, top)) {
		top->drop++;
		top->drop_total++;
1111
		return 0;
1112
	}
1113

J
Jiri Olsa 已提交
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 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
	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];
1183 1184
	pthread_mutex_init(&top->qe.mutex, NULL);
	pthread_cond_init(&top->qe.cond, NULL);
J
Jiri Olsa 已提交
1185 1186
}

1187
static int __cmd_top(struct perf_top *top)
1188
{
1189 1190 1191 1192
	char msg[512];
	struct perf_evsel *pos;
	struct perf_evsel_config_term *err_term;
	struct perf_evlist *evlist = top->evlist;
1193
	struct record_opts *opts = &top->record_opts;
J
Jiri Olsa 已提交
1194
	pthread_t thread, thread_process;
1195
	int ret;
1196

1197
	top->session = perf_session__new(NULL, false, NULL);
1198
	if (top->session == NULL)
1199
		return -1;
1200

1201 1202 1203
	if (!top->annotation_opts.objdump_path) {
		ret = perf_env__lookup_objdump(&top->session->header.env,
					       &top->annotation_opts.objdump_path);
1204 1205 1206 1207
		if (ret)
			goto out_delete;
	}

1208
	ret = callchain_param__setup_sample_type(&callchain_param);
1209 1210 1211
	if (ret)
		goto out_delete;

1212
	if (perf_session__register_idle_thread(top->session) < 0)
N
Namhyung Kim 已提交
1213 1214
		goto out_delete;

1215 1216
	if (top->nr_threads_synthesize > 1)
		perf_set_multithreaded();
1217

J
Jiri Olsa 已提交
1218 1219
	init_process_thread(top);

1220 1221 1222 1223 1224 1225
	ret = perf_event__synthesize_bpf_events(&top->tool, perf_event__process,
						&top->session->machines.host,
						&top->record_opts);
	if (ret < 0)
		pr_warning("Couldn't synthesize bpf events.\n");

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

1230 1231
	if (top->nr_threads_synthesize > 1)
		perf_set_singlethreaded();
1232

1233
	if (perf_hpp_list.socket) {
1234 1235 1236 1237 1238
		ret = perf_env__read_cpu_topology_map(&perf_env);
		if (ret < 0)
			goto out_err_cpu_topo;
	}

1239 1240 1241 1242
	ret = perf_top__start_counters(top);
	if (ret)
		goto out_delete;

1243 1244
	ret = perf_evlist__apply_drv_configs(evlist, &pos, &err_term);
	if (ret) {
1245
		pr_err("failed to set config \"%s\" on event %s with %d (%s)\n",
1246 1247 1248 1249 1250
			err_term->val.drv_cfg, perf_evsel__name(pos), errno,
			str_error_r(errno, msg, sizeof(msg)));
		goto out_delete;
	}

1251
	top->session->evlist = top->evlist;
1252
	perf_session__set_id_hdr_size(top->session);
1253

1254 1255 1256 1257 1258 1259 1260 1261
	/*
	 * 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.
	 */
1262
        if (!target__none(&opts->target))
1263 1264
                perf_evlist__enable(top->evlist);

1265
	ret = -1;
J
Jiri Olsa 已提交
1266 1267 1268 1269 1270
	if (pthread_create(&thread_process, NULL, process_thread, top)) {
		ui__error("Could not create process thread.\n");
		goto out_delete;
	}

1271
	if (pthread_create(&thread, NULL, (use_browser > 0 ? display_thread_tui :
1272
							    display_thread), top)) {
1273
		ui__error("Could not create display thread.\n");
J
Jiri Olsa 已提交
1274
		goto out_join_thread;
1275 1276
	}

1277
	if (top->realtime_prio) {
1278 1279
		struct sched_param param;

1280
		param.sched_priority = top->realtime_prio;
1281
		if (sched_setscheduler(0, SCHED_FIFO, &param)) {
1282
			ui__error("Could not set realtime priority.\n");
1283
			goto out_join;
1284 1285 1286
		}
	}

1287 1288 1289 1290 1291
	/* Wait for a minimal set of events before starting the snapshot */
	perf_evlist__poll(top->evlist, 100);

	perf_top__mmap_read(top);

1292
	while (!done) {
1293
		u64 hits = top->samples;
1294

1295
		perf_top__mmap_read(top);
1296

1297
		if (opts->overwrite || (hits == top->samples))
1298
			ret = perf_evlist__poll(top->evlist, 100);
1299 1300 1301 1302 1303

		if (resize) {
			perf_top__resize(top);
			resize = 0;
		}
1304 1305
	}

1306
	ret = 0;
1307 1308
out_join:
	pthread_join(thread, NULL);
J
Jiri Olsa 已提交
1309
out_join_thread:
1310
	pthread_cond_signal(&top->qe.cond);
J
Jiri Olsa 已提交
1311
	pthread_join(thread_process, NULL);
1312
out_delete:
1313 1314
	perf_session__delete(top->session);
	top->session = NULL;
1315

1316
	return ret;
1317 1318 1319

out_err_cpu_topo: {
	char errbuf[BUFSIZ];
1320
	const char *err = str_error_r(-ret, errbuf, sizeof(errbuf));
1321 1322 1323 1324

	ui__error("Could not read the CPU topology map: %s\n", err);
	goto out_delete;
}
1325 1326 1327
}

static int
J
Jiri Olsa 已提交
1328
callchain_opt(const struct option *opt, const char *arg, int unset)
1329 1330
{
	symbol_conf.use_callchain = true;
J
Jiri Olsa 已提交
1331 1332
	return record_callchain_opt(opt, arg, unset);
}
1333

J
Jiri Olsa 已提交
1334 1335 1336
static int
parse_callchain_opt(const struct option *opt, const char *arg, int unset)
{
1337
	struct callchain_param *callchain = opt->value;
1338

1339 1340
	callchain->enabled = !unset;
	callchain->record_mode = CALLCHAIN_FP;
1341 1342 1343 1344 1345 1346

	/*
	 * --no-call-graph
	 */
	if (unset) {
		symbol_conf.use_callchain = false;
1347
		callchain->record_mode = CALLCHAIN_NONE;
1348 1349 1350 1351
		return 0;
	}

	return parse_callchain_top_opt(arg);
1352
}
1353

1354
static int perf_top_config(const char *var, const char *value, void *cb __maybe_unused)
1355
{
1356 1357 1358 1359
	if (!strcmp(var, "top.call-graph")) {
		var = "call-graph.record-mode";
		return perf_default_config(var, value, cb);
	}
1360 1361 1362 1363
	if (!strcmp(var, "top.children")) {
		symbol_conf.cumulate_callchain = perf_config_bool(var, value);
		return 0;
	}
1364

1365
	return 0;
1366 1367
}

1368 1369 1370 1371 1372 1373 1374 1375 1376 1377
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;
}

1378 1379
const char top_callchain_help[] = CALLCHAIN_RECORD_HELP CALLCHAIN_REPORT_HELP
	"\n\t\t\t\tDefault: fp,graph,0.5,caller,function";
1380

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

	if (status < 0)
		return status;
1535

1536 1537 1538
	top.annotation_opts.min_pcnt = 5;
	top.annotation_opts.context  = 4;

1539
	top.evlist = perf_evlist__new();
1540
	if (top.evlist == NULL)
1541 1542
		return -ENOMEM;

1543 1544 1545
	status = perf_config(perf_top_config, &top);
	if (status)
		return status;
1546

1547 1548 1549 1550
	argc = parse_options(argc, argv, options, top_usage, 0);
	if (argc)
		usage_with_options(top_usage, options);

1551 1552 1553 1554 1555 1556
	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 已提交
1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569
	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;
		}
	}

1570 1571 1572
	if (opts->branch_stack && callchain_param.enabled)
		symbol_conf.show_branchflag_count = true;

1573
	sort__mode = SORT_MODE__TOP;
1574
	/* display thread wants entries to be collapsed in a different tree */
1575
	perf_hpp_list.need_collapse = 1;
1576

1577 1578 1579 1580 1581 1582 1583
	if (top.use_stdio)
		use_browser = 0;
	else if (top.use_tui)
		use_browser = 1;

	setup_browser(false);

1584
	if (setup_sorting(top.evlist) < 0) {
1585 1586 1587 1588 1589
		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);
1590 1591
		goto out_delete_evlist;
	}
1592

1593
	status = target__validate(target);
1594
	if (status) {
1595
		target__strerror(target, status, errbuf, BUFSIZ);
1596
		ui__warning("%s\n", errbuf);
1597 1598
	}

1599
	status = target__parse_uid(target);
1600 1601
	if (status) {
		int saved_errno = errno;
1602

1603
		target__strerror(target, status, errbuf, BUFSIZ);
1604
		ui__error("%s\n", errbuf);
1605 1606

		status = -saved_errno;
1607
		goto out_delete_evlist;
1608
	}
1609

1610
	if (target__none(target))
1611
		target->system_wide = true;
1612

1613 1614
	if (perf_evlist__create_maps(top.evlist, target) < 0) {
		ui__error("Couldn't create thread/CPU maps: %s\n",
1615
			  errno == ENOENT ? "No such process" : str_error_r(errno, errbuf, sizeof(errbuf)));
1616
		goto out_delete_evlist;
1617
	}
1618

1619 1620
	if (top.delay_secs < 1)
		top.delay_secs = 1;
1621

1622
	if (record_opts__config(opts)) {
1623
		status = -EINVAL;
1624
		goto out_delete_evlist;
1625 1626
	}

1627
	top.sym_evsel = perf_evlist__first(top.evlist);
1628

1629
	if (!callchain_param.enabled) {
N
Namhyung Kim 已提交
1630 1631 1632 1633
		symbol_conf.cumulate_callchain = false;
		perf_hpp__cancel_cumulate();
	}

1634 1635 1636
	if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
		callchain_param.order = ORDER_CALLER;

1637 1638 1639
	status = symbol__annotation_init();
	if (status < 0)
		goto out_delete_evlist;
1640

1641 1642
	annotation_config__init();

1643
	symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
1644
	if (symbol__init(NULL) < 0)
1645 1646
		return -1;

1647
	sort__setup_elide(stdout);
1648

1649
	get_term_dimensions(&top.winsize);
1650
	if (top.print_entries == 0) {
1651
		perf_top__update_print_entries(&top);
1652
		signal(SIGWINCH, winch_sig);
1653 1654
	}

1655
	status = __cmd_top(&top);
1656

1657
out_delete_evlist:
1658
	perf_evlist__delete(top.evlist);
1659 1660

	return status;
1661
}