core/release_config.mk

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


# -----------------------------------------------------------------
# Determine which pass this is.
# -----------------------------------------------------------------
# Before PRODUCT_RELEASE_CONFIG_MAPS has been set to its final value,
# we are called with CALLED_PRE_PRODUCT_CONFIG=true.
# The final pass will have it unset/empty.
_final_product_config_pass:=
ifeq (,$(CALLED_PRE_PRODUCT_CONFIG))
    _final_product_config_pass:=true
endif

# -----------------------------------------------------------------
# Choose the flag files
# -----------------------------------------------------------------
# Release configs are defined in reflease_config_map files, which map
# the short name (e.g. -next) used in lunch to the starlark files
# defining the build flag values.
#
# (If you're thinking about aconfig flags, there is one build flag,
# RELEASE_ACONFIG_VALUE_SETS, that sets which aconfig_value_set
# module to use to set the aconfig flag values.)
#
# The short release config names *can* appear multiple times, to allow
# for AOSP and vendor specific flags under the same name, but the
# individual flag values must appear in exactly one config.  Vendor
# does not override AOSP, or anything like that.  This is because
# vendor code usually includes prebuilts, and having vendor compile
# with different flags from AOSP increases the likelihood of flag
# mismatch.

# Do this first, because we're going to unset TARGET_RELEASE before
# including anyone, so they don't start making conditionals based on it.
# This logic is in make because starlark doesn't understand optional
# vendor files.

# If this is a google source tree, restrict it to only the one file
# which has OWNERS control.  If it isn't let others define their own.
_protobuf_map_files := build/release/release_config_map.textproto \
    $(wildcard vendor/google_shared/build/release/release_config_map.textproto) \
    $(if $(wildcard vendor/google/release/release_config_map.textproto), \
        vendor/google/release/release_config_map.textproto, \
        $(sort \
            $(wildcard device/*/release/release_config_map.textproto) \
            $(wildcard device/*/*/release/release_config_map.textproto) \
            $(wildcard vendor/*/release/release_config_map.textproto) \
            $(wildcard vendor/*/*/release/release_config_map.textproto) \
        ) \
    )

# PRODUCT_RELEASE_CONFIG_MAPS is set by Soong using an initial run of product
# config to capture only the list of config maps needed by the build.
# - Keep them in the order provided, but remove duplicates.
# - Treat any .mk file as an error, since those have not worked since ap3a.
# - Additionally, the release config map filename **must** be
#   `release_config_map.textproto`, because finder looks for those files so that
#   we can correctly build release config artifacts.
$(foreach map,$(PRODUCT_RELEASE_CONFIG_MAPS), \
    $(if $(filter $(basename $(map)).mk,$(map)),\
        $(error $(map): use of release_config_map.mk files is not supported))\
    $(if $(filter-out release_config_map.textproto,$(notdir $(map))),\
        $(error $(map): must be named release_config_map.textproto))\
    $(if $(filter $(basename $(map)),$(basename $(_protobuf_map_files))),, \
        $(eval _protobuf_map_files += $(map))) \
)

# Always generate the release config for ${TARGET_RELEASE} (and its dependencies).
# Any others that are needed for build artifacts will be generated in Soong.
_flags_dir:=$(OUT_DIR)/soong/release-config

# $_maps_file) is the list of maps that are used for $(TARGET_PRODUCT).
$(shell mkdir -p $(_flags_dir))
_maps_file:=$(_flags_dir)/maps_list-$(TARGET_PRODUCT).txt
$(file >$(_maps_file).tmp,$(foreach map,$(_protobuf_map_files),$(map)))

_args:=
ifneq (,$(TARGET_PRODUCT))
    _args += --product $(TARGET_PRODUCT)
endif
ifneq (,$(TARGET_RELEASE))
    _args += --release $(TARGET_RELEASE)
endif
ifneq (,$(TARGET_BUILD_VARIANT))
    _args += --variant $(TARGET_BUILD_VARIANT)
else
    _args += --variant eng
endif
_args_file:=$(_flags_dir)/args-$(TARGET_PRODUCT).txt
# Preserve arguments for the soong module to use when it re-runs release-config.
$(KATI_file_no_rerun >$(_args_file).tmp,$(_args) --maps-file $(_maps_file))

# $(_hashfile) will have changed if any of the inputs to release-config changed, triggering a rebuild of
# those artifacts in the Soong modules.  This way, we can skip trying to duplicate the dependency tracking
# with finder.
_hashfile:=$(_flags_dir)/files_used-$(TARGET_PRODUCT).hash

# Always use the generated _maps_file, but only update the saved file on the final pass.
_args += --allow-missing=true --maps-file $(_maps_file).tmp --hashfile $(_hashfile).tmp
_flags_file:=$(_flags_dir)/release_config-$(TARGET_PRODUCT)-$(TARGET_RELEASE).vars
_active_flags:=$(_flags_dir)/release_config-$(TARGET_PRODUCT).vars
# release-config generates $(_flags_varmk)
_flags_varmk:=$(_flags_file:.vars=.varmk)

# Note: The lack of $(KATI_extra_file_deps) is intentional.  Since only the final build flag values for
# *THIS* release config matter for analysis, we don't need to re-run Kati if there were input changes
# that did not cause any changes in the final state of this release config.
$(KATI_shell_no_rerun $(OUT_DIR)/release-config $(_args) >$(OUT_DIR)/release-config.${TARGET_PRODUCT}.out && touch -t 200001010000 $(_flags_varmk))
$(if $(filter-out 0,$(.SHELLSTATUS)),$(error release-config failed to run))
ifneq (,$(_final_product_config_pass))
    # Save the final version of the config.
    $(shell if ! cmp --quiet $(_flags_varmk) $(_flags_file); then cp $(_flags_varmk) $(_flags_file); fi)
    $(shell if ! cmp --quiet $(_flags_varmk) $(_active_flags); then cp $(_flags_varmk) $(_active_flags); fi)
    # Save the final version of the maps file, so that Soong can produce the additional artifacts.
    $(shell if ! cmp --quiet $(_maps_file).tmp $(_maps_file); then cp $(_maps_file).tmp $(_maps_file); fi)
    $(shell if ! cmp --quiet $(_args_file).tmp $(_args_file); then cp $(_args_file).tmp $(_args_file); fi)
    # Save the hash of all release config files so that Soong modules can use that to detect potential changes.
    $(shell if ! cmp --quiet $(_hashfile).tmp $(_hashfile); then cp $(_hashfile).tmp $(_hashfile); fi)
    # This will also set ALL_RELEASE_CONFIGS_FOR_PRODUCT.
    $(eval include $(_flags_file))
    ifneq (,$(_disallow_lunch_use))
        $(error Release config ${TARGET_RELEASE} is disallowed for build.  Please use one of: $(ALL_RELEASE_CONFIGS_FOR_PRODUCT))
    endif
    $(KATI_shell_no_rerun rm -f $(OUT_DIR)/release-config.${TARGET_PRODUCT}.out)
else
    # This is the first pass of product config.
    $(eval include $(_flags_varmk))
endif
_args:=
_used_files:=
_flags_dir:=
_flags_file:=
_active_flags:=
_flags_varmk:=
_hashfile:=
_maps_file:=

ifeq ($(TARGET_RELEASE),)
    # We allow some internal paths to explicitly set TARGET_RELEASE to the
    # empty string.  For the most part, 'make' treats unset and empty string as
    # the same.  But the following line differentiates, and will only assign
    # if the variable was completely unset.
    TARGET_RELEASE ?= was_unset
    ifeq ($(TARGET_RELEASE),was_unset)
        $(error No release config set for target; please set TARGET_RELEASE, or if building on the command line use 'lunch <target>-<release>-<build_type>', where release is one of: $(ALL_RELEASE_CONFIGS_FOR_PRODUCT))
    endif
    # Instead of leaving this string empty, we want to default to a valid
    # setting.  Full builds coming through this path is a bug, but in case
    # of such a bug, we want to at least get consistent, valid results.
    TARGET_RELEASE = trunk_staging
endif

# During pass 1 of product config, using a non-existent release config is not an error.
# We can safely assume that we are doing pass 1 if DUMP_MANY_VARS=="PRODUCT_RELEASE_CONFIG_MAPS".
ifneq (,$(_final_product_config_pass))
    ifeq ($(filter $(ALL_RELEASE_CONFIGS_FOR_PRODUCT), $(TARGET_RELEASE)),)
        $(error No release config found for TARGET_RELEASE: $(TARGET_RELEASE). Available releases are: $(ALL_RELEASE_CONFIGS_FOR_PRODUCT))
    endif
endif

# TODO: Remove this check after enough people have sourced lunch that we don't
# need to worry about it trying to do get_build_vars TARGET_RELEASE. Maybe after ~9/2023
ifneq ($(CALLED_FROM_SETUP),true)
define TARGET_RELEASE
$(error TARGET_RELEASE may not be accessed directly. Use individual flags.)
endef
else
TARGET_RELEASE:=
endif
.KATI_READONLY := TARGET_RELEASE

_protobuf_map_files:=