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