tools/perf/builtin-report.c

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