1b2441318SGreg Kroah-Hartman // SPDX-License-Identifier: GPL-2.0 286470930SIngo Molnar /* 386470930SIngo Molnar * builtin-annotate.c 486470930SIngo Molnar * 586470930SIngo Molnar * Builtin annotate command: Analyze the perf.data input file, 686470930SIngo Molnar * look up and read DSOs and symbol information and display 786470930SIngo Molnar * a histogram of results, along various sorting keys. 886470930SIngo Molnar */ 986470930SIngo Molnar #include "builtin.h" 1086470930SIngo Molnar 1186470930SIngo Molnar #include "util/util.h" 1286470930SIngo Molnar #include "util/color.h" 135da50258SArnaldo Carvalho de Melo #include <linux/list.h> 1486470930SIngo Molnar #include "util/cache.h" 1543cbcd8aSArnaldo Carvalho de Melo #include <linux/rbtree.h> 1686470930SIngo Molnar #include "util/symbol.h" 1786470930SIngo Molnar 1886470930SIngo Molnar #include "perf.h" 198f28827aSFrederic Weisbecker #include "util/debug.h" 2086470930SIngo Molnar 21e248de33SArnaldo Carvalho de Melo #include "util/evlist.h" 22e248de33SArnaldo Carvalho de Melo #include "util/evsel.h" 2378f7defeSArnaldo Carvalho de Melo #include "util/annotate.h" 2462daacb5SArnaldo Carvalho de Melo #include "util/event.h" 254b6ab94eSJosh Poimboeuf #include <subcmd/parse-options.h> 2686470930SIngo Molnar #include "util/parse-events.h" 276baa0a5aSFrederic Weisbecker #include "util/thread.h" 28dd68ada2SJohn Kacur #include "util/sort.h" 293d1d07ecSJohn Kacur #include "util/hist.h" 3094c744b6SArnaldo Carvalho de Melo #include "util/session.h" 3145694aa7SArnaldo Carvalho de Melo #include "util/tool.h" 32f5fc1412SJiri Olsa #include "util/data.h" 3368e94f4eSIrina Tirdea #include "arch/common.h" 3470fbe057SPeter Zijlstra #include "util/block-range.h" 3586470930SIngo Molnar 36fc67297bSNamhyung Kim #include <dlfcn.h> 37a43783aeSArnaldo Carvalho de Melo #include <errno.h> 385d67be97SAnton Blanchard #include <linux/bitmap.h> 395d67be97SAnton Blanchard 40d20deb64SArnaldo Carvalho de Melo struct perf_annotate { 4145694aa7SArnaldo Carvalho de Melo struct perf_tool tool; 42fa10f316SNamhyung Kim struct perf_session *session; 43982d410bSArnaldo Carvalho de Melo struct annotation_options opts; 44befd2a38SArnaldo Carvalho de Melo bool use_tui, use_stdio, use_stdio2, use_gtk; 4518c9e5c5SNamhyung Kim bool skip_missing; 46bb848c14SJin Yao bool has_br_stack; 477ebaf489SJin Yao bool group_set; 487009cc34SArnaldo Carvalho de Melo const char *sym_hist_filter; 497009cc34SArnaldo Carvalho de Melo const char *cpu_list; 507009cc34SArnaldo Carvalho de Melo DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS); 51d20deb64SArnaldo Carvalho de Melo }; 525d67be97SAnton Blanchard 5370fbe057SPeter Zijlstra /* 5470fbe057SPeter Zijlstra * Given one basic block: 5570fbe057SPeter Zijlstra * 5670fbe057SPeter Zijlstra * from to branch_i 5770fbe057SPeter Zijlstra * * ----> * 5870fbe057SPeter Zijlstra * | 5970fbe057SPeter Zijlstra * | block 6070fbe057SPeter Zijlstra * v 6170fbe057SPeter Zijlstra * * ----> * 6270fbe057SPeter Zijlstra * from to branch_i+1 6370fbe057SPeter Zijlstra * 6470fbe057SPeter Zijlstra * where the horizontal are the branches and the vertical is the executed 6570fbe057SPeter Zijlstra * block of instructions. 6670fbe057SPeter Zijlstra * 6770fbe057SPeter Zijlstra * We count, for each 'instruction', the number of blocks that covered it as 6870fbe057SPeter Zijlstra * well as count the ratio each branch is taken. 6970fbe057SPeter Zijlstra * 7070fbe057SPeter Zijlstra * We can do this without knowing the actual instruction stream by keeping 7170fbe057SPeter Zijlstra * track of the address ranges. We break down ranges such that there is no 7270fbe057SPeter Zijlstra * overlap and iterate from the start until the end. 7370fbe057SPeter Zijlstra * 7470fbe057SPeter Zijlstra * @acme: once we parse the objdump output _before_ processing the samples, 7570fbe057SPeter Zijlstra * we can easily fold the branch.cycles IPC bits in. 7670fbe057SPeter Zijlstra */ 7770fbe057SPeter Zijlstra static void process_basic_block(struct addr_map_symbol *start, 7870fbe057SPeter Zijlstra struct addr_map_symbol *end, 7970fbe057SPeter Zijlstra struct branch_flags *flags) 8070fbe057SPeter Zijlstra { 8170fbe057SPeter Zijlstra struct symbol *sym = start->sym; 8270fbe057SPeter Zijlstra struct annotation *notes = sym ? symbol__annotation(sym) : NULL; 8370fbe057SPeter Zijlstra struct block_range_iter iter; 8470fbe057SPeter Zijlstra struct block_range *entry; 8570fbe057SPeter Zijlstra 8670fbe057SPeter Zijlstra /* 8770fbe057SPeter Zijlstra * Sanity; NULL isn't executable and the CPU cannot execute backwards 8870fbe057SPeter Zijlstra */ 8970fbe057SPeter Zijlstra if (!start->addr || start->addr > end->addr) 9070fbe057SPeter Zijlstra return; 9170fbe057SPeter Zijlstra 9270fbe057SPeter Zijlstra iter = block_range__create(start->addr, end->addr); 9370fbe057SPeter Zijlstra if (!block_range_iter__valid(&iter)) 9470fbe057SPeter Zijlstra return; 9570fbe057SPeter Zijlstra 9670fbe057SPeter Zijlstra /* 9770fbe057SPeter Zijlstra * First block in range is a branch target. 9870fbe057SPeter Zijlstra */ 9970fbe057SPeter Zijlstra entry = block_range_iter(&iter); 10070fbe057SPeter Zijlstra assert(entry->is_target); 10170fbe057SPeter Zijlstra entry->entry++; 10270fbe057SPeter Zijlstra 10370fbe057SPeter Zijlstra do { 10470fbe057SPeter Zijlstra entry = block_range_iter(&iter); 10570fbe057SPeter Zijlstra 10670fbe057SPeter Zijlstra entry->coverage++; 10770fbe057SPeter Zijlstra entry->sym = sym; 10870fbe057SPeter Zijlstra 10970fbe057SPeter Zijlstra if (notes) 11070fbe057SPeter Zijlstra notes->max_coverage = max(notes->max_coverage, entry->coverage); 11170fbe057SPeter Zijlstra 11270fbe057SPeter Zijlstra } while (block_range_iter__next(&iter)); 11370fbe057SPeter Zijlstra 11470fbe057SPeter Zijlstra /* 11570fbe057SPeter Zijlstra * Last block in rage is a branch. 11670fbe057SPeter Zijlstra */ 11770fbe057SPeter Zijlstra entry = block_range_iter(&iter); 11870fbe057SPeter Zijlstra assert(entry->is_branch); 11970fbe057SPeter Zijlstra entry->taken++; 12070fbe057SPeter Zijlstra if (flags->predicted) 12170fbe057SPeter Zijlstra entry->pred++; 12270fbe057SPeter Zijlstra } 12370fbe057SPeter Zijlstra 12470fbe057SPeter Zijlstra static void process_branch_stack(struct branch_stack *bs, struct addr_location *al, 12570fbe057SPeter Zijlstra struct perf_sample *sample) 12670fbe057SPeter Zijlstra { 12770fbe057SPeter Zijlstra struct addr_map_symbol *prev = NULL; 12870fbe057SPeter Zijlstra struct branch_info *bi; 12970fbe057SPeter Zijlstra int i; 13070fbe057SPeter Zijlstra 13170fbe057SPeter Zijlstra if (!bs || !bs->nr) 13270fbe057SPeter Zijlstra return; 13370fbe057SPeter Zijlstra 13470fbe057SPeter Zijlstra bi = sample__resolve_bstack(sample, al); 13570fbe057SPeter Zijlstra if (!bi) 13670fbe057SPeter Zijlstra return; 13770fbe057SPeter Zijlstra 13870fbe057SPeter Zijlstra for (i = bs->nr - 1; i >= 0; i--) { 13970fbe057SPeter Zijlstra /* 14070fbe057SPeter Zijlstra * XXX filter against symbol 14170fbe057SPeter Zijlstra */ 14270fbe057SPeter Zijlstra if (prev) 14370fbe057SPeter Zijlstra process_basic_block(prev, &bi[i].from, &bi[i].flags); 14470fbe057SPeter Zijlstra prev = &bi[i].to; 14570fbe057SPeter Zijlstra } 14670fbe057SPeter Zijlstra 14770fbe057SPeter Zijlstra free(bi); 14870fbe057SPeter Zijlstra } 14970fbe057SPeter Zijlstra 150bb848c14SJin Yao static int hist_iter__branch_callback(struct hist_entry_iter *iter, 151bb848c14SJin Yao struct addr_location *al __maybe_unused, 152bb848c14SJin Yao bool single __maybe_unused, 153bb848c14SJin Yao void *arg __maybe_unused) 154bb848c14SJin Yao { 155bb848c14SJin Yao struct hist_entry *he = iter->he; 156bb848c14SJin Yao struct branch_info *bi; 157bb848c14SJin Yao struct perf_sample *sample = iter->sample; 158bb848c14SJin Yao struct perf_evsel *evsel = iter->evsel; 159bb848c14SJin Yao int err; 160bb848c14SJin Yao 161bb848c14SJin Yao hist__account_cycles(sample->branch_stack, al, sample, false); 162bb848c14SJin Yao 163bb848c14SJin Yao bi = he->branch_info; 164e345f3bdSArnaldo Carvalho de Melo err = addr_map_symbol__inc_samples(&bi->from, sample, evsel); 165bb848c14SJin Yao 166bb848c14SJin Yao if (err) 167bb848c14SJin Yao goto out; 168bb848c14SJin Yao 169e345f3bdSArnaldo Carvalho de Melo err = addr_map_symbol__inc_samples(&bi->to, sample, evsel); 170bb848c14SJin Yao 171bb848c14SJin Yao out: 172bb848c14SJin Yao return err; 173bb848c14SJin Yao } 174bb848c14SJin Yao 175bb848c14SJin Yao static int process_branch_callback(struct perf_evsel *evsel, 176bb848c14SJin Yao struct perf_sample *sample, 177bb848c14SJin Yao struct addr_location *al __maybe_unused, 178bb848c14SJin Yao struct perf_annotate *ann, 179bb848c14SJin Yao struct machine *machine) 180bb848c14SJin Yao { 181bb848c14SJin Yao struct hist_entry_iter iter = { 182bb848c14SJin Yao .evsel = evsel, 183bb848c14SJin Yao .sample = sample, 184bb848c14SJin Yao .add_entry_cb = hist_iter__branch_callback, 185bb848c14SJin Yao .hide_unresolved = symbol_conf.hide_unresolved, 186bb848c14SJin Yao .ops = &hist_iter_branch, 187bb848c14SJin Yao }; 188bb848c14SJin Yao 189bb848c14SJin Yao struct addr_location a; 190bb848c14SJin Yao int ret; 191bb848c14SJin Yao 192bb848c14SJin Yao if (machine__resolve(machine, &a, sample) < 0) 193bb848c14SJin Yao return -1; 194bb848c14SJin Yao 195bb848c14SJin Yao if (a.sym == NULL) 196bb848c14SJin Yao return 0; 197bb848c14SJin Yao 198bb848c14SJin Yao if (a.map != NULL) 199bb848c14SJin Yao a.map->dso->hit = 1; 200bb848c14SJin Yao 201bb848c14SJin Yao ret = hist_entry_iter__add(&iter, &a, PERF_MAX_STACK_DEPTH, ann); 202bb848c14SJin Yao return ret; 203bb848c14SJin Yao } 204bb848c14SJin Yao 205befd2a38SArnaldo Carvalho de Melo static bool has_annotation(struct perf_annotate *ann) 206befd2a38SArnaldo Carvalho de Melo { 207befd2a38SArnaldo Carvalho de Melo return ui__has_annotation() || ann->use_stdio2; 208befd2a38SArnaldo Carvalho de Melo } 209befd2a38SArnaldo Carvalho de Melo 210d04b35f8SArnaldo Carvalho de Melo static int perf_evsel__add_sample(struct perf_evsel *evsel, 211fd36f3ddSNamhyung Kim struct perf_sample *sample, 212d20deb64SArnaldo Carvalho de Melo struct addr_location *al, 213bb848c14SJin Yao struct perf_annotate *ann, 214bb848c14SJin Yao struct machine *machine) 21586470930SIngo Molnar { 2164ea062edSArnaldo Carvalho de Melo struct hists *hists = evsel__hists(evsel); 217628ada0cSArnaldo Carvalho de Melo struct hist_entry *he; 218e248de33SArnaldo Carvalho de Melo int ret; 219628ada0cSArnaldo Carvalho de Melo 220befd2a38SArnaldo Carvalho de Melo if ((!ann->has_br_stack || !has_annotation(ann)) && 221bb848c14SJin Yao ann->sym_hist_filter != NULL && 2227009cc34SArnaldo Carvalho de Melo (al->sym == NULL || 2237009cc34SArnaldo Carvalho de Melo strcmp(ann->sym_hist_filter, al->sym->name) != 0)) { 224628ada0cSArnaldo Carvalho de Melo /* We're only interested in a symbol named sym_hist_filter */ 225facf3f06SArnaldo Carvalho de Melo /* 226facf3f06SArnaldo Carvalho de Melo * FIXME: why isn't this done in the symbol_filter when loading 227facf3f06SArnaldo Carvalho de Melo * the DSO? 228facf3f06SArnaldo Carvalho de Melo */ 229628ada0cSArnaldo Carvalho de Melo if (al->sym != NULL) { 230628ada0cSArnaldo Carvalho de Melo rb_erase(&al->sym->rb_node, 2313183f8caSArnaldo Carvalho de Melo &al->map->dso->symbols); 232628ada0cSArnaldo Carvalho de Melo symbol__delete(al->sym); 233c0b4dffbSArnaldo Carvalho de Melo dso__reset_find_symbol_cache(al->map->dso); 234628ada0cSArnaldo Carvalho de Melo } 235628ada0cSArnaldo Carvalho de Melo return 0; 236628ada0cSArnaldo Carvalho de Melo } 237628ada0cSArnaldo Carvalho de Melo 23870fbe057SPeter Zijlstra /* 23970fbe057SPeter Zijlstra * XXX filtered samples can still have branch entires pointing into our 24070fbe057SPeter Zijlstra * symbol and are missed. 24170fbe057SPeter Zijlstra */ 24270fbe057SPeter Zijlstra process_branch_stack(sample->branch_stack, al, sample); 24370fbe057SPeter Zijlstra 244befd2a38SArnaldo Carvalho de Melo if (ann->has_br_stack && has_annotation(ann)) 245bb848c14SJin Yao return process_branch_callback(evsel, sample, al, ann, machine); 246bb848c14SJin Yao 2470102ef3eSJiri Olsa he = hists__add_entry(hists, al, NULL, NULL, NULL, sample, true); 2489735abf1SArnaldo Carvalho de Melo if (he == NULL) 24986470930SIngo Molnar return -ENOMEM; 250628ada0cSArnaldo Carvalho de Melo 251e345f3bdSArnaldo Carvalho de Melo ret = hist_entry__inc_addr_samples(he, sample, evsel, al->addr); 2524ea062edSArnaldo Carvalho de Melo hists__inc_nr_samples(hists, true); 253e248de33SArnaldo Carvalho de Melo return ret; 25486470930SIngo Molnar } 25586470930SIngo Molnar 25645694aa7SArnaldo Carvalho de Melo static int process_sample_event(struct perf_tool *tool, 257d20deb64SArnaldo Carvalho de Melo union perf_event *event, 2588115d60cSArnaldo Carvalho de Melo struct perf_sample *sample, 2599e69c210SArnaldo Carvalho de Melo struct perf_evsel *evsel, 260743eb868SArnaldo Carvalho de Melo struct machine *machine) 26186470930SIngo Molnar { 26245694aa7SArnaldo Carvalho de Melo struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool); 2631ed091c4SArnaldo Carvalho de Melo struct addr_location al; 264b91fc39fSArnaldo Carvalho de Melo int ret = 0; 2656baa0a5aSFrederic Weisbecker 266bb3eb566SArnaldo Carvalho de Melo if (machine__resolve(machine, &al, sample) < 0) { 26729a9f66dSArnaldo Carvalho de Melo pr_warning("problem processing %d event, skipping it.\n", 26886470930SIngo Molnar event->header.type); 26986470930SIngo Molnar return -1; 27086470930SIngo Molnar } 27186470930SIngo Molnar 2727009cc34SArnaldo Carvalho de Melo if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap)) 273b91fc39fSArnaldo Carvalho de Melo goto out_put; 2745d67be97SAnton Blanchard 275bb848c14SJin Yao if (!al.filtered && 276bb848c14SJin Yao perf_evsel__add_sample(evsel, sample, &al, ann, machine)) { 27729a9f66dSArnaldo Carvalho de Melo pr_warning("problem incrementing symbol count, " 278ec218fc4SArnaldo Carvalho de Melo "skipping event\n"); 279b91fc39fSArnaldo Carvalho de Melo ret = -1; 28086470930SIngo Molnar } 281b91fc39fSArnaldo Carvalho de Melo out_put: 282b91fc39fSArnaldo Carvalho de Melo addr_location__put(&al); 283b91fc39fSArnaldo Carvalho de Melo return ret; 28486470930SIngo Molnar } 28586470930SIngo Molnar 286db8fd07aSNamhyung Kim static int hist_entry__tty_annotate(struct hist_entry *he, 287db8fd07aSNamhyung Kim struct perf_evsel *evsel, 288d20deb64SArnaldo Carvalho de Melo struct perf_annotate *ann) 28986470930SIngo Molnar { 290befd2a38SArnaldo Carvalho de Melo if (!ann->use_stdio2) 291982d410bSArnaldo Carvalho de Melo return symbol__tty_annotate(he->ms.sym, he->ms.map, evsel, &ann->opts); 292982d410bSArnaldo Carvalho de Melo 293982d410bSArnaldo Carvalho de Melo return symbol__tty_annotate2(he->ms.sym, he->ms.map, evsel, &ann->opts); 29486470930SIngo Molnar } 29586470930SIngo Molnar 296c824c433SArnaldo Carvalho de Melo static void hists__find_annotations(struct hists *hists, 297db8fd07aSNamhyung Kim struct perf_evsel *evsel, 298d20deb64SArnaldo Carvalho de Melo struct perf_annotate *ann) 29986470930SIngo Molnar { 300c824c433SArnaldo Carvalho de Melo struct rb_node *nd = rb_first(&hists->entries), *next; 301cf958003SArnaldo Carvalho de Melo int key = K_RIGHT; 30286470930SIngo Molnar 30346e3e055SArnaldo Carvalho de Melo while (nd) { 304ed52ce2eSArnaldo Carvalho de Melo struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node); 30578f7defeSArnaldo Carvalho de Melo struct annotation *notes; 30686470930SIngo Molnar 30746e3e055SArnaldo Carvalho de Melo if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned) 30846e3e055SArnaldo Carvalho de Melo goto find_next; 309e4204992SArnaldo Carvalho de Melo 310bb848c14SJin Yao if (ann->sym_hist_filter && 311bb848c14SJin Yao (strcmp(he->ms.sym->name, ann->sym_hist_filter) != 0)) 312bb848c14SJin Yao goto find_next; 313bb848c14SJin Yao 31478f7defeSArnaldo Carvalho de Melo notes = symbol__annotation(he->ms.sym); 315ce6f4fabSArnaldo Carvalho de Melo if (notes->src == NULL) { 31646e3e055SArnaldo Carvalho de Melo find_next: 317cf958003SArnaldo Carvalho de Melo if (key == K_LEFT) 31846e3e055SArnaldo Carvalho de Melo nd = rb_prev(nd); 31946e3e055SArnaldo Carvalho de Melo else 32046e3e055SArnaldo Carvalho de Melo nd = rb_next(nd); 321e4204992SArnaldo Carvalho de Melo continue; 32246e3e055SArnaldo Carvalho de Melo } 323e4204992SArnaldo Carvalho de Melo 3242b676bf0SNamhyung Kim if (use_browser == 2) { 32518c9e5c5SNamhyung Kim int ret; 326fc67297bSNamhyung Kim int (*annotate)(struct hist_entry *he, 327fc67297bSNamhyung Kim struct perf_evsel *evsel, 328fc67297bSNamhyung Kim struct hist_browser_timer *hbt); 32918c9e5c5SNamhyung Kim 330fc67297bSNamhyung Kim annotate = dlsym(perf_gtk_handle, 331fc67297bSNamhyung Kim "hist_entry__gtk_annotate"); 332fc67297bSNamhyung Kim if (annotate == NULL) { 333fc67297bSNamhyung Kim ui__error("GTK browser not found!\n"); 334fc67297bSNamhyung Kim return; 335fc67297bSNamhyung Kim } 336fc67297bSNamhyung Kim 337fc67297bSNamhyung Kim ret = annotate(he, evsel, NULL); 33818c9e5c5SNamhyung Kim if (!ret || !ann->skip_missing) 3392b676bf0SNamhyung Kim return; 34018c9e5c5SNamhyung Kim 34118c9e5c5SNamhyung Kim /* skip missing symbols */ 34218c9e5c5SNamhyung Kim nd = rb_next(nd); 3432b676bf0SNamhyung Kim } else if (use_browser == 1) { 344db8fd07aSNamhyung Kim key = hist_entry__tui_annotate(he, evsel, NULL); 345bb848c14SJin Yao 34646e3e055SArnaldo Carvalho de Melo switch (key) { 34718c9e5c5SNamhyung Kim case -1: 34818c9e5c5SNamhyung Kim if (!ann->skip_missing) 34918c9e5c5SNamhyung Kim return; 35018c9e5c5SNamhyung Kim /* fall through */ 351cf958003SArnaldo Carvalho de Melo case K_RIGHT: 352b50e003dSArnaldo Carvalho de Melo next = rb_next(nd); 35346e3e055SArnaldo Carvalho de Melo break; 354cf958003SArnaldo Carvalho de Melo case K_LEFT: 355b50e003dSArnaldo Carvalho de Melo next = rb_prev(nd); 35646e3e055SArnaldo Carvalho de Melo break; 357b50e003dSArnaldo Carvalho de Melo default: 358b50e003dSArnaldo Carvalho de Melo return; 35946e3e055SArnaldo Carvalho de Melo } 360b50e003dSArnaldo Carvalho de Melo 361b50e003dSArnaldo Carvalho de Melo if (next != NULL) 362b50e003dSArnaldo Carvalho de Melo nd = next; 36346e3e055SArnaldo Carvalho de Melo } else { 364db8fd07aSNamhyung Kim hist_entry__tty_annotate(he, evsel, ann); 36546e3e055SArnaldo Carvalho de Melo nd = rb_next(nd); 366ed52ce2eSArnaldo Carvalho de Melo /* 36746e3e055SArnaldo Carvalho de Melo * Since we have a hist_entry per IP for the same 368ce6f4fabSArnaldo Carvalho de Melo * symbol, free he->ms.sym->src to signal we already 36946e3e055SArnaldo Carvalho de Melo * processed this symbol. 370ed52ce2eSArnaldo Carvalho de Melo */ 371d4957633SAndi Kleen zfree(¬es->src->cycles_hist); 37204662523SArnaldo Carvalho de Melo zfree(¬es->src); 37386470930SIngo Molnar } 37486470930SIngo Molnar } 37546e3e055SArnaldo Carvalho de Melo } 37686470930SIngo Molnar 377d20deb64SArnaldo Carvalho de Melo static int __cmd_annotate(struct perf_annotate *ann) 37886470930SIngo Molnar { 379bab81b62SLi Zefan int ret; 380fa10f316SNamhyung Kim struct perf_session *session = ann->session; 381e248de33SArnaldo Carvalho de Melo struct perf_evsel *pos; 382e248de33SArnaldo Carvalho de Melo u64 total_nr_samples; 38394c744b6SArnaldo Carvalho de Melo 3847009cc34SArnaldo Carvalho de Melo if (ann->cpu_list) { 3857009cc34SArnaldo Carvalho de Melo ret = perf_session__cpu_bitmap(session, ann->cpu_list, 3867009cc34SArnaldo Carvalho de Melo ann->cpu_bitmap); 3875d67be97SAnton Blanchard if (ret) 388fa10f316SNamhyung Kim goto out; 3895d67be97SAnton Blanchard } 3905d67be97SAnton Blanchard 39168e94f4eSIrina Tirdea if (!objdump_path) { 392eebd0bfcSArnaldo Carvalho de Melo ret = perf_env__lookup_objdump(&session->header.env); 39368e94f4eSIrina Tirdea if (ret) 394fa10f316SNamhyung Kim goto out; 39568e94f4eSIrina Tirdea } 39668e94f4eSIrina Tirdea 397b7b61cbeSArnaldo Carvalho de Melo ret = perf_session__process_events(session); 398bab81b62SLi Zefan if (ret) 399fa10f316SNamhyung Kim goto out; 40086470930SIngo Molnar 40162daacb5SArnaldo Carvalho de Melo if (dump_trace) { 402c8446b9bSArnaldo Carvalho de Melo perf_session__fprintf_nr_events(session, stdout); 4032a1731fbSArnaldo Carvalho de Melo perf_evlist__fprintf_nr_events(session->evlist, stdout); 404fa10f316SNamhyung Kim goto out; 40562daacb5SArnaldo Carvalho de Melo } 40686470930SIngo Molnar 407da21d1b5SArnaldo Carvalho de Melo if (verbose > 3) 408b3165f41SArnaldo Carvalho de Melo perf_session__fprintf(session, stdout); 40986470930SIngo Molnar 410da21d1b5SArnaldo Carvalho de Melo if (verbose > 2) 411cbf69680SArnaldo Carvalho de Melo perf_session__fprintf_dsos(session, stdout); 41286470930SIngo Molnar 413e248de33SArnaldo Carvalho de Melo total_nr_samples = 0; 414e5cadb93SArnaldo Carvalho de Melo evlist__for_each_entry(session->evlist, pos) { 4154ea062edSArnaldo Carvalho de Melo struct hists *hists = evsel__hists(pos); 416e248de33SArnaldo Carvalho de Melo u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE]; 41786470930SIngo Molnar 418e248de33SArnaldo Carvalho de Melo if (nr_samples > 0) { 419e248de33SArnaldo Carvalho de Melo total_nr_samples += nr_samples; 420c1fb5651SNamhyung Kim hists__collapse_resort(hists, NULL); 421f9db0d0fSKan Liang /* Don't sort callchain */ 422f9db0d0fSKan Liang perf_evsel__reset_sample_bit(pos, CALLCHAIN); 423452ce03bSJiri Olsa perf_evsel__output_resort(pos, NULL); 424b1dd4432SNamhyung Kim 425b1dd4432SNamhyung Kim if (symbol_conf.event_group && 426b1dd4432SNamhyung Kim !perf_evsel__is_group_leader(pos)) 427b1dd4432SNamhyung Kim continue; 428b1dd4432SNamhyung Kim 429db8fd07aSNamhyung Kim hists__find_annotations(hists, pos, ann); 430e248de33SArnaldo Carvalho de Melo } 431e248de33SArnaldo Carvalho de Melo } 432e248de33SArnaldo Carvalho de Melo 433e248de33SArnaldo Carvalho de Melo if (total_nr_samples == 0) { 434eae8ad80SJiri Olsa ui__error("The %s file has no samples!\n", session->data->file.path); 435fa10f316SNamhyung Kim goto out; 436e248de33SArnaldo Carvalho de Melo } 4377a60ba94SNamhyung Kim 438fc67297bSNamhyung Kim if (use_browser == 2) { 439fc67297bSNamhyung Kim void (*show_annotations)(void); 440fc67297bSNamhyung Kim 441fc67297bSNamhyung Kim show_annotations = dlsym(perf_gtk_handle, 442fc67297bSNamhyung Kim "perf_gtk__show_annotations"); 443fc67297bSNamhyung Kim if (show_annotations == NULL) { 444fc67297bSNamhyung Kim ui__error("GTK browser not found!\n"); 445fa10f316SNamhyung Kim goto out; 446fc67297bSNamhyung Kim } 447fc67297bSNamhyung Kim show_annotations(); 448fc67297bSNamhyung Kim } 4497a60ba94SNamhyung Kim 450fa10f316SNamhyung Kim out: 451bab81b62SLi Zefan return ret; 45286470930SIngo Molnar } 45386470930SIngo Molnar 45486470930SIngo Molnar static const char * const annotate_usage[] = { 45599345254SNamhyung Kim "perf annotate [<options>]", 45686470930SIngo Molnar NULL 45786470930SIngo Molnar }; 45886470930SIngo Molnar 459b0ad8ea6SArnaldo Carvalho de Melo int cmd_annotate(int argc, const char **argv) 460d20deb64SArnaldo Carvalho de Melo { 461d20deb64SArnaldo Carvalho de Melo struct perf_annotate annotate = { 46245694aa7SArnaldo Carvalho de Melo .tool = { 463d20deb64SArnaldo Carvalho de Melo .sample = process_sample_event, 464d20deb64SArnaldo Carvalho de Melo .mmap = perf_event__process_mmap, 4655c5e854bSStephane Eranian .mmap2 = perf_event__process_mmap2, 466d20deb64SArnaldo Carvalho de Melo .comm = perf_event__process_comm, 467ec4622f5SArnaldo Carvalho de Melo .exit = perf_event__process_exit, 468f62d3f0fSArnaldo Carvalho de Melo .fork = perf_event__process_fork, 469f3b3614aSHari Bathini .namespaces = perf_event__process_namespaces, 4706ab11f3aSDavid Carrillo-Cisneros .attr = perf_event__process_attr, 4716ab11f3aSDavid Carrillo-Cisneros .build_id = perf_event__process_build_id, 472f4849599SDavid Carrillo-Cisneros .tracing_data = perf_event__process_tracing_data, 473e9def1b2SDavid Carrillo-Cisneros .feature = perf_event__process_feature, 4740a8cb85cSJiri Olsa .ordered_events = true, 475d20deb64SArnaldo Carvalho de Melo .ordering_requires_timestamps = true, 476d20deb64SArnaldo Carvalho de Melo }, 477982d410bSArnaldo Carvalho de Melo .opts = annotation__default_options, 478d20deb64SArnaldo Carvalho de Melo }; 4798ceb41d7SJiri Olsa struct perf_data data = { 480fa10f316SNamhyung Kim .mode = PERF_DATA_MODE_READ, 481fa10f316SNamhyung Kim }; 4821ac39372STaeung Song struct option options[] = { 48370cb4e96SFeng Tang OPT_STRING('i', "input", &input_name, "file", 48486470930SIngo Molnar "input file name"), 485ac73c5a9SArnaldo Carvalho de Melo OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]", 486ac73c5a9SArnaldo Carvalho de Melo "only consider symbols in these dsos"), 4877009cc34SArnaldo Carvalho de Melo OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol", 48886470930SIngo Molnar "symbol to annotate"), 4898ceb41d7SJiri Olsa OPT_BOOLEAN('f', "force", &data.force, "don't complain, do it"), 490c0555642SIan Munsie OPT_INCR('v', "verbose", &verbose, 49186470930SIngo Molnar "be more verbose (show symbol address, etc)"), 492eddaef88SNamhyung Kim OPT_BOOLEAN('q', "quiet", &quiet, "do now show any message"), 49386470930SIngo Molnar OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, 49486470930SIngo Molnar "dump raw trace in ASCII"), 4952b676bf0SNamhyung Kim OPT_BOOLEAN(0, "gtk", &annotate.use_gtk, "Use the GTK interface"), 4967009cc34SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"), 4977009cc34SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"), 498befd2a38SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "stdio2", &annotate.use_stdio2, "Use the stdio interface"), 499be316409SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux, 500be316409SArnaldo Carvalho de Melo "don't load vmlinux even if found"), 501b32d133aSArnaldo Carvalho de Melo OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, 502b32d133aSArnaldo Carvalho de Melo "file", "vmlinux pathname"), 503b32d133aSArnaldo Carvalho de Melo OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules, 50442976487SMike Galbraith "load module symbols - WARNING: use only with -k and LIVE kernel"), 505982d410bSArnaldo Carvalho de Melo OPT_BOOLEAN('l', "print-line", &annotate.opts.print_lines, 506301406b9SFrederic Weisbecker "print matching source lines (may be slow)"), 507982d410bSArnaldo Carvalho de Melo OPT_BOOLEAN('P', "full-paths", &annotate.opts.full_path, 50842976487SMike Galbraith "Don't shorten the displayed pathnames"), 50918c9e5c5SNamhyung Kim OPT_BOOLEAN(0, "skip-missing", &annotate.skip_missing, 51018c9e5c5SNamhyung Kim "Skip symbols that cannot be annotated"), 5117ebaf489SJin Yao OPT_BOOLEAN_SET(0, "group", &symbol_conf.event_group, 5127ebaf489SJin Yao &annotate.group_set, 5137ebaf489SJin Yao "Show event group information together"), 514c8e66720SDavid Ahern OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"), 515a7066709SHe Kuang OPT_CALLBACK(0, "symfs", NULL, "directory", 516a7066709SHe Kuang "Look for files with symbols relative to this directory", 517a7066709SHe Kuang symbol__config_symfs), 5181eddd9e4SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "source", &annotate.opts.annotate_src, 5193e6a2a7fSStephane Eranian "Interleave source code with assembly code (default)"), 5201eddd9e4SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "asm-raw", &annotate.opts.show_asm_raw, 5213e6a2a7fSStephane Eranian "Display raw encoding of assembly instructions (default)"), 522a47e843eSArnaldo Carvalho de Melo OPT_STRING('M', "disassembler-style", &annotate.opts.disassembler_style, "disassembler style", 523f69b64f7SAndi Kleen "Specify disassembler style (e.g. -M intel for intel syntax)"), 5247a4ec938SMaciek Borzecki OPT_STRING(0, "objdump", &objdump_path, "path", 5257a4ec938SMaciek Borzecki "objdump binary to use for disassembly and annotations"), 526b1dd4432SNamhyung Kim OPT_BOOLEAN(0, "group", &symbol_conf.event_group, 527b1dd4432SNamhyung Kim "Show event group information together"), 5280c4a5bceSMartin Liška OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period, 5290c4a5bceSMartin Liška "Show a column with the sum of periods"), 5301ac39372STaeung Song OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples, 5311ac39372STaeung Song "Show a column with the number of samples"), 53253fe4ba1SArnaldo Carvalho de Melo OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL, "mode", 53353fe4ba1SArnaldo Carvalho de Melo "'always' (default), 'never' or 'auto' only applicable to --stdio mode", 53453fe4ba1SArnaldo Carvalho de Melo stdio__config_color, "always"), 53586470930SIngo Molnar OPT_END() 53686470930SIngo Molnar }; 5371ac39372STaeung Song int ret; 538a635fc51SArnaldo Carvalho de Melo 5391ac39372STaeung Song set_option_flag(options, 0, "show-total-period", PARSE_OPT_EXCLUSIVE); 5401ac39372STaeung Song set_option_flag(options, 0, "show-nr-samples", PARSE_OPT_EXCLUSIVE); 5411ac39372STaeung Song 5421ac39372STaeung Song 5431ac39372STaeung Song ret = hists__init(); 544a635fc51SArnaldo Carvalho de Melo if (ret < 0) 545a635fc51SArnaldo Carvalho de Melo return ret; 54686470930SIngo Molnar 547655000e7SArnaldo Carvalho de Melo argc = parse_options(argc, argv, options, annotate_usage, 0); 54850e19ef9SNamhyung Kim if (argc) { 54950e19ef9SNamhyung Kim /* 55050e19ef9SNamhyung Kim * Special case: if there's an argument left then assume that 55150e19ef9SNamhyung Kim * it's a symbol filter: 55250e19ef9SNamhyung Kim */ 55350e19ef9SNamhyung Kim if (argc > 1) 55450e19ef9SNamhyung Kim usage_with_options(annotate_usage, options); 55550e19ef9SNamhyung Kim 55650e19ef9SNamhyung Kim annotate.sym_hist_filter = argv[0]; 55750e19ef9SNamhyung Kim } 558655000e7SArnaldo Carvalho de Melo 5599cef4b0bSTaeung Song if (symbol_conf.show_nr_samples && annotate.use_gtk) { 5609cef4b0bSTaeung Song pr_err("--show-nr-samples is not available in --gtk mode at this time\n"); 5611ac39372STaeung Song return ret; 5621ac39372STaeung Song } 5631ac39372STaeung Song 564eddaef88SNamhyung Kim if (quiet) 565eddaef88SNamhyung Kim perf_quiet_option(); 566eddaef88SNamhyung Kim 567eae8ad80SJiri Olsa data.file.path = input_name; 56844848cdbSMartin Liška 5698ceb41d7SJiri Olsa annotate.session = perf_session__new(&data, false, &annotate.tool); 570fa10f316SNamhyung Kim if (annotate.session == NULL) 57152e02834STaeung Song return -1; 572fa10f316SNamhyung Kim 573bb848c14SJin Yao annotate.has_br_stack = perf_header__has_feat(&annotate.session->header, 574bb848c14SJin Yao HEADER_BRANCH_STACK); 575bb848c14SJin Yao 5767ebaf489SJin Yao if (annotate.group_set) 5777ebaf489SJin Yao perf_evlist__force_leader(annotate.session->evlist); 5787ebaf489SJin Yao 579b01141f4SArnaldo Carvalho de Melo ret = symbol__annotation_init(); 580b01141f4SArnaldo Carvalho de Melo if (ret < 0) 581b01141f4SArnaldo Carvalho de Melo goto out_delete; 582b01141f4SArnaldo Carvalho de Melo 5837f0b6fdeSArnaldo Carvalho de Melo annotation_config__init(); 5847f0b6fdeSArnaldo Carvalho de Melo 58575be6cf4SArnaldo Carvalho de Melo symbol_conf.try_vmlinux_path = true; 58675be6cf4SArnaldo Carvalho de Melo 5870a7e6d1bSNamhyung Kim ret = symbol__init(&annotate.session->header.env); 588fa10f316SNamhyung Kim if (ret < 0) 589fa10f316SNamhyung Kim goto out_delete; 59086470930SIngo Molnar 591befd2a38SArnaldo Carvalho de Melo if (annotate.use_stdio || annotate.use_stdio2) 5923df668e7SNamhyung Kim use_browser = 0; 5933df668e7SNamhyung Kim else if (annotate.use_tui) 5943df668e7SNamhyung Kim use_browser = 1; 5953df668e7SNamhyung Kim else if (annotate.use_gtk) 5963df668e7SNamhyung Kim use_browser = 2; 5973df668e7SNamhyung Kim 5983df668e7SNamhyung Kim setup_browser(true); 5993df668e7SNamhyung Kim 600befd2a38SArnaldo Carvalho de Melo if ((use_browser == 1 || annotate.use_stdio2) && annotate.has_br_stack) { 601bb848c14SJin Yao sort__mode = SORT_MODE__BRANCH; 602bb848c14SJin Yao if (setup_sorting(annotate.session->evlist) < 0) 603bb848c14SJin Yao usage_with_options(annotate_usage, options); 604bb848c14SJin Yao } else { 605bb848c14SJin Yao if (setup_sorting(NULL) < 0) 606bb848c14SJin Yao usage_with_options(annotate_usage, options); 607bb848c14SJin Yao } 608bb848c14SJin Yao 609fa10f316SNamhyung Kim ret = __cmd_annotate(&annotate); 610fa10f316SNamhyung Kim 611fa10f316SNamhyung Kim out_delete: 612fa10f316SNamhyung Kim /* 613fa10f316SNamhyung Kim * Speed up the exit process, for large files this can 614fa10f316SNamhyung Kim * take quite a while. 615fa10f316SNamhyung Kim * 616fa10f316SNamhyung Kim * XXX Enable this when using valgrind or if we ever 617fa10f316SNamhyung Kim * librarize this command. 618fa10f316SNamhyung Kim * 619fa10f316SNamhyung Kim * Also experiment with obstacks to see how much speed 620fa10f316SNamhyung Kim * up we'll get here. 621fa10f316SNamhyung Kim * 622fa10f316SNamhyung Kim * perf_session__delete(session); 623fa10f316SNamhyung Kim */ 624fa10f316SNamhyung Kim return ret; 62586470930SIngo Molnar } 626