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