Reset Internal D3D12 Device After Test Shutdown

Adds dawn_native::ResetDeviceInternal, which allows us to destroy and
create a new ID3D12Device. The device should be reset after every test
when GPU-based validation is enabled in order to prevent GBV objects
from using a significant amount of memory over time.

Bug: dawn:623
Change-Id: I654d093d993ab0198c6c240bd0f3f843d2762680
Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/41340
Reviewed-by: Austin Eng <enga@chromium.org>
Reviewed-by: Rafael Cintron <rafael.cintron@microsoft.com>
Commit-Queue: Brandon Jones <brandon1.jones@intel.com>

src/dawn_native/Adapter.cpp

@@ -91,4 +91,13 @@ namespace dawn_native {
         return {};
     }
 
+    void AdapterBase::ResetInternalDeviceForTesting() {
+        mInstance->ConsumedError(ResetInternalDeviceForTestingImpl());
+    }
+
+    MaybeError AdapterBase::ResetInternalDeviceForTestingImpl() {
+        return DAWN_INTERNAL_ERROR(
+            "ResetInternalDeviceForTesting should only be used with the D3D12 backend.");
+    }
+
 }  // namespace dawn_native

src/dawn_native/Adapter.h

@@ -40,6 +40,8 @@ namespace dawn_native {
 
         DeviceBase* CreateDevice(const DeviceDescriptor* descriptor = nullptr);
 
+        void ResetInternalDeviceForTesting();
+
         ExtensionsSet GetSupportedExtensions() const;
         bool SupportsAllRequestedExtensions(
             const std::vector<const char*>& requestedExtensions) const;
@@ -56,6 +58,7 @@ namespace dawn_native {
 
         MaybeError CreateDeviceInternal(DeviceBase** result, const DeviceDescriptor* descriptor);
 
+        virtual MaybeError ResetInternalDeviceForTestingImpl();
         InstanceBase* mInstance = nullptr;
         wgpu::BackendType mBackend;
     };

src/dawn_native/DawnNative.cpp

@@ -111,6 +111,10 @@ namespace dawn_native {
         return reinterpret_cast<WGPUDevice>(mImpl->CreateDevice(deviceDescriptor));
     }
 
+    void Adapter::ResetInternalDeviceForTesting() {
+        mImpl->ResetInternalDeviceForTesting();
+    }
+
     // AdapterDiscoverOptionsBase
 
     AdapterDiscoveryOptionsBase::AdapterDiscoveryOptionsBase(WGPUBackendType type)

src/dawn_native/d3d12/AdapterD3D12.cpp

@@ -216,4 +216,15 @@ namespace dawn_native { namespace d3d12 {
         return Device::Create(this, descriptor);
     }
 
+    // Resets the backend device and creates a new one. If any D3D12 objects belonging to the
+    // current ID3D12Device have not been destroyed, a non-zero value will be returned upon Reset()
+    // and the subequent call to CreateDevice will return a handle the existing device instead of
+    // creating a new one.
+    MaybeError Adapter::ResetInternalDeviceForTestingImpl() {
+        ASSERT(mD3d12Device.Reset() == 0);
+        DAWN_TRY(Initialize());
+
+        return {};
+    }
+
 }}  // namespace dawn_native::d3d12

src/dawn_native/d3d12/AdapterD3D12.h

@@ -38,6 +38,8 @@ namespace dawn_native { namespace d3d12 {
 
       private:
         ResultOrError<DeviceBase*> CreateDeviceImpl(const DeviceDescriptor* descriptor) override;
+        MaybeError ResetInternalDeviceForTestingImpl() override;
+
         void InitializeSupportedExtensions();
         MaybeError InitializeDebugLayerFilters();
         void CleanUpDebugLayerFilters();

src/include/dawn_native/DawnNative.h

@@ -116,6 +116,9 @@ namespace dawn_native {
         // On an error, nullptr is returned.
         WGPUDevice CreateDevice(const DeviceDescriptor* deviceDescriptor = nullptr);
 
+        // Reset the backend device object for testing purposes.
+        void ResetInternalDeviceForTesting();
+
       private:
         AdapterBase* mImpl = nullptr;
     };

src/tests/DawnTest.cpp

@@ -677,6 +677,11 @@ DawnTestBase::~DawnTestBase() {
     queue = wgpu::Queue();
     device = wgpu::Device();
 
+    // D3D12's GPU-based validation will accumulate objects over time if the backend device is not
+    // destroyed and recreated, so we reset it here.
+    if (IsD3D12() && IsBackendValidationEnabled()) {
+        mBackendAdapter.ResetInternalDeviceForTesting();
+    }
     mWireHelper.reset();
 }
 

src/tests/end2end/DeviceInitializationTests.cpp

@@ -62,7 +62,7 @@ TEST_F(DeviceInitializationTest, DeviceOutlivesInstance) {
                 properties.backendType == desiredProperties.backendType) {
                 // Create the device, destroy the instance, and break out of the loop.
                 dawn_native::DeviceDescriptor deviceDescriptor = {};
-                device = wgpu::Device(adapter.CreateDevice(&deviceDescriptor));
+                device = wgpu::Device::Acquire(adapter.CreateDevice(&deviceDescriptor));
                 instance.reset();
                 break;
             }