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