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 char             const *input_name = "perf.data";
  34
  35 static bool             force, use_tui, use_stdio;
  36
  37 static bool             full_paths;
  38
  39 static bool             print_line;
  40
  41 static const char *sym_hist_filter;
  42
  43 static const char       *cpu_list;
  44 static DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
  45
  46 static int perf_evlist__add_sample(struct perf_evlist *evlist,
  47                                    struct perf_sample *sample,
  48                                    struct perf_evsel *evsel,
  49                                    struct addr_location *al)
  50 {
  51         struct hist_entry *he;
  52         int ret;
  53
  54         if (sym_hist_filter != NULL &&
  55             (al->sym == NULL || strcmp(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 &&
  73                     symbol__alloc_hist(he->ms.sym, evlist->nr_entries) < 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
  84 static int process_sample_event(union perf_event *event,
  85                                 struct perf_sample *sample,
  86                                 struct perf_evsel *evsel,
  87                                 struct perf_session *session)
  88 {
  89         struct addr_location al;
  90
  91         if (perf_event__preprocess_sample(event, session, &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
  98         if (cpu_list && !test_bit(sample->cpu, cpu_bitmap))
  99                 return 0;
 100
 101         if (!al.filtered &&
 102             perf_evlist__add_sample(session->evlist, sample, evsel, &al)) {
 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 {
 113         return symbol__tty_annotate(he->ms.sym, he->ms.map, evidx,
 114                                     print_line, full_paths, 0, 0);
 115 }
 116
 117 static void hists__find_annotations(struct hists *self, int evidx,
 118                                     int nr_events)
 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
 127                 if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned)
 128                         goto find_next;
 129
 130                 notes = symbol__annotation(he->ms.sym);
 131                 if (notes->src == NULL) {
 132 find_next:
 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) {
 141                         key = hist_entry__tui_annotate(he, evidx, nr_events,
 142                                                        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);
 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 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
 179 static int __cmd_annotate(void)
 180 {
 181         int ret;
 182         struct perf_session *session;
 183         struct perf_evsel *pos;
 184         u64 total_nr_samples;
 185
 186         session = perf_session__new(input_name, O_RDONLY, force, false, &event_ops);
 187         if (session == NULL)
 188                 return -ENOMEM;
 189
 190         if (cpu_list) {
 191                 ret = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
 192                 if (ret)
 193                         goto out_delete;
 194         }
 195
 196         ret = perf_session__process_events(session, &event_ops);
 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
 205         if (verbose > 3)
 206                 perf_session__fprintf(session, stdout);
 207
 208         if (verbose > 2)
 209                 perf_session__fprintf_dsos(session, stdout);
 210
 211         total_nr_samples = 0;
 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);
 220                         hists__find_annotations(hists, pos->idx,
 221                                                 session->evlist->nr_entries);
 222                 }
 223         }
 224
 225         if (total_nr_samples == 0) {
 226                 ui__warning("The %s file has no samples!\n", input_name);
 227                 goto out_delete;
 228         }
 229 out_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
 235          * librarize this command.
 236          *
 237          * Also experiment with obstacks to see how much speed
 238          * up we'll get here.
 239          *
 240          * perf_session__delete(session);
 241          */
 242         return ret;
 243 }
 244
 245 static const char * const annotate_usage[] = {
 246         "perf annotate [<options>] <command>",
 247         NULL
 248 };
 249
 250 static const struct option options[] = {
 251         OPT_STRING('i', "input", &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"),
 255         OPT_STRING('s', "symbol", &sym_hist_filter, "symbol",
 256                     "symbol to annotate"),
 257         OPT_BOOLEAN('f', "force", &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_BOOLEAN(0, "tui", &use_tui, "Use the TUI interface"),
 263         OPT_BOOLEAN(0, "stdio", &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_BOOLEAN('l', "print-line", &print_line,
 269                     "print matching source lines (may be slow)"),
 270         OPT_BOOLEAN('P', "full-paths", &full_paths,
 271                     "Don't shorten the displayed pathnames"),
 272         OPT_STRING('c', "cpu", &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()
 282 };
 283
 284 int cmd_annotate(int argc, const char **argv, const char *prefix __used)
 285 {
 286         argc = parse_options(argc, argv, options, annotate_usage, 0);
 287
 288         if (use_stdio)
 289                 use_browser = 0;
 290         else if (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)
 299                 return -1;
 300
 301         setup_sorting(annotate_usage, options);
 302
 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
 311                 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
 319         return __cmd_annotate();
 320 }