Loading...
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 "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"
30#include "util/tool.h"
31
32#include <linux/bitmap.h>
33
34struct perf_annotate {
35 struct perf_tool tool;
36 char const *input_name;
37 bool force, use_tui, use_stdio;
38 bool full_paths;
39 bool print_line;
40 const char *sym_hist_filter;
41 const char *cpu_list;
42 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
43};
44
45static int perf_evsel__add_sample(struct perf_evsel *evsel,
46 struct perf_sample *sample,
47 struct addr_location *al,
48 struct perf_annotate *ann)
49{
50 struct hist_entry *he;
51 int ret;
52
53 if (ann->sym_hist_filter != NULL &&
54 (al->sym == NULL ||
55 strcmp(ann->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
65 he = __hists__add_entry(&evsel->hists, al, NULL, 1);
66 if (he == NULL)
67 return -ENOMEM;
68
69 ret = 0;
70 if (he->ms.sym != NULL) {
71 struct annotation *notes = symbol__annotation(he->ms.sym);
72 if (notes->src == NULL && symbol__alloc_hist(he->ms.sym) < 0)
73 return -ENOMEM;
74
75 ret = hist_entry__inc_addr_samples(he, evsel->idx, al->addr);
76 }
77
78 evsel->hists.stats.total_period += sample->period;
79 hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE);
80 return ret;
81}
82
83static int process_sample_event(struct perf_tool *tool,
84 union perf_event *event,
85 struct perf_sample *sample,
86 struct perf_evsel *evsel,
87 struct machine *machine)
88{
89 struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool);
90 struct addr_location al;
91
92 if (perf_event__preprocess_sample(event, machine, &al, sample,
93 symbol__annotate_init) < 0) {
94 pr_warning("problem processing %d event, skipping it.\n",
95 event->header.type);
96 return -1;
97 }
98
99 if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap))
100 return 0;
101
102 if (!al.filtered && perf_evsel__add_sample(evsel, sample, &al, ann)) {
103 pr_warning("problem incrementing symbol count, "
104 "skipping event\n");
105 return -1;
106 }
107
108 return 0;
109}
110
111static int hist_entry__tty_annotate(struct hist_entry *he, int evidx,
112 struct perf_annotate *ann)
113{
114 return symbol__tty_annotate(he->ms.sym, he->ms.map, evidx,
115 ann->print_line, ann->full_paths, 0, 0);
116}
117
118static void hists__find_annotations(struct hists *self, int evidx,
119 struct perf_annotate *ann)
120{
121 struct rb_node *nd = rb_first(&self->entries), *next;
122 int key = K_RIGHT;
123
124 while (nd) {
125 struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
126 struct annotation *notes;
127
128 if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned)
129 goto find_next;
130
131 notes = symbol__annotation(he->ms.sym);
132 if (notes->src == NULL) {
133find_next:
134 if (key == K_LEFT)
135 nd = rb_prev(nd);
136 else
137 nd = rb_next(nd);
138 continue;
139 }
140
141 if (use_browser > 0) {
142 key = hist_entry__tui_annotate(he, evidx, NULL, NULL, 0);
143 switch (key) {
144 case K_RIGHT:
145 next = rb_next(nd);
146 break;
147 case K_LEFT:
148 next = rb_prev(nd);
149 break;
150 default:
151 return;
152 }
153
154 if (next != NULL)
155 nd = next;
156 } else {
157 hist_entry__tty_annotate(he, evidx, ann);
158 nd = rb_next(nd);
159 /*
160 * Since we have a hist_entry per IP for the same
161 * symbol, free he->ms.sym->src to signal we already
162 * processed this symbol.
163 */
164 free(notes->src);
165 notes->src = NULL;
166 }
167 }
168}
169
170static int __cmd_annotate(struct perf_annotate *ann)
171{
172 int ret;
173 struct perf_session *session;
174 struct perf_evsel *pos;
175 u64 total_nr_samples;
176
177 session = perf_session__new(ann->input_name, O_RDONLY,
178 ann->force, false, &ann->tool);
179 if (session == NULL)
180 return -ENOMEM;
181
182 if (ann->cpu_list) {
183 ret = perf_session__cpu_bitmap(session, ann->cpu_list,
184 ann->cpu_bitmap);
185 if (ret)
186 goto out_delete;
187 }
188
189 ret = perf_session__process_events(session, &ann->tool);
190 if (ret)
191 goto out_delete;
192
193 if (dump_trace) {
194 perf_session__fprintf_nr_events(session, stdout);
195 goto out_delete;
196 }
197
198 if (verbose > 3)
199 perf_session__fprintf(session, stdout);
200
201 if (verbose > 2)
202 perf_session__fprintf_dsos(session, stdout);
203
204 total_nr_samples = 0;
205 list_for_each_entry(pos, &session->evlist->entries, node) {
206 struct hists *hists = &pos->hists;
207 u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
208
209 if (nr_samples > 0) {
210 total_nr_samples += nr_samples;
211 hists__collapse_resort(hists);
212 hists__output_resort(hists);
213 hists__find_annotations(hists, pos->idx, ann);
214 }
215 }
216
217 if (total_nr_samples == 0) {
218 ui__error("The %s file has no samples!\n", session->filename);
219 goto out_delete;
220 }
221out_delete:
222 /*
223 * Speed up the exit process, for large files this can
224 * take quite a while.
225 *
226 * XXX Enable this when using valgrind or if we ever
227 * librarize this command.
228 *
229 * Also experiment with obstacks to see how much speed
230 * up we'll get here.
231 *
232 * perf_session__delete(session);
233 */
234 return ret;
235}
236
237static const char * const annotate_usage[] = {
238 "perf annotate [<options>]",
239 NULL
240};
241
242int cmd_annotate(int argc, const char **argv, const char *prefix __used)
243{
244 struct perf_annotate annotate = {
245 .tool = {
246 .sample = process_sample_event,
247 .mmap = perf_event__process_mmap,
248 .comm = perf_event__process_comm,
249 .fork = perf_event__process_task,
250 .ordered_samples = true,
251 .ordering_requires_timestamps = true,
252 },
253 };
254 const struct option options[] = {
255 OPT_STRING('i', "input", &annotate.input_name, "file",
256 "input file name"),
257 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
258 "only consider symbols in these dsos"),
259 OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol",
260 "symbol to annotate"),
261 OPT_BOOLEAN('f', "force", &annotate.force, "don't complain, do it"),
262 OPT_INCR('v', "verbose", &verbose,
263 "be more verbose (show symbol address, etc)"),
264 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
265 "dump raw trace in ASCII"),
266 OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"),
267 OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"),
268 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
269 "file", "vmlinux pathname"),
270 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
271 "load module symbols - WARNING: use only with -k and LIVE kernel"),
272 OPT_BOOLEAN('l', "print-line", &annotate.print_line,
273 "print matching source lines (may be slow)"),
274 OPT_BOOLEAN('P', "full-paths", &annotate.full_paths,
275 "Don't shorten the displayed pathnames"),
276 OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"),
277 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
278 "Look for files with symbols relative to this directory"),
279 OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
280 "Interleave source code with assembly code (default)"),
281 OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
282 "Display raw encoding of assembly instructions (default)"),
283 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
284 "Specify disassembler style (e.g. -M intel for intel syntax)"),
285 OPT_END()
286 };
287
288 argc = parse_options(argc, argv, options, annotate_usage, 0);
289
290 if (annotate.use_stdio)
291 use_browser = 0;
292 else if (annotate.use_tui)
293 use_browser = 1;
294
295 setup_browser(true);
296
297 symbol_conf.priv_size = sizeof(struct annotation);
298 symbol_conf.try_vmlinux_path = true;
299
300 if (symbol__init() < 0)
301 return -1;
302
303 setup_sorting(annotate_usage, options);
304
305 if (argc) {
306 /*
307 * Special case: if there's an argument left then assume tha
308 * it's a symbol filter:
309 */
310 if (argc > 1)
311 usage_with_options(annotate_usage, options);
312
313 annotate.sym_hist_filter = argv[0];
314 }
315
316 return __cmd_annotate(&annotate);
317}
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 "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"
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 bool force, use_tui, use_stdio, use_gtk;
40 bool full_paths;
41 bool print_line;
42 bool skip_missing;
43 const char *sym_hist_filter;
44 const char *cpu_list;
45 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
46};
47
48static int perf_evsel__add_sample(struct perf_evsel *evsel,
49 struct perf_sample *sample,
50 struct addr_location *al,
51 struct perf_annotate *ann)
52{
53 struct hist_entry *he;
54 int ret;
55
56 if (ann->sym_hist_filter != NULL &&
57 (al->sym == NULL ||
58 strcmp(ann->sym_hist_filter, al->sym->name) != 0)) {
59 /* We're only interested in a symbol named sym_hist_filter */
60 if (al->sym != NULL) {
61 rb_erase(&al->sym->rb_node,
62 &al->map->dso->symbols[al->map->type]);
63 symbol__delete(al->sym);
64 }
65 return 0;
66 }
67
68 he = __hists__add_entry(&evsel->hists, al, NULL, NULL, NULL, 1, 1, 0);
69 if (he == NULL)
70 return -ENOMEM;
71
72 ret = hist_entry__inc_addr_samples(he, evsel->idx, al->addr);
73 evsel->hists.stats.total_period += sample->period;
74 hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE);
75 return ret;
76}
77
78static int process_sample_event(struct perf_tool *tool,
79 union perf_event *event,
80 struct perf_sample *sample,
81 struct perf_evsel *evsel,
82 struct machine *machine)
83{
84 struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool);
85 struct addr_location al;
86
87 if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) {
88 pr_warning("problem processing %d event, skipping it.\n",
89 event->header.type);
90 return -1;
91 }
92
93 if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap))
94 return 0;
95
96 if (!al.filtered && perf_evsel__add_sample(evsel, sample, &al, ann)) {
97 pr_warning("problem incrementing symbol count, "
98 "skipping event\n");
99 return -1;
100 }
101
102 return 0;
103}
104
105static int hist_entry__tty_annotate(struct hist_entry *he,
106 struct perf_evsel *evsel,
107 struct perf_annotate *ann)
108{
109 return symbol__tty_annotate(he->ms.sym, he->ms.map, evsel,
110 ann->print_line, ann->full_paths, 0, 0);
111}
112
113static void hists__find_annotations(struct hists *hists,
114 struct perf_evsel *evsel,
115 struct perf_annotate *ann)
116{
117 struct rb_node *nd = rb_first(&hists->entries), *next;
118 int key = K_RIGHT;
119
120 while (nd) {
121 struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
122 struct annotation *notes;
123
124 if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned)
125 goto find_next;
126
127 notes = symbol__annotation(he->ms.sym);
128 if (notes->src == NULL) {
129find_next:
130 if (key == K_LEFT)
131 nd = rb_prev(nd);
132 else
133 nd = rb_next(nd);
134 continue;
135 }
136
137 if (use_browser == 2) {
138 int ret;
139 int (*annotate)(struct hist_entry *he,
140 struct perf_evsel *evsel,
141 struct hist_browser_timer *hbt);
142
143 annotate = dlsym(perf_gtk_handle,
144 "hist_entry__gtk_annotate");
145 if (annotate == NULL) {
146 ui__error("GTK browser not found!\n");
147 return;
148 }
149
150 ret = annotate(he, evsel, NULL);
151 if (!ret || !ann->skip_missing)
152 return;
153
154 /* skip missing symbols */
155 nd = rb_next(nd);
156 } else if (use_browser == 1) {
157 key = hist_entry__tui_annotate(he, evsel, NULL);
158 switch (key) {
159 case -1:
160 if (!ann->skip_missing)
161 return;
162 /* fall through */
163 case K_RIGHT:
164 next = rb_next(nd);
165 break;
166 case K_LEFT:
167 next = rb_prev(nd);
168 break;
169 default:
170 return;
171 }
172
173 if (next != NULL)
174 nd = next;
175 } else {
176 hist_entry__tty_annotate(he, evsel, ann);
177 nd = rb_next(nd);
178 /*
179 * Since we have a hist_entry per IP for the same
180 * symbol, free he->ms.sym->src to signal we already
181 * processed this symbol.
182 */
183 zfree(¬es->src);
184 }
185 }
186}
187
188static int __cmd_annotate(struct perf_annotate *ann)
189{
190 int ret;
191 struct perf_session *session;
192 struct perf_evsel *pos;
193 u64 total_nr_samples;
194 struct perf_data_file file = {
195 .path = input_name,
196 .mode = PERF_DATA_MODE_READ,
197 .force = ann->force,
198 };
199
200 session = perf_session__new(&file, false, &ann->tool);
201 if (session == NULL)
202 return -ENOMEM;
203
204 machines__set_symbol_filter(&session->machines, symbol__annotate_init);
205
206 if (ann->cpu_list) {
207 ret = perf_session__cpu_bitmap(session, ann->cpu_list,
208 ann->cpu_bitmap);
209 if (ret)
210 goto out_delete;
211 }
212
213 if (!objdump_path) {
214 ret = perf_session_env__lookup_objdump(&session->header.env);
215 if (ret)
216 goto out_delete;
217 }
218
219 ret = perf_session__process_events(session, &ann->tool);
220 if (ret)
221 goto out_delete;
222
223 if (dump_trace) {
224 perf_session__fprintf_nr_events(session, stdout);
225 goto out_delete;
226 }
227
228 if (verbose > 3)
229 perf_session__fprintf(session, stdout);
230
231 if (verbose > 2)
232 perf_session__fprintf_dsos(session, stdout);
233
234 total_nr_samples = 0;
235 evlist__for_each(session->evlist, pos) {
236 struct hists *hists = &pos->hists;
237 u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
238
239 if (nr_samples > 0) {
240 total_nr_samples += nr_samples;
241 hists__collapse_resort(hists, NULL);
242 hists__output_resort(hists);
243
244 if (symbol_conf.event_group &&
245 !perf_evsel__is_group_leader(pos))
246 continue;
247
248 hists__find_annotations(hists, pos, ann);
249 }
250 }
251
252 if (total_nr_samples == 0) {
253 ui__error("The %s file has no samples!\n", file.path);
254 goto out_delete;
255 }
256
257 if (use_browser == 2) {
258 void (*show_annotations)(void);
259
260 show_annotations = dlsym(perf_gtk_handle,
261 "perf_gtk__show_annotations");
262 if (show_annotations == NULL) {
263 ui__error("GTK browser not found!\n");
264 goto out_delete;
265 }
266 show_annotations();
267 }
268
269out_delete:
270 /*
271 * Speed up the exit process, for large files this can
272 * take quite a while.
273 *
274 * XXX Enable this when using valgrind or if we ever
275 * librarize this command.
276 *
277 * Also experiment with obstacks to see how much speed
278 * up we'll get here.
279 *
280 * perf_session__delete(session);
281 */
282 return ret;
283}
284
285static const char * const annotate_usage[] = {
286 "perf annotate [<options>]",
287 NULL
288};
289
290int cmd_annotate(int argc, const char **argv, const char *prefix __maybe_unused)
291{
292 struct perf_annotate annotate = {
293 .tool = {
294 .sample = process_sample_event,
295 .mmap = perf_event__process_mmap,
296 .mmap2 = perf_event__process_mmap2,
297 .comm = perf_event__process_comm,
298 .exit = perf_event__process_exit,
299 .fork = perf_event__process_fork,
300 .ordered_samples = true,
301 .ordering_requires_timestamps = true,
302 },
303 };
304 const struct option options[] = {
305 OPT_STRING('i', "input", &input_name, "file",
306 "input file name"),
307 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
308 "only consider symbols in these dsos"),
309 OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol",
310 "symbol to annotate"),
311 OPT_BOOLEAN('f', "force", &annotate.force, "don't complain, do it"),
312 OPT_INCR('v', "verbose", &verbose,
313 "be more verbose (show symbol address, etc)"),
314 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
315 "dump raw trace in ASCII"),
316 OPT_BOOLEAN(0, "gtk", &annotate.use_gtk, "Use the GTK interface"),
317 OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"),
318 OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"),
319 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
320 "file", "vmlinux pathname"),
321 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
322 "load module symbols - WARNING: use only with -k and LIVE kernel"),
323 OPT_BOOLEAN('l', "print-line", &annotate.print_line,
324 "print matching source lines (may be slow)"),
325 OPT_BOOLEAN('P', "full-paths", &annotate.full_paths,
326 "Don't shorten the displayed pathnames"),
327 OPT_BOOLEAN(0, "skip-missing", &annotate.skip_missing,
328 "Skip symbols that cannot be annotated"),
329 OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"),
330 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
331 "Look for files with symbols relative to this directory"),
332 OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
333 "Interleave source code with assembly code (default)"),
334 OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
335 "Display raw encoding of assembly instructions (default)"),
336 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
337 "Specify disassembler style (e.g. -M intel for intel syntax)"),
338 OPT_STRING(0, "objdump", &objdump_path, "path",
339 "objdump binary to use for disassembly and annotations"),
340 OPT_BOOLEAN(0, "group", &symbol_conf.event_group,
341 "Show event group information together"),
342 OPT_END()
343 };
344
345 argc = parse_options(argc, argv, options, annotate_usage, 0);
346
347 if (annotate.use_stdio)
348 use_browser = 0;
349 else if (annotate.use_tui)
350 use_browser = 1;
351 else if (annotate.use_gtk)
352 use_browser = 2;
353
354 setup_browser(true);
355
356 symbol_conf.priv_size = sizeof(struct annotation);
357 symbol_conf.try_vmlinux_path = true;
358
359 if (symbol__init() < 0)
360 return -1;
361
362 if (setup_sorting() < 0)
363 usage_with_options(annotate_usage, options);
364
365 if (argc) {
366 /*
367 * Special case: if there's an argument left then assume that
368 * it's a symbol filter:
369 */
370 if (argc > 1)
371 usage_with_options(annotate_usage, options);
372
373 annotate.sym_hist_filter = argv[0];
374 }
375
376 return __cmd_annotate(&annotate);
377}