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/annotate.h"
23 #include "util/event.h"
24 #include "util/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"
31 static char const *input_name = "perf.data";
33 static bool force, use_tui, use_stdio;
35 static bool full_paths;
37 static bool print_line;
39 static const char *sym_hist_filter;
41 static int hists__add_entry(struct hists *self, struct addr_location *al)
43 struct hist_entry *he;
45 if (sym_hist_filter != NULL &&
46 (al->sym == NULL || strcmp(sym_hist_filter, al->sym->name) != 0)) {
47 /* We're only interested in a symbol named sym_hist_filter */
48 if (al->sym != NULL) {
49 rb_erase(&al->sym->rb_node,
50 &al->map->dso->symbols[al->map->type]);
51 symbol__delete(al->sym);
56 he = __hists__add_entry(self, al, NULL, 1);
60 if (he->ms.sym != NULL) {
62 * All aggregated on the first sym_hist.
64 struct annotation *notes = symbol__annotation(he->ms.sym);
65 if (notes->histograms == NULL && symbol__alloc_hist(he->ms.sym, 1) < 0)
68 return hist_entry__inc_addr_samples(he, 0, al->addr);
74 static int process_sample_event(union perf_event *event,
75 struct perf_sample *sample,
76 struct perf_session *session)
78 struct addr_location al;
80 if (perf_event__preprocess_sample(event, session, &al, sample, NULL) < 0) {
81 pr_warning("problem processing %d event, skipping it.\n",
86 if (!al.filtered && hists__add_entry(&session->hists, &al)) {
87 pr_warning("problem incrementing symbol count, "
95 static int hist_entry__tty_annotate(struct hist_entry *he, int evidx)
97 return symbol__tty_annotate(he->ms.sym, he->ms.map, evidx,
98 print_line, full_paths);
101 static void hists__find_annotations(struct hists *self)
103 struct rb_node *nd = rb_first(&self->entries), *next;
107 struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
108 struct annotation *notes;
110 if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned)
113 notes = symbol__annotation(he->ms.sym);
114 if (notes->histograms == NULL) {
123 if (use_browser > 0) {
124 /* For now all is aggregated on the first */
125 key = hist_entry__tui_annotate(he, 0);
140 /* For now all is aggregated on the first */
141 hist_entry__tty_annotate(he, 0);
144 * Since we have a hist_entry per IP for the same
145 * symbol, free he->ms.sym->histogram to signal we already
146 * processed this symbol.
148 free(notes->histograms);
149 notes->histograms = NULL;
154 static struct perf_event_ops event_ops = {
155 .sample = process_sample_event,
156 .mmap = perf_event__process_mmap,
157 .comm = perf_event__process_comm,
158 .fork = perf_event__process_task,
159 .ordered_samples = true,
160 .ordering_requires_timestamps = true,
163 static int __cmd_annotate(void)
166 struct perf_session *session;
168 session = perf_session__new(input_name, O_RDONLY, force, false, &event_ops);
172 ret = perf_session__process_events(session, &event_ops);
177 perf_session__fprintf_nr_events(session, stdout);
182 perf_session__fprintf(session, stdout);
185 perf_session__fprintf_dsos(session, stdout);
187 hists__collapse_resort(&session->hists);
188 hists__output_resort(&session->hists);
189 hists__find_annotations(&session->hists);
191 perf_session__delete(session);
196 static const char * const annotate_usage[] = {
197 "perf annotate [<options>] <command>",
201 static const struct option options[] = {
202 OPT_STRING('i', "input", &input_name, "file",
204 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
205 "only consider symbols in these dsos"),
206 OPT_STRING('s', "symbol", &sym_hist_filter, "symbol",
207 "symbol to annotate"),
208 OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
209 OPT_INCR('v', "verbose", &verbose,
210 "be more verbose (show symbol address, etc)"),
211 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
212 "dump raw trace in ASCII"),
213 OPT_BOOLEAN(0, "tui", &use_tui, "Use the TUI interface"),
214 OPT_BOOLEAN(0, "stdio", &use_stdio, "Use the stdio interface"),
215 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
216 "file", "vmlinux pathname"),
217 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
218 "load module symbols - WARNING: use only with -k and LIVE kernel"),
219 OPT_BOOLEAN('l', "print-line", &print_line,
220 "print matching source lines (may be slow)"),
221 OPT_BOOLEAN('P', "full-paths", &full_paths,
222 "Don't shorten the displayed pathnames"),
226 int cmd_annotate(int argc, const char **argv, const char *prefix __used)
228 argc = parse_options(argc, argv, options, annotate_usage, 0);
237 symbol_conf.priv_size = sizeof(struct annotation);
238 symbol_conf.try_vmlinux_path = true;
240 if (symbol__init() < 0)
243 setup_sorting(annotate_usage, options);
247 * Special case: if there's an argument left then assume tha
248 * it's a symbol filter:
251 usage_with_options(annotate_usage, options);
253 sym_hist_filter = argv[0];
256 if (field_sep && *field_sep == '.') {
257 pr_err("'.' is the only non valid --field-separator argument\n");
261 return __cmd_annotate();