4 * Builtin top command: Display a continuously updated profile of
5 * any workload, CPU or specific PID.
7 * Copyright (C) 2008, Red Hat Inc, Ingo Molnar <mingo@redhat.com>
8 * 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
10 * Improvements and fixes by:
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>
18 * Released under the GPL v2. (and only v2, not any later version)
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"
35 #include "util/util.h"
36 #include <linux/rbtree.h>
37 #include "util/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"
46 #include "util/debug.h"
61 #include <sys/syscall.h>
62 #include <sys/ioctl.h>
64 #include <sys/prctl.h>
67 #include <sys/utsname.h>
70 #include <linux/types.h>
72 static volatile int done
;
74 #define HEADER_LINE_NR 5
76 static void perf_top__update_print_entries(struct perf_top
*top
)
78 top
->print_entries
= top
->winsize
.ws_row
- HEADER_LINE_NR
;
81 static void perf_top__sig_winch(int sig __maybe_unused
,
82 siginfo_t
*info __maybe_unused
, void *arg
)
84 struct perf_top
*top
= arg
;
86 get_term_dimensions(&top
->winsize
);
87 perf_top__update_print_entries(top
);
90 static int perf_top__parse_source(struct perf_top
*top
, struct hist_entry
*he
)
93 struct annotation
*notes
;
97 if (!he
|| !he
->ms
.sym
)
104 * We can't annotate with just /proc/kallsyms
106 if (map
->dso
->symtab_type
== DSO_BINARY_TYPE__KALLSYMS
&&
107 !dso__is_kcore(map
->dso
)) {
108 pr_err("Can't annotate %s: No vmlinux file was found in the "
109 "path\n", sym
->name
);
114 notes
= symbol__annotation(sym
);
115 if (notes
->src
!= NULL
) {
116 pthread_mutex_lock(¬es
->lock
);
120 pthread_mutex_lock(¬es
->lock
);
122 if (symbol__alloc_hist(sym
) < 0) {
123 pthread_mutex_unlock(¬es
->lock
);
124 pr_err("Not enough memory for annotating '%s' symbol!\n",
130 err
= symbol__annotate(sym
, map
, 0);
133 top
->sym_filter_entry
= he
;
136 pthread_mutex_unlock(¬es
->lock
);
140 static void __zero_source_counters(struct hist_entry
*he
)
142 struct symbol
*sym
= he
->ms
.sym
;
143 symbol__annotate_zero_histograms(sym
);
146 static void ui__warn_map_erange(struct map
*map
, struct symbol
*sym
, u64 ip
)
149 int err
= uname(&uts
);
151 ui__warning("Out of bounds address found:\n\n"
152 "Addr: %" PRIx64
"\n"
154 "Map: %" PRIx64
"-%" PRIx64
"\n"
155 "Symbol: %" PRIx64
"-%" PRIx64
" %c %s\n"
159 "Not all samples will be on the annotation output.\n\n"
160 "Please report to linux-kernel@vger.kernel.org\n",
161 ip
, map
->dso
->long_name
, dso__symtab_origin(map
->dso
),
162 map
->start
, map
->end
, sym
->start
, sym
->end
,
163 sym
->binding
== STB_GLOBAL
? 'g' :
164 sym
->binding
== STB_LOCAL
? 'l' : 'w', sym
->name
,
165 err
? "[unknown]" : uts
.machine
,
166 err
? "[unknown]" : uts
.release
, perf_version_string
);
167 if (use_browser
<= 0)
170 map
->erange_warned
= true;
173 static void perf_top__record_precise_ip(struct perf_top
*top
,
174 struct hist_entry
*he
,
177 struct annotation
*notes
;
181 if (he
== NULL
|| he
->ms
.sym
== NULL
||
182 ((top
->sym_filter_entry
== NULL
||
183 top
->sym_filter_entry
->ms
.sym
!= he
->ms
.sym
) && use_browser
!= 1))
187 notes
= symbol__annotation(sym
);
189 if (pthread_mutex_trylock(¬es
->lock
))
192 ip
= he
->ms
.map
->map_ip(he
->ms
.map
, ip
);
194 if (ui__has_annotation())
195 err
= hist_entry__inc_addr_samples(he
, counter
, ip
);
197 pthread_mutex_unlock(¬es
->lock
);
200 * This function is now called with he->hists->lock held.
201 * Release it before going to sleep.
203 pthread_mutex_unlock(&he
->hists
->lock
);
205 if (err
== -ERANGE
&& !he
->ms
.map
->erange_warned
)
206 ui__warn_map_erange(he
->ms
.map
, sym
, ip
);
207 else if (err
== -ENOMEM
) {
208 pr_err("Not enough memory for annotating '%s' symbol!\n",
213 pthread_mutex_lock(&he
->hists
->lock
);
216 static void perf_top__show_details(struct perf_top
*top
)
218 struct hist_entry
*he
= top
->sym_filter_entry
;
219 struct annotation
*notes
;
220 struct symbol
*symbol
;
227 notes
= symbol__annotation(symbol
);
229 pthread_mutex_lock(¬es
->lock
);
231 if (notes
->src
== NULL
)
234 printf("Showing %s for %s\n", perf_evsel__name(top
->sym_evsel
), symbol
->name
);
235 printf(" Events Pcnt (>=%d%%)\n", top
->sym_pcnt_filter
);
237 more
= symbol__annotate_printf(symbol
, he
->ms
.map
, top
->sym_evsel
,
238 0, top
->sym_pcnt_filter
, top
->print_entries
, 4);
240 if (top
->evlist
->enabled
) {
242 symbol__annotate_zero_histogram(symbol
, top
->sym_evsel
->idx
);
244 symbol__annotate_decay_histogram(symbol
, top
->sym_evsel
->idx
);
247 printf("%d lines not displayed, maybe increase display entries [e]\n", more
);
249 pthread_mutex_unlock(¬es
->lock
);
252 static void perf_top__print_sym_table(struct perf_top
*top
)
256 const int win_width
= top
->winsize
.ws_col
- 1;
257 struct hists
*hists
= evsel__hists(top
->sym_evsel
);
261 perf_top__header_snprintf(top
, bf
, sizeof(bf
));
264 perf_top__reset_sample_counters(top
);
266 printf("%-*.*s\n", win_width
, win_width
, graph_dotted_line
);
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
);
278 if (top
->sym_filter_entry
) {
279 perf_top__show_details(top
);
283 if (top
->evlist
->enabled
) {
285 hists__delete_entries(hists
);
287 hists__decay_entries(hists
, top
->hide_user_symbols
,
288 top
->hide_kernel_symbols
);
292 hists__collapse_resort(hists
, NULL
);
293 hists__output_resort(hists
, NULL
);
295 hists__output_recalc_col_len(hists
, top
->print_entries
- printed
);
297 hists__fprintf(hists
, false, top
->print_entries
- printed
, win_width
,
298 top
->min_percent
, stdout
);
301 static void prompt_integer(int *target
, const char *msg
)
303 char *buf
= malloc(0), *p
;
307 fprintf(stdout
, "\n%s: ", msg
);
308 if (getline(&buf
, &dummy
, stdin
) < 0)
311 p
= strchr(buf
, '\n');
321 tmp
= strtoul(buf
, NULL
, 10);
327 static void prompt_percent(int *target
, const char *msg
)
331 prompt_integer(&tmp
, msg
);
332 if (tmp
>= 0 && tmp
<= 100)
336 static void perf_top__prompt_symbol(struct perf_top
*top
, const char *msg
)
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
;
344 /* zero counters of active symbol */
346 __zero_source_counters(syme
);
347 top
->sym_filter_entry
= NULL
;
350 fprintf(stdout
, "\n%s: ", msg
);
351 if (getline(&buf
, &dummy
, stdin
) < 0)
354 p
= strchr(buf
, '\n');
358 next
= rb_first(&hists
->entries
);
360 n
= rb_entry(next
, struct hist_entry
, rb_node
);
361 if (n
->ms
.sym
&& !strcmp(buf
, n
->ms
.sym
->name
)) {
365 next
= rb_next(&n
->rb_node
);
369 fprintf(stderr
, "Sorry, %s is not active.\n", buf
);
372 perf_top__parse_source(top
, found
);
378 static void perf_top__print_mapped_keys(struct perf_top
*top
)
382 if (top
->sym_filter_entry
) {
383 struct symbol
*sym
= top
->sym_filter_entry
->ms
.sym
;
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
);
391 if (top
->evlist
->nr_entries
> 1)
392 fprintf(stdout
, "\t[E] active event counter. \t(%s)\n", perf_evsel__name(top
->sym_evsel
));
394 fprintf(stdout
, "\t[f] profile display filter (count). \t(%d)\n", top
->count_filter
);
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");
401 "\t[K] hide kernel_symbols symbols. \t(%s)\n",
402 top
->hide_kernel_symbols
? "yes" : "no");
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");
410 static int perf_top__key_mapped(struct perf_top
*top
, int c
)
426 return top
->evlist
->nr_entries
> 1 ? 1 : 0;
434 static bool perf_top__handle_keypress(struct perf_top
*top
, int c
)
438 if (!perf_top__key_mapped(top
, c
)) {
439 struct pollfd stdin_poll
= { .fd
= 0, .events
= POLLIN
};
442 perf_top__print_mapped_keys(top
);
443 fprintf(stdout
, "\nEnter selection, or unmapped key to continue: ");
446 set_term_quiet_input(&save
);
448 poll(&stdin_poll
, 1, -1);
451 tcsetattr(0, TCSAFLUSH
, &save
);
452 if (!perf_top__key_mapped(top
, c
))
458 prompt_integer(&top
->delay_secs
, "Enter display delay");
459 if (top
->delay_secs
< 1)
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
,
469 perf_top__sig_winch(SIGWINCH
, NULL
, top
);
470 sigaction(SIGWINCH
, &act
, NULL
);
472 signal(SIGWINCH
, SIG_DFL
);
476 if (top
->evlist
->nr_entries
> 1) {
477 /* Select 0 as the default event: */
480 fprintf(stderr
, "\nAvailable events:");
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
));
485 prompt_integer(&counter
, "Enter details event counter");
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
));
493 evlist__for_each(top
->evlist
, top
->sym_evsel
)
494 if (top
->sym_evsel
->idx
== counter
)
497 top
->sym_evsel
= perf_evlist__first(top
->evlist
);
500 prompt_integer(&top
->count_filter
, "Enter display event count filter");
503 prompt_percent(&top
->sym_pcnt_filter
,
504 "Enter details display event filter (percent)");
507 top
->hide_kernel_symbols
= !top
->hide_kernel_symbols
;
511 printf("exiting.\n");
512 if (top
->dump_symtab
)
513 perf_session__fprintf_dsos(top
->session
, stderr
);
517 perf_top__prompt_symbol(top
, "Enter details symbol");
520 if (!top
->sym_filter_entry
)
523 struct hist_entry
*syme
= top
->sym_filter_entry
;
525 top
->sym_filter_entry
= NULL
;
526 __zero_source_counters(syme
);
530 top
->hide_user_symbols
= !top
->hide_user_symbols
;
533 top
->zero
= !top
->zero
;
542 static void perf_top__sort_new_samples(void *arg
)
544 struct perf_top
*t
= arg
;
547 perf_top__reset_sample_counters(t
);
549 if (t
->evlist
->selected
!= NULL
)
550 t
->sym_evsel
= t
->evlist
->selected
;
552 hists
= evsel__hists(t
->sym_evsel
);
554 if (t
->evlist
->enabled
) {
556 hists__delete_entries(hists
);
558 hists__decay_entries(hists
, t
->hide_user_symbols
,
559 t
->hide_kernel_symbols
);
563 hists__collapse_resort(hists
, NULL
);
564 hists__output_resort(hists
, NULL
);
567 static void *display_thread_tui(void *arg
)
569 struct perf_evsel
*pos
;
570 struct perf_top
*top
= arg
;
571 const char *help
= "For a higher level overview, try: perf top --sort comm,dso";
572 struct hist_browser_timer hbt
= {
573 .timer
= perf_top__sort_new_samples
,
575 .refresh
= top
->delay_secs
,
578 perf_top__sort_new_samples(top
);
581 * Initialize the uid_filter_str, in the future the TUI will allow
582 * Zooming in/out UIDs. For now juse use whatever the user passed
585 evlist__for_each(top
->evlist
, pos
) {
586 struct hists
*hists
= evsel__hists(pos
);
587 hists
->uid_filter_str
= top
->record_opts
.target
.uid_str
;
590 perf_evlist__tui_browse_hists(top
->evlist
, help
, &hbt
,
592 &top
->session
->header
.env
);
598 static void display_sig(int sig __maybe_unused
)
603 static void display_setup_sig(void)
605 signal(SIGSEGV
, sighandler_dump_stack
);
606 signal(SIGFPE
, sighandler_dump_stack
);
607 signal(SIGINT
, display_sig
);
608 signal(SIGQUIT
, display_sig
);
609 signal(SIGTERM
, display_sig
);
612 static void *display_thread(void *arg
)
614 struct pollfd stdin_poll
= { .fd
= 0, .events
= POLLIN
};
616 struct perf_top
*top
= arg
;
620 pthread__unblock_sigwinch();
622 delay_msecs
= top
->delay_secs
* 1000;
623 set_term_quiet_input(&save
);
628 perf_top__print_sym_table(top
);
630 * Either timeout expired or we got an EINTR due to SIGWINCH,
631 * refresh screen in both cases.
633 switch (poll(&stdin_poll
, 1, delay_msecs
)) {
642 tcsetattr(0, TCSAFLUSH
, &save
);
644 if (perf_top__handle_keypress(top
, c
))
650 tcsetattr(0, TCSAFLUSH
, &save
);
654 static int symbol_filter(struct map
*map
, struct symbol
*sym
)
656 const char *name
= sym
->name
;
658 if (!map
->dso
->kernel
)
661 * ppc64 uses function descriptors and appends a '.' to the
662 * start of every instruction address. Remove it.
667 if (!strcmp(name
, "_text") ||
668 !strcmp(name
, "_etext") ||
669 !strcmp(name
, "_sinittext") ||
670 !strncmp("init_module", name
, 11) ||
671 !strncmp("cleanup_module", name
, 14) ||
672 strstr(name
, "_text_start") ||
673 strstr(name
, "_text_end"))
676 if (symbol__is_idle(sym
))
682 static int hist_iter__top_callback(struct hist_entry_iter
*iter
,
683 struct addr_location
*al
, bool single
,
686 struct perf_top
*top
= arg
;
687 struct hist_entry
*he
= iter
->he
;
688 struct perf_evsel
*evsel
= iter
->evsel
;
690 if (sort__has_sym
&& single
) {
694 ip
= al
->map
->unmap_ip(al
->map
, ip
);
696 perf_top__record_precise_ip(top
, he
, evsel
->idx
, ip
);
699 hist__account_cycles(iter
->sample
->branch_stack
, al
, iter
->sample
,
700 !(top
->record_opts
.branch_stack
& PERF_SAMPLE_BRANCH_ANY
));
704 static void perf_event__process_sample(struct perf_tool
*tool
,
705 const union perf_event
*event
,
706 struct perf_evsel
*evsel
,
707 struct perf_sample
*sample
,
708 struct machine
*machine
)
710 struct perf_top
*top
= container_of(tool
, struct perf_top
, tool
);
711 struct addr_location al
;
714 if (!machine
&& perf_guest
) {
715 static struct intlist
*seen
;
718 seen
= intlist__new(NULL
);
720 if (!intlist__has_entry(seen
, sample
->pid
)) {
721 pr_err("Can't find guest [%d]'s kernel information\n",
723 intlist__add(seen
, sample
->pid
);
729 pr_err("%u unprocessable samples recorded.\r",
730 top
->session
->evlist
->stats
.nr_unprocessable_samples
++);
734 if (event
->header
.misc
& PERF_RECORD_MISC_EXACT_IP
)
735 top
->exact_samples
++;
737 if (perf_event__preprocess_sample(event
, machine
, &al
, sample
) < 0)
740 if (!top
->kptr_restrict_warned
&&
741 symbol_conf
.kptr_restrict
&&
742 al
.cpumode
== PERF_RECORD_MISC_KERNEL
) {
744 "Kernel address maps (/proc/{kallsyms,modules}) are restricted.\n\n"
745 "Check /proc/sys/kernel/kptr_restrict.\n\n"
746 "Kernel%s samples will not be resolved.\n",
747 al
.map
&& !RB_EMPTY_ROOT(&al
.map
->dso
->symbols
[MAP__FUNCTION
]) ?
749 if (use_browser
<= 0)
751 top
->kptr_restrict_warned
= true;
754 if (al
.sym
== NULL
) {
755 const char *msg
= "Kernel samples will not be resolved.\n";
757 * As we do lazy loading of symtabs we only will know if the
758 * specified vmlinux file is invalid when we actually have a
759 * hit in kernel space and then try to load it. So if we get
760 * here and there are _no_ symbols in the DSO backing the
761 * kernel map, bail out.
763 * We may never get here, for instance, if we use -K/
764 * --hide-kernel-symbols, even if the user specifies an
765 * invalid --vmlinux ;-)
767 if (!top
->kptr_restrict_warned
&& !top
->vmlinux_warned
&&
768 al
.map
== machine
->vmlinux_maps
[MAP__FUNCTION
] &&
769 RB_EMPTY_ROOT(&al
.map
->dso
->symbols
[MAP__FUNCTION
])) {
770 if (symbol_conf
.vmlinux_name
) {
772 dso__strerror_load(al
.map
->dso
, serr
, sizeof(serr
));
773 ui__warning("The %s file can't be used: %s\n%s",
774 symbol_conf
.vmlinux_name
, serr
, msg
);
776 ui__warning("A vmlinux file was not found.\n%s",
780 if (use_browser
<= 0)
782 top
->vmlinux_warned
= true;
786 if (al
.sym
== NULL
|| !al
.sym
->ignore
) {
787 struct hists
*hists
= evsel__hists(evsel
);
788 struct hist_entry_iter iter
= {
791 .add_entry_cb
= hist_iter__top_callback
,
794 if (symbol_conf
.cumulate_callchain
)
795 iter
.ops
= &hist_iter_cumulative
;
797 iter
.ops
= &hist_iter_normal
;
799 pthread_mutex_lock(&hists
->lock
);
801 err
= hist_entry_iter__add(&iter
, &al
, top
->max_stack
, top
);
803 pr_err("Problem incrementing symbol period, skipping event\n");
805 pthread_mutex_unlock(&hists
->lock
);
808 addr_location__put(&al
);
811 static void perf_top__mmap_read_idx(struct perf_top
*top
, int idx
)
813 struct perf_sample sample
;
814 struct perf_evsel
*evsel
;
815 struct perf_session
*session
= top
->session
;
816 union perf_event
*event
;
817 struct machine
*machine
;
821 while ((event
= perf_evlist__mmap_read(top
->evlist
, idx
)) != NULL
) {
822 ret
= perf_evlist__parse_sample(top
->evlist
, event
, &sample
);
824 pr_err("Can't parse sample, err = %d\n", ret
);
828 evsel
= perf_evlist__id2evsel(session
->evlist
, sample
.id
);
829 assert(evsel
!= NULL
);
831 origin
= event
->header
.misc
& PERF_RECORD_MISC_CPUMODE_MASK
;
833 if (event
->header
.type
== PERF_RECORD_SAMPLE
)
837 case PERF_RECORD_MISC_USER
:
839 if (top
->hide_user_symbols
)
841 machine
= &session
->machines
.host
;
843 case PERF_RECORD_MISC_KERNEL
:
844 ++top
->kernel_samples
;
845 if (top
->hide_kernel_symbols
)
847 machine
= &session
->machines
.host
;
849 case PERF_RECORD_MISC_GUEST_KERNEL
:
850 ++top
->guest_kernel_samples
;
851 machine
= perf_session__find_machine(session
,
854 case PERF_RECORD_MISC_GUEST_USER
:
855 ++top
->guest_us_samples
;
857 * TODO: we don't process guest user from host side
858 * except simple counting.
866 if (event
->header
.type
== PERF_RECORD_SAMPLE
) {
867 perf_event__process_sample(&top
->tool
, event
, evsel
,
869 } else if (event
->header
.type
< PERF_RECORD_MAX
) {
870 hists__inc_nr_events(evsel__hists(evsel
), event
->header
.type
);
871 machine__process_event(machine
, event
, &sample
);
873 ++session
->evlist
->stats
.nr_unknown_events
;
875 perf_evlist__mmap_consume(top
->evlist
, idx
);
879 static void perf_top__mmap_read(struct perf_top
*top
)
883 for (i
= 0; i
< top
->evlist
->nr_mmaps
; i
++)
884 perf_top__mmap_read_idx(top
, i
);
887 static int perf_top__start_counters(struct perf_top
*top
)
890 struct perf_evsel
*counter
;
891 struct perf_evlist
*evlist
= top
->evlist
;
892 struct record_opts
*opts
= &top
->record_opts
;
894 perf_evlist__config(evlist
, opts
);
896 evlist__for_each(evlist
, counter
) {
898 if (perf_evsel__open(counter
, top
->evlist
->cpus
,
899 top
->evlist
->threads
) < 0) {
900 if (perf_evsel__fallback(counter
, errno
, msg
, sizeof(msg
))) {
902 ui__warning("%s\n", msg
);
906 perf_evsel__open_strerror(counter
, &opts
->target
,
907 errno
, msg
, sizeof(msg
));
908 ui__error("%s\n", msg
);
913 if (perf_evlist__mmap(evlist
, opts
->mmap_pages
, false) < 0) {
914 ui__error("Failed to mmap with %d (%s)\n",
915 errno
, strerror_r(errno
, msg
, sizeof(msg
)));
925 static int perf_top__setup_sample_type(struct perf_top
*top __maybe_unused
)
927 if (!sort__has_sym
) {
928 if (symbol_conf
.use_callchain
) {
929 ui__error("Selected -g but \"sym\" not present in --sort/-s.");
932 } else if (callchain_param
.mode
!= CHAIN_NONE
) {
933 if (callchain_register_param(&callchain_param
) < 0) {
934 ui__error("Can't register callchain params.\n");
942 static int __cmd_top(struct perf_top
*top
)
944 struct record_opts
*opts
= &top
->record_opts
;
948 top
->session
= perf_session__new(NULL
, false, NULL
);
949 if (top
->session
== NULL
)
952 machines__set_symbol_filter(&top
->session
->machines
, symbol_filter
);
955 ret
= perf_session_env__lookup_objdump(&top
->session
->header
.env
);
960 ret
= perf_top__setup_sample_type(top
);
964 machine__synthesize_threads(&top
->session
->machines
.host
, &opts
->target
,
965 top
->evlist
->threads
, false, opts
->proc_map_timeout
);
966 ret
= perf_top__start_counters(top
);
970 top
->session
->evlist
= top
->evlist
;
971 perf_session__set_id_hdr_size(top
->session
);
974 * When perf is starting the traced process, all the events (apart from
975 * group members) have enable_on_exec=1 set, so don't spoil it by
976 * prematurely enabling them.
978 * XXX 'top' still doesn't start workloads like record, trace, but should,
979 * so leave the check here.
981 if (!target__none(&opts
->target
))
982 perf_evlist__enable(top
->evlist
);
984 /* Wait for a minimal set of events before starting the snapshot */
985 perf_evlist__poll(top
->evlist
, 100);
987 perf_top__mmap_read(top
);
990 if (pthread_create(&thread
, NULL
, (use_browser
> 0 ? display_thread_tui
:
991 display_thread
), top
)) {
992 ui__error("Could not create display thread.\n");
996 if (top
->realtime_prio
) {
997 struct sched_param param
;
999 param
.sched_priority
= top
->realtime_prio
;
1000 if (sched_setscheduler(0, SCHED_FIFO
, ¶m
)) {
1001 ui__error("Could not set realtime priority.\n");
1007 u64 hits
= top
->samples
;
1009 perf_top__mmap_read(top
);
1011 if (hits
== top
->samples
)
1012 ret
= perf_evlist__poll(top
->evlist
, 100);
1017 pthread_join(thread
, NULL
);
1019 perf_session__delete(top
->session
);
1020 top
->session
= NULL
;
1026 callchain_opt(const struct option
*opt
, const char *arg
, int unset
)
1028 symbol_conf
.use_callchain
= true;
1029 return record_callchain_opt(opt
, arg
, unset
);
1033 parse_callchain_opt(const struct option
*opt
, const char *arg
, int unset
)
1035 symbol_conf
.use_callchain
= true;
1036 return record_parse_callchain_opt(opt
, arg
, unset
);
1039 static int perf_top_config(const char *var
, const char *value
, void *cb
)
1041 if (!strcmp(var
, "top.call-graph"))
1042 var
= "call-graph.record-mode"; /* fall-through */
1043 if (!strcmp(var
, "top.children")) {
1044 symbol_conf
.cumulate_callchain
= perf_config_bool(var
, value
);
1048 return perf_default_config(var
, value
, cb
);
1052 parse_percent_limit(const struct option
*opt
, const char *arg
,
1053 int unset __maybe_unused
)
1055 struct perf_top
*top
= opt
->value
;
1057 top
->min_percent
= strtof(arg
, NULL
);
1061 int cmd_top(int argc
, const char **argv
, const char *prefix __maybe_unused
)
1063 char errbuf
[BUFSIZ
];
1064 struct perf_top top
= {
1068 .mmap_pages
= UINT_MAX
,
1069 .user_freq
= UINT_MAX
,
1070 .user_interval
= ULLONG_MAX
,
1071 .freq
= 4000, /* 4 KHz */
1075 .proc_map_timeout
= 500,
1077 .max_stack
= PERF_MAX_STACK_DEPTH
,
1078 .sym_pcnt_filter
= 5,
1080 struct record_opts
*opts
= &top
.record_opts
;
1081 struct target
*target
= &opts
->target
;
1082 const struct option options
[] = {
1083 OPT_CALLBACK('e', "event", &top
.evlist
, "event",
1084 "event selector. use 'perf list' to list available events",
1085 parse_events_option
),
1086 OPT_U64('c', "count", &opts
->user_interval
, "event period to sample"),
1087 OPT_STRING('p', "pid", &target
->pid
, "pid",
1088 "profile events on existing process id"),
1089 OPT_STRING('t', "tid", &target
->tid
, "tid",
1090 "profile events on existing thread id"),
1091 OPT_BOOLEAN('a', "all-cpus", &target
->system_wide
,
1092 "system-wide collection from all CPUs"),
1093 OPT_STRING('C', "cpu", &target
->cpu_list
, "cpu",
1094 "list of cpus to monitor"),
1095 OPT_STRING('k', "vmlinux", &symbol_conf
.vmlinux_name
,
1096 "file", "vmlinux pathname"),
1097 OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf
.ignore_vmlinux
,
1098 "don't load vmlinux even if found"),
1099 OPT_BOOLEAN('K', "hide_kernel_symbols", &top
.hide_kernel_symbols
,
1100 "hide kernel symbols"),
1101 OPT_CALLBACK('m', "mmap-pages", &opts
->mmap_pages
, "pages",
1102 "number of mmap data pages",
1103 perf_evlist__parse_mmap_pages
),
1104 OPT_INTEGER('r', "realtime", &top
.realtime_prio
,
1105 "collect data with this RT SCHED_FIFO priority"),
1106 OPT_INTEGER('d', "delay", &top
.delay_secs
,
1107 "number of seconds to delay between refreshes"),
1108 OPT_BOOLEAN('D', "dump-symtab", &top
.dump_symtab
,
1109 "dump the symbol table used for profiling"),
1110 OPT_INTEGER('f', "count-filter", &top
.count_filter
,
1111 "only display functions with more events than this"),
1112 OPT_BOOLEAN(0, "group", &opts
->group
,
1113 "put the counters into a counter group"),
1114 OPT_BOOLEAN('i', "no-inherit", &opts
->no_inherit
,
1115 "child tasks do not inherit counters"),
1116 OPT_STRING(0, "sym-annotate", &top
.sym_filter
, "symbol name",
1117 "symbol to annotate"),
1118 OPT_BOOLEAN('z', "zero", &top
.zero
, "zero history across updates"),
1119 OPT_UINTEGER('F', "freq", &opts
->user_freq
, "profile at this frequency"),
1120 OPT_INTEGER('E', "entries", &top
.print_entries
,
1121 "display this many functions"),
1122 OPT_BOOLEAN('U', "hide_user_symbols", &top
.hide_user_symbols
,
1123 "hide user symbols"),
1124 OPT_BOOLEAN(0, "tui", &top
.use_tui
, "Use the TUI interface"),
1125 OPT_BOOLEAN(0, "stdio", &top
.use_stdio
, "Use the stdio interface"),
1126 OPT_INCR('v', "verbose", &verbose
,
1127 "be more verbose (show counter open errors, etc)"),
1128 OPT_STRING('s', "sort", &sort_order
, "key[,key2...]",
1129 "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
1130 " Please refer the man page for the complete list."),
1131 OPT_STRING(0, "fields", &field_order
, "key[,keys...]",
1132 "output field(s): overhead, period, sample plus all of sort keys"),
1133 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf
.show_nr_samples
,
1134 "Show a column with the number of samples"),
1135 OPT_CALLBACK_NOOPT('g', NULL
, &top
.record_opts
,
1136 NULL
, "enables call-graph recording",
1138 OPT_CALLBACK(0, "call-graph", &top
.record_opts
,
1139 "mode[,dump_size]", record_callchain_help
,
1140 &parse_callchain_opt
),
1141 OPT_BOOLEAN(0, "children", &symbol_conf
.cumulate_callchain
,
1142 "Accumulate callchains of children and show total overhead as well"),
1143 OPT_INTEGER(0, "max-stack", &top
.max_stack
,
1144 "Set the maximum stack depth when parsing the callchain. "
1145 "Default: " __stringify(PERF_MAX_STACK_DEPTH
)),
1146 OPT_CALLBACK(0, "ignore-callees", NULL
, "regex",
1147 "ignore callees of these functions in call graphs",
1148 report_parse_ignore_callees_opt
),
1149 OPT_BOOLEAN(0, "show-total-period", &symbol_conf
.show_total_period
,
1150 "Show a column with the sum of periods"),
1151 OPT_STRING(0, "dsos", &symbol_conf
.dso_list_str
, "dso[,dso...]",
1152 "only consider symbols in these dsos"),
1153 OPT_STRING(0, "comms", &symbol_conf
.comm_list_str
, "comm[,comm...]",
1154 "only consider symbols in these comms"),
1155 OPT_STRING(0, "symbols", &symbol_conf
.sym_list_str
, "symbol[,symbol...]",
1156 "only consider these symbols"),
1157 OPT_BOOLEAN(0, "source", &symbol_conf
.annotate_src
,
1158 "Interleave source code with assembly code (default)"),
1159 OPT_BOOLEAN(0, "asm-raw", &symbol_conf
.annotate_asm_raw
,
1160 "Display raw encoding of assembly instructions (default)"),
1161 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf
.demangle_kernel
,
1162 "Enable kernel symbol demangling"),
1163 OPT_STRING(0, "objdump", &objdump_path
, "path",
1164 "objdump binary to use for disassembly and annotations"),
1165 OPT_STRING('M', "disassembler-style", &disassembler_style
, "disassembler style",
1166 "Specify disassembler style (e.g. -M intel for intel syntax)"),
1167 OPT_STRING('u', "uid", &target
->uid_str
, "user", "user to profile"),
1168 OPT_CALLBACK(0, "percent-limit", &top
, "percent",
1169 "Don't show entries under that percent", parse_percent_limit
),
1170 OPT_CALLBACK(0, "percentage", NULL
, "relative|absolute",
1171 "How to display percentage of filtered entries", parse_filter_percentage
),
1172 OPT_STRING('w', "column-widths", &symbol_conf
.col_width_list_str
,
1174 "don't try to adjust column width, use these fixed values"),
1175 OPT_UINTEGER(0, "proc-map-timeout", &opts
->proc_map_timeout
,
1176 "per thread proc mmap processing timeout in ms"),
1177 OPT_CALLBACK_NOOPT('b', "branch-any", &opts
->branch_stack
,
1178 "branch any", "sample any taken branches",
1179 parse_branch_stack
),
1180 OPT_CALLBACK('j', "branch-filter", &opts
->branch_stack
,
1181 "branch filter mask", "branch stack filter modes",
1182 parse_branch_stack
),
1185 const char * const top_usage
[] = {
1186 "perf top [<options>]",
1189 int status
= hists__init();
1194 top
.evlist
= perf_evlist__new();
1195 if (top
.evlist
== NULL
)
1198 perf_config(perf_top_config
, &top
);
1200 argc
= parse_options(argc
, argv
, options
, top_usage
, 0);
1202 usage_with_options(top_usage
, options
);
1204 sort__mode
= SORT_MODE__TOP
;
1205 /* display thread wants entries to be collapsed in a different tree */
1206 sort__need_collapse
= 1;
1208 if (setup_sorting() < 0) {
1210 parse_options_usage(top_usage
, options
, "s", 1);
1212 parse_options_usage(sort_order
? NULL
: top_usage
,
1213 options
, "fields", 0);
1214 goto out_delete_evlist
;
1219 else if (top
.use_tui
)
1222 setup_browser(false);
1224 status
= target__validate(target
);
1226 target__strerror(target
, status
, errbuf
, BUFSIZ
);
1227 ui__warning("%s\n", errbuf
);
1230 status
= target__parse_uid(target
);
1232 int saved_errno
= errno
;
1234 target__strerror(target
, status
, errbuf
, BUFSIZ
);
1235 ui__error("%s\n", errbuf
);
1237 status
= -saved_errno
;
1238 goto out_delete_evlist
;
1241 if (target__none(target
))
1242 target
->system_wide
= true;
1244 if (perf_evlist__create_maps(top
.evlist
, target
) < 0)
1245 usage_with_options(top_usage
, options
);
1247 if (!top
.evlist
->nr_entries
&&
1248 perf_evlist__add_default(top
.evlist
) < 0) {
1249 ui__error("Not enough memory for event selector list\n");
1250 goto out_delete_evlist
;
1253 symbol_conf
.nr_events
= top
.evlist
->nr_entries
;
1255 if (top
.delay_secs
< 1)
1258 if (record_opts__config(opts
)) {
1260 goto out_delete_evlist
;
1263 top
.sym_evsel
= perf_evlist__first(top
.evlist
);
1265 if (!symbol_conf
.use_callchain
) {
1266 symbol_conf
.cumulate_callchain
= false;
1267 perf_hpp__cancel_cumulate();
1270 symbol_conf
.priv_size
= sizeof(struct annotation
);
1272 symbol_conf
.try_vmlinux_path
= (symbol_conf
.vmlinux_name
== NULL
);
1273 if (symbol__init(NULL
) < 0)
1276 sort__setup_elide(stdout
);
1278 get_term_dimensions(&top
.winsize
);
1279 if (top
.print_entries
== 0) {
1280 struct sigaction act
= {
1281 .sa_sigaction
= perf_top__sig_winch
,
1282 .sa_flags
= SA_SIGINFO
,
1284 perf_top__update_print_entries(&top
);
1285 sigaction(SIGWINCH
, &act
, NULL
);
1288 status
= __cmd_top(&top
);
1291 perf_evlist__delete(top
.evlist
);