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