1 // Copyright (c) 2010, Google Inc.
2 // All rights reserved.
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
8 // * Redistributions of source code must retain the above copyright
9 // notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above
11 // copyright notice, this list of conditions and the following disclaimer
12 // in the documentation and/or other materials provided with the
14 // * Neither the name of Google Inc. nor the names of its
15 // contributors may be used to endorse or promote products derived from
16 // this software without specific prior written permission.
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 // linux_dumper.h: Define the google_breakpad::LinuxDumper class, which
31 // is a base class for extracting information of a crashed process. It
32 // was originally a complete implementation using the ptrace API, but
33 // has been refactored to allow derived implementations supporting both
34 // ptrace and core dump. A portion of the original implementation is now
35 // in google_breakpad::LinuxPtraceDumper (see linux_ptrace_dumper.h for
38 #ifndef CLIENT_LINUX_MINIDUMP_WRITER_LINUX_DUMPER_H_
39 #define CLIENT_LINUX_MINIDUMP_WRITER_LINUX_DUMPER_H_
42 #include <linux/limits.h>
44 #include <sys/types.h>
47 #include "common/memory.h"
48 #include "google_breakpad/common/minidump_format.h"
50 namespace google_breakpad {
52 #if defined(__i386) || defined(__x86_64)
53 typedef typeof(((struct user*) 0)->u_debugreg[0]) debugreg_t;
56 // Typedef for our parsing of the auxv variables in /proc/pid/auxv.
57 #if defined(__i386) || defined(__ARM_EABI__) || defined(__mips__)
58 typedef Elf32_auxv_t elf_aux_entry;
59 #elif defined(__x86_64)
60 typedef Elf64_auxv_t elf_aux_entry;
63 typedef typeof(((elf_aux_entry*) 0)->a_un.a_val) elf_aux_val_t;
65 // When we find the VDSO mapping in the process's address space, this
66 // is the name we use for it when writing it to the minidump.
67 // This should always be less than NAME_MAX!
68 const char kLinuxGateLibraryName[] = "linux-gate.so";
70 // We produce one of these structures for each thread in the crashed process.
72 pid_t tgid; // thread group id
73 pid_t ppid; // parent process
75 uintptr_t stack_pointer; // thread stack pointer
78 #if defined(__i386) || defined(__x86_64)
79 user_regs_struct regs;
80 user_fpregs_struct fpregs;
81 static const unsigned kNumDebugRegisters = 8;
84 user_fpxregs_struct fpxregs;
85 #endif // defined(__i386)
87 #elif defined(__ARM_EABI__)
88 // Mimicking how strace does this(see syscall.c, search for GETREGS)
89 struct user_regs regs;
90 struct user_fpregs fpregs;
91 #elif defined(__mips__)
92 user_regs_struct regs;
93 user_fpregs_struct fpregs;
100 // One of these is produced for each mapping in the process (i.e. line in
103 uintptr_t start_addr;
105 size_t offset; // offset into the backed file.
111 explicit LinuxDumper(pid_t pid);
113 virtual ~LinuxDumper();
115 // Parse the data for |threads| and |mappings|.
118 // Return true if the dumper performs a post-mortem dump.
119 virtual bool IsPostMortem() const = 0;
121 // Suspend/resume all threads in the given process.
122 virtual bool ThreadsSuspend() = 0;
123 virtual bool ThreadsResume() = 0;
125 // Read information about the |index|-th thread of |threads_|.
126 // Returns true on success. One must have called |ThreadsSuspend| first.
127 virtual bool GetThreadInfoByIndex(size_t index, ThreadInfo* info) = 0;
129 // These are only valid after a call to |Init|.
130 const wasteful_vector<pid_t> &threads() { return threads_; }
131 const wasteful_vector<MappingInfo*> &mappings() { return mappings_; }
132 const MappingInfo* FindMapping(const void* address) const;
133 const wasteful_vector<elf_aux_val_t>& auxv() { return auxv_; }
135 // Find a block of memory to take as the stack given the top of stack pointer.
136 // stack: (output) the lowest address in the memory area
137 // stack_len: (output) the length of the memory area
138 // stack_top: the current top of the stack
139 bool GetStackInfo(const void** stack, size_t* stack_len, uintptr_t stack_top);
141 PageAllocator* allocator() { return &allocator_; }
143 // Copy content of |length| bytes from a given process |child|,
144 // starting from |src|, into |dest|.
145 virtual void CopyFromProcess(void* dest, pid_t child, const void* src,
148 // Builds a proc path for a certain pid for a node (/proc/<pid>/<node>).
149 // |path| is a character array of at least NAME_MAX bytes to return the
150 // result.|node| is the final node without any slashes. Returns true on
152 virtual bool BuildProcPath(char* path, pid_t pid, const char* node) const = 0;
154 // Generate a File ID from the .text section of a mapped entry.
155 // If not a member, mapping_id is ignored.
156 bool ElfFileIdentifierForMapping(const MappingInfo& mapping,
158 unsigned int mapping_id,
159 uint8_t identifier[sizeof(MDGUID)]);
161 uintptr_t crash_address() const { return crash_address_; }
162 void set_crash_address(uintptr_t crash_address) {
163 crash_address_ = crash_address;
166 int crash_signal() const { return crash_signal_; }
167 void set_crash_signal(int crash_signal) { crash_signal_ = crash_signal; }
169 pid_t crash_thread() const { return crash_thread_; }
170 void set_crash_thread(pid_t crash_thread) { crash_thread_ = crash_thread; }
175 virtual bool EnumerateMappings();
177 virtual bool EnumerateThreads() = 0;
179 // For the case where a running program has been deleted, it'll show up in
180 // /proc/pid/maps as "/path/to/program (deleted)". If this is the case, then
181 // see if '/path/to/program (deleted)' matches /proc/pid/exe and return
182 // /proc/pid/exe in |path| so ELF identifier generation works correctly. This
183 // also checks to see if '/path/to/program (deleted)' exists, so it does not
184 // get fooled by a poorly named binary.
185 // For programs that don't end with ' (deleted)', this is a no-op.
186 // This assumes |path| is a buffer with length NAME_MAX.
187 // Returns true if |path| is modified.
188 bool HandleDeletedFileInMapping(char* path) const;
190 // ID of the crashed process.
193 // Virtual address at which the process crashed.
194 uintptr_t crash_address_;
196 // Signal that terminated the crashed process.
199 // ID of the crashed thread.
202 mutable PageAllocator allocator_;
204 // IDs of all the threads.
205 wasteful_vector<pid_t> threads_;
207 // Info from /proc/<pid>/maps.
208 wasteful_vector<MappingInfo*> mappings_;
210 // Info from /proc/<pid>/auxv
211 wasteful_vector<elf_aux_val_t> auxv_;
214 } // namespace google_breakpad
216 #endif // CLIENT_LINUX_HANDLER_LINUX_DUMPER_H_