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