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