feat: support android platform cross build

.github/workflows/android_build.yml

@@ -0,0 +1,78 @@
+name: android-cross-build
+
+on:
+  push:
+    branches: [ "main" ]
+    paths-ignore:
+      - '**.md'
+  merge_group:
+  pull_request:
+    branches: [ "main" ]
+    paths-ignore:
+      - '**.md'
+  workflow_dispatch:
+
+jobs:
+  build-android:
+    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        # abi: [arm64-v8a, armeabi-v7a, x86_64]
+        abi: [arm64-v8a]
+        api: [21]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends \
+            cmake ninja-build git ca-certificates python3 \
+            build-essential make
+
+      - name: Setup Java 17
+        uses: actions/setup-java@v4
+        with:
+            distribution: temurin
+            java-version: '17'
+
+      - name: Setup Android NDK
+        uses: android-actions/setup-android@v3
+
+      - name: Install NDK (side by side)
+        shell: bash
+        run: |
+            # yes | sdkmanager --licenses
+            sdkmanager "ndk;26.1.10909125"
+
+      - name: Use host env to compile protoc
+        shell: bash
+        run: |
+          cmake -S . -B build-host -G Ninja
+          cmake --build build-host --target protoc --parallel
+
+      - name: Configure (CMake)
+        shell: bash
+        run: |
+          git submodule foreach --recursive 'git stash --include-untracked'
+
+          export ANDROID_SDK_ROOT="$ANDROID_HOME"
+          export ANDROID_NDK_HOME="$ANDROID_SDK_ROOT/ndk/26.1.10909125"
+
+          cmake -S . -B build-android-${{ matrix.abi }} -G Ninja \
+            -DCMAKE_BUILD_TYPE=Release \
+            -DCMAKE_TOOLCHAIN_FILE="$ANDROID_NDK_HOME/build/cmake/android.toolchain.cmake" \
+            -DANDROID_ABI=${{ matrix.abi }} \
+            -DANDROID_PLATFORM=android-${{ matrix.api }} \
+            -DANDROID_STL=c++_shared \
+            -DBUILD_PYTHON_BINDINGS=OFF \
+            -DBUILD_TOOLS=OFF \
+            -DGLOBAL_CC_PROTOBUF_PROTOC=build-host/bin/protoc \
+
+      - name: Build
+        shell: bash
+        run: |
+          cmake --build build-android-${{ matrix.abi }} --parallel

.gitignore

@@ -5,7 +5,6 @@ build*
 bin/*
 lib/*
 var/*
-thirdparty
 venv*
 tests/integration/conf/*
 tests/de_integration/conf/*
@@ -48,3 +47,5 @@ yarn-debug.log*
 yarn-error.log*
 
 allure-*
+
+!build_android.sh

build_android.sh

@@ -0,0 +1,65 @@
+#!/bin/bash
+set -e
+CURRENT_DIR=$(pwd)
+
+ABI=${1:-"arm64-v8a"}
+API_LEVEL=${2:-21}
+BUILD_TYPE=${3:-"Release"}
+
+# step1: use host env to compile protoc
+echo "step1: building protoc for host..."
+HOST_BUILD_DIR="build_host"
+mkdir -p $HOST_BUILD_DIR
+cd $HOST_BUILD_DIR
+
+cmake -DCMAKE_BUILD_TYPE="$BUILD_TYPE" ..
+make -j protoc
+PROTOC_EXECUTABLE=$CURRENT_DIR/$HOST_BUILD_DIR/bin/protoc
+cd $CURRENT_DIR
+
+echo "step1: Done!!!"
+
+# step2: cross build zvec based on android ndk
+echo "step2: building zvec for android..."
+
+# reset thirdparty directory
+git submodule foreach --recursive 'git stash --include-untracked'
+
+export ANDROID_SDK_ROOT=$HOME/Library/Android/sdk
+export ANDROID_HOME=$ANDROID_SDK_ROOT
+export ANDROID_NDK_HOME=$ANDROID_SDK_ROOT/ndk/28.2.13676358
+export CMAKE_TOOLCHAIN_FILE=$ANDROID_NDK_HOME/build/cmake/android.toolchain.cmake
+
+export PATH=$PATH:$ANDROID_SDK_ROOT/cmdline-tools/latest/bin
+export PATH=$PATH:$ANDROID_SDK_ROOT/platform-tools
+export PATH=$PATH:$ANDROID_NDK_HOME
+
+if [ -z "$ANDROID_NDK_HOME" ]; then
+    echo "error: ANDROID_NDK_HOME env not set"
+    echo "please install NDK and set env variable ANDROID_NDK_HOME"
+    exit 1
+fi
+
+BUILD_DIR="build_android_${ABI}_macos"
+mkdir -p $BUILD_DIR
+cd $BUILD_DIR
+
+echo "configure CMake..."
+cmake \
+    -DANDROID_NDK="$ANDROID_NDK_HOME" \
+    -DCMAKE_TOOLCHAIN_FILE="$ANDROID_NDK_HOME/build/cmake/android.toolchain.cmake" \
+    -DANDROID_ABI="$ABI" \
+    -DANDROID_NATIVE_API_LEVEL="$API_LEVEL" \
+    -DANDROID_STL="c++_static" \
+    -DCMAKE_BUILD_TYPE="$BUILD_TYPE" \
+    -DBUILD_PYTHON_BINDINGS=OFF \
+    -DBUILD_TOOLS=OFF \
+    -DCMAKE_INSTALL_PREFIX="./install" \
+    -DGLOBAL_CC_PROTOBUF_PROTOC=$PROTOC_EXECUTABLE \
+    ../
+
+echo "building..."
+CORE_COUNT=$(sysctl -n hw.ncpu)
+make -j$CORE_COUNT
+
+echo "step2: Done!!!"

cmake/bazel.cmake

@@ -1313,6 +1313,9 @@ function(cc_proto_library)
 
   _find_protobuf("${CC_ARGS_PROTOBUF_VERSION}")
   set(CC_PROTOBUF_PROTOC ${CC_PROTOBUF_PROTOC_${CC_ARGS_PROTOBUF_VERSION}})
+  if(DEFINED GLOBAL_CC_PROTOBUF_PROTOC)
+    set(CC_PROTOBUF_PROTOC ${GLOBAL_CC_PROTOBUF_PROTOC})
+  endif()
   set(CC_PROTOBUF_INCS ${CC_PROTOBUF_INCS_${CC_ARGS_PROTOBUF_VERSION}})
   set(CC_PROTOBUF_LIBS ${CC_PROTOBUF_LIBS_${CC_ARGS_PROTOBUF_VERSION}})
 

examples/c++/CMakeLists.txt

@@ -84,6 +84,16 @@ elseif(APPLE)
         zvec-ailego
         ${zvec_core_deps}
     )
+elseif(ANDROID)
+    target_link_libraries(zvec-core INTERFACE
+        -Wl,--whole-archive
+        zvec_core
+        -Wl,--no-whole-archive
+        -Wl,--start-group
+        zvec-ailego
+        ${zvec_core_deps}
+        -Wl,--end-group
+    )
 else()
     message(FATAL_ERROR "Unsupported platform: ${CMAKE_SYSTEM_NAME}")
 endif()
@@ -106,6 +116,17 @@ elseif(APPLE)
         zvec-ailego
         ${zvec_db_deps}
     )
+elseif(ANDROID)
+    target_link_libraries(zvec-db INTERFACE
+        zvec_db
+        zvec-core
+        zvec-ailego
+        -Wl,--start-group
+        ${zvec_db_deps}
+        -Wl,--end-group
+    )
+else()
+    message(FATAL_ERROR "Unsupported platform: ${CMAKE_SYSTEM_NAME}")
 endif()
 
 
@@ -114,6 +135,11 @@ add_executable(db-example db/main.cc)
 target_link_libraries(db-example PRIVATE
     zvec-db
 )
+if(ANDROID)
+    target_link_libraries(db-example PRIVATE
+        log
+    )
+endif()
 
 add_executable(core-example core/main.cc)
 target_link_libraries(core-example PRIVATE

examples/c++/build_android.sh

@@ -0,0 +1,41 @@
+export ANDROID_SDK_ROOT=$HOME/Library/Android/sdk
+export ANDROID_HOME=$ANDROID_SDK_ROOT
+export ANDROID_NDK_HOME=$ANDROID_SDK_ROOT/ndk/28.2.13676358
+export CMAKE_TOOLCHAIN_FILE=$ANDROID_NDK_HOME/build/cmake/android.toolchain.cmake
+
+export PATH=$PATH:$ANDROID_SDK_ROOT/cmdline-tools/latest/bin
+export PATH=$PATH:$ANDROID_SDK_ROOT/platform-tools
+export PATH=$PATH:$ANDROID_NDK_HOME
+
+#!/bin/bash
+set -e
+
+if [ -z "$ANDROID_NDK_HOME" ]; then
+    echo "error: ANDROID_NDK_HOME env not set"
+    echo "please install NDK and set env variable ANDROID_NDK_HOME"
+    exit 1
+fi
+
+ABI=${1:-"arm64-v8a"}
+API_LEVEL=${2:-21}
+BUILD_TYPE=${3:-"Release"}
+
+BUILD_DIR="build_android_${ABI}_macos"
+mkdir -p $BUILD_DIR
+cd $BUILD_DIR
+
+echo "configure CMake..."
+cmake \
+    -DANDROID_NDK="$ANDROID_NDK_HOME" \
+    -DCMAKE_TOOLCHAIN_FILE="$ANDROID_NDK_HOME/build/cmake/android.toolchain.cmake" \
+    -DANDROID_ABI="$ABI" \
+    -DANDROID_NATIVE_API_LEVEL="$API_LEVEL" \
+    -DCMAKE_BUILD_TYPE="$BUILD_TYPE" \
+    -DBUILD_PYTHON_BINDINGS=OFF \
+    -DBUILD_TOOLS=OFF \
+    -DCMAKE_INSTALL_PREFIX="./install" \
+    ../
+
+echo "building..."
+CORE_COUNT=$(sysctl -n hw.ncpu)
+make -j$CORE_COUNT

pyproject.toml

@@ -182,6 +182,7 @@ exclude = [
     ".git/",
     ".venv/",
     "venv/",
+    "thirdparty",
 ]
 
 [tool.ruff.lint]

src/ailego/CMakeLists.txt

@@ -3,7 +3,7 @@ include(${PROJECT_ROOT_DIR}/cmake/option.cmake)
 
 find_package(Threads REQUIRED)
 
-if(UNIX AND NOT APPLE)
+if(UNIX AND NOT APPLE AND NOT ANDROID)
     find_library(LIB_RT NAMES rt)
 else()
     set(LIB_RT "")

thirdparty/arrow/CMakeLists.txt

@@ -1,6 +1,11 @@
 set(ARROW_SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR}/apache-arrow-21.0.0)
-set(ARROW_PATCH ${CMAKE_CURRENT_SOURCE_DIR}/arrow.patch)
-apply_patch_once("arrow_fix" "${ARROW_SRC_DIR}" "${ARROW_PATCH}")
+if(ANDROID)
+        set(ARROW_PATCH ${CMAKE_CURRENT_SOURCE_DIR}/arrow.android.patch)
+        apply_patch_once("arrow_android_fix" "${ARROW_SRC_DIR}" "${ARROW_PATCH}")
+else()
+        set(ARROW_PATCH ${CMAKE_CURRENT_SOURCE_DIR}/arrow.patch)
+        apply_patch_once("arrow_fix" "${ARROW_SRC_DIR}" "${ARROW_PATCH}")
+endif()
 
 include(ExternalProject)
 include(ProcessorCount)
@@ -14,20 +19,37 @@ set(LIB_ACERO ${EXTERNAL_LIB_DIR}/libarrow_acero.a)
 set(LIB_ARROW_DEPENDS ${EXTERNAL_LIB_DIR}/libarrow_bundled_dependencies.a)
 set(LIB_ARROW_DATASET ${EXTERNAL_LIB_DIR}/libarrow_dataset.a)
 
-ExternalProject_Add(
-        ARROW.BUILD PREFIX arrow
-        SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/apache-arrow-21.0.0
-        DOWNLOAD_COMMAND ""
-        BUILD_IN_SOURCE false
-        CONFIGURE_COMMAND "${CMAKE_COMMAND}" ${CMAKE_CACHE_ARGS} -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} -DCMAKE_DEBUG_POSTFIX= -DARROW_BUILD_SHARED=OFF -DARROW_ACERO=ON -DARROW_FILESYSTEM=ON -DARROW_DATASET=ON -DARROW_PARQUET=ON -DARROW_COMPUTE=ON -DARROW_WITH_ZLIB=OFF -DARROW_DEPENDENCY_SOURCE=BUNDLED -DARROW_MIMALLOC=OFF -DCMAKE_INSTALL_LIBDIR=lib "<SOURCE_DIR>/cpp"
-        BUILD_COMMAND "${CMAKE_COMMAND}" --build . --target all -- -j ${NPROC}
-        INSTALL_COMMAND "${CMAKE_COMMAND}" --install "<BINARY_DIR>" --prefix=${EXTERNAL_BINARY_DIR}/usr/local
-        BYPRODUCTS ${LIB_PARQUET} ${LIB_ARROW} ${LIB_COMPUTE} ${LIB_ACERO} ${LIB_ARROW_DEPENDS} ${LIB_ARROW_DATASET}
-        LOG_DOWNLOAD ON
-        LOG_CONFIGURE ON
-        LOG_BUILD ON
-        LOG_INSTALL ON
-)
+if(ANDROID)
+        ExternalProject_Add(
+                ARROW.BUILD PREFIX arrow
+                SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/apache-arrow-21.0.0
+                DOWNLOAD_COMMAND ""
+                BUILD_IN_SOURCE false
+                CONFIGURE_COMMAND "${CMAKE_COMMAND}" ${CMAKE_CACHE_ARGS} -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} -DCMAKE_DEBUG_POSTFIX= -DARROW_BUILD_SHARED=OFF -DARROW_ACERO=ON -DARROW_FILESYSTEM=ON -DARROW_DATASET=ON -DARROW_PARQUET=ON -DARROW_COMPUTE=ON -DARROW_WITH_ZLIB=OFF -DARROW_DEPENDENCY_SOURCE=BUNDLED -DARROW_MIMALLOC=OFF -DCMAKE_INSTALL_LIBDIR=lib -DCMAKE_TOOLCHAIN_FILE=${CMAKE_TOOLCHAIN_FILE} -DANDROID_ABI=${ANDROID_ABI} -DANDROID_NATIVE_API_LEVEL=${ANDROID_NATIVE_API_LEVEL} -DARROW_WITH_MUSL=OFF "<SOURCE_DIR>/cpp"
+                BUILD_COMMAND "${CMAKE_COMMAND}" --build . --target all -- -j ${NPROC}
+                INSTALL_COMMAND "${CMAKE_COMMAND}" --install "<BINARY_DIR>" --prefix=${EXTERNAL_BINARY_DIR}/usr/local
+                BYPRODUCTS ${LIB_PARQUET} ${LIB_ARROW} ${LIB_COMPUTE} ${LIB_ACERO} ${LIB_ARROW_DEPENDS} ${LIB_ARROW_DATASET}
+                LOG_DOWNLOAD ON
+                LOG_CONFIGURE ON
+                LOG_BUILD ON
+                LOG_INSTALL ON
+        )
+else()
+        ExternalProject_Add(
+                ARROW.BUILD PREFIX arrow
+                SOURCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/apache-arrow-21.0.0
+                DOWNLOAD_COMMAND ""
+                BUILD_IN_SOURCE false
+                CONFIGURE_COMMAND "${CMAKE_COMMAND}" ${CMAKE_CACHE_ARGS} -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE} -DCMAKE_DEBUG_POSTFIX= -DARROW_BUILD_SHARED=OFF -DARROW_ACERO=ON -DARROW_FILESYSTEM=ON -DARROW_DATASET=ON -DARROW_PARQUET=ON -DARROW_COMPUTE=ON -DARROW_WITH_ZLIB=OFF -DARROW_DEPENDENCY_SOURCE=BUNDLED -DARROW_MIMALLOC=OFF -DCMAKE_INSTALL_LIBDIR=lib "<SOURCE_DIR>/cpp"
+                BUILD_COMMAND "${CMAKE_COMMAND}" --build . --target all -- -j ${NPROC}
+                INSTALL_COMMAND "${CMAKE_COMMAND}" --install "<BINARY_DIR>" --prefix=${EXTERNAL_BINARY_DIR}/usr/local
+                BYPRODUCTS ${LIB_PARQUET} ${LIB_ARROW} ${LIB_COMPUTE} ${LIB_ACERO} ${LIB_ARROW_DEPENDS} ${LIB_ARROW_DATASET}
+                LOG_DOWNLOAD ON
+                LOG_CONFIGURE ON
+                LOG_BUILD ON
+                LOG_INSTALL ON
+        )
+endif()
 add_library(arrow UNKNOWN IMPORTED GLOBAL)
 add_dependencies(arrow ARROW.BUILD)