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" 3168e94f4eSIrina Tirdea #include "arch/common.h" 3286470930SIngo Molnar 335d67be97SAnton Blanchard #include <linux/bitmap.h> 345d67be97SAnton Blanchard 35d20deb64SArnaldo Carvalho de Melo struct perf_annotate { 3645694aa7SArnaldo Carvalho de Melo struct perf_tool tool; 377009cc34SArnaldo Carvalho de Melo char const *input_name; 387009cc34SArnaldo Carvalho de Melo bool force, use_tui, use_stdio; 397009cc34SArnaldo Carvalho de Melo bool full_paths; 407009cc34SArnaldo Carvalho de Melo bool print_line; 417009cc34SArnaldo Carvalho de Melo const char *sym_hist_filter; 427009cc34SArnaldo Carvalho de Melo const char *cpu_list; 437009cc34SArnaldo Carvalho de Melo DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS); 44d20deb64SArnaldo Carvalho de Melo }; 455d67be97SAnton Blanchard 46d04b35f8SArnaldo Carvalho de Melo static int perf_evsel__add_sample(struct perf_evsel *evsel, 47e248de33SArnaldo Carvalho de Melo struct perf_sample *sample, 48d20deb64SArnaldo Carvalho de Melo struct addr_location *al, 49d20deb64SArnaldo Carvalho de Melo struct perf_annotate *ann) 5086470930SIngo Molnar { 51628ada0cSArnaldo Carvalho de Melo struct hist_entry *he; 52e248de33SArnaldo Carvalho de Melo int ret; 53628ada0cSArnaldo Carvalho de Melo 547009cc34SArnaldo Carvalho de Melo if (ann->sym_hist_filter != NULL && 557009cc34SArnaldo Carvalho de Melo (al->sym == NULL || 567009cc34SArnaldo Carvalho de Melo strcmp(ann->sym_hist_filter, al->sym->name) != 0)) { 57628ada0cSArnaldo Carvalho de Melo /* We're only interested in a symbol named sym_hist_filter */ 58628ada0cSArnaldo Carvalho de Melo if (al->sym != NULL) { 59628ada0cSArnaldo Carvalho de Melo rb_erase(&al->sym->rb_node, 60628ada0cSArnaldo Carvalho de Melo &al->map->dso->symbols[al->map->type]); 61628ada0cSArnaldo Carvalho de Melo symbol__delete(al->sym); 62628ada0cSArnaldo Carvalho de Melo } 63628ada0cSArnaldo Carvalho de Melo return 0; 64628ada0cSArnaldo Carvalho de Melo } 65628ada0cSArnaldo Carvalho de Melo 66e248de33SArnaldo Carvalho de Melo he = __hists__add_entry(&evsel->hists, al, NULL, 1); 679735abf1SArnaldo Carvalho de Melo if (he == NULL) 6886470930SIngo Molnar return -ENOMEM; 69628ada0cSArnaldo Carvalho de Melo 70e248de33SArnaldo Carvalho de Melo ret = 0; 712f525d01SArnaldo Carvalho de Melo if (he->ms.sym != NULL) { 722f525d01SArnaldo Carvalho de Melo struct annotation *notes = symbol__annotation(he->ms.sym); 73d04b35f8SArnaldo Carvalho de Melo if (notes->src == NULL && symbol__alloc_hist(he->ms.sym) < 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 8445694aa7SArnaldo Carvalho de Melo static int process_sample_event(struct perf_tool *tool, 85d20deb64SArnaldo Carvalho de Melo union perf_event *event, 868115d60cSArnaldo Carvalho de Melo struct perf_sample *sample, 879e69c210SArnaldo Carvalho de Melo struct perf_evsel *evsel, 88743eb868SArnaldo Carvalho de Melo struct machine *machine) 8986470930SIngo Molnar { 9045694aa7SArnaldo Carvalho de Melo struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool); 911ed091c4SArnaldo Carvalho de Melo struct addr_location al; 926baa0a5aSFrederic Weisbecker 93743eb868SArnaldo Carvalho de Melo if (perf_event__preprocess_sample(event, machine, &al, sample, 94ce6f4fabSArnaldo Carvalho de Melo symbol__annotate_init) < 0) { 9529a9f66dSArnaldo Carvalho de Melo pr_warning("problem processing %d event, skipping it.\n", 9686470930SIngo Molnar event->header.type); 9786470930SIngo Molnar return -1; 9886470930SIngo Molnar } 9986470930SIngo Molnar 1007009cc34SArnaldo Carvalho de Melo if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap)) 1015d67be97SAnton Blanchard return 0; 1025d67be97SAnton Blanchard 103d20deb64SArnaldo Carvalho de Melo if (!al.filtered && perf_evsel__add_sample(evsel, sample, &al, ann)) { 10429a9f66dSArnaldo Carvalho de Melo pr_warning("problem incrementing symbol count, " 105ec218fc4SArnaldo Carvalho de Melo "skipping event\n"); 10686470930SIngo Molnar return -1; 10786470930SIngo Molnar } 10886470930SIngo Molnar 10986470930SIngo Molnar return 0; 11086470930SIngo Molnar } 11186470930SIngo Molnar 112d20deb64SArnaldo Carvalho de Melo static int hist_entry__tty_annotate(struct hist_entry *he, int evidx, 113d20deb64SArnaldo Carvalho de Melo struct perf_annotate *ann) 11486470930SIngo Molnar { 1152f525d01SArnaldo Carvalho de Melo return symbol__tty_annotate(he->ms.sym, he->ms.map, evidx, 1167009cc34SArnaldo Carvalho de Melo ann->print_line, ann->full_paths, 0, 0); 11786470930SIngo Molnar } 11886470930SIngo Molnar 119d20deb64SArnaldo Carvalho de Melo static void hists__find_annotations(struct hists *self, int evidx, 120d20deb64SArnaldo Carvalho de Melo struct perf_annotate *ann) 12186470930SIngo Molnar { 122b50e003dSArnaldo Carvalho de Melo struct rb_node *nd = rb_first(&self->entries), *next; 123cf958003SArnaldo Carvalho de Melo int key = K_RIGHT; 12486470930SIngo Molnar 12546e3e055SArnaldo Carvalho de Melo while (nd) { 126ed52ce2eSArnaldo Carvalho de Melo struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node); 12778f7defeSArnaldo Carvalho de Melo struct annotation *notes; 12886470930SIngo Molnar 12946e3e055SArnaldo Carvalho de Melo if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned) 13046e3e055SArnaldo Carvalho de Melo goto find_next; 131e4204992SArnaldo Carvalho de Melo 13278f7defeSArnaldo Carvalho de Melo notes = symbol__annotation(he->ms.sym); 133ce6f4fabSArnaldo Carvalho de Melo if (notes->src == NULL) { 13446e3e055SArnaldo Carvalho de Melo find_next: 135cf958003SArnaldo Carvalho de Melo if (key == K_LEFT) 13646e3e055SArnaldo Carvalho de Melo nd = rb_prev(nd); 13746e3e055SArnaldo Carvalho de Melo else 13846e3e055SArnaldo Carvalho de Melo nd = rb_next(nd); 139e4204992SArnaldo Carvalho de Melo continue; 14046e3e055SArnaldo Carvalho de Melo } 141e4204992SArnaldo Carvalho de Melo 14262e3436bSArnaldo Carvalho de Melo if (use_browser > 0) { 143d04b35f8SArnaldo Carvalho de Melo key = hist_entry__tui_annotate(he, evidx, NULL, NULL, 0); 14446e3e055SArnaldo Carvalho de Melo switch (key) { 145cf958003SArnaldo Carvalho de Melo case K_RIGHT: 146b50e003dSArnaldo Carvalho de Melo next = rb_next(nd); 14746e3e055SArnaldo Carvalho de Melo break; 148cf958003SArnaldo Carvalho de Melo case K_LEFT: 149b50e003dSArnaldo Carvalho de Melo next = rb_prev(nd); 15046e3e055SArnaldo Carvalho de Melo break; 151b50e003dSArnaldo Carvalho de Melo default: 152b50e003dSArnaldo Carvalho de Melo return; 15346e3e055SArnaldo Carvalho de Melo } 154b50e003dSArnaldo Carvalho de Melo 155b50e003dSArnaldo Carvalho de Melo if (next != NULL) 156b50e003dSArnaldo Carvalho de Melo nd = next; 15746e3e055SArnaldo Carvalho de Melo } else { 158d20deb64SArnaldo Carvalho de Melo hist_entry__tty_annotate(he, evidx, ann); 15946e3e055SArnaldo Carvalho de Melo nd = rb_next(nd); 160ed52ce2eSArnaldo Carvalho de Melo /* 16146e3e055SArnaldo Carvalho de Melo * Since we have a hist_entry per IP for the same 162ce6f4fabSArnaldo Carvalho de Melo * symbol, free he->ms.sym->src to signal we already 16346e3e055SArnaldo Carvalho de Melo * processed this symbol. 164ed52ce2eSArnaldo Carvalho de Melo */ 165ce6f4fabSArnaldo Carvalho de Melo free(notes->src); 166ce6f4fabSArnaldo Carvalho de Melo notes->src = NULL; 16786470930SIngo Molnar } 16886470930SIngo Molnar } 16946e3e055SArnaldo Carvalho de Melo } 17086470930SIngo Molnar 171d20deb64SArnaldo Carvalho de Melo static int __cmd_annotate(struct perf_annotate *ann) 17286470930SIngo Molnar { 173bab81b62SLi Zefan int ret; 17475be6cf4SArnaldo Carvalho de Melo struct perf_session *session; 175e248de33SArnaldo Carvalho de Melo struct perf_evsel *pos; 176e248de33SArnaldo Carvalho de Melo u64 total_nr_samples; 17786470930SIngo Molnar 1787009cc34SArnaldo Carvalho de Melo session = perf_session__new(ann->input_name, O_RDONLY, 17945694aa7SArnaldo Carvalho de Melo ann->force, false, &ann->tool); 18094c744b6SArnaldo Carvalho de Melo if (session == NULL) 18194c744b6SArnaldo Carvalho de Melo return -ENOMEM; 18294c744b6SArnaldo Carvalho de Melo 1837009cc34SArnaldo Carvalho de Melo if (ann->cpu_list) { 1847009cc34SArnaldo Carvalho de Melo ret = perf_session__cpu_bitmap(session, ann->cpu_list, 1857009cc34SArnaldo Carvalho de Melo ann->cpu_bitmap); 1865d67be97SAnton Blanchard if (ret) 1875d67be97SAnton Blanchard goto out_delete; 1885d67be97SAnton Blanchard } 1895d67be97SAnton Blanchard 19068e94f4eSIrina Tirdea if (!objdump_path) { 19168e94f4eSIrina Tirdea ret = perf_session_env__lookup_objdump(&session->header.env); 19268e94f4eSIrina Tirdea if (ret) 19368e94f4eSIrina Tirdea goto out_delete; 19468e94f4eSIrina Tirdea } 19568e94f4eSIrina Tirdea 19645694aa7SArnaldo Carvalho de Melo ret = perf_session__process_events(session, &ann->tool); 197bab81b62SLi Zefan if (ret) 19894c744b6SArnaldo Carvalho de Melo goto out_delete; 19986470930SIngo Molnar 20062daacb5SArnaldo Carvalho de Melo if (dump_trace) { 201c8446b9bSArnaldo Carvalho de Melo perf_session__fprintf_nr_events(session, stdout); 20294c744b6SArnaldo Carvalho de Melo goto out_delete; 20362daacb5SArnaldo Carvalho de Melo } 20486470930SIngo Molnar 205da21d1b5SArnaldo Carvalho de Melo if (verbose > 3) 206b3165f41SArnaldo Carvalho de Melo perf_session__fprintf(session, stdout); 20786470930SIngo Molnar 208da21d1b5SArnaldo Carvalho de Melo if (verbose > 2) 209cbf69680SArnaldo Carvalho de Melo perf_session__fprintf_dsos(session, stdout); 21086470930SIngo Molnar 211e248de33SArnaldo Carvalho de Melo total_nr_samples = 0; 212e248de33SArnaldo Carvalho de Melo list_for_each_entry(pos, &session->evlist->entries, node) { 213e248de33SArnaldo Carvalho de Melo struct hists *hists = &pos->hists; 214e248de33SArnaldo Carvalho de Melo u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE]; 21586470930SIngo Molnar 216e248de33SArnaldo Carvalho de Melo if (nr_samples > 0) { 217e248de33SArnaldo Carvalho de Melo total_nr_samples += nr_samples; 218e248de33SArnaldo Carvalho de Melo hists__collapse_resort(hists); 219e248de33SArnaldo Carvalho de Melo hists__output_resort(hists); 220d20deb64SArnaldo Carvalho de Melo hists__find_annotations(hists, pos->idx, ann); 221e248de33SArnaldo Carvalho de Melo } 222e248de33SArnaldo Carvalho de Melo } 223e248de33SArnaldo Carvalho de Melo 224e248de33SArnaldo Carvalho de Melo if (total_nr_samples == 0) { 2253780f488SNamhyung Kim ui__error("The %s file has no samples!\n", session->filename); 226e248de33SArnaldo Carvalho de Melo goto out_delete; 227e248de33SArnaldo Carvalho de Melo } 228e248de33SArnaldo Carvalho de Melo out_delete: 229e248de33SArnaldo Carvalho de Melo /* 230e248de33SArnaldo Carvalho de Melo * Speed up the exit process, for large files this can 231e248de33SArnaldo Carvalho de Melo * take quite a while. 232e248de33SArnaldo Carvalho de Melo * 233e248de33SArnaldo Carvalho de Melo * XXX Enable this when using valgrind or if we ever 234e248de33SArnaldo Carvalho de Melo * librarize this command. 235e248de33SArnaldo Carvalho de Melo * 236e248de33SArnaldo Carvalho de Melo * Also experiment with obstacks to see how much speed 237e248de33SArnaldo Carvalho de Melo * up we'll get here. 238e248de33SArnaldo Carvalho de Melo * 239e248de33SArnaldo Carvalho de Melo * perf_session__delete(session); 240e248de33SArnaldo Carvalho de Melo */ 241bab81b62SLi Zefan return ret; 24286470930SIngo Molnar } 24386470930SIngo Molnar 24486470930SIngo Molnar static const char * const annotate_usage[] = { 24599345254SNamhyung Kim "perf annotate [<options>]", 24686470930SIngo Molnar NULL 24786470930SIngo Molnar }; 24886470930SIngo Molnar 2491d037ca1SIrina Tirdea int cmd_annotate(int argc, const char **argv, const char *prefix __maybe_unused) 250d20deb64SArnaldo Carvalho de Melo { 251d20deb64SArnaldo Carvalho de Melo struct perf_annotate annotate = { 25245694aa7SArnaldo Carvalho de Melo .tool = { 253d20deb64SArnaldo Carvalho de Melo .sample = process_sample_event, 254d20deb64SArnaldo Carvalho de Melo .mmap = perf_event__process_mmap, 255d20deb64SArnaldo Carvalho de Melo .comm = perf_event__process_comm, 256ec4622f5SArnaldo Carvalho de Melo .exit = perf_event__process_exit, 257f62d3f0fSArnaldo Carvalho de Melo .fork = perf_event__process_fork, 258d20deb64SArnaldo Carvalho de Melo .ordered_samples = true, 259d20deb64SArnaldo Carvalho de Melo .ordering_requires_timestamps = true, 260d20deb64SArnaldo Carvalho de Melo }, 261d20deb64SArnaldo Carvalho de Melo }; 262d20deb64SArnaldo Carvalho de Melo const struct option options[] = { 2637009cc34SArnaldo Carvalho de Melo OPT_STRING('i', "input", &annotate.input_name, "file", 26486470930SIngo Molnar "input file name"), 265ac73c5a9SArnaldo Carvalho de Melo OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]", 266ac73c5a9SArnaldo Carvalho de Melo "only consider symbols in these dsos"), 2677009cc34SArnaldo Carvalho de Melo OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol", 26886470930SIngo Molnar "symbol to annotate"), 2697009cc34SArnaldo Carvalho de Melo OPT_BOOLEAN('f', "force", &annotate.force, "don't complain, do it"), 270c0555642SIan Munsie OPT_INCR('v', "verbose", &verbose, 27186470930SIngo Molnar "be more verbose (show symbol address, etc)"), 27286470930SIngo Molnar OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, 27386470930SIngo Molnar "dump raw trace in ASCII"), 2747009cc34SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"), 2757009cc34SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"), 276b32d133aSArnaldo Carvalho de Melo OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, 277b32d133aSArnaldo Carvalho de Melo "file", "vmlinux pathname"), 278b32d133aSArnaldo Carvalho de Melo OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules, 27942976487SMike Galbraith "load module symbols - WARNING: use only with -k and LIVE kernel"), 2807009cc34SArnaldo Carvalho de Melo OPT_BOOLEAN('l', "print-line", &annotate.print_line, 281301406b9SFrederic Weisbecker "print matching source lines (may be slow)"), 2827009cc34SArnaldo Carvalho de Melo OPT_BOOLEAN('P', "full-paths", &annotate.full_paths, 28342976487SMike Galbraith "Don't shorten the displayed pathnames"), 284c8e66720SDavid Ahern OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"), 285e71a0598SStephane Eranian OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory", 286e71a0598SStephane Eranian "Look for files with symbols relative to this directory"), 28764c6f0c7SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src, 2883e6a2a7fSStephane Eranian "Interleave source code with assembly code (default)"), 28964c6f0c7SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw, 2903e6a2a7fSStephane Eranian "Display raw encoding of assembly instructions (default)"), 291f69b64f7SAndi Kleen OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style", 292f69b64f7SAndi Kleen "Specify disassembler style (e.g. -M intel for intel syntax)"), 2937a4ec938SMaciek Borzecki OPT_STRING(0, "objdump", &objdump_path, "path", 2947a4ec938SMaciek Borzecki "objdump binary to use for disassembly and annotations"), 29586470930SIngo Molnar OPT_END() 29686470930SIngo Molnar }; 29786470930SIngo Molnar 298655000e7SArnaldo Carvalho de Melo argc = parse_options(argc, argv, options, annotate_usage, 0); 299655000e7SArnaldo Carvalho de Melo 3007009cc34SArnaldo Carvalho de Melo if (annotate.use_stdio) 3018b9e74ebSArnaldo Carvalho de Melo use_browser = 0; 3027009cc34SArnaldo Carvalho de Melo else if (annotate.use_tui) 3038b9e74ebSArnaldo Carvalho de Melo use_browser = 1; 3048b9e74ebSArnaldo Carvalho de Melo 305229ade9bSArnaldo Carvalho de Melo setup_browser(true); 30646e3e055SArnaldo Carvalho de Melo 30778f7defeSArnaldo Carvalho de Melo symbol_conf.priv_size = sizeof(struct annotation); 30875be6cf4SArnaldo Carvalho de Melo symbol_conf.try_vmlinux_path = true; 30975be6cf4SArnaldo Carvalho de Melo 31075be6cf4SArnaldo Carvalho de Melo if (symbol__init() < 0) 311b32d133aSArnaldo Carvalho de Melo return -1; 31286470930SIngo Molnar 313c8829c7aSArnaldo Carvalho de Melo setup_sorting(annotate_usage, options); 31486470930SIngo Molnar 31586470930SIngo Molnar if (argc) { 31686470930SIngo Molnar /* 31786470930SIngo Molnar * Special case: if there's an argument left then assume tha 31886470930SIngo Molnar * it's a symbol filter: 31986470930SIngo Molnar */ 32086470930SIngo Molnar if (argc > 1) 32186470930SIngo Molnar usage_with_options(annotate_usage, options); 32286470930SIngo Molnar 3237009cc34SArnaldo Carvalho de Melo annotate.sym_hist_filter = argv[0]; 32486470930SIngo Molnar } 32586470930SIngo Molnar 326d20deb64SArnaldo Carvalho de Melo return __cmd_annotate(&annotate); 32786470930SIngo Molnar } 328