Build Docs

aidl_interface

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

srcs list of string, List of .aidl files which compose this interface.

host_supported bool, Whether the library can be used on host

⊕backend.cpp

Backend of the compiler generating code for C++ clients using libbinder (unstable C++ interface) When enabled, this creates a target called "<name>-cpp".

gen_log bool, Whether to generate additional code for gathering information about the transactions. Default: false

enabled bool, Whether to generate code in the corresponding backend. Default: true

apex_available list of string

min_sdk_version string, The minimum version of the sdk that the compiled artifacts will run against For native modules, the property needs to be set when a module is a part of mainline modules(APEX). Forwarded to generated java/native module.

srcs_available bool, Determines whether the generated source files are available or not. When set to true, the source files can be added to `srcs` property via `:<ifacename>-<backend>-source`, e.g., ":myaidl-java-source"

⊕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

⊕backend.java

Backend of the compiler generating code for Java clients. When enabled, this creates a target called "<name>-java".

sdk_version string, Set to the version of the sdk to compile against Default: system_current

platform_apis bool, Whether to compile against platform APIs instead of an SDK.

enabled bool, Whether to generate code in the corresponding backend. Default: true

apex_available list of string

⊕backend.ndk

Backend of the compiler generating code for C++ clients using libbinder_ndk (stable C interface to system's libbinder) When enabled, this creates a target called "<name>-ndk" (for apps) and "<name>-ndk_platform" (for platform usage).

apps_enabled bool, Currently, all ndk-supported interfaces generate two variants: - ndk - for apps to use, against an NDK - ndk_platform - for the platform to use This adds an option to disable the 'ndk' variant in cases where APIs only available in the platform version work.

gen_log bool, Whether to generate additional code for gathering information about the transactions. Default: false

enabled bool, Whether to generate code in the corresponding backend. Default: true

apex_available list of string

⊕vndk

extends string, Extending another module

⊕backend.rust

Backend of the compiler generating code for Rust clients. When enabled, this creates a target called "<name>-rust".

enabled bool, Whether to generate code in the corresponding backend. Default: true

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

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

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

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 the library can be loaded multiple times into the same process

⊕dumpapi

--dumpapi options

no_license bool, Dumps without license header (assuming it is the first comment in .aidl file). Default: false

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.

flags list of string, Optional flags to be passed to the AIDL compiler. e.g. "-Weverything"

gen_trace bool, Whether tracing should be added to the interface.

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

imports list of string, List of aidl_interface modules that this uses. If one of your AIDL interfaces uses an interface or parcelable from another aidl_interface, you should put its name here. It could be an aidl_interface solely or with version(such as -V1)

include_dirs list of string, Top level directories for includes. TODO(b/128940869): remove it if aidl_interface can depend on framework.aidl

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

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

local_include_dir string, Relative path for includes. By default assumes AIDL path is relative to current directory.

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

notice string, relative path to a file to include in the list of notices for the device

odm_available bool, Whether the library can be installed on the odm image.

owner string, vendor who owns this module

product_available bool, Whether the library can be installed on the product image.

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

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

ramdisk bool, Whether this module is installed to ramdisk

recovery bool, Whether this module is installed to recovery partition

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

stability string, Stability promise. Currently only supports "vintf". If this is unset, this corresponds to an interface with stability within this compilation context (so an interface loaded here can only be used with things compiled together, e.g. on the system.img). If this is set to "vintf", this corresponds to a stability promise: the interface must be kept stable as long as it is used.

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.host, target.android

compile_multilib string

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

unstable bool, Marks that this interface does not need to be stable. When set to true, the build system doesn't create the API dump and require it to be updated. 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_available bool, Whether the library can be installed on the vendor image.

vendor_ramdisk bool, Whether this module is installed to vendor ramdisk

versions list of string, Previous API versions that are now frozen. The version that is last in the list is considered as the most recent version.

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

extends string, Extending another module

vndk_use_version string, How to interpret VNDK options. We only want one library in the VNDK (not multiple versions, since this would be a waste of space/unclear, and ultimately we want all code in a given release to be updated to use a specific version). By default, this puts either the latest stable version of the library or, if there is no stable version, the unstable version of the library in the VNDK. When using this field, explicitly set it to one of the values in the 'versions' field to put that version in the VNDK or set it to the next version (1 higher than this) to mean the version that will be frozen in the next update.

aidl_interfaces_metadata