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