Track builtin bootstrap mounts

Author: AnastaZIuk

.github/workflows/build-nabla.yml

@@ -174,15 +174,6 @@ jobs:
               --target install `
               --config ${{ matrix.config }}
 
-      - name: Container – Install and verify NSC runtime bundle
-        run: |
-          docker exec orphan `
-            ${{ env.entry }} ${{ env.cmd }} -Command ctest `
-              --test-dir ${{ env.binary }}\tools\nsc `
-              -C ${{ matrix.config }} `
-              --output-on-failure `
-              -R "^(NBL_NSC_INSTALL_RUNTIMES_TEST|NBL_NSC_INSTALL_EXECUTABLES_TEST|NBL_NSC_SELF_TEST_UNMOUNT_BUILTINS)$"
-
       - name: API / Examples / Check Run (Create)
         id: check-run-create
         uses: actions/github-script@v6

include/nbl/system/ISystem.h

@@ -143,6 +143,7 @@ class NBL_API2 ISystem : public core::IReferenceCounted
 
         void unmountBuiltins();
 		bool areBuiltinsMounted() const;
+        size_t getMountedBuiltinArchiveCount() const;
         inline size_t getMountedArchiveCount() const { return m_cachedArchiveFiles.getSize(); }
 
         //
@@ -206,8 +207,16 @@ class NBL_API2 ISystem : public core::IReferenceCounted
             //! The key is file extension
             core::CMultiObjectCache<std::string,core::smart_refctd_ptr<IArchiveLoader>,std::vector> perFileExt;
         } m_loaders;
+        struct SBuiltinMount
+        {
+            core::smart_refctd_ptr<IFileArchive> archive;
+            system::path pathAlias;
+        };
+        void mountBuiltin(core::smart_refctd_ptr<IFileArchive>&& archive, const system::path& pathAlias = "");
+        bool isBuiltinMounted(const SBuiltinMount& mount) const;
         //
         core::CMultiObjectCache<system::path,core::smart_refctd_ptr<IFileArchive>> m_cachedArchiveFiles;
+        core::vector<SBuiltinMount> m_builtinMounts;
 
     private:
         struct SRequestParams_NOOP

src/nbl/system/ISystem.cpp

@@ -12,32 +12,27 @@
 #include "nbl/system/CArchiveLoaderTar.h"
 #include "nbl/system/CMountDirectoryArchive.h"
 
-#include <array>
-
 using namespace nbl;
 using namespace nbl::system;
 
-namespace
-{
-constexpr std::array<const char*, 4> builtinMountPoints = { "nbl/builtin", "nbl/video", "spirv", "boost" };
-}
-
 ISystem::ISystem(core::smart_refctd_ptr<ISystem::ICaller>&& caller) : m_dispatcher(std::move(caller))
 {
     addArchiveLoader(core::make_smart_refctd_ptr<CArchiveLoaderZip>(nullptr));
     addArchiveLoader(core::make_smart_refctd_ptr<CArchiveLoaderTar>(nullptr));
 
+    // Builtins still live in the main archive cache for normal path resolution.
+    // This separate bootstrap tracking is only for exact unmounting and regression tests.
     #ifdef NBL_EMBED_BUILTIN_RESOURCES
-    mount(core::make_smart_refctd_ptr<nbl::builtin::CArchive>(nullptr));
-    mount(core::make_smart_refctd_ptr<spirv::builtin::CArchive>(nullptr));
-    mount(core::make_smart_refctd_ptr<boost::builtin::CArchive>(nullptr));
-    mount(core::make_smart_refctd_ptr<nbl::devicegen::builtin::CArchive>(nullptr));
+    mountBuiltin(core::make_smart_refctd_ptr<nbl::builtin::CArchive>(nullptr));
+    mountBuiltin(core::make_smart_refctd_ptr<spirv::builtin::CArchive>(nullptr));
+    mountBuiltin(core::make_smart_refctd_ptr<boost::builtin::CArchive>(nullptr));
+    mountBuiltin(core::make_smart_refctd_ptr<nbl::devicegen::builtin::CArchive>(nullptr));
     #else
     // TODO: absolute default entry paths? we should do something with it
-    mount(core::make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(NBL_BUILTIN_RESOURCES_DIRECTORY_PATH, nullptr, this), "nbl/builtin");
-    mount(core::make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(SPIRV_BUILTIN_RESOURCES_DIRECTORY_PATH, nullptr, this), "spirv");
-    mount(core::make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(BOOST_BUILTIN_RESOURCES_DIRECTORY_PATH, nullptr, this), "boost");
-    mount(core::make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(DEVICEGEN_BUILTIN_RESOURCES_DIRECTORY_PATH, nullptr, this), "nbl/video");
+    mountBuiltin(core::make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(NBL_BUILTIN_RESOURCES_DIRECTORY_PATH, nullptr, this), "nbl/builtin");
+    mountBuiltin(core::make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(SPIRV_BUILTIN_RESOURCES_DIRECTORY_PATH, nullptr, this), "spirv");
+    mountBuiltin(core::make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(BOOST_BUILTIN_RESOURCES_DIRECTORY_PATH, nullptr, this), "boost");
+    mountBuiltin(core::make_smart_refctd_ptr<nbl::system::CMountDirectoryArchive>(DEVICEGEN_BUILTIN_RESOURCES_DIRECTORY_PATH, nullptr, this), "nbl/video");
 #endif
 }
 
@@ -328,32 +323,41 @@ bool ISystem::ICaller::flushMapping(IFile* file, size_t offset, size_t size)
 }
 
 void ISystem::unmountBuiltins() {
+    for (auto& mount : m_builtinMounts)
+        unmount(mount.archive.get(), mount.pathAlias);
+    m_builtinMounts.clear();
+}
 
-    auto removeByKey = [&, this](const char* s) {
-        auto range = m_cachedArchiveFiles.findRange(s);
-
-        std::vector<core::smart_refctd_ptr<IFileArchive>> items_to_remove = {}; //is it always just 1 item?
-        for (auto it = range.begin(); it != range.end(); ++it)
-        {
-            items_to_remove.push_back(it->second);
-        }
-        for (size_t i = 0; i < items_to_remove.size(); i++)
-        {
-            m_cachedArchiveFiles.removeObject(items_to_remove[i], s);
-        }
-    };
+bool ISystem::areBuiltinsMounted() const
+{
+    return !m_builtinMounts.empty() && getMountedBuiltinArchiveCount() == m_builtinMounts.size();
+}
 
-    for (const auto* mountPoint : builtinMountPoints)
-        removeByKey(mountPoint);
+size_t ISystem::getMountedBuiltinArchiveCount() const
+{
+    size_t retval = 0ull;
+    for (const auto& mount : m_builtinMounts)
+        retval += size_t(isBuiltinMounted(mount));
+    return retval;
 }
 
-bool ISystem::areBuiltinsMounted() const
+void ISystem::mountBuiltin(core::smart_refctd_ptr<IFileArchive>&& archive, const system::path& pathAlias)
 {
-    for (const auto* mountPoint : builtinMountPoints)
-		if (!isDirectory(path(mountPoint)))
-			return false;
+    auto tracked = archive;
+    mount(std::move(archive), pathAlias);
+    m_builtinMounts.push_back({ std::move(tracked), pathAlias });
+}
 
-    return true;
+bool ISystem::isBuiltinMounted(const SBuiltinMount& mount) const
+{
+    const auto lookupKey = mount.pathAlias.empty() ? mount.archive->getDefaultAbsolutePath() : mount.pathAlias;
+    const auto range = m_cachedArchiveFiles.findRange(lookupKey);
+    for (auto it = range.begin(); it != range.end(); ++it)
+    {
+        if (it->second.get() == mount.archive.get())
+            return true;
+    }
+    return false;
 }
 
 #ifdef _NBL_PLATFORM_WINDOWS_

tools/nsc/CMakeLists.txt

@@ -510,7 +510,7 @@ execute_process(COMMAND "@DOCKER_EXE@"
 
 message(STATUS "Executing CTests")
 execute_process(COMMAND "@CTEST_EXE@" 
-  -C "$<CONFIG>" --stop-on-failure 
+  -C "$<CONFIG>" --stop-on-failure --output-on-failure
   WORKING_DIRECTORY "@CMAKE_CURRENT_BINARY_DIR@"
   COMMAND_ERROR_IS_FATAL ANY
 )

tools/nsc/main.cpp

@@ -209,18 +209,19 @@ class ShaderCompiler final : public IApplicationFramework
 
         if (program.get<bool>("--self-test-unmount-builtins"))
         {
-            const auto mountedArchiveCount = m_system->getMountedArchiveCount();
-            if (!mountedArchiveCount)
+            const auto mountedBuiltinArchiveCount = m_system->getMountedBuiltinArchiveCount();
+            if (!mountedBuiltinArchiveCount)
             {
-                std::cerr << "Builtins were not mounted at startup.\n";
+                std::cerr << "Builtins were not mounted at startup. builtin_mount_count=0 total_mount_count=" << m_system->getMountedArchiveCount() << "\n";
                 return false;
             }
 
             m_system->unmountBuiltins();
 
-            if (const auto remainingArchiveCount = m_system->getMountedArchiveCount(); remainingArchiveCount != 0ull)
+            if (const auto remainingBuiltinArchiveCount = m_system->getMountedBuiltinArchiveCount(); remainingBuiltinArchiveCount != 0ull)
             {
-                std::cerr << "Builtins unmount self-test failed. Remaining mounted archives: " << remainingArchiveCount << "\n";
+                std::cerr << "Builtins unmount self-test failed. remaining_builtin_mount_count=" << remainingBuiltinArchiveCount
+                          << " total_mount_count=" << m_system->getMountedArchiveCount() << "\n";
                 return false;
             }