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