Google最新源码编译系统

本文是何晓杰的译文

Soong 是原基于 make 的构建系统的替代品。它使用 Android.bp 来取代 Android.mk，并使用类似于 JSON 的格式来描述一个模块的构建方案。

Android.bp 文件格式

Android.bp 的设计非常简单，没有条件判断或控制流语句。在 Go 语言中编写的构建逻辑没有任何复杂度。Android.bp 的语法和语义可能也类似于 Bazel BUILD 文件。

模块

模块在 Android.bp 文件中以一个模块类型开始，后面跟着一组属性，以名值对(name: value)表示。基本格式为：

cc_binary {
    name: "gzip",
    srcs: ["src/test/minigzip.c"],
    shared_libs: ["libz"],
    stl: "none",
}

每个模块都必须有一个 name 属性，name 的值在所有的 Android.bp 文件中都必须是唯一的。

有关有效模块类型及其属性的列表，请参阅 $OUT_DIR/soong/.bootstrap/docs/soong_build.html。

变量

Android.bp 文件可以包含顶级变量并赋值：

gzip_srcs = ["src/test/minigzip.c"],

cc_binary {
    name: "gzip",
    srcs: gzip_srcs,
    shared_libs: ["libz"],
    stl: "none",
}

变量的范围被限定为它们声明的文件的剩余部分，以及任何子 blueprint 文件。变量只能够被 += 进行附加赋值，而且只有在被引用之前可变。

注释

Android.bp 文件可以使用 C 风格的多行 /* */ 和 C++ 风格的单行 // 注释。

类型

变量和属性是强类型的，基于第一次被赋值的值动态推定，以及由模块类型决定的静态属性。支持的类型有：

• 布尔值（true 或 false）
• 字符串（"string"）
• 字符串列表（["string1", "string2"]）
• Map（{key1: "value1", key2:["value2"]}）

Map 可以包含任意类型的值，包括嵌套的 Map。列表和 Map 允许在最后一个值之后有逗号。

操作符

字符串，字符串列表和 Map 可以使用 + 运算符进行附加。附加 Map 将生成两个 Map 中的键的并集，并且附加两个 Map 中存在的所有键的值。

默认模块

默认模块可以描述在多个模块中被重复的相同属性。例如：

cc_defaults {
    name: "gzip_defaults",
    shared_libs: ["libz"],
    stl: "none",
}

cc_binary {
    name: "gzip",
    defaults: ["gzip_defaults"],
    srcs: ["src/test/minigzip.c"],
}

格式化工具

Soong 包含了一个 blueprint 文件的格式化器，类似于 gofmt。使用以下命令来递归格式化当前目录中的所有 Android.bp 文件：

bpfmt -w。

标准格式包括 4 个空格的缩进，包含多个元素的列表中，每个元素之后的换行符，并且始终包括列表和 Map 中的逗号。

转换 Android.mk 文件

Soong 包含了一个工具，可以将 Android.mk 文件转换为 Android.bp 文件：

androidmk Android.mk > Android.bp

该工具可以转换变量，模块，注释和一些条件，但任何自定义的 Makefile 规则，复杂条件或额外的 include 必须手动转换。

Android.mk和Android.bp之间的差异

• Android.mk 文件通常包含了拥有相同名称的多个模块（例如，对于同时拥有静态和动态版本的库，或同时供主机和设备使用的库）。Android.bp 文件要求每个模块拥有唯一的名称，但每个模块可以内置多种变化，例如添加 host_supported: true。 androidmk 转换器将产生多个冲突的模块，必须手动合并到单个模块内的 target: { android: { }, host: { } } 块里。

构建逻辑

构建逻辑使用 Go 语言编写，并使用 blueprint 框架。构建逻辑接收模块定义，并利用反射和构建规则解析为 Go 数据结构。构建规则由 blueprint 收集并写入 ninja 构建文件。

常见问题

如何写一个条件判断？

Soong 故意不支持 Android.bp 文件中的条件。作为替代，复杂的、需要用到条件的构建规则已被 Go 处理，可以使用高级语言特征来跟踪由条件引入的隐式依赖关系。大多数条件将被转换为 Map 属性，Map 中的一个值将被选中并附加到顶级属性。

例如，支持特定架构的文件：

cc_library {
    ...
    srcs: ["generic.cpp"],
    arch: {
        arm: {
            srcs: ["arm.cpp"],
        },
        x86: {
            srcs: ["x86.cpp"],
        },
    },
}

有关产品变量或环境变量的更复杂条件的示例，请参阅 art/build/art.go 或 external/llvm/soong/llvm.go。

联系

如有任何问题，请发电子邮件至 android-building@googlegroups.com（外部），或查看 go/soong（内部）