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