Breakpad coverage for chrome_elf start up

chrome_elf/breakpad.cc

Index: chrome_elf/breakpad.cc
diff --git a/remoting/base/breakpad_win.cc b/chrome_elf/breakpad.cc
similarity index 69%
copy from remoting/base/breakpad_win.cc
copy to chrome_elf/breakpad.cc
index 9e544f0517dbc63b8c12f7bc970541fa5ef45219..9bef87db04da096d2554e972835e20a9d01184d9 100644
--- a/remoting/base/breakpad_win.cc
+++ b/chrome_elf/breakpad.cc
@@ -1,210 +1,185 @@
-// Copyright (c) 2012 The Chromium Authors. All rights reserved.
-// Use of this source code is governed by a BSD-style license that can be
-// found in the LICENSE file.
-
-// This module contains the necessary code to register the Breakpad exception
-// handler. This implementation is based on Chrome crash reporting code. See:
-//   - src/components/breakpad/app/breakpad_win.cc
-//   - src/chrome/installer/setup/setup_main.cc
-
-#include "remoting/base/breakpad.h"
-
-#include <windows.h>
-#include <string>
-
-#include "base/atomicops.h"
-#include "base/file_version_info.h"
-#include "base/lazy_instance.h"
-#include "base/logging.h"
-#include "base/memory/scoped_ptr.h"
-#include "base/process/memory.h"
-#include "base/strings/utf_string_conversions.h"
-#include "base/win/wrapped_window_proc.h"
-#include "breakpad/src/client/windows/handler/exception_handler.h"
-
-namespace remoting {
-void InitializeCrashReportingForTest(const wchar_t* pipe_name);
-}  // namespace remoting
-
-namespace {
-
-const wchar_t kBreakpadProductName[] = L"Chromoting";
-const wchar_t kBreakpadVersionEntry[] = L"ver";
-const wchar_t kBreakpadVersionDefault[] = L"0.1.0.0";
-const wchar_t kBreakpadProdEntry[] = L"prod";
-const wchar_t kBreakpadPlatformEntry[] = L"plat";
-const wchar_t kBreakpadPlatformWin32[] = L"Win32";
-
-// The protocol for connecting to the out-of-process Breakpad crash
-// reporter is different for x86-32 and x86-64: the message sizes
-// are different because the message struct contains a pointer.  As
-// a result, there are two different named pipes to connect to.  The
-// 64-bit one is distinguished with an "-x64" suffix.
-#if defined(_WIN64)
-const wchar_t kGoogleUpdatePipeName[] =
-    L"\\\\.\\pipe\\GoogleCrashServices\\S-1-5-18-x64";
-#else
-const wchar_t kGoogleUpdatePipeName[] =
-    L"\\\\.\\pipe\\GoogleCrashServices\\S-1-5-18";
-#endif
-
-using base::subtle::AtomicWord;
-using base::subtle::NoBarrier_CompareAndSwap;
-
-class BreakpadWin {
- public:
-  BreakpadWin();
-  ~BreakpadWin();
-
-  static BreakpadWin* GetInstance();
-
- private:
-  // Returns the Custom information to be used for crash reporting.
-  google_breakpad::CustomClientInfo* GetCustomInfo();
-
-  // This callback is executed when the process has crashed and *before*
-  // the crash dump is created. To prevent duplicate crash reports we
-  // make every thread calling this method, except the very first one,
-  // go to sleep.
-  static bool OnExceptionCallback(void* context,
-                                  EXCEPTION_POINTERS* exinfo,
-                                  MDRawAssertionInfo* assertion);
-
-  // Crashes the process after generating a dump for the provided exception.
-  // Note that the crash reporter should be initialized before calling this
-  // function for it to do anything.
-  static int OnWindowProcedureException(EXCEPTION_POINTERS* exinfo);
-
-  // Breakpad's exception handler.
-  scoped_ptr<google_breakpad::ExceptionHandler> breakpad_;
-
-  // This flag is used to indicate that an exception is already being handled.
-  volatile AtomicWord handling_exception_;
-
-  // The testing hook below allows overriding the crash server pipe name.
-  static const wchar_t* pipe_name_;
-
-  friend void ::remoting::InitializeCrashReportingForTest(const wchar_t*);
-
-  DISALLOW_COPY_AND_ASSIGN(BreakpadWin);
-};
-
-// |LazyInstance| is used to guarantee that the exception handler will be
-// initialized exactly once.
-// N.B. LazyInstance does not allow this to be a static member of the class.
-static base::LazyInstance<BreakpadWin>::Leaky g_instance =
-    LAZY_INSTANCE_INITIALIZER;
-
-const wchar_t* BreakpadWin::pipe_name_ = kGoogleUpdatePipeName;
-
-BreakpadWin::BreakpadWin() : handling_exception_(0) {
-  // Disable the message box for assertions.
-  _CrtSetReportMode(_CRT_ASSERT, 0);
-
-  // Get the alternate dump directory. We use the temp path.
-  // N.B. We don't use base::GetTempDir() here to avoid running more code then
-  //      necessary before crashes can be properly reported.
-  wchar_t temp_directory[MAX_PATH + 1] = { 0 };
-  DWORD length = GetTempPath(MAX_PATH, temp_directory);
-  if (length == 0)
-    return;
-
-  // Minidump with stacks, PEB, TEBs and unloaded module list.
-  MINIDUMP_TYPE dump_type = static_cast<MINIDUMP_TYPE>(
-      MiniDumpWithProcessThreadData |
-      MiniDumpWithUnloadedModules);
-  breakpad_.reset(
-      new google_breakpad::ExceptionHandler(
-          temp_directory, &OnExceptionCallback, NULL, NULL,
-          google_breakpad::ExceptionHandler::HANDLER_ALL, dump_type,
-          pipe_name_, GetCustomInfo()));
-
-  if (breakpad_->IsOutOfProcess()) {
-    // Tells breakpad to handle breakpoint and single step exceptions.
-    breakpad_->set_handle_debug_exceptions(true);
-  }
-
-  // Catch exceptions thrown from a window procedure.
-  base::win::WinProcExceptionFilter exception_filter =
-      base::win::SetWinProcExceptionFilter(&OnWindowProcedureException);
-  CHECK(!exception_filter);
-}
-
-BreakpadWin::~BreakpadWin() {
-  // This object should be leaked so that crashes occurred during the process
-  // shutdown will be caught.
-  NOTREACHED();
-}
-
-// static
-BreakpadWin* BreakpadWin::GetInstance() {
-  return &g_instance.Get();
-}
-
-// Returns the Custom information to be used for crash reporting.
-google_breakpad::CustomClientInfo* BreakpadWin::GetCustomInfo() {
-  HMODULE binary = base::GetModuleFromAddress(
-      reinterpret_cast<void*>(&remoting::InitializeCrashReporting));
-  scoped_ptr<FileVersionInfo> version_info(
-      FileVersionInfo::CreateFileVersionInfoForModule(binary));
-
-  static wchar_t version[64];
-  if (version_info.get()) {
-    wcscpy_s(version,
-             base::UTF16ToWide(version_info->product_version()).c_str());
-  } else {
-    wcscpy_s(version, kBreakpadVersionDefault);
-  }
-
-  static google_breakpad::CustomInfoEntry ver_entry(
-      kBreakpadVersionEntry, version);
-  static google_breakpad::CustomInfoEntry prod_entry(
-      kBreakpadProdEntry, kBreakpadProductName);
-  static google_breakpad::CustomInfoEntry plat_entry(
-      kBreakpadPlatformEntry, kBreakpadPlatformWin32);
-  static google_breakpad::CustomInfoEntry entries[] = {
-      ver_entry, prod_entry, plat_entry  };
-  static google_breakpad::CustomClientInfo custom_info = {
-      entries, arraysize(entries) };
-  return &custom_info;
-}
-
-// static
-bool BreakpadWin::OnExceptionCallback(void* /* context */,
-                                      EXCEPTION_POINTERS* /* exinfo */,
-                                      MDRawAssertionInfo* /* assertion */) {
-  BreakpadWin* self = BreakpadWin::GetInstance();
-  if (NoBarrier_CompareAndSwap(&self->handling_exception_, 0, 1) != 0) {
-    // Capture every thread except the first one in the sleep. We don't
-    // want multiple threads to concurrently report exceptions.
-    ::Sleep(INFINITE);
-  }
-  return true;
-}
-
-// static
-int BreakpadWin::OnWindowProcedureException(EXCEPTION_POINTERS* exinfo) {
-  BreakpadWin* self = BreakpadWin::GetInstance();
-  if (self->breakpad_.get() != NULL) {
-    self->breakpad_->WriteMinidumpForException(exinfo);
-    TerminateProcess(GetCurrentProcess(),
-                     exinfo->ExceptionRecord->ExceptionCode);
-  }
-  return EXCEPTION_CONTINUE_SEARCH;
-}
-
-}  // namespace
-
-namespace remoting {
-
-void InitializeCrashReporting() {
-  // Touch the object to make sure it is initialized.
-  BreakpadWin::GetInstance();
-}
-
-void InitializeCrashReportingForTest(const wchar_t* pipe_name) {
-  BreakpadWin::pipe_name_ = pipe_name;
-  InitializeCrashReporting();
-}
-
-}  // namespace remoting
+// Copyright (c) 2014 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+// This module contains the necessary code to register the Breakpad exception
+// handler. This implementation is based on Chrome crash reporting code.
+
+#include "chrome_elf/breakpad.h"
+
+#include <string>
+
+#include "base/atomicops.h"
+#include "base/lazy_instance.h"
+#include "base/memory/scoped_ptr.h"
+#include "base/strings/utf_string_conversions.h"
+#include "breakpad/src/client/windows/crash_generation/crash_generation_client.h"
+#include "breakpad/src/client/windows/handler/exception_handler.h"
+#include "version.h"  // NOLINT
+
+namespace {
+
+const wchar_t kBreakpadProductName[] = L"ChromeElf";
+const wchar_t kBreakpadVersionEntry[] = L"ver";
+const wchar_t kBreakpadVersionDefault[] = L"0.1.0.0";
+const wchar_t kBreakpadProdEntry[] = L"prod";
+const wchar_t kBreakpadPlatformEntry[] = L"plat";
+const wchar_t kBreakpadPlatformWin32[] = L"Win32";
+
+// TODO(caitkp): figure out what these should be. Current pipe works with local
+// instance of crash_service.exe.
+// The protocol for connecting to the out-of-process Breakpad crash
+// reporter is different for x86-32 and x86-64: the message sizes
+// are different because the message struct contains a pointer.  As
+// a result, there are two different named pipes to connect to.  The
+// 64-bit one is distinguished with an "-x64" suffix.
+#if defined(_WIN64)
+const wchar_t kGoogleUpdatePipeName[] =
+    L"\\\\.\\pipe\\ChromeCrashServices";
+    //L"\\\\.\\pipe\\GoogleCrashServices\\S-1-5-18-x64";
+#else
+const wchar_t kGoogleUpdatePipeName[] =
+    L"\\\\.\\pipe\\ChromeCrashServices";
+    //L"\\\\.\\pipe\\GoogleCrashServices\\S-1-5-18";
+#endif
+
+using base::subtle::AtomicWord;
+using base::subtle::NoBarrier_CompareAndSwap;
+
+class BreakpadWin {
+ public:
+  BreakpadWin();
+  ~BreakpadWin();
+
+  static BreakpadWin* GetInstance();
+
+  // Generates dump on request for given |exinfo|.
+  static int OnDumpRequested(EXCEPTION_POINTERS* exinfo);
+
+ private:
+  // Returns the Custom information to be used for crash reporting.
+  google_breakpad::CustomClientInfo* GetCustomInfo();
+
+  // This callback is executed when the process has crashed and *before*
+  // the crash dump is created. To prevent duplicate crash reports we
+  // make every thread calling this method, except the very first one,
+  // go to sleep.
+  static bool OnExceptionCallback(void* context,
+                                  EXCEPTION_POINTERS* exinfo,
+                                  MDRawAssertionInfo* assertion);
+
+  // Breakpad's exception handler.
+  scoped_ptr<google_breakpad::ExceptionHandler> breakpad_;
+
+  // This flag is used to indicate that an exception is already being handled.
+  volatile AtomicWord handling_exception_;
+
+  // The testing hook below allows overriding the crash server pipe name.
+  static const wchar_t* pipe_name_;
+
+  DISALLOW_COPY_AND_ASSIGN(BreakpadWin);
+};
+
+// |LazyInstance| is used to guarantee that the exception handler will be
+// initialized exactly once.
+// N.B. LazyInstance does not allow this to be a static member of the class.
+static base::LazyInstance<BreakpadWin>::Leaky g_instance =
+    LAZY_INSTANCE_INITIALIZER;
+
+const wchar_t* BreakpadWin::pipe_name_ = kGoogleUpdatePipeName;
+
+BreakpadWin::BreakpadWin() : handling_exception_(0) {
+  // Disable the message box for assertions.
+  _CrtSetReportMode(_CRT_ASSERT, 0);
+
+  // Get the alternate dump directory. We use the temp path.
+  // N.B. We don't use base::GetTempDir() here to avoid running more code then
+  //      necessary before crashes can be properly reported.
+  wchar_t temp_directory[MAX_PATH + 1] = { 0 };
+  DWORD length = GetTempPath(MAX_PATH, temp_directory);
+  if (length == 0)
+    return;
+
+  // Minidump with stacks, PEB, TEBs and unloaded module list.
+  MINIDUMP_TYPE dump_type = static_cast<MINIDUMP_TYPE>(
+    MiniDumpWithProcessThreadData |  // Get PEB and TEB.
+    MiniDumpWithUnloadedModules |  // Get unloaded modules when available.
+    MiniDumpWithIndirectlyReferencedMemory);  // Get memory referenced by stack.
+
+  breakpad_.reset(new google_breakpad::ExceptionHandler(
+      temp_directory,
+      &OnExceptionCallback,
+      NULL,
+      NULL,
+      google_breakpad::ExceptionHandler::HANDLER_ALL,
+      dump_type,
+      pipe_name_,
+      GetCustomInfo()));
+
+  if (breakpad_->IsOutOfProcess()) {
+    // Tells breakpad to handle breakpoint and single step exceptions.
+    breakpad_->set_handle_debug_exceptions(true);
+  }
+}
+
+BreakpadWin::~BreakpadWin() {
+  // This object should be leaked so that crashes occurred during the process
+  // shutdown will be caught.
+  NOTREACHED();
+}
+
+// static
+BreakpadWin* BreakpadWin::GetInstance() {
+  return &g_instance.Get();
+}
+
+// static
+int BreakpadWin::OnDumpRequested(EXCEPTION_POINTERS* exinfo) {
+  BreakpadWin* self = BreakpadWin::GetInstance();
+  if (self->breakpad_.get() != NULL) {
+    self->breakpad_->WriteMinidumpForException(exinfo);
+    // TODO(caitkp): Is terminating the right thing to do here?

[Sigurður Ásgeirsson, 2014/02/05 13:58:33]

It's six of on, half a dozen of the other. If you continue the search here while
inside DllMain, the loader will catch the exception.
If this is at DLL_ATTACH time, the process will fail to run.

[Cait (Slow), 2014/02/07 15:32:02]

Done -- I'll grab the dump and let the loader take it from there then.

+    TerminateProcess(GetCurrentProcess(),
+                     exinfo->ExceptionRecord->ExceptionCode);
+  }
+  return EXCEPTION_CONTINUE_SEARCH;
+}
+
+// Returns the Custom information to be used for crash reporting.
+google_breakpad::CustomClientInfo* BreakpadWin::GetCustomInfo() {
+  static google_breakpad::CustomInfoEntry ver_entry(
+      kBreakpadVersionEntry, TEXT(CHROME_VERSION_STRING));
+  static google_breakpad::CustomInfoEntry prod_entry(
+      kBreakpadProdEntry, kBreakpadProductName);
+  static google_breakpad::CustomInfoEntry plat_entry(
+      kBreakpadPlatformEntry, kBreakpadPlatformWin32);
+  static google_breakpad::CustomInfoEntry entries[] = {
+      ver_entry, prod_entry, plat_entry  };
+  static google_breakpad::CustomClientInfo custom_info = {
+      entries, arraysize(entries) };
+  return &custom_info;
+}
+
+// static
+bool BreakpadWin::OnExceptionCallback(void* /* context */,
+                                      EXCEPTION_POINTERS* /* exinfo */,
+                                      MDRawAssertionInfo* /* assertion */) {
+  BreakpadWin* self = BreakpadWin::GetInstance();
+  if (NoBarrier_CompareAndSwap(&self->handling_exception_, 0, 1) != 0) {
+    // Capture every thread except the first one in the sleep. We don't
+    // want multiple threads to concurrently report exceptions.
+    ::Sleep(INFINITE);
+  }
+  return true;
+}
+
+}  // namespace
+
+int GenerateCrashDump(EXCEPTION_POINTERS* exinfo) {
+  return BreakpadWin::OnDumpRequested(exinfo);

[Sigurður Ásgeirsson, 2014/02/05 13:58:33]

As we discussed, you may want to filter out debug break and single step
exceptions here - have you tested this under debugger?

[Cait (Slow), 2014/02/07 15:32:02]

I tested under windbg and it seemed fine -- no harm in adding filters though.

+}
+
+void InitializeCrashReporting() {
+  // Touch the object to make sure it is initialized.
+  BreakpadWin::GetInstance();
+}