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.
10 #include "util/util.h"
12 #include "util/util.h"
13 #include "util/color.h"
14 #include <linux/list.h>
15 #include "util/cache.h"
16 #include <linux/rbtree.h>
17 #include "util/symbol.h"
20 #include "util/debug.h"
22 #include "util/evlist.h"
23 #include "util/evsel.h"
24 #include "util/annotate.h"
25 #include "util/event.h"
26 #include "util/parse-options.h"
27 #include "util/parse-events.h"
28 #include "util/thread.h"
29 #include "util/sort.h"
30 #include "util/hist.h"
31 #include "util/session.h"
33 static char const *input_name = "perf.data";
35 static bool force, use_tui, use_stdio;
37 static bool full_paths;
39 static bool print_line;
41 static const char *sym_hist_filter;
43 static int perf_evlist__add_sample(struct perf_evlist *evlist,
44 struct perf_sample *sample,
45 struct addr_location *al)
47 struct perf_evsel *evsel;
48 struct hist_entry *he;
51 if (sym_hist_filter != NULL &&
52 (al->sym == NULL || strcmp(sym_hist_filter, al->sym->name) != 0)) {
53 /* We're only interested in a symbol named sym_hist_filter */
54 if (al->sym != NULL) {
55 rb_erase(&al->sym->rb_node,
56 &al->map->dso->symbols[al->map->type]);
57 symbol__delete(al->sym);
62 evsel = perf_evlist__id2evsel(evlist, sample->id);
65 * FIXME: Propagate this back, but at least we're in a builtin,
66 * where exit() is allowed. ;-)
68 ui__warning("Invalid %s file, contains samples with id not in "
69 "its header!\n", input_name);
74 he = __hists__add_entry(&evsel->hists, al, NULL, 1);
79 if (he->ms.sym != NULL) {
80 struct annotation *notes = symbol__annotation(he->ms.sym);
81 if (notes->src == NULL &&
82 symbol__alloc_hist(he->ms.sym, evlist->nr_entries) < 0)
85 ret = hist_entry__inc_addr_samples(he, evsel->idx, al->addr);
88 evsel->hists.stats.total_period += sample->period;
89 hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE);
93 static int process_sample_event(union perf_event *event,
94 struct perf_sample *sample,
95 struct perf_session *session)
97 struct addr_location al;
99 if (perf_event__preprocess_sample(event, session, &al, sample,
100 symbol__annotate_init) < 0) {
101 pr_warning("problem processing %d event, skipping it.\n",
106 if (!al.filtered && perf_evlist__add_sample(session->evlist, sample, &al)) {
107 pr_warning("problem incrementing symbol count, "
115 static int hist_entry__tty_annotate(struct hist_entry *he, int evidx)
117 return symbol__tty_annotate(he->ms.sym, he->ms.map, evidx,
118 print_line, full_paths, 0, 0);
121 static void hists__find_annotations(struct hists *self, int evidx)
123 struct rb_node *nd = rb_first(&self->entries), *next;
127 struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
128 struct annotation *notes;
130 if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned)
133 notes = symbol__annotation(he->ms.sym);
134 if (notes->src == NULL) {
143 if (use_browser > 0) {
144 key = hist_entry__tui_annotate(he, evidx);
159 hist_entry__tty_annotate(he, evidx);
162 * Since we have a hist_entry per IP for the same
163 * symbol, free he->ms.sym->src to signal we already
164 * processed this symbol.
172 static struct perf_event_ops event_ops = {
173 .sample = process_sample_event,
174 .mmap = perf_event__process_mmap,
175 .comm = perf_event__process_comm,
176 .fork = perf_event__process_task,
177 .ordered_samples = true,
178 .ordering_requires_timestamps = true,
181 static int __cmd_annotate(void)
184 struct perf_session *session;
185 struct perf_evsel *pos;
186 u64 total_nr_samples;
188 session = perf_session__new(input_name, O_RDONLY, force, false, &event_ops);
192 ret = perf_session__process_events(session, &event_ops);
197 perf_session__fprintf_nr_events(session, stdout);
202 perf_session__fprintf(session, stdout);
205 perf_session__fprintf_dsos(session, stdout);
207 total_nr_samples = 0;
208 list_for_each_entry(pos, &session->evlist->entries, node) {
209 struct hists *hists = &pos->hists;
210 u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
212 if (nr_samples > 0) {
213 total_nr_samples += nr_samples;
214 hists__collapse_resort(hists);
215 hists__output_resort(hists);
216 hists__find_annotations(hists, pos->idx);
220 if (total_nr_samples == 0) {
221 ui__warning("The %s file has no samples!\n", input_name);
226 * Speed up the exit process, for large files this can
227 * take quite a while.
229 * XXX Enable this when using valgrind or if we ever
230 * librarize this command.
232 * Also experiment with obstacks to see how much speed
235 * perf_session__delete(session);
240 static const char * const annotate_usage[] = {
241 "perf annotate [<options>] <command>",
245 static const struct option options[] = {
246 OPT_STRING('i', "input", &input_name, "file",
248 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
249 "only consider symbols in these dsos"),
250 OPT_STRING('s', "symbol", &sym_hist_filter, "symbol",
251 "symbol to annotate"),
252 OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
253 OPT_INCR('v', "verbose", &verbose,
254 "be more verbose (show symbol address, etc)"),
255 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
256 "dump raw trace in ASCII"),
257 OPT_BOOLEAN(0, "tui", &use_tui, "Use the TUI interface"),
258 OPT_BOOLEAN(0, "stdio", &use_stdio, "Use the stdio interface"),
259 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
260 "file", "vmlinux pathname"),
261 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
262 "load module symbols - WARNING: use only with -k and LIVE kernel"),
263 OPT_BOOLEAN('l', "print-line", &print_line,
264 "print matching source lines (may be slow)"),
265 OPT_BOOLEAN('P', "full-paths", &full_paths,
266 "Don't shorten the displayed pathnames"),
270 int cmd_annotate(int argc, const char **argv, const char *prefix __used)
272 argc = parse_options(argc, argv, options, annotate_usage, 0);
281 symbol_conf.priv_size = sizeof(struct annotation);
282 symbol_conf.try_vmlinux_path = true;
284 if (symbol__init() < 0)
287 setup_sorting(annotate_usage, options);
291 * Special case: if there's an argument left then assume tha
292 * it's a symbol filter:
295 usage_with_options(annotate_usage, options);
297 sym_hist_filter = argv[0];
300 if (field_sep && *field_sep == '.') {
301 pr_err("'.' is the only non valid --field-separator argument\n");
305 return __cmd_annotate();