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