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