<div dir="ltr">Please add sanitizer_symbolizer_win.h to SANITIZER_HEADERS in CMakeLists.txt</div><div class="gmail_extra"><br><div class="gmail_quote">On Fri, Mar 6, 2015 at 6:33 AM, Kuba Brecka <span dir="ltr"><<a href="mailto:kuba.brecka@gmail.com" target="_blank">kuba.brecka@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Author: kuba.brecka<br>
Date: Fri Mar 6 08:33:56 2015<br>
New Revision: 231478<br>
<br>
URL: <a href="http://llvm.org/viewvc/llvm-project?rev=231478&view=rev" target="_blank">http://llvm.org/viewvc/llvm-project?rev=231478&view=rev</a><br>
Log:<br>
Symbolizer refactoring: Make WinSymbolizer use SymbolizerTool interface<br>
<br>
Reviewed at <a href="http://reviews.llvm.org/D8089" target="_blank">http://reviews.llvm.org/D8089</a><br>
<br>
<br>
Added:<br>
compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_win.h<br>
Modified:<br>
compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_internal.h<br>
compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_win.cc<br>
<br>
Modified: compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_internal.h<br>
URL: <a href="http://llvm.org/viewvc/llvm-project/compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_internal.h?rev=231478&r1=231477&r2=231478&view=diff" target="_blank">http://llvm.org/viewvc/llvm-project/compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_internal.h?rev=231478&r1=231477&r2=231478&view=diff</a><br>
==============================================================================<br>
--- compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_internal.h (original)<br>
+++ compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_internal.h Fri Mar 6 08:33:56 2015<br>
@@ -26,6 +26,9 @@ const char *ExtractToken(const char *str<br>
const char *ExtractInt(const char *str, const char *delims, int *result);<br>
const char *ExtractUptr(const char *str, const char *delims, uptr *result);<br>
<br>
+// SymbolizerTool is an interface that is implemented by individual "tools"<br>
+// that can perform symbolication (external llvm-symbolizer, libbacktrace,<br>
+// Windows DbgHelp symbolizer, etc.).<br>
class SymbolizerTool {<br>
public:<br>
// POSIXSymbolizer implements a "fallback chain" of symbolizer tools. In a<br>
<br>
Modified: compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_win.cc<br>
URL: <a href="http://llvm.org/viewvc/llvm-project/compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_win.cc?rev=231478&r1=231477&r2=231478&view=diff" target="_blank">http://llvm.org/viewvc/llvm-project/compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_win.cc?rev=231478&r1=231477&r2=231478&view=diff</a><br>
==============================================================================<br>
--- compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_win.cc (original)<br>
+++ compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_win.cc Fri Mar 6 08:33:56 2015<br>
@@ -18,139 +18,171 @@<br>
#include <dbghelp.h><br>
#pragma comment(lib, "dbghelp.lib")<br>
<br>
-#include "sanitizer_symbolizer.h"<br>
+#include "sanitizer_symbolizer_win.h"<br>
+#include "sanitizer_symbolizer_internal.h"<br>
<br>
namespace __sanitizer {<br>
<br>
-class WinSymbolizer : public Symbolizer {<br>
- public:<br>
- WinSymbolizer() : initialized_(false) {}<br>
+namespace {<br>
<br>
- SymbolizedStack *SymbolizePC(uptr addr) override {<br>
- SymbolizedStack *frame = SymbolizedStack::New(addr);<br>
+bool is_dbghelp_initialized = false;<br>
<br>
- BlockingMutexLock l(&dbghelp_mu_);<br>
- InitializeIfNeeded();<br>
+bool TrySymInitialize() {<br>
+ SymSetOptions(SYMOPT_DEFERRED_LOADS | SYMOPT_UNDNAME | SYMOPT_LOAD_LINES);<br>
+ return SymInitialize(GetCurrentProcess(), 0, TRUE);<br>
+ // FIXME: We don't call SymCleanup() on exit yet - should we?<br>
+}<br>
<br>
- // See <a href="http://msdn.microsoft.com/en-us/library/ms680578(VS.85).aspx" target="_blank">http://msdn.microsoft.com/en-us/library/ms680578(VS.85).aspx</a><br>
- char buffer[sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(CHAR)];<br>
- PSYMBOL_INFO symbol = (PSYMBOL_INFO)buffer;<br>
- symbol->SizeOfStruct = sizeof(SYMBOL_INFO);<br>
- symbol->MaxNameLen = MAX_SYM_NAME;<br>
- DWORD64 offset = 0;<br>
- BOOL got_objname = SymFromAddr(GetCurrentProcess(),<br>
- (DWORD64)addr, &offset, symbol);<br>
- if (!got_objname)<br>
- return frame;<br>
-<br>
- DWORD unused;<br>
- IMAGEHLP_LINE64 line_info;<br>
- line_info.SizeOfStruct = sizeof(IMAGEHLP_LINE64);<br>
- BOOL got_fileline = SymGetLineFromAddr64(GetCurrentProcess(), (DWORD64)addr,<br>
- &unused, &line_info);<br>
- frame->info.function = internal_strdup(symbol->Name);<br>
- frame->info.function_offset = (uptr)offset;<br>
- if (got_fileline) {<br>
- frame->info.file = internal_strdup(line_info.FileName);<br>
- frame->info.line = line_info.LineNumber;<br>
- }<br>
-<br>
- IMAGEHLP_MODULE64 mod_info;<br>
- internal_memset(&mod_info, 0, sizeof(mod_info));<br>
- mod_info.SizeOfStruct = sizeof(mod_info);<br>
- if (SymGetModuleInfo64(GetCurrentProcess(), addr, &mod_info))<br>
- frame->info.FillModuleInfo(mod_info.ImageName,<br>
- addr - (uptr)mod_info.BaseOfImage);<br>
- return frame;<br>
+// Initializes DbgHelp library, if it's not yet initialized. Calls to this<br>
+// function should be synchronized with respect to other calls to DbgHelp API<br>
+// (e.g. from WinSymbolizerTool).<br>
+void InitializeDbgHelpIfNeeded() {<br>
+ if (is_dbghelp_initialized)<br>
+ return;<br>
+ if (!TrySymInitialize()) {<br>
+ // OK, maybe the client app has called SymInitialize already.<br>
+ // That's a bit unfortunate for us as all the DbgHelp functions are<br>
+ // single-threaded and we can't coordinate with the app.<br>
+ // FIXME: Can we stop the other threads at this point?<br>
+ // Anyways, we have to reconfigure stuff to make sure that SymInitialize<br>
+ // has all the appropriate options set.<br>
+ // Cross our fingers and reinitialize DbgHelp.<br>
+ Report("*** WARNING: Failed to initialize DbgHelp! ***\n");<br>
+ Report("*** Most likely this means that the app is already ***\n");<br>
+ Report("*** using DbgHelp, possibly with incompatible flags. ***\n");<br>
+ Report("*** Due to technical reasons, symbolization might crash ***\n");<br>
+ Report("*** or produce wrong results. ***\n");<br>
+ SymCleanup(GetCurrentProcess());<br>
+ TrySymInitialize();<br>
}<br>
+ is_dbghelp_initialized = true;<br>
<br>
- bool CanReturnFileLineInfo() override {<br>
+ // When an executable is run from a location different from the one where it<br>
+ // was originally built, we may not see the nearby PDB files.<br>
+ // To work around this, let's append the directory of the main module<br>
+ // to the symbol search path. All the failures below are not fatal.<br>
+ const size_t kSymPathSize = 2048;<br>
+ static wchar_t path_buffer[kSymPathSize + 1 + MAX_PATH];<br>
+ if (!SymGetSearchPathW(GetCurrentProcess(), path_buffer, kSymPathSize)) {<br>
+ Report("*** WARNING: Failed to SymGetSearchPathW ***\n");<br>
+ return;<br>
+ }<br>
+ size_t sz = wcslen(path_buffer);<br>
+ if (sz) {<br>
+ CHECK_EQ(0, wcscat_s(path_buffer, L";"));<br>
+ sz++;<br>
+ }<br>
+ DWORD res = GetModuleFileNameW(NULL, path_buffer + sz, MAX_PATH);<br>
+ if (res == 0 || res == MAX_PATH) {<br>
+ Report("*** WARNING: Failed to getting the EXE directory ***\n");<br>
+ return;<br>
+ }<br>
+ // Write the zero character in place of the last backslash to get the<br>
+ // directory of the main module at the end of path_buffer.<br>
+ wchar_t *last_bslash = wcsrchr(path_buffer + sz, L'\\');<br>
+ CHECK_NE(last_bslash, 0);<br>
+ *last_bslash = L'\0';<br>
+ if (!SymSetSearchPathW(GetCurrentProcess(), path_buffer)) {<br>
+ Report("*** WARNING: Failed to SymSetSearchPathW\n");<br>
+ return;<br>
+ }<br>
+}<br>
+<br>
+} // namespace<br>
+<br>
+bool WinSymbolizerTool::SymbolizePC(uptr addr, SymbolizedStack *frame) {<br>
+ InitializeDbgHelpIfNeeded();<br>
+<br>
+ // See <a href="http://msdn.microsoft.com/en-us/library/ms680578(VS.85).aspx" target="_blank">http://msdn.microsoft.com/en-us/library/ms680578(VS.85).aspx</a><br>
+ char buffer[sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(CHAR)];<br>
+ PSYMBOL_INFO symbol = (PSYMBOL_INFO)buffer;<br>
+ symbol->SizeOfStruct = sizeof(SYMBOL_INFO);<br>
+ symbol->MaxNameLen = MAX_SYM_NAME;<br>
+ DWORD64 offset = 0;<br>
+ BOOL got_objname = SymFromAddr(GetCurrentProcess(),<br>
+ (DWORD64)addr, &offset, symbol);<br>
+ if (!got_objname)<br>
+ return false;<br>
+<br>
+ DWORD unused;<br>
+ IMAGEHLP_LINE64 line_info;<br>
+ line_info.SizeOfStruct = sizeof(IMAGEHLP_LINE64);<br>
+ BOOL got_fileline = SymGetLineFromAddr64(GetCurrentProcess(), (DWORD64)addr,<br>
+ &unused, &line_info);<br>
+ frame->info.function = internal_strdup(symbol->Name);<br>
+ frame->info.function_offset = (uptr)offset;<br>
+ if (got_fileline) {<br>
+ frame->info.file = internal_strdup(line_info.FileName);<br>
+ frame->info.line = line_info.LineNumber;<br>
+ }<br>
+ return true;<br>
+}<br>
+<br>
+const char *WinSymbolizerTool::Demangle(const char *name) {<br>
+ CHECK(is_dbghelp_initialized);<br>
+ static char demangle_buffer[1000];<br>
+ if (name[0] == '\01' &&<br>
+ UnDecorateSymbolName(name + 1, demangle_buffer, sizeof(demangle_buffer),<br>
+ UNDNAME_NAME_ONLY))<br>
+ return demangle_buffer;<br>
+ else<br>
+ return name;<br>
+}<br>
+<br>
+bool FindModuleNameAndOffsetForAddress(uptr addr, const char **module_name,<br>
+ uptr *module_offset) {<br>
+ InitializeDbgHelpIfNeeded();<br>
+<br>
+ IMAGEHLP_MODULE64 mod_info;<br>
+ internal_memset(&mod_info, 0, sizeof(mod_info));<br>
+ mod_info.SizeOfStruct = sizeof(mod_info);<br>
+ if (SymGetModuleInfo64(GetCurrentProcess(), addr, &mod_info)) {<br>
+ *module_name = mod_info.ImageName;<br>
+ *module_offset = addr - (uptr)mod_info.BaseOfImage;<br>
return true;<br>
}<br>
+ return false;<br>
+}<br>
<br>
+// TODO(kuba.brecka): To be merged with POSIXSymbolizer.<br>
+class WinSymbolizer : public Symbolizer {<br>
+ public:<br>
+ explicit WinSymbolizer(SymbolizerTool *tool) : Symbolizer(), tool_(tool) {<br>
+ CHECK(tool);<br>
+ }<br>
+ SymbolizedStack *SymbolizePC(uptr addr) override {<br>
+ BlockingMutexLock l(&mu_);<br>
+ const char *module_name;<br>
+ uptr module_offset;<br>
+ SymbolizedStack *res = SymbolizedStack::New(addr);<br>
+ if (FindModuleNameAndOffsetForAddress(addr, &module_name, &module_offset))<br>
+ res->info.FillModuleInfo(module_name, module_offset);<br>
+ tool_->SymbolizePC(addr, res);<br>
+ return res;<br>
+ }<br>
+ bool CanReturnFileLineInfo() override {<br>
+ return true;<br>
+ }<br>
const char *Demangle(const char *name) override {<br>
- CHECK(initialized_);<br>
- static char demangle_buffer[1000];<br>
- if (name[0] == '\01' &&<br>
- UnDecorateSymbolName(name + 1, demangle_buffer, sizeof(demangle_buffer),<br>
- UNDNAME_NAME_ONLY))<br>
- return demangle_buffer;<br>
- else<br>
- return name;<br>
- }<br>
-<br>
- // FIXME: Implement GetModuleNameAndOffsetForPC().<br>
-<br>
- private:<br>
- void InitializeIfNeeded() {<br>
- if (initialized_)<br>
- return;<br>
- if (!TrySymInitialize()) {<br>
- // OK, maybe the client app has called SymInitialize already.<br>
- // That's a bit unfortunate for us as all the DbgHelp functions are<br>
- // single-threaded and we can't coordinate with the app.<br>
- // FIXME: Can we stop the other threads at this point?<br>
- // Anyways, we have to reconfigure stuff to make sure that SymInitialize<br>
- // has all the appropriate options set.<br>
- // Cross our fingers and reinitialize DbgHelp.<br>
- Report("*** WARNING: Failed to initialize DbgHelp! ***\n");<br>
- Report("*** Most likely this means that the app is already ***\n");<br>
- Report("*** using DbgHelp, possibly with incompatible flags. ***\n");<br>
- Report("*** Due to technical reasons, symbolization might crash ***\n");<br>
- Report("*** or produce wrong results. ***\n");<br>
- SymCleanup(GetCurrentProcess());<br>
- TrySymInitialize();<br>
- }<br>
- initialized_ = true;<br>
-<br>
- // When an executable is run from a location different from the one where it<br>
- // was originally built, we may not see the nearby PDB files.<br>
- // To work around this, let's append the directory of the main module<br>
- // to the symbol search path. All the failures below are not fatal.<br>
- const size_t kSymPathSize = 2048;<br>
- static wchar_t path_buffer[kSymPathSize + 1 + MAX_PATH];<br>
- if (!SymGetSearchPathW(GetCurrentProcess(), path_buffer, kSymPathSize)) {<br>
- Report("*** WARNING: Failed to SymGetSearchPathW ***\n");<br>
- return;<br>
- }<br>
- size_t sz = wcslen(path_buffer);<br>
- if (sz) {<br>
- CHECK_EQ(0, wcscat_s(path_buffer, L";"));<br>
- sz++;<br>
- }<br>
- DWORD res = GetModuleFileNameW(NULL, path_buffer + sz, MAX_PATH);<br>
- if (res == 0 || res == MAX_PATH) {<br>
- Report("*** WARNING: Failed to getting the EXE directory ***\n");<br>
- return;<br>
- }<br>
- // Write the zero character in place of the last backslash to get the<br>
- // directory of the main module at the end of path_buffer.<br>
- wchar_t *last_bslash = wcsrchr(path_buffer + sz, L'\\');<br>
- CHECK_NE(last_bslash, 0);<br>
- *last_bslash = L'\0';<br>
- if (!SymSetSearchPathW(GetCurrentProcess(), path_buffer)) {<br>
- Report("*** WARNING: Failed to SymSetSearchPathW\n");<br>
- return;<br>
- }<br>
- }<br>
-<br>
- bool TrySymInitialize() {<br>
- SymSetOptions(SYMOPT_DEFERRED_LOADS | SYMOPT_UNDNAME | SYMOPT_LOAD_LINES);<br>
- return SymInitialize(GetCurrentProcess(), 0, TRUE);<br>
- // FIXME: We don't call SymCleanup() on exit yet - should we?<br>
- }<br>
-<br>
- // All DbgHelp functions are single threaded, so we should use a mutex to<br>
- // serialize accesses.<br>
- BlockingMutex dbghelp_mu_;<br>
- bool initialized_;<br>
+ BlockingMutexLock l(&mu_);<br>
+ return tool_->Demangle(name);<br>
+ }<br>
+ bool GetModuleNameAndOffsetForPC(uptr pc, const char **module_name,<br>
+ uptr *module_address) override {<br>
+ BlockingMutexLock l(&mu_);<br>
+ return FindModuleNameAndOffsetForAddress(pc, module_name, module_address);<br>
+ }<br>
+<br>
+ BlockingMutex mu_;<br>
+ SymbolizerTool *tool_;<br>
};<br>
<br>
Symbolizer *Symbolizer::PlatformInit() {<br>
static bool called_once = false;<br>
CHECK(!called_once && "Shouldn't create more than one symbolizer");<br>
called_once = true;<br>
- return new(symbolizer_allocator_) WinSymbolizer();<br>
+ SymbolizerTool *tool = new(symbolizer_allocator_) WinSymbolizerTool();<br>
+ return new(symbolizer_allocator_) WinSymbolizer(tool);<br>
}<br>
<br>
} // namespace __sanitizer<br>
<br>
Added: compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_win.h<br>
URL: <a href="http://llvm.org/viewvc/llvm-project/compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_win.h?rev=231478&view=auto" target="_blank">http://llvm.org/viewvc/llvm-project/compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_win.h?rev=231478&view=auto</a><br>
==============================================================================<br>
--- compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_win.h (added)<br>
+++ compiler-rt/trunk/lib/sanitizer_common/sanitizer_symbolizer_win.h Fri Mar 6 08:33:56 2015<br>
@@ -0,0 +1,31 @@<br>
+//===-- sanitizer_symbolizer_win.h ------------------------------*- C++ -*-===//<br>
+//<br>
+// The LLVM Compiler Infrastructure<br>
+//<br>
+// This file is distributed under the University of Illinois Open Source<br>
+// License. See LICENSE.TXT for details.<br>
+//<br>
+//===----------------------------------------------------------------------===//<br>
+//<br>
+// Header file for the Windows symbolizer tool.<br>
+//<br>
+//===----------------------------------------------------------------------===//<br>
+#ifndef SANITIZER_SYMBOLIZER_WIN_H<br>
+#define SANITIZER_SYMBOLIZER_WIN_H<br>
+<br>
+#include "sanitizer_symbolizer_internal.h"<br>
+<br>
+namespace __sanitizer {<br>
+<br>
+class WinSymbolizerTool : public SymbolizerTool {<br>
+ public:<br>
+ bool SymbolizePC(uptr addr, SymbolizedStack *stack) override;<br>
+ bool SymbolizeData(uptr addr, DataInfo *info) override {<br>
+ return false;<br>
+ }<br>
+ const char *Demangle(const char *name) override;<br>
+};<br>
+<br>
+} // namespace __sanitizer<br>
+<br>
+#endif // SANITIZER_SYMBOLIZER_WIN_H<br>
<br>
<br>
_______________________________________________<br>
llvm-commits mailing list<br>
<a href="mailto:llvm-commits@cs.uiuc.edu">llvm-commits@cs.uiuc.edu</a><br>
<a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits" target="_blank">http://lists.cs.uiuc.edu/mailman/listinfo/llvm-commits</a><br>
</blockquote></div><br><br clear="all"><div><br></div>-- <br><div class="gmail_signature"><div dir="ltr">Alexey Samsonov<br><a href="mailto:vonosmas@gmail.com" target="_blank">vonosmas@gmail.com</a></div></div>
</div>