Implement Android Vulkan support

Author: amakropoulos

.github/scripts/build_openssl.sh

@@ -51,7 +51,7 @@ get_android_toolchain() {
     local api_level=$2
 
     case $arch in
-        android-arm64)
+        android-arm64|android-arm64-vulkan)
             export ANDROID_ARCH="aarch64"
             export ANDROID_EABI="aarch64-linux-android"
             export OPENSSL_ARCH="android-arm64"
@@ -157,7 +157,7 @@ main() {
     mkdir -p $WORK_DIR $INSTALL_DIR/$arch
 
     case $arch in
-        android-arm64)
+        android-arm64|android-arm64-vulkan)
             build_openssl_android $arch
             ;;
         android-x64)

.github/workflows/build_library.yaml

@@ -53,6 +53,11 @@ jobs:
             sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-jammy.list https://packages.lunarg.com/vulkan/lunarg-vulkan-jammy.list
             sudo apt-get update -y
             sudo apt-get install -y build-essential vulkan-sdk
+
+        - id: copy_vulkan_linux
+          if: contains(matrix.arch, 'vulkan')
+          name: Copy Vulcan
+          run: |
             cp /lib/x86_64-linux-gnu/libvulkan.so.1 build/libs/
 
         - id: setup_cuda_linux
@@ -540,6 +545,8 @@ jobs:
             ABI: arm64-v8a
           - arch: android-x64
             ABI: x86_64
+          - arch: android-arm64-vulkan
+            ABI: arm64-v8a
 
     steps:
         - id: setup_libs_linux
@@ -561,6 +568,23 @@ jobs:
             echo "CMAKE_VARS=-DARCHITECTURE=${{ matrix.arch }} -DCMAKE_RUNTIME_OUTPUT_DIRECTORY=${{ github.workspace }}/build/libs -DCMAKE_ARCHIVE_OUTPUT_DIRECTORY=${{ github.workspace }}/build/libs -DCMAKE_LIBRARY_OUTPUT_DIRECTORY=${{ github.workspace }}/build/libs ${{ matrix.cmake_vars }}" >> $GITHUB_ENV
           shell: bash
 
+        - id: setup_vulkan_linux
+          if: contains(matrix.arch, 'vulkan')
+          name: Dependencies Vulcan
+          run: |
+            wget -qO - https://packages.lunarg.com/lunarg-signing-key-pub.asc | sudo apt-key add -
+            sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-jammy.list https://packages.lunarg.com/vulkan/lunarg-vulkan-jammy.list
+            sudo apt-get update -y
+            sudo apt-get install -y build-essential vulkan-sdk
+
+        - id: setup_vulcan_android
+          if: contains(matrix.arch, 'vulkan')
+          name: Install Vulkan headers
+          run: |
+            git submodule add https://github.com/KhronosGroup/Vulkan-Headers.git third_party/Vulkan-Headers
+            cd third_party/Vulkan-Headers
+            git checkout v1.3.275
+
 
         - id: cpu-cores
           name: Get number of CPU cores
@@ -577,7 +601,7 @@ jobs:
             export LD_LIBRARY_PATH=""
             export NDK=`ls -d /usr/local/lib/android/sdk/ndk/27.*`
             cd build
-            cmake .. -DCMAKE_TOOLCHAIN_FILE=$NDK/build/cmake/android.toolchain.cmake -DANDROID_PLATFORM=android-23 -DANDROID_ABI=${{ matrix.ABI }} ${{ env.CMAKE_VARS }}
+            cmake .. -DCMAKE_TOOLCHAIN_FILE=$NDK/build/cmake/android.toolchain.cmake -DANDROID_PLATFORM=android-29 -DANDROID_ABI=${{ matrix.ABI }} ${{ env.CMAKE_VARS }}
             cmake --build . --config Release -j ${{ steps.cpu-cores.outputs.count }}
 
 

.github/workflows_template/build_library_steps.yaml

@@ -123,6 +123,11 @@ jobs:
           sudo wget -qO /etc/apt/sources.list.d/lunarg-vulkan-jammy.list https://packages.lunarg.com/vulkan/lunarg-vulkan-jammy.list
           sudo apt-get update -y
           sudo apt-get install -y build-essential vulkan-sdk
+
+      - name: Copy Vulcan
+        id: copy_vulkan_linux
+        if: contains(matrix.arch, 'vulkan')
+        run: |
           cp /lib/x86_64-linux-gnu/libvulkan.so.1 build/libs/
 
       - uses: Jimver/cuda-toolkit@v0.2.15
@@ -242,13 +247,21 @@ jobs:
 
 ################################ Android ################################
 
+      - name: Install Vulkan headers
+        id: setup_vulcan_android
+        if: contains(matrix.arch, 'vulkan')
+        run: |
+          git submodule add https://github.com/KhronosGroup/Vulkan-Headers.git third_party/Vulkan-Headers
+          cd third_party/Vulkan-Headers
+          git checkout v1.3.275
+
       - name: Build
         id: cmake_build_android
         run: |
           export LD_LIBRARY_PATH=""
           export NDK=`ls -d /usr/local/lib/android/sdk/ndk/27.*`
           cd build
-          cmake .. -DCMAKE_TOOLCHAIN_FILE=$NDK/build/cmake/android.toolchain.cmake -DANDROID_PLATFORM=android-23 -DANDROID_ABI=${{ matrix.ABI }} ${{ env.CMAKE_VARS }}
+          cmake .. -DCMAKE_TOOLCHAIN_FILE=$NDK/build/cmake/android.toolchain.cmake -DANDROID_PLATFORM=android-29 -DANDROID_ABI=${{ matrix.ABI }} ${{ env.CMAKE_VARS }}
           cmake --build . --config Release -j ${{ steps.cpu-cores.outputs.count }}
 
 ################################ iOS ################################

.github/workflows_template/build_library_template.yaml

@@ -30,6 +30,7 @@ jobs:
         @@checkout@@
         @@preparation@@
         @@setup_vulkan_linux@@
+        @@copy_vulkan_linux@@
         @@setup_cuda_linux@@
         @@link_cuda_linux@@
 
@@ -146,11 +147,15 @@ jobs:
             ABI: arm64-v8a
           - arch: android-x64
             ABI: x86_64
+          - arch: android-arm64-vulkan
+            ABI: arm64-v8a
 
     steps:
         @@setup_libs_linux@@
         @@checkout@@
         @@preparation@@
+        @@setup_vulkan_linux@@
+        @@setup_vulcan_android@@
 
         @@cpu-cores@@
         @@build_openssl@@

CMakeLists.txt

@@ -48,6 +48,42 @@ endif()
 
 set(LLAMA_CPP_ROOT ${CMAKE_SOURCE_DIR}/third_party/llama.cpp)
 
+if(ARCHITECTURE MATCHES "android" AND ARCHITECTURE MATCHES "vulkan")
+    # Derive triple from ANDROID_ABI
+    if(ANDROID_ABI STREQUAL "arm64-v8a")
+        set(ANDROID_ARCH_TRIPLE "aarch64-linux-android")
+    elseif(ANDROID_ABI STREQUAL "armeabi-v7a")
+        set(ANDROID_ARCH_TRIPLE "arm-linux-androideabi")
+    elseif(ANDROID_ABI STREQUAL "x86_64")
+        set(ANDROID_ARCH_TRIPLE "x86_64-linux-android")
+    elseif(ANDROID_ABI STREQUAL "x86")
+        set(ANDROID_ARCH_TRIPLE "i686-linux-android")
+    else()
+        message(FATAL_ERROR "Unknown ANDROID_ABI: ${ANDROID_ABI}")
+    endif()
+
+    message(STATUS "ANDROID_ABI=${ANDROID_ABI}")
+    message(STATUS "ANDROID_ARCH_TRIPLE=${ANDROID_ARCH_TRIPLE}")
+    message(STATUS "CMAKE_SYSROOT=${CMAKE_SYSROOT}")
+
+    string(REGEX REPLACE "android-" "" ANDROID_API_LEVEL "${ANDROID_PLATFORM}")
+    set(Vulkan_LIBRARY "${CMAKE_SYSROOT}/usr/lib/${ANDROID_ARCH_TRIPLE}/${ANDROID_API_LEVEL}/libvulkan.so")
+    set(Vulkan_FOUND TRUE)
+    set(Vulkan_VERSION "1.3.275")
+    set(Vulkan_INCLUDE_DIR "${CMAKE_SOURCE_DIR}/third_party/Vulkan-Headers/include")
+
+    if(NOT EXISTS "${Vulkan_LIBRARY}")
+        message(FATAL_ERROR "Vulkan stub not found at: ${Vulkan_LIBRARY}")
+    endif()
+
+    find_program(Vulkan_GLSLC_EXECUTABLE
+        NAMES glslc
+        PATHS "/usr/bin" "/usr/local/bin"
+        NO_CMAKE_SYSTEM_PATH)
+    set(Vulkan_GLSLC_EXECUTABLE "${Vulkan_GLSLC_EXECUTABLE}" CACHE FILEPATH "" FORCE)
+endif()
+
+
 function(LLAMALIB_COMPILE_DEFS NAME)
     add_compile_definitions(${NAME} PRIVATE UNDREAMAI_EXPORTS)
     target_include_directories(${NAME} PRIVATE "${CMAKE_SOURCE_DIR}/include")

src/CMakeLists.txt

@@ -24,6 +24,9 @@ add_library(
 if (CMAKE_SYSTEM_NAME STREQUAL "Linux")
     target_link_options(${LLAMALIB_ARCHITECTURE_LIBRARY} PRIVATE -Wl,--no-undefined)
 endif()
+if(ARCHITECTURE MATCHES "android" AND ARCHITECTURE MATCHES "vulkan")
+    target_link_libraries(${LLAMALIB_ARCHITECTURE_LIBRARY} PRIVATE "${Vulkan_LIBRARY}")
+endif()
 LLAMALIB_COMPILE_DEFS(${LLAMALIB_ARCHITECTURE_LIBRARY})
 target_include_directories(${LLAMALIB_ARCHITECTURE_LIBRARY} PRIVATE "${LLAMA_CPP_ROOT}/src" "${LLAMA_CPP_ROOT}/ggml/include" "${LLAMA_CPP_ROOT}/tools/server" "${LLAMA_CPP_ROOT}/tools/mtmd" "${LLAMA_CPP_ROOT}/common")
 target_link_libraries(${LLAMALIB_ARCHITECTURE_LIBRARY} PRIVATE common mtmd)

third_party/CMakeLists.txt

@@ -30,8 +30,6 @@ elseif(ARCHITECTURE MATCHES "avx2")
     # Nothing to define
 elseif(ARCHITECTURE MATCHES "avx")
     SET(GGML_AVX2 OFF)
-elseif(ARCHITECTURE MATCHES "vulkan")
-    SET(GGML_VULKAN ON)
 elseif(ARCHITECTURE MATCHES "tinyblas")
     SET(GGML_CUDA ON)
     set(GGML_CUDA_FA OFF)
@@ -63,6 +61,11 @@ elseif(ARCHITECTURE MATCHES "android")
     else()
         add_compile_options("-march=x86-64")
     endif()
+    if(ARCHITECTURE MATCHES "vulkan")
+        SET(GGML_VULKAN ON)
+    endif()
+elseif(ARCHITECTURE MATCHES "vulkan")
+    SET(GGML_VULKAN ON)
 elseif(ARCHITECTURE MATCHES "ios" OR ARCHITECTURE MATCHES "visionos")
     SET(GGML_METAL_EMBED_LIBRARY ON)
 elseif(ARCHITECTURE STREQUAL "")
@@ -167,4 +170,4 @@ if(ARCHITECTURE MATCHES "tinyblas")
             target_compile_definitions(${target} PUBLIC GGML_USE_TINYBLAS GGML_CUDA_NO_FA GGML_CUDA_NO_IQUANTS)
         endif()
     endforeach()
-endif()
+endif()