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 ACM |
48 | static int perf_evsel__add_sample(struct perf_evsel *evsel, |
49 | struct perf_sample *sample, | |
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 | ||
41a4e6e2 | 68 | he = __hists__add_entry(&evsel->hists, al, NULL, NULL, NULL, 1, 1, 0); |
9735abf1 | 69 | if (he == NULL) |
8035e428 | 70 | return -ENOMEM; |
628ada0c | 71 | |
e248de33 | 72 | ret = 0; |
2f525d01 | 73 | if (he->ms.sym != NULL) { |
2f525d01 | 74 | struct annotation *notes = symbol__annotation(he->ms.sym); |
d04b35f8 | 75 | if (notes->src == NULL && symbol__alloc_hist(he->ms.sym) < 0) |
2f525d01 ACM |
76 | return -ENOMEM; |
77 | ||
e248de33 | 78 | ret = hist_entry__inc_addr_samples(he, evsel->idx, al->addr); |
2f525d01 ACM |
79 | } |
80 | ||
e248de33 ACM |
81 | evsel->hists.stats.total_period += sample->period; |
82 | hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE); | |
83 | return ret; | |
8035e428 IM |
84 | } |
85 | ||
45694aa7 | 86 | static int process_sample_event(struct perf_tool *tool, |
d20deb64 | 87 | union perf_event *event, |
8115d60c | 88 | struct perf_sample *sample, |
9e69c210 | 89 | struct perf_evsel *evsel, |
743eb868 | 90 | struct machine *machine) |
8035e428 | 91 | { |
45694aa7 | 92 | struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool); |
1ed091c4 | 93 | struct addr_location al; |
6baa0a5a | 94 | |
e44baa3e | 95 | if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) { |
29a9f66d ACM |
96 | pr_warning("problem processing %d event, skipping it.\n", |
97 | event->header.type); | |
8035e428 IM |
98 | return -1; |
99 | } | |
100 | ||
7009cc34 | 101 | if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap)) |
5d67be97 AB |
102 | return 0; |
103 | ||
d20deb64 | 104 | if (!al.filtered && perf_evsel__add_sample(evsel, sample, &al, ann)) { |
29a9f66d ACM |
105 | pr_warning("problem incrementing symbol count, " |
106 | "skipping event\n"); | |
ec218fc4 | 107 | return -1; |
8035e428 | 108 | } |
8035e428 IM |
109 | |
110 | return 0; | |
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 | */ | |
ce6f4fab ACM |
191 | free(notes->src); |
192 | notes->src = NULL; | |
46e3e055 | 193 | } |
0b73da3f | 194 | } |
0b73da3f IM |
195 | } |
196 | ||
d20deb64 | 197 | static int __cmd_annotate(struct perf_annotate *ann) |
8035e428 | 198 | { |
bab81b62 | 199 | int ret; |
75be6cf4 | 200 | struct perf_session *session; |
e248de33 ACM |
201 | struct perf_evsel *pos; |
202 | u64 total_nr_samples; | |
f5fc1412 JO |
203 | struct perf_data_file file = { |
204 | .path = input_name, | |
205 | .mode = PERF_DATA_MODE_READ, | |
206 | .force = ann->force, | |
207 | }; | |
8035e428 | 208 | |
f5fc1412 | 209 | session = perf_session__new(&file, false, &ann->tool); |
94c744b6 ACM |
210 | if (session == NULL) |
211 | return -ENOMEM; | |
212 | ||
476d35c2 AH |
213 | machines__set_symbol_filter(&session->machines, symbol__annotate_init); |
214 | ||
7009cc34 ACM |
215 | if (ann->cpu_list) { |
216 | ret = perf_session__cpu_bitmap(session, ann->cpu_list, | |
217 | ann->cpu_bitmap); | |
5d67be97 AB |
218 | if (ret) |
219 | goto out_delete; | |
220 | } | |
221 | ||
68e94f4e IT |
222 | if (!objdump_path) { |
223 | ret = perf_session_env__lookup_objdump(&session->header.env); | |
224 | if (ret) | |
225 | goto out_delete; | |
226 | } | |
227 | ||
45694aa7 | 228 | ret = perf_session__process_events(session, &ann->tool); |
bab81b62 | 229 | if (ret) |
94c744b6 | 230 | goto out_delete; |
8035e428 | 231 | |
62daacb5 | 232 | if (dump_trace) { |
c8446b9b | 233 | perf_session__fprintf_nr_events(session, stdout); |
94c744b6 | 234 | goto out_delete; |
62daacb5 | 235 | } |
8035e428 | 236 | |
da21d1b5 | 237 | if (verbose > 3) |
b3165f41 | 238 | perf_session__fprintf(session, stdout); |
8035e428 | 239 | |
da21d1b5 | 240 | if (verbose > 2) |
cbf69680 | 241 | perf_session__fprintf_dsos(session, stdout); |
8035e428 | 242 | |
e248de33 ACM |
243 | total_nr_samples = 0; |
244 | list_for_each_entry(pos, &session->evlist->entries, node) { | |
245 | struct hists *hists = &pos->hists; | |
246 | u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE]; | |
247 | ||
248 | if (nr_samples > 0) { | |
249 | total_nr_samples += nr_samples; | |
c1fb5651 | 250 | hists__collapse_resort(hists, NULL); |
e248de33 | 251 | hists__output_resort(hists); |
b1dd4432 NK |
252 | |
253 | if (symbol_conf.event_group && | |
254 | !perf_evsel__is_group_leader(pos)) | |
255 | continue; | |
256 | ||
db8fd07a | 257 | hists__find_annotations(hists, pos, ann); |
e248de33 ACM |
258 | } |
259 | } | |
8035e428 | 260 | |
e248de33 | 261 | if (total_nr_samples == 0) { |
cc9784bd | 262 | ui__error("The %s file has no samples!\n", file.path); |
e248de33 ACM |
263 | goto out_delete; |
264 | } | |
7a60ba94 | 265 | |
fc67297b NK |
266 | if (use_browser == 2) { |
267 | void (*show_annotations)(void); | |
268 | ||
269 | show_annotations = dlsym(perf_gtk_handle, | |
270 | "perf_gtk__show_annotations"); | |
271 | if (show_annotations == NULL) { | |
272 | ui__error("GTK browser not found!\n"); | |
273 | goto out_delete; | |
274 | } | |
275 | show_annotations(); | |
276 | } | |
7a60ba94 | 277 | |
e248de33 ACM |
278 | out_delete: |
279 | /* | |
280 | * Speed up the exit process, for large files this can | |
281 | * take quite a while. | |
282 | * | |
283 | * XXX Enable this when using valgrind or if we ever | |
284 | * librarize this command. | |
285 | * | |
286 | * Also experiment with obstacks to see how much speed | |
287 | * up we'll get here. | |
288 | * | |
289 | * perf_session__delete(session); | |
290 | */ | |
bab81b62 | 291 | return ret; |
8035e428 IM |
292 | } |
293 | ||
294 | static const char * const annotate_usage[] = { | |
99345254 | 295 | "perf annotate [<options>]", |
8035e428 IM |
296 | NULL |
297 | }; | |
298 | ||
1d037ca1 | 299 | int cmd_annotate(int argc, const char **argv, const char *prefix __maybe_unused) |
d20deb64 ACM |
300 | { |
301 | struct perf_annotate annotate = { | |
45694aa7 | 302 | .tool = { |
d20deb64 ACM |
303 | .sample = process_sample_event, |
304 | .mmap = perf_event__process_mmap, | |
5c5e854b | 305 | .mmap2 = perf_event__process_mmap2, |
d20deb64 | 306 | .comm = perf_event__process_comm, |
ec4622f5 | 307 | .exit = perf_event__process_exit, |
f62d3f0f | 308 | .fork = perf_event__process_fork, |
d20deb64 ACM |
309 | .ordered_samples = true, |
310 | .ordering_requires_timestamps = true, | |
311 | }, | |
d20deb64 ACM |
312 | }; |
313 | const struct option options[] = { | |
70cb4e96 | 314 | OPT_STRING('i', "input", &input_name, "file", |
8035e428 | 315 | "input file name"), |
ac73c5a9 ACM |
316 | OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]", |
317 | "only consider symbols in these dsos"), | |
7009cc34 | 318 | OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol", |
0b73da3f | 319 | "symbol to annotate"), |
7009cc34 | 320 | OPT_BOOLEAN('f', "force", &annotate.force, "don't complain, do it"), |
c0555642 | 321 | OPT_INCR('v', "verbose", &verbose, |
8035e428 IM |
322 | "be more verbose (show symbol address, etc)"), |
323 | OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, | |
324 | "dump raw trace in ASCII"), | |
2b676bf0 | 325 | OPT_BOOLEAN(0, "gtk", &annotate.use_gtk, "Use the GTK interface"), |
7009cc34 ACM |
326 | OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"), |
327 | OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"), | |
b32d133a ACM |
328 | OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, |
329 | "file", "vmlinux pathname"), | |
330 | OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules, | |
42976487 | 331 | "load module symbols - WARNING: use only with -k and LIVE kernel"), |
7009cc34 | 332 | OPT_BOOLEAN('l', "print-line", &annotate.print_line, |
301406b9 | 333 | "print matching source lines (may be slow)"), |
7009cc34 | 334 | OPT_BOOLEAN('P', "full-paths", &annotate.full_paths, |
42976487 | 335 | "Don't shorten the displayed pathnames"), |
18c9e5c5 NK |
336 | OPT_BOOLEAN(0, "skip-missing", &annotate.skip_missing, |
337 | "Skip symbols that cannot be annotated"), | |
c8e66720 | 338 | OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"), |
e71a0598 SE |
339 | OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory", |
340 | "Look for files with symbols relative to this directory"), | |
64c6f0c7 | 341 | OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src, |
3e6a2a7f | 342 | "Interleave source code with assembly code (default)"), |
64c6f0c7 | 343 | OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw, |
3e6a2a7f | 344 | "Display raw encoding of assembly instructions (default)"), |
f69b64f7 AK |
345 | OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style", |
346 | "Specify disassembler style (e.g. -M intel for intel syntax)"), | |
7a4ec938 MB |
347 | OPT_STRING(0, "objdump", &objdump_path, "path", |
348 | "objdump binary to use for disassembly and annotations"), | |
b1dd4432 NK |
349 | OPT_BOOLEAN(0, "group", &symbol_conf.event_group, |
350 | "Show event group information together"), | |
8035e428 | 351 | OPT_END() |
d20deb64 | 352 | }; |
8035e428 | 353 | |
655000e7 ACM |
354 | argc = parse_options(argc, argv, options, annotate_usage, 0); |
355 | ||
7009cc34 | 356 | if (annotate.use_stdio) |
8b9e74eb | 357 | use_browser = 0; |
7009cc34 | 358 | else if (annotate.use_tui) |
8b9e74eb | 359 | use_browser = 1; |
2b676bf0 NK |
360 | else if (annotate.use_gtk) |
361 | use_browser = 2; | |
8b9e74eb | 362 | |
229ade9b | 363 | setup_browser(true); |
46e3e055 | 364 | |
78f7defe | 365 | symbol_conf.priv_size = sizeof(struct annotation); |
75be6cf4 ACM |
366 | symbol_conf.try_vmlinux_path = true; |
367 | ||
368 | if (symbol__init() < 0) | |
b32d133a | 369 | return -1; |
8035e428 | 370 | |
55309985 NK |
371 | if (setup_sorting() < 0) |
372 | usage_with_options(annotate_usage, options); | |
8035e428 | 373 | |
0b73da3f IM |
374 | if (argc) { |
375 | /* | |
6f1d0c86 | 376 | * Special case: if there's an argument left then assume that |
0b73da3f IM |
377 | * it's a symbol filter: |
378 | */ | |
379 | if (argc > 1) | |
380 | usage_with_options(annotate_usage, options); | |
381 | ||
7009cc34 | 382 | annotate.sym_hist_filter = argv[0]; |
0b73da3f IM |
383 | } |
384 | ||
d20deb64 | 385 | return __cmd_annotate(&annotate); |
8035e428 | 386 | } |