blob: f533358e5f4109b6cf0e34d17ff8f9cb0435f5d3 [file] [log] [blame]
The Android Open Source Project88b60792009-03-03 19:28:42 -08001#
2# Copyright (C) 2008 The Android Open Source Project
3#
4# Licensed under the Apache License, Version 2.0 (the "License");
5# you may not use this file except in compliance with the License.
6# You may obtain a copy of the License at
7#
8# http://www.apache.org/licenses/LICENSE-2.0
9#
10# Unless required by applicable law or agreed to in writing, software
11# distributed under the License is distributed on an "AS IS" BASIS,
12# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13# See the License for the specific language governing permissions and
14# limitations under the License.
15#
16
Dan Willemsen3bf15e72016-07-25 16:03:53 -070017# Catch users that directly include base_rules.mk
18$(call record-module-type,base_rules)
19
The Android Open Source Project88b60792009-03-03 19:28:42 -080020# Users can define base-rules-hook in their buildspec.mk to perform
21# arbitrary operations as each module is included.
22ifdef base-rules-hook
Cole Faustf773f3a2022-04-28 16:12:52 -070023 ifndef _has_warned_about_base_rules_hook
24 $(warning base-rules-hook is deprecated, please remove usages of it and/or convert to Soong.)
25 _has_warned_about_base_rules_hook := true
26 endif
27 $(if $(base-rules-hook),)
The Android Open Source Project88b60792009-03-03 19:28:42 -080028endif
29
30###########################################################
31## Common instructions for a generic module.
32###########################################################
33
34LOCAL_MODULE := $(strip $(LOCAL_MODULE))
35ifeq ($(LOCAL_MODULE),)
36 $(error $(LOCAL_PATH): LOCAL_MODULE is not defined)
37endif
Dan Willemsenbbe6a022018-06-10 14:49:01 -070038$(call verify-module-name)
The Android Open Source Project88b60792009-03-03 19:28:42 -080039
Bob Badour42f00c72022-03-19 23:20:59 -070040my_test_data :=
41my_test_config :=
42
The Android Open Source Project88b60792009-03-03 19:28:42 -080043LOCAL_IS_HOST_MODULE := $(strip $(LOCAL_IS_HOST_MODULE))
44ifdef LOCAL_IS_HOST_MODULE
45 ifneq ($(LOCAL_IS_HOST_MODULE),true)
46 $(error $(LOCAL_PATH): LOCAL_IS_HOST_MODULE must be "true" or empty, not "$(LOCAL_IS_HOST_MODULE)")
47 endif
Dan Willemsen057aaea2015-08-14 12:59:50 -070048 ifeq ($(LOCAL_HOST_PREFIX),)
49 my_prefix := HOST_
50 else
51 my_prefix := $(LOCAL_HOST_PREFIX)
52 endif
Ying Wang13d69502012-11-01 17:22:33 -070053 my_host := host-
Alexey Polyudovccdc3112016-08-01 17:41:49 -070054 my_kind := HOST
The Android Open Source Project88b60792009-03-03 19:28:42 -080055else
Dan Willemsen58634e12020-03-06 18:09:06 -080056 my_prefix := TARGET_
57 my_kind :=
Ying Wang13d69502012-11-01 17:22:33 -070058 my_host :=
The Android Open Source Project88b60792009-03-03 19:28:42 -080059endif
60
Dan Willemsen057aaea2015-08-14 12:59:50 -070061ifeq ($(my_prefix),HOST_CROSS_)
62 my_host_cross := true
63else
64 my_host_cross :=
65endif
66
Dario Frenif31bc452018-07-12 19:44:33 +010067ifeq (true, $(LOCAL_PRODUCT_MODULE))
68ifneq (,$(filter $(LOCAL_MODULE),$(PRODUCT_FORCE_PRODUCT_MODULES_TO_SYSTEM_PARTITION)))
69 LOCAL_PRODUCT_MODULE :=
70endif
71endif
72
Jiyong Park003ea362017-11-15 18:22:14 +090073_path := $(LOCAL_MODULE_PATH) $(LOCAL_MODULE_PATH_32) $(LOCAL_MODULE_PATH_64)
74ifneq ($(filter $(TARGET_OUT_VENDOR)%,$(_path)),)
75LOCAL_VENDOR_MODULE := true
76else ifneq ($(filter $(TARGET_OUT_OEM)/%,$(_path)),)
77LOCAL_OEM_MODULE := true
78else ifneq ($(filter $(TARGET_OUT_ODM)/%,$(_path)),)
79LOCAL_ODM_MODULE := true
Jaekyun Seokb7735d82017-11-27 17:04:47 +090080else ifneq ($(filter $(TARGET_OUT_PRODUCT)/%,$(_path)),)
81LOCAL_PRODUCT_MODULE := true
Justin Yun6151e3f2019-06-25 15:58:13 +090082else ifneq ($(filter $(TARGET_OUT_SYSTEM_EXT)/%,$(_path)),)
83LOCAL_SYSTEM_EXT_MODULE := true
Jiyong Park003ea362017-11-15 18:22:14 +090084endif
85_path :=
86
Justin Yun6151e3f2019-06-25 15:58:13 +090087# TODO(b/135957588) Remove following workaround
88# LOCAL_PRODUCT_SERVICES_MODULE to LOCAL_PRODUCT_MODULE for all Android.mk
89ifndef LOCAL_PRODUCT_MODULE
90LOCAL_PRODUCT_MODULE := $(LOCAL_PRODUCT_SERVICES_MODULE)
91endif
92
Dan Willemsen05a2b932017-03-20 18:31:17 -070093ifndef LOCAL_PROPRIETARY_MODULE
94 LOCAL_PROPRIETARY_MODULE := $(LOCAL_VENDOR_MODULE)
95endif
96ifndef LOCAL_VENDOR_MODULE
97 LOCAL_VENDOR_MODULE := $(LOCAL_PROPRIETARY_MODULE)
98endif
99ifneq ($(filter-out $(LOCAL_PROPRIETARY_MODULE),$(LOCAL_VENDOR_MODULE))$(filter-out $(LOCAL_VENDOR_MODULE),$(LOCAL_PROPRIETARY_MODULE)),)
100$(call pretty-error,Only one of LOCAL_PROPRIETARY_MODULE[$(LOCAL_PROPRIETARY_MODULE)] and LOCAL_VENDOR_MODULE[$(LOCAL_VENDOR_MODULE)] may be set, or they must be equal)
101endif
102
Inseob Kimce839562020-08-10 13:03:22 +0900103ifeq ($(LOCAL_HOST_MODULE),true)
104my_image_variant := host
105else ifeq ($(LOCAL_VENDOR_MODULE),true)
106my_image_variant := vendor
107else ifeq ($(LOCAL_OEM_MODULE),true)
108my_image_variant := vendor
109else ifeq ($(LOCAL_ODM_MODULE),true)
110my_image_variant := vendor
111else ifeq ($(LOCAL_PRODUCT_MODULE),true)
112my_image_variant := product
113else
114my_image_variant := core
115endif
116
Jeongik Cha83c50322019-01-18 15:09:09 +0900117non_system_module := $(filter true, \
118 $(LOCAL_PRODUCT_MODULE) \
Justin Yun6151e3f2019-06-25 15:58:13 +0900119 $(LOCAL_SYSTEM_EXT_MODULE) \
Jeongik Cha83c50322019-01-18 15:09:09 +0900120 $(LOCAL_VENDOR_MODULE) \
121 $(LOCAL_PROPRIETARY_MODULE))
122
Dan Willemsenbab0fa62016-11-18 14:05:39 -0800123include $(BUILD_SYSTEM)/local_vndk.mk
Jiyong Park641b6cc2018-01-15 14:48:40 +0900124include $(BUILD_SYSTEM)/local_systemsdk.mk
Jeongik Cha0d1d9812020-08-20 20:21:36 +0900125include $(BUILD_SYSTEM)/local_current_sdk.mk
Dan Willemsenbab0fa62016-11-18 14:05:39 -0800126
Colin Crossa4447e82015-09-28 16:26:00 -0700127# Ninja has an implicit dependency on the command being run, and kati will
128# regenerate the ninja manifest if any read makefile changes, so there is no
129# need to have dependencies on makefiles.
130# This won't catch all the cases where LOCAL_ADDITIONAL_DEPENDENCIES contains
131# a .mk file, because a few users of LOCAL_ADDITIONAL_DEPENDENCIES don't include
132# base_rules.mk, but it will fix the most common ones.
133LOCAL_ADDITIONAL_DEPENDENCIES := $(filter-out %.mk,$(LOCAL_ADDITIONAL_DEPENDENCIES))
Colin Crossa4447e82015-09-28 16:26:00 -0700134
Dan Willemsen0c821a92017-10-23 22:14:21 -0700135my_bad_deps := $(strip $(foreach dep,$(filter-out | ||,$(LOCAL_ADDITIONAL_DEPENDENCIES)),\
136 $(if $(findstring /,$(dep)),,$(dep))))
137ifneq ($(my_bad_deps),)
138$(call pretty-warning,"Bad LOCAL_ADDITIONAL_DEPENDENCIES: $(my_bad_deps)")
139$(call pretty-error,"LOCAL_ADDITIONAL_DEPENDENCIES must only contain paths (not module names)")
140endif
141
The Android Open Source Project88b60792009-03-03 19:28:42 -0800142###########################################################
143## Validate and define fallbacks for input LOCAL_* variables.
144###########################################################
145
Ying Wang6e371e42012-05-15 14:31:26 -0700146LOCAL_UNINSTALLABLE_MODULE := $(strip $(LOCAL_UNINSTALLABLE_MODULE))
Dan Willemsen9569ddd2019-01-22 19:38:56 -0800147
Jean-Baptiste Querua831cbd2010-01-07 11:06:50 -0800148# Only the tags mentioned in this test are expected to be set by module
149# makefiles. Anything else is either a typo or a source of unexpected
150# behaviors.
Colin Crossaed37d72023-11-02 09:46:10 -0700151ifneq ($(filter-out tests optional samples,$(LOCAL_MODULE_TAGS)),)
152$(call pretty-error,unusual tags: $(filter-out tests optional samples,$(LOCAL_MODULE_TAGS)))
Jean-Baptiste Querua831cbd2010-01-07 11:06:50 -0800153endif
154
The Android Open Source Project88b60792009-03-03 19:28:42 -0800155LOCAL_MODULE_CLASS := $(strip $(LOCAL_MODULE_CLASS))
156ifneq ($(words $(LOCAL_MODULE_CLASS)),1)
157 $(error $(LOCAL_PATH): LOCAL_MODULE_CLASS must contain exactly one word, not "$(LOCAL_MODULE_CLASS)")
158endif
159
Ying Wang6feb6d52014-04-17 10:03:35 -0700160my_32_64_bit_suffix := $(if $($(LOCAL_2ND_ARCH_VAR_PREFIX)$(my_prefix)IS_64_BIT),64,32)
Colin Cross87974052014-03-21 12:25:44 -0700161
Ying Wang6e371e42012-05-15 14:31:26 -0700162ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
Colin Cross87974052014-03-21 12:25:44 -0700163my_multilib_module_path := $(strip $(LOCAL_MODULE_PATH_$(my_32_64_bit_suffix)))
Colin Cross87974052014-03-21 12:25:44 -0700164ifdef my_multilib_module_path
165my_module_path := $(my_multilib_module_path)
166else
Ying Wangb8e01852014-01-23 15:09:04 -0800167my_module_path := $(strip $(LOCAL_MODULE_PATH))
Colin Cross87974052014-03-21 12:25:44 -0700168endif
Dan Willemsene0bba6f2016-12-09 21:15:41 -0800169my_module_path := $(patsubst %/,%,$(my_module_path))
Colin Cross639c3362014-01-24 19:23:40 -0800170my_module_relative_path := $(strip $(LOCAL_MODULE_RELATIVE_PATH))
Sasha Smundakf15ff832020-05-06 13:46:30 -0700171
Dan Willemsenb2a5c7b2017-02-13 13:41:43 -0800172ifdef LOCAL_IS_HOST_MODULE
173 partition_tag :=
Bill Peckham19c3feb2020-03-20 18:31:43 -0700174 actual_partition_tag :=
Dan Willemsenb2a5c7b2017-02-13 13:41:43 -0800175else
joker.yanga75c9a52019-04-03 09:10:37 +0800176ifeq (true,$(strip $(LOCAL_VENDOR_MODULE)))
Dan Willemsenb2a5c7b2017-02-13 13:41:43 -0800177 partition_tag := _VENDOR
Bill Peckham19c3feb2020-03-20 18:31:43 -0700178 # A vendor module could be on the vendor partition at "vendor" or the system
179 # partition at "system/vendor".
180 actual_partition_tag := $(if $(filter true,$(BOARD_USES_VENDORIMAGE)),vendor,system)
joker.yanga75c9a52019-04-03 09:10:37 +0800181else ifeq (true,$(strip $(LOCAL_OEM_MODULE)))
Dan Willemsenb2a5c7b2017-02-13 13:41:43 -0800182 partition_tag := _OEM
Bill Peckham19c3feb2020-03-20 18:31:43 -0700183 actual_partition_tag := oem
joker.yanga75c9a52019-04-03 09:10:37 +0800184else ifeq (true,$(strip $(LOCAL_ODM_MODULE)))
Dan Willemsenb2a5c7b2017-02-13 13:41:43 -0800185 partition_tag := _ODM
Bill Peckham19c3feb2020-03-20 18:31:43 -0700186 # An ODM module could be on the odm partition at "odm", the vendor partition
187 # at "vendor/odm", or the system partition at "system/vendor/odm".
188 actual_partition_tag := $(if $(filter true,$(BOARD_USES_ODMIMAGE)),odm,$(if $(filter true,$(BOARD_USES_VENDORIMAGE)),vendor,system))
joker.yanga75c9a52019-04-03 09:10:37 +0800189else ifeq (true,$(strip $(LOCAL_PRODUCT_MODULE)))
Jaekyun Seokb7735d82017-11-27 17:04:47 +0900190 partition_tag := _PRODUCT
Bill Peckham19c3feb2020-03-20 18:31:43 -0700191 # A product module could be on the product partition at "product" or the
192 # system partition at "system/product".
193 actual_partition_tag := $(if $(filter true,$(BOARD_USES_PRODUCTIMAGE)),product,system)
Justin Yun6151e3f2019-06-25 15:58:13 +0900194else ifeq (true,$(strip $(LOCAL_SYSTEM_EXT_MODULE)))
195 partition_tag := _SYSTEM_EXT
Bill Peckham19c3feb2020-03-20 18:31:43 -0700196 # A system_ext-specific module could be on the system_ext partition at
197 # "system_ext" or the system partition at "system/system_ext".
198 actual_partition_tag := $(if $(filter true,$(BOARD_USES_SYSTEM_EXTIMAGE)),system_ext,system)
Dan Willemsenb2a5c7b2017-02-13 13:41:43 -0800199else ifeq (NATIVE_TESTS,$(LOCAL_MODULE_CLASS))
200 partition_tag := _DATA
Bill Peckham19c3feb2020-03-20 18:31:43 -0700201 actual_partition_tag := data
Dan Willemsenb2a5c7b2017-02-13 13:41:43 -0800202else
203 # The definition of should-install-to-system will be different depending
204 # on which goal (e.g., sdk or just droid) is being built.
Colin Crossaed37d72023-11-02 09:46:10 -0700205 partition_tag := $(if $(call should-install-to-system,$(LOCAL_MODULE_TAGS)),,_DATA)
Bill Peckham19c3feb2020-03-20 18:31:43 -0700206 actual_partition_tag := $(if $(partition_tag),data,system)
Dan Willemsenb2a5c7b2017-02-13 13:41:43 -0800207endif
208endif
Nelson Li1f8357f2019-03-14 01:04:05 +0000209# For test modules that lack a suite tag, set null-suite as the default.
210# We only support adding a default suite to native tests, native benchmarks, and instrumentation tests.
211# This is because they are the only tests we currently auto-generate test configs for.
212ifndef LOCAL_COMPATIBILITY_SUITE
213 ifneq ($(filter NATIVE_TESTS NATIVE_BENCHMARK, $(LOCAL_MODULE_CLASS)),)
214 LOCAL_COMPATIBILITY_SUITE := null-suite
215 endif
216 ifneq ($(filter APPS, $(LOCAL_MODULE_CLASS)),)
Colin Crossaed37d72023-11-02 09:46:10 -0700217 ifneq ($(filter $(LOCAL_MODULE_TAGS),tests),)
Nelson Li1f8357f2019-03-14 01:04:05 +0000218 LOCAL_COMPATIBILITY_SUITE := null-suite
219 endif
220 endif
221endif
222
223use_testcase_folder :=
Sasha Smundakda25b692019-03-25 13:26:03 -0700224ifeq ($(my_module_path),)
225 ifneq ($(LOCAL_MODULE),$(filter $(LOCAL_MODULE),$(DEFAULT_DATA_OUT_MODULES)))
226 ifdef LOCAL_COMPATIBILITY_SUITE
227 ifneq (true, $(LOCAL_IS_HOST_MODULE))
228 use_testcase_folder := true
Nelson Li1f8357f2019-03-14 01:04:05 +0000229 endif
230 endif
231 endif
232endif
233
Dan Shi41f62912020-11-11 16:25:20 -0800234ifeq ($(LOCAL_IS_UNIT_TEST),true)
235 ifeq ($(LOCAL_IS_HOST_MODULE),true)
236 LOCAL_COMPATIBILITY_SUITE += host-unit-tests
237 endif
238endif
239
Jiyong Park842a9852017-01-20 09:01:17 +0900240ifeq ($(my_module_path),)
Dan Willemsende4e71b2017-03-16 16:51:46 -0700241 install_path_var := $(LOCAL_2ND_ARCH_VAR_PREFIX)$(my_prefix)OUT$(partition_tag)_$(LOCAL_MODULE_CLASS)
242 ifeq (true,$(LOCAL_PRIVILEGED_MODULE))
243 install_path_var := $(install_path_var)_PRIVILEGED
244 endif
Jiyong Park842a9852017-01-20 09:01:17 +0900245
Dan Willemsende4e71b2017-03-16 16:51:46 -0700246 my_module_path := $($(install_path_var))
Nelson Li1f8357f2019-03-14 01:04:05 +0000247
248 # If use_testcase_folder be set, and LOCAL_MODULE_PATH not set,
249 # overwrite the default path under testcase.
250 ifeq ($(use_testcase_folder),true)
251 arch_dir := $($(my_prefix)$(LOCAL_2ND_ARCH_VAR_PREFIX)ARCH)
252 testcase_folder := $($(my_prefix)OUT_TESTCASES)/$(LOCAL_MODULE)/$(arch_dir)
253 my_module_path := $(testcase_folder)
254 arch_dir :=
255 endif
256
Dan Willemsende4e71b2017-03-16 16:51:46 -0700257 ifeq ($(strip $(my_module_path)),)
258 $(error $(LOCAL_PATH): unhandled install path "$(install_path_var) for $(LOCAL_MODULE)")
Jiyong Park842a9852017-01-20 09:01:17 +0900259 endif
Colin Cross639c3362014-01-24 19:23:40 -0800260endif
Dan Willemsende4e71b2017-03-16 16:51:46 -0700261ifneq ($(my_module_relative_path),)
262 my_module_path := $(my_module_path)/$(my_module_relative_path)
263endif
Ying Wang6e371e42012-05-15 14:31:26 -0700264endif # not LOCAL_UNINSTALLABLE_MODULE
The Android Open Source Project88b60792009-03-03 19:28:42 -0800265
266ifneq ($(strip $(LOCAL_BUILT_MODULE)$(LOCAL_INSTALLED_MODULE)),)
267 $(error $(LOCAL_PATH): LOCAL_BUILT_MODULE and LOCAL_INSTALLED_MODULE must not be defined by component makefiles)
268endif
269
Ying Wang6ef65192014-01-15 16:02:16 -0800270my_register_name := $(LOCAL_MODULE)
Dan Willemsen057aaea2015-08-14 12:59:50 -0700271ifeq ($(my_host_cross),true)
272 my_register_name := host_cross_$(LOCAL_MODULE)
273endif
Dan Willemsen9ecbf832016-02-05 16:20:19 -0800274ifdef LOCAL_2ND_ARCH_VAR_PREFIX
275ifndef LOCAL_NO_2ND_ARCH_MODULE_SUFFIX
276my_register_name := $(my_register_name)$($(my_prefix)2ND_ARCH_MODULE_SUFFIX)
277endif
278endif
Alexey Polyudovccdc3112016-08-01 17:41:49 -0700279
Colin Crossaaf888a2016-09-07 12:48:30 -0700280ifeq ($(my_host_cross),true)
281 my_all_targets := host_cross_$(my_register_name)_all_targets
282else ifneq ($(LOCAL_IS_HOST_MODULE),)
283 my_all_targets := host_$(my_register_name)_all_targets
284else
285 my_all_targets := device_$(my_register_name)_all_targets
286endif
287
The Android Open Source Project88b60792009-03-03 19:28:42 -0800288# Make sure that this IS_HOST/CLASS/MODULE combination is unique.
289module_id := MODULE.$(if \
Dan Willemsen58634e12020-03-06 18:09:06 -0800290 $(LOCAL_IS_HOST_MODULE),$($(my_prefix)OS),TARGET).$(LOCAL_MODULE_CLASS).$(my_register_name)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800291ifdef $(module_id)
292$(error $(LOCAL_PATH): $(module_id) already defined by $($(module_id)))
293endif
294$(module_id) := $(LOCAL_PATH)
295
Dan Willemsen8447b812020-06-08 21:00:18 -0700296# These are the same as local-intermediates-dir / local-generated-sources dir, but faster
297intermediates.COMMON := $($(my_prefix)OUT_COMMON_INTERMEDIATES)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
298ifneq (,$(filter $(my_prefix)$(LOCAL_MODULE_CLASS),$(COMMON_MODULE_CLASSES)))
299 intermediates := $($(my_prefix)OUT_COMMON_INTERMEDIATES)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
300 generated_sources_dir := $($(my_prefix)OUT_COMMON_GEN)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
301else
302 ifneq (,$(filter $(LOCAL_MODULE_CLASS),$(PER_ARCH_MODULE_CLASSES)))
303 intermediates := $($(LOCAL_2ND_ARCH_VAR_PREFIX)$(my_prefix)OUT_INTERMEDIATES)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
304 else
305 intermediates := $($(my_prefix)OUT_INTERMEDIATES)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
306 endif
307 generated_sources_dir := $($(my_prefix)OUT_GEN)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
308endif
The Android Open Source Project88b60792009-03-03 19:28:42 -0800309
Jiyong Parkcbf76f62017-03-24 19:31:49 +0900310ifneq ($(LOCAL_OVERRIDES_MODULES),)
dimitry3142e292018-11-07 10:39:34 +0100311 ifndef LOCAL_IS_HOST_MODULE
312 ifeq ($(LOCAL_MODULE_CLASS),EXECUTABLES)
Jiyong Parkcbf76f62017-03-24 19:31:49 +0900313 EXECUTABLES.$(LOCAL_MODULE).OVERRIDES := $(strip $(LOCAL_OVERRIDES_MODULES))
dimitry3142e292018-11-07 10:39:34 +0100314 else ifeq ($(LOCAL_MODULE_CLASS),SHARED_LIBRARIES)
315 SHARED_LIBRARIES.$(LOCAL_MODULE).OVERRIDES := $(strip $(LOCAL_OVERRIDES_MODULES))
Jaewoong Jung7c7dfcd2019-11-06 14:08:59 -0800316 else ifeq ($(LOCAL_MODULE_CLASS),ETC)
317 ETC.$(LOCAL_MODULE).OVERRIDES := $(strip $(LOCAL_OVERRIDES_MODULES))
Jiyong Parkcbf76f62017-03-24 19:31:49 +0900318 else
dimitry3142e292018-11-07 10:39:34 +0100319 $(call pretty-error,LOCAL_MODULE_CLASS := $(LOCAL_MODULE_CLASS) cannot use LOCAL_OVERRIDES_MODULES)
Jiyong Parkcbf76f62017-03-24 19:31:49 +0900320 endif
321 else
dimitry3142e292018-11-07 10:39:34 +0100322 $(call pretty-error,host modules cannot use LOCAL_OVERRIDES_MODULES)
Jiyong Parkcbf76f62017-03-24 19:31:49 +0900323 endif
324endif
325
The Android Open Source Project88b60792009-03-03 19:28:42 -0800326###########################################################
327# Pick a name for the intermediate and final targets
328###########################################################
Colin Cross5a9db902014-03-21 12:27:37 -0700329include $(BUILD_SYSTEM)/configure_module_stem.mk
The Android Open Source Project88b60792009-03-03 19:28:42 -0800330
Dan Willemsen0cf52d82017-05-15 23:38:04 -0700331LOCAL_BUILT_MODULE := $(intermediates)/$(my_built_module_stem)
332
Colin Cross23ee3752021-09-24 15:48:03 -0700333ifneq (,$(LOCAL_SOONG_INSTALLED_MODULE))
334 ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
335 $(call pretty-error, LOCAL_SOONG_INSTALLED_MODULE can only be used from $(SOONG_ANDROID_MK))
336 endif
337 # Use the install path requested by Soong.
338 LOCAL_INSTALLED_MODULE := $(LOCAL_SOONG_INSTALLED_MODULE)
339else ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
Ying Wangaf9757e2014-07-17 21:24:42 -0700340 # Apk and its attachments reside in its own subdir.
341 ifeq ($(LOCAL_MODULE_CLASS),APPS)
Sasha Smundakf15ff832020-05-06 13:46:30 -0700342 # framework-res.apk doesn't like the additional layer.
343 ifeq ($(LOCAL_NO_STANDARD_LIBRARIES),true)
344 # Neither do Runtime Resource Overlay apks, which contain just the overlaid resources.
345 else ifeq ($(LOCAL_IS_RUNTIME_RESOURCE_OVERLAY),true)
346 else
347 ifneq ($(use_testcase_folder),true)
348 my_module_path := $(my_module_path)/$(LOCAL_MODULE)
349 endif
Nelson Li1f8357f2019-03-14 01:04:05 +0000350 endif
Ying Wangaf9757e2014-07-17 21:24:42 -0700351 endif
Ying Wang966c1e02014-05-20 14:43:51 -0700352 LOCAL_INSTALLED_MODULE := $(my_module_path)/$(my_installed_module_stem)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800353endif
354
355# Assemble the list of targets to create PRIVATE_ variables for.
356LOCAL_INTERMEDIATE_TARGETS += $(LOCAL_BUILT_MODULE)
357
Yasuhiro Matsudaff82e822015-09-04 16:23:49 +0900358###########################################################
Shinichiro Hamaji0e7587a2015-10-09 14:36:04 +0900359## Create .toc files from shared objects to reduce unnecessary rebuild
360# .toc files have the list of external dynamic symbols without their addresses.
Shinichiro Hamaji89b255a2015-11-09 16:47:42 +0900361# As .KATI_RESTAT is specified to .toc files and commit-change-for-toc is used,
362# dependent binaries of a .toc file will be rebuilt only when the content of
Shinichiro Hamaji0e7587a2015-10-09 14:36:04 +0900363# the .toc file is changed.
Colin Cross8fb525d2018-09-06 16:25:22 -0700364#
365# Don't create .toc files for Soong shared libraries, that is handled in
366# Soong and soong_cc_prebuilt.mk
Shinichiro Hamaji0e7587a2015-10-09 14:36:04 +0900367###########################################################
Colin Cross8fb525d2018-09-06 16:25:22 -0700368ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
Shinichiro Hamaji0e7587a2015-10-09 14:36:04 +0900369ifeq ($(LOCAL_MODULE_CLASS),SHARED_LIBRARIES)
370LOCAL_INTERMEDIATE_TARGETS += $(LOCAL_BUILT_MODULE).toc
371$(LOCAL_BUILT_MODULE).toc: $(LOCAL_BUILT_MODULE)
Shinichiro Hamaji0e7587a2015-10-09 14:36:04 +0900372 $(call $(PRIVATE_2ND_ARCH_VAR_PREFIX)$(PRIVATE_PREFIX)transform-shared-lib-to-toc,$<,$@.tmp)
Shinichiro Hamaji89b255a2015-11-09 16:47:42 +0900373 $(call commit-change-for-toc,$@)
Shinichiro Hamaji0e7587a2015-10-09 14:36:04 +0900374
375# Kati adds restat=1 to ninja. GNU make does nothing for this.
376.KATI_RESTAT: $(LOCAL_BUILT_MODULE).toc
Colin Crosse2b8f682016-02-04 13:28:04 -0800377# Build .toc file when using mm, mma, or make $(my_register_name)
Colin Crossaaf888a2016-09-07 12:48:30 -0700378$(my_all_targets): $(LOCAL_BUILT_MODULE).toc
Shinichiro Hamaji0e7587a2015-10-09 14:36:04 +0900379endif
Colin Cross8fb525d2018-09-06 16:25:22 -0700380endif
Shinichiro Hamaji0e7587a2015-10-09 14:36:04 +0900381
382###########################################################
Yasuhiro Matsudaff82e822015-09-04 16:23:49 +0900383## logtags: Add .logtags files to global list
384###########################################################
385
Dan Willemsenb0a08b82016-06-01 15:27:11 -0700386logtags_sources := $(filter %.logtags,$(LOCAL_SRC_FILES)) $(LOCAL_LOGTAGS_FILES)
Yasuhiro Matsudaff82e822015-09-04 16:23:49 +0900387
388ifneq ($(strip $(logtags_sources)),)
Dan Willemsenbbe4e112019-06-12 17:13:28 +0000389event_log_tags := $(foreach f,$(addprefix $(LOCAL_PATH)/,$(logtags_sources)),$(call clean-path,$(f)))
Yasuhiro Matsudaff82e822015-09-04 16:23:49 +0900390else
391event_log_tags :=
392endif
The Android Open Source Project88b60792009-03-03 19:28:42 -0800393
394###########################################################
The Android Open Source Project88b60792009-03-03 19:28:42 -0800395## make clean- targets
396###########################################################
Ying Wang6ef65192014-01-15 16:02:16 -0800397cleantarget := clean-$(my_register_name)
Dan Willemsen7a1da0e2018-07-24 01:21:12 -0700398.PHONY: $(cleantarget)
Ying Wang6ef65192014-01-15 16:02:16 -0800399$(cleantarget) : PRIVATE_MODULE := $(my_register_name)
Ying Wang4d063412013-03-22 18:52:57 -0700400$(cleantarget) : PRIVATE_CLEAN_FILES := \
Ying Wang95221ca2012-11-07 14:07:34 -0800401 $(LOCAL_BUILT_MODULE) \
402 $(LOCAL_INSTALLED_MODULE) \
403 $(intermediates)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800404$(cleantarget)::
405 @echo "Clean: $(PRIVATE_MODULE)"
406 $(hide) rm -rf $(PRIVATE_CLEAN_FILES)
407
408###########################################################
409## Common definitions for module.
410###########################################################
The Android Open Source Project88b60792009-03-03 19:28:42 -0800411$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_PATH:=$(LOCAL_PATH)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800412$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_IS_HOST_MODULE := $(LOCAL_IS_HOST_MODULE)
413$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_HOST:= $(my_host)
Dan Willemsen057aaea2015-08-14 12:59:50 -0700414$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_PREFIX := $(my_prefix)
Dan Albert617597c2023-06-08 21:08:40 +0000415$(LOCAL_INTERMEDIATE_TARGETS) : .KATI_TAGS += ;module_name=$(LOCAL_MODULE)
416ifeq ($(LOCAL_MODULE_CLASS),)
417$(error "$(LOCAL_MODULE) in $(LOCAL_PATH) does not set $(LOCAL_MODULE_CLASS)")
418else
419$(LOCAL_INTERMEDIATE_TARGETS) : .KATI_TAGS += ;module_type=$(LOCAL_MODULE_CLASS)
420endif
Dan Willemsen057aaea2015-08-14 12:59:50 -0700421
Dima Zavin46e9bec2009-05-27 19:41:07 -0700422$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_INTERMEDIATES_DIR:= $(intermediates)
Ying Wang6feb6d52014-04-17 10:03:35 -0700423$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_2ND_ARCH_VAR_PREFIX := $(LOCAL_2ND_ARCH_VAR_PREFIX)
424
The Android Open Source Project88b60792009-03-03 19:28:42 -0800425# Tell the module and all of its sub-modules who it is.
Ying Wang6ef65192014-01-15 16:02:16 -0800426$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_MODULE:= $(my_register_name)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800427
428# Provide a short-hand for building this module.
429# We name both BUILT and INSTALLED in case
430# LOCAL_UNINSTALLABLE_MODULE is set.
Colin Crossaaf888a2016-09-07 12:48:30 -0700431.PHONY: $(my_all_targets)
Colin Cross0162cc82019-01-29 15:04:39 -0800432$(my_all_targets): $(LOCAL_BUILT_MODULE) $(LOCAL_INSTALLED_MODULE) $(LOCAL_ADDITIONAL_CHECKED_MODULE)
Colin Crossaaf888a2016-09-07 12:48:30 -0700433
Ying Wang6ef65192014-01-15 16:02:16 -0800434.PHONY: $(my_register_name)
Colin Crossaaf888a2016-09-07 12:48:30 -0700435$(my_register_name): $(my_all_targets)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800436
Ying Wang71c58092016-03-23 11:02:03 -0700437ifneq ($(my_register_name),$(LOCAL_MODULE))
438# $(LOCAL_MODULE) covers all the multilib targets.
439.PHONY: $(LOCAL_MODULE)
Colin Crossaaf888a2016-09-07 12:48:30 -0700440$(LOCAL_MODULE) : $(my_all_targets)
Ying Wang71c58092016-03-23 11:02:03 -0700441endif
442
Ying Wangcaeaa082015-09-23 16:08:55 -0700443# Set up phony targets that covers all modules under the given paths.
444# This allows us to build everything in given paths by running mmma/mma.
Dan Willemsen343caec2020-06-08 23:10:14 -0700445define my_path_comp
446parent := $(patsubst %/,%,$(dir $(1)))
447parent_target := MODULES-IN-$$(subst /,-,$$(parent))
448.PHONY: $$(parent_target)
449$$(parent_target): $(2)
450ifndef $$(parent_target)
451 $$(parent_target) := true
452 ifneq (,$$(findstring /,$$(parent)))
453 $$(eval $$(call my_path_comp,$$(parent),$$(parent_target)))
454 endif
455endif
456endef
457
458_local_path := $(patsubst %/,%,$(LOCAL_PATH))
459_local_path_target := MODULES-IN-$(subst /,-,$(_local_path))
460
461.PHONY: $(_local_path_target)
462$(_local_path_target): $(my_register_name)
463
464ifndef $(_local_path_target)
465 $(_local_path_target) := true
Yo Chiang150a1ca2020-08-08 20:10:59 +0800466 ifneq (,$(findstring /,$(_local_path)))
467 $(eval $(call my_path_comp,$(_local_path),$(_local_path_target)))
468 endif
Dan Willemsen343caec2020-06-08 23:10:14 -0700469endif
470
471_local_path :=
472_local_path_target :=
473my_path_comp :=
Ying Wangcaeaa082015-09-23 16:08:55 -0700474
The Android Open Source Project88b60792009-03-03 19:28:42 -0800475###########################################################
476## Module installation rule
477###########################################################
478
Colin Cross744d33b2016-07-14 16:02:57 -0700479my_installed_symlinks :=
Nelson Li1f8357f2019-03-14 01:04:05 +0000480
Colin Cross23ee3752021-09-24 15:48:03 -0700481ifneq (,$(LOCAL_SOONG_INSTALLED_MODULE))
482 # Soong already generated the copy rule, but make the installed location depend on the Make
483 # copy of the intermediates for now, as some rules that collect intermediates may expect
484 # them to exist.
485 $(LOCAL_INSTALLED_MODULE): $(LOCAL_BUILT_MODULE)
486else ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
Colin Crossa69b8092021-11-03 13:15:59 -0700487 $(LOCAL_INSTALLED_MODULE): PRIVATE_POST_INSTALL_CMD := $(LOCAL_POST_INSTALL_CMD)
488 $(LOCAL_INSTALLED_MODULE): $(LOCAL_BUILT_MODULE)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800489 @echo "Install: $@"
Colin Crossa69b8092021-11-03 13:15:59 -0700490 ifeq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
Martin Stjernholm49a4e9b2020-08-21 16:36:23 +0100491 $(copy-file-or-link-to-new-target)
Colin Crossa69b8092021-11-03 13:15:59 -0700492 else
Ying Wang84ed6fa2011-01-18 17:21:20 -0800493 $(copy-file-to-new-target)
Colin Cross23ee3752021-09-24 15:48:03 -0700494 endif
Colin Crossa69b8092021-11-03 13:15:59 -0700495 $(PRIVATE_POST_INSTALL_CMD)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800496
Colin Cross23ee3752021-09-24 15:48:03 -0700497 # Rule to install the module's companion symlinks
498 my_installed_symlinks := $(addprefix $(my_module_path)/,$(LOCAL_MODULE_SYMLINKS) $(LOCAL_MODULE_SYMLINKS_$(my_32_64_bit_suffix)))
499 $(foreach symlink,$(my_installed_symlinks),\
Bob Badour879cfa82021-04-15 10:41:38 -0700500 $(call symlink-file,$(LOCAL_INSTALLED_MODULE),$(my_installed_module_stem),$(symlink))\
501 $(call declare-0p-target,$(symlink)))
Dan Willemsen435360a2016-07-27 22:52:42 -0700502
Colin Cross23ee3752021-09-24 15:48:03 -0700503 $(my_all_targets) : | $(my_installed_symlinks)
Colin Cross6d34b612016-08-24 15:20:23 -0700504
Ying Wang9fe15ac2015-08-20 12:02:10 -0700505endif # !LOCAL_UNINSTALLABLE_MODULE
Joe Onoratoe334d252009-07-17 15:33:40 -0400506
Cole Faustc67e7692023-09-01 16:15:00 -0700507# Add dependencies on LOCAL_SOONG_INSTALL_SYMLINKS if we're installing any kind of module, not just
508# ones that set LOCAL_SOONG_INSTALLED_MODULE. This is so we can have a soong module that only
509# installs symlinks (e.g. install_symlink). We can't set LOCAL_SOONG_INSTALLED_MODULE to a symlink
510# because cp commands will fail on symlinks.
511ifneq (,$(or $(LOCAL_SOONG_INSTALLED_MODULE),$(call boolean-not,$(LOCAL_UNINSTALLABLE_MODULE))))
512 $(foreach symlink, $(LOCAL_SOONG_INSTALL_SYMLINKS), $(call declare-0p-target,$(symlink)))
513 $(my_all_targets) : | $(LOCAL_SOONG_INSTALL_SYMLINKS)
514endif
515
Joe Onoratoe334d252009-07-17 15:33:40 -0400516###########################################################
Colin Cross23ee3752021-09-24 15:48:03 -0700517## VINTF manifest fragment and init.rc goals
Steven Moreland3629aa72018-04-04 15:41:05 -0700518###########################################################
519
520my_vintf_installed:=
Steven Morelandb1861832021-11-01 17:58:28 -0700521my_vintf_path:=
Steven Moreland3629aa72018-04-04 15:41:05 -0700522my_vintf_pairs:=
Colin Cross23ee3752021-09-24 15:48:03 -0700523my_init_rc_installed :=
524my_init_rc_path :=
525my_init_rc_pairs :=
Steven Moreland3629aa72018-04-04 15:41:05 -0700526ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
Colin Cross23ee3752021-09-24 15:48:03 -0700527 ifndef LOCAL_IS_HOST_MODULE
528 # Rule to install the module's companion vintf fragments.
529 ifneq ($(strip $(LOCAL_FULL_VINTF_FRAGMENTS)),)
530 my_vintf_fragments := $(LOCAL_FULL_VINTF_FRAGMENTS)
531 else
532 my_vintf_fragments := $(foreach xml,$(LOCAL_VINTF_FRAGMENTS),$(LOCAL_PATH)/$(xml))
533 endif
534 ifneq ($(strip $(my_vintf_fragments)),)
Steven Morelandb1861832021-11-01 17:58:28 -0700535 # Make doesn't support recovery as an output partition, but some Soong modules installed in recovery
536 # have init.rc files that need to be installed alongside them. Manually handle the case where the
537 # output file is in the recovery partition.
538 my_vintf_path := $(if $(filter $(TARGET_RECOVERY_ROOT_OUT)/%,$(my_module_path)),$(TARGET_RECOVERY_ROOT_OUT)/system/etc,$(TARGET_OUT$(partition_tag)_ETC))
539 my_vintf_pairs := $(foreach xml,$(my_vintf_fragments),$(xml):$(my_vintf_path)/vintf/manifest/$(notdir $(xml)))
Colin Cross23ee3752021-09-24 15:48:03 -0700540 my_vintf_installed := $(foreach xml,$(my_vintf_pairs),$(call word-colon,2,$(xml)))
Steven Moreland3629aa72018-04-04 15:41:05 -0700541
Colin Cross23ee3752021-09-24 15:48:03 -0700542 # Only set up copy rules once, even if another arch variant shares it
543 my_vintf_new_pairs := $(filter-out $(ALL_VINTF_MANIFEST_FRAGMENTS_LIST),$(my_vintf_pairs))
544 my_vintf_new_installed := $(call copy-many-vintf-manifest-files-checked,$(my_vintf_new_pairs))
Steven Moreland3629aa72018-04-04 15:41:05 -0700545
Colin Cross23ee3752021-09-24 15:48:03 -0700546 ALL_VINTF_MANIFEST_FRAGMENTS_LIST += $(my_vintf_new_pairs)
Steven Moreland3629aa72018-04-04 15:41:05 -0700547
Jooyung Han7650dda2023-07-05 15:58:53 +0900548 $(my_all_targets) : $(my_vintf_installed)
Jooyung Hanb14b4cd2023-07-05 15:59:28 +0900549 # Install fragments together with the target
550 $(LOCAL_INSTALLED_MODULE) : | $(my_vintf_installed)
Colin Cross23ee3752021-09-24 15:48:03 -0700551 endif # my_vintf_fragments
552
553 # Rule to install the module's companion init.rc.
554 ifneq ($(strip $(LOCAL_FULL_INIT_RC)),)
555 my_init_rc := $(LOCAL_FULL_INIT_RC)
556 else
557 my_init_rc := $(foreach rc,$(LOCAL_INIT_RC_$(my_32_64_bit_suffix)) $(LOCAL_INIT_RC),$(LOCAL_PATH)/$(rc))
558 endif
559 ifneq ($(strip $(my_init_rc)),)
Kelvin Zhang701f1612022-04-13 16:40:06 -0700560 # Make doesn't support recovery or ramdisk as an output partition,
561 # but some Soong modules installed in recovery or ramdisk
562 # have init.rc files that need to be installed alongside them.
563 # Manually handle the case where the
564 # output file is in the recovery or ramdisk partition.
565 ifneq (,$(filter $(TARGET_RECOVERY_ROOT_OUT)/%,$(my_module_path)))
Kelvin Zhang1143aaf2023-01-13 09:45:00 -0800566 ifneq (,$(filter $(TARGET_RECOVERY_ROOT_OUT)/first_stage_ramdisk/%,$(my_module_path)))
567 my_init_rc_path := $(TARGET_RECOVERY_ROOT_OUT)/first_stage_ramdisk/system/etc
568 else
569 my_init_rc_path := $(TARGET_RECOVERY_ROOT_OUT)/system/etc
570 endif
Kelvin Zhang701f1612022-04-13 16:40:06 -0700571 else ifneq (,$(filter $(TARGET_RAMDISK_OUT)/%,$(my_module_path)))
572 my_init_rc_path := $(TARGET_RAMDISK_OUT)/system/etc
573 else
574 my_init_rc_path := $(TARGET_OUT$(partition_tag)_ETC)
575 endif
Colin Cross23ee3752021-09-24 15:48:03 -0700576 my_init_rc_pairs := $(foreach rc,$(my_init_rc),$(rc):$(my_init_rc_path)/init/$(notdir $(rc)))
577 my_init_rc_installed := $(foreach rc,$(my_init_rc_pairs),$(call word-colon,2,$(rc)))
578
579 # Make sure we only set up the copy rules once, even if another arch variant
580 # shares a common LOCAL_INIT_RC.
581 my_init_rc_new_pairs := $(filter-out $(ALL_INIT_RC_INSTALLED_PAIRS),$(my_init_rc_pairs))
582 my_init_rc_new_installed := $(call copy-many-init-script-files-checked,$(my_init_rc_new_pairs))
583
584 ALL_INIT_RC_INSTALLED_PAIRS += $(my_init_rc_new_pairs)
585
586 $(my_all_targets) : $(my_init_rc_installed)
Jooyung Hanb14b4cd2023-07-05 15:59:28 +0900587 # Install init_rc together with the target
588 $(LOCAL_INSTALLED_MODULE) : | $(my_init_rc_installed)
Colin Cross23ee3752021-09-24 15:48:03 -0700589 endif # my_init_rc
590
591 endif # !LOCAL_IS_HOST_MODULE
Steven Moreland3629aa72018-04-04 15:41:05 -0700592endif # !LOCAL_UNINSTALLABLE_MODULE
593
594###########################################################
Joe Onoratoe334d252009-07-17 15:33:40 -0400595## CHECK_BUILD goals
596###########################################################
Ying Wang6c1d1cc2014-09-29 14:34:32 -0700597my_checked_module :=
Joe Onoratoe334d252009-07-17 15:33:40 -0400598# If nobody has defined a more specific module for the
Ying Wang5a8d3452013-01-30 14:43:05 -0800599# checked modules, use LOCAL_BUILT_MODULE.
Ying Wang6c1d1cc2014-09-29 14:34:32 -0700600ifdef LOCAL_CHECKED_MODULE
601 my_checked_module := $(LOCAL_CHECKED_MODULE)
602else
603 my_checked_module := $(LOCAL_BUILT_MODULE)
Joe Onoratoe334d252009-07-17 15:33:40 -0400604endif
605
Colin Cross0162cc82019-01-29 15:04:39 -0800606my_checked_module += $(LOCAL_ADDITIONAL_CHECKED_MODULE)
607
Joe Onoratoe334d252009-07-17 15:33:40 -0400608# If they request that this module not be checked, then don't.
609# PLEASE DON'T SET THIS. ANY PLACES THAT SET THIS WITHOUT
610# GOOD REASON WILL HAVE IT REMOVED.
611ifdef LOCAL_DONT_CHECK_MODULE
Ying Wang6c1d1cc2014-09-29 14:34:32 -0700612 my_checked_module :=
Joe Onoratoe334d252009-07-17 15:33:40 -0400613endif
Ying Wang966c1e02014-05-20 14:43:51 -0700614# Don't check build target module defined for the 2nd arch
615ifndef LOCAL_IS_HOST_MODULE
Ying Wang6ef65192014-01-15 16:02:16 -0800616ifdef LOCAL_2ND_ARCH_VAR_PREFIX
Ying Wang6c1d1cc2014-09-29 14:34:32 -0700617 my_checked_module :=
Ying Wang6ef65192014-01-15 16:02:16 -0800618endif
Ying Wang966c1e02014-05-20 14:43:51 -0700619endif
Joe Onoratoe334d252009-07-17 15:33:40 -0400620
The Android Open Source Project88b60792009-03-03 19:28:42 -0800621###########################################################
Simran Basi5691cb82017-12-04 14:44:16 -0800622## Test Data
623###########################################################
624my_test_data_pairs :=
625my_installed_test_data :=
626# Source to relative dst file paths for reuse in LOCAL_COMPATIBILITY_SUITE.
627my_test_data_file_pairs :=
628
Mitch Phillipsfd6d9022019-09-13 17:39:49 -0700629ifneq ($(strip $(filter NATIVE_TESTS,$(LOCAL_MODULE_CLASS)) $(LOCAL_IS_FUZZ_TARGET)),)
Simran Basi5691cb82017-12-04 14:44:16 -0800630ifneq ($(strip $(LOCAL_TEST_DATA)),)
631ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
632
Chris Parsons1abe7ef2020-07-17 15:27:27 -0400633# Soong LOCAL_TEST_DATA is of the form <from_base>:<file>:<relative_install_path>
634# or <from_base>:<file>, to be installed to
635# <install_root>/<relative_install_path>/<file> or <install_root>/<file>,
636# respectively.
Dan Willemsenc5ec8e92020-06-05 22:28:20 -0700637ifeq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
638 define copy_test_data_pairs
639 _src_base := $$(call word-colon,1,$$(td))
640 _file := $$(call word-colon,2,$$(td))
Chris Parsons1abe7ef2020-07-17 15:27:27 -0400641 _relative_install_path := $$(call word-colon,3,$$(td))
642 ifeq (,$$(_relative_install_path))
643 _relative_dest_file := $$(_file)
644 else
645 _relative_dest_file := $$(call append-path,$$(_relative_install_path),$$(_file))
646 endif
647 my_test_data_pairs += $$(call append-path,$$(_src_base),$$(_file)):$$(call append-path,$$(my_module_path),$$(_relative_dest_file))
648 my_test_data_file_pairs += $$(call append-path,$$(_src_base),$$(_file)):$$(_relative_dest_file)
Dan Willemsenc5ec8e92020-06-05 22:28:20 -0700649 endef
650else
651 define copy_test_data_pairs
652 _src_base := $$(call word-colon,1,$$(td))
653 _file := $$(call word-colon,2,$$(td))
654 ifndef _file
655 _file := $$(_src_base)
656 _src_base := $$(LOCAL_PATH)
657 endif
658 ifneq (,$$(findstring ..,$$(_file)))
659 $$(call pretty-error,LOCAL_TEST_DATA may not include '..': $$(_file))
660 endif
661 ifneq (,$$(filter/%,$$(_src_base) $$(_file)))
662 $$(call pretty-error,LOCAL_TEST_DATA may not include absolute paths: $$(_src_base) $$(_file))
663 endif
664 my_test_data_pairs += $$(call append-path,$$(_src_base),$$(_file)):$$(call append-path,$$(my_module_path),$$(_file))
665 my_test_data_file_pairs += $$(call append-path,$$(_src_base),$$(_file)):$$(_file)
666 endef
667endif
668
669$(foreach td,$(LOCAL_TEST_DATA),$(eval $(copy_test_data_pairs)))
670
671copy_test_data_pairs :=
Simran Basi5691cb82017-12-04 14:44:16 -0800672
Colin Cross20626462023-11-16 11:36:56 -0800673ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
674 my_installed_test_data := $(call copy-many-files,$(my_test_data_pairs))
675 $(LOCAL_INSTALLED_MODULE): $(my_installed_test_data)
676else
677 # Skip installing test data for Soong modules, it's already been handled.
678 # Just compute my_installed_test_data.
679 my_installed_test_data := $(foreach f, $(my_test_data_pairs), $(call word-colon,2,$(f)))
680endif
Simran Basi5691cb82017-12-04 14:44:16 -0800681
682endif
683endif
684endif
685
686###########################################################
Simran Basi6bea37c2017-02-16 18:04:10 -0800687## Compatibility suite files.
Ying Wang16243612015-06-03 12:43:50 -0700688###########################################################
689ifdef LOCAL_COMPATIBILITY_SUITE
Yike40f5c3a2023-02-14 12:27:59 +0800690
691ifneq (,$(LOCAL_FULL_TEST_CONFIG))
692 test_config := $(LOCAL_FULL_TEST_CONFIG)
693else ifneq (,$(LOCAL_TEST_CONFIG))
694 test_config := $(LOCAL_PATH)/$(LOCAL_TEST_CONFIG)
695else
696 test_config := $(wildcard $(LOCAL_PATH)/AndroidTest.xml)
697endif
698
Colin Crossfca369e2020-04-13 12:16:19 -0700699ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
Simran Basi3fb354c2017-02-08 15:53:32 -0800700
Simran Basi8a431d92017-04-04 12:47:19 -0700701# If we are building a native test or benchmark and its stem variants are not defined,
702# separate the multiple architectures into subdirectories of the testcase folder.
703arch_dir :=
704is_native :=
Simran Basi7160b062018-01-08 12:25:18 -0800705multi_arch :=
Simran Basi8a431d92017-04-04 12:47:19 -0700706ifeq ($(LOCAL_MODULE_CLASS),NATIVE_TESTS)
707 is_native := true
Simran Basi7160b062018-01-08 12:25:18 -0800708 multi_arch := true
Simran Basi8a431d92017-04-04 12:47:19 -0700709endif
Simran Basi8a431d92017-04-04 12:47:19 -0700710ifdef LOCAL_MULTILIB
Simran Basi7160b062018-01-08 12:25:18 -0800711 multi_arch := true
Trevor Radcliffe6bb8a1a2022-04-05 16:29:18 +0000712# These conditionals allow this functionality to be mimicked in Soong
Trevor Radcliffe74a4de72022-03-30 16:46:32 +0000713else ifeq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
714 ifeq ($(LOCAL_MODULE_CLASS),SHARED_LIBRARIES)
715 multi_arch := true
716 endif
Simran Basi8a431d92017-04-04 12:47:19 -0700717endif
Nelson Li1f8357f2019-03-14 01:04:05 +0000718
Simran Basi7160b062018-01-08 12:25:18 -0800719ifdef multi_arch
Nelson Li1f8357f2019-03-14 01:04:05 +0000720arch_dir := /$($(my_prefix)$(LOCAL_2ND_ARCH_VAR_PREFIX)ARCH)
721else
722ifeq ($(use_testcase_folder),true)
Simran Basi8a431d92017-04-04 12:47:19 -0700723 arch_dir := /$($(my_prefix)$(LOCAL_2ND_ARCH_VAR_PREFIX)ARCH)
Simran Basi8a431d92017-04-04 12:47:19 -0700724endif
Nelson Li1f8357f2019-03-14 01:04:05 +0000725endif
726
Simran Basi7160b062018-01-08 12:25:18 -0800727multi_arch :=
Simran Basi8a431d92017-04-04 12:47:19 -0700728
nelsonlife043512019-03-19 16:00:45 +0800729my_default_test_module :=
730my_default_test_module := $($(my_prefix)OUT_TESTCASES)/$(LOCAL_MODULE)$(arch_dir)/$(my_installed_module_stem)
731ifneq ($(LOCAL_INSTALLED_MODULE),$(my_default_test_module))
732# Install into the testcase folder
733$(LOCAL_INSTALLED_MODULE) : $(my_default_test_module)
734endif
735
Ying Wang719f1982015-10-20 18:18:40 -0700736# The module itself.
Simran Basi6bea37c2017-02-16 18:04:10 -0800737$(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
Colin Crossa69b8092021-11-03 13:15:59 -0700738 $(eval my_compat_dist_$(suite) := $(patsubst %:$(LOCAL_INSTALLED_MODULE),$(LOCAL_INSTALLED_MODULE):$(LOCAL_INSTALLED_MODULE),\
739 $(foreach dir, $(call compatibility_suite_dirs,$(suite),$(arch_dir)), \
740 $(LOCAL_BUILT_MODULE):$(dir)/$(my_installed_module_stem)))) \
Nelson Lia2a8b9b2018-06-25 05:47:53 +0000741 $(eval my_compat_dist_config_$(suite) := ))
Ying Wang719f1982015-10-20 18:18:40 -0700742
yangbill86f441d2018-07-13 22:55:36 +0800743
yangbillc9347b32018-08-23 23:04:37 +0800744# Auto-generate build config.
yangbillc9347b32018-08-23 23:04:37 +0800745ifeq (,$(test_config))
746 ifneq (true,$(is_native))
747 is_instrumentation_test := true
748 ifeq (true, $(LOCAL_IS_HOST_MODULE))
749 is_instrumentation_test := false
750 endif
751 # If LOCAL_MODULE_CLASS is not APPS, it's certainly not an instrumentation
752 # test. However, some packages for test data also have LOCAL_MODULE_CLASS
753 # set to APPS. These will require flag LOCAL_DISABLE_AUTO_GENERATE_TEST_CONFIG
754 # to disable auto-generating test config file.
755 ifneq (APPS, $(LOCAL_MODULE_CLASS))
756 is_instrumentation_test := false
757 endif
758 endif
759 # CTS modules can be used for test data, so test config files must be
760 # explicitly created using AndroidTest.xml
761 ifeq (,$(filter cts, $(LOCAL_COMPATIBILITY_SUITE)))
762 ifneq (true, $(LOCAL_DISABLE_AUTO_GENERATE_TEST_CONFIG))
763 ifeq (true, $(filter true,$(is_native) $(is_instrumentation_test)))
764 include $(BUILD_SYSTEM)/autogen_test_config.mk
765 test_config := $(autogen_test_config_file)
766 autogen_test_config_file :=
767 endif
768 endif
769 endif
770endif
771is_instrumentation_test :=
772
Yuntao Xu32a085c2021-05-27 10:19:48 -0700773# Currently this flag variable is true only for the `android_test_helper_app` type module
774# which should not have any .config file
775ifeq (true, $(LOCAL_DISABLE_TEST_CONFIG))
776 test_config :=
777endif
778
Ying Wang719f1982015-10-20 18:18:40 -0700779# Make sure we only add the files once for multilib modules.
yangbill86f441d2018-07-13 22:55:36 +0800780ifdef $(my_prefix)$(LOCAL_MODULE_CLASS)_$(LOCAL_MODULE)_compat_files
781 # Sync the auto_test_config value for multilib modules.
782 ifdef $(my_prefix)$(LOCAL_MODULE_CLASS)_$(LOCAL_MODULE)_autogen
783 ALL_MODULES.$(my_register_name).auto_test_config := true
Dan Shiefb892d2017-12-06 15:57:31 -0800784 endif
yangbill86f441d2018-07-13 22:55:36 +0800785else
786 $(my_prefix)$(LOCAL_MODULE_CLASS)_$(LOCAL_MODULE)_compat_files := true
787 # LOCAL_COMPATIBILITY_SUPPORT_FILES is a list of <src>[:<dest>].
788 $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
789 $(eval my_compat_dist_$(suite) += $(foreach f, $(LOCAL_COMPATIBILITY_SUPPORT_FILES), \
790 $(eval p := $(subst :,$(space),$(f))) \
791 $(eval s := $(word 1,$(p))) \
792 $(eval n := $(or $(word 2,$(p)),$(notdir $(word 1, $(p))))) \
793 $(foreach dir, $(call compatibility_suite_dirs,$(suite)), \
794 $(s):$(dir)/$(n)))))
Dan Shiefb892d2017-12-06 15:57:31 -0800795
yangbill86f441d2018-07-13 22:55:36 +0800796 ifneq (,$(test_config))
797 $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
798 $(eval my_compat_dist_config_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite)), \
799 $(test_config):$(dir)/$(LOCAL_MODULE).config)))
800 endif
Ying Wang16243612015-06-03 12:43:50 -0700801
Dan Shi0c9a5252020-08-15 12:27:42 -0700802 ifneq (,$(LOCAL_EXTRA_FULL_TEST_CONFIGS))
803 $(foreach test_config_file, $(LOCAL_EXTRA_FULL_TEST_CONFIGS), \
804 $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
805 $(eval my_compat_dist_config_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite)), \
Dan Shi22bc0992020-09-16 15:51:28 -0700806 $(test_config_file):$(dir)/$(basename $(notdir $(test_config_file))).config))))
Dan Shi0c9a5252020-08-15 12:27:42 -0700807 endif
808
yangbill86f441d2018-07-13 22:55:36 +0800809 ifneq (,$(wildcard $(LOCAL_PATH)/DynamicConfig.xml))
810 $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
811 $(eval my_compat_dist_config_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite)), \
812 $(LOCAL_PATH)/DynamicConfig.xml:$(dir)/$(LOCAL_MODULE).dynamic)))
813 endif
Simran Basi3e73e2b2017-04-19 16:10:45 -0700814
yangbill86f441d2018-07-13 22:55:36 +0800815 ifneq (,$(wildcard $(LOCAL_PATH)/$(LOCAL_MODULE)_*.config))
816 $(foreach extra_config, $(wildcard $(LOCAL_PATH)/$(LOCAL_MODULE)_*.config), \
817 $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
818 $(eval my_compat_dist_config_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite)), \
819 $(extra_config):$(dir)/$(notdir $(extra_config))))))
820 endif
Ying Wang719f1982015-10-20 18:18:40 -0700821endif # $(my_prefix)$(LOCAL_MODULE_CLASS)_$(LOCAL_MODULE)_compat_files
Stuart Scott8fe4bc72015-08-18 14:31:08 -0700822
Jaewoong Jung5ea69712019-09-13 19:02:46 +0000823
824ifeq ($(use_testcase_folder),true)
825ifneq ($(my_test_data_file_pairs),)
Jaewoong Jungb5aa16d2020-03-13 15:51:54 -0700826# Filter out existng installed test data paths when collecting test data files to be installed and
827# indexed as they cause build rule conflicts. Instead put them in a separate list which is only
828# used for indexing.
Jaewoong Jung5ea69712019-09-13 19:02:46 +0000829$(foreach pair, $(my_test_data_file_pairs), \
830 $(eval parts := $(subst :,$(space),$(pair))) \
831 $(eval src_path := $(word 1,$(parts))) \
832 $(eval file := $(word 2,$(parts))) \
833 $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
834 $(eval my_compat_dist_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite),$(arch_dir)), \
Jaewoong Jungb5aa16d2020-03-13 15:51:54 -0700835 $(call filter-copy-pair,$(src_path),$(call append-path,$(dir),$(file)),$(my_installed_test_data)))) \
836 $(eval my_compat_dist_test_data_$(suite) += \
837 $(foreach dir, $(call compatibility_suite_dirs,$(suite),$(arch_dir)), \
838 $(filter $(my_installed_test_data),$(call append-path,$(dir),$(file)))))))
Jaewoong Jung5ea69712019-09-13 19:02:46 +0000839endif
840else
Simran Basi5691cb82017-12-04 14:44:16 -0800841ifneq ($(my_test_data_file_pairs),)
842$(foreach pair, $(my_test_data_file_pairs), \
843 $(eval parts := $(subst :,$(space),$(pair))) \
844 $(eval src_path := $(word 1,$(parts))) \
845 $(eval file := $(word 2,$(parts))) \
846 $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
847 $(eval my_compat_dist_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite),$(arch_dir)), \
848 $(src_path):$(call append-path,$(dir),$(file))))))
849endif
Jaewoong Jung5ea69712019-09-13 19:02:46 +0000850endif
Nelson Li1f8357f2019-03-14 01:04:05 +0000851
852
Simran Basi5691cb82017-12-04 14:44:16 -0800853
Dan Willemsen41337932018-01-26 16:57:57 -0800854arch_dir :=
855is_native :=
856
Simran Basi6bea37c2017-02-16 18:04:10 -0800857$(call create-suite-dependencies)
Nelson Lia2a8b9b2018-06-25 05:47:53 +0000858$(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
Jaewoong Jungb5aa16d2020-03-13 15:51:54 -0700859 $(eval my_compat_dist_config_$(suite) := ) \
860 $(eval my_compat_dist_test_data_$(suite) := ))
Ying Wang25e01172015-09-17 12:24:56 -0700861
Colin Crossfca369e2020-04-13 12:16:19 -0700862endif # LOCAL_UNINSTALLABLE_MODULE
Yike40f5c3a2023-02-14 12:27:59 +0800863
864# HACK: pretend a soong LOCAL_FULL_TEST_CONFIG is autogenerated by setting the flag in
865# module-info.json
866# TODO: (b/113029686) Add explicit flag from Soong to determine if a test was
867# autogenerated.
868ifneq (,$(filter $(SOONG_OUT_DIR)%,$(LOCAL_FULL_TEST_CONFIG)))
869 ifeq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
870 ALL_MODULES.$(my_register_name).auto_test_config := true
871 endif
872endif
873
Ying Wang16243612015-06-03 12:43:50 -0700874endif # LOCAL_COMPATIBILITY_SUITE
875
yangbillb2219c72022-02-18 15:27:53 +0800876my_supported_variant :=
877ifeq ($(my_host_cross),true)
878 my_supported_variant := HOST_CROSS
879else
880 ifdef LOCAL_IS_HOST_MODULE
881 my_supported_variant := HOST
882 else
883 my_supported_variant := DEVICE
884 endif
885endif
Ying Wang16243612015-06-03 12:43:50 -0700886###########################################################
Dan Shi639c6cc2018-04-13 14:39:53 -0700887## Add test module to ALL_DISABLED_PRESUBMIT_TESTS if LOCAL_PRESUBMIT_DISABLED is set to true.
888###########################################################
889ifeq ($(LOCAL_PRESUBMIT_DISABLED),true)
890 ALL_DISABLED_PRESUBMIT_TESTS += $(LOCAL_MODULE)
891endif # LOCAL_PRESUBMIT_DISABLED
892
893###########################################################
The Android Open Source Project88b60792009-03-03 19:28:42 -0800894## Register with ALL_MODULES
895###########################################################
896
Dan Willemsen2abf1592019-08-26 23:25:17 -0700897ifndef ALL_MODULES.$(my_register_name).PATH
Dan Willemsen8e96a792019-04-02 14:43:32 -0700898 # These keys are no longer used, they've been replaced by keys that specify
899 # target/host/host_cross (REQUIRED_FROM_TARGET / REQUIRED_FROM_HOST) and similar.
900 #
901 # Marking them obsolete to ensure that anyone using these internal variables looks for
902 # alternates.
903 $(KATI_obsolete_var ALL_MODULES.$(my_register_name).REQUIRED)
904 $(KATI_obsolete_var ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED)
905 $(KATI_obsolete_var ALL_MODULES.$(my_register_name).HOST_REQUIRED)
906 $(KATI_obsolete_var ALL_MODULES.$(my_register_name).TARGET_REQUIRED)
907endif
908
Ying Wang6ef65192014-01-15 16:02:16 -0800909ALL_MODULES += $(my_register_name)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800910
911# Don't use += on subvars, or else they'll end up being
912# recursively expanded.
Ying Wang6ef65192014-01-15 16:02:16 -0800913ALL_MODULES.$(my_register_name).CLASS := \
914 $(ALL_MODULES.$(my_register_name).CLASS) $(LOCAL_MODULE_CLASS)
915ALL_MODULES.$(my_register_name).PATH := \
916 $(ALL_MODULES.$(my_register_name).PATH) $(LOCAL_PATH)
917ALL_MODULES.$(my_register_name).TAGS := \
Colin Crossaed37d72023-11-02 09:46:10 -0700918 $(ALL_MODULES.$(my_register_name).TAGS) $(LOCAL_MODULE_TAGS)
Ying Wang6ef65192014-01-15 16:02:16 -0800919ALL_MODULES.$(my_register_name).CHECKED := \
Ying Wang6c1d1cc2014-09-29 14:34:32 -0700920 $(ALL_MODULES.$(my_register_name).CHECKED) $(my_checked_module)
Ying Wang6ef65192014-01-15 16:02:16 -0800921ALL_MODULES.$(my_register_name).BUILT := \
922 $(ALL_MODULES.$(my_register_name).BUILT) $(LOCAL_BUILT_MODULE)
Wei Li49933362023-01-04 17:13:47 -0800923ALL_MODULES.$(my_register_name).SOONG_MODULE_TYPE := \
924 $(ALL_MODULES.$(my_register_name).SOONG_MODULE_TYPE) $(LOCAL_SOONG_MODULE_TYPE)
Vic Yang1b834132019-01-18 19:37:47 -0800925ifndef LOCAL_IS_HOST_MODULE
926ALL_MODULES.$(my_register_name).TARGET_BUILT := \
927 $(ALL_MODULES.$(my_register_name).TARGET_BUILT) $(LOCAL_BUILT_MODULE)
928endif
Colin Cross23ee3752021-09-24 15:48:03 -0700929ifneq (,$(LOCAL_SOONG_INSTALLED_MODULE))
930 # Store the list of paths to installed locations of files provided by this
931 # module. Used as dependencies of the image packaging rules when the module
932 # is installed by the current product.
933 ALL_MODULES.$(my_register_name).INSTALLED := \
934 $(strip $(ALL_MODULES.$(my_register_name).INSTALLED) \
935 $(foreach f, $(LOCAL_SOONG_INSTALL_PAIRS),\
936 $(word 2,$(subst :,$(space),$(f)))) \
937 $(LOCAL_SOONG_INSTALL_SYMLINKS) \
938 $(my_init_rc_installed) \
939 $(my_installed_test_data) \
940 $(my_vintf_installed))
Cole Faust075d9622023-08-21 11:47:39 -0700941
942 ALL_MODULES.$(my_register_name).INSTALLED_SYMLINKS := $(LOCAL_SOONG_INSTALL_SYMLINKS)
943
Colin Cross23ee3752021-09-24 15:48:03 -0700944 # Store the list of colon-separated pairs of the built and installed locations
945 # of files provided by this module. Used by custom packaging rules like
946 # package-modules.mk that need to copy the built files to a custom install
947 # location during packaging.
Colin Cross802f2112021-11-15 13:15:22 -0800948 #
949 # Translate copies from $(LOCAL_PREBUILT_MODULE_FILE) to $(LOCAL_BUILT_MODULE)
950 # so that package-modules.mk gets any transtive dependencies added to
951 # $(LOCAL_BUILT_MODULE), for example unstripped symbols files.
Colin Cross23ee3752021-09-24 15:48:03 -0700952 ALL_MODULES.$(my_register_name).BUILT_INSTALLED := \
953 $(strip $(ALL_MODULES.$(my_register_name).BUILT_INSTALLED) \
Colin Cross802f2112021-11-15 13:15:22 -0800954 $(patsubst $(LOCAL_PREBUILT_MODULE_FILE):%,$(LOCAL_BUILT_MODULE):%,$(LOCAL_SOONG_INSTALL_PAIRS)) \
Colin Cross23ee3752021-09-24 15:48:03 -0700955 $(my_init_rc_pairs) \
956 $(my_test_data_pairs) \
957 $(my_vintf_pairs))
Jooyung Han2ecded02023-07-05 16:00:36 +0900958 # Store the list of vintf/init_rc as order-only dependencies
959 ALL_MODULES.$(my_register_name).ORDERONLY_INSTALLED := \
960 $(strip $(ALL_MODULES.$(my_register_name).ORDERONLY_INSTALLED) \
961 $(my_init_rc_installed) \
962 $(my_vintf_installed))
Colin Cross23ee3752021-09-24 15:48:03 -0700963else ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
964 ALL_MODULES.$(my_register_name).INSTALLED := \
Ying Wang9fe15ac2015-08-20 12:02:10 -0700965 $(strip $(ALL_MODULES.$(my_register_name).INSTALLED) \
Dan Willemsend07ba4e2016-12-09 16:05:09 -0800966 $(LOCAL_INSTALLED_MODULE) $(my_init_rc_installed) $(my_installed_symlinks) \
Steven Moreland3629aa72018-04-04 15:41:05 -0700967 $(my_installed_test_data) $(my_vintf_installed))
Colin Cross23ee3752021-09-24 15:48:03 -0700968 ALL_MODULES.$(my_register_name).BUILT_INSTALLED := \
Ying Wang9fe15ac2015-08-20 12:02:10 -0700969 $(strip $(ALL_MODULES.$(my_register_name).BUILT_INSTALLED) \
970 $(LOCAL_BUILT_MODULE):$(LOCAL_INSTALLED_MODULE) \
Steven Moreland3629aa72018-04-04 15:41:05 -0700971 $(my_init_rc_pairs) $(my_test_data_pairs) $(my_vintf_pairs))
Jooyung Han2ecded02023-07-05 16:00:36 +0900972 ALL_MODULES.$(my_register_name).ORDERONLY_INSTALLED := \
973 $(strip $(ALL_MODULES.$(my_register_name).ORDERONLY_INSTALLED) \
974 $(my_init_rc_installed) \
975 $(my_vintf_installed))
Ying Wang3380d3a2014-05-19 13:03:36 -0700976endif
Cole Faustc67e7692023-09-01 16:15:00 -0700977
978# Mark LOCAL_SOONG_INSTALL_SYMLINKS as installed if we're installing any kind of module, not just
979# ones that set LOCAL_SOONG_INSTALLED_MODULE. This is so we can have a soong module that only
980# installs symlinks (e.g. installed_symlink). We can't set LOCAL_SOONG_INSTALLED_MODULE to a symlink
981# because cp commands will fail on symlinks.
982ifneq (,$(or $(LOCAL_SOONG_INSTALLED_MODULE),$(call boolean-not,$(LOCAL_UNINSTALLABLE_MODULE))))
983 ALL_MODULES.$(my_register_name).INSTALLED += $(LOCAL_SOONG_INSTALL_SYMLINKS)
984 ALL_MODULES.$(my_register_name).INSTALLED_SYMLINKS := $(LOCAL_SOONG_INSTALL_SYMLINKS)
985endif
986
Ying Wang3b81aab2014-05-05 16:46:52 -0700987ifdef LOCAL_PICKUP_FILES
988# Files or directories ready to pick up by the build system
989# when $(LOCAL_BUILT_MODULE) is done.
990ALL_MODULES.$(my_register_name).PICKUP_FILES := \
991 $(ALL_MODULES.$(my_register_name).PICKUP_FILES) $(LOCAL_PICKUP_FILES)
992endif
Jiyong Park403c2552020-05-04 11:12:00 +0000993# Record the platform availability of this module. Note that the availability is not
994# meaningful for non-installable modules (e.g., static libs) or host modules.
995# We only care about modules that are installable to the device.
996ifeq (true,$(LOCAL_NOT_AVAILABLE_FOR_PLATFORM))
997 ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
998 ifndef LOCAL_IS_HOST_MODULE
999 ALL_MODULES.$(my_register_name).NOT_AVAILABLE_FOR_PLATFORM := true
1000 endif
1001 endif
1002endif
Logan Chiend71fbfc2017-12-19 17:46:55 +08001003
Dan Willemsen7a549852015-08-13 17:51:40 -07001004my_required_modules := $(LOCAL_REQUIRED_MODULES) \
1005 $(LOCAL_REQUIRED_MODULES_$(TARGET_$(LOCAL_2ND_ARCH_VAR_PREFIX)ARCH))
1006ifdef LOCAL_IS_HOST_MODULE
1007my_required_modules += $(LOCAL_REQUIRED_MODULES_$($(my_prefix)OS))
1008endif
Logan Chiend71fbfc2017-12-19 17:46:55 +08001009
yangbill5f5e2362021-10-13 16:25:35 +08001010ALL_MODULES.$(my_register_name).SHARED_LIBS := \
1011 $(ALL_MODULES.$(my_register_name).SHARED_LIBS) $(LOCAL_SHARED_LIBRARIES)
1012
Devin Moore48d7b342023-05-15 18:08:30 +00001013ALL_MODULES.$(my_register_name).STATIC_LIBS := \
1014 $(ALL_MODULES.$(my_register_name).STATIC_LIBS) $(LOCAL_STATIC_LIBRARIES)
1015
yangbill5f5e2362021-10-13 16:25:35 +08001016ALL_MODULES.$(my_register_name).SYSTEM_SHARED_LIBS := \
1017 $(ALL_MODULES.$(my_register_name).SYSTEM_SHARED_LIBS) $(LOCAL_SYSTEM_SHARED_LIBRARIES)
1018
yangbillfa5026c2022-02-08 16:59:21 +08001019ALL_MODULES.$(my_register_name).LOCAL_RUNTIME_LIBRARIES := \
Yike82f0a2d2022-08-31 17:46:13 +08001020 $(ALL_MODULES.$(my_register_name).LOCAL_RUNTIME_LIBRARIES) $(LOCAL_RUNTIME_LIBRARIES) \
1021 $(LOCAL_JAVA_LIBRARIES)
1022
1023ALL_MODULES.$(my_register_name).LOCAL_STATIC_LIBRARIES := \
1024 $(ALL_MODULES.$(my_register_name).LOCAL_STATIC_LIBRARIES) $(LOCAL_STATIC_JAVA_LIBRARIES)
yangbillfa5026c2022-02-08 16:59:21 +08001025
Colin Cross7bf03bf2023-11-16 15:39:13 -08001026ifneq ($(my_test_data_file_pairs),)
yangbill724565d2021-12-21 18:59:33 +08001027 # Export the list of targets that are handled as data inputs and required
Colin Cross7bf03bf2023-11-16 15:39:13 -08001028 # by tests at runtime. The format of my_test_data_file_pairs is
1029 # is $(path):$(relative_file) but for module-info, only the string after
1030 # ":" is needed.
yangbill724565d2021-12-21 18:59:33 +08001031 ALL_MODULES.$(my_register_name).TEST_DATA := \
1032 $(strip $(ALL_MODULES.$(my_register_name).TEST_DATA) \
Colin Cross7bf03bf2023-11-16 15:39:13 -08001033 $(foreach f, $(my_test_data_file_pairs),\
yangbill724565d2021-12-21 18:59:33 +08001034 $(call word-colon,2,$(f))))
1035endif
1036
yangbille6b498b2022-02-11 18:27:32 +08001037ifdef LOCAL_TEST_DATA_BINS
1038 ALL_MODULES.$(my_register_name).TEST_DATA_BINS := \
1039 $(ALL_MODULES.$(my_register_name).TEST_DATA_BINS) $(LOCAL_TEST_DATA_BINS)
1040endif
1041
yangbillb2219c72022-02-18 15:27:53 +08001042ALL_MODULES.$(my_register_name).SUPPORTED_VARIANTS := \
1043 $(ALL_MODULES.$(my_register_name).SUPPORTED_VARIANTS) \
1044 $(filter-out $(ALL_MODULES.$(my_register_name).SUPPORTED_VARIANTS),$(my_supported_variant))
1045
Joe Onorato63a84552023-06-29 14:34:18 -07001046ALL_MODULES.$(my_register_name).ACONFIG_FILES := \
1047 $(ALL_MODULES.$(my_register_name).ACONFIG_FILES) $(LOCAL_ACONFIG_FILES)
1048
1049
Justin Yun2bfe0a12020-01-20 18:57:01 +09001050##########################################################################
Kiyoung Kimad0d7712022-08-31 14:02:36 +09001051## When compiling against API imported module, use API import stub
1052## libraries.
1053##########################################################################
1054ifneq ($(LOCAL_USE_VNDK),)
1055 ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
1056 apiimport_postfix := .apiimport
1057 ifeq ($(LOCAL_USE_VNDK_PRODUCT),true)
1058 apiimport_postfix := .apiimport.product
1059 else
1060 apiimport_postfix := .apiimport.vendor
1061 endif
1062
1063 my_required_modules := $(foreach l,$(my_required_modules), \
1064 $(if $(filter $(l), $(API_IMPORTED_SHARED_LIBRARIES)), $(l)$(apiimport_postfix), $(l)))
1065 endif
1066endif
1067
1068##########################################################################
Justin Yun2bfe0a12020-01-20 18:57:01 +09001069## When compiling against the VNDK, add the .vendor or .product suffix to
1070## required modules.
1071##########################################################################
Logan Chiend71fbfc2017-12-19 17:46:55 +08001072ifneq ($(LOCAL_USE_VNDK),)
Justin Yun2bfe0a12020-01-20 18:57:01 +09001073 #####################################################
1074 ## Soong modules may be built three times, once for
1075 ## /system, once for /vendor and once for /product.
1076 ## If we're using the VNDK, switch all soong
1077 ## libraries over to the /vendor or /product variant.
1078 #####################################################
Logan Chiend71fbfc2017-12-19 17:46:55 +08001079 ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
1080 # We don't do this renaming for soong-defined modules since they already
Justin Yun2bfe0a12020-01-20 18:57:01 +09001081 # have correct names (with .vendor or .product suffix when necessary) in
1082 # their LOCAL_*_LIBRARIES.
1083 ifeq ($(LOCAL_USE_VNDK_PRODUCT),true)
1084 my_required_modules := $(foreach l,$(my_required_modules),\
1085 $(if $(SPLIT_PRODUCT.SHARED_LIBRARIES.$(l)),$(l).product,$(l)))
1086 else
1087 my_required_modules := $(foreach l,$(my_required_modules),\
1088 $(if $(SPLIT_VENDOR.SHARED_LIBRARIES.$(l)),$(l).vendor,$(l)))
1089 endif
Logan Chiend71fbfc2017-12-19 17:46:55 +08001090 endif
1091endif
1092
Dan Willemsen8e96a792019-04-02 14:43:32 -07001093ifdef LOCAL_IS_HOST_MODULE
1094 ifneq ($(my_host_cross),true)
1095 ALL_MODULES.$(my_register_name).REQUIRED_FROM_HOST := \
1096 $(strip $(ALL_MODULES.$(my_register_name).REQUIRED_FROM_HOST) $(my_required_modules))
1097 ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_HOST := \
1098 $(strip $(ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_HOST)\
1099 $(my_required_modules))
1100 ALL_MODULES.$(my_register_name).TARGET_REQUIRED_FROM_HOST := \
1101 $(strip $(ALL_MODULES.$(my_register_name).TARGET_REQUIRED_FROM_HOST)\
1102 $(LOCAL_TARGET_REQUIRED_MODULES))
1103 else
1104 ALL_MODULES.$(my_register_name).REQUIRED_FROM_HOST_CROSS := \
1105 $(strip $(ALL_MODULES.$(my_register_name).REQUIRED_FROM_HOST_CROSS) $(my_required_modules))
1106 ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_HOST_CROSS := \
1107 $(strip $(ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_HOST_CROSS)\
1108 $(my_required_modules))
1109 ifdef LOCAL_TARGET_REQUIRED_MODULES
1110 $(call pretty-error,LOCAL_TARGET_REQUIRED_MODULES may not be used from host_cross modules)
1111 endif
1112 endif
1113 ifdef LOCAL_HOST_REQUIRED_MODULES
1114 $(call pretty-error,LOCAL_HOST_REQUIRED_MODULES may not be used from host modules. Use LOCAL_REQUIRED_MODULES instead)
1115 endif
1116else
1117 ALL_MODULES.$(my_register_name).REQUIRED_FROM_TARGET := \
1118 $(strip $(ALL_MODULES.$(my_register_name).REQUIRED_FROM_TARGET) $(my_required_modules))
1119 ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_TARGET := \
1120 $(strip $(ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_TARGET)\
1121 $(my_required_modules))
1122 ALL_MODULES.$(my_register_name).HOST_REQUIRED_FROM_TARGET := \
1123 $(strip $(ALL_MODULES.$(my_register_name).HOST_REQUIRED_FROM_TARGET)\
1124 $(LOCAL_HOST_REQUIRED_MODULES))
1125 ifdef LOCAL_TARGET_REQUIRED_MODULES
1126 $(call pretty-error,LOCAL_TARGET_REQUIRED_MODULES may not be used from target modules. Use LOCAL_REQUIRED_MODULES instead)
1127 endif
1128endif
Yasuhiro Matsudaff82e822015-09-04 16:23:49 +09001129ALL_MODULES.$(my_register_name).EVENT_LOG_TAGS := \
1130 $(ALL_MODULES.$(my_register_name).EVENT_LOG_TAGS) $(event_log_tags)
Ying Wang6ef65192014-01-15 16:02:16 -08001131ALL_MODULES.$(my_register_name).MAKEFILE := \
1132 $(ALL_MODULES.$(my_register_name).MAKEFILE) $(LOCAL_MODULE_MAKEFILE)
Ying Wangdbb31be2011-12-09 15:11:57 -08001133ifdef LOCAL_MODULE_OWNER
Ying Wang6ef65192014-01-15 16:02:16 -08001134ALL_MODULES.$(my_register_name).OWNER := \
1135 $(sort $(ALL_MODULES.$(my_register_name).OWNER) $(LOCAL_MODULE_OWNER))
Ying Wangdbb31be2011-12-09 15:11:57 -08001136endif
Ying Wang14a6cbd2014-02-10 22:26:23 -08001137ifdef LOCAL_2ND_ARCH_VAR_PREFIX
1138ALL_MODULES.$(my_register_name).FOR_2ND_ARCH := true
1139endif
Dan Willemsen057aaea2015-08-14 12:59:50 -07001140ALL_MODULES.$(my_register_name).FOR_HOST_CROSS := $(my_host_cross)
Morris Lina77d5a22018-08-07 21:22:21 +08001141ALL_MODULES.$(my_register_name).MODULE_NAME := $(LOCAL_MODULE)
yangbill6dd962f2021-12-08 15:30:23 +08001142ALL_MODULES.$(my_register_name).COMPATIBILITY_SUITES := \
1143 $(ALL_MODULES.$(my_register_name).COMPATIBILITY_SUITES) \
1144 $(filter-out $(ALL_MODULES.$(my_register_name).COMPATIBILITY_SUITES),$(LOCAL_COMPATIBILITY_SUITE))
yangbillc9347b32018-08-23 23:04:37 +08001145ALL_MODULES.$(my_register_name).TEST_CONFIG := $(test_config)
Dan Shi0c9a5252020-08-15 12:27:42 -07001146ALL_MODULES.$(my_register_name).EXTRA_TEST_CONFIGS := $(LOCAL_EXTRA_FULL_TEST_CONFIGS)
kellyhung0ba6ec62020-08-28 00:19:53 +08001147ALL_MODULES.$(my_register_name).TEST_MAINLINE_MODULES := $(LOCAL_TEST_MAINLINE_MODULES)
Jooyung Hanb27c2e82020-09-23 19:15:20 +09001148ifndef LOCAL_IS_HOST_MODULE
1149ALL_MODULES.$(my_register_name).FILE_CONTEXTS := $(LOCAL_FILE_CONTEXTS)
Jooyung Han8b162282023-10-30 16:22:53 +09001150ALL_MODULES.$(my_register_name).APEX_KEYS_FILE := $(LOCAL_APEX_KEY_PATH)
Jooyung Hanb27c2e82020-09-23 19:15:20 +09001151endif
yangbill877586c2021-04-19 20:30:17 +08001152ifdef LOCAL_IS_UNIT_TEST
yangbill732b8582021-01-08 17:36:56 +08001153ALL_MODULES.$(my_register_name).IS_UNIT_TEST := $(LOCAL_IS_UNIT_TEST)
yangbill877586c2021-04-19 20:30:17 +08001154endif
Zhenhuang Wang415ee122022-08-05 20:51:50 +08001155ifdef LOCAL_TEST_OPTIONS_TAGS
1156ALL_MODULES.$(my_register_name).TEST_OPTIONS_TAGS := $(LOCAL_TEST_OPTIONS_TAGS)
1157endif
yangbillc9347b32018-08-23 23:04:37 +08001158test_config :=
The Android Open Source Project88b60792009-03-03 19:28:42 -08001159
Ying Wang6ef65192014-01-15 16:02:16 -08001160INSTALLABLE_FILES.$(LOCAL_INSTALLED_MODULE).MODULE := $(my_register_name)
Joe Onorato8a06bac2010-05-21 14:29:29 -07001161
Ying Wang39b9b692015-05-07 12:08:53 -07001162##########################################################
1163# Track module-level dependencies.
Jim Tang5c6410e2021-11-03 16:13:05 +08001164# (b/204397180) Unlock RECORD_ALL_DEPS was acknowledged reasonable for better Atest performance.
Colin Cross9cb51b72023-11-14 11:06:08 -08001165ALL_MODULES.$(my_register_name).ALL_DEPS := \
1166 $(ALL_MODULES.$(my_register_name).ALL_DEPS) \
Ying Wang39b9b692015-05-07 12:08:53 -07001167 $(LOCAL_STATIC_LIBRARIES) \
1168 $(LOCAL_WHOLE_STATIC_LIBRARIES) \
1169 $(LOCAL_SHARED_LIBRARIES) \
Ivan Lozanod62e7122019-08-27 11:23:35 -07001170 $(LOCAL_DYLIB_LIBRARIES) \
1171 $(LOCAL_RLIB_LIBRARIES) \
1172 $(LOCAL_PROC_MACRO_LIBRARIES) \
Dan Willemsen8dae49c2017-02-15 15:48:11 -08001173 $(LOCAL_HEADER_LIBRARIES) \
Ying Wang39b9b692015-05-07 12:08:53 -07001174 $(LOCAL_STATIC_JAVA_LIBRARIES) \
Martin Stjernholm43ee3552019-06-05 21:10:29 +01001175 $(LOCAL_JAVA_LIBRARIES) \
Colin Cross9cb51b72023-11-14 11:06:08 -08001176 $(LOCAL_JNI_SHARED_LIBRARIES)
Ying Wang39b9b692015-05-07 12:08:53 -07001177
The Android Open Source Project88b60792009-03-03 19:28:42 -08001178###########################################################
Ying Wangef4d82f2013-01-29 16:59:18 -08001179## umbrella targets used to verify builds
1180###########################################################
Ying Wangef4d82f2013-01-29 16:59:18 -08001181j_or_n :=
Ivan Lozanod62e7122019-08-27 11:23:35 -07001182ifneq (,$(filter EXECUTABLES SHARED_LIBRARIES STATIC_LIBRARIES HEADER_LIBRARIES NATIVE_TESTS RLIB_LIBRARIES DYLIB_LIBRARIES PROC_MACRO_LIBRARIES,$(LOCAL_MODULE_CLASS)))
Ying Wangef4d82f2013-01-29 16:59:18 -08001183j_or_n := native
1184else
1185ifneq (,$(filter JAVA_LIBRARIES APPS,$(LOCAL_MODULE_CLASS)))
1186j_or_n := java
Ying Wangef4d82f2013-01-29 16:59:18 -08001187endif
1188endif
1189ifdef LOCAL_IS_HOST_MODULE
1190h_or_t := host
Colin Crossd76e2e62016-12-09 13:08:27 -08001191ifeq ($(my_host_cross),true)
1192h_or_hc_or_t := host-cross
Ying Wangef4d82f2013-01-29 16:59:18 -08001193else
Colin Crossd76e2e62016-12-09 13:08:27 -08001194h_or_hc_or_t := host
1195endif
1196else
1197h_or_hc_or_t := target
Ying Wangef4d82f2013-01-29 16:59:18 -08001198h_or_t := target
1199endif
1200
Colin Crossd76e2e62016-12-09 13:08:27 -08001201
Ying Wangef4d82f2013-01-29 16:59:18 -08001202ifdef j_or_n
Dan Willemsenc01ad7b2017-11-29 20:54:41 -08001203$(j_or_n) $(h_or_t) $(j_or_n)-$(h_or_hc_or_t) : $(my_checked_module)
Colin Crossaed37d72023-11-02 09:46:10 -07001204ifneq (,$(filter $(LOCAL_MODULE_TAGS),tests))
Ying Wang6c1d1cc2014-09-29 14:34:32 -07001205$(j_or_n)-$(h_or_t)-tests $(j_or_n)-tests $(h_or_t)-tests : $(my_checked_module)
Ying Wangef4d82f2013-01-29 16:59:18 -08001206endif
Colin Crossd76e2e62016-12-09 13:08:27 -08001207$(LOCAL_MODULE)-$(h_or_hc_or_t) : $(my_all_targets)
Dan Willemsen14e10262018-06-17 21:54:21 -07001208.PHONY: $(LOCAL_MODULE)-$(h_or_hc_or_t)
Colin Crossd76e2e62016-12-09 13:08:27 -08001209ifeq ($(j_or_n),native)
1210$(LOCAL_MODULE)-$(h_or_hc_or_t)$(my_32_64_bit_suffix) : $(my_all_targets)
Dan Willemsen14e10262018-06-17 21:54:21 -07001211.PHONY: $(LOCAL_MODULE)-$(h_or_hc_or_t)$(my_32_64_bit_suffix)
Colin Crossd76e2e62016-12-09 13:08:27 -08001212endif
Ying Wangef4d82f2013-01-29 16:59:18 -08001213endif
1214
1215###########################################################
Nicolas Geoffrayb06c30b2017-09-19 11:51:45 +00001216# Ensure privileged applications always have LOCAL_PRIVILEGED_MODULE
1217###########################################################
1218ifndef LOCAL_PRIVILEGED_MODULE
1219 ifneq (,$(filter $(TARGET_OUT_APPS_PRIVILEGED)/% $(TARGET_OUT_VENDOR_APPS_PRIVILEGED)/%,$(my_module_path)))
1220 LOCAL_PRIVILEGED_MODULE := true
1221 endif
1222endif
1223
1224###########################################################
The Android Open Source Project88b60792009-03-03 19:28:42 -08001225## NOTICE files
1226###########################################################
1227
Ying Wang13d69502012-11-01 17:22:33 -07001228include $(BUILD_NOTICE_FILE)
Wei Li49933362023-01-04 17:13:47 -08001229
1230###########################################################
1231## SBOM generation
1232###########################################################
Devin Moore48d7b342023-05-15 18:08:30 +00001233include $(BUILD_SBOM_GEN)