Skip to content

Feature/add android support #1130

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Feature/add android support #1130

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6610db5
add android support
AmSmart Mar 19, 2025
38f6bb3
add maui test project
AmSmart Mar 19, 2025
ded0f07
update workflow
AmSmart Mar 19, 2025
9f8863a
uncomment Android section of Gather Binaries
AmSmart Mar 19, 2025
2ac7871
add ggm-base and ggml-cpu
AmSmart Mar 19, 2025
bb528ba
update MSBuild for ggm-base and ggml-cpu
AmSmart Mar 19, 2025
472140e
create separate Android nuspec
AmSmart Apr 19, 2025
4421364
fix failing tests
AmSmart Apr 19, 2025
bc4bdf9
sync fork
AmSmart Apr 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
71 changes: 43 additions & 28 deletions .github/workflows/compile.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -527,19 +527,17 @@ jobs:
if-no-files-found: error

compile-android:
# Disable android build
if: false

name: Compile (Android)
strategy:
fail-fast: true
matrix:
include:
- build: 'x86'
defines: '-DANDROID_ABI=x86'
defines: '-DANDROID_ABI=x86 -DCMAKE_C_FLAGS=-march=i686 -DCMAKE_CXX_FLAGS=-march=i686'
- build: 'x86_64'
defines: '-DANDROID_ABI=x86_64'
defines: '-DANDROID_ABI=x86_64 -DCMAKE_C_FLAGS=-march=x86-64 -DCMAKE_CXX_FLAGS=-march=x86-64'
- build: 'arm64-v8a'
defines: '-DANDROID_ABI=arm64-v8a'
defines: '-DANDROID_ABI=arm64-v8a -DCMAKE_C_FLAGS=-march=armv8.7a -DCMAKE_C_FLAGS=-march=armv8.7a'
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v4
Expand All @@ -555,28 +553,39 @@ jobs:
- name: Build
id: cmake_build
env:
CMAKE_FLAGS: '-DCMAKE_TOOLCHAIN_FILE=${{ steps.setup-ndk.outputs.ndk-path }}/build/cmake/android.toolchain.cmake -DANDROID_PLATFORM=android-23'
CMAKE_FLAGS: '-DCMAKE_TOOLCHAIN_FILE=${{ steps.setup-ndk.outputs.ndk-path }}/build/cmake/android.toolchain.cmake -DANDROID_PLATFORM=android-23 -DGGML_OPENMP=OFF -DGGML_LLAMAFILE=OFF'
run: |
mkdir build
cd build
cmake .. ${{ env.COMMON_DEFINE }} ${{ env.CMAKE_FLAGS }} ${{ matrix.defines }}
cmake --build . --config Release -j ${env:NUMBER_OF_PROCESSORS}
cd ..
ls -R
# export-lora not supported on 32 bit machines hence breaks x86 build
sed -i '/add_subdirectory(export-lora)/d' examples/CMakeLists.txt # remove export-lora from examples
cmake ${{ env.COMMON_DEFINE }} ${{ env.CMAKE_FLAGS }} ${{ matrix.defines }} -B build
cmake --build build --config Release -j ${env:NUMBER_OF_PROCESSORS}
- name: Upload Llama
uses: actions/upload-artifact@v4
with:
path: ./build/src/libllama.so
path: ./build/bin/libllama.so
name: llama-bin-android-${{ matrix.build }}.so
- uses: actions/upload-artifact@v4
- name: Upload GGML
uses: actions/upload-artifact@v4
with:
path: ./build/ggml/src/libggml.so
path: ./build/bin/libggml.so
name: ggml-bin-android-${{ matrix.build }}.so
if-no-files-found: error
- name: Upload GGML Base
uses: actions/upload-artifact@v4
with:
path: ./build/bin/libggml-base.so
name: ggml-base-bin-android-${{ matrix.build }}.so
if-no-files-found: error
- name: Upload GGML CPU
uses: actions/upload-artifact@v4
with:
path: ./build/bin/libggml-cpu.so
name: ggml-cpu-bin-android-${{ matrix.build }}.so
if-no-files-found: error
- name: Upload Llava
uses: actions/upload-artifact@v4
with:
path: ./build/examples/llava/libllava_shared.so
path: ./build/bin/libllava_shared.so
name: llava-bin-android-${{ matrix.build }}.so

build-deps:
Expand Down Expand Up @@ -703,17 +712,23 @@ jobs:
cp artifacts/llava-bin-osx-x64-rosetta2.dylib/libllava_shared.dylib deps/osx-x64-rosetta2/libllava_shared.dylib

# Android
#cp artifacts/ggml-bin-android-arm64-v8a.so/libggml.so deps/android-arm64-v8a/libggml.so
#cp artifacts/llama-bin-android-arm64-v8a.so/libllama.so deps/android-arm64-v8a/libllama.so
#cp artifacts/llava-bin-android-arm64-v8a.so/libllava_shared.so deps/android-arm64-v8a/libllava_shared.so

#cp artifacts/ggml-bin-android-x86.so/libggml.so deps/android-x86/libggml.so
#cp artifacts/llama-bin-android-x86.so/libllama.so deps/android-x86/libllama.so
#cp artifacts/llava-bin-android-x86.so/libllava_shared.so deps/android-x86/libllava_shared.so

#cp artifacts/ggml-bin-android-x86_64.so/libggml.so deps/android-x86_64/libggml.so
#cp artifacts/llama-bin-android-x86_64.so/libllama.so deps/android-x86_64/libllama.so
#cp artifacts/llava-bin-android-x86_64.so/libllava_shared.so deps/android-x86_64/libllava_shared.so
cp artifacts/ggml-bin-android-arm64-v8a.so/libggml.so deps/android-arm64-v8a/libggml.so
cp artifacts/ggml-base-bin-android-arm64-v8a.so/libggml-base.so deps/android-arm64-v8a/libggml-base.so
cp artifacts/ggml-cpu-bin-android-arm64-v8a.so/libggml-cpu.so deps/android-arm64-v8a/libggml-cpu.so
cp artifacts/llama-bin-android-arm64-v8a.so/libllama.so deps/android-arm64-v8a/libllama.so
cp artifacts/llava-bin-android-arm64-v8a.so/libllava_shared.so deps/android-arm64-v8a/libllava_shared.so

cp artifacts/ggml-bin-android-x86.so/libggml.so deps/android-x86/libggml.so
cp artifacts/ggml-base-bin-android-x86.so/libggml-base.so deps/android-x86/libggml-base.so
cp artifacts/ggml-cpu-bin-android-x86.so/libggml-cpu.so deps/android-x86/libggml-cpu.so
cp artifacts/llama-bin-android-x86.so/libllama.so deps/android-x86/libllama.so
cp artifacts/llava-bin-android-x86.so/libllava_shared.so deps/android-x86/libllava_shared.so

cp artifacts/ggml-bin-android-x86_64.so/libggml.so deps/android-x86_64/libggml.so
cp artifacts/ggml-base-bin-android-x86_64.so/libggml-base.so deps/android-x86_64/libggml-base.so
cp artifacts/ggml-cpu-bin-android-x86_64.so/libggml-cpu.so deps/android-x86_64/libggml-cpu.so
cp artifacts/llama-bin-android-x86_64.so/libllama.so deps/android-x86_64/libllama.so
cp artifacts/llava-bin-android-x86_64.so/libllava_shared.so deps/android-x86_64/libllava_shared.so

# Windows CUDA
cp artifacts/ggml-bin-win-cublas-cu11.7.1-x64.dll/ggml.dll deps/cu11.7.1/ggml.dll
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/main.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ jobs:
with:
dotnet-version: |
8.0.x
- name: Install Mobile Workloads
run: |
dotnet workload install android --ignore-failed-sources
dotnet workload install maui --ignore-failed-sources
- name: Cache Packages
uses: actions/cache@v4
with:
Expand Down
90 changes: 90 additions & 0 deletions LLama/LLamaSharp.Runtime.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,4 +466,94 @@
<Link>runtimes/linux-x64/native/vulkan/libllava_shared.so</Link>
</None>
</ItemGroup>

<!-- Android Native Libs (Start) -->
<ItemGroup
Condition="$(AndroidSupportedAbis.Contains('x86')) or $(RuntimeIdentifiers.Contains('android-x86'))">
<AndroidNativeLibrary Visible="false"
Include="$(MSBuildThisFileDirectory)runtimes/deps/android-x86/libllama.so">
<Link>runtimes/android-x86/native/libllama.so</Link>
<Abi>x86</Abi>
</AndroidNativeLibrary>
<AndroidNativeLibrary Visible="false"
Include="$(MSBuildThisFileDirectory)runtimes/deps/android-x86/libggml.so">
<Link>runtimes/android-x86/native/libggml.so</Link>
<Abi>x86</Abi>
</AndroidNativeLibrary>
<AndroidNativeLibrary Visible="false"
Include="$(MSBuildThisFileDirectory)runtimes/deps/android-x86/libggml-base.so">
<Link>runtimes/android-x86/native/libggml-base.so</Link>
<Abi>x86</Abi>
</AndroidNativeLibrary>
<AndroidNativeLibrary Visible="false"
Include="$(MSBuildThisFileDirectory)runtimes/deps/android-x86/libggml-cpu.so">
<Link>runtimes/android-x86/native/libggml-cpu.so</Link>
<Abi>x86</Abi>
</AndroidNativeLibrary>
<AndroidNativeLibrary Visible="false"
Include="$(MSBuildThisFileDirectory)runtimes/deps/android-x86/libllava_shared.so">
<Link>runtimes/android-x86/native/libllava_shared.so</Link>
<Abi>x86</Abi>
</AndroidNativeLibrary>
</ItemGroup>

<ItemGroup
Condition="$(AndroidSupportedAbis.Contains('x86_64')) or $(RuntimeIdentifiers.Contains('android-x64'))">
<AndroidNativeLibrary Visible="false"
Include="$(MSBuildThisFileDirectory)runtimes/deps/android-x86_64/libllama.so">
<Link>lib/x86_64/libllama.so</Link>
<Abi>x86_64</Abi>
</AndroidNativeLibrary>
<AndroidNativeLibrary Visible="false"
Include="$(MSBuildThisFileDirectory)runtimes/deps/android-x86_64/libggml.so">
<Link>lib/x86_64/libggml.so</Link>
<Abi>x86_64</Abi>
</AndroidNativeLibrary>
<AndroidNativeLibrary Visible="false"
Include="$(MSBuildThisFileDirectory)runtimes/deps/android-x86_64/libggml-base.so">
<Link>lib/x86_64/libggml-base.so</Link>
<Abi>x86_64</Abi>
</AndroidNativeLibrary>
<AndroidNativeLibrary Visible="false"
Include="$(MSBuildThisFileDirectory)runtimes/deps/android-x86_64/libggml-cpu.so">
<Link>lib/x86_64/libggml-cpu.so</Link>
<Abi>x86_64</Abi>
</AndroidNativeLibrary>
<AndroidNativeLibrary Visible="false"
Include="$(MSBuildThisFileDirectory)runtimes/deps/android-x86_64/libllava_shared.so">
<Link>lib/x86_64/libllava_shared.so</Link>
<Abi>x86_64</Abi>
</AndroidNativeLibrary>
</ItemGroup>

<ItemGroup
Condition="$(AndroidSupportedAbis.Contains('arm64-v8a')) or $(RuntimeIdentifiers.Contains('android-arm64'))">
<AndroidNativeLibrary Visible="false"
Include="$(MSBuildThisFileDirectory)runtimes/deps/android-arm64-v8a/libllama.so">
<Link>lib/arm64-v8a/libllama.so</Link>
<Abi>arm64-v8a</Abi>
</AndroidNativeLibrary>
<AndroidNativeLibrary Visible="false"
Include="$(MSBuildThisFileDirectory)runtimes/deps/android-arm64-v8a/libggml.so">
<Link>lib/arm64-v8a/libggml.so</Link>
<Abi>arm64-v8a</Abi>
</AndroidNativeLibrary>
<AndroidNativeLibrary Visible="false"
Include="$(MSBuildThisFileDirectory)runtimes/deps/android-arm64-v8a/libggml-base.so">
<Link>lib/arm64-v8a/libggml-base.so</Link>
<Abi>arm64-v8a</Abi>
</AndroidNativeLibrary>
<AndroidNativeLibrary Visible="false"
Include="$(MSBuildThisFileDirectory)runtimes/deps/android-arm64-v8a/libggml-cpu.so">
<Link>lib/arm64-v8a/libggml-cpu.so</Link>
<Abi>arm64-v8a</Abi>
</AndroidNativeLibrary>
<AndroidNativeLibrary Visible="false"
Include="$(MSBuildThisFileDirectory)runtimes/deps/android-arm64-v8a/libllava_shared.so">
<Link>lib/arm64-v8a/libllava_shared.so</Link>
<Abi>arm64-v8a</Abi>
</AndroidNativeLibrary>
</ItemGroup>
<!-- Android Native Libs (End) -->

</Project>
6 changes: 6 additions & 0 deletions LLama/Native/NativeApi.Load.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,12 @@ private static void SetDllImportResolver()
// NativeLibrary is not available on older runtimes. We'll have to depend on
// the normal runtime dll resolution there.
#if NET5_0_OR_GREATER
if (OperatingSystem.IsAndroid())
{
// Android doesn't support DllImportResolver, so we have to rely on the default search path
return;
}

NativeLibrary.SetDllImportResolver(typeof(NativeApi).Assembly, (name, _, _) =>
{
if (name == "llama")
Expand Down
41 changes: 41 additions & 0 deletions LLama/runtimes/build/LLamaSharp.Backend.Cpu.Android.nuspec
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
<?xml version="1.0" encoding="utf-8"?>
<package >
<metadata>
<id>LLamaSharp.Backend.Cpu.Android</id>
<version>$version$</version>
<title>LLamaSharp.Backend.Cpu.Android, the backend for LLamaSharp</title>
<authors>llama.cpp Authors</authors>
<requireLicenseAcceptance>false</requireLicenseAcceptance>
<license type="expression">MIT</license>
<icon>icon512.png</icon>
<projectUrl>https://github.com/SciSharp/LLamaSharp</projectUrl>
<description>LLamaSharp.Backend.Cpu.Android is a backend for LLamaSharp to use with Android Cpu only.</description>
<releaseNotes></releaseNotes>
<copyright>Copyright 2023 The llama.cpp Authors. All rights reserved.</copyright>
<tags>LLamaSharp LLama LLM GPT AI ChatBot SciSharp</tags>
</metadata>

<files>
<file src="LLamaSharpBackend.props" target="build/netstandard2.0/LLamaSharp.Backend.Cpu.Android.props" />

<file src="runtimes/deps/android-arm64-v8a/libllama.so" target="runtimes\android-arm64-v8a\native\libllama.so" />
<file src="runtimes/deps/android-arm64-v8a/libggml.so" target="runtimes\android-arm64-v8a\native\libggml.so" />
<file src="runtimes/deps/android-arm64-v8a/libggml-base.so" target="runtimes\android-arm64-v8a\native\libggml-base.so" />
<file src="runtimes/deps/android-arm64-v8a/libggml-cpu.so" target="runtimes\android-arm64-v8a\native\libggml-cpu.so" />
<file src="runtimes/deps/android-arm64-v8a/libllava_shared.so" target="runtimes\android-arm64-v8a\native\libllava_shared.so" />

<file src="runtimes/deps/android-x86_64/libllama.so" target="runtimes\android-x86_64\native\libllama.so" />
<file src="runtimes/deps/android-x86_64/libggml.so" target="runtimes\android-x86_64\native\libggml.so" />
<file src="runtimes/deps/android-x86_64/libggml-base.so" target="runtimes\android-x86_64\native\libggml-base.so" />
<file src="runtimes/deps/android-x86_64/libggml-cpu.so" target="runtimes\android-x86_64\native\libggml-cpu.so" />
<file src="runtimes/deps/android-x86_64/libllava_shared.so" target="runtimes\android-x86_64\native\libllava_shared.so" />

<file src="runtimes/deps/android-x86/libllama.so" target="runtimes\android-x86\native\libllama.so" />
<file src="runtimes/deps/android-x86/libggml.so" target="runtimes\android-x86\native\libggml.so" />
<file src="runtimes/deps/android-x86/libggml-base.so" target="runtimes\android-x86\native\libggml-base.so" />
<file src="runtimes/deps/android-x86/libggml-cpu.so" target="runtimes\android-x86\native\libggml-cpu.so" />
<file src="runtimes/deps/android-x86/libllava_shared.so" target="runtimes\android-x86\native\libllava_shared.so" />

<file src="icon512.png" target="icon512.png" />
</files>
</package>
Loading