Commit | Line | Data |
---|---|---|
b2441318 | 1 | // SPDX-License-Identifier: GPL-2.0 |
8035e428 IM |
2 | /* |
3 | * builtin-annotate.c | |
4 | * | |
5 | * Builtin annotate command: Analyze the perf.data input file, | |
6 | * look up and read DSOs and symbol information and display | |
7 | * a histogram of results, along various sorting keys. | |
8 | */ | |
9 | #include "builtin.h" | |
10 | ||
8035e428 | 11 | #include "util/color.h" |
5da50258 | 12 | #include <linux/list.h> |
8035e428 | 13 | #include "util/cache.h" |
43cbcd8a | 14 | #include <linux/rbtree.h> |
7f7c536f | 15 | #include <linux/zalloc.h> |
8035e428 | 16 | #include "util/symbol.h" |
8035e428 | 17 | |
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" |
263925bf | 23 | #include "util/annotate-data.h" |
62daacb5 | 24 | #include "util/event.h" |
4b6ab94e | 25 | #include <subcmd/parse-options.h> |
8035e428 | 26 | #include "util/parse-events.h" |
dd68ada2 | 27 | #include "util/sort.h" |
3d1d07ec | 28 | #include "util/hist.h" |
4a3cec84 | 29 | #include "util/dso.h" |
3f79132a | 30 | #include "util/machine.h" |
1101f69a | 31 | #include "util/map.h" |
94c744b6 | 32 | #include "util/session.h" |
45694aa7 | 33 | #include "util/tool.h" |
f5fc1412 | 34 | #include "util/data.h" |
68e94f4e | 35 | #include "arch/common.h" |
70fbe057 | 36 | #include "util/block-range.h" |
d3300a3c ACM |
37 | #include "util/map_symbol.h" |
38 | #include "util/branch.h" | |
f12ad272 | 39 | #include "util/util.h" |
d9aedc12 | 40 | #include "ui/progress.h" |
8035e428 | 41 | |
fc67297b | 42 | #include <dlfcn.h> |
a43783ae | 43 | #include <errno.h> |
5d67be97 | 44 | #include <linux/bitmap.h> |
6ef81c55 | 45 | #include <linux/err.h> |
bdeaf6ff | 46 | #include <inttypes.h> |
5d67be97 | 47 | |
d20deb64 | 48 | struct perf_annotate { |
45694aa7 | 49 | struct perf_tool tool; |
fa10f316 | 50 | struct perf_session *session; |
3402ae0a IR |
51 | #ifdef HAVE_SLANG_SUPPORT |
52 | bool use_tui; | |
53 | #endif | |
54 | bool use_stdio, use_stdio2; | |
557cc18e | 55 | #ifdef HAVE_GTK2_SUPPORT |
3402ae0a | 56 | bool use_gtk; |
557cc18e | 57 | #endif |
18c9e5c5 | 58 | bool skip_missing; |
bb848c14 | 59 | bool has_br_stack; |
7ebaf489 | 60 | bool group_set; |
263925bf | 61 | bool data_type; |
61a9741e | 62 | bool type_stat; |
58824fa0 | 63 | bool insn_stat; |
cad10ce3 | 64 | float min_percent; |
7009cc34 ACM |
65 | const char *sym_hist_filter; |
66 | const char *cpu_list; | |
263925bf | 67 | const char *target_data_type; |
7009cc34 | 68 | DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS); |
d20deb64 | 69 | }; |
5d67be97 | 70 | |
70fbe057 PZ |
71 | /* |
72 | * Given one basic block: | |
73 | * | |
74 | * from to branch_i | |
75 | * * ----> * | |
76 | * | | |
77 | * | block | |
78 | * v | |
79 | * * ----> * | |
80 | * from to branch_i+1 | |
81 | * | |
82 | * where the horizontal are the branches and the vertical is the executed | |
83 | * block of instructions. | |
84 | * | |
85 | * We count, for each 'instruction', the number of blocks that covered it as | |
86 | * well as count the ratio each branch is taken. | |
87 | * | |
88 | * We can do this without knowing the actual instruction stream by keeping | |
89 | * track of the address ranges. We break down ranges such that there is no | |
90 | * overlap and iterate from the start until the end. | |
91 | * | |
92 | * @acme: once we parse the objdump output _before_ processing the samples, | |
93 | * we can easily fold the branch.cycles IPC bits in. | |
94 | */ | |
95 | static void process_basic_block(struct addr_map_symbol *start, | |
96 | struct addr_map_symbol *end, | |
97 | struct branch_flags *flags) | |
98 | { | |
d46a4cdf | 99 | struct symbol *sym = start->ms.sym; |
70fbe057 PZ |
100 | struct annotation *notes = sym ? symbol__annotation(sym) : NULL; |
101 | struct block_range_iter iter; | |
102 | struct block_range *entry; | |
2b215ec7 | 103 | struct annotated_branch *branch; |
70fbe057 PZ |
104 | |
105 | /* | |
106 | * Sanity; NULL isn't executable and the CPU cannot execute backwards | |
107 | */ | |
108 | if (!start->addr || start->addr > end->addr) | |
109 | return; | |
110 | ||
111 | iter = block_range__create(start->addr, end->addr); | |
112 | if (!block_range_iter__valid(&iter)) | |
113 | return; | |
114 | ||
2b215ec7 NK |
115 | branch = annotation__get_branch(notes); |
116 | ||
70fbe057 PZ |
117 | /* |
118 | * First block in range is a branch target. | |
119 | */ | |
120 | entry = block_range_iter(&iter); | |
121 | assert(entry->is_target); | |
122 | entry->entry++; | |
123 | ||
124 | do { | |
125 | entry = block_range_iter(&iter); | |
126 | ||
127 | entry->coverage++; | |
128 | entry->sym = sym; | |
129 | ||
2b215ec7 NK |
130 | if (branch) |
131 | branch->max_coverage = max(branch->max_coverage, entry->coverage); | |
70fbe057 PZ |
132 | |
133 | } while (block_range_iter__next(&iter)); | |
134 | ||
135 | /* | |
136 | * Last block in rage is a branch. | |
137 | */ | |
138 | entry = block_range_iter(&iter); | |
139 | assert(entry->is_branch); | |
140 | entry->taken++; | |
141 | if (flags->predicted) | |
142 | entry->pred++; | |
143 | } | |
144 | ||
145 | static void process_branch_stack(struct branch_stack *bs, struct addr_location *al, | |
146 | struct perf_sample *sample) | |
147 | { | |
148 | struct addr_map_symbol *prev = NULL; | |
149 | struct branch_info *bi; | |
150 | int i; | |
151 | ||
152 | if (!bs || !bs->nr) | |
153 | return; | |
154 | ||
155 | bi = sample__resolve_bstack(sample, al); | |
156 | if (!bi) | |
157 | return; | |
158 | ||
159 | for (i = bs->nr - 1; i >= 0; i--) { | |
160 | /* | |
161 | * XXX filter against symbol | |
162 | */ | |
163 | if (prev) | |
164 | process_basic_block(prev, &bi[i].from, &bi[i].flags); | |
165 | prev = &bi[i].to; | |
166 | } | |
167 | ||
168 | free(bi); | |
169 | } | |
170 | ||
bb848c14 JY |
171 | static int hist_iter__branch_callback(struct hist_entry_iter *iter, |
172 | struct addr_location *al __maybe_unused, | |
173 | bool single __maybe_unused, | |
174 | void *arg __maybe_unused) | |
175 | { | |
176 | struct hist_entry *he = iter->he; | |
177 | struct branch_info *bi; | |
178 | struct perf_sample *sample = iter->sample; | |
32dcd021 | 179 | struct evsel *evsel = iter->evsel; |
bb848c14 JY |
180 | int err; |
181 | ||
bb848c14 | 182 | bi = he->branch_info; |
e345f3bd | 183 | err = addr_map_symbol__inc_samples(&bi->from, sample, evsel); |
bb848c14 JY |
184 | |
185 | if (err) | |
186 | goto out; | |
187 | ||
e345f3bd | 188 | err = addr_map_symbol__inc_samples(&bi->to, sample, evsel); |
bb848c14 JY |
189 | |
190 | out: | |
191 | return err; | |
192 | } | |
193 | ||
32dcd021 | 194 | static int process_branch_callback(struct evsel *evsel, |
bb848c14 | 195 | struct perf_sample *sample, |
0dd5041c | 196 | struct addr_location *al, |
bb848c14 JY |
197 | struct perf_annotate *ann, |
198 | struct machine *machine) | |
199 | { | |
200 | struct hist_entry_iter iter = { | |
201 | .evsel = evsel, | |
202 | .sample = sample, | |
203 | .add_entry_cb = hist_iter__branch_callback, | |
204 | .hide_unresolved = symbol_conf.hide_unresolved, | |
205 | .ops = &hist_iter_branch, | |
206 | }; | |
bb848c14 | 207 | struct addr_location a; |
0dd5041c | 208 | int ret; |
bb848c14 | 209 | |
0dd5041c IR |
210 | addr_location__init(&a); |
211 | if (machine__resolve(machine, &a, sample) < 0) { | |
212 | ret = -1; | |
213 | goto out; | |
214 | } | |
bb848c14 | 215 | |
0dd5041c IR |
216 | if (a.sym == NULL) { |
217 | ret = 0; | |
218 | goto out; | |
219 | } | |
bb848c14 JY |
220 | |
221 | if (a.map != NULL) | |
ee756ef7 | 222 | dso__set_hit(map__dso(a.map)); |
bb848c14 | 223 | |
7841f40a | 224 | hist__account_cycles(sample->branch_stack, al, sample, false, NULL); |
bdd1666b | 225 | |
0dd5041c IR |
226 | ret = hist_entry_iter__add(&iter, &a, PERF_MAX_STACK_DEPTH, ann); |
227 | out: | |
228 | addr_location__exit(&a); | |
229 | return ret; | |
bb848c14 JY |
230 | } |
231 | ||
befd2a38 ACM |
232 | static bool has_annotation(struct perf_annotate *ann) |
233 | { | |
234 | return ui__has_annotation() || ann->use_stdio2; | |
235 | } | |
236 | ||
74aa90e8 ACM |
237 | static int evsel__add_sample(struct evsel *evsel, struct perf_sample *sample, |
238 | struct addr_location *al, struct perf_annotate *ann, | |
239 | struct machine *machine) | |
8035e428 | 240 | { |
4ea062ed | 241 | struct hists *hists = evsel__hists(evsel); |
628ada0c | 242 | struct hist_entry *he; |
e248de33 | 243 | int ret; |
628ada0c | 244 | |
befd2a38 | 245 | if ((!ann->has_br_stack || !has_annotation(ann)) && |
bb848c14 | 246 | ann->sym_hist_filter != NULL && |
7009cc34 ACM |
247 | (al->sym == NULL || |
248 | strcmp(ann->sym_hist_filter, al->sym->name) != 0)) { | |
628ada0c | 249 | /* We're only interested in a symbol named sym_hist_filter */ |
facf3f06 ACM |
250 | /* |
251 | * FIXME: why isn't this done in the symbol_filter when loading | |
252 | * the DSO? | |
253 | */ | |
628ada0c | 254 | if (al->sym != NULL) { |
63df0e4b IR |
255 | struct dso *dso = map__dso(al->map); |
256 | ||
ee756ef7 | 257 | rb_erase_cached(&al->sym->rb_node, dso__symbols(dso)); |
628ada0c | 258 | symbol__delete(al->sym); |
63df0e4b | 259 | dso__reset_find_symbol_cache(dso); |
628ada0c ACM |
260 | } |
261 | return 0; | |
262 | } | |
263 | ||
70fbe057 | 264 | /* |
4d39c89f | 265 | * XXX filtered samples can still have branch entries pointing into our |
70fbe057 PZ |
266 | * symbol and are missed. |
267 | */ | |
268 | process_branch_stack(sample->branch_stack, al, sample); | |
269 | ||
befd2a38 | 270 | if (ann->has_br_stack && has_annotation(ann)) |
bb848c14 JY |
271 | return process_branch_callback(evsel, sample, al, ann, machine); |
272 | ||
ebf39d29 | 273 | he = hists__add_entry(hists, al, NULL, NULL, NULL, NULL, sample, true); |
9735abf1 | 274 | if (he == NULL) |
8035e428 | 275 | return -ENOMEM; |
628ada0c | 276 | |
e345f3bd | 277 | ret = hist_entry__inc_addr_samples(he, sample, evsel, al->addr); |
4ea062ed | 278 | hists__inc_nr_samples(hists, true); |
e248de33 | 279 | return ret; |
8035e428 IM |
280 | } |
281 | ||
45694aa7 | 282 | static int process_sample_event(struct perf_tool *tool, |
d20deb64 | 283 | union perf_event *event, |
8115d60c | 284 | struct perf_sample *sample, |
32dcd021 | 285 | struct evsel *evsel, |
743eb868 | 286 | struct machine *machine) |
8035e428 | 287 | { |
45694aa7 | 288 | struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool); |
1ed091c4 | 289 | struct addr_location al; |
b91fc39f | 290 | int ret = 0; |
6baa0a5a | 291 | |
0dd5041c | 292 | addr_location__init(&al); |
bb3eb566 | 293 | if (machine__resolve(machine, &al, sample) < 0) { |
29a9f66d ACM |
294 | pr_warning("problem processing %d event, skipping it.\n", |
295 | event->header.type); | |
0dd5041c IR |
296 | ret = -1; |
297 | goto out_put; | |
8035e428 IM |
298 | } |
299 | ||
7009cc34 | 300 | if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap)) |
b91fc39f | 301 | goto out_put; |
5d67be97 | 302 | |
bb848c14 | 303 | if (!al.filtered && |
74aa90e8 | 304 | evsel__add_sample(evsel, sample, &al, ann, machine)) { |
29a9f66d ACM |
305 | pr_warning("problem incrementing symbol count, " |
306 | "skipping event\n"); | |
b91fc39f | 307 | ret = -1; |
8035e428 | 308 | } |
b91fc39f | 309 | out_put: |
0dd5041c | 310 | addr_location__exit(&al); |
b91fc39f | 311 | return ret; |
8035e428 IM |
312 | } |
313 | ||
89f1688a JO |
314 | static int process_feature_event(struct perf_session *session, |
315 | union perf_event *event) | |
92ead7ee RB |
316 | { |
317 | if (event->feat.feat_id < HEADER_LAST_FEATURE) | |
89f1688a | 318 | return perf_event__process_feature(session, event); |
92ead7ee RB |
319 | return 0; |
320 | } | |
321 | ||
db8fd07a | 322 | static int hist_entry__tty_annotate(struct hist_entry *he, |
32dcd021 | 323 | struct evsel *evsel, |
d20deb64 | 324 | struct perf_annotate *ann) |
0b73da3f | 325 | { |
befd2a38 | 326 | if (!ann->use_stdio2) |
41fd3cac | 327 | return symbol__tty_annotate(&he->ms, evsel); |
982d410b | 328 | |
41fd3cac | 329 | return symbol__tty_annotate2(&he->ms, evsel); |
0b73da3f IM |
330 | } |
331 | ||
61a9741e NK |
332 | static void print_annotate_data_stat(struct annotated_data_stat *s) |
333 | { | |
334 | #define PRINT_STAT(fld) if (s->fld) printf("%10d : %s\n", s->fld, #fld) | |
335 | ||
336 | int bad = s->no_sym + | |
337 | s->no_insn + | |
338 | s->no_insn_ops + | |
339 | s->no_mem_ops + | |
340 | s->no_reg + | |
341 | s->no_dbginfo + | |
342 | s->no_cuinfo + | |
343 | s->no_var + | |
344 | s->no_typeinfo + | |
345 | s->invalid_size + | |
346 | s->bad_offset; | |
347 | int ok = s->total - bad; | |
348 | ||
349 | printf("Annotate data type stats:\n"); | |
350 | printf("total %d, ok %d (%.1f%%), bad %d (%.1f%%)\n", | |
351 | s->total, ok, 100.0 * ok / (s->total ?: 1), bad, 100.0 * bad / (s->total ?: 1)); | |
352 | printf("-----------------------------------------------------------\n"); | |
353 | PRINT_STAT(no_sym); | |
354 | PRINT_STAT(no_insn); | |
355 | PRINT_STAT(no_insn_ops); | |
356 | PRINT_STAT(no_mem_ops); | |
357 | PRINT_STAT(no_reg); | |
358 | PRINT_STAT(no_dbginfo); | |
359 | PRINT_STAT(no_cuinfo); | |
360 | PRINT_STAT(no_var); | |
361 | PRINT_STAT(no_typeinfo); | |
362 | PRINT_STAT(invalid_size); | |
363 | PRINT_STAT(bad_offset); | |
eb8a55e0 | 364 | PRINT_STAT(insn_track); |
61a9741e NK |
365 | printf("\n"); |
366 | ||
367 | #undef PRINT_STAT | |
368 | } | |
369 | ||
58824fa0 NK |
370 | static void print_annotate_item_stat(struct list_head *head, const char *title) |
371 | { | |
372 | struct annotated_item_stat *istat, *pos, *iter; | |
373 | int total_good, total_bad, total; | |
374 | int sum1, sum2; | |
375 | LIST_HEAD(tmp); | |
376 | ||
377 | /* sort the list by count */ | |
378 | list_splice_init(head, &tmp); | |
379 | total_good = total_bad = 0; | |
380 | ||
381 | list_for_each_entry_safe(istat, pos, &tmp, list) { | |
382 | total_good += istat->good; | |
383 | total_bad += istat->bad; | |
384 | sum1 = istat->good + istat->bad; | |
385 | ||
386 | list_for_each_entry(iter, head, list) { | |
387 | sum2 = iter->good + iter->bad; | |
388 | if (sum1 > sum2) | |
389 | break; | |
390 | } | |
391 | list_move_tail(&istat->list, &iter->list); | |
392 | } | |
393 | total = total_good + total_bad; | |
394 | ||
395 | printf("Annotate %s stats\n", title); | |
396 | printf("total %d, ok %d (%.1f%%), bad %d (%.1f%%)\n\n", total, | |
397 | total_good, 100.0 * total_good / (total ?: 1), | |
398 | total_bad, 100.0 * total_bad / (total ?: 1)); | |
399 | printf(" %-10s: %5s %5s\n", "Name", "Good", "Bad"); | |
400 | printf("-----------------------------------------------------------\n"); | |
401 | list_for_each_entry(istat, head, list) | |
402 | printf(" %-10s: %5d %5d\n", istat->name, istat->good, istat->bad); | |
403 | printf("\n"); | |
404 | } | |
405 | ||
c824c433 | 406 | static void hists__find_annotations(struct hists *hists, |
32dcd021 | 407 | struct evsel *evsel, |
d20deb64 | 408 | struct perf_annotate *ann) |
0b73da3f | 409 | { |
2eb3d689 | 410 | struct rb_node *nd = rb_first_cached(&hists->entries), *next; |
cf958003 | 411 | int key = K_RIGHT; |
0b73da3f | 412 | |
61a9741e NK |
413 | if (ann->type_stat) |
414 | print_annotate_data_stat(&ann_data_stat); | |
58824fa0 NK |
415 | if (ann->insn_stat) |
416 | print_annotate_item_stat(&ann_insn_stat, "Instruction"); | |
61a9741e | 417 | |
46e3e055 | 418 | while (nd) { |
ed52ce2e | 419 | struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node); |
78f7defe | 420 | struct annotation *notes; |
0b73da3f | 421 | |
ee756ef7 | 422 | if (he->ms.sym == NULL || dso__annotate_warned(map__dso(he->ms.map))) |
46e3e055 | 423 | goto find_next; |
0b73da3f | 424 | |
bb848c14 JY |
425 | if (ann->sym_hist_filter && |
426 | (strcmp(he->ms.sym->name, ann->sym_hist_filter) != 0)) | |
427 | goto find_next; | |
428 | ||
cad10ce3 NK |
429 | if (ann->min_percent) { |
430 | float percent = 0; | |
431 | u64 total = hists__total_period(hists); | |
432 | ||
433 | if (total) | |
434 | percent = 100.0 * he->stat.period / total; | |
435 | ||
436 | if (percent < ann->min_percent) | |
437 | goto find_next; | |
438 | } | |
439 | ||
78f7defe | 440 | notes = symbol__annotation(he->ms.sym); |
ce6f4fab | 441 | if (notes->src == NULL) { |
46e3e055 | 442 | find_next: |
6d491b37 | 443 | if (key == K_LEFT || key == '<') |
46e3e055 ACM |
444 | nd = rb_prev(nd); |
445 | else | |
446 | nd = rb_next(nd); | |
e4204992 | 447 | continue; |
46e3e055 | 448 | } |
e4204992 | 449 | |
263925bf | 450 | if (ann->data_type) { |
263925bf NK |
451 | /* skip unknown type */ |
452 | if (he->mem_type->histograms == NULL) | |
453 | goto find_next; | |
454 | ||
455 | if (ann->target_data_type) { | |
456 | const char *type_name = he->mem_type->self.type_name; | |
457 | ||
458 | /* skip 'struct ' prefix in the type name */ | |
459 | if (strncmp(ann->target_data_type, "struct ", 7) && | |
460 | !strncmp(type_name, "struct ", 7)) | |
461 | type_name += 7; | |
462 | ||
463 | /* skip 'union ' prefix in the type name */ | |
464 | if (strncmp(ann->target_data_type, "union ", 6) && | |
465 | !strncmp(type_name, "union ", 6)) | |
466 | type_name += 6; | |
467 | ||
468 | if (strcmp(ann->target_data_type, type_name)) | |
469 | goto find_next; | |
470 | } | |
471 | ||
d001c7a7 NK |
472 | if (use_browser == 1) |
473 | key = hist_entry__annotate_data_tui(he, evsel, NULL); | |
474 | else | |
475 | key = hist_entry__annotate_data_tty(he, evsel); | |
476 | ||
477 | switch (key) { | |
478 | case -1: | |
479 | if (!ann->skip_missing) | |
480 | return; | |
481 | /* fall through */ | |
482 | case K_RIGHT: | |
483 | case '>': | |
484 | next = rb_next(nd); | |
485 | break; | |
486 | case K_LEFT: | |
487 | case '<': | |
488 | next = rb_prev(nd); | |
489 | break; | |
490 | default: | |
491 | return; | |
492 | } | |
493 | ||
2b87383c | 494 | if (use_browser == 0 || next != NULL) |
d001c7a7 NK |
495 | nd = next; |
496 | ||
497 | continue; | |
263925bf NK |
498 | } |
499 | ||
2b676bf0 | 500 | if (use_browser == 2) { |
18c9e5c5 | 501 | int ret; |
fc67297b | 502 | int (*annotate)(struct hist_entry *he, |
32dcd021 | 503 | struct evsel *evsel, |
fc67297b NK |
504 | struct hist_browser_timer *hbt); |
505 | ||
506 | annotate = dlsym(perf_gtk_handle, | |
507 | "hist_entry__gtk_annotate"); | |
508 | if (annotate == NULL) { | |
509 | ui__error("GTK browser not found!\n"); | |
510 | return; | |
511 | } | |
18c9e5c5 | 512 | |
41fd3cac | 513 | ret = annotate(he, evsel, NULL); |
18c9e5c5 NK |
514 | if (!ret || !ann->skip_missing) |
515 | return; | |
516 | ||
517 | /* skip missing symbols */ | |
518 | nd = rb_next(nd); | |
2b676bf0 | 519 | } else if (use_browser == 1) { |
22197fb2 | 520 | key = hist_entry__tui_annotate(he, evsel, NULL); |
bb848c14 | 521 | |
46e3e055 | 522 | switch (key) { |
18c9e5c5 NK |
523 | case -1: |
524 | if (!ann->skip_missing) | |
525 | return; | |
526 | /* fall through */ | |
cf958003 | 527 | case K_RIGHT: |
6d491b37 | 528 | case '>': |
b50e003d | 529 | next = rb_next(nd); |
46e3e055 | 530 | break; |
cf958003 | 531 | case K_LEFT: |
6d491b37 | 532 | case '<': |
b50e003d | 533 | next = rb_prev(nd); |
46e3e055 | 534 | break; |
b50e003d ACM |
535 | default: |
536 | return; | |
46e3e055 | 537 | } |
b50e003d ACM |
538 | |
539 | if (next != NULL) | |
540 | nd = next; | |
46e3e055 | 541 | } else { |
db8fd07a | 542 | hist_entry__tty_annotate(he, evsel, ann); |
46e3e055 | 543 | nd = rb_next(nd); |
46e3e055 | 544 | } |
0b73da3f | 545 | } |
0b73da3f IM |
546 | } |
547 | ||
d20deb64 | 548 | static int __cmd_annotate(struct perf_annotate *ann) |
8035e428 | 549 | { |
bab81b62 | 550 | int ret; |
fa10f316 | 551 | struct perf_session *session = ann->session; |
32dcd021 | 552 | struct evsel *pos; |
e248de33 | 553 | u64 total_nr_samples; |
94c744b6 | 554 | |
7009cc34 ACM |
555 | if (ann->cpu_list) { |
556 | ret = perf_session__cpu_bitmap(session, ann->cpu_list, | |
557 | ann->cpu_bitmap); | |
5d67be97 | 558 | if (ret) |
fa10f316 | 559 | goto out; |
5d67be97 AB |
560 | } |
561 | ||
9d03194a | 562 | if (!annotate_opts.objdump_path) { |
f178fd2d | 563 | ret = perf_env__lookup_objdump(&session->header.env, |
9d03194a | 564 | &annotate_opts.objdump_path); |
68e94f4e | 565 | if (ret) |
fa10f316 | 566 | goto out; |
68e94f4e IT |
567 | } |
568 | ||
b7b61cbe | 569 | ret = perf_session__process_events(session); |
bab81b62 | 570 | if (ret) |
fa10f316 | 571 | goto out; |
8035e428 | 572 | |
62daacb5 | 573 | if (dump_trace) { |
2775de0b NK |
574 | perf_session__fprintf_nr_events(session, stdout, false); |
575 | evlist__fprintf_nr_events(session->evlist, stdout, false); | |
fa10f316 | 576 | goto out; |
62daacb5 | 577 | } |
8035e428 | 578 | |
da21d1b5 | 579 | if (verbose > 3) |
b3165f41 | 580 | perf_session__fprintf(session, stdout); |
8035e428 | 581 | |
da21d1b5 | 582 | if (verbose > 2) |
cbf69680 | 583 | perf_session__fprintf_dsos(session, stdout); |
8035e428 | 584 | |
e248de33 | 585 | total_nr_samples = 0; |
e5cadb93 | 586 | evlist__for_each_entry(session->evlist, pos) { |
4ea062ed | 587 | struct hists *hists = evsel__hists(pos); |
0f0abbac | 588 | u32 nr_samples = hists->stats.nr_samples; |
d9aedc12 | 589 | struct ui_progress prog; |
e248de33 ACM |
590 | |
591 | if (nr_samples > 0) { | |
592 | total_nr_samples += nr_samples; | |
d9aedc12 NK |
593 | |
594 | ui_progress__init(&prog, nr_samples, | |
595 | "Merging related events..."); | |
596 | hists__collapse_resort(hists, &prog); | |
597 | ui_progress__finish(); | |
598 | ||
f9db0d0f | 599 | /* Don't sort callchain */ |
862b2f8f | 600 | evsel__reset_sample_bit(pos, CALLCHAIN); |
d9aedc12 NK |
601 | |
602 | ui_progress__init(&prog, nr_samples, | |
603 | "Sorting events for output..."); | |
604 | evsel__output_resort(pos, &prog); | |
605 | ui_progress__finish(); | |
b1dd4432 | 606 | |
227ad323 NK |
607 | /* |
608 | * An event group needs to display other events too. | |
609 | * Let's delay printing until other events are processed. | |
610 | */ | |
611 | if (symbol_conf.event_group) { | |
612 | if (!evsel__is_group_leader(pos)) { | |
613 | struct hists *leader_hists; | |
614 | ||
615 | leader_hists = evsel__hists(evsel__leader(pos)); | |
616 | hists__match(leader_hists, hists); | |
617 | hists__link(leader_hists, hists); | |
618 | } | |
b1dd4432 | 619 | continue; |
227ad323 | 620 | } |
b1dd4432 | 621 | |
db8fd07a | 622 | hists__find_annotations(hists, pos, ann); |
e248de33 ACM |
623 | } |
624 | } | |
8035e428 | 625 | |
e248de33 | 626 | if (total_nr_samples == 0) { |
2d4f2799 | 627 | ui__error("The %s data has no samples!\n", session->data->path); |
fa10f316 | 628 | goto out; |
e248de33 | 629 | } |
7a60ba94 | 630 | |
227ad323 NK |
631 | /* Display group events together */ |
632 | evlist__for_each_entry(session->evlist, pos) { | |
633 | struct hists *hists = evsel__hists(pos); | |
634 | u32 nr_samples = hists->stats.nr_samples; | |
635 | ||
636 | if (nr_samples == 0) | |
637 | continue; | |
638 | ||
639 | if (!symbol_conf.event_group || !evsel__is_group_leader(pos)) | |
640 | continue; | |
641 | ||
642 | hists__find_annotations(hists, pos, ann); | |
643 | } | |
644 | ||
fc67297b NK |
645 | if (use_browser == 2) { |
646 | void (*show_annotations)(void); | |
647 | ||
648 | show_annotations = dlsym(perf_gtk_handle, | |
649 | "perf_gtk__show_annotations"); | |
650 | if (show_annotations == NULL) { | |
651 | ui__error("GTK browser not found!\n"); | |
fa10f316 | 652 | goto out; |
fc67297b NK |
653 | } |
654 | show_annotations(); | |
655 | } | |
7a60ba94 | 656 | |
fa10f316 | 657 | out: |
bab81b62 | 658 | return ret; |
8035e428 IM |
659 | } |
660 | ||
cad10ce3 NK |
661 | static int parse_percent_limit(const struct option *opt, const char *str, |
662 | int unset __maybe_unused) | |
663 | { | |
664 | struct perf_annotate *ann = opt->value; | |
665 | double pcnt = strtof(str, NULL); | |
666 | ||
667 | ann->min_percent = pcnt; | |
668 | return 0; | |
669 | } | |
670 | ||
263925bf NK |
671 | static int parse_data_type(const struct option *opt, const char *str, int unset) |
672 | { | |
673 | struct perf_annotate *ann = opt->value; | |
674 | ||
675 | ann->data_type = !unset; | |
676 | if (str) | |
677 | ann->target_data_type = strdup(str); | |
678 | ||
679 | return 0; | |
680 | } | |
681 | ||
8035e428 | 682 | static const char * const annotate_usage[] = { |
99345254 | 683 | "perf annotate [<options>]", |
8035e428 IM |
684 | NULL |
685 | }; | |
686 | ||
b0ad8ea6 | 687 | int cmd_annotate(int argc, const char **argv) |
d20deb64 ACM |
688 | { |
689 | struct perf_annotate annotate = { | |
45694aa7 | 690 | .tool = { |
d20deb64 ACM |
691 | .sample = process_sample_event, |
692 | .mmap = perf_event__process_mmap, | |
5c5e854b | 693 | .mmap2 = perf_event__process_mmap2, |
d20deb64 | 694 | .comm = perf_event__process_comm, |
ec4622f5 | 695 | .exit = perf_event__process_exit, |
f62d3f0f | 696 | .fork = perf_event__process_fork, |
f3b3614a | 697 | .namespaces = perf_event__process_namespaces, |
6ab11f3a DCC |
698 | .attr = perf_event__process_attr, |
699 | .build_id = perf_event__process_build_id, | |
378ef0f5 | 700 | #ifdef HAVE_LIBTRACEEVENT |
f4849599 | 701 | .tracing_data = perf_event__process_tracing_data, |
378ef0f5 | 702 | #endif |
4bcbe438 YJ |
703 | .id_index = perf_event__process_id_index, |
704 | .auxtrace_info = perf_event__process_auxtrace_info, | |
705 | .auxtrace = perf_event__process_auxtrace, | |
92ead7ee | 706 | .feature = process_feature_event, |
0a8cb85c | 707 | .ordered_events = true, |
d20deb64 ACM |
708 | .ordering_requires_timestamps = true, |
709 | }, | |
d20deb64 | 710 | }; |
8ceb41d7 | 711 | struct perf_data data = { |
fa10f316 NK |
712 | .mode = PERF_DATA_MODE_READ, |
713 | }; | |
4bcbe438 YJ |
714 | struct itrace_synth_opts itrace_synth_opts = { |
715 | .set = 0, | |
716 | }; | |
57594454 | 717 | const char *disassembler_style = NULL, *objdump_path = NULL, *addr2line_path = NULL; |
1ac39372 | 718 | struct option options[] = { |
70cb4e96 | 719 | OPT_STRING('i', "input", &input_name, "file", |
8035e428 | 720 | "input file name"), |
ac73c5a9 ACM |
721 | OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]", |
722 | "only consider symbols in these dsos"), | |
7009cc34 | 723 | OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol", |
0b73da3f | 724 | "symbol to annotate"), |
8ceb41d7 | 725 | OPT_BOOLEAN('f', "force", &data.force, "don't complain, do it"), |
c0555642 | 726 | OPT_INCR('v', "verbose", &verbose, |
8035e428 | 727 | "be more verbose (show symbol address, etc)"), |
a527c2c1 | 728 | OPT_BOOLEAN('q', "quiet", &quiet, "do now show any warnings or messages"), |
8035e428 IM |
729 | OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, |
730 | "dump raw trace in ASCII"), | |
557cc18e | 731 | #ifdef HAVE_GTK2_SUPPORT |
2b676bf0 | 732 | OPT_BOOLEAN(0, "gtk", &annotate.use_gtk, "Use the GTK interface"), |
557cc18e | 733 | #endif |
3402ae0a | 734 | #ifdef HAVE_SLANG_SUPPORT |
7009cc34 | 735 | OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"), |
3402ae0a | 736 | #endif |
7009cc34 | 737 | OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"), |
befd2a38 | 738 | OPT_BOOLEAN(0, "stdio2", &annotate.use_stdio2, "Use the stdio interface"), |
be316409 ACM |
739 | OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux, |
740 | "don't load vmlinux even if found"), | |
b32d133a ACM |
741 | OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, |
742 | "file", "vmlinux pathname"), | |
743 | OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules, | |
42976487 | 744 | "load module symbols - WARNING: use only with -k and LIVE kernel"), |
9d03194a | 745 | OPT_BOOLEAN('l', "print-line", &annotate_opts.print_lines, |
301406b9 | 746 | "print matching source lines (may be slow)"), |
9d03194a | 747 | OPT_BOOLEAN('P', "full-paths", &annotate_opts.full_path, |
42976487 | 748 | "Don't shorten the displayed pathnames"), |
18c9e5c5 NK |
749 | OPT_BOOLEAN(0, "skip-missing", &annotate.skip_missing, |
750 | "Skip symbols that cannot be annotated"), | |
7ebaf489 JY |
751 | OPT_BOOLEAN_SET(0, "group", &symbol_conf.event_group, |
752 | &annotate.group_set, | |
753 | "Show event group information together"), | |
c8e66720 | 754 | OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"), |
a7066709 HK |
755 | OPT_CALLBACK(0, "symfs", NULL, "directory", |
756 | "Look for files with symbols relative to this directory", | |
757 | symbol__config_symfs), | |
9d03194a | 758 | OPT_BOOLEAN(0, "source", &annotate_opts.annotate_src, |
3e6a2a7f | 759 | "Interleave source code with assembly code (default)"), |
9d03194a | 760 | OPT_BOOLEAN(0, "asm-raw", &annotate_opts.show_asm_raw, |
3e6a2a7f | 761 | "Display raw encoding of assembly instructions (default)"), |
56d9117c | 762 | OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style", |
f69b64f7 | 763 | "Specify disassembler style (e.g. -M intel for intel syntax)"), |
9d03194a | 764 | OPT_STRING(0, "prefix", &annotate_opts.prefix, "prefix", |
3b0b16bf | 765 | "Add prefix to source file path names in programs (with --prefix-strip)"), |
9d03194a | 766 | OPT_STRING(0, "prefix-strip", &annotate_opts.prefix_strip, "N", |
3b0b16bf | 767 | "Strip first N entries of source file path name in programs (with --prefix)"), |
56d9117c | 768 | OPT_STRING(0, "objdump", &objdump_path, "path", |
7a4ec938 | 769 | "objdump binary to use for disassembly and annotations"), |
57594454 IR |
770 | OPT_STRING(0, "addr2line", &addr2line_path, "path", |
771 | "addr2line binary to use for line numbers"), | |
3406ac53 ML |
772 | OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle, |
773 | "Enable symbol demangling"), | |
774 | OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel, | |
775 | "Enable kernel symbol demangling"), | |
0c4a5bce ML |
776 | OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period, |
777 | "Show a column with the sum of periods"), | |
1ac39372 TS |
778 | OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples, |
779 | "Show a column with the number of samples"), | |
53fe4ba1 ACM |
780 | OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL, "mode", |
781 | "'always' (default), 'never' or 'auto' only applicable to --stdio mode", | |
782 | stdio__config_color, "always"), | |
9d03194a | 783 | OPT_CALLBACK(0, "percent-type", &annotate_opts, "local-period", |
88c21190 JO |
784 | "Set percent type local/global-period/hits", |
785 | annotate_parse_percent_type), | |
cad10ce3 NK |
786 | OPT_CALLBACK(0, "percent-limit", &annotate, "percent", |
787 | "Don't show entries under that percent", parse_percent_limit), | |
4bcbe438 YJ |
788 | OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts", |
789 | "Instruction Tracing options\n" ITRACE_HELP, | |
790 | itrace_parse_synth_opts), | |
263925bf NK |
791 | OPT_CALLBACK_OPTARG(0, "data-type", &annotate, NULL, "name", |
792 | "Show data type annotate for the memory accesses", | |
793 | parse_data_type), | |
61a9741e NK |
794 | OPT_BOOLEAN(0, "type-stat", &annotate.type_stat, |
795 | "Show stats for the data type annotation"), | |
58824fa0 NK |
796 | OPT_BOOLEAN(0, "insn-stat", &annotate.insn_stat, |
797 | "Show instruction stats for the data type annotation"), | |
8035e428 | 798 | OPT_END() |
d20deb64 | 799 | }; |
1ac39372 TS |
800 | int ret; |
801 | ||
802 | set_option_flag(options, 0, "show-total-period", PARSE_OPT_EXCLUSIVE); | |
803 | set_option_flag(options, 0, "show-nr-samples", PARSE_OPT_EXCLUSIVE); | |
804 | ||
7f929aea | 805 | annotation_options__init(); |
a635fc51 | 806 | |
1ac39372 | 807 | ret = hists__init(); |
a635fc51 ACM |
808 | if (ret < 0) |
809 | return ret; | |
8035e428 | 810 | |
7f929aea | 811 | annotation_config__init(); |
812b0f52 | 812 | |
655000e7 | 813 | argc = parse_options(argc, argv, options, annotate_usage, 0); |
50e19ef9 NK |
814 | if (argc) { |
815 | /* | |
816 | * Special case: if there's an argument left then assume that | |
817 | * it's a symbol filter: | |
818 | */ | |
819 | if (argc > 1) | |
820 | usage_with_options(annotate_usage, options); | |
821 | ||
822 | annotate.sym_hist_filter = argv[0]; | |
823 | } | |
655000e7 | 824 | |
56d9117c | 825 | if (disassembler_style) { |
9d03194a NK |
826 | annotate_opts.disassembler_style = strdup(disassembler_style); |
827 | if (!annotate_opts.disassembler_style) | |
56d9117c IR |
828 | return -ENOMEM; |
829 | } | |
830 | if (objdump_path) { | |
9d03194a NK |
831 | annotate_opts.objdump_path = strdup(objdump_path); |
832 | if (!annotate_opts.objdump_path) | |
56d9117c IR |
833 | return -ENOMEM; |
834 | } | |
57594454 IR |
835 | if (addr2line_path) { |
836 | symbol_conf.addr2line_path = strdup(addr2line_path); | |
837 | if (!symbol_conf.addr2line_path) | |
838 | return -ENOMEM; | |
839 | } | |
56d9117c | 840 | |
7f929aea | 841 | if (annotate_check_args() < 0) |
3b0b16bf AK |
842 | return -EINVAL; |
843 | ||
557cc18e | 844 | #ifdef HAVE_GTK2_SUPPORT |
9cef4b0b TS |
845 | if (symbol_conf.show_nr_samples && annotate.use_gtk) { |
846 | pr_err("--show-nr-samples is not available in --gtk mode at this time\n"); | |
1ac39372 TS |
847 | return ret; |
848 | } | |
557cc18e | 849 | #endif |
1ac39372 | 850 | |
263925bf NK |
851 | #ifndef HAVE_DWARF_GETLOCATIONS_SUPPORT |
852 | if (annotate.data_type) { | |
853 | pr_err("Error: Data type profiling is disabled due to missing DWARF support\n"); | |
854 | return -ENOTSUP; | |
855 | } | |
856 | #endif | |
857 | ||
7cc72553 JC |
858 | ret = symbol__validate_sym_arguments(); |
859 | if (ret) | |
860 | return ret; | |
861 | ||
eddaef88 NK |
862 | if (quiet) |
863 | perf_quiet_option(); | |
864 | ||
2d4f2799 | 865 | data.path = input_name; |
44848cdb | 866 | |
2681bd85 | 867 | annotate.session = perf_session__new(&data, &annotate.tool); |
6ef81c55 MI |
868 | if (IS_ERR(annotate.session)) |
869 | return PTR_ERR(annotate.session); | |
fa10f316 | 870 | |
4bcbe438 YJ |
871 | annotate.session->itrace_synth_opts = &itrace_synth_opts; |
872 | ||
bb848c14 JY |
873 | annotate.has_br_stack = perf_header__has_feat(&annotate.session->header, |
874 | HEADER_BRANCH_STACK); | |
875 | ||
7ebaf489 | 876 | if (annotate.group_set) |
64b4778b | 877 | evlist__force_leader(annotate.session->evlist); |
7ebaf489 | 878 | |
b01141f4 ACM |
879 | ret = symbol__annotation_init(); |
880 | if (ret < 0) | |
881 | goto out_delete; | |
882 | ||
75be6cf4 ACM |
883 | symbol_conf.try_vmlinux_path = true; |
884 | ||
0a7e6d1b | 885 | ret = symbol__init(&annotate.session->header.env); |
fa10f316 NK |
886 | if (ret < 0) |
887 | goto out_delete; | |
8035e428 | 888 | |
befd2a38 | 889 | if (annotate.use_stdio || annotate.use_stdio2) |
3df668e7 | 890 | use_browser = 0; |
3402ae0a | 891 | #ifdef HAVE_SLANG_SUPPORT |
3df668e7 NK |
892 | else if (annotate.use_tui) |
893 | use_browser = 1; | |
3402ae0a | 894 | #endif |
557cc18e | 895 | #ifdef HAVE_GTK2_SUPPORT |
3df668e7 NK |
896 | else if (annotate.use_gtk) |
897 | use_browser = 2; | |
557cc18e | 898 | #endif |
3df668e7 | 899 | |
263925bf | 900 | if (annotate.data_type) { |
263925bf NK |
901 | annotate_opts.annotate_src = false; |
902 | symbol_conf.annotate_data_member = true; | |
903 | symbol_conf.annotate_data_sample = true; | |
904 | } | |
905 | ||
3df668e7 NK |
906 | setup_browser(true); |
907 | ||
5676dba7 YJ |
908 | /* |
909 | * Events of different processes may correspond to the same | |
910 | * symbol, we do not care about the processes in annotate, | |
911 | * set sort order to avoid repeated output. | |
912 | */ | |
263925bf NK |
913 | if (annotate.data_type) |
914 | sort_order = "dso,type"; | |
915 | else | |
916 | sort_order = "dso,symbol"; | |
5676dba7 YJ |
917 | |
918 | /* | |
919 | * Set SORT_MODE__BRANCH so that annotate display IPC/Cycle | |
920 | * if branch info is in perf data in TUI mode. | |
921 | */ | |
922 | if ((use_browser == 1 || annotate.use_stdio2) && annotate.has_br_stack) | |
bb848c14 | 923 | sort__mode = SORT_MODE__BRANCH; |
5676dba7 YJ |
924 | |
925 | if (setup_sorting(NULL) < 0) | |
926 | usage_with_options(annotate_usage, options); | |
bb848c14 | 927 | |
fa10f316 NK |
928 | ret = __cmd_annotate(&annotate); |
929 | ||
930 | out_delete: | |
931 | /* | |
333b1b11 IR |
932 | * Speed up the exit process by only deleting for debug builds. For |
933 | * large files this can save time. | |
fa10f316 | 934 | */ |
333b1b11 IR |
935 | #ifndef NDEBUG |
936 | perf_session__delete(annotate.session); | |
937 | #endif | |
7f929aea | 938 | annotation_options__exit(); |
333b1b11 | 939 | |
fa10f316 | 940 | return ret; |
8035e428 | 941 | } |