tools/perf/builtin-report.c

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