Google Git
Sign in
android / platform / ndk / 0e75a4b85523fc597305d7076b1f17ba2a5affd1
commit0e75a4b85523fc597305d7076b1f17ba2a5affd1[log] [tgz]
authorDan Albert <[email protected]>Mon Jun 27 23:43:19 2016 -0700
committerDan Albert <[email protected]>Mon Jun 27 23:58:40 2016 -0700
treec0b8cbe9b0b79352e6a29caada46dc62116e458f
parente26e3d84cd4714d9044c06e68d2265c8369d0b12 [diff]
Fork static executable test into two.

The static-executable test couldn't have caught
https://github.com/android-ndk/ndk/issues/132 because it's already
marked broken for a different issue (duplicate symbols caused by L's
libc.a including new/delete and friends colliding with libsupc++ for
exception support).

To make our test suite marginally less useless, split this into two
tests. static-executable will be the bare minimum static executable
test, and static-executable-exceptions will make sure exception
support works (or, for now, doesn't).

Test: Applied with other patches in topic (one of which removes the
      broken annotation for static-executable), static-executable
      passes for ARM android-21 and static-executable-exceptions
      remains a known failure.
Bug: http://b/24468267
Bug: https://github.com/android-ndk/ndk/issues/132

Change-Id: Ib83c8f01974db5139ab4069996a6bf2187e51a94
7 files changed
tree: c0b8cbe9b0b79352e6a29caada46dc62116e458f
  1. build/
  2. docs/
  3. samples/
  4. scripts/
  5. sources/
  6. tests/
  7. .gitignore
  8. Android.mk
  9. CHANGELOG.md
  10. checkbuild.py
  11. CleanSpec.mk
  12. config.py
  13. CONTRIBUTING.md
  14. ndk-gdb
  15. ndk-gdb.cmd
  16. ndk-gdb.py
  17. ndk-which
  18. OWNERS
  19. pylintrc
  20. README.md
README.md

Android Native Development Kit (NDK)

The latest version of this document is available at https://android.googlesource.com/platform/ndk/+/master/README.md.

Note: This document is for developers of the NDK, not developers that use the NDK.

The NDK allows Android application developers to include native code in their Android application packages, compiled as JNI shared libraries.

Other Resources

This doc gives a high level overview of the NDK's build, packaging, and test process. For other use cases, or more in depth documentation, refer to the following sources:

Building the NDK

Both Linux and Windows host binaries are built on Linux machines. Windows host binaries are built via MinGW cross compiler. Systems without a working MinGW compiler can use build/tools/build-mingw64-toolchain.sh to generate their own and be added to the PATH for build scripts to discover.

Building binaries for Mac OS X requires at least 10.8.

Target headers and binaries are built on Linux.

Components

The NDK consists of three parts: host binaries, target prebuilts, and others (build system, docs, samples, tests).

Host Binaries

  • toolchains/ contains GCC and Clang toolchains.
    • $TOOLCHAIN/config.mk contains ARCH and ABIS this toolchain can handle.
    • $TOOLCHAIN/setup.mk contains toolchain-specific default CFLAGS/LDFLAGS when this toolchain is used.
  • prebuilt/$HOST_TAG contains build dependencies and additional tools.
    • make, awk, python, yasm, and for Windows: cmp.exe and echo.exe
    • ndk-depends, ndk-stack and ndk-gdb can also be found here.

Target Headers and Binaries

  • platforms/android-$VERSION/arch-$ARCH_NAME/ contains headers and libraries for each API level.
    • The build system sets --sysroot to one of these directories based on user-specified APP_ABI and APP_PLATFORM.
  • sources/cxx-stl/$STL contains the headers and libraries for the various C++ STLs.
  • prebuilt/android-$ARCH/gdbserver contains gdbserver.

Others

  • build/ contains the ndk-build system and scripts to rebuild NDK.
  • sources/android and sources/third_party contain modules that can be used in apps (cpufeatures, native_app_glue, etc) via $(call import-module, $MODULE)
  • tests/

Prerequisites

  • AOSP NDK Repository

    • Check out the branch master-ndk

      repo init -u https://android.googlesource.com/platform/manifest \
    -b master-ndk

# Googlers, use
repo init -u \
    persistent-https://android.git.corp.google.com/platform/manifest \
    -b master-ndk

  • Additional Linux Dependencies (available from apt):

    • bison
    • flex
    • libtool
    • mingw-w64
    • zip
    • pbzip2 (optional, improves packaging times)
    • texinfo
    • asciidoctor
    • ruby-pygments.rb
    • python-nose
    • python3 (used for Vulkan validation layer generation)
    • python-lxml (used for Vulkan validation layer generation)

  • Mac OS X also requires Xcode.

  • Running tests requires that adb is in your PATH. This is provided as part of the Android SDK.

Building the NDK

For Linux or Darwin:

$ python checkbuild.py

For Windows, from Linux:

$ python checkbuild.py --system windows  # Or windows64.

checkbuild.py also accepts a variety of other options to speed up local builds, namely --arch and --module.

Packaging

By default, checkbuild.py will also package the NDK and run basic tests. To skip the packaging step, use the --no-package flag. Note that running the tests does require the packaging step.

If you need to re-run just the packaging step without going through a build, packaging is handled by build/tools/package.py.

Testing

Testing is discussed in Testing.md.