Add Rendering

CMakeLists.txt

@@ -14,6 +14,10 @@ set(libp2p_INCLUDE_DIR "${_THIRDPARTY_BUILD_DIR}/libp2p/include")
 
 #add_subdirectory(generated)
 add_subdirectory(src)
+if(BUILD_TESTING)
+    add_subdirectory(test)
+endif()
+add_subdirectory(tools)
 
 install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/include/" DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/SGProcessingManager" FILES_MATCHING PATTERN "*.h*")
 install(DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}/generated/" DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/SGProcessingManager/generated" FILES_MATCHING PATTERN "*.h*")

cmake/CommonBuildParameters.cmake

@@ -7,7 +7,14 @@ set(BOOST_PATCH_VERSION "0" CACHE STRING "Boost Patch Version")
 set(BOOST_VERSION "${BOOST_MAJOR_VERSION}.${BOOST_MINOR_VERSION}.${BOOST_PATCH_VERSION}")
 set(BOOST_VERSION_2U "${BOOST_MAJOR_VERSION}_${BOOST_MINOR_VERSION}")
 
-set(CMAKE_CXX_STANDARD 20)
+# Default to C++20 only when the including project has not already chosen a
+# standard.  The standalone build (build/CommonCompilerOptions.cmake) sets
+# C++17 before including this file, matching SuperGenius and all other
+# projects; forcing 20 here breaks fmt/spdlog consteval format-string checks
+# on newer clang (e.g. SPDLOG_LOGGER_CATCH in spdlog/logger.h).
+if(NOT DEFINED CMAKE_CXX_STANDARD)
+    set(CMAKE_CXX_STANDARD 20)
+endif()
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
@@ -32,15 +39,81 @@ set(OPENSSL_INCLUDE_DIR "${_THIRDPARTY_BUILD_DIR}/openssl/build/include" CACHE P
 
 find_package(OpenSSL REQUIRED CONFIG)
 
+# VulkanHeaders
+set(VulkanHeaders_DIR "${_THIRDPARTY_BUILD_DIR}/Vulkan-Headers/share/cmake/VulkanHeaders" CACHE PATH "Path to Vulkan-Headers install folder")
+find_package(VulkanHeaders CONFIG REQUIRED)
+
 # Vulkan
-find_package(Vulkan)
+#
+# On macOS, create the Vulkan::Vulkan target manually pointing at the MoltenVK
+# dylib nested inside the thirdparty-built MoltenVK.xcframework.  MoltenVK is a
+# complete Vulkan implementation that exports the full loader API — it can be
+# used directly without any ICD plumbing, exactly as MNN's Vulkan backend does.
+#
+# On other platforms, use the vendored Khronos Vulkan-Loader found via the
+# standard find_package(Vulkan) / VULKAN_SDK mechanism.
+if(APPLE)
+    if(NOT TARGET Vulkan::Vulkan)
+        set(_MVK_LIB "${_THIRDPARTY_BUILD_DIR}/MoltenVK/build/lib/MoltenVK.xcframework/macos-arm64_x86_64/libMoltenVK.a")
+        add_library(Vulkan::Vulkan STATIC IMPORTED GLOBAL)
+        set_target_properties(Vulkan::Vulkan PROPERTIES
+            INTERFACE_INCLUDE_DIRECTORIES "${_THIRDPARTY_BUILD_DIR}/Vulkan-Headers/include"
+            IMPORTED_LOCATION "${_MVK_LIB}"
+        )
+        # Frameworks MoltenVK links against; inherited by every consumer of Vulkan::Vulkan.
+        target_link_libraries(Vulkan::Vulkan INTERFACE
+            "-framework Metal"
+            "-framework IOSurface"
+            "-framework QuartzCore"
+            "-framework Foundation"
+            "-framework CoreFoundation"
+            "-framework CoreGraphics"
+            "-framework IOKit"
+            "-framework AppKit"
+        )
+    endif()
+else()
+    find_package(Vulkan)
+
+    if(NOT TARGET Vulkan::Vulkan)
+        set(Vulkan_INCLUDE_DIR "${_THIRDPARTY_BUILD_DIR}/Vulkan-Headers/include")
+        if(NOT DEFINED ENV{VULKAN_SDK})
+            set(ENV{VULKAN_SDK} "${_THIRDPARTY_BUILD_DIR}/Vulkan-Loader")
+        endif()
 
-if(NOT TARGET Vulkan::Vulkan)
-    if(NOT DEFINED $ENV{VULKAN_SDK})
-        set(ENV{VULKAN_SDK} "${_THIRDPARTY_BUILD_DIR}/Vulkan-Loader")
+        find_package(Vulkan REQUIRED)
     endif()
 
-    find_package(Vulkan REQUIRED)
+    # Override Vulkan::Vulkan to use our vendored Vulkan-Headers on all non-Apple
+    # platforms.  vk-bootstrap was built against our headers (v1.4); mixing with
+    # system/NDK headers (v1.3 or other versions) causes unknown-type errors in
+    # VkBootstrapDispatch.h and VkBootstrapFeatureChain.h.
+    set_target_properties(Vulkan::Vulkan PROPERTIES
+        INTERFACE_INCLUDE_DIRECTORIES "${_THIRDPARTY_BUILD_DIR}/Vulkan-Headers/include"
+    )
+endif()
+
+# vk-bootstrap
+set(vk-bootstrap_DIR "${_THIRDPARTY_BUILD_DIR}/vk-bootstrap/lib/cmake/vk-bootstrap")
+find_package(vk-bootstrap CONFIG REQUIRED)
+
+# SPIRV-Tools — no longer a standalone build.  libshaderc_combined (linked via
+# shaderc::shaderc below) statically bundles the exact same SPIRV-Tools code at the
+# exact same pinned commit (v2024.3 DEPS).  The spirv-tools include path is folded into
+# shaderc::shaderc's INTERFACE_INCLUDE_DIRECTORIES so <spirv-tools/libspirv.hpp> resolves.
+
+# shaderc — installs no CMake package config (confirmed in 02-02-RESEARCH.md against
+# github.com/google/shaderc/issues/1369 and github.com/microsoft/vcpkg/issues/23208); hand-written
+# IMPORTED target required, mirroring thirdparty/build/CommonTargets.cmake's own target.
+# libshaderc_combined statically bundles glslang+SPIRV-Tools and installs spirv-tools
+# headers into <prefix>/include/spirv-tools/, so <spirv-tools/libspirv.hpp> resolves
+# for consumers that call spvtools::SpirvTools::Validate() directly (SHADER-02).
+if(NOT TARGET shaderc::shaderc)
+    add_library(shaderc::shaderc STATIC IMPORTED GLOBAL)
+    set_target_properties(shaderc::shaderc PROPERTIES
+        IMPORTED_LOCATION "${_THIRDPARTY_BUILD_DIR}/shaderc/lib/${CMAKE_STATIC_LIBRARY_PREFIX}shaderc_combined${CMAKE_STATIC_LIBRARY_SUFFIX}"
+        INTERFACE_INCLUDE_DIRECTORIES "${_THIRDPARTY_BUILD_DIR}/shaderc/include"
+    )
 endif()
 
 # for compression, we need snappy
@@ -181,6 +254,10 @@ find_package(libp2p CONFIG REQUIRED)
 set(ipfs-lite-cpp_DIR "${_THIRDPARTY_BUILD_DIR}/ipfs-lite-cpp/lib/cmake/ipfs-lite-cpp")
 find_package(ipfs-lite-cpp CONFIG REQUIRED)
 
+# ipfs-bitswap-cpp
+set(ipfs-bitswap-cpp_DIR "${_THIRDPARTY_BUILD_DIR}/ipfs-bitswap-cpp/lib/cmake/ipfs-bitswap-cpp")
+find_package(ipfs-bitswap-cpp CONFIG REQUIRED)
+
 # MNN
 set(MNN_DIR "${_THIRDPARTY_BUILD_DIR}/MNN/lib/cmake/MNN")
 find_package(MNN CONFIG REQUIRED)
@@ -195,6 +272,31 @@ elseif(CMAKE_BUILD_TYPE STREQUAL "RelWithDebInfo")
     get_target_property(MNN_LIB_PATH MNN::MNN IMPORTED_LOCATION_RELWITHDEBINFO)
 endif()
 
+# zlib
+set(ZLIB_ROOT "${_THIRDPARTY_BUILD_DIR}/zlib")
+
+# Prefer package config files while loading Libssh2's dependencies.
+# Libssh2 config calls `find_dependency(ZLIB)` without `CONFIG`, which can
+# otherwise resolve to CMake's FindZLIB module on Windows CI.
+set(_SGNS_CMAKE_FIND_PACKAGE_PREFER_CONFIG_WAS_DEFINED FALSE)
+if(DEFINED CMAKE_FIND_PACKAGE_PREFER_CONFIG)
+    set(_SGNS_CMAKE_FIND_PACKAGE_PREFER_CONFIG_WAS_DEFINED TRUE)
+    set(_SGNS_CMAKE_FIND_PACKAGE_PREFER_CONFIG_PREV "${CMAKE_FIND_PACKAGE_PREFER_CONFIG}")
+endif()
+set(CMAKE_FIND_PACKAGE_PREFER_CONFIG ON)
+
+# libssh2
+set(Libssh2_DIR "${_THIRDPARTY_BUILD_DIR}/libssh2/lib/cmake/libssh2")
+find_package(Libssh2 CONFIG REQUIRED)
+
+if(_SGNS_CMAKE_FIND_PACKAGE_PREFER_CONFIG_WAS_DEFINED)
+    set(CMAKE_FIND_PACKAGE_PREFER_CONFIG "${_SGNS_CMAKE_FIND_PACKAGE_PREFER_CONFIG_PREV}")
+else()
+    unset(CMAKE_FIND_PACKAGE_PREFER_CONFIG)
+endif()
+unset(_SGNS_CMAKE_FIND_PACKAGE_PREFER_CONFIG_PREV)
+unset(_SGNS_CMAKE_FIND_PACKAGE_PREFER_CONFIG_WAS_DEFINED)
+
 # AsyncioManager
 set(AsyncIOManager_INCLUDE_DIR "${_THIRDPARTY_BUILD_DIR}/AsyncIOManager/include")
 set(AsyncIOManager_DIR "${_THIRDPARTY_BUILD_DIR}/AsyncIOManager/lib/cmake/AsyncIOManager")
@@ -206,20 +308,8 @@ include_directories(
 )
 
 add_subdirectory(${PROJECT_ROOT}/src ${CMAKE_BINARY_DIR}/src)
-
-# if(BUILD_TESTS)
-        # add_executable(${PROJECT_NAME}_test
-                # "${CMAKE_CURRENT_LIST_DIR}/../test/main_test.cpp"
-                # "${CMAKE_CURRENT_LIST_DIR}/../test/BitcoinKeyGenerator_test.cpp"
-                # "${CMAKE_CURRENT_LIST_DIR}/../test/EthereumKeyGenerator_test.cpp"
-                # "${CMAKE_CURRENT_LIST_DIR}/../test/ElGamalKeyGenerator_test.cpp"
-                # "${CMAKE_CURRENT_LIST_DIR}/../test/ECElGamalKeyGenerator_test.cpp"
-                # "${CMAKE_CURRENT_LIST_DIR}/../test/TransactionVerifierCircuit_test.cpp"
-                # "${CMAKE_CURRENT_LIST_DIR}/../test/MPCVerifierCircuit_test.cpp"
-                # "${CMAKE_CURRENT_LIST_DIR}/../test/Requestor.cpp"
-        # )
-        # target_link_libraries(${PROJECT_NAME}_test PUBLIC ${PROJECT_NAME} SGProofCircuits GTest::gtest Boost::random)
-# endif()
+add_subdirectory(${PROJECT_ROOT}/tools ${CMAKE_BINARY_DIR}/tools)
+add_subdirectory(${PROJECT_ROOT}/test ${CMAKE_BINARY_DIR}/test)
 
 # Install Headers
 install(DIRECTORY "${CMAKE_SOURCE_DIR}/include/" DESTINATION "${CMAKE_INSTALL_INCLUDEDIR}/SGProcessingManager" FILES_MATCHING PATTERN "*.h*")

doc/vulkan-validation-layers-decision.md

@@ -0,0 +1,21 @@
+# Vulkan Validation Layers Deferral Decision
+
+## Decision
+
+Vulkan-ValidationLayers is explicitly **not vendored** and **not wired** into debug or CI builds for v1.0 of the render pipeline. No validation-layer extension or callback is requested at `vkCreateInstance` time in any code path this phase delivers.
+
+## Rationale
+
+CTX-04 scoped validation-layer vendoring out of Phase 1 to keep the net-new vendoring surface to `vk-bootstrap` only. Validation layers are a development and debugging aid — they validate correct API usage, not runtime-correctness requirements — and this phase's deliverable (CTX-01..03, DISP-01..03) does not depend on them:
+
+- A headless Vulkan context can be created, tested for coexistence safety, and dispatched to without validation layers present.
+- This project's CI has zero macOS Vulkan signal today regardless of validation-layer presence (a pre-existing gap tracked for Phase 4).
+- Adding validation layers would introduce an additional vendoring step (`thirdparty/Vulkan-ValidationLayers`, its own submodule + ExternalProject_Add build wiring) plus platform-specific library path resolution at runtime (the loader must find `VK_LAYER_KHRONOS_validation` on disk, and the path differs across Windows/Linux/macOS/MoltenVK) — all for a tooling aid that has no effect on the shipped code path.
+
+## Deferred To
+
+Tracked as v2 requirement **VALLAYER-01** in `.planning/workstreams/sgproc-render/REQUIREMENTS.md` ("Vulkan-ValidationLayers wired into debug/CI builds"), to be implemented in v1.x.
+
+## Future Hook Point
+
+If implemented later, validation layers can be enabled via `vkb::InstanceBuilder::request_validation_layers(true)` (vk-bootstrap has first-class support for this). The toggle would be gated behind a new CMake debug-only option — analogous to the existing `SANITIZE_CODE` debug-only toggle pattern already present in `CommonCompilerOptions.cmake` — so it never activates in release/optimized builds.

generated/ColorFormat.hpp

@@ -0,0 +1,27 @@
+//  To parse this JSON data, first install
+//
+//      Boost     http://www.boost.org
+//      json.hpp  https://github.com/nlohmann/json
+//
+//  Then include this file, and then do
+//
+//     ColorFormat.hpp data = nlohmann::json::parse(jsonString);
+
+#pragma once
+
+#include <boost/optional.hpp>
+#include <nlohmann/json.hpp>
+#include "helper.hpp"
+
+namespace sgns {
+    /**
+     * Color attachment format
+     */
+
+    using nlohmann::json;
+
+    /**
+     * Color attachment format
+     */
+    enum class ColorFormat : int { RGB8, RGBA8 };
+}

generated/ShaderType.hpp → generated/CullMode.hpp

@@ -5,7 +5,7 @@
 //
 //  Then include this file, and then do
 //
-//     ShaderType.hpp data = nlohmann::json::parse(jsonString);
+//     CullMode.hpp data = nlohmann::json::parse(jsonString);
 
 #pragma once
 
@@ -16,5 +16,5 @@
 namespace sgns {
     using nlohmann::json;
 
-    enum class ShaderType : int { GLSL, HLSL, METAL, SPIRV };
+    enum class CullMode : int { BACK, FRONT, NONE };
 }

generated/DepthFormat.hpp

@@ -0,0 +1,27 @@
+//  To parse this JSON data, first install
+//
+//      Boost     http://www.boost.org
+//      json.hpp  https://github.com/nlohmann/json
+//
+//  Then include this file, and then do
+//
+//     DepthFormat.hpp data = nlohmann::json::parse(jsonString);
+
+#pragma once
+
+#include <boost/optional.hpp>
+#include <nlohmann/json.hpp>
+#include "helper.hpp"
+
+namespace sgns {
+    /**
+     * Depth attachment format
+     */
+
+    using nlohmann::json;
+
+    /**
+     * Depth attachment format
+     */
+    enum class DepthFormat : int { D24_UNORM_S8_UINT, D32_SFLOAT };
+}

generated/DepthTest.hpp

@@ -0,0 +1,20 @@
+//  To parse this JSON data, first install
+//
+//      Boost     http://www.boost.org
+//      json.hpp  https://github.com/nlohmann/json
+//
+//  Then include this file, and then do
+//
+//     DepthTest.hpp data = nlohmann::json::parse(jsonString);
+
+#pragma once
+
+#include <boost/optional.hpp>
+#include <nlohmann/json.hpp>
+#include "helper.hpp"
+
+namespace sgns {
+    using nlohmann::json;
+
+    enum class DepthTest : int { DISABLED, ENABLED };
+}

generated/FrontFace.hpp

@@ -0,0 +1,20 @@
+//  To parse this JSON data, first install
+//
+//      Boost     http://www.boost.org
+//      json.hpp  https://github.com/nlohmann/json
+//
+//  Then include this file, and then do
+//
+//     FrontFace.hpp data = nlohmann::json::parse(jsonString);
+
+#pragma once
+
+#include <boost/optional.hpp>
+#include <nlohmann/json.hpp>
+#include "helper.hpp"
+
+namespace sgns {
+    using nlohmann::json;
+
+    enum class FrontFace : int { CCW, CW };
+}