理解 android 编译系统

前言

Android 编译系统用来编译 Android 系统、Android_SDK 以及相关文档。该系统主要由编译文件（mk 文件）、Shell 脚本以及 Python 脚本组成，其中最主要的是 Make 文件

众所周知，Android 是一个开源的操作系统。Android 的源码中包含了大量的开源项目以及许多的模块。不同产商的不同设备对于 Android 系统的定制都是不一样的。

如何将这些项目和模块的编译统一管理起来，如何能够在不同的操作系统上进行编译，如何在编译时能够支持面向不同的硬件设备、不同的编译类型，且还要提供面向各个产商的定制扩展？

概述

编译系统最主要的逻辑都在编译文件中，而其他的脚本文件只是起到了一些辅助作用

这个编译系统的编译文件可以分为三个部分：
1. 核心文件
    代码路径：buid/core
    说明：此类文件定义了整个编译系统的架构，其他编译文件都是在框架基础上编写出来

2. 产品文件
    代码路径：device/
    说明：通常以公司名和产品名分成两层目录（device/xxxx/xxxx）
          对于一个产品的定义通常需要一组文件，这些文件共同构成了对产品的定义
          
3. 模块编译文件
    说明：整个系统中，包含了大量的模块，每个模块都有一个专门的编译文件
    这类文件的名称统一为 "Android.mk"，该文件中定义了如何编译当前模块

1. 编译 Android 系统

Android 系统的编译环境目前只支持 Ubuntu 以及 Mac OS 两种操作系统。关于编译环境的构建方法请参见：搭建编译环境

编译命令:

$ source build/envsetup.sh 
$ lunch full-eng
$ make -j8

其中第一条命令引入了 “build/envsetup.sh” 脚本。该脚本的作用是初始化编译环境，并引入了一些辅助的 shell 函数，这其中就包含了第二步使用的 lunch 函数。

除此之外，该文件还定义了一些常见的函数，如下表：

名称	说明
croot	切换到源码树的根目录
m	在源码树的根目录执行 make
mm	build 当前目录下的模块
mmm	build 指定目录下的模块
cgrep	在所有 C/C++ 中执行 grep
jgrep	在所有 java 文件中执行 grep
resgrep	在所有 res/*.xml 文件上执行 grep
godir	转到包含某个文件的目录路径
printconfig	显示当前 Build 的配置信息
add_lunch_combo	在 lunch 函数的菜单中添加一个条目

第二条命令 “lunch full-eng” 是调用 lunch 函数，并指定参数为 “full-eng”。lunch 函数的参数用来指定此次编译的目标设备以及编译类型。

第三条命令 make 开始真正执行编译。make 的参数 “-j” 指定了同时编译的 job 数量。

make如果没有指定任何目标，则采用默认的名称"droid"目标，该目标会编译出整个android系统镜像。

Build 结果的目录结构

所有的编译产物都位于 out 目录下，该目录包含有以下几个子目录：

1. /out/host： 该目录下包含了针对主机的 Android 开发工具的产物。即 SDK 中的各种工具，例如 emulator、adb、aapt 等
2. out/target/common：该目录下包含了针对设备的共通的编译产物，主要是 Java 应用代码和 Java 库
3. out/target/product/<product_name>：包含了针对特定设备的编译结果以及平台相关的 C/C++ 库和二进制文件。其中，<product_name> 是具体目标设备的名称
4. out/dist：包含了为多种分发而准备的包，通过 “make disttarget” 将文件拷贝到该目录，默认的编译目标不会产生该目录

Build 生成的镜像文件

Build 的产物中最重要的是三个镜像文件，它们都位于 out/target/product/<product_name> 目录下
三个文件是：

1. system.img：包含了 Android OS 的系统文件库、可执行文件以及预置的应用程序，将被挂载为根分区
2. ramdisk.img：在启动时将被 Linux 内核挂载为只读分区，它包含了 init 文件和一些配置文件。
   它用来挂载其他系统镜像并启动 init 进程
3. userdata.img：将被挂在为 data，包含了应用程序相关的数据以及用户相关的数据

2. 编译流程

$ cd $源码树根目录
$ make -j8

整个编译系统的入口文件是源码树根目录下名称为 “Makefile” 的文件。make 命令首先将读取该文件。

Makefile 文件的内容只有一行：“include build/core/main.mk”。该行代码的作用很明显：包含 build/core/main.mk 文件。在 main.mk 文件中又会包含其他的文件，其他文件中又会包含更多的文件，这样就引入了整个编译系统。

下图说明了 main 编译文件包含的一些 Make 文件的作用：

文件名	说明
main.mk	整个编译系统的主导文件
help.mk	help 的目标定义，该目标将列出主要编译目标及其说明
cleanbuild.mk	clean 操作的定义
envsetup.mk	配置编译系统需要的环境变量（TARGET_PRODUCT）等
config.mk	重要，产品配置的主导文件
definitions.mk	重要，定义了大量的实用函数，供其他编译文件使用（all-subdir-makefiles）等
dex_preopt.mk	针对启动 jar 包的预先优化
pdk_config.mk	针对 pdk（Platform Developement Kit）的配置文件
host_static_library.mk	负责 BUILD_HOST_STATIC_LIBRARY 的具体实现，其他类型的BUILD_XX 这里不再赘述

1. main.mk

   • 检查编译环境
     比如 java 环境是否符合要求，当前是 linux 系统还是 mac 系统。
     如果这些检测中有任何一项不符合要求，则会终止编译
   • 进行一些必要的前期处理
     比如整个项目工程是否要进行清理操作，部分工具的安装等
   • 引用其他 Makefile 文件
     比如引用 config.mk，cleanbuild.mk

2. envsetup.mk

   • 配置编译系统需要的环境变量，例 TARGET_PRODUCT，TARGET_BUILD_VARIANT，HOST_OS，HOST_ARCH
   • 当前编译的主机平台信息（例如操作系统，CPU 类型等信息）
   • 指定各种编译结果的输出路径

3. definitions.mk

   • 定义了大量的函数。这些函数都是编译系统的其他文件将用到
     例如：my-dir，all-subdir-makefiles，find-subdir-files，sign-package 等

编译方式类型

Android 源码中有许多的模块，模块的类型有很多种，例如：Java 库、C/C++ 库、APK 应用以及可执行文件等。并且，库还可能是动态或者静态的。不同类型的模块编译步骤和编译方式是不一样的，为了能够一致统一的执行各模块的编译，在 config.mk 中定义了许多的常量，每个常量描述了一种模块类型的编译方式。

BUILD_HOST_STATIC_LIBRARY
BUILD_HOST_SHARED_LIBRARY
BUILD_STATIC_LIBRARY
BUILD_SHARED_LIBRARY
BUILD_EXECUTABLE
BUILD_HOST_EXECUTABLE
BUILD_PACKAGE
BUILD_PREBUILT
BUILD_MULTI_PREBUILT
BUILD_HOST_PREBUILT
BUILD_JAVA_LIBRARY
BUILD_STATIC_JAVA_LIBRARY
BUILD_HOST_JAVA_LIBRARY

通过名称就可以猜到每个变量所对应的模块类型，在 Android.mk 中，只要包含对应的常量便可执行相应类型模块的编译。

这些常量的值都是另外一个 Make 文件的路径，详细的编译方式都是在对应的 Make 文件中定义的。这些常量和 Make 文件的是一一对应的，对应规则也很简单：常量的名称是 Make 文件的文件名除去后缀全部改为大写然后加上 “BUILD_” 作为前缀。例如常量 BUILD_HOST_PREBUILT 的值对应的文件就是 host_prebuilt.mk。

文件名	说明
host_static_library.mk	定义了如何编译主机上的静态库。
host_shared_library.mk	定义了如何编译主机上的共享库。
static_library.mk	定义了如何编译设备上的静态库。
shared_library.mk	定义了如何编译设备上的共享库。
executable.mk	定义了如何编译设备上的可执行文件。
host_executable.mk	定义了如何编译主机上的可执行文件。
package.mk	定义了如何编译 APK 文件。
prebuilt.mk	定义了如何处理一个已经编译好的文件 ( 例如 Jar 包 )。
multi_prebuilt.mk	定义了如何处理一个或多个已编译文件，该文件的实现依赖 prebuilt.mk。
host_prebuilt.mk	处理一个或多个主机上使用的已编译文件，该文件的实现依赖 multi_prebuilt.mk。
java_library.mk	定义了如何编译设备上的共享 Java 库。
static_java_library.mk	定义了如何编译设备上的静态 Java 库。
host_java_library.mk	定义了如何编译主机上的共享 Java 库。

3. 编译目标说明

make / make droid

如果在源码树的根目录直接调用 “make” 命令而不指定任何目标，则会选择默认目标： “droid”

droid 目标将编译出整个系统的镜像。从源代码到编译出系统镜像，整个编译过程非常复杂。这个过程并不是在 droid 一个目标中定义的，而是 droid 目标会依赖许多其他的目标，这些目标的互相配合导致了整个系统的编译。

droid 所依赖的其他 Make 目标的说明

名称	说明
apps_only	该目标将编译出当前配置下不包含 user，userdebug，eng 标签的应用程序。
droidcore	该目标仅仅是所依赖的几个目标的组合，其本身不做更多的处理。
dist_files	该目标用来拷贝文件到 /out/dist 目录。
files	该目标仅仅是所依赖的几个目标的组合，其本身不做更多的处理。
prebuilt	该目标依赖于 $(AL{L}_{P}REBUILT)，$(ALL_PREBUILT)的作用就是处理所有已编译好的文件。
$(modules_to_install)	modules_to_install 变量包含了当前配置下所有会被安装的模块（一个模块是否会被安装依赖于该产品的配置文件，模块的标签等信息），因此该目标将导致所有会被安装的模块的编译。
$(modules_to_check)	该目标用来确保我们定义的构建模块是没有冗余的。
$(INSTALLED_ANDROID_INFO_TXT_TARGET)	该目标会生成一个关于当前 Build 配置的设备信息的文件，该文件的生成路径是：out/target/product/<product_name>/android-info.txt
systemimage	生成 system.img。
$(INSTALLED_BOOTIMAGE_TARGET)	生成 boot.img。
$(INSTALLED_RECOVERYIMAGE_TARGET)	生成 recovery.img。
$(INSTALLED_USERDATAIMAGE_TARGET)	生成 userdata.img。
$(INSTALLED_CACHEIMAGE_TARGET)	生成 cache.img。
$(INSTALLED_FILES_FILE)	该目标会生成 out/target/product/<product_name>/ installed-files.txt 文件，该文件中内容是当前系统镜像中已经安装的文件列表。

其他目标

编译目标	说明
make clean	执行清理，等同于：rm -rf out/
make sdk	编译出 Android 的 SDK
make clean-sdk	清理 SDK 的编译产物
make update-api	更新 API。在 framework API 改动之后，需要首先执行该命令来更新 API，公开的 API 记录在 frameworks/base/api 目录下
make dist	执行 Build，并将 MAKECMDGOALS 变量定义的输出文件拷贝到 /out/dist 目录
make all	编译所有内容，不管当前产品的定义中是否会包含
make snod	从已经编译出的包快速重建系统镜像
make libandroid_runtime	编译所有 JNI framework 内容
make framework	编译所有 Java framework 内容
make services	编译系统服务和相关内容
make <local_target>	编译一个指定的模块，local_target 为模块的名称
make clean-<local_target>	make clean-<local_target>