From ad658f07caaecb1d5a2de84868c07067959b36e6 Mon Sep 17 00:00:00 2001 From: assiduous Date: Mon, 14 Sep 2020 14:24:57 -0700 Subject: Refactoring shader compilation - part III --- Graphics/ShaderTools/include/DXCompiler.hpp | 14 +++-- Graphics/ShaderTools/include/HLSLUtils.hpp | 2 + Graphics/ShaderTools/src/DXCompiler.cpp | 84 +++++++++++++++-------------- Graphics/ShaderTools/src/DXILUtilsStub.cpp | 8 --- Graphics/ShaderTools/src/HLSLUtils.cpp | 26 +++++++++ 5 files changed, 79 insertions(+), 55 deletions(-) (limited to 'Graphics/ShaderTools') diff --git a/Graphics/ShaderTools/include/DXCompiler.hpp b/Graphics/ShaderTools/include/DXCompiler.hpp index 10d60be7..d361361c 100644 --- a/Graphics/ShaderTools/include/DXCompiler.hpp +++ b/Graphics/ShaderTools/include/DXCompiler.hpp @@ -73,6 +73,12 @@ public: }; virtual bool Compile(const CompileAttribs& Attribs) = 0; + virtual void Compile(const ShaderCreateInfo& ShaderCI, + const char* ExtraDefinitions, + IDxcBlob** ppByteCodeBlob, + std::vector* pByteCode, + IDataBlob** ppCompilerOutput) noexcept(false) = 0; + // Attempts to extract shader reflection from the bytecode using DXC. virtual void GetD3D12ShaderReflection(IDxcBlob* pShaderBytecode, ID3D12ShaderReflection** ppShaderReflection) = 0; @@ -83,12 +89,4 @@ public: IDXCompiler* CreateDXCompiler(DXCompilerTarget Target, const char* pLibraryName); -#if VULKAN_SUPPORTED -std::vector DXILtoSPIRV(IDXCompiler* pLibrary, - const ShaderCreateInfo& Attribs, - const char* ExtraDefinitions, - IDataBlob** ppCompilerOutput) noexcept(false); -#endif - - } // namespace Diligent diff --git a/Graphics/ShaderTools/include/HLSLUtils.hpp b/Graphics/ShaderTools/include/HLSLUtils.hpp index 8d8774f5..9abd1e7d 100644 --- a/Graphics/ShaderTools/include/HLSLUtils.hpp +++ b/Graphics/ShaderTools/include/HLSLUtils.hpp @@ -37,4 +37,6 @@ namespace Diligent String BuildHLSLSourceString(const ShaderCreateInfo& ShaderCI, const char* ExtraDefinitions = nullptr); +String GetHLSLProfileString(SHADER_TYPE ShaderType, ShaderVersion ShaderModel); + } // namespace Diligent diff --git a/Graphics/ShaderTools/src/DXCompiler.cpp b/Graphics/ShaderTools/src/DXCompiler.cpp index 80235f65..3ce6066f 100644 --- a/Graphics/ShaderTools/src/DXCompiler.cpp +++ b/Graphics/ShaderTools/src/DXCompiler.cpp @@ -83,6 +83,12 @@ public: bool Compile(const CompileAttribs& Attribs) override final; + virtual void Compile(const ShaderCreateInfo& ShaderCI, + const char* ExtraDefinitions, + IDxcBlob** ppByteCodeBlob, + std::vector* pByteCode, + IDataBlob** ppCompilerOutput) noexcept(false) override final; + virtual void GetD3D12ShaderReflection(IDxcBlob* pShaderBytecode, ID3D12ShaderReflection** ppShaderReflection) override final; @@ -404,18 +410,21 @@ void DXCompilerImpl::GetD3D12ShaderReflection(IDxcBlob* pShaderBy -#if VULKAN_SUPPORTED - -std::vector DXILtoSPIRV(IDXCompiler* pLibrary, - const ShaderCreateInfo& ShaderCI, - const char* ExtraDefinitions, - IDataBlob** ppCompilerOutput) noexcept(false) +void DXCompilerImpl::Compile(const ShaderCreateInfo& ShaderCI, + const char* ExtraDefinitions, + IDxcBlob** ppByteCodeBlob, + std::vector* pByteCode, + IDataBlob** ppCompilerOutput) noexcept(false) { - + if (!IsLoaded()) + { + UNEXPECTED("DX compiler is not loaded"); + return; + } // validate shader version ShaderVersion ShaderModel = ShaderCI.HLSLVersion; - ShaderVersion MaxSM = pLibrary->GetMaxShaderModel(); + ShaderVersion MaxSM = GetMaxShaderModel(); if (ShaderModel.Major < 6 || ShaderModel.Major > MaxSM.Major) ShaderModel = MaxSM; @@ -423,27 +432,11 @@ std::vector DXILtoSPIRV(IDXCompiler* pLibrary, if (ShaderModel.Major == MaxSM.Major && ShaderModel.Minor > MaxSM.Minor) ShaderModel = MaxSM; - std::wstring Profile; - switch (ShaderCI.Desc.ShaderType) - { - // clang-format off - case SHADER_TYPE_VERTEX: Profile = L"vs_"; break; - case SHADER_TYPE_PIXEL: Profile = L"ps_"; break; - case SHADER_TYPE_GEOMETRY: Profile = L"gs_"; break; - case SHADER_TYPE_HULL: Profile = L"hs_"; break; - case SHADER_TYPE_DOMAIN: Profile = L"ds_"; break; - case SHADER_TYPE_COMPUTE: Profile = L"cs_"; break; - case SHADER_TYPE_AMPLIFICATION: Profile = L"as_"; break; - case SHADER_TYPE_MESH: Profile = L"ms_"; break; - default: UNEXPECTED("Unexpected shader type"); - // clang-format on - } - - Profile += L'0' + (ShaderModel.Major % 10); - Profile += L'_'; - Profile += L'0' + (ShaderModel.Minor % 10); + const auto Profile = GetHLSLProfileString(ShaderCI.Desc.ShaderType, ShaderModel); + const std::wstring wstrProfile{Profile.begin(), Profile.end()}; + const std::wstring wstrEntryPoint{ShaderCI.EntryPoint, ShaderCI.EntryPoint + strlen(ShaderCI.EntryPoint)}; - const wchar_t* pArgs[] = + const wchar_t* pSpirvArgs[] = { L"-spirv", L"-fspv-reflect", @@ -452,6 +445,20 @@ std::vector DXILtoSPIRV(IDXCompiler* pLibrary, L"-O3", // Optimization level 3 }; + const wchar_t* pDxbcArgs[] = + { + L"-Zpc", // Matrices in column-major order + //L"-WX", // Warnings as errors +#ifdef DILIGENT_DEBUG + L"-Zi", // Debug info + //L"-Qembed_debug", // Embed debug info into the shader (some compilers do not recognize this flag) + L"-Od", // Disable optimization +#else + L"-Od", // TODO: something goes wrong if optimization is enabled + //L"-O3", // Optimization level 3 +#endif + }; + CComPtr compiled; CComPtr errors; @@ -461,18 +468,17 @@ std::vector DXILtoSPIRV(IDXCompiler* pLibrary, CA.Source = Source.c_str(); CA.SourceLength = static_cast(Source.length()); - auto wstrEntryPoint = std::wstring{ShaderCI.EntryPoint, ShaderCI.EntryPoint + strlen(ShaderCI.EntryPoint)}; CA.EntryPoint = wstrEntryPoint.c_str(); - CA.Profile = Profile.c_str(); + CA.Profile = wstrProfile.c_str(); CA.pDefines = nullptr; CA.DefinesCount = 0; - CA.pArgs = pArgs; - CA.ArgsCount = _countof(pArgs); + CA.pArgs = m_Target == DXCompilerTarget::Direct3D12 ? pDxbcArgs : pSpirvArgs; + CA.ArgsCount = m_Target == DXCompilerTarget::Direct3D12 ? _countof(pDxbcArgs) : _countof(pSpirvArgs); CA.pShaderSourceStreamFactory = ShaderCI.pShaderSourceStreamFactory; CA.ppBlobOut = &compiled; CA.ppCompilerOutput = &errors; - auto result = pLibrary->Compile(CA); + auto result = Compile(CA); const size_t CompilerMsgLen = errors ? errors->GetBufferSize() : 0; const char* CompilerMsg = CompilerMsgLen > 0 ? static_cast(errors->GetBufferPointer()) : nullptr; @@ -499,15 +505,15 @@ std::vector DXILtoSPIRV(IDXCompiler* pLibrary, } } - std::vector SPIRV; if (result && compiled && compiled->GetBufferSize() > 0) { - SPIRV.assign(static_cast(compiled->GetBufferPointer()), - static_cast(compiled->GetBufferPointer()) + compiled->GetBufferSize() / sizeof(uint32_t)); + if (pByteCode != nullptr) + pByteCode->assign(static_cast(compiled->GetBufferPointer()), + static_cast(compiled->GetBufferPointer()) + compiled->GetBufferSize() / sizeof(uint32_t)); + + if (ppByteCodeBlob != nullptr) + *ppByteCodeBlob = compiled.Detach(); } - return SPIRV; } -#endif // VULKAN_SUPPORTED - } // namespace Diligent diff --git a/Graphics/ShaderTools/src/DXILUtilsStub.cpp b/Graphics/ShaderTools/src/DXILUtilsStub.cpp index 4a801fc0..5cdb842a 100644 --- a/Graphics/ShaderTools/src/DXILUtilsStub.cpp +++ b/Graphics/ShaderTools/src/DXILUtilsStub.cpp @@ -35,12 +35,4 @@ IDXCompiler* CreateDXCompiler(DXCompilerTarget Target, const char* pLibraryName) return nullptr; } -std::vector DXILtoSPIRV(IDXCompiler* pLibrary, - const ShaderCreateInfo& Attribs, - const char* ExtraDefinitions, - IDataBlob** ppCompilerOutput) noexcept(false) -{ - return {}; -} - } // namespace Diligent diff --git a/Graphics/ShaderTools/src/HLSLUtils.cpp b/Graphics/ShaderTools/src/HLSLUtils.cpp index 94ffcd3e..613eea25 100644 --- a/Graphics/ShaderTools/src/HLSLUtils.cpp +++ b/Graphics/ShaderTools/src/HLSLUtils.cpp @@ -65,4 +65,30 @@ String BuildHLSLSourceString(const ShaderCreateInfo& ShaderCI, return HLSLSource; } +String GetHLSLProfileString(SHADER_TYPE ShaderType, ShaderVersion ShaderModel) +{ + String strShaderProfile; + switch (ShaderType) + { + // clang-format off + case SHADER_TYPE_VERTEX: strShaderProfile = "vs"; break; + case SHADER_TYPE_PIXEL: strShaderProfile = "ps"; break; + case SHADER_TYPE_GEOMETRY: strShaderProfile = "gs"; break; + case SHADER_TYPE_HULL: strShaderProfile = "hs"; break; + case SHADER_TYPE_DOMAIN: strShaderProfile = "ds"; break; + case SHADER_TYPE_COMPUTE: strShaderProfile = "cs"; break; + case SHADER_TYPE_AMPLIFICATION: strShaderProfile = "as"; break; + case SHADER_TYPE_MESH: strShaderProfile = "ms"; break; + // clang-format on + default: UNEXPECTED("Unknown shader type"); + } + + strShaderProfile += "_"; + strShaderProfile += std::to_string(ShaderModel.Major); + strShaderProfile += "_"; + strShaderProfile += std::to_string(ShaderModel.Minor); + + return strShaderProfile; +} + } // namespace Diligent -- cgit v1.2.3