arm64-android対応 (#17)

* feat: Android対応

* bind, test用のスクリプトを追加

* Update onnxruntime-sys/build.rs

Co-authored-by: Ryo Yamashita <[email protected]>

* Update .github/workflows/general.yml

Co-authored-by: Hiroshiba <[email protected]>

* Update onnxruntime-sys/build.rs

Co-authored-by: Hiroshiba <[email protected]>

* Update onnxruntime-sys/build.rs

Co-authored-by: Hiroshiba <[email protected]>

* androidのリリースURLを切り出し

* NDK用のGithub Actionsを使うように

* fix typo

* ndkのパスを修正

* androidのas_onnx_str を指定

---------

Co-authored-by: Ryo Yamashita <[email protected]>
Co-authored-by: Hiroshiba <[email protected]>

Author: 3 people

.github/actions/auto_gen_bind_pr/action.yaml

@@ -20,6 +20,16 @@ runs:
       run: |
         sudo apt update
         sudo apt install gcc-aarch64-linux-gnu g++-aarch64-linux-gnu
+    - uses: nttld/setup-ndk@v1
+      if: inputs.triple == 'aarch64-linux-android'
+      with:
+        ndk-version: r25b
+    - name: Set path for android
+      if: inputs.triple == 'aarch64-linux-android'
+      shell: bash
+      run: |
+        echo "$ANDROID_NDK/toolchains/llvm/prebuilt/linux-x86_64/bin" >> "$GITHUB_PATH"
+        echo "AR_aarch64_linux_android=llvm-ar" >> "$GITHUB_ENV"
     - uses: actions-rs/toolchain@v1
       with:
         toolchain: stable

.github/workflows/gen_bind.yaml

@@ -15,6 +15,8 @@ jobs:
             triple: x86_64-unknown-linux-gnu
           - os: ubuntu-latest
             triple: aarch64-unknown-linux-gnu
+          - os: ubuntu-latest
+            triple: aarch64-linux-android
           - os: windows-latest
             triple: x86_64-pc-windows-msvc
           - os: windows-latest

.github/workflows/general.yml

@@ -38,6 +38,7 @@ jobs:
       - run: rustup target install x86_64-apple-darwin
       - run: rustup target install i686-pc-windows-msvc
       - run: rustup target install x86_64-pc-windows-msvc
+      - run: rustup target install aarch64-linux-android
       # ******************************************************************
       - name: Download prebuilt archive (CPU, x86_64-unknown-linux-gnu)
         uses: actions-rs/cargo@v1
@@ -47,6 +48,14 @@ jobs:
       - name: Verify prebuilt archive downloaded (CPU, x86_64-unknown-linux-gnu)
         run: ls -lh target/x86_64-unknown-linux-gnu/debug/build/onnxruntime-sys-*/out/onnxruntime-linux-x64-1.*.tgz
       # ******************************************************************
+      - name: Download prebuilt archive (CPU, aarch64-linux-android)
+        uses: actions-rs/cargo@v1
+        with:
+          command: build
+          args: --target aarch64-linux-android
+      - name: Verify prebuilt archive downloaded (CPU, aarch64-linux-android)
+        run: ls -lh target/aarch64-linux-android/debug/build/onnxruntime-sys-*/out/onnxruntime*.aar
+      # ******************************************************************
       - name: Download prebuilt archive (CPU, x86_64-apple-darwin)
         uses: actions-rs/cargo@v1
         with:

onnxruntime-sys/build.rs

@@ -18,6 +18,10 @@ const ORT_VERSION: &str = "1.13.1";
 /// Base Url from which to download pre-built releases/
 const ORT_RELEASE_BASE_URL: &str = "https://github.com/microsoft/onnxruntime/releases/download";
 
+/// Base Url from which to download pre-built releases for android/
+const ORT_MAVEN_RELEASE_BASE_URL: &str =
+    "https://repo1.maven.org/maven2/com/microsoft/onnxruntime/onnxruntime-android";
+
 /// Environment variable selecting which strategy to use for finding the library
 /// Possibilities:
 /// * "download": Download a pre-built library from upstream. This is the default if `ORT_STRATEGY` is not set.
@@ -63,11 +67,21 @@ fn main() {
 fn main() {
     let libort_install_dir = prepare_libort_dir();
 
+    // FIXME: directmlとandroidで処理の表現が違うので統一する
     #[cfg(not(feature = "directml"))]
-    let (include_dir, lib_dir) = (
-        libort_install_dir.join("include"),
-        libort_install_dir.join("lib"),
-    );
+    let (include_dir, lib_dir) = match TRIPLET.os {
+        Os::Android => {
+            let include_dir = libort_install_dir.join("headers");
+            let runtimes_dir = libort_install_dir
+                .join("jni")
+                .join(&*TRIPLET.arch.as_onnx_android_str());
+            (include_dir, runtimes_dir)
+        }
+        _ => (
+            libort_install_dir.join("include"),
+            libort_install_dir.join("lib"),
+        ),
+    };
 
     #[cfg(feature = "directml")]
     let (include_dir, lib_dir) = {
@@ -265,6 +279,7 @@ fn extract_archive(filename: &Path, output: &Path) {
     match filename.extension().map(|e| e.to_str()) {
         Some(Some("zip")) => extract_zip(filename, output),
         Some(Some("tgz")) => extract_tgz(filename, output),
+        Some(Some("aar")) => extract_zip(filename, output),
         _ => unimplemented!(),
     }
 }
@@ -349,6 +364,15 @@ impl Architecture {
             Architecture::Arm64 => Cow::from("arm64"),
         }
     }
+
+    fn as_onnx_android_str(&self) -> Cow<str> {
+        match self {
+            Architecture::X86 => Cow::from("x86"),
+            Architecture::X86_64 => Cow::from("x86_64"),
+            Architecture::Arm => Cow::from("armeabi-v7a"),
+            Architecture::Arm64 => Cow::from("arm64-v8a"),
+        }
+    }
 }
 
 #[derive(Debug)]
@@ -357,6 +381,7 @@ enum Os {
     Windows,
     Linux,
     MacOs,
+    Android,
 }
 
 impl Os {
@@ -365,6 +390,7 @@ impl Os {
             Os::Windows => "zip",
             Os::Linux => "tgz",
             Os::MacOs => "tgz",
+            Os::Android => "aar",
         }
     }
 }
@@ -377,6 +403,7 @@ impl FromStr for Os {
             "windows" => Ok(Os::Windows),
             "macos" => Ok(Os::MacOs),
             "linux" => Ok(Os::Linux),
+            "android" => Ok(Os::Android),
             _ => Err(format!("Unsupported os: {}", s)),
         }
     }
@@ -388,6 +415,7 @@ impl OnnxPrebuiltArchive for Os {
             Os::Windows => Cow::from("win"),
             Os::Linux => Cow::from("linux"),
             Os::MacOs => Cow::from("osx"),
+            Os::Android => Cow::from("android"),
         }
     }
 }
@@ -436,6 +464,7 @@ impl OnnxPrebuiltArchive for Triplet {
             }
             (Os::Windows, Architecture::X86, Accelerator::None)
             | (Os::MacOs, Architecture::X86_64, Accelerator::None)
+            | (Os::Android, Architecture::Arm64, Accelerator::None)
             | (Os::Linux, Architecture::Arm64, Accelerator::None) => Cow::from(format!(
                 "{}-{}",
                 self.os.as_onnx_str(),
@@ -484,11 +513,19 @@ fn prebuilt_archive_url() -> (PathBuf, String) {
         ORT_VERSION,
         TRIPLET.os.archive_extension()
     );
-    let prebuilt_url = format!(
-        "{}/v{}/{}",
-        ORT_RELEASE_BASE_URL, ORT_VERSION, prebuilt_archive
-    );
-
+    let prebuilt_url = match TRIPLET.os {
+        Os::Android => format!(
+            "{}/{}/onnxruntime-android-{}.{}",
+            ORT_MAVEN_RELEASE_BASE_URL,
+            ORT_VERSION,
+            ORT_VERSION,
+            TRIPLET.os.archive_extension()
+        ),
+        _ => format!(
+            "{}/v{}/{}",
+            ORT_RELEASE_BASE_URL, ORT_VERSION, prebuilt_archive
+        ),
+    };
     (PathBuf::from(prebuilt_archive), prebuilt_url)
 }
 
@@ -534,7 +571,10 @@ fn prepare_libort_dir_prebuilt() -> PathBuf {
     // directmlの場合はzipの子ディレクトリがzipファイル名のディレクトリではないため、
     // この処理は非directmlの場合のみ行う
     #[cfg(not(feature = "directml"))]
-    let extract_dir = extract_dir.join(prebuilt_archive.file_stem().unwrap());
+    let extract_dir = match TRIPLET.os {
+        Os::Android => extract_dir,
+        _ => extract_dir.join(prebuilt_archive.file_stem().unwrap()),
+    };
 
     extract_dir
 }