tools/perf/util/ui/browsers/annotate.c

   1 #include "../browser.h"
   2 #include "../helpline.h"
   3 #include "../libslang.h"
   4 #include "../../annotate.h"
   5 #include "../../hist.h"
   6 #include "../../sort.h"
   7 #include "../../symbol.h"
   8 #include <pthread.h>
   9
  10 static void ui__error_window(const char *fmt, ...)
  11 {
  12         va_list ap;
  13
  14         va_start(ap, fmt);
  15         newtWinMessagev((char *)"Error", (char *)"Ok", (char *)fmt, ap);
  16         va_end(ap);
  17 }
  18
  19 struct annotate_browser {
  20         struct ui_browser b;
  21         struct rb_root    entries;
  22         struct rb_node    *curr_hot;
  23         struct objdump_line *selection;
  24 };
  25
  26 struct objdump_line_rb_node {
  27         struct rb_node  rb_node;
  28         double          percent;
  29         u32             idx;
  30 };
  31
  32 static inline
  33 struct objdump_line_rb_node *objdump_line__rb(struct objdump_line *self)
  34 {
  35         return (struct objdump_line_rb_node *)(self + 1);
  36 }
  37
  38 static void annotate_browser__write(struct ui_browser *self, void *entry, int row)
  39 {
  40         struct annotate_browser *ab = container_of(self, struct annotate_browser, b);
  41         struct objdump_line *ol = rb_entry(entry, struct objdump_line, node);
  42         bool current_entry = ui_browser__is_current_entry(self, row);
  43         int width = self->width;
  44
  45         if (ol->offset != -1) {
  46                 struct objdump_line_rb_node *olrb = objdump_line__rb(ol);
  47                 ui_browser__set_percent_color(self, olrb->percent, current_entry);
  48                 slsmg_printf(" %7.2f ", olrb->percent);
  49         } else {
  50                 ui_browser__set_percent_color(self, 0, current_entry);
  51                 slsmg_write_nstring(" ", 9);
  52         }
  53
  54         SLsmg_write_char(':');
  55         slsmg_write_nstring(" ", 8);
  56         if (!*ol->line)
  57                 slsmg_write_nstring(" ", width - 18);
  58         else
  59                 slsmg_write_nstring(ol->line, width - 18);
  60
  61         if (!current_entry)
  62                 ui_browser__set_color(self, HE_COLORSET_CODE);
  63         else
  64                 ab->selection = ol;
  65 }
  66
  67 static double objdump_line__calc_percent(struct objdump_line *self,
  68                                          struct symbol *sym, int evidx)
  69 {
  70         double percent = 0.0;
  71
  72         if (self->offset != -1) {
  73                 int len = sym->end - sym->start;
  74                 unsigned int hits = 0;
  75                 struct annotation *notes = symbol__annotation(sym);
  76                 struct source_line *src_line = notes->src->lines;
  77                 struct sym_hist *h = annotation__histogram(notes, evidx);
  78                 s64 offset = self->offset;
  79                 struct objdump_line *next;
  80
  81                 next = objdump__get_next_ip_line(&notes->src->source, self);
  82                 while (offset < (s64)len &&
  83                        (next == NULL || offset < next->offset)) {
  84                         if (src_line) {
  85                                 percent += src_line[offset].percent;
  86                         } else
  87                                 hits += h->addr[offset];
  88
  89                         ++offset;
  90                 }
  91                 /*
  92                  * If the percentage wasn't already calculated in
  93                  * symbol__get_source_line, do it now:
  94                  */
  95                 if (src_line == NULL && h->sum)
  96                         percent = 100.0 * hits / h->sum;
  97         }
  98
  99         return percent;
 100 }
 101
 102 static void objdump__insert_line(struct rb_root *self,
 103                                  struct objdump_line_rb_node *line)
 104 {
 105         struct rb_node **p = &self->rb_node;
 106         struct rb_node *parent = NULL;
 107         struct objdump_line_rb_node *l;
 108
 109         while (*p != NULL) {
 110                 parent = *p;
 111                 l = rb_entry(parent, struct objdump_line_rb_node, rb_node);
 112                 if (line->percent < l->percent)
 113                         p = &(*p)->rb_left;
 114                 else
 115                         p = &(*p)->rb_right;
 116         }
 117         rb_link_node(&line->rb_node, parent, p);
 118         rb_insert_color(&line->rb_node, self);
 119 }
 120
 121 static void annotate_browser__set_top(struct annotate_browser *self,
 122                                       struct rb_node *nd)
 123 {
 124         struct objdump_line_rb_node *rbpos;
 125         struct objdump_line *pos;
 126         unsigned back;
 127
 128         ui_browser__refresh_dimensions(&self->b);
 129         back = self->b.height / 2;
 130         rbpos = rb_entry(nd, struct objdump_line_rb_node, rb_node);
 131         pos = ((struct objdump_line *)rbpos) - 1;
 132         self->b.top_idx = self->b.index = rbpos->idx;
 133
 134         while (self->b.top_idx != 0 && back != 0) {
 135                 pos = list_entry(pos->node.prev, struct objdump_line, node);
 136
 137                 --self->b.top_idx;
 138                 --back;
 139         }
 140
 141         self->b.top = pos;
 142         self->curr_hot = nd;
 143 }
 144
 145 static void annotate_browser__calc_percent(struct annotate_browser *browser,
 146                                            int evidx)
 147 {
 148         struct map_symbol *ms = browser->b.priv;
 149         struct symbol *sym = ms->sym;
 150         struct annotation *notes = symbol__annotation(sym);
 151         struct objdump_line *pos;
 152
 153         browser->entries = RB_ROOT;
 154
 155         pthread_mutex_lock(&notes->lock);
 156
 157         list_for_each_entry(pos, &notes->src->source, node) {
 158                 struct objdump_line_rb_node *rbpos = objdump_line__rb(pos);
 159                 rbpos->percent = objdump_line__calc_percent(pos, sym, evidx);
 160                 if (rbpos->percent < 0.01) {
 161                         RB_CLEAR_NODE(&rbpos->rb_node);
 162                         continue;
 163                 }
 164                 objdump__insert_line(&browser->entries, rbpos);
 165         }
 166         pthread_mutex_unlock(&notes->lock);
 167
 168         browser->curr_hot = rb_last(&browser->entries);
 169 }
 170
 171 static int annotate_browser__run(struct annotate_browser *self, int evidx,
 172                                  int nr_events, void(*timer)(void *arg),
 173                                  void *arg, int delay_secs)
 174 {
 175         struct rb_node *nd = NULL;
 176         struct map_symbol *ms = self->b.priv;
 177         struct symbol *sym = ms->sym;
 178         /*
 179          * RIGHT To allow builtin-annotate to cycle thru multiple symbols by
 180          * examining the exit key for this function.
 181          */
 182         int exit_keys[] = { 'H', NEWT_KEY_TAB, NEWT_KEY_UNTAB,
 183                             NEWT_KEY_RIGHT, NEWT_KEY_ENTER, 0 };
 184         int key;
 185
 186         if (ui_browser__show(&self->b, sym->name,
 187                              "<- or ESC: exit, TAB/shift+TAB: "
 188                              "cycle hottest lines, H: Hottest, -> Line action") < 0)
 189                 return -1;
 190
 191         ui_browser__add_exit_keys(&self->b, exit_keys);
 192         annotate_browser__calc_percent(self, evidx);
 193
 194         if (self->curr_hot)
 195                 annotate_browser__set_top(self, self->curr_hot);
 196
 197         nd = self->curr_hot;
 198
 199         while (1) {
 200                 key = ui_browser__run(&self->b, delay_secs);
 201
 202                 if (delay_secs != 0) {
 203                         annotate_browser__calc_percent(self, evidx);
 204                         /*
 205                          * Current line focus got out of the list of most active
 206                          * lines, NULL it so that if TAB|UNTAB is pressed, we
 207                          * move to curr_hot (current hottest line).
 208                          */
 209                         if (nd != NULL && RB_EMPTY_NODE(nd))
 210                                 nd = NULL;
 211                 }
 212
 213                 switch (key) {
 214                 case -1:
 215                         /*
 216                          * FIXME we need to check if it was
 217                          * es.reason == NEWT_EXIT_TIMER
 218                          */
 219                         if (timer != NULL)
 220                                 timer(arg);
 221
 222                         if (delay_secs != 0)
 223                                 symbol__annotate_decay_histogram(sym, evidx);
 224                         continue;
 225                 case NEWT_KEY_TAB:
 226                         if (nd != NULL) {
 227                                 nd = rb_prev(nd);
 228                                 if (nd == NULL)
 229                                         nd = rb_last(&self->entries);
 230                         } else
 231                                 nd = self->curr_hot;
 232                         break;
 233                 case NEWT_KEY_UNTAB:
 234                         if (nd != NULL)
 235                                 nd = rb_next(nd);
 236                                 if (nd == NULL)
 237                                         nd = rb_first(&self->entries);
 238                         else
 239                                 nd = self->curr_hot;
 240                         break;
 241                 case 'H':
 242                         nd = self->curr_hot;
 243                         break;
 244                 case NEWT_KEY_ENTER:
 245                 case NEWT_KEY_RIGHT:
 246                         if (self->selection == NULL) {
 247                                 ui_helpline__puts("Huh? No selection. Report to linux-kernel@vger.kernel.org");
 248                                 continue;
 249                         }
 250
 251                         if (self->selection->offset == -1) {
 252                                 ui_helpline__puts("Actions are only available for assembly lines.");
 253                                 continue;
 254                         } else {
 255                                 char *s = strstr(self->selection->line, "callq ");
 256                                 struct annotation *notes;
 257                                 struct symbol *target;
 258                                 u64 ip;
 259
 260                                 if (s == NULL) {
 261                                         ui_helpline__puts("Actions are only available for the 'callq' instruction.");
 262                                         continue;
 263                                 }
 264
 265                                 s = strchr(s, ' ');
 266                                 if (s++ == NULL) {
 267                                         ui_helpline__puts("Invallid callq instruction.");
 268                                         continue;
 269                                 }
 270
 271                                 ip = strtoull(s, NULL, 16);
 272                                 ip = ms->map->map_ip(ms->map, ip);
 273                                 target = map__find_symbol(ms->map, ip, NULL);
 274                                 if (target == NULL) {
 275                                         ui_helpline__puts("The called function was not found.");
 276                                         continue;
 277                                 }
 278
 279                                 notes = symbol__annotation(target);
 280                                 pthread_mutex_lock(&notes->lock);
 281
 282                                 if (notes->src == NULL &&
 283                                     symbol__alloc_hist(target, nr_events) < 0) {
 284                                         pthread_mutex_unlock(&notes->lock);
 285                                         ui__warning("Not enough memory for annotating '%s' symbol!\n",
 286                                                     target->name);
 287                                         continue;
 288                                 }
 289
 290                                 pthread_mutex_unlock(&notes->lock);
 291                                 symbol__tui_annotate(target, ms->map, evidx, nr_events,
 292                                                      timer, arg, delay_secs);
 293                         }
 294                         break;
 295                 default:
 296                         goto out;
 297                 }
 298
 299                 if (nd != NULL)
 300                         annotate_browser__set_top(self, nd);
 301         }
 302 out:
 303         ui_browser__hide(&self->b);
 304         return key;
 305 }
 306
 307 int hist_entry__tui_annotate(struct hist_entry *he, int evidx, int nr_events,
 308                              void(*timer)(void *arg), void *arg, int delay_secs)
 309 {
 310         return symbol__tui_annotate(he->ms.sym, he->ms.map, evidx, nr_events,
 311                                     timer, arg, delay_secs);
 312 }
 313
 314 int symbol__tui_annotate(struct symbol *sym, struct map *map, int evidx,
 315                          int nr_events, void(*timer)(void *arg), void *arg,
 316                          int delay_secs)
 317 {
 318         struct objdump_line *pos, *n;
 319         struct annotation *notes;
 320         struct map_symbol ms = {
 321                 .map = map,
 322                 .sym = sym,
 323         };
 324         struct annotate_browser browser = {
 325                 .b = {
 326                         .refresh = ui_browser__list_head_refresh,
 327                         .seek    = ui_browser__list_head_seek,
 328                         .write   = annotate_browser__write,
 329                         .priv    = &ms,
 330                 },
 331         };
 332         int ret;
 333
 334         if (sym == NULL)
 335                 return -1;
 336
 337         if (map->dso->annotate_warned)
 338                 return -1;
 339
 340         if (symbol__annotate(sym, map, sizeof(struct objdump_line_rb_node)) < 0) {
 341                 ui__error_window(ui_helpline__last_msg);
 342                 return -1;
 343         }
 344
 345         ui_helpline__push("Press <- or ESC to exit");
 346
 347         notes = symbol__annotation(sym);
 348
 349         list_for_each_entry(pos, &notes->src->source, node) {
 350                 struct objdump_line_rb_node *rbpos;
 351                 size_t line_len = strlen(pos->line);
 352
 353                 if (browser.b.width < line_len)
 354                         browser.b.width = line_len;
 355                 rbpos = objdump_line__rb(pos);
 356                 rbpos->idx = browser.b.nr_entries++;
 357         }
 358
 359         browser.b.entries = &notes->src->source,
 360         browser.b.width += 18; /* Percentage */
 361         ret = annotate_browser__run(&browser, evidx, nr_events,
 362                                     timer, arg, delay_secs);
 363         list_for_each_entry_safe(pos, n, &notes->src->source, node) {
 364                 list_del(&pos->node);
 365                 objdump_line__free(pos);
 366         }
 367         return ret;
 368 }