android的 makefile -- Android.mk 分析

对于一个程序新手而言，好的IDE是他们追捧的对象。但当他接触的代码多了之后，就会逐渐发现IDE不够用了，因为有好多东西用IDE是不好做的，例如自动编译，测试，版本控制，编译定制等。这跟政治课上的一句话有点像：资本主义开始的时候是促进生产力发展的，但到了后来又成了阻碍生产力发展的因素了。如果一个程序不能摆脱IDE的限制（不是不用，而是要有选择的用），那么他就很难提高。要知道，IDE和makefile代表了两种不同的思想：IDE根据强调的是简化计算机与用户的交互；而makefile体现的是自动化。

对于一个一开始就接触linux的人来说，makefile可能是比较容易学的（熟能生巧），对于一个一开始就接触Windows的人来说，makefile就不太好学，这主要是应该很多时候会不自觉地去用Visual Studio（VisualStudio是个好东西，特别是它的调试）。不知道大叫有没有这个的感觉：一个人如果先接触c，再接触java会比较容易点；如果一个人先接触java，再接触c，就会比较反感c。

一个工程中的源文件不计数，其按类型、功能、模块分别放在若干个目录中，makefile定义了一系列的规则来指定，哪些文件需要先编译，哪些文件需要后编译，哪些文件需要重新编译，甚至于进行更复杂的功能操作，因为 makefile就像一个Shell脚本一样，其中也可以执行操作系统的命令。

makefile带来的好处就是——“自动化编译”，一旦写好，只需要一个make命令，整个工程完全自动编译，极大的提高了软件开发的效率。make是一个命令工具，是一个解释makefile中指令的命令工具，一般来说，大多数的IDE都有这个命令，比如：Delphi的make，Visual C++的nmake，Linux下GNU的make。可见，makefile都成为了一种在工程方面的编译方法。

Make工具最主要也是最基本的功能就是通过makefile文件来描述源程序之间的相互关系并自动维护编译工作。而makefile 文件需要按照某种语法进行编写，文件中需要说明如何编译各个源文件并连接生成可执行文件，并要求定义源文件之间的依赖关系。makefile 文件是许多编译器--包括 Windows NT 下的编译器--维护编译信息的常用方法，只是在集成开发环境中，用户通过友好的界面修改 makefile 文件而已。

对于android而言，android使用的是GNU的make，因此它的makefile格式也是GNU的makefile格式。现在网络上关于makefile最好的文档就是陈皓的《跟我一起写makefile》，这份文档对makefile进行了详细的介绍。

首先我们来看看android里makefile的写法
(1)Android.mk文件首先需要指定LOCAL_PATH变量，用于查找源文件,宏函数’my-dir’, 由编译系统提供。由于一般情况下Android.mk和需要编译的源文件在同一目录下，所以定义成如下形式：
LOCAL_PATH:=$(call my-dir)
上面的语句的意思是 将LOCAL_PATH变量定义成本文件所在目录路径。

一个 Android.mk中可以定义多个编译模块，每个编译模块都是以include $(CLEAR_VARS)开始
以include $(BUILD_XXX)结束。

BUILD_PACKAGE 建立一个APK

include $(CLEAR_VARS)
CLEAR_VARS由编译系统提供，指的是clear_vars.mk，指定让GNU MAKEFILE为你清除除LOCAL_PATH以外的所有LOCAL_XXX变量，
如LOCAL_MODULE，LOCAL_SRC_FILES，LOCAL_SHARED_LIBRARIES，LOCAL_STATIC_LIBRARIES等。

LOCAL_MODULE:=xxx

生成的模块的名称(注意应用程序名称用LOCAL_PACKAGE_NAME，而不是LOCAL_MODULE)，当编译动态库或者静态库时，此变量标示库名称；

LOCAL_SRC_FILES，app的所有源码，可以指定具体的文件，如果是java源码的话，可以调用all-java-files-under得到。
LOCAL_PACKAGE_NAME，package的名字，这个名字在脚本中将标识这个app或package。

LOCAL_MODULE_TAGS := user eng tests optional

user: 指该模块只在user版本下才编译

eng: 指该模块只在eng版本下才编译

tests: 指该模块只在tests版本下才编译

optional:指该模块在所有版本下都编译，默认是optional

LOCAL_CERTIFICATE := platform //指定使用的哪种key 来给apk签名，platform 就是指用 platform.pk8和platform.x509.pem两个文件来签名。用这两个key签名后apk才真正可以放入系统进程中；

LOCAL_C_INCLUDES:=include 这个是用来指定在编译时即将使用的c头文件的位置，以当前目录为起点。

include $(BUILD_STATIC_LIBRARY)表示编译成静态库，后缀为.a。
include $(BUILD_SHARED_LIBRARY)表示编译成动态库，用来指示将当前模块编译为共享库，前缀为lib，后缀为.so。
include $(BUILD_EXECUTABLE)表示编译成可执行程序

（2）定义多个Android.mk文件。

　　有的时候，需要编译的模块比较多，我们可能会将对应的模块放置在相应的目录中，这样，我们可以在每个目录中定义对应的Android.mk文件（类似于上面的写法），最后，在根目录放置一个Android.mk文件，内容如下：
　　include $(call all-subdir-makefiles)
　　只需要这一行就可以了，它的作用就是包含所有子目录中的Android.mk文件

另一种方法就是可以在一个Android.mk文件里包含多个模块。
　　很直观的想法就是将第一个Android.mk文件的内容复制一份，然后修改。我最开始也是这样做的，但是后来出现问题了，在第二个模块中的源码找不到，最后还是看文档，发现里面已经有示例解释了：
　　LOCAL_PATH := $(call my-dir)
　　大意是：在这个Android.mk里面只需要调用一次$(call my-dir)就够了，否则会出错，如果所有的源文件都在一个目录中。
　　如果需要的话，可以在第一次调用call my-dir的时候，将值保存下来，比如：
　　MY_LOCAL_PATH := $(call my-dir)
　　LOCAL_PATH := $(MY_LOCAL_PATH)
　　然后，在另外一个模块中，继续如下定义：
　　LOCAL_PATH := $(MY_LOCAL_PATH)

(3)简单例子1 ，编译一个普通apk

1 ifeq ($(BOARD_USE_DEFAULT_APPINSTALL),true) // 这一行和最后一行是定义了一个开关 BOARD_USE_DEFAULT_APPINSTALL ，如果这个开关为 true，那么就执行这个 makefile，这个开关定义在我的项目 device/amlogic/xxx/BoardConfig.mk 里，如BOARD_USE_DEFAULT_APPINSTALL := false

2 LOCAL_PATH:= $(call my-dir) //LOCAL_PATH必须位于Android.mk文件的最开始。它是用来定位源文件的位置，$(call my-dir)的作用就是返回当前目录的路径。
3 include $(CLEAR_VARS) //作用是清除一些变量的值，但是LOCAL_PATH除外
4 LOCAL_MODULE_TAGS := optional // optional:指该模块在所有版本下都编译
5 LOCAL_SRC_FILES := $(call all-subdir-java-files) //用来指定参与编译的源代码文件
6 LOCAL_PACKAGE_NAME := AppInstaller //package的名字
7 LOCAL_CERTIFICATE := platform //指定使用的哪种key 来给apk签名，platform 就是指用 platform.pk8和platform.x509.pem两个文件来签名。用这两个key签名后apk才真正可以放入系统进程中；
8 include $(BUILD_PACKAGE) //建立一个APK
9 endif

-----------------------------------------------------

简单例子 2，把 c文件编译为共享库

一个简单的"hello world"，比如下面的文件：

sources/helloworld/helloworld.c

sources/helloworld/Android.mk

相应的Android.mk文件会象下面这样：

---------- cut here ------------------

LOCAL_PATH := $(call my-dir)

include $(CLEAR_VARS)

LOCAL_MODULE := helloworld

LOCAL_SRC_FILES := helloworld.c

include $(BUILD_SHARED_LIBRARY)

---------- cut here ------------------

解释：

LOCAL_MODULE变量必须定义，以标识你在Android.mk文件中描述的每个模块。名称必须是唯一的，而且不包含任何空格。注意编译系统会自动产生合适的前缀和后缀，换句话说，一个被命名为'foo'的共享库模块，将会生成'libfoo.so'文件。

LOCAL_SRC_FILES变量必须包含将要编译打包进模块中的C或C++源代码文件。注意，你不用在这里列出头文件和包含文件，因为编译系统将会自动为你找出依赖型的文件；仅仅列出直接传递给编译器的源代码文件就好。

====================================

举例如下(frameworks/base/libs/audioflinger/Android.mk)：

LOCAL_PATH:= $(call my-dir)
include $(CLEAR_VARS) 模块一
ifeq ($(AUDIO_POLICY_TEST),true)
ENABLE_AUDIO_DUMP := true
endif
LOCAL_SRC_FILES:= \
AudioHardwareGeneric.cpp \
AudioHardwareStub.cpp \
AudioHardwareInterface.cpp
ifeq ($(ENABLE_AUDIO_DUMP),true)
LOCAL_SRC_FILES += AudioDumpInterface.cpp
LOCAL_CFLAGS += -DENABLE_AUDIO_DUMP
endif
LOCAL_SHARED_LIBRARIES := \
libcutils \
libutils \
libbinder \
libmedia \
libhardware_legacy
ifeq ($(strip $(BOARD_USES_GENERIC_AUDIO)),true)
LOCAL_CFLAGS += -DGENERIC_AUDIO
endif
LOCAL_MODULE:= libaudiointerface
ifeq ($(BOARD_HAVE_BLUETOOTH),true)
LOCAL_SRC_FILES += A2dpAudioInterface.cpp
LOCAL_SHARED_LIBRARIES += liba2dp
LOCAL_CFLAGS += -DWITH_BLUETOOTH -DWITH_A2DP
LOCAL_C_INCLUDES += $(call include-path-for, bluez)
endif
include $(BUILD_STATIC_LIBRARY) 模块一编译成静态库
include $(CLEAR_VARS) 模块二
LOCAL_SRC_FILES:= \
AudioPolicyManagerBase.cpp
LOCAL_SHARED_LIBRARIES := \
libcutils \
libutils \
libmedia
ifeq ($(TARGET_SIMULATOR),true)
LOCAL_LDLIBS += -ldl
else
LOCAL_SHARED_LIBRARIES += libdl
endif
LOCAL_MODULE:= libaudiopolicybase
ifeq ($(BOARD_HAVE_BLUETOOTH),true)
LOCAL_CFLAGS += -DWITH_A2DP
endif
ifeq ($(AUDIO_POLICY_TEST),true)
LOCAL_CFLAGS += -DAUDIO_POLICY_TEST
endif
include $(BUILD_STATIC_LIBRARY) 模块二编译成静态库
include $(CLEAR_VARS) 模块三
LOCAL_SRC_FILES:= \
AudioFlinger.cpp \
AudioMixer.cpp.arm \
AudioResampler.cpp.arm \
AudioResamplerSinc.cpp.arm \
AudioResamplerCubic.cpp.arm \
AudioPolicyService.cpp
LOCAL_SHARED_LIBRARIES := \
libcutils \
libutils \
libbinder \
libmedia \
libhardware_legacy
ifeq ($(strip $(BOARD_USES_GENERIC_AUDIO)),true)
LOCAL_STATIC_LIBRARIES += libaudiointerface libaudiopolicybase
LOCAL_CFLAGS += -DGENERIC_AUDIO
else
LOCAL_SHARED_LIBRARIES += libaudio libaudiopolicy
endif
ifeq ($(TARGET_SIMULATOR),true)
LOCAL_LDLIBS += -ldl
else
LOCAL_SHARED_LIBRARIES += libdl
endif
LOCAL_MODULE:= libaudioflinger
ifeq ($(BOARD_HAVE_BLUETOOTH),true)
LOCAL_CFLAGS += -DWITH_BLUETOOTH -DWITH_A2DP
LOCAL_SHARED_LIBRARIES += liba2dp
endif
ifeq ($(AUDIO_POLICY_TEST),true)
LOCAL_CFLAGS += -DAUDIO_POLICY_TEST
endif
ifeq ($(TARGET_SIMULATOR),true)
ifeq ($(HOST_OS),linux)
LOCAL_LDLIBS += -lrt -lpthread
endif
endif
ifeq ($(BOARD_USE_LVMX),true)
LOCAL_CFLAGS += -DLVMX
LOCAL_C_INCLUDES += vendor/nxp
LOCAL_STATIC_LIBRARIES += liblifevibes
LOCAL_SHARED_LIBRARIES += liblvmxservice
# LOCAL_SHARED_LIBRARIES += liblvmxipc
endif
include $(BUILD_SHARED_LIBRARY) 模块三编译成动态库

(4)编译一个应用程序(APK)

LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
# Build all java files in the java subdirectory-->直译（建立在java子目录中的所有Java文件）
LOCAL_SRC_FILES := $(call all-subdir-java-files)
# Name of the APK to build-->直译（创建APK的名称）
LOCAL_PACKAGE_NAME := LocalPackage
# Tell it to build an APK-->直译（告诉它来建立一个APK）
include $(BUILD_PACKAGE)

(5)编译一个依赖于静态Java库(static.jar)的应用程序

LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
# List of static libraries to include in the package
LOCAL_STATIC_JAVA_LIBRARIES := static-library
# Build all java files in the java subdirectory
LOCAL_SRC_FILES := $(call all-subdir-java-files)
# Name of the APK to build
LOCAL_PACKAGE_NAME := LocalPackage
# Tell it to build an APK
include $(BUILD_PACKAGE)

(6)编译一个需要用平台的key签名的应用程序

LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
# Build all java files in the java subdirectory
LOCAL_SRC_FILES := $(call all-subdir-java-files)
# Name of the APK to build
LOCAL_PACKAGE_NAME := LocalPackage
LOCAL_CERTIFICATE := platform
# Tell it to build an APK
include $(BUILD_PACKAGE)

(7)编译一个需要用特定key前面的应用程序

LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
# Build all java files in the java subdirectory
LOCAL_SRC_FILES := $(call all-subdir-java-files)
# Name of the APK to build
LOCAL_PACKAGE_NAME := LocalPackage
LOCAL_CERTIFICATE := vendor/example/certs/app
# Tell it to build an APK
include $(BUILD_PACKAGE)

(8)添加一个预编译应用程序

LOCAL_PATH := $(call my-dir)
include $(CLEAR_VARS)
# Module name should match apk name to be installed.
LOCAL_MODULE := LocalModuleName
LOCAL_SRC_FILES := $(LOCAL_MODULE).apk
LOCAL_MODULE_CLASS := APPS
LOCAL_MODULE_SUFFIX := $(COMMON_ANDROID_PACKAGE_SUFFIX)
include $(BUILD_PREBUILT)

(9)添加一个静态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)

(10)Android.mk的编译模块中间可以定义相关的编译内容，也就是指定相关的变量如下：

LOCAL_AAPT_FLAGS

LOCAL_ACP_UNAVAILABLE

LOCAL_ADDITIONAL_JAVA_DIR

LOCAL_AIDL_INCLUDES

LOCAL_ALLOW_UNDEFINED_SYMBOLS

LOCAL_ARM_MODE

LOCAL_ASFLAGS

LOCAL_ASSET_DIR

LOCAL_ASSET_FILES 在Android.mk文件中编译应用程序(BUILD_PACKAGE)时设置此变量，表示资源文件，
               通常会定义成LOCAL_ASSET_FILES += $(call find-subdir-assets)

LOCAL_BUILT_MODULE_STEM
LOCAL_C_INCLUDES 额外的C/C++编译头文件路径，用LOCAL_PATH表示本文件所在目录
               举例如下：
               LOCAL_C_INCLUDES += extlibs/zlib-1.2.3
               LOCAL_C_INCLUDES += $(LOCAL_PATH)/src

LOCAL_CC 指定C编译器

LOCAL_CERTIFICATE 签名认证

LOCAL_CFLAGS 为C/C++编译器定义额外的标志(如宏定义)，举例：LOCAL_CFLAGS += -DLIBUTILS_NATIVE=1

LOCAL_CLASSPATH

LOCAL_COMPRESS_MODULE_SYMBOLS

LOCAL_COPY_HEADERS install应用程序时需要复制的头文件，必须同时定义LOCAL_COPY_HEADERS_TO

LOCAL_COPY_HEADERS_TO install应用程序时复制头文件的目的路径

LOCAL_CPP_EXTENSION 如果你的C++文件不是以cpp为文件后缀，你可以通过LOCAL_CPP_EXTENSION指定C++文件后缀名
如：LOCAL_CPP_EXTENSION := .cc
注意统一模块中C++文件后缀必须保持一致。

LOCAL_CPPFLAGS 传递额外的标志给C++编译器，如：LOCAL_CPPFLAGS += -ffriend-injection

LOCAL_CXX 指定C++编译器

LOCAL_DX_FLAGS

LOCAL_EXPORT_PACKAGE_RESOURCES

LOCAL_FORCE_STATIC_EXECUTABLE 如果编译的可执行程序要进行静态链接(执行时不依赖于任何动态库)，则设置LOCAL_FORCE_STATIC_EXECUTABLE:=true
目前只有libc有静态库形式，这个只有文件系统中/sbin目录下的应用程序会用到，这个目录下的应用程序在运行时通常
文件系统的其它部分还没有加载，所以必须进行静态链接。

LOCAL_GENERATED_SOURCES

LOCAL_INSTRUMENTATION_FOR

LOCAL_INSTRUMENTATION_FOR_PACKAGE_NAME

LOCAL_INTERMEDIATE_SOURCES

LOCAL_INTERMEDIATE_TARGETS

LOCAL_IS_HOST_MODULE

LOCAL_JAR_MANIFEST

LOCAL_JARJAR_RULES

LOCAL_JAVA_LIBRARIES 编译java应用程序和库的时候指定包含的java类库，目前有core和framework两种
多数情况下定义成：LOCAL_JAVA_LIBRARIES := core framework
注意LOCAL_JAVA_LIBRARIES不是必须的，而且编译APK时不允许定义(系统会自动添加)

LOCAL_JAVA_RESOURCE_DIRS

LOCAL_JAVA_RESOURCE_FILES

LOCAL_JNI_SHARED_LIBRARIES

LOCAL_LDFLAGS 传递额外的参数给连接器(务必注意参数的顺序)

LOCAL_LDLIBS 为可执行程序或者库的编译指定额外的库，指定库以"-lxxx"格式，举例：
LOCAL_LDLIBS += -lcurses -lpthread
LOCAL_LDLIBS += -Wl,-z,origin

LOCAL_MODULE 生成的模块的名称(注意应用程序名称用LOCAL_PACKAGE_NAME而不是LOCAL_MODULE)

LOCAL_MODULE_PATH 生成模块的路径

LOCAL_MODULE_STEM

LOCAL_MODULE_TAGS 生成模块的标记

LOCAL_NO_DEFAULT_COMPILER_FLAGS

LOCAL_NO_EMMA_COMPILE

LOCAL_NO_EMMA_INSTRUMENT

LOCAL_NO_STANDARD_LIBRARIES

LOCAL_OVERRIDES_PACKAGES

LOCAL_PACKAGE_NAME //APK应用程序的名称

LOCAL_POST_PROCESS_COMMAND

LOCAL_PREBUILT_EXECUTABLES 预编译including $(BUILD_PREBUILT)或者$(BUILD_HOST_PREBUILT)时所用,指定需要复制的可执行文件

LOCAL_PREBUILT_JAVA_LIBRARIES

LOCAL_PREBUILT_LIBS 预编译including $(BUILD_PREBUILT)或者$(BUILD_HOST_PREBUILT)时所用, 指定需要复制的库.

LOCAL_PREBUILT_OBJ_FILES

LOCAL_PREBUILT_STATIC_JAVA_LIBRARIES

LOCAL_PRELINK_MODULE 是否需要预连接处理(默认需要，用来做动态库优化)

LOCAL_REQUIRED_MODULES 指定模块运行所依赖的模块(模块安装时将会同步安装它所依赖的模块)

LOCAL_RESOURCE_DIR

LOCAL_SDK_VERSION

LOCAL_SHARED_LIBRARIES 可链接动态库

LOCAL_SRC_FILES 编译源文件

LOCAL_STATIC_JAVA_LIBRARIES

LOCAL_STATIC_LIBRARIES 可链接静态库

LOCAL_UNINSTALLABLE_MODULE

LOCAL_UNSTRIPPED_PATH

LOCAL_WHOLE_STATIC_LIBRARIES 指定模块所需要载入的完整静态库(这些精通库在链接是不允许链接器删除其中无用的代码)

LOCAL_YACCFLAGS

OVERRIDE_BUILT_MODULE_PATH

==========================================

android 最顶层的目录结构如下：

接下来我们详细看一下android里的makefile文件

|-- Makefile （全局的Makefile）

|-- bionic （Bionic含义为仿生，这里面是一些基础的库的源代码）
|-- bootloader （引导加载器）

|-- build （build目录中的内容不是目标所用的代码，而是编译和配置所需要的脚本和工具）

|-- dalvik （JAVA虚拟机）

|-- development （程序开发所需要的模板和工具）

|-- external （目标机器使用的一些库）

|-- frameworks （应用程序的框架层）

|-- hardware （与硬件相关的库）

|-- kernel （Linux2.6的源代码）

|-- packages （Android的各种应用程序）

|-- prebuilt （Android在各种平台下编译的预置脚本）

|-- recovery （与目标的恢复功能相关）

`-- system （Android的底层的一些库）

-----------------------------------------------------------

Makefile的规则如下：

target ... : prerequisites ...

command ... ...

target可以是一个目标文件，也可以是Object File（例如helloworld.obj），也可以是执行文件和标签。

prerequisites就是生成target所需要的文件或是目标。

command
也就是要达到target这个目标所需要执行的命令。这里没有说“使用生成target所需要执行的命令”，是因为target可能是标签。需要注意的是

command前面必须是TAB键，而不是空格，因此喜欢在编辑器里面将TAB键用空格替换的人需要特别小心了。

我们写程序一般喜欢写helloworld，当我们写了一个c的helloworld之后，我们该如何写helloworld来编译helloworld.c呢？

下面就是编译helloworld的makefile。

helloworld : helloworld.o

cc -o helloworld helloworld .o

helloworld.o : helloworld.c

cc -c main.c

clean:
rm helloworld helloworl.o

之后我们执行make就可以编译helloworld.c了，执行make clean就可以清除编译结果了（其实就是删除helloworld helloworl.o）。

可能有人问为什么执行make就会生成helloworld呢？这得从make的默认处理说起：make将makefile的第一个target作为作为最终的

target，凡是这个规则依赖的规则都将被执行，否则就不会执行。所以在执行make的时候，clean这个规则就没有被执行。

posted @ 2012-04-27 19:51 点点爱梦阅读(268) 评论(0) 编辑收藏举报

刷新页面返回顶部

android的 makefile -- Android.mk 分析

公告