tools/perf/builtin-report.c

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