art_apex_test_host
name
,
defaults
,
host_supported
,
device_supported
,
allowed_files
,
androidManifest
,
apps
,
arch
,
arch.arm
,
arch.arm64
,
arch.riscv64
,
arch.x86
,
arch.x86_64
,
bazel_module
,
binaries
,
bootclasspath_fragments
,
bpfs
,
canned_fs_config
,
certificate
,
compat_configs
,
compile_multilib
,
compressible
,
custom_sign_tool
,
debug_ramdisk
,
device_specific
,
dist
,
dists
,
dynamic_common_lib_apex
,
enabled
,
exclude_binaries
,
exclude_filesystems
,
exclude_jni_libs
,
exclude_native_shared_libs
,
exclude_rust_dyn_libs
,
exclude_tests
,
export
,
file_contexts
,
filesystems
,
future_updatable
,
generate_hashtree
,
host_required
,
ignore_system_library_special_case
,
init_rc
,
installable
,
java_libs
,
jni_libs
,
key
,
licenses
,
logging_parent
,
manifest
,
min_sdk_version
,
multilib
,
multilib.both
,
multilib.first
,
multilib.lib32
,
multilib.lib64
,
multilib.prefer32
,
native_bridge_supported
,
native_shared_libs
,
overrides
,
owner
,
package_name
,
payload_fs_type
,
payload_type
,
platform_apis
,
prebuilts
,
product_specific
,
product_variables.always_use_prebuilt_sdks
,
product_variables.debuggable
,
product_variables.flatten_apex
,
product_variables.pdk
,
product_variables.unbundled_build
,
proprietary
,
ramdisk
,
recovery
,
required
,
rros
,
rust_dyn_libs
,
sh_binaries
,
soc_specific
,
system_ext_specific
,
systemserverclasspath_fragments
,
target
,
target.android
,
target.host
,
target.linux_bionic
,
target.linux_glibc
,
target_required
,
test_only_force_compression
,
test_only_unsigned_payload
,
tests
,
trim_against
,
updatable
,
use_file_contexts_as_is
,
use_vndk_as_stable
,
vendor
,
vendor_ramdisk
,
vintf_fragments
,
visibility
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.
allowed_files
string, A txt file containing list of files that are allowed to be included in this APEX.
androidManifest
string, AndroidManifest.xml file used for the zip container of this APEX bundle. If unspecified,
a default one is automatically generated.
apps
list of string, List of APKs that are embedded inside this APEX.
arch
interface
⊕arch.arm
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕arch.arm64
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕arch.riscv64
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕arch.x86
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕arch.x86_64
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕bazel_module
bazelModuleProperties
In "Bazel mixed build" mode, this represents the Bazel target replacing
this Soong module.
label
string, The label of the Bazel target replacing this Soong module. When run in conversion mode, this
will import the handcrafted build target into the autogenerated file. Note: this may result in
a conflict due to duplicate targets if bp2build_available is also set.
bp2build_available
bool, If true, bp2build will generate the converted Bazel target for this module. Note: this may
cause a conflict due to the duplicate targets if label is also set.
This is a bool pointer to support tristates: true, false, not set.
To opt in a module, set bazel_module: { bp2build_available: true }
To opt out a module, set bazel_module: { bp2build_available: false }
To defer the default setting for the directory, do not set the value.
binaries
list of string, List of native executables that are embedded inside this APEX.
bootclasspath_fragments
list of string, List of bootclasspath fragments that are embedded inside this APEX bundle.
bpfs
list of string, List of BPF programs inside this APEX bundle.
canned_fs_config
string, Path to the canned fs config file for customizing file's
uid/gid/mod/capabilities. The content of this file is appended to the
default config, so that the custom entries are preferred. The format is
/<path_or_glob> <uid> <gid> <mode> [capabilities=0x<cap>], where
path_or_glob is a path or glob pattern for a file or set of files,
uid/gid are numerial values of user ID and group ID, mode is octal value
for the file mode, and cap is hexadecimal value for the capability.
certificate
string, Specifies the certificate and the private key to sign the zip container of this APEX. If
this is "foo", foo.x509.pem and foo.pk8 under PRODUCT_DEFAULT_DEV_CERTIFICATE are used
as the certificate and the private key, respectively. If this is ":module", then the
certificate and the private key are provided from the android_app_certificate module
named "module".
compat_configs
list of string, List of platform_compat_config files that are embedded inside this APEX bundle.
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).
compressible
bool, Whether this APEX can be compressed or not. Setting this property to false means this
APEX will never be compressed. When set to true, APEX will be compressed if other
conditions, e.g., target device needs to support APEX compression, are also fulfilled.
Default: false.
custom_sign_tool
string, Put extra tags (signer=<value>) to apexkeys.txt, so that release tools can sign this apex
with the tool to sign payload contents.
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.
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)
dynamic_common_lib_apex
bool, Whether this is a dynamic common lib apex, if so the native shared libs will be placed
in a special way that include the digest of the lib file under /lib(64)?
enabled
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.
exclude_binaries
list of string, List of native executables to exclude from this APEX.
exclude_filesystems
list of string, List of filesystem images to exclude from this APEX bundle.
exclude_jni_libs
list of string, List of JNI libraries to exclude from this APEX.
exclude_native_shared_libs
list of string, List of native libraries to exclude from this APEX.
exclude_rust_dyn_libs
list of string, List of rust dyn libraries to exclude from this APEX.
exclude_tests
list of string, List of native tests to exclude from this APEX.
export
bool, True if the module is exported to the other components in a multi-tree.
Any components in the multi-tree can import this module to use.
file_contexts
string, Determines the file contexts file for setting the security contexts to files in this APEX
bundle. For platform APEXes, this should points to a file under /system/sepolicy Default:
/system/sepolicy/apex/<module_name>_file_contexts.
filesystems
list of string, List of filesystem images that are embedded inside this APEX bundle.
future_updatable
bool, Marks that this APEX is designed to be updatable in the future, although it's not
updatable yet. This is used to mimic some of the build behaviors that are applied only to
updatable APEXes. Currently, this disables the size optimization, so that the size of
APEX will not increase when the APEX is actually marked as truly updatable. Default is
false.
generate_hashtree
bool, Whenever apex_payload.img of the APEX should include dm-verity hashtree.
Default value is true.
host_required
list of string, names of other modules to install on host if this module is installed
ignore_system_library_special_case
bool, For telling the APEX to ignore special handling for system libraries such as bionic.
Default is false.
init_rc
list of string, init.rc files to be installed if this module is installed
installable
bool, Whether this APEX is installable to one of the partitions like system, vendor, etc.
Default: true.
java_libs
list of string, List of java libraries that are embedded inside this APEX bundle.
jni_libs
list of string, List of JNI libraries that are embedded inside this APEX.
key
string, Name of the apex_key module that provides the private key to sign this APEX bundle.
licenses
list of string, Describes the licenses applicable to this module. Must reference license modules.
logging_parent
string, Logging parent value.
manifest
string, Json manifest file describing meta info of this APEX bundle. Refer to
system/apex/proto/apex_manifest.proto for the schema. Default: "apex_manifest.json"
min_sdk_version
string, The minimum SDK version that this APEX must support at minimum. This is usually set to
the SDK version that the APEX was first introduced.
multilib
interface
⊕multilib.both
ApexNativeDependencies
Native dependencies whose compile_multilib is "both"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.first
ApexNativeDependencies
Native dependencies whose compile_multilib is "first"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.lib32
ApexNativeDependencies
Native dependencies whose compile_multilib is "32"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.lib64
ApexNativeDependencies
Native dependencies whose compile_multilib is "64"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.prefer32
ApexNativeDependencies
Native dependencies whose compile_multilib is "prefer32"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
native_bridge_supported
bool, Whether this module is built for non-native architectures (also known as native bridge binary)
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
overrides
list of string, Names of modules to be overridden. Listed modules can only be other binaries (in Make or
Soong). This does not completely prevent installation of the overridden binaries, but if
both binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will
be removed from PRODUCT_PACKAGES.
owner
string, vendor who owns this module
package_name
string, Apex Container package name. Override value for attribute package:name in
AndroidManifest.xml
payload_fs_type
string, The type of filesystem to use when the payload_type is 'image'. Either 'ext4', 'f2fs'
or 'erofs'. Default 'ext4'.
payload_type
string, The type of APEX to build. Controls what the APEX payload is. Either 'image', 'zip' or
'both'. When set to image, contents are stored in a filesystem image inside a zip
container. When set to zip, contents are stored in a zip container directly. This type is
mostly for host-side debugging. When set to both, the two types are both built. Default
is 'image'.
platform_apis
bool, Whether this APEX can use platform APIs or not. Can be set to true only when `updatable:
false`. Default is false.
prebuilts
list of string, List of prebuilt files that are embedded inside this APEX bundle.
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.always_use_prebuilt_sdks
⊕product_variables.debuggable
⊕init_rc
⊕required
⊕host_required
⊕target_required
⊕product_variables.flatten_apex
⊕product_variables.pdk
⊕product_variables.unbundled_build
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
list of string, names of other modules to install if this module is installed
rros
list of string, List of runtime resource overlays (RROs) that are embedded inside this APEX.
rust_dyn_libs
list of string, List of rust dyn libraries that are embedded inside this APEX.
sh_binaries
list of string, List of sh binaries that are embedded inside this APEX bundle.
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_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).
systemserverclasspath_fragments
list of string, List of systemserverclasspath fragments that are embedded inside this APEX bundle.
target
interface
⊕target.android
Multilib properties only for android.
⊕multilib.first
ApexNativeDependencies
Native dependencies whose compile_multilib is "first"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.both
ApexNativeDependencies
Native dependencies whose compile_multilib is "both"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.prefer32
ApexNativeDependencies
Native dependencies whose compile_multilib is "prefer32"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.lib32
ApexNativeDependencies
Native dependencies whose compile_multilib is "32"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.lib64
ApexNativeDependencies
Native dependencies whose compile_multilib is "64"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
compile_multilib
string
⊕target.host
Multilib properties only for host.
⊕multilib.first
ApexNativeDependencies
Native dependencies whose compile_multilib is "first"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.both
ApexNativeDependencies
Native dependencies whose compile_multilib is "both"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.prefer32
ApexNativeDependencies
Native dependencies whose compile_multilib is "prefer32"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.lib32
ApexNativeDependencies
Native dependencies whose compile_multilib is "32"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.lib64
ApexNativeDependencies
Native dependencies whose compile_multilib is "64"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
compile_multilib
string
⊕target.linux_bionic
Multilib properties only for host linux_bionic.
⊕multilib.first
ApexNativeDependencies
Native dependencies whose compile_multilib is "first"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.both
ApexNativeDependencies
Native dependencies whose compile_multilib is "both"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.prefer32
ApexNativeDependencies
Native dependencies whose compile_multilib is "prefer32"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.lib32
ApexNativeDependencies
Native dependencies whose compile_multilib is "32"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.lib64
ApexNativeDependencies
Native dependencies whose compile_multilib is "64"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕target.linux_glibc
Multilib properties only for host linux_glibc.
⊕multilib.first
ApexNativeDependencies
Native dependencies whose compile_multilib is "first"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.both
ApexNativeDependencies
Native dependencies whose compile_multilib is "both"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.prefer32
ApexNativeDependencies
Native dependencies whose compile_multilib is "prefer32"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.lib32
ApexNativeDependencies
Native dependencies whose compile_multilib is "32"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
⊕multilib.lib64
ApexNativeDependencies
Native dependencies whose compile_multilib is "64"
native_shared_libs
list of string, List of native libraries that are embedded inside this APEX.
jni_libs
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
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.
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.
target_required
list of string, names of other modules to install on target if this module is installed
test_only_force_compression
bool, Whenever apex should be compressed, regardless of product flag used. Should be only
used in tests.
test_only_unsigned_payload
bool, Whenever apex_payload.img of the APEX should not be dm-verity signed. Should be only
used in tests.
tests
list of string, List of native tests that are embedded inside this APEX.
trim_against
string, Trim against a specific Dynamic Common Lib APEX
updatable
bool, Whether this APEX is considered updatable or not. When set to true, this will enforce
additional rules for making sure that the APEX is truly updatable. To be updatable,
min_sdk_version should be set as well. This will also disable the size optimizations like
symlinking to the system libs. Default is true.
use_file_contexts_as_is
bool, By default, file_contexts is amended by force-labelling / and /apex_manifest.pb as system_file
to avoid mistakes. When set as true, no force-labelling.
use_vndk_as_stable
bool, If set true, VNDK libs are considered as stable libs and are not included in this APEX.
Should be only used in non-system apexes (e.g. vendor: true). Default is false.
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_ramdisk
bool, Whether this module is installed to vendor ramdisk
vintf_fragments
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/+/master/README.md#visibility for
more details.
art_cc_binary
name
,
srcs
,
exclude_srcs
,
defaults
,
host_supported
,
device_supported
,
afdo
,
aidl
,
allow_undefined_symbols
,
apex_available
,
arch
,
asflags
,
bazel_module
,
bootstrap
,
buildstubs
,
c_std
,
cflags
,
clang
,
clang_asflags
,
clang_cflags
,
compile_multilib
,
conlyflags
,
cpp_std
,
cppflags
,
debug
,
debug_ramdisk
,
device_specific
,
dist
,
dists
,
double_loadable
,
dynamic_list
,
enabled
,
exclude_from_recovery_snapshot
,
exclude_from_vendor_snapshot
,
exclude_generated_sources
,
exclude_runtime_libs
,
exclude_shared_libs
,
exclude_static_libs
,
export_generated_headers
,
export_header_lib_headers
,
export_shared_lib_headers
,
export_static_lib_headers
,
generated_headers
,
generated_sources
,
gnu_extensions
,
group_static_libs
,
header_libs
,
host_ldlibs
,
host_required
,
include_build_directory
,
include_dirs
,
init_rc
,
inject_bssl_hash
,
install_in_root
,
install_in_xbin
,
installable
,
instruction_set
,
ldflags
,
lex
,
licenses
,
linker_scripts
,
local_include_dirs
,
logtags
,
lto
,
min_sdk_version
,
multilib
,
native_bridge_supported
,
native_coverage
,
no_libcrt
,
nocrt
,
odm_available
,
openmp
,
overrides
,
owner
,
pack_relocations
,
pgo
,
prefix_symbols
,
product_available
,
product_specific
,
product_variables.always_use_prebuilt_sdks
,
product_variables.arc
,
product_variables.binder32bit
,
product_variables.debuggable
,
product_variables.enforce_vintf_manifest
,
product_variables.eng
,
product_variables.flatten_apex
,
product_variables.malloc_not_svelte
,
product_variables.malloc_pattern_fill_contents
,
product_variables.malloc_zero_contents
,
product_variables.native_coverage
,
product_variables.override_rs_driver
,
product_variables.pdk
,
product_variables.platform_sdk_version
,
product_variables.safestack
,
product_variables.treble_linker_namespaces
,
product_variables.uml
,
product_variables.unbundled_build
,
proprietary
,
proto
,
ramdisk
,
ramdisk_available
,
recovery
,
recovery_available
,
relative_install_path
,
release
,
renderscript
,
required
,
rtti
,
runtime_libs
,
sanitize
,
sdclang
,
sdk_variant_only
,
sdk_version
,
shared_libs
,
soc_specific
,
static_executable
,
static_libs
,
stem
,
stl
,
strip
,
suffix
,
symlink_preferred_arch
,
symlinks
,
system_ext_specific
,
system_shared_libs
,
target
,
target.android
,
target.apex
,
target.host
,
target.platform
,
target.product
,
target.ramdisk
,
target.recovery
,
target.vendor
,
target.vendor_ramdisk
,
target_required
,
test_for
,
tidy
,
tidy_checks
,
tidy_checks_as_errors
,
tidy_disabled_srcs
,
tidy_flags
,
tidy_timeout_srcs
,
use_clang_lld
,
use_version_lib
,
vendor
,
vendor_available
,
vendor_ramdisk
,
vendor_ramdisk_available
,
version_script
,
vintf_fragments
,
visibility
,
vndk
,
whole_program_vtables
,
whole_static_libs
,
yacc
name
string, The name of the module. Must be unique across all modules.
srcs
list of string, list of source files used to compile the C/C++ module. May be .c, .cpp, or .S files.
srcs may reference the outputs of other modules that produce source files like genrule
or filegroup using the syntax ":module".
exclude_srcs
list of string, list of source files that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
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.
afdo
bool, Afdo allows developers self-service enroll for
automatic feedback-directed optimization using profile data.
⊕aidl
include_dirs
list of string, list of directories that will be added to the aidl include paths.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the aidl include paths.
generate_traces
bool, whether to generate traces (for systrace) for this interface
flags
list of string, list of flags that will be passed to the AIDL compiler
allow_undefined_symbols
bool, allow the module to contain undefined symbols. By default,
modules cannot contain undefined symbols that are not satisified by their immediate
dependencies. Set this flag to true to remove --no-undefined from the linker flags.
This flag should only be necessary for compiling low-level libraries like libc.
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".
"com.android.gki.*" matches any APEX module name with the prefix "com.android.gki.".
Default is ["//apex_available:platform"].
arch
interface
asflags
list of string, list of module-specific flags that will be used for .S compiles
⊕bazel_module
bazelModuleProperties
In "Bazel mixed build" mode, this represents the Bazel target replacing
this Soong module.
label
string, The label of the Bazel target replacing this Soong module. When run in conversion mode, this
will import the handcrafted build target into the autogenerated file. Note: this may result in
a conflict due to duplicate targets if bp2build_available is also set.
bp2build_available
bool, If true, bp2build will generate the converted Bazel target for this module. Note: this may
cause a conflict due to the duplicate targets if label is also set.
This is a bool pointer to support tristates: true, false, not set.
To opt in a module, set bazel_module: { bp2build_available: true }
To opt out a module, set bazel_module: { bp2build_available: false }
To defer the default setting for the directory, do not set the value.
bootstrap
bool, Allows this module to use non-APEX version of libraries. Useful
for building binaries that are started before APEXes are activated.
⊕buildstubs
bool
c_std
string, C standard version to use. Can be a specific version (such as "gnu11"),
"experimental" (which will use draft versions like C1x when available),
or the empty string (which will use the default).
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles.
clang
bool, Deprecated. true is the default, false is invalid.
clang_asflags
list of string, list of module-specific flags that will be used for .S compiles when
compiling with clang
clang_cflags
list of string, list of module-specific flags that will be used for C and C++ compiles when
compiling with clang
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).
conlyflags
list of string, list of module-specific flags that will be used for C compiles
cpp_std
string, C++ standard version to use. Can be a specific version (such as
"gnu++11"), "experimental" (which will use draft versions like C++1z when
available), or the empty string (which will use the default).
cppflags
list of string, list of module-specific flags that will be used for C++ compiles
⊕debug
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
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.
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)
double_loadable
bool, whether this module is capable of being loaded with other instance
(possibly an older version) of the same module in the same process.
Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
can be double loaded in a vendor process if the library is also a
(direct and indirect) dependency of an LLNDK library. Such libraries must be
explicitly marked as `double_loadable: true` by the owner, or the dependency
from the LLNDK lib should be cut if the lib is not designed to be double loaded.
dynamic_list
string, local file name to pass to the linker as --dynamic-list
enabled
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.
exclude_from_recovery_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the recovery snapshot.
exclude_from_vendor_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the vendor snapshot.
exclude_generated_sources
list of string, list of generated sources that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with this module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build this module
exclude_static_libs
list of string, list of static libs that should not be used to build this module
generated_sources
list of string, list of generated sources to compile. These are the names of gensrcs or
genrule modules.
gnu_extensions
bool, if set to false, use -std=c++* instead of -std=gnu++*
group_static_libs
bool, deprecated and ignored because lld makes it unnecessary. See b/189475744.
host_ldlibs
list of string, -l arguments to pass to linker for host-provided shared libraries
host_required
list of string, names of other modules to install on host if this module is installed
include_build_directory
bool, Add the directory containing the Android.bp file to the list of include
directories. Defaults to true.
include_dirs
list of string, list of directories relative to the root of the source tree that will
be added to the include path using -I.
If possible, don't use this. If adding paths from the current directory use
local_include_dirs, if adding paths from other modules use export_include_dirs in
that module.
init_rc
list of string, init.rc files to be installed if this module is installed
inject_bssl_hash
bool, Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
install_in_root
bool, Install output directly in {partition}/, not in any subdir. This is only intended for use by
init_first_stage.
install_in_xbin
bool, Install output directly in {partition}/xbin
installable
bool
instruction_set
string, the instruction set architecture to use to compile the C/C++
module.
ldflags
list of string, list of module-specific flags that will be used for all link steps
lex
LexProperties
licenses
list of string, Describes the licenses applicable to this module. Must reference license modules.
linker_scripts
list of string, local files to pass to the linker as --script
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path using -I
logtags
list of string, *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
file
⊕lto
Lto must violate capitialization style for acronyms so that it can be
referred to in blueprint files as "lto"
never
bool
full
bool
thin
bool
min_sdk_version
string, Minimum OS API level supported by this C or C++ module. This property becomes the value
of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
this property is also used to ensure that the min_sdk_version of the containing module is
not older (i.e. less) than this module's min_sdk_version. When not set, this property
defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
min_sdk_version of the containing APEX. When the module
is not built for an APEX, "apex_inherit" defaults to sdk_version.
multilib
interface
native_bridge_supported
bool, Whether this module is built for non-native architectures (also known as native bridge binary)
native_coverage
bool
no_libcrt
bool, don't link in libclang_rt.builtins-*.a
nocrt
bool, don't link in crt_begin and crt_end. This flag should only be necessary for
compiling crt or libc.
odm_available
bool, This is the same as the "vendor_available" except that the install path
of the vendor variant is /odm or /vendor/odm.
By replacing "vendor_available: true" with "odm_available: true", the
module will install its vendor variant to the /odm partition or /vendor/odm.
As the modules with "odm_available: true" still create the vendor variants,
they can link to the other vendor modules as the vendor_available modules do.
Also, the vendor modules can link to odm_available modules.
It may not be used for VNDK modules.
openmp
bool, Build and link with OpenMP
overrides
list of string, Names of modules to be overridden. Listed modules can only be other binaries
(in Make or Soong).
This does not completely prevent installation of the overridden binaries, but if both
binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
from PRODUCT_PACKAGES.
owner
string, vendor who owns this module
pack_relocations
bool, Generate compact dynamic relocation table, default true.
⊕pgo
instrumentation
bool
profile_file
string
benchmarks
list of string
enable_profile_use
bool
cflags
list of string, Additional compiler flags to use when building this module
for profiling.
prefix_symbols
string, if set, add an extra objcopy --prefix-symbols= step
product_available
bool, whether this module should be allowed to be directly depended by other
modules with `product_specific: true` or `product_available: true`.
If set to true, an additional product variant will be built separately
that is limited to the set of libraries and headers that are exposed to
/product modules.
The product variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /product modules.
Different from the 'vendor_available' property, the modules with
vndk: {enabled: true} don't have to define 'product_available'. The VNDK
library without 'product_available' may not be depended on by any other
modules that has product variants including the product available VNDKs.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
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.always_use_prebuilt_sdks
⊕product_variables.arc
⊕cflags
⊕exclude_srcs
⊕include_dirs
⊕shared_libs
⊕static_libs
⊕srcs
⊕whole_static_libs
⊕product_variables.binder32bit
⊕product_variables.debuggable
⊕cflags
⊕cppflags
⊕init_rc
⊕required
⊕host_required
⊕target_required
⊕strip.all
⊕strip.keep_symbols
⊕strip.keep_symbols_and_debug_frame
⊕static_libs
⊕whole_static_libs
⊕shared_libs
⊕srcs
⊕exclude_srcs
⊕product_variables.enforce_vintf_manifest
⊕product_variables.eng
⊕cflags
⊕cppflags
⊕lto.never
⊕sanitize.address
⊕product_variables.flatten_apex
⊕product_variables.malloc_not_svelte
⊕cflags
⊕shared_libs
⊕whole_static_libs
⊕exclude_static_libs
⊕srcs
⊕product_variables.malloc_pattern_fill_contents
⊕product_variables.malloc_zero_contents
⊕product_variables.native_coverage
⊕product_variables.override_rs_driver
⊕product_variables.pdk
⊕product_variables.platform_sdk_version
⊕product_variables.safestack
⊕product_variables.treble_linker_namespaces
⊕product_variables.uml
⊕product_variables.unbundled_build
proprietary
bool, whether this is a proprietary vendor module, and should be installed into /vendor
⊕proto
type
string, Proto generator type. C++: full or lite. Java: micro, nano, stream, or lite.
plugin
string, Proto plugin to use as the generator. Must be a cc_binary_host module.
include_dirs
list of string, list of directories that will be added to the protoc include paths.
local_include_dirs
list of string, list of directories relative to the bp file that will
be added to the protoc include paths.
canonical_path_from_root
bool, whether to identify the proto files from the root of the
source tree (the original method in Android, useful for
android-specific protos), or relative from where they were
specified (useful for external/third party protos).
This defaults to true today, but is expected to default to
false in the future.
static
bool, Link statically against the protobuf runtime
ramdisk
bool, Whether this module is installed to ramdisk
ramdisk_available
bool, Make this module available when building for ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
recovery
bool, Whether this module is installed to recovery partition
recovery_available
bool, Make this module available when building for recovery
relative_install_path
string, install to a subdirectory of the default install path for the module
⊕release
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
⊕renderscript
include_dirs
list of string, list of directories that will be added to the llvm-rs-cc include paths
flags
list of string, list of flags that will be passed to llvm-rs-cc
target_api
string, Renderscript API level to target
required
list of string, names of other modules to install if this module is installed
rtti
bool, pass -frtti instead of -fno-rtti
runtime_libs
list of string, list of modules that should be installed with this module. This is similar to 'required'
but '.vendor' suffix will be appended to the module names if the shared libraries have
vendor variants and this module uses VNDK.
⊕sanitize
SanitizeUserProps
never
bool, Prevent use of any sanitizers on this module
address
bool, ASan (Address sanitizer), incompatible with static binaries.
Always runs in a diagnostic mode.
Use of address sanitizer disables cfi sanitizer.
Hwaddress sanitizer takes precedence over this sanitizer.
thread
bool, TSan (Thread sanitizer), incompatible with static binaries and 32 bit architectures.
Always runs in a diagnostic mode.
Use of thread sanitizer disables cfi and scudo sanitizers.
Hwaddress sanitizer takes precedence over this sanitizer.
hwaddress
bool, HWASan (Hardware Address sanitizer).
Use of hwasan sanitizer disables cfi, address, thread, and scudo sanitizers.
all_undefined
bool, Undefined behavior sanitizer
undefined
bool, Subset of undefined behavior sanitizer
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable
fuzzer
bool, Fuzzer, incompatible with static binaries.
safestack
bool, safe-stack sanitizer, incompatible with 32-bit architectures.
cfi
bool, cfi sanitizer, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, incompatible with Darwin.
scudo
bool, scudo sanitizer, incompatible with asan, hwasan, tsan
This should not be used in Android 11+ : https://source.android.com/devices/tech/debug/scudo
deprecated
scs
bool, shadow-call-stack sanitizer, only available on arm64/riscv64.
memtag_heap
bool, Memory-tagging, only available on arm64
if diag.memtag unset or false, enables async memory tagging
memtag_stack
bool, Memory-tagging stack instrumentation, only available on arm64
Adds instrumentation to detect stack buffer overflows and use-after-scope using MTE.
writeonly
bool, A modifier for ASAN and HWASAN for write only instrumentation
⊕diag
Sanitizers to run in the diagnostic mode (as opposed to the release mode).
Replaces abort() on error with a human-readable error message.
Address and Thread sanitizers always run in diagnostic mode.
undefined
bool, Undefined behavior sanitizer, diagnostic mode
cfi
bool, cfi sanitizer, diagnostic mode, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, diagnostic mode, incompatible with Darwin.
memtag_heap
bool, Memory-tagging, only available on arm64
requires sanitizer.memtag: true
if set, enables sync memory tagging
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable in diagnostic mode
no_recover
list of string, List of sanitizers to pass to -fno-sanitize-recover
results in only the first detected error for these sanitizers being reported and program then
exits with a non-zero exit code.
⊕config
Sanitizers to run with flag configuration specified
cfi_assembly_support
bool, Enables CFI support flags for assembly-heavy libraries
recover
list of string, List of sanitizers to pass to -fsanitize-recover
allows execution to continue for these sanitizers to detect multiple errors rather than only
the first one
blocklist
string, value to pass to -fsanitize-ignorelist
sdclang
bool, compile module with SDLLVM instead of AOSP LLVM
sdk_variant_only
bool, If true, always create an sdk variant and don't create a platform variant.
sdk_version
string, The API level that this module is built against. The APIs of this API level will be
visible at build time, but use of any APIs newer than min_sdk_version will render the
module unloadable on older devices. In the future it will be possible to weakly-link new
APIs, making the behavior match Java: such modules will load on older devices, but
calling new APIs on devices that do not support them will result in a crash.
This property has the same behavior as sdk_version does for Java modules. For those
familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
does for Java code.
In addition, setting this property causes two variants to be built, one for the platform
and one for apps.
shared_libs
list of string, list of modules that should be dynamically linked into this module.
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).
static_executable
bool, compile executable with -static
static_libs
list of string, list of modules that should be statically linked into this module.
stem
string, set the name of the output
stl
string, Select the STL library to use. Possible values are "libc++",
"libc++_static", "libstdc++", or "none". Leave blank to select the
default.
⊕strip
none
bool, none forces all stripping to be disabled.
Device modules default to stripping enabled leaving mini debuginfo.
Host modules default to stripping disabled, but can be enabled by setting any other
strip boolean property.
all
bool, all forces stripping everything, including the mini debug info.
keep_symbols
bool, keep_symbols enables stripping but keeps all symbols.
keep_symbols_list
list of string, keep_symbols_list specifies a list of symbols to keep if keep_symbols is enabled.
If it is unset then all symbols are kept.
keep_symbols_and_debug_frame
bool, keep_symbols_and_debug_frame enables stripping but keeps all symbols and debug frames.
suffix
string, append to the name of the output
symlink_preferred_arch
bool, if set, install a symlink to the preferred architecture
symlinks
list of string, install symlinks to the binary. Symlink names will have the suffix and the binary
extension (if any) appended
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).
system_shared_libs
list of string, list of system libraries that will be dynamically linked to
shared library and executable modules. If unset, generally defaults to libc,
libm, and libdl. Set to [] to prevent linking against the defaults.
target
interface
⊕target.android
⊕target.apex
exclude_shared_libs
list of string, list of shared libs that should not be used to build the apex variant of
the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build the apex
variant of the C/C++ module.
⊕target.host
⊕target.platform
required
list of string, List of modules required by the core variant.
exclude_required
list of string, List of modules not required by the core variant.
shared_libs
list of string, list of shared libs that should be use to build the platform variant
of a module that sets sdk_version. This should rarely be necessary,
in most cases the same libraries are available for the SDK and platform
variants.
exclude_shared_libs
list of string, list of shared libs that should not be used to build the platform variant
of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the platform
variant of the C/C++ module.
⊕target.product
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
⊕target.ramdisk
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
ramdisk variant of the C/C++ module.
⊕target.recovery
required
list of string, List of modules required by the recovery variant.
exclude_required
list of string, List of modules not required by the recovery variant.
srcs
list of string, list of source files that should only be used in the
recovery variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to
build the recovery variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the recovery
variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to
build the recovery variant of the C/C++ module.
shared_libs
list of string, list of shared libs that only should be used to build the recovery
variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
recovery variant of the C/C++ module.
⊕target.vendor
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
⊕target.vendor_ramdisk
exclude_srcs
list of string, list of source files that should not be used to
build the vendor ramdisk variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the vendor ramdisk
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the vendor ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor ramdisk variant of the C/C++ module.
target_required
list of string, names of other modules to install on target if this module is installed
test_for
list of string, List of APEXes that this module has private access to for testing purpose. The module
can depend on libraries that are not exported by the APEXes and use private symbols
from the exported libraries.
tidy
bool, whether to run clang-tidy over C-like sources.
tidy_checks
list of string, Extra checks to enable or disable in clang-tidy
tidy_checks_as_errors
list of string, Checks that should be treated as errors.
tidy_disabled_srcs
list of string, list of source files that should not be compiled with clang-tidy.
tidy_flags
list of string, Extra flags to pass to clang-tidy
tidy_timeout_srcs
list of string, list of source files that should not be compiled by clang-tidy when TIDY_TIMEOUT is set.
use_clang_lld
bool, Use clang lld instead of gnu ld.
use_version_lib
bool, make android::build:GetBuildNumber() available containing the build ID.
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_available
bool, whether this module should be allowed to be directly depended by other
modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
If set to true, two variants will be built separately, one like
normal, and the other limited to the set of libraries and headers
that are exposed to /vendor modules.
The vendor variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /vendor modules.
The modules with vndk: {enabled: true} must define 'vendor_available'
to 'true'.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
vendor_ramdisk
bool, Whether this module is installed to vendor ramdisk
vendor_ramdisk_available
bool, Make this module available when building for vendor ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
version_script
string, local file name to pass to the linker as --version-script
vintf_fragments
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/+/master/README.md#visibility for
more details.
⊕vndk
enabled
bool, declared as a VNDK or VNDK-SP module. The vendor variant
will be installed in /system instead of /vendor partition.
`vendor_available` and `product_available` must be explicitly
set to either true or false together with `vndk: {enabled: true}`.
support_system_process
bool, declared as a VNDK-SP module, which is a subset of VNDK.
`vndk: { enabled: true }` must set together.
All these modules are allowed to link to VNDK-SP or LL-NDK
modules only. Other dependency will cause link-type errors.
If `support_system_process` is not set or set to false,
the module is VNDK-core and can link to other VNDK-core,
VNDK-SP or LL-NDK modules only.
private
bool, declared as a VNDK-private module.
This module still creates the vendor and product variants refering
to the `vendor_available: true` and `product_available: true`
properties. However, it is only available to the other VNDK modules
but not to the non-VNDK vendor or product modules.
extends
string, Extending another module
whole_program_vtables
bool, Use -fwhole-program-vtables cflag.
whole_static_libs
list of string, list of modules whose object files should be linked into this module
in their entirety. For static library modules, all of the .o files from the intermediate
directory of the dependency will be linked into this modules .a file. For a shared library,
the dependency's .a file will be linked into this module using -Wl,--whole-archive.
yacc
YaccProperties
art_cc_defaults
name
,
srcs
,
exclude_srcs
,
defaults
,
host_supported
,
device_supported
,
afdo
,
aidl
,
allow_undefined_symbols
,
apex_available
,
arch
,
asflags
,
auto_gen_config
,
bazel_module
,
bootstrap
,
c_std
,
cflags
,
check_elf_files
,
clang
,
clang_asflags
,
clang_cflags
,
codegen.arm
,
codegen.arm64
,
codegen.riscv64
,
codegen.x86
,
codegen.x86_64
,
compile_multilib
,
conlyflags
,
corpus
,
cpp_std
,
cppflags
,
crt
,
data
,
data_bins
,
data_libs
,
debug
,
debug_ramdisk
,
defaults_visibility
,
device_specific
,
dictionary
,
disable_framework
,
dist
,
dists
,
double_loadable
,
dynamic_list
,
enabled
,
exclude_from_ndk_sysroot
,
exclude_from_recovery_snapshot
,
exclude_from_vendor_snapshot
,
exclude_generated_sources
,
exclude_runtime_libs
,
exclude_shared_libs
,
exclude_static_libs
,
export_generated_headers
,
export_header_lib_headers
,
export_include_dirs
,
export_shared_lib_headers
,
export_static_lib_headers
,
export_system_include_dirs
,
force_symbols_not_weak_list
,
force_symbols_weak_list
,
fuzz_config
,
fuzzing_frameworks
,
generated_headers
,
generated_sources
,
gnu_extensions
,
group_static_libs
,
gtest
,
header_abi_checker
,
header_libs
,
host_ldlibs
,
host_required
,
include_build_directory
,
include_dirs
,
init_rc
,
inject_bssl_hash
,
install_in_root
,
install_in_xbin
,
installable
,
instruction_set
,
isolated
,
ldflags
,
lex
,
licenses
,
linker_script
,
linker_scripts
,
llndk
,
local_include_dirs
,
logtags
,
lto
,
min_sdk_version
,
multilib
,
native_bridge_supported
,
native_coverage
,
no_libcrt
,
no_named_install_directory
,
nocrt
,
objs
,
odm_available
,
openmp
,
overrides
,
owner
,
pack_relocations
,
per_testcase_directory
,
pgo
,
prefix_symbols
,
product_available
,
product_specific
,
product_variables.always_use_prebuilt_sdks
,
product_variables.arc
,
product_variables.binder32bit
,
product_variables.debuggable
,
product_variables.enforce_vintf_manifest
,
product_variables.eng
,
product_variables.flatten_apex
,
product_variables.malloc_not_svelte
,
product_variables.malloc_pattern_fill_contents
,
product_variables.malloc_zero_contents
,
product_variables.native_coverage
,
product_variables.override_rs_driver
,
product_variables.pdk
,
product_variables.platform_sdk_version
,
product_variables.safestack
,
product_variables.treble_linker_namespaces
,
product_variables.uml
,
product_variables.unbundled_build
,
proprietary
,
proto
,
ramdisk
,
ramdisk_available
,
recovery
,
recovery_available
,
relative_install_path
,
release
,
renderscript
,
require_root
,
required
,
rtti
,
runtime_libs
,
sanitize
,
sanitized.address
,
sanitized.hwaddress
,
sanitized.none
,
sdclang
,
sdk_variant_only
,
sdk_version
,
shared
,
shared_libs
,
soc_specific
,
static
,
static_executable
,
static_libs
,
static_ndk_lib
,
stem
,
stl
,
strip
,
stubs
,
suffix
,
symlink_preferred_arch
,
symlinks
,
system_ext_specific
,
system_shared_libs
,
target
,
target.android
,
target.apex
,
target.host
,
target.platform
,
target.product
,
target.ramdisk
,
target.recovery
,
target.vendor
,
target.vendor_ramdisk
,
target_required
,
test_config
,
test_config_template
,
test_for
,
test_mainline_modules
,
test_options
,
test_per_src
,
test_suites
,
tidy
,
tidy_checks
,
tidy_checks_as_errors
,
tidy_disabled_srcs
,
tidy_flags
,
tidy_timeout_srcs
,
unexported_symbols_list
,
unique_host_soname
,
use_clang_lld
,
use_version_lib
,
vendor
,
vendor_available
,
vendor_public_library
,
vendor_ramdisk
,
vendor_ramdisk_available
,
version_script
,
vintf_fragments
,
visibility
,
vndk
,
whole_program_vtables
,
whole_static_libs
,
windows_import_lib
,
yacc
name
string, The name of the module. Must be unique across all modules.
srcs
list of string, list of source files used to compile the C/C++ module. May be .c, .cpp, or .S files.
srcs may reference the outputs of other modules that produce source files like genrule
or filegroup using the syntax ":module".
exclude_srcs
list of string, list of source files that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
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.
afdo
bool, Afdo allows developers self-service enroll for
automatic feedback-directed optimization using profile data.
⊕aidl
include_dirs
list of string, list of directories that will be added to the aidl include paths.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the aidl include paths.
generate_traces
bool, whether to generate traces (for systrace) for this interface
flags
list of string, list of flags that will be passed to the AIDL compiler
allow_undefined_symbols
bool, allow the module to contain undefined symbols. By default,
modules cannot contain undefined symbols that are not satisified by their immediate
dependencies. Set this flag to true to remove --no-undefined from the linker flags.
This flag should only be necessary for compiling low-level libraries like libc.
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".
"com.android.gki.*" matches any APEX module name with the prefix "com.android.gki.".
Default is ["//apex_available:platform"].
arch
interface
asflags
list of string, list of module-specific flags that will be used for .S compiles
auto_gen_config
bool, Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
explicitly.
⊕bazel_module
bazelModuleProperties
In "Bazel mixed build" mode, this represents the Bazel target replacing
this Soong module.
label
string, The label of the Bazel target replacing this Soong module. When run in conversion mode, this
will import the handcrafted build target into the autogenerated file. Note: this may result in
a conflict due to duplicate targets if bp2build_available is also set.
bp2build_available
bool, If true, bp2build will generate the converted Bazel target for this module. Note: this may
cause a conflict due to the duplicate targets if label is also set.
This is a bool pointer to support tristates: true, false, not set.
To opt in a module, set bazel_module: { bp2build_available: true }
To opt out a module, set bazel_module: { bp2build_available: false }
To defer the default setting for the directory, do not set the value.
bootstrap
bool, Allows this module to use non-APEX version of libraries. Useful
for building binaries that are started before APEXes are activated.
c_std
string, C standard version to use. Can be a specific version (such as "gnu11"),
"experimental" (which will use draft versions like C1x when available),
or the empty string (which will use the default).
If this is set, the file extension will be ignored and this will be used as the std version value. Setting this
to "default" will use the build system default version. This cannot be set at the same time as cpp_std.
cflags
list of string, list of clang flags required to correctly interpret the headers.
check_elf_files
bool, Check the prebuilt ELF files (e.g. DT_SONAME, DT_NEEDED, resolution of undefined
symbols, etc), default true.
clang
bool, Deprecated. true is the default, false is invalid.
clang_asflags
list of string, list of module-specific flags that will be used for .S compiles when
compiling with clang
clang_cflags
list of string, list of module-specific flags that will be used for C and C++ compiles when
compiling with clang
⊕codegen.arm
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.arm64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.riscv64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86_64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
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).
conlyflags
list of string, list of module-specific flags that will be used for C compiles
corpus
list of string, Optional list of seed files to be installed to the fuzz target's output
directory.
cpp_std
string, C++ standard version to use. Can be a specific version (such as
"gnu++11"), "experimental" (which will use draft versions like C++1z when
available), or the empty string (which will use the default).
cppflags
list of string, list of module-specific flags that will be used for C++ compiles
crt
bool, Indicates that this module is a CRT object. CRT objects will be split
into a variant per-API level between min_sdk_version and current.
data
list of string, list of files or filegroup modules that provide data that should be installed alongside
the test
data_bins
list of string, list of binary modules that should be installed alongside the test
data_libs
list of string, list of shared library modules that should be installed alongside the test
⊕debug
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
debug_ramdisk
bool, Whether this module is installed to debug ramdisk
defaults_visibility
list of string, Controls the visibility of the defaults module itself.
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`.
dictionary
string, Optional dictionary to be installed to the fuzz target's output directory.
disable_framework
bool, Add RunCommandTargetPreparer to stop framework before the test and start it after the test.
⊕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.
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)
double_loadable
bool, whether this module is capable of being loaded with other instance
(possibly an older version) of the same module in the same process.
Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
can be double loaded in a vendor process if the library is also a
(direct and indirect) dependency of an LLNDK library. Such libraries must be
explicitly marked as `double_loadable: true` by the owner, or the dependency
from the LLNDK lib should be cut if the lib is not designed to be double loaded.
dynamic_list
string, local file name to pass to the linker as --dynamic-list
enabled
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.
exclude_from_ndk_sysroot
bool, Indicates that this module should not be included in the NDK sysroot.
Only applies to CRT objects. Defaults to false.
exclude_from_recovery_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the recovery snapshot.
exclude_from_vendor_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the vendor snapshot.
exclude_generated_sources
list of string, list of generated sources that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with this module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build this module
exclude_static_libs
list of string, list of static libs that should not be used to build this module
export_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path (using -I) for this module and any module that links
against this module. Directories listed in export_include_dirs do not need to be
listed in local_include_dirs.
export_system_include_dirs
list of string, list of directories that will be added to the system include path
using -isystem for this module and any module that links against this module.
force_symbols_not_weak_list
string, local file name to pass to the linker as -force_symbols_not_weak_list
force_symbols_weak_list
string, local file name to pass to the linker as -force_symbols_weak_list
fuzz_config
FuzzConfig, Config for running the target on fuzzing infrastructure.
fuzzing_frameworks
FuzzFrameworks, Define the fuzzing frameworks this fuzz target can be built for. If
empty then the fuzz target will be available to be built for all fuzz
frameworks available
generated_sources
list of string, list of generated sources to compile. These are the names of gensrcs or
genrule modules.
gnu_extensions
bool, if set to false, use -std=c++* instead of -std=gnu++*
group_static_libs
bool, deprecated and ignored because lld makes it unnecessary. See b/189475744.
gtest
bool, if set, build against the gtest library. Defaults to true.
Properties for ABI compatibility checker.
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
host_ldlibs
list of string, -l arguments to pass to linker for host-provided shared libraries
host_required
list of string, names of other modules to install on host if this module is installed
include_build_directory
bool, Add the directory containing the Android.bp file to the list of include
directories. Defaults to true.
include_dirs
list of string, list of directories relative to the root of the source tree that will
be added to the include path using -I.
If possible, don't use this. If adding paths from the current directory use
local_include_dirs, if adding paths from other modules use export_include_dirs in
that module.
init_rc
list of string, init.rc files to be installed if this module is installed
inject_bssl_hash
bool, Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
install_in_root
bool, Install output directly in {partition}/, not in any subdir. This is only intended for use by
init_first_stage.
install_in_xbin
bool, Install output directly in {partition}/xbin
installable
bool
instruction_set
string, the instruction set architecture to use to compile the C/C++
module.
isolated
bool, if set, use the isolated gtest runner. Defaults to true if gtest is also true and the arch is Windows, false
otherwise.
ldflags
list of string, list of module-specific flags that will be used for all link steps
lex
LexProperties
licenses
list of string, Describes the licenses applicable to this module. Must reference license modules.
linker_script
string, if set, the path to a linker script to pass to ld -r when combining multiple object files.
linker_scripts
list of string, local files to pass to the linker as --script
⊕llndk
llndkLibraryProperties
If this is an LLNDK library, properties to describe the LLNDK stubs. Will be copied from
the module pointed to by llndk_stubs if it is set.
symbol_file
string, Relative path to the symbol map.
An example file can be seen here: TODO(danalbert): Make an example.
unversioned
bool, Whether the system library uses symbol versions.
override_export_include_dirs
list of string, list of directories relative to the Blueprints file that willbe added to the include path
(using -I) for any module that links against the LLNDK variant of this module, replacing
any that were listed outside the llndk clause.
private
bool, whether this module can be directly depended upon by libs that are installed
to /vendor and /product.
When set to true, this module can only be depended on by VNDK libraries, not
vendor nor product libraries. This effectively hides this module from
non-system modules. Default value is false.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path using -I
logtags
list of string, *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
file
⊕lto
Lto must violate capitialization style for acronyms so that it can be
referred to in blueprint files as "lto"
never
bool
full
bool
thin
bool
min_sdk_version
string, Minimum OS API level supported by this C or C++ module. This property becomes the value
of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
this property is also used to ensure that the min_sdk_version of the containing module is
not older (i.e. less) than this module's min_sdk_version. When not set, this property
defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
min_sdk_version of the containing APEX. When the module
is not built for an APEX, "apex_inherit" defaults to sdk_version.
multilib
interface
native_bridge_supported
bool, Whether this module is built for non-native architectures (also known as native bridge binary)
native_coverage
bool
no_libcrt
bool, don't link in libclang_rt.builtins-*.a
no_named_install_directory
bool, Disables the creation of a test-specific directory when used with
relative_install_path. Useful if several tests need to be in the same
directory, but test_per_src doesn't work.
nocrt
bool, don't link in crt_begin and crt_end. This flag should only be necessary for
compiling crt or libc.
objs
list of string, names of other cc_object modules to link into this module using partial linking
odm_available
bool, This is the same as the "vendor_available" except that the install path
of the vendor variant is /odm or /vendor/odm.
By replacing "vendor_available: true" with "odm_available: true", the
module will install its vendor variant to the /odm partition or /vendor/odm.
As the modules with "odm_available: true" still create the vendor variants,
they can link to the other vendor modules as the vendor_available modules do.
Also, the vendor modules can link to odm_available modules.
It may not be used for VNDK modules.
openmp
bool, Build and link with OpenMP
overrides
list of string, Names of modules to be overridden. Listed modules can only be other shared libraries
(in Make or Soong).
This does not completely prevent installation of the overridden libraries, but if both
binaries would be installed by default (in PRODUCT_PACKAGES) the other library will be removed
from PRODUCT_PACKAGES.
owner
string, vendor who owns this module
pack_relocations
bool, Generate compact dynamic relocation table, default true.
per_testcase_directory
bool, Install the test into a folder named for the module in all test suites.
⊕pgo
instrumentation
bool
profile_file
string
benchmarks
list of string
enable_profile_use
bool
cflags
list of string, Additional compiler flags to use when building this module
for profiling.
prefix_symbols
string, if set, add an extra objcopy --prefix-symbols= step
product_available
bool, whether this module should be allowed to be directly depended by other
modules with `product_specific: true` or `product_available: true`.
If set to true, an additional product variant will be built separately
that is limited to the set of libraries and headers that are exposed to
/product modules.
The product variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /product modules.
Different from the 'vendor_available' property, the modules with
vndk: {enabled: true} don't have to define 'product_available'. The VNDK
library without 'product_available' may not be depended on by any other
modules that has product variants including the product available VNDKs.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
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.always_use_prebuilt_sdks
⊕product_variables.arc
⊕cflags
⊕exclude_srcs
⊕include_dirs
⊕shared_libs
⊕static_libs
⊕srcs
⊕whole_static_libs
⊕product_variables.binder32bit
⊕product_variables.debuggable
⊕cflags
⊕cppflags
⊕init_rc
⊕required
⊕host_required
⊕target_required
⊕strip.all
⊕strip.keep_symbols
⊕strip.keep_symbols_and_debug_frame
⊕static_libs
⊕whole_static_libs
⊕shared_libs
⊕srcs
⊕exclude_srcs
⊕product_variables.enforce_vintf_manifest
⊕product_variables.eng
⊕cflags
⊕cppflags
⊕lto.never
⊕sanitize.address
⊕product_variables.flatten_apex
⊕product_variables.malloc_not_svelte
⊕cflags
⊕shared_libs
⊕whole_static_libs
⊕exclude_static_libs
⊕srcs
⊕product_variables.malloc_pattern_fill_contents
⊕product_variables.malloc_zero_contents
⊕product_variables.native_coverage
⊕product_variables.override_rs_driver
⊕product_variables.pdk
⊕product_variables.platform_sdk_version
⊕product_variables.safestack
⊕product_variables.treble_linker_namespaces
⊕product_variables.uml
⊕product_variables.unbundled_build
proprietary
bool, whether this is a proprietary vendor module, and should be installed into /vendor
⊕proto
static
bool, Link statically against the protobuf runtime
type
string, Proto generator type. C++: full or lite. Java: micro, nano, stream, or lite.
plugin
string, Proto plugin to use as the generator. Must be a cc_binary_host module.
include_dirs
list of string, list of directories that will be added to the protoc include paths.
local_include_dirs
list of string, list of directories relative to the bp file that will
be added to the protoc include paths.
canonical_path_from_root
bool, whether to identify the proto files from the root of the
source tree (the original method in Android, useful for
android-specific protos), or relative from where they were
specified (useful for external/third party protos).
This defaults to true today, but is expected to default to
false in the future.
ramdisk
bool, Whether this module is installed to ramdisk
ramdisk_available
bool, Make this module available when building for ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
recovery
bool, Whether this module is installed to recovery partition
recovery_available
bool, Make this module available when building for recovery
relative_install_path
string, install to a subdirectory of the default install path for the module
⊕release
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
⊕renderscript
include_dirs
list of string, list of directories that will be added to the llvm-rs-cc include paths
flags
list of string, list of flags that will be passed to llvm-rs-cc
target_api
string, Renderscript API level to target
require_root
bool, Add RootTargetPreparer to auto generated test config. This guarantees the test to run
with root permission.
required
list of string, names of other modules to install if this module is installed
rtti
bool, pass -frtti instead of -fno-rtti
runtime_libs
list of string, list of modules that should be installed with this module. This is similar to 'required'
but '.vendor' suffix will be appended to the module names if the shared libraries have
vendor variants and this module uses VNDK.
⊕sanitize
SanitizeUserProps
never
bool, Prevent use of any sanitizers on this module
address
bool, ASan (Address sanitizer), incompatible with static binaries.
Always runs in a diagnostic mode.
Use of address sanitizer disables cfi sanitizer.
Hwaddress sanitizer takes precedence over this sanitizer.
thread
bool, TSan (Thread sanitizer), incompatible with static binaries and 32 bit architectures.
Always runs in a diagnostic mode.
Use of thread sanitizer disables cfi and scudo sanitizers.
Hwaddress sanitizer takes precedence over this sanitizer.
hwaddress
bool, HWASan (Hardware Address sanitizer).
Use of hwasan sanitizer disables cfi, address, thread, and scudo sanitizers.
all_undefined
bool, Undefined behavior sanitizer
undefined
bool, Subset of undefined behavior sanitizer
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable
fuzzer
bool, Fuzzer, incompatible with static binaries.
safestack
bool, safe-stack sanitizer, incompatible with 32-bit architectures.
cfi
bool, cfi sanitizer, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, incompatible with Darwin.
scudo
bool, scudo sanitizer, incompatible with asan, hwasan, tsan
This should not be used in Android 11+ : https://source.android.com/devices/tech/debug/scudo
deprecated
scs
bool, shadow-call-stack sanitizer, only available on arm64/riscv64.
memtag_heap
bool, Memory-tagging, only available on arm64
if diag.memtag unset or false, enables async memory tagging
memtag_stack
bool, Memory-tagging stack instrumentation, only available on arm64
Adds instrumentation to detect stack buffer overflows and use-after-scope using MTE.
writeonly
bool, A modifier for ASAN and HWASAN for write only instrumentation
⊕diag
Sanitizers to run in the diagnostic mode (as opposed to the release mode).
Replaces abort() on error with a human-readable error message.
Address and Thread sanitizers always run in diagnostic mode.
undefined
bool, Undefined behavior sanitizer, diagnostic mode
cfi
bool, cfi sanitizer, diagnostic mode, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, diagnostic mode, incompatible with Darwin.
memtag_heap
bool, Memory-tagging, only available on arm64
requires sanitizer.memtag: true
if set, enables sync memory tagging
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable in diagnostic mode
no_recover
list of string, List of sanitizers to pass to -fno-sanitize-recover
results in only the first detected error for these sanitizers being reported and program then
exits with a non-zero exit code.
⊕config
Sanitizers to run with flag configuration specified
cfi_assembly_support
bool, Enables CFI support flags for assembly-heavy libraries
recover
list of string, List of sanitizers to pass to -fsanitize-recover
allows execution to continue for these sanitizers to detect multiple errors rather than only
the first one
blocklist
string, value to pass to -fsanitize-ignorelist
⊕sanitized.address
⊕sanitized.hwaddress
⊕sanitized.none
sdclang
bool, compile module with SDLLVM instead of AOSP LLVM
sdk_variant_only
bool, If true, always create an sdk variant and don't create a platform variant.
sdk_version
string, The API level that this module is built against. The APIs of this API level will be
visible at build time, but use of any APIs newer than min_sdk_version will render the
module unloadable on older devices. In the future it will be possible to weakly-link new
APIs, making the behavior match Java: such modules will load on older devices, but
calling new APIs on devices that do not support them will result in a crash.
This property has the same behavior as sdk_version does for Java modules. For those
familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
does for Java code.
In addition, setting this property causes two variants to be built, one for the platform
and one for apps.
⊕shared
StaticOrSharedProperties
srcs
list of string
tidy_disabled_srcs
list of string
tidy_timeout_srcs
list of string
⊕sanitized
Sanitized
⊕none
⊕address
⊕hwaddress
cflags
list of string
enabled
bool
whole_static_libs
list of string
static_libs
list of string
shared_libs
list of string
system_shared_libs
list of string
apex_available
list of string
installable
bool
shared_libs
list of string, list of modules that should be dynamically linked into this module.
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).
⊕static
StaticOrSharedProperties
srcs
list of string
tidy_disabled_srcs
list of string
tidy_timeout_srcs
list of string
⊕sanitized
Sanitized
⊕none
⊕address
⊕hwaddress
cflags
list of string
enabled
bool
whole_static_libs
list of string
static_libs
list of string
shared_libs
list of string
system_shared_libs
list of string
apex_available
list of string
installable
bool
static_executable
bool, compile executable with -static
static_libs
list of string, list of static library modules that should only provide headers for this module.
static_ndk_lib
bool
stem
string, set the name of the output
stl
string, Select the STL library to use. Possible values are "libc++",
"libc++_static", "libstdc++", or "none". Leave blank to select the
default.
⊕strip
none
bool, none forces all stripping to be disabled.
Device modules default to stripping enabled leaving mini debuginfo.
Host modules default to stripping disabled, but can be enabled by setting any other
strip boolean property.
all
bool, all forces stripping everything, including the mini debug info.
keep_symbols
bool, keep_symbols enables stripping but keeps all symbols.
keep_symbols_list
list of string, keep_symbols_list specifies a list of symbols to keep if keep_symbols is enabled.
If it is unset then all symbols are kept.
keep_symbols_and_debug_frame
bool, keep_symbols_and_debug_frame enables stripping but keeps all symbols and debug frames.
⊕stubs
Generate stubs to make this library accessible to APEXes.
symbol_file
string, Relative path to the symbol map. The symbol map provides the list of
symbols that are exported for stubs variant of this library.
versions
list of string, List versions to generate stubs libs for. The version name "current" is always
implicitly added.
implementation_installable
bool, Whether to not require the implementation of the library to be installed if a
client of the stubs is installed. Defaults to true; set to false if the
implementation is made available by some other means, e.g. in a Microdroid
virtual machine.
suffix
string, append to the name of the output
symlink_preferred_arch
bool, if set, install a symlink to the preferred architecture
symlinks
list of string, install symlinks to the binary. Symlink names will have the suffix and the binary
extension (if any) appended
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).
system_shared_libs
list of string, list of default libraries that will provide headers for this module. If unset, generally
defaults to libc, libm, and libdl. Set to [] to prevent using headers from the defaults.
target
interface
⊕target.android
⊕target.apex
exclude_shared_libs
list of string, list of shared libs that should not be used to build the apex variant of
the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build the apex
variant of the C/C++ module.
⊕target.host
⊕target.platform
cflags
list of string, List of additional cflags that should be used to build the platform
variant of the C/C++ module.
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
required
list of string, List of modules required by the core variant.
exclude_required
list of string, List of modules not required by the core variant.
shared_libs
list of string, list of shared libs that should be use to build the platform variant
of a module that sets sdk_version. This should rarely be necessary,
in most cases the same libraries are available for the SDK and platform
variants.
exclude_shared_libs
list of string, list of shared libs that should not be used to build the platform variant
of the C/C++ module.
⊕target.product
override_export_include_dirs
list of string, list of exported include directories, like
export_include_dirs, that will be applied to
vendor or product variant of this library.
This will overwrite any other declarations.
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
suffix
string, set suffix of the name of the output
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
⊕target.ramdisk
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
ramdisk variant of the C/C++ module.
⊕target.recovery
required
list of string, List of modules required by the recovery variant.
exclude_required
list of string, List of modules not required by the recovery variant.
shared_libs
list of string, list of shared libs that only should be used to build the recovery
variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
recovery variant of the C/C++ module.
srcs
list of string, list of source files that should only be used in the
recovery variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to
build the recovery variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the recovery
variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to
build the recovery variant of the C/C++ module.
⊕target.vendor
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
suffix
string, set suffix of the name of the output
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
override_export_include_dirs
list of string, list of exported include directories, like
export_include_dirs, that will be applied to
vendor or product variant of this library.
This will overwrite any other declarations.
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
⊕target.vendor_ramdisk
exclude_srcs
list of string, list of source files that should not be used to
build the vendor ramdisk variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the vendor ramdisk
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the vendor ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor ramdisk variant of the C/C++ module.
target_required
list of string, names of other modules to install on target if this module is installed
test_config
string, the name of the test configuration (for example "AndroidTest.xml") that should be
installed with the module.
test_config_template
string, the name of the test configuration template (for example "AndroidTestTemplate.xml") that
should be installed with the module.
test_for
list of string, List of APEXes that this module has private access to for testing purpose. The module
can depend on libraries that are not exported by the APEXes and use private symbols
from the exported libraries.
test_mainline_modules
list of string, Add parameterized mainline modules to auto generated test config. The options will be
handled by TradeFed to download and install the specified modules on the device.
⊕test_options
TestOptions
Test options.
run_test_as
string, The UID that you want to run the test as on a device.
test_suite_tag
list of string, A list of free-formed strings without spaces that categorize the test.
min_shipping_api_level
int64, Add ShippingApiLevelModuleController to auto generated test config. If the device properties
for the shipping api level is less than the min_shipping_api_level, skip this module.
vsr_min_shipping_api_level
int64, Add ShippingApiLevelModuleController to auto generated test config. If any of the device
shipping api level and vendor api level properties are less than the
vsr_min_shipping_api_level, skip this module.
As this includes the shipping api level check, it is not allowed to define
min_shipping_api_level at the same time with this property.
min_vndk_version
int64, Add MinApiLevelModuleController with ro.vndk.version property. If ro.vndk.version has an
integer value and the value is less than the min_vndk_version, skip this module.
unit_test
bool, If the test is a hostside (no device required) unittest that shall be run
during presubmit check.
tags
list of string, Tags provide additional metadata to customize test execution by downstream
test runners. The tags have no special meaning to Soong.
test_per_src
bool, Create a separate binary for each source file. Useful when there is
global state that can not be torn down and reset between each test suite.
test_suites
list of string, list of compatibility suites (for example "cts", "vts") that the module should be
installed into.
tidy
bool, whether to run clang-tidy over C-like sources.
tidy_checks
list of string, Extra checks to enable or disable in clang-tidy
tidy_checks_as_errors
list of string, Checks that should be treated as errors.
tidy_disabled_srcs
list of string, list of source files that should not be compiled with clang-tidy.
tidy_flags
list of string, Extra flags to pass to clang-tidy
tidy_timeout_srcs
list of string, list of source files that should not be compiled by clang-tidy when TIDY_TIMEOUT is set.
unexported_symbols_list
string, local file name to pass to the linker as -unexported_symbols_list
unique_host_soname
bool, rename host libraries to prevent overlap with system installed libraries
use_clang_lld
bool, Use clang lld instead of gnu ld.
use_version_lib
bool, make android::build:GetBuildNumber() available containing the build ID.
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_available
bool, whether this module should be allowed to be directly depended by other
modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
If set to true, two variants will be built separately, one like
normal, and the other limited to the set of libraries and headers
that are exposed to /vendor modules.
The vendor variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /vendor modules.
The modules with vndk: {enabled: true} must define 'vendor_available'
to 'true'.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
⊕vendor_public_library
vendorPublicLibraryProperties
If this is a vendor public library, properties to describe the vendor public library stubs.
symbol_file
string, Relative path to the symbol map.
unversioned
bool, Whether the system library uses symbol versions.
override_export_include_dirs
list of string, list of directories relative to the Blueprints file that willbe added to the include path
(using -I) for any module that links against the LLNDK variant of this module, replacing
any that were listed outside the llndk clause.
vendor_ramdisk
bool, Whether this module is installed to vendor ramdisk
vendor_ramdisk_available
bool, Make this module available when building for vendor ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
version_script
string, local file name to pass to the linker as --version-script
vintf_fragments
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/+/master/README.md#visibility for
more details.
⊕vndk
enabled
bool, declared as a VNDK or VNDK-SP module. The vendor variant
will be installed in /system instead of /vendor partition.
`vendor_available` and `product_available` must be explicitly
set to either true or false together with `vndk: {enabled: true}`.
support_system_process
bool, declared as a VNDK-SP module, which is a subset of VNDK.
`vndk: { enabled: true }` must set together.
All these modules are allowed to link to VNDK-SP or LL-NDK
modules only. Other dependency will cause link-type errors.
If `support_system_process` is not set or set to false,
the module is VNDK-core and can link to other VNDK-core,
VNDK-SP or LL-NDK modules only.
private
bool, declared as a VNDK-private module.
This module still creates the vendor and product variants refering
to the `vendor_available: true` and `product_available: true`
properties. However, it is only available to the other VNDK modules
but not to the non-VNDK vendor or product modules.
extends
string, Extending another module
whole_program_vtables
bool, Use -fwhole-program-vtables cflag.
whole_static_libs
list of string, list of modules whose object files should be linked into this module
in their entirety. For static library modules, all of the .o files from the intermediate
directory of the dependency will be linked into this modules .a file. For a shared library,
the dependency's .a file will be linked into this module using -Wl,--whole-archive.
windows_import_lib
string, Optionally provide an import library if this is a Windows PE DLL prebuilt.
This is needed only if this library is linked by other modules in build time.
Only makes sense for the Windows target.
yacc
YaccProperties
art_cc_library
name
,
srcs
,
exclude_srcs
,
defaults
,
host_supported
,
device_supported
,
afdo
,
aidl
,
allow_undefined_symbols
,
apex_available
,
arch
,
asflags
,
bazel_module
,
bootstrap
,
buildstubs
,
c_std
,
cflags
,
clang
,
clang_asflags
,
clang_cflags
,
codegen.arm
,
codegen.arm64
,
codegen.riscv64
,
codegen.x86
,
codegen.x86_64
,
compile_multilib
,
conlyflags
,
cpp_std
,
cppflags
,
debug
,
debug_ramdisk
,
device_specific
,
dist
,
dists
,
double_loadable
,
dynamic_list
,
enabled
,
exclude_from_recovery_snapshot
,
exclude_from_vendor_snapshot
,
exclude_generated_sources
,
exclude_runtime_libs
,
exclude_shared_libs
,
exclude_static_libs
,
export_generated_headers
,
export_header_lib_headers
,
export_include_dirs
,
export_shared_lib_headers
,
export_static_lib_headers
,
export_system_include_dirs
,
force_symbols_not_weak_list
,
force_symbols_weak_list
,
generated_headers
,
generated_sources
,
gnu_extensions
,
group_static_libs
,
header_abi_checker
,
header_libs
,
host_ldlibs
,
host_required
,
include_build_directory
,
include_dirs
,
init_rc
,
inject_bssl_hash
,
install_in_root
,
install_in_xbin
,
installable
,
instruction_set
,
ldflags
,
lex
,
licenses
,
linker_scripts
,
llndk
,
local_include_dirs
,
logtags
,
lto
,
min_sdk_version
,
multilib
,
native_bridge_supported
,
native_coverage
,
no_libcrt
,
nocrt
,
odm_available
,
openmp
,
overrides
,
owner
,
pack_relocations
,
pgo
,
product_available
,
product_specific
,
product_variables.always_use_prebuilt_sdks
,
product_variables.arc
,
product_variables.binder32bit
,
product_variables.debuggable
,
product_variables.enforce_vintf_manifest
,
product_variables.eng
,
product_variables.flatten_apex
,
product_variables.malloc_not_svelte
,
product_variables.malloc_pattern_fill_contents
,
product_variables.malloc_zero_contents
,
product_variables.native_coverage
,
product_variables.override_rs_driver
,
product_variables.pdk
,
product_variables.platform_sdk_version
,
product_variables.safestack
,
product_variables.treble_linker_namespaces
,
product_variables.uml
,
product_variables.unbundled_build
,
proprietary
,
proto
,
ramdisk
,
ramdisk_available
,
recovery
,
recovery_available
,
relative_install_path
,
release
,
renderscript
,
required
,
rtti
,
runtime_libs
,
sanitize
,
sdclang
,
sdk_variant_only
,
sdk_version
,
shared
,
shared_libs
,
soc_specific
,
static
,
static_libs
,
static_ndk_lib
,
stem
,
stl
,
strip
,
stubs
,
suffix
,
system_ext_specific
,
system_shared_libs
,
target
,
target.android
,
target.apex
,
target.host
,
target.platform
,
target.product
,
target.ramdisk
,
target.recovery
,
target.vendor
,
target.vendor_ramdisk
,
target_required
,
test_for
,
tidy
,
tidy_checks
,
tidy_checks_as_errors
,
tidy_disabled_srcs
,
tidy_flags
,
tidy_timeout_srcs
,
unexported_symbols_list
,
unique_host_soname
,
use_clang_lld
,
use_version_lib
,
vendor
,
vendor_available
,
vendor_public_library
,
vendor_ramdisk
,
vendor_ramdisk_available
,
version_script
,
vintf_fragments
,
visibility
,
vndk
,
whole_program_vtables
,
whole_static_libs
,
yacc
name
string, The name of the module. Must be unique across all modules.
srcs
list of string, list of source files used to compile the C/C++ module. May be .c, .cpp, or .S files.
srcs may reference the outputs of other modules that produce source files like genrule
or filegroup using the syntax ":module".
exclude_srcs
list of string, list of source files that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
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.
afdo
bool, Afdo allows developers self-service enroll for
automatic feedback-directed optimization using profile data.
⊕aidl
include_dirs
list of string, list of directories that will be added to the aidl include paths.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the aidl include paths.
generate_traces
bool, whether to generate traces (for systrace) for this interface
flags
list of string, list of flags that will be passed to the AIDL compiler
allow_undefined_symbols
bool, allow the module to contain undefined symbols. By default,
modules cannot contain undefined symbols that are not satisified by their immediate
dependencies. Set this flag to true to remove --no-undefined from the linker flags.
This flag should only be necessary for compiling low-level libraries like libc.
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".
"com.android.gki.*" matches any APEX module name with the prefix "com.android.gki.".
Default is ["//apex_available:platform"].
arch
interface
asflags
list of string, list of module-specific flags that will be used for .S compiles
⊕bazel_module
bazelModuleProperties
In "Bazel mixed build" mode, this represents the Bazel target replacing
this Soong module.
label
string, The label of the Bazel target replacing this Soong module. When run in conversion mode, this
will import the handcrafted build target into the autogenerated file. Note: this may result in
a conflict due to duplicate targets if bp2build_available is also set.
bp2build_available
bool, If true, bp2build will generate the converted Bazel target for this module. Note: this may
cause a conflict due to the duplicate targets if label is also set.
This is a bool pointer to support tristates: true, false, not set.
To opt in a module, set bazel_module: { bp2build_available: true }
To opt out a module, set bazel_module: { bp2build_available: false }
To defer the default setting for the directory, do not set the value.
bootstrap
bool, Allows this module to use non-APEX version of libraries. Useful
for building binaries that are started before APEXes are activated.
⊕buildstubs
bool
c_std
string, C standard version to use. Can be a specific version (such as "gnu11"),
"experimental" (which will use draft versions like C1x when available),
or the empty string (which will use the default).
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles.
clang
bool, Deprecated. true is the default, false is invalid.
clang_asflags
list of string, list of module-specific flags that will be used for .S compiles when
compiling with clang
clang_cflags
list of string, list of module-specific flags that will be used for C and C++ compiles when
compiling with clang
⊕codegen.arm
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.arm64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.riscv64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86_64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
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).
conlyflags
list of string, list of module-specific flags that will be used for C compiles
cpp_std
string, C++ standard version to use. Can be a specific version (such as
"gnu++11"), "experimental" (which will use draft versions like C++1z when
available), or the empty string (which will use the default).
cppflags
list of string, list of module-specific flags that will be used for C++ compiles
⊕debug
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
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.
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)
double_loadable
bool, whether this module is capable of being loaded with other instance
(possibly an older version) of the same module in the same process.
Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
can be double loaded in a vendor process if the library is also a
(direct and indirect) dependency of an LLNDK library. Such libraries must be
explicitly marked as `double_loadable: true` by the owner, or the dependency
from the LLNDK lib should be cut if the lib is not designed to be double loaded.
dynamic_list
string, local file name to pass to the linker as --dynamic-list
enabled
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.
exclude_from_recovery_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the recovery snapshot.
exclude_from_vendor_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the vendor snapshot.
exclude_generated_sources
list of string, list of generated sources that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with this module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build this module
exclude_static_libs
list of string, list of static libs that should not be used to build this module
export_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path (using -I) for this module and any module that links
against this module. Directories listed in export_include_dirs do not need to be
listed in local_include_dirs.
export_system_include_dirs
list of string, list of directories that will be added to the system include path
using -isystem for this module and any module that links against this module.
force_symbols_not_weak_list
string, local file name to pass to the linker as -force_symbols_not_weak_list
force_symbols_weak_list
string, local file name to pass to the linker as -force_symbols_weak_list
generated_sources
list of string, list of generated sources to compile. These are the names of gensrcs or
genrule modules.
gnu_extensions
bool, if set to false, use -std=c++* instead of -std=gnu++*
group_static_libs
bool, deprecated and ignored because lld makes it unnecessary. See b/189475744.
Properties for ABI compatibility checker.
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
host_ldlibs
list of string, -l arguments to pass to linker for host-provided shared libraries
host_required
list of string, names of other modules to install on host if this module is installed
include_build_directory
bool, Add the directory containing the Android.bp file to the list of include
directories. Defaults to true.
include_dirs
list of string, list of directories relative to the root of the source tree that will
be added to the include path using -I.
If possible, don't use this. If adding paths from the current directory use
local_include_dirs, if adding paths from other modules use export_include_dirs in
that module.
init_rc
list of string, init.rc files to be installed if this module is installed
inject_bssl_hash
bool, Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
install_in_root
bool, Install output directly in {partition}/, not in any subdir. This is only intended for use by
init_first_stage.
install_in_xbin
bool, Install output directly in {partition}/xbin
installable
bool
instruction_set
string, the instruction set architecture to use to compile the C/C++
module.
ldflags
list of string, list of module-specific flags that will be used for all link steps
lex
LexProperties
licenses
list of string, Describes the licenses applicable to this module. Must reference license modules.
linker_scripts
list of string, local files to pass to the linker as --script
⊕llndk
llndkLibraryProperties
If this is an LLNDK library, properties to describe the LLNDK stubs. Will be copied from
the module pointed to by llndk_stubs if it is set.
symbol_file
string, Relative path to the symbol map.
An example file can be seen here: TODO(danalbert): Make an example.
unversioned
bool, Whether the system library uses symbol versions.
override_export_include_dirs
list of string, list of directories relative to the Blueprints file that willbe added to the include path
(using -I) for any module that links against the LLNDK variant of this module, replacing
any that were listed outside the llndk clause.
private
bool, whether this module can be directly depended upon by libs that are installed
to /vendor and /product.
When set to true, this module can only be depended on by VNDK libraries, not
vendor nor product libraries. This effectively hides this module from
non-system modules. Default value is false.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path using -I
logtags
list of string, *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
file
⊕lto
Lto must violate capitialization style for acronyms so that it can be
referred to in blueprint files as "lto"
never
bool
full
bool
thin
bool
min_sdk_version
string, Minimum OS API level supported by this C or C++ module. This property becomes the value
of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
this property is also used to ensure that the min_sdk_version of the containing module is
not older (i.e. less) than this module's min_sdk_version. When not set, this property
defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
min_sdk_version of the containing APEX. When the module
is not built for an APEX, "apex_inherit" defaults to sdk_version.
multilib
interface
native_bridge_supported
bool, Whether this module is built for non-native architectures (also known as native bridge binary)
native_coverage
bool
no_libcrt
bool, don't link in libclang_rt.builtins-*.a
nocrt
bool, don't link in crt_begin and crt_end. This flag should only be necessary for
compiling crt or libc.
odm_available
bool, This is the same as the "vendor_available" except that the install path
of the vendor variant is /odm or /vendor/odm.
By replacing "vendor_available: true" with "odm_available: true", the
module will install its vendor variant to the /odm partition or /vendor/odm.
As the modules with "odm_available: true" still create the vendor variants,
they can link to the other vendor modules as the vendor_available modules do.
Also, the vendor modules can link to odm_available modules.
It may not be used for VNDK modules.
openmp
bool, Build and link with OpenMP
overrides
list of string, Names of modules to be overridden. Listed modules can only be other shared libraries
(in Make or Soong).
This does not completely prevent installation of the overridden libraries, but if both
binaries would be installed by default (in PRODUCT_PACKAGES) the other library will be removed
from PRODUCT_PACKAGES.
owner
string, vendor who owns this module
pack_relocations
bool, Generate compact dynamic relocation table, default true.
⊕pgo
instrumentation
bool
profile_file
string
benchmarks
list of string
enable_profile_use
bool
cflags
list of string, Additional compiler flags to use when building this module
for profiling.
product_available
bool, whether this module should be allowed to be directly depended by other
modules with `product_specific: true` or `product_available: true`.
If set to true, an additional product variant will be built separately
that is limited to the set of libraries and headers that are exposed to
/product modules.
The product variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /product modules.
Different from the 'vendor_available' property, the modules with
vndk: {enabled: true} don't have to define 'product_available'. The VNDK
library without 'product_available' may not be depended on by any other
modules that has product variants including the product available VNDKs.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
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.always_use_prebuilt_sdks
⊕product_variables.arc
⊕cflags
⊕exclude_srcs
⊕include_dirs
⊕shared_libs
⊕static_libs
⊕srcs
⊕whole_static_libs
⊕product_variables.binder32bit
⊕product_variables.debuggable
⊕cflags
⊕cppflags
⊕init_rc
⊕required
⊕host_required
⊕target_required
⊕strip.all
⊕strip.keep_symbols
⊕strip.keep_symbols_and_debug_frame
⊕static_libs
⊕whole_static_libs
⊕shared_libs
⊕srcs
⊕exclude_srcs
⊕product_variables.enforce_vintf_manifest
⊕product_variables.eng
⊕cflags
⊕cppflags
⊕lto.never
⊕sanitize.address
⊕product_variables.flatten_apex
⊕product_variables.malloc_not_svelte
⊕cflags
⊕shared_libs
⊕whole_static_libs
⊕exclude_static_libs
⊕srcs
⊕product_variables.malloc_pattern_fill_contents
⊕product_variables.malloc_zero_contents
⊕product_variables.native_coverage
⊕product_variables.override_rs_driver
⊕product_variables.pdk
⊕product_variables.platform_sdk_version
⊕product_variables.safestack
⊕product_variables.treble_linker_namespaces
⊕product_variables.uml
⊕product_variables.unbundled_build
proprietary
bool, whether this is a proprietary vendor module, and should be installed into /vendor
⊕proto
static
bool, Link statically against the protobuf runtime
type
string, Proto generator type. C++: full or lite. Java: micro, nano, stream, or lite.
plugin
string, Proto plugin to use as the generator. Must be a cc_binary_host module.
include_dirs
list of string, list of directories that will be added to the protoc include paths.
local_include_dirs
list of string, list of directories relative to the bp file that will
be added to the protoc include paths.
canonical_path_from_root
bool, whether to identify the proto files from the root of the
source tree (the original method in Android, useful for
android-specific protos), or relative from where they were
specified (useful for external/third party protos).
This defaults to true today, but is expected to default to
false in the future.
ramdisk
bool, Whether this module is installed to ramdisk
ramdisk_available
bool, Make this module available when building for ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
recovery
bool, Whether this module is installed to recovery partition
recovery_available
bool, Make this module available when building for recovery
relative_install_path
string, install to a subdirectory of the default install path for the module
⊕release
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
⊕renderscript
include_dirs
list of string, list of directories that will be added to the llvm-rs-cc include paths
flags
list of string, list of flags that will be passed to llvm-rs-cc
target_api
string, Renderscript API level to target
required
list of string, names of other modules to install if this module is installed
rtti
bool, pass -frtti instead of -fno-rtti
runtime_libs
list of string, list of modules that should be installed with this module. This is similar to 'required'
but '.vendor' suffix will be appended to the module names if the shared libraries have
vendor variants and this module uses VNDK.
⊕sanitize
SanitizeUserProps
never
bool, Prevent use of any sanitizers on this module
address
bool, ASan (Address sanitizer), incompatible with static binaries.
Always runs in a diagnostic mode.
Use of address sanitizer disables cfi sanitizer.
Hwaddress sanitizer takes precedence over this sanitizer.
thread
bool, TSan (Thread sanitizer), incompatible with static binaries and 32 bit architectures.
Always runs in a diagnostic mode.
Use of thread sanitizer disables cfi and scudo sanitizers.
Hwaddress sanitizer takes precedence over this sanitizer.
hwaddress
bool, HWASan (Hardware Address sanitizer).
Use of hwasan sanitizer disables cfi, address, thread, and scudo sanitizers.
all_undefined
bool, Undefined behavior sanitizer
undefined
bool, Subset of undefined behavior sanitizer
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable
fuzzer
bool, Fuzzer, incompatible with static binaries.
safestack
bool, safe-stack sanitizer, incompatible with 32-bit architectures.
cfi
bool, cfi sanitizer, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, incompatible with Darwin.
scudo
bool, scudo sanitizer, incompatible with asan, hwasan, tsan
This should not be used in Android 11+ : https://source.android.com/devices/tech/debug/scudo
deprecated
scs
bool, shadow-call-stack sanitizer, only available on arm64/riscv64.
memtag_heap
bool, Memory-tagging, only available on arm64
if diag.memtag unset or false, enables async memory tagging
memtag_stack
bool, Memory-tagging stack instrumentation, only available on arm64
Adds instrumentation to detect stack buffer overflows and use-after-scope using MTE.
writeonly
bool, A modifier for ASAN and HWASAN for write only instrumentation
⊕diag
Sanitizers to run in the diagnostic mode (as opposed to the release mode).
Replaces abort() on error with a human-readable error message.
Address and Thread sanitizers always run in diagnostic mode.
undefined
bool, Undefined behavior sanitizer, diagnostic mode
cfi
bool, cfi sanitizer, diagnostic mode, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, diagnostic mode, incompatible with Darwin.
memtag_heap
bool, Memory-tagging, only available on arm64
requires sanitizer.memtag: true
if set, enables sync memory tagging
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable in diagnostic mode
no_recover
list of string, List of sanitizers to pass to -fno-sanitize-recover
results in only the first detected error for these sanitizers being reported and program then
exits with a non-zero exit code.
⊕config
Sanitizers to run with flag configuration specified
cfi_assembly_support
bool, Enables CFI support flags for assembly-heavy libraries
recover
list of string, List of sanitizers to pass to -fsanitize-recover
allows execution to continue for these sanitizers to detect multiple errors rather than only
the first one
blocklist
string, value to pass to -fsanitize-ignorelist
sdclang
bool, compile module with SDLLVM instead of AOSP LLVM
sdk_variant_only
bool, If true, always create an sdk variant and don't create a platform variant.
sdk_version
string, The API level that this module is built against. The APIs of this API level will be
visible at build time, but use of any APIs newer than min_sdk_version will render the
module unloadable on older devices. In the future it will be possible to weakly-link new
APIs, making the behavior match Java: such modules will load on older devices, but
calling new APIs on devices that do not support them will result in a crash.
This property has the same behavior as sdk_version does for Java modules. For those
familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
does for Java code.
In addition, setting this property causes two variants to be built, one for the platform
and one for apps.
⊕shared
StaticOrSharedProperties
srcs
list of string
tidy_disabled_srcs
list of string
tidy_timeout_srcs
list of string
⊕sanitized
Sanitized
⊕none
⊕address
⊕hwaddress
cflags
list of string
enabled
bool
whole_static_libs
list of string
static_libs
list of string
shared_libs
list of string
system_shared_libs
list of string
apex_available
list of string
installable
bool
shared_libs
list of string, list of modules that should be dynamically linked into this module.
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).
⊕static
StaticOrSharedProperties
srcs
list of string
tidy_disabled_srcs
list of string
tidy_timeout_srcs
list of string
⊕sanitized
Sanitized
⊕none
⊕address
⊕hwaddress
cflags
list of string
enabled
bool
whole_static_libs
list of string
static_libs
list of string
shared_libs
list of string
system_shared_libs
list of string
apex_available
list of string
installable
bool
static_libs
list of string, list of modules that should be statically linked into this module.
static_ndk_lib
bool
stem
string, set the name of the output
stl
string, Select the STL library to use. Possible values are "libc++",
"libc++_static", "libstdc++", or "none". Leave blank to select the
default.
⊕strip
none
bool, none forces all stripping to be disabled.
Device modules default to stripping enabled leaving mini debuginfo.
Host modules default to stripping disabled, but can be enabled by setting any other
strip boolean property.
all
bool, all forces stripping everything, including the mini debug info.
keep_symbols
bool, keep_symbols enables stripping but keeps all symbols.
keep_symbols_list
list of string, keep_symbols_list specifies a list of symbols to keep if keep_symbols is enabled.
If it is unset then all symbols are kept.
keep_symbols_and_debug_frame
bool, keep_symbols_and_debug_frame enables stripping but keeps all symbols and debug frames.
⊕stubs
Generate stubs to make this library accessible to APEXes.
symbol_file
string, Relative path to the symbol map. The symbol map provides the list of
symbols that are exported for stubs variant of this library.
versions
list of string, List versions to generate stubs libs for. The version name "current" is always
implicitly added.
implementation_installable
bool, Whether to not require the implementation of the library to be installed if a
client of the stubs is installed. Defaults to true; set to false if the
implementation is made available by some other means, e.g. in a Microdroid
virtual machine.
suffix
string, set suffix of the name of the output
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).
system_shared_libs
list of string, list of system libraries that will be dynamically linked to
shared library and executable modules. If unset, generally defaults to libc,
libm, and libdl. Set to [] to prevent linking against the defaults.
target
interface
⊕target.android
⊕target.apex
exclude_shared_libs
list of string, list of shared libs that should not be used to build the apex variant of
the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build the apex
variant of the C/C++ module.
⊕target.host
⊕target.platform
required
list of string, List of modules required by the core variant.
exclude_required
list of string, List of modules not required by the core variant.
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
cflags
list of string, List of additional cflags that should be used to build the platform
variant of the C/C++ module.
shared_libs
list of string, list of shared libs that should be use to build the platform variant
of a module that sets sdk_version. This should rarely be necessary,
in most cases the same libraries are available for the SDK and platform
variants.
exclude_shared_libs
list of string, list of shared libs that should not be used to build the platform variant
of the C/C++ module.
⊕target.product
override_export_include_dirs
list of string, list of exported include directories, like
export_include_dirs, that will be applied to
vendor or product variant of this library.
This will overwrite any other declarations.
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
suffix
string, set suffix of the name of the output
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
⊕target.ramdisk
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
ramdisk variant of the C/C++ module.
⊕target.recovery
required
list of string, List of modules required by the recovery variant.
exclude_required
list of string, List of modules not required by the recovery variant.
shared_libs
list of string, list of shared libs that only should be used to build the recovery
variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
recovery variant of the C/C++ module.
srcs
list of string, list of source files that should only be used in the
recovery variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to
build the recovery variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the recovery
variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to
build the recovery variant of the C/C++ module.
⊕target.vendor
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
suffix
string, set suffix of the name of the output
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
override_export_include_dirs
list of string, list of exported include directories, like
export_include_dirs, that will be applied to
vendor or product variant of this library.
This will overwrite any other declarations.
⊕target.vendor_ramdisk
exclude_srcs
list of string, list of source files that should not be used to
build the vendor ramdisk variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the vendor ramdisk
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the vendor ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor ramdisk variant of the C/C++ module.
target_required
list of string, names of other modules to install on target if this module is installed
test_for
list of string, List of APEXes that this module has private access to for testing purpose. The module
can depend on libraries that are not exported by the APEXes and use private symbols
from the exported libraries.
tidy
bool, whether to run clang-tidy over C-like sources.
tidy_checks
list of string, Extra checks to enable or disable in clang-tidy
tidy_checks_as_errors
list of string, Checks that should be treated as errors.
tidy_disabled_srcs
list of string, list of source files that should not be compiled with clang-tidy.
tidy_flags
list of string, Extra flags to pass to clang-tidy
tidy_timeout_srcs
list of string, list of source files that should not be compiled by clang-tidy when TIDY_TIMEOUT is set.
unexported_symbols_list
string, local file name to pass to the linker as -unexported_symbols_list
unique_host_soname
bool, rename host libraries to prevent overlap with system installed libraries
use_clang_lld
bool, Use clang lld instead of gnu ld.
use_version_lib
bool, make android::build:GetBuildNumber() available containing the build ID.
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_available
bool, whether this module should be allowed to be directly depended by other
modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
If set to true, two variants will be built separately, one like
normal, and the other limited to the set of libraries and headers
that are exposed to /vendor modules.
The vendor variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /vendor modules.
The modules with vndk: {enabled: true} must define 'vendor_available'
to 'true'.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
⊕vendor_public_library
vendorPublicLibraryProperties
If this is a vendor public library, properties to describe the vendor public library stubs.
symbol_file
string, Relative path to the symbol map.
unversioned
bool, Whether the system library uses symbol versions.
override_export_include_dirs
list of string, list of directories relative to the Blueprints file that willbe added to the include path
(using -I) for any module that links against the LLNDK variant of this module, replacing
any that were listed outside the llndk clause.
vendor_ramdisk
bool, Whether this module is installed to vendor ramdisk
vendor_ramdisk_available
bool, Make this module available when building for vendor ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
version_script
string, local file name to pass to the linker as --version-script
vintf_fragments
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/+/master/README.md#visibility for
more details.
⊕vndk
enabled
bool, declared as a VNDK or VNDK-SP module. The vendor variant
will be installed in /system instead of /vendor partition.
`vendor_available` and `product_available` must be explicitly
set to either true or false together with `vndk: {enabled: true}`.
support_system_process
bool, declared as a VNDK-SP module, which is a subset of VNDK.
`vndk: { enabled: true }` must set together.
All these modules are allowed to link to VNDK-SP or LL-NDK
modules only. Other dependency will cause link-type errors.
If `support_system_process` is not set or set to false,
the module is VNDK-core and can link to other VNDK-core,
VNDK-SP or LL-NDK modules only.
private
bool, declared as a VNDK-private module.
This module still creates the vendor and product variants refering
to the `vendor_available: true` and `product_available: true`
properties. However, it is only available to the other VNDK modules
but not to the non-VNDK vendor or product modules.
extends
string, Extending another module
whole_program_vtables
bool, Use -fwhole-program-vtables cflag.
whole_static_libs
list of string, list of modules whose object files should be linked into this module
in their entirety. For static library modules, all of the .o files from the intermediate
directory of the dependency will be linked into this modules .a file. For a shared library,
the dependency's .a file will be linked into this module using -Wl,--whole-archive.
yacc
YaccProperties
art_cc_library_static
name
,
srcs
,
exclude_srcs
,
defaults
,
host_supported
,
device_supported
,
afdo
,
aidl
,
allow_undefined_symbols
,
apex_available
,
arch
,
asflags
,
bazel_module
,
bootstrap
,
buildstubs
,
c_std
,
cflags
,
clang
,
clang_asflags
,
clang_cflags
,
codegen.arm
,
codegen.arm64
,
codegen.riscv64
,
codegen.x86
,
codegen.x86_64
,
compile_multilib
,
conlyflags
,
cpp_std
,
cppflags
,
debug
,
debug_ramdisk
,
device_specific
,
dist
,
dists
,
double_loadable
,
dynamic_list
,
enabled
,
exclude_from_recovery_snapshot
,
exclude_from_vendor_snapshot
,
exclude_generated_sources
,
exclude_runtime_libs
,
exclude_shared_libs
,
exclude_static_libs
,
export_generated_headers
,
export_header_lib_headers
,
export_include_dirs
,
export_shared_lib_headers
,
export_static_lib_headers
,
export_system_include_dirs
,
force_symbols_not_weak_list
,
force_symbols_weak_list
,
generated_headers
,
generated_sources
,
gnu_extensions
,
group_static_libs
,
header_abi_checker
,
header_libs
,
host_ldlibs
,
host_required
,
include_build_directory
,
include_dirs
,
init_rc
,
inject_bssl_hash
,
install_in_root
,
install_in_xbin
,
installable
,
instruction_set
,
ldflags
,
lex
,
licenses
,
linker_scripts
,
llndk
,
local_include_dirs
,
logtags
,
lto
,
min_sdk_version
,
multilib
,
native_bridge_supported
,
native_coverage
,
no_libcrt
,
nocrt
,
odm_available
,
openmp
,
overrides
,
owner
,
pack_relocations
,
pgo
,
product_available
,
product_specific
,
product_variables.always_use_prebuilt_sdks
,
product_variables.arc
,
product_variables.binder32bit
,
product_variables.debuggable
,
product_variables.enforce_vintf_manifest
,
product_variables.eng
,
product_variables.flatten_apex
,
product_variables.malloc_not_svelte
,
product_variables.malloc_pattern_fill_contents
,
product_variables.malloc_zero_contents
,
product_variables.native_coverage
,
product_variables.override_rs_driver
,
product_variables.pdk
,
product_variables.platform_sdk_version
,
product_variables.safestack
,
product_variables.treble_linker_namespaces
,
product_variables.uml
,
product_variables.unbundled_build
,
proprietary
,
proto
,
ramdisk
,
ramdisk_available
,
recovery
,
recovery_available
,
relative_install_path
,
release
,
renderscript
,
required
,
rtti
,
runtime_libs
,
sanitize
,
sdclang
,
sdk_variant_only
,
sdk_version
,
shared_libs
,
soc_specific
,
static
,
static_libs
,
static_ndk_lib
,
stem
,
stl
,
strip
,
stubs
,
suffix
,
system_ext_specific
,
system_shared_libs
,
target
,
target.android
,
target.apex
,
target.host
,
target.platform
,
target.product
,
target.ramdisk
,
target.recovery
,
target.vendor
,
target.vendor_ramdisk
,
target_required
,
test_for
,
tidy
,
tidy_checks
,
tidy_checks_as_errors
,
tidy_disabled_srcs
,
tidy_flags
,
tidy_timeout_srcs
,
unexported_symbols_list
,
unique_host_soname
,
use_clang_lld
,
use_version_lib
,
vendor
,
vendor_available
,
vendor_public_library
,
vendor_ramdisk
,
vendor_ramdisk_available
,
version_script
,
vintf_fragments
,
visibility
,
vndk
,
whole_program_vtables
,
whole_static_libs
,
yacc
name
string, The name of the module. Must be unique across all modules.
srcs
list of string, list of source files used to compile the C/C++ module. May be .c, .cpp, or .S files.
srcs may reference the outputs of other modules that produce source files like genrule
or filegroup using the syntax ":module".
exclude_srcs
list of string, list of source files that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
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.
afdo
bool, Afdo allows developers self-service enroll for
automatic feedback-directed optimization using profile data.
⊕aidl
include_dirs
list of string, list of directories that will be added to the aidl include paths.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the aidl include paths.
generate_traces
bool, whether to generate traces (for systrace) for this interface
flags
list of string, list of flags that will be passed to the AIDL compiler
allow_undefined_symbols
bool, allow the module to contain undefined symbols. By default,
modules cannot contain undefined symbols that are not satisified by their immediate
dependencies. Set this flag to true to remove --no-undefined from the linker flags.
This flag should only be necessary for compiling low-level libraries like libc.
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".
"com.android.gki.*" matches any APEX module name with the prefix "com.android.gki.".
Default is ["//apex_available:platform"].
arch
interface
asflags
list of string, list of module-specific flags that will be used for .S compiles
⊕bazel_module
bazelModuleProperties
In "Bazel mixed build" mode, this represents the Bazel target replacing
this Soong module.
label
string, The label of the Bazel target replacing this Soong module. When run in conversion mode, this
will import the handcrafted build target into the autogenerated file. Note: this may result in
a conflict due to duplicate targets if bp2build_available is also set.
bp2build_available
bool, If true, bp2build will generate the converted Bazel target for this module. Note: this may
cause a conflict due to the duplicate targets if label is also set.
This is a bool pointer to support tristates: true, false, not set.
To opt in a module, set bazel_module: { bp2build_available: true }
To opt out a module, set bazel_module: { bp2build_available: false }
To defer the default setting for the directory, do not set the value.
bootstrap
bool, Allows this module to use non-APEX version of libraries. Useful
for building binaries that are started before APEXes are activated.
⊕buildstubs
bool
c_std
string, C standard version to use. Can be a specific version (such as "gnu11"),
"experimental" (which will use draft versions like C1x when available),
or the empty string (which will use the default).
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles.
clang
bool, Deprecated. true is the default, false is invalid.
clang_asflags
list of string, list of module-specific flags that will be used for .S compiles when
compiling with clang
clang_cflags
list of string, list of module-specific flags that will be used for C and C++ compiles when
compiling with clang
⊕codegen.arm
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.arm64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.riscv64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86_64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
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).
conlyflags
list of string, list of module-specific flags that will be used for C compiles
cpp_std
string, C++ standard version to use. Can be a specific version (such as
"gnu++11"), "experimental" (which will use draft versions like C++1z when
available), or the empty string (which will use the default).
cppflags
list of string, list of module-specific flags that will be used for C++ compiles
⊕debug
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
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.
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)
double_loadable
bool, whether this module is capable of being loaded with other instance
(possibly an older version) of the same module in the same process.
Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
can be double loaded in a vendor process if the library is also a
(direct and indirect) dependency of an LLNDK library. Such libraries must be
explicitly marked as `double_loadable: true` by the owner, or the dependency
from the LLNDK lib should be cut if the lib is not designed to be double loaded.
dynamic_list
string, local file name to pass to the linker as --dynamic-list
enabled
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.
exclude_from_recovery_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the recovery snapshot.
exclude_from_vendor_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the vendor snapshot.
exclude_generated_sources
list of string, list of generated sources that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with this module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build this module
exclude_static_libs
list of string, list of static libs that should not be used to build this module
export_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path (using -I) for this module and any module that links
against this module. Directories listed in export_include_dirs do not need to be
listed in local_include_dirs.
export_system_include_dirs
list of string, list of directories that will be added to the system include path
using -isystem for this module and any module that links against this module.
force_symbols_not_weak_list
string, local file name to pass to the linker as -force_symbols_not_weak_list
force_symbols_weak_list
string, local file name to pass to the linker as -force_symbols_weak_list
generated_sources
list of string, list of generated sources to compile. These are the names of gensrcs or
genrule modules.
gnu_extensions
bool, if set to false, use -std=c++* instead of -std=gnu++*
group_static_libs
bool, deprecated and ignored because lld makes it unnecessary. See b/189475744.
Properties for ABI compatibility checker.
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
host_ldlibs
list of string, -l arguments to pass to linker for host-provided shared libraries
host_required
list of string, names of other modules to install on host if this module is installed
include_build_directory
bool, Add the directory containing the Android.bp file to the list of include
directories. Defaults to true.
include_dirs
list of string, list of directories relative to the root of the source tree that will
be added to the include path using -I.
If possible, don't use this. If adding paths from the current directory use
local_include_dirs, if adding paths from other modules use export_include_dirs in
that module.
init_rc
list of string, init.rc files to be installed if this module is installed
inject_bssl_hash
bool, Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
install_in_root
bool, Install output directly in {partition}/, not in any subdir. This is only intended for use by
init_first_stage.
install_in_xbin
bool, Install output directly in {partition}/xbin
installable
bool
instruction_set
string, the instruction set architecture to use to compile the C/C++
module.
ldflags
list of string, list of module-specific flags that will be used for all link steps
lex
LexProperties
licenses
list of string, Describes the licenses applicable to this module. Must reference license modules.
linker_scripts
list of string, local files to pass to the linker as --script
⊕llndk
llndkLibraryProperties
If this is an LLNDK library, properties to describe the LLNDK stubs. Will be copied from
the module pointed to by llndk_stubs if it is set.
symbol_file
string, Relative path to the symbol map.
An example file can be seen here: TODO(danalbert): Make an example.
unversioned
bool, Whether the system library uses symbol versions.
override_export_include_dirs
list of string, list of directories relative to the Blueprints file that willbe added to the include path
(using -I) for any module that links against the LLNDK variant of this module, replacing
any that were listed outside the llndk clause.
private
bool, whether this module can be directly depended upon by libs that are installed
to /vendor and /product.
When set to true, this module can only be depended on by VNDK libraries, not
vendor nor product libraries. This effectively hides this module from
non-system modules. Default value is false.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path using -I
logtags
list of string, *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
file
⊕lto
Lto must violate capitialization style for acronyms so that it can be
referred to in blueprint files as "lto"
never
bool
full
bool
thin
bool
min_sdk_version
string, Minimum OS API level supported by this C or C++ module. This property becomes the value
of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
this property is also used to ensure that the min_sdk_version of the containing module is
not older (i.e. less) than this module's min_sdk_version. When not set, this property
defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
min_sdk_version of the containing APEX. When the module
is not built for an APEX, "apex_inherit" defaults to sdk_version.
multilib
interface
native_bridge_supported
bool, Whether this module is built for non-native architectures (also known as native bridge binary)
native_coverage
bool
no_libcrt
bool, don't link in libclang_rt.builtins-*.a
nocrt
bool, don't link in crt_begin and crt_end. This flag should only be necessary for
compiling crt or libc.
odm_available
bool, This is the same as the "vendor_available" except that the install path
of the vendor variant is /odm or /vendor/odm.
By replacing "vendor_available: true" with "odm_available: true", the
module will install its vendor variant to the /odm partition or /vendor/odm.
As the modules with "odm_available: true" still create the vendor variants,
they can link to the other vendor modules as the vendor_available modules do.
Also, the vendor modules can link to odm_available modules.
It may not be used for VNDK modules.
openmp
bool, Build and link with OpenMP
overrides
list of string, Names of modules to be overridden. Listed modules can only be other shared libraries
(in Make or Soong).
This does not completely prevent installation of the overridden libraries, but if both
binaries would be installed by default (in PRODUCT_PACKAGES) the other library will be removed
from PRODUCT_PACKAGES.
owner
string, vendor who owns this module
pack_relocations
bool, Generate compact dynamic relocation table, default true.
⊕pgo
instrumentation
bool
profile_file
string
benchmarks
list of string
enable_profile_use
bool
cflags
list of string, Additional compiler flags to use when building this module
for profiling.
product_available
bool, whether this module should be allowed to be directly depended by other
modules with `product_specific: true` or `product_available: true`.
If set to true, an additional product variant will be built separately
that is limited to the set of libraries and headers that are exposed to
/product modules.
The product variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /product modules.
Different from the 'vendor_available' property, the modules with
vndk: {enabled: true} don't have to define 'product_available'. The VNDK
library without 'product_available' may not be depended on by any other
modules that has product variants including the product available VNDKs.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
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.always_use_prebuilt_sdks
⊕product_variables.arc
⊕cflags
⊕exclude_srcs
⊕include_dirs
⊕shared_libs
⊕static_libs
⊕srcs
⊕whole_static_libs
⊕product_variables.binder32bit
⊕product_variables.debuggable
⊕cflags
⊕cppflags
⊕init_rc
⊕required
⊕host_required
⊕target_required
⊕strip.all
⊕strip.keep_symbols
⊕strip.keep_symbols_and_debug_frame
⊕static_libs
⊕whole_static_libs
⊕shared_libs
⊕srcs
⊕exclude_srcs
⊕product_variables.enforce_vintf_manifest
⊕product_variables.eng
⊕cflags
⊕cppflags
⊕lto.never
⊕sanitize.address
⊕product_variables.flatten_apex
⊕product_variables.malloc_not_svelte
⊕cflags
⊕shared_libs
⊕whole_static_libs
⊕exclude_static_libs
⊕srcs
⊕product_variables.malloc_pattern_fill_contents
⊕product_variables.malloc_zero_contents
⊕product_variables.native_coverage
⊕product_variables.override_rs_driver
⊕product_variables.pdk
⊕product_variables.platform_sdk_version
⊕product_variables.safestack
⊕product_variables.treble_linker_namespaces
⊕product_variables.uml
⊕product_variables.unbundled_build
proprietary
bool, whether this is a proprietary vendor module, and should be installed into /vendor
⊕proto
static
bool, Link statically against the protobuf runtime
type
string, Proto generator type. C++: full or lite. Java: micro, nano, stream, or lite.
plugin
string, Proto plugin to use as the generator. Must be a cc_binary_host module.
include_dirs
list of string, list of directories that will be added to the protoc include paths.
local_include_dirs
list of string, list of directories relative to the bp file that will
be added to the protoc include paths.
canonical_path_from_root
bool, whether to identify the proto files from the root of the
source tree (the original method in Android, useful for
android-specific protos), or relative from where they were
specified (useful for external/third party protos).
This defaults to true today, but is expected to default to
false in the future.
ramdisk
bool, Whether this module is installed to ramdisk
ramdisk_available
bool, Make this module available when building for ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
recovery
bool, Whether this module is installed to recovery partition
recovery_available
bool, Make this module available when building for recovery
relative_install_path
string, install to a subdirectory of the default install path for the module
⊕release
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
⊕renderscript
include_dirs
list of string, list of directories that will be added to the llvm-rs-cc include paths
flags
list of string, list of flags that will be passed to llvm-rs-cc
target_api
string, Renderscript API level to target
required
list of string, names of other modules to install if this module is installed
rtti
bool, pass -frtti instead of -fno-rtti
runtime_libs
list of string, list of modules that should be installed with this module. This is similar to 'required'
but '.vendor' suffix will be appended to the module names if the shared libraries have
vendor variants and this module uses VNDK.
⊕sanitize
SanitizeUserProps
never
bool, Prevent use of any sanitizers on this module
address
bool, ASan (Address sanitizer), incompatible with static binaries.
Always runs in a diagnostic mode.
Use of address sanitizer disables cfi sanitizer.
Hwaddress sanitizer takes precedence over this sanitizer.
thread
bool, TSan (Thread sanitizer), incompatible with static binaries and 32 bit architectures.
Always runs in a diagnostic mode.
Use of thread sanitizer disables cfi and scudo sanitizers.
Hwaddress sanitizer takes precedence over this sanitizer.
hwaddress
bool, HWASan (Hardware Address sanitizer).
Use of hwasan sanitizer disables cfi, address, thread, and scudo sanitizers.
all_undefined
bool, Undefined behavior sanitizer
undefined
bool, Subset of undefined behavior sanitizer
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable
fuzzer
bool, Fuzzer, incompatible with static binaries.
safestack
bool, safe-stack sanitizer, incompatible with 32-bit architectures.
cfi
bool, cfi sanitizer, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, incompatible with Darwin.
scudo
bool, scudo sanitizer, incompatible with asan, hwasan, tsan
This should not be used in Android 11+ : https://source.android.com/devices/tech/debug/scudo
deprecated
scs
bool, shadow-call-stack sanitizer, only available on arm64/riscv64.
memtag_heap
bool, Memory-tagging, only available on arm64
if diag.memtag unset or false, enables async memory tagging
memtag_stack
bool, Memory-tagging stack instrumentation, only available on arm64
Adds instrumentation to detect stack buffer overflows and use-after-scope using MTE.
writeonly
bool, A modifier for ASAN and HWASAN for write only instrumentation
⊕diag
Sanitizers to run in the diagnostic mode (as opposed to the release mode).
Replaces abort() on error with a human-readable error message.
Address and Thread sanitizers always run in diagnostic mode.
undefined
bool, Undefined behavior sanitizer, diagnostic mode
cfi
bool, cfi sanitizer, diagnostic mode, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, diagnostic mode, incompatible with Darwin.
memtag_heap
bool, Memory-tagging, only available on arm64
requires sanitizer.memtag: true
if set, enables sync memory tagging
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable in diagnostic mode
no_recover
list of string, List of sanitizers to pass to -fno-sanitize-recover
results in only the first detected error for these sanitizers being reported and program then
exits with a non-zero exit code.
⊕config
Sanitizers to run with flag configuration specified
cfi_assembly_support
bool, Enables CFI support flags for assembly-heavy libraries
recover
list of string, List of sanitizers to pass to -fsanitize-recover
allows execution to continue for these sanitizers to detect multiple errors rather than only
the first one
blocklist
string, value to pass to -fsanitize-ignorelist
sdclang
bool, compile module with SDLLVM instead of AOSP LLVM
sdk_variant_only
bool, If true, always create an sdk variant and don't create a platform variant.
sdk_version
string, The API level that this module is built against. The APIs of this API level will be
visible at build time, but use of any APIs newer than min_sdk_version will render the
module unloadable on older devices. In the future it will be possible to weakly-link new
APIs, making the behavior match Java: such modules will load on older devices, but
calling new APIs on devices that do not support them will result in a crash.
This property has the same behavior as sdk_version does for Java modules. For those
familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
does for Java code.
In addition, setting this property causes two variants to be built, one for the platform
and one for apps.
shared_libs
list of string, list of modules that should be dynamically linked into this module.
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).
⊕static
StaticOrSharedProperties
srcs
list of string
tidy_disabled_srcs
list of string
tidy_timeout_srcs
list of string
⊕sanitized
Sanitized
⊕none
⊕address
⊕hwaddress
cflags
list of string
enabled
bool
whole_static_libs
list of string
static_libs
list of string
shared_libs
list of string
system_shared_libs
list of string
apex_available
list of string
installable
bool
static_libs
list of string, list of modules that should be statically linked into this module.
static_ndk_lib
bool
stem
string, set the name of the output
stl
string, Select the STL library to use. Possible values are "libc++",
"libc++_static", "libstdc++", or "none". Leave blank to select the
default.
⊕strip
none
bool, none forces all stripping to be disabled.
Device modules default to stripping enabled leaving mini debuginfo.
Host modules default to stripping disabled, but can be enabled by setting any other
strip boolean property.
all
bool, all forces stripping everything, including the mini debug info.
keep_symbols
bool, keep_symbols enables stripping but keeps all symbols.
keep_symbols_list
list of string, keep_symbols_list specifies a list of symbols to keep if keep_symbols is enabled.
If it is unset then all symbols are kept.
keep_symbols_and_debug_frame
bool, keep_symbols_and_debug_frame enables stripping but keeps all symbols and debug frames.
⊕stubs
Generate stubs to make this library accessible to APEXes.
symbol_file
string, Relative path to the symbol map. The symbol map provides the list of
symbols that are exported for stubs variant of this library.
versions
list of string, List versions to generate stubs libs for. The version name "current" is always
implicitly added.
implementation_installable
bool, Whether to not require the implementation of the library to be installed if a
client of the stubs is installed. Defaults to true; set to false if the
implementation is made available by some other means, e.g. in a Microdroid
virtual machine.
suffix
string, set suffix of the name of the output
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).
system_shared_libs
list of string, list of system libraries that will be dynamically linked to
shared library and executable modules. If unset, generally defaults to libc,
libm, and libdl. Set to [] to prevent linking against the defaults.
target
interface
⊕target.android
⊕target.apex
exclude_shared_libs
list of string, list of shared libs that should not be used to build the apex variant of
the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build the apex
variant of the C/C++ module.
⊕target.host
⊕target.platform
required
list of string, List of modules required by the core variant.
exclude_required
list of string, List of modules not required by the core variant.
shared_libs
list of string, list of shared libs that should be use to build the platform variant
of a module that sets sdk_version. This should rarely be necessary,
in most cases the same libraries are available for the SDK and platform
variants.
exclude_shared_libs
list of string, list of shared libs that should not be used to build the platform variant
of the C/C++ module.
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
cflags
list of string, List of additional cflags that should be used to build the platform
variant of the C/C++ module.
⊕target.product
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
override_export_include_dirs
list of string, list of exported include directories, like
export_include_dirs, that will be applied to
vendor or product variant of this library.
This will overwrite any other declarations.
suffix
string, set suffix of the name of the output
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
⊕target.ramdisk
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
ramdisk variant of the C/C++ module.
⊕target.recovery
shared_libs
list of string, list of shared libs that only should be used to build the recovery
variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
recovery variant of the C/C++ module.
srcs
list of string, list of source files that should only be used in the
recovery variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to
build the recovery variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the recovery
variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to
build the recovery variant of the C/C++ module.
required
list of string, List of modules required by the recovery variant.
exclude_required
list of string, List of modules not required by the recovery variant.
⊕target.vendor
override_export_include_dirs
list of string, list of exported include directories, like
export_include_dirs, that will be applied to
vendor or product variant of this library.
This will overwrite any other declarations.
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
suffix
string, set suffix of the name of the output
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
⊕target.vendor_ramdisk
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the vendor ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor ramdisk variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to
build the vendor ramdisk variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the vendor ramdisk
variant of the C/C++ module.
target_required
list of string, names of other modules to install on target if this module is installed
test_for
list of string, List of APEXes that this module has private access to for testing purpose. The module
can depend on libraries that are not exported by the APEXes and use private symbols
from the exported libraries.
tidy
bool, whether to run clang-tidy over C-like sources.
tidy_checks
list of string, Extra checks to enable or disable in clang-tidy
tidy_checks_as_errors
list of string, Checks that should be treated as errors.
tidy_disabled_srcs
list of string, list of source files that should not be compiled with clang-tidy.
tidy_flags
list of string, Extra flags to pass to clang-tidy
tidy_timeout_srcs
list of string, list of source files that should not be compiled by clang-tidy when TIDY_TIMEOUT is set.
unexported_symbols_list
string, local file name to pass to the linker as -unexported_symbols_list
unique_host_soname
bool, rename host libraries to prevent overlap with system installed libraries
use_clang_lld
bool, Use clang lld instead of gnu ld.
use_version_lib
bool, make android::build:GetBuildNumber() available containing the build ID.
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_available
bool, whether this module should be allowed to be directly depended by other
modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
If set to true, two variants will be built separately, one like
normal, and the other limited to the set of libraries and headers
that are exposed to /vendor modules.
The vendor variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /vendor modules.
The modules with vndk: {enabled: true} must define 'vendor_available'
to 'true'.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
⊕vendor_public_library
vendorPublicLibraryProperties
If this is a vendor public library, properties to describe the vendor public library stubs.
symbol_file
string, Relative path to the symbol map.
unversioned
bool, Whether the system library uses symbol versions.
override_export_include_dirs
list of string, list of directories relative to the Blueprints file that willbe added to the include path
(using -I) for any module that links against the LLNDK variant of this module, replacing
any that were listed outside the llndk clause.
vendor_ramdisk
bool, Whether this module is installed to vendor ramdisk
vendor_ramdisk_available
bool, Make this module available when building for vendor ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
version_script
string, local file name to pass to the linker as --version-script
vintf_fragments
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/+/master/README.md#visibility for
more details.
⊕vndk
enabled
bool, declared as a VNDK or VNDK-SP module. The vendor variant
will be installed in /system instead of /vendor partition.
`vendor_available` and `product_available` must be explicitly
set to either true or false together with `vndk: {enabled: true}`.
support_system_process
bool, declared as a VNDK-SP module, which is a subset of VNDK.
`vndk: { enabled: true }` must set together.
All these modules are allowed to link to VNDK-SP or LL-NDK
modules only. Other dependency will cause link-type errors.
If `support_system_process` is not set or set to false,
the module is VNDK-core and can link to other VNDK-core,
VNDK-SP or LL-NDK modules only.
private
bool, declared as a VNDK-private module.
This module still creates the vendor and product variants refering
to the `vendor_available: true` and `product_available: true`
properties. However, it is only available to the other VNDK modules
but not to the non-VNDK vendor or product modules.
extends
string, Extending another module
whole_program_vtables
bool, Use -fwhole-program-vtables cflag.
whole_static_libs
list of string, list of modules whose object files should be linked into this module
in their entirety. For static library modules, all of the .o files from the intermediate
directory of the dependency will be linked into this modules .a file. For a shared library,
the dependency's .a file will be linked into this module using -Wl,--whole-archive.
yacc
YaccProperties
art_cc_test
name
,
srcs
,
exclude_srcs
,
defaults
,
host_supported
,
device_supported
,
afdo
,
aidl
,
allow_undefined_symbols
,
apex_available
,
arch
,
asflags
,
auto_gen_config
,
bootstrap
,
buildstubs
,
c_std
,
cflags
,
clang
,
clang_asflags
,
clang_cflags
,
codegen.arm
,
codegen.arm64
,
codegen.riscv64
,
codegen.x86
,
codegen.x86_64
,
compile_multilib
,
conlyflags
,
cpp_std
,
cppflags
,
data
,
data_bins
,
data_libs
,
debug
,
debug_ramdisk
,
device_specific
,
disable_framework
,
dist
,
dists
,
double_loadable
,
dynamic_list
,
enabled
,
exclude_from_recovery_snapshot
,
exclude_from_vendor_snapshot
,
exclude_generated_sources
,
exclude_runtime_libs
,
exclude_shared_libs
,
exclude_static_libs
,
export_generated_headers
,
export_header_lib_headers
,
export_shared_lib_headers
,
export_static_lib_headers
,
generated_headers
,
generated_sources
,
gnu_extensions
,
group_static_libs
,
gtest
,
header_libs
,
host_ldlibs
,
host_required
,
include_build_directory
,
include_dirs
,
init_rc
,
inject_bssl_hash
,
install_in_root
,
install_in_xbin
,
installable
,
instruction_set
,
isolated
,
ldflags
,
lex
,
licenses
,
linker_scripts
,
local_include_dirs
,
logtags
,
lto
,
min_sdk_version
,
multilib
,
native_bridge_supported
,
native_coverage
,
no_libcrt
,
no_named_install_directory
,
nocrt
,
odm_available
,
openmp
,
overrides
,
owner
,
pack_relocations
,
per_testcase_directory
,
pgo
,
prefix_symbols
,
product_available
,
product_specific
,
product_variables.always_use_prebuilt_sdks
,
product_variables.arc
,
product_variables.binder32bit
,
product_variables.debuggable
,
product_variables.enforce_vintf_manifest
,
product_variables.eng
,
product_variables.flatten_apex
,
product_variables.malloc_not_svelte
,
product_variables.malloc_pattern_fill_contents
,
product_variables.malloc_zero_contents
,
product_variables.native_coverage
,
product_variables.override_rs_driver
,
product_variables.pdk
,
product_variables.platform_sdk_version
,
product_variables.safestack
,
product_variables.treble_linker_namespaces
,
product_variables.uml
,
product_variables.unbundled_build
,
proprietary
,
proto
,
ramdisk
,
ramdisk_available
,
recovery
,
recovery_available
,
relative_install_path
,
release
,
renderscript
,
require_root
,
required
,
rtti
,
runtime_libs
,
sanitize
,
sdclang
,
sdk_variant_only
,
sdk_version
,
shared_libs
,
soc_specific
,
static_executable
,
static_libs
,
stem
,
stl
,
strip
,
suffix
,
symlink_preferred_arch
,
symlinks
,
system_ext_specific
,
system_shared_libs
,
target
,
target.android
,
target.apex
,
target.host
,
target.platform
,
target.product
,
target.ramdisk
,
target.recovery
,
target.vendor
,
target.vendor_ramdisk
,
target_required
,
test_config
,
test_config_template
,
test_for
,
test_mainline_modules
,
test_options
,
test_per_src
,
test_suites
,
tidy
,
tidy_checks
,
tidy_checks_as_errors
,
tidy_disabled_srcs
,
tidy_flags
,
tidy_timeout_srcs
,
use_clang_lld
,
use_version_lib
,
vendor
,
vendor_available
,
vendor_ramdisk
,
vendor_ramdisk_available
,
version_script
,
vintf_fragments
,
visibility
,
vndk
,
whole_program_vtables
,
whole_static_libs
,
yacc
name
string, The name of the module. Must be unique across all modules.
srcs
list of string, list of source files used to compile the C/C++ module. May be .c, .cpp, or .S files.
srcs may reference the outputs of other modules that produce source files like genrule
or filegroup using the syntax ":module".
exclude_srcs
list of string, list of source files that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
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.
afdo
bool, Afdo allows developers self-service enroll for
automatic feedback-directed optimization using profile data.
⊕aidl
include_dirs
list of string, list of directories that will be added to the aidl include paths.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the aidl include paths.
generate_traces
bool, whether to generate traces (for systrace) for this interface
flags
list of string, list of flags that will be passed to the AIDL compiler
allow_undefined_symbols
bool, allow the module to contain undefined symbols. By default,
modules cannot contain undefined symbols that are not satisified by their immediate
dependencies. Set this flag to true to remove --no-undefined from the linker flags.
This flag should only be necessary for compiling low-level libraries like libc.
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".
"com.android.gki.*" matches any APEX module name with the prefix "com.android.gki.".
Default is ["//apex_available:platform"].
arch
interface
asflags
list of string, list of module-specific flags that will be used for .S compiles
auto_gen_config
bool, Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
explicitly.
bootstrap
bool, Allows this module to use non-APEX version of libraries. Useful
for building binaries that are started before APEXes are activated.
⊕buildstubs
bool
c_std
string, C standard version to use. Can be a specific version (such as "gnu11"),
"experimental" (which will use draft versions like C1x when available),
or the empty string (which will use the default).
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles.
clang
bool, Deprecated. true is the default, false is invalid.
clang_asflags
list of string, list of module-specific flags that will be used for .S compiles when
compiling with clang
clang_cflags
list of string, list of module-specific flags that will be used for C and C++ compiles when
compiling with clang
⊕codegen.arm
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.arm64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.riscv64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86_64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
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).
conlyflags
list of string, list of module-specific flags that will be used for C compiles
cpp_std
string, C++ standard version to use. Can be a specific version (such as
"gnu++11"), "experimental" (which will use draft versions like C++1z when
available), or the empty string (which will use the default).
cppflags
list of string, list of module-specific flags that will be used for C++ compiles
data
list of string, list of files or filegroup modules that provide data that should be installed alongside
the test
data_bins
list of string, list of binary modules that should be installed alongside the test
data_libs
list of string, list of shared library modules that should be installed alongside the test
⊕debug
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
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`.
disable_framework
bool, Add RunCommandTargetPreparer to stop framework before the test and start it after the test.
⊕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.
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)
double_loadable
bool, whether this module is capable of being loaded with other instance
(possibly an older version) of the same module in the same process.
Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
can be double loaded in a vendor process if the library is also a
(direct and indirect) dependency of an LLNDK library. Such libraries must be
explicitly marked as `double_loadable: true` by the owner, or the dependency
from the LLNDK lib should be cut if the lib is not designed to be double loaded.
dynamic_list
string, local file name to pass to the linker as --dynamic-list
enabled
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.
exclude_from_recovery_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the recovery snapshot.
exclude_from_vendor_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the vendor snapshot.
exclude_generated_sources
list of string, list of generated sources that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with this module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build this module
exclude_static_libs
list of string, list of static libs that should not be used to build this module
generated_sources
list of string, list of generated sources to compile. These are the names of gensrcs or
genrule modules.
gnu_extensions
bool, if set to false, use -std=c++* instead of -std=gnu++*
group_static_libs
bool, deprecated and ignored because lld makes it unnecessary. See b/189475744.
gtest
bool, if set, build against the gtest library. Defaults to true.
host_ldlibs
list of string, -l arguments to pass to linker for host-provided shared libraries
host_required
list of string, names of other modules to install on host if this module is installed
include_build_directory
bool, Add the directory containing the Android.bp file to the list of include
directories. Defaults to true.
include_dirs
list of string, list of directories relative to the root of the source tree that will
be added to the include path using -I.
If possible, don't use this. If adding paths from the current directory use
local_include_dirs, if adding paths from other modules use export_include_dirs in
that module.
init_rc
list of string, init.rc files to be installed if this module is installed
inject_bssl_hash
bool, Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
install_in_root
bool, Install output directly in {partition}/, not in any subdir. This is only intended for use by
init_first_stage.
install_in_xbin
bool, Install output directly in {partition}/xbin
installable
bool
instruction_set
string, the instruction set architecture to use to compile the C/C++
module.
isolated
bool, if set, use the isolated gtest runner. Defaults to true if gtest is also true and the arch is Windows, false
otherwise.
ldflags
list of string, list of module-specific flags that will be used for all link steps
lex
LexProperties
licenses
list of string, Describes the licenses applicable to this module. Must reference license modules.
linker_scripts
list of string, local files to pass to the linker as --script
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path using -I
logtags
list of string, *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
file
⊕lto
Lto must violate capitialization style for acronyms so that it can be
referred to in blueprint files as "lto"
never
bool
full
bool
thin
bool
min_sdk_version
string, Minimum OS API level supported by this C or C++ module. This property becomes the value
of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
this property is also used to ensure that the min_sdk_version of the containing module is
not older (i.e. less) than this module's min_sdk_version. When not set, this property
defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
min_sdk_version of the containing APEX. When the module
is not built for an APEX, "apex_inherit" defaults to sdk_version.
multilib
interface
native_bridge_supported
bool, Whether this module is built for non-native architectures (also known as native bridge binary)
native_coverage
bool
no_libcrt
bool, don't link in libclang_rt.builtins-*.a
no_named_install_directory
bool, Disables the creation of a test-specific directory when used with
relative_install_path. Useful if several tests need to be in the same
directory, but test_per_src doesn't work.
nocrt
bool, don't link in crt_begin and crt_end. This flag should only be necessary for
compiling crt or libc.
odm_available
bool, This is the same as the "vendor_available" except that the install path
of the vendor variant is /odm or /vendor/odm.
By replacing "vendor_available: true" with "odm_available: true", the
module will install its vendor variant to the /odm partition or /vendor/odm.
As the modules with "odm_available: true" still create the vendor variants,
they can link to the other vendor modules as the vendor_available modules do.
Also, the vendor modules can link to odm_available modules.
It may not be used for VNDK modules.
openmp
bool, Build and link with OpenMP
overrides
list of string, Names of modules to be overridden. Listed modules can only be other binaries
(in Make or Soong).
This does not completely prevent installation of the overridden binaries, but if both
binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
from PRODUCT_PACKAGES.
owner
string, vendor who owns this module
pack_relocations
bool, Generate compact dynamic relocation table, default true.
per_testcase_directory
bool, Install the test into a folder named for the module in all test suites.
⊕pgo
instrumentation
bool
profile_file
string
benchmarks
list of string
enable_profile_use
bool
cflags
list of string, Additional compiler flags to use when building this module
for profiling.
prefix_symbols
string, if set, add an extra objcopy --prefix-symbols= step
product_available
bool, whether this module should be allowed to be directly depended by other
modules with `product_specific: true` or `product_available: true`.
If set to true, an additional product variant will be built separately
that is limited to the set of libraries and headers that are exposed to
/product modules.
The product variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /product modules.
Different from the 'vendor_available' property, the modules with
vndk: {enabled: true} don't have to define 'product_available'. The VNDK
library without 'product_available' may not be depended on by any other
modules that has product variants including the product available VNDKs.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
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.always_use_prebuilt_sdks
⊕product_variables.arc
⊕cflags
⊕exclude_srcs
⊕include_dirs
⊕shared_libs
⊕static_libs
⊕srcs
⊕whole_static_libs
⊕product_variables.binder32bit
⊕product_variables.debuggable
⊕cflags
⊕cppflags
⊕init_rc
⊕required
⊕host_required
⊕target_required
⊕strip.all
⊕strip.keep_symbols
⊕strip.keep_symbols_and_debug_frame
⊕static_libs
⊕whole_static_libs
⊕shared_libs
⊕srcs
⊕exclude_srcs
⊕product_variables.enforce_vintf_manifest
⊕product_variables.eng
⊕cflags
⊕cppflags
⊕lto.never
⊕sanitize.address
⊕product_variables.flatten_apex
⊕product_variables.malloc_not_svelte
⊕cflags
⊕shared_libs
⊕whole_static_libs
⊕exclude_static_libs
⊕srcs
⊕product_variables.malloc_pattern_fill_contents
⊕product_variables.malloc_zero_contents
⊕product_variables.native_coverage
⊕product_variables.override_rs_driver
⊕product_variables.pdk
⊕product_variables.platform_sdk_version
⊕product_variables.safestack
⊕product_variables.treble_linker_namespaces
⊕product_variables.uml
⊕product_variables.unbundled_build
proprietary
bool, whether this is a proprietary vendor module, and should be installed into /vendor
⊕proto
type
string, Proto generator type. C++: full or lite. Java: micro, nano, stream, or lite.
plugin
string, Proto plugin to use as the generator. Must be a cc_binary_host module.
include_dirs
list of string, list of directories that will be added to the protoc include paths.
local_include_dirs
list of string, list of directories relative to the bp file that will
be added to the protoc include paths.
canonical_path_from_root
bool, whether to identify the proto files from the root of the
source tree (the original method in Android, useful for
android-specific protos), or relative from where they were
specified (useful for external/third party protos).
This defaults to true today, but is expected to default to
false in the future.
static
bool, Link statically against the protobuf runtime
ramdisk
bool, Whether this module is installed to ramdisk
ramdisk_available
bool, Make this module available when building for ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
recovery
bool, Whether this module is installed to recovery partition
recovery_available
bool, Make this module available when building for recovery
relative_install_path
string, install to a subdirectory of the default install path for the module
⊕release
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
⊕renderscript
include_dirs
list of string, list of directories that will be added to the llvm-rs-cc include paths
flags
list of string, list of flags that will be passed to llvm-rs-cc
target_api
string, Renderscript API level to target
require_root
bool, Add RootTargetPreparer to auto generated test config. This guarantees the test to run
with root permission.
required
list of string, names of other modules to install if this module is installed
rtti
bool, pass -frtti instead of -fno-rtti
runtime_libs
list of string, list of modules that should be installed with this module. This is similar to 'required'
but '.vendor' suffix will be appended to the module names if the shared libraries have
vendor variants and this module uses VNDK.
⊕sanitize
SanitizeUserProps
never
bool, Prevent use of any sanitizers on this module
address
bool, ASan (Address sanitizer), incompatible with static binaries.
Always runs in a diagnostic mode.
Use of address sanitizer disables cfi sanitizer.
Hwaddress sanitizer takes precedence over this sanitizer.
thread
bool, TSan (Thread sanitizer), incompatible with static binaries and 32 bit architectures.
Always runs in a diagnostic mode.
Use of thread sanitizer disables cfi and scudo sanitizers.
Hwaddress sanitizer takes precedence over this sanitizer.
hwaddress
bool, HWASan (Hardware Address sanitizer).
Use of hwasan sanitizer disables cfi, address, thread, and scudo sanitizers.
all_undefined
bool, Undefined behavior sanitizer
undefined
bool, Subset of undefined behavior sanitizer
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable
fuzzer
bool, Fuzzer, incompatible with static binaries.
safestack
bool, safe-stack sanitizer, incompatible with 32-bit architectures.
cfi
bool, cfi sanitizer, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, incompatible with Darwin.
scudo
bool, scudo sanitizer, incompatible with asan, hwasan, tsan
This should not be used in Android 11+ : https://source.android.com/devices/tech/debug/scudo
deprecated
scs
bool, shadow-call-stack sanitizer, only available on arm64/riscv64.
memtag_heap
bool, Memory-tagging, only available on arm64
if diag.memtag unset or false, enables async memory tagging
memtag_stack
bool, Memory-tagging stack instrumentation, only available on arm64
Adds instrumentation to detect stack buffer overflows and use-after-scope using MTE.
writeonly
bool, A modifier for ASAN and HWASAN for write only instrumentation
⊕diag
Sanitizers to run in the diagnostic mode (as opposed to the release mode).
Replaces abort() on error with a human-readable error message.
Address and Thread sanitizers always run in diagnostic mode.
undefined
bool, Undefined behavior sanitizer, diagnostic mode
cfi
bool, cfi sanitizer, diagnostic mode, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, diagnostic mode, incompatible with Darwin.
memtag_heap
bool, Memory-tagging, only available on arm64
requires sanitizer.memtag: true
if set, enables sync memory tagging
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable in diagnostic mode
no_recover
list of string, List of sanitizers to pass to -fno-sanitize-recover
results in only the first detected error for these sanitizers being reported and program then
exits with a non-zero exit code.
⊕config
Sanitizers to run with flag configuration specified
cfi_assembly_support
bool, Enables CFI support flags for assembly-heavy libraries
recover
list of string, List of sanitizers to pass to -fsanitize-recover
allows execution to continue for these sanitizers to detect multiple errors rather than only
the first one
blocklist
string, value to pass to -fsanitize-ignorelist
sdclang
bool, compile module with SDLLVM instead of AOSP LLVM
sdk_variant_only
bool, If true, always create an sdk variant and don't create a platform variant.
sdk_version
string, The API level that this module is built against. The APIs of this API level will be
visible at build time, but use of any APIs newer than min_sdk_version will render the
module unloadable on older devices. In the future it will be possible to weakly-link new
APIs, making the behavior match Java: such modules will load on older devices, but
calling new APIs on devices that do not support them will result in a crash.
This property has the same behavior as sdk_version does for Java modules. For those
familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
does for Java code.
In addition, setting this property causes two variants to be built, one for the platform
and one for apps.
shared_libs
list of string, list of modules that should be dynamically linked into this module.
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).
static_executable
bool, compile executable with -static
static_libs
list of string, list of modules that should be statically linked into this module.
stem
string, set the name of the output
stl
string, Select the STL library to use. Possible values are "libc++",
"libc++_static", "libstdc++", or "none". Leave blank to select the
default.
⊕strip
none
bool, none forces all stripping to be disabled.
Device modules default to stripping enabled leaving mini debuginfo.
Host modules default to stripping disabled, but can be enabled by setting any other
strip boolean property.
all
bool, all forces stripping everything, including the mini debug info.
keep_symbols
bool, keep_symbols enables stripping but keeps all symbols.
keep_symbols_list
list of string, keep_symbols_list specifies a list of symbols to keep if keep_symbols is enabled.
If it is unset then all symbols are kept.
keep_symbols_and_debug_frame
bool, keep_symbols_and_debug_frame enables stripping but keeps all symbols and debug frames.
suffix
string, append to the name of the output
symlink_preferred_arch
bool, if set, install a symlink to the preferred architecture
symlinks
list of string, install symlinks to the binary. Symlink names will have the suffix and the binary
extension (if any) appended
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).
system_shared_libs
list of string, list of system libraries that will be dynamically linked to
shared library and executable modules. If unset, generally defaults to libc,
libm, and libdl. Set to [] to prevent linking against the defaults.
target
interface
⊕target.android
⊕target.apex
exclude_shared_libs
list of string, list of shared libs that should not be used to build the apex variant of
the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build the apex
variant of the C/C++ module.
⊕target.host
⊕target.platform
cflags
list of string, List of additional cflags that should be used to build the platform
variant of the C/C++ module.
shared_libs
list of string, list of shared libs that should be use to build the platform variant
of a module that sets sdk_version. This should rarely be necessary,
in most cases the same libraries are available for the SDK and platform
variants.
exclude_shared_libs
list of string, list of shared libs that should not be used to build the platform variant
of the C/C++ module.
required
list of string, List of modules required by the core variant.
exclude_required
list of string, List of modules not required by the core variant.
⊕target.product
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
⊕target.ramdisk
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
ramdisk variant of the C/C++ module.
⊕target.recovery
srcs
list of string, list of source files that should only be used in the
recovery variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to
build the recovery variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the recovery
variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to
build the recovery variant of the C/C++ module.
shared_libs
list of string, list of shared libs that only should be used to build the recovery
variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
recovery variant of the C/C++ module.
required
list of string, List of modules required by the recovery variant.
exclude_required
list of string, List of modules not required by the recovery variant.
⊕target.vendor
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
⊕target.vendor_ramdisk
exclude_srcs
list of string, list of source files that should not be used to
build the vendor ramdisk variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the vendor ramdisk
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the vendor ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor ramdisk variant of the C/C++ module.
target_required
list of string, names of other modules to install on target if this module is installed
test_config
string, the name of the test configuration (for example "AndroidTest.xml") that should be
installed with the module.
test_config_template
string, the name of the test configuration template (for example "AndroidTestTemplate.xml") that
should be installed with the module.
test_for
list of string, List of APEXes that this module has private access to for testing purpose. The module
can depend on libraries that are not exported by the APEXes and use private symbols
from the exported libraries.
test_mainline_modules
list of string, Add parameterized mainline modules to auto generated test config. The options will be
handled by TradeFed to download and install the specified modules on the device.
⊕test_options
TestOptions
Test options.
run_test_as
string, The UID that you want to run the test as on a device.
test_suite_tag
list of string, A list of free-formed strings without spaces that categorize the test.
min_shipping_api_level
int64, Add ShippingApiLevelModuleController to auto generated test config. If the device properties
for the shipping api level is less than the min_shipping_api_level, skip this module.
vsr_min_shipping_api_level
int64, Add ShippingApiLevelModuleController to auto generated test config. If any of the device
shipping api level and vendor api level properties are less than the
vsr_min_shipping_api_level, skip this module.
As this includes the shipping api level check, it is not allowed to define
min_shipping_api_level at the same time with this property.
min_vndk_version
int64, Add MinApiLevelModuleController with ro.vndk.version property. If ro.vndk.version has an
integer value and the value is less than the min_vndk_version, skip this module.
unit_test
bool, If the test is a hostside (no device required) unittest that shall be run
during presubmit check.
tags
list of string, Tags provide additional metadata to customize test execution by downstream
test runners. The tags have no special meaning to Soong.
test_per_src
bool, Create a separate binary for each source file. Useful when there is
global state that can not be torn down and reset between each test suite.
test_suites
list of string, list of compatibility suites (for example "cts", "vts") that the module should be installed into.
tidy
bool, whether to run clang-tidy over C-like sources.
tidy_checks
list of string, Extra checks to enable or disable in clang-tidy
tidy_checks_as_errors
list of string, Checks that should be treated as errors.
tidy_disabled_srcs
list of string, list of source files that should not be compiled with clang-tidy.
tidy_flags
list of string, Extra flags to pass to clang-tidy
tidy_timeout_srcs
list of string, list of source files that should not be compiled by clang-tidy when TIDY_TIMEOUT is set.
use_clang_lld
bool, Use clang lld instead of gnu ld.
use_version_lib
bool, make android::build:GetBuildNumber() available containing the build ID.
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_available
bool, whether this module should be allowed to be directly depended by other
modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
If set to true, two variants will be built separately, one like
normal, and the other limited to the set of libraries and headers
that are exposed to /vendor modules.
The vendor variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /vendor modules.
The modules with vndk: {enabled: true} must define 'vendor_available'
to 'true'.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
vendor_ramdisk
bool, Whether this module is installed to vendor ramdisk
vendor_ramdisk_available
bool, Make this module available when building for vendor ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
version_script
string, local file name to pass to the linker as --version-script
vintf_fragments
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/+/master/README.md#visibility for
more details.
⊕vndk
enabled
bool, declared as a VNDK or VNDK-SP module. The vendor variant
will be installed in /system instead of /vendor partition.
`vendor_available` and `product_available` must be explicitly
set to either true or false together with `vndk: {enabled: true}`.
support_system_process
bool, declared as a VNDK-SP module, which is a subset of VNDK.
`vndk: { enabled: true }` must set together.
All these modules are allowed to link to VNDK-SP or LL-NDK
modules only. Other dependency will cause link-type errors.
If `support_system_process` is not set or set to false,
the module is VNDK-core and can link to other VNDK-core,
VNDK-SP or LL-NDK modules only.
private
bool, declared as a VNDK-private module.
This module still creates the vendor and product variants refering
to the `vendor_available: true` and `product_available: true`
properties. However, it is only available to the other VNDK modules
but not to the non-VNDK vendor or product modules.
extends
string, Extending another module
whole_program_vtables
bool, Use -fwhole-program-vtables cflag.
whole_static_libs
list of string, list of modules whose object files should be linked into this module
in their entirety. For static library modules, all of the .o files from the intermediate
directory of the dependency will be linked into this modules .a file. For a shared library,
the dependency's .a file will be linked into this module using -Wl,--whole-archive.
yacc
YaccProperties
art_cc_test_library
name
,
srcs
,
exclude_srcs
,
defaults
,
host_supported
,
device_supported
,
afdo
,
aidl
,
allow_undefined_symbols
,
apex_available
,
arch
,
asflags
,
bazel_module
,
bootstrap
,
buildstubs
,
c_std
,
cflags
,
clang
,
clang_asflags
,
clang_cflags
,
codegen.arm
,
codegen.arm64
,
codegen.riscv64
,
codegen.x86
,
codegen.x86_64
,
compile_multilib
,
conlyflags
,
cpp_std
,
cppflags
,
debug
,
debug_ramdisk
,
device_specific
,
dist
,
dists
,
double_loadable
,
dynamic_list
,
enabled
,
exclude_from_recovery_snapshot
,
exclude_from_vendor_snapshot
,
exclude_generated_sources
,
exclude_runtime_libs
,
exclude_shared_libs
,
exclude_static_libs
,
export_generated_headers
,
export_header_lib_headers
,
export_include_dirs
,
export_shared_lib_headers
,
export_static_lib_headers
,
export_system_include_dirs
,
force_symbols_not_weak_list
,
force_symbols_weak_list
,
generated_headers
,
generated_sources
,
gnu_extensions
,
group_static_libs
,
gtest
,
header_abi_checker
,
header_libs
,
host_ldlibs
,
host_required
,
include_build_directory
,
include_dirs
,
init_rc
,
inject_bssl_hash
,
install_in_root
,
install_in_xbin
,
installable
,
instruction_set
,
isolated
,
ldflags
,
lex
,
licenses
,
linker_scripts
,
llndk
,
local_include_dirs
,
logtags
,
lto
,
min_sdk_version
,
multilib
,
native_bridge_supported
,
native_coverage
,
no_libcrt
,
nocrt
,
odm_available
,
openmp
,
overrides
,
owner
,
pack_relocations
,
pgo
,
product_available
,
product_specific
,
product_variables.always_use_prebuilt_sdks
,
product_variables.arc
,
product_variables.binder32bit
,
product_variables.debuggable
,
product_variables.enforce_vintf_manifest
,
product_variables.eng
,
product_variables.flatten_apex
,
product_variables.malloc_not_svelte
,
product_variables.malloc_pattern_fill_contents
,
product_variables.malloc_zero_contents
,
product_variables.native_coverage
,
product_variables.override_rs_driver
,
product_variables.pdk
,
product_variables.platform_sdk_version
,
product_variables.safestack
,
product_variables.treble_linker_namespaces
,
product_variables.uml
,
product_variables.unbundled_build
,
proprietary
,
proto
,
ramdisk
,
ramdisk_available
,
recovery
,
recovery_available
,
relative_install_path
,
release
,
renderscript
,
required
,
rtti
,
runtime_libs
,
sanitize
,
sdclang
,
sdk_variant_only
,
sdk_version
,
shared
,
shared_libs
,
soc_specific
,
static
,
static_libs
,
static_ndk_lib
,
stem
,
stl
,
strip
,
stubs
,
suffix
,
system_ext_specific
,
system_shared_libs
,
target
,
target.android
,
target.apex
,
target.host
,
target.platform
,
target.product
,
target.ramdisk
,
target.recovery
,
target.vendor
,
target.vendor_ramdisk
,
target_required
,
test_for
,
test_suites
,
tidy
,
tidy_checks
,
tidy_checks_as_errors
,
tidy_disabled_srcs
,
tidy_flags
,
tidy_timeout_srcs
,
unexported_symbols_list
,
unique_host_soname
,
use_clang_lld
,
use_version_lib
,
vendor
,
vendor_available
,
vendor_public_library
,
vendor_ramdisk
,
vendor_ramdisk_available
,
version_script
,
vintf_fragments
,
visibility
,
vndk
,
whole_program_vtables
,
whole_static_libs
,
yacc
name
string, The name of the module. Must be unique across all modules.
srcs
list of string, list of source files used to compile the C/C++ module. May be .c, .cpp, or .S files.
srcs may reference the outputs of other modules that produce source files like genrule
or filegroup using the syntax ":module".
exclude_srcs
list of string, list of source files that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
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.
afdo
bool, Afdo allows developers self-service enroll for
automatic feedback-directed optimization using profile data.
⊕aidl
include_dirs
list of string, list of directories that will be added to the aidl include paths.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the aidl include paths.
generate_traces
bool, whether to generate traces (for systrace) for this interface
flags
list of string, list of flags that will be passed to the AIDL compiler
allow_undefined_symbols
bool, allow the module to contain undefined symbols. By default,
modules cannot contain undefined symbols that are not satisified by their immediate
dependencies. Set this flag to true to remove --no-undefined from the linker flags.
This flag should only be necessary for compiling low-level libraries like libc.
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".
"com.android.gki.*" matches any APEX module name with the prefix "com.android.gki.".
Default is ["//apex_available:platform"].
arch
interface
asflags
list of string, list of module-specific flags that will be used for .S compiles
⊕bazel_module
bazelModuleProperties
In "Bazel mixed build" mode, this represents the Bazel target replacing
this Soong module.
label
string, The label of the Bazel target replacing this Soong module. When run in conversion mode, this
will import the handcrafted build target into the autogenerated file. Note: this may result in
a conflict due to duplicate targets if bp2build_available is also set.
bp2build_available
bool, If true, bp2build will generate the converted Bazel target for this module. Note: this may
cause a conflict due to the duplicate targets if label is also set.
This is a bool pointer to support tristates: true, false, not set.
To opt in a module, set bazel_module: { bp2build_available: true }
To opt out a module, set bazel_module: { bp2build_available: false }
To defer the default setting for the directory, do not set the value.
bootstrap
bool, Allows this module to use non-APEX version of libraries. Useful
for building binaries that are started before APEXes are activated.
⊕buildstubs
bool
c_std
string, C standard version to use. Can be a specific version (such as "gnu11"),
"experimental" (which will use draft versions like C1x when available),
or the empty string (which will use the default).
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles.
clang
bool, Deprecated. true is the default, false is invalid.
clang_asflags
list of string, list of module-specific flags that will be used for .S compiles when
compiling with clang
clang_cflags
list of string, list of module-specific flags that will be used for C and C++ compiles when
compiling with clang
⊕codegen.arm
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.arm64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.riscv64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86_64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
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).
conlyflags
list of string, list of module-specific flags that will be used for C compiles
cpp_std
string, C++ standard version to use. Can be a specific version (such as
"gnu++11"), "experimental" (which will use draft versions like C++1z when
available), or the empty string (which will use the default).
cppflags
list of string, list of module-specific flags that will be used for C++ compiles
⊕debug
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
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.
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)
double_loadable
bool, whether this module is capable of being loaded with other instance
(possibly an older version) of the same module in the same process.
Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
can be double loaded in a vendor process if the library is also a
(direct and indirect) dependency of an LLNDK library. Such libraries must be
explicitly marked as `double_loadable: true` by the owner, or the dependency
from the LLNDK lib should be cut if the lib is not designed to be double loaded.
dynamic_list
string, local file name to pass to the linker as --dynamic-list
enabled
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.
exclude_from_recovery_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the recovery snapshot.
exclude_from_vendor_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the vendor snapshot.
exclude_generated_sources
list of string, list of generated sources that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with this module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build this module
exclude_static_libs
list of string, list of static libs that should not be used to build this module
export_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path (using -I) for this module and any module that links
against this module. Directories listed in export_include_dirs do not need to be
listed in local_include_dirs.
export_system_include_dirs
list of string, list of directories that will be added to the system include path
using -isystem for this module and any module that links against this module.
force_symbols_not_weak_list
string, local file name to pass to the linker as -force_symbols_not_weak_list
force_symbols_weak_list
string, local file name to pass to the linker as -force_symbols_weak_list
generated_sources
list of string, list of generated sources to compile. These are the names of gensrcs or
genrule modules.
gnu_extensions
bool, if set to false, use -std=c++* instead of -std=gnu++*
group_static_libs
bool, deprecated and ignored because lld makes it unnecessary. See b/189475744.
gtest
bool, if set, build against the gtest library. Defaults to true.
Properties for ABI compatibility checker.
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
host_ldlibs
list of string, -l arguments to pass to linker for host-provided shared libraries
host_required
list of string, names of other modules to install on host if this module is installed
include_build_directory
bool, Add the directory containing the Android.bp file to the list of include
directories. Defaults to true.
include_dirs
list of string, list of directories relative to the root of the source tree that will
be added to the include path using -I.
If possible, don't use this. If adding paths from the current directory use
local_include_dirs, if adding paths from other modules use export_include_dirs in
that module.
init_rc
list of string, init.rc files to be installed if this module is installed
inject_bssl_hash
bool, Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
install_in_root
bool, Install output directly in {partition}/, not in any subdir. This is only intended for use by
init_first_stage.
install_in_xbin
bool, Install output directly in {partition}/xbin
installable
bool
instruction_set
string, the instruction set architecture to use to compile the C/C++
module.
isolated
bool, if set, use the isolated gtest runner. Defaults to true if gtest is also true and the arch is Windows, false
otherwise.
ldflags
list of string, list of module-specific flags that will be used for all link steps
lex
LexProperties
licenses
list of string, Describes the licenses applicable to this module. Must reference license modules.
linker_scripts
list of string, local files to pass to the linker as --script
⊕llndk
llndkLibraryProperties
If this is an LLNDK library, properties to describe the LLNDK stubs. Will be copied from
the module pointed to by llndk_stubs if it is set.
symbol_file
string, Relative path to the symbol map.
An example file can be seen here: TODO(danalbert): Make an example.
unversioned
bool, Whether the system library uses symbol versions.
override_export_include_dirs
list of string, list of directories relative to the Blueprints file that willbe added to the include path
(using -I) for any module that links against the LLNDK variant of this module, replacing
any that were listed outside the llndk clause.
private
bool, whether this module can be directly depended upon by libs that are installed
to /vendor and /product.
When set to true, this module can only be depended on by VNDK libraries, not
vendor nor product libraries. This effectively hides this module from
non-system modules. Default value is false.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path using -I
logtags
list of string, *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
file
⊕lto
Lto must violate capitialization style for acronyms so that it can be
referred to in blueprint files as "lto"
never
bool
full
bool
thin
bool
min_sdk_version
string, Minimum OS API level supported by this C or C++ module. This property becomes the value
of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
this property is also used to ensure that the min_sdk_version of the containing module is
not older (i.e. less) than this module's min_sdk_version. When not set, this property
defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
min_sdk_version of the containing APEX. When the module
is not built for an APEX, "apex_inherit" defaults to sdk_version.
multilib
interface
native_bridge_supported
bool, Whether this module is built for non-native architectures (also known as native bridge binary)
native_coverage
bool
no_libcrt
bool, don't link in libclang_rt.builtins-*.a
nocrt
bool, don't link in crt_begin and crt_end. This flag should only be necessary for
compiling crt or libc.
odm_available
bool, This is the same as the "vendor_available" except that the install path
of the vendor variant is /odm or /vendor/odm.
By replacing "vendor_available: true" with "odm_available: true", the
module will install its vendor variant to the /odm partition or /vendor/odm.
As the modules with "odm_available: true" still create the vendor variants,
they can link to the other vendor modules as the vendor_available modules do.
Also, the vendor modules can link to odm_available modules.
It may not be used for VNDK modules.
openmp
bool, Build and link with OpenMP
overrides
list of string, Names of modules to be overridden. Listed modules can only be other shared libraries
(in Make or Soong).
This does not completely prevent installation of the overridden libraries, but if both
binaries would be installed by default (in PRODUCT_PACKAGES) the other library will be removed
from PRODUCT_PACKAGES.
owner
string, vendor who owns this module
pack_relocations
bool, Generate compact dynamic relocation table, default true.
⊕pgo
instrumentation
bool
profile_file
string
benchmarks
list of string
enable_profile_use
bool
cflags
list of string, Additional compiler flags to use when building this module
for profiling.
product_available
bool, whether this module should be allowed to be directly depended by other
modules with `product_specific: true` or `product_available: true`.
If set to true, an additional product variant will be built separately
that is limited to the set of libraries and headers that are exposed to
/product modules.
The product variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /product modules.
Different from the 'vendor_available' property, the modules with
vndk: {enabled: true} don't have to define 'product_available'. The VNDK
library without 'product_available' may not be depended on by any other
modules that has product variants including the product available VNDKs.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
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.always_use_prebuilt_sdks
⊕product_variables.arc
⊕cflags
⊕exclude_srcs
⊕include_dirs
⊕shared_libs
⊕static_libs
⊕srcs
⊕whole_static_libs
⊕product_variables.binder32bit
⊕product_variables.debuggable
⊕cflags
⊕cppflags
⊕init_rc
⊕required
⊕host_required
⊕target_required
⊕strip.all
⊕strip.keep_symbols
⊕strip.keep_symbols_and_debug_frame
⊕static_libs
⊕whole_static_libs
⊕shared_libs
⊕srcs
⊕exclude_srcs
⊕product_variables.enforce_vintf_manifest
⊕product_variables.eng
⊕cflags
⊕cppflags
⊕lto.never
⊕sanitize.address
⊕product_variables.flatten_apex
⊕product_variables.malloc_not_svelte
⊕cflags
⊕shared_libs
⊕whole_static_libs
⊕exclude_static_libs
⊕srcs
⊕product_variables.malloc_pattern_fill_contents
⊕product_variables.malloc_zero_contents
⊕product_variables.native_coverage
⊕product_variables.override_rs_driver
⊕product_variables.pdk
⊕product_variables.platform_sdk_version
⊕product_variables.safestack
⊕product_variables.treble_linker_namespaces
⊕product_variables.uml
⊕product_variables.unbundled_build
proprietary
bool, whether this is a proprietary vendor module, and should be installed into /vendor
⊕proto
type
string, Proto generator type. C++: full or lite. Java: micro, nano, stream, or lite.
plugin
string, Proto plugin to use as the generator. Must be a cc_binary_host module.
include_dirs
list of string, list of directories that will be added to the protoc include paths.
local_include_dirs
list of string, list of directories relative to the bp file that will
be added to the protoc include paths.
canonical_path_from_root
bool, whether to identify the proto files from the root of the
source tree (the original method in Android, useful for
android-specific protos), or relative from where they were
specified (useful for external/third party protos).
This defaults to true today, but is expected to default to
false in the future.
static
bool, Link statically against the protobuf runtime
ramdisk
bool, Whether this module is installed to ramdisk
ramdisk_available
bool, Make this module available when building for ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
recovery
bool, Whether this module is installed to recovery partition
recovery_available
bool, Make this module available when building for recovery
relative_install_path
string, install to a subdirectory of the default install path for the module
⊕release
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
⊕renderscript
include_dirs
list of string, list of directories that will be added to the llvm-rs-cc include paths
flags
list of string, list of flags that will be passed to llvm-rs-cc
target_api
string, Renderscript API level to target
required
list of string, names of other modules to install if this module is installed
rtti
bool, pass -frtti instead of -fno-rtti
runtime_libs
list of string, list of modules that should be installed with this module. This is similar to 'required'
but '.vendor' suffix will be appended to the module names if the shared libraries have
vendor variants and this module uses VNDK.
⊕sanitize
SanitizeUserProps
never
bool, Prevent use of any sanitizers on this module
address
bool, ASan (Address sanitizer), incompatible with static binaries.
Always runs in a diagnostic mode.
Use of address sanitizer disables cfi sanitizer.
Hwaddress sanitizer takes precedence over this sanitizer.
thread
bool, TSan (Thread sanitizer), incompatible with static binaries and 32 bit architectures.
Always runs in a diagnostic mode.
Use of thread sanitizer disables cfi and scudo sanitizers.
Hwaddress sanitizer takes precedence over this sanitizer.
hwaddress
bool, HWASan (Hardware Address sanitizer).
Use of hwasan sanitizer disables cfi, address, thread, and scudo sanitizers.
all_undefined
bool, Undefined behavior sanitizer
undefined
bool, Subset of undefined behavior sanitizer
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable
fuzzer
bool, Fuzzer, incompatible with static binaries.
safestack
bool, safe-stack sanitizer, incompatible with 32-bit architectures.
cfi
bool, cfi sanitizer, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, incompatible with Darwin.
scudo
bool, scudo sanitizer, incompatible with asan, hwasan, tsan
This should not be used in Android 11+ : https://source.android.com/devices/tech/debug/scudo
deprecated
scs
bool, shadow-call-stack sanitizer, only available on arm64/riscv64.
memtag_heap
bool, Memory-tagging, only available on arm64
if diag.memtag unset or false, enables async memory tagging
memtag_stack
bool, Memory-tagging stack instrumentation, only available on arm64
Adds instrumentation to detect stack buffer overflows and use-after-scope using MTE.
writeonly
bool, A modifier for ASAN and HWASAN for write only instrumentation
⊕diag
Sanitizers to run in the diagnostic mode (as opposed to the release mode).
Replaces abort() on error with a human-readable error message.
Address and Thread sanitizers always run in diagnostic mode.
undefined
bool, Undefined behavior sanitizer, diagnostic mode
cfi
bool, cfi sanitizer, diagnostic mode, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, diagnostic mode, incompatible with Darwin.
memtag_heap
bool, Memory-tagging, only available on arm64
requires sanitizer.memtag: true
if set, enables sync memory tagging
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable in diagnostic mode
no_recover
list of string, List of sanitizers to pass to -fno-sanitize-recover
results in only the first detected error for these sanitizers being reported and program then
exits with a non-zero exit code.
⊕config
Sanitizers to run with flag configuration specified
cfi_assembly_support
bool, Enables CFI support flags for assembly-heavy libraries
recover
list of string, List of sanitizers to pass to -fsanitize-recover
allows execution to continue for these sanitizers to detect multiple errors rather than only
the first one
blocklist
string, value to pass to -fsanitize-ignorelist
sdclang
bool, compile module with SDLLVM instead of AOSP LLVM
sdk_variant_only
bool, If true, always create an sdk variant and don't create a platform variant.
sdk_version
string, The API level that this module is built against. The APIs of this API level will be
visible at build time, but use of any APIs newer than min_sdk_version will render the
module unloadable on older devices. In the future it will be possible to weakly-link new
APIs, making the behavior match Java: such modules will load on older devices, but
calling new APIs on devices that do not support them will result in a crash.
This property has the same behavior as sdk_version does for Java modules. For those
familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
does for Java code.
In addition, setting this property causes two variants to be built, one for the platform
and one for apps.
⊕shared
StaticOrSharedProperties
srcs
list of string
tidy_disabled_srcs
list of string
tidy_timeout_srcs
list of string
⊕sanitized
Sanitized
⊕none
⊕address
⊕hwaddress
cflags
list of string
enabled
bool
whole_static_libs
list of string
static_libs
list of string
shared_libs
list of string
system_shared_libs
list of string
apex_available
list of string
installable
bool
shared_libs
list of string, list of modules that should be dynamically linked into this module.
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).
⊕static
StaticOrSharedProperties
srcs
list of string
tidy_disabled_srcs
list of string
tidy_timeout_srcs
list of string
⊕sanitized
Sanitized
⊕none
⊕address
⊕hwaddress
cflags
list of string
enabled
bool
whole_static_libs
list of string
static_libs
list of string
shared_libs
list of string
system_shared_libs
list of string
apex_available
list of string
installable
bool
static_libs
list of string, list of modules that should be statically linked into this module.
static_ndk_lib
bool
stem
string, set the name of the output
stl
string, Select the STL library to use. Possible values are "libc++",
"libc++_static", "libstdc++", or "none". Leave blank to select the
default.
⊕strip
none
bool, none forces all stripping to be disabled.
Device modules default to stripping enabled leaving mini debuginfo.
Host modules default to stripping disabled, but can be enabled by setting any other
strip boolean property.
all
bool, all forces stripping everything, including the mini debug info.
keep_symbols
bool, keep_symbols enables stripping but keeps all symbols.
keep_symbols_list
list of string, keep_symbols_list specifies a list of symbols to keep if keep_symbols is enabled.
If it is unset then all symbols are kept.
keep_symbols_and_debug_frame
bool, keep_symbols_and_debug_frame enables stripping but keeps all symbols and debug frames.
⊕stubs
Generate stubs to make this library accessible to APEXes.
symbol_file
string, Relative path to the symbol map. The symbol map provides the list of
symbols that are exported for stubs variant of this library.
versions
list of string, List versions to generate stubs libs for. The version name "current" is always
implicitly added.
implementation_installable
bool, Whether to not require the implementation of the library to be installed if a
client of the stubs is installed. Defaults to true; set to false if the
implementation is made available by some other means, e.g. in a Microdroid
virtual machine.
suffix
string, set suffix of the name of the output
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).
system_shared_libs
list of string, list of system libraries that will be dynamically linked to
shared library and executable modules. If unset, generally defaults to libc,
libm, and libdl. Set to [] to prevent linking against the defaults.
target
interface
⊕target.android
⊕target.apex
exclude_shared_libs
list of string, list of shared libs that should not be used to build the apex variant of
the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build the apex
variant of the C/C++ module.
⊕target.host
⊕target.platform
shared_libs
list of string, list of shared libs that should be use to build the platform variant
of a module that sets sdk_version. This should rarely be necessary,
in most cases the same libraries are available for the SDK and platform
variants.
exclude_shared_libs
list of string, list of shared libs that should not be used to build the platform variant
of the C/C++ module.
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
required
list of string, List of modules required by the core variant.
exclude_required
list of string, List of modules not required by the core variant.
cflags
list of string, List of additional cflags that should be used to build the platform
variant of the C/C++ module.
⊕target.product
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
override_export_include_dirs
list of string, list of exported include directories, like
export_include_dirs, that will be applied to
vendor or product variant of this library.
This will overwrite any other declarations.
suffix
string, set suffix of the name of the output
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
⊕target.ramdisk
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
ramdisk variant of the C/C++ module.
⊕target.recovery
required
list of string, List of modules required by the recovery variant.
exclude_required
list of string, List of modules not required by the recovery variant.
srcs
list of string, list of source files that should only be used in the
recovery variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to
build the recovery variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the recovery
variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to
build the recovery variant of the C/C++ module.
shared_libs
list of string, list of shared libs that only should be used to build the recovery
variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
recovery variant of the C/C++ module.
⊕target.vendor
suffix
string, set suffix of the name of the output
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
override_export_include_dirs
list of string, list of exported include directories, like
export_include_dirs, that will be applied to
vendor or product variant of this library.
This will overwrite any other declarations.
⊕target.vendor_ramdisk
exclude_srcs
list of string, list of source files that should not be used to
build the vendor ramdisk variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the vendor ramdisk
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the vendor ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor ramdisk variant of the C/C++ module.
target_required
list of string, names of other modules to install on target if this module is installed
test_for
list of string, List of APEXes that this module has private access to for testing purpose. The module
can depend on libraries that are not exported by the APEXes and use private symbols
from the exported libraries.
test_suites
list of string, list of compatibility suites (for example "cts", "vts") that the module should be installed into.
tidy
bool, whether to run clang-tidy over C-like sources.
tidy_checks
list of string, Extra checks to enable or disable in clang-tidy
tidy_checks_as_errors
list of string, Checks that should be treated as errors.
tidy_disabled_srcs
list of string, list of source files that should not be compiled with clang-tidy.
tidy_flags
list of string, Extra flags to pass to clang-tidy
tidy_timeout_srcs
list of string, list of source files that should not be compiled by clang-tidy when TIDY_TIMEOUT is set.
unexported_symbols_list
string, local file name to pass to the linker as -unexported_symbols_list
unique_host_soname
bool, rename host libraries to prevent overlap with system installed libraries
use_clang_lld
bool, Use clang lld instead of gnu ld.
use_version_lib
bool, make android::build:GetBuildNumber() available containing the build ID.
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_available
bool, whether this module should be allowed to be directly depended by other
modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
If set to true, two variants will be built separately, one like
normal, and the other limited to the set of libraries and headers
that are exposed to /vendor modules.
The vendor variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /vendor modules.
The modules with vndk: {enabled: true} must define 'vendor_available'
to 'true'.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
⊕vendor_public_library
vendorPublicLibraryProperties
If this is a vendor public library, properties to describe the vendor public library stubs.
symbol_file
string, Relative path to the symbol map.
unversioned
bool, Whether the system library uses symbol versions.
override_export_include_dirs
list of string, list of directories relative to the Blueprints file that willbe added to the include path
(using -I) for any module that links against the LLNDK variant of this module, replacing
any that were listed outside the llndk clause.
vendor_ramdisk
bool, Whether this module is installed to vendor ramdisk
vendor_ramdisk_available
bool, Make this module available when building for vendor ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
version_script
string, local file name to pass to the linker as --version-script
vintf_fragments
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/+/master/README.md#visibility for
more details.
⊕vndk
enabled
bool, declared as a VNDK or VNDK-SP module. The vendor variant
will be installed in /system instead of /vendor partition.
`vendor_available` and `product_available` must be explicitly
set to either true or false together with `vndk: {enabled: true}`.
support_system_process
bool, declared as a VNDK-SP module, which is a subset of VNDK.
`vndk: { enabled: true }` must set together.
All these modules are allowed to link to VNDK-SP or LL-NDK
modules only. Other dependency will cause link-type errors.
If `support_system_process` is not set or set to false,
the module is VNDK-core and can link to other VNDK-core,
VNDK-SP or LL-NDK modules only.
private
bool, declared as a VNDK-private module.
This module still creates the vendor and product variants refering
to the `vendor_available: true` and `product_available: true`
properties. However, it is only available to the other VNDK modules
but not to the non-VNDK vendor or product modules.
extends
string, Extending another module
whole_program_vtables
bool, Use -fwhole-program-vtables cflag.
whole_static_libs
list of string, list of modules whose object files should be linked into this module
in their entirety. For static library modules, all of the .o files from the intermediate
directory of the dependency will be linked into this modules .a file. For a shared library,
the dependency's .a file will be linked into this module using -Wl,--whole-archive.
yacc
YaccProperties
art_debug_defaults
name
,
srcs
,
exclude_srcs
,
defaults
,
host_supported
,
device_supported
,
afdo
,
aidl
,
allow_undefined_symbols
,
apex_available
,
arch
,
asflags
,
auto_gen_config
,
bazel_module
,
bootstrap
,
c_std
,
cflags
,
check_elf_files
,
clang
,
clang_asflags
,
clang_cflags
,
codegen.arm
,
codegen.arm64
,
codegen.riscv64
,
codegen.x86
,
codegen.x86_64
,
compile_multilib
,
conlyflags
,
corpus
,
cpp_std
,
cppflags
,
crt
,
data
,
data_bins
,
data_libs
,
debug
,
debug_ramdisk
,
defaults_visibility
,
device_specific
,
dictionary
,
disable_framework
,
dist
,
dists
,
double_loadable
,
dynamic_list
,
enabled
,
exclude_from_ndk_sysroot
,
exclude_from_recovery_snapshot
,
exclude_from_vendor_snapshot
,
exclude_generated_sources
,
exclude_runtime_libs
,
exclude_shared_libs
,
exclude_static_libs
,
export_generated_headers
,
export_header_lib_headers
,
export_include_dirs
,
export_shared_lib_headers
,
export_static_lib_headers
,
export_system_include_dirs
,
force_symbols_not_weak_list
,
force_symbols_weak_list
,
fuzz_config
,
fuzzing_frameworks
,
generated_headers
,
generated_sources
,
gnu_extensions
,
group_static_libs
,
gtest
,
header_abi_checker
,
header_libs
,
host_ldlibs
,
host_required
,
include_build_directory
,
include_dirs
,
init_rc
,
inject_bssl_hash
,
install_in_root
,
install_in_xbin
,
installable
,
instruction_set
,
isolated
,
ldflags
,
lex
,
licenses
,
linker_script
,
linker_scripts
,
llndk
,
local_include_dirs
,
logtags
,
lto
,
min_sdk_version
,
multilib
,
native_bridge_supported
,
native_coverage
,
no_libcrt
,
no_named_install_directory
,
nocrt
,
objs
,
odm_available
,
openmp
,
overrides
,
owner
,
pack_relocations
,
per_testcase_directory
,
pgo
,
prefix_symbols
,
product_available
,
product_specific
,
product_variables.always_use_prebuilt_sdks
,
product_variables.arc
,
product_variables.binder32bit
,
product_variables.debuggable
,
product_variables.enforce_vintf_manifest
,
product_variables.eng
,
product_variables.flatten_apex
,
product_variables.malloc_not_svelte
,
product_variables.malloc_pattern_fill_contents
,
product_variables.malloc_zero_contents
,
product_variables.native_coverage
,
product_variables.override_rs_driver
,
product_variables.pdk
,
product_variables.platform_sdk_version
,
product_variables.safestack
,
product_variables.treble_linker_namespaces
,
product_variables.uml
,
product_variables.unbundled_build
,
proprietary
,
proto
,
ramdisk
,
ramdisk_available
,
recovery
,
recovery_available
,
relative_install_path
,
release
,
renderscript
,
require_root
,
required
,
rtti
,
runtime_libs
,
sanitize
,
sanitized.address
,
sanitized.hwaddress
,
sanitized.none
,
sdclang
,
sdk_variant_only
,
sdk_version
,
shared
,
shared_libs
,
soc_specific
,
static
,
static_executable
,
static_libs
,
static_ndk_lib
,
stem
,
stl
,
strip
,
stubs
,
suffix
,
symlink_preferred_arch
,
symlinks
,
system_ext_specific
,
system_shared_libs
,
target
,
target.android
,
target.apex
,
target.host
,
target.platform
,
target.product
,
target.ramdisk
,
target.recovery
,
target.vendor
,
target.vendor_ramdisk
,
target_required
,
test_config
,
test_config_template
,
test_for
,
test_mainline_modules
,
test_options
,
test_per_src
,
test_suites
,
tidy
,
tidy_checks
,
tidy_checks_as_errors
,
tidy_disabled_srcs
,
tidy_flags
,
tidy_timeout_srcs
,
unexported_symbols_list
,
unique_host_soname
,
use_clang_lld
,
use_version_lib
,
vendor
,
vendor_available
,
vendor_public_library
,
vendor_ramdisk
,
vendor_ramdisk_available
,
version_script
,
vintf_fragments
,
visibility
,
vndk
,
whole_program_vtables
,
whole_static_libs
,
windows_import_lib
,
yacc
name
string, The name of the module. Must be unique across all modules.
srcs
list of string, list of source files used to compile the C/C++ module. May be .c, .cpp, or .S files.
srcs may reference the outputs of other modules that produce source files like genrule
or filegroup using the syntax ":module".
exclude_srcs
list of string, list of source files that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
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.
afdo
bool, Afdo allows developers self-service enroll for
automatic feedback-directed optimization using profile data.
⊕aidl
include_dirs
list of string, list of directories that will be added to the aidl include paths.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the aidl include paths.
generate_traces
bool, whether to generate traces (for systrace) for this interface
flags
list of string, list of flags that will be passed to the AIDL compiler
allow_undefined_symbols
bool, allow the module to contain undefined symbols. By default,
modules cannot contain undefined symbols that are not satisified by their immediate
dependencies. Set this flag to true to remove --no-undefined from the linker flags.
This flag should only be necessary for compiling low-level libraries like libc.
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".
"com.android.gki.*" matches any APEX module name with the prefix "com.android.gki.".
Default is ["//apex_available:platform"].
arch
interface
asflags
list of string, list of module-specific flags that will be used for .S compiles
auto_gen_config
bool, Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
explicitly.
⊕bazel_module
bazelModuleProperties
In "Bazel mixed build" mode, this represents the Bazel target replacing
this Soong module.
label
string, The label of the Bazel target replacing this Soong module. When run in conversion mode, this
will import the handcrafted build target into the autogenerated file. Note: this may result in
a conflict due to duplicate targets if bp2build_available is also set.
bp2build_available
bool, If true, bp2build will generate the converted Bazel target for this module. Note: this may
cause a conflict due to the duplicate targets if label is also set.
This is a bool pointer to support tristates: true, false, not set.
To opt in a module, set bazel_module: { bp2build_available: true }
To opt out a module, set bazel_module: { bp2build_available: false }
To defer the default setting for the directory, do not set the value.
bootstrap
bool, Allows this module to use non-APEX version of libraries. Useful
for building binaries that are started before APEXes are activated.
c_std
string, C standard version to use. Can be a specific version (such as "gnu11"),
"experimental" (which will use draft versions like C1x when available),
or the empty string (which will use the default).
If this is set, the file extension will be ignored and this will be used as the std version value. Setting this
to "default" will use the build system default version. This cannot be set at the same time as cpp_std.
cflags
list of string, list of clang flags required to correctly interpret the headers.
check_elf_files
bool, Check the prebuilt ELF files (e.g. DT_SONAME, DT_NEEDED, resolution of undefined
symbols, etc), default true.
clang
bool, Deprecated. true is the default, false is invalid.
clang_asflags
list of string, list of module-specific flags that will be used for .S compiles when
compiling with clang
clang_cflags
list of string, list of module-specific flags that will be used for C and C++ compiles when
compiling with clang
⊕codegen.arm
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.arm64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.riscv64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86_64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
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).
conlyflags
list of string, list of module-specific flags that will be used for C compiles
corpus
list of string, Optional list of seed files to be installed to the fuzz target's output
directory.
cpp_std
string, C++ standard version to use. Can be a specific version (such as
"gnu++11"), "experimental" (which will use draft versions like C++1z when
available), or the empty string (which will use the default).
cppflags
list of string, list of module-specific flags that will be used for C++ compiles
crt
bool, Indicates that this module is a CRT object. CRT objects will be split
into a variant per-API level between min_sdk_version and current.
data
list of string, list of files or filegroup modules that provide data that should be installed alongside
the test
data_bins
list of string, list of binary modules that should be installed alongside the test
data_libs
list of string, list of shared library modules that should be installed alongside the test
⊕debug
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
debug_ramdisk
bool, Whether this module is installed to debug ramdisk
defaults_visibility
list of string, Controls the visibility of the defaults module itself.
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`.
dictionary
string, Optional dictionary to be installed to the fuzz target's output directory.
disable_framework
bool, Add RunCommandTargetPreparer to stop framework before the test and start it after the test.
⊕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.
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)
double_loadable
bool, whether this module is capable of being loaded with other instance
(possibly an older version) of the same module in the same process.
Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
can be double loaded in a vendor process if the library is also a
(direct and indirect) dependency of an LLNDK library. Such libraries must be
explicitly marked as `double_loadable: true` by the owner, or the dependency
from the LLNDK lib should be cut if the lib is not designed to be double loaded.
dynamic_list
string, local file name to pass to the linker as --dynamic-list
enabled
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.
exclude_from_ndk_sysroot
bool, Indicates that this module should not be included in the NDK sysroot.
Only applies to CRT objects. Defaults to false.
exclude_from_recovery_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the recovery snapshot.
exclude_from_vendor_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the vendor snapshot.
exclude_generated_sources
list of string, list of generated sources that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with this module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build this module
exclude_static_libs
list of string, list of static libs that should not be used to build this module
export_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path (using -I) for this module and any module that links
against this module. Directories listed in export_include_dirs do not need to be
listed in local_include_dirs.
export_system_include_dirs
list of string, list of directories that will be added to the system include path
using -isystem for this module and any module that links against this module.
force_symbols_not_weak_list
string, local file name to pass to the linker as -force_symbols_not_weak_list
force_symbols_weak_list
string, local file name to pass to the linker as -force_symbols_weak_list
fuzz_config
FuzzConfig, Config for running the target on fuzzing infrastructure.
fuzzing_frameworks
FuzzFrameworks, Define the fuzzing frameworks this fuzz target can be built for. If
empty then the fuzz target will be available to be built for all fuzz
frameworks available
generated_sources
list of string, list of generated sources to compile. These are the names of gensrcs or
genrule modules.
gnu_extensions
bool, if set to false, use -std=c++* instead of -std=gnu++*
group_static_libs
bool, deprecated and ignored because lld makes it unnecessary. See b/189475744.
gtest
bool, if set, build against the gtest library. Defaults to true.
Properties for ABI compatibility checker.
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
host_ldlibs
list of string, -l arguments to pass to linker for host-provided shared libraries
host_required
list of string, names of other modules to install on host if this module is installed
include_build_directory
bool, Add the directory containing the Android.bp file to the list of include
directories. Defaults to true.
include_dirs
list of string, list of directories relative to the root of the source tree that will
be added to the include path using -I.
If possible, don't use this. If adding paths from the current directory use
local_include_dirs, if adding paths from other modules use export_include_dirs in
that module.
init_rc
list of string, init.rc files to be installed if this module is installed
inject_bssl_hash
bool, Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
install_in_root
bool, Install output directly in {partition}/, not in any subdir. This is only intended for use by
init_first_stage.
install_in_xbin
bool, Install output directly in {partition}/xbin
installable
bool
instruction_set
string, the instruction set architecture to use to compile the C/C++
module.
isolated
bool, if set, use the isolated gtest runner. Defaults to true if gtest is also true and the arch is Windows, false
otherwise.
ldflags
list of string, list of module-specific flags that will be used for all link steps
lex
LexProperties
licenses
list of string, Describes the licenses applicable to this module. Must reference license modules.
linker_script
string, if set, the path to a linker script to pass to ld -r when combining multiple object files.
linker_scripts
list of string, local files to pass to the linker as --script
⊕llndk
llndkLibraryProperties
If this is an LLNDK library, properties to describe the LLNDK stubs. Will be copied from
the module pointed to by llndk_stubs if it is set.
symbol_file
string, Relative path to the symbol map.
An example file can be seen here: TODO(danalbert): Make an example.
unversioned
bool, Whether the system library uses symbol versions.
override_export_include_dirs
list of string, list of directories relative to the Blueprints file that willbe added to the include path
(using -I) for any module that links against the LLNDK variant of this module, replacing
any that were listed outside the llndk clause.
private
bool, whether this module can be directly depended upon by libs that are installed
to /vendor and /product.
When set to true, this module can only be depended on by VNDK libraries, not
vendor nor product libraries. This effectively hides this module from
non-system modules. Default value is false.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path using -I
logtags
list of string, *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
file
⊕lto
Lto must violate capitialization style for acronyms so that it can be
referred to in blueprint files as "lto"
never
bool
full
bool
thin
bool
min_sdk_version
string, Minimum OS API level supported by this C or C++ module. This property becomes the value
of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
this property is also used to ensure that the min_sdk_version of the containing module is
not older (i.e. less) than this module's min_sdk_version. When not set, this property
defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
min_sdk_version of the containing APEX. When the module
is not built for an APEX, "apex_inherit" defaults to sdk_version.
multilib
interface
native_bridge_supported
bool, Whether this module is built for non-native architectures (also known as native bridge binary)
native_coverage
bool
no_libcrt
bool, don't link in libclang_rt.builtins-*.a
no_named_install_directory
bool, Disables the creation of a test-specific directory when used with
relative_install_path. Useful if several tests need to be in the same
directory, but test_per_src doesn't work.
nocrt
bool, don't link in crt_begin and crt_end. This flag should only be necessary for
compiling crt or libc.
objs
list of string, names of other cc_object modules to link into this module using partial linking
odm_available
bool, This is the same as the "vendor_available" except that the install path
of the vendor variant is /odm or /vendor/odm.
By replacing "vendor_available: true" with "odm_available: true", the
module will install its vendor variant to the /odm partition or /vendor/odm.
As the modules with "odm_available: true" still create the vendor variants,
they can link to the other vendor modules as the vendor_available modules do.
Also, the vendor modules can link to odm_available modules.
It may not be used for VNDK modules.
openmp
bool, Build and link with OpenMP
overrides
list of string, Names of modules to be overridden. Listed modules can only be other shared libraries
(in Make or Soong).
This does not completely prevent installation of the overridden libraries, but if both
binaries would be installed by default (in PRODUCT_PACKAGES) the other library will be removed
from PRODUCT_PACKAGES.
owner
string, vendor who owns this module
pack_relocations
bool, Generate compact dynamic relocation table, default true.
per_testcase_directory
bool, Install the test into a folder named for the module in all test suites.
⊕pgo
instrumentation
bool
profile_file
string
benchmarks
list of string
enable_profile_use
bool
cflags
list of string, Additional compiler flags to use when building this module
for profiling.
prefix_symbols
string, if set, add an extra objcopy --prefix-symbols= step
product_available
bool, whether this module should be allowed to be directly depended by other
modules with `product_specific: true` or `product_available: true`.
If set to true, an additional product variant will be built separately
that is limited to the set of libraries and headers that are exposed to
/product modules.
The product variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /product modules.
Different from the 'vendor_available' property, the modules with
vndk: {enabled: true} don't have to define 'product_available'. The VNDK
library without 'product_available' may not be depended on by any other
modules that has product variants including the product available VNDKs.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
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.always_use_prebuilt_sdks
⊕product_variables.arc
⊕cflags
⊕exclude_srcs
⊕include_dirs
⊕shared_libs
⊕static_libs
⊕srcs
⊕whole_static_libs
⊕product_variables.binder32bit
⊕product_variables.debuggable
⊕cflags
⊕cppflags
⊕init_rc
⊕required
⊕host_required
⊕target_required
⊕strip.all
⊕strip.keep_symbols
⊕strip.keep_symbols_and_debug_frame
⊕static_libs
⊕whole_static_libs
⊕shared_libs
⊕srcs
⊕exclude_srcs
⊕product_variables.enforce_vintf_manifest
⊕product_variables.eng
⊕cflags
⊕cppflags
⊕lto.never
⊕sanitize.address
⊕product_variables.flatten_apex
⊕product_variables.malloc_not_svelte
⊕cflags
⊕shared_libs
⊕whole_static_libs
⊕exclude_static_libs
⊕srcs
⊕product_variables.malloc_pattern_fill_contents
⊕product_variables.malloc_zero_contents
⊕product_variables.native_coverage
⊕product_variables.override_rs_driver
⊕product_variables.pdk
⊕product_variables.platform_sdk_version
⊕product_variables.safestack
⊕product_variables.treble_linker_namespaces
⊕product_variables.uml
⊕product_variables.unbundled_build
proprietary
bool, whether this is a proprietary vendor module, and should be installed into /vendor
⊕proto
static
bool, Link statically against the protobuf runtime
type
string, Proto generator type. C++: full or lite. Java: micro, nano, stream, or lite.
plugin
string, Proto plugin to use as the generator. Must be a cc_binary_host module.
include_dirs
list of string, list of directories that will be added to the protoc include paths.
local_include_dirs
list of string, list of directories relative to the bp file that will
be added to the protoc include paths.
canonical_path_from_root
bool, whether to identify the proto files from the root of the
source tree (the original method in Android, useful for
android-specific protos), or relative from where they were
specified (useful for external/third party protos).
This defaults to true today, but is expected to default to
false in the future.
ramdisk
bool, Whether this module is installed to ramdisk
ramdisk_available
bool, Make this module available when building for ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
recovery
bool, Whether this module is installed to recovery partition
recovery_available
bool, Make this module available when building for recovery
relative_install_path
string, install to a subdirectory of the default install path for the module
⊕release
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
⊕renderscript
include_dirs
list of string, list of directories that will be added to the llvm-rs-cc include paths
flags
list of string, list of flags that will be passed to llvm-rs-cc
target_api
string, Renderscript API level to target
require_root
bool, Add RootTargetPreparer to auto generated test config. This guarantees the test to run
with root permission.
required
list of string, names of other modules to install if this module is installed
rtti
bool, pass -frtti instead of -fno-rtti
runtime_libs
list of string, list of modules that should be installed with this module. This is similar to 'required'
but '.vendor' suffix will be appended to the module names if the shared libraries have
vendor variants and this module uses VNDK.
⊕sanitize
SanitizeUserProps
never
bool, Prevent use of any sanitizers on this module
address
bool, ASan (Address sanitizer), incompatible with static binaries.
Always runs in a diagnostic mode.
Use of address sanitizer disables cfi sanitizer.
Hwaddress sanitizer takes precedence over this sanitizer.
thread
bool, TSan (Thread sanitizer), incompatible with static binaries and 32 bit architectures.
Always runs in a diagnostic mode.
Use of thread sanitizer disables cfi and scudo sanitizers.
Hwaddress sanitizer takes precedence over this sanitizer.
hwaddress
bool, HWASan (Hardware Address sanitizer).
Use of hwasan sanitizer disables cfi, address, thread, and scudo sanitizers.
all_undefined
bool, Undefined behavior sanitizer
undefined
bool, Subset of undefined behavior sanitizer
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable
fuzzer
bool, Fuzzer, incompatible with static binaries.
safestack
bool, safe-stack sanitizer, incompatible with 32-bit architectures.
cfi
bool, cfi sanitizer, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, incompatible with Darwin.
scudo
bool, scudo sanitizer, incompatible with asan, hwasan, tsan
This should not be used in Android 11+ : https://source.android.com/devices/tech/debug/scudo
deprecated
scs
bool, shadow-call-stack sanitizer, only available on arm64/riscv64.
memtag_heap
bool, Memory-tagging, only available on arm64
if diag.memtag unset or false, enables async memory tagging
memtag_stack
bool, Memory-tagging stack instrumentation, only available on arm64
Adds instrumentation to detect stack buffer overflows and use-after-scope using MTE.
writeonly
bool, A modifier for ASAN and HWASAN for write only instrumentation
⊕diag
Sanitizers to run in the diagnostic mode (as opposed to the release mode).
Replaces abort() on error with a human-readable error message.
Address and Thread sanitizers always run in diagnostic mode.
undefined
bool, Undefined behavior sanitizer, diagnostic mode
cfi
bool, cfi sanitizer, diagnostic mode, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, diagnostic mode, incompatible with Darwin.
memtag_heap
bool, Memory-tagging, only available on arm64
requires sanitizer.memtag: true
if set, enables sync memory tagging
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable in diagnostic mode
no_recover
list of string, List of sanitizers to pass to -fno-sanitize-recover
results in only the first detected error for these sanitizers being reported and program then
exits with a non-zero exit code.
⊕config
Sanitizers to run with flag configuration specified
cfi_assembly_support
bool, Enables CFI support flags for assembly-heavy libraries
recover
list of string, List of sanitizers to pass to -fsanitize-recover
allows execution to continue for these sanitizers to detect multiple errors rather than only
the first one
blocklist
string, value to pass to -fsanitize-ignorelist
⊕sanitized.address
⊕sanitized.hwaddress
⊕sanitized.none
sdclang
bool, compile module with SDLLVM instead of AOSP LLVM
sdk_variant_only
bool, If true, always create an sdk variant and don't create a platform variant.
sdk_version
string, The API level that this module is built against. The APIs of this API level will be
visible at build time, but use of any APIs newer than min_sdk_version will render the
module unloadable on older devices. In the future it will be possible to weakly-link new
APIs, making the behavior match Java: such modules will load on older devices, but
calling new APIs on devices that do not support them will result in a crash.
This property has the same behavior as sdk_version does for Java modules. For those
familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
does for Java code.
In addition, setting this property causes two variants to be built, one for the platform
and one for apps.
⊕shared
StaticOrSharedProperties
srcs
list of string
tidy_disabled_srcs
list of string
tidy_timeout_srcs
list of string
⊕sanitized
Sanitized
⊕none
⊕address
⊕hwaddress
cflags
list of string
enabled
bool
whole_static_libs
list of string
static_libs
list of string
shared_libs
list of string
system_shared_libs
list of string
apex_available
list of string
installable
bool
shared_libs
list of string, list of modules that should be dynamically linked into this module.
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).
⊕static
StaticOrSharedProperties
srcs
list of string
tidy_disabled_srcs
list of string
tidy_timeout_srcs
list of string
⊕sanitized
Sanitized
⊕none
⊕address
⊕hwaddress
cflags
list of string
enabled
bool
whole_static_libs
list of string
static_libs
list of string
shared_libs
list of string
system_shared_libs
list of string
apex_available
list of string
installable
bool
static_executable
bool, compile executable with -static
static_libs
list of string, list of static library modules that should only provide headers for this module.
static_ndk_lib
bool
stem
string, set the name of the output
stl
string, Select the STL library to use. Possible values are "libc++",
"libc++_static", "libstdc++", or "none". Leave blank to select the
default.
⊕strip
none
bool, none forces all stripping to be disabled.
Device modules default to stripping enabled leaving mini debuginfo.
Host modules default to stripping disabled, but can be enabled by setting any other
strip boolean property.
all
bool, all forces stripping everything, including the mini debug info.
keep_symbols
bool, keep_symbols enables stripping but keeps all symbols.
keep_symbols_list
list of string, keep_symbols_list specifies a list of symbols to keep if keep_symbols is enabled.
If it is unset then all symbols are kept.
keep_symbols_and_debug_frame
bool, keep_symbols_and_debug_frame enables stripping but keeps all symbols and debug frames.
⊕stubs
Generate stubs to make this library accessible to APEXes.
symbol_file
string, Relative path to the symbol map. The symbol map provides the list of
symbols that are exported for stubs variant of this library.
versions
list of string, List versions to generate stubs libs for. The version name "current" is always
implicitly added.
implementation_installable
bool, Whether to not require the implementation of the library to be installed if a
client of the stubs is installed. Defaults to true; set to false if the
implementation is made available by some other means, e.g. in a Microdroid
virtual machine.
suffix
string, append to the name of the output
symlink_preferred_arch
bool, if set, install a symlink to the preferred architecture
symlinks
list of string, install symlinks to the binary. Symlink names will have the suffix and the binary
extension (if any) appended
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).
system_shared_libs
list of string, list of default libraries that will provide headers for this module. If unset, generally
defaults to libc, libm, and libdl. Set to [] to prevent using headers from the defaults.
target
interface
⊕target.android
⊕target.apex
exclude_shared_libs
list of string, list of shared libs that should not be used to build the apex variant of
the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build the apex
variant of the C/C++ module.
⊕target.host
⊕target.platform
cflags
list of string, List of additional cflags that should be used to build the platform
variant of the C/C++ module.
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
required
list of string, List of modules required by the core variant.
exclude_required
list of string, List of modules not required by the core variant.
shared_libs
list of string, list of shared libs that should be use to build the platform variant
of a module that sets sdk_version. This should rarely be necessary,
in most cases the same libraries are available for the SDK and platform
variants.
exclude_shared_libs
list of string, list of shared libs that should not be used to build the platform variant
of the C/C++ module.
⊕target.product
override_export_include_dirs
list of string, list of exported include directories, like
export_include_dirs, that will be applied to
vendor or product variant of this library.
This will overwrite any other declarations.
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
suffix
string, set suffix of the name of the output
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
⊕target.ramdisk
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
ramdisk variant of the C/C++ module.
⊕target.recovery
required
list of string, List of modules required by the recovery variant.
exclude_required
list of string, List of modules not required by the recovery variant.
shared_libs
list of string, list of shared libs that only should be used to build the recovery
variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
recovery variant of the C/C++ module.
srcs
list of string, list of source files that should only be used in the
recovery variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to
build the recovery variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the recovery
variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to
build the recovery variant of the C/C++ module.
⊕target.vendor
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
suffix
string, set suffix of the name of the output
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
override_export_include_dirs
list of string, list of exported include directories, like
export_include_dirs, that will be applied to
vendor or product variant of this library.
This will overwrite any other declarations.
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
⊕target.vendor_ramdisk
exclude_srcs
list of string, list of source files that should not be used to
build the vendor ramdisk variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the vendor ramdisk
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the vendor ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor ramdisk variant of the C/C++ module.
target_required
list of string, names of other modules to install on target if this module is installed
test_config
string, the name of the test configuration (for example "AndroidTest.xml") that should be
installed with the module.
test_config_template
string, the name of the test configuration template (for example "AndroidTestTemplate.xml") that
should be installed with the module.
test_for
list of string, List of APEXes that this module has private access to for testing purpose. The module
can depend on libraries that are not exported by the APEXes and use private symbols
from the exported libraries.
test_mainline_modules
list of string, Add parameterized mainline modules to auto generated test config. The options will be
handled by TradeFed to download and install the specified modules on the device.
⊕test_options
TestOptions
Test options.
run_test_as
string, The UID that you want to run the test as on a device.
test_suite_tag
list of string, A list of free-formed strings without spaces that categorize the test.
min_shipping_api_level
int64, Add ShippingApiLevelModuleController to auto generated test config. If the device properties
for the shipping api level is less than the min_shipping_api_level, skip this module.
vsr_min_shipping_api_level
int64, Add ShippingApiLevelModuleController to auto generated test config. If any of the device
shipping api level and vendor api level properties are less than the
vsr_min_shipping_api_level, skip this module.
As this includes the shipping api level check, it is not allowed to define
min_shipping_api_level at the same time with this property.
min_vndk_version
int64, Add MinApiLevelModuleController with ro.vndk.version property. If ro.vndk.version has an
integer value and the value is less than the min_vndk_version, skip this module.
unit_test
bool, If the test is a hostside (no device required) unittest that shall be run
during presubmit check.
tags
list of string, Tags provide additional metadata to customize test execution by downstream
test runners. The tags have no special meaning to Soong.
test_per_src
bool, Create a separate binary for each source file. Useful when there is
global state that can not be torn down and reset between each test suite.
test_suites
list of string, list of compatibility suites (for example "cts", "vts") that the module should be
installed into.
tidy
bool, whether to run clang-tidy over C-like sources.
tidy_checks
list of string, Extra checks to enable or disable in clang-tidy
tidy_checks_as_errors
list of string, Checks that should be treated as errors.
tidy_disabled_srcs
list of string, list of source files that should not be compiled with clang-tidy.
tidy_flags
list of string, Extra flags to pass to clang-tidy
tidy_timeout_srcs
list of string, list of source files that should not be compiled by clang-tidy when TIDY_TIMEOUT is set.
unexported_symbols_list
string, local file name to pass to the linker as -unexported_symbols_list
unique_host_soname
bool, rename host libraries to prevent overlap with system installed libraries
use_clang_lld
bool, Use clang lld instead of gnu ld.
use_version_lib
bool, make android::build:GetBuildNumber() available containing the build ID.
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_available
bool, whether this module should be allowed to be directly depended by other
modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
If set to true, two variants will be built separately, one like
normal, and the other limited to the set of libraries and headers
that are exposed to /vendor modules.
The vendor variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /vendor modules.
The modules with vndk: {enabled: true} must define 'vendor_available'
to 'true'.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
⊕vendor_public_library
vendorPublicLibraryProperties
If this is a vendor public library, properties to describe the vendor public library stubs.
symbol_file
string, Relative path to the symbol map.
unversioned
bool, Whether the system library uses symbol versions.
override_export_include_dirs
list of string, list of directories relative to the Blueprints file that willbe added to the include path
(using -I) for any module that links against the LLNDK variant of this module, replacing
any that were listed outside the llndk clause.
vendor_ramdisk
bool, Whether this module is installed to vendor ramdisk
vendor_ramdisk_available
bool, Make this module available when building for vendor ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
version_script
string, local file name to pass to the linker as --version-script
vintf_fragments
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/+/master/README.md#visibility for
more details.
⊕vndk
enabled
bool, declared as a VNDK or VNDK-SP module. The vendor variant
will be installed in /system instead of /vendor partition.
`vendor_available` and `product_available` must be explicitly
set to either true or false together with `vndk: {enabled: true}`.
support_system_process
bool, declared as a VNDK-SP module, which is a subset of VNDK.
`vndk: { enabled: true }` must set together.
All these modules are allowed to link to VNDK-SP or LL-NDK
modules only. Other dependency will cause link-type errors.
If `support_system_process` is not set or set to false,
the module is VNDK-core and can link to other VNDK-core,
VNDK-SP or LL-NDK modules only.
private
bool, declared as a VNDK-private module.
This module still creates the vendor and product variants refering
to the `vendor_available: true` and `product_available: true`
properties. However, it is only available to the other VNDK modules
but not to the non-VNDK vendor or product modules.
extends
string, Extending another module
whole_program_vtables
bool, Use -fwhole-program-vtables cflag.
whole_static_libs
list of string, list of modules whose object files should be linked into this module
in their entirety. For static library modules, all of the .o files from the intermediate
directory of the dependency will be linked into this modules .a file. For a shared library,
the dependency's .a file will be linked into this module using -Wl,--whole-archive.
windows_import_lib
string, Optionally provide an import library if this is a Windows PE DLL prebuilt.
This is needed only if this library is linked by other modules in build time.
Only makes sense for the Windows target.
yacc
YaccProperties
art_global_defaults
name
,
srcs
,
exclude_srcs
,
defaults
,
host_supported
,
device_supported
,
afdo
,
aidl
,
allow_undefined_symbols
,
apex_available
,
arch
,
asflags
,
auto_gen_config
,
bazel_module
,
bootstrap
,
c_std
,
cflags
,
check_elf_files
,
clang
,
clang_asflags
,
clang_cflags
,
codegen.arm
,
codegen.arm64
,
codegen.riscv64
,
codegen.x86
,
codegen.x86_64
,
compile_multilib
,
conlyflags
,
corpus
,
cpp_std
,
cppflags
,
crt
,
data
,
data_bins
,
data_libs
,
debug
,
debug_ramdisk
,
defaults_visibility
,
device_specific
,
dictionary
,
disable_framework
,
dist
,
dists
,
double_loadable
,
dynamic_list
,
enabled
,
exclude_from_ndk_sysroot
,
exclude_from_recovery_snapshot
,
exclude_from_vendor_snapshot
,
exclude_generated_sources
,
exclude_runtime_libs
,
exclude_shared_libs
,
exclude_static_libs
,
export_generated_headers
,
export_header_lib_headers
,
export_include_dirs
,
export_shared_lib_headers
,
export_static_lib_headers
,
export_system_include_dirs
,
force_symbols_not_weak_list
,
force_symbols_weak_list
,
fuzz_config
,
fuzzing_frameworks
,
generated_headers
,
generated_sources
,
gnu_extensions
,
group_static_libs
,
gtest
,
header_abi_checker
,
header_libs
,
host_ldlibs
,
host_required
,
include_build_directory
,
include_dirs
,
init_rc
,
inject_bssl_hash
,
install_in_root
,
install_in_xbin
,
installable
,
instruction_set
,
isolated
,
ldflags
,
lex
,
licenses
,
linker_script
,
linker_scripts
,
llndk
,
local_include_dirs
,
logtags
,
lto
,
min_sdk_version
,
multilib
,
native_bridge_supported
,
native_coverage
,
no_libcrt
,
no_named_install_directory
,
nocrt
,
objs
,
odm_available
,
openmp
,
overrides
,
owner
,
pack_relocations
,
per_testcase_directory
,
pgo
,
prefix_symbols
,
product_available
,
product_specific
,
product_variables.always_use_prebuilt_sdks
,
product_variables.arc
,
product_variables.binder32bit
,
product_variables.debuggable
,
product_variables.enforce_vintf_manifest
,
product_variables.eng
,
product_variables.flatten_apex
,
product_variables.malloc_not_svelte
,
product_variables.malloc_pattern_fill_contents
,
product_variables.malloc_zero_contents
,
product_variables.native_coverage
,
product_variables.override_rs_driver
,
product_variables.pdk
,
product_variables.platform_sdk_version
,
product_variables.safestack
,
product_variables.treble_linker_namespaces
,
product_variables.uml
,
product_variables.unbundled_build
,
proprietary
,
proto
,
ramdisk
,
ramdisk_available
,
recovery
,
recovery_available
,
relative_install_path
,
release
,
renderscript
,
require_root
,
required
,
rtti
,
runtime_libs
,
sanitize
,
sanitized.address
,
sanitized.hwaddress
,
sanitized.none
,
sdclang
,
sdk_variant_only
,
sdk_version
,
shared
,
shared_libs
,
soc_specific
,
static
,
static_executable
,
static_libs
,
static_ndk_lib
,
stem
,
stl
,
strip
,
stubs
,
suffix
,
symlink_preferred_arch
,
symlinks
,
system_ext_specific
,
system_shared_libs
,
target
,
target.android
,
target.apex
,
target.host
,
target.platform
,
target.product
,
target.ramdisk
,
target.recovery
,
target.vendor
,
target.vendor_ramdisk
,
target_required
,
test_config
,
test_config_template
,
test_for
,
test_mainline_modules
,
test_options
,
test_per_src
,
test_suites
,
tidy
,
tidy_checks
,
tidy_checks_as_errors
,
tidy_disabled_srcs
,
tidy_flags
,
tidy_timeout_srcs
,
unexported_symbols_list
,
unique_host_soname
,
use_clang_lld
,
use_version_lib
,
vendor
,
vendor_available
,
vendor_public_library
,
vendor_ramdisk
,
vendor_ramdisk_available
,
version_script
,
vintf_fragments
,
visibility
,
vndk
,
whole_program_vtables
,
whole_static_libs
,
windows_import_lib
,
yacc
name
string, The name of the module. Must be unique across all modules.
srcs
list of string, list of source files used to compile the C/C++ module. May be .c, .cpp, or .S files.
srcs may reference the outputs of other modules that produce source files like genrule
or filegroup using the syntax ":module".
exclude_srcs
list of string, list of source files that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
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.
afdo
bool, Afdo allows developers self-service enroll for
automatic feedback-directed optimization using profile data.
⊕aidl
include_dirs
list of string, list of directories that will be added to the aidl include paths.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the aidl include paths.
generate_traces
bool, whether to generate traces (for systrace) for this interface
flags
list of string, list of flags that will be passed to the AIDL compiler
allow_undefined_symbols
bool, allow the module to contain undefined symbols. By default,
modules cannot contain undefined symbols that are not satisified by their immediate
dependencies. Set this flag to true to remove --no-undefined from the linker flags.
This flag should only be necessary for compiling low-level libraries like libc.
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".
"com.android.gki.*" matches any APEX module name with the prefix "com.android.gki.".
Default is ["//apex_available:platform"].
arch
interface
asflags
list of string, list of module-specific flags that will be used for .S compiles
auto_gen_config
bool, Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
explicitly.
⊕bazel_module
bazelModuleProperties
In "Bazel mixed build" mode, this represents the Bazel target replacing
this Soong module.
label
string, The label of the Bazel target replacing this Soong module. When run in conversion mode, this
will import the handcrafted build target into the autogenerated file. Note: this may result in
a conflict due to duplicate targets if bp2build_available is also set.
bp2build_available
bool, If true, bp2build will generate the converted Bazel target for this module. Note: this may
cause a conflict due to the duplicate targets if label is also set.
This is a bool pointer to support tristates: true, false, not set.
To opt in a module, set bazel_module: { bp2build_available: true }
To opt out a module, set bazel_module: { bp2build_available: false }
To defer the default setting for the directory, do not set the value.
bootstrap
bool, Allows this module to use non-APEX version of libraries. Useful
for building binaries that are started before APEXes are activated.
c_std
string, C standard version to use. Can be a specific version (such as "gnu11"),
"experimental" (which will use draft versions like C1x when available),
or the empty string (which will use the default).
If this is set, the file extension will be ignored and this will be used as the std version value. Setting this
to "default" will use the build system default version. This cannot be set at the same time as cpp_std.
cflags
list of string, list of clang flags required to correctly interpret the headers.
check_elf_files
bool, Check the prebuilt ELF files (e.g. DT_SONAME, DT_NEEDED, resolution of undefined
symbols, etc), default true.
clang
bool, Deprecated. true is the default, false is invalid.
clang_asflags
list of string, list of module-specific flags that will be used for .S compiles when
compiling with clang
clang_cflags
list of string, list of module-specific flags that will be used for C and C++ compiles when
compiling with clang
⊕codegen.arm
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.arm64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.riscv64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86_64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
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).
conlyflags
list of string, list of module-specific flags that will be used for C compiles
corpus
list of string, Optional list of seed files to be installed to the fuzz target's output
directory.
cpp_std
string, C++ standard version to use. Can be a specific version (such as
"gnu++11"), "experimental" (which will use draft versions like C++1z when
available), or the empty string (which will use the default).
cppflags
list of string, list of module-specific flags that will be used for C++ compiles
crt
bool, Indicates that this module is a CRT object. CRT objects will be split
into a variant per-API level between min_sdk_version and current.
data
list of string, list of files or filegroup modules that provide data that should be installed alongside
the test
data_bins
list of string, list of binary modules that should be installed alongside the test
data_libs
list of string, list of shared library modules that should be installed alongside the test
⊕debug
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
debug_ramdisk
bool, Whether this module is installed to debug ramdisk
defaults_visibility
list of string, Controls the visibility of the defaults module itself.
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`.
dictionary
string, Optional dictionary to be installed to the fuzz target's output directory.
disable_framework
bool, Add RunCommandTargetPreparer to stop framework before the test and start it after the test.
⊕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.
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)
double_loadable
bool, whether this module is capable of being loaded with other instance
(possibly an older version) of the same module in the same process.
Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
can be double loaded in a vendor process if the library is also a
(direct and indirect) dependency of an LLNDK library. Such libraries must be
explicitly marked as `double_loadable: true` by the owner, or the dependency
from the LLNDK lib should be cut if the lib is not designed to be double loaded.
dynamic_list
string, local file name to pass to the linker as --dynamic-list
enabled
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.
exclude_from_ndk_sysroot
bool, Indicates that this module should not be included in the NDK sysroot.
Only applies to CRT objects. Defaults to false.
exclude_from_recovery_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the recovery snapshot.
exclude_from_vendor_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the vendor snapshot.
exclude_generated_sources
list of string, list of generated sources that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with this module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build this module
exclude_static_libs
list of string, list of static libs that should not be used to build this module
export_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path (using -I) for this module and any module that links
against this module. Directories listed in export_include_dirs do not need to be
listed in local_include_dirs.
export_system_include_dirs
list of string, list of directories that will be added to the system include path
using -isystem for this module and any module that links against this module.
force_symbols_not_weak_list
string, local file name to pass to the linker as -force_symbols_not_weak_list
force_symbols_weak_list
string, local file name to pass to the linker as -force_symbols_weak_list
fuzz_config
FuzzConfig, Config for running the target on fuzzing infrastructure.
fuzzing_frameworks
FuzzFrameworks, Define the fuzzing frameworks this fuzz target can be built for. If
empty then the fuzz target will be available to be built for all fuzz
frameworks available
generated_sources
list of string, list of generated sources to compile. These are the names of gensrcs or
genrule modules.
gnu_extensions
bool, if set to false, use -std=c++* instead of -std=gnu++*
group_static_libs
bool, deprecated and ignored because lld makes it unnecessary. See b/189475744.
gtest
bool, if set, build against the gtest library. Defaults to true.
Properties for ABI compatibility checker.
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
host_ldlibs
list of string, -l arguments to pass to linker for host-provided shared libraries
host_required
list of string, names of other modules to install on host if this module is installed
include_build_directory
bool, Add the directory containing the Android.bp file to the list of include
directories. Defaults to true.
include_dirs
list of string, list of directories relative to the root of the source tree that will
be added to the include path using -I.
If possible, don't use this. If adding paths from the current directory use
local_include_dirs, if adding paths from other modules use export_include_dirs in
that module.
init_rc
list of string, init.rc files to be installed if this module is installed
inject_bssl_hash
bool, Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
install_in_root
bool, Install output directly in {partition}/, not in any subdir. This is only intended for use by
init_first_stage.
install_in_xbin
bool, Install output directly in {partition}/xbin
installable
bool
instruction_set
string, the instruction set architecture to use to compile the C/C++
module.
isolated
bool, if set, use the isolated gtest runner. Defaults to true if gtest is also true and the arch is Windows, false
otherwise.
ldflags
list of string, list of module-specific flags that will be used for all link steps
lex
LexProperties
licenses
list of string, Describes the licenses applicable to this module. Must reference license modules.
linker_script
string, if set, the path to a linker script to pass to ld -r when combining multiple object files.
linker_scripts
list of string, local files to pass to the linker as --script
⊕llndk
llndkLibraryProperties
If this is an LLNDK library, properties to describe the LLNDK stubs. Will be copied from
the module pointed to by llndk_stubs if it is set.
symbol_file
string, Relative path to the symbol map.
An example file can be seen here: TODO(danalbert): Make an example.
unversioned
bool, Whether the system library uses symbol versions.
override_export_include_dirs
list of string, list of directories relative to the Blueprints file that willbe added to the include path
(using -I) for any module that links against the LLNDK variant of this module, replacing
any that were listed outside the llndk clause.
private
bool, whether this module can be directly depended upon by libs that are installed
to /vendor and /product.
When set to true, this module can only be depended on by VNDK libraries, not
vendor nor product libraries. This effectively hides this module from
non-system modules. Default value is false.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path using -I
logtags
list of string, *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
file
⊕lto
Lto must violate capitialization style for acronyms so that it can be
referred to in blueprint files as "lto"
never
bool
full
bool
thin
bool
min_sdk_version
string, Minimum OS API level supported by this C or C++ module. This property becomes the value
of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
this property is also used to ensure that the min_sdk_version of the containing module is
not older (i.e. less) than this module's min_sdk_version. When not set, this property
defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
min_sdk_version of the containing APEX. When the module
is not built for an APEX, "apex_inherit" defaults to sdk_version.
multilib
interface
native_bridge_supported
bool, Whether this module is built for non-native architectures (also known as native bridge binary)
native_coverage
bool
no_libcrt
bool, don't link in libclang_rt.builtins-*.a
no_named_install_directory
bool, Disables the creation of a test-specific directory when used with
relative_install_path. Useful if several tests need to be in the same
directory, but test_per_src doesn't work.
nocrt
bool, don't link in crt_begin and crt_end. This flag should only be necessary for
compiling crt or libc.
objs
list of string, names of other cc_object modules to link into this module using partial linking
odm_available
bool, This is the same as the "vendor_available" except that the install path
of the vendor variant is /odm or /vendor/odm.
By replacing "vendor_available: true" with "odm_available: true", the
module will install its vendor variant to the /odm partition or /vendor/odm.
As the modules with "odm_available: true" still create the vendor variants,
they can link to the other vendor modules as the vendor_available modules do.
Also, the vendor modules can link to odm_available modules.
It may not be used for VNDK modules.
openmp
bool, Build and link with OpenMP
overrides
list of string, Names of modules to be overridden. Listed modules can only be other shared libraries
(in Make or Soong).
This does not completely prevent installation of the overridden libraries, but if both
binaries would be installed by default (in PRODUCT_PACKAGES) the other library will be removed
from PRODUCT_PACKAGES.
owner
string, vendor who owns this module
pack_relocations
bool, Generate compact dynamic relocation table, default true.
per_testcase_directory
bool, Install the test into a folder named for the module in all test suites.
⊕pgo
instrumentation
bool
profile_file
string
benchmarks
list of string
enable_profile_use
bool
cflags
list of string, Additional compiler flags to use when building this module
for profiling.
prefix_symbols
string, if set, add an extra objcopy --prefix-symbols= step
product_available
bool, whether this module should be allowed to be directly depended by other
modules with `product_specific: true` or `product_available: true`.
If set to true, an additional product variant will be built separately
that is limited to the set of libraries and headers that are exposed to
/product modules.
The product variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /product modules.
Different from the 'vendor_available' property, the modules with
vndk: {enabled: true} don't have to define 'product_available'. The VNDK
library without 'product_available' may not be depended on by any other
modules that has product variants including the product available VNDKs.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
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.always_use_prebuilt_sdks
⊕product_variables.arc
⊕cflags
⊕exclude_srcs
⊕include_dirs
⊕shared_libs
⊕static_libs
⊕srcs
⊕whole_static_libs
⊕product_variables.binder32bit
⊕product_variables.debuggable
⊕cflags
⊕cppflags
⊕init_rc
⊕required
⊕host_required
⊕target_required
⊕strip.all
⊕strip.keep_symbols
⊕strip.keep_symbols_and_debug_frame
⊕static_libs
⊕whole_static_libs
⊕shared_libs
⊕srcs
⊕exclude_srcs
⊕product_variables.enforce_vintf_manifest
⊕product_variables.eng
⊕cflags
⊕cppflags
⊕lto.never
⊕sanitize.address
⊕product_variables.flatten_apex
⊕product_variables.malloc_not_svelte
⊕cflags
⊕shared_libs
⊕whole_static_libs
⊕exclude_static_libs
⊕srcs
⊕product_variables.malloc_pattern_fill_contents
⊕product_variables.malloc_zero_contents
⊕product_variables.native_coverage
⊕product_variables.override_rs_driver
⊕product_variables.pdk
⊕product_variables.platform_sdk_version
⊕product_variables.safestack
⊕product_variables.treble_linker_namespaces
⊕product_variables.uml
⊕product_variables.unbundled_build
proprietary
bool, whether this is a proprietary vendor module, and should be installed into /vendor
⊕proto
static
bool, Link statically against the protobuf runtime
type
string, Proto generator type. C++: full or lite. Java: micro, nano, stream, or lite.
plugin
string, Proto plugin to use as the generator. Must be a cc_binary_host module.
include_dirs
list of string, list of directories that will be added to the protoc include paths.
local_include_dirs
list of string, list of directories relative to the bp file that will
be added to the protoc include paths.
canonical_path_from_root
bool, whether to identify the proto files from the root of the
source tree (the original method in Android, useful for
android-specific protos), or relative from where they were
specified (useful for external/third party protos).
This defaults to true today, but is expected to default to
false in the future.
ramdisk
bool, Whether this module is installed to ramdisk
ramdisk_available
bool, Make this module available when building for ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
recovery
bool, Whether this module is installed to recovery partition
recovery_available
bool, Make this module available when building for recovery
relative_install_path
string, install to a subdirectory of the default install path for the module
⊕release
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
⊕renderscript
include_dirs
list of string, list of directories that will be added to the llvm-rs-cc include paths
flags
list of string, list of flags that will be passed to llvm-rs-cc
target_api
string, Renderscript API level to target
require_root
bool, Add RootTargetPreparer to auto generated test config. This guarantees the test to run
with root permission.
required
list of string, names of other modules to install if this module is installed
rtti
bool, pass -frtti instead of -fno-rtti
runtime_libs
list of string, list of modules that should be installed with this module. This is similar to 'required'
but '.vendor' suffix will be appended to the module names if the shared libraries have
vendor variants and this module uses VNDK.
⊕sanitize
SanitizeUserProps
never
bool, Prevent use of any sanitizers on this module
address
bool, ASan (Address sanitizer), incompatible with static binaries.
Always runs in a diagnostic mode.
Use of address sanitizer disables cfi sanitizer.
Hwaddress sanitizer takes precedence over this sanitizer.
thread
bool, TSan (Thread sanitizer), incompatible with static binaries and 32 bit architectures.
Always runs in a diagnostic mode.
Use of thread sanitizer disables cfi and scudo sanitizers.
Hwaddress sanitizer takes precedence over this sanitizer.
hwaddress
bool, HWASan (Hardware Address sanitizer).
Use of hwasan sanitizer disables cfi, address, thread, and scudo sanitizers.
all_undefined
bool, Undefined behavior sanitizer
undefined
bool, Subset of undefined behavior sanitizer
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable
fuzzer
bool, Fuzzer, incompatible with static binaries.
safestack
bool, safe-stack sanitizer, incompatible with 32-bit architectures.
cfi
bool, cfi sanitizer, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, incompatible with Darwin.
scudo
bool, scudo sanitizer, incompatible with asan, hwasan, tsan
This should not be used in Android 11+ : https://source.android.com/devices/tech/debug/scudo
deprecated
scs
bool, shadow-call-stack sanitizer, only available on arm64/riscv64.
memtag_heap
bool, Memory-tagging, only available on arm64
if diag.memtag unset or false, enables async memory tagging
memtag_stack
bool, Memory-tagging stack instrumentation, only available on arm64
Adds instrumentation to detect stack buffer overflows and use-after-scope using MTE.
writeonly
bool, A modifier for ASAN and HWASAN for write only instrumentation
⊕diag
Sanitizers to run in the diagnostic mode (as opposed to the release mode).
Replaces abort() on error with a human-readable error message.
Address and Thread sanitizers always run in diagnostic mode.
undefined
bool, Undefined behavior sanitizer, diagnostic mode
cfi
bool, cfi sanitizer, diagnostic mode, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, diagnostic mode, incompatible with Darwin.
memtag_heap
bool, Memory-tagging, only available on arm64
requires sanitizer.memtag: true
if set, enables sync memory tagging
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable in diagnostic mode
no_recover
list of string, List of sanitizers to pass to -fno-sanitize-recover
results in only the first detected error for these sanitizers being reported and program then
exits with a non-zero exit code.
⊕config
Sanitizers to run with flag configuration specified
cfi_assembly_support
bool, Enables CFI support flags for assembly-heavy libraries
recover
list of string, List of sanitizers to pass to -fsanitize-recover
allows execution to continue for these sanitizers to detect multiple errors rather than only
the first one
blocklist
string, value to pass to -fsanitize-ignorelist
⊕sanitized.address
⊕sanitized.hwaddress
⊕sanitized.none
sdclang
bool, compile module with SDLLVM instead of AOSP LLVM
sdk_variant_only
bool, If true, always create an sdk variant and don't create a platform variant.
sdk_version
string, The API level that this module is built against. The APIs of this API level will be
visible at build time, but use of any APIs newer than min_sdk_version will render the
module unloadable on older devices. In the future it will be possible to weakly-link new
APIs, making the behavior match Java: such modules will load on older devices, but
calling new APIs on devices that do not support them will result in a crash.
This property has the same behavior as sdk_version does for Java modules. For those
familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
does for Java code.
In addition, setting this property causes two variants to be built, one for the platform
and one for apps.
⊕shared
StaticOrSharedProperties
srcs
list of string
tidy_disabled_srcs
list of string
tidy_timeout_srcs
list of string
⊕sanitized
Sanitized
⊕none
⊕address
⊕hwaddress
cflags
list of string
enabled
bool
whole_static_libs
list of string
static_libs
list of string
shared_libs
list of string
system_shared_libs
list of string
apex_available
list of string
installable
bool
shared_libs
list of string, list of modules that should be dynamically linked into this module.
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).
⊕static
StaticOrSharedProperties
srcs
list of string
tidy_disabled_srcs
list of string
tidy_timeout_srcs
list of string
⊕sanitized
Sanitized
⊕none
⊕address
⊕hwaddress
cflags
list of string
enabled
bool
whole_static_libs
list of string
static_libs
list of string
shared_libs
list of string
system_shared_libs
list of string
apex_available
list of string
installable
bool
static_executable
bool, compile executable with -static
static_libs
list of string, list of static library modules that should only provide headers for this module.
static_ndk_lib
bool
stem
string, set the name of the output
stl
string, Select the STL library to use. Possible values are "libc++",
"libc++_static", "libstdc++", or "none". Leave blank to select the
default.
⊕strip
none
bool, none forces all stripping to be disabled.
Device modules default to stripping enabled leaving mini debuginfo.
Host modules default to stripping disabled, but can be enabled by setting any other
strip boolean property.
all
bool, all forces stripping everything, including the mini debug info.
keep_symbols
bool, keep_symbols enables stripping but keeps all symbols.
keep_symbols_list
list of string, keep_symbols_list specifies a list of symbols to keep if keep_symbols is enabled.
If it is unset then all symbols are kept.
keep_symbols_and_debug_frame
bool, keep_symbols_and_debug_frame enables stripping but keeps all symbols and debug frames.
⊕stubs
Generate stubs to make this library accessible to APEXes.
symbol_file
string, Relative path to the symbol map. The symbol map provides the list of
symbols that are exported for stubs variant of this library.
versions
list of string, List versions to generate stubs libs for. The version name "current" is always
implicitly added.
implementation_installable
bool, Whether to not require the implementation of the library to be installed if a
client of the stubs is installed. Defaults to true; set to false if the
implementation is made available by some other means, e.g. in a Microdroid
virtual machine.
suffix
string, append to the name of the output
symlink_preferred_arch
bool, if set, install a symlink to the preferred architecture
symlinks
list of string, install symlinks to the binary. Symlink names will have the suffix and the binary
extension (if any) appended
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).
system_shared_libs
list of string, list of default libraries that will provide headers for this module. If unset, generally
defaults to libc, libm, and libdl. Set to [] to prevent using headers from the defaults.
target
interface
⊕target.android
⊕target.apex
exclude_shared_libs
list of string, list of shared libs that should not be used to build the apex variant of
the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build the apex
variant of the C/C++ module.
⊕target.host
⊕target.platform
cflags
list of string, List of additional cflags that should be used to build the platform
variant of the C/C++ module.
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
required
list of string, List of modules required by the core variant.
exclude_required
list of string, List of modules not required by the core variant.
shared_libs
list of string, list of shared libs that should be use to build the platform variant
of a module that sets sdk_version. This should rarely be necessary,
in most cases the same libraries are available for the SDK and platform
variants.
exclude_shared_libs
list of string, list of shared libs that should not be used to build the platform variant
of the C/C++ module.
⊕target.product
override_export_include_dirs
list of string, list of exported include directories, like
export_include_dirs, that will be applied to
vendor or product variant of this library.
This will overwrite any other declarations.
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
suffix
string, set suffix of the name of the output
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
⊕target.ramdisk
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
ramdisk variant of the C/C++ module.
⊕target.recovery
required
list of string, List of modules required by the recovery variant.
exclude_required
list of string, List of modules not required by the recovery variant.
shared_libs
list of string, list of shared libs that only should be used to build the recovery
variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
recovery variant of the C/C++ module.
srcs
list of string, list of source files that should only be used in the
recovery variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to
build the recovery variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the recovery
variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to
build the recovery variant of the C/C++ module.
⊕target.vendor
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
suffix
string, set suffix of the name of the output
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
override_export_include_dirs
list of string, list of exported include directories, like
export_include_dirs, that will be applied to
vendor or product variant of this library.
This will overwrite any other declarations.
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
⊕target.vendor_ramdisk
exclude_srcs
list of string, list of source files that should not be used to
build the vendor ramdisk variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the vendor ramdisk
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the vendor ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor ramdisk variant of the C/C++ module.
target_required
list of string, names of other modules to install on target if this module is installed
test_config
string, the name of the test configuration (for example "AndroidTest.xml") that should be
installed with the module.
test_config_template
string, the name of the test configuration template (for example "AndroidTestTemplate.xml") that
should be installed with the module.
test_for
list of string, List of APEXes that this module has private access to for testing purpose. The module
can depend on libraries that are not exported by the APEXes and use private symbols
from the exported libraries.
test_mainline_modules
list of string, Add parameterized mainline modules to auto generated test config. The options will be
handled by TradeFed to download and install the specified modules on the device.
⊕test_options
TestOptions
Test options.
run_test_as
string, The UID that you want to run the test as on a device.
test_suite_tag
list of string, A list of free-formed strings without spaces that categorize the test.
min_shipping_api_level
int64, Add ShippingApiLevelModuleController to auto generated test config. If the device properties
for the shipping api level is less than the min_shipping_api_level, skip this module.
vsr_min_shipping_api_level
int64, Add ShippingApiLevelModuleController to auto generated test config. If any of the device
shipping api level and vendor api level properties are less than the
vsr_min_shipping_api_level, skip this module.
As this includes the shipping api level check, it is not allowed to define
min_shipping_api_level at the same time with this property.
min_vndk_version
int64, Add MinApiLevelModuleController with ro.vndk.version property. If ro.vndk.version has an
integer value and the value is less than the min_vndk_version, skip this module.
unit_test
bool, If the test is a hostside (no device required) unittest that shall be run
during presubmit check.
tags
list of string, Tags provide additional metadata to customize test execution by downstream
test runners. The tags have no special meaning to Soong.
test_per_src
bool, Create a separate binary for each source file. Useful when there is
global state that can not be torn down and reset between each test suite.
test_suites
list of string, list of compatibility suites (for example "cts", "vts") that the module should be
installed into.
tidy
bool, whether to run clang-tidy over C-like sources.
tidy_checks
list of string, Extra checks to enable or disable in clang-tidy
tidy_checks_as_errors
list of string, Checks that should be treated as errors.
tidy_disabled_srcs
list of string, list of source files that should not be compiled with clang-tidy.
tidy_flags
list of string, Extra flags to pass to clang-tidy
tidy_timeout_srcs
list of string, list of source files that should not be compiled by clang-tidy when TIDY_TIMEOUT is set.
unexported_symbols_list
string, local file name to pass to the linker as -unexported_symbols_list
unique_host_soname
bool, rename host libraries to prevent overlap with system installed libraries
use_clang_lld
bool, Use clang lld instead of gnu ld.
use_version_lib
bool, make android::build:GetBuildNumber() available containing the build ID.
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_available
bool, whether this module should be allowed to be directly depended by other
modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
If set to true, two variants will be built separately, one like
normal, and the other limited to the set of libraries and headers
that are exposed to /vendor modules.
The vendor variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /vendor modules.
The modules with vndk: {enabled: true} must define 'vendor_available'
to 'true'.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
⊕vendor_public_library
vendorPublicLibraryProperties
If this is a vendor public library, properties to describe the vendor public library stubs.
symbol_file
string, Relative path to the symbol map.
unversioned
bool, Whether the system library uses symbol versions.
override_export_include_dirs
list of string, list of directories relative to the Blueprints file that willbe added to the include path
(using -I) for any module that links against the LLNDK variant of this module, replacing
any that were listed outside the llndk clause.
vendor_ramdisk
bool, Whether this module is installed to vendor ramdisk
vendor_ramdisk_available
bool, Make this module available when building for vendor ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
version_script
string, local file name to pass to the linker as --version-script
vintf_fragments
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/+/master/README.md#visibility for
more details.
⊕vndk
enabled
bool, declared as a VNDK or VNDK-SP module. The vendor variant
will be installed in /system instead of /vendor partition.
`vendor_available` and `product_available` must be explicitly
set to either true or false together with `vndk: {enabled: true}`.
support_system_process
bool, declared as a VNDK-SP module, which is a subset of VNDK.
`vndk: { enabled: true }` must set together.
All these modules are allowed to link to VNDK-SP or LL-NDK
modules only. Other dependency will cause link-type errors.
If `support_system_process` is not set or set to false,
the module is VNDK-core and can link to other VNDK-core,
VNDK-SP or LL-NDK modules only.
private
bool, declared as a VNDK-private module.
This module still creates the vendor and product variants refering
to the `vendor_available: true` and `product_available: true`
properties. However, it is only available to the other VNDK modules
but not to the non-VNDK vendor or product modules.
extends
string, Extending another module
whole_program_vtables
bool, Use -fwhole-program-vtables cflag.
whole_static_libs
list of string, list of modules whose object files should be linked into this module
in their entirety. For static library modules, all of the .o files from the intermediate
directory of the dependency will be linked into this modules .a file. For a shared library,
the dependency's .a file will be linked into this module using -Wl,--whole-archive.
windows_import_lib
string, Optionally provide an import library if this is a Windows PE DLL prebuilt.
This is needed only if this library is linked by other modules in build time.
Only makes sense for the Windows target.
yacc
YaccProperties
libart_cc_defaults
name
,
srcs
,
exclude_srcs
,
defaults
,
host_supported
,
device_supported
,
afdo
,
aidl
,
allow_undefined_symbols
,
apex_available
,
arch
,
asflags
,
auto_gen_config
,
bazel_module
,
bootstrap
,
c_std
,
cflags
,
check_elf_files
,
clang
,
clang_asflags
,
clang_cflags
,
codegen.arm
,
codegen.arm64
,
codegen.riscv64
,
codegen.x86
,
codegen.x86_64
,
compile_multilib
,
conlyflags
,
corpus
,
cpp_std
,
cppflags
,
crt
,
data
,
data_bins
,
data_libs
,
debug
,
debug_ramdisk
,
defaults_visibility
,
device_specific
,
dictionary
,
disable_framework
,
dist
,
dists
,
double_loadable
,
dynamic_list
,
enabled
,
exclude_from_ndk_sysroot
,
exclude_from_recovery_snapshot
,
exclude_from_vendor_snapshot
,
exclude_generated_sources
,
exclude_runtime_libs
,
exclude_shared_libs
,
exclude_static_libs
,
export_generated_headers
,
export_header_lib_headers
,
export_include_dirs
,
export_shared_lib_headers
,
export_static_lib_headers
,
export_system_include_dirs
,
force_symbols_not_weak_list
,
force_symbols_weak_list
,
fuzz_config
,
fuzzing_frameworks
,
generated_headers
,
generated_sources
,
gnu_extensions
,
group_static_libs
,
gtest
,
header_abi_checker
,
header_libs
,
host_ldlibs
,
host_required
,
include_build_directory
,
include_dirs
,
init_rc
,
inject_bssl_hash
,
install_in_root
,
install_in_xbin
,
installable
,
instruction_set
,
isolated
,
ldflags
,
lex
,
licenses
,
linker_script
,
linker_scripts
,
llndk
,
local_include_dirs
,
logtags
,
lto
,
min_sdk_version
,
multilib
,
native_bridge_supported
,
native_coverage
,
no_libcrt
,
no_named_install_directory
,
nocrt
,
objs
,
odm_available
,
openmp
,
overrides
,
owner
,
pack_relocations
,
per_testcase_directory
,
pgo
,
prefix_symbols
,
product_available
,
product_specific
,
product_variables.always_use_prebuilt_sdks
,
product_variables.arc
,
product_variables.binder32bit
,
product_variables.debuggable
,
product_variables.enforce_vintf_manifest
,
product_variables.eng
,
product_variables.flatten_apex
,
product_variables.malloc_not_svelte
,
product_variables.malloc_pattern_fill_contents
,
product_variables.malloc_zero_contents
,
product_variables.native_coverage
,
product_variables.override_rs_driver
,
product_variables.pdk
,
product_variables.platform_sdk_version
,
product_variables.safestack
,
product_variables.treble_linker_namespaces
,
product_variables.uml
,
product_variables.unbundled_build
,
proprietary
,
proto
,
ramdisk
,
ramdisk_available
,
recovery
,
recovery_available
,
relative_install_path
,
release
,
renderscript
,
require_root
,
required
,
rtti
,
runtime_libs
,
sanitize
,
sanitized.address
,
sanitized.hwaddress
,
sanitized.none
,
sdclang
,
sdk_variant_only
,
sdk_version
,
shared
,
shared_libs
,
soc_specific
,
static
,
static_executable
,
static_libs
,
static_ndk_lib
,
stem
,
stl
,
strip
,
stubs
,
suffix
,
symlink_preferred_arch
,
symlinks
,
system_ext_specific
,
system_shared_libs
,
target
,
target.android
,
target.apex
,
target.host
,
target.platform
,
target.product
,
target.ramdisk
,
target.recovery
,
target.vendor
,
target.vendor_ramdisk
,
target_required
,
test_config
,
test_config_template
,
test_for
,
test_mainline_modules
,
test_options
,
test_per_src
,
test_suites
,
tidy
,
tidy_checks
,
tidy_checks_as_errors
,
tidy_disabled_srcs
,
tidy_flags
,
tidy_timeout_srcs
,
unexported_symbols_list
,
unique_host_soname
,
use_clang_lld
,
use_version_lib
,
vendor
,
vendor_available
,
vendor_public_library
,
vendor_ramdisk
,
vendor_ramdisk_available
,
version_script
,
vintf_fragments
,
visibility
,
vndk
,
whole_program_vtables
,
whole_static_libs
,
windows_import_lib
,
yacc
name
string, The name of the module. Must be unique across all modules.
srcs
list of string, list of source files used to compile the C/C++ module. May be .c, .cpp, or .S files.
srcs may reference the outputs of other modules that produce source files like genrule
or filegroup using the syntax ":module".
exclude_srcs
list of string, list of source files that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
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.
afdo
bool, Afdo allows developers self-service enroll for
automatic feedback-directed optimization using profile data.
⊕aidl
include_dirs
list of string, list of directories that will be added to the aidl include paths.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the aidl include paths.
generate_traces
bool, whether to generate traces (for systrace) for this interface
flags
list of string, list of flags that will be passed to the AIDL compiler
allow_undefined_symbols
bool, allow the module to contain undefined symbols. By default,
modules cannot contain undefined symbols that are not satisified by their immediate
dependencies. Set this flag to true to remove --no-undefined from the linker flags.
This flag should only be necessary for compiling low-level libraries like libc.
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".
"com.android.gki.*" matches any APEX module name with the prefix "com.android.gki.".
Default is ["//apex_available:platform"].
arch
interface
asflags
list of string, list of module-specific flags that will be used for .S compiles
auto_gen_config
bool, Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
explicitly.
⊕bazel_module
bazelModuleProperties
In "Bazel mixed build" mode, this represents the Bazel target replacing
this Soong module.
label
string, The label of the Bazel target replacing this Soong module. When run in conversion mode, this
will import the handcrafted build target into the autogenerated file. Note: this may result in
a conflict due to duplicate targets if bp2build_available is also set.
bp2build_available
bool, If true, bp2build will generate the converted Bazel target for this module. Note: this may
cause a conflict due to the duplicate targets if label is also set.
This is a bool pointer to support tristates: true, false, not set.
To opt in a module, set bazel_module: { bp2build_available: true }
To opt out a module, set bazel_module: { bp2build_available: false }
To defer the default setting for the directory, do not set the value.
bootstrap
bool, Allows this module to use non-APEX version of libraries. Useful
for building binaries that are started before APEXes are activated.
c_std
string, C standard version to use. Can be a specific version (such as "gnu11"),
"experimental" (which will use draft versions like C1x when available),
or the empty string (which will use the default).
If this is set, the file extension will be ignored and this will be used as the std version value. Setting this
to "default" will use the build system default version. This cannot be set at the same time as cpp_std.
cflags
list of string, list of clang flags required to correctly interpret the headers.
check_elf_files
bool, Check the prebuilt ELF files (e.g. DT_SONAME, DT_NEEDED, resolution of undefined
symbols, etc), default true.
clang
bool, Deprecated. true is the default, false is invalid.
clang_asflags
list of string, list of module-specific flags that will be used for .S compiles when
compiling with clang
clang_cflags
list of string, list of module-specific flags that will be used for C and C++ compiles when
compiling with clang
⊕codegen.arm
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.arm64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.riscv64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86_64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
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).
conlyflags
list of string, list of module-specific flags that will be used for C compiles
corpus
list of string, Optional list of seed files to be installed to the fuzz target's output
directory.
cpp_std
string, C++ standard version to use. Can be a specific version (such as
"gnu++11"), "experimental" (which will use draft versions like C++1z when
available), or the empty string (which will use the default).
cppflags
list of string, list of module-specific flags that will be used for C++ compiles
crt
bool, Indicates that this module is a CRT object. CRT objects will be split
into a variant per-API level between min_sdk_version and current.
data
list of string, list of files or filegroup modules that provide data that should be installed alongside
the test
data_bins
list of string, list of binary modules that should be installed alongside the test
data_libs
list of string, list of shared library modules that should be installed alongside the test
⊕debug
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
debug_ramdisk
bool, Whether this module is installed to debug ramdisk
defaults_visibility
list of string, Controls the visibility of the defaults module itself.
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`.
dictionary
string, Optional dictionary to be installed to the fuzz target's output directory.
disable_framework
bool, Add RunCommandTargetPreparer to stop framework before the test and start it after the test.
⊕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.
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)
double_loadable
bool, whether this module is capable of being loaded with other instance
(possibly an older version) of the same module in the same process.
Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
can be double loaded in a vendor process if the library is also a
(direct and indirect) dependency of an LLNDK library. Such libraries must be
explicitly marked as `double_loadable: true` by the owner, or the dependency
from the LLNDK lib should be cut if the lib is not designed to be double loaded.
dynamic_list
string, local file name to pass to the linker as --dynamic-list
enabled
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.
exclude_from_ndk_sysroot
bool, Indicates that this module should not be included in the NDK sysroot.
Only applies to CRT objects. Defaults to false.
exclude_from_recovery_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the recovery snapshot.
exclude_from_vendor_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the vendor snapshot.
exclude_generated_sources
list of string, list of generated sources that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with this module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build this module
exclude_static_libs
list of string, list of static libs that should not be used to build this module
export_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path (using -I) for this module and any module that links
against this module. Directories listed in export_include_dirs do not need to be
listed in local_include_dirs.
export_system_include_dirs
list of string, list of directories that will be added to the system include path
using -isystem for this module and any module that links against this module.
force_symbols_not_weak_list
string, local file name to pass to the linker as -force_symbols_not_weak_list
force_symbols_weak_list
string, local file name to pass to the linker as -force_symbols_weak_list
fuzz_config
FuzzConfig, Config for running the target on fuzzing infrastructure.
fuzzing_frameworks
FuzzFrameworks, Define the fuzzing frameworks this fuzz target can be built for. If
empty then the fuzz target will be available to be built for all fuzz
frameworks available
generated_sources
list of string, list of generated sources to compile. These are the names of gensrcs or
genrule modules.
gnu_extensions
bool, if set to false, use -std=c++* instead of -std=gnu++*
group_static_libs
bool, deprecated and ignored because lld makes it unnecessary. See b/189475744.
gtest
bool, if set, build against the gtest library. Defaults to true.
Properties for ABI compatibility checker.
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
host_ldlibs
list of string, -l arguments to pass to linker for host-provided shared libraries
host_required
list of string, names of other modules to install on host if this module is installed
include_build_directory
bool, Add the directory containing the Android.bp file to the list of include
directories. Defaults to true.
include_dirs
list of string, list of directories relative to the root of the source tree that will
be added to the include path using -I.
If possible, don't use this. If adding paths from the current directory use
local_include_dirs, if adding paths from other modules use export_include_dirs in
that module.
init_rc
list of string, init.rc files to be installed if this module is installed
inject_bssl_hash
bool, Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
install_in_root
bool, Install output directly in {partition}/, not in any subdir. This is only intended for use by
init_first_stage.
install_in_xbin
bool, Install output directly in {partition}/xbin
installable
bool
instruction_set
string, the instruction set architecture to use to compile the C/C++
module.
isolated
bool, if set, use the isolated gtest runner. Defaults to true if gtest is also true and the arch is Windows, false
otherwise.
ldflags
list of string, list of module-specific flags that will be used for all link steps
lex
LexProperties
licenses
list of string, Describes the licenses applicable to this module. Must reference license modules.
linker_script
string, if set, the path to a linker script to pass to ld -r when combining multiple object files.
linker_scripts
list of string, local files to pass to the linker as --script
⊕llndk
llndkLibraryProperties
If this is an LLNDK library, properties to describe the LLNDK stubs. Will be copied from
the module pointed to by llndk_stubs if it is set.
symbol_file
string, Relative path to the symbol map.
An example file can be seen here: TODO(danalbert): Make an example.
unversioned
bool, Whether the system library uses symbol versions.
override_export_include_dirs
list of string, list of directories relative to the Blueprints file that willbe added to the include path
(using -I) for any module that links against the LLNDK variant of this module, replacing
any that were listed outside the llndk clause.
private
bool, whether this module can be directly depended upon by libs that are installed
to /vendor and /product.
When set to true, this module can only be depended on by VNDK libraries, not
vendor nor product libraries. This effectively hides this module from
non-system modules. Default value is false.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path using -I
logtags
list of string, *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
file
⊕lto
Lto must violate capitialization style for acronyms so that it can be
referred to in blueprint files as "lto"
never
bool
full
bool
thin
bool
min_sdk_version
string, Minimum OS API level supported by this C or C++ module. This property becomes the value
of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
this property is also used to ensure that the min_sdk_version of the containing module is
not older (i.e. less) than this module's min_sdk_version. When not set, this property
defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
min_sdk_version of the containing APEX. When the module
is not built for an APEX, "apex_inherit" defaults to sdk_version.
multilib
interface
native_bridge_supported
bool, Whether this module is built for non-native architectures (also known as native bridge binary)
native_coverage
bool
no_libcrt
bool, don't link in libclang_rt.builtins-*.a
no_named_install_directory
bool, Disables the creation of a test-specific directory when used with
relative_install_path. Useful if several tests need to be in the same
directory, but test_per_src doesn't work.
nocrt
bool, don't link in crt_begin and crt_end. This flag should only be necessary for
compiling crt or libc.
objs
list of string, names of other cc_object modules to link into this module using partial linking
odm_available
bool, This is the same as the "vendor_available" except that the install path
of the vendor variant is /odm or /vendor/odm.
By replacing "vendor_available: true" with "odm_available: true", the
module will install its vendor variant to the /odm partition or /vendor/odm.
As the modules with "odm_available: true" still create the vendor variants,
they can link to the other vendor modules as the vendor_available modules do.
Also, the vendor modules can link to odm_available modules.
It may not be used for VNDK modules.
openmp
bool, Build and link with OpenMP
overrides
list of string, Names of modules to be overridden. Listed modules can only be other shared libraries
(in Make or Soong).
This does not completely prevent installation of the overridden libraries, but if both
binaries would be installed by default (in PRODUCT_PACKAGES) the other library will be removed
from PRODUCT_PACKAGES.
owner
string, vendor who owns this module
pack_relocations
bool, Generate compact dynamic relocation table, default true.
per_testcase_directory
bool, Install the test into a folder named for the module in all test suites.
⊕pgo
instrumentation
bool
profile_file
string
benchmarks
list of string
enable_profile_use
bool
cflags
list of string, Additional compiler flags to use when building this module
for profiling.
prefix_symbols
string, if set, add an extra objcopy --prefix-symbols= step
product_available
bool, whether this module should be allowed to be directly depended by other
modules with `product_specific: true` or `product_available: true`.
If set to true, an additional product variant will be built separately
that is limited to the set of libraries and headers that are exposed to
/product modules.
The product variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /product modules.
Different from the 'vendor_available' property, the modules with
vndk: {enabled: true} don't have to define 'product_available'. The VNDK
library without 'product_available' may not be depended on by any other
modules that has product variants including the product available VNDKs.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
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.always_use_prebuilt_sdks
⊕product_variables.arc
⊕cflags
⊕exclude_srcs
⊕include_dirs
⊕shared_libs
⊕static_libs
⊕srcs
⊕whole_static_libs
⊕product_variables.binder32bit
⊕product_variables.debuggable
⊕cflags
⊕cppflags
⊕init_rc
⊕required
⊕host_required
⊕target_required
⊕strip.all
⊕strip.keep_symbols
⊕strip.keep_symbols_and_debug_frame
⊕static_libs
⊕whole_static_libs
⊕shared_libs
⊕srcs
⊕exclude_srcs
⊕product_variables.enforce_vintf_manifest
⊕product_variables.eng
⊕cflags
⊕cppflags
⊕lto.never
⊕sanitize.address
⊕product_variables.flatten_apex
⊕product_variables.malloc_not_svelte
⊕cflags
⊕shared_libs
⊕whole_static_libs
⊕exclude_static_libs
⊕srcs
⊕product_variables.malloc_pattern_fill_contents
⊕product_variables.malloc_zero_contents
⊕product_variables.native_coverage
⊕product_variables.override_rs_driver
⊕product_variables.pdk
⊕product_variables.platform_sdk_version
⊕product_variables.safestack
⊕product_variables.treble_linker_namespaces
⊕product_variables.uml
⊕product_variables.unbundled_build
proprietary
bool, whether this is a proprietary vendor module, and should be installed into /vendor
⊕proto
static
bool, Link statically against the protobuf runtime
type
string, Proto generator type. C++: full or lite. Java: micro, nano, stream, or lite.
plugin
string, Proto plugin to use as the generator. Must be a cc_binary_host module.
include_dirs
list of string, list of directories that will be added to the protoc include paths.
local_include_dirs
list of string, list of directories relative to the bp file that will
be added to the protoc include paths.
canonical_path_from_root
bool, whether to identify the proto files from the root of the
source tree (the original method in Android, useful for
android-specific protos), or relative from where they were
specified (useful for external/third party protos).
This defaults to true today, but is expected to default to
false in the future.
ramdisk
bool, Whether this module is installed to ramdisk
ramdisk_available
bool, Make this module available when building for ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
recovery
bool, Whether this module is installed to recovery partition
recovery_available
bool, Make this module available when building for recovery
relative_install_path
string, install to a subdirectory of the default install path for the module
⊕release
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
⊕renderscript
include_dirs
list of string, list of directories that will be added to the llvm-rs-cc include paths
flags
list of string, list of flags that will be passed to llvm-rs-cc
target_api
string, Renderscript API level to target
require_root
bool, Add RootTargetPreparer to auto generated test config. This guarantees the test to run
with root permission.
required
list of string, names of other modules to install if this module is installed
rtti
bool, pass -frtti instead of -fno-rtti
runtime_libs
list of string, list of modules that should be installed with this module. This is similar to 'required'
but '.vendor' suffix will be appended to the module names if the shared libraries have
vendor variants and this module uses VNDK.
⊕sanitize
SanitizeUserProps
never
bool, Prevent use of any sanitizers on this module
address
bool, ASan (Address sanitizer), incompatible with static binaries.
Always runs in a diagnostic mode.
Use of address sanitizer disables cfi sanitizer.
Hwaddress sanitizer takes precedence over this sanitizer.
thread
bool, TSan (Thread sanitizer), incompatible with static binaries and 32 bit architectures.
Always runs in a diagnostic mode.
Use of thread sanitizer disables cfi and scudo sanitizers.
Hwaddress sanitizer takes precedence over this sanitizer.
hwaddress
bool, HWASan (Hardware Address sanitizer).
Use of hwasan sanitizer disables cfi, address, thread, and scudo sanitizers.
all_undefined
bool, Undefined behavior sanitizer
undefined
bool, Subset of undefined behavior sanitizer
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable
fuzzer
bool, Fuzzer, incompatible with static binaries.
safestack
bool, safe-stack sanitizer, incompatible with 32-bit architectures.
cfi
bool, cfi sanitizer, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, incompatible with Darwin.
scudo
bool, scudo sanitizer, incompatible with asan, hwasan, tsan
This should not be used in Android 11+ : https://source.android.com/devices/tech/debug/scudo
deprecated
scs
bool, shadow-call-stack sanitizer, only available on arm64/riscv64.
memtag_heap
bool, Memory-tagging, only available on arm64
if diag.memtag unset or false, enables async memory tagging
memtag_stack
bool, Memory-tagging stack instrumentation, only available on arm64
Adds instrumentation to detect stack buffer overflows and use-after-scope using MTE.
writeonly
bool, A modifier for ASAN and HWASAN for write only instrumentation
⊕diag
Sanitizers to run in the diagnostic mode (as opposed to the release mode).
Replaces abort() on error with a human-readable error message.
Address and Thread sanitizers always run in diagnostic mode.
undefined
bool, Undefined behavior sanitizer, diagnostic mode
cfi
bool, cfi sanitizer, diagnostic mode, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, diagnostic mode, incompatible with Darwin.
memtag_heap
bool, Memory-tagging, only available on arm64
requires sanitizer.memtag: true
if set, enables sync memory tagging
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable in diagnostic mode
no_recover
list of string, List of sanitizers to pass to -fno-sanitize-recover
results in only the first detected error for these sanitizers being reported and program then
exits with a non-zero exit code.
⊕config
Sanitizers to run with flag configuration specified
cfi_assembly_support
bool, Enables CFI support flags for assembly-heavy libraries
recover
list of string, List of sanitizers to pass to -fsanitize-recover
allows execution to continue for these sanitizers to detect multiple errors rather than only
the first one
blocklist
string, value to pass to -fsanitize-ignorelist
⊕sanitized.address
⊕sanitized.hwaddress
⊕sanitized.none
sdclang
bool, compile module with SDLLVM instead of AOSP LLVM
sdk_variant_only
bool, If true, always create an sdk variant and don't create a platform variant.
sdk_version
string, The API level that this module is built against. The APIs of this API level will be
visible at build time, but use of any APIs newer than min_sdk_version will render the
module unloadable on older devices. In the future it will be possible to weakly-link new
APIs, making the behavior match Java: such modules will load on older devices, but
calling new APIs on devices that do not support them will result in a crash.
This property has the same behavior as sdk_version does for Java modules. For those
familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
does for Java code.
In addition, setting this property causes two variants to be built, one for the platform
and one for apps.
⊕shared
StaticOrSharedProperties
srcs
list of string
tidy_disabled_srcs
list of string
tidy_timeout_srcs
list of string
⊕sanitized
Sanitized
⊕none
⊕address
⊕hwaddress
cflags
list of string
enabled
bool
whole_static_libs
list of string
static_libs
list of string
shared_libs
list of string
system_shared_libs
list of string
apex_available
list of string
installable
bool
shared_libs
list of string, list of modules that should be dynamically linked into this module.
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).
⊕static
StaticOrSharedProperties
srcs
list of string
tidy_disabled_srcs
list of string
tidy_timeout_srcs
list of string
⊕sanitized
Sanitized
⊕none
⊕address
⊕hwaddress
cflags
list of string
enabled
bool
whole_static_libs
list of string
static_libs
list of string
shared_libs
list of string
system_shared_libs
list of string
apex_available
list of string
installable
bool
static_executable
bool, compile executable with -static
static_libs
list of string, list of static library modules that should only provide headers for this module.
static_ndk_lib
bool
stem
string, set the name of the output
stl
string, Select the STL library to use. Possible values are "libc++",
"libc++_static", "libstdc++", or "none". Leave blank to select the
default.
⊕strip
none
bool, none forces all stripping to be disabled.
Device modules default to stripping enabled leaving mini debuginfo.
Host modules default to stripping disabled, but can be enabled by setting any other
strip boolean property.
all
bool, all forces stripping everything, including the mini debug info.
keep_symbols
bool, keep_symbols enables stripping but keeps all symbols.
keep_symbols_list
list of string, keep_symbols_list specifies a list of symbols to keep if keep_symbols is enabled.
If it is unset then all symbols are kept.
keep_symbols_and_debug_frame
bool, keep_symbols_and_debug_frame enables stripping but keeps all symbols and debug frames.
⊕stubs
Generate stubs to make this library accessible to APEXes.
symbol_file
string, Relative path to the symbol map. The symbol map provides the list of
symbols that are exported for stubs variant of this library.
versions
list of string, List versions to generate stubs libs for. The version name "current" is always
implicitly added.
implementation_installable
bool, Whether to not require the implementation of the library to be installed if a
client of the stubs is installed. Defaults to true; set to false if the
implementation is made available by some other means, e.g. in a Microdroid
virtual machine.
suffix
string, append to the name of the output
symlink_preferred_arch
bool, if set, install a symlink to the preferred architecture
symlinks
list of string, install symlinks to the binary. Symlink names will have the suffix and the binary
extension (if any) appended
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).
system_shared_libs
list of string, list of default libraries that will provide headers for this module. If unset, generally
defaults to libc, libm, and libdl. Set to [] to prevent using headers from the defaults.
target
interface
⊕target.android
⊕target.apex
exclude_shared_libs
list of string, list of shared libs that should not be used to build the apex variant of
the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build the apex
variant of the C/C++ module.
⊕target.host
⊕target.platform
cflags
list of string, List of additional cflags that should be used to build the platform
variant of the C/C++ module.
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
required
list of string, List of modules required by the core variant.
exclude_required
list of string, List of modules not required by the core variant.
shared_libs
list of string, list of shared libs that should be use to build the platform variant
of a module that sets sdk_version. This should rarely be necessary,
in most cases the same libraries are available for the SDK and platform
variants.
exclude_shared_libs
list of string, list of shared libs that should not be used to build the platform variant
of the C/C++ module.
⊕target.product
override_export_include_dirs
list of string, list of exported include directories, like
export_include_dirs, that will be applied to
vendor or product variant of this library.
This will overwrite any other declarations.
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
suffix
string, set suffix of the name of the output
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
⊕target.ramdisk
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
ramdisk variant of the C/C++ module.
⊕target.recovery
required
list of string, List of modules required by the recovery variant.
exclude_required
list of string, List of modules not required by the recovery variant.
shared_libs
list of string, list of shared libs that only should be used to build the recovery
variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
recovery variant of the C/C++ module.
srcs
list of string, list of source files that should only be used in the
recovery variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to
build the recovery variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the recovery
variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to
build the recovery variant of the C/C++ module.
⊕target.vendor
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
suffix
string, set suffix of the name of the output
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
override_export_include_dirs
list of string, list of exported include directories, like
export_include_dirs, that will be applied to
vendor or product variant of this library.
This will overwrite any other declarations.
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
⊕target.vendor_ramdisk
exclude_srcs
list of string, list of source files that should not be used to
build the vendor ramdisk variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the vendor ramdisk
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the vendor ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor ramdisk variant of the C/C++ module.
target_required
list of string, names of other modules to install on target if this module is installed
test_config
string, the name of the test configuration (for example "AndroidTest.xml") that should be
installed with the module.
test_config_template
string, the name of the test configuration template (for example "AndroidTestTemplate.xml") that
should be installed with the module.
test_for
list of string, List of APEXes that this module has private access to for testing purpose. The module
can depend on libraries that are not exported by the APEXes and use private symbols
from the exported libraries.
test_mainline_modules
list of string, Add parameterized mainline modules to auto generated test config. The options will be
handled by TradeFed to download and install the specified modules on the device.
⊕test_options
TestOptions
Test options.
run_test_as
string, The UID that you want to run the test as on a device.
test_suite_tag
list of string, A list of free-formed strings without spaces that categorize the test.
min_shipping_api_level
int64, Add ShippingApiLevelModuleController to auto generated test config. If the device properties
for the shipping api level is less than the min_shipping_api_level, skip this module.
vsr_min_shipping_api_level
int64, Add ShippingApiLevelModuleController to auto generated test config. If any of the device
shipping api level and vendor api level properties are less than the
vsr_min_shipping_api_level, skip this module.
As this includes the shipping api level check, it is not allowed to define
min_shipping_api_level at the same time with this property.
min_vndk_version
int64, Add MinApiLevelModuleController with ro.vndk.version property. If ro.vndk.version has an
integer value and the value is less than the min_vndk_version, skip this module.
unit_test
bool, If the test is a hostside (no device required) unittest that shall be run
during presubmit check.
tags
list of string, Tags provide additional metadata to customize test execution by downstream
test runners. The tags have no special meaning to Soong.
test_per_src
bool, Create a separate binary for each source file. Useful when there is
global state that can not be torn down and reset between each test suite.
test_suites
list of string, list of compatibility suites (for example "cts", "vts") that the module should be
installed into.
tidy
bool, whether to run clang-tidy over C-like sources.
tidy_checks
list of string, Extra checks to enable or disable in clang-tidy
tidy_checks_as_errors
list of string, Checks that should be treated as errors.
tidy_disabled_srcs
list of string, list of source files that should not be compiled with clang-tidy.
tidy_flags
list of string, Extra flags to pass to clang-tidy
tidy_timeout_srcs
list of string, list of source files that should not be compiled by clang-tidy when TIDY_TIMEOUT is set.
unexported_symbols_list
string, local file name to pass to the linker as -unexported_symbols_list
unique_host_soname
bool, rename host libraries to prevent overlap with system installed libraries
use_clang_lld
bool, Use clang lld instead of gnu ld.
use_version_lib
bool, make android::build:GetBuildNumber() available containing the build ID.
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_available
bool, whether this module should be allowed to be directly depended by other
modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
If set to true, two variants will be built separately, one like
normal, and the other limited to the set of libraries and headers
that are exposed to /vendor modules.
The vendor variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /vendor modules.
The modules with vndk: {enabled: true} must define 'vendor_available'
to 'true'.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
⊕vendor_public_library
vendorPublicLibraryProperties
If this is a vendor public library, properties to describe the vendor public library stubs.
symbol_file
string, Relative path to the symbol map.
unversioned
bool, Whether the system library uses symbol versions.
override_export_include_dirs
list of string, list of directories relative to the Blueprints file that willbe added to the include path
(using -I) for any module that links against the LLNDK variant of this module, replacing
any that were listed outside the llndk clause.
vendor_ramdisk
bool, Whether this module is installed to vendor ramdisk
vendor_ramdisk_available
bool, Make this module available when building for vendor ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
version_script
string, local file name to pass to the linker as --version-script
vintf_fragments
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/+/master/README.md#visibility for
more details.
⊕vndk
enabled
bool, declared as a VNDK or VNDK-SP module. The vendor variant
will be installed in /system instead of /vendor partition.
`vendor_available` and `product_available` must be explicitly
set to either true or false together with `vndk: {enabled: true}`.
support_system_process
bool, declared as a VNDK-SP module, which is a subset of VNDK.
`vndk: { enabled: true }` must set together.
All these modules are allowed to link to VNDK-SP or LL-NDK
modules only. Other dependency will cause link-type errors.
If `support_system_process` is not set or set to false,
the module is VNDK-core and can link to other VNDK-core,
VNDK-SP or LL-NDK modules only.
private
bool, declared as a VNDK-private module.
This module still creates the vendor and product variants refering
to the `vendor_available: true` and `product_available: true`
properties. However, it is only available to the other VNDK modules
but not to the non-VNDK vendor or product modules.
extends
string, Extending another module
whole_program_vtables
bool, Use -fwhole-program-vtables cflag.
whole_static_libs
list of string, list of modules whose object files should be linked into this module
in their entirety. For static library modules, all of the .o files from the intermediate
directory of the dependency will be linked into this modules .a file. For a shared library,
the dependency's .a file will be linked into this module using -Wl,--whole-archive.
windows_import_lib
string, Optionally provide an import library if this is a Windows PE DLL prebuilt.
This is needed only if this library is linked by other modules in build time.
Only makes sense for the Windows target.
yacc
YaccProperties
libart_static_cc_defaults
name
,
srcs
,
exclude_srcs
,
defaults
,
host_supported
,
device_supported
,
afdo
,
aidl
,
allow_undefined_symbols
,
apex_available
,
arch
,
asflags
,
auto_gen_config
,
bazel_module
,
bootstrap
,
c_std
,
cflags
,
check_elf_files
,
clang
,
clang_asflags
,
clang_cflags
,
codegen.arm
,
codegen.arm64
,
codegen.riscv64
,
codegen.x86
,
codegen.x86_64
,
compile_multilib
,
conlyflags
,
corpus
,
cpp_std
,
cppflags
,
crt
,
data
,
data_bins
,
data_libs
,
debug
,
debug_ramdisk
,
defaults_visibility
,
device_specific
,
dictionary
,
disable_framework
,
dist
,
dists
,
double_loadable
,
dynamic_list
,
enabled
,
exclude_from_ndk_sysroot
,
exclude_from_recovery_snapshot
,
exclude_from_vendor_snapshot
,
exclude_generated_sources
,
exclude_runtime_libs
,
exclude_shared_libs
,
exclude_static_libs
,
export_generated_headers
,
export_header_lib_headers
,
export_include_dirs
,
export_shared_lib_headers
,
export_static_lib_headers
,
export_system_include_dirs
,
force_symbols_not_weak_list
,
force_symbols_weak_list
,
fuzz_config
,
fuzzing_frameworks
,
generated_headers
,
generated_sources
,
gnu_extensions
,
group_static_libs
,
gtest
,
header_abi_checker
,
header_libs
,
host_ldlibs
,
host_required
,
include_build_directory
,
include_dirs
,
init_rc
,
inject_bssl_hash
,
install_in_root
,
install_in_xbin
,
installable
,
instruction_set
,
isolated
,
ldflags
,
lex
,
licenses
,
linker_script
,
linker_scripts
,
llndk
,
local_include_dirs
,
logtags
,
lto
,
min_sdk_version
,
multilib
,
native_bridge_supported
,
native_coverage
,
no_libcrt
,
no_named_install_directory
,
nocrt
,
objs
,
odm_available
,
openmp
,
overrides
,
owner
,
pack_relocations
,
per_testcase_directory
,
pgo
,
prefix_symbols
,
product_available
,
product_specific
,
product_variables.always_use_prebuilt_sdks
,
product_variables.arc
,
product_variables.binder32bit
,
product_variables.debuggable
,
product_variables.enforce_vintf_manifest
,
product_variables.eng
,
product_variables.flatten_apex
,
product_variables.malloc_not_svelte
,
product_variables.malloc_pattern_fill_contents
,
product_variables.malloc_zero_contents
,
product_variables.native_coverage
,
product_variables.override_rs_driver
,
product_variables.pdk
,
product_variables.platform_sdk_version
,
product_variables.safestack
,
product_variables.treble_linker_namespaces
,
product_variables.uml
,
product_variables.unbundled_build
,
proprietary
,
proto
,
ramdisk
,
ramdisk_available
,
recovery
,
recovery_available
,
relative_install_path
,
release
,
renderscript
,
require_root
,
required
,
rtti
,
runtime_libs
,
sanitize
,
sanitized.address
,
sanitized.hwaddress
,
sanitized.none
,
sdclang
,
sdk_variant_only
,
sdk_version
,
shared
,
shared_libs
,
soc_specific
,
static
,
static_executable
,
static_libs
,
static_ndk_lib
,
stem
,
stl
,
strip
,
stubs
,
suffix
,
symlink_preferred_arch
,
symlinks
,
system_ext_specific
,
system_shared_libs
,
target
,
target.android
,
target.apex
,
target.host
,
target.platform
,
target.product
,
target.ramdisk
,
target.recovery
,
target.vendor
,
target.vendor_ramdisk
,
target_required
,
test_config
,
test_config_template
,
test_for
,
test_mainline_modules
,
test_options
,
test_per_src
,
test_suites
,
tidy
,
tidy_checks
,
tidy_checks_as_errors
,
tidy_disabled_srcs
,
tidy_flags
,
tidy_timeout_srcs
,
unexported_symbols_list
,
unique_host_soname
,
use_clang_lld
,
use_version_lib
,
vendor
,
vendor_available
,
vendor_public_library
,
vendor_ramdisk
,
vendor_ramdisk_available
,
version_script
,
vintf_fragments
,
visibility
,
vndk
,
whole_program_vtables
,
whole_static_libs
,
windows_import_lib
,
yacc
name
string, The name of the module. Must be unique across all modules.
srcs
list of string, list of source files used to compile the C/C++ module. May be .c, .cpp, or .S files.
srcs may reference the outputs of other modules that produce source files like genrule
or filegroup using the syntax ":module".
exclude_srcs
list of string, list of source files that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
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.
afdo
bool, Afdo allows developers self-service enroll for
automatic feedback-directed optimization using profile data.
⊕aidl
include_dirs
list of string, list of directories that will be added to the aidl include paths.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the aidl include paths.
generate_traces
bool, whether to generate traces (for systrace) for this interface
flags
list of string, list of flags that will be passed to the AIDL compiler
allow_undefined_symbols
bool, allow the module to contain undefined symbols. By default,
modules cannot contain undefined symbols that are not satisified by their immediate
dependencies. Set this flag to true to remove --no-undefined from the linker flags.
This flag should only be necessary for compiling low-level libraries like libc.
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".
"com.android.gki.*" matches any APEX module name with the prefix "com.android.gki.".
Default is ["//apex_available:platform"].
arch
interface
asflags
list of string, list of module-specific flags that will be used for .S compiles
auto_gen_config
bool, Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
explicitly.
⊕bazel_module
bazelModuleProperties
In "Bazel mixed build" mode, this represents the Bazel target replacing
this Soong module.
label
string, The label of the Bazel target replacing this Soong module. When run in conversion mode, this
will import the handcrafted build target into the autogenerated file. Note: this may result in
a conflict due to duplicate targets if bp2build_available is also set.
bp2build_available
bool, If true, bp2build will generate the converted Bazel target for this module. Note: this may
cause a conflict due to the duplicate targets if label is also set.
This is a bool pointer to support tristates: true, false, not set.
To opt in a module, set bazel_module: { bp2build_available: true }
To opt out a module, set bazel_module: { bp2build_available: false }
To defer the default setting for the directory, do not set the value.
bootstrap
bool, Allows this module to use non-APEX version of libraries. Useful
for building binaries that are started before APEXes are activated.
c_std
string, C standard version to use. Can be a specific version (such as "gnu11"),
"experimental" (which will use draft versions like C1x when available),
or the empty string (which will use the default).
If this is set, the file extension will be ignored and this will be used as the std version value. Setting this
to "default" will use the build system default version. This cannot be set at the same time as cpp_std.
cflags
list of string, list of clang flags required to correctly interpret the headers.
check_elf_files
bool, Check the prebuilt ELF files (e.g. DT_SONAME, DT_NEEDED, resolution of undefined
symbols, etc), default true.
clang
bool, Deprecated. true is the default, false is invalid.
clang_asflags
list of string, list of module-specific flags that will be used for .S compiles when
compiling with clang
clang_cflags
list of string, list of module-specific flags that will be used for C and C++ compiles when
compiling with clang
⊕codegen.arm
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.arm64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.riscv64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
⊕codegen.x86_64
codegenArchProperties
srcs
list of string
cflags
list of string
cppflags
list of string
static_libs
list of string
⊕static
whole_static_libs
list of string
⊕shared
shared_libs
list of string
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).
conlyflags
list of string, list of module-specific flags that will be used for C compiles
corpus
list of string, Optional list of seed files to be installed to the fuzz target's output
directory.
cpp_std
string, C++ standard version to use. Can be a specific version (such as
"gnu++11"), "experimental" (which will use draft versions like C++1z when
available), or the empty string (which will use the default).
cppflags
list of string, list of module-specific flags that will be used for C++ compiles
crt
bool, Indicates that this module is a CRT object. CRT objects will be split
into a variant per-API level between min_sdk_version and current.
data
list of string, list of files or filegroup modules that provide data that should be installed alongside
the test
data_bins
list of string, list of binary modules that should be installed alongside the test
data_libs
list of string, list of shared library modules that should be installed alongside the test
⊕debug
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
debug_ramdisk
bool, Whether this module is installed to debug ramdisk
defaults_visibility
list of string, Controls the visibility of the defaults module itself.
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`.
dictionary
string, Optional dictionary to be installed to the fuzz target's output directory.
disable_framework
bool, Add RunCommandTargetPreparer to stop framework before the test and start it after the test.
⊕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.
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)
double_loadable
bool, whether this module is capable of being loaded with other instance
(possibly an older version) of the same module in the same process.
Currently, a shared library that is a member of VNDK (vndk: {enabled: true})
can be double loaded in a vendor process if the library is also a
(direct and indirect) dependency of an LLNDK library. Such libraries must be
explicitly marked as `double_loadable: true` by the owner, or the dependency
from the LLNDK lib should be cut if the lib is not designed to be double loaded.
dynamic_list
string, local file name to pass to the linker as --dynamic-list
enabled
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.
exclude_from_ndk_sysroot
bool, Indicates that this module should not be included in the NDK sysroot.
Only applies to CRT objects. Defaults to false.
exclude_from_recovery_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the recovery snapshot.
exclude_from_vendor_snapshot
bool, Normally Soong uses the directory structure to decide which modules
should be included (framework) or excluded (non-framework) from the
different snapshots (vendor, recovery, etc.), but this property
allows a partner to exclude a module normally thought of as a
framework module from the vendor snapshot.
exclude_generated_sources
list of string, list of generated sources that should not be used to build the C/C++ module.
This is most useful in the arch/multilib variants to remove non-common files
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with this module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build this module
exclude_static_libs
list of string, list of static libs that should not be used to build this module
export_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path (using -I) for this module and any module that links
against this module. Directories listed in export_include_dirs do not need to be
listed in local_include_dirs.
export_system_include_dirs
list of string, list of directories that will be added to the system include path
using -isystem for this module and any module that links against this module.
force_symbols_not_weak_list
string, local file name to pass to the linker as -force_symbols_not_weak_list
force_symbols_weak_list
string, local file name to pass to the linker as -force_symbols_weak_list
fuzz_config
FuzzConfig, Config for running the target on fuzzing infrastructure.
fuzzing_frameworks
FuzzFrameworks, Define the fuzzing frameworks this fuzz target can be built for. If
empty then the fuzz target will be available to be built for all fuzz
frameworks available
generated_sources
list of string, list of generated sources to compile. These are the names of gensrcs or
genrule modules.
gnu_extensions
bool, if set to false, use -std=c++* instead of -std=gnu++*
group_static_libs
bool, deprecated and ignored because lld makes it unnecessary. See b/189475744.
gtest
bool, if set, build against the gtest library. Defaults to true.
Properties for ABI compatibility checker.
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
host_ldlibs
list of string, -l arguments to pass to linker for host-provided shared libraries
host_required
list of string, names of other modules to install on host if this module is installed
include_build_directory
bool, Add the directory containing the Android.bp file to the list of include
directories. Defaults to true.
include_dirs
list of string, list of directories relative to the root of the source tree that will
be added to the include path using -I.
If possible, don't use this. If adding paths from the current directory use
local_include_dirs, if adding paths from other modules use export_include_dirs in
that module.
init_rc
list of string, init.rc files to be installed if this module is installed
inject_bssl_hash
bool, Inject boringssl hash into the shared library. This is only intended for use by external/boringssl.
install_in_root
bool, Install output directly in {partition}/, not in any subdir. This is only intended for use by
init_first_stage.
install_in_xbin
bool, Install output directly in {partition}/xbin
installable
bool
instruction_set
string, the instruction set architecture to use to compile the C/C++
module.
isolated
bool, if set, use the isolated gtest runner. Defaults to true if gtest is also true and the arch is Windows, false
otherwise.
ldflags
list of string, list of module-specific flags that will be used for all link steps
lex
LexProperties
licenses
list of string, Describes the licenses applicable to this module. Must reference license modules.
linker_script
string, if set, the path to a linker script to pass to ld -r when combining multiple object files.
linker_scripts
list of string, local files to pass to the linker as --script
⊕llndk
llndkLibraryProperties
If this is an LLNDK library, properties to describe the LLNDK stubs. Will be copied from
the module pointed to by llndk_stubs if it is set.
symbol_file
string, Relative path to the symbol map.
An example file can be seen here: TODO(danalbert): Make an example.
unversioned
bool, Whether the system library uses symbol versions.
override_export_include_dirs
list of string, list of directories relative to the Blueprints file that willbe added to the include path
(using -I) for any module that links against the LLNDK variant of this module, replacing
any that were listed outside the llndk clause.
private
bool, whether this module can be directly depended upon by libs that are installed
to /vendor and /product.
When set to true, this module can only be depended on by VNDK libraries, not
vendor nor product libraries. This effectively hides this module from
non-system modules. Default value is false.
local_include_dirs
list of string, list of directories relative to the Blueprints file that will
be added to the include path using -I
logtags
list of string, *.logtags files, to combine together in order to generate the /system/etc/event-log-tags
file
⊕lto
Lto must violate capitialization style for acronyms so that it can be
referred to in blueprint files as "lto"
never
bool
full
bool
thin
bool
min_sdk_version
string, Minimum OS API level supported by this C or C++ module. This property becomes the value
of the __ANDROID_API__ macro. When the C or C++ module is included in an APEX or an APK,
this property is also used to ensure that the min_sdk_version of the containing module is
not older (i.e. less) than this module's min_sdk_version. When not set, this property
defaults to the value of sdk_version. When this is set to "apex_inherit", this tracks
min_sdk_version of the containing APEX. When the module
is not built for an APEX, "apex_inherit" defaults to sdk_version.
multilib
interface
native_bridge_supported
bool, Whether this module is built for non-native architectures (also known as native bridge binary)
native_coverage
bool
no_libcrt
bool, don't link in libclang_rt.builtins-*.a
no_named_install_directory
bool, Disables the creation of a test-specific directory when used with
relative_install_path. Useful if several tests need to be in the same
directory, but test_per_src doesn't work.
nocrt
bool, don't link in crt_begin and crt_end. This flag should only be necessary for
compiling crt or libc.
objs
list of string, names of other cc_object modules to link into this module using partial linking
odm_available
bool, This is the same as the "vendor_available" except that the install path
of the vendor variant is /odm or /vendor/odm.
By replacing "vendor_available: true" with "odm_available: true", the
module will install its vendor variant to the /odm partition or /vendor/odm.
As the modules with "odm_available: true" still create the vendor variants,
they can link to the other vendor modules as the vendor_available modules do.
Also, the vendor modules can link to odm_available modules.
It may not be used for VNDK modules.
openmp
bool, Build and link with OpenMP
overrides
list of string, Names of modules to be overridden. Listed modules can only be other shared libraries
(in Make or Soong).
This does not completely prevent installation of the overridden libraries, but if both
binaries would be installed by default (in PRODUCT_PACKAGES) the other library will be removed
from PRODUCT_PACKAGES.
owner
string, vendor who owns this module
pack_relocations
bool, Generate compact dynamic relocation table, default true.
per_testcase_directory
bool, Install the test into a folder named for the module in all test suites.
⊕pgo
instrumentation
bool
profile_file
string
benchmarks
list of string
enable_profile_use
bool
cflags
list of string, Additional compiler flags to use when building this module
for profiling.
prefix_symbols
string, if set, add an extra objcopy --prefix-symbols= step
product_available
bool, whether this module should be allowed to be directly depended by other
modules with `product_specific: true` or `product_available: true`.
If set to true, an additional product variant will be built separately
that is limited to the set of libraries and headers that are exposed to
/product modules.
The product variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /product modules.
Different from the 'vendor_available' property, the modules with
vndk: {enabled: true} don't have to define 'product_available'. The VNDK
library without 'product_available' may not be depended on by any other
modules that has product variants including the product available VNDKs.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
and PRODUCT_PRODUCT_VNDK_VERSION isn't set.
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.always_use_prebuilt_sdks
⊕product_variables.arc
⊕cflags
⊕exclude_srcs
⊕include_dirs
⊕shared_libs
⊕static_libs
⊕srcs
⊕whole_static_libs
⊕product_variables.binder32bit
⊕product_variables.debuggable
⊕cflags
⊕cppflags
⊕init_rc
⊕required
⊕host_required
⊕target_required
⊕strip.all
⊕strip.keep_symbols
⊕strip.keep_symbols_and_debug_frame
⊕static_libs
⊕whole_static_libs
⊕shared_libs
⊕srcs
⊕exclude_srcs
⊕product_variables.enforce_vintf_manifest
⊕product_variables.eng
⊕cflags
⊕cppflags
⊕lto.never
⊕sanitize.address
⊕product_variables.flatten_apex
⊕product_variables.malloc_not_svelte
⊕cflags
⊕shared_libs
⊕whole_static_libs
⊕exclude_static_libs
⊕srcs
⊕product_variables.malloc_pattern_fill_contents
⊕product_variables.malloc_zero_contents
⊕product_variables.native_coverage
⊕product_variables.override_rs_driver
⊕product_variables.pdk
⊕product_variables.platform_sdk_version
⊕product_variables.safestack
⊕product_variables.treble_linker_namespaces
⊕product_variables.uml
⊕product_variables.unbundled_build
proprietary
bool, whether this is a proprietary vendor module, and should be installed into /vendor
⊕proto
static
bool, Link statically against the protobuf runtime
type
string, Proto generator type. C++: full or lite. Java: micro, nano, stream, or lite.
plugin
string, Proto plugin to use as the generator. Must be a cc_binary_host module.
include_dirs
list of string, list of directories that will be added to the protoc include paths.
local_include_dirs
list of string, list of directories relative to the bp file that will
be added to the protoc include paths.
canonical_path_from_root
bool, whether to identify the proto files from the root of the
source tree (the original method in Android, useful for
android-specific protos), or relative from where they were
specified (useful for external/third party protos).
This defaults to true today, but is expected to default to
false in the future.
ramdisk
bool, Whether this module is installed to ramdisk
ramdisk_available
bool, Make this module available when building for ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
recovery
bool, Whether this module is installed to recovery partition
recovery_available
bool, Make this module available when building for recovery
relative_install_path
string, install to a subdirectory of the default install path for the module
⊕release
cflags
list of string, list of module-specific flags that will be used for C and C++ compiles in debug or
release builds
⊕renderscript
include_dirs
list of string, list of directories that will be added to the llvm-rs-cc include paths
flags
list of string, list of flags that will be passed to llvm-rs-cc
target_api
string, Renderscript API level to target
require_root
bool, Add RootTargetPreparer to auto generated test config. This guarantees the test to run
with root permission.
required
list of string, names of other modules to install if this module is installed
rtti
bool, pass -frtti instead of -fno-rtti
runtime_libs
list of string, list of modules that should be installed with this module. This is similar to 'required'
but '.vendor' suffix will be appended to the module names if the shared libraries have
vendor variants and this module uses VNDK.
⊕sanitize
SanitizeUserProps
never
bool, Prevent use of any sanitizers on this module
address
bool, ASan (Address sanitizer), incompatible with static binaries.
Always runs in a diagnostic mode.
Use of address sanitizer disables cfi sanitizer.
Hwaddress sanitizer takes precedence over this sanitizer.
thread
bool, TSan (Thread sanitizer), incompatible with static binaries and 32 bit architectures.
Always runs in a diagnostic mode.
Use of thread sanitizer disables cfi and scudo sanitizers.
Hwaddress sanitizer takes precedence over this sanitizer.
hwaddress
bool, HWASan (Hardware Address sanitizer).
Use of hwasan sanitizer disables cfi, address, thread, and scudo sanitizers.
all_undefined
bool, Undefined behavior sanitizer
undefined
bool, Subset of undefined behavior sanitizer
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable
fuzzer
bool, Fuzzer, incompatible with static binaries.
safestack
bool, safe-stack sanitizer, incompatible with 32-bit architectures.
cfi
bool, cfi sanitizer, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, incompatible with Darwin.
scudo
bool, scudo sanitizer, incompatible with asan, hwasan, tsan
This should not be used in Android 11+ : https://source.android.com/devices/tech/debug/scudo
deprecated
scs
bool, shadow-call-stack sanitizer, only available on arm64/riscv64.
memtag_heap
bool, Memory-tagging, only available on arm64
if diag.memtag unset or false, enables async memory tagging
memtag_stack
bool, Memory-tagging stack instrumentation, only available on arm64
Adds instrumentation to detect stack buffer overflows and use-after-scope using MTE.
writeonly
bool, A modifier for ASAN and HWASAN for write only instrumentation
⊕diag
Sanitizers to run in the diagnostic mode (as opposed to the release mode).
Replaces abort() on error with a human-readable error message.
Address and Thread sanitizers always run in diagnostic mode.
undefined
bool, Undefined behavior sanitizer, diagnostic mode
cfi
bool, cfi sanitizer, diagnostic mode, incompatible with asan, hwasan, fuzzer, or Darwin
integer_overflow
bool, signed/unsigned integer overflow sanitizer, diagnostic mode, incompatible with Darwin.
memtag_heap
bool, Memory-tagging, only available on arm64
requires sanitizer.memtag: true
if set, enables sync memory tagging
misc_undefined
list of string, List of specific undefined behavior sanitizers to enable in diagnostic mode
no_recover
list of string, List of sanitizers to pass to -fno-sanitize-recover
results in only the first detected error for these sanitizers being reported and program then
exits with a non-zero exit code.
⊕config
Sanitizers to run with flag configuration specified
cfi_assembly_support
bool, Enables CFI support flags for assembly-heavy libraries
recover
list of string, List of sanitizers to pass to -fsanitize-recover
allows execution to continue for these sanitizers to detect multiple errors rather than only
the first one
blocklist
string, value to pass to -fsanitize-ignorelist
⊕sanitized.address
⊕sanitized.hwaddress
⊕sanitized.none
sdclang
bool, compile module with SDLLVM instead of AOSP LLVM
sdk_variant_only
bool, If true, always create an sdk variant and don't create a platform variant.
sdk_version
string, The API level that this module is built against. The APIs of this API level will be
visible at build time, but use of any APIs newer than min_sdk_version will render the
module unloadable on older devices. In the future it will be possible to weakly-link new
APIs, making the behavior match Java: such modules will load on older devices, but
calling new APIs on devices that do not support them will result in a crash.
This property has the same behavior as sdk_version does for Java modules. For those
familiar with Android Gradle, the property behaves similarly to how compileSdkVersion
does for Java code.
In addition, setting this property causes two variants to be built, one for the platform
and one for apps.
⊕shared
StaticOrSharedProperties
srcs
list of string
tidy_disabled_srcs
list of string
tidy_timeout_srcs
list of string
⊕sanitized
Sanitized
⊕none
⊕address
⊕hwaddress
cflags
list of string
enabled
bool
whole_static_libs
list of string
static_libs
list of string
shared_libs
list of string
system_shared_libs
list of string
apex_available
list of string
installable
bool
shared_libs
list of string, list of modules that should be dynamically linked into this module.
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).
⊕static
StaticOrSharedProperties
srcs
list of string
tidy_disabled_srcs
list of string
tidy_timeout_srcs
list of string
⊕sanitized
Sanitized
⊕none
⊕address
⊕hwaddress
cflags
list of string
enabled
bool
whole_static_libs
list of string
static_libs
list of string
shared_libs
list of string
system_shared_libs
list of string
apex_available
list of string
installable
bool
static_executable
bool, compile executable with -static
static_libs
list of string, list of static library modules that should only provide headers for this module.
static_ndk_lib
bool
stem
string, set the name of the output
stl
string, Select the STL library to use. Possible values are "libc++",
"libc++_static", "libstdc++", or "none". Leave blank to select the
default.
⊕strip
none
bool, none forces all stripping to be disabled.
Device modules default to stripping enabled leaving mini debuginfo.
Host modules default to stripping disabled, but can be enabled by setting any other
strip boolean property.
all
bool, all forces stripping everything, including the mini debug info.
keep_symbols
bool, keep_symbols enables stripping but keeps all symbols.
keep_symbols_list
list of string, keep_symbols_list specifies a list of symbols to keep if keep_symbols is enabled.
If it is unset then all symbols are kept.
keep_symbols_and_debug_frame
bool, keep_symbols_and_debug_frame enables stripping but keeps all symbols and debug frames.
⊕stubs
Generate stubs to make this library accessible to APEXes.
symbol_file
string, Relative path to the symbol map. The symbol map provides the list of
symbols that are exported for stubs variant of this library.
versions
list of string, List versions to generate stubs libs for. The version name "current" is always
implicitly added.
implementation_installable
bool, Whether to not require the implementation of the library to be installed if a
client of the stubs is installed. Defaults to true; set to false if the
implementation is made available by some other means, e.g. in a Microdroid
virtual machine.
suffix
string, append to the name of the output
symlink_preferred_arch
bool, if set, install a symlink to the preferred architecture
symlinks
list of string, install symlinks to the binary. Symlink names will have the suffix and the binary
extension (if any) appended
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).
system_shared_libs
list of string, list of default libraries that will provide headers for this module. If unset, generally
defaults to libc, libm, and libdl. Set to [] to prevent using headers from the defaults.
target
interface
⊕target.android
⊕target.apex
exclude_shared_libs
list of string, list of shared libs that should not be used to build the apex variant of
the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build the apex
variant of the C/C++ module.
⊕target.host
⊕target.platform
cflags
list of string, List of additional cflags that should be used to build the platform
variant of the C/C++ module.
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
required
list of string, List of modules required by the core variant.
exclude_required
list of string, List of modules not required by the core variant.
shared_libs
list of string, list of shared libs that should be use to build the platform variant
of a module that sets sdk_version. This should rarely be necessary,
in most cases the same libraries are available for the SDK and platform
variants.
exclude_shared_libs
list of string, list of shared libs that should not be used to build the platform variant
of the C/C++ module.
⊕target.product
override_export_include_dirs
list of string, list of exported include directories, like
export_include_dirs, that will be applied to
vendor or product variant of this library.
This will overwrite any other declarations.
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
suffix
string, set suffix of the name of the output
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
⊕target.ramdisk
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
ramdisk variant of the C/C++ module.
⊕target.recovery
required
list of string, List of modules required by the recovery variant.
exclude_required
list of string, List of modules not required by the recovery variant.
shared_libs
list of string, list of shared libs that only should be used to build the recovery
variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build the recovery
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
recovery variant of the C/C++ module.
srcs
list of string, list of source files that should only be used in the
recovery variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to
build the recovery variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the recovery
variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to
build the recovery variant of the C/C++ module.
⊕target.vendor
shared_libs
list of string, list of shared libs that only should be used to build vendor or
product variant of the C/C++ module.
static_libs
list of string, list of static libs that only should be used to build vendor or
product variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build vendor or
product variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor or product variant of the C/C++ module.
version_script
string, version script for vendor or product variant
suffix
string, set suffix of the name of the output
enabled
bool, Enable ABI checks (even if this is not an LLNDK/VNDK lib)
symbol_file
string, Path to a symbol file that specifies the symbols to be included in the generated
ABI dump file
exclude_symbol_versions
list of string, Symbol versions that should be ignored from the symbol file
exclude_symbol_tags
list of string, Symbol tags that should be ignored from the symbol file
check_all_apis
bool, Run checks on all APIs (in addition to the ones referred by
one of exported ELF symbols.)
diff_flags
list of string, Extra flags passed to header-abi-diff
ref_dump_dirs
list of string, Opt-in reference dump directories
override_export_include_dirs
list of string, list of exported include directories, like
export_include_dirs, that will be applied to
vendor or product variant of this library.
This will overwrite any other declarations.
srcs
list of string, list of source files that should only be used in vendor or
product variant of the C/C++ module.
exclude_srcs
list of string, list of source files that should not be used to build vendor
or product variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build vendor
or product variant of the C/C++ module.
exclude_generated_sources
list of string, list of generated sources that should not be used to build
vendor or product variant of the C/C++ module.
⊕target.vendor_ramdisk
exclude_srcs
list of string, list of source files that should not be used to
build the vendor ramdisk variant of the C/C++ module.
cflags
list of string, List of additional cflags that should be used to build the vendor ramdisk
variant of the C/C++ module.
exclude_shared_libs
list of string, list of shared libs that should not be used to build
the recovery variant of the C/C++ module.
exclude_static_libs
list of string, list of static libs that should not be used to build
the vendor ramdisk variant of the C/C++ module.
exclude_runtime_libs
list of string, list of runtime libs that should not be installed along with the
vendor ramdisk variant of the C/C++ module.
target_required
list of string, names of other modules to install on target if this module is installed
test_config
string, the name of the test configuration (for example "AndroidTest.xml") that should be
installed with the module.
test_config_template
string, the name of the test configuration template (for example "AndroidTestTemplate.xml") that
should be installed with the module.
test_for
list of string, List of APEXes that this module has private access to for testing purpose. The module
can depend on libraries that are not exported by the APEXes and use private symbols
from the exported libraries.
test_mainline_modules
list of string, Add parameterized mainline modules to auto generated test config. The options will be
handled by TradeFed to download and install the specified modules on the device.
⊕test_options
TestOptions
Test options.
run_test_as
string, The UID that you want to run the test as on a device.
test_suite_tag
list of string, A list of free-formed strings without spaces that categorize the test.
min_shipping_api_level
int64, Add ShippingApiLevelModuleController to auto generated test config. If the device properties
for the shipping api level is less than the min_shipping_api_level, skip this module.
vsr_min_shipping_api_level
int64, Add ShippingApiLevelModuleController to auto generated test config. If any of the device
shipping api level and vendor api level properties are less than the
vsr_min_shipping_api_level, skip this module.
As this includes the shipping api level check, it is not allowed to define
min_shipping_api_level at the same time with this property.
min_vndk_version
int64, Add MinApiLevelModuleController with ro.vndk.version property. If ro.vndk.version has an
integer value and the value is less than the min_vndk_version, skip this module.
unit_test
bool, If the test is a hostside (no device required) unittest that shall be run
during presubmit check.
tags
list of string, Tags provide additional metadata to customize test execution by downstream
test runners. The tags have no special meaning to Soong.
test_per_src
bool, Create a separate binary for each source file. Useful when there is
global state that can not be torn down and reset between each test suite.
test_suites
list of string, list of compatibility suites (for example "cts", "vts") that the module should be
installed into.
tidy
bool, whether to run clang-tidy over C-like sources.
tidy_checks
list of string, Extra checks to enable or disable in clang-tidy
tidy_checks_as_errors
list of string, Checks that should be treated as errors.
tidy_disabled_srcs
list of string, list of source files that should not be compiled with clang-tidy.
tidy_flags
list of string, Extra flags to pass to clang-tidy
tidy_timeout_srcs
list of string, list of source files that should not be compiled by clang-tidy when TIDY_TIMEOUT is set.
unexported_symbols_list
string, local file name to pass to the linker as -unexported_symbols_list
unique_host_soname
bool, rename host libraries to prevent overlap with system installed libraries
use_clang_lld
bool, Use clang lld instead of gnu ld.
use_version_lib
bool, make android::build:GetBuildNumber() available containing the build ID.
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_available
bool, whether this module should be allowed to be directly depended by other
modules with `vendor: true`, `proprietary: true`, or `vendor_available:true`.
If set to true, two variants will be built separately, one like
normal, and the other limited to the set of libraries and headers
that are exposed to /vendor modules.
The vendor variant may be used with a different (newer) /system,
so it shouldn't have any unversioned runtime dependencies, or
make assumptions about the system that may not be true in the
future.
If set to false, this module becomes inaccessible from /vendor modules.
The modules with vndk: {enabled: true} must define 'vendor_available'
to 'true'.
Nothing happens if BOARD_VNDK_VERSION isn't set in the BoardConfig.mk
⊕vendor_public_library
vendorPublicLibraryProperties
If this is a vendor public library, properties to describe the vendor public library stubs.
symbol_file
string, Relative path to the symbol map.
unversioned
bool, Whether the system library uses symbol versions.
override_export_include_dirs
list of string, list of directories relative to the Blueprints file that willbe added to the include path
(using -I) for any module that links against the LLNDK variant of this module, replacing
any that were listed outside the llndk clause.
vendor_ramdisk
bool, Whether this module is installed to vendor ramdisk
vendor_ramdisk_available
bool, Make this module available when building for vendor ramdisk.
On device without a dedicated recovery partition, the module is only
available after switching root into
/first_stage_ramdisk. To expose the module before switching root, install
the recovery variant instead.
version_script
string, local file name to pass to the linker as --version-script
vintf_fragments
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/+/master/README.md#visibility for
more details.
⊕vndk
enabled
bool, declared as a VNDK or VNDK-SP module. The vendor variant
will be installed in /system instead of /vendor partition.
`vendor_available` and `product_available` must be explicitly
set to either true or false together with `vndk: {enabled: true}`.
support_system_process
bool, declared as a VNDK-SP module, which is a subset of VNDK.
`vndk: { enabled: true }` must set together.
All these modules are allowed to link to VNDK-SP or LL-NDK
modules only. Other dependency will cause link-type errors.
If `support_system_process` is not set or set to false,
the module is VNDK-core and can link to other VNDK-core,
VNDK-SP or LL-NDK modules only.
private
bool, declared as a VNDK-private module.
This module still creates the vendor and product variants refering
to the `vendor_available: true` and `product_available: true`
properties. However, it is only available to the other VNDK modules
but not to the non-VNDK vendor or product modules.
extends
string, Extending another module
whole_program_vtables
bool, Use -fwhole-program-vtables cflag.
whole_static_libs
list of string, list of modules whose object files should be linked into this module
in their entirety. For static library modules, all of the .o files from the intermediate
directory of the dependency will be linked into this modules .a file. For a shared library,
the dependency's .a file will be linked into this module using -Wl,--whole-archive.
windows_import_lib
string, Optionally provide an import library if this is a Windows PE DLL prebuilt.
This is needed only if this library is linked by other modules in build time.
Only makes sense for the Windows target.
yacc
YaccProperties