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 "arch/common.h" 32 33 #include <linux/bitmap.h> 34 35 struct perf_annotate { 36 struct perf_tool tool; 37 bool force, use_tui, use_stdio, use_gtk; 38 bool full_paths; 39 bool print_line; 40 bool skip_missing; 41 const char *sym_hist_filter; 42 const char *cpu_list; 43 DECLARE_BITMAP(cpu_bitmap, MAX_NR_CPUS); 44 }; 45 46 static int perf_evsel__add_sample(struct perf_evsel *evsel, 47 struct perf_sample *sample, 48 struct addr_location *al, 49 struct perf_annotate *ann) 50 { 51 struct hist_entry *he; 52 int ret; 53 54 if (ann->sym_hist_filter != NULL && 55 (al->sym == NULL || 56 strcmp(ann->sym_hist_filter, al->sym->name) != 0)) { 57 /* We're only interested in a symbol named sym_hist_filter */ 58 if (al->sym != NULL) { 59 rb_erase(&al->sym->rb_node, 60 &al->map->dso->symbols[al->map->type]); 61 symbol__delete(al->sym); 62 } 63 return 0; 64 } 65 66 he = __hists__add_entry(&evsel->hists, al, NULL, 1, 1); 67 if (he == NULL) 68 return -ENOMEM; 69 70 ret = 0; 71 if (he->ms.sym != NULL) { 72 struct annotation *notes = symbol__annotation(he->ms.sym); 73 if (notes->src == NULL && symbol__alloc_hist(he->ms.sym) < 0) 74 return -ENOMEM; 75 76 ret = hist_entry__inc_addr_samples(he, evsel->idx, al->addr); 77 } 78 79 evsel->hists.stats.total_period += sample->period; 80 hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE); 81 return ret; 82 } 83 84 static int process_sample_event(struct perf_tool *tool, 85 union perf_event *event, 86 struct perf_sample *sample, 87 struct perf_evsel *evsel, 88 struct machine *machine) 89 { 90 struct perf_annotate *ann = container_of(tool, struct perf_annotate, tool); 91 struct addr_location al; 92 93 if (perf_event__preprocess_sample(event, machine, &al, sample) < 0) { 94 pr_warning("problem processing %d event, skipping it.\n", 95 event->header.type); 96 return -1; 97 } 98 99 if (ann->cpu_list && !test_bit(sample->cpu, ann->cpu_bitmap)) 100 return 0; 101 102 if (!al.filtered && perf_evsel__add_sample(evsel, sample, &al, ann)) { 103 pr_warning("problem incrementing symbol count, " 104 "skipping event\n"); 105 return -1; 106 } 107 108 return 0; 109 } 110 111 static int hist_entry__tty_annotate(struct hist_entry *he, 112 struct perf_evsel *evsel, 113 struct perf_annotate *ann) 114 { 115 return symbol__tty_annotate(he->ms.sym, he->ms.map, evsel, 116 ann->print_line, ann->full_paths, 0, 0); 117 } 118 119 static void hists__find_annotations(struct hists *self, 120 struct perf_evsel *evsel, 121 struct perf_annotate *ann) 122 { 123 struct rb_node *nd = rb_first(&self->entries), *next; 124 int key = K_RIGHT; 125 126 while (nd) { 127 struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node); 128 struct annotation *notes; 129 130 if (he->ms.sym == NULL || he->ms.map->dso->annotate_warned) 131 goto find_next; 132 133 notes = symbol__annotation(he->ms.sym); 134 if (notes->src == NULL) { 135 find_next: 136 if (key == K_LEFT) 137 nd = rb_prev(nd); 138 else 139 nd = rb_next(nd); 140 continue; 141 } 142 143 if (use_browser == 2) { 144 int ret; 145 146 ret = hist_entry__gtk_annotate(he, evsel, NULL); 147 if (!ret || !ann->skip_missing) 148 return; 149 150 /* skip missing symbols */ 151 nd = rb_next(nd); 152 } else if (use_browser == 1) { 153 key = hist_entry__tui_annotate(he, evsel, NULL); 154 switch (key) { 155 case -1: 156 if (!ann->skip_missing) 157 return; 158 /* fall through */ 159 case K_RIGHT: 160 next = rb_next(nd); 161 break; 162 case K_LEFT: 163 next = rb_prev(nd); 164 break; 165 default: 166 return; 167 } 168 169 if (next != NULL) 170 nd = next; 171 } else { 172 hist_entry__tty_annotate(he, evsel, ann); 173 nd = rb_next(nd); 174 /* 175 * Since we have a hist_entry per IP for the same 176 * symbol, free he->ms.sym->src to signal we already 177 * processed this symbol. 178 */ 179 free(notes->src); 180 notes->src = NULL; 181 } 182 } 183 } 184 185 static int __cmd_annotate(struct perf_annotate *ann) 186 { 187 int ret; 188 struct perf_session *session; 189 struct perf_evsel *pos; 190 u64 total_nr_samples; 191 192 session = perf_session__new(input_name, O_RDONLY, 193 ann->force, false, &ann->tool); 194 if (session == NULL) 195 return -ENOMEM; 196 197 machines__set_symbol_filter(&session->machines, symbol__annotate_init); 198 199 if (ann->cpu_list) { 200 ret = perf_session__cpu_bitmap(session, ann->cpu_list, 201 ann->cpu_bitmap); 202 if (ret) 203 goto out_delete; 204 } 205 206 if (!objdump_path) { 207 ret = perf_session_env__lookup_objdump(&session->header.env); 208 if (ret) 209 goto out_delete; 210 } 211 212 ret = perf_session__process_events(session, &ann->tool); 213 if (ret) 214 goto out_delete; 215 216 if (dump_trace) { 217 perf_session__fprintf_nr_events(session, stdout); 218 goto out_delete; 219 } 220 221 if (verbose > 3) 222 perf_session__fprintf(session, stdout); 223 224 if (verbose > 2) 225 perf_session__fprintf_dsos(session, stdout); 226 227 total_nr_samples = 0; 228 list_for_each_entry(pos, &session->evlist->entries, node) { 229 struct hists *hists = &pos->hists; 230 u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE]; 231 232 if (nr_samples > 0) { 233 total_nr_samples += nr_samples; 234 hists__collapse_resort(hists); 235 hists__output_resort(hists); 236 237 if (symbol_conf.event_group && 238 !perf_evsel__is_group_leader(pos)) 239 continue; 240 241 hists__find_annotations(hists, pos, ann); 242 } 243 } 244 245 if (total_nr_samples == 0) { 246 ui__error("The %s file has no samples!\n", session->filename); 247 goto out_delete; 248 } 249 250 if (use_browser == 2) 251 perf_gtk__show_annotations(); 252 253 out_delete: 254 /* 255 * Speed up the exit process, for large files this can 256 * take quite a while. 257 * 258 * XXX Enable this when using valgrind or if we ever 259 * librarize this command. 260 * 261 * Also experiment with obstacks to see how much speed 262 * up we'll get here. 263 * 264 * perf_session__delete(session); 265 */ 266 return ret; 267 } 268 269 static const char * const annotate_usage[] = { 270 "perf annotate [<options>]", 271 NULL 272 }; 273 274 int cmd_annotate(int argc, const char **argv, const char *prefix __maybe_unused) 275 { 276 struct perf_annotate annotate = { 277 .tool = { 278 .sample = process_sample_event, 279 .mmap = perf_event__process_mmap, 280 .mmap2 = perf_event__process_mmap2, 281 .comm = perf_event__process_comm, 282 .exit = perf_event__process_exit, 283 .fork = perf_event__process_fork, 284 .ordered_samples = true, 285 .ordering_requires_timestamps = true, 286 }, 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", &annotate.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 329 argc = parse_options(argc, argv, options, annotate_usage, 0); 330 331 if (annotate.use_stdio) 332 use_browser = 0; 333 else if (annotate.use_tui) 334 use_browser = 1; 335 else if (annotate.use_gtk) 336 use_browser = 2; 337 338 setup_browser(true); 339 340 symbol_conf.priv_size = sizeof(struct annotation); 341 symbol_conf.try_vmlinux_path = true; 342 343 if (symbol__init() < 0) 344 return -1; 345 346 if (setup_sorting() < 0) 347 usage_with_options(annotate_usage, options); 348 349 if (argc) { 350 /* 351 * Special case: if there's an argument left then assume tha 352 * it's a symbol filter: 353 */ 354 if (argc > 1) 355 usage_with_options(annotate_usage, options); 356 357 annotate.sym_hist_filter = argv[0]; 358 } 359 360 return __cmd_annotate(&annotate); 361 } 362
