Compare commits

..
Author SHA1 Message Date
Blendman974 75bceb3b92 fix: support Android 16 KiB pages in native llama library 2026-11-06 04:21:43 +01:00
12 changed files with 135 additions and 177 deletions

No files matched your search

-3
View File
@@ -1,3 +0,0 @@
watch_file devenv.nix devenv.yaml devenv.lock
eval "$(devenv direnvrc)"
use devenv
-5
View File
@@ -49,11 +49,6 @@ faceclaw_settings.xml
faceclaw_settings*.json
# Developer configs
.devenv*
.direnv/
.android/
devenv.local.nix
local.properties
build_paths.sh
**/xcuserdata/
-8
View File
@@ -162,14 +162,6 @@ tasks.register("prepareFaceclawNativeLibs") {
def faceclawLlamaCppTag = "b10333"
def faceclawFindSdkCmakeDir = {
// NixOS and other managed environments can provide patched host tools.
def explicitCmake = System.getenv("ANDROID_CMAKE_HOME")
if (explicitCmake != null) {
def explicitDir = file(explicitCmake)
if (faceclawHostExecutable(file("$explicitDir/bin"), "cmake").exists()
&& faceclawHostExecutable(file("$explicitDir/bin"), "ninja").exists()) return explicitDir
throw new GradleException("ANDROID_CMAKE_HOME must contain bin/cmake and bin/ninja: $explicitDir")
}
def sdkRoot = System.getenv("ANDROID_HOME") ?: System.getenv("ANDROID_SDK_ROOT")
if (sdkRoot == null) return null
def cmakeRoot = file("$sdkRoot/cmake")
@@ -29,3 +29,8 @@ add_subdirectory(${LLAMA_CPP_SOURCE_DIR} llama.cpp-build EXCLUDE_FROM_ALL)
add_library(faceclaw_llama SHARED faceclaw_llama.cpp)
target_link_libraries(faceclaw_llama PRIVATE llama android log)
# NDK r27 defaults to 4 KiB. Align both LOAD segments and RELRO boundaries
# for Android devices using 16 KiB pages, including debug APKs.
target_link_options(faceclaw_llama PRIVATE
"-Wl,-z,max-page-size=16384"
"-Wl,-z,common-page-size=16384")
-65
View File
@@ -1,65 +0,0 @@
{
"nodes": {
"devenv": {
"locked": {
"dir": "src/modules",
"lastModified": 1793731702,
"narHash": "sha256-WlVNaWXVTYaGBNey2Z+20sY1lT7BvzJEECb+VlDDdk0=",
"owner": "cachix",
"repo": "devenv",
"rev": "9655d320b8f9df74dbecf681f52a7334574606c3",
"type": "github"
},
"original": {
"dir": "src/modules",
"owner": "cachix",
"repo": "devenv",
"type": "github"
}
},
"nixpkgs": {
"inputs": {
"nixpkgs-src": "nixpkgs-src"
},
"locked": {
"lastModified": 1793043970,
"narHash": "sha256-m14odYTdkBUEkJOiEYs2zjGjn8fcjvdCJsm45+k084U=",
"owner": "cachix",
"repo": "devenv-nixpkgs",
"rev": "d97234e58d4e90e3bf77c082fc3b546e51200938",
"type": "github"
},
"original": {
"owner": "cachix",
"ref": "rolling",
"repo": "devenv-nixpkgs",
"type": "github"
}
},
"nixpkgs-src": {
"flake": false,
"locked": {
"lastModified": 1792812153,
"narHash": "sha256-T2+XBfNbf9pecLUWS4+RtuVNZ3W8K5taG5QdV71mWlk=",
"owner": "NixOS",
"repo": "nixpkgs",
"rev": "674a2028661e550a97400c1cc992b9cca9a668a1",
"type": "github"
},
"original": {
"owner": "NixOS",
"ref": "nixpkgs-unstable",
"repo": "nixpkgs",
"type": "github"
}
},
"root": {
"inputs": {
"devenv": "devenv",
"nixpkgs": "nixpkgs"
}
}
},
"root": "root",
"version": 7
}
-42
View File
@@ -1,42 +0,0 @@
{ pkgs, config, lib, ... }:
{
languages.javascript = {
enable = true;
package = pkgs.nodejs_22;
};
languages.java = {
enable = true;
jdk.package = pkgs.jdk21;
lsp.enable = false;
};
android = {
enable = true;
platforms.version = [ "35" ];
buildTools.version = [ "34.0.0" "35.0.0" "35.0.1" ];
ndk.enable = true;
ndk.version = [ "27.2.12479018" ];
cmake.version = [ ];
emulator.enable = false;
systemImages.enable = false;
sources.enable = false;
};
packages = with pkgs; [ git gh curl jq ripgrep python3 pkg-config gnumake gcc unzip zip ];
# Gradle's downloaded aapt2 cannot run directly on NixOS.
# Keep API 35 aapt2 for phone builds even with Wear's older tools installed.
env.GRADLE_OPTS = lib.mkForce "-Dorg.gradle.project.android.aapt2FromMavenOverride=${config.env.ANDROID_HOME}/build-tools/35.0.0/aapt2";
# NativeScript's doctor rejects a valid build-only SDK without an emulator.
# enterTest below checks the actual tools used by our local builds.
env.NS_SKIP_ENV_CHECK = "1";
env.ANDROID_CMAKE_HOME = "${pkgs.symlinkJoin {
name = "faceclaw-cmake";
paths = [ pkgs.cmake pkgs.ninja ];
}}";
scripts.faceclaw-setup.exec = "npm ci";
scripts.faceclaw-test.exec = "npm test";
enterShell = ''
export PATH="$DEVENV_ROOT/node_modules/.bin:$PATH"
'';
enterTest = ''
bash "$DEVENV_ROOT/scripts/check-devenv.sh"
'';
}
-7
View File
@@ -1,7 +0,0 @@
inputs:
nixpkgs:
url: github:cachix/devenv-nixpkgs/rolling
nixpkgs:
allow_unfree: true
android_sdk:
accept_license: true
-29
View File
@@ -1,29 +0,0 @@
# Nix development environment
Install Nix with flakes and devenv, then run `devenv shell` in this directory
(or `nix run nixpkgs#devenv -- shell`). With direnv, `direnv allow` loads `.envrc`.
The committed `devenv.lock` pins the environment inputs.
The environment provides Node 22/npm, Java 21, Android SDK/platform 35,
build-tools 34.0.0 (Wear OS) and 35.0.0/35.0.1 (phone and NativeScript plugins), NDK 27, CMake,
Git/GitHub CLI, Python and build utilities. `ANDROID_CMAKE_HOME` selects the
Nix-patched CMake/Ninja pair for the native Android libraries (the SDK's bundled
Ninja can crash on NixOS). Other environments keep using the SDK's CMake.
Android SDK licenses are accepted through `devenv.yaml`. Gradle uses the
Nix-patched SDK aapt2. Gradle itself comes from the repository's wrapper.
The emulator and system images are omitted. `NS_SKIP_ENV_CHECK=1` bypasses
NativeScript doctor's mandatory emulator check; `devenv test` checks the actual
SDK/JDK build prerequisites instead.
Run `faceclaw-setup` (`npm ci`) once, then `faceclaw-test` (`npm test`),
`npm run lint` and `npm run test:kotlin`. `devenv test` checks the environment.
`bash build.sh` builds the Android app; it does not install it. On NixOS, any
additional downloaded native executables may require the host's nix-ld support.
iOS builds still require macOS/Xcode and are outside this Linux environment.
Keep machine-specific signing/device settings in the ignored `build_paths.sh`.
Use `gh auth login` separately if GitHub CLI is not already authenticated.
Software tests do not validate Bluetooth behavior on physical glasses. Record
device/firmware versions and manual results separately for hardware checks.
Do not flash firmware during development without explicit permission.
+33
View File
@@ -0,0 +1,33 @@
# Android 16 KiB page compatibility
The initial debug APK triggered Android's page-size compatibility warning.
Its `libfaceclaw_llama.so` LOAD segments were aligned to 4096 bytes. The other
six packaged arm64 libraries were aligned to 16384 bytes, and APK ZIP alignment
already passed `zipalign -c -P 16 4`.
The llama JNI shared library now links with both `max-page-size=16384` and
`common-page-size=16384`, matching the LC3 JNI library. This changes the native
binary layout rather than hiding the compatibility warning or disabling debug.
Gradle already tracks CMakeLists.txt as an input, and Ninja reconfigures and
relinks existing builds after this change.
Reproduce the regression and artifact checks inside `devenv shell`:
```sh
python3 -m unittest discover -s tests -p test_apk_pages.py
bash build.sh
python3 scripts/check-apk-pages.py platforms/android/app/build/outputs/apk/debug/app-debug.apk
"$ANDROID_HOME/build-tools/35.0.1/zipalign" -c -P 16 4 platforms/android/app/build/outputs/apk/debug/app-debug.apk
```
The checker rejects the initial APK and reports its misaligned llama library.
Five unit tests cover 4 KiB rejection, 16 KiB acceptance, RELRO boundaries and
invalid ELF program headers. APK checks inspect all arm64/x86_64 shared libraries.
Reference: [Android's 16 KiB guidance](https://developer.android.com/guide/practices/page-sizes).
Static alignment and successful installation do not prove every native code
path works on-device; voice/LLM features still require functional testing.
The rebuilt APK passes all seven native-library checks, ZIP alignment and APK
signature verification. The connected Pixel 10 Pro Fold reports `getconf
PAGE_SIZE` = 4096; actual execution with 16 KiB pages remains untested.
+57
View File
@@ -0,0 +1,57 @@
#!/usr/bin/env python3
"""Check ELF64 LOAD/RELRO alignment in an APK; pair with zipalign -c -P 16 4."""
import argparse
import struct
import zipfile
PAGE = 16384
def alignment_errors(data):
if len(data) < 64 or data[:4] != b"\x7fELF" or data[4] != 2 or data[5] not in (1, 2):
return ["expected an ELF64 library"]
endian = "<" if data[5] == 1 else ">"
offset = struct.unpack_from(endian + "Q", data, 32)[0]
size, count = struct.unpack_from(endian + "HH", data, 54)
if size < 56 or offset + size * count > len(data):
return ["invalid program headers"]
headers = [struct.unpack_from(endian + "IIQQQQQQ", data, offset + i * size) for i in range(count)]
errors = []
loads = [h for h in headers if h[0] == 1]
if not loads:
errors.append("no LOAD segments")
for h in loads:
if h[7] < PAGE or h[7] % PAGE or (h[3] - h[2]) % PAGE:
errors.append(f"LOAD alignment {h[7]} is incompatible with 16 KiB pages")
for h in headers:
if h[0] != 0x6474E552:
continue
end = h[3] + h[6]
# A RELRO ending within a writable LOAD may protect unrelated writable
# data on a 16 KiB device. A separate LOAD after RELRO is also safe.
if end % PAGE and any(p[1] & 2 and p[3] <= h[3] and end < p[3] + p[6] for p in loads):
errors.append("RELRO ends inside writable LOAD without 16 KiB alignment")
return errors
def main():
parser = argparse.ArgumentParser(description=__doc__)
parser.add_argument("apk")
args = parser.parse_args()
checked = 0
failed = False
with zipfile.ZipFile(args.apk) as archive:
for name in archive.namelist():
if not name.startswith(("lib/arm64-v8a/", "lib/x86_64/")) or not name.endswith(".so"):
continue
checked += 1
errors = alignment_errors(archive.read(name))
failed |= bool(errors)
print(f"{'FAIL' if errors else 'OK'} {name}" + (": " + "; ".join(errors) if errors else ""))
if not checked:
parser.error("no 64-bit native libraries found")
return int(failed)
if __name__ == "__main__":
raise SystemExit(main())
-18
View File
@@ -1,18 +0,0 @@
#!/usr/bin/env bash
set -euo pipefail
node --version
java -version
test -f "$ANDROID_HOME/platforms/android-35/android.jar"
for version in 34.0.0 35.0.0 35.0.1; do
"$ANDROID_HOME/build-tools/$version/aapt2" version
done
"$ANDROID_HOME/platform-tools/adb" version
"$ANDROID_CMAKE_HOME/bin/cmake" --version
"$ANDROID_CMAKE_HOME/bin/ninja" --version
case "$(uname -s)" in
Darwin) ndk_host=darwin-x86_64 ;;
*) ndk_host=linux-x86_64 ;;
esac
test -x "$ANDROID_HOME/ndk/27.2.12479018/toolchains/llvm/prebuilt/$ndk_host/bin/clang"
echo "Faceclaw development tools verified."
+40
View File
@@ -0,0 +1,40 @@
import importlib.util
from pathlib import Path
import struct
import unittest
spec = importlib.util.spec_from_file_location("apk_pages", Path(__file__).parents[1] / "scripts/check-apk-pages.py")
checker = importlib.util.module_from_spec(spec)
spec.loader.exec_module(checker)
def elf(alignment=16384, relro_end=16384, writable_end=32768):
data = bytearray(64 + 2 * 56)
data[:6] = b"\x7fELF\x02\x01"
struct.pack_into("<Q", data, 32, 64)
struct.pack_into("<HH", data, 54, 56, 2)
struct.pack_into("<IIQQQQQQ", data, 64, 1, 6, 0, 0, 0, writable_end, writable_end, alignment)
struct.pack_into("<IIQQQQQQ", data, 120, 0x6474E552, 4, 0, 0, 0, relro_end, relro_end, 1)
return data
class AlignmentTests(unittest.TestCase):
def test_rejects_4k_loads(self):
self.assertTrue(checker.alignment_errors(elf(alignment=4096)))
def test_accepts_16k_loads_and_relro(self):
self.assertEqual([], checker.alignment_errors(elf()))
def test_rejects_relro_protecting_writable_data(self):
self.assertTrue(checker.alignment_errors(elf(relro_end=4096)))
def test_accepts_relro_at_end_of_writable_load(self):
self.assertEqual([], checker.alignment_errors(elf(relro_end=4096, writable_end=4096)))
def test_rejects_invalid_headers(self):
self.assertTrue(checker.alignment_errors(b"not ELF"))
self.assertTrue(checker.alignment_errors(elf()[:70]))
if __name__ == "__main__":
unittest.main()