tools/perf/builtin-annotate.c

   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
  12 #include "util/color.h"
  13 #include <linux/list.h>
  14 #include "util/cache.h"
  15 #include <linux/rbtree.h>
  16 #include "util/symbol.h"
  17 #include "util/string.h"
  18
  19 #include "perf.h"
  20 #include "util/debug.h"
  21
  22 #include "util/event.h"
  23 #include "util/parse-options.h"
  24 #include "util/parse-events.h"
  25 #include "util/thread.h"
  26 #include "util/sort.h"
  27 #include "util/hist.h"
  28 #include "util/session.h"
  29
  30 static char             const *input_name = "perf.data";
  31
  32 static int              force;
  33
  34 static int              full_paths;
  35
  36 static int              print_line;
  37
  38 struct sym_hist {
  39         u64             sum;
  40         u64             ip[0];
  41 };
  42
  43 struct sym_ext {
  44         struct rb_node  node;
  45         double          percent;
  46         char            *path;
  47 };
  48
  49 struct sym_priv {
  50         struct sym_hist *hist;
  51         struct sym_ext  *ext;
  52 };
  53
  54 static struct symbol_conf symbol_conf = {
  55         .priv_size        = sizeof(struct sym_priv),
  56         .try_vmlinux_path = true,
  57 };
  58
  59 static const char *sym_hist_filter;
  60
  61 static int symbol_filter(struct map *map __used, struct symbol *sym)
  62 {
  63         if (sym_hist_filter == NULL ||
  64             strcmp(sym->name, sym_hist_filter) == 0) {
  65                 struct sym_priv *priv = symbol__priv(sym);
  66                 const int size = (sizeof(*priv->hist) +
  67                                   (sym->end - sym->start) * sizeof(u64));
  68
  69                 priv->hist = malloc(size);
  70                 if (priv->hist)
  71                         memset(priv->hist, 0, size);
  72                 return 0;
  73         }
  74         /*
  75          * FIXME: We should really filter it out, as we don't want to go thru symbols
  76          * we're not interested, and if a DSO ends up with no symbols, delete it too,
  77          * but right now the kernel loading routines in symbol.c bail out if no symbols
  78          * are found, fix it later.
  79          */
  80         return 0;
  81 }
  82
  83 /*
  84  * collect histogram counts
  85  */
  86 static void hist_hit(struct hist_entry *he, u64 ip)
  87 {
  88         unsigned int sym_size, offset;
  89         struct symbol *sym = he->sym;
  90         struct sym_priv *priv;
  91         struct sym_hist *h;
  92
  93         he->count++;
  94
  95         if (!sym || !he->map)
  96                 return;
  97
  98         priv = symbol__priv(sym);
  99         if (!priv->hist)
 100                 return;
 101
 102         sym_size = sym->end - sym->start;
 103         offset = ip - sym->start;
 104
 105         if (verbose)
 106                 fprintf(stderr, "%s: ip=%Lx\n", __func__,
 107                         he->map->unmap_ip(he->map, ip));
 108
 109         if (offset >= sym_size)
 110                 return;
 111
 112         h = priv->hist;
 113         h->sum++;
 114         h->ip[offset]++;
 115
 116         if (verbose >= 3)
 117                 printf("%p %s: count++ [ip: %p, %08Lx] => %Ld\n",
 118                         (void *)(unsigned long)he->sym->start,
 119                         he->sym->name,
 120                         (void *)(unsigned long)ip, ip - he->sym->start,
 121                         h->ip[offset]);
 122 }
 123
 124 static int perf_session__add_hist_entry(struct perf_session *self,
 125                                         struct addr_location *al, u64 count)
 126 {
 127         bool hit;
 128         struct hist_entry *he = __perf_session__add_hist_entry(self, al, NULL,
 129                                                                count, &hit);
 130         if (he == NULL)
 131                 return -ENOMEM;
 132         hist_hit(he, al->addr);
 133         return 0;
 134 }
 135
 136 static int process_sample_event(event_t *event, struct perf_session *session)
 137 {
 138         struct addr_location al;
 139
 140         dump_printf("(IP, %d): %d: %p\n", event->header.misc,
 141                     event->ip.pid, (void *)(long)event->ip.ip);
 142
 143         if (event__preprocess_sample(event, session, &al, symbol_filter) < 0) {
 144                 fprintf(stderr, "problem processing %d event, skipping it.\n",
 145                         event->header.type);
 146                 return -1;
 147         }
 148
 149         if (perf_session__add_hist_entry(session, &al, 1)) {
 150                 fprintf(stderr, "problem incrementing symbol count, "
 151                                 "skipping event\n");
 152                 return -1;
 153         }
 154
 155         return 0;
 156 }
 157
 158 static int parse_line(FILE *file, struct hist_entry *he, u64 len)
 159 {
 160         struct symbol *sym = he->sym;
 161         char *line = NULL, *tmp, *tmp2;
 162         static const char *prev_line;
 163         static const char *prev_color;
 164         unsigned int offset;
 165         size_t line_len;
 166         u64 start;
 167         s64 line_ip;
 168         int ret;
 169         char *c;
 170
 171         if (getline(&line, &line_len, file) < 0)
 172                 return -1;
 173         if (!line)
 174                 return -1;
 175
 176         c = strchr(line, '\n');
 177         if (c)
 178                 *c = 0;
 179
 180         line_ip = -1;
 181         offset = 0;
 182         ret = -2;
 183
 184         /*
 185          * Strip leading spaces:
 186          */
 187         tmp = line;
 188         while (*tmp) {
 189                 if (*tmp != ' ')
 190                         break;
 191                 tmp++;
 192         }
 193
 194         if (*tmp) {
 195                 /*
 196                  * Parse hexa addresses followed by ':'
 197                  */
 198                 line_ip = strtoull(tmp, &tmp2, 16);
 199                 if (*tmp2 != ':')
 200                         line_ip = -1;
 201         }
 202
 203         start = he->map->unmap_ip(he->map, sym->start);
 204
 205         if (line_ip != -1) {
 206                 const char *path = NULL;
 207                 unsigned int hits = 0;
 208                 double percent = 0.0;
 209                 const char *color;
 210                 struct sym_priv *priv = symbol__priv(sym);
 211                 struct sym_ext *sym_ext = priv->ext;
 212                 struct sym_hist *h = priv->hist;
 213
 214                 offset = line_ip - start;
 215                 if (offset < len)
 216                         hits = h->ip[offset];
 217
 218                 if (offset < len && sym_ext) {
 219                         path = sym_ext[offset].path;
 220                         percent = sym_ext[offset].percent;
 221                 } else if (h->sum)
 222                         percent = 100.0 * hits / h->sum;
 223
 224                 color = get_percent_color(percent);
 225
 226                 /*
 227                  * Also color the filename and line if needed, with
 228                  * the same color than the percentage. Don't print it
 229                  * twice for close colored ip with the same filename:line
 230                  */
 231                 if (path) {
 232                         if (!prev_line || strcmp(prev_line, path)
 233                                        || color != prev_color) {
 234                                 color_fprintf(stdout, color, " %s", path);
 235                                 prev_line = path;
 236                                 prev_color = color;
 237                         }
 238                 }
 239
 240                 color_fprintf(stdout, color, " %7.2f", percent);
 241                 printf(" :      ");
 242                 color_fprintf(stdout, PERF_COLOR_BLUE, "%s\n", line);
 243         } else {
 244                 if (!*line)
 245                         printf("         :\n");
 246                 else
 247                         printf("         :      %s\n", line);
 248         }
 249
 250         return 0;
 251 }
 252
 253 static struct rb_root root_sym_ext;
 254
 255 static void insert_source_line(struct sym_ext *sym_ext)
 256 {
 257         struct sym_ext *iter;
 258         struct rb_node **p = &root_sym_ext.rb_node;
 259         struct rb_node *parent = NULL;
 260
 261         while (*p != NULL) {
 262                 parent = *p;
 263                 iter = rb_entry(parent, struct sym_ext, node);
 264
 265                 if (sym_ext->percent > iter->percent)
 266                         p = &(*p)->rb_left;
 267                 else
 268                         p = &(*p)->rb_right;
 269         }
 270
 271         rb_link_node(&sym_ext->node, parent, p);
 272         rb_insert_color(&sym_ext->node, &root_sym_ext);
 273 }
 274
 275 static void free_source_line(struct hist_entry *he, int len)
 276 {
 277         struct sym_priv *priv = symbol__priv(he->sym);
 278         struct sym_ext *sym_ext = priv->ext;
 279         int i;
 280
 281         if (!sym_ext)
 282                 return;
 283
 284         for (i = 0; i < len; i++)
 285                 free(sym_ext[i].path);
 286         free(sym_ext);
 287
 288         priv->ext = NULL;
 289         root_sym_ext = RB_ROOT;
 290 }
 291
 292 /* Get the filename:line for the colored entries */
 293 static void
 294 get_source_line(struct hist_entry *he, int len, const char *filename)
 295 {
 296         struct symbol *sym = he->sym;
 297         u64 start;
 298         int i;
 299         char cmd[PATH_MAX * 2];
 300         struct sym_ext *sym_ext;
 301         struct sym_priv *priv = symbol__priv(sym);
 302         struct sym_hist *h = priv->hist;
 303
 304         if (!h->sum)
 305                 return;
 306
 307         sym_ext = priv->ext = calloc(len, sizeof(struct sym_ext));
 308         if (!priv->ext)
 309                 return;
 310
 311         start = he->map->unmap_ip(he->map, sym->start);
 312
 313         for (i = 0; i < len; i++) {
 314                 char *path = NULL;
 315                 size_t line_len;
 316                 u64 offset;
 317                 FILE *fp;
 318
 319                 sym_ext[i].percent = 100.0 * h->ip[i] / h->sum;
 320                 if (sym_ext[i].percent <= 0.5)
 321                         continue;
 322
 323                 offset = start + i;
 324                 sprintf(cmd, "addr2line -e %s %016llx", filename, offset);
 325                 fp = popen(cmd, "r");
 326                 if (!fp)
 327                         continue;
 328
 329                 if (getline(&path, &line_len, fp) < 0 || !line_len)
 330                         goto next;
 331
 332                 sym_ext[i].path = malloc(sizeof(char) * line_len + 1);
 333                 if (!sym_ext[i].path)
 334                         goto next;
 335
 336                 strcpy(sym_ext[i].path, path);
 337                 insert_source_line(&sym_ext[i]);
 338
 339         next:
 340                 pclose(fp);
 341         }
 342 }
 343
 344 static void print_summary(const char *filename)
 345 {
 346         struct sym_ext *sym_ext;
 347         struct rb_node *node;
 348
 349         printf("\nSorted summary for file %s\n", filename);
 350         printf("----------------------------------------------\n\n");
 351
 352         if (RB_EMPTY_ROOT(&root_sym_ext)) {
 353                 printf(" Nothing higher than %1.1f%%\n", MIN_GREEN);
 354                 return;
 355         }
 356
 357         node = rb_first(&root_sym_ext);
 358         while (node) {
 359                 double percent;
 360                 const char *color;
 361                 char *path;
 362
 363                 sym_ext = rb_entry(node, struct sym_ext, node);
 364                 percent = sym_ext->percent;
 365                 color = get_percent_color(percent);
 366                 path = sym_ext->path;
 367
 368                 color_fprintf(stdout, color, " %7.2f %s", percent, path);
 369                 node = rb_next(node);
 370         }
 371 }
 372
 373 static void annotate_sym(struct hist_entry *he)
 374 {
 375         struct map *map = he->map;
 376         struct dso *dso = map->dso;
 377         struct symbol *sym = he->sym;
 378         const char *filename = dso->long_name, *d_filename;
 379         u64 len;
 380         char command[PATH_MAX*2];
 381         FILE *file;
 382
 383         if (!filename)
 384                 return;
 385
 386         if (verbose)
 387                 fprintf(stderr, "%s: filename=%s, sym=%s, start=%Lx, end=%Lx\n",
 388                         __func__, filename, sym->name,
 389                         map->unmap_ip(map, sym->start),
 390                         map->unmap_ip(map, sym->end));
 391
 392         if (full_paths)
 393                 d_filename = filename;
 394         else
 395                 d_filename = basename(filename);
 396
 397         len = sym->end - sym->start;
 398
 399         if (print_line) {
 400                 get_source_line(he, len, filename);
 401                 print_summary(filename);
 402         }
 403
 404         printf("\n\n------------------------------------------------\n");
 405         printf(" Percent |      Source code & Disassembly of %s\n", d_filename);
 406         printf("------------------------------------------------\n");
 407
 408         if (verbose >= 2)
 409                 printf("annotating [%p] %30s : [%p] %30s\n",
 410                        dso, dso->long_name, sym, sym->name);
 411
 412         sprintf(command, "objdump --start-address=0x%016Lx --stop-address=0x%016Lx -dS %s|grep -v %s",
 413                 map->unmap_ip(map, sym->start), map->unmap_ip(map, sym->end),
 414                 filename, filename);
 415
 416         if (verbose >= 3)
 417                 printf("doing: %s\n", command);
 418
 419         file = popen(command, "r");
 420         if (!file)
 421                 return;
 422
 423         while (!feof(file)) {
 424                 if (parse_line(file, he, len) < 0)
 425                         break;
 426         }
 427
 428         pclose(file);
 429         if (print_line)
 430                 free_source_line(he, len);
 431 }
 432
 433 static void perf_session__find_annotations(struct perf_session *self)
 434 {
 435         struct rb_node *nd;
 436
 437         for (nd = rb_first(&self->hists); nd; nd = rb_next(nd)) {
 438                 struct hist_entry *he = rb_entry(nd, struct hist_entry, rb_node);
 439                 struct sym_priv *priv;
 440
 441                 if (he->sym == NULL)
 442                         continue;
 443
 444                 priv = symbol__priv(he->sym);
 445                 if (priv->hist == NULL)
 446                         continue;
 447
 448                 annotate_sym(he);
 449                 /*
 450                  * Since we have a hist_entry per IP for the same symbol, free
 451                  * he->sym->hist to signal we already processed this symbol.
 452                  */
 453                 free(priv->hist);
 454                 priv->hist = NULL;
 455         }
 456 }
 457
 458 static struct perf_event_ops event_ops = {
 459         .process_sample_event   = process_sample_event,
 460         .process_mmap_event     = event__process_mmap,
 461         .process_comm_event     = event__process_comm,
 462         .process_fork_event     = event__process_task,
 463 };
 464
 465 static int __cmd_annotate(void)
 466 {
 467         struct perf_session *session = perf_session__new(input_name, O_RDONLY,
 468                                                          force, &symbol_conf);
 469         int ret;
 470
 471         if (session == NULL)
 472                 return -ENOMEM;
 473
 474         ret = perf_session__process_events(session, &event_ops);
 475         if (ret)
 476                 goto out_delete;
 477
 478         if (dump_trace) {
 479                 event__print_totals();
 480                 goto out_delete;
 481         }
 482
 483         if (verbose > 3)
 484                 perf_session__fprintf(session, stdout);
 485
 486         if (verbose > 2)
 487                 dsos__fprintf(stdout);
 488
 489         perf_session__collapse_resort(session);
 490         perf_session__output_resort(session, session->event_total[0]);
 491         perf_session__find_annotations(session);
 492 out_delete:
 493         perf_session__delete(session);
 494
 495         return ret;
 496 }
 497
 498 static const char * const annotate_usage[] = {
 499         "perf annotate [<options>] <command>",
 500         NULL
 501 };
 502
 503 static const struct option options[] = {
 504         OPT_STRING('i', "input", &input_name, "file",
 505                     "input file name"),
 506         OPT_STRING('s', "symbol", &sym_hist_filter, "symbol",
 507                     "symbol to annotate"),
 508         OPT_BOOLEAN('f', "force", &force, "don't complain, do it"),
 509         OPT_BOOLEAN('v', "verbose", &verbose,
 510                     "be more verbose (show symbol address, etc)"),
 511         OPT_BOOLEAN('D', "dump-raw-trace", &dump_trace,
 512                     "dump raw trace in ASCII"),
 513         OPT_STRING('k', "vmlinux", &symbol_conf.vmlinux_name,
 514                    "file", "vmlinux pathname"),
 515         OPT_BOOLEAN('m', "modules", &symbol_conf.use_modules,
 516                     "load module symbols - WARNING: use only with -k and LIVE kernel"),
 517         OPT_BOOLEAN('l', "print-line", &print_line,
 518                     "print matching source lines (may be slow)"),
 519         OPT_BOOLEAN('P', "full-paths", &full_paths,
 520                     "Don't shorten the displayed pathnames"),
 521         OPT_END()
 522 };
 523
 524 static void setup_sorting(void)
 525 {
 526         char *tmp, *tok, *str = strdup(sort_order);
 527
 528         for (tok = strtok_r(str, ", ", &tmp);
 529                         tok; tok = strtok_r(NULL, ", ", &tmp)) {
 530                 if (sort_dimension__add(tok) < 0) {
 531                         error("Unknown --sort key: `%s'", tok);
 532                         usage_with_options(annotate_usage, options);
 533                 }
 534         }
 535
 536         free(str);
 537 }
 538
 539 int cmd_annotate(int argc, const char **argv, const char *prefix __used)
 540 {
 541         if (symbol__init(&symbol_conf) < 0)
 542                 return -1;
 543
 544         argc = parse_options(argc, argv, options, annotate_usage, 0);
 545
 546         setup_sorting();
 547
 548         if (argc) {
 549                 /*
 550                  * Special case: if there's an argument left then assume tha
 551                  * it's a symbol filter:
 552                  */
 553                 if (argc > 1)
 554                         usage_with_options(annotate_usage, options);
 555
 556                 sym_hist_filter = argv[0];
 557         }
 558
 559         setup_pager();
 560
 561         if (field_sep && *field_sep == '.') {
 562                 fputs("'.' is the only non valid --field-separator argument\n",
 563                                 stderr);
 564                 exit(129);
 565         }
 566
 567         return __cmd_annotate();
 568 }