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"
44 #include "util/debug.h"
59 #include <sys/syscall.h>
60 #include <sys/ioctl.h>
62 #include <sys/prctl.h>
65 #include <sys/utsname.h>
68 #include <linux/unistd.h>
69 #include <linux/types.h>
71 static volatile int done;
73 static void perf_top__update_print_entries(struct perf_top *top)
75 if (top->print_entries > 9)
76 top->print_entries -= 9;
79 static void perf_top__sig_winch(int sig __maybe_unused,
80 siginfo_t *info __maybe_unused, void *arg)
82 struct perf_top *top = arg;
84 get_term_dimensions(&top->winsize);
85 if (!top->print_entries
86 || (top->print_entries+4) > top->winsize.ws_row) {
87 top->print_entries = top->winsize.ws_row;
89 top->print_entries += 4;
90 top->winsize.ws_row = top->print_entries;
92 perf_top__update_print_entries(top);
95 static int perf_top__parse_source(struct perf_top *top, struct hist_entry *he)
98 struct annotation *notes;
102 if (!he || !he->ms.sym)
109 * We can't annotate with just /proc/kallsyms
111 if (map->dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS) {
112 pr_err("Can't annotate %s: No vmlinux file was found in the "
113 "path\n", sym->name);
118 notes = symbol__annotation(sym);
119 if (notes->src != NULL) {
120 pthread_mutex_lock(¬es->lock);
124 pthread_mutex_lock(¬es->lock);
126 if (symbol__alloc_hist(sym) < 0) {
127 pthread_mutex_unlock(¬es->lock);
128 pr_err("Not enough memory for annotating '%s' symbol!\n",
134 err = symbol__annotate(sym, map, 0);
137 top->sym_filter_entry = he;
140 pthread_mutex_unlock(¬es->lock);
144 static void __zero_source_counters(struct hist_entry *he)
146 struct symbol *sym = he->ms.sym;
147 symbol__annotate_zero_histograms(sym);
150 static void ui__warn_map_erange(struct map *map, struct symbol *sym, u64 ip)
153 int err = uname(&uts);
155 ui__warning("Out of bounds address found:\n\n"
156 "Addr: %" PRIx64 "\n"
158 "Map: %" PRIx64 "-%" PRIx64 "\n"
159 "Symbol: %" PRIx64 "-%" PRIx64 " %c %s\n"
163 "Not all samples will be on the annotation output.\n\n"
164 "Please report to linux-kernel@vger.kernel.org\n",
165 ip, map->dso->long_name, dso__symtab_origin(map->dso),
166 map->start, map->end, sym->start, sym->end,
167 sym->binding == STB_GLOBAL ? 'g' :
168 sym->binding == STB_LOCAL ? 'l' : 'w', sym->name,
169 err ? "[unknown]" : uts.machine,
170 err ? "[unknown]" : uts.release, perf_version_string);
171 if (use_browser <= 0)
174 map->erange_warned = true;
177 static void perf_top__record_precise_ip(struct perf_top *top,
178 struct hist_entry *he,
181 struct annotation *notes;
185 if (he == NULL || he->ms.sym == NULL ||
186 ((top->sym_filter_entry == NULL ||
187 top->sym_filter_entry->ms.sym != he->ms.sym) && use_browser != 1))
191 notes = symbol__annotation(sym);
193 if (pthread_mutex_trylock(¬es->lock))
196 if (notes->src == NULL && symbol__alloc_hist(sym) < 0) {
197 pthread_mutex_unlock(¬es->lock);
198 pr_err("Not enough memory for annotating '%s' symbol!\n",
204 ip = he->ms.map->map_ip(he->ms.map, ip);
205 err = symbol__inc_addr_samples(sym, he->ms.map, counter, ip);
207 pthread_mutex_unlock(¬es->lock);
209 if (err == -ERANGE && !he->ms.map->erange_warned)
210 ui__warn_map_erange(he->ms.map, sym, ip);
213 static void perf_top__show_details(struct perf_top *top)
215 struct hist_entry *he = top->sym_filter_entry;
216 struct annotation *notes;
217 struct symbol *symbol;
224 notes = symbol__annotation(symbol);
226 pthread_mutex_lock(¬es->lock);
228 if (notes->src == NULL)
231 printf("Showing %s for %s\n", perf_evsel__name(top->sym_evsel), symbol->name);
232 printf(" Events Pcnt (>=%d%%)\n", top->sym_pcnt_filter);
234 more = symbol__annotate_printf(symbol, he->ms.map, top->sym_evsel,
235 0, top->sym_pcnt_filter, top->print_entries, 4);
237 symbol__annotate_zero_histogram(symbol, top->sym_evsel->idx);
239 symbol__annotate_decay_histogram(symbol, top->sym_evsel->idx);
241 printf("%d lines not displayed, maybe increase display entries [e]\n", more);
243 pthread_mutex_unlock(¬es->lock);
246 static const char CONSOLE_CLEAR[] = "
\e[H
\e[2J";
248 static struct hist_entry *perf_evsel__add_hist_entry(struct perf_evsel *evsel,
249 struct addr_location *al,
250 struct perf_sample *sample)
252 struct hist_entry *he;
254 he = __hists__add_entry(&evsel->hists, al, NULL, sample->period,
259 hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE);
263 static void perf_top__print_sym_table(struct perf_top *top)
267 const int win_width = top->winsize.ws_col - 1;
271 perf_top__header_snprintf(top, bf, sizeof(bf));
274 perf_top__reset_sample_counters(top);
276 printf("%-*.*s\n", win_width, win_width, graph_dotted_line);
278 if (top->sym_evsel->hists.stats.nr_lost_warned !=
279 top->sym_evsel->hists.stats.nr_events[PERF_RECORD_LOST]) {
280 top->sym_evsel->hists.stats.nr_lost_warned =
281 top->sym_evsel->hists.stats.nr_events[PERF_RECORD_LOST];
282 color_fprintf(stdout, PERF_COLOR_RED,
283 "WARNING: LOST %d chunks, Check IO/CPU overload",
284 top->sym_evsel->hists.stats.nr_lost_warned);
288 if (top->sym_filter_entry) {
289 perf_top__show_details(top);
293 hists__collapse_resort_threaded(&top->sym_evsel->hists);
294 hists__output_resort_threaded(&top->sym_evsel->hists);
295 hists__decay_entries_threaded(&top->sym_evsel->hists,
296 top->hide_user_symbols,
297 top->hide_kernel_symbols);
298 hists__output_recalc_col_len(&top->sym_evsel->hists,
299 top->winsize.ws_row - 3);
301 hists__fprintf(&top->sym_evsel->hists, false,
302 top->winsize.ws_row - 4 - printed, win_width, stdout);
305 static void prompt_integer(int *target, const char *msg)
307 char *buf = malloc(0), *p;
311 fprintf(stdout, "\n%s: ", msg);
312 if (getline(&buf, &dummy, stdin) < 0)
315 p = strchr(buf, '\n');
325 tmp = strtoul(buf, NULL, 10);
331 static void prompt_percent(int *target, const char *msg)
335 prompt_integer(&tmp, msg);
336 if (tmp >= 0 && tmp <= 100)
340 static void perf_top__prompt_symbol(struct perf_top *top, const char *msg)
342 char *buf = malloc(0), *p;
343 struct hist_entry *syme = top->sym_filter_entry, *n, *found = NULL;
344 struct rb_node *next;
347 /* zero counters of active symbol */
349 __zero_source_counters(syme);
350 top->sym_filter_entry = NULL;
353 fprintf(stdout, "\n%s: ", msg);
354 if (getline(&buf, &dummy, stdin) < 0)
357 p = strchr(buf, '\n');
361 next = rb_first(&top->sym_evsel->hists.entries);
363 n = rb_entry(next, struct hist_entry, rb_node);
364 if (n->ms.sym && !strcmp(buf, n->ms.sym->name)) {
368 next = rb_next(&n->rb_node);
372 fprintf(stderr, "Sorry, %s is not active.\n", buf);
375 perf_top__parse_source(top, found);
381 static void perf_top__print_mapped_keys(struct perf_top *top)
385 if (top->sym_filter_entry) {
386 struct symbol *sym = top->sym_filter_entry->ms.sym;
390 fprintf(stdout, "\nMapped keys:\n");
391 fprintf(stdout, "\t[d] display refresh delay. \t(%d)\n", top->delay_secs);
392 fprintf(stdout, "\t[e] display entries (lines). \t(%d)\n", top->print_entries);
394 if (top->evlist->nr_entries > 1)
395 fprintf(stdout, "\t[E] active event counter. \t(%s)\n", perf_evsel__name(top->sym_evsel));
397 fprintf(stdout, "\t[f] profile display filter (count). \t(%d)\n", top->count_filter);
399 fprintf(stdout, "\t[F] annotate display filter (percent). \t(%d%%)\n", top->sym_pcnt_filter);
400 fprintf(stdout, "\t[s] annotate symbol. \t(%s)\n", name?: "NULL");
401 fprintf(stdout, "\t[S] stop annotation.\n");
404 "\t[K] hide kernel_symbols symbols. \t(%s)\n",
405 top->hide_kernel_symbols ? "yes" : "no");
407 "\t[U] hide user symbols. \t(%s)\n",
408 top->hide_user_symbols ? "yes" : "no");
409 fprintf(stdout, "\t[z] toggle sample zeroing. \t(%d)\n", top->zero ? 1 : 0);
410 fprintf(stdout, "\t[qQ] quit.\n");
413 static int perf_top__key_mapped(struct perf_top *top, int c)
429 return top->evlist->nr_entries > 1 ? 1 : 0;
437 static bool perf_top__handle_keypress(struct perf_top *top, int c)
441 if (!perf_top__key_mapped(top, c)) {
442 struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
443 struct termios tc, save;
445 perf_top__print_mapped_keys(top);
446 fprintf(stdout, "\nEnter selection, or unmapped key to continue: ");
451 tc.c_lflag &= ~(ICANON | ECHO);
454 tcsetattr(0, TCSANOW, &tc);
456 poll(&stdin_poll, 1, -1);
459 tcsetattr(0, TCSAFLUSH, &save);
460 if (!perf_top__key_mapped(top, c))
466 prompt_integer(&top->delay_secs, "Enter display delay");
467 if (top->delay_secs < 1)
471 prompt_integer(&top->print_entries, "Enter display entries (lines)");
472 if (top->print_entries == 0) {
473 struct sigaction act = {
474 .sa_sigaction = perf_top__sig_winch,
475 .sa_flags = SA_SIGINFO,
477 perf_top__sig_winch(SIGWINCH, NULL, top);
478 sigaction(SIGWINCH, &act, NULL);
480 perf_top__sig_winch(SIGWINCH, NULL, top);
481 signal(SIGWINCH, SIG_DFL);
485 if (top->evlist->nr_entries > 1) {
486 /* Select 0 as the default event: */
489 fprintf(stderr, "\nAvailable events:");
491 list_for_each_entry(top->sym_evsel, &top->evlist->entries, node)
492 fprintf(stderr, "\n\t%d %s", top->sym_evsel->idx, perf_evsel__name(top->sym_evsel));
494 prompt_integer(&counter, "Enter details event counter");
496 if (counter >= top->evlist->nr_entries) {
497 top->sym_evsel = perf_evlist__first(top->evlist);
498 fprintf(stderr, "Sorry, no such event, using %s.\n", perf_evsel__name(top->sym_evsel));
502 list_for_each_entry(top->sym_evsel, &top->evlist->entries, node)
503 if (top->sym_evsel->idx == counter)
506 top->sym_evsel = perf_evlist__first(top->evlist);
509 prompt_integer(&top->count_filter, "Enter display event count filter");
512 prompt_percent(&top->sym_pcnt_filter,
513 "Enter details display event filter (percent)");
516 top->hide_kernel_symbols = !top->hide_kernel_symbols;
520 printf("exiting.\n");
521 if (top->dump_symtab)
522 perf_session__fprintf_dsos(top->session, stderr);
526 perf_top__prompt_symbol(top, "Enter details symbol");
529 if (!top->sym_filter_entry)
532 struct hist_entry *syme = top->sym_filter_entry;
534 top->sym_filter_entry = NULL;
535 __zero_source_counters(syme);
539 top->hide_user_symbols = !top->hide_user_symbols;
542 top->zero = !top->zero;
551 static void perf_top__sort_new_samples(void *arg)
553 struct perf_top *t = arg;
554 perf_top__reset_sample_counters(t);
556 if (t->evlist->selected != NULL)
557 t->sym_evsel = t->evlist->selected;
559 hists__collapse_resort_threaded(&t->sym_evsel->hists);
560 hists__output_resort_threaded(&t->sym_evsel->hists);
561 hists__decay_entries_threaded(&t->sym_evsel->hists,
562 t->hide_user_symbols,
563 t->hide_kernel_symbols);
566 static void *display_thread_tui(void *arg)
568 struct perf_evsel *pos;
569 struct perf_top *top = arg;
570 const char *help = "For a higher level overview, try: perf top --sort comm,dso";
571 struct hist_browser_timer hbt = {
572 .timer = perf_top__sort_new_samples,
574 .refresh = top->delay_secs,
577 perf_top__sort_new_samples(top);
580 * Initialize the uid_filter_str, in the future the TUI will allow
581 * Zooming in/out UIDs. For now juse use whatever the user passed
584 list_for_each_entry(pos, &top->evlist->entries, node)
585 pos->hists.uid_filter_str = top->record_opts.target.uid_str;
587 perf_evlist__tui_browse_hists(top->evlist, help, &hbt,
588 &top->session->header.env);
594 static void *display_thread(void *arg)
596 struct pollfd stdin_poll = { .fd = 0, .events = POLLIN };
597 struct termios tc, save;
598 struct perf_top *top = arg;
603 tc.c_lflag &= ~(ICANON | ECHO);
607 pthread__unblock_sigwinch();
609 delay_msecs = top->delay_secs * 1000;
610 tcsetattr(0, TCSANOW, &tc);
615 perf_top__print_sym_table(top);
617 * Either timeout expired or we got an EINTR due to SIGWINCH,
618 * refresh screen in both cases.
620 switch (poll(&stdin_poll, 1, delay_msecs)) {
629 tcsetattr(0, TCSAFLUSH, &save);
631 if (perf_top__handle_keypress(top, c))
640 /* Tag samples to be skipped. */
641 static const char *skip_symbols[] = {
649 "mwait_idle_with_hints",
651 "ppc64_runlatch_off",
652 "pseries_dedicated_idle_sleep",
656 static int symbol_filter(struct map *map __maybe_unused, struct symbol *sym)
658 const char *name = sym->name;
662 * ppc64 uses function descriptors and appends a '.' to the
663 * start of every instruction address. Remove it.
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"))
677 for (i = 0; skip_symbols[i]; i++) {
678 if (!strcmp(skip_symbols[i], name)) {
687 static void perf_event__process_sample(struct perf_tool *tool,
688 const union perf_event *event,
689 struct perf_evsel *evsel,
690 struct perf_sample *sample,
691 struct machine *machine)
693 struct perf_top *top = container_of(tool, struct perf_top, tool);
694 struct symbol *parent = NULL;
695 u64 ip = event->ip.ip;
696 struct addr_location al;
699 if (!machine && perf_guest) {
700 static struct intlist *seen;
703 seen = intlist__new(NULL);
705 if (!intlist__has_entry(seen, event->ip.pid)) {
706 pr_err("Can't find guest [%d]'s kernel information\n",
708 intlist__add(seen, event->ip.pid);
714 pr_err("%u unprocessable samples recorded.\r",
715 top->session->stats.nr_unprocessable_samples++);
719 if (event->header.misc & PERF_RECORD_MISC_EXACT_IP)
720 top->exact_samples++;
722 if (perf_event__preprocess_sample(event, machine, &al, sample,
723 symbol_filter) < 0 ||
727 if (!top->kptr_restrict_warned &&
728 symbol_conf.kptr_restrict &&
729 al.cpumode == PERF_RECORD_MISC_KERNEL) {
731 "Kernel address maps (/proc/{kallsyms,modules}) are restricted.\n\n"
732 "Check /proc/sys/kernel/kptr_restrict.\n\n"
733 "Kernel%s samples will not be resolved.\n",
734 !RB_EMPTY_ROOT(&al.map->dso->symbols[MAP__FUNCTION]) ?
736 if (use_browser <= 0)
738 top->kptr_restrict_warned = true;
741 if (al.sym == NULL) {
742 const char *msg = "Kernel samples will not be resolved.\n";
744 * As we do lazy loading of symtabs we only will know if the
745 * specified vmlinux file is invalid when we actually have a
746 * hit in kernel space and then try to load it. So if we get
747 * here and there are _no_ symbols in the DSO backing the
748 * kernel map, bail out.
750 * We may never get here, for instance, if we use -K/
751 * --hide-kernel-symbols, even if the user specifies an
752 * invalid --vmlinux ;-)
754 if (!top->kptr_restrict_warned && !top->vmlinux_warned &&
755 al.map == machine->vmlinux_maps[MAP__FUNCTION] &&
756 RB_EMPTY_ROOT(&al.map->dso->symbols[MAP__FUNCTION])) {
757 if (symbol_conf.vmlinux_name) {
758 ui__warning("The %s file can't be used.\n%s",
759 symbol_conf.vmlinux_name, msg);
761 ui__warning("A vmlinux file was not found.\n%s",
765 if (use_browser <= 0)
767 top->vmlinux_warned = true;
771 if (al.sym == NULL || !al.sym->ignore) {
772 struct hist_entry *he;
774 if ((sort__has_parent || symbol_conf.use_callchain) &&
776 err = machine__resolve_callchain(machine, evsel,
784 he = perf_evsel__add_hist_entry(evsel, &al, sample);
786 pr_err("Problem incrementing symbol period, skipping event\n");
790 if (symbol_conf.use_callchain) {
791 err = callchain_append(he->callchain, &callchain_cursor,
797 if (top->sort_has_symbols)
798 perf_top__record_precise_ip(top, he, evsel->idx, ip);
804 static void perf_top__mmap_read_idx(struct perf_top *top, int idx)
806 struct perf_sample sample;
807 struct perf_evsel *evsel;
808 struct perf_session *session = top->session;
809 union perf_event *event;
810 struct machine *machine;
814 while ((event = perf_evlist__mmap_read(top->evlist, idx)) != NULL) {
815 ret = perf_evlist__parse_sample(top->evlist, event, &sample);
817 pr_err("Can't parse sample, err = %d\n", ret);
821 evsel = perf_evlist__id2evsel(session->evlist, sample.id);
822 assert(evsel != NULL);
824 origin = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
826 if (event->header.type == PERF_RECORD_SAMPLE)
830 case PERF_RECORD_MISC_USER:
832 if (top->hide_user_symbols)
834 machine = &session->machines.host;
836 case PERF_RECORD_MISC_KERNEL:
837 ++top->kernel_samples;
838 if (top->hide_kernel_symbols)
840 machine = &session->machines.host;
842 case PERF_RECORD_MISC_GUEST_KERNEL:
843 ++top->guest_kernel_samples;
844 machine = perf_session__find_machine(session, event->ip.pid);
846 case PERF_RECORD_MISC_GUEST_USER:
847 ++top->guest_us_samples;
849 * TODO: we don't process guest user from host side
850 * except simple counting.
858 if (event->header.type == PERF_RECORD_SAMPLE) {
859 perf_event__process_sample(&top->tool, event, evsel,
861 } else if (event->header.type < PERF_RECORD_MAX) {
862 hists__inc_nr_events(&evsel->hists, event->header.type);
863 machine__process_event(machine, event);
865 ++session->stats.nr_unknown_events;
869 static void perf_top__mmap_read(struct perf_top *top)
873 for (i = 0; i < top->evlist->nr_mmaps; i++)
874 perf_top__mmap_read_idx(top, i);
877 static int perf_top__start_counters(struct perf_top *top)
880 struct perf_evsel *counter;
881 struct perf_evlist *evlist = top->evlist;
882 struct perf_record_opts *opts = &top->record_opts;
884 perf_evlist__config(evlist, opts);
886 list_for_each_entry(counter, &evlist->entries, node) {
888 if (perf_evsel__open(counter, top->evlist->cpus,
889 top->evlist->threads) < 0) {
890 if (perf_evsel__fallback(counter, errno, msg, sizeof(msg))) {
892 ui__warning("%s\n", msg);
896 perf_evsel__open_strerror(counter, &opts->target,
897 errno, msg, sizeof(msg));
898 ui__error("%s\n", msg);
903 if (perf_evlist__mmap(evlist, opts->mmap_pages, false) < 0) {
904 ui__error("Failed to mmap with %d (%s)\n",
905 errno, strerror(errno));
915 static int perf_top__setup_sample_type(struct perf_top *top)
917 if (!top->sort_has_symbols) {
918 if (symbol_conf.use_callchain) {
919 ui__error("Selected -g but \"sym\" not present in --sort/-s.");
922 } else if (callchain_param.mode != CHAIN_NONE) {
923 if (callchain_register_param(&callchain_param) < 0) {
924 ui__error("Can't register callchain params.\n");
932 static int __cmd_top(struct perf_top *top)
934 struct perf_record_opts *opts = &top->record_opts;
938 * FIXME: perf_session__new should allow passing a O_MMAP, so that all this
939 * mmap reading, etc is encapsulated in it. Use O_WRONLY for now.
941 top->session = perf_session__new(NULL, O_WRONLY, false, false, NULL);
942 if (top->session == NULL)
945 ret = perf_top__setup_sample_type(top);
949 if (perf_target__has_task(&opts->target))
950 perf_event__synthesize_thread_map(&top->tool, top->evlist->threads,
952 &top->session->machines.host);
954 perf_event__synthesize_threads(&top->tool, perf_event__process,
955 &top->session->machines.host);
957 ret = perf_top__start_counters(top);
961 top->session->evlist = top->evlist;
962 perf_session__set_id_hdr_size(top->session);
965 * When perf is starting the traced process, all the events (apart from
966 * group members) have enable_on_exec=1 set, so don't spoil it by
967 * prematurely enabling them.
969 * XXX 'top' still doesn't start workloads like record, trace, but should,
970 * so leave the check here.
972 if (!perf_target__none(&opts->target))
973 perf_evlist__enable(top->evlist);
975 /* Wait for a minimal set of events before starting the snapshot */
976 poll(top->evlist->pollfd, top->evlist->nr_fds, 100);
978 perf_top__mmap_read(top);
981 if (pthread_create(&thread, NULL, (use_browser > 0 ? display_thread_tui :
982 display_thread), top)) {
983 ui__error("Could not create display thread.\n");
987 if (top->realtime_prio) {
988 struct sched_param param;
990 param.sched_priority = top->realtime_prio;
991 if (sched_setscheduler(0, SCHED_FIFO, ¶m)) {
992 ui__error("Could not set realtime priority.\n");
998 u64 hits = top->samples;
1000 perf_top__mmap_read(top);
1002 if (hits == top->samples)
1003 ret = poll(top->evlist->pollfd, top->evlist->nr_fds, 100);
1008 perf_session__delete(top->session);
1009 top->session = NULL;
1015 parse_callchain_opt(const struct option *opt, const char *arg, int unset)
1023 symbol_conf.use_callchain = true;
1025 return record_parse_callchain_opt(opt, arg, unset);
1028 int cmd_top(int argc, const char **argv, const char *prefix __maybe_unused)
1031 char errbuf[BUFSIZ];
1032 struct perf_top top = {
1036 .mmap_pages = UINT_MAX,
1037 .user_freq = UINT_MAX,
1038 .user_interval = ULLONG_MAX,
1039 .freq = 4000, /* 4 KHz */
1044 .sym_pcnt_filter = 5,
1046 struct perf_record_opts *opts = &top.record_opts;
1047 struct perf_target *target = &opts->target;
1048 const struct option options[] = {
1049 OPT_CALLBACK('e', "event", &top.evlist, "event",
1050 "event selector. use 'perf list' to list available events",
1051 parse_events_option),
1052 OPT_U64('c', "count", &opts->user_interval, "event period to sample"),
1053 OPT_STRING('p', "pid", &target->pid, "pid",
1054 "profile events on existing process id"),
1055 OPT_STRING('t', "tid", &target->tid, "tid",
1056 "profile events on existing thread id"),
1057 OPT_BOOLEAN('a', "all-cpus", &target->system_wide,
1058 "system-wide collection from all CPUs"),
1059 OPT_STRING('C', "cpu", &target->cpu_list, "cpu",
1060 "list of cpus to monitor"),
1061 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1062 "file", "vmlinux pathname"),
1063 OPT_BOOLEAN('K', "hide_kernel_symbols", &top.hide_kernel_symbols,
1064 "hide kernel symbols"),
1065 OPT_UINTEGER('m', "mmap-pages", &opts->mmap_pages,
1066 "number of mmap data pages"),
1067 OPT_INTEGER('r', "realtime", &top.realtime_prio,
1068 "collect data with this RT SCHED_FIFO priority"),
1069 OPT_INTEGER('d', "delay", &top.delay_secs,
1070 "number of seconds to delay between refreshes"),
1071 OPT_BOOLEAN('D', "dump-symtab", &top.dump_symtab,
1072 "dump the symbol table used for profiling"),
1073 OPT_INTEGER('f', "count-filter", &top.count_filter,
1074 "only display functions with more events than this"),
1075 OPT_BOOLEAN('g', "group", &opts->group,
1076 "put the counters into a counter group"),
1077 OPT_BOOLEAN('i', "no-inherit", &opts->no_inherit,
1078 "child tasks do not inherit counters"),
1079 OPT_STRING(0, "sym-annotate", &top.sym_filter, "symbol name",
1080 "symbol to annotate"),
1081 OPT_BOOLEAN('z', "zero", &top.zero, "zero history across updates"),
1082 OPT_UINTEGER('F', "freq", &opts->user_freq, "profile at this frequency"),
1083 OPT_INTEGER('E', "entries", &top.print_entries,
1084 "display this many functions"),
1085 OPT_BOOLEAN('U', "hide_user_symbols", &top.hide_user_symbols,
1086 "hide user symbols"),
1087 OPT_BOOLEAN(0, "tui", &top.use_tui, "Use the TUI interface"),
1088 OPT_BOOLEAN(0, "stdio", &top.use_stdio, "Use the stdio interface"),
1089 OPT_INCR('v', "verbose", &verbose,
1090 "be more verbose (show counter open errors, etc)"),
1091 OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
1092 "sort by key(s): pid, comm, dso, symbol, parent, weight, local_weight"),
1093 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
1094 "Show a column with the number of samples"),
1095 OPT_CALLBACK_DEFAULT('G', "call-graph", &top.record_opts,
1096 "mode[,dump_size]", record_callchain_help,
1097 &parse_callchain_opt, "fp"),
1098 OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
1099 "Show a column with the sum of periods"),
1100 OPT_STRING(0, "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
1101 "only consider symbols in these dsos"),
1102 OPT_STRING(0, "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1103 "only consider symbols in these comms"),
1104 OPT_STRING(0, "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1105 "only consider these symbols"),
1106 OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
1107 "Interleave source code with assembly code (default)"),
1108 OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
1109 "Display raw encoding of assembly instructions (default)"),
1110 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
1111 "Specify disassembler style (e.g. -M intel for intel syntax)"),
1112 OPT_STRING('u', "uid", &target->uid_str, "user", "user to profile"),
1115 const char * const top_usage[] = {
1116 "perf top [<options>]",
1120 top.evlist = perf_evlist__new();
1121 if (top.evlist == NULL)
1124 symbol_conf.exclude_other = false;
1126 argc = parse_options(argc, argv, options, top_usage, 0);
1128 usage_with_options(top_usage, options);
1130 if (sort_order == default_sort_order)
1131 sort_order = "dso,symbol";
1133 if (setup_sorting() < 0)
1134 usage_with_options(top_usage, options);
1138 else if (top.use_tui)
1141 setup_browser(false);
1143 status = perf_target__validate(target);
1145 perf_target__strerror(target, status, errbuf, BUFSIZ);
1146 ui__warning("%s", errbuf);
1149 status = perf_target__parse_uid(target);
1151 int saved_errno = errno;
1153 perf_target__strerror(target, status, errbuf, BUFSIZ);
1154 ui__error("%s", errbuf);
1156 status = -saved_errno;
1157 goto out_delete_evlist;
1160 if (perf_target__none(target))
1161 target->system_wide = true;
1163 if (perf_evlist__create_maps(top.evlist, target) < 0)
1164 usage_with_options(top_usage, options);
1166 if (!top.evlist->nr_entries &&
1167 perf_evlist__add_default(top.evlist) < 0) {
1168 ui__error("Not enough memory for event selector list\n");
1169 goto out_delete_maps;
1172 symbol_conf.nr_events = top.evlist->nr_entries;
1174 if (top.delay_secs < 1)
1177 if (opts->user_interval != ULLONG_MAX)
1178 opts->default_interval = opts->user_interval;
1179 if (opts->user_freq != UINT_MAX)
1180 opts->freq = opts->user_freq;
1183 * User specified count overrides default frequency.
1185 if (opts->default_interval)
1187 else if (opts->freq) {
1188 opts->default_interval = opts->freq;
1190 ui__error("frequency and count are zero, aborting\n");
1192 goto out_delete_maps;
1195 top.sym_evsel = perf_evlist__first(top.evlist);
1197 symbol_conf.priv_size = sizeof(struct annotation);
1199 symbol_conf.try_vmlinux_path = (symbol_conf.vmlinux_name == NULL);
1200 if (symbol__init() < 0)
1203 sort_entry__setup_elide(&sort_dso, symbol_conf.dso_list, "dso", stdout);
1204 sort_entry__setup_elide(&sort_comm, symbol_conf.comm_list, "comm", stdout);
1205 sort_entry__setup_elide(&sort_sym, symbol_conf.sym_list, "symbol", stdout);
1208 * Avoid annotation data structures overhead when symbols aren't on the
1211 top.sort_has_symbols = sort_sym.list.next != NULL;
1213 get_term_dimensions(&top.winsize);
1214 if (top.print_entries == 0) {
1215 struct sigaction act = {
1216 .sa_sigaction = perf_top__sig_winch,
1217 .sa_flags = SA_SIGINFO,
1219 perf_top__update_print_entries(&top);
1220 sigaction(SIGWINCH, &act, NULL);
1223 status = __cmd_top(&top);
1226 perf_evlist__delete_maps(top.evlist);
1228 perf_evlist__delete(top.evlist);