Build Docs

all_apex_certs

all_apex_certs is a singleton module that collects the certs of all apexes in the tree. It provides two types of output files 1. .pem: This is usually the checked-in x509 certificate in PEM format 2. .der: This is DER format of the certificate, and is generated from the PEM certificate using `openssl x509`

name string, The name of the module. Must be unique across all modules. Default: all_apex_certs

arch interface

compile_multilib string, control whether this module compiles for 32-bit, 64-bit, or both. Possible values are "32" (compile for 32-bit only), "64" (compile for 64-bit only), "both" (compile for both architectures), or "first" (compile for 64-bit on a 64-bit platform, and 32-bit on a 32-bit platform).

debug_ramdisk bool, Whether this module is installed to debug ramdisk

device_specific bool, whether this module is specific to a device, not only for SoC, but also for off-chip peripherals. When set to true, it is installed into /odm (or /vendor/odm if odm partition does not exist, or /system/vendor/odm if both odm and vendor partitions do not exist). This implies `soc_specific:true`.

⊕dist Dist

configuration to distribute output files from this module to the distribution directory (default: $OUT/dist, configurable with $DIST_DIR)

targets list of string, Copy the output of this module to the $DIST_DIR when `dist` is specified on the command line and any of these targets are also on the command line, or otherwise built

dest string, The name of the output artifact. This defaults to the basename of the output of the module.

dir string, The directory within the dist directory to store the artifact. Defaults to the top level directory ("").

suffix string, A suffix to add to the artifact file name (before any extension).

append_artifact_with_product bool, If true, then the artifact file will be appended with _<product name>. For example, if the product is coral and the module is an android_app module of name foo, then the artifact would be foo_coral.apk. If false, there is no change to the artifact file name.

prepend_artifact_with_product bool, If true, then the artifact file will be prepended with <product name>-. For example, if the product is coral and the module is an android_app module of name foo, then the artifact would be coral-foo.apk. If false, there is no change to the artifact file name.

tag string, A string tag to select the OutputFiles associated with the tag. If no tag is specified then it will select the default dist paths provided by the module type. If a tag of "" is specified then it will return the default output files provided by the modules, i.e. the result of calling OutputFiles("").

dists list of Dist, a list of configurations to distribute output files from this module to the distribution directory (default: $OUT/dist, configurable with $DIST_DIR)

enabled configurable bool, emit build rules for this module Disabling a module should only be done for those modules that cannot be built in the current environment. Modules that can build in the current environment but are not usually required (e.g. superceded by a prebuilt) should not be disabled as that will prevent them from being built by the checkbuild target and so prevent early detection of changes that have broken those modules.

host_required list of string, names of other modules to install on host if this module is installed

init_rc configurable list of string, init.rc files to be installed if this module is installed

licenses list of string, Describes the licenses applicable to this module. Must reference license modules.

multilib interface

native_bridge_supported bool, Whether this module is built for non-native architectures (also known as native bridge binary)

no_full_install bool, When set to true, this module is not installed to the full install path (ex: under out/target/product/<name>/<partition>). It can be installed only to the packaging modules like android_filesystem.

odm_dlkm_specific bool, Install to partition odm_dlkm when set to true.

overrides list of string, List of module names that are prevented from being installed when this module gets installed.

owner string, vendor who owns this module

product_specific bool, whether this module is specific to a software configuration of a product (e.g. country, network operator, etc). When set to true, it is installed into /product (or /system/product if product partition does not exist).

⊕product_variables.debuggable

⊕init_rc

[]string

⊕required

[]string

⊕host_required

[]string

⊕target_required

[]string

⊕product_variables.release_aidl_use_unfrozen

⊕required

[]string

⊕vintf_fragment_modules

[]string

⊕product_variables.selinuxignoreneverallows

⊕required

[]string

⊕product_variables.unbundled_build

⊕enabled Configurable[bool]

Configurable[bool] proptools.Configurable[bool]

proprietary bool, whether this is a proprietary vendor module, and should be installed into /vendor

ramdisk bool, Whether this module is installed to ramdisk

recovery bool, Whether this module is installed to recovery partition

required configurable list of string, names of other modules to install if this module is installed

soc_specific bool, whether this module is specific to an SoC (System-On-a-Chip). When set to true, it is installed into /vendor (or /system/vendor if vendor partition does not exist).

system_dlkm_specific bool, Install to partition system_dlkm when set to true.

system_ext_specific bool, whether this module extends system. When set to true, it is installed into /system_ext (or /system/system_ext if system_ext partition does not exist).

target interface

⊕target.android

compile_multilib string

enabled bool

⊕target.host

compile_multilib string

target_required list of string, names of other modules to install on target if this module is installed

team string, The team (defined by the owner/vendor) who owns the property.

use_generic_config bool, Set to true if this module must be generic and does not require product-specific information. To be included in the system image, this property must be set to true.

vendor bool, whether this module is specific to an SoC (System-On-a-Chip). When set to true, it is installed into /vendor (or /system/vendor if vendor partition does not exist). Use `soc_specific` instead for better meaning.

vendor_dlkm_specific bool, Install to partition vendor_dlkm when set to true.

vendor_ramdisk bool, Whether this module is installed to vendor ramdisk

vintf_fragment_modules configurable list of string, vintf_fragment Modules required from this module.

vintf_fragments configurable list of string, VINTF manifest fragments to be installed if this module is installed

visibility list of string, Controls the visibility of this module to other modules. Allowable values are one or more of these formats:


 ["//visibility:public"]: Anyone can use this module.
 ["//visibility:private"]: Only rules in the module's package (not its subpackages) can use
     this module.
 ["//visibility:override"]: Discards any rules inherited from defaults or a creating module.
     Can only be used at the beginning of a list of visibility rules.
 ["//some/package:__pkg__", "//other/package:__pkg__"]: Only modules in some/package and
     other/package (defined in some/package/*.bp and other/package/*.bp) have access to
     this module. Note that sub-packages do not have access to the rule; for example,
     //some/package/foo:bar or //other/package/testing:bla wouldn't have access. __pkg__
     is a special module and must be used verbatim. It represents all of the modules in the
     package.
 ["//project:__subpackages__", "//other:__subpackages__"]: Only modules in packages project
     or other or in one of their sub-packages have access to this module. For example,
     //project:rule, //project/library:lib or //other/testing/internal:munge are allowed
     to depend on this rule (but not //independent:evil)
 ["//project"]: This is shorthand for ["//project:__pkg__"]
 [":__subpackages__"]: This is shorthand for ["//project:__subpackages__"] where
     //project is the module's package. e.g. using [":__subpackages__"] in
     packages/apps/Settings/Android.bp is equivalent to
     //packages/apps/Settings:__subpackages__.
 ["//visibility:legacy_public"]: The default visibility, behaves as //visibility:public
     for now. It is an error if it is used in a module.

If a module does not specify the `visibility` property then it uses the `default_visibility` property of the `package` module in the module's package. If the `default_visibility` property is not set for the module's package then it will use the `default_visibility` of its closest ancestor package for which a `default_visibility` property is specified. If no `default_visibility` property can be found then the module uses the global default of `//visibility:legacy_public`. The `visibility` property has no effect on a defaults module although it does apply to any non-defaults module that uses it. To set the visibility of a defaults module, use the `defaults_visibility` property on the defaults module; not to be confused with the `default_visibility` property on the package module. See https://android.googlesource.com/platform/build/soong/+/main/README.md#visibility for more details. Default: [//cts/tests/tests/security //cts/hostsidetests/appsecurity]

apex

apex packages other modules into an APEX file which is a packaging format for system-level components like binaries, shared libraries, etc.

name string, The name of the module. Must be unique across all modules.

defaults list of string

allowed_files string, A txt file containing list of files that are allowed to be included in this APEX.

androidManifest configurable string, AndroidManifest.xml file used for the zip container of this APEX bundle. If unspecified, a default one is automatically generated.

apex_available_name string, Name that dependencies can specify in their apex_available properties to refer to this module. If not specified, this defaults to Soong module name. This must be the name of a Soong module.

apps configurable list of string, List of APKs that are embedded inside this APEX.

arch interface

⊕arch.arm

native_shared_libs configurable list of string, List of native libraries that are embedded inside this APEX.

jni_libs configurable list of string, List of JNI libraries that are embedded inside this APEX.

rust_dyn_libs list of string, List of rust dyn libraries that are embedded inside this APEX.

binaries configurable list of string, List of native executables that are embedded inside this APEX.

tests list of string, List of native tests that are embedded inside this APEX.

filesystems list of string, List of filesystem images that are embedded inside this APEX bundle.

prebuilts configurable list of string, List of prebuilt_etcs that are embedded inside this APEX bundle.

exclude_native_shared_libs list of string, List of native libraries to exclude from this APEX.

exclude_jni_libs list of string, List of JNI libraries to exclude from this APEX.

exclude_rust_dyn_libs list of string, List of rust dyn libraries to exclude from this APEX.

exclude_binaries list of string, List of native executables to exclude from this APEX.

exclude_tests list of string, List of native tests to exclude from this APEX.

exclude_filesystems list of string, List of filesystem images to exclude from this APEX bundle.

exclude_prebuilts list of string, List of prebuilt_etcs to exclude from this APEX bundle.

⊕arch.arm64