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;
33 bool searching_backwards;
38 static inline struct browser_disasm_line *disasm_line__browser(struct disasm_line *dl)
40 return (struct browser_disasm_line *)(dl + 1);
43 static bool disasm_line__filter(struct ui_browser *browser, void *entry)
45 struct annotate_browser *ab = container_of(browser, struct annotate_browser, b);
47 if (ab->hide_src_code) {
48 struct disasm_line *dl = list_entry(entry, struct disasm_line, node);
49 return dl->offset == -1;
55 static void annotate_browser__write(struct ui_browser *self, void *entry, int row)
57 struct annotate_browser *ab = container_of(self, struct annotate_browser, b);
58 struct disasm_line *dl = list_entry(entry, struct disasm_line, node);
59 struct browser_disasm_line *bdl = disasm_line__browser(dl);
60 bool current_entry = ui_browser__is_current_entry(self, row);
61 bool change_color = (!ab->hide_src_code &&
62 (!current_entry || (self->use_navkeypressed &&
63 !self->navkeypressed)));
64 int width = self->width;
66 if (dl->offset != -1) {
67 ui_browser__set_percent_color(self, bdl->percent, current_entry);
68 slsmg_printf(" %7.2f ", bdl->percent);
70 ui_browser__set_percent_color(self, 0, current_entry);
71 slsmg_write_nstring(" ", 9);
74 ui_browser__write_graph(self, SLSMG_VLINE_CHAR);
75 SLsmg_write_char(' ');
77 /* The scroll bar isn't being used */
78 if (!self->navkeypressed)
81 if (dl->offset != -1 && change_color)
82 ui_browser__set_color(self, HE_COLORSET_CODE);
85 slsmg_write_nstring(" ", width - 10);
86 else if (dl->offset == -1)
87 slsmg_write_nstring(dl->line, width - 10);
90 u64 addr = dl->offset;
91 int printed, color = -1;
96 if (!ab->use_offset) {
97 printed = scnprintf(bf, sizeof(bf), " %" PRIx64 ":", addr);
99 if (bdl->jump_target) {
100 printed = scnprintf(bf, sizeof(bf), " %*" PRIx64 ":",
101 ab->offset_width, addr);
103 printed = scnprintf(bf, sizeof(bf), " %*s ",
104 ab->offset_width, " ");
109 color = ui_browser__set_color(self, HE_COLORSET_ADDR);
110 slsmg_write_nstring(bf, printed);
112 ui_browser__set_color(self, color);
113 if (dl->ins && dl->ins->ops->scnprintf) {
114 if (ins__is_jump(dl->ins)) {
115 bool fwd = dl->ops.target.offset > (u64)dl->offset;
117 ui_browser__write_graph(self, fwd ? SLSMG_DARROW_CHAR :
119 SLsmg_write_char(' ');
120 } else if (ins__is_call(dl->ins)) {
121 ui_browser__write_graph(self, SLSMG_RARROW_CHAR);
122 SLsmg_write_char(' ');
124 slsmg_write_nstring(" ", 2);
127 dl->ins->ops->scnprintf(dl->ins, bf, sizeof(bf), &dl->ops,
130 if (strcmp(dl->name, "retq")) {
131 slsmg_write_nstring(" ", 2);
133 ui_browser__write_graph(self, SLSMG_LARROW_CHAR);
134 SLsmg_write_char(' ');
137 scnprintf(bf, sizeof(bf), "%-6.6s %s", dl->name, dl->ops.raw);
140 slsmg_write_nstring(bf, width - 12 - printed);
147 static void annotate_browser__draw_current_loop(struct ui_browser *browser)
149 struct annotate_browser *ab = container_of(browser, struct annotate_browser, b);
150 struct map_symbol *ms = browser->priv;
151 struct symbol *sym = ms->sym;
152 struct annotation *notes = symbol__annotation(sym);
153 struct disasm_line *cursor = ab->selection, *pos = cursor, *target;
154 struct browser_disasm_line *bcursor = disasm_line__browser(cursor),
156 unsigned int from, to, start_width = 2;
158 list_for_each_entry_from(pos, ¬es->src->source, node) {
159 if (!pos->ins || !ins__is_jump(pos->ins) ||
160 !disasm_line__has_offset(pos))
163 target = ab->offsets[pos->ops.target.offset];
167 btarget = disasm_line__browser(target);
168 if (btarget->idx <= bcursor->idx)
175 bpos = disasm_line__browser(pos);
176 if (ab->hide_src_code) {
177 from = bpos->idx_asm;
178 to = btarget->idx_asm;
180 from = (u64)bpos->idx;
181 to = (u64)btarget->idx;
184 ui_browser__set_color(browser, HE_COLORSET_CODE);
186 if (!bpos->jump_target)
187 start_width += ab->offset_width + 1;
189 __ui_browser__line_arrow_up(browser, 10, from, to, start_width);
192 static unsigned int annotate_browser__refresh(struct ui_browser *browser)
194 int ret = ui_browser__list_head_refresh(browser);
196 annotate_browser__draw_current_loop(browser);
201 static double disasm_line__calc_percent(struct disasm_line *dl, struct symbol *sym, int evidx)
203 double percent = 0.0;
205 if (dl->offset != -1) {
206 int len = sym->end - sym->start;
207 unsigned int hits = 0;
208 struct annotation *notes = symbol__annotation(sym);
209 struct source_line *src_line = notes->src->lines;
210 struct sym_hist *h = annotation__histogram(notes, evidx);
211 s64 offset = dl->offset;
212 struct disasm_line *next;
214 next = disasm__get_next_ip_line(¬es->src->source, dl);
215 while (offset < (s64)len &&
216 (next == NULL || offset < next->offset)) {
218 percent += src_line[offset].percent;
220 hits += h->addr[offset];
225 * If the percentage wasn't already calculated in
226 * symbol__get_source_line, do it now:
228 if (src_line == NULL && h->sum)
229 percent = 100.0 * hits / h->sum;
235 static void disasm_rb_tree__insert(struct rb_root *root, struct browser_disasm_line *bdl)
237 struct rb_node **p = &root->rb_node;
238 struct rb_node *parent = NULL;
239 struct browser_disasm_line *l;
243 l = rb_entry(parent, struct browser_disasm_line, rb_node);
244 if (bdl->percent < l->percent)
249 rb_link_node(&bdl->rb_node, parent, p);
250 rb_insert_color(&bdl->rb_node, root);
253 static void annotate_browser__set_top(struct annotate_browser *self,
254 struct disasm_line *pos, u32 idx)
258 ui_browser__refresh_dimensions(&self->b);
259 back = self->b.height / 2;
260 self->b.top_idx = self->b.index = idx;
262 while (self->b.top_idx != 0 && back != 0) {
263 pos = list_entry(pos->node.prev, struct disasm_line, node);
265 if (disasm_line__filter(&self->b, &pos->node))
273 self->b.navkeypressed = true;
276 static void annotate_browser__set_rb_top(struct annotate_browser *browser,
279 struct browser_disasm_line *bpos;
280 struct disasm_line *pos;
282 bpos = rb_entry(nd, struct browser_disasm_line, rb_node);
283 pos = ((struct disasm_line *)bpos) - 1;
284 annotate_browser__set_top(browser, pos, bpos->idx);
285 browser->curr_hot = nd;
288 static void annotate_browser__calc_percent(struct annotate_browser *browser,
291 struct map_symbol *ms = browser->b.priv;
292 struct symbol *sym = ms->sym;
293 struct annotation *notes = symbol__annotation(sym);
294 struct disasm_line *pos;
296 browser->entries = RB_ROOT;
298 pthread_mutex_lock(¬es->lock);
300 list_for_each_entry(pos, ¬es->src->source, node) {
301 struct browser_disasm_line *bpos = disasm_line__browser(pos);
302 bpos->percent = disasm_line__calc_percent(pos, sym, evidx);
303 if (bpos->percent < 0.01) {
304 RB_CLEAR_NODE(&bpos->rb_node);
307 disasm_rb_tree__insert(&browser->entries, bpos);
309 pthread_mutex_unlock(¬es->lock);
311 browser->curr_hot = rb_last(&browser->entries);
314 static bool annotate_browser__toggle_source(struct annotate_browser *browser)
316 struct disasm_line *dl;
317 struct browser_disasm_line *bdl;
318 off_t offset = browser->b.index - browser->b.top_idx;
320 browser->b.seek(&browser->b, offset, SEEK_CUR);
321 dl = list_entry(browser->b.top, struct disasm_line, node);
322 bdl = disasm_line__browser(dl);
324 if (browser->hide_src_code) {
325 if (bdl->idx_asm < offset)
328 browser->b.nr_entries = browser->nr_entries;
329 browser->hide_src_code = false;
330 browser->b.seek(&browser->b, -offset, SEEK_CUR);
331 browser->b.top_idx = bdl->idx - offset;
332 browser->b.index = bdl->idx;
334 if (bdl->idx_asm < 0) {
335 ui_helpline__puts("Only available for assembly lines.");
336 browser->b.seek(&browser->b, -offset, SEEK_CUR);
340 if (bdl->idx_asm < offset)
341 offset = bdl->idx_asm;
343 browser->b.nr_entries = browser->nr_asm_entries;
344 browser->hide_src_code = true;
345 browser->b.seek(&browser->b, -offset, SEEK_CUR);
346 browser->b.top_idx = bdl->idx_asm - offset;
347 browser->b.index = bdl->idx_asm;
353 static bool annotate_browser__callq(struct annotate_browser *browser,
354 int evidx, void (*timer)(void *arg),
355 void *arg, int delay_secs)
357 struct map_symbol *ms = browser->b.priv;
358 struct disasm_line *dl = browser->selection;
359 struct symbol *sym = ms->sym;
360 struct annotation *notes;
361 struct symbol *target;
364 if (!ins__is_call(dl->ins))
367 ip = ms->map->map_ip(ms->map, dl->ops.target.addr);
368 target = map__find_symbol(ms->map, ip, NULL);
369 if (target == NULL) {
370 ui_helpline__puts("The called function was not found.");
374 notes = symbol__annotation(target);
375 pthread_mutex_lock(¬es->lock);
377 if (notes->src == NULL && symbol__alloc_hist(target) < 0) {
378 pthread_mutex_unlock(¬es->lock);
379 ui__warning("Not enough memory for annotating '%s' symbol!\n",
384 pthread_mutex_unlock(¬es->lock);
385 symbol__tui_annotate(target, ms->map, evidx, timer, arg, delay_secs);
386 ui_browser__show_title(&browser->b, sym->name);
391 struct disasm_line *annotate_browser__find_offset(struct annotate_browser *browser,
392 s64 offset, s64 *idx)
394 struct map_symbol *ms = browser->b.priv;
395 struct symbol *sym = ms->sym;
396 struct annotation *notes = symbol__annotation(sym);
397 struct disasm_line *pos;
400 list_for_each_entry(pos, ¬es->src->source, node) {
401 if (pos->offset == offset)
403 if (!disasm_line__filter(&browser->b, &pos->node))
410 static bool annotate_browser__jump(struct annotate_browser *browser)
412 struct disasm_line *dl = browser->selection;
415 if (!ins__is_jump(dl->ins))
418 dl = annotate_browser__find_offset(browser, dl->ops.target.offset, &idx);
420 ui_helpline__puts("Invallid jump offset");
424 annotate_browser__set_top(browser, dl, idx);
430 struct disasm_line *annotate_browser__find_string(struct annotate_browser *browser,
433 struct map_symbol *ms = browser->b.priv;
434 struct symbol *sym = ms->sym;
435 struct annotation *notes = symbol__annotation(sym);
436 struct disasm_line *pos = browser->selection;
438 *idx = browser->b.index;
439 list_for_each_entry_continue(pos, ¬es->src->source, node) {
440 if (disasm_line__filter(&browser->b, &pos->node))
445 if (pos->line && strstr(pos->line, s) != NULL)
452 static bool __annotate_browser__search(struct annotate_browser *browser)
454 struct disasm_line *dl;
457 dl = annotate_browser__find_string(browser, browser->search_bf, &idx);
459 ui_helpline__puts("String not found!");
463 annotate_browser__set_top(browser, dl, idx);
464 browser->searching_backwards = false;
469 struct disasm_line *annotate_browser__find_string_reverse(struct annotate_browser *browser,
472 struct map_symbol *ms = browser->b.priv;
473 struct symbol *sym = ms->sym;
474 struct annotation *notes = symbol__annotation(sym);
475 struct disasm_line *pos = browser->selection;
477 *idx = browser->b.index;
478 list_for_each_entry_continue_reverse(pos, ¬es->src->source, node) {
479 if (disasm_line__filter(&browser->b, &pos->node))
484 if (pos->line && strstr(pos->line, s) != NULL)
491 static bool __annotate_browser__search_reverse(struct annotate_browser *browser)
493 struct disasm_line *dl;
496 dl = annotate_browser__find_string_reverse(browser, browser->search_bf, &idx);
498 ui_helpline__puts("String not found!");
502 annotate_browser__set_top(browser, dl, idx);
503 browser->searching_backwards = true;
507 static bool annotate_browser__search_window(struct annotate_browser *browser,
510 if (ui_browser__input_window("Search", "String: ", browser->search_bf,
511 "ENTER: OK, ESC: Cancel",
512 delay_secs * 2) != K_ENTER ||
513 !*browser->search_bf)
519 static bool annotate_browser__search(struct annotate_browser *browser, int delay_secs)
521 if (annotate_browser__search_window(browser, delay_secs))
522 return __annotate_browser__search(browser);
527 static bool annotate_browser__continue_search(struct annotate_browser *browser,
530 if (!*browser->search_bf)
531 return annotate_browser__search(browser, delay_secs);
533 return __annotate_browser__search(browser);
536 static bool annotate_browser__search_reverse(struct annotate_browser *browser,
539 if (annotate_browser__search_window(browser, delay_secs))
540 return __annotate_browser__search_reverse(browser);
546 bool annotate_browser__continue_search_reverse(struct annotate_browser *browser,
549 if (!*browser->search_bf)
550 return annotate_browser__search_reverse(browser, delay_secs);
552 return __annotate_browser__search_reverse(browser);
555 static int annotate_browser__run(struct annotate_browser *self, int evidx,
556 void(*timer)(void *arg),
557 void *arg, int delay_secs)
559 struct rb_node *nd = NULL;
560 struct map_symbol *ms = self->b.priv;
561 struct symbol *sym = ms->sym;
562 const char *help = "<-/ESC: Exit, TAB/shift+TAB: Cycle hot lines, "
563 "H: Go to hottest line, ->/ENTER: Line action, "
564 "O: Toggle offset view, "
565 "S: Toggle source code view";
568 if (ui_browser__show(&self->b, sym->name, help) < 0)
571 annotate_browser__calc_percent(self, evidx);
573 if (self->curr_hot) {
574 annotate_browser__set_rb_top(self, self->curr_hot);
575 self->b.navkeypressed = false;
581 key = ui_browser__run(&self->b, delay_secs);
583 if (delay_secs != 0) {
584 annotate_browser__calc_percent(self, evidx);
586 * Current line focus got out of the list of most active
587 * lines, NULL it so that if TAB|UNTAB is pressed, we
588 * move to curr_hot (current hottest line).
590 if (nd != NULL && RB_EMPTY_NODE(nd))
600 symbol__annotate_decay_histogram(sym, evidx);
606 nd = rb_last(&self->entries);
614 nd = rb_first(&self->entries);
624 if (annotate_browser__toggle_source(self))
625 ui_helpline__puts(help);
629 self->use_offset = !self->use_offset;
632 if (annotate_browser__search(self, delay_secs)) {
634 ui_helpline__puts(help);
638 if (self->searching_backwards ?
639 annotate_browser__continue_search_reverse(self, delay_secs) :
640 annotate_browser__continue_search(self, delay_secs))
644 if (annotate_browser__search_reverse(self, delay_secs))
649 if (self->selection == NULL)
650 ui_helpline__puts("Huh? No selection. Report to linux-kernel@vger.kernel.org");
651 else if (self->selection->offset == -1)
652 ui_helpline__puts("Actions are only available for assembly lines.");
653 else if (!self->selection->ins) {
654 if (strcmp(self->selection->name, "retq"))
657 } else if (!(annotate_browser__jump(self) ||
658 annotate_browser__callq(self, evidx, timer, arg, delay_secs))) {
660 ui_helpline__puts("Actions are only available for 'callq', 'retq' & jump instructions.");
673 annotate_browser__set_rb_top(self, nd);
676 ui_browser__hide(&self->b);
680 int hist_entry__tui_annotate(struct hist_entry *he, int evidx,
681 void(*timer)(void *arg), void *arg, int delay_secs)
683 return symbol__tui_annotate(he->ms.sym, he->ms.map, evidx,
684 timer, arg, delay_secs);
687 static void annotate_browser__mark_jump_targets(struct annotate_browser *browser,
692 for (offset = 0; offset < size; ++offset) {
693 struct disasm_line *dl = browser->offsets[offset], *dlt;
694 struct browser_disasm_line *bdlt;
696 if (!dl || !dl->ins || !ins__is_jump(dl->ins) ||
697 !disasm_line__has_offset(dl))
700 if (dl->ops.target.offset >= size) {
701 ui__error("jump to after symbol!\n"
702 "size: %zx, jump target: %" PRIx64,
703 size, dl->ops.target.offset);
707 dlt = browser->offsets[dl->ops.target.offset];
709 * FIXME: Oops, no jump target? Buggy disassembler? Or do we
710 * have to adjust to the previous offset?
715 bdlt = disasm_line__browser(dlt);
716 bdlt->jump_target = true;
721 int symbol__tui_annotate(struct symbol *sym, struct map *map, int evidx,
722 void(*timer)(void *arg), void *arg,
725 struct disasm_line *pos, *n;
726 struct annotation *notes;
727 const size_t size = symbol__size(sym);
728 struct map_symbol ms = {
732 struct annotate_browser browser = {
734 .refresh = annotate_browser__refresh,
735 .seek = ui_browser__list_head_seek,
736 .write = annotate_browser__write,
737 .filter = disasm_line__filter,
739 .use_navkeypressed = true,
748 if (map->dso->annotate_warned)
751 browser.offsets = zalloc(size * sizeof(struct disasm_line *));
752 if (browser.offsets == NULL) {
753 ui__error("Not enough memory!");
757 if (symbol__annotate(sym, map, sizeof(struct browser_disasm_line)) < 0) {
758 ui__error("%s", ui_helpline__last_msg);
759 goto out_free_offsets;
762 ui_helpline__push("Press <- or ESC to exit");
764 notes = symbol__annotation(sym);
765 browser.start = map__rip_2objdump(map, sym->start);
767 list_for_each_entry(pos, ¬es->src->source, node) {
768 struct browser_disasm_line *bpos;
769 size_t line_len = strlen(pos->line);
771 if (browser.b.width < line_len)
772 browser.b.width = line_len;
773 bpos = disasm_line__browser(pos);
774 bpos->idx = browser.nr_entries++;
775 if (pos->offset != -1) {
776 bpos->idx_asm = browser.nr_asm_entries++;
778 * FIXME: short term bandaid to cope with assembly
779 * routines that comes with labels in the same column
780 * as the address in objdump, sigh.
782 * E.g. copy_user_generic_unrolled
784 if (pos->offset < (s64)size)
785 browser.offsets[pos->offset] = pos;
790 annotate_browser__mark_jump_targets(&browser, size);
792 browser.offset_width = hex_width(size);
793 browser.b.nr_entries = browser.nr_entries;
794 browser.b.entries = ¬es->src->source,
795 browser.b.width += 18; /* Percentage */
796 ret = annotate_browser__run(&browser, evidx, timer, arg, delay_secs);
797 list_for_each_entry_safe(pos, n, ¬es->src->source, node) {
798 list_del(&pos->node);
799 disasm_line__free(pos);
803 free(browser.offsets);