0. 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.
Android NDK构建系统是由多种GNU Makefile片段构成的。该构建系统包括基于渲染构建过程的不同类型NDK项目所需要的必要片段。这些构建系统片段可以
在Android NDK按照程序的build/core子目录中找到。虽然开发人员并不会直接接触这些文件,但知道他们的位置对与构建系统相关的故障很有帮助。
除了这些片段,Android NDK构建系统还要依赖另外两个文件Application.mk和Android.mk,这两个文件应该作为NDK项目的一部分由开发人员提供。
1. Android.mk语法:
Android.mk是一个向Android NDK构建系统描述NDK项目的GNU Makefile片段,它是每一个NDK项目的必备组件,构建系统希望它出现在jni子目录中。
首先看一个最简单的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提供(build\core\definitions.mk片段中定义)。返回包含Android.mk的目录路径。
include $(CLEAR_VARS)
CLEAR_VARS 变量由Build System提供(build\core\clear-vars.mk片段中定义)。并指向一个指定的GNU Makefile,由它负责清理除了LOCAL_PATH以外的LOCAL_变量.
例如: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_SRC_FILES := hello-jni.c
LOCAL_SRC_FILES变量必须包含将要打包如模块的C/C++ 源码。不必列出头文件,build System 会自动帮我们找出依赖文件。缺省的C++源码的扩展名为.cpp. 也可以修改,通过LOCAL_CPP_EXTENSION。
include $(BUILD_SHARED_LIBRARY)
BUILD_SHARED_LIBRARY:是Build System提供的一个变量(build\core\build-shared-library.mk),指向一个GNU Makefile Script。
它负责收集自从上次调用include $(CLEAR_VARS)后的所有LOCAL_XXX信息。并决定编译为什么。
然后再看一个最简单的Android.mk的例子:构建多个共享库
LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
LOCAL_MODULE := model1
LOCAL_SRC_FILES := model1.c
include $(BUILD_SHARED_LIBRARY)
include $(CLEAR_VARS)
LOCAL_MODULE := model2
LOCAL_SRC_FILES := model2.c
include $(BUILD_SHARED_LIBRARY)
在处理完这个Android.mk构建文档之后,Android NDK构建系统会产生libmodel1.so和libmodel2.so两个共享库.
BUILD_STATIC_LIBRARY:编译为静态库。
BUILD_SHARED_LIBRARY :编译为动态库
BUILD_EXECUTABLE(build\core\build-executable.mk):编译为Native C可执行程序
注意:至此,Android.mk文件中定义的构建系统变量简单描述了原生项目。编译和生成实际模块的的构建系统还需要包含合适的构建系统片段,具体需要包含哪些片段取决于想要生成模块的类型。
2. NDK Build System变量:
NDK Build System 保留以下变量名:
以LOCAL_ 为开头的
以PRIVATE_ ,NDK_ 或者APP_ 开头的名字。
小写字母名字:如my-dir
如果想要定义自己在Android.mk中使用的变量名,建议添加 MY_ 前缀。
2.1: NDK提供的变量:
此类GNU Make变量是NDK Build System在解析Android.mk之前就定义好了的。
2.1.1:CLEAR_VARS:
指向一个编译脚本。必须在新模块前包含之。
include $(CLEAR_VARS)
2.1.2:BUILD_SHARED_LIBRARY:
指向一个编译脚本,它收集自从上次调用 include $(CLEAR_VARS) 后的所有LOCAL_XXX信息。
并决定如何将你列出的Source编译成一个动态库。 注意,在包含此文件前,至少应该包含:LOCAL_MODULE and LOCAL_SRC_FILES 例如:
include $(BUILD_SHARED_LIBRARY)
2.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)
2.1.4: BUILD_EXECUTABLE:
与前面类似,它也指向一个编译脚本,收集自从上次调用 include $(CLEAR_VARS) 后的所有LOCAL_XXX信息。
并决定如何将你列出的Source编译成一个可执行Native程序。
include $(BUILD_EXECUTABLE)
2.1.5:PREBUILT_SHARED_LIBRARY:
把这个共享库声明为 “一个” 独立的模块。
指向一个build 脚本,用来指定一个预先编译好多动态库。 与BUILD_SHARED_LIBRARY and BUILD_STATIC_LIBRARY不同,
此时模块的LOCAL_SRC_FILES应该被指定为一个预先编译好的动态库,而非source file.
LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
LOCAL_MODULE := foo-prebuilt # 模块名
LOCAL_SRC_FILES := libfoo.so # 模块的文件路径(相对于 LOCAL_PATH)
include $(PREBUILT_SHARED_LIBRARY) # 注意这里不是 BUILD_SHARED_LIBRARY
这个共享库将被拷贝到 $PROJECT/obj/local 和 $PROJECT/libs/ (stripped) 主要是用在将已经编译好的第三方库
使用在本Android Project中。为什么不直接将其COPY到libs/armabi目录呢?因为这样做缺陷很多。下一节再详细说明。
2.1.6: PREBUILT_STATIC_LIBRARY: 预先编译的静态库。 同上。
2.1.7: TARGET_ARCH: 目标CPU架构名。如果为 “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的路径。通常返回Android.mk所在的路径。它用来作为Android.mk的开头来定义LOCAL_PATH.
LOCAL_PATH :=
(
c
a
l
l
m
y
−
d
i
r
)
请
注
意
:
返
回
的
是
最
近
一
次
i
n
c
l
u
d
e
的
M
a
k
e
f
i
l
e
的
路
径
。
所
以
在
I
n
c
l
u
d
e
其
它
M
a
k
e
f
i
l
e
后
,
再
调
用
(call my-dir) 请注意:返回的是最近一次include的Makefile的路径。所以在Include其它Makefile后,再调用
(callmy−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 :=
(
c
a
l
l
m
y
−
d
i
r
)
.
.
.
d
e
c
l
a
r
e
a
n
o
t
h
e
r
m
o
d
u
l
e
则
第
二
次
返
回
的
L
O
C
A
L
P
A
T
H
为
:
(call my-dir) ... declare another module 则第二次返回的LOCAL_PATH 为:
(callmy−dir)...declareanothermodule则第二次返回的LOCALPATH 为:PATH/foo。 而非$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 $(CLEAR_VARS)’ 和 'include $(BUILD_XXXXX)'之间。必须定义此类变量。
include $(CLEAR_VARS) script用来清空这些变量。
include $(BUILD_XXXXX)收集和使用这些变量。
2.3.1: LOCAL_PATH:
这个值用来给定当前目录。必须在Android.mk的开是位置定义之。
例如: LOCAL_PATH := $(call my-dir) LOCAL_PATH不会被include $(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.7:LOCAL_EXPORT_C_INCLUDES:
编译某模块时,如果它依赖别的模块,那么别的模块的LOCAL_EXPORT*类的值,会自动加入到本模块。(但是反过来不会有作用)
2.3.8: LOCAL_CFLAGS:
一个可选的设置,在编译C/C++ source 时添加如Flags。
用来附加编译选项。 注意:不要尝试在此处修改编译的优化选项和Debug等级。它会通过您Application.mk中的信息自动指定。
也可以指定include 目录通过:LOCAL_CFLAGS += -I
2.3.8: LOCAL_EXPORT_CFLAGS:
编译某模块是,如果它依赖别的模块,那么别的模块的LOCAL_EXPORT*类的值,会自动加入到本模块。(但是反过来不会有作用)
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
2.3.20 LOCAL_WHOLE_STATIC_LIBRARIES:
LOCAL_STATIC_LIBRARIES的变体,用来指明应该被包含在生成的共享库中的所有静态库内容。
2.4 其他构建系统变量
TARGET_ARCH: 目标CPU体系结构的名称,例如arm
TARGET_PLATFORM: 目标Android平台的名称,例如android-18
TARGET_ARCH_ABI: 目标CPU体系结构和ABI的名称,例如armeabi-v7a
TARGET_ABI:目标平台和ABI的串联,例如: android-18-armeabi-v7a
2.5 其他的构建系统函数宏
all-subdir-makefile 返回当前目录的所有子目录下的Androi.mk构建文件列表
3. Application.mk
Application.mk是Android NDK构建系统使用的一个可选构建文件,和Android.mk文件一样,放在jni目录下
Application也是一个GNU Makefile片段。它的目的是描述应用程序需要哪些模块;它也定义所有模块的通用变量。
APP_MODULES:默认情况下,Android NDK构建系统构建Android.mk文件声明的所有模块。该变量可以覆盖上述行为并提供一个用空格分开的、需要被构建的模块列表
APP_OPTIM:该变量可以被设置为release或者debug以改变生成的二进制文件的优化级别。默认是release模式,并且此时生成的二进制文件被高度优化。
该变量设置为debug模式生成更容易调试的未优化二进制文件.
APP_CFLAGS:该变量列出了一些编译器标志,在编译任何模块的C和C++源文件时这些标志都被传给编译器
APP_CPPFLAGS:该变量列出了一些编译器标志,在编译任何模块的C++源文件时这些标志都被传给编译器
APP_BUILD_SCRIPT:默认情况下,Android NDK构建系统在项目的jni子目录下查找Android.mk构建文件。可以用该变量上述行为,
并使用不同的生成文件.
APP_ABI:默认情况下,Android NDK构建系统为armeabi ABI生成二进制文件,可以改变该变量改变上述行为,并为其他ABI生成一个或者多个二进制文件.
APP_STL:默认情况下,Android NDK构建系统使用最小运行库,也被称为system库,该变量选择不同的STL实现
APP_GNUSTL_FORCE_CPP_FEATURES:
APP_SHORT_COMMMANDS:
4.排除构建系统故障
ndk-build NDK_LOG =1便可启用构建系统内部状态日志功能.