1.Android.mk文件
1.简介:
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为开始。它用于在项目树中查找源文件(所以这里应该指定源文件路径,本例中源文件路径是和Android.mk文件路径在同一目录下的)。
宏my-dir则由Build System提供。返回Android.mk的目录路径。
inclue $(CLEAR_VARS)
CLEAR_VARS变量由Build System提供。并指向一个指定的GNU Makefile,由它负责清理很多的LOCAL_xxx。
例如:LOCAL_MODULE, LOCAL_SRC_FILES, LOCAL_STATIC_LIBRARIES等等。但不清理LOCAL_PATH。
这个清理动作是必须的,因为所有的编译控制文件由同一个GNU Make解析和执行,其变量是全局的。所以清理后才能避免相互影响。相当于是解析此mk文件的时候GNU Make相关的全局变量会被赋值,如果其他mk文件没有指定某个LOCAL_xxx,那么make相应的全局变量会继续沿用之前mk文件的赋值,因此相互产生影响。
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提供的一个变量,指向一个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中使用的变量名,建议添加 MY_前缀。
4.NDK提供的变量:
此类GNU Make变量是NDK Build System在解析Android.mk之前就定义好了的。
4.1:CLEAR_VARS:
指向一个编译脚本。必须在新模块前包含之。
include $(CLEAR_VARS)
4.2:BUILD_SHARED_LIBRARY:
指向一个编译脚本,它收集自从上次调用 include $(CLEAR_VARS) 后的所有LOCAL_XXX信息。
并决定如何将你列出的Source编译成一个动态库。 注意,在包含此文件前,至少应该包含:LOCAL_MODULE and LOCAL_SRC_FILES 例如:
include $(BUILD_SHARED_LIBRARY)
4.3:BUILD_STATIC_LIBRARY:
与前面类似,它也指向一个编译脚本,
收集自从上次调用 include $(CLEAR_VARS) 后的所有LOCAL_XXX信息。
并决定如何将你列出的Source编译成一个静态库。 静态库不能够加入到Project 或者APK中。但它可以用来生成动态库。LOCAL_STATIC_LIBRARIES and LOCAL_WHOLE_STATIC_LIBRARIES将描述之。
include $(BUILD_STATIC_LIBRARY)
4.4: BUILD_EXECUTABLE:
与前面类似,它也指向一个编译脚本,收集自从上次调用 include $(CLEAR_VARS) 后的所有LOCAL_XXX信息。 并决定如何将你列出的Source编译成一个可执行Native程序。
include $(BUILD_EXECUTABLE)
4.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/<abi> (stripped) 主要是用在将已经编译好的第三方库
使用在本Android Project中。为什么不直接将其COPY到libs/armabi目录呢?因为这样做缺陷很多。下一节再详细说明。
4.6: PREBUILT_STATIC_LIBRARY: 预先编译的静态库。 同上。
4.7: TARGET_ARCH: 目标CPU架构名。如果为 “arm” 则声称ARM兼容的指令。与CPU架构版本无关。
4.8: TARGET_PLATFORM: 目标平台的名字。
4.9:TARGET_ARCH_ABI:
Name of the target CPU+ABI
armeabi For ARMv5TE armeabi-v7a
4.10:TARGET_ABI
5.NDK提供的功能宏
GNU Make 提供的功能宏,只有通过类似:(call function)的方式来得到其值,它将返回文本化的信息。
5.1:my-dir:$(call my-dir)
返回最近一次include的Makefile的路径。通常返回Android.mk所在的路径。它用来作为Android.mk开头的来定义LOCAL_PATH。LOCAL_PATH := $(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/foo。而非$PATH.
与前面类似,它也指向一个编译脚本,收集自从上次调用 include $(CLEAR_VARS) 后的所有LOCAL_XXX信息。 并决定如何将你列出的Source编译成一个可执行Native程序。
5.2:all-subdir-makefiles:
返回一个列表,包含‘my-dir’中所有子目录中的Android.mk。
例如:结构如下:
sources/foo/Android.mk
sources/foo/lib1/Android.mk
sources/foo/lib2/Android.mk
在sources/foo/Android.mk中include $(call all-subdir-makefiles)
则相当于includele了:
include sources/foo/lib1/Android.mk
include sources/foo/lib2/Android.mk
5.3:this-makefile:
当前Makefile的路径。
5.4:parent-makefile:
返回include tree中父Makefile路径。也就是include当前Makefile的Makefile path。
5.5:import-module:
允许寻找并import其他modules到本Android.mk中来。他会从NDK_MODULE_PATH寻找指定的模块名。
$(call import-module,<name>)
6.模块描述变量:
此类变量名用来给Build System描述模块信息。在'include $(CLEAR_VARS)'和'include $(BUILD_xxxx)'之间。必须定义此类变量。
include $(CLEAR_VARS) script用来清理这些变量。
include $(BUILD_xxxx) 收集和使用这些变量。
6.1:LOCAL_PATH:
这个值来给定当前目录。必须在Android.mk的开始位置定义。
例如:LOCAL_PATH := $(call my-dir) LOCAL_PATH不会被include $(CLEAR_VARS)清理。6.2: LOCAL_MODULE:
6.2: LOCAL_MODULE:
modules名。在include $(BUILD_XXXXX)之前,必须定义这个变量。此变量必须唯一且不能有空格。
通常,由此变量名决定最终生成的目标文件名。
6.3: LOCAL_MODULE_FILENAME:
可选。用来override LOCAL_MODULE. 即允许用户重新定义最终生成的目标文件名。
LOCAL_MODULE := foo-version-1 LOCAL_MODULE_FILENAME := libfoo
6.4:LOCAL_SRC_FILES:
为Build Modules而提供的Source 文件列表。不需要列出依赖文件。 注意:文件相对于LOCAL_PATH存放,
且可以提供相对路径。 例如:
LOCAL_SRC_FILES := foo.c \ toto/bar.c
6.5: LOCAL_CPP_EXTENSION:
指出C++ 扩展名。(可选)
LOCAL_CPP_EXTENSION := .cxx 从NDK R7后,可以写多个:
LOCAL_CPP_EXTENSION := .cxx .cpp .cc
6.6:LOCAL_CPP_FEATURES:
可选。用来指定C++ features。
LOCAL_CPP_FEATURES := rtti
LOCAL_CPP_FEATURES := exceptions
6.7:LOCAL_C_INCLUDES:
一个可选的path列表。相对于NDK ROOT 目录。编译时,将会把这些目录附上。
LOCAL_C_INCLUDES := sources/foo LOCAL_C_INCLUDES := $(LOCAL_PATH)/../foo
6.8: LOCAL_CFLAGS:
一个可选的设置,在编译C/C++ source 时添加如Flags。
用来附加编译选项。 注意:不要尝试在此处修改编译的优化选项和Debug等级。它会通过您Application.mk中的信息自动指定。
也可以指定include 目录通过:LOCAL_CFLAGS += -I<path>。 这个方法比使用LOCAL_C_INCLUDES要好。因为这样也可以被ndk-debug使用。
6.9: LOCAL_CXXFLAGS:
LOCAL_CPPFLAGS的别名。
6.10: LOCAL_CPPFLAGS:
C++ Source 编译时添加的C Flags。这些Flags将出现在LOCAL_CFLAGS flags 的后面。
6.11: LOCAL_STATIC_LIBRARIES:
要链接到本模块的静态库list。(built with BUILD_STATIC_LIBRARY)
6.12: LOCAL_SHARED_LIBRARIES:
要链接到本模块的动态库。
6.13:LOCAL_WHOLE_STATIC_LIBRARIES:
静态库全链接。 不同于LOCAL_STATIC_LIBRARIES,类似于使用--whole-archive
6.14:LOCAL_LDLIBS:
linker flags。 可以用它来添加系统库。 如 -lz:
LOCAL_LDLIBS := -lz
6.15: LOCAL_ALLOW_UNDEFINED_SYMBOLS:
6.16: LOCAL_ARM_MODE:
缺省模式下,ARM目标代码被编译为thumb模式。每个指令16位。如果指定此变量为:arm。 则指令为32位。
LOCAL_ARM_MODE := arm 其实也可以指定某一个或者某几个文件的ARM指令模式。
6.17: LOCAL_ARM_NEON:
设置为true时,会讲浮点编译成neon指令。这会极大地加快浮点运算(前提是硬件支持)
只有targeting 为 'armeabi-v7a'时才可以。
6.18:LOCAL_DISABLE_NO_EXECUTE:
6.19: LOCAL_EXPORT_CFLAGS:
定义这个变量用来记录C/C++编译器标志集合,
并且会被添加到其他任何以LOCAL_STATIC_LIBRARIES和LOCAL_SHARED_LIBRARIES的模块的LOCAL_CFLAGS定义中 LOCAL_CFLAG定义中LOCAL_SRC_FILES := foo.c bar.c
7.Android.mk文件的使用实例
Android.mk是一个NDK项目必备组件。
7.1:构建多个动态共享库:
LOCAL_PATH := $(call my-dir)
#模块1
include $(CLEAR_VARS)
LOCAL_MODULE := module1
LOCAL_SRC_FILES := module1.c
include $(BUILD_SHARED_LIBRARY)
#模块2
include $(CLEAR_VARS)
LOCAL_MODULE := module2
LOCAL_SRC_FILES := module2.c
include $(BUILD_SHARED_LIBRARY)
此mk文件被ndk编译后会生成两个动态共享库文件。
7.2:构建多个静态共享库:
上文提到只有动态库.so才能被install/copy进应用程序包,那编译的静态库一般是链接进动态共享库中的。
LOCAL_PATH := $(call my-dir)
#第三方库
include $(CLEAR_VARS)
LOCAL_MODULE := jsoncpp
LOCAL_SRC_FILES := jsoncpp.cpp
include $(BUILD_STATIC_LIBRARY)
#原生模块
include $(CLEAR_VARS)
LOCAL_MODULE := module
LOCAL_SRC_FILES := module.c
LOCAL_STATIC_LIBRARIES := jsoncpp
include $(BUILD_SHARED_LIBRARY)
7 .3:共享库通用模块:
LOCAL_PATH := $(call my-dir)
#第三方库
include $(CLEAR_VARS)
LOCAL_MODULE := jsoncpp
LOCAL_SRC_FILES := jsoncpp.cpp
include $(BUILD_SHARED_LIBRARY)
#模块1
include $(CLEAR_VARS)
LOCAL_MODULE := module1
LOCAL_SRC_FILES := module1.c
LOCAL_SHARED_LIBRARIES := jsoncpp
include $(BUILD_SHARED_LIBRARY)
#模块2
include $(CLEAR_VARS)
LOCAL_MODULE := module2
LOCAL_SRC_FILES := module2.c
LOCAL_SHARED_LIBRARIES := jsoncpp
include $(BUILD_SHARED_LIBRARY)
7.4:多个NDK项目间共享模块:
同时使用动态库和静态库时,可以在模块间共享通用代码,但这些必须在同一个NDK项目中,将共享库模块移动到NDK项目以外的其他目录本身的Android.mk文件
LOCAL_PATH := $(call my-dir)
#第三方库
include $(CLEAR_VARS)
LOCAL_MODULE := jsoncpp
LOCAL_SRC_FILES := jsoncpp.cpp
include $(BUILD_SHARED_LIBRARY)
为了避免构建系统冲突,应该将import-module函数宏放在Android.mk末尾
LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
LOCAL_MODULE := module1
LOCAL_SRC_FILES := module1.c
LOCAL_SHARED_LIBRARIES := jsoncpp
include $(BUILD_SHARED_LIBRARY)
$(call import-module,code/jsoncpp)
import-module函数宏先定位共享模块,再将它导入到NDK项目中。
7.5:Prebuilt库:
使用共享库的时候要求有共享库的源代码,Android NDK构建系统简单的把这些源文件包含在NDK项目中再次构建它们
预构建共享模块的Android.mk文件
LOCAL_PATH := $(call my-dir)
#第三方库
include $(CLEAR_VARS)
LOCAL_MODULE := jsoncpp
LOCAL_SRC_FILES := libjsoncpp.so
include $(PREBUILT_SHARED_LIBRARY)
注意:Prebuilt库定义中不包含任何关于该库所构建的实际机器体系结构的信息,开发人员要确保Prebuilt库是为了与NDK项目相同的机器体系构建的
PREBUILT_SHARED_LIBRARY变量纸箱prebuilt-shared-library.mk Makefile片段。它什么都没有构建,但是它将Prebuilt库复制到了NDK项目的libs目录下。通过使用PREBUILT_STATIC_LIBRARY变量,静态库可以像共享库一样被用作Prebuilt库,NDK项目可以想普通共享库一样使用Prebuilt库了
LOCAL_SHARED_LIBRARIES :=jsoncpp
7.6:构建独立可执行模块:
为了方便测试,Android NDK也支持构建独立的可执行文件
LOCAL_PATH := $(call my-dir)
#模块
include $(CLEAR_VARS)
LOCAL_MODULE := module
LOCAL_SRC_FILES := module.c
include $(BUILD_EXECUTABLE)
BUILD_EXECUTABLE变量指向build-executable.mk Makefile片段。
7.7:其他构建系统变量
TARGET_ARCH:目标CPU体系结构的名称,例如arm
TARGET_PLATFORM:目标Android平台的名称,例如:android-3
TARGET_ARCH_ABI:目标CPU体系结构和ABI的名称,例如:armeabi-v7a
TARGET_ABI:目标平台和ABI的串联,例如:android-3-armeabi-v7a
LOCAL_MODULE_FILENAME:可选变量,用来重新定义生成的输出文件名称,默认情况下,构建系统使用LOCAL_MODULE的值来作为生成的输出文件名称,使用此变量可以覆盖
LOCAL_CPP_EXTENSION:C++源文件的扩展名为.cpp,这个变量可以用来为C++源代码指定一个或多个扩展名
LOCAL_CPP_EXTENSION := .cpp cxx
LOCAL_CPP_FEATURES:可选变量,用来指明模块所依赖的具体C++特性,如RTTI,exceptions等
LOCAL_CPP_FEATURES := rtti
LOCAL_C_INCLUDES:可选目录列表,NDK安装目录的相对路径,用来搜索头文件
LOCAL_C_INCLUDES := sources/shared-module
LOCAL_C_INCLUDES := $(LOCAL_PATH)/include
LOCAL_CFLAGS:一组可选的编译器标志,在编译C和C++源文件的时候会被传送给编译器
LOCAL_CFLAGS := -DNDEBUG -DPORT=1234
LOCAL_CPP_FLAGS:一组可选的编译器标志,在编译C++源文件的时候会被传送给编译器
LOCAL_WHOLE_STATIC_LIBRARIES:LOCAL_STATIC_LIBRARIES的变体,用来指明应该被包含在生成的共享库中所有静态库内容,几个静态库有循环依赖时,很有用
LOCAL_LDLIBS:链接标志的可选列表,当对目标文件进行链接以生成输出文件时该标志将被传送给链接器。它主要用于传送要进行动态链接的系统库列表,例如要与Android NDK日志库链接,使用以下代码
LOCAL_LDFLAGS := -llog
LOCAL_ALLOW_UNDEFINED_SYMBOLS:可选参数,它禁止在生成的文件中进行缺失符号检查,若没有定义,链接器会在符号缺失生成错误信息
LOCAL_ARM_MODE:可选参数,ARM机器体系结构特有变量,用于指定要生成的ARM二进制类型
LOCAL_ARM_MODE := arm
LOCAL_SRC_FILES := file.c file2.c.arm
LOCAL_ARM_NEON:可选参数,ARM机器体系特有变量,用来指定在源文件中使用的ARM高级单指令流内联函数
LOCAL_ARM_NEON := true
LOCAL_SRC_FILES := file.c file2.c.neon
LOCAL_DIABLE_NO_EXECUTE:可选变量,用来禁用NX Bit安全特性,用来隔离代码区和存储区,防止恶意软件通过将它的代码注入到应用程序的存储区来控制应用程序
LOCAL_DISABLE_NO_EXECUTE := true
LOCAL_EXPORT_CFLAGS:该变量记录一组编译器标志,这些编译器标志会被添加到通过变量LOCAL_STATIC_LIBRARIES或LOCAL_SHARED_LIBRARIES使用模块的其他模块LOCAL_CFLAGS定义中
LOCAL_MODULE := jsoncpp
...
LOCAL_EXPORT_CFLAGS := -DENABLE_AUDIO
...
LOCAL_MODULE := module
LOCAL_CFLAGS := -DDEBUG
...
LOCAL_SHARED_LIBRARIES := jsoncpp
编译器在构建module的时候会以-DENABLE_AUDIO -DDEBUG标志执行
LOCAL_EXPORT_CPPFLAGS:和LOCAL_EXPORT_CFLAGS一样,不过它是C++特定代码编译器标志
LOCAL_EXPORT_LDFLAGS:和LOCAL_EXPORT_CFLAGS一样,不过用作链接器标志
LOCAL_EXPORT_C_INCLUDES:该变量运行记录路径集,这些路径会被添加到通过变量LOCAL_STATIC_LIBRARIES或LOCAL_SHARED_LIBRARIES使用该模块的LOCAL_C_INCLUDES定义中
LOCAL_SHORT_COMMANDS:对于有大量的资源或独立的静态/共享库的模块,该变量应该被设置为true
LOCAL_FILTER_ASM:该变量定义了用于过滤来自LOCAL_SRC_FILES变量的装配文件的应用程序
7.8:其他的构建系统函数宏:
all-subdir-makefiles:返回当前目录的所有子目录下的Android.mk构建文件列表,例如,调用一下命令可以将子目录下的所有Android.mk文件包含在构建过程中:
include $(call all-subdir-makefiles)
this-makefile:返回当前Android.mk构建文件的路径
parent-makefile:返回包含当前构建文件的父Android.mk构建文件的路径
grand-parent-makefile:和parent-makefile一样但用于祖父目录
7.9:定义新变量:
...
MY_SRC_FILES ;= jsoncpp.cpp
LOCAL_SRC_FILES := $(addprefix jsoncpp/,$(MY_SRC_FILES))
...
7.10:条件操作:
...
ifeq ($(TARGET_ARCH),arm)
LOCAL_SRC_FILES += abc.c
else
LOCAL_SRC_FILES += xyz.c
endif
...
2.Application.mk文件
它是Android NDK构建系统使用的一个可选的构建文件,也是一个GNU Makefile片段下面是Application.mk构建文件支持的变量:
APP_MODULES:默认情况下,Android NDK构建系统构建Android.mk文件声明的所有模块。
该变量可以覆盖上述行为并提供一个空格分开的,需要被构建的模块列表
APP_OPTIM:该变量可以设置为release和debug来改变生成的二进制文件的优化级别,
默认为release模式。
APP_CLAGS:列出编译器标识,在编译任何模块的C和C++源文件时这些标志都会被传给编译器
APP_CPPFLAGS:列出编译器标识,在编译任何模块的C++源文件时这些标志都会被传给编译器
APP_BUILD_SCRIPT:默认情况下,Android NDK构建系统在项目的JNI子目录下查找Android.mk构建文件。
可以用该变量改变上述行为,并使用不同的生成文件
APP_ABI:默认情况下,Android NDK构建系统为armeabi ABI生成二进制文件,
可以用该变量改变上述行为,并为其他ABI生成二进制文件:例如
APP_ABI := mips
另外可以设置多个ABI
APP_ABI := armeabi mips
为所有支持的ABI生成二进制文件
APP_ABI := all
APP_STL:默认情况下,Android NDK构建系统使用最小
STL运行库,也被成为system库。可以用该变量选择不同的
STL实现。
APP_STL := stlport_shared
APP_GNUSTL_FORCE_CPP_FEATURES:与LOCAL_CPP_EXTENSIONS变量类似,改变量表明所有模
块都依赖于具体的C++特性,如RTTI,exceptions等。
APP_SHORT_COMMANDS:与LOCAL_SHORT_COMMANDS变量相似,该变量使得构建
系统存在有大量源文件的情况下可以在项目里使用更短的命令。