Loading...
1/*
2 * builtin-top.c
3 *
4 * Builtin top command: Display a continuously updated profile of
5 * any workload, CPU or specific PID.
6 *
7 * 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 * Improvements and fixes by:
11 *
12 * Arjan van de Ven <arjan@linux.intel.com>
13 * Yanmin Zhang <yanmin.zhang@intel.com>
14 * Wu Fengguang <fengguang.wu@intel.com>
15 * Mike Galbraith <efault@gmx.de>
16 * Paul Mackerras <paulus@samba.org>
17 *
18 * 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/cache.h"
26#include "util/color.h"
27#include "util/evlist.h"
28#include "util/evsel.h"
29#include "util/session.h"
30#include "util/symbol.h"
31#include "util/thread.h"
32#include "util/thread_map.h"
33#include "util/top.h"
34#include "util/util.h"
35#include <linux/rbtree.h>
36#include "util/parse-options.h"
37#include "util/parse-events.h"
38#include "util/cpumap.h"
39#include "util/xyarray.h"
40#include "util/sort.h"
41
42#include "util/debug.h"
43
44#include <assert.h>
45#include <elf.h>
46#include <fcntl.h>
47
48#include <stdio.h>
49#include <termios.h>
50#include <unistd.h>
51#include <inttypes.h>
52
53#include <errno.h>
54#include <time.h>
55#include <sched.h>
56
57#include <sys/syscall.h>
58#include <sys/ioctl.h>
59#include <sys/poll.h>
60#include <sys/prctl.h>
61#include <sys/wait.h>
62#include <sys/uio.h>
63#include <sys/utsname.h>
64#include <sys/mman.h>
65
66#include <linux/unistd.h>
67#include <linux/types.h>
68
69void get_term_dimensions(struct winsize *ws)
70{
71 char *s = getenv("LINES");
72
73 if (s != NULL) {
74 ws->ws_row = atoi(s);
75 s = getenv("COLUMNS");
76 if (s != NULL) {
77 ws->ws_col = atoi(s);
78 if (ws->ws_row && ws->ws_col)
79 return;
80 }
81 }
82#ifdef TIOCGWINSZ
83 if (ioctl(1, TIOCGWINSZ, ws) == 0 &&
84 ws->ws_row && ws->ws_col)
85 return;
86#endif
87 ws->ws_row = 25;
88 ws->ws_col = 80;
89}
90
91static void perf_top__update_print_entries(struct perf_top *top)
92{
93 if (top->print_entries > 9)
94 top->print_entries -= 9;
95}
96
97static void perf_top__sig_winch(int sig __used, siginfo_t *info __used, void *arg)
98{
99 struct perf_top *top = arg;
100
101 get_term_dimensions(&top->winsize);
102 if (!top->print_entries
103 || (top->print_entries+4) > top->winsize.ws_row) {
104 top->print_entries = top->winsize.ws_row;
105 } else {
106 top->print_entries += 4;
107 top->winsize.ws_row = top->print_entries;
108 }
109 perf_top__update_print_entries(top);
110}
111
112static int perf_top__parse_source(struct perf_top *top, struct hist_entry *he)
113{
114 struct symbol *sym;
115 struct annotation *notes;
116 struct map *map;
117 int err = -1;
118
119 if (!he || !he->ms.sym)
120 return -1;
121
122 sym = he->ms.sym;
123 map = he->ms.map;
124
125 /*
126 * We can't annotate with just /proc/kallsyms
127 */
128 if (map->dso->symtab_type == SYMTAB__KALLSYMS) {
129 pr_err("Can't annotate %s: No vmlinux file was found in the "
130 "path\n", sym->name);
131 sleep(1);
132 return -1;
133 }
134
135 notes = symbol__annotation(sym);
136 if (notes->src != NULL) {
137 pthread_mutex_lock(¬es->lock);
138 goto out_assign;
139 }
140
141 pthread_mutex_lock(¬es->lock);
142
143 if (symbol__alloc_hist(sym) < 0) {
144 pthread_mutex_unlock(¬es->lock);
145 pr_err("Not enough memory for annotating '%s' symbol!\n",
146 sym->name);
147 sleep(1);
148 return err;
149 }
150
151 err = symbol__annotate(sym, map, 0);
152 if (err == 0) {
153out_assign:
154 top->sym_filter_entry = he;
155 }
156
157 pthread_mutex_unlock(¬es->lock);
158 return err;
159}
160
161static void __zero_source_counters(struct hist_entry *he)
162{
163 struct symbol *sym = he->ms.sym;
164 symbol__annotate_zero_histograms(sym);
165}
166
167static void ui__warn_map_erange(struct map *map, struct symbol *sym, u64 ip)
168{
169 struct utsname uts;
170 int err = uname(&uts);
171
172 ui__warning("Out of bounds address found:\n\n"
173 "Addr: %" PRIx64 "\n"
174 "DSO: %s %c\n"
175 "Map: %" PRIx64 "-%" PRIx64 "\n"
176 "Symbol: %" PRIx64 "-%" PRIx64 " %c %s\n"
177 "Arch: %s\n"
178 "Kernel: %s\n"
179 "Tools: %s\n\n"
180 "Not all samples will be on the annotation output.\n\n"
181 "Please report to linux-kernel@vger.kernel.org\n",
182 ip, map->dso->long_name, dso__symtab_origin(map->dso),
183 map->start, map->end, sym->start, sym->end,
184 sym->binding == STB_GLOBAL ? 'g' :
185 sym->binding == STB_LOCAL ? 'l' : 'w', sym->name,
186 err ? "[unknown]" : uts.machine,
187 err ? "[unknown]" : uts.release, perf_version_string);
188 if (use_browser <= 0)
189 sleep(5);
190
191 map->erange_warned = true;
192}
193
194static void perf_top__record_precise_ip(struct perf_top *top,
195 struct hist_entry *he,
196 int counter, u64 ip)
197{
198 struct annotation *notes;
199 struct symbol *sym;
200 int err;
201
202 if (he == NULL || he->ms.sym == NULL ||
203 ((top->sym_filter_entry == NULL ||
204 top->sym_filter_entry->ms.sym != he->ms.sym) && use_browser != 1))
205 return;
206
207 sym = he->ms.sym;
208 notes = symbol__annotation(sym);
209
210 if (pthread_mutex_trylock(¬es->lock))
211 return;
212
213 if (notes->src == NULL && symbol__alloc_hist(sym) < 0) {
214 pthread_mutex_unlock(¬es->lock);
215 pr_err("Not enough memory for annotating '%s' symbol!\n",
216 sym->name);
217 sleep(1);
218 return;
219 }
220
221 ip = he->ms.map->map_ip(he->ms.map, ip);
222 err = symbol__inc_addr_samples(sym, he->ms.map, counter, ip);
223
224 pthread_mutex_unlock(¬es->lock);
225
226 if (err == -ERANGE && !he->ms.map->erange_warned)
227 ui__warn_map_erange(he->ms.map, sym, ip);
228}
229
230static void perf_top__show_details(struct perf_top *top)
231{
232 struct hist_entry *he = top->sym_filter_entry;
233 struct annotation *notes;
234 struct symbol *symbol;
235 int more;
236
237 if (!he)
238 return;
239
240 symbol = he->ms.sym;
241 notes = symbol__annotation(symbol);
242
243 pthread_mutex_lock(¬es->lock);
244
245 if (notes->src == NULL)
246 goto out_unlock;
247
248 printf("Showing %s for %s\n", event_name(top->sym_evsel), symbol->name);
249 printf(" Events Pcnt (>=%d%%)\n", top->sym_pcnt_filter);
250
251 more = symbol__annotate_printf(symbol, he->ms.map, top->sym_evsel->idx,
252 0, top->sym_pcnt_filter, top->print_entries, 4);
253 if (top->zero)
254 symbol__annotate_zero_histogram(symbol, top->sym_evsel->idx);
255 else
256 symbol__annotate_decay_histogram(symbol, top->sym_evsel->idx);
257 if (more != 0)
258 printf("%d lines not displayed, maybe increase display entries [e]\n", more);
259out_unlock:
260 pthread_mutex_unlock(¬es->lock);
261}
262
263static const char CONSOLE_CLEAR[] = "[H[2J";
264
265static struct hist_entry *perf_evsel__add_hist_entry(struct perf_evsel *evsel,
266 struct addr_location *al,
267 struct perf_sample *sample)
268{
269 struct hist_entry *he;
270
271 he = __hists__add_entry(&evsel->hists, al, NULL, sample->period);
272 if (he == NULL)
273 return NULL;
274
275 hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE);
276 return he;
277}
278
279static void perf_top__print_sym_table(struct perf_top *top)
280{
281 char bf[160];
282 int printed = 0;
283 const int win_width = top->winsize.ws_col - 1;
284
285 puts(CONSOLE_CLEAR);
286
287 perf_top__header_snprintf(top, bf, sizeof(bf));
288 printf("%s\n", bf);
289
290 perf_top__reset_sample_counters(top);
291
292 printf("%-*.*s\n", win_width, win_width, graph_dotted_line);
293
294 if (top->sym_evsel->hists.stats.nr_lost_warned !=
295 top->sym_evsel->hists.stats.nr_events[PERF_RECORD_LOST]) {
296 top->sym_evsel->hists.stats.nr_lost_warned =
297 top->sym_evsel->hists.stats.nr_events[PERF_RECORD_LOST];
298 color_fprintf(stdout, PERF_COLOR_RED,
299 "WARNING: LOST %d chunks, Check IO/CPU overload",
300 top->sym_evsel->hists.stats.nr_lost_warned);
301 ++printed;
302 }
303
304 if (top->sym_filter_entry) {
305 perf_top__show_details(top);
306 return;
307 }
308
309 hists__collapse_resort_threaded(&top->sym_evsel->hists);
310 hists__output_resort_threaded(&top->sym_evsel->hists);
311 hists__decay_entries_threaded(&top->sym_evsel->hists,
312 top->hide_user_symbols,
313 top->hide_kernel_symbols);
314 hists__output_recalc_col_len(&top->sym_evsel->hists,
315 top->winsize.ws_row - 3);
316 putchar('\n');
317 hists__fprintf(&top->sym_evsel->hists, NULL, false, false,
318 top->winsize.ws_row - 4 - printed, win_width, stdout);
319}
320
321static void prompt_integer(int *target, const char *msg)
322{
323 char *buf = malloc(0), *p;
324 size_t dummy = 0;
325 int tmp;
326
327 fprintf(stdout, "\n%s: ", msg);
328 if (getline(&buf, &dummy, stdin) < 0)
329 return;
330
331 p = strchr(buf, '\n');
332 if (p)
333 *p = 0;
334
335 p = buf;
336 while(*p) {
337 if (!isdigit(*p))
338 goto out_free;
339 p++;
340 }
341 tmp = strtoul(buf, NULL, 10);
342 *target = tmp;
343out_free:
344 free(buf);
345}
346
347static void prompt_percent(int *target, const char *msg)
348{
349 int tmp = 0;
350
351 prompt_integer(&tmp, msg);
352 if (tmp >= 0 && tmp <= 100)
353 *target = tmp;
354}
355
356static void perf_top__prompt_symbol(struct perf_top *top, const char *msg)
357{
358 char *buf = malloc(0), *p;
359 struct hist_entry *syme = top->sym_filter_entry, *n, *found = NULL;
360 struct rb_node *next;
361 size_t dummy = 0;
362
363 /* zero counters of active symbol */
364 if (syme) {
365 __zero_source_counters(syme);
366 top->sym_filter_entry = NULL;
367 }
368
369 fprintf(stdout, "\n%s: ", msg);
370 if (getline(&buf, &dummy, stdin) < 0)
371 goto out_free;
372
373 p = strchr(buf, '\n');
374 if (p)
375 *p = 0;
376
377 next = rb_first(&top->sym_evsel->hists.entries);
378 while (next) {
379 n = rb_entry(next, struct hist_entry, rb_node);
380 if (n->ms.sym && !strcmp(buf, n->ms.sym->name)) {
381 found = n;
382 break;
383 }
384 next = rb_next(&n->rb_node);
385 }
386
387 if (!found) {
388 fprintf(stderr, "Sorry, %s is not active.\n", buf);
389 sleep(1);
390 } else
391 perf_top__parse_source(top, found);
392
393out_free:
394 free(buf);
395}
396
397static void perf_top__print_mapped_keys(struct perf_top *top)
398{
399 char *name = NULL;
400
401 if (top->sym_filter_entry) {
402 struct symbol *sym = top->sym_filter_entry->ms.sym;
403 name = sym->name;
404 }
405
406 fprintf(stdout, "\nMapped keys:\n");
407 fprintf(stdout, "\t[d] display refresh delay. \t(%d)\n", top->delay_secs);
408 fprintf(stdout, "\t[e] display entries (lines). \t(%d)\n", top->print_entries);
409
410 if (top->evlist->nr_entries > 1)
411 fprintf(stdout, "\t[E] active event counter. \t(%s)\n", event_name(top->sym_evsel));
412
413 fprintf(stdout, "\t[f] profile display filter (count). \t(%d)\n", top->count_filter);
414
415 fprintf(stdout, "\t[F] annotate display filter (percent). \t(%d%%)\n", top->sym_pcnt_filter);
416 fprintf(stdout, "\t[s] annotate symbol. \t(%s)\n", name?: "NULL");
417 fprintf(stdout, "\t[S] stop annotation.\n");
418
419 fprintf(stdout,
420 "\t[K] hide kernel_symbols symbols. \t(%s)\n",
421 top->hide_kernel_symbols ? "yes" : "no");
422 fprintf(stdout,
423 "\t[U] hide user symbols. \t(%s)\n",
424 top->hide_user_symbols ? "yes" : "no");
425 fprintf(stdout, "\t[z] toggle sample zeroing. \t(%d)\n", top->zero ? 1 : 0);
426 fprintf(stdout, "\t[qQ] quit.\n");
427}
428
429static int perf_top__key_mapped(struct perf_top *top, int c)
430{
431 switch (c) {
432 case 'd':
433 case 'e':
434 case 'f':
435 case 'z':
436 case 'q':
437 case 'Q':
438 case 'K':
439 case 'U':
440 case 'F':
441 case 's':
442 case 'S':
443 return 1;
444 case 'E':
445 return top->evlist->nr_entries > 1 ? 1 : 0;
446 default:
447 break;
448 }
449
450 return 0;
451}
452
453static void perf_top__handle_keypress(struct perf_top *top, int c)
454{
455 if (!perf_top__key_mapped(top, c)) {
456 struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
457 struct termios tc, save;
458
459 perf_top__print_mapped_keys(top);
460 fprintf(stdout, "\nEnter selection, or unmapped key to continue: ");
461 fflush(stdout);
462
463 tcgetattr(0, &save);
464 tc = save;
465 tc.c_lflag &= ~(ICANON | ECHO);
466 tc.c_cc[VMIN] = 0;
467 tc.c_cc[VTIME] = 0;
468 tcsetattr(0, TCSANOW, &tc);
469
470 poll(&stdin_poll, 1, -1);
471 c = getc(stdin);
472
473 tcsetattr(0, TCSAFLUSH, &save);
474 if (!perf_top__key_mapped(top, c))
475 return;
476 }
477
478 switch (c) {
479 case 'd':
480 prompt_integer(&top->delay_secs, "Enter display delay");
481 if (top->delay_secs < 1)
482 top->delay_secs = 1;
483 break;
484 case 'e':
485 prompt_integer(&top->print_entries, "Enter display entries (lines)");
486 if (top->print_entries == 0) {
487 struct sigaction act = {
488 .sa_sigaction = perf_top__sig_winch,
489 .sa_flags = SA_SIGINFO,
490 };
491 perf_top__sig_winch(SIGWINCH, NULL, top);
492 sigaction(SIGWINCH, &act, NULL);
493 } else {
494 perf_top__sig_winch(SIGWINCH, NULL, top);
495 signal(SIGWINCH, SIG_DFL);
496 }
497 break;
498 case 'E':
499 if (top->evlist->nr_entries > 1) {
500 /* Select 0 as the default event: */
501 int counter = 0;
502
503 fprintf(stderr, "\nAvailable events:");
504
505 list_for_each_entry(top->sym_evsel, &top->evlist->entries, node)
506 fprintf(stderr, "\n\t%d %s", top->sym_evsel->idx, event_name(top->sym_evsel));
507
508 prompt_integer(&counter, "Enter details event counter");
509
510 if (counter >= top->evlist->nr_entries) {
511 top->sym_evsel = list_entry(top->evlist->entries.next, struct perf_evsel, node);
512 fprintf(stderr, "Sorry, no such event, using %s.\n", event_name(top->sym_evsel));
513 sleep(1);
514 break;
515 }
516 list_for_each_entry(top->sym_evsel, &top->evlist->entries, node)
517 if (top->sym_evsel->idx == counter)
518 break;
519 } else
520 top->sym_evsel = list_entry(top->evlist->entries.next, struct perf_evsel, node);
521 break;
522 case 'f':
523 prompt_integer(&top->count_filter, "Enter display event count filter");
524 break;
525 case 'F':
526 prompt_percent(&top->sym_pcnt_filter,
527 "Enter details display event filter (percent)");
528 break;
529 case 'K':
530 top->hide_kernel_symbols = !top->hide_kernel_symbols;
531 break;
532 case 'q':
533 case 'Q':
534 printf("exiting.\n");
535 if (top->dump_symtab)
536 perf_session__fprintf_dsos(top->session, stderr);
537 exit(0);
538 case 's':
539 perf_top__prompt_symbol(top, "Enter details symbol");
540 break;
541 case 'S':
542 if (!top->sym_filter_entry)
543 break;
544 else {
545 struct hist_entry *syme = top->sym_filter_entry;
546
547 top->sym_filter_entry = NULL;
548 __zero_source_counters(syme);
549 }
550 break;
551 case 'U':
552 top->hide_user_symbols = !top->hide_user_symbols;
553 break;
554 case 'z':
555 top->zero = !top->zero;
556 break;
557 default:
558 break;
559 }
560}
561
562static void perf_top__sort_new_samples(void *arg)
563{
564 struct perf_top *t = arg;
565 perf_top__reset_sample_counters(t);
566
567 if (t->evlist->selected != NULL)
568 t->sym_evsel = t->evlist->selected;
569
570 hists__collapse_resort_threaded(&t->sym_evsel->hists);
571 hists__output_resort_threaded(&t->sym_evsel->hists);
572 hists__decay_entries_threaded(&t->sym_evsel->hists,
573 t->hide_user_symbols,
574 t->hide_kernel_symbols);
575}
576
577static void *display_thread_tui(void *arg)
578{
579 struct perf_evsel *pos;
580 struct perf_top *top = arg;
581 const char *help = "For a higher level overview, try: perf top --sort comm,dso";
582
583 perf_top__sort_new_samples(top);
584
585 /*
586 * Initialize the uid_filter_str, in the future the TUI will allow
587 * Zooming in/out UIDs. For now juse use whatever the user passed
588 * via --uid.
589 */
590 list_for_each_entry(pos, &top->evlist->entries, node)
591 pos->hists.uid_filter_str = top->target.uid_str;
592
593 perf_evlist__tui_browse_hists(top->evlist, help,
594 perf_top__sort_new_samples,
595 top, top->delay_secs);
596
597 exit_browser(0);
598 exit(0);
599 return NULL;
600}
601
602static void *display_thread(void *arg)
603{
604 struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
605 struct termios tc, save;
606 struct perf_top *top = arg;
607 int delay_msecs, c;
608
609 tcgetattr(0, &save);
610 tc = save;
611 tc.c_lflag &= ~(ICANON | ECHO);
612 tc.c_cc[VMIN] = 0;
613 tc.c_cc[VTIME] = 0;
614
615 pthread__unblock_sigwinch();
616repeat:
617 delay_msecs = top->delay_secs * 1000;
618 tcsetattr(0, TCSANOW, &tc);
619 /* trash return*/
620 getc(stdin);
621
622 while (1) {
623 perf_top__print_sym_table(top);
624 /*
625 * Either timeout expired or we got an EINTR due to SIGWINCH,
626 * refresh screen in both cases.
627 */
628 switch (poll(&stdin_poll, 1, delay_msecs)) {
629 case 0:
630 continue;
631 case -1:
632 if (errno == EINTR)
633 continue;
634 /* Fall trhu */
635 default:
636 goto process_hotkey;
637 }
638 }
639process_hotkey:
640 c = getc(stdin);
641 tcsetattr(0, TCSAFLUSH, &save);
642
643 perf_top__handle_keypress(top, c);
644 goto repeat;
645
646 return NULL;
647}
648
649/* Tag samples to be skipped. */
650static const char *skip_symbols[] = {
651 "intel_idle",
652 "default_idle",
653 "native_safe_halt",
654 "cpu_idle",
655 "enter_idle",
656 "exit_idle",
657 "mwait_idle",
658 "mwait_idle_with_hints",
659 "poll_idle",
660 "ppc64_runlatch_off",
661 "pseries_dedicated_idle_sleep",
662 NULL
663};
664
665static int symbol_filter(struct map *map __used, struct symbol *sym)
666{
667 const char *name = sym->name;
668 int i;
669
670 /*
671 * ppc64 uses function descriptors and appends a '.' to the
672 * start of every instruction address. Remove it.
673 */
674 if (name[0] == '.')
675 name++;
676
677 if (!strcmp(name, "_text") ||
678 !strcmp(name, "_etext") ||
679 !strcmp(name, "_sinittext") ||
680 !strncmp("init_module", name, 11) ||
681 !strncmp("cleanup_module", name, 14) ||
682 strstr(name, "_text_start") ||
683 strstr(name, "_text_end"))
684 return 1;
685
686 for (i = 0; skip_symbols[i]; i++) {
687 if (!strcmp(skip_symbols[i], name)) {
688 sym->ignore = true;
689 break;
690 }
691 }
692
693 return 0;
694}
695
696static void perf_event__process_sample(struct perf_tool *tool,
697 const union perf_event *event,
698 struct perf_evsel *evsel,
699 struct perf_sample *sample,
700 struct machine *machine)
701{
702 struct perf_top *top = container_of(tool, struct perf_top, tool);
703 struct symbol *parent = NULL;
704 u64 ip = event->ip.ip;
705 struct addr_location al;
706 int err;
707
708 if (!machine && perf_guest) {
709 pr_err("Can't find guest [%d]'s kernel information\n",
710 event->ip.pid);
711 return;
712 }
713
714 if (!machine) {
715 pr_err("%u unprocessable samples recorded.",
716 top->session->hists.stats.nr_unprocessable_samples++);
717 return;
718 }
719
720 if (event->header.misc & PERF_RECORD_MISC_EXACT_IP)
721 top->exact_samples++;
722
723 if (perf_event__preprocess_sample(event, machine, &al, sample,
724 symbol_filter) < 0 ||
725 al.filtered)
726 return;
727
728 if (!top->kptr_restrict_warned &&
729 symbol_conf.kptr_restrict &&
730 al.cpumode == PERF_RECORD_MISC_KERNEL) {
731 ui__warning(
732"Kernel address maps (/proc/{kallsyms,modules}) are restricted.\n\n"
733"Check /proc/sys/kernel/kptr_restrict.\n\n"
734"Kernel%s samples will not be resolved.\n",
735 !RB_EMPTY_ROOT(&al.map->dso->symbols[MAP__FUNCTION]) ?
736 " modules" : "");
737 if (use_browser <= 0)
738 sleep(5);
739 top->kptr_restrict_warned = true;
740 }
741
742 if (al.sym == NULL) {
743 const char *msg = "Kernel samples will not be resolved.\n";
744 /*
745 * As we do lazy loading of symtabs we only will know if the
746 * specified vmlinux file is invalid when we actually have a
747 * hit in kernel space and then try to load it. So if we get
748 * here and there are _no_ symbols in the DSO backing the
749 * kernel map, bail out.
750 *
751 * We may never get here, for instance, if we use -K/
752 * --hide-kernel-symbols, even if the user specifies an
753 * invalid --vmlinux ;-)
754 */
755 if (!top->kptr_restrict_warned && !top->vmlinux_warned &&
756 al.map == machine->vmlinux_maps[MAP__FUNCTION] &&
757 RB_EMPTY_ROOT(&al.map->dso->symbols[MAP__FUNCTION])) {
758 if (symbol_conf.vmlinux_name) {
759 ui__warning("The %s file can't be used.\n%s",
760 symbol_conf.vmlinux_name, msg);
761 } else {
762 ui__warning("A vmlinux file was not found.\n%s",
763 msg);
764 }
765
766 if (use_browser <= 0)
767 sleep(5);
768 top->vmlinux_warned = true;
769 }
770 }
771
772 if (al.sym == NULL || !al.sym->ignore) {
773 struct hist_entry *he;
774
775 if ((sort__has_parent || symbol_conf.use_callchain) &&
776 sample->callchain) {
777 err = machine__resolve_callchain(machine, evsel, al.thread,
778 sample->callchain, &parent);
779 if (err)
780 return;
781 }
782
783 he = perf_evsel__add_hist_entry(evsel, &al, sample);
784 if (he == NULL) {
785 pr_err("Problem incrementing symbol period, skipping event\n");
786 return;
787 }
788
789 if (symbol_conf.use_callchain) {
790 err = callchain_append(he->callchain, &callchain_cursor,
791 sample->period);
792 if (err)
793 return;
794 }
795
796 if (top->sort_has_symbols)
797 perf_top__record_precise_ip(top, he, evsel->idx, ip);
798 }
799
800 return;
801}
802
803static void perf_top__mmap_read_idx(struct perf_top *top, int idx)
804{
805 struct perf_sample sample;
806 struct perf_evsel *evsel;
807 struct perf_session *session = top->session;
808 union perf_event *event;
809 struct machine *machine;
810 u8 origin;
811 int ret;
812
813 while ((event = perf_evlist__mmap_read(top->evlist, idx)) != NULL) {
814 ret = perf_session__parse_sample(session, event, &sample);
815 if (ret) {
816 pr_err("Can't parse sample, err = %d\n", ret);
817 continue;
818 }
819
820 evsel = perf_evlist__id2evsel(session->evlist, sample.id);
821 assert(evsel != NULL);
822
823 origin = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
824
825 if (event->header.type == PERF_RECORD_SAMPLE)
826 ++top->samples;
827
828 switch (origin) {
829 case PERF_RECORD_MISC_USER:
830 ++top->us_samples;
831 if (top->hide_user_symbols)
832 continue;
833 machine = perf_session__find_host_machine(session);
834 break;
835 case PERF_RECORD_MISC_KERNEL:
836 ++top->kernel_samples;
837 if (top->hide_kernel_symbols)
838 continue;
839 machine = perf_session__find_host_machine(session);
840 break;
841 case PERF_RECORD_MISC_GUEST_KERNEL:
842 ++top->guest_kernel_samples;
843 machine = perf_session__find_machine(session, event->ip.pid);
844 break;
845 case PERF_RECORD_MISC_GUEST_USER:
846 ++top->guest_us_samples;
847 /*
848 * TODO: we don't process guest user from host side
849 * except simple counting.
850 */
851 /* Fall thru */
852 default:
853 continue;
854 }
855
856
857 if (event->header.type == PERF_RECORD_SAMPLE) {
858 perf_event__process_sample(&top->tool, event, evsel,
859 &sample, machine);
860 } else if (event->header.type < PERF_RECORD_MAX) {
861 hists__inc_nr_events(&evsel->hists, event->header.type);
862 perf_event__process(&top->tool, event, &sample, machine);
863 } else
864 ++session->hists.stats.nr_unknown_events;
865 }
866}
867
868static void perf_top__mmap_read(struct perf_top *top)
869{
870 int i;
871
872 for (i = 0; i < top->evlist->nr_mmaps; i++)
873 perf_top__mmap_read_idx(top, i);
874}
875
876static void perf_top__start_counters(struct perf_top *top)
877{
878 struct perf_evsel *counter, *first;
879 struct perf_evlist *evlist = top->evlist;
880
881 first = list_entry(evlist->entries.next, struct perf_evsel, node);
882
883 list_for_each_entry(counter, &evlist->entries, node) {
884 struct perf_event_attr *attr = &counter->attr;
885 struct xyarray *group_fd = NULL;
886
887 if (top->group && counter != first)
888 group_fd = first->fd;
889
890 attr->sample_type = PERF_SAMPLE_IP | PERF_SAMPLE_TID;
891
892 if (top->freq) {
893 attr->sample_type |= PERF_SAMPLE_PERIOD;
894 attr->freq = 1;
895 attr->sample_freq = top->freq;
896 }
897
898 if (evlist->nr_entries > 1) {
899 attr->sample_type |= PERF_SAMPLE_ID;
900 attr->read_format |= PERF_FORMAT_ID;
901 }
902
903 if (perf_target__has_cpu(&top->target))
904 attr->sample_type |= PERF_SAMPLE_CPU;
905
906 if (symbol_conf.use_callchain)
907 attr->sample_type |= PERF_SAMPLE_CALLCHAIN;
908
909 attr->mmap = 1;
910 attr->comm = 1;
911 attr->inherit = top->inherit;
912fallback_missing_features:
913 if (top->exclude_guest_missing)
914 attr->exclude_guest = attr->exclude_host = 0;
915retry_sample_id:
916 attr->sample_id_all = top->sample_id_all_missing ? 0 : 1;
917try_again:
918 if (perf_evsel__open(counter, top->evlist->cpus,
919 top->evlist->threads, top->group,
920 group_fd) < 0) {
921 int err = errno;
922
923 if (err == EPERM || err == EACCES) {
924 ui__error_paranoid();
925 goto out_err;
926 } else if (err == EINVAL) {
927 if (!top->exclude_guest_missing &&
928 (attr->exclude_guest || attr->exclude_host)) {
929 pr_debug("Old kernel, cannot exclude "
930 "guest or host samples.\n");
931 top->exclude_guest_missing = true;
932 goto fallback_missing_features;
933 } else if (!top->sample_id_all_missing) {
934 /*
935 * Old kernel, no attr->sample_id_type_all field
936 */
937 top->sample_id_all_missing = true;
938 goto retry_sample_id;
939 }
940 }
941 /*
942 * If it's cycles then fall back to hrtimer
943 * based cpu-clock-tick sw counter, which
944 * is always available even if no PMU support:
945 */
946 if (attr->type == PERF_TYPE_HARDWARE &&
947 attr->config == PERF_COUNT_HW_CPU_CYCLES) {
948 if (verbose)
949 ui__warning("Cycles event not supported,\n"
950 "trying to fall back to cpu-clock-ticks\n");
951
952 attr->type = PERF_TYPE_SOFTWARE;
953 attr->config = PERF_COUNT_SW_CPU_CLOCK;
954 if (counter->name) {
955 free(counter->name);
956 counter->name = NULL;
957 }
958 goto try_again;
959 }
960
961 if (err == ENOENT) {
962 ui__error("The %s event is not supported.\n",
963 event_name(counter));
964 goto out_err;
965 } else if (err == EMFILE) {
966 ui__error("Too many events are opened.\n"
967 "Try again after reducing the number of events\n");
968 goto out_err;
969 }
970
971 ui__error("The sys_perf_event_open() syscall "
972 "returned with %d (%s). /bin/dmesg "
973 "may provide additional information.\n"
974 "No CONFIG_PERF_EVENTS=y kernel support "
975 "configured?\n", err, strerror(err));
976 goto out_err;
977 }
978 }
979
980 if (perf_evlist__mmap(evlist, top->mmap_pages, false) < 0) {
981 ui__error("Failed to mmap with %d (%s)\n",
982 errno, strerror(errno));
983 goto out_err;
984 }
985
986 return;
987
988out_err:
989 exit_browser(0);
990 exit(0);
991}
992
993static int perf_top__setup_sample_type(struct perf_top *top)
994{
995 if (!top->sort_has_symbols) {
996 if (symbol_conf.use_callchain) {
997 ui__error("Selected -g but \"sym\" not present in --sort/-s.");
998 return -EINVAL;
999 }
1000 } else if (!top->dont_use_callchains && callchain_param.mode != CHAIN_NONE) {
1001 if (callchain_register_param(&callchain_param) < 0) {
1002 ui__error("Can't register callchain params.\n");
1003 return -EINVAL;
1004 }
1005 }
1006
1007 return 0;
1008}
1009
1010static int __cmd_top(struct perf_top *top)
1011{
1012 pthread_t thread;
1013 int ret;
1014 /*
1015 * FIXME: perf_session__new should allow passing a O_MMAP, so that all this
1016 * mmap reading, etc is encapsulated in it. Use O_WRONLY for now.
1017 */
1018 top->session = perf_session__new(NULL, O_WRONLY, false, false, NULL);
1019 if (top->session == NULL)
1020 return -ENOMEM;
1021
1022 ret = perf_top__setup_sample_type(top);
1023 if (ret)
1024 goto out_delete;
1025
1026 if (perf_target__has_task(&top->target))
1027 perf_event__synthesize_thread_map(&top->tool, top->evlist->threads,
1028 perf_event__process,
1029 &top->session->host_machine);
1030 else
1031 perf_event__synthesize_threads(&top->tool, perf_event__process,
1032 &top->session->host_machine);
1033 perf_top__start_counters(top);
1034 top->session->evlist = top->evlist;
1035 perf_session__update_sample_type(top->session);
1036
1037 /* Wait for a minimal set of events before starting the snapshot */
1038 poll(top->evlist->pollfd, top->evlist->nr_fds, 100);
1039
1040 perf_top__mmap_read(top);
1041
1042 if (pthread_create(&thread, NULL, (use_browser > 0 ? display_thread_tui :
1043 display_thread), top)) {
1044 ui__error("Could not create display thread.\n");
1045 exit(-1);
1046 }
1047
1048 if (top->realtime_prio) {
1049 struct sched_param param;
1050
1051 param.sched_priority = top->realtime_prio;
1052 if (sched_setscheduler(0, SCHED_FIFO, ¶m)) {
1053 ui__error("Could not set realtime priority.\n");
1054 exit(-1);
1055 }
1056 }
1057
1058 while (1) {
1059 u64 hits = top->samples;
1060
1061 perf_top__mmap_read(top);
1062
1063 if (hits == top->samples)
1064 ret = poll(top->evlist->pollfd, top->evlist->nr_fds, 100);
1065 }
1066
1067out_delete:
1068 perf_session__delete(top->session);
1069 top->session = NULL;
1070
1071 return 0;
1072}
1073
1074static int
1075parse_callchain_opt(const struct option *opt, const char *arg, int unset)
1076{
1077 struct perf_top *top = (struct perf_top *)opt->value;
1078 char *tok, *tok2;
1079 char *endptr;
1080
1081 /*
1082 * --no-call-graph
1083 */
1084 if (unset) {
1085 top->dont_use_callchains = true;
1086 return 0;
1087 }
1088
1089 symbol_conf.use_callchain = true;
1090
1091 if (!arg)
1092 return 0;
1093
1094 tok = strtok((char *)arg, ",");
1095 if (!tok)
1096 return -1;
1097
1098 /* get the output mode */
1099 if (!strncmp(tok, "graph", strlen(arg)))
1100 callchain_param.mode = CHAIN_GRAPH_ABS;
1101
1102 else if (!strncmp(tok, "flat", strlen(arg)))
1103 callchain_param.mode = CHAIN_FLAT;
1104
1105 else if (!strncmp(tok, "fractal", strlen(arg)))
1106 callchain_param.mode = CHAIN_GRAPH_REL;
1107
1108 else if (!strncmp(tok, "none", strlen(arg))) {
1109 callchain_param.mode = CHAIN_NONE;
1110 symbol_conf.use_callchain = false;
1111
1112 return 0;
1113 } else
1114 return -1;
1115
1116 /* get the min percentage */
1117 tok = strtok(NULL, ",");
1118 if (!tok)
1119 goto setup;
1120
1121 callchain_param.min_percent = strtod(tok, &endptr);
1122 if (tok == endptr)
1123 return -1;
1124
1125 /* get the print limit */
1126 tok2 = strtok(NULL, ",");
1127 if (!tok2)
1128 goto setup;
1129
1130 if (tok2[0] != 'c') {
1131 callchain_param.print_limit = strtod(tok2, &endptr);
1132 tok2 = strtok(NULL, ",");
1133 if (!tok2)
1134 goto setup;
1135 }
1136
1137 /* get the call chain order */
1138 if (!strcmp(tok2, "caller"))
1139 callchain_param.order = ORDER_CALLER;
1140 else if (!strcmp(tok2, "callee"))
1141 callchain_param.order = ORDER_CALLEE;
1142 else
1143 return -1;
1144setup:
1145 if (callchain_register_param(&callchain_param) < 0) {
1146 fprintf(stderr, "Can't register callchain params\n");
1147 return -1;
1148 }
1149 return 0;
1150}
1151
1152static const char * const top_usage[] = {
1153 "perf top [<options>]",
1154 NULL
1155};
1156
1157int cmd_top(int argc, const char **argv, const char *prefix __used)
1158{
1159 struct perf_evsel *pos;
1160 int status;
1161 char errbuf[BUFSIZ];
1162 struct perf_top top = {
1163 .count_filter = 5,
1164 .delay_secs = 2,
1165 .freq = 4000, /* 4 KHz */
1166 .mmap_pages = 128,
1167 .sym_pcnt_filter = 5,
1168 .target = {
1169 .uses_mmap = true,
1170 },
1171 };
1172 char callchain_default_opt[] = "fractal,0.5,callee";
1173 const struct option options[] = {
1174 OPT_CALLBACK('e', "event", &top.evlist, "event",
1175 "event selector. use 'perf list' to list available events",
1176 parse_events_option),
1177 OPT_INTEGER('c', "count", &top.default_interval,
1178 "event period to sample"),
1179 OPT_STRING('p', "pid", &top.target.pid, "pid",
1180 "profile events on existing process id"),
1181 OPT_STRING('t', "tid", &top.target.tid, "tid",
1182 "profile events on existing thread id"),
1183 OPT_BOOLEAN('a', "all-cpus", &top.target.system_wide,
1184 "system-wide collection from all CPUs"),
1185 OPT_STRING('C', "cpu", &top.target.cpu_list, "cpu",
1186 "list of cpus to monitor"),
1187 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1188 "file", "vmlinux pathname"),
1189 OPT_BOOLEAN('K', "hide_kernel_symbols", &top.hide_kernel_symbols,
1190 "hide kernel symbols"),
1191 OPT_UINTEGER('m', "mmap-pages", &top.mmap_pages, "number of mmap data pages"),
1192 OPT_INTEGER('r', "realtime", &top.realtime_prio,
1193 "collect data with this RT SCHED_FIFO priority"),
1194 OPT_INTEGER('d', "delay", &top.delay_secs,
1195 "number of seconds to delay between refreshes"),
1196 OPT_BOOLEAN('D', "dump-symtab", &top.dump_symtab,
1197 "dump the symbol table used for profiling"),
1198 OPT_INTEGER('f', "count-filter", &top.count_filter,
1199 "only display functions with more events than this"),
1200 OPT_BOOLEAN('g', "group", &top.group,
1201 "put the counters into a counter group"),
1202 OPT_BOOLEAN('i', "inherit", &top.inherit,
1203 "child tasks inherit counters"),
1204 OPT_STRING(0, "sym-annotate", &top.sym_filter, "symbol name",
1205 "symbol to annotate"),
1206 OPT_BOOLEAN('z', "zero", &top.zero,
1207 "zero history across updates"),
1208 OPT_INTEGER('F', "freq", &top.freq,
1209 "profile at this frequency"),
1210 OPT_INTEGER('E', "entries", &top.print_entries,
1211 "display this many functions"),
1212 OPT_BOOLEAN('U', "hide_user_symbols", &top.hide_user_symbols,
1213 "hide user symbols"),
1214 OPT_BOOLEAN(0, "tui", &top.use_tui, "Use the TUI interface"),
1215 OPT_BOOLEAN(0, "stdio", &top.use_stdio, "Use the stdio interface"),
1216 OPT_INCR('v', "verbose", &verbose,
1217 "be more verbose (show counter open errors, etc)"),
1218 OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
1219 "sort by key(s): pid, comm, dso, symbol, parent"),
1220 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
1221 "Show a column with the number of samples"),
1222 OPT_CALLBACK_DEFAULT('G', "call-graph", &top, "output_type,min_percent, call_order",
1223 "Display callchains using output_type (graph, flat, fractal, or none), min percent threshold and callchain order. "
1224 "Default: fractal,0.5,callee", &parse_callchain_opt,
1225 callchain_default_opt),
1226 OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
1227 "Show a column with the sum of periods"),
1228 OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
1229 "only consider symbols in these dsos"),
1230 OPT_STRING(0, "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1231 "only consider symbols in these comms"),
1232 OPT_STRING(0, "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1233 "only consider these symbols"),
1234 OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
1235 "Interleave source code with assembly code (default)"),
1236 OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
1237 "Display raw encoding of assembly instructions (default)"),
1238 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
1239 "Specify disassembler style (e.g. -M intel for intel syntax)"),
1240 OPT_STRING('u', "uid", &top.target.uid_str, "user", "user to profile"),
1241 OPT_END()
1242 };
1243
1244 top.evlist = perf_evlist__new(NULL, NULL);
1245 if (top.evlist == NULL)
1246 return -ENOMEM;
1247
1248 symbol_conf.exclude_other = false;
1249
1250 argc = parse_options(argc, argv, options, top_usage, 0);
1251 if (argc)
1252 usage_with_options(top_usage, options);
1253
1254 if (sort_order == default_sort_order)
1255 sort_order = "dso,symbol";
1256
1257 setup_sorting(top_usage, options);
1258
1259 if (top.use_stdio)
1260 use_browser = 0;
1261 else if (top.use_tui)
1262 use_browser = 1;
1263
1264 setup_browser(false);
1265
1266 status = perf_target__validate(&top.target);
1267 if (status) {
1268 perf_target__strerror(&top.target, status, errbuf, BUFSIZ);
1269 ui__warning("%s", errbuf);
1270 }
1271
1272 status = perf_target__parse_uid(&top.target);
1273 if (status) {
1274 int saved_errno = errno;
1275
1276 perf_target__strerror(&top.target, status, errbuf, BUFSIZ);
1277 ui__error("%s", errbuf);
1278
1279 status = -saved_errno;
1280 goto out_delete_evlist;
1281 }
1282
1283 if (perf_target__none(&top.target))
1284 top.target.system_wide = true;
1285
1286 if (perf_evlist__create_maps(top.evlist, &top.target) < 0)
1287 usage_with_options(top_usage, options);
1288
1289 if (!top.evlist->nr_entries &&
1290 perf_evlist__add_default(top.evlist) < 0) {
1291 ui__error("Not enough memory for event selector list\n");
1292 return -ENOMEM;
1293 }
1294
1295 symbol_conf.nr_events = top.evlist->nr_entries;
1296
1297 if (top.delay_secs < 1)
1298 top.delay_secs = 1;
1299
1300 /*
1301 * User specified count overrides default frequency.
1302 */
1303 if (top.default_interval)
1304 top.freq = 0;
1305 else if (top.freq) {
1306 top.default_interval = top.freq;
1307 } else {
1308 ui__error("frequency and count are zero, aborting\n");
1309 exit(EXIT_FAILURE);
1310 }
1311
1312 list_for_each_entry(pos, &top.evlist->entries, node) {
1313 /*
1314 * Fill in the ones not specifically initialized via -c:
1315 */
1316 if (!pos->attr.sample_period)
1317 pos->attr.sample_period = top.default_interval;
1318 }
1319
1320 top.sym_evsel = list_entry(top.evlist->entries.next, struct perf_evsel, node);
1321
1322 symbol_conf.priv_size = sizeof(struct annotation);
1323
1324 symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
1325 if (symbol__init() < 0)
1326 return -1;
1327
1328 sort_entry__setup_elide(&sort_dso, symbol_conf.dso_list, "dso", stdout);
1329 sort_entry__setup_elide(&sort_comm, symbol_conf.comm_list, "comm", stdout);
1330 sort_entry__setup_elide(&sort_sym, symbol_conf.sym_list, "symbol", stdout);
1331
1332 /*
1333 * Avoid annotation data structures overhead when symbols aren't on the
1334 * sort list.
1335 */
1336 top.sort_has_symbols = sort_sym.list.next != NULL;
1337
1338 get_term_dimensions(&top.winsize);
1339 if (top.print_entries == 0) {
1340 struct sigaction act = {
1341 .sa_sigaction = perf_top__sig_winch,
1342 .sa_flags = SA_SIGINFO,
1343 };
1344 perf_top__update_print_entries(&top);
1345 sigaction(SIGWINCH, &act, NULL);
1346 }
1347
1348 status = __cmd_top(&top);
1349
1350out_delete_evlist:
1351 perf_evlist__delete(top.evlist);
1352
1353 return status;
1354}
1/*
2 * builtin-top.c
3 *
4 * Builtin top command: Display a continuously updated profile of
5 * any workload, CPU or specific PID.
6 *
7 * 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 * Improvements and fixes by:
11 *
12 * Arjan van de Ven <arjan@linux.intel.com>
13 * Yanmin Zhang <yanmin.zhang@intel.com>
14 * Wu Fengguang <fengguang.wu@intel.com>
15 * Mike Galbraith <efault@gmx.de>
16 * Paul Mackerras <paulus@samba.org>
17 *
18 * 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/cache.h"
26#include "util/color.h"
27#include "util/evlist.h"
28#include "util/evsel.h"
29#include "util/machine.h"
30#include "util/session.h"
31#include "util/symbol.h"
32#include "util/thread.h"
33#include "util/thread_map.h"
34#include "util/top.h"
35#include "util/util.h"
36#include <linux/rbtree.h>
37#include <subcmd/parse-options.h>
38#include "util/parse-events.h"
39#include "util/cpumap.h"
40#include "util/xyarray.h"
41#include "util/sort.h"
42#include "util/intlist.h"
43#include "util/parse-branch-options.h"
44#include "arch/common.h"
45
46#include "util/debug.h"
47
48#include <assert.h>
49#include <elf.h>
50#include <fcntl.h>
51
52#include <stdio.h>
53#include <termios.h>
54#include <unistd.h>
55#include <inttypes.h>
56
57#include <errno.h>
58#include <time.h>
59#include <sched.h>
60
61#include <sys/syscall.h>
62#include <sys/ioctl.h>
63#include <poll.h>
64#include <sys/prctl.h>
65#include <sys/wait.h>
66#include <sys/uio.h>
67#include <sys/utsname.h>
68#include <sys/mman.h>
69
70#include <linux/stringify.h>
71#include <linux/types.h>
72
73static volatile int done;
74
75#define HEADER_LINE_NR 5
76
77static void perf_top__update_print_entries(struct perf_top *top)
78{
79 top->print_entries = top->winsize.ws_row - HEADER_LINE_NR;
80}
81
82static void perf_top__sig_winch(int sig __maybe_unused,
83 siginfo_t *info __maybe_unused, void *arg)
84{
85 struct perf_top *top = arg;
86
87 get_term_dimensions(&top->winsize);
88 perf_top__update_print_entries(top);
89}
90
91static int perf_top__parse_source(struct perf_top *top, struct hist_entry *he)
92{
93 struct symbol *sym;
94 struct annotation *notes;
95 struct map *map;
96 int err = -1;
97
98 if (!he || !he->ms.sym)
99 return -1;
100
101 sym = he->ms.sym;
102 map = he->ms.map;
103
104 /*
105 * We can't annotate with just /proc/kallsyms
106 */
107 if (map->dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
108 !dso__is_kcore(map->dso)) {
109 pr_err("Can't annotate %s: No vmlinux file was found in the "
110 "path\n", sym->name);
111 sleep(1);
112 return -1;
113 }
114
115 notes = symbol__annotation(sym);
116 if (notes->src != NULL) {
117 pthread_mutex_lock(¬es->lock);
118 goto out_assign;
119 }
120
121 pthread_mutex_lock(¬es->lock);
122
123 if (symbol__alloc_hist(sym) < 0) {
124 pthread_mutex_unlock(¬es->lock);
125 pr_err("Not enough memory for annotating '%s' symbol!\n",
126 sym->name);
127 sleep(1);
128 return err;
129 }
130
131 err = symbol__annotate(sym, map, 0);
132 if (err == 0) {
133out_assign:
134 top->sym_filter_entry = he;
135 }
136
137 pthread_mutex_unlock(¬es->lock);
138 return err;
139}
140
141static void __zero_source_counters(struct hist_entry *he)
142{
143 struct symbol *sym = he->ms.sym;
144 symbol__annotate_zero_histograms(sym);
145}
146
147static void ui__warn_map_erange(struct map *map, struct symbol *sym, u64 ip)
148{
149 struct utsname uts;
150 int err = uname(&uts);
151
152 ui__warning("Out of bounds address found:\n\n"
153 "Addr: %" PRIx64 "\n"
154 "DSO: %s %c\n"
155 "Map: %" PRIx64 "-%" PRIx64 "\n"
156 "Symbol: %" PRIx64 "-%" PRIx64 " %c %s\n"
157 "Arch: %s\n"
158 "Kernel: %s\n"
159 "Tools: %s\n\n"
160 "Not all samples will be on the annotation output.\n\n"
161 "Please report to linux-kernel@vger.kernel.org\n",
162 ip, map->dso->long_name, dso__symtab_origin(map->dso),
163 map->start, map->end, sym->start, sym->end,
164 sym->binding == STB_GLOBAL ? 'g' :
165 sym->binding == STB_LOCAL ? 'l' : 'w', sym->name,
166 err ? "[unknown]" : uts.machine,
167 err ? "[unknown]" : uts.release, perf_version_string);
168 if (use_browser <= 0)
169 sleep(5);
170
171 map->erange_warned = true;
172}
173
174static void perf_top__record_precise_ip(struct perf_top *top,
175 struct hist_entry *he,
176 int counter, u64 ip)
177{
178 struct annotation *notes;
179 struct symbol *sym = he->ms.sym;
180 int err = 0;
181
182 if (sym == NULL || (use_browser == 0 &&
183 (top->sym_filter_entry == NULL ||
184 top->sym_filter_entry->ms.sym != sym)))
185 return;
186
187 notes = symbol__annotation(sym);
188
189 if (pthread_mutex_trylock(¬es->lock))
190 return;
191
192 err = hist_entry__inc_addr_samples(he, counter, ip);
193
194 pthread_mutex_unlock(¬es->lock);
195
196 if (unlikely(err)) {
197 /*
198 * This function is now called with he->hists->lock held.
199 * Release it before going to sleep.
200 */
201 pthread_mutex_unlock(&he->hists->lock);
202
203 if (err == -ERANGE && !he->ms.map->erange_warned)
204 ui__warn_map_erange(he->ms.map, sym, ip);
205 else if (err == -ENOMEM) {
206 pr_err("Not enough memory for annotating '%s' symbol!\n",
207 sym->name);
208 sleep(1);
209 }
210
211 pthread_mutex_lock(&he->hists->lock);
212 }
213}
214
215static void perf_top__show_details(struct perf_top *top)
216{
217 struct hist_entry *he = top->sym_filter_entry;
218 struct annotation *notes;
219 struct symbol *symbol;
220 int more;
221
222 if (!he)
223 return;
224
225 symbol = he->ms.sym;
226 notes = symbol__annotation(symbol);
227
228 pthread_mutex_lock(¬es->lock);
229
230 if (notes->src == NULL)
231 goto out_unlock;
232
233 printf("Showing %s for %s\n", perf_evsel__name(top->sym_evsel), symbol->name);
234 printf(" Events Pcnt (>=%d%%)\n", top->sym_pcnt_filter);
235
236 more = symbol__annotate_printf(symbol, he->ms.map, top->sym_evsel,
237 0, top->sym_pcnt_filter, top->print_entries, 4);
238
239 if (top->evlist->enabled) {
240 if (top->zero)
241 symbol__annotate_zero_histogram(symbol, top->sym_evsel->idx);
242 else
243 symbol__annotate_decay_histogram(symbol, top->sym_evsel->idx);
244 }
245 if (more != 0)
246 printf("%d lines not displayed, maybe increase display entries [e]\n", more);
247out_unlock:
248 pthread_mutex_unlock(¬es->lock);
249}
250
251static void perf_top__print_sym_table(struct perf_top *top)
252{
253 char bf[160];
254 int printed = 0;
255 const int win_width = top->winsize.ws_col - 1;
256 struct perf_evsel *evsel = top->sym_evsel;
257 struct hists *hists = evsel__hists(evsel);
258
259 puts(CONSOLE_CLEAR);
260
261 perf_top__header_snprintf(top, bf, sizeof(bf));
262 printf("%s\n", bf);
263
264 perf_top__reset_sample_counters(top);
265
266 printf("%-*.*s\n", win_width, win_width, graph_dotted_line);
267
268 if (hists->stats.nr_lost_warned !=
269 hists->stats.nr_events[PERF_RECORD_LOST]) {
270 hists->stats.nr_lost_warned =
271 hists->stats.nr_events[PERF_RECORD_LOST];
272 color_fprintf(stdout, PERF_COLOR_RED,
273 "WARNING: LOST %d chunks, Check IO/CPU overload",
274 hists->stats.nr_lost_warned);
275 ++printed;
276 }
277
278 if (top->sym_filter_entry) {
279 perf_top__show_details(top);
280 return;
281 }
282
283 if (top->evlist->enabled) {
284 if (top->zero) {
285 hists__delete_entries(hists);
286 } else {
287 hists__decay_entries(hists, top->hide_user_symbols,
288 top->hide_kernel_symbols);
289 }
290 }
291
292 hists__collapse_resort(hists, NULL);
293 perf_evsel__output_resort(evsel, NULL);
294
295 hists__output_recalc_col_len(hists, top->print_entries - printed);
296 putchar('\n');
297 hists__fprintf(hists, false, top->print_entries - printed, win_width,
298 top->min_percent, stdout);
299}
300
301static void prompt_integer(int *target, const char *msg)
302{
303 char *buf = malloc(0), *p;
304 size_t dummy = 0;
305 int tmp;
306
307 fprintf(stdout, "\n%s: ", msg);
308 if (getline(&buf, &dummy, stdin) < 0)
309 return;
310
311 p = strchr(buf, '\n');
312 if (p)
313 *p = 0;
314
315 p = buf;
316 while(*p) {
317 if (!isdigit(*p))
318 goto out_free;
319 p++;
320 }
321 tmp = strtoul(buf, NULL, 10);
322 *target = tmp;
323out_free:
324 free(buf);
325}
326
327static void prompt_percent(int *target, const char *msg)
328{
329 int tmp = 0;
330
331 prompt_integer(&tmp, msg);
332 if (tmp >= 0 && tmp <= 100)
333 *target = tmp;
334}
335
336static void perf_top__prompt_symbol(struct perf_top *top, const char *msg)
337{
338 char *buf = malloc(0), *p;
339 struct hist_entry *syme = top->sym_filter_entry, *n, *found = NULL;
340 struct hists *hists = evsel__hists(top->sym_evsel);
341 struct rb_node *next;
342 size_t dummy = 0;
343
344 /* zero counters of active symbol */
345 if (syme) {
346 __zero_source_counters(syme);
347 top->sym_filter_entry = NULL;
348 }
349
350 fprintf(stdout, "\n%s: ", msg);
351 if (getline(&buf, &dummy, stdin) < 0)
352 goto out_free;
353
354 p = strchr(buf, '\n');
355 if (p)
356 *p = 0;
357
358 next = rb_first(&hists->entries);
359 while (next) {
360 n = rb_entry(next, struct hist_entry, rb_node);
361 if (n->ms.sym && !strcmp(buf, n->ms.sym->name)) {
362 found = n;
363 break;
364 }
365 next = rb_next(&n->rb_node);
366 }
367
368 if (!found) {
369 fprintf(stderr, "Sorry, %s is not active.\n", buf);
370 sleep(1);
371 } else
372 perf_top__parse_source(top, found);
373
374out_free:
375 free(buf);
376}
377
378static void perf_top__print_mapped_keys(struct perf_top *top)
379{
380 char *name = NULL;
381
382 if (top->sym_filter_entry) {
383 struct symbol *sym = top->sym_filter_entry->ms.sym;
384 name = sym->name;
385 }
386
387 fprintf(stdout, "\nMapped keys:\n");
388 fprintf(stdout, "\t[d] display refresh delay. \t(%d)\n", top->delay_secs);
389 fprintf(stdout, "\t[e] display entries (lines). \t(%d)\n", top->print_entries);
390
391 if (top->evlist->nr_entries > 1)
392 fprintf(stdout, "\t[E] active event counter. \t(%s)\n", perf_evsel__name(top->sym_evsel));
393
394 fprintf(stdout, "\t[f] profile display filter (count). \t(%d)\n", top->count_filter);
395
396 fprintf(stdout, "\t[F] annotate display filter (percent). \t(%d%%)\n", top->sym_pcnt_filter);
397 fprintf(stdout, "\t[s] annotate symbol. \t(%s)\n", name?: "NULL");
398 fprintf(stdout, "\t[S] stop annotation.\n");
399
400 fprintf(stdout,
401 "\t[K] hide kernel_symbols symbols. \t(%s)\n",
402 top->hide_kernel_symbols ? "yes" : "no");
403 fprintf(stdout,
404 "\t[U] hide user symbols. \t(%s)\n",
405 top->hide_user_symbols ? "yes" : "no");
406 fprintf(stdout, "\t[z] toggle sample zeroing. \t(%d)\n", top->zero ? 1 : 0);
407 fprintf(stdout, "\t[qQ] quit.\n");
408}
409
410static int perf_top__key_mapped(struct perf_top *top, int c)
411{
412 switch (c) {
413 case 'd':
414 case 'e':
415 case 'f':
416 case 'z':
417 case 'q':
418 case 'Q':
419 case 'K':
420 case 'U':
421 case 'F':
422 case 's':
423 case 'S':
424 return 1;
425 case 'E':
426 return top->evlist->nr_entries > 1 ? 1 : 0;
427 default:
428 break;
429 }
430
431 return 0;
432}
433
434static bool perf_top__handle_keypress(struct perf_top *top, int c)
435{
436 bool ret = true;
437
438 if (!perf_top__key_mapped(top, c)) {
439 struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
440 struct termios save;
441
442 perf_top__print_mapped_keys(top);
443 fprintf(stdout, "\nEnter selection, or unmapped key to continue: ");
444 fflush(stdout);
445
446 set_term_quiet_input(&save);
447
448 poll(&stdin_poll, 1, -1);
449 c = getc(stdin);
450
451 tcsetattr(0, TCSAFLUSH, &save);
452 if (!perf_top__key_mapped(top, c))
453 return ret;
454 }
455
456 switch (c) {
457 case 'd':
458 prompt_integer(&top->delay_secs, "Enter display delay");
459 if (top->delay_secs < 1)
460 top->delay_secs = 1;
461 break;
462 case 'e':
463 prompt_integer(&top->print_entries, "Enter display entries (lines)");
464 if (top->print_entries == 0) {
465 struct sigaction act = {
466 .sa_sigaction = perf_top__sig_winch,
467 .sa_flags = SA_SIGINFO,
468 };
469 perf_top__sig_winch(SIGWINCH, NULL, top);
470 sigaction(SIGWINCH, &act, NULL);
471 } else {
472 signal(SIGWINCH, SIG_DFL);
473 }
474 break;
475 case 'E':
476 if (top->evlist->nr_entries > 1) {
477 /* Select 0 as the default event: */
478 int counter = 0;
479
480 fprintf(stderr, "\nAvailable events:");
481
482 evlist__for_each(top->evlist, top->sym_evsel)
483 fprintf(stderr, "\n\t%d %s", top->sym_evsel->idx, perf_evsel__name(top->sym_evsel));
484
485 prompt_integer(&counter, "Enter details event counter");
486
487 if (counter >= top->evlist->nr_entries) {
488 top->sym_evsel = perf_evlist__first(top->evlist);
489 fprintf(stderr, "Sorry, no such event, using %s.\n", perf_evsel__name(top->sym_evsel));
490 sleep(1);
491 break;
492 }
493 evlist__for_each(top->evlist, top->sym_evsel)
494 if (top->sym_evsel->idx == counter)
495 break;
496 } else
497 top->sym_evsel = perf_evlist__first(top->evlist);
498 break;
499 case 'f':
500 prompt_integer(&top->count_filter, "Enter display event count filter");
501 break;
502 case 'F':
503 prompt_percent(&top->sym_pcnt_filter,
504 "Enter details display event filter (percent)");
505 break;
506 case 'K':
507 top->hide_kernel_symbols = !top->hide_kernel_symbols;
508 break;
509 case 'q':
510 case 'Q':
511 printf("exiting.\n");
512 if (top->dump_symtab)
513 perf_session__fprintf_dsos(top->session, stderr);
514 ret = false;
515 break;
516 case 's':
517 perf_top__prompt_symbol(top, "Enter details symbol");
518 break;
519 case 'S':
520 if (!top->sym_filter_entry)
521 break;
522 else {
523 struct hist_entry *syme = top->sym_filter_entry;
524
525 top->sym_filter_entry = NULL;
526 __zero_source_counters(syme);
527 }
528 break;
529 case 'U':
530 top->hide_user_symbols = !top->hide_user_symbols;
531 break;
532 case 'z':
533 top->zero = !top->zero;
534 break;
535 default:
536 break;
537 }
538
539 return ret;
540}
541
542static void perf_top__sort_new_samples(void *arg)
543{
544 struct perf_top *t = arg;
545 struct perf_evsel *evsel = t->sym_evsel;
546 struct hists *hists;
547
548 perf_top__reset_sample_counters(t);
549
550 if (t->evlist->selected != NULL)
551 t->sym_evsel = t->evlist->selected;
552
553 hists = evsel__hists(evsel);
554
555 if (t->evlist->enabled) {
556 if (t->zero) {
557 hists__delete_entries(hists);
558 } else {
559 hists__decay_entries(hists, t->hide_user_symbols,
560 t->hide_kernel_symbols);
561 }
562 }
563
564 hists__collapse_resort(hists, NULL);
565 perf_evsel__output_resort(evsel, NULL);
566}
567
568static void *display_thread_tui(void *arg)
569{
570 struct perf_evsel *pos;
571 struct perf_top *top = arg;
572 const char *help = "For a higher level overview, try: perf top --sort comm,dso";
573 struct hist_browser_timer hbt = {
574 .timer = perf_top__sort_new_samples,
575 .arg = top,
576 .refresh = top->delay_secs,
577 };
578
579 perf_top__sort_new_samples(top);
580
581 /*
582 * Initialize the uid_filter_str, in the future the TUI will allow
583 * Zooming in/out UIDs. For now juse use whatever the user passed
584 * via --uid.
585 */
586 evlist__for_each(top->evlist, pos) {
587 struct hists *hists = evsel__hists(pos);
588 hists->uid_filter_str = top->record_opts.target.uid_str;
589 }
590
591 perf_evlist__tui_browse_hists(top->evlist, help, &hbt,
592 top->min_percent,
593 &top->session->header.env);
594
595 done = 1;
596 return NULL;
597}
598
599static void display_sig(int sig __maybe_unused)
600{
601 done = 1;
602}
603
604static void display_setup_sig(void)
605{
606 signal(SIGSEGV, sighandler_dump_stack);
607 signal(SIGFPE, sighandler_dump_stack);
608 signal(SIGINT, display_sig);
609 signal(SIGQUIT, display_sig);
610 signal(SIGTERM, display_sig);
611}
612
613static void *display_thread(void *arg)
614{
615 struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
616 struct termios save;
617 struct perf_top *top = arg;
618 int delay_msecs, c;
619
620 display_setup_sig();
621 pthread__unblock_sigwinch();
622repeat:
623 delay_msecs = top->delay_secs * 1000;
624 set_term_quiet_input(&save);
625 /* trash return*/
626 getc(stdin);
627
628 while (!done) {
629 perf_top__print_sym_table(top);
630 /*
631 * Either timeout expired or we got an EINTR due to SIGWINCH,
632 * refresh screen in both cases.
633 */
634 switch (poll(&stdin_poll, 1, delay_msecs)) {
635 case 0:
636 continue;
637 case -1:
638 if (errno == EINTR)
639 continue;
640 /* Fall trhu */
641 default:
642 c = getc(stdin);
643 tcsetattr(0, TCSAFLUSH, &save);
644
645 if (perf_top__handle_keypress(top, c))
646 goto repeat;
647 done = 1;
648 }
649 }
650
651 tcsetattr(0, TCSAFLUSH, &save);
652 return NULL;
653}
654
655static int symbol_filter(struct map *map, struct symbol *sym)
656{
657 const char *name = sym->name;
658
659 if (!__map__is_kernel(map))
660 return 0;
661 /*
662 * ppc64 uses function descriptors and appends a '.' to the
663 * start of every instruction address. Remove it.
664 */
665 if (name[0] == '.')
666 name++;
667
668 if (!strcmp(name, "_text") ||
669 !strcmp(name, "_etext") ||
670 !strcmp(name, "_sinittext") ||
671 !strncmp("init_module", name, 11) ||
672 !strncmp("cleanup_module", name, 14) ||
673 strstr(name, "_text_start") ||
674 strstr(name, "_text_end"))
675 return 1;
676
677 if (symbol__is_idle(sym))
678 sym->ignore = true;
679
680 return 0;
681}
682
683static int hist_iter__top_callback(struct hist_entry_iter *iter,
684 struct addr_location *al, bool single,
685 void *arg)
686{
687 struct perf_top *top = arg;
688 struct hist_entry *he = iter->he;
689 struct perf_evsel *evsel = iter->evsel;
690
691 if (sort__has_sym && single)
692 perf_top__record_precise_ip(top, he, evsel->idx, al->addr);
693
694 hist__account_cycles(iter->sample->branch_stack, al, iter->sample,
695 !(top->record_opts.branch_stack & PERF_SAMPLE_BRANCH_ANY));
696 return 0;
697}
698
699static void perf_event__process_sample(struct perf_tool *tool,
700 const union perf_event *event,
701 struct perf_evsel *evsel,
702 struct perf_sample *sample,
703 struct machine *machine)
704{
705 struct perf_top *top = container_of(tool, struct perf_top, tool);
706 struct addr_location al;
707 int err;
708
709 if (!machine && perf_guest) {
710 static struct intlist *seen;
711
712 if (!seen)
713 seen = intlist__new(NULL);
714
715 if (!intlist__has_entry(seen, sample->pid)) {
716 pr_err("Can't find guest [%d]'s kernel information\n",
717 sample->pid);
718 intlist__add(seen, sample->pid);
719 }
720 return;
721 }
722
723 if (!machine) {
724 pr_err("%u unprocessable samples recorded.\r",
725 top->session->evlist->stats.nr_unprocessable_samples++);
726 return;
727 }
728
729 if (event->header.misc & PERF_RECORD_MISC_EXACT_IP)
730 top->exact_samples++;
731
732 if (machine__resolve(machine, &al, sample) < 0)
733 return;
734
735 if (!top->kptr_restrict_warned &&
736 symbol_conf.kptr_restrict &&
737 al.cpumode == PERF_RECORD_MISC_KERNEL) {
738 ui__warning(
739"Kernel address maps (/proc/{kallsyms,modules}) are restricted.\n\n"
740"Check /proc/sys/kernel/kptr_restrict.\n\n"
741"Kernel%s samples will not be resolved.\n",
742 al.map && !RB_EMPTY_ROOT(&al.map->dso->symbols[MAP__FUNCTION]) ?
743 " modules" : "");
744 if (use_browser <= 0)
745 sleep(5);
746 top->kptr_restrict_warned = true;
747 }
748
749 if (al.sym == NULL) {
750 const char *msg = "Kernel samples will not be resolved.\n";
751 /*
752 * As we do lazy loading of symtabs we only will know if the
753 * specified vmlinux file is invalid when we actually have a
754 * hit in kernel space and then try to load it. So if we get
755 * here and there are _no_ symbols in the DSO backing the
756 * kernel map, bail out.
757 *
758 * We may never get here, for instance, if we use -K/
759 * --hide-kernel-symbols, even if the user specifies an
760 * invalid --vmlinux ;-)
761 */
762 if (!top->kptr_restrict_warned && !top->vmlinux_warned &&
763 al.map == machine->vmlinux_maps[MAP__FUNCTION] &&
764 RB_EMPTY_ROOT(&al.map->dso->symbols[MAP__FUNCTION])) {
765 if (symbol_conf.vmlinux_name) {
766 char serr[256];
767 dso__strerror_load(al.map->dso, serr, sizeof(serr));
768 ui__warning("The %s file can't be used: %s\n%s",
769 symbol_conf.vmlinux_name, serr, msg);
770 } else {
771 ui__warning("A vmlinux file was not found.\n%s",
772 msg);
773 }
774
775 if (use_browser <= 0)
776 sleep(5);
777 top->vmlinux_warned = true;
778 }
779 }
780
781 if (al.sym == NULL || !al.sym->ignore) {
782 struct hists *hists = evsel__hists(evsel);
783 struct hist_entry_iter iter = {
784 .evsel = evsel,
785 .sample = sample,
786 .add_entry_cb = hist_iter__top_callback,
787 };
788
789 if (symbol_conf.cumulate_callchain)
790 iter.ops = &hist_iter_cumulative;
791 else
792 iter.ops = &hist_iter_normal;
793
794 pthread_mutex_lock(&hists->lock);
795
796 err = hist_entry_iter__add(&iter, &al, top->max_stack, top);
797 if (err < 0)
798 pr_err("Problem incrementing symbol period, skipping event\n");
799
800 pthread_mutex_unlock(&hists->lock);
801 }
802
803 addr_location__put(&al);
804}
805
806static void perf_top__mmap_read_idx(struct perf_top *top, int idx)
807{
808 struct perf_sample sample;
809 struct perf_evsel *evsel;
810 struct perf_session *session = top->session;
811 union perf_event *event;
812 struct machine *machine;
813 int ret;
814
815 while ((event = perf_evlist__mmap_read(top->evlist, idx)) != NULL) {
816 ret = perf_evlist__parse_sample(top->evlist, event, &sample);
817 if (ret) {
818 pr_err("Can't parse sample, err = %d\n", ret);
819 goto next_event;
820 }
821
822 evsel = perf_evlist__id2evsel(session->evlist, sample.id);
823 assert(evsel != NULL);
824
825 if (event->header.type == PERF_RECORD_SAMPLE)
826 ++top->samples;
827
828 switch (sample.cpumode) {
829 case PERF_RECORD_MISC_USER:
830 ++top->us_samples;
831 if (top->hide_user_symbols)
832 goto next_event;
833 machine = &session->machines.host;
834 break;
835 case PERF_RECORD_MISC_KERNEL:
836 ++top->kernel_samples;
837 if (top->hide_kernel_symbols)
838 goto next_event;
839 machine = &session->machines.host;
840 break;
841 case PERF_RECORD_MISC_GUEST_KERNEL:
842 ++top->guest_kernel_samples;
843 machine = perf_session__find_machine(session,
844 sample.pid);
845 break;
846 case PERF_RECORD_MISC_GUEST_USER:
847 ++top->guest_us_samples;
848 /*
849 * TODO: we don't process guest user from host side
850 * except simple counting.
851 */
852 goto next_event;
853 default:
854 if (event->header.type == PERF_RECORD_SAMPLE)
855 goto next_event;
856 machine = &session->machines.host;
857 break;
858 }
859
860
861 if (event->header.type == PERF_RECORD_SAMPLE) {
862 perf_event__process_sample(&top->tool, event, evsel,
863 &sample, machine);
864 } else if (event->header.type < PERF_RECORD_MAX) {
865 hists__inc_nr_events(evsel__hists(evsel), event->header.type);
866 machine__process_event(machine, event, &sample);
867 } else
868 ++session->evlist->stats.nr_unknown_events;
869next_event:
870 perf_evlist__mmap_consume(top->evlist, idx);
871 }
872}
873
874static void perf_top__mmap_read(struct perf_top *top)
875{
876 int i;
877
878 for (i = 0; i < top->evlist->nr_mmaps; i++)
879 perf_top__mmap_read_idx(top, i);
880}
881
882static int perf_top__start_counters(struct perf_top *top)
883{
884 char msg[512];
885 struct perf_evsel *counter;
886 struct perf_evlist *evlist = top->evlist;
887 struct record_opts *opts = &top->record_opts;
888
889 perf_evlist__config(evlist, opts);
890
891 evlist__for_each(evlist, counter) {
892try_again:
893 if (perf_evsel__open(counter, top->evlist->cpus,
894 top->evlist->threads) < 0) {
895 if (perf_evsel__fallback(counter, errno, msg, sizeof(msg))) {
896 if (verbose)
897 ui__warning("%s\n", msg);
898 goto try_again;
899 }
900
901 perf_evsel__open_strerror(counter, &opts->target,
902 errno, msg, sizeof(msg));
903 ui__error("%s\n", msg);
904 goto out_err;
905 }
906 }
907
908 if (perf_evlist__mmap(evlist, opts->mmap_pages, false) < 0) {
909 ui__error("Failed to mmap with %d (%s)\n",
910 errno, strerror_r(errno, msg, sizeof(msg)));
911 goto out_err;
912 }
913
914 return 0;
915
916out_err:
917 return -1;
918}
919
920static int perf_top__setup_sample_type(struct perf_top *top __maybe_unused)
921{
922 if (!sort__has_sym) {
923 if (symbol_conf.use_callchain) {
924 ui__error("Selected -g but \"sym\" not present in --sort/-s.");
925 return -EINVAL;
926 }
927 } else if (callchain_param.mode != CHAIN_NONE) {
928 if (callchain_register_param(&callchain_param) < 0) {
929 ui__error("Can't register callchain params.\n");
930 return -EINVAL;
931 }
932 }
933
934 return 0;
935}
936
937static int __cmd_top(struct perf_top *top)
938{
939 struct record_opts *opts = &top->record_opts;
940 pthread_t thread;
941 int ret;
942
943 top->session = perf_session__new(NULL, false, NULL);
944 if (top->session == NULL)
945 return -1;
946
947 machines__set_symbol_filter(&top->session->machines, symbol_filter);
948
949 if (!objdump_path) {
950 ret = perf_env__lookup_objdump(&top->session->header.env);
951 if (ret)
952 goto out_delete;
953 }
954
955 ret = perf_top__setup_sample_type(top);
956 if (ret)
957 goto out_delete;
958
959 if (perf_session__register_idle_thread(top->session) < 0)
960 goto out_delete;
961
962 machine__synthesize_threads(&top->session->machines.host, &opts->target,
963 top->evlist->threads, false, opts->proc_map_timeout);
964
965 if (sort__has_socket) {
966 ret = perf_env__read_cpu_topology_map(&perf_env);
967 if (ret < 0)
968 goto out_err_cpu_topo;
969 }
970
971 ret = perf_top__start_counters(top);
972 if (ret)
973 goto out_delete;
974
975 top->session->evlist = top->evlist;
976 perf_session__set_id_hdr_size(top->session);
977
978 /*
979 * When perf is starting the traced process, all the events (apart from
980 * group members) have enable_on_exec=1 set, so don't spoil it by
981 * prematurely enabling them.
982 *
983 * XXX 'top' still doesn't start workloads like record, trace, but should,
984 * so leave the check here.
985 */
986 if (!target__none(&opts->target))
987 perf_evlist__enable(top->evlist);
988
989 /* Wait for a minimal set of events before starting the snapshot */
990 perf_evlist__poll(top->evlist, 100);
991
992 perf_top__mmap_read(top);
993
994 ret = -1;
995 if (pthread_create(&thread, NULL, (use_browser > 0 ? display_thread_tui :
996 display_thread), top)) {
997 ui__error("Could not create display thread.\n");
998 goto out_delete;
999 }
1000
1001 if (top->realtime_prio) {
1002 struct sched_param param;
1003
1004 param.sched_priority = top->realtime_prio;
1005 if (sched_setscheduler(0, SCHED_FIFO, ¶m)) {
1006 ui__error("Could not set realtime priority.\n");
1007 goto out_join;
1008 }
1009 }
1010
1011 while (!done) {
1012 u64 hits = top->samples;
1013
1014 perf_top__mmap_read(top);
1015
1016 if (hits == top->samples)
1017 ret = perf_evlist__poll(top->evlist, 100);
1018 }
1019
1020 ret = 0;
1021out_join:
1022 pthread_join(thread, NULL);
1023out_delete:
1024 perf_session__delete(top->session);
1025 top->session = NULL;
1026
1027 return ret;
1028
1029out_err_cpu_topo: {
1030 char errbuf[BUFSIZ];
1031 const char *err = strerror_r(-ret, errbuf, sizeof(errbuf));
1032
1033 ui__error("Could not read the CPU topology map: %s\n", err);
1034 goto out_delete;
1035}
1036}
1037
1038static int
1039callchain_opt(const struct option *opt, const char *arg, int unset)
1040{
1041 symbol_conf.use_callchain = true;
1042 return record_callchain_opt(opt, arg, unset);
1043}
1044
1045static int
1046parse_callchain_opt(const struct option *opt, const char *arg, int unset)
1047{
1048 struct record_opts *record = (struct record_opts *)opt->value;
1049
1050 record->callgraph_set = true;
1051 callchain_param.enabled = !unset;
1052 callchain_param.record_mode = CALLCHAIN_FP;
1053
1054 /*
1055 * --no-call-graph
1056 */
1057 if (unset) {
1058 symbol_conf.use_callchain = false;
1059 callchain_param.record_mode = CALLCHAIN_NONE;
1060 return 0;
1061 }
1062
1063 return parse_callchain_top_opt(arg);
1064}
1065
1066static int perf_top_config(const char *var, const char *value, void *cb __maybe_unused)
1067{
1068 if (!strcmp(var, "top.call-graph"))
1069 var = "call-graph.record-mode"; /* fall-through */
1070 if (!strcmp(var, "top.children")) {
1071 symbol_conf.cumulate_callchain = perf_config_bool(var, value);
1072 return 0;
1073 }
1074
1075 return 0;
1076}
1077
1078static int
1079parse_percent_limit(const struct option *opt, const char *arg,
1080 int unset __maybe_unused)
1081{
1082 struct perf_top *top = opt->value;
1083
1084 top->min_percent = strtof(arg, NULL);
1085 return 0;
1086}
1087
1088const char top_callchain_help[] = CALLCHAIN_RECORD_HELP CALLCHAIN_REPORT_HELP
1089 "\n\t\t\t\tDefault: fp,graph,0.5,caller,function";
1090
1091int cmd_top(int argc, const char **argv, const char *prefix __maybe_unused)
1092{
1093 char errbuf[BUFSIZ];
1094 struct perf_top top = {
1095 .count_filter = 5,
1096 .delay_secs = 2,
1097 .record_opts = {
1098 .mmap_pages = UINT_MAX,
1099 .user_freq = UINT_MAX,
1100 .user_interval = ULLONG_MAX,
1101 .freq = 4000, /* 4 KHz */
1102 .target = {
1103 .uses_mmap = true,
1104 },
1105 .proc_map_timeout = 500,
1106 },
1107 .max_stack = PERF_MAX_STACK_DEPTH,
1108 .sym_pcnt_filter = 5,
1109 };
1110 struct record_opts *opts = &top.record_opts;
1111 struct target *target = &opts->target;
1112 const struct option options[] = {
1113 OPT_CALLBACK('e', "event", &top.evlist, "event",
1114 "event selector. use 'perf list' to list available events",
1115 parse_events_option),
1116 OPT_U64('c', "count", &opts->user_interval, "event period to sample"),
1117 OPT_STRING('p', "pid", &target->pid, "pid",
1118 "profile events on existing process id"),
1119 OPT_STRING('t', "tid", &target->tid, "tid",
1120 "profile events on existing thread id"),
1121 OPT_BOOLEAN('a', "all-cpus", &target->system_wide,
1122 "system-wide collection from all CPUs"),
1123 OPT_STRING('C', "cpu", &target->cpu_list, "cpu",
1124 "list of cpus to monitor"),
1125 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1126 "file", "vmlinux pathname"),
1127 OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux,
1128 "don't load vmlinux even if found"),
1129 OPT_BOOLEAN('K', "hide_kernel_symbols", &top.hide_kernel_symbols,
1130 "hide kernel symbols"),
1131 OPT_CALLBACK('m', "mmap-pages", &opts->mmap_pages, "pages",
1132 "number of mmap data pages",
1133 perf_evlist__parse_mmap_pages),
1134 OPT_INTEGER('r', "realtime", &top.realtime_prio,
1135 "collect data with this RT SCHED_FIFO priority"),
1136 OPT_INTEGER('d', "delay", &top.delay_secs,
1137 "number of seconds to delay between refreshes"),
1138 OPT_BOOLEAN('D', "dump-symtab", &top.dump_symtab,
1139 "dump the symbol table used for profiling"),
1140 OPT_INTEGER('f', "count-filter", &top.count_filter,
1141 "only display functions with more events than this"),
1142 OPT_BOOLEAN(0, "group", &opts->group,
1143 "put the counters into a counter group"),
1144 OPT_BOOLEAN('i', "no-inherit", &opts->no_inherit,
1145 "child tasks do not inherit counters"),
1146 OPT_STRING(0, "sym-annotate", &top.sym_filter, "symbol name",
1147 "symbol to annotate"),
1148 OPT_BOOLEAN('z', "zero", &top.zero, "zero history across updates"),
1149 OPT_UINTEGER('F', "freq", &opts->user_freq, "profile at this frequency"),
1150 OPT_INTEGER('E', "entries", &top.print_entries,
1151 "display this many functions"),
1152 OPT_BOOLEAN('U', "hide_user_symbols", &top.hide_user_symbols,
1153 "hide user symbols"),
1154 OPT_BOOLEAN(0, "tui", &top.use_tui, "Use the TUI interface"),
1155 OPT_BOOLEAN(0, "stdio", &top.use_stdio, "Use the stdio interface"),
1156 OPT_INCR('v', "verbose", &verbose,
1157 "be more verbose (show counter open errors, etc)"),
1158 OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
1159 "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
1160 " Please refer the man page for the complete list."),
1161 OPT_STRING(0, "fields", &field_order, "key[,keys...]",
1162 "output field(s): overhead, period, sample plus all of sort keys"),
1163 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
1164 "Show a column with the number of samples"),
1165 OPT_CALLBACK_NOOPT('g', NULL, &top.record_opts,
1166 NULL, "enables call-graph recording and display",
1167 &callchain_opt),
1168 OPT_CALLBACK(0, "call-graph", &top.record_opts,
1169 "record_mode[,record_size],print_type,threshold[,print_limit],order,sort_key[,branch]",
1170 top_callchain_help, &parse_callchain_opt),
1171 OPT_BOOLEAN(0, "children", &symbol_conf.cumulate_callchain,
1172 "Accumulate callchains of children and show total overhead as well"),
1173 OPT_INTEGER(0, "max-stack", &top.max_stack,
1174 "Set the maximum stack depth when parsing the callchain. "
1175 "Default: " __stringify(PERF_MAX_STACK_DEPTH)),
1176 OPT_CALLBACK(0, "ignore-callees", NULL, "regex",
1177 "ignore callees of these functions in call graphs",
1178 report_parse_ignore_callees_opt),
1179 OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
1180 "Show a column with the sum of periods"),
1181 OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
1182 "only consider symbols in these dsos"),
1183 OPT_STRING(0, "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1184 "only consider symbols in these comms"),
1185 OPT_STRING(0, "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1186 "only consider these symbols"),
1187 OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
1188 "Interleave source code with assembly code (default)"),
1189 OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
1190 "Display raw encoding of assembly instructions (default)"),
1191 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
1192 "Enable kernel symbol demangling"),
1193 OPT_STRING(0, "objdump", &objdump_path, "path",
1194 "objdump binary to use for disassembly and annotations"),
1195 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
1196 "Specify disassembler style (e.g. -M intel for intel syntax)"),
1197 OPT_STRING('u', "uid", &target->uid_str, "user", "user to profile"),
1198 OPT_CALLBACK(0, "percent-limit", &top, "percent",
1199 "Don't show entries under that percent", parse_percent_limit),
1200 OPT_CALLBACK(0, "percentage", NULL, "relative|absolute",
1201 "How to display percentage of filtered entries", parse_filter_percentage),
1202 OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
1203 "width[,width...]",
1204 "don't try to adjust column width, use these fixed values"),
1205 OPT_UINTEGER(0, "proc-map-timeout", &opts->proc_map_timeout,
1206 "per thread proc mmap processing timeout in ms"),
1207 OPT_CALLBACK_NOOPT('b', "branch-any", &opts->branch_stack,
1208 "branch any", "sample any taken branches",
1209 parse_branch_stack),
1210 OPT_CALLBACK('j', "branch-filter", &opts->branch_stack,
1211 "branch filter mask", "branch stack filter modes",
1212 parse_branch_stack),
1213 OPT_BOOLEAN(0, "raw-trace", &symbol_conf.raw_trace,
1214 "Show raw trace event output (do not use print fmt or plugins)"),
1215 OPT_BOOLEAN(0, "hierarchy", &symbol_conf.report_hierarchy,
1216 "Show entries in a hierarchy"),
1217 OPT_END()
1218 };
1219 const char * const top_usage[] = {
1220 "perf top [<options>]",
1221 NULL
1222 };
1223 int status = hists__init();
1224
1225 if (status < 0)
1226 return status;
1227
1228 top.evlist = perf_evlist__new();
1229 if (top.evlist == NULL)
1230 return -ENOMEM;
1231
1232 perf_config(perf_top_config, &top);
1233
1234 argc = parse_options(argc, argv, options, top_usage, 0);
1235 if (argc)
1236 usage_with_options(top_usage, options);
1237
1238 if (!top.evlist->nr_entries &&
1239 perf_evlist__add_default(top.evlist) < 0) {
1240 pr_err("Not enough memory for event selector list\n");
1241 goto out_delete_evlist;
1242 }
1243
1244 if (symbol_conf.report_hierarchy) {
1245 /* disable incompatible options */
1246 symbol_conf.event_group = false;
1247 symbol_conf.cumulate_callchain = false;
1248
1249 if (field_order) {
1250 pr_err("Error: --hierarchy and --fields options cannot be used together\n");
1251 parse_options_usage(top_usage, options, "fields", 0);
1252 parse_options_usage(NULL, options, "hierarchy", 0);
1253 goto out_delete_evlist;
1254 }
1255 }
1256
1257 sort__mode = SORT_MODE__TOP;
1258 /* display thread wants entries to be collapsed in a different tree */
1259 sort__need_collapse = 1;
1260
1261 if (top.use_stdio)
1262 use_browser = 0;
1263 else if (top.use_tui)
1264 use_browser = 1;
1265
1266 setup_browser(false);
1267
1268 if (setup_sorting(top.evlist) < 0) {
1269 if (sort_order)
1270 parse_options_usage(top_usage, options, "s", 1);
1271 if (field_order)
1272 parse_options_usage(sort_order ? NULL : top_usage,
1273 options, "fields", 0);
1274 goto out_delete_evlist;
1275 }
1276
1277 status = target__validate(target);
1278 if (status) {
1279 target__strerror(target, status, errbuf, BUFSIZ);
1280 ui__warning("%s\n", errbuf);
1281 }
1282
1283 status = target__parse_uid(target);
1284 if (status) {
1285 int saved_errno = errno;
1286
1287 target__strerror(target, status, errbuf, BUFSIZ);
1288 ui__error("%s\n", errbuf);
1289
1290 status = -saved_errno;
1291 goto out_delete_evlist;
1292 }
1293
1294 if (target__none(target))
1295 target->system_wide = true;
1296
1297 if (perf_evlist__create_maps(top.evlist, target) < 0) {
1298 ui__error("Couldn't create thread/CPU maps: %s\n",
1299 errno == ENOENT ? "No such process" : strerror_r(errno, errbuf, sizeof(errbuf)));
1300 goto out_delete_evlist;
1301 }
1302
1303 symbol_conf.nr_events = top.evlist->nr_entries;
1304
1305 if (top.delay_secs < 1)
1306 top.delay_secs = 1;
1307
1308 if (record_opts__config(opts)) {
1309 status = -EINVAL;
1310 goto out_delete_evlist;
1311 }
1312
1313 top.sym_evsel = perf_evlist__first(top.evlist);
1314
1315 if (!symbol_conf.use_callchain) {
1316 symbol_conf.cumulate_callchain = false;
1317 perf_hpp__cancel_cumulate();
1318 }
1319
1320 if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
1321 callchain_param.order = ORDER_CALLER;
1322
1323 symbol_conf.priv_size = sizeof(struct annotation);
1324
1325 symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
1326 if (symbol__init(NULL) < 0)
1327 return -1;
1328
1329 sort__setup_elide(stdout);
1330
1331 get_term_dimensions(&top.winsize);
1332 if (top.print_entries == 0) {
1333 struct sigaction act = {
1334 .sa_sigaction = perf_top__sig_winch,
1335 .sa_flags = SA_SIGINFO,
1336 };
1337 perf_top__update_print_entries(&top);
1338 sigaction(SIGWINCH, &act, NULL);
1339 }
1340
1341 status = __cmd_top(&top);
1342
1343out_delete_evlist:
1344 perf_evlist__delete(top.evlist);
1345
1346 return status;
1347}