Commit | Line | Data |
---|---|---|
8035e428 IM |
1 | /* |
2 | * builtin-annotate.c | |
3 | * | |
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. | |
7 | */ | |
8 | #include "builtin.h" | |
9 | ||
78f7defe | 10 | #include "util/util.h" |
8035e428 | 11 | #include "util/color.h" |
5da50258 | 12 | #include <linux/list.h> |
8035e428 | 13 | #include "util/cache.h" |
43cbcd8a | 14 | #include <linux/rbtree.h> |
8035e428 | 15 | #include "util/symbol.h" |
8035e428 IM |
16 | |
17 | #include "perf.h" | |
8f28827a | 18 | #include "util/debug.h" |
8035e428 | 19 | |
e248de33 ACM |
20 | #include "util/evlist.h" |
21 | #include "util/evsel.h" | |
78f7defe | 22 | #include "util/annotate.h" |
62daacb5 | 23 | #include "util/event.h" |
8035e428 IM |
24 | #include "util/parse-options.h" |
25 | #include "util/parse-events.h" | |
6baa0a5a | 26 | #include "util/thread.h" |
dd68ada2 | 27 | #include "util/sort.h" |
3d1d07ec | 28 | #include "util/hist.h" |
94c744b6 | 29 | #include "util/session.h" |
45694aa7 | 30 | #include "util/tool.h" |
f5fc1412 | 31 | #include "util/data.h" |
68e94f4e | 32 | #include "arch/common.h" |
8035e428 | 33 | |
fc67297b | 34 | #include <dlfcn.h> |
5d67be97 AB |
35 | #include <linux/bitmap.h> |
36 | ||
d20deb64 | 37 | struct perf_annotate { |
45694aa7 | 38 | struct perf_tool tool; |
fa10f316 NK |
39 | struct perf_session *session; |
40 | bool use_tui, use_stdio, use_gtk; | |
7009cc34 ACM |
41 | bool full_paths; |
42 | bool print_line; | |
18c9e5c5 | 43 | bool skip_missing; |
7009cc34 ACM |
44 | const char *sym_hist_filter; |
45 | const char *cpu_list; | |
46 | DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS); | |
d20deb64 | 47 | }; |
5d67be97 | 48 | |
d04b35f8 | 49 | static int perf_evsel__add_sample(struct perf_evsel *evsel, |
820bc81f | 50 | struct perf_sample *sample __maybe_unused, |
d20deb64 ACM |
51 | struct addr_location *al, |
52 | struct perf_annotate *ann) | |
8035e428 | 53 | { |
4ea062ed | 54 | struct hists *hists = evsel__hists(evsel); |
628ada0c | 55 | struct hist_entry *he; |
e248de33 | 56 | int ret; |
628ada0c | 57 | |
7009cc34 ACM |
58 | if (ann->sym_hist_filter != NULL && |
59 | (al->sym == NULL || | |
60 | strcmp(ann->sym_hist_filter, al->sym->name) != 0)) { | |
628ada0c | 61 | /* We're only interested in a symbol named sym_hist_filter */ |
facf3f06 ACM |
62 | /* |
63 | * FIXME: why isn't this done in the symbol_filter when loading | |
64 | * the DSO? | |
65 | */ | |
628ada0c ACM |
66 | if (al->sym != NULL) { |
67 | rb_erase(&al->sym->rb_node, | |
68 | &al->map->dso->symbols[al->map->type]); | |
69 | symbol__delete(al->sym); | |
c0b4dffb | 70 | dso__reset_find_symbol_cache(al->map->dso); |
628ada0c ACM |
71 | } |
72 | return 0; | |
73 | } | |
74 | ||
4ea062ed | 75 | he = __hists__add_entry(hists, al, NULL, NULL, NULL, 1, 1, 0, true); |
9735abf1 | 76 | if (he == NULL) |
8035e428 | 77 | return -ENOMEM; |
628ada0c | 78 | |
00e55218 | 79 | ret = hist_entry__inc_addr_samples(he, evsel->idx, al->addr); |
4ea062ed | 80 | hists__inc_nr_samples(hists, true); |
e248de33 | 81 | return ret; |
8035e428 IM |
82 | } |
83 | ||
45694aa7 | 84 | static int process_sample_event(struct perf_tool *tool, |
d20deb64 | 85 | union perf_event *event, |
8115d60c | 86 | struct perf_sample *sample, |
9e69c210 | 87 | struct perf_evsel *evsel, |
743eb868 | 88 | struct machine *machine) |
8035e428 | 89 | { |
45694aa7 | 90 | struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool); |
1ed091c4 | 91 | struct addr_location al; |
b91fc39f | 92 | int ret = 0; |
6baa0a5a | 93 | |
e44baa3e | 94 | if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) { |
29a9f66d ACM |
95 | pr_warning("problem processing %d event, skipping it.\n", |
96 | event->header.type); | |
8035e428 IM |
97 | return -1; |
98 | } | |
99 | ||
7009cc34 | 100 | if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap)) |
b91fc39f | 101 | goto out_put; |
5d67be97 | 102 | |
d20deb64 | 103 | if (!al.filtered && perf_evsel__add_sample(evsel, sample, &al, ann)) { |
29a9f66d ACM |
104 | pr_warning("problem incrementing symbol count, " |
105 | "skipping event\n"); | |
b91fc39f | 106 | ret = -1; |
8035e428 | 107 | } |
b91fc39f ACM |
108 | out_put: |
109 | addr_location__put(&al); | |
110 | return ret; | |
8035e428 IM |
111 | } |
112 | ||
db8fd07a NK |
113 | static int hist_entry__tty_annotate(struct hist_entry *he, |
114 | struct perf_evsel *evsel, | |
d20deb64 | 115 | struct perf_annotate *ann) |
0b73da3f | 116 | { |
db8fd07a | 117 | return symbol__tty_annotate(he->ms.sym, he->ms.map, evsel, |
7009cc34 | 118 | ann->print_line, ann->full_paths, 0, 0); |
0b73da3f IM |
119 | } |
120 | ||
c824c433 | 121 | static void hists__find_annotations(struct hists *hists, |
db8fd07a | 122 | struct perf_evsel *evsel, |
d20deb64 | 123 | struct perf_annotate *ann) |
0b73da3f | 124 | { |
c824c433 | 125 | struct rb_node *nd = rb_first(&hists->entries), *next; |
cf958003 | 126 | int key = K_RIGHT; |
0b73da3f | 127 | |
46e3e055 | 128 | while (nd) { |
ed52ce2e | 129 | struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node); |
78f7defe | 130 | struct annotation *notes; |
0b73da3f | 131 | |
46e3e055 ACM |
132 | if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned) |
133 | goto find_next; | |
0b73da3f | 134 | |
78f7defe | 135 | notes = symbol__annotation(he->ms.sym); |
ce6f4fab | 136 | if (notes->src == NULL) { |
46e3e055 | 137 | find_next: |
cf958003 | 138 | if (key == K_LEFT) |
46e3e055 ACM |
139 | nd = rb_prev(nd); |
140 | else | |
141 | nd = rb_next(nd); | |
e4204992 | 142 | continue; |
46e3e055 | 143 | } |
e4204992 | 144 | |
2b676bf0 | 145 | if (use_browser == 2) { |
18c9e5c5 | 146 | int ret; |
fc67297b NK |
147 | int (*annotate)(struct hist_entry *he, |
148 | struct perf_evsel *evsel, | |
149 | struct hist_browser_timer *hbt); | |
150 | ||
151 | annotate = dlsym(perf_gtk_handle, | |
152 | "hist_entry__gtk_annotate"); | |
153 | if (annotate == NULL) { | |
154 | ui__error("GTK browser not found!\n"); | |
155 | return; | |
156 | } | |
18c9e5c5 | 157 | |
fc67297b | 158 | ret = annotate(he, evsel, NULL); |
18c9e5c5 NK |
159 | if (!ret || !ann->skip_missing) |
160 | return; | |
161 | ||
162 | /* skip missing symbols */ | |
163 | nd = rb_next(nd); | |
2b676bf0 | 164 | } else if (use_browser == 1) { |
db8fd07a | 165 | key = hist_entry__tui_annotate(he, evsel, NULL); |
46e3e055 | 166 | switch (key) { |
18c9e5c5 NK |
167 | case -1: |
168 | if (!ann->skip_missing) | |
169 | return; | |
170 | /* fall through */ | |
cf958003 | 171 | case K_RIGHT: |
b50e003d | 172 | next = rb_next(nd); |
46e3e055 | 173 | break; |
cf958003 | 174 | case K_LEFT: |
b50e003d | 175 | next = rb_prev(nd); |
46e3e055 | 176 | break; |
b50e003d ACM |
177 | default: |
178 | return; | |
46e3e055 | 179 | } |
b50e003d ACM |
180 | |
181 | if (next != NULL) | |
182 | nd = next; | |
46e3e055 | 183 | } else { |
db8fd07a | 184 | hist_entry__tty_annotate(he, evsel, ann); |
46e3e055 ACM |
185 | nd = rb_next(nd); |
186 | /* | |
187 | * Since we have a hist_entry per IP for the same | |
ce6f4fab | 188 | * symbol, free he->ms.sym->src to signal we already |
46e3e055 ACM |
189 | * processed this symbol. |
190 | */ | |
d4957633 | 191 | zfree(¬es->src->cycles_hist); |
04662523 | 192 | zfree(¬es->src); |
46e3e055 | 193 | } |
0b73da3f | 194 | } |
0b73da3f IM |
195 | } |
196 | ||
d20deb64 | 197 | static int __cmd_annotate(struct perf_annotate *ann) |
8035e428 | 198 | { |
bab81b62 | 199 | int ret; |
fa10f316 | 200 | struct perf_session *session = ann->session; |
e248de33 ACM |
201 | struct perf_evsel *pos; |
202 | u64 total_nr_samples; | |
94c744b6 | 203 | |
476d35c2 AH |
204 | machines__set_symbol_filter(&session->machines, symbol__annotate_init); |
205 | ||
7009cc34 ACM |
206 | if (ann->cpu_list) { |
207 | ret = perf_session__cpu_bitmap(session, ann->cpu_list, | |
208 | ann->cpu_bitmap); | |
5d67be97 | 209 | if (ret) |
fa10f316 | 210 | goto out; |
5d67be97 AB |
211 | } |
212 | ||
68e94f4e | 213 | if (!objdump_path) { |
eebd0bfc | 214 | ret = perf_env__lookup_objdump(&session->header.env); |
68e94f4e | 215 | if (ret) |
fa10f316 | 216 | goto out; |
68e94f4e IT |
217 | } |
218 | ||
b7b61cbe | 219 | ret = perf_session__process_events(session); |
bab81b62 | 220 | if (ret) |
fa10f316 | 221 | goto out; |
8035e428 | 222 | |
62daacb5 | 223 | if (dump_trace) { |
c8446b9b | 224 | perf_session__fprintf_nr_events(session, stdout); |
2a1731fb | 225 | perf_evlist__fprintf_nr_events(session->evlist, stdout); |
fa10f316 | 226 | goto out; |
62daacb5 | 227 | } |
8035e428 | 228 | |
da21d1b5 | 229 | if (verbose > 3) |
b3165f41 | 230 | perf_session__fprintf(session, stdout); |
8035e428 | 231 | |
da21d1b5 | 232 | if (verbose > 2) |
cbf69680 | 233 | perf_session__fprintf_dsos(session, stdout); |
8035e428 | 234 | |
e248de33 | 235 | total_nr_samples = 0; |
0050f7aa | 236 | evlist__for_each(session->evlist, pos) { |
4ea062ed | 237 | struct hists *hists = evsel__hists(pos); |
e248de33 ACM |
238 | u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE]; |
239 | ||
240 | if (nr_samples > 0) { | |
241 | total_nr_samples += nr_samples; | |
c1fb5651 | 242 | hists__collapse_resort(hists, NULL); |
f9db0d0f KL |
243 | /* Don't sort callchain */ |
244 | perf_evsel__reset_sample_bit(pos, CALLCHAIN); | |
740b97f9 | 245 | hists__output_resort(hists, NULL); |
b1dd4432 NK |
246 | |
247 | if (symbol_conf.event_group && | |
248 | !perf_evsel__is_group_leader(pos)) | |
249 | continue; | |
250 | ||
db8fd07a | 251 | hists__find_annotations(hists, pos, ann); |
e248de33 ACM |
252 | } |
253 | } | |
8035e428 | 254 | |
e248de33 | 255 | if (total_nr_samples == 0) { |
fa10f316 NK |
256 | ui__error("The %s file has no samples!\n", session->file->path); |
257 | goto out; | |
e248de33 | 258 | } |
7a60ba94 | 259 | |
fc67297b NK |
260 | if (use_browser == 2) { |
261 | void (*show_annotations)(void); | |
262 | ||
263 | show_annotations = dlsym(perf_gtk_handle, | |
264 | "perf_gtk__show_annotations"); | |
265 | if (show_annotations == NULL) { | |
266 | ui__error("GTK browser not found!\n"); | |
fa10f316 | 267 | goto out; |
fc67297b NK |
268 | } |
269 | show_annotations(); | |
270 | } | |
7a60ba94 | 271 | |
fa10f316 | 272 | out: |
bab81b62 | 273 | return ret; |
8035e428 IM |
274 | } |
275 | ||
276 | static const char * const annotate_usage[] = { | |
99345254 | 277 | "perf annotate [<options>]", |
8035e428 IM |
278 | NULL |
279 | }; | |
280 | ||
1d037ca1 | 281 | int cmd_annotate(int argc, const char **argv, const char *prefix __maybe_unused) |
d20deb64 ACM |
282 | { |
283 | struct perf_annotate annotate = { | |
45694aa7 | 284 | .tool = { |
d20deb64 ACM |
285 | .sample = process_sample_event, |
286 | .mmap = perf_event__process_mmap, | |
5c5e854b | 287 | .mmap2 = perf_event__process_mmap2, |
d20deb64 | 288 | .comm = perf_event__process_comm, |
ec4622f5 | 289 | .exit = perf_event__process_exit, |
f62d3f0f | 290 | .fork = perf_event__process_fork, |
0a8cb85c | 291 | .ordered_events = true, |
d20deb64 ACM |
292 | .ordering_requires_timestamps = true, |
293 | }, | |
d20deb64 | 294 | }; |
fa10f316 | 295 | struct perf_data_file file = { |
fa10f316 NK |
296 | .mode = PERF_DATA_MODE_READ, |
297 | }; | |
d20deb64 | 298 | const struct option options[] = { |
70cb4e96 | 299 | OPT_STRING('i', "input", &input_name, "file", |
8035e428 | 300 | "input file name"), |
ac73c5a9 ACM |
301 | OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]", |
302 | "only consider symbols in these dsos"), | |
7009cc34 | 303 | OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol", |
0b73da3f | 304 | "symbol to annotate"), |
fa10f316 | 305 | OPT_BOOLEAN('f', "force", &file.force, "don't complain, do it"), |
c0555642 | 306 | OPT_INCR('v', "verbose", &verbose, |
8035e428 IM |
307 | "be more verbose (show symbol address, etc)"), |
308 | OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, | |
309 | "dump raw trace in ASCII"), | |
2b676bf0 | 310 | OPT_BOOLEAN(0, "gtk", &annotate.use_gtk, "Use the GTK interface"), |
7009cc34 ACM |
311 | OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"), |
312 | OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"), | |
b32d133a ACM |
313 | OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, |
314 | "file", "vmlinux pathname"), | |
315 | OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules, | |
42976487 | 316 | "load module symbols - WARNING: use only with -k and LIVE kernel"), |
7009cc34 | 317 | OPT_BOOLEAN('l', "print-line", &annotate.print_line, |
301406b9 | 318 | "print matching source lines (may be slow)"), |
7009cc34 | 319 | OPT_BOOLEAN('P', "full-paths", &annotate.full_paths, |
42976487 | 320 | "Don't shorten the displayed pathnames"), |
18c9e5c5 NK |
321 | OPT_BOOLEAN(0, "skip-missing", &annotate.skip_missing, |
322 | "Skip symbols that cannot be annotated"), | |
c8e66720 | 323 | OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"), |
e71a0598 SE |
324 | OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory", |
325 | "Look for files with symbols relative to this directory"), | |
64c6f0c7 | 326 | OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src, |
3e6a2a7f | 327 | "Interleave source code with assembly code (default)"), |
64c6f0c7 | 328 | OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw, |
3e6a2a7f | 329 | "Display raw encoding of assembly instructions (default)"), |
f69b64f7 AK |
330 | OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style", |
331 | "Specify disassembler style (e.g. -M intel for intel syntax)"), | |
7a4ec938 MB |
332 | OPT_STRING(0, "objdump", &objdump_path, "path", |
333 | "objdump binary to use for disassembly and annotations"), | |
b1dd4432 NK |
334 | OPT_BOOLEAN(0, "group", &symbol_conf.event_group, |
335 | "Show event group information together"), | |
0c4a5bce ML |
336 | OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period, |
337 | "Show a column with the sum of periods"), | |
8035e428 | 338 | OPT_END() |
d20deb64 | 339 | }; |
a635fc51 ACM |
340 | int ret = hists__init(); |
341 | ||
342 | if (ret < 0) | |
343 | return ret; | |
8035e428 | 344 | |
655000e7 ACM |
345 | argc = parse_options(argc, argv, options, annotate_usage, 0); |
346 | ||
7009cc34 | 347 | if (annotate.use_stdio) |
8b9e74eb | 348 | use_browser = 0; |
7009cc34 | 349 | else if (annotate.use_tui) |
8b9e74eb | 350 | use_browser = 1; |
2b676bf0 NK |
351 | else if (annotate.use_gtk) |
352 | use_browser = 2; | |
8b9e74eb | 353 | |
44848cdb ML |
354 | file.path = input_name; |
355 | ||
229ade9b | 356 | setup_browser(true); |
46e3e055 | 357 | |
fa10f316 NK |
358 | annotate.session = perf_session__new(&file, false, &annotate.tool); |
359 | if (annotate.session == NULL) | |
52e02834 | 360 | return -1; |
fa10f316 | 361 | |
78f7defe | 362 | symbol_conf.priv_size = sizeof(struct annotation); |
75be6cf4 ACM |
363 | symbol_conf.try_vmlinux_path = true; |
364 | ||
0a7e6d1b | 365 | ret = symbol__init(&annotate.session->header.env); |
fa10f316 NK |
366 | if (ret < 0) |
367 | goto out_delete; | |
8035e428 | 368 | |
55309985 NK |
369 | if (setup_sorting() < 0) |
370 | usage_with_options(annotate_usage, options); | |
8035e428 | 371 | |
0b73da3f IM |
372 | if (argc) { |
373 | /* | |
6f1d0c86 | 374 | * Special case: if there's an argument left then assume that |
0b73da3f IM |
375 | * it's a symbol filter: |
376 | */ | |
377 | if (argc > 1) | |
378 | usage_with_options(annotate_usage, options); | |
379 | ||
7009cc34 | 380 | annotate.sym_hist_filter = argv[0]; |
0b73da3f IM |
381 | } |
382 | ||
fa10f316 NK |
383 | ret = __cmd_annotate(&annotate); |
384 | ||
385 | out_delete: | |
386 | /* | |
387 | * Speed up the exit process, for large files this can | |
388 | * take quite a while. | |
389 | * | |
390 | * XXX Enable this when using valgrind or if we ever | |
391 | * librarize this command. | |
392 | * | |
393 | * Also experiment with obstacks to see how much speed | |
394 | * up we'll get here. | |
395 | * | |
396 | * perf_session__delete(session); | |
397 | */ | |
398 | return ret; | |
8035e428 | 399 | } |