Build Docs

clang_builtin_headers

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

srcs configurable list of string, list of input files

exclude_srcs list of string, input files to exclude

defaults list of string

cmd configurable string, The command to run on one or more input files. Cmd supports substitution of a few variables. Available variables for substitution:


 $(location): the path to the first entry in tools or tool_files.
 $(location <label>): the path to the tool, tool_file, input or output with name <label>. Use $(location) if <label> refers to a rule that outputs exactly one file.
 $(locations <label>): the paths to the tools, tool_files, inputs or outputs with name <label>. Use $(locations) if <label> refers to a rule that outputs two or more files.
 $(in): one or more input files.
 $(out): a single output file.
 $(genDir): the sandbox directory for this tool; contains $(out).
 $$: a literal $

common_os_srcs configurable list of string, Same as srcs, but will add dependencies on modules via a common_os os variation.

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

debug_ramdisk bool, Whether this module is installed to debug ramdisk

device_common_srcs configurable list of string, Same as srcs, but will add dependencies on modules via a device os variation and the common arch variation. Can be used to add a dependency from a host genrule to a device module.

device_first_srcs configurable list of string, Same as srcs, but will add dependencies on modules via a device os variation and the device's first supported arch's variation. Can be used to add a dependency from a host genrule to a device module.

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

dir_srcs list of string, List of input directories. Can be set only when use_nsjail is true. Currently, usage of dir_srcs is limited only to Trusty build.

⊕dist Dist

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

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

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

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

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

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

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

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

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

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

export_include_dirs list of string, List of directories to export generated headers from

host_first_srcs configurable list of string, Same as srcs, but will add dependencies on modules via for host os variation.

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

host_second_srcs configurable list of string, Same as srcs, but will add dependencies on modules via for host 2nd arch os variation.

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

keep_gendir bool, If set to true, $(genDir) is not truncated. Useful when this genrule can be incrementally built. Can be set only when use_nsjail is true.

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

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

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

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

out list of string, names of the output files that will be generated

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

owner string, vendor who owns this module

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

⊕product_variables.arc

⊕exclude_srcs

[]string

⊕srcs

[]string

⊕product_variables.debuggable

⊕init_rc

[]string

⊕required

[]string

⊕host_required

[]string

⊕target_required

[]string

⊕srcs

[]string

⊕exclude_srcs

[]string

⊕cmd

*string

⊕product_variables.malloc_low_memory

⊕srcs

[]string

⊕product_variables.native_coverage

⊕srcs

[]string

⊕exclude_srcs

[]string

⊕product_variables.platform_sdk_extension_version

⊕cmd

*string

⊕product_variables.platform_sdk_version

⊕cmd

*string

⊕product_variables.release_aidl_use_unfrozen

⊕cmd

*string

⊕required

[]string

⊕vintf_fragment_modules

[]string

⊕product_variables.selinuxignoreneverallows

⊕required

[]string

⊕product_variables.unbundled_build

⊕enabled Configurable[bool]

Configurable[bool] proptools.Configurable[bool]

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

ramdisk bool, Whether this module is installed to ramdisk

recovery bool, Whether this module is installed to recovery partition

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

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

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

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

⊕target.android

compile_multilib string

enabled bool

⊕target.host

compile_multilib string

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

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

tool_files list of string, Local files that are used by the tool

tools list of string, name of the modules (if any) that produces the host executable. Leave empty for prebuilts or scripts that do not need a module to build them.

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

use_nsjail bool

uses_order_only_build_date_file bool, When set to true, an additional $(build_date_file) label will be available to use in the cmd. This will be the location of a text file containing the build date. The dependency on this file will be "order-only", meaning that the genrule will not rerun when only this file changes, to avoid rerunning the genrule every build, because the build date changes every build. This also means that you should not attempt to consume the build date from the result of this genrule in another build rule. If you do, the build date in the second build rule will be stale when the second build rule rebuilds but this genrule does not. Only certain allowlisted modules are allowed to use this property, usages of the build date should be kept to the absolute minimum.

uses_order_only_build_number_file bool, When set to true, an additional $(build_number_file) label will be available to use in the cmd. This will be the location of a text file containing the build number. The dependency on this file will be "order-only", meaning that the genrule will not rerun when only this file changes, to avoid rerunning the genrule every build, because the build number changes every build. This also means that you should not attempt to consume the build number from the result of this genrule in another build rule. If you do, the build number in the second build rule will be stale when the second build rule rebuilds but this genrule does not. Only certain allowlisted modules are allowed to use this property, usages of the build number should be kept to the absolute minimum. Particularly no modules on the system image may include the build number. Prefer using libbuildversion via the use_version_lib property on cc modules.

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

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

vendor_ramdisk bool, Whether this module is installed to vendor ramdisk

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

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

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


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

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

write_if_changed bool, Enable restat to update the output only if the output is changed

libclang_rt_prebuilt_library_shared

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

srcs configurable list of string, a prebuilt library or binary. Can reference a genrule module that generates an executable file.

exclude_srcs configurable 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

libs list of string, List of aidl_library modules

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

export_aidl_headers bool, export headers generated from .aidl sources

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". Prefix pattern (com.foo.*) can be used to match with any APEX name with the prefix(com.foo.). Default is ["//apex_available:platform"].

arch interface

asflags list of string, list of module-specific flags that will be used for .S compiles

bootstrap bool, Allows this module to use non-APEX version of libraries. Useful for building binaries that are started before APEXes are activated.

bpf_target bool, cc Build rules targeting BPF must set this to true. The correct fix is to ban targeting bpf in cc rules instead use bpf_rules. (b/323415017)

⊕buildstubs bool

bool 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 configurable list of string, list of module-specific flags that will be used for C and C++ compiles.

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

clang_verify bool, Add "-Xclang -verify" to the cflags and appends "touch $out" to the clang command line.

cmake_snapshot_supported bool, Allows this module to be included in CMake release snapshots to be built outside of Android build system and source tree.

conlyflags list of string, list of module-specific flags that will be used for C compiles

cppflags configurable list of string, list of module-specific flags that will be used for C++ compiles

debug_ramdisk bool, Whether this module is installed to debug ramdisk

device_first_generated_headers configurable list of string, Same as generated_headers, but the dependencies will be added based on the first supported arch variant and the device os variant. This can be useful for creating a host tool that embeds a copy of a device tool, that it then extracts and pushes to a device at runtime.

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

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. Not supported on darwin, and will fail to build if provided to the darwin variant of a module.

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_cflags list of string, list of plain cc flags to be used for any module that links against this module.

export_generated_headers list of string, list of generated headers to re-export include directories from. Entries must be present in generated_headers.

export_header_lib_headers configurable list of string, list of header libraries to re-export include directories from. Entries must be present in header_libs.

export_include_dirs configurable 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_shared_lib_headers list of string, list of shared libraries to re-export include directories from. Entries must be present in shared_libs.

export_static_lib_headers list of string, list of static libraries to re-export include directories from. Entries must be present in static_libs.

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.

exported_symbols_list string, local file name to pass to the linker as -exported_symbols_list

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_headers configurable list of string, list of generated headers to add to the include path. These are the names of genrule modules.

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.

⊕header_abi_checker headerAbiCheckerProperties

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

header_libs configurable list of string, list of modules that should only provide headers for this module.

host_cross_supported bool, If set to true, build a variant of the module for the host cross. 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

ignore_max_page_size bool, ignore max page size. By default, max page size must be the max page size set for the target.

include_build_directory bool, Add the directory containing the Android.bp file to the list of include directories. Defaults to true.

include_dirs configurable 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 configurable 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.

is_llndk bool

ldflags list of string, list of module-specific flags that will be used for all link steps

lex LexProperties

lib_name string

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. Not supported on darwin or windows, and will fail to build if provided to the darwin or windows variant of a module.

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

export_headers_as_system bool, Whether to export any headers as -isystem instead of -I. Mainly for use by bionic/libc.

unversioned bool, Whether the system library uses symbol versions.

export_llndk_headers list of string, list of llndk headers to re-export include directories from.

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.

llndk_headers bool, if true, make this module available to provide headers to other modules that set llndk.symbol_file.

moved_to_apex bool, moved_to_apex marks this module has having been distributed through an apex module.

llndk_moved_to_apex bool

local_include_dirs configurable 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 capitalization style for acronyms so that it can be referred to in blueprint files as "lto"

never bool

thin bool

lto_O0 bool, Use --lto-O0 flag.

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_crt_pad_segment bool, don't link in crt_pad_segment. This flag is currently only used internal to soong for testing and for vndk prebuilt shared libraries.

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.

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

openmp bool, Build and link with OpenMP

optimize_for_size bool, Aggresively trade performance for smaller binary size. This should only be used for on-device binaries that are rarely executed and not performance critical.

⊕orderfile

instrumentation bool

order_file_path string

load_order_file bool

cflags list of string, Additional compiler flags to use when building this module for orderfile profiling.

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

owner string, vendor who owns this module

pack_relocations bool, Generate compact dynamic relocation table, default true.

prefer configurable bool, When prefer is set to true the prebuilt will be used instead of any source module with a matching name.

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_variables.arc

⊕cflags

[]string

⊕exclude_srcs

[]string

⊕header_libs

[]string

⊕include_dirs

[]string

⊕shared_libs

[]string

⊕static_libs

[]string

⊕srcs

[]string

⊕whole_static_libs

[]string

⊕product_variables.binder32bit

⊕cflags

[]string

⊕product_variables.build_from_text_stub

⊕static_libs

[]string

⊕exclude_static_libs

[]string

⊕product_variables.debuggable

⊕cflags

[]string

⊕cppflags

[]string

⊕init_rc

[]string

⊕required

[]string

⊕host_required

[]string

⊕target_required

[]string

⊕strip.all

*bool

⊕strip.keep_symbols

*bool

⊕strip.keep_symbols_and_debug_frame

*bool

⊕static_libs

[]string

⊕exclude_static_libs

[]string

⊕whole_static_libs

[]string

⊕shared_libs

[]string

⊕srcs

[]string

⊕exclude_srcs

[]string

⊕product_variables.enforce_vintf_manifest

⊕cflags

[]string

⊕product_variables.eng

⊕cflags

[]string

⊕cppflags

[]string

⊕lto.never

*bool

⊕sanitize.address

*bool

⊕product_variables.malloc_low_memory

⊕cflags

[]string

⊕shared_libs

[]string

⊕whole_static_libs

[]string

⊕static_libs

[]string

⊕exclude_static_libs

[]string

⊕srcs

[]string

⊕header_libs

[]string

⊕product_variables.malloc_pattern_fill_contents

⊕cflags

[]string

⊕product_variables.malloc_zero_contents

⊕cflags

[]string

⊕product_variables.native_coverage

⊕srcs

[]string

⊕exclude_srcs

[]string

⊕product_variables.override_rs_driver

⊕cflags

[]string

⊕product_variables.platform_sdk_version

⊕asflags

[]string

⊕cflags

[]string

⊕product_variables.release_aidl_use_unfrozen

⊕cflags

[]string

⊕required

[]string

⊕vintf_fragment_modules

[]string

⊕product_variables.safestack

⊕cflags

[]string

⊕product_variables.selinuxignoreneverallows

⊕required

[]string

⊕product_variables.shipping_api_level

⊕cflags

[]string

⊕product_variables.treble_linker_namespaces

⊕cflags

[]string

⊕product_variables.uml

⊕cppflags

[]string

⊕product_variables.unbundled_build

⊕enabled Configurable[bool]

Configurable[bool] proptools.Configurable[bool]

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

⊕proto

static bool, Link statically against the protobuf runtime

export_proto_headers bool, export headers generated from .proto sources

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

⊕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 configurable 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.

memtag_globals bool, Memory-tagging globals instrumentation, only available on arm64 Adds instrumentation to detect global buffer overflows 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

srcs list of string

⊕sanitized.hwaddress

srcs list of string

⊕sanitized.none

srcs list of string

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 configurable list of string

tidy_disabled_srcs list of string

tidy_timeout_srcs list of string

⊕sanitized Sanitized

⊕none

srcs list of string

⊕address

srcs list of string

⊕hwaddress

srcs list of string

cflags configurable list of string

enabled bool

whole_static_libs configurable list of string

static_libs configurable list of string

shared_libs configurable list of string

system_shared_libs list of string

export_shared_lib_headers list of string

export_static_lib_headers list of string

apex_available list of string

installable bool

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

source_module_name string, Name of the source soong module that gets shadowed by this prebuilt If unspecified, follows the naming convention that the source module of the prebuilt is Name() without "prebuilt_" prefix

static_libs configurable 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, 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 StubsProperties

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

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

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

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

compile_multilib string

enabled bool

⊕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

compile_multilib string

⊕target.non_apex

exclude_shared_libs list of string, list of shared libs that should not be used to build the non-apex variant of the C/C++ module.

⊕target.platform

⊕header_abi_checker headerAbiCheckerProperties

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.

header_libs list of string, list of ehader libs that only should be used to build platform variant of the C/C++ module.

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

suffix string, set suffix of the name of the output

⊕header_abi_checker headerAbiCheckerProperties

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

no_stubs bool, Disable stubs for vendor/product variants This is a workaround to keep `stubs` only for "core" variant (not product/vendor). It would be nice if we could put `stubs` into a `target: { core: {} }` block but it's not supported in soong yet. This could be removed/simplified once we have a better syntax.

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.

header_libs list of string, list of header 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_header_libs list of string, list of header 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

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

exclude_srcs list of string, list of source files that should not be used to build the ramdisk variants of the C/C++ module.

cflags list of string, List of additional cflags that should be used to build the ramdisk variants of the C/C++ module.

static_libs list of string, list of static libs that only should be used to build the 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 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.

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_header_libs list of string, list of header 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