Commit | Line | Data |
---|---|---|
8035e428 IM |
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 | ||
78f7defe | 10 | #include "util/util.h" |
8035e428 | 11 | #include "util/color.h" |
5da50258 | 12 | #include <linux/list.h> |
8035e428 | 13 | #include "util/cache.h" |
43cbcd8a | 14 | #include <linux/rbtree.h> |
8035e428 | 15 | #include "util/symbol.h" |
8035e428 IM |
16 | |
17 | #include "perf.h" | |
8f28827a | 18 | #include "util/debug.h" |
8035e428 | 19 | |
e248de33 ACM |
20 | #include "util/evlist.h" |
21 | #include "util/evsel.h" | |
78f7defe | 22 | #include "util/annotate.h" |
62daacb5 | 23 | #include "util/event.h" |
8035e428 IM |
24 | #include "util/parse-options.h" |
25 | #include "util/parse-events.h" | |
6baa0a5a | 26 | #include "util/thread.h" |
dd68ada2 | 27 | #include "util/sort.h" |
3d1d07ec | 28 | #include "util/hist.h" |
94c744b6 | 29 | #include "util/session.h" |
8035e428 | 30 | |
5d67be97 AB |
31 | #include <linux/bitmap.h> |
32 | ||
8035e428 | 33 | static char const *input_name = "perf.data"; |
8035e428 | 34 | |
8b9e74eb | 35 | static bool force, use_tui, use_stdio; |
8035e428 | 36 | |
c0555642 | 37 | static bool full_paths; |
42976487 | 38 | |
c0555642 | 39 | static bool print_line; |
301406b9 | 40 | |
e4204992 ACM |
41 | static const char *sym_hist_filter; |
42 | ||
5d67be97 AB |
43 | static const char *cpu_list; |
44 | static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS); | |
45 | ||
e248de33 ACM |
46 | static int perf_evlist__add_sample(struct perf_evlist *evlist, |
47 | struct perf_sample *sample, | |
9e69c210 | 48 | struct perf_evsel *evsel, |
e248de33 | 49 | struct addr_location *al) |
8035e428 | 50 | { |
628ada0c | 51 | struct hist_entry *he; |
e248de33 | 52 | int ret; |
628ada0c ACM |
53 | |
54 | if (sym_hist_filter != NULL && | |
55 | (al->sym == NULL || strcmp(sym_hist_filter, al->sym->name) != 0)) { | |
56 | /* We're only interested in a symbol named sym_hist_filter */ | |
57 | if (al->sym != NULL) { | |
58 | rb_erase(&al->sym->rb_node, | |
59 | &al->map->dso->symbols[al->map->type]); | |
60 | symbol__delete(al->sym); | |
61 | } | |
62 | return 0; | |
63 | } | |
64 | ||
e248de33 | 65 | he = __hists__add_entry(&evsel->hists, al, NULL, 1); |
9735abf1 | 66 | if (he == NULL) |
8035e428 | 67 | return -ENOMEM; |
628ada0c | 68 | |
e248de33 | 69 | ret = 0; |
2f525d01 | 70 | if (he->ms.sym != NULL) { |
2f525d01 | 71 | struct annotation *notes = symbol__annotation(he->ms.sym); |
ce6f4fab | 72 | if (notes->src == NULL && |
e248de33 | 73 | symbol__alloc_hist(he->ms.sym, evlist->nr_entries) < 0) |
2f525d01 ACM |
74 | return -ENOMEM; |
75 | ||
e248de33 | 76 | ret = hist_entry__inc_addr_samples(he, evsel->idx, al->addr); |
2f525d01 ACM |
77 | } |
78 | ||
e248de33 ACM |
79 | evsel->hists.stats.total_period += sample->period; |
80 | hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE); | |
81 | return ret; | |
8035e428 IM |
82 | } |
83 | ||
8115d60c ACM |
84 | static int process_sample_event(union perf_event *event, |
85 | struct perf_sample *sample, | |
9e69c210 | 86 | struct perf_evsel *evsel, |
640c03ce | 87 | struct perf_session *session) |
8035e428 | 88 | { |
1ed091c4 | 89 | struct addr_location al; |
6baa0a5a | 90 | |
ce6f4fab ACM |
91 | if (perf_event__preprocess_sample(event, session, &al, sample, |
92 | symbol__annotate_init) < 0) { | |
29a9f66d ACM |
93 | pr_warning("problem processing %d event, skipping it.\n", |
94 | event->header.type); | |
8035e428 IM |
95 | return -1; |
96 | } | |
97 | ||
5d67be97 AB |
98 | if (cpu_list && !test_bit(sample->cpu, cpu_bitmap)) |
99 | return 0; | |
100 | ||
9e69c210 ACM |
101 | if (!al.filtered && |
102 | perf_evlist__add_sample(session->evlist, sample, evsel, &al)) { | |
29a9f66d ACM |
103 | pr_warning("problem incrementing symbol count, " |
104 | "skipping event\n"); | |
ec218fc4 | 105 | return -1; |
8035e428 | 106 | } |
8035e428 IM |
107 | |
108 | return 0; | |
109 | } | |
110 | ||
2f525d01 | 111 | static int hist_entry__tty_annotate(struct hist_entry *he, int evidx) |
0b73da3f | 112 | { |
2f525d01 | 113 | return symbol__tty_annotate(he->ms.sym, he->ms.map, evidx, |
d040bd36 | 114 | print_line, full_paths, 0, 0); |
0b73da3f IM |
115 | } |
116 | ||
e248de33 | 117 | static void hists__find_annotations(struct hists *self, int evidx) |
0b73da3f | 118 | { |
b50e003d | 119 | struct rb_node *nd = rb_first(&self->entries), *next; |
46e3e055 | 120 | int key = KEY_RIGHT; |
0b73da3f | 121 | |
46e3e055 | 122 | while (nd) { |
ed52ce2e | 123 | struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node); |
78f7defe | 124 | struct annotation *notes; |
0b73da3f | 125 | |
46e3e055 ACM |
126 | if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned) |
127 | goto find_next; | |
0b73da3f | 128 | |
78f7defe | 129 | notes = symbol__annotation(he->ms.sym); |
ce6f4fab | 130 | if (notes->src == NULL) { |
46e3e055 ACM |
131 | find_next: |
132 | if (key == KEY_LEFT) | |
133 | nd = rb_prev(nd); | |
134 | else | |
135 | nd = rb_next(nd); | |
e4204992 | 136 | continue; |
46e3e055 | 137 | } |
e4204992 | 138 | |
62e3436b | 139 | if (use_browser > 0) { |
e248de33 | 140 | key = hist_entry__tui_annotate(he, evidx); |
46e3e055 ACM |
141 | switch (key) { |
142 | case KEY_RIGHT: | |
b50e003d | 143 | next = rb_next(nd); |
46e3e055 ACM |
144 | break; |
145 | case KEY_LEFT: | |
b50e003d | 146 | next = rb_prev(nd); |
46e3e055 | 147 | break; |
b50e003d ACM |
148 | default: |
149 | return; | |
46e3e055 | 150 | } |
b50e003d ACM |
151 | |
152 | if (next != NULL) | |
153 | nd = next; | |
46e3e055 | 154 | } else { |
e248de33 | 155 | hist_entry__tty_annotate(he, evidx); |
46e3e055 ACM |
156 | nd = rb_next(nd); |
157 | /* | |
158 | * Since we have a hist_entry per IP for the same | |
ce6f4fab | 159 | * symbol, free he->ms.sym->src to signal we already |
46e3e055 ACM |
160 | * processed this symbol. |
161 | */ | |
ce6f4fab ACM |
162 | free(notes->src); |
163 | notes->src = NULL; | |
46e3e055 | 164 | } |
0b73da3f | 165 | } |
0b73da3f IM |
166 | } |
167 | ||
301a0b02 | 168 | static struct perf_event_ops event_ops = { |
55aa640f | 169 | .sample = process_sample_event, |
8115d60c ACM |
170 | .mmap = perf_event__process_mmap, |
171 | .comm = perf_event__process_comm, | |
172 | .fork = perf_event__process_task, | |
eac23d1c IM |
173 | .ordered_samples = true, |
174 | .ordering_requires_timestamps = true, | |
bab81b62 LZ |
175 | }; |
176 | ||
8035e428 IM |
177 | static int __cmd_annotate(void) |
178 | { | |
bab81b62 | 179 | int ret; |
75be6cf4 | 180 | struct perf_session *session; |
e248de33 ACM |
181 | struct perf_evsel *pos; |
182 | u64 total_nr_samples; | |
8035e428 | 183 | |
21ef97f0 | 184 | session = perf_session__new(input_name, O_RDONLY, force, false, &event_ops); |
94c744b6 ACM |
185 | if (session == NULL) |
186 | return -ENOMEM; | |
187 | ||
5d67be97 AB |
188 | if (cpu_list) { |
189 | ret = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap); | |
190 | if (ret) | |
191 | goto out_delete; | |
192 | } | |
193 | ||
ec913369 | 194 | ret = perf_session__process_events(session, &event_ops); |
bab81b62 | 195 | if (ret) |
94c744b6 | 196 | goto out_delete; |
8035e428 | 197 | |
62daacb5 | 198 | if (dump_trace) { |
c8446b9b | 199 | perf_session__fprintf_nr_events(session, stdout); |
94c744b6 | 200 | goto out_delete; |
62daacb5 | 201 | } |
8035e428 | 202 | |
da21d1b5 | 203 | if (verbose > 3) |
b3165f41 | 204 | perf_session__fprintf(session, stdout); |
8035e428 | 205 | |
da21d1b5 | 206 | if (verbose > 2) |
cbf69680 | 207 | perf_session__fprintf_dsos(session, stdout); |
8035e428 | 208 | |
e248de33 ACM |
209 | total_nr_samples = 0; |
210 | list_for_each_entry(pos, &session->evlist->entries, node) { | |
211 | struct hists *hists = &pos->hists; | |
212 | u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE]; | |
213 | ||
214 | if (nr_samples > 0) { | |
215 | total_nr_samples += nr_samples; | |
216 | hists__collapse_resort(hists); | |
217 | hists__output_resort(hists); | |
218 | hists__find_annotations(hists, pos->idx); | |
219 | } | |
220 | } | |
8035e428 | 221 | |
e248de33 ACM |
222 | if (total_nr_samples == 0) { |
223 | ui__warning("The %s file has no samples!\n", input_name); | |
224 | goto out_delete; | |
225 | } | |
226 | out_delete: | |
227 | /* | |
228 | * Speed up the exit process, for large files this can | |
229 | * take quite a while. | |
230 | * | |
231 | * XXX Enable this when using valgrind or if we ever | |
232 | * librarize this command. | |
233 | * | |
234 | * Also experiment with obstacks to see how much speed | |
235 | * up we'll get here. | |
236 | * | |
237 | * perf_session__delete(session); | |
238 | */ | |
bab81b62 | 239 | return ret; |
8035e428 IM |
240 | } |
241 | ||
242 | static const char * const annotate_usage[] = { | |
243 | "perf annotate [<options>] <command>", | |
244 | NULL | |
245 | }; | |
246 | ||
247 | static const struct option options[] = { | |
248 | OPT_STRING('i', "input", &input_name, "file", | |
249 | "input file name"), | |
ac73c5a9 ACM |
250 | OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]", |
251 | "only consider symbols in these dsos"), | |
23b87116 | 252 | OPT_STRING('s', "symbol", &sym_hist_filter, "symbol", |
0b73da3f | 253 | "symbol to annotate"), |
fa6963b2 | 254 | OPT_BOOLEAN('f', "force", &force, "don't complain, do it"), |
c0555642 | 255 | OPT_INCR('v', "verbose", &verbose, |
8035e428 IM |
256 | "be more verbose (show symbol address, etc)"), |
257 | OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, | |
258 | "dump raw trace in ASCII"), | |
8b9e74eb ACM |
259 | OPT_BOOLEAN(0, "tui", &use_tui, "Use the TUI interface"), |
260 | OPT_BOOLEAN(0, "stdio", &use_stdio, "Use the stdio interface"), | |
b32d133a ACM |
261 | OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, |
262 | "file", "vmlinux pathname"), | |
263 | OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules, | |
42976487 | 264 | "load module symbols - WARNING: use only with -k and LIVE kernel"), |
301406b9 FW |
265 | OPT_BOOLEAN('l', "print-line", &print_line, |
266 | "print matching source lines (may be slow)"), | |
42976487 MG |
267 | OPT_BOOLEAN('P', "full-paths", &full_paths, |
268 | "Don't shorten the displayed pathnames"), | |
5d67be97 | 269 | OPT_STRING('c', "cpu", &cpu_list, "cpu", "list of cpus to profile"), |
8035e428 IM |
270 | OPT_END() |
271 | }; | |
272 | ||
f37a291c | 273 | int cmd_annotate(int argc, const char **argv, const char *prefix __used) |
8035e428 | 274 | { |
655000e7 ACM |
275 | argc = parse_options(argc, argv, options, annotate_usage, 0); |
276 | ||
8b9e74eb ACM |
277 | if (use_stdio) |
278 | use_browser = 0; | |
279 | else if (use_tui) | |
280 | use_browser = 1; | |
281 | ||
229ade9b | 282 | setup_browser(true); |
46e3e055 | 283 | |
78f7defe | 284 | symbol_conf.priv_size = sizeof(struct annotation); |
75be6cf4 ACM |
285 | symbol_conf.try_vmlinux_path = true; |
286 | ||
287 | if (symbol__init() < 0) | |
b32d133a | 288 | return -1; |
8035e428 | 289 | |
c8829c7a | 290 | setup_sorting(annotate_usage, options); |
8035e428 | 291 | |
0b73da3f IM |
292 | if (argc) { |
293 | /* | |
294 | * Special case: if there's an argument left then assume tha | |
295 | * it's a symbol filter: | |
296 | */ | |
297 | if (argc > 1) | |
298 | usage_with_options(annotate_usage, options); | |
299 | ||
300 | sym_hist_filter = argv[0]; | |
301 | } | |
302 | ||
dd68ada2 | 303 | if (field_sep && *field_sep == '.') { |
29a9f66d ACM |
304 | pr_err("'.' is the only non valid --field-separator argument\n"); |
305 | return -1; | |
dd68ada2 JK |
306 | } |
307 | ||
8035e428 IM |
308 | return __cmd_annotate(); |
309 | } |