Overview:

Implement out-of-process dump generation for Windows platform.

Details:
- Created a lib, crash_generation.lib, that implements the out-of-process dump generation protocol.
- The lib code is under client/windows/crash_generation folder and is organized in the following way:
	- CrashGenerationServer class (crash_generation_server.h/.cc) implements the server side of
	  the protocol.
	- CrashGenerationClient class (crash_generation_client.h/.cc) implements the client side of
	  the protocol.
	- MinidumpGenerator class (minidump_generator.h/.cc) serves as an abstractino for generating
	  dump files using Windows APIs, coming up with new file names by creating GUIDs, etc.
	- ProtocolMessage class (ipc_protocol.h) represents the message format between the client and server
	  for pipe IPC.
	- Server allows one client at a time on the pipe in the current implementation.
	- ReadMe.txt explains the state machine the server uses to serve clients.
- ExceptionHandler is modified and a new constructor is added that allows specifying the pipe name. If the
  pipe name is NULL, the behavior is backward compatible - in-process dump generation is done as before. If
  the pipe name is specified, out-of-process dump generation registration is attempted. If that fails, the
  behavior is again backward compatible.
- If out-of-process registration succeeds, all write dump requests, direct or indirect, are directed to
  crash server process that served the registration request. NOTE that the explicit dump requests made by
  calling the static method of ExceptionHandler are not directed to theserver.
- client/windows/tests/crash_generation_app implements a simple Win32 GUI application to help test the
  out-of-process dump generation client and server. Typical use of the app is to start one instance, click
  Server --> Start and then start the other instance. The other instance will register with the first
  instance automatically at start-up. Then the second instance can be used to request various typoes of
  dump requests by using options under the Client menu.




git-svn-id: http://google-breakpad.googlecode.com/svn/trunk@244 4c0a9323-5329-0410-9bdc-e9ce6186880e

1 files changed, 228 insertions, 0 deletions

diff --git a/src/client/windows/crash_generation/minidump_generator.cc b/src/client/windows/crash_generation/minidump_generator.cc
new file mode 100644
index 00000000..6081e4b2
--- /dev/null
+++ b/src/client/windows/crash_generation/minidump_generator.cc
@@ -0,0 +1,228 @@
+// Copyright (c) 2008, 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 Google 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 THE COPYRIGHT

+// OWNER 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.

+

+#include "client/windows/crash_generation/minidump_generator.h"

+#include <cassert>

+#include "client/windows/common/auto_critical_section.h"

+#include "common/windows/guid_string.h"

+

+using std::wstring;

+

+namespace google_breakpad {

+

+MinidumpGenerator::MinidumpGenerator(const wstring& dump_path)

+    : dbghelp_module_(NULL),

+      rpcrt4_module_(NULL),

+      dump_path_(dump_path),

+      write_dump_(NULL),

+      create_uuid_(NULL) {

+  InitializeCriticalSection(&module_load_sync_);

+  InitializeCriticalSection(&get_proc_address_sync_);

+}

+

+MinidumpGenerator::~MinidumpGenerator() {

+  if (dbghelp_module_) {

+    FreeLibrary(dbghelp_module_);

+  }

+

+  if (rpcrt4_module_) {

+    FreeLibrary(rpcrt4_module_);

+  }

+

+  DeleteCriticalSection(&get_proc_address_sync_);

+  DeleteCriticalSection(&module_load_sync_);

+}

+

+bool MinidumpGenerator::WriteMinidump(HANDLE process_handle,

+                                      DWORD process_id,

+                                      DWORD thread_id,

+                                      DWORD requesting_thread_id,

+                                      EXCEPTION_POINTERS* exception_pointers,

+                                      MDRawAssertionInfo* assert_info,

+                                      MINIDUMP_TYPE dump_type,

+                                      bool is_client_pointers) {

+  MiniDumpWriteDumpType write_dump = GetWriteDump();

+  if (!write_dump) {

+    return false;

+  }

+

+  wstring dump_file_path;

+  if (!GenerateDumpFilePath(&dump_file_path)) {

+    return false;

+  }

+

+  HANDLE dump_file = CreateFile(dump_file_path.c_str(),

+                                GENERIC_WRITE,

+                                0,

+                                NULL,

+                                CREATE_NEW,

+                                FILE_ATTRIBUTE_NORMAL,

+                                NULL);

+

+  if (dump_file == INVALID_HANDLE_VALUE) {

+    return false;

+  }

+

+  MINIDUMP_EXCEPTION_INFORMATION* dump_exception_pointers = NULL;

+  MINIDUMP_EXCEPTION_INFORMATION dump_exception_info;

+

+  // Setup the exception information object only if it's a dump

+  // due to an exception.

+  if (exception_pointers) {

+    dump_exception_pointers = &dump_exception_info;

+    dump_exception_info.ThreadId = thread_id;

+    dump_exception_info.ExceptionPointers = exception_pointers;

+    dump_exception_info.ClientPointers = is_client_pointers;

+  }

+

+  // Add an MDRawBreakpadInfo stream to the minidump, to provide additional

+  // information about the exception handler to the Breakpad processor.

+  // The information will help the processor determine which threads are

+  // relevant. The Breakpad processor does not require this information but

+  // can function better with Breakpad-generated dumps when it is present.

+  // The native debugger is not harmed by the presence of this information.

+  MDRawBreakpadInfo breakpad_info;

+  breakpad_info.validity = MD_BREAKPAD_INFO_VALID_DUMP_THREAD_ID |

+                           MD_BREAKPAD_INFO_VALID_REQUESTING_THREAD_ID;

+  breakpad_info.dump_thread_id = thread_id;

+  breakpad_info.requesting_thread_id = requesting_thread_id;

+

+  // Leave room in user_stream_array for a possible assertion info stream.

+  MINIDUMP_USER_STREAM user_stream_array[2];

+  user_stream_array[0].Type = MD_BREAKPAD_INFO_STREAM;

+  user_stream_array[0].BufferSize = sizeof(breakpad_info);

+  user_stream_array[0].Buffer = &breakpad_info;

+

+  MINIDUMP_USER_STREAM_INFORMATION user_streams;

+  user_streams.UserStreamCount = 1;

+  user_streams.UserStreamArray = user_stream_array;

+

+  MDRawAssertionInfo* actual_assert_info = assert_info;

+  MDRawAssertionInfo client_assert_info = {0};

+

+  if (assert_info) {

+    // If the assertion info object lives in the client process,

+    // read the memory of the client process.

+    if (is_client_pointers) {

+      SIZE_T bytes_read = 0;

+      if (!ReadProcessMemory(process_handle,

+                             assert_info,

+                             &client_assert_info,

+                             sizeof(client_assert_info),

+                             &bytes_read)) {

+        CloseHandle(dump_file);

+        return false;

+      }

+

+      if (bytes_read != sizeof(client_assert_info)) {

+        CloseHandle(dump_file);

+        return false;

+      }

+

+      actual_assert_info  = &client_assert_info;

+    }

+

+    user_stream_array[1].Type = MD_ASSERTION_INFO_STREAM;

+    user_stream_array[1].BufferSize = sizeof(MDRawAssertionInfo);

+    user_stream_array[1].Buffer = actual_assert_info;

+    ++user_streams.UserStreamCount;

+  }

+

+  bool result = write_dump(process_handle,

+                           process_id,

+                           dump_file,

+                           dump_type,

+                           exception_pointers ? &dump_exception_info : NULL,

+                           &user_streams,

+                           NULL) != FALSE;

+

+  CloseHandle(dump_file);

+  return result;

+}

+

+HMODULE MinidumpGenerator::GetDbghelpModule() {

+  AutoCriticalSection lock(&module_load_sync_);

+  if (!dbghelp_module_) {

+    dbghelp_module_ = LoadLibrary(TEXT("dbghelp.dll"));

+  }

+

+  return dbghelp_module_;

+}

+

+MinidumpGenerator::MiniDumpWriteDumpType MinidumpGenerator::GetWriteDump() {

+  AutoCriticalSection lock(&get_proc_address_sync_);

+  if (!write_dump_) {

+    HMODULE module = GetDbghelpModule();

+    if (module) {

+      FARPROC proc = GetProcAddress(module, "MiniDumpWriteDump");

+      write_dump_ = reinterpret_cast<MiniDumpWriteDumpType>(proc);

+    }

+  }

+

+  return write_dump_;

+}

+

+HMODULE MinidumpGenerator::GetRpcrt4Module() {

+  AutoCriticalSection lock(&module_load_sync_);

+  if (!rpcrt4_module_) {

+    rpcrt4_module_ = LoadLibrary(TEXT("rpcrt4.dll"));

+  }

+

+  return rpcrt4_module_;

+}

+

+MinidumpGenerator::UuidCreateType MinidumpGenerator::GetCreateUuid() {

+  AutoCriticalSection lock(&module_load_sync_);

+  if (!create_uuid_) {

+    HMODULE module = GetRpcrt4Module();

+    if (module) {

+      FARPROC proc = GetProcAddress(module, "UuidCreate");

+      create_uuid_ = reinterpret_cast<UuidCreateType>(proc);

+    }

+  }

+

+  return create_uuid_;

+}

+

+bool MinidumpGenerator::GenerateDumpFilePath(wstring* file_path) {

+  UUID id = {0};

+

+  UuidCreateType create_uuid = GetCreateUuid();

+  if(!create_uuid) {

+    return false;

+  }

+

+  create_uuid(&id);

+  wstring id_str = GUIDString::GUIDToWString(&id);

+

+  *file_path = dump_path_ + TEXT("\\") + id_str + TEXT(".dmp");

+  return true;

+}

+

+}  // namespace google_breakpad