]>
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 | ||
10 | #include "util/util.h" | |
11 | ||
12 | #include "util/color.h" | |
5da50258 | 13 | #include <linux/list.h> |
8035e428 | 14 | #include "util/cache.h" |
43cbcd8a | 15 | #include <linux/rbtree.h> |
8035e428 IM |
16 | #include "util/symbol.h" |
17 | #include "util/string.h" | |
18 | ||
19 | #include "perf.h" | |
8f28827a | 20 | #include "util/debug.h" |
8035e428 | 21 | |
62daacb5 | 22 | #include "util/event.h" |
8035e428 IM |
23 | #include "util/parse-options.h" |
24 | #include "util/parse-events.h" | |
6baa0a5a | 25 | #include "util/thread.h" |
dd68ada2 | 26 | #include "util/sort.h" |
3d1d07ec | 27 | #include "util/hist.h" |
94c744b6 | 28 | #include "util/session.h" |
8035e428 | 29 | |
8035e428 | 30 | static char const *input_name = "perf.data"; |
8035e428 | 31 | |
fa6963b2 | 32 | static int force; |
8035e428 | 33 | |
42976487 MG |
34 | static int full_paths; |
35 | ||
301406b9 FW |
36 | static int print_line; |
37 | ||
e4204992 ACM |
38 | struct sym_hist { |
39 | u64 sum; | |
40 | u64 ip[0]; | |
41 | }; | |
42 | ||
301406b9 | 43 | struct sym_ext { |
971738f3 | 44 | struct rb_node node; |
301406b9 FW |
45 | double percent; |
46 | char *path; | |
47 | }; | |
48 | ||
e4204992 ACM |
49 | struct sym_priv { |
50 | struct sym_hist *hist; | |
51 | struct sym_ext *ext; | |
52 | }; | |
53 | ||
54 | static const char *sym_hist_filter; | |
55 | ||
628ada0c | 56 | static int sym__alloc_hist(struct symbol *self) |
e4204992 | 57 | { |
628ada0c ACM |
58 | struct sym_priv *priv = symbol__priv(self); |
59 | const int size = (sizeof(*priv->hist) + | |
60 | (self->end - self->start) * sizeof(u64)); | |
61 | ||
62 | priv->hist = zalloc(size); | |
63 | return priv->hist == NULL ? -1 : 0; | |
e4204992 | 64 | } |
8035e428 | 65 | |
0b73da3f IM |
66 | /* |
67 | * collect histogram counts | |
68 | */ | |
628ada0c | 69 | static int annotate__hist_hit(struct hist_entry *he, u64 ip) |
8035e428 | 70 | { |
0b73da3f IM |
71 | unsigned int sym_size, offset; |
72 | struct symbol *sym = he->sym; | |
e4204992 ACM |
73 | struct sym_priv *priv; |
74 | struct sym_hist *h; | |
8035e428 | 75 | |
0b73da3f | 76 | he->count++; |
8035e428 | 77 | |
e4204992 | 78 | if (!sym || !he->map) |
628ada0c | 79 | return 0; |
e4204992 | 80 | |
00a192b3 | 81 | priv = symbol__priv(sym); |
628ada0c ACM |
82 | if (priv->hist == NULL && sym__alloc_hist(sym) < 0) |
83 | return -ENOMEM; | |
8035e428 | 84 | |
0b73da3f IM |
85 | sym_size = sym->end - sym->start; |
86 | offset = ip - sym->start; | |
8035e428 | 87 | |
29a9f66d | 88 | pr_debug3("%s: ip=%#Lx\n", __func__, he->map->unmap_ip(he->map, ip)); |
ed52ce2e | 89 | |
0b73da3f | 90 | if (offset >= sym_size) |
628ada0c | 91 | return 0; |
8035e428 | 92 | |
e4204992 ACM |
93 | h = priv->hist; |
94 | h->sum++; | |
95 | h->ip[offset]++; | |
8035e428 | 96 | |
29a9f66d ACM |
97 | pr_debug3("%#Lx %s: count++ [ip: %#Lx, %#Lx] => %Ld\n", he->sym->start, |
98 | he->sym->name, ip, ip - he->sym->start, h->ip[offset]); | |
628ada0c | 99 | return 0; |
8035e428 IM |
100 | } |
101 | ||
4e4f06e4 ACM |
102 | static int perf_session__add_hist_entry(struct perf_session *self, |
103 | struct addr_location *al, u64 count) | |
8035e428 | 104 | { |
9735abf1 | 105 | bool hit; |
628ada0c ACM |
106 | struct hist_entry *he; |
107 | ||
108 | if (sym_hist_filter != NULL && | |
109 | (al->sym == NULL || strcmp(sym_hist_filter, al->sym->name) != 0)) { | |
110 | /* We're only interested in a symbol named sym_hist_filter */ | |
111 | if (al->sym != NULL) { | |
112 | rb_erase(&al->sym->rb_node, | |
113 | &al->map->dso->symbols[al->map->type]); | |
114 | symbol__delete(al->sym); | |
115 | } | |
116 | return 0; | |
117 | } | |
118 | ||
119 | he = __perf_session__add_hist_entry(self, al, NULL, count, &hit); | |
9735abf1 | 120 | if (he == NULL) |
8035e428 | 121 | return -ENOMEM; |
628ada0c ACM |
122 | |
123 | return annotate__hist_hit(he, al->addr); | |
8035e428 IM |
124 | } |
125 | ||
b3165f41 | 126 | static int process_sample_event(event_t *event, struct perf_session *session) |
8035e428 | 127 | { |
1ed091c4 | 128 | struct addr_location al; |
6baa0a5a | 129 | |
0d755034 ACM |
130 | dump_printf("(IP, %d): %d: %#Lx\n", event->header.misc, |
131 | event->ip.pid, event->ip.ip); | |
8035e428 | 132 | |
628ada0c | 133 | if (event__preprocess_sample(event, session, &al, NULL) < 0) { |
29a9f66d ACM |
134 | pr_warning("problem processing %d event, skipping it.\n", |
135 | event->header.type); | |
8035e428 IM |
136 | return -1; |
137 | } | |
138 | ||
c410a338 | 139 | if (!al.filtered && perf_session__add_hist_entry(session, &al, 1)) { |
29a9f66d ACM |
140 | pr_warning("problem incrementing symbol count, " |
141 | "skipping event\n"); | |
ec218fc4 | 142 | return -1; |
8035e428 | 143 | } |
8035e428 IM |
144 | |
145 | return 0; | |
146 | } | |
147 | ||
ed52ce2e | 148 | static int parse_line(FILE *file, struct hist_entry *he, u64 len) |
0b73da3f | 149 | { |
ed52ce2e | 150 | struct symbol *sym = he->sym; |
0b73da3f | 151 | char *line = NULL, *tmp, *tmp2; |
301406b9 FW |
152 | static const char *prev_line; |
153 | static const char *prev_color; | |
0b73da3f IM |
154 | unsigned int offset; |
155 | size_t line_len; | |
ed52ce2e | 156 | u64 start; |
f37a291c | 157 | s64 line_ip; |
0b73da3f IM |
158 | int ret; |
159 | char *c; | |
160 | ||
161 | if (getline(&line, &line_len, file) < 0) | |
162 | return -1; | |
163 | if (!line) | |
164 | return -1; | |
165 | ||
166 | c = strchr(line, '\n'); | |
167 | if (c) | |
168 | *c = 0; | |
169 | ||
170 | line_ip = -1; | |
171 | offset = 0; | |
172 | ret = -2; | |
173 | ||
174 | /* | |
175 | * Strip leading spaces: | |
176 | */ | |
177 | tmp = line; | |
178 | while (*tmp) { | |
179 | if (*tmp != ' ') | |
180 | break; | |
181 | tmp++; | |
182 | } | |
183 | ||
184 | if (*tmp) { | |
185 | /* | |
186 | * Parse hexa addresses followed by ':' | |
187 | */ | |
188 | line_ip = strtoull(tmp, &tmp2, 16); | |
189 | if (*tmp2 != ':') | |
190 | line_ip = -1; | |
191 | } | |
192 | ||
7a2b6209 | 193 | start = map__rip_2objdump(he->map, sym->start); |
ed52ce2e | 194 | |
0b73da3f | 195 | if (line_ip != -1) { |
301406b9 | 196 | const char *path = NULL; |
0b73da3f IM |
197 | unsigned int hits = 0; |
198 | double percent = 0.0; | |
83a0944f | 199 | const char *color; |
00a192b3 | 200 | struct sym_priv *priv = symbol__priv(sym); |
e4204992 ACM |
201 | struct sym_ext *sym_ext = priv->ext; |
202 | struct sym_hist *h = priv->hist; | |
0b73da3f | 203 | |
ed52ce2e | 204 | offset = line_ip - start; |
0b73da3f | 205 | if (offset < len) |
e4204992 | 206 | hits = h->ip[offset]; |
0b73da3f | 207 | |
c17c2db1 | 208 | if (offset < len && sym_ext) { |
301406b9 FW |
209 | path = sym_ext[offset].path; |
210 | percent = sym_ext[offset].percent; | |
e4204992 ACM |
211 | } else if (h->sum) |
212 | percent = 100.0 * hits / h->sum; | |
0b73da3f | 213 | |
1e11fd82 | 214 | color = get_percent_color(percent); |
0b73da3f | 215 | |
301406b9 FW |
216 | /* |
217 | * Also color the filename and line if needed, with | |
218 | * the same color than the percentage. Don't print it | |
219 | * twice for close colored ip with the same filename:line | |
220 | */ | |
221 | if (path) { | |
222 | if (!prev_line || strcmp(prev_line, path) | |
223 | || color != prev_color) { | |
224 | color_fprintf(stdout, color, " %s", path); | |
225 | prev_line = path; | |
226 | prev_color = color; | |
227 | } | |
228 | } | |
229 | ||
0b73da3f IM |
230 | color_fprintf(stdout, color, " %7.2f", percent); |
231 | printf(" : "); | |
232 | color_fprintf(stdout, PERF_COLOR_BLUE, "%s\n", line); | |
233 | } else { | |
234 | if (!*line) | |
235 | printf(" :\n"); | |
236 | else | |
237 | printf(" : %s\n", line); | |
238 | } | |
239 | ||
240 | return 0; | |
241 | } | |
242 | ||
971738f3 FW |
243 | static struct rb_root root_sym_ext; |
244 | ||
245 | static void insert_source_line(struct sym_ext *sym_ext) | |
246 | { | |
247 | struct sym_ext *iter; | |
248 | struct rb_node **p = &root_sym_ext.rb_node; | |
249 | struct rb_node *parent = NULL; | |
250 | ||
251 | while (*p != NULL) { | |
252 | parent = *p; | |
253 | iter = rb_entry(parent, struct sym_ext, node); | |
254 | ||
255 | if (sym_ext->percent > iter->percent) | |
256 | p = &(*p)->rb_left; | |
257 | else | |
258 | p = &(*p)->rb_right; | |
259 | } | |
260 | ||
261 | rb_link_node(&sym_ext->node, parent, p); | |
262 | rb_insert_color(&sym_ext->node, &root_sym_ext); | |
263 | } | |
264 | ||
e4204992 | 265 | static void free_source_line(struct hist_entry *he, int len) |
301406b9 | 266 | { |
00a192b3 | 267 | struct sym_priv *priv = symbol__priv(he->sym); |
e4204992 | 268 | struct sym_ext *sym_ext = priv->ext; |
301406b9 FW |
269 | int i; |
270 | ||
271 | if (!sym_ext) | |
272 | return; | |
273 | ||
274 | for (i = 0; i < len; i++) | |
275 | free(sym_ext[i].path); | |
276 | free(sym_ext); | |
277 | ||
e4204992 | 278 | priv->ext = NULL; |
971738f3 | 279 | root_sym_ext = RB_ROOT; |
301406b9 FW |
280 | } |
281 | ||
282 | /* Get the filename:line for the colored entries */ | |
c17c2db1 | 283 | static void |
ed52ce2e | 284 | get_source_line(struct hist_entry *he, int len, const char *filename) |
301406b9 | 285 | { |
ed52ce2e ACM |
286 | struct symbol *sym = he->sym; |
287 | u64 start; | |
301406b9 FW |
288 | int i; |
289 | char cmd[PATH_MAX * 2]; | |
290 | struct sym_ext *sym_ext; | |
00a192b3 | 291 | struct sym_priv *priv = symbol__priv(sym); |
e4204992 | 292 | struct sym_hist *h = priv->hist; |
301406b9 | 293 | |
e4204992 | 294 | if (!h->sum) |
301406b9 FW |
295 | return; |
296 | ||
e4204992 ACM |
297 | sym_ext = priv->ext = calloc(len, sizeof(struct sym_ext)); |
298 | if (!priv->ext) | |
301406b9 FW |
299 | return; |
300 | ||
ed52ce2e | 301 | start = he->map->unmap_ip(he->map, sym->start); |
301406b9 FW |
302 | |
303 | for (i = 0; i < len; i++) { | |
304 | char *path = NULL; | |
305 | size_t line_len; | |
9cffa8d5 | 306 | u64 offset; |
301406b9 FW |
307 | FILE *fp; |
308 | ||
e4204992 | 309 | sym_ext[i].percent = 100.0 * h->ip[i] / h->sum; |
301406b9 FW |
310 | if (sym_ext[i].percent <= 0.5) |
311 | continue; | |
312 | ||
ed52ce2e | 313 | offset = start + i; |
c17c2db1 | 314 | sprintf(cmd, "addr2line -e %s %016llx", filename, offset); |
301406b9 FW |
315 | fp = popen(cmd, "r"); |
316 | if (!fp) | |
317 | continue; | |
318 | ||
319 | if (getline(&path, &line_len, fp) < 0 || !line_len) | |
320 | goto next; | |
321 | ||
c17c2db1 | 322 | sym_ext[i].path = malloc(sizeof(char) * line_len + 1); |
301406b9 FW |
323 | if (!sym_ext[i].path) |
324 | goto next; | |
325 | ||
326 | strcpy(sym_ext[i].path, path); | |
971738f3 | 327 | insert_source_line(&sym_ext[i]); |
301406b9 FW |
328 | |
329 | next: | |
330 | pclose(fp); | |
331 | } | |
332 | } | |
333 | ||
83a0944f | 334 | static void print_summary(const char *filename) |
971738f3 FW |
335 | { |
336 | struct sym_ext *sym_ext; | |
337 | struct rb_node *node; | |
338 | ||
339 | printf("\nSorted summary for file %s\n", filename); | |
340 | printf("----------------------------------------------\n\n"); | |
341 | ||
342 | if (RB_EMPTY_ROOT(&root_sym_ext)) { | |
343 | printf(" Nothing higher than %1.1f%%\n", MIN_GREEN); | |
344 | return; | |
345 | } | |
346 | ||
347 | node = rb_first(&root_sym_ext); | |
348 | while (node) { | |
349 | double percent; | |
83a0944f | 350 | const char *color; |
971738f3 FW |
351 | char *path; |
352 | ||
353 | sym_ext = rb_entry(node, struct sym_ext, node); | |
354 | percent = sym_ext->percent; | |
1e11fd82 | 355 | color = get_percent_color(percent); |
971738f3 FW |
356 | path = sym_ext->path; |
357 | ||
358 | color_fprintf(stdout, color, " %7.2f %s", percent, path); | |
359 | node = rb_next(node); | |
360 | } | |
361 | } | |
362 | ||
ed52ce2e | 363 | static void annotate_sym(struct hist_entry *he) |
0b73da3f | 364 | { |
ed52ce2e ACM |
365 | struct map *map = he->map; |
366 | struct dso *dso = map->dso; | |
367 | struct symbol *sym = he->sym; | |
439d473b ACM |
368 | const char *filename = dso->long_name, *d_filename; |
369 | u64 len; | |
0b73da3f IM |
370 | char command[PATH_MAX*2]; |
371 | FILE *file; | |
372 | ||
373 | if (!filename) | |
374 | return; | |
439d473b | 375 | |
29a9f66d ACM |
376 | pr_debug("%s: filename=%s, sym=%s, start=%#Lx, end=%#Lx\n", __func__, |
377 | filename, sym->name, map->unmap_ip(map, sym->start), | |
378 | map->unmap_ip(map, sym->end)); | |
ed52ce2e | 379 | |
42976487 MG |
380 | if (full_paths) |
381 | d_filename = filename; | |
382 | else | |
383 | d_filename = basename(filename); | |
0b73da3f | 384 | |
0b73da3f IM |
385 | len = sym->end - sym->start; |
386 | ||
971738f3 | 387 | if (print_line) { |
ed52ce2e | 388 | get_source_line(he, len, filename); |
971738f3 FW |
389 | print_summary(filename); |
390 | } | |
391 | ||
392 | printf("\n\n------------------------------------------------\n"); | |
42976487 | 393 | printf(" Percent | Source code & Disassembly of %s\n", d_filename); |
971738f3 FW |
394 | printf("------------------------------------------------\n"); |
395 | ||
396 | if (verbose >= 2) | |
439d473b ACM |
397 | printf("annotating [%p] %30s : [%p] %30s\n", |
398 | dso, dso->long_name, sym, sym->name); | |
301406b9 | 399 | |
42976487 | 400 | sprintf(command, "objdump --start-address=0x%016Lx --stop-address=0x%016Lx -dS %s|grep -v %s", |
7a2b6209 KS |
401 | map__rip_2objdump(map, sym->start), |
402 | map__rip_2objdump(map, sym->end), | |
ed52ce2e | 403 | filename, filename); |
0b73da3f IM |
404 | |
405 | if (verbose >= 3) | |
406 | printf("doing: %s\n", command); | |
407 | ||
408 | file = popen(command, "r"); | |
409 | if (!file) | |
410 | return; | |
411 | ||
412 | while (!feof(file)) { | |
ed52ce2e | 413 | if (parse_line(file, he, len) < 0) |
0b73da3f IM |
414 | break; |
415 | } | |
416 | ||
417 | pclose(file); | |
971738f3 | 418 | if (print_line) |
e4204992 | 419 | free_source_line(he, len); |
0b73da3f IM |
420 | } |
421 | ||
4e4f06e4 | 422 | static void perf_session__find_annotations(struct perf_session *self) |
0b73da3f IM |
423 | { |
424 | struct rb_node *nd; | |
0b73da3f | 425 | |
4e4f06e4 | 426 | for (nd = rb_first(&self->hists); nd; nd = rb_next(nd)) { |
ed52ce2e | 427 | struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node); |
e4204992 | 428 | struct sym_priv *priv; |
0b73da3f | 429 | |
e4204992 ACM |
430 | if (he->sym == NULL) |
431 | continue; | |
0b73da3f | 432 | |
00a192b3 | 433 | priv = symbol__priv(he->sym); |
e4204992 ACM |
434 | if (priv->hist == NULL) |
435 | continue; | |
436 | ||
437 | annotate_sym(he); | |
e4204992 ACM |
438 | /* |
439 | * Since we have a hist_entry per IP for the same symbol, free | |
440 | * he->sym->hist to signal we already processed this symbol. | |
441 | */ | |
442 | free(priv->hist); | |
443 | priv->hist = NULL; | |
0b73da3f | 444 | } |
0b73da3f IM |
445 | } |
446 | ||
301a0b02 | 447 | static struct perf_event_ops event_ops = { |
55aa640f ACM |
448 | .sample = process_sample_event, |
449 | .mmap = event__process_mmap, | |
450 | .comm = event__process_comm, | |
451 | .fork = event__process_task, | |
bab81b62 LZ |
452 | }; |
453 | ||
8035e428 IM |
454 | static int __cmd_annotate(void) |
455 | { | |
bab81b62 | 456 | int ret; |
75be6cf4 | 457 | struct perf_session *session; |
8035e428 | 458 | |
75be6cf4 | 459 | session = perf_session__new(input_name, O_RDONLY, force); |
94c744b6 ACM |
460 | if (session == NULL) |
461 | return -ENOMEM; | |
462 | ||
ec913369 | 463 | ret = perf_session__process_events(session, &event_ops); |
bab81b62 | 464 | if (ret) |
94c744b6 | 465 | goto out_delete; |
8035e428 | 466 | |
62daacb5 ACM |
467 | if (dump_trace) { |
468 | event__print_totals(); | |
94c744b6 | 469 | goto out_delete; |
62daacb5 | 470 | } |
8035e428 | 471 | |
da21d1b5 | 472 | if (verbose > 3) |
b3165f41 | 473 | perf_session__fprintf(session, stdout); |
8035e428 | 474 | |
da21d1b5 | 475 | if (verbose > 2) |
8035e428 IM |
476 | dsos__fprintf(stdout); |
477 | ||
4e4f06e4 | 478 | perf_session__collapse_resort(session); |
f823e441 | 479 | perf_session__output_resort(session, session->event_total[0]); |
4e4f06e4 | 480 | perf_session__find_annotations(session); |
94c744b6 ACM |
481 | out_delete: |
482 | perf_session__delete(session); | |
8035e428 | 483 | |
bab81b62 | 484 | return ret; |
8035e428 IM |
485 | } |
486 | ||
487 | static const char * const annotate_usage[] = { | |
488 | "perf annotate [<options>] <command>", | |
489 | NULL | |
490 | }; | |
491 | ||
492 | static const struct option options[] = { | |
493 | OPT_STRING('i', "input", &input_name, "file", | |
494 | "input file name"), | |
23b87116 | 495 | OPT_STRING('s', "symbol", &sym_hist_filter, "symbol", |
0b73da3f | 496 | "symbol to annotate"), |
fa6963b2 | 497 | OPT_BOOLEAN('f', "force", &force, "don't complain, do it"), |
8035e428 IM |
498 | OPT_BOOLEAN('v', "verbose", &verbose, |
499 | "be more verbose (show symbol address, etc)"), | |
500 | OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, | |
501 | "dump raw trace in ASCII"), | |
b32d133a ACM |
502 | OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, |
503 | "file", "vmlinux pathname"), | |
504 | OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules, | |
42976487 | 505 | "load module symbols - WARNING: use only with -k and LIVE kernel"), |
301406b9 FW |
506 | OPT_BOOLEAN('l', "print-line", &print_line, |
507 | "print matching source lines (may be slow)"), | |
42976487 MG |
508 | OPT_BOOLEAN('P', "full-paths", &full_paths, |
509 | "Don't shorten the displayed pathnames"), | |
8035e428 IM |
510 | OPT_END() |
511 | }; | |
512 | ||
f37a291c | 513 | int cmd_annotate(int argc, const char **argv, const char *prefix __used) |
8035e428 | 514 | { |
655000e7 ACM |
515 | argc = parse_options(argc, argv, options, annotate_usage, 0); |
516 | ||
75be6cf4 ACM |
517 | symbol_conf.priv_size = sizeof(struct sym_priv); |
518 | symbol_conf.try_vmlinux_path = true; | |
519 | ||
520 | if (symbol__init() < 0) | |
b32d133a | 521 | return -1; |
8035e428 | 522 | |
c8829c7a | 523 | setup_sorting(annotate_usage, options); |
8035e428 | 524 | |
0b73da3f IM |
525 | if (argc) { |
526 | /* | |
527 | * Special case: if there's an argument left then assume tha | |
528 | * it's a symbol filter: | |
529 | */ | |
530 | if (argc > 1) | |
531 | usage_with_options(annotate_usage, options); | |
532 | ||
533 | sym_hist_filter = argv[0]; | |
534 | } | |
535 | ||
8035e428 IM |
536 | setup_pager(); |
537 | ||
dd68ada2 | 538 | if (field_sep && *field_sep == '.') { |
29a9f66d ACM |
539 | pr_err("'.' is the only non valid --field-separator argument\n"); |
540 | return -1; | |
dd68ada2 JK |
541 | } |
542 | ||
8035e428 IM |
543 | return __cmd_annotate(); |
544 | } |