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