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 "util/data.h"
32 #include "arch/common.h"
35 #include <linux/bitmap.h>
37 struct perf_annotate {
38 struct perf_tool tool;
39 bool force, use_tui, use_stdio, use_gtk;
43 const char *sym_hist_filter;
45 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
48 static int perf_evsel__add_sample(struct perf_evsel *evsel,
49 struct perf_sample *sample __maybe_unused,
50 struct addr_location *al,
51 struct perf_annotate *ann)
53 struct hist_entry *he;
56 if (ann->sym_hist_filter != NULL &&
58 strcmp(ann->sym_hist_filter, al->sym->name) != 0)) {
59 /* We're only interested in a symbol named sym_hist_filter */
60 if (al->sym != NULL) {
61 rb_erase(&al->sym->rb_node,
62 &al->map->dso->symbols[al->map->type]);
63 symbol__delete(al->sym);
68 he = __hists__add_entry(&evsel->hists, al, NULL, NULL, NULL, 1, 1, 0);
72 ret = hist_entry__inc_addr_samples(he, evsel->idx, al->addr);
73 hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE);
77 static int process_sample_event(struct perf_tool *tool,
78 union perf_event *event,
79 struct perf_sample *sample,
80 struct perf_evsel *evsel,
81 struct machine *machine)
83 struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool);
84 struct addr_location al;
86 if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
87 pr_warning("problem processing %d event, skipping it.\n",
92 if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap))
95 if (!al.filtered && perf_evsel__add_sample(evsel, sample, &al, ann)) {
96 pr_warning("problem incrementing symbol count, "
104 static int hist_entry__tty_annotate(struct hist_entry *he,
105 struct perf_evsel *evsel,
106 struct perf_annotate *ann)
108 return symbol__tty_annotate(he->ms.sym, he->ms.map, evsel,
109 ann->print_line, ann->full_paths, 0, 0);
112 static void hists__find_annotations(struct hists *hists,
113 struct perf_evsel *evsel,
114 struct perf_annotate *ann)
116 struct rb_node *nd = rb_first(&hists->entries), *next;
120 struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
121 struct annotation *notes;
123 if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned)
126 notes = symbol__annotation(he->ms.sym);
127 if (notes->src == NULL) {
136 if (use_browser == 2) {
138 int (*annotate)(struct hist_entry *he,
139 struct perf_evsel *evsel,
140 struct hist_browser_timer *hbt);
142 annotate = dlsym(perf_gtk_handle,
143 "hist_entry__gtk_annotate");
144 if (annotate == NULL) {
145 ui__error("GTK browser not found!\n");
149 ret = annotate(he, evsel, NULL);
150 if (!ret || !ann->skip_missing)
153 /* skip missing symbols */
155 } else if (use_browser == 1) {
156 key = hist_entry__tui_annotate(he, evsel, NULL);
159 if (!ann->skip_missing)
175 hist_entry__tty_annotate(he, evsel, ann);
178 * Since we have a hist_entry per IP for the same
179 * symbol, free he->ms.sym->src to signal we already
180 * processed this symbol.
187 static int __cmd_annotate(struct perf_annotate *ann)
190 struct perf_session *session;
191 struct perf_evsel *pos;
192 u64 total_nr_samples;
193 struct perf_data_file file = {
195 .mode = PERF_DATA_MODE_READ,
199 session = perf_session__new(&file, false, &ann->tool);
203 machines__set_symbol_filter(&session->machines, symbol__annotate_init);
206 ret = perf_session__cpu_bitmap(session, ann->cpu_list,
213 ret = perf_session_env__lookup_objdump(&session->header.env);
218 ret = perf_session__process_events(session, &ann->tool);
223 perf_session__fprintf_nr_events(session, stdout);
228 perf_session__fprintf(session, stdout);
231 perf_session__fprintf_dsos(session, stdout);
233 total_nr_samples = 0;
234 evlist__for_each(session->evlist, pos) {
235 struct hists *hists = &pos->hists;
236 u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
238 if (nr_samples > 0) {
239 total_nr_samples += nr_samples;
240 hists__collapse_resort(hists, NULL);
241 hists__output_resort(hists);
243 if (symbol_conf.event_group &&
244 !perf_evsel__is_group_leader(pos))
247 hists__find_annotations(hists, pos, ann);
251 if (total_nr_samples == 0) {
252 ui__error("The %s file has no samples!\n", file.path);
256 if (use_browser == 2) {
257 void (*show_annotations)(void);
259 show_annotations = dlsym(perf_gtk_handle,
260 "perf_gtk__show_annotations");
261 if (show_annotations == NULL) {
262 ui__error("GTK browser not found!\n");
270 * Speed up the exit process, for large files this can
271 * take quite a while.
273 * XXX Enable this when using valgrind or if we ever
274 * librarize this command.
276 * Also experiment with obstacks to see how much speed
279 * perf_session__delete(session);
284 static const char * const annotate_usage[] = {
285 "perf annotate [<options>]",
289 int cmd_annotate(int argc, const char **argv, const char *prefix __maybe_unused)
291 struct perf_annotate annotate = {
293 .sample = process_sample_event,
294 .mmap = perf_event__process_mmap,
295 .mmap2 = perf_event__process_mmap2,
296 .comm = perf_event__process_comm,
297 .exit = perf_event__process_exit,
298 .fork = perf_event__process_fork,
299 .ordered_samples = true,
300 .ordering_requires_timestamps = true,
303 const struct option options[] = {
304 OPT_STRING('i', "input", &input_name, "file",
306 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
307 "only consider symbols in these dsos"),
308 OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol",
309 "symbol to annotate"),
310 OPT_BOOLEAN('f', "force", &annotate.force, "don't complain, do it"),
311 OPT_INCR('v', "verbose", &verbose,
312 "be more verbose (show symbol address, etc)"),
313 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
314 "dump raw trace in ASCII"),
315 OPT_BOOLEAN(0, "gtk", &annotate.use_gtk, "Use the GTK interface"),
316 OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"),
317 OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"),
318 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
319 "file", "vmlinux pathname"),
320 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
321 "load module symbols - WARNING: use only with -k and LIVE kernel"),
322 OPT_BOOLEAN('l', "print-line", &annotate.print_line,
323 "print matching source lines (may be slow)"),
324 OPT_BOOLEAN('P', "full-paths", &annotate.full_paths,
325 "Don't shorten the displayed pathnames"),
326 OPT_BOOLEAN(0, "skip-missing", &annotate.skip_missing,
327 "Skip symbols that cannot be annotated"),
328 OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"),
329 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
330 "Look for files with symbols relative to this directory"),
331 OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
332 "Interleave source code with assembly code (default)"),
333 OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
334 "Display raw encoding of assembly instructions (default)"),
335 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
336 "Specify disassembler style (e.g. -M intel for intel syntax)"),
337 OPT_STRING(0, "objdump", &objdump_path, "path",
338 "objdump binary to use for disassembly and annotations"),
339 OPT_BOOLEAN(0, "group", &symbol_conf.event_group,
340 "Show event group information together"),
344 argc = parse_options(argc, argv, options, annotate_usage, 0);
346 if (annotate.use_stdio)
348 else if (annotate.use_tui)
350 else if (annotate.use_gtk)
355 symbol_conf.priv_size = sizeof(struct annotation);
356 symbol_conf.try_vmlinux_path = true;
358 if (symbol__init() < 0)
361 if (setup_sorting() < 0)
362 usage_with_options(annotate_usage, options);
366 * Special case: if there's an argument left then assume that
367 * it's a symbol filter:
370 usage_with_options(annotate_usage, options);
372 annotate.sym_hist_filter = argv[0];
375 return __cmd_annotate(&annotate);