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
  12 #include "util/annotate.h"
  13 #include "util/color.h"
  14 #include <linux/list.h>
  15 #include "util/cache.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
  37 #include <linux/bitmap.h>
  38
  39 struct perf_report {
  40         struct perf_tool        tool;
  41         struct perf_session     *session;
  42         char const              *input_name;
  43         bool                    force, use_tui, use_gtk, use_stdio;
  44         bool                    hide_unresolved;
  45         bool                    dont_use_callchains;
  46         bool                    show_full_info;
  47         bool                    show_threads;
  48         bool                    inverted_callchain;
  49         struct perf_read_values show_threads_values;
  50         const char              *pretty_printing_style;
  51         symbol_filter_t         annotate_init;
  52         const char              *cpu_list;
  53         const char              *symbol_filter_str;
  54         DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
  55 };
  56
  57 static int perf_report__add_branch_hist_entry(struct perf_tool *tool,
  58                                         struct addr_location *al,
  59                                         struct perf_sample *sample,
  60                                         struct perf_evsel *evsel,
  61                                       struct machine *machine)
  62 {
  63         struct perf_report *rep = container_of(tool, struct perf_report, tool);
  64         struct symbol *parent = NULL;
  65         int err = 0;
  66         unsigned i;
  67         struct hist_entry *he;
  68         struct branch_info *bi, *bx;
  69
  70         if ((sort__has_parent || symbol_conf.use_callchain)
  71             && sample->callchain) {
  72                 err = machine__resolve_callchain(machine, evsel, al->thread,
  73                                                  sample->callchain, &parent);
  74                 if (err)
  75                         return err;
  76         }
  77
  78         bi = machine__resolve_bstack(machine, al->thread,
  79                                      sample->branch_stack);
  80         if (!bi)
  81                 return -ENOMEM;
  82
  83         for (i = 0; i < sample->branch_stack->nr; i++) {
  84                 if (rep->hide_unresolved && !(bi[i].from.sym && bi[i].to.sym))
  85                         continue;
  86                 /*
  87                  * The report shows the percentage of total branches captured
  88                  * and not events sampled. Thus we use a pseudo period of 1.
  89                  */
  90                 he = __hists__add_branch_entry(&evsel->hists, al, parent,
  91                                 &bi[i], 1);
  92                 if (he) {
  93                         struct annotation *notes;
  94                         err = -ENOMEM;
  95                         bx = he->branch_info;
  96                         if (bx->from.sym && use_browser > 0) {
  97                                 notes = symbol__annotation(bx->from.sym);
  98                                 if (!notes->src
  99                                     && symbol__alloc_hist(bx->from.sym) < 0)
 100                                         goto out;
 101
 102                                 err = symbol__inc_addr_samples(bx->from.sym,
 103                                                                bx->from.map,
 104                                                                evsel->idx,
 105                                                                bx->from.al_addr);
 106                                 if (err)
 107                                         goto out;
 108                         }
 109
 110                         if (bx->to.sym && use_browser > 0) {
 111                                 notes = symbol__annotation(bx->to.sym);
 112                                 if (!notes->src
 113                                     && symbol__alloc_hist(bx->to.sym) < 0)
 114                                         goto out;
 115
 116                                 err = symbol__inc_addr_samples(bx->to.sym,
 117                                                                bx->to.map,
 118                                                                evsel->idx,
 119                                                                bx->to.al_addr);
 120                                 if (err)
 121                                         goto out;
 122                         }
 123                         evsel->hists.stats.total_period += 1;
 124                         hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE);
 125                         err = 0;
 126                 } else
 127                         return -ENOMEM;
 128         }
 129 out:
 130         return err;
 131 }
 132
 133 static int perf_evsel__add_hist_entry(struct perf_evsel *evsel,
 134                                       struct addr_location *al,
 135                                       struct perf_sample *sample,
 136                                       struct machine *machine)
 137 {
 138         struct symbol *parent = NULL;
 139         int err = 0;
 140         struct hist_entry *he;
 141
 142         if ((sort__has_parent || symbol_conf.use_callchain) && sample->callchain) {
 143                 err = machine__resolve_callchain(machine, evsel, al->thread,
 144                                                  sample->callchain, &parent);
 145                 if (err)
 146                         return err;
 147         }
 148
 149         he = __hists__add_entry(&evsel->hists, al, parent, sample->period);
 150         if (he == NULL)
 151                 return -ENOMEM;
 152
 153         if (symbol_conf.use_callchain) {
 154                 err = callchain_append(he->callchain,
 155                                        &evsel->hists.callchain_cursor,
 156                                        sample->period);
 157                 if (err)
 158                         return err;
 159         }
 160         /*
 161          * Only in the newt browser we are doing integrated annotation,
 162          * so we don't allocated the extra space needed because the stdio
 163          * code will not use it.
 164          */
 165         if (al->sym != NULL && use_browser > 0) {
 166                 struct annotation *notes = symbol__annotation(he->ms.sym);
 167
 168                 assert(evsel != NULL);
 169
 170                 err = -ENOMEM;
 171                 if (notes->src == NULL && symbol__alloc_hist(he->ms.sym) < 0)
 172                         goto out;
 173
 174                 err = hist_entry__inc_addr_samples(he, evsel->idx, al->addr);
 175         }
 176
 177         evsel->hists.stats.total_period += sample->period;
 178         hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE);
 179 out:
 180         return err;
 181 }
 182
 183
 184 static int process_sample_event(struct perf_tool *tool,
 185                                 union perf_event *event,
 186                                 struct perf_sample *sample,
 187                                 struct perf_evsel *evsel,
 188                                 struct machine *machine)
 189 {
 190         struct perf_report *rep = container_of(tool, struct perf_report, tool);
 191         struct addr_location al;
 192
 193         if (perf_event__preprocess_sample(event, machine, &al, sample,
 194                                           rep->annotate_init) < 0) {
 195                 fprintf(stderr, "problem processing %d event, skipping it.\n",
 196                         event->header.type);
 197                 return -1;
 198         }
 199
 200         if (al.filtered || (rep->hide_unresolved && al.sym == NULL))
 201                 return 0;
 202
 203         if (rep->cpu_list && !test_bit(sample->cpu, rep->cpu_bitmap))
 204                 return 0;
 205
 206         if (sort__branch_mode == 1) {
 207                 if (perf_report__add_branch_hist_entry(tool, &al, sample,
 208                                                        evsel, machine)) {
 209                         pr_debug("problem adding lbr entry, skipping event\n");
 210                         return -1;
 211                 }
 212         } else {
 213                 if (al.map != NULL)
 214                         al.map->dso->hit = 1;
 215
 216                 if (perf_evsel__add_hist_entry(evsel, &al, sample, machine)) {
 217                         pr_debug("problem incrementing symbol period, skipping event\n");
 218                         return -1;
 219                 }
 220         }
 221         return 0;
 222 }
 223
 224 static int process_read_event(struct perf_tool *tool,
 225                               union perf_event *event,
 226                               struct perf_sample *sample __used,
 227                               struct perf_evsel *evsel,
 228                               struct machine *machine __used)
 229 {
 230         struct perf_report *rep = container_of(tool, struct perf_report, tool);
 231
 232         if (rep->show_threads) {
 233                 const char *name = evsel ? event_name(evsel) : "unknown";
 234                 perf_read_values_add_value(&rep->show_threads_values,
 235                                            event->read.pid, event->read.tid,
 236                                            event->read.id,
 237                                            name,
 238                                            event->read.value);
 239         }
 240
 241         dump_printf(": %d %d %s %" PRIu64 "\n", event->read.pid, event->read.tid,
 242                     evsel ? event_name(evsel) : "FAIL",
 243                     event->read.value);
 244
 245         return 0;
 246 }
 247
 248 static int perf_report__setup_sample_type(struct perf_report *rep)
 249 {
 250         struct perf_session *self = rep->session;
 251
 252         if (!(self->sample_type & PERF_SAMPLE_CALLCHAIN)) {
 253                 if (sort__has_parent) {
 254                         ui__warning("Selected --sort parent, but no "
 255                                     "callchain data. Did you call "
 256                                     "'perf record' without -g?\n");
 257                         return -EINVAL;
 258                 }
 259                 if (symbol_conf.use_callchain) {
 260                         ui__warning("Selected -g but no callchain data. Did "
 261                                     "you call 'perf record' without -g?\n");
 262                         return -1;
 263                 }
 264         } else if (!rep->dont_use_callchains &&
 265                    callchain_param.mode != CHAIN_NONE &&
 266                    !symbol_conf.use_callchain) {
 267                         symbol_conf.use_callchain = true;
 268                         if (callchain_register_param(&callchain_param) < 0) {
 269                                 ui__warning("Can't register callchain "
 270                                             "params.\n");
 271                                 return -EINVAL;
 272                         }
 273         }
 274
 275         if (sort__branch_mode == 1) {
 276                 if (!(self->sample_type & PERF_SAMPLE_BRANCH_STACK)) {
 277                         fprintf(stderr, "selected -b but no branch data."
 278                                         " Did you call perf record without"
 279                                         " -b?\n");
 280                         return -1;
 281                 }
 282         }
 283
 284         return 0;
 285 }
 286
 287 extern volatile int session_done;
 288
 289 static void sig_handler(int sig __used)
 290 {
 291         session_done = 1;
 292 }
 293
 294 static size_t hists__fprintf_nr_sample_events(struct hists *self,
 295                                               const char *evname, FILE *fp)
 296 {
 297         size_t ret;
 298         char unit;
 299         unsigned long nr_events = self->stats.nr_events[PERF_RECORD_SAMPLE];
 300
 301         nr_events = convert_unit(nr_events, &unit);
 302         ret = fprintf(fp, "# Events: %lu%c", nr_events, unit);
 303         if (evname != NULL)
 304                 ret += fprintf(fp, " %s", evname);
 305         return ret + fprintf(fp, "\n#\n");
 306 }
 307
 308 static int perf_evlist__tty_browse_hists(struct perf_evlist *evlist,
 309                                          struct perf_report *rep,
 310                                          const char *help)
 311 {
 312         struct perf_evsel *pos;
 313
 314         list_for_each_entry(pos, &evlist->entries, node) {
 315                 struct hists *hists = &pos->hists;
 316                 const char *evname = event_name(pos);
 317
 318                 hists__fprintf_nr_sample_events(hists, evname, stdout);
 319                 hists__fprintf(hists, NULL, false, true, 0, 0, stdout);
 320                 fprintf(stdout, "\n\n");
 321         }
 322
 323         if (sort_order == default_sort_order &&
 324             parent_pattern == default_parent_pattern) {
 325                 fprintf(stdout, "#\n# (%s)\n#\n", help);
 326
 327                 if (rep->show_threads) {
 328                         bool style = !strcmp(rep->pretty_printing_style, "raw");
 329                         perf_read_values_display(stdout, &rep->show_threads_values,
 330                                                  style);
 331                         perf_read_values_destroy(&rep->show_threads_values);
 332                 }
 333         }
 334
 335         return 0;
 336 }
 337
 338 static int __cmd_report(struct perf_report *rep)
 339 {
 340         int ret = -EINVAL;
 341         u64 nr_samples;
 342         struct perf_session *session = rep->session;
 343         struct perf_evsel *pos;
 344         struct map *kernel_map;
 345         struct kmap *kernel_kmap;
 346         const char *help = "For a higher level overview, try: perf report --sort comm,dso";
 347
 348         signal(SIGINT, sig_handler);
 349
 350         if (rep->cpu_list) {
 351                 ret = perf_session__cpu_bitmap(session, rep->cpu_list,
 352                                                rep->cpu_bitmap);
 353                 if (ret)
 354                         goto out_delete;
 355         }
 356
 357         if (use_browser <= 0)
 358                 perf_session__fprintf_info(session, stdout, rep->show_full_info);
 359
 360         if (rep->show_threads)
 361                 perf_read_values_init(&rep->show_threads_values);
 362
 363         ret = perf_report__setup_sample_type(rep);
 364         if (ret)
 365                 goto out_delete;
 366
 367         ret = perf_session__process_events(session, &rep->tool);
 368         if (ret)
 369                 goto out_delete;
 370
 371         kernel_map = session->host_machine.vmlinux_maps[MAP__FUNCTION];
 372         kernel_kmap = map__kmap(kernel_map);
 373         if (kernel_map == NULL ||
 374             (kernel_map->dso->hit &&
 375              (kernel_kmap->ref_reloc_sym == NULL ||
 376               kernel_kmap->ref_reloc_sym->addr == 0))) {
 377                 const char *desc =
 378                     "As no suitable kallsyms nor vmlinux was found, kernel samples\n"
 379                     "can't be resolved.";
 380
 381                 if (kernel_map) {
 382                         const struct dso *kdso = kernel_map->dso;
 383                         if (!RB_EMPTY_ROOT(&kdso->symbols[MAP__FUNCTION])) {
 384                                 desc = "If some relocation was applied (e.g. "
 385                                        "kexec) symbols may be misresolved.";
 386                         }
 387                 }
 388
 389                 ui__warning(
 390 "Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n"
 391 "Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n"
 392 "Samples in kernel modules can't be resolved as well.\n\n",
 393                 desc);
 394         }
 395
 396         if (dump_trace) {
 397                 perf_session__fprintf_nr_events(session, stdout);
 398                 goto out_delete;
 399         }
 400
 401         if (verbose > 3)
 402                 perf_session__fprintf(session, stdout);
 403
 404         if (verbose > 2)
 405                 perf_session__fprintf_dsos(session, stdout);
 406
 407         nr_samples = 0;
 408         list_for_each_entry(pos, &session->evlist->entries, node) {
 409                 struct hists *hists = &pos->hists;
 410
 411                 if (pos->idx == 0)
 412                         hists->symbol_filter_str = rep->symbol_filter_str;
 413
 414                 hists__collapse_resort(hists);
 415                 hists__output_resort(hists);
 416                 nr_samples += hists->stats.nr_events[PERF_RECORD_SAMPLE];
 417         }
 418
 419         if (nr_samples == 0) {
 420                 ui__warning("The %s file has no samples!\n", session->filename);
 421                 goto out_delete;
 422         }
 423
 424         if (use_browser > 0) {
 425                 if (use_browser == 1) {
 426                         perf_evlist__tui_browse_hists(session->evlist, help,
 427                                                       NULL, NULL, 0);
 428                 } else if (use_browser == 2) {
 429                         perf_evlist__gtk_browse_hists(session->evlist, help,
 430                                                       NULL, NULL, 0);
 431                 }
 432         } else
 433                 perf_evlist__tty_browse_hists(session->evlist, rep, help);
 434
 435 out_delete:
 436         /*
 437          * Speed up the exit process, for large files this can
 438          * take quite a while.
 439          *
 440          * XXX Enable this when using valgrind or if we ever
 441          * librarize this command.
 442          *
 443          * Also experiment with obstacks to see how much speed
 444          * up we'll get here.
 445          *
 446          * perf_session__delete(session);
 447          */
 448         return ret;
 449 }
 450
 451 static int
 452 parse_callchain_opt(const struct option *opt, const char *arg, int unset)
 453 {
 454         struct perf_report *rep = (struct perf_report *)opt->value;
 455         char *tok, *tok2;
 456         char *endptr;
 457
 458         /*
 459          * --no-call-graph
 460          */
 461         if (unset) {
 462                 rep->dont_use_callchains = true;
 463                 return 0;
 464         }
 465
 466         symbol_conf.use_callchain = true;
 467
 468         if (!arg)
 469                 return 0;
 470
 471         tok = strtok((char *)arg, ",");
 472         if (!tok)
 473                 return -1;
 474
 475         /* get the output mode */
 476         if (!strncmp(tok, "graph", strlen(arg)))
 477                 callchain_param.mode = CHAIN_GRAPH_ABS;
 478
 479         else if (!strncmp(tok, "flat", strlen(arg)))
 480                 callchain_param.mode = CHAIN_FLAT;
 481
 482         else if (!strncmp(tok, "fractal", strlen(arg)))
 483                 callchain_param.mode = CHAIN_GRAPH_REL;
 484
 485         else if (!strncmp(tok, "none", strlen(arg))) {
 486                 callchain_param.mode = CHAIN_NONE;
 487                 symbol_conf.use_callchain = false;
 488
 489                 return 0;
 490         }
 491
 492         else
 493                 return -1;
 494
 495         /* get the min percentage */
 496         tok = strtok(NULL, ",");
 497         if (!tok)
 498                 goto setup;
 499
 500         callchain_param.min_percent = strtod(tok, &endptr);
 501         if (tok == endptr)
 502                 return -1;
 503
 504         /* get the print limit */
 505         tok2 = strtok(NULL, ",");
 506         if (!tok2)
 507                 goto setup;
 508
 509         if (tok2[0] != 'c') {
 510                 callchain_param.print_limit = strtoul(tok2, &endptr, 0);
 511                 tok2 = strtok(NULL, ",");
 512                 if (!tok2)
 513                         goto setup;
 514         }
 515
 516         /* get the call chain order */
 517         if (!strcmp(tok2, "caller"))
 518                 callchain_param.order = ORDER_CALLER;
 519         else if (!strcmp(tok2, "callee"))
 520                 callchain_param.order = ORDER_CALLEE;
 521         else
 522                 return -1;
 523 setup:
 524         if (callchain_register_param(&callchain_param) < 0) {
 525                 fprintf(stderr, "Can't register callchain params\n");
 526                 return -1;
 527         }
 528         return 0;
 529 }
 530
 531 static int
 532 parse_branch_mode(const struct option *opt __used, const char *str __used, int unset)
 533 {
 534         sort__branch_mode = !unset;
 535         return 0;
 536 }
 537
 538 int cmd_report(int argc, const char **argv, const char *prefix __used)
 539 {
 540         struct perf_session *session;
 541         struct stat st;
 542         bool has_br_stack = false;
 543         int ret = -1;
 544         char callchain_default_opt[] = "fractal,0.5,callee";
 545         const char * const report_usage[] = {
 546                 "perf report [<options>]",
 547                 NULL
 548         };
 549         struct perf_report report = {
 550                 .tool = {
 551                         .sample          = process_sample_event,
 552                         .mmap            = perf_event__process_mmap,
 553                         .comm            = perf_event__process_comm,
 554                         .exit            = perf_event__process_task,
 555                         .fork            = perf_event__process_task,
 556                         .lost            = perf_event__process_lost,
 557                         .read            = process_read_event,
 558                         .attr            = perf_event__process_attr,
 559                         .event_type      = perf_event__process_event_type,
 560                         .tracing_data    = perf_event__process_tracing_data,
 561                         .build_id        = perf_event__process_build_id,
 562                         .ordered_samples = true,
 563                         .ordering_requires_timestamps = true,
 564                 },
 565                 .pretty_printing_style   = "normal",
 566         };
 567         const struct option options[] = {
 568         OPT_STRING('i', "input", &report.input_name, "file",
 569                     "input file name"),
 570         OPT_INCR('v', "verbose", &verbose,
 571                     "be more verbose (show symbol address, etc)"),
 572         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
 573                     "dump raw trace in ASCII"),
 574         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
 575                    "file", "vmlinux pathname"),
 576         OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
 577                    "file", "kallsyms pathname"),
 578         OPT_BOOLEAN('f', "force", &report.force, "don't complain, do it"),
 579         OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
 580                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
 581         OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
 582                     "Show a column with the number of samples"),
 583         OPT_BOOLEAN('T', "threads", &report.show_threads,
 584                     "Show per-thread event counters"),
 585         OPT_STRING(0, "pretty", &report.pretty_printing_style, "key",
 586                    "pretty printing style key: normal raw"),
 587         OPT_BOOLEAN(0, "tui", &report.use_tui, "Use the TUI interface"),
 588         OPT_BOOLEAN(0, "gtk", &report.use_gtk, "Use the GTK2 interface"),
 589         OPT_BOOLEAN(0, "stdio", &report.use_stdio,
 590                     "Use the stdio interface"),
 591         OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
 592                    "sort by key(s): pid, comm, dso, symbol, parent, dso_to,"
 593                    " dso_from, symbol_to, symbol_from, mispredict"),
 594         OPT_BOOLEAN(0, "showcpuutilization", &symbol_conf.show_cpu_utilization,
 595                     "Show sample percentage for different cpu modes"),
 596         OPT_STRING('p', "parent", &parent_pattern, "regex",
 597                    "regex filter to identify parent, see: '--sort parent'"),
 598         OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other,
 599                     "Only display entries with parent-match"),
 600         OPT_CALLBACK_DEFAULT('g', "call-graph", &report, "output_type,min_percent[,print_limit],call_order",
 601                      "Display callchains using output_type (graph, flat, fractal, or none) , min percent threshold, optional print limit and callchain order. "
 602                      "Default: fractal,0.5,callee", &parse_callchain_opt, callchain_default_opt),
 603         OPT_BOOLEAN('G', "inverted", &report.inverted_callchain,
 604                     "alias for inverted call graph"),
 605         OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
 606                    "only consider symbols in these dsos"),
 607         OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
 608                    "only consider symbols in these comms"),
 609         OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
 610                    "only consider these symbols"),
 611         OPT_STRING(0, "symbol-filter", &report.symbol_filter_str, "filter",
 612                    "only show symbols that (partially) match with this filter"),
 613         OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
 614                    "width[,width...]",
 615                    "don't try to adjust column width, use these fixed values"),
 616         OPT_STRING('t', "field-separator", &symbol_conf.field_sep, "separator",
 617                    "separator for columns, no spaces will be added between "
 618                    "columns '.' is reserved."),
 619         OPT_BOOLEAN('U', "hide-unresolved", &report.hide_unresolved,
 620                     "Only display entries resolved to a symbol"),
 621         OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
 622                     "Look for files with symbols relative to this directory"),
 623         OPT_STRING('C', "cpu", &report.cpu_list, "cpu",
 624                    "list of cpus to profile"),
 625         OPT_BOOLEAN('I', "show-info", &report.show_full_info,
 626                     "Display extended information about perf.data file"),
 627         OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
 628                     "Interleave source code with assembly code (default)"),
 629         OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
 630                     "Display raw encoding of assembly instructions (default)"),
 631         OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
 632                    "Specify disassembler style (e.g. -M intel for intel syntax)"),
 633         OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
 634                     "Show a column with the sum of periods"),
 635         OPT_CALLBACK_NOOPT('b', "branch-stack", &sort__branch_mode, "",
 636                     "use branch records for histogram filling", parse_branch_mode),
 637         OPT_END()
 638         };
 639
 640         argc = parse_options(argc, argv, options, report_usage, 0);
 641
 642         if (report.use_stdio)
 643                 use_browser = 0;
 644         else if (report.use_tui)
 645                 use_browser = 1;
 646         else if (report.use_gtk)
 647                 use_browser = 2;
 648
 649         if (report.inverted_callchain)
 650                 callchain_param.order = ORDER_CALLER;
 651
 652         if (!report.input_name || !strlen(report.input_name)) {
 653                 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
 654                         report.input_name = "-";
 655                 else
 656                         report.input_name = "perf.data";
 657         }
 658         session = perf_session__new(report.input_name, O_RDONLY,
 659                                     report.force, false, &report.tool);
 660         if (session == NULL)
 661                 return -ENOMEM;
 662
 663         report.session = session;
 664
 665         has_br_stack = perf_header__has_feat(&session->header,
 666                                              HEADER_BRANCH_STACK);
 667
 668         if (sort__branch_mode == -1 && has_br_stack)
 669                 sort__branch_mode = 1;
 670
 671         /* sort__branch_mode could be 0 if --no-branch-stack */
 672         if (sort__branch_mode == 1) {
 673                 /*
 674                  * if no sort_order is provided, then specify
 675                  * branch-mode specific order
 676                  */
 677                 if (sort_order == default_sort_order)
 678                         sort_order = "comm,dso_from,symbol_from,"
 679                                      "dso_to,symbol_to";
 680
 681         }
 682
 683         if (strcmp(report.input_name, "-") != 0) {
 684                 if (report.use_gtk)
 685                         perf_gtk_setup_browser(argc, argv, true);
 686                 else
 687                         setup_browser(true);
 688         } else {
 689                 use_browser = 0;
 690         }
 691
 692         /*
 693          * Only in the newt browser we are doing integrated annotation,
 694          * so don't allocate extra space that won't be used in the stdio
 695          * implementation.
 696          */
 697         if (use_browser > 0) {
 698                 symbol_conf.priv_size = sizeof(struct annotation);
 699                 report.annotate_init  = symbol__annotate_init;
 700                 /*
 701                  * For searching by name on the "Browse map details".
 702                  * providing it only in verbose mode not to bloat too
 703                  * much struct symbol.
 704                  */
 705                 if (verbose) {
 706                         /*
 707                          * XXX: Need to provide a less kludgy way to ask for
 708                          * more space per symbol, the u32 is for the index on
 709                          * the ui browser.
 710                          * See symbol__browser_index.
 711                          */
 712                         symbol_conf.priv_size += sizeof(u32);
 713                         symbol_conf.sort_by_name = true;
 714                 }
 715         }
 716
 717         if (symbol__init() < 0)
 718                 goto error;
 719
 720         setup_sorting(report_usage, options);
 721
 722         if (parent_pattern != default_parent_pattern) {
 723                 if (sort_dimension__add("parent") < 0)
 724                         goto error;
 725
 726                 /*
 727                  * Only show the parent fields if we explicitly
 728                  * sort that way. If we only use parent machinery
 729                  * for filtering, we don't want it.
 730                  */
 731                 if (!strstr(sort_order, "parent"))
 732                         sort_parent.elide = 1;
 733         } else
 734                 symbol_conf.exclude_other = false;
 735
 736         if (argc) {
 737                 /*
 738                  * Special case: if there's an argument left then assume that
 739                  * it's a symbol filter:
 740                  */
 741                 if (argc > 1)
 742                         usage_with_options(report_usage, options);
 743
 744                 report.symbol_filter_str = argv[0];
 745         }
 746
 747         sort_entry__setup_elide(&sort_comm, symbol_conf.comm_list, "comm", stdout);
 748
 749         if (sort__branch_mode == 1) {
 750                 sort_entry__setup_elide(&sort_dso_from, symbol_conf.dso_from_list, "dso_from", stdout);
 751                 sort_entry__setup_elide(&sort_dso_to, symbol_conf.dso_to_list, "dso_to", stdout);
 752                 sort_entry__setup_elide(&sort_sym_from, symbol_conf.sym_from_list, "sym_from", stdout);
 753                 sort_entry__setup_elide(&sort_sym_to, symbol_conf.sym_to_list, "sym_to", stdout);
 754         } else {
 755                 sort_entry__setup_elide(&sort_dso, symbol_conf.dso_list, "dso", stdout);
 756                 sort_entry__setup_elide(&sort_sym, symbol_conf.sym_list, "symbol", stdout);
 757         }
 758
 759         ret = __cmd_report(&report);
 760 error:
 761         perf_session__delete(session);
 762         return ret;
 763 }