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