1// SPDX-License-Identifier: GPL-2.0
  2/*
  3 * builtin-annotate.c
  4 *
  5 * Builtin annotate 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/color.h"
 12#include <linux/list.h>
 13#include "util/cache.h"
 14#include <linux/rbtree.h>
 15#include <linux/zalloc.h>
 16#include "util/symbol.h"
 17
 
 18#include "util/debug.h"
 19
 20#include "util/evlist.h"
 21#include "util/evsel.h"
 22#include "util/annotate.h"
 23#include "util/annotate-data.h"
 24#include "util/event.h"
 25#include <subcmd/parse-options.h>
 26#include "util/parse-events.h"
 
 27#include "util/sort.h"
 28#include "util/hist.h"
 29#include "util/dso.h"
 30#include "util/machine.h"
 31#include "util/map.h"
 32#include "util/session.h"
 33#include "util/tool.h"
 34#include "util/data.h"
 35#include "arch/common.h"
 36#include "util/block-range.h"
 37#include "util/map_symbol.h"
 38#include "util/branch.h"
 39#include "util/util.h"
 40#include "ui/progress.h"
 41
 42#include <dlfcn.h>
 43#include <errno.h>
 44#include <linux/bitmap.h>
 45#include <linux/err.h>
 46#include <inttypes.h>
 47
 48struct perf_annotate {
 49	struct perf_tool tool;
 50	struct perf_session *session;
 51#ifdef HAVE_SLANG_SUPPORT
 52	bool	   use_tui;
 53#endif
 54	bool	   use_stdio, use_stdio2;
 55#ifdef HAVE_GTK2_SUPPORT
 56	bool	   use_gtk;
 57#endif
 58	bool	   skip_missing;
 59	bool	   has_br_stack;
 60	bool	   group_set;
 61	bool	   data_type;
 62	bool	   type_stat;
 63	bool	   insn_stat;
 64	float	   min_percent;
 65	const char *sym_hist_filter;
 66	const char *cpu_list;
 67	const char *target_data_type;
 68	DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
 69};
 70
 71/*
 72 * Given one basic block:
 73 *
 74 *	from	to		branch_i
 75 *	* ----> *
 76 *		|
 77 *		| block
 78 *		v
 79 *		* ----> *
 80 *		from	to	branch_i+1
 81 *
 82 * where the horizontal are the branches and the vertical is the executed
 83 * block of instructions.
 84 *
 85 * We count, for each 'instruction', the number of blocks that covered it as
 86 * well as count the ratio each branch is taken.
 87 *
 88 * We can do this without knowing the actual instruction stream by keeping
 89 * track of the address ranges. We break down ranges such that there is no
 90 * overlap and iterate from the start until the end.
 91 *
 92 * @acme: once we parse the objdump output _before_ processing the samples,
 93 * we can easily fold the branch.cycles IPC bits in.
 94 */
 95static void process_basic_block(struct addr_map_symbol *start,
 96				struct addr_map_symbol *end,
 97				struct branch_flags *flags)
 98{
 99	struct symbol *sym = start->ms.sym;
100	struct annotation *notes = sym ? symbol__annotation(sym) : NULL;
101	struct block_range_iter iter;
102	struct block_range *entry;
103	struct annotated_branch *branch;
104
105	/*
106	 * Sanity; NULL isn't executable and the CPU cannot execute backwards
107	 */
108	if (!start->addr || start->addr > end->addr)
109		return;
110
111	iter = block_range__create(start->addr, end->addr);
112	if (!block_range_iter__valid(&iter))
113		return;
114
115	branch = annotation__get_branch(notes);
116
117	/*
118	 * First block in range is a branch target.
119	 */
120	entry = block_range_iter(&iter);
121	assert(entry->is_target);
122	entry->entry++;
123
124	do {
125		entry = block_range_iter(&iter);
126
127		entry->coverage++;
128		entry->sym = sym;
129
130		if (branch)
131			branch->max_coverage = max(branch->max_coverage, entry->coverage);
132
133	} while (block_range_iter__next(&iter));
134
135	/*
136	 * Last block in rage is a branch.
137	 */
138	entry = block_range_iter(&iter);
139	assert(entry->is_branch);
140	entry->taken++;
141	if (flags->predicted)
142		entry->pred++;
143}
144
145static void process_branch_stack(struct branch_stack *bs, struct addr_location *al,
146				 struct perf_sample *sample)
147{
148	struct addr_map_symbol *prev = NULL;
149	struct branch_info *bi;
150	int i;
151
152	if (!bs || !bs->nr)
153		return;
154
155	bi = sample__resolve_bstack(sample, al);
156	if (!bi)
157		return;
158
159	for (i = bs->nr - 1; i >= 0; i--) {
160		/*
161		 * XXX filter against symbol
162		 */
163		if (prev)
164			process_basic_block(prev, &bi[i].from, &bi[i].flags);
165		prev = &bi[i].to;
166	}
167
168	free(bi);
169}
170
171static int hist_iter__branch_callback(struct hist_entry_iter *iter,
172				      struct addr_location *al __maybe_unused,
173				      bool single __maybe_unused,
174				      void *arg __maybe_unused)
175{
176	struct hist_entry *he = iter->he;
177	struct branch_info *bi;
178	struct perf_sample *sample = iter->sample;
179	struct evsel *evsel = iter->evsel;
180	int err;
181
182	bi = he->branch_info;
183	err = addr_map_symbol__inc_samples(&bi->from, sample, evsel);
184
185	if (err)
186		goto out;
187
188	err = addr_map_symbol__inc_samples(&bi->to, sample, evsel);
189
190out:
191	return err;
192}
193
194static int process_branch_callback(struct evsel *evsel,
195				   struct perf_sample *sample,
196				   struct addr_location *al,
197				   struct perf_annotate *ann,
198				   struct machine *machine)
199{
200	struct hist_entry_iter iter = {
201		.evsel		= evsel,
202		.sample		= sample,
203		.add_entry_cb	= hist_iter__branch_callback,
204		.hide_unresolved	= symbol_conf.hide_unresolved,
205		.ops		= &hist_iter_branch,
206	};
207	struct addr_location a;
208	int ret;
209
210	addr_location__init(&a);
211	if (machine__resolve(machine, &a, sample) < 0) {
212		ret = -1;
213		goto out;
214	}
215
216	if (a.sym == NULL) {
217		ret = 0;
218		goto out;
219	}
220
221	if (a.map != NULL)
222		dso__set_hit(map__dso(a.map));
223
224	hist__account_cycles(sample->branch_stack, al, sample, false,
225			     NULL, evsel);
226
227	ret = hist_entry_iter__add(&iter, &a, PERF_MAX_STACK_DEPTH, ann);
228out:
229	addr_location__exit(&a);
230	return ret;
231}
232
233static bool has_annotation(struct perf_annotate *ann)
234{
235	return ui__has_annotation() || ann->use_stdio2;
236}
237
238static int evsel__add_sample(struct evsel *evsel, struct perf_sample *sample,
239			     struct addr_location *al, struct perf_annotate *ann,
240			     struct machine *machine)
241{
242	struct hists *hists = evsel__hists(evsel);
243	struct hist_entry *he;
244	int ret;
245
246	if ((!ann->has_br_stack || !has_annotation(ann)) &&
247	    ann->sym_hist_filter != NULL &&
248	    (al->sym == NULL ||
249	     strcmp(ann->sym_hist_filter, al->sym->name) != 0)) {
250		/* We're only interested in a symbol named sym_hist_filter */
251		/*
252		 * FIXME: why isn't this done in the symbol_filter when loading
253		 * the DSO?
254		 */
255		if (al->sym != NULL) {
256			struct dso *dso = map__dso(al->map);
257
258			rb_erase_cached(&al->sym->rb_node, dso__symbols(dso));
259			symbol__delete(al->sym);
260			dso__reset_find_symbol_cache(dso);
261		}
262		return 0;
263	}
264
265	/*
266	 * XXX filtered samples can still have branch entries pointing into our
267	 * symbol and are missed.
268	 */
269	process_branch_stack(sample->branch_stack, al, sample);
270
271	if (ann->has_br_stack && has_annotation(ann))
272		return process_branch_callback(evsel, sample, al, ann, machine);
273
274	he = hists__add_entry(hists, al, NULL, NULL, NULL, NULL, sample, true);
275	if (he == NULL)
276		return -ENOMEM;
277
278	ret = hist_entry__inc_addr_samples(he, sample, evsel, al->addr);
279	hists__inc_nr_samples(hists, true);
 
 
 
 
 
 
 
 
 
 
280	return ret;
281}
282
283static int process_sample_event(const struct perf_tool *tool,
284				union perf_event *event,
285				struct perf_sample *sample,
286				struct evsel *evsel,
287				struct machine *machine)
288{
289	struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool);
290	struct addr_location al;
291	int ret = 0;
292
293	addr_location__init(&al);
294	if (machine__resolve(machine, &al, sample) < 0) {
295		pr_warning("problem processing %d event, skipping it.\n",
296			   event->header.type);
297		ret = -1;
298		goto out_put;
299	}
300
301	if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap))
302		goto out_put;
303
304	if (!al.filtered &&
305	    evsel__add_sample(evsel, sample, &al, ann, machine)) {
306		pr_warning("problem incrementing symbol count, "
307			   "skipping event\n");
308		ret = -1;
309	}
310out_put:
311	addr_location__exit(&al);
312	return ret;
313}
314
315static int process_feature_event(struct perf_session *session,
316				 union perf_event *event)
317{
318	if (event->feat.feat_id < HEADER_LAST_FEATURE)
319		return perf_event__process_feature(session, event);
320	return 0;
321}
322
323static int hist_entry__tty_annotate(struct hist_entry *he,
324				    struct evsel *evsel,
325				    struct perf_annotate *ann)
326{
327	if (!ann->use_stdio2)
328		return symbol__tty_annotate(&he->ms, evsel);
329
330	return symbol__tty_annotate2(&he->ms, evsel);
331}
332
333static void print_annotate_data_stat(struct annotated_data_stat *s)
334{
335#define PRINT_STAT(fld) if (s->fld) printf("%10d : %s\n", s->fld, #fld)
336
337	int bad = s->no_sym +
338			s->no_insn +
339			s->no_insn_ops +
340			s->no_mem_ops +
341			s->no_reg +
342			s->no_dbginfo +
343			s->no_cuinfo +
344			s->no_var +
345			s->no_typeinfo +
346			s->invalid_size +
347			s->bad_offset;
348	int ok = s->total - bad;
349
350	printf("Annotate data type stats:\n");
351	printf("total %d, ok %d (%.1f%%), bad %d (%.1f%%)\n",
352		s->total, ok, 100.0 * ok / (s->total ?: 1), bad, 100.0 * bad / (s->total ?: 1));
353	printf("-----------------------------------------------------------\n");
354	PRINT_STAT(no_sym);
355	PRINT_STAT(no_insn);
356	PRINT_STAT(no_insn_ops);
357	PRINT_STAT(no_mem_ops);
358	PRINT_STAT(no_reg);
359	PRINT_STAT(no_dbginfo);
360	PRINT_STAT(no_cuinfo);
361	PRINT_STAT(no_var);
362	PRINT_STAT(no_typeinfo);
363	PRINT_STAT(invalid_size);
364	PRINT_STAT(bad_offset);
365	PRINT_STAT(insn_track);
366	printf("\n");
367
368#undef PRINT_STAT
369}
370
371static void print_annotate_item_stat(struct list_head *head, const char *title)
372{
373	struct annotated_item_stat *istat, *pos, *iter;
374	int total_good, total_bad, total;
375	int sum1, sum2;
376	LIST_HEAD(tmp);
377
378	/* sort the list by count */
379	list_splice_init(head, &tmp);
380	total_good = total_bad = 0;
381
382	list_for_each_entry_safe(istat, pos, &tmp, list) {
383		total_good += istat->good;
384		total_bad += istat->bad;
385		sum1 = istat->good + istat->bad;
386
387		list_for_each_entry(iter, head, list) {
388			sum2 = iter->good + iter->bad;
389			if (sum1 > sum2)
390				break;
391		}
392		list_move_tail(&istat->list, &iter->list);
393	}
394	total = total_good + total_bad;
395
396	printf("Annotate %s stats\n", title);
397	printf("total %d, ok %d (%.1f%%), bad %d (%.1f%%)\n\n", total,
398	       total_good, 100.0 * total_good / (total ?: 1),
399	       total_bad, 100.0 * total_bad / (total ?: 1));
400	printf("  %-20s: %5s %5s\n", "Name/opcode", "Good", "Bad");
401	printf("-----------------------------------------------------------\n");
402	list_for_each_entry(istat, head, list)
403		printf("  %-20s: %5d %5d\n", istat->name, istat->good, istat->bad);
404	printf("\n");
405}
406
407static void hists__find_annotations(struct hists *hists,
408				    struct evsel *evsel,
409				    struct perf_annotate *ann)
410{
411	struct rb_node *nd = rb_first_cached(&hists->entries), *next;
412	int key = K_RIGHT;
413
414	if (ann->type_stat)
415		print_annotate_data_stat(&ann_data_stat);
416	if (ann->insn_stat)
417		print_annotate_item_stat(&ann_insn_stat, "Instruction");
418
419	while (nd) {
420		struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
421		struct annotation *notes;
422
423		if (he->ms.sym == NULL || dso__annotate_warned(map__dso(he->ms.map)))
424			goto find_next;
425
426		if (ann->sym_hist_filter &&
427		    (strcmp(he->ms.sym->name, ann->sym_hist_filter) != 0))
428			goto find_next;
429
430		if (ann->min_percent) {
431			float percent = 0;
432			u64 total = hists__total_period(hists);
433
434			if (total)
435				percent = 100.0 * he->stat.period / total;
436
437			if (percent < ann->min_percent)
438				goto find_next;
439		}
440
441		notes = symbol__annotation(he->ms.sym);
442		if (notes->src == NULL) {
443find_next:
444			if (key == K_LEFT || key == '<')
445				nd = rb_prev(nd);
446			else
447				nd = rb_next(nd);
448			continue;
449		}
450
451		if (ann->data_type) {
452			/* skip unknown type */
453			if (he->mem_type->histograms == NULL)
454				goto find_next;
455
456			if (ann->target_data_type) {
457				const char *type_name = he->mem_type->self.type_name;
458
459				/* skip 'struct ' prefix in the type name */
460				if (strncmp(ann->target_data_type, "struct ", 7) &&
461				    !strncmp(type_name, "struct ", 7))
462					type_name += 7;
463
464				/* skip 'union ' prefix in the type name */
465				if (strncmp(ann->target_data_type, "union ", 6) &&
466				    !strncmp(type_name, "union ", 6))
467					type_name += 6;
468
469				if (strcmp(ann->target_data_type, type_name))
470					goto find_next;
471			}
472
473			if (use_browser == 1)
474				key = hist_entry__annotate_data_tui(he, evsel, NULL);
475			else
476				key = hist_entry__annotate_data_tty(he, evsel);
477
478			switch (key) {
479			case -1:
480				if (!ann->skip_missing)
481					return;
482				/* fall through */
483			case K_RIGHT:
484			case '>':
485				next = rb_next(nd);
486				break;
487			case K_LEFT:
488			case '<':
489				next = rb_prev(nd);
490				break;
491			default:
492				return;
493			}
494
495			if (use_browser == 0 || next != NULL)
496				nd = next;
497
498			continue;
499		}
500
501		if (use_browser == 2) {
502			int ret;
503			int (*annotate)(struct hist_entry *he,
504					struct evsel *evsel,
505					struct hist_browser_timer *hbt);
506
507			annotate = dlsym(perf_gtk_handle,
508					 "hist_entry__gtk_annotate");
509			if (annotate == NULL) {
510				ui__error("GTK browser not found!\n");
511				return;
512			}
513
514			ret = annotate(he, evsel, NULL);
515			if (!ret || !ann->skip_missing)
516				return;
517
518			/* skip missing symbols */
519			nd = rb_next(nd);
520		} else if (use_browser == 1) {
521			key = hist_entry__tui_annotate(he, evsel, NULL);
522
523			switch (key) {
524			case -1:
525				if (!ann->skip_missing)
526					return;
527				/* fall through */
528			case K_RIGHT:
529			case '>':
530				next = rb_next(nd);
531				break;
532			case K_LEFT:
533			case '<':
534				next = rb_prev(nd);
535				break;
536			default:
537				return;
538			}
539
540			if (next != NULL)
541				nd = next;
542		} else {
543			hist_entry__tty_annotate(he, evsel, ann);
544			nd = rb_next(nd);
 
 
 
 
 
 
 
545		}
546	}
547}
548
549static int __cmd_annotate(struct perf_annotate *ann)
 
 
 
 
 
 
 
 
 
550{
551	int ret;
552	struct perf_session *session = ann->session;
553	struct evsel *pos;
554	u64 total_nr_samples;
555
556	if (ann->cpu_list) {
557		ret = perf_session__cpu_bitmap(session, ann->cpu_list,
558					       ann->cpu_bitmap);
559		if (ret)
560			goto out;
561	}
562
563	if (!annotate_opts.objdump_path) {
564		ret = perf_env__lookup_objdump(&session->header.env,
565					       &annotate_opts.objdump_path);
566		if (ret)
567			goto out;
568	}
569
570	ret = perf_session__process_events(session);
571	if (ret)
572		goto out;
573
574	if (dump_trace) {
575		perf_session__fprintf_nr_events(session, stdout);
576		evlist__fprintf_nr_events(session->evlist, stdout);
577		goto out;
578	}
579
580	if (verbose > 3)
581		perf_session__fprintf(session, stdout);
582
583	if (verbose > 2)
584		perf_session__fprintf_dsos(session, stdout);
585
586	total_nr_samples = 0;
587	evlist__for_each_entry(session->evlist, pos) {
588		struct hists *hists = evsel__hists(pos);
589		u32 nr_samples = hists->stats.nr_samples;
590		struct ui_progress prog;
591
592		if (nr_samples > 0) {
593			total_nr_samples += nr_samples;
594
595			ui_progress__init(&prog, nr_samples,
596					  "Merging related events...");
597			hists__collapse_resort(hists, &prog);
598			ui_progress__finish();
599
600			/* Don't sort callchain */
601			evsel__reset_sample_bit(pos, CALLCHAIN);
602
603			ui_progress__init(&prog, nr_samples,
604					  "Sorting events for output...");
605			evsel__output_resort(pos, &prog);
606			ui_progress__finish();
607
608			/*
609			 * An event group needs to display other events too.
610			 * Let's delay printing until other events are processed.
611			 */
612			if (symbol_conf.event_group) {
613				if (!evsel__is_group_leader(pos)) {
614					struct hists *leader_hists;
615
616					leader_hists = evsel__hists(evsel__leader(pos));
617					hists__match(leader_hists, hists);
618					hists__link(leader_hists, hists);
619				}
620				continue;
621			}
622
623			hists__find_annotations(hists, pos, ann);
624		}
625	}
626
627	if (total_nr_samples == 0) {
628		ui__error("The %s data has no samples!\n", session->data->path);
629		goto out;
630	}
631
632	/* Display group events together */
633	evlist__for_each_entry(session->evlist, pos) {
634		struct hists *hists = evsel__hists(pos);
635		u32 nr_samples = hists->stats.nr_samples;
636		struct ui_progress prog;
637		struct evsel *evsel;
638
639		if (!symbol_conf.event_group || !evsel__is_group_leader(pos))
640			continue;
641
642		for_each_group_member(evsel, pos)
643			nr_samples += evsel__hists(evsel)->stats.nr_samples;
644
645		if (nr_samples == 0)
646			continue;
647
648		ui_progress__init(&prog, nr_samples,
649				  "Sorting group events for output...");
650		evsel__output_resort(pos, &prog);
651		ui_progress__finish();
652
653		hists__find_annotations(hists, pos, ann);
654	}
655
656	if (use_browser == 2) {
657		void (*show_annotations)(void);
658
659		show_annotations = dlsym(perf_gtk_handle,
660					 "perf_gtk__show_annotations");
661		if (show_annotations == NULL) {
662			ui__error("GTK browser not found!\n");
663			goto out;
664		}
665		show_annotations();
666	}
667
668out:
 
 
 
 
 
 
 
 
 
 
 
669	return ret;
670}
671
672static int parse_percent_limit(const struct option *opt, const char *str,
673			       int unset __maybe_unused)
674{
675	struct perf_annotate *ann = opt->value;
676	double pcnt = strtof(str, NULL);
677
678	ann->min_percent = pcnt;
679	return 0;
680}
681
682static int parse_data_type(const struct option *opt, const char *str, int unset)
683{
684	struct perf_annotate *ann = opt->value;
685
686	ann->data_type = !unset;
687	if (str)
688		ann->target_data_type = strdup(str);
689
690	return 0;
691}
692
693static const char * const annotate_usage[] = {
694	"perf annotate [<options>]",
695	NULL
696};
697
698int cmd_annotate(int argc, const char **argv)
699{
700	struct perf_annotate annotate = {};
701	struct perf_data data = {
702		.mode  = PERF_DATA_MODE_READ,
703	};
704	struct itrace_synth_opts itrace_synth_opts = {
705		.set = 0,
706	};
707	const char *disassembler_style = NULL, *objdump_path = NULL, *addr2line_path = NULL;
708	struct option options[] = {
709	OPT_STRING('i', "input", &input_name, "file",
710		    "input file name"),
711	OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
712		   "only consider symbols in these dsos"),
713	OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol",
714		    "symbol to annotate"),
715	OPT_BOOLEAN('f', "force", &data.force, "don't complain, do it"),
716	OPT_INCR('v', "verbose", &verbose,
717		    "be more verbose (show symbol address, etc)"),
718	OPT_BOOLEAN('q', "quiet", &quiet, "do now show any warnings or messages"),
719	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
720		    "dump raw trace in ASCII"),
721#ifdef HAVE_GTK2_SUPPORT
722	OPT_BOOLEAN(0, "gtk", &annotate.use_gtk, "Use the GTK interface"),
723#endif
724#ifdef HAVE_SLANG_SUPPORT
725	OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"),
726#endif
727	OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"),
728	OPT_BOOLEAN(0, "stdio2", &annotate.use_stdio2, "Use the stdio interface"),
729	OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux,
730                    "don't load vmlinux even if found"),
731	OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
732		   "file", "vmlinux pathname"),
733	OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
734		    "load module symbols - WARNING: use only with -k and LIVE kernel"),
735	OPT_BOOLEAN('l', "print-line", &annotate_opts.print_lines,
736		    "print matching source lines (may be slow)"),
737	OPT_BOOLEAN('P', "full-paths", &annotate_opts.full_path,
738		    "Don't shorten the displayed pathnames"),
739	OPT_BOOLEAN(0, "skip-missing", &annotate.skip_missing,
740		    "Skip symbols that cannot be annotated"),
741	OPT_BOOLEAN_SET(0, "group", &symbol_conf.event_group,
742			&annotate.group_set,
743			"Show event group information together"),
744	OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"),
745	OPT_CALLBACK(0, "symfs", NULL, "directory",
746		     "Look for files with symbols relative to this directory",
747		     symbol__config_symfs),
748	OPT_BOOLEAN(0, "source", &annotate_opts.annotate_src,
749		    "Interleave source code with assembly code (default)"),
750	OPT_BOOLEAN(0, "asm-raw", &annotate_opts.show_asm_raw,
751		    "Display raw encoding of assembly instructions (default)"),
752	OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
753		   "Specify disassembler style (e.g. -M intel for intel syntax)"),
754	OPT_STRING(0, "prefix", &annotate_opts.prefix, "prefix",
755		    "Add prefix to source file path names in programs (with --prefix-strip)"),
756	OPT_STRING(0, "prefix-strip", &annotate_opts.prefix_strip, "N",
757		    "Strip first N entries of source file path name in programs (with --prefix)"),
758	OPT_STRING(0, "objdump", &objdump_path, "path",
759		   "objdump binary to use for disassembly and annotations"),
760	OPT_STRING(0, "addr2line", &addr2line_path, "path",
761		   "addr2line binary to use for line numbers"),
762	OPT_BOOLEAN(0, "demangle", &symbol_conf.demangle,
763		    "Enable symbol demangling"),
764	OPT_BOOLEAN(0, "demangle-kernel", &symbol_conf.demangle_kernel,
765		    "Enable kernel symbol demangling"),
766	OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
767		    "Show a column with the sum of periods"),
768	OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
769		    "Show a column with the number of samples"),
770	OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL, "mode",
771			     "'always' (default), 'never' or 'auto' only applicable to --stdio mode",
772			     stdio__config_color, "always"),
773	OPT_CALLBACK(0, "percent-type", &annotate_opts, "local-period",
774		     "Set percent type local/global-period/hits",
775		     annotate_parse_percent_type),
776	OPT_CALLBACK(0, "percent-limit", &annotate, "percent",
777		     "Don't show entries under that percent", parse_percent_limit),
778	OPT_CALLBACK_OPTARG(0, "itrace", &itrace_synth_opts, NULL, "opts",
779			    "Instruction Tracing options\n" ITRACE_HELP,
780			    itrace_parse_synth_opts),
781	OPT_CALLBACK_OPTARG(0, "data-type", &annotate, NULL, "name",
782			    "Show data type annotate for the memory accesses",
783			    parse_data_type),
784	OPT_BOOLEAN(0, "type-stat", &annotate.type_stat,
785		    "Show stats for the data type annotation"),
786	OPT_BOOLEAN(0, "insn-stat", &annotate.insn_stat,
787		    "Show instruction stats for the data type annotation"),
788	OPT_BOOLEAN(0, "skip-empty", &symbol_conf.skip_empty,
789		    "Do not display empty (or dummy) events in the output"),
790	OPT_END()
791	};
792	int ret;
793
794	set_option_flag(options, 0, "show-total-period", PARSE_OPT_EXCLUSIVE);
795	set_option_flag(options, 0, "show-nr-samples", PARSE_OPT_EXCLUSIVE);
 
796
797	annotation_options__init();
 
 
 
798
799	ret = hists__init();
800	if (ret < 0)
801		return ret;
802
803	annotation_config__init();
 
 
 
 
 
 
804
805	argc = parse_options(argc, argv, options, annotate_usage, 0);
806	if (argc) {
807		/*
808		 * Special case: if there's an argument left then assume that
809		 * it's a symbol filter:
810		 */
811		if (argc > 1)
812			usage_with_options(annotate_usage, options);
813
814		annotate.sym_hist_filter = argv[0];
815	}
816
817	if (disassembler_style) {
818		annotate_opts.disassembler_style = strdup(disassembler_style);
819		if (!annotate_opts.disassembler_style)
820			return -ENOMEM;
821	}
822	if (objdump_path) {
823		annotate_opts.objdump_path = strdup(objdump_path);
824		if (!annotate_opts.objdump_path)
825			return -ENOMEM;
826	}
827	if (addr2line_path) {
828		symbol_conf.addr2line_path = strdup(addr2line_path);
829		if (!symbol_conf.addr2line_path)
830			return -ENOMEM;
831	}
832
833	if (annotate_check_args() < 0)
834		return -EINVAL;
835
836#ifdef HAVE_GTK2_SUPPORT
837	if (symbol_conf.show_nr_samples && annotate.use_gtk) {
838		pr_err("--show-nr-samples is not available in --gtk mode at this time\n");
839		return ret;
840	}
841#endif
842
843#ifndef HAVE_LIBDW_SUPPORT
844	if (annotate.data_type) {
845		pr_err("Error: Data type profiling is disabled due to missing DWARF support\n");
846		return -ENOTSUP;
847	}
848#endif
849
850	ret = symbol__validate_sym_arguments();
851	if (ret)
852		return ret;
853
854	if (quiet)
855		perf_quiet_option();
856
857	data.path = input_name;
858
859	perf_tool__init(&annotate.tool, /*ordered_events=*/true);
860	annotate.tool.sample	= process_sample_event;
861	annotate.tool.mmap	= perf_event__process_mmap;
862	annotate.tool.mmap2	= perf_event__process_mmap2;
863	annotate.tool.comm	= perf_event__process_comm;
864	annotate.tool.exit	= perf_event__process_exit;
865	annotate.tool.fork	= perf_event__process_fork;
866	annotate.tool.namespaces = perf_event__process_namespaces;
867	annotate.tool.attr	= perf_event__process_attr;
868	annotate.tool.build_id = perf_event__process_build_id;
869#ifdef HAVE_LIBTRACEEVENT
870	annotate.tool.tracing_data   = perf_event__process_tracing_data;
871#endif
872	annotate.tool.id_index	= perf_event__process_id_index;
873	annotate.tool.auxtrace_info	= perf_event__process_auxtrace_info;
874	annotate.tool.auxtrace	= perf_event__process_auxtrace;
875	annotate.tool.feature	= process_feature_event;
876	annotate.tool.ordering_requires_timestamps = true;
877
878	annotate.session = perf_session__new(&data, &annotate.tool);
879	if (IS_ERR(annotate.session))
880		return PTR_ERR(annotate.session);
881
882	annotate.session->itrace_synth_opts = &itrace_synth_opts;
883
884	annotate.has_br_stack = perf_header__has_feat(&annotate.session->header,
885						      HEADER_BRANCH_STACK);
886
887	if (annotate.group_set)
888		evlist__force_leader(annotate.session->evlist);
889
890	ret = symbol__annotation_init();
891	if (ret < 0)
892		goto out_delete;
893
894	symbol_conf.try_vmlinux_path = true;
895
896	ret = symbol__init(&annotate.session->header.env);
897	if (ret < 0)
898		goto out_delete;
899
900	if (annotate.use_stdio || annotate.use_stdio2)
901		use_browser = 0;
902#ifdef HAVE_SLANG_SUPPORT
903	else if (annotate.use_tui)
904		use_browser = 1;
905#endif
906#ifdef HAVE_GTK2_SUPPORT
907	else if (annotate.use_gtk)
908		use_browser = 2;
909#endif
910
911	if (annotate.data_type) {
912		annotate_opts.annotate_src = false;
913		symbol_conf.annotate_data_member = true;
914		symbol_conf.annotate_data_sample = true;
915	}
916
917	setup_browser(true);
918
919	/*
920	 * Events of different processes may correspond to the same
921	 * symbol, we do not care about the processes in annotate,
922	 * set sort order to avoid repeated output.
923	 */
924	if (annotate.data_type)
925		sort_order = "dso,type";
926	else
927		sort_order = "dso,symbol";
928
929	/*
930	 * Set SORT_MODE__BRANCH so that annotate displays IPC/Cycle and
931	 * branch counters, if the corresponding branch info is available
932	 * in the perf data in the TUI mode.
933	 */
934	if ((use_browser == 1 || annotate.use_stdio2) && annotate.has_br_stack) {
935		sort__mode = SORT_MODE__BRANCH;
936		if (annotate.session->evlist->nr_br_cntr > 0)
937			annotate_opts.show_br_cntr = true;
938	}
939
940	if (setup_sorting(NULL) < 0)
941		usage_with_options(annotate_usage, options);
942
943	ret = __cmd_annotate(&annotate);
944
945out_delete:
946	/*
947	 * Speed up the exit process by only deleting for debug builds. For
948	 * large files this can save time.
949	 */
950#ifndef NDEBUG
951	perf_session__delete(annotate.session);
952#endif
953	annotation_options__exit();
954
955	return ret;
956}