Merge branch 'master' into bugfix/shader-slanggh-6513

Author: mkeshavaNV

.github/workflows/ci.yml

@@ -169,21 +169,26 @@ jobs:
               -server-count 8 \
               -category ${{ matrix.test-category }} \
               -api all-cpu \
-              -expected-failure-list tests/expected-failure-github.txt
+              -expected-failure-list tests/expected-failure-github.txt \
+              -show-adapter-info
           elif [[ "${{matrix.has-gpu}}" == "true" ]]; then
             "$bin_dir/slang-test" \
               -use-test-server \
               -category ${{ matrix.test-category }} \
               -api all-dx12 \
               -expected-failure-list tests/expected-failure-github.txt \
-              -expected-failure-list tests/expected-failure-record-replay-tests.txt
+              -expected-failure-list tests/expected-failure-record-replay-tests.txt \
+              -expected-failure-list tests/expected-failure-github-runner.txt \
+              -show-adapter-info
           else
             "$bin_dir/slang-test" \
               -use-test-server \
               -category ${{ matrix.test-category }} \
               -api all-dx12 \
               -expected-failure-list tests/expected-failure-github.txt \
-              -expected-failure-list tests/expected-failure-record-replay-tests.txt
+              -expected-failure-list tests/expected-failure-record-replay-tests.txt \
+              -expected-failure-list tests/expected-failure-github-runner.txt \
+              -show-adapter-info
           fi
       - name: Run Slang examples
         if: steps.filter.outputs.should-run == 'true' && matrix.platform != 'wasm' && matrix.full-gpu-tests
@@ -209,7 +214,8 @@ jobs:
             -category ${{ matrix.test-category }} \
             -emit-spirv-via-glsl \
             -api vk \
-            -expected-failure-list tests/expected-failure.txt
+            -expected-failure-list tests/expected-failure.txt \
+            -show-adapter-info
       - uses: actions/upload-artifact@v4
         if: steps.filter.outputs.should-run == 'true' && ! matrix.full-gpu-tests
         with:

CMakeLists.txt

@@ -166,6 +166,55 @@ option(
 )
 mark_as_advanced(SLANG_SPIRV_HEADERS_INCLUDE_DIR)
 
+# Options for user defined paths for external modules.
+advanced_option(
+    SLANG_OVERRIDE_LZ4_PATH
+    "Build using user defined path for LZ4"
+    OFF
+)
+advanced_option(
+    SLANG_OVERRIDE_MINIZ_PATH
+    "Build using user defined path for Miniz"
+    OFF
+)
+advanced_option(
+    SLANG_OVERRIDE_UNORDERED_DENSE_PATH
+    "Build using user defined path for unordered_dense"
+    OFF
+)
+advanced_option(
+    SLANG_OVERRIDE_VULKAN_HEADERS_PATH
+    "Build using user defined path for Vulkan headers"
+    OFF
+)
+advanced_option(
+    SLANG_OVERRIDE_SPIRV_HEADERS_PATH
+    "Build using user defined path for SPIR-V headers"
+    OFF
+)
+advanced_option(
+    SLANG_OVERRIDE_SPIRV_TOOLS_PATH
+    "Build using user defined path for SPIR-V tools"
+    OFF
+)
+advanced_option(
+    SLANG_OVERRIDE_GLSLANG_PATH
+    "Build using user defined path for glslang"
+    OFF
+)
+
+advanced_option(
+    SLANG_EXCLUDE_DAWN
+    "Optionally exclude webgpu_dawn from the build"
+    OFF
+)
+
+advanced_option(
+    SLANG_EXCLUDE_TINT
+    "Optionally exclude slang-tint from the build"
+    OFF
+)
+
 if(${SLANG_USE_SYSTEM_LZ4})
     add_compile_definitions(SLANG_USE_SYSTEM_LZ4_HEADER)
 endif()
@@ -178,6 +227,10 @@ if(${SLANG_USE_SYSTEM_UNORDERED_DENSE})
     add_compile_definitions(SLANG_USE_SYSTEM_UNORDERED_DENSE_HEADER)
 endif()
 
+if(SLANG_OVERRIDE_SPIRV_HEADERS_PATH)
+    add_compile_definitions(SLANG_USE_SYSTEM_SPIRV_HEADER)
+endif()
+
 enum_option(
     SLANG_LIB_TYPE
     # Default
@@ -251,24 +304,28 @@ if(SLANG_SLANG_LLVM_FLAVOR MATCHES FETCH_BINARY)
     )
 endif()
 
-set(webgpu_dawn_release_tag "webgpu_dawn-0")
-if(
-    CMAKE_SYSTEM_NAME MATCHES "Windows"
-    AND CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64|amd64|AMD64"
-)
-    set(SLANG_WEBGPU_DAWN_BINARY_URL
-        "https://github.com/shader-slang/dawn/releases/download/${webgpu_dawn_release_tag}/webgpu_dawn-windows-x64.zip"
+if(NOT SLANG_EXCLUDE_DAWN)
+    set(webgpu_dawn_release_tag "webgpu_dawn-0")
+    if(
+        CMAKE_SYSTEM_NAME MATCHES "Windows"
+        AND CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64|amd64|AMD64"
     )
+        set(SLANG_WEBGPU_DAWN_BINARY_URL
+            "https://github.com/shader-slang/dawn/releases/download/${webgpu_dawn_release_tag}/webgpu_dawn-windows-x64.zip"
+        )
+    endif()
 endif()
 
-set(slang_tint_release_tag "slang-tint-0")
-if(
-    CMAKE_SYSTEM_NAME MATCHES "Windows"
-    AND CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64|amd64|AMD64"
-)
-    set(SLANG_SLANG_TINT_BINARY_URL
-        "https://github.com/shader-slang/dawn/releases/download/${slang_tint_release_tag}/slang-tint-windows-x64.zip"
+if(NOT SLANG_EXCLUDE_TINT)
+    set(slang_tint_release_tag "slang-tint-0")
+    if(
+        CMAKE_SYSTEM_NAME MATCHES "Windows"
+        AND CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64|amd64|AMD64"
     )
+        set(SLANG_SLANG_TINT_BINARY_URL
+            "https://github.com/shader-slang/dawn/releases/download/${slang_tint_release_tag}/slang-tint-windows-x64.zip"
+        )
+    endif()
 endif()
 
 #

docs/assets/moduletree.png

@@ -120,10 +120,6 @@ It is only valid for the user code to `import m`. Attempting to `import helper`
 Multiple `import`s of the same module from different input files will only cause the module to be loaded once (there is no need for "include guards" or `#pragma once`).
 Note that preprocessor definitions in the current file will not affect the compilation of `import`ed code, and the preprocessor definitions in the imported code is not visible to the current file.
 
-> #### Note ####
-> Future versions of the Slang system will support loading of modules from pre-compiled binaries instead of source code.
-> The same `import` keyword will continue to work in that case.
-
 ## Access Control
 
 Slang supports access control modifiers: `public`, `internal` and `private`. The module boundary plays an important role in access control.
@@ -195,6 +191,39 @@ The Slang compiler enforces the following rules regarding access control:
 - Type definitions themselves cannot be `private`, for example, `private struct S {}` is not valid code.
 - `interface` requirements cannot be `private`.
 
+## Organizing File Structure of Modules
+
+Slang does not seek to impose any specific organization of modules. However, there are some conventions that have emerged as being useful.
+
+### Module Organization Suggestions
+
+- The top-level directory contains modules that would be `import`ed by user code.
+- The implementation details of the modules are placed in files at lower levels of the tree.
+
+This has the benefit that it is easy for a user to distinguish the public API from the implementation details.
+
+### Module Organization Example
+
+<img src="../assets/moduletree.png" width="300em" alt="Module organization tree diagram"/>
+
+### Module Organization Example
+
+The above diagram shows a module organization example.
+
+Top-level module files such as `utils.slang` are those that are directly `import`ed by user code. The implementation details of the module are placed in the lower levels of the tree, organized into similarly named subdirectories for clarity.
+
+Modules like `utils.slang` needn't contain anything more than a module declaration and a list of included files, with optional `import` statement(s) to pull in any external dependencies, e.g.
+
+```
+module utils;
+import slangpy;
+
+__include "utils/accumlator.slang";
+__include "utils/tonemap.slang";
+__include "utils/fill.slang";
+```
+
+Here, all the public symbols defined in `accumlator.slang`, `tonemap.slang`, and `fill.slang` are visible to the user of the `utils` module, and these constituent helper files do not need to clutter the top-level file hierarchy.
 
 ## Legacy Modules
 

docs/user-guide/04-modules-and-access-control.md

@@ -58,6 +58,7 @@
 <li data-link="modules#defining-a-module"><span>Defining a Module</span></li>
 <li data-link="modules#importing-a-module"><span>Importing a Module</span></li>
 <li data-link="modules#access-control"><span>Access Control</span></li>
+<li data-link="modules#organizing-file-structure-of-modules"><span>Organizing File Structure of Modules</span></li>
 <li data-link="modules#legacy-modules"><span>Legacy Modules</span></li>
 </ul>
 </li>

docs/user-guide/toc.html

@@ -27,13 +27,32 @@ if(NOT SLANG_ENABLE_EXTERNAL_COMPILER_WARNINGS)
     endif()
 endif()
 
+# Unordered dense
 if(NOT ${SLANG_USE_SYSTEM_UNORDERED_DENSE})
-    add_subdirectory(unordered_dense EXCLUDE_FROM_ALL ${system})
+    if(NOT SLANG_OVERRIDE_UNORDERED_DENSE_PATH)
+        add_subdirectory(unordered_dense EXCLUDE_FROM_ALL ${system})
+    else()
+        add_subdirectory(
+            ${SLANG_OVERRIDE_UNORDERED_DENSE_PATH}
+            unordered_dense
+            EXCLUDE_FROM_ALL
+            ${system}
+        )
+    endif()
 endif()
 
 # Miniz
 if(NOT ${SLANG_USE_SYSTEM_MINIZ})
-    add_subdirectory(miniz EXCLUDE_FROM_ALL ${system})
+    if(NOT SLANG_OVERRIDE_MINIZ_PATH)
+        add_subdirectory(miniz EXCLUDE_FROM_ALL ${system})
+    else()
+        add_subdirectory(
+            ${SLANG_OVERRIDE_MINIZ_PATH}
+            miniz
+            EXCLUDE_FROM_ALL
+            ${system}
+        )
+    endif()
     set_property(TARGET miniz PROPERTY POSITION_INDEPENDENT_CODE ON)
     # Work around https://github.com/richgel999/miniz/pull/292
     get_target_property(miniz_c_launcher miniz C_COMPILER_LAUNCHER)
@@ -46,7 +65,16 @@ endif()
 # LZ4
 if(NOT ${SLANG_USE_SYSTEM_LZ4})
     set(LZ4_BUNDLED_MODE ON)
-    add_subdirectory(lz4/build/cmake EXCLUDE_FROM_ALL ${system})
+    if(NOT SLANG_OVERRIDE_LZ4_PATH)
+        add_subdirectory(lz4/build/cmake EXCLUDE_FROM_ALL ${system})
+    else()
+        add_subdirectory(
+            ${SLANG_OVERRIDE_LZ4_PATH}/build/cmake
+            lz4/build/cmake
+            EXCLUDE_FROM_ALL
+            ${system}
+        )
+    endif()
     if(MSVC)
         target_compile_options(
             lz4_static
@@ -57,7 +85,16 @@ endif()
 
 # Vulkan headers
 if(NOT ${SLANG_USE_SYSTEM_VULKAN_HEADERS})
-    add_subdirectory(vulkan EXCLUDE_FROM_ALL ${system})
+    if(NOT SLANG_OVERRIDE_VULKAN_HEADERS_PATH)
+        add_subdirectory(vulkan EXCLUDE_FROM_ALL ${system})
+    else()
+        add_subdirectory(
+            ${SLANG_OVERRIDE_VULKAN_HEADERS_PATH}
+            vulkan
+            EXCLUDE_FROM_ALL
+            ${system}
+        )
+    endif()
 endif()
 
 # metal-cpp headers
@@ -69,22 +106,55 @@ target_include_directories(
 
 # SPIRV-Headers
 if(NOT ${SLANG_USE_SYSTEM_SPIRV_HEADERS})
-    add_subdirectory(spirv-headers EXCLUDE_FROM_ALL ${system})
+    if(NOT SLANG_OVERRIDE_SPIRV_HEADERS_PATH)
+        add_subdirectory(spirv-headers EXCLUDE_FROM_ALL ${system})
+    else()
+        add_subdirectory(
+            ${SLANG_OVERRIDE_SPIRV_HEADERS_PATH}
+            spirv-headers
+            EXCLUDE_FROM_ALL
+            ${system}
+        )
+    endif()
 endif()
 
 if(SLANG_ENABLE_SLANG_GLSLANG)
     # SPIRV-Tools
     set(SPIRV_TOOLS_BUILD_STATIC ON)
     set(SPIRV_WERROR OFF)
-    set(SPIRV_HEADER_DIR "${CMAKE_CURRENT_LIST_DIR}/spirv-headers/")
+    # Headers
+    if(NOT SLANG_OVERRIDE_SPIRV_HEADERS_PATH)
+        set(SPIRV_HEADER_DIR "${CMAKE_CURRENT_LIST_DIR}/spirv-headers/")
+    else()
+        set(SPIRV_HEADER_DIR ${SLANG_OVERRIDE_SPIRV_HEADERS_PATH})
+    endif()
     set(SPIRV_SKIP_TESTS ON)
-    add_subdirectory(spirv-tools EXCLUDE_FROM_ALL ${system})
+    # Tools
+    if(NOT SLANG_OVERRIDE_SPIRV_TOOLS_PATH)
+        add_subdirectory(spirv-tools EXCLUDE_FROM_ALL ${system})
+    else()
+        add_subdirectory(
+            ${SLANG_OVERRIDE_SPIRV_TOOLS_PATH}
+            spirv-tools
+            EXCLUDE_FROM_ALL
+            ${system}
+        )
+    endif()
 
     # glslang
     set(SKIP_GLSLANG_INSTALL ON)
     set(ENABLE_OPT ON)
     set(ENABLE_PCH OFF)
-    add_subdirectory(glslang EXCLUDE_FROM_ALL ${system})
+    if(NOT SLANG_OVERRIDE_GLSLANG_PATH)
+        add_subdirectory(glslang EXCLUDE_FROM_ALL ${system})
+    else()
+        add_subdirectory(
+            ${SLANG_OVERRIDE_GLSLANG_PATH}
+            glslang
+            EXCLUDE_FROM_ALL
+            ${system}
+        )
+    endif()
 endif()
 
 # imgui

external/CMakeLists.txt

@@ -163,6 +163,12 @@ class IShaderProgram : public ISlangUnknown
         SeparateEntryPointCompilation
     };
 
+    enum class DownstreamLinkMode
+    {
+        None,
+        Deferred,
+    };
+
     struct Desc
     {
         // TODO: Tess doesn't like this but doesn't know what to do about it
@@ -180,6 +186,9 @@ class IShaderProgram : public ISlangUnknown
         // An array of Slang entry points. The size of the array must be `entryPointCount`.
         // Each element must define only 1 Slang EntryPoint.
         slang::IComponentType** slangEntryPoints = nullptr;
+
+        // Indicates whether the app is responsible for final downstream linking.
+        DownstreamLinkMode downstreamLinkMode = DownstreamLinkMode::None;
     };
 
     struct CreateDesc2

external/spirv-tools

@@ -653,6 +653,7 @@ typedef uint32_t SlangSizeT;
         SLANG_PASS_THROUGH_SPIRV_OPT,     ///< SPIRV-opt
         SLANG_PASS_THROUGH_METAL,         ///< Metal compiler
         SLANG_PASS_THROUGH_TINT,          ///< Tint WGSL compiler
+        SLANG_PASS_THROUGH_SPIRV_LINK,    ///< SPIRV-link
         SLANG_PASS_THROUGH_COUNT_OF,
     };
 
@@ -1008,6 +1009,8 @@ typedef uint32_t SlangSizeT;
 
         EmitReflectionJSON, // bool
         SaveGLSLModuleBinSource,
+
+        SkipDownstreamLinking, // bool, experimental
         CountOf,
     };