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