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/color.h" 125da50258SArnaldo Carvalho de Melo #include <linux/list.h> 1386470930SIngo Molnar #include "util/cache.h" 1443cbcd8aSArnaldo Carvalho de Melo #include <linux/rbtree.h> 157f7c536fSArnaldo Carvalho de Melo #include <linux/zalloc.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" 27dd68ada2SJohn Kacur #include "util/sort.h" 283d1d07ecSJohn Kacur #include "util/hist.h" 294a3cec84SArnaldo Carvalho de Melo #include "util/dso.h" 303f79132aSArnaldo Carvalho de Melo #include "util/machine.h" 311101f69aSArnaldo Carvalho de Melo #include "util/map.h" 3294c744b6SArnaldo Carvalho de Melo #include "util/session.h" 3345694aa7SArnaldo Carvalho de Melo #include "util/tool.h" 34f5fc1412SJiri Olsa #include "util/data.h" 3568e94f4eSIrina Tirdea #include "arch/common.h" 3670fbe057SPeter Zijlstra #include "util/block-range.h" 37d3300a3cSArnaldo Carvalho de Melo #include "util/map_symbol.h" 38d3300a3cSArnaldo Carvalho de Melo #include "util/branch.h" 3986470930SIngo Molnar 40fc67297bSNamhyung Kim #include <dlfcn.h> 41a43783aeSArnaldo Carvalho de Melo #include <errno.h> 425d67be97SAnton Blanchard #include <linux/bitmap.h> 436ef81c55SMamatha Inamdar #include <linux/err.h> 445d67be97SAnton Blanchard 45d20deb64SArnaldo Carvalho de Melo struct perf_annotate { 4645694aa7SArnaldo Carvalho de Melo struct perf_tool tool; 47fa10f316SNamhyung Kim struct perf_session *session; 48982d410bSArnaldo Carvalho de Melo struct annotation_options opts; 49befd2a38SArnaldo Carvalho de Melo bool use_tui, use_stdio, use_stdio2, use_gtk; 5018c9e5c5SNamhyung Kim bool skip_missing; 51bb848c14SJin Yao bool has_br_stack; 527ebaf489SJin Yao bool group_set; 537009cc34SArnaldo Carvalho de Melo const char *sym_hist_filter; 547009cc34SArnaldo Carvalho de Melo const char *cpu_list; 557009cc34SArnaldo Carvalho de Melo DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS); 56d20deb64SArnaldo Carvalho de Melo }; 575d67be97SAnton Blanchard 5870fbe057SPeter Zijlstra /* 5970fbe057SPeter Zijlstra * Given one basic block: 6070fbe057SPeter Zijlstra * 6170fbe057SPeter Zijlstra * from to branch_i 6270fbe057SPeter Zijlstra * * ----> * 6370fbe057SPeter Zijlstra * | 6470fbe057SPeter Zijlstra * | block 6570fbe057SPeter Zijlstra * v 6670fbe057SPeter Zijlstra * * ----> * 6770fbe057SPeter Zijlstra * from to branch_i+1 6870fbe057SPeter Zijlstra * 6970fbe057SPeter Zijlstra * where the horizontal are the branches and the vertical is the executed 7070fbe057SPeter Zijlstra * block of instructions. 7170fbe057SPeter Zijlstra * 7270fbe057SPeter Zijlstra * We count, for each 'instruction', the number of blocks that covered it as 7370fbe057SPeter Zijlstra * well as count the ratio each branch is taken. 7470fbe057SPeter Zijlstra * 7570fbe057SPeter Zijlstra * We can do this without knowing the actual instruction stream by keeping 7670fbe057SPeter Zijlstra * track of the address ranges. We break down ranges such that there is no 7770fbe057SPeter Zijlstra * overlap and iterate from the start until the end. 7870fbe057SPeter Zijlstra * 7970fbe057SPeter Zijlstra * @acme: once we parse the objdump output _before_ processing the samples, 8070fbe057SPeter Zijlstra * we can easily fold the branch.cycles IPC bits in. 8170fbe057SPeter Zijlstra */ 8270fbe057SPeter Zijlstra static void process_basic_block(struct addr_map_symbol *start, 8370fbe057SPeter Zijlstra struct addr_map_symbol *end, 8470fbe057SPeter Zijlstra struct branch_flags *flags) 8570fbe057SPeter Zijlstra { 86d46a4cdfSArnaldo Carvalho de Melo struct symbol *sym = start->ms.sym; 8770fbe057SPeter Zijlstra struct annotation *notes = sym ? symbol__annotation(sym) : NULL; 8870fbe057SPeter Zijlstra struct block_range_iter iter; 8970fbe057SPeter Zijlstra struct block_range *entry; 9070fbe057SPeter Zijlstra 9170fbe057SPeter Zijlstra /* 9270fbe057SPeter Zijlstra * Sanity; NULL isn't executable and the CPU cannot execute backwards 9370fbe057SPeter Zijlstra */ 9470fbe057SPeter Zijlstra if (!start->addr || start->addr > end->addr) 9570fbe057SPeter Zijlstra return; 9670fbe057SPeter Zijlstra 9770fbe057SPeter Zijlstra iter = block_range__create(start->addr, end->addr); 9870fbe057SPeter Zijlstra if (!block_range_iter__valid(&iter)) 9970fbe057SPeter Zijlstra return; 10070fbe057SPeter Zijlstra 10170fbe057SPeter Zijlstra /* 10270fbe057SPeter Zijlstra * First block in range is a branch target. 10370fbe057SPeter Zijlstra */ 10470fbe057SPeter Zijlstra entry = block_range_iter(&iter); 10570fbe057SPeter Zijlstra assert(entry->is_target); 10670fbe057SPeter Zijlstra entry->entry++; 10770fbe057SPeter Zijlstra 10870fbe057SPeter Zijlstra do { 10970fbe057SPeter Zijlstra entry = block_range_iter(&iter); 11070fbe057SPeter Zijlstra 11170fbe057SPeter Zijlstra entry->coverage++; 11270fbe057SPeter Zijlstra entry->sym = sym; 11370fbe057SPeter Zijlstra 11470fbe057SPeter Zijlstra if (notes) 11570fbe057SPeter Zijlstra notes->max_coverage = max(notes->max_coverage, entry->coverage); 11670fbe057SPeter Zijlstra 11770fbe057SPeter Zijlstra } while (block_range_iter__next(&iter)); 11870fbe057SPeter Zijlstra 11970fbe057SPeter Zijlstra /* 12070fbe057SPeter Zijlstra * Last block in rage is a branch. 12170fbe057SPeter Zijlstra */ 12270fbe057SPeter Zijlstra entry = block_range_iter(&iter); 12370fbe057SPeter Zijlstra assert(entry->is_branch); 12470fbe057SPeter Zijlstra entry->taken++; 12570fbe057SPeter Zijlstra if (flags->predicted) 12670fbe057SPeter Zijlstra entry->pred++; 12770fbe057SPeter Zijlstra } 12870fbe057SPeter Zijlstra 12970fbe057SPeter Zijlstra static void process_branch_stack(struct branch_stack *bs, struct addr_location *al, 13070fbe057SPeter Zijlstra struct perf_sample *sample) 13170fbe057SPeter Zijlstra { 13270fbe057SPeter Zijlstra struct addr_map_symbol *prev = NULL; 13370fbe057SPeter Zijlstra struct branch_info *bi; 13470fbe057SPeter Zijlstra int i; 13570fbe057SPeter Zijlstra 13670fbe057SPeter Zijlstra if (!bs || !bs->nr) 13770fbe057SPeter Zijlstra return; 13870fbe057SPeter Zijlstra 13970fbe057SPeter Zijlstra bi = sample__resolve_bstack(sample, al); 14070fbe057SPeter Zijlstra if (!bi) 14170fbe057SPeter Zijlstra return; 14270fbe057SPeter Zijlstra 14370fbe057SPeter Zijlstra for (i = bs->nr - 1; i >= 0; i--) { 14470fbe057SPeter Zijlstra /* 14570fbe057SPeter Zijlstra * XXX filter against symbol 14670fbe057SPeter Zijlstra */ 14770fbe057SPeter Zijlstra if (prev) 14870fbe057SPeter Zijlstra process_basic_block(prev, &bi[i].from, &bi[i].flags); 14970fbe057SPeter Zijlstra prev = &bi[i].to; 15070fbe057SPeter Zijlstra } 15170fbe057SPeter Zijlstra 15270fbe057SPeter Zijlstra free(bi); 15370fbe057SPeter Zijlstra } 15470fbe057SPeter Zijlstra 155bb848c14SJin Yao static int hist_iter__branch_callback(struct hist_entry_iter *iter, 156bb848c14SJin Yao struct addr_location *al __maybe_unused, 157bb848c14SJin Yao bool single __maybe_unused, 158bb848c14SJin Yao void *arg __maybe_unused) 159bb848c14SJin Yao { 160bb848c14SJin Yao struct hist_entry *he = iter->he; 161bb848c14SJin Yao struct branch_info *bi; 162bb848c14SJin Yao struct perf_sample *sample = iter->sample; 16332dcd021SJiri Olsa struct evsel *evsel = iter->evsel; 164bb848c14SJin Yao int err; 165bb848c14SJin Yao 166bb848c14SJin Yao bi = he->branch_info; 167e345f3bdSArnaldo Carvalho de Melo err = addr_map_symbol__inc_samples(&bi->from, sample, evsel); 168bb848c14SJin Yao 169bb848c14SJin Yao if (err) 170bb848c14SJin Yao goto out; 171bb848c14SJin Yao 172e345f3bdSArnaldo Carvalho de Melo err = addr_map_symbol__inc_samples(&bi->to, sample, evsel); 173bb848c14SJin Yao 174bb848c14SJin Yao out: 175bb848c14SJin Yao return err; 176bb848c14SJin Yao } 177bb848c14SJin Yao 17832dcd021SJiri Olsa static int process_branch_callback(struct evsel *evsel, 179bb848c14SJin Yao struct perf_sample *sample, 180bb848c14SJin Yao struct addr_location *al __maybe_unused, 181bb848c14SJin Yao struct perf_annotate *ann, 182bb848c14SJin Yao struct machine *machine) 183bb848c14SJin Yao { 184bb848c14SJin Yao struct hist_entry_iter iter = { 185bb848c14SJin Yao .evsel = evsel, 186bb848c14SJin Yao .sample = sample, 187bb848c14SJin Yao .add_entry_cb = hist_iter__branch_callback, 188bb848c14SJin Yao .hide_unresolved = symbol_conf.hide_unresolved, 189bb848c14SJin Yao .ops = &hist_iter_branch, 190bb848c14SJin Yao }; 191bb848c14SJin Yao 192bb848c14SJin Yao struct addr_location a; 193bb848c14SJin Yao int ret; 194bb848c14SJin Yao 195bb848c14SJin Yao if (machine__resolve(machine, &a, sample) < 0) 196bb848c14SJin Yao return -1; 197bb848c14SJin Yao 198bb848c14SJin Yao if (a.sym == NULL) 199bb848c14SJin Yao return 0; 200bb848c14SJin Yao 201bb848c14SJin Yao if (a.map != NULL) 202bb848c14SJin Yao a.map->dso->hit = 1; 203bb848c14SJin Yao 2047841f40aSJin Yao hist__account_cycles(sample->branch_stack, al, sample, false, NULL); 205bdd1666bSJin Yao 206bb848c14SJin Yao ret = hist_entry_iter__add(&iter, &a, PERF_MAX_STACK_DEPTH, ann); 207bb848c14SJin Yao return ret; 208bb848c14SJin Yao } 209bb848c14SJin Yao 210befd2a38SArnaldo Carvalho de Melo static bool has_annotation(struct perf_annotate *ann) 211befd2a38SArnaldo Carvalho de Melo { 212befd2a38SArnaldo Carvalho de Melo return ui__has_annotation() || ann->use_stdio2; 213befd2a38SArnaldo Carvalho de Melo } 214befd2a38SArnaldo Carvalho de Melo 21532dcd021SJiri Olsa static int perf_evsel__add_sample(struct evsel *evsel, 216fd36f3ddSNamhyung Kim struct perf_sample *sample, 217d20deb64SArnaldo Carvalho de Melo struct addr_location *al, 218bb848c14SJin Yao struct perf_annotate *ann, 219bb848c14SJin Yao struct machine *machine) 22086470930SIngo Molnar { 2214ea062edSArnaldo Carvalho de Melo struct hists *hists = evsel__hists(evsel); 222628ada0cSArnaldo Carvalho de Melo struct hist_entry *he; 223e248de33SArnaldo Carvalho de Melo int ret; 224628ada0cSArnaldo Carvalho de Melo 225befd2a38SArnaldo Carvalho de Melo if ((!ann->has_br_stack || !has_annotation(ann)) && 226bb848c14SJin Yao ann->sym_hist_filter != NULL && 2277009cc34SArnaldo Carvalho de Melo (al->sym == NULL || 2287009cc34SArnaldo Carvalho de Melo strcmp(ann->sym_hist_filter, al->sym->name) != 0)) { 229628ada0cSArnaldo Carvalho de Melo /* We're only interested in a symbol named sym_hist_filter */ 230facf3f06SArnaldo Carvalho de Melo /* 231facf3f06SArnaldo Carvalho de Melo * FIXME: why isn't this done in the symbol_filter when loading 232facf3f06SArnaldo Carvalho de Melo * the DSO? 233facf3f06SArnaldo Carvalho de Melo */ 234628ada0cSArnaldo Carvalho de Melo if (al->sym != NULL) { 2357137ff50SDavidlohr Bueso rb_erase_cached(&al->sym->rb_node, 2363183f8caSArnaldo Carvalho de Melo &al->map->dso->symbols); 237628ada0cSArnaldo Carvalho de Melo symbol__delete(al->sym); 238c0b4dffbSArnaldo Carvalho de Melo dso__reset_find_symbol_cache(al->map->dso); 239628ada0cSArnaldo Carvalho de Melo } 240628ada0cSArnaldo Carvalho de Melo return 0; 241628ada0cSArnaldo Carvalho de Melo } 242628ada0cSArnaldo Carvalho de Melo 24370fbe057SPeter Zijlstra /* 24470fbe057SPeter Zijlstra * XXX filtered samples can still have branch entires pointing into our 24570fbe057SPeter Zijlstra * symbol and are missed. 24670fbe057SPeter Zijlstra */ 24770fbe057SPeter Zijlstra process_branch_stack(sample->branch_stack, al, sample); 24870fbe057SPeter Zijlstra 249befd2a38SArnaldo Carvalho de Melo if (ann->has_br_stack && has_annotation(ann)) 250bb848c14SJin Yao return process_branch_callback(evsel, sample, al, ann, machine); 251bb848c14SJin Yao 2520102ef3eSJiri Olsa he = hists__add_entry(hists, al, NULL, NULL, NULL, sample, true); 2539735abf1SArnaldo Carvalho de Melo if (he == NULL) 25486470930SIngo Molnar return -ENOMEM; 255628ada0cSArnaldo Carvalho de Melo 256e345f3bdSArnaldo Carvalho de Melo ret = hist_entry__inc_addr_samples(he, sample, evsel, al->addr); 2574ea062edSArnaldo Carvalho de Melo hists__inc_nr_samples(hists, true); 258e248de33SArnaldo Carvalho de Melo return ret; 25986470930SIngo Molnar } 26086470930SIngo Molnar 26145694aa7SArnaldo Carvalho de Melo static int process_sample_event(struct perf_tool *tool, 262d20deb64SArnaldo Carvalho de Melo union perf_event *event, 2638115d60cSArnaldo Carvalho de Melo struct perf_sample *sample, 26432dcd021SJiri Olsa struct evsel *evsel, 265743eb868SArnaldo Carvalho de Melo struct machine *machine) 26686470930SIngo Molnar { 26745694aa7SArnaldo Carvalho de Melo struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool); 2681ed091c4SArnaldo Carvalho de Melo struct addr_location al; 269b91fc39fSArnaldo Carvalho de Melo int ret = 0; 2706baa0a5aSFrederic Weisbecker 271bb3eb566SArnaldo Carvalho de Melo if (machine__resolve(machine, &al, sample) < 0) { 27229a9f66dSArnaldo Carvalho de Melo pr_warning("problem processing %d event, skipping it.\n", 27386470930SIngo Molnar event->header.type); 27486470930SIngo Molnar return -1; 27586470930SIngo Molnar } 27686470930SIngo Molnar 2777009cc34SArnaldo Carvalho de Melo if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap)) 278b91fc39fSArnaldo Carvalho de Melo goto out_put; 2795d67be97SAnton Blanchard 280bb848c14SJin Yao if (!al.filtered && 281bb848c14SJin Yao perf_evsel__add_sample(evsel, sample, &al, ann, machine)) { 28229a9f66dSArnaldo Carvalho de Melo pr_warning("problem incrementing symbol count, " 283ec218fc4SArnaldo Carvalho de Melo "skipping event\n"); 284b91fc39fSArnaldo Carvalho de Melo ret = -1; 28586470930SIngo Molnar } 286b91fc39fSArnaldo Carvalho de Melo out_put: 287b91fc39fSArnaldo Carvalho de Melo addr_location__put(&al); 288b91fc39fSArnaldo Carvalho de Melo return ret; 28986470930SIngo Molnar } 29086470930SIngo Molnar 29189f1688aSJiri Olsa static int process_feature_event(struct perf_session *session, 29289f1688aSJiri Olsa union perf_event *event) 29392ead7eeSRavi Bangoria { 29492ead7eeSRavi Bangoria if (event->feat.feat_id < HEADER_LAST_FEATURE) 29589f1688aSJiri Olsa return perf_event__process_feature(session, event); 29692ead7eeSRavi Bangoria return 0; 29792ead7eeSRavi Bangoria } 29892ead7eeSRavi Bangoria 299db8fd07aSNamhyung Kim static int hist_entry__tty_annotate(struct hist_entry *he, 30032dcd021SJiri Olsa struct evsel *evsel, 301d20deb64SArnaldo Carvalho de Melo struct perf_annotate *ann) 30286470930SIngo Molnar { 303befd2a38SArnaldo Carvalho de Melo if (!ann->use_stdio2) 30429754894SArnaldo Carvalho de Melo return symbol__tty_annotate(&he->ms, evsel, &ann->opts); 305982d410bSArnaldo Carvalho de Melo 30629754894SArnaldo Carvalho de Melo return symbol__tty_annotate2(&he->ms, evsel, &ann->opts); 30786470930SIngo Molnar } 30886470930SIngo Molnar 309c824c433SArnaldo Carvalho de Melo static void hists__find_annotations(struct hists *hists, 31032dcd021SJiri Olsa struct evsel *evsel, 311d20deb64SArnaldo Carvalho de Melo struct perf_annotate *ann) 31286470930SIngo Molnar { 3132eb3d689SDavidlohr Bueso struct rb_node *nd = rb_first_cached(&hists->entries), *next; 314cf958003SArnaldo Carvalho de Melo int key = K_RIGHT; 31586470930SIngo Molnar 31646e3e055SArnaldo Carvalho de Melo while (nd) { 317ed52ce2eSArnaldo Carvalho de Melo struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node); 31878f7defeSArnaldo Carvalho de Melo struct annotation *notes; 31986470930SIngo Molnar 32046e3e055SArnaldo Carvalho de Melo if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned) 32146e3e055SArnaldo Carvalho de Melo goto find_next; 322e4204992SArnaldo Carvalho de Melo 323bb848c14SJin Yao if (ann->sym_hist_filter && 324bb848c14SJin Yao (strcmp(he->ms.sym->name, ann->sym_hist_filter) != 0)) 325bb848c14SJin Yao goto find_next; 326bb848c14SJin Yao 32778f7defeSArnaldo Carvalho de Melo notes = symbol__annotation(he->ms.sym); 328ce6f4fabSArnaldo Carvalho de Melo if (notes->src == NULL) { 32946e3e055SArnaldo Carvalho de Melo find_next: 330cf958003SArnaldo Carvalho de Melo if (key == K_LEFT) 33146e3e055SArnaldo Carvalho de Melo nd = rb_prev(nd); 33246e3e055SArnaldo Carvalho de Melo else 33346e3e055SArnaldo Carvalho de Melo nd = rb_next(nd); 334e4204992SArnaldo Carvalho de Melo continue; 33546e3e055SArnaldo Carvalho de Melo } 336e4204992SArnaldo Carvalho de Melo 3372b676bf0SNamhyung Kim if (use_browser == 2) { 33818c9e5c5SNamhyung Kim int ret; 339fc67297bSNamhyung Kim int (*annotate)(struct hist_entry *he, 34032dcd021SJiri Olsa struct evsel *evsel, 341fc67297bSNamhyung Kim struct hist_browser_timer *hbt); 34218c9e5c5SNamhyung Kim 343fc67297bSNamhyung Kim annotate = dlsym(perf_gtk_handle, 344fc67297bSNamhyung Kim "hist_entry__gtk_annotate"); 345fc67297bSNamhyung Kim if (annotate == NULL) { 346fc67297bSNamhyung Kim ui__error("GTK browser not found!\n"); 347fc67297bSNamhyung Kim return; 348fc67297bSNamhyung Kim } 349fc67297bSNamhyung Kim 350fc67297bSNamhyung Kim ret = annotate(he, evsel, NULL); 35118c9e5c5SNamhyung Kim if (!ret || !ann->skip_missing) 3522b676bf0SNamhyung Kim return; 35318c9e5c5SNamhyung Kim 35418c9e5c5SNamhyung Kim /* skip missing symbols */ 35518c9e5c5SNamhyung Kim nd = rb_next(nd); 3562b676bf0SNamhyung Kim } else if (use_browser == 1) { 357cd0cccbaSArnaldo Carvalho de Melo key = hist_entry__tui_annotate(he, evsel, NULL, &ann->opts); 358bb848c14SJin Yao 35946e3e055SArnaldo Carvalho de Melo switch (key) { 36018c9e5c5SNamhyung Kim case -1: 36118c9e5c5SNamhyung Kim if (!ann->skip_missing) 36218c9e5c5SNamhyung Kim return; 36318c9e5c5SNamhyung Kim /* fall through */ 364cf958003SArnaldo Carvalho de Melo case K_RIGHT: 365b50e003dSArnaldo Carvalho de Melo next = rb_next(nd); 36646e3e055SArnaldo Carvalho de Melo break; 367cf958003SArnaldo Carvalho de Melo case K_LEFT: 368b50e003dSArnaldo Carvalho de Melo next = rb_prev(nd); 36946e3e055SArnaldo Carvalho de Melo break; 370b50e003dSArnaldo Carvalho de Melo default: 371b50e003dSArnaldo Carvalho de Melo return; 37246e3e055SArnaldo Carvalho de Melo } 373b50e003dSArnaldo Carvalho de Melo 374b50e003dSArnaldo Carvalho de Melo if (next != NULL) 375b50e003dSArnaldo Carvalho de Melo nd = next; 37646e3e055SArnaldo Carvalho de Melo } else { 377db8fd07aSNamhyung Kim hist_entry__tty_annotate(he, evsel, ann); 37846e3e055SArnaldo Carvalho de Melo nd = rb_next(nd); 379ed52ce2eSArnaldo Carvalho de Melo /* 38046e3e055SArnaldo Carvalho de Melo * Since we have a hist_entry per IP for the same 381ce6f4fabSArnaldo Carvalho de Melo * symbol, free he->ms.sym->src to signal we already 38246e3e055SArnaldo Carvalho de Melo * processed this symbol. 383ed52ce2eSArnaldo Carvalho de Melo */ 384d4957633SAndi Kleen zfree(¬es->src->cycles_hist); 38504662523SArnaldo Carvalho de Melo zfree(¬es->src); 38686470930SIngo Molnar } 38786470930SIngo Molnar } 38846e3e055SArnaldo Carvalho de Melo } 38986470930SIngo Molnar 390d20deb64SArnaldo Carvalho de Melo static int __cmd_annotate(struct perf_annotate *ann) 39186470930SIngo Molnar { 392bab81b62SLi Zefan int ret; 393fa10f316SNamhyung Kim struct perf_session *session = ann->session; 39432dcd021SJiri Olsa struct evsel *pos; 395e248de33SArnaldo Carvalho de Melo u64 total_nr_samples; 39694c744b6SArnaldo Carvalho de Melo 3977009cc34SArnaldo Carvalho de Melo if (ann->cpu_list) { 3987009cc34SArnaldo Carvalho de Melo ret = perf_session__cpu_bitmap(session, ann->cpu_list, 3997009cc34SArnaldo Carvalho de Melo ann->cpu_bitmap); 4005d67be97SAnton Blanchard if (ret) 401fa10f316SNamhyung Kim goto out; 4025d67be97SAnton Blanchard } 4035d67be97SAnton Blanchard 404f178fd2dSArnaldo Carvalho de Melo if (!ann->opts.objdump_path) { 405f178fd2dSArnaldo Carvalho de Melo ret = perf_env__lookup_objdump(&session->header.env, 406f178fd2dSArnaldo Carvalho de Melo &ann->opts.objdump_path); 40768e94f4eSIrina Tirdea if (ret) 408fa10f316SNamhyung Kim goto out; 40968e94f4eSIrina Tirdea } 41068e94f4eSIrina Tirdea 411b7b61cbeSArnaldo Carvalho de Melo ret = perf_session__process_events(session); 412bab81b62SLi Zefan if (ret) 413fa10f316SNamhyung Kim goto out; 41486470930SIngo Molnar 41562daacb5SArnaldo Carvalho de Melo if (dump_trace) { 416c8446b9bSArnaldo Carvalho de Melo perf_session__fprintf_nr_events(session, stdout); 4172a1731fbSArnaldo Carvalho de Melo perf_evlist__fprintf_nr_events(session->evlist, stdout); 418fa10f316SNamhyung Kim goto out; 41962daacb5SArnaldo Carvalho de Melo } 42086470930SIngo Molnar 421da21d1b5SArnaldo Carvalho de Melo if (verbose > 3) 422b3165f41SArnaldo Carvalho de Melo perf_session__fprintf(session, stdout); 42386470930SIngo Molnar 424da21d1b5SArnaldo Carvalho de Melo if (verbose > 2) 425cbf69680SArnaldo Carvalho de Melo perf_session__fprintf_dsos(session, stdout); 42686470930SIngo Molnar 427e248de33SArnaldo Carvalho de Melo total_nr_samples = 0; 428e5cadb93SArnaldo Carvalho de Melo evlist__for_each_entry(session->evlist, pos) { 4294ea062edSArnaldo Carvalho de Melo struct hists *hists = evsel__hists(pos); 430e248de33SArnaldo Carvalho de Melo u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE]; 43186470930SIngo Molnar 432e248de33SArnaldo Carvalho de Melo if (nr_samples > 0) { 433e248de33SArnaldo Carvalho de Melo total_nr_samples += nr_samples; 434c1fb5651SNamhyung Kim hists__collapse_resort(hists, NULL); 435f9db0d0fSKan Liang /* Don't sort callchain */ 436862b2f8fSArnaldo Carvalho de Melo evsel__reset_sample_bit(pos, CALLCHAIN); 437452ce03bSJiri Olsa perf_evsel__output_resort(pos, NULL); 438b1dd4432SNamhyung Kim 439b1dd4432SNamhyung Kim if (symbol_conf.event_group && 440b1dd4432SNamhyung Kim !perf_evsel__is_group_leader(pos)) 441b1dd4432SNamhyung Kim continue; 442b1dd4432SNamhyung Kim 443db8fd07aSNamhyung Kim hists__find_annotations(hists, pos, ann); 444e248de33SArnaldo Carvalho de Melo } 445e248de33SArnaldo Carvalho de Melo } 446e248de33SArnaldo Carvalho de Melo 447e248de33SArnaldo Carvalho de Melo if (total_nr_samples == 0) { 4482d4f2799SJiri Olsa ui__error("The %s data has no samples!\n", session->data->path); 449fa10f316SNamhyung Kim goto out; 450e248de33SArnaldo Carvalho de Melo } 4517a60ba94SNamhyung Kim 452fc67297bSNamhyung Kim if (use_browser == 2) { 453fc67297bSNamhyung Kim void (*show_annotations)(void); 454fc67297bSNamhyung Kim 455fc67297bSNamhyung Kim show_annotations = dlsym(perf_gtk_handle, 456fc67297bSNamhyung Kim "perf_gtk__show_annotations"); 457fc67297bSNamhyung Kim if (show_annotations == NULL) { 458fc67297bSNamhyung Kim ui__error("GTK browser not found!\n"); 459fa10f316SNamhyung Kim goto out; 460fc67297bSNamhyung Kim } 461fc67297bSNamhyung Kim show_annotations(); 462fc67297bSNamhyung Kim } 4637a60ba94SNamhyung Kim 464fa10f316SNamhyung Kim out: 465bab81b62SLi Zefan return ret; 46686470930SIngo Molnar } 46786470930SIngo Molnar 46886470930SIngo Molnar static const char * const annotate_usage[] = { 46999345254SNamhyung Kim "perf annotate [<options>]", 47086470930SIngo Molnar NULL 47186470930SIngo Molnar }; 47286470930SIngo Molnar 473b0ad8ea6SArnaldo Carvalho de Melo int cmd_annotate(int argc, const char **argv) 474d20deb64SArnaldo Carvalho de Melo { 475d20deb64SArnaldo Carvalho de Melo struct perf_annotate annotate = { 47645694aa7SArnaldo Carvalho de Melo .tool = { 477d20deb64SArnaldo Carvalho de Melo .sample = process_sample_event, 478d20deb64SArnaldo Carvalho de Melo .mmap = perf_event__process_mmap, 4795c5e854bSStephane Eranian .mmap2 = perf_event__process_mmap2, 480d20deb64SArnaldo Carvalho de Melo .comm = perf_event__process_comm, 481ec4622f5SArnaldo Carvalho de Melo .exit = perf_event__process_exit, 482f62d3f0fSArnaldo Carvalho de Melo .fork = perf_event__process_fork, 483f3b3614aSHari Bathini .namespaces = perf_event__process_namespaces, 4846ab11f3aSDavid Carrillo-Cisneros .attr = perf_event__process_attr, 4856ab11f3aSDavid Carrillo-Cisneros .build_id = perf_event__process_build_id, 486f4849599SDavid Carrillo-Cisneros .tracing_data = perf_event__process_tracing_data, 48792ead7eeSRavi Bangoria .feature = process_feature_event, 4880a8cb85cSJiri Olsa .ordered_events = true, 489d20deb64SArnaldo Carvalho de Melo .ordering_requires_timestamps = true, 490d20deb64SArnaldo Carvalho de Melo }, 491982d410bSArnaldo Carvalho de Melo .opts = annotation__default_options, 492d20deb64SArnaldo Carvalho de Melo }; 4938ceb41d7SJiri Olsa struct perf_data data = { 494fa10f316SNamhyung Kim .mode = PERF_DATA_MODE_READ, 495fa10f316SNamhyung Kim }; 4961ac39372STaeung Song struct option options[] = { 49770cb4e96SFeng Tang OPT_STRING('i', "input", &input_name, "file", 49886470930SIngo Molnar "input file name"), 499ac73c5a9SArnaldo Carvalho de Melo OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]", 500ac73c5a9SArnaldo Carvalho de Melo "only consider symbols in these dsos"), 5017009cc34SArnaldo Carvalho de Melo OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol", 50286470930SIngo Molnar "symbol to annotate"), 5038ceb41d7SJiri Olsa OPT_BOOLEAN('f', "force", &data.force, "don't complain, do it"), 504c0555642SIan Munsie OPT_INCR('v', "verbose", &verbose, 50586470930SIngo Molnar "be more verbose (show symbol address, etc)"), 506eddaef88SNamhyung Kim OPT_BOOLEAN('q', "quiet", &quiet, "do now show any message"), 50786470930SIngo Molnar OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, 50886470930SIngo Molnar "dump raw trace in ASCII"), 5092b676bf0SNamhyung Kim OPT_BOOLEAN(0, "gtk", &annotate.use_gtk, "Use the GTK interface"), 5107009cc34SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"), 5117009cc34SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"), 512befd2a38SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "stdio2", &annotate.use_stdio2, "Use the stdio interface"), 513be316409SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux, 514be316409SArnaldo Carvalho de Melo "don't load vmlinux even if found"), 515b32d133aSArnaldo Carvalho de Melo OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, 516b32d133aSArnaldo Carvalho de Melo "file", "vmlinux pathname"), 517b32d133aSArnaldo Carvalho de Melo OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules, 51842976487SMike Galbraith "load module symbols - WARNING: use only with -k and LIVE kernel"), 519982d410bSArnaldo Carvalho de Melo OPT_BOOLEAN('l', "print-line", &annotate.opts.print_lines, 520301406b9SFrederic Weisbecker "print matching source lines (may be slow)"), 521982d410bSArnaldo Carvalho de Melo OPT_BOOLEAN('P', "full-paths", &annotate.opts.full_path, 52242976487SMike Galbraith "Don't shorten the displayed pathnames"), 52318c9e5c5SNamhyung Kim OPT_BOOLEAN(0, "skip-missing", &annotate.skip_missing, 52418c9e5c5SNamhyung Kim "Skip symbols that cannot be annotated"), 5257ebaf489SJin Yao OPT_BOOLEAN_SET(0, "group", &symbol_conf.event_group, 5267ebaf489SJin Yao &annotate.group_set, 5277ebaf489SJin Yao "Show event group information together"), 528c8e66720SDavid Ahern OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"), 529a7066709SHe Kuang OPT_CALLBACK(0, "symfs", NULL, "directory", 530a7066709SHe Kuang "Look for files with symbols relative to this directory", 531a7066709SHe Kuang symbol__config_symfs), 5321eddd9e4SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "source", &annotate.opts.annotate_src, 5333e6a2a7fSStephane Eranian "Interleave source code with assembly code (default)"), 5341eddd9e4SArnaldo Carvalho de Melo OPT_BOOLEAN(0, "asm-raw", &annotate.opts.show_asm_raw, 5353e6a2a7fSStephane Eranian "Display raw encoding of assembly instructions (default)"), 536a47e843eSArnaldo Carvalho de Melo OPT_STRING('M', "disassembler-style", &annotate.opts.disassembler_style, "disassembler style", 537f69b64f7SAndi Kleen "Specify disassembler style (e.g. -M intel for intel syntax)"), 5383b0b16bfSAndi Kleen OPT_STRING(0, "prefix", &annotate.opts.prefix, "prefix", 5393b0b16bfSAndi Kleen "Add prefix to source file path names in programs (with --prefix-strip)"), 5403b0b16bfSAndi Kleen OPT_STRING(0, "prefix-strip", &annotate.opts.prefix_strip, "N", 5413b0b16bfSAndi Kleen "Strip first N entries of source file path name in programs (with --prefix)"), 542f178fd2dSArnaldo Carvalho de Melo OPT_STRING(0, "objdump", &annotate.opts.objdump_path, "path", 5437a4ec938SMaciek Borzecki "objdump binary to use for disassembly and annotations"), 544b1dd4432SNamhyung Kim OPT_BOOLEAN(0, "group", &symbol_conf.event_group, 545b1dd4432SNamhyung Kim "Show event group information together"), 5460c4a5bceSMartin Liška OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period, 5470c4a5bceSMartin Liška "Show a column with the sum of periods"), 5481ac39372STaeung Song OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples, 5491ac39372STaeung Song "Show a column with the number of samples"), 55053fe4ba1SArnaldo Carvalho de Melo OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL, "mode", 55153fe4ba1SArnaldo Carvalho de Melo "'always' (default), 'never' or 'auto' only applicable to --stdio mode", 55253fe4ba1SArnaldo Carvalho de Melo stdio__config_color, "always"), 55388c21190SJiri Olsa OPT_CALLBACK(0, "percent-type", &annotate.opts, "local-period", 55488c21190SJiri Olsa "Set percent type local/global-period/hits", 55588c21190SJiri Olsa annotate_parse_percent_type), 55688c21190SJiri Olsa 55786470930SIngo Molnar OPT_END() 55886470930SIngo Molnar }; 5591ac39372STaeung Song int ret; 560a635fc51SArnaldo Carvalho de Melo 5611ac39372STaeung Song set_option_flag(options, 0, "show-total-period", PARSE_OPT_EXCLUSIVE); 5621ac39372STaeung Song set_option_flag(options, 0, "show-nr-samples", PARSE_OPT_EXCLUSIVE); 5631ac39372STaeung Song 5641ac39372STaeung Song 5651ac39372STaeung Song ret = hists__init(); 566a635fc51SArnaldo Carvalho de Melo if (ret < 0) 567a635fc51SArnaldo Carvalho de Melo return ret; 56886470930SIngo Molnar 569812b0f52SRavi Bangoria annotation_config__init(&annotate.opts); 570812b0f52SRavi Bangoria 571655000e7SArnaldo Carvalho de Melo argc = parse_options(argc, argv, options, annotate_usage, 0); 57250e19ef9SNamhyung Kim if (argc) { 57350e19ef9SNamhyung Kim /* 57450e19ef9SNamhyung Kim * Special case: if there's an argument left then assume that 57550e19ef9SNamhyung Kim * it's a symbol filter: 57650e19ef9SNamhyung Kim */ 57750e19ef9SNamhyung Kim if (argc > 1) 57850e19ef9SNamhyung Kim usage_with_options(annotate_usage, options); 57950e19ef9SNamhyung Kim 58050e19ef9SNamhyung Kim annotate.sym_hist_filter = argv[0]; 58150e19ef9SNamhyung Kim } 582655000e7SArnaldo Carvalho de Melo 5833b0b16bfSAndi Kleen if (annotate_check_args(&annotate.opts) < 0) 5843b0b16bfSAndi Kleen return -EINVAL; 5853b0b16bfSAndi Kleen 5869cef4b0bSTaeung Song if (symbol_conf.show_nr_samples && annotate.use_gtk) { 5879cef4b0bSTaeung Song pr_err("--show-nr-samples is not available in --gtk mode at this time\n"); 5881ac39372STaeung Song return ret; 5891ac39372STaeung Song } 5901ac39372STaeung Song 591eddaef88SNamhyung Kim if (quiet) 592eddaef88SNamhyung Kim perf_quiet_option(); 593eddaef88SNamhyung Kim 5942d4f2799SJiri Olsa data.path = input_name; 59544848cdbSMartin Liška 5968ceb41d7SJiri Olsa annotate.session = perf_session__new(&data, false, &annotate.tool); 5976ef81c55SMamatha Inamdar if (IS_ERR(annotate.session)) 5986ef81c55SMamatha Inamdar return PTR_ERR(annotate.session); 599fa10f316SNamhyung Kim 600bb848c14SJin Yao annotate.has_br_stack = perf_header__has_feat(&annotate.session->header, 601bb848c14SJin Yao HEADER_BRANCH_STACK); 602bb848c14SJin Yao 6037ebaf489SJin Yao if (annotate.group_set) 6047ebaf489SJin Yao perf_evlist__force_leader(annotate.session->evlist); 6057ebaf489SJin Yao 606b01141f4SArnaldo Carvalho de Melo ret = symbol__annotation_init(); 607b01141f4SArnaldo Carvalho de Melo if (ret < 0) 608b01141f4SArnaldo Carvalho de Melo goto out_delete; 609b01141f4SArnaldo Carvalho de Melo 61075be6cf4SArnaldo Carvalho de Melo symbol_conf.try_vmlinux_path = true; 61175be6cf4SArnaldo Carvalho de Melo 6120a7e6d1bSNamhyung Kim ret = symbol__init(&annotate.session->header.env); 613fa10f316SNamhyung Kim if (ret < 0) 614fa10f316SNamhyung Kim goto out_delete; 61586470930SIngo Molnar 616befd2a38SArnaldo Carvalho de Melo if (annotate.use_stdio || annotate.use_stdio2) 6173df668e7SNamhyung Kim use_browser = 0; 6183df668e7SNamhyung Kim else if (annotate.use_tui) 6193df668e7SNamhyung Kim use_browser = 1; 6203df668e7SNamhyung Kim else if (annotate.use_gtk) 6213df668e7SNamhyung Kim use_browser = 2; 6223df668e7SNamhyung Kim 6233df668e7SNamhyung Kim setup_browser(true); 6243df668e7SNamhyung Kim 625befd2a38SArnaldo Carvalho de Melo if ((use_browser == 1 || annotate.use_stdio2) && annotate.has_br_stack) { 626bb848c14SJin Yao sort__mode = SORT_MODE__BRANCH; 627bb848c14SJin Yao if (setup_sorting(annotate.session->evlist) < 0) 628bb848c14SJin Yao usage_with_options(annotate_usage, options); 629bb848c14SJin Yao } else { 630bb848c14SJin Yao if (setup_sorting(NULL) < 0) 631bb848c14SJin Yao usage_with_options(annotate_usage, options); 632bb848c14SJin Yao } 633bb848c14SJin Yao 634fa10f316SNamhyung Kim ret = __cmd_annotate(&annotate); 635fa10f316SNamhyung Kim 636fa10f316SNamhyung Kim out_delete: 637fa10f316SNamhyung Kim /* 638fa10f316SNamhyung Kim * Speed up the exit process, for large files this can 639fa10f316SNamhyung Kim * take quite a while. 640fa10f316SNamhyung Kim * 641fa10f316SNamhyung Kim * XXX Enable this when using valgrind or if we ever 642fa10f316SNamhyung Kim * librarize this command. 643fa10f316SNamhyung Kim * 644fa10f316SNamhyung Kim * Also experiment with obstacks to see how much speed 645fa10f316SNamhyung Kim * up we'll get here. 646fa10f316SNamhyung Kim * 647fa10f316SNamhyung Kim * perf_session__delete(session); 648fa10f316SNamhyung Kim */ 649fa10f316SNamhyung Kim return ret; 65086470930SIngo Molnar } 651