tools/perf/builtin-report.c

   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/evlist.h"
  31 #include "util/evsel.h"
  32 #include "util/evswitch.h"
  33 #include "util/header.h"
  34 #include "util/session.h"
  35 #include "util/srcline.h"
  36 #include "util/tool.h"
  37
  38 #include <subcmd/parse-options.h>
  39 #include <subcmd/exec-cmd.h>
  40 #include "util/parse-events.h"
  41
  42 #include "util/thread.h"
  43 #include "util/sort.h"
  44 #include "util/hist.h"
  45 #include "util/data.h"
  46 #include "arch/common.h"
  47 #include "util/time-utils.h"
  48 #include "util/auxtrace.h"
  49 #include "util/units.h"
  50 #include "util/branch.h"
  51 #include "util/util.h" // perf_tip()
  52 #include "ui/ui.h"
  53 #include "ui/progress.h"
  54 #include "util/block-info.h"
  55
  56 #include <dlfcn.h>
  57 #include <errno.h>
  58 #include <inttypes.h>
  59 #include <regex.h>
  60 #include <linux/ctype.h>
  61 #include <signal.h>
  62 #include <linux/bitmap.h>
  63 #include <linux/string.h>
  64 #include <linux/stringify.h>
  65 #include <linux/time64.h>
  66 #include <sys/types.h>
  67 #include <sys/stat.h>
  68 #include <unistd.h>
  69 #include <linux/mman.h>
  70
  71 struct report {
  72         struct perf_tool        tool;
  73         struct perf_session     *session;
  74         struct evswitch         evswitch;
  75         bool                    use_tui, use_gtk, use_stdio;
  76         bool                    show_full_info;
  77         bool                    show_threads;
  78         bool                    inverted_callchain;
  79         bool                    mem_mode;
  80         bool                    stats_mode;
  81         bool                    tasks_mode;
  82         bool                    mmaps_mode;
  83         bool                    header;
  84         bool                    header_only;
  85         bool                    nonany_branch_mode;
  86         bool                    group_set;
  87         int                     max_stack;
  88         struct perf_read_values show_threads_values;
  89         struct annotation_options annotation_opts;
  90         const char              *pretty_printing_style;
  91         const char              *cpu_list;
  92         const char              *symbol_filter_str;
  93         const char              *time_str;
  94         struct perf_time_interval *ptime_range;
  95         int                     range_size;
  96         int                     range_num;
  97         float                   min_percent;
  98         u64                     nr_entries;
  99         u64                     queue_size;
 100         u64                     total_cycles;
 101         int                     socket_filter;
 102         DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
 103         struct branch_type_stat brtype_stat;
 104         bool                    symbol_ipc;
 105         bool                    total_cycles_mode;
 106         struct block_report     *block_reports;
 107 };
 108
 109 static int report__config(const char *var, const char *value, void *cb)
 110 {
 111         struct report *rep = cb;
 112
 113         if (!strcmp(var, "report.group")) {
 114                 symbol_conf.event_group = perf_config_bool(var, value);
 115                 return 0;
 116         }
 117         if (!strcmp(var, "report.percent-limit")) {
 118                 double pcnt = strtof(value, NULL);
 119
 120                 rep->min_percent = pcnt;
 121                 callchain_param.min_percent = pcnt;
 122                 return 0;
 123         }
 124         if (!strcmp(var, "report.children")) {
 125                 symbol_conf.cumulate_callchain = perf_config_bool(var, value);
 126                 return 0;
 127         }
 128         if (!strcmp(var, "report.queue-size"))
 129                 return perf_config_u64(&rep->queue_size, var, value);
 130
 131         if (!strcmp(var, "report.sort_order")) {
 132                 default_sort_order = strdup(value);
 133                 return 0;
 134         }
 135
 136         return 0;
 137 }
 138
 139 static int hist_iter__report_callback(struct hist_entry_iter *iter,
 140                                       struct addr_location *al, bool single,
 141                                       void *arg)
 142 {
 143         int err = 0;
 144         struct report *rep = arg;
 145         struct hist_entry *he = iter->he;
 146         struct evsel *evsel = iter->evsel;
 147         struct perf_sample *sample = iter->sample;
 148         struct mem_info *mi;
 149         struct branch_info *bi;
 150
 151         if (!ui__has_annotation() && !rep->symbol_ipc)
 152                 return 0;
 153
 154         if (sort__mode == SORT_MODE__BRANCH) {
 155                 bi = he->branch_info;
 156                 err = addr_map_symbol__inc_samples(&bi->from, sample, evsel);
 157                 if (err)
 158                         goto out;
 159
 160                 err = addr_map_symbol__inc_samples(&bi->to, sample, evsel);
 161
 162         } else if (rep->mem_mode) {
 163                 mi = he->mem_info;
 164                 err = addr_map_symbol__inc_samples(&mi->daddr, sample, evsel);
 165                 if (err)
 166                         goto out;
 167
 168                 err = hist_entry__inc_addr_samples(he, sample, evsel, al->addr);
 169
 170         } else if (symbol_conf.cumulate_callchain) {
 171                 if (single)
 172                         err = hist_entry__inc_addr_samples(he, sample, evsel, al->addr);
 173         } else {
 174                 err = hist_entry__inc_addr_samples(he, sample, evsel, al->addr);
 175         }
 176
 177 out:
 178         return err;
 179 }
 180
 181 static int hist_iter__branch_callback(struct hist_entry_iter *iter,
 182                                       struct addr_location *al __maybe_unused,
 183                                       bool single __maybe_unused,
 184                                       void *arg)
 185 {
 186         struct hist_entry *he = iter->he;
 187         struct report *rep = arg;
 188         struct branch_info *bi;
 189         struct perf_sample *sample = iter->sample;
 190         struct evsel *evsel = iter->evsel;
 191         int err;
 192
 193         if (!ui__has_annotation() && !rep->symbol_ipc)
 194                 return 0;
 195
 196         bi = he->branch_info;
 197         err = addr_map_symbol__inc_samples(&bi->from, sample, evsel);
 198         if (err)
 199                 goto out;
 200
 201         err = addr_map_symbol__inc_samples(&bi->to, sample, evsel);
 202
 203         branch_type_count(&rep->brtype_stat, &bi->flags,
 204                           bi->from.addr, bi->to.addr);
 205
 206 out:
 207         return err;
 208 }
 209
 210 static void setup_forced_leader(struct report *report,
 211                                 struct evlist *evlist)
 212 {
 213         if (report->group_set)
 214                 perf_evlist__force_leader(evlist);
 215 }
 216
 217 static int process_feature_event(struct perf_session *session,
 218                                  union perf_event *event)
 219 {
 220         struct report *rep = container_of(session->tool, struct report, tool);
 221
 222         if (event->feat.feat_id < HEADER_LAST_FEATURE)
 223                 return perf_event__process_feature(session, event);
 224
 225         if (event->feat.feat_id != HEADER_LAST_FEATURE) {
 226                 pr_err("failed: wrong feature ID: %" PRI_lu64 "\n",
 227                        event->feat.feat_id);
 228                 return -1;
 229         }
 230
 231         /*
 232          * (feat_id = HEADER_LAST_FEATURE) is the end marker which
 233          * means all features are received, now we can force the
 234          * group if needed.
 235          */
 236         setup_forced_leader(rep, session->evlist);
 237         return 0;
 238 }
 239
 240 static int process_sample_event(struct perf_tool *tool,
 241                                 union perf_event *event,
 242                                 struct perf_sample *sample,
 243                                 struct evsel *evsel,
 244                                 struct machine *machine)
 245 {
 246         struct report *rep = container_of(tool, struct report, tool);
 247         struct addr_location al;
 248         struct hist_entry_iter iter = {
 249                 .evsel                  = evsel,
 250                 .sample                 = sample,
 251                 .hide_unresolved        = symbol_conf.hide_unresolved,
 252                 .add_entry_cb           = hist_iter__report_callback,
 253         };
 254         int ret = 0;
 255
 256         if (perf_time__ranges_skip_sample(rep->ptime_range, rep->range_num,
 257                                           sample->time)) {
 258                 return 0;
 259         }
 260
 261         if (evswitch__discard(&rep->evswitch, evsel))
 262                 return 0;
 263
 264         if (machine__resolve(machine, &al, sample) < 0) {
 265                 pr_debug("problem processing %d event, skipping it.\n",
 266                          event->header.type);
 267                 return -1;
 268         }
 269
 270         if (symbol_conf.hide_unresolved && al.sym == NULL)
 271                 goto out_put;
 272
 273         if (rep->cpu_list && !test_bit(sample->cpu, rep->cpu_bitmap))
 274                 goto out_put;
 275
 276         if (sort__mode == SORT_MODE__BRANCH) {
 277                 /*
 278                  * A non-synthesized event might not have a branch stack if
 279                  * branch stacks have been synthesized (using itrace options).
 280                  */
 281                 if (!sample->branch_stack)
 282                         goto out_put;
 283
 284                 iter.add_entry_cb = hist_iter__branch_callback;
 285                 iter.ops = &hist_iter_branch;
 286         } else if (rep->mem_mode) {
 287                 iter.ops = &hist_iter_mem;
 288         } else if (symbol_conf.cumulate_callchain) {
 289                 iter.ops = &hist_iter_cumulative;
 290         } else {
 291                 iter.ops = &hist_iter_normal;
 292         }
 293
 294         if (al.map != NULL)
 295                 al.map->dso->hit = 1;
 296
 297         if (ui__has_annotation() || rep->symbol_ipc || rep->total_cycles_mode) {
 298                 hist__account_cycles(sample->branch_stack, &al, sample,
 299                                      rep->nonany_branch_mode,
 300                                      &rep->total_cycles);
 301         }
 302
 303         ret = hist_entry_iter__add(&iter, &al, rep->max_stack, rep);
 304         if (ret < 0)
 305                 pr_debug("problem adding hist entry, skipping event\n");
 306 out_put:
 307         addr_location__put(&al);
 308         return ret;
 309 }
 310
 311 static int process_read_event(struct perf_tool *tool,
 312                               union perf_event *event,
 313                               struct perf_sample *sample __maybe_unused,
 314                               struct evsel *evsel,
 315                               struct machine *machine __maybe_unused)
 316 {
 317         struct report *rep = container_of(tool, struct report, tool);
 318
 319         if (rep->show_threads) {
 320                 const char *name = perf_evsel__name(evsel);
 321                 int err = perf_read_values_add_value(&rep->show_threads_values,
 322                                            event->read.pid, event->read.tid,
 323                                            evsel->idx,
 324                                            name,
 325                                            event->read.value);
 326
 327                 if (err)
 328                         return err;
 329         }
 330
 331         return 0;
 332 }
 333
 334 /* For pipe mode, sample_type is not currently set */
 335 static int report__setup_sample_type(struct report *rep)
 336 {
 337         struct perf_session *session = rep->session;
 338         u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
 339         bool is_pipe = perf_data__is_pipe(session->data);
 340
 341         if (session->itrace_synth_opts->callchain ||
 342             (!is_pipe &&
 343              perf_header__has_feat(&session->header, HEADER_AUXTRACE) &&
 344              !session->itrace_synth_opts->set))
 345                 sample_type |= PERF_SAMPLE_CALLCHAIN;
 346
 347         if (session->itrace_synth_opts->last_branch)
 348                 sample_type |= PERF_SAMPLE_BRANCH_STACK;
 349
 350         if (!is_pipe && !(sample_type & PERF_SAMPLE_CALLCHAIN)) {
 351                 if (perf_hpp_list.parent) {
 352                         ui__error("Selected --sort parent, but no "
 353                                     "callchain data. Did you call "
 354                                     "'perf record' without -g?\n");
 355                         return -EINVAL;
 356                 }
 357                 if (symbol_conf.use_callchain &&
 358                         !symbol_conf.show_branchflag_count) {
 359                         ui__error("Selected -g or --branch-history.\n"
 360                                   "But no callchain or branch data.\n"
 361                                   "Did you call 'perf record' without -g or -b?\n");
 362                         return -1;
 363                 }
 364         } else if (!callchain_param.enabled &&
 365                    callchain_param.mode != CHAIN_NONE &&
 366                    !symbol_conf.use_callchain) {
 367                         symbol_conf.use_callchain = true;
 368                         if (callchain_register_param(&callchain_param) < 0) {
 369                                 ui__error("Can't register callchain params.\n");
 370                                 return -EINVAL;
 371                         }
 372         }
 373
 374         if (symbol_conf.cumulate_callchain) {
 375                 /* Silently ignore if callchain is missing */
 376                 if (!(sample_type & PERF_SAMPLE_CALLCHAIN)) {
 377                         symbol_conf.cumulate_callchain = false;
 378                         perf_hpp__cancel_cumulate();
 379                 }
 380         }
 381
 382         if (sort__mode == SORT_MODE__BRANCH) {
 383                 if (!is_pipe &&
 384                     !(sample_type & PERF_SAMPLE_BRANCH_STACK)) {
 385                         ui__error("Selected -b but no branch data. "
 386                                   "Did you call perf record without -b?\n");
 387                         return -1;
 388                 }
 389         }
 390
 391         if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
 392                 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
 393                     (sample_type & PERF_SAMPLE_STACK_USER)) {
 394                         callchain_param.record_mode = CALLCHAIN_DWARF;
 395                         dwarf_callchain_users = true;
 396                 } else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
 397                         callchain_param.record_mode = CALLCHAIN_LBR;
 398                 else
 399                         callchain_param.record_mode = CALLCHAIN_FP;
 400         }
 401
 402         /* ??? handle more cases than just ANY? */
 403         if (!(perf_evlist__combined_branch_type(session->evlist) &
 404                                 PERF_SAMPLE_BRANCH_ANY))
 405                 rep->nonany_branch_mode = true;
 406
 407 #ifndef HAVE_LIBUNWIND_SUPPORT
 408         if (dwarf_callchain_users) {
 409                 ui__warning("Please install libunwind development packages "
 410                             "during the perf build.\n");
 411         }
 412 #endif
 413
 414         return 0;
 415 }
 416
 417 static void sig_handler(int sig __maybe_unused)
 418 {
 419         session_done = 1;
 420 }
 421
 422 static size_t hists__fprintf_nr_sample_events(struct hists *hists, struct report *rep,
 423                                               const char *evname, FILE *fp)
 424 {
 425         size_t ret;
 426         char unit;
 427         unsigned long nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
 428         u64 nr_events = hists->stats.total_period;
 429         struct evsel *evsel = hists_to_evsel(hists);
 430         char buf[512];
 431         size_t size = sizeof(buf);
 432         int socked_id = hists->socket_filter;
 433
 434         if (quiet)
 435                 return 0;
 436
 437         if (symbol_conf.filter_relative) {
 438                 nr_samples = hists->stats.nr_non_filtered_samples;
 439                 nr_events = hists->stats.total_non_filtered_period;
 440         }
 441
 442         if (perf_evsel__is_group_event(evsel)) {
 443                 struct evsel *pos;
 444
 445                 perf_evsel__group_desc(evsel, buf, size);
 446                 evname = buf;
 447
 448                 for_each_group_member(pos, evsel) {
 449                         const struct hists *pos_hists = evsel__hists(pos);
 450
 451                         if (symbol_conf.filter_relative) {
 452                                 nr_samples += pos_hists->stats.nr_non_filtered_samples;
 453                                 nr_events += pos_hists->stats.total_non_filtered_period;
 454                         } else {
 455                                 nr_samples += pos_hists->stats.nr_events[PERF_RECORD_SAMPLE];
 456                                 nr_events += pos_hists->stats.total_period;
 457                         }
 458                 }
 459         }
 460
 461         nr_samples = convert_unit(nr_samples, &unit);
 462         ret = fprintf(fp, "# Samples: %lu%c", nr_samples, unit);
 463         if (evname != NULL) {
 464                 ret += fprintf(fp, " of event%s '%s'",
 465                                evsel->core.nr_members > 1 ? "s" : "", evname);
 466         }
 467
 468         if (rep->time_str)
 469                 ret += fprintf(fp, " (time slices: %s)", rep->time_str);
 470
 471         if (symbol_conf.show_ref_callgraph &&
 472             strstr(evname, "call-graph=no")) {
 473                 ret += fprintf(fp, ", show reference callgraph");
 474         }
 475
 476         if (rep->mem_mode) {
 477                 ret += fprintf(fp, "\n# Total weight : %" PRIu64, nr_events);
 478                 ret += fprintf(fp, "\n# Sort order   : %s", sort_order ? : default_mem_sort_order);
 479         } else
 480                 ret += fprintf(fp, "\n# Event count (approx.): %" PRIu64, nr_events);
 481
 482         if (socked_id > -1)
 483                 ret += fprintf(fp, "\n# Processor Socket: %d", socked_id);
 484
 485         return ret + fprintf(fp, "\n#\n");
 486 }
 487
 488 static int perf_evlist__tui_block_hists_browse(struct evlist *evlist,
 489                                                struct report *rep)
 490 {
 491         struct evsel *pos;
 492         int i = 0, ret;
 493
 494         evlist__for_each_entry(evlist, pos) {
 495                 ret = report__browse_block_hists(&rep->block_reports[i++].hist,
 496                                                  rep->min_percent, pos,
 497                                                  &rep->session->header.env,
 498                                                  &rep->annotation_opts);
 499                 if (ret != 0)
 500                         return ret;
 501         }
 502
 503         return 0;
 504 }
 505
 506 static int perf_evlist__tty_browse_hists(struct evlist *evlist,
 507                                          struct report *rep,
 508                                          const char *help)
 509 {
 510         struct evsel *pos;
 511         int i = 0;
 512
 513         if (!quiet) {
 514                 fprintf(stdout, "#\n# Total Lost Samples: %" PRIu64 "\n#\n",
 515                         evlist->stats.total_lost_samples);
 516         }
 517
 518         evlist__for_each_entry(evlist, pos) {
 519                 struct hists *hists = evsel__hists(pos);
 520                 const char *evname = perf_evsel__name(pos);
 521
 522                 if (symbol_conf.event_group &&
 523                     !perf_evsel__is_group_leader(pos))
 524                         continue;
 525
 526                 hists__fprintf_nr_sample_events(hists, rep, evname, stdout);
 527
 528                 if (rep->total_cycles_mode) {
 529                         report__browse_block_hists(&rep->block_reports[i++].hist,
 530                                                    rep->min_percent, pos,
 531                                                    NULL, NULL);
 532                         continue;
 533                 }
 534
 535                 hists__fprintf(hists, !quiet, 0, 0, rep->min_percent, stdout,
 536                                !(symbol_conf.use_callchain ||
 537                                  symbol_conf.show_branchflag_count));
 538                 fprintf(stdout, "\n\n");
 539         }
 540
 541         if (!quiet)
 542                 fprintf(stdout, "#\n# (%s)\n#\n", help);
 543
 544         if (rep->show_threads) {
 545                 bool style = !strcmp(rep->pretty_printing_style, "raw");
 546                 perf_read_values_display(stdout, &rep->show_threads_values,
 547                                          style);
 548                 perf_read_values_destroy(&rep->show_threads_values);
 549         }
 550
 551         if (sort__mode == SORT_MODE__BRANCH)
 552                 branch_type_stat_display(stdout, &rep->brtype_stat);
 553
 554         return 0;
 555 }
 556
 557 static void report__warn_kptr_restrict(const struct report *rep)
 558 {
 559         struct map *kernel_map = machine__kernel_map(&rep->session->machines.host);
 560         struct kmap *kernel_kmap = kernel_map ? map__kmap(kernel_map) : NULL;
 561
 562         if (perf_evlist__exclude_kernel(rep->session->evlist))
 563                 return;
 564
 565         if (kernel_map == NULL ||
 566             (kernel_map->dso->hit &&
 567              (kernel_kmap->ref_reloc_sym == NULL ||
 568               kernel_kmap->ref_reloc_sym->addr == 0))) {
 569                 const char *desc =
 570                     "As no suitable kallsyms nor vmlinux was found, kernel samples\n"
 571                     "can't be resolved.";
 572
 573                 if (kernel_map && map__has_symbols(kernel_map)) {
 574                         desc = "If some relocation was applied (e.g. "
 575                                "kexec) symbols may be misresolved.";
 576                 }
 577
 578                 ui__warning(
 579 "Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n"
 580 "Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n"
 581 "Samples in kernel modules can't be resolved as well.\n\n",
 582                 desc);
 583         }
 584 }
 585
 586 static int report__gtk_browse_hists(struct report *rep, const char *help)
 587 {
 588         int (*hist_browser)(struct evlist *evlist, const char *help,
 589                             struct hist_browser_timer *timer, float min_pcnt);
 590
 591         hist_browser = dlsym(perf_gtk_handle, "perf_evlist__gtk_browse_hists");
 592
 593         if (hist_browser == NULL) {
 594                 ui__error("GTK browser not found!\n");
 595                 return -1;
 596         }
 597
 598         return hist_browser(rep->session->evlist, help, NULL, rep->min_percent);
 599 }
 600
 601 static int report__browse_hists(struct report *rep)
 602 {
 603         int ret;
 604         struct perf_session *session = rep->session;
 605         struct evlist *evlist = session->evlist;
 606         const char *help = perf_tip(system_path(TIPDIR));
 607
 608         if (help == NULL) {
 609                 /* fallback for people who don't install perf ;-) */
 610                 help = perf_tip(DOCDIR);
 611                 if (help == NULL)
 612                         help = "Cannot load tips.txt file, please install perf!";
 613         }
 614
 615         switch (use_browser) {
 616         case 1:
 617                 if (rep->total_cycles_mode) {
 618                         ret = perf_evlist__tui_block_hists_browse(evlist, rep);
 619                         break;
 620                 }
 621
 622                 ret = perf_evlist__tui_browse_hists(evlist, help, NULL,
 623                                                     rep->min_percent,
 624                                                     &session->header.env,
 625                                                     true, &rep->annotation_opts);
 626                 /*
 627                  * Usually "ret" is the last pressed key, and we only
 628                  * care if the key notifies us to switch data file.
 629                  */
 630                 if (ret != K_SWITCH_INPUT_DATA)
 631                         ret = 0;
 632                 break;
 633         case 2:
 634                 ret = report__gtk_browse_hists(rep, help);
 635                 break;
 636         default:
 637                 ret = perf_evlist__tty_browse_hists(evlist, rep, help);
 638                 break;
 639         }
 640
 641         return ret;
 642 }
 643
 644 static int report__collapse_hists(struct report *rep)
 645 {
 646         struct ui_progress prog;
 647         struct evsel *pos;
 648         int ret = 0;
 649
 650         ui_progress__init(&prog, rep->nr_entries, "Merging related events...");
 651
 652         evlist__for_each_entry(rep->session->evlist, pos) {
 653                 struct hists *hists = evsel__hists(pos);
 654
 655                 if (pos->idx == 0)
 656                         hists->symbol_filter_str = rep->symbol_filter_str;
 657
 658                 hists->socket_filter = rep->socket_filter;
 659
 660                 ret = hists__collapse_resort(hists, &prog);
 661                 if (ret < 0)
 662                         break;
 663
 664                 /* Non-group events are considered as leader */
 665                 if (symbol_conf.event_group &&
 666                     !perf_evsel__is_group_leader(pos)) {
 667                         struct hists *leader_hists = evsel__hists(pos->leader);
 668
 669                         hists__match(leader_hists, hists);
 670                         hists__link(leader_hists, hists);
 671                 }
 672         }
 673
 674         ui_progress__finish();
 675         return ret;
 676 }
 677
 678 static int hists__resort_cb(struct hist_entry *he, void *arg)
 679 {
 680         struct report *rep = arg;
 681         struct symbol *sym = he->ms.sym;
 682
 683         if (rep->symbol_ipc && sym && !sym->annotate2) {
 684                 struct evsel *evsel = hists_to_evsel(he->hists);
 685
 686                 symbol__annotate2(&he->ms, evsel,
 687                                   &annotation__default_options, NULL);
 688         }
 689
 690         return 0;
 691 }
 692
 693 static void report__output_resort(struct report *rep)
 694 {
 695         struct ui_progress prog;
 696         struct evsel *pos;
 697
 698         ui_progress__init(&prog, rep->nr_entries, "Sorting events for output...");
 699
 700         evlist__for_each_entry(rep->session->evlist, pos) {
 701                 perf_evsel__output_resort_cb(pos, &prog,
 702                                              hists__resort_cb, rep);
 703         }
 704
 705         ui_progress__finish();
 706 }
 707
 708 static void stats_setup(struct report *rep)
 709 {
 710         memset(&rep->tool, 0, sizeof(rep->tool));
 711         rep->tool.no_warn = true;
 712 }
 713
 714 static int stats_print(struct report *rep)
 715 {
 716         struct perf_session *session = rep->session;
 717
 718         perf_session__fprintf_nr_events(session, stdout);
 719         return 0;
 720 }
 721
 722 static void tasks_setup(struct report *rep)
 723 {
 724         memset(&rep->tool, 0, sizeof(rep->tool));
 725         rep->tool.ordered_events = true;
 726         if (rep->mmaps_mode) {
 727                 rep->tool.mmap = perf_event__process_mmap;
 728                 rep->tool.mmap2 = perf_event__process_mmap2;
 729         }
 730         rep->tool.comm = perf_event__process_comm;
 731         rep->tool.exit = perf_event__process_exit;
 732         rep->tool.fork = perf_event__process_fork;
 733         rep->tool.no_warn = true;
 734 }
 735
 736 struct task {
 737         struct thread           *thread;
 738         struct list_head         list;
 739         struct list_head         children;
 740 };
 741
 742 static struct task *tasks_list(struct task *task, struct machine *machine)
 743 {
 744         struct thread *parent_thread, *thread = task->thread;
 745         struct task   *parent_task;
 746
 747         /* Already listed. */
 748         if (!list_empty(&task->list))
 749                 return NULL;
 750
 751         /* Last one in the chain. */
 752         if (thread->ppid == -1)
 753                 return task;
 754
 755         parent_thread = machine__find_thread(machine, -1, thread->ppid);
 756         if (!parent_thread)
 757                 return ERR_PTR(-ENOENT);
 758
 759         parent_task = thread__priv(parent_thread);
 760         list_add_tail(&task->list, &parent_task->children);
 761         return tasks_list(parent_task, machine);
 762 }
 763
 764 static size_t maps__fprintf_task(struct maps *maps, int indent, FILE *fp)
 765 {
 766         size_t printed = 0;
 767         struct map *map;
 768
 769         maps__for_each_entry(maps, map) {
 770                 printed += fprintf(fp, "%*s  %" PRIx64 "-%" PRIx64 " %c%c%c%c %08" PRIx64 " %" PRIu64 " %s\n",
 771                                    indent, "", map->start, map->end,
 772                                    map->prot & PROT_READ ? 'r' : '-',
 773                                    map->prot & PROT_WRITE ? 'w' : '-',
 774                                    map->prot & PROT_EXEC ? 'x' : '-',
 775                                    map->flags & MAP_SHARED ? 's' : 'p',
 776                                    map->pgoff,
 777                                    map->dso->id.ino, map->dso->name);
 778         }
 779
 780         return printed;
 781 }
 782
 783 static void task__print_level(struct task *task, FILE *fp, int level)
 784 {
 785         struct thread *thread = task->thread;
 786         struct task *child;
 787         int comm_indent = fprintf(fp, "  %8d %8d %8d |%*s",
 788                                   thread->pid_, thread->tid, thread->ppid,
 789                                   level, "");
 790
 791         fprintf(fp, "%s\n", thread__comm_str(thread));
 792
 793         maps__fprintf_task(thread->maps, comm_indent, fp);
 794
 795         if (!list_empty(&task->children)) {
 796                 list_for_each_entry(child, &task->children, list)
 797                         task__print_level(child, fp, level + 1);
 798         }
 799 }
 800
 801 static int tasks_print(struct report *rep, FILE *fp)
 802 {
 803         struct perf_session *session = rep->session;
 804         struct machine      *machine = &session->machines.host;
 805         struct task *tasks, *task;
 806         unsigned int nr = 0, itask = 0, i;
 807         struct rb_node *nd;
 808         LIST_HEAD(list);
 809
 810         /*
 811          * No locking needed while accessing machine->threads,
 812          * because --tasks is single threaded command.
 813          */
 814
 815         /* Count all the threads. */
 816         for (i = 0; i < THREADS__TABLE_SIZE; i++)
 817                 nr += machine->threads[i].nr;
 818
 819         tasks = malloc(sizeof(*tasks) * nr);
 820         if (!tasks)
 821                 return -ENOMEM;
 822
 823         for (i = 0; i < THREADS__TABLE_SIZE; i++) {
 824                 struct threads *threads = &machine->threads[i];
 825
 826                 for (nd = rb_first_cached(&threads->entries); nd;
 827                      nd = rb_next(nd)) {
 828                         task = tasks + itask++;
 829
 830                         task->thread = rb_entry(nd, struct thread, rb_node);
 831                         INIT_LIST_HEAD(&task->children);
 832                         INIT_LIST_HEAD(&task->list);
 833                         thread__set_priv(task->thread, task);
 834                 }
 835         }
 836
 837         /*
 838          * Iterate every task down to the unprocessed parent
 839          * and link all in task children list. Task with no
 840          * parent is added into 'list'.
 841          */
 842         for (itask = 0; itask < nr; itask++) {
 843                 task = tasks + itask;
 844
 845                 if (!list_empty(&task->list))
 846                         continue;
 847
 848                 task = tasks_list(task, machine);
 849                 if (IS_ERR(task)) {
 850                         pr_err("Error: failed to process tasks\n");
 851                         free(tasks);
 852                         return PTR_ERR(task);
 853                 }
 854
 855                 if (task)
 856                         list_add_tail(&task->list, &list);
 857         }
 858
 859         fprintf(fp, "# %8s %8s %8s  %s\n", "pid", "tid", "ppid", "comm");
 860
 861         list_for_each_entry(task, &list, list)
 862                 task__print_level(task, fp, 0);
 863
 864         free(tasks);
 865         return 0;
 866 }
 867
 868 static int __cmd_report(struct report *rep)
 869 {
 870         int ret;
 871         struct perf_session *session = rep->session;
 872         struct evsel *pos;
 873         struct perf_data *data = session->data;
 874
 875         signal(SIGINT, sig_handler);
 876
 877         if (rep->cpu_list) {
 878                 ret = perf_session__cpu_bitmap(session, rep->cpu_list,
 879                                                rep->cpu_bitmap);
 880                 if (ret) {
 881                         ui__error("failed to set cpu bitmap\n");
 882                         return ret;
 883                 }
 884                 session->itrace_synth_opts->cpu_bitmap = rep->cpu_bitmap;
 885         }
 886
 887         if (rep->show_threads) {
 888                 ret = perf_read_values_init(&rep->show_threads_values);
 889                 if (ret)
 890                         return ret;
 891         }
 892
 893         ret = report__setup_sample_type(rep);
 894         if (ret) {
 895                 /* report__setup_sample_type() already showed error message */
 896                 return ret;
 897         }
 898
 899         if (rep->stats_mode)
 900                 stats_setup(rep);
 901
 902         if (rep->tasks_mode)
 903                 tasks_setup(rep);
 904
 905         ret = perf_session__process_events(session);
 906         if (ret) {
 907                 ui__error("failed to process sample\n");
 908                 return ret;
 909         }
 910
 911         if (rep->stats_mode)
 912                 return stats_print(rep);
 913
 914         if (rep->tasks_mode)
 915                 return tasks_print(rep, stdout);
 916
 917         report__warn_kptr_restrict(rep);
 918
 919         evlist__for_each_entry(session->evlist, pos)
 920                 rep->nr_entries += evsel__hists(pos)->nr_entries;
 921
 922         if (use_browser == 0) {
 923                 if (verbose > 3)
 924                         perf_session__fprintf(session, stdout);
 925
 926                 if (verbose > 2)
 927                         perf_session__fprintf_dsos(session, stdout);
 928
 929                 if (dump_trace) {
 930                         perf_session__fprintf_nr_events(session, stdout);
 931                         perf_evlist__fprintf_nr_events(session->evlist, stdout);
 932                         return 0;
 933                 }
 934         }
 935
 936         ret = report__collapse_hists(rep);
 937         if (ret) {
 938                 ui__error("failed to process hist entry\n");
 939                 return ret;
 940         }
 941
 942         if (session_done())
 943                 return 0;
 944
 945         /*
 946          * recalculate number of entries after collapsing since it
 947          * might be changed during the collapse phase.
 948          */
 949         rep->nr_entries = 0;
 950         evlist__for_each_entry(session->evlist, pos)
 951                 rep->nr_entries += evsel__hists(pos)->nr_entries;
 952
 953         if (rep->nr_entries == 0) {
 954                 ui__error("The %s data has no samples!\n", data->path);
 955                 return 0;
 956         }
 957
 958         report__output_resort(rep);
 959
 960         if (rep->total_cycles_mode) {
 961                 rep->block_reports = block_info__create_report(session->evlist,
 962                                                                rep->total_cycles);
 963                 if (!rep->block_reports)
 964                         return -1;
 965         }
 966
 967         return report__browse_hists(rep);
 968 }
 969
 970 static int
 971 report_parse_callchain_opt(const struct option *opt, const char *arg, int unset)
 972 {
 973         struct callchain_param *callchain = opt->value;
 974
 975         callchain->enabled = !unset;
 976         /*
 977          * --no-call-graph
 978          */
 979         if (unset) {
 980                 symbol_conf.use_callchain = false;
 981                 callchain->mode = CHAIN_NONE;
 982                 return 0;
 983         }
 984
 985         return parse_callchain_report_opt(arg);
 986 }
 987
 988 static int
 989 parse_time_quantum(const struct option *opt, const char *arg,
 990                    int unset __maybe_unused)
 991 {
 992         unsigned long *time_q = opt->value;
 993         char *end;
 994
 995         *time_q = strtoul(arg, &end, 0);
 996         if (end == arg)
 997                 goto parse_err;
 998         if (*time_q == 0) {
 999                 pr_err("time quantum cannot be 0");
1000                 return -1;
1001         }
1002         end = skip_spaces(end);
1003         if (*end == 0)
1004                 return 0;
1005         if (!strcmp(end, "s")) {
1006                 *time_q *= NSEC_PER_SEC;
1007                 return 0;
1008         }
1009         if (!strcmp(end, "ms")) {
1010                 *time_q *= NSEC_PER_MSEC;
1011                 return 0;
1012         }
1013         if (!strcmp(end, "us")) {
1014                 *time_q *= NSEC_PER_USEC;
1015                 return 0;
1016         }
1017         if (!strcmp(end, "ns"))
1018                 return 0;
1019 parse_err:
1020         pr_err("Cannot parse time quantum `%s'\n", arg);
1021         return -1;
1022 }
1023
1024 int
1025 report_parse_ignore_callees_opt(const struct option *opt __maybe_unused,
1026                                 const char *arg, int unset __maybe_unused)
1027 {
1028         if (arg) {
1029                 int err = regcomp(&ignore_callees_regex, arg, REG_EXTENDED);
1030                 if (err) {
1031                         char buf[BUFSIZ];
1032                         regerror(err, &ignore_callees_regex, buf, sizeof(buf));
1033                         pr_err("Invalid --ignore-callees regex: %s\n%s", arg, buf);
1034                         return -1;
1035                 }
1036                 have_ignore_callees = 1;
1037         }
1038
1039         return 0;
1040 }
1041
1042 static int
1043 parse_branch_mode(const struct option *opt,
1044                   const char *str __maybe_unused, int unset)
1045 {
1046         int *branch_mode = opt->value;
1047
1048         *branch_mode = !unset;
1049         return 0;
1050 }
1051
1052 static int
1053 parse_percent_limit(const struct option *opt, const char *str,
1054                     int unset __maybe_unused)
1055 {
1056         struct report *rep = opt->value;
1057         double pcnt = strtof(str, NULL);
1058
1059         rep->min_percent = pcnt;
1060         callchain_param.min_percent = pcnt;
1061         return 0;
1062 }
1063
1064 int cmd_report(int argc, const char **argv)
1065 {
1066         struct perf_session *session;
1067         struct itrace_synth_opts itrace_synth_opts = { .set = 0, };
1068         struct stat st;
1069         bool has_br_stack = false;
1070         int branch_mode = -1;
1071         bool branch_call_mode = false;
1072 #define CALLCHAIN_DEFAULT_OPT  "graph,0.5,caller,function,percent"
1073         static const char report_callchain_help[] = "Display call graph (stack chain/backtrace):\n\n"
1074                                                     CALLCHAIN_REPORT_HELP
1075                                                     "\n\t\t\t\tDefault: " CALLCHAIN_DEFAULT_OPT;
1076         char callchain_default_opt[] = CALLCHAIN_DEFAULT_OPT;
1077         const char * const report_usage[] = {
1078                 "perf report [<options>]",
1079                 NULL
1080         };
1081         struct report report = {
1082                 .tool = {
1083                         .sample          = process_sample_event,
1084                         .mmap            = perf_event__process_mmap,
1085                         .mmap2           = perf_event__process_mmap2,
1086                         .comm            = perf_event__process_comm,
1087                         .namespaces      = perf_event__process_namespaces,
1088                         .exit            = perf_event__process_exit,
1089                         .fork            = perf_event__process_fork,
1090                         .lost            = perf_event__process_lost,
1091                         .read            = process_read_event,
1092                         .attr            = perf_event__process_attr,
1093                         .tracing_data    = perf_event__process_tracing_data,
1094                         .build_id        = perf_event__process_build_id,
1095                         .id_index        = perf_event__process_id_index,
1096                         .auxtrace_info   = perf_event__process_auxtrace_info,
1097                         .auxtrace        = perf_event__process_auxtrace,
1098                         .event_update    = perf_event__process_event_update,
1099                         .feature         = process_feature_event,
1100                         .ordered_events  = true,
1101                         .ordering_requires_timestamps = true,
1102                 },
1103                 .max_stack               = PERF_MAX_STACK_DEPTH,
1104                 .pretty_printing_style   = "normal",
1105                 .socket_filter           = -1,
1106                 .annotation_opts         = annotation__default_options,
1107         };
1108         const struct option options[] = {
1109         OPT_STRING('i', "input", &input_name, "file",
1110                     "input file name"),
1111         OPT_INCR('v', "verbose", &verbose,
1112                     "be more verbose (show symbol address, etc)"),
1113         OPT_BOOLEAN('q', "quiet", &quiet, "Do not show any message"),
1114         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1115                     "dump raw trace in ASCII"),
1116         OPT_BOOLEAN(0, "stats", &report.stats_mode, "Display event stats"),
1117         OPT_BOOLEAN(0, "tasks", &report.tasks_mode, "Display recorded tasks"),
1118         OPT_BOOLEAN(0, "mmaps", &report.mmaps_mode, "Display recorded tasks memory maps"),
1119         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1120                    "file", "vmlinux pathname"),
1121         OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux,
1122                     "don't load vmlinux even if found"),
1123         OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1124                    "file", "kallsyms pathname"),
1125         OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
1126         OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
1127                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
1128         OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
1129                     "Show a column with the number of samples"),
1130         OPT_BOOLEAN('T', "threads", &report.show_threads,
1131                     "Show per-thread event counters"),
1132         OPT_STRING(0, "pretty", &report.pretty_printing_style, "key",
1133                    "pretty printing style key: normal raw"),
1134         OPT_BOOLEAN(0, "tui", &report.use_tui, "Use the TUI interface"),
1135         OPT_BOOLEAN(0, "gtk", &report.use_gtk, "Use the GTK2 interface"),
1136         OPT_BOOLEAN(0, "stdio", &report.use_stdio,
1137                     "Use the stdio interface"),
1138         OPT_BOOLEAN(0, "header", &report.header, "Show data header."),
1139         OPT_BOOLEAN(0, "header-only", &report.header_only,
1140                     "Show only data header."),
1141         OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
1142                    sort_help("sort by key(s):")),
1143         OPT_STRING('F', "fields", &field_order, "key[,keys...]",
1144                    sort_help("output field(s): overhead period sample ")),
1145         OPT_BOOLEAN(0, "show-cpu-utilization", &symbol_conf.show_cpu_utilization,
1146                     "Show sample percentage for different cpu modes"),
1147         OPT_BOOLEAN_FLAG(0, "showcpuutilization", &symbol_conf.show_cpu_utilization,
1148                     "Show sample percentage for different cpu modes", PARSE_OPT_HIDDEN),
1149         OPT_STRING('p', "parent", &parent_pattern, "regex",
1150                    "regex filter to identify parent, see: '--sort parent'"),
1151         OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other,
1152                     "Only display entries with parent-match"),
1153         OPT_CALLBACK_DEFAULT('g', "call-graph", &callchain_param,
1154                              "print_type,threshold[,print_limit],order,sort_key[,branch],value",
1155                              report_callchain_help, &report_parse_callchain_opt,
1156                              callchain_default_opt),
1157         OPT_BOOLEAN(0, "children", &symbol_conf.cumulate_callchain,
1158                     "Accumulate callchains of children and show total overhead as well"),
1159         OPT_INTEGER(0, "max-stack", &report.max_stack,
1160                     "Set the maximum stack depth when parsing the callchain, "
1161                     "anything beyond the specified depth will be ignored. "
1162                     "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
1163         OPT_BOOLEAN('G', "inverted", &report.inverted_callchain,
1164                     "alias for inverted call graph"),
1165         OPT_CALLBACK(0, "ignore-callees", NULL, "regex",
1166                    "ignore callees of these functions in call graphs",
1167                    report_parse_ignore_callees_opt),
1168         OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
1169                    "only consider symbols in these dsos"),
1170         OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1171                    "only consider symbols in these comms"),
1172         OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
1173                    "only consider symbols in these pids"),
1174         OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
1175                    "only consider symbols in these tids"),
1176         OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1177                    "only consider these symbols"),
1178         OPT_STRING(0, "symbol-filter", &report.symbol_filter_str, "filter",
1179                    "only show symbols that (partially) match with this filter"),
1180         OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
1181                    "width[,width...]",
1182                    "don't try to adjust column width, use these fixed values"),
1183         OPT_STRING_NOEMPTY('t', "field-separator", &symbol_conf.field_sep, "separator",
1184                    "separator for columns, no spaces will be added between "
1185                    "columns '.' is reserved."),
1186         OPT_BOOLEAN('U', "hide-unresolved", &symbol_conf.hide_unresolved,
1187                     "Only display entries resolved to a symbol"),
1188         OPT_CALLBACK(0, "symfs", NULL, "directory",
1189                      "Look for files with symbols relative to this directory",
1190                      symbol__config_symfs),
1191         OPT_STRING('C', "cpu", &report.cpu_list, "cpu",
1192                    "list of cpus to profile"),
1193         OPT_BOOLEAN('I', "show-info", &report.show_full_info,
1194                     "Display extended information about perf.data file"),
1195         OPT_BOOLEAN(0, "source", &report.annotation_opts.annotate_src,
1196                     "Interleave source code with assembly code (default)"),
1197         OPT_BOOLEAN(0, "asm-raw", &report.annotation_opts.show_asm_raw,
1198                     "Display raw encoding of assembly instructions (default)"),
1199         OPT_STRING('M', "disassembler-style", &report.annotation_opts.disassembler_style, "disassembler style",
1200                    "Specify disassembler style (e.g. -M intel for intel syntax)"),
1201         OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
1202                     "Show a column with the sum of periods"),
1203         OPT_BOOLEAN_SET(0, "group", &symbol_conf.event_group, &report.group_set,
1204                     "Show event group information together"),
1205         OPT_CALLBACK_NOOPT('b', "branch-stack", &branch_mode, "",
1206                     "use branch records for per branch histogram filling",
1207                     parse_branch_mode),
1208         OPT_BOOLEAN(0, "branch-history", &branch_call_mode,
1209                     "add last branch records to call history"),
1210         OPT_STRING(0, "objdump", &report.annotation_opts.objdump_path, "path",
1211                    "objdump binary to use for disassembly and annotations"),
1212         OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
1213                     "Disable symbol demangling"),
1214         OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
1215                     "Enable kernel symbol demangling"),
1216         OPT_BOOLEAN(0, "mem-mode", &report.mem_mode, "mem access profile"),
1217         OPT_INTEGER(0, "samples", &symbol_conf.res_sample,
1218                     "Number of samples to save per histogram entry for individual browsing"),
1219         OPT_CALLBACK(0, "percent-limit", &report, "percent",
1220                      "Don't show entries under that percent", parse_percent_limit),
1221         OPT_CALLBACK(0, "percentage", NULL, "relative|absolute",
1222                      "how to display percentage of filtered entries", parse_filter_percentage),
1223         OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
1224                             "Instruction Tracing options\n" ITRACE_HELP,
1225                             itrace_parse_synth_opts),
1226         OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
1227                         "Show full source file name path for source lines"),
1228         OPT_BOOLEAN(0, "show-ref-call-graph", &symbol_conf.show_ref_callgraph,
1229                     "Show callgraph from reference event"),
1230         OPT_INTEGER(0, "socket-filter", &report.socket_filter,
1231                     "only show processor socket that match with this filter"),
1232         OPT_BOOLEAN(0, "raw-trace", &symbol_conf.raw_trace,
1233                     "Show raw trace event output (do not use print fmt or plugins)"),
1234         OPT_BOOLEAN(0, "hierarchy", &symbol_conf.report_hierarchy,
1235                     "Show entries in a hierarchy"),
1236         OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL, "mode",
1237                              "'always' (default), 'never' or 'auto' only applicable to --stdio mode",
1238                              stdio__config_color, "always"),
1239         OPT_STRING(0, "time", &report.time_str, "str",
1240                    "Time span of interest (start,stop)"),
1241         OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
1242                     "Show inline function"),
1243         OPT_CALLBACK(0, "percent-type", &report.annotation_opts, "local-period",
1244                      "Set percent type local/global-period/hits",
1245                      annotate_parse_percent_type),
1246         OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs, "Show times in nanosecs"),
1247         OPT_CALLBACK(0, "time-quantum", &symbol_conf.time_quantum, "time (ms|us|ns|s)",
1248                      "Set time quantum for time sort key (default 100ms)",
1249                      parse_time_quantum),
1250         OPTS_EVSWITCH(&report.evswitch),
1251         OPT_BOOLEAN(0, "total-cycles", &report.total_cycles_mode,
1252                     "Sort all blocks by 'Sampled Cycles%'"),
1253         OPT_END()
1254         };
1255         struct perf_data data = {
1256                 .mode  = PERF_DATA_MODE_READ,
1257         };
1258         int ret = hists__init();
1259         char sort_tmp[128];
1260
1261         if (ret < 0)
1262                 return ret;
1263
1264         ret = perf_config(report__config, &report);
1265         if (ret)
1266                 return ret;
1267
1268         argc = parse_options(argc, argv, options, report_usage, 0);
1269         if (argc) {
1270                 /*
1271                  * Special case: if there's an argument left then assume that
1272                  * it's a symbol filter:
1273                  */
1274                 if (argc > 1)
1275                         usage_with_options(report_usage, options);
1276
1277                 report.symbol_filter_str = argv[0];
1278         }
1279
1280         if (report.mmaps_mode)
1281                 report.tasks_mode = true;
1282
1283         if (quiet)
1284                 perf_quiet_option();
1285
1286         if (symbol_conf.vmlinux_name &&
1287             access(symbol_conf.vmlinux_name, R_OK)) {
1288                 pr_err("Invalid file: %s\n", symbol_conf.vmlinux_name);
1289                 return -EINVAL;
1290         }
1291         if (symbol_conf.kallsyms_name &&
1292             access(symbol_conf.kallsyms_name, R_OK)) {
1293                 pr_err("Invalid file: %s\n", symbol_conf.kallsyms_name);
1294                 return -EINVAL;
1295         }
1296
1297         if (report.inverted_callchain)
1298                 callchain_param.order = ORDER_CALLER;
1299         if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
1300                 callchain_param.order = ORDER_CALLER;
1301
1302         if (itrace_synth_opts.callchain &&
1303             (int)itrace_synth_opts.callchain_sz > report.max_stack)
1304                 report.max_stack = itrace_synth_opts.callchain_sz;
1305
1306         if (!input_name || !strlen(input_name)) {
1307                 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
1308                         input_name = "-";
1309                 else
1310                         input_name = "perf.data";
1311         }
1312
1313         data.path  = input_name;
1314         data.force = symbol_conf.force;
1315
1316 repeat:
1317         session = perf_session__new(&data, false, &report.tool);
1318         if (IS_ERR(session))
1319                 return PTR_ERR(session);
1320
1321         ret = evswitch__init(&report.evswitch, session->evlist, stderr);
1322         if (ret)
1323                 return ret;
1324
1325         if (zstd_init(&(session->zstd_data), 0) < 0)
1326                 pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
1327
1328         if (report.queue_size) {
1329                 ordered_events__set_alloc_size(&session->ordered_events,
1330                                                report.queue_size);
1331         }
1332
1333         session->itrace_synth_opts = &itrace_synth_opts;
1334
1335         report.session = session;
1336
1337         has_br_stack = perf_header__has_feat(&session->header,
1338                                              HEADER_BRANCH_STACK);
1339         if (perf_evlist__combined_sample_type(session->evlist) & PERF_SAMPLE_STACK_USER)
1340                 has_br_stack = false;
1341
1342         setup_forced_leader(&report, session->evlist);
1343
1344         if (itrace_synth_opts.last_branch)
1345                 has_br_stack = true;
1346
1347         if (has_br_stack && branch_call_mode)
1348                 symbol_conf.show_branchflag_count = true;
1349
1350         memset(&report.brtype_stat, 0, sizeof(struct branch_type_stat));
1351
1352         /*
1353          * Branch mode is a tristate:
1354          * -1 means default, so decide based on the file having branch data.
1355          * 0/1 means the user chose a mode.
1356          */
1357         if (((branch_mode == -1 && has_br_stack) || branch_mode == 1) &&
1358             !branch_call_mode) {
1359                 sort__mode = SORT_MODE__BRANCH;
1360                 symbol_conf.cumulate_callchain = false;
1361         }
1362         if (branch_call_mode) {
1363                 callchain_param.key = CCKEY_ADDRESS;
1364                 callchain_param.branch_callstack = 1;
1365                 symbol_conf.use_callchain = true;
1366                 callchain_register_param(&callchain_param);
1367                 if (sort_order == NULL)
1368                         sort_order = "srcline,symbol,dso";
1369         }
1370
1371         if (report.mem_mode) {
1372                 if (sort__mode == SORT_MODE__BRANCH) {
1373                         pr_err("branch and mem mode incompatible\n");
1374                         goto error;
1375                 }
1376                 sort__mode = SORT_MODE__MEMORY;
1377                 symbol_conf.cumulate_callchain = false;
1378         }
1379
1380         if (symbol_conf.report_hierarchy) {
1381                 /* disable incompatible options */
1382                 symbol_conf.cumulate_callchain = false;
1383
1384                 if (field_order) {
1385                         pr_err("Error: --hierarchy and --fields options cannot be used together\n");
1386                         parse_options_usage(report_usage, options, "F", 1);
1387                         parse_options_usage(NULL, options, "hierarchy", 0);
1388                         goto error;
1389                 }
1390
1391                 perf_hpp_list.need_collapse = true;
1392         }
1393
1394         if (report.use_stdio)
1395                 use_browser = 0;
1396         else if (report.use_tui)
1397                 use_browser = 1;
1398         else if (report.use_gtk)
1399                 use_browser = 2;
1400
1401         /* Force tty output for header output and per-thread stat. */
1402         if (report.header || report.header_only || report.show_threads)
1403                 use_browser = 0;
1404         if (report.header || report.header_only)
1405                 report.tool.show_feat_hdr = SHOW_FEAT_HEADER;
1406         if (report.show_full_info)
1407                 report.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
1408         if (report.stats_mode || report.tasks_mode)
1409                 use_browser = 0;
1410         if (report.stats_mode && report.tasks_mode) {
1411                 pr_err("Error: --tasks and --mmaps can't be used together with --stats\n");
1412                 goto error;
1413         }
1414
1415         if (report.total_cycles_mode) {
1416                 if (sort__mode != SORT_MODE__BRANCH)
1417                         report.total_cycles_mode = false;
1418                 else
1419                         sort_order = NULL;
1420         }
1421
1422         if (strcmp(input_name, "-") != 0)
1423                 setup_browser(true);
1424         else
1425                 use_browser = 0;
1426
1427         if (sort_order && strstr(sort_order, "ipc")) {
1428                 parse_options_usage(report_usage, options, "s", 1);
1429                 goto error;
1430         }
1431
1432         if (sort_order && strstr(sort_order, "symbol")) {
1433                 if (sort__mode == SORT_MODE__BRANCH) {
1434                         snprintf(sort_tmp, sizeof(sort_tmp), "%s,%s",
1435                                  sort_order, "ipc_lbr");
1436                         report.symbol_ipc = true;
1437                 } else {
1438                         snprintf(sort_tmp, sizeof(sort_tmp), "%s,%s",
1439                                  sort_order, "ipc_null");
1440                 }
1441
1442                 sort_order = sort_tmp;
1443         }
1444
1445         if (setup_sorting(session->evlist) < 0) {
1446                 if (sort_order)
1447                         parse_options_usage(report_usage, options, "s", 1);
1448                 if (field_order)
1449                         parse_options_usage(sort_order ? NULL : report_usage,
1450                                             options, "F", 1);
1451                 goto error;
1452         }
1453
1454         if ((report.header || report.header_only) && !quiet) {
1455                 perf_session__fprintf_info(session, stdout,
1456                                            report.show_full_info);
1457                 if (report.header_only) {
1458                         ret = 0;
1459                         goto error;
1460                 }
1461         } else if (use_browser == 0 && !quiet &&
1462                    !report.stats_mode && !report.tasks_mode) {
1463                 fputs("# To display the perf.data header info, please use --header/--header-only options.\n#\n",
1464                       stdout);
1465         }
1466
1467         /*
1468          * Only in the TUI browser we are doing integrated annotation,
1469          * so don't allocate extra space that won't be used in the stdio
1470          * implementation.
1471          */
1472         if (ui__has_annotation() || report.symbol_ipc ||
1473             report.total_cycles_mode) {
1474                 ret = symbol__annotation_init();
1475                 if (ret < 0)
1476                         goto error;
1477                 /*
1478                  * For searching by name on the "Browse map details".
1479                  * providing it only in verbose mode not to bloat too
1480                  * much struct symbol.
1481                  */
1482                 if (verbose > 0) {
1483                         /*
1484                          * XXX: Need to provide a less kludgy way to ask for
1485                          * more space per symbol, the u32 is for the index on
1486                          * the ui browser.
1487                          * See symbol__browser_index.
1488                          */
1489                         symbol_conf.priv_size += sizeof(u32);
1490                         symbol_conf.sort_by_name = true;
1491                 }
1492                 annotation_config__init();
1493         }
1494
1495         if (symbol__init(&session->header.env) < 0)
1496                 goto error;
1497
1498         if (report.time_str) {
1499                 ret = perf_time__parse_for_ranges(report.time_str, session,
1500                                                   &report.ptime_range,
1501                                                   &report.range_size,
1502                                                   &report.range_num);
1503                 if (ret < 0)
1504                         goto error;
1505
1506                 itrace_synth_opts__set_time_range(&itrace_synth_opts,
1507                                                   report.ptime_range,
1508                                                   report.range_num);
1509         }
1510
1511         if (session->tevent.pevent &&
1512             tep_set_function_resolver(session->tevent.pevent,
1513                                       machine__resolve_kernel_addr,
1514                                       &session->machines.host) < 0) {
1515                 pr_err("%s: failed to set libtraceevent function resolver\n",
1516                        __func__);
1517                 return -1;
1518         }
1519
1520         sort__setup_elide(stdout);
1521
1522         ret = __cmd_report(&report);
1523         if (ret == K_SWITCH_INPUT_DATA) {
1524                 perf_session__delete(session);
1525                 goto repeat;
1526         } else
1527                 ret = 0;
1528
1529 error:
1530         if (report.ptime_range) {
1531                 itrace_synth_opts__clear_time_range(&itrace_synth_opts);
1532                 zfree(&report.ptime_range);
1533         }
1534
1535         if (report.block_reports)
1536                 zfree(&report.block_reports);
1537
1538         zstd_fini(&(session->zstd_data));
1539         perf_session__delete(session);
1540         return ret;
1541 }