GPU compute API abstraction on top of WebGPU

.github/workflows/checks.yml

@@ -29,7 +29,7 @@ jobs:
     - name: install dependencies
       run: |
          sudo apt-get update
-         sudo apt-get install clang qt6-base-dev libglvnd-dev zlib1g-dev libfftw3-dev ninja-build python3-numpy libpng-dev
+         sudo apt-get install clang qt6-base-dev libglvnd-dev zlib1g-dev libfftw3-dev ninja-build python3-numpy libpng-dev mesa-vulkan-drivers
 
     - name: Run sccache-cache
       uses: mozilla-actions/sccache-action@v0.0.9
@@ -61,7 +61,7 @@ jobs:
       run: cd build && ctest -L cli --output-on-failure
 
     - name: unit tests
-      run: cd build && ctest -L unittest --output-on-failure --parallel 4
+      run: cd build && ctest -L unittest --output-on-failure
 
     - name: compatibility tests
       run: cd build && ctest -L compatibility --output-on-failure
@@ -96,7 +96,7 @@ jobs:
     - name: install dependencies
       run: |
          sudo apt-get update
-         sudo apt-get install g++-9 qt6-base-dev libglvnd-dev zlib1g-dev libfftw3-dev ninja-build python3-numpy libpng-dev
+         sudo apt-get install g++-9 qt6-base-dev libglvnd-dev zlib1g-dev libfftw3-dev ninja-build python3-numpy libpng-dev mesa-vulkan-drivers
 
     - name: Run sccache-cache
       uses: mozilla-actions/sccache-action@v0.0.9
@@ -126,7 +126,7 @@ jobs:
       run: cd build && ctest -L cli --output-on-failure
 
     - name: unit tests
-      run: cd build && ctest -L unittest --output-on-failure --parallel 4
+      run: cd build && ctest -L unittest --output-on-failure
 
     - name: compatibility tests
       run: cd build && ctest -L compatibility --output-on-failure
@@ -187,7 +187,7 @@ jobs:
       run: cd build && ctest -L cli --output-on-failure
 
     - name: unit tests
-      run: cd build && ctest -L unittest --output-on-failure --parallel 4
+      run: cd build && ctest -L unittest --output-on-failure
 
     - name: compatibility tests
       run: cd build && ctest -L compatibility --output-on-failure
@@ -233,6 +233,7 @@ jobs:
             ${{env.MINGW_PACKAGE_PREFIX}}-diffutils
             ${{env.MINGW_PACKAGE_PREFIX}}-fftw
             ${{env.MINGW_PACKAGE_PREFIX}}-gcc
+            ${{env.MINGW_PACKAGE_PREFIX}}-mesa
             ${{env.MINGW_PACKAGE_PREFIX}}-ninja
             ${{env.MINGW_PACKAGE_PREFIX}}-pkg-config
             ${{env.MINGW_PACKAGE_PREFIX}}-qt6-base
@@ -265,7 +266,7 @@ jobs:
         run: cd build && ctest -L cli --output-on-failure
 
       - name: unit tests
-        run: cd build && ctest -L unittest --output-on-failure --parallel 4
+        run: cd build && ctest -L unittest --output-on-failure
 
       - name: compatibility tests
         run: cd build && ctest -L compatibility --output-on-failure

CMakeLists.txt

@@ -30,6 +30,9 @@ option(MRTRIX_USE_SYSTEM_EIGEN "Use system-installed Eigen3 library" OFF)
 option(MRTRIX_USE_SYSTEM_JSON "Use system-installed Json for Modern C++ library" OFF)
 option(MRTRIX_USE_SYSTEM_NIFTI "Use system-installed NIfTI C headers" OFF)
 option(MRTRIX_USE_SYSTEM_GTEST "Use system-installed Google Test library" OFF)
+option(MRTRIX_USE_SYSTEM_DAWN "Use system-installed Dawn library" OFF)
+option(MRTRIX_USE_SYSTEM_SLANG "Use system-installed Slang library" OFF)
+option(MRTRIX_USE_SYSTEM_TCB_SPAN "Use system-installed TCB Span library" OFF)
 
 if(MRTRIX_BUILD_TESTS)
     if(CMAKE_VERSION VERSION_GREATER 3.17)
@@ -69,6 +72,10 @@ file(RELATIVE_PATH relDir
 
 set(CMAKE_INSTALL_RPATH ${base} ${base}/${relDir})
 
+if (CMAKE_VERSION VERSION_GREATER_EQUAL "3.24.0")
+    cmake_policy(SET CMP0135 NEW)
+endif()
+
 include(BuildType)
 include(BuildInfo)
 include(LinkerSetup)

README.md

@@ -19,7 +19,7 @@ You can address all *MRtrix3*-related queries there, using your GitHub or Google
 ## Quick install
 
 1. Install dependencies by whichever means your system uses. 
-   These include: CMake (>= 3.16), Python3, a C++ compiler with full C++17 support, 
+   These include: CMake (>= 3.22), Python3, a C++ compiler with full C++17 support, 
    Eigen (>=3.2.8), zlib, OpenGL (>=3.3), and Qt (>=5.5).
 
 2. Clone Git repository and compile:

cmake/Dependencies.cmake

@@ -102,3 +102,135 @@ if(MRTRIX_BUILD_TESTS)
         FetchContent_MakeAvailable(googletest)
     endif()
 endif()
+
+
+# Dawn
+
+# Threads (required by Dawn exported targets)
+find_package(Threads REQUIRED)
+
+if(NOT MRTRIX_USE_SYSTEM_DAWN)
+    message(STATUS "Downloading prebuilt binaries for Dawn...")
+    include(FetchContent)
+    set(FETCHCONTENT_QUIET OFF)
+
+    if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
+        set(DAWN_PLATFORM "linux")
+    elseif(CMAKE_SYSTEM_NAME STREQUAL "Darwin")
+        set(DAWN_PLATFORM "macos")
+    elseif(CMAKE_SYSTEM_NAME STREQUAL "Windows")
+        set(DAWN_PLATFORM "windows-msys2")
+    else()
+        message(FATAL_ERROR "Unsupported platform: ${CMAKE_SYSTEM_NAME}")
+    endif()
+
+    set(DAWN_VERSION 7495)
+
+
+    set(DAWN_BINARIES_URL_PREFIX
+        "https://github.com/mrtrix3/webgpu-dawn-binaries/releases/download/chromium")
+    set(DAWN_BINARIES_URL
+        ${DAWN_BINARIES_URL_PREFIX}-${DAWN_VERSION}/webgpu-dawn-chromium-${DAWN_VERSION}-${DAWN_PLATFORM}.zip
+    )
+
+    FetchContent_Declare(
+        dawn
+        DOWNLOAD_NO_PROGRESS         1
+        URL ${DAWN_BINARIES_URL}
+    )
+    FetchContent_MakeAvailable(dawn)
+
+    # On Linux, Dawn prebuilt packages use lib64; others use lib
+    if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
+        set(DAWN_LIB_DIR_NAME "lib64")
+    else()
+        set(DAWN_LIB_DIR_NAME "lib")
+    endif()
+    set(
+      Dawn_DIR
+      "${dawn_SOURCE_DIR}/${DAWN_LIB_DIR_NAME}/cmake/Dawn"
+      CACHE PATH "Folder containing DawnConfig.cmake"
+      FORCE
+    )
+    set(FETCHCONTENT_QUIET ON)
+endif()
+
+
+# Slang
+
+find_package(slang QUIET)
+
+if(NOT MRTRIX_USE_SYSTEM_SLANG)
+    message(STATUS "Downloading prebuilt binaries for Slang...")
+    set(SLANG_VERSION "2025.22.1" CACHE STRING "Slang version to download from GitHub releases")
+
+    if(CMAKE_SYSTEM_NAME STREQUAL "Linux")
+        set(SLANG_OS "linux")
+    elseif(APPLE)
+        set(SLANG_OS "macos")
+    else()
+        set(SLANG_OS "windows")
+    endif()
+
+    if(CMAKE_SYSTEM_PROCESSOR MATCHES "aarch64" OR CMAKE_SYSTEM_PROCESSOR MATCHES "arm64")
+        set(SLANG_ARCH "aarch64")
+    else()
+        set(SLANG_ARCH "x86_64")
+    endif()
+
+    set(SLANG_SUBSTRING "-${SLANG_OS}-${SLANG_ARCH}")
+
+    set(SLANG_DOWNLOAD_LINK
+      "https://github.com/shader-slang/slang/releases/download/v${SLANG_VERSION}/slang-${SLANG_VERSION}${SLANG_SUBSTRING}.zip"
+    )
+
+    message(STATUS "Downloading Slang ${SLANG_VERSION} (${SLANG_OS}/${SLANG_ARCH})...")
+
+    FetchContent_Declare(
+      slang
+        DOWNLOAD_NO_PROGRESS         1
+        URL                          ${SLANG_DOWNLOAD_LINK}
+    )
+    FetchContent_MakeAvailable(slang)
+
+    if(WIN32)
+        set(slang_DIR_PATH "${slang_SOURCE_DIR}/cmake")
+    else()
+        set(slang_DIR_PATH "${slang_SOURCE_DIR}/lib/cmake/slang")
+    endif()
+
+    set(
+      slang_DIR
+      "${slang_DIR_PATH}"
+      CACHE PATH "Folder containing SlangConfig.cmake"
+      FORCE
+    )
+endif()
+
+# tcb::span
+if(MRTRIX_USE_SYSTEM_TCB_SPAN)
+    find_path(TCB_SPAN_INCLUDE_DIR
+        NAMES tcb/span.hpp
+        PATHS /usr/include /usr/local/include
+    )
+    if(NOT TCB_SPAN_INCLUDE_DIR)
+        message(FATAL_ERROR "Could not find tcb::span headers. Please install tcb::span or disable MRTRIX_USE_SYSTEM_TCB_SPAN.")
+    endif()
+
+    add_library(tcb_span INTERFACE)
+    target_include_directories(tcb_span INTERFACE ${TCB_SPAN_INCLUDE_DIR})
+    add_library(tcb::span ALIAS tcb_span)
+else()
+    message(STATUS "Downloading tcb::span...")
+
+    FetchContent_Populate(
+        tcb_span
+        GIT_REPOSITORY https://github.com/tcbrindle/span.git
+        GIT_TAG        836dc6a0efd9849cb194e88e4aa2387436bb079b
+    )
+
+    add_library(tcb_span INTERFACE)
+    target_include_directories(tcb_span INTERFACE ${tcb_span_SOURCE_DIR}/include)
+    add_library(tcb::span ALIAS tcb_span)
+endif()
+

cpp/core/CMakeLists.txt

@@ -4,6 +4,8 @@ find_package(FFTW REQUIRED)
 find_package(Git QUIET)
 find_package(Threads REQUIRED)
 find_package(PNG QUIET)
+find_package(Dawn CONFIG REQUIRED)
+find_package(slang CONFIG REQUIRED)
 
 if(PNG_FOUND)
     message(STATUS "Found PNG: ${PNG_LIBRARIES}")
@@ -102,6 +104,7 @@ else()
 endif()
 
 target_link_libraries(mrtrix-core PUBLIC
+    dawn::webgpu_dawn
     Eigen3::Eigen
     ZLIB::ZLIB
     fftw3::fftw
@@ -110,13 +113,36 @@ target_link_libraries(mrtrix-core PUBLIC
     Threads::Threads
     nlohmann_json::nlohmann_json
     nifti::nifti
+    slang::slang
+    tcb::span
 )
 
 # On Windows, the libraries need to be in the same directory as the executables
 if(WIN32)
     set_target_properties(mrtrix-core PROPERTIES
         RUNTIME_OUTPUT_DIRECTORY ${PROJECT_BINARY_DIR}/bin
     )
+
+    add_custom_command(TARGET mrtrix-core POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy_if_different
+            $<TARGET_FILE:dawn::webgpu_dawn>
+            $<TARGET_FILE:slang::slang>
+            $<TARGET_FILE_DIR:mrtrix-core>
+        COMMENT "Copying imported dependencies to output directory"
+    )
+# In an MSYS2 environment, dawn fails to load the required vulkan-1.dll library when
+# creating a WebGPU instance. To remedy this, we copy the DLL from C:/Windows/System32
+# to the build output directory.
+# TODO: Investigate further and find a better solution.
+if(NOT MSVC)
+    add_custom_command(TARGET mrtrix-core POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E copy_if_different
+            $ENV{WINDIR}/System32/vulkan-1.dll
+            $<TARGET_FILE_DIR:mrtrix-core>
+        COMMENT "Copying vulkan-1.dll to output directory"
+    )
+endif()
+
 endif()
 
 install(TARGETS mrtrix-core