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
,
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);
73 if (he
->ms
.sym
!= NULL
) {
74 struct annotation
*notes
= symbol__annotation(he
->ms
.sym
);
75 if (notes
->src
== NULL
&& symbol__alloc_hist(he
->ms
.sym
) < 0)
78 ret
= hist_entry__inc_addr_samples(he
, evsel
->idx
, al
->addr
);
81 evsel
->hists
.stats
.total_period
+= sample
->period
;
82 hists__inc_nr_events(&evsel
->hists
, PERF_RECORD_SAMPLE
);
86 static int process_sample_event(struct perf_tool
*tool
,
87 union perf_event
*event
,
88 struct perf_sample
*sample
,
89 struct perf_evsel
*evsel
,
90 struct machine
*machine
)
92 struct perf_annotate
*ann
= container_of(tool
, struct perf_annotate
, tool
);
93 struct addr_location al
;
95 if (perf_event__preprocess_sample(event
, machine
, &al
, sample
) < 0) {
96 pr_warning("problem processing %d event, skipping it.\n",
101 if (ann
->cpu_list
&& !test_bit(sample
->cpu
, ann
->cpu_bitmap
))
104 if (!al
.filtered
&& perf_evsel__add_sample(evsel
, sample
, &al
, ann
)) {
105 pr_warning("problem incrementing symbol count, "
113 static int hist_entry__tty_annotate(struct hist_entry
*he
,
114 struct perf_evsel
*evsel
,
115 struct perf_annotate
*ann
)
117 return symbol__tty_annotate(he
->ms
.sym
, he
->ms
.map
, evsel
,
118 ann
->print_line
, ann
->full_paths
, 0, 0);
121 static void hists__find_annotations(struct hists
*hists
,
122 struct perf_evsel
*evsel
,
123 struct perf_annotate
*ann
)
125 struct rb_node
*nd
= rb_first(&hists
->entries
), *next
;
129 struct hist_entry
*he
= rb_entry(nd
, struct hist_entry
, rb_node
);
130 struct annotation
*notes
;
132 if (he
->ms
.sym
== NULL
|| he
->ms
.map
->dso
->annotate_warned
)
135 notes
= symbol__annotation(he
->ms
.sym
);
136 if (notes
->src
== NULL
) {
145 if (use_browser
== 2) {
147 int (*annotate
)(struct hist_entry
*he
,
148 struct perf_evsel
*evsel
,
149 struct hist_browser_timer
*hbt
);
151 annotate
= dlsym(perf_gtk_handle
,
152 "hist_entry__gtk_annotate");
153 if (annotate
== NULL
) {
154 ui__error("GTK browser not found!\n");
158 ret
= annotate(he
, evsel
, NULL
);
159 if (!ret
|| !ann
->skip_missing
)
162 /* skip missing symbols */
164 } else if (use_browser
== 1) {
165 key
= hist_entry__tui_annotate(he
, evsel
, NULL
);
168 if (!ann
->skip_missing
)
184 hist_entry__tty_annotate(he
, evsel
, ann
);
187 * Since we have a hist_entry per IP for the same
188 * symbol, free he->ms.sym->src to signal we already
189 * processed this symbol.
197 static int __cmd_annotate(struct perf_annotate
*ann
)
200 struct perf_session
*session
;
201 struct perf_evsel
*pos
;
202 u64 total_nr_samples
;
203 struct perf_data_file file
= {
205 .mode
= PERF_DATA_MODE_READ
,
209 session
= perf_session__new(&file
, false, &ann
->tool
);
213 machines__set_symbol_filter(&session
->machines
, symbol__annotate_init
);
216 ret
= perf_session__cpu_bitmap(session
, ann
->cpu_list
,
223 ret
= perf_session_env__lookup_objdump(&session
->header
.env
);
228 ret
= perf_session__process_events(session
, &ann
->tool
);
233 perf_session__fprintf_nr_events(session
, stdout
);
238 perf_session__fprintf(session
, stdout
);
241 perf_session__fprintf_dsos(session
, stdout
);
243 total_nr_samples
= 0;
244 list_for_each_entry(pos
, &session
->evlist
->entries
, node
) {
245 struct hists
*hists
= &pos
->hists
;
246 u32 nr_samples
= hists
->stats
.nr_events
[PERF_RECORD_SAMPLE
];
248 if (nr_samples
> 0) {
249 total_nr_samples
+= nr_samples
;
250 hists__collapse_resort(hists
, NULL
);
251 hists__output_resort(hists
);
253 if (symbol_conf
.event_group
&&
254 !perf_evsel__is_group_leader(pos
))
257 hists__find_annotations(hists
, pos
, ann
);
261 if (total_nr_samples
== 0) {
262 ui__error("The %s file has no samples!\n", file
.path
);
266 if (use_browser
== 2) {
267 void (*show_annotations
)(void);
269 show_annotations
= dlsym(perf_gtk_handle
,
270 "perf_gtk__show_annotations");
271 if (show_annotations
== NULL
) {
272 ui__error("GTK browser not found!\n");
280 * Speed up the exit process, for large files this can
281 * take quite a while.
283 * XXX Enable this when using valgrind or if we ever
284 * librarize this command.
286 * Also experiment with obstacks to see how much speed
289 * perf_session__delete(session);
294 static const char * const annotate_usage
[] = {
295 "perf annotate [<options>]",
299 int cmd_annotate(int argc
, const char **argv
, const char *prefix __maybe_unused
)
301 struct perf_annotate annotate
= {
303 .sample
= process_sample_event
,
304 .mmap
= perf_event__process_mmap
,
305 .mmap2
= perf_event__process_mmap2
,
306 .comm
= perf_event__process_comm
,
307 .exit
= perf_event__process_exit
,
308 .fork
= perf_event__process_fork
,
309 .ordered_samples
= true,
310 .ordering_requires_timestamps
= true,
313 const struct option options
[] = {
314 OPT_STRING('i', "input", &input_name
, "file",
316 OPT_STRING('d', "dsos", &symbol_conf
.dso_list_str
, "dso[,dso...]",
317 "only consider symbols in these dsos"),
318 OPT_STRING('s', "symbol", &annotate
.sym_hist_filter
, "symbol",
319 "symbol to annotate"),
320 OPT_BOOLEAN('f', "force", &annotate
.force
, "don't complain, do it"),
321 OPT_INCR('v', "verbose", &verbose
,
322 "be more verbose (show symbol address, etc)"),
323 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace
,
324 "dump raw trace in ASCII"),
325 OPT_BOOLEAN(0, "gtk", &annotate
.use_gtk
, "Use the GTK interface"),
326 OPT_BOOLEAN(0, "tui", &annotate
.use_tui
, "Use the TUI interface"),
327 OPT_BOOLEAN(0, "stdio", &annotate
.use_stdio
, "Use the stdio interface"),
328 OPT_STRING('k', "vmlinux", &symbol_conf
.vmlinux_name
,
329 "file", "vmlinux pathname"),
330 OPT_BOOLEAN('m', "modules", &symbol_conf
.use_modules
,
331 "load module symbols - WARNING: use only with -k and LIVE kernel"),
332 OPT_BOOLEAN('l', "print-line", &annotate
.print_line
,
333 "print matching source lines (may be slow)"),
334 OPT_BOOLEAN('P', "full-paths", &annotate
.full_paths
,
335 "Don't shorten the displayed pathnames"),
336 OPT_BOOLEAN(0, "skip-missing", &annotate
.skip_missing
,
337 "Skip symbols that cannot be annotated"),
338 OPT_STRING('C', "cpu", &annotate
.cpu_list
, "cpu", "list of cpus to profile"),
339 OPT_STRING(0, "symfs", &symbol_conf
.symfs
, "directory",
340 "Look for files with symbols relative to this directory"),
341 OPT_BOOLEAN(0, "source", &symbol_conf
.annotate_src
,
342 "Interleave source code with assembly code (default)"),
343 OPT_BOOLEAN(0, "asm-raw", &symbol_conf
.annotate_asm_raw
,
344 "Display raw encoding of assembly instructions (default)"),
345 OPT_STRING('M', "disassembler-style", &disassembler_style
, "disassembler style",
346 "Specify disassembler style (e.g. -M intel for intel syntax)"),
347 OPT_STRING(0, "objdump", &objdump_path
, "path",
348 "objdump binary to use for disassembly and annotations"),
349 OPT_BOOLEAN(0, "group", &symbol_conf
.event_group
,
350 "Show event group information together"),
354 argc
= parse_options(argc
, argv
, options
, annotate_usage
, 0);
356 if (annotate
.use_stdio
)
358 else if (annotate
.use_tui
)
360 else if (annotate
.use_gtk
)
365 symbol_conf
.priv_size
= sizeof(struct annotation
);
366 symbol_conf
.try_vmlinux_path
= true;
368 if (symbol__init() < 0)
371 if (setup_sorting() < 0)
372 usage_with_options(annotate_usage
, options
);
376 * Special case: if there's an argument left then assume tha
377 * it's a symbol filter:
380 usage_with_options(annotate_usage
, options
);
382 annotate
.sym_hist_filter
= argv
[0];
385 return __cmd_annotate(&annotate
);