builtin-top.c 44.1 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/sort.h"
42
#include "util/string2.h"
43
#include "util/term.h"
44
#include "util/intlist.h"
45
#include "util/parse-branch-options.h"
46
#include "arch/common.h"
47

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

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

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

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

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

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

78
#include <linux/ctype.h>
79

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

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

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

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

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

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

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

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

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->core.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 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 evsel *evsel;
231
	struct annotation *notes;
232
	struct symbol *symbol;
233
	int more;
234

235
	if (!he)
236 237
		return;

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

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

	pthread_mutex_lock(&notes->lock);

245 246
	symbol__calc_percent(symbol, evsel);

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

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

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

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

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

275
	puts(CONSOLE_CLEAR);
276

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

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

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

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

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

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

310
	hists__output_recalc_col_len(hists, top->print_entries - printed);
311
	putchar('\n');
312
	hists__fprintf(hists, false, top->print_entries - printed, win_width,
313
		       top->min_percent, stdout, !symbol_conf.use_callchain);
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 349 350
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;
}

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

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

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

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

out_free:
	free(buf);
}

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

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

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

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

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

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

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

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

	return 0;
447 448
}

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

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

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

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

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

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

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

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

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

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

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

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

	return ret;
551 552
}

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

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

562
	hists = evsel__hists(evsel);
563

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

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

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

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

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

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

604 605
	prctl(PR_SET_NAME, "perf-top-UI", 0, 0, 0);

606
	perf_top__sort_new_samples(top);
607 608 609

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

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

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

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

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

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

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

656 657
	prctl(PR_SET_NAME, "perf-top-UI", 0, 0, 0);

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

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

			if (perf_top__handle_keypress(top, c))
				goto repeat;
685
			stop_top();
686 687
		}
	}
688

689
	tcsetattr(0, TCSAFLUSH, &save);
690 691 692
	return NULL;
}

693 694 695 696 697 698
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;
699
	struct evsel *evsel = iter->evsel;
700

701
	if (perf_hpp_list.sym && single)
702
		perf_top__record_precise_ip(top, he, iter->sample, evsel, al->addr);
703

704 705
	hist__account_cycles(iter->sample->branch_stack, al, iter->sample,
		     !(top->record_opts.branch_stack & PERF_SAMPLE_BRANCH_ANY));
706 707 708
	return 0;
}

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

719
	if (!machine && perf_guest) {
720 721 722
		static struct intlist *seen;

		if (!seen)
723
			seen = intlist__new(NULL);
724

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

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

739
	if (event->header.misc & PERF_RECORD_MISC_EXACT_IP)
740
		top->exact_samples++;
741

742
	if (machine__resolve(machine, &al, sample) < 0)
743
		return;
744

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

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

			if (use_browser <= 0)
				sleep(5);
788
			top->vmlinux_warned = true;
789
		}
790 791
	}

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

800 801 802 803
		if (symbol_conf.cumulate_callchain)
			iter.ops = &hist_iter_cumulative;
		else
			iter.ops = &hist_iter_normal;
804

805
		pthread_mutex_lock(&hists->lock);
806

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

811
		pthread_mutex_unlock(&hists->lock);
812
	}
813

814
	addr_location__put(&al);
815 816
}

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

840 841
static u64 last_timestamp;

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

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

853
	while ((event = perf_mmap__read_event(md)) != NULL) {
J
Jiri Olsa 已提交
854
		int ret;
855

856
		ret = perf_evlist__parse_sample_timestamp(evlist, event, &last_timestamp);
J
Jiri Olsa 已提交
857
		if (ret && ret != -1)
858 859
			break;

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

		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);
		}
872
	}
873 874

	perf_mmap__read_done(md);
875 876
}

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

883 884 885
	if (overwrite)
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_DATA_PENDING);

886 887
	for (i = 0; i < top->evlist->nr_mmaps; i++)
		perf_top__mmap_read_idx(top, i);
888 889 890 891 892

	if (overwrite) {
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_RUNNING);
	}
893 894
}

895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
/*
 * 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;
915
	struct evlist *evlist = top->evlist;
916 917
	struct perf_evsel_config_term *term;
	struct list_head *config_terms;
918
	struct evsel *evsel;
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 954 955 956
	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 已提交
957
static int perf_top_overwrite_fallback(struct perf_top *top,
958
				       struct evsel *evsel)
K
Kan Liang 已提交
959 960
{
	struct record_opts *opts = &top->record_opts;
961
	struct evlist *evlist = top->evlist;
962
	struct evsel *counter;
K
Kan Liang 已提交
963 964 965 966 967 968 969 970 971

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

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

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

991
	perf_evlist__config(evlist, opts, &callchain_param);
992

993
	evlist__for_each_entry(evlist, counter) {
994
try_again:
995
		if (evsel__open(counter, top->evlist->core.cpus,
996
				     top->evlist->core.threads) < 0) {
K
Kan Liang 已提交
997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011

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

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

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

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

1031
	return 0;
1032 1033

out_err:
1034
	return -1;
1035 1036
}

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

	return 0;
}

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

		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 已提交
1079 1080 1081 1082 1083 1084 1085 1086

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

	return NULL;
}

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

1114 1115 1116
	if (should_drop(qevent, top)) {
		top->drop++;
		top->drop_total++;
1117
		return 0;
1118
	}
1119

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

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

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

1206
	ret = callchain_param__setup_sample_type(&callchain_param);
1207
	if (ret)
1208
		return ret;
1209

1210
	if (perf_session__register_idle_thread(top->session) < 0)
1211
		return ret;
N
Namhyung Kim 已提交
1212

1213 1214
	if (top->nr_threads_synthesize > 1)
		perf_set_multithreaded();
1215

J
Jiri Olsa 已提交
1216 1217
	init_process_thread(top);

N
Namhyung Kim 已提交
1218 1219 1220
	if (opts->record_namespaces)
		top->tool.namespace_events = true;

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

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

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

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

1245 1246
	ret = perf_top__start_counters(top);
	if (ret)
1247
		return ret;
1248

1249
	top->session->evlist = top->evlist;
1250
	perf_session__set_id_hdr_size(top->session);
1251

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

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

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

1275
	if (top->realtime_prio) {
1276 1277
		struct sched_param param;

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

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

	perf_top__mmap_read(top);

1290
	while (!done) {
1291
		u64 hits = top->samples;
1292

1293
		perf_top__mmap_read(top);
1294

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

		if (resize) {
			perf_top__resize(top);
			resize = 0;
		}
1302 1303
	}

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

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

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

1325 1326
	callchain->enabled = !unset;
	callchain->record_mode = CALLCHAIN_FP;
1327 1328 1329 1330 1331 1332

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

	return parse_callchain_top_opt(arg);
1338
}
1339

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

1351
	return 0;
1352 1353
}

1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
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;
}

1364 1365
const char top_callchain_help[] = CALLCHAIN_RECORD_HELP CALLCHAIN_REPORT_HELP
	"\n\t\t\t\tDefault: fp,graph,0.5,caller,function";
1366

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

	if (status < 0)
		return status;
1526

1527 1528 1529
	top.annotation_opts.min_pcnt = 5;
	top.annotation_opts.context  = 4;

1530
	top.evlist = evlist__new();
1531
	if (top.evlist == NULL)
1532 1533
		return -ENOMEM;

1534 1535 1536
	status = perf_config(perf_top_config, &top);
	if (status)
		return status;
1537

1538 1539 1540 1541
	argc = parse_options(argc, argv, options, top_usage, 0);
	if (argc)
		usage_with_options(top_usage, options);

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

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

1561 1562 1563
	if (opts->branch_stack && callchain_param.enabled)
		symbol_conf.show_branchflag_count = true;

1564
	sort__mode = SORT_MODE__TOP;
1565
	/* display thread wants entries to be collapsed in a different tree */
1566
	perf_hpp_list.need_collapse = 1;
1567

1568 1569 1570 1571 1572 1573 1574
	if (top.use_stdio)
		use_browser = 0;
	else if (top.use_tui)
		use_browser = 1;

	setup_browser(false);

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

1584
	status = target__validate(target);
1585
	if (status) {
1586
		target__strerror(target, status, errbuf, BUFSIZ);
1587
		ui__warning("%s\n", errbuf);
1588 1589
	}

1590
	status = target__parse_uid(target);
1591 1592
	if (status) {
		int saved_errno = errno;
1593

1594
		target__strerror(target, status, errbuf, BUFSIZ);
1595
		ui__error("%s\n", errbuf);
1596 1597

		status = -saved_errno;
1598
		goto out_delete_evlist;
1599
	}
1600

1601
	if (target__none(target))
1602
		target->system_wide = true;
1603

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

1610 1611
	if (top.delay_secs < 1)
		top.delay_secs = 1;
1612

1613
	if (record_opts__config(opts)) {
1614
		status = -EINVAL;
1615
		goto out_delete_evlist;
1616 1617
	}

1618
	top.sym_evsel = perf_evlist__first(top.evlist);
1619

1620
	if (!callchain_param.enabled) {
N
Namhyung Kim 已提交
1621 1622 1623 1624
		symbol_conf.cumulate_callchain = false;
		perf_hpp__cancel_cumulate();
	}

1625 1626 1627
	if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
		callchain_param.order = ORDER_CALLER;

1628 1629 1630
	status = symbol__annotation_init();
	if (status < 0)
		goto out_delete_evlist;
1631

1632 1633
	annotation_config__init();

1634
	symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
1635 1636 1637
	status = symbol__init(NULL);
	if (status < 0)
		goto out_delete_evlist;
1638

1639
	sort__setup_elide(stdout);
1640

1641
	get_term_dimensions(&top.winsize);
1642
	if (top.print_entries == 0) {
1643
		perf_top__update_print_entries(&top);
1644
		signal(SIGWINCH, winch_sig);
1645 1646
	}

1647 1648 1649 1650 1651 1652
	top.session = perf_session__new(NULL, false, NULL);
	if (top.session == NULL) {
		status = -1;
		goto out_delete_evlist;
	}

1653 1654 1655
	if (!top.record_opts.no_bpf_event)
		bpf_event__add_sb_event(&sb_evlist, &perf_env);

1656 1657 1658 1659 1660
	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;
	}

1661
	status = __cmd_top(&top);
1662

1663 1664 1665
	if (!opts->no_bpf_event)
		perf_evlist__stop_sb_thread(sb_evlist);

1666
out_delete_evlist:
1667
	evlist__delete(top.evlist);
1668
	perf_session__delete(top.session);
1669 1670

	return status;
1671
}