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