mesa/src/util/build_id.c

/*
 * Copyright © 2016 Intel Corporation
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#include "build_id.h"

#if HAVE_BUILD_ID
#include <dlfcn.h>
#include <stddef.h>
#include <string.h>

#include "macros.h"

#if  DETECT_OS_APPLE
#include <mach-o/loader.h>

struct build_id_note {
   const struct uuid_command uuid_cmd;
};
#else
#include <link.h>
#ifndef NT_GNU_BUILD_ID
#define NT_GNU_BUILD_ID 3
#endif

#ifndef ElfW
#define ElfW(type) Elf_##type
#endif

struct build_id_note {
   ElfW(Nhdr) nhdr;

   char name[4]; /* Note name for build-id is "GNU\0" */
   uint8_t build_id[0];
};
#endif /*  DETECT_OS_APPLE */

struct callback_data {
   /* Base address of shared object, taken from Dl_info::dli_fbase */
   const void *dli_fbase;

   struct build_id_note *note;
};

#if DETECT_OS_APPLE
static int
build_id_find_uuid_command(void *data_)
{
   struct callback_data *data = data_;
   const struct mach_header *header =
      (const struct mach_header *)data->dli_fbase;
   const struct load_command *cmd = NULL;

   /* Headers' sizes differ based on architecture */
   if (header->magic == MH_MAGIC_64 || header->magic == MH_CIGAM_64) {
      cmd =
         (const struct load_command *)((const struct mach_header_64 *)header +
                                       1);
   } else if (header->magic == MH_MAGIC || header->magic == MH_CIGAM) {
      cmd = (const struct load_command *)(header + 1);
   } else {
      return 0;
   }

   uint32_t ncmds = header->ncmds;
   for (uint32_t i = 0; i < ncmds; i++) {
      if (cmd->cmd == LC_UUID) {
         data->note = (struct build_id_note *)cmd;
         return 1;
      }
      cmd = (const struct load_command *)((const char *)cmd + cmd->cmdsize);
   }

   return 0;
}
#else
static int
build_id_find_nhdr_callback(struct dl_phdr_info *info, size_t size, void *data_)
{
   struct callback_data *data = data_;

   /* Calculate address where shared object is mapped into the process space.
    * (Using the base address and the virtual address of the first LOAD segment)
    */
   void *map_start = NULL;
   for (unsigned i = 0; i < info->dlpi_phnum; i++) {
      if (info->dlpi_phdr[i].p_type == PT_LOAD) {
         map_start = (void *)(info->dlpi_addr + info->dlpi_phdr[i].p_vaddr);
         break;
      }
   }

   if (map_start != data->dli_fbase)
      return 0;

   for (unsigned i = 0; i < info->dlpi_phnum; i++) {
      if (info->dlpi_phdr[i].p_type != PT_NOTE)
         continue;

      struct build_id_note *note = (void *)(info->dlpi_addr +
                                            info->dlpi_phdr[i].p_vaddr);
      ptrdiff_t len = info->dlpi_phdr[i].p_filesz;

      while (len >= sizeof(struct build_id_note)) {
         if (note->nhdr.n_type == NT_GNU_BUILD_ID &&
            note->nhdr.n_descsz != 0 &&
            note->nhdr.n_namesz == 4 &&
            memcmp(note->name, "GNU", 4) == 0) {
            data->note = note;
            return 1;
         }

         size_t offset = sizeof(ElfW(Nhdr)) +
                         ALIGN_POT(note->nhdr.n_namesz, 4) +
                         ALIGN_POT(note->nhdr.n_descsz, 4);
         note = (struct build_id_note *)((char *)note + offset);
         len -= offset;
      }
   }

   return 0;
}
#endif /* DETECT_OS_APPLE */

const struct build_id_note *
build_id_find_nhdr_for_addr(const void *addr)
{
   Dl_info info;

   if (!dladdr(addr, &info))
      return NULL;

   if (!info.dli_fbase)
      return NULL;

   struct callback_data data = {
      .dli_fbase = info.dli_fbase,
      .note = NULL,
   };

#if DETECT_OS_APPLE
   if (!build_id_find_uuid_command(&data))
      return NULL;
#else
   if (!dl_iterate_phdr(build_id_find_nhdr_callback, &data))
      return NULL;
#endif /* DETECT_OS_APPLE */

   return data.note;
}

unsigned
build_id_length(const struct build_id_note *note)
{
#if DETECT_OS_APPLE
   return sizeof(note->uuid_cmd.uuid);
#else
   return note->nhdr.n_descsz;
#endif /* DETECT_OS_APPLE */
}

const uint8_t *
build_id_data(const struct build_id_note *note)
{
#if DETECT_OS_APPLE
   return note->uuid_cmd.uuid;
#else
   return note->build_id;
#endif /* DETECT_OS_APPLE */
}

void
copy_build_id_to_sha1(uint8_t sha1[SHA1_DIGEST_LENGTH],
                      const struct build_id_note *note)
{
   unsigned length = build_id_length(note);

   assert(length <= SHA1_DIGEST_LENGTH);
   memcpy(sha1, build_id_data(note), length);
   memset(sha1 + length, 0, SHA1_DIGEST_LENGTH - length);
}

#endif