Improve D3D12 pipeline cache implementation code

Bug: dawn:549
Change-Id: I84eaabdb2b72e73e37cd840632a4180acf2253e9
Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/92680
Kokoro: Kokoro <noreply+kokoro@google.com>
Reviewed-by: Austin Eng <enga@chromium.org>
Commit-Queue: Shrek Shao <shrekshao@google.com>
Reviewed-by: Corentin Wallez <cwallez@chromium.org>

src/dawn/native/BUILD.gn

@@ -377,6 +377,7 @@ source_set("sources") {
       "d3d12/BindGroupLayoutD3D12.cpp",
       "d3d12/BindGroupLayoutD3D12.h",
       "d3d12/BlobD3D12.cpp",
+      "d3d12/BlobD3D12.h",
       "d3d12/BufferD3D12.cpp",
       "d3d12/BufferD3D12.h",
       "d3d12/CPUDescriptorHeapAllocationD3D12.cpp",

src/dawn/native/Blob.cpp

@@ -18,16 +18,20 @@
 
 namespace dawn::native {
 
-// static
-Blob Blob::Create(size_t size) {
+Blob CreateBlob(size_t size) {
     if (size > 0) {
         uint8_t* data = new uint8_t[size];
-        return Blob(data, size, [=]() { delete[] data; });
+        return Blob::UnsafeCreateWithDeleter(data, size, [=]() { delete[] data; });
     } else {
         return Blob();
     }
 }
 
+// static
+Blob Blob::UnsafeCreateWithDeleter(uint8_t* data, size_t size, std::function<void()> deleter) {
+    return Blob(data, size, deleter);
+}
+
 Blob::Blob() : mData(nullptr), mSize(0), mDeleter({}) {}
 
 Blob::Blob(uint8_t* data, size_t size, std::function<void()> deleter)

src/dawn/native/Blob.h

@@ -18,12 +18,6 @@
 #include <functional>
 #include <memory>
 
-#include "dawn/common/Platform.h"
-
-#if defined(DAWN_PLATFORM_WINDOWS)
-#include "dawn/native/d3d12/d3d12_platform.h"
-#endif  // DAWN_PLATFORM_WINDOWS
-
 namespace dawn::native {
 
 // Blob represents a block of bytes. It may be constructed from
@@ -31,11 +25,9 @@ namespace dawn::native {
 // ownership of the container and release its memory on destruction.
 class Blob {
   public:
-    static Blob Create(size_t size);
-
-#if defined(DAWN_PLATFORM_WINDOWS)
-    static Blob Create(Microsoft::WRL::ComPtr<ID3DBlob> blob);
-#endif  // DAWN_PLATFORM_WINDOWS
+    // This function is used to create Blob with actual data.
+    // Make sure the creation and deleter handles the data ownership and lifetime correctly.
+    static Blob UnsafeCreateWithDeleter(uint8_t* data, size_t size, std::function<void()> deleter);
 
     Blob();
     ~Blob();
@@ -52,6 +44,8 @@ class Blob {
     size_t Size() const;
 
   private:
+    // The constructor should be responsible to take ownership of |data| and releases ownership by
+    // calling |deleter|. The deleter function is called at ~Blob() and during std::move.
     explicit Blob(uint8_t* data, size_t size, std::function<void()> deleter);
 
     uint8_t* mData;
@@ -59,6 +53,8 @@ class Blob {
     std::function<void()> mDeleter;
 };
 
+Blob CreateBlob(size_t size);
+
 }  // namespace dawn::native
 
 #endif  // SRC_DAWN_NATIVE_BLOB_H_

src/dawn/native/BlobCache.cpp

@@ -45,7 +45,7 @@ Blob BlobCache::LoadInternal(const CacheKey& key) {
     const size_t expectedSize = mCache->LoadData(key.data(), key.size(), nullptr, 0);
     if (expectedSize > 0) {
         // Need to put this inside to trigger copy elision.
-        Blob result = Blob::Create(expectedSize);
+        Blob result = CreateBlob(expectedSize);
         const size_t actualSize =
             mCache->LoadData(key.data(), key.size(), result.Data(), expectedSize);
         ASSERT(expectedSize == actualSize);

src/dawn/native/CMakeLists.txt

@@ -244,6 +244,7 @@ if (DAWN_ENABLE_D3D12)
         "d3d12/BindGroupLayoutD3D12.cpp"
         "d3d12/BindGroupLayoutD3D12.h"
         "d3d12/BlobD3D12.cpp"
+        "d3d12/BlobD3D12.h"
         "d3d12/BufferD3D12.cpp"
         "d3d12/BufferD3D12.h"
         "d3d12/CPUDescriptorHeapAllocationD3D12.cpp"

src/dawn/native/Device.h

@@ -22,7 +22,6 @@
 #include <utility>
 #include <vector>
 
-#include "dawn/native/BlobCache.h"
 #include "dawn/native/CacheKey.h"
 #include "dawn/native/Commands.h"
 #include "dawn/native/ComputePipeline.h"
@@ -48,6 +47,8 @@ namespace dawn::native {
 class AsyncTaskManager;
 class AttachmentState;
 class AttachmentStateBlueprint;
+class Blob;
+class BlobCache;
 class CallbackTaskManager;
 class DynamicUploader;
 class ErrorScopeStack;

src/dawn/native/d3d12/BlobD3D12.cpp

@@ -12,16 +12,15 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-#include "dawn/native/Blob.h"
-#include "dawn/native/d3d12/d3d12_platform.h"
+#include "dawn/native/d3d12/BlobD3D12.h"
 
 namespace dawn::native {
 
-// static
-Blob Blob::Create(ComPtr<ID3DBlob> blob) {
+Blob CreateBlob(ComPtr<ID3DBlob> blob) {
     // Detach so the deleter callback can "own" the reference
     ID3DBlob* ptr = blob.Detach();
-    return Blob(reinterpret_cast<uint8_t*>(ptr->GetBufferPointer()), ptr->GetBufferSize(), [=]() {
+    return Blob::UnsafeCreateWithDeleter(reinterpret_cast<uint8_t*>(ptr->GetBufferPointer()),
+                                         ptr->GetBufferSize(), [=]() {
                                              // Reattach and drop to delete it.
                                              ComPtr<ID3DBlob> b;
                                              b.Attach(ptr);

src/dawn/native/d3d12/BlobD3D12.h

@@ -0,0 +1,22 @@
+// Copyright 2022 The Dawn Authors
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#include "dawn/native/Blob.h"
+#include "dawn/native/d3d12/d3d12_platform.h"
+
+namespace dawn::native {
+
+Blob CreateBlob(ComPtr<ID3DBlob> blob);
+
+}  // namespace dawn::native

src/dawn/native/d3d12/ComputePipelineD3D12.cpp

@@ -18,6 +18,7 @@
 #include <utility>
 
 #include "dawn/native/CreatePipelineAsyncTask.h"
+#include "dawn/native/d3d12/BlobD3D12.h"
 #include "dawn/native/d3d12/D3D12Error.h"
 #include "dawn/native/d3d12/DeviceD3D12.h"
 #include "dawn/native/d3d12/PipelineLayoutD3D12.h"
@@ -82,7 +83,7 @@ MaybeError ComputePipeline::Initialize() {
         ComPtr<ID3DBlob> d3dBlob;
         DAWN_TRY(CheckHRESULT(GetPipelineState()->GetCachedBlob(&d3dBlob),
                               "D3D12 compute pipeline state get cached blob"));
-        device->StoreCachedBlob(GetCacheKey(), Blob::Create(std::move(d3dBlob)));
+        device->StoreCachedBlob(GetCacheKey(), CreateBlob(std::move(d3dBlob)));
     }
 
     SetLabelImpl();

src/dawn/native/d3d12/DeviceD3D12.cpp

@@ -441,9 +441,6 @@ ResultOrError<Ref<TextureViewBase>> Device::CreateTextureViewImpl(
     const TextureViewDescriptor* descriptor) {
     return TextureView::Create(texture, descriptor);
 }
-Ref<PipelineCacheBase> Device::GetOrCreatePipelineCacheImpl(const CacheKey& key) {
-    UNREACHABLE();
-}
 void Device::InitializeComputePipelineAsyncImpl(Ref<ComputePipelineBase> computePipeline,
                                                 WGPUCreateComputePipelineAsyncCallback callback,
                                                 void* userdata) {

src/dawn/native/d3d12/DeviceD3D12.h

@@ -188,7 +188,6 @@ class Device final : public DeviceBase {
         const ComputePipelineDescriptor* descriptor) override;
     Ref<RenderPipelineBase> CreateUninitializedRenderPipelineImpl(
         const RenderPipelineDescriptor* descriptor) override;
-    Ref<PipelineCacheBase> GetOrCreatePipelineCacheImpl(const CacheKey& key) override;
     void InitializeComputePipelineAsyncImpl(Ref<ComputePipelineBase> computePipeline,
                                             WGPUCreateComputePipelineAsyncCallback callback,
                                             void* userdata) override;

src/dawn/native/d3d12/RenderPipelineD3D12.cpp

@@ -22,6 +22,7 @@
 #include "dawn/common/Assert.h"
 #include "dawn/common/Log.h"
 #include "dawn/native/CreatePipelineAsyncTask.h"
+#include "dawn/native/d3d12/BlobD3D12.h"
 #include "dawn/native/d3d12/D3D12Error.h"
 #include "dawn/native/d3d12/DeviceD3D12.h"
 #include "dawn/native/d3d12/PipelineLayoutD3D12.h"
@@ -449,7 +450,7 @@ MaybeError RenderPipeline::Initialize() {
         ComPtr<ID3DBlob> d3dBlob;
         DAWN_TRY(CheckHRESULT(GetPipelineState()->GetCachedBlob(&d3dBlob),
                               "D3D12 render pipeline state get cached blob"));
-        device->StoreCachedBlob(GetCacheKey(), Blob::Create(std::move(d3dBlob)));
+        device->StoreCachedBlob(GetCacheKey(), CreateBlob(std::move(d3dBlob)));
     }
 
     SetLabelImpl();

src/dawn/native/vulkan/PipelineCacheVk.cpp

@@ -61,12 +61,13 @@ MaybeError PipelineCache::SerializeToBlobImpl(Blob* blob) {
     DAWN_TRY(CheckVkSuccess(
         device->fn.GetPipelineCacheData(device->GetVkDevice(), mHandle, &bufferSize, nullptr),
         "GetPipelineCacheData"));
-    if (bufferSize > 0) {
-        *blob = Blob::Create(bufferSize);
-        DAWN_TRY(CheckVkSuccess(device->fn.GetPipelineCacheData(device->GetVkDevice(), mHandle,
-                                                                &bufferSize, blob->Data()),
-                                "GetPipelineCacheData"));
+    if (bufferSize == 0) {
+        return {};
     }
+    *blob = CreateBlob(bufferSize);
+    DAWN_TRY(CheckVkSuccess(
+        device->fn.GetPipelineCacheData(device->GetVkDevice(), mHandle, &bufferSize, blob->Data()),
+        "GetPipelineCacheData"));
     return {};
 }