]>
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 | ||
34958544 ACM |
117 | static void hists__find_annotations(struct hists *self, int evidx, |
118 | int nr_events) | |
0b73da3f | 119 | { |
b50e003d | 120 | struct rb_node *nd = rb_first(&self->entries), *next; |
cf958003 | 121 | int key = K_RIGHT; |
0b73da3f | 122 | |
46e3e055 | 123 | while (nd) { |
ed52ce2e | 124 | struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node); |
78f7defe | 125 | struct annotation *notes; |
0b73da3f | 126 | |
46e3e055 ACM |
127 | if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned) |
128 | goto find_next; | |
0b73da3f | 129 | |
78f7defe | 130 | notes = symbol__annotation(he->ms.sym); |
ce6f4fab | 131 | if (notes->src == NULL) { |
46e3e055 | 132 | find_next: |
cf958003 | 133 | if (key == K_LEFT) |
46e3e055 ACM |
134 | nd = rb_prev(nd); |
135 | else | |
136 | nd = rb_next(nd); | |
e4204992 | 137 | continue; |
46e3e055 | 138 | } |
e4204992 | 139 | |
62e3436b | 140 | if (use_browser > 0) { |
34958544 ACM |
141 | key = hist_entry__tui_annotate(he, evidx, nr_events, |
142 | NULL, NULL, 0); | |
46e3e055 | 143 | switch (key) { |
cf958003 | 144 | case K_RIGHT: |
b50e003d | 145 | next = rb_next(nd); |
46e3e055 | 146 | break; |
cf958003 | 147 | case K_LEFT: |
b50e003d | 148 | next = rb_prev(nd); |
46e3e055 | 149 | break; |
b50e003d ACM |
150 | default: |
151 | return; | |
46e3e055 | 152 | } |
b50e003d ACM |
153 | |
154 | if (next != NULL) | |
155 | nd = next; | |
46e3e055 | 156 | } else { |
e248de33 | 157 | hist_entry__tty_annotate(he, evidx); |
46e3e055 ACM |
158 | nd = rb_next(nd); |
159 | /* | |
160 | * Since we have a hist_entry per IP for the same | |
ce6f4fab | 161 | * symbol, free he->ms.sym->src to signal we already |
46e3e055 ACM |
162 | * processed this symbol. |
163 | */ | |
ce6f4fab ACM |
164 | free(notes->src); |
165 | notes->src = NULL; | |
46e3e055 | 166 | } |
0b73da3f | 167 | } |
0b73da3f IM |
168 | } |
169 | ||
301a0b02 | 170 | static struct perf_event_ops event_ops = { |
55aa640f | 171 | .sample = process_sample_event, |
8115d60c ACM |
172 | .mmap = perf_event__process_mmap, |
173 | .comm = perf_event__process_comm, | |
174 | .fork = perf_event__process_task, | |
eac23d1c IM |
175 | .ordered_samples = true, |
176 | .ordering_requires_timestamps = true, | |
bab81b62 LZ |
177 | }; |
178 | ||
8035e428 IM |
179 | static int __cmd_annotate(void) |
180 | { | |
bab81b62 | 181 | int ret; |
75be6cf4 | 182 | struct perf_session *session; |
e248de33 ACM |
183 | struct perf_evsel *pos; |
184 | u64 total_nr_samples; | |
8035e428 | 185 | |
21ef97f0 | 186 | session = perf_session__new(input_name, O_RDONLY, force, false, &event_ops); |
94c744b6 ACM |
187 | if (session == NULL) |
188 | return -ENOMEM; | |
189 | ||
5d67be97 AB |
190 | if (cpu_list) { |
191 | ret = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap); | |
192 | if (ret) | |
193 | goto out_delete; | |
194 | } | |
195 | ||
ec913369 | 196 | ret = perf_session__process_events(session, &event_ops); |
bab81b62 | 197 | if (ret) |
94c744b6 | 198 | goto out_delete; |
8035e428 | 199 | |
62daacb5 | 200 | if (dump_trace) { |
c8446b9b | 201 | perf_session__fprintf_nr_events(session, stdout); |
94c744b6 | 202 | goto out_delete; |
62daacb5 | 203 | } |
8035e428 | 204 | |
da21d1b5 | 205 | if (verbose > 3) |
b3165f41 | 206 | perf_session__fprintf(session, stdout); |
8035e428 | 207 | |
da21d1b5 | 208 | if (verbose > 2) |
cbf69680 | 209 | perf_session__fprintf_dsos(session, stdout); |
8035e428 | 210 | |
e248de33 ACM |
211 | total_nr_samples = 0; |
212 | list_for_each_entry(pos, &session->evlist->entries, node) { | |
213 | struct hists *hists = &pos->hists; | |
214 | u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE]; | |
215 | ||
216 | if (nr_samples > 0) { | |
217 | total_nr_samples += nr_samples; | |
218 | hists__collapse_resort(hists); | |
219 | hists__output_resort(hists); | |
34958544 ACM |
220 | hists__find_annotations(hists, pos->idx, |
221 | session->evlist->nr_entries); | |
e248de33 ACM |
222 | } |
223 | } | |
8035e428 | 224 | |
e248de33 ACM |
225 | if (total_nr_samples == 0) { |
226 | ui__warning("The %s file has no samples!\n", input_name); | |
227 | goto out_delete; | |
228 | } | |
229 | out_delete: | |
230 | /* | |
231 | * Speed up the exit process, for large files this can | |
232 | * take quite a while. | |
233 | * | |
234 | * XXX Enable this when using valgrind or if we ever | |
235 | * librarize this command. | |
236 | * | |
237 | * Also experiment with obstacks to see how much speed | |
238 | * up we'll get here. | |
239 | * | |
240 | * perf_session__delete(session); | |
241 | */ | |
bab81b62 | 242 | return ret; |
8035e428 IM |
243 | } |
244 | ||
245 | static const char * const annotate_usage[] = { | |
246 | "perf annotate [<options>] <command>", | |
247 | NULL | |
248 | }; | |
249 | ||
250 | static const struct option options[] = { | |
251 | OPT_STRING('i', "input", &input_name, "file", | |
252 | "input file name"), | |
ac73c5a9 ACM |
253 | OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]", |
254 | "only consider symbols in these dsos"), | |
23b87116 | 255 | OPT_STRING('s', "symbol", &sym_hist_filter, "symbol", |
0b73da3f | 256 | "symbol to annotate"), |
fa6963b2 | 257 | OPT_BOOLEAN('f', "force", &force, "don't complain, do it"), |
c0555642 | 258 | OPT_INCR('v', "verbose", &verbose, |
8035e428 IM |
259 | "be more verbose (show symbol address, etc)"), |
260 | OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, | |
261 | "dump raw trace in ASCII"), | |
8b9e74eb ACM |
262 | OPT_BOOLEAN(0, "tui", &use_tui, "Use the TUI interface"), |
263 | OPT_BOOLEAN(0, "stdio", &use_stdio, "Use the stdio interface"), | |
b32d133a ACM |
264 | OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, |
265 | "file", "vmlinux pathname"), | |
266 | OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules, | |
42976487 | 267 | "load module symbols - WARNING: use only with -k and LIVE kernel"), |
301406b9 FW |
268 | OPT_BOOLEAN('l', "print-line", &print_line, |
269 | "print matching source lines (may be slow)"), | |
42976487 MG |
270 | OPT_BOOLEAN('P', "full-paths", &full_paths, |
271 | "Don't shorten the displayed pathnames"), | |
5d67be97 | 272 | OPT_STRING('c', "cpu", &cpu_list, "cpu", "list of cpus to profile"), |
e71a0598 SE |
273 | OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory", |
274 | "Look for files with symbols relative to this directory"), | |
64c6f0c7 | 275 | OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src, |
3e6a2a7f | 276 | "Interleave source code with assembly code (default)"), |
64c6f0c7 | 277 | OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw, |
3e6a2a7f | 278 | "Display raw encoding of assembly instructions (default)"), |
f69b64f7 AK |
279 | OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style", |
280 | "Specify disassembler style (e.g. -M intel for intel syntax)"), | |
8035e428 IM |
281 | OPT_END() |
282 | }; | |
283 | ||
f37a291c | 284 | int cmd_annotate(int argc, const char **argv, const char *prefix __used) |
8035e428 | 285 | { |
655000e7 ACM |
286 | argc = parse_options(argc, argv, options, annotate_usage, 0); |
287 | ||
8b9e74eb ACM |
288 | if (use_stdio) |
289 | use_browser = 0; | |
290 | else if (use_tui) | |
291 | use_browser = 1; | |
292 | ||
229ade9b | 293 | setup_browser(true); |
46e3e055 | 294 | |
78f7defe | 295 | symbol_conf.priv_size = sizeof(struct annotation); |
75be6cf4 ACM |
296 | symbol_conf.try_vmlinux_path = true; |
297 | ||
298 | if (symbol__init() < 0) | |
b32d133a | 299 | return -1; |
8035e428 | 300 | |
c8829c7a | 301 | setup_sorting(annotate_usage, options); |
8035e428 | 302 | |
0b73da3f IM |
303 | if (argc) { |
304 | /* | |
305 | * Special case: if there's an argument left then assume tha | |
306 | * it's a symbol filter: | |
307 | */ | |
308 | if (argc > 1) | |
309 | usage_with_options(annotate_usage, options); | |
310 | ||
311 | sym_hist_filter = argv[0]; | |
312 | } | |
313 | ||
dd68ada2 | 314 | if (field_sep && *field_sep == '.') { |
29a9f66d ACM |
315 | pr_err("'.' is the only non valid --field-separator argument\n"); |
316 | return -1; | |
dd68ada2 JK |
317 | } |
318 | ||
8035e428 IM |
319 | return __cmd_annotate(); |
320 | } |