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