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                                        &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 (he->ms.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__error("Selected --sort parent, but no "
 255                                     "callchain data. Did you call "
 256                                     "'perf record' without -g?\n");
 257                         return -EINVAL;
 258                 }
 259                 if (symbol_conf.use_callchain) {
 260                         ui__error("Selected -g 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__error("Can't register callchain params.\n");
 270                                 return -EINVAL;
 271                         }
 272         }
 273
 274         if (sort__branch_mode == 1) {
 275                 if (!(self->sample_type & PERF_SAMPLE_BRANCH_STACK)) {
 276                         ui__error("Selected -b but no branch data. "
 277                                   "Did you call perf record without -b?\n");
 278                         return -1;
 279                 }
 280         }
 281
 282         return 0;
 283 }
 284
 285 extern volatile int session_done;
 286
 287 static void sig_handler(int sig __used)
 288 {
 289         session_done = 1;
 290 }
 291
 292 static size_t hists__fprintf_nr_sample_events(struct hists *self,
 293                                               const char *evname, FILE *fp)
 294 {
 295         size_t ret;
 296         char unit;
 297         unsigned long nr_samples = self->stats.nr_events[PERF_RECORD_SAMPLE];
 298         u64 nr_events = self->stats.total_period;
 299
 300         nr_samples = convert_unit(nr_samples, &unit);
 301         ret = fprintf(fp, "# Samples: %lu%c", nr_samples, unit);
 302         if (evname != NULL)
 303                 ret += fprintf(fp, " of event '%s'", evname);
 304
 305         ret += fprintf(fp, "\n# Event count (approx.): %" PRIu64, nr_events);
 306         return ret + fprintf(fp, "\n#\n");
 307 }
 308
 309 static int perf_evlist__tty_browse_hists(struct perf_evlist *evlist,
 310                                          struct perf_report *rep,
 311                                          const char *help)
 312 {
 313         struct perf_evsel *pos;
 314
 315         list_for_each_entry(pos, &evlist->entries, node) {
 316                 struct hists *hists = &pos->hists;
 317                 const char *evname = event_name(pos);
 318
 319                 hists__fprintf_nr_sample_events(hists, evname, stdout);
 320                 hists__fprintf(hists, NULL, false, true, 0, 0, stdout);
 321                 fprintf(stdout, "\n\n");
 322         }
 323
 324         if (sort_order == default_sort_order &&
 325             parent_pattern == default_parent_pattern) {
 326                 fprintf(stdout, "#\n# (%s)\n#\n", help);
 327
 328                 if (rep->show_threads) {
 329                         bool style = !strcmp(rep->pretty_printing_style, "raw");
 330                         perf_read_values_display(stdout, &rep->show_threads_values,
 331                                                  style);
 332                         perf_read_values_destroy(&rep->show_threads_values);
 333                 }
 334         }
 335
 336         return 0;
 337 }
 338
 339 static int __cmd_report(struct perf_report *rep)
 340 {
 341         int ret = -EINVAL;
 342         u64 nr_samples;
 343         struct perf_session *session = rep->session;
 344         struct perf_evsel *pos;
 345         struct map *kernel_map;
 346         struct kmap *kernel_kmap;
 347         const char *help = "For a higher level overview, try: perf report --sort comm,dso";
 348
 349         signal(SIGINT, sig_handler);
 350
 351         if (rep->cpu_list) {
 352                 ret = perf_session__cpu_bitmap(session, rep->cpu_list,
 353                                                rep->cpu_bitmap);
 354                 if (ret)
 355                         goto out_delete;
 356         }
 357
 358         if (use_browser <= 0)
 359                 perf_session__fprintf_info(session, stdout, rep->show_full_info);
 360
 361         if (rep->show_threads)
 362                 perf_read_values_init(&rep->show_threads_values);
 363
 364         ret = perf_report__setup_sample_type(rep);
 365         if (ret)
 366                 goto out_delete;
 367
 368         ret = perf_session__process_events(session, &rep->tool);
 369         if (ret)
 370                 goto out_delete;
 371
 372         kernel_map = session->host_machine.vmlinux_maps[MAP__FUNCTION];
 373         kernel_kmap = map__kmap(kernel_map);
 374         if (kernel_map == NULL ||
 375             (kernel_map->dso->hit &&
 376              (kernel_kmap->ref_reloc_sym == NULL ||
 377               kernel_kmap->ref_reloc_sym->addr == 0))) {
 378                 const char *desc =
 379                     "As no suitable kallsyms nor vmlinux was found, kernel samples\n"
 380                     "can't be resolved.";
 381
 382                 if (kernel_map) {
 383                         const struct dso *kdso = kernel_map->dso;
 384                         if (!RB_EMPTY_ROOT(&kdso->symbols[MAP__FUNCTION])) {
 385                                 desc = "If some relocation was applied (e.g. "
 386                                        "kexec) symbols may be misresolved.";
 387                         }
 388                 }
 389
 390                 ui__warning(
 391 "Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n"
 392 "Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n"
 393 "Samples in kernel modules can't be resolved as well.\n\n",
 394                 desc);
 395         }
 396
 397         if (dump_trace) {
 398                 perf_session__fprintf_nr_events(session, stdout);
 399                 goto out_delete;
 400         }
 401
 402         if (verbose > 3)
 403                 perf_session__fprintf(session, stdout);
 404
 405         if (verbose > 2)
 406                 perf_session__fprintf_dsos(session, stdout);
 407
 408         nr_samples = 0;
 409         list_for_each_entry(pos, &session->evlist->entries, node) {
 410                 struct hists *hists = &pos->hists;
 411
 412                 if (pos->idx == 0)
 413                         hists->symbol_filter_str = rep->symbol_filter_str;
 414
 415                 hists__collapse_resort(hists);
 416                 hists__output_resort(hists);
 417                 nr_samples += hists->stats.nr_events[PERF_RECORD_SAMPLE];
 418         }
 419
 420         if (nr_samples == 0) {
 421                 ui__error("The %s file has no samples!\n", session->filename);
 422                 goto out_delete;
 423         }
 424
 425         if (use_browser > 0) {
 426                 if (use_browser == 1) {
 427                         perf_evlist__tui_browse_hists(session->evlist, help,
 428                                                       NULL, NULL, 0);
 429                 } else if (use_browser == 2) {
 430                         perf_evlist__gtk_browse_hists(session->evlist, help,
 431                                                       NULL, NULL, 0);
 432                 }
 433         } else
 434                 perf_evlist__tty_browse_hists(session->evlist, rep, help);
 435
 436 out_delete:
 437         /*
 438          * Speed up the exit process, for large files this can
 439          * take quite a while.
 440          *
 441          * XXX Enable this when using valgrind or if we ever
 442          * librarize this command.
 443          *
 444          * Also experiment with obstacks to see how much speed
 445          * up we'll get here.
 446          *
 447          * perf_session__delete(session);
 448          */
 449         return ret;
 450 }
 451
 452 static int
 453 parse_callchain_opt(const struct option *opt, const char *arg, int unset)
 454 {
 455         struct perf_report *rep = (struct perf_report *)opt->value;
 456         char *tok, *tok2;
 457         char *endptr;
 458
 459         /*
 460          * --no-call-graph
 461          */
 462         if (unset) {
 463                 rep->dont_use_callchains = true;
 464                 return 0;
 465         }
 466
 467         symbol_conf.use_callchain = true;
 468
 469         if (!arg)
 470                 return 0;
 471
 472         tok = strtok((char *)arg, ",");
 473         if (!tok)
 474                 return -1;
 475
 476         /* get the output mode */
 477         if (!strncmp(tok, "graph", strlen(arg)))
 478                 callchain_param.mode = CHAIN_GRAPH_ABS;
 479
 480         else if (!strncmp(tok, "flat", strlen(arg)))
 481                 callchain_param.mode = CHAIN_FLAT;
 482
 483         else if (!strncmp(tok, "fractal", strlen(arg)))
 484                 callchain_param.mode = CHAIN_GRAPH_REL;
 485
 486         else if (!strncmp(tok, "none", strlen(arg))) {
 487                 callchain_param.mode = CHAIN_NONE;
 488                 symbol_conf.use_callchain = false;
 489
 490                 return 0;
 491         }
 492
 493         else
 494                 return -1;
 495
 496         /* get the min percentage */
 497         tok = strtok(NULL, ",");
 498         if (!tok)
 499                 goto setup;
 500
 501         callchain_param.min_percent = strtod(tok, &endptr);
 502         if (tok == endptr)
 503                 return -1;
 504
 505         /* get the print limit */
 506         tok2 = strtok(NULL, ",");
 507         if (!tok2)
 508                 goto setup;
 509
 510         if (tok2[0] != 'c') {
 511                 callchain_param.print_limit = strtoul(tok2, &endptr, 0);
 512                 tok2 = strtok(NULL, ",");
 513                 if (!tok2)
 514                         goto setup;
 515         }
 516
 517         /* get the call chain order */
 518         if (!strcmp(tok2, "caller"))
 519                 callchain_param.order = ORDER_CALLER;
 520         else if (!strcmp(tok2, "callee"))
 521                 callchain_param.order = ORDER_CALLEE;
 522         else
 523                 return -1;
 524 setup:
 525         if (callchain_register_param(&callchain_param) < 0) {
 526                 fprintf(stderr, "Can't register callchain params\n");
 527                 return -1;
 528         }
 529         return 0;
 530 }
 531
 532 static int
 533 parse_branch_mode(const struct option *opt __used, const char *str __used, int unset)
 534 {
 535         sort__branch_mode = !unset;
 536         return 0;
 537 }
 538
 539 int cmd_report(int argc, const char **argv, const char *prefix __used)
 540 {
 541         struct perf_session *session;
 542         struct stat st;
 543         bool has_br_stack = false;
 544         int ret = -1;
 545         char callchain_default_opt[] = "fractal,0.5,callee";
 546         const char * const report_usage[] = {
 547                 "perf report [<options>]",
 548                 NULL
 549         };
 550         struct perf_report report = {
 551                 .tool = {
 552                         .sample          = process_sample_event,
 553                         .mmap            = perf_event__process_mmap,
 554                         .comm            = perf_event__process_comm,
 555                         .exit            = perf_event__process_task,
 556                         .fork            = perf_event__process_task,
 557                         .lost            = perf_event__process_lost,
 558                         .read            = process_read_event,
 559                         .attr            = perf_event__process_attr,
 560                         .event_type      = perf_event__process_event_type,
 561                         .tracing_data    = perf_event__process_tracing_data,
 562                         .build_id        = perf_event__process_build_id,
 563                         .ordered_samples = true,
 564                         .ordering_requires_timestamps = true,
 565                 },
 566                 .pretty_printing_style   = "normal",
 567         };
 568         const struct option options[] = {
 569         OPT_STRING('i', "input", &report.input_name, "file",
 570                     "input file name"),
 571         OPT_INCR('v', "verbose", &verbose,
 572                     "be more verbose (show symbol address, etc)"),
 573         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
 574                     "dump raw trace in ASCII"),
 575         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
 576                    "file", "vmlinux pathname"),
 577         OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
 578                    "file", "kallsyms pathname"),
 579         OPT_BOOLEAN('f', "force", &report.force, "don't complain, do it"),
 580         OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
 581                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
 582         OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
 583                     "Show a column with the number of samples"),
 584         OPT_BOOLEAN('T', "threads", &report.show_threads,
 585                     "Show per-thread event counters"),
 586         OPT_STRING(0, "pretty", &report.pretty_printing_style, "key",
 587                    "pretty printing style key: normal raw"),
 588         OPT_BOOLEAN(0, "tui", &report.use_tui, "Use the TUI interface"),
 589         OPT_BOOLEAN(0, "gtk", &report.use_gtk, "Use the GTK2 interface"),
 590         OPT_BOOLEAN(0, "stdio", &report.use_stdio,
 591                     "Use the stdio interface"),
 592         OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
 593                    "sort by key(s): pid, comm, dso, symbol, parent, dso_to,"
 594                    " dso_from, symbol_to, symbol_from, mispredict"),
 595         OPT_BOOLEAN(0, "showcpuutilization", &symbol_conf.show_cpu_utilization,
 596                     "Show sample percentage for different cpu modes"),
 597         OPT_STRING('p', "parent", &parent_pattern, "regex",
 598                    "regex filter to identify parent, see: '--sort parent'"),
 599         OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other,
 600                     "Only display entries with parent-match"),
 601         OPT_CALLBACK_DEFAULT('g', "call-graph", &report, "output_type,min_percent[,print_limit],call_order",
 602                      "Display callchains using output_type (graph, flat, fractal, or none) , min percent threshold, optional print limit and callchain order. "
 603                      "Default: fractal,0.5,callee", &parse_callchain_opt, callchain_default_opt),
 604         OPT_BOOLEAN('G', "inverted", &report.inverted_callchain,
 605                     "alias for inverted call graph"),
 606         OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
 607                    "only consider symbols in these dsos"),
 608         OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
 609                    "only consider symbols in these comms"),
 610         OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
 611                    "only consider these symbols"),
 612         OPT_STRING(0, "symbol-filter", &report.symbol_filter_str, "filter",
 613                    "only show symbols that (partially) match with this filter"),
 614         OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
 615                    "width[,width...]",
 616                    "don't try to adjust column width, use these fixed values"),
 617         OPT_STRING('t', "field-separator", &symbol_conf.field_sep, "separator",
 618                    "separator for columns, no spaces will be added between "
 619                    "columns '.' is reserved."),
 620         OPT_BOOLEAN('U', "hide-unresolved", &report.hide_unresolved,
 621                     "Only display entries resolved to a symbol"),
 622         OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
 623                     "Look for files with symbols relative to this directory"),
 624         OPT_STRING('C', "cpu", &report.cpu_list, "cpu",
 625                    "list of cpus to profile"),
 626         OPT_BOOLEAN('I', "show-info", &report.show_full_info,
 627                     "Display extended information about perf.data file"),
 628         OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
 629                     "Interleave source code with assembly code (default)"),
 630         OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
 631                     "Display raw encoding of assembly instructions (default)"),
 632         OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
 633                    "Specify disassembler style (e.g. -M intel for intel syntax)"),
 634         OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
 635                     "Show a column with the sum of periods"),
 636         OPT_CALLBACK_NOOPT('b', "branch-stack", &sort__branch_mode, "",
 637                     "use branch records for histogram filling", parse_branch_mode),
 638         OPT_END()
 639         };
 640
 641         argc = parse_options(argc, argv, options, report_usage, 0);
 642
 643         if (report.use_stdio)
 644                 use_browser = 0;
 645         else if (report.use_tui)
 646                 use_browser = 1;
 647         else if (report.use_gtk)
 648                 use_browser = 2;
 649
 650         if (report.inverted_callchain)
 651                 callchain_param.order = ORDER_CALLER;
 652
 653         if (!report.input_name || !strlen(report.input_name)) {
 654                 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
 655                         report.input_name = "-";
 656                 else
 657                         report.input_name = "perf.data";
 658         }
 659         session = perf_session__new(report.input_name, O_RDONLY,
 660                                     report.force, false, &report.tool);
 661         if (session == NULL)
 662                 return -ENOMEM;
 663
 664         report.session = session;
 665
 666         has_br_stack = perf_header__has_feat(&session->header,
 667                                              HEADER_BRANCH_STACK);
 668
 669         if (sort__branch_mode == -1 && has_br_stack)
 670                 sort__branch_mode = 1;
 671
 672         /* sort__branch_mode could be 0 if --no-branch-stack */
 673         if (sort__branch_mode == 1) {
 674                 /*
 675                  * if no sort_order is provided, then specify
 676                  * branch-mode specific order
 677                  */
 678                 if (sort_order == default_sort_order)
 679                         sort_order = "comm,dso_from,symbol_from,"
 680                                      "dso_to,symbol_to";
 681
 682         }
 683
 684         if (strcmp(report.input_name, "-") != 0)
 685                 setup_browser(true);
 686         else
 687                 use_browser = 0;
 688
 689         /*
 690          * Only in the newt browser we are doing integrated annotation,
 691          * so don't allocate extra space that won't be used in the stdio
 692          * implementation.
 693          */
 694         if (use_browser > 0) {
 695                 symbol_conf.priv_size = sizeof(struct annotation);
 696                 report.annotate_init  = symbol__annotate_init;
 697                 /*
 698                  * For searching by name on the "Browse map details".
 699                  * providing it only in verbose mode not to bloat too
 700                  * much struct symbol.
 701                  */
 702                 if (verbose) {
 703                         /*
 704                          * XXX: Need to provide a less kludgy way to ask for
 705                          * more space per symbol, the u32 is for the index on
 706                          * the ui browser.
 707                          * See symbol__browser_index.
 708                          */
 709                         symbol_conf.priv_size += sizeof(u32);
 710                         symbol_conf.sort_by_name = true;
 711                 }
 712         }
 713
 714         if (symbol__init() < 0)
 715                 goto error;
 716
 717         setup_sorting(report_usage, options);
 718
 719         if (parent_pattern != default_parent_pattern) {
 720                 if (sort_dimension__add("parent") < 0)
 721                         goto error;
 722
 723                 /*
 724                  * Only show the parent fields if we explicitly
 725                  * sort that way. If we only use parent machinery
 726                  * for filtering, we don't want it.
 727                  */
 728                 if (!strstr(sort_order, "parent"))
 729                         sort_parent.elide = 1;
 730         } else
 731                 symbol_conf.exclude_other = false;
 732
 733         if (argc) {
 734                 /*
 735                  * Special case: if there's an argument left then assume that
 736                  * it's a symbol filter:
 737                  */
 738                 if (argc > 1)
 739                         usage_with_options(report_usage, options);
 740
 741                 report.symbol_filter_str = argv[0];
 742         }
 743
 744         sort_entry__setup_elide(&sort_comm, symbol_conf.comm_list, "comm", stdout);
 745
 746         if (sort__branch_mode == 1) {
 747                 sort_entry__setup_elide(&sort_dso_from, symbol_conf.dso_from_list, "dso_from", stdout);
 748                 sort_entry__setup_elide(&sort_dso_to, symbol_conf.dso_to_list, "dso_to", stdout);
 749                 sort_entry__setup_elide(&sort_sym_from, symbol_conf.sym_from_list, "sym_from", stdout);
 750                 sort_entry__setup_elide(&sort_sym_to, symbol_conf.sym_to_list, "sym_to", stdout);
 751         } else {
 752                 sort_entry__setup_elide(&sort_dso, symbol_conf.dso_list, "dso", stdout);
 753                 sort_entry__setup_elide(&sort_sym, symbol_conf.sym_list, "symbol", stdout);
 754         }
 755
 756         ret = __cmd_report(&report);
 757 error:
 758         perf_session__delete(session);
 759         return ret;
 760 }