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