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