浅析Android.mk
Android.mk简介:
Android.mk文件用来告知NDKBuild系统关于Source的信息。Android.mk将是GNUMakefile的一部分,且将被BuildSystem解析一次或多次。
所以,请尽量少的在Android.mk中声明变量,也不要假定任何东西不会在解析过程中定义。
Android.mk文件语法允许我们将Source打包成一个"modules".modules可以是:
静态库
动态库。
只有动态库可以被install/copy到应用程序包(APK).静态库则可以被链接入动态库。
可以在一个Android.mk中定义一个或多个modules.也可以将同一份source加进多个modules.
BuildSystem帮我们处理了很多细节而不需要我们再关心。例如:你不需要在Android.mk中列出头文件和外部依赖文件。
NDKBuildSystem自动帮我们提供这些信息。这也意味着,当用户升级NDK后,你将可以受益于新的toolchain/platform而不必再去修改Android.mk.
Android.mk语法:
首先看一个最简单的Android.mk的例子:
LOCAL_PATH:=$(callmy-dir) include$(CLEAR_VARS) LOCAL_MODULE:=hello-jni LOCAL_SRC_FILES:=hello-jni.c include$(BUILD_SHARED_LIBRARY)
讲解如下:
LOCAL_PATH:=$(callmy-dir)
每个Android.mk文件必须以定义LOCAL_PATH为开始。它用于在开发tree中查找源文件。
宏my-dir则由BuildSystem提供。返回包含Android.mk的目录路径。
include$(CLEAR_VARS)
CLEAR_VARS变量由BuildSystem提供。并指向一个指定的GNUMakefile,由它负责清理很多LOCAL_xxx.
例如:LOCAL_MODULE,LOCAL_SRC_FILES,LOCAL_STATIC_LIBRARIES等等。但不清理LOCAL_PATH.
这个清理动作是必须的,因为所有的编译控制文件由同一个GNUMake解析和执行,其变量是全局的。所以清理后才能避免相互影响。
LOCAL_MODULE:=hello-jni
LOCAL_MODULE模块必须定义,以表示Android.mk中的每一个模块。名字必须唯一且不包含空格。
BuildSystem会自动添加适当的前缀和后缀。例如,foo,要产生动态库,则生成libfoo.so.但请注意:如果模块名被定为:libfoo.则生成libfoo.so.不再加前缀。
LOCAL_SRC_FILES:=hello-jni.c
LOCAL_SRC_FILES变量必须包含将要打包如模块的C/C++源码。
不必列出头文件,buildSystem会自动帮我们找出依赖文件。
缺省的C++源码的扩展名为.cpp.也可以修改,通过LOCAL_CPP_EXTENSION。
include$(BUILD_SHARED_LIBRARY)
BUILD_SHARED_LIBRARY:是BuildSystem提供的一个变量,指向一个GNUMakefileScript。
它负责收集自从上次调用include$(CLEAR_VARS)后的所有LOCAL_XXX信息。并决定编译为什么。
BUILD_STATIC_LIBRARY:编译为静态库。
BUILD_SHARED_LIBRARY:编译为动态库
BUILD_EXECUTABLE:编译为NativeC可执行程序
一、Android.mk文件的用途
一个android子项目中会存在一个或多个Android.mk文件
1、单一的Android.mk文件
直接参考NDK的sample目录下的hello-jni项目,在这个项目中只有一个Android.mk文件
2、多个Android.mk文件
如果需要编译的模块比较多,我们可能会将对应的模块放置在相应的目录中,这样,我们可以在每个目录中定义对应的Android.mk文件(类似于上面的写法),最后,在根目录放置一个Android.mk文件,内容如下:
include$(callall-subdir-makefiles)
只需要这一行就可以了,它的作用就是包含所有子目录中的Android.mk文件
3、多个模块共用一个Android.mk
这个文件允许你将源文件组织成模块,这个模块中含有:
-静态库(.a文件)
-动态库(.so文件)
只有共享库才能被安装/复制到您的应用软件(APK)包中
include$(BUILD_STATIC_LIBRARY),编译出的是静态库
include$(BUILD_SHARED_LIBRARY),编译出的是动态库
二、自定义变量
以下是在Android.mk中依赖或定义的变量列表,可以定义其他变量为自己使用,但是NDK编译系统保留下列变量名:
-以LOCAL_开头的名字(例如LOCAL_MODULE)
-以PRIVATE_,NDK_或APP_开头的名字(内部使用)
-小写名字(内部使用,例如‘my-dir')
如果为了方便在Android.mk中定义自己的变量,建议使用MY_前缀,一个小例子:
MY_SOURCES:=foo.c ifneq($(MY_CONFIG_BAR),) MY_SOURCES+=bar.c endif LOCAL_SRC_FILES+=$(MY_SOURCES)
注意:‘:='是赋值的意思;'+='是追加的意思;‘$'表示引用某变量的值。
三、GNUMake系统变量
这些GNUMake变量在你的Android.mk文件解析之前,就由编译系统定义好了。注意在某些情况下,NDK可能分析Android.mk几次,每一次某些变量的定义会有不同。
(1)CLEAR_VARS:指向一个编译脚本,几乎所有未定义的LOCAL_XXX变量都在"Module-description"节中列出。必须在开始一个新模块之前包含这个脚本:include$(CLEAR_VARS),用于重置除LOCAL_PATH变量外的,所有LOCAL_XXX系列变量。
(2)BUILD_SHARED_LIBRARY:指向编译脚本,根据所有的在LOCAL_XXX变量把列出的源代码文件编译成一个共享库。
注意,必须至少在包含这个文件之前定义LOCAL_MODULE和LOCAL_SRC_FILES。
(3)BUILD_STATIC_LIBRARY:一个BUILD_SHARED_LIBRARY变量用于编译一个静态库。静态库不会复制到的APK包中,但是能够用于编译共享库。
示例:include$(BUILD_STATIC_LIBRARY)
注意,这将会生成一个名为lib$(LOCAL_MODULE).a的文件
(4)TARGET_ARCH:目标CPU平台的名字
(5)TARGET_PLATFORM:Android.mk解析的时候,目标Android平台的名字.详情可考/development/ndk/docs/stable-apis.txt.
android-3->OfficialAndroid1.5systemimages android-4->OfficialAndroid1.6systemimages android-5->OfficialAndroid2.0systemimages
(6)TARGET_ARCH_ABI:暂时只支持两个value,armeabi和armeabi-v7a。。
(7)TARGET_ABI:目标平台和ABI的组合,
四、模块描述变量
下面的变量用于向编译系统描述你的模块。应该定义在'include$(CLEAR_VARS)'和'include$(BUILD_XXXXX)'之间。$(CLEAR_VARS)是一个脚本,清除所有这些变量。
(1)LOCAL_PATH:这个变量用于给出当前文件的路径。
必须在Android.mk的开头定义,可以这样使用:LOCAL_PATH:=$(callmy-dir)
如当前目录下有个文件夹名称src,则可以这样写$(callsrc),那么就会得到src目录的完整路径
这个变量不会被$(CLEAR_VARS)清除,因此每个Android.mk只需要定义一次(即使在一个文件中定义了几个模块的情况下)。
(2)LOCAL_MODULE:这是模块的名字,它必须是唯一的,而且不能包含空格。
必须在包含任一的$(BUILD_XXXX)脚本之前定义它。模块的名字决定了生成文件的名字。
(3)LOCAL_SRC_FILES:这是要编译的源代码文件列表。
只要列出要传递给编译器的文件,因为编译系统自动计算依赖。注意源代码文件名称都是相对于LOCAL_PATH的,你可以使用路径部分,例如:
LOCAL_SRC_FILES:=foo.ctoto/bar.c\
Hello.c
文件之间可以用空格或Tab键进行分割,换行请用"\"
如果是追加源代码文件的话,请用LOCAL_SRC_FILES+=
注意:可以LOCAL_SRC_FILES:=$(callall-subdir-java-files)这种形式来包含local_path目录下的所有java文件。
(4)LOCAL_C_INCLUDES:可选变量,表示头文件的搜索路径。
默认的头文件的搜索路径是LOCAL_PATH目录。
(5)LOCAL_STATIC_LIBRARIES:表示该模块需要使用哪些静态库,以便在编译时进行链接。
(6)LOCAL_SHARED_LIBRARIES:表示模块在运行时要依赖的共享库(动态库),在链接时就需要,以便在生成文件时嵌入其相应的信息。
注意:它不会附加列出的模块到编译图,也就是仍然需要在Application.mk中把它们添加到程序要求的模块中。
(7)LOCAL_LDLIBS:编译模块时要使用的附加的链接器选项。这对于使用‘-l'前缀传递指定库的名字是有用的。
例如,LOCAL_LDLIBS:=-lz表示告诉链接器生成的模块要在加载时刻链接到/system/lib/libz.so
可查看docs/STABLE-APIS.TXT获取使用NDK发行版能链接到的开放的系统库列表。
(8)LOCAL_MODULE_PATH和LOCAL_UNSTRIPPED_PATH
在Android.mk文件中,还可以用LOCAL_MODULE_PATH和LOCAL_UNSTRIPPED_PATH指定最后的目标安装路径.
不同的文件系统路径用以下的宏进行选择:
TARGET_ROOT_OUT:表示根文件系统。
TARGET_OUT:表示system文件系统。
TARGET_OUT_DATA:表示data文件系统。
用法如:LOCAL_MODULE_PATH:=$(TARGET_ROOT_OUT)
至于LOCAL_MODULE_PATH和LOCAL_UNSTRIPPED_PATH的区别,暂时还不清楚。
(9)LOCAL_JNI_SHARED_LIBRARIES:定义了要包含的so库文件的名字,如果程序没有采用jni,不需要
LOCAL_JNI_SHARED_LIBRARIES:=libxxx这样在编译的时候,NDK自动会把这个libxxx打包进apk;放在youapk/lib/目录下
五、NDK提供的函数宏
GNUMake函数宏,必须通过使用'$(call)'来调用,返回值是文本化的信息。
(1)my-dir:返回当前Android.mk所在的目录的路径,相对于NDK编译系统的顶层。这是有用的,在Android.mk文件的开头如此定义:
LOCAL_PATH:=$(callmy-dir)
(2)all-subdir-makefiles:返回一个位于当前'my-dir'路径的子目录中的所有Android.mk的列表。
例如,某一子项目的目录层次如下:
src/foo/Android.mk
src/foo/lib1/Android.mk
src/foo/lib2/Android.mk
如果src/foo/Android.mk包含一行:
include$(callall-subdir-makefiles)
那么它就会自动包含src/foo/lib1/Android.mk和src/foo/lib2/Android.mk。
这项功能用于向编译系统提供深层次嵌套的代码目录层次。
注意,在默认情况下,NDK将会只搜索在src/*/Android.mk中的文件。
(3)this-makefile:返回当前Makefile的路径(即这个函数调用的地方)
(4)parent-makefile:返回调用树中父Makefile路径。即包含当前Makefile的Makefile路径。
(5)grand-parent-makefile:返回调用树中父Makefile的父Makefile的路径
六、Android.mk示例
#编译静态库 LOCAL_PATH:=$(callmy-dir) include$(CLEAR_VARS) LOCAL_MODULE=libhellos LOCAL_CFLAGS=$(L_CFLAGS) LOCAL_SRC_FILES=hellos.c LOCAL_C_INCLUDES=$(INCLUDES) LOCAL_SHARED_LIBRARIES:=libcutils LOCAL_COPY_HEADERS_TO:=libhellos LOCAL_COPY_HEADERS:=hellos.h include$(BUILD_STATIC_LIBRARY) #编译动态库 LOCAL_PATH:=$(callmy-dir) include$(CLEAR_VARS) LOCAL_MODULE=libhellod LOCAL_CFLAGS=$(L_CFLAGS) LOCAL_SRC_FILES=hellod.c LOCAL_C_INCLUDES=$(INCLUDES) LOCAL_SHARED_LIBRARIES:=libcutils LOCAL_COPY_HEADERS_TO:=libhellod LOCAL_COPY_HEADERS:=hellod.h include$(BUILD_SHARED_LIBRARY) #使用静态库 LOCAL_PATH:=$(callmy-dir) include$(CLEAR_VARS) LOCAL_MODULE:=hellos LOCAL_STATIC_LIBRARIES:=libhellos LOCAL_SHARED_LIBRARIES:= LOCAL_LDLIBS+=-ldl LOCAL_CFLAGS:=$(L_CFLAGS) LOCAL_SRC_FILES:=mains.c LOCAL_C_INCLUDES:=$(INCLUDES) include$(BUILD_EXECUTABLE) #使用动态库 LOCAL_PATH:=$(callmy-dir) include$(CLEAR_VARS) LOCAL_MODULE:=hellod LOCAL_MODULE_TAGS:=debug LOCAL_SHARED_LIBRARIES:=libclibcutilslibhellod LOCAL_LDLIBS+=-ldl LOCAL_CFLAGS:=$(L_CFLAGS) LOCAL_SRC_FILES:=maind.c LOCAL_C_INCLUDES:=$(INCLUDES) include$(BUILD_EXECUTABLE)