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" 3045694aa7SArnaldo Carvalho de Melo #include "util/tool.h" 3186470930SIngo Molnar 325d67be97SAnton Blanchard #include <linux/bitmap.h> 335d67be97SAnton Blanchard 34d20deb64SArnaldo Carvalho de Melo struct perf_annotate { 3545694aa7SArnaldo Carvalho de Melo struct perf_tool tool; 367009cc34SArnaldo Carvalho de Melo char const *input_name; 377009cc34SArnaldo Carvalho de Melo bool force, use_tui, use_stdio; 387009cc34SArnaldo Carvalho de Melo bool full_paths; 397009cc34SArnaldo Carvalho de Melo bool print_line; 407009cc34SArnaldo Carvalho de Melo const char *sym_hist_filter; 417009cc34SArnaldo Carvalho de Melo const char *cpu_list; 427009cc34SArnaldo Carvalho de Melo DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS); 43d20deb64SArnaldo Carvalho de Melo }; 445d67be97SAnton Blanchard 45d04b35f8SArnaldo Carvalho de Melo static int perf_evsel__add_sample(struct perf_evsel *evsel, 46e248de33SArnaldo Carvalho de Melo struct perf_sample *sample, 47d20deb64SArnaldo Carvalho de Melo struct addr_location *al, 48d20deb64SArnaldo Carvalho de Melo struct perf_annotate *ann) 4986470930SIngo Molnar { 50628ada0cSArnaldo Carvalho de Melo struct hist_entry *he; 51e248de33SArnaldo Carvalho de Melo int ret; 52628ada0cSArnaldo Carvalho de Melo 537009cc34SArnaldo Carvalho de Melo if (ann->sym_hist_filter != NULL && 547009cc34SArnaldo Carvalho de Melo (al->sym == NULL || 557009cc34SArnaldo Carvalho de Melo strcmp(ann->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); 72d04b35f8SArnaldo Carvalho de Melo if (notes->src == NULL && symbol__alloc_hist(he->ms.sym) < 0) 732f525d01SArnaldo Carvalho de Melo return -ENOMEM; 742f525d01SArnaldo Carvalho de Melo 75e248de33SArnaldo Carvalho de Melo ret = hist_entry__inc_addr_samples(he, evsel->idx, al->addr); 762f525d01SArnaldo Carvalho de Melo } 772f525d01SArnaldo Carvalho de Melo 78e248de33SArnaldo Carvalho de Melo evsel->hists.stats.total_period += sample->period; 79e248de33SArnaldo Carvalho de Melo hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE); 80e248de33SArnaldo Carvalho de Melo return ret; 8186470930SIngo Molnar } 8286470930SIngo Molnar 8345694aa7SArnaldo Carvalho de Melo static int process_sample_event(struct perf_tool *tool, 84d20deb64SArnaldo Carvalho de Melo union perf_event *event, 858115d60cSArnaldo Carvalho de Melo struct perf_sample *sample, 869e69c210SArnaldo Carvalho de Melo struct perf_evsel *evsel, 87743eb868SArnaldo Carvalho de Melo struct machine *machine) 8886470930SIngo Molnar { 8945694aa7SArnaldo Carvalho de Melo struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool); 901ed091c4SArnaldo Carvalho de Melo struct addr_location al; 916baa0a5aSFrederic Weisbecker 92743eb868SArnaldo Carvalho de Melo if (perf_event__preprocess_sample(event, machine, &al, sample, 93ce6f4fabSArnaldo Carvalho de Melo symbol__annotate_init) < 0) { 9429a9f66dSArnaldo Carvalho de Melo pr_warning("problem processing %d event, skipping it.\n", 9586470930SIngo Molnar event->header.type); 9686470930SIngo Molnar return -1; 9786470930SIngo Molnar } 9886470930SIngo Molnar 997009cc34SArnaldo Carvalho de Melo if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap)) 1005d67be97SAnton Blanchard return 0; 1015d67be97SAnton Blanchard 102d20deb64SArnaldo Carvalho de Melo if (!al.filtered && perf_evsel__add_sample(evsel, sample, &al, ann)) { 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 111d20deb64SArnaldo Carvalho de Melo static int hist_entry__tty_annotate(struct hist_entry *he, int evidx, 112d20deb64SArnaldo Carvalho de Melo struct perf_annotate *ann) 11386470930SIngo Molnar { 1142f525d01SArnaldo Carvalho de Melo return symbol__tty_annotate(he->ms.sym, he->ms.map, evidx, 1157009cc34SArnaldo Carvalho de Melo ann->print_line, ann->full_paths, 0, 0); 11686470930SIngo Molnar } 11786470930SIngo Molnar 118d20deb64SArnaldo Carvalho de Melo static void hists__find_annotations(struct hists *self, int evidx, 119d20deb64SArnaldo Carvalho de Melo struct perf_annotate *ann) 12086470930SIngo Molnar { 121b50e003dSArnaldo Carvalho de Melo struct rb_node *nd = rb_first(&self->entries), *next; 122cf958003SArnaldo Carvalho de Melo int key = K_RIGHT; 12386470930SIngo Molnar 12446e3e055SArnaldo Carvalho de Melo while (nd) { 125ed52ce2eSArnaldo Carvalho de Melo struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node); 12678f7defeSArnaldo Carvalho de Melo struct annotation *notes; 12786470930SIngo Molnar 12846e3e055SArnaldo Carvalho de Melo if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned) 12946e3e055SArnaldo Carvalho de Melo goto find_next; 130e4204992SArnaldo Carvalho de Melo 13178f7defeSArnaldo Carvalho de Melo notes = symbol__annotation(he->ms.sym); 132ce6f4fabSArnaldo Carvalho de Melo if (notes->src == NULL) { 13346e3e055SArnaldo Carvalho de Melo find_next: 134cf958003SArnaldo Carvalho de Melo if (key == K_LEFT) 13546e3e055SArnaldo Carvalho de Melo nd = rb_prev(nd); 13646e3e055SArnaldo Carvalho de Melo else 13746e3e055SArnaldo Carvalho de Melo nd = rb_next(nd); 138e4204992SArnaldo Carvalho de Melo continue; 13946e3e055SArnaldo Carvalho de Melo } 140e4204992SArnaldo Carvalho de Melo 14162e3436bSArnaldo Carvalho de Melo if (use_browser > 0) { 142d04b35f8SArnaldo Carvalho de Melo key = hist_entry__tui_annotate(he, evidx, NULL, NULL, 0); 14346e3e055SArnaldo Carvalho de Melo switch (key) { 144cf958003SArnaldo Carvalho de Melo case K_RIGHT: 145b50e003dSArnaldo Carvalho de Melo next = rb_next(nd); 14646e3e055SArnaldo Carvalho de Melo break; 147cf958003SArnaldo Carvalho de Melo case K_LEFT: 148b50e003dSArnaldo Carvalho de Melo next = rb_prev(nd); 14946e3e055SArnaldo Carvalho de Melo break; 150b50e003dSArnaldo Carvalho de Melo default: 151b50e003dSArnaldo Carvalho de Melo return; 15246e3e055SArnaldo Carvalho de Melo } 153b50e003dSArnaldo Carvalho de Melo 154b50e003dSArnaldo Carvalho de Melo if (next != NULL) 155b50e003dSArnaldo Carvalho de Melo nd = next; 15646e3e055SArnaldo Carvalho de Melo } else { 157d20deb64SArnaldo Carvalho de Melo hist_entry__tty_annotate(he, evidx, ann); 15846e3e055SArnaldo Carvalho de Melo nd = rb_next(nd); 159ed52ce2eSArnaldo Carvalho de Melo /* 16046e3e055SArnaldo Carvalho de Melo * Since we have a hist_entry per IP for the same 161ce6f4fabSArnaldo Carvalho de Melo * symbol, free he->ms.sym->src to signal we already 16246e3e055SArnaldo Carvalho de Melo * processed this symbol. 163ed52ce2eSArnaldo Carvalho de Melo */ 164ce6f4fabSArnaldo Carvalho de Melo free(notes->src); 165ce6f4fabSArnaldo Carvalho de Melo notes->src = NULL; 16686470930SIngo Molnar } 16786470930SIngo Molnar } 16846e3e055SArnaldo Carvalho de Melo } 16986470930SIngo Molnar 170d20deb64SArnaldo Carvalho de Melo static int __cmd_annotate(struct perf_annotate *ann) 17186470930SIngo Molnar { 172bab81b62SLi Zefan int ret; 17375be6cf4SArnaldo Carvalho de Melo struct perf_session *session; 174e248de33SArnaldo Carvalho de Melo struct perf_evsel *pos; 175e248de33SArnaldo Carvalho de Melo u64 total_nr_samples; 17686470930SIngo Molnar 1777009cc34SArnaldo Carvalho de Melo session = perf_session__new(ann->input_name, O_RDONLY, 17845694aa7SArnaldo Carvalho de Melo ann->force, false, &ann->tool); 17994c744b6SArnaldo Carvalho de Melo if (session == NULL) 18094c744b6SArnaldo Carvalho de Melo return -ENOMEM; 18194c744b6SArnaldo Carvalho de Melo 1827009cc34SArnaldo Carvalho de Melo if (ann->cpu_list) { 1837009cc34SArnaldo Carvalho de Melo ret = perf_session__cpu_bitmap(session, ann->cpu_list, 1847009cc34SArnaldo Carvalho de Melo ann->cpu_bitmap); 1855d67be97SAnton Blanchard if (ret) 1865d67be97SAnton Blanchard goto out_delete; 1875d67be97SAnton Blanchard } 1885d67be97SAnton Blanchard 18945694aa7SArnaldo Carvalho de Melo ret = perf_session__process_events(session, &ann->tool); 190bab81b62SLi Zefan if (ret) 19194c744b6SArnaldo Carvalho de Melo goto out_delete; 19286470930SIngo Molnar 19362daacb5SArnaldo Carvalho de Melo if (dump_trace) { 194c8446b9bSArnaldo Carvalho de Melo perf_session__fprintf_nr_events(session, stdout); 19594c744b6SArnaldo Carvalho de Melo goto out_delete; 19662daacb5SArnaldo Carvalho de Melo } 19786470930SIngo Molnar 198da21d1b5SArnaldo Carvalho de Melo if (verbose > 3) 199b3165f41SArnaldo Carvalho de Melo perf_session__fprintf(session, stdout); 20086470930SIngo Molnar 201da21d1b5SArnaldo Carvalho de Melo if (verbose > 2) 202cbf69680SArnaldo Carvalho de Melo perf_session__fprintf_dsos(session, stdout); 20386470930SIngo Molnar 204e248de33SArnaldo Carvalho de Melo total_nr_samples = 0; 205e248de33SArnaldo Carvalho de Melo list_for_each_entry(pos, &session->evlist->entries, node) { 206e248de33SArnaldo Carvalho de Melo struct hists *hists = &pos->hists; 207e248de33SArnaldo Carvalho de Melo u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE]; 20886470930SIngo Molnar 209e248de33SArnaldo Carvalho de Melo if (nr_samples > 0) { 210e248de33SArnaldo Carvalho de Melo total_nr_samples += nr_samples; 211e248de33SArnaldo Carvalho de Melo hists__collapse_resort(hists); 212e248de33SArnaldo Carvalho de Melo hists__output_resort(hists); 213d20deb64SArnaldo Carvalho de Melo hists__find_annotations(hists, pos->idx, ann); 214e248de33SArnaldo Carvalho de Melo } 215e248de33SArnaldo Carvalho de Melo } 216e248de33SArnaldo Carvalho de Melo 217e248de33SArnaldo Carvalho de Melo if (total_nr_samples == 0) { 2183780f488SNamhyung Kim ui__error("The %s file has no samples!\n", session->filename); 219e248de33SArnaldo Carvalho de Melo goto out_delete; 220e248de33SArnaldo Carvalho de Melo } 221e248de33SArnaldo Carvalho de Melo out_delete: 222e248de33SArnaldo Carvalho de Melo /* 223e248de33SArnaldo Carvalho de Melo * Speed up the exit process, for large files this can 224e248de33SArnaldo Carvalho de Melo * take quite a while. 225e248de33SArnaldo Carvalho de Melo * 226e248de33SArnaldo Carvalho de Melo * XXX Enable this when using valgrind or if we ever 227e248de33SArnaldo Carvalho de Melo * librarize this command. 228e248de33SArnaldo Carvalho de Melo * 229e248de33SArnaldo Carvalho de Melo * Also experiment with obstacks to see how much speed 230e248de33SArnaldo Carvalho de Melo * up we'll get here. 231e248de33SArnaldo Carvalho de Melo * 232e248de33SArnaldo Carvalho de Melo * perf_session__delete(session); 233e248de33SArnaldo Carvalho de Melo */ 234bab81b62SLi Zefan return ret; 23586470930SIngo Molnar } 23686470930SIngo Molnar 23786470930SIngo Molnar static const char * const annotate_usage[] = { 23899345254SNamhyung Kim "perf annotate [<options>]", 23986470930SIngo Molnar NULL 24086470930SIngo Molnar }; 24186470930SIngo Molnar 242d20deb64SArnaldo Carvalho de Melo int cmd_annotate(int argc, const char **argv, const char *prefix __used) 243d20deb64SArnaldo Carvalho de Melo { 244d20deb64SArnaldo Carvalho de Melo struct perf_annotate annotate = { 24545694aa7SArnaldo Carvalho de Melo .tool = { 246d20deb64SArnaldo Carvalho de Melo .sample = process_sample_event, 247d20deb64SArnaldo Carvalho de Melo .mmap = perf_event__process_mmap, 248d20deb64SArnaldo Carvalho de Melo .comm = perf_event__process_comm, 249d20deb64SArnaldo Carvalho de Melo .fork = perf_event__process_task, 250d20deb64SArnaldo Carvalho de Melo .ordered_samples = true, 251d20deb64SArnaldo Carvalho de Melo .ordering_requires_timestamps = true, 252d20deb64SArnaldo Carvalho de Melo }, 253d20deb64SArnaldo Carvalho de Melo }; 254d20deb64SArnaldo Carvalho de Melo const struct option options[] = { 2557009cc34SArnaldo Carvalho de Melo OPT_STRING('i', "input", &annotate.input_name, "file", 25686470930SIngo Molnar "input file name"), 257ac73c5a9SArnaldo Carvalho de Melo OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]", 258ac73c5a9SArnaldo Carvalho de Melo "only consider symbols in these dsos"), 2597009cc34SArnaldo Carvalho de Melo OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol", 26086470930SIngo Molnar "symbol to annotate"), 2617009cc34SArnaldo Carvalho de Melo OPT_BOOLEAN('f', "force", &annotate.force, "don't complain, do it"), 262c0555642SIan Munsie OPT_INCR('v', "verbose", &verbose, 26386470930SIngo Molnar "be more verbose (show symbol address, etc)"), 26486470930SIngo Molnar OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, 26586470930SIngo Molnar "dump raw trace in ASCII"), 2667009cc34SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"), 2677009cc34SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"), 268b32d133aSArnaldo Carvalho de Melo OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, 269b32d133aSArnaldo Carvalho de Melo "file", "vmlinux pathname"), 270b32d133aSArnaldo Carvalho de Melo OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules, 27142976487SMike Galbraith "load module symbols - WARNING: use only with -k and LIVE kernel"), 2727009cc34SArnaldo Carvalho de Melo OPT_BOOLEAN('l', "print-line", &annotate.print_line, 273301406b9SFrederic Weisbecker "print matching source lines (may be slow)"), 2747009cc34SArnaldo Carvalho de Melo OPT_BOOLEAN('P', "full-paths", &annotate.full_paths, 27542976487SMike Galbraith "Don't shorten the displayed pathnames"), 276c8e66720SDavid Ahern OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"), 277e71a0598SStephane Eranian OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory", 278e71a0598SStephane Eranian "Look for files with symbols relative to this directory"), 27964c6f0c7SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src, 2803e6a2a7fSStephane Eranian "Interleave source code with assembly code (default)"), 28164c6f0c7SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw, 2823e6a2a7fSStephane Eranian "Display raw encoding of assembly instructions (default)"), 283f69b64f7SAndi Kleen OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style", 284f69b64f7SAndi Kleen "Specify disassembler style (e.g. -M intel for intel syntax)"), 28586470930SIngo Molnar OPT_END() 28686470930SIngo Molnar }; 28786470930SIngo Molnar 288655000e7SArnaldo Carvalho de Melo argc = parse_options(argc, argv, options, annotate_usage, 0); 289655000e7SArnaldo Carvalho de Melo 2907009cc34SArnaldo Carvalho de Melo if (annotate.use_stdio) 2918b9e74ebSArnaldo Carvalho de Melo use_browser = 0; 2927009cc34SArnaldo Carvalho de Melo else if (annotate.use_tui) 2938b9e74ebSArnaldo Carvalho de Melo use_browser = 1; 2948b9e74ebSArnaldo Carvalho de Melo 295229ade9bSArnaldo Carvalho de Melo setup_browser(true); 29646e3e055SArnaldo Carvalho de Melo 29778f7defeSArnaldo Carvalho de Melo symbol_conf.priv_size = sizeof(struct annotation); 29875be6cf4SArnaldo Carvalho de Melo symbol_conf.try_vmlinux_path = true; 29975be6cf4SArnaldo Carvalho de Melo 30075be6cf4SArnaldo Carvalho de Melo if (symbol__init() < 0) 301b32d133aSArnaldo Carvalho de Melo return -1; 30286470930SIngo Molnar 303c8829c7aSArnaldo Carvalho de Melo setup_sorting(annotate_usage, options); 30486470930SIngo Molnar 30586470930SIngo Molnar if (argc) { 30686470930SIngo Molnar /* 30786470930SIngo Molnar * Special case: if there's an argument left then assume tha 30886470930SIngo Molnar * it's a symbol filter: 30986470930SIngo Molnar */ 31086470930SIngo Molnar if (argc > 1) 31186470930SIngo Molnar usage_with_options(annotate_usage, options); 31286470930SIngo Molnar 3137009cc34SArnaldo Carvalho de Melo annotate.sym_hist_filter = argv[0]; 31486470930SIngo Molnar } 31586470930SIngo Molnar 316d20deb64SArnaldo Carvalho de Melo return __cmd_annotate(&annotate); 31786470930SIngo Molnar } 318