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 {
 119         struct rb_node *nd = rb_first(&self->entries), *next;
 120         int key = KEY_RIGHT;
 121
 122         while (nd) {
 123                 struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
 124                 struct annotation *notes;
 125
 126                 if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned)
 127                         goto find_next;
 128
 129                 notes = symbol__annotation(he->ms.sym);
 130                 if (notes->src == NULL) {
 131 find_next:
 132                         if (key == KEY_LEFT)
 133                                 nd = rb_prev(nd);
 134                         else
 135                                 nd = rb_next(nd);
 136                         continue;
 137                 }
 138
 139                 if (use_browser > 0) {
 140                         key = hist_entry__tui_annotate(he, evidx);
 141                         switch (key) {
 142                         case KEY_RIGHT:
 143                                 next = rb_next(nd);
 144                                 break;
 145                         case KEY_LEFT:
 146                                 next = rb_prev(nd);
 147                                 break;
 148                         default:
 149                                 return;
 150                         }
 151
 152                         if (next != NULL)
 153                                 nd = next;
 154                 } else {
 155                         hist_entry__tty_annotate(he, evidx);
 156                         nd = rb_next(nd);
 157                         /*
 158                          * Since we have a hist_entry per IP for the same
 159                          * symbol, free he->ms.sym->src to signal we already
 160                          * processed this symbol.
 161                          */
 162                         free(notes->src);
 163                         notes->src = NULL;
 164                 }
 165         }
 166 }
 167
 168 static struct perf_event_ops event_ops = {
 169         .sample = process_sample_event,
 170         .mmap   = perf_event__process_mmap,
 171         .comm   = perf_event__process_comm,
 172         .fork   = perf_event__process_task,
 173         .ordered_samples = true,
 174         .ordering_requires_timestamps = true,
 175 };
 176
 177 static int __cmd_annotate(void)
 178 {
 179         int ret;
 180         struct perf_session *session;
 181         struct perf_evsel *pos;
 182         u64 total_nr_samples;
 183
 184         session = perf_session__new(input_name, O_RDONLY, force, false, &event_ops);
 185         if (session == NULL)
 186                 return -ENOMEM;
 187
 188         if (cpu_list) {
 189                 ret = perf_session__cpu_bitmap(session, cpu_list, cpu_bitmap);
 190                 if (ret)
 191                         goto out_delete;
 192         }
 193
 194         ret = perf_session__process_events(session, &event_ops);
 195         if (ret)
 196                 goto out_delete;
 197
 198         if (dump_trace) {
 199                 perf_session__fprintf_nr_events(session, stdout);
 200                 goto out_delete;
 201         }
 202
 203         if (verbose > 3)
 204                 perf_session__fprintf(session, stdout);
 205
 206         if (verbose > 2)
 207                 perf_session__fprintf_dsos(session, stdout);
 208
 209         total_nr_samples = 0;
 210         list_for_each_entry(pos, &session->evlist->entries, node) {
 211                 struct hists *hists = &pos->hists;
 212                 u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
 213
 214                 if (nr_samples > 0) {
 215                         total_nr_samples += nr_samples;
 216                         hists__collapse_resort(hists);
 217                         hists__output_resort(hists);
 218                         hists__find_annotations(hists, pos->idx);
 219                 }
 220         }
 221
 222         if (total_nr_samples == 0) {
 223                 ui__warning("The %s file has no samples!\n", input_name);
 224                 goto out_delete;
 225         }
 226 out_delete:
 227         /*
 228          * Speed up the exit process, for large files this can
 229          * take quite a while.
 230          *
 231          * XXX Enable this when using valgrind or if we ever
 232          * librarize this command.
 233          *
 234          * Also experiment with obstacks to see how much speed
 235          * up we'll get here.
 236          *
 237          * perf_session__delete(session);
 238          */
 239         return ret;
 240 }
 241
 242 static const char * const annotate_usage[] = {
 243         "perf annotate [<options>] <command>",
 244         NULL
 245 };
 246
 247 static const struct option options[] = {
 248         OPT_STRING('i', "input", &input_name, "file",
 249                     "input file name"),
 250         OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
 251                    "only consider symbols in these dsos"),
 252         OPT_STRING('s', "symbol", &sym_hist_filter, "symbol",
 253                     "symbol to annotate"),
 254         OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
 255         OPT_INCR('v', "verbose", &verbose,
 256                     "be more verbose (show symbol address, etc)"),
 257         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
 258                     "dump raw trace in ASCII"),
 259         OPT_BOOLEAN(0, "tui", &use_tui, "Use the TUI interface"),
 260         OPT_BOOLEAN(0, "stdio", &use_stdio, "Use the stdio interface"),
 261         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
 262                    "file", "vmlinux pathname"),
 263         OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
 264                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
 265         OPT_BOOLEAN('l', "print-line", &print_line,
 266                     "print matching source lines (may be slow)"),
 267         OPT_BOOLEAN('P', "full-paths", &full_paths,
 268                     "Don't shorten the displayed pathnames"),
 269         OPT_STRING('c', "cpu", &cpu_list, "cpu", "list of cpus to profile"),
 270         OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
 271                    "Look for files with symbols relative to this directory"),
 272         OPT_BOOLEAN('0', "source", &symbol_conf.annotate_src,
 273                     "Interleave source code with assembly code (default)"),
 274         OPT_BOOLEAN('0', "asm-raw", &symbol_conf.annotate_asm_raw,
 275                     "Display raw encoding of assembly instructions (default)"),
 276         OPT_END()
 277 };
 278
 279 int cmd_annotate(int argc, const char **argv, const char *prefix __used)
 280 {
 281         argc = parse_options(argc, argv, options, annotate_usage, 0);
 282
 283         if (use_stdio)
 284                 use_browser = 0;
 285         else if (use_tui)
 286                 use_browser = 1;
 287
 288         setup_browser(true);
 289
 290         symbol_conf.priv_size = sizeof(struct annotation);
 291         symbol_conf.try_vmlinux_path = true;
 292
 293         if (symbol__init() < 0)
 294                 return -1;
 295
 296         setup_sorting(annotate_usage, options);
 297
 298         if (argc) {
 299                 /*
 300                  * Special case: if there's an argument left then assume tha
 301                  * it's a symbol filter:
 302                  */
 303                 if (argc > 1)
 304                         usage_with_options(annotate_usage, options);
 305
 306                 sym_hist_filter = argv[0];
 307         }
 308
 309         if (field_sep && *field_sep == '.') {
 310                 pr_err("'.' is the only non valid --field-separator argument\n");
 311                 return -1;
 312         }
 313
 314         return __cmd_annotate();
 315 }