Blame NOTES.ANDROID

Packit Service 084de1
Packit Service 084de1
 NOTES FOR ANDROID PLATFORMS
Packit Service 084de1
 ===========================
Packit Service 084de1
Packit Service 084de1
 Requirement details
Packit Service 084de1
 -------------------
Packit Service 084de1
Packit Service 084de1
 Beside basic tools like perl and make you'll need to download the Android
Packit Service 084de1
 NDK. It's available for Linux, Mac OS X and Windows, but only Linux
Packit Service 084de1
 version was actually tested. There is no reason to believe that Mac OS X
Packit Service 084de1
 wouldn't work. And as for Windows, it's unclear which "shell" would be
Packit Service 084de1
 suitable, MSYS2 might have best chances. NDK version should play lesser
Packit Service 084de1
 role, the goal is to support a range of most recent versions.
Packit Service 084de1
Packit Service 084de1
 Configuration
Packit Service 084de1
 -------------
Packit Service 084de1
Packit Service 084de1
 Android is a naturally cross-compiled target and you can't use ./config.
Packit Service 084de1
 You have to use ./Configure and name your target explicitly; there are
Packit Service 084de1
 android-arm, android-arm64, android-mips, android-mip64, android-x86
Packit Service 084de1
 and android-x86_64 (*MIPS targets are no longer supported with NDK R20+).
Packit Service 084de1
 Do not pass --cross-compile-prefix (as you might be tempted), as it will
Packit Service 084de1
 be "calculated" automatically based on chosen platform. Though you still
Packit Service 084de1
 need to know the prefix to extend your PATH, in order to invoke
Packit Service 084de1
 $(CROSS_COMPILE)clang [*gcc on NDK 19 and lower] and company. (Configure
Packit Service 084de1
 will fail and give you a hint if you get it wrong.) Apart from PATH
Packit Service 084de1
 adjustment you need to set ANDROID_NDK_HOME environment to point at the
Packit Service 084de1
 NDK directory. If you're using a side-by-side NDK the path will look
Packit Service 084de1
 something like /some/where/android-sdk/ndk/<ver>, and for a standalone
Packit Service 084de1
 NDK the path will be something like /some/where/android-ndk-<ver>.
Packit Service 084de1
 Both variables are significant at both configuration and compilation times.
Packit Service 084de1
 The NDK customarily supports multiple Android API levels, e.g. android-14,
Packit Service 084de1
 android-21, etc. By default latest API level is chosen. If you need to
Packit Service 084de1
 target an older platform pass the argument -D__ANDROID_API__=N to Configure,
Packit Service 084de1
 with N being the numerical value of the target platform version. For example,
Packit Service 084de1
 to compile for Android 10 arm64 with a side-by-side NDK r20.0.5594570
Packit Service 084de1
Packit Service 084de1
	export ANDROID_NDK_HOME=/home/whoever/Android/android-sdk/ndk/20.0.5594570
Packit Service 084de1
	PATH=$ANDROID_NDK_HOME/toolchains/llvm/prebuilt/linux-x86_64/bin:$ANDROID_NDK_HOME/toolchains/arm-linux-androideabi-4.9/prebuilt/linux-x86_64/bin:$PATH
Packit Service 084de1
	./Configure android-arm64 -D__ANDROID_API__=29
Packit Service 084de1
	make
Packit Service 084de1
Packit Service 084de1
 Older versions of the NDK have GCC under their common prebuilt tools directory, so the bin path
Packit Service 084de1
 will be slightly different. EG: to compile for ICS on ARM with NDK 10d:
Packit Service 084de1
Packit Service 084de1
    export ANDROID_NDK_HOME=/some/where/android-ndk-10d
Packit Service 084de1
    PATH=$ANDROID_NDK_HOME/toolchains/arm-linux-androideabi-4.8/prebuilt/linux-x86_64/bin:$PATH
Packit Service 084de1
    ./Configure android-arm -D__ANDROID_API__=14
Packit Service 084de1
    make
Packit Service 084de1
Packit Service 084de1
 Caveat lector! Earlier OpenSSL versions relied on additional CROSS_SYSROOT
Packit Service 084de1
 variable set to $ANDROID_NDK_HOME/platforms/android-<api>/arch-<arch> to
Packit Service 084de1
 appoint headers-n-libraries' location. It's still recognized in order
Packit Service 084de1
 to facilitate migration from older projects. However, since API level
Packit Service 084de1
 appears in CROSS_SYSROOT value, passing -D__ANDROID_API__=N can be in
Packit Service 084de1
 conflict, and mixing the two is therefore not supported. Migration to
Packit Service 084de1
 CROSS_SYSROOT-less setup is recommended.
Packit Service 084de1
Packit Service 084de1
 One can engage clang by adjusting PATH to cover same NDK's clang. Just
Packit Service 084de1
 keep in mind that if you miss it, Configure will try to use gcc...
Packit Service 084de1
 Also, PATH would need even further adjustment to cover unprefixed, yet
Packit Service 084de1
 target-specific, ar and ranlib. It's possible that you don't need to
Packit Service 084de1
 bother, if binutils-multiarch is installed on your Linux system.
Packit Service 084de1
Packit Service 084de1
 Another option is to create so called "standalone toolchain" tailored
Packit Service 084de1
 for single specific platform including Android API level, and assign its
Packit Service 084de1
 location to ANDROID_NDK_HOME. In such case you have to pass matching
Packit Service 084de1
 target name to Configure and shouldn't use -D__ANDROID_API__=N. PATH
Packit Service 084de1
 adjustment becomes simpler, $ANDROID_NDK_HOME/bin:$PATH suffices.
Packit Service 084de1
Packit Service 084de1
 Running tests (on Linux)
Packit Service 084de1
 ------------------------
Packit Service 084de1
Packit Service 084de1
 This is not actually supported. Notes are meant rather as inspiration.
Packit Service 084de1
Packit Service 084de1
 Even though build output targets alien system, it's possible to execute
Packit Service 084de1
 test suite on Linux system by employing qemu-user. The trick is static
Packit Service 084de1
 linking. Pass -static to Configure, then edit generated Makefile and
Packit Service 084de1
 remove occurrences of -ldl and -pie flags. You would also need to pick
Packit Service 084de1
 API version that comes with usable static libraries, 42/2=21 used to
Packit Service 084de1
 work. Once built, you should be able to
Packit Service 084de1
Packit Service 084de1
    env EXE_SHELL=qemu-<arch> make test
Packit Service 084de1
Packit Service 084de1
 If you need to pass additional flag to qemu, quotes are your friend, e.g.
Packit Service 084de1
Packit Service 084de1
    env EXE_SHELL="qemu-mips64el -cpu MIPS64R6-generic" make test