1 /* 2 * builtin-report.c 3 * 4 * Builtin report command: Analyze the perf.data input file, 5 * look up and read DSOs and symbol information and display 6 * a histogram of results, along various sorting keys. 7 */ 8 #include "builtin.h" 9 10 #include "util/util.h" 11 #include "util/config.h" 12 13 #include "util/annotate.h" 14 #include "util/color.h" 15 #include <linux/list.h> 16 #include <linux/rbtree.h> 17 #include "util/symbol.h" 18 #include "util/callchain.h" 19 #include "util/strlist.h" 20 #include "util/values.h" 21 22 #include "perf.h" 23 #include "util/debug.h" 24 #include "util/evlist.h" 25 #include "util/evsel.h" 26 #include "util/header.h" 27 #include "util/session.h" 28 #include "util/tool.h" 29 30 #include <subcmd/parse-options.h> 31 #include <subcmd/exec-cmd.h> 32 #include "util/parse-events.h" 33 34 #include "util/thread.h" 35 #include "util/sort.h" 36 #include "util/hist.h" 37 #include "util/data.h" 38 #include "arch/common.h" 39 40 #include "util/auxtrace.h" 41 42 #include <dlfcn.h> 43 #include <linux/bitmap.h> 44 #include <linux/stringify.h> 45 46 struct report { 47 struct perf_tool tool; 48 struct perf_session *session; 49 bool use_tui, use_gtk, use_stdio; 50 bool show_full_info; 51 bool show_threads; 52 bool inverted_callchain; 53 bool mem_mode; 54 bool header; 55 bool header_only; 56 bool nonany_branch_mode; 57 int max_stack; 58 struct perf_read_values show_threads_values; 59 const char *pretty_printing_style; 60 const char *cpu_list; 61 const char *symbol_filter_str; 62 float min_percent; 63 u64 nr_entries; 64 u64 queue_size; 65 int socket_filter; 66 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS); 67 }; 68 69 static int report__config(const char *var, const char *value, void *cb) 70 { 71 struct report *rep = cb; 72 73 if (!strcmp(var, "report.group")) { 74 symbol_conf.event_group = perf_config_bool(var, value); 75 return 0; 76 } 77 if (!strcmp(var, "report.percent-limit")) { 78 double pcnt = strtof(value, NULL); 79 80 rep->min_percent = pcnt; 81 callchain_param.min_percent = pcnt; 82 return 0; 83 } 84 if (!strcmp(var, "report.children")) { 85 symbol_conf.cumulate_callchain = perf_config_bool(var, value); 86 return 0; 87 } 88 if (!strcmp(var, "report.queue-size")) { 89 rep->queue_size = perf_config_u64(var, value); 90 return 0; 91 } 92 93 return 0; 94 } 95 96 static int hist_iter__report_callback(struct hist_entry_iter *iter, 97 struct addr_location *al, bool single, 98 void *arg) 99 { 100 int err = 0; 101 struct report *rep = arg; 102 struct hist_entry *he = iter->he; 103 struct perf_evsel *evsel = iter->evsel; 104 struct mem_info *mi; 105 struct branch_info *bi; 106 107 if (!ui__has_annotation()) 108 return 0; 109 110 hist__account_cycles(iter->sample->branch_stack, al, iter->sample, 111 rep->nonany_branch_mode); 112 113 if (sort__mode == SORT_MODE__BRANCH) { 114 bi = he->branch_info; 115 err = addr_map_symbol__inc_samples(&bi->from, evsel->idx); 116 if (err) 117 goto out; 118 119 err = addr_map_symbol__inc_samples(&bi->to, evsel->idx); 120 121 } else if (rep->mem_mode) { 122 mi = he->mem_info; 123 err = addr_map_symbol__inc_samples(&mi->daddr, evsel->idx); 124 if (err) 125 goto out; 126 127 err = hist_entry__inc_addr_samples(he, evsel->idx, al->addr); 128 129 } else if (symbol_conf.cumulate_callchain) { 130 if (single) 131 err = hist_entry__inc_addr_samples(he, evsel->idx, 132 al->addr); 133 } else { 134 err = hist_entry__inc_addr_samples(he, evsel->idx, al->addr); 135 } 136 137 out: 138 return err; 139 } 140 141 static int process_sample_event(struct perf_tool *tool, 142 union perf_event *event, 143 struct perf_sample *sample, 144 struct perf_evsel *evsel, 145 struct machine *machine) 146 { 147 struct report *rep = container_of(tool, struct report, tool); 148 struct addr_location al; 149 struct hist_entry_iter iter = { 150 .evsel = evsel, 151 .sample = sample, 152 .hide_unresolved = symbol_conf.hide_unresolved, 153 .add_entry_cb = hist_iter__report_callback, 154 }; 155 int ret = 0; 156 157 if (machine__resolve(machine, &al, sample) < 0) { 158 pr_debug("problem processing %d event, skipping it.\n", 159 event->header.type); 160 return -1; 161 } 162 163 if (symbol_conf.hide_unresolved && al.sym == NULL) 164 goto out_put; 165 166 if (rep->cpu_list && !test_bit(sample->cpu, rep->cpu_bitmap)) 167 goto out_put; 168 169 if (sort__mode == SORT_MODE__BRANCH) { 170 /* 171 * A non-synthesized event might not have a branch stack if 172 * branch stacks have been synthesized (using itrace options). 173 */ 174 if (!sample->branch_stack) 175 goto out_put; 176 iter.ops = &hist_iter_branch; 177 } else if (rep->mem_mode) { 178 iter.ops = &hist_iter_mem; 179 } else if (symbol_conf.cumulate_callchain) { 180 iter.ops = &hist_iter_cumulative; 181 } else { 182 iter.ops = &hist_iter_normal; 183 } 184 185 if (al.map != NULL) 186 al.map->dso->hit = 1; 187 188 ret = hist_entry_iter__add(&iter, &al, rep->max_stack, rep); 189 if (ret < 0) 190 pr_debug("problem adding hist entry, skipping event\n"); 191 out_put: 192 addr_location__put(&al); 193 return ret; 194 } 195 196 static int process_read_event(struct perf_tool *tool, 197 union perf_event *event, 198 struct perf_sample *sample __maybe_unused, 199 struct perf_evsel *evsel, 200 struct machine *machine __maybe_unused) 201 { 202 struct report *rep = container_of(tool, struct report, tool); 203 204 if (rep->show_threads) { 205 const char *name = evsel ? perf_evsel__name(evsel) : "unknown"; 206 perf_read_values_add_value(&rep->show_threads_values, 207 event->read.pid, event->read.tid, 208 event->read.id, 209 name, 210 event->read.value); 211 } 212 213 dump_printf(": %d %d %s %" PRIu64 "\n", event->read.pid, event->read.tid, 214 evsel ? perf_evsel__name(evsel) : "FAIL", 215 event->read.value); 216 217 return 0; 218 } 219 220 /* For pipe mode, sample_type is not currently set */ 221 static int report__setup_sample_type(struct report *rep) 222 { 223 struct perf_session *session = rep->session; 224 u64 sample_type = perf_evlist__combined_sample_type(session->evlist); 225 bool is_pipe = perf_data_file__is_pipe(session->file); 226 227 if (session->itrace_synth_opts->callchain || 228 (!is_pipe && 229 perf_header__has_feat(&session->header, HEADER_AUXTRACE) && 230 !session->itrace_synth_opts->set)) 231 sample_type |= PERF_SAMPLE_CALLCHAIN; 232 233 if (session->itrace_synth_opts->last_branch) 234 sample_type |= PERF_SAMPLE_BRANCH_STACK; 235 236 if (!is_pipe && !(sample_type & PERF_SAMPLE_CALLCHAIN)) { 237 if (perf_hpp_list.parent) { 238 ui__error("Selected --sort parent, but no " 239 "callchain data. Did you call " 240 "'perf record' without -g?\n"); 241 return -EINVAL; 242 } 243 if (symbol_conf.use_callchain) { 244 ui__error("Selected -g or --branch-history but no " 245 "callchain data. Did\n" 246 "you call 'perf record' without -g?\n"); 247 return -1; 248 } 249 } else if (!callchain_param.enabled && 250 callchain_param.mode != CHAIN_NONE && 251 !symbol_conf.use_callchain) { 252 symbol_conf.use_callchain = true; 253 if (callchain_register_param(&callchain_param) < 0) { 254 ui__error("Can't register callchain params.\n"); 255 return -EINVAL; 256 } 257 } 258 259 if (symbol_conf.cumulate_callchain) { 260 /* Silently ignore if callchain is missing */ 261 if (!(sample_type & PERF_SAMPLE_CALLCHAIN)) { 262 symbol_conf.cumulate_callchain = false; 263 perf_hpp__cancel_cumulate(); 264 } 265 } 266 267 if (sort__mode == SORT_MODE__BRANCH) { 268 if (!is_pipe && 269 !(sample_type & PERF_SAMPLE_BRANCH_STACK)) { 270 ui__error("Selected -b but no branch data. " 271 "Did you call perf record without -b?\n"); 272 return -1; 273 } 274 } 275 276 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) { 277 if ((sample_type & PERF_SAMPLE_REGS_USER) && 278 (sample_type & PERF_SAMPLE_STACK_USER)) 279 callchain_param.record_mode = CALLCHAIN_DWARF; 280 else if (sample_type & PERF_SAMPLE_BRANCH_STACK) 281 callchain_param.record_mode = CALLCHAIN_LBR; 282 else 283 callchain_param.record_mode = CALLCHAIN_FP; 284 } 285 286 /* ??? handle more cases than just ANY? */ 287 if (!(perf_evlist__combined_branch_type(session->evlist) & 288 PERF_SAMPLE_BRANCH_ANY)) 289 rep->nonany_branch_mode = true; 290 291 return 0; 292 } 293 294 static void sig_handler(int sig __maybe_unused) 295 { 296 session_done = 1; 297 } 298 299 static size_t hists__fprintf_nr_sample_events(struct hists *hists, struct report *rep, 300 const char *evname, FILE *fp) 301 { 302 size_t ret; 303 char unit; 304 unsigned long nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE]; 305 u64 nr_events = hists->stats.total_period; 306 struct perf_evsel *evsel = hists_to_evsel(hists); 307 char buf[512]; 308 size_t size = sizeof(buf); 309 int socked_id = hists->socket_filter; 310 311 if (symbol_conf.filter_relative) { 312 nr_samples = hists->stats.nr_non_filtered_samples; 313 nr_events = hists->stats.total_non_filtered_period; 314 } 315 316 if (perf_evsel__is_group_event(evsel)) { 317 struct perf_evsel *pos; 318 319 perf_evsel__group_desc(evsel, buf, size); 320 evname = buf; 321 322 for_each_group_member(pos, evsel) { 323 const struct hists *pos_hists = evsel__hists(pos); 324 325 if (symbol_conf.filter_relative) { 326 nr_samples += pos_hists->stats.nr_non_filtered_samples; 327 nr_events += pos_hists->stats.total_non_filtered_period; 328 } else { 329 nr_samples += pos_hists->stats.nr_events[PERF_RECORD_SAMPLE]; 330 nr_events += pos_hists->stats.total_period; 331 } 332 } 333 } 334 335 nr_samples = convert_unit(nr_samples, &unit); 336 ret = fprintf(fp, "# Samples: %lu%c", nr_samples, unit); 337 if (evname != NULL) 338 ret += fprintf(fp, " of event '%s'", evname); 339 340 if (symbol_conf.show_ref_callgraph && 341 strstr(evname, "call-graph=no")) { 342 ret += fprintf(fp, ", show reference callgraph"); 343 } 344 345 if (rep->mem_mode) { 346 ret += fprintf(fp, "\n# Total weight : %" PRIu64, nr_events); 347 ret += fprintf(fp, "\n# Sort order : %s", sort_order ? : default_mem_sort_order); 348 } else 349 ret += fprintf(fp, "\n# Event count (approx.): %" PRIu64, nr_events); 350 351 if (socked_id > -1) 352 ret += fprintf(fp, "\n# Processor Socket: %d", socked_id); 353 354 return ret + fprintf(fp, "\n#\n"); 355 } 356 357 static int perf_evlist__tty_browse_hists(struct perf_evlist *evlist, 358 struct report *rep, 359 const char *help) 360 { 361 struct perf_evsel *pos; 362 363 fprintf(stdout, "#\n# Total Lost Samples: %" PRIu64 "\n#\n", evlist->stats.total_lost_samples); 364 evlist__for_each_entry(evlist, pos) { 365 struct hists *hists = evsel__hists(pos); 366 const char *evname = perf_evsel__name(pos); 367 368 if (symbol_conf.event_group && 369 !perf_evsel__is_group_leader(pos)) 370 continue; 371 372 hists__fprintf_nr_sample_events(hists, rep, evname, stdout); 373 hists__fprintf(hists, true, 0, 0, rep->min_percent, stdout, 374 symbol_conf.use_callchain); 375 fprintf(stdout, "\n\n"); 376 } 377 378 if (sort_order == NULL && 379 parent_pattern == default_parent_pattern) 380 fprintf(stdout, "#\n# (%s)\n#\n", help); 381 382 if (rep->show_threads) { 383 bool style = !strcmp(rep->pretty_printing_style, "raw"); 384 perf_read_values_display(stdout, &rep->show_threads_values, 385 style); 386 perf_read_values_destroy(&rep->show_threads_values); 387 } 388 389 return 0; 390 } 391 392 static void report__warn_kptr_restrict(const struct report *rep) 393 { 394 struct map *kernel_map = machine__kernel_map(&rep->session->machines.host); 395 struct kmap *kernel_kmap = kernel_map ? map__kmap(kernel_map) : NULL; 396 397 if (kernel_map == NULL || 398 (kernel_map->dso->hit && 399 (kernel_kmap->ref_reloc_sym == NULL || 400 kernel_kmap->ref_reloc_sym->addr == 0))) { 401 const char *desc = 402 "As no suitable kallsyms nor vmlinux was found, kernel samples\n" 403 "can't be resolved."; 404 405 if (kernel_map) { 406 const struct dso *kdso = kernel_map->dso; 407 if (!RB_EMPTY_ROOT(&kdso->symbols[MAP__FUNCTION])) { 408 desc = "If some relocation was applied (e.g. " 409 "kexec) symbols may be misresolved."; 410 } 411 } 412 413 ui__warning( 414 "Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n" 415 "Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n" 416 "Samples in kernel modules can't be resolved as well.\n\n", 417 desc); 418 } 419 } 420 421 static int report__gtk_browse_hists(struct report *rep, const char *help) 422 { 423 int (*hist_browser)(struct perf_evlist *evlist, const char *help, 424 struct hist_browser_timer *timer, float min_pcnt); 425 426 hist_browser = dlsym(perf_gtk_handle, "perf_evlist__gtk_browse_hists"); 427 428 if (hist_browser == NULL) { 429 ui__error("GTK browser not found!\n"); 430 return -1; 431 } 432 433 return hist_browser(rep->session->evlist, help, NULL, rep->min_percent); 434 } 435 436 static int report__browse_hists(struct report *rep) 437 { 438 int ret; 439 struct perf_session *session = rep->session; 440 struct perf_evlist *evlist = session->evlist; 441 const char *help = perf_tip(system_path(TIPDIR)); 442 443 if (help == NULL) { 444 /* fallback for people who don't install perf ;-) */ 445 help = perf_tip(DOCDIR); 446 if (help == NULL) 447 help = "Cannot load tips.txt file, please install perf!"; 448 } 449 450 switch (use_browser) { 451 case 1: 452 ret = perf_evlist__tui_browse_hists(evlist, help, NULL, 453 rep->min_percent, 454 &session->header.env); 455 /* 456 * Usually "ret" is the last pressed key, and we only 457 * care if the key notifies us to switch data file. 458 */ 459 if (ret != K_SWITCH_INPUT_DATA) 460 ret = 0; 461 break; 462 case 2: 463 ret = report__gtk_browse_hists(rep, help); 464 break; 465 default: 466 ret = perf_evlist__tty_browse_hists(evlist, rep, help); 467 break; 468 } 469 470 return ret; 471 } 472 473 static int report__collapse_hists(struct report *rep) 474 { 475 struct ui_progress prog; 476 struct perf_evsel *pos; 477 int ret = 0; 478 479 ui_progress__init(&prog, rep->nr_entries, "Merging related events..."); 480 481 evlist__for_each_entry(rep->session->evlist, pos) { 482 struct hists *hists = evsel__hists(pos); 483 484 if (pos->idx == 0) 485 hists->symbol_filter_str = rep->symbol_filter_str; 486 487 hists->socket_filter = rep->socket_filter; 488 489 ret = hists__collapse_resort(hists, &prog); 490 if (ret < 0) 491 break; 492 493 /* Non-group events are considered as leader */ 494 if (symbol_conf.event_group && 495 !perf_evsel__is_group_leader(pos)) { 496 struct hists *leader_hists = evsel__hists(pos->leader); 497 498 hists__match(leader_hists, hists); 499 hists__link(leader_hists, hists); 500 } 501 } 502 503 ui_progress__finish(); 504 return ret; 505 } 506 507 static void report__output_resort(struct report *rep) 508 { 509 struct ui_progress prog; 510 struct perf_evsel *pos; 511 512 ui_progress__init(&prog, rep->nr_entries, "Sorting events for output..."); 513 514 evlist__for_each_entry(rep->session->evlist, pos) 515 perf_evsel__output_resort(pos, &prog); 516 517 ui_progress__finish(); 518 } 519 520 static int __cmd_report(struct report *rep) 521 { 522 int ret; 523 struct perf_session *session = rep->session; 524 struct perf_evsel *pos; 525 struct perf_data_file *file = session->file; 526 527 signal(SIGINT, sig_handler); 528 529 if (rep->cpu_list) { 530 ret = perf_session__cpu_bitmap(session, rep->cpu_list, 531 rep->cpu_bitmap); 532 if (ret) { 533 ui__error("failed to set cpu bitmap\n"); 534 return ret; 535 } 536 } 537 538 if (rep->show_threads) 539 perf_read_values_init(&rep->show_threads_values); 540 541 ret = report__setup_sample_type(rep); 542 if (ret) { 543 /* report__setup_sample_type() already showed error message */ 544 return ret; 545 } 546 547 ret = perf_session__process_events(session); 548 if (ret) { 549 ui__error("failed to process sample\n"); 550 return ret; 551 } 552 553 report__warn_kptr_restrict(rep); 554 555 evlist__for_each_entry(session->evlist, pos) 556 rep->nr_entries += evsel__hists(pos)->nr_entries; 557 558 if (use_browser == 0) { 559 if (verbose > 3) 560 perf_session__fprintf(session, stdout); 561 562 if (verbose > 2) 563 perf_session__fprintf_dsos(session, stdout); 564 565 if (dump_trace) { 566 perf_session__fprintf_nr_events(session, stdout); 567 perf_evlist__fprintf_nr_events(session->evlist, stdout); 568 return 0; 569 } 570 } 571 572 ret = report__collapse_hists(rep); 573 if (ret) { 574 ui__error("failed to process hist entry\n"); 575 return ret; 576 } 577 578 if (session_done()) 579 return 0; 580 581 /* 582 * recalculate number of entries after collapsing since it 583 * might be changed during the collapse phase. 584 */ 585 rep->nr_entries = 0; 586 evlist__for_each_entry(session->evlist, pos) 587 rep->nr_entries += evsel__hists(pos)->nr_entries; 588 589 if (rep->nr_entries == 0) { 590 ui__error("The %s file has no samples!\n", file->path); 591 return 0; 592 } 593 594 report__output_resort(rep); 595 596 return report__browse_hists(rep); 597 } 598 599 static int 600 report_parse_callchain_opt(const struct option *opt, const char *arg, int unset) 601 { 602 struct callchain_param *callchain = opt->value; 603 604 callchain->enabled = !unset; 605 /* 606 * --no-call-graph 607 */ 608 if (unset) { 609 symbol_conf.use_callchain = false; 610 callchain->mode = CHAIN_NONE; 611 return 0; 612 } 613 614 return parse_callchain_report_opt(arg); 615 } 616 617 int 618 report_parse_ignore_callees_opt(const struct option *opt __maybe_unused, 619 const char *arg, int unset __maybe_unused) 620 { 621 if (arg) { 622 int err = regcomp(&ignore_callees_regex, arg, REG_EXTENDED); 623 if (err) { 624 char buf[BUFSIZ]; 625 regerror(err, &ignore_callees_regex, buf, sizeof(buf)); 626 pr_err("Invalid --ignore-callees regex: %s\n%s", arg, buf); 627 return -1; 628 } 629 have_ignore_callees = 1; 630 } 631 632 return 0; 633 } 634 635 static int 636 parse_branch_mode(const struct option *opt __maybe_unused, 637 const char *str __maybe_unused, int unset) 638 { 639 int *branch_mode = opt->value; 640 641 *branch_mode = !unset; 642 return 0; 643 } 644 645 static int 646 parse_percent_limit(const struct option *opt, const char *str, 647 int unset __maybe_unused) 648 { 649 struct report *rep = opt->value; 650 double pcnt = strtof(str, NULL); 651 652 rep->min_percent = pcnt; 653 callchain_param.min_percent = pcnt; 654 return 0; 655 } 656 657 #define CALLCHAIN_DEFAULT_OPT "graph,0.5,caller,function,percent" 658 659 const char report_callchain_help[] = "Display call graph (stack chain/backtrace):\n\n" 660 CALLCHAIN_REPORT_HELP 661 "\n\t\t\t\tDefault: " CALLCHAIN_DEFAULT_OPT; 662 663 int cmd_report(int argc, const char **argv, const char *prefix __maybe_unused) 664 { 665 struct perf_session *session; 666 struct itrace_synth_opts itrace_synth_opts = { .set = 0, }; 667 struct stat st; 668 bool has_br_stack = false; 669 int branch_mode = -1; 670 bool branch_call_mode = false; 671 char callchain_default_opt[] = CALLCHAIN_DEFAULT_OPT; 672 const char * const report_usage[] = { 673 "perf report [<options>]", 674 NULL 675 }; 676 struct report report = { 677 .tool = { 678 .sample = process_sample_event, 679 .mmap = perf_event__process_mmap, 680 .mmap2 = perf_event__process_mmap2, 681 .comm = perf_event__process_comm, 682 .exit = perf_event__process_exit, 683 .fork = perf_event__process_fork, 684 .lost = perf_event__process_lost, 685 .read = process_read_event, 686 .attr = perf_event__process_attr, 687 .tracing_data = perf_event__process_tracing_data, 688 .build_id = perf_event__process_build_id, 689 .id_index = perf_event__process_id_index, 690 .auxtrace_info = perf_event__process_auxtrace_info, 691 .auxtrace = perf_event__process_auxtrace, 692 .ordered_events = true, 693 .ordering_requires_timestamps = true, 694 }, 695 .max_stack = PERF_MAX_STACK_DEPTH, 696 .pretty_printing_style = "normal", 697 .socket_filter = -1, 698 }; 699 const struct option options[] = { 700 OPT_STRING('i', "input", &input_name, "file", 701 "input file name"), 702 OPT_INCR('v', "verbose", &verbose, 703 "be more verbose (show symbol address, etc)"), 704 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, 705 "dump raw trace in ASCII"), 706 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, 707 "file", "vmlinux pathname"), 708 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name, 709 "file", "kallsyms pathname"), 710 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"), 711 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules, 712 "load module symbols - WARNING: use only with -k and LIVE kernel"), 713 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples, 714 "Show a column with the number of samples"), 715 OPT_BOOLEAN('T', "threads", &report.show_threads, 716 "Show per-thread event counters"), 717 OPT_STRING(0, "pretty", &report.pretty_printing_style, "key", 718 "pretty printing style key: normal raw"), 719 OPT_BOOLEAN(0, "tui", &report.use_tui, "Use the TUI interface"), 720 OPT_BOOLEAN(0, "gtk", &report.use_gtk, "Use the GTK2 interface"), 721 OPT_BOOLEAN(0, "stdio", &report.use_stdio, 722 "Use the stdio interface"), 723 OPT_BOOLEAN(0, "header", &report.header, "Show data header."), 724 OPT_BOOLEAN(0, "header-only", &report.header_only, 725 "Show only data header."), 726 OPT_STRING('s', "sort", &sort_order, "key[,key2...]", 727 "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..." 728 " Please refer the man page for the complete list."), 729 OPT_STRING('F', "fields", &field_order, "key[,keys...]", 730 "output field(s): overhead, period, sample plus all of sort keys"), 731 OPT_BOOLEAN(0, "show-cpu-utilization", &symbol_conf.show_cpu_utilization, 732 "Show sample percentage for different cpu modes"), 733 OPT_BOOLEAN_FLAG(0, "showcpuutilization", &symbol_conf.show_cpu_utilization, 734 "Show sample percentage for different cpu modes", PARSE_OPT_HIDDEN), 735 OPT_STRING('p', "parent", &parent_pattern, "regex", 736 "regex filter to identify parent, see: '--sort parent'"), 737 OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other, 738 "Only display entries with parent-match"), 739 OPT_CALLBACK_DEFAULT('g', "call-graph", &callchain_param, 740 "print_type,threshold[,print_limit],order,sort_key[,branch],value", 741 report_callchain_help, &report_parse_callchain_opt, 742 callchain_default_opt), 743 OPT_BOOLEAN(0, "children", &symbol_conf.cumulate_callchain, 744 "Accumulate callchains of children and show total overhead as well"), 745 OPT_INTEGER(0, "max-stack", &report.max_stack, 746 "Set the maximum stack depth when parsing the callchain, " 747 "anything beyond the specified depth will be ignored. " 748 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)), 749 OPT_BOOLEAN('G', "inverted", &report.inverted_callchain, 750 "alias for inverted call graph"), 751 OPT_CALLBACK(0, "ignore-callees", NULL, "regex", 752 "ignore callees of these functions in call graphs", 753 report_parse_ignore_callees_opt), 754 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]", 755 "only consider symbols in these dsos"), 756 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]", 757 "only consider symbols in these comms"), 758 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]", 759 "only consider symbols in these pids"), 760 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]", 761 "only consider symbols in these tids"), 762 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]", 763 "only consider these symbols"), 764 OPT_STRING(0, "symbol-filter", &report.symbol_filter_str, "filter", 765 "only show symbols that (partially) match with this filter"), 766 OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str, 767 "width[,width...]", 768 "don't try to adjust column width, use these fixed values"), 769 OPT_STRING_NOEMPTY('t', "field-separator", &symbol_conf.field_sep, "separator", 770 "separator for columns, no spaces will be added between " 771 "columns '.' is reserved."), 772 OPT_BOOLEAN('U', "hide-unresolved", &symbol_conf.hide_unresolved, 773 "Only display entries resolved to a symbol"), 774 OPT_CALLBACK(0, "symfs", NULL, "directory", 775 "Look for files with symbols relative to this directory", 776 symbol__config_symfs), 777 OPT_STRING('C', "cpu", &report.cpu_list, "cpu", 778 "list of cpus to profile"), 779 OPT_BOOLEAN('I', "show-info", &report.show_full_info, 780 "Display extended information about perf.data file"), 781 OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src, 782 "Interleave source code with assembly code (default)"), 783 OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw, 784 "Display raw encoding of assembly instructions (default)"), 785 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style", 786 "Specify disassembler style (e.g. -M intel for intel syntax)"), 787 OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period, 788 "Show a column with the sum of periods"), 789 OPT_BOOLEAN(0, "group", &symbol_conf.event_group, 790 "Show event group information together"), 791 OPT_CALLBACK_NOOPT('b', "branch-stack", &branch_mode, "", 792 "use branch records for per branch histogram filling", 793 parse_branch_mode), 794 OPT_BOOLEAN(0, "branch-history", &branch_call_mode, 795 "add last branch records to call history"), 796 OPT_STRING(0, "objdump", &objdump_path, "path", 797 "objdump binary to use for disassembly and annotations"), 798 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle, 799 "Disable symbol demangling"), 800 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel, 801 "Enable kernel symbol demangling"), 802 OPT_BOOLEAN(0, "mem-mode", &report.mem_mode, "mem access profile"), 803 OPT_CALLBACK(0, "percent-limit", &report, "percent", 804 "Don't show entries under that percent", parse_percent_limit), 805 OPT_CALLBACK(0, "percentage", NULL, "relative|absolute", 806 "how to display percentage of filtered entries", parse_filter_percentage), 807 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts", 808 "Instruction Tracing options", 809 itrace_parse_synth_opts), 810 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename, 811 "Show full source file name path for source lines"), 812 OPT_BOOLEAN(0, "show-ref-call-graph", &symbol_conf.show_ref_callgraph, 813 "Show callgraph from reference event"), 814 OPT_INTEGER(0, "socket-filter", &report.socket_filter, 815 "only show processor socket that match with this filter"), 816 OPT_BOOLEAN(0, "raw-trace", &symbol_conf.raw_trace, 817 "Show raw trace event output (do not use print fmt or plugins)"), 818 OPT_BOOLEAN(0, "hierarchy", &symbol_conf.report_hierarchy, 819 "Show entries in a hierarchy"), 820 OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL, "mode", 821 "'always' (default), 'never' or 'auto' only applicable to --stdio mode", 822 stdio__config_color, "always"), 823 OPT_END() 824 }; 825 struct perf_data_file file = { 826 .mode = PERF_DATA_MODE_READ, 827 }; 828 int ret = hists__init(); 829 830 if (ret < 0) 831 return ret; 832 833 perf_config(report__config, &report); 834 835 argc = parse_options(argc, argv, options, report_usage, 0); 836 if (argc) { 837 /* 838 * Special case: if there's an argument left then assume that 839 * it's a symbol filter: 840 */ 841 if (argc > 1) 842 usage_with_options(report_usage, options); 843 844 report.symbol_filter_str = argv[0]; 845 } 846 847 if (symbol_conf.vmlinux_name && 848 access(symbol_conf.vmlinux_name, R_OK)) { 849 pr_err("Invalid file: %s\n", symbol_conf.vmlinux_name); 850 return -EINVAL; 851 } 852 if (symbol_conf.kallsyms_name && 853 access(symbol_conf.kallsyms_name, R_OK)) { 854 pr_err("Invalid file: %s\n", symbol_conf.kallsyms_name); 855 return -EINVAL; 856 } 857 858 if (report.use_stdio) 859 use_browser = 0; 860 else if (report.use_tui) 861 use_browser = 1; 862 else if (report.use_gtk) 863 use_browser = 2; 864 865 if (report.inverted_callchain) 866 callchain_param.order = ORDER_CALLER; 867 if (symbol_conf.cumulate_callchain && !callchain_param.order_set) 868 callchain_param.order = ORDER_CALLER; 869 870 if (itrace_synth_opts.callchain && 871 (int)itrace_synth_opts.callchain_sz > report.max_stack) 872 report.max_stack = itrace_synth_opts.callchain_sz; 873 874 if (!input_name || !strlen(input_name)) { 875 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode)) 876 input_name = "-"; 877 else 878 input_name = "perf.data"; 879 } 880 881 file.path = input_name; 882 file.force = symbol_conf.force; 883 884 repeat: 885 session = perf_session__new(&file, false, &report.tool); 886 if (session == NULL) 887 return -1; 888 889 if (report.queue_size) { 890 ordered_events__set_alloc_size(&session->ordered_events, 891 report.queue_size); 892 } 893 894 session->itrace_synth_opts = &itrace_synth_opts; 895 896 report.session = session; 897 898 has_br_stack = perf_header__has_feat(&session->header, 899 HEADER_BRANCH_STACK); 900 901 if (itrace_synth_opts.last_branch) 902 has_br_stack = true; 903 904 /* 905 * Branch mode is a tristate: 906 * -1 means default, so decide based on the file having branch data. 907 * 0/1 means the user chose a mode. 908 */ 909 if (((branch_mode == -1 && has_br_stack) || branch_mode == 1) && 910 !branch_call_mode) { 911 sort__mode = SORT_MODE__BRANCH; 912 symbol_conf.cumulate_callchain = false; 913 } 914 if (branch_call_mode) { 915 callchain_param.key = CCKEY_ADDRESS; 916 callchain_param.branch_callstack = 1; 917 symbol_conf.use_callchain = true; 918 callchain_register_param(&callchain_param); 919 if (sort_order == NULL) 920 sort_order = "srcline,symbol,dso"; 921 } 922 923 if (report.mem_mode) { 924 if (sort__mode == SORT_MODE__BRANCH) { 925 pr_err("branch and mem mode incompatible\n"); 926 goto error; 927 } 928 sort__mode = SORT_MODE__MEMORY; 929 symbol_conf.cumulate_callchain = false; 930 } 931 932 if (symbol_conf.report_hierarchy) { 933 /* disable incompatible options */ 934 symbol_conf.event_group = false; 935 symbol_conf.cumulate_callchain = false; 936 937 if (field_order) { 938 pr_err("Error: --hierarchy and --fields options cannot be used together\n"); 939 parse_options_usage(report_usage, options, "F", 1); 940 parse_options_usage(NULL, options, "hierarchy", 0); 941 goto error; 942 } 943 944 perf_hpp_list.need_collapse = true; 945 } 946 947 /* Force tty output for header output and per-thread stat. */ 948 if (report.header || report.header_only || report.show_threads) 949 use_browser = 0; 950 951 if (strcmp(input_name, "-") != 0) 952 setup_browser(true); 953 else 954 use_browser = 0; 955 956 if (setup_sorting(session->evlist) < 0) { 957 if (sort_order) 958 parse_options_usage(report_usage, options, "s", 1); 959 if (field_order) 960 parse_options_usage(sort_order ? NULL : report_usage, 961 options, "F", 1); 962 goto error; 963 } 964 965 if (report.header || report.header_only) { 966 perf_session__fprintf_info(session, stdout, 967 report.show_full_info); 968 if (report.header_only) { 969 ret = 0; 970 goto error; 971 } 972 } else if (use_browser == 0) { 973 fputs("# To display the perf.data header info, please use --header/--header-only options.\n#\n", 974 stdout); 975 } 976 977 /* 978 * Only in the TUI browser we are doing integrated annotation, 979 * so don't allocate extra space that won't be used in the stdio 980 * implementation. 981 */ 982 if (ui__has_annotation()) { 983 symbol_conf.priv_size = sizeof(struct annotation); 984 machines__set_symbol_filter(&session->machines, 985 symbol__annotate_init); 986 /* 987 * For searching by name on the "Browse map details". 988 * providing it only in verbose mode not to bloat too 989 * much struct symbol. 990 */ 991 if (verbose) { 992 /* 993 * XXX: Need to provide a less kludgy way to ask for 994 * more space per symbol, the u32 is for the index on 995 * the ui browser. 996 * See symbol__browser_index. 997 */ 998 symbol_conf.priv_size += sizeof(u32); 999 symbol_conf.sort_by_name = true; 1000 } 1001 } 1002 1003 if (symbol__init(&session->header.env) < 0) 1004 goto error; 1005 1006 sort__setup_elide(stdout); 1007 1008 ret = __cmd_report(&report); 1009 if (ret == K_SWITCH_INPUT_DATA) { 1010 perf_session__delete(session); 1011 goto repeat; 1012 } else 1013 ret = 0; 1014 1015 error: 1016 perf_session__delete(session); 1017 return ret; 1018 } 1019