[asan Win64] Fix missing frames in TestCase null_deref

[wang0109]

Summary

TestCase null_deref was failing in Win64:

c:\lipo\work\asan\b_llvm>c:\lipo\work\asan\b_llvm\projects\compiler-rt\test\asan\X86_64WindowsConfig\TestCases\Output\null_deref.cc.tmp
=================================================================
==5488==ERROR: AddressSanitizer: access-violation on unknown address 0x000000000028 (pc 0x7ff701f91067 bp 0x000c8cf8fbf0 sp 0x000c8cf8fbb0 T0)
==5488==The signal is caused by a READ memory access.
==5488==Hint: address points to the zero page.
    #0 0x7ff701f91066 in NullDeref(int *) C:\lipo\work\asan\llvm\projects\compiler-rt\test\asan\TestCases\null_deref.cc:15:10
    #1 0x8a0388830a67  (<unknown module>)

The reason was symbols was not initilized. In fact, it was first inited
with a call to stack.Print(), which calls
WinSymbolizerTool::SymbolizePC, then InitializeDbgHelpIfNeeded().

Since the StackWalk was performed before the stack.Print(), stack frames
where not gathered correctly.

There should be a better place to initialize symbols. For now, this
patch makes the test happy.

[wang0109]

After patch:

c:\lipo\work\asan\b_llvm>"c:\lipo\work\asan\b_llvm\projects\compiler-rt\test\asan\X86_64WindowsConfig\TestCases\Output\null_deref.cc.tmp"
=================================================================
==13776==ERROR: AddressSanitizer: access-violation on unknown address 0x000000000028 (pc 0x7ff778b61028 bp 0x00ddaaaffc90 sp 0x00ddaaaffc70 T0)
==13776==The signal is caused by a WRITE memory access.
==13776==Hint: address points to the zero page.
    #0 0x7ff778b61027 in NullDeref(int *) C:\lipo\work\asan\llvm\projects\compiler-rt\test\asan\TestCases\null_deref.cc:15:10
    #1 0x7ff778b61060 in main C:\lipo\work\asan\llvm\projects\compiler-rt\test\asan\TestCases\null_deref.cc:21:3
    #2 0x7ff778b91deb in __scrt_common_main_seh f:\dd\vctools\crt\vcstartup\src\startup\exe_common.inl:255
    #3 0x7ffeee778101  (C:\Windows\system32\KERNEL32.DLL+0x180018101)
    #4 0x7ffeef7ac5b3  (C:\Windows\SYSTEM32\ntdll.dll+0x18005c5b3)

AddressSanitizer can not provide additional info.
SUMMARY: AddressSanitizer: access-violation C:\lipo\work\asan\llvm\projects\compiler-rt\test\asan\TestCases\null_deref.cc:15:10 in NullDeref(int *)
==13776==ABORTING

[etienneb]

Is this the same idea of what that function is doing:

void InitializeDbgHelpIfNeeded() {

[wang0109]

• update diff: Reuse InitializeDbgHelpIfNeeded()

[rnk]

lgtm, yeah, I'm pretty sure you're supposed to call SymInitialize before you call StackWalk64.

[etienneb]

Closed by commit rL275580: TestCase null_deref was failing in Win64: (authored by etienneb).

lib/sanitizer_common/sanitizer_symbolizer.h

private:
    public:
     explicit SymbolizerScope(const Symbolizer *sym);
     ~SymbolizerScope();
    private:
     const Symbolizer *sym_;
   };
 };
 
+#ifdef SANITIZER_WINDOWS
+void InitializeDbgHelpIfNeeded();
+#endif
+
 }  // namespace __sanitizer
 
 #endif  // SANITIZER_SYMBOLIZER_H

lib/sanitizer_common/sanitizer_symbolizer_win.cc

 bool is_dbghelp_initialized = false;
 
 bool TrySymInitialize() {
   SymSetOptions(SYMOPT_DEFERRED_LOADS | SYMOPT_UNDNAME | SYMOPT_LOAD_LINES);
   return SymInitialize(GetCurrentProcess(), 0, TRUE);
   // FIXME: We don't call SymCleanup() on exit yet - should we?
 }
 
+}  // namespace
+
 // Initializes DbgHelp library, if it's not yet initialized. Calls to this
 // function should be synchronized with respect to other calls to DbgHelp API
 // (e.g. from WinSymbolizerTool).
 void InitializeDbgHelpIfNeeded() {
   if (is_dbghelp_initialized)
     return;
   if (!TrySymInitialize()) {
     // OK, maybe the client app has called SymInitialize already.
void InitializeDbgHelpIfNeeded() {
   CHECK_NE(last_bslash, 0);
   *last_bslash = L'\0';
   if (!SymSetSearchPathW(GetCurrentProcess(), path_buffer)) {
     Report("*** WARNING: Failed to SymSetSearchPathW\n");
     return;
   }
 }
 
-}  // namespace
-
 bool WinSymbolizerTool::SymbolizePC(uptr addr, SymbolizedStack *frame) {
   InitializeDbgHelpIfNeeded();
 
   // See http://msdn.microsoft.com/en-us/library/ms680578(VS.85).aspx
   char buffer[sizeof(SYMBOL_INFO) + MAX_SYM_NAME * sizeof(CHAR)];
   PSYMBOL_INFO symbol = (PSYMBOL_INFO)buffer;
   symbol->SizeOfStruct = sizeof(SYMBOL_INFO);
   symbol->MaxNameLen = MAX_SYM_NAME;

lib/sanitizer_common/sanitizer_win.cc

 #include <psapi.h>
 #include <stdlib.h>
 
 #include "sanitizer_common.h"
 #include "sanitizer_libc.h"
 #include "sanitizer_mutex.h"
 #include "sanitizer_placement_new.h"
 #include "sanitizer_stacktrace.h"
+#include "sanitizer_symbolizer.h"
 
 namespace __sanitizer {
 
 #include "sanitizer_syscall_generic.inc"
 
 // --------------------- sanitizer_common.h
 uptr GetPageSize() {
   SYSTEM_INFO si;
void BufferedStackTrace::SlowUnwindStack(uptr pc, u32 max_depth) {
   PopStackFrames(pc_location);
 }
 
 void BufferedStackTrace::SlowUnwindStackWithContext(uptr pc, void *context,
                                                     u32 max_depth) {
   CONTEXT ctx = *(CONTEXT *)context;
   STACKFRAME64 stack_frame;
   memset(&stack_frame, 0, sizeof(stack_frame));
+
+  InitializeDbgHelpIfNeeded();
+
   size = 0;
 #if defined(_WIN64)
   int machine_type = IMAGE_FILE_MACHINE_AMD64;
   stack_frame.AddrPC.Offset = ctx.Rip;
   stack_frame.AddrFrame.Offset = ctx.Rbp;
   stack_frame.AddrStack.Offset = ctx.Rsp;
 #else
   int machine_type = IMAGE_FILE_MACHINE_I386;