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