~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/tools/perf/util/annotate.c

Version: ~ [ linux-5.10-rc1 ] ~ [ linux-5.9.1 ] ~ [ linux-5.8.16 ] ~ [ linux-5.7.19 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.72 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.152 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.202 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.240 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.240 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.85 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 // SPDX-License-Identifier: GPL-2.0-only
  2 /*
  3  * Copyright (C) 2011, Red Hat Inc, Arnaldo Carvalho de Melo <acme@redhat.com>
  4  *
  5  * Parts came from builtin-annotate.c, see those files for further
  6  * copyright notes.
  7  */
  8 
  9 #include <errno.h>
 10 #include <inttypes.h>
 11 #include <libgen.h>
 12 #include <bpf/bpf.h>
 13 #include <bpf/btf.h>
 14 #include <bpf/libbpf.h>
 15 #include <linux/btf.h>
 16 #include "util.h"
 17 #include "ui/ui.h"
 18 #include "sort.h"
 19 #include "build-id.h"
 20 #include "color.h"
 21 #include "config.h"
 22 #include "cache.h"
 23 #include "map.h"
 24 #include "symbol.h"
 25 #include "units.h"
 26 #include "debug.h"
 27 #include "annotate.h"
 28 #include "evsel.h"
 29 #include "evlist.h"
 30 #include "bpf-event.h"
 31 #include "block-range.h"
 32 #include "string2.h"
 33 #include "arch/common.h"
 34 #include <regex.h>
 35 #include <pthread.h>
 36 #include <linux/bitops.h>
 37 #include <linux/kernel.h>
 38 #include <linux/string.h>
 39 #include <bpf/libbpf.h>
 40 
 41 /* FIXME: For the HE_COLORSET */
 42 #include "ui/browser.h"
 43 
 44 /*
 45  * FIXME: Using the same values as slang.h,
 46  * but that header may not be available everywhere
 47  */
 48 #define LARROW_CHAR     ((unsigned char)',')
 49 #define RARROW_CHAR     ((unsigned char)'+')
 50 #define DARROW_CHAR     ((unsigned char)'.')
 51 #define UARROW_CHAR     ((unsigned char)'-')
 52 
 53 #include <linux/ctype.h>
 54 
 55 struct annotation_options annotation__default_options = {
 56         .use_offset     = true,
 57         .jump_arrows    = true,
 58         .annotate_src   = true,
 59         .offset_level   = ANNOTATION__OFFSET_JUMP_TARGETS,
 60         .percent_type   = PERCENT_PERIOD_LOCAL,
 61 };
 62 
 63 static regex_t   file_lineno;
 64 
 65 static struct ins_ops *ins__find(struct arch *arch, const char *name);
 66 static void ins__sort(struct arch *arch);
 67 static int disasm_line__parse(char *line, const char **namep, char **rawp);
 68 
 69 struct arch {
 70         const char      *name;
 71         struct ins      *instructions;
 72         size_t          nr_instructions;
 73         size_t          nr_instructions_allocated;
 74         struct ins_ops  *(*associate_instruction_ops)(struct arch *arch, const char *name);
 75         bool            sorted_instructions;
 76         bool            initialized;
 77         void            *priv;
 78         unsigned int    model;
 79         unsigned int    family;
 80         int             (*init)(struct arch *arch, char *cpuid);
 81         bool            (*ins_is_fused)(struct arch *arch, const char *ins1,
 82                                         const char *ins2);
 83         struct          {
 84                 char comment_char;
 85                 char skip_functions_char;
 86         } objdump;
 87 };
 88 
 89 static struct ins_ops call_ops;
 90 static struct ins_ops dec_ops;
 91 static struct ins_ops jump_ops;
 92 static struct ins_ops mov_ops;
 93 static struct ins_ops nop_ops;
 94 static struct ins_ops lock_ops;
 95 static struct ins_ops ret_ops;
 96 
 97 static int arch__grow_instructions(struct arch *arch)
 98 {
 99         struct ins *new_instructions;
100         size_t new_nr_allocated;
101 
102         if (arch->nr_instructions_allocated == 0 && arch->instructions)
103                 goto grow_from_non_allocated_table;
104 
105         new_nr_allocated = arch->nr_instructions_allocated + 128;
106         new_instructions = realloc(arch->instructions, new_nr_allocated * sizeof(struct ins));
107         if (new_instructions == NULL)
108                 return -1;
109 
110 out_update_instructions:
111         arch->instructions = new_instructions;
112         arch->nr_instructions_allocated = new_nr_allocated;
113         return 0;
114 
115 grow_from_non_allocated_table:
116         new_nr_allocated = arch->nr_instructions + 128;
117         new_instructions = calloc(new_nr_allocated, sizeof(struct ins));
118         if (new_instructions == NULL)
119                 return -1;
120 
121         memcpy(new_instructions, arch->instructions, arch->nr_instructions);
122         goto out_update_instructions;
123 }
124 
125 static int arch__associate_ins_ops(struct arch* arch, const char *name, struct ins_ops *ops)
126 {
127         struct ins *ins;
128 
129         if (arch->nr_instructions == arch->nr_instructions_allocated &&
130             arch__grow_instructions(arch))
131                 return -1;
132 
133         ins = &arch->instructions[arch->nr_instructions];
134         ins->name = strdup(name);
135         if (!ins->name)
136                 return -1;
137 
138         ins->ops  = ops;
139         arch->nr_instructions++;
140 
141         ins__sort(arch);
142         return 0;
143 }
144 
145 #include "arch/arc/annotate/instructions.c"
146 #include "arch/arm/annotate/instructions.c"
147 #include "arch/arm64/annotate/instructions.c"
148 #include "arch/csky/annotate/instructions.c"
149 #include "arch/x86/annotate/instructions.c"
150 #include "arch/powerpc/annotate/instructions.c"
151 #include "arch/s390/annotate/instructions.c"
152 #include "arch/sparc/annotate/instructions.c"
153 
154 static struct arch architectures[] = {
155         {
156                 .name = "arc",
157                 .init = arc__annotate_init,
158         },
159         {
160                 .name = "arm",
161                 .init = arm__annotate_init,
162         },
163         {
164                 .name = "arm64",
165                 .init = arm64__annotate_init,
166         },
167         {
168                 .name = "csky",
169                 .init = csky__annotate_init,
170         },
171         {
172                 .name = "x86",
173                 .init = x86__annotate_init,
174                 .instructions = x86__instructions,
175                 .nr_instructions = ARRAY_SIZE(x86__instructions),
176                 .ins_is_fused = x86__ins_is_fused,
177                 .objdump =  {
178                         .comment_char = '#',
179                 },
180         },
181         {
182                 .name = "powerpc",
183                 .init = powerpc__annotate_init,
184         },
185         {
186                 .name = "s390",
187                 .init = s390__annotate_init,
188                 .objdump =  {
189                         .comment_char = '#',
190                 },
191         },
192         {
193                 .name = "sparc",
194                 .init = sparc__annotate_init,
195                 .objdump = {
196                         .comment_char = '#',
197                 },
198         },
199 };
200 
201 static void ins__delete(struct ins_operands *ops)
202 {
203         if (ops == NULL)
204                 return;
205         zfree(&ops->source.raw);
206         zfree(&ops->source.name);
207         zfree(&ops->target.raw);
208         zfree(&ops->target.name);
209 }
210 
211 static int ins__raw_scnprintf(struct ins *ins, char *bf, size_t size,
212                               struct ins_operands *ops, int max_ins_name)
213 {
214         return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->raw);
215 }
216 
217 int ins__scnprintf(struct ins *ins, char *bf, size_t size,
218                    struct ins_operands *ops, int max_ins_name)
219 {
220         if (ins->ops->scnprintf)
221                 return ins->ops->scnprintf(ins, bf, size, ops, max_ins_name);
222 
223         return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
224 }
225 
226 bool ins__is_fused(struct arch *arch, const char *ins1, const char *ins2)
227 {
228         if (!arch || !arch->ins_is_fused)
229                 return false;
230 
231         return arch->ins_is_fused(arch, ins1, ins2);
232 }
233 
234 static int call__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
235 {
236         char *endptr, *tok, *name;
237         struct map *map = ms->map;
238         struct addr_map_symbol target = {
239                 .map = map,
240         };
241 
242         ops->target.addr = strtoull(ops->raw, &endptr, 16);
243 
244         name = strchr(endptr, '<');
245         if (name == NULL)
246                 goto indirect_call;
247 
248         name++;
249 
250         if (arch->objdump.skip_functions_char &&
251             strchr(name, arch->objdump.skip_functions_char))
252                 return -1;
253 
254         tok = strchr(name, '>');
255         if (tok == NULL)
256                 return -1;
257 
258         *tok = '\0';
259         ops->target.name = strdup(name);
260         *tok = '>';
261 
262         if (ops->target.name == NULL)
263                 return -1;
264 find_target:
265         target.addr = map__objdump_2mem(map, ops->target.addr);
266 
267         if (map_groups__find_ams(&target) == 0 &&
268             map__rip_2objdump(target.map, map->map_ip(target.map, target.addr)) == ops->target.addr)
269                 ops->target.sym = target.sym;
270 
271         return 0;
272 
273 indirect_call:
274         tok = strchr(endptr, '*');
275         if (tok != NULL) {
276                 endptr++;
277 
278                 /* Indirect call can use a non-rip register and offset: callq  *0x8(%rbx).
279                  * Do not parse such instruction.  */
280                 if (strstr(endptr, "(%r") == NULL)
281                         ops->target.addr = strtoull(endptr, NULL, 16);
282         }
283         goto find_target;
284 }
285 
286 static int call__scnprintf(struct ins *ins, char *bf, size_t size,
287                            struct ins_operands *ops, int max_ins_name)
288 {
289         if (ops->target.sym)
290                 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
291 
292         if (ops->target.addr == 0)
293                 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
294 
295         if (ops->target.name)
296                 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.name);
297 
298         return scnprintf(bf, size, "%-*s *%" PRIx64, max_ins_name, ins->name, ops->target.addr);
299 }
300 
301 static struct ins_ops call_ops = {
302         .parse     = call__parse,
303         .scnprintf = call__scnprintf,
304 };
305 
306 bool ins__is_call(const struct ins *ins)
307 {
308         return ins->ops == &call_ops || ins->ops == &s390_call_ops;
309 }
310 
311 /*
312  * Prevents from matching commas in the comment section, e.g.:
313  * ffff200008446e70:       b.cs    ffff2000084470f4 <generic_exec_single+0x314>  // b.hs, b.nlast
314  */
315 static inline const char *validate_comma(const char *c, struct ins_operands *ops)
316 {
317         if (ops->raw_comment && c > ops->raw_comment)
318                 return NULL;
319 
320         return c;
321 }
322 
323 static int jump__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
324 {
325         struct map *map = ms->map;
326         struct symbol *sym = ms->sym;
327         struct addr_map_symbol target = {
328                 .map = map,
329         };
330         const char *c = strchr(ops->raw, ',');
331         u64 start, end;
332 
333         ops->raw_comment = strchr(ops->raw, arch->objdump.comment_char);
334         c = validate_comma(c, ops);
335 
336         /*
337          * Examples of lines to parse for the _cpp_lex_token@@Base
338          * function:
339          *
340          * 1159e6c: jne    115aa32 <_cpp_lex_token@@Base+0xf92>
341          * 1159e8b: jne    c469be <cpp_named_operator2name@@Base+0xa72>
342          *
343          * The first is a jump to an offset inside the same function,
344          * the second is to another function, i.e. that 0xa72 is an
345          * offset in the cpp_named_operator2name@@base function.
346          */
347         /*
348          * skip over possible up to 2 operands to get to address, e.g.:
349          * tbnz  w0, #26, ffff0000083cd190 <security_file_permission+0xd0>
350          */
351         if (c++ != NULL) {
352                 ops->target.addr = strtoull(c, NULL, 16);
353                 if (!ops->target.addr) {
354                         c = strchr(c, ',');
355                         c = validate_comma(c, ops);
356                         if (c++ != NULL)
357                                 ops->target.addr = strtoull(c, NULL, 16);
358                 }
359         } else {
360                 ops->target.addr = strtoull(ops->raw, NULL, 16);
361         }
362 
363         target.addr = map__objdump_2mem(map, ops->target.addr);
364         start = map->unmap_ip(map, sym->start),
365         end = map->unmap_ip(map, sym->end);
366 
367         ops->target.outside = target.addr < start || target.addr > end;
368 
369         /*
370          * FIXME: things like this in _cpp_lex_token (gcc's cc1 program):
371 
372                 cpp_named_operator2name@@Base+0xa72
373 
374          * Point to a place that is after the cpp_named_operator2name
375          * boundaries, i.e.  in the ELF symbol table for cc1
376          * cpp_named_operator2name is marked as being 32-bytes long, but it in
377          * fact is much larger than that, so we seem to need a symbols__find()
378          * routine that looks for >= current->start and  < next_symbol->start,
379          * possibly just for C++ objects?
380          *
381          * For now lets just make some progress by marking jumps to outside the
382          * current function as call like.
383          *
384          * Actual navigation will come next, with further understanding of how
385          * the symbol searching and disassembly should be done.
386          */
387         if (map_groups__find_ams(&target) == 0 &&
388             map__rip_2objdump(target.map, map->map_ip(target.map, target.addr)) == ops->target.addr)
389                 ops->target.sym = target.sym;
390 
391         if (!ops->target.outside) {
392                 ops->target.offset = target.addr - start;
393                 ops->target.offset_avail = true;
394         } else {
395                 ops->target.offset_avail = false;
396         }
397 
398         return 0;
399 }
400 
401 static int jump__scnprintf(struct ins *ins, char *bf, size_t size,
402                            struct ins_operands *ops, int max_ins_name)
403 {
404         const char *c;
405 
406         if (!ops->target.addr || ops->target.offset < 0)
407                 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
408 
409         if (ops->target.outside && ops->target.sym != NULL)
410                 return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name, ops->target.sym->name);
411 
412         c = strchr(ops->raw, ',');
413         c = validate_comma(c, ops);
414 
415         if (c != NULL) {
416                 const char *c2 = strchr(c + 1, ',');
417 
418                 c2 = validate_comma(c2, ops);
419                 /* check for 3-op insn */
420                 if (c2 != NULL)
421                         c = c2;
422                 c++;
423 
424                 /* mirror arch objdump's space-after-comma style */
425                 if (*c == ' ')
426                         c++;
427         }
428 
429         return scnprintf(bf, size, "%-*s %.*s%" PRIx64, max_ins_name,
430                          ins->name, c ? c - ops->raw : 0, ops->raw,
431                          ops->target.offset);
432 }
433 
434 static struct ins_ops jump_ops = {
435         .parse     = jump__parse,
436         .scnprintf = jump__scnprintf,
437 };
438 
439 bool ins__is_jump(const struct ins *ins)
440 {
441         return ins->ops == &jump_ops;
442 }
443 
444 static int comment__symbol(char *raw, char *comment, u64 *addrp, char **namep)
445 {
446         char *endptr, *name, *t;
447 
448         if (strstr(raw, "(%rip)") == NULL)
449                 return 0;
450 
451         *addrp = strtoull(comment, &endptr, 16);
452         if (endptr == comment)
453                 return 0;
454         name = strchr(endptr, '<');
455         if (name == NULL)
456                 return -1;
457 
458         name++;
459 
460         t = strchr(name, '>');
461         if (t == NULL)
462                 return 0;
463 
464         *t = '\0';
465         *namep = strdup(name);
466         *t = '>';
467 
468         return 0;
469 }
470 
471 static int lock__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms)
472 {
473         ops->locked.ops = zalloc(sizeof(*ops->locked.ops));
474         if (ops->locked.ops == NULL)
475                 return 0;
476 
477         if (disasm_line__parse(ops->raw, &ops->locked.ins.name, &ops->locked.ops->raw) < 0)
478                 goto out_free_ops;
479 
480         ops->locked.ins.ops = ins__find(arch, ops->locked.ins.name);
481 
482         if (ops->locked.ins.ops == NULL)
483                 goto out_free_ops;
484 
485         if (ops->locked.ins.ops->parse &&
486             ops->locked.ins.ops->parse(arch, ops->locked.ops, ms) < 0)
487                 goto out_free_ops;
488 
489         return 0;
490 
491 out_free_ops:
492         zfree(&ops->locked.ops);
493         return 0;
494 }
495 
496 static int lock__scnprintf(struct ins *ins, char *bf, size_t size,
497                            struct ins_operands *ops, int max_ins_name)
498 {
499         int printed;
500 
501         if (ops->locked.ins.ops == NULL)
502                 return ins__raw_scnprintf(ins, bf, size, ops, max_ins_name);
503 
504         printed = scnprintf(bf, size, "%-*s ", max_ins_name, ins->name);
505         return printed + ins__scnprintf(&ops->locked.ins, bf + printed,
506                                         size - printed, ops->locked.ops, max_ins_name);
507 }
508 
509 static void lock__delete(struct ins_operands *ops)
510 {
511         struct ins *ins = &ops->locked.ins;
512 
513         if (ins->ops && ins->ops->free)
514                 ins->ops->free(ops->locked.ops);
515         else
516                 ins__delete(ops->locked.ops);
517 
518         zfree(&ops->locked.ops);
519         zfree(&ops->target.raw);
520         zfree(&ops->target.name);
521 }
522 
523 static struct ins_ops lock_ops = {
524         .free      = lock__delete,
525         .parse     = lock__parse,
526         .scnprintf = lock__scnprintf,
527 };
528 
529 static int mov__parse(struct arch *arch, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
530 {
531         char *s = strchr(ops->raw, ','), *target, *comment, prev;
532 
533         if (s == NULL)
534                 return -1;
535 
536         *s = '\0';
537         ops->source.raw = strdup(ops->raw);
538         *s = ',';
539 
540         if (ops->source.raw == NULL)
541                 return -1;
542 
543         target = ++s;
544         comment = strchr(s, arch->objdump.comment_char);
545 
546         if (comment != NULL)
547                 s = comment - 1;
548         else
549                 s = strchr(s, '\0') - 1;
550 
551         while (s > target && isspace(s[0]))
552                 --s;
553         s++;
554         prev = *s;
555         *s = '\0';
556 
557         ops->target.raw = strdup(target);
558         *s = prev;
559 
560         if (ops->target.raw == NULL)
561                 goto out_free_source;
562 
563         if (comment == NULL)
564                 return 0;
565 
566         comment = skip_spaces(comment);
567         comment__symbol(ops->source.raw, comment + 1, &ops->source.addr, &ops->source.name);
568         comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
569 
570         return 0;
571 
572 out_free_source:
573         zfree(&ops->source.raw);
574         return -1;
575 }
576 
577 static int mov__scnprintf(struct ins *ins, char *bf, size_t size,
578                            struct ins_operands *ops, int max_ins_name)
579 {
580         return scnprintf(bf, size, "%-*s %s,%s", max_ins_name, ins->name,
581                          ops->source.name ?: ops->source.raw,
582                          ops->target.name ?: ops->target.raw);
583 }
584 
585 static struct ins_ops mov_ops = {
586         .parse     = mov__parse,
587         .scnprintf = mov__scnprintf,
588 };
589 
590 static int dec__parse(struct arch *arch __maybe_unused, struct ins_operands *ops, struct map_symbol *ms __maybe_unused)
591 {
592         char *target, *comment, *s, prev;
593 
594         target = s = ops->raw;
595 
596         while (s[0] != '\0' && !isspace(s[0]))
597                 ++s;
598         prev = *s;
599         *s = '\0';
600 
601         ops->target.raw = strdup(target);
602         *s = prev;
603 
604         if (ops->target.raw == NULL)
605                 return -1;
606 
607         comment = strchr(s, arch->objdump.comment_char);
608         if (comment == NULL)
609                 return 0;
610 
611         comment = skip_spaces(comment);
612         comment__symbol(ops->target.raw, comment + 1, &ops->target.addr, &ops->target.name);
613 
614         return 0;
615 }
616 
617 static int dec__scnprintf(struct ins *ins, char *bf, size_t size,
618                            struct ins_operands *ops, int max_ins_name)
619 {
620         return scnprintf(bf, size, "%-*s %s", max_ins_name, ins->name,
621                          ops->target.name ?: ops->target.raw);
622 }
623 
624 static struct ins_ops dec_ops = {
625         .parse     = dec__parse,
626         .scnprintf = dec__scnprintf,
627 };
628 
629 static int nop__scnprintf(struct ins *ins __maybe_unused, char *bf, size_t size,
630                           struct ins_operands *ops __maybe_unused, int max_ins_name)
631 {
632         return scnprintf(bf, size, "%-*s", max_ins_name, "nop");
633 }
634 
635 static struct ins_ops nop_ops = {
636         .scnprintf = nop__scnprintf,
637 };
638 
639 static struct ins_ops ret_ops = {
640         .scnprintf = ins__raw_scnprintf,
641 };
642 
643 bool ins__is_ret(const struct ins *ins)
644 {
645         return ins->ops == &ret_ops;
646 }
647 
648 bool ins__is_lock(const struct ins *ins)
649 {
650         return ins->ops == &lock_ops;
651 }
652 
653 static int ins__key_cmp(const void *name, const void *insp)
654 {
655         const struct ins *ins = insp;
656 
657         return strcmp(name, ins->name);
658 }
659 
660 static int ins__cmp(const void *a, const void *b)
661 {
662         const struct ins *ia = a;
663         const struct ins *ib = b;
664 
665         return strcmp(ia->name, ib->name);
666 }
667 
668 static void ins__sort(struct arch *arch)
669 {
670         const int nmemb = arch->nr_instructions;
671 
672         qsort(arch->instructions, nmemb, sizeof(struct ins), ins__cmp);
673 }
674 
675 static struct ins_ops *__ins__find(struct arch *arch, const char *name)
676 {
677         struct ins *ins;
678         const int nmemb = arch->nr_instructions;
679 
680         if (!arch->sorted_instructions) {
681                 ins__sort(arch);
682                 arch->sorted_instructions = true;
683         }
684 
685         ins = bsearch(name, arch->instructions, nmemb, sizeof(struct ins), ins__key_cmp);
686         return ins ? ins->ops : NULL;
687 }
688 
689 static struct ins_ops *ins__find(struct arch *arch, const char *name)
690 {
691         struct ins_ops *ops = __ins__find(arch, name);
692 
693         if (!ops && arch->associate_instruction_ops)
694                 ops = arch->associate_instruction_ops(arch, name);
695 
696         return ops;
697 }
698 
699 static int arch__key_cmp(const void *name, const void *archp)
700 {
701         const struct arch *arch = archp;
702 
703         return strcmp(name, arch->name);
704 }
705 
706 static int arch__cmp(const void *a, const void *b)
707 {
708         const struct arch *aa = a;
709         const struct arch *ab = b;
710 
711         return strcmp(aa->name, ab->name);
712 }
713 
714 static void arch__sort(void)
715 {
716         const int nmemb = ARRAY_SIZE(architectures);
717 
718         qsort(architectures, nmemb, sizeof(struct arch), arch__cmp);
719 }
720 
721 static struct arch *arch__find(const char *name)
722 {
723         const int nmemb = ARRAY_SIZE(architectures);
724         static bool sorted;
725 
726         if (!sorted) {
727                 arch__sort();
728                 sorted = true;
729         }
730 
731         return bsearch(name, architectures, nmemb, sizeof(struct arch), arch__key_cmp);
732 }
733 
734 static struct annotated_source *annotated_source__new(void)
735 {
736         struct annotated_source *src = zalloc(sizeof(*src));
737 
738         if (src != NULL)
739                 INIT_LIST_HEAD(&src->source);
740 
741         return src;
742 }
743 
744 static __maybe_unused void annotated_source__delete(struct annotated_source *src)
745 {
746         if (src == NULL)
747                 return;
748         zfree(&src->histograms);
749         zfree(&src->cycles_hist);
750         free(src);
751 }
752 
753 static int annotated_source__alloc_histograms(struct annotated_source *src,
754                                               size_t size, int nr_hists)
755 {
756         size_t sizeof_sym_hist;
757 
758         /*
759          * Add buffer of one element for zero length symbol.
760          * When sample is taken from first instruction of
761          * zero length symbol, perf still resolves it and
762          * shows symbol name in perf report and allows to
763          * annotate it.
764          */
765         if (size == 0)
766                 size = 1;
767 
768         /* Check for overflow when calculating sizeof_sym_hist */
769         if (size > (SIZE_MAX - sizeof(struct sym_hist)) / sizeof(struct sym_hist_entry))
770                 return -1;
771 
772         sizeof_sym_hist = (sizeof(struct sym_hist) + size * sizeof(struct sym_hist_entry));
773 
774         /* Check for overflow in zalloc argument */
775         if (sizeof_sym_hist > SIZE_MAX / nr_hists)
776                 return -1;
777 
778         src->sizeof_sym_hist = sizeof_sym_hist;
779         src->nr_histograms   = nr_hists;
780         src->histograms      = calloc(nr_hists, sizeof_sym_hist) ;
781         return src->histograms ? 0 : -1;
782 }
783 
784 /* The cycles histogram is lazily allocated. */
785 static int symbol__alloc_hist_cycles(struct symbol *sym)
786 {
787         struct annotation *notes = symbol__annotation(sym);
788         const size_t size = symbol__size(sym);
789 
790         notes->src->cycles_hist = calloc(size, sizeof(struct cyc_hist));
791         if (notes->src->cycles_hist == NULL)
792                 return -1;
793         return 0;
794 }
795 
796 void symbol__annotate_zero_histograms(struct symbol *sym)
797 {
798         struct annotation *notes = symbol__annotation(sym);
799 
800         pthread_mutex_lock(&notes->lock);
801         if (notes->src != NULL) {
802                 memset(notes->src->histograms, 0,
803                        notes->src->nr_histograms * notes->src->sizeof_sym_hist);
804                 if (notes->src->cycles_hist)
805                         memset(notes->src->cycles_hist, 0,
806                                 symbol__size(sym) * sizeof(struct cyc_hist));
807         }
808         pthread_mutex_unlock(&notes->lock);
809 }
810 
811 static int __symbol__account_cycles(struct cyc_hist *ch,
812                                     u64 start,
813                                     unsigned offset, unsigned cycles,
814                                     unsigned have_start)
815 {
816         /*
817          * For now we can only account one basic block per
818          * final jump. But multiple could be overlapping.
819          * Always account the longest one. So when
820          * a shorter one has been already seen throw it away.
821          *
822          * We separately always account the full cycles.
823          */
824         ch[offset].num_aggr++;
825         ch[offset].cycles_aggr += cycles;
826 
827         if (cycles > ch[offset].cycles_max)
828                 ch[offset].cycles_max = cycles;
829 
830         if (ch[offset].cycles_min) {
831                 if (cycles && cycles < ch[offset].cycles_min)
832                         ch[offset].cycles_min = cycles;
833         } else
834                 ch[offset].cycles_min = cycles;
835 
836         if (!have_start && ch[offset].have_start)
837                 return 0;
838         if (ch[offset].num) {
839                 if (have_start && (!ch[offset].have_start ||
840                                    ch[offset].start > start)) {
841                         ch[offset].have_start = 0;
842                         ch[offset].cycles = 0;
843                         ch[offset].num = 0;
844                         if (ch[offset].reset < 0xffff)
845                                 ch[offset].reset++;
846                 } else if (have_start &&
847                            ch[offset].start < start)
848                         return 0;
849         }
850         ch[offset].have_start = have_start;
851         ch[offset].start = start;
852         ch[offset].cycles += cycles;
853         ch[offset].num++;
854         return 0;
855 }
856 
857 static int __symbol__inc_addr_samples(struct symbol *sym, struct map *map,
858                                       struct annotated_source *src, int evidx, u64 addr,
859                                       struct perf_sample *sample)
860 {
861         unsigned offset;
862         struct sym_hist *h;
863 
864         pr_debug3("%s: addr=%#" PRIx64 "\n", __func__, map->unmap_ip(map, addr));
865 
866         if ((addr < sym->start || addr >= sym->end) &&
867             (addr != sym->end || sym->start != sym->end)) {
868                 pr_debug("%s(%d): ERANGE! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 "\n",
869                        __func__, __LINE__, sym->name, sym->start, addr, sym->end);
870                 return -ERANGE;
871         }
872 
873         offset = addr - sym->start;
874         h = annotated_source__histogram(src, evidx);
875         if (h == NULL) {
876                 pr_debug("%s(%d): ENOMEM! sym->name=%s, start=%#" PRIx64 ", addr=%#" PRIx64 ", end=%#" PRIx64 ", func: %d\n",
877                          __func__, __LINE__, sym->name, sym->start, addr, sym->end, sym->type == STT_FUNC);
878                 return -ENOMEM;
879         }
880         h->nr_samples++;
881         h->addr[offset].nr_samples++;
882         h->period += sample->period;
883         h->addr[offset].period += sample->period;
884 
885         pr_debug3("%#" PRIx64 " %s: period++ [addr: %#" PRIx64 ", %#" PRIx64
886                   ", evidx=%d] => nr_samples: %" PRIu64 ", period: %" PRIu64 "\n",
887                   sym->start, sym->name, addr, addr - sym->start, evidx,
888                   h->addr[offset].nr_samples, h->addr[offset].period);
889         return 0;
890 }
891 
892 static struct cyc_hist *symbol__cycles_hist(struct symbol *sym)
893 {
894         struct annotation *notes = symbol__annotation(sym);
895 
896         if (notes->src == NULL) {
897                 notes->src = annotated_source__new();
898                 if (notes->src == NULL)
899                         return NULL;
900                 goto alloc_cycles_hist;
901         }
902 
903         if (!notes->src->cycles_hist) {
904 alloc_cycles_hist:
905                 symbol__alloc_hist_cycles(sym);
906         }
907 
908         return notes->src->cycles_hist;
909 }
910 
911 struct annotated_source *symbol__hists(struct symbol *sym, int nr_hists)
912 {
913         struct annotation *notes = symbol__annotation(sym);
914 
915         if (notes->src == NULL) {
916                 notes->src = annotated_source__new();
917                 if (notes->src == NULL)
918                         return NULL;
919                 goto alloc_histograms;
920         }
921 
922         if (notes->src->histograms == NULL) {
923 alloc_histograms:
924                 annotated_source__alloc_histograms(notes->src, symbol__size(sym),
925                                                    nr_hists);
926         }
927 
928         return notes->src;
929 }
930 
931 static int symbol__inc_addr_samples(struct symbol *sym, struct map *map,
932                                     struct perf_evsel *evsel, u64 addr,
933                                     struct perf_sample *sample)
934 {
935         struct annotated_source *src;
936 
937         if (sym == NULL)
938                 return 0;
939         src = symbol__hists(sym, evsel->evlist->nr_entries);
940         return (src) ?  __symbol__inc_addr_samples(sym, map, src, evsel->idx,
941                                                    addr, sample) : 0;
942 }
943 
944 static int symbol__account_cycles(u64 addr, u64 start,
945                                   struct symbol *sym, unsigned cycles)
946 {
947         struct cyc_hist *cycles_hist;
948         unsigned offset;
949 
950         if (sym == NULL)
951                 return 0;
952         cycles_hist = symbol__cycles_hist(sym);
953         if (cycles_hist == NULL)
954                 return -ENOMEM;
955         if (addr < sym->start || addr >= sym->end)
956                 return -ERANGE;
957 
958         if (start) {
959                 if (start < sym->start || start >= sym->end)
960                         return -ERANGE;
961                 if (start >= addr)
962                         start = 0;
963         }
964         offset = addr - sym->start;
965         return __symbol__account_cycles(cycles_hist,
966                                         start ? start - sym->start : 0,
967                                         offset, cycles,
968                                         !!start);
969 }
970 
971 int addr_map_symbol__account_cycles(struct addr_map_symbol *ams,
972                                     struct addr_map_symbol *start,
973                                     unsigned cycles)
974 {
975         u64 saddr = 0;
976         int err;
977 
978         if (!cycles)
979                 return 0;
980 
981         /*
982          * Only set start when IPC can be computed. We can only
983          * compute it when the basic block is completely in a single
984          * function.
985          * Special case the case when the jump is elsewhere, but
986          * it starts on the function start.
987          */
988         if (start &&
989                 (start->sym == ams->sym ||
990                  (ams->sym &&
991                    start->addr == ams->sym->start + ams->map->start)))
992                 saddr = start->al_addr;
993         if (saddr == 0)
994                 pr_debug2("BB with bad start: addr %"PRIx64" start %"PRIx64" sym %"PRIx64" saddr %"PRIx64"\n",
995                         ams->addr,
996                         start ? start->addr : 0,
997                         ams->sym ? ams->sym->start + ams->map->start : 0,
998                         saddr);
999         err = symbol__account_cycles(ams->al_addr, saddr, ams->sym, cycles);
1000         if (err)
1001                 pr_debug2("account_cycles failed %d\n", err);
1002         return err;
1003 }
1004 
1005 static unsigned annotation__count_insn(struct annotation *notes, u64 start, u64 end)
1006 {
1007         unsigned n_insn = 0;
1008         u64 offset;
1009 
1010         for (offset = start; offset <= end; offset++) {
1011                 if (notes->offsets[offset])
1012                         n_insn++;
1013         }
1014         return n_insn;
1015 }
1016 
1017 static void annotation__count_and_fill(struct annotation *notes, u64 start, u64 end, struct cyc_hist *ch)
1018 {
1019         unsigned n_insn;
1020         unsigned int cover_insn = 0;
1021         u64 offset;
1022 
1023         n_insn = annotation__count_insn(notes, start, end);
1024         if (n_insn && ch->num && ch->cycles) {
1025                 float ipc = n_insn / ((double)ch->cycles / (double)ch->num);
1026 
1027                 /* Hide data when there are too many overlaps. */
1028                 if (ch->reset >= 0x7fff)
1029                         return;
1030 
1031                 for (offset = start; offset <= end; offset++) {
1032                         struct annotation_line *al = notes->offsets[offset];
1033 
1034                         if (al && al->ipc == 0.0) {
1035                                 al->ipc = ipc;
1036                                 cover_insn++;
1037                         }
1038                 }
1039 
1040                 if (cover_insn) {
1041                         notes->hit_cycles += ch->cycles;
1042                         notes->hit_insn += n_insn * ch->num;
1043                         notes->cover_insn += cover_insn;
1044                 }
1045         }
1046 }
1047 
1048 void annotation__compute_ipc(struct annotation *notes, size_t size)
1049 {
1050         s64 offset;
1051 
1052         if (!notes->src || !notes->src->cycles_hist)
1053                 return;
1054 
1055         notes->total_insn = annotation__count_insn(notes, 0, size - 1);
1056         notes->hit_cycles = 0;
1057         notes->hit_insn = 0;
1058         notes->cover_insn = 0;
1059 
1060         pthread_mutex_lock(&notes->lock);
1061         for (offset = size - 1; offset >= 0; --offset) {
1062                 struct cyc_hist *ch;
1063 
1064                 ch = &notes->src->cycles_hist[offset];
1065                 if (ch && ch->cycles) {
1066                         struct annotation_line *al;
1067 
1068                         if (ch->have_start)
1069                                 annotation__count_and_fill(notes, ch->start, offset, ch);
1070                         al = notes->offsets[offset];
1071                         if (al && ch->num_aggr) {
1072                                 al->cycles = ch->cycles_aggr / ch->num_aggr;
1073                                 al->cycles_max = ch->cycles_max;
1074                                 al->cycles_min = ch->cycles_min;
1075                         }
1076                         notes->have_cycles = true;
1077                 }
1078         }
1079         pthread_mutex_unlock(&notes->lock);
1080 }
1081 
1082 int addr_map_symbol__inc_samples(struct addr_map_symbol *ams, struct perf_sample *sample,
1083                                  struct perf_evsel *evsel)
1084 {
1085         return symbol__inc_addr_samples(ams->sym, ams->map, evsel, ams->al_addr, sample);
1086 }
1087 
1088 int hist_entry__inc_addr_samples(struct hist_entry *he, struct perf_sample *sample,
1089                                  struct perf_evsel *evsel, u64 ip)
1090 {
1091         return symbol__inc_addr_samples(he->ms.sym, he->ms.map, evsel, ip, sample);
1092 }
1093 
1094 static void disasm_line__init_ins(struct disasm_line *dl, struct arch *arch, struct map_symbol *ms)
1095 {
1096         dl->ins.ops = ins__find(arch, dl->ins.name);
1097 
1098         if (!dl->ins.ops)
1099                 return;
1100 
1101         if (dl->ins.ops->parse && dl->ins.ops->parse(arch, &dl->ops, ms) < 0)
1102                 dl->ins.ops = NULL;
1103 }
1104 
1105 static int disasm_line__parse(char *line, const char **namep, char **rawp)
1106 {
1107         char tmp, *name = skip_spaces(line);
1108 
1109         if (name[0] == '\0')
1110                 return -1;
1111 
1112         *rawp = name + 1;
1113 
1114         while ((*rawp)[0] != '\0' && !isspace((*rawp)[0]))
1115                 ++*rawp;
1116 
1117         tmp = (*rawp)[0];
1118         (*rawp)[0] = '\0';
1119         *namep = strdup(name);
1120 
1121         if (*namep == NULL)
1122                 goto out;
1123 
1124         (*rawp)[0] = tmp;
1125         *rawp = strim(*rawp);
1126 
1127         return 0;
1128 
1129 out:
1130         return -1;
1131 }
1132 
1133 struct annotate_args {
1134         size_t                   privsize;
1135         struct arch             *arch;
1136         struct map_symbol        ms;
1137         struct perf_evsel       *evsel;
1138         struct annotation_options *options;
1139         s64                      offset;
1140         char                    *line;
1141         int                      line_nr;
1142 };
1143 
1144 static void annotation_line__delete(struct annotation_line *al)
1145 {
1146         void *ptr = (void *) al - al->privsize;
1147 
1148         free_srcline(al->path);
1149         zfree(&al->line);
1150         free(ptr);
1151 }
1152 
1153 /*
1154  * Allocating the annotation line data with following
1155  * structure:
1156  *
1157  *    --------------------------------------
1158  *    private space | struct annotation_line
1159  *    --------------------------------------
1160  *
1161  * Size of the private space is stored in 'struct annotation_line'.
1162  *
1163  */
1164 static struct annotation_line *
1165 annotation_line__new(struct annotate_args *args, size_t privsize)
1166 {
1167         struct annotation_line *al;
1168         struct perf_evsel *evsel = args->evsel;
1169         size_t size = privsize + sizeof(*al);
1170         int nr = 1;
1171 
1172         if (perf_evsel__is_group_event(evsel))
1173                 nr = evsel->nr_members;
1174 
1175         size += sizeof(al->data[0]) * nr;
1176 
1177         al = zalloc(size);
1178         if (al) {
1179                 al = (void *) al + privsize;
1180                 al->privsize   = privsize;
1181                 al->offset     = args->offset;
1182                 al->line       = strdup(args->line);
1183                 al->line_nr    = args->line_nr;
1184                 al->data_nr    = nr;
1185         }
1186 
1187         return al;
1188 }
1189 
1190 /*
1191  * Allocating the disasm annotation line data with
1192  * following structure:
1193  *
1194  *    ------------------------------------------------------------
1195  *    privsize space | struct disasm_line | struct annotation_line
1196  *    ------------------------------------------------------------
1197  *
1198  * We have 'struct annotation_line' member as last member
1199  * of 'struct disasm_line' to have an easy access.
1200  *
1201  */
1202 static struct disasm_line *disasm_line__new(struct annotate_args *args)
1203 {
1204         struct disasm_line *dl = NULL;
1205         struct annotation_line *al;
1206         size_t privsize = args->privsize + offsetof(struct disasm_line, al);
1207 
1208         al = annotation_line__new(args, privsize);
1209         if (al != NULL) {
1210                 dl = disasm_line(al);
1211 
1212                 if (dl->al.line == NULL)
1213                         goto out_delete;
1214 
1215                 if (args->offset != -1) {
1216                         if (disasm_line__parse(dl->al.line, &dl->ins.name, &dl->ops.raw) < 0)
1217                                 goto out_free_line;
1218 
1219                         disasm_line__init_ins(dl, args->arch, &args->ms);
1220                 }
1221         }
1222 
1223         return dl;
1224 
1225 out_free_line:
1226         zfree(&dl->al.line);
1227 out_delete:
1228         free(dl);
1229         return NULL;
1230 }
1231 
1232 void disasm_line__free(struct disasm_line *dl)
1233 {
1234         if (dl->ins.ops && dl->ins.ops->free)
1235                 dl->ins.ops->free(&dl->ops);
1236         else
1237                 ins__delete(&dl->ops);
1238         zfree(&dl->ins.name);
1239         annotation_line__delete(&dl->al);
1240 }
1241 
1242 int disasm_line__scnprintf(struct disasm_line *dl, char *bf, size_t size, bool raw, int max_ins_name)
1243 {
1244         if (raw || !dl->ins.ops)
1245                 return scnprintf(bf, size, "%-*s %s", max_ins_name, dl->ins.name, dl->ops.raw);
1246 
1247         return ins__scnprintf(&dl->ins, bf, size, &dl->ops, max_ins_name);
1248 }
1249 
1250 static void annotation_line__add(struct annotation_line *al, struct list_head *head)
1251 {
1252         list_add_tail(&al->node, head);
1253 }
1254 
1255 struct annotation_line *
1256 annotation_line__next(struct annotation_line *pos, struct list_head *head)
1257 {
1258         list_for_each_entry_continue(pos, head, node)
1259                 if (pos->offset >= 0)
1260                         return pos;
1261 
1262         return NULL;
1263 }
1264 
1265 static const char *annotate__address_color(struct block_range *br)
1266 {
1267         double cov = block_range__coverage(br);
1268 
1269         if (cov >= 0) {
1270                 /* mark red for >75% coverage */
1271                 if (cov > 0.75)
1272                         return PERF_COLOR_RED;
1273 
1274                 /* mark dull for <1% coverage */
1275                 if (cov < 0.01)
1276                         return PERF_COLOR_NORMAL;
1277         }
1278 
1279         return PERF_COLOR_MAGENTA;
1280 }
1281 
1282 static const char *annotate__asm_color(struct block_range *br)
1283 {
1284         double cov = block_range__coverage(br);
1285 
1286         if (cov >= 0) {
1287                 /* mark dull for <1% coverage */
1288                 if (cov < 0.01)
1289                         return PERF_COLOR_NORMAL;
1290         }
1291 
1292         return PERF_COLOR_BLUE;
1293 }
1294 
1295 static void annotate__branch_printf(struct block_range *br, u64 addr)
1296 {
1297         bool emit_comment = true;
1298 
1299         if (!br)
1300                 return;
1301 
1302 #if 1
1303         if (br->is_target && br->start == addr) {
1304                 struct block_range *branch = br;
1305                 double p;
1306 
1307                 /*
1308                  * Find matching branch to our target.
1309                  */
1310                 while (!branch->is_branch)
1311                         branch = block_range__next(branch);
1312 
1313                 p = 100 *(double)br->entry / branch->coverage;
1314 
1315                 if (p > 0.1) {
1316                         if (emit_comment) {
1317                                 emit_comment = false;
1318                                 printf("\t#");
1319                         }
1320 
1321                         /*
1322                          * The percentage of coverage joined at this target in relation
1323                          * to the next branch.
1324                          */
1325                         printf(" +%.2f%%", p);
1326                 }
1327         }
1328 #endif
1329         if (br->is_branch && br->end == addr) {
1330                 double p = 100*(double)br->taken / br->coverage;
1331 
1332                 if (p > 0.1) {
1333                         if (emit_comment) {
1334                                 emit_comment = false;
1335                                 printf("\t#");
1336                         }
1337 
1338                         /*
1339                          * The percentage of coverage leaving at this branch, and
1340                          * its prediction ratio.
1341                          */
1342                         printf(" -%.2f%% (p:%.2f%%)", p, 100*(double)br->pred  / br->taken);
1343                 }
1344         }
1345 }
1346 
1347 static int disasm_line__print(struct disasm_line *dl, u64 start, int addr_fmt_width)
1348 {
1349         s64 offset = dl->al.offset;
1350         const u64 addr = start + offset;
1351         struct block_range *br;
1352 
1353         br = block_range__find(addr);
1354         color_fprintf(stdout, annotate__address_color(br), "  %*" PRIx64 ":", addr_fmt_width, addr);
1355         color_fprintf(stdout, annotate__asm_color(br), "%s", dl->al.line);
1356         annotate__branch_printf(br, addr);
1357         return 0;
1358 }
1359 
1360 static int
1361 annotation_line__print(struct annotation_line *al, struct symbol *sym, u64 start,
1362                        struct perf_evsel *evsel, u64 len, int min_pcnt, int printed,
1363                        int max_lines, struct annotation_line *queue, int addr_fmt_width,
1364                        int percent_type)
1365 {
1366         struct disasm_line *dl = container_of(al, struct disasm_line, al);
1367         static const char *prev_line;
1368         static const char *prev_color;
1369 
1370         if (al->offset != -1) {
1371                 double max_percent = 0.0;
1372                 int i, nr_percent = 1;
1373                 const char *color;
1374                 struct annotation *notes = symbol__annotation(sym);
1375 
1376                 for (i = 0; i < al->data_nr; i++) {
1377                         double percent;
1378 
1379                         percent = annotation_data__percent(&al->data[i],
1380                                                            percent_type);
1381 
1382                         if (percent > max_percent)
1383                                 max_percent = percent;
1384                 }
1385 
1386                 if (al->data_nr > nr_percent)
1387                         nr_percent = al->data_nr;
1388 
1389                 if (max_percent < min_pcnt)
1390                         return -1;
1391 
1392                 if (max_lines && printed >= max_lines)
1393                         return 1;
1394 
1395                 if (queue != NULL) {
1396                         list_for_each_entry_from(queue, &notes->src->source, node) {
1397                                 if (queue == al)
1398                                         break;
1399                                 annotation_line__print(queue, sym, start, evsel, len,
1400                                                        0, 0, 1, NULL, addr_fmt_width,
1401                                                        percent_type);
1402                         }
1403                 }
1404 
1405                 color = get_percent_color(max_percent);
1406 
1407                 /*
1408                  * Also color the filename and line if needed, with
1409                  * the same color than the percentage. Don't print it
1410                  * twice for close colored addr with the same filename:line
1411                  */
1412                 if (al->path) {
1413                         if (!prev_line || strcmp(prev_line, al->path)
1414                                        || color != prev_color) {
1415                                 color_fprintf(stdout, color, " %s", al->path);
1416                                 prev_line = al->path;
1417                                 prev_color = color;
1418                         }
1419                 }
1420 
1421                 for (i = 0; i < nr_percent; i++) {
1422                         struct annotation_data *data = &al->data[i];
1423                         double percent;
1424 
1425                         percent = annotation_data__percent(data, percent_type);
1426                         color = get_percent_color(percent);
1427 
1428                         if (symbol_conf.show_total_period)
1429                                 color_fprintf(stdout, color, " %11" PRIu64,
1430                                               data->he.period);
1431                         else if (symbol_conf.show_nr_samples)
1432                                 color_fprintf(stdout, color, " %7" PRIu64,
1433                                               data->he.nr_samples);
1434                         else
1435                                 color_fprintf(stdout, color, " %7.2f", percent);
1436                 }
1437 
1438                 printf(" : ");
1439 
1440                 disasm_line__print(dl, start, addr_fmt_width);
1441                 printf("\n");
1442         } else if (max_lines && printed >= max_lines)
1443                 return 1;
1444         else {
1445                 int width = symbol_conf.show_total_period ? 12 : 8;
1446 
1447                 if (queue)
1448                         return -1;
1449 
1450                 if (perf_evsel__is_group_event(evsel))
1451                         width *= evsel->nr_members;
1452 
1453                 if (!*al->line)
1454                         printf(" %*s:\n", width, " ");
1455                 else
1456                         printf(" %*s:     %*s %s\n", width, " ", addr_fmt_width, " ", al->line);
1457         }
1458 
1459         return 0;
1460 }
1461 
1462 /*
1463  * symbol__parse_objdump_line() parses objdump output (with -d --no-show-raw)
1464  * which looks like following
1465  *
1466  *  0000000000415500 <_init>:
1467  *    415500:       sub    $0x8,%rsp
1468  *    415504:       mov    0x2f5ad5(%rip),%rax        # 70afe0 <_DYNAMIC+0x2f8>
1469  *    41550b:       test   %rax,%rax
1470  *    41550e:       je     415515 <_init+0x15>
1471  *    415510:       callq  416e70 <__gmon_start__@plt>
1472  *    415515:       add    $0x8,%rsp
1473  *    415519:       retq
1474  *
1475  * it will be parsed and saved into struct disasm_line as
1476  *  <offset>       <name>  <ops.raw>
1477  *
1478  * The offset will be a relative offset from the start of the symbol and -1
1479  * means that it's not a disassembly line so should be treated differently.
1480  * The ops.raw part will be parsed further according to type of the instruction.
1481  */
1482 static int symbol__parse_objdump_line(struct symbol *sym, FILE *file,
1483                                       struct annotate_args *args,
1484                                       int *line_nr)
1485 {
1486         struct map *map = args->ms.map;
1487         struct annotation *notes = symbol__annotation(sym);
1488         struct disasm_line *dl;
1489         char *line = NULL, *parsed_line, *tmp, *tmp2;
1490         size_t line_len;
1491         s64 line_ip, offset = -1;
1492         regmatch_t match[2];
1493 
1494         if (getline(&line, &line_len, file) < 0)
1495                 return -1;
1496 
1497         if (!line)
1498                 return -1;
1499 
1500         line_ip = -1;
1501         parsed_line = strim(line);
1502 
1503         /* /filename:linenr ? Save line number and ignore. */
1504         if (regexec(&file_lineno, parsed_line, 2, match, 0) == 0) {
1505                 *line_nr = atoi(parsed_line + match[1].rm_so);
1506                 return 0;
1507         }
1508 
1509         tmp = skip_spaces(parsed_line);
1510         if (*tmp) {
1511                 /*
1512                  * Parse hexa addresses followed by ':'
1513                  */
1514                 line_ip = strtoull(tmp, &tmp2, 16);
1515                 if (*tmp2 != ':' || tmp == tmp2 || tmp2[1] == '\0')
1516                         line_ip = -1;
1517         }
1518 
1519         if (line_ip != -1) {
1520                 u64 start = map__rip_2objdump(map, sym->start),
1521                     end = map__rip_2objdump(map, sym->end);
1522 
1523                 offset = line_ip - start;
1524                 if ((u64)line_ip < start || (u64)line_ip >= end)
1525                         offset = -1;
1526                 else
1527                         parsed_line = tmp2 + 1;
1528         }
1529 
1530         args->offset  = offset;
1531         args->line    = parsed_line;
1532         args->line_nr = *line_nr;
1533         args->ms.sym  = sym;
1534 
1535         dl = disasm_line__new(args);
1536         free(line);
1537         (*line_nr)++;
1538 
1539         if (dl == NULL)
1540                 return -1;
1541 
1542         if (!disasm_line__has_local_offset(dl)) {
1543                 dl->ops.target.offset = dl->ops.target.addr -
1544                                         map__rip_2objdump(map, sym->start);
1545                 dl->ops.target.offset_avail = true;
1546         }
1547 
1548         /* kcore has no symbols, so add the call target symbol */
1549         if (dl->ins.ops && ins__is_call(&dl->ins) && !dl->ops.target.sym) {
1550                 struct addr_map_symbol target = {
1551                         .map = map,
1552                         .addr = dl->ops.target.addr,
1553                 };
1554 
1555                 if (!map_groups__find_ams(&target) &&
1556                     target.sym->start == target.al_addr)
1557                         dl->ops.target.sym = target.sym;
1558         }
1559 
1560         annotation_line__add(&dl->al, &notes->src->source);
1561 
1562         return 0;
1563 }
1564 
1565 static __attribute__((constructor)) void symbol__init_regexpr(void)
1566 {
1567         regcomp(&file_lineno, "^/[^:]+:([0-9]+)", REG_EXTENDED);
1568 }
1569 
1570 static void delete_last_nop(struct symbol *sym)
1571 {
1572         struct annotation *notes = symbol__annotation(sym);
1573         struct list_head *list = &notes->src->source;
1574         struct disasm_line *dl;
1575 
1576         while (!list_empty(list)) {
1577                 dl = list_entry(list->prev, struct disasm_line, al.node);
1578 
1579                 if (dl->ins.ops) {
1580                         if (dl->ins.ops != &nop_ops)
1581                                 return;
1582                 } else {
1583                         if (!strstr(dl->al.line, " nop ") &&
1584                             !strstr(dl->al.line, " nopl ") &&
1585                             !strstr(dl->al.line, " nopw "))
1586                                 return;
1587                 }
1588 
1589                 list_del_init(&dl->al.node);
1590                 disasm_line__free(dl);
1591         }
1592 }
1593 
1594 int symbol__strerror_disassemble(struct symbol *sym __maybe_unused, struct map *map,
1595                               int errnum, char *buf, size_t buflen)
1596 {
1597         struct dso *dso = map->dso;
1598 
1599         BUG_ON(buflen == 0);
1600 
1601         if (errnum >= 0) {
1602                 str_error_r(errnum, buf, buflen);
1603                 return 0;
1604         }
1605 
1606         switch (errnum) {
1607         case SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX: {
1608                 char bf[SBUILD_ID_SIZE + 15] = " with build id ";
1609                 char *build_id_msg = NULL;
1610 
1611                 if (dso->has_build_id) {
1612                         build_id__sprintf(dso->build_id,
1613                                           sizeof(dso->build_id), bf + 15);
1614                         build_id_msg = bf;
1615                 }
1616                 scnprintf(buf, buflen,
1617                           "No vmlinux file%s\nwas found in the path.\n\n"
1618                           "Note that annotation using /proc/kcore requires CAP_SYS_RAWIO capability.\n\n"
1619                           "Please use:\n\n"
1620                           "  perf buildid-cache -vu vmlinux\n\n"
1621                           "or:\n\n"
1622                           "  --vmlinux vmlinux\n", build_id_msg ?: "");
1623         }
1624                 break;
1625         case SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF:
1626                 scnprintf(buf, buflen, "Please link with binutils's libopcode to enable BPF annotation");
1627                 break;
1628         case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_REGEXP:
1629                 scnprintf(buf, buflen, "Problems with arch specific instruction name regular expressions.");
1630                 break;
1631         case SYMBOL_ANNOTATE_ERRNO__ARCH_INIT_CPUID_PARSING:
1632                 scnprintf(buf, buflen, "Problems while parsing the CPUID in the arch specific initialization.");
1633                 break;
1634         case SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE:
1635                 scnprintf(buf, buflen, "Invalid BPF file: %s.", dso->long_name);
1636                 break;
1637         case SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF:
1638                 scnprintf(buf, buflen, "The %s BPF file has no BTF section, compile with -g or use pahole -J.",
1639                           dso->long_name);
1640                 break;
1641         default:
1642                 scnprintf(buf, buflen, "Internal error: Invalid %d error code\n", errnum);
1643                 break;
1644         }
1645 
1646         return 0;
1647 }
1648 
1649 static int dso__disassemble_filename(struct dso *dso, char *filename, size_t filename_size)
1650 {
1651         char linkname[PATH_MAX];
1652         char *build_id_filename;
1653         char *build_id_path = NULL;
1654         char *pos;
1655 
1656         if (dso->symtab_type == DSO_BINARY_TYPE__KALLSYMS &&
1657             !dso__is_kcore(dso))
1658                 return SYMBOL_ANNOTATE_ERRNO__NO_VMLINUX;
1659 
1660         build_id_filename = dso__build_id_filename(dso, NULL, 0, false);
1661         if (build_id_filename) {
1662                 __symbol__join_symfs(filename, filename_size, build_id_filename);
1663                 free(build_id_filename);
1664         } else {
1665                 if (dso->has_build_id)
1666                         return ENOMEM;
1667                 goto fallback;
1668         }
1669 
1670         build_id_path = strdup(filename);
1671         if (!build_id_path)
1672                 return ENOMEM;
1673 
1674         /*
1675          * old style build-id cache has name of XX/XXXXXXX.. while
1676          * new style has XX/XXXXXXX../{elf,kallsyms,vdso}.
1677          * extract the build-id part of dirname in the new style only.
1678          */
1679         pos = strrchr(build_id_path, '/');
1680         if (pos && strlen(pos) < SBUILD_ID_SIZE - 2)
1681                 dirname(build_id_path);
1682 
1683         if (dso__is_kcore(dso) ||
1684             readlink(build_id_path, linkname, sizeof(linkname)) < 0 ||
1685             strstr(linkname, DSO__NAME_KALLSYMS) ||
1686             access(filename, R_OK)) {
1687 fallback:
1688                 /*
1689                  * If we don't have build-ids or the build-id file isn't in the
1690                  * cache, or is just a kallsyms file, well, lets hope that this
1691                  * DSO is the same as when 'perf record' ran.
1692                  */
1693                 __symbol__join_symfs(filename, filename_size, dso->long_name);
1694         }
1695 
1696         free(build_id_path);
1697         return 0;
1698 }
1699 
1700 #if defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1701 #define PACKAGE "perf"
1702 #include <bfd.h>
1703 #include <dis-asm.h>
1704 
1705 static int symbol__disassemble_bpf(struct symbol *sym,
1706                                    struct annotate_args *args)
1707 {
1708         struct annotation *notes = symbol__annotation(sym);
1709         struct annotation_options *opts = args->options;
1710         struct bpf_prog_info_linear *info_linear;
1711         struct bpf_prog_linfo *prog_linfo = NULL;
1712         struct bpf_prog_info_node *info_node;
1713         int len = sym->end - sym->start;
1714         disassembler_ftype disassemble;
1715         struct map *map = args->ms.map;
1716         struct disassemble_info info;
1717         struct dso *dso = map->dso;
1718         int pc = 0, count, sub_id;
1719         struct btf *btf = NULL;
1720         char tpath[PATH_MAX];
1721         size_t buf_size;
1722         int nr_skip = 0;
1723         char *buf;
1724         bfd *bfdf;
1725         int ret;
1726         FILE *s;
1727 
1728         if (dso->binary_type != DSO_BINARY_TYPE__BPF_PROG_INFO)
1729                 return SYMBOL_ANNOTATE_ERRNO__BPF_INVALID_FILE;
1730 
1731         pr_debug("%s: handling sym %s addr %" PRIx64 " len %" PRIx64 "\n", __func__,
1732                   sym->name, sym->start, sym->end - sym->start);
1733 
1734         memset(tpath, 0, sizeof(tpath));
1735         perf_exe(tpath, sizeof(tpath));
1736 
1737         bfdf = bfd_openr(tpath, NULL);
1738         assert(bfdf);
1739         assert(bfd_check_format(bfdf, bfd_object));
1740 
1741         s = open_memstream(&buf, &buf_size);
1742         if (!s) {
1743                 ret = errno;
1744                 goto out;
1745         }
1746         init_disassemble_info(&info, s,
1747                               (fprintf_ftype) fprintf);
1748 
1749         info.arch = bfd_get_arch(bfdf);
1750         info.mach = bfd_get_mach(bfdf);
1751 
1752         info_node = perf_env__find_bpf_prog_info(dso->bpf_prog.env,
1753                                                  dso->bpf_prog.id);
1754         if (!info_node) {
1755                 ret = SYMBOL_ANNOTATE_ERRNO__BPF_MISSING_BTF;
1756                 goto out;
1757         }
1758         info_linear = info_node->info_linear;
1759         sub_id = dso->bpf_prog.sub_id;
1760 
1761         info.buffer = (void *)(uintptr_t)(info_linear->info.jited_prog_insns);
1762         info.buffer_length = info_linear->info.jited_prog_len;
1763 
1764         if (info_linear->info.nr_line_info)
1765                 prog_linfo = bpf_prog_linfo__new(&info_linear->info);
1766 
1767         if (info_linear->info.btf_id) {
1768                 struct btf_node *node;
1769 
1770                 node = perf_env__find_btf(dso->bpf_prog.env,
1771                                           info_linear->info.btf_id);
1772                 if (node)
1773                         btf = btf__new((__u8 *)(node->data),
1774                                        node->data_size);
1775         }
1776 
1777         disassemble_init_for_target(&info);
1778 
1779 #ifdef DISASM_FOUR_ARGS_SIGNATURE
1780         disassemble = disassembler(info.arch,
1781                                    bfd_big_endian(bfdf),
1782                                    info.mach,
1783                                    bfdf);
1784 #else
1785         disassemble = disassembler(bfdf);
1786 #endif
1787         assert(disassemble);
1788 
1789         fflush(s);
1790         do {
1791                 const struct bpf_line_info *linfo = NULL;
1792                 struct disasm_line *dl;
1793                 size_t prev_buf_size;
1794                 const char *srcline;
1795                 u64 addr;
1796 
1797                 addr = pc + ((u64 *)(uintptr_t)(info_linear->info.jited_ksyms))[sub_id];
1798                 count = disassemble(pc, &info);
1799 
1800                 if (prog_linfo)
1801                         linfo = bpf_prog_linfo__lfind_addr_func(prog_linfo,
1802                                                                 addr, sub_id,
1803                                                                 nr_skip);
1804 
1805                 if (linfo && btf) {
1806                         srcline = btf__name_by_offset(btf, linfo->line_off);
1807                         nr_skip++;
1808                 } else
1809                         srcline = NULL;
1810 
1811                 fprintf(s, "\n");
1812                 prev_buf_size = buf_size;
1813                 fflush(s);
1814 
1815                 if (!opts->hide_src_code && srcline) {
1816                         args->offset = -1;
1817                         args->line = strdup(srcline);
1818                         args->line_nr = 0;
1819                         args->ms.sym  = sym;
1820                         dl = disasm_line__new(args);
1821                         if (dl) {
1822                                 annotation_line__add(&dl->al,
1823                                                      &notes->src->source);
1824                         }
1825                 }
1826 
1827                 args->offset = pc;
1828                 args->line = buf + prev_buf_size;
1829                 args->line_nr = 0;
1830                 args->ms.sym  = sym;
1831                 dl = disasm_line__new(args);
1832                 if (dl)
1833                         annotation_line__add(&dl->al, &notes->src->source);
1834 
1835                 pc += count;
1836         } while (count > 0 && pc < len);
1837 
1838         ret = 0;
1839 out:
1840         free(prog_linfo);
1841         free(btf);
1842         fclose(s);
1843         bfd_close(bfdf);
1844         return ret;
1845 }
1846 #else // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1847 static int symbol__disassemble_bpf(struct symbol *sym __maybe_unused,
1848                                    struct annotate_args *args __maybe_unused)
1849 {
1850         return SYMBOL_ANNOTATE_ERRNO__NO_LIBOPCODES_FOR_BPF;
1851 }
1852 #endif // defined(HAVE_LIBBFD_SUPPORT) && defined(HAVE_LIBBPF_SUPPORT)
1853 
1854 static int symbol__disassemble(struct symbol *sym, struct annotate_args *args)
1855 {
1856         struct annotation_options *opts = args->options;
1857         struct map *map = args->ms.map;
1858         struct dso *dso = map->dso;
1859         char *command;
1860         FILE *file;
1861         char symfs_filename[PATH_MAX];
1862         struct kcore_extract kce;
1863         bool delete_extract = false;
1864         bool decomp = false;
1865         int stdout_fd[2];
1866         int lineno = 0;
1867         int nline;
1868         pid_t pid;
1869         int err = dso__disassemble_filename(dso, symfs_filename, sizeof(symfs_filename));
1870 
1871         if (err)
1872                 return err;
1873 
1874         pr_debug("%s: filename=%s, sym=%s, start=%#" PRIx64 ", end=%#" PRIx64 "\n", __func__,
1875                  symfs_filename, sym->name, map->unmap_ip(map, sym->start),
1876                  map->unmap_ip(map, sym->end));
1877 
1878         pr_debug("annotating [%p] %30s : [%p] %30s\n",
1879                  dso, dso->long_name, sym, sym->name);
1880 
1881         if (dso->binary_type == DSO_BINARY_TYPE__BPF_PROG_INFO) {
1882                 return symbol__disassemble_bpf(sym, args);
1883         } else if (dso__is_kcore(dso)) {
1884                 kce.kcore_filename = symfs_filename;
1885                 kce.addr = map__rip_2objdump(map, sym->start);
1886                 kce.offs = sym->start;
1887                 kce.len = sym->end - sym->start;
1888                 if (!kcore_extract__create(&kce)) {
1889                         delete_extract = true;
1890                         strlcpy(symfs_filename, kce.extract_filename,
1891                                 sizeof(symfs_filename));
1892                 }
1893         } else if (dso__needs_decompress(dso)) {
1894                 char tmp[KMOD_DECOMP_LEN];
1895 
1896                 if (dso__decompress_kmodule_path(dso, symfs_filename,
1897                                                  tmp, sizeof(tmp)) < 0)
1898                         goto out;
1899 
1900                 decomp = true;
1901                 strcpy(symfs_filename, tmp);
1902         }
1903 
1904         err = asprintf(&command,
1905                  "%s %s%s --start-address=0x%016" PRIx64
1906                  " --stop-address=0x%016" PRIx64
1907                  " -l -d %s %s -C \"$1\" 2>/dev/null|grep -v \"$1:\"|expand",
1908                  opts->objdump_path ?: "objdump",
1909                  opts->disassembler_style ? "-M " : "",
1910                  opts->disassembler_style ?: "",
1911                  map__rip_2objdump(map, sym->start),
1912                  map__rip_2objdump(map, sym->end),
1913                  opts->show_asm_raw ? "" : "--no-show-raw",
1914                  opts->annotate_src ? "-S" : "");
1915 
1916         if (err < 0) {
1917                 pr_err("Failure allocating memory for the command to run\n");
1918                 goto out_remove_tmp;
1919         }
1920 
1921         pr_debug("Executing: %s\n", command);
1922 
1923         err = -1;
1924         if (pipe(stdout_fd) < 0) {
1925                 pr_err("Failure creating the pipe to run %s\n", command);
1926                 goto out_free_command;
1927         }
1928 
1929         pid = fork();
1930         if (pid < 0) {
1931                 pr_err("Failure forking to run %s\n", command);
1932                 goto out_close_stdout;
1933         }
1934 
1935         if (pid == 0) {
1936                 close(stdout_fd[0]);
1937                 dup2(stdout_fd[1], 1);
1938                 close(stdout_fd[1]);
1939                 execl("/bin/sh", "sh", "-c", command, "--", symfs_filename,
1940                       NULL);
1941                 perror(command);
1942                 exit(-1);
1943         }
1944 
1945         close(stdout_fd[1]);
1946 
1947         file = fdopen(stdout_fd[0], "r");
1948         if (!file) {
1949                 pr_err("Failure creating FILE stream for %s\n", command);
1950                 /*
1951                  * If we were using debug info should retry with
1952                  * original binary.
1953                  */
1954                 goto out_free_command;
1955         }
1956 
1957         nline = 0;
1958         while (!feof(file)) {
1959                 /*
1960                  * The source code line number (lineno) needs to be kept in
1961                  * across calls to symbol__parse_objdump_line(), so that it
1962                  * can associate it with the instructions till the next one.
1963                  * See disasm_line__new() and struct disasm_line::line_nr.
1964                  */
1965                 if (symbol__parse_objdump_line(sym, file, args, &lineno) < 0)
1966                         break;
1967                 nline++;
1968         }
1969 
1970         if (nline == 0)
1971                 pr_err("No output from %s\n", command);
1972 
1973         /*
1974          * kallsyms does not have symbol sizes so there may a nop at the end.
1975          * Remove it.
1976          */
1977         if (dso__is_kcore(dso))
1978                 delete_last_nop(sym);
1979 
1980         fclose(file);
1981         err = 0;
1982 out_free_command:
1983         free(command);
1984 out_remove_tmp:
1985         close(stdout_fd[0]);
1986 
1987         if (decomp)
1988                 unlink(symfs_filename);
1989 
1990         if (delete_extract)
1991                 kcore_extract__delete(&kce);
1992 out:
1993         return err;
1994 
1995 out_close_stdout:
1996         close(stdout_fd[1]);
1997         goto out_free_command;
1998 }
1999 
2000 static void calc_percent(struct sym_hist *sym_hist,
2001                          struct hists *hists,
2002                          struct annotation_data *data,
2003                          s64 offset, s64 end)
2004 {
2005         unsigned int hits = 0;
2006         u64 period = 0;
2007 
2008         while (offset < end) {
2009                 hits   += sym_hist->addr[offset].nr_samples;
2010                 period += sym_hist->addr[offset].period;
2011                 ++offset;
2012         }
2013 
2014         if (sym_hist->nr_samples) {
2015                 data->he.period     = period;
2016                 data->he.nr_samples = hits;
2017                 data->percent[PERCENT_HITS_LOCAL] = 100.0 * hits / sym_hist->nr_samples;
2018         }
2019 
2020         if (hists->stats.nr_non_filtered_samples)
2021                 data->percent[PERCENT_HITS_GLOBAL] = 100.0 * hits / hists->stats.nr_non_filtered_samples;
2022 
2023         if (sym_hist->period)
2024                 data->percent[PERCENT_PERIOD_LOCAL] = 100.0 * period / sym_hist->period;
2025 
2026         if (hists->stats.total_period)
2027                 data->percent[PERCENT_PERIOD_GLOBAL] = 100.0 * period / hists->stats.total_period;
2028 }
2029 
2030 static void annotation__calc_percent(struct annotation *notes,
2031                                      struct perf_evsel *leader, s64 len)
2032 {
2033         struct annotation_line *al, *next;
2034         struct perf_evsel *evsel;
2035 
2036         list_for_each_entry(al, &notes->src->source, node) {
2037                 s64 end;
2038                 int i = 0;
2039 
2040                 if (al->offset == -1)
2041                         continue;
2042 
2043                 next = annotation_line__next(al, &notes->src->source);
2044                 end  = next ? next->offset : len;
2045 
2046                 for_each_group_evsel(evsel, leader) {
2047                         struct hists *hists = evsel__hists(evsel);
2048                         struct annotation_data *data;
2049                         struct sym_hist *sym_hist;
2050 
2051                         BUG_ON(i >= al->data_nr);
2052 
2053                         sym_hist = annotation__histogram(notes, evsel->idx);
2054                         data = &al->data[i++];
2055 
2056                         calc_percent(sym_hist, hists, data, al->offset, end);
2057                 }
2058         }
2059 }
2060 
2061 void symbol__calc_percent(struct symbol *sym, struct perf_evsel *evsel)
2062 {
2063         struct annotation *notes = symbol__annotation(sym);
2064 
2065         annotation__calc_percent(notes, evsel, symbol__size(sym));
2066 }
2067 
2068 int symbol__annotate(struct symbol *sym, struct map *map,
2069                      struct perf_evsel *evsel, size_t privsize,
2070                      struct annotation_options *options,
2071                      struct arch **parch)
2072 {
2073         struct annotation *notes = symbol__annotation(sym);
2074         struct annotate_args args = {
2075                 .privsize       = privsize,
2076                 .evsel          = evsel,
2077                 .options        = options,
2078         };
2079         struct perf_env *env = perf_evsel__env(evsel);
2080         const char *arch_name = perf_env__arch(env);
2081         struct arch *arch;
2082         int err;
2083 
2084         if (!arch_name)
2085                 return errno;
2086 
2087         args.arch = arch = arch__find(arch_name);
2088         if (arch == NULL)
2089                 return ENOTSUP;
2090 
2091         if (parch)
2092                 *parch = arch;
2093 
2094         if (arch->init) {
2095                 err = arch->init(arch, env ? env->cpuid : NULL);
2096                 if (err) {
2097                         pr_err("%s: failed to initialize %s arch priv area\n", __func__, arch->name);
2098                         return err;
2099                 }
2100         }
2101 
2102         args.ms.map = map;
2103         args.ms.sym = sym;
2104         notes->start = map__rip_2objdump(map, sym->start);
2105 
2106         return symbol__disassemble(sym, &args);
2107 }
2108 
2109 static void insert_source_line(struct rb_root *root, struct annotation_line *al,
2110                                struct annotation_options *opts)
2111 {
2112         struct annotation_line *iter;
2113         struct rb_node **p = &root->rb_node;
2114         struct rb_node *parent = NULL;
2115         int i, ret;
2116 
2117         while (*p != NULL) {
2118                 parent = *p;
2119                 iter = rb_entry(parent, struct annotation_line, rb_node);
2120 
2121                 ret = strcmp(iter->path, al->path);
2122                 if (ret == 0) {
2123                         for (i = 0; i < al->data_nr; i++) {
2124                                 iter->data[i].percent_sum += annotation_data__percent(&al->data[i],
2125                                                                                       opts->percent_type);
2126                         }
2127                         return;
2128                 }
2129 
2130                 if (ret < 0)
2131                         p = &(*p)->rb_left;
2132                 else
2133                         p = &(*p)->rb_right;
2134         }
2135 
2136         for (i = 0; i < al->data_nr; i++) {
2137                 al->data[i].percent_sum = annotation_data__percent(&al->data[i],
2138                                                                    opts->percent_type);
2139         }
2140 
2141         rb_link_node(&al->rb_node, parent, p);
2142         rb_insert_color(&al->rb_node, root);
2143 }
2144 
2145 static int cmp_source_line(struct annotation_line *a, struct annotation_line *b)
2146 {
2147         int i;
2148 
2149         for (i = 0; i < a->data_nr; i++) {
2150                 if (a->data[i].percent_sum == b->data[i].percent_sum)
2151                         continue;
2152                 return a->data[i].percent_sum > b->data[i].percent_sum;
2153         }
2154 
2155         return 0;
2156 }
2157 
2158 static void __resort_source_line(struct rb_root *root, struct annotation_line *al)
2159 {
2160         struct annotation_line *iter;
2161         struct rb_node **p = &root->rb_node;
2162         struct rb_node *parent = NULL;
2163 
2164         while (*p != NULL) {
2165                 parent = *p;
2166                 iter = rb_entry(parent, struct annotation_line, rb_node);
2167 
2168                 if (cmp_source_line(al, iter))
2169                         p = &(*p)->rb_left;
2170                 else
2171                         p = &(*p)->rb_right;
2172         }
2173 
2174         rb_link_node(&al->rb_node, parent, p);
2175         rb_insert_color(&al->rb_node, root);
2176 }
2177 
2178 static void resort_source_line(struct rb_root *dest_root, struct rb_root *src_root)
2179 {
2180         struct annotation_line *al;
2181         struct rb_node *node;
2182 
2183         node = rb_first(src_root);
2184         while (node) {
2185                 struct rb_node *next;
2186 
2187                 al = rb_entry(node, struct annotation_line, rb_node);
2188                 next = rb_next(node);
2189                 rb_erase(node, src_root);
2190 
2191                 __resort_source_line(dest_root, al);
2192                 node = next;
2193         }
2194 }
2195 
2196 static void print_summary(struct rb_root *root, const char *filename)
2197 {
2198         struct annotation_line *al;
2199         struct rb_node *node;
2200 
2201         printf("\nSorted summary for file %s\n", filename);
2202         printf("----------------------------------------------\n\n");
2203 
2204         if (RB_EMPTY_ROOT(root)) {
2205                 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
2206                 return;
2207         }
2208 
2209         node = rb_first(root);
2210         while (node) {
2211                 double percent, percent_max = 0.0;
2212                 const char *color;
2213                 char *path;
2214                 int i;
2215 
2216                 al = rb_entry(node, struct annotation_line, rb_node);
2217                 for (i = 0; i < al->data_nr; i++) {
2218                         percent = al->data[i].percent_sum;
2219                         color = get_percent_color(percent);
2220                         color_fprintf(stdout, color, " %7.2f", percent);
2221 
2222                         if (percent > percent_max)
2223                                 percent_max = percent;
2224                 }
2225 
2226                 path = al->path;
2227                 color = get_percent_color(percent_max);
2228                 color_fprintf(stdout, color, " %s\n", path);
2229 
2230                 node = rb_next(node);
2231         }
2232 }
2233 
2234 static void symbol__annotate_hits(struct symbol *sym, struct perf_evsel *evsel)
2235 {
2236         struct annotation *notes = symbol__annotation(sym);
2237         struct sym_hist *h = annotation__histogram(notes, evsel->idx);
2238         u64 len = symbol__size(sym), offset;
2239 
2240         for (offset = 0; offset < len; ++offset)
2241                 if (h->addr[offset].nr_samples != 0)
2242                         printf("%*" PRIx64 ": %" PRIu64 "\n", BITS_PER_LONG / 2,
2243                                sym->start + offset, h->addr[offset].nr_samples);
2244         printf("%*s: %" PRIu64 "\n", BITS_PER_LONG / 2, "h->nr_samples", h->nr_samples);
2245 }
2246 
2247 static int annotated_source__addr_fmt_width(struct list_head *lines, u64 start)
2248 {
2249         char bf[32];
2250         struct annotation_line *line;
2251 
2252         list_for_each_entry_reverse(line, lines, node) {
2253                 if (line->offset != -1)
2254                         return scnprintf(bf, sizeof(bf), "%" PRIx64, start + line->offset);
2255         }
2256 
2257         return 0;
2258 }
2259 
2260 int symbol__annotate_printf(struct symbol *sym, struct map *map,
2261                             struct perf_evsel *evsel,
2262                             struct annotation_options *opts)
2263 {
2264         struct dso *dso = map->dso;
2265         char *filename;
2266         const char *d_filename;
2267         const char *evsel_name = perf_evsel__name(evsel);
2268         struct annotation *notes = symbol__annotation(sym);
2269         struct sym_hist *h = annotation__histogram(notes, evsel->idx);
2270         struct annotation_line *pos, *queue = NULL;
2271         u64 start = map__rip_2objdump(map, sym->start);
2272         int printed = 2, queue_len = 0, addr_fmt_width;
2273         int more = 0;
2274         bool context = opts->context;
2275         u64 len;
2276         int width = symbol_conf.show_total_period ? 12 : 8;
2277         int graph_dotted_len;
2278         char buf[512];
2279 
2280         filename = strdup(dso->long_name);
2281         if (!filename)
2282                 return -ENOMEM;
2283 
2284         if (opts->full_path)
2285                 d_filename = filename;
2286         else
2287                 d_filename = basename(filename);
2288 
2289         len = symbol__size(sym);
2290 
2291         if (perf_evsel__is_group_event(evsel)) {
2292                 width *= evsel->nr_members;
2293                 perf_evsel__group_desc(evsel, buf, sizeof(buf));
2294                 evsel_name = buf;
2295         }
2296 
2297         graph_dotted_len = printf(" %-*.*s|     Source code & Disassembly of %s for %s (%" PRIu64 " samples, "
2298                                   "percent: %s)\n",
2299                                   width, width, symbol_conf.show_total_period ? "Period" :
2300                                   symbol_conf.show_nr_samples ? "Samples" : "Percent",
2301                                   d_filename, evsel_name, h->nr_samples,
2302                                   percent_type_str(opts->percent_type));
2303 
2304         printf("%-*.*s----\n",
2305                graph_dotted_len, graph_dotted_len, graph_dotted_line);
2306 
2307         if (verbose > 0)
2308                 symbol__annotate_hits(sym, evsel);
2309 
2310         addr_fmt_width = annotated_source__addr_fmt_width(&notes->src->source, start);
2311 
2312         list_for_each_entry(pos, &notes->src->source, node) {
2313                 int err;
2314 
2315                 if (context && queue == NULL) {
2316                         queue = pos;
2317                         queue_len = 0;
2318                 }
2319 
2320                 err = annotation_line__print(pos, sym, start, evsel, len,
2321                                              opts->min_pcnt, printed, opts->max_lines,
2322                                              queue, addr_fmt_width, opts->percent_type);
2323 
2324                 switch (err) {
2325                 case 0:
2326                         ++printed;
2327                         if (context) {
2328                                 printed += queue_len;
2329                                 queue = NULL;
2330                                 queue_len = 0;
2331                         }
2332                         break;
2333                 case 1:
2334                         /* filtered by max_lines */
2335                         ++more;
2336                         break;
2337                 case -1:
2338                 default:
2339                         /*
2340                          * Filtered by min_pcnt or non IP lines when
2341                          * context != 0
2342                          */
2343                         if (!context)
2344                                 break;
2345                         if (queue_len == context)
2346                                 queue = list_entry(queue->node.next, typeof(*queue), node);
2347                         else
2348                                 ++queue_len;
2349                         break;
2350                 }
2351         }
2352 
2353         free(filename);
2354 
2355         return more;
2356 }
2357 
2358 static void FILE__set_percent_color(void *fp __maybe_unused,
2359                                     double percent __maybe_unused,
2360                                     bool current __maybe_unused)
2361 {
2362 }
2363 
2364 static int FILE__set_jumps_percent_color(void *fp __maybe_unused,
2365                                          int nr __maybe_unused, bool current __maybe_unused)
2366 {
2367         return 0;
2368 }
2369 
2370 static int FILE__set_color(void *fp __maybe_unused, int color __maybe_unused)
2371 {
2372         return 0;
2373 }
2374 
2375 static void FILE__printf(void *fp, const char *fmt, ...)
2376 {
2377         va_list args;
2378 
2379         va_start(args, fmt);
2380         vfprintf(fp, fmt, args);
2381         va_end(args);
2382 }
2383 
2384 static void FILE__write_graph(void *fp, int graph)
2385 {
2386         const char *s;
2387         switch (graph) {
2388 
2389         case DARROW_CHAR: s = "↓"; break;
2390         case UARROW_CHAR: s = "↑"; break;
2391         case LARROW_CHAR: s = "←"; break;
2392         case RARROW_CHAR: s = "→"; break;
2393         default:                s = "?"; break;
2394         }
2395 
2396         fputs(s, fp);
2397 }
2398 
2399 static int symbol__annotate_fprintf2(struct symbol *sym, FILE *fp,
2400                                      struct annotation_options *opts)
2401 {
2402         struct annotation *notes = symbol__annotation(sym);
2403         struct annotation_write_ops wops = {
2404                 .first_line              = true,
2405                 .obj                     = fp,
2406                 .set_color               = FILE__set_color,
2407                 .set_percent_color       = FILE__set_percent_color,
2408                 .set_jumps_percent_color = FILE__set_jumps_percent_color,
2409                 .printf                  = FILE__printf,
2410                 .write_graph             = FILE__write_graph,
2411         };
2412         struct annotation_line *al;
2413 
2414         list_for_each_entry(al, &notes->src->source, node) {
2415                 if (annotation_line__filter(al, notes))
2416                         continue;
2417                 annotation_line__write(al, notes, &wops, opts);
2418                 fputc('\n', fp);
2419                 wops.first_line = false;
2420         }
2421 
2422         return 0;
2423 }
2424 
2425 int map_symbol__annotation_dump(struct map_symbol *ms, struct perf_evsel *evsel,
2426                                 struct annotation_options *opts)
2427 {
2428         const char *ev_name = perf_evsel__name(evsel);
2429         char buf[1024];
2430         char *filename;
2431         int err = -1;
2432         FILE *fp;
2433 
2434         if (asprintf(&filename, "%s.annotation", ms->sym->name) < 0)
2435                 return -1;
2436 
2437         fp = fopen(filename, "w");
2438         if (fp == NULL)
2439                 goto out_free_filename;
2440 
2441         if (perf_evsel__is_group_event(evsel)) {
2442                 perf_evsel__group_desc(evsel, buf, sizeof(buf));
2443                 ev_name = buf;
2444         }
2445 
2446         fprintf(fp, "%s() %s\nEvent: %s\n\n",
2447                 ms->sym->name, ms->map->dso->long_name, ev_name);
2448         symbol__annotate_fprintf2(ms->sym, fp, opts);
2449 
2450         fclose(fp);
2451         err = 0;
2452 out_free_filename:
2453         free(filename);
2454         return err;
2455 }
2456 
2457 void symbol__annotate_zero_histogram(struct symbol *sym, int evidx)
2458 {
2459         struct annotation *notes = symbol__annotation(sym);
2460         struct sym_hist *h = annotation__histogram(notes, evidx);
2461 
2462         memset(h, 0, notes->src->sizeof_sym_hist);
2463 }
2464 
2465 void symbol__annotate_decay_histogram(struct symbol *sym, int evidx)
2466 {
2467         struct annotation *notes = symbol__annotation(sym);
2468         struct sym_hist *h = annotation__histogram(notes, evidx);
2469         int len = symbol__size(sym), offset;
2470 
2471         h->nr_samples = 0;
2472         for (offset = 0; offset < len; ++offset) {
2473                 h->addr[offset].nr_samples = h->addr[offset].nr_samples * 7 / 8;
2474                 h->nr_samples += h->addr[offset].nr_samples;
2475         }
2476 }
2477 
2478 void annotated_source__purge(struct annotated_source *as)
2479 {
2480         struct annotation_line *al, *n;
2481 
2482         list_for_each_entry_safe(al, n, &as->source, node) {
2483                 list_del_init(&al->node);
2484                 disasm_line__free(disasm_line(al));
2485         }
2486 }
2487 
2488 static size_t disasm_line__fprintf(struct disasm_line *dl, FILE *fp)
2489 {
2490         size_t printed;
2491 
2492         if (dl->al.offset == -1)
2493                 return fprintf(fp, "%s\n", dl->al.line);
2494 
2495         printed = fprintf(fp, "%#" PRIx64 " %s", dl->al.offset, dl->ins.name);
2496 
2497         if (dl->ops.raw[0] != '\0') {
2498                 printed += fprintf(fp, "%.*s %s\n", 6 - (int)printed, " ",
2499                                    dl->ops.raw);
2500         }
2501 
2502         return printed + fprintf(fp, "\n");
2503 }
2504 
2505 size_t disasm__fprintf(struct list_head *head, FILE *fp)
2506 {
2507         struct disasm_line *pos;
2508         size_t printed = 0;
2509 
2510         list_for_each_entry(pos, head, al.node)
2511                 printed += disasm_line__fprintf(pos, fp);
2512 
2513         return printed;
2514 }
2515 
2516 bool disasm_line__is_valid_local_jump(struct disasm_line *dl, struct symbol *sym)
2517 {
2518         if (!dl || !dl->ins.ops || !ins__is_jump(&dl->ins) ||
2519             !disasm_line__has_local_offset(dl) || dl->ops.target.offset < 0 ||
2520             dl->ops.target.offset >= (s64)symbol__size(sym))
2521                 return false;
2522 
2523         return true;
2524 }
2525 
2526 void annotation__mark_jump_targets(struct annotation *notes, struct symbol *sym)
2527 {
2528         u64 offset, size = symbol__size(sym);
2529 
2530         /* PLT symbols contain external offsets */
2531         if (strstr(sym->name, "@plt"))
2532                 return;
2533 
2534         for (offset = 0; offset < size; ++offset) {
2535                 struct annotation_line *al = notes->offsets[offset];
2536                 struct disasm_line *dl;
2537 
2538                 dl = disasm_line(al);
2539 
2540                 if (!disasm_line__is_valid_local_jump(dl, sym))
2541                         continue;
2542 
2543                 al = notes->offsets[dl->ops.target.offset];
2544 
2545                 /*
2546                  * FIXME: Oops, no jump target? Buggy disassembler? Or do we
2547                  * have to adjust to the previous offset?
2548                  */
2549                 if (al == NULL)
2550                         continue;
2551 
2552                 if (++al->jump_sources > notes->max_jump_sources)
2553                         notes->max_jump_sources = al->jump_sources;
2554 
2555                 ++notes->nr_jumps;
2556         }
2557 }
2558 
2559 void annotation__set_offsets(struct annotation *notes, s64 size)
2560 {
2561         struct annotation_line *al;
2562 
2563         notes->max_line_len = 0;
2564 
2565         list_for_each_entry(al, &notes->src->source, node) {
2566                 size_t line_len = strlen(al->line);
2567 
2568                 if (notes->max_line_len < line_len)
2569                         notes->max_line_len = line_len;
2570                 al->idx = notes->nr_entries++;
2571                 if (al->offset != -1) {
2572                         al->idx_asm = notes->nr_asm_entries++;
2573                         /*
2574                          * FIXME: short term bandaid to cope with assembly
2575                          * routines that comes with labels in the same column
2576                          * as the address in objdump, sigh.
2577                          *
2578                          * E.g. copy_user_generic_unrolled
2579                          */
2580                         if (al->offset < size)
2581                                 notes->offsets[al->offset] = al;
2582                 } else
2583                         al->idx_asm = -1;
2584         }
2585 }
2586 
2587 static inline int width_jumps(int n)
2588 {
2589         if (n >= 100)
2590                 return 5;
2591         if (n / 10)
2592                 return 2;
2593         return 1;
2594 }
2595 
2596 static int annotation__max_ins_name(struct annotation *notes)
2597 {
2598         int max_name = 0, len;
2599         struct annotation_line *al;
2600 
2601         list_for_each_entry(al, &notes->src->source, node) {
2602                 if (al->offset == -1)
2603                         continue;
2604 
2605                 len = strlen(disasm_line(al)->ins.name);
2606                 if (max_name < len)
2607                         max_name = len;
2608         }
2609 
2610         return max_name;
2611 }
2612 
2613 void annotation__init_column_widths(struct annotation *notes, struct symbol *sym)
2614 {
2615         notes->widths.addr = notes->widths.target =
2616                 notes->widths.min_addr = hex_width(symbol__size(sym));
2617         notes->widths.max_addr = hex_width(sym->end);
2618         notes->widths.jumps = width_jumps(notes->max_jump_sources);
2619         notes->widths.max_ins_name = annotation__max_ins_name(notes);
2620 }
2621 
2622 void annotation__update_column_widths(struct annotation *notes)
2623 {
2624         if (notes->options->use_offset)
2625                 notes->widths.target = notes->widths.min_addr;
2626         else
2627                 notes->widths.target = notes->widths.max_addr;
2628 
2629         notes->widths.addr = notes->widths.target;
2630 
2631         if (notes->options->show_nr_jumps)
2632                 notes->widths.addr += notes->widths.jumps + 1;
2633 }
2634 
2635 static void annotation__calc_lines(struct annotation *notes, struct map *map,
2636                                    struct rb_root *root,
2637                                    struct annotation_options *opts)
2638 {
2639         struct annotation_line *al;
2640         struct rb_root tmp_root = RB_ROOT;
2641 
2642         list_for_each_entry(al, &notes->src->source, node) {
2643                 double percent_max = 0.0;
2644                 int i;
2645 
2646                 for (i = 0; i < al->data_nr; i++) {
2647                         double percent;
2648 
2649                         percent = annotation_data__percent(&al->data[i],
2650                                                            opts->percent_type);
2651 
2652                         if (percent > percent_max)
2653                                 percent_max = percent;
2654                 }
2655 
2656                 if (percent_max <= 0.5)
2657                         continue;
2658 
2659                 al->path = get_srcline(map->dso, notes->start + al->offset, NULL,
2660                                        false, true, notes->start + al->offset);
2661                 insert_source_line(&tmp_root, al, opts);
2662         }
2663 
2664         resort_source_line(root, &tmp_root);
2665 }
2666 
2667 static void symbol__calc_lines(struct symbol *sym, struct map *map,
2668                                struct rb_root *root,
2669                                struct annotation_options *opts)
2670 {
2671         struct annotation *notes = symbol__annotation(sym);
2672 
2673         annotation__calc_lines(notes, map, root, opts);
2674 }
2675 
2676 int symbol__tty_annotate2(struct symbol *sym, struct map *map,
2677                           struct perf_evsel *evsel,
2678                           struct annotation_options *opts)
2679 {
2680         struct dso *dso = map->dso;
2681         struct rb_root source_line = RB_ROOT;
2682         struct hists *hists = evsel__hists(evsel);
2683         char buf[1024];
2684 
2685         if (symbol__annotate2(sym, map, evsel, opts, NULL) < 0)
2686                 return -1;
2687 
2688         if (opts->print_lines) {
2689                 srcline_full_filename = opts->full_path;
2690                 symbol__calc_lines(sym, map, &source_line, opts);
2691                 print_summary(&source_line, dso->long_name);
2692         }
2693 
2694         hists__scnprintf_title(hists, buf, sizeof(buf));
2695         fprintf(stdout, "%s, [percent: %s]\n%s() %s\n",
2696                 buf, percent_type_str(opts->percent_type), sym->name, dso->long_name);
2697         symbol__annotate_fprintf2(sym, stdout, opts);
2698 
2699         annotated_source__purge(symbol__annotation(sym)->src);
2700 
2701         return 0;
2702 }
2703 
2704 int symbol__tty_annotate(struct symbol *sym, struct map *map,
2705                          struct perf_evsel *evsel,
2706                          struct annotation_options *opts)
2707 {
2708         struct dso *dso = map->dso;
2709         struct rb_root source_line = RB_ROOT;
2710 
2711         if (symbol__annotate(sym, map, evsel, 0, opts, NULL) < 0)
2712                 return -1;
2713 
2714         symbol__calc_percent(sym, evsel);
2715 
2716         if (opts->print_lines) {
2717                 srcline_full_filename = opts->full_path;
2718                 symbol__calc_lines(sym, map, &source_line, opts);
2719                 print_summary(&source_line, dso->long_name);
2720         }
2721 
2722         symbol__annotate_printf(sym, map, evsel, opts);
2723 
2724         annotated_source__purge(symbol__annotation(sym)->src);
2725 
2726         return 0;
2727 }
2728 
2729 bool ui__has_annotation(void)
2730 {
2731         return use_browser == 1 && perf_hpp_list.sym;
2732 }
2733 
2734 
2735 static double annotation_line__max_percent(struct annotation_line *al,
2736                                            struct annotation *notes,
2737                                            unsigned int percent_type)
2738 {
2739         double percent_max = 0.0;
2740         int i;
2741 
2742         for (i = 0; i < notes->nr_events; i++) {
2743                 double percent;
2744 
2745                 percent = annotation_data__percent(&al->data[i],
2746                                                    percent_type);
2747 
2748                 if (percent > percent_max)
2749                         percent_max = percent;
2750         }
2751 
2752         return percent_max;
2753 }
2754 
2755 static void disasm_line__write(struct disasm_line *dl, struct annotation *notes,
2756                                void *obj, char *bf, size_t size,
2757                                void (*obj__printf)(void *obj, const char *fmt, ...),
2758                                void (*obj__write_graph)(void *obj, int graph))
2759 {
2760         if (dl->ins.ops && dl->ins.ops->scnprintf) {
2761                 if (ins__is_jump(&dl->ins)) {
2762                         bool fwd;
2763 
2764                         if (dl->ops.target.outside)
2765                                 goto call_like;
2766                         fwd = dl->ops.target.offset > dl->al.offset;
2767                         obj__write_graph(obj, fwd ? DARROW_CHAR : UARROW_CHAR);
2768                         obj__printf(obj, " ");
2769                 } else if (ins__is_call(&dl->ins)) {
2770 call_like:
2771                         obj__write_graph(obj, RARROW_CHAR);
2772                         obj__printf(obj, " ");
2773                 } else if (ins__is_ret(&dl->ins)) {
2774                         obj__write_graph(obj, LARROW_CHAR);
2775                         obj__printf(obj, " ");
2776                 } else {
2777                         obj__printf(obj, "  ");
2778                 }
2779         } else {
2780                 obj__printf(obj, "  ");
2781         }
2782 
2783         disasm_line__scnprintf(dl, bf, size, !notes->options->use_offset, notes->widths.max_ins_name);
2784 }
2785 
2786 static void ipc_coverage_string(char *bf, int size, struct annotation *notes)
2787 {
2788         double ipc = 0.0, coverage = 0.0;
2789 
2790         if (notes->hit_cycles)
2791                 ipc = notes->hit_insn / ((double)notes->hit_cycles);
2792 
2793         if (notes->total_insn) {
2794                 coverage = notes->cover_insn * 100.0 /
2795                         ((double)notes->total_insn);
2796         }
2797 
2798         scnprintf(bf, size, "(Average IPC: %.2f, IPC Coverage: %.1f%%)",
2799                   ipc, coverage);
2800 }
2801 
2802 static void __annotation_line__write(struct annotation_line *al, struct annotation *notes,
2803                                      bool first_line, bool current_entry, bool change_color, int width,
2804                                      void *obj, unsigned int percent_type,
2805                                      int  (*obj__set_color)(void *obj, int color),
2806                                      void (*obj__set_percent_color)(void *obj, double percent, bool current),
2807                                      int  (*obj__set_jumps_percent_color)(void *obj, int nr, bool current),
2808                                      void (*obj__printf)(void *obj, const char *fmt, ...),
2809                                      void (*obj__write_graph)(void *obj, int graph))
2810 
2811 {
2812         double percent_max = annotation_line__max_percent(al, notes, percent_type);
2813         int pcnt_width = annotation__pcnt_width(notes),
2814             cycles_width = annotation__cycles_width(notes);
2815         bool show_title = false;
2816         char bf[256];
2817         int printed;
2818 
2819         if (first_line && (al->offset == -1 || percent_max == 0.0)) {
2820                 if (notes->have_cycles) {
2821                         if (al->ipc == 0.0 && al->cycles == 0)
2822                                 show_title = true;
2823                 } else
2824                         show_title = true;
2825         }
2826 
2827         if (al->offset != -1 && percent_max != 0.0) {
2828                 int i;
2829 
2830                 for (i = 0; i < notes->nr_events; i++) {
2831                         double percent;
2832 
2833                         percent = annotation_data__percent(&al->data[i], percent_type);
2834 
2835                         obj__set_percent_color(obj, percent, current_entry);
2836                         if (notes->options->show_total_period) {
2837                                 obj__printf(obj, "%11" PRIu64 " ", al->data[i].he.period);
2838                         } else if (notes->options->show_nr_samples) {
2839                                 obj__printf(obj, "%6" PRIu64 " ",
2840                                                    al->data[i].he.nr_samples);
2841                         } else {
2842                                 obj__printf(obj, "%6.2f ", percent);
2843                         }
2844                 }
2845         } else {
2846                 obj__set_percent_color(obj, 0, current_entry);
2847 
2848                 if (!show_title)
2849                         obj__printf(obj, "%-*s", pcnt_width, " ");
2850                 else {
2851                         obj__printf(obj, "%-*s", pcnt_width,
2852                                            notes->options->show_total_period ? "Period" :
2853                                            notes->options->show_nr_samples ? "Samples" : "Percent");
2854                 }
2855         }
2856 
2857         if (notes->have_cycles) {
2858                 if (al->ipc)
2859                         obj__printf(obj, "%*.2f ", ANNOTATION__IPC_WIDTH - 1, al->ipc);
2860                 else if (!show_title)
2861                         obj__printf(obj, "%*s", ANNOTATION__IPC_WIDTH, " ");
2862                 else
2863                         obj__printf(obj, "%*s ", ANNOTATION__IPC_WIDTH - 1, "IPC");
2864 
2865                 if (!notes->options->show_minmax_cycle) {
2866                         if (al->cycles)
2867                                 obj__printf(obj, "%*" PRIu64 " ",
2868                                            ANNOTATION__CYCLES_WIDTH - 1, al->cycles);
2869                         else if (!show_title)
2870                                 obj__printf(obj, "%*s",
2871                                             ANNOTATION__CYCLES_WIDTH, " ");
2872                         else
2873                                 obj__printf(obj, "%*s ",
2874                                             ANNOTATION__CYCLES_WIDTH - 1,
2875                                             "Cycle");
2876                 } else {
2877                         if (al->cycles) {
2878                                 char str[32];
2879 
2880                                 scnprintf(str, sizeof(str),
2881                                         "%" PRIu64 "(%" PRIu64 "/%" PRIu64 ")",
2882                                         al->cycles, al->cycles_min,
2883                                         al->cycles_max);
2884 
2885                                 obj__printf(obj, "%*s ",
2886                                             ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
2887                                             str);
2888                         } else if (!show_title)
2889                                 obj__printf(obj, "%*s",
2890                                             ANNOTATION__MINMAX_CYCLES_WIDTH,
2891                                             " ");
2892                         else
2893                                 obj__printf(obj, "%*s ",
2894                                             ANNOTATION__MINMAX_CYCLES_WIDTH - 1,
2895                                             "Cycle(min/max)");
2896                 }
2897 
2898                 if (show_title && !*al->line) {
2899                         ipc_coverage_string(bf, sizeof(bf), notes);
2900                         obj__printf(obj, "%*s", ANNOTATION__AVG_IPC_WIDTH, bf);
2901                 }
2902         }
2903 
2904         obj__printf(obj, " ");
2905 
2906         if (!*al->line)
2907                 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width, " ");
2908         else if (al->offset == -1) {
2909                 if (al->line_nr && notes->options->show_linenr)
2910                         printed = scnprintf(bf, sizeof(bf), "%-*d ", notes->widths.addr + 1, al->line_nr);
2911                 else
2912                         printed = scnprintf(bf, sizeof(bf), "%-*s  ", notes->widths.addr, " ");
2913                 obj__printf(obj, bf);
2914                 obj__printf(obj, "%-*s", width - printed - pcnt_width - cycles_width + 1, al->line);
2915         } else {
2916                 u64 addr = al->offset;
2917                 int color = -1;
2918 
2919                 if (!notes->options->use_offset)
2920                         addr += notes->start;
2921 
2922                 if (!notes->options->use_offset) {
2923                         printed = scnprintf(bf, sizeof(bf), "%" PRIx64 ": ", addr);
2924                 } else {
2925                         if (al->jump_sources &&
2926                             notes->options->offset_level >= ANNOTATION__OFFSET_JUMP_TARGETS) {
2927                                 if (notes->options->show_nr_jumps) {
2928                                         int prev;
2929                                         printed = scnprintf(bf, sizeof(bf), "%*d ",
2930                                                             notes->widths.jumps,
2931                                                             al->jump_sources);
2932                                         prev = obj__set_jumps_percent_color(obj, al->jump_sources,
2933                                                                             current_entry);
2934                                         obj__printf(obj, bf);
2935                                         obj__set_color(obj, prev);
2936                                 }
2937 print_addr:
2938                                 printed = scnprintf(bf, sizeof(bf), "%*" PRIx64 ": ",
2939                                                     notes->widths.target, addr);
2940                         } else if (ins__is_call(&disasm_line(al)->ins) &&
2941                                    notes->options->offset_level >= ANNOTATION__OFFSET_CALL) {
2942                                 goto print_addr;
2943                         } else if (notes->options->offset_level == ANNOTATION__MAX_OFFSET_LEVEL) {
2944                                 goto print_addr;
2945                         } else {
2946                                 printed = scnprintf(bf, sizeof(bf), "%-*s  ",
2947                                                     notes->widths.addr, " ");
2948                         }
2949                 }
2950 
2951                 if (change_color)
2952                         color = obj__set_color(obj, HE_COLORSET_ADDR);
2953                 obj__printf(obj, bf);
2954                 if (change_color)
2955                         obj__set_color(obj, color);
2956 
2957                 disasm_line__write(disasm_line(al), notes, obj, bf, sizeof(bf), obj__printf, obj__write_graph);
2958 
2959                 obj__printf(obj, "%-*s", width - pcnt_width - cycles_width - 3 - printed, bf);
2960         }
2961 
2962 }
2963 
2964 void annotation_line__write(struct annotation_line *al, struct annotation *notes,
2965                             struct annotation_write_ops *wops,
2966                             struct annotation_options *opts)
2967 {
2968         __annotation_line__write(al, notes, wops->first_line, wops->current_entry,
2969                                  wops->change_color, wops->width, wops->obj,
2970                                  opts->percent_type,
2971                                  wops->set_color, wops->set_percent_color,
2972                                  wops->set_jumps_percent_color, wops->printf,
2973                                  wops->write_graph);
2974 }
2975 
2976 int symbol__annotate2(struct symbol *sym, struct map *map, struct perf_evsel *evsel,
2977                       struct annotation_options *options, struct arch **parch)
2978 {
2979         struct annotation *notes = symbol__annotation(sym);
2980         size_t size = symbol__size(sym);
2981         int nr_pcnt = 1, err;
2982 
2983         notes->offsets = zalloc(size * sizeof(struct annotation_line *));
2984         if (notes->offsets == NULL)
2985                 return ENOMEM;
2986 
2987         if (perf_evsel__is_group_event(evsel))
2988                 nr_pcnt = evsel->nr_members;
2989 
2990         err = symbol__annotate(sym, map, evsel, 0, options, parch);
2991         if (err)
2992                 goto out_free_offsets;
2993 
2994         notes->options = options;
2995 
2996         symbol__calc_percent(sym, evsel);
2997 
2998         annotation__set_offsets(notes, size);
2999         annotation__mark_jump_targets(notes, sym);
3000         annotation__compute_ipc(notes, size);
3001         annotation__init_column_widths(notes, sym);
3002         notes->nr_events = nr_pcnt;
3003 
3004         annotation__update_column_widths(notes);
3005         sym->annotate2 = true;
3006 
3007         return 0;
3008 
3009 out_free_offsets:
3010         zfree(&notes->offsets);
3011         return err;
3012 }
3013 
3014 #define ANNOTATION__CFG(n) \
3015         { .name = #n, .value = &annotation__default_options.n, }
3016 
3017 /*
3018  * Keep the entries sorted, they are bsearch'ed
3019  */
3020 static struct annotation_config {
3021         const char *name;
3022         void *value;
3023 } annotation__configs[] = {
3024         ANNOTATION__CFG(hide_src_code),
3025         ANNOTATION__CFG(jump_arrows),
3026         ANNOTATION__CFG(offset_level),
3027         ANNOTATION__CFG(show_linenr),
3028         ANNOTATION__CFG(show_nr_jumps),
3029         ANNOTATION__CFG(show_nr_samples),
3030         ANNOTATION__CFG(show_total_period),
3031         ANNOTATION__CFG(use_offset),
3032 };
3033 
3034 #undef ANNOTATION__CFG
3035 
3036 static int annotation_config__cmp(const void *name, const void *cfgp)
3037 {
3038         const struct annotation_config *cfg = cfgp;
3039 
3040         return strcmp(name, cfg->name);
3041 }
3042 
3043 static int annotation__config(const char *var, const char *value,
3044                             void *data __maybe_unused)
3045 {
3046         struct annotation_config *cfg;
3047         const char *name;
3048 
3049         if (!strstarts(var, "annotate."))
3050                 return 0;
3051 
3052         name = var + 9;
3053         cfg = bsearch(name, annotation__configs, ARRAY_SIZE(annotation__configs),
3054                       sizeof(struct annotation_config), annotation_config__cmp);
3055 
3056         if (cfg == NULL)
3057                 pr_debug("%s variable unknown, ignoring...", var);
3058         else if (strcmp(var, "annotate.offset_level") == 0) {
3059                 perf_config_int(cfg->value, name, value);
3060 
3061                 if (*(int *)cfg->value > ANNOTATION__MAX_OFFSET_LEVEL)
3062                         *(int *)cfg->value = ANNOTATION__MAX_OFFSET_LEVEL;
3063                 else if (*(int *)cfg->value < ANNOTATION__MIN_OFFSET_LEVEL)
3064                         *(int *)cfg->value = ANNOTATION__MIN_OFFSET_LEVEL;
3065         } else {
3066                 *(bool *)cfg->value = perf_config_bool(name, value);
3067         }
3068         return 0;
3069 }
3070 
3071 void annotation_config__init(void)
3072 {
3073         perf_config(annotation__config, NULL);
3074 
3075         annotation__default_options.show_total_period = symbol_conf.show_total_period;
3076         annotation__default_options.show_nr_samples   = symbol_conf.show_nr_samples;
3077 }
3078 
3079 static unsigned int parse_percent_type(char *str1, char *str2)
3080 {
3081         unsigned int type = (unsigned int) -1;
3082 
3083         if (!strcmp("period", str1)) {
3084                 if (!strcmp("local", str2))
3085                         type = PERCENT_PERIOD_LOCAL;
3086                 else if (!strcmp("global", str2))
3087                         type = PERCENT_PERIOD_GLOBAL;
3088         }
3089 
3090         if (!strcmp("hits", str1)) {
3091                 if (!strcmp("local", str2))
3092                         type = PERCENT_HITS_LOCAL;
3093                 else if (!strcmp("global", str2))
3094                         type = PERCENT_HITS_GLOBAL;
3095         }
3096 
3097         return type;
3098 }
3099 
3100 int annotate_parse_percent_type(const struct option *opt, const char *_str,
3101                                 int unset __maybe_unused)
3102 {
3103         struct annotation_options *opts = opt->value;
3104         unsigned int type;
3105         char *str1, *str2;
3106         int err = -1;
3107 
3108         str1 = strdup(_str);
3109         if (!str1)
3110                 return -ENOMEM;
3111 
3112         str2 = strchr(str1, '-');
3113         if (!str2)
3114                 goto out;
3115 
3116         *str2++ = 0;
3117 
3118         type = parse_percent_type(str1, str2);
3119         if (type == (unsigned int) -1)
3120                 type = parse_percent_type(str2, str1);
3121         if (type != (unsigned int) -1) {
3122                 opts->percent_type = type;
3123                 err = 0;
3124         }
3125 
3126 out:
3127         free(str1);
3128         return err;
3129 }
3130 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp