Draft: integrate slang-rhi (shader-slang#4970)

* add slang-rhi submodule * refactor render-test to use slang-rhi and remove OpenGL support * remove -vk -glsl tests * remove gl test * disable failing test * allow recursive submodules in github actions * update slang-rhi * update slang-rhi --------- Co-authored-by: Yong He <[email protected]>
jkwak-work · Aug 30, 2024 · f428a05 · f428a05
1 parent 12137e9
commit f428a05
Show file tree

Hide file tree

Showing 31 changed files with 176 additions and 104 deletions.
diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml
@@ -25,7 +25,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         with:
-          submodules: 'true'
+          submodules: 'recursive'
           fetch-depth: '0'
       - name: Common setup
         uses: ./.github/actions/common-setup

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -84,7 +84,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         with:
-          submodules: 'true'
+          submodules: 'recursive'
           fetch-depth: '0'
       - name: Setup
         uses: ./.github/actions/common-setup

diff --git a/.github/workflows/compile-regression-test.yml b/.github/workflows/compile-regression-test.yml
@@ -42,7 +42,7 @@ jobs:
     steps:
     - uses: actions/checkout@v3
       with:
-        submodules: 'true'
+        submodules: 'recursive'
         fetch-depth: '0'
     - name: Setup
       uses: ./.github/actions/common-setup

diff --git a/.github/workflows/falcor-compiler-perf-test.yml b/.github/workflows/falcor-compiler-perf-test.yml
@@ -44,7 +44,7 @@ jobs:
     steps:
     - uses: actions/checkout@v3
       with:
-        submodules: 'true'
+        submodules: 'recursive'
         fetch-depth: '0'
 
     - name: Setup

diff --git a/.github/workflows/falcor-test.yml b/.github/workflows/falcor-test.yml
@@ -42,7 +42,7 @@ jobs:
     steps:
     - uses: actions/checkout@v3
       with:
-        submodules: 'true'
+        submodules: 'recursive'
         fetch-depth: '0'
     - name: Setup
       uses: ./.github/actions/common-setup

diff --git a/.github/workflows/release-linux-glibc-2-17.yml b/.github/workflows/release-linux-glibc-2-17.yml
@@ -10,7 +10,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         with:
-          submodules: 'true'
+          submodules: 'recursive'
           fetch-depth: '0'
 
       # build the binary in docker image

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -42,7 +42,7 @@ jobs:
     steps:
       - uses: actions/checkout@v3
         with:
-          submodules: 'true'
+          submodules: 'recursive'
           fetch-depth: '0'
       - name: Setup
         uses: ./.github/actions/common-setup

diff --git a/.gitmodules b/.gitmodules
@@ -35,3 +35,6 @@
 [submodule "external/metal-cpp"]
 	path = external/metal-cpp
 	url = https://github.com/bkaradzic/metal-cpp
+[submodule "external/slang-rhi"]
+	path = external/slang-rhi
+	url = https://github.com/shader-slang/slang-rhi.git
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -637,8 +637,7 @@ if(SLANG_ENABLE_TESTS)
                 core
                 compiler-core
                 slang
-                gfx
-                gfx-util
+                slang-rhi
                 platform
                 $<$<BOOL:${SLANG_ENABLE_CUDA}>:CUDA::cuda_driver>
             EXTRA_COMPILE_DEFINITIONS_PRIVATE

diff --git a/external/CMakeLists.txt b/external/CMakeLists.txt
@@ -66,6 +66,12 @@ endif()
 add_library(imgui INTERFACE)
 target_include_directories(imgui INTERFACE "${CMAKE_CURRENT_LIST_DIR}/imgui")
 
+# slang-rhi
+set(SLANG_INCLUDE_DIR ${CMAKE_SOURCE_DIR}/include)
+set(SLANG_BINARY_DIR ${CMAKE_BINARY_DIR})
+set(SLANG_RHI_BUILD_TESTS OFF)
+add_subdirectory(slang-rhi)
+
 # Tidy things up:
 
 # Restore log level if we set it

diff --git a/external/slang-rhi b/external/slang-rhi
diff --git a/source/core/slang-render-api-util.cpp b/source/core/slang-render-api-util.cpp
@@ -13,7 +13,6 @@ namespace Slang {
 // NOTE! Must keep in same order as RenderApiType and have same amount of entries
 /* static */const RenderApiUtil::Info RenderApiUtil::s_infos[] =
 {
-    { RenderApiType::OpenGl, "gl,ogl,opengl",   "glsl,glsl-rewrite,glsl-cross"},
     { RenderApiType::Vulkan, "vk,vulkan",       ""},
     { RenderApiType::D3D12,  "dx12,d3d12",      ""},
     { RenderApiType::D3D11,  "dx11,d3d11",      "hlsl,hlsl-rewrite,slang"},
@@ -265,13 +264,11 @@ static bool _canLoadSharedLibrary(const char* libName)
     switch (type)
     {
 #if SLANG_WINDOWS_FAMILY
-        case RenderApiType::OpenGl: return _canLoadSharedLibrary("opengl32");
         case RenderApiType::Vulkan: return _canLoadSharedLibrary("vulkan-1") || _canLoadSharedLibrary("vk_swiftshader");
 #elif SLANG_APPLE_FAMILY
         case RenderApiType::Vulkan: return true;
         case RenderApiType::Metal:  return true;
 #elif SLANG_UNIX_FAMILY
-        case RenderApiType::OpenGl: return true;
         case RenderApiType::Vulkan: return true;
 #endif
 

diff --git a/source/core/slang-render-api-util.h b/source/core/slang-render-api-util.h
@@ -11,8 +11,7 @@ namespace Slang
 enum class RenderApiType
 {
     Unknown = -1,
-    OpenGl = 0,
-    Vulkan,
+    Vulkan = 0,
     D3D12,
     D3D11,
     Metal,
@@ -26,7 +25,6 @@ struct RenderApiFlag
 {
     enum Enum
     {
-        OpenGl = 1 << int(RenderApiType::OpenGl),
         Vulkan = 1 << int(RenderApiType::Vulkan),
         D3D12 = 1 << int(RenderApiType::D3D12),
         D3D11 = 1 << int(RenderApiType::D3D11),

diff --git a/tests/bugs/gh-4504.slang b/tests/bugs/gh-4504.slang
@@ -1,6 +1,5 @@
 //TEST(compute):COMPARE_COMPUTE(filecheck-buffer=CHECK):-slang -dx12 -compute -shaderobj
 //TEST(compute, vulkan):COMPARE_COMPUTE(filecheck-buffer=CHECK):-vk -compute -shaderobj
-//TEST(compute, vulkan):COMPARE_COMPUTE(filecheck-buffer=CHECK):-vk -glsl -compute -shaderobj
 //TEST(compute, vulkan):COMPARE_COMPUTE(filecheck-buffer=CHECK):-mtl -compute -shaderobj
 
 //TEST_INPUT:ubuffer(data=[0], stride=4):out,name=outputBuffer
@@ -20,4 +19,4 @@ void computeMain(uint3 threadId: SV_DispatchThreadID)
         && size.y == 2
         && size.z == 1
         ;
-}
+}
diff --git a/tests/bugs/gh-4556.slang b/tests/bugs/gh-4556.slang
@@ -1,6 +1,5 @@
 //TEST(compute):COMPARE_COMPUTE(filecheck-buffer=CHECK):-dx12 -compute -output-using-type -shaderobj
 //TEST(compute, vulkan):COMPARE_COMPUTE(filecheck-buffer=CHECK):-vk -compute -output-using-type -shaderobj
-//TEST(compute, vulkan):COMPARE_COMPUTE(filecheck-buffer=CHECK):-vk -glsl -compute -output-using-type -shaderobj
 //TEST(compute):SIMPLE(filecheck=SPIRV): -target spirv-asm -stage compute
 //DISABLE_TEST(compute):COMPARE_COMPUTE(filecheck-buffer=CHECK):-mtl -compute -output-using-type -shaderobj
 //TEST(compute):COMPARE_COMPUTE(filecheck-buffer=CHECK): -cpu -output-using-type -shaderobj

diff --git a/tests/compute/dynamic-dispatch-14.slang b/tests/compute/dynamic-dispatch-14.slang
@@ -2,7 +2,6 @@
 
 //TEST(compute):COMPARE_COMPUTE_EX:-slang -compute -dx12 -profile sm_6_0 -use-dxil
 //TEST(compute):COMPARE_COMPUTE_EX:-slang -compute -dx11 -profile sm_5_0
-//TEST(compute):COMPARE_COMPUTE_EX:-slang -compute -gl  -profile glsl_440
 //TEST(compute):COMPARE_COMPUTE_EX:-slang -compute -vk -profile glsl_440
 //TEST(compute):COMPARE_COMPUTE_EX:-slang -compute -cpu
 

diff --git a/tests/compute/texture-subscript-multisample.slang b/tests/compute/texture-subscript-multisample.slang
@@ -4,7 +4,6 @@
 // Due to this, Metal compute test is disabled
 //DISABLE_TEST(compute):COMPARE_COMPUTE(filecheck-buffer=BUF): -slang -output-using-type -shaderobj -mtl
 //TEST(compute):COMPARE_COMPUTE(filecheck-buffer=BUF): -slang -output-using-type -shaderobj -vk
-//TEST(compute):COMPARE_COMPUTE(filecheck-buffer=BUF): -slang -output-using-type -shaderobj -vk -glsl
 
 //METAL_ERROR: error 41402
 //METALLIB: error 41402

diff --git a/tests/compute/texture-subscript.slang b/tests/compute/texture-subscript.slang
@@ -4,7 +4,6 @@
 // Due to this, Metal compute test is disabled
 //TEST(compute):COMPARE_COMPUTE(filecheck-buffer=BUF): -slang -output-using-type -shaderobj -mtl
 //TEST(compute):COMPARE_COMPUTE(filecheck-buffer=BUF): -slang -output-using-type -shaderobj -vk
-//TEST(compute):COMPARE_COMPUTE(filecheck-buffer=BUF): -slang -output-using-type -shaderobj -vk -glsl
 
 //METAL-NOT: error 41402
 //METALLIB: @computeMain
@@ -59,4 +58,4 @@ void computeMain()
             );
 }
 
-//BUF: 1
+//BUF: 1
diff --git a/tests/render/cross-compile-entry-point.slang b/tests/render/cross-compile-entry-point.slang
@@ -1,5 +1,5 @@
-//TEST(render):COMPARE_HLSL_CROSS_COMPILE_RENDER:
-//TEST(render):COMPARE_HLSL_CROSS_COMPILE_RENDER: -dx12
+// //TEST(render):COMPARE_HLSL_CROSS_COMPILE_RENDER:
+// //TEST(render):COMPARE_HLSL_CROSS_COMPILE_RENDER: -dx12
 
 
 // This is a test to ensure that we can cross-compile a complete entry point.

diff --git a/tools/gfx-unit-test/gfx-test-util.cpp b/tools/gfx-unit-test/gfx-test-util.cpp
@@ -263,9 +263,6 @@ namespace gfx_test
         case Slang::RenderApiFlag::CUDA:
             deviceDesc.deviceType = gfx::DeviceType::CUDA;
             break;
-        case Slang::RenderApiFlag::OpenGl:
-            deviceDesc.deviceType = gfx::DeviceType::OpenGl;
-            break;
         default:
             SLANG_IGNORE_TEST
         }

diff --git a/tools/render-test/options.cpp b/tools/render-test/options.cpp
@@ -22,20 +22,19 @@
 namespace renderer_test {
 using namespace Slang;
 
-static gfx::DeviceType _toRenderType(Slang::RenderApiType apiType)
+static rhi::DeviceType _toRenderType(Slang::RenderApiType apiType)
 {
     using namespace Slang;
     switch (apiType)
     {
-    case RenderApiType::D3D11:  return gfx::DeviceType::DirectX11;
-    case RenderApiType::D3D12:  return gfx::DeviceType::DirectX12;
-    case RenderApiType::OpenGl: return gfx::DeviceType::OpenGl;
-    case RenderApiType::Vulkan: return gfx::DeviceType::Vulkan;
-    case RenderApiType::Metal:  return gfx::DeviceType::Metal;
-    case RenderApiType::CPU:    return gfx::DeviceType::CPU;
-    case RenderApiType::CUDA:   return gfx::DeviceType::CUDA;
+    case RenderApiType::D3D11:  return rhi::DeviceType::D3D11;
+    case RenderApiType::D3D12:  return rhi::DeviceType::D3D12;
+    case RenderApiType::Vulkan: return rhi::DeviceType::Vulkan;
+    case RenderApiType::Metal:  return rhi::DeviceType::Metal;
+    case RenderApiType::CPU:    return rhi::DeviceType::CPU;
+    case RenderApiType::CUDA:   return rhi::DeviceType::CUDA;
     default:
-        return gfx::DeviceType::Unknown;
+        return rhi::DeviceType::Unknown;
     }
 }
 
@@ -254,7 +253,7 @@ static gfx::DeviceType _toRenderType(Slang::RenderApiType apiType)
                 // Lookup the target language type
                 DeviceType targetLanguageDeviceType = _toRenderType(RenderApiUtil::findImplicitLanguageRenderApiType(argName));
 
-                if (targetLanguageDeviceType != DeviceType::Unknown)
+                if (targetLanguageDeviceType != DeviceType::Unknown || argName == "glsl")
                 {
                     outOptions.targetLanguageDeviceType = targetLanguageDeviceType;
                     outOptions.inputLanguageID = (argName == "hlsl" || argName == "glsl" || argName == "cpp" || argName == "cxx" || argName == "c") ?  InputLanguageID::Native : InputLanguageID::Slang;

diff --git a/tools/render-test/options.h b/tools/render-test/options.h
@@ -14,11 +14,11 @@
 
 #include "../../source/compiler-core/slang-command-line-args.h"
 
-#include "slang-gfx.h"
+#include <slang-rhi.h>
 
 namespace renderer_test {
 
-using namespace gfx;
+using namespace rhi;
 
 struct Options
 {