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