tools/perf/util/build-id.c

   1 /*
   2  * build-id.c
   3  *
   4  * build-id support
   5  *
   6  * Copyright (C) 2009, 2010 Red Hat Inc.
   7  * Copyright (C) 2009, 2010 Arnaldo Carvalho de Melo <acme@redhat.com>
   8  */
   9 #include "util.h"
  10 #include <stdio.h>
  11 #include "build-id.h"
  12 #include "event.h"
  13 #include "symbol.h"
  14 #include <linux/kernel.h>
  15 #include "debug.h"
  16 #include "session.h"
  17 #include "tool.h"
  18 #include "header.h"
  19 #include "vdso.h"
  20
  21
  22 static bool no_buildid_cache;
  23
  24 int build_id__mark_dso_hit(struct perf_tool *tool __maybe_unused,
  25                            union perf_event *event,
  26                            struct perf_sample *sample,
  27                            struct perf_evsel *evsel __maybe_unused,
  28                            struct machine *machine)
  29 {
  30         struct addr_location al;
  31         u8 cpumode = event->header.misc & PERF_RECORD_MISC_CPUMODE_MASK;
  32         struct thread *thread = machine__findnew_thread(machine, sample->pid,
  33                                                         sample->tid);
  34
  35         if (thread == NULL) {
  36                 pr_err("problem processing %d event, skipping it.\n",
  37                         event->header.type);
  38                 return -1;
  39         }
  40
  41         thread__find_addr_map(thread, cpumode, MAP__FUNCTION, sample->ip, &al);
  42
  43         if (al.map != NULL)
  44                 al.map->dso->hit = 1;
  45
  46         thread__put(thread);
  47         return 0;
  48 }
  49
  50 static int perf_event__exit_del_thread(struct perf_tool *tool __maybe_unused,
  51                                        union perf_event *event,
  52                                        struct perf_sample *sample
  53                                        __maybe_unused,
  54                                        struct machine *machine)
  55 {
  56         struct thread *thread = machine__findnew_thread(machine,
  57                                                         event->fork.pid,
  58                                                         event->fork.tid);
  59
  60         dump_printf("(%d:%d):(%d:%d)\n", event->fork.pid, event->fork.tid,
  61                     event->fork.ppid, event->fork.ptid);
  62
  63         if (thread) {
  64                 machine__remove_thread(machine, thread);
  65                 thread__put(thread);
  66         }
  67
  68         return 0;
  69 }
  70
  71 struct perf_tool build_id__mark_dso_hit_ops = {
  72         .sample = build_id__mark_dso_hit,
  73         .mmap   = perf_event__process_mmap,
  74         .mmap2  = perf_event__process_mmap2,
  75         .fork   = perf_event__process_fork,
  76         .exit   = perf_event__exit_del_thread,
  77         .attr            = perf_event__process_attr,
  78         .build_id        = perf_event__process_build_id,
  79         .ordered_events  = true,
  80 };
  81
  82 int build_id__sprintf(const u8 *build_id, int len, char *bf)
  83 {
  84         char *bid = bf;
  85         const u8 *raw = build_id;
  86         int i;
  87
  88         for (i = 0; i < len; ++i) {
  89                 sprintf(bid, "%02x", *raw);
  90                 ++raw;
  91                 bid += 2;
  92         }
  93
  94         return (bid - bf) + 1;
  95 }
  96
  97 int sysfs__sprintf_build_id(const char *root_dir, char *sbuild_id)
  98 {
  99         char notes[PATH_MAX];
 100         u8 build_id[BUILD_ID_SIZE];
 101         int ret;
 102
 103         if (!root_dir)
 104                 root_dir = "";
 105
 106         scnprintf(notes, sizeof(notes), "%s/sys/kernel/notes", root_dir);
 107
 108         ret = sysfs__read_build_id(notes, build_id, sizeof(build_id));
 109         if (ret < 0)
 110                 return ret;
 111
 112         return build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
 113 }
 114
 115 int filename__sprintf_build_id(const char *pathname, char *sbuild_id)
 116 {
 117         u8 build_id[BUILD_ID_SIZE];
 118         int ret;
 119
 120         ret = filename__read_build_id(pathname, build_id, sizeof(build_id));
 121         if (ret < 0)
 122                 return ret;
 123         else if (ret != sizeof(build_id))
 124                 return -EINVAL;
 125
 126         return build_id__sprintf(build_id, sizeof(build_id), sbuild_id);
 127 }
 128
 129 /* asnprintf consolidates asprintf and snprintf */
 130 static int asnprintf(char **strp, size_t size, const char *fmt, ...)
 131 {
 132         va_list ap;
 133         int ret;
 134
 135         if (!strp)
 136                 return -EINVAL;
 137
 138         va_start(ap, fmt);
 139         if (*strp)
 140                 ret = vsnprintf(*strp, size, fmt, ap);
 141         else
 142                 ret = vasprintf(strp, fmt, ap);
 143         va_end(ap);
 144
 145         return ret;
 146 }
 147
 148 static char *build_id__filename(const char *sbuild_id, char *bf, size_t size)
 149 {
 150         char *tmp = bf;
 151         int ret = asnprintf(&bf, size, "%s/.build-id/%.2s/%s", buildid_dir,
 152                             sbuild_id, sbuild_id + 2);
 153         if (ret < 0 || (tmp && size < (unsigned int)ret))
 154                 return NULL;
 155         return bf;
 156 }
 157
 158 char *dso__build_id_filename(const struct dso *dso, char *bf, size_t size)
 159 {
 160         char build_id_hex[SBUILD_ID_SIZE];
 161
 162         if (!dso->has_build_id)
 163                 return NULL;
 164
 165         build_id__sprintf(dso->build_id, sizeof(dso->build_id), build_id_hex);
 166         return build_id__filename(build_id_hex, bf, size);
 167 }
 168
 169 #define dsos__for_each_with_build_id(pos, head) \
 170         list_for_each_entry(pos, head, node)    \
 171                 if (!pos->has_build_id)         \
 172                         continue;               \
 173                 else
 174
 175 static int write_buildid(const char *name, size_t name_len, u8 *build_id,
 176                          pid_t pid, u16 misc, int fd)
 177 {
 178         int err;
 179         struct build_id_event b;
 180         size_t len;
 181
 182         len = name_len + 1;
 183         len = PERF_ALIGN(len, NAME_ALIGN);
 184
 185         memset(&b, 0, sizeof(b));
 186         memcpy(&b.build_id, build_id, BUILD_ID_SIZE);
 187         b.pid = pid;
 188         b.header.misc = misc;
 189         b.header.size = sizeof(b) + len;
 190
 191         err = writen(fd, &b, sizeof(b));
 192         if (err < 0)
 193                 return err;
 194
 195         return write_padded(fd, name, name_len + 1, len);
 196 }
 197
 198 static int machine__write_buildid_table(struct machine *machine, int fd)
 199 {
 200         int err = 0;
 201         char nm[PATH_MAX];
 202         struct dso *pos;
 203         u16 kmisc = PERF_RECORD_MISC_KERNEL,
 204             umisc = PERF_RECORD_MISC_USER;
 205
 206         if (!machine__is_host(machine)) {
 207                 kmisc = PERF_RECORD_MISC_GUEST_KERNEL;
 208                 umisc = PERF_RECORD_MISC_GUEST_USER;
 209         }
 210
 211         dsos__for_each_with_build_id(pos, &machine->dsos.head) {
 212                 const char *name;
 213                 size_t name_len;
 214                 bool in_kernel = false;
 215
 216                 if (!pos->hit)
 217                         continue;
 218
 219                 if (dso__is_vdso(pos)) {
 220                         name = pos->short_name;
 221                         name_len = pos->short_name_len + 1;
 222                 } else if (dso__is_kcore(pos)) {
 223                         machine__mmap_name(machine, nm, sizeof(nm));
 224                         name = nm;
 225                         name_len = strlen(nm) + 1;
 226                 } else {
 227                         name = pos->long_name;
 228                         name_len = pos->long_name_len + 1;
 229                 }
 230
 231                 in_kernel = pos->kernel ||
 232                                 is_kernel_module(name,
 233                                         PERF_RECORD_MISC_CPUMODE_UNKNOWN);
 234                 err = write_buildid(name, name_len, pos->build_id, machine->pid,
 235                                     in_kernel ? kmisc : umisc, fd);
 236                 if (err)
 237                         break;
 238         }
 239
 240         return err;
 241 }
 242
 243 int perf_session__write_buildid_table(struct perf_session *session, int fd)
 244 {
 245         struct rb_node *nd;
 246         int err = machine__write_buildid_table(&session->machines.host, fd);
 247
 248         if (err)
 249                 return err;
 250
 251         for (nd = rb_first(&session->machines.guests); nd; nd = rb_next(nd)) {
 252                 struct machine *pos = rb_entry(nd, struct machine, rb_node);
 253                 err = machine__write_buildid_table(pos, fd);
 254                 if (err)
 255                         break;
 256         }
 257         return err;
 258 }
 259
 260 static int __dsos__hit_all(struct list_head *head)
 261 {
 262         struct dso *pos;
 263
 264         list_for_each_entry(pos, head, node)
 265                 pos->hit = true;
 266
 267         return 0;
 268 }
 269
 270 static int machine__hit_all_dsos(struct machine *machine)
 271 {
 272         return __dsos__hit_all(&machine->dsos.head);
 273 }
 274
 275 int dsos__hit_all(struct perf_session *session)
 276 {
 277         struct rb_node *nd;
 278         int err;
 279
 280         err = machine__hit_all_dsos(&session->machines.host);
 281         if (err)
 282                 return err;
 283
 284         for (nd = rb_first(&session->machines.guests); nd; nd = rb_next(nd)) {
 285                 struct machine *pos = rb_entry(nd, struct machine, rb_node);
 286
 287                 err = machine__hit_all_dsos(pos);
 288                 if (err)
 289                         return err;
 290         }
 291
 292         return 0;
 293 }
 294
 295 void disable_buildid_cache(void)
 296 {
 297         no_buildid_cache = true;
 298 }
 299
 300 static char *build_id_cache__dirname_from_path(const char *name,
 301                                                bool is_kallsyms, bool is_vdso)
 302 {
 303         char *realname = (char *)name, *filename;
 304         bool slash = is_kallsyms || is_vdso;
 305
 306         if (!slash) {
 307                 realname = realpath(name, NULL);
 308                 if (!realname)
 309                         return NULL;
 310         }
 311
 312         if (asprintf(&filename, "%s%s%s", buildid_dir, slash ? "/" : "",
 313                      is_vdso ? DSO__NAME_VDSO : realname) < 0)
 314                 filename = NULL;
 315
 316         if (!slash)
 317                 free(realname);
 318
 319         return filename;
 320 }
 321
 322 int build_id_cache__list_build_ids(const char *pathname,
 323                                    struct strlist **result)
 324 {
 325         struct strlist *list;
 326         char *dir_name;
 327         DIR *dir;
 328         struct dirent *d;
 329         int ret = 0;
 330
 331         list = strlist__new(NULL, NULL);
 332         dir_name = build_id_cache__dirname_from_path(pathname, false, false);
 333         if (!list || !dir_name) {
 334                 ret = -ENOMEM;
 335                 goto out;
 336         }
 337
 338         /* List up all dirents */
 339         dir = opendir(dir_name);
 340         if (!dir) {
 341                 ret = -errno;
 342                 goto out;
 343         }
 344
 345         while ((d = readdir(dir)) != NULL) {
 346                 if (!strcmp(d->d_name, ".") || !strcmp(d->d_name, ".."))
 347                         continue;
 348                 strlist__add(list, d->d_name);
 349         }
 350         closedir(dir);
 351
 352 out:
 353         free(dir_name);
 354         if (ret)
 355                 strlist__delete(list);
 356         else
 357                 *result = list;
 358
 359         return ret;
 360 }
 361
 362 int build_id_cache__add_s(const char *sbuild_id, const char *name,
 363                           bool is_kallsyms, bool is_vdso)
 364 {
 365         const size_t size = PATH_MAX;
 366         char *realname = NULL, *filename = NULL, *dir_name = NULL,
 367              *linkname = zalloc(size), *targetname, *tmp;
 368         int err = -1;
 369
 370         if (!is_kallsyms) {
 371                 realname = realpath(name, NULL);
 372                 if (!realname)
 373                         goto out_free;
 374         }
 375
 376         dir_name = build_id_cache__dirname_from_path(name, is_kallsyms, is_vdso);
 377         if (!dir_name)
 378                 goto out_free;
 379
 380         if (mkdir_p(dir_name, 0755))
 381                 goto out_free;
 382
 383         if (asprintf(&filename, "%s/%s", dir_name, sbuild_id) < 0) {
 384                 filename = NULL;
 385                 goto out_free;
 386         }
 387
 388         if (access(filename, F_OK)) {
 389                 if (is_kallsyms) {
 390                          if (copyfile("/proc/kallsyms", filename))
 391                                 goto out_free;
 392                 } else if (link(realname, filename) && errno != EEXIST &&
 393                                 copyfile(name, filename))
 394                         goto out_free;
 395         }
 396
 397         if (!build_id__filename(sbuild_id, linkname, size))
 398                 goto out_free;
 399         tmp = strrchr(linkname, '/');
 400         *tmp = '\0';
 401
 402         if (access(linkname, X_OK) && mkdir_p(linkname, 0755))
 403                 goto out_free;
 404
 405         *tmp = '/';
 406         targetname = filename + strlen(buildid_dir) - 5;
 407         memcpy(targetname, "../..", 5);
 408
 409         if (symlink(targetname, linkname) == 0)
 410                 err = 0;
 411 out_free:
 412         if (!is_kallsyms)
 413                 free(realname);
 414         free(filename);
 415         free(dir_name);
 416         free(linkname);
 417         return err;
 418 }
 419
 420 static int build_id_cache__add_b(const u8 *build_id, size_t build_id_size,
 421                                  const char *name, bool is_kallsyms,
 422                                  bool is_vdso)
 423 {
 424         char sbuild_id[SBUILD_ID_SIZE];
 425
 426         build_id__sprintf(build_id, build_id_size, sbuild_id);
 427
 428         return build_id_cache__add_s(sbuild_id, name, is_kallsyms, is_vdso);
 429 }
 430
 431 bool build_id_cache__cached(const char *sbuild_id)
 432 {
 433         bool ret = false;
 434         char *filename = build_id__filename(sbuild_id, NULL, 0);
 435
 436         if (filename && !access(filename, F_OK))
 437                 ret = true;
 438         free(filename);
 439
 440         return ret;
 441 }
 442
 443 int build_id_cache__remove_s(const char *sbuild_id)
 444 {
 445         const size_t size = PATH_MAX;
 446         char *filename = zalloc(size),
 447              *linkname = zalloc(size), *tmp;
 448         int err = -1;
 449
 450         if (filename == NULL || linkname == NULL)
 451                 goto out_free;
 452
 453         if (!build_id__filename(sbuild_id, linkname, size))
 454                 goto out_free;
 455
 456         if (access(linkname, F_OK))
 457                 goto out_free;
 458
 459         if (readlink(linkname, filename, size - 1) < 0)
 460                 goto out_free;
 461
 462         if (unlink(linkname))
 463                 goto out_free;
 464
 465         /*
 466          * Since the link is relative, we must make it absolute:
 467          */
 468         tmp = strrchr(linkname, '/') + 1;
 469         snprintf(tmp, size - (tmp - linkname), "%s", filename);
 470
 471         if (unlink(linkname))
 472                 goto out_free;
 473
 474         err = 0;
 475 out_free:
 476         free(filename);
 477         free(linkname);
 478         return err;
 479 }
 480
 481 static int dso__cache_build_id(struct dso *dso, struct machine *machine)
 482 {
 483         bool is_kallsyms = dso->kernel && dso->long_name[0] != '/';
 484         bool is_vdso = dso__is_vdso(dso);
 485         const char *name = dso->long_name;
 486         char nm[PATH_MAX];
 487
 488         if (dso__is_kcore(dso)) {
 489                 is_kallsyms = true;
 490                 machine__mmap_name(machine, nm, sizeof(nm));
 491                 name = nm;
 492         }
 493         return build_id_cache__add_b(dso->build_id, sizeof(dso->build_id), name,
 494                                      is_kallsyms, is_vdso);
 495 }
 496
 497 static int __dsos__cache_build_ids(struct list_head *head,
 498                                    struct machine *machine)
 499 {
 500         struct dso *pos;
 501         int err = 0;
 502
 503         dsos__for_each_with_build_id(pos, head)
 504                 if (dso__cache_build_id(pos, machine))
 505                         err = -1;
 506
 507         return err;
 508 }
 509
 510 static int machine__cache_build_ids(struct machine *machine)
 511 {
 512         return __dsos__cache_build_ids(&machine->dsos.head, machine);
 513 }
 514
 515 int perf_session__cache_build_ids(struct perf_session *session)
 516 {
 517         struct rb_node *nd;
 518         int ret;
 519
 520         if (no_buildid_cache)
 521                 return 0;
 522
 523         if (mkdir(buildid_dir, 0755) != 0 && errno != EEXIST)
 524                 return -1;
 525
 526         ret = machine__cache_build_ids(&session->machines.host);
 527
 528         for (nd = rb_first(&session->machines.guests); nd; nd = rb_next(nd)) {
 529                 struct machine *pos = rb_entry(nd, struct machine, rb_node);
 530                 ret |= machine__cache_build_ids(pos);
 531         }
 532         return ret ? -1 : 0;
 533 }
 534
 535 static bool machine__read_build_ids(struct machine *machine, bool with_hits)
 536 {
 537         return __dsos__read_build_ids(&machine->dsos.head, with_hits);
 538 }
 539
 540 bool perf_session__read_build_ids(struct perf_session *session, bool with_hits)
 541 {
 542         struct rb_node *nd;
 543         bool ret = machine__read_build_ids(&session->machines.host, with_hits);
 544
 545         for (nd = rb_first(&session->machines.guests); nd; nd = rb_next(nd)) {
 546                 struct machine *pos = rb_entry(nd, struct machine, rb_node);
 547                 ret |= machine__read_build_ids(pos, with_hits);
 548         }
 549
 550         return ret;
 551 }