xref: /openbmc/linux/tools/perf/builtin-report.c (revision 7b7dfdd2)
1 /*
2  * builtin-report.c
3  *
4  * Builtin report command: Analyze the perf.data input file,
5  * look up and read DSOs and symbol information and display
6  * a histogram of results, along various sorting keys.
7  */
8 #include "builtin.h"
9 
10 #include "util/util.h"
11 #include "util/cache.h"
12 
13 #include "util/annotate.h"
14 #include "util/color.h"
15 #include <linux/list.h>
16 #include <linux/rbtree.h>
17 #include "util/symbol.h"
18 #include "util/callchain.h"
19 #include "util/strlist.h"
20 #include "util/values.h"
21 
22 #include "perf.h"
23 #include "util/debug.h"
24 #include "util/evlist.h"
25 #include "util/evsel.h"
26 #include "util/header.h"
27 #include "util/session.h"
28 #include "util/tool.h"
29 
30 #include "util/parse-options.h"
31 #include "util/parse-events.h"
32 
33 #include "util/thread.h"
34 #include "util/sort.h"
35 #include "util/hist.h"
36 #include "util/data.h"
37 #include "arch/common.h"
38 
39 #include <dlfcn.h>
40 #include <linux/bitmap.h>
41 
42 struct report {
43 	struct perf_tool	tool;
44 	struct perf_session	*session;
45 	bool			force, use_tui, use_gtk, use_stdio;
46 	bool			hide_unresolved;
47 	bool			dont_use_callchains;
48 	bool			show_full_info;
49 	bool			show_threads;
50 	bool			inverted_callchain;
51 	bool			mem_mode;
52 	bool			header;
53 	bool			header_only;
54 	int			max_stack;
55 	struct perf_read_values	show_threads_values;
56 	const char		*pretty_printing_style;
57 	const char		*cpu_list;
58 	const char		*symbol_filter_str;
59 	float			min_percent;
60 	u64			nr_entries;
61 	DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
62 };
63 
64 static int report__config(const char *var, const char *value, void *cb)
65 {
66 	if (!strcmp(var, "report.group")) {
67 		symbol_conf.event_group = perf_config_bool(var, value);
68 		return 0;
69 	}
70 	if (!strcmp(var, "report.percent-limit")) {
71 		struct report *rep = cb;
72 		rep->min_percent = strtof(value, NULL);
73 		return 0;
74 	}
75 	if (!strcmp(var, "report.children")) {
76 		symbol_conf.cumulate_callchain = perf_config_bool(var, value);
77 		return 0;
78 	}
79 
80 	return perf_default_config(var, value, cb);
81 }
82 
83 static void report__inc_stats(struct report *rep, struct hist_entry *he)
84 {
85 	/*
86 	 * The @he is either of a newly created one or an existing one
87 	 * merging current sample.  We only want to count a new one so
88 	 * checking ->nr_events being 1.
89 	 */
90 	if (he->stat.nr_events == 1)
91 		rep->nr_entries++;
92 }
93 
94 static int hist_iter__report_callback(struct hist_entry_iter *iter,
95 				      struct addr_location *al, bool single,
96 				      void *arg)
97 {
98 	int err = 0;
99 	struct report *rep = arg;
100 	struct hist_entry *he = iter->he;
101 	struct perf_evsel *evsel = iter->evsel;
102 	struct mem_info *mi;
103 	struct branch_info *bi;
104 
105 	report__inc_stats(rep, he);
106 
107 	if (!ui__has_annotation())
108 		return 0;
109 
110 	if (sort__mode == SORT_MODE__BRANCH) {
111 		bi = he->branch_info;
112 		err = addr_map_symbol__inc_samples(&bi->from, evsel->idx);
113 		if (err)
114 			goto out;
115 
116 		err = addr_map_symbol__inc_samples(&bi->to, evsel->idx);
117 
118 	} else if (rep->mem_mode) {
119 		mi = he->mem_info;
120 		err = addr_map_symbol__inc_samples(&mi->daddr, evsel->idx);
121 		if (err)
122 			goto out;
123 
124 		err = hist_entry__inc_addr_samples(he, evsel->idx, al->addr);
125 
126 	} else if (symbol_conf.cumulate_callchain) {
127 		if (single)
128 			err = hist_entry__inc_addr_samples(he, evsel->idx,
129 							   al->addr);
130 	} else {
131 		err = hist_entry__inc_addr_samples(he, evsel->idx, al->addr);
132 	}
133 
134 out:
135 	return err;
136 }
137 
138 static int process_sample_event(struct perf_tool *tool,
139 				union perf_event *event,
140 				struct perf_sample *sample,
141 				struct perf_evsel *evsel,
142 				struct machine *machine)
143 {
144 	struct report *rep = container_of(tool, struct report, tool);
145 	struct addr_location al;
146 	struct hist_entry_iter iter = {
147 		.hide_unresolved = rep->hide_unresolved,
148 		.add_entry_cb = hist_iter__report_callback,
149 	};
150 	int ret;
151 
152 	if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
153 		pr_debug("problem processing %d event, skipping it.\n",
154 			 event->header.type);
155 		return -1;
156 	}
157 
158 	if (rep->hide_unresolved && al.sym == NULL)
159 		return 0;
160 
161 	if (rep->cpu_list && !test_bit(sample->cpu, rep->cpu_bitmap))
162 		return 0;
163 
164 	if (sort__mode == SORT_MODE__BRANCH)
165 		iter.ops = &hist_iter_branch;
166 	else if (rep->mem_mode)
167 		iter.ops = &hist_iter_mem;
168 	else if (symbol_conf.cumulate_callchain)
169 		iter.ops = &hist_iter_cumulative;
170 	else
171 		iter.ops = &hist_iter_normal;
172 
173 	if (al.map != NULL)
174 		al.map->dso->hit = 1;
175 
176 	ret = hist_entry_iter__add(&iter, &al, evsel, sample, rep->max_stack,
177 				   rep);
178 	if (ret < 0)
179 		pr_debug("problem adding hist entry, skipping event\n");
180 
181 	return ret;
182 }
183 
184 static int process_read_event(struct perf_tool *tool,
185 			      union perf_event *event,
186 			      struct perf_sample *sample __maybe_unused,
187 			      struct perf_evsel *evsel,
188 			      struct machine *machine __maybe_unused)
189 {
190 	struct report *rep = container_of(tool, struct report, tool);
191 
192 	if (rep->show_threads) {
193 		const char *name = evsel ? perf_evsel__name(evsel) : "unknown";
194 		perf_read_values_add_value(&rep->show_threads_values,
195 					   event->read.pid, event->read.tid,
196 					   event->read.id,
197 					   name,
198 					   event->read.value);
199 	}
200 
201 	dump_printf(": %d %d %s %" PRIu64 "\n", event->read.pid, event->read.tid,
202 		    evsel ? perf_evsel__name(evsel) : "FAIL",
203 		    event->read.value);
204 
205 	return 0;
206 }
207 
208 /* For pipe mode, sample_type is not currently set */
209 static int report__setup_sample_type(struct report *rep)
210 {
211 	struct perf_session *session = rep->session;
212 	u64 sample_type = perf_evlist__combined_sample_type(session->evlist);
213 	bool is_pipe = perf_data_file__is_pipe(session->file);
214 
215 	if (!is_pipe && !(sample_type & PERF_SAMPLE_CALLCHAIN)) {
216 		if (sort__has_parent) {
217 			ui__error("Selected --sort parent, but no "
218 				    "callchain data. Did you call "
219 				    "'perf record' without -g?\n");
220 			return -EINVAL;
221 		}
222 		if (symbol_conf.use_callchain) {
223 			ui__error("Selected -g but no callchain data. Did "
224 				    "you call 'perf record' without -g?\n");
225 			return -1;
226 		}
227 	} else if (!rep->dont_use_callchains &&
228 		   callchain_param.mode != CHAIN_NONE &&
229 		   !symbol_conf.use_callchain) {
230 			symbol_conf.use_callchain = true;
231 			if (callchain_register_param(&callchain_param) < 0) {
232 				ui__error("Can't register callchain params.\n");
233 				return -EINVAL;
234 			}
235 	}
236 
237 	if (symbol_conf.cumulate_callchain) {
238 		/* Silently ignore if callchain is missing */
239 		if (!(sample_type & PERF_SAMPLE_CALLCHAIN)) {
240 			symbol_conf.cumulate_callchain = false;
241 			perf_hpp__cancel_cumulate();
242 		}
243 	}
244 
245 	if (sort__mode == SORT_MODE__BRANCH) {
246 		if (!is_pipe &&
247 		    !(sample_type & PERF_SAMPLE_BRANCH_STACK)) {
248 			ui__error("Selected -b but no branch data. "
249 				  "Did you call perf record without -b?\n");
250 			return -1;
251 		}
252 	}
253 
254 	return 0;
255 }
256 
257 static void sig_handler(int sig __maybe_unused)
258 {
259 	session_done = 1;
260 }
261 
262 static size_t hists__fprintf_nr_sample_events(struct hists *hists, struct report *rep,
263 					      const char *evname, FILE *fp)
264 {
265 	size_t ret;
266 	char unit;
267 	unsigned long nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
268 	u64 nr_events = hists->stats.total_period;
269 	struct perf_evsel *evsel = hists_to_evsel(hists);
270 	char buf[512];
271 	size_t size = sizeof(buf);
272 
273 	if (symbol_conf.filter_relative) {
274 		nr_samples = hists->stats.nr_non_filtered_samples;
275 		nr_events = hists->stats.total_non_filtered_period;
276 	}
277 
278 	if (perf_evsel__is_group_event(evsel)) {
279 		struct perf_evsel *pos;
280 
281 		perf_evsel__group_desc(evsel, buf, size);
282 		evname = buf;
283 
284 		for_each_group_member(pos, evsel) {
285 			if (symbol_conf.filter_relative) {
286 				nr_samples += pos->hists.stats.nr_non_filtered_samples;
287 				nr_events += pos->hists.stats.total_non_filtered_period;
288 			} else {
289 				nr_samples += pos->hists.stats.nr_events[PERF_RECORD_SAMPLE];
290 				nr_events += pos->hists.stats.total_period;
291 			}
292 		}
293 	}
294 
295 	nr_samples = convert_unit(nr_samples, &unit);
296 	ret = fprintf(fp, "# Samples: %lu%c", nr_samples, unit);
297 	if (evname != NULL)
298 		ret += fprintf(fp, " of event '%s'", evname);
299 
300 	if (rep->mem_mode) {
301 		ret += fprintf(fp, "\n# Total weight : %" PRIu64, nr_events);
302 		ret += fprintf(fp, "\n# Sort order   : %s", sort_order);
303 	} else
304 		ret += fprintf(fp, "\n# Event count (approx.): %" PRIu64, nr_events);
305 	return ret + fprintf(fp, "\n#\n");
306 }
307 
308 static int perf_evlist__tty_browse_hists(struct perf_evlist *evlist,
309 					 struct report *rep,
310 					 const char *help)
311 {
312 	struct perf_evsel *pos;
313 
314 	evlist__for_each(evlist, pos) {
315 		struct hists *hists = &pos->hists;
316 		const char *evname = perf_evsel__name(pos);
317 
318 		if (symbol_conf.event_group &&
319 		    !perf_evsel__is_group_leader(pos))
320 			continue;
321 
322 		hists__fprintf_nr_sample_events(hists, rep, evname, stdout);
323 		hists__fprintf(hists, true, 0, 0, rep->min_percent, stdout);
324 		fprintf(stdout, "\n\n");
325 	}
326 
327 	if (sort_order == default_sort_order &&
328 	    parent_pattern == default_parent_pattern) {
329 		fprintf(stdout, "#\n# (%s)\n#\n", help);
330 
331 		if (rep->show_threads) {
332 			bool style = !strcmp(rep->pretty_printing_style, "raw");
333 			perf_read_values_display(stdout, &rep->show_threads_values,
334 						 style);
335 			perf_read_values_destroy(&rep->show_threads_values);
336 		}
337 	}
338 
339 	return 0;
340 }
341 
342 static void report__warn_kptr_restrict(const struct report *rep)
343 {
344 	struct map *kernel_map = rep->session->machines.host.vmlinux_maps[MAP__FUNCTION];
345 	struct kmap *kernel_kmap = map__kmap(kernel_map);
346 
347 	if (kernel_map == NULL ||
348 	    (kernel_map->dso->hit &&
349 	     (kernel_kmap->ref_reloc_sym == NULL ||
350 	      kernel_kmap->ref_reloc_sym->addr == 0))) {
351 		const char *desc =
352 		    "As no suitable kallsyms nor vmlinux was found, kernel samples\n"
353 		    "can't be resolved.";
354 
355 		if (kernel_map) {
356 			const struct dso *kdso = kernel_map->dso;
357 			if (!RB_EMPTY_ROOT(&kdso->symbols[MAP__FUNCTION])) {
358 				desc = "If some relocation was applied (e.g. "
359 				       "kexec) symbols may be misresolved.";
360 			}
361 		}
362 
363 		ui__warning(
364 "Kernel address maps (/proc/{kallsyms,modules}) were restricted.\n\n"
365 "Check /proc/sys/kernel/kptr_restrict before running 'perf record'.\n\n%s\n\n"
366 "Samples in kernel modules can't be resolved as well.\n\n",
367 		desc);
368 	}
369 }
370 
371 static int report__gtk_browse_hists(struct report *rep, const char *help)
372 {
373 	int (*hist_browser)(struct perf_evlist *evlist, const char *help,
374 			    struct hist_browser_timer *timer, float min_pcnt);
375 
376 	hist_browser = dlsym(perf_gtk_handle, "perf_evlist__gtk_browse_hists");
377 
378 	if (hist_browser == NULL) {
379 		ui__error("GTK browser not found!\n");
380 		return -1;
381 	}
382 
383 	return hist_browser(rep->session->evlist, help, NULL, rep->min_percent);
384 }
385 
386 static int report__browse_hists(struct report *rep)
387 {
388 	int ret;
389 	struct perf_session *session = rep->session;
390 	struct perf_evlist *evlist = session->evlist;
391 	const char *help = "For a higher level overview, try: perf report --sort comm,dso";
392 
393 	switch (use_browser) {
394 	case 1:
395 		ret = perf_evlist__tui_browse_hists(evlist, help, NULL,
396 						    rep->min_percent,
397 						    &session->header.env);
398 		/*
399 		 * Usually "ret" is the last pressed key, and we only
400 		 * care if the key notifies us to switch data file.
401 		 */
402 		if (ret != K_SWITCH_INPUT_DATA)
403 			ret = 0;
404 		break;
405 	case 2:
406 		ret = report__gtk_browse_hists(rep, help);
407 		break;
408 	default:
409 		ret = perf_evlist__tty_browse_hists(evlist, rep, help);
410 		break;
411 	}
412 
413 	return ret;
414 }
415 
416 static void report__collapse_hists(struct report *rep)
417 {
418 	struct ui_progress prog;
419 	struct perf_evsel *pos;
420 
421 	ui_progress__init(&prog, rep->nr_entries, "Merging related events...");
422 
423 	evlist__for_each(rep->session->evlist, pos) {
424 		struct hists *hists = &pos->hists;
425 
426 		if (pos->idx == 0)
427 			hists->symbol_filter_str = rep->symbol_filter_str;
428 
429 		hists__collapse_resort(hists, &prog);
430 
431 		/* Non-group events are considered as leader */
432 		if (symbol_conf.event_group &&
433 		    !perf_evsel__is_group_leader(pos)) {
434 			struct hists *leader_hists = &pos->leader->hists;
435 
436 			hists__match(leader_hists, hists);
437 			hists__link(leader_hists, hists);
438 		}
439 	}
440 
441 	ui_progress__finish();
442 }
443 
444 static int __cmd_report(struct report *rep)
445 {
446 	int ret;
447 	struct perf_session *session = rep->session;
448 	struct perf_evsel *pos;
449 	struct perf_data_file *file = session->file;
450 
451 	signal(SIGINT, sig_handler);
452 
453 	if (rep->cpu_list) {
454 		ret = perf_session__cpu_bitmap(session, rep->cpu_list,
455 					       rep->cpu_bitmap);
456 		if (ret)
457 			return ret;
458 	}
459 
460 	if (rep->show_threads)
461 		perf_read_values_init(&rep->show_threads_values);
462 
463 	ret = report__setup_sample_type(rep);
464 	if (ret)
465 		return ret;
466 
467 	ret = perf_session__process_events(session, &rep->tool);
468 	if (ret)
469 		return ret;
470 
471 	report__warn_kptr_restrict(rep);
472 
473 	if (use_browser == 0) {
474 		if (verbose > 3)
475 			perf_session__fprintf(session, stdout);
476 
477 		if (verbose > 2)
478 			perf_session__fprintf_dsos(session, stdout);
479 
480 		if (dump_trace) {
481 			perf_session__fprintf_nr_events(session, stdout);
482 			return 0;
483 		}
484 	}
485 
486 	report__collapse_hists(rep);
487 
488 	if (session_done())
489 		return 0;
490 
491 	if (rep->nr_entries == 0) {
492 		ui__error("The %s file has no samples!\n", file->path);
493 		return 0;
494 	}
495 
496 	evlist__for_each(session->evlist, pos)
497 		hists__output_resort(&pos->hists);
498 
499 	return report__browse_hists(rep);
500 }
501 
502 static int
503 report_parse_callchain_opt(const struct option *opt, const char *arg, int unset)
504 {
505 	struct report *rep = (struct report *)opt->value;
506 
507 	/*
508 	 * --no-call-graph
509 	 */
510 	if (unset) {
511 		rep->dont_use_callchains = true;
512 		return 0;
513 	}
514 
515 	return parse_callchain_report_opt(arg);
516 }
517 
518 int
519 report_parse_ignore_callees_opt(const struct option *opt __maybe_unused,
520 				const char *arg, int unset __maybe_unused)
521 {
522 	if (arg) {
523 		int err = regcomp(&ignore_callees_regex, arg, REG_EXTENDED);
524 		if (err) {
525 			char buf[BUFSIZ];
526 			regerror(err, &ignore_callees_regex, buf, sizeof(buf));
527 			pr_err("Invalid --ignore-callees regex: %s\n%s", arg, buf);
528 			return -1;
529 		}
530 		have_ignore_callees = 1;
531 	}
532 
533 	return 0;
534 }
535 
536 static int
537 parse_branch_mode(const struct option *opt __maybe_unused,
538 		  const char *str __maybe_unused, int unset)
539 {
540 	int *branch_mode = opt->value;
541 
542 	*branch_mode = !unset;
543 	return 0;
544 }
545 
546 static int
547 parse_percent_limit(const struct option *opt, const char *str,
548 		    int unset __maybe_unused)
549 {
550 	struct report *rep = opt->value;
551 
552 	rep->min_percent = strtof(str, NULL);
553 	return 0;
554 }
555 
556 int cmd_report(int argc, const char **argv, const char *prefix __maybe_unused)
557 {
558 	struct perf_session *session;
559 	struct stat st;
560 	bool has_br_stack = false;
561 	int branch_mode = -1;
562 	int ret = -1;
563 	char callchain_default_opt[] = "fractal,0.5,callee";
564 	const char * const report_usage[] = {
565 		"perf report [<options>]",
566 		NULL
567 	};
568 	struct report report = {
569 		.tool = {
570 			.sample		 = process_sample_event,
571 			.mmap		 = perf_event__process_mmap,
572 			.mmap2		 = perf_event__process_mmap2,
573 			.comm		 = perf_event__process_comm,
574 			.exit		 = perf_event__process_exit,
575 			.fork		 = perf_event__process_fork,
576 			.lost		 = perf_event__process_lost,
577 			.read		 = process_read_event,
578 			.attr		 = perf_event__process_attr,
579 			.tracing_data	 = perf_event__process_tracing_data,
580 			.build_id	 = perf_event__process_build_id,
581 			.ordered_samples = true,
582 			.ordering_requires_timestamps = true,
583 		},
584 		.max_stack		 = PERF_MAX_STACK_DEPTH,
585 		.pretty_printing_style	 = "normal",
586 	};
587 	const struct option options[] = {
588 	OPT_STRING('i', "input", &input_name, "file",
589 		    "input file name"),
590 	OPT_INCR('v', "verbose", &verbose,
591 		    "be more verbose (show symbol address, etc)"),
592 	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
593 		    "dump raw trace in ASCII"),
594 	OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
595 		   "file", "vmlinux pathname"),
596 	OPT_STRING(0, "kallsyms", &symbol_conf.kallsyms_name,
597 		   "file", "kallsyms pathname"),
598 	OPT_BOOLEAN('f', "force", &report.force, "don't complain, do it"),
599 	OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
600 		    "load module symbols - WARNING: use only with -k and LIVE kernel"),
601 	OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
602 		    "Show a column with the number of samples"),
603 	OPT_BOOLEAN('T', "threads", &report.show_threads,
604 		    "Show per-thread event counters"),
605 	OPT_STRING(0, "pretty", &report.pretty_printing_style, "key",
606 		   "pretty printing style key: normal raw"),
607 	OPT_BOOLEAN(0, "tui", &report.use_tui, "Use the TUI interface"),
608 	OPT_BOOLEAN(0, "gtk", &report.use_gtk, "Use the GTK2 interface"),
609 	OPT_BOOLEAN(0, "stdio", &report.use_stdio,
610 		    "Use the stdio interface"),
611 	OPT_BOOLEAN(0, "header", &report.header, "Show data header."),
612 	OPT_BOOLEAN(0, "header-only", &report.header_only,
613 		    "Show only data header."),
614 	OPT_STRING('s', "sort", &sort_order, "key[,key2...]",
615 		   "sort by key(s): pid, comm, dso, symbol, parent, cpu, srcline, ..."
616 		   " Please refer the man page for the complete list."),
617 	OPT_STRING('F', "fields", &field_order, "key[,keys...]",
618 		   "output field(s): overhead, period, sample plus all of sort keys"),
619 	OPT_BOOLEAN(0, "showcpuutilization", &symbol_conf.show_cpu_utilization,
620 		    "Show sample percentage for different cpu modes"),
621 	OPT_STRING('p', "parent", &parent_pattern, "regex",
622 		   "regex filter to identify parent, see: '--sort parent'"),
623 	OPT_BOOLEAN('x', "exclude-other", &symbol_conf.exclude_other,
624 		    "Only display entries with parent-match"),
625 	OPT_CALLBACK_DEFAULT('g', "call-graph", &report, "output_type,min_percent[,print_limit],call_order",
626 		     "Display callchains using output_type (graph, flat, fractal, or none) , min percent threshold, optional print limit, callchain order, key (function or address). "
627 		     "Default: fractal,0.5,callee,function", &report_parse_callchain_opt, callchain_default_opt),
628 	OPT_BOOLEAN(0, "children", &symbol_conf.cumulate_callchain,
629 		    "Accumulate callchains of children and show total overhead as well"),
630 	OPT_INTEGER(0, "max-stack", &report.max_stack,
631 		    "Set the maximum stack depth when parsing the callchain, "
632 		    "anything beyond the specified depth will be ignored. "
633 		    "Default: " __stringify(PERF_MAX_STACK_DEPTH)),
634 	OPT_BOOLEAN('G', "inverted", &report.inverted_callchain,
635 		    "alias for inverted call graph"),
636 	OPT_CALLBACK(0, "ignore-callees", NULL, "regex",
637 		   "ignore callees of these functions in call graphs",
638 		   report_parse_ignore_callees_opt),
639 	OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
640 		   "only consider symbols in these dsos"),
641 	OPT_STRING('c', "comms", &symbol_conf.comm_list_str, "comm[,comm...]",
642 		   "only consider symbols in these comms"),
643 	OPT_STRING('S', "symbols", &symbol_conf.sym_list_str, "symbol[,symbol...]",
644 		   "only consider these symbols"),
645 	OPT_STRING(0, "symbol-filter", &report.symbol_filter_str, "filter",
646 		   "only show symbols that (partially) match with this filter"),
647 	OPT_STRING('w', "column-widths", &symbol_conf.col_width_list_str,
648 		   "width[,width...]",
649 		   "don't try to adjust column width, use these fixed values"),
650 	OPT_STRING('t', "field-separator", &symbol_conf.field_sep, "separator",
651 		   "separator for columns, no spaces will be added between "
652 		   "columns '.' is reserved."),
653 	OPT_BOOLEAN('U', "hide-unresolved", &report.hide_unresolved,
654 		    "Only display entries resolved to a symbol"),
655 	OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
656 		    "Look for files with symbols relative to this directory"),
657 	OPT_STRING('C', "cpu", &report.cpu_list, "cpu",
658 		   "list of cpus to profile"),
659 	OPT_BOOLEAN('I', "show-info", &report.show_full_info,
660 		    "Display extended information about perf.data file"),
661 	OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
662 		    "Interleave source code with assembly code (default)"),
663 	OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
664 		    "Display raw encoding of assembly instructions (default)"),
665 	OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
666 		   "Specify disassembler style (e.g. -M intel for intel syntax)"),
667 	OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
668 		    "Show a column with the sum of periods"),
669 	OPT_BOOLEAN(0, "group", &symbol_conf.event_group,
670 		    "Show event group information together"),
671 	OPT_CALLBACK_NOOPT('b', "branch-stack", &branch_mode, "",
672 		    "use branch records for histogram filling", parse_branch_mode),
673 	OPT_STRING(0, "objdump", &objdump_path, "path",
674 		   "objdump binary to use for disassembly and annotations"),
675 	OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
676 		    "Disable symbol demangling"),
677 	OPT_BOOLEAN(0, "mem-mode", &report.mem_mode, "mem access profile"),
678 	OPT_CALLBACK(0, "percent-limit", &report, "percent",
679 		     "Don't show entries under that percent", parse_percent_limit),
680 	OPT_CALLBACK(0, "percentage", NULL, "relative|absolute",
681 		     "how to display percentage of filtered entries", parse_filter_percentage),
682 	OPT_END()
683 	};
684 	struct perf_data_file file = {
685 		.mode  = PERF_DATA_MODE_READ,
686 	};
687 
688 	perf_config(report__config, &report);
689 
690 	argc = parse_options(argc, argv, options, report_usage, 0);
691 
692 	if (report.use_stdio)
693 		use_browser = 0;
694 	else if (report.use_tui)
695 		use_browser = 1;
696 	else if (report.use_gtk)
697 		use_browser = 2;
698 
699 	if (report.inverted_callchain)
700 		callchain_param.order = ORDER_CALLER;
701 
702 	if (!input_name || !strlen(input_name)) {
703 		if (!fstat(STDIN_FILENO, &st) && S_ISFIFO(st.st_mode))
704 			input_name = "-";
705 		else
706 			input_name = "perf.data";
707 	}
708 
709 	file.path  = input_name;
710 	file.force = report.force;
711 
712 repeat:
713 	session = perf_session__new(&file, false, &report.tool);
714 	if (session == NULL)
715 		return -ENOMEM;
716 
717 	report.session = session;
718 
719 	has_br_stack = perf_header__has_feat(&session->header,
720 					     HEADER_BRANCH_STACK);
721 
722 	if (branch_mode == -1 && has_br_stack) {
723 		sort__mode = SORT_MODE__BRANCH;
724 		symbol_conf.cumulate_callchain = false;
725 	}
726 
727 	if (report.mem_mode) {
728 		if (sort__mode == SORT_MODE__BRANCH) {
729 			pr_err("branch and mem mode incompatible\n");
730 			goto error;
731 		}
732 		sort__mode = SORT_MODE__MEMORY;
733 		symbol_conf.cumulate_callchain = false;
734 	}
735 
736 	if (setup_sorting() < 0) {
737 		if (sort_order)
738 			parse_options_usage(report_usage, options, "s", 1);
739 		if (field_order)
740 			parse_options_usage(sort_order ? NULL : report_usage,
741 					    options, "F", 1);
742 		goto error;
743 	}
744 
745 	/* Force tty output for header output. */
746 	if (report.header || report.header_only)
747 		use_browser = 0;
748 
749 	if (strcmp(input_name, "-") != 0)
750 		setup_browser(true);
751 	else
752 		use_browser = 0;
753 
754 	if (report.header || report.header_only) {
755 		perf_session__fprintf_info(session, stdout,
756 					   report.show_full_info);
757 		if (report.header_only)
758 			return 0;
759 	} else if (use_browser == 0) {
760 		fputs("# To display the perf.data header info, please use --header/--header-only options.\n#\n",
761 		      stdout);
762 	}
763 
764 	/*
765 	 * Only in the TUI browser we are doing integrated annotation,
766 	 * so don't allocate extra space that won't be used in the stdio
767 	 * implementation.
768 	 */
769 	if (ui__has_annotation()) {
770 		symbol_conf.priv_size = sizeof(struct annotation);
771 		machines__set_symbol_filter(&session->machines,
772 					    symbol__annotate_init);
773 		/*
774  		 * For searching by name on the "Browse map details".
775  		 * providing it only in verbose mode not to bloat too
776  		 * much struct symbol.
777  		 */
778 		if (verbose) {
779 			/*
780 			 * XXX: Need to provide a less kludgy way to ask for
781 			 * more space per symbol, the u32 is for the index on
782 			 * the ui browser.
783 			 * See symbol__browser_index.
784 			 */
785 			symbol_conf.priv_size += sizeof(u32);
786 			symbol_conf.sort_by_name = true;
787 		}
788 	}
789 
790 	if (symbol__init() < 0)
791 		goto error;
792 
793 	if (argc) {
794 		/*
795 		 * Special case: if there's an argument left then assume that
796 		 * it's a symbol filter:
797 		 */
798 		if (argc > 1)
799 			usage_with_options(report_usage, options);
800 
801 		report.symbol_filter_str = argv[0];
802 	}
803 
804 	sort__setup_elide(stdout);
805 
806 	ret = __cmd_report(&report);
807 	if (ret == K_SWITCH_INPUT_DATA) {
808 		perf_session__delete(session);
809 		goto repeat;
810 	} else
811 		ret = 0;
812 
813 error:
814 	perf_session__delete(session);
815 	return ret;
816 }
817