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