Google Git
Sign in
android / platform / ndk / 4b485bf4fbd62ce2be8f45958cd223230a5be538
commit4b485bf4fbd62ce2be8f45958cd223230a5be538[log] [tgz]
authorDan Albert <[email protected]>Thu Sep 24 10:28:36 2015 -0700
committerDan Albert <[email protected]>Fri Oct 02 13:44:20 2015 -0700
treeddc2ea5a0893ef3cf8fb878f875ef6935bc7c034
parentfb0e997e4d54b8d75b4102ecc31f3c2d963e5dad [diff]
Add test_config.py for better test disabling.

Each test directory can contain a "test_config.py" file that describes
the configurations a test is not expected to pass for. Previously this
information could be captured in one of two places: the Application.mk
file, or a BROKEN_BUILD/BROKEN_RUN file.

Application.mk was used to state that a test was only to be run for a
specific platform version, specific toolchain, or a set of ABIs.
Unfortunately Application.mk could only specify a single toolchain or
platform, not a set.

BROKEN_BUILD/BROKEN_RUN files were too general. An empty file meant
the test should always be skipped regardless of configuration. Any
change that would put a test in that situation should be reverted
immediately. These also didn't make it clear if the test was actually
broken (and thus should be fixed) or just not applicable.

A test_config.py file is more flexible. It is a Python module that
defines the functions `match_broken` and `match_unsupported`. These
functions respectively identify if a test is broken or unsupported for
the given configuration.

Change-Id: Ibffcef610a32c49efef17eba1154f6a9f4dcf565
59 files changed
tree: ddc2ea5a0893ef3cf8fb878f875ef6935bc7c034
  1. build/
  2. docs/
  3. samples/
  4. sources/
  5. tests/
  6. toolchains/
  7. .gitignore
  8. Android.mk
  9. checkbuild.py
  10. CleanSpec.mk
  11. find-win-host.cmd
  12. GNUmakefile
  13. ndk-build
  14. ndk-build.cmd
  15. ndk-gdb
  16. ndk-gdb-py
  17. ndk-gdb-py.cmd
  18. ndk-gdb.py
  19. ndk-which
  20. README.md
  21. realpath
  22. remove-windows-symlink.sh
README.md

Android Native Development Kit (NDK)

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

See the Getting Started Guide for an introduction.

See the changelist for a list of changes since the previous release.

Finally, discussions related to the Android NDK happen on the android-ndk Google Group.

Building the NDK

Note: This document is for developers of the NDK, not developers that use 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, Clang, and Renderscript 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_ARCH/ contains various tools to make the build system hermetic.
    • make, awk, sed, python, yasm, and for Windows: cmp.exe and echo.exe
  • ndk-depends and ndk-stack should probably go in prebuilt/ to avoid collisions between host variants.

Target Headers and Binaries

  • platforms/android-N/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/$ABI/ 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.
  • docs/
  • samples/
  • sources/ contains modules useful in samples and apps 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

    • The only difference between the NDK branch and master is that the NDK repository already has the toolchain repository checked out and patched.

  • Additional Linux Dependencies (available from apt):

    • texinfo
    • gcc-mingw32
    • wine
    • bison
    • flex
    • dmake
    • libtool
    • pbzip2

  • Mac OS X also requires Xcode.

Host/Target prebuilts

For Linux or Darwin:

$ python checkbuild.py --no-package

For Windows, from Linux:

$ python checkbuild.py --system windows

Packaging

The simplest way to package an NDK on Linux is to just omit the --no-package flag when running checkbuild.py. This will take a little longer though, so it may not be desired for day to day development.

To package the NDK for Windows or Darwin (or if more control over the packaging process is needed), invoke build/tools/package-release.sh directly. This process will be improved in a future commit.

Best Practices for Incremental Builds

  • Do not run build/tools/dev-cleanup.sh which erases all prebuilts.
  • Remove the individual prebuilt directory if new build deletes files. This is rare.
  • Package NDK from prebuilt tarballs in $PREBUILT_PATH. It runs build/tools/build-docs.sh which produces no tarball in $PREBUILT_PATH.
  • Unpack and compare against the previous package.