NDK Roadmap

Note: If there‘s anything you want to see done in the NDK, file a bug! Nothing here is set in stone, and if there’s something that we haven‘t thought of that would be of more use, we’d be happy to adjust our plans for that.

Disclaimer: Everything here is subject to change. The further the plans are in the future, the less stable they will be. Things in the upcoming release are fairly certain, and the second release is quite likely. Beyond that, anything written here is what we would like to accomplish in that release assuming things have gone according to plan until then.

Note: For release timing, see our release schedule on our wiki.


Regular maintenance

Every NDK release aims to include a new toolchain, new headers, and a new version of libc++.

We also maintain hotlists of the bugs we intend to fix in any given NDK release.


Future work

The following projects are listed in order of their current priority.

Note that some of these projects do not actually affect the contents of the NDK package. The samples, cdep, documentation, etc are all NDK work but are separate from the NDK package. As such they will not appear in any specific release, but are noted here to show where the team's time is being spent.

Easier access to common open-source libraries

There are many other commonly-used libraries (such as Curl and BoringSSL) that are currently difficult to build/package, let alone keep updated. We should offer (a) a tool to build open source projects, (b) a repository of prebuilts, (c) a command-line tool to add prebuilts to an ndk-build/cmake project, and (d) Studio integration to add prebuilts via a GUI.

The tools are nearly complete, and the repository is Maven for easy integration into existing Android projects. Access from CMake and ndk-build will be via the existing find_package and import-module facilities, respectively. A GUI in Studio will come later.

For more information, see Issue 916.

C++ File System API

Issue 609

We don't currently build, test, or ship libc++‘s std::filesystem. Until recently this API wasn’t final, but now is at least a stable API (though it sounds like the ABI will change in the near future).

There‘s a fair amount of work involved in getting these tests running, but that’s something we should do.

CMake

CMake added their own NDK support about the same time we added our toolchain file. The two often conflict with each other, and a toolchain file is a messy way to implement this support. However, fully switching to the integrated support puts NDK policy decisions (default options, NDK layout, etc) fully into the hands of CMake, which makes them impossible to update without the user also updating their CMake version.

We will reorganize our toolchain file to match the typical implementation of a CMake platform integration (like $CMAKE/Modules/Platform/Android-*.cmake) and CMake will be modified to load the implementation from the NDK rather than its own.

See Issue 463 for discussion.

Default to lld

NDK r18 made lld available, r20 made it more usable, and a future release will make it the default once all the issues that turn up are resolved.

Remove gold and bfd

Once we've switched the default to lld and no major issues remain, we should remove gold and bfd.

lldb debugger

We should make lldb available in the NDK. It's currently shipped as part of Studio. Medium-term we should have Studio ship our lldb. Long-term Studio should probably use the NDK lldb directly.


Unscheduled Work

The following projects are things we intend to do, but have not yet been sheduled into the sections above.

Better documentation

We should probably add basic doc comments to the bionic headers:

  • One-sentence summary.
  • One paragraph listing any Android differences. (Perhaps worth upstreaming this to man7.org too.)
  • Explain any “flags” arguments (at least giving some idea of which flags)?
  • Explain the return value: what does a char* point to? Who owns it? Are errors -1 (as for most functions) or <errno.h> values (for pthread_mutex_lock)?
  • A “See also” pointing to man7.org?

Should these be in the NDK API reference too? If so, how will we keep them from swamping the “real” NDK API?

vim is ready, Android Studio now supports doxygen comments (but seems to have gained a new man page viewer that takes precedence), and Visual Studio Code has nothing but feature requests.

Better samples

The samples are low-quality and don't necessarily cover interesting/difficult topics.

Better tools for improving code quality.

The NDK has long included gtest and clang supports various sanitiziers, but there are things we can do to improve the state of testing/code quality:

  • Test coverage support.
  • Add gmock.
  • Make GTestJNI available to developers via some some package manager so developers can integrate their C++ tests into Studio.

NDK API header-only C++ wrappers

NDK APIs are C-only for ABI stability reasons. We should offer header-only C++ wrappers for NDK APIs, even if only to offer the benefits of RAII. Examples include Bitmap, ATrace, and ASharedMemory.

NDK C++ header-only JNI helpers

Complaints about basic JNI handling are common. We should make libnativehelper or something similar available to developers.

NDK icu4c wrapper

For serious i18n, icu4c is too big too bundle, and non-trivial to use the platform. We have a C API wrapper prototype, but we need to make it easily available for NDK users.

More automated libc++ updates

We still need to update libc++ twice: once for the platform, and once for the NDK. We also still have two separate test runners.

Weak symbols for API additions

iOS developers are used to using weak symbols to refer to function that may be present in their equivalent of targetSdkVersion but not in their minSdkVersion. We could potentially do something similar. See issue 1003.

C++ Modules

By Q2 2019 Clang may have a complete enough implementation of the modules TS and Android may have a Clang with those changes available.

At least for the current spec (which is in the process of merging with the Clang implementation, so could change), the NDK will need to:

  1. Support compiling module interfaces.
  2. Support either automated discovery (currently very messy) or specification of module dependencies.
  3. Begin creating module interfaces for system libraries. Frameworks, libc, libc++, etc.

Historical releases

Full history is available, but this section summarizes major changes in recent releases.

NDK r20

Updated Clang and libc++, added Q APIs. Improved out-of-the-box Clang behavior.

NDK r19

Reorganized the toolchain packaging and modified Clang so that standalone toolchains are now unnecessary. Clang can now be invoked directly from its installed location in the NDK.

C++ compilation defaults to C++14.

NDK r18

Removed GCC and gnustl/stlport. Added lld.

Added compile_commands.json for better tooling support.

NDK r17

Defaulted to libc++.

Removed ARMv5 (armeabi), MIPS, and MIPS64.

NDK r16

Fixed libandroid_support, libc++ now the recommended STL (but still not the default).

Removed non-unified headers.

NDK r15

Defaulted to unified headers (opt-out).

Removed support for API levels lower than 14 (Android 4.0).

NDK r14

Added unified headers (opt-in).

NDK r13

Added simpleperf.

NDK r12

Removed armeabi-v7a-hard.

Removed support for API levels lower than 9 (Android 2.3).