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