Build Docs

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

defaults list of string

arch interface

avb_algorithm string, Signing algorithm for avbtool. Default is SHA256_RSA4096.

avb_hash_algorithm string, Hash algorithm used for avbtool (for descriptors). This is passed as hash_algorithm to avbtool. Default is sha256.

avb_private_key string, Path to the private key that avbtool will use to sign this filesystem image. TODO(jiyong): allow apex_key to be specified here

base_dir string, Base directory relative to root, to which deps are installed, e.g. "system". Default is "." (root).

build_logtags bool, When set, builds etc/event-log-tags file by merging logtags from all dependencies. Default is false

check_vintf bool, Run checkvintf on the vintf manifests of the filesystem

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

deps configurable list of string, Modules to include in this package

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`.

dirs configurable list of string, Directories to be created under root. e.g. /dev, /proc, etc.

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)

enable_compression bool, Whether to enable per-file compression in f2fs

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.

fake_timestamp string, Seconds since unix epoch to override timestamps of file entries

file_contexts string, file_contexts file to make image. Currently, only ext4 is supported. These file contexts will be compiled with sefcontext_compile

gen_aconfig_flags_pb bool, Install aconfig_flags.pb file for the modules installed in this partition.

high_priority_deps list of string, Deps that have higher priority in packaging when there is a packaging conflict. For example, if multiple files are being installed to same filepath, the install file of the module listed in this property will have a higher priority over those in other deps properties.

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

include_files_of list of string, List of filesystem modules to include in creating the partition. The root directory of the provided filesystem modules are included in creating the partition. This is only supported for cpio and compressed cpio filesystem types.

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

is_auto_generated bool, Determines if the module is auto-generated from Soong or not. If the module is auto-generated, its deps are exempted from visibility enforcement.

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

mount_point string, Mount point for this image. Default is "/"

multilib interface

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

no_flashall bool, Whether this partition is not supported by flashall. If true, this partition will not be included in the `updatedpackage` dist artifact.

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

partition_name string, Name of the partition stored in vbmeta desc. Defaults to the name of this module.

partition_size int64, The size of the partition on the device. It will be a build error if this built partition image exceeds this size.

partition_type string, Identifies which partition this is for //visibility:any_system_image (and others) visibility checks, and will be used in the future for API surface checks.

precompiled_file_contexts string, The selinux file contexts, after having already run them through sefcontext_compile

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).

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

rollback_index int64, The index used to prevent rollback of the image. Only used if use_avb is true.

rollback_index_location int64, Rollback index location of this image. Must be 1, 2, 3, etc.

security_patch string, The security patch passed to as the com.android.build.<type>.security_patch avb property.

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).

stem string, Name of the output. Default is $(module_name).img

support_casefolding bool, Whether to format f2fs and ext4 in a way that supports casefolding

support_project_quota bool, Whether to format f2fs and ext4 in a way that supports project quotas

symlinks list of SymlinkDefinition, Symbolic links to be created under root with "ln -sf <target> <name>".

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_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.

type string, Type of the filesystem. Currently, ext4, erofs, cpio, and compressed_cpio are supported. Default is ext4.

use_avb bool, When set to true, sign the image with avbtool. Default is false.

use_fec bool, Whether or not to use forward-error-correction codes when signing with AVB. Defaults to true.

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.

uuid string, When set, passed to mkuserimg_mke2fs --mke2fs_uuid & --mke2fs_hash_seed. Otherwise, they'll be set as random which might cause indeterministic build output.

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.

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

defaults list of string

host_supported bool, If set to true, build a variant of the module for the host. Defaults to false.

device_supported bool, If set to true, build a variant of the module for the device. Defaults to true.

apex_available list of string, Availability of this module in APEXes. Only the listed APEXes can contain this module. If the module has stubs then other APEXes and the platform may access it through them (subject to visibility). "//apex_available:anyapex" is a pseudo APEX name that matches to any APEX. "//apex_available:platform" refers to non-APEX partitions like "system.img". Prefix pattern (com.foo.*) can be used to match with any APEX name with the prefix(com.foo.). Default is ["//apex_available:platform"].