tools/perf/util/dso.c

   1 #include "symbol.h"
   2 #include "dso.h"
   3 #include "machine.h"
   4 #include "util.h"
   5 #include "debug.h"
   6
   7 char dso__symtab_origin(const struct dso *dso)
   8 {
   9         static const char origin[] = {
  10                 [DSO_BINARY_TYPE__KALLSYMS]                     = 'k',
  11                 [DSO_BINARY_TYPE__VMLINUX]                      = 'v',
  12                 [DSO_BINARY_TYPE__JAVA_JIT]                     = 'j',
  13                 [DSO_BINARY_TYPE__DEBUGLINK]                    = 'l',
  14                 [DSO_BINARY_TYPE__BUILD_ID_CACHE]               = 'B',
  15                 [DSO_BINARY_TYPE__FEDORA_DEBUGINFO]             = 'f',
  16                 [DSO_BINARY_TYPE__UBUNTU_DEBUGINFO]             = 'u',
  17                 [DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO]       = 'o',
  18                 [DSO_BINARY_TYPE__BUILDID_DEBUGINFO]            = 'b',
  19                 [DSO_BINARY_TYPE__SYSTEM_PATH_DSO]              = 'd',
  20                 [DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE]          = 'K',
  21                 [DSO_BINARY_TYPE__GUEST_KALLSYMS]               = 'g',
  22                 [DSO_BINARY_TYPE__GUEST_KMODULE]                = 'G',
  23                 [DSO_BINARY_TYPE__GUEST_VMLINUX]                = 'V',
  24         };
  25
  26         if (dso == NULL || dso->symtab_type == DSO_BINARY_TYPE__NOT_FOUND)
  27                 return '!';
  28         return origin[dso->symtab_type];
  29 }
  30
  31 int dso__binary_type_file(struct dso *dso, enum dso_binary_type type,
  32                           char *root_dir, char *file, size_t size)
  33 {
  34         char build_id_hex[BUILD_ID_SIZE * 2 + 1];
  35         int ret = 0;
  36
  37         switch (type) {
  38         case DSO_BINARY_TYPE__DEBUGLINK: {
  39                 char *debuglink;
  40
  41                 strncpy(file, dso->long_name, size);
  42                 debuglink = file + dso->long_name_len;
  43                 while (debuglink != file && *debuglink != '/')
  44                         debuglink--;
  45                 if (*debuglink == '/')
  46                         debuglink++;
  47                 filename__read_debuglink(dso->long_name, debuglink,
  48                                          size - (debuglink - file));
  49                 }
  50                 break;
  51         case DSO_BINARY_TYPE__BUILD_ID_CACHE:
  52                 /* skip the locally configured cache if a symfs is given */
  53                 if (symbol_conf.symfs[0] ||
  54                     (dso__build_id_filename(dso, file, size) == NULL))
  55                         ret = -1;
  56                 break;
  57
  58         case DSO_BINARY_TYPE__FEDORA_DEBUGINFO:
  59                 snprintf(file, size, "%s/usr/lib/debug%s.debug",
  60                          symbol_conf.symfs, dso->long_name);
  61                 break;
  62
  63         case DSO_BINARY_TYPE__UBUNTU_DEBUGINFO:
  64                 snprintf(file, size, "%s/usr/lib/debug%s",
  65                          symbol_conf.symfs, dso->long_name);
  66                 break;
  67
  68         case DSO_BINARY_TYPE__OPENEMBEDDED_DEBUGINFO:
  69         {
  70                 char *last_slash;
  71                 size_t len;
  72                 size_t dir_size;
  73
  74                 last_slash = dso->long_name + dso->long_name_len;
  75                 while (last_slash != dso->long_name && *last_slash != '/')
  76                         last_slash--;
  77
  78                 len = scnprintf(file, size, "%s", symbol_conf.symfs);
  79                 dir_size = last_slash - dso->long_name + 2;
  80                 if (dir_size > (size - len)) {
  81                         ret = -1;
  82                         break;
  83                 }
  84                 len += scnprintf(file + len, dir_size, "%s",  dso->long_name);
  85                 len += scnprintf(file + len , size - len, ".debug%s",
  86                                                                 last_slash);
  87                 break;
  88         }
  89
  90         case DSO_BINARY_TYPE__BUILDID_DEBUGINFO:
  91                 if (!dso->has_build_id) {
  92                         ret = -1;
  93                         break;
  94                 }
  95
  96                 build_id__sprintf(dso->build_id,
  97                                   sizeof(dso->build_id),
  98                                   build_id_hex);
  99                 snprintf(file, size,
 100                          "%s/usr/lib/debug/.build-id/%.2s/%s.debug",
 101                          symbol_conf.symfs, build_id_hex, build_id_hex + 2);
 102                 break;
 103
 104         case DSO_BINARY_TYPE__VMLINUX:
 105         case DSO_BINARY_TYPE__GUEST_VMLINUX:
 106         case DSO_BINARY_TYPE__SYSTEM_PATH_DSO:
 107                 snprintf(file, size, "%s%s",
 108                          symbol_conf.symfs, dso->long_name);
 109                 break;
 110
 111         case DSO_BINARY_TYPE__GUEST_KMODULE:
 112                 snprintf(file, size, "%s%s%s", symbol_conf.symfs,
 113                          root_dir, dso->long_name);
 114                 break;
 115
 116         case DSO_BINARY_TYPE__SYSTEM_PATH_KMODULE:
 117                 snprintf(file, size, "%s%s", symbol_conf.symfs,
 118                          dso->long_name);
 119                 break;
 120
 121         case DSO_BINARY_TYPE__KCORE:
 122         case DSO_BINARY_TYPE__GUEST_KCORE:
 123                 snprintf(file, size, "%s", dso->long_name);
 124                 break;
 125
 126         default:
 127         case DSO_BINARY_TYPE__KALLSYMS:
 128         case DSO_BINARY_TYPE__GUEST_KALLSYMS:
 129         case DSO_BINARY_TYPE__JAVA_JIT:
 130         case DSO_BINARY_TYPE__NOT_FOUND:
 131                 ret = -1;
 132                 break;
 133         }
 134
 135         return ret;
 136 }
 137
 138 static int open_dso(struct dso *dso, struct machine *machine)
 139 {
 140         char *root_dir = (char *) "";
 141         char *name;
 142         int fd;
 143
 144         name = malloc(PATH_MAX);
 145         if (!name)
 146                 return -ENOMEM;
 147
 148         if (machine)
 149                 root_dir = machine->root_dir;
 150
 151         if (dso__binary_type_file(dso, dso->data_type,
 152                                   root_dir, name, PATH_MAX)) {
 153                 free(name);
 154                 return -EINVAL;
 155         }
 156
 157         fd = open(name, O_RDONLY);
 158         free(name);
 159         return fd;
 160 }
 161
 162 int dso__data_fd(struct dso *dso, struct machine *machine)
 163 {
 164         static enum dso_binary_type binary_type_data[] = {
 165                 DSO_BINARY_TYPE__BUILD_ID_CACHE,
 166                 DSO_BINARY_TYPE__SYSTEM_PATH_DSO,
 167                 DSO_BINARY_TYPE__NOT_FOUND,
 168         };
 169         int i = 0;
 170
 171         if (dso->data_type != DSO_BINARY_TYPE__NOT_FOUND)
 172                 return open_dso(dso, machine);
 173
 174         do {
 175                 int fd;
 176
 177                 dso->data_type = binary_type_data[i++];
 178
 179                 fd = open_dso(dso, machine);
 180                 if (fd >= 0)
 181                         return fd;
 182
 183         } while (dso->data_type != DSO_BINARY_TYPE__NOT_FOUND);
 184
 185         return -EINVAL;
 186 }
 187
 188 static void
 189 dso_cache__free(struct rb_root *root)
 190 {
 191         struct rb_node *next = rb_first(root);
 192
 193         while (next) {
 194                 struct dso_cache *cache;
 195
 196                 cache = rb_entry(next, struct dso_cache, rb_node);
 197                 next = rb_next(&cache->rb_node);
 198                 rb_erase(&cache->rb_node, root);
 199                 free(cache);
 200         }
 201 }
 202
 203 static struct dso_cache*
 204 dso_cache__find(struct rb_root *root, u64 offset)
 205 {
 206         struct rb_node **p = &root->rb_node;
 207         struct rb_node *parent = NULL;
 208         struct dso_cache *cache;
 209
 210         while (*p != NULL) {
 211                 u64 end;
 212
 213                 parent = *p;
 214                 cache = rb_entry(parent, struct dso_cache, rb_node);
 215                 end = cache->offset + DSO__DATA_CACHE_SIZE;
 216
 217                 if (offset < cache->offset)
 218                         p = &(*p)->rb_left;
 219                 else if (offset >= end)
 220                         p = &(*p)->rb_right;
 221                 else
 222                         return cache;
 223         }
 224         return NULL;
 225 }
 226
 227 static void
 228 dso_cache__insert(struct rb_root *root, struct dso_cache *new)
 229 {
 230         struct rb_node **p = &root->rb_node;
 231         struct rb_node *parent = NULL;
 232         struct dso_cache *cache;
 233         u64 offset = new->offset;
 234
 235         while (*p != NULL) {
 236                 u64 end;
 237
 238                 parent = *p;
 239                 cache = rb_entry(parent, struct dso_cache, rb_node);
 240                 end = cache->offset + DSO__DATA_CACHE_SIZE;
 241
 242                 if (offset < cache->offset)
 243                         p = &(*p)->rb_left;
 244                 else if (offset >= end)
 245                         p = &(*p)->rb_right;
 246         }
 247
 248         rb_link_node(&new->rb_node, parent, p);
 249         rb_insert_color(&new->rb_node, root);
 250 }
 251
 252 static ssize_t
 253 dso_cache__memcpy(struct dso_cache *cache, u64 offset,
 254                   u8 *data, u64 size)
 255 {
 256         u64 cache_offset = offset - cache->offset;
 257         u64 cache_size   = min(cache->size - cache_offset, size);
 258
 259         memcpy(data, cache->data + cache_offset, cache_size);
 260         return cache_size;
 261 }
 262
 263 static ssize_t
 264 dso_cache__read(struct dso *dso, struct machine *machine,
 265                  u64 offset, u8 *data, ssize_t size)
 266 {
 267         struct dso_cache *cache;
 268         ssize_t ret;
 269         int fd;
 270
 271         fd = dso__data_fd(dso, machine);
 272         if (fd < 0)
 273                 return -1;
 274
 275         do {
 276                 u64 cache_offset;
 277
 278                 ret = -ENOMEM;
 279
 280                 cache = zalloc(sizeof(*cache) + DSO__DATA_CACHE_SIZE);
 281                 if (!cache)
 282                         break;
 283
 284                 cache_offset = offset & DSO__DATA_CACHE_MASK;
 285                 ret = -EINVAL;
 286
 287                 if (-1 == lseek(fd, cache_offset, SEEK_SET))
 288                         break;
 289
 290                 ret = read(fd, cache->data, DSO__DATA_CACHE_SIZE);
 291                 if (ret <= 0)
 292                         break;
 293
 294                 cache->offset = cache_offset;
 295                 cache->size   = ret;
 296                 dso_cache__insert(&dso->cache, cache);
 297
 298                 ret = dso_cache__memcpy(cache, offset, data, size);
 299
 300         } while (0);
 301
 302         if (ret <= 0)
 303                 free(cache);
 304
 305         close(fd);
 306         return ret;
 307 }
 308
 309 static ssize_t dso_cache_read(struct dso *dso, struct machine *machine,
 310                               u64 offset, u8 *data, ssize_t size)
 311 {
 312         struct dso_cache *cache;
 313
 314         cache = dso_cache__find(&dso->cache, offset);
 315         if (cache)
 316                 return dso_cache__memcpy(cache, offset, data, size);
 317         else
 318                 return dso_cache__read(dso, machine, offset, data, size);
 319 }
 320
 321 ssize_t dso__data_read_offset(struct dso *dso, struct machine *machine,
 322                               u64 offset, u8 *data, ssize_t size)
 323 {
 324         ssize_t r = 0;
 325         u8 *p = data;
 326
 327         do {
 328                 ssize_t ret;
 329
 330                 ret = dso_cache_read(dso, machine, offset, p, size);
 331                 if (ret < 0)
 332                         return ret;
 333
 334                 /* Reached EOF, return what we have. */
 335                 if (!ret)
 336                         break;
 337
 338                 BUG_ON(ret > size);
 339
 340                 r      += ret;
 341                 p      += ret;
 342                 offset += ret;
 343                 size   -= ret;
 344
 345         } while (size);
 346
 347         return r;
 348 }
 349
 350 ssize_t dso__data_read_addr(struct dso *dso, struct map *map,
 351                             struct machine *machine, u64 addr,
 352                             u8 *data, ssize_t size)
 353 {
 354         u64 offset = map->map_ip(map, addr);
 355         return dso__data_read_offset(dso, machine, offset, data, size);
 356 }
 357
 358 struct map *dso__new_map(const char *name)
 359 {
 360         struct map *map = NULL;
 361         struct dso *dso = dso__new(name);
 362
 363         if (dso)
 364                 map = map__new2(0, dso, MAP__FUNCTION);
 365
 366         return map;
 367 }
 368
 369 struct dso *dso__kernel_findnew(struct machine *machine, const char *name,
 370                     const char *short_name, int dso_type)
 371 {
 372         /*
 373          * The kernel dso could be created by build_id processing.
 374          */
 375         struct dso *dso = __dsos__findnew(&machine->kernel_dsos, name);
 376
 377         /*
 378          * We need to run this in all cases, since during the build_id
 379          * processing we had no idea this was the kernel dso.
 380          */
 381         if (dso != NULL) {
 382                 dso__set_short_name(dso, short_name);
 383                 dso->kernel = dso_type;
 384         }
 385
 386         return dso;
 387 }
 388
 389 void dso__set_long_name(struct dso *dso, char *name)
 390 {
 391         if (name == NULL)
 392                 return;
 393         dso->long_name = name;
 394         dso->long_name_len = strlen(name);
 395 }
 396
 397 void dso__set_short_name(struct dso *dso, const char *name)
 398 {
 399         if (name == NULL)
 400                 return;
 401         dso->short_name = name;
 402         dso->short_name_len = strlen(name);
 403 }
 404
 405 static void dso__set_basename(struct dso *dso)
 406 {
 407         dso__set_short_name(dso, basename(dso->long_name));
 408 }
 409
 410 int dso__name_len(const struct dso *dso)
 411 {
 412         if (!dso)
 413                 return strlen("[unknown]");
 414         if (verbose)
 415                 return dso->long_name_len;
 416
 417         return dso->short_name_len;
 418 }
 419
 420 bool dso__loaded(const struct dso *dso, enum map_type type)
 421 {
 422         return dso->loaded & (1 << type);
 423 }
 424
 425 bool dso__sorted_by_name(const struct dso *dso, enum map_type type)
 426 {
 427         return dso->sorted_by_name & (1 << type);
 428 }
 429
 430 void dso__set_sorted_by_name(struct dso *dso, enum map_type type)
 431 {
 432         dso->sorted_by_name |= (1 << type);
 433 }
 434
 435 struct dso *dso__new(const char *name)
 436 {
 437         struct dso *dso = calloc(1, sizeof(*dso) + strlen(name) + 1);
 438
 439         if (dso != NULL) {
 440                 int i;
 441                 strcpy(dso->name, name);
 442                 dso__set_long_name(dso, dso->name);
 443                 dso__set_short_name(dso, dso->name);
 444                 for (i = 0; i < MAP__NR_TYPES; ++i)
 445                         dso->symbols[i] = dso->symbol_names[i] = RB_ROOT;
 446                 dso->cache = RB_ROOT;
 447                 dso->symtab_type = DSO_BINARY_TYPE__NOT_FOUND;
 448                 dso->data_type   = DSO_BINARY_TYPE__NOT_FOUND;
 449                 dso->loaded = 0;
 450                 dso->rel = 0;
 451                 dso->sorted_by_name = 0;
 452                 dso->has_build_id = 0;
 453                 dso->kernel = DSO_TYPE_USER;
 454                 dso->needs_swap = DSO_SWAP__UNSET;
 455                 INIT_LIST_HEAD(&dso->node);
 456         }
 457
 458         return dso;
 459 }
 460
 461 void dso__delete(struct dso *dso)
 462 {
 463         int i;
 464         for (i = 0; i < MAP__NR_TYPES; ++i)
 465                 symbols__delete(&dso->symbols[i]);
 466         if (dso->sname_alloc)
 467                 free((char *)dso->short_name);
 468         if (dso->lname_alloc)
 469                 free(dso->long_name);
 470         dso_cache__free(&dso->cache);
 471         free(dso);
 472 }
 473
 474 void dso__set_build_id(struct dso *dso, void *build_id)
 475 {
 476         memcpy(dso->build_id, build_id, sizeof(dso->build_id));
 477         dso->has_build_id = 1;
 478 }
 479
 480 bool dso__build_id_equal(const struct dso *dso, u8 *build_id)
 481 {
 482         return memcmp(dso->build_id, build_id, sizeof(dso->build_id)) == 0;
 483 }
 484
 485 void dso__read_running_kernel_build_id(struct dso *dso, struct machine *machine)
 486 {
 487         char path[PATH_MAX];
 488
 489         if (machine__is_default_guest(machine))
 490                 return;
 491         sprintf(path, "%s/sys/kernel/notes", machine->root_dir);
 492         if (sysfs__read_build_id(path, dso->build_id,
 493                                  sizeof(dso->build_id)) == 0)
 494                 dso->has_build_id = true;
 495 }
 496
 497 int dso__kernel_module_get_build_id(struct dso *dso,
 498                                     const char *root_dir)
 499 {
 500         char filename[PATH_MAX];
 501         /*
 502          * kernel module short names are of the form "[module]" and
 503          * we need just "module" here.
 504          */
 505         const char *name = dso->short_name + 1;
 506
 507         snprintf(filename, sizeof(filename),
 508                  "%s/sys/module/%.*s/notes/.note.gnu.build-id",
 509                  root_dir, (int)strlen(name) - 1, name);
 510
 511         if (sysfs__read_build_id(filename, dso->build_id,
 512                                  sizeof(dso->build_id)) == 0)
 513                 dso->has_build_id = true;
 514
 515         return 0;
 516 }
 517
 518 bool __dsos__read_build_ids(struct list_head *head, bool with_hits)
 519 {
 520         bool have_build_id = false;
 521         struct dso *pos;
 522
 523         list_for_each_entry(pos, head, node) {
 524                 if (with_hits && !pos->hit)
 525                         continue;
 526                 if (pos->has_build_id) {
 527                         have_build_id = true;
 528                         continue;
 529                 }
 530                 if (filename__read_build_id(pos->long_name, pos->build_id,
 531                                             sizeof(pos->build_id)) > 0) {
 532                         have_build_id     = true;
 533                         pos->has_build_id = true;
 534                 }
 535         }
 536
 537         return have_build_id;
 538 }
 539
 540 void dsos__add(struct list_head *head, struct dso *dso)
 541 {
 542         list_add_tail(&dso->node, head);
 543 }
 544
 545 struct dso *dsos__find(struct list_head *head, const char *name, bool cmp_short)
 546 {
 547         struct dso *pos;
 548
 549         if (cmp_short) {
 550                 list_for_each_entry(pos, head, node)
 551                         if (strcmp(pos->short_name, name) == 0)
 552                                 return pos;
 553                 return NULL;
 554         }
 555         list_for_each_entry(pos, head, node)
 556                 if (strcmp(pos->long_name, name) == 0)
 557                         return pos;
 558         return NULL;
 559 }
 560
 561 struct dso *__dsos__findnew(struct list_head *head, const char *name)
 562 {
 563         struct dso *dso = dsos__find(head, name, false);
 564
 565         if (!dso) {
 566                 dso = dso__new(name);
 567                 if (dso != NULL) {
 568                         dsos__add(head, dso);
 569                         dso__set_basename(dso);
 570                 }
 571         }
 572
 573         return dso;
 574 }
 575
 576 size_t __dsos__fprintf_buildid(struct list_head *head, FILE *fp,
 577                                bool (skip)(struct dso *dso, int parm), int parm)
 578 {
 579         struct dso *pos;
 580         size_t ret = 0;
 581
 582         list_for_each_entry(pos, head, node) {
 583                 if (skip && skip(pos, parm))
 584                         continue;
 585                 ret += dso__fprintf_buildid(pos, fp);
 586                 ret += fprintf(fp, " %s\n", pos->long_name);
 587         }
 588         return ret;
 589 }
 590
 591 size_t __dsos__fprintf(struct list_head *head, FILE *fp)
 592 {
 593         struct dso *pos;
 594         size_t ret = 0;
 595
 596         list_for_each_entry(pos, head, node) {
 597                 int i;
 598                 for (i = 0; i < MAP__NR_TYPES; ++i)
 599                         ret += dso__fprintf(pos, i, fp);
 600         }
 601
 602         return ret;
 603 }
 604
 605 size_t dso__fprintf_buildid(struct dso *dso, FILE *fp)
 606 {
 607         char sbuild_id[BUILD_ID_SIZE * 2 + 1];
 608
 609         build_id__sprintf(dso->build_id, sizeof(dso->build_id), sbuild_id);
 610         return fprintf(fp, "%s", sbuild_id);
 611 }
 612
 613 size_t dso__fprintf(struct dso *dso, enum map_type type, FILE *fp)
 614 {
 615         struct rb_node *nd;
 616         size_t ret = fprintf(fp, "dso: %s (", dso->short_name);
 617
 618         if (dso->short_name != dso->long_name)
 619                 ret += fprintf(fp, "%s, ", dso->long_name);
 620         ret += fprintf(fp, "%s, %sloaded, ", map_type__name[type],
 621                        dso__loaded(dso, type) ? "" : "NOT ");
 622         ret += dso__fprintf_buildid(dso, fp);
 623         ret += fprintf(fp, ")\n");
 624         for (nd = rb_first(&dso->symbols[type]); nd; nd = rb_next(nd)) {
 625                 struct symbol *pos = rb_entry(nd, struct symbol, rb_node);
 626                 ret += symbol__fprintf(pos, fp);
 627         }
 628
 629         return ret;
 630 }