Initial commit.

Author: gendx

.dockerignore

@@ -0,0 +1,4 @@
+.git
+LICENSE
+*.md
+docker-*.sh

Dockerfile

@@ -0,0 +1,162 @@
+FROM debian:bullseye-slim
+
+RUN apt-get update \
+    && apt-get install -y \
+        wget \
+        unzip \
+        build-essential \
+        openjdk-11-jdk-headless \
+        libgl1-mesa-dri \
+        libgl1-mesa-glx \
+        libpulse0 \
+        libasound2 \
+        libxcomposite1 \
+        libxcursor1 \
+        libxdamage1 \
+        libxi6 \
+        libxtst6 \
+        --no-install-recommends \
+    && rm -rf /var/lib/apt/lists/*
+
+RUN useradd --uid 1000 --create-home --shell /bin/bash dev
+# For some reason the host adds the USB device to the 46(plugdev) group. Being
+# member of this group is enough to have rw access to the USB device and run
+# adb.
+RUN groupadd --gid 106 --system kvm \
+    && usermod --groups 46,106 dev
+
+USER dev
+WORKDIR "/home/dev"
+
+# Install Gradle manually. The Debian package is too outdated.
+ENV GRADLE_ROOT=/home/dev/opt/gradle
+
+RUN mkdir -p ${GRADLE_ROOT}
+RUN wget https://services.gradle.org/distributions/gradle-7.5.1-bin.zip -O gradle-7.5.1-bin.zip \
+    && sha256sum gradle-7.5.1-bin.zip \
+    && echo "f6b8596b10cce501591e92f229816aa4046424f3b24d771751b06779d58c8ec4  gradle-7.5.1-bin.zip" | sha256sum -c - \
+    && unzip gradle-7.5.1-bin.zip -d ${GRADLE_ROOT} \
+    && rm gradle-7.5.1-bin.zip
+
+ENV PATH=${PATH}:${GRADLE_ROOT}/gradle-7.5.1/bin
+
+# Set the ${ANDROID_HOME} variable, so that the tools can find our installation.
+# See https://developer.android.com/studio/command-line/variables#envar.
+ENV ANDROID_HOME=/home/dev/opt/android-sdk
+
+RUN mkdir -p ${ANDROID_HOME}
+RUN wget https://dl.google.com/android/repository/commandlinetools-linux-8512546_latest.zip \
+        -O ${HOME}/commandlinetools-linux-8512546_latest.zip \
+    && sha256sum commandlinetools-linux-8512546_latest.zip \
+    && echo "2ccbda4302db862a28ada25aa7425d99dce9462046003c1714b059b5c47970d8 commandlinetools-linux-8512546_latest.zip" | sha256sum -c - \
+    && unzip commandlinetools-linux-8512546_latest.zip -d ${ANDROID_HOME}/cmdline-tools \
+    && rm commandlinetools-linux-8512546_latest.zip
+
+ENV PATH=${PATH}:${ANDROID_HOME}/cmdline-tools/cmdline-tools/bin:${ANDROID_HOME}/platform-tools
+
+# Given the following configuration in `build.gradle`:
+#   classpath 'com.android.tools.build:gradle:7.3.0'
+# the build tools version to use is 30.0.3.
+# See https://mvnrepository.com/artifact/com.android.tools.build/gradle/7.3.0.
+RUN yes | sdkmanager --licenses \
+    && sdkmanager --list \
+    && sdkmanager --verbose \
+        "build-tools;30.0.3" \
+        "ndk;25.1.8937393" \
+        "platforms;android-33" \
+        "system-images;android-29;default;x86_64" \
+    && rm -R ${HOME}/.android/
+RUN sdkmanager --list_installed
+
+RUN cd ${HOME}/opt/android-sdk/ndk/25.1.8937393/toolchains/llvm/prebuilt/linux-x86_64/bin/ \
+    && ln -s aarch64-linux-android30-clang aarch64-linux-android-clang \
+    && ln -s armv7a-linux-androideabi30-clang arm-linux-androideabi-clang \
+    && ln -s i686-linux-android30-clang i686-linux-android-clang \
+    && ln -s x86_64-linux-android30-clang x86_64-linux-android-clang
+
+# Replace the Android emulator by a custom one (version 31.3.11 from the
+# archive at https://developer.android.com/studio/emulator_archive). Indeed,
+# from version 31.3.12 on, the disk size is too big and doesn't fit in a
+# reasonably-sized tmpfs.
+#
+# See https://developer.android.com/studio/releases/emulator#31-3-12.
+RUN rm -R ${ANDROID_HOME}/emulator \
+    && wget https://redirector.gvt1.com/edgedl/android/repository/emulator-linux_x64-9058569.zip \
+        -O ${HOME}/emulator-linux_x64-9058569.zip \
+    && sha256sum emulator-linux_x64-9058569.zip \
+    && echo "5b06dae2b8c79b0a39456c3b4d31cf1895571bbf9763cc8ba84c8fdae15673e8 emulator-linux_x64-9058569.zip" | sha256sum -c - \
+    && yes | unzip emulator-linux_x64-9058569.zip -d ${ANDROID_HOME} \
+    && rm emulator-linux_x64-9058569.zip
+
+USER root
+COPY emulator-package.xml /home/dev/opt/android-sdk/emulator/package.xml
+USER dev
+
+# Create an Android virtual device.
+RUN avdmanager create avd \
+    -n test_avd \
+    -d pixel \
+    -k "system-images;android-29;default;x86_64" \
+    && mv ${HOME}/.android ${HOME}/android
+
+# Install Rust toolchain.
+ENV NDK_HOME=${ANDROID_HOME}/ndk/25.1.8937393
+
+RUN wget https://sh.rustup.rs -O rustup.sh \
+    && sha256sum rustup.sh \
+    && echo "173f4881e2de99ba9ad1acb59e65be01b2a44979d83b6ec648d0d22f8654cbce  rustup.sh" | sha256sum -c - \
+    && sh rustup.sh -y \
+    && rm rustup.sh \
+    && rm .profile \
+    && ${HOME}/.cargo/bin/rustup target add \
+        aarch64-linux-android \
+        armv7-linux-androideabi \
+        i686-linux-android \
+        x86_64-linux-android \
+    && ${HOME}/.cargo/bin/rustup toolchain install nightly \
+    && ${HOME}/.cargo/bin/rustup target add --toolchain nightly \
+        aarch64-linux-android \
+        armv7-linux-androideabi \
+        i686-linux-android \
+        x86_64-linux-android
+
+ENV PATH=${PATH}:/home/dev/.cargo/bin
+
+USER root
+
+COPY \
+    strip-rust.sh \
+    script-rust-default.sh \
+    script-rust-default-nostrip.sh \
+    script-rust-nightly.sh \
+    script-rust-nightly-nostrip.sh \
+    script-gradle.sh \
+    script-java.sh \
+    script-java-incorrect-arm64.sh \
+    script-java-incorrect-x86_64.sh \
+    emulator.sh \
+    launch-app-debug.sh \
+    launch-app-release.sh \
+    /home/dev/
+RUN chmod 555 \
+    /home/dev/strip-rust.sh \
+    /home/dev/script-rust-default.sh \
+    /home/dev/script-rust-default-nostrip.sh \
+    /home/dev/script-rust-nightly.sh \
+    /home/dev/script-rust-nightly-nostrip.sh \
+    /home/dev/script-gradle.sh \
+    /home/dev/script-java.sh \
+    /home/dev/script-java-incorrect-arm64.sh \
+    /home/dev/script-java-incorrect-x86_64.sh \
+    /home/dev/emulator.sh \
+    /home/dev/launch-app-debug.sh \
+    /home/dev/launch-app-release.sh
+
+COPY --chown=1000:1000 cargo-config.toml /home/dev/.cargo/config
+
+COPY --chown=1000:1000 src /home/dev/src
+
+USER dev
+
+ENTRYPOINT [ "/bin/bash" ]
+

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022  Guillaume Endignoux
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,40 @@
+# Android Rust example application
+
+This repository is a demonstration of an Android app integrating a native Rust library.
+
+You can find more information in the following blog post: [Compiling Rust libraries for Android apps: a deep dive](https://gendignoux.com/blog/2022/10/24/rust-library-android.html).
+
+## Usage
+
+To build a Docker container containing all the build tools and the demo application, run:
+
+```bash
+$ sudo ./docker-build.sh
+```
+
+You can then launch this Docker container to build the application.
+This comes in various configurations:
+
+- `docker-run-basic.sh`: minimal setup to compile the application within the container.
+- `docker-run-emulator.sh`: besides compiling the application, this setup allows to spawn an Android emulator within the container to test this application.
+- `docker-run-usb.sh`: besides compiling the application, this setup gives the container access to the USB devices, so that you can install the application on a real device via ADB.
+- `docker-run-all.sh`: setup with everything available in the container.
+
+```bash
+$ sudo ./docker-run-basic.sh
+$ ./script-rust.sh && ./script-java.sh
+```
+
+You can build various flavors of the Rust library.
+
+- `script-rust-nightly.sh`: basic script using the nightly Rust toolchain, with stripping of debug symbols enabled.
+- `script-rust-nightly-nostrip.sh`: same, but without stripping debug symbols.
+- `script-rust-default.sh` and `script-rust-default-nostrip.sh`: using the default Rust toolchain (stable).
+
+Then, multiple ways are provided to build the Java part of the Android app.
+
+- `script-java.sh`: normal build of the Android app.
+- `script-java-incorrect-arm64.sh`: Android app built with the ARM-64 library in the wrong folder.
+- `script-java-incorrect-x86_64.sh`: Android app built with the x86_64 library in the wrong folder.
+
+You can then spawn an Android emulator with `emulator.sh`, and use the `launch-app-debug.sh` or `launch-app-release.sh` scripts to install+launch the application via ADB to either the emulator or a real device connected via USB.

cargo-config.toml

@@ -0,0 +1,11 @@
+[target.aarch64-linux-android]
+linker = "/home/dev/opt/android-sdk/ndk/25.1.8937393/toolchains/llvm/prebuilt/linux-x86_64/bin/aarch64-linux-android30-clang"
+
+[target.armv7-linux-androideabi]
+linker = "/home/dev/opt/android-sdk/ndk/25.1.8937393/toolchains/llvm/prebuilt/linux-x86_64/bin/armv7a-linux-androideabi30-clang"
+
+[target.i686-linux-android]
+linker = "/home/dev/opt/android-sdk/ndk/25.1.8937393/toolchains/llvm/prebuilt/linux-x86_64/bin/i686-linux-android30-clang"
+
+[target.x86_64-linux-android]
+linker = "/home/dev/opt/android-sdk/ndk/25.1.8937393/toolchains/llvm/prebuilt/linux-x86_64/bin/x86_64-linux-android30-clang"

docker-build.sh

@@ -0,0 +1,2 @@
+#!/bin/sh
+docker build -t android-rust-simd .

docker-run-all.sh

@@ -0,0 +1,25 @@
+#!/bin/sh
+docker run \
+    --rm \
+    -it \
+    --cap-drop=all \
+    --security-opt no-new-privileges \
+    --read-only \
+    -u dev \
+    --memory=3072m \
+    --memory-swap=3072m \
+    --memory-swappiness=0 \
+    --env USER=dev \
+    --env "DISPLAY=unix${DISPLAY}" \
+    --env XAUTHORITY=/Xauthority \
+    --tmpfs /tmp:size=16m \
+    --tmpfs /home/dev/build:exec,size=512m \
+    --tmpfs /home/dev/.gradle:exec,size=512m \
+    --tmpfs /home/dev/.android:size=3072m \
+    --tmpfs /home/dev/.cargo/registry:size=16m \
+    --volume /tmp/.X11-unix:/tmp/.X11-unix \
+    --volume ${HOME}/.Xauthority:/Xauthority:ro \
+    --device /dev/bus/usb \
+    --device /dev/dri \
+    --device /dev/kvm \
+    android-rust-simd

docker-run-basic.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+docker run \
+    --rm \
+    -it \
+    --cap-drop=all \
+    --security-opt no-new-privileges \
+    --read-only \
+    -u dev \
+    --memory=3072m \
+    --memory-swap=3072m \
+    --memory-swappiness=0 \
+    --env USER=dev \
+    --tmpfs /tmp:size=16m \
+    --tmpfs /home/dev/build:exec,size=512m \
+    --tmpfs /home/dev/.gradle:exec,size=512m \
+    --tmpfs /home/dev/.android:size=1m \
+    --tmpfs /home/dev/.cargo/registry:size=16m \
+    android-rust-simd

docker-run-emulator.sh

@@ -0,0 +1,24 @@
+#!/bin/sh
+docker run \
+    --rm \
+    -it \
+    --cap-drop=all \
+    --security-opt no-new-privileges \
+    --read-only \
+    -u dev \
+    --memory=3072m \
+    --memory-swap=3072m \
+    --memory-swappiness=0 \
+    --env USER=dev \
+    --env "DISPLAY=unix${DISPLAY}" \
+    --env XAUTHORITY=/Xauthority \
+    --tmpfs /tmp:size=16m \
+    --tmpfs /home/dev/build:exec,size=512m \
+    --tmpfs /home/dev/.gradle:exec,size=512m \
+    --tmpfs /home/dev/.android:size=3072m \
+    --tmpfs /home/dev/.cargo/registry:size=16m \
+    --volume /tmp/.X11-unix:/tmp/.X11-unix \
+    --volume ${HOME}/.Xauthority:/Xauthority:ro \
+    --device /dev/dri \
+    --device /dev/kvm \
+    android-rust-simd

docker-run-usb.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+docker run \
+    --rm \
+    -it \
+    --cap-drop=all \
+    --security-opt no-new-privileges \
+    --read-only \
+    -u dev \
+    --memory=3072m \
+    --memory-swap=3072m \
+    --memory-swappiness=0 \
+    --env USER=dev \
+    --tmpfs /tmp:size=16m \
+    --tmpfs /home/dev/build:exec,size=512m \
+    --tmpfs /home/dev/.gradle:exec,size=512m \
+    --tmpfs /home/dev/.android:size=1m \
+    --tmpfs /home/dev/.cargo/registry:size=16m \
+    --device /dev/bus/usb \
+    android-rust-simd