Add a way to build the app with a stage 1 Rust compiler.

Author: gendx

.github/workflows/docker-build.yml

@@ -5,9 +5,15 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+      - name: Get some system information
+        run: |
+          id;
+          df;
+          free;
+          nproc
       - name: Docker build
         run: ./docker-build.sh
-      - name: Build Android application
+      - name: Build Android application (nightly Rust)
         run: |
           docker run \
             --rm \
@@ -24,5 +30,30 @@ jobs:
             --tmpfs /home/dev/.gradle:exec,size=512m \
             --tmpfs /home/dev/.android:size=1m \
             --tmpfs /home/dev/.cargo/registry:size=16m \
+            --tmpfs /home/dev/.rustup/toolchains:exec,size=1m \
             --entrypoint /home/dev/build-application.sh \
             android-rust-simd
+      - name: Build Android application (stage 1 Rust)
+        run: |
+          mkdir -p rustc-build;
+          chmod 777 rustc-build;
+          PWD=`pwd`;
+          docker run \
+            --rm \
+            --cap-drop=all \
+            --security-opt no-new-privileges \
+            --read-only \
+            -u dev \
+            --memory=5g \
+            --memory-swap=5g \
+            --memory-swappiness=0 \
+            --env USER=dev \
+            --tmpfs /tmp:size=256m \
+            --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=512m \
+            --tmpfs /home/dev/.rustup/toolchains:exec,size=1m \
+            --volume ${PWD}/rustc-build:/home/dev/rustc-build \
+            --entrypoint /home/dev/build-application-stage1.sh \
+            android-rust-simd

.github/workflows/format.yml

@@ -10,5 +10,7 @@ jobs:
       - uses: dtolnay/rust-toolchain@nightly
         with:
           components: rustfmt
-      - name: Check Rust formatting
+      - name: Check Rust formatting (android-simd)
         run: cargo fmt --verbose --manifest-path src/android-simd/Cargo.toml -- --check
+      - name: Check Rust formatting (flamedisk)
+        run: cargo fmt --verbose --manifest-path tools/flamedisk/Cargo.toml -- --check

Dockerfile

@@ -5,6 +5,10 @@ RUN apt-get update \
         wget \
         unzip \
         build-essential \
+        python3 \
+        curl \
+        cmake \
+        git \
         openjdk-11-jdk-headless \
         libgl1-mesa-dri \
         libgl1-mesa-glx \
@@ -32,7 +36,7 @@ WORKDIR "/home/dev"
 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 \
+RUN wget -nv 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} \
@@ -45,7 +49,7 @@ ENV PATH=${PATH}:${GRADLE_ROOT}/gradle-7.5.1/bin
 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 \
+RUN wget -nv 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 - \
@@ -81,7 +85,7 @@ RUN cd ${HOME}/opt/android-sdk/ndk/25.1.8937393/toolchains/llvm/prebuilt/linux-x
 #
 # 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 \
+    && wget -nv 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 - \
@@ -102,7 +106,7 @@ RUN avdmanager create avd \
 # Install Rust toolchain.
 ENV NDK_HOME=${ANDROID_HOME}/ndk/25.1.8937393
 
-RUN wget https://sh.rustup.rs -O rustup.sh \
+RUN wget -nv https://sh.rustup.rs -O rustup.sh \
     && sha256sum rustup.sh \
     && echo "173f4881e2de99ba9ad1acb59e65be01b2a44979d83b6ec648d0d22f8654cbce  rustup.sh" | sha256sum -c - \
     && sh rustup.sh -y \
@@ -118,45 +122,68 @@ RUN wget https://sh.rustup.rs -O rustup.sh \
         aarch64-linux-android \
         armv7-linux-androideabi \
         i686-linux-android \
-        x86_64-linux-android
+        x86_64-linux-android \
+    && mkdir -p ${HOME}/rustup \
+    && mv ${HOME}/.rustup/toolchains ${HOME}/rustup/toolchains
 
 ENV PATH=${PATH}:/home/dev/.cargo/bin
 
 USER root
 
 COPY \
     scripts/build-application.sh \
+    scripts/build-application-stage1.sh \
+    scripts/setup.sh \
+    scripts/clone-rustlang-head.sh \
+    scripts/clone-rustlang-1.67.0-1286ee23e.sh \
+    scripts/stage0.sh \
+    scripts/stage1.sh \
     scripts/strip-rust.sh \
     scripts/script-rust-default.sh \
     scripts/script-rust-default-nostrip.sh \
     scripts/script-rust-nightly.sh \
     scripts/script-rust-nightly-nostrip.sh \
+    scripts/script-rust-stage1.sh \
+    scripts/script-rust-stage1-nostrip.sh \
     scripts/script-gradle.sh \
     scripts/script-java.sh \
     scripts/script-java-incorrect-arm64.sh \
     scripts/script-java-incorrect-x86_64.sh \
     scripts/emulator.sh \
     scripts/launch-app-debug.sh \
     scripts/launch-app-release.sh \
+    scripts/flamedisk.sh \
     /home/dev/
 RUN chmod 555 \
     /home/dev/build-application.sh \
+    /home/dev/build-application-stage1.sh \
+    /home/dev/setup.sh \
+    /home/dev/clone-rustlang-head.sh \
+    /home/dev/clone-rustlang-1.67.0-1286ee23e.sh \
+    /home/dev/stage0.sh \
+    /home/dev/stage1.sh \
     /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-rust-stage1.sh \
+    /home/dev/script-rust-stage1-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
+    /home/dev/launch-app-release.sh \
+    /home/dev/flamedisk.sh
 
 COPY --chown=1000:1000 cargo-config.toml /home/dev/.cargo/config
+COPY --chown=1000:1000 rustbuild-config.toml /home/dev/
+COPY --chown=1000:1000 stdarch.patch /home/dev/
 
 COPY --chown=1000:1000 src /home/dev/src
+COPY --chown=1000:1000 tools /home/dev/tools
 
 USER dev
 

README.md

@@ -1,8 +1,12 @@
-# Android Rust example application
+# Android Rust example application with SIMD instructions
 
 This repository is a demonstration of an Android app integrating a native Rust library.
+Additionally, this Rust library demonstrates detecting support for SIMD instructions.
 
-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).
+You can find more information in the following blog posts:
+
+- [Compiling Rust libraries for Android apps: a deep dive](https://gendignoux.com/blog/2022/10/24/rust-library-android.html),
+- [Detecting SIMD support on ARM with Android (and patching the Rust compiler for it)](https://gendignoux.com/blog/2022/11/09/rust-simd-detect-arm-android.md).
 
 ## Usage
 
@@ -29,6 +33,7 @@ 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-stage1.sh` and `script-rust-stage1-nostrip.sh`: using a locally built `stage1` Rust compiler (see below).
 - `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.
@@ -38,3 +43,25 @@ Then, multiple ways are provided to build the Java part of the Android app.
 - `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.
+
+## Building and using a patched Rust compiler
+
+This repository also shows how to patch and build the Rust compiler.
+You can launch the Docker container in various scenarios:
+
+- `docker-run-rustc-1cpu.sh`: with 1 CPU, 2 GB of RAM,
+- `docker-run-rustc-2cpu.sh`: with 2 CPUs, 2 GB of RAM,
+- `docker-run-rustc-4cpu.sh`: with 4 CPUs, 3 GB of RAM,
+- `docker-run-rustc-8cpu.sh`: with 8 CPUs, 5 GB of RAM,
+- `docker-run-all-rustc.sh`: to compile `rustc` + build the app.
+
+Once launched, you can clone and compile `rustc` for Android with:
+
+- `scripts/clone-rustlang-head.sh`: clone the latest commit on the Rust repository,
+- `scripts/stage0.sh`: build a stage 0 compiler,
+- `scripts/stage1.sh`: build a stage 1 compiler.
+
+You'll also find the following tool to generate a flame graph of the disk space used by a build of `rustc`:
+
+- `tools/flamedisk`: small Rust tool to generate an input suitable for `flamegraph.pl`,
+- `scripts/flamedisk.sh`: driver script to generate the flame graph.

docker-run-all-rustc.sh

@@ -0,0 +1,31 @@
+#!/bin/sh
+
+mkdir -p rustc-build
+chown 1000:1000 rustc-build
+PWD=`pwd`
+
+docker run \
+    --rm \
+    -it \
+    --cap-drop=all \
+    --security-opt no-new-privileges \
+    --read-only \
+    -u dev \
+    --cpus 8 \
+    --memory=5g \
+    --memory-swap=5g \
+    --memory-swappiness=0 \
+    --env USER=dev \
+    --env "DISPLAY=unix${DISPLAY}" \
+    --tmpfs /tmp:size=256m \
+    --tmpfs /home/dev/build:exec,size=512m \
+    --tmpfs /home/dev/.gradle:exec,size=512m \
+    --tmpfs /home/dev/.android:size=3g \
+    --tmpfs /home/dev/.cargo/registry:size=512m \
+    --tmpfs /home/dev/.rustup/toolchains:exec,size=1m \
+    --volume /tmp/.X11-unix:/tmp/.X11-unix \
+    --volume ${PWD}/rustc-build:/home/dev/rustc-build \
+    --device /dev/bus/usb \
+    --device /dev/dri \
+    --device /dev/kvm \
+    android-rust-simd

docker-run-all.sh

@@ -16,6 +16,7 @@ docker run \
     --tmpfs /home/dev/.gradle:exec,size=512m \
     --tmpfs /home/dev/.android:size=3g \
     --tmpfs /home/dev/.cargo/registry:size=16m \
+    --tmpfs /home/dev/.rustup/toolchains:exec,size=1m \
     --volume /tmp/.X11-unix:/tmp/.X11-unix \
     --device /dev/bus/usb \
     --device /dev/dri \

docker-run-basic.sh

@@ -15,4 +15,5 @@ docker run \
     --tmpfs /home/dev/.gradle:exec,size=512m \
     --tmpfs /home/dev/.android:size=1m \
     --tmpfs /home/dev/.cargo/registry:size=16m \
+    --tmpfs /home/dev/.rustup/toolchains:exec,size=1m \
     android-rust-simd

docker-run-emulator.sh

@@ -16,6 +16,7 @@ docker run \
     --tmpfs /home/dev/.gradle:exec,size=512m \
     --tmpfs /home/dev/.android:size=3g \
     --tmpfs /home/dev/.cargo/registry:size=16m \
+    --tmpfs /home/dev/.rustup/toolchains:exec,size=1m \
     --volume /tmp/.X11-unix:/tmp/.X11-unix \
     --device /dev/dri \
     --device /dev/kvm \

docker-run-rustc-1cpu.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+mkdir -p rustc-build
+chown 1000:1000 rustc-build
+PWD=`pwd`
+
+docker run \
+    --rm \
+    -it \
+    --cap-drop=all \
+    --security-opt no-new-privileges \
+    --read-only \
+    -u dev \
+    --cpus 1 \
+    --memory=2g \
+    --memory-swap=2g \
+    --memory-swappiness=0 \
+    --env USER=dev \
+    --tmpfs /tmp:size=256m \
+    --tmpfs /home/dev/.cargo/registry:size=512m \
+    --tmpfs /home/dev/.rustup/toolchains:exec,size=1m \
+    --volume $PWD/rustc-build:/home/dev/rustc-build \
+    android-rust-simd

docker-run-rustc-2cpus.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+mkdir -p rustc-build
+chown 1000:1000 rustc-build
+PWD=`pwd`
+
+docker run \
+    --rm \
+    -it \
+    --cap-drop=all \
+    --security-opt no-new-privileges \
+    --read-only \
+    -u dev \
+    --cpus 2 \
+    --memory=2g \
+    --memory-swap=2g \
+    --memory-swappiness=0 \
+    --env USER=dev \
+    --tmpfs /tmp:size=256m \
+    --tmpfs /home/dev/.cargo/registry:size=512m \
+    --tmpfs /home/dev/.rustup/toolchains:exec,size=1m \
+    --volume ${PWD}/rustc-build:/home/dev/rustc-build \
+    android-rust-simd

docker-run-rustc-4cpus.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+mkdir -p rustc-build
+chown 1000:1000 rustc-build
+PWD=`pwd`
+
+docker run \
+    --rm \
+    -it \
+    --cap-drop=all \
+    --security-opt no-new-privileges \
+    --read-only \
+    -u dev \
+    --cpus 4 \
+    --memory=3g \
+    --memory-swap=3g \
+    --memory-swappiness=0 \
+    --env USER=dev \
+    --tmpfs /tmp:size=256m \
+    --tmpfs /home/dev/.cargo/registry:size=512m \
+    --tmpfs /home/dev/.rustup/toolchains:exec,size=1m \
+    --volume ${PWD}/rustc-build:/home/dev/rustc-build \
+    android-rust-simd

docker-run-rustc-8cpus.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+mkdir -p rustc-build
+chown 1000:1000 rustc-build
+PWD=`pwd`
+
+docker run \
+    --rm \
+    -it \
+    --cap-drop=all \
+    --security-opt no-new-privileges \
+    --read-only \
+    -u dev \
+    --cpus 8 \
+    --memory=5g \
+    --memory-swap=5g \
+    --memory-swappiness=0 \
+    --env USER=dev \
+    --tmpfs /tmp:size=256m \
+    --tmpfs /home/dev/.cargo/registry:size=512m \
+    --tmpfs /home/dev/.rustup/toolchains:exec,size=1m \
+    --volume ${PWD}/rustc-build:/home/dev/rustc-build \
+    android-rust-simd

docker-run-usb.sh

@@ -15,5 +15,6 @@ docker run \
     --tmpfs /home/dev/.gradle:exec,size=512m \
     --tmpfs /home/dev/.android:size=1m \
     --tmpfs /home/dev/.cargo/registry:size=16m \
+    --tmpfs /home/dev/.rustup/toolchains:exec,size=1m \
     --device /dev/bus/usb \
     android-rust-simd

rustbuild-config.toml

@@ -0,0 +1,15 @@
+# Includes one of the default files in src/bootstrap/defaults
+profile = "library"
+changelog-seen = 2
+
+[target.aarch64-linux-android]
+android-ndk = "/home/dev/opt/android-sdk/ndk/25.1.8937393/toolchains/llvm/prebuilt/linux-x86_64"
+
+[target.armv7-linux-androideabi]
+android-ndk = "/home/dev/opt/android-sdk/ndk/25.1.8937393/toolchains/llvm/prebuilt/linux-x86_64"
+
+[target.i686-linux-android]
+android-ndk = "/home/dev/opt/android-sdk/ndk/25.1.8937393/toolchains/llvm/prebuilt/linux-x86_64"
+
+[target.x86_64-linux-android]
+android-ndk = "/home/dev/opt/android-sdk/ndk/25.1.8937393/toolchains/llvm/prebuilt/linux-x86_64"