Move debug-related stuff from base to the base/debug directory and use the...

base/debug/debugger_win.cc

-// Copyright (c) 2006-2009 The Chromium Authors. All rights reserved.
+// Copyright (c) 2010 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.
 
-#include "base/debug_util.h"
+#include "base/debug/debugger.h"
 
 #include <windows.h>
 #include <dbghelp.h>
 
-#include <iostream>
+#include "base/basictypes.h"
+#include "base/debug_util.h"
+#include "base/logging.h"
 
-#include "base/basictypes.h"
-#include "base/lock.h"
-#include "base/logging.h"
-#include "base/singleton.h"
+namespace base {
+namespace debug {
 
 namespace {
 
 // Minimalist key reader.
 // Note: Does not use the CRT.
 bool RegReadString(HKEY root, const wchar_t* subkey,
                    const wchar_t* value_name, wchar_t* buffer, int* len) {
   HKEY key = NULL;
   DWORD res = RegOpenKeyEx(root, subkey, 0, KEY_READ, &key);
   if (ERROR_SUCCESS != res || key == NULL)
@@ skipping 35 matching lines @@
       i += 2;
     } else {
       if (current_output_len >= output_len)
         return false;
       output[current_output_len] = input[i];
     }
   }
   return true;
 }
 
-// SymbolContext is a threadsafe singleton that wraps the DbgHelp Sym* family
-// of functions.  The Sym* family of functions may only be invoked by one
-// thread at a time.  SymbolContext code may access a symbol server over the
-// network while holding the lock for this singleton.  In the case of high
-// latency, this code will adversly affect performance.
-//
-// There is also a known issue where this backtrace code can interact
-// badly with breakpad if breakpad is invoked in a separate thread while
-// we are using the Sym* functions.  This is because breakpad does now
-// share a lock with this function.  See this related bug:
-//
-//   http://code.google.com/p/google-breakpad/issues/detail?id=311
-//
-// This is a very unlikely edge case, and the current solution is to
-// just ignore it.
-class SymbolContext {
- public:
-  static SymbolContext* Get() {
-    // We use a leaky singleton because code may call this during process
-    // termination.
-    return
-      Singleton<SymbolContext, LeakySingletonTraits<SymbolContext> >::get();
-  }
-
-  // Returns the error code of a failed initialization.
-  DWORD init_error() const {
-    return init_error_;
-  }
-
-  // For the given trace, attempts to resolve the symbols, and output a trace
-  // to the ostream os.  The format for each line of the backtrace is:
-  //
-  //    <tab>SymbolName[0xAddress+Offset] (FileName:LineNo)
-  //
-  // This function should only be called if Init() has been called.  We do not
-  // LOG(FATAL) here because this code is called might be triggered by a
-  // LOG(FATAL) itself.
-  void OutputTraceToStream(const void* const* trace,
-                           int count,
-                           std::ostream* os) {
-    AutoLock lock(lock_);
-
-    for (size_t i = 0; (i < count) && os->good(); ++i) {
-      const int kMaxNameLength = 256;
-      DWORD_PTR frame = reinterpret_cast<DWORD_PTR>(trace[i]);
-
-      // Code adapted from MSDN example:
-      // http://msdn.microsoft.com/en-us/library/ms680578(VS.85).aspx
-      ULONG64 buffer[
-        (sizeof(SYMBOL_INFO) +
-          kMaxNameLength * sizeof(wchar_t) +
-          sizeof(ULONG64) - 1) /
-        sizeof(ULONG64)];
-      memset(buffer, 0, sizeof(buffer));
-
-      // Initialize symbol information retrieval structures.
-      DWORD64 sym_displacement = 0;
-      PSYMBOL_INFO symbol = reinterpret_cast<PSYMBOL_INFO>(&buffer[0]);
-      symbol->SizeOfStruct = sizeof(SYMBOL_INFO);
-      symbol->MaxNameLen = kMaxNameLength - 1;
-      BOOL has_symbol = SymFromAddr(GetCurrentProcess(), frame,
-                                    &sym_displacement, symbol);
-
-      // Attempt to retrieve line number information.
-      DWORD line_displacement = 0;
-      IMAGEHLP_LINE64 line = {};
-      line.SizeOfStruct = sizeof(IMAGEHLP_LINE64);
-      BOOL has_line = SymGetLineFromAddr64(GetCurrentProcess(), frame,
-                                           &line_displacement, &line);
-
-      // Output the backtrace line.
-      (*os) << "\t";
-      if (has_symbol) {
-        (*os) << symbol->Name << " [0x" << trace[i] << "+"
-              << sym_displacement << "]";
-      } else {
-        // If there is no symbol informtion, add a spacer.
-        (*os) << "(No symbol) [0x" << trace[i] << "]";
-      }
-      if (has_line) {
-        (*os) << " (" << line.FileName << ":" << line.LineNumber << ")";
-      }
-      (*os) << "\n";
-    }
-  }
-
- private:
-  friend struct DefaultSingletonTraits<SymbolContext>;
-
-  SymbolContext() : init_error_(ERROR_SUCCESS) {
-    // Initializes the symbols for the process.
-    // Defer symbol load until they're needed, use undecorated names, and
-    // get line numbers.
-    SymSetOptions(SYMOPT_DEFERRED_LOADS |
-                  SYMOPT_UNDNAME |
-                  SYMOPT_LOAD_LINES);
-    if (SymInitialize(GetCurrentProcess(), NULL, TRUE)) {
-      init_error_ = ERROR_SUCCESS;
-    } else {
-      init_error_ = GetLastError();
-      // TODO(awong): Handle error: SymInitialize can fail with
-      // ERROR_INVALID_PARAMETER.
-      // When it fails, we should not call debugbreak since it kills the current
-      // process (prevents future tests from running or kills the browser
-      // process).
-      DLOG(ERROR) << "SymInitialize failed: " << init_error_;
-    }
-  }
-
-  DWORD init_error_;
-  Lock lock_;
-  DISALLOW_COPY_AND_ASSIGN(SymbolContext);
-};
-
 }  // namespace
 
 // Note: Does not use the CRT.
-bool DebugUtil::SpawnDebuggerOnProcess(unsigned process_id) {
+bool SpawnDebuggerOnProcess(unsigned process_id) {
   wchar_t reg_value[1026];
   int len = arraysize(reg_value);
   if (RegReadString(HKEY_LOCAL_MACHINE,
       L"SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\AeDebug",
       L"Debugger", reg_value, &len)) {
     wchar_t command_line[1026];
     if (StringReplace(reg_value, process_id, command_line,
                       arraysize(command_line))) {
       // We don't mind if the debugger is present because it will simply fail
       // to attach to this process.
       STARTUPINFO startup_info = {0};
       startup_info.cb = sizeof(startup_info);
       PROCESS_INFORMATION process_info = {0};
 
       if (CreateProcess(NULL, command_line, NULL, NULL, FALSE, 0, NULL, NULL,
                         &startup_info, &process_info)) {
         CloseHandle(process_info.hThread);
         WaitForInputIdle(process_info.hProcess, 10000);
         CloseHandle(process_info.hProcess);
         return true;
       }
     }
   }
   return false;
 }
 
-// static
-bool DebugUtil::BeingDebugged() {
+bool BeingDebugged() {
   return ::IsDebuggerPresent() != 0;
 }
 
-// static
-void DebugUtil::BreakDebugger() {
-  if (suppress_dialogs_)
+void BreakDebugger() {
+  if (DebugUtil::AreDialogsSuppressed())
     _exit(1);
-
   __debugbreak();
 }
 
-StackTrace::StackTrace() {
-  // When walking our own stack, use CaptureStackBackTrace().
-  count_ = CaptureStackBackTrace(0, arraysize(trace_), trace_, NULL);
-}
-
-StackTrace::StackTrace(EXCEPTION_POINTERS* exception_pointers) {
-  // When walking an exception stack, we need to use StackWalk64().
-  count_ = 0;
-  // Initialize stack walking.
-  STACKFRAME64 stack_frame;
-  memset(&stack_frame, 0, sizeof(stack_frame));
-#if defined(_WIN64)
-  int machine_type = IMAGE_FILE_MACHINE_AMD64;
-  stack_frame.AddrPC.Offset = exception_pointers->ContextRecord->Rip;
-  stack_frame.AddrFrame.Offset = exception_pointers->ContextRecord->Rbp;
-  stack_frame.AddrStack.Offset = exception_pointers->ContextRecord->Rsp;
-#else
-  int machine_type = IMAGE_FILE_MACHINE_I386;
-  stack_frame.AddrPC.Offset = exception_pointers->ContextRecord->Eip;
-  stack_frame.AddrFrame.Offset = exception_pointers->ContextRecord->Ebp;
-  stack_frame.AddrStack.Offset = exception_pointers->ContextRecord->Esp;
-#endif
-  stack_frame.AddrPC.Mode = AddrModeFlat;
-  stack_frame.AddrFrame.Mode = AddrModeFlat;
-  stack_frame.AddrStack.Mode = AddrModeFlat;
-  while (StackWalk64(machine_type,
-                     GetCurrentProcess(),
-                     GetCurrentThread(),
-                     &stack_frame,
-                     exception_pointers->ContextRecord,
-                     NULL,
-                     &SymFunctionTableAccess64,
-                     &SymGetModuleBase64,
-                     NULL) &&
-         count_ < arraysize(trace_)) {
-    trace_[count_++] = reinterpret_cast<void*>(stack_frame.AddrPC.Offset);
-  }
-}
-
-void StackTrace::PrintBacktrace() {
-  OutputToStream(&std::cerr);
-}
-
-void StackTrace::OutputToStream(std::ostream* os) {
-  SymbolContext* context = SymbolContext::Get();
-  DWORD error = context->init_error();
-  if (error != ERROR_SUCCESS) {
-    (*os) << "Error initializing symbols (" << error
-          << ").  Dumping unresolved backtrace:\n";
-    for (int i = 0; (i < count_) && os->good(); ++i) {
-      (*os) << "\t" << trace_[i] << "\n";
-    }
-  } else {
-    (*os) << "Backtrace:\n";
-    context->OutputTraceToStream(trace_, count_, os);
-  }
-}
+}  // namespace debug
+}  // namespace base