4 * Builtin annotate command: Analyze the perf.data input file,
5 * look up and read DSOs and symbol information and display
6 * a histogram of results, along various sorting keys.
10 #include "util/util.h"
11 #include "util/color.h"
12 #include <linux/list.h>
13 #include "util/cache.h"
14 #include <linux/rbtree.h>
15 #include "util/symbol.h"
18 #include "util/debug.h"
20 #include "util/evlist.h"
21 #include "util/evsel.h"
22 #include "util/annotate.h"
23 #include "util/event.h"
24 #include "util/parse-options.h"
25 #include "util/parse-events.h"
26 #include "util/thread.h"
27 #include "util/sort.h"
28 #include "util/hist.h"
29 #include "util/session.h"
30 #include "util/tool.h"
31 #include "arch/common.h"
33 #include <linux/bitmap.h>
35 struct perf_annotate {
36 struct perf_tool tool;
37 bool force, use_tui, use_stdio, use_gtk;
41 const char *sym_hist_filter;
43 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
46 static int perf_evsel__add_sample(struct perf_evsel *evsel,
47 struct perf_sample *sample,
48 struct addr_location *al,
49 struct perf_annotate *ann)
51 struct hist_entry *he;
54 if (ann->sym_hist_filter != NULL &&
56 strcmp(ann->sym_hist_filter, al->sym->name) != 0)) {
57 /* We're only interested in a symbol named sym_hist_filter */
58 if (al->sym != NULL) {
59 rb_erase(&al->sym->rb_node,
60 &al->map->dso->symbols[al->map->type]);
61 symbol__delete(al->sym);
66 he = __hists__add_entry(&evsel->hists, al, NULL, 1);
71 if (he->ms.sym != NULL) {
72 struct annotation *notes = symbol__annotation(he->ms.sym);
73 if (notes->src == NULL && symbol__alloc_hist(he->ms.sym) < 0)
76 ret = hist_entry__inc_addr_samples(he, evsel->idx, al->addr);
79 evsel->hists.stats.total_period += sample->period;
80 hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE);
84 static int process_sample_event(struct perf_tool *tool,
85 union perf_event *event,
86 struct perf_sample *sample,
87 struct perf_evsel *evsel,
88 struct machine *machine)
90 struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool);
91 struct addr_location al;
93 if (perf_event__preprocess_sample(event, machine, &al, sample,
94 symbol__annotate_init) < 0) {
95 pr_warning("problem processing %d event, skipping it.\n",
100 if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap))
103 if (!al.filtered && perf_evsel__add_sample(evsel, sample, &al, ann)) {
104 pr_warning("problem incrementing symbol count, "
112 static int hist_entry__tty_annotate(struct hist_entry *he, int evidx,
113 struct perf_annotate *ann)
115 return symbol__tty_annotate(he->ms.sym, he->ms.map, evidx,
116 ann->print_line, ann->full_paths, 0, 0);
119 static void hists__find_annotations(struct hists *self, int evidx,
120 struct perf_annotate *ann)
122 struct rb_node *nd = rb_first(&self->entries), *next;
126 struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
127 struct annotation *notes;
129 if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned)
132 notes = symbol__annotation(he->ms.sym);
133 if (notes->src == NULL) {
142 if (use_browser == 2) {
145 ret = hist_entry__gtk_annotate(he, evidx, NULL);
146 if (!ret || !ann->skip_missing)
149 /* skip missing symbols */
151 } else if (use_browser == 1) {
152 key = hist_entry__tui_annotate(he, evidx, NULL);
155 if (!ann->skip_missing)
171 hist_entry__tty_annotate(he, evidx, ann);
174 * Since we have a hist_entry per IP for the same
175 * symbol, free he->ms.sym->src to signal we already
176 * processed this symbol.
184 static int __cmd_annotate(struct perf_annotate *ann)
187 struct perf_session *session;
188 struct perf_evsel *pos;
189 u64 total_nr_samples;
191 session = perf_session__new(input_name, O_RDONLY,
192 ann->force, false, &ann->tool);
197 ret = perf_session__cpu_bitmap(session, ann->cpu_list,
204 ret = perf_session_env__lookup_objdump(&session->header.env);
209 ret = perf_session__process_events(session, &ann->tool);
214 perf_session__fprintf_nr_events(session, stdout);
219 perf_session__fprintf(session, stdout);
222 perf_session__fprintf_dsos(session, stdout);
224 total_nr_samples = 0;
225 list_for_each_entry(pos, &session->evlist->entries, node) {
226 struct hists *hists = &pos->hists;
227 u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
229 if (nr_samples > 0) {
230 total_nr_samples += nr_samples;
231 hists__collapse_resort(hists);
232 hists__output_resort(hists);
233 hists__find_annotations(hists, pos->idx, ann);
237 if (total_nr_samples == 0) {
238 ui__error("The %s file has no samples!\n", session->filename);
242 if (use_browser == 2)
243 perf_gtk__show_annotations();
247 * Speed up the exit process, for large files this can
248 * take quite a while.
250 * XXX Enable this when using valgrind or if we ever
251 * librarize this command.
253 * Also experiment with obstacks to see how much speed
256 * perf_session__delete(session);
261 static const char * const annotate_usage[] = {
262 "perf annotate [<options>]",
266 int cmd_annotate(int argc, const char **argv, const char *prefix __maybe_unused)
268 struct perf_annotate annotate = {
270 .sample = process_sample_event,
271 .mmap = perf_event__process_mmap,
272 .comm = perf_event__process_comm,
273 .exit = perf_event__process_exit,
274 .fork = perf_event__process_fork,
275 .ordered_samples = true,
276 .ordering_requires_timestamps = true,
279 const struct option options[] = {
280 OPT_STRING('i', "input", &input_name, "file",
282 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
283 "only consider symbols in these dsos"),
284 OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol",
285 "symbol to annotate"),
286 OPT_BOOLEAN('f', "force", &annotate.force, "don't complain, do it"),
287 OPT_INCR('v', "verbose", &verbose,
288 "be more verbose (show symbol address, etc)"),
289 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
290 "dump raw trace in ASCII"),
291 OPT_BOOLEAN(0, "gtk", &annotate.use_gtk, "Use the GTK interface"),
292 OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"),
293 OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"),
294 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
295 "file", "vmlinux pathname"),
296 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
297 "load module symbols - WARNING: use only with -k and LIVE kernel"),
298 OPT_BOOLEAN('l', "print-line", &annotate.print_line,
299 "print matching source lines (may be slow)"),
300 OPT_BOOLEAN('P', "full-paths", &annotate.full_paths,
301 "Don't shorten the displayed pathnames"),
302 OPT_BOOLEAN(0, "skip-missing", &annotate.skip_missing,
303 "Skip symbols that cannot be annotated"),
304 OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"),
305 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
306 "Look for files with symbols relative to this directory"),
307 OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
308 "Interleave source code with assembly code (default)"),
309 OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
310 "Display raw encoding of assembly instructions (default)"),
311 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
312 "Specify disassembler style (e.g. -M intel for intel syntax)"),
313 OPT_STRING(0, "objdump", &objdump_path, "path",
314 "objdump binary to use for disassembly and annotations"),
318 argc = parse_options(argc, argv, options, annotate_usage, 0);
320 if (annotate.use_stdio)
322 else if (annotate.use_tui)
324 else if (annotate.use_gtk)
329 symbol_conf.priv_size = sizeof(struct annotation);
330 symbol_conf.try_vmlinux_path = true;
332 if (symbol__init() < 0)
335 if (setup_sorting() < 0)
336 usage_with_options(annotate_usage, options);
340 * Special case: if there's an argument left then assume tha
341 * it's a symbol filter:
344 usage_with_options(annotate_usage, options);
346 annotate.sym_hist_filter = argv[0];
349 return __cmd_annotate(&annotate);