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