builtin-top.c 44.5 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 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
static void evlist__resort_hists(struct evlist *evlist)
{
	struct evsel *pos;

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

		hists__collapse_resort(hists, NULL);

		/* Non-group events are considered as leader */
		if (symbol_conf.event_group &&
		    !perf_evsel__is_group_leader(pos)) {
			struct hists *leader_hists = evsel__hists(pos->leader);

			hists__match(leader_hists, hists);
			hists__link(leader_hists, hists);
		}
	}

	evlist__for_each_entry(evlist, pos) {
		perf_evsel__output_resort(pos, NULL);
	}
}

291
static void perf_top__print_sym_table(struct perf_top *top)
292
{
293 294
	char bf[160];
	int printed = 0;
295
	const int win_width = top->winsize.ws_col - 1;
296
	struct evsel *evsel = top->sym_evsel;
297
	struct hists *hists = evsel__hists(evsel);
298

299
	puts(CONSOLE_CLEAR);
300

301
	perf_top__header_snprintf(top, bf, sizeof(bf));
302
	printf("%s\n", bf);
303

304
	printf("%-*.*s\n", win_width, win_width, graph_dotted_line);
305

306 307 308
	if (!top->record_opts.overwrite &&
	    (hists->stats.nr_lost_warned !=
	    hists->stats.nr_events[PERF_RECORD_LOST])) {
309 310
		hists->stats.nr_lost_warned =
			      hists->stats.nr_events[PERF_RECORD_LOST];
311 312
		color_fprintf(stdout, PERF_COLOR_RED,
			      "WARNING: LOST %d chunks, Check IO/CPU overload",
313
			      hists->stats.nr_lost_warned);
314
		++printed;
315 316
	}

317 318
	if (top->sym_filter_entry) {
		perf_top__show_details(top);
319 320 321
		return;
	}

322 323 324 325 326 327 328
	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 已提交
329 330
	}

331
	evlist__resort_hists(top->evlist);
N
Namhyung Kim 已提交
332

333
	hists__output_recalc_col_len(hists, top->print_entries - printed);
334
	putchar('\n');
335
	hists__fprintf(hists, false, top->print_entries - printed, win_width,
336
		       top->min_percent, stdout, !symbol_conf.use_callchain);
337 338
}

339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
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;
}

374
static void perf_top__prompt_symbol(struct perf_top *top, const char *msg)
375 376
{
	char *buf = malloc(0), *p;
377
	struct hist_entry *syme = top->sym_filter_entry, *n, *found = NULL;
378
	struct hists *hists = evsel__hists(top->sym_evsel);
379
	struct rb_node *next;
380 381 382 383 384
	size_t dummy = 0;

	/* zero counters of active symbol */
	if (syme) {
		__zero_source_counters(syme);
385
		top->sym_filter_entry = NULL;
386 387 388 389 390 391 392 393 394 395
	}

	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 已提交
396
	next = rb_first_cached(&hists->entries);
397 398 399 400
	while (next) {
		n = rb_entry(next, struct hist_entry, rb_node);
		if (n->ms.sym && !strcmp(buf, n->ms.sym->name)) {
			found = n;
401 402
			break;
		}
403
		next = rb_next(&n->rb_node);
404 405 406
	}

	if (!found) {
407
		fprintf(stderr, "Sorry, %s is not active.\n", buf);
408 409
		sleep(1);
	} else
410
		perf_top__parse_source(top, found);
411 412 413 414 415

out_free:
	free(buf);
}

416
static void perf_top__print_mapped_keys(struct perf_top *top)
417
{
418 419
	char *name = NULL;

420 421
	if (top->sym_filter_entry) {
		struct symbol *sym = top->sym_filter_entry->ms.sym;
422 423 424 425
		name = sym->name;
	}

	fprintf(stdout, "\nMapped keys:\n");
426 427
	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);
428

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

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

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

438
	fprintf(stdout,
S
Sihyeon Jang 已提交
439
		"\t[K]     hide kernel symbols.             \t(%s)\n",
440
		top->hide_kernel_symbols ? "yes" : "no");
441 442
	fprintf(stdout,
		"\t[U]     hide user symbols.               \t(%s)\n",
443 444
		top->hide_user_symbols ? "yes" : "no");
	fprintf(stdout, "\t[z]     toggle sample zeroing.             \t(%d)\n", top->zero ? 1 : 0);
445 446 447
	fprintf(stdout, "\t[qQ]    quit.\n");
}

448
static int perf_top__key_mapped(struct perf_top *top, int c)
449 450 451 452 453 454 455 456
{
	switch (c) {
		case 'd':
		case 'e':
		case 'f':
		case 'z':
		case 'q':
		case 'Q':
457 458
		case 'K':
		case 'U':
459 460 461
		case 'F':
		case 's':
		case 'S':
462 463
			return 1;
		case 'E':
464
			return top->evlist->core.nr_entries > 1 ? 1 : 0;
465 466
		default:
			break;
467 468 469
	}

	return 0;
470 471
}

472
static bool perf_top__handle_keypress(struct perf_top *top, int c)
473
{
474 475
	bool ret = true;

476
	if (!perf_top__key_mapped(top, c)) {
477
		struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
478
		struct termios save;
479

480
		perf_top__print_mapped_keys(top);
481 482 483
		fprintf(stdout, "\nEnter selection, or unmapped key to continue: ");
		fflush(stdout);

484
		set_term_quiet_input(&save);
485 486 487 488 489

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

		tcsetattr(0, TCSAFLUSH, &save);
490
		if (!perf_top__key_mapped(top, c))
491
			return ret;
492 493
	}

494 495
	switch (c) {
		case 'd':
496 497 498
			prompt_integer(&top->delay_secs, "Enter display delay");
			if (top->delay_secs < 1)
				top->delay_secs = 1;
499 500
			break;
		case 'e':
501 502
			prompt_integer(&top->print_entries, "Enter display entries (lines)");
			if (top->print_entries == 0) {
503
				perf_top__resize(top);
504
				signal(SIGWINCH, winch_sig);
505
			} else {
506
				signal(SIGWINCH, SIG_DFL);
507
			}
508 509
			break;
		case 'E':
510
			if (top->evlist->core.nr_entries > 1) {
511 512 513
				/* Select 0 as the default event: */
				int counter = 0;

514
				fprintf(stderr, "\nAvailable events:");
515

516
				evlist__for_each_entry(top->evlist, top->sym_evsel)
517
					fprintf(stderr, "\n\t%d %s", top->sym_evsel->idx, perf_evsel__name(top->sym_evsel));
518

519
				prompt_integer(&counter, "Enter details event counter");
520

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

559
				top->sym_filter_entry = NULL;
560 561 562
				__zero_source_counters(syme);
			}
			break;
563
		case 'U':
564
			top->hide_user_symbols = !top->hide_user_symbols;
565
			break;
566
		case 'z':
567
			top->zero = !top->zero;
568
			break;
569 570
		default:
			break;
571
	}
572 573

	return ret;
574 575
}

576 577 578
static void perf_top__sort_new_samples(void *arg)
{
	struct perf_top *t = arg;
579
	struct evsel *evsel = t->sym_evsel;
580 581
	struct hists *hists;

582 583 584
	if (t->evlist->selected != NULL)
		t->sym_evsel = t->evlist->selected;

585
	hists = evsel__hists(evsel);
586

587 588 589 590 591 592 593
	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 已提交
594 595
	}

596
	evlist__resort_hists(t->evlist);
597

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

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

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

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

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

628
	perf_top__sort_new_samples(top);
629 630 631

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

		if (!seen)
745
			seen = intlist__new(NULL);
746

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

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

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

764
	if (machine__resolve(machine, &al, sample) < 0)
765
		return;
766

767
	if (!machine->kptr_restrict_warned &&
768 769
	    symbol_conf.kptr_restrict &&
	    al.cpumode == PERF_RECORD_MISC_KERNEL) {
770 771
		if (!perf_evlist__exclude_kernel(top->session->evlist)) {
			ui__warning(
772 773 774
"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",
775
			  al.map && map__has_symbols(al.map) ?
776
			  " modules" : "");
777 778 779
			if (use_browser <= 0)
				sleep(5);
		}
780
		machine->kptr_restrict_warned = true;
781 782
	}

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

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

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

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

827
		pthread_mutex_lock(&hists->lock);
828

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

833
		pthread_mutex_unlock(&hists->lock);
834
	}
835

836
	addr_location__put(&al);
837 838
}

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

862 863
static u64 last_timestamp;

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

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

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

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

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

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

	perf_mmap__read_done(md);
897 898
}

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

905 906 907
	if (overwrite)
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_DATA_PENDING);

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

	if (overwrite) {
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_EMPTY);
		perf_evlist__toggle_bkw_mmap(evlist, BKW_MMAP_RUNNING);
	}
915 916
}

917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936
/*
 * 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;
937
	struct evlist *evlist = top->evlist;
938 939
	struct perf_evsel_config_term *term;
	struct list_head *config_terms;
940
	struct evsel *evsel;
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
	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 已提交
979
static int perf_top_overwrite_fallback(struct perf_top *top,
980
				       struct evsel *evsel)
K
Kan Liang 已提交
981 982
{
	struct record_opts *opts = &top->record_opts;
983
	struct evlist *evlist = top->evlist;
984
	struct evsel *counter;
K
Kan Liang 已提交
985 986 987 988 989 990 991 992 993

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

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

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

1013
	perf_evlist__config(evlist, opts, &callchain_param);
1014

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

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

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

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

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

1053
	return 0;
1054 1055

out_err:
1056
	return -1;
1057 1058
}

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

	return 0;
}

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

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

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

	return NULL;
}

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

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

J
Jiri Olsa 已提交
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 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210
	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];
1211 1212
	pthread_mutex_init(&top->qe.mutex, NULL);
	pthread_cond_init(&top->qe.cond, NULL);
J
Jiri Olsa 已提交
1213 1214
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

	perf_top__mmap_read(top);

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

1315
		perf_top__mmap_read(top);
1316

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

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

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

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

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

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

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

	return parse_callchain_top_opt(arg);
1360
}
1361

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

1373
	return 0;
1374 1375
}

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

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

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

	if (status < 0)
		return status;
1548

1549 1550 1551
	top.annotation_opts.min_pcnt = 5;
	top.annotation_opts.context  = 4;

1552
	top.evlist = evlist__new();
1553
	if (top.evlist == NULL)
1554 1555
		return -ENOMEM;

1556 1557 1558
	status = perf_config(perf_top_config, &top);
	if (status)
		return status;
1559

1560 1561 1562 1563
	argc = parse_options(argc, argv, options, top_usage, 0);
	if (argc)
		usage_with_options(top_usage, options);

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

N
Namhyung Kim 已提交
1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
	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;
		}
	}

1583 1584 1585
	if (opts->branch_stack && callchain_param.enabled)
		symbol_conf.show_branchflag_count = true;

1586
	sort__mode = SORT_MODE__TOP;
1587
	/* display thread wants entries to be collapsed in a different tree */
1588
	perf_hpp_list.need_collapse = 1;
1589

1590 1591 1592 1593 1594 1595 1596
	if (top.use_stdio)
		use_browser = 0;
	else if (top.use_tui)
		use_browser = 1;

	setup_browser(false);

1597
	if (setup_sorting(top.evlist) < 0) {
1598 1599 1600 1601 1602
		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);
1603 1604
		goto out_delete_evlist;
	}
1605

1606
	status = target__validate(target);
1607
	if (status) {
1608
		target__strerror(target, status, errbuf, BUFSIZ);
1609
		ui__warning("%s\n", errbuf);
1610 1611
	}

1612
	status = target__parse_uid(target);
1613 1614
	if (status) {
		int saved_errno = errno;
1615

1616
		target__strerror(target, status, errbuf, BUFSIZ);
1617
		ui__error("%s\n", errbuf);
1618 1619

		status = -saved_errno;
1620
		goto out_delete_evlist;
1621
	}
1622

1623
	if (target__none(target))
1624
		target->system_wide = true;
1625

1626 1627
	if (perf_evlist__create_maps(top.evlist, target) < 0) {
		ui__error("Couldn't create thread/CPU maps: %s\n",
1628
			  errno == ENOENT ? "No such process" : str_error_r(errno, errbuf, sizeof(errbuf)));
1629
		goto out_delete_evlist;
1630
	}
1631

1632 1633
	if (top.delay_secs < 1)
		top.delay_secs = 1;
1634

1635
	if (record_opts__config(opts)) {
1636
		status = -EINVAL;
1637
		goto out_delete_evlist;
1638 1639
	}

1640
	top.sym_evsel = perf_evlist__first(top.evlist);
1641

1642
	if (!callchain_param.enabled) {
N
Namhyung Kim 已提交
1643 1644 1645 1646
		symbol_conf.cumulate_callchain = false;
		perf_hpp__cancel_cumulate();
	}

1647 1648 1649
	if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
		callchain_param.order = ORDER_CALLER;

1650 1651 1652
	status = symbol__annotation_init();
	if (status < 0)
		goto out_delete_evlist;
1653

1654 1655
	annotation_config__init();

1656
	symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
1657 1658 1659
	status = symbol__init(NULL);
	if (status < 0)
		goto out_delete_evlist;
1660

1661
	sort__setup_elide(stdout);
1662

1663
	get_term_dimensions(&top.winsize);
1664
	if (top.print_entries == 0) {
1665
		perf_top__update_print_entries(&top);
1666
		signal(SIGWINCH, winch_sig);
1667 1668
	}

1669 1670 1671 1672 1673 1674
	top.session = perf_session__new(NULL, false, NULL);
	if (top.session == NULL) {
		status = -1;
		goto out_delete_evlist;
	}

1675 1676 1677
	if (!top.record_opts.no_bpf_event)
		bpf_event__add_sb_event(&sb_evlist, &perf_env);

1678 1679 1680 1681 1682
	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;
	}

1683
	status = __cmd_top(&top);
1684

1685 1686 1687
	if (!opts->no_bpf_event)
		perf_evlist__stop_sb_thread(sb_evlist);

1688
out_delete_evlist:
1689
	evlist__delete(top.evlist);
1690
	perf_session__delete(top.session);
1691 1692

	return status;
1693
}