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