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/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 static char             const *input_name = "perf.data";
  32
  33 static bool             force, use_tui, use_stdio;
  34
  35 static bool             full_paths;
  36
  37 static bool             print_line;
  38
  39 static const char *sym_hist_filter;
  40
  41 static int hists__add_entry(struct hists *self, struct addr_location *al)
  42 {
  43         struct hist_entry *he;
  44
  45         if (sym_hist_filter != NULL &&
  46             (al->sym == NULL || strcmp(sym_hist_filter, al->sym->name) != 0)) {
  47                 /* We're only interested in a symbol named sym_hist_filter */
  48                 if (al->sym != NULL) {
  49                         rb_erase(&al->sym->rb_node,
  50                                  &al->map->dso->symbols[al->map->type]);
  51                         symbol__delete(al->sym);
  52                 }
  53                 return 0;
  54         }
  55
  56         he = __hists__add_entry(self, al, NULL, 1);
  57         if (he == NULL)
  58                 return -ENOMEM;
  59
  60         if (he->ms.sym != NULL) {
  61                 /*
  62                  * All aggregated on the first sym_hist.
  63                  */
  64                 struct annotation *notes = symbol__annotation(he->ms.sym);
  65                 if (notes->histograms == NULL && symbol__alloc_hist(he->ms.sym, 1) < 0)
  66                         return -ENOMEM;
  67
  68                 return hist_entry__inc_addr_samples(he, 0, al->addr);
  69         }
  70
  71         return 0;
  72 }
  73
  74 static int process_sample_event(union perf_event *event,
  75                                 struct perf_sample *sample,
  76                                 struct perf_session *session)
  77 {
  78         struct addr_location al;
  79
  80         if (perf_event__preprocess_sample(event, session, &al, sample, NULL) < 0) {
  81                 pr_warning("problem processing %d event, skipping it.\n",
  82                            event->header.type);
  83                 return -1;
  84         }
  85
  86         if (!al.filtered && hists__add_entry(&session->hists, &al)) {
  87                 pr_warning("problem incrementing symbol count, "
  88                            "skipping event\n");
  89                 return -1;
  90         }
  91
  92         return 0;
  93 }
  94
  95 static int hist_entry__tty_annotate(struct hist_entry *he, int evidx)
  96 {
  97         return symbol__tty_annotate(he->ms.sym, he->ms.map, evidx,
  98                                     print_line, full_paths);
  99 }
 100
 101 static void hists__find_annotations(struct hists *self)
 102 {
 103         struct rb_node *nd = rb_first(&self->entries), *next;
 104         int key = KEY_RIGHT;
 105
 106         while (nd) {
 107                 struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
 108                 struct annotation *notes;
 109
 110                 if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned)
 111                         goto find_next;
 112
 113                 notes = symbol__annotation(he->ms.sym);
 114                 if (notes->histograms == NULL) {
 115 find_next:
 116                         if (key == KEY_LEFT)
 117                                 nd = rb_prev(nd);
 118                         else
 119                                 nd = rb_next(nd);
 120                         continue;
 121                 }
 122
 123                 if (use_browser > 0) {
 124                         /* For now all is aggregated on the first */
 125                         key = hist_entry__tui_annotate(he, 0);
 126                         switch (key) {
 127                         case KEY_RIGHT:
 128                                 next = rb_next(nd);
 129                                 break;
 130                         case KEY_LEFT:
 131                                 next = rb_prev(nd);
 132                                 break;
 133                         default:
 134                                 return;
 135                         }
 136
 137                         if (next != NULL)
 138                                 nd = next;
 139                 } else {
 140                         /* For now all is aggregated on the first */
 141                         hist_entry__tty_annotate(he, 0);
 142                         nd = rb_next(nd);
 143                         /*
 144                          * Since we have a hist_entry per IP for the same
 145                          * symbol, free he->ms.sym->histogram to signal we already
 146                          * processed this symbol.
 147                          */
 148                         free(notes->histograms);
 149                         notes->histograms = NULL;
 150                 }
 151         }
 152 }
 153
 154 static struct perf_event_ops event_ops = {
 155         .sample = process_sample_event,
 156         .mmap   = perf_event__process_mmap,
 157         .comm   = perf_event__process_comm,
 158         .fork   = perf_event__process_task,
 159         .ordered_samples = true,
 160         .ordering_requires_timestamps = true,
 161 };
 162
 163 static int __cmd_annotate(void)
 164 {
 165         int ret;
 166         struct perf_session *session;
 167
 168         session = perf_session__new(input_name, O_RDONLY, force, false, &event_ops);
 169         if (session == NULL)
 170                 return -ENOMEM;
 171
 172         ret = perf_session__process_events(session, &event_ops);
 173         if (ret)
 174                 goto out_delete;
 175
 176         if (dump_trace) {
 177                 perf_session__fprintf_nr_events(session, stdout);
 178                 goto out_delete;
 179         }
 180
 181         if (verbose > 3)
 182                 perf_session__fprintf(session, stdout);
 183
 184         if (verbose > 2)
 185                 perf_session__fprintf_dsos(session, stdout);
 186
 187         hists__collapse_resort(&session->hists);
 188         hists__output_resort(&session->hists);
 189         hists__find_annotations(&session->hists);
 190 out_delete:
 191         perf_session__delete(session);
 192
 193         return ret;
 194 }
 195
 196 static const char * const annotate_usage[] = {
 197         "perf annotate [<options>] <command>",
 198         NULL
 199 };
 200
 201 static const struct option options[] = {
 202         OPT_STRING('i', "input", &input_name, "file",
 203                     "input file name"),
 204         OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
 205                    "only consider symbols in these dsos"),
 206         OPT_STRING('s', "symbol", &sym_hist_filter, "symbol",
 207                     "symbol to annotate"),
 208         OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
 209         OPT_INCR('v', "verbose", &verbose,
 210                     "be more verbose (show symbol address, etc)"),
 211         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
 212                     "dump raw trace in ASCII"),
 213         OPT_BOOLEAN(0, "tui", &use_tui, "Use the TUI interface"),
 214         OPT_BOOLEAN(0, "stdio", &use_stdio, "Use the stdio interface"),
 215         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
 216                    "file", "vmlinux pathname"),
 217         OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
 218                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
 219         OPT_BOOLEAN('l', "print-line", &print_line,
 220                     "print matching source lines (may be slow)"),
 221         OPT_BOOLEAN('P', "full-paths", &full_paths,
 222                     "Don't shorten the displayed pathnames"),
 223         OPT_END()
 224 };
 225
 226 int cmd_annotate(int argc, const char **argv, const char *prefix __used)
 227 {
 228         argc = parse_options(argc, argv, options, annotate_usage, 0);
 229
 230         if (use_stdio)
 231                 use_browser = 0;
 232         else if (use_tui)
 233                 use_browser = 1;
 234
 235         setup_browser(true);
 236
 237         symbol_conf.priv_size = sizeof(struct annotation);
 238         symbol_conf.try_vmlinux_path = true;
 239
 240         if (symbol__init() < 0)
 241                 return -1;
 242
 243         setup_sorting(annotate_usage, options);
 244
 245         if (argc) {
 246                 /*
 247                  * Special case: if there's an argument left then assume tha
 248                  * it's a symbol filter:
 249                  */
 250                 if (argc > 1)
 251                         usage_with_options(annotate_usage, options);
 252
 253                 sym_hist_filter = argv[0];
 254         }
 255
 256         if (field_sep && *field_sep == '.') {
 257                 pr_err("'.' is the only non valid --field-separator argument\n");
 258                 return -1;
 259         }
 260
 261         return __cmd_annotate();
 262 }