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