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