Android.mk文档规范

文章来源：http://blog.csdn.net/hudashi/article/details/7059006

1.Android.mk简介

Android.mk文件是GNU Makefile的一小部分，它用来对Android程序进行编译。
因为所有的编译文件都在同一个 GNU MAKE 执行环境中进行执行，而Android.mk中所有的变量都是全局的。因此，您应尽量少声明变量，不要认为某些变量在解析过程中不会被定义。
一个Android.mk文件可以编译多个模块，每个模块属于下列类型之一：
1）APK程序
 一般的Android程序，比哪一打包成.apk文件。
2）JAVA库
 java类库，编译打包生成.jar文件。
3）C\C++应用程序
 可执行的C\C++应用程序
4）C\C++静态库
 编译生成C\C++静态库，并打包成.a文件。
5）C\C++共享库
 编译生成共享库（动态链接库），并打包成.so文件。
 有且只有共享库才能被安装/复制到您的应用应用软件(APK)包中。

可以再每一个Android.mk文件中定义一个或多个模块，你也可以再几个模块中使用同一个源代码文件。编译系统为你处理许多细节问题。例如，你不需要在你的Android.mk文件中列出头文件和依赖文件。这也意味着，在升级NDK后，你应该得到新的toolchain/platfrom支持，而且不需要改变你的Android.mk文件。
注意，NDK的Android.mk语法同公开发布的Android平台开源代码的Android.mk语法很接近，然而编译系统实现他们的方式却是不同的，这是故意这样设计的，可以让程序开发人员重用外部库的源代码更容易。

在描述语法细节之前，先来看一个简单的"hello world"的例子，比如，下面的文件：
sources/helloworld/helloworld.c
sources/helloworld/Android.mk
'helloworld.c'是一个JNI共享库，实现返回"hello world"字符串的原生方法。 相应Android.mk文件会象下面这样:
LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
LOCAT_MODULE := helloworld
LOCAT_SRC_FILES := helloworld.c
include $(BUILD_SHARED_LIBRARY)
解释一下几行代码：
LOCAL_PATH := $(call my-dir)
 一个Android.mk文件首先必须定义好LOCAL_PATH变量，它表示源文件的路径。
在这个例子中，宏函数'my-dir'由编译系统提供，用于返回当前路径(即当前Android.mk文件路径)。
include $(CLEAR_VARS)
 CLEAR_VARS由编译系统提供，在build/core/config.mk文件中看到其定义为CLEAR_VARS:= $(BUILD_SYSTEM)/clear_vars.mk。clear_vars.mk中将许多LOCAL_XXX清空（不包含LOCAL_PATH）。应为在同一个GNU MAKE执行环境中，所以的变量都是全局的，所以需要清空这些变量。而LOCAL_PATH在每个模块中都需要重新定义，所以不要清空。
LOCAL_MODULE := helloworld
 LOCAL_MODULE变量也是必须定义的，用来标识你在Android.mk文件中描述的每一个模块。名称必须是唯一的并且不包含任何空格。编译系统会根据这个变量自动产生前缀和后缀。例如一个命名为'foo'的共享库模块，会生成'libfoo.so'文件。
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也是由编译系统提供的变量，与上面说到的CLEAR_VARS导入方式相同，config.mk定义为BUILD_SHARED_LIBRARY:= $(BUILD_SYSTEM)/shared_library.mk，从shared_library.mk中导入编译动态链接库所需要的全局变量。如果想生成静态库，则使用BUILD_STATIC_LIBRARY。
在NDK的sources/samples目录下有更复杂一点的例子，并附带写有注释的Android.mk文件。

2.自定义变量

在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)
注意：‘:=’是赋值的意思；'+='是追加的意思；‘$’表示引用某变量的值。

3.GNU Make系统变量

下列GNU Make变量由编译系统定义，在某些情况下，NDK可能多次解析Android.mk，某些变量值会有不同。
1）CLEAR_VARS
 指向相应脚本，用于清空除LOCAL_PATH变量外机会所以系统未定义的LOCAL_XXX系列变量，必须在一个新模块之前包含这个脚本：include $(CLEAR_VARS),
2）BUILD_SHARED_LIBRARY
 指向相应脚本，把源码编译成一个共享库。注意，在包含该文件前必须已定义LOCAL_MODULE和LOCAL_SRC_FILES。
3）BUILD_STATIC_LIBRARY
 指向相应脚本，把源码编译成一个静态库。静态库可用于编译共享库。
4）TARGET_ARCH
 目标CPU架构的名字，例如TARGET_ARCH为arm，则表示生成ARM兼容指令，与CPU架构版本无关。
5）TARGET_PLATFORM
 目标Android平台名，相应值可参看/development/ndk/docs/stable-apis.txt。例如android-5 -> Official Android 2.0 system images。
6）TARGET_ARCH_ABI
 暂时只支持两个值，armeabi和armeabi-v7a。在现在的版本中一般把这两个值简单的定义为arm，通过android平台内部对它重定义来获得更好的匹配。其他ABI将在以后的NDK本中介绍，它们会有不同的名字。注意，虽然所有基于ARM的ABI都会把'TARGET_ARCH'定义成'arm',但会有不同的'TARGET_ARCH_ABI'。
7) TARGET_ABI
 目标平台和ABI的组合，事实上它被定义成$(TARGET_PLATFORM)-$(TARGET_ARCH_ABI)，在想要在真实的设备中针对一个特别的目标系统进行测试时，会有用。在默认情况下，它会是'android-3-arm'。

4.模块描述变量

下面的变量用于向编译系统描述你的模块。你应该定义在'include $(CLEAR_VARS)'和'include $(BUILD_XXXXX)'之间。
1）LOCAL_PATH
 这个变量用于给出当前文件的路径。必须在Android.mk的开头定义，一般将其指向Android.mk所在目录，即LOCAL_PATH:=$(call my-dir)。这个变量不会被$(CLEAR_VARS)清除，因此每个Android.mk需要定义一次(即使在一个Android.mk文件中定义了几个模块的情况下)。
2）LOCAL_MODULE
 这是模块的名字，它必须是唯一的，而且不能包含空格。必须在包含任一的$(BUILD_XXXXX)脚本之前定义它。模块的名字决定了生成文件的名字。例如，如果一个共享库模块的名字是'xxx'，那么生成文件的名字就是libxxx.so。
3）LOCAL_SRC_FILES
 这是要编译的源代码文件列表。只要列出要传递给编译器的文件，因为编译系统会自动计算依赖。注意源代码文件名称都是相对于LOCAL_PATH的，你也可以使用路径部分。文件之间可以用空格或TAB键分隔，使用'\'换行。如果是追加源代码文件可以使用LOCAL_SRC_FILES +=。另外，可以使用LOCAL_SRC_FILES:=$(call all-subdir-java-files)这种形式来包含LOCAL_PATH目录下所有java文件。
4）LOCAL_CPP_EXTENSION
 这是一个可选变量，用来指定C++代码文件的扩展名，默认是'.cpp'，但是可以改变它，比如LOCAT_CPP_EXTENSION:=.cxx。
5）LOCAL_C_INCLUDES
 可选变量，表示头文件的搜索路径。该变量需要在任何包含LOCAL_CFLAGS/LOCAL_CPPFLAGS标志之前进行设置。默认的头文件的搜索路径是LOCAL_PATH目录。例如LOCAL_C_INCLUDES:=sources/foo或LOCAL_C_INCLUDES:=$(LOCAL_PATH)/../foo。
6）LOCAL_CFLAGS
 可选的编译器选项，在编译C代码文件时使用。这里可以指定一个附加的包含路径(相对于NDK的顶层目录)，宏定义或者编译选项。
 注意，不要在Android.mk中改变optiomization/debugging级别，只要在Application.mk中指定合适的信息，就会自动为你处理这个问题，在调试期间，会让NDK自动生成有用的数据文件。
7）LOCAL_CXXFLAGS
 与LOCAL_CFLAGS同理，针对C++源文件。
8）LOCAL_CPPFLAGS
 与LOCAL_CFLAGS同理，同时针对C和C++源文件。
9）LOCAL_STATIC_LIBRARIES
 表示该模块需要使用哪些静态库，以便在编译时进行连接。
10）LOCAL_SHARED_LIBRARIES
 表示模块在运行时要依赖的共享库，在连接时就需要，以便在生成文件时嵌入其相应的信息。注意，它不会附加列出的模块到编译图，也就是依然需要在Application.mk中把他们添加到程序要求的模块中。
11）LOCAL_LDLIBS
 编译模块时要使用的附加的连接器选项。这对于使用'-l'前缀传递指定库的名字是有用的。
12）LOCAL_ALLOW_UNDEFINED_SYMBOLS
 默认情况下，在试图编译一个共享库时，任何未定义的引用将导致一个“未定义的符号”错误。这对于在源代码中捕捉错误会有很大帮助。然而，如果因为某些原因，需要不启动这项检查，可以把这个变量设置为"true"。注意，相应的共享库可能在运行时加载失败。
13）LOCAL_ARM_MODE
 默认情况，arm目标二进制会以thumb的形式生成(16位)。如果你希望你的Module是以32位指令的形式，你可以通过设置这个变量为arm。
14）LOCAL_MODULE_PATH和LOCAL_UNSTRIPPED_PATH
 在Android.mk文件中，还可以使用这两个变量指定最后的目标安装路径。用TARGET_ROOT_OUT表示根文件系统，TARGET_OUT表示system文件系统，TARGET_OUT_DATA表示data文件系统。例如LOCAL_MODULE_PATH:=$(TARGET_ROOT_OUT)。

5.GNU Make‘功能’宏

GNU Make‘功能’宏必须通过使用'$(call)'来调用，调用它们将返回文本化的信息。
1）my-dir
 返回当前Android.mk所在的目录的路径，相对于NDK编译系统的顶层。
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)
 那么它就会自动包含 sources/foo/lib1/Android.mk 和 sources/foo/lib2/Android.mk。
 这项功能用于向编译系统提供深层次嵌套的代码目录层次。
 注意，在默认情况下，NDK将会只搜索在 sources/*/Android.mk。
3）this-makefile
 返回当前Makefile的路径，即这个函数调用的地方
4）parent-makefile
 返回调用树中父Makefile的路径，即包含当前Makefile的Makefile的路径。
5）grand-parent-makefile
 返回调用树中父Makefile的父Makefile的路径。

6.Android使用膜拜
在一个 Android.mk 中可以生成多个APK应用程序，JAVA库，C\C++可执行程序,C\C++动态库和C\C++静态库。
1）编译APK应用程序模板
 略。
2）编译JAVA库模板
 LOCAL_PATH := $(call my-dir)
 include $(CLEAR_VARS)
 # Build all java files in the java subdirectory
 LOCAL_SRC_FILES := $(call all-subdir-java-files)
 # Any libraries that this library depends on
 LOCAL_JAVA_LIBRARIES := android.test.runner
 # The name of the jar file to create
 LOCAL_MODULE := sample
 # Build a static jar file.
 include $(BUILD_STATIC_JAVA_LIBRARY)
 注：LOCAL_JAVA_LIBRARIES := android.test.runner表示生成的JAVA库的jar文件名
3）编译C/C++应用程序模板如下：
 LOCAL_PATH := $(call my-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 表示以一个可执行程序的方式进行编译。
4）编译C\C++静态库
 LOCAL_PATH := $(call my-dir)
 include $(CLEAR_VARS)
 LOCAL_SRC_FILES := \
 helloworld.c
 LOCAL_MODULE:= libtest_static
 #LOCAL_C_INCLUDES :=
 #LOCAL_STATIC_LIBRARIES :=
 #LOCAL_SHARED_LIBRARIES :=
 include $(BUILD_STATIC_LIBRARY)
 和上面相似，BUILD_STATIC_LIBRARY 表示编译一个静态库。
5）编译C\C++动态库的模板
 LOCAL_PATH := $(call my-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/APPS
 out/target/product/generic/obj/JAVA_LIBRARIES
 out/target/product/generic/obj/EXECUTABLE
 out/target/product/generic/obj/STATIC_LIBRARY
 out/target/product/generic/obj/SHARED_LIBRARY

 每个模块的目标文件夹分别为：
 1）APK程序：XXX_intermediates
 2）JAVA库程序：XXX_intermediates
 3）C\C++可执行程序：XXX_intermediates
 4）C\C++静态库： XXX_static_intermediates
 5）C\C++动态库： XXX_shared_intermediates