src/stacktrace_windows-inl.h

   1 // Copyright (c) 2000 - 2007, Google Inc.
   2 // All rights reserved.
   3 //
   4 // Redistribution and use in source and binary forms, with or without
   5 // modification, are permitted provided that the following conditions are
   6 // met:
   7 //
   8 //     * Redistributions of source code must retain the above copyright
   9 // notice, this list of conditions and the following disclaimer.
  10 //     * Redistributions in binary form must reproduce the above
  11 // copyright notice, this list of conditions and the following disclaimer
  12 // in the documentation and/or other materials provided with the
  13 // distribution.
  14 //     * Neither the name of Google Inc. nor the names of its
  15 // contributors may be used to endorse or promote products derived from
  16 // this software without specific prior written permission.
  17 //
  18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29 //
  30 // Author: Andrew Schwartzmeyer
  31 //
  32 // Windows implementation - just use CaptureStackBackTrace
  33
  34 #include "port.h"
  35 #include "stacktrace.h"
  36 #include "Dbghelp.h"
  37 #include <vector>
  38
  39 _START_GOOGLE_NAMESPACE_
  40
  41 static bool ready_to_run = false;
  42 class StackTraceInit {
  43 public:
  44   HANDLE hProcess;
  45   StackTraceInit() {
  46     // Initialize the symbol handler
  47     // https://msdn.microsoft.com/en-us/library/windows/desktop/ms680344(v=vs.85).aspx
  48     hProcess = GetCurrentProcess();
  49     SymSetOptions(SYMOPT_UNDNAME | SYMOPT_DEFERRED_LOADS);
  50     SymInitialize(hProcess, NULL, true);
  51     ready_to_run = true;
  52   }
  53   ~StackTraceInit() {
  54     SymCleanup(hProcess);
  55     ready_to_run = false;
  56   }
  57 };
  58
  59 static const StackTraceInit module_initializer;  // Force initialization
  60
  61 // If you change this function, also change GetStackFrames below.
  62 int GetStackTrace(void** result, int max_depth, int skip_count) {
  63   if (!ready_to_run) {
  64     return 0;
  65   }
  66   skip_count++;  // we want to skip the current frame as well
  67   if (max_depth > 64) {
  68     max_depth = 64;
  69   }
  70   std::vector<void*> stack(max_depth);
  71   // This API is thread-safe (moreover it walks only the current thread).
  72   int size = CaptureStackBackTrace(skip_count, max_depth, &stack[0], NULL);
  73   for (int i = 0; i < size; ++i) {
  74     // Resolve symbol information from address.
  75     char buffer[sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(TCHAR)];
  76     SYMBOL_INFO* symbol = reinterpret_cast<SYMBOL_INFO*>(buffer);
  77     symbol->SizeOfStruct = sizeof(SYMBOL_INFO);
  78     symbol->MaxNameLen = MAX_SYM_NAME;
  79     SymFromAddr(module_initializer.hProcess, reinterpret_cast<DWORD64>(stack[i]), 0, symbol);
  80     result[i] = stack[i];
  81   }
  82
  83   return size;
  84 }
  85
  86 _END_GOOGLE_NAMESPACE_