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