forked from apache/tvm
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[APP] Android RPC README (apache#395)
- Loading branch information
Showing
2 changed files
with
113 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,112 @@ | ||
# Android TVM RPC | ||
|
||
This folder contains Android RPC app that allows us to launch an rpc server on a Android device and connect to it through python script and do testing on the python side as normal TVM RPC. | ||
|
||
You will need JDK, [Android NDK](https://developer.android.com/ndk) and an Android device to use this. | ||
|
||
## Build and Installation | ||
|
||
### <a name="buildapk">Build APK</a> | ||
|
||
Before you build the Android application, please refer to [TVM4J Installation Guide](https://github.com/dmlc/tvm/blob/master/jvm/README.md) and install tvm4j-core to your local maven repository. You can find tvm4j dependency declare in `app/build.gradle`. Modify it if it is necessary. | ||
|
||
```json | ||
dependencies { | ||
compile fileTree(dir: 'libs', include: ['*.jar']) | ||
androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', { | ||
exclude group: 'com.android.support', module: 'support-annotations' | ||
}) | ||
compile 'com.android.support:appcompat-v7:26.0.1' | ||
compile 'com.android.support.constraint:constraint-layout:1.0.2' | ||
compile 'com.android.support:design:26.0.1' | ||
compile 'ml.dmlc.tvm:tvm4j-core:0.0.1-SNAPSHOT' | ||
testCompile 'junit:junit:4.12' | ||
} | ||
``` | ||
|
||
The Gradle build script is provided in the app root folder. It downloads the proper version of Gradle, compiles JNI, resolves Java dependencies and builds the Android application together with tvm4j. Run following script to build apk file. | ||
|
||
```bash | ||
export ANDROID_HOME=[Path to your Android SDK, e.g., ~/Android/sdk] | ||
cd apps/android_rpc | ||
./gradlew clean build | ||
``` | ||
|
||
In `app/build/outputs/apk` you'll find `app-release-unsigned.apk`, use `dev_tools/gen_keystore.sh` to generate a signature and use `dev_tools/sign_apk.sh` to get the signed apk file `app/build/outputs/apk/tvmrpc-release.apk`. | ||
|
||
Now upload `tvmrpc-release.apk` to your Android device and install it. | ||
|
||
### Build with OpenCL | ||
|
||
This application does not link any OpenCL library unless you configure it to. In `app/src/main/jni/make` you will find JNI Makefile config `config.mk`. Copy it to `app/src/main/jni` and modify it. | ||
|
||
```bash | ||
cd apps/android_rpc/app/src/main/jni | ||
cp make/config.mk . | ||
``` | ||
|
||
Here's a piece of example for `config.mk`. | ||
|
||
```makefile | ||
APP_ABI = arm64-v8a | ||
|
||
APP_PLATFORM = android-17 | ||
|
||
# whether enable OpenCL during compile | ||
USE_OPENCL = 1 | ||
|
||
# the additional include headers you want to add, e.g., SDK_PATH/adrenosdk/Development/Inc | ||
ADD_C_INCLUDES = /opt/adrenosdk-osx/Development/Inc | ||
|
||
# the additional link libs you want to add, e.g., ANDROID_LIB_PATH/libOpenCL.so | ||
ADD_LDLIBS = libOpenCL.so | ||
``` | ||
|
||
Note that you should specify the correct GPU development headers for your android device. Run `adb shell dumpsys | grep GLES` to find out what GPU your android device uses. It is very likely the library (libOpenCL.so) is already present on the mobile device. For instance, I found it under `/system/vendor/lib64`. You can do `adb pull /system/vendor/lib64/libOpenCL.so ./` to get the file to your desktop. | ||
|
||
After you setup the `config.mk`, follow the instructions in [Build APK](#buildapk) to build the Android package. | ||
|
||
## Cross Compile and Run on Android Devices | ||
|
||
### Architecture and Android Standalone Toolchain | ||
|
||
In order to cross compile a shared library (.so) for your android device, you have to know the target triple for the device. (Refer to [Cross-compilation using Clang](https://clang.llvm.org/docs/CrossCompilation.html) for more information). Run `adb shell cat /proc/cpuinfo` to list the device's CPU information. | ||
|
||
Now use NDK to generate standalone toolchain for your device. For my test device, I use following command. | ||
|
||
```bash | ||
cd /opt/android-ndk/build/tools/ | ||
./make-standalone-toolchain.sh --platform=android-24 --use-llvm --arch=arm64 --install-dir=/opt/android-toolchain-arm64 | ||
``` | ||
|
||
If everything goes well, you will find compile tools in `/opt/android-toolchain-arm64/bin`. For example, `bin/aarch64-linux-android-g++` can be used to compile C++ source codes and create shared libraries for arm64 Android devices. | ||
|
||
### Cross Compile and Upload to the Android Device | ||
|
||
First start a proxy server using `python -m tvm.exec.rpc_proxy` and make your Android device connect to this proxy server via TVM RPC application. | ||
|
||
Then checkout [android\_rpc/tests/android\_rpc\_test.py](https://github.com/dmlc/tvm/blob/master/apps/android_rpc/tests/android_rpc_test.py) and run, | ||
|
||
```bash | ||
# Specify the proxy host | ||
export TVM_ANDROID_RPC_PROXY_HOST=0.0.0.0 | ||
# Specify the standalone Android C++ compiler | ||
export TVM_NDK_CC=/opt/android-toolchain-arm64/bin/aarch64-linux-android-g++ | ||
python android_rpc_test.py | ||
``` | ||
|
||
This will compile TVM IR to shared libraries (CPU and OpenCL) and run vector additon on your Android device. On my test device, it gives following results. | ||
|
||
```bash | ||
TVM: Initializing cython mode... | ||
[01:21:43] src/codegen/llvm/codegen_llvm.cc:75: set native vector to be 32 for target aarch64 | ||
[01:21:43] src/runtime/opencl/opencl_device_api.cc:194: Initialize OpenCL platform 'Apple' | ||
[01:21:43] src/runtime/opencl/opencl_device_api.cc:214: opencl(0)='Iris' cl_device_id=0x1024500 | ||
[01:21:44] src/codegen/llvm/codegen_llvm.cc:75: set native vector to be 32 for target aarch64 | ||
Run GPU test ... | ||
0.000155807 secs/op | ||
Run CPU test ... | ||
0.00139824 secs/op | ||
``` | ||
|
||
You can define your own TVM operators and test via this RPC app on your Android device to find the most optimized TVM schedule. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters