[d3d12] Rework signal handlers to dump debug info. Prevent rogue pointer access. (#1076)

Author: manon-traverse

lib/API/DX/Device.cpp

@@ -46,13 +46,42 @@
 
 #include <codecvt>
 #include <locale>
+#include <mutex>
 
 using namespace offloadtest;
 using Microsoft::WRL::ComPtr;
 
 template <> char CapabilityValueEnum<directx::ShaderModel>::ID = 0;
 template <> char CapabilityValueEnum<directx::RootSignature>::ID = 0;
 
+static std::mutex SignalHandlerMutex;
+static llvm::SmallVector<ID3D12Device *> SignalHandlerDevices;
+
+static void dumpD3DInfoQueues(void *) {
+  const std::lock_guard<std::mutex> Lock(SignalHandlerMutex);
+  for (ID3D12Device *Device : SignalHandlerDevices) {
+    ComPtr<ID3D12InfoQueue> InfoQueue;
+    HRESULT HR = Device->QueryInterface(InfoQueue.GetAddressOf());
+    if (FAILED(HR)) {
+      llvm::errs() << "Failed to query D3D info queue\n";
+      continue;
+    }
+    for (int I = 0, E = InfoQueue->GetNumStoredMessages(); I < E; ++I) {
+      SIZE_T Len = 0;
+      HR = InfoQueue->GetMessage(I, NULL, &Len);
+      if (FAILED(HR)) {
+        llvm::errs() << "Failed to get message " << I
+                     << " from D3D info queue\n";
+      } else {
+        D3D12_MESSAGE *Msg = (D3D12_MESSAGE *)malloc(Len);
+        HR = InfoQueue->GetMessage(I, Msg, &Len);
+        llvm::errs() << "D3D: " << Msg->pDescription << "\n";
+        free(Msg);
+      }
+    }
+  }
+}
+
 #define DXFormats(FMT)                                                         \
   if (Channels == 1)                                                           \
     return DXGI_FORMAT_R32_##FMT;                                              \
@@ -496,7 +525,10 @@ class DXDevice : public offloadtest::Device {
   }
   DXDevice(const DXDevice &) = default;
 
-  ~DXDevice() override = default;
+  ~DXDevice() override {
+    const std::lock_guard<std::mutex> Lock(SignalHandlerMutex);
+    llvm::erase(SignalHandlerDevices, Device.Get());
+  }
 
   llvm::StringRef getAPIName() const override { return "DirectX"; }
   GPUAPI getAPI() const override { return GPUAPI::DirectX; }
@@ -631,6 +663,16 @@ class DXDevice : public offloadtest::Device {
                                           IID_PPV_ARGS(&Device)),
                         "Failed to create D3D device"))
       return Err;
+
+    static std::once_flag SignalHandlerRegistered;
+    std::call_once(SignalHandlerRegistered, [] {
+      llvm::sys::AddSignalHandler(dumpD3DInfoQueues, nullptr);
+    });
+    {
+      const std::lock_guard<std::mutex> Lock(SignalHandlerMutex);
+      SignalHandlerDevices.push_back(Device.Get());
+    }
+
     assert(
         Adapter->IsPropertySupported(DXCoreAdapterProperty::DriverDescription));
     size_t BufferSize;
@@ -1796,32 +1838,6 @@ class DXDevice : public offloadtest::Device {
   }
 
   llvm::Error executeProgram(Pipeline &P) override {
-    llvm::sys::AddSignalHandler(
-        [](void *Cookie) {
-          ID3D12Device *Device = (ID3D12Device *)Cookie;
-
-          ComPtr<ID3D12InfoQueue> InfoQueue;
-          HRESULT HR = Device->QueryInterface(InfoQueue.GetAddressOf());
-          if (FAILED(HR)) {
-            llvm::errs() << "Failed to query D3D info queue\n";
-            return;
-          }
-          for (int I = 0, E = InfoQueue->GetNumStoredMessages(); I < E; ++I) {
-            SIZE_T Len = 0;
-            HR = InfoQueue->GetMessage(I, NULL, &Len);
-            if (FAILED(HR)) {
-              llvm::errs() << "Failed to get message " << I
-                           << " from D3D info queue\n";
-            } else {
-              D3D12_MESSAGE *Msg = (D3D12_MESSAGE *)malloc(Len);
-              HR = InfoQueue->GetMessage(I, Msg, &Len);
-              llvm::errs() << "D3D: " << Msg->pDescription << "\n";
-              free(Msg);
-            }
-          }
-        },
-        (void *)Device.Get());
-
     InvocationState State;
     llvm::outs() << "Configuring execution on device: " << Description << "\n";
     if (auto Err = createRootSignature(P, State))