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 "arch/common.h"
45 #include "util/debug.h"
60 #include <sys/syscall.h>
61 #include <sys/ioctl.h>
63 #include <sys/prctl.h>
66 #include <sys/utsname.h>
69 #include <linux/unistd.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 symbol__annotate_zero_histogram(symbol
, top
->sym_evsel
->idx
);
242 symbol__annotate_decay_histogram(symbol
, top
->sym_evsel
->idx
);
244 printf("%d lines not displayed, maybe increase display entries [e]\n", more
);
246 pthread_mutex_unlock(¬es
->lock
);
249 static void perf_top__print_sym_table(struct perf_top
*top
)
253 const int win_width
= top
->winsize
.ws_col
- 1;
254 struct hists
*hists
= evsel__hists(top
->sym_evsel
);
258 perf_top__header_snprintf(top
, bf
, sizeof(bf
));
261 perf_top__reset_sample_counters(top
);
263 printf("%-*.*s\n", win_width
, win_width
, graph_dotted_line
);
265 if (hists
->stats
.nr_lost_warned
!=
266 hists
->stats
.nr_events
[PERF_RECORD_LOST
]) {
267 hists
->stats
.nr_lost_warned
=
268 hists
->stats
.nr_events
[PERF_RECORD_LOST
];
269 color_fprintf(stdout
, PERF_COLOR_RED
,
270 "WARNING: LOST %d chunks, Check IO/CPU overload",
271 hists
->stats
.nr_lost_warned
);
275 if (top
->sym_filter_entry
) {
276 perf_top__show_details(top
);
281 hists__delete_entries(hists
);
283 hists__decay_entries(hists
, top
->hide_user_symbols
,
284 top
->hide_kernel_symbols
);
287 hists__collapse_resort(hists
, NULL
);
288 hists__output_resort(hists
);
290 hists__output_recalc_col_len(hists
, top
->print_entries
- printed
);
292 hists__fprintf(hists
, false, top
->print_entries
- printed
, win_width
,
293 top
->min_percent
, stdout
);
296 static void prompt_integer(int *target
, const char *msg
)
298 char *buf
= malloc(0), *p
;
302 fprintf(stdout
, "\n%s: ", msg
);
303 if (getline(&buf
, &dummy
, stdin
) < 0)
306 p
= strchr(buf
, '\n');
316 tmp
= strtoul(buf
, NULL
, 10);
322 static void prompt_percent(int *target
, const char *msg
)
326 prompt_integer(&tmp
, msg
);
327 if (tmp
>= 0 && tmp
<= 100)
331 static void perf_top__prompt_symbol(struct perf_top
*top
, const char *msg
)
333 char *buf
= malloc(0), *p
;
334 struct hist_entry
*syme
= top
->sym_filter_entry
, *n
, *found
= NULL
;
335 struct hists
*hists
= evsel__hists(top
->sym_evsel
);
336 struct rb_node
*next
;
339 /* zero counters of active symbol */
341 __zero_source_counters(syme
);
342 top
->sym_filter_entry
= NULL
;
345 fprintf(stdout
, "\n%s: ", msg
);
346 if (getline(&buf
, &dummy
, stdin
) < 0)
349 p
= strchr(buf
, '\n');
353 next
= rb_first(&hists
->entries
);
355 n
= rb_entry(next
, struct hist_entry
, rb_node
);
356 if (n
->ms
.sym
&& !strcmp(buf
, n
->ms
.sym
->name
)) {
360 next
= rb_next(&n
->rb_node
);
364 fprintf(stderr
, "Sorry, %s is not active.\n", buf
);
367 perf_top__parse_source(top
, found
);
373 static void perf_top__print_mapped_keys(struct perf_top
*top
)
377 if (top
->sym_filter_entry
) {
378 struct symbol
*sym
= top
->sym_filter_entry
->ms
.sym
;
382 fprintf(stdout
, "\nMapped keys:\n");
383 fprintf(stdout
, "\t[d] display refresh delay. \t(%d)\n", top
->delay_secs
);
384 fprintf(stdout
, "\t[e] display entries (lines). \t(%d)\n", top
->print_entries
);
386 if (top
->evlist
->nr_entries
> 1)
387 fprintf(stdout
, "\t[E] active event counter. \t(%s)\n", perf_evsel__name(top
->sym_evsel
));
389 fprintf(stdout
, "\t[f] profile display filter (count). \t(%d)\n", top
->count_filter
);
391 fprintf(stdout
, "\t[F] annotate display filter (percent). \t(%d%%)\n", top
->sym_pcnt_filter
);
392 fprintf(stdout
, "\t[s] annotate symbol. \t(%s)\n", name
?: "NULL");
393 fprintf(stdout
, "\t[S] stop annotation.\n");
396 "\t[K] hide kernel_symbols symbols. \t(%s)\n",
397 top
->hide_kernel_symbols
? "yes" : "no");
399 "\t[U] hide user symbols. \t(%s)\n",
400 top
->hide_user_symbols
? "yes" : "no");
401 fprintf(stdout
, "\t[z] toggle sample zeroing. \t(%d)\n", top
->zero
? 1 : 0);
402 fprintf(stdout
, "\t[qQ] quit.\n");
405 static int perf_top__key_mapped(struct perf_top
*top
, int c
)
421 return top
->evlist
->nr_entries
> 1 ? 1 : 0;
429 static bool perf_top__handle_keypress(struct perf_top
*top
, int c
)
433 if (!perf_top__key_mapped(top
, c
)) {
434 struct pollfd stdin_poll
= { .fd
= 0, .events
= POLLIN
};
437 perf_top__print_mapped_keys(top
);
438 fprintf(stdout
, "\nEnter selection, or unmapped key to continue: ");
441 set_term_quiet_input(&save
);
443 poll(&stdin_poll
, 1, -1);
446 tcsetattr(0, TCSAFLUSH
, &save
);
447 if (!perf_top__key_mapped(top
, c
))
453 prompt_integer(&top
->delay_secs
, "Enter display delay");
454 if (top
->delay_secs
< 1)
458 prompt_integer(&top
->print_entries
, "Enter display entries (lines)");
459 if (top
->print_entries
== 0) {
460 struct sigaction act
= {
461 .sa_sigaction
= perf_top__sig_winch
,
462 .sa_flags
= SA_SIGINFO
,
464 perf_top__sig_winch(SIGWINCH
, NULL
, top
);
465 sigaction(SIGWINCH
, &act
, NULL
);
467 signal(SIGWINCH
, SIG_DFL
);
471 if (top
->evlist
->nr_entries
> 1) {
472 /* Select 0 as the default event: */
475 fprintf(stderr
, "\nAvailable events:");
477 evlist__for_each(top
->evlist
, top
->sym_evsel
)
478 fprintf(stderr
, "\n\t%d %s", top
->sym_evsel
->idx
, perf_evsel__name(top
->sym_evsel
));
480 prompt_integer(&counter
, "Enter details event counter");
482 if (counter
>= top
->evlist
->nr_entries
) {
483 top
->sym_evsel
= perf_evlist__first(top
->evlist
);
484 fprintf(stderr
, "Sorry, no such event, using %s.\n", perf_evsel__name(top
->sym_evsel
));
488 evlist__for_each(top
->evlist
, top
->sym_evsel
)
489 if (top
->sym_evsel
->idx
== counter
)
492 top
->sym_evsel
= perf_evlist__first(top
->evlist
);
495 prompt_integer(&top
->count_filter
, "Enter display event count filter");
498 prompt_percent(&top
->sym_pcnt_filter
,
499 "Enter details display event filter (percent)");
502 top
->hide_kernel_symbols
= !top
->hide_kernel_symbols
;
506 printf("exiting.\n");
507 if (top
->dump_symtab
)
508 perf_session__fprintf_dsos(top
->session
, stderr
);
512 perf_top__prompt_symbol(top
, "Enter details symbol");
515 if (!top
->sym_filter_entry
)
518 struct hist_entry
*syme
= top
->sym_filter_entry
;
520 top
->sym_filter_entry
= NULL
;
521 __zero_source_counters(syme
);
525 top
->hide_user_symbols
= !top
->hide_user_symbols
;
528 top
->zero
= !top
->zero
;
537 static void perf_top__sort_new_samples(void *arg
)
539 struct perf_top
*t
= arg
;
542 perf_top__reset_sample_counters(t
);
544 if (t
->evlist
->selected
!= NULL
)
545 t
->sym_evsel
= t
->evlist
->selected
;
547 hists
= evsel__hists(t
->sym_evsel
);
550 hists__delete_entries(hists
);
552 hists__decay_entries(hists
, t
->hide_user_symbols
,
553 t
->hide_kernel_symbols
);
556 hists__collapse_resort(hists
, NULL
);
557 hists__output_resort(hists
);
560 static void *display_thread_tui(void *arg
)
562 struct perf_evsel
*pos
;
563 struct perf_top
*top
= arg
;
564 const char *help
= "For a higher level overview, try: perf top --sort comm,dso";
565 struct hist_browser_timer hbt
= {
566 .timer
= perf_top__sort_new_samples
,
568 .refresh
= top
->delay_secs
,
571 perf_top__sort_new_samples(top
);
574 * Initialize the uid_filter_str, in the future the TUI will allow
575 * Zooming in/out UIDs. For now juse use whatever the user passed
578 evlist__for_each(top
->evlist
, pos
) {
579 struct hists
*hists
= evsel__hists(pos
);
580 hists
->uid_filter_str
= top
->record_opts
.target
.uid_str
;
583 perf_evlist__tui_browse_hists(top
->evlist
, help
, &hbt
, top
->min_percent
,
584 &top
->session
->header
.env
);
590 static void display_sig(int sig __maybe_unused
)
595 static void display_setup_sig(void)
597 signal(SIGSEGV
, display_sig
);
598 signal(SIGFPE
, display_sig
);
599 signal(SIGINT
, display_sig
);
600 signal(SIGQUIT
, display_sig
);
601 signal(SIGTERM
, display_sig
);
604 static void *display_thread(void *arg
)
606 struct pollfd stdin_poll
= { .fd
= 0, .events
= POLLIN
};
608 struct perf_top
*top
= arg
;
612 pthread__unblock_sigwinch();
614 delay_msecs
= top
->delay_secs
* 1000;
615 set_term_quiet_input(&save
);
620 perf_top__print_sym_table(top
);
622 * Either timeout expired or we got an EINTR due to SIGWINCH,
623 * refresh screen in both cases.
625 switch (poll(&stdin_poll
, 1, delay_msecs
)) {
634 tcsetattr(0, TCSAFLUSH
, &save
);
636 if (perf_top__handle_keypress(top
, c
))
642 tcsetattr(0, TCSAFLUSH
, &save
);
646 static int symbol_filter(struct map
*map
, struct symbol
*sym
)
648 const char *name
= sym
->name
;
650 if (!map
->dso
->kernel
)
653 * ppc64 uses function descriptors and appends a '.' to the
654 * start of every instruction address. Remove it.
659 if (!strcmp(name
, "_text") ||
660 !strcmp(name
, "_etext") ||
661 !strcmp(name
, "_sinittext") ||
662 !strncmp("init_module", name
, 11) ||
663 !strncmp("cleanup_module", name
, 14) ||
664 strstr(name
, "_text_start") ||
665 strstr(name
, "_text_end"))
668 if (symbol__is_idle(sym
))
674 static int hist_iter__top_callback(struct hist_entry_iter
*iter
,
675 struct addr_location
*al
, bool single
,
678 struct perf_top
*top
= arg
;
679 struct hist_entry
*he
= iter
->he
;
680 struct perf_evsel
*evsel
= iter
->evsel
;
682 if (sort__has_sym
&& single
) {
686 ip
= al
->map
->unmap_ip(al
->map
, ip
);
688 perf_top__record_precise_ip(top
, he
, evsel
->idx
, ip
);
694 static void perf_event__process_sample(struct perf_tool
*tool
,
695 const union perf_event
*event
,
696 struct perf_evsel
*evsel
,
697 struct perf_sample
*sample
,
698 struct machine
*machine
)
700 struct perf_top
*top
= container_of(tool
, struct perf_top
, tool
);
701 struct addr_location al
;
704 if (!machine
&& perf_guest
) {
705 static struct intlist
*seen
;
708 seen
= intlist__new(NULL
);
710 if (!intlist__has_entry(seen
, sample
->pid
)) {
711 pr_err("Can't find guest [%d]'s kernel information\n",
713 intlist__add(seen
, sample
->pid
);
719 pr_err("%u unprocessable samples recorded.\r",
720 top
->session
->stats
.nr_unprocessable_samples
++);
724 if (event
->header
.misc
& PERF_RECORD_MISC_EXACT_IP
)
725 top
->exact_samples
++;
727 if (perf_event__preprocess_sample(event
, machine
, &al
, sample
) < 0)
730 if (!top
->kptr_restrict_warned
&&
731 symbol_conf
.kptr_restrict
&&
732 al
.cpumode
== PERF_RECORD_MISC_KERNEL
) {
734 "Kernel address maps (/proc/{kallsyms,modules}) are restricted.\n\n"
735 "Check /proc/sys/kernel/kptr_restrict.\n\n"
736 "Kernel%s samples will not be resolved.\n",
737 !RB_EMPTY_ROOT(&al
.map
->dso
->symbols
[MAP__FUNCTION
]) ?
739 if (use_browser
<= 0)
741 top
->kptr_restrict_warned
= true;
744 if (al
.sym
== NULL
) {
745 const char *msg
= "Kernel samples will not be resolved.\n";
747 * As we do lazy loading of symtabs we only will know if the
748 * specified vmlinux file is invalid when we actually have a
749 * hit in kernel space and then try to load it. So if we get
750 * here and there are _no_ symbols in the DSO backing the
751 * kernel map, bail out.
753 * We may never get here, for instance, if we use -K/
754 * --hide-kernel-symbols, even if the user specifies an
755 * invalid --vmlinux ;-)
757 if (!top
->kptr_restrict_warned
&& !top
->vmlinux_warned
&&
758 al
.map
== machine
->vmlinux_maps
[MAP__FUNCTION
] &&
759 RB_EMPTY_ROOT(&al
.map
->dso
->symbols
[MAP__FUNCTION
])) {
760 if (symbol_conf
.vmlinux_name
) {
761 ui__warning("The %s file can't be used.\n%s",
762 symbol_conf
.vmlinux_name
, msg
);
764 ui__warning("A vmlinux file was not found.\n%s",
768 if (use_browser
<= 0)
770 top
->vmlinux_warned
= true;
774 if (al
.sym
== NULL
|| !al
.sym
->ignore
) {
775 struct hists
*hists
= evsel__hists(evsel
);
776 struct hist_entry_iter iter
= {
777 .add_entry_cb
= hist_iter__top_callback
,
780 if (symbol_conf
.cumulate_callchain
)
781 iter
.ops
= &hist_iter_cumulative
;
783 iter
.ops
= &hist_iter_normal
;
785 pthread_mutex_lock(&hists
->lock
);
787 err
= hist_entry_iter__add(&iter
, &al
, evsel
, sample
,
788 top
->max_stack
, top
);
790 pr_err("Problem incrementing symbol period, skipping event\n");
792 pthread_mutex_unlock(&hists
->lock
);
798 static void perf_top__mmap_read_idx(struct perf_top
*top
, int idx
)
800 struct perf_sample sample
;
801 struct perf_evsel
*evsel
;
802 struct perf_session
*session
= top
->session
;
803 union perf_event
*event
;
804 struct machine
*machine
;
808 while ((event
= perf_evlist__mmap_read(top
->evlist
, idx
)) != NULL
) {
809 ret
= perf_evlist__parse_sample(top
->evlist
, event
, &sample
);
811 pr_err("Can't parse sample, err = %d\n", ret
);
815 evsel
= perf_evlist__id2evsel(session
->evlist
, sample
.id
);
816 assert(evsel
!= NULL
);
818 origin
= event
->header
.misc
& PERF_RECORD_MISC_CPUMODE_MASK
;
820 if (event
->header
.type
== PERF_RECORD_SAMPLE
)
824 case PERF_RECORD_MISC_USER
:
826 if (top
->hide_user_symbols
)
828 machine
= &session
->machines
.host
;
830 case PERF_RECORD_MISC_KERNEL
:
831 ++top
->kernel_samples
;
832 if (top
->hide_kernel_symbols
)
834 machine
= &session
->machines
.host
;
836 case PERF_RECORD_MISC_GUEST_KERNEL
:
837 ++top
->guest_kernel_samples
;
838 machine
= perf_session__find_machine(session
,
841 case PERF_RECORD_MISC_GUEST_USER
:
842 ++top
->guest_us_samples
;
844 * TODO: we don't process guest user from host side
845 * except simple counting.
853 if (event
->header
.type
== PERF_RECORD_SAMPLE
) {
854 perf_event__process_sample(&top
->tool
, event
, evsel
,
856 } else if (event
->header
.type
< PERF_RECORD_MAX
) {
857 hists__inc_nr_events(evsel__hists(evsel
), event
->header
.type
);
858 machine__process_event(machine
, event
, &sample
);
860 ++session
->stats
.nr_unknown_events
;
862 perf_evlist__mmap_consume(top
->evlist
, idx
);
866 static void perf_top__mmap_read(struct perf_top
*top
)
870 for (i
= 0; i
< top
->evlist
->nr_mmaps
; i
++)
871 perf_top__mmap_read_idx(top
, i
);
874 static int perf_top__start_counters(struct perf_top
*top
)
877 struct perf_evsel
*counter
;
878 struct perf_evlist
*evlist
= top
->evlist
;
879 struct record_opts
*opts
= &top
->record_opts
;
881 perf_evlist__config(evlist
, opts
);
883 evlist__for_each(evlist
, counter
) {
885 if (perf_evsel__open(counter
, top
->evlist
->cpus
,
886 top
->evlist
->threads
) < 0) {
887 if (perf_evsel__fallback(counter
, errno
, msg
, sizeof(msg
))) {
889 ui__warning("%s\n", msg
);
893 perf_evsel__open_strerror(counter
, &opts
->target
,
894 errno
, msg
, sizeof(msg
));
895 ui__error("%s\n", msg
);
900 if (perf_evlist__mmap(evlist
, opts
->mmap_pages
, false) < 0) {
901 ui__error("Failed to mmap with %d (%s)\n",
902 errno
, strerror_r(errno
, msg
, sizeof(msg
)));
912 static int perf_top__setup_sample_type(struct perf_top
*top __maybe_unused
)
914 if (!sort__has_sym
) {
915 if (symbol_conf
.use_callchain
) {
916 ui__error("Selected -g but \"sym\" not present in --sort/-s.");
919 } else if (callchain_param
.mode
!= CHAIN_NONE
) {
920 if (callchain_register_param(&callchain_param
) < 0) {
921 ui__error("Can't register callchain params.\n");
929 static int __cmd_top(struct perf_top
*top
)
931 struct record_opts
*opts
= &top
->record_opts
;
935 top
->session
= perf_session__new(NULL
, false, NULL
);
936 if (top
->session
== NULL
)
939 machines__set_symbol_filter(&top
->session
->machines
, symbol_filter
);
942 ret
= perf_session_env__lookup_objdump(&top
->session
->header
.env
);
947 ret
= perf_top__setup_sample_type(top
);
951 machine__synthesize_threads(&top
->session
->machines
.host
, &opts
->target
,
952 top
->evlist
->threads
, false);
953 ret
= perf_top__start_counters(top
);
957 top
->session
->evlist
= top
->evlist
;
958 perf_session__set_id_hdr_size(top
->session
);
961 * When perf is starting the traced process, all the events (apart from
962 * group members) have enable_on_exec=1 set, so don't spoil it by
963 * prematurely enabling them.
965 * XXX 'top' still doesn't start workloads like record, trace, but should,
966 * so leave the check here.
968 if (!target__none(&opts
->target
))
969 perf_evlist__enable(top
->evlist
);
971 /* Wait for a minimal set of events before starting the snapshot */
972 perf_evlist__poll(top
->evlist
, 100);
974 perf_top__mmap_read(top
);
977 if (pthread_create(&thread
, NULL
, (use_browser
> 0 ? display_thread_tui
:
978 display_thread
), top
)) {
979 ui__error("Could not create display thread.\n");
983 if (top
->realtime_prio
) {
984 struct sched_param param
;
986 param
.sched_priority
= top
->realtime_prio
;
987 if (sched_setscheduler(0, SCHED_FIFO
, ¶m
)) {
988 ui__error("Could not set realtime priority.\n");
994 u64 hits
= top
->samples
;
996 perf_top__mmap_read(top
);
998 if (hits
== top
->samples
)
999 ret
= perf_evlist__poll(top
->evlist
, 100);
1004 pthread_join(thread
, NULL
);
1006 perf_session__delete(top
->session
);
1007 top
->session
= NULL
;
1013 callchain_opt(const struct option
*opt
, const char *arg
, int unset
)
1015 symbol_conf
.use_callchain
= true;
1016 return record_callchain_opt(opt
, arg
, unset
);
1020 parse_callchain_opt(const struct option
*opt
, const char *arg
, int unset
)
1022 symbol_conf
.use_callchain
= true;
1023 return record_parse_callchain_opt(opt
, arg
, unset
);
1026 static int perf_top_config(const char *var
, const char *value
, void *cb
)
1028 if (!strcmp(var
, "top.call-graph"))
1029 var
= "call-graph.record-mode"; /* fall-through */
1030 if (!strcmp(var
, "top.children")) {
1031 symbol_conf
.cumulate_callchain
= perf_config_bool(var
, value
);
1035 return perf_default_config(var
, value
, cb
);
1039 parse_percent_limit(const struct option
*opt
, const char *arg
,
1040 int unset __maybe_unused
)
1042 struct perf_top
*top
= opt
->value
;
1044 top
->min_percent
= strtof(arg
, NULL
);
1048 int cmd_top(int argc
, const char **argv
, const char *prefix __maybe_unused
)
1050 char errbuf
[BUFSIZ
];
1051 struct perf_top top
= {
1055 .mmap_pages
= UINT_MAX
,
1056 .user_freq
= UINT_MAX
,
1057 .user_interval
= ULLONG_MAX
,
1058 .freq
= 4000, /* 4 KHz */
1063 .max_stack
= PERF_MAX_STACK_DEPTH
,
1064 .sym_pcnt_filter
= 5,
1066 struct record_opts
*opts
= &top
.record_opts
;
1067 struct target
*target
= &opts
->target
;
1068 const struct option options
[] = {
1069 OPT_CALLBACK('e', "event", &top
.evlist
, "event",
1070 "event selector. use 'perf list' to list available events",
1071 parse_events_option
),
1072 OPT_U64('c', "count", &opts
->user_interval
, "event period to sample"),
1073 OPT_STRING('p', "pid", &target
->pid
, "pid",
1074 "profile events on existing process id"),
1075 OPT_STRING('t', "tid", &target
->tid
, "tid",
1076 "profile events on existing thread id"),
1077 OPT_BOOLEAN('a', "all-cpus", &target
->system_wide
,
1078 "system-wide collection from all CPUs"),
1079 OPT_STRING('C', "cpu", &target
->cpu_list
, "cpu",
1080 "list of cpus to monitor"),
1081 OPT_STRING('k', "vmlinux", &symbol_conf
.vmlinux_name
,
1082 "file", "vmlinux pathname"),
1083 OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf
.ignore_vmlinux
,
1084 "don't load vmlinux even if found"),
1085 OPT_BOOLEAN('K', "hide_kernel_symbols", &top
.hide_kernel_symbols
,
1086 "hide kernel symbols"),
1087 OPT_CALLBACK('m', "mmap-pages", &opts
->mmap_pages
, "pages",
1088 "number of mmap data pages",
1089 perf_evlist__parse_mmap_pages
),
1090 OPT_INTEGER('r', "realtime", &top
.realtime_prio
,
1091 "collect data with this RT SCHED_FIFO priority"),
1092 OPT_INTEGER('d', "delay", &top
.delay_secs
,
1093 "number of seconds to delay between refreshes"),
1094 OPT_BOOLEAN('D', "dump-symtab", &top
.dump_symtab
,
1095 "dump the symbol table used for profiling"),
1096 OPT_INTEGER('f', "count-filter", &top
.count_filter
,
1097 "only display functions with more events than this"),
1098 OPT_BOOLEAN(0, "group", &opts
->group
,
1099 "put the counters into a counter group"),
1100 OPT_BOOLEAN('i', "no-inherit", &opts
->no_inherit
,
1101 "child tasks do not inherit counters"),
1102 OPT_STRING(0, "sym-annotate", &top
.sym_filter
, "symbol name",
1103 "symbol to annotate"),
1104 OPT_BOOLEAN('z', "zero", &top
.zero
, "zero history across updates"),
1105 OPT_UINTEGER('F', "freq", &opts
->user_freq
, "profile at this frequency"),
1106 OPT_INTEGER('E', "entries", &top
.print_entries
,
1107 "display this many functions"),
1108 OPT_BOOLEAN('U', "hide_user_symbols", &top
.hide_user_symbols
,
1109 "hide user symbols"),
1110 OPT_BOOLEAN(0, "tui", &top
.use_tui
, "Use the TUI interface"),
1111 OPT_BOOLEAN(0, "stdio", &top
.use_stdio
, "Use the stdio interface"),
1112 OPT_INCR('v', "verbose", &verbose
,
1113 "be more verbose (show counter open errors, etc)"),
1114 OPT_STRING('s', "sort", &sort_order
, "key[,key2...]",
1115 "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
1116 " Please refer the man page for the complete list."),
1117 OPT_STRING(0, "fields", &field_order
, "key[,keys...]",
1118 "output field(s): overhead, period, sample plus all of sort keys"),
1119 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf
.show_nr_samples
,
1120 "Show a column with the number of samples"),
1121 OPT_CALLBACK_NOOPT('g', NULL
, &top
.record_opts
,
1122 NULL
, "enables call-graph recording",
1124 OPT_CALLBACK(0, "call-graph", &top
.record_opts
,
1125 "mode[,dump_size]", record_callchain_help
,
1126 &parse_callchain_opt
),
1127 OPT_BOOLEAN(0, "children", &symbol_conf
.cumulate_callchain
,
1128 "Accumulate callchains of children and show total overhead as well"),
1129 OPT_INTEGER(0, "max-stack", &top
.max_stack
,
1130 "Set the maximum stack depth when parsing the callchain. "
1131 "Default: " __stringify(PERF_MAX_STACK_DEPTH
)),
1132 OPT_CALLBACK(0, "ignore-callees", NULL
, "regex",
1133 "ignore callees of these functions in call graphs",
1134 report_parse_ignore_callees_opt
),
1135 OPT_BOOLEAN(0, "show-total-period", &symbol_conf
.show_total_period
,
1136 "Show a column with the sum of periods"),
1137 OPT_STRING(0, "dsos", &symbol_conf
.dso_list_str
, "dso[,dso...]",
1138 "only consider symbols in these dsos"),
1139 OPT_STRING(0, "comms", &symbol_conf
.comm_list_str
, "comm[,comm...]",
1140 "only consider symbols in these comms"),
1141 OPT_STRING(0, "symbols", &symbol_conf
.sym_list_str
, "symbol[,symbol...]",
1142 "only consider these symbols"),
1143 OPT_BOOLEAN(0, "source", &symbol_conf
.annotate_src
,
1144 "Interleave source code with assembly code (default)"),
1145 OPT_BOOLEAN(0, "asm-raw", &symbol_conf
.annotate_asm_raw
,
1146 "Display raw encoding of assembly instructions (default)"),
1147 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf
.demangle_kernel
,
1148 "Enable kernel symbol demangling"),
1149 OPT_STRING(0, "objdump", &objdump_path
, "path",
1150 "objdump binary to use for disassembly and annotations"),
1151 OPT_STRING('M', "disassembler-style", &disassembler_style
, "disassembler style",
1152 "Specify disassembler style (e.g. -M intel for intel syntax)"),
1153 OPT_STRING('u', "uid", &target
->uid_str
, "user", "user to profile"),
1154 OPT_CALLBACK(0, "percent-limit", &top
, "percent",
1155 "Don't show entries under that percent", parse_percent_limit
),
1156 OPT_CALLBACK(0, "percentage", NULL
, "relative|absolute",
1157 "How to display percentage of filtered entries", parse_filter_percentage
),
1158 OPT_STRING('w', "column-widths", &symbol_conf
.col_width_list_str
,
1160 "don't try to adjust column width, use these fixed values"),
1163 const char * const top_usage
[] = {
1164 "perf top [<options>]",
1167 int status
= hists__init();
1172 top
.evlist
= perf_evlist__new();
1173 if (top
.evlist
== NULL
)
1176 perf_config(perf_top_config
, &top
);
1178 argc
= parse_options(argc
, argv
, options
, top_usage
, 0);
1180 usage_with_options(top_usage
, options
);
1182 sort__mode
= SORT_MODE__TOP
;
1183 /* display thread wants entries to be collapsed in a different tree */
1184 sort__need_collapse
= 1;
1186 if (setup_sorting() < 0) {
1188 parse_options_usage(top_usage
, options
, "s", 1);
1190 parse_options_usage(sort_order
? NULL
: top_usage
,
1191 options
, "fields", 0);
1192 goto out_delete_evlist
;
1197 else if (top
.use_tui
)
1200 setup_browser(false);
1202 status
= target__validate(target
);
1204 target__strerror(target
, status
, errbuf
, BUFSIZ
);
1205 ui__warning("%s\n", errbuf
);
1208 status
= target__parse_uid(target
);
1210 int saved_errno
= errno
;
1212 target__strerror(target
, status
, errbuf
, BUFSIZ
);
1213 ui__error("%s\n", errbuf
);
1215 status
= -saved_errno
;
1216 goto out_delete_evlist
;
1219 if (target__none(target
))
1220 target
->system_wide
= true;
1222 if (perf_evlist__create_maps(top
.evlist
, target
) < 0)
1223 usage_with_options(top_usage
, options
);
1225 if (!top
.evlist
->nr_entries
&&
1226 perf_evlist__add_default(top
.evlist
) < 0) {
1227 ui__error("Not enough memory for event selector list\n");
1228 goto out_delete_evlist
;
1231 symbol_conf
.nr_events
= top
.evlist
->nr_entries
;
1233 if (top
.delay_secs
< 1)
1236 if (record_opts__config(opts
)) {
1238 goto out_delete_evlist
;
1241 top
.sym_evsel
= perf_evlist__first(top
.evlist
);
1243 if (!symbol_conf
.use_callchain
) {
1244 symbol_conf
.cumulate_callchain
= false;
1245 perf_hpp__cancel_cumulate();
1248 symbol_conf
.priv_size
= sizeof(struct annotation
);
1250 symbol_conf
.try_vmlinux_path
= (symbol_conf
.vmlinux_name
== NULL
);
1251 if (symbol__init(NULL
) < 0)
1254 sort__setup_elide(stdout
);
1256 get_term_dimensions(&top
.winsize
);
1257 if (top
.print_entries
== 0) {
1258 struct sigaction act
= {
1259 .sa_sigaction
= perf_top__sig_winch
,
1260 .sa_flags
= SA_SIGINFO
,
1262 perf_top__update_print_entries(&top
);
1263 sigaction(SIGWINCH
, &act
, NULL
);
1266 status
= __cmd_top(&top
);
1269 perf_evlist__delete(top
.evlist
);