tools/perf/util/map.c

   1 #include "symbol.h"
   2 #include <errno.h>
   3 #include <inttypes.h>
   4 #include <limits.h>
   5 #include <stdlib.h>
   6 #include <string.h>
   7 #include <stdio.h>
   8 #include <unistd.h>
   9 #include "map.h"
  10 #include "thread.h"
  11 #include "strlist.h"
  12 #include "vdso.h"
  13 #include "build-id.h"
  14 #include "util.h"
  15 #include <linux/string.h>
  16
  17 const char *map_type__name[MAP__NR_TYPES] = {
  18         [MAP__FUNCTION] = "Functions",
  19         [MAP__VARIABLE] = "Variables",
  20 };
  21
  22 static inline int is_anon_memory(const char *filename)
  23 {
  24         return !strcmp(filename, "//anon") ||
  25                !strcmp(filename, "/dev/zero (deleted)") ||
  26                !strcmp(filename, "/anon_hugepage (deleted)");
  27 }
  28
  29 static inline int is_no_dso_memory(const char *filename)
  30 {
  31         return !strncmp(filename, "[stack", 6) ||
  32                !strcmp(filename, "[heap]");
  33 }
  34
  35 void map__init(struct map *map, enum map_type type,
  36                u64 start, u64 end, u64 pgoff, struct dso *dso)
  37 {
  38         map->type     = type;
  39         map->start    = start;
  40         map->end      = end;
  41         map->pgoff    = pgoff;
  42         map->dso      = dso;
  43         map->map_ip   = map__map_ip;
  44         map->unmap_ip = map__unmap_ip;
  45         RB_CLEAR_NODE(&map->rb_node);
  46         map->groups   = NULL;
  47         map->referenced = false;
  48         map->erange_warned = false;
  49 }
  50
  51 struct map *map__new(struct list_head *dsos__list, u64 start, u64 len,
  52                      u64 pgoff, u32 pid, u32 d_maj, u32 d_min, u64 ino,
  53                      u64 ino_gen, char *filename,
  54                      enum map_type type)
  55 {
  56         struct map *map = malloc(sizeof(*map));
  57
  58         if (map != NULL) {
  59                 char newfilename[PATH_MAX];
  60                 struct dso *dso;
  61                 int anon, no_dso, vdso;
  62
  63                 anon = is_anon_memory(filename);
  64                 vdso = is_vdso_map(filename);
  65                 no_dso = is_no_dso_memory(filename);
  66
  67                 map->maj = d_maj;
  68                 map->min = d_min;
  69                 map->ino = ino;
  70                 map->ino_generation = ino_gen;
  71
  72                 if ((anon || no_dso) && type == MAP__FUNCTION) {
  73                         snprintf(newfilename, sizeof(newfilename), "/tmp/perf-%d.map", pid);
  74                         filename = newfilename;
  75                 }
  76
  77                 if (vdso) {
  78                         pgoff = 0;
  79                         dso = vdso__dso_findnew(dsos__list);
  80                 } else
  81                         dso = __dsos__findnew(dsos__list, filename);
  82
  83                 if (dso == NULL)
  84                         goto out_delete;
  85
  86                 map__init(map, type, start, start + len, pgoff, dso);
  87
  88                 if (anon || no_dso) {
  89                         map->map_ip = map->unmap_ip = identity__map_ip;
  90
  91                         /*
  92                          * Set memory without DSO as loaded. All map__find_*
  93                          * functions still return NULL, and we avoid the
  94                          * unnecessary map__load warning.
  95                          */
  96                         if (type != MAP__FUNCTION)
  97                                 dso__set_loaded(dso, map->type);
  98                 }
  99         }
 100         return map;
 101 out_delete:
 102         free(map);
 103         return NULL;
 104 }
 105
 106 /*
 107  * Constructor variant for modules (where we know from /proc/modules where
 108  * they are loaded) and for vmlinux, where only after we load all the
 109  * symbols we'll know where it starts and ends.
 110  */
 111 struct map *map__new2(u64 start, struct dso *dso, enum map_type type)
 112 {
 113         struct map *map = calloc(1, (sizeof(*map) +
 114                                      (dso->kernel ? sizeof(struct kmap) : 0)));
 115         if (map != NULL) {
 116                 /*
 117                  * ->end will be filled after we load all the symbols
 118                  */
 119                 map__init(map, type, start, 0, 0, dso);
 120         }
 121
 122         return map;
 123 }
 124
 125 void map__delete(struct map *map)
 126 {
 127         free(map);
 128 }
 129
 130 void map__fixup_start(struct map *map)
 131 {
 132         struct rb_root *symbols = &map->dso->symbols[map->type];
 133         struct rb_node *nd = rb_first(symbols);
 134         if (nd != NULL) {
 135                 struct symbol *sym = rb_entry(nd, struct symbol, rb_node);
 136                 map->start = sym->start;
 137         }
 138 }
 139
 140 void map__fixup_end(struct map *map)
 141 {
 142         struct rb_root *symbols = &map->dso->symbols[map->type];
 143         struct rb_node *nd = rb_last(symbols);
 144         if (nd != NULL) {
 145                 struct symbol *sym = rb_entry(nd, struct symbol, rb_node);
 146                 map->end = sym->end;
 147         }
 148 }
 149
 150 #define DSO__DELETED "(deleted)"
 151
 152 int map__load(struct map *map, symbol_filter_t filter)
 153 {
 154         const char *name = map->dso->long_name;
 155         int nr;
 156
 157         if (dso__loaded(map->dso, map->type))
 158                 return 0;
 159
 160         nr = dso__load(map->dso, map, filter);
 161         if (nr < 0) {
 162                 if (map->dso->has_build_id) {
 163                         char sbuild_id[BUILD_ID_SIZE * 2 + 1];
 164
 165                         build_id__sprintf(map->dso->build_id,
 166                                           sizeof(map->dso->build_id),
 167                                           sbuild_id);
 168                         pr_warning("%s with build id %s not found",
 169                                    name, sbuild_id);
 170                 } else
 171                         pr_warning("Failed to open %s", name);
 172
 173                 pr_warning(", continuing without symbols\n");
 174                 return -1;
 175         } else if (nr == 0) {
 176 #ifdef HAVE_LIBELF_SUPPORT
 177                 const size_t len = strlen(name);
 178                 const size_t real_len = len - sizeof(DSO__DELETED);
 179
 180                 if (len > sizeof(DSO__DELETED) &&
 181                     strcmp(name + real_len + 1, DSO__DELETED) == 0) {
 182                         pr_warning("%.*s was updated (is prelink enabled?). "
 183                                 "Restart the long running apps that use it!\n",
 184                                    (int)real_len, name);
 185                 } else {
 186                         pr_warning("no symbols found in %s, maybe install "
 187                                    "a debug package?\n", name);
 188                 }
 189 #endif
 190                 return -1;
 191         }
 192
 193         return 0;
 194 }
 195
 196 struct symbol *map__find_symbol(struct map *map, u64 addr,
 197                                 symbol_filter_t filter)
 198 {
 199         if (map__load(map, filter) < 0)
 200                 return NULL;
 201
 202         return dso__find_symbol(map->dso, map->type, addr);
 203 }
 204
 205 struct symbol *map__find_symbol_by_name(struct map *map, const char *name,
 206                                         symbol_filter_t filter)
 207 {
 208         if (map__load(map, filter) < 0)
 209                 return NULL;
 210
 211         if (!dso__sorted_by_name(map->dso, map->type))
 212                 dso__sort_by_name(map->dso, map->type);
 213
 214         return dso__find_symbol_by_name(map->dso, map->type, name);
 215 }
 216
 217 struct map *map__clone(struct map *map)
 218 {
 219         return memdup(map, sizeof(*map));
 220 }
 221
 222 int map__overlap(struct map *l, struct map *r)
 223 {
 224         if (l->start > r->start) {
 225                 struct map *t = l;
 226                 l = r;
 227                 r = t;
 228         }
 229
 230         if (l->end > r->start)
 231                 return 1;
 232
 233         return 0;
 234 }
 235
 236 size_t map__fprintf(struct map *map, FILE *fp)
 237 {
 238         return fprintf(fp, " %" PRIx64 "-%" PRIx64 " %" PRIx64 " %s\n",
 239                        map->start, map->end, map->pgoff, map->dso->name);
 240 }
 241
 242 size_t map__fprintf_dsoname(struct map *map, FILE *fp)
 243 {
 244         const char *dsoname = "[unknown]";
 245
 246         if (map && map->dso && (map->dso->name || map->dso->long_name)) {
 247                 if (symbol_conf.show_kernel_path && map->dso->long_name)
 248                         dsoname = map->dso->long_name;
 249                 else if (map->dso->name)
 250                         dsoname = map->dso->name;
 251         }
 252
 253         return fprintf(fp, "%s", dsoname);
 254 }
 255
 256 int map__fprintf_srcline(struct map *map, u64 addr, const char *prefix,
 257                          FILE *fp)
 258 {
 259         char *srcline;
 260         int ret = 0;
 261
 262         if (map && map->dso) {
 263                 srcline = get_srcline(map->dso,
 264                                       map__rip_2objdump(map, addr));
 265                 if (srcline != SRCLINE_UNKNOWN)
 266                         ret = fprintf(fp, "%s%s", prefix, srcline);
 267                 free_srcline(srcline);
 268         }
 269         return ret;
 270 }
 271
 272 /**
 273  * map__rip_2objdump - convert symbol start address to objdump address.
 274  * @map: memory map
 275  * @rip: symbol start address
 276  *
 277  * objdump wants/reports absolute IPs for ET_EXEC, and RIPs for ET_DYN.
 278  * map->dso->adjust_symbols==1 for ET_EXEC-like cases except ET_REL which is
 279  * relative to section start.
 280  *
 281  * Return: Address suitable for passing to "objdump --start-address="
 282  */
 283 u64 map__rip_2objdump(struct map *map, u64 rip)
 284 {
 285         if (!map->dso->adjust_symbols)
 286                 return rip;
 287
 288         if (map->dso->rel)
 289                 return rip - map->pgoff;
 290
 291         return map->unmap_ip(map, rip);
 292 }
 293
 294 /**
 295  * map__objdump_2mem - convert objdump address to a memory address.
 296  * @map: memory map
 297  * @ip: objdump address
 298  *
 299  * Closely related to map__rip_2objdump(), this function takes an address from
 300  * objdump and converts it to a memory address.  Note this assumes that @map
 301  * contains the address.  To be sure the result is valid, check it forwards
 302  * e.g. map__rip_2objdump(map->map_ip(map, map__objdump_2mem(map, ip))) == ip
 303  *
 304  * Return: Memory address.
 305  */
 306 u64 map__objdump_2mem(struct map *map, u64 ip)
 307 {
 308         if (!map->dso->adjust_symbols)
 309                 return map->unmap_ip(map, ip);
 310
 311         if (map->dso->rel)
 312                 return map->unmap_ip(map, ip + map->pgoff);
 313
 314         return ip;
 315 }
 316
 317 void map_groups__init(struct map_groups *mg)
 318 {
 319         int i;
 320         for (i = 0; i < MAP__NR_TYPES; ++i) {
 321                 mg->maps[i] = RB_ROOT;
 322                 INIT_LIST_HEAD(&mg->removed_maps[i]);
 323         }
 324         mg->machine = NULL;
 325 }
 326
 327 static void maps__delete(struct rb_root *maps)
 328 {
 329         struct rb_node *next = rb_first(maps);
 330
 331         while (next) {
 332                 struct map *pos = rb_entry(next, struct map, rb_node);
 333
 334                 next = rb_next(&pos->rb_node);
 335                 rb_erase(&pos->rb_node, maps);
 336                 map__delete(pos);
 337         }
 338 }
 339
 340 static void maps__delete_removed(struct list_head *maps)
 341 {
 342         struct map *pos, *n;
 343
 344         list_for_each_entry_safe(pos, n, maps, node) {
 345                 list_del(&pos->node);
 346                 map__delete(pos);
 347         }
 348 }
 349
 350 void map_groups__exit(struct map_groups *mg)
 351 {
 352         int i;
 353
 354         for (i = 0; i < MAP__NR_TYPES; ++i) {
 355                 maps__delete(&mg->maps[i]);
 356                 maps__delete_removed(&mg->removed_maps[i]);
 357         }
 358 }
 359
 360 void map_groups__flush(struct map_groups *mg)
 361 {
 362         int type;
 363
 364         for (type = 0; type < MAP__NR_TYPES; type++) {
 365                 struct rb_root *root = &mg->maps[type];
 366                 struct rb_node *next = rb_first(root);
 367
 368                 while (next) {
 369                         struct map *pos = rb_entry(next, struct map, rb_node);
 370                         next = rb_next(&pos->rb_node);
 371                         rb_erase(&pos->rb_node, root);
 372                         /*
 373                          * We may have references to this map, for
 374                          * instance in some hist_entry instances, so
 375                          * just move them to a separate list.
 376                          */
 377                         list_add_tail(&pos->node, &mg->removed_maps[pos->type]);
 378                 }
 379         }
 380 }
 381
 382 struct symbol *map_groups__find_symbol(struct map_groups *mg,
 383                                        enum map_type type, u64 addr,
 384                                        struct map **mapp,
 385                                        symbol_filter_t filter)
 386 {
 387         struct map *map = map_groups__find(mg, type, addr);
 388
 389         /* Ensure map is loaded before using map->map_ip */
 390         if (map != NULL && map__load(map, filter) >= 0) {
 391                 if (mapp != NULL)
 392                         *mapp = map;
 393                 return map__find_symbol(map, map->map_ip(map, addr), filter);
 394         }
 395
 396         return NULL;
 397 }
 398
 399 struct symbol *map_groups__find_symbol_by_name(struct map_groups *mg,
 400                                                enum map_type type,
 401                                                const char *name,
 402                                                struct map **mapp,
 403                                                symbol_filter_t filter)
 404 {
 405         struct rb_node *nd;
 406
 407         for (nd = rb_first(&mg->maps[type]); nd; nd = rb_next(nd)) {
 408                 struct map *pos = rb_entry(nd, struct map, rb_node);
 409                 struct symbol *sym = map__find_symbol_by_name(pos, name, filter);
 410
 411                 if (sym == NULL)
 412                         continue;
 413                 if (mapp != NULL)
 414                         *mapp = pos;
 415                 return sym;
 416         }
 417
 418         return NULL;
 419 }
 420
 421 int map_groups__find_ams(struct addr_map_symbol *ams, symbol_filter_t filter)
 422 {
 423         if (ams->addr < ams->map->start || ams->addr > ams->map->end) {
 424                 if (ams->map->groups == NULL)
 425                         return -1;
 426                 ams->map = map_groups__find(ams->map->groups, ams->map->type,
 427                                             ams->addr);
 428                 if (ams->map == NULL)
 429                         return -1;
 430         }
 431
 432         ams->al_addr = ams->map->map_ip(ams->map, ams->addr);
 433         ams->sym = map__find_symbol(ams->map, ams->al_addr, filter);
 434
 435         return ams->sym ? 0 : -1;
 436 }
 437
 438 size_t __map_groups__fprintf_maps(struct map_groups *mg,
 439                                   enum map_type type, int verbose, FILE *fp)
 440 {
 441         size_t printed = fprintf(fp, "%s:\n", map_type__name[type]);
 442         struct rb_node *nd;
 443
 444         for (nd = rb_first(&mg->maps[type]); nd; nd = rb_next(nd)) {
 445                 struct map *pos = rb_entry(nd, struct map, rb_node);
 446                 printed += fprintf(fp, "Map:");
 447                 printed += map__fprintf(pos, fp);
 448                 if (verbose > 2) {
 449                         printed += dso__fprintf(pos->dso, type, fp);
 450                         printed += fprintf(fp, "--\n");
 451                 }
 452         }
 453
 454         return printed;
 455 }
 456
 457 size_t map_groups__fprintf_maps(struct map_groups *mg, int verbose, FILE *fp)
 458 {
 459         size_t printed = 0, i;
 460         for (i = 0; i < MAP__NR_TYPES; ++i)
 461                 printed += __map_groups__fprintf_maps(mg, i, verbose, fp);
 462         return printed;
 463 }
 464
 465 static size_t __map_groups__fprintf_removed_maps(struct map_groups *mg,
 466                                                  enum map_type type,
 467                                                  int verbose, FILE *fp)
 468 {
 469         struct map *pos;
 470         size_t printed = 0;
 471
 472         list_for_each_entry(pos, &mg->removed_maps[type], node) {
 473                 printed += fprintf(fp, "Map:");
 474                 printed += map__fprintf(pos, fp);
 475                 if (verbose > 1) {
 476                         printed += dso__fprintf(pos->dso, type, fp);
 477                         printed += fprintf(fp, "--\n");
 478                 }
 479         }
 480         return printed;
 481 }
 482
 483 static size_t map_groups__fprintf_removed_maps(struct map_groups *mg,
 484                                                int verbose, FILE *fp)
 485 {
 486         size_t printed = 0, i;
 487         for (i = 0; i < MAP__NR_TYPES; ++i)
 488                 printed += __map_groups__fprintf_removed_maps(mg, i, verbose, fp);
 489         return printed;
 490 }
 491
 492 size_t map_groups__fprintf(struct map_groups *mg, int verbose, FILE *fp)
 493 {
 494         size_t printed = map_groups__fprintf_maps(mg, verbose, fp);
 495         printed += fprintf(fp, "Removed maps:\n");
 496         return printed + map_groups__fprintf_removed_maps(mg, verbose, fp);
 497 }
 498
 499 int map_groups__fixup_overlappings(struct map_groups *mg, struct map *map,
 500                                    int verbose, FILE *fp)
 501 {
 502         struct rb_root *root = &mg->maps[map->type];
 503         struct rb_node *next = rb_first(root);
 504         int err = 0;
 505
 506         while (next) {
 507                 struct map *pos = rb_entry(next, struct map, rb_node);
 508                 next = rb_next(&pos->rb_node);
 509
 510                 if (!map__overlap(pos, map))
 511                         continue;
 512
 513                 if (verbose >= 2) {
 514                         fputs("overlapping maps:\n", fp);
 515                         map__fprintf(map, fp);
 516                         map__fprintf(pos, fp);
 517                 }
 518
 519                 rb_erase(&pos->rb_node, root);
 520                 /*
 521                  * Now check if we need to create new maps for areas not
 522                  * overlapped by the new map:
 523                  */
 524                 if (map->start > pos->start) {
 525                         struct map *before = map__clone(pos);
 526
 527                         if (before == NULL) {
 528                                 err = -ENOMEM;
 529                                 goto move_map;
 530                         }
 531
 532                         before->end = map->start - 1;
 533                         map_groups__insert(mg, before);
 534                         if (verbose >= 2)
 535                                 map__fprintf(before, fp);
 536                 }
 537
 538                 if (map->end < pos->end) {
 539                         struct map *after = map__clone(pos);
 540
 541                         if (after == NULL) {
 542                                 err = -ENOMEM;
 543                                 goto move_map;
 544                         }
 545
 546                         after->start = map->end + 1;
 547                         map_groups__insert(mg, after);
 548                         if (verbose >= 2)
 549                                 map__fprintf(after, fp);
 550                 }
 551 move_map:
 552                 /*
 553                  * If we have references, just move them to a separate list.
 554                  */
 555                 if (pos->referenced)
 556                         list_add_tail(&pos->node, &mg->removed_maps[map->type]);
 557                 else
 558                         map__delete(pos);
 559
 560                 if (err)
 561                         return err;
 562         }
 563
 564         return 0;
 565 }
 566
 567 /*
 568  * XXX This should not really _copy_ te maps, but refcount them.
 569  */
 570 int map_groups__clone(struct map_groups *mg,
 571                       struct map_groups *parent, enum map_type type)
 572 {
 573         struct rb_node *nd;
 574         for (nd = rb_first(&parent->maps[type]); nd; nd = rb_next(nd)) {
 575                 struct map *map = rb_entry(nd, struct map, rb_node);
 576                 struct map *new = map__clone(map);
 577                 if (new == NULL)
 578                         return -ENOMEM;
 579                 map_groups__insert(mg, new);
 580         }
 581         return 0;
 582 }
 583
 584 void maps__insert(struct rb_root *maps, struct map *map)
 585 {
 586         struct rb_node **p = &maps->rb_node;
 587         struct rb_node *parent = NULL;
 588         const u64 ip = map->start;
 589         struct map *m;
 590
 591         while (*p != NULL) {
 592                 parent = *p;
 593                 m = rb_entry(parent, struct map, rb_node);
 594                 if (ip < m->start)
 595                         p = &(*p)->rb_left;
 596                 else
 597                         p = &(*p)->rb_right;
 598         }
 599
 600         rb_link_node(&map->rb_node, parent, p);
 601         rb_insert_color(&map->rb_node, maps);
 602 }
 603
 604 void maps__remove(struct rb_root *maps, struct map *map)
 605 {
 606         rb_erase(&map->rb_node, maps);
 607 }
 608
 609 struct map *maps__find(struct rb_root *maps, u64 ip)
 610 {
 611         struct rb_node **p = &maps->rb_node;
 612         struct rb_node *parent = NULL;
 613         struct map *m;
 614
 615         while (*p != NULL) {
 616                 parent = *p;
 617                 m = rb_entry(parent, struct map, rb_node);
 618                 if (ip < m->start)
 619                         p = &(*p)->rb_left;
 620                 else if (ip > m->end)
 621                         p = &(*p)->rb_right;
 622                 else
 623                         return m;
 624         }
 625
 626         return NULL;
 627 }
 628
 629 struct map *maps__first(struct rb_root *maps)
 630 {
 631         struct rb_node *first = rb_first(maps);
 632
 633         if (first)
 634                 return rb_entry(first, struct map, rb_node);
 635         return NULL;
 636 }
 637
 638 struct map *maps__next(struct map *map)
 639 {
 640         struct rb_node *next = rb_next(&map->rb_node);
 641
 642         if (next)
 643                 return rb_entry(next, struct map, rb_node);
 644         return NULL;
 645 }