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