Linux Audio

Check our new training course

Loading...
v4.6
  1/*
  2 * builtin-annotate.c
  3 *
  4 * Builtin annotate 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/color.h"
 12#include <linux/list.h>
 13#include "util/cache.h"
 14#include <linux/rbtree.h>
 15#include "util/symbol.h"
 16
 17#include "perf.h"
 18#include "util/debug.h"
 19
 20#include "util/evlist.h"
 21#include "util/evsel.h"
 22#include "util/annotate.h"
 23#include "util/event.h"
 24#include <subcmd/parse-options.h>
 25#include "util/parse-events.h"
 26#include "util/thread.h"
 27#include "util/sort.h"
 28#include "util/hist.h"
 29#include "util/session.h"
 30#include "util/tool.h"
 31#include "util/data.h"
 32#include "arch/common.h"
 
 33
 34#include <dlfcn.h>
 35#include <linux/bitmap.h>
 36
 37struct perf_annotate {
 38	struct perf_tool tool;
 39	struct perf_session *session;
 40	bool	   use_tui, use_stdio, use_gtk;
 41	bool	   full_paths;
 42	bool	   print_line;
 43	bool	   skip_missing;
 44	const char *sym_hist_filter;
 45	const char *cpu_list;
 46	DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
 47};
 48
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 49static int perf_evsel__add_sample(struct perf_evsel *evsel,
 50				  struct perf_sample *sample,
 51				  struct addr_location *al,
 52				  struct perf_annotate *ann)
 53{
 54	struct hists *hists = evsel__hists(evsel);
 55	struct hist_entry *he;
 56	int ret;
 57
 58	if (ann->sym_hist_filter != NULL &&
 59	    (al->sym == NULL ||
 60	     strcmp(ann->sym_hist_filter, al->sym->name) != 0)) {
 61		/* We're only interested in a symbol named sym_hist_filter */
 62		/*
 63		 * FIXME: why isn't this done in the symbol_filter when loading
 64		 * the DSO?
 65		 */
 66		if (al->sym != NULL) {
 67			rb_erase(&al->sym->rb_node,
 68				 &al->map->dso->symbols[al->map->type]);
 69			symbol__delete(al->sym);
 70			dso__reset_find_symbol_cache(al->map->dso);
 71		}
 72		return 0;
 73	}
 74
 
 
 
 
 
 
 75	sample->period = 1;
 76	sample->weight = 1;
 77
 78	he = __hists__add_entry(hists, al, NULL, NULL, NULL, sample, true);
 79	if (he == NULL)
 80		return -ENOMEM;
 81
 82	ret = hist_entry__inc_addr_samples(he, evsel->idx, al->addr);
 83	hists__inc_nr_samples(hists, true);
 84	return ret;
 85}
 86
 87static int process_sample_event(struct perf_tool *tool,
 88				union perf_event *event,
 89				struct perf_sample *sample,
 90				struct perf_evsel *evsel,
 91				struct machine *machine)
 92{
 93	struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool);
 94	struct addr_location al;
 95	int ret = 0;
 96
 97	if (machine__resolve(machine, &al, sample) < 0) {
 98		pr_warning("problem processing %d event, skipping it.\n",
 99			   event->header.type);
100		return -1;
101	}
102
103	if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap))
104		goto out_put;
105
106	if (!al.filtered && perf_evsel__add_sample(evsel, sample, &al, ann)) {
107		pr_warning("problem incrementing symbol count, "
108			   "skipping event\n");
109		ret = -1;
110	}
111out_put:
112	addr_location__put(&al);
113	return ret;
114}
115
116static int hist_entry__tty_annotate(struct hist_entry *he,
117				    struct perf_evsel *evsel,
118				    struct perf_annotate *ann)
119{
120	return symbol__tty_annotate(he->ms.sym, he->ms.map, evsel,
121				    ann->print_line, ann->full_paths, 0, 0);
122}
123
124static void hists__find_annotations(struct hists *hists,
125				    struct perf_evsel *evsel,
126				    struct perf_annotate *ann)
127{
128	struct rb_node *nd = rb_first(&hists->entries), *next;
129	int key = K_RIGHT;
130
131	while (nd) {
132		struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
133		struct annotation *notes;
134
135		if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned)
136			goto find_next;
137
138		notes = symbol__annotation(he->ms.sym);
139		if (notes->src == NULL) {
140find_next:
141			if (key == K_LEFT)
142				nd = rb_prev(nd);
143			else
144				nd = rb_next(nd);
145			continue;
146		}
147
148		if (use_browser == 2) {
149			int ret;
150			int (*annotate)(struct hist_entry *he,
151					struct perf_evsel *evsel,
152					struct hist_browser_timer *hbt);
153
154			annotate = dlsym(perf_gtk_handle,
155					 "hist_entry__gtk_annotate");
156			if (annotate == NULL) {
157				ui__error("GTK browser not found!\n");
158				return;
159			}
160
161			ret = annotate(he, evsel, NULL);
162			if (!ret || !ann->skip_missing)
163				return;
164
165			/* skip missing symbols */
166			nd = rb_next(nd);
167		} else if (use_browser == 1) {
168			key = hist_entry__tui_annotate(he, evsel, NULL);
169			switch (key) {
170			case -1:
171				if (!ann->skip_missing)
172					return;
173				/* fall through */
174			case K_RIGHT:
175				next = rb_next(nd);
176				break;
177			case K_LEFT:
178				next = rb_prev(nd);
179				break;
180			default:
181				return;
182			}
183
184			if (next != NULL)
185				nd = next;
186		} else {
187			hist_entry__tty_annotate(he, evsel, ann);
188			nd = rb_next(nd);
189			/*
190			 * Since we have a hist_entry per IP for the same
191			 * symbol, free he->ms.sym->src to signal we already
192			 * processed this symbol.
193			 */
194			zfree(&notes->src->cycles_hist);
195			zfree(&notes->src);
196		}
197	}
198}
199
200static int __cmd_annotate(struct perf_annotate *ann)
201{
202	int ret;
203	struct perf_session *session = ann->session;
204	struct perf_evsel *pos;
205	u64 total_nr_samples;
206
207	machines__set_symbol_filter(&session->machines, symbol__annotate_init);
208
209	if (ann->cpu_list) {
210		ret = perf_session__cpu_bitmap(session, ann->cpu_list,
211					       ann->cpu_bitmap);
212		if (ret)
213			goto out;
214	}
215
216	if (!objdump_path) {
217		ret = perf_env__lookup_objdump(&session->header.env);
218		if (ret)
219			goto out;
220	}
221
222	ret = perf_session__process_events(session);
223	if (ret)
224		goto out;
225
226	if (dump_trace) {
227		perf_session__fprintf_nr_events(session, stdout);
228		perf_evlist__fprintf_nr_events(session->evlist, stdout);
229		goto out;
230	}
231
232	if (verbose > 3)
233		perf_session__fprintf(session, stdout);
234
235	if (verbose > 2)
236		perf_session__fprintf_dsos(session, stdout);
237
238	total_nr_samples = 0;
239	evlist__for_each(session->evlist, pos) {
240		struct hists *hists = evsel__hists(pos);
241		u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
242
243		if (nr_samples > 0) {
244			total_nr_samples += nr_samples;
245			hists__collapse_resort(hists, NULL);
246			/* Don't sort callchain */
247			perf_evsel__reset_sample_bit(pos, CALLCHAIN);
248			perf_evsel__output_resort(pos, NULL);
249
250			if (symbol_conf.event_group &&
251			    !perf_evsel__is_group_leader(pos))
252				continue;
253
254			hists__find_annotations(hists, pos, ann);
255		}
256	}
257
258	if (total_nr_samples == 0) {
259		ui__error("The %s file has no samples!\n", session->file->path);
260		goto out;
261	}
262
263	if (use_browser == 2) {
264		void (*show_annotations)(void);
265
266		show_annotations = dlsym(perf_gtk_handle,
267					 "perf_gtk__show_annotations");
268		if (show_annotations == NULL) {
269			ui__error("GTK browser not found!\n");
270			goto out;
271		}
272		show_annotations();
273	}
274
275out:
276	return ret;
277}
278
279static const char * const annotate_usage[] = {
280	"perf annotate [<options>]",
281	NULL
282};
283
284int cmd_annotate(int argc, const char **argv, const char *prefix __maybe_unused)
285{
286	struct perf_annotate annotate = {
287		.tool = {
288			.sample	= process_sample_event,
289			.mmap	= perf_event__process_mmap,
290			.mmap2	= perf_event__process_mmap2,
291			.comm	= perf_event__process_comm,
292			.exit	= perf_event__process_exit,
293			.fork	= perf_event__process_fork,
294			.ordered_events = true,
295			.ordering_requires_timestamps = true,
296		},
297	};
298	struct perf_data_file file = {
299		.mode  = PERF_DATA_MODE_READ,
300	};
301	const struct option options[] = {
302	OPT_STRING('i', "input", &input_name, "file",
303		    "input file name"),
304	OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
305		   "only consider symbols in these dsos"),
306	OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol",
307		    "symbol to annotate"),
308	OPT_BOOLEAN('f', "force", &file.force, "don't complain, do it"),
309	OPT_INCR('v', "verbose", &verbose,
310		    "be more verbose (show symbol address, etc)"),
311	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
312		    "dump raw trace in ASCII"),
313	OPT_BOOLEAN(0, "gtk", &annotate.use_gtk, "Use the GTK interface"),
314	OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"),
315	OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"),
316	OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
317		   "file", "vmlinux pathname"),
318	OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
319		    "load module symbols - WARNING: use only with -k and LIVE kernel"),
320	OPT_BOOLEAN('l', "print-line", &annotate.print_line,
321		    "print matching source lines (may be slow)"),
322	OPT_BOOLEAN('P', "full-paths", &annotate.full_paths,
323		    "Don't shorten the displayed pathnames"),
324	OPT_BOOLEAN(0, "skip-missing", &annotate.skip_missing,
325		    "Skip symbols that cannot be annotated"),
326	OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"),
327	OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
328		   "Look for files with symbols relative to this directory"),
 
329	OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
330		    "Interleave source code with assembly code (default)"),
331	OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
332		    "Display raw encoding of assembly instructions (default)"),
333	OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
334		   "Specify disassembler style (e.g. -M intel for intel syntax)"),
335	OPT_STRING(0, "objdump", &objdump_path, "path",
336		   "objdump binary to use for disassembly and annotations"),
337	OPT_BOOLEAN(0, "group", &symbol_conf.event_group,
338		    "Show event group information together"),
339	OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
340		    "Show a column with the sum of periods"),
 
 
 
341	OPT_END()
342	};
343	int ret = hists__init();
344
345	if (ret < 0)
346		return ret;
347
348	argc = parse_options(argc, argv, options, annotate_usage, 0);
349	if (argc) {
350		/*
351		 * Special case: if there's an argument left then assume that
352		 * it's a symbol filter:
353		 */
354		if (argc > 1)
355			usage_with_options(annotate_usage, options);
356
357		annotate.sym_hist_filter = argv[0];
358	}
359
360	file.path  = input_name;
361
362	annotate.session = perf_session__new(&file, false, &annotate.tool);
363	if (annotate.session == NULL)
364		return -1;
365
366	symbol_conf.priv_size = sizeof(struct annotation);
 
 
 
367	symbol_conf.try_vmlinux_path = true;
368
369	ret = symbol__init(&annotate.session->header.env);
370	if (ret < 0)
371		goto out_delete;
372
373	if (setup_sorting(NULL) < 0)
374		usage_with_options(annotate_usage, options);
375
376	if (annotate.use_stdio)
377		use_browser = 0;
378	else if (annotate.use_tui)
379		use_browser = 1;
380	else if (annotate.use_gtk)
381		use_browser = 2;
382
383	setup_browser(true);
384
385	ret = __cmd_annotate(&annotate);
386
387out_delete:
388	/*
389	 * Speed up the exit process, for large files this can
390	 * take quite a while.
391	 *
392	 * XXX Enable this when using valgrind or if we ever
393	 * librarize this command.
394	 *
395	 * Also experiment with obstacks to see how much speed
396	 * up we'll get here.
397	 *
398	 * perf_session__delete(session);
399	 */
400	return ret;
401}
v4.10.11
  1/*
  2 * builtin-annotate.c
  3 *
  4 * Builtin annotate 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/color.h"
 12#include <linux/list.h>
 13#include "util/cache.h"
 14#include <linux/rbtree.h>
 15#include "util/symbol.h"
 16
 17#include "perf.h"
 18#include "util/debug.h"
 19
 20#include "util/evlist.h"
 21#include "util/evsel.h"
 22#include "util/annotate.h"
 23#include "util/event.h"
 24#include <subcmd/parse-options.h>
 25#include "util/parse-events.h"
 26#include "util/thread.h"
 27#include "util/sort.h"
 28#include "util/hist.h"
 29#include "util/session.h"
 30#include "util/tool.h"
 31#include "util/data.h"
 32#include "arch/common.h"
 33#include "util/block-range.h"
 34
 35#include <dlfcn.h>
 36#include <linux/bitmap.h>
 37
 38struct perf_annotate {
 39	struct perf_tool tool;
 40	struct perf_session *session;
 41	bool	   use_tui, use_stdio, use_gtk;
 42	bool	   full_paths;
 43	bool	   print_line;
 44	bool	   skip_missing;
 45	const char *sym_hist_filter;
 46	const char *cpu_list;
 47	DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
 48};
 49
 50/*
 51 * Given one basic block:
 52 *
 53 *	from	to		branch_i
 54 *	* ----> *
 55 *		|
 56 *		| block
 57 *		v
 58 *		* ----> *
 59 *		from	to	branch_i+1
 60 *
 61 * where the horizontal are the branches and the vertical is the executed
 62 * block of instructions.
 63 *
 64 * We count, for each 'instruction', the number of blocks that covered it as
 65 * well as count the ratio each branch is taken.
 66 *
 67 * We can do this without knowing the actual instruction stream by keeping
 68 * track of the address ranges. We break down ranges such that there is no
 69 * overlap and iterate from the start until the end.
 70 *
 71 * @acme: once we parse the objdump output _before_ processing the samples,
 72 * we can easily fold the branch.cycles IPC bits in.
 73 */
 74static void process_basic_block(struct addr_map_symbol *start,
 75				struct addr_map_symbol *end,
 76				struct branch_flags *flags)
 77{
 78	struct symbol *sym = start->sym;
 79	struct annotation *notes = sym ? symbol__annotation(sym) : NULL;
 80	struct block_range_iter iter;
 81	struct block_range *entry;
 82
 83	/*
 84	 * Sanity; NULL isn't executable and the CPU cannot execute backwards
 85	 */
 86	if (!start->addr || start->addr > end->addr)
 87		return;
 88
 89	iter = block_range__create(start->addr, end->addr);
 90	if (!block_range_iter__valid(&iter))
 91		return;
 92
 93	/*
 94	 * First block in range is a branch target.
 95	 */
 96	entry = block_range_iter(&iter);
 97	assert(entry->is_target);
 98	entry->entry++;
 99
100	do {
101		entry = block_range_iter(&iter);
102
103		entry->coverage++;
104		entry->sym = sym;
105
106		if (notes)
107			notes->max_coverage = max(notes->max_coverage, entry->coverage);
108
109	} while (block_range_iter__next(&iter));
110
111	/*
112	 * Last block in rage is a branch.
113	 */
114	entry = block_range_iter(&iter);
115	assert(entry->is_branch);
116	entry->taken++;
117	if (flags->predicted)
118		entry->pred++;
119}
120
121static void process_branch_stack(struct branch_stack *bs, struct addr_location *al,
122				 struct perf_sample *sample)
123{
124	struct addr_map_symbol *prev = NULL;
125	struct branch_info *bi;
126	int i;
127
128	if (!bs || !bs->nr)
129		return;
130
131	bi = sample__resolve_bstack(sample, al);
132	if (!bi)
133		return;
134
135	for (i = bs->nr - 1; i >= 0; i--) {
136		/*
137		 * XXX filter against symbol
138		 */
139		if (prev)
140			process_basic_block(prev, &bi[i].from, &bi[i].flags);
141		prev = &bi[i].to;
142	}
143
144	free(bi);
145}
146
147static int perf_evsel__add_sample(struct perf_evsel *evsel,
148				  struct perf_sample *sample,
149				  struct addr_location *al,
150				  struct perf_annotate *ann)
151{
152	struct hists *hists = evsel__hists(evsel);
153	struct hist_entry *he;
154	int ret;
155
156	if (ann->sym_hist_filter != NULL &&
157	    (al->sym == NULL ||
158	     strcmp(ann->sym_hist_filter, al->sym->name) != 0)) {
159		/* We're only interested in a symbol named sym_hist_filter */
160		/*
161		 * FIXME: why isn't this done in the symbol_filter when loading
162		 * the DSO?
163		 */
164		if (al->sym != NULL) {
165			rb_erase(&al->sym->rb_node,
166				 &al->map->dso->symbols[al->map->type]);
167			symbol__delete(al->sym);
168			dso__reset_find_symbol_cache(al->map->dso);
169		}
170		return 0;
171	}
172
173	/*
174	 * XXX filtered samples can still have branch entires pointing into our
175	 * symbol and are missed.
176	 */
177	process_branch_stack(sample->branch_stack, al, sample);
178
179	sample->period = 1;
180	sample->weight = 1;
181
182	he = hists__add_entry(hists, al, NULL, NULL, NULL, sample, true);
183	if (he == NULL)
184		return -ENOMEM;
185
186	ret = hist_entry__inc_addr_samples(he, evsel->idx, al->addr);
187	hists__inc_nr_samples(hists, true);
188	return ret;
189}
190
191static int process_sample_event(struct perf_tool *tool,
192				union perf_event *event,
193				struct perf_sample *sample,
194				struct perf_evsel *evsel,
195				struct machine *machine)
196{
197	struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool);
198	struct addr_location al;
199	int ret = 0;
200
201	if (machine__resolve(machine, &al, sample) < 0) {
202		pr_warning("problem processing %d event, skipping it.\n",
203			   event->header.type);
204		return -1;
205	}
206
207	if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap))
208		goto out_put;
209
210	if (!al.filtered && perf_evsel__add_sample(evsel, sample, &al, ann)) {
211		pr_warning("problem incrementing symbol count, "
212			   "skipping event\n");
213		ret = -1;
214	}
215out_put:
216	addr_location__put(&al);
217	return ret;
218}
219
220static int hist_entry__tty_annotate(struct hist_entry *he,
221				    struct perf_evsel *evsel,
222				    struct perf_annotate *ann)
223{
224	return symbol__tty_annotate(he->ms.sym, he->ms.map, evsel,
225				    ann->print_line, ann->full_paths, 0, 0);
226}
227
228static void hists__find_annotations(struct hists *hists,
229				    struct perf_evsel *evsel,
230				    struct perf_annotate *ann)
231{
232	struct rb_node *nd = rb_first(&hists->entries), *next;
233	int key = K_RIGHT;
234
235	while (nd) {
236		struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
237		struct annotation *notes;
238
239		if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned)
240			goto find_next;
241
242		notes = symbol__annotation(he->ms.sym);
243		if (notes->src == NULL) {
244find_next:
245			if (key == K_LEFT)
246				nd = rb_prev(nd);
247			else
248				nd = rb_next(nd);
249			continue;
250		}
251
252		if (use_browser == 2) {
253			int ret;
254			int (*annotate)(struct hist_entry *he,
255					struct perf_evsel *evsel,
256					struct hist_browser_timer *hbt);
257
258			annotate = dlsym(perf_gtk_handle,
259					 "hist_entry__gtk_annotate");
260			if (annotate == NULL) {
261				ui__error("GTK browser not found!\n");
262				return;
263			}
264
265			ret = annotate(he, evsel, NULL);
266			if (!ret || !ann->skip_missing)
267				return;
268
269			/* skip missing symbols */
270			nd = rb_next(nd);
271		} else if (use_browser == 1) {
272			key = hist_entry__tui_annotate(he, evsel, NULL);
273			switch (key) {
274			case -1:
275				if (!ann->skip_missing)
276					return;
277				/* fall through */
278			case K_RIGHT:
279				next = rb_next(nd);
280				break;
281			case K_LEFT:
282				next = rb_prev(nd);
283				break;
284			default:
285				return;
286			}
287
288			if (next != NULL)
289				nd = next;
290		} else {
291			hist_entry__tty_annotate(he, evsel, ann);
292			nd = rb_next(nd);
293			/*
294			 * Since we have a hist_entry per IP for the same
295			 * symbol, free he->ms.sym->src to signal we already
296			 * processed this symbol.
297			 */
298			zfree(&notes->src->cycles_hist);
299			zfree(&notes->src);
300		}
301	}
302}
303
304static int __cmd_annotate(struct perf_annotate *ann)
305{
306	int ret;
307	struct perf_session *session = ann->session;
308	struct perf_evsel *pos;
309	u64 total_nr_samples;
310
 
 
311	if (ann->cpu_list) {
312		ret = perf_session__cpu_bitmap(session, ann->cpu_list,
313					       ann->cpu_bitmap);
314		if (ret)
315			goto out;
316	}
317
318	if (!objdump_path) {
319		ret = perf_env__lookup_objdump(&session->header.env);
320		if (ret)
321			goto out;
322	}
323
324	ret = perf_session__process_events(session);
325	if (ret)
326		goto out;
327
328	if (dump_trace) {
329		perf_session__fprintf_nr_events(session, stdout);
330		perf_evlist__fprintf_nr_events(session->evlist, stdout);
331		goto out;
332	}
333
334	if (verbose > 3)
335		perf_session__fprintf(session, stdout);
336
337	if (verbose > 2)
338		perf_session__fprintf_dsos(session, stdout);
339
340	total_nr_samples = 0;
341	evlist__for_each_entry(session->evlist, pos) {
342		struct hists *hists = evsel__hists(pos);
343		u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
344
345		if (nr_samples > 0) {
346			total_nr_samples += nr_samples;
347			hists__collapse_resort(hists, NULL);
348			/* Don't sort callchain */
349			perf_evsel__reset_sample_bit(pos, CALLCHAIN);
350			perf_evsel__output_resort(pos, NULL);
351
352			if (symbol_conf.event_group &&
353			    !perf_evsel__is_group_leader(pos))
354				continue;
355
356			hists__find_annotations(hists, pos, ann);
357		}
358	}
359
360	if (total_nr_samples == 0) {
361		ui__error("The %s file has no samples!\n", session->file->path);
362		goto out;
363	}
364
365	if (use_browser == 2) {
366		void (*show_annotations)(void);
367
368		show_annotations = dlsym(perf_gtk_handle,
369					 "perf_gtk__show_annotations");
370		if (show_annotations == NULL) {
371			ui__error("GTK browser not found!\n");
372			goto out;
373		}
374		show_annotations();
375	}
376
377out:
378	return ret;
379}
380
381static const char * const annotate_usage[] = {
382	"perf annotate [<options>]",
383	NULL
384};
385
386int cmd_annotate(int argc, const char **argv, const char *prefix __maybe_unused)
387{
388	struct perf_annotate annotate = {
389		.tool = {
390			.sample	= process_sample_event,
391			.mmap	= perf_event__process_mmap,
392			.mmap2	= perf_event__process_mmap2,
393			.comm	= perf_event__process_comm,
394			.exit	= perf_event__process_exit,
395			.fork	= perf_event__process_fork,
396			.ordered_events = true,
397			.ordering_requires_timestamps = true,
398		},
399	};
400	struct perf_data_file file = {
401		.mode  = PERF_DATA_MODE_READ,
402	};
403	const struct option options[] = {
404	OPT_STRING('i', "input", &input_name, "file",
405		    "input file name"),
406	OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
407		   "only consider symbols in these dsos"),
408	OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol",
409		    "symbol to annotate"),
410	OPT_BOOLEAN('f', "force", &file.force, "don't complain, do it"),
411	OPT_INCR('v', "verbose", &verbose,
412		    "be more verbose (show symbol address, etc)"),
413	OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
414		    "dump raw trace in ASCII"),
415	OPT_BOOLEAN(0, "gtk", &annotate.use_gtk, "Use the GTK interface"),
416	OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"),
417	OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"),
418	OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
419		   "file", "vmlinux pathname"),
420	OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
421		    "load module symbols - WARNING: use only with -k and LIVE kernel"),
422	OPT_BOOLEAN('l', "print-line", &annotate.print_line,
423		    "print matching source lines (may be slow)"),
424	OPT_BOOLEAN('P', "full-paths", &annotate.full_paths,
425		    "Don't shorten the displayed pathnames"),
426	OPT_BOOLEAN(0, "skip-missing", &annotate.skip_missing,
427		    "Skip symbols that cannot be annotated"),
428	OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"),
429	OPT_CALLBACK(0, "symfs", NULL, "directory",
430		     "Look for files with symbols relative to this directory",
431		     symbol__config_symfs),
432	OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
433		    "Interleave source code with assembly code (default)"),
434	OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
435		    "Display raw encoding of assembly instructions (default)"),
436	OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
437		   "Specify disassembler style (e.g. -M intel for intel syntax)"),
438	OPT_STRING(0, "objdump", &objdump_path, "path",
439		   "objdump binary to use for disassembly and annotations"),
440	OPT_BOOLEAN(0, "group", &symbol_conf.event_group,
441		    "Show event group information together"),
442	OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
443		    "Show a column with the sum of periods"),
444	OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL, "mode",
445			     "'always' (default), 'never' or 'auto' only applicable to --stdio mode",
446			     stdio__config_color, "always"),
447	OPT_END()
448	};
449	int ret = hists__init();
450
451	if (ret < 0)
452		return ret;
453
454	argc = parse_options(argc, argv, options, annotate_usage, 0);
455	if (argc) {
456		/*
457		 * Special case: if there's an argument left then assume that
458		 * it's a symbol filter:
459		 */
460		if (argc > 1)
461			usage_with_options(annotate_usage, options);
462
463		annotate.sym_hist_filter = argv[0];
464	}
465
466	file.path  = input_name;
467
468	annotate.session = perf_session__new(&file, false, &annotate.tool);
469	if (annotate.session == NULL)
470		return -1;
471
472	ret = symbol__annotation_init();
473	if (ret < 0)
474		goto out_delete;
475
476	symbol_conf.try_vmlinux_path = true;
477
478	ret = symbol__init(&annotate.session->header.env);
479	if (ret < 0)
480		goto out_delete;
481
482	if (setup_sorting(NULL) < 0)
483		usage_with_options(annotate_usage, options);
484
485	if (annotate.use_stdio)
486		use_browser = 0;
487	else if (annotate.use_tui)
488		use_browser = 1;
489	else if (annotate.use_gtk)
490		use_browser = 2;
491
492	setup_browser(true);
493
494	ret = __cmd_annotate(&annotate);
495
496out_delete:
497	/*
498	 * Speed up the exit process, for large files this can
499	 * take quite a while.
500	 *
501	 * XXX Enable this when using valgrind or if we ever
502	 * librarize this command.
503	 *
504	 * Also experiment with obstacks to see how much speed
505	 * up we'll get here.
506	 *
507	 * perf_session__delete(session);
508	 */
509	return ret;
510}