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;
41 static inline struct browser_disasm_line *disasm_line__browser(struct disasm_line *dl)
43 return (struct browser_disasm_line *)(dl + 1);
46 static bool disasm_line__filter(struct ui_browser *browser, void *entry)
48 struct annotate_browser *ab = container_of(browser, struct annotate_browser, b);
50 if (ab->hide_src_code) {
51 struct disasm_line *dl = list_entry(entry, struct disasm_line, node);
52 return dl->offset == -1;
58 static void annotate_browser__write(struct ui_browser *self, void *entry, int row)
60 struct annotate_browser *ab = container_of(self, struct annotate_browser, b);
61 struct disasm_line *dl = list_entry(entry, struct disasm_line, node);
62 struct browser_disasm_line *bdl = disasm_line__browser(dl);
63 bool current_entry = ui_browser__is_current_entry(self, row);
64 bool change_color = (!ab->hide_src_code &&
65 (!current_entry || (self->use_navkeypressed &&
66 !self->navkeypressed)));
67 int width = self->width, printed;
70 if (dl->offset != -1 && bdl->percent != 0.0) {
71 ui_browser__set_percent_color(self, bdl->percent, current_entry);
72 slsmg_printf("%6.2f ", bdl->percent);
74 ui_browser__set_percent_color(self, 0, current_entry);
75 slsmg_write_nstring(" ", 7);
78 SLsmg_write_char(' ');
80 /* The scroll bar isn't being used */
81 if (!self->navkeypressed)
85 slsmg_write_nstring(" ", width - 7);
86 else if (dl->offset == -1) {
87 printed = scnprintf(bf, sizeof(bf), "%*s ",
89 slsmg_write_nstring(bf, printed);
90 slsmg_write_nstring(dl->line, width - printed - 6);
92 u64 addr = dl->offset;
98 if (!ab->use_offset) {
99 printed = scnprintf(bf, sizeof(bf), "%" PRIx64 ": ", addr);
101 if (bdl->jump_target) {
102 printed = scnprintf(bf, sizeof(bf), "%*" PRIx64 ": ",
103 ab->addr_width, addr);
105 printed = scnprintf(bf, sizeof(bf), "%*s ",
106 ab->addr_width, " ");
111 color = ui_browser__set_color(self, HE_COLORSET_ADDR);
112 slsmg_write_nstring(bf, printed);
114 ui_browser__set_color(self, color);
115 if (dl->ins && dl->ins->ops->scnprintf) {
116 if (ins__is_jump(dl->ins)) {
117 bool fwd = dl->ops.target.offset > (u64)dl->offset;
119 ui_browser__write_graph(self, fwd ? SLSMG_DARROW_CHAR :
121 SLsmg_write_char(' ');
122 } else if (ins__is_call(dl->ins)) {
123 ui_browser__write_graph(self, SLSMG_RARROW_CHAR);
124 SLsmg_write_char(' ');
126 slsmg_write_nstring(" ", 2);
129 if (strcmp(dl->name, "retq")) {
130 slsmg_write_nstring(" ", 2);
132 ui_browser__write_graph(self, SLSMG_LARROW_CHAR);
133 SLsmg_write_char(' ');
137 disasm_line__scnprintf(dl, bf, sizeof(bf), !ab->use_offset);
138 slsmg_write_nstring(bf, width - 10 - printed);
145 static void annotate_browser__draw_current_jump(struct ui_browser *browser)
147 struct annotate_browser *ab = container_of(browser, struct annotate_browser, b);
148 struct disasm_line *cursor = ab->selection, *target;
149 struct browser_disasm_line *btarget, *bcursor;
150 unsigned int from, to;
152 if (!cursor->ins || !ins__is_jump(cursor->ins) ||
153 !disasm_line__has_offset(cursor))
156 target = ab->offsets[cursor->ops.target.offset];
160 bcursor = disasm_line__browser(cursor);
161 btarget = disasm_line__browser(target);
163 if (ab->hide_src_code) {
164 from = bcursor->idx_asm;
165 to = btarget->idx_asm;
167 from = (u64)bcursor->idx;
168 to = (u64)btarget->idx;
171 ui_browser__set_color(browser, HE_COLORSET_CODE);
172 __ui_browser__line_arrow(browser, 9 + ab->addr_width, from, to);
175 static unsigned int annotate_browser__refresh(struct ui_browser *browser)
177 struct annotate_browser *ab = container_of(browser, struct annotate_browser, b);
178 int ret = ui_browser__list_head_refresh(browser);
181 annotate_browser__draw_current_jump(browser);
183 ui_browser__set_color(browser, HE_COLORSET_NORMAL);
184 __ui_browser__vline(browser, 7, 0, browser->height - 1);
188 static double disasm_line__calc_percent(struct disasm_line *dl, struct symbol *sym, int evidx)
190 double percent = 0.0;
192 if (dl->offset != -1) {
193 int len = sym->end - sym->start;
194 unsigned int hits = 0;
195 struct annotation *notes = symbol__annotation(sym);
196 struct source_line *src_line = notes->src->lines;
197 struct sym_hist *h = annotation__histogram(notes, evidx);
198 s64 offset = dl->offset;
199 struct disasm_line *next;
201 next = disasm__get_next_ip_line(¬es->src->source, dl);
202 while (offset < (s64)len &&
203 (next == NULL || offset < next->offset)) {
205 percent += src_line[offset].percent;
207 hits += h->addr[offset];
212 * If the percentage wasn't already calculated in
213 * symbol__get_source_line, do it now:
215 if (src_line == NULL && h->sum)
216 percent = 100.0 * hits / h->sum;
222 static void disasm_rb_tree__insert(struct rb_root *root, struct browser_disasm_line *bdl)
224 struct rb_node **p = &root->rb_node;
225 struct rb_node *parent = NULL;
226 struct browser_disasm_line *l;
230 l = rb_entry(parent, struct browser_disasm_line, rb_node);
231 if (bdl->percent < l->percent)
236 rb_link_node(&bdl->rb_node, parent, p);
237 rb_insert_color(&bdl->rb_node, root);
240 static void annotate_browser__set_top(struct annotate_browser *self,
241 struct disasm_line *pos, u32 idx)
245 ui_browser__refresh_dimensions(&self->b);
246 back = self->b.height / 2;
247 self->b.top_idx = self->b.index = idx;
249 while (self->b.top_idx != 0 && back != 0) {
250 pos = list_entry(pos->node.prev, struct disasm_line, node);
252 if (disasm_line__filter(&self->b, &pos->node))
260 self->b.navkeypressed = true;
263 static void annotate_browser__set_rb_top(struct annotate_browser *browser,
266 struct browser_disasm_line *bpos;
267 struct disasm_line *pos;
269 bpos = rb_entry(nd, struct browser_disasm_line, rb_node);
270 pos = ((struct disasm_line *)bpos) - 1;
271 annotate_browser__set_top(browser, pos, bpos->idx);
272 browser->curr_hot = nd;
275 static void annotate_browser__calc_percent(struct annotate_browser *browser,
278 struct map_symbol *ms = browser->b.priv;
279 struct symbol *sym = ms->sym;
280 struct annotation *notes = symbol__annotation(sym);
281 struct disasm_line *pos;
283 browser->entries = RB_ROOT;
285 pthread_mutex_lock(¬es->lock);
287 list_for_each_entry(pos, ¬es->src->source, node) {
288 struct browser_disasm_line *bpos = disasm_line__browser(pos);
289 bpos->percent = disasm_line__calc_percent(pos, sym, evidx);
290 if (bpos->percent < 0.01) {
291 RB_CLEAR_NODE(&bpos->rb_node);
294 disasm_rb_tree__insert(&browser->entries, bpos);
296 pthread_mutex_unlock(¬es->lock);
298 browser->curr_hot = rb_last(&browser->entries);
301 static bool annotate_browser__toggle_source(struct annotate_browser *browser)
303 struct disasm_line *dl;
304 struct browser_disasm_line *bdl;
305 off_t offset = browser->b.index - browser->b.top_idx;
307 browser->b.seek(&browser->b, offset, SEEK_CUR);
308 dl = list_entry(browser->b.top, struct disasm_line, node);
309 bdl = disasm_line__browser(dl);
311 if (browser->hide_src_code) {
312 if (bdl->idx_asm < offset)
315 browser->b.nr_entries = browser->nr_entries;
316 browser->hide_src_code = false;
317 browser->b.seek(&browser->b, -offset, SEEK_CUR);
318 browser->b.top_idx = bdl->idx - offset;
319 browser->b.index = bdl->idx;
321 if (bdl->idx_asm < 0) {
322 ui_helpline__puts("Only available for assembly lines.");
323 browser->b.seek(&browser->b, -offset, SEEK_CUR);
327 if (bdl->idx_asm < offset)
328 offset = bdl->idx_asm;
330 browser->b.nr_entries = browser->nr_asm_entries;
331 browser->hide_src_code = true;
332 browser->b.seek(&browser->b, -offset, SEEK_CUR);
333 browser->b.top_idx = bdl->idx_asm - offset;
334 browser->b.index = bdl->idx_asm;
340 static bool annotate_browser__callq(struct annotate_browser *browser,
341 int evidx, void (*timer)(void *arg),
342 void *arg, int delay_secs)
344 struct map_symbol *ms = browser->b.priv;
345 struct disasm_line *dl = browser->selection;
346 struct symbol *sym = ms->sym;
347 struct annotation *notes;
348 struct symbol *target;
351 if (!ins__is_call(dl->ins))
354 ip = ms->map->map_ip(ms->map, dl->ops.target.addr);
355 target = map__find_symbol(ms->map, ip, NULL);
356 if (target == NULL) {
357 ui_helpline__puts("The called function was not found.");
361 notes = symbol__annotation(target);
362 pthread_mutex_lock(¬es->lock);
364 if (notes->src == NULL && symbol__alloc_hist(target) < 0) {
365 pthread_mutex_unlock(¬es->lock);
366 ui__warning("Not enough memory for annotating '%s' symbol!\n",
371 pthread_mutex_unlock(¬es->lock);
372 symbol__tui_annotate(target, ms->map, evidx, timer, arg, delay_secs);
373 ui_browser__show_title(&browser->b, sym->name);
378 struct disasm_line *annotate_browser__find_offset(struct annotate_browser *browser,
379 s64 offset, s64 *idx)
381 struct map_symbol *ms = browser->b.priv;
382 struct symbol *sym = ms->sym;
383 struct annotation *notes = symbol__annotation(sym);
384 struct disasm_line *pos;
387 list_for_each_entry(pos, ¬es->src->source, node) {
388 if (pos->offset == offset)
390 if (!disasm_line__filter(&browser->b, &pos->node))
397 static bool annotate_browser__jump(struct annotate_browser *browser)
399 struct disasm_line *dl = browser->selection;
402 if (!ins__is_jump(dl->ins))
405 dl = annotate_browser__find_offset(browser, dl->ops.target.offset, &idx);
407 ui_helpline__puts("Invallid jump offset");
411 annotate_browser__set_top(browser, dl, idx);
417 struct disasm_line *annotate_browser__find_string(struct annotate_browser *browser,
420 struct map_symbol *ms = browser->b.priv;
421 struct symbol *sym = ms->sym;
422 struct annotation *notes = symbol__annotation(sym);
423 struct disasm_line *pos = browser->selection;
425 *idx = browser->b.index;
426 list_for_each_entry_continue(pos, ¬es->src->source, node) {
427 if (disasm_line__filter(&browser->b, &pos->node))
432 if (pos->line && strstr(pos->line, s) != NULL)
439 static bool __annotate_browser__search(struct annotate_browser *browser)
441 struct disasm_line *dl;
444 dl = annotate_browser__find_string(browser, browser->search_bf, &idx);
446 ui_helpline__puts("String not found!");
450 annotate_browser__set_top(browser, dl, idx);
451 browser->searching_backwards = false;
456 struct disasm_line *annotate_browser__find_string_reverse(struct annotate_browser *browser,
459 struct map_symbol *ms = browser->b.priv;
460 struct symbol *sym = ms->sym;
461 struct annotation *notes = symbol__annotation(sym);
462 struct disasm_line *pos = browser->selection;
464 *idx = browser->b.index;
465 list_for_each_entry_continue_reverse(pos, ¬es->src->source, node) {
466 if (disasm_line__filter(&browser->b, &pos->node))
471 if (pos->line && strstr(pos->line, s) != NULL)
478 static bool __annotate_browser__search_reverse(struct annotate_browser *browser)
480 struct disasm_line *dl;
483 dl = annotate_browser__find_string_reverse(browser, browser->search_bf, &idx);
485 ui_helpline__puts("String not found!");
489 annotate_browser__set_top(browser, dl, idx);
490 browser->searching_backwards = true;
494 static bool annotate_browser__search_window(struct annotate_browser *browser,
497 if (ui_browser__input_window("Search", "String: ", browser->search_bf,
498 "ENTER: OK, ESC: Cancel",
499 delay_secs * 2) != K_ENTER ||
500 !*browser->search_bf)
506 static bool annotate_browser__search(struct annotate_browser *browser, int delay_secs)
508 if (annotate_browser__search_window(browser, delay_secs))
509 return __annotate_browser__search(browser);
514 static bool annotate_browser__continue_search(struct annotate_browser *browser,
517 if (!*browser->search_bf)
518 return annotate_browser__search(browser, delay_secs);
520 return __annotate_browser__search(browser);
523 static bool annotate_browser__search_reverse(struct annotate_browser *browser,
526 if (annotate_browser__search_window(browser, delay_secs))
527 return __annotate_browser__search_reverse(browser);
533 bool annotate_browser__continue_search_reverse(struct annotate_browser *browser,
536 if (!*browser->search_bf)
537 return annotate_browser__search_reverse(browser, delay_secs);
539 return __annotate_browser__search_reverse(browser);
542 static int annotate_browser__run(struct annotate_browser *self, int evidx,
543 void(*timer)(void *arg),
544 void *arg, int delay_secs)
546 struct rb_node *nd = NULL;
547 struct map_symbol *ms = self->b.priv;
548 struct symbol *sym = ms->sym;
549 const char *help = "<-/ESC: Exit, TAB/shift+TAB: Cycle hot lines, "
550 "H: Hottest line, ->/ENTER: Line action, "
555 if (ui_browser__show(&self->b, sym->name, help) < 0)
558 annotate_browser__calc_percent(self, evidx);
560 if (self->curr_hot) {
561 annotate_browser__set_rb_top(self, self->curr_hot);
562 self->b.navkeypressed = false;
568 key = ui_browser__run(&self->b, delay_secs);
570 if (delay_secs != 0) {
571 annotate_browser__calc_percent(self, evidx);
573 * Current line focus got out of the list of most active
574 * lines, NULL it so that if TAB|UNTAB is pressed, we
575 * move to curr_hot (current hottest line).
577 if (nd != NULL && RB_EMPTY_NODE(nd))
587 symbol__annotate_decay_histogram(sym, evidx);
593 nd = rb_last(&self->entries);
601 nd = rb_first(&self->entries);
611 if (annotate_browser__toggle_source(self))
612 ui_helpline__puts(help);
616 self->use_offset = !self->use_offset;
617 if (self->use_offset)
618 self->addr_width = self->min_addr_width;
620 self->addr_width = self->max_addr_width;
623 self->jump_arrows = !self->jump_arrows;
626 if (annotate_browser__search(self, delay_secs)) {
628 ui_helpline__puts(help);
632 if (self->searching_backwards ?
633 annotate_browser__continue_search_reverse(self, delay_secs) :
634 annotate_browser__continue_search(self, delay_secs))
638 if (annotate_browser__search_reverse(self, delay_secs))
643 if (self->selection == NULL)
644 ui_helpline__puts("Huh? No selection. Report to linux-kernel@vger.kernel.org");
645 else if (self->selection->offset == -1)
646 ui_helpline__puts("Actions are only available for assembly lines.");
647 else if (!self->selection->ins) {
648 if (strcmp(self->selection->name, "retq"))
651 } else if (!(annotate_browser__jump(self) ||
652 annotate_browser__callq(self, evidx, timer, arg, delay_secs))) {
654 ui_helpline__puts("Actions are only available for 'callq', 'retq' & jump instructions.");
667 annotate_browser__set_rb_top(self, nd);
670 ui_browser__hide(&self->b);
674 int hist_entry__tui_annotate(struct hist_entry *he, int evidx,
675 void(*timer)(void *arg), void *arg, int delay_secs)
677 return symbol__tui_annotate(he->ms.sym, he->ms.map, evidx,
678 timer, arg, delay_secs);
681 static void annotate_browser__mark_jump_targets(struct annotate_browser *browser,
686 for (offset = 0; offset < size; ++offset) {
687 struct disasm_line *dl = browser->offsets[offset], *dlt;
688 struct browser_disasm_line *bdlt;
690 if (!dl || !dl->ins || !ins__is_jump(dl->ins) ||
691 !disasm_line__has_offset(dl))
694 if (dl->ops.target.offset >= size) {
695 ui__error("jump to after symbol!\n"
696 "size: %zx, jump target: %" PRIx64,
697 size, dl->ops.target.offset);
701 dlt = browser->offsets[dl->ops.target.offset];
703 * FIXME: Oops, no jump target? Buggy disassembler? Or do we
704 * have to adjust to the previous offset?
709 bdlt = disasm_line__browser(dlt);
710 bdlt->jump_target = true;
715 int symbol__tui_annotate(struct symbol *sym, struct map *map, int evidx,
716 void(*timer)(void *arg), void *arg,
719 struct disasm_line *pos, *n;
720 struct annotation *notes;
721 const size_t size = symbol__size(sym);
722 struct map_symbol ms = {
726 struct annotate_browser browser = {
728 .refresh = annotate_browser__refresh,
729 .seek = ui_browser__list_head_seek,
730 .write = annotate_browser__write,
731 .filter = disasm_line__filter,
733 .use_navkeypressed = true,
743 if (map->dso->annotate_warned)
746 browser.offsets = zalloc(size * sizeof(struct disasm_line *));
747 if (browser.offsets == NULL) {
748 ui__error("Not enough memory!");
752 if (symbol__annotate(sym, map, sizeof(struct browser_disasm_line)) < 0) {
753 ui__error("%s", ui_helpline__last_msg);
754 goto out_free_offsets;
757 ui_helpline__push("Press <- or ESC to exit");
759 notes = symbol__annotation(sym);
760 browser.start = map__rip_2objdump(map, sym->start);
762 list_for_each_entry(pos, ¬es->src->source, node) {
763 struct browser_disasm_line *bpos;
764 size_t line_len = strlen(pos->line);
766 if (browser.b.width < line_len)
767 browser.b.width = line_len;
768 bpos = disasm_line__browser(pos);
769 bpos->idx = browser.nr_entries++;
770 if (pos->offset != -1) {
771 bpos->idx_asm = browser.nr_asm_entries++;
773 * FIXME: short term bandaid to cope with assembly
774 * routines that comes with labels in the same column
775 * as the address in objdump, sigh.
777 * E.g. copy_user_generic_unrolled
779 if (pos->offset < (s64)size)
780 browser.offsets[pos->offset] = pos;
785 annotate_browser__mark_jump_targets(&browser, size);
787 browser.addr_width = browser.min_addr_width = hex_width(size);
788 browser.max_addr_width = hex_width(sym->end);
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);