Android build improvements (#2725)

kirklandsign · facebook-github-bot · commit eb8eca807ba9 · 2024-03-28T10:18:06.000-07:00
Summary: Pull Request resolved: #2725 Reviewed By: shoumikhin Differential Revision: D55464604 Pulled By: kirklandsign fbshipit-source-id: 460fe36372bf7ef23f4a7c4ebec849ecf7ee2f16
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -428,11 +428,6 @@ if(EXECUTORCH_BUILD_VULKAN)
   add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/backends/vulkan)
 endif()
 
-if(EXECUTORCH_BUILD_ANDROID_JNI)
-  add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/examples/models/llama2/runner)
-  add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/extension/android)
-endif()
-
 if(EXECUTORCH_BUILD_QNN)
   add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/backends/qualcomm)
 endif()
diff --git a/examples/demo-apps/android/ExecuTorchDemo/README.md b/examples/demo-apps/android/ExecuTorchDemo/README.md
@@ -64,36 +64,46 @@ We build the required ExecuTorch runtime library to run the model.
 
 #### XNNPACK
 
-1. Configure the CMake target for the library with XNNPACK backend:
+1. Build the CMake target for the library with XNNPACK backend:
 
 ```bash
 export ANDROID_NDK=<path-to-android-ndk>
 export BUCK2=/tmp/buck2 # Or your buck path
 
 rm -rf cmake-out && mkdir cmake-out && cd cmake-out
+
+# Build the core executorch library
 cmake .. -DCMAKE_INSTALL_PREFIX=cmake-out \
-        -DCMAKE_TOOLCHAIN_FILE=$ANDROID_NDK/build/cmake/android.toolchain.cmake \
-        -DANDROID_ABI=arm64-v8a \
-        -DBUCK2=$BUCK \
-        -DEXECUTORCH_BUILD_XNNPACK=ON \
-        -DEXECUTORCH_BUILD_FLATC=OFF \
-        -DEXECUTORCH_BUILD_EXTENSION_DATA_LOADER=ON \
-        -DFLATC_EXECUTABLE=$FLATC_EXECUTABLE \
-        -DEXECUTORCH_BUILD_ANDROID_JNI=ON \
-        -DEXECUTORCH_BUILD_EXTENSION_MODULE=ON \
-        -DEXECUTORCH_BUILD_EXTENSION_DATA_LOADER=ON
+  -DCMAKE_TOOLCHAIN_FILE="${ANDROID_NDK}/build/cmake/android.toolchain.cmake" \
+  -DANDROID_ABI="${ANDROID_ABI}" \
+  -DBUCK2="${BUCK2}" \
+  -DEXECUTORCH_BUILD_XNNPACK=ON \
+  -DEXECUTORCH_BUILD_FLATC=OFF \
+  -DEXECUTORCH_BUILD_EXTENSION_DATA_LOADER=ON \
+  -DFLATC_EXECUTABLE="${FLATC}" \
+  -DEXECUTORCH_BUILD_EXTENSION_MODULE=ON
+
+cmake --build . -j16 --target install
 ```
 
 When we set `EXECUTORCH_BUILD_XNNPACK=ON`, we will build the target [`xnnpack_backend`](https://github.com/pytorch/executorch/blob/main/backends/xnnpack/CMakeLists.txt) which in turn is linked into libexecutorch_jni via [CMake](https://github.com/pytorch/executorch/blob/main/examples/demo-apps/android/jni/CMakeLists.txt).
 
-`libexecutorch_jni.so` wraps up the required XNNPACK Backend runtime library from `xnnpack_backend`, and adds an additional JNI layer using fbjni. This is later exposed to Java app.
-
-2. Build the libraries:
+2. Build the Android extension:
 
 ```bash
-cmake --build . -j16
+
+# Build the android extension
+cmake ../extension/android -DBUCK2="${BUCK2}" \
+  -DCMAKE_TOOLCHAIN_FILE=${ANDROID_NDK}/build/cmake/android.toolchain.cmake \
+  -DANDROID_ABI="${ANDROID_ABI}" \
+  -DCMAKE_INSTALL_PREFIX=cmake-out \
+  -Bextension/android
+
+cmake --build ./extension/android -j16
 ```
 
+`libexecutorch_jni.so` wraps up the required XNNPACK Backend runtime library from `xnnpack_backend`, and adds an additional JNI layer using fbjni. This is later exposed to Java app.
+
 #### Qualcomm Hexagon NPU
 
 1. Configure the CMake target for the library with Qualcomm Hexagon NPU (HTP) backend (XNNPACK also included):
diff --git a/examples/demo-apps/android/ExecuTorchDemo/setup.sh b/examples/demo-apps/android/ExecuTorchDemo/setup.sh
@@ -8,26 +8,32 @@
 
 set -eu
 
-pushd cmake-out
-# Note: Set up ANDROID_NDK, ANDROID_ABI, BUCK2, and FLATC_EXECUTABLE
-cmake .. -DCMAKE_INSTALL_PREFIX=cmake-out \
+# Note: Set up ANDROID_NDK, ANDROID_ABI, BUCK2, and FLATC
+cmake . -DCMAKE_INSTALL_PREFIX=cmake-out \
   -DCMAKE_TOOLCHAIN_FILE="${ANDROID_NDK}/build/cmake/android.toolchain.cmake" \
   -DANDROID_ABI="${ANDROID_ABI}" \
   -DBUCK2="${BUCK2}" \
   -DEXECUTORCH_BUILD_XNNPACK=ON \
   -DEXECUTORCH_BUILD_FLATC=OFF \
   -DEXECUTORCH_BUILD_EXTENSION_DATA_LOADER=ON \
   -DFLATC_EXECUTABLE="${FLATC}" \
-  -DEXECUTORCH_BUILD_ANDROID_JNI=ON \
-  -DEXECUTORCH_BUILD_EXTENSION_MODULE=ON
+  -DEXECUTORCH_BUILD_EXTENSION_MODULE=ON \
+  -Bcmake-out
 
 if [ "$(uname)" == "Darwin" ]; then
   CMAKE_JOBS=$(( $(sysctl -n hw.ncpu) - 1 ))
 else
   CMAKE_JOBS=$(( $(nproc) - 1 ))
 fi
-cmake --build . -j "${CMAKE_JOBS}"
-popd
+cmake --build cmake-out -j "${CMAKE_JOBS}" --target install
+
+cmake extension/android -DBUCK2="${BUCK2}" \
+  -DCMAKE_TOOLCHAIN_FILE=${ANDROID_NDK}/build/cmake/android.toolchain.cmake \
+  -DANDROID_ABI="${ANDROID_ABI}" \
+  -DCMAKE_INSTALL_PREFIX=cmake-out \
+  -Bcmake-out/extension/android
+
+cmake --build cmake-out/extension/android -j "${CMAKE_JOBS}"
 
 JNI_LIBS_PATH="examples/demo-apps/android/ExecuTorchDemo/app/src/main/jniLibs"
 mkdir -p "${JNI_LIBS_PATH}/${ANDROID_ABI}"
diff --git a/examples/demo-apps/android/LlamaDemo/README.md b/examples/demo-apps/android/LlamaDemo/README.md
@@ -33,24 +33,39 @@ pushd cmake-out
 ```
 4. Run the following command to configure the CMake build:
 ```
-cmake .. -DBUCK2="$BUCK" \
+cmake .. -DCMAKE_INSTALL_PREFIX=cmake-out \
+  -DCMAKE_TOOLCHAIN_FILE="${ANDROID_NDK}/build/cmake/android.toolchain.cmake" \
+  -DANDROID_ABI="${ANDROID_ABI}" \
+  -DBUCK2="${BUCK2}" \
+  -DEXECUTORCH_BUILD_XNNPACK=ON \
+  -DEXECUTORCH_BUILD_FLATC=OFF \
+  -DEXECUTORCH_BUILD_EXTENSION_DATA_LOADER=ON \
+  -DFLATC_EXECUTABLE="${FLATC}" \
+  -DEXECUTORCH_BUILD_EXTENSION_MODULE=ON
+
+cmake --build . -j16 --target install
+
+cmake ../examples/models/llama2 -DBUCK2="$BUCK" \
          -DCMAKE_TOOLCHAIN_FILE=$ANDROID_NDK/build/cmake/android.toolchain.cmake \
          -DANDROID_ABI="$ANDROID_ABI" \
          -DCMAKE_INSTALL_PREFIX=cmake-out \
-         -DEXECUTORCH_BUILD_EXTENSION_MODULE=ON \
-         -DEXECUTORCH_BUILD_FLATC=OFF \
-         -DFLATC_EXECUTABLE="${FLATC}" \
-         -DEXECUTORCH_BUILD_EXTENSION_DATA_LOADER=ON \
-         -DPYTHON_EXECUTABLE="$PYTHON_EXECUTABLE" \
-         -DEXECUTORCH_BUILD_ANDROID_JNI=ON \
-         -DEXECUTORCH_BUILD_XNNPACK=ON
-```
-5. Run the following command to build the JNI library:
-```
-cmake --build . -j50
+         -Bexamples/models/llama2
+
+cmake --build examples/models/llama2 -j16
+
+cmake ../extension/android -DBUCK2="${BUCK2}" \
+  -DCMAKE_TOOLCHAIN_FILE=${ANDROID_NDK}/build/cmake/android.toolchain.cmake \
+  -DANDROID_ABI="${ANDROID_ABI}" \
+  -DCMAKE_INSTALL_PREFIX=cmake-out \
+  -DEXECUTORCH_BUILD_LLAMA_JNI=ON \
+  -Bextension/android
+
+cmake --build extension/android -j16
+
 popd
 ```
-6. Copy the built library to your app:
+
+5. Copy the built library to your app:
 ```
 JNI_LIBS_PATH="examples/demo-apps/android/LlamaDemo/app/src/main/jniLibs"
 mkdir -p "${JNI_LIBS_PATH}/${ANDROID_ABI}"
diff --git a/examples/demo-apps/android/LlamaDemo/setup.sh b/examples/demo-apps/android/LlamaDemo/setup.sh
@@ -7,31 +7,46 @@
 
 set -eu
 
-pushd cmake-out
-# Note: Set up ANDROID_NDK, ANDROID_ABI, BUCK2, and FLATC_EXECUTABLE
-cmake .. -DBUCK2="$BUCK" \
-         -DCMAKE_TOOLCHAIN_FILE=$ANDROID_NDK/build/cmake/android.toolchain.cmake \
-         -DANDROID_ABI="$ANDROID_ABI" \
-         -DCMAKE_INSTALL_PREFIX=cmake-out \
-         -DEXECUTORCH_BUILD_EXTENSION_MODULE=ON \
-         -DEXECUTORCH_BUILD_FLATC=OFF \
-         -DFLATC_EXECUTABLE="${FLATC}" \
-         -DEXECUTORCH_BUILD_EXTENSION_DATA_LOADER=ON \
-         -DPYTHON_EXECUTABLE="$PYTHON_EXECUTABLE" \
-         -DEXECUTORCH_BUILD_ANDROID_JNI=ON \
-         -DEXECUTORCH_BUILD_XNNPACK=ON
+CMAKE_OUT=cmake-out
+# Note: Set up ANDROID_NDK, ANDROID_ABI, BUCK2, and FLATC
+cmake . -DCMAKE_INSTALL_PREFIX="${CMAKE_OUT}" \
+  -DCMAKE_TOOLCHAIN_FILE="${ANDROID_NDK}/build/cmake/android.toolchain.cmake" \
+  -DANDROID_ABI="${ANDROID_ABI}" \
+  -DBUCK2="${BUCK2}" \
+  -DEXECUTORCH_BUILD_XNNPACK=ON \
+  -DEXECUTORCH_BUILD_FLATC=OFF \
+  -DEXECUTORCH_BUILD_EXTENSION_DATA_LOADER=ON \
+  -DFLATC_EXECUTABLE="${FLATC}" \
+  -DEXECUTORCH_BUILD_EXTENSION_MODULE=ON \
+  -B"${CMAKE_OUT}"
 
 if [ "$(uname)" == "Darwin" ]; then
   CMAKE_JOBS=$(( $(sysctl -n hw.ncpu) - 1 ))
 else
   CMAKE_JOBS=$(( $(nproc) - 1 ))
 fi
-cmake --build . -j "${CMAKE_JOBS}"
-popd
+cmake --build "${CMAKE_OUT}" -j "${CMAKE_JOBS}" --target install
+
+cmake examples/models/llama2 -DBUCK2="$BUCK" \
+         -DCMAKE_TOOLCHAIN_FILE=$ANDROID_NDK/build/cmake/android.toolchain.cmake \
+         -DANDROID_ABI="$ANDROID_ABI" \
+         -DCMAKE_INSTALL_PREFIX="${CMAKE_OUT}" \
+         -B"${CMAKE_OUT}"/examples/models/llama2
+
+cmake --build "${CMAKE_OUT}"/examples/models/llama2 -j "${CMAKE_JOBS}"
+
+cmake extension/android -DBUCK2="${BUCK2}" \
+  -DCMAKE_TOOLCHAIN_FILE=${ANDROID_NDK}/build/cmake/android.toolchain.cmake \
+  -DANDROID_ABI="${ANDROID_ABI}" \
+  -DCMAKE_INSTALL_PREFIX="${CMAKE_OUT}" \
+  -DEXECUTORCH_BUILD_LLAMA_JNI=ON \
+  -B"${CMAKE_OUT}"/extension/android
+
+cmake --build "${CMAKE_OUT}"/extension/android -j "${CMAKE_JOBS}"
 
 JNI_LIBS_PATH="examples/demo-apps/android/LlamaDemo/app/src/main/jniLibs"
 mkdir -p "${JNI_LIBS_PATH}/${ANDROID_ABI}"
-cp cmake-out/extension/android/libexecutorch_llama_jni.so "${JNI_LIBS_PATH}/${ANDROID_ABI}/"
+cp "${CMAKE_OUT}"/extension/android/libexecutorch_llama_jni.so "${JNI_LIBS_PATH}/${ANDROID_ABI}/"
 
 pushd extension/android
 ./gradlew build
diff --git a/extension/android/CMakeLists.txt b/extension/android/CMakeLists.txt
@@ -8,37 +8,65 @@ cmake_minimum_required(VERSION 3.19)
 
 project(executorch_jni)
 
+if(NOT ANDROID)
+  message(FATAL_ERROR "This directory is for Android build only")
+endif()
+
 set(EXECUTORCH_ROOT "${CMAKE_CURRENT_SOURCE_DIR}/../..")
 include(${EXECUTORCH_ROOT}/build/Utils.cmake)
-
+set(_common_compile_options -Wno-deprecated-declarations -fPIC)
 set(_common_include_directories ${EXECUTORCH_ROOT}/..)
 
 add_subdirectory(${EXECUTORCH_ROOT}/examples/third-party/fbjni
                  ${CMAKE_CURRENT_BINARY_DIR}/third-party/fbjni)
 
-if(CMAKE_TOOLCHAIN_ANDROID)
-  add_library(executorch_jni SHARED jni/jni_layer.cpp)
-  target_link_libraries(executorch_jni extension_data_loader extension_module
-                        portable_ops_lib fbjni)
-  if(EXECUTORCH_BUILD_QNN)
-    target_link_libraries(executorch_jni qnn_executorch_backend)
-  endif()
-  if(EXECUTORCH_BUILD_XNNPACK)
-    target_link_libraries(executorch_jni xnnpack_backend)
-  endif()
-  if(EXECUTORCH_BUILD_VULKAN)
-    target_link_libraries(executorch_jni vulkan_executor_runner_lib)
-  endif()
-  target_compile_options(executorch_jni PUBLIC ${_common_compile_options})
+set(executorch_DIR ${CMAKE_CURRENT_BINARY_DIR}/../../lib/cmake/ExecuTorch)
+find_package(executorch CONFIG REQUIRED)
+target_link_options_shared_lib(executorch)
+target_link_options_shared_lib(portable_ops_lib)
 
-  add_library(executorch_llama_jni SHARED jni/jni_layer_llama.cpp)
-  target_link_libraries(executorch_llama_jni fbjni llama_runner portable_ops_lib)
-  if(EXECUTORCH_BUILD_XNNPACK)
-    target_link_libraries(executorch_llama_jni xnnpack_backend)
-  endif()
-  if(EXECUTORCH_BUILD_VULKAN)
-    target_link_libraries(executorch_llama_jni vulkan_executor_runner_lib)
-  endif()
+set(link_libraries)
+list(APPEND link_libraries extension_data_loader extension_module executorch
+            portable_ops_lib portable_kernels fbjni)
+
+if(TARGET optimized_native_cpu_ops_lib)
+  list(APPEND link_libraries optimized_native_cpu_ops_lib optimized_kernels
+              cpublas eigen_blas)
+  target_link_options_shared_lib(optimized_native_cpu_ops_lib)
+endif()
+if(TARGET qnn_executorch_backend)
+  list(APPEND link_libraries qnn_executorch_backend)
+endif()
+if(TARGET xnnpack_backend)
+  target_link_options_shared_lib(xnnpack_backend)
+  list(APPEND link_libraries xnnpack_backend XNNPACK pthreadpool cpuinfo)
+endif()
+if(TARGET vulkan_executor_runner_lib)
+  list(APPEND link_libraries vulkan_executor_runner_lib)
+endif()
+
+add_library(executorch_jni SHARED jni/jni_layer.cpp)
+target_link_libraries(executorch_jni ${link_libraries})
+target_include_directories(executorch_jni PRIVATE ${_common_include_directories})
+target_compile_options(executorch_jni PUBLIC ${_common_compile_options})
+
+if(EXECUTORCH_BUILD_LLAMA_JNI)
+  set(LLAMA_RUNNER_PATH ${CMAKE_CURRENT_BINARY_DIR}/../../examples/models/llama2/runner/libllama_runner.a)
+  add_library(llama_runner STATIC IMPORTED)
+  set_property(TARGET llama_runner PROPERTY IMPORTED_LOCATION ${LLAMA_RUNNER_PATH})
 
+  set(CUSTOM_OPS_LIB_PATH ${CMAKE_CURRENT_BINARY_DIR}/../../examples/models/llama2/custom_ops/libcustom_ops_lib.a)
+  add_library(custom_ops_lib STATIC IMPORTED)
+  set_property(TARGET custom_ops_lib PROPERTY IMPORTED_LOCATION ${CUSTOM_OPS_LIB_PATH})
+
+  set(CUSTOM_OPS_PATH ${CMAKE_CURRENT_BINARY_DIR}/../../examples/models/llama2/custom_ops/libcustom_ops.a)
+  add_library(custom_ops STATIC IMPORTED)
+  set_property(TARGET custom_ops PROPERTY IMPORTED_LOCATION ${CUSTOM_OPS_PATH})
+  target_link_options_shared_lib(custom_ops_lib)
+
+  add_library(executorch_llama_jni SHARED jni/jni_layer_llama.cpp)
+  target_include_directories(executorch_llama_jni PRIVATE ${_common_include_directories})
+  target_link_libraries(executorch_llama_jni ${link_libraries} llama_runner
+                        custom_ops custom_ops_lib cpublas eigen_blas)
   target_compile_options(executorch_llama_jni PUBLIC ${_common_compile_options})
 endif()
