Merge pull request #849 from Devsh-Graphics-Programming/full_inline_spirv_bda

DXC member decorate, Spir-V 1.4 backports and KHR_fragment_shader_barycentrics support

Author: devshgraphicsprogramming

3rdparty/dxc/dxc

@@ -146,7 +146,6 @@ class NBL_API2 CHLSLCompiler final : public IShaderCompiler
 			L"-Wno-c++1z-extensions",
 			L"-Wno-c++14-extensions",
 			L"-Wno-gnu-static-float-init",
-			L"-fspv-target-env=vulkan1.3",
 			L"-HV", L"202x"
 		});
 };

include/nbl/asset/utils/CHLSLCompiler.h

@@ -13,7 +13,7 @@ namespace hlsl
 namespace bda
 {
 template<typename T>
-using __spv_ptr_t = spirv::pointer_t<spv::StorageClassPhysicalStorageBuffer,T>;
+using __spv_ptr_t __NBL_CAPABILITY_PhysicalStorageBufferAddresses = spirv::pointer_t<spv::StorageClassPhysicalStorageBuffer,T>;
 
 template<typename T>
 struct __ptr;

include/nbl/builtin/hlsl/bda/__ref.hlsl

@@ -17,6 +17,40 @@ namespace nbl
 namespace hlsl
 {
 #ifdef __HLSL_VERSION
+
+
+#if __SPIRV_MAJOR_VERSION__>1 || (__SPIRV_MAJOR_VERSION__==1 && __SPIRV_MINOR_VERSION__>=5)
+
+#define __NBL_SPIRV_SUPERSET_1_5__
+
+#define __NBL_CAPABILITY_VulkanMemoryModel [[vk::ext_capability(spv::CapabilityVulkanMemoryModel)]]
+#define __NBL_CAPABILITY_ShaderNonUniform [[vk::ext_capability(spv::CapabilityShaderNonUniform)]]
+#define __NBL_CAPABILITY_PhysicalStorageBufferAddresses [[vk::ext_capability(spv::CapabilityPhysicalStorageBufferAddresses)]]
+// TODO: some poor soul needs to study rest of https://registry.khronos.org/SPIR-V/specs/unified1/SPIRV.html#_capability
+#define __NBL_CAPABILITY_ShaderLayer [[vk::ext_capability(spv::CapabilityShaderLayer)]]
+#define __NBL_CAPABILITY_ShaderViewportIndex [[vk::ext_capability(spv::CapabilityShaderViewportIndex)]]
+
+#else
+
+#define __NBL_CAPABILITY_VulkanMemoryModel [[vk::ext_capability(spv::CapabilityVulkanMemoryModel)]] [[vk::ext_extension("SPV_KHR_vulkan_memory_model")]]
+#define __NBL_CAPABILITY_ShaderNonUniform [[vk::ext_capability(spv::CapabilityShaderNonUniform)]] [[vk::ext_extension("SPV_EXT_descriptor_indexing")]]
+#define __NBL_CAPABILITY_PhysicalStorageBufferAddresses [[vk::ext_capability(spv::CapabilityPhysicalStorageBufferAddresses)]] [[vk::ext_extension("SPV_KHR_physical_storage_buffer")]]
+
+#endif
+
+
+#if __SPIRV_MAJOR_VERSION__>1 || (__SPIRV_MAJOR_VERSION__==1 && __SPIRV_MINOR_VERSION__>=6)
+
+#define __NBL_SPIRV_SUPERSET_1_6__
+
+// 1.6 core caps
+
+#else
+
+// 1.6 core caps and their old extensions
+
+#endif
+
 namespace spirv
 {
 //! General
@@ -171,7 +205,7 @@ enable_if_t<is_spirv_type_v<Ptr_T>, T> atomicCompareExchange(Ptr_T ptr, uint32_t
 
 
 template<typename T, uint32_t alignment>
-[[vk::ext_capability(spv::CapabilityPhysicalStorageBufferAddresses)]]
+__NBL_CAPABILITY_PhysicalStorageBufferAddresses
 [[vk::ext_instruction(spv::OpLoad)]]
 T load(pointer_t<spv::StorageClassPhysicalStorageBuffer,T> pointer, [[vk::ext_literal]] uint32_t __aligned = /*Aligned*/0x00000002, [[vk::ext_literal]] uint32_t __alignment = alignment);
 
@@ -180,7 +214,7 @@ template<typename T, typename P>
 enable_if_t<is_spirv_type_v<P>,T> load(P pointer);
 
 template<typename T, uint32_t alignment>
-[[vk::ext_capability(spv::CapabilityPhysicalStorageBufferAddresses)]]
+__NBL_CAPABILITY_PhysicalStorageBufferAddresses
 [[vk::ext_instruction(spv::OpStore)]]
 void store(pointer_t<spv::StorageClassPhysicalStorageBuffer,T>  pointer, T obj, [[vk::ext_literal]] uint32_t __aligned = /*Aligned*/0x00000002, [[vk::ext_literal]] uint32_t __alignment = alignment);
 
@@ -205,12 +239,12 @@ template<typename T, typename U>
 enable_if_t<is_spirv_type_v<T> && is_spirv_type_v<U>, T> bitcast(U);
 
 template<typename T>
-[[vk::ext_capability(spv::CapabilityPhysicalStorageBufferAddresses)]]
+__NBL_CAPABILITY_PhysicalStorageBufferAddresses
 [[vk::ext_instruction(spv::OpBitcast)]]
 uint64_t bitcast(pointer_t<spv::StorageClassPhysicalStorageBuffer,T>);
 
 template<typename T>
-[[vk::ext_capability(spv::CapabilityPhysicalStorageBufferAddresses)]]
+__NBL_CAPABILITY_PhysicalStorageBufferAddresses
 [[vk::ext_instruction(spv::OpBitcast)]]
 pointer_t<spv::StorageClassPhysicalStorageBuffer,T> bitcast(uint64_t);
 
@@ -269,8 +303,7 @@ enable_if_t<is_vector_v<BooleanVector>&& is_same_v<typename vector_traits<Boolea
 }
 
 #endif
-    }
 }
-
+}
 #endif
 #endif

include/nbl/builtin/hlsl/spirv_intrinsics/core.hlsl

@@ -0,0 +1,30 @@
+// Copyright (C) 2023 - DevSH Graphics Programming Sp. z O.O.
+// This file is part of the "Nabla Engine".
+// For conditions of distribution and use, see copyright notice in nabla.h
+#ifndef _NBL_BUILTIN_HLSL_SPIRV_INTRINSICS_FRAGMENT_SHADER_BARYCENTRIC_INCLUDED_
+#define _NBL_BUILTIN_HLSL_SPIRV_INTRINSICS_FRAGMENT_SHADER_BARYCENTRIC_INCLUDED_
+
+#include "spirv/unified1/spirv.hpp"
+
+namespace nbl 
+{
+namespace hlsl
+{
+namespace spirv
+{
+
+[[vk::ext_capability(/*spv::CapabilityFragmentBarycentricKHR*/5284)]]
+[[vk::ext_extension("SPV_KHR_fragment_shader_barycentric")]]
+[[vk::ext_builtin_input(/*spv::BuiltInBaryCoordKHR*/5286)]]
+static const float32_t3 BaryCoordKHR;
+
+[[vk::ext_capability(/*spv::CapabilityFragmentBarycentricKHR*/5284)]]
+[[vk::ext_extension("SPV_KHR_fragment_shader_barycentric")]]
+[[vk::ext_builtin_input(/*spv::BuiltInBaryCoordKHR*/5287)]]
+static const float32_t3 BaryCoordNoPerspKHR;
+
+}
+}
+}
+
+#endif

include/nbl/builtin/hlsl/spirv_intrinsics/fragment_shader_barycentric.hlsl

@@ -7,6 +7,9 @@
 // For all WaveMultiPrefix* ops, an example can be found here https://github.com/microsoft/DirectXShaderCompiler/blob/4e5440e1ee1f30d1164f90445611328293de08fa/tools/clang/test/HLSLFileCheck/hlsl/intrinsics/wave/prefix/sm_6_5_wave.hlsl
 // However, we prefer to implement them with SPIRV intrinsics to avoid DXC changes in the compiler's emitted code
 
+
+#include "nbl/builtin/hlsl/spirv_intrinsics/core.hlsl"
+
 namespace nbl 
 {
 namespace hlsl

include/nbl/builtin/hlsl/spirv_intrinsics/subgroup_arithmetic.hlsl

@@ -5,7 +5,7 @@
 #define _NBL_BUILTIN_HLSL_SPIRV_INTRINSICS_SUBGROUP_VOTE_INCLUDED_
 
 
-#include "nbl/builtin/hlsl/spirv_intrinsics/basic.hlsl"
+#include "nbl/builtin/hlsl/spirv_intrinsics/subgroup_basic.hlsl"
 
 
 namespace nbl 

include/nbl/builtin/hlsl/spirv_intrinsics/subgroup_vote.hlsl

@@ -95,6 +95,26 @@ CHLSLCompiler::~CHLSLCompiler()
     delete m_dxcCompilerTypes;
 }
 
+static bool fixup_spirv_target_ver(std::vector<std::wstring>& arguments, system::logger_opt_ptr& logger)
+{
+    constexpr std::wstring_view Prefix = L"-fspv-target-env=";
+    const std::set<std::wstring_view> AllowedSuffices = {L"vulkan1.1spirv1.4",L"vulkan1.2",L"vulkan1.3"};
+
+    for (auto targetEnvArgumentPos=arguments.begin(); targetEnvArgumentPos!=arguments.end(); targetEnvArgumentPos++)
+    if (targetEnvArgumentPos->find(Prefix)==0)
+    {
+        const auto suffix = targetEnvArgumentPos->substr(Prefix.length());
+        const auto found = AllowedSuffices.find(suffix);
+        if (found!=AllowedSuffices.end())
+            return true;
+        logger.log("Compile flag error: Required compile flag not found -fspv-target-env=. Force enabling -fspv-target-env= found but with unsupported value `%s`.", system::ILogger::ELL_ERROR, "TODO: write wchar to char convert usage");
+        return false;
+    }
+
+    logger.log("Compile flag error: Required compile flag not found -fspv-target-env=. Force enabling -fspv-target-env=vulkan1.3, as it is required by Nabla.", system::ILogger::ELL_WARNING);
+    arguments.push_back(L"-fspv-target-env=vulkan1.3");
+    return true;
+}
 
 static void try_upgrade_hlsl_version(std::vector<std::wstring>& arguments, system::logger_opt_ptr& logger)
 {
@@ -418,35 +438,49 @@ core::smart_refctd_ptr<ICPUShader> CHLSLCompiler::compileToSPIRV_impl(const std:
     std::wstring targetProfile(SHADER_MODEL_PROFILE);
 
     std::vector<std::wstring> arguments = {};
-    if (dxc_compile_flags.size()) { // #pragma dxc_compile_flags takes priority
+    if (!dxc_compile_flags.empty()) // #pragma dxc_compile_flags takes priority
         populate_arguments_with_type_conversion(arguments, dxc_compile_flags, logger);
-    }
-    else if (hlslOptions.dxcOptions.size()) { // second in order of priority is command line arguments
-        populate_arguments_with_type_conversion(arguments, hlslOptions.dxcOptions, logger);
-    }
-    else { // lastly default arguments
-        const auto required = CHLSLCompiler::getRequiredArguments();
-        arguments = {};
-        for (size_t i = 0; i < required.size(); i++)
-            arguments.push_back(required[i]);
-        arguments.push_back(L"-HV");
-        arguments.push_back(L"202x");
-        // TODO: add this to `CHLSLCompiler::SOptions` and handle it properly in `dxc_compile_flags.empty()`
-        if (stage != asset::IShader::E_SHADER_STAGE::ESS_ALL_OR_LIBRARY) {
-            arguments.push_back(L"-E");
-            arguments.push_back(L"main");
-        }
-        // If a custom SPIR-V optimizer is specified, use that instead of DXC's spirv-opt.
-        // This is how we can get more optimizer options.
-        // 
-        // Optimization is also delegated to SPIRV-Tools. Right now there are no difference between 
-        // optimization levels greater than zero; they will all invoke the same optimization recipe. 
-        // https://github.com/Microsoft/DirectXShaderCompiler/blob/main/docs/SPIR-V.rst#optimization
-        if (hlslOptions.spirvOptimizer)
-            arguments.push_back(L"-O0");
-    }
-    if (dxc_compile_flags.empty())
+    else
     {
+        if (hlslOptions.dxcOptions.size()) // second in order of priority is command line arguments
+            populate_arguments_with_type_conversion(arguments, hlslOptions.dxcOptions, logger);
+        else // lastly default arguments from polymorphic options
+        {
+            const auto required = CHLSLCompiler::getRequiredArguments();
+            arguments = {};
+            for (size_t i = 0; i < required.size(); i++)
+                arguments.push_back(required[i]);
+            //
+            switch (options.targetSpirvVersion)
+            {
+                case hlsl::SpirvVersion::ESV_1_4:
+                    arguments.push_back(L"-fspv-target-env=vulkan1.1spirv1.4");
+                case hlsl::SpirvVersion::ESV_1_5:
+                    arguments.push_back(L"-fspv-target-env=vulkan1.2");
+                    break;
+                case hlsl::SpirvVersion::ESV_1_6:
+                    arguments.push_back(L"-fspv-target-env=vulkan1.3");
+                    break;
+                default:
+                    logger.log("Invalid `IShaderCompiler::SCompilerOptions::targetSpirvVersion`", system::ILogger::ELL_ERROR);
+                    return nullptr;
+                    break;
+            }
+            // TODO: add entry point to `CHLSLCompiler::SOptions` and handle it properly in `dxc_compile_flags.empty()`
+            if (stage != asset::IShader::E_SHADER_STAGE::ESS_ALL_OR_LIBRARY) {
+                arguments.push_back(L"-E");
+                arguments.push_back(L"main");
+            }
+            // If a custom SPIR-V optimizer is specified, use that instead of DXC's spirv-opt.
+            // This is how we can get more optimizer options.
+            // 
+            // Optimization is also delegated to SPIRV-Tools. Right now there are no difference between 
+            // optimization levels greater than zero; they will all invoke the same optimization recipe. 
+            // https://github.com/Microsoft/DirectXShaderCompiler/blob/main/docs/SPIR-V.rst#optimization
+            if (hlslOptions.spirvOptimizer)
+                arguments.push_back(L"-O0");
+        }
+        //
         auto set = std::unordered_set<std::wstring>();
         for (int i = 0; i < arguments.size(); i++)
             set.insert(arguments[i]);
@@ -469,6 +503,9 @@ core::smart_refctd_ptr<ICPUShader> CHLSLCompiler::compileToSPIRV_impl(const std:
             add_if_missing(L"-fspv-debug=vulkan-with-source");
     }
 
+    if (!fixup_spirv_target_ver(arguments, logger))
+        return nullptr;
+
     try_upgrade_shader_stage(arguments, stage, logger);
     try_upgrade_hlsl_version(arguments, logger);
 

src/nbl/asset/utils/CHLSLCompiler.cpp

@@ -230,6 +230,7 @@ LIST_BUILTIN_RESOURCE(NBL_RESOURCES_TO_EMBED "hlsl/matrix_utils/matrix_traits.hl
 #spirv intrinsics
 LIST_BUILTIN_RESOURCE(NBL_RESOURCES_TO_EMBED "hlsl/spirv_intrinsics/core.hlsl")
 LIST_BUILTIN_RESOURCE(NBL_RESOURCES_TO_EMBED "hlsl/spirv_intrinsics/fragment_shader_pixel_interlock.hlsl")
+LIST_BUILTIN_RESOURCE(NBL_RESOURCES_TO_EMBED "hlsl/spirv_intrinsics/fragment_shader_barycentric.hlsl")
 LIST_BUILTIN_RESOURCE(NBL_RESOURCES_TO_EMBED "hlsl/spirv_intrinsics/raytracing.hlsl")
 LIST_BUILTIN_RESOURCE(NBL_RESOURCES_TO_EMBED "hlsl/spirv_intrinsics/subgroup_arithmetic.hlsl")
 LIST_BUILTIN_RESOURCE(NBL_RESOURCES_TO_EMBED "hlsl/spirv_intrinsics/subgroup_ballot.hlsl")