Currently, we have a set of libc headers for each API version. In many cases these headers are incorrect. Many expose APIs that didn‘t exist, and others don’t expose APIs that did.
Over the last few months we've done unified these into a single set of headers. This single header path will be used for every platform level. API level guards are handled with #ifdef
. These headers can be found in prebuilts/ndk/headers.
Unified headers are built directly from the Android platform, so they will no longer be out of date or incorrect (or at the very least, any bugs in the NDK headers will also be a bug in the platform headers, which means we're much more likely to find them).
-D__ANDROID_API__=$API
when compiling.Unified headers are enabled by default starting with NDK r15. If your build is not yet compatible with unified headers, you can revert to the deprecated headers. The way to do so depends on your build system.
Warning: The deprecated headers will be removed from the NDK in r16. If you need to revert to the deprecated headers, make sure you're working on fixing your build or filing bugs.
Add the following to your Android.mk:
APP_DEPRECATED_HEADERS := true
cmake -DANDROID_DEPRECATED_HEADERS=ON ...
$NDK/build/tools/make_standalone_toolchain.py --deprecated-headers ...
For general standalone toolchain documentation, see https://developer.android.com/ndk/guides/standalone_toolchain.html
model { android { ndk { useUnifiedHeaders false } } }
configure && make
If you're trying to build a traditional open-source configure && make
style project with the NDK, unified headers are your best choice. The basic steps look like this (here for 32-bit ARM):
$ $NDK/build/tools/make_standalone_toolchain.py --unified-headers \ --arch arm --api 21 --install-dir /tmp/ndk-arm-21 $ cd <project> $ export CC=/tmp/ndk-arm-21/arm-linux-androideabi-clang $ export LDFLAGS="-pie" $ ./configure --host=arm-linux-androideabi $ make
Replace “arm” and “arm-linux-androideabi” with the appropriate pair for the architecture you actually want to build for, and 21 with the API level you want to target.
App developers can stop reading here. The following information is only relevant to build system engineers.
Unified headers require only a few changes compared to using the deprecated NDK headers. For reference, this patch added support to ndk-build: https://android-review.googlesource.com/c/239934/
The compile time sysroot is now $NDK/sysroot
. Previously this was $NDK/platforms/android-$API/arch-$ARCH
.
Pass -isystem $NDK/sysroot/usr/include/$TRIPLE
when compiling. The triple has the following mapping:
Arch | Triple |
---|---|
ARM | arm-linux-androideabi |
ARM64 | aarch64-linux-android |
MIPS | mipsel-linux-android |
MIPS64 | mips64el-linux-android |
x86 | i686-linux-android |
x86_64 | x86_64-linux-android |
This is needed for architecture specific headers such as those in asm/
and machine/
. We plan to teach Clang's driver to automatically search the architecture specific include directory, but that has yet to be done.
Pass -D__ANDROID_API__=$API
when compiling. This define used to be provided by <android/api-level.h>
, but with only one set of headers this is no longer possible. In the future we will look in to adding -mandroid-version
or similar to Clang so this is automatic.
At link time, change nothing. All link time build behavior should match the deprecated headers behavior. --sysroot
should still point to $NDK/platforms/android-$API/arch-$ARCH/
.