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, 145 insertions, 0 deletions

diff --git a/src/client/windows/crash_generation/client_info.h b/src/client/windows/crash_generation/client_info.h
new file mode 100644
index 00000000..06de6311
--- /dev/null
+++ b/src/client/windows/crash_generation/client_info.h
@@ -0,0 +1,145 @@
+// 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.

+

+#ifndef CLIENT_WINDOWS_CRASH_GENERATION_CLIENT_INFO_H__

+#define CLIENT_WINDOWS_CRASH_GENERATION_CLIENT_INFO_H__

+

+#include <Windows.h>

+#include <DbgHelp.h>

+#include "google_breakpad/common/minidump_format.h"

+

+namespace google_breakpad {

+

+class CrashGenerationServer;

+

+// Abstraction for a crash client process.

+class ClientInfo {

+ public:

+  // Creates an instance with the given values. Gets the process

+  // handle for the given process id and creates necessary event

+  // objects.

+  ClientInfo(CrashGenerationServer* crash_server,

+             DWORD pid,

+             MINIDUMP_TYPE dump_type,

+             DWORD* thread_id,

+             EXCEPTION_POINTERS** ex_info,

+             MDRawAssertionInfo* assert_info);

+

+  ~ClientInfo();

+

+  CrashGenerationServer* crash_server() const { return crash_server_; }

+  DWORD pid() const { return pid_; }

+  MINIDUMP_TYPE dump_type() const { return dump_type_; }

+  EXCEPTION_POINTERS** ex_info() const { return ex_info_; }

+  MDRawAssertionInfo* assert_info() const { return assert_info_; }

+  DWORD* thread_id() const { return thread_id_; }

+  HANDLE process_handle() const { return process_handle_; }

+  HANDLE dump_requested_handle() const { return dump_requested_handle_; }

+  HANDLE dump_generated_handle() const { return dump_generated_handle_; }

+

+  HANDLE dump_request_wait_handle() const {

+    return dump_request_wait_handle_;

+  }

+

+  void set_dump_request_wait_handle(HANDLE value) {

+    dump_request_wait_handle_ = value;

+  }

+

+  HANDLE process_exit_wait_handle() const {

+    return process_exit_wait_handle_;

+  }

+

+  void set_process_exit_wait_handle(HANDLE value) {

+    process_exit_wait_handle_ = value;

+  }

+

+  // Unregister all waits for the client.

+  bool UnregisterWaits();

+

+  bool Initialize();

+  bool GetClientExceptionInfo(EXCEPTION_POINTERS** ex_info) const;

+  bool GetClientThreadId(DWORD* thread_id) const;

+

+ private:

+  // Crash generation server.

+  CrashGenerationServer* crash_server_;

+

+  // Client process ID.

+  DWORD pid_;

+

+  // Dump type requested by the client.

+  MINIDUMP_TYPE dump_type_;

+

+  // Address of an EXCEPTION_POINTERS* variable in the client

+  // process address space that will point to an instance of

+  // EXCEPTION_POINTERS containing information about crash.

+  //

+  // WARNING: Do not dereference these pointers as they are pointers

+  // in the address space of another process.

+  EXCEPTION_POINTERS** ex_info_;

+

+  // Address of an instance of MDRawAssertionInfo in the client

+  // process address space that will contain information about

+  // non-exception related crashes like invalid parameter assertion

+  // failures and pure calls.

+  //

+  // WARNING: Do not dereference these pointers as they are pointers

+  // in the address space of another process.

+  MDRawAssertionInfo* assert_info_;

+

+  // Address of a variable in the client process address space that

+  // will contain the thread id of the crashing client thread.

+  //

+  // WARNING: Do not dereference these pointers as they are pointers

+  // in the address space of another process.

+  DWORD* thread_id_;

+

+  // Client process handle.

+  HANDLE process_handle_;

+

+  // Dump request event handle.

+  HANDLE dump_requested_handle_;

+

+  // Dump generated event handle.

+  HANDLE dump_generated_handle_;

+

+  // Wait handle for dump request event.

+  HANDLE dump_request_wait_handle_;

+

+  // Wait handle for process exit event.

+  HANDLE process_exit_wait_handle_;

+

+  // Disallow copy ctor and operator=.

+  ClientInfo(const ClientInfo& client_info);

+  ClientInfo& operator=(const ClientInfo& client_info);

+};

+

+}  // namespace google_breakpad

+

+#endif  // CLIENT_WINDOWS_CRASH_GENERATION_CLIENT_INFO_H__