tools/perf/builtin-annotate.c

   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 "arch/common.h"
  32
  33 #include <linux/bitmap.h>
  34
  35 struct perf_annotate {
  36         struct perf_tool tool;
  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
  45 static 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
  83 static 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
 111 static 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
 118 static 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) {
 133 find_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);
 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
 170 static 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(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         if (!objdump_path) {
 190                 ret = perf_session_env__lookup_objdump(&session->header.env);
 191                 if (ret)
 192                         goto out_delete;
 193         }
 194
 195         ret = perf_session__process_events(session, &ann->tool);
 196         if (ret)
 197                 goto out_delete;
 198
 199         if (dump_trace) {
 200                 perf_session__fprintf_nr_events(session, stdout);
 201                 goto out_delete;
 202         }
 203
 204         if (verbose > 3)
 205                 perf_session__fprintf(session, stdout);
 206
 207         if (verbose > 2)
 208                 perf_session__fprintf_dsos(session, stdout);
 209
 210         total_nr_samples = 0;
 211         list_for_each_entry(pos, &session->evlist->entries, node) {
 212                 struct hists *hists = &pos->hists;
 213                 u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
 214
 215                 if (nr_samples > 0) {
 216                         total_nr_samples += nr_samples;
 217                         hists__collapse_resort(hists);
 218                         hists__output_resort(hists);
 219                         hists__find_annotations(hists, pos->idx, ann);
 220                 }
 221         }
 222
 223         if (total_nr_samples == 0) {
 224                 ui__error("The %s file has no samples!\n", session->filename);
 225                 goto out_delete;
 226         }
 227 out_delete:
 228         /*
 229          * Speed up the exit process, for large files this can
 230          * take quite a while.
 231          *
 232          * XXX Enable this when using valgrind or if we ever
 233          * librarize this command.
 234          *
 235          * Also experiment with obstacks to see how much speed
 236          * up we'll get here.
 237          *
 238          * perf_session__delete(session);
 239          */
 240         return ret;
 241 }
 242
 243 static const char * const annotate_usage[] = {
 244         "perf annotate [<options>]",
 245         NULL
 246 };
 247
 248 int cmd_annotate(int argc, const char **argv, const char *prefix __maybe_unused)
 249 {
 250         struct perf_annotate annotate = {
 251                 .tool = {
 252                         .sample = process_sample_event,
 253                         .mmap   = perf_event__process_mmap,
 254                         .comm   = perf_event__process_comm,
 255                         .exit   = perf_event__process_exit,
 256                         .fork   = perf_event__process_fork,
 257                         .ordered_samples = true,
 258                         .ordering_requires_timestamps = true,
 259                 },
 260         };
 261         const struct option options[] = {
 262         OPT_STRING('i', "input", &input_name, "file",
 263                     "input file name"),
 264         OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
 265                    "only consider symbols in these dsos"),
 266         OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol",
 267                     "symbol to annotate"),
 268         OPT_BOOLEAN('f', "force", &annotate.force, "don't complain, do it"),
 269         OPT_INCR('v', "verbose", &verbose,
 270                     "be more verbose (show symbol address, etc)"),
 271         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
 272                     "dump raw trace in ASCII"),
 273         OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"),
 274         OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"),
 275         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
 276                    "file", "vmlinux pathname"),
 277         OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
 278                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
 279         OPT_BOOLEAN('l', "print-line", &annotate.print_line,
 280                     "print matching source lines (may be slow)"),
 281         OPT_BOOLEAN('P', "full-paths", &annotate.full_paths,
 282                     "Don't shorten the displayed pathnames"),
 283         OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"),
 284         OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
 285                    "Look for files with symbols relative to this directory"),
 286         OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
 287                     "Interleave source code with assembly code (default)"),
 288         OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
 289                     "Display raw encoding of assembly instructions (default)"),
 290         OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
 291                    "Specify disassembler style (e.g. -M intel for intel syntax)"),
 292         OPT_STRING(0, "objdump", &objdump_path, "path",
 293                    "objdump binary to use for disassembly and annotations"),
 294         OPT_END()
 295         };
 296
 297         argc = parse_options(argc, argv, options, annotate_usage, 0);
 298
 299         if (annotate.use_stdio)
 300                 use_browser = 0;
 301         else if (annotate.use_tui)
 302                 use_browser = 1;
 303
 304         setup_browser(true);
 305
 306         symbol_conf.priv_size = sizeof(struct annotation);
 307         symbol_conf.try_vmlinux_path = true;
 308
 309         if (symbol__init() < 0)
 310                 return -1;
 311
 312         setup_sorting(annotate_usage, options);
 313
 314         if (argc) {
 315                 /*
 316                  * Special case: if there's an argument left then assume tha
 317                  * it's a symbol filter:
 318                  */
 319                 if (argc > 1)
 320                         usage_with_options(annotate_usage, options);
 321
 322                 annotate.sym_hist_filter = argv[0];
 323         }
 324
 325         return __cmd_annotate(&annotate);
 326 }