Blame NOTES.ANDROID

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