cfi build fixes in x86-64 ghash assembly
[openssl.git] / NOTES.ANDROID
1
2  NOTES FOR ANDROID PLATFORMS
3  ===========================
4
5  Requirement details
6  -------------------
7
8  Beside basic tools like perl and make you'll need to download the Android
9  NDK. It's available for Linux, Mac OS X and Windows, but only Linux
10  version was actually tested. There is no reason to believe that Mac OS X
11  wouldn't work. And as for Windows, it's unclear which "shell" would be
12  suitable, MSYS2 might have best chances. NDK version should play lesser
13  role, the goal is to support a range of most recent versions.
14
15  Configuration
16  -------------
17
18  Android is naturally cross-compiled target and you can't use ./config.
19  You have to use ./Configure and name your target explicitly; there are
20  android-arm, android-arm64, android-mips, android-mip64, android-x86
21  and android-x86_64. Do not pass --cross-compile-prefix (as you might
22  be tempted), as it will be "calculated" automatically based on chosen
23  platform. Though you still need to know the prefix to extend your PATH,
24  in order to invoke $(CROSS_COMPILE)gcc and company. (Configure will fail
25  and give you a hint if you get it wrong.) Apart from PATH adjustment
26  you need to set ANDROID_NDK_HOME environment to point at NDK directory
27  as /some/where/android-ndk-<ver>. Both variables are significant at both
28  configuration and compilation times. NDK customarily supports multiple
29  Android API levels, e.g. android-14, android-21, etc. By default latest
30  one available is chosen. If you need to target older platform, pass
31  additional -D__ANDROID_API__=N to Configure. N is numeric value of the
32  target platform version. For example, to compile for ICS on ARM with
33  NDK 10d:
34
35     export ANDROID_NDK_HOME=/some/where/android-ndk-10d
36     PATH=$ANDROID_NDK_HOME/toolchains/arm-linux-androideabi-4.8/prebuilt/linux-x86_64/bin:$PATH
37     ./Configure android-arm -D__ANDROID_API__=14
38     make
39
40  Caveat lector! Earlier OpenSSL versions relied on additional CROSS_SYSROOT
41  variable set to $ANDROID_NDK_HOME/platforms/android-<api>/arch-<arch> to
42  appoint headers-n-libraries' location. It's still recognized in order
43  to facilitate migration from older projects. However, since API level
44  appears in CROSS_SYSROOT value, passing -D__ANDROID_API__=N can be in
45  conflict, and mixing the two is therefore not supported. Migration to
46  CROSS_SYSROOT-less setup is recommended.
47
48  One can engage clang by adjusting PATH to cover same NDK's clang. Just
49  keep in mind that if you miss it, Configure will try to use gcc...
50  Also, PATH would need even further adjustment to cover unprefixed, yet
51  target-specific, ar and ranlib. It's possible that you don't need to
52  bother, if binutils-multiarch is installed on your Linux system.
53
54  Another option is to create so called "standalone toolchain" tailored
55  for single specific platform including Android API level, and assign its
56  location to ANDROID_NDK_HOME. In such case you have to pass matching
57  target name to Configure and shouldn't use -D__ANDROID_API__=N. PATH
58  adjustment becomes simpler, $ANDROID_NDK_HOME/bin:$PATH suffices.
59
60  Running tests (on Linux)
61  ------------------------
62
63  This is not actually supported. Notes are meant rather as inspiration.
64
65  Even though build output targets alien system, it's possible to execute
66  test suite on Linux system by employing qemu-user. The trick is static
67  linking. Pass -static to Configure, then edit generated Makefile and
68  remove occurrences of -ldl and -pie flags. You would also need to pick
69  API version that comes with usable static libraries, 42/2=21 used to
70  work. Once built, you should be able to
71
72     env EXE_SHELL=qemu-<arch> make test
73
74  If you need to pass additional flag to qemu, quotes are your friend, e.g.
75
76     env EXE_SHELL="qemu-mips64el -cpu MIPS64R6-generic" make test