186470930SIngo Molnar /* 286470930SIngo Molnar * builtin-annotate.c 386470930SIngo Molnar * 486470930SIngo Molnar * Builtin annotate command: Analyze the perf.data input file, 586470930SIngo Molnar * look up and read DSOs and symbol information and display 686470930SIngo Molnar * a histogram of results, along various sorting keys. 786470930SIngo Molnar */ 886470930SIngo Molnar #include "builtin.h" 986470930SIngo Molnar 1086470930SIngo Molnar #include "util/util.h" 1186470930SIngo Molnar #include "util/color.h" 125da50258SArnaldo Carvalho de Melo #include <linux/list.h> 1386470930SIngo Molnar #include "util/cache.h" 1443cbcd8aSArnaldo Carvalho de Melo #include <linux/rbtree.h> 1586470930SIngo Molnar #include "util/symbol.h" 1686470930SIngo Molnar 1786470930SIngo Molnar #include "perf.h" 188f28827aSFrederic Weisbecker #include "util/debug.h" 1986470930SIngo Molnar 20e248de33SArnaldo Carvalho de Melo #include "util/evlist.h" 21e248de33SArnaldo Carvalho de Melo #include "util/evsel.h" 2278f7defeSArnaldo Carvalho de Melo #include "util/annotate.h" 2362daacb5SArnaldo Carvalho de Melo #include "util/event.h" 2486470930SIngo Molnar #include "util/parse-options.h" 2586470930SIngo Molnar #include "util/parse-events.h" 266baa0a5aSFrederic Weisbecker #include "util/thread.h" 27dd68ada2SJohn Kacur #include "util/sort.h" 283d1d07ecSJohn Kacur #include "util/hist.h" 2994c744b6SArnaldo Carvalho de Melo #include "util/session.h" 3086470930SIngo Molnar 315d67be97SAnton Blanchard #include <linux/bitmap.h> 325d67be97SAnton Blanchard 3386470930SIngo Molnar static char const *input_name = "perf.data"; 3486470930SIngo Molnar 358b9e74ebSArnaldo Carvalho de Melo static bool force, use_tui, use_stdio; 3686470930SIngo Molnar 37c0555642SIan Munsie static bool full_paths; 3842976487SMike Galbraith 39c0555642SIan Munsie static bool print_line; 40301406b9SFrederic Weisbecker 41e4204992SArnaldo Carvalho de Melo static const char *sym_hist_filter; 42e4204992SArnaldo Carvalho de Melo 435d67be97SAnton Blanchard static const char *cpu_list; 445d67be97SAnton Blanchard static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS); 455d67be97SAnton Blanchard 46e248de33SArnaldo Carvalho de Melo static int perf_evlist__add_sample(struct perf_evlist *evlist, 47e248de33SArnaldo Carvalho de Melo struct perf_sample *sample, 489e69c210SArnaldo Carvalho de Melo struct perf_evsel *evsel, 49e248de33SArnaldo Carvalho de Melo struct addr_location *al) 5086470930SIngo Molnar { 51628ada0cSArnaldo Carvalho de Melo struct hist_entry *he; 52e248de33SArnaldo Carvalho de Melo int ret; 53628ada0cSArnaldo Carvalho de Melo 54628ada0cSArnaldo Carvalho de Melo if (sym_hist_filter != NULL && 55628ada0cSArnaldo Carvalho de Melo (al->sym == NULL || strcmp(sym_hist_filter, al->sym->name) != 0)) { 56628ada0cSArnaldo Carvalho de Melo /* We're only interested in a symbol named sym_hist_filter */ 57628ada0cSArnaldo Carvalho de Melo if (al->sym != NULL) { 58628ada0cSArnaldo Carvalho de Melo rb_erase(&al->sym->rb_node, 59628ada0cSArnaldo Carvalho de Melo &al->map->dso->symbols[al->map->type]); 60628ada0cSArnaldo Carvalho de Melo symbol__delete(al->sym); 61628ada0cSArnaldo Carvalho de Melo } 62628ada0cSArnaldo Carvalho de Melo return 0; 63628ada0cSArnaldo Carvalho de Melo } 64628ada0cSArnaldo Carvalho de Melo 65e248de33SArnaldo Carvalho de Melo he = __hists__add_entry(&evsel->hists, al, NULL, 1); 669735abf1SArnaldo Carvalho de Melo if (he == NULL) 6786470930SIngo Molnar return -ENOMEM; 68628ada0cSArnaldo Carvalho de Melo 69e248de33SArnaldo Carvalho de Melo ret = 0; 702f525d01SArnaldo Carvalho de Melo if (he->ms.sym != NULL) { 712f525d01SArnaldo Carvalho de Melo struct annotation *notes = symbol__annotation(he->ms.sym); 72ce6f4fabSArnaldo Carvalho de Melo if (notes->src == NULL && 73e248de33SArnaldo Carvalho de Melo symbol__alloc_hist(he->ms.sym, evlist->nr_entries) < 0) 742f525d01SArnaldo Carvalho de Melo return -ENOMEM; 752f525d01SArnaldo Carvalho de Melo 76e248de33SArnaldo Carvalho de Melo ret = hist_entry__inc_addr_samples(he, evsel->idx, al->addr); 772f525d01SArnaldo Carvalho de Melo } 782f525d01SArnaldo Carvalho de Melo 79e248de33SArnaldo Carvalho de Melo evsel->hists.stats.total_period += sample->period; 80e248de33SArnaldo Carvalho de Melo hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE); 81e248de33SArnaldo Carvalho de Melo return ret; 8286470930SIngo Molnar } 8386470930SIngo Molnar 848115d60cSArnaldo Carvalho de Melo static int process_sample_event(union perf_event *event, 858115d60cSArnaldo Carvalho de Melo struct perf_sample *sample, 869e69c210SArnaldo Carvalho de Melo struct perf_evsel *evsel, 87640c03ceSArnaldo Carvalho de Melo struct perf_session *session) 8886470930SIngo Molnar { 891ed091c4SArnaldo Carvalho de Melo struct addr_location al; 906baa0a5aSFrederic Weisbecker 91ce6f4fabSArnaldo Carvalho de Melo if (perf_event__preprocess_sample(event, session, &al, sample, 92ce6f4fabSArnaldo Carvalho de Melo symbol__annotate_init) < 0) { 9329a9f66dSArnaldo Carvalho de Melo pr_warning("problem processing %d event, skipping it.\n", 9486470930SIngo Molnar event->header.type); 9586470930SIngo Molnar return -1; 9686470930SIngo Molnar } 9786470930SIngo Molnar 985d67be97SAnton Blanchard if (cpu_list && !test_bit(sample->cpu, cpu_bitmap)) 995d67be97SAnton Blanchard return 0; 1005d67be97SAnton Blanchard 1019e69c210SArnaldo Carvalho de Melo if (!al.filtered && 1029e69c210SArnaldo Carvalho de Melo perf_evlist__add_sample(session->evlist, sample, evsel, &al)) { 10329a9f66dSArnaldo Carvalho de Melo pr_warning("problem incrementing symbol count, " 104ec218fc4SArnaldo Carvalho de Melo "skipping event\n"); 10586470930SIngo Molnar return -1; 10686470930SIngo Molnar } 10786470930SIngo Molnar 10886470930SIngo Molnar return 0; 10986470930SIngo Molnar } 11086470930SIngo Molnar 1112f525d01SArnaldo Carvalho de Melo static int hist_entry__tty_annotate(struct hist_entry *he, int evidx) 11286470930SIngo Molnar { 1132f525d01SArnaldo Carvalho de Melo return symbol__tty_annotate(he->ms.sym, he->ms.map, evidx, 114d040bd36SArnaldo Carvalho de Melo print_line, full_paths, 0, 0); 11586470930SIngo Molnar } 11686470930SIngo Molnar 117e248de33SArnaldo Carvalho de Melo static void hists__find_annotations(struct hists *self, int evidx) 11886470930SIngo Molnar { 119b50e003dSArnaldo Carvalho de Melo struct rb_node *nd = rb_first(&self->entries), *next; 12046e3e055SArnaldo Carvalho de Melo int key = KEY_RIGHT; 12186470930SIngo Molnar 12246e3e055SArnaldo Carvalho de Melo while (nd) { 123ed52ce2eSArnaldo Carvalho de Melo struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node); 12478f7defeSArnaldo Carvalho de Melo struct annotation *notes; 12586470930SIngo Molnar 12646e3e055SArnaldo Carvalho de Melo if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned) 12746e3e055SArnaldo Carvalho de Melo goto find_next; 128e4204992SArnaldo Carvalho de Melo 12978f7defeSArnaldo Carvalho de Melo notes = symbol__annotation(he->ms.sym); 130ce6f4fabSArnaldo Carvalho de Melo if (notes->src == NULL) { 13146e3e055SArnaldo Carvalho de Melo find_next: 13246e3e055SArnaldo Carvalho de Melo if (key == KEY_LEFT) 13346e3e055SArnaldo Carvalho de Melo nd = rb_prev(nd); 13446e3e055SArnaldo Carvalho de Melo else 13546e3e055SArnaldo Carvalho de Melo nd = rb_next(nd); 136e4204992SArnaldo Carvalho de Melo continue; 13746e3e055SArnaldo Carvalho de Melo } 138e4204992SArnaldo Carvalho de Melo 13962e3436bSArnaldo Carvalho de Melo if (use_browser > 0) { 140e248de33SArnaldo Carvalho de Melo key = hist_entry__tui_annotate(he, evidx); 14146e3e055SArnaldo Carvalho de Melo switch (key) { 14246e3e055SArnaldo Carvalho de Melo case KEY_RIGHT: 143b50e003dSArnaldo Carvalho de Melo next = rb_next(nd); 14446e3e055SArnaldo Carvalho de Melo break; 14546e3e055SArnaldo Carvalho de Melo case KEY_LEFT: 146b50e003dSArnaldo Carvalho de Melo next = rb_prev(nd); 14746e3e055SArnaldo Carvalho de Melo break; 148b50e003dSArnaldo Carvalho de Melo default: 149b50e003dSArnaldo Carvalho de Melo return; 15046e3e055SArnaldo Carvalho de Melo } 151b50e003dSArnaldo Carvalho de Melo 152b50e003dSArnaldo Carvalho de Melo if (next != NULL) 153b50e003dSArnaldo Carvalho de Melo nd = next; 15446e3e055SArnaldo Carvalho de Melo } else { 155e248de33SArnaldo Carvalho de Melo hist_entry__tty_annotate(he, evidx); 15646e3e055SArnaldo Carvalho de Melo nd = rb_next(nd); 157ed52ce2eSArnaldo Carvalho de Melo /* 15846e3e055SArnaldo Carvalho de Melo * Since we have a hist_entry per IP for the same 159ce6f4fabSArnaldo Carvalho de Melo * symbol, free he->ms.sym->src to signal we already 16046e3e055SArnaldo Carvalho de Melo * processed this symbol. 161ed52ce2eSArnaldo Carvalho de Melo */ 162ce6f4fabSArnaldo Carvalho de Melo free(notes->src); 163ce6f4fabSArnaldo Carvalho de Melo notes->src = NULL; 16486470930SIngo Molnar } 16586470930SIngo Molnar } 16646e3e055SArnaldo Carvalho de Melo } 16786470930SIngo Molnar 168301a0b02SArnaldo Carvalho de Melo static struct perf_event_ops event_ops = { 16955aa640fSArnaldo Carvalho de Melo .sample = process_sample_event, 1708115d60cSArnaldo Carvalho de Melo .mmap = perf_event__process_mmap, 1718115d60cSArnaldo Carvalho de Melo .comm = perf_event__process_comm, 1728115d60cSArnaldo Carvalho de Melo .fork = perf_event__process_task, 173eac23d1cSIan Munsie .ordered_samples = true, 174eac23d1cSIan Munsie .ordering_requires_timestamps = true, 175bab81b62SLi Zefan }; 176bab81b62SLi Zefan 17786470930SIngo Molnar static int __cmd_annotate(void) 17886470930SIngo Molnar { 179bab81b62SLi Zefan int ret; 18075be6cf4SArnaldo Carvalho de Melo struct perf_session *session; 181e248de33SArnaldo Carvalho de Melo struct perf_evsel *pos; 182e248de33SArnaldo Carvalho de Melo u64 total_nr_samples; 18386470930SIngo Molnar 18421ef97f0SIan Munsie session = perf_session__new(input_name, O_RDONLY, force, false, &event_ops); 18594c744b6SArnaldo Carvalho de Melo if (session == NULL) 18694c744b6SArnaldo Carvalho de Melo return -ENOMEM; 18794c744b6SArnaldo Carvalho de Melo 1885d67be97SAnton Blanchard if (cpu_list) { 1895d67be97SAnton Blanchard ret = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap); 1905d67be97SAnton Blanchard if (ret) 1915d67be97SAnton Blanchard goto out_delete; 1925d67be97SAnton Blanchard } 1935d67be97SAnton Blanchard 194ec913369SArnaldo Carvalho de Melo ret = perf_session__process_events(session, &event_ops); 195bab81b62SLi Zefan if (ret) 19694c744b6SArnaldo Carvalho de Melo goto out_delete; 19786470930SIngo Molnar 19862daacb5SArnaldo Carvalho de Melo if (dump_trace) { 199c8446b9bSArnaldo Carvalho de Melo perf_session__fprintf_nr_events(session, stdout); 20094c744b6SArnaldo Carvalho de Melo goto out_delete; 20162daacb5SArnaldo Carvalho de Melo } 20286470930SIngo Molnar 203da21d1b5SArnaldo Carvalho de Melo if (verbose > 3) 204b3165f41SArnaldo Carvalho de Melo perf_session__fprintf(session, stdout); 20586470930SIngo Molnar 206da21d1b5SArnaldo Carvalho de Melo if (verbose > 2) 207cbf69680SArnaldo Carvalho de Melo perf_session__fprintf_dsos(session, stdout); 20886470930SIngo Molnar 209e248de33SArnaldo Carvalho de Melo total_nr_samples = 0; 210e248de33SArnaldo Carvalho de Melo list_for_each_entry(pos, &session->evlist->entries, node) { 211e248de33SArnaldo Carvalho de Melo struct hists *hists = &pos->hists; 212e248de33SArnaldo Carvalho de Melo u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE]; 21386470930SIngo Molnar 214e248de33SArnaldo Carvalho de Melo if (nr_samples > 0) { 215e248de33SArnaldo Carvalho de Melo total_nr_samples += nr_samples; 216e248de33SArnaldo Carvalho de Melo hists__collapse_resort(hists); 217e248de33SArnaldo Carvalho de Melo hists__output_resort(hists); 218e248de33SArnaldo Carvalho de Melo hists__find_annotations(hists, pos->idx); 219e248de33SArnaldo Carvalho de Melo } 220e248de33SArnaldo Carvalho de Melo } 221e248de33SArnaldo Carvalho de Melo 222e248de33SArnaldo Carvalho de Melo if (total_nr_samples == 0) { 223e248de33SArnaldo Carvalho de Melo ui__warning("The %s file has no samples!\n", input_name); 224e248de33SArnaldo Carvalho de Melo goto out_delete; 225e248de33SArnaldo Carvalho de Melo } 226e248de33SArnaldo Carvalho de Melo out_delete: 227e248de33SArnaldo Carvalho de Melo /* 228e248de33SArnaldo Carvalho de Melo * Speed up the exit process, for large files this can 229e248de33SArnaldo Carvalho de Melo * take quite a while. 230e248de33SArnaldo Carvalho de Melo * 231e248de33SArnaldo Carvalho de Melo * XXX Enable this when using valgrind or if we ever 232e248de33SArnaldo Carvalho de Melo * librarize this command. 233e248de33SArnaldo Carvalho de Melo * 234e248de33SArnaldo Carvalho de Melo * Also experiment with obstacks to see how much speed 235e248de33SArnaldo Carvalho de Melo * up we'll get here. 236e248de33SArnaldo Carvalho de Melo * 237e248de33SArnaldo Carvalho de Melo * perf_session__delete(session); 238e248de33SArnaldo Carvalho de Melo */ 239bab81b62SLi Zefan return ret; 24086470930SIngo Molnar } 24186470930SIngo Molnar 24286470930SIngo Molnar static const char * const annotate_usage[] = { 24386470930SIngo Molnar "perf annotate [<options>] <command>", 24486470930SIngo Molnar NULL 24586470930SIngo Molnar }; 24686470930SIngo Molnar 24786470930SIngo Molnar static const struct option options[] = { 24886470930SIngo Molnar OPT_STRING('i', "input", &input_name, "file", 24986470930SIngo Molnar "input file name"), 250ac73c5a9SArnaldo Carvalho de Melo OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]", 251ac73c5a9SArnaldo Carvalho de Melo "only consider symbols in these dsos"), 25223b87116SIngo Molnar OPT_STRING('s', "symbol", &sym_hist_filter, "symbol", 25386470930SIngo Molnar "symbol to annotate"), 254fa6963b2SPeter Zijlstra OPT_BOOLEAN('f', "force", &force, "don't complain, do it"), 255c0555642SIan Munsie OPT_INCR('v', "verbose", &verbose, 25686470930SIngo Molnar "be more verbose (show symbol address, etc)"), 25786470930SIngo Molnar OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, 25886470930SIngo Molnar "dump raw trace in ASCII"), 2598b9e74ebSArnaldo Carvalho de Melo OPT_BOOLEAN(0, "tui", &use_tui, "Use the TUI interface"), 2608b9e74ebSArnaldo Carvalho de Melo OPT_BOOLEAN(0, "stdio", &use_stdio, "Use the stdio interface"), 261b32d133aSArnaldo Carvalho de Melo OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, 262b32d133aSArnaldo Carvalho de Melo "file", "vmlinux pathname"), 263b32d133aSArnaldo Carvalho de Melo OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules, 26442976487SMike Galbraith "load module symbols - WARNING: use only with -k and LIVE kernel"), 265301406b9SFrederic Weisbecker OPT_BOOLEAN('l', "print-line", &print_line, 266301406b9SFrederic Weisbecker "print matching source lines (may be slow)"), 26742976487SMike Galbraith OPT_BOOLEAN('P', "full-paths", &full_paths, 26842976487SMike Galbraith "Don't shorten the displayed pathnames"), 2695d67be97SAnton Blanchard OPT_STRING('c', "cpu", &cpu_list, "cpu", "list of cpus to profile"), 270e71a0598SStephane Eranian OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory", 271e71a0598SStephane Eranian "Look for files with symbols relative to this directory"), 2723e6a2a7fSStephane Eranian OPT_BOOLEAN('0', "source", &symbol_conf.annotate_src, 2733e6a2a7fSStephane Eranian "Interleave source code with assembly code (default)"), 2743e6a2a7fSStephane Eranian OPT_BOOLEAN('0', "asm-raw", &symbol_conf.annotate_asm_raw, 2753e6a2a7fSStephane Eranian "Display raw encoding of assembly instructions (default)"), 276f69b64f7SAndi Kleen OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style", 277f69b64f7SAndi Kleen "Specify disassembler style (e.g. -M intel for intel syntax)"), 27886470930SIngo Molnar OPT_END() 27986470930SIngo Molnar }; 28086470930SIngo Molnar 281f37a291cSIngo Molnar int cmd_annotate(int argc, const char **argv, const char *prefix __used) 28286470930SIngo Molnar { 283655000e7SArnaldo Carvalho de Melo argc = parse_options(argc, argv, options, annotate_usage, 0); 284655000e7SArnaldo Carvalho de Melo 2858b9e74ebSArnaldo Carvalho de Melo if (use_stdio) 2868b9e74ebSArnaldo Carvalho de Melo use_browser = 0; 2878b9e74ebSArnaldo Carvalho de Melo else if (use_tui) 2888b9e74ebSArnaldo Carvalho de Melo use_browser = 1; 2898b9e74ebSArnaldo Carvalho de Melo 290229ade9bSArnaldo Carvalho de Melo setup_browser(true); 29146e3e055SArnaldo Carvalho de Melo 29278f7defeSArnaldo Carvalho de Melo symbol_conf.priv_size = sizeof(struct annotation); 29375be6cf4SArnaldo Carvalho de Melo symbol_conf.try_vmlinux_path = true; 29475be6cf4SArnaldo Carvalho de Melo 29575be6cf4SArnaldo Carvalho de Melo if (symbol__init() < 0) 296b32d133aSArnaldo Carvalho de Melo return -1; 29786470930SIngo Molnar 298c8829c7aSArnaldo Carvalho de Melo setup_sorting(annotate_usage, options); 29986470930SIngo Molnar 30086470930SIngo Molnar if (argc) { 30186470930SIngo Molnar /* 30286470930SIngo Molnar * Special case: if there's an argument left then assume tha 30386470930SIngo Molnar * it's a symbol filter: 30486470930SIngo Molnar */ 30586470930SIngo Molnar if (argc > 1) 30686470930SIngo Molnar usage_with_options(annotate_usage, options); 30786470930SIngo Molnar 30886470930SIngo Molnar sym_hist_filter = argv[0]; 30986470930SIngo Molnar } 31086470930SIngo Molnar 311dd68ada2SJohn Kacur if (field_sep && *field_sep == '.') { 31229a9f66dSArnaldo Carvalho de Melo pr_err("'.' is the only non valid --field-separator argument\n"); 31329a9f66dSArnaldo Carvalho de Melo return -1; 314dd68ada2SJohn Kacur } 315dd68ada2SJohn Kacur 31686470930SIngo Molnar return __cmd_annotate(); 31786470930SIngo Molnar } 318