Android.mk文件分析

1.Android.mk简介

一个Android.mk file用来向编译系统描述你的源代码。具体来说:该文件是GNU Makefile的一小部分,会被编译系统解析一次或多次。你可以在每一个Android.mk file中定义一个或多个模块,你也可以在几个模块中使用同一个源代码文件。编译系统为你处理许多细节问题。
一个工程中的源文件不计数,其按类型、功能、模块分别放在若干个目录中,makefile定义了一系列的规则来指定,哪些文件需要先编译,哪些文件需要后编译,哪些文件需要重新编译,甚至于进行更复杂的功能操作,因为 makefile就像一个Shell脚本一样,其中也可以执行操作系统的命令。
makefile带来的好处就是——“自动化编译”,一旦写好,只需要一个make命令,整个工程完全自动编译,极大的提高了软件开发的效率。make是一个命令工具,是一个解释makefile中指令的命令工具,一般来说,大多数的IDE都有这个命令,比如:Delphi的make,Visual C++的nmake,Linux下GNU的make。可见,makefile都成为了一种在工程方面的编译方法。
Make工具最主要也是最基本的功能就是通过makefile文件来描述源程序之间的相互关系并自动维护编译工作。而makefile 文件需要按照某种语法进行编写,文件中需要说明如何编译各个源文件并连接生成可执行文件,并要求定义源文件之间的依赖关系。makefile 文件是许多编译器,包括 Windows NT 下的编译器–维护编译信息的常用方法,只是在集成开发环境中,用户通过友好的界面修改 makefile 文件而已。

2.实例分析

下面以A51_Hosin_MP的Android.mk文件为例进行说明:

LOCAL_PATH:= $(call my-dir)

include $(CLEAR_VARS)
ifeq ($(MTK_VT3G324M_SUPPORT), yes)
LOCAL_MANIFEST_FILE := cmcc/AndroidManifest.xml
endif
endif

ifeq ($(strip $(HQ_CLIENT)), hosin)
LOCAL_MANIFEST_FILE := hosin/AndroidManifest.xml
endif

LOCAL_MODULE_TAGS := optional

LOCAL_SRC_FILES := $(call all-java-files-under, src)

ifeq ($(strip $(HQ_CLIENT)),doov)
  ifeq ($(strip $(HQ_PROJECT)),A51)
     LOCAL_SRC_FILES := $(call all-java-files-under,a51_doov)
  endif
  LOCAL_SRC_FILES := $(filter-out src/com/android/contacts/ContactsGroupsActivity.java, $(LOCAL_SRC_FILES))

  LOCAL_SRC_FILES := $(filter-out src/com/android/contacts/ContactsMarkListActivity.java, $(LOCAL_SRC_FILES))
  LOCAL_SRC_FILES := $(filter-out src/com/android/contacts/ExportVCardActivity.java, $(LOCAL_SRC_FILES))
else
 LOCAL_SRC_FILES := $(filter-out src/com/android/contacts/a51_doov/ContactsGroupsActivity.java, $(LOCAL_SRC_FILES))
 LOCAL_SRC_FILES := $(filter-out src/com/android/contacts/a51_doov/ContactsMarkListActivity.java, $(LOCAL_SRC_FILES))
 LOCAL_SRC_FILES := $(filter-out src/com/android/contacts/a51_doov/ExportVCardActivity.java, $(LOCAL_SRC_FILES))
endif

LOCAL_STATIC_JAVA_LIBRARIES := com.android.phone.common \
                                                                                    com.mediatek.wsp \
                                                           com.mediatek.CellConnUtil
LOCAL_JAVA_LIBRARIES += com.mediatek.framework
LOCAL_JAVA_LIBRARIES +=com.huaqin.utils

LOCAL_PACKAGE_NAME := Contacts
LOCAL_CERTIFICATE := shared
LOCAL_PROGUARD_FLAG_FILES := proguard.flags
include $(BUILD_PACKAGE)

字段说明
1. LOCAL_PATH

LOCAL_PATH := $(call my-dir)

一个Android.mk file首先必须定义好LOCAL_PATH变量。它表示是当前文件的路径。在这个例子中, 宏函数‘my-dir’, 由编译系统提供, 用于返回当前路径(即包含Android.mk file文件的目录)。
2. CLEAR_VARS

include $(CLEAR_VARS)

CLEAR_VARS 由编译系统提供(可以在 android 安装目录下的/build/core/config.mk 文件看到其定义,为 CLEAR_VARS:=$(BUILD_SYSTEM)/clear_vars.mk),指定让GNU MAKEFILE该脚本为你清除许多 LOCAL_XXX 变量 ( 例如 LOCAL_MODULE , LOCAL_SRC_FILES ,LOCAL_STATIC_LIBRARIES,等等…),除 LOCAL_PATH。这是必要的,因为所有的编译文件都在同一个 GNU MAKE 执行环境中,所有的变量都是全局的。另外注意,该语句的意思就是把CLEAR_VARS变量所指向的脚本文件包含进来。

  1. HQ_CLIENT
 ifeq ($(strip $(HQ_CLIENT)), hosin)
                LOCAL_MANIFEST_FILE := hosin/AndroidManifest.xml
           endif

以上说了当宏HQ_CLIENT为hosin时,系统在编译的时候的AndroidManifest.xml文件的路径
4. LOCAL_MODULE_TAGS

 LOCAL_MODULE_TAGS := optional

指该模块在所有版本下都编译

  1. LOCAL_SRC_FILES
LOCAL_SRC_FILES := $(call all-java-files-under, src)

说了本次要编译的源文件(src文件夹下的所有java文件)
6. LOCAL_JAVA_LIBRARIES

LOCAL_JAVA_LIBRARIES += com.mediatek.framework

该模块在参加编译时需要的java库
7.LOCAL_PACKAGE_NAME

LOCAL_PACKAGE_NAME := Contacts

编译生成的apk的文件名

  1. LOCAL_CERTIFICATE
LOCAL_CERTIFICATE := shared

允许共享UID
对于几个apk来说要想共享User id,首先需要在AndroidManifest节点中增加android:sharedUserId属性,最后还要把APK的源码放到packages/apps/目录下,用mm进行编译。
9. LOCAL_PROGUARD_FLAG_FILES

LOCAL_PROGUARD_FLAG_FILES := proguard.flags   

proguard是将java代码进行混淆的工具,这一句话指定不需要混淆的native方法与变量的proguard.flags文件
10. BUILD_PACKAGE

include $(BUILD_PACKAGE)

告诉系统编译结束要生成一个apk

3.字段分析

下面再介绍一下Android.mk文件编写的一些变量:
一、自定义变量
以下是在 Android.mk中依赖或定义的变量列表, 可以定义其他变量为自己使用
-以 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系统变量
(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平台的名字, 和 android 开放源码中指定的那样。如果是
arm,表示要生成 ARM 兼容的指令,与 CPU架构的修订版无关。
(5)TARGET_PLATFORM: Android.mk 解析的时候,目标 Android 平台的名字.
(6)TARGET_ARCH_ABI: 暂时只支持两个 value,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’。
三、模块描述变量
下面的变量用于向编译系统描述你的模块。你应该定义在include $(CLEAR_VARS)include $(BUILD_XXXXX)之间。正如前面描写的那样,$(CLEAR_VARS)是一个脚本,清除所有这些变量。
(1) LOCAL_PATH: 这个变量用于给出当前文件的路径。必须在 Android.mk 的开头定义,可以这样使用:LOCAL_PATH := $(call my-dir) 这个变量不会被$(CLEAR_VARS)清除,因此每个 Android.mk 只需要定义一次(即使在一个文件中定义了几个模块的情况下)。
(2)LOCAL_MODULE: 这是模块的名字,它必须是唯一的,而且不能包含空格。必须在包含任一的$(BUILD_XXXX)脚本之前定义它。模块的名字决定了生成文件的名字。例如,如果一个一个共享库模块的名字是,那么生成文件的名字就是 lib.so。但是,在的 NDK 生成文
件中(或者 Android.mk 或者 Application.mk),应该只涉及(引用)有正常名字的其他模块。
(3)LOCAL_SRC_FILES: 这是要编译的源代码文件列表。只要列出要传递给编译器的文件,因为编译系统自动计算依赖。注意源代码文件名称都是相对于 LOCAL_PATH的,你可以使用路径部分,例如:

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

文件之间可以用空格或Tab键进行分割,换行请用”\”.如果是追加源代码文件的话,请用LOCAL_SRC_FILES +=
注意:在生成文件中都要使用UNIX风格的斜杠(/).windows风格的反斜杠不会被正确的处理。
注意:可以LOCAL_SRC_FILES := $(call all-subdir-java-files)这种形式来包含local_path目录下的所有java文件。
(4) LOCAL_CPP_EXTENSION: 这是一个可选变量,用来指定C++代码文件的扩展名,默认是’.cpp’,但是可以改变它,比如:

LOCAL_CPP_EXTENSION := .cxx

(5) LOCAL_C_INCLUDES: 可选变量,表示头文件的搜索路径。默认的头文件的搜索路径是LOCAL_PATH目录。
示例:LOCAL_C_INCLUDES := sources/fooLOCAL_C_INCLUDES := $(LOCAL_PATH)/../foo
LOCAL_C_INCLUDES需要在任何包含LOCAL_CFLAGS/LOCAL_CPPFLAGS标志之前进行设置。
(6)LOCAL_CFLAGS: 可选的编译器选项,在编译 C 代码文件的时候使用。这可能是有
用的,指定一个附加的包含路径(相对于NDK的顶层目录),宏定义,或者编译选项。
(7)LOCAL_CXXFLAGS: 与 LOCAL_CFLAGS同理,针对 C++源文件。
(8)LOCAL_CPPFLAGS: 与 LOCAL_CFLAGS同理,但是对 C 和 C++ source files都适用。
(9)LOCAL_STATIC_LIBRARIES: 表示该模块需要使用哪些静态库,以便在编译时进行链接。
(10)LOCAL_SHARED_LIBRARIES: 表示模块在运行时要依赖的共享库(动态库),在链接时就需要,以便在生成文件时嵌入其相应的信息。注意:它不会附加列出的模块到编译图,也就是仍然需要在Application.mk 中把它们添加到程序要求的模块中。
(11)LOCAL_LDLIBS: 编译模块时要使用的附加的链接器选项。这对于使用‘-l’前缀传递指定库的名字是有用的。
例如,LOCAL_LDLIBS := -lz表示告诉链接器生成的模块要在加载时刻链接到/system/lib/libz.so
可查看 docs/STABLE-APIS.TXT 获取使用 NDK发行版能链接到的开放的系统库列表。
(12) LOCAL_ALLOW_UNDEFINED_SYMBOLS: 默认情况下, 在试图编译一个共享库时,任何未定义的引用将导致一个“未定义的符号”错误。这对于在源代码文件中捕捉错误会有很大的帮助。然而,如果因为某些原因,需要不启动这项检查,可把这个变量设为‘true’。
注意相应的共享库可能在运行时加载失败。(这个一般尽量不要去设为 true)。
(13) LOCAL_ARM_MODE: 默认情况下, arm目标二进制会以 thumb 的形式生成(16 位),你可以通过设置这个变量为 arm如果你希望你的 module 是以 32 位指令的形式。
‘arm’ (32-bit instructions) mode. E.g.:

LOCAL_ARM_MODE := arm

注意:可以在编译的时候告诉系统针对某个源码文件进行特定的类型的编译
比如,LOCAL_SRC_FILES := foo.c bar.c.arm 这样就告诉系统总是将 bar.c 以arm的模式编译。
(14)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的区别,暂时还不清楚。
四、GNU Make功能宏
GNU Make功能宏,必须通过使用“$(call)”来调用,调用他们将返回文本化的信息。
(1)my-dir:返回当前 Android.mk 所在的目录的路径,相对于 NDK 编译系统的顶层。这是有用的,在 Android.mk 文件的开头如此定义:

LOCAL_PATH := $(call my-dir)

(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。
这项功能用于向编译系统提供深层次嵌套的代码目录层次。
(3)this-makefile: 返回当前Makefile 的路径(即这个函数调用的地方)
(4)parent-makefile: 返回调用树中父 Makefile 路径。即包含当前Makefile的Makefile 路径。
(5)grand-parent-makefile:返回调用树中父Makefile的父Makefile的路径
五、 lib库名称分析
libHello.so 加lib前缀 .so后缀 makefile的语法约定的,LOCAL_MODULE的值是和java中通过static 方式load lib时的名字相同

LOCAL_MODULE    := libHello
LOCAL_SRC_FILES := Hello.c

include $(BUILD_SHARED_LIBRARY)

猜你喜欢

转载自blog.csdn.net/u011897062/article/details/79465137