Upgrade Jitify to jitify2

- Adds nvjitlink as a CUDA requirement to CI
- Borrow Jitify1 demangle for gcc
- Prevent jitify2::KernelData from being destroyed after context.
- Preload FLAMEGPU headers
  - This only reduces time from 6.8s to 4.1s (Windows/CUDA 12.0) and can't easily extend it to system headers.
- Split up program load so we can serialise linked program.
  - Quick windows test shows it to be much faster to deserialize.
- Specify -D_FILE_OFFSET_BITS=64 for when required for Jitify2 via try_compile
- Remove getKnownHeaders()
- Disables Werror from some CI workflows
- Add compile error string to exception
- Jitify2: pin the commit to the HEAD of the jitify2 branch from August 2025, including nodiscard fix
- CMake: Specify the jitify2 include directory as SYSTEM to attempt warning suppression on windows
- Either JITIFY_VERBOSE_ERRORS must be defined to a truthy value, or .info() must be called on the ErrorMsg for the header log to be included.
  - see jitify2::make_compilation_error_msg for the implementation
- Readme: Remove the known issue about RTC performance for CUDA >= 12.2
- CMake: apply jitify2#146 patches prior to it being merged

Co-authored-by Robert Chisholm <r.chisholm@sheffield.ac.uk>
Co-authored-by Peter Heywood <p.heywood@sheffield.ac.uk>

Author: Robadob

.github/scripts/install_cuda_centos.sh

@@ -18,6 +18,7 @@ CUDA_PACKAGES_IN=(
     "cuda-nvtx"
     "cuda-nvrtc-devel"
     "libcurand-devel" # 11-0+
+    "libnvjitlink-devel" # 12.0+
 )
 
 ## -------------------
@@ -91,9 +92,12 @@ do :
     if [[ ${package} == libcu* ]] && version_lt "$CUDA_VERSION_MAJOR_MINOR" "11.0" ; then
         package="${package/libcu/cuda-cu}"
     fi
-    # CUDA < 11, -devel- packages were actually -dev
-    if [[ ${package} == *devel* ]] && version_lt "$CUDA_VERSION_MAJOR_MINOR" "11.0" ; then
-        package="${package//devel/dev}"
+    # libnvjitlink not required prior to CUDA 12.0
+    if [[ ${package} == libnvjitlink-dev* ]] && version_lt "$CUDA_VERSION_MAJOR_MINOR" "12.0" ;then
+        continue
+    # CUDA 11+ includes lib* / lib*-dev packages, which if they existed previously where cuda-cu*- / cuda-cu*-dev-
+    elif [[ ${package} == lib* ]] && version_lt "$CUDA_VERSION_MAJOR_MINOR" "11.0" ; then
+        package="${package/libcu/cuda-cu}"
     fi
     # Build the full package name and append to the string.
     CUDA_PACKAGES+=" ${package}-${CUDA_MAJOR}-${CUDA_MINOR}"

.github/scripts/install_cuda_el8.sh

@@ -18,6 +18,7 @@ CUDA_PACKAGES_IN=(
     "cuda-nvtx"
     "cuda-nvrtc-devel"
     "libcurand-devel" # 11-0+
+    "libnvjitlink-devel" #12-0+
 )
 
 ## -------------------
@@ -90,6 +91,10 @@ do :
     if [[ ${package} == libcu* ]] && version_lt "$CUDA_VERSION_MAJOR_MINOR" "11.0" ; then
         package="${package/libcu/cuda-cu}"
     fi
+    # libnvjitlink not required prior to CUDA 12.0
+    if [[ ${package} == libnvjitlink-dev* ]] && version_lt "$CUDA_VERSION_MAJOR_MINOR" "12.0" ;then
+        continue
+    fi
     # CUDA < 11, -devel- packages were actually -dev
     if [[ ${package} == *devel* ]] && version_lt "$CUDA_VERSION_MAJOR_MINOR" "11.0" ; then
         package="${package//devel/dev}"

.github/scripts/install_cuda_ubuntu.sh

@@ -14,7 +14,8 @@ CUDA_PACKAGES_IN=(
     "cuda-nvtx"
     "cuda-nvrtc-dev"
     "libcurand-dev" # 11-0+
-    "cuda-cccl" # 11.4+, provides cub and thrust. On 11.3 knwon as cuda-thrust-11-3
+    "cuda-cccl" # 11.4+, provides cub and thrust. On 11.3 known as cuda-thrust-11-3
+    "libnvjitlink-dev" # 12.0+
 )
 
 ## -------------------
@@ -104,8 +105,11 @@ do :
             continue
         fi
     fi
+    # libnvjitlink not required prior to CUDA 12.0
+    if [[ ${package} == libnvjitlink-dev* ]] && version_lt "$CUDA_VERSION_MAJOR_MINOR" "12.0" ;then
+        continue
     # CUDA 11+ includes lib* / lib*-dev packages, which if they existed previously where cuda-cu*- / cuda-cu*-dev-
-    if [[ ${package} == libcu* ]] && version_lt "$CUDA_VERSION_MAJOR_MINOR" "11.0" ; then
+    elif [[ ${package} == lib* ]] && version_lt "$CUDA_VERSION_MAJOR_MINOR" "11.0" ; then
         package="${package/libcu/cuda-cu}"
     fi
     # Build the full package name and append to the string.

.github/scripts/install_cuda_windows.ps1

@@ -68,7 +68,7 @@ $VISUAL_STUDIO_MIN_CUDA = @{
     "2022" = "11.6.0";
     "2019" = "10.1";
     "2017" = "10.0"; # Depends on which version of 2017! 9.0 to 10.0 depending on version
-    "2015" = "8.0";  # Might support older, unsure. Depracated as of 11.1, unsupported in 11.2
+    "2015" = "8.0";  # Might support older, unsure. Deprecated as of 11.1, unsupported in 11.2
 }
 
 # cuda_runtime.h is in nvcc <= 10.2, but cudart >= 11.0
@@ -80,6 +80,8 @@ $CUDA_PACKAGES_IN = @(
     "nvrtc_dev";
     "cudart";
     "thrust";
+    "thrust";
+    "nvjitlink";
 )
 
 ## -------------------
@@ -132,6 +134,9 @@ Foreach ($package in $CUDA_PACKAGES_IN) {
     } elseif($package -eq "thrust" -and [version]$CUDA_VERSION_FULL -lt [version]"11.3") {
         # Thrust is a package from CUDA 11.3, otherwise it should be skipped.
         continue
+    } elseif($package -eq "nvjitlink" -and [version]$CUDA_VERSION_FULL -lt [version]"12.0") {
+        # nvjitlink is a from CUDA 12.0, otherwise it should be skipped.
+        continue
     }
     $CUDA_PACKAGES += " $($package)_$($CUDA_MAJOR).$($CUDA_MINOR)"
 }
@@ -180,7 +185,7 @@ while (-not $downloaded) {
         Write-Output "Downloading Complete"
         $downloaded=$true
     } else {
-        # If downlaod failed, either wait and try again, or give up and error.
+        # If download failed, either wait and try again, or give up and error.
         if ($download_attempt -le $download_attempts_max) {
             Write-Output "Error: Failed to download $($CUDA_REPO_PKG_LOCAL) (attempt $($download_attempt)/$($download_attempts_max)). Retrying."
             # Sleep for a number of seconds.

.github/workflows/Draft-Release.yml

@@ -282,7 +282,6 @@ jobs:
       run: >
         cmake . -B "${{ env.BUILD_DIR }}"
         -G "${{ env.HOSTCXX }}" -A x64
-        -Werror=dev
         -DCMAKE_WARN_DEPRECATED="OFF"
         -DFLAMEGPU_WARNINGS_AS_ERRORS="ON"
         -DCMAKE_CUDA_ARCHITECTURES="${{ env.CUDA_ARCH }}"
@@ -585,7 +584,6 @@ jobs:
       run: >
         cmake . -B "${{ env.BUILD_DIR }}"
         -G "${{ env.HOSTCXX }}" -A x64
-        -Werror=dev
         -DCMAKE_WARN_DEPRECATED="OFF"
         -DFLAMEGPU_WARNINGS_AS_ERRORS="ON"
         -DCMAKE_CUDA_ARCHITECTURES="${{ env.CUDA_ARCH }}"

README.md

@@ -373,4 +373,3 @@ For a full list of known issues pleases see the [Issue Tracker](https://github.c
 
 + Warnings and a loss of performance due to hash collisions in device code ([#356](https://github.com/FLAMEGPU/FLAMEGPU2/issues/356))
 + Multiple known areas where performance can be improved (e.g. [#449](https://github.com/FLAMEGPU/FLAMEGPU2/issues/449), [#402](https://github.com/FLAMEGPU/FLAMEGPU2/issues/402))
-+ CUDA 12.2+ suffers from poor RTC compilation times, to be fixed in a future release ([#1118](https://github.com/FLAMEGPU/FLAMEGPU2/issues/1118)).

cmake/CheckCompilerFunctionality.cmake

@@ -187,6 +187,25 @@ function(flamegpu_check_compiler_functionality)
         endif()
     endif()
 
+    if (NOT MSVC)
+        # Jitify2 on linux requires uses F_OFD_SETLKW or -D_FILE_OFFSET_BITS=64. 
+        # Cannot detect the presence of this from CMAKE_SYSTEM_VERSION when in a container, so try to compile with it and if an error occurs then we must define this option.
+        # If required, sets a cmake cache internal variable FLAMEGPU__FILE_OFFSET_BITS_64_REQUIRED to true
+        try_compile(
+            LINUX_F_OFD_SETLKW
+            "${CMAKE_CURRENT_BINARY_DIR}/try_compile"
+            "${CMAKE_CURRENT_LIST_DIR}/CheckCompilerFunctionality/F_OFD_SETLKW.cpp"
+            CXX_STANDARD 17
+            CUDA_STANDARD 17
+            CXX_STANDARD_REQUIRED "ON"
+        )
+        if(NOT LINUX_F_OFD_SETLKW)
+            set(FLAMEGPU__FILE_OFFSET_BITS_64_REQUIRED "true" CACHE INTERNAL "if _FILE_OFFSET_BITS=64 required for jitify2")
+        else()
+            set(FLAMEGPU__FILE_OFFSET_BITS_64_REQUIRED "false" CACHE INTERNAL "if _FILE_OFFSET_BITS=64 required for jitify2")
+        endif()
+    endif()
+
     # If we made it this far, set the result variable to be truthy
     set(FLAMEGPU_CheckCompilerFunctionality_RESULT "YES" PARENT_SCOPE)
 endfunction()

cmake/CheckCompilerFunctionality/F_OFD_SETLKW.cpp

@@ -0,0 +1,10 @@
+#ifdef __linux__
+#include <fcntl.h>
+#endif  // __linux__
+
+int main (int argc, char * argv[]) {
+    #ifndef F_OFD_SETLKW
+    #error F_OFD_SETLKW is not defined; try building with -D_FILE_OFFSET_BITS=64
+    #endif  // F_OFD_SETLKW
+    return 0;
+}

cmake/dependencies/Jitify.cmake

@@ -14,17 +14,48 @@ endif()
 FetchContent_Declare(
     jitify
     GIT_REPOSITORY https://github.com/NVIDIA/jitify.git
-    GIT_TAG        9c01f4988bbc3e11fcb84fc2747b5d0f2af7862e
+    GIT_TAG        44e978b21fc8bdb6b2d7d8d179523c8350db72e5  # jitify2 branch on 2025-08-23, pre windows patches
     SOURCE_DIR     ${FETCHCONTENT_BASE_DIR}/jitify-src/jitify
     GIT_PROGRESS   ON
     # UPDATE_DISCONNECTED   ON
 )
 FetchContent_GetProperties(jitify)
 if(NOT jitify_POPULATED)
     FetchContent_Populate(jitify)
-    # Jitify is not a cmake project, so cannot use add_subdirectory, use custom find_package.
+    # Apply patches to jitify2 for msvc support prior to https://github.com/NVIDIA/jitify/pull/146 being merged
+    # patch generated from jitify fork/branch, via `git format-patch jitify2 --stdout > jitify2-pr-146.patch`
+    # Does not use fetch content PATCH_COMMAND as it was unreliable / problematic on windows for prior rapidjson patching
+    # This will silently not apply the patch if it is not applicable, which supports repeated fetching but may lead to silent failures
+    # Check if the patch is applicable
+    execute_process(
+        COMMAND git apply --check ${CMAKE_CURRENT_LIST_DIR}/patches/jitify2-pr-146.patch
+        WORKING_DIRECTORY "${jitify_SOURCE_DIR}"
+        RESULT_VARIABLE jitify_patch_check_result
+        OUTPUT_QUIET
+        ERROR_QUIET
+    )
+    # If applicable, apply the patch
+    if (jitify_patch_check_result EQUAL 0)
+        message(CHECK_START  "Patching jitify #146")
+        execute_process(
+            COMMAND git apply ${CMAKE_CURRENT_LIST_DIR}/patches/jitify2-pr-146.patch
+            WORKING_DIRECTORY "${jitify_SOURCE_DIR}"
+            RESULT_VARIABLE jifity_patch_apply_result
+            OUTPUT_QUIET
+            ERROR_QUIET
+        )
+        # If the patch failed emit a warning but allow cmake to progress. This should not occur given the previous check.
+        if (jifity_patch_apply_result EQUAL 0)
+            message(CHECK_PASS "done")
+        else()
+            message(CHECK_FAIL "patching failed")
+        endif()
+        unset(jifity_patch_apply_result)
+    endif()
+    unset(jitify_patch_check_result)
 endif()
 
+# Jitify is not a cmake project, so cannot use add_subdirectory, use custom find_package.
 set(CMAKE_PREFIX_PATH "${CMAKE_PREFIX_PATH};${jitify_SOURCE_DIR}/..")
 # Always find the package, even if jitify is already populated.
 find_package(Jitify REQUIRED)

cmake/dependencies/flamegpu2-visualiser.cmake

@@ -42,7 +42,7 @@ if (FLAMEGPU_VISUALISATION_ROOT)
         set(FLAMEGPU_VISUALISATION_ROOT "${FLAMEGPU_VISUALISATION_ROOT_ABS}" PARENT_SCOPE)
         # And set up the visualisation build 
         add_subdirectory(${FLAMEGPU_VISUALISATION_ROOT_ABS} ${CMAKE_CURRENT_BINARY_DIR}/_deps/flamegpu_visualiser-build EXCLUDE_FROM_ALL)
-        # Set the cahce var too, to ensure it appears in the GUI.
+        # Set the cache var too, to ensure it appears in the GUI.
         set(FLAMEGPU_VISUALISATION_ROOT "${FLAMEGPU_VISUALISATION_ROOT}" CACHE STRING "Path to local copy of the FLAMEGPU2-visualiser repository, rather than CMake-based fetching")
 
     else()