Refactor ShaderModule creation to use a Builder pattern

BUG=dawn:270

Change-Id: Iedae1a5500b1eb65abb84ff59f68d829c5c22c2b
Reviewed-on: https://dawn-review.googlesource.com/c/dawn/+/13500
Commit-Queue: Ryan Harrison <rharrison@chromium.org>
Reviewed-by: Corentin Wallez <cwallez@chromium.org>

src/dawn_native/d3d12/DeviceD3D12.cpp

@@ -274,7 +274,7 @@ namespace dawn_native { namespace d3d12 {
     }
     ResultOrError<ShaderModuleBase*> Device::CreateShaderModuleImpl(
         const ShaderModuleDescriptor* descriptor) {
-        return new ShaderModule(this, descriptor);
+        return ShaderModule::Create(this, descriptor);
     }
     ResultOrError<SwapChainBase*> Device::CreateSwapChainImpl(
         const SwapChainDescriptor* descriptor) {

src/dawn_native/d3d12/ShaderModuleD3D12.cpp

@@ -24,11 +24,25 @@
 
 namespace dawn_native { namespace d3d12 {
 
+    // static
+    ResultOrError<ShaderModule*> ShaderModule::Create(Device* device,
+                                                      const ShaderModuleDescriptor* descriptor) {
+        std::unique_ptr<ShaderModule> module(new ShaderModule(device, descriptor));
+        if (!module)
+            return DAWN_VALIDATION_ERROR("Unable to create ShaderModule");
+        DAWN_TRY(module->Initialize(descriptor));
+        return module.release();
+    }
+
     ShaderModule::ShaderModule(Device* device, const ShaderModuleDescriptor* descriptor)
         : ShaderModuleBase(device, descriptor) {
+    }
+
+    MaybeError ShaderModule::Initialize(const ShaderModuleDescriptor* descriptor) {
         mSpirv.assign(descriptor->code, descriptor->code + descriptor->codeSize);
         spirv_cross::CompilerHLSL compiler(mSpirv);
         ExtractSpirvInfo(compiler);
+        return {};
     }
 
     const std::string ShaderModule::GetHLSLSource(PipelineLayout* layout) const {

src/dawn_native/d3d12/ShaderModuleD3D12.h

@@ -24,11 +24,15 @@ namespace dawn_native { namespace d3d12 {
 
     class ShaderModule : public ShaderModuleBase {
       public:
-        ShaderModule(Device* device, const ShaderModuleDescriptor* descriptor);
+        static ResultOrError<ShaderModule*> Create(Device* device,
+                                                   const ShaderModuleDescriptor* descriptor);
 
         const std::string GetHLSLSource(PipelineLayout* layout) const;
 
       private:
+        ShaderModule(Device* device, const ShaderModuleDescriptor* descriptor);
+        MaybeError Initialize(const ShaderModuleDescriptor* descriptor);
+
         std::vector<uint32_t> mSpirv;
     };
 

src/dawn_native/metal/DeviceMTL.mm

@@ -129,7 +129,7 @@ namespace dawn_native { namespace metal {
     }
     ResultOrError<ShaderModuleBase*> Device::CreateShaderModuleImpl(
         const ShaderModuleDescriptor* descriptor) {
-        return new ShaderModule(this, descriptor);
+        return ShaderModule::Create(this, descriptor);
     }
     ResultOrError<SwapChainBase*> Device::CreateSwapChainImpl(
         const SwapChainDescriptor* descriptor) {

src/dawn_native/metal/ShaderModuleMTL.h

@@ -19,6 +19,8 @@
 
 #import <Metal/Metal.h>
 
+#include "dawn_native/Error.h"
+
 namespace spirv_cross {
     class CompilerMSL;
 }
@@ -30,7 +32,8 @@ namespace dawn_native { namespace metal {
 
     class ShaderModule : public ShaderModuleBase {
       public:
-        ShaderModule(Device* device, const ShaderModuleDescriptor* descriptor);
+        static ResultOrError<ShaderModule*> Create(Device* device,
+                                                   const ShaderModuleDescriptor* descriptor);
 
         struct MetalFunctionData {
             id<MTLFunction> function;
@@ -45,6 +48,9 @@ namespace dawn_native { namespace metal {
                                       const PipelineLayout* layout) const;
 
       private:
+        ShaderModule(Device* device, const ShaderModuleDescriptor* descriptor);
+        MaybeError Initialize(const ShaderModuleDescriptor* descriptor);
+
         // Calling compile on CompilerMSL somehow changes internal state that makes subsequent
         // compiles return invalid MSL. We keep the spirv around and recreate the compiler everytime
         // we need to use it.

src/dawn_native/metal/ShaderModuleMTL.mm

@@ -38,13 +38,27 @@ namespace dawn_native { namespace metal {
                     UNREACHABLE();
             }
         }
+    }  // namespace
+
+    // static
+    ResultOrError<ShaderModule*> ShaderModule::Create(Device* device,
+                                                      const ShaderModuleDescriptor* descriptor) {
+        std::unique_ptr<ShaderModule> module(new ShaderModule(device, descriptor));
+        if (!module)
+            return DAWN_VALIDATION_ERROR("Unable to create ShaderModule");
+        DAWN_TRY(module->Initialize(descriptor));
+        return module.release();
     }
 
     ShaderModule::ShaderModule(Device* device, const ShaderModuleDescriptor* descriptor)
         : ShaderModuleBase(device, descriptor) {
+    }
+
+    MaybeError ShaderModule::Initialize(const ShaderModuleDescriptor* descriptor) {
         mSpirv.assign(descriptor->code, descriptor->code + descriptor->codeSize);
         spirv_cross::CompilerMSL compiler(mSpirv);
         ExtractSpirvInfo(compiler);
+        return {};
     }
 
     ShaderModule::MetalFunctionData ShaderModule::GetFunction(const char* functionName,

src/dawn_native/opengl/DeviceGL.cpp

@@ -99,7 +99,7 @@ namespace dawn_native { namespace opengl {
     }
     ResultOrError<ShaderModuleBase*> Device::CreateShaderModuleImpl(
         const ShaderModuleDescriptor* descriptor) {
-        return new ShaderModule(this, descriptor);
+        return ShaderModule::Create(this, descriptor);
     }
     ResultOrError<SwapChainBase*> Device::CreateSwapChainImpl(
         const SwapChainDescriptor* descriptor) {

src/dawn_native/opengl/ShaderModuleGL.cpp

@@ -47,8 +47,29 @@ namespace dawn_native { namespace opengl {
         return o.str();
     }
 
+    // static
+    ResultOrError<ShaderModule*> ShaderModule::Create(Device* device,
+                                                      const ShaderModuleDescriptor* descriptor) {
+        std::unique_ptr<ShaderModule> module(new ShaderModule(device, descriptor));
+        if (!module)
+            return DAWN_VALIDATION_ERROR("Unable to create ShaderModule");
+        DAWN_TRY(module->Initialize(descriptor));
+        return module.release();
+    }
+
+    const char* ShaderModule::GetSource() const {
+        return mGlslSource.c_str();
+    }
+
+    const ShaderModule::CombinedSamplerInfo& ShaderModule::GetCombinedSamplerInfo() const {
+        return mCombinedInfo;
+    }
+
     ShaderModule::ShaderModule(Device* device, const ShaderModuleDescriptor* descriptor)
         : ShaderModuleBase(device, descriptor) {
+    }
+
+    MaybeError ShaderModule::Initialize(const ShaderModuleDescriptor* descriptor) {
         spirv_cross::CompilerGLSL compiler(descriptor->code, descriptor->codeSize);
         // If these options are changed, the values in DawnSPIRVCrossGLSLFastFuzzer.cpp need to be
         // updated.
@@ -108,14 +129,7 @@ namespace dawn_native { namespace opengl {
         }
 
         mGlslSource = compiler.compile();
-    }
-
-    const char* ShaderModule::GetSource() const {
-        return mGlslSource.c_str();
-    }
-
-    const ShaderModule::CombinedSamplerInfo& ShaderModule::GetCombinedSamplerInfo() const {
-        return mCombinedInfo;
+        return {};
     }
 
 }}  // namespace dawn_native::opengl

src/dawn_native/opengl/ShaderModuleGL.h

@@ -40,7 +40,8 @@ namespace dawn_native { namespace opengl {
 
     class ShaderModule : public ShaderModuleBase {
       public:
-        ShaderModule(Device* device, const ShaderModuleDescriptor* descriptor);
+        static ResultOrError<ShaderModule*> Create(Device* device,
+                                                   const ShaderModuleDescriptor* descriptor);
 
         using CombinedSamplerInfo = std::vector<CombinedSampler>;
 
@@ -48,6 +49,9 @@ namespace dawn_native { namespace opengl {
         const CombinedSamplerInfo& GetCombinedSamplerInfo() const;
 
       private:
+        ShaderModule(Device* device, const ShaderModuleDescriptor* descriptor);
+        MaybeError Initialize(const ShaderModuleDescriptor* descriptor);
+
         CombinedSamplerInfo mCombinedInfo;
         std::string mGlslSource;
     };

src/dawn_native/vulkan/ShaderModuleVk.cpp

@@ -25,11 +25,17 @@ namespace dawn_native { namespace vulkan {
     // static
     ResultOrError<ShaderModule*> ShaderModule::Create(Device* device,
                                                       const ShaderModuleDescriptor* descriptor) {
-        std::unique_ptr<ShaderModule> module = std::make_unique<ShaderModule>(device, descriptor);
+        std::unique_ptr<ShaderModule> module(new ShaderModule(device, descriptor));
+        if (!module)
+            return DAWN_VALIDATION_ERROR("Unable to create ShaderModule");
         DAWN_TRY(module->Initialize(descriptor));
         return module.release();
     }
 
+    ShaderModule::ShaderModule(Device* device, const ShaderModuleDescriptor* descriptor)
+        : ShaderModuleBase(device, descriptor) {
+    }
+
     MaybeError ShaderModule::Initialize(const ShaderModuleDescriptor* descriptor) {
         // Use SPIRV-Cross to extract info from the SPIRV even if Vulkan consumes SPIRV. We want to
         // have a translation step eventually anyway.

src/dawn_native/vulkan/ShaderModuleVk.h

@@ -33,7 +33,7 @@ namespace dawn_native { namespace vulkan {
         VkShaderModule GetHandle() const;
 
       private:
-        using ShaderModuleBase::ShaderModuleBase;
+        ShaderModule(Device* device, const ShaderModuleDescriptor* descriptor);
         MaybeError Initialize(const ShaderModuleDescriptor* descriptor);
 
         VkShaderModule mHandle = VK_NULL_HANDLE;