Aucune description

Dan Willemsen bc203622e6 Add performance and best practices documentation il y a 6 ans
android 2383f3b693 Support filegroups for version_script and related properties il y a 6 ans
androidmk 5cfbfbb67a Use product instead of oem for Product specific module il y a 6 ans
bpfix 3a7822c571 Have bpfix not remove empty lists il y a 6 ans
cc 966bdded1f Merge "Enable emutls with -flto for Android sanitize=cfi" il y a 6 ans
cmd 5498f8548b Add a tool to inject data into an elf, macho, or PE symbol il y a 6 ans
docs bc203622e6 Add performance and best practices documentation il y a 6 ans
env 68f55102da Support dependencies on environment variables il y a 9 ans
finder ae7fd6baf3 Reimplement ioutil.ReadDir with a version that avoids calling lstat il y a 6 ans
genrule 31603067b0 Escape genrule commands il y a 6 ans
jar bddcf13555 Change default jar time to match ziptime il y a 6 ans
java 8222d3b31e Change the naming policy of system_$(VER) il y a 6 ans
phony 0f86d186b1 Allow AndroidMkData.Custom handlers to extend normal values il y a 6 ans
python ee6143cde2 Add VisitDirectDepsWithTag il y a 6 ans
scripts 6ea0f81c3f Remove unnecessary DeviceUsesClang. il y a 6 ans
shared efc1b412f1 Have Soong try to enforce that genrules declare all their outputs. il y a 7 ans
third_party 10e8e93710 Strip extended-timestap extra block in zip2zip. il y a 6 ans
ui e7945d76ac Make GOROOT consistent il y a 6 ans
zip f83c150269 Add --write_if_changed argument to soong_zip il y a 6 ans
Android.bp f0056cb2ed Refactor dexing il y a 6 ans
OWNERS f5b969cd2b Add srhines to the OWNERS for clang.go and global.go. il y a 6 ans
PREUPLOAD.cfg 78ffeea24e Fix gofmt problems and add gofmt to preupload checks il y a 7 ans
README.md bc203622e6 Add performance and best practices documentation il y a 6 ans
bootstrap.bash d00350c61b Add license headers to all go and shell files il y a 6 ans
build_test.bash 89479facb9 Get some more debugging for ckati crashes il y a 6 ans
doc.go 3f40fa460d Add soong_build primary builder il y a 9 ans
navbar.md bc203622e6 Add performance and best practices documentation il y a 6 ans
root.bp 393667285e Replace root.bp with a comment il y a 6 ans
soong.bash d00350c61b Add license headers to all go and shell files il y a 6 ans
soong.bootstrap.in 87b17d1ff4 Use SRCDIR as a working directory il y a 8 ans
soong_ui.bash 91f9b54767 Switch to blueprint's microfactory il y a 6 ans

README.md

Soong

Soong is the replacement for the old Android make-based build system. It replaces Android.mk files with Android.bp files, which are JSON-like simple declarative descriptions of modules to build.

Android.bp file format

By design, Android.bp files are very simple. There are no conditionals or control flow statements - any complexity is handled in build logic written in Go. The syntax and semantics of Android.bp files are intentionally similar to Bazel BUILD files when possible.

Modules

A module in an Android.bp file starts with a module type, followed by a set of properties in name: value, format:

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

Every module must have a name property, and the value must be unique across all Android.bp files.

For a list of valid module types and their properties see $OUT_DIR/soong/.bootstrap/docs/soong_build.html.

Variables

An Android.bp file may contain top-level variable assignments:

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

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

Variables are scoped to the remainder of the file they are declared in, as well as any child blueprint files. Variables are immutable with one exception - they can be appended to with a += assignment, but only before they have been referenced.

Comments

Android.bp files can contain C-style multiline /* */ and C++ style single-line // comments.

Types

Variables and properties are strongly typed, variables dynamically based on the first assignment, and properties statically by the module type. The supported types are:

  • Bool (true or false)
  • Integers (int)
  • Strings ("string")
  • Lists of strings (["string1", "string2"])
  • Maps ({key1: "value1", key2: ["value2"]})

Maps may values of any type, including nested maps. Lists and maps may have trailing commas after the last value.

Operators

Strings, lists of strings, and maps can be appended using the + operator. Integers can be summed up using the + operator. Appending a map produces the union of keys in both maps, appending the values of any keys that are present in both maps.

Defaults modules

A defaults module can be used to repeat the same properties in multiple modules. For example:

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

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

Name resolution

Soong provides the ability for modules in different directories to specify the same name, as long as each module is declared within a separate namespace. A namespace can be declared like this:

soong_namespace {
    imports: ["path/to/otherNamespace1", "path/to/otherNamespace2"],
}

Each Soong module is assigned a namespace based on its location in the tree. Each Soong module is considered to be in the namespace defined by the soong_namespace found in an Android.bp in the current directory or closest ancestor directory, unless no such soong_namespace module is found, in which case the module is considered to be in the implicit root namespace.

When Soong attempts to resolve dependency D declared my module M in namespace N which imports namespaces I1, I2, I3…, then if D is a fully-qualified name of the form «//namespace:module», only the specified namespace will be searched for the specified module name. Otherwise, Soong will first look for a module named D declared in namespace N. If that module does not exist, Soong will look for a module named D in namespaces I1, I2, I3… Lastly, Soong will look in the root namespace.

Until we have fully converted from Make to Soong, it will be necessary for the Make product config to specify a value of PRODUCT_SOONG_NAMESPACES. Its value should be a space-separated list of namespaces that Soong export to Make to be built by the m command. After we have fully converted from Make to Soong, the details of enabling namespaces could potentially change.

Formatter

Soong includes a canonical formatter for blueprint files, similar to gofmt. To recursively reformat all Android.bp files in the current directory:

bpfmt -w .

The canonical format includes 4 space indents, newlines after every element of a multi-element list, and always includes a trailing comma in lists and maps.

Convert Android.mk files

Soong includes a tool perform a first pass at converting Android.mk files to Android.bp files:

androidmk Android.mk > Android.bp

The tool converts variables, modules, comments, and some conditionals, but any custom Makefile rules, complex conditionals or extra includes must be converted by hand.

Differences between Android.mk and Android.bp

  • Android.mk files often have multiple modules with the same name (for example for static and shared version of a library, or for host and device versions). Android.bp files require unique names for every module, but a single module can be built in multiple variants, for example by adding host_supported: true. The androidmk converter will produce multiple conflicting modules, which must be resolved by hand to a single module with any differences inside target: { android: { }, host: { } } blocks.

Build logic

The build logic is written in Go using the blueprint framework. Build logic receives module definitions parsed into Go structures using reflection and produces build rules. The build rules are collected by blueprint and written to a ninja build file.

Other documentation

FAQ

How do I write conditionals?

Soong deliberately does not support conditionals in Android.bp files. Instead, complexity in build rules that would require conditionals are handled in Go, where high level language features can be used and implicit dependencies introduced by conditionals can be tracked. Most conditionals are converted to a map property, where one of the values in the map will be selected and appended to the top level properties.

For example, to support architecture specific files:

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

See art/build/art.go or external/llvm/soong/llvm.go for examples of more complex conditionals on product variables or environment variables.

Contact

Email android-building@googlegroups.com (external) for any questions, or see go/soong (internal).