i#7046 Add Linux support to dr_create_memory_dump. (#7047)

This is the first change to add Linux support to dr_create_memory_dump.
The memory dump is written in ELF format and saved under the logs
directory following the Windows example in win32/os.c.

Add a new test, memory_dump_test, to test dr_create_memory_dump for X64
Linux.

Issue: #7046

api/docs/release.dox

@@ -126,7 +126,8 @@ clients.
 
 The changes between version \DR_VERSION and 11.0.0 include the following compatibility
 changes:
- - No compatibility changes.
+ - Added X64 Linux support to dr_create_memory_dump(). This API has the same
+   restriction as dr_suspend_all_other_threads_ex().
 
 Further non-compatibility-affecting changes include:
  - No changes yet.

core/CMakeLists.txt

@@ -390,6 +390,7 @@ if (UNIX)
       set(OS_SRCS ${OS_SRCS} unix/loader_android.c)
     else ()
       set(OS_SRCS ${OS_SRCS} unix/loader_linux.c)
+      set(OS_SRCS ${OS_SRCS} unix/coredump.c)
     endif ()
     set(OS_SRCS ${OS_SRCS} unix/memquery_linux.c)
     set(OS_SRCS ${OS_SRCS} unix/memquery.c)

core/lib/dr_tools.h

@@ -341,6 +341,13 @@ typedef enum {
      * \note Windows only.
      */
     DR_MEMORY_DUMP_LDMP = 0x0001,
+    /**
+     * Memory dump in Executable and Linkable Format. This API has the same
+     * restrictions in where it can be called from as dr_suspend_all_other_threads_ex().
+     *
+     * \note X64 Linux only.
+     */
+    DR_MEMORY_DUMP_ELF = 0x0002,
 } dr_memory_dump_flags_t;
 
 /** Indicates the type of memory dump for dr_create_memory_dump(). */

core/lib/instrument.c

@@ -2497,6 +2497,9 @@ dr_create_memory_dump(dr_memory_dump_spec_t *spec)
 #ifdef WINDOWS
     if (TEST(DR_MEMORY_DUMP_LDMP, spec->flags))
         return os_dump_core_live(spec->label, spec->ldmp_path, spec->ldmp_path_size);
+#elif defined(LINUX) && defined(X64)
+    if (TEST(DR_MEMORY_DUMP_ELF, spec->flags))
+        return os_dump_core_live();
 #endif
     return false;
 }

core/unix/elf_defines.h

@@ -0,0 +1,237 @@
+/* **********************************************************
+ * Copyright (c) 2024 Google, Inc.  All rights reserved.
+ * **********************************************************/
+
+/*
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * * Redistributions of source code must retain the above copyright notice,
+ *   this list of conditions and the following disclaimer.
+ *
+ * * Redistributions in binary form must reproduce the above copyright notice,
+ *   this list of conditions and the following disclaimer in the documentation
+ *   and/or other materials provided with the distribution.
+ *
+ * * Neither the name of VMware, Inc. nor the names of its contributors may be
+ *   used to endorse or promote products derived from this software without
+ *   specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+ * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ * ARE DISCLAIMED. IN NO EVENT SHALL VMWARE, INC. OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+ * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+ * DAMAGE.
+ */
+
+#ifndef ELF_DEFINES_H
+#define ELF_DEFINES_H
+
+#include <elf.h> /* for ELF types */
+
+#ifndef DT_RELRSZ
+#    define DT_RELRSZ 35
+#    define DT_RELR 36
+#endif
+
+/* Workaround for EM_RISCV not being defined in elf.h on RHEL-7. */
+#ifndef EM_RISCV
+#    define EM_RISCV 243
+#endif
+
+/* XXX i#1345: support mixed-mode 32-bit and 64-bit in one process.
+ * There is no official support for that on Linux or Mac and for now we do
+ * not support it either, especially not mixing libraries.
+ * Update: We want this for i#1684 for multi-arch support in drdecode.
+ */
+#ifdef X64
+#    define ELF_HEADER_TYPE Elf64_Ehdr
+#    define ELF_ALTARCH_HEADER_TYPE Elf32_Ehdr
+#    define ELF_PROGRAM_HEADER_TYPE Elf64_Phdr
+#    define ELF_SECTION_HEADER_TYPE Elf64_Shdr
+#    define ELF_DYNAMIC_ENTRY_TYPE Elf64_Dyn
+#    define ELF_ADDR Elf64_Addr
+#    define ELF_WORD Elf64_Xword
+#    define ELF_SWORD Elf64_Sxword
+#    define ELF_HALF Elf64_Half
+#    define ELF_SYM_TYPE Elf64_Sym
+#    define ELF_WORD_SIZE 64 /* __ELF_NATIVE_CLASS */
+#    define ELF_ST_VISIBILITY ELF64_ST_VISIBILITY
+#    define ELF_REL_TYPE Elf64_Rel
+#    define ELF_RELA_TYPE Elf64_Rela
+#    define ELF_AUXV_TYPE Elf64_auxv_t
+#    define ELF_OFF Elf64_Word
+/* system like android has ELF_ST_TYPE and ELF_ST_BIND */
+#    ifndef ELF_ST_TYPE
+#        define ELF_ST_TYPE ELF64_ST_TYPE
+#        define ELF_ST_BIND ELF64_ST_BIND
+#    endif
+#else
+#    define ELF_HEADER_TYPE Elf32_Ehdr
+#    define ELF_ALTARCH_HEADER_TYPE Elf64_Ehdr
+#    define ELF_PROGRAM_HEADER_TYPE Elf32_Phdr
+#    define ELF_SECTION_HEADER_TYPE Elf32_Shdr
+#    define ELF_DYNAMIC_ENTRY_TYPE Elf32_Dyn
+#    define ELF_ADDR Elf32_Addr
+#    define ELF_WORD Elf32_Word
+#    define ELF_SWORD Elf32_Sword
+#    define ELF_HALF Elf32_Half
+#    define ELF_SYM_TYPE Elf32_Sym
+#    define ELF_WORD_SIZE 32 /* __ELF_NATIVE_CLASS */
+#    define ELF_ST_VISIBILITY ELF32_ST_VISIBILITY
+#    define ELF_REL_TYPE Elf32_Rel
+#    define ELF_RELA_TYPE Elf32_Rela
+#    define ELF_AUXV_TYPE Elf32_auxv_t
+#    define ELF_OFF Elf32_Word
+/* system like android has ELF_ST_TYPE and ELF_ST_BIND */
+#    ifndef ELF_ST_TYPE
+#        define ELF_ST_TYPE ELF32_ST_TYPE
+#        define ELF_ST_BIND ELF32_ST_BIND
+#    endif
+#endif
+
+#ifdef X86
+#    ifdef X64
+/* AMD x86-64 relocations.  */
+#        define ELF_R_TYPE ELF64_R_TYPE
+#        define ELF_R_SYM ELF64_R_SYM
+#        define ELF_R_INFO ELF64_R_INFO
+/* relocation type */
+#        define ELF_R_NONE R_X86_64_NONE           /* No reloc */
+#        define ELF_R_DIRECT R_X86_64_64           /* Direct 64 bit */
+#        define ELF_R_PC32 R_X86_64_PC32           /* PC relative 32-bit signed */
+#        define ELF_R_COPY R_X86_64_COPY           /* copy symbol at runtime */
+#        define ELF_R_GLOB_DAT R_X86_64_GLOB_DAT   /* GOT entry */
+#        define ELF_R_JUMP_SLOT R_X86_64_JUMP_SLOT /* PLT entry */
+#        define ELF_R_RELATIVE R_X86_64_RELATIVE   /* Adjust by program delta */
+#        ifndef R_X86_64_IRELATIVE
+#            define R_X86_64_IRELATIVE 37
+#        endif
+#        define ELF_R_IRELATIVE                                                         \
+            R_X86_64_IRELATIVE                     /* Adjust indirectly by program base \
+                                                    */
+                                                   /* TLS hanlding */
+#        define ELF_R_TLS_DTPMOD R_X86_64_DTPMOD64 /* Module ID */
+#        define ELF_R_TLS_TPOFF R_X86_64_TPOFF64   /* Offset in module's TLS block */
+#        define ELF_R_TLS_DTPOFF R_X86_64_DTPOFF64 /* Offset in initial TLS block */
+#        ifndef R_X86_64_TLSDESC
+#            define R_X86_64_TLSDESC 36
+#        endif
+#        define ELF_R_TLS_DESC                              \
+            R_X86_64_TLSDESC /* TLS descriptor containing   \
+                              * pointer to code and to      \
+                              * argument, returning the TLS \
+                              * offset for the symbol.      \
+                              */
+#    else                    /* 32-bit */
+#        define ELF_R_TYPE ELF32_R_TYPE
+#        define ELF_R_SYM ELF32_R_SYM
+#        define ELF_R_INFO ELF32_R_INFO
+/* relocation type */
+#        define ELF_R_NONE R_386_NONE          /* No reloc */
+#        define ELF_R_DIRECT R_386_32          /* Direct 32 bit */
+#        define ELF_R_PC32 R_386_PC32          /* PC relative 32 bit */
+#        define ELF_R_COPY R_386_COPY          /* Copy symbol at runtime */
+#        define ELF_R_GLOB_DAT R_386_GLOB_DAT  /* GOT entry */
+#        define ELF_R_JUMP_SLOT R_386_JMP_SLOT /* PLT entry */
+#        define ELF_R_RELATIVE R_386_RELATIVE  /* Adjust by program delta */
+#        ifndef R_386_IRELATIVE
+#            define R_386_IRELATIVE 42
+#        endif
+#        define ELF_R_IRELATIVE R_386_IRELATIVE /* Adjust indirectly by program base */
+/* tls related */
+#        define ELF_R_TLS_DTPMOD R_386_TLS_DTPMOD32 /* Module ID */
+#        define ELF_R_TLS_TPOFF                                    \
+            R_386_TLS_TPOFF /* Negated offsets in static TLS block \
+                             */
+#        define ELF_R_TLS_DTPOFF R_386_TLS_DTPOFF32 /* Offset in TLS block */
+#        ifndef R_386_TLS_DESC
+#            define R_386_TLS_DESC 41
+#        endif
+#        define ELF_R_TLS_DESC                            \
+            R_386_TLS_DESC /* TLS descriptor containing   \
+                            * pointer to code and to      \
+                            * argument, returning the TLS \
+                            * offset for the symbol.      \
+                            */
+#    endif
+#elif defined(AARCH64)
+#    define ELF_R_TYPE ELF64_R_TYPE
+#    define ELF_R_SYM ELF64_R_SYM
+/* relocation type */
+#    define ELF_R_NONE R_AARCH64_NONE           /* No relocation. */
+#    define ELF_R_DIRECT R_AARCH64_ABS64        /* Direct 64 bit. */
+#    define ELF_R_COPY R_AARCH64_COPY           /* Copy symbol at runtime. */
+#    define ELF_R_GLOB_DAT R_AARCH64_GLOB_DAT   /* Create GOT entry. */
+#    define ELF_R_JUMP_SLOT R_AARCH64_JUMP_SLOT /* Create PLT entry. */
+#    define ELF_R_RELATIVE R_AARCH64_RELATIVE   /* Adjust by program base. */
+#    define ELF_R_IRELATIVE R_AARCH64_IRELATIVE /* STT_GNU_IFUNC relocation. */
+/* tls related */
+#    define ELF_R_TLS_DTPMOD 1028 /* R_AARCH64_TLS_DTPMOD64 Module number. */
+#    define ELF_R_TLS_TPOFF 1030  /* R_AARCH64_TLS_TPREL64  TP-relative offset. */
+#    define ELF_R_TLS_DTPOFF 1029 /* R_AARCH64_TLS_DTPREL64 Module-relative offset. */
+#    define ELF_R_TLS_DESC 1031   /* R_AARCH64_TLSDESC      TLS Descriptor. */
+#elif defined(ARM)
+#    define ELF_R_TYPE ELF32_R_TYPE
+#    define ELF_R_SYM ELF32_R_SYM
+#    define ELF_R_INFO ELF32_R_INFO
+/* relocation type */
+#    define ELF_R_NONE R_ARM_NONE               /* No reloc */
+#    define ELF_R_DIRECT R_ARM_ABS32            /* Direct 32 bit */
+#    define ELF_R_COPY R_ARM_COPY               /* Copy symbol at runtime */
+#    define ELF_R_GLOB_DAT R_ARM_GLOB_DAT       /* GOT entry */
+#    define ELF_R_JUMP_SLOT R_ARM_JUMP_SLOT     /* PLT entry */
+#    define ELF_R_RELATIVE R_ARM_RELATIVE       /* Adjust by program delta */
+#    define ELF_R_IRELATIVE R_ARM_IRELATIVE     /* Adjust indirectly by program base */
+/* tls related */
+#    define ELF_R_TLS_DTPMOD R_ARM_TLS_DTPMOD32 /* Module ID */
+#    define ELF_R_TLS_TPOFF R_ARM_TLS_TPOFF32   /* Negated offsets in static TLS block */
+#    define ELF_R_TLS_DTPOFF R_ARM_TLS_DTPOFF32 /* Offset in TLS block */
+#    ifndef ANDROID
+#        define ELF_R_TLS_DESC                            \
+            R_ARM_TLS_DESC /* TLS descriptor containing   \
+                            * pointer to code and to      \
+                            * argument, returning the TLS \
+                            * offset for the symbol.      \
+                            */
+#    endif                 /* ANDROID */
+#elif defined(RISCV64)
+#    define ELF_R_TYPE ELF64_R_TYPE
+#    define ELF_R_SYM ELF64_R_SYM
+/* relocation type */
+#    define ELF_R_NONE R_RISCV_NONE           /* No relocation. */
+#    define ELF_R_DIRECT R_RISCV_64           /* Direct 64 bit. */
+#    define ELF_R_COPY R_RISCV_COPY           /* Copy symbol at runtime. */
+/* XXX i#3544: GOT and direct 64 bit both use R_RISCV_64. */
+#    define ELF_R_GLOB_DAT R_RISCV_64         /* Create GOT entry. */
+#    define ELF_R_JUMP_SLOT R_RISCV_JUMP_SLOT /* Create PLT entry. */
+#    define ELF_R_RELATIVE R_RISCV_RELATIVE   /* Adjust by program base. */
+/* XXX i#3544: R_RISCV_IRELATIVE was added after libc 2.31 and some distros
+ * don't have it yet (i.e. Ubuntu 20.04). The official number has been defined
+ * here: https://github.com/riscv/riscv-elf-psabi-doc/commit/d21ca40a.
+ */
+#    ifndef R_RISCV_IRELATIVE
+#        define R_RISCV_IRELATIVE 58
+#    endif
+#    define ELF_R_IRELATIVE R_RISCV_IRELATIVE     /* STT_GNU_IFUNC relocation. */
+/* tls related */
+#    define ELF_R_TLS_DTPMOD R_RISCV_TLS_DTPMOD64 /* Module ID. */
+#    define ELF_R_TLS_TPOFF R_RISCV_TLS_TPREL64   /* TP-relative offset. */
+#    define ELF_R_TLS_DTPOFF R_RISCV_TLS_DTPREL64 /* Module-relative offset. */
+#endif                                            /* X86/ARM/RISCV64 */
+
+/* Define ARM ELF machine types to support compiling on old Linux distros. */
+#ifndef EM_ARM
+#    define EM_ARM 40
+#endif
+#ifndef EM_AARCH64
+#    define EM_AARCH64 183
+#endif
+
+#endif /* ELF_DEFINES_H */