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