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

diff --git a/src/client/windows/crash_generation/ReadMe.txt b/src/client/windows/crash_generation/ReadMe.txt
new file mode 100644
index 00000000..d9ded287
--- /dev/null
+++ b/src/client/windows/crash_generation/ReadMe.txt
@@ -0,0 +1,58 @@
+=========================================================================

+ State machine transitions for the Crash Generation Server

+=========================================================================

+

+=========================================================================

+               |

+ STATE         | ACTIONS

+               |

+=========================================================================

+ ERROR         | Clean up resources used to serve clients.

+               | Always remain in ERROR state.

+-------------------------------------------------------------------------

+ INITIAL       | Connect to the pipe asynchronously.

+               | If connection is successfully queued up asynchronously,

+               | go into CONNECTING state.

+               | If connection is done synchronously, go into CONNECTED

+               | state.

+               | For any unexpected problems, go into ERROR state.

+-------------------------------------------------------------------------

+ CONNECTING    | Get the result of async connection request.

+               | If I/O is still incomplete, remain in the CONNECTING

+               | state.

+               | If connection is complete, go into CONNECTED state.

+               | For any unexpected problems, go into DISCONNECTING state.

+-------------------------------------------------------------------------

+ CONNECTED     | Read from the pipe asynchronously.

+               | If read request is successfully queued up asynchronously,

+               | go into READING state.

+               | For any unexpected problems, go into DISCONNECTING state.

+-------------------------------------------------------------------------

+ READING       | Get the result of async read request.

+               | If read is done, go into READ_DONE state.

+               | For any unexpected problems, go into DISCONNECTING state.

+-------------------------------------------------------------------------

+ READ_DONE     | Register the client, prepare the reply and write the

+               | reply to the pipe asynchronously.

+               | If write request is successfully queued up asynchronously,

+               | go into WRITING state.

+               | For any unexpected problems, go into DISCONNECTING state.

+-------------------------------------------------------------------------

+ WRITING       | Get the result of the async write request.

+               | If write is done, go into WRITE_DONE state.

+               | For any unexpected problems, go into DISCONNECTING state.

+-------------------------------------------------------------------------

+ WRITE_DONE    | Read from the pipe asynchronously (for an ACK).

+               | If read request is successfully queued up asynchonously,

+               | go into READING_ACK state.

+               | For any unexpected problems, go into DISCONNECTING state.

+-------------------------------------------------------------------------

+ READING_ACK   | Get the result of the async read request.

+               | If read is done, perform action for successful client

+               | connection.

+               | Go into DISCONNECTING state.

+-------------------------------------------------------------------------

+ DISCONNECTING | Disconnect from the pipe, reset the event and go into

+               | INITIAL state and signal the event again. If anything

+               | fails, go into ERROR state.

+=========================================================================