Merge pull request #40815 from grynspan/jgrynspan/DbgHelp-threadsafety

Ensure Debug Help library calls on Windows are made in as thread-safe a manner as possible by wrapping them in a scoped lock.

Author: grynspan

stdlib/public/runtime/Errors.cpp

@@ -85,10 +85,13 @@ static bool getSymbolNameAddr(llvm::StringRef libraryName,
   // providing failure status instead of just returning the original string like
   // swift demangle.
 #if defined(_WIN32)
-  static StaticMutex mutex;
-
   char szUndName[1024];
-  DWORD dwResult = mutex.withLock([&syminfo, &szUndName]() {
+  DWORD dwResult;
+  dwResult = _swift_withWin32DbgHelpLibrary([&] (bool isInitialized) -> DWORD {
+    if (!isInitialized) {
+      return 0;
+    }
+
     DWORD dwFlags = UNDNAME_COMPLETE;
 #if !defined(_WIN64)
     dwFlags |= UNDNAME_32_BIT_DECODE;
@@ -98,7 +101,7 @@ static bool getSymbolNameAddr(llvm::StringRef libraryName,
                                 sizeof(szUndName), dwFlags);
   });
 
-  if (dwResult == TRUE) {
+  if (dwResult) {
     symbolName += szUndName;
     return true;
   }

stdlib/public/runtime/ImageInspection.h

@@ -21,11 +21,13 @@
 #ifndef SWIFT_RUNTIME_IMAGEINSPECTION_H
 #define SWIFT_RUNTIME_IMAGEINSPECTION_H
 
+#include "swift/Runtime/Config.h"
+
 #include <cstdint>
 #include <cstddef>
-#if defined(__cplusplus)
+#include <functional>
 #include <memory>
-#endif
+#include <type_traits>
 
 namespace swift {
 
@@ -106,6 +108,47 @@ void addImageAccessibleFunctionsBlockCallbackUnsafe(const void *baseAddress,
 
 int lookupSymbol(const void *address, SymbolInfo *info);
 
+#if defined(_WIN32)
+/// Configure the environment to allow calling into the Debug Help library.
+///
+/// \param body A function to invoke. This function attempts to first initialize
+///   the Debug Help library. The result of that operation is passed to this
+///   function.
+///
+/// On Windows, the Debug Help library (DbgHelp.lib) is not thread-safe. All
+/// calls into it from the Swift runtime and stdlib should route through this
+/// function.
+SWIFT_RUNTIME_STDLIB_SPI
+void _swift_withWin32DbgHelpLibrary(
+  const std::function<void(bool /*isInitialized*/)>& body);
+
+/// Configure the environment to allow calling into the Debug Help library.
+///
+/// \param body A function to invoke. This function attempts to first initialize
+///   the Debug Help library. The result of that operation is passed to this
+///   function.
+///
+/// \returns Whatever is returned from \a body.
+///
+/// On Windows, the Debug Help library (DbgHelp.lib) is not thread-safe. All
+/// calls into it from the Swift runtime and stdlib should route through this
+/// function.
+template <
+  typename F,
+  typename R = typename std::result_of_t<F&(bool /*isInitialized*/)>,
+  typename = typename std::enable_if_t<!std::is_same<void, R>::value>
+>
+static inline R _swift_withWin32DbgHelpLibrary(const F& body) {
+  R result;
+
+  _swift_withWin32DbgHelpLibrary([&body, &result] (bool isInitialized) {
+    result = body(isInitialized);
+  });
+
+  return result;
+}
+#endif
+
 } // end namespace swift
 
 #endif

stdlib/public/runtime/ImageInspectionCOFF.cpp

@@ -23,6 +23,8 @@
 #include <DbgHelp.h>
 #endif
 
+#include "swift/Runtime/Mutex.h"
+
 using namespace swift;
 
 int swift::lookupSymbol(const void *address, SymbolInfo *info) {
@@ -38,36 +40,52 @@ int swift::lookupSymbol(const void *address, SymbolInfo *info) {
   info->symbolAddress = dli_saddr;
   return 1;
 #elif defined(_WIN32)
-  static const constexpr size_t kSymbolMaxNameLen = 1024;
-  static bool bInitialized = false;
+  return _swift_withWin32DbgHelpLibrary([&] (bool isInitialized) {
+    static const constexpr size_t kSymbolMaxNameLen = 1024;
 
-  if (bInitialized == false) {
-    if (SymInitialize(GetCurrentProcess(), /*UserSearchPath=*/NULL,
-                      /*fInvadeProcess=*/TRUE) == FALSE)
+    if (!isInitialized) {
       return 0;
-    bInitialized = true;
-  }
+    }
 
-  char buffer[sizeof(SYMBOL_INFO) + kSymbolMaxNameLen];
-  PSYMBOL_INFO pSymbol = reinterpret_cast<PSYMBOL_INFO>(buffer);
-  pSymbol->SizeOfStruct = sizeof(SYMBOL_INFO);
-  pSymbol->MaxNameLen = kSymbolMaxNameLen;
+    char buffer[sizeof(SYMBOL_INFO) + kSymbolMaxNameLen];
+    PSYMBOL_INFO pSymbol = reinterpret_cast<PSYMBOL_INFO>(buffer);
+    pSymbol->SizeOfStruct = sizeof(SYMBOL_INFO);
+    pSymbol->MaxNameLen = kSymbolMaxNameLen;
 
-  DWORD64 dwDisplacement = 0;
+    DWORD64 dwDisplacement = 0;
 
-  if (SymFromAddr(GetCurrentProcess(), reinterpret_cast<const DWORD64>(address),
-                  &dwDisplacement, pSymbol) == FALSE)
-    return 0;
+    if (SymFromAddr(GetCurrentProcess(),
+                    reinterpret_cast<const DWORD64>(address),
+                    &dwDisplacement, pSymbol) == FALSE) {
+      return 0;
+    }
 
-  info->fileName = NULL;
-  info->baseAddress = reinterpret_cast<void *>(pSymbol->ModBase);
-  info->symbolName.reset(_strdup(pSymbol->Name));
-  info->symbolAddress = reinterpret_cast<void *>(pSymbol->Address);
+    info->fileName = NULL;
+    info->baseAddress = reinterpret_cast<void *>(pSymbol->ModBase);
+    info->symbolName.reset(_strdup(pSymbol->Name));
+    info->symbolAddress = reinterpret_cast<void *>(pSymbol->Address);
 
-  return 1;
+    return 1;
+  });
 #else
   return 0;
 #endif // defined(__CYGWIN__) || defined(_WIN32)
 }
 
+#if defined(_WIN32)
+static StaticMutex mutex;
+static bool isDbgHelpInitialized = false;
+
+void swift::_swift_withWin32DbgHelpLibrary(
+  const std::function<void(bool /* isInitialized */)>& body) {
+  mutex.withLock([&body] () {
+    if (!isDbgHelpInitialized) {
+      SymSetOptions(SYMOPT_UNDNAME | SYMOPT_DEFERRED_LOADS);
+      isDbgHelpInitialized = SymInitialize(GetCurrentProcess(), nullptr, true);
+    }
+    body(isDbgHelpInitialized);
+  });
+}
+#endif
+
 #endif // !defined(__ELF__) && !defined(__MACH__)