Android: Add chrome-specific dynamic linker.

third_party/crazy_linker/crazy_linker/src/crazy_linker_rdebug.cpp

Index: third_party/crazy_linker/crazy_linker/src/crazy_linker_rdebug.cpp
diff --git a/third_party/crazy_linker/crazy_linker/src/crazy_linker_rdebug.cpp b/third_party/crazy_linker/crazy_linker/src/crazy_linker_rdebug.cpp
new file mode 100644
index 0000000000000000000000000000000000000000..432ed1963a575920bd2223e8b90fd86513fb610e
--- /dev/null
+++ b/third_party/crazy_linker/crazy_linker/src/crazy_linker_rdebug.cpp
@@ -0,0 +1,377 @@
+// Copyright (c) 2013 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#include "crazy_linker_rdebug.h"
+
+#include <elf.h>
+#include <inttypes.h>
+#include <sys/mman.h>
+#include <unistd.h>
+
+#include "crazy_linker_debug.h"
+#include "crazy_linker_proc_maps.h"
+#include "crazy_linker_util.h"
+#include "crazy_linker_system.h"
+#include "elf_traits.h"
+
+namespace crazy {
+
+namespace {
+
+// Find the full path of the current executable. On success return true
+// and sets |exe_path|. On failure, return false and sets errno.
+bool FindExecutablePath(String* exe_path) {
+  // /proc/self/exe is a symlink to the full path. Read it with
+  // readlink().
+  exe_path->Resize(512);
+  ssize_t ret = TEMP_FAILURE_RETRY(
+      readlink("/proc/self/exe", &(*exe_path)[0], exe_path->size()));

[bulach, 2013/09/09 16:14:15]

can we get a non-const c_str out of exe_path? :) it'd be slightly more
readable..

[digit1, 2013/09/10 09:23:30]

Good idea, done.

+  if (ret < 0) {
+    LOG_ERRNO("%s: Could not get /proc/self/exe link", __FUNCTION__);
+    return false;
+  }
+
+  exe_path->Resize(static_cast<size_t>(ret));
+  LOG("%s: Current executable: %s\n", __FUNCTION__, exe_path->c_str());
+  return true;
+}
+
+// Given an ELF binary at |path| that is _already_ mapped in the process,
+// find the address of its dynamic section and its size.
+// |path| is the full path of the binary (as it appears in /proc/self/maps.
+// |self_maps| is an instance of ProcMaps that is used to inspect
+// /proc/self/maps. The function rewind + iterates over it.
+// On success, return true and set |*dynamic_offset| and |*dynamic_size|.
+bool FindElfDynamicSection(const char* path,
+                           ProcMaps* self_maps,
+                           size_t* dynamic_address,
+                           size_t* dynamic_size) {
+  // Read the ELF header first.
+  ELF::Ehdr header[1];
+
+  crazy::FileDescriptor fd;
+  if (!fd.OpenReadOnly(path) ||
+      fd.Read(header, sizeof(header)) != static_cast<int>(sizeof(header))) {
+    LOG_ERRNO("%s: Could not load ELF binary header", __FUNCTION__);
+    return false;
+  }
+
+  // Sanity check.
+  if (header->e_ident[0] != 127 || header->e_ident[1] != 'E' ||
+      header->e_ident[2] != 'L' || header->e_ident[3] != 'F' ||
+      header->e_ident[4] != 1) {
+    LOG("%s: Not a 32-bit ELF binary: %s\n", __FUNCTION__, path);
+    return false;
+  }
+
+  if (header->e_phoff == 0 || header->e_phentsize != sizeof(ELF::Phdr)) {
+    LOG("%s: Invalid program header values: %s\n", __FUNCTION__, path);
+    return false;
+  }
+
+  // Scan the program header table.
+  if (fd.SeekTo(header->e_phoff) < 0) {
+    LOG_ERRNO("%s: Could not find ELF program header table", __FUNCTION__);
+    return false;
+  }
+
+  ELF::Phdr phdr_load0 = { 0, };
+  ELF::Phdr phdr_dyn = { 0, };
+  bool found_load0 = false;
+  bool found_dyn = false;
+
+  for (size_t n = 0; n < header->e_phnum; ++n) {
+    ELF::Phdr phdr;
+    if (fd.Read(&phdr, sizeof(phdr)) != sizeof(phdr)) {
+      LOG_ERRNO("%s: Could not read program header entry", __FUNCTION__);
+      return false;
+    }
+
+    if (phdr.p_type == PT_LOAD && !found_load0) {
+      phdr_load0 = phdr;
+      found_load0 = true;
+    } else if (phdr.p_type == PT_DYNAMIC && !found_dyn) {
+      phdr_dyn = phdr;
+      found_dyn = true;
+    }
+  }
+
+  if (!found_load0) {
+    LOG("%s: Could not find loadable segment!?", __FUNCTION__);
+    return false;
+  }
+  if (!found_dyn) {
+    LOG("%s: Could not find dynamic segment!?", __FUNCTION__);
+    return false;
+  }
+
+  LOG("%s: Found first loadable segment [offset=%p vaddr=%p]\n",
+      __FUNCTION__,
+      (void*)phdr_load0.p_offset,
+      (void*)phdr_load0.p_vaddr);
+
+  LOG("%s: Found dynamic segment [offset=%p vaddr=%p size=%p]\n",
+      __FUNCTION__,
+      (void*)phdr_dyn.p_offset,
+      (void*)phdr_dyn.p_vaddr,
+      (void*)phdr_dyn.p_memsz);
+
+  // Parse /proc/self/maps to find the load address of the first
+  // loadable segment.
+  size_t path_len = strlen(path);
+  self_maps->Rewind();
+  ProcMaps::Entry entry;
+  while (self_maps->GetNextEntry(&entry)) {
+    if (!entry.path || entry.path_len != path_len ||
+        memcmp(entry.path, path, path_len) != 0)
+      continue;
+
+    LOG("%s: Found executable segment mapped [%p-%p offset=%p]\n",
+        __FUNCTION__,
+        (void*) entry.vma_start,
+        (void*) entry.vma_end,
+        (void*) entry.load_offset);
+
+    size_t load_bias = entry.vma_start - phdr_load0.p_vaddr;
+    LOG("%s: Load bias is %p\n", __FUNCTION__, (void*) load_bias);
+
+    *dynamic_address = load_bias + phdr_dyn.p_vaddr;
+    *dynamic_size = phdr_dyn.p_memsz;
+    LOG("%s: Dynamic section addr=%p size=%p\n",
+        __FUNCTION__, (void*)*dynamic_address, (void*)*dynamic_size);
+    return true;
+  }
+
+  LOG("%s: Executable is not mapped in current process.\n",
+      __FUNCTION__);
+  return false;
+}
+
+// Helper class to temporarily remap a page to readable+writable until
+// scope exit.
+class ScopedPageMapper {
+public:

[bulach, 2013/09/09 16:14:15]

nit: space

[digit1, 2013/09/10 09:23:30]

Done, as well as in all other sources.

+  ScopedPageMapper() : page_address_(0), page_prot_(0) {}
+  void MapReadWrite(void* address);
+  ~ScopedPageMapper();
+private:
+  static const uintptr_t kPageSize = 4096;
+  uintptr_t page_address_;
+  int page_prot_;
+};
+
+void ScopedPageMapper::MapReadWrite(void* address) {
+  page_address_ = reinterpret_cast<uintptr_t>(address) & ~(kPageSize - 1);
+  page_prot_ = 0;
+  if (!FindProtectionFlagsForAddress(address, &page_prot_) ||
+      (page_prot_ & (PROT_READ|PROT_WRITE)) == (PROT_READ|PROT_WRITE)) {
+    // If the address is invalid, or if the page is already read+write,
+    // no need to do anything here.
+    page_address_ = 0;
+    return;
+  }
+  int new_page_prot = page_prot_ | PROT_READ | PROT_WRITE;
+  int ret = mprotect(reinterpret_cast<void*>(page_address_),
+                                             kPageSize,
+                                             new_page_prot);
+  if (ret < 0) {
+    LOG_ERRNO("Could not remap page to read/write");
+    page_address_ = 0;
+  }
+}
+
+ScopedPageMapper::~ScopedPageMapper() {
+  if (page_address_) {
+    int ret = mprotect(reinterpret_cast<void*>(page_address_),
+                       kPageSize,
+                       page_prot_);
+    if (ret < 0)
+      LOG_ERRNO("Could not remap page to old protection flags");
+  }
+}
+
+}  // namespace
+
+bool RDebug::Init() {
+  // The address of '_r_debug' is in the DT_DEBUG entry of the current
+  // executable. This is supposed to be updated by the linker at load
+  // time, though it looks like this never happens on certain Android
+  // releases :-(
+  init_ = true;
+
+  size_t dynamic_addr = 0;
+  size_t dynamic_size = 0;
+  String path;
+
+  // Find the current executable's full path, and its dynamic section
+  // information.
+  if (!FindExecutablePath(&path))
+    return false;
+
+  ProcMaps self_maps;
+  if (!FindElfDynamicSection(path.c_str(),
+                             &self_maps,
+                             &dynamic_addr,
+                             &dynamic_size)) {
+    return false;
+  }
+
+  // Parse the dynamic table and find the DT_DEBUG entry.
+  const ELF::Dyn* dyn_section =
+      reinterpret_cast<const ELF::Dyn*>(dynamic_addr);
+
+  while (dynamic_size >= sizeof(*dyn_section)) {
+    if (dyn_section->d_tag == DT_DEBUG) {
+      // Found it!
+      LOG("%s: Found DT_DEBUG entry inside %s at %p, pointing to %p\n",
+          __FUNCTION__, path.c_str(), dyn_section, dyn_section->d_un.d_ptr);
+      if (dyn_section->d_un.d_ptr) {
+        r_debug_ = reinterpret_cast<r_debug*>(dyn_section->d_un.d_ptr);
+        LOG("%s: r_debug [r_version=%d r_map=%p r_brk=%p r_ldbase=%p]\n",
+            __FUNCTION__,
+            r_debug_->r_version,
+            r_debug_->r_map,
+            r_debug_->r_brk,
+            r_debug_->r_ldbase);
+        // Only version 1 of the struct is supported.
+        if (r_debug_->r_version != 1) {
+          LOG("%s: r_debug.r_version is %d, 1 expected.\n",
+              __FUNCTION__, r_debug_->r_version);
+          r_debug_ = NULL;
+        }
+
+        // The linker of recent Android releases maps its link map entries
+        // in read-only pages. Determine if this is the case and record it
+        // for later. The first entry in the list corresponds to the
+        // executable.
+        int prot = self_maps.GetProtectionFlagsForAddress(r_debug_->r_map);
+        readonly_entries_ = (prot & PROT_WRITE) == 0;
+
+        LOG("%s: r_debug.readonly_entries=%s\n",
+            __FUNCTION__, readonly_entries_ ? "true" : "false");
+        return true;
+      }
+    }
+    dyn_section++;
+    dynamic_size -= sizeof(*dyn_section);
+  }
+
+  LOG("%s: There is no non-0 DT_DEBUG entry in this process\n",
+      __FUNCTION__);
+  return false;
+}
+
+void RDebug::AddEntry(link_map_t* entry) {
+  LOG("%s\n", __FUNCTION__);
+  if (!init_)
+    Init();
+
+  if (!r_debug_) {
+    LOG("%s: Nothing to do\n", __FUNCTION__);
+    return;
+  }
+
+  // Tell GDB the list is going to be modified.
+  r_debug_->r_state = RT_ADD;
+  r_debug_->r_brk();
+
+  // IMPORTANT: GDB expects the first entry in the list to correspond
+  // to the executable. So add our new entry just after it. This is ok
+  // because the linker is always the second entry, as in:
+  //
+  //   [<executable>, /system/bin/linker, libc.so, libm.so, ...]
+  //
+  // By design, the first two entries should never be removed since they
+  // can't be unloaded from the process (they are loaded by the kernel
+  // when invoking the program).
+  //
+  // TODO(digit): Does GDB expect the linker to be the second entry?
+  // It doesn't seem so, but have a look at the GDB sources to confirm
+  // this. No problem appear experimentally.
+  //
+  // What happens for static binaries? They don't have an .interp section,
+  // and don't have a r_debug variable on Android, so GDB should not be
+  // able to debug shared libraries at all for them (assuming one
+  // statically links a linker into the executable).
+  if (!r_debug_->r_map ||
+      !r_debug_->r_map->l_next ||
+      !r_debug_->r_map->l_next->l_next) {
+    // Sanity check: Must have at least two items in the list.
+    LOG("%s: Malformed r_debug.r_map list\n", __FUNCTION__);
+    r_debug_ = NULL;
+    return;
+  }
+
+  link_map_t* before = r_debug_->r_map->l_next;
+  link_map_t* after  = before->l_next;
+
+  // Prepare the new entry.
+  entry->l_prev = before;
+  entry->l_next = after;
+
+  // IMPORTANT: Before modifying the previous and next entries in the
+  // list, ensure that they are writable. This avoids crashing when
+  // updating the 'l_prev' or 'l_next' fields of a system linker entry,
+  // which are mapped read-only. Note that in theory, all entries before
+  // the current one are supposed to be from our linker, so remapping
+  // the previous entry should not be necessary. However, this can prevent
+  // surprises when this code is run on a future version of the platform
+  // that has a slightly different linker, or even crazy things from
+  // third-party libraries.
+  {
+    ScopedPageMapper mapper;
+    if (readonly_entries_)
+      mapper.MapReadWrite(before);
+    before->l_next = entry;
+  }
+
+  {
+    ScopedPageMapper mapper;
+    if (readonly_entries_)
+      mapper.MapReadWrite(after);
+    after->l_prev = entry;
+  }
+
+  // Tell GDB that the list modification has completed.
+  r_debug_->r_state = RT_CONSISTENT;
+  r_debug_->r_brk();
+}
+
+void RDebug::DelEntry(link_map_t* entry) {
+  if (!r_debug_)
+    return;
+
+  // Tell GDB the list is going to be modified.
+  r_debug_->r_state = RT_DELETE;
+  r_debug_->r_brk();
+
+  // IMPORTANT: Before modifying the previous and next entries in the
+  // list, ensure that they are writable. See comment above for more
+  // details.
+  if (entry->l_prev) {
+    ScopedPageMapper mapper;
+    if (readonly_entries_)
+      mapper.MapReadWrite(entry->l_prev);
+    entry->l_prev->l_next = entry->l_next;
+  }
+
+  if (entry->l_next) {
+    ScopedPageMapper mapper;
+    if (readonly_entries_)
+      mapper.MapReadWrite(entry->l_next);
+    entry->l_next->l_prev = entry->l_prev;
+  }
+
+  if (r_debug_->r_map == entry)
+    r_debug_->r_map = entry->l_next;
+
+  entry->l_prev = NULL;
+  entry->l_next = NULL;
+
+  // Tell GDB the list modification has completed.
+  r_debug_->r_state = RT_CONSISTENT;
+  r_debug_->r_brk();
+}
+
+}  // namespace crazy