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 #include "util/tool.h"
  31 #include "arch/common.h"
  32
  33 #include <linux/bitmap.h>
  34
  35 struct perf_annotate {
  36         struct perf_tool tool;
  37         bool       force, use_tui, use_stdio, use_gtk;
  38         bool       full_paths;
  39         bool       print_line;
  40         bool       skip_missing;
  41         const char *sym_hist_filter;
  42         const char *cpu_list;
  43         DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS);
  44 };
  45
  46 static int perf_evsel__add_sample(struct perf_evsel *evsel,
  47                                   struct perf_sample *sample,
  48                                   struct addr_location *al,
  49                                   struct perf_annotate *ann)
  50 {
  51         struct hist_entry *he;
  52         int ret;
  53
  54         if (ann->sym_hist_filter != NULL &&
  55             (al->sym == NULL ||
  56              strcmp(ann->sym_hist_filter, al->sym->name) != 0)) {
  57                 /* We're only interested in a symbol named sym_hist_filter */
  58                 if (al->sym != NULL) {
  59                         rb_erase(&al->sym->rb_node,
  60                                  &al->map->dso->symbols[al->map->type]);
  61                         symbol__delete(al->sym);
  62                 }
  63                 return 0;
  64         }
  65
  66         he = __hists__add_entry(&evsel->hists, al, NULL, 1, 1);
  67         if (he == NULL)
  68                 return -ENOMEM;
  69
  70         ret = 0;
  71         if (he->ms.sym != NULL) {
  72                 struct annotation *notes = symbol__annotation(he->ms.sym);
  73                 if (notes->src == NULL && symbol__alloc_hist(he->ms.sym) < 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(struct perf_tool *tool,
  85                                 union perf_event *event,
  86                                 struct perf_sample *sample,
  87                                 struct perf_evsel *evsel,
  88                                 struct machine *machine)
  89 {
  90         struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool);
  91         struct addr_location al;
  92
  93         if (perf_event__preprocess_sample(event, machine, &al, sample,
  94                                           symbol__annotate_init) < 0) {
  95                 pr_warning("problem processing %d event, skipping it.\n",
  96                            event->header.type);
  97                 return -1;
  98         }
  99
 100         if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap))
 101                 return 0;
 102
 103         if (!al.filtered && perf_evsel__add_sample(evsel, sample, &al, ann)) {
 104                 pr_warning("problem incrementing symbol count, "
 105                            "skipping event\n");
 106                 return -1;
 107         }
 108
 109         return 0;
 110 }
 111
 112 static int hist_entry__tty_annotate(struct hist_entry *he,
 113                                     struct perf_evsel *evsel,
 114                                     struct perf_annotate *ann)
 115 {
 116         return symbol__tty_annotate(he->ms.sym, he->ms.map, evsel,
 117                                     ann->print_line, ann->full_paths, 0, 0);
 118 }
 119
 120 static void hists__find_annotations(struct hists *self,
 121                                     struct perf_evsel *evsel,
 122                                     struct perf_annotate *ann)
 123 {
 124         struct rb_node *nd = rb_first(&self->entries), *next;
 125         int key = K_RIGHT;
 126
 127         while (nd) {
 128                 struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
 129                 struct annotation *notes;
 130
 131                 if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned)
 132                         goto find_next;
 133
 134                 notes = symbol__annotation(he->ms.sym);
 135                 if (notes->src == NULL) {
 136 find_next:
 137                         if (key == K_LEFT)
 138                                 nd = rb_prev(nd);
 139                         else
 140                                 nd = rb_next(nd);
 141                         continue;
 142                 }
 143
 144                 if (use_browser == 2) {
 145                         int ret;
 146
 147                         ret = hist_entry__gtk_annotate(he, evsel, NULL);
 148                         if (!ret || !ann->skip_missing)
 149                                 return;
 150
 151                         /* skip missing symbols */
 152                         nd = rb_next(nd);
 153                 } else if (use_browser == 1) {
 154                         key = hist_entry__tui_annotate(he, evsel, NULL);
 155                         switch (key) {
 156                         case -1:
 157                                 if (!ann->skip_missing)
 158                                         return;
 159                                 /* fall through */
 160                         case K_RIGHT:
 161                                 next = rb_next(nd);
 162                                 break;
 163                         case K_LEFT:
 164                                 next = rb_prev(nd);
 165                                 break;
 166                         default:
 167                                 return;
 168                         }
 169
 170                         if (next != NULL)
 171                                 nd = next;
 172                 } else {
 173                         hist_entry__tty_annotate(he, evsel, ann);
 174                         nd = rb_next(nd);
 175                         /*
 176                          * Since we have a hist_entry per IP for the same
 177                          * symbol, free he->ms.sym->src to signal we already
 178                          * processed this symbol.
 179                          */
 180                         free(notes->src);
 181                         notes->src = NULL;
 182                 }
 183         }
 184 }
 185
 186 static int __cmd_annotate(struct perf_annotate *ann)
 187 {
 188         int ret;
 189         struct perf_session *session;
 190         struct perf_evsel *pos;
 191         u64 total_nr_samples;
 192
 193         session = perf_session__new(input_name, O_RDONLY,
 194                                     ann->force, false, &ann->tool);
 195         if (session == NULL)
 196                 return -ENOMEM;
 197
 198         if (ann->cpu_list) {
 199                 ret = perf_session__cpu_bitmap(session, ann->cpu_list,
 200                                                ann->cpu_bitmap);
 201                 if (ret)
 202                         goto out_delete;
 203         }
 204
 205         if (!objdump_path) {
 206                 ret = perf_session_env__lookup_objdump(&session->header.env);
 207                 if (ret)
 208                         goto out_delete;
 209         }
 210
 211         ret = perf_session__process_events(session, &ann->tool);
 212         if (ret)
 213                 goto out_delete;
 214
 215         if (dump_trace) {
 216                 perf_session__fprintf_nr_events(session, stdout);
 217                 goto out_delete;
 218         }
 219
 220         if (verbose > 3)
 221                 perf_session__fprintf(session, stdout);
 222
 223         if (verbose > 2)
 224                 perf_session__fprintf_dsos(session, stdout);
 225
 226         total_nr_samples = 0;
 227         list_for_each_entry(pos, &session->evlist->entries, node) {
 228                 struct hists *hists = &pos->hists;
 229                 u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE];
 230
 231                 if (nr_samples > 0) {
 232                         total_nr_samples += nr_samples;
 233                         hists__collapse_resort(hists);
 234                         hists__output_resort(hists);
 235
 236                         if (symbol_conf.event_group &&
 237                             !perf_evsel__is_group_leader(pos))
 238                                 continue;
 239
 240                         hists__find_annotations(hists, pos, ann);
 241                 }
 242         }
 243
 244         if (total_nr_samples == 0) {
 245                 ui__error("The %s file has no samples!\n", session->filename);
 246                 goto out_delete;
 247         }
 248
 249         if (use_browser == 2)
 250                 perf_gtk__show_annotations();
 251
 252 out_delete:
 253         /*
 254          * Speed up the exit process, for large files this can
 255          * take quite a while.
 256          *
 257          * XXX Enable this when using valgrind or if we ever
 258          * librarize this command.
 259          *
 260          * Also experiment with obstacks to see how much speed
 261          * up we'll get here.
 262          *
 263          * perf_session__delete(session);
 264          */
 265         return ret;
 266 }
 267
 268 static const char * const annotate_usage[] = {
 269         "perf annotate [<options>]",
 270         NULL
 271 };
 272
 273 int cmd_annotate(int argc, const char **argv, const char *prefix __maybe_unused)
 274 {
 275         struct perf_annotate annotate = {
 276                 .tool = {
 277                         .sample = process_sample_event,
 278                         .mmap   = perf_event__process_mmap,
 279                         .comm   = perf_event__process_comm,
 280                         .exit   = perf_event__process_exit,
 281                         .fork   = perf_event__process_fork,
 282                         .ordered_samples = true,
 283                         .ordering_requires_timestamps = true,
 284                 },
 285         };
 286         const struct option options[] = {
 287         OPT_STRING('i', "input", &input_name, "file",
 288                     "input file name"),
 289         OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]",
 290                    "only consider symbols in these dsos"),
 291         OPT_STRING('s', "symbol", &annotate.sym_hist_filter, "symbol",
 292                     "symbol to annotate"),
 293         OPT_BOOLEAN('f', "force", &annotate.force, "don't complain, do it"),
 294         OPT_INCR('v', "verbose", &verbose,
 295                     "be more verbose (show symbol address, etc)"),
 296         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
 297                     "dump raw trace in ASCII"),
 298         OPT_BOOLEAN(0, "gtk", &annotate.use_gtk, "Use the GTK interface"),
 299         OPT_BOOLEAN(0, "tui", &annotate.use_tui, "Use the TUI interface"),
 300         OPT_BOOLEAN(0, "stdio", &annotate.use_stdio, "Use the stdio interface"),
 301         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
 302                    "file", "vmlinux pathname"),
 303         OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
 304                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
 305         OPT_BOOLEAN('l', "print-line", &annotate.print_line,
 306                     "print matching source lines (may be slow)"),
 307         OPT_BOOLEAN('P', "full-paths", &annotate.full_paths,
 308                     "Don't shorten the displayed pathnames"),
 309         OPT_BOOLEAN(0, "skip-missing", &annotate.skip_missing,
 310                     "Skip symbols that cannot be annotated"),
 311         OPT_STRING('C', "cpu", &annotate.cpu_list, "cpu", "list of cpus to profile"),
 312         OPT_STRING(0, "symfs", &symbol_conf.symfs, "directory",
 313                    "Look for files with symbols relative to this directory"),
 314         OPT_BOOLEAN(0, "source", &symbol_conf.annotate_src,
 315                     "Interleave source code with assembly code (default)"),
 316         OPT_BOOLEAN(0, "asm-raw", &symbol_conf.annotate_asm_raw,
 317                     "Display raw encoding of assembly instructions (default)"),
 318         OPT_STRING('M', "disassembler-style", &disassembler_style, "disassembler style",
 319                    "Specify disassembler style (e.g. -M intel for intel syntax)"),
 320         OPT_STRING(0, "objdump", &objdump_path, "path",
 321                    "objdump binary to use for disassembly and annotations"),
 322         OPT_BOOLEAN(0, "group", &symbol_conf.event_group,
 323                     "Show event group information together"),
 324         OPT_END()
 325         };
 326
 327         argc = parse_options(argc, argv, options, annotate_usage, 0);
 328
 329         if (annotate.use_stdio)
 330                 use_browser = 0;
 331         else if (annotate.use_tui)
 332                 use_browser = 1;
 333         else if (annotate.use_gtk)
 334                 use_browser = 2;
 335
 336         setup_browser(true);
 337
 338         symbol_conf.priv_size = sizeof(struct annotation);
 339         symbol_conf.try_vmlinux_path = true;
 340
 341         if (symbol__init() < 0)
 342                 return -1;
 343
 344         if (setup_sorting() < 0)
 345                 usage_with_options(annotate_usage, options);
 346
 347         if (argc) {
 348                 /*
 349                  * Special case: if there's an argument left then assume tha
 350                  * it's a symbol filter:
 351                  */
 352                 if (argc > 1)
 353                         usage_with_options(annotate_usage, options);
 354
 355                 annotate.sym_hist_filter = argv[0];
 356         }
 357
 358         return __cmd_annotate(&annotate);
 359 }