Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * builtin-report.c
4 *
5 * Builtin report command: Analyze the perf.data input file,
6 * look up and read DSOs and symbol information and display
7 * a histogram of results, along various sorting keys.
8 */
9#include "builtin.h"
10
11#include "util/util.h"
12#include "util/config.h"
13
14#include "util/annotate.h"
15#include "util/color.h"
16#include <linux/list.h>
17#include <linux/rbtree.h>
18#include <linux/err.h>
19#include "util/symbol.h"
20#include "util/callchain.h"
21#include "util/values.h"
22
23#include "perf.h"
24#include "util/debug.h"
25#include "util/evlist.h"
26#include "util/evsel.h"
27#include "util/header.h"
28#include "util/session.h"
29#include "util/tool.h"
30
31#include <subcmd/parse-options.h>
32#include <subcmd/exec-cmd.h>
33#include "util/parse-events.h"
34
35#include "util/thread.h"
36#include "util/sort.h"
37#include "util/hist.h"
38#include "util/data.h"
39#include "arch/common.h"
40#include "util/time-utils.h"
41#include "util/auxtrace.h"
42#include "util/units.h"
43#include "util/branch.h"
44
45#include <dlfcn.h>
46#include <errno.h>
47#include <inttypes.h>
48#include <regex.h>
49#include <signal.h>
50#include <linux/bitmap.h>
51#include <linux/stringify.h>
52#include <sys/types.h>
53#include <sys/stat.h>
54#include <unistd.h>
55#include <linux/mman.h>
56
57struct report {
58 struct perf_tool tool;
59 struct perf_session *session;
60 bool use_tui, use_gtk, use_stdio;
61 bool show_full_info;
62 bool show_threads;
63 bool inverted_callchain;
64 bool mem_mode;
65 bool stats_mode;
66 bool tasks_mode;
67 bool mmaps_mode;
68 bool header;
69 bool header_only;
70 bool nonany_branch_mode;
71 bool group_set;
72 int max_stack;
73 struct perf_read_values show_threads_values;
74 const char *pretty_printing_style;
75 const char *cpu_list;
76 const char *symbol_filter_str;
77 const char *time_str;
78 struct perf_time_interval *ptime_range;
79 int range_size;
80 int range_num;
81 float min_percent;
82 u64 nr_entries;
83 u64 queue_size;
84 int socket_filter;
85 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
86 struct branch_type_stat brtype_stat;
87};
88
89static int report__config(const char *var, const char *value, void *cb)
90{
91 struct report *rep = cb;
92
93 if (!strcmp(var, "report.group")) {
94 symbol_conf.event_group = perf_config_bool(var, value);
95 return 0;
96 }
97 if (!strcmp(var, "report.percent-limit")) {
98 double pcnt = strtof(value, NULL);
99
100 rep->min_percent = pcnt;
101 callchain_param.min_percent = pcnt;
102 return 0;
103 }
104 if (!strcmp(var, "report.children")) {
105 symbol_conf.cumulate_callchain = perf_config_bool(var, value);
106 return 0;
107 }
108 if (!strcmp(var, "report.queue-size"))
109 return perf_config_u64(&rep->queue_size, var, value);
110
111 if (!strcmp(var, "report.sort_order")) {
112 default_sort_order = strdup(value);
113 return 0;
114 }
115
116 return 0;
117}
118
119static int hist_iter__report_callback(struct hist_entry_iter *iter,
120 struct addr_location *al, bool single,
121 void *arg)
122{
123 int err = 0;
124 struct report *rep = arg;
125 struct hist_entry *he = iter->he;
126 struct perf_evsel *evsel = iter->evsel;
127 struct perf_sample *sample = iter->sample;
128 struct mem_info *mi;
129 struct branch_info *bi;
130
131 if (!ui__has_annotation())
132 return 0;
133
134 hist__account_cycles(sample->branch_stack, al, sample,
135 rep->nonany_branch_mode);
136
137 if (sort__mode == SORT_MODE__BRANCH) {
138 bi = he->branch_info;
139 err = addr_map_symbol__inc_samples(&bi->from, sample, evsel->idx);
140 if (err)
141 goto out;
142
143 err = addr_map_symbol__inc_samples(&bi->to, sample, evsel->idx);
144
145 } else if (rep->mem_mode) {
146 mi = he->mem_info;
147 err = addr_map_symbol__inc_samples(&mi->daddr, sample, evsel->idx);
148 if (err)
149 goto out;
150
151 err = hist_entry__inc_addr_samples(he, sample, evsel->idx, al->addr);
152
153 } else if (symbol_conf.cumulate_callchain) {
154 if (single)
155 err = hist_entry__inc_addr_samples(he, sample, evsel->idx,
156 al->addr);
157 } else {
158 err = hist_entry__inc_addr_samples(he, sample, evsel->idx, al->addr);
159 }
160
161out:
162 return err;
163}
164
165static int hist_iter__branch_callback(struct hist_entry_iter *iter,
166 struct addr_location *al __maybe_unused,
167 bool single __maybe_unused,
168 void *arg)
169{
170 struct hist_entry *he = iter->he;
171 struct report *rep = arg;
172 struct branch_info *bi;
173 struct perf_sample *sample = iter->sample;
174 struct perf_evsel *evsel = iter->evsel;
175 int err;
176
177 if (!ui__has_annotation())
178 return 0;
179
180 hist__account_cycles(sample->branch_stack, al, sample,
181 rep->nonany_branch_mode);
182
183 bi = he->branch_info;
184 err = addr_map_symbol__inc_samples(&bi->from, sample, evsel->idx);
185 if (err)
186 goto out;
187
188 err = addr_map_symbol__inc_samples(&bi->to, sample, evsel->idx);
189
190 branch_type_count(&rep->brtype_stat, &bi->flags,
191 bi->from.addr, bi->to.addr);
192
193out:
194 return err;
195}
196
197/*
198 * Events in data file are not collect in groups, but we still want
199 * the group display. Set the artificial group and set the leader's
200 * forced_leader flag to notify the display code.
201 */
202static void setup_forced_leader(struct report *report,
203 struct perf_evlist *evlist)
204{
205 if (report->group_set && !evlist->nr_groups) {
206 struct perf_evsel *leader = perf_evlist__first(evlist);
207
208 perf_evlist__set_leader(evlist);
209 leader->forced_leader = true;
210 }
211}
212
213static int process_feature_event(struct perf_tool *tool,
214 union perf_event *event,
215 struct perf_session *session __maybe_unused)
216{
217 struct report *rep = container_of(tool, struct report, tool);
218
219 if (event->feat.feat_id < HEADER_LAST_FEATURE)
220 return perf_event__process_feature(tool, event, session);
221
222 if (event->feat.feat_id != HEADER_LAST_FEATURE) {
223 pr_err("failed: wrong feature ID: %" PRIu64 "\n",
224 event->feat.feat_id);
225 return -1;
226 }
227
228 /*
229 * All features are received, we can force the
230 * group if needed.
231 */
232 setup_forced_leader(rep, session->evlist);
233 return 0;
234}
235
236static int process_sample_event(struct perf_tool *tool,
237 union perf_event *event,
238 struct perf_sample *sample,
239 struct perf_evsel *evsel,
240 struct machine *machine)
241{
242 struct report *rep = container_of(tool, struct report, tool);
243 struct addr_location al;
244 struct hist_entry_iter iter = {
245 .evsel = evsel,
246 .sample = sample,
247 .hide_unresolved = symbol_conf.hide_unresolved,
248 .add_entry_cb = hist_iter__report_callback,
249 };
250 int ret = 0;
251
252 if (perf_time__ranges_skip_sample(rep->ptime_range, rep->range_num,
253 sample->time)) {
254 return 0;
255 }
256
257 if (machine__resolve(machine, &al, sample) < 0) {
258 pr_debug("problem processing %d event, skipping it.\n",
259 event->header.type);
260 return -1;
261 }
262
263 if (symbol_conf.hide_unresolved && al.sym == NULL)
264 goto out_put;
265
266 if (rep->cpu_list && !test_bit(sample->cpu, rep->cpu_bitmap))
267 goto out_put;
268
269 if (sort__mode == SORT_MODE__BRANCH) {
270 /*
271 * A non-synthesized event might not have a branch stack if
272 * branch stacks have been synthesized (using itrace options).
273 */
274 if (!sample->branch_stack)
275 goto out_put;
276
277 iter.add_entry_cb = hist_iter__branch_callback;
278 iter.ops = &hist_iter_branch;
279 } else if (rep->mem_mode) {
280 iter.ops = &hist_iter_mem;
281 } else if (symbol_conf.cumulate_callchain) {
282 iter.ops = &hist_iter_cumulative;
283 } else {
284 iter.ops = &hist_iter_normal;
285 }
286
287 if (al.map != NULL)
288 al.map->dso->hit = 1;
289
290 ret = hist_entry_iter__add(&iter, &al, rep->max_stack, rep);
291 if (ret < 0)
292 pr_debug("problem adding hist entry, skipping event\n");
293out_put:
294 addr_location__put(&al);
295 return ret;
296}
297
298static int process_read_event(struct perf_tool *tool,
299 union perf_event *event,
300 struct perf_sample *sample __maybe_unused,
301 struct perf_evsel *evsel,
302 struct machine *machine __maybe_unused)
303{
304 struct report *rep = container_of(tool, struct report, tool);
305
306 if (rep->show_threads) {
307 const char *name = evsel ? perf_evsel__name(evsel) : "unknown";
308 int err = perf_read_values_add_value(&rep->show_threads_values,
309 event->read.pid, event->read.tid,
310 evsel->idx,
311 name,
312 event->read.value);
313
314 if (err)
315 return err;
316 }
317
318 return 0;
319}
320
321/* For pipe mode, sample_type is not currently set */
322static int report__setup_sample_type(struct report *rep)
323{
324 struct perf_session *session = rep->session;
325 u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
326 bool is_pipe = perf_data__is_pipe(session->data);
327
328 if (session->itrace_synth_opts->callchain ||
329 (!is_pipe &&
330 perf_header__has_feat(&session->header, HEADER_AUXTRACE) &&
331 !session->itrace_synth_opts->set))
332 sample_type |= PERF_SAMPLE_CALLCHAIN;
333
334 if (session->itrace_synth_opts->last_branch)
335 sample_type |= PERF_SAMPLE_BRANCH_STACK;
336
337 if (!is_pipe && !(sample_type & PERF_SAMPLE_CALLCHAIN)) {
338 if (perf_hpp_list.parent) {
339 ui__error("Selected --sort parent, but no "
340 "callchain data. Did you call "
341 "'perf record' without -g?\n");
342 return -EINVAL;
343 }
344 if (symbol_conf.use_callchain &&
345 !symbol_conf.show_branchflag_count) {
346 ui__error("Selected -g or --branch-history.\n"
347 "But no callchain or branch data.\n"
348 "Did you call 'perf record' without -g or -b?\n");
349 return -1;
350 }
351 } else if (!callchain_param.enabled &&
352 callchain_param.mode != CHAIN_NONE &&
353 !symbol_conf.use_callchain) {
354 symbol_conf.use_callchain = true;
355 if (callchain_register_param(&callchain_param) < 0) {
356 ui__error("Can't register callchain params.\n");
357 return -EINVAL;
358 }
359 }
360
361 if (symbol_conf.cumulate_callchain) {
362 /* Silently ignore if callchain is missing */
363 if (!(sample_type & PERF_SAMPLE_CALLCHAIN)) {
364 symbol_conf.cumulate_callchain = false;
365 perf_hpp__cancel_cumulate();
366 }
367 }
368
369 if (sort__mode == SORT_MODE__BRANCH) {
370 if (!is_pipe &&
371 !(sample_type & PERF_SAMPLE_BRANCH_STACK)) {
372 ui__error("Selected -b but no branch data. "
373 "Did you call perf record without -b?\n");
374 return -1;
375 }
376 }
377
378 if (symbol_conf.use_callchain || symbol_conf.cumulate_callchain) {
379 if ((sample_type & PERF_SAMPLE_REGS_USER) &&
380 (sample_type & PERF_SAMPLE_STACK_USER)) {
381 callchain_param.record_mode = CALLCHAIN_DWARF;
382 dwarf_callchain_users = true;
383 } else if (sample_type & PERF_SAMPLE_BRANCH_STACK)
384 callchain_param.record_mode = CALLCHAIN_LBR;
385 else
386 callchain_param.record_mode = CALLCHAIN_FP;
387 }
388
389 /* ??? handle more cases than just ANY? */
390 if (!(perf_evlist__combined_branch_type(session->evlist) &
391 PERF_SAMPLE_BRANCH_ANY))
392 rep->nonany_branch_mode = true;
393
394 return 0;
395}
396
397static void sig_handler(int sig __maybe_unused)
398{
399 session_done = 1;
400}
401
402static size_t hists__fprintf_nr_sample_events(struct hists *hists, struct report *rep,
403 const char *evname, FILE *fp)
404{
405 size_t ret;
406 char unit;
407 unsigned long nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
408 u64 nr_events = hists->stats.total_period;
409 struct perf_evsel *evsel = hists_to_evsel(hists);
410 char buf[512];
411 size_t size = sizeof(buf);
412 int socked_id = hists->socket_filter;
413
414 if (quiet)
415 return 0;
416
417 if (symbol_conf.filter_relative) {
418 nr_samples = hists->stats.nr_non_filtered_samples;
419 nr_events = hists->stats.total_non_filtered_period;
420 }
421
422 if (perf_evsel__is_group_event(evsel)) {
423 struct perf_evsel *pos;
424
425 perf_evsel__group_desc(evsel, buf, size);
426 evname = buf;
427
428 for_each_group_member(pos, evsel) {
429 const struct hists *pos_hists = evsel__hists(pos);
430
431 if (symbol_conf.filter_relative) {
432 nr_samples += pos_hists->stats.nr_non_filtered_samples;
433 nr_events += pos_hists->stats.total_non_filtered_period;
434 } else {
435 nr_samples += pos_hists->stats.nr_events[PERF_RECORD_SAMPLE];
436 nr_events += pos_hists->stats.total_period;
437 }
438 }
439 }
440
441 nr_samples = convert_unit(nr_samples, &unit);
442 ret = fprintf(fp, "# Samples: %lu%c", nr_samples, unit);
443 if (evname != NULL) {
444 ret += fprintf(fp, " of event%s '%s'",
445 evsel->nr_members > 1 ? "s" : "", evname);
446 }
447
448 if (rep->time_str)
449 ret += fprintf(fp, " (time slices: %s)", rep->time_str);
450
451 if (symbol_conf.show_ref_callgraph &&
452 strstr(evname, "call-graph=no")) {
453 ret += fprintf(fp, ", show reference callgraph");
454 }
455
456 if (rep->mem_mode) {
457 ret += fprintf(fp, "\n# Total weight : %" PRIu64, nr_events);
458 ret += fprintf(fp, "\n# Sort order : %s", sort_order ? : default_mem_sort_order);
459 } else
460 ret += fprintf(fp, "\n# Event count (approx.): %" PRIu64, nr_events);
461
462 if (socked_id > -1)
463 ret += fprintf(fp, "\n# Processor Socket: %d", socked_id);
464
465 return ret + fprintf(fp, "\n#\n");
466}
467
468static int perf_evlist__tty_browse_hists(struct perf_evlist *evlist,
469 struct report *rep,
470 const char *help)
471{
472 struct perf_evsel *pos;
473
474 if (!quiet) {
475 fprintf(stdout, "#\n# Total Lost Samples: %" PRIu64 "\n#\n",
476 evlist->stats.total_lost_samples);
477 }
478
479 evlist__for_each_entry(evlist, pos) {
480 struct hists *hists = evsel__hists(pos);
481 const char *evname = perf_evsel__name(pos);
482
483 if (symbol_conf.event_group &&
484 !perf_evsel__is_group_leader(pos))
485 continue;
486
487 hists__fprintf_nr_sample_events(hists, rep, evname, stdout);
488 hists__fprintf(hists, !quiet, 0, 0, rep->min_percent, stdout,
489 symbol_conf.use_callchain ||
490 symbol_conf.show_branchflag_count);
491 fprintf(stdout, "\n\n");
492 }
493
494 if (!quiet)
495 fprintf(stdout, "#\n# (%s)\n#\n", help);
496
497 if (rep->show_threads) {
498 bool style = !strcmp(rep->pretty_printing_style, "raw");
499 perf_read_values_display(stdout, &rep->show_threads_values,
500 style);
501 perf_read_values_destroy(&rep->show_threads_values);
502 }
503
504 if (sort__mode == SORT_MODE__BRANCH)
505 branch_type_stat_display(stdout, &rep->brtype_stat);
506
507 return 0;
508}
509
510static void report__warn_kptr_restrict(const struct report *rep)
511{
512 struct map *kernel_map = machine__kernel_map(&rep->session->machines.host);
513 struct kmap *kernel_kmap = kernel_map ? map__kmap(kernel_map) : NULL;
514
515 if (perf_evlist__exclude_kernel(rep->session->evlist))
516 return;
517
518 if (kernel_map == NULL ||
519 (kernel_map->dso->hit &&
520 (kernel_kmap->ref_reloc_sym == NULL ||
521 kernel_kmap->ref_reloc_sym->addr == 0))) {
522 const char *desc =
523 "As no suitable kallsyms nor vmlinux was found, kernel samples\n"
524 "can't be resolved.";
525
526 if (kernel_map) {
527 const struct dso *kdso = kernel_map->dso;
528 if (!RB_EMPTY_ROOT(&kdso->symbols[MAP__FUNCTION])) {
529 desc = "If some relocation was applied (e.g. "
530 "kexec) symbols may be misresolved.";
531 }
532 }
533
534 ui__warning(
535"Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n"
536"Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n"
537"Samples in kernel modules can't be resolved as well.\n\n",
538 desc);
539 }
540}
541
542static int report__gtk_browse_hists(struct report *rep, const char *help)
543{
544 int (*hist_browser)(struct perf_evlist *evlist, const char *help,
545 struct hist_browser_timer *timer, float min_pcnt);
546
547 hist_browser = dlsym(perf_gtk_handle, "perf_evlist__gtk_browse_hists");
548
549 if (hist_browser == NULL) {
550 ui__error("GTK browser not found!\n");
551 return -1;
552 }
553
554 return hist_browser(rep->session->evlist, help, NULL, rep->min_percent);
555}
556
557static int report__browse_hists(struct report *rep)
558{
559 int ret;
560 struct perf_session *session = rep->session;
561 struct perf_evlist *evlist = session->evlist;
562 const char *help = perf_tip(system_path(TIPDIR));
563
564 if (help == NULL) {
565 /* fallback for people who don't install perf ;-) */
566 help = perf_tip(DOCDIR);
567 if (help == NULL)
568 help = "Cannot load tips.txt file, please install perf!";
569 }
570
571 switch (use_browser) {
572 case 1:
573 ret = perf_evlist__tui_browse_hists(evlist, help, NULL,
574 rep->min_percent,
575 &session->header.env,
576 true);
577 /*
578 * Usually "ret" is the last pressed key, and we only
579 * care if the key notifies us to switch data file.
580 */
581 if (ret != K_SWITCH_INPUT_DATA)
582 ret = 0;
583 break;
584 case 2:
585 ret = report__gtk_browse_hists(rep, help);
586 break;
587 default:
588 ret = perf_evlist__tty_browse_hists(evlist, rep, help);
589 break;
590 }
591
592 return ret;
593}
594
595static int report__collapse_hists(struct report *rep)
596{
597 struct ui_progress prog;
598 struct perf_evsel *pos;
599 int ret = 0;
600
601 ui_progress__init(&prog, rep->nr_entries, "Merging related events...");
602
603 evlist__for_each_entry(rep->session->evlist, pos) {
604 struct hists *hists = evsel__hists(pos);
605
606 if (pos->idx == 0)
607 hists->symbol_filter_str = rep->symbol_filter_str;
608
609 hists->socket_filter = rep->socket_filter;
610
611 ret = hists__collapse_resort(hists, &prog);
612 if (ret < 0)
613 break;
614
615 /* Non-group events are considered as leader */
616 if (symbol_conf.event_group &&
617 !perf_evsel__is_group_leader(pos)) {
618 struct hists *leader_hists = evsel__hists(pos->leader);
619
620 hists__match(leader_hists, hists);
621 hists__link(leader_hists, hists);
622 }
623 }
624
625 ui_progress__finish();
626 return ret;
627}
628
629static void report__output_resort(struct report *rep)
630{
631 struct ui_progress prog;
632 struct perf_evsel *pos;
633
634 ui_progress__init(&prog, rep->nr_entries, "Sorting events for output...");
635
636 evlist__for_each_entry(rep->session->evlist, pos)
637 perf_evsel__output_resort(pos, &prog);
638
639 ui_progress__finish();
640}
641
642static void stats_setup(struct report *rep)
643{
644 memset(&rep->tool, 0, sizeof(rep->tool));
645 rep->tool.no_warn = true;
646}
647
648static int stats_print(struct report *rep)
649{
650 struct perf_session *session = rep->session;
651
652 perf_session__fprintf_nr_events(session, stdout);
653 return 0;
654}
655
656static void tasks_setup(struct report *rep)
657{
658 memset(&rep->tool, 0, sizeof(rep->tool));
659 rep->tool.ordered_events = true;
660 if (rep->mmaps_mode) {
661 rep->tool.mmap = perf_event__process_mmap;
662 rep->tool.mmap2 = perf_event__process_mmap2;
663 }
664 rep->tool.comm = perf_event__process_comm;
665 rep->tool.exit = perf_event__process_exit;
666 rep->tool.fork = perf_event__process_fork;
667 rep->tool.no_warn = true;
668}
669
670struct task {
671 struct thread *thread;
672 struct list_head list;
673 struct list_head children;
674};
675
676static struct task *tasks_list(struct task *task, struct machine *machine)
677{
678 struct thread *parent_thread, *thread = task->thread;
679 struct task *parent_task;
680
681 /* Already listed. */
682 if (!list_empty(&task->list))
683 return NULL;
684
685 /* Last one in the chain. */
686 if (thread->ppid == -1)
687 return task;
688
689 parent_thread = machine__find_thread(machine, -1, thread->ppid);
690 if (!parent_thread)
691 return ERR_PTR(-ENOENT);
692
693 parent_task = thread__priv(parent_thread);
694 list_add_tail(&task->list, &parent_task->children);
695 return tasks_list(parent_task, machine);
696}
697
698static size_t maps__fprintf_task(struct maps *maps, int indent, FILE *fp)
699{
700 size_t printed = 0;
701 struct rb_node *nd;
702
703 for (nd = rb_first(&maps->entries); nd; nd = rb_next(nd)) {
704 struct map *map = rb_entry(nd, struct map, rb_node);
705
706 printed += fprintf(fp, "%*s %" PRIx64 "-%" PRIx64 " %c%c%c%c %08" PRIx64 " %" PRIu64 " %s\n",
707 indent, "", map->start, map->end,
708 map->prot & PROT_READ ? 'r' : '-',
709 map->prot & PROT_WRITE ? 'w' : '-',
710 map->prot & PROT_EXEC ? 'x' : '-',
711 map->flags & MAP_SHARED ? 's' : 'p',
712 map->pgoff,
713 map->ino, map->dso->name);
714 }
715
716 return printed;
717}
718
719static int map_groups__fprintf_task(struct map_groups *mg, int indent, FILE *fp)
720{
721 int printed = 0, i;
722 for (i = 0; i < MAP__NR_TYPES; ++i)
723 printed += maps__fprintf_task(&mg->maps[i], indent, fp);
724 return printed;
725}
726
727static void task__print_level(struct task *task, FILE *fp, int level)
728{
729 struct thread *thread = task->thread;
730 struct task *child;
731 int comm_indent = fprintf(fp, " %8d %8d %8d |%*s",
732 thread->pid_, thread->tid, thread->ppid,
733 level, "");
734
735 fprintf(fp, "%s\n", thread__comm_str(thread));
736
737 map_groups__fprintf_task(thread->mg, comm_indent, fp);
738
739 if (!list_empty(&task->children)) {
740 list_for_each_entry(child, &task->children, list)
741 task__print_level(child, fp, level + 1);
742 }
743}
744
745static int tasks_print(struct report *rep, FILE *fp)
746{
747 struct perf_session *session = rep->session;
748 struct machine *machine = &session->machines.host;
749 struct task *tasks, *task;
750 unsigned int nr = 0, itask = 0, i;
751 struct rb_node *nd;
752 LIST_HEAD(list);
753
754 /*
755 * No locking needed while accessing machine->threads,
756 * because --tasks is single threaded command.
757 */
758
759 /* Count all the threads. */
760 for (i = 0; i < THREADS__TABLE_SIZE; i++)
761 nr += machine->threads[i].nr;
762
763 tasks = malloc(sizeof(*tasks) * nr);
764 if (!tasks)
765 return -ENOMEM;
766
767 for (i = 0; i < THREADS__TABLE_SIZE; i++) {
768 struct threads *threads = &machine->threads[i];
769
770 for (nd = rb_first(&threads->entries); nd; nd = rb_next(nd)) {
771 task = tasks + itask++;
772
773 task->thread = rb_entry(nd, struct thread, rb_node);
774 INIT_LIST_HEAD(&task->children);
775 INIT_LIST_HEAD(&task->list);
776 thread__set_priv(task->thread, task);
777 }
778 }
779
780 /*
781 * Iterate every task down to the unprocessed parent
782 * and link all in task children list. Task with no
783 * parent is added into 'list'.
784 */
785 for (itask = 0; itask < nr; itask++) {
786 task = tasks + itask;
787
788 if (!list_empty(&task->list))
789 continue;
790
791 task = tasks_list(task, machine);
792 if (IS_ERR(task)) {
793 pr_err("Error: failed to process tasks\n");
794 free(tasks);
795 return PTR_ERR(task);
796 }
797
798 if (task)
799 list_add_tail(&task->list, &list);
800 }
801
802 fprintf(fp, "# %8s %8s %8s %s\n", "pid", "tid", "ppid", "comm");
803
804 list_for_each_entry(task, &list, list)
805 task__print_level(task, fp, 0);
806
807 free(tasks);
808 return 0;
809}
810
811static int __cmd_report(struct report *rep)
812{
813 int ret;
814 struct perf_session *session = rep->session;
815 struct perf_evsel *pos;
816 struct perf_data *data = session->data;
817
818 signal(SIGINT, sig_handler);
819
820 if (rep->cpu_list) {
821 ret = perf_session__cpu_bitmap(session, rep->cpu_list,
822 rep->cpu_bitmap);
823 if (ret) {
824 ui__error("failed to set cpu bitmap\n");
825 return ret;
826 }
827 session->itrace_synth_opts->cpu_bitmap = rep->cpu_bitmap;
828 }
829
830 if (rep->show_threads) {
831 ret = perf_read_values_init(&rep->show_threads_values);
832 if (ret)
833 return ret;
834 }
835
836 ret = report__setup_sample_type(rep);
837 if (ret) {
838 /* report__setup_sample_type() already showed error message */
839 return ret;
840 }
841
842 if (rep->stats_mode)
843 stats_setup(rep);
844
845 if (rep->tasks_mode)
846 tasks_setup(rep);
847
848 ret = perf_session__process_events(session);
849 if (ret) {
850 ui__error("failed to process sample\n");
851 return ret;
852 }
853
854 if (rep->stats_mode)
855 return stats_print(rep);
856
857 if (rep->tasks_mode)
858 return tasks_print(rep, stdout);
859
860 report__warn_kptr_restrict(rep);
861
862 evlist__for_each_entry(session->evlist, pos)
863 rep->nr_entries += evsel__hists(pos)->nr_entries;
864
865 if (use_browser == 0) {
866 if (verbose > 3)
867 perf_session__fprintf(session, stdout);
868
869 if (verbose > 2)
870 perf_session__fprintf_dsos(session, stdout);
871
872 if (dump_trace) {
873 perf_session__fprintf_nr_events(session, stdout);
874 perf_evlist__fprintf_nr_events(session->evlist, stdout);
875 return 0;
876 }
877 }
878
879 ret = report__collapse_hists(rep);
880 if (ret) {
881 ui__error("failed to process hist entry\n");
882 return ret;
883 }
884
885 if (session_done())
886 return 0;
887
888 /*
889 * recalculate number of entries after collapsing since it
890 * might be changed during the collapse phase.
891 */
892 rep->nr_entries = 0;
893 evlist__for_each_entry(session->evlist, pos)
894 rep->nr_entries += evsel__hists(pos)->nr_entries;
895
896 if (rep->nr_entries == 0) {
897 ui__error("The %s file has no samples!\n", data->file.path);
898 return 0;
899 }
900
901 report__output_resort(rep);
902
903 return report__browse_hists(rep);
904}
905
906static int
907report_parse_callchain_opt(const struct option *opt, const char *arg, int unset)
908{
909 struct callchain_param *callchain = opt->value;
910
911 callchain->enabled = !unset;
912 /*
913 * --no-call-graph
914 */
915 if (unset) {
916 symbol_conf.use_callchain = false;
917 callchain->mode = CHAIN_NONE;
918 return 0;
919 }
920
921 return parse_callchain_report_opt(arg);
922}
923
924int
925report_parse_ignore_callees_opt(const struct option *opt __maybe_unused,
926 const char *arg, int unset __maybe_unused)
927{
928 if (arg) {
929 int err = regcomp(&ignore_callees_regex, arg, REG_EXTENDED);
930 if (err) {
931 char buf[BUFSIZ];
932 regerror(err, &ignore_callees_regex, buf, sizeof(buf));
933 pr_err("Invalid --ignore-callees regex: %s\n%s", arg, buf);
934 return -1;
935 }
936 have_ignore_callees = 1;
937 }
938
939 return 0;
940}
941
942static int
943parse_branch_mode(const struct option *opt,
944 const char *str __maybe_unused, int unset)
945{
946 int *branch_mode = opt->value;
947
948 *branch_mode = !unset;
949 return 0;
950}
951
952static int
953parse_percent_limit(const struct option *opt, const char *str,
954 int unset __maybe_unused)
955{
956 struct report *rep = opt->value;
957 double pcnt = strtof(str, NULL);
958
959 rep->min_percent = pcnt;
960 callchain_param.min_percent = pcnt;
961 return 0;
962}
963
964#define CALLCHAIN_DEFAULT_OPT "graph,0.5,caller,function,percent"
965
966const char report_callchain_help[] = "Display call graph (stack chain/backtrace):\n\n"
967 CALLCHAIN_REPORT_HELP
968 "\n\t\t\t\tDefault: " CALLCHAIN_DEFAULT_OPT;
969
970int cmd_report(int argc, const char **argv)
971{
972 struct perf_session *session;
973 struct itrace_synth_opts itrace_synth_opts = { .set = 0, };
974 struct stat st;
975 bool has_br_stack = false;
976 int branch_mode = -1;
977 bool branch_call_mode = false;
978 char callchain_default_opt[] = CALLCHAIN_DEFAULT_OPT;
979 const char * const report_usage[] = {
980 "perf report [<options>]",
981 NULL
982 };
983 struct report report = {
984 .tool = {
985 .sample = process_sample_event,
986 .mmap = perf_event__process_mmap,
987 .mmap2 = perf_event__process_mmap2,
988 .comm = perf_event__process_comm,
989 .namespaces = perf_event__process_namespaces,
990 .exit = perf_event__process_exit,
991 .fork = perf_event__process_fork,
992 .lost = perf_event__process_lost,
993 .read = process_read_event,
994 .attr = perf_event__process_attr,
995 .tracing_data = perf_event__process_tracing_data,
996 .build_id = perf_event__process_build_id,
997 .id_index = perf_event__process_id_index,
998 .auxtrace_info = perf_event__process_auxtrace_info,
999 .auxtrace = perf_event__process_auxtrace,
1000 .feature = process_feature_event,
1001 .ordered_events = true,
1002 .ordering_requires_timestamps = true,
1003 },
1004 .max_stack = PERF_MAX_STACK_DEPTH,
1005 .pretty_printing_style = "normal",
1006 .socket_filter = -1,
1007 };
1008 const struct option options[] = {
1009 OPT_STRING('i', "input", &input_name, "file",
1010 "input file name"),
1011 OPT_INCR('v', "verbose", &verbose,
1012 "be more verbose (show symbol address, etc)"),
1013 OPT_BOOLEAN('q', "quiet", &quiet, "Do not show any message"),
1014 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1015 "dump raw trace in ASCII"),
1016 OPT_BOOLEAN(0, "stats", &report.stats_mode, "Display event stats"),
1017 OPT_BOOLEAN(0, "tasks", &report.tasks_mode, "Display recorded tasks"),
1018 OPT_BOOLEAN(0, "mmaps", &report.mmaps_mode, "Display recorded tasks memory maps"),
1019 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1020 "file", "vmlinux pathname"),
1021 OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux,
1022 "don't load vmlinux even if found"),
1023 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1024 "file", "kallsyms pathname"),
1025 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
1026 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
1027 "load module symbols - WARNING: use only with -k and LIVE kernel"),
1028 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
1029 "Show a column with the number of samples"),
1030 OPT_BOOLEAN('T', "threads", &report.show_threads,
1031 "Show per-thread event counters"),
1032 OPT_STRING(0, "pretty", &report.pretty_printing_style, "key",
1033 "pretty printing style key: normal raw"),
1034 OPT_BOOLEAN(0, "tui", &report.use_tui, "Use the TUI interface"),
1035 OPT_BOOLEAN(0, "gtk", &report.use_gtk, "Use the GTK2 interface"),
1036 OPT_BOOLEAN(0, "stdio", &report.use_stdio,
1037 "Use the stdio interface"),
1038 OPT_BOOLEAN(0, "header", &report.header, "Show data header."),
1039 OPT_BOOLEAN(0, "header-only", &report.header_only,
1040 "Show only data header."),
1041 OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
1042 "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
1043 " Please refer the man page for the complete list."),
1044 OPT_STRING('F', "fields", &field_order, "key[,keys...]",
1045 "output field(s): overhead, period, sample plus all of sort keys"),
1046 OPT_BOOLEAN(0, "show-cpu-utilization", &symbol_conf.show_cpu_utilization,
1047 "Show sample percentage for different cpu modes"),
1048 OPT_BOOLEAN_FLAG(0, "showcpuutilization", &symbol_conf.show_cpu_utilization,
1049 "Show sample percentage for different cpu modes", PARSE_OPT_HIDDEN),
1050 OPT_STRING('p', "parent", &parent_pattern, "regex",
1051 "regex filter to identify parent, see: '--sort parent'"),
1052 OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other,
1053 "Only display entries with parent-match"),
1054 OPT_CALLBACK_DEFAULT('g', "call-graph", &callchain_param,
1055 "print_type,threshold[,print_limit],order,sort_key[,branch],value",
1056 report_callchain_help, &report_parse_callchain_opt,
1057 callchain_default_opt),
1058 OPT_BOOLEAN(0, "children", &symbol_conf.cumulate_callchain,
1059 "Accumulate callchains of children and show total overhead as well"),
1060 OPT_INTEGER(0, "max-stack", &report.max_stack,
1061 "Set the maximum stack depth when parsing the callchain, "
1062 "anything beyond the specified depth will be ignored. "
1063 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
1064 OPT_BOOLEAN('G', "inverted", &report.inverted_callchain,
1065 "alias for inverted call graph"),
1066 OPT_CALLBACK(0, "ignore-callees", NULL, "regex",
1067 "ignore callees of these functions in call graphs",
1068 report_parse_ignore_callees_opt),
1069 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
1070 "only consider symbols in these dsos"),
1071 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1072 "only consider symbols in these comms"),
1073 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
1074 "only consider symbols in these pids"),
1075 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
1076 "only consider symbols in these tids"),
1077 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1078 "only consider these symbols"),
1079 OPT_STRING(0, "symbol-filter", &report.symbol_filter_str, "filter",
1080 "only show symbols that (partially) match with this filter"),
1081 OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
1082 "width[,width...]",
1083 "don't try to adjust column width, use these fixed values"),
1084 OPT_STRING_NOEMPTY('t', "field-separator", &symbol_conf.field_sep, "separator",
1085 "separator for columns, no spaces will be added between "
1086 "columns '.' is reserved."),
1087 OPT_BOOLEAN('U', "hide-unresolved", &symbol_conf.hide_unresolved,
1088 "Only display entries resolved to a symbol"),
1089 OPT_CALLBACK(0, "symfs", NULL, "directory",
1090 "Look for files with symbols relative to this directory",
1091 symbol__config_symfs),
1092 OPT_STRING('C', "cpu", &report.cpu_list, "cpu",
1093 "list of cpus to profile"),
1094 OPT_BOOLEAN('I', "show-info", &report.show_full_info,
1095 "Display extended information about perf.data file"),
1096 OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
1097 "Interleave source code with assembly code (default)"),
1098 OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
1099 "Display raw encoding of assembly instructions (default)"),
1100 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
1101 "Specify disassembler style (e.g. -M intel for intel syntax)"),
1102 OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
1103 "Show a column with the sum of periods"),
1104 OPT_BOOLEAN_SET(0, "group", &symbol_conf.event_group, &report.group_set,
1105 "Show event group information together"),
1106 OPT_CALLBACK_NOOPT('b', "branch-stack", &branch_mode, "",
1107 "use branch records for per branch histogram filling",
1108 parse_branch_mode),
1109 OPT_BOOLEAN(0, "branch-history", &branch_call_mode,
1110 "add last branch records to call history"),
1111 OPT_STRING(0, "objdump", &objdump_path, "path",
1112 "objdump binary to use for disassembly and annotations"),
1113 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
1114 "Disable symbol demangling"),
1115 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
1116 "Enable kernel symbol demangling"),
1117 OPT_BOOLEAN(0, "mem-mode", &report.mem_mode, "mem access profile"),
1118 OPT_CALLBACK(0, "percent-limit", &report, "percent",
1119 "Don't show entries under that percent", parse_percent_limit),
1120 OPT_CALLBACK(0, "percentage", NULL, "relative|absolute",
1121 "how to display percentage of filtered entries", parse_filter_percentage),
1122 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
1123 "Instruction Tracing options",
1124 itrace_parse_synth_opts),
1125 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
1126 "Show full source file name path for source lines"),
1127 OPT_BOOLEAN(0, "show-ref-call-graph", &symbol_conf.show_ref_callgraph,
1128 "Show callgraph from reference event"),
1129 OPT_INTEGER(0, "socket-filter", &report.socket_filter,
1130 "only show processor socket that match with this filter"),
1131 OPT_BOOLEAN(0, "raw-trace", &symbol_conf.raw_trace,
1132 "Show raw trace event output (do not use print fmt or plugins)"),
1133 OPT_BOOLEAN(0, "hierarchy", &symbol_conf.report_hierarchy,
1134 "Show entries in a hierarchy"),
1135 OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL, "mode",
1136 "'always' (default), 'never' or 'auto' only applicable to --stdio mode",
1137 stdio__config_color, "always"),
1138 OPT_STRING(0, "time", &report.time_str, "str",
1139 "Time span of interest (start,stop)"),
1140 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
1141 "Show inline function"),
1142 OPT_END()
1143 };
1144 struct perf_data data = {
1145 .mode = PERF_DATA_MODE_READ,
1146 };
1147 int ret = hists__init();
1148
1149 if (ret < 0)
1150 return ret;
1151
1152 ret = perf_config(report__config, &report);
1153 if (ret)
1154 return ret;
1155
1156 argc = parse_options(argc, argv, options, report_usage, 0);
1157 if (argc) {
1158 /*
1159 * Special case: if there's an argument left then assume that
1160 * it's a symbol filter:
1161 */
1162 if (argc > 1)
1163 usage_with_options(report_usage, options);
1164
1165 report.symbol_filter_str = argv[0];
1166 }
1167
1168 if (report.mmaps_mode)
1169 report.tasks_mode = true;
1170
1171 if (quiet)
1172 perf_quiet_option();
1173
1174 if (symbol_conf.vmlinux_name &&
1175 access(symbol_conf.vmlinux_name, R_OK)) {
1176 pr_err("Invalid file: %s\n", symbol_conf.vmlinux_name);
1177 return -EINVAL;
1178 }
1179 if (symbol_conf.kallsyms_name &&
1180 access(symbol_conf.kallsyms_name, R_OK)) {
1181 pr_err("Invalid file: %s\n", symbol_conf.kallsyms_name);
1182 return -EINVAL;
1183 }
1184
1185 if (report.inverted_callchain)
1186 callchain_param.order = ORDER_CALLER;
1187 if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
1188 callchain_param.order = ORDER_CALLER;
1189
1190 if (itrace_synth_opts.callchain &&
1191 (int)itrace_synth_opts.callchain_sz > report.max_stack)
1192 report.max_stack = itrace_synth_opts.callchain_sz;
1193
1194 if (!input_name || !strlen(input_name)) {
1195 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
1196 input_name = "-";
1197 else
1198 input_name = "perf.data";
1199 }
1200
1201 data.file.path = input_name;
1202 data.force = symbol_conf.force;
1203
1204repeat:
1205 session = perf_session__new(&data, false, &report.tool);
1206 if (session == NULL)
1207 return -1;
1208
1209 if (report.queue_size) {
1210 ordered_events__set_alloc_size(&session->ordered_events,
1211 report.queue_size);
1212 }
1213
1214 session->itrace_synth_opts = &itrace_synth_opts;
1215
1216 report.session = session;
1217
1218 has_br_stack = perf_header__has_feat(&session->header,
1219 HEADER_BRANCH_STACK);
1220
1221 setup_forced_leader(&report, session->evlist);
1222
1223 if (itrace_synth_opts.last_branch)
1224 has_br_stack = true;
1225
1226 if (has_br_stack && branch_call_mode)
1227 symbol_conf.show_branchflag_count = true;
1228
1229 memset(&report.brtype_stat, 0, sizeof(struct branch_type_stat));
1230
1231 /*
1232 * Branch mode is a tristate:
1233 * -1 means default, so decide based on the file having branch data.
1234 * 0/1 means the user chose a mode.
1235 */
1236 if (((branch_mode == -1 && has_br_stack) || branch_mode == 1) &&
1237 !branch_call_mode) {
1238 sort__mode = SORT_MODE__BRANCH;
1239 symbol_conf.cumulate_callchain = false;
1240 }
1241 if (branch_call_mode) {
1242 callchain_param.key = CCKEY_ADDRESS;
1243 callchain_param.branch_callstack = 1;
1244 symbol_conf.use_callchain = true;
1245 callchain_register_param(&callchain_param);
1246 if (sort_order == NULL)
1247 sort_order = "srcline,symbol,dso";
1248 }
1249
1250 if (report.mem_mode) {
1251 if (sort__mode == SORT_MODE__BRANCH) {
1252 pr_err("branch and mem mode incompatible\n");
1253 goto error;
1254 }
1255 sort__mode = SORT_MODE__MEMORY;
1256 symbol_conf.cumulate_callchain = false;
1257 }
1258
1259 if (symbol_conf.report_hierarchy) {
1260 /* disable incompatible options */
1261 symbol_conf.cumulate_callchain = false;
1262
1263 if (field_order) {
1264 pr_err("Error: --hierarchy and --fields options cannot be used together\n");
1265 parse_options_usage(report_usage, options, "F", 1);
1266 parse_options_usage(NULL, options, "hierarchy", 0);
1267 goto error;
1268 }
1269
1270 perf_hpp_list.need_collapse = true;
1271 }
1272
1273 if (report.use_stdio)
1274 use_browser = 0;
1275 else if (report.use_tui)
1276 use_browser = 1;
1277 else if (report.use_gtk)
1278 use_browser = 2;
1279
1280 /* Force tty output for header output and per-thread stat. */
1281 if (report.header || report.header_only || report.show_threads)
1282 use_browser = 0;
1283 if (report.header || report.header_only)
1284 report.tool.show_feat_hdr = SHOW_FEAT_HEADER;
1285 if (report.show_full_info)
1286 report.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
1287 if (report.stats_mode || report.tasks_mode)
1288 use_browser = 0;
1289 if (report.stats_mode && report.tasks_mode) {
1290 pr_err("Error: --tasks and --mmaps can't be used together with --stats\n");
1291 goto error;
1292 }
1293
1294 if (strcmp(input_name, "-") != 0)
1295 setup_browser(true);
1296 else
1297 use_browser = 0;
1298
1299 if (setup_sorting(session->evlist) < 0) {
1300 if (sort_order)
1301 parse_options_usage(report_usage, options, "s", 1);
1302 if (field_order)
1303 parse_options_usage(sort_order ? NULL : report_usage,
1304 options, "F", 1);
1305 goto error;
1306 }
1307
1308 if ((report.header || report.header_only) && !quiet) {
1309 perf_session__fprintf_info(session, stdout,
1310 report.show_full_info);
1311 if (report.header_only) {
1312 ret = 0;
1313 goto error;
1314 }
1315 } else if (use_browser == 0 && !quiet &&
1316 !report.stats_mode && !report.tasks_mode) {
1317 fputs("# To display the perf.data header info, please use --header/--header-only options.\n#\n",
1318 stdout);
1319 }
1320
1321 /*
1322 * Only in the TUI browser we are doing integrated annotation,
1323 * so don't allocate extra space that won't be used in the stdio
1324 * implementation.
1325 */
1326 if (ui__has_annotation()) {
1327 ret = symbol__annotation_init();
1328 if (ret < 0)
1329 goto error;
1330 /*
1331 * For searching by name on the "Browse map details".
1332 * providing it only in verbose mode not to bloat too
1333 * much struct symbol.
1334 */
1335 if (verbose > 0) {
1336 /*
1337 * XXX: Need to provide a less kludgy way to ask for
1338 * more space per symbol, the u32 is for the index on
1339 * the ui browser.
1340 * See symbol__browser_index.
1341 */
1342 symbol_conf.priv_size += sizeof(u32);
1343 symbol_conf.sort_by_name = true;
1344 }
1345 annotation_config__init();
1346 }
1347
1348 if (symbol__init(&session->header.env) < 0)
1349 goto error;
1350
1351 report.ptime_range = perf_time__range_alloc(report.time_str,
1352 &report.range_size);
1353 if (!report.ptime_range) {
1354 ret = -ENOMEM;
1355 goto error;
1356 }
1357
1358 if (perf_time__parse_str(report.ptime_range, report.time_str) != 0) {
1359 if (session->evlist->first_sample_time == 0 &&
1360 session->evlist->last_sample_time == 0) {
1361 pr_err("HINT: no first/last sample time found in perf data.\n"
1362 "Please use latest perf binary to execute 'perf record'\n"
1363 "(if '--buildid-all' is enabled, please set '--timestamp-boundary').\n");
1364 ret = -EINVAL;
1365 goto error;
1366 }
1367
1368 report.range_num = perf_time__percent_parse_str(
1369 report.ptime_range, report.range_size,
1370 report.time_str,
1371 session->evlist->first_sample_time,
1372 session->evlist->last_sample_time);
1373
1374 if (report.range_num < 0) {
1375 pr_err("Invalid time string\n");
1376 ret = -EINVAL;
1377 goto error;
1378 }
1379 } else {
1380 report.range_num = 1;
1381 }
1382
1383 if (session->tevent.pevent &&
1384 pevent_set_function_resolver(session->tevent.pevent,
1385 machine__resolve_kernel_addr,
1386 &session->machines.host) < 0) {
1387 pr_err("%s: failed to set libtraceevent function resolver\n",
1388 __func__);
1389 return -1;
1390 }
1391
1392 sort__setup_elide(stdout);
1393
1394 ret = __cmd_report(&report);
1395 if (ret == K_SWITCH_INPUT_DATA) {
1396 perf_session__delete(session);
1397 goto repeat;
1398 } else
1399 ret = 0;
1400
1401error:
1402 zfree(&report.ptime_range);
1403
1404 perf_session__delete(session);
1405 return ret;
1406}
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * builtin-report.c
4 *
5 * Builtin report command: Analyze the perf.data input file,
6 * look up and read DSOs and symbol information and display
7 * a histogram of results, along various sorting keys.
8 */
9#include "builtin.h"
10
11#include "util/config.h"
12
13#include "util/annotate.h"
14#include "util/color.h"
15#include "util/dso.h"
16#include <linux/list.h>
17#include <linux/rbtree.h>
18#include <linux/err.h>
19#include <linux/zalloc.h>
20#include "util/map.h"
21#include "util/symbol.h"
22#include "util/map_symbol.h"
23#include "util/mem-events.h"
24#include "util/branch.h"
25#include "util/callchain.h"
26#include "util/values.h"
27
28#include "perf.h"
29#include "util/debug.h"
30#include "util/evlist.h"
31#include "util/evsel.h"
32#include "util/evswitch.h"
33#include "util/header.h"
34#include "util/session.h"
35#include "util/srcline.h"
36#include "util/tool.h"
37
38#include <subcmd/parse-options.h>
39#include <subcmd/exec-cmd.h>
40#include "util/parse-events.h"
41
42#include "util/thread.h"
43#include "util/sort.h"
44#include "util/hist.h"
45#include "util/data.h"
46#include "arch/common.h"
47#include "util/time-utils.h"
48#include "util/auxtrace.h"
49#include "util/units.h"
50#include "util/util.h" // perf_tip()
51#include "ui/ui.h"
52#include "ui/progress.h"
53#include "util/block-info.h"
54
55#include <dlfcn.h>
56#include <errno.h>
57#include <inttypes.h>
58#include <regex.h>
59#include <linux/ctype.h>
60#include <signal.h>
61#include <linux/bitmap.h>
62#include <linux/string.h>
63#include <linux/stringify.h>
64#include <linux/time64.h>
65#include <sys/types.h>
66#include <sys/stat.h>
67#include <unistd.h>
68#include <linux/mman.h>
69
70#ifdef HAVE_LIBTRACEEVENT
71#include <traceevent/event-parse.h>
72#endif
73
74struct report {
75 struct perf_tool tool;
76 struct perf_session *session;
77 struct evswitch evswitch;
78#ifdef HAVE_SLANG_SUPPORT
79 bool use_tui;
80#endif
81#ifdef HAVE_GTK2_SUPPORT
82 bool use_gtk;
83#endif
84 bool use_stdio;
85 bool show_full_info;
86 bool show_threads;
87 bool inverted_callchain;
88 bool mem_mode;
89 bool stats_mode;
90 bool tasks_mode;
91 bool mmaps_mode;
92 bool header;
93 bool header_only;
94 bool nonany_branch_mode;
95 bool group_set;
96 bool stitch_lbr;
97 bool disable_order;
98 bool skip_empty;
99 bool data_type;
100 int max_stack;
101 struct perf_read_values show_threads_values;
102 const char *pretty_printing_style;
103 const char *cpu_list;
104 const char *symbol_filter_str;
105 const char *time_str;
106 struct perf_time_interval *ptime_range;
107 int range_size;
108 int range_num;
109 float min_percent;
110 u64 nr_entries;
111 u64 queue_size;
112 u64 total_cycles;
113 int socket_filter;
114 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
115 struct branch_type_stat brtype_stat;
116 bool symbol_ipc;
117 bool total_cycles_mode;
118 struct block_report *block_reports;
119 int nr_block_reports;
120};
121
122static int report__config(const char *var, const char *value, void *cb)
123{
124 struct report *rep = cb;
125
126 if (!strcmp(var, "report.group")) {
127 symbol_conf.event_group = perf_config_bool(var, value);
128 return 0;
129 }
130 if (!strcmp(var, "report.percent-limit")) {
131 double pcnt = strtof(value, NULL);
132
133 rep->min_percent = pcnt;
134 callchain_param.min_percent = pcnt;
135 return 0;
136 }
137 if (!strcmp(var, "report.children")) {
138 symbol_conf.cumulate_callchain = perf_config_bool(var, value);
139 return 0;
140 }
141 if (!strcmp(var, "report.queue-size"))
142 return perf_config_u64(&rep->queue_size, var, value);
143
144 if (!strcmp(var, "report.sort_order")) {
145 default_sort_order = strdup(value);
146 if (!default_sort_order) {
147 pr_err("Not enough memory for report.sort_order\n");
148 return -1;
149 }
150 return 0;
151 }
152
153 if (!strcmp(var, "report.skip-empty")) {
154 rep->skip_empty = perf_config_bool(var, value);
155 return 0;
156 }
157
158 pr_debug("%s variable unknown, ignoring...", var);
159 return 0;
160}
161
162static int hist_iter__report_callback(struct hist_entry_iter *iter,
163 struct addr_location *al, bool single,
164 void *arg)
165{
166 int err = 0;
167 struct report *rep = arg;
168 struct hist_entry *he = iter->he;
169 struct evsel *evsel = iter->evsel;
170 struct perf_sample *sample = iter->sample;
171 struct mem_info *mi;
172 struct branch_info *bi;
173
174 if (!ui__has_annotation() && !rep->symbol_ipc && !rep->data_type)
175 return 0;
176
177 if (sort__mode == SORT_MODE__BRANCH) {
178 bi = he->branch_info;
179 err = addr_map_symbol__inc_samples(&bi->from, sample, evsel);
180 if (err)
181 goto out;
182
183 err = addr_map_symbol__inc_samples(&bi->to, sample, evsel);
184
185 } else if (rep->mem_mode) {
186 mi = he->mem_info;
187 err = addr_map_symbol__inc_samples(&mi->daddr, sample, evsel);
188 if (err)
189 goto out;
190
191 err = hist_entry__inc_addr_samples(he, sample, evsel, al->addr);
192
193 } else if (symbol_conf.cumulate_callchain) {
194 if (single)
195 err = hist_entry__inc_addr_samples(he, sample, evsel, al->addr);
196 } else {
197 err = hist_entry__inc_addr_samples(he, sample, evsel, al->addr);
198 }
199
200out:
201 return err;
202}
203
204static int hist_iter__branch_callback(struct hist_entry_iter *iter,
205 struct addr_location *al __maybe_unused,
206 bool single __maybe_unused,
207 void *arg)
208{
209 struct hist_entry *he = iter->he;
210 struct report *rep = arg;
211 struct branch_info *bi = he->branch_info;
212 struct perf_sample *sample = iter->sample;
213 struct evsel *evsel = iter->evsel;
214 int err;
215
216 branch_type_count(&rep->brtype_stat, &bi->flags,
217 bi->from.addr, bi->to.addr);
218
219 if (!ui__has_annotation() && !rep->symbol_ipc)
220 return 0;
221
222 err = addr_map_symbol__inc_samples(&bi->from, sample, evsel);
223 if (err)
224 goto out;
225
226 err = addr_map_symbol__inc_samples(&bi->to, sample, evsel);
227
228out:
229 return err;
230}
231
232static void setup_forced_leader(struct report *report,
233 struct evlist *evlist)
234{
235 if (report->group_set)
236 evlist__force_leader(evlist);
237}
238
239static int process_feature_event(struct perf_session *session,
240 union perf_event *event)
241{
242 struct report *rep = container_of(session->tool, struct report, tool);
243
244 if (event->feat.feat_id < HEADER_LAST_FEATURE)
245 return perf_event__process_feature(session, event);
246
247 if (event->feat.feat_id != HEADER_LAST_FEATURE) {
248 pr_err("failed: wrong feature ID: %" PRI_lu64 "\n",
249 event->feat.feat_id);
250 return -1;
251 } else if (rep->header_only) {
252 session_done = 1;
253 }
254
255 /*
256 * (feat_id = HEADER_LAST_FEATURE) is the end marker which
257 * means all features are received, now we can force the
258 * group if needed.
259 */
260 setup_forced_leader(rep, session->evlist);
261 return 0;
262}
263
264static int process_sample_event(struct perf_tool *tool,
265 union perf_event *event,
266 struct perf_sample *sample,
267 struct evsel *evsel,
268 struct machine *machine)
269{
270 struct report *rep = container_of(tool, struct report, tool);
271 struct addr_location al;
272 struct hist_entry_iter iter = {
273 .evsel = evsel,
274 .sample = sample,
275 .hide_unresolved = symbol_conf.hide_unresolved,
276 .add_entry_cb = hist_iter__report_callback,
277 };
278 int ret = 0;
279
280 if (perf_time__ranges_skip_sample(rep->ptime_range, rep->range_num,
281 sample->time)) {
282 return 0;
283 }
284
285 if (evswitch__discard(&rep->evswitch, evsel))
286 return 0;
287
288 addr_location__init(&al);
289 if (machine__resolve(machine, &al, sample) < 0) {
290 pr_debug("problem processing %d event, skipping it.\n",
291 event->header.type);
292 ret = -1;
293 goto out_put;
294 }
295
296 if (rep->stitch_lbr)
297 thread__set_lbr_stitch_enable(al.thread, true);
298
299 if (symbol_conf.hide_unresolved && al.sym == NULL)
300 goto out_put;
301
302 if (rep->cpu_list && !test_bit(sample->cpu, rep->cpu_bitmap))
303 goto out_put;
304
305 if (sort__mode == SORT_MODE__BRANCH) {
306 /*
307 * A non-synthesized event might not have a branch stack if
308 * branch stacks have been synthesized (using itrace options).
309 */
310 if (!sample->branch_stack)
311 goto out_put;
312
313 iter.add_entry_cb = hist_iter__branch_callback;
314 iter.ops = &hist_iter_branch;
315 } else if (rep->mem_mode) {
316 iter.ops = &hist_iter_mem;
317 } else if (symbol_conf.cumulate_callchain) {
318 iter.ops = &hist_iter_cumulative;
319 } else {
320 iter.ops = &hist_iter_normal;
321 }
322
323 if (al.map != NULL)
324 map__dso(al.map)->hit = 1;
325
326 if (ui__has_annotation() || rep->symbol_ipc || rep->total_cycles_mode) {
327 hist__account_cycles(sample->branch_stack, &al, sample,
328 rep->nonany_branch_mode,
329 &rep->total_cycles);
330 }
331
332 ret = hist_entry_iter__add(&iter, &al, rep->max_stack, rep);
333 if (ret < 0)
334 pr_debug("problem adding hist entry, skipping event\n");
335out_put:
336 addr_location__exit(&al);
337 return ret;
338}
339
340static int process_read_event(struct perf_tool *tool,
341 union perf_event *event,
342 struct perf_sample *sample __maybe_unused,
343 struct evsel *evsel,
344 struct machine *machine __maybe_unused)
345{
346 struct report *rep = container_of(tool, struct report, tool);
347
348 if (rep->show_threads) {
349 const char *name = evsel__name(evsel);
350 int err = perf_read_values_add_value(&rep->show_threads_values,
351 event->read.pid, event->read.tid,
352 evsel->core.idx,
353 name,
354 event->read.value);
355
356 if (err)
357 return err;
358 }
359
360 return 0;
361}
362
363/* For pipe mode, sample_type is not currently set */
364static int report__setup_sample_type(struct report *rep)
365{
366 struct perf_session *session = rep->session;
367 u64 sample_type = evlist__combined_sample_type(session->evlist);
368 bool is_pipe = perf_data__is_pipe(session->data);
369 struct evsel *evsel;
370
371 if (session->itrace_synth_opts->callchain ||
372 session->itrace_synth_opts->add_callchain ||
373 (!is_pipe &&
374 perf_header__has_feat(&session->header, HEADER_AUXTRACE) &&
375 !session->itrace_synth_opts->set))
376 sample_type |= PERF_SAMPLE_CALLCHAIN;
377
378 if (session->itrace_synth_opts->last_branch ||
379 session->itrace_synth_opts->add_last_branch)
380 sample_type |= PERF_SAMPLE_BRANCH_STACK;
381
382 if (!is_pipe && !(sample_type & PERF_SAMPLE_CALLCHAIN)) {
383 if (perf_hpp_list.parent) {
384 ui__error("Selected --sort parent, but no "
385 "callchain data. Did you call "
386 "'perf record' without -g?\n");
387 return -EINVAL;
388 }
389 if (symbol_conf.use_callchain &&
390 !symbol_conf.show_branchflag_count) {
391 ui__error("Selected -g or --branch-history.\n"
392 "But no callchain or branch data.\n"
393 "Did you call 'perf record' without -g or -b?\n");
394 return -1;
395 }
396 } else if (!callchain_param.enabled &&
397 callchain_param.mode != CHAIN_NONE &&
398 !symbol_conf.use_callchain) {
399 symbol_conf.use_callchain = true;
400 if (callchain_register_param(&callchain_param) < 0) {
401 ui__error("Can't register callchain params.\n");
402 return -EINVAL;
403 }
404 }
405
406 if (symbol_conf.cumulate_callchain) {
407 /* Silently ignore if callchain is missing */
408 if (!(sample_type & PERF_SAMPLE_CALLCHAIN)) {
409 symbol_conf.cumulate_callchain = false;
410 perf_hpp__cancel_cumulate();
411 }
412 }
413
414 if (sort__mode == SORT_MODE__BRANCH) {
415 if (!is_pipe &&
416 !(sample_type & PERF_SAMPLE_BRANCH_STACK)) {
417 ui__error("Selected -b but no branch data. "
418 "Did you call perf record without -b?\n");
419 return -1;
420 }
421 }
422
423 if (sort__mode == SORT_MODE__MEMORY) {
424 /*
425 * FIXUP: prior to kernel 5.18, Arm SPE missed to set
426 * PERF_SAMPLE_DATA_SRC bit in sample type. For backward
427 * compatibility, set the bit if it's an old perf data file.
428 */
429 evlist__for_each_entry(session->evlist, evsel) {
430 if (strstr(evsel->name, "arm_spe") &&
431 !(sample_type & PERF_SAMPLE_DATA_SRC)) {
432 evsel->core.attr.sample_type |= PERF_SAMPLE_DATA_SRC;
433 sample_type |= PERF_SAMPLE_DATA_SRC;
434 }
435 }
436
437 if (!is_pipe && !(sample_type & PERF_SAMPLE_DATA_SRC)) {
438 ui__error("Selected --mem-mode but no mem data. "
439 "Did you call perf record without -d?\n");
440 return -1;
441 }
442 }
443
444 callchain_param_setup(sample_type, perf_env__arch(&rep->session->header.env));
445
446 if (rep->stitch_lbr && (callchain_param.record_mode != CALLCHAIN_LBR)) {
447 ui__warning("Can't find LBR callchain. Switch off --stitch-lbr.\n"
448 "Please apply --call-graph lbr when recording.\n");
449 rep->stitch_lbr = false;
450 }
451
452 /* ??? handle more cases than just ANY? */
453 if (!(evlist__combined_branch_type(session->evlist) & PERF_SAMPLE_BRANCH_ANY))
454 rep->nonany_branch_mode = true;
455
456#if !defined(HAVE_LIBUNWIND_SUPPORT) && !defined(HAVE_DWARF_SUPPORT)
457 if (dwarf_callchain_users) {
458 ui__warning("Please install libunwind or libdw "
459 "development packages during the perf build.\n");
460 }
461#endif
462
463 return 0;
464}
465
466static void sig_handler(int sig __maybe_unused)
467{
468 session_done = 1;
469}
470
471static size_t hists__fprintf_nr_sample_events(struct hists *hists, struct report *rep,
472 const char *evname, FILE *fp)
473{
474 size_t ret;
475 char unit;
476 unsigned long nr_samples = hists->stats.nr_samples;
477 u64 nr_events = hists->stats.total_period;
478 struct evsel *evsel = hists_to_evsel(hists);
479 char buf[512];
480 size_t size = sizeof(buf);
481 int socked_id = hists->socket_filter;
482
483 if (quiet)
484 return 0;
485
486 if (symbol_conf.filter_relative) {
487 nr_samples = hists->stats.nr_non_filtered_samples;
488 nr_events = hists->stats.total_non_filtered_period;
489 }
490
491 if (evsel__is_group_event(evsel)) {
492 struct evsel *pos;
493
494 evsel__group_desc(evsel, buf, size);
495 evname = buf;
496
497 for_each_group_member(pos, evsel) {
498 const struct hists *pos_hists = evsel__hists(pos);
499
500 if (symbol_conf.filter_relative) {
501 nr_samples += pos_hists->stats.nr_non_filtered_samples;
502 nr_events += pos_hists->stats.total_non_filtered_period;
503 } else {
504 nr_samples += pos_hists->stats.nr_samples;
505 nr_events += pos_hists->stats.total_period;
506 }
507 }
508 }
509
510 nr_samples = convert_unit(nr_samples, &unit);
511 ret = fprintf(fp, "# Samples: %lu%c", nr_samples, unit);
512 if (evname != NULL) {
513 ret += fprintf(fp, " of event%s '%s'",
514 evsel->core.nr_members > 1 ? "s" : "", evname);
515 }
516
517 if (rep->time_str)
518 ret += fprintf(fp, " (time slices: %s)", rep->time_str);
519
520 if (symbol_conf.show_ref_callgraph && evname && strstr(evname, "call-graph=no")) {
521 ret += fprintf(fp, ", show reference callgraph");
522 }
523
524 if (rep->mem_mode) {
525 ret += fprintf(fp, "\n# Total weight : %" PRIu64, nr_events);
526 ret += fprintf(fp, "\n# Sort order : %s", sort_order ? : default_mem_sort_order);
527 } else
528 ret += fprintf(fp, "\n# Event count (approx.): %" PRIu64, nr_events);
529
530 if (socked_id > -1)
531 ret += fprintf(fp, "\n# Processor Socket: %d", socked_id);
532
533 return ret + fprintf(fp, "\n#\n");
534}
535
536static int evlist__tui_block_hists_browse(struct evlist *evlist, struct report *rep)
537{
538 struct evsel *pos;
539 int i = 0, ret;
540
541 evlist__for_each_entry(evlist, pos) {
542 ret = report__browse_block_hists(&rep->block_reports[i++].hist,
543 rep->min_percent, pos,
544 &rep->session->header.env);
545 if (ret != 0)
546 return ret;
547 }
548
549 return 0;
550}
551
552static int evlist__tty_browse_hists(struct evlist *evlist, struct report *rep, const char *help)
553{
554 struct evsel *pos;
555 int i = 0;
556
557 if (!quiet) {
558 fprintf(stdout, "#\n# Total Lost Samples: %" PRIu64 "\n#\n",
559 evlist->stats.total_lost_samples);
560 }
561
562 evlist__for_each_entry(evlist, pos) {
563 struct hists *hists = evsel__hists(pos);
564 const char *evname = evsel__name(pos);
565
566 if (symbol_conf.event_group && !evsel__is_group_leader(pos))
567 continue;
568
569 if (rep->skip_empty && !hists->stats.nr_samples)
570 continue;
571
572 hists__fprintf_nr_sample_events(hists, rep, evname, stdout);
573
574 if (rep->total_cycles_mode) {
575 report__browse_block_hists(&rep->block_reports[i++].hist,
576 rep->min_percent, pos, NULL);
577 continue;
578 }
579
580 hists__fprintf(hists, !quiet, 0, 0, rep->min_percent, stdout,
581 !(symbol_conf.use_callchain ||
582 symbol_conf.show_branchflag_count));
583 fprintf(stdout, "\n\n");
584 }
585
586 if (!quiet)
587 fprintf(stdout, "#\n# (%s)\n#\n", help);
588
589 if (rep->show_threads) {
590 bool style = !strcmp(rep->pretty_printing_style, "raw");
591 perf_read_values_display(stdout, &rep->show_threads_values,
592 style);
593 perf_read_values_destroy(&rep->show_threads_values);
594 }
595
596 if (sort__mode == SORT_MODE__BRANCH)
597 branch_type_stat_display(stdout, &rep->brtype_stat);
598
599 return 0;
600}
601
602static void report__warn_kptr_restrict(const struct report *rep)
603{
604 struct map *kernel_map = machine__kernel_map(&rep->session->machines.host);
605 struct kmap *kernel_kmap = kernel_map ? map__kmap(kernel_map) : NULL;
606
607 if (evlist__exclude_kernel(rep->session->evlist))
608 return;
609
610 if (kernel_map == NULL ||
611 (map__dso(kernel_map)->hit &&
612 (kernel_kmap->ref_reloc_sym == NULL ||
613 kernel_kmap->ref_reloc_sym->addr == 0))) {
614 const char *desc =
615 "As no suitable kallsyms nor vmlinux was found, kernel samples\n"
616 "can't be resolved.";
617
618 if (kernel_map && map__has_symbols(kernel_map)) {
619 desc = "If some relocation was applied (e.g. "
620 "kexec) symbols may be misresolved.";
621 }
622
623 ui__warning(
624"Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n"
625"Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n"
626"Samples in kernel modules can't be resolved as well.\n\n",
627 desc);
628 }
629}
630
631static int report__gtk_browse_hists(struct report *rep, const char *help)
632{
633 int (*hist_browser)(struct evlist *evlist, const char *help,
634 struct hist_browser_timer *timer, float min_pcnt);
635
636 hist_browser = dlsym(perf_gtk_handle, "evlist__gtk_browse_hists");
637
638 if (hist_browser == NULL) {
639 ui__error("GTK browser not found!\n");
640 return -1;
641 }
642
643 return hist_browser(rep->session->evlist, help, NULL, rep->min_percent);
644}
645
646static int report__browse_hists(struct report *rep)
647{
648 int ret;
649 struct perf_session *session = rep->session;
650 struct evlist *evlist = session->evlist;
651 char *help = NULL, *path = NULL;
652
653 path = system_path(TIPDIR);
654 if (perf_tip(&help, path) || help == NULL) {
655 /* fallback for people who don't install perf ;-) */
656 free(path);
657 path = system_path(DOCDIR);
658 if (perf_tip(&help, path) || help == NULL)
659 help = strdup("Cannot load tips.txt file, please install perf!");
660 }
661 free(path);
662
663 switch (use_browser) {
664 case 1:
665 if (rep->total_cycles_mode) {
666 ret = evlist__tui_block_hists_browse(evlist, rep);
667 break;
668 }
669
670 ret = evlist__tui_browse_hists(evlist, help, NULL, rep->min_percent,
671 &session->header.env, true);
672 /*
673 * Usually "ret" is the last pressed key, and we only
674 * care if the key notifies us to switch data file.
675 */
676 if (ret != K_SWITCH_INPUT_DATA && ret != K_RELOAD)
677 ret = 0;
678 break;
679 case 2:
680 ret = report__gtk_browse_hists(rep, help);
681 break;
682 default:
683 ret = evlist__tty_browse_hists(evlist, rep, help);
684 break;
685 }
686 free(help);
687 return ret;
688}
689
690static int report__collapse_hists(struct report *rep)
691{
692 struct perf_session *session = rep->session;
693 struct evlist *evlist = session->evlist;
694 struct ui_progress prog;
695 struct evsel *pos;
696 int ret = 0;
697
698 /*
699 * The pipe data needs to setup hierarchy hpp formats now, because it
700 * cannot know about evsels in the data before reading the data. The
701 * normal file data saves the event (attribute) info in the header
702 * section, but pipe does not have the luxury.
703 */
704 if (perf_data__is_pipe(session->data)) {
705 if (perf_hpp__setup_hists_formats(&perf_hpp_list, evlist) < 0) {
706 ui__error("Failed to setup hierarchy output formats\n");
707 return -1;
708 }
709 }
710
711 ui_progress__init(&prog, rep->nr_entries, "Merging related events...");
712
713 evlist__for_each_entry(rep->session->evlist, pos) {
714 struct hists *hists = evsel__hists(pos);
715
716 if (pos->core.idx == 0)
717 hists->symbol_filter_str = rep->symbol_filter_str;
718
719 hists->socket_filter = rep->socket_filter;
720
721 ret = hists__collapse_resort(hists, &prog);
722 if (ret < 0)
723 break;
724
725 /* Non-group events are considered as leader */
726 if (symbol_conf.event_group && !evsel__is_group_leader(pos)) {
727 struct hists *leader_hists = evsel__hists(evsel__leader(pos));
728
729 hists__match(leader_hists, hists);
730 hists__link(leader_hists, hists);
731 }
732 }
733
734 ui_progress__finish();
735 return ret;
736}
737
738static int hists__resort_cb(struct hist_entry *he, void *arg)
739{
740 struct report *rep = arg;
741 struct symbol *sym = he->ms.sym;
742
743 if (rep->symbol_ipc && sym && !sym->annotate2) {
744 struct evsel *evsel = hists_to_evsel(he->hists);
745
746 symbol__annotate2(&he->ms, evsel, NULL);
747 }
748
749 return 0;
750}
751
752static void report__output_resort(struct report *rep)
753{
754 struct ui_progress prog;
755 struct evsel *pos;
756
757 ui_progress__init(&prog, rep->nr_entries, "Sorting events for output...");
758
759 evlist__for_each_entry(rep->session->evlist, pos) {
760 evsel__output_resort_cb(pos, &prog, hists__resort_cb, rep);
761 }
762
763 ui_progress__finish();
764}
765
766static int count_sample_event(struct perf_tool *tool __maybe_unused,
767 union perf_event *event __maybe_unused,
768 struct perf_sample *sample __maybe_unused,
769 struct evsel *evsel,
770 struct machine *machine __maybe_unused)
771{
772 struct hists *hists = evsel__hists(evsel);
773
774 hists__inc_nr_events(hists);
775 return 0;
776}
777
778static int count_lost_samples_event(struct perf_tool *tool,
779 union perf_event *event,
780 struct perf_sample *sample,
781 struct machine *machine __maybe_unused)
782{
783 struct report *rep = container_of(tool, struct report, tool);
784 struct evsel *evsel;
785
786 evsel = evlist__id2evsel(rep->session->evlist, sample->id);
787 if (evsel) {
788 hists__inc_nr_lost_samples(evsel__hists(evsel),
789 event->lost_samples.lost);
790 }
791 return 0;
792}
793
794static int process_attr(struct perf_tool *tool __maybe_unused,
795 union perf_event *event,
796 struct evlist **pevlist);
797
798static void stats_setup(struct report *rep)
799{
800 memset(&rep->tool, 0, sizeof(rep->tool));
801 rep->tool.attr = process_attr;
802 rep->tool.sample = count_sample_event;
803 rep->tool.lost_samples = count_lost_samples_event;
804 rep->tool.no_warn = true;
805}
806
807static int stats_print(struct report *rep)
808{
809 struct perf_session *session = rep->session;
810
811 perf_session__fprintf_nr_events(session, stdout, rep->skip_empty);
812 evlist__fprintf_nr_events(session->evlist, stdout, rep->skip_empty);
813 return 0;
814}
815
816static void tasks_setup(struct report *rep)
817{
818 memset(&rep->tool, 0, sizeof(rep->tool));
819 rep->tool.ordered_events = true;
820 if (rep->mmaps_mode) {
821 rep->tool.mmap = perf_event__process_mmap;
822 rep->tool.mmap2 = perf_event__process_mmap2;
823 }
824 rep->tool.attr = process_attr;
825 rep->tool.comm = perf_event__process_comm;
826 rep->tool.exit = perf_event__process_exit;
827 rep->tool.fork = perf_event__process_fork;
828 rep->tool.no_warn = true;
829}
830
831struct task {
832 struct thread *thread;
833 struct list_head list;
834 struct list_head children;
835};
836
837static struct task *tasks_list(struct task *task, struct machine *machine)
838{
839 struct thread *parent_thread, *thread = task->thread;
840 struct task *parent_task;
841
842 /* Already listed. */
843 if (!list_empty(&task->list))
844 return NULL;
845
846 /* Last one in the chain. */
847 if (thread__ppid(thread) == -1)
848 return task;
849
850 parent_thread = machine__find_thread(machine, -1, thread__ppid(thread));
851 if (!parent_thread)
852 return ERR_PTR(-ENOENT);
853
854 parent_task = thread__priv(parent_thread);
855 thread__put(parent_thread);
856 list_add_tail(&task->list, &parent_task->children);
857 return tasks_list(parent_task, machine);
858}
859
860struct maps__fprintf_task_args {
861 int indent;
862 FILE *fp;
863 size_t printed;
864};
865
866static int maps__fprintf_task_cb(struct map *map, void *data)
867{
868 struct maps__fprintf_task_args *args = data;
869 const struct dso *dso = map__dso(map);
870 u32 prot = map__prot(map);
871 int ret;
872
873 ret = fprintf(args->fp,
874 "%*s %" PRIx64 "-%" PRIx64 " %c%c%c%c %08" PRIx64 " %" PRIu64 " %s\n",
875 args->indent, "", map__start(map), map__end(map),
876 prot & PROT_READ ? 'r' : '-',
877 prot & PROT_WRITE ? 'w' : '-',
878 prot & PROT_EXEC ? 'x' : '-',
879 map__flags(map) ? 's' : 'p',
880 map__pgoff(map),
881 dso->id.ino, dso->name);
882
883 if (ret < 0)
884 return ret;
885
886 args->printed += ret;
887 return 0;
888}
889
890static size_t maps__fprintf_task(struct maps *maps, int indent, FILE *fp)
891{
892 struct maps__fprintf_task_args args = {
893 .indent = indent,
894 .fp = fp,
895 .printed = 0,
896 };
897
898 maps__for_each_map(maps, maps__fprintf_task_cb, &args);
899
900 return args.printed;
901}
902
903static void task__print_level(struct task *task, FILE *fp, int level)
904{
905 struct thread *thread = task->thread;
906 struct task *child;
907 int comm_indent = fprintf(fp, " %8d %8d %8d |%*s",
908 thread__pid(thread), thread__tid(thread),
909 thread__ppid(thread), level, "");
910
911 fprintf(fp, "%s\n", thread__comm_str(thread));
912
913 maps__fprintf_task(thread__maps(thread), comm_indent, fp);
914
915 if (!list_empty(&task->children)) {
916 list_for_each_entry(child, &task->children, list)
917 task__print_level(child, fp, level + 1);
918 }
919}
920
921static int tasks_print(struct report *rep, FILE *fp)
922{
923 struct perf_session *session = rep->session;
924 struct machine *machine = &session->machines.host;
925 struct task *tasks, *task;
926 unsigned int nr = 0, itask = 0, i;
927 struct rb_node *nd;
928 LIST_HEAD(list);
929
930 /*
931 * No locking needed while accessing machine->threads,
932 * because --tasks is single threaded command.
933 */
934
935 /* Count all the threads. */
936 for (i = 0; i < THREADS__TABLE_SIZE; i++)
937 nr += machine->threads[i].nr;
938
939 tasks = malloc(sizeof(*tasks) * nr);
940 if (!tasks)
941 return -ENOMEM;
942
943 for (i = 0; i < THREADS__TABLE_SIZE; i++) {
944 struct threads *threads = &machine->threads[i];
945
946 for (nd = rb_first_cached(&threads->entries); nd;
947 nd = rb_next(nd)) {
948 task = tasks + itask++;
949
950 task->thread = rb_entry(nd, struct thread_rb_node, rb_node)->thread;
951 INIT_LIST_HEAD(&task->children);
952 INIT_LIST_HEAD(&task->list);
953 thread__set_priv(task->thread, task);
954 }
955 }
956
957 /*
958 * Iterate every task down to the unprocessed parent
959 * and link all in task children list. Task with no
960 * parent is added into 'list'.
961 */
962 for (itask = 0; itask < nr; itask++) {
963 task = tasks + itask;
964
965 if (!list_empty(&task->list))
966 continue;
967
968 task = tasks_list(task, machine);
969 if (IS_ERR(task)) {
970 pr_err("Error: failed to process tasks\n");
971 free(tasks);
972 return PTR_ERR(task);
973 }
974
975 if (task)
976 list_add_tail(&task->list, &list);
977 }
978
979 fprintf(fp, "# %8s %8s %8s %s\n", "pid", "tid", "ppid", "comm");
980
981 list_for_each_entry(task, &list, list)
982 task__print_level(task, fp, 0);
983
984 free(tasks);
985 return 0;
986}
987
988static int __cmd_report(struct report *rep)
989{
990 int ret;
991 struct perf_session *session = rep->session;
992 struct evsel *pos;
993 struct perf_data *data = session->data;
994
995 signal(SIGINT, sig_handler);
996
997 if (rep->cpu_list) {
998 ret = perf_session__cpu_bitmap(session, rep->cpu_list,
999 rep->cpu_bitmap);
1000 if (ret) {
1001 ui__error("failed to set cpu bitmap\n");
1002 return ret;
1003 }
1004 session->itrace_synth_opts->cpu_bitmap = rep->cpu_bitmap;
1005 }
1006
1007 if (rep->show_threads) {
1008 ret = perf_read_values_init(&rep->show_threads_values);
1009 if (ret)
1010 return ret;
1011 }
1012
1013 ret = report__setup_sample_type(rep);
1014 if (ret) {
1015 /* report__setup_sample_type() already showed error message */
1016 return ret;
1017 }
1018
1019 if (rep->stats_mode)
1020 stats_setup(rep);
1021
1022 if (rep->tasks_mode)
1023 tasks_setup(rep);
1024
1025 ret = perf_session__process_events(session);
1026 if (ret) {
1027 ui__error("failed to process sample\n");
1028 return ret;
1029 }
1030
1031 evlist__check_mem_load_aux(session->evlist);
1032
1033 if (rep->stats_mode)
1034 return stats_print(rep);
1035
1036 if (rep->tasks_mode)
1037 return tasks_print(rep, stdout);
1038
1039 report__warn_kptr_restrict(rep);
1040
1041 evlist__for_each_entry(session->evlist, pos)
1042 rep->nr_entries += evsel__hists(pos)->nr_entries;
1043
1044 if (use_browser == 0) {
1045 if (verbose > 3)
1046 perf_session__fprintf(session, stdout);
1047
1048 if (verbose > 2)
1049 perf_session__fprintf_dsos(session, stdout);
1050
1051 if (dump_trace) {
1052 perf_session__fprintf_nr_events(session, stdout,
1053 rep->skip_empty);
1054 evlist__fprintf_nr_events(session->evlist, stdout,
1055 rep->skip_empty);
1056 return 0;
1057 }
1058 }
1059
1060 ret = report__collapse_hists(rep);
1061 if (ret) {
1062 ui__error("failed to process hist entry\n");
1063 return ret;
1064 }
1065
1066 if (session_done())
1067 return 0;
1068
1069 /*
1070 * recalculate number of entries after collapsing since it
1071 * might be changed during the collapse phase.
1072 */
1073 rep->nr_entries = 0;
1074 evlist__for_each_entry(session->evlist, pos)
1075 rep->nr_entries += evsel__hists(pos)->nr_entries;
1076
1077 if (rep->nr_entries == 0) {
1078 ui__error("The %s data has no samples!\n", data->path);
1079 return 0;
1080 }
1081
1082 report__output_resort(rep);
1083
1084 if (rep->total_cycles_mode) {
1085 int block_hpps[6] = {
1086 PERF_HPP_REPORT__BLOCK_TOTAL_CYCLES_PCT,
1087 PERF_HPP_REPORT__BLOCK_LBR_CYCLES,
1088 PERF_HPP_REPORT__BLOCK_CYCLES_PCT,
1089 PERF_HPP_REPORT__BLOCK_AVG_CYCLES,
1090 PERF_HPP_REPORT__BLOCK_RANGE,
1091 PERF_HPP_REPORT__BLOCK_DSO,
1092 };
1093
1094 rep->block_reports = block_info__create_report(session->evlist,
1095 rep->total_cycles,
1096 block_hpps, 6,
1097 &rep->nr_block_reports);
1098 if (!rep->block_reports)
1099 return -1;
1100 }
1101
1102 return report__browse_hists(rep);
1103}
1104
1105static int
1106report_parse_callchain_opt(const struct option *opt, const char *arg, int unset)
1107{
1108 struct callchain_param *callchain = opt->value;
1109
1110 callchain->enabled = !unset;
1111 /*
1112 * --no-call-graph
1113 */
1114 if (unset) {
1115 symbol_conf.use_callchain = false;
1116 callchain->mode = CHAIN_NONE;
1117 return 0;
1118 }
1119
1120 return parse_callchain_report_opt(arg);
1121}
1122
1123static int
1124parse_time_quantum(const struct option *opt, const char *arg,
1125 int unset __maybe_unused)
1126{
1127 unsigned long *time_q = opt->value;
1128 char *end;
1129
1130 *time_q = strtoul(arg, &end, 0);
1131 if (end == arg)
1132 goto parse_err;
1133 if (*time_q == 0) {
1134 pr_err("time quantum cannot be 0");
1135 return -1;
1136 }
1137 end = skip_spaces(end);
1138 if (*end == 0)
1139 return 0;
1140 if (!strcmp(end, "s")) {
1141 *time_q *= NSEC_PER_SEC;
1142 return 0;
1143 }
1144 if (!strcmp(end, "ms")) {
1145 *time_q *= NSEC_PER_MSEC;
1146 return 0;
1147 }
1148 if (!strcmp(end, "us")) {
1149 *time_q *= NSEC_PER_USEC;
1150 return 0;
1151 }
1152 if (!strcmp(end, "ns"))
1153 return 0;
1154parse_err:
1155 pr_err("Cannot parse time quantum `%s'\n", arg);
1156 return -1;
1157}
1158
1159int
1160report_parse_ignore_callees_opt(const struct option *opt __maybe_unused,
1161 const char *arg, int unset __maybe_unused)
1162{
1163 if (arg) {
1164 int err = regcomp(&ignore_callees_regex, arg, REG_EXTENDED);
1165 if (err) {
1166 char buf[BUFSIZ];
1167 regerror(err, &ignore_callees_regex, buf, sizeof(buf));
1168 pr_err("Invalid --ignore-callees regex: %s\n%s", arg, buf);
1169 return -1;
1170 }
1171 have_ignore_callees = 1;
1172 }
1173
1174 return 0;
1175}
1176
1177static int
1178parse_branch_mode(const struct option *opt,
1179 const char *str __maybe_unused, int unset)
1180{
1181 int *branch_mode = opt->value;
1182
1183 *branch_mode = !unset;
1184 return 0;
1185}
1186
1187static int
1188parse_percent_limit(const struct option *opt, const char *str,
1189 int unset __maybe_unused)
1190{
1191 struct report *rep = opt->value;
1192 double pcnt = strtof(str, NULL);
1193
1194 rep->min_percent = pcnt;
1195 callchain_param.min_percent = pcnt;
1196 return 0;
1197}
1198
1199static int process_attr(struct perf_tool *tool __maybe_unused,
1200 union perf_event *event,
1201 struct evlist **pevlist)
1202{
1203 u64 sample_type;
1204 int err;
1205
1206 err = perf_event__process_attr(tool, event, pevlist);
1207 if (err)
1208 return err;
1209
1210 /*
1211 * Check if we need to enable callchains based
1212 * on events sample_type.
1213 */
1214 sample_type = evlist__combined_sample_type(*pevlist);
1215 callchain_param_setup(sample_type, perf_env__arch((*pevlist)->env));
1216 return 0;
1217}
1218
1219int cmd_report(int argc, const char **argv)
1220{
1221 struct perf_session *session;
1222 struct itrace_synth_opts itrace_synth_opts = { .set = 0, };
1223 struct stat st;
1224 bool has_br_stack = false;
1225 int branch_mode = -1;
1226 int last_key = 0;
1227 bool branch_call_mode = false;
1228#define CALLCHAIN_DEFAULT_OPT "graph,0.5,caller,function,percent"
1229 static const char report_callchain_help[] = "Display call graph (stack chain/backtrace):\n\n"
1230 CALLCHAIN_REPORT_HELP
1231 "\n\t\t\t\tDefault: " CALLCHAIN_DEFAULT_OPT;
1232 char callchain_default_opt[] = CALLCHAIN_DEFAULT_OPT;
1233 const char * const report_usage[] = {
1234 "perf report [<options>]",
1235 NULL
1236 };
1237 struct report report = {
1238 .tool = {
1239 .sample = process_sample_event,
1240 .mmap = perf_event__process_mmap,
1241 .mmap2 = perf_event__process_mmap2,
1242 .comm = perf_event__process_comm,
1243 .namespaces = perf_event__process_namespaces,
1244 .cgroup = perf_event__process_cgroup,
1245 .exit = perf_event__process_exit,
1246 .fork = perf_event__process_fork,
1247 .lost = perf_event__process_lost,
1248 .read = process_read_event,
1249 .attr = process_attr,
1250#ifdef HAVE_LIBTRACEEVENT
1251 .tracing_data = perf_event__process_tracing_data,
1252#endif
1253 .build_id = perf_event__process_build_id,
1254 .id_index = perf_event__process_id_index,
1255 .auxtrace_info = perf_event__process_auxtrace_info,
1256 .auxtrace = perf_event__process_auxtrace,
1257 .event_update = perf_event__process_event_update,
1258 .feature = process_feature_event,
1259 .ordered_events = true,
1260 .ordering_requires_timestamps = true,
1261 },
1262 .max_stack = PERF_MAX_STACK_DEPTH,
1263 .pretty_printing_style = "normal",
1264 .socket_filter = -1,
1265 .skip_empty = true,
1266 };
1267 char *sort_order_help = sort_help("sort by key(s):");
1268 char *field_order_help = sort_help("output field(s): overhead period sample ");
1269 const char *disassembler_style = NULL, *objdump_path = NULL, *addr2line_path = NULL;
1270 const struct option options[] = {
1271 OPT_STRING('i', "input", &input_name, "file",
1272 "input file name"),
1273 OPT_INCR('v', "verbose", &verbose,
1274 "be more verbose (show symbol address, etc)"),
1275 OPT_BOOLEAN('q', "quiet", &quiet, "Do not show any warnings or messages"),
1276 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
1277 "dump raw trace in ASCII"),
1278 OPT_BOOLEAN(0, "stats", &report.stats_mode, "Display event stats"),
1279 OPT_BOOLEAN(0, "tasks", &report.tasks_mode, "Display recorded tasks"),
1280 OPT_BOOLEAN(0, "mmaps", &report.mmaps_mode, "Display recorded tasks memory maps"),
1281 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
1282 "file", "vmlinux pathname"),
1283 OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux,
1284 "don't load vmlinux even if found"),
1285 OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
1286 "file", "kallsyms pathname"),
1287 OPT_BOOLEAN('f', "force", &symbol_conf.force, "don't complain, do it"),
1288 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
1289 "load module symbols - WARNING: use only with -k and LIVE kernel"),
1290 OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
1291 "Show a column with the number of samples"),
1292 OPT_BOOLEAN('T', "threads", &report.show_threads,
1293 "Show per-thread event counters"),
1294 OPT_STRING(0, "pretty", &report.pretty_printing_style, "key",
1295 "pretty printing style key: normal raw"),
1296#ifdef HAVE_SLANG_SUPPORT
1297 OPT_BOOLEAN(0, "tui", &report.use_tui, "Use the TUI interface"),
1298#endif
1299#ifdef HAVE_GTK2_SUPPORT
1300 OPT_BOOLEAN(0, "gtk", &report.use_gtk, "Use the GTK2 interface"),
1301#endif
1302 OPT_BOOLEAN(0, "stdio", &report.use_stdio,
1303 "Use the stdio interface"),
1304 OPT_BOOLEAN(0, "header", &report.header, "Show data header."),
1305 OPT_BOOLEAN(0, "header-only", &report.header_only,
1306 "Show only data header."),
1307 OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
1308 sort_order_help),
1309 OPT_STRING('F', "fields", &field_order, "key[,keys...]",
1310 field_order_help),
1311 OPT_BOOLEAN(0, "show-cpu-utilization", &symbol_conf.show_cpu_utilization,
1312 "Show sample percentage for different cpu modes"),
1313 OPT_BOOLEAN_FLAG(0, "showcpuutilization", &symbol_conf.show_cpu_utilization,
1314 "Show sample percentage for different cpu modes", PARSE_OPT_HIDDEN),
1315 OPT_STRING('p', "parent", &parent_pattern, "regex",
1316 "regex filter to identify parent, see: '--sort parent'"),
1317 OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other,
1318 "Only display entries with parent-match"),
1319 OPT_CALLBACK_DEFAULT('g', "call-graph", &callchain_param,
1320 "print_type,threshold[,print_limit],order,sort_key[,branch],value",
1321 report_callchain_help, &report_parse_callchain_opt,
1322 callchain_default_opt),
1323 OPT_BOOLEAN(0, "children", &symbol_conf.cumulate_callchain,
1324 "Accumulate callchains of children and show total overhead as well. "
1325 "Enabled by default, use --no-children to disable."),
1326 OPT_INTEGER(0, "max-stack", &report.max_stack,
1327 "Set the maximum stack depth when parsing the callchain, "
1328 "anything beyond the specified depth will be ignored. "
1329 "Default: kernel.perf_event_max_stack or " __stringify(PERF_MAX_STACK_DEPTH)),
1330 OPT_BOOLEAN('G', "inverted", &report.inverted_callchain,
1331 "alias for inverted call graph"),
1332 OPT_CALLBACK(0, "ignore-callees", NULL, "regex",
1333 "ignore callees of these functions in call graphs",
1334 report_parse_ignore_callees_opt),
1335 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
1336 "only consider symbols in these dsos"),
1337 OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
1338 "only consider symbols in these comms"),
1339 OPT_STRING(0, "pid", &symbol_conf.pid_list_str, "pid[,pid...]",
1340 "only consider symbols in these pids"),
1341 OPT_STRING(0, "tid", &symbol_conf.tid_list_str, "tid[,tid...]",
1342 "only consider symbols in these tids"),
1343 OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
1344 "only consider these symbols"),
1345 OPT_STRING(0, "symbol-filter", &report.symbol_filter_str, "filter",
1346 "only show symbols that (partially) match with this filter"),
1347 OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
1348 "width[,width...]",
1349 "don't try to adjust column width, use these fixed values"),
1350 OPT_STRING_NOEMPTY('t', "field-separator", &symbol_conf.field_sep, "separator",
1351 "separator for columns, no spaces will be added between "
1352 "columns '.' is reserved."),
1353 OPT_BOOLEAN('U', "hide-unresolved", &symbol_conf.hide_unresolved,
1354 "Only display entries resolved to a symbol"),
1355 OPT_CALLBACK(0, "symfs", NULL, "directory",
1356 "Look for files with symbols relative to this directory",
1357 symbol__config_symfs),
1358 OPT_STRING('C', "cpu", &report.cpu_list, "cpu",
1359 "list of cpus to profile"),
1360 OPT_BOOLEAN('I', "show-info", &report.show_full_info,
1361 "Display extended information about perf.data file"),
1362 OPT_BOOLEAN(0, "source", &annotate_opts.annotate_src,
1363 "Interleave source code with assembly code (default)"),
1364 OPT_BOOLEAN(0, "asm-raw", &annotate_opts.show_asm_raw,
1365 "Display raw encoding of assembly instructions (default)"),
1366 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
1367 "Specify disassembler style (e.g. -M intel for intel syntax)"),
1368 OPT_STRING(0, "prefix", &annotate_opts.prefix, "prefix",
1369 "Add prefix to source file path names in programs (with --prefix-strip)"),
1370 OPT_STRING(0, "prefix-strip", &annotate_opts.prefix_strip, "N",
1371 "Strip first N entries of source file path name in programs (with --prefix)"),
1372 OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
1373 "Show a column with the sum of periods"),
1374 OPT_BOOLEAN_SET(0, "group", &symbol_conf.event_group, &report.group_set,
1375 "Show event group information together"),
1376 OPT_INTEGER(0, "group-sort-idx", &symbol_conf.group_sort_idx,
1377 "Sort the output by the event at the index n in group. "
1378 "If n is invalid, sort by the first event. "
1379 "WARNING: should be used on grouped events."),
1380 OPT_CALLBACK_NOOPT('b', "branch-stack", &branch_mode, "",
1381 "use branch records for per branch histogram filling",
1382 parse_branch_mode),
1383 OPT_BOOLEAN(0, "branch-history", &branch_call_mode,
1384 "add last branch records to call history"),
1385 OPT_STRING(0, "objdump", &objdump_path, "path",
1386 "objdump binary to use for disassembly and annotations"),
1387 OPT_STRING(0, "addr2line", &addr2line_path, "path",
1388 "addr2line binary to use for line numbers"),
1389 OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
1390 "Disable symbol demangling"),
1391 OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
1392 "Enable kernel symbol demangling"),
1393 OPT_BOOLEAN(0, "mem-mode", &report.mem_mode, "mem access profile"),
1394 OPT_INTEGER(0, "samples", &symbol_conf.res_sample,
1395 "Number of samples to save per histogram entry for individual browsing"),
1396 OPT_CALLBACK(0, "percent-limit", &report, "percent",
1397 "Don't show entries under that percent", parse_percent_limit),
1398 OPT_CALLBACK(0, "percentage", NULL, "relative|absolute",
1399 "how to display percentage of filtered entries", parse_filter_percentage),
1400 OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
1401 "Instruction Tracing options\n" ITRACE_HELP,
1402 itrace_parse_synth_opts),
1403 OPT_BOOLEAN(0, "full-source-path", &srcline_full_filename,
1404 "Show full source file name path for source lines"),
1405 OPT_BOOLEAN(0, "show-ref-call-graph", &symbol_conf.show_ref_callgraph,
1406 "Show callgraph from reference event"),
1407 OPT_BOOLEAN(0, "stitch-lbr", &report.stitch_lbr,
1408 "Enable LBR callgraph stitching approach"),
1409 OPT_INTEGER(0, "socket-filter", &report.socket_filter,
1410 "only show processor socket that match with this filter"),
1411 OPT_BOOLEAN(0, "raw-trace", &symbol_conf.raw_trace,
1412 "Show raw trace event output (do not use print fmt or plugins)"),
1413 OPT_BOOLEAN(0, "hierarchy", &symbol_conf.report_hierarchy,
1414 "Show entries in a hierarchy"),
1415 OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL, "mode",
1416 "'always' (default), 'never' or 'auto' only applicable to --stdio mode",
1417 stdio__config_color, "always"),
1418 OPT_STRING(0, "time", &report.time_str, "str",
1419 "Time span of interest (start,stop)"),
1420 OPT_BOOLEAN(0, "inline", &symbol_conf.inline_name,
1421 "Show inline function"),
1422 OPT_CALLBACK(0, "percent-type", &annotate_opts, "local-period",
1423 "Set percent type local/global-period/hits",
1424 annotate_parse_percent_type),
1425 OPT_BOOLEAN(0, "ns", &symbol_conf.nanosecs, "Show times in nanosecs"),
1426 OPT_CALLBACK(0, "time-quantum", &symbol_conf.time_quantum, "time (ms|us|ns|s)",
1427 "Set time quantum for time sort key (default 100ms)",
1428 parse_time_quantum),
1429 OPTS_EVSWITCH(&report.evswitch),
1430 OPT_BOOLEAN(0, "total-cycles", &report.total_cycles_mode,
1431 "Sort all blocks by 'Sampled Cycles%'"),
1432 OPT_BOOLEAN(0, "disable-order", &report.disable_order,
1433 "Disable raw trace ordering"),
1434 OPT_BOOLEAN(0, "skip-empty", &report.skip_empty,
1435 "Do not display empty (or dummy) events in the output"),
1436 OPT_END()
1437 };
1438 struct perf_data data = {
1439 .mode = PERF_DATA_MODE_READ,
1440 };
1441 int ret = hists__init();
1442 char sort_tmp[128];
1443
1444 if (ret < 0)
1445 goto exit;
1446
1447 /*
1448 * tasks_mode require access to exited threads to list those that are in
1449 * the data file. Off-cpu events are synthesized after other events and
1450 * reference exited threads.
1451 */
1452 symbol_conf.keep_exited_threads = true;
1453
1454 annotation_options__init();
1455
1456 ret = perf_config(report__config, &report);
1457 if (ret)
1458 goto exit;
1459
1460 argc = parse_options(argc, argv, options, report_usage, 0);
1461 if (argc) {
1462 /*
1463 * Special case: if there's an argument left then assume that
1464 * it's a symbol filter:
1465 */
1466 if (argc > 1)
1467 usage_with_options(report_usage, options);
1468
1469 report.symbol_filter_str = argv[0];
1470 }
1471
1472 if (disassembler_style) {
1473 annotate_opts.disassembler_style = strdup(disassembler_style);
1474 if (!annotate_opts.disassembler_style)
1475 return -ENOMEM;
1476 }
1477 if (objdump_path) {
1478 annotate_opts.objdump_path = strdup(objdump_path);
1479 if (!annotate_opts.objdump_path)
1480 return -ENOMEM;
1481 }
1482 if (addr2line_path) {
1483 symbol_conf.addr2line_path = strdup(addr2line_path);
1484 if (!symbol_conf.addr2line_path)
1485 return -ENOMEM;
1486 }
1487
1488 if (annotate_check_args() < 0) {
1489 ret = -EINVAL;
1490 goto exit;
1491 }
1492
1493 if (report.mmaps_mode)
1494 report.tasks_mode = true;
1495
1496 if (dump_trace && report.disable_order)
1497 report.tool.ordered_events = false;
1498
1499 if (quiet)
1500 perf_quiet_option();
1501
1502 ret = symbol__validate_sym_arguments();
1503 if (ret)
1504 goto exit;
1505
1506 if (report.inverted_callchain)
1507 callchain_param.order = ORDER_CALLER;
1508 if (symbol_conf.cumulate_callchain && !callchain_param.order_set)
1509 callchain_param.order = ORDER_CALLER;
1510
1511 if ((itrace_synth_opts.callchain || itrace_synth_opts.add_callchain) &&
1512 (int)itrace_synth_opts.callchain_sz > report.max_stack)
1513 report.max_stack = itrace_synth_opts.callchain_sz;
1514
1515 if (!input_name || !strlen(input_name)) {
1516 if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
1517 input_name = "-";
1518 else
1519 input_name = "perf.data";
1520 }
1521
1522 data.path = input_name;
1523 data.force = symbol_conf.force;
1524
1525repeat:
1526 session = perf_session__new(&data, &report.tool);
1527 if (IS_ERR(session)) {
1528 ret = PTR_ERR(session);
1529 goto exit;
1530 }
1531
1532 ret = evswitch__init(&report.evswitch, session->evlist, stderr);
1533 if (ret)
1534 goto exit;
1535
1536 if (zstd_init(&(session->zstd_data), 0) < 0)
1537 pr_warning("Decompression initialization failed. Reported data may be incomplete.\n");
1538
1539 if (report.queue_size) {
1540 ordered_events__set_alloc_size(&session->ordered_events,
1541 report.queue_size);
1542 }
1543
1544 session->itrace_synth_opts = &itrace_synth_opts;
1545
1546 report.session = session;
1547
1548 has_br_stack = perf_header__has_feat(&session->header,
1549 HEADER_BRANCH_STACK);
1550 if (evlist__combined_sample_type(session->evlist) & PERF_SAMPLE_STACK_USER)
1551 has_br_stack = false;
1552
1553 setup_forced_leader(&report, session->evlist);
1554
1555 if (symbol_conf.group_sort_idx && evlist__nr_groups(session->evlist) == 0) {
1556 parse_options_usage(NULL, options, "group-sort-idx", 0);
1557 ret = -EINVAL;
1558 goto error;
1559 }
1560
1561 if (itrace_synth_opts.last_branch || itrace_synth_opts.add_last_branch)
1562 has_br_stack = true;
1563
1564 if (has_br_stack && branch_call_mode)
1565 symbol_conf.show_branchflag_count = true;
1566
1567 memset(&report.brtype_stat, 0, sizeof(struct branch_type_stat));
1568
1569 /*
1570 * Branch mode is a tristate:
1571 * -1 means default, so decide based on the file having branch data.
1572 * 0/1 means the user chose a mode.
1573 */
1574 if (((branch_mode == -1 && has_br_stack) || branch_mode == 1) &&
1575 !branch_call_mode) {
1576 sort__mode = SORT_MODE__BRANCH;
1577 symbol_conf.cumulate_callchain = false;
1578 }
1579 if (branch_call_mode) {
1580 callchain_param.key = CCKEY_ADDRESS;
1581 callchain_param.branch_callstack = true;
1582 symbol_conf.use_callchain = true;
1583 callchain_register_param(&callchain_param);
1584 if (sort_order == NULL)
1585 sort_order = "srcline,symbol,dso";
1586 }
1587
1588 if (report.mem_mode) {
1589 if (sort__mode == SORT_MODE__BRANCH) {
1590 pr_err("branch and mem mode incompatible\n");
1591 goto error;
1592 }
1593 sort__mode = SORT_MODE__MEMORY;
1594 symbol_conf.cumulate_callchain = false;
1595 }
1596
1597 if (symbol_conf.report_hierarchy) {
1598 /* disable incompatible options */
1599 symbol_conf.cumulate_callchain = false;
1600
1601 if (field_order) {
1602 pr_err("Error: --hierarchy and --fields options cannot be used together\n");
1603 parse_options_usage(report_usage, options, "F", 1);
1604 parse_options_usage(NULL, options, "hierarchy", 0);
1605 goto error;
1606 }
1607
1608 perf_hpp_list.need_collapse = true;
1609 }
1610
1611 if (report.use_stdio)
1612 use_browser = 0;
1613#ifdef HAVE_SLANG_SUPPORT
1614 else if (report.use_tui)
1615 use_browser = 1;
1616#endif
1617#ifdef HAVE_GTK2_SUPPORT
1618 else if (report.use_gtk)
1619 use_browser = 2;
1620#endif
1621
1622 /* Force tty output for header output and per-thread stat. */
1623 if (report.header || report.header_only || report.show_threads)
1624 use_browser = 0;
1625 if (report.header || report.header_only)
1626 report.tool.show_feat_hdr = SHOW_FEAT_HEADER;
1627 if (report.show_full_info)
1628 report.tool.show_feat_hdr = SHOW_FEAT_HEADER_FULL_INFO;
1629 if (report.stats_mode || report.tasks_mode)
1630 use_browser = 0;
1631 if (report.stats_mode && report.tasks_mode) {
1632 pr_err("Error: --tasks and --mmaps can't be used together with --stats\n");
1633 goto error;
1634 }
1635
1636 if (report.total_cycles_mode) {
1637 if (sort__mode != SORT_MODE__BRANCH)
1638 report.total_cycles_mode = false;
1639 else
1640 sort_order = NULL;
1641 }
1642
1643 if (sort_order && strstr(sort_order, "type")) {
1644 report.data_type = true;
1645 annotate_opts.annotate_src = false;
1646
1647#ifndef HAVE_DWARF_GETLOCATIONS_SUPPORT
1648 pr_err("Error: Data type profiling is disabled due to missing DWARF support\n");
1649 goto error;
1650#endif
1651 }
1652
1653 if (strcmp(input_name, "-") != 0)
1654 setup_browser(true);
1655 else
1656 use_browser = 0;
1657
1658 if (sort_order && strstr(sort_order, "ipc")) {
1659 parse_options_usage(report_usage, options, "s", 1);
1660 goto error;
1661 }
1662
1663 if (sort_order && strstr(sort_order, "symbol")) {
1664 if (sort__mode == SORT_MODE__BRANCH) {
1665 snprintf(sort_tmp, sizeof(sort_tmp), "%s,%s",
1666 sort_order, "ipc_lbr");
1667 report.symbol_ipc = true;
1668 } else {
1669 snprintf(sort_tmp, sizeof(sort_tmp), "%s,%s",
1670 sort_order, "ipc_null");
1671 }
1672
1673 sort_order = sort_tmp;
1674 }
1675
1676 if ((last_key != K_SWITCH_INPUT_DATA && last_key != K_RELOAD) &&
1677 (setup_sorting(session->evlist) < 0)) {
1678 if (sort_order)
1679 parse_options_usage(report_usage, options, "s", 1);
1680 if (field_order)
1681 parse_options_usage(sort_order ? NULL : report_usage,
1682 options, "F", 1);
1683 goto error;
1684 }
1685
1686 if ((report.header || report.header_only) && !quiet) {
1687 perf_session__fprintf_info(session, stdout,
1688 report.show_full_info);
1689 if (report.header_only) {
1690 if (data.is_pipe) {
1691 /*
1692 * we need to process first few records
1693 * which contains PERF_RECORD_HEADER_FEATURE.
1694 */
1695 perf_session__process_events(session);
1696 }
1697 ret = 0;
1698 goto error;
1699 }
1700 } else if (use_browser == 0 && !quiet &&
1701 !report.stats_mode && !report.tasks_mode) {
1702 fputs("# To display the perf.data header info, please use --header/--header-only options.\n#\n",
1703 stdout);
1704 }
1705
1706 /*
1707 * Only in the TUI browser we are doing integrated annotation,
1708 * so don't allocate extra space that won't be used in the stdio
1709 * implementation.
1710 */
1711 if (ui__has_annotation() || report.symbol_ipc || report.data_type ||
1712 report.total_cycles_mode) {
1713 ret = symbol__annotation_init();
1714 if (ret < 0)
1715 goto error;
1716 /*
1717 * For searching by name on the "Browse map details".
1718 * providing it only in verbose mode not to bloat too
1719 * much struct symbol.
1720 */
1721 if (verbose > 0) {
1722 /*
1723 * XXX: Need to provide a less kludgy way to ask for
1724 * more space per symbol, the u32 is for the index on
1725 * the ui browser.
1726 * See symbol__browser_index.
1727 */
1728 symbol_conf.priv_size += sizeof(u32);
1729 }
1730 annotation_config__init();
1731 }
1732
1733 if (symbol__init(&session->header.env) < 0)
1734 goto error;
1735
1736 if (report.time_str) {
1737 ret = perf_time__parse_for_ranges(report.time_str, session,
1738 &report.ptime_range,
1739 &report.range_size,
1740 &report.range_num);
1741 if (ret < 0)
1742 goto error;
1743
1744 itrace_synth_opts__set_time_range(&itrace_synth_opts,
1745 report.ptime_range,
1746 report.range_num);
1747 }
1748
1749#ifdef HAVE_LIBTRACEEVENT
1750 if (session->tevent.pevent &&
1751 tep_set_function_resolver(session->tevent.pevent,
1752 machine__resolve_kernel_addr,
1753 &session->machines.host) < 0) {
1754 pr_err("%s: failed to set libtraceevent function resolver\n",
1755 __func__);
1756 return -1;
1757 }
1758#endif
1759 sort__setup_elide(stdout);
1760
1761 ret = __cmd_report(&report);
1762 if (ret == K_SWITCH_INPUT_DATA || ret == K_RELOAD) {
1763 perf_session__delete(session);
1764 last_key = K_SWITCH_INPUT_DATA;
1765 goto repeat;
1766 } else
1767 ret = 0;
1768
1769error:
1770 if (report.ptime_range) {
1771 itrace_synth_opts__clear_time_range(&itrace_synth_opts);
1772 zfree(&report.ptime_range);
1773 }
1774
1775 if (report.block_reports) {
1776 block_info__free_report(report.block_reports,
1777 report.nr_block_reports);
1778 report.block_reports = NULL;
1779 }
1780
1781 zstd_fini(&(session->zstd_data));
1782 perf_session__delete(session);
1783exit:
1784 annotation_options__exit();
1785 free(sort_order_help);
1786 free(field_order_help);
1787 return ret;
1788}