builtin-annotate.c (e4da3fbfbd1de56d2367653e3823e6445e49f8a9) builtin-annotate.c (efad14150a0b4429f37da7245001a8096ef7ee38)
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"

--- 13 unchanged lines hidden (view full) ---

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"
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"

--- 13 unchanged lines hidden (view full) ---

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"
30
31#include <linux/bitmap.h>
32
31
32#include <linux/bitmap.h>
33
33static char const *input_name = "perf.data";
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};
34
44
35static bool force, use_tui, use_stdio;
36
37static bool full_paths;
38
39static bool print_line;
40
41static const char *sym_hist_filter;
42
43static const char *cpu_list;
44static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
45
46static int perf_evlist__add_sample(struct perf_evlist *evlist,
47 struct perf_sample *sample,
48 struct perf_evsel *evsel,
49 struct addr_location *al)
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)
50{
51 struct hist_entry *he;
52 int ret;
53
49{
50 struct hist_entry *he;
51 int ret;
52
54 if (sym_hist_filter != NULL &&
55 (al->sym == NULL || strcmp(sym_hist_filter, al->sym->name) != 0)) {
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);
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 &&
73 symbol__alloc_hist(he->ms.sym, evlist->nr_entries) < 0)
72 if (notes->src == NULL && symbol__alloc_hist(he->ms.sym) < 0)
74 return -ENOMEM;
75
76 ret = hist_entry__inc_addr_samples(he, evsel->idx, al->addr);
77 }
78
79 evsel->hists.stats.total_period += sample->period;
80 hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE);
81 return ret;
82}
83
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
84static int process_sample_event(union perf_event *event,
83static int process_sample_event(struct perf_tool *tool,
84 union perf_event *event,
85 struct perf_sample *sample,
86 struct perf_evsel *evsel,
85 struct perf_sample *sample,
86 struct perf_evsel *evsel,
87 struct perf_session *session)
87 struct machine *machine)
88{
88{
89 struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool);
89 struct addr_location al;
90
90 struct addr_location al;
91
91 if (perf_event__preprocess_sample(event, session, &al, sample,
92 if (perf_event__preprocess_sample(event, machine, &al, sample,
92 symbol__annotate_init) < 0) {
93 pr_warning("problem processing %d event, skipping it.\n",
94 event->header.type);
95 return -1;
96 }
97
93 symbol__annotate_init) < 0) {
94 pr_warning("problem processing %d event, skipping it.\n",
95 event->header.type);
96 return -1;
97 }
98
98 if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
99 if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap))
99 return 0;
100
100 return 0;
101
101 if (!al.filtered &&
102 perf_evlist__add_sample(session->evlist, sample, evsel, &al)) {
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
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)
111static int hist_entry__tty_annotate(struct hist_entry *he, int evidx,
112 struct perf_annotate *ann)
112{
113 return symbol__tty_annotate(he->ms.sym, he->ms.map, evidx,
113{
114 return symbol__tty_annotate(he->ms.sym, he->ms.map, evidx,
114 print_line, full_paths, 0, 0);
115 ann->print_line, ann->full_paths, 0, 0);
115}
116
117static void hists__find_annotations(struct hists *self, int evidx,
116}
117
118static void hists__find_annotations(struct hists *self, int evidx,
118 int nr_events)
119 struct perf_annotate *ann)
119{
120 struct rb_node *nd = rb_first(&self->entries), *next;
121 int key = K_RIGHT;
122
123 while (nd) {
124 struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
125 struct annotation *notes;
126

--- 6 unchanged lines hidden (view full) ---

133 if (key == K_LEFT)
134 nd = rb_prev(nd);
135 else
136 nd = rb_next(nd);
137 continue;
138 }
139
140 if (use_browser > 0) {
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

--- 6 unchanged lines hidden (view full) ---

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) {
141 key = hist_entry__tui_annotate(he, evidx, nr_events,
142 NULL, NULL, 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 {
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);
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
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 struct perf_event_ops event_ops = {
171 .sample = process_sample_event,
172 .mmap = perf_event__process_mmap,
173 .comm = perf_event__process_comm,
174 .fork = perf_event__process_task,
175 .ordered_samples = true,
176 .ordering_requires_timestamps = true,
177};
178
179static int __cmd_annotate(void)
170static int __cmd_annotate(struct perf_annotate *ann)
180{
181 int ret;
182 struct perf_session *session;
183 struct perf_evsel *pos;
184 u64 total_nr_samples;
185
171{
172 int ret;
173 struct perf_session *session;
174 struct perf_evsel *pos;
175 u64 total_nr_samples;
176
186 session = perf_session__new(input_name, O_RDONLY, force, false, &event_ops);
177 session = perf_session__new(ann->input_name, O_RDONLY,
178 ann->force, false, &ann->tool);
187 if (session == NULL)
188 return -ENOMEM;
189
179 if (session == NULL)
180 return -ENOMEM;
181
190 if (cpu_list) {
191 ret = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
182 if (ann->cpu_list) {
183 ret = perf_session__cpu_bitmap(session, ann->cpu_list,
184 ann->cpu_bitmap);
192 if (ret)
193 goto out_delete;
194 }
195
185 if (ret)
186 goto out_delete;
187 }
188
196 ret = perf_session__process_events(session, &event_ops);
189 ret = perf_session__process_events(session, &ann->tool);
197 if (ret)
198 goto out_delete;
199
200 if (dump_trace) {
201 perf_session__fprintf_nr_events(session, stdout);
202 goto out_delete;
203 }
204

--- 7 unchanged lines hidden (view full) ---

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);
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

--- 7 unchanged lines hidden (view full) ---

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);
220 hists__find_annotations(hists, pos->idx,
221 session->evlist->nr_entries);
213 hists__find_annotations(hists, pos->idx, ann);
222 }
223 }
224
225 if (total_nr_samples == 0) {
214 }
215 }
216
217 if (total_nr_samples == 0) {
226 ui__warning("The %s file has no samples!\n", input_name);
218 ui__warning("The %s file has no samples!\n", session->filename);
227 goto out_delete;
228 }
229out_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

--- 7 unchanged lines hidden (view full) ---

242 return ret;
243}
244
245static const char * const annotate_usage[] = {
246 "perf annotate [<options>] <command>",
247 NULL
248};
249
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

--- 7 unchanged lines hidden (view full) ---

234 return ret;
235}
236
237static const char * const annotate_usage[] = {
238 "perf annotate [<options>] <command>",
239 NULL
240};
241
250static const struct option options[] = {
251 OPT_STRING('i', "input", &input_name, "file",
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",
252 "input file name"),
253 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
254 "only consider symbols in these dsos"),
256 "input file name"),
257 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
258 "only consider symbols in these dsos"),
255 OPT_STRING('s', "symbol", &sym_hist_filter, "symbol",
259 OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol",
256 "symbol to annotate"),
260 "symbol to annotate"),
257 OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
261 OPT_BOOLEAN('f', "force", &annotate.force, "don't complain, do it"),
258 OPT_INCR('v', "verbose", &verbose,
259 "be more verbose (show symbol address, etc)"),
260 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
261 "dump raw trace in ASCII"),
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"),
262 OPT_BOOLEAN(0, "tui", &use_tui, "Use the TUI interface"),
263 OPT_BOOLEAN(0, "stdio", &use_stdio, "Use the stdio interface"),
266 OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"),
267 OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"),
264 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
265 "file", "vmlinux pathname"),
266 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
267 "load module symbols - WARNING: use only with -k and LIVE kernel"),
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"),
268 OPT_BOOLEAN('l', "print-line", &print_line,
272 OPT_BOOLEAN('l', "print-line", &annotate.print_line,
269 "print matching source lines (may be slow)"),
273 "print matching source lines (may be slow)"),
270 OPT_BOOLEAN('P', "full-paths", &full_paths,
274 OPT_BOOLEAN('P', "full-paths", &annotate.full_paths,
271 "Don't shorten the displayed pathnames"),
275 "Don't shorten the displayed pathnames"),
272 OPT_STRING('c', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
276 OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"),
273 OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
274 "Look for files with symbols relative to this directory"),
275 OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
276 "Interleave source code with assembly code (default)"),
277 OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
278 "Display raw encoding of assembly instructions (default)"),
279 OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
280 "Specify disassembler style (e.g. -M intel for intel syntax)"),
281 OPT_END()
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()
282};
286 };
283
287
284int cmd_annotate(int argc, const char **argv, const char *prefix __used)
285{
286 argc = parse_options(argc, argv, options, annotate_usage, 0);
287
288 argc = parse_options(argc, argv, options, annotate_usage, 0);
289
288 if (use_stdio)
290 if (annotate.use_stdio)
289 use_browser = 0;
291 use_browser = 0;
290 else if (use_tui)
292 else if (annotate.use_tui)
291 use_browser = 1;
292
293 setup_browser(true);
294
295 symbol_conf.priv_size = sizeof(struct annotation);
296 symbol_conf.try_vmlinux_path = true;
297
298 if (symbol__init() < 0)

--- 4 unchanged lines hidden (view full) ---

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
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)

--- 4 unchanged lines hidden (view full) ---

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
311 sym_hist_filter = argv[0];
313 annotate.sym_hist_filter = argv[0];
312 }
313
314 if (field_sep && *field_sep == '.') {
315 pr_err("'.' is the only non valid --field-separator argument\n");
316 return -1;
317 }
318
314 }
315
316 if (field_sep && *field_sep == '.') {
317 pr_err("'.' is the only non valid --field-separator argument\n");
318 return -1;
319 }
320
319 return __cmd_annotate();
321 return __cmd_annotate(&annotate);
320}
322}