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 12 #include "util/util.h" 13 #include "util/color.h" 14 #include <linux/list.h> 15 #include "util/cache.h" 16 #include <linux/rbtree.h> 17 #include "util/symbol.h" 18 19 #include "perf.h" 20 #include "util/debug.h" 21 22 #include "util/evlist.h" 23 #include "util/evsel.h" 24 #include "util/annotate.h" 25 #include "util/event.h" 26 #include "util/parse-options.h" 27 #include "util/parse-events.h" 28 #include "util/thread.h" 29 #include "util/sort.h" 30 #include "util/hist.h" 31 #include "util/session.h" 32 33 static char const *input_name = "perf.data"; 34 35 static bool force, use_tui, use_stdio; 36 37 static bool full_paths; 38 39 static bool print_line; 40 41 static const char *sym_hist_filter; 42 43 static int perf_evlist__add_sample(struct perf_evlist *evlist, 44 struct perf_sample *sample, 45 struct addr_location *al) 46 { 47 struct perf_evsel *evsel; 48 struct hist_entry *he; 49 int ret; 50 51 if (sym_hist_filter != NULL && 52 (al->sym == NULL || strcmp(sym_hist_filter, al->sym->name) != 0)) { 53 /* We're only interested in a symbol named sym_hist_filter */ 54 if (al->sym != NULL) { 55 rb_erase(&al->sym->rb_node, 56 &al->map->dso->symbols[al->map->type]); 57 symbol__delete(al->sym); 58 } 59 return 0; 60 } 61 62 evsel = perf_evlist__id2evsel(evlist, sample->id); 63 if (evsel == NULL) { 64 /* 65 * FIXME: Propagate this back, but at least we're in a builtin, 66 * where exit() is allowed. ;-) 67 */ 68 ui__warning("Invalid %s file, contains samples with id not in " 69 "its header!\n", input_name); 70 exit_browser(0); 71 exit(1); 72 } 73 74 he = __hists__add_entry(&evsel->hists, al, NULL, 1); 75 if (he == NULL) 76 return -ENOMEM; 77 78 ret = 0; 79 if (he->ms.sym != NULL) { 80 struct annotation *notes = symbol__annotation(he->ms.sym); 81 if (notes->src == NULL && 82 symbol__alloc_hist(he->ms.sym, evlist->nr_entries) < 0) 83 return -ENOMEM; 84 85 ret = hist_entry__inc_addr_samples(he, evsel->idx, al->addr); 86 } 87 88 evsel->hists.stats.total_period += sample->period; 89 hists__inc_nr_events(&evsel->hists, PERF_RECORD_SAMPLE); 90 return ret; 91 } 92 93 static int process_sample_event(union perf_event *event, 94 struct perf_sample *sample, 95 struct perf_session *session) 96 { 97 struct addr_location al; 98 99 if (perf_event__preprocess_sample(event, session, &al, sample, 100 symbol__annotate_init) < 0) { 101 pr_warning("problem processing %d event, skipping it.\n", 102 event->header.type); 103 return -1; 104 } 105 106 if (!al.filtered && perf_evlist__add_sample(session->evlist, sample, &al)) { 107 pr_warning("problem incrementing symbol count, " 108 "skipping event\n"); 109 return -1; 110 } 111 112 return 0; 113 } 114 115 static int hist_entry__tty_annotate(struct hist_entry *he, int evidx) 116 { 117 return symbol__tty_annotate(he->ms.sym, he->ms.map, evidx, 118 print_line, full_paths, 0, 0); 119 } 120 121 static void hists__find_annotations(struct hists *self, int evidx) 122 { 123 struct rb_node *nd = rb_first(&self->entries), *next; 124 int key = KEY_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 == KEY_LEFT) 137 nd = rb_prev(nd); 138 else 139 nd = rb_next(nd); 140 continue; 141 } 142 143 if (use_browser > 0) { 144 key = hist_entry__tui_annotate(he, evidx); 145 switch (key) { 146 case KEY_RIGHT: 147 next = rb_next(nd); 148 break; 149 case KEY_LEFT: 150 next = rb_prev(nd); 151 break; 152 default: 153 return; 154 } 155 156 if (next != NULL) 157 nd = next; 158 } else { 159 hist_entry__tty_annotate(he, evidx); 160 nd = rb_next(nd); 161 /* 162 * Since we have a hist_entry per IP for the same 163 * symbol, free he->ms.sym->src to signal we already 164 * processed this symbol. 165 */ 166 free(notes->src); 167 notes->src = NULL; 168 } 169 } 170 } 171 172 static struct perf_event_ops event_ops = { 173 .sample = process_sample_event, 174 .mmap = perf_event__process_mmap, 175 .comm = perf_event__process_comm, 176 .fork = perf_event__process_task, 177 .ordered_samples = true, 178 .ordering_requires_timestamps = true, 179 }; 180 181 static int __cmd_annotate(void) 182 { 183 int ret; 184 struct perf_session *session; 185 struct perf_evsel *pos; 186 u64 total_nr_samples; 187 188 session = perf_session__new(input_name, O_RDONLY, force, false, &event_ops); 189 if (session == NULL) 190 return -ENOMEM; 191 192 ret = perf_session__process_events(session, &event_ops); 193 if (ret) 194 goto out_delete; 195 196 if (dump_trace) { 197 perf_session__fprintf_nr_events(session, stdout); 198 goto out_delete; 199 } 200 201 if (verbose > 3) 202 perf_session__fprintf(session, stdout); 203 204 if (verbose > 2) 205 perf_session__fprintf_dsos(session, stdout); 206 207 total_nr_samples = 0; 208 list_for_each_entry(pos, &session->evlist->entries, node) { 209 struct hists *hists = &pos->hists; 210 u32 nr_samples = hists->stats.nr_events[PERF_RECORD_SAMPLE]; 211 212 if (nr_samples > 0) { 213 total_nr_samples += nr_samples; 214 hists__collapse_resort(hists); 215 hists__output_resort(hists); 216 hists__find_annotations(hists, pos->idx); 217 } 218 } 219 220 if (total_nr_samples == 0) { 221 ui__warning("The %s file has no samples!\n", input_name); 222 goto out_delete; 223 } 224 out_delete: 225 /* 226 * Speed up the exit process, for large files this can 227 * take quite a while. 228 * 229 * XXX Enable this when using valgrind or if we ever 230 * librarize this command. 231 * 232 * Also experiment with obstacks to see how much speed 233 * up we'll get here. 234 * 235 * perf_session__delete(session); 236 */ 237 return ret; 238 } 239 240 static const char * const annotate_usage[] = { 241 "perf annotate [<options>] <command>", 242 NULL 243 }; 244 245 static const struct option options[] = { 246 OPT_STRING('i', "input", &input_name, "file", 247 "input file name"), 248 OPT_STRING('d', "dsos", &symbol_conf.dso_list_str, "dso[,dso...]", 249 "only consider symbols in these dsos"), 250 OPT_STRING('s', "symbol", &sym_hist_filter, "symbol", 251 "symbol to annotate"), 252 OPT_BOOLEAN('f', "force", &force, "don't complain, do it"), 253 OPT_INCR('v', "verbose", &verbose, 254 "be more verbose (show symbol address, etc)"), 255 OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace, 256 "dump raw trace in ASCII"), 257 OPT_BOOLEAN(0, "tui", &use_tui, "Use the TUI interface"), 258 OPT_BOOLEAN(0, "stdio", &use_stdio, "Use the stdio interface"), 259 OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name, 260 "file", "vmlinux pathname"), 261 OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules, 262 "load module symbols - WARNING: use only with -k and LIVE kernel"), 263 OPT_BOOLEAN('l', "print-line", &print_line, 264 "print matching source lines (may be slow)"), 265 OPT_BOOLEAN('P', "full-paths", &full_paths, 266 "Don't shorten the displayed pathnames"), 267 OPT_END() 268 }; 269 270 int cmd_annotate(int argc, const char **argv, const char *prefix __used) 271 { 272 argc = parse_options(argc, argv, options, annotate_usage, 0); 273 274 if (use_stdio) 275 use_browser = 0; 276 else if (use_tui) 277 use_browser = 1; 278 279 setup_browser(true); 280 281 symbol_conf.priv_size = sizeof(struct annotation); 282 symbol_conf.try_vmlinux_path = true; 283 284 if (symbol__init() < 0) 285 return -1; 286 287 setup_sorting(annotate_usage, options); 288 289 if (argc) { 290 /* 291 * Special case: if there's an argument left then assume tha 292 * it's a symbol filter: 293 */ 294 if (argc > 1) 295 usage_with_options(annotate_usage, options); 296 297 sym_hist_filter = argv[0]; 298 } 299 300 if (field_sep && *field_sep == '.') { 301 pr_err("'.' is the only non valid --field-separator argument\n"); 302 return -1; 303 } 304 305 return __cmd_annotate(); 306 } 307