Android NDK

1. Android.mk简介：

Android.mk文件用来告知NDK Build 系统关于Source的信息。 Android.mk将是GNU Makefile的一部分，且将被Build System解析一次或屡次。因此，请尽可能少的在Android.mk中声明变量，也不要假定任何东西不会在解析过程当中定义。

Android.mk文件语法容许咱们将Source打包成一个"modules". modules能够是： 静态库 动态库。

只有动态库能够被 install/copy到应用程序包(APK). 静态库则能够被连接入动态库。 能够在一个Android.mk中定义一个或多个modules. 也能够将同一份source 加进多个modules.

Build System帮咱们处理了不少细节而不须要咱们再关心。例如：你不须要在Android.mk中列出头文件和外部依赖文件。NDK Build System自动帮咱们提供这些信息。这也意味着，当用户升级NDK后，你将能够受益于新的toolchain/platform而没必要再去修改Android.mk.

2. Android.mk语法：

首先看一个最简单的Android.mk的例子：

LOCAL_PATH := $(call my-dir)

include $(CLEAR_VARS)

LOCAL_MODULE    := hello-jni
LOCAL_SRC_FILES := hello-jni.c

include $(BUILD_SHARED_LIBRARY)
复制代码

讲解以下:
LOCAL_PATH := $(call my-dir)
每一个Android.mk文件必须以定义LOCAL_PATH为开始。它用于在开发tree中查找源文件。 宏my-dir 则由Build System提供。返回包含Android.mk的目录路径。

include $(CLEAR_VARS)
CLEAR_VARS 变量由Build System提供。并指向一个指定的GNU Makefile，由它负责清理不少LOCAL_xxx. 例如：LOCAL_MODULE, LOCAL_SRC_FILES, LOCAL_STATIC_LIBRARIES等等。但不清理LOCAL_PATH. 这个清理动做是必须的，由于全部的编译控制文件由同一个GNU Make解析和执行，其变量是全局的。因此清理后才能避免相互影响。

LOCAL_MODULE := hello-jni
LOCAL_MODULE模块必须定义，以表示Android.mk中的每个模块。名字必须惟一且不包含空格。Build System会自动添加适当的前缀和后缀。例如，foo，要产生动态库，则生成libfoo.so. 但请注意：若是模块名被定为：libfoo.则生成libfoo.so. 再也不加前缀。

LOCAL_MODULE := hello-jni.c
LOCAL_SRC_FILES变量必须包含将要打包如模块的C/C++ 源码。没必要列出头文件，build System 会自动帮咱们找出依赖文件。 缺省的C++源码的扩展名为.cpp. 也能够修改，经过LOCAL_CPP_EXTENSION。

include (BUILD_SHARED_LIBRARY)
BUILD_SHARED_LIBRARY：是Build System提供的一个变量，指向一个GNU Makefile Script。它负责收集自从上次调用 include $(CLEAR_VARS)后的全部LOCAL_XXX信息。并决定编译为何。

BUILD_STATIC_LIBRARY：编译为静态库。
BUILD_SHARED_LIBRARY ：编译为动态库
BUILD_EXECUTABLE：编译为Native C可执行程序

3.NDK Build System变量：

NDK Build System 保留如下变量名：
以LOCAL_ 为开头的
以PRIVATE_ ,NDK_ 或者APP_ 开头的名字。
小写字母名字：如my-dir

若是想要定义本身在Android.mk中使用的变量名，建议添加 ＭＹ＿ 前缀。

3.一、 NDK提供的变量：

此类GNU Make变量是NDK Build System在解析Android.mk以前就定义好了的。

3.1.1: CLEAR_VARS : 指向一个编译脚本。必须在新模块前包含之。
include $(CLEAR_VARS)

3.1.2: BUILD_SHARED_LIBRARY: 指向一个编译脚本，它收集自从上次调用 include $(CLEAR_VARS) 后的全部LOCAL_XXX信息。并决定如何将你列出的Source编译成一个动态库。 注意，在包含此文件前，至少应该包含：LOCAL_MODULE and LOCAL_SRC_FILES

例如： include $(BUILD_SHARED_LIBRARY)

3.1.3：BUILD_STATIC_LIBRARY： 与前面相似，它也指向一个编译脚本，收集自从上次调用 include $(CLEAR_VARS) 后的全部LOCAL_XXX信息。并决定如何将你列出的Source编译成一个静态库。 静态库不可以加入到Project 或者APK中。但它能够用来生成动态库。 LOCAL_STATIC_LIBRARIES and LOCAL_WHOLE_STATIC_LIBRARIES将描述之。

include $(BUILD_STATIC_LIBRARY)

3.1.4: BUILD_EXECUTABLE
与前面相似，它也指向一个编译脚本 include $(CLEAR_VARS)

3.1.5：PREBUILT_SHARED_LIBRARY：把这个共享库声明为 “一个” 独立的模块。
指向一个build 脚本，用来指定一个预先编译好多动态库。 与BUILD_SHARED_LIBRARY and BUILD_STATIC_LIBRARY不一样，此时模块的LOCAL_SRC_FILES应该被指定为一个预先编译好的动态库，而非source file.
LOCAL_PATH:= (CLEAR_VARS)
LOCAL_MODULE := foo-prebuilt # 模块名
LOCAL_SRC_FILES := libfoo.so # 模块的文件路径（相对于 LOCAL_PATH）

include $(PREBUILT_SHARED_LIBRARY) # 注意这里不是 BUILD_SHARED_LIBRARY

这个共享库将被拷贝到 PROJECT/libs/(stripped) 主要是用在将已经编译好的第三方库使用在本Android Project中。为何不直接将其COPY到libs/armabi目录呢？由于这样作缺陷不少。下一节再详细说明。

2.1.6: PREBUILT_STATIC_LIBRARY: 预先编译的静态库。 同上。

2.1.7: TARGET_ARCH:
目标ＣＰＵ架构名。若是为 “arm” 则声称ARM兼容的指令。 与CPU架构版本无关。

2.1.8: TARGET_PLATFORM: 目标平台的名字。

2.1.9：TARGET_ARCH_ABI
Name of the target CPU+ABI
armeabi For ARMv5TE
armeabi-v7a

2.1.10：TARGET_ABI

2.2: NDK提供的功能宏：

GNU Make 提供的功能宏，只有经过相似： $(call function)
的方式来获得其值，它将返回文本化的信息。

2.2.1: my-dir:
(call my-dir)
请注意：返回的是最近一次include的Makefile的路径。因此在Include其它Makefile后，再调用$(call my-dir)会返回其它Android.mk 所在路径。

例如：

LOCAL_PATH := $(call my-dir)
 ... declare one module 
 include $(LOCAL_PATH)/foo/Android.mk 
 LOCAL_PATH := $(call my-dir) 
 ... declare another module
复制代码

则第二次返回的LOCAL_PATH 为：PATH.

2.2.2: all-subdir-makefiles:
返回一个列表，包含'my-dir 中全部子目录中的Android.mk。

例如： 结构以下：

sources/foo/Android.mk 
sources/foo/lib1/Android.mk 
sources/foo/lib2/Android.mk
在If sources/foo/Android.mk 中，
include $(call all-subdir-makefiles)
复制代码

那则自动include 了sources/foo/lib1/Android.mk and sources/foo/lib2/Android.mk。

2.2.3：this-makefile：
当前Makefile的路径。

2.2.4：parent-makefile：
返回include tree中父Makefile 路径。 也就是include 当前Makefile的Makefile Path。

2.2.5：import-module：
容许寻找并inport其它modules到本Android.mk中来。
它会从NDK_MODULE_PATH寻找指定的模块名。
$(call import-module,)

2.3: 模块描述变量：

此类变量用来给Build System描述模块信息。在'include (BUILD_XXXXX)'之间。必须定义此类变量。

include $(CLEAR_VARS) script用来清空这些变量。

include $(BUILD_XXXXX)收集和使用这些变量。

2.3.1: LOCAL_PATH:
这个值用来给定当前目录。必须在Android.mk的开是位置定义之。
例如：
LOCAL_PATH := (CLEAR_VARS) 清理。

2.3.2: LOCAL_MODULE:
modules名。在include $(BUILD_XXXXX)以前，必须定义这个变量。此变量必须惟一且不能有空格。

一般，由此变量名决定最终生成的目标文件名。

2.3.3: LOCAL_MODULE_FILENAME:
可选。用来override LOCAL_MODULE. 即容许用户从新定义最终生成的目标文件名。

LOCAL_MODULE := foo-version-1
LOCAL_MODULE_FILENAME := libfoo

2.3.4：LOCAL_SRC_FILES：
为Build Modules而提供的Source 文件列表。不须要列出依赖文件。
注意：文件相对于LOCAL_PATH存放，且能够提供相对路径。
例如：
LOCAL_SRC_FILES := foo.c \ toto/bar.c

2.3.5: LOCAL_CPP_EXTENSION:
指出C++ 扩展名。(可选)
LOCAL_CPP_EXTENSION := .cxx
从NDK R7后，能够写多个：
LOCAL_CPP_EXTENSION := .cxx .cpp .cc

2.3.6：LOCAL_CPP_FEATURES：
可选。用来指定C++ features。

LOCAL_CPP_FEATURES := rtti
LOCAL_CPP_FEATURES := exceptions
复制代码

2.3.7：LOCAL_C_INCLUDES：
一个可选的path列表。相对于NDK ROOT 目录。编译时，将会把这些目录附上。

LOCAL_C_INCLUDES := sources/foo 
LOCAL_C_INCLUDES := $(LOCAL_PATH)/../foo
复制代码

2.3.8: LOCAL_CFLAGS:
一个可选的设置，在编译C/C++ source 时添加如Flags。 用来附加编译选项。 注意：不要尝试在此处修改编译的优化选项和Debug等级。它会经过您Application.mk中的信息自动指定。

也能够指定include 目录经过：LOCAL_CFLAGS += -I。 这个方法比使用LOCAL_C_INCLUDES要好。由于这样也能够被ndk-debug使用。

2.3.9: LOCAL_CXXFLAGS:
LOCAL_CPPFLAGS的别名。

2.3.10: LOCAL_CPPFLAGS:
C++ Source 编译时添加的C Flags。这些Flags将出如今LOCAL_CFLAGS flags 的后面。

2.3.11: LOCAL_STATIC_LIBRARIES:
要连接到本模块的静态库list。(built with BUILD_STATIC_LIBRARY)

2.3.12: LOCAL_SHARED_LIBRARIES:
要连接到本模块的动态库。

2.3.13：LOCAL_WHOLE_STATIC_LIBRARIES:
静态库全连接。 不一样于LOCAL_STATIC_LIBRARIES，相似于使用--whole-archive

2.3.14：LOCAL_LDLIBS:
linker flags。 能够用它来添加系统库。 如 -lz: LOCAL_LDLIBS := -lz

2.3.15: LOCAL_ALLOW_UNDEFINED_SYMBOLS:

2.3.16: LOCAL_ARM_MODE:
缺省模式下，ARM目标代码被编译为thumb模式。每一个指令16位。若是指定此变量为：arm。 则指令为32位。
LOCAL_ARM_MODE := arm

其实也能够指定某一个或者某几个文件的ARM指令模式。

2.3.17: LOCAL_ARM_NEON:
设置为true时，会讲浮点编译成neon指令。这会极大地加快浮点运算(前提是硬件支持) 只有targeting 为 'armeabi-v7a'时才能够。

2.3.18：LOCAL_DISABLE_NO_EXECUTE：

2.3.19: LOCAL_EXPORT_CFLAGS: 定义这个变量用来记录C/C++编译器标志集合，而且会被添加到其余任何以LOCAL_STATIC_LIBRARIES和LOCAL_SHARED_LIBRARIES的模块的LOCAL_CFLAGS定义中

LOCAL_SRC_FILES := foo.c bar.c.arm

附1： Android.mk与jni目录的关系：
在某目录下，如/src/modules1/下存放Android.mk和Application.mk，调用ndk-build试图编译时，会遇到以下错误：
Android NDK: Could not find application project directory !
Android NDK: Please define the NDK_PROJECT_PATH variable to point to it.
/opt/android-ndk-r9d/build/core/build-local.mk:148: *** Android NDK: Aborting . Stop.

这是由于，当前Android.mk 未放置在jni目录内。因此ndk-build没法找到Android.mk. (ndk-build会今后目录向上一直找到jni目录，并从jni目录中找到Android.mk)且NDK_PROJECT_PATH， APP_BUILD_SCRIPT， NDK_APPLICATION_MK 是一个空的值。
如何解决这个问题呢。首先固然是建立jni目录，并在其中添加Android.mk和Application.mk.

但另外一方面，也能够显性的指出这三个值：
目录结构以下：
/src/modules1/Android.mk
在此目录下：
/opt/android-ndk-r9d/ndk-build -B V=1 NDK_PROJECT_PATH=. APP_BUILD_SCRIPT=./Android.mk NDK_APPLICATION_MK=./Application.mk

也能够正常编译。

注意：此处NDK版本为NDK R7C.（不一样NDK版本，ndk-build所产生的Makefile并不彻底相同)