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