1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * builtin-annotate.c 4 * 5 * Builtin annotate command: Analyze the perf.data input file, 6 * look up and read DSOs and symbol information and display 7 * a histogram of results, along various sorting keys. 8 */ 9 #include "builtin.h" 10 #include "perf.h" 11 12 #include "util/color.h" 13 #include <linux/list.h> 14 #include "util/cache.h" 15 #include <linux/rbtree.h> 16 #include "util/symbol.h" 17 18 #include "util/debug.h" 19 20 #include "util/evlist.h" 21 #include "util/evsel.h" 22 #include "util/annotate.h" 23 #include "util/annotate-data.h" 24 #include "util/event.h" 25 #include <subcmd/parse-options.h> 26 #include "util/parse-events.h" 27 #include "util/sort.h" 28 #include "util/hist.h" 29 #include "util/dso.h" 30 #include "util/machine.h" 31 #include "util/map.h" 32 #include "util/session.h" 33 #include "util/tool.h" 34 #include "util/data.h" 35 #include "arch/common.h" 36 #include "util/block-range.h" 37 #include "util/map_symbol.h" 38 #include "util/branch.h" 39 #include "util/util.h" 40 #include "ui/progress.h" 41 42 #include <dlfcn.h> 43 #include <errno.h> 44 #include <linux/bitmap.h> 45 #include <linux/err.h> 46 #include <inttypes.h> 47 48 struct perf_annotate { 49 struct perf_tool tool; 50 struct perf_session *session; 51 #ifdef HAVE_SLANG_SUPPORT 52 bool use_tui; 53 #endif 54 bool use_stdio, use_stdio2; 55 #ifdef HAVE_GTK2_SUPPORT 56 bool use_gtk; 57 #endif 58 bool skip_missing; 59 bool has_br_stack; 60 bool group_set; 61 bool data_type; 62 bool type_stat; 63 bool insn_stat; 64 float min_percent; 65 const char *sym_hist_filter; 66 const char *cpu_list; 67 const char *target_data_type; 68 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS); 69 }; 70 71 /* 72 * Given one basic block: 73 * 74 * from to branch_i 75 * * ----> * 76 * | 77 * | block 78 * v 79 * * ----> * 80 * from to branch_i+1 81 * 82 * where the horizontal are the branches and the vertical is the executed 83 * block of instructions. 84 * 85 * We count, for each 'instruction', the number of blocks that covered it as 86 * well as count the ratio each branch is taken. 87 * 88 * We can do this without knowing the actual instruction stream by keeping 89 * track of the address ranges. We break down ranges such that there is no 90 * overlap and iterate from the start until the end. 91 * 92 * @acme: once we parse the objdump output _before_ processing the samples, 93 * we can easily fold the branch.cycles IPC bits in. 94 */ 95 static void process_basic_block(struct addr_map_symbol *start, 96 struct addr_map_symbol *end, 97 struct branch_flags *flags) 98 { 99 struct symbol *sym = start->ms.sym; 100 struct annotation *notes = sym ? symbol__annotation(sym) : NULL; 101 struct block_range_iter iter; 102 struct block_range *entry; 103 struct annotated_branch *branch; 104 105 /* 106 * Sanity; NULL isn't executable and the CPU cannot execute backwards 107 */ 108 if (!start->addr || start->addr > end->addr) 109 return; 110 111 iter = block_range__create(start->addr, end->addr); 112 if (!block_range_iter__valid(&iter)) 113 return; 114 115 branch = annotation__get_branch(notes); 116 117 /* 118 * First block in range is a branch target. 119 */ 120 entry = block_range_iter(&iter); 121 assert(entry->is_target); 122 entry->entry++; 123 124 do { 125 entry = block_range_iter(&iter); 126 127 entry->coverage++; 128 entry->sym = sym; 129 130 if (branch) 131 branch->max_coverage = max(branch->max_coverage, entry->coverage); 132 133 } while (block_range_iter__next(&iter)); 134 135 /* 136 * Last block in rage is a branch. 137 */ 138 entry = block_range_iter(&iter); 139 assert(entry->is_branch); 140 entry->taken++; 141 if (flags->predicted) 142 entry->pred++; 143 } 144 145 static void process_branch_stack(struct branch_stack *bs, struct addr_location *al, 146 struct perf_sample *sample) 147 { 148 struct addr_map_symbol *prev = NULL; 149 struct branch_info *bi; 150 int i; 151 152 if (!bs || !bs->nr) 153 return; 154 155 bi = sample__resolve_bstack(sample, al); 156 if (!bi) 157 return; 158 159 for (i = bs->nr - 1; i >= 0; i--) { 160 /* 161 * XXX filter against symbol 162 */ 163 if (prev) 164 process_basic_block(prev, &bi[i].from, &bi[i].flags); 165 prev = &bi[i].to; 166 } 167 168 free(bi); 169 } 170 171 static int hist_iter__branch_callback(struct hist_entry_iter *iter, 172 struct addr_location *al __maybe_unused, 173 bool single __maybe_unused, 174 void *arg __maybe_unused) 175 { 176 struct hist_entry *he = iter->he; 177 struct branch_info *bi; 178 struct perf_sample *sample = iter->sample; 179 struct evsel *evsel = iter->evsel; 180 int err; 181 182 bi = he->branch_info; 183 err = addr_map_symbol__inc_samples(&bi->from, sample, evsel); 184 185 if (err) 186 goto out; 187 188 err = addr_map_symbol__inc_samples(&bi->to, sample, evsel); 189 190 out: 191 return err; 192 } 193 194 static int process_branch_callback(struct evsel *evsel, 195 struct perf_sample *sample, 196 struct addr_location *al, 197 struct perf_annotate *ann, 198 struct machine *machine) 199 { 200 struct hist_entry_iter iter = { 201 .evsel = evsel, 202 .sample = sample, 203 .add_entry_cb = hist_iter__branch_callback, 204 .hide_unresolved = symbol_conf.hide_unresolved, 205 .ops = &hist_iter_branch, 206 }; 207 struct addr_location a; 208 int ret; 209 210 addr_location__init(&a); 211 if (machine__resolve(machine, &a, sample) < 0) { 212 ret = -1; 213 goto out; 214 } 215 216 if (a.sym == NULL) { 217 ret = 0; 218 goto out; 219 } 220 221 if (a.map != NULL) 222 dso__set_hit(map__dso(a.map)); 223 224 hist__account_cycles(sample->branch_stack, al, sample, false, 225 NULL, evsel); 226 227 ret = hist_entry_iter__add(&iter, &a, PERF_MAX_STACK_DEPTH, ann); 228 out: 229 addr_location__exit(&a); 230 return ret; 231 } 232 233 static bool has_annotation(struct perf_annotate *ann) 234 { 235 return ui__has_annotation() || ann->use_stdio2; 236 } 237 238 static int evsel__add_sample(struct evsel *evsel, struct perf_sample *sample, 239 struct addr_location *al, struct perf_annotate *ann, 240 struct machine *machine) 241 { 242 struct hists *hists = evsel__hists(evsel); 243 struct hist_entry *he; 244 int ret; 245 246 if ((!ann->has_br_stack || !has_annotation(ann)) && 247 ann->sym_hist_filter != NULL && 248 (al->sym == NULL || 249 strcmp(ann->sym_hist_filter, al->sym->name) != 0)) { 250 /* We're only interested in a symbol named sym_hist_filter */ 251 /* 252 * FIXME: why isn't this done in the symbol_filter when loading 253 * the DSO? 254 */ 255 if (al->sym != NULL) { 256 struct dso *dso = map__dso(al->map); 257 258 rb_erase_cached(&al->sym->rb_node, dso__symbols(dso)); 259 symbol__delete(al->sym); 260 dso__reset_find_symbol_cache(dso); 261 } 262 return 0; 263 } 264 265 /* 266 * XXX filtered samples can still have branch entries pointing into our 267 * symbol and are missed. 268 */ 269 process_branch_stack(sample->branch_stack, al, sample); 270 271 if (ann->has_br_stack && has_annotation(ann)) 272 return process_branch_callback(evsel, sample, al, ann, machine); 273 274 he = hists__add_entry(hists, al, NULL, NULL, NULL, NULL, sample, true); 275 if (he == NULL) 276 return -ENOMEM; 277 278 ret = hist_entry__inc_addr_samples(he, sample, evsel, al->addr); 279 hists__inc_nr_samples(hists, true); 280 return ret; 281 } 282 283 static int process_sample_event(const struct perf_tool *tool, 284 union perf_event *event, 285 struct perf_sample *sample, 286 struct evsel *evsel, 287 struct machine *machine) 288 { 289 struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool); 290 struct addr_location al; 291 int ret = 0; 292 293 addr_location__init(&al); 294 if (machine__resolve(machine, &al, sample) < 0) { 295 pr_warning("problem processing %d event, skipping it.\n", 296 event->header.type); 297 ret = -1; 298 goto out_put; 299 } 300 301 if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap)) 302 goto out_put; 303 304 if (!al.filtered && 305 evsel__add_sample(evsel, sample, &al, ann, machine)) { 306 pr_warning("problem incrementing symbol count, " 307 "skipping event\n"); 308 ret = -1; 309 } 310 out_put: 311 addr_location__exit(&al); 312 return ret; 313 } 314 315 static int hist_entry__stdio_annotate(struct hist_entry *he, 316 struct evsel *evsel, 317 struct perf_annotate *ann) 318 { 319 if (ann->use_stdio2) 320 return hist_entry__tty_annotate2(he, evsel); 321 322 return hist_entry__tty_annotate(he, evsel); 323 } 324 325 static void print_annotate_data_stat(struct annotated_data_stat *s) 326 { 327 #define PRINT_STAT(fld) if (s->fld) printf("%10d : %s\n", s->fld, #fld) 328 329 int bad = s->no_sym + 330 s->no_insn + 331 s->no_insn_ops + 332 s->no_mem_ops + 333 s->no_reg + 334 s->no_dbginfo + 335 s->no_cuinfo + 336 s->no_var + 337 s->no_typeinfo + 338 s->invalid_size + 339 s->bad_offset; 340 int ok = s->total - bad; 341 342 printf("Annotate data type stats:\n"); 343 printf("total %d, ok %d (%.1f%%), bad %d (%.1f%%)\n", 344 s->total, ok, 100.0 * ok / (s->total ?: 1), bad, 100.0 * bad / (s->total ?: 1)); 345 printf("-----------------------------------------------------------\n"); 346 PRINT_STAT(no_sym); 347 PRINT_STAT(no_insn); 348 PRINT_STAT(no_insn_ops); 349 PRINT_STAT(no_mem_ops); 350 PRINT_STAT(no_reg); 351 PRINT_STAT(no_dbginfo); 352 PRINT_STAT(no_cuinfo); 353 PRINT_STAT(no_var); 354 PRINT_STAT(no_typeinfo); 355 PRINT_STAT(invalid_size); 356 PRINT_STAT(bad_offset); 357 PRINT_STAT(insn_track); 358 printf("\n"); 359 360 #undef PRINT_STAT 361 } 362 363 static void print_annotate_item_stat(struct list_head *head, const char *title) 364 { 365 struct annotated_item_stat *istat, *pos, *iter; 366 int total_good, total_bad, total; 367 int sum1, sum2; 368 LIST_HEAD(tmp); 369 370 /* sort the list by count */ 371 list_splice_init(head, &tmp); 372 total_good = total_bad = 0; 373 374 list_for_each_entry_safe(istat, pos, &tmp, list) { 375 total_good += istat->good; 376 total_bad += istat->bad; 377 sum1 = istat->good + istat->bad; 378 379 list_for_each_entry(iter, head, list) { 380 sum2 = iter->good + iter->bad; 381 if (sum1 > sum2) 382 break; 383 } 384 list_move_tail(&istat->list, &iter->list); 385 } 386 total = total_good + total_bad; 387 388 printf("Annotate %s stats\n", title); 389 printf("total %d, ok %d (%.1f%%), bad %d (%.1f%%)\n\n", total, 390 total_good, 100.0 * total_good / (total ?: 1), 391 total_bad, 100.0 * total_bad / (total ?: 1)); 392 printf(" %-20s: %5s %5s\n", "Name/opcode", "Good", "Bad"); 393 printf("-----------------------------------------------------------\n"); 394 list_for_each_entry(istat, head, list) 395 printf(" %-20s: %5d %5d\n", istat->name, istat->good, istat->bad); 396 printf("\n"); 397 } 398 399 static void hists__find_annotations(struct hists *hists, 400 struct evsel *evsel, 401 struct perf_annotate *ann) 402 { 403 struct rb_node *nd = rb_first_cached(&hists->entries), *next; 404 int key = K_RIGHT; 405 406 if (ann->type_stat) 407 print_annotate_data_stat(&ann_data_stat); 408 if (ann->insn_stat) 409 print_annotate_item_stat(&ann_insn_stat, "Instruction"); 410 411 while (nd) { 412 struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node); 413 struct annotation *notes; 414 415 if (he->ms.sym == NULL || dso__annotate_warned(map__dso(he->ms.map))) 416 goto find_next; 417 418 if (ann->sym_hist_filter && 419 (strcmp(he->ms.sym->name, ann->sym_hist_filter) != 0)) 420 goto find_next; 421 422 if (ann->min_percent) { 423 float percent = 0; 424 u64 total = hists__total_period(hists); 425 426 if (total) 427 percent = 100.0 * he->stat.period / total; 428 429 if (percent < ann->min_percent) 430 goto find_next; 431 } 432 433 notes = symbol__annotation(he->ms.sym); 434 if (notes->src == NULL) { 435 find_next: 436 if (key == K_LEFT || key == '<') 437 nd = rb_prev(nd); 438 else 439 nd = rb_next(nd); 440 continue; 441 } 442 443 if (ann->data_type) { 444 /* skip unknown type */ 445 if (he->mem_type->histograms == NULL) 446 goto find_next; 447 448 if (ann->target_data_type) { 449 const char *type_name = he->mem_type->self.type_name; 450 451 /* skip 'struct ' prefix in the type name */ 452 if (strncmp(ann->target_data_type, "struct ", 7) && 453 !strncmp(type_name, "struct ", 7)) 454 type_name += 7; 455 456 /* skip 'union ' prefix in the type name */ 457 if (strncmp(ann->target_data_type, "union ", 6) && 458 !strncmp(type_name, "union ", 6)) 459 type_name += 6; 460 461 if (strcmp(ann->target_data_type, type_name)) 462 goto find_next; 463 } 464 465 if (use_browser == 1) 466 key = hist_entry__annotate_data_tui(he, evsel, NULL); 467 else 468 key = hist_entry__annotate_data_tty(he, evsel); 469 470 switch (key) { 471 case -1: 472 if (!ann->skip_missing) 473 return; 474 /* fall through */ 475 case K_RIGHT: 476 case '>': 477 next = rb_next(nd); 478 break; 479 case K_LEFT: 480 case '<': 481 next = rb_prev(nd); 482 break; 483 default: 484 return; 485 } 486 487 if (use_browser == 0 || next != NULL) 488 nd = next; 489 490 continue; 491 } 492 493 if (use_browser == 2) { 494 int ret; 495 int (*annotate)(struct hist_entry *he, 496 struct evsel *evsel, 497 struct hist_browser_timer *hbt); 498 499 annotate = dlsym(perf_gtk_handle, 500 "hist_entry__gtk_annotate"); 501 if (annotate == NULL) { 502 ui__error("GTK browser not found!\n"); 503 return; 504 } 505 506 ret = annotate(he, evsel, NULL); 507 if (!ret || !ann->skip_missing) 508 return; 509 510 /* skip missing symbols */ 511 nd = rb_next(nd); 512 } else if (use_browser == 1) { 513 key = hist_entry__tui_annotate(he, evsel, NULL, NO_ADDR); 514 515 switch (key) { 516 case -1: 517 if (!ann->skip_missing) 518 return; 519 /* fall through */ 520 case K_RIGHT: 521 case '>': 522 next = rb_next(nd); 523 break; 524 case K_LEFT: 525 case '<': 526 next = rb_prev(nd); 527 break; 528 default: 529 return; 530 } 531 532 if (next != NULL) 533 nd = next; 534 } else { 535 hist_entry__stdio_annotate(he, evsel, ann); 536 nd = rb_next(nd); 537 } 538 } 539 } 540 541 static int __cmd_annotate(struct perf_annotate *ann) 542 { 543 int ret; 544 struct perf_session *session = ann->session; 545 struct evsel *pos; 546 u64 total_nr_samples; 547 548 if (ann->cpu_list) { 549 ret = perf_session__cpu_bitmap(session, ann->cpu_list, 550 ann->cpu_bitmap); 551 if (ret) 552 goto out; 553 } 554 555 if (!annotate_opts.objdump_path) { 556 ret = perf_env__lookup_objdump(perf_session__env(session), 557 &annotate_opts.objdump_path); 558 if (ret) 559 goto out; 560 } 561 562 ret = perf_session__process_events(session); 563 if (ret) 564 goto out; 565 566 if (dump_trace) { 567 perf_session__fprintf_nr_events(session, stdout); 568 evlist__fprintf_nr_events(session->evlist, stdout); 569 goto out; 570 } 571 572 if (verbose > 3) 573 perf_session__fprintf(session, stdout); 574 575 if (verbose > 2) 576 perf_session__fprintf_dsos(session, stdout); 577 578 total_nr_samples = 0; 579 evlist__for_each_entry(session->evlist, pos) { 580 struct hists *hists = evsel__hists(pos); 581 u32 nr_samples = hists->stats.nr_samples; 582 struct ui_progress prog; 583 584 if (nr_samples > 0) { 585 total_nr_samples += nr_samples; 586 587 ui_progress__init(&prog, nr_samples, 588 "Merging related events..."); 589 hists__collapse_resort(hists, &prog); 590 ui_progress__finish(); 591 592 /* Don't sort callchain */ 593 evsel__reset_sample_bit(pos, CALLCHAIN); 594 595 ui_progress__init(&prog, nr_samples, 596 "Sorting events for output..."); 597 evsel__output_resort(pos, &prog); 598 ui_progress__finish(); 599 600 /* 601 * An event group needs to display other events too. 602 * Let's delay printing until other events are processed. 603 */ 604 if (symbol_conf.event_group) { 605 if (!evsel__is_group_leader(pos)) { 606 struct hists *leader_hists; 607 608 leader_hists = evsel__hists(evsel__leader(pos)); 609 hists__match(leader_hists, hists); 610 hists__link(leader_hists, hists); 611 } 612 continue; 613 } 614 615 hists__find_annotations(hists, pos, ann); 616 } 617 } 618 619 if (total_nr_samples == 0) { 620 ui__error("The %s data has no samples!\n", session->data->path); 621 goto out; 622 } 623 624 /* Display group events together */ 625 evlist__for_each_entry(session->evlist, pos) { 626 struct hists *hists = evsel__hists(pos); 627 u32 nr_samples = hists->stats.nr_samples; 628 struct ui_progress prog; 629 struct evsel *evsel; 630 631 if (!symbol_conf.event_group || !evsel__is_group_leader(pos)) 632 continue; 633 634 for_each_group_member(evsel, pos) 635 nr_samples += evsel__hists(evsel)->stats.nr_samples; 636 637 if (nr_samples == 0) 638 continue; 639 640 ui_progress__init(&prog, nr_samples, 641 "Sorting group events for output..."); 642 evsel__output_resort(pos, &prog); 643 ui_progress__finish(); 644 645 hists__find_annotations(hists, pos, ann); 646 } 647 648 if (use_browser == 2) { 649 void (*show_annotations)(void); 650 651 show_annotations = dlsym(perf_gtk_handle, 652 "perf_gtk__show_annotations"); 653 if (show_annotations == NULL) { 654 ui__error("GTK browser not found!\n"); 655 goto out; 656 } 657 show_annotations(); 658 } 659 660 out: 661 return ret; 662 } 663 664 static int parse_percent_limit(const struct option *opt, const char *str, 665 int unset __maybe_unused) 666 { 667 struct perf_annotate *ann = opt->value; 668 double pcnt = strtof(str, NULL); 669 670 ann->min_percent = pcnt; 671 return 0; 672 } 673 674 static int parse_data_type(const struct option *opt, const char *str, int unset) 675 { 676 struct perf_annotate *ann = opt->value; 677 678 ann->data_type = !unset; 679 if (str) 680 ann->target_data_type = strdup(str); 681 682 return 0; 683 } 684 685 static const char * const annotate_usage[] = { 686 "perf annotate [<options>]", 687 NULL 688 }; 689 690 int cmd_annotate(int argc, const char **argv) 691 { 692 struct perf_annotate annotate = {}; 693 struct perf_data data = { 694 .mode = PERF_DATA_MODE_READ, 695 }; 696 struct itrace_synth_opts itrace_synth_opts = { 697 .set = 0, 698 }; 699 const char *disassembler_style = NULL, *objdump_path = NULL, *addr2line_path = NULL; 700 struct option options[] = { 701 OPT_STRING('i', "input", &input_name, "file", 702 "input file name"), 703 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]", 704 "only consider symbols in these dsos"), 705 OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol", 706 "symbol to annotate"), 707 OPT_BOOLEAN('f', "force", &data.force, "don't complain, do it"), 708 OPT_INCR('v', "verbose", &verbose, 709 "be more verbose (show symbol address, etc)"), 710 OPT_BOOLEAN('q', "quiet", &quiet, "do now show any warnings or messages"), 711 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, 712 "dump raw trace in ASCII"), 713 #ifdef HAVE_GTK2_SUPPORT 714 OPT_BOOLEAN(0, "gtk", &annotate.use_gtk, "Use the GTK interface"), 715 #endif 716 #ifdef HAVE_SLANG_SUPPORT 717 OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"), 718 #endif 719 OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"), 720 OPT_BOOLEAN(0, "stdio2", &annotate.use_stdio2, "Use the stdio interface"), 721 OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux, 722 "don't load vmlinux even if found"), 723 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, 724 "file", "vmlinux pathname"), 725 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules, 726 "load module symbols - WARNING: use only with -k and LIVE kernel"), 727 OPT_BOOLEAN('l', "print-line", &annotate_opts.print_lines, 728 "print matching source lines (may be slow)"), 729 OPT_BOOLEAN('P', "full-paths", &annotate_opts.full_path, 730 "Don't shorten the displayed pathnames"), 731 OPT_BOOLEAN(0, "skip-missing", &annotate.skip_missing, 732 "Skip symbols that cannot be annotated"), 733 OPT_BOOLEAN_SET(0, "group", &symbol_conf.event_group, 734 &annotate.group_set, 735 "Show event group information together"), 736 OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"), 737 OPT_CALLBACK(0, "symfs", NULL, "directory[,layout]", SYMFS_HELP, 738 symbol__config_symfs), 739 OPT_BOOLEAN(0, "source", &annotate_opts.annotate_src, 740 "Interleave source code with assembly code (default)"), 741 OPT_BOOLEAN(0, "asm-raw", &annotate_opts.show_asm_raw, 742 "Display raw encoding of assembly instructions (default)"), 743 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style", 744 "Specify disassembler style (e.g. -M intel for intel syntax)"), 745 OPT_STRING(0, "prefix", &annotate_opts.prefix, "prefix", 746 "Add prefix to source file path names in programs (with --prefix-strip)"), 747 OPT_STRING(0, "prefix-strip", &annotate_opts.prefix_strip, "N", 748 "Strip first N entries of source file path name in programs (with --prefix)"), 749 OPT_STRING(0, "objdump", &objdump_path, "path", 750 "objdump binary to use for disassembly and annotations"), 751 OPT_STRING(0, "addr2line", &addr2line_path, "path", 752 "addr2line binary to use for line numbers"), 753 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle, 754 "Enable symbol demangling"), 755 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel, 756 "Enable kernel symbol demangling"), 757 OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period, 758 "Show a column with the sum of periods"), 759 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples, 760 "Show a column with the number of samples"), 761 OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL, "mode", 762 "'always' (default), 'never' or 'auto' only applicable to --stdio mode", 763 stdio__config_color, "always"), 764 OPT_CALLBACK(0, "percent-type", &annotate_opts, "local-period", 765 "Set percent type local/global-period/hits", 766 annotate_parse_percent_type), 767 OPT_CALLBACK(0, "percent-limit", &annotate, "percent", 768 "Don't show entries under that percent", parse_percent_limit), 769 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts", 770 "Instruction Tracing options\n" ITRACE_HELP, 771 itrace_parse_synth_opts), 772 OPT_CALLBACK_OPTARG(0, "data-type", &annotate, NULL, "name", 773 "Show data type annotate for the memory accesses", 774 parse_data_type), 775 OPT_BOOLEAN(0, "type-stat", &annotate.type_stat, 776 "Show stats for the data type annotation"), 777 OPT_BOOLEAN(0, "insn-stat", &annotate.insn_stat, 778 "Show instruction stats for the data type annotation"), 779 OPT_BOOLEAN(0, "skip-empty", &symbol_conf.skip_empty, 780 "Do not display empty (or dummy) events in the output"), 781 OPT_BOOLEAN(0, "code-with-type", &annotate_opts.code_with_type, 782 "Show data type info in code annotation (memory instructions only)"), 783 OPT_END() 784 }; 785 int ret; 786 787 set_option_flag(options, 0, "show-total-period", PARSE_OPT_EXCLUSIVE); 788 set_option_flag(options, 0, "show-nr-samples", PARSE_OPT_EXCLUSIVE); 789 790 annotation_options__init(); 791 792 ret = hists__init(); 793 if (ret < 0) 794 return ret; 795 796 annotation_config__init(); 797 798 argc = parse_options(argc, argv, options, annotate_usage, 0); 799 if (argc) { 800 /* 801 * Special case: if there's an argument left then assume that 802 * it's a symbol filter: 803 */ 804 if (argc > 1) 805 usage_with_options(annotate_usage, options); 806 807 annotate.sym_hist_filter = argv[0]; 808 } 809 810 if (disassembler_style) { 811 annotate_opts.disassembler_style = strdup(disassembler_style); 812 if (!annotate_opts.disassembler_style) 813 return -ENOMEM; 814 } 815 if (objdump_path) { 816 annotate_opts.objdump_path = strdup(objdump_path); 817 if (!annotate_opts.objdump_path) 818 return -ENOMEM; 819 } 820 if (addr2line_path) { 821 symbol_conf.addr2line_path = strdup(addr2line_path); 822 if (!symbol_conf.addr2line_path) 823 return -ENOMEM; 824 } 825 826 if (annotate_check_args() < 0) 827 return -EINVAL; 828 829 #ifdef HAVE_GTK2_SUPPORT 830 if (symbol_conf.show_nr_samples && annotate.use_gtk) { 831 pr_err("--show-nr-samples is not available in --gtk mode at this time\n"); 832 return ret; 833 } 834 #endif 835 836 #ifndef HAVE_LIBDW_SUPPORT 837 if (annotate.data_type) { 838 pr_err("Error: Data type profiling is disabled due to missing DWARF support\n"); 839 return -ENOTSUP; 840 } 841 #endif 842 843 ret = symbol__validate_sym_arguments(); 844 if (ret) 845 return ret; 846 847 if (quiet) 848 perf_quiet_option(); 849 850 data.path = input_name; 851 852 perf_tool__init(&annotate.tool, /*ordered_events=*/true); 853 annotate.tool.sample = process_sample_event; 854 annotate.tool.mmap = perf_event__process_mmap; 855 annotate.tool.mmap2 = perf_event__process_mmap2; 856 annotate.tool.comm = perf_event__process_comm; 857 annotate.tool.exit = perf_event__process_exit; 858 annotate.tool.fork = perf_event__process_fork; 859 annotate.tool.namespaces = perf_event__process_namespaces; 860 annotate.tool.attr = perf_event__process_attr; 861 annotate.tool.build_id = perf_event__process_build_id; 862 #ifdef HAVE_LIBTRACEEVENT 863 annotate.tool.tracing_data = perf_event__process_tracing_data; 864 #endif 865 annotate.tool.id_index = perf_event__process_id_index; 866 annotate.tool.auxtrace_info = perf_event__process_auxtrace_info; 867 annotate.tool.auxtrace = perf_event__process_auxtrace; 868 annotate.tool.feature = perf_event__process_feature; 869 annotate.tool.ordering_requires_timestamps = true; 870 871 annotate.session = perf_session__new(&data, &annotate.tool); 872 if (IS_ERR(annotate.session)) 873 return PTR_ERR(annotate.session); 874 875 annotate.session->itrace_synth_opts = &itrace_synth_opts; 876 877 annotate.has_br_stack = perf_header__has_feat(&annotate.session->header, 878 HEADER_BRANCH_STACK); 879 880 if (annotate.group_set) 881 evlist__force_leader(annotate.session->evlist); 882 883 ret = symbol__annotation_init(); 884 if (ret < 0) 885 goto out_delete; 886 887 symbol_conf.try_vmlinux_path = true; 888 889 ret = symbol__init(perf_session__env(annotate.session)); 890 if (ret < 0) 891 goto out_delete; 892 893 if (annotate.use_stdio || annotate.use_stdio2) 894 use_browser = 0; 895 #ifdef HAVE_SLANG_SUPPORT 896 else if (annotate.use_tui) 897 use_browser = 1; 898 #endif 899 #ifdef HAVE_GTK2_SUPPORT 900 else if (annotate.use_gtk) 901 use_browser = 2; 902 #endif 903 904 if (annotate.data_type) { 905 annotate_opts.annotate_src = false; 906 symbol_conf.annotate_data_member = true; 907 symbol_conf.annotate_data_sample = true; 908 } else if (annotate_opts.code_with_type) { 909 symbol_conf.annotate_data_member = true; 910 } 911 912 setup_browser(true); 913 914 /* 915 * Events of different processes may correspond to the same 916 * symbol, we do not care about the processes in annotate, 917 * set sort order to avoid repeated output. 918 */ 919 if (annotate.data_type) 920 sort_order = "dso,type"; 921 else 922 sort_order = "dso,symbol"; 923 924 /* 925 * Set SORT_MODE__BRANCH so that annotate displays IPC/Cycle and 926 * branch counters, if the corresponding branch info is available 927 * in the perf data in the TUI mode. 928 */ 929 if ((use_browser == 1 || annotate.use_stdio2) && annotate.has_br_stack) { 930 sort__mode = SORT_MODE__BRANCH; 931 if (annotate.session->evlist->nr_br_cntr > 0) 932 annotate_opts.show_br_cntr = true; 933 } 934 935 if (setup_sorting(/*evlist=*/NULL, perf_session__env(annotate.session)) < 0) 936 usage_with_options(annotate_usage, options); 937 938 ret = __cmd_annotate(&annotate); 939 940 out_delete: 941 /* 942 * Speed up the exit process by only deleting for debug builds. For 943 * large files this can save time. 944 */ 945 #ifndef NDEBUG 946 perf_session__delete(annotate.session); 947 #endif 948 annotation_options__exit(); 949 950 return ret; 951 } 952