Android.mk文件语法规范（Android.mk File）

http://blog.csdn.net/smfwuxiao/article/details/8530742

1、Android.mk文件概述

Android.mk文件用来告诉NDK编译系统，应该如何编译这些源码。更确切地说，该文件其实就是一个小型的Makefile。该文件会被 NDK的编译工具解析多次，所以要注意不要过多使用环境变量，以免第一次解析时产生的变量影响后面的解析。Android.mk把源码组织成不同的模块， 每个模块可以是一个静态库也可以是一个动态库。动态库才会被拷贝到安装包中，静态库只能用于编译生成动态库。

同一个Android.mk文件可以定义多个模块，不同的模块可以共用同一个源文件。

注意，NDK所使用的Android.mk文件的语法与Android操作系统的开放源码中的Android.mk的语法非常接近，但是两个编译系统对Android.mk的使用方法不同，这是为了方便应用程序开发人员复用以前的代码。

2、一个简单的例子

在详细讨论Android.mk文件的语法之前，先看一个简单的 “hello JNI“ 的例子，文件位于 apps/hello-jni/project。其中的 src 子目录存放Android工程的java源码，jni子目录存放C/C++源码文件，即 jni/hello-jni.c （实现了一个返回字符串给虚拟机的函数）。jni/Android.mk 文件是这个模块的编译脚本，内容如下：

  1. LOCAL_PATH := $(call my-dir)  
  2.   
  3. include $(CLEAR_VARS)  
  4.   
  5. LOCAL_MODULE    := hello-jni  
  6. LOCAL_SRC_FILES := hello-jni.c  
  7.   
  8. include $(BUILD_SHARED_LIBRARY)  

以上内容解释如下：

    LOCAL_PATH := $(call my-dir)

每个Android.mk文件都必须在开头定义 LOCAL_PATH 变量。这个变量被用来寻找C/C++源文件。在该例中，my-dir 是一个由编译系统提供的宏函数，用于返回Android.mk所在目录的路径。

    include $(CLEAR_VARS)

CLEAR_VARS是编译系统预定义的一个变量，它指向一个特殊的Makefile，这个Makefile负责清除 LOCAL_xxx 的变量（例如 LOCAL_MODULE, LOCAL_SRC_FILES, LOCAL_STATIC_LIBRARIES 等）但不会清除 LOCAL_PATH。之所以需要清理这些变量是因为所有的编译控制文件是在一趟make执行过程中完成的，而所有的变量都是全局的，会对其他 Android.mk文件产生影响。

    LOCAL_MODULE := hello-jni

LOCAL_MODULE 用来给每个模块定义一个名字，不同模块的名字不能相同，不能有空格。这里的名字会传给NDK编译系统，然后加上lib前缀和.so后缀 （例如，变成libhello-jni.so）。注意，如果你在LOCAL_MODULE定义中自己加上了lib前缀，则ndk在处理的时候就不会再加上 lib前缀了（为了兼容Android系统的一些源码）。

    LOCAL_SRC_FILES := hello-jni.c

在LOCAL_SRC_FILES 变量里面列举出对应于同一个模块的、要编译的那些文件，这里不要把头文件加进来，编译系统可以自动检测头文件依赖关系。默认情况下，C++源码文件的扩展 名应该是cpp，如果想修改的话，将变量LOCAL_CPP_EXTENSION修改为你想要的扩展名，注意句点。例 如：LOCAL_CPP_EXTENSION := .cxx

    include $(BUILD_SHARED_LIBRARY)

这个 BUILD_SHARED_LIBRARY也是预定义的变量，也是指向一个Makefile，负责将你在 LOCAL_XXX 等变量中定义信息收集起来，确定要编译的文件，如何编译。如果要编译的是静态库而不是动态库，则可以用 BUILD_STATIC_LIBRARY。

在NDK安装目录的samples目录下有更加丰富的例子，里面都有详细的注释。

3、变量名的限制

下面这些变量是你可以直接使用或者应该由你来定义的。你也可以定义自己的变量，但是不能用以下NDK所保留的变量名：

    以 LOCAL_ 开头的名字（例如，LOCAL_MODULE）

    以 PRIVATE_， NDK_，APP_ 开头的名字（供NDK内部使用）

    小写字母的变量名也不能使用（供NDK内部使用，例如 my-dir）

例如，你可以随便用 MY_ 开头的变量名

  1. MY_SOURCES := foo.c  
  2. ifneq ($(MY_CONFIG_BAR),)  
  3.   MY_SOURCES += bar.c  
  4. endif  
  5.   
  6. LOCAL_SRC_FILES += $(MY_SOURCES)  

4、NDK预定义变量

下面这些变量是ndk提前定义好的变量。有时ndk会解析同一个Android.mk文件多次，每次解析时，这些变量的值可能不相同。

CLEAR_VARS

指向一个特殊的Makefile，负责清理 LOCAL_XXX 变量（LOCAL_PATH除外）。一般在定义新模块之前使用这个变量，用法：

include $(CLEAR_VARS)

BUILD_SHARED_LIBRARY

该变量实际指向了一个Makefile，用来把所有名为 LOCAL_XXX的变量中的信息收集起来，然后确定如何把你提供的源码编译成目标模块。用法：include $(BUILD_SHARED_LIBRARY)     默认文件名：lib<LOCAL_MODULE>.so

BUILD_STATIC_LIBRARY

类似于BUILD_SHARED_LIBRARY，不过它用来编译静态库。静态库不会被拷贝到你的安装包中去，它往往用来编译其他动态库。用 法：include $(BUILD_STATIC_LIBRARY)    默认文件名：lib<LOCAL_MODULE>.a

PREBUILT_SHARED_LIBRARY

该变量指向一个已编译好的共享库。与BUILD_SHARED_LIBRARY和BUILD_STATIC_LIBRARY不同，此时相应的 LOCAL_SRC_FILES不再指定源文件，而是指向这个预编译共享库文件（例如 foo/libfoo.so）。可以在其他模块中，通过使用LOCAL_PREBUILTS变量来引用这个预编译模块。参考Prebuilt。

PREBUILT_STATIC_LIBRARY

与PREBUILT_SHARED_LIBRARY相同，只不过这里是静态库。 参考 Prebuilt。

TARGET_ARCH

目标CPU架构的名字，与Android操作系统的CPU架构名一致。如果想兼容所有ARM的CPU，可以用 “arm” 这个名字。

TARGET_PLATFORM

目标Android平台的名字。例如 android-3 对应的是 Android 1.5 系统镜像（Cupcake）。所有系统镜像的名字和相应的系统镜像可参考Stable APIs。

TARGET_ARCH_ABI

目标CPU和ABI组合的名字，目前只有2个值可以用：

armeabi     对于ARMv5TE

armeabi-v7a

注意，一直到Android NDK 1.6_r1，这里的值都是用“arm”。然而，该值已被重新定义以更好地匹配Android平台内部所使用的。

关于架构和ABI及兼容性问题，参考文档 Cpu Arch ABIs。

其他的目标ABI会在将来的NDK版本中增加，并且是不同的名字。注意，所有兼容ARM的ABI的TARGET_ARCH都是arm，但是TARGET_ARCH_ABI不同。

TARGET_ABI

目标平台和ABI的组合，定义为 $(TARGET_PLATFORM)-$(TARGET_ARCH_ABI)。当你想在真机上测试一种系统镜像时有用。该变量的默认值是android-3-armeabi。

直到Android NDK 1.6_r1，这个值一直是 android-3-arm。

5、NDK预定义的宏函数

下面是NDK预定义的“函数”宏，用法是  $(call <function>) ，返回的是文本信息

my-dir

返回上一个被包含的Makefile的路径，典型情况是Android.mk文件所在的路径。这个函数对于定义LOCAL_PATH特别有用，例如：

    LOCAL_PATH := $(call my-dir)

注意：由于make的工作原理，该函数返回的确实是上一个被包含的Makefile的路径（也就是说返回的结果可能不是Android.mk所在目录）。所以，包含了另外一个文件之后，就不要再使用 my-dir 了。

例如，下面的例子：

  1.     LOCAL_PATH := $(call my-dir)  
  2.     该模块其他声明  
  3.       
  4.     include $(LOCAL_PATH)/foo/Android.mk  
  5.     LOCAL_PATH := $(call my-dir)  
  6.     另一个模块的声明  

上面的问题就是第二次调用my-dir的时候，得到的是 $PATH/foo 而不是 $PATH，因为它前面有一个include语句。

因此，最好在所有include语句之前，把LOCAL_PATH定义好：

  1. LOCAL_PATH := $(call my-dir)  
  2. ... declare one module  
  3. LOCAL_PATH := $(call my-dir)  
  4. ... declare another module  
  5. # extra includes at the end of the Android.mk  
  6. include $(LOCAL_PATH)/foo/Android.mk  

如果觉得这样做不方便，可以把第一次调用的结果保存到变量中，例如：

  1. MY_LOCAL_PATH := $(call my-dir)  
  2. LOCAL_PATH := $(MY_LOCAL_PATH)  
  3. ... declare one module  
  4. include $(LOCAL_PATH)/foo/Android.mk  
  5. LOCAL_PATH := $(MY_LOCAL_PATH)  
  6. ... declare another module  

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。

this-makefile

返回当前的Makefile的路径（即该函数调用时的位置）

parent-makefile

如果当前这个Makefile被另一个Makefile包含，则返回那个包含了自己的Makefile的路径（即parent）

grand-parent-makefile

(你猜猜......)

import-module

该函数用于按模块名查找另一个模块的Android.mk文件，并包含进来。用法如下：

        $(call import-module,<name>)

上面将在 NDK_MODULE_PATH变量所指定的目录列表中寻找名为<name>的模块，找到之后将包含进来。

可以参考 Import Module。

6、模块描述变量

下面这些变量用于对模块进行描述，这些变量应该在 include $(CLEAR_VARS) 和 include $(BUILD_XXXX) 之间定义好。

LOCAL_PATH （必须）

这个变量表示当前文件（一般是Android.mk）所在的路径，该变量很重要，必须定义（在Android.mk文件的开头处定义）。常见写法如下：

    LOCAL_PATH := $(call my-dir)

该变量不会被 include $(CLEAR_VARS) 清空，所以不论Android.mk定义了几个模块，一个Android.mk只需要在开头定义一次即可。

LOCAL_MODULE （必须）

该变量定义当前模块的名字，名字必须唯一，不能有空格。这个变量必须在 include $(BUILD_XXX) 之前定义好。默认情况下，这里的名字会用来得到输出文件的名字。例如模块名为foo，则得到的输出文件为libfoo.so。但是，如果你要在其他模块的 Android.mk文件或Application.mk中引用这个模块，应该用foo这个模块名，而不要用libfoo.so这个文件名。

LOCAL_MODULE_FILENAME （可选）

该变量可以用来重定义输出文件的名字。默认情况下，foo模块得到的静态库的名字为 libfoo.a，动态库的名字为libfoo.so（UNIX规范）。当定义了LOCAL_MODULE_FILENAME之后，输出文件名就是这个变量指定的名字，例如：

  1. LOCAL_MODULE := foo-version-1  
  2. LOCAL_MODULE_FILENAME := libfoo  

注意： LOCAL_MODULE_FILENAME不支持文件路径（所以不能有斜杠），不要写扩展名（文件路径和文件扩展名是由编译工具自动加上的）

LOCAL_SRC_FILES （必须）

该变量用来指定该模块对应的源文件，只把需要传给编译器的源文件名加进LOCAL_SRC_FILES，编译系统会自动处理头文件依赖。这里的文件名都是以 LOCAL_PATH 作为当前目录的（即相对于LOCAL_PATH目录），例如：

    LOCAL_SRC_FILES := foo.c toto/bar.c
注意：必须使用Unix风格的斜杠，Windows风格的斜杠不能正确处理。

LOCAL_CPP_EXTENSION （可选）

用来定义C++代码文件的扩展名。必须以句点开头（即 “.”），默认值是“.cpp”，可以修改，例如：

    LOCAL_CPP_EXTENSION := .cxx

从 NDK r7 这个版本开始，该变量可以支持多个扩展名了，例如：

    LOCAL_CPP_EXTENSION := .cxx .cpp .cc

LOCAL_CPP_FEATURES （可选）

该变量用来指定C++代码所依赖的特殊C++特性。例如，如果要告诉编译器你的C++代码使用了RTTI（RunTime Type Information）：

    LOCAL_CPP_FEATURES := rtti

如果要指定你的C++代码使用了C++异常，则：

    LOCAL_CPP_FEATURES := exceptions

该变量可以同时指定多个特性。例如：    LOCAL_CPP_FEATURES := rtti features

这个变量的作用就是在编译模块的时候，开启相应的编译器/链接器标志。对于预编译的文件，该变量表明该预编译的库依赖了这些特性，从而确保最后的链 接工作正确进行。与该变量等价的做法是在LOCAL_CPPFLAGS中写上 -frtti -fexceptions 等标志选项。但是，推荐用这里的方法。

LOCAL_C_INCLUDES

一个路径的列表，是NDK根目录的相对路径（LOCAL_SRC_FILES中的文件相对于LOCAL_PATH）。当编译C/C++、汇编文件时，这些路径将被追加到头文件搜索路径列表中。例如：

    LOCAL_C_INCLUDES := sources/foo

    或者， LOCAL_C_INCLUDES := $(LOCAL_PATH)/../foo

这里的搜索路径会放在LOCAL_CFLAGS/LOCAL_CPPFALGS等标志的前面。 当使用ndk-gdb的时候，LOCAL_C_INCLUDES中的路径也会被用到。

LOCAL_CFLAGS

指定当编译C/C++源码的时候，传给编译器的标志。它一般用来指定其他的编译选项和宏定义。

注意：尽量不要在Android.mk中修改优化/调试等级，因为在Application.mk中定义了相关信息之后编译系统会自动处理这些问题。


LOCAL_CXXFLAGS （废除， LOCAL_CPPFLAGS的别名）

LOCAL_CPPFLAGS （可选）

编译C++代码的时候传递给编译器的选项（编译C代码不会用这里的选项）。最后得到的命令行选项中，这里指定的选项在 LOCAL_CFLAGS 指定的选项的后面。

LOCAL_STATIC_LIBRARIES

指定应该链接到当前模块的静态库（可指定多个）。当前模块是动态库时，该选项才有意义。

LOCAL_SHARED_LIBRARIES

指定的是运行时该模块所依赖共享库（可指定多个）。这些信息是链接阶段必须的。

LOCAL_WHOLE_STATIC_LIBRARIES

它是LOCAL_STATIC_LIBRARIES的变体，用来表示它对应的模块对于linker来说应该是一个“whole archive”（见GNU linker 文档，关于 --whole-archive的资料）。当静态库之间有循环依赖时，会用到这个选项。注意，当编译动态库时，这个选项会强行把所有的对象文件组装到一 起；不过，在编译可执行文件的时候情况不是这样的。

LOCAL_LDLIBS

用来指定模块编译时的其余连接器标志。例如：

    LOCAL_LDLIBS := -lz

告诉链接器在加载该共享库的时候必须链接 /system/lib/libz.so 这个共享库。

如果想知道Android系统中有哪些共享库可以链接，参考 Stable APIs。

LOCAL_ALLOW_UNDEFINED_SYMBOLS

默认情况下，当编译一个共享库的时候，遇到未定义符号引用就会报告一个“undefined symbol”错误。这有助于修复你的代码中存在的bug。

如果因为某种原因，必须禁止该检测，可以把这个变量设置为true。注意，编译出的共享库有可能在加载的时候就报错导致程序退出。

LOCAL_ARM_MODE

LOCAL_ARM_NEON

LOCAL_DISABLE_NO_EXECUTE

Android NDK r4增加了对“NX bit“安全特性的支持。它是默认开启的，如果你确定自己不需要该特性，你可以将它关闭，即：

    LOCAL_DISABLE_NO_EXECUTE := true

该变量不会修改ABI，只会在 ARMv6以上的CPU的内核上启用。开启该特性编译出的代码无需修改可运行在老的CPU上（也就是说所有ARM的CPU都能运行）。

参考信息：

http://en.wikipedia.org/wiki/NX_bit
http://www.gentoo.org/proj/en/hardened/gnu-stack.xml

LOCAL_EXPORT_CFLAGS

    这个变量定义一些C/C++编译器flags。这些flags（标志）会被追加到使用了这个模块（利用LOCAL_STATIC_LIBRARIES和LOCAL_SHARED_LIBRARIES）的模块的LOCAL_CFLAGS 定义中去。

假如foo模块的声明如下：

  1. include $(CLEAR_VARS)  
  2. LOCAL_MODULE := foo  
  3. LOCAL_SRC_FILES := foo/foo.c  
  4. LOCAL_EXPORT_CFLAGS := -DFOO=1  
  5. include $(BUILD_STATIC_LIBRARY)  

bar模块依赖foo模块，声明如下：

  1. include $(CLEAR_VARS)  
  2. LOCAL_MODULE := bar  
  3. LOCAL_SRC_FILES := bar.c  
  4. LOCAL_CFLAGS := -DBAR=2  
  5. LOCAL_STATIC_LIBRARIES := foo  
  6. include $(BUILD_SHARED_LIBRARY)  

因 此在编译bar模块的时候，它的编译器标志就是 “-DFOO=1 -DBAR=2”。 导出的flags 加上本模块的 LOCAL_CFLAGS，成为最后传给编译器的flags。这样修改起来就很容易。这种依赖关系是可传递的，例如，如果zoo依赖bar，bar依赖 foo，那么zoo就会同时有bar和foo的导出flags。

注意，编译模块自身时，不会使用它所导出的flags。例如在编译上面的foo模块时， -DFOO=1 不会传递给编译器。

LOCAL_EXPORT_CPPFLAGS

    与 LOCAL_EXPORT_CFLAGS 相同，是跟C++相关的标志。

LOCAL_EXPORT_C_INCLUDES

    与 LOCAL_EXPORT_CFLAGS 相同，但是只用于头文件搜索路径。当你的共享库有多个模块，而且互相之间有头文件依赖时有用。用法详见 Import Module。

LOCAL_EXPORT_LDLIBS

    与 LOCAL_EXPORT_CFLAGS 相同，但是只用于连接器的flag。注意这里被导人的链接器标志将追加到模块的 LOCAL_LDLIBS。

    例如当foo模块是一个静态库并且代码依赖于系统库时，该变量非常有用。 LOCAL_EXPORT_LDLIBS 可以用于导出该依赖：

  1. include $(CLEAR_VARS)  
  2. LOCAL_MODULE := foo  
  3. LOCAL_SRC_FILES := foo/foo.c  
  4. LOCAL_EXPORT_LDLIBS := -llog  
  5. include $(BUILD_STATIC_LIBRARY)  
  6.   
  7. include $(CLEAR_VARS)  
  8. LOCAL_MODULE := bar  
  9. LOCAL_SRC_FILES := bar.c  
  10. LOCAL_STATIC_LIBRARIES := foo  
  11. include $(BUILD_SHARED_LIBRARY)  

此处在编译bar模块的时候，它的链接器标志将加上一个 -llog，表示它依赖于系统提供的 liblog.so，因为它依赖 foo 模块。

LOCAL_FILTER_ASM

    这个变量指定一个shell命令，用于过滤LOCAL_SRC_FILES 中列出的汇编文件或者LOCAL_SRC_FILES列出的文件所编译出的汇编文件。定义该变量后，将导致以下行为：

    1）所有的C/C++源码首先翻译为临时汇编文件（如果不定义LOCAL_FILTER_ASM，则C/C++源码直接编译为 obj 文件）

    2）这些汇编文件被传给 LOCAL_FILTER_ASM 所指定的shell命令处理，得到一批新的汇编文件。

    3）这些新的汇编文件再被编译成obj文件。

换句话说，如果你定义：

  1. LOCAL_SRC_FILES  := foo.c bar.S  
  2. LOCAL_FILTER_ASM := myasmfilter  

则 foo.c首先传给编译器（gcc），得到 foo.S.orignal，然后这个 foo.S.original 被传给你指定的过滤器(LOCAL_ASM_FILTER)，得到 foo.S，然后再传给汇编器（例如as），得到 foo.o。 bar.S 直接传给过滤器得到 bar.S.new，然后再传给汇编器，得到 bar.o。即在从*.S到*.o的编译流程中增加了一个过滤的环节。

过滤器必须是独立的shell命令，输入文件作为它的第一个命令行参数，输出文件作为第二个命令行参数，例如：

    1.     myasmfilter $OBJS_DIR/foo.S.original $OBJS_DIR/foo.S  
    2.     myasmfilter bar.S $OBJS_DIR/bar.S 

posted on 2013-03-29 11:25  屁屁侠  阅读(1930)  评论(0)  编辑  收藏  举报

导航