Skip to content
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

Add support for Android/iOS (and react-native) #91

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add support for Android/iOS (and react-native) #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3770437
Add makefile rule to compile for Android archs
ospfranco Aug 26, 2024
635496e
Add iOS compilation steps
ospfranco Aug 27, 2024
e26206f
Update makefile with minOS version
ospfranco Sep 15, 2024
2edd945
Fix min OS version not being set to 8
ospfranco Sep 15, 2024
0bd1ce7
Generate a final xcframework with correct rpaths
ospfranco Sep 15, 2024
c190580
Merge branch 'main' into oscar/react-native
ospfranco Sep 26, 2024
f0f2376
Merge branch 'main' into oscar/react-native
ospfranco Sep 26, 2024
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
Binary file added .DS_Store
View file
Open in desktop
Binary file not shown.
5 changes: 4 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,7 @@ sqlite-vec.h
tmp/

poetry.lock
pyproject.toml
pyproject.toml

templates/sqlitevec.xcframework/ios-arm64/sqlitevec.framework/sqlitevec
templates/sqlitevec.xcframework/ios-arm64_x86_64-simulator/sqlitevec.framework/sqlitevec
125 changes: 125 additions & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,131 @@ uninstall:
rm -f $(INSTALL_INCLUDE_DIR)/sqlite-vec.h
ldconfig

# ███████████████████████████████ ANDROID SECTION ███████████████████████████████

# Define Android NDK paths (update these to your actual NDK path)
# NDK_PATH ?= /path/to/android-ndk
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ANDROID_NDK_HOME needs to be defined in case you want to compile libraries for Android.

# SYSROOT = $(ANDROID_NDK_HOME)/toolchains/llvm/prebuilt/linux-x86_64/sysroot

# Define target architectures
ARCHS = arm64-v8a armeabi-v7a x86 x86_64

# Define cross-compiler toolchains
CC_aarch64 = $(ANDROID_NDK_HOME)/toolchains/llvm/prebuilt/darwin-x86_64/bin/aarch64-linux-android21-clang
CC_arm = $(ANDROID_NDK_HOME)/toolchains/llvm/prebuilt/darwin-x86_64/bin/armv7a-linux-androideabi21-clang
CC_x86 = $(ANDROID_NDK_HOME)/toolchains/llvm/prebuilt/darwin-x86_64/bin/i686-linux-android21-clang
CC_x86_64 = $(ANDROID_NDK_HOME)/toolchains/llvm/prebuilt/darwin-x86_64/bin/x86_64-linux-android21-clang

# Define output directories for each architecture
OUT_DIR_aarch64 = $(prefix)/android/arm64-v8a
OUT_DIR_arm = $(prefix)/android/armeabi-v7a
OUT_DIR_x86 = $(prefix)/android/x86
OUT_DIR_x86_64 = $(prefix)/android/x86_64

# Compilation rules for each architecture
$(OUT_DIR_aarch64):
mkdir -p $@

$(OUT_DIR_arm):
mkdir -p $@

$(OUT_DIR_x86):
mkdir -p $@

$(OUT_DIR_x86_64):
mkdir -p $@

# Set the path to sqlite3ext.h, assuming it's in vendor/sqlite3/
SQLITE_INCLUDE_PATH = -Ivendor/

# Android-specific flags (no -mcpu=apple-m1 here)
ANDROID_CFLAGS = -Ivendor/ -I./ -O3 -fPIC

# Rule for compiling for arm64-v8a
android_arm64-v8a: $(OUT_DIR_aarch64)
$(CC_aarch64) $(CFLAGS) $(SQLITE_INCLUDE_PATH) $(ANDROID_CFLAGS) -shared sqlite-vec.c -o $(OUT_DIR_aarch64)/libsqlite_vec.so

# Rule for compiling for armeabi-v7a
android_armeabi-v7a: $(OUT_DIR_arm)
$(CC_arm) $(CFLAGS) $(SQLITE_INCLUDE_PATH) $(ANDROID_CFLAGS) -shared sqlite-vec.c -o $(OUT_DIR_arm)/libsqlite_vec.so

# Rule for compiling for x86
android_x86: $(OUT_DIR_x86)
$(CC_x86) $(CFLAGS) $(SQLITE_INCLUDE_PATH) $(ANDROID_CFLAGS) -shared sqlite-vec.c -o $(OUT_DIR_x86)/libsqlite_vec.so

# Rule for compiling for x86_64
android_x86_64: $(OUT_DIR_x86_64)
$(CC_x86_64) $(CFLAGS) $(SQLITE_INCLUDE_PATH) $(ANDROID_CFLAGS) -shared sqlite-vec.c -o $(OUT_DIR_x86_64)/libsqlite_vec.so

# Rule to compile for all Android architectures
android: android_arm64-v8a android_armeabi-v7a android_x86 android_x86_64
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to compile with OMIT_SIMD=1 make android as there is a flag added above with mcpu=m1 which is not compatible by the clang compiler android uses.


.PHONY: android android_arm64-v8a android_armeabi-v7a android_x86 android_x86_64

# ███████████████████████████████ END ANDROID ███████████████████████████████

# ███████████████████████████████ IOS SECTION ███████████████████████████████

MIN_IOS_VERSION = 8.0

# iOS SDK paths
IOS_SDK_PATH = $(shell xcrun --sdk iphoneos --show-sdk-path)
IOS_SIMULATOR_SDK_PATH = $(shell xcrun --sdk iphonesimulator --show-sdk-path)

# iOS cross-compiler toolchains
CC_ios_arm64 = $(shell xcrun --sdk iphoneos --find clang)
CC_ios_x86_64 = $(shell xcrun --sdk iphonesimulator --find clang)

# Output directories for iOS
OUT_DIR_ios_arm64 = $(prefix)/ios/arm64
OUT_DIR_ios_x86_64 = $(prefix)/ios/x86_64
OUT_DIR_ios_arm64_simulator = $(prefix)/ios/arm64_simulator

# iOS-specific flags
IOS_CFLAGS = -Ivendor/ -I./ -O3 -fembed-bitcode -fPIC
IOS_LDFLAGS = -Wl,-ios_version_min,$(MIN_IOS_VERSION)
IOS_ARM64_FLAGS = -target arm64-apple-ios$(MIN_IOS_VERSION) -miphoneos-version-min=$(MIN_IOS_VERSION)
IOS_ARM64_SIM_FLAGS = -target arm64-apple-ios-simulator$(MIN_IOS_VERSION) -mios-simulator-version-min=$(MIN_IOS_VERSION)
IOS_X86_64_FLAGS = -target x86_64-apple-ios-simulator$(MIN_IOS_VERSION) -mios-simulator-version-min=$(MIN_IOS_VERSION)

# Compilation rules for each iOS architecture
$(OUT_DIR_ios_arm64):
mkdir -p $@

$(OUT_DIR_ios_x86_64):
mkdir -p $@

$(OUT_DIR_ios_arm64_simulator):
mkdir -p $@

# Rule for compiling for iOS arm64 (device)
ios_arm64: $(OUT_DIR_ios_arm64)
$(CC_ios_arm64) $(CFLAGS) $(IOS_CFLAGS) $(IOS_ARM64_FLAGS) -isysroot $(IOS_SDK_PATH) -c sqlite-vec.c -o $(OUT_DIR_ios_arm64)/sqlite-vec.o
$(CC_ios_arm64) -dynamiclib -o $(OUT_DIR_ios_arm64)/sqlitevec $(OUT_DIR_ios_arm64)/sqlite-vec.o -isysroot $(IOS_SDK_PATH) $(IOS_LDFLAGS)

# Rule for compiling for iOS x86_64 (simulator)
ios_x86_64: $(OUT_DIR_ios_x86_64)
$(CC_ios_x86_64) $(CFLAGS) $(IOS_CFLAGS) $(IOS_X86_64_FLAGS) -isysroot $(IOS_SIMULATOR_SDK_PATH) -c sqlite-vec.c -o $(OUT_DIR_ios_x86_64)/sqlite-vec.o
$(CC_ios_x86_64) $(IOS_X86_64_FLAGS) -dynamiclib -o $(OUT_DIR_ios_x86_64)/sqlitevec $(OUT_DIR_ios_x86_64)/sqlite-vec.o -isysroot $(IOS_SIMULATOR_SDK_PATH)

# Rule for compiling for iOS arm64 (simulator)
ios_arm64_sim: $(OUT_DIR_ios_arm64_simulator)
$(CC_ios_arm64) $(CFLAGS) $(IOS_CFLAGS) $(IOS_ARM64_SIM_FLAGS) -isysroot $(IOS_SIMULATOR_SDK_PATH) -c sqlite-vec.c -o $(OUT_DIR_ios_arm64_simulator)/sqlite-vec.o
$(CC_ios_arm64) -dynamiclib -o $(OUT_DIR_ios_arm64_simulator)/sqlitevec $(OUT_DIR_ios_arm64_simulator)/sqlite-vec.o -isysroot $(IOS_SIMULATOR_SDK_PATH)


# Rule to compile for all iOS architectures
ios: ios_arm64 ios_x86_64 ios_arm64_sim
lipo -create ./dist/ios/x86_64/sqlitevec ./dist/ios/arm64_simulator/sqlitevec -output dist/ios/sim_fat/sqlitevec
cp ./dist/ios/arm64/sqlitevec ./templates/sqlitevec.xcframework/ios-arm64/sqlitevec.framework/
install_name_tool -id @rpath/sqlitevec.framework/sqlitevec ./templates/sqlitevec.xcframework/ios-arm64/sqlitevec.framework/sqlitevec
cp ./dist/ios/sim_fat/sqlitevec ./templates/sqlitevec.xcframework/ios-arm64_x86_64-simulator/sqlitevec.framework/
install_name_tool -id @rpath/sqlitevec.framework/sqlitevec ./templates/sqlitevec.xcframework/ios-arm64_x86_64-simulator/sqlitevec.framework/sqlitevec

.PHONY: ios ios_arm64 ios_x86_64 ios_arm64_sim

# ███████████████████████████████ END IOS ███████████████████████████████

# ███████████████████████████████ WASM SECTION ███████████████████████████████

WASM_DIR=$(prefix)/.wasm
Expand Down
5 changes: 4 additions & 1 deletion scripts/vendor.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
#!/bin/bash

set -ex

mkdir -p vendor
curl -o sqlite-amalgamation.zip https://www.sqlite.org/2024/sqlite-amalgamation-3450300.zip
unzip -d
# unzip -d
unzip sqlite-amalgamation.zip
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this commands are correct, this floating unzip -d was incorrect and I had to comment it so the amalgamation was correctly downloaded.

mv sqlite-amalgamation-3450300/* vendor/
rmdir sqlite-amalgamation-3450300
Expand Down
44 changes: 44 additions & 0 deletions templates/sqlitevec.xcframework/Info.plist
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>AvailableLibraries</key>
<array>
<dict>
<key>LibraryIdentifier</key>
<string>ios-arm64</string>
<key>LibraryPath</key>
<string>sqlitevec.framework</string>
<key>SupportedArchitectures</key>
<array>
<string>arm64</string>
</array>
<key>SupportedPlatform</key>
<string>ios</string>
</dict>
<dict>
<key>LibraryIdentifier</key>
<string>ios-arm64_x86_64-simulator</string>
<key>LibraryPath</key>
<string>sqlitevec.framework</string>
<key>SupportedArchitectures</key>
<array>
<string>arm64</string>
<string>x86_64</string>
</array>
<key>SupportedPlatform</key>
<string>ios</string>
<key>SupportedPlatformVariant</key>
<string>simulator</string>
</dict>
</array>
<key>CFBundlePackageType</key>
<string>XFWK</string>
<key>XCFrameworkFormatVersion</key>
<string>1.0</string>
<key>CFBundleVersion</key>
<string>1.0.0</string>
<key>CFBundleShortVersionString</key>
<string>1.0.0</string>
</dict>
</plist>
Binary file added templates/sqlitevec.xcframework/ios-arm64/.DS_Store
View file
Open in desktop
Binary file not shown.
Binary file added templates/sqlitevec.xcframework/ios-arm64/sqlitevec.framework/.DS_Store
View file
Open in desktop
Binary file not shown.
24 changes: 24 additions & 0 deletions templates/sqlitevec.xcframework/ios-arm64/sqlitevec.framework/Info.plist
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>en</string>
<key>CFBundleExecutable</key>
<string>sqlitevec</string>
<key>CFBundleIdentifier</key>
<string>com.ospfranco.sqlitevec</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>FMWK</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1.0.0</string>
<key>CFBundleShortVersionString</key>
<string>1.0.0</string>
<key>MinimumOSVersion</key>
<string>8.0</string>
</dict>
</plist>
Binary file added templates/sqlitevec.xcframework/ios-arm64_x86_64-simulator/.DS_Store
View file
Open in desktop
Binary file not shown.
Binary file added templates/sqlitevec.xcframework/ios-arm64_x86_64-simulator/sqlitevec.framework/.DS_Store
View file
Open in desktop
Binary file not shown.
24 changes: 24 additions & 0 deletions templates/sqlitevec.xcframework/ios-arm64_x86_64-simulator/sqlitevec.framework/Info.plist
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>CFBundleDevelopmentRegion</key>
<string>en</string>
<key>CFBundleExecutable</key>
<string>sqlitevec</string>
<key>CFBundleIdentifier</key>
<string>com.ospfranco.sqlitevec</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundlePackageType</key>
<string>FMWK</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1.0.0</string>
<key>CFBundleShortVersionString</key>
<string>1.0.0</string>
<key>MinimumOSVersion</key>
<string>8.0</string>
</dict>
</plist>