1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * builtin-report.c 4 * 5 * Builtin report 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 11 #include "util/config.h" 12 13 #include "util/annotate.h" 14 #include "util/color.h" 15 #include "util/dso.h" 16 #include <linux/list.h> 17 #include <linux/rbtree.h> 18 #include <linux/err.h> 19 #include <linux/zalloc.h> 20 #include "util/map.h" 21 #include "util/symbol.h" 22 #include "util/map_symbol.h" 23 #include "util/mem-events.h" 24 #include "util/branch.h" 25 #include "util/callchain.h" 26 #include "util/values.h" 27 28 #include "perf.h" 29 #include "util/debug.h" 30 #include "util/event.h" 31 #include "util/evlist.h" 32 #include "util/evsel.h" 33 #include "util/evswitch.h" 34 #include "util/header.h" 35 #include "util/mem-info.h" 36 #include "util/session.h" 37 #include "util/srcline.h" 38 #include "util/tool.h" 39 40 #include <subcmd/parse-options.h> 41 #include <subcmd/exec-cmd.h> 42 #include "util/parse-events.h" 43 44 #include "util/thread.h" 45 #include "util/sort.h" 46 #include "util/hist.h" 47 #include "util/data.h" 48 #include "arch/common.h" 49 #include "util/time-utils.h" 50 #include "util/auxtrace.h" 51 #include "util/units.h" 52 #include "util/unwind.h" 53 #include "util/util.h" // perf_tip() 54 #include "ui/ui.h" 55 #include "ui/progress.h" 56 #include "util/block-info.h" 57 58 #include <dlfcn.h> 59 #include <errno.h> 60 #include <inttypes.h> 61 #include <regex.h> 62 #include <linux/ctype.h> 63 #include <signal.h> 64 #include <linux/bitmap.h> 65 #include <linux/list_sort.h> 66 #include <linux/string.h> 67 #include <linux/stringify.h> 68 #include <linux/time64.h> 69 #include <sys/types.h> 70 #include <sys/stat.h> 71 #include <unistd.h> 72 #include <linux/mman.h> 73 74 #ifdef HAVE_LIBTRACEEVENT 75 #include <event-parse.h> 76 #endif 77 78 struct report { 79 struct perf_tool tool; 80 struct perf_session *session; 81 struct evswitch evswitch; 82 #ifdef HAVE_SLANG_SUPPORT 83 bool use_tui; 84 #endif 85 #ifdef HAVE_GTK2_SUPPORT 86 bool use_gtk; 87 #endif 88 bool use_stdio; 89 bool show_full_info; 90 bool show_threads; 91 bool inverted_callchain; 92 bool mem_mode; 93 bool stats_mode; 94 bool tasks_mode; 95 bool mmaps_mode; 96 bool header; 97 bool header_only; 98 bool nonany_branch_mode; 99 bool group_set; 100 bool stitch_lbr; 101 bool disable_order; 102 bool skip_empty; 103 bool data_type; 104 int max_stack; 105 struct perf_read_values show_threads_values; 106 const char *pretty_printing_style; 107 const char *cpu_list; 108 const char *symbol_filter_str; 109 const char *time_str; 110 struct perf_time_interval *ptime_range; 111 int range_size; 112 int range_num; 113 float min_percent; 114 u64 nr_entries; 115 u64 queue_size; 116 u64 total_cycles; 117 u64 total_samples; 118 u64 singlethreaded_samples; 119 int socket_filter; 120 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS); 121 struct branch_type_stat brtype_stat; 122 bool symbol_ipc; 123 bool total_cycles_mode; 124 struct block_report *block_reports; 125 int nr_block_reports; 126 }; 127 128 static int report__config(const char *var, const char *value, void *cb) 129 { 130 struct report *rep = cb; 131 132 if (!strcmp(var, "report.group")) { 133 symbol_conf.event_group = perf_config_bool(var, value); 134 return 0; 135 } 136 if (!strcmp(var, "report.percent-limit")) { 137 double pcnt = strtof(value, NULL); 138 139 rep->min_percent = pcnt; 140 callchain_param.min_percent = pcnt; 141 return 0; 142 } 143 if (!strcmp(var, "report.children")) { 144 symbol_conf.cumulate_callchain = perf_config_bool(var, value); 145 return 0; 146 } 147 if (!strcmp(var, "report.queue-size")) 148 return perf_config_u64(&rep->queue_size, var, value); 149 150 if (!strcmp(var, "report.sort_order")) { 151 default_sort_order = strdup(value); 152 if (!default_sort_order) { 153 pr_err("Not enough memory for report.sort_order\n"); 154 return -1; 155 } 156 return 0; 157 } 158 159 if (!strcmp(var, "report.skip-empty")) { 160 rep->skip_empty = perf_config_bool(var, value); 161 return 0; 162 } 163 164 pr_debug("%s variable unknown, ignoring...", var); 165 return 0; 166 } 167 168 static int hist_iter__report_callback(struct hist_entry_iter *iter, 169 struct addr_location *al, bool single, 170 void *arg) 171 { 172 int err = 0; 173 struct report *rep = arg; 174 struct hist_entry *he = iter->he; 175 struct perf_sample *sample = iter->sample; 176 struct mem_info *mi; 177 struct branch_info *bi; 178 179 if (!ui__has_annotation() && !rep->symbol_ipc) 180 return 0; 181 182 if (sort__mode == SORT_MODE__BRANCH) { 183 bi = he->branch_info; 184 err = addr_map_symbol__inc_samples(&bi->from, sample); 185 if (err) 186 goto out; 187 188 err = addr_map_symbol__inc_samples(&bi->to, sample); 189 190 } else if (rep->mem_mode) { 191 mi = he->mem_info; 192 err = addr_map_symbol__inc_samples(mem_info__daddr(mi), sample); 193 if (err) 194 goto out; 195 196 err = hist_entry__inc_addr_samples(he, sample, al->addr); 197 198 } else if (symbol_conf.cumulate_callchain) { 199 if (single) 200 err = hist_entry__inc_addr_samples(he, sample, al->addr); 201 } else { 202 err = hist_entry__inc_addr_samples(he, sample, al->addr); 203 } 204 205 out: 206 return err; 207 } 208 209 static int hist_iter__branch_callback(struct hist_entry_iter *iter, 210 struct addr_location *al __maybe_unused, 211 bool single __maybe_unused, 212 void *arg) 213 { 214 struct hist_entry *he = iter->he; 215 struct report *rep = arg; 216 struct branch_info *bi = he->branch_info; 217 struct perf_sample *sample = iter->sample; 218 int err; 219 220 branch_type_count(&rep->brtype_stat, &bi->flags, 221 bi->from.addr, bi->to.addr); 222 223 if (!ui__has_annotation() && !rep->symbol_ipc) 224 return 0; 225 226 err = addr_map_symbol__inc_samples(&bi->from, sample); 227 if (err) 228 goto out; 229 230 err = addr_map_symbol__inc_samples(&bi->to, sample); 231 232 out: 233 return err; 234 } 235 236 static void setup_forced_leader(struct report *report, 237 struct evlist *evlist) 238 { 239 if (report->group_set) 240 evlist__force_leader(evlist); 241 } 242 243 static int process_feature_event(const struct perf_tool *tool, 244 struct perf_session *session, 245 union perf_event *event) 246 { 247 struct report *rep = container_of(tool, struct report, tool); 248 int ret = perf_event__process_feature(tool, session, event); 249 250 if (ret == 0 && event->header.size == sizeof(struct perf_record_header_feature) && 251 (int)event->feat.feat_id >= session->header.last_feat) { 252 /* 253 * (feat_id = HEADER_LAST_FEATURE) is the end marker which means 254 * all features are received. 255 */ 256 if (rep->header_only) 257 session_done = 1; 258 259 setup_forced_leader(rep, session->evlist); 260 } 261 return ret; 262 } 263 264 static int process_sample_event(const struct perf_tool *tool, 265 union perf_event *event, 266 struct perf_sample *sample, 267 struct machine *machine) 268 { 269 struct report *rep = container_of(tool, struct report, tool); 270 struct addr_location al; 271 struct hist_entry_iter iter = { 272 .sample = sample, 273 .hide_unresolved = symbol_conf.hide_unresolved, 274 .add_entry_cb = hist_iter__report_callback, 275 }; 276 int ret = 0; 277 278 if (perf_time__ranges_skip_sample(rep->ptime_range, rep->range_num, 279 sample->time)) { 280 return 0; 281 } 282 283 if (evswitch__discard(&rep->evswitch, sample->evsel)) 284 return 0; 285 286 addr_location__init(&al); 287 if (machine__resolve(machine, &al, sample) < 0) { 288 pr_debug("problem processing %s (%u) event at offset %#" PRIx64 ", skipping it.\n", 289 perf_event__name(event->header.type), event->header.type, 290 sample->file_offset); 291 ret = -1; 292 goto out_put; 293 } 294 295 if (rep->stitch_lbr) 296 thread__set_lbr_stitch_enable(al.thread, true); 297 298 if (symbol_conf.hide_unresolved && al.sym == NULL) 299 goto out_put; 300 301 if (rep->cpu_list && (sample->cpu >= MAX_NR_CPUS || 302 !test_bit(sample->cpu, rep->cpu_bitmap))) 303 goto out_put; 304 305 if (sort__mode == SORT_MODE__BRANCH) { 306 /* 307 * A non-synthesized event might not have a branch stack if 308 * branch stacks have been synthesized (using itrace options). 309 */ 310 if (!sample->branch_stack) 311 goto out_put; 312 313 iter.add_entry_cb = hist_iter__branch_callback; 314 iter.ops = &hist_iter_branch; 315 } else if (rep->mem_mode) { 316 iter.ops = &hist_iter_mem; 317 } else if (symbol_conf.cumulate_callchain) { 318 iter.ops = &hist_iter_cumulative; 319 } else { 320 iter.ops = &hist_iter_normal; 321 } 322 323 if (al.map != NULL) 324 dso__set_hit(map__dso(al.map)); 325 326 if (ui__has_annotation() || rep->symbol_ipc || rep->total_cycles_mode) { 327 hist__account_cycles(sample->branch_stack, &al, sample, 328 rep->nonany_branch_mode, 329 &rep->total_cycles); 330 } 331 332 rep->total_samples++; 333 if (al.parallelism == 1) 334 rep->singlethreaded_samples++; 335 336 ret = hist_entry_iter__add(&iter, &al, rep->max_stack, rep); 337 if (ret < 0) 338 pr_debug("problem adding hist entry at offset %#" PRIx64 ", skipping event\n", 339 sample->file_offset); 340 out_put: 341 addr_location__exit(&al); 342 return ret; 343 } 344 345 static int process_read_event(const struct perf_tool *tool, 346 union perf_event *event, 347 struct perf_sample *sample __maybe_unused, 348 struct machine *machine __maybe_unused) 349 { 350 struct report *rep = container_of(tool, struct report, tool); 351 352 if (rep->show_threads) { 353 int err = perf_read_values_add_value(&rep->show_threads_values, 354 event->read.pid, event->read.tid, 355 sample->evsel, 356 event->read.value); 357 358 if (err) 359 return err; 360 } 361 362 return 0; 363 } 364 365 /* For pipe mode, sample_type is not currently set */ 366 static int report__setup_sample_type(struct report *rep) 367 { 368 struct perf_session *session = rep->session; 369 u64 sample_type = evlist__combined_sample_type(session->evlist); 370 bool is_pipe = perf_data__is_pipe(session->data); 371 struct evsel *evsel; 372 373 if (session->itrace_synth_opts->callchain || 374 session->itrace_synth_opts->add_callchain || 375 (!is_pipe && 376 perf_header__has_feat(&session->header, HEADER_AUXTRACE) && 377 !session->itrace_synth_opts->set)) 378 sample_type |= PERF_SAMPLE_CALLCHAIN; 379 380 if (session->itrace_synth_opts->last_branch || 381 session->itrace_synth_opts->add_last_branch) 382 sample_type |= PERF_SAMPLE_BRANCH_STACK; 383 384 if (!is_pipe && !(sample_type & PERF_SAMPLE_CALLCHAIN)) { 385 if (perf_hpp_list.parent) { 386 ui__error("Selected --sort parent, but no " 387 "callchain data. Did you call " 388 "'perf record' without -g?\n"); 389 return -EINVAL; 390 } 391 if (symbol_conf.use_callchain && 392 !symbol_conf.show_branchflag_count) { 393 ui__error("Selected -g or --branch-history.\n" 394 "But no callchain or branch data.\n" 395 "Did you call 'perf record' without -g or -b?\n"); 396 return -1; 397 } 398 } else if (!callchain_param.enabled && 399 callchain_param.mode != CHAIN_NONE && 400 !symbol_conf.use_callchain) { 401 symbol_conf.use_callchain = true; 402 if (callchain_register_param(&callchain_param) < 0) { 403 ui__error("Can't register callchain params.\n"); 404 return -EINVAL; 405 } 406 } 407 408 if (symbol_conf.cumulate_callchain) { 409 /* Silently ignore if callchain is missing */ 410 if (!(sample_type & PERF_SAMPLE_CALLCHAIN)) { 411 symbol_conf.cumulate_callchain = false; 412 perf_hpp__cancel_cumulate(session->evlist); 413 } 414 } 415 416 if (sort__mode == SORT_MODE__BRANCH) { 417 if (!is_pipe && 418 !(sample_type & PERF_SAMPLE_BRANCH_STACK)) { 419 ui__error("Selected -b but no branch data. " 420 "Did you call perf record without -b?\n"); 421 return -1; 422 } 423 } 424 425 if (sort__mode == SORT_MODE__MEMORY) { 426 /* 427 * FIXUP: prior to kernel 5.18, Arm SPE missed to set 428 * PERF_SAMPLE_DATA_SRC bit in sample type. For backward 429 * compatibility, set the bit if it's an old perf data file. 430 */ 431 evlist__for_each_entry(session->evlist, evsel) { 432 if (strstr(evsel__name(evsel), "arm_spe") && 433 !(sample_type & PERF_SAMPLE_DATA_SRC)) { 434 evsel->core.attr.sample_type |= PERF_SAMPLE_DATA_SRC; 435 sample_type |= PERF_SAMPLE_DATA_SRC; 436 } 437 } 438 439 if (!is_pipe && !(sample_type & PERF_SAMPLE_DATA_SRC)) { 440 ui__error("Selected --mem-mode but no mem data. " 441 "Did you call perf record without -d?\n"); 442 return -1; 443 } 444 } 445 446 callchain_param_setup(sample_type, perf_session__e_machine(session, /*e_flags=*/NULL)); 447 448 if (rep->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) { 449 ui__warning("Can't find LBR callchain. Switch off --stitch-lbr.\n" 450 "Please apply --call-graph lbr when recording.\n"); 451 rep->stitch_lbr = false; 452 } 453 454 /* ??? handle more cases than just ANY? */ 455 if (!(evlist__combined_branch_type(session->evlist) & PERF_SAMPLE_BRANCH_ANY)) 456 rep->nonany_branch_mode = true; 457 458 #if !defined(HAVE_LIBUNWIND_SUPPORT) && !defined(HAVE_LIBDW_SUPPORT) 459 if (dwarf_callchain_users) { 460 ui__warning("Please install libunwind or libdw " 461 "development packages during the perf build.\n"); 462 } 463 #endif 464 465 return 0; 466 } 467 468 static void sig_handler(int sig __maybe_unused) 469 { 470 session_done = 1; 471 } 472 473 static size_t hists__fprintf_nr_sample_events(struct hists *hists, struct report *rep, 474 const char *evname, FILE *fp) 475 { 476 size_t ret; 477 char unit; 478 unsigned long nr_samples = hists->stats.nr_samples; 479 u64 nr_events = hists->stats.total_period; 480 struct evsel *evsel = hists_to_evsel(hists); 481 char buf[512]; 482 size_t size = sizeof(buf); 483 int socked_id = hists->socket_filter; 484 485 if (quiet) 486 return 0; 487 488 if (symbol_conf.filter_relative) { 489 nr_samples = hists->stats.nr_non_filtered_samples; 490 nr_events = hists->stats.total_non_filtered_period; 491 } 492 493 if (evsel__is_group_event(evsel)) { 494 struct evsel *pos; 495 496 evsel__group_desc(evsel, buf, size); 497 evname = buf; 498 499 for_each_group_member(pos, evsel) { 500 const struct hists *pos_hists = evsel__hists(pos); 501 502 if (symbol_conf.filter_relative) { 503 nr_samples += pos_hists->stats.nr_non_filtered_samples; 504 nr_events += pos_hists->stats.total_non_filtered_period; 505 } else { 506 nr_samples += pos_hists->stats.nr_samples; 507 nr_events += pos_hists->stats.total_period; 508 } 509 } 510 } 511 512 nr_samples = convert_unit(nr_samples, &unit); 513 ret = fprintf(fp, "# Samples: %lu%c", nr_samples, unit); 514 if (evname != NULL) { 515 ret += fprintf(fp, " of event%s '%s'", 516 evsel->core.nr_members > 1 ? "s" : "", evname); 517 } 518 519 if (rep->time_str) 520 ret += fprintf(fp, " (time slices: %s)", rep->time_str); 521 522 if (symbol_conf.show_ref_callgraph && evname && strstr(evname, "call-graph=no")) { 523 ret += fprintf(fp, ", show reference callgraph"); 524 } 525 526 if (rep->mem_mode) { 527 ret += fprintf(fp, "\n# Total weight : %" PRIu64, nr_events); 528 if (sort_order || !field_order) { 529 ret += fprintf(fp, "\n# Sort order : %s", 530 sort_order ? : default_mem_sort_order); 531 } 532 } else 533 ret += fprintf(fp, "\n# Event count (approx.): %" PRIu64, nr_events); 534 535 if (socked_id > -1) 536 ret += fprintf(fp, "\n# Processor Socket: %d", socked_id); 537 538 return ret + fprintf(fp, "\n#\n"); 539 } 540 541 static int evlist__tui_block_hists_browse(struct evlist *evlist, struct report *rep) 542 { 543 struct evsel *pos; 544 int i = 0, ret; 545 546 evlist__for_each_entry(evlist, pos) { 547 ret = report__browse_block_hists(&rep->block_reports[i++].hist, 548 rep->min_percent, pos, 549 perf_session__env(rep->session)); 550 if (ret != 0) 551 return ret; 552 } 553 554 return 0; 555 } 556 557 static int evlist__tty_browse_hists(struct evlist *evlist, struct report *rep, const char *help) 558 { 559 struct evsel *pos; 560 int i = 0; 561 562 if (!quiet) { 563 fprintf(stdout, "#\n# Total Lost Samples: %" PRIu64 "\n#\n", 564 evlist__stats(evlist)->total_lost_samples); 565 } 566 567 evlist__for_each_entry(evlist, pos) { 568 struct hists *hists = evsel__hists(pos); 569 const char *evname = evsel__name(pos); 570 571 i++; 572 if (symbol_conf.event_group && !evsel__is_group_leader(pos)) 573 continue; 574 575 if (rep->skip_empty && !hists->stats.nr_samples) 576 continue; 577 578 hists__fprintf_nr_sample_events(hists, rep, evname, stdout); 579 580 if (rep->total_cycles_mode) { 581 char *buf; 582 583 if (!annotation_br_cntr_abbr_list(&buf, pos, true)) { 584 fprintf(stdout, "%s", buf); 585 fprintf(stdout, "#\n"); 586 free(buf); 587 } 588 report__browse_block_hists(&rep->block_reports[i - 1].hist, 589 rep->min_percent, pos, NULL); 590 continue; 591 } 592 593 hists__fprintf(hists, !quiet, 0, 0, rep->min_percent, stdout, 594 !(symbol_conf.use_callchain || 595 symbol_conf.show_branchflag_count)); 596 fprintf(stdout, "\n\n"); 597 } 598 599 if (!quiet) 600 fprintf(stdout, "#\n# (%s)\n#\n", help); 601 602 if (rep->show_threads) { 603 bool style = !strcmp(rep->pretty_printing_style, "raw"); 604 perf_read_values_display(stdout, &rep->show_threads_values, 605 style); 606 perf_read_values_destroy(&rep->show_threads_values); 607 } 608 609 if (sort__mode == SORT_MODE__BRANCH) 610 branch_type_stat_display(stdout, &rep->brtype_stat); 611 612 return 0; 613 } 614 615 static void report__warn_kptr_restrict(const struct report *rep) 616 { 617 struct map *kernel_map = machine__kernel_map(&rep->session->machines.host); 618 struct kmap *kernel_kmap = kernel_map ? map__kmap(kernel_map) : NULL; 619 620 if (evlist__exclude_kernel(rep->session->evlist)) 621 return; 622 623 if (kernel_map == NULL || 624 (dso__hit(map__dso(kernel_map)) && 625 (kernel_kmap->ref_reloc_sym == NULL || 626 kernel_kmap->ref_reloc_sym->addr == 0))) { 627 const char *desc = 628 "As no suitable kallsyms nor vmlinux was found, kernel samples\n" 629 "can't be resolved."; 630 631 if (kernel_map && map__has_symbols(kernel_map)) { 632 desc = "If some relocation was applied (e.g. " 633 "kexec) symbols may be misresolved."; 634 } 635 636 ui__warning( 637 "Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n" 638 "Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n" 639 "Samples in kernel modules can't be resolved as well.\n\n", 640 desc); 641 } 642 } 643 644 static int report__gtk_browse_hists(struct report *rep, const char *help) 645 { 646 int (*hist_browser)(struct evlist *evlist, const char *help, 647 struct hist_browser_timer *timer, float min_pcnt); 648 649 hist_browser = dlsym(perf_gtk_handle, "evlist__gtk_browse_hists"); 650 651 if (hist_browser == NULL) { 652 ui__error("GTK browser not found!\n"); 653 return -1; 654 } 655 656 return hist_browser(rep->session->evlist, help, NULL, rep->min_percent); 657 } 658 659 static int report__browse_hists(struct report *rep) 660 { 661 int ret; 662 struct perf_session *session = rep->session; 663 struct evlist *evlist = session->evlist; 664 char *help = NULL, *path = NULL; 665 666 path = system_path(TIPDIR); 667 if (perf_tip(&help, path) || help == NULL) { 668 /* fallback for people who don't install perf ;-) */ 669 free(path); 670 path = system_path(DOCDIR); 671 if (perf_tip(&help, path) || help == NULL) 672 help = strdup("Cannot load tips.txt file, please install perf!"); 673 } 674 free(path); 675 676 switch (use_browser) { 677 case 1: 678 if (rep->total_cycles_mode) { 679 ret = evlist__tui_block_hists_browse(evlist, rep); 680 break; 681 } 682 683 ret = evlist__tui_browse_hists(evlist, help, NULL, rep->min_percent, 684 perf_session__env(session), true); 685 /* 686 * Usually "ret" is the last pressed key, and we only 687 * care if the key notifies us to switch data file. 688 */ 689 if (ret != K_SWITCH_INPUT_DATA && ret != K_RELOAD) 690 ret = 0; 691 break; 692 case 2: 693 ret = report__gtk_browse_hists(rep, help); 694 break; 695 default: 696 ret = evlist__tty_browse_hists(evlist, rep, help); 697 break; 698 } 699 free(help); 700 return ret; 701 } 702 703 static int report__collapse_hists(struct report *rep) 704 { 705 struct perf_session *session = rep->session; 706 struct evlist *evlist = session->evlist; 707 struct ui_progress prog; 708 struct evsel *pos; 709 int ret = 0; 710 711 /* 712 * The pipe data needs to setup hierarchy hpp formats now, because it 713 * cannot know about evsels in the data before reading the data. The 714 * normal file data saves the event (attribute) info in the header 715 * section, but pipe does not have the luxury. 716 */ 717 if (perf_data__is_pipe(session->data)) { 718 if (perf_hpp__setup_hists_formats(&perf_hpp_list, evlist) < 0) { 719 ui__error("Failed to setup hierarchy output formats\n"); 720 return -1; 721 } 722 } 723 724 ui_progress__init(&prog, rep->nr_entries, "Merging related events..."); 725 726 evlist__for_each_entry(rep->session->evlist, pos) { 727 struct hists *hists = evsel__hists(pos); 728 729 if (pos->core.idx == 0) { 730 hists->symbol_filter_str = 731 rep->symbol_filter_str ? 732 strdup(rep->symbol_filter_str) : NULL; 733 } 734 735 hists->socket_filter = rep->socket_filter; 736 737 ret = hists__collapse_resort(hists, &prog); 738 if (ret < 0) 739 break; 740 741 /* Non-group events are considered as leader */ 742 if (symbol_conf.event_group && !evsel__is_group_leader(pos)) { 743 struct hists *leader_hists = evsel__hists(evsel__leader(pos)); 744 745 hists__match(leader_hists, hists); 746 hists__link(leader_hists, hists); 747 } 748 } 749 750 ui_progress__finish(); 751 return ret; 752 } 753 754 static int hists__resort_cb(struct hist_entry *he, void *arg) 755 { 756 struct report *rep = arg; 757 struct symbol *sym = he->ms.sym; 758 759 if (rep->symbol_ipc && sym && !symbol__is_annotate2(sym)) { 760 struct evsel *evsel = hists_to_evsel(he->hists); 761 762 symbol__annotate2(&he->ms, evsel, NULL); 763 } 764 765 return 0; 766 } 767 768 static void report__output_resort(struct report *rep) 769 { 770 struct ui_progress prog; 771 struct evsel *pos; 772 773 ui_progress__init(&prog, rep->nr_entries, "Sorting events for output..."); 774 775 evlist__for_each_entry(rep->session->evlist, pos) { 776 evsel__output_resort_cb(pos, &prog, hists__resort_cb, rep); 777 } 778 779 ui_progress__finish(); 780 } 781 782 static int count_sample_event(const struct perf_tool *tool __maybe_unused, 783 union perf_event *event __maybe_unused, 784 struct perf_sample *sample, 785 struct machine *machine __maybe_unused) 786 { 787 struct hists *hists = evsel__hists(sample->evsel); 788 789 hists__inc_nr_events(hists); 790 return 0; 791 } 792 793 static int count_lost_samples_event(const struct perf_tool *tool, 794 union perf_event *event, 795 struct perf_sample *sample, 796 struct machine *machine __maybe_unused) 797 { 798 struct report *rep = container_of(tool, struct report, tool); 799 struct evsel *evsel = sample->evsel; 800 801 if (!evsel) 802 evsel = evlist__id2evsel(rep->session->evlist, sample->id); 803 804 if (evsel) { 805 struct hists *hists = evsel__hists(evsel); 806 u32 count = event->lost_samples.lost; 807 808 if (event->header.misc & PERF_RECORD_MISC_LOST_SAMPLES_BPF) 809 hists__inc_nr_dropped_samples(hists, count); 810 else 811 hists__inc_nr_lost_samples(hists, count); 812 } 813 return 0; 814 } 815 816 static int process_attr(const struct perf_tool *tool __maybe_unused, 817 union perf_event *event, 818 struct evlist **pevlist); 819 820 static void stats_setup(struct report *rep) 821 { 822 perf_tool__init(&rep->tool, /*ordered_events=*/false); 823 rep->tool.attr = process_attr; 824 rep->tool.sample = count_sample_event; 825 rep->tool.lost_samples = count_lost_samples_event; 826 rep->tool.event_update = perf_event__process_event_update; 827 rep->tool.no_warn = true; 828 } 829 830 static int stats_print(struct report *rep) 831 { 832 struct perf_session *session = rep->session; 833 834 perf_session__fprintf_nr_events(session, stdout); 835 evlist__fprintf_nr_events(session->evlist, stdout); 836 return 0; 837 } 838 839 static void tasks_setup(struct report *rep) 840 { 841 perf_tool__init(&rep->tool, /*ordered_events=*/true); 842 if (rep->mmaps_mode) { 843 rep->tool.mmap = perf_event__process_mmap; 844 rep->tool.mmap2 = perf_event__process_mmap2; 845 } 846 rep->tool.attr = process_attr; 847 rep->tool.comm = perf_event__process_comm; 848 rep->tool.exit = perf_event__process_exit; 849 rep->tool.fork = perf_event__process_fork; 850 rep->tool.no_warn = true; 851 } 852 853 struct maps__fprintf_task_args { 854 int indent; 855 FILE *fp; 856 size_t printed; 857 }; 858 859 static int maps__fprintf_task_cb(struct map *map, void *data) 860 { 861 struct maps__fprintf_task_args *args = data; 862 const struct dso *dso = map__dso(map); 863 u32 prot = map__prot(map); 864 const struct dso_id *dso_id = dso__id_const(dso); 865 int ret; 866 char buf[SBUILD_ID_SIZE]; 867 868 if (dso_id->mmap2_valid) 869 snprintf(buf, sizeof(buf), "%" PRIu64, dso_id->ino); 870 else 871 build_id__snprintf(&dso_id->build_id, buf, sizeof(buf)); 872 873 ret = fprintf(args->fp, 874 "%*s %" PRIx64 "-%" PRIx64 " %c%c%c%c %08" PRIx64 " %s %s\n", 875 args->indent, "", map__start(map), map__end(map), 876 prot & PROT_READ ? 'r' : '-', 877 prot & PROT_WRITE ? 'w' : '-', 878 prot & PROT_EXEC ? 'x' : '-', 879 map__flags(map) ? 's' : 'p', 880 map__pgoff(map), 881 buf, dso__name(dso)); 882 883 if (ret < 0) 884 return ret; 885 886 args->printed += ret; 887 return 0; 888 } 889 890 static size_t maps__fprintf_task(struct maps *maps, int indent, FILE *fp) 891 { 892 struct maps__fprintf_task_args args = { 893 .indent = indent, 894 .fp = fp, 895 .printed = 0, 896 }; 897 898 maps__for_each_map(maps, maps__fprintf_task_cb, &args); 899 900 return args.printed; 901 } 902 903 static int thread_level(struct machine *machine, const struct thread *thread) 904 { 905 struct thread *parent_thread; 906 int res; 907 908 if (thread__tid(thread) <= 0) 909 return 0; 910 911 if (thread__ppid(thread) <= 0) 912 return 1; 913 914 parent_thread = machine__find_thread(machine, -1, thread__ppid(thread)); 915 if (!parent_thread) { 916 pr_err("Missing parent thread of %d\n", thread__tid(thread)); 917 return 0; 918 } 919 res = 1 + thread_level(machine, parent_thread); 920 thread__put(parent_thread); 921 return res; 922 } 923 924 static void task__print_level(struct machine *machine, struct thread *thread, FILE *fp) 925 { 926 int level = thread_level(machine, thread); 927 int comm_indent = fprintf(fp, " %8d %8d %8d |%*s", 928 thread__pid(thread), thread__tid(thread), 929 thread__ppid(thread), level, ""); 930 931 fprintf(fp, "%s\n", thread__comm_str(thread)); 932 933 maps__fprintf_task(thread__maps(thread), comm_indent, fp); 934 } 935 936 /* 937 * Sort two thread list nodes such that they form a tree. The first node is the 938 * root of the tree, its children are ordered numerically after it. If a child 939 * has children itself then they appear immediately after their parent. For 940 * example, the 4 threads in the order they'd appear in the list: 941 * - init with a TID 1 and a parent of 0 942 * - systemd with a TID 3000 and a parent of init/1 943 * - systemd child thread with TID 4000, the parent is 3000 944 * - NetworkManager is a child of init with a TID of 3500. 945 */ 946 static int task_list_cmp(void *priv, const struct list_head *la, const struct list_head *lb) 947 { 948 struct machine *machine = priv; 949 struct thread_list *task_a = list_entry(la, struct thread_list, list); 950 struct thread_list *task_b = list_entry(lb, struct thread_list, list); 951 struct thread *a = task_a->thread; 952 struct thread *b = task_b->thread; 953 int level_a, level_b, res; 954 955 /* Same thread? */ 956 if (thread__tid(a) == thread__tid(b)) 957 return 0; 958 959 /* Compare a and b to root. */ 960 if (thread__tid(a) == 0) 961 return -1; 962 963 if (thread__tid(b) == 0) 964 return 1; 965 966 /* If parents match sort by tid. */ 967 if (thread__ppid(a) == thread__ppid(b)) 968 return thread__tid(a) < thread__tid(b) ? -1 : 1; 969 970 /* 971 * Find a and b such that if they are a child of each other a and b's 972 * tid's match, otherwise a and b have a common parent and distinct 973 * tid's to sort by. First make the depths of the threads match. 974 */ 975 level_a = thread_level(machine, a); 976 level_b = thread_level(machine, b); 977 a = thread__get(a); 978 b = thread__get(b); 979 for (int i = level_a; i > level_b; i--) { 980 struct thread *parent = machine__find_thread(machine, -1, thread__ppid(a)); 981 982 thread__put(a); 983 if (!parent) { 984 pr_err("Missing parent thread of %d\n", thread__tid(a)); 985 thread__put(b); 986 return -1; 987 } 988 a = parent; 989 } 990 for (int i = level_b; i > level_a; i--) { 991 struct thread *parent = machine__find_thread(machine, -1, thread__ppid(b)); 992 993 thread__put(b); 994 if (!parent) { 995 pr_err("Missing parent thread of %d\n", thread__tid(b)); 996 thread__put(a); 997 return 1; 998 } 999 b = parent; 1000 } 1001 /* Search up to a common parent. */ 1002 while (thread__ppid(a) != thread__ppid(b)) { 1003 struct thread *parent; 1004 1005 parent = machine__find_thread(machine, -1, thread__ppid(a)); 1006 thread__put(a); 1007 if (!parent) 1008 pr_err("Missing parent thread of %d\n", thread__tid(a)); 1009 a = parent; 1010 parent = machine__find_thread(machine, -1, thread__ppid(b)); 1011 thread__put(b); 1012 if (!parent) 1013 pr_err("Missing parent thread of %d\n", thread__tid(b)); 1014 b = parent; 1015 if (!a || !b) { 1016 /* Handle missing parent (unexpected) with some sanity. */ 1017 thread__put(a); 1018 thread__put(b); 1019 return !a && !b ? 0 : (!a ? -1 : 1); 1020 } 1021 } 1022 if (thread__tid(a) == thread__tid(b)) { 1023 /* a is a child of b or vice-versa, deeper levels appear later. */ 1024 res = level_a < level_b ? -1 : (level_a > level_b ? 1 : 0); 1025 } else { 1026 /* Sort by tid now the parent is the same. */ 1027 res = thread__tid(a) < thread__tid(b) ? -1 : 1; 1028 } 1029 thread__put(a); 1030 thread__put(b); 1031 return res; 1032 } 1033 1034 static int tasks_print(struct report *rep, FILE *fp) 1035 { 1036 struct machine *machine = &rep->session->machines.host; 1037 LIST_HEAD(tasks); 1038 int ret; 1039 1040 ret = machine__thread_list(machine, &tasks); 1041 if (!ret) { 1042 struct thread_list *task; 1043 1044 list_sort(machine, &tasks, task_list_cmp); 1045 1046 fprintf(fp, "# %8s %8s %8s %s\n", "pid", "tid", "ppid", "comm"); 1047 1048 list_for_each_entry(task, &tasks, list) 1049 task__print_level(machine, task->thread, fp); 1050 } 1051 thread_list__delete(&tasks); 1052 return ret; 1053 } 1054 1055 static int __cmd_report(struct report *rep) 1056 { 1057 int ret; 1058 struct perf_session *session = rep->session; 1059 struct evsel *pos; 1060 struct perf_data *data = session->data; 1061 1062 signal(SIGINT, sig_handler); 1063 1064 if (rep->cpu_list) { 1065 ret = perf_session__cpu_bitmap(session, rep->cpu_list, 1066 rep->cpu_bitmap); 1067 if (ret) { 1068 ui__error("failed to set cpu bitmap\n"); 1069 return ret; 1070 } 1071 session->itrace_synth_opts->cpu_bitmap = rep->cpu_bitmap; 1072 } 1073 1074 if (rep->show_threads) { 1075 ret = perf_read_values_init(&rep->show_threads_values); 1076 if (ret) 1077 return ret; 1078 } 1079 1080 ret = report__setup_sample_type(rep); 1081 if (ret) { 1082 /* report__setup_sample_type() already showed error message */ 1083 return ret; 1084 } 1085 1086 if (rep->stats_mode) 1087 stats_setup(rep); 1088 1089 if (rep->tasks_mode) 1090 tasks_setup(rep); 1091 1092 ret = perf_session__process_events(session); 1093 if (ret) { 1094 ui__error("failed to process sample\n"); 1095 return ret; 1096 } 1097 1098 /* Don't show Latency column for non-parallel profiles by default. */ 1099 if (!symbol_conf.prefer_latency && rep->total_samples && 1100 rep->singlethreaded_samples * 100 / rep->total_samples >= 99) 1101 perf_hpp__cancel_latency(session->evlist); 1102 1103 evlist__check_mem_load_aux(session->evlist); 1104 1105 if (rep->stats_mode) 1106 return stats_print(rep); 1107 1108 if (rep->tasks_mode) 1109 return tasks_print(rep, stdout); 1110 1111 report__warn_kptr_restrict(rep); 1112 1113 evlist__for_each_entry(session->evlist, pos) 1114 rep->nr_entries += evsel__hists(pos)->nr_entries; 1115 1116 if (use_browser == 0) { 1117 if (verbose > 3) 1118 perf_session__fprintf(session, stdout); 1119 1120 if (verbose > 2) 1121 perf_session__fprintf_dsos(session, stdout); 1122 1123 if (dump_trace) { 1124 stats_print(rep); 1125 return 0; 1126 } 1127 } 1128 1129 ret = report__collapse_hists(rep); 1130 if (ret) { 1131 ui__error("failed to process hist entry\n"); 1132 return ret; 1133 } 1134 1135 if (session_done()) 1136 return 0; 1137 1138 /* 1139 * recalculate number of entries after collapsing since it 1140 * might be changed during the collapse phase. 1141 */ 1142 rep->nr_entries = 0; 1143 evlist__for_each_entry(session->evlist, pos) 1144 rep->nr_entries += evsel__hists(pos)->nr_entries; 1145 1146 if (rep->nr_entries == 0) { 1147 ui__error("The %s data has no samples!\n", data->path); 1148 return 0; 1149 } 1150 1151 report__output_resort(rep); 1152 1153 if (rep->total_cycles_mode) { 1154 int nr_hpps = 4; 1155 int block_hpps[PERF_HPP_REPORT__BLOCK_MAX_INDEX] = { 1156 PERF_HPP_REPORT__BLOCK_TOTAL_CYCLES_PCT, 1157 PERF_HPP_REPORT__BLOCK_LBR_CYCLES, 1158 PERF_HPP_REPORT__BLOCK_CYCLES_PCT, 1159 PERF_HPP_REPORT__BLOCK_AVG_CYCLES, 1160 }; 1161 1162 if (evlist__nr_br_cntr(session->evlist) > 0) 1163 block_hpps[nr_hpps++] = PERF_HPP_REPORT__BLOCK_BRANCH_COUNTER; 1164 1165 block_hpps[nr_hpps++] = PERF_HPP_REPORT__BLOCK_RANGE; 1166 block_hpps[nr_hpps++] = PERF_HPP_REPORT__BLOCK_DSO; 1167 1168 rep->block_reports = block_info__create_report(session->evlist, 1169 rep->total_cycles, 1170 block_hpps, nr_hpps, 1171 &rep->nr_block_reports); 1172 if (!rep->block_reports) 1173 return -1; 1174 } 1175 1176 return report__browse_hists(rep); 1177 } 1178 1179 static int 1180 report_parse_callchain_opt(const struct option *opt, const char *arg, int unset) 1181 { 1182 struct callchain_param *callchain = opt->value; 1183 1184 callchain->enabled = !unset; 1185 /* 1186 * --no-call-graph 1187 */ 1188 if (unset) { 1189 symbol_conf.use_callchain = false; 1190 callchain->mode = CHAIN_NONE; 1191 return 0; 1192 } 1193 1194 return parse_callchain_report_opt(arg); 1195 } 1196 1197 static int 1198 parse_time_quantum(const struct option *opt, const char *arg, 1199 int unset __maybe_unused) 1200 { 1201 unsigned long *time_q = opt->value; 1202 char *end; 1203 1204 *time_q = strtoul(arg, &end, 0); 1205 if (end == arg) 1206 goto parse_err; 1207 if (*time_q == 0) { 1208 pr_err("time quantum cannot be 0"); 1209 return -1; 1210 } 1211 end = skip_spaces(end); 1212 if (*end == 0) 1213 return 0; 1214 if (!strcmp(end, "s")) { 1215 *time_q *= NSEC_PER_SEC; 1216 return 0; 1217 } 1218 if (!strcmp(end, "ms")) { 1219 *time_q *= NSEC_PER_MSEC; 1220 return 0; 1221 } 1222 if (!strcmp(end, "us")) { 1223 *time_q *= NSEC_PER_USEC; 1224 return 0; 1225 } 1226 if (!strcmp(end, "ns")) 1227 return 0; 1228 parse_err: 1229 pr_err("Cannot parse time quantum `%s'\n", arg); 1230 return -1; 1231 } 1232 1233 int 1234 report_parse_ignore_callees_opt(const struct option *opt __maybe_unused, 1235 const char *arg, int unset __maybe_unused) 1236 { 1237 if (arg) { 1238 int err = regcomp(&ignore_callees_regex, arg, REG_EXTENDED); 1239 if (err) { 1240 char buf[BUFSIZ]; 1241 regerror(err, &ignore_callees_regex, buf, sizeof(buf)); 1242 pr_err("Invalid --ignore-callees regex: %s\n%s", arg, buf); 1243 return -1; 1244 } 1245 have_ignore_callees = 1; 1246 } 1247 1248 return 0; 1249 } 1250 1251 static int 1252 parse_branch_mode(const struct option *opt, 1253 const char *str __maybe_unused, int unset) 1254 { 1255 int *branch_mode = opt->value; 1256 1257 *branch_mode = !unset; 1258 return 0; 1259 } 1260 1261 static int 1262 parse_percent_limit(const struct option *opt, const char *str, 1263 int unset __maybe_unused) 1264 { 1265 struct report *rep = opt->value; 1266 double pcnt = strtof(str, NULL); 1267 1268 rep->min_percent = pcnt; 1269 callchain_param.min_percent = pcnt; 1270 return 0; 1271 } 1272 1273 static int 1274 report_parse_addr2line_config(const struct option *opt __maybe_unused, 1275 const char *arg, int unset __maybe_unused) 1276 { 1277 return addr2line_configure("addr2line.style", arg, NULL); 1278 } 1279 1280 static int process_attr(const struct perf_tool *tool __maybe_unused, 1281 union perf_event *event, 1282 struct evlist **pevlist) 1283 { 1284 struct perf_session *session; 1285 u64 sample_type; 1286 int err; 1287 1288 err = perf_event__process_attr(tool, event, pevlist); 1289 if (err) 1290 return err; 1291 1292 /* 1293 * Check if we need to enable callchains based 1294 * on events sample_type. 1295 */ 1296 sample_type = evlist__combined_sample_type(*pevlist); 1297 session = evlist__session(*pevlist); 1298 callchain_param_setup(sample_type, perf_session__e_machine(session, /*e_flags=*/NULL)); 1299 return 0; 1300 } 1301 1302 #define CALLCHAIN_BRANCH_SORT_ORDER \ 1303 "srcline,symbol,dso,callchain_branch_predicted," \ 1304 "callchain_branch_abort,callchain_branch_cycles" 1305 1306 int cmd_report(int argc, const char **argv) 1307 { 1308 struct perf_session *session; 1309 struct itrace_synth_opts itrace_synth_opts = { .set = 0, }; 1310 struct stat st; 1311 bool has_br_stack = false; 1312 int branch_mode = -1; 1313 int last_key = 0; 1314 bool branch_call_mode = false; 1315 #define CALLCHAIN_DEFAULT_OPT "graph,0.5,caller,function,percent" 1316 static const char report_callchain_help[] = "Display call graph (stack chain/backtrace):\n\n" 1317 CALLCHAIN_REPORT_HELP 1318 "\n\t\t\t\tDefault: " CALLCHAIN_DEFAULT_OPT; 1319 char callchain_default_opt[] = CALLCHAIN_DEFAULT_OPT; 1320 const char * const report_usage[] = { 1321 "perf report [<options>]", 1322 NULL 1323 }; 1324 struct report report = { 1325 .max_stack = PERF_MAX_STACK_DEPTH, 1326 .pretty_printing_style = "normal", 1327 .socket_filter = -1, 1328 .skip_empty = true, 1329 }; 1330 char *sort_order_help = sort_help("sort by key(s):", SORT_MODE__NORMAL); 1331 char *field_order_help = sort_help("output field(s):", SORT_MODE__NORMAL); 1332 const char *disassembler_style = NULL, *objdump_path = NULL, *addr2line_path = NULL; 1333 const struct option options[] = { 1334 OPT_STRING('i', "input", &input_name, "file", 1335 "input file name"), 1336 OPT_INCR('v', "verbose", &verbose, 1337 "be more verbose (show symbol address, etc)"), 1338 OPT_BOOLEAN('q', "quiet", &quiet, "Do not show any warnings or messages"), 1339 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, 1340 "dump raw trace in ASCII"), 1341 OPT_BOOLEAN(0, "stats", &report.stats_mode, "Display event stats"), 1342 OPT_BOOLEAN(0, "tasks", &report.tasks_mode, "Display recorded tasks"), 1343 OPT_BOOLEAN(0, "mmaps", &report.mmaps_mode, "Display recorded tasks memory maps"), 1344 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, 1345 "file", "vmlinux pathname"), 1346 OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux, 1347 "don't load vmlinux even if found"), 1348 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name, 1349 "file", "kallsyms pathname"), 1350 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"), 1351 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules, 1352 "load module symbols - WARNING: use only with -k and LIVE kernel"), 1353 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples, 1354 "Show a column with the number of samples"), 1355 OPT_BOOLEAN('T', "threads", &report.show_threads, 1356 "Show per-thread event counters"), 1357 OPT_STRING(0, "pretty", &report.pretty_printing_style, "key", 1358 "pretty printing style key: normal raw"), 1359 #ifdef HAVE_SLANG_SUPPORT 1360 OPT_BOOLEAN(0, "tui", &report.use_tui, "Use the TUI interface"), 1361 #endif 1362 #ifdef HAVE_GTK2_SUPPORT 1363 OPT_BOOLEAN(0, "gtk", &report.use_gtk, "Use the GTK2 interface"), 1364 #endif 1365 OPT_BOOLEAN(0, "stdio", &report.use_stdio, 1366 "Use the stdio interface"), 1367 OPT_BOOLEAN(0, "header", &report.header, "Show data header."), 1368 OPT_BOOLEAN(0, "header-only", &report.header_only, 1369 "Show only data header."), 1370 OPT_STRING('s', "sort", &sort_order, "key[,key2...]", 1371 sort_order_help), 1372 OPT_STRING('F', "fields", &field_order, "key[,keys...]", 1373 field_order_help), 1374 OPT_BOOLEAN(0, "show-cpu-utilization", &symbol_conf.show_cpu_utilization, 1375 "Show sample percentage for different cpu modes"), 1376 OPT_BOOLEAN_FLAG(0, "showcpuutilization", &symbol_conf.show_cpu_utilization, 1377 "Show sample percentage for different cpu modes", PARSE_OPT_HIDDEN), 1378 OPT_STRING('p', "parent", &parent_pattern, "regex", 1379 "regex filter to identify parent, see: '--sort parent'"), 1380 OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other, 1381 "Only display entries with parent-match"), 1382 OPT_CALLBACK_DEFAULT('g', "call-graph", &callchain_param, 1383 "print_type,threshold[,print_limit],order,sort_key[,branch],value", 1384 report_callchain_help, &report_parse_callchain_opt, 1385 callchain_default_opt), 1386 OPT_BOOLEAN(0, "children", &symbol_conf.cumulate_callchain, 1387 "Accumulate callchains of children and show total overhead as well. " 1388 "Enabled by default, use --no-children to disable."), 1389 OPT_INTEGER(0, "max-stack", &report.max_stack, 1390 "Set the maximum stack depth when parsing the callchain, " 1391 "anything beyond the specified depth will be ignored. " 1392 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)), 1393 OPT_BOOLEAN('G', "inverted", &report.inverted_callchain, 1394 "alias for inverted call graph"), 1395 OPT_CALLBACK(0, "ignore-callees", NULL, "regex", 1396 "ignore callees of these functions in call graphs", 1397 report_parse_ignore_callees_opt), 1398 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]", 1399 "only consider symbols in these dsos"), 1400 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]", 1401 "only consider symbols in these comms"), 1402 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]", 1403 "only consider symbols in these pids"), 1404 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]", 1405 "only consider symbols in these tids"), 1406 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]", 1407 "only consider these symbols"), 1408 OPT_STRING(0, "symbol-filter", &report.symbol_filter_str, "filter", 1409 "only show symbols that (partially) match with this filter"), 1410 OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str, 1411 "width[,width...]", 1412 "don't try to adjust column width, use these fixed values"), 1413 OPT_STRING_NOEMPTY('t', "field-separator", &symbol_conf.field_sep, "separator", 1414 "separator for columns, no spaces will be added between " 1415 "columns '.' is reserved."), 1416 OPT_BOOLEAN('U', "hide-unresolved", &symbol_conf.hide_unresolved, 1417 "Only display entries resolved to a symbol"), 1418 OPT_CALLBACK(0, "symfs", NULL, "directory[,layout]", SYMFS_HELP, 1419 symbol__config_symfs), 1420 OPT_STRING('C', "cpu", &report.cpu_list, "cpu", 1421 "list of cpus to profile"), 1422 OPT_STRING(0, "parallelism", &symbol_conf.parallelism_list_str, "parallelism", 1423 "only consider these parallelism levels (cpu set format)"), 1424 OPT_BOOLEAN('I', "show-info", &report.show_full_info, 1425 "Display extended information about perf.data file"), 1426 OPT_BOOLEAN(0, "source", &annotate_opts.annotate_src, 1427 "Interleave source code with assembly code (default)"), 1428 OPT_BOOLEAN(0, "asm-raw", &annotate_opts.show_asm_raw, 1429 "Display raw encoding of assembly instructions (default)"), 1430 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style", 1431 "Specify disassembler style (e.g. -M intel for intel syntax)"), 1432 OPT_STRING(0, "prefix", &annotate_opts.prefix, "prefix", 1433 "Add prefix to source file path names in programs (with --prefix-strip)"), 1434 OPT_STRING(0, "prefix-strip", &annotate_opts.prefix_strip, "N", 1435 "Strip first N entries of source file path name in programs (with --prefix)"), 1436 OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period, 1437 "Show a column with the sum of periods"), 1438 OPT_BOOLEAN_SET(0, "group", &symbol_conf.event_group, &report.group_set, 1439 "Show event group information together"), 1440 OPT_INTEGER(0, "group-sort-idx", &symbol_conf.group_sort_idx, 1441 "Sort the output by the event at the index n in group. " 1442 "If n is invalid, sort by the first event. " 1443 "WARNING: should be used on grouped events."), 1444 OPT_CALLBACK_NOOPT('b', "branch-stack", &branch_mode, "", 1445 "use branch records for per branch histogram filling", 1446 parse_branch_mode), 1447 OPT_BOOLEAN(0, "branch-history", &branch_call_mode, 1448 "add last branch records to call history"), 1449 OPT_STRING(0, "objdump", &objdump_path, "path", 1450 "objdump binary to use for disassembly and annotations"), 1451 OPT_STRING(0, "addr2line", &addr2line_path, "path", 1452 "addr2line binary to use for line numbers"), 1453 OPT_CALLBACK(0, "addr2line-style", NULL, "addr2line style", 1454 "addr2line styles (libdw,llvm,libbfd,addr2line)", 1455 report_parse_addr2line_config), 1456 OPT_CALLBACK(0, "unwind-style", NULL, "unwind style", 1457 "unwind styles (libdw,libunwind)", 1458 unwind__option), 1459 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle, 1460 "Symbol demangling. Enabled by default, use --no-demangle to disable."), 1461 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel, 1462 "Enable kernel symbol demangling"), 1463 OPT_BOOLEAN(0, "mem-mode", &report.mem_mode, "mem access profile"), 1464 OPT_INTEGER(0, "samples", &symbol_conf.res_sample, 1465 "Number of samples to save per histogram entry for individual browsing"), 1466 OPT_CALLBACK(0, "percent-limit", &report, "percent", 1467 "Don't show entries under that percent", parse_percent_limit), 1468 OPT_CALLBACK(0, "percentage", NULL, "relative|absolute", 1469 "how to display percentage of filtered entries", parse_filter_percentage), 1470 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts", 1471 "Instruction Tracing options\n" ITRACE_HELP, 1472 itrace_parse_synth_opts), 1473 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename, 1474 "Show full source file name path for source lines"), 1475 OPT_BOOLEAN(0, "show-ref-call-graph", &symbol_conf.show_ref_callgraph, 1476 "Show callgraph from reference event"), 1477 OPT_BOOLEAN(0, "stitch-lbr", &report.stitch_lbr, 1478 "Enable LBR callgraph stitching approach"), 1479 OPT_INTEGER(0, "socket-filter", &report.socket_filter, 1480 "only show processor socket that match with this filter"), 1481 OPT_BOOLEAN(0, "raw-trace", &symbol_conf.raw_trace, 1482 "Show raw trace event output (do not use print fmt or plugins)"), 1483 OPT_BOOLEAN('H', "hierarchy", &symbol_conf.report_hierarchy, 1484 "Show entries in a hierarchy"), 1485 OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL, "mode", 1486 "'always' (default), 'never' or 'auto' only applicable to --stdio mode", 1487 stdio__config_color, "always"), 1488 OPT_STRING(0, "time", &report.time_str, "str", 1489 "Time span of interest (start,stop)"), 1490 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name, 1491 "Show inline function"), 1492 OPT_CALLBACK(0, "percent-type", &annotate_opts, "local-period", 1493 "Set percent type local/global-period/hits", 1494 annotate_parse_percent_type), 1495 OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs, "Show times in nanosecs"), 1496 OPT_CALLBACK(0, "time-quantum", &symbol_conf.time_quantum, "time (ms|us|ns|s)", 1497 "Set time quantum for time sort key (default 100ms)", 1498 parse_time_quantum), 1499 OPTS_EVSWITCH(&report.evswitch), 1500 OPT_BOOLEAN(0, "total-cycles", &report.total_cycles_mode, 1501 "Sort all blocks by 'Sampled Cycles%'"), 1502 OPT_BOOLEAN(0, "disable-order", &report.disable_order, 1503 "Disable raw trace ordering"), 1504 OPT_BOOLEAN(0, "skip-empty", &report.skip_empty, 1505 "Do not display empty (or dummy) events in the output"), 1506 OPT_BOOLEAN(0, "latency", &symbol_conf.prefer_latency, 1507 "Show latency-centric profile rather than the default\n" 1508 "\t\t\t CPU-consumption-centric profile\n" 1509 "\t\t\t (requires perf record --latency flag)."), 1510 OPT_END() 1511 }; 1512 struct perf_data data = { 1513 .mode = PERF_DATA_MODE_READ, 1514 }; 1515 int ret = hists__init(); 1516 char sort_tmp[128]; 1517 bool ordered_events = true; 1518 1519 if (ret < 0) 1520 goto exit; 1521 1522 /* 1523 * tasks_mode require access to exited threads to list those that are in 1524 * the data file. Off-cpu events are synthesized after other events and 1525 * reference exited threads. 1526 */ 1527 symbol_conf.keep_exited_threads = true; 1528 1529 annotation_options__init(); 1530 1531 ret = perf_config(report__config, &report); 1532 if (ret) 1533 goto exit; 1534 1535 argc = parse_options(argc, argv, options, report_usage, 0); 1536 if (argc) { 1537 /* 1538 * Special case: if there's an argument left then assume that 1539 * it's a symbol filter: 1540 */ 1541 if (argc > 1) 1542 usage_with_options(report_usage, options); 1543 1544 report.symbol_filter_str = argv[0]; 1545 } 1546 1547 if (disassembler_style) { 1548 annotate_opts.disassembler_style = strdup(disassembler_style); 1549 if (!annotate_opts.disassembler_style) 1550 return -ENOMEM; 1551 } 1552 if (objdump_path) { 1553 annotate_opts.objdump_path = strdup(objdump_path); 1554 if (!annotate_opts.objdump_path) 1555 return -ENOMEM; 1556 } 1557 if (addr2line_path) { 1558 symbol_conf.addr2line_path = strdup(addr2line_path); 1559 if (!symbol_conf.addr2line_path) 1560 return -ENOMEM; 1561 } 1562 1563 if (annotate_check_args() < 0) { 1564 ret = -EINVAL; 1565 goto exit; 1566 } 1567 1568 if (report.mmaps_mode) 1569 report.tasks_mode = true; 1570 1571 if (dump_trace && report.disable_order) 1572 ordered_events = false; 1573 1574 if (quiet) 1575 perf_quiet_option(); 1576 1577 ret = symbol__validate_sym_arguments(); 1578 if (ret) 1579 goto exit; 1580 1581 if (report.inverted_callchain) 1582 callchain_param.order = ORDER_CALLER; 1583 if (symbol_conf.cumulate_callchain && !callchain_param.order_set) 1584 callchain_param.order = ORDER_CALLER; 1585 1586 if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) && 1587 (int)itrace_synth_opts.callchain_sz > report.max_stack) 1588 report.max_stack = itrace_synth_opts.callchain_sz; 1589 1590 if (!input_name || !strlen(input_name)) { 1591 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode)) 1592 input_name = "-"; 1593 else 1594 input_name = "perf.data"; 1595 } 1596 1597 repeat: 1598 data.path = input_name; 1599 data.force = symbol_conf.force; 1600 1601 symbol_conf.skip_empty = report.skip_empty; 1602 1603 perf_tool__init(&report.tool, ordered_events); 1604 report.tool.sample = process_sample_event; 1605 report.tool.mmap = perf_event__process_mmap; 1606 report.tool.mmap2 = perf_event__process_mmap2; 1607 report.tool.comm = perf_event__process_comm; 1608 report.tool.namespaces = perf_event__process_namespaces; 1609 report.tool.cgroup = perf_event__process_cgroup; 1610 report.tool.exit = perf_event__process_exit; 1611 report.tool.fork = perf_event__process_fork; 1612 report.tool.context_switch = perf_event__process_switch; 1613 report.tool.lost = perf_event__process_lost; 1614 report.tool.read = process_read_event; 1615 report.tool.attr = process_attr; 1616 #ifdef HAVE_LIBTRACEEVENT 1617 report.tool.tracing_data = perf_event__process_tracing_data; 1618 #endif 1619 report.tool.build_id = perf_event__process_build_id; 1620 report.tool.id_index = perf_event__process_id_index; 1621 report.tool.auxtrace_info = perf_event__process_auxtrace_info; 1622 report.tool.auxtrace = perf_event__process_auxtrace; 1623 report.tool.event_update = perf_event__process_event_update; 1624 report.tool.feature = process_feature_event; 1625 report.tool.ordering_requires_timestamps = true; 1626 report.tool.merge_deferred_callchains = !dump_trace; 1627 1628 session = perf_session__new(&data, &report.tool); 1629 if (IS_ERR(session)) { 1630 ret = PTR_ERR(session); 1631 goto exit; 1632 } 1633 1634 ret = evswitch__init(&report.evswitch, session->evlist, stderr); 1635 if (ret) 1636 goto exit; 1637 1638 if (zstd_init(&(session->zstd_data), 0) < 0) 1639 pr_warning("Decompression initialization failed. Reported data may be incomplete.\n"); 1640 1641 if (report.queue_size) { 1642 ordered_events__set_alloc_size(&session->ordered_events, 1643 report.queue_size); 1644 } 1645 1646 session->itrace_synth_opts = &itrace_synth_opts; 1647 1648 report.session = session; 1649 1650 has_br_stack = perf_header__has_feat(&session->header, 1651 HEADER_BRANCH_STACK); 1652 if (evlist__combined_sample_type(session->evlist) & PERF_SAMPLE_STACK_USER) 1653 has_br_stack = false; 1654 1655 setup_forced_leader(&report, session->evlist); 1656 1657 if (symbol_conf.group_sort_idx && evlist__nr_groups(session->evlist) == 0) { 1658 parse_options_usage(NULL, options, "group-sort-idx", 0); 1659 ret = -EINVAL; 1660 goto error; 1661 } 1662 1663 if (itrace_synth_opts.last_branch || itrace_synth_opts.add_last_branch) 1664 has_br_stack = true; 1665 1666 if (has_br_stack && branch_call_mode) 1667 symbol_conf.show_branchflag_count = true; 1668 1669 memset(&report.brtype_stat, 0, sizeof(struct branch_type_stat)); 1670 1671 /* 1672 * Branch mode is a tristate: 1673 * -1 means default, so decide based on the file having branch data. 1674 * 0/1 means the user chose a mode. 1675 */ 1676 if (((branch_mode == -1 && has_br_stack) || branch_mode == 1) && 1677 !branch_call_mode) { 1678 sort__mode = SORT_MODE__BRANCH; 1679 symbol_conf.cumulate_callchain = false; 1680 } 1681 if (branch_call_mode) { 1682 callchain_param.key = CCKEY_ADDRESS; 1683 callchain_param.branch_callstack = true; 1684 symbol_conf.use_callchain = true; 1685 callchain_register_param(&callchain_param); 1686 if (sort_order == NULL) 1687 sort_order = CALLCHAIN_BRANCH_SORT_ORDER; 1688 } 1689 1690 if (report.mem_mode) { 1691 if (sort__mode == SORT_MODE__BRANCH) { 1692 pr_err("branch and mem mode incompatible\n"); 1693 goto error; 1694 } 1695 sort__mode = SORT_MODE__MEMORY; 1696 symbol_conf.cumulate_callchain = false; 1697 } 1698 1699 if (symbol_conf.report_hierarchy) { 1700 /* 1701 * The hist entries in hierarchy are added during the collpase 1702 * phase. Let's enable it even if no sort keys require it. 1703 */ 1704 perf_hpp_list.need_collapse = true; 1705 } 1706 1707 if (report.use_stdio) 1708 use_browser = 0; 1709 #ifdef HAVE_SLANG_SUPPORT 1710 else if (report.use_tui) 1711 use_browser = 1; 1712 #endif 1713 #ifdef HAVE_GTK2_SUPPORT 1714 else if (report.use_gtk) 1715 use_browser = 2; 1716 #endif 1717 1718 /* Force tty output for header output and per-thread stat. */ 1719 if (report.header || report.header_only || report.show_threads) 1720 use_browser = 0; 1721 if (report.header || report.header_only) 1722 report.tool.show_feat_hdr = SHOW_FEAT_HEADER; 1723 if (report.show_full_info) 1724 report.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO; 1725 if (report.stats_mode || report.tasks_mode) 1726 use_browser = 0; 1727 if (report.stats_mode && report.tasks_mode) { 1728 pr_err("Error: --tasks and --mmaps can't be used together with --stats\n"); 1729 goto error; 1730 } 1731 1732 if (report.total_cycles_mode) { 1733 if (sort__mode != SORT_MODE__BRANCH) 1734 report.total_cycles_mode = false; 1735 else 1736 sort_order = NULL; 1737 } 1738 1739 if ((sort_order && strstr(sort_order, "type")) || 1740 (field_order && strstr(field_order, "type"))) { 1741 report.data_type = true; 1742 annotate_opts.annotate_src = false; 1743 1744 /* disable incompatible options */ 1745 symbol_conf.cumulate_callchain = false; 1746 1747 #ifndef HAVE_LIBDW_SUPPORT 1748 pr_err("Error: Data type profiling is disabled due to missing DWARF support\n"); 1749 goto error; 1750 #endif 1751 } 1752 1753 if (strcmp(input_name, "-") != 0) 1754 setup_browser(true); 1755 else 1756 use_browser = 0; 1757 1758 if (report.data_type && use_browser == 1) { 1759 symbol_conf.annotate_data_member = true; 1760 symbol_conf.annotate_data_sample = true; 1761 } 1762 1763 symbol_conf.enable_latency = true; 1764 if (report.disable_order || !perf_session__has_switch_events(session)) { 1765 if (symbol_conf.parallelism_list_str || 1766 symbol_conf.prefer_latency || 1767 (sort_order && (strstr(sort_order, "latency") || 1768 strstr(sort_order, "parallelism"))) || 1769 (field_order && (strstr(field_order, "latency") || 1770 strstr(field_order, "parallelism")))) { 1771 if (report.disable_order) 1772 ui__error("Use of latency profile or parallelism is incompatible with --disable-order.\n"); 1773 else 1774 ui__error("Use of latency profile or parallelism requires --latency flag during record.\n"); 1775 return -1; 1776 } 1777 /* 1778 * If user did not ask for anything related to 1779 * latency/parallelism explicitly, just don't show it. 1780 */ 1781 symbol_conf.enable_latency = false; 1782 } 1783 1784 if (last_key != K_SWITCH_INPUT_DATA) { 1785 if (sort_order && strstr(sort_order, "ipc")) { 1786 parse_options_usage(report_usage, options, "s", 1); 1787 goto error; 1788 } 1789 1790 if (sort_order && strstr(sort_order, "symbol")) { 1791 if (sort__mode == SORT_MODE__BRANCH) { 1792 snprintf(sort_tmp, sizeof(sort_tmp), "%s,%s", 1793 sort_order, "ipc_lbr"); 1794 report.symbol_ipc = true; 1795 } else { 1796 snprintf(sort_tmp, sizeof(sort_tmp), "%s,%s", 1797 sort_order, "ipc_null"); 1798 } 1799 1800 sort_order = sort_tmp; 1801 } 1802 } 1803 1804 if ((last_key != K_SWITCH_INPUT_DATA && last_key != K_RELOAD) && 1805 (setup_sorting(session->evlist, perf_session__env(session)) < 0)) { 1806 if (sort_order) 1807 parse_options_usage(report_usage, options, "s", 1); 1808 if (field_order) 1809 parse_options_usage(sort_order ? NULL : report_usage, 1810 options, "F", 1); 1811 goto error; 1812 } 1813 1814 if ((report.header || report.header_only) && !quiet) { 1815 perf_session__fprintf_info(session, stdout, 1816 report.show_full_info); 1817 if (report.header_only) { 1818 if (data.is_pipe) { 1819 /* 1820 * we need to process first few records 1821 * which contains PERF_RECORD_HEADER_FEATURE. 1822 */ 1823 perf_session__process_events(session); 1824 } 1825 ret = 0; 1826 goto error; 1827 } 1828 } else if (use_browser == 0 && !quiet && 1829 !report.stats_mode && !report.tasks_mode) { 1830 fputs("# To display the perf.data header info, please use --header/--header-only options.\n#\n", 1831 stdout); 1832 } 1833 1834 /* 1835 * Only in the TUI browser we are doing integrated annotation, 1836 * so don't allocate extra space that won't be used in the stdio 1837 * implementation. 1838 */ 1839 if (ui__has_annotation() || report.symbol_ipc || report.data_type || 1840 report.total_cycles_mode) { 1841 ret = symbol__annotation_init(); 1842 if (ret < 0) 1843 goto error; 1844 /* 1845 * For searching by name on the "Browse map details". 1846 * providing it only in verbose mode not to bloat too 1847 * much struct symbol. 1848 */ 1849 if (verbose > 0) { 1850 /* 1851 * XXX: Need to provide a less kludgy way to ask for 1852 * more space per symbol, the u32 is for the index on 1853 * the ui browser. 1854 * See symbol__browser_index. 1855 */ 1856 symbol_conf.priv_size += sizeof(u32); 1857 } 1858 annotation_config__init(); 1859 } 1860 1861 if (symbol__init(perf_session__env(session)) < 0) 1862 goto error; 1863 1864 if (report.time_str) { 1865 ret = perf_time__parse_for_ranges(report.time_str, session, 1866 &report.ptime_range, 1867 &report.range_size, 1868 &report.range_num); 1869 if (ret < 0) 1870 goto error; 1871 1872 itrace_synth_opts__set_time_range(&itrace_synth_opts, 1873 report.ptime_range, 1874 report.range_num); 1875 } 1876 1877 #ifdef HAVE_LIBTRACEEVENT 1878 if (session->tevent.pevent && 1879 tep_set_function_resolver(session->tevent.pevent, 1880 machine__resolve_kernel_addr, 1881 &session->machines.host) < 0) { 1882 pr_err("%s: failed to set libtraceevent function resolver\n", 1883 __func__); 1884 return -1; 1885 } 1886 #endif 1887 sort__setup_elide(stdout); 1888 1889 ret = __cmd_report(&report); 1890 if (ret == K_SWITCH_INPUT_DATA || ret == K_RELOAD) { 1891 perf_session__delete(session); 1892 last_key = K_SWITCH_INPUT_DATA; 1893 /* 1894 * To support switching between data with and without callchains. 1895 * report__setup_sample_type() will update it properly. 1896 */ 1897 symbol_conf.use_callchain = false; 1898 goto repeat; 1899 } else 1900 ret = 0; 1901 1902 if (!use_browser && (verbose > 2 || debug_kmaps)) 1903 perf_session__dump_kmaps(session); 1904 error: 1905 if (report.ptime_range) { 1906 itrace_synth_opts__clear_time_range(&itrace_synth_opts); 1907 zfree(&report.ptime_range); 1908 } 1909 1910 if (report.block_reports) { 1911 block_info__free_report(report.block_reports, 1912 report.nr_block_reports); 1913 report.block_reports = NULL; 1914 } 1915 1916 zstd_fini(&(session->zstd_data)); 1917 perf_session__delete(session); 1918 exit: 1919 annotation_options__exit(); 1920 free(sort_order_help); 1921 free(field_order_help); 1922 return ret; 1923 } 1924