minidump_generator.h revision 34f57bcf6a1bf45c1052813f384fc18bd15ca159 
1// Copyright (c) 2006, Google Inc.
2// All rights reserved.
3//
4// Redistribution and use in source and binary forms, with or without
5// modification, are permitted provided that the following conditions are
6// met:
7//
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
13// distribution.
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.
17//
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.
29
30// minidump_generator.h:  Create a minidump of the current MacOS process.
31
32#ifndef CLIENT_MAC_GENERATOR_MINIDUMP_GENERATOR_H__
33#define CLIENT_MAC_GENERATOR_MINIDUMP_GENERATOR_H__
34
35#include <mach/mach.h>
36#include <TargetConditionals.h>
37
38#include <string>
39
40#include "client/minidump_file_writer.h"
41#include "common/memory.h"
42#include "common/mac/macho_utilities.h"
43#include "google_breakpad/common/minidump_format.h"
44
45#include "dynamic_images.h"
46#include "mach_vm_compat.h"
47
48#if !TARGET_OS_IPHONE && (MAC_OS_X_VERSION_MIN_REQUIRED < MAC_OS_X_VERSION_10_7)
49  #define HAS_PPC_SUPPORT
50#endif
51#if defined(__arm__)
52  #define HAS_ARM_SUPPORT
53#elif defined(__i386__) || defined(__x86_64__)
54  #define HAS_X86_SUPPORT
55#endif
56
57namespace google_breakpad {
58
59using std::string;
60
61// Use the REGISTER_FROM_THREADSTATE to access a register name from the
62// breakpad_thread_state_t structure.
63#if __DARWIN_UNIX03 || TARGET_CPU_X86_64 || TARGET_CPU_PPC64 || TARGET_CPU_ARM
64// In The 10.5 SDK Headers Apple prepended __ to the variable names in the
65// i386_thread_state_t structure.  There's no good way to tell what version of
66// the SDK we're compiling against so we just toggle on the same preprocessor
67// symbol Apple's headers use.
68#define REGISTER_FROM_THREADSTATE(a, b) ((a)->__ ## b)
69#else
70#define REGISTER_FROM_THREADSTATE(a, b) (a->b)
71#endif
72
73// Creates a minidump file of the current process.  If there is exception data,
74// use SetExceptionInformation() to add this to the minidump.  The minidump
75// file is generated by the Write() function.
76// Usage:
77// MinidumpGenerator minidump();
78// minidump.Write("/tmp/minidump");
79//
80class MinidumpGenerator {
81 public:
82  MinidumpGenerator();
83  MinidumpGenerator(mach_port_t crashing_task, mach_port_t handler_thread);
84
85  ~MinidumpGenerator();
86
87  // Return <dir>/<unique_name>.dmp
88  // Sets |unique_name| (if requested) to the unique name for the minidump
89  static string UniqueNameInDirectory(const string &dir, string *unique_name);
90
91  // Write out the minidump into |path|
92  // All of the components of |path| must exist and be writable
93  // Return true if successful, false otherwise
94  bool Write(const char *path);
95
96  // Specify some exception information, if applicable
97  void SetExceptionInformation(int type, int code, int subcode,
98                               mach_port_t thread_name) {
99    exception_type_ = type;
100    exception_code_ = code;
101    exception_subcode_ = subcode;
102    exception_thread_ = thread_name;
103  }
104
105  // Gather system information.  This should be call at least once before using
106  // the MinidumpGenerator class.
107  static void GatherSystemInformation();
108
109 private:
110    typedef bool (MinidumpGenerator::*WriteStreamFN)(MDRawDirectory *);
111
112  // Stream writers
113  bool WriteThreadListStream(MDRawDirectory *thread_list_stream);
114  bool WriteMemoryListStream(MDRawDirectory *memory_list_stream);
115  bool WriteExceptionStream(MDRawDirectory *exception_stream);
116  bool WriteSystemInfoStream(MDRawDirectory *system_info_stream);
117  bool WriteModuleListStream(MDRawDirectory *module_list_stream);
118  bool WriteMiscInfoStream(MDRawDirectory *misc_info_stream);
119  bool WriteBreakpadInfoStream(MDRawDirectory *breakpad_info_stream);
120
121  // Helpers
122  u_int64_t CurrentPCForStack(breakpad_thread_state_data_t state);
123  bool GetThreadState(thread_act_t target_thread, thread_state_t state,
124                      mach_msg_type_number_t *count);
125  bool WriteStackFromStartAddress(mach_vm_address_t start_addr,
126                                  MDMemoryDescriptor *stack_location);
127  bool WriteStack(breakpad_thread_state_data_t state,
128                  MDMemoryDescriptor *stack_location);
129  bool WriteContext(breakpad_thread_state_data_t state,
130                    MDLocationDescriptor *register_location);
131  bool WriteThreadStream(mach_port_t thread_id, MDRawThread *thread);
132  bool WriteCVRecord(MDRawModule *module, int cpu_type,
133                     const char *module_path, bool in_memory);
134  bool WriteModuleStream(unsigned int index, MDRawModule *module);
135  size_t CalculateStackSize(mach_vm_address_t start_addr);
136  int  FindExecutableModule();
137
138  // Per-CPU implementations of these methods
139#ifdef HAS_ARM_SUPPORT
140  bool WriteStackARM(breakpad_thread_state_data_t state,
141                     MDMemoryDescriptor *stack_location);
142  bool WriteContextARM(breakpad_thread_state_data_t state,
143                       MDLocationDescriptor *register_location);
144  u_int64_t CurrentPCForStackARM(breakpad_thread_state_data_t state);
145#endif
146#ifdef HAS_PPC_SUPPORT
147  bool WriteStackPPC(breakpad_thread_state_data_t state,
148                     MDMemoryDescriptor *stack_location);
149  bool WriteContextPPC(breakpad_thread_state_data_t state,
150                       MDLocationDescriptor *register_location);
151  u_int64_t CurrentPCForStackPPC(breakpad_thread_state_data_t state);
152  bool WriteStackPPC64(breakpad_thread_state_data_t state,
153                       MDMemoryDescriptor *stack_location);
154  bool WriteContextPPC64(breakpad_thread_state_data_t state,
155                       MDLocationDescriptor *register_location);
156  u_int64_t CurrentPCForStackPPC64(breakpad_thread_state_data_t state);
157#endif
158#ifdef HAS_X86_SUPPORT
159  bool WriteStackX86(breakpad_thread_state_data_t state,
160                       MDMemoryDescriptor *stack_location);
161  bool WriteContextX86(breakpad_thread_state_data_t state,
162                       MDLocationDescriptor *register_location);
163  u_int64_t CurrentPCForStackX86(breakpad_thread_state_data_t state);
164  bool WriteStackX86_64(breakpad_thread_state_data_t state,
165                        MDMemoryDescriptor *stack_location);
166  bool WriteContextX86_64(breakpad_thread_state_data_t state,
167                          MDLocationDescriptor *register_location);
168  u_int64_t CurrentPCForStackX86_64(breakpad_thread_state_data_t state);
169#endif
170
171  // disallow copy ctor and operator=
172  explicit MinidumpGenerator(const MinidumpGenerator &);
173  void operator=(const MinidumpGenerator &);
174
175  // Use this writer to put the data to disk
176  MinidumpFileWriter writer_;
177
178  // Exception information
179  int exception_type_;
180  int exception_code_;
181  int exception_subcode_;
182  mach_port_t exception_thread_;
183  mach_port_t crashing_task_;
184  mach_port_t handler_thread_;
185
186  // CPU type of the task being dumped.
187  cpu_type_t cpu_type_;
188
189  // System information
190  static char build_string_[16];
191  static int os_major_version_;
192  static int os_minor_version_;
193  static int os_build_number_;
194
195  // Information about dynamically loaded code
196  DynamicImages *dynamic_images_;
197
198  // PageAllocator makes it possible to allocate memory
199  // directly from the system, even while handling an exception.
200  mutable PageAllocator allocator_;
201
202  // Blocks of memory written to the dump. These are all currently
203  // written while writing the thread list stream, but saved here
204  // so a memory list stream can be written afterwards.
205  wasteful_vector<MDMemoryDescriptor> memory_blocks_;
206};
207
208}  // namespace google_breakpad
209
210#endif  // CLIENT_MAC_GENERATOR_MINIDUMP_GENERATOR_H__
211