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