探索黑客技术攻防,实战研究与安全创新

导航菜单

Android.mk文件语法规范详解

熟悉Linux的朋友对mk文件应该不陌生,在Android系统中的NDK编程同样涉及到这个问题。Android.mk编译文件是用来向AndroidNDK描述C/C++源代码文件的,本文将重点介绍其语法实现。

概述

Android.mk文件用来向编译系统描述你的源代码。具体来说,该文件是GNUMakefile的一部分,会被编译系统解析一次或更多次的build系统。因此,应尽量减少源码中声明的变量,不要认为某些变量在解析过程中不会被定义。这个文件的语法允许把源代码组织成模块,一个模块属于下列类型之一:静态库或共享库。只有共享库能被安装/复制到应用软件包,静态库能被用于生成共享库。我们可以在每一个Android.mk文件中定义一个或多个模块,也可以在几个模块中使用同一个源代码文件。

NDK编译系统会自动处理许多细节问题。例如,我们不需要在Android.mk中列出头文件和依赖文件,在升级NDK后,会得到新的toolchain/platform支持,不需要改变Android.mk文件。这个语法同公开发布的Android平台的开源代码很接近,但编译系统实现它们的方式却是不同的,这是有意这样设计的,可以让程序开发人员重用外部库的源代码更容易。

简单的例子

在描述语法细节之前,我们先看一个简单的helloworld的例子,比如下面的文件:


sources/helloworld/helloworld.c
sources/helloworld/Android.mk


helloworld.c是一个JNI共享库,实现返回helloworld字符串的原生方法。相应的Android.mk文件会像下面这样:


LOCAL_PATH:=$(callmy-dir)
include$(CLEAR_VARS)
LOCAL_MODULE:=helloworld
LOCAL_SRC_FILES:=helloworld.c
include$(BUILD_SHARED_LIBRARY)


我们解释一下这几行代码。

LOCAL_PATH:=$(callmy-dir):一个Android.mk文件首先必须定义好LOCAL_PATH变量,用于在开发树中查找源文件。在这个例子中,宏函数my-dir由编译系统提供,用于返回当前路径(即包含Android.mk文件的目录)。

include$(CLEAR_VARS):CLEAR_VARS由编译系统提供,指定让GNUMAKEFILE清除许多LOCAL_XXX变量(例如LOCAL_MODULE、LOCAL_SRC_FILES、LOCAL_STATIC_LIBRARIES等),除了LOCAL_PATH。这是必要的,因为所有的编译控制文件都在同一个GNUMAKE执行环境中,所有的变量都是全局的。

LOCAL_MODULE:=helloworld:LOCAL_MODULE变量必须定义,以标识在Android.mk文件中描述的每个模块。而且名称必须是唯一的,且不包含任何空格。编译系统会自动产生合适的前缀和后缀,比如一个被命名为foo的共享库模块,将会生成libfoo.so文件。如果把库命名为libhelloworld,编译系统将不会添加任何的lib前缀,也会生成libhelloworld.so文件,这是为了支持来源于Android平台的源代码的Android.mk文件。

LOCAL_SRC_FILES:=helloworld.c:LOCAL_SRC_FILES变量必须包含将要编译打包进模块中的C或C++源代码文件。我们不用在这里列出头文件和包含文件,因为编译系统会自动找出依赖型的文件,只需要列出直接传递给编译器的源代码文件就好。注意,默认的C++源码文件的扩展名是“.cpp”,虽然指定一个不同的扩展名也可以,只要定义LOCAL_DEFAULT_CPP_EXTENSION变量即可,但不要忘记开始的小圆点,也就是定义为“.cxx”,而不是“cxx”。

include$(BUILD_SHARED_LIBRARY):BUILD_SHARED_LIBRARY是编译系统提供的变量,指向一个GNUMakefile脚本(应该就是build/core目录下的shared_library.mk),负责收集自从上次调用include$(CLEAR_VARS)以来,定义在LOCAL_XXX变量中的所有信息,并且决定编译什么,如何正确地去做,并根据其规则生成静态库。在sources/samples目录下有更复杂一点的例子,写有注释的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变量在Android.mk文件解析之前,就由编译系统定义好了。在某些情况下,NDK可能分析Android.mk几次,每一次某些变量的定义会有不同。CLEAR_VARS:指向一个编译脚本,几乎所有未定义的LOCAL_XXX变量都在Module-description节中列出,必须在开始一个新模块之前包含这个脚本。

BUILD_SHARED_LIBRARY:指向编译脚本,收集所有在LOCAL_XXX变量中提供的信息,并且决定如何把列出的源代码文件编译成一个共享库。必须在包含这个文件之前定义LOCAL_MODULE和LOCAL_SRC_FILES,比如include$(BUILD_SHARED_LIBRARY),将生成一个名为lib$(LOCAL_MODULE).so的文件。BUILD_STATIC_LIBRARY:一个BUILD_SHARED_LIBRARY变量用于编译一个静态库。静态库不会复制到project/packages中,生成能够用于编译的共享库。比如include$(BUILD_STATIC_LIBRARY),将会生成一个名为lib$(LOCAL_MODULE).a的文件。TARGET_ARCH:目标CPU平台的名字,如同在Android开放源码中指定的那样。如果是ARM,表示要生成ARM兼容的指令,与CPU架构的修订版无关。

TARGET_PLATFORM:Android.mk解析的时候,目标Android平台的名字,详情可参考/development/ndk/docs/stable-apis.txt。

TARGET_ARCH_ABI:暂时只支持两个value,armeabi和armeabi-v7a。在现在的版本中,一般把这两个值简单的定义为ARM,通过Android平台内部对它重定义来获得更好的匹配。所有基于ARM的ABI都会把TARGET_ARCH定义成ARM,但是会有不同的TARGET_ARCH_ABI。

TARGET_ABI:目标平台和ABI的组合,它事实上被定义成$(TARGET_PLATFORM)-$(TARGET_ARCH_ABI),在想要在真实的设备中针对一个特别的目标系统进行测试时会有用。在默认的情况下,是android-3-arm。

下面是GNUMake的功能宏,必须通过使用$(call<function>)来求值,并返回文本化的信息。

my-dir:返回当前Android.mk所在的目录路径,相对于NDK编译系统的顶层。在Android.mk文件的开头定义:LOCAL_PATH:=$(callmy-dir)。all-subdir-makefiles:返回一个位于当前my-dir路径的子目录列表。例如下面的目录层次:


sources/foo/Android.mk
sources/foo/lib1/Android.mk
sources/foo/lib2/Android.mk


如果sources/foo/Android.mk包含一行include$(callall-subdir-makefiles),那么它就会自动包含sources/foo/lib1/Android.mk和sources/foo/lib2/Android.mk。这项功能用于向编译系统提供深层次嵌套的代码目录层次。在默认情况下,NDK会只搜索在sources/*/Android.mk中的文件。

this-makefile:返回当前Makefile的路径(即这个函数调用的地方)。

parent-makefile:返回调用树中父Makefile路径。即包含当前Makefile的Makefile路径。

模块描述变量

下面的变量用于向编译系统描述我们自己的模块,它应该定义在include$(CLEAR_VARS)和include$(BUILD_XXXXX)之间。正如前面讲述的那样,$(CLEAR_VARS)是一个脚本,清除所有这些变量,除非在描述中显式注明。

LOCAL_PATH:这个变量用于给出当前文件的路径,必须在Android.mk的开头定义,可以这样使用:LOCAL_PATH:=$(callmy-dir)。这个变量不会被$(CLEAR_VARS)清除,因此每个Android.mk只需要定义一次(即使在一个文件中定义了几个模块的情况下)。

LOCAL_MODULE:这是模块的名字,必须是唯一的,而且不能包含空格。必须在包含任一个(BUILD_XXXX)脚本之前定义它。模块的名字决定了生成文件的名字,如果一个共享库模块的名字是<foo>,那么生成文件的名字就是lib<foo>.so。

LOCAL_SRC_FILES:这是要编译的源代码文件列表。只要列出要传递给编译器的文件即可,编译系统会自动计算依赖。源代码文件名称都是相对于LOCAL_PATH的,可以使用路径部分,例如:LOCAL_SRC_FILES:=toto/bar.c。

LOCAL_CPP_EXTENSION:这是一个可选变量,用来指定C++代码文件的扩展名,默认是“.cpp”,我们可以改变,比如LOCAL_CPP_EXTENSION:=.cxx。

LOCAL_C_INCLUDES:路径的可选配置,从根目录开始,需要在任何包含LOCAL_CFLAGS/LOCAL_CPPFLAGS标志之前。

LOCAL_CFLAGS:可选的编译器选项,在编译C代码文件的时候使用。指定一个附加的包含路径(相对于NDK的顶层目录)、宏定义,或者编译选项。注意:不要在Android.mk中改变optimization/debugging级别,只要在Application.mk中指定合适的信息,就会自动处

理这个问题,在调试期间,会让NDK自动生成有用的数据文件。

LOCAL_CPPFLAGS:与LOCAL_CFLAGS相同,但对C和C++都适用。

LOCAL_STATIC_LIBRARIES:应该链接到这个模块的静态库列表(使用BUILD_STATIC_LIBRARY生成),仅对共享库模块才有意义。

LOCAL_SHARED_LIBRARIES:模块在运行时要依赖的共享库模块列表,在链接时需要,在生成文件时嵌入相应的信息,仍然需要在Application.mk中把它们添加到程序要求的模块中。

LOCAL_LDLIBS:编译模块要使用的附加的链接器选项。这对于使用“-l”前缀传递指定库的名字是有用的。

LOCAL_ALLOW_UNDEFINED_SYMBOLS:默认情况下,在试图编译一个共享库时,任何未定义的引用都将导致“未定义的符号”错误。这对在源代码文件中捕捉错误会有很大的帮助。如果因为某些原因,需要不启动这项检查,把这个变量设为true,相应的共享库就可能在运行时加载失败。

LOCAL_ARM_MODE:默认情况下,ARM目标二进制会以thumb的形式生成(16位),可以通过设置这个变量为arm,模块就会以32位指令的形式生成。同样,我们可以在编译的时候告诉系统编译特定的类型,比如LOCAL_SRC_FILES:=foo.cbar.c.arm,将告诉系统总是把bar.c以arm的模式编译。

Android.mk使用模板

一个Android.mk中可以生成多个可执行程序、动态库和静态库。

1)编译应用程序的模板


#TestExe
LOCAL_PATH:=$(callmy-dir)
#include$(CLEAR_VARS)
LOCAL_SRC_FILES:=main.c
LOCAL_MODULE:=test_exe
#LOCAL_C_INCLUDES:=
#LOCAL_STATIC_LIBRARIES:=
#LOCAL_SHARED_LIBRARIES:=
include$(BUILD_EXECUTABLE)


LOCAL_SRC_FILES中加入源文件路径,LOCAL_C_INCLUDES中加入所需要包含的头文件路径,LOCAL_STATIC_LIBRARIES加入所需要链接的静态库(*.a)的名称,

LOCAL_SHARED_LIBRARIES中加入所需要链接的动态库(*.so)的名称,

LOCAL_MODULE表示模块最终的名称,BUILD_EXECUTABLE表示以一个可执行程序的方式进行编译。

2)编译静态库的模板


#TestStaticLib
LOCAL_PATH:=$(callmy-dir)
include$(CLEAR_VARS)
LOCAL_SRC_FILES:=/helloworld.c
LOCAL_MODULE:=libtest_static
#LOCAL_C_INCLUDES:=
#LOCAL_STATIC_LIBRARIES:=
Android远程监控技术
#LOCAL_SHARED_LIBRARIES:=
include$(BUILD_STATIC_LIBRARY)


一般的都和上面相似,BUILD_STATIC_LIBRARY表示编译一个静态库。

3)编译动态库的模板


#TestSharedLib
LOCAL_PATH:=$(callmy-dir)
include$(CLEAR_VARS)
LOCAL_SRC_FILES:=/helloworld.c
LOCAL_MODULE:=libtest_shared
TARGET_PRELINK_MODULES:=false
#LOCAL_C_INCLUDES:=
#LOCAL_STATIC_LIBRARIES:=
#LOCAL_SHARED_LIBRARIES:=
include$(BUILD_SHARED_LIBRARY)


一般也和上面的相似,BUILD_SHARED_LIBRARY表示编译一个共享库。以上三者的生成结果分别如下,generic依具体target会有所改变。


out/target/product/generic/obj/EXECUTABLE
out/target/product/generic/obj/STATIC_LIBRARY
out/target/product/generic/obj/SHARED_LIBRARY


每个模块的目标文件夹分别为:

可执行程序:XXX_intermediates

静态库:XXX_static_intermediates

动态库:XXX_shared_intermediates

另外,在Android.mk文件中,还可以指定最后的目标安装路径,用LOCAL_MODULE_PATH和LOCAL_UNSTRIPPED_PATH来指定。不同的文件系统路径,

可以用以下的宏进行选择:

TARGET_ROOT_OUT:表示根文件系统

TARGET_OUT:表示system文件系统

TARGET_OUT_DATA:表示data文件系统

用法为LOCAL_MODULE_PATH:=$(TARGET_ROOT_OUT)。

到这里,与MK相关的信息基本都介绍到了,现在打开一个NDK项目再去阅读Android.mk文件,是不是感觉清晰明了了?