builtin-top.c 43.8 KB
Newer Older
1
/*
2 3 4 5 6 7
 * builtin-top.c
 *
 * Builtin top command: Display a continuously updated profile of
 * any workload, CPU or specific PID.
 *
 * Copyright (C) 2008, Red Hat Inc, Ingo Molnar <mingo@redhat.com>
8
 *		 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
9 10 11 12 13 14 15 16 17 18
 *
 * Improvements and fixes by:
 *
 *   Arjan van de Ven <arjan@linux.intel.com>
 *   Yanmin Zhang <yanmin.zhang@intel.com>
 *   Wu Fengguang <fengguang.wu@intel.com>
 *   Mike Galbraith <efault@gmx.de>
 *   Paul Mackerras <paulus@samba.org>
 *
 * Released under the GPL v2. (and only v2, not any later version)
19
 */
20
#include "builtin.h"
21

22
#include "perf.h"
23

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

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

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

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

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

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

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

79 80
#include "sane_ctype.h"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

181 182 183
	map->erange_warned = true;
}

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

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

198 199 200
	notes = symbol__annotation(sym);

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

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

205
	pthread_mutex_unlock(&notes->lock);
206

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

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

234
	if (!he)
235 236
		return;

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

	pthread_mutex_lock(&notes->lock);

242 243
	symbol__calc_percent(symbol, evsel);

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

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

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

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

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

272
	puts(CONSOLE_CLEAR);
273

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

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

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

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

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

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

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

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

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

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

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

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

out_free:
	free(buf);
}

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

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

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

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

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

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

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

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

	return 0;
444 445
}

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

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

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

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

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

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

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

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

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

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

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

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

	return ret;
548 549
}

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

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

559
	hists = evsel__hists(evsel);
560

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

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

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

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

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

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

601
	perf_top__sort_new_samples(top);
602 603 604

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

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

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

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

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

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

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

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

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

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

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

686 687 688 689 690 691 692 693
static int hist_iter__top_callback(struct hist_entry_iter *iter,
				   struct addr_location *al, bool single,
				   void *arg)
{
	struct perf_top *top = arg;
	struct hist_entry *he = iter->he;
	struct perf_evsel *evsel = iter->evsel;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

798
		pthread_mutex_lock(&hists->lock);
799

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

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

807
	addr_location__put(&al);
808 809
}

810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
static void
perf_top__process_lost(struct perf_top *top, union perf_event *event,
		       struct perf_evsel *evsel)
{
	struct hists *hists = evsel__hists(evsel);

	top->lost += event->lost.lost;
	top->lost_total += event->lost.lost;
	hists->stats.total_lost += event->lost.lost;
}

static void
perf_top__process_lost_samples(struct perf_top *top,
			       union perf_event *event,
			       struct perf_evsel *evsel)
{
	struct hists *hists = evsel__hists(evsel);

	top->lost += event->lost_samples.lost;
	top->lost_total += event->lost_samples.lost;
	hists->stats.total_lost_samples += event->lost_samples.lost;
}

833 834
static u64 last_timestamp;

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

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

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

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

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

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

	perf_mmap__read_done(md);
868 869
}

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

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

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

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

888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
/*
 * Check per-event overwrite term.
 * perf top should support consistent term for all events.
 * - All events don't have per-event term
 *   E.g. "cpu/cpu-cycles/,cpu/instructions/"
 *   Nothing change, return 0.
 * - All events have same per-event term
 *   E.g. "cpu/cpu-cycles,no-overwrite/,cpu/instructions,no-overwrite/
 *   Using the per-event setting to replace the opts->overwrite if
 *   they are different, then return 0.
 * - Events have different per-event term
 *   E.g. "cpu/cpu-cycles,overwrite/,cpu/instructions,no-overwrite/"
 *   Return -1
 * - Some of the event set per-event term, but some not.
 *   E.g. "cpu/cpu-cycles/,cpu/instructions,no-overwrite/"
 *   Return -1
 */
static int perf_top__overwrite_check(struct perf_top *top)
{
	struct record_opts *opts = &top->record_opts;
	struct perf_evlist *evlist = top->evlist;
	struct perf_evsel_config_term *term;
	struct list_head *config_terms;
	struct perf_evsel *evsel;
	int set, overwrite = -1;

	evlist__for_each_entry(evlist, evsel) {
		set = -1;
		config_terms = &evsel->config_terms;
		list_for_each_entry(term, config_terms, list) {
			if (term->type == PERF_EVSEL__CONFIG_TERM_OVERWRITE)
				set = term->val.overwrite ? 1 : 0;
		}

		/* no term for current and previous event (likely) */
		if ((overwrite < 0) && (set < 0))
			continue;

		/* has term for both current and previous event, compare */
		if ((overwrite >= 0) && (set >= 0) && (overwrite != set))
			return -1;

		/* no term for current event but has term for previous one */
		if ((overwrite >= 0) && (set < 0))
			return -1;

		/* has term for current event */
		if ((overwrite < 0) && (set >= 0)) {
			/* if it's first event, set overwrite */
			if (evsel == perf_evlist__first(evlist))
				overwrite = set;
			else
				return -1;
		}
	}

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

	return 0;
}

K
Kan Liang 已提交
950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
static int perf_top_overwrite_fallback(struct perf_top *top,
				       struct perf_evsel *evsel)
{
	struct record_opts *opts = &top->record_opts;
	struct perf_evlist *evlist = top->evlist;
	struct perf_evsel *counter;

	if (!opts->overwrite)
		return 0;

	/* only fall back when first event fails */
	if (evsel != perf_evlist__first(evlist))
		return 0;

	evlist__for_each_entry(evlist, counter)
		counter->attr.write_backward = false;
	opts->overwrite = false;
967
	pr_debug2("fall back to non-overwrite mode\n");
K
Kan Liang 已提交
968 969 970
	return 1;
}

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

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

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

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

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

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

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

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

1024
	return 0;
1025 1026

out_err:
1027
	return -1;
1028 1029
}

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

	return 0;
}

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

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

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

	return NULL;
}

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

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

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

1186
static int __cmd_top(struct perf_top *top)
1187
{
1188
	struct record_opts *opts = &top->record_opts;
J
Jiri Olsa 已提交
1189
	pthread_t thread, thread_process;
1190
	int ret;
1191

1192 1193 1194
	if (!top->annotation_opts.objdump_path) {
		ret = perf_env__lookup_objdump(&top->session->header.env,
					       &top->annotation_opts.objdump_path);
1195
		if (ret)
1196
			return ret;
1197 1198
	}

1199
	ret = callchain_param__setup_sample_type(&callchain_param);
1200
	if (ret)
1201
		return ret;
1202

1203
	if (perf_session__register_idle_thread(top->session) < 0)
1204
		return ret;
N
Namhyung Kim 已提交
1205

1206 1207
	if (top->nr_threads_synthesize > 1)
		perf_set_multithreaded();
1208

J
Jiri Olsa 已提交
1209 1210
	init_process_thread(top);

1211
	ret = perf_event__synthesize_bpf_events(top->session, perf_event__process,
1212 1213 1214 1215 1216
						&top->session->machines.host,
						&top->record_opts);
	if (ret < 0)
		pr_warning("Couldn't synthesize bpf events.\n");

1217
	machine__synthesize_threads(&top->session->machines.host, &opts->target,
1218
				    top->evlist->threads, false,
1219
				    top->nr_threads_synthesize);
1220

1221 1222
	if (top->nr_threads_synthesize > 1)
		perf_set_singlethreaded();
1223

1224
	if (perf_hpp_list.socket) {
1225
		ret = perf_env__read_cpu_topology_map(&perf_env);
1226 1227 1228 1229 1230 1231 1232
		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;
		}
1233 1234
	}

1235 1236
	ret = perf_top__start_counters(top);
	if (ret)
1237
		return ret;
1238

1239
	top->session->evlist = top->evlist;
1240
	perf_session__set_id_hdr_size(top->session);
1241

1242 1243 1244 1245 1246 1247 1248 1249
	/*
	 * 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.
	 */
1250
        if (!target__none(&opts->target))
1251 1252
                perf_evlist__enable(top->evlist);

1253
	ret = -1;
J
Jiri Olsa 已提交
1254 1255
	if (pthread_create(&thread_process, NULL, process_thread, top)) {
		ui__error("Could not create process thread.\n");
1256
		return ret;
J
Jiri Olsa 已提交
1257 1258
	}

1259
	if (pthread_create(&thread, NULL, (use_browser > 0 ? display_thread_tui :
1260
							    display_thread), top)) {
1261
		ui__error("Could not create display thread.\n");
J
Jiri Olsa 已提交
1262
		goto out_join_thread;
1263 1264
	}

1265
	if (top->realtime_prio) {
1266 1267
		struct sched_param param;

1268
		param.sched_priority = top->realtime_prio;
1269
		if (sched_setscheduler(0, SCHED_FIFO, &param)) {
1270
			ui__error("Could not set realtime priority.\n");
1271
			goto out_join;
1272 1273 1274
		}
	}

1275 1276 1277 1278 1279
	/* Wait for a minimal set of events before starting the snapshot */
	perf_evlist__poll(top->evlist, 100);

	perf_top__mmap_read(top);

1280
	while (!done) {
1281
		u64 hits = top->samples;
1282

1283
		perf_top__mmap_read(top);
1284

1285
		if (opts->overwrite || (hits == top->samples))
1286
			ret = perf_evlist__poll(top->evlist, 100);
1287 1288 1289 1290 1291

		if (resize) {
			perf_top__resize(top);
			resize = 0;
		}
1292 1293
	}

1294
	ret = 0;
1295 1296
out_join:
	pthread_join(thread, NULL);
J
Jiri Olsa 已提交
1297
out_join_thread:
1298
	pthread_cond_signal(&top->qe.cond);
J
Jiri Olsa 已提交
1299
	pthread_join(thread_process, NULL);
1300
	return ret;
1301 1302 1303
}

static int
J
Jiri Olsa 已提交
1304
callchain_opt(const struct option *opt, const char *arg, int unset)
1305 1306
{
	symbol_conf.use_callchain = true;
J
Jiri Olsa 已提交
1307 1308
	return record_callchain_opt(opt, arg, unset);
}
1309

J
Jiri Olsa 已提交
1310 1311 1312
static int
parse_callchain_opt(const struct option *opt, const char *arg, int unset)
{
1313
	struct callchain_param *callchain = opt->value;
1314

1315 1316
	callchain->enabled = !unset;
	callchain->record_mode = CALLCHAIN_FP;
1317 1318 1319 1320 1321 1322

	/*
	 * --no-call-graph
	 */
	if (unset) {
		symbol_conf.use_callchain = false;
1323
		callchain->record_mode = CALLCHAIN_NONE;
1324 1325 1326 1327
		return 0;
	}

	return parse_callchain_top_opt(arg);
1328
}
1329

1330
static int perf_top_config(const char *var, const char *value, void *cb __maybe_unused)
1331
{
1332 1333 1334 1335
	if (!strcmp(var, "top.call-graph")) {
		var = "call-graph.record-mode";
		return perf_default_config(var, value, cb);
	}
1336 1337 1338 1339
	if (!strcmp(var, "top.children")) {
		symbol_conf.cumulate_callchain = perf_config_bool(var, value);
		return 0;
	}
1340

1341
	return 0;
1342 1343
}

1344 1345 1346 1347 1348 1349 1350 1351 1352 1353
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;
}

1354 1355
const char top_callchain_help[] = CALLCHAIN_RECORD_HELP CALLCHAIN_REPORT_HELP
	"\n\t\t\t\tDefault: fp,graph,0.5,caller,function";
1356

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

	if (status < 0)
		return status;
1513

1514 1515 1516
	top.annotation_opts.min_pcnt = 5;
	top.annotation_opts.context  = 4;

1517
	top.evlist = perf_evlist__new();
1518
	if (top.evlist == NULL)
1519 1520
		return -ENOMEM;

1521 1522 1523
	status = perf_config(perf_top_config, &top);
	if (status)
		return status;
1524

1525 1526 1527 1528
	argc = parse_options(argc, argv, options, top_usage, 0);
	if (argc)
		usage_with_options(top_usage, options);

1529 1530 1531 1532 1533 1534
	if (!top.evlist->nr_entries &&
	    perf_evlist__add_default(top.evlist) < 0) {
		pr_err("Not enough memory for event selector list\n");
		goto out_delete_evlist;
	}

N
Namhyung Kim 已提交
1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
	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;
		}
	}

1548 1549 1550
	if (opts->branch_stack && callchain_param.enabled)
		symbol_conf.show_branchflag_count = true;

1551
	sort__mode = SORT_MODE__TOP;
1552
	/* display thread wants entries to be collapsed in a different tree */
1553
	perf_hpp_list.need_collapse = 1;
1554

1555 1556 1557 1558 1559 1560 1561
	if (top.use_stdio)
		use_browser = 0;
	else if (top.use_tui)
		use_browser = 1;

	setup_browser(false);

1562
	if (setup_sorting(top.evlist) < 0) {
1563 1564 1565 1566 1567
		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);
1568 1569
		goto out_delete_evlist;
	}
1570

1571
	status = target__validate(target);
1572
	if (status) {
1573
		target__strerror(target, status, errbuf, BUFSIZ);
1574
		ui__warning("%s\n", errbuf);
1575 1576
	}

1577
	status = target__parse_uid(target);
1578 1579
	if (status) {
		int saved_errno = errno;
1580

1581
		target__strerror(target, status, errbuf, BUFSIZ);
1582
		ui__error("%s\n", errbuf);
1583 1584

		status = -saved_errno;
1585
		goto out_delete_evlist;
1586
	}
1587

1588
	if (target__none(target))
1589
		target->system_wide = true;
1590

1591 1592
	if (perf_evlist__create_maps(top.evlist, target) < 0) {
		ui__error("Couldn't create thread/CPU maps: %s\n",
1593
			  errno == ENOENT ? "No such process" : str_error_r(errno, errbuf, sizeof(errbuf)));
1594
		goto out_delete_evlist;
1595
	}
1596

1597 1598
	if (top.delay_secs < 1)
		top.delay_secs = 1;
1599

1600
	if (record_opts__config(opts)) {
1601
		status = -EINVAL;
1602
		goto out_delete_evlist;
1603 1604
	}

1605
	top.sym_evsel = perf_evlist__first(top.evlist);
1606

1607
	if (!callchain_param.enabled) {
N
Namhyung Kim 已提交
1608 1609 1610 1611
		symbol_conf.cumulate_callchain = false;
		perf_hpp__cancel_cumulate();
	}

1612 1613 1614
	if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
		callchain_param.order = ORDER_CALLER;

1615 1616 1617
	status = symbol__annotation_init();
	if (status < 0)
		goto out_delete_evlist;
1618

1619 1620
	annotation_config__init();

1621
	symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
1622 1623 1624
	status = symbol__init(NULL);
	if (status < 0)
		goto out_delete_evlist;
1625

1626
	sort__setup_elide(stdout);
1627

1628
	get_term_dimensions(&top.winsize);
1629
	if (top.print_entries == 0) {
1630
		perf_top__update_print_entries(&top);
1631
		signal(SIGWINCH, winch_sig);
1632 1633
	}

1634 1635 1636 1637 1638 1639
	top.session = perf_session__new(NULL, false, NULL);
	if (top.session == NULL) {
		status = -1;
		goto out_delete_evlist;
	}

1640 1641 1642 1643 1644
	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;
	}

1645
	status = __cmd_top(&top);
1646

1647 1648 1649
	if (!opts->no_bpf_event)
		perf_evlist__stop_sb_thread(sb_evlist);

1650
out_delete_evlist:
1651
	perf_evlist__delete(top.evlist);
1652
	perf_session__delete(top.session);
1653 1654

	return status;
1655
}