[Win] Add function call name information to stack traces
authorchris.reid@sony.com <chris.reid@sony.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Wed, 24 Oct 2018 14:27:13 +0000 (14:27 +0000)
committerchris.reid@sony.com <chris.reid@sony.com@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Wed, 24 Oct 2018 14:27:13 +0000 (14:27 +0000)
https://bugs.webkit.org/show_bug.cgi?id=190761

Reviewed by Fujii Hironori.

Add symbol information to stack traces using dbghelp.dll
This library will use symbols files from these sources:
    - The current working directory
    - The directory containing the application's executable
    - _NT_SYMBOL_PATH environment variable
    - _NT_ALTERNATE_SYMBOL_PATH environment variable

This functionality is currently only enabled in debug mode since dbghelp is not threadsafe.
The DbgHelper class attempts to synchronize calls to dbghelp.dll but external code
can still attempt to call the library at the same time as WebKit.

* wtf/CMakeLists.txt:
* wtf/PlatformWin.cmake:
* wtf/StackTrace.cpp:
* wtf/win/DbgHelperWin.cpp: Added.
* wtf/win/DbgHelperWin.h: Added.

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@237382 268f45cc-cd09-0410-ab3c-d52691b4dbfc

Source/WTF/ChangeLog
Source/WTF/wtf/CMakeLists.txt
Source/WTF/wtf/PlatformWin.cmake
Source/WTF/wtf/StackTrace.cpp
Source/WTF/wtf/win/DbgHelperWin.cpp [new file with mode: 0644]
Source/WTF/wtf/win/DbgHelperWin.h [new file with mode: 0644]

index a1809cf..219274b 100644 (file)
@@ -1,3 +1,27 @@
+2018-10-24  Christopher Reid  <chris.reid@sony.com>
+
+        [Win] Add function call name information to stack traces
+        https://bugs.webkit.org/show_bug.cgi?id=190761
+
+        Reviewed by Fujii Hironori.
+
+        Add symbol information to stack traces using dbghelp.dll
+        This library will use symbols files from these sources:
+            - The current working directory
+            - The directory containing the application's executable
+            - _NT_SYMBOL_PATH environment variable
+            - _NT_ALTERNATE_SYMBOL_PATH environment variable
+
+        This functionality is currently only enabled in debug mode since dbghelp is not threadsafe.
+        The DbgHelper class attempts to synchronize calls to dbghelp.dll but external code
+        can still attempt to call the library at the same time as WebKit.
+
+        * wtf/CMakeLists.txt:
+        * wtf/PlatformWin.cmake:
+        * wtf/StackTrace.cpp:
+        * wtf/win/DbgHelperWin.cpp: Added.
+        * wtf/win/DbgHelperWin.h: Added.
+
 2018-10-22  Alexey Proskuryakov  <ap@apple.com>
 
         Really prevent PLATFORM(IOS) from being used
index 3ee5c48..6d3ceb9 100644 (file)
@@ -499,6 +499,7 @@ if (WIN32)
         ThreadingWin.cpp
     )
     list(APPEND WTF_LIBRARIES
+        DbgHelp
         winmm
     )
 else ()
index 4685196..5f2275a 100644 (file)
@@ -1,6 +1,7 @@
 list(APPEND WTF_PUBLIC_HEADERS
     text/win/WCharStringExtras.h
 
+    win/DbgHelperWin.h
     win/GDIObject.h
     win/SoftLinking.h
     win/Win32Handle.h
@@ -10,6 +11,7 @@ list(APPEND WTF_SOURCES
     text/win/TextBreakIteratorInternalICUWin.cpp
 
     win/CPUTimeWin.cpp
+    win/DbgHelperWin.cpp
     win/LanguageWin.cpp
     win/MainThreadWin.cpp
     win/MemoryFootprintWin.cpp
index 7a0d99c..becf22a 100644 (file)
@@ -41,6 +41,7 @@
 
 #if OS(WINDOWS)
 #include <windows.h>
+#include <wtf/win/DbgHelperWin.h>
 #endif
 
 void WTFGetBacktrace(void** stack, int* size)
@@ -110,6 +111,13 @@ void StackTrace::dump(PrintStream& out, const char* indentString) const
     char** symbols = backtrace_symbols(stack, m_size);
     if (!symbols)
         return;
+#elif OS(WINDOWS)
+    HANDLE hProc = GetCurrentProcess();
+    uint8_t symbolData[sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(TCHAR)] = { 0 };
+    auto symbolInfo = reinterpret_cast<SYMBOL_INFO*>(symbolData);
+
+    symbolInfo->SizeOfStruct = sizeof(SYMBOL_INFO);
+    symbolInfo->MaxNameLen = MAX_SYM_NAME;
 #endif
 
     if (!indentString)
@@ -125,6 +133,9 @@ void StackTrace::dump(PrintStream& out, const char* indentString) const
             mangledName = demangled->mangledName();
             cxaDemangled = demangled->demangledName();
         }
+#elif OS(WINDOWS)
+        if (DbgHelper::SymFromAddress(hProc, reinterpret_cast<DWORD64>(stack[i]), 0, symbolInfo))
+            mangledName = symbolInfo->Name;
 #endif
         const int frameNumber = i + 1;
         if (mangledName || cxaDemangled)
diff --git a/Source/WTF/wtf/win/DbgHelperWin.cpp b/Source/WTF/wtf/win/DbgHelperWin.cpp
new file mode 100644 (file)
index 0000000..559daab
--- /dev/null
@@ -0,0 +1,72 @@
+/*
+ * Copyright (C) 2018 Sony Interactive Entertainment Inc.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS 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 APPLE OR ITS 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.
+ */
+
+#include "config.h"
+#include <wtf/win/DbgHelperWin.h>
+
+#include <mutex>
+
+namespace WTF {
+
+namespace DbgHelper {
+
+// We are only calling these DbgHelp.dll functions in debug mode since the library is not threadsafe.
+// It's possible for external code to call the library at the same time as WebKit and cause memory corruption.
+
+#if !defined(NDEBUG)
+
+static Lock callMutex;
+
+static void initializeSymbols(HANDLE hProc)
+{
+    static std::once_flag onceFlag;
+    std::call_once(onceFlag, [&]() {
+        if (!SymInitialize(hProc, nullptr, TRUE))
+            LOG_ERROR("Failed to initialze symbol information %d", GetLastError());
+    });
+}
+
+bool SymFromAddress(HANDLE hProc, DWORD64 address, DWORD64* displacement, SYMBOL_INFO* symbolInfo)
+{
+    LockHolder lock(callMutex);
+    initializeSymbols(hProc);
+
+    bool success = ::SymFromAddr(hProc, address, displacement, symbolInfo);
+    if (success)
+        symbolInfo->Name[symbolInfo->NameLen] = '\0';
+    return success;
+}
+
+#else
+
+bool SymFromAddress(HANDLE, DWORD64, DWORD64*, SYMBOL_INFO*)
+{
+    return false;
+}
+
+#endif // !defined(NDEBUG)
+
+} // namespace DbgHelper
+
+} // namespace WTF
diff --git a/Source/WTF/wtf/win/DbgHelperWin.h b/Source/WTF/wtf/win/DbgHelperWin.h
new file mode 100644 (file)
index 0000000..12d0134
--- /dev/null
@@ -0,0 +1,41 @@
+/*
+ * Copyright (C) 2018 Sony Interactive Entertainment Inc.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. 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.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS 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 APPLE OR ITS 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.
+ */
+
+#pragma once
+
+#include <windows.h>
+#include <wtf/Lock.h>
+#include <wtf/Noncopyable.h>
+
+#include <dbghelp.h>
+
+namespace WTF {
+
+namespace DbgHelper {
+
+bool SymFromAddress(HANDLE hProc, DWORD64 address, DWORD64* displacement, SYMBOL_INFO*);
+
+};
+
+} // namespace WTF