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