[Docs] [android] Update to the latest NDK 21, fix commands, and remove cruft #29439

finagolfin · 2020-01-24T20:19:07Z

The commands from this pull were tested on an Arch Linux x86_64 VPS by building everything with Swift 5.1.3 for Android AArch64. Rather than use adb to test the "hello world" example, I copied the listed files over to the Termux app on an Android AArch64 device and checked that it ran that way. Nor did I actually use adb to test the final command or build the ARMv7 version of these commands, but I checked the NDK ARMv7 paths to make sure they were correct.

I only had to make a couple tweaks to the Swift CMake config to get it to cross-compile for Android, pull forthcoming for that.

finagolfin · 2020-01-24T20:24:10Z

docs/Android.md

    --android-api-level 21 \                   # The Android API level to target. Swift only supports 21 or greater.
    --android-icu-uc ${ARM_DIR}/libicuucswift.so \
    --android-icu-uc-include ${ARM_DIR}/icu/source/common \
    --android-icu-i18n ${ARM_DIR}/libicui18nswift.so \
-    --android-icu-i18n-include ${ARM_DIR}/icu/source/i18n
+    --android-icu-i18n-include ${ARM_DIR}/icu/source/i18n \
+    --android-icu-data ${ARM_DIR}/libicudataswift.so


This was made a requirement in #20082, but these commands weren't updated to show that, so the current commands in this doc don't work.

finagolfin · 2020-01-24T20:25:04Z

docs/Android.md

-```
-$ sudo ln -s \
-    /path/to/android-ndk-r16/toolchains/arm-linux-androideabi-4.9/prebuilt/linux-x86_64/arm-linux-androideabi/bin/ld.gold \
-    /usr/bin/armv7-none-linux-androideabi-ld.gold


Unneeded since the -tools-directory flag was added in #8007.

finagolfin · 2020-01-24T20:27:22Z

docs/Android.md

+$ NDK_PATH="path/to/android-ndk21"
+$ build/Ninja-ReleaseAssert/swift-linux-x86_64/bin/swiftc \     # The Swift compiler built in the previous step.
+                                                                # The location of the tools used to build Android binaries
+    -tools-directory ${NDK_PATH}/toolchains/llvm/prebuilt/linux-x86_64/bin/ \


This is a better architecture-independent path because it will get swift to invoke the NDK's clang, which will simply call the right linker based on the -target flag.

finagolfin · 2020-01-24T20:32:34Z

docs/Android.md

+    -tools-directory ${NDK_PATH}/toolchains/llvm/prebuilt/linux-x86_64/bin/ \
+    -target armv7a-none-linux-androideabi \                     # Targeting android-armv7.
+    -sdk ${NDK_PATH}/platforms/android-21/arch-arm \            # Use the same architecture and API version as you used to build the stdlib in the previous step.
+    -Xclang-linker -nostdlib++ \                                # Don't link libc++, and supply the path to libgcc.


I don't know how the previous attempt to link against the NDK's libc++ ever worked, as the Android port of Swift linked against libc++_shared.so from the beginning, and clang++ will try to link against the file named libc++.so instead.

finagolfin · 2020-01-24T20:37:07Z

docs/Android.md

 $ adb push build/Ninja-ReleaseAssert/swift-linux-x86_64/lib/swift/android/libswiftSwiftOnoneSupport.so /data/local/tmp
-$ adb push build/Ninja-ReleaseAssert/swift-linux-x86_64/lib/swift/android/libswiftRemoteMirror.so /data/local/tmp
-$ adb push build/Ninja-ReleaseAssert/swift-linux-x86_64/lib/swift/android/libswiftSwiftExperimental.so /data/local/tmp


I didn't need any of these three libraries when running the "hello world" example, with the last one not existing anymore.

finagolfin · 2020-01-24T20:40:03Z

docs/Android.md

-## Build Android Toolchain
-
-This toolchain will generate the .so and .swiftmodule files of the Swift standard library and Foundation framework for the Android environment, armv7 architecture. Those files are needed when building any Swift library to be included in an application for Android.
-


This last section was just added with #12530 after two years in limbo, but the referenced build-toolchain script hasn't been updated since then either and most likely won't work, so just take this out.

@amraboelela, let me know if it works.

finagolfin · 2020-01-24T22:02:01Z

@CodaFi, this doc hasn't been meaningfully updated in years, and you were the last one to merge an old pull into it, so let me know what you think.

docs/Android.md

CodaFi

One remaining comment. I’m not an authority on this configuration though.

CodaFi · 2020-01-24T23:34:13Z

@compnerd Does this look alright?

compnerd · 2020-01-25T00:17:05Z

docs/Android.md

+$ build/Ninja-ReleaseAssert/swift-linux-x86_64/bin/swiftc \     # The Swift compiler built in the previous step.
+                                                                # The location of the tools used to build Android binaries
+    -tools-directory ${NDK_PATH}/toolchains/llvm/prebuilt/linux-x86_64/bin/ \
+    -target armv7a-none-linux-androideabi \                     # Targeting android-armv7.


This really should be armv7-unknown-linux-androideabi -march=armv7-a.

This is a swiftc flag to build the Swift example and invoke the clang++ linker driver, I don't believe there's a -march flag accepted by swiftc. As for armv7 vs armv7a, Jake Petroules asked that I use the latter before because it's the official triple, and none vs unknown for the vendor are both ignored. I honestly don't care what variation of this target triple is used, so just let me know.

Ping, this is the last remaining issue for this pull, just let me know what you prefer given the details I linked and mentioned.

Finally built the Android-armv7 SDK by using these commands and as expected, the above flags didn't work:

<unknown>:0: error: unknown argument: '-march=armv7-a'

Instead, the flag I used worked, as did -target armv7-unknown-linux-androideabi -Xclang-linker -march=armv7-a, tested by building the hello world executable both ways and running it.

Since both ways work once your suggestion is properly modified, I don't really care what's used, just let me know.

I experimented with this a bit more and if I cross-compiled the Swift object file first, to avoid any transient strings from each compiler invocation, then linked it into an executable by using this command with either of these flag combos or a couple more I tried, they all produce identical executables with the same hashes, as the final linker commands run are identical.

Since the suggestion makes no difference, the flag used now should be fine.

docs/Android.md

…e cruft

finagolfin · 2020-02-14T15:29:43Z

Ping @CodaFi, addressed all issues with this pull, with no response for the last three weeks on the last remaining suggestion from the review. Anyway, I've since run all these commands for Android ARMv7 too, and it worked well as is.

I'd like to get this in and then I'll submit a pull for the 5.2 branch with this doc update and #29296 also (I'd appreciate any help on that stalled pull too, parts of which were used to build a full 5.1.4 toolchain natively on Android, termux/termux-packages#4895), so that the upcoming 5.2 release can be used to easily compile for Android, both cross-compiling and natively too.

CodaFi · 2020-02-14T15:32:31Z

I’ll merge this here but 5.2 is under lockdown for critical changes. I don’t think these changes need to go there as well. From master you can cut another tag or have CI master a toolchain and it’ll do the trick.

CodaFi · 2020-02-14T15:32:44Z

@swift-ci please smoke test and merge

finagolfin · 2020-02-15T04:14:09Z

Alright, at least this doc will be fixed for the 5.3 release, thanks for merging.

finagolfin commented Jan 24, 2020

View reviewed changes

CodaFi reviewed Jan 24, 2020

View reviewed changes

docs/Android.md Outdated Show resolved Hide resolved

CodaFi approved these changes Jan 24, 2020

View reviewed changes

CodaFi requested a review from compnerd January 24, 2020 23:34

finagolfin force-pushed the doc branch from 079cab1 to 829a4c2 Compare January 25, 2020 00:13

compnerd requested changes Jan 25, 2020

View reviewed changes

[Docs] [android] Update to the latest NDK 21, fix commands, and remov…

b516d19

…e cruft

finagolfin force-pushed the doc branch from 829a4c2 to b516d19 Compare January 25, 2020 00:42

swift-ci merged commit ea55a30 into swiftlang:master Feb 14, 2020

finagolfin deleted the doc branch February 15, 2020 04:12

finagolfin mentioned this pull request Mar 2, 2020

[build] rewrite #21707 so that it doesn't break cross-compilation #30170

Open

finagolfin mentioned this pull request Jan 8, 2021

[SR-1750] Use the Android linker when running the Android test suite #44359

Closed

		## Build Android Toolchain

		This toolchain will generate the .so and .swiftmodule files of the Swift standard library and Foundation framework for the Android environment, armv7 architecture. Those files are needed when building any Swift library to be included in an application for Android.

[Docs] [android] Update to the latest NDK 21, fix commands, and remove cruft #29439

[Docs] [android] Update to the latest NDK 21, fix commands, and remove cruft #29439

Uh oh!

Conversation

finagolfin commented Jan 24, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

finagolfin commented Jan 24, 2020

Uh oh!

Uh oh!

CodaFi left a comment

Choose a reason for hiding this comment

Uh oh!

CodaFi commented Jan 24, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

finagolfin commented Feb 14, 2020

Uh oh!

CodaFi commented Feb 14, 2020

Uh oh!

CodaFi commented Feb 14, 2020

Uh oh!

finagolfin commented Feb 15, 2020

Uh oh!

Uh oh!

finagolfin commented Jan 24, 2020 •

edited

Loading