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 if (notes->src == NULL && symbol__alloc_hist(sym) < 0) {
193 pthread_mutex_unlock(¬es->lock);
194 pr_err("Not enough memory for annotating '%s' symbol!\n",
200 ip = he->ms.map->map_ip(he->ms.map, ip);
201 err = symbol__inc_addr_samples(sym, he->ms.map, counter, ip);
203 pthread_mutex_unlock(¬es->lock);
205 if (err == -ERANGE && !he->ms.map->erange_warned)
206 ui__warn_map_erange(he->ms.map, sym, ip);
209 static void perf_top__show_details(struct perf_top *top)
211 struct hist_entry *he = top->sym_filter_entry;
212 struct annotation *notes;
213 struct symbol *symbol;
220 notes = symbol__annotation(symbol);
222 pthread_mutex_lock(¬es->lock);
224 if (notes->src == NULL)
227 printf("Showing %s for %s\n", perf_evsel__name(top->sym_evsel), symbol->name);
228 printf(" Events Pcnt (>=%d%%)\n", top->sym_pcnt_filter);
230 more = symbol__annotate_printf(symbol, he->ms.map, top->sym_evsel,
231 0, top->sym_pcnt_filter, top->print_entries, 4);
233 symbol__annotate_zero_histogram(symbol, top->sym_evsel->idx);
235 symbol__annotate_decay_histogram(symbol, top->sym_evsel->idx);
237 printf("%d lines not displayed, maybe increase display entries [e]\n", more);
239 pthread_mutex_unlock(¬es->lock);
242 static struct hist_entry *perf_evsel__add_hist_entry(struct perf_evsel *evsel,
243 struct addr_location *al,
244 struct perf_sample *sample)
246 struct hist_entry *he;
248 pthread_mutex_lock(&evsel->hists.lock);
249 he = __hists__add_entry(&evsel->hists, al, NULL, NULL, NULL,
250 sample->period, sample->weight,
251 sample->transaction);
252 pthread_mutex_unlock(&evsel->hists.lock);
256 hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE);
260 static void perf_top__print_sym_table(struct perf_top *top)
264 const int win_width = top->winsize.ws_col - 1;
268 perf_top__header_snprintf(top, bf, sizeof(bf));
271 perf_top__reset_sample_counters(top);
273 printf("%-*.*s\n", win_width, win_width, graph_dotted_line);
275 if (top->sym_evsel->hists.stats.nr_lost_warned !=
276 top->sym_evsel->hists.stats.nr_events[PERF_RECORD_LOST]) {
277 top->sym_evsel->hists.stats.nr_lost_warned =
278 top->sym_evsel->hists.stats.nr_events[PERF_RECORD_LOST];
279 color_fprintf(stdout, PERF_COLOR_RED,
280 "WARNING: LOST %d chunks, Check IO/CPU overload",
281 top->sym_evsel->hists.stats.nr_lost_warned);
285 if (top->sym_filter_entry) {
286 perf_top__show_details(top);
290 hists__collapse_resort(&top->sym_evsel->hists, NULL);
291 hists__output_resort(&top->sym_evsel->hists);
292 hists__decay_entries(&top->sym_evsel->hists,
293 top->hide_user_symbols,
294 top->hide_kernel_symbols);
295 hists__output_recalc_col_len(&top->sym_evsel->hists,
296 top->print_entries - printed);
298 hists__fprintf(&top->sym_evsel->hists, false,
299 top->print_entries - printed, win_width,
300 top->min_percent, stdout);
303 static void prompt_integer(int *target, const char *msg)
305 char *buf = malloc(0), *p;
309 fprintf(stdout, "\n%s: ", msg);
310 if (getline(&buf, &dummy, stdin) < 0)
313 p = strchr(buf, '\n');
323 tmp = strtoul(buf, NULL, 10);
329 static void prompt_percent(int *target, const char *msg)
333 prompt_integer(&tmp, msg);
334 if (tmp >= 0 && tmp <= 100)
338 static void perf_top__prompt_symbol(struct perf_top *top, const char *msg)
340 char *buf = malloc(0), *p;
341 struct hist_entry *syme = top->sym_filter_entry, *n, *found = NULL;
342 struct rb_node *next;
345 /* zero counters of active symbol */
347 __zero_source_counters(syme);
348 top->sym_filter_entry = NULL;
351 fprintf(stdout, "\n%s: ", msg);
352 if (getline(&buf, &dummy, stdin) < 0)
355 p = strchr(buf, '\n');
359 next = rb_first(&top->sym_evsel->hists.entries);
361 n = rb_entry(next, struct hist_entry, rb_node);
362 if (n->ms.sym && !strcmp(buf, n->ms.sym->name)) {
366 next = rb_next(&n->rb_node);
370 fprintf(stderr, "Sorry, %s is not active.\n", buf);
373 perf_top__parse_source(top, found);
379 static void perf_top__print_mapped_keys(struct perf_top *top)
383 if (top->sym_filter_entry) {
384 struct symbol *sym = top->sym_filter_entry->ms.sym;
388 fprintf(stdout, "\nMapped keys:\n");
389 fprintf(stdout, "\t[d] display refresh delay. \t(%d)\n", top->delay_secs);
390 fprintf(stdout, "\t[e] display entries (lines). \t(%d)\n", top->print_entries);
392 if (top->evlist->nr_entries > 1)
393 fprintf(stdout, "\t[E] active event counter. \t(%s)\n", perf_evsel__name(top->sym_evsel));
395 fprintf(stdout, "\t[f] profile display filter (count). \t(%d)\n", top->count_filter);
397 fprintf(stdout, "\t[F] annotate display filter (percent). \t(%d%%)\n", top->sym_pcnt_filter);
398 fprintf(stdout, "\t[s] annotate symbol. \t(%s)\n", name?: "NULL");
399 fprintf(stdout, "\t[S] stop annotation.\n");
402 "\t[K] hide kernel_symbols symbols. \t(%s)\n",
403 top->hide_kernel_symbols ? "yes" : "no");
405 "\t[U] hide user symbols. \t(%s)\n",
406 top->hide_user_symbols ? "yes" : "no");
407 fprintf(stdout, "\t[z] toggle sample zeroing. \t(%d)\n", top->zero ? 1 : 0);
408 fprintf(stdout, "\t[qQ] quit.\n");
411 static int perf_top__key_mapped(struct perf_top *top, int c)
427 return top->evlist->nr_entries > 1 ? 1 : 0;
435 static bool perf_top__handle_keypress(struct perf_top *top, int c)
439 if (!perf_top__key_mapped(top, c)) {
440 struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
441 struct termios tc, save;
443 perf_top__print_mapped_keys(top);
444 fprintf(stdout, "\nEnter selection, or unmapped key to continue: ");
449 tc.c_lflag &= ~(ICANON | ECHO);
452 tcsetattr(0, TCSANOW, &tc);
454 poll(&stdin_poll, 1, -1);
457 tcsetattr(0, TCSAFLUSH, &save);
458 if (!perf_top__key_mapped(top, c))
464 prompt_integer(&top->delay_secs, "Enter display delay");
465 if (top->delay_secs < 1)
469 prompt_integer(&top->print_entries, "Enter display entries (lines)");
470 if (top->print_entries == 0) {
471 struct sigaction act = {
472 .sa_sigaction = perf_top__sig_winch,
473 .sa_flags = SA_SIGINFO,
475 perf_top__sig_winch(SIGWINCH, NULL, top);
476 sigaction(SIGWINCH, &act, NULL);
478 signal(SIGWINCH, SIG_DFL);
482 if (top->evlist->nr_entries > 1) {
483 /* Select 0 as the default event: */
486 fprintf(stderr, "\nAvailable events:");
488 list_for_each_entry(top->sym_evsel, &top->evlist->entries, node)
489 fprintf(stderr, "\n\t%d %s", top->sym_evsel->idx, perf_evsel__name(top->sym_evsel));
491 prompt_integer(&counter, "Enter details event counter");
493 if (counter >= top->evlist->nr_entries) {
494 top->sym_evsel = perf_evlist__first(top->evlist);
495 fprintf(stderr, "Sorry, no such event, using %s.\n", perf_evsel__name(top->sym_evsel));
499 list_for_each_entry(top->sym_evsel, &top->evlist->entries, node)
500 if (top->sym_evsel->idx == counter)
503 top->sym_evsel = perf_evlist__first(top->evlist);
506 prompt_integer(&top->count_filter, "Enter display event count filter");
509 prompt_percent(&top->sym_pcnt_filter,
510 "Enter details display event filter (percent)");
513 top->hide_kernel_symbols = !top->hide_kernel_symbols;
517 printf("exiting.\n");
518 if (top->dump_symtab)
519 perf_session__fprintf_dsos(top->session, stderr);
523 perf_top__prompt_symbol(top, "Enter details symbol");
526 if (!top->sym_filter_entry)
529 struct hist_entry *syme = top->sym_filter_entry;
531 top->sym_filter_entry = NULL;
532 __zero_source_counters(syme);
536 top->hide_user_symbols = !top->hide_user_symbols;
539 top->zero = !top->zero;
548 static void perf_top__sort_new_samples(void *arg)
550 struct perf_top *t = arg;
551 perf_top__reset_sample_counters(t);
553 if (t->evlist->selected != NULL)
554 t->sym_evsel = t->evlist->selected;
556 hists__collapse_resort(&t->sym_evsel->hists, NULL);
557 hists__output_resort(&t->sym_evsel->hists);
558 hists__decay_entries(&t->sym_evsel->hists,
559 t->hide_user_symbols,
560 t->hide_kernel_symbols);
563 static void *display_thread_tui(void *arg)
565 struct perf_evsel *pos;
566 struct perf_top *top = arg;
567 const char *help = "For a higher level overview, try: perf top --sort comm,dso";
568 struct hist_browser_timer hbt = {
569 .timer = perf_top__sort_new_samples,
571 .refresh = top->delay_secs,
574 perf_top__sort_new_samples(top);
577 * Initialize the uid_filter_str, in the future the TUI will allow
578 * Zooming in/out UIDs. For now juse use whatever the user passed
581 list_for_each_entry(pos, &top->evlist->entries, node)
582 pos->hists.uid_filter_str = top->record_opts.target.uid_str;
584 perf_evlist__tui_browse_hists(top->evlist, help, &hbt, top->min_percent,
585 &top->session->header.env);
591 static void *display_thread(void *arg)
593 struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
594 struct termios tc, save;
595 struct perf_top *top = arg;
600 tc.c_lflag &= ~(ICANON | ECHO);
604 pthread__unblock_sigwinch();
606 delay_msecs = top->delay_secs * 1000;
607 tcsetattr(0, TCSANOW, &tc);
612 perf_top__print_sym_table(top);
614 * Either timeout expired or we got an EINTR due to SIGWINCH,
615 * refresh screen in both cases.
617 switch (poll(&stdin_poll, 1, delay_msecs)) {
626 tcsetattr(0, TCSAFLUSH, &save);
628 if (perf_top__handle_keypress(top, c))
637 /* Tag samples to be skipped. */
638 static const char *skip_symbols[] = {
646 "mwait_idle_with_hints",
648 "ppc64_runlatch_off",
649 "pseries_dedicated_idle_sleep",
653 static int symbol_filter(struct map *map __maybe_unused, struct symbol *sym)
655 const char *name = sym->name;
659 * ppc64 uses function descriptors and appends a '.' to the
660 * start of every instruction address. Remove it.
665 if (!strcmp(name, "_text") ||
666 !strcmp(name, "_etext") ||
667 !strcmp(name, "_sinittext") ||
668 !strncmp("init_module", name, 11) ||
669 !strncmp("cleanup_module", name, 14) ||
670 strstr(name, "_text_start") ||
671 strstr(name, "_text_end"))
674 for (i = 0; skip_symbols[i]; i++) {
675 if (!strcmp(skip_symbols[i], name)) {
684 static void perf_event__process_sample(struct perf_tool *tool,
685 const union perf_event *event,
686 struct perf_evsel *evsel,
687 struct perf_sample *sample,
688 struct machine *machine)
690 struct perf_top *top = container_of(tool, struct perf_top, tool);
691 struct symbol *parent = NULL;
693 struct addr_location al;
696 if (!machine && perf_guest) {
697 static struct intlist *seen;
700 seen = intlist__new(NULL);
702 if (!intlist__has_entry(seen, sample->pid)) {
703 pr_err("Can't find guest [%d]'s kernel information\n",
705 intlist__add(seen, sample->pid);
711 pr_err("%u unprocessable samples recorded.\r",
712 top->session->stats.nr_unprocessable_samples++);
716 if (event->header.misc & PERF_RECORD_MISC_EXACT_IP)
717 top->exact_samples++;
719 if (perf_event__preprocess_sample(event, machine, &al, sample) < 0 ||
723 if (!top->kptr_restrict_warned &&
724 symbol_conf.kptr_restrict &&
725 al.cpumode == PERF_RECORD_MISC_KERNEL) {
727 "Kernel address maps (/proc/{kallsyms,modules}) are restricted.\n\n"
728 "Check /proc/sys/kernel/kptr_restrict.\n\n"
729 "Kernel%s samples will not be resolved.\n",
730 !RB_EMPTY_ROOT(&al.map->dso->symbols[MAP__FUNCTION]) ?
732 if (use_browser <= 0)
734 top->kptr_restrict_warned = true;
737 if (al.sym == NULL) {
738 const char *msg = "Kernel samples will not be resolved.\n";
740 * As we do lazy loading of symtabs we only will know if the
741 * specified vmlinux file is invalid when we actually have a
742 * hit in kernel space and then try to load it. So if we get
743 * here and there are _no_ symbols in the DSO backing the
744 * kernel map, bail out.
746 * We may never get here, for instance, if we use -K/
747 * --hide-kernel-symbols, even if the user specifies an
748 * invalid --vmlinux ;-)
750 if (!top->kptr_restrict_warned && !top->vmlinux_warned &&
751 al.map == machine->vmlinux_maps[MAP__FUNCTION] &&
752 RB_EMPTY_ROOT(&al.map->dso->symbols[MAP__FUNCTION])) {
753 if (symbol_conf.vmlinux_name) {
754 ui__warning("The %s file can't be used.\n%s",
755 symbol_conf.vmlinux_name, msg);
757 ui__warning("A vmlinux file was not found.\n%s",
761 if (use_browser <= 0)
763 top->vmlinux_warned = true;
767 if (al.sym == NULL || !al.sym->ignore) {
768 struct hist_entry *he;
770 if ((sort__has_parent || symbol_conf.use_callchain) &&
772 err = machine__resolve_callchain(machine, evsel,
780 he = perf_evsel__add_hist_entry(evsel, &al, sample);
782 pr_err("Problem incrementing symbol period, skipping event\n");
786 if (symbol_conf.use_callchain) {
787 err = callchain_append(he->callchain, &callchain_cursor,
794 perf_top__record_precise_ip(top, he, evsel->idx, ip);
800 static void perf_top__mmap_read_idx(struct perf_top *top, int idx)
802 struct perf_sample sample;
803 struct perf_evsel *evsel;
804 struct perf_session *session = top->session;
805 union perf_event *event;
806 struct machine *machine;
810 while ((event = perf_evlist__mmap_read(top->evlist, idx)) != NULL) {
811 ret = perf_evlist__parse_sample(top->evlist, event, &sample);
813 pr_err("Can't parse sample, err = %d\n", ret);
817 evsel = perf_evlist__id2evsel(session->evlist, sample.id);
818 assert(evsel != NULL);
820 origin = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
822 if (event->header.type == PERF_RECORD_SAMPLE)
826 case PERF_RECORD_MISC_USER:
828 if (top->hide_user_symbols)
830 machine = &session->machines.host;
832 case PERF_RECORD_MISC_KERNEL:
833 ++top->kernel_samples;
834 if (top->hide_kernel_symbols)
836 machine = &session->machines.host;
838 case PERF_RECORD_MISC_GUEST_KERNEL:
839 ++top->guest_kernel_samples;
840 machine = perf_session__find_machine(session,
843 case PERF_RECORD_MISC_GUEST_USER:
844 ++top->guest_us_samples;
846 * TODO: we don't process guest user from host side
847 * except simple counting.
855 if (event->header.type == PERF_RECORD_SAMPLE) {
856 perf_event__process_sample(&top->tool, event, evsel,
858 } else if (event->header.type < PERF_RECORD_MAX) {
859 hists__inc_nr_events(&evsel->hists, event->header.type);
860 machine__process_event(machine, event, &sample);
862 ++session->stats.nr_unknown_events;
864 perf_evlist__mmap_consume(top->evlist, idx);
868 static void perf_top__mmap_read(struct perf_top *top)
872 for (i = 0; i < top->evlist->nr_mmaps; i++)
873 perf_top__mmap_read_idx(top, i);
876 static int perf_top__start_counters(struct perf_top *top)
879 struct perf_evsel *counter;
880 struct perf_evlist *evlist = top->evlist;
881 struct perf_record_opts *opts = &top->record_opts;
883 perf_evlist__config(evlist, opts);
885 list_for_each_entry(counter, &evlist->entries, node) {
887 if (perf_evsel__open(counter, top->evlist->cpus,
888 top->evlist->threads) < 0) {
889 if (perf_evsel__fallback(counter, errno, msg, sizeof(msg))) {
891 ui__warning("%s\n", msg);
895 perf_evsel__open_strerror(counter, &opts->target,
896 errno, msg, sizeof(msg));
897 ui__error("%s\n", msg);
902 if (perf_evlist__mmap(evlist, opts->mmap_pages, false) < 0) {
903 ui__error("Failed to mmap with %d (%s)\n",
904 errno, strerror(errno));
914 static int perf_top__setup_sample_type(struct perf_top *top __maybe_unused)
916 if (!sort__has_sym) {
917 if (symbol_conf.use_callchain) {
918 ui__error("Selected -g but \"sym\" not present in --sort/-s.");
921 } else if (callchain_param.mode != CHAIN_NONE) {
922 if (callchain_register_param(&callchain_param) < 0) {
923 ui__error("Can't register callchain params.\n");
931 static int __cmd_top(struct perf_top *top)
933 struct perf_record_opts *opts = &top->record_opts;
937 top->session = perf_session__new(NULL, false, NULL);
938 if (top->session == NULL)
941 machines__set_symbol_filter(&top->session->machines, symbol_filter);
944 ret = perf_session_env__lookup_objdump(&top->session->header.env);
949 ret = perf_top__setup_sample_type(top);
953 machine__synthesize_threads(&top->session->machines.host, &opts->target,
954 top->evlist->threads, false);
955 ret = perf_top__start_counters(top);
959 top->session->evlist = top->evlist;
960 perf_session__set_id_hdr_size(top->session);
963 * When perf is starting the traced process, all the events (apart from
964 * group members) have enable_on_exec=1 set, so don't spoil it by
965 * prematurely enabling them.
967 * XXX 'top' still doesn't start workloads like record, trace, but should,
968 * so leave the check here.
970 if (!perf_target__none(&opts->target))
971 perf_evlist__enable(top->evlist);
973 /* Wait for a minimal set of events before starting the snapshot */
974 poll(top->evlist->pollfd, top->evlist->nr_fds, 100);
976 perf_top__mmap_read(top);
979 if (pthread_create(&thread, NULL, (use_browser > 0 ? display_thread_tui :
980 display_thread), top)) {
981 ui__error("Could not create display thread.\n");
985 if (top->realtime_prio) {
986 struct sched_param param;
988 param.sched_priority = top->realtime_prio;
989 if (sched_setscheduler(0, SCHED_FIFO, ¶m)) {
990 ui__error("Could not set realtime priority.\n");
996 u64 hits = top->samples;
998 perf_top__mmap_read(top);
1000 if (hits == top->samples)
1001 ret = poll(top->evlist->pollfd, top->evlist->nr_fds, 100);
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);
1027 parse_percent_limit(const struct option *opt, const char *arg,
1028 int unset __maybe_unused)
1030 struct perf_top *top = opt->value;
1032 top->min_percent = strtof(arg, NULL);
1036 int cmd_top(int argc, const char **argv, const char *prefix __maybe_unused)
1039 char errbuf[BUFSIZ];
1040 struct perf_top top = {
1044 .mmap_pages = UINT_MAX,
1045 .user_freq = UINT_MAX,
1046 .user_interval = ULLONG_MAX,
1047 .freq = 4000, /* 4 KHz */
1052 .max_stack = PERF_MAX_STACK_DEPTH,
1053 .sym_pcnt_filter = 5,
1055 struct perf_record_opts *opts = &top.record_opts;
1056 struct perf_target *target = &opts->target;
1057 const struct option options[] = {
1058 OPT_CALLBACK('e', "event", &top.evlist, "event",
1059 "event selector. use 'perf list' to list available events",
1060 parse_events_option),
1061 OPT_U64('c', "count", &opts->user_interval, "event period to sample"),
1062 OPT_STRING('p', "pid", &target->pid, "pid",
1063 "profile events on existing process id"),
1064 OPT_STRING('t', "tid", &target->tid, "tid",
1065 "profile events on existing thread id"),
1066 OPT_BOOLEAN('a', "all-cpus", &target->system_wide,
1067 "system-wide collection from all CPUs"),
1068 OPT_STRING('C', "cpu", &target->cpu_list, "cpu",
1069 "list of cpus to monitor"),
1070 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1071 "file", "vmlinux pathname"),
1072 OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux,
1073 "don't load vmlinux even if found"),
1074 OPT_BOOLEAN('K', "hide_kernel_symbols", &top.hide_kernel_symbols,
1075 "hide kernel symbols"),
1076 OPT_CALLBACK('m', "mmap-pages", &opts->mmap_pages, "pages",
1077 "number of mmap data pages",
1078 perf_evlist__parse_mmap_pages),
1079 OPT_INTEGER('r', "realtime", &top.realtime_prio,
1080 "collect data with this RT SCHED_FIFO priority"),
1081 OPT_INTEGER('d', "delay", &top.delay_secs,
1082 "number of seconds to delay between refreshes"),
1083 OPT_BOOLEAN('D', "dump-symtab", &top.dump_symtab,
1084 "dump the symbol table used for profiling"),
1085 OPT_INTEGER('f', "count-filter", &top.count_filter,
1086 "only display functions with more events than this"),
1087 OPT_BOOLEAN('g', "group", &opts->group,
1088 "put the counters into a counter group"),
1089 OPT_BOOLEAN('i', "no-inherit", &opts->no_inherit,
1090 "child tasks do not inherit counters"),
1091 OPT_STRING(0, "sym-annotate", &top.sym_filter, "symbol name",
1092 "symbol to annotate"),
1093 OPT_BOOLEAN('z', "zero", &top.zero, "zero history across updates"),
1094 OPT_UINTEGER('F', "freq", &opts->user_freq, "profile at this frequency"),
1095 OPT_INTEGER('E', "entries", &top.print_entries,
1096 "display this many functions"),
1097 OPT_BOOLEAN('U', "hide_user_symbols", &top.hide_user_symbols,
1098 "hide user symbols"),
1099 OPT_BOOLEAN(0, "tui", &top.use_tui, "Use the TUI interface"),
1100 OPT_BOOLEAN(0, "stdio", &top.use_stdio, "Use the stdio interface"),
1101 OPT_INCR('v', "verbose", &verbose,
1102 "be more verbose (show counter open errors, etc)"),
1103 OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
1104 "sort by key(s): pid, comm, dso, symbol, parent, weight, local_weight,"
1105 " abort, in_tx, transaction"),
1106 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
1107 "Show a column with the number of samples"),
1108 OPT_CALLBACK_NOOPT('G', NULL, &top.record_opts,
1109 NULL, "enables call-graph recording",
1111 OPT_CALLBACK(0, "call-graph", &top.record_opts,
1112 "mode[,dump_size]", record_callchain_help,
1113 &parse_callchain_opt),
1114 OPT_INTEGER(0, "max-stack", &top.max_stack,
1115 "Set the maximum stack depth when parsing the callchain. "
1116 "Default: " __stringify(PERF_MAX_STACK_DEPTH)),
1117 OPT_CALLBACK(0, "ignore-callees", NULL, "regex",
1118 "ignore callees of these functions in call graphs",
1119 report_parse_ignore_callees_opt),
1120 OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
1121 "Show a column with the sum of periods"),
1122 OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
1123 "only consider symbols in these dsos"),
1124 OPT_STRING(0, "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1125 "only consider symbols in these comms"),
1126 OPT_STRING(0, "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1127 "only consider these symbols"),
1128 OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
1129 "Interleave source code with assembly code (default)"),
1130 OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
1131 "Display raw encoding of assembly instructions (default)"),
1132 OPT_STRING(0, "objdump", &objdump_path, "path",
1133 "objdump binary to use for disassembly and annotations"),
1134 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
1135 "Specify disassembler style (e.g. -M intel for intel syntax)"),
1136 OPT_STRING('u', "uid", &target->uid_str, "user", "user to profile"),
1137 OPT_CALLBACK(0, "percent-limit", &top, "percent",
1138 "Don't show entries under that percent", parse_percent_limit),
1141 const char * const top_usage[] = {
1142 "perf top [<options>]",
1146 top.evlist = perf_evlist__new();
1147 if (top.evlist == NULL)
1150 argc = parse_options(argc, argv, options, top_usage, 0);
1152 usage_with_options(top_usage, options);
1154 if (sort_order == default_sort_order)
1155 sort_order = "dso,symbol";
1157 if (setup_sorting() < 0) {
1158 parse_options_usage(top_usage, options, "s", 1);
1159 goto out_delete_evlist;
1162 /* display thread wants entries to be collapsed in a different tree */
1163 sort__need_collapse = 1;
1167 else if (top.use_tui)
1170 setup_browser(false);
1172 status = perf_target__validate(target);
1174 perf_target__strerror(target, status, errbuf, BUFSIZ);
1175 ui__warning("%s", errbuf);
1178 status = perf_target__parse_uid(target);
1180 int saved_errno = errno;
1182 perf_target__strerror(target, status, errbuf, BUFSIZ);
1183 ui__error("%s", errbuf);
1185 status = -saved_errno;
1186 goto out_delete_evlist;
1189 if (perf_target__none(target))
1190 target->system_wide = true;
1192 if (perf_evlist__create_maps(top.evlist, target) < 0)
1193 usage_with_options(top_usage, options);
1195 if (!top.evlist->nr_entries &&
1196 perf_evlist__add_default(top.evlist) < 0) {
1197 ui__error("Not enough memory for event selector list\n");
1198 goto out_delete_maps;
1201 symbol_conf.nr_events = top.evlist->nr_entries;
1203 if (top.delay_secs < 1)
1206 if (perf_record_opts__config(opts)) {
1208 goto out_delete_maps;
1211 top.sym_evsel = perf_evlist__first(top.evlist);
1213 symbol_conf.priv_size = sizeof(struct annotation);
1215 symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
1216 if (symbol__init() < 0)
1219 sort__setup_elide(stdout);
1221 get_term_dimensions(&top.winsize);
1222 if (top.print_entries == 0) {
1223 struct sigaction act = {
1224 .sa_sigaction = perf_top__sig_winch,
1225 .sa_flags = SA_SIGINFO,
1227 perf_top__update_print_entries(&top);
1228 sigaction(SIGWINCH, &act, NULL);
1231 status = __cmd_top(&top);
1234 perf_evlist__delete_maps(top.evlist);
1236 perf_evlist__delete(top.evlist);