GNU Linux-libre 5.10.219-gnu1
[releases.git] / tools / perf / builtin-annotate.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * builtin-annotate.c
4  *
5  * Builtin annotate command: Analyze the perf.data input file,
6  * look up and read DSOs and symbol information and display
7  * a histogram of results, along various sorting keys.
8  */
9 #include "builtin.h"
10
11 #include "util/color.h"
12 #include <linux/list.h>
13 #include "util/cache.h"
14 #include <linux/rbtree.h>
15 #include <linux/zalloc.h>
16 #include "util/symbol.h"
17
18 #include "perf.h"
19 #include "util/debug.h"
20
21 #include "util/evlist.h"
22 #include "util/evsel.h"
23 #include "util/annotate.h"
24 #include "util/event.h"
25 #include <subcmd/parse-options.h>
26 #include "util/parse-events.h"
27 #include "util/sort.h"
28 #include "util/hist.h"
29 #include "util/dso.h"
30 #include "util/machine.h"
31 #include "util/map.h"
32 #include "util/session.h"
33 #include "util/tool.h"
34 #include "util/data.h"
35 #include "arch/common.h"
36 #include "util/block-range.h"
37 #include "util/map_symbol.h"
38 #include "util/branch.h"
39
40 #include <dlfcn.h>
41 #include <errno.h>
42 #include <linux/bitmap.h>
43 #include <linux/err.h>
44
45 struct perf_annotate {
46         struct perf_tool tool;
47         struct perf_session *session;
48         struct annotation_options opts;
49         bool       use_tui, use_stdio, use_stdio2, use_gtk;
50         bool       skip_missing;
51         bool       has_br_stack;
52         bool       group_set;
53         const char *sym_hist_filter;
54         const char *cpu_list;
55         DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
56 };
57
58 /*
59  * Given one basic block:
60  *
61  *      from    to              branch_i
62  *      * ----> *
63  *              |
64  *              | block
65  *              v
66  *              * ----> *
67  *              from    to      branch_i+1
68  *
69  * where the horizontal are the branches and the vertical is the executed
70  * block of instructions.
71  *
72  * We count, for each 'instruction', the number of blocks that covered it as
73  * well as count the ratio each branch is taken.
74  *
75  * We can do this without knowing the actual instruction stream by keeping
76  * track of the address ranges. We break down ranges such that there is no
77  * overlap and iterate from the start until the end.
78  *
79  * @acme: once we parse the objdump output _before_ processing the samples,
80  * we can easily fold the branch.cycles IPC bits in.
81  */
82 static void process_basic_block(struct addr_map_symbol *start,
83                                 struct addr_map_symbol *end,
84                                 struct branch_flags *flags)
85 {
86         struct symbol *sym = start->ms.sym;
87         struct annotation *notes = sym ? symbol__annotation(sym) : NULL;
88         struct block_range_iter iter;
89         struct block_range *entry;
90
91         /*
92          * Sanity; NULL isn't executable and the CPU cannot execute backwards
93          */
94         if (!start->addr || start->addr > end->addr)
95                 return;
96
97         iter = block_range__create(start->addr, end->addr);
98         if (!block_range_iter__valid(&iter))
99                 return;
100
101         /*
102          * First block in range is a branch target.
103          */
104         entry = block_range_iter(&iter);
105         assert(entry->is_target);
106         entry->entry++;
107
108         do {
109                 entry = block_range_iter(&iter);
110
111                 entry->coverage++;
112                 entry->sym = sym;
113
114                 if (notes)
115                         notes->max_coverage = max(notes->max_coverage, entry->coverage);
116
117         } while (block_range_iter__next(&iter));
118
119         /*
120          * Last block in rage is a branch.
121          */
122         entry = block_range_iter(&iter);
123         assert(entry->is_branch);
124         entry->taken++;
125         if (flags->predicted)
126                 entry->pred++;
127 }
128
129 static void process_branch_stack(struct branch_stack *bs, struct addr_location *al,
130                                  struct perf_sample *sample)
131 {
132         struct addr_map_symbol *prev = NULL;
133         struct branch_info *bi;
134         int i;
135
136         if (!bs || !bs->nr)
137                 return;
138
139         bi = sample__resolve_bstack(sample, al);
140         if (!bi)
141                 return;
142
143         for (i = bs->nr - 1; i >= 0; i--) {
144                 /*
145                  * XXX filter against symbol
146                  */
147                 if (prev)
148                         process_basic_block(prev, &bi[i].from, &bi[i].flags);
149                 prev = &bi[i].to;
150         }
151
152         free(bi);
153 }
154
155 static int hist_iter__branch_callback(struct hist_entry_iter *iter,
156                                       struct addr_location *al __maybe_unused,
157                                       bool single __maybe_unused,
158                                       void *arg __maybe_unused)
159 {
160         struct hist_entry *he = iter->he;
161         struct branch_info *bi;
162         struct perf_sample *sample = iter->sample;
163         struct evsel *evsel = iter->evsel;
164         int err;
165
166         bi = he->branch_info;
167         err = addr_map_symbol__inc_samples(&bi->from, sample, evsel);
168
169         if (err)
170                 goto out;
171
172         err = addr_map_symbol__inc_samples(&bi->to, sample, evsel);
173
174 out:
175         return err;
176 }
177
178 static int process_branch_callback(struct evsel *evsel,
179                                    struct perf_sample *sample,
180                                    struct addr_location *al __maybe_unused,
181                                    struct perf_annotate *ann,
182                                    struct machine *machine)
183 {
184         struct hist_entry_iter iter = {
185                 .evsel          = evsel,
186                 .sample         = sample,
187                 .add_entry_cb   = hist_iter__branch_callback,
188                 .hide_unresolved        = symbol_conf.hide_unresolved,
189                 .ops            = &hist_iter_branch,
190         };
191
192         struct addr_location a;
193         int ret;
194
195         if (machine__resolve(machine, &a, sample) < 0)
196                 return -1;
197
198         if (a.sym == NULL)
199                 return 0;
200
201         if (a.map != NULL)
202                 a.map->dso->hit = 1;
203
204         hist__account_cycles(sample->branch_stack, al, sample, false, NULL);
205
206         ret = hist_entry_iter__add(&iter, &a, PERF_MAX_STACK_DEPTH, ann);
207         return ret;
208 }
209
210 static bool has_annotation(struct perf_annotate *ann)
211 {
212         return ui__has_annotation() || ann->use_stdio2;
213 }
214
215 static int evsel__add_sample(struct evsel *evsel, struct perf_sample *sample,
216                              struct addr_location *al, struct perf_annotate *ann,
217                              struct machine *machine)
218 {
219         struct hists *hists = evsel__hists(evsel);
220         struct hist_entry *he;
221         int ret;
222
223         if ((!ann->has_br_stack || !has_annotation(ann)) &&
224             ann->sym_hist_filter != NULL &&
225             (al->sym == NULL ||
226              strcmp(ann->sym_hist_filter, al->sym->name) != 0)) {
227                 /* We're only interested in a symbol named sym_hist_filter */
228                 /*
229                  * FIXME: why isn't this done in the symbol_filter when loading
230                  * the DSO?
231                  */
232                 if (al->sym != NULL) {
233                         rb_erase_cached(&al->sym->rb_node,
234                                  &al->map->dso->symbols);
235                         symbol__delete(al->sym);
236                         dso__reset_find_symbol_cache(al->map->dso);
237                 }
238                 return 0;
239         }
240
241         /*
242          * XXX filtered samples can still have branch entires pointing into our
243          * symbol and are missed.
244          */
245         process_branch_stack(sample->branch_stack, al, sample);
246
247         if (ann->has_br_stack && has_annotation(ann))
248                 return process_branch_callback(evsel, sample, al, ann, machine);
249
250         he = hists__add_entry(hists, al, NULL, NULL, NULL, sample, true);
251         if (he == NULL)
252                 return -ENOMEM;
253
254         ret = hist_entry__inc_addr_samples(he, sample, evsel, al->addr);
255         hists__inc_nr_samples(hists, true);
256         return ret;
257 }
258
259 static int process_sample_event(struct perf_tool *tool,
260                                 union perf_event *event,
261                                 struct perf_sample *sample,
262                                 struct evsel *evsel,
263                                 struct machine *machine)
264 {
265         struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool);
266         struct addr_location al;
267         int ret = 0;
268
269         if (machine__resolve(machine, &al, sample) < 0) {
270                 pr_warning("problem processing %d event, skipping it.\n",
271                            event->header.type);
272                 return -1;
273         }
274
275         if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap))
276                 goto out_put;
277
278         if (!al.filtered &&
279             evsel__add_sample(evsel, sample, &al, ann, machine)) {
280                 pr_warning("problem incrementing symbol count, "
281                            "skipping event\n");
282                 ret = -1;
283         }
284 out_put:
285         addr_location__put(&al);
286         return ret;
287 }
288
289 static int process_feature_event(struct perf_session *session,
290                                  union perf_event *event)
291 {
292         if (event->feat.feat_id < HEADER_LAST_FEATURE)
293                 return perf_event__process_feature(session, event);
294         return 0;
295 }
296
297 static int hist_entry__tty_annotate(struct hist_entry *he,
298                                     struct evsel *evsel,
299                                     struct perf_annotate *ann)
300 {
301         if (!ann->use_stdio2)
302                 return symbol__tty_annotate(&he->ms, evsel, &ann->opts);
303
304         return symbol__tty_annotate2(&he->ms, evsel, &ann->opts);
305 }
306
307 static void hists__find_annotations(struct hists *hists,
308                                     struct evsel *evsel,
309                                     struct perf_annotate *ann)
310 {
311         struct rb_node *nd = rb_first_cached(&hists->entries), *next;
312         int key = K_RIGHT;
313
314         while (nd) {
315                 struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
316                 struct annotation *notes;
317
318                 if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned)
319                         goto find_next;
320
321                 if (ann->sym_hist_filter &&
322                     (strcmp(he->ms.sym->name, ann->sym_hist_filter) != 0))
323                         goto find_next;
324
325                 notes = symbol__annotation(he->ms.sym);
326                 if (notes->src == NULL) {
327 find_next:
328                         if (key == K_LEFT)
329                                 nd = rb_prev(nd);
330                         else
331                                 nd = rb_next(nd);
332                         continue;
333                 }
334
335                 if (use_browser == 2) {
336                         int ret;
337                         int (*annotate)(struct hist_entry *he,
338                                         struct evsel *evsel,
339                                         struct hist_browser_timer *hbt);
340
341                         annotate = dlsym(perf_gtk_handle,
342                                          "hist_entry__gtk_annotate");
343                         if (annotate == NULL) {
344                                 ui__error("GTK browser not found!\n");
345                                 return;
346                         }
347
348                         ret = annotate(he, evsel, NULL);
349                         if (!ret || !ann->skip_missing)
350                                 return;
351
352                         /* skip missing symbols */
353                         nd = rb_next(nd);
354                 } else if (use_browser == 1) {
355                         key = hist_entry__tui_annotate(he, evsel, NULL, &ann->opts);
356
357                         switch (key) {
358                         case -1:
359                                 if (!ann->skip_missing)
360                                         return;
361                                 /* fall through */
362                         case K_RIGHT:
363                                 next = rb_next(nd);
364                                 break;
365                         case K_LEFT:
366                                 next = rb_prev(nd);
367                                 break;
368                         default:
369                                 return;
370                         }
371
372                         if (next != NULL)
373                                 nd = next;
374                 } else {
375                         hist_entry__tty_annotate(he, evsel, ann);
376                         nd = rb_next(nd);
377                         /*
378                          * Since we have a hist_entry per IP for the same
379                          * symbol, free he->ms.sym->src to signal we already
380                          * processed this symbol.
381                          */
382                         zfree(&notes->src->cycles_hist);
383                         zfree(&notes->src);
384                 }
385         }
386 }
387
388 static int __cmd_annotate(struct perf_annotate *ann)
389 {
390         int ret;
391         struct perf_session *session = ann->session;
392         struct evsel *pos;
393         u64 total_nr_samples;
394
395         if (ann->cpu_list) {
396                 ret = perf_session__cpu_bitmap(session, ann->cpu_list,
397                                                ann->cpu_bitmap);
398                 if (ret)
399                         goto out;
400         }
401
402         if (!ann->opts.objdump_path) {
403                 ret = perf_env__lookup_objdump(&session->header.env,
404                                                &ann->opts.objdump_path);
405                 if (ret)
406                         goto out;
407         }
408
409         ret = perf_session__process_events(session);
410         if (ret)
411                 goto out;
412
413         if (dump_trace) {
414                 perf_session__fprintf_nr_events(session, stdout);
415                 perf_evlist__fprintf_nr_events(session->evlist, stdout);
416                 goto out;
417         }
418
419         if (verbose > 3)
420                 perf_session__fprintf(session, stdout);
421
422         if (verbose > 2)
423                 perf_session__fprintf_dsos(session, stdout);
424
425         total_nr_samples = 0;
426         evlist__for_each_entry(session->evlist, pos) {
427                 struct hists *hists = evsel__hists(pos);
428                 u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
429
430                 if (nr_samples > 0) {
431                         total_nr_samples += nr_samples;
432                         hists__collapse_resort(hists, NULL);
433                         /* Don't sort callchain */
434                         evsel__reset_sample_bit(pos, CALLCHAIN);
435                         evsel__output_resort(pos, NULL);
436
437                         if (symbol_conf.event_group && !evsel__is_group_leader(pos))
438                                 continue;
439
440                         hists__find_annotations(hists, pos, ann);
441                 }
442         }
443
444         if (total_nr_samples == 0) {
445                 ui__error("The %s data has no samples!\n", session->data->path);
446                 goto out;
447         }
448
449         if (use_browser == 2) {
450                 void (*show_annotations)(void);
451
452                 show_annotations = dlsym(perf_gtk_handle,
453                                          "perf_gtk__show_annotations");
454                 if (show_annotations == NULL) {
455                         ui__error("GTK browser not found!\n");
456                         goto out;
457                 }
458                 show_annotations();
459         }
460
461 out:
462         return ret;
463 }
464
465 static const char * const annotate_usage[] = {
466         "perf annotate [<options>]",
467         NULL
468 };
469
470 int cmd_annotate(int argc, const char **argv)
471 {
472         struct perf_annotate annotate = {
473                 .tool = {
474                         .sample = process_sample_event,
475                         .mmap   = perf_event__process_mmap,
476                         .mmap2  = perf_event__process_mmap2,
477                         .comm   = perf_event__process_comm,
478                         .exit   = perf_event__process_exit,
479                         .fork   = perf_event__process_fork,
480                         .namespaces = perf_event__process_namespaces,
481                         .attr   = perf_event__process_attr,
482                         .build_id = perf_event__process_build_id,
483                         .tracing_data   = perf_event__process_tracing_data,
484                         .feature        = process_feature_event,
485                         .ordered_events = true,
486                         .ordering_requires_timestamps = true,
487                 },
488                 .opts = annotation__default_options,
489         };
490         struct perf_data data = {
491                 .mode  = PERF_DATA_MODE_READ,
492         };
493         struct option options[] = {
494         OPT_STRING('i', "input", &input_name, "file",
495                     "input file name"),
496         OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
497                    "only consider symbols in these dsos"),
498         OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol",
499                     "symbol to annotate"),
500         OPT_BOOLEAN('f', "force", &data.force, "don't complain, do it"),
501         OPT_INCR('v', "verbose", &verbose,
502                     "be more verbose (show symbol address, etc)"),
503         OPT_BOOLEAN('q', "quiet", &quiet, "do now show any message"),
504         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
505                     "dump raw trace in ASCII"),
506         OPT_BOOLEAN(0, "gtk", &annotate.use_gtk, "Use the GTK interface"),
507         OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"),
508         OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"),
509         OPT_BOOLEAN(0, "stdio2", &annotate.use_stdio2, "Use the stdio interface"),
510         OPT_BOOLEAN(0, "ignore-vmlinux", &symbol_conf.ignore_vmlinux,
511                     "don't load vmlinux even if found"),
512         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
513                    "file", "vmlinux pathname"),
514         OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
515                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
516         OPT_BOOLEAN('l', "print-line", &annotate.opts.print_lines,
517                     "print matching source lines (may be slow)"),
518         OPT_BOOLEAN('P', "full-paths", &annotate.opts.full_path,
519                     "Don't shorten the displayed pathnames"),
520         OPT_BOOLEAN(0, "skip-missing", &annotate.skip_missing,
521                     "Skip symbols that cannot be annotated"),
522         OPT_BOOLEAN_SET(0, "group", &symbol_conf.event_group,
523                         &annotate.group_set,
524                         "Show event group information together"),
525         OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"),
526         OPT_CALLBACK(0, "symfs", NULL, "directory",
527                      "Look for files with symbols relative to this directory",
528                      symbol__config_symfs),
529         OPT_BOOLEAN(0, "source", &annotate.opts.annotate_src,
530                     "Interleave source code with assembly code (default)"),
531         OPT_BOOLEAN(0, "asm-raw", &annotate.opts.show_asm_raw,
532                     "Display raw encoding of assembly instructions (default)"),
533         OPT_STRING('M', "disassembler-style", &annotate.opts.disassembler_style, "disassembler style",
534                    "Specify disassembler style (e.g. -M intel for intel syntax)"),
535         OPT_STRING(0, "prefix", &annotate.opts.prefix, "prefix",
536                     "Add prefix to source file path names in programs (with --prefix-strip)"),
537         OPT_STRING(0, "prefix-strip", &annotate.opts.prefix_strip, "N",
538                     "Strip first N entries of source file path name in programs (with --prefix)"),
539         OPT_STRING(0, "objdump", &annotate.opts.objdump_path, "path",
540                    "objdump binary to use for disassembly and annotations"),
541         OPT_BOOLEAN(0, "group", &symbol_conf.event_group,
542                     "Show event group information together"),
543         OPT_BOOLEAN(0, "show-total-period", &symbol_conf.show_total_period,
544                     "Show a column with the sum of periods"),
545         OPT_BOOLEAN('n', "show-nr-samples", &symbol_conf.show_nr_samples,
546                     "Show a column with the number of samples"),
547         OPT_CALLBACK_DEFAULT(0, "stdio-color", NULL, "mode",
548                              "'always' (default), 'never' or 'auto' only applicable to --stdio mode",
549                              stdio__config_color, "always"),
550         OPT_CALLBACK(0, "percent-type", &annotate.opts, "local-period",
551                      "Set percent type local/global-period/hits",
552                      annotate_parse_percent_type),
553
554         OPT_END()
555         };
556         int ret;
557
558         set_option_flag(options, 0, "show-total-period", PARSE_OPT_EXCLUSIVE);
559         set_option_flag(options, 0, "show-nr-samples", PARSE_OPT_EXCLUSIVE);
560
561
562         ret = hists__init();
563         if (ret < 0)
564                 return ret;
565
566         annotation_config__init(&annotate.opts);
567
568         argc = parse_options(argc, argv, options, annotate_usage, 0);
569         if (argc) {
570                 /*
571                  * Special case: if there's an argument left then assume that
572                  * it's a symbol filter:
573                  */
574                 if (argc > 1)
575                         usage_with_options(annotate_usage, options);
576
577                 annotate.sym_hist_filter = argv[0];
578         }
579
580         if (annotate_check_args(&annotate.opts) < 0)
581                 return -EINVAL;
582
583         if (symbol_conf.show_nr_samples && annotate.use_gtk) {
584                 pr_err("--show-nr-samples is not available in --gtk mode at this time\n");
585                 return ret;
586         }
587
588         if (quiet)
589                 perf_quiet_option();
590
591         data.path = input_name;
592
593         annotate.session = perf_session__new(&data, false, &annotate.tool);
594         if (IS_ERR(annotate.session))
595                 return PTR_ERR(annotate.session);
596
597         annotate.has_br_stack = perf_header__has_feat(&annotate.session->header,
598                                                       HEADER_BRANCH_STACK);
599
600         if (annotate.group_set)
601                 perf_evlist__force_leader(annotate.session->evlist);
602
603         ret = symbol__annotation_init();
604         if (ret < 0)
605                 goto out_delete;
606
607         symbol_conf.try_vmlinux_path = true;
608
609         ret = symbol__init(&annotate.session->header.env);
610         if (ret < 0)
611                 goto out_delete;
612
613         if (annotate.use_stdio || annotate.use_stdio2)
614                 use_browser = 0;
615         else if (annotate.use_tui)
616                 use_browser = 1;
617         else if (annotate.use_gtk)
618                 use_browser = 2;
619
620         setup_browser(true);
621
622         if ((use_browser == 1 || annotate.use_stdio2) && annotate.has_br_stack) {
623                 sort__mode = SORT_MODE__BRANCH;
624                 if (setup_sorting(annotate.session->evlist) < 0)
625                         usage_with_options(annotate_usage, options);
626         } else {
627                 if (setup_sorting(NULL) < 0)
628                         usage_with_options(annotate_usage, options);
629         }
630
631         ret = __cmd_annotate(&annotate);
632
633 out_delete:
634         /*
635          * Speed up the exit process, for large files this can
636          * take quite a while.
637          *
638          * XXX Enable this when using valgrind or if we ever
639          * librarize this command.
640          *
641          * Also experiment with obstacks to see how much speed
642          * up we'll get here.
643          *
644          * perf_session__delete(session);
645          */
646         return ret;
647 }