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