tools/perf/builtin-report.c

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