build_flags.bzl - platform/build/release - Git at Google

 """
 Build flag definitions.
 """
 # Copyright (C) 2023 The Android Open Source Project
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
 #
 #      http://www.apache.org/licenses/LICENSE-2.0
 #
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 # See the License for the specific language governing permissions and
 # limitations under the License.

 # This file defines the build system flags that can be set based on the
 # release configuration.  If at all possible, use aconfig flags instead.
 # This is for things that must be decided at compile time.

 load(
     "//build/make/core/release_config.bzl",
     "ALL",
     "PRODUCT",  # buildifier: disable=load
     "SYSTEM",  # buildifier: disable=load
     "SYSTEM_EXT",  # buildifier: disable=load
     "VENDOR",  # buildifier: disable=load
     "flag",
 )

 # Flags should be alphabetical by flag name to reduce merge conflifcts
 flags = [
     # The default permission for all flags
     flag("RELEASE_ACONFIG_FLAG_DEFAULT_PERMISSION", ALL, "READ_WRITE"),

     # The aconfig_value_set soong module to use to set aconfig values.
     flag("RELEASE_ACONFIG_VALUE_SETS", ALL, None),

     # Enables the use of the unfrozen versions of AIDL interfaces.
     # When this is `False` the libraries of the latest unfrozen version of a
     # stable interface will behave like the last frozen version.
     # When this is `True` the libraries behave like the lastest unfrozen version like
     # they always have.
     flag("RELEASE_AIDL_USE_UNFROZEN", ALL, True),

     # Enables acces to the AVF APIs to pre-installed apps.
     flag("RELEASE_AVF_ALLOW_PREINSTALLED_APPS", SYSTEM, False),

     # Enables assigning hardware devices to the guest VMs.
     # If this flag is enabled, then RELEASE_AVF_ENABLE_MICRODROID_VENDOR_MODULES
     # must also be enabled.
     flag("RELEASE_AVF_ENABLE_DEVICE_ASSIGNMENT", ALL, False),

     # Enables new DICE functionality in Microdroid VMs.
     flag("RELEASE_AVF_ENABLE_DICE_CHANGES", ALL, False),

     # Enables new llPvm functionality in Microdroid VMs.
     flag("RELEASE_AVF_ENABLE_LLPVM_CHANGES", ALL, False),

     # Enables running multiple payloads in the same Microdroid VM instance.
     flag("RELEASE_AVF_ENABLE_MULTI_TENANT_MICRODROID_VM", SYSTEM, False),

     # Enables pVM remote attestation in Microdroid VM.
     flag("RELEASE_AVF_ENABLE_REMOTE_ATTESTATION", ALL, False),

     # Enables loading vendor modules (both kernel & userspace) in Microdroid VM.
     flag("RELEASE_AVF_ENABLE_VENDOR_MODULES", ALL, False),

     # If enabled, DeathRecipient is not strongly referenced from JNI.
     flag("RELEASE_BINDER_DEATH_RECIPIENT_WEAK_FROM_JNI", ALL, False),

     # The behavior for the tree wrt building mainline modules or using prebuilts
     flag("RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE", ALL, True),

     # feature flag to deprecate VNDK
     flag("RELEASE_DEPRECATE_VNDK", ALL, False),

     # Enables flagged apis to be exposed.
     flag("RELEASE_EXPOSE_FLAGGED_API", ALL, True),

     # The version of mainline prebuilts used when prebuilts are enabled.
     flag("RELEASE_MAINLINE_MODULE_PREBUILT_VERSION", ALL, "mainline_module_prebuilt_nightly"),

     # This flag will control the rollout of new versions of the SoundPicker app.
     flag("RELEASE_PACKAGE_SOUND_PICKER", ALL, "SoundPicker"),

     # The name of the virtual camera package to add to the system partition.
     flag("RELEASE_PACKAGE_VIRTUAL_CAMERA", SYSTEM, ""),

     # The platform version.
     # TODO(joeo): Remove the default here. Maybe for platform builds not having
     # a version should be an error and should be allowed for unbundled builds.
     # The platform version. This is the 4 letter code, e.g. UD1A, UPB1, ZP1A, etc.
     flag("RELEASE_PLATFORM_VERSION", ALL, "VP1A"),

     #  Used to indicate the security patch that has been applied to the device.
     #  It must signify that the build includes all security patches issued up through the designated Android Public Security Bulletin.
     #  It must be of the form "YYYY-MM-DD" on production devices.
     #  It must match one of the Android Security Patch Level strings of the Public Security Bulletins.
     #  If there is no $PLATFORM_SECURITY_PATCH set, keep it empty.
     flag("RELEASE_PLATFORM_SECURITY_PATCH", ALL, "2023-12-05"),

     # The SDK version of the platform, e.g. 34 for UDC. This should only be increased
     # when the API is finalized and the codename is set to rel, not during development.
     flag("RELEASE_PLATFORM_SDK_VERSION", ALL, "34"),

     # The sdk extension version of this release configuration.
     flag("RELEASE_PLATFORM_SDK_EXTENSION_VERSION", ALL, "7"),

     # Set to REL for production platform builds, otherwise the codename string,
     # e.g. UpsideDownCake or VanillaIceCream
     flag("RELEASE_PLATFORM_VERSION_CODENAME", ALL, "VanillaIceCream"),

     # A comma separated list of all codenames that are in preview.
     # This variable is sort of a lie for historical reasons and only
     # includes codenames up to and including the currently active codename
     flag("RELEASE_PLATFORM_VERSION_ALL_CODENAMES", ALL, "VanillaIceCream"),

     # A comma separated list of all preview codenames the platform will accept apps built against
     flag("RELEASE_PLATFORM_VERSION_ALL_PREVIEW_CODENAMES", ALL, "VanillaIceCream"),

     # The last stable version name of the platform that was released.  During
     # development, this stays at that previous version, while the codename indicates
     # further work based on the previous version.
     flag("RELEASE_PLATFORM_VERSION_LAST_STABLE", ALL, "14"),

     # The PLATFORM_VNDK_VERSION will be set to this version when the
     # PLATFORM_VERSION_CODENAME is REL. This VNDK version flag will be removed
     # when the VNDK is deprecated
     flag("RELEASE_PLATFORM_VNDK_VERSION", ALL, ""),

     # feature flag for removing legacy emoji font from system image.
     flag("RELEASE_REMOVE_LEGACY_EMOJI_FONT", SYSTEM, False),
 ]
	"""
	Build flag definitions.
	"""
	# Copyright (C) 2023 The Android Open Source Project
	#
	# Licensed under the Apache License, Version 2.0 (the "License");
	# you may not use this file except in compliance with the License.
	# You may obtain a copy of the License at
	#
	# http://www.apache.org/licenses/LICENSE-2.0
	#
	# Unless required by applicable law or agreed to in writing, software
	# distributed under the License is distributed on an "AS IS" BASIS,
	# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	# See the License for the specific language governing permissions and
	# limitations under the License.

	# This file defines the build system flags that can be set based on the
	# release configuration. If at all possible, use aconfig flags instead.
	# This is for things that must be decided at compile time.

	load(
	"//build/make/core/release_config.bzl",
	"ALL",
	"PRODUCT", # buildifier: disable=load
	"SYSTEM", # buildifier: disable=load
	"SYSTEM_EXT", # buildifier: disable=load
	"VENDOR", # buildifier: disable=load
	"flag",
	)

	# Flags should be alphabetical by flag name to reduce merge conflifcts
	flags = [
	# The default permission for all flags
	flag("RELEASE_ACONFIG_FLAG_DEFAULT_PERMISSION", ALL, "READ_WRITE"),

	# The aconfig_value_set soong module to use to set aconfig values.
	flag("RELEASE_ACONFIG_VALUE_SETS", ALL, None),

	# Enables the use of the unfrozen versions of AIDL interfaces.
	# When this is `False` the libraries of the latest unfrozen version of a
	# stable interface will behave like the last frozen version.
	# When this is `True` the libraries behave like the lastest unfrozen version like
	# they always have.
	flag("RELEASE_AIDL_USE_UNFROZEN", ALL, True),

	# Enables acces to the AVF APIs to pre-installed apps.
	flag("RELEASE_AVF_ALLOW_PREINSTALLED_APPS", SYSTEM, False),

	# Enables assigning hardware devices to the guest VMs.
	# If this flag is enabled, then RELEASE_AVF_ENABLE_MICRODROID_VENDOR_MODULES
	# must also be enabled.
	flag("RELEASE_AVF_ENABLE_DEVICE_ASSIGNMENT", ALL, False),

	# Enables new DICE functionality in Microdroid VMs.
	flag("RELEASE_AVF_ENABLE_DICE_CHANGES", ALL, False),

	# Enables new llPvm functionality in Microdroid VMs.
	flag("RELEASE_AVF_ENABLE_LLPVM_CHANGES", ALL, False),

	# Enables running multiple payloads in the same Microdroid VM instance.
	flag("RELEASE_AVF_ENABLE_MULTI_TENANT_MICRODROID_VM", SYSTEM, False),

	# Enables pVM remote attestation in Microdroid VM.
	flag("RELEASE_AVF_ENABLE_REMOTE_ATTESTATION", ALL, False),

	# Enables loading vendor modules (both kernel & userspace) in Microdroid VM.
	flag("RELEASE_AVF_ENABLE_VENDOR_MODULES", ALL, False),

	# If enabled, DeathRecipient is not strongly referenced from JNI.
	flag("RELEASE_BINDER_DEATH_RECIPIENT_WEAK_FROM_JNI", ALL, False),

	# The behavior for the tree wrt building mainline modules or using prebuilts
	flag("RELEASE_DEFAULT_MODULE_BUILD_FROM_SOURCE", ALL, True),

	# feature flag to deprecate VNDK
	flag("RELEASE_DEPRECATE_VNDK", ALL, False),

	# Enables flagged apis to be exposed.
	flag("RELEASE_EXPOSE_FLAGGED_API", ALL, True),

	# The version of mainline prebuilts used when prebuilts are enabled.
	flag("RELEASE_MAINLINE_MODULE_PREBUILT_VERSION", ALL, "mainline_module_prebuilt_nightly"),

	# This flag will control the rollout of new versions of the SoundPicker app.
	flag("RELEASE_PACKAGE_SOUND_PICKER", ALL, "SoundPicker"),

	# The name of the virtual camera package to add to the system partition.
	flag("RELEASE_PACKAGE_VIRTUAL_CAMERA", SYSTEM, ""),

	# The platform version.
	# TODO(joeo): Remove the default here. Maybe for platform builds not having
	# a version should be an error and should be allowed for unbundled builds.
	# The platform version. This is the 4 letter code, e.g. UD1A, UPB1, ZP1A, etc.
	flag("RELEASE_PLATFORM_VERSION", ALL, "VP1A"),

	# Used to indicate the security patch that has been applied to the device.
	# It must signify that the build includes all security patches issued up through the designated Android Public Security Bulletin.
	# It must be of the form "YYYY-MM-DD" on production devices.
	# It must match one of the Android Security Patch Level strings of the Public Security Bulletins.
	# If there is no $PLATFORM_SECURITY_PATCH set, keep it empty.
	flag("RELEASE_PLATFORM_SECURITY_PATCH", ALL, "2023-12-05"),

	# The SDK version of the platform, e.g. 34 for UDC. This should only be increased
	# when the API is finalized and the codename is set to rel, not during development.
	flag("RELEASE_PLATFORM_SDK_VERSION", ALL, "34"),

	# The sdk extension version of this release configuration.
	flag("RELEASE_PLATFORM_SDK_EXTENSION_VERSION", ALL, "7"),

	# Set to REL for production platform builds, otherwise the codename string,
	# e.g. UpsideDownCake or VanillaIceCream
	flag("RELEASE_PLATFORM_VERSION_CODENAME", ALL, "VanillaIceCream"),

	# A comma separated list of all codenames that are in preview.
	# This variable is sort of a lie for historical reasons and only
	# includes codenames up to and including the currently active codename
	flag("RELEASE_PLATFORM_VERSION_ALL_CODENAMES", ALL, "VanillaIceCream"),

	# A comma separated list of all preview codenames the platform will accept apps built against
	flag("RELEASE_PLATFORM_VERSION_ALL_PREVIEW_CODENAMES", ALL, "VanillaIceCream"),

	# The last stable version name of the platform that was released. During
	# development, this stays at that previous version, while the codename indicates
	# further work based on the previous version.
	flag("RELEASE_PLATFORM_VERSION_LAST_STABLE", ALL, "14"),

	# The PLATFORM_VNDK_VERSION will be set to this version when the
	# PLATFORM_VERSION_CODENAME is REL. This VNDK version flag will be removed
	# when the VNDK is deprecated
	flag("RELEASE_PLATFORM_VNDK_VERSION", ALL, ""),

	# feature flag for removing legacy emoji font from system image.
	flag("RELEASE_REMOVE_LEGACY_EMOJI_FONT", SYSTEM, False),
	]