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