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