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