Android mk文件详解

Android.mk是Android提供的一种makefile文件，用来指定诸如编译生成so库名、引用的头文件目录、需要编译的.c/.cpp文件和.a静态库文件等。要掌握jni，就必须熟练掌握Android.mk的语法规范。 

一、Android.mk文件的用途 
一个android子项目中会存在一个或多个Android.mk文件 
1、单一的Android.mk文件 
直接参考NDK的sample目录下的hello-jni项目，在这个项目中只有一个Android.mk文件 
2、多个Android.mk文件 
如果需要编译的模块比较多，我们可能会将对应的模块放置在相应的目录中， 
这样，我们可以在每个目录中定义对应的Android.mk文件（类似于上面的写法）， 
最后，在根目录放置一个Android.mk文件，内容如下： 
include $(call all-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) 
注意：‘:=’是赋值的意思；'+='是追加的意思；‘$’表示引用某变量的值。 

三、GNU Make系统变量 
  这些 GNU Make变量在你的 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 -> Official Android 1.5 system images 
       android-4 -> Official Android 1.6 system images 
       android-5 -> Official Android 2.0 system images 
  （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 := $(call my-dir) 
       如当前目录下有个文件夹名称 src，则可以这样写 $(call src)，那么就会得到 src 目录的完整路径 
       这个变量不会被$(CLEAR_VARS)清除，因此每个 Android.mk 只需要定义一次(即使在一个文件中定义了几个模块的情况下)。 
  （2）LOCAL_MODULE: 这是模块的名字，它必须是唯一的，而且不能包含空格。 
       必须在包含任一的$(BUILD_XXXX)脚本之前定义它。模块的名字决定了生成文件的名字。 
  （3）LOCAL_SRC_FILES:  这是要编译的源代码文件列表。 
       只要列出要传递给编译器的文件，因为编译系统自动计算依赖。注意源代码文件名称都是相对于 LOCAL_PATH的，你可以使用路径部分，例如： 
        LOCAL_SRC_FILES := foo.c toto/bar.c\ 
        Hello.c 
       文件之间可以用空格或Tab键进行分割,换行请用"\" 
       如果是追加源代码文件的话，请用LOCAL_SRC_FILES += 
       注意：可以LOCAL_SRC_FILES := $(call all-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提供的函数宏 
GNU Make函数宏，必须通过使用'$(call  )'来调用，返回值是文本化的信息。 
   （1）my-dir:返回当前 Android.mk 所在的目录的路径，相对于 NDK 编译系统的顶层。这是有用的，在 Android.mk 文件的开头如此定义： 
        LOCAL_PATH := $(call my-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 $(call all-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示例 

Java代码  


#编译静态库  

LOCAL_PATH := $(call my-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 := $(call my-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 := $(call my-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 := $(call my-dir)  

include $(CLEAR_VARS)  

LOCAL_MODULE := hellod  

LOCAL_MODULE_TAGS := debug  

LOCAL_SHARED_LIBRARIES := libc libcutils libhellod  

LOCAL_LDLIBS += -ldl  

LOCAL_CFLAGS := $(L_CFLAGS)  

LOCAL_SRC_FILES := maind.c  

LOCAL_C_INCLUDES := $(INCLUDES)  

include $(BUILD_EXECUTABLE)  

 
 
 

0. Android.mk简介：

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.

1. 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为开始。它用于在开发tree中查找源文件。

宏my-dir 则由Build System提供。返回包含Android.mk的目录路径。

include $(CLEAR_VARS) 

CLEAR_VARS 变量由Build System提供。并指向一个指定的GNU Makefile，由它负责清理很多LOCAL_xxx.

例如：LOCAL_MODULE, LOCAL_SRC_FILES, LOCAL_STATIC_LIBRARIES等等。但不清理LOCAL_PATH.

这个清理动作是必须的，因为所有的编译控制文件由同一个GNU Make解析和执行，其变量是全局的。所以清理后才能避免相互影响。

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可执行程序     

  

2. NDK Build System变量：

NDK Build System 保留以下变量名：

以LOCAL_  为开头的


以PRIVATE_ ,NDK_ 或者APP_ 开头的名字。

小写字母名字：如my-dir

如果想要定义自己在Android.mk中使用的变量名，建议添加 ＭＹ＿　前缀。

2.1: NDK提供的变量：

此类GNU Make变量是NDK Build System在解析Android.mk之前就定义好了的。

2.1.1：CLEAR_VARS：

指向一个编译脚本。必须在新模块前包含之。 

include $(CLEAR_VARS)

2.1.2：BUILD_SHARED_LIBRARY：

指向一个编译脚本，它收集自从上次调用 include $(CLEAR_VARS)  后的所有LOCAL_XXX信息。

并决定如何将你列出的Source编译成一个动态库。 注意，在包含此文件前，至少应该包含：LOCAL_MODULE and LOCAL_SRC_FILES 例如： 

include $(BUILD_SHARED_LIBRARY)

2.1.3：BUILD_STATIC_LIBRARY：

与前面类似，它也指向一个编译脚本，

收集自从上次调用 include
$(CLEAR_VARS)  后的所有LOCAL_XXX信息。

并决定如何将你列出的Source编译成一个静态库。
静态库不能够加入到Project 或者APK中。但它可以用来生成动态库。

LOCAL_STATIC_LIBRARIES and LOCAL_WHOLE_STATIC_LIBRARIES将描述之。

include $(BUILD_STATIC_LIBRARY)

2.1.4: BUILD_EXECUTABLE: 
与前面类似，它也指向一个编译脚本，收集自从上次调用 include $(CLEAR_VARS)  后的所有LOCAL_XXX信息。
并决定如何将你列出的Source编译成一个可执行Native程序。

include $(BUILD_EXECUTABLE)

2.1.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目录呢？因为这样做缺陷很多。下一节再详细说明。

2.1.6: PREBUILT_STATIC_LIBRARY: 预先编译的静态库。 同上。

2.1.7: TARGET_ARCH:
目标ＣＰＵ架构名。如果为　“arm” 则声称ARM兼容的指令。与CPU架构版本无关。

2.1.8: TARGET_PLATFORM: 
目标平台的名字。

2.1.9：TARGET_ARCH_ABI

Name of the target CPU+ABI

armeabi For ARMv5TE  armeabi-v7a
2.1.10：TARGET_ABI

2.2: NDK提供的功能宏：
GNU　Make 提供的功能宏，只有通过类似： $(call function)   的方式来得到其值，它将返回文本化的信息。

2.2.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.

2.2.2: all-subdir-makefiles:
返回一个列表，包含'my-dir'中所有子目录中的Android.mk。
例如： 结构如下：

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

在If sources/foo/Android.mk 中， include $(call all-subdir-makefiles)  那则自动include 了sources/foo/lib1/Android.mk and sources/foo/lib2/Android.mk。

2.2.3：this-makefile：
当前Makefile的路径。

2.2.4：parent-makefile：
返回include tree中父Makefile 路径。 也就是include 当前Makefile的Makefile Path。

2.2.5：import-module：
允许寻找并inport其它modules到本Android.mk中来。 它会从NDK_MODULE_PATH寻找指定的模块名。

$(call import-module,<name>)

2.3: 模块描述变量：
此类变量用来给Build System描述模块信息。在'include $(CLEAR_VARS)' 和 'include $(BUILD_XXXXX)'之间。必须定义此类变量。

include $(CLEAR_VARS) script用来清空这些变量。 

include $(BUILD_XXXXX)收集和使用这些变量。

2.3.1: LOCAL_PATH: 
这个值用来给定当前目录。必须在Android.mk的开是位置定义之。
例如：  LOCAL_PATH := $(call my-dir)   LOCAL_PATH不会被include $(CLEAR_VARS) 清理。

2.3.2: LOCAL_MODULE: 
modules名。在include $(BUILD_XXXXX)之前，必须定义这个变量。此变量必须唯一且不能有空格。
通常，由此变量名决定最终生成的目标文件名。

2.3.3: LOCAL_MODULE_FILENAME:
可选。用来override LOCAL_MODULE. 即允许用户重新定义最终生成的目标文件名。

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

2.3.4：LOCAL_SRC_FILES：
为Build Modules而提供的Source 文件列表。不需要列出依赖文件。 注意：文件相对于LOCAL_PATH存放，
且可以提供相对路径。 例如：

LOCAL_SRC_FILES := foo.c               \ toto/bar.c

2.3.5: LOCAL_CPP_EXTENSION:
指出C++ 扩展名。(可选)

LOCAL_CPP_EXTENSION := .cxx 从NDK R7后，可以写多个：

LOCAL_CPP_EXTENSION := .cxx .cpp .cc

2.3.6：LOCAL_CPP_FEATURES：
可选。用来指定C++ features。

LOCAL_CPP_FEATURES := rtti

LOCAL_CPP_FEATURES := exceptions

 

2.3.7：LOCAL_C_INCLUDES：
一个可选的path列表。相对于NDK ROOT 目录。编译时，将会把这些目录附上。

LOCAL_C_INCLUDES := sources/foo  LOCAL_C_INCLUDES := $(LOCAL_PATH)/../foo

2.3.8: LOCAL_CFLAGS:
一个可选的设置，在编译C/C++ source 时添加如Flags。
用来附加编译选项。 注意：不要尝试在此处修改编译的优化选项和Debug等级。它会通过您Application.mk中的信息自动指定。
也可以指定include 目录通过：LOCAL_CFLAGS += -I<path>。 这个方法比使用LOCAL_C_INCLUDES要好。因为这样也可以被ndk-debug使用。

2.3.9: LOCAL_CXXFLAGS: 

LOCAL_CPPFLAGS的别名。

2.3.10: LOCAL_CPPFLAGS: 
C++ Source 编译时添加的C Flags。这些Flags将出现在LOCAL_CFLAGS flags 的后面。

2.3.11: LOCAL_STATIC_LIBRARIES:
要链接到本模块的静态库list。(built with BUILD_STATIC_LIBRARY)

2.3.12: LOCAL_SHARED_LIBRARIES: 
要链接到本模块的动态库。

2.3.13：LOCAL_WHOLE_STATIC_LIBRARIES：

静态库全链接。 不同于LOCAL_STATIC_LIBRARIES，类似于使用--whole-archive

2.3.14：LOCAL_LDLIBS：  

linker flags。 可以用它来添加系统库。 如 -lz: 

LOCAL_LDLIBS := -lz

2.3.15: LOCAL_ALLOW_UNDEFINED_SYMBOLS:

2.3.16: LOCAL_ARM_MODE: 
缺省模式下，ARM目标代码被编译为thumb模式。每个指令16位。如果指定此变量为：arm。 则指令为32位。

LOCAL_ARM_MODE := arm   其实也可以指定某一个或者某几个文件的ARM指令模式。

2.3.17: LOCAL_ARM_NEON: 
设置为true时，会讲浮点编译成neon指令。这会极大地加快浮点运算(前提是硬件支持)
只有targeting 为 'armeabi-v7a'时才可以。

2.3.18：LOCAL_DISABLE_NO_EXECUTE：

2.3.19: LOCAL_EXPORT_CFLAGS:
定义这个变量用来记录C/C++编译器标志集合，
并且会被添加到其他任何以LOCAL_STATIC_LIBRARIES和LOCAL_SHARED_LIBRARIES的模块的LOCAL_CFLAGS定义中 

LOCAL_SRC_FILES := foo.c bar.c.arm

注意：此处NDK版本为NDK R7C.（不同NDK版本，ndk-build所产生的Makefile并不完全相同[b]）
[/b]