| // Copyright 2017 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/d3d12/ShaderModuleD3D12.h" |
| |
| #include "common/Assert.h" |
| #include "common/BitSetIterator.h" |
| #include "common/Log.h" |
| #include "dawn_native/d3d12/BindGroupLayoutD3D12.h" |
| #include "dawn_native/d3d12/D3D12Error.h" |
| #include "dawn_native/d3d12/DeviceD3D12.h" |
| #include "dawn_native/d3d12/PipelineLayoutD3D12.h" |
| #include "dawn_native/d3d12/PlatformFunctions.h" |
| #include "dawn_native/d3d12/UtilsD3D12.h" |
| |
| #include <d3dcompiler.h> |
| |
| #include <spirv_hlsl.hpp> |
| |
| namespace dawn_native { namespace d3d12 { |
| |
| namespace { |
| std::vector<const wchar_t*> GetDXCArguments(uint32_t compileFlags, bool enable16BitTypes) { |
| std::vector<const wchar_t*> arguments; |
| if (compileFlags & D3DCOMPILE_ENABLE_BACKWARDS_COMPATIBILITY) { |
| arguments.push_back(L"/Gec"); |
| } |
| if (compileFlags & D3DCOMPILE_IEEE_STRICTNESS) { |
| arguments.push_back(L"/Gis"); |
| } |
| if (compileFlags & D3DCOMPILE_OPTIMIZATION_LEVEL2) { |
| switch (compileFlags & D3DCOMPILE_OPTIMIZATION_LEVEL2) { |
| case D3DCOMPILE_OPTIMIZATION_LEVEL0: |
| arguments.push_back(L"/O0"); |
| break; |
| case D3DCOMPILE_OPTIMIZATION_LEVEL2: |
| arguments.push_back(L"/O2"); |
| break; |
| case D3DCOMPILE_OPTIMIZATION_LEVEL3: |
| arguments.push_back(L"/O3"); |
| break; |
| } |
| } |
| if (compileFlags & D3DCOMPILE_DEBUG) { |
| arguments.push_back(L"/Zi"); |
| } |
| if (compileFlags & D3DCOMPILE_PACK_MATRIX_ROW_MAJOR) { |
| arguments.push_back(L"/Zpr"); |
| } |
| if (compileFlags & D3DCOMPILE_PACK_MATRIX_COLUMN_MAJOR) { |
| arguments.push_back(L"/Zpc"); |
| } |
| if (compileFlags & D3DCOMPILE_AVOID_FLOW_CONTROL) { |
| arguments.push_back(L"/Gfa"); |
| } |
| if (compileFlags & D3DCOMPILE_PREFER_FLOW_CONTROL) { |
| arguments.push_back(L"/Gfp"); |
| } |
| if (compileFlags & D3DCOMPILE_RESOURCES_MAY_ALIAS) { |
| arguments.push_back(L"/res_may_alias"); |
| } |
| |
| if (enable16BitTypes) { |
| // enable-16bit-types are only allowed in -HV 2018 (default) |
| arguments.push_back(L"/enable-16bit-types"); |
| } else { |
| // Enable FXC backward compatibility by setting the language version to 2016 |
| arguments.push_back(L"-HV"); |
| arguments.push_back(L"2016"); |
| } |
| return arguments; |
| } |
| |
| } // anonymous namespace |
| |
| // static |
| ResultOrError<ShaderModule*> ShaderModule::Create(Device* device, |
| const ShaderModuleDescriptor* descriptor) { |
| Ref<ShaderModule> module = AcquireRef(new ShaderModule(device, descriptor)); |
| DAWN_TRY(module->Initialize()); |
| return module.Detach(); |
| } |
| |
| ShaderModule::ShaderModule(Device* device, const ShaderModuleDescriptor* descriptor) |
| : ShaderModuleBase(device, descriptor) { |
| } |
| |
| MaybeError ShaderModule::Initialize() { |
| DAWN_TRY(InitializeBase()); |
| const std::vector<uint32_t>& spirv = GetSpirv(); |
| |
| if (GetDevice()->IsToggleEnabled(Toggle::UseSpvc)) { |
| shaderc_spvc::CompileOptions options = GetCompileOptions(); |
| |
| options.SetForceZeroInitializedVariables(true); |
| if (GetDevice()->IsExtensionEnabled(Extension::ShaderFloat16)) { |
| options.SetHLSLShaderModel(ToBackend(GetDevice())->GetDeviceInfo().shaderModel); |
| options.SetHLSLEnable16BitTypes(true); |
| } else { |
| options.SetHLSLShaderModel(51); |
| } |
| // PointCoord and PointSize are not supported in HLSL |
| // TODO (hao.x.li@intel.com): The point_coord_compat and point_size_compat are |
| // required temporarily for https://bugs.chromium.org/p/dawn/issues/detail?id=146, |
| // but should be removed once WebGPU requires there is no gl_PointSize builtin. |
| // See https://github.com/gpuweb/gpuweb/issues/332 |
| options.SetHLSLPointCoordCompat(true); |
| options.SetHLSLPointSizeCompat(true); |
| options.SetHLSLNonWritableUAVTextureAsSRV(true); |
| |
| DAWN_TRY(CheckSpvcSuccess( |
| mSpvcContext.InitializeForHlsl(spirv.data(), spirv.size(), options), |
| "Unable to initialize instance of spvc")); |
| |
| spirv_cross::Compiler* compiler; |
| DAWN_TRY(CheckSpvcSuccess(mSpvcContext.GetCompiler(reinterpret_cast<void**>(&compiler)), |
| "Unable to get cross compiler")); |
| DAWN_TRY(ExtractSpirvInfo(*compiler)); |
| } else { |
| spirv_cross::CompilerHLSL compiler(spirv); |
| DAWN_TRY(ExtractSpirvInfo(compiler)); |
| } |
| return {}; |
| } |
| |
| ResultOrError<std::string> ShaderModule::GetHLSLSource(PipelineLayout* layout) { |
| ASSERT(!IsError()); |
| const std::vector<uint32_t>& spirv = GetSpirv(); |
| |
| std::unique_ptr<spirv_cross::CompilerHLSL> compilerImpl; |
| spirv_cross::CompilerHLSL* compiler = nullptr; |
| if (!GetDevice()->IsToggleEnabled(Toggle::UseSpvc)) { |
| // If these options are changed, the values in DawnSPIRVCrossHLSLFastFuzzer.cpp need to |
| // be updated. |
| spirv_cross::CompilerGLSL::Options options_glsl; |
| // Force all uninitialized variables to be 0, otherwise they will fail to compile |
| // by FXC. |
| options_glsl.force_zero_initialized_variables = true; |
| |
| spirv_cross::CompilerHLSL::Options options_hlsl; |
| if (GetDevice()->IsExtensionEnabled(Extension::ShaderFloat16)) { |
| options_hlsl.shader_model = ToBackend(GetDevice())->GetDeviceInfo().shaderModel; |
| options_hlsl.enable_16bit_types = true; |
| } else { |
| options_hlsl.shader_model = 51; |
| } |
| // PointCoord and PointSize are not supported in HLSL |
| // TODO (hao.x.li@intel.com): The point_coord_compat and point_size_compat are |
| // required temporarily for https://bugs.chromium.org/p/dawn/issues/detail?id=146, |
| // but should be removed once WebGPU requires there is no gl_PointSize builtin. |
| // See https://github.com/gpuweb/gpuweb/issues/332 |
| options_hlsl.point_coord_compat = true; |
| options_hlsl.point_size_compat = true; |
| options_hlsl.nonwritable_uav_texture_as_srv = true; |
| |
| compilerImpl = std::make_unique<spirv_cross::CompilerHLSL>(spirv); |
| compiler = compilerImpl.get(); |
| compiler->set_common_options(options_glsl); |
| compiler->set_hlsl_options(options_hlsl); |
| } |
| |
| const ModuleBindingInfo& moduleBindingInfo = GetBindingInfo(); |
| for (BindGroupIndex group : IterateBitSet(layout->GetBindGroupLayoutsMask())) { |
| const BindGroupLayout* bgl = ToBackend(layout->GetBindGroupLayout(group)); |
| const auto& bindingOffsets = bgl->GetBindingOffsets(); |
| const auto& groupBindingInfo = moduleBindingInfo[group]; |
| for (const auto& it : groupBindingInfo) { |
| const ShaderBindingInfo& bindingInfo = it.second; |
| BindingNumber bindingNumber = it.first; |
| BindingIndex bindingIndex = bgl->GetBindingIndex(bindingNumber); |
| |
| // Declaring a read-only storage buffer in HLSL but specifying a storage buffer in |
| // the BGL produces the wrong output. Force read-only storage buffer bindings to |
| // be treated as UAV instead of SRV. |
| const bool forceStorageBufferAsUAV = |
| (bindingInfo.type == wgpu::BindingType::ReadonlyStorageBuffer && |
| bgl->GetBindingInfo(bindingIndex).type == wgpu::BindingType::StorageBuffer); |
| |
| uint32_t bindingOffset = bindingOffsets[bindingIndex]; |
| if (GetDevice()->IsToggleEnabled(Toggle::UseSpvc)) { |
| DAWN_TRY(CheckSpvcSuccess( |
| mSpvcContext.SetDecoration(bindingInfo.id, SHADERC_SPVC_DECORATION_BINDING, |
| bindingOffset), |
| "Unable to set decorating binding before generating HLSL shader w/ " |
| "spvc")); |
| if (forceStorageBufferAsUAV) { |
| DAWN_TRY(CheckSpvcSuccess( |
| mSpvcContext.SetHLSLForceStorageBufferAsUAV( |
| static_cast<uint32_t>(group), static_cast<uint32_t>(bindingNumber)), |
| "Unable to force read-only storage buffer as UAV w/ spvc")); |
| } |
| } else { |
| compiler->set_decoration(bindingInfo.id, spv::DecorationBinding, bindingOffset); |
| if (forceStorageBufferAsUAV) { |
| compiler->set_hlsl_force_storage_buffer_as_uav( |
| static_cast<uint32_t>(group), static_cast<uint32_t>(bindingNumber)); |
| } |
| } |
| } |
| } |
| if (GetDevice()->IsToggleEnabled(Toggle::UseSpvc)) { |
| shaderc_spvc::CompilationResult result; |
| DAWN_TRY(CheckSpvcSuccess(mSpvcContext.CompileShader(&result), |
| "Unable to generate HLSL shader w/ spvc")); |
| std::string result_string; |
| DAWN_TRY(CheckSpvcSuccess(result.GetStringOutput(&result_string), |
| "Unable to get HLSL shader text")); |
| return std::move(result_string); |
| } else { |
| return compiler->compile(); |
| } |
| } |
| |
| ResultOrError<ComPtr<IDxcBlob>> ShaderModule::CompileShaderDXC(SingleShaderStage stage, |
| const std::string& hlslSource, |
| const char* entryPoint, |
| uint32_t compileFlags) { |
| IDxcLibrary* dxcLibrary; |
| DAWN_TRY_ASSIGN(dxcLibrary, ToBackend(GetDevice())->GetOrCreateDxcLibrary()); |
| |
| ComPtr<IDxcBlobEncoding> sourceBlob; |
| DAWN_TRY(CheckHRESULT(dxcLibrary->CreateBlobWithEncodingOnHeapCopy( |
| hlslSource.c_str(), hlslSource.length(), CP_UTF8, &sourceBlob), |
| "DXC create blob")); |
| |
| IDxcCompiler* dxcCompiler; |
| DAWN_TRY_ASSIGN(dxcCompiler, ToBackend(GetDevice())->GetOrCreateDxcCompiler()); |
| |
| std::wstring entryPointW; |
| DAWN_TRY_ASSIGN(entryPointW, ConvertStringToWstring(entryPoint)); |
| |
| std::vector<const wchar_t*> arguments = GetDXCArguments( |
| compileFlags, GetDevice()->IsExtensionEnabled(Extension::ShaderFloat16)); |
| |
| ComPtr<IDxcOperationResult> result; |
| DAWN_TRY( |
| CheckHRESULT(dxcCompiler->Compile( |
| sourceBlob.Get(), nullptr, entryPointW.c_str(), |
| ToBackend(GetDevice())->GetDeviceInfo().shaderProfiles[stage].c_str(), |
| arguments.data(), arguments.size(), nullptr, 0, nullptr, &result), |
| "DXC compile")); |
| |
| HRESULT hr; |
| DAWN_TRY(CheckHRESULT(result->GetStatus(&hr), "DXC get status")); |
| |
| if (FAILED(hr)) { |
| ComPtr<IDxcBlobEncoding> errors; |
| DAWN_TRY(CheckHRESULT(result->GetErrorBuffer(&errors), "DXC get error buffer")); |
| |
| std::string message = std::string("DXC compile failed with ") + |
| static_cast<char*>(errors->GetBufferPointer()); |
| return DAWN_INTERNAL_ERROR(message); |
| } |
| |
| ComPtr<IDxcBlob> compiledShader; |
| DAWN_TRY(CheckHRESULT(result->GetResult(&compiledShader), "DXC get result")); |
| return std::move(compiledShader); |
| } |
| |
| ResultOrError<ComPtr<ID3DBlob>> ShaderModule::CompileShaderFXC(SingleShaderStage stage, |
| const std::string& hlslSource, |
| const char* entryPoint, |
| uint32_t compileFlags) { |
| const char* targetProfile = nullptr; |
| switch (stage) { |
| case SingleShaderStage::Vertex: |
| targetProfile = "vs_5_1"; |
| break; |
| case SingleShaderStage::Fragment: |
| targetProfile = "ps_5_1"; |
| break; |
| case SingleShaderStage::Compute: |
| targetProfile = "cs_5_1"; |
| break; |
| } |
| |
| ComPtr<ID3DBlob> compiledShader; |
| ComPtr<ID3DBlob> errors; |
| |
| const PlatformFunctions* functions = ToBackend(GetDevice())->GetFunctions(); |
| if (FAILED(functions->d3dCompile(hlslSource.c_str(), hlslSource.length(), nullptr, nullptr, |
| nullptr, entryPoint, targetProfile, compileFlags, 0, |
| &compiledShader, &errors))) { |
| std::string message = std::string("D3D compile failed with ") + |
| static_cast<char*>(errors->GetBufferPointer()); |
| return DAWN_INTERNAL_ERROR(message); |
| } |
| |
| return std::move(compiledShader); |
| } |
| |
| }} // namespace dawn_native::d3d12 |
