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