Skip to content

Commit 94f8547

Browse files
msluszniakmsluszniak
committed
[RNE Rewrite] feat: on-demand native lib download and backend splitting
Port PR #1039's on-demand native-lib mechanism into the rewrite. Apps opt in via a `react-native-executorch` block (`backends`/`libs`/`features`) in their package.json; the postinstall `scripts/download-libs.js` expands `features` via the full forward-looking FEATURE_MAP, writes `rne-build-config.json`, and downloads only the requested per-backend artifacts from GitHub Releases into third-party/. The podspec and android/build.gradle.kts read that config to gate `RNE_ENABLE_*` and link backends as separate libs (Xnnpack/CoreML/MLX xcframeworks, lib*_executorch_backend.so) — MLX device-slice only. Adapted to the rewrite: cpp/ layout (opencv gated as an extensible source list, guarded in RnExecutorch.cpp), Kotlin-DSL gradle config read, single android/CMakeLists.txt. scripts + FEATURE_MAP + artifact contract kept identical to #1039 so future rewrite work is code-only. CI (TS-only) skips the download via RNET_SKIP_DOWNLOAD in the setup action. Verified: config expansion, download/extract/checksum (local server), and CI gates (lint, bob build, typecheck). Release artifacts (executorch fork build) + committed headers/jar/ExecutorchLib wrapper are provisioned separately.
1 parent 862b77d commit 94f8547

14 files changed

Lines changed: 1044 additions & 71 deletions

File tree

‎.cspell-wordlist.txt‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
multimodal
22
swmansion
33
executorch
4+
RNET
5+
libexecutorch
6+
libxnnpack
7+
libvulkan
8+
xcframework
9+
metallib
10+
ASPP
11+
pthreadpool
12+
cpuinfo
413
execu
514
Execu
615
torch

‎.github/actions/setup/action.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,8 @@ runs:
2525
if: steps.yarn-cache.outputs.cache-hit != 'true'
2626
run: yarn install --immutable
2727
shell: bash
28+
# CI is TypeScript-only and has no GitHub Release to fetch native libs
29+
# from; skip the postinstall native-lib download (it still writes
30+
# rne-build-config.json so the native build config exists).
31+
env:
32+
RNET_SKIP_DOWNLOAD: '1'

‎apps/computer-vision/package.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22
"name": "computer-vision",
33
"version": "1.0.0",
44
"main": "expo-router/entry",
5+
"react-native-executorch": {
6+
"features": [
7+
"classification",
8+
"semanticSegmentation",
9+
"styleTransfer"
10+
]
11+
},
512
"scripts": {
613
"start": "expo start",
714
"android": "expo run:android",

‎apps/nlp/package.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22
"name": "nlp",
33
"version": "1.0.0",
44
"main": "expo-router/entry",
5+
"react-native-executorch": {
6+
"features": [
7+
"tokenizer"
8+
]
9+
},
510
"scripts": {
611
"start": "expo start",
712
"android": "expo run:android",

‎packages/react-native-executorch/.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Generated by scripts/download-libs.js at postinstall (records which backends/libs
2+
# are enabled; consumed by the podspec and android/build.gradle.kts).
3+
rne-build-config.json
4+
5+
# Generated by scripts/package-release-artifacts.sh
6+
dist-artifacts/

‎packages/react-native-executorch/android/CMakeLists.txt‎

Lines changed: 97 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,126 @@
1-
cmake_minimum_required(VERSION 3.10)
1+
cmake_minimum_required(VERSION 3.13)
22
project(RnExecutorch)
33

44
set(CMAKE_VERBOSE_MAKEFILE ON)
55
set(CMAKE_CXX_STANDARD 20)
66

7-
set(EXEC_LIB_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../third-party/android/jniLibs/${ANDROID_ABI}/libexecutorch.so")
8-
set(OPENCV_LIB_PATH "${CMAKE_CURRENT_SOURCE_DIR}/../third-party/android/jniLibs/${ANDROID_ABI}/libopencv_java4.so")
7+
set(THIRD_PARTY_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../third-party")
8+
set(LIBS_DIR "${THIRD_PARTY_DIR}/android/libs")
9+
set(INCLUDE_DIR "${THIRD_PARTY_DIR}/include")
10+
set(CPP_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../cpp")
911

10-
add_library(executorch SHARED IMPORTED)
11-
set_target_properties(executorch PROPERTIES IMPORTED_LOCATION ${EXEC_LIB_PATH})
12-
13-
add_library(opencv SHARED IMPORTED)
14-
set_target_properties(opencv PROPERTIES IMPORTED_LOCATION ${OPENCV_LIB_PATH})
12+
# Feature flags forwarded from build.gradle.kts (which reads rne-build-config.json
13+
# written by scripts/download-libs.js). Default ON so a manual/full provisioning
14+
# still builds everything.
15+
option(RNE_ENABLE_OPENCV "Compile + link OpenCV-dependent sources" ON)
16+
option(RNE_ENABLE_PHONEMIS "Compile phonemis (TTS) sources" ON)
17+
option(RNE_ENABLE_XNNPACK "Link the XNNPACK backend shared library" ON)
18+
option(RNE_ENABLE_VULKAN "Link the Vulkan backend shared library" ON)
1519

1620
find_package(ReactAndroid REQUIRED CONFIG)
1721

18-
file(GLOB CORE_SOURCES ../cpp/core/*.cpp)
19-
file(GLOB MATH_SOURCES ../cpp/extensions/math/*.cpp)
20-
file(GLOB CV_SOURCES ../cpp/extensions/cv/*.cpp)
21-
file(GLOB NLP_SOURCES ../cpp/extensions/nlp/*.cpp)
22+
# --- Source groups ---
23+
# core/math/nlp are backend-agnostic and always compiled. OPENCV_SOURCES is the
24+
# explicit, extensible list of opencv-dependent sources: when multimodal LLM
25+
# lands in nlp, its vision-encoder sources should be appended here too.
26+
file(GLOB CORE_SOURCES ${CPP_DIR}/core/*.cpp)
27+
file(GLOB MATH_SOURCES ${CPP_DIR}/extensions/math/*.cpp)
28+
file(GLOB NLP_SOURCES ${CPP_DIR}/extensions/nlp/*.cpp)
29+
file(GLOB OPENCV_SOURCES ${CPP_DIR}/extensions/cv/*.cpp)
2230

23-
add_library(${CMAKE_PROJECT_NAME} SHARED
24-
../cpp/RnExecutorch.cpp
31+
set(RNE_SOURCES
32+
${CPP_DIR}/RnExecutorch.cpp
2533
${CORE_SOURCES}
26-
${CV_SOURCES}
2734
${MATH_SOURCES}
2835
${NLP_SOURCES}
2936
cpp-adapter.cpp
3037
)
3138

39+
if(RNE_ENABLE_OPENCV)
40+
list(APPEND RNE_SOURCES ${OPENCV_SOURCES})
41+
endif()
42+
43+
add_library(${CMAKE_PROJECT_NAME} SHARED ${RNE_SOURCES})
44+
3245
target_compile_definitions(${CMAKE_PROJECT_NAME} PRIVATE
3346
C10_USING_CUSTOM_GENERATED_MACROS=1
3447
EXECUTORCH_ENABLE_EXECUTION_PROFILING=1
3548
)
3649

50+
# Propagate feature flags as preprocessor defines so C++ can guard includes/calls.
51+
if(RNE_ENABLE_OPENCV)
52+
target_compile_definitions(${CMAKE_PROJECT_NAME} PRIVATE RNE_ENABLE_OPENCV)
53+
endif()
54+
if(RNE_ENABLE_PHONEMIS)
55+
target_compile_definitions(${CMAKE_PROJECT_NAME} PRIVATE RNE_ENABLE_PHONEMIS)
56+
endif()
57+
3758
target_include_directories(${CMAKE_PROJECT_NAME} PRIVATE
38-
../cpp
39-
${CMAKE_CURRENT_SOURCE_DIR}/../third-party/include
40-
${CMAKE_CURRENT_SOURCE_DIR}/../third-party/include/executorch/extension/llm/tokenizers/include
41-
${CMAKE_CURRENT_SOURCE_DIR}/../third-party/include/executorch/extension/llm/tokenizers/third-party/json/include
42-
${CMAKE_CURRENT_SOURCE_DIR}/../third-party/include/executorch/extension/llm/tokenizers/third-party/re2
43-
${CMAKE_CURRENT_SOURCE_DIR}/../third-party/include/executorch/extension/llm/tokenizers/third-party/abseil-cpp
59+
${CPP_DIR}
60+
${INCLUDE_DIR}
61+
${INCLUDE_DIR}/executorch/extension/llm/tokenizers/include
62+
${INCLUDE_DIR}/executorch/extension/llm/tokenizers/third-party/json/include
63+
${INCLUDE_DIR}/executorch/extension/llm/tokenizers/third-party/re2
64+
${INCLUDE_DIR}/executorch/extension/llm/tokenizers/third-party/abseil-cpp
4465
)
4566

46-
# Ensure executorch is linked with WHOLE_ARCHIVE so all static initializers are included
47-
target_link_options(${CMAKE_PROJECT_NAME} PRIVATE -Wl,--whole-archive)
48-
target_link_libraries(${CMAKE_PROJECT_NAME} executorch)
49-
target_link_options(${CMAKE_PROJECT_NAME} PRIVATE -Wl,--no-whole-archive)
67+
# ------- ExecuTorch core (always required) -------
68+
add_library(executorch SHARED IMPORTED)
69+
set_target_properties(executorch PROPERTIES
70+
IMPORTED_LOCATION "${LIBS_DIR}/executorch/${ANDROID_ABI}/libexecutorch.so")
71+
72+
# ------- XNNPACK backend (optional) -------
73+
# Backends ship as separate .so files. When enabled, CMake imports the .so and
74+
# links libreact-native-executorch.so against it; Gradle packages the .so into
75+
# the APK (via jniLibs srcDir) and the dynamic linker loads it whenever
76+
# libreact-native-executorch.so loads. Each backend .so's load-time constructor
77+
# registers itself with libexecutorch.so's backend registry.
78+
if(RNE_ENABLE_XNNPACK)
79+
add_library(xnnpack_executorch_backend SHARED IMPORTED)
80+
set_target_properties(xnnpack_executorch_backend PROPERTIES
81+
IMPORTED_LOCATION "${LIBS_DIR}/executorch/${ANDROID_ABI}/libxnnpack_executorch_backend.so")
82+
endif()
83+
84+
# ------- Vulkan backend (optional) -------
85+
if(RNE_ENABLE_VULKAN)
86+
add_library(vulkan_executorch_backend SHARED IMPORTED)
87+
set_target_properties(vulkan_executorch_backend PROPERTIES
88+
IMPORTED_LOCATION "${LIBS_DIR}/executorch/${ANDROID_ABI}/libvulkan_executorch_backend.so")
89+
endif()
90+
91+
# ------- OpenCV (optional, static) -------
92+
set(OPENCV_LINK_LIBS "")
93+
if(RNE_ENABLE_OPENCV)
94+
set(OPENCV_LINK_LIBS
95+
"${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_core.a"
96+
"${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_features2d.a"
97+
"${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_highgui.a"
98+
"${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_imgproc.a"
99+
"${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_photo.a"
100+
"${LIBS_DIR}/opencv/${ANDROID_ABI}/libopencv_video.a"
101+
)
102+
if(ANDROID_ABI STREQUAL "arm64-v8a")
103+
list(APPEND OPENCV_LINK_LIBS
104+
"${LIBS_DIR}/opencv-third-party/${ANDROID_ABI}/libkleidicv_hal.a"
105+
"${LIBS_DIR}/opencv-third-party/${ANDROID_ABI}/libkleidicv_thread.a"
106+
"${LIBS_DIR}/opencv-third-party/${ANDROID_ABI}/libkleidicv.a"
107+
)
108+
endif()
109+
endif()
50110

51111
target_link_libraries(${CMAKE_PROJECT_NAME}
52112
ReactAndroid::jsi
53113
log
54-
opencv
114+
${OPENCV_LINK_LIBS}
115+
executorch
116+
z
55117
)
118+
119+
# Linking against the backend .so (when enabled) makes Gradle bundle them and
120+
# instructs the dynamic linker to load them with libreact-native-executorch.so.
121+
if(RNE_ENABLE_XNNPACK)
122+
target_link_libraries(${CMAKE_PROJECT_NAME} xnnpack_executorch_backend)
123+
endif()
124+
if(RNE_ENABLE_VULKAN)
125+
target_link_libraries(${CMAKE_PROJECT_NAME} vulkan_executorch_backend)
126+
endif()

‎packages/react-native-executorch/android/build.gradle.kts‎

Lines changed: 49 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1+
import groovy.json.JsonSlurper
2+
13
plugins {
24
id("com.android.library")
35
id("org.jetbrains.kotlin.android")
46
id("com.facebook.react")
57
}
68

79
/**
8-
* Helper function to get variables from the root project (App level)
10+
* Helper function to get variables from the root project (App level)
911
* or fall back to local project properties.
1012
*/
1113
fun getExtOrDefault(name: String, default: Any): Any {
@@ -18,6 +20,31 @@ fun getExtOrDefault(name: String, default: Any): Any {
1820
}
1921
}
2022

23+
/**
24+
* Reads the build config written by the postinstall script
25+
* (scripts/download-libs.js). Falls back to enabling everything if the file is
26+
* missing (e.g. native libs provisioned manually, or CI with pre-cached libs).
27+
*/
28+
fun rneBuildConfig(): Map<*, *> {
29+
val defaults = mapOf(
30+
"enableOpencv" to true,
31+
"enablePhonemis" to true,
32+
"enableXnnpack" to true,
33+
"enableVulkan" to true
34+
)
35+
val configFile = file("../rne-build-config.json")
36+
if (!configFile.exists()) return defaults
37+
return try {
38+
JsonSlurper().parse(configFile) as Map<*, *>
39+
} catch (e: Exception) {
40+
logger.warn("[RnExecutorch] Failed to parse rne-build-config.json: ${e.message}. Defaulting to all features enabled.")
41+
defaults
42+
}
43+
}
44+
45+
val rneConfig = rneBuildConfig()
46+
fun rneFlag(key: String): String = if (rneConfig[key] != false) "ON" else "OFF"
47+
2148
android {
2249
namespace = "com.swmansion.rnexecutorch"
2350
compileSdk = (getExtOrDefault("compileSdkVersion", 34) as Number).toInt()
@@ -29,11 +56,18 @@ android {
2956
externalNativeBuild {
3057
cmake {
3158
cppFlags("-fexceptions", "-frtti", "-std=c++20", "-Wall")
32-
arguments("-DANDROID_STL=c++_shared", "-DANDROID_SUPPORT_FLEXIBLE_PAGE_SIZES=ON")
33-
34-
// CRITICAL: Only include ABIs you actually have binaries for
35-
// Since you only have arm64-v8a in third-party, we pin it here.
36-
abiFilters.add("arm64-v8a")
59+
arguments(
60+
"-DANDROID_STL=c++_shared",
61+
"-DANDROID_SUPPORT_FLEXIBLE_PAGE_SIZES=ON",
62+
"-DRNE_ENABLE_OPENCV=${rneFlag("enableOpencv")}",
63+
"-DRNE_ENABLE_PHONEMIS=${rneFlag("enablePhonemis")}",
64+
"-DRNE_ENABLE_XNNPACK=${rneFlag("enableXnnpack")}",
65+
"-DRNE_ENABLE_VULKAN=${rneFlag("enableVulkan")}"
66+
)
67+
68+
// ExecuTorch only supports these ABIs; on-demand artifacts ship
69+
// both. The dynamic linker loads whichever the device needs.
70+
abiFilters.addAll(listOf("arm64-v8a", "x86_64"))
3771
}
3872
}
3973
}
@@ -46,8 +80,11 @@ android {
4680

4781
sourceSets {
4882
getByName("main") {
49-
// Pointing to your centralized third-party binaries
50-
jniLibs.srcDirs("../third-party/android/jniLibs")
83+
// Prebuilt executorch + backend .so live under
84+
// third-party/android/libs/executorch/<abi>/. Pointing jniLibs here
85+
// makes Gradle package them (libexecutorch.so + the enabled
86+
// lib*_executorch_backend.so) into the APK alongside our own .so.
87+
jniLibs.srcDirs("../third-party/android/libs/executorch")
5188
// Include generated codegen if using TurboModules
5289
java.srcDirs("${project.buildDir}/generated/source/codegen/java")
5390
}
@@ -82,8 +119,9 @@ dependencies {
82119
// React Native Android Engine
83120
implementation("com.facebook.react:react-android")
84121

85-
// The ExecuTorch Java/Kotlin wrapper from your third-party folder
86-
implementation(files("../third-party/android/libs/executorch.jar"))
122+
// The ExecuTorch Java/Kotlin wrapper (ABI-independent, committed in the
123+
// android module since it is not part of the per-ABI download artifacts).
124+
implementation(files("libs/executorch.jar"))
87125

88126
// Recommended for modern Kotlin Android development
89127
implementation("androidx.core:core-ktx:1.12.0")
@@ -94,4 +132,4 @@ extensions.configure<com.facebook.react.ReactExtension>("react") {
94132
jsRootDir = file("../src/")
95133
libraryName = "RnExecutorch"
96134
codegenJavaPackageName = "com.swmansion.rnexecutorch"
97-
}
135+
}

‎packages/react-native-executorch/cpp/RnExecutorch.cpp‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
11
#include "RnExecutorch.h"
22

33
#include "core/install.h"
4-
#include "extensions/cv/install.h"
54
#include "extensions/math/install.h"
65
#include "extensions/nlp/install.h"
76

7+
// The cv extension links against OpenCV. When opencv is opted out
8+
// (RNE_ENABLE_OPENCV unset by the build config), its sources are excluded from
9+
// compilation, so guard the include + install call too.
10+
#ifdef RNE_ENABLE_OPENCV
11+
#include "extensions/cv/install.h"
12+
#endif
13+
814
using namespace facebook;
915

1016
namespace rnexecutorch {
1117
void install(jsi::Runtime &jsiRuntime) {
1218
jsi::Object module = jsi::Object(jsiRuntime);
1319

1420
rnexecutorch::core::install(jsiRuntime, module);
21+
#ifdef RNE_ENABLE_OPENCV
1522
rnexecutorch::extensions::cv::install(jsiRuntime, module);
23+
#endif
1624
rnexecutorch::extensions::math::install(jsiRuntime, module);
1725
rnexecutorch::extensions::nlp::install(jsiRuntime, module);
1826

‎packages/react-native-executorch/package.json‎

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,19 @@
2020
"android",
2121
"ios",
2222
"cpp",
23-
"third-party",
23+
"scripts",
2424
"*.podspec",
25+
"third-party/include",
26+
"third-party",
27+
"!third-party/android/jniLibs",
28+
"!third-party/android/libs",
29+
"!third-party/ios/Frameworks",
30+
"!third-party/ios/ExecutorchLib",
31+
"!third-party/ios/ExecutorchLib.xcframework",
32+
"!third-party/ios/XnnpackBackend.xcframework",
33+
"!third-party/ios/CoreMLBackend.xcframework",
34+
"!third-party/ios/MLXBackend.xcframework",
35+
"!third-party/ios/libs",
2536
"!android/build",
2637
"!ios/build",
2738
"!**/__tests__",
@@ -36,7 +47,7 @@
3647
"lint": "eslint \"**/*.{js,ts,tsx}\"",
3748
"prepack": "cp ../../README.md ./README.md",
3849
"postpack": "rm ./README.md",
39-
"postinstall": "yarn run -T patch-package --patch-dir ../../patches"
50+
"postinstall": "node scripts/download-libs.js && yarn run -T patch-package --patch-dir ../../patches"
4051
},
4152
"keywords": [
4253
"text-to-speech",

0 commit comments

Comments
 (0)