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