Integrate volk runtime smoke path

Author: AnastaZIuk

README.md

@@ -78,6 +78,17 @@ add_executable(my_app src/main.c)
 target_link_libraries(my_app PRIVATE webvulkan::llvmpipe_wasm)
 ```
 
+## Volk smoke path
+
+`runtime_smoke` includes a dedicated Volk-based runtime check.
+
+It validates:
+- `volkInitializeCustom` is used with `vk_icdGetInstanceProcAddr` from the linked wasm driver archive
+- Vulkan instance creation and physical device enumeration succeed
+- Required ICD entrypoints are resolved through that same dispatch path
+
+This gives a realistic loader flow for consumers that use Volk, while keeping dispatch pinned to the wasm ICD path.
+
 ## Release channels
 
 - `llvm-wasm-prebuilt-latest` contains only the LLVM prebuilt bundle

tests/CMakeLists.txt

@@ -4,11 +4,37 @@ if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
   project(webvulkan_tests LANGUAGES NONE)
 endif()
 
+set(WEBVULKAN_TEST_THIRDPARTY_DIR "${CMAKE_CURRENT_LIST_DIR}/../.3rdparty/tests" CACHE PATH "Test-only third-party root directory")
+set(WEBVULKAN_VOLK_GIT_URL "https://github.com/zeux/volk.git" CACHE STRING "volk git repository URL for smoke tests")
+set(WEBVULKAN_VOLK_GIT_REF "1.4.304" CACHE STRING "Pinned volk git ref for smoke tests")
+
 set(WEBVULKAN_TEST_MODE "auto" CACHE STRING "Test mode: auto, in-tree, or package")
 set_property(CACHE WEBVULKAN_TEST_MODE PROPERTY STRINGS auto in-tree package)
 set(WEBVULKAN_TEST_PACKAGE_PREFIX "" CACHE PATH "Install prefix for WebVulkan package mode")
 set(WEBVULKAN_TEST_WASM_BUILD_DIR "${CMAKE_BINARY_DIR}/wasm" CACHE PATH "WASM smoke build directory")
 
+if(NOT COMMAND CPMAddPackage)
+  if(NOT DEFINED WEBVULKAN_CPM_VERSION OR WEBVULKAN_CPM_VERSION STREQUAL "")
+    set(WEBVULKAN_CPM_VERSION "0.40.2" CACHE STRING "CPM.cmake release version for tests")
+  endif()
+  if(NOT DEFINED WEBVULKAN_CPM_DIR OR WEBVULKAN_CPM_DIR STREQUAL "")
+    set(WEBVULKAN_CPM_DIR "${WEBVULKAN_TEST_THIRDPARTY_DIR}/cpm" CACHE PATH "Directory where CPM.cmake is stored for tests")
+  endif()
+  if(NOT DEFINED CPM_SOURCE_CACHE OR CPM_SOURCE_CACHE STREQUAL "")
+    set(CPM_SOURCE_CACHE "${WEBVULKAN_TEST_THIRDPARTY_DIR}/cpm-cache" CACHE PATH "CPM source cache path for tests")
+  endif()
+  if(NOT DEFINED WEBVULKAN_ALLOW_DEP_UPDATES)
+    set(WEBVULKAN_ALLOW_DEP_UPDATES OFF CACHE BOOL "Allow dependency git update during configure")
+  endif()
+  if(WEBVULKAN_ALLOW_DEP_UPDATES)
+    set(CPM_UPDATE_DISCONNECTED OFF CACHE BOOL "CPM update disconnected mode" FORCE)
+  else()
+    set(CPM_UPDATE_DISCONNECTED ON CACHE BOOL "CPM update disconnected mode" FORCE)
+  endif()
+  include("${CMAKE_CURRENT_LIST_DIR}/../cmake/BootstrapCpm.cmake")
+  webvulkan_bootstrap_cpm()
+endif()
+
 set(_webvulkan_test_mode "${WEBVULKAN_TEST_MODE}")
 if(_webvulkan_test_mode STREQUAL "auto")
   if(TARGET llvmpipe_wasm_spike)
@@ -51,6 +77,20 @@ if(NOT SUBBUILD_GENERATOR)
   message(FATAL_ERROR "No CMake generator is available for wasm smoke sub-build")
 endif()
 
+CPMAddPackage(
+  NAME webvulkan_volk
+  GIT_REPOSITORY "${WEBVULKAN_VOLK_GIT_URL}"
+  GIT_TAG "${WEBVULKAN_VOLK_GIT_REF}"
+  GIT_SHALLOW TRUE
+  DOWNLOAD_ONLY YES
+)
+set(_webvulkan_volk_include_dir "${webvulkan_volk_SOURCE_DIR}")
+set(_webvulkan_volk_source "${webvulkan_volk_SOURCE_DIR}/volk.c")
+set(_webvulkan_volk_header "${webvulkan_volk_SOURCE_DIR}/volk.h")
+if(NOT EXISTS "${_webvulkan_volk_source}" OR NOT EXISTS "${_webvulkan_volk_header}")
+  message(FATAL_ERROR "volk sources are missing under ${webvulkan_volk_SOURCE_DIR}")
+endif()
+
 if(_webvulkan_test_mode STREQUAL "in-tree")
   if(NOT TARGET llvmpipe_wasm_spike)
     message(FATAL_ERROR "in-tree test mode requires llvmpipe_wasm_spike target")
@@ -106,6 +146,8 @@ set(_webvulkan_lavapipe_depends
   "${CMAKE_CURRENT_LIST_DIR}/RunLavapipeRuntimeSmoke.cmake"
   "${CMAKE_CURRENT_LIST_DIR}/wasm/src/lavapipe_runtime_smoke.c"
   "${CMAKE_CURRENT_LIST_DIR}/wasm/tools/smoke_runtime.mjs"
+  "${_webvulkan_volk_source}"
+  "${_webvulkan_volk_header}"
   "${_webvulkan_driver_archive}"
 )
 if(_webvulkan_test_mode STREQUAL "in-tree")
@@ -122,6 +164,8 @@ add_custom_command(
     -DSMOKE_SOURCE=${CMAKE_CURRENT_LIST_DIR}/wasm/src/lavapipe_runtime_smoke.c
     -DSMOKE_JS_OUT=${WEBVULKAN_LAVAPIPE_SMOKE_JS}
     -DSMOKE_SCRIPT=${CMAKE_CURRENT_LIST_DIR}/wasm/tools/smoke_runtime.mjs
+    -DVOLK_INCLUDE_DIR=${_webvulkan_volk_include_dir}
+    -DVOLK_SOURCE=${_webvulkan_volk_source}
     -P "${CMAKE_CURRENT_LIST_DIR}/RunLavapipeRuntimeSmoke.cmake"
   COMMAND "${CMAKE_COMMAND}" -E touch "${WEBVULKAN_LAVAPIPE_SMOKE_OK}"
   DEPENDS ${_webvulkan_lavapipe_depends}

tests/RunLavapipeRuntimeSmoke.cmake

@@ -12,6 +12,8 @@ require_var(SMOKE_INCLUDE_DIRS)
 require_var(SMOKE_SOURCE)
 require_var(SMOKE_JS_OUT)
 require_var(SMOKE_SCRIPT)
+require_var(VOLK_INCLUDE_DIR)
+require_var(VOLK_SOURCE)
 
 if(CMAKE_HOST_WIN32)
   set(EMCC_BIN "${EMSDK_ROOT}/upstream/emscripten/emcc.bat")
@@ -34,6 +36,12 @@ list(GET NODE_CANDIDATES 0 NODE_EXE)
 if(NOT EXISTS "${DRIVER_ARCHIVE}")
   message(FATAL_ERROR "Missing driver archive ${DRIVER_ARCHIVE}")
 endif()
+if(NOT EXISTS "${VOLK_SOURCE}")
+  message(FATAL_ERROR "Missing volk source ${VOLK_SOURCE}")
+endif()
+if(NOT EXISTS "${VOLK_INCLUDE_DIR}/volk.h")
+  message(FATAL_ERROR "Missing volk include directory ${VOLK_INCLUDE_DIR}")
+endif()
 
 get_filename_component(SMOKE_OUT_DIR "${SMOKE_JS_OUT}" DIRECTORY)
 file(MAKE_DIRECTORY "${SMOKE_OUT_DIR}")
@@ -46,9 +54,11 @@ function(append_rsp ARG_VALUE)
 endfunction()
 
 append_rsp("${SMOKE_SOURCE}")
+append_rsp("${VOLK_SOURCE}")
 append_rsp("-o")
 append_rsp("${SMOKE_JS_OUT}")
 append_rsp("-std=c11")
+append_rsp("-I${VOLK_INCLUDE_DIR}")
 foreach(SMOKE_INCLUDE_DIR IN LISTS SMOKE_INCLUDE_DIRS)
   if(NOT EXISTS "${SMOKE_INCLUDE_DIR}")
     message(FATAL_ERROR "Missing include directory ${SMOKE_INCLUDE_DIR}")

tests/wasm/src/lavapipe_runtime_smoke.c

@@ -1,20 +1,18 @@
 #include <emscripten/emscripten.h>
+#include <volk.h>
 #include <stdio.h>
 #include <string.h>
-#include <vulkan/vulkan.h>
 
 VKAPI_ATTR PFN_vkVoidFunction VKAPI_CALL vk_icdGetInstanceProcAddr(VkInstance instance, const char* pName);
 
 EMSCRIPTEN_KEEPALIVE int lavapipe_runtime_smoke(void) {
-  PFN_vkCreateInstance createInstance = (PFN_vkCreateInstance)vk_icdGetInstanceProcAddr(VK_NULL_HANDLE, "vkCreateInstance");
-  PFN_vkEnumerateInstanceVersion enumerateVersion = (PFN_vkEnumerateInstanceVersion)vk_icdGetInstanceProcAddr(VK_NULL_HANDLE, "vkEnumerateInstanceVersion");
-
-  if (!createInstance || !enumerateVersion) {
+  volkInitializeCustom((PFN_vkGetInstanceProcAddr)vk_icdGetInstanceProcAddr);
+  if (!vkCreateInstance || !vkEnumerateInstanceVersion) {
     return 21;
   }
 
   uint32_t apiVersion = 0u;
-  VkResult rc = enumerateVersion(&apiVersion);
+  VkResult rc = vkEnumerateInstanceVersion(&apiVersion);
   if (rc != VK_SUCCESS) {
     return 22;
   }
@@ -34,27 +32,44 @@ EMSCRIPTEN_KEEPALIVE int lavapipe_runtime_smoke(void) {
   createInfo.pApplicationInfo = &appInfo;
 
   VkInstance instance = VK_NULL_HANDLE;
-  rc = createInstance(&createInfo, 0, &instance);
+  rc = vkCreateInstance(&createInfo, 0, &instance);
   if (rc != VK_SUCCESS || instance == VK_NULL_HANDLE) {
     return 23;
   }
 
-  PFN_vkEnumeratePhysicalDevices enumeratePhysicalDevices =
-    (PFN_vkEnumeratePhysicalDevices)vk_icdGetInstanceProcAddr(instance, "vkEnumeratePhysicalDevices");
-  PFN_vkDestroyInstance destroyInstance =
-    (PFN_vkDestroyInstance)vk_icdGetInstanceProcAddr(instance, "vkDestroyInstance");
-
-  if (!enumeratePhysicalDevices || !destroyInstance) {
+  volkLoadInstance(instance);
+  if (!vkEnumeratePhysicalDevices || !vkDestroyInstance || !vkGetDeviceProcAddr) {
+    vkDestroyInstance(instance, 0);
     return 24;
   }
 
   uint32_t physicalDeviceCount = 0u;
-  rc = enumeratePhysicalDevices(instance, &physicalDeviceCount, 0);
+  rc = vkEnumeratePhysicalDevices(instance, &physicalDeviceCount, 0);
   if (rc != VK_SUCCESS || physicalDeviceCount == 0u) {
-    destroyInstance(instance, 0);
+    vkDestroyInstance(instance, 0);
     return 25;
   }
 
+  VkPhysicalDevice physicalDevice = VK_NULL_HANDLE;
+  uint32_t one = 1u;
+  rc = vkEnumeratePhysicalDevices(instance, &one, &physicalDevice);
+  if (rc != VK_SUCCESS || one == 0u || physicalDevice == VK_NULL_HANDLE) {
+    vkDestroyInstance(instance, 0);
+    return 26;
+  }
+
+  PFN_vkVoidFunction fpEnumeratePhysicalDevices =
+    vk_icdGetInstanceProcAddr(instance, "vkEnumeratePhysicalDevices");
+  PFN_vkVoidFunction fpGetPhysicalDeviceProperties =
+    vk_icdGetInstanceProcAddr(instance, "vkGetPhysicalDeviceProperties");
+  PFN_vkVoidFunction fpGetPhysicalDeviceProperties2 =
+    vk_icdGetInstanceProcAddr(instance, "vkGetPhysicalDeviceProperties2");
+
+  if (!fpEnumeratePhysicalDevices || !fpGetPhysicalDeviceProperties || !fpGetPhysicalDeviceProperties2) {
+    vkDestroyInstance(instance, 0);
+    return 27;
+  }
+
   printf("lavapipe runtime smoke ok\n");
   printf("  backend=mesa lavapipe (swrast)\n");
   printf("  instance.api=%u.%u.%u (%u)\n",
@@ -65,8 +80,11 @@ EMSCRIPTEN_KEEPALIVE int lavapipe_runtime_smoke(void) {
   printf("  vkCreateInstance=ok\n");
   printf("  vkEnumeratePhysicalDevices=ok\n");
   printf("  physical_devices=%u\n", physicalDeviceCount);
-  printf("  vk_icd.entrypoint=vk_icdGetInstanceProcAddr\n");
-  destroyInstance(instance, 0);
+  printf("  vk_icdGetInstanceProcAddr(vkEnumeratePhysicalDevices)=present\n");
+  printf("  vk_icdGetInstanceProcAddr(vkGetPhysicalDeviceProperties)=present\n");
+  printf("  vk_icdGetInstanceProcAddr(vkGetPhysicalDeviceProperties2)=present\n");
+  printf("  vulkan_loader=volk (custom vk_icdGetInstanceProcAddr)\n");
+  vkDestroyInstance(instance, 0);
   return 0;
 }