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