1 #include "../../util/util.h"
2 #include "../browser.h"
3 #include "../helpline.h"
4 #include "../libslang.h"
7 #include "../../util/annotate.h"
8 #include "../../util/hist.h"
9 #include "../../util/sort.h"
10 #include "../../util/symbol.h"
14 struct browser_disasm_line {
15 struct rb_node rb_node;
22 struct annotate_browser {
24 struct rb_root entries;
25 struct rb_node *curr_hot;
26 struct disasm_line *selection;
27 struct disasm_line **offsets;
34 bool searching_backwards;
39 static inline struct browser_disasm_line *disasm_line__browser(struct disasm_line *dl)
41 return (struct browser_disasm_line *)(dl + 1);
44 static bool disasm_line__filter(struct ui_browser *browser, void *entry)
46 struct annotate_browser *ab = container_of(browser, struct annotate_browser, b);
48 if (ab->hide_src_code) {
49 struct disasm_line *dl = list_entry(entry, struct disasm_line, node);
50 return dl->offset == -1;
56 static void annotate_browser__write(struct ui_browser *self, void *entry, int row)
58 struct annotate_browser *ab = container_of(self, struct annotate_browser, b);
59 struct disasm_line *dl = list_entry(entry, struct disasm_line, node);
60 struct browser_disasm_line *bdl = disasm_line__browser(dl);
61 bool current_entry = ui_browser__is_current_entry(self, row);
62 bool change_color = (!ab->hide_src_code &&
63 (!current_entry || (self->use_navkeypressed &&
64 !self->navkeypressed)));
65 int width = self->width;
67 if (dl->offset != -1) {
68 ui_browser__set_percent_color(self, bdl->percent, current_entry);
69 slsmg_printf(" %7.2f ", bdl->percent);
71 ui_browser__set_percent_color(self, 0, current_entry);
72 slsmg_write_nstring(" ", 9);
75 ui_browser__write_graph(self, SLSMG_VLINE_CHAR);
76 SLsmg_write_char(' ');
78 /* The scroll bar isn't being used */
79 if (!self->navkeypressed)
82 if (dl->offset != -1 && change_color)
83 ui_browser__set_color(self, HE_COLORSET_CODE);
86 slsmg_write_nstring(" ", width - 10);
87 else if (dl->offset == -1)
88 slsmg_write_nstring(dl->line, width - 10);
91 u64 addr = dl->offset;
92 int printed, color = -1;
97 if (!ab->use_offset) {
98 printed = scnprintf(bf, sizeof(bf), " %" PRIx64 ":", addr);
100 if (bdl->jump_target) {
101 printed = scnprintf(bf, sizeof(bf), " %*" PRIx64 ":",
102 ab->offset_width, addr);
104 printed = scnprintf(bf, sizeof(bf), " %*s ",
105 ab->offset_width, " ");
110 color = ui_browser__set_color(self, HE_COLORSET_ADDR);
111 slsmg_write_nstring(bf, printed);
113 ui_browser__set_color(self, color);
114 if (dl->ins && dl->ins->ops->scnprintf) {
115 if (ins__is_jump(dl->ins)) {
116 bool fwd = dl->ops.target.offset > (u64)dl->offset;
118 ui_browser__write_graph(self, fwd ? SLSMG_DARROW_CHAR :
120 SLsmg_write_char(' ');
121 } else if (ins__is_call(dl->ins)) {
122 ui_browser__write_graph(self, SLSMG_RARROW_CHAR);
123 SLsmg_write_char(' ');
125 slsmg_write_nstring(" ", 2);
128 dl->ins->ops->scnprintf(dl->ins, bf, sizeof(bf), &dl->ops,
131 if (strcmp(dl->name, "retq")) {
132 slsmg_write_nstring(" ", 2);
134 ui_browser__write_graph(self, SLSMG_LARROW_CHAR);
135 SLsmg_write_char(' ');
138 scnprintf(bf, sizeof(bf), "%-6.6s %s", dl->name, dl->ops.raw);
141 slsmg_write_nstring(bf, width - 12 - printed);
148 static void annotate_browser__draw_current_jump(struct ui_browser *browser)
150 struct annotate_browser *ab = container_of(browser, struct annotate_browser, b);
151 struct disasm_line *cursor = ab->selection, *target;
152 struct browser_disasm_line *btarget, *bcursor;
153 unsigned int from, to, start_width = 2;
155 if (!cursor->ins || !ins__is_jump(cursor->ins) ||
156 !disasm_line__has_offset(cursor))
159 target = ab->offsets[cursor->ops.target.offset];
163 bcursor = disasm_line__browser(cursor);
164 btarget = disasm_line__browser(target);
166 if (ab->hide_src_code) {
167 from = bcursor->idx_asm;
168 to = btarget->idx_asm;
170 from = (u64)bcursor->idx;
171 to = (u64)btarget->idx;
174 ui_browser__set_color(browser, HE_COLORSET_CODE);
176 if (!bcursor->jump_target)
177 start_width += ab->offset_width + 1;
179 __ui_browser__line_arrow(browser, 10, from, to, start_width);
182 static unsigned int annotate_browser__refresh(struct ui_browser *browser)
184 struct annotate_browser *ab = container_of(browser, struct annotate_browser, b);
185 int ret = ui_browser__list_head_refresh(browser);
188 annotate_browser__draw_current_jump(browser);
193 static double disasm_line__calc_percent(struct disasm_line *dl, struct symbol *sym, int evidx)
195 double percent = 0.0;
197 if (dl->offset != -1) {
198 int len = sym->end - sym->start;
199 unsigned int hits = 0;
200 struct annotation *notes = symbol__annotation(sym);
201 struct source_line *src_line = notes->src->lines;
202 struct sym_hist *h = annotation__histogram(notes, evidx);
203 s64 offset = dl->offset;
204 struct disasm_line *next;
206 next = disasm__get_next_ip_line(¬es->src->source, dl);
207 while (offset < (s64)len &&
208 (next == NULL || offset < next->offset)) {
210 percent += src_line[offset].percent;
212 hits += h->addr[offset];
217 * If the percentage wasn't already calculated in
218 * symbol__get_source_line, do it now:
220 if (src_line == NULL && h->sum)
221 percent = 100.0 * hits / h->sum;
227 static void disasm_rb_tree__insert(struct rb_root *root, struct browser_disasm_line *bdl)
229 struct rb_node **p = &root->rb_node;
230 struct rb_node *parent = NULL;
231 struct browser_disasm_line *l;
235 l = rb_entry(parent, struct browser_disasm_line, rb_node);
236 if (bdl->percent < l->percent)
241 rb_link_node(&bdl->rb_node, parent, p);
242 rb_insert_color(&bdl->rb_node, root);
245 static void annotate_browser__set_top(struct annotate_browser *self,
246 struct disasm_line *pos, u32 idx)
250 ui_browser__refresh_dimensions(&self->b);
251 back = self->b.height / 2;
252 self->b.top_idx = self->b.index = idx;
254 while (self->b.top_idx != 0 && back != 0) {
255 pos = list_entry(pos->node.prev, struct disasm_line, node);
257 if (disasm_line__filter(&self->b, &pos->node))
265 self->b.navkeypressed = true;
268 static void annotate_browser__set_rb_top(struct annotate_browser *browser,
271 struct browser_disasm_line *bpos;
272 struct disasm_line *pos;
274 bpos = rb_entry(nd, struct browser_disasm_line, rb_node);
275 pos = ((struct disasm_line *)bpos) - 1;
276 annotate_browser__set_top(browser, pos, bpos->idx);
277 browser->curr_hot = nd;
280 static void annotate_browser__calc_percent(struct annotate_browser *browser,
283 struct map_symbol *ms = browser->b.priv;
284 struct symbol *sym = ms->sym;
285 struct annotation *notes = symbol__annotation(sym);
286 struct disasm_line *pos;
288 browser->entries = RB_ROOT;
290 pthread_mutex_lock(¬es->lock);
292 list_for_each_entry(pos, ¬es->src->source, node) {
293 struct browser_disasm_line *bpos = disasm_line__browser(pos);
294 bpos->percent = disasm_line__calc_percent(pos, sym, evidx);
295 if (bpos->percent < 0.01) {
296 RB_CLEAR_NODE(&bpos->rb_node);
299 disasm_rb_tree__insert(&browser->entries, bpos);
301 pthread_mutex_unlock(¬es->lock);
303 browser->curr_hot = rb_last(&browser->entries);
306 static bool annotate_browser__toggle_source(struct annotate_browser *browser)
308 struct disasm_line *dl;
309 struct browser_disasm_line *bdl;
310 off_t offset = browser->b.index - browser->b.top_idx;
312 browser->b.seek(&browser->b, offset, SEEK_CUR);
313 dl = list_entry(browser->b.top, struct disasm_line, node);
314 bdl = disasm_line__browser(dl);
316 if (browser->hide_src_code) {
317 if (bdl->idx_asm < offset)
320 browser->b.nr_entries = browser->nr_entries;
321 browser->hide_src_code = false;
322 browser->b.seek(&browser->b, -offset, SEEK_CUR);
323 browser->b.top_idx = bdl->idx - offset;
324 browser->b.index = bdl->idx;
326 if (bdl->idx_asm < 0) {
327 ui_helpline__puts("Only available for assembly lines.");
328 browser->b.seek(&browser->b, -offset, SEEK_CUR);
332 if (bdl->idx_asm < offset)
333 offset = bdl->idx_asm;
335 browser->b.nr_entries = browser->nr_asm_entries;
336 browser->hide_src_code = true;
337 browser->b.seek(&browser->b, -offset, SEEK_CUR);
338 browser->b.top_idx = bdl->idx_asm - offset;
339 browser->b.index = bdl->idx_asm;
345 static bool annotate_browser__callq(struct annotate_browser *browser,
346 int evidx, void (*timer)(void *arg),
347 void *arg, int delay_secs)
349 struct map_symbol *ms = browser->b.priv;
350 struct disasm_line *dl = browser->selection;
351 struct symbol *sym = ms->sym;
352 struct annotation *notes;
353 struct symbol *target;
356 if (!ins__is_call(dl->ins))
359 ip = ms->map->map_ip(ms->map, dl->ops.target.addr);
360 target = map__find_symbol(ms->map, ip, NULL);
361 if (target == NULL) {
362 ui_helpline__puts("The called function was not found.");
366 notes = symbol__annotation(target);
367 pthread_mutex_lock(¬es->lock);
369 if (notes->src == NULL && symbol__alloc_hist(target) < 0) {
370 pthread_mutex_unlock(¬es->lock);
371 ui__warning("Not enough memory for annotating '%s' symbol!\n",
376 pthread_mutex_unlock(¬es->lock);
377 symbol__tui_annotate(target, ms->map, evidx, timer, arg, delay_secs);
378 ui_browser__show_title(&browser->b, sym->name);
383 struct disasm_line *annotate_browser__find_offset(struct annotate_browser *browser,
384 s64 offset, s64 *idx)
386 struct map_symbol *ms = browser->b.priv;
387 struct symbol *sym = ms->sym;
388 struct annotation *notes = symbol__annotation(sym);
389 struct disasm_line *pos;
392 list_for_each_entry(pos, ¬es->src->source, node) {
393 if (pos->offset == offset)
395 if (!disasm_line__filter(&browser->b, &pos->node))
402 static bool annotate_browser__jump(struct annotate_browser *browser)
404 struct disasm_line *dl = browser->selection;
407 if (!ins__is_jump(dl->ins))
410 dl = annotate_browser__find_offset(browser, dl->ops.target.offset, &idx);
412 ui_helpline__puts("Invallid jump offset");
416 annotate_browser__set_top(browser, dl, idx);
422 struct disasm_line *annotate_browser__find_string(struct annotate_browser *browser,
425 struct map_symbol *ms = browser->b.priv;
426 struct symbol *sym = ms->sym;
427 struct annotation *notes = symbol__annotation(sym);
428 struct disasm_line *pos = browser->selection;
430 *idx = browser->b.index;
431 list_for_each_entry_continue(pos, ¬es->src->source, node) {
432 if (disasm_line__filter(&browser->b, &pos->node))
437 if (pos->line && strstr(pos->line, s) != NULL)
444 static bool __annotate_browser__search(struct annotate_browser *browser)
446 struct disasm_line *dl;
449 dl = annotate_browser__find_string(browser, browser->search_bf, &idx);
451 ui_helpline__puts("String not found!");
455 annotate_browser__set_top(browser, dl, idx);
456 browser->searching_backwards = false;
461 struct disasm_line *annotate_browser__find_string_reverse(struct annotate_browser *browser,
464 struct map_symbol *ms = browser->b.priv;
465 struct symbol *sym = ms->sym;
466 struct annotation *notes = symbol__annotation(sym);
467 struct disasm_line *pos = browser->selection;
469 *idx = browser->b.index;
470 list_for_each_entry_continue_reverse(pos, ¬es->src->source, node) {
471 if (disasm_line__filter(&browser->b, &pos->node))
476 if (pos->line && strstr(pos->line, s) != NULL)
483 static bool __annotate_browser__search_reverse(struct annotate_browser *browser)
485 struct disasm_line *dl;
488 dl = annotate_browser__find_string_reverse(browser, browser->search_bf, &idx);
490 ui_helpline__puts("String not found!");
494 annotate_browser__set_top(browser, dl, idx);
495 browser->searching_backwards = true;
499 static bool annotate_browser__search_window(struct annotate_browser *browser,
502 if (ui_browser__input_window("Search", "String: ", browser->search_bf,
503 "ENTER: OK, ESC: Cancel",
504 delay_secs * 2) != K_ENTER ||
505 !*browser->search_bf)
511 static bool annotate_browser__search(struct annotate_browser *browser, int delay_secs)
513 if (annotate_browser__search_window(browser, delay_secs))
514 return __annotate_browser__search(browser);
519 static bool annotate_browser__continue_search(struct annotate_browser *browser,
522 if (!*browser->search_bf)
523 return annotate_browser__search(browser, delay_secs);
525 return __annotate_browser__search(browser);
528 static bool annotate_browser__search_reverse(struct annotate_browser *browser,
531 if (annotate_browser__search_window(browser, delay_secs))
532 return __annotate_browser__search_reverse(browser);
538 bool annotate_browser__continue_search_reverse(struct annotate_browser *browser,
541 if (!*browser->search_bf)
542 return annotate_browser__search_reverse(browser, delay_secs);
544 return __annotate_browser__search_reverse(browser);
547 static int annotate_browser__run(struct annotate_browser *self, int evidx,
548 void(*timer)(void *arg),
549 void *arg, int delay_secs)
551 struct rb_node *nd = NULL;
552 struct map_symbol *ms = self->b.priv;
553 struct symbol *sym = ms->sym;
554 const char *help = "<-/ESC: Exit, TAB/shift+TAB: Cycle hot lines, "
555 "H: Go to hottest line, ->/ENTER: Line action, "
556 "O: Toggle offset view, "
557 "S: Toggle source code view";
560 if (ui_browser__show(&self->b, sym->name, help) < 0)
563 annotate_browser__calc_percent(self, evidx);
565 if (self->curr_hot) {
566 annotate_browser__set_rb_top(self, self->curr_hot);
567 self->b.navkeypressed = false;
573 key = ui_browser__run(&self->b, delay_secs);
575 if (delay_secs != 0) {
576 annotate_browser__calc_percent(self, evidx);
578 * Current line focus got out of the list of most active
579 * lines, NULL it so that if TAB|UNTAB is pressed, we
580 * move to curr_hot (current hottest line).
582 if (nd != NULL && RB_EMPTY_NODE(nd))
592 symbol__annotate_decay_histogram(sym, evidx);
598 nd = rb_last(&self->entries);
606 nd = rb_first(&self->entries);
616 if (annotate_browser__toggle_source(self))
617 ui_helpline__puts(help);
621 self->use_offset = !self->use_offset;
624 self->jump_arrows = !self->jump_arrows;
627 if (annotate_browser__search(self, delay_secs)) {
629 ui_helpline__puts(help);
633 if (self->searching_backwards ?
634 annotate_browser__continue_search_reverse(self, delay_secs) :
635 annotate_browser__continue_search(self, delay_secs))
639 if (annotate_browser__search_reverse(self, delay_secs))
644 if (self->selection == NULL)
645 ui_helpline__puts("Huh? No selection. Report to linux-kernel@vger.kernel.org");
646 else if (self->selection->offset == -1)
647 ui_helpline__puts("Actions are only available for assembly lines.");
648 else if (!self->selection->ins) {
649 if (strcmp(self->selection->name, "retq"))
652 } else if (!(annotate_browser__jump(self) ||
653 annotate_browser__callq(self, evidx, timer, arg, delay_secs))) {
655 ui_helpline__puts("Actions are only available for 'callq', 'retq' & jump instructions.");
668 annotate_browser__set_rb_top(self, nd);
671 ui_browser__hide(&self->b);
675 int hist_entry__tui_annotate(struct hist_entry *he, int evidx,
676 void(*timer)(void *arg), void *arg, int delay_secs)
678 return symbol__tui_annotate(he->ms.sym, he->ms.map, evidx,
679 timer, arg, delay_secs);
682 static void annotate_browser__mark_jump_targets(struct annotate_browser *browser,
687 for (offset = 0; offset < size; ++offset) {
688 struct disasm_line *dl = browser->offsets[offset], *dlt;
689 struct browser_disasm_line *bdlt;
691 if (!dl || !dl->ins || !ins__is_jump(dl->ins) ||
692 !disasm_line__has_offset(dl))
695 if (dl->ops.target.offset >= size) {
696 ui__error("jump to after symbol!\n"
697 "size: %zx, jump target: %" PRIx64,
698 size, dl->ops.target.offset);
702 dlt = browser->offsets[dl->ops.target.offset];
704 * FIXME: Oops, no jump target? Buggy disassembler? Or do we
705 * have to adjust to the previous offset?
710 bdlt = disasm_line__browser(dlt);
711 bdlt->jump_target = true;
716 int symbol__tui_annotate(struct symbol *sym, struct map *map, int evidx,
717 void(*timer)(void *arg), void *arg,
720 struct disasm_line *pos, *n;
721 struct annotation *notes;
722 const size_t size = symbol__size(sym);
723 struct map_symbol ms = {
727 struct annotate_browser browser = {
729 .refresh = annotate_browser__refresh,
730 .seek = ui_browser__list_head_seek,
731 .write = annotate_browser__write,
732 .filter = disasm_line__filter,
734 .use_navkeypressed = true,
744 if (map->dso->annotate_warned)
747 browser.offsets = zalloc(size * sizeof(struct disasm_line *));
748 if (browser.offsets == NULL) {
749 ui__error("Not enough memory!");
753 if (symbol__annotate(sym, map, sizeof(struct browser_disasm_line)) < 0) {
754 ui__error("%s", ui_helpline__last_msg);
755 goto out_free_offsets;
758 ui_helpline__push("Press <- or ESC to exit");
760 notes = symbol__annotation(sym);
761 browser.start = map__rip_2objdump(map, sym->start);
763 list_for_each_entry(pos, ¬es->src->source, node) {
764 struct browser_disasm_line *bpos;
765 size_t line_len = strlen(pos->line);
767 if (browser.b.width < line_len)
768 browser.b.width = line_len;
769 bpos = disasm_line__browser(pos);
770 bpos->idx = browser.nr_entries++;
771 if (pos->offset != -1) {
772 bpos->idx_asm = browser.nr_asm_entries++;
774 * FIXME: short term bandaid to cope with assembly
775 * routines that comes with labels in the same column
776 * as the address in objdump, sigh.
778 * E.g. copy_user_generic_unrolled
780 if (pos->offset < (s64)size)
781 browser.offsets[pos->offset] = pos;
786 annotate_browser__mark_jump_targets(&browser, size);
788 browser.offset_width = hex_width(size);
789 browser.b.nr_entries = browser.nr_entries;
790 browser.b.entries = ¬es->src->source,
791 browser.b.width += 18; /* Percentage */
792 ret = annotate_browser__run(&browser, evidx, timer, arg, delay_secs);
793 list_for_each_entry_safe(pos, n, ¬es->src->source, node) {
794 list_del(&pos->node);
795 disasm_line__free(pos);
799 free(browser.offsets);