Skip to content
Permalink
Browse files
[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.


Canonical link: https://commits.webkit.org/205729@main
git-svn-id: https://svn.webkit.org/repository/webkit/trunk@237382 268f45cc-cd09-0410-ab3c-d52691b4dbfc
  • Loading branch information
c29reid committed Oct 24, 2018
1 parent ec5c7b9 commit 7e1b8b2ecff8dfa89a2a48edfb1d9a38a754ead1
Showing with 151 additions and 0 deletions.
  1. +24 −0 Source/WTF/ChangeLog
  2. +1 −0 Source/WTF/wtf/CMakeLists.txt
  3. +2 −0 Source/WTF/wtf/PlatformWin.cmake
  4. +11 −0 Source/WTF/wtf/StackTrace.cpp
  5. +72 −0 Source/WTF/wtf/win/DbgHelperWin.cpp
  6. +41 −0 Source/WTF/wtf/win/DbgHelperWin.h
@@ -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
@@ -499,6 +499,7 @@ if (WIN32)
ThreadingWin.cpp
)
list(APPEND WTF_LIBRARIES
DbgHelp
winmm
)
else ()
@@ -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
@@ -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)
@@ -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
@@ -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

0 comments on commit 7e1b8b2

Please sign in to comment.