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

2 files changed, 185 insertions, 0 deletions

diff --git a/src/client/windows/common/auto_critical_section.h b/src/client/windows/common/auto_critical_section.h
new file mode 100644
index 00000000..9bf3d492
--- /dev/null
+++ b/src/client/windows/common/auto_critical_section.h
@@ -0,0 +1,63 @@
+// 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_COMMON_AUTO_CRITICAL_SECTION_H__

+#define CLIENT_WINDOWS_COMMON_AUTO_CRITICAL_SECTION_H__

+

+#include <Windows.h>

+

+namespace google_breakpad {

+

+// Automatically enters the critical section in the constructor and leaves

+// the critical section in the destructor.

+class AutoCriticalSection {

+ public:

+  // Creates a new instance with the given critical section object

+  // and enters the critical section immediately.

+  explicit AutoCriticalSection(CRITICAL_SECTION* cs) : cs_(cs) {

+    assert(cs_);

+    EnterCriticalSection(cs_);

+  }

+

+  // Destructor: leaves the critical section.

+  ~AutoCriticalSection() {

+    LeaveCriticalSection(cs_);

+  }

+

+ private:

+  // Disable copy ctor and operator=.

+  AutoCriticalSection(const AutoCriticalSection&);

+  AutoCriticalSection& operator=(const AutoCriticalSection&);

+

+  CRITICAL_SECTION* cs_;

+};

+

+}  // namespace google_breakpad

+

+#endif  // CLIENT_WINDOWS_COMMON_AUTO_CRITICAL_SECTION_H__

diff --git a/src/client/windows/common/ipc_protocol.h b/src/client/windows/common/ipc_protocol.h
new file mode 100644
index 00000000..aa3751f3
--- /dev/null
+++ b/src/client/windows/common/ipc_protocol.h
@@ -0,0 +1,122 @@
+// 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_COMMON_IPC_PROTOCOL_H__

+#define CLIENT_WINDOWS_COMMON_IPC_PROTOCOL_H__

+

+#include <Windows.h>

+#include <DbgHelp.h>

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

+

+namespace google_breakpad {

+

+// Constants for the protocol between client and the server.

+

+// Tags sent with each message indicating the purpose of

+// the message.

+enum MessageTag {

+  MESSAGE_TAG_NONE = 0,

+  MESSAGE_TAG_REGISTRATION_REQUEST = 1,

+  MESSAGE_TAG_REGISTRATION_RESPONSE = 2,

+  MESSAGE_TAG_REGISTRATION_ACK = 3

+};

+

+// Message structure for IPC between crash client and crash server.

+struct ProtocolMessage {

+  ProtocolMessage()

+      : tag(MESSAGE_TAG_NONE),

+        pid(0),

+        dump_type(MiniDumpNormal),

+        thread_id(0),

+        exception_pointers(NULL),

+        assert_info(NULL),

+        dump_request_handle(NULL),

+        dump_generated_handle(NULL),

+        server_alive_handle(NULL) {

+  }

+

+  // Creates an instance with the given parameters.

+  ProtocolMessage(MessageTag arg_tag,

+                  DWORD arg_pid,

+                  MINIDUMP_TYPE arg_dump_type,

+                  DWORD* arg_thread_id,

+                  EXCEPTION_POINTERS** arg_exception_pointers,

+                  MDRawAssertionInfo* arg_assert_info,

+                  HANDLE arg_dump_request_handle,

+                  HANDLE arg_dump_generated_handle,

+                  HANDLE arg_server_alive)

+    : tag(arg_tag),

+      pid(arg_pid),

+      dump_type(arg_dump_type),

+      thread_id(arg_thread_id),

+      exception_pointers(arg_exception_pointers),

+      assert_info(arg_assert_info),

+      dump_request_handle(arg_dump_request_handle),

+      dump_generated_handle(arg_dump_generated_handle),

+      server_alive_handle(arg_server_alive) {

+  }

+

+  // Tag in the message.

+  MessageTag tag;

+

+  // Process id.

+  DWORD pid;

+

+  // Dump type requested.

+  MINIDUMP_TYPE dump_type;

+

+  // Client thread id pointer.

+  DWORD* thread_id;

+

+  // Exception information.

+  EXCEPTION_POINTERS** exception_pointers;

+

+  // Assert information in case of an invalid parameter or

+  // pure call failure.

+  MDRawAssertionInfo* assert_info;

+

+  // Handle to signal the crash event.

+  HANDLE dump_request_handle;

+

+  // Handle to check if server is done generating crash.

+  HANDLE dump_generated_handle;

+

+  // Handle to a mutex that becomes signaled (WAIT_ABANDONED)

+  // if server process goes down.

+  HANDLE server_alive_handle;

+

+ private:

+  // Disable copy ctor and operator=.

+  ProtocolMessage(const ProtocolMessage& msg);

+  ProtocolMessage& operator=(const ProtocolMessage& msg);

+};

+

+}  // namespace google_breakpad

+

+#endif  // CLIENT_WINDOWS_COMMON_IPC_PROTOCOL_H__