Add support for Android versions 5-11. #1023

Alexhuszagh · 2022-09-15T16:51:50Z

Configuration

We provide the following arguments to configure the Android version:

ANDROID_NDK
ANDROID_SDK (note that this is dependent on `ANDROID_VERSION)
ANDROID_VERSION
ANDROID_SYSTEM_COMPLETE: do a complete Android build
ANDROID_SYSTEM_NONE: do not build the Android system, disables runner support

Version Support

We now support NDK versions r10e-r25b, SDK versions 21-33, and Android versions 5.0, 5.1, 6.0, 7.0, 8.0, 8.1, 9.0, 10.0, and 11.0. We also validate that the NDK, SDK, and Android versions are compatible.

For Android 12+, we do support using the NDK with the proper API level, allowing cross-compilation for the desired target, however, running or testing the generated binary is currently not supported without a complete build. Note that support for non-complete builds with Android versions 12+ is unlikely to ever occur, due to issues with APEX in the build system.

Implementation Details

Next, we've improved the removal of unittests during the build process, to ensure fast builds while maintaining compatibility with various newer Android versions. To do this, we've implemented a Python library and a script. The Python library contains a complete parser (correctly parses all valid input) for Soong blueprint files, using an LALR grammar, and a rudimentary parser for Makefiles.

The Soong parser removes any gtest dependencies, as well as any subdirectories or scope names containing test. For example:

cc_library {
    name: "lib",
    srcs: ["lib.cc",],
}
cc_test {
    name: "test",
    defaults: ["target"],
    srcs: ["test.cc"],
}

Will become:

cc_library {
    name: "lib",
    srcs: ["lib.cc",],
}

The Makefile parser first splits the file based on conditional directives (ifeq, endif, etc.) to ensure any subsequent processing doesn't lead to unbalanced directives. Next, we split the text within each directive based on comment sections used in the Android source tree. For example:

test_tags := tests

include $(call subdir,$(LOCAL_PATH))

c_flags := \
  -g \
  -Wall

We can therefore remove the Benchmarks and Unit tests sections without removing the Other section.

The Python library is reasonably performant (it adds no noticeable overhead to the build process) and is compact (in total, < 60KB). Also, it is much more resilient than a series of sed scripts.

Finally, extensive unittests have been added for the Python library, for both code linting (flake8) and unittests (via tox). Since we cannot assume the presence of Python on the host machine, the tests can be optionally enabled via the --python flag (or PYTHON environment variable, to hook into the git hooks), and custom overrides for the flake8 and tox commands are provided (since the user may wish to specify a specific Python version, such as python3.7 -m flake8).

Linker

For Android 10+, since we use a minimal Android build, we only support the bootstrap and ASAN linkers unless using a complete Android build. Supporting the APEX linker requires a nearly complete Android runtime, requiring 60+GB image sizes, slow builds, and other prohibitive factors.

Complete Builds

Complete builds are currently untested, for Androids version 12+ they exceed the default storage capacity of WSL2 images (250GB). They should work and properly install both the /system and /apex directories, however, the builds are slow and untested.

Alexhuszagh · 2022-09-15T16:53:39Z

docker/Dockerfile.aarch64-linux-android

docker/android-system.sh

Alexhuszagh · 2022-09-23T16:03:00Z

I've restored using Python for the Android NDK install steps, since it's a bit more resilient than making all the symlinks outself manually. We could probably speed it up slightly making manual symlinks, but considering the major bottleneck is the Android build itself, and this adds no size to the resulting image, I don't see any reason to remove it. I've added python3 since newer Android NDK versions use it by default and it also has effectively no change in the build times or performance.

Alexhuszagh · 2022-09-23T16:03:08Z

bors try --target aarch64-linux-android

bors · 2022-09-23T16:42:07Z

try

Build succeeded:

conclusion

Alexhuszagh · 2022-10-28T03:14:20Z

There might be other things I'm missing: I've tried to run through this numerous times, but at 4k lines of code, there may be something I've overlooked. I've re-run the tests for the entire suite of Android versions on aarch64-linux-android on the latest version of the build scripts, so it should work for the tested versions for all targets, but there could be subtle logic errors.

bors · 2022-10-28T04:04:19Z

try

Build succeeded:

conclusion

Emilgardis · 2022-10-28T06:46:17Z

since these scripts are very android specific and most of it would not be used in CI, would it make sense to move this to cross-toolchain?

Alexhuszagh · 2022-10-28T13:13:47Z

since these scripts are very android specific and most of it would not be used in CI, would it make sense to move this to cross-toolchain?

Sure, that could work. We can then also cherry pick pieces if we say, want to upgrade to Android 11.

Alexhuszagh · 2022-10-28T14:03:45Z

If we do migrate this to cross-toolchains, it would be nice if we could have some basic CI to test the additions, however:
cross-rs/cross-toolchains#24

Emilgardis

looks amazing, some minor comments

I'm not super familiar with the android build system so can't comment to much on the approach, but this seems great!

This might now be the most complete containerized build system for c/c++/rust projects in android available anywhere 😅

i'm fine with merging this into this repo

docker/Dockerfile.aarch64-linux-android

xtask/src/hooks.rs

docker/android-system.sh

**Configuration** We provide the following arguments to configure the Android version: - `ANDROID_NDK` - `ANDROID_SDK` (note that this is dependent on `ANDROID_VERSION) - `ANDROID_VERSION` - `ANDROID_SYSTEM_COMPLETE`: do a complete Android build - `ANDROID_SYSTEM_NONE`: do not build the Android system, disables runner support **Version Support** We now support NDK versions r10e-r25b, SDK versions 21-33, and Android versions 5.0, 5.1, 6.0, 7.0, 8.0, 8.1, 9.0, 10.0, and 11.0. We also validate that the NDK, SDK, and Android versions are compatible. For Android 12+, we do support using the NDK with the proper API level, allowing cross-compilation for the desired target, however, running or testing the generated binary is currently not supported without a complete build. Note that support for non-complete builds with Android versions 12+ is unlikely to ever occur, due to issues with APEX in the build system. **Implementation Details** Next, we've improved the removal of unittests during the build process, to ensure fast builds while maintaining compatibility with various newer Android versions. To do this, we've implemented a Python library and a script. The Python library contains a complete parser (correctly parses all valid input) for Soong blueprint files, using an LALR grammar, and a rudimentary parser for Makefiles. The Soong parser removes any `gtest` dependencies, as well as any subdirectories or scope names containing `test`. For example: ```go cc_library { name: "lib", srcs: ["lib.cc",], } cc_test { name: "test", defaults: ["target"], srcs: ["test.cc"], } ``` Will become: ```go cc_library { name: "lib", srcs: ["lib.cc",], } ``` The Makefile parser first splits the file based on conditional directives (`ifeq`, `endif`, etc.) to ensure any subsequent processing doesn't lead to unbalanced directives. Next, we split the text within each directive based on comment sections used in the Android source tree. For example: ```Makefile test_tags := tests include $(call subdir,$(LOCAL_PATH)) c_flags := \ -g \ -Wall ``` We can therefore remove the `Benchmarks` and `Unit tests` sections without removing the `Other section`. The Python library is reasonably performant (it adds no noticeable overhead to the build process) and is compact (in total, < 60KB). Also, it is much more resilient than a series of `sed` scripts. Finally, extensive unittests have been added for the Python library, for both code linting (`flake8`) and unittests (via `tox`). Since we cannot assume the presence of Python on the host machine, the tests can be optionally enabled via the `--python` flag (or `PYTHON` environment variable, to hook into the git hooks), and custom overrides for the `flake8` and `tox` commands are provided (since the user may wish to specify a specific Python version, such as `python3.7 -m flake8`). **Linker** For Android 10+, since we use a minimal Android build, we only support the bootstrap and ASAN linkers unless using a complete Android build. Supporting the APEX linker requires a nearly complete Android runtime, requiring 60+GB image sizes, slow builds, and other prohibitive factors. **Complete Builds** Complete builds are currently untested, for Androids version 12+ they exceed the default storage capacity of WSL2 images (250GB). They should work and properly install both the `/system` and `/apex` directories, however, the builds are slow and untested.

Alexhuszagh · 2022-11-01T12:50:23Z

I've updated the NDK to r25b.
bors try --target -android

bors · 2022-11-01T13:36:28Z

try

Build succeeded:

conclusion

Alexhuszagh · 2022-11-01T13:39:05Z

bors r=Emilgardis

1023: Add support for Android versions 5-11. r=Emilgardis a=Alexhuszagh **Configuration** We provide the following arguments to configure the Android version: - `ANDROID_NDK` - `ANDROID_SDK` (note that this is dependent on `ANDROID_VERSION) - `ANDROID_VERSION` - `ANDROID_SYSTEM_COMPLETE`: do a complete Android build - `ANDROID_SYSTEM_NONE`: do not build the Android system, disables runner support **Version Support** We now support NDK versions r10e-r25b, SDK versions 21-33, and Android versions 5.0, 5.1, 6.0, 7.0, 8.0, 8.1, 9.0, 10.0, and 11.0. We also validate that the NDK, SDK, and Android versions are compatible. For Android 12+, we do support using the NDK with the proper API level, allowing cross-compilation for the desired target, however, running or testing the generated binary is currently not supported without a complete build. Note that support for non-complete builds with Android versions 12+ is unlikely to ever occur, due to issues with APEX in the build system. **Implementation Details** Next, we've improved the removal of unittests during the build process, to ensure fast builds while maintaining compatibility with various newer Android versions. To do this, we've implemented a Python library and a script. The Python library contains a complete parser (correctly parses all valid input) for Soong blueprint files, using an LALR grammar, and a rudimentary parser for Makefiles. The Soong parser removes any `gtest` dependencies, as well as any subdirectories or scope names containing `test`. For example: ```go cc_library { name: "lib", srcs: ["lib.cc",], } cc_test { name: "test", defaults: ["target"], srcs: ["test.cc"], } ``` Will become: ```go cc_library { name: "lib", srcs: ["lib.cc",], } ``` The Makefile parser first splits the file based on conditional directives (`ifeq`, `endif`, etc.) to ensure any subsequent processing doesn't lead to unbalanced directives. Next, we split the text within each directive based on comment sections used in the Android source tree. For example: ```Makefile test_tags := tests include $(call subdir,$(LOCAL_PATH)) c_flags := \ -g \ -Wall ``` We can therefore remove the `Benchmarks` and `Unit tests` sections without removing the `Other section`. The Python library is reasonably performant (it adds no noticeable overhead to the build process) and is compact (in total, < 60KB). Also, it is much more resilient than a series of `sed` scripts. Finally, extensive unittests have been added for the Python library, for both code linting (`flake8`) and unittests (via `tox`). Since we cannot assume the presence of Python on the host machine, the tests can be optionally enabled via the `--python` flag (or `PYTHON` environment variable, to hook into the git hooks), and custom overrides for the `flake8` and `tox` commands are provided (since the user may wish to specify a specific Python version, such as `python3.7 -m flake8`). **Linker** For Android 10+, since we use a minimal Android build, we only support the bootstrap and ASAN linkers unless using a complete Android build. Supporting the APEX linker requires a nearly complete Android runtime, requiring 60+GB image sizes, slow builds, and other prohibitive factors. **Complete Builds** Complete builds are currently untested, for Androids version 12+ they exceed the default storage capacity of WSL2 images (250GB). They should work and properly install both the `/system` and `/apex` directories, however, the builds are slow and untested. Co-authored-by: Alex Huszagh <ahuszagh@gmail.com>

bors · 2022-11-01T14:29:38Z

Build failed:

conclusion

Alexhuszagh · 2022-11-01T14:30:02Z

Currently waiting on the fix for -ar and -gcc-ar in #1105, and also we had a spurious network issue in the merge.

Emilgardis · 2022-11-01T14:42:39Z

bors r+ p=1

1023: Add support for Android versions 5-11. r=Emilgardis a=Alexhuszagh **Configuration** We provide the following arguments to configure the Android version: - `ANDROID_NDK` - `ANDROID_SDK` (note that this is dependent on `ANDROID_VERSION) - `ANDROID_VERSION` - `ANDROID_SYSTEM_COMPLETE`: do a complete Android build - `ANDROID_SYSTEM_NONE`: do not build the Android system, disables runner support **Version Support** We now support NDK versions r10e-r25b, SDK versions 21-33, and Android versions 5.0, 5.1, 6.0, 7.0, 8.0, 8.1, 9.0, 10.0, and 11.0. We also validate that the NDK, SDK, and Android versions are compatible. For Android 12+, we do support using the NDK with the proper API level, allowing cross-compilation for the desired target, however, running or testing the generated binary is currently not supported without a complete build. Note that support for non-complete builds with Android versions 12+ is unlikely to ever occur, due to issues with APEX in the build system. **Implementation Details** Next, we've improved the removal of unittests during the build process, to ensure fast builds while maintaining compatibility with various newer Android versions. To do this, we've implemented a Python library and a script. The Python library contains a complete parser (correctly parses all valid input) for Soong blueprint files, using an LALR grammar, and a rudimentary parser for Makefiles. The Soong parser removes any `gtest` dependencies, as well as any subdirectories or scope names containing `test`. For example: ```go cc_library { name: "lib", srcs: ["lib.cc",], } cc_test { name: "test", defaults: ["target"], srcs: ["test.cc"], } ``` Will become: ```go cc_library { name: "lib", srcs: ["lib.cc",], } ``` The Makefile parser first splits the file based on conditional directives (`ifeq`, `endif`, etc.) to ensure any subsequent processing doesn't lead to unbalanced directives. Next, we split the text within each directive based on comment sections used in the Android source tree. For example: ```Makefile test_tags := tests include $(call subdir,$(LOCAL_PATH)) c_flags := \ -g \ -Wall ``` We can therefore remove the `Benchmarks` and `Unit tests` sections without removing the `Other section`. The Python library is reasonably performant (it adds no noticeable overhead to the build process) and is compact (in total, < 60KB). Also, it is much more resilient than a series of `sed` scripts. Finally, extensive unittests have been added for the Python library, for both code linting (`flake8`) and unittests (via `tox`). Since we cannot assume the presence of Python on the host machine, the tests can be optionally enabled via the `--python` flag (or `PYTHON` environment variable, to hook into the git hooks), and custom overrides for the `flake8` and `tox` commands are provided (since the user may wish to specify a specific Python version, such as `python3.7 -m flake8`). **Linker** For Android 10+, since we use a minimal Android build, we only support the bootstrap and ASAN linkers unless using a complete Android build. Supporting the APEX linker requires a nearly complete Android runtime, requiring 60+GB image sizes, slow builds, and other prohibitive factors. **Complete Builds** Complete builds are currently untested, for Androids version 12+ they exceed the default storage capacity of WSL2 images (250GB). They should work and properly install both the `/system` and `/apex` directories, however, the builds are slow and untested. Co-authored-by: Alex Huszagh <ahuszagh@gmail.com>

bors · 2022-11-01T15:49:57Z

Build failed:

conclusion

Emilgardis · 2022-11-01T16:33:27Z

bors retry

Alexhuszagh · 2022-11-01T16:33:27Z

bors r=Emilgardis

bors · 2022-11-01T16:33:33Z

Already running a review

bors · 2022-11-01T17:52:19Z

Build succeeded:

conclusion

Alexhuszagh added enhancement container-images A-android Area: android targets labels Sep 15, 2022

Emilgardis reviewed Sep 15, 2022

View reviewed changes

docker/Dockerfile.aarch64-linux-android Outdated Show resolved Hide resolved

docker/android-system.sh Outdated Show resolved Hide resolved

Alexhuszagh mentioned this pull request Sep 21, 2022

Tracking Issue for Android 10+ Support #1026

Closed

This comment was marked as outdated.

Sign in to view

bors bot added a commit that referenced this pull request Sep 22, 2022

Try #1023: --target aarch64-linux-android

e07d29f

This comment was marked as outdated.

Sign in to view

bors bot added a commit that referenced this pull request Sep 22, 2022

Try #1023: --target aarch64-linux-android

62a104b

This comment was marked as outdated.

Sign in to view

bors bot added a commit that referenced this pull request Sep 23, 2022

Try #1023: --target aarch64-linux-android

03fd12f

Alexhuszagh force-pushed the android_versions branch from 8a888c5 to 782ecd1 Compare September 26, 2022 16:02

Alexhuszagh force-pushed the android_versions branch 6 times, most recently from f74d84b to 17c074a Compare October 15, 2022 04:06

Alexhuszagh force-pushed the android_versions branch 3 times, most recently from 16dee77 to 75870b7 Compare October 17, 2022 21:06

Alexhuszagh force-pushed the android_versions branch 4 times, most recently from 79fb560 to 97d747e Compare October 25, 2022 18:38

bors bot added a commit that referenced this pull request Oct 28, 2022

Try #1023: --target *-android*

81cb26e

Emilgardis approved these changes Oct 31, 2022

View reviewed changes

docker/Dockerfile.aarch64-linux-android Outdated Show resolved Hide resolved

xtask/src/hooks.rs Outdated Show resolved Hide resolved

xtask/src/hooks.rs Outdated Show resolved Hide resolved

docker/android-system.sh Outdated Show resolved Hide resolved

Alexhuszagh force-pushed the android_versions branch from c2ff7ac to 25c7121 Compare November 1, 2022 12:40

bors bot added a commit that referenced this pull request Nov 1, 2022

Try #1023: --target *-android*

0392ad8

Alexhuszagh mentioned this pull request Nov 1, 2022

Explicitly prefer -ar to -gcc-ar. #1105

Merged

bors bot merged commit 35a1e17 into cross-rs:main Nov 1, 2022

Alexhuszagh deleted the android_versions branch November 1, 2022 23:51

Alexhuszagh mentioned this pull request Nov 11, 2022

aarch64-linux-android target fails if using rust nightly #1128

Closed

11 tasks

This was referenced Mar 12, 2023

Android build seems to be broken after Rust 1.68 #1217

Closed

Target aarch64-linux-android link failure: unwind. #1222

Open

Emilgardis added this to the v0.3.0 milestone Mar 27, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for Android versions 5-11. #1023

Add support for Android versions 5-11. #1023

Alexhuszagh commented Sep 15, 2022 •

edited

Alexhuszagh commented Sep 15, 2022 •

edited

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

Alexhuszagh commented Sep 23, 2022

Alexhuszagh commented Sep 23, 2022

bors bot commented Sep 23, 2022

Alexhuszagh commented Oct 28, 2022

bors bot commented Oct 28, 2022

Emilgardis commented Oct 28, 2022

Alexhuszagh commented Oct 28, 2022

Alexhuszagh commented Oct 28, 2022

Emilgardis left a comment

Alexhuszagh commented Nov 1, 2022

bors bot commented Nov 1, 2022

Alexhuszagh commented Nov 1, 2022

bors bot commented Nov 1, 2022

Alexhuszagh commented Nov 1, 2022

Emilgardis commented Nov 1, 2022

bors bot commented Nov 1, 2022

Emilgardis commented Nov 1, 2022

Alexhuszagh commented Nov 1, 2022

bors bot commented Nov 1, 2022

bors bot commented Nov 1, 2022

Add support for Android versions 5-11. #1023

Add support for Android versions 5-11. #1023

Conversation

Alexhuszagh commented Sep 15, 2022 • edited

Alexhuszagh commented Sep 15, 2022 • edited

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

Alexhuszagh commented Sep 23, 2022

Alexhuszagh commented Sep 23, 2022

bors bot commented Sep 23, 2022

try

Alexhuszagh commented Oct 28, 2022

bors bot commented Oct 28, 2022

try

Emilgardis commented Oct 28, 2022

Alexhuszagh commented Oct 28, 2022

Alexhuszagh commented Oct 28, 2022

Emilgardis left a comment

Choose a reason for hiding this comment

Alexhuszagh commented Nov 1, 2022

bors bot commented Nov 1, 2022

try

Alexhuszagh commented Nov 1, 2022

bors bot commented Nov 1, 2022

Alexhuszagh commented Nov 1, 2022

Emilgardis commented Nov 1, 2022

bors bot commented Nov 1, 2022

Emilgardis commented Nov 1, 2022

Alexhuszagh commented Nov 1, 2022

bors bot commented Nov 1, 2022

bors bot commented Nov 1, 2022

Alexhuszagh commented Sep 15, 2022 •

edited

Alexhuszagh commented Sep 15, 2022 •

edited