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