blob: 7ea9b528da85cfb2d3f9c908cb1a064d348c7aa7 [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
23$(if $(base-rules-hook),)
24endif
25
26###########################################################
27## Common instructions for a generic module.
28###########################################################
29
30LOCAL_MODULE := $(strip $(LOCAL_MODULE))
31ifeq ($(LOCAL_MODULE),)
32 $(error $(LOCAL_PATH): LOCAL_MODULE is not defined)
33endif
Dan Willemsenbbe6a022018-06-10 14:49:01 -070034$(call verify-module-name)
The Android Open Source Project88b60792009-03-03 19:28:42 -080035
Bob Badour42f00c72022-03-19 23:20:59 -070036my_test_data :=
37my_test_config :=
38
The Android Open Source Project88b60792009-03-03 19:28:42 -080039LOCAL_IS_HOST_MODULE := $(strip $(LOCAL_IS_HOST_MODULE))
40ifdef LOCAL_IS_HOST_MODULE
41 ifneq ($(LOCAL_IS_HOST_MODULE),true)
42 $(error $(LOCAL_PATH): LOCAL_IS_HOST_MODULE must be "true" or empty, not "$(LOCAL_IS_HOST_MODULE)")
43 endif
Dan Willemsen057aaea2015-08-14 12:59:50 -070044 ifeq ($(LOCAL_HOST_PREFIX),)
45 my_prefix := HOST_
46 else
47 my_prefix := $(LOCAL_HOST_PREFIX)
48 endif
Ying Wang13d69502012-11-01 17:22:33 -070049 my_host := host-
Alexey Polyudovccdc3112016-08-01 17:41:49 -070050 my_kind := HOST
The Android Open Source Project88b60792009-03-03 19:28:42 -080051else
Dan Willemsen58634e12020-03-06 18:09:06 -080052 my_prefix := TARGET_
53 my_kind :=
Ying Wang13d69502012-11-01 17:22:33 -070054 my_host :=
The Android Open Source Project88b60792009-03-03 19:28:42 -080055endif
56
Dan Willemsen057aaea2015-08-14 12:59:50 -070057ifeq ($(my_prefix),HOST_CROSS_)
58 my_host_cross := true
59else
60 my_host_cross :=
61endif
62
Dario Frenif31bc452018-07-12 19:44:33 +010063ifeq (true, $(LOCAL_PRODUCT_MODULE))
64ifneq (,$(filter $(LOCAL_MODULE),$(PRODUCT_FORCE_PRODUCT_MODULES_TO_SYSTEM_PARTITION)))
65 LOCAL_PRODUCT_MODULE :=
66endif
67endif
68
Jiyong Park003ea362017-11-15 18:22:14 +090069_path := $(LOCAL_MODULE_PATH) $(LOCAL_MODULE_PATH_32) $(LOCAL_MODULE_PATH_64)
70ifneq ($(filter $(TARGET_OUT_VENDOR)%,$(_path)),)
71LOCAL_VENDOR_MODULE := true
72else ifneq ($(filter $(TARGET_OUT_OEM)/%,$(_path)),)
73LOCAL_OEM_MODULE := true
74else ifneq ($(filter $(TARGET_OUT_ODM)/%,$(_path)),)
75LOCAL_ODM_MODULE := true
Jaekyun Seokb7735d82017-11-27 17:04:47 +090076else ifneq ($(filter $(TARGET_OUT_PRODUCT)/%,$(_path)),)
77LOCAL_PRODUCT_MODULE := true
Justin Yun6151e3f2019-06-25 15:58:13 +090078else ifneq ($(filter $(TARGET_OUT_SYSTEM_EXT)/%,$(_path)),)
79LOCAL_SYSTEM_EXT_MODULE := true
Jiyong Park003ea362017-11-15 18:22:14 +090080endif
81_path :=
82
Justin Yun6151e3f2019-06-25 15:58:13 +090083# TODO(b/135957588) Remove following workaround
84# LOCAL_PRODUCT_SERVICES_MODULE to LOCAL_PRODUCT_MODULE for all Android.mk
85ifndef LOCAL_PRODUCT_MODULE
86LOCAL_PRODUCT_MODULE := $(LOCAL_PRODUCT_SERVICES_MODULE)
87endif
88
Dan Willemsen05a2b932017-03-20 18:31:17 -070089ifndef LOCAL_PROPRIETARY_MODULE
90 LOCAL_PROPRIETARY_MODULE := $(LOCAL_VENDOR_MODULE)
91endif
92ifndef LOCAL_VENDOR_MODULE
93 LOCAL_VENDOR_MODULE := $(LOCAL_PROPRIETARY_MODULE)
94endif
95ifneq ($(filter-out $(LOCAL_PROPRIETARY_MODULE),$(LOCAL_VENDOR_MODULE))$(filter-out $(LOCAL_VENDOR_MODULE),$(LOCAL_PROPRIETARY_MODULE)),)
96$(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)
97endif
98
Inseob Kimce839562020-08-10 13:03:22 +090099ifeq ($(LOCAL_HOST_MODULE),true)
100my_image_variant := host
101else ifeq ($(LOCAL_VENDOR_MODULE),true)
102my_image_variant := vendor
103else ifeq ($(LOCAL_OEM_MODULE),true)
104my_image_variant := vendor
105else ifeq ($(LOCAL_ODM_MODULE),true)
106my_image_variant := vendor
107else ifeq ($(LOCAL_PRODUCT_MODULE),true)
108my_image_variant := product
109else
110my_image_variant := core
111endif
112
Jeongik Cha83c50322019-01-18 15:09:09 +0900113non_system_module := $(filter true, \
114 $(LOCAL_PRODUCT_MODULE) \
Justin Yun6151e3f2019-06-25 15:58:13 +0900115 $(LOCAL_SYSTEM_EXT_MODULE) \
Jeongik Cha83c50322019-01-18 15:09:09 +0900116 $(LOCAL_VENDOR_MODULE) \
117 $(LOCAL_PROPRIETARY_MODULE))
118
Dan Willemsenbab0fa62016-11-18 14:05:39 -0800119include $(BUILD_SYSTEM)/local_vndk.mk
Jiyong Park641b6cc2018-01-15 14:48:40 +0900120include $(BUILD_SYSTEM)/local_systemsdk.mk
Jeongik Cha0d1d9812020-08-20 20:21:36 +0900121include $(BUILD_SYSTEM)/local_current_sdk.mk
Dan Willemsenbab0fa62016-11-18 14:05:39 -0800122
Ying Wang37bd1f22014-01-27 15:19:09 -0800123my_module_tags := $(LOCAL_MODULE_TAGS)
Dan Willemsen057aaea2015-08-14 12:59:50 -0700124ifeq ($(my_host_cross),true)
125 my_module_tags :=
126endif
Ying Wang37bd1f22014-01-27 15:19:09 -0800127
Colin Crossa4447e82015-09-28 16:26:00 -0700128# Ninja has an implicit dependency on the command being run, and kati will
129# regenerate the ninja manifest if any read makefile changes, so there is no
130# need to have dependencies on makefiles.
131# This won't catch all the cases where LOCAL_ADDITIONAL_DEPENDENCIES contains
132# a .mk file, because a few users of LOCAL_ADDITIONAL_DEPENDENCIES don't include
133# base_rules.mk, but it will fix the most common ones.
134LOCAL_ADDITIONAL_DEPENDENCIES := $(filter-out %.mk,$(LOCAL_ADDITIONAL_DEPENDENCIES))
Colin Crossa4447e82015-09-28 16:26:00 -0700135
Dan Willemsen0c821a92017-10-23 22:14:21 -0700136my_bad_deps := $(strip $(foreach dep,$(filter-out | ||,$(LOCAL_ADDITIONAL_DEPENDENCIES)),\
137 $(if $(findstring /,$(dep)),,$(dep))))
138ifneq ($(my_bad_deps),)
139$(call pretty-warning,"Bad LOCAL_ADDITIONAL_DEPENDENCIES: $(my_bad_deps)")
140$(call pretty-error,"LOCAL_ADDITIONAL_DEPENDENCIES must only contain paths (not module names)")
141endif
142
The Android Open Source Project88b60792009-03-03 19:28:42 -0800143###########################################################
144## Validate and define fallbacks for input LOCAL_* variables.
145###########################################################
146
147## Dump a .csv file of all modules and their tags
148#ifneq ($(tag-list-first-time),false)
149#$(shell rm -f tag-list.csv)
150#tag-list-first-time := false
151#endif
Ying Wang37bd1f22014-01-27 15:19:09 -0800152#$(shell echo $(lastword $(filter-out config/% out/%,$(MAKEFILE_LIST))),$(LOCAL_MODULE),$(strip $(LOCAL_MODULE_CLASS)),$(subst $(space),$(comma),$(sort $(my_module_tags))) >> tag-list.csv)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800153
Ying Wang6e371e42012-05-15 14:31:26 -0700154LOCAL_UNINSTALLABLE_MODULE := $(strip $(LOCAL_UNINSTALLABLE_MODULE))
Ying Wang37bd1f22014-01-27 15:19:09 -0800155my_module_tags := $(sort $(my_module_tags))
156ifeq (,$(my_module_tags))
157 my_module_tags := optional
Ying Wang2fd81cf2010-12-10 11:17:28 -0800158endif
Joe Onorato918ee312012-05-18 20:43:14 -0700159
Joe Onorato6a185e42012-05-22 14:08:50 -0700160# User tags are not allowed anymore. Fail early because it will not be installed
161# like it used to be.
Ying Wang37bd1f22014-01-27 15:19:09 -0800162ifneq ($(filter $(my_module_tags),user),)
Joe Onorato6a185e42012-05-22 14:08:50 -0700163 $(warning *** Module name: $(LOCAL_MODULE))
164 $(warning *** Makefile location: $(LOCAL_MODULE_MAKEFILE))
165 $(warning * )
166 $(warning * Module is attempting to use the 'user' tag. This)
167 $(warning * used to cause the module to be installed automatically.)
168 $(warning * Now, the module must be listed in the PRODUCT_PACKAGES)
169 $(warning * section of a product makefile to have it installed.)
170 $(warning * )
171 $(error user tag detected on module.)
172endif
The Android Open Source Project88b60792009-03-03 19:28:42 -0800173
Dan Willemsen9569ddd2019-01-22 19:38:56 -0800174my_bad_module_tags := $(filter eng debug,$(my_module_tags))
175ifdef my_bad_module_tags
176 ifeq (true,$(LOCAL_UNINSTALLABLE_MODULE))
177 $(call pretty-warning,LOCAL_MODULE_TAGS := $(my_bad_module_tags) does not do anything for uninstallable modules)
178 endif
Dan Willemsene048f7e2019-02-09 18:58:36 -0800179 $(call pretty-error,LOCAL_MODULE_TAGS := $(my_bad_module_tags) is obsolete. See $(CHANGES_URL)#LOCAL_MODULE_TAGS)
Dan Willemsen9569ddd2019-01-22 19:38:56 -0800180endif
181
Jean-Baptiste Querua831cbd2010-01-07 11:06:50 -0800182# Only the tags mentioned in this test are expected to be set by module
183# makefiles. Anything else is either a typo or a source of unexpected
184# behaviors.
Dan Willemsene048f7e2019-02-09 18:58:36 -0800185ifneq ($(filter-out tests optional samples,$(my_module_tags)),)
186$(call pretty-error,unusual tags: $(filter-out tests optional samples,$(my_module_tags)))
Jean-Baptiste Querua831cbd2010-01-07 11:06:50 -0800187endif
188
The Android Open Source Project88b60792009-03-03 19:28:42 -0800189# Add implicit tags.
190#
191# If the local directory or one of its parents contains a MODULE_LICENSE_GPL
Andrew Boie08a943b2013-12-10 13:52:00 -0800192# file, tag the module as "gnu". Search for "*_GPL*", "*_LGPL*" and "*_MPL*"
193# so that we can also find files like MODULE_LICENSE_GPL_AND_AFL
The Android Open Source Project88b60792009-03-03 19:28:42 -0800194#
Andrew Boie08a943b2013-12-10 13:52:00 -0800195gpl_license_file := $(call find-parent-file,$(LOCAL_PATH),MODULE_LICENSE*_GPL* MODULE_LICENSE*_MPL* MODULE_LICENSE*_LGPL*)
Ying Wangfd626f22011-12-12 12:57:38 -0800196ifneq ($(gpl_license_file),)
Ying Wang37bd1f22014-01-27 15:19:09 -0800197 my_module_tags += gnu
Dan Willemsen8447b812020-06-08 21:00:18 -0700198 ALL_GPL_MODULE_LICENSE_FILES += $(gpl_license_file)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800199endif
200
The Android Open Source Project88b60792009-03-03 19:28:42 -0800201LOCAL_MODULE_CLASS := $(strip $(LOCAL_MODULE_CLASS))
202ifneq ($(words $(LOCAL_MODULE_CLASS)),1)
203 $(error $(LOCAL_PATH): LOCAL_MODULE_CLASS must contain exactly one word, not "$(LOCAL_MODULE_CLASS)")
204endif
205
Ying Wang6feb6d52014-04-17 10:03:35 -0700206my_32_64_bit_suffix := $(if $($(LOCAL_2ND_ARCH_VAR_PREFIX)$(my_prefix)IS_64_BIT),64,32)
Colin Cross87974052014-03-21 12:25:44 -0700207
Ying Wang6e371e42012-05-15 14:31:26 -0700208ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
Colin Cross87974052014-03-21 12:25:44 -0700209my_multilib_module_path := $(strip $(LOCAL_MODULE_PATH_$(my_32_64_bit_suffix)))
Colin Cross87974052014-03-21 12:25:44 -0700210ifdef my_multilib_module_path
211my_module_path := $(my_multilib_module_path)
212else
Ying Wangb8e01852014-01-23 15:09:04 -0800213my_module_path := $(strip $(LOCAL_MODULE_PATH))
Colin Cross87974052014-03-21 12:25:44 -0700214endif
Dan Willemsene0bba6f2016-12-09 21:15:41 -0800215my_module_path := $(patsubst %/,%,$(my_module_path))
Colin Cross639c3362014-01-24 19:23:40 -0800216my_module_relative_path := $(strip $(LOCAL_MODULE_RELATIVE_PATH))
Sasha Smundakf15ff832020-05-06 13:46:30 -0700217
Dan Willemsenb2a5c7b2017-02-13 13:41:43 -0800218ifdef LOCAL_IS_HOST_MODULE
219 partition_tag :=
Bill Peckham19c3feb2020-03-20 18:31:43 -0700220 actual_partition_tag :=
Dan Willemsenb2a5c7b2017-02-13 13:41:43 -0800221else
joker.yanga75c9a52019-04-03 09:10:37 +0800222ifeq (true,$(strip $(LOCAL_VENDOR_MODULE)))
Dan Willemsenb2a5c7b2017-02-13 13:41:43 -0800223 partition_tag := _VENDOR
Bill Peckham19c3feb2020-03-20 18:31:43 -0700224 # A vendor module could be on the vendor partition at "vendor" or the system
225 # partition at "system/vendor".
226 actual_partition_tag := $(if $(filter true,$(BOARD_USES_VENDORIMAGE)),vendor,system)
joker.yanga75c9a52019-04-03 09:10:37 +0800227else ifeq (true,$(strip $(LOCAL_OEM_MODULE)))
Dan Willemsenb2a5c7b2017-02-13 13:41:43 -0800228 partition_tag := _OEM
Bill Peckham19c3feb2020-03-20 18:31:43 -0700229 actual_partition_tag := oem
joker.yanga75c9a52019-04-03 09:10:37 +0800230else ifeq (true,$(strip $(LOCAL_ODM_MODULE)))
Dan Willemsenb2a5c7b2017-02-13 13:41:43 -0800231 partition_tag := _ODM
Bill Peckham19c3feb2020-03-20 18:31:43 -0700232 # An ODM module could be on the odm partition at "odm", the vendor partition
233 # at "vendor/odm", or the system partition at "system/vendor/odm".
234 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 +0800235else ifeq (true,$(strip $(LOCAL_PRODUCT_MODULE)))
Jaekyun Seokb7735d82017-11-27 17:04:47 +0900236 partition_tag := _PRODUCT
Bill Peckham19c3feb2020-03-20 18:31:43 -0700237 # A product module could be on the product partition at "product" or the
238 # system partition at "system/product".
239 actual_partition_tag := $(if $(filter true,$(BOARD_USES_PRODUCTIMAGE)),product,system)
Justin Yun6151e3f2019-06-25 15:58:13 +0900240else ifeq (true,$(strip $(LOCAL_SYSTEM_EXT_MODULE)))
241 partition_tag := _SYSTEM_EXT
Bill Peckham19c3feb2020-03-20 18:31:43 -0700242 # A system_ext-specific module could be on the system_ext partition at
243 # "system_ext" or the system partition at "system/system_ext".
244 actual_partition_tag := $(if $(filter true,$(BOARD_USES_SYSTEM_EXTIMAGE)),system_ext,system)
Dan Willemsenb2a5c7b2017-02-13 13:41:43 -0800245else ifeq (NATIVE_TESTS,$(LOCAL_MODULE_CLASS))
246 partition_tag := _DATA
Bill Peckham19c3feb2020-03-20 18:31:43 -0700247 actual_partition_tag := data
Dan Willemsenb2a5c7b2017-02-13 13:41:43 -0800248else
249 # The definition of should-install-to-system will be different depending
250 # on which goal (e.g., sdk or just droid) is being built.
251 partition_tag := $(if $(call should-install-to-system,$(my_module_tags)),,_DATA)
Bill Peckham19c3feb2020-03-20 18:31:43 -0700252 actual_partition_tag := $(if $(partition_tag),data,system)
Dan Willemsenb2a5c7b2017-02-13 13:41:43 -0800253endif
254endif
Nelson Li1f8357f2019-03-14 01:04:05 +0000255# For test modules that lack a suite tag, set null-suite as the default.
256# We only support adding a default suite to native tests, native benchmarks, and instrumentation tests.
257# This is because they are the only tests we currently auto-generate test configs for.
258ifndef LOCAL_COMPATIBILITY_SUITE
259 ifneq ($(filter NATIVE_TESTS NATIVE_BENCHMARK, $(LOCAL_MODULE_CLASS)),)
260 LOCAL_COMPATIBILITY_SUITE := null-suite
261 endif
262 ifneq ($(filter APPS, $(LOCAL_MODULE_CLASS)),)
263 ifneq ($(filter $(my_module_tags),tests),)
264 LOCAL_COMPATIBILITY_SUITE := null-suite
265 endif
266 endif
267endif
268
269use_testcase_folder :=
Sasha Smundakda25b692019-03-25 13:26:03 -0700270ifeq ($(my_module_path),)
271 ifneq ($(LOCAL_MODULE),$(filter $(LOCAL_MODULE),$(DEFAULT_DATA_OUT_MODULES)))
272 ifdef LOCAL_COMPATIBILITY_SUITE
273 ifneq (true, $(LOCAL_IS_HOST_MODULE))
274 use_testcase_folder := true
Nelson Li1f8357f2019-03-14 01:04:05 +0000275 endif
276 endif
277 endif
278endif
279
Dan Shi41f62912020-11-11 16:25:20 -0800280ifeq ($(LOCAL_IS_UNIT_TEST),true)
281 ifeq ($(LOCAL_IS_HOST_MODULE),true)
282 LOCAL_COMPATIBILITY_SUITE += host-unit-tests
283 endif
284endif
285
Jiyong Park842a9852017-01-20 09:01:17 +0900286ifeq ($(my_module_path),)
Dan Willemsende4e71b2017-03-16 16:51:46 -0700287 install_path_var := $(LOCAL_2ND_ARCH_VAR_PREFIX)$(my_prefix)OUT$(partition_tag)_$(LOCAL_MODULE_CLASS)
288 ifeq (true,$(LOCAL_PRIVILEGED_MODULE))
289 install_path_var := $(install_path_var)_PRIVILEGED
290 endif
Jiyong Park842a9852017-01-20 09:01:17 +0900291
Dan Willemsende4e71b2017-03-16 16:51:46 -0700292 my_module_path := $($(install_path_var))
Nelson Li1f8357f2019-03-14 01:04:05 +0000293
294 # If use_testcase_folder be set, and LOCAL_MODULE_PATH not set,
295 # overwrite the default path under testcase.
296 ifeq ($(use_testcase_folder),true)
297 arch_dir := $($(my_prefix)$(LOCAL_2ND_ARCH_VAR_PREFIX)ARCH)
298 testcase_folder := $($(my_prefix)OUT_TESTCASES)/$(LOCAL_MODULE)/$(arch_dir)
299 my_module_path := $(testcase_folder)
300 arch_dir :=
301 endif
302
Dan Willemsende4e71b2017-03-16 16:51:46 -0700303 ifeq ($(strip $(my_module_path)),)
304 $(error $(LOCAL_PATH): unhandled install path "$(install_path_var) for $(LOCAL_MODULE)")
Jiyong Park842a9852017-01-20 09:01:17 +0900305 endif
Colin Cross639c3362014-01-24 19:23:40 -0800306endif
Dan Willemsende4e71b2017-03-16 16:51:46 -0700307ifneq ($(my_module_relative_path),)
308 my_module_path := $(my_module_path)/$(my_module_relative_path)
309endif
Ying Wang6e371e42012-05-15 14:31:26 -0700310endif # not LOCAL_UNINSTALLABLE_MODULE
The Android Open Source Project88b60792009-03-03 19:28:42 -0800311
312ifneq ($(strip $(LOCAL_BUILT_MODULE)$(LOCAL_INSTALLED_MODULE)),)
313 $(error $(LOCAL_PATH): LOCAL_BUILT_MODULE and LOCAL_INSTALLED_MODULE must not be defined by component makefiles)
314endif
315
Ying Wang6ef65192014-01-15 16:02:16 -0800316my_register_name := $(LOCAL_MODULE)
Dan Willemsen057aaea2015-08-14 12:59:50 -0700317ifeq ($(my_host_cross),true)
318 my_register_name := host_cross_$(LOCAL_MODULE)
319endif
Dan Willemsen9ecbf832016-02-05 16:20:19 -0800320ifdef LOCAL_2ND_ARCH_VAR_PREFIX
321ifndef LOCAL_NO_2ND_ARCH_MODULE_SUFFIX
322my_register_name := $(my_register_name)$($(my_prefix)2ND_ARCH_MODULE_SUFFIX)
323endif
324endif
Alexey Polyudovccdc3112016-08-01 17:41:49 -0700325
Colin Crossaaf888a2016-09-07 12:48:30 -0700326ifeq ($(my_host_cross),true)
327 my_all_targets := host_cross_$(my_register_name)_all_targets
328else ifneq ($(LOCAL_IS_HOST_MODULE),)
329 my_all_targets := host_$(my_register_name)_all_targets
330else
331 my_all_targets := device_$(my_register_name)_all_targets
332endif
333
The Android Open Source Project88b60792009-03-03 19:28:42 -0800334# Make sure that this IS_HOST/CLASS/MODULE combination is unique.
335module_id := MODULE.$(if \
Dan Willemsen58634e12020-03-06 18:09:06 -0800336 $(LOCAL_IS_HOST_MODULE),$($(my_prefix)OS),TARGET).$(LOCAL_MODULE_CLASS).$(my_register_name)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800337ifdef $(module_id)
338$(error $(LOCAL_PATH): $(module_id) already defined by $($(module_id)))
339endif
340$(module_id) := $(LOCAL_PATH)
341
Dan Willemsen8447b812020-06-08 21:00:18 -0700342# These are the same as local-intermediates-dir / local-generated-sources dir, but faster
343intermediates.COMMON := $($(my_prefix)OUT_COMMON_INTERMEDIATES)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
344ifneq (,$(filter $(my_prefix)$(LOCAL_MODULE_CLASS),$(COMMON_MODULE_CLASSES)))
345 intermediates := $($(my_prefix)OUT_COMMON_INTERMEDIATES)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
346 generated_sources_dir := $($(my_prefix)OUT_COMMON_GEN)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
347else
348 ifneq (,$(filter $(LOCAL_MODULE_CLASS),$(PER_ARCH_MODULE_CLASSES)))
349 intermediates := $($(LOCAL_2ND_ARCH_VAR_PREFIX)$(my_prefix)OUT_INTERMEDIATES)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
350 else
351 intermediates := $($(my_prefix)OUT_INTERMEDIATES)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
352 endif
353 generated_sources_dir := $($(my_prefix)OUT_GEN)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
354endif
The Android Open Source Project88b60792009-03-03 19:28:42 -0800355
Jiyong Parkcbf76f62017-03-24 19:31:49 +0900356ifneq ($(LOCAL_OVERRIDES_MODULES),)
dimitry3142e292018-11-07 10:39:34 +0100357 ifndef LOCAL_IS_HOST_MODULE
358 ifeq ($(LOCAL_MODULE_CLASS),EXECUTABLES)
Jiyong Parkcbf76f62017-03-24 19:31:49 +0900359 EXECUTABLES.$(LOCAL_MODULE).OVERRIDES := $(strip $(LOCAL_OVERRIDES_MODULES))
dimitry3142e292018-11-07 10:39:34 +0100360 else ifeq ($(LOCAL_MODULE_CLASS),SHARED_LIBRARIES)
361 SHARED_LIBRARIES.$(LOCAL_MODULE).OVERRIDES := $(strip $(LOCAL_OVERRIDES_MODULES))
Jaewoong Jung7c7dfcd2019-11-06 14:08:59 -0800362 else ifeq ($(LOCAL_MODULE_CLASS),ETC)
363 ETC.$(LOCAL_MODULE).OVERRIDES := $(strip $(LOCAL_OVERRIDES_MODULES))
Jiyong Parkcbf76f62017-03-24 19:31:49 +0900364 else
dimitry3142e292018-11-07 10:39:34 +0100365 $(call pretty-error,LOCAL_MODULE_CLASS := $(LOCAL_MODULE_CLASS) cannot use LOCAL_OVERRIDES_MODULES)
Jiyong Parkcbf76f62017-03-24 19:31:49 +0900366 endif
367 else
dimitry3142e292018-11-07 10:39:34 +0100368 $(call pretty-error,host modules cannot use LOCAL_OVERRIDES_MODULES)
Jiyong Parkcbf76f62017-03-24 19:31:49 +0900369 endif
370endif
371
The Android Open Source Project88b60792009-03-03 19:28:42 -0800372###########################################################
373# Pick a name for the intermediate and final targets
374###########################################################
Colin Cross5a9db902014-03-21 12:27:37 -0700375include $(BUILD_SYSTEM)/configure_module_stem.mk
The Android Open Source Project88b60792009-03-03 19:28:42 -0800376
Dan Willemsen0cf52d82017-05-15 23:38:04 -0700377LOCAL_BUILT_MODULE := $(intermediates)/$(my_built_module_stem)
378
Colin Cross23ee3752021-09-24 15:48:03 -0700379ifneq (,$(LOCAL_SOONG_INSTALLED_MODULE))
380 ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
381 $(call pretty-error, LOCAL_SOONG_INSTALLED_MODULE can only be used from $(SOONG_ANDROID_MK))
382 endif
383 # Use the install path requested by Soong.
384 LOCAL_INSTALLED_MODULE := $(LOCAL_SOONG_INSTALLED_MODULE)
385else ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
Ying Wangaf9757e2014-07-17 21:24:42 -0700386 # Apk and its attachments reside in its own subdir.
387 ifeq ($(LOCAL_MODULE_CLASS),APPS)
Sasha Smundakf15ff832020-05-06 13:46:30 -0700388 # framework-res.apk doesn't like the additional layer.
389 ifeq ($(LOCAL_NO_STANDARD_LIBRARIES),true)
390 # Neither do Runtime Resource Overlay apks, which contain just the overlaid resources.
391 else ifeq ($(LOCAL_IS_RUNTIME_RESOURCE_OVERLAY),true)
392 else
393 ifneq ($(use_testcase_folder),true)
394 my_module_path := $(my_module_path)/$(LOCAL_MODULE)
395 endif
Nelson Li1f8357f2019-03-14 01:04:05 +0000396 endif
Ying Wangaf9757e2014-07-17 21:24:42 -0700397 endif
Ying Wang966c1e02014-05-20 14:43:51 -0700398 LOCAL_INSTALLED_MODULE := $(my_module_path)/$(my_installed_module_stem)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800399endif
400
401# Assemble the list of targets to create PRIVATE_ variables for.
402LOCAL_INTERMEDIATE_TARGETS += $(LOCAL_BUILT_MODULE)
403
Yasuhiro Matsudaff82e822015-09-04 16:23:49 +0900404###########################################################
Shinichiro Hamaji0e7587a2015-10-09 14:36:04 +0900405## Create .toc files from shared objects to reduce unnecessary rebuild
406# .toc files have the list of external dynamic symbols without their addresses.
Shinichiro Hamaji89b255a2015-11-09 16:47:42 +0900407# As .KATI_RESTAT is specified to .toc files and commit-change-for-toc is used,
408# dependent binaries of a .toc file will be rebuilt only when the content of
Shinichiro Hamaji0e7587a2015-10-09 14:36:04 +0900409# the .toc file is changed.
Colin Cross8fb525d2018-09-06 16:25:22 -0700410#
411# Don't create .toc files for Soong shared libraries, that is handled in
412# Soong and soong_cc_prebuilt.mk
Shinichiro Hamaji0e7587a2015-10-09 14:36:04 +0900413###########################################################
Colin Cross8fb525d2018-09-06 16:25:22 -0700414ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
Shinichiro Hamaji0e7587a2015-10-09 14:36:04 +0900415ifeq ($(LOCAL_MODULE_CLASS),SHARED_LIBRARIES)
416LOCAL_INTERMEDIATE_TARGETS += $(LOCAL_BUILT_MODULE).toc
417$(LOCAL_BUILT_MODULE).toc: $(LOCAL_BUILT_MODULE)
Shinichiro Hamaji0e7587a2015-10-09 14:36:04 +0900418 $(call $(PRIVATE_2ND_ARCH_VAR_PREFIX)$(PRIVATE_PREFIX)transform-shared-lib-to-toc,$<,$@.tmp)
Shinichiro Hamaji89b255a2015-11-09 16:47:42 +0900419 $(call commit-change-for-toc,$@)
Shinichiro Hamaji0e7587a2015-10-09 14:36:04 +0900420
421# Kati adds restat=1 to ninja. GNU make does nothing for this.
422.KATI_RESTAT: $(LOCAL_BUILT_MODULE).toc
Colin Crosse2b8f682016-02-04 13:28:04 -0800423# Build .toc file when using mm, mma, or make $(my_register_name)
Colin Crossaaf888a2016-09-07 12:48:30 -0700424$(my_all_targets): $(LOCAL_BUILT_MODULE).toc
Shinichiro Hamaji0e7587a2015-10-09 14:36:04 +0900425endif
Colin Cross8fb525d2018-09-06 16:25:22 -0700426endif
Shinichiro Hamaji0e7587a2015-10-09 14:36:04 +0900427
428###########################################################
Yasuhiro Matsudaff82e822015-09-04 16:23:49 +0900429## logtags: Add .logtags files to global list
430###########################################################
431
Dan Willemsenb0a08b82016-06-01 15:27:11 -0700432logtags_sources := $(filter %.logtags,$(LOCAL_SRC_FILES)) $(LOCAL_LOGTAGS_FILES)
Yasuhiro Matsudaff82e822015-09-04 16:23:49 +0900433
434ifneq ($(strip $(logtags_sources)),)
Dan Willemsenbbe4e112019-06-12 17:13:28 +0000435event_log_tags := $(foreach f,$(addprefix $(LOCAL_PATH)/,$(logtags_sources)),$(call clean-path,$(f)))
Yasuhiro Matsudaff82e822015-09-04 16:23:49 +0900436else
437event_log_tags :=
438endif
The Android Open Source Project88b60792009-03-03 19:28:42 -0800439
440###########################################################
The Android Open Source Project88b60792009-03-03 19:28:42 -0800441## make clean- targets
442###########################################################
Ying Wang6ef65192014-01-15 16:02:16 -0800443cleantarget := clean-$(my_register_name)
Dan Willemsen7a1da0e2018-07-24 01:21:12 -0700444.PHONY: $(cleantarget)
Ying Wang6ef65192014-01-15 16:02:16 -0800445$(cleantarget) : PRIVATE_MODULE := $(my_register_name)
Ying Wang4d063412013-03-22 18:52:57 -0700446$(cleantarget) : PRIVATE_CLEAN_FILES := \
Ying Wang95221ca2012-11-07 14:07:34 -0800447 $(LOCAL_BUILT_MODULE) \
448 $(LOCAL_INSTALLED_MODULE) \
449 $(intermediates)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800450$(cleantarget)::
451 @echo "Clean: $(PRIVATE_MODULE)"
452 $(hide) rm -rf $(PRIVATE_CLEAN_FILES)
453
454###########################################################
455## Common definitions for module.
456###########################################################
The Android Open Source Project88b60792009-03-03 19:28:42 -0800457$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_PATH:=$(LOCAL_PATH)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800458$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_IS_HOST_MODULE := $(LOCAL_IS_HOST_MODULE)
459$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_HOST:= $(my_host)
Dan Willemsen057aaea2015-08-14 12:59:50 -0700460$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_PREFIX := $(my_prefix)
461
Dima Zavin46e9bec2009-05-27 19:41:07 -0700462$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_INTERMEDIATES_DIR:= $(intermediates)
Ying Wang6feb6d52014-04-17 10:03:35 -0700463$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_2ND_ARCH_VAR_PREFIX := $(LOCAL_2ND_ARCH_VAR_PREFIX)
464
The Android Open Source Project88b60792009-03-03 19:28:42 -0800465# Tell the module and all of its sub-modules who it is.
Ying Wang6ef65192014-01-15 16:02:16 -0800466$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_MODULE:= $(my_register_name)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800467
468# Provide a short-hand for building this module.
469# We name both BUILT and INSTALLED in case
470# LOCAL_UNINSTALLABLE_MODULE is set.
Colin Crossaaf888a2016-09-07 12:48:30 -0700471.PHONY: $(my_all_targets)
Colin Cross0162cc82019-01-29 15:04:39 -0800472$(my_all_targets): $(LOCAL_BUILT_MODULE) $(LOCAL_INSTALLED_MODULE) $(LOCAL_ADDITIONAL_CHECKED_MODULE)
Colin Crossaaf888a2016-09-07 12:48:30 -0700473
Ying Wang6ef65192014-01-15 16:02:16 -0800474.PHONY: $(my_register_name)
Colin Crossaaf888a2016-09-07 12:48:30 -0700475$(my_register_name): $(my_all_targets)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800476
Ying Wang71c58092016-03-23 11:02:03 -0700477ifneq ($(my_register_name),$(LOCAL_MODULE))
478# $(LOCAL_MODULE) covers all the multilib targets.
479.PHONY: $(LOCAL_MODULE)
Colin Crossaaf888a2016-09-07 12:48:30 -0700480$(LOCAL_MODULE) : $(my_all_targets)
Ying Wang71c58092016-03-23 11:02:03 -0700481endif
482
Ying Wangcaeaa082015-09-23 16:08:55 -0700483# Set up phony targets that covers all modules under the given paths.
484# This allows us to build everything in given paths by running mmma/mma.
Dan Willemsen343caec2020-06-08 23:10:14 -0700485define my_path_comp
486parent := $(patsubst %/,%,$(dir $(1)))
487parent_target := MODULES-IN-$$(subst /,-,$$(parent))
488.PHONY: $$(parent_target)
489$$(parent_target): $(2)
490ifndef $$(parent_target)
491 $$(parent_target) := true
492 ifneq (,$$(findstring /,$$(parent)))
493 $$(eval $$(call my_path_comp,$$(parent),$$(parent_target)))
494 endif
495endif
496endef
497
498_local_path := $(patsubst %/,%,$(LOCAL_PATH))
499_local_path_target := MODULES-IN-$(subst /,-,$(_local_path))
500
501.PHONY: $(_local_path_target)
502$(_local_path_target): $(my_register_name)
503
504ifndef $(_local_path_target)
505 $(_local_path_target) := true
Yo Chiang150a1ca2020-08-08 20:10:59 +0800506 ifneq (,$(findstring /,$(_local_path)))
507 $(eval $(call my_path_comp,$(_local_path),$(_local_path_target)))
508 endif
Dan Willemsen343caec2020-06-08 23:10:14 -0700509endif
510
511_local_path :=
512_local_path_target :=
513my_path_comp :=
Ying Wangcaeaa082015-09-23 16:08:55 -0700514
The Android Open Source Project88b60792009-03-03 19:28:42 -0800515###########################################################
516## Module installation rule
517###########################################################
518
Colin Cross744d33b2016-07-14 16:02:57 -0700519my_installed_symlinks :=
Nelson Li1f8357f2019-03-14 01:04:05 +0000520
Colin Cross23ee3752021-09-24 15:48:03 -0700521ifneq (,$(LOCAL_SOONG_INSTALLED_MODULE))
522 # Soong already generated the copy rule, but make the installed location depend on the Make
523 # copy of the intermediates for now, as some rules that collect intermediates may expect
524 # them to exist.
525 $(LOCAL_INSTALLED_MODULE): $(LOCAL_BUILT_MODULE)
Colin Crossd954ea82021-11-08 11:34:29 -0800526
527 $(foreach symlink, $(LOCAL_SOONG_INSTALL_SYMLINKS), \
528 $(call declare-0p-target,$(symlink)))
529 $(my_all_targets) : | $(LOCAL_SOONG_INSTALL_SYMLINKS)
Colin Cross23ee3752021-09-24 15:48:03 -0700530else ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
Colin Crossa69b8092021-11-03 13:15:59 -0700531 $(LOCAL_INSTALLED_MODULE): PRIVATE_POST_INSTALL_CMD := $(LOCAL_POST_INSTALL_CMD)
532 $(LOCAL_INSTALLED_MODULE): $(LOCAL_BUILT_MODULE)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800533 @echo "Install: $@"
Colin Crossa69b8092021-11-03 13:15:59 -0700534 ifeq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
Martin Stjernholm49a4e9b2020-08-21 16:36:23 +0100535 $(copy-file-or-link-to-new-target)
Colin Crossa69b8092021-11-03 13:15:59 -0700536 else
Ying Wang84ed6fa2011-01-18 17:21:20 -0800537 $(copy-file-to-new-target)
Colin Cross23ee3752021-09-24 15:48:03 -0700538 endif
Colin Crossa69b8092021-11-03 13:15:59 -0700539 $(PRIVATE_POST_INSTALL_CMD)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800540
Colin Cross23ee3752021-09-24 15:48:03 -0700541 # Rule to install the module's companion symlinks
542 my_installed_symlinks := $(addprefix $(my_module_path)/,$(LOCAL_MODULE_SYMLINKS) $(LOCAL_MODULE_SYMLINKS_$(my_32_64_bit_suffix)))
543 $(foreach symlink,$(my_installed_symlinks),\
Bob Badour879cfa82021-04-15 10:41:38 -0700544 $(call symlink-file,$(LOCAL_INSTALLED_MODULE),$(my_installed_module_stem),$(symlink))\
545 $(call declare-0p-target,$(symlink)))
Dan Willemsen435360a2016-07-27 22:52:42 -0700546
Colin Cross23ee3752021-09-24 15:48:03 -0700547 $(my_all_targets) : | $(my_installed_symlinks)
Colin Cross6d34b612016-08-24 15:20:23 -0700548
Ying Wang9fe15ac2015-08-20 12:02:10 -0700549endif # !LOCAL_UNINSTALLABLE_MODULE
Joe Onoratoe334d252009-07-17 15:33:40 -0400550
551###########################################################
Colin Cross23ee3752021-09-24 15:48:03 -0700552## VINTF manifest fragment and init.rc goals
Steven Moreland3629aa72018-04-04 15:41:05 -0700553###########################################################
554
555my_vintf_installed:=
Steven Morelandb1861832021-11-01 17:58:28 -0700556my_vintf_path:=
Steven Moreland3629aa72018-04-04 15:41:05 -0700557my_vintf_pairs:=
Colin Cross23ee3752021-09-24 15:48:03 -0700558my_init_rc_installed :=
559my_init_rc_path :=
560my_init_rc_pairs :=
Steven Moreland3629aa72018-04-04 15:41:05 -0700561ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
Colin Cross23ee3752021-09-24 15:48:03 -0700562 ifndef LOCAL_IS_HOST_MODULE
563 # Rule to install the module's companion vintf fragments.
564 ifneq ($(strip $(LOCAL_FULL_VINTF_FRAGMENTS)),)
565 my_vintf_fragments := $(LOCAL_FULL_VINTF_FRAGMENTS)
566 else
567 my_vintf_fragments := $(foreach xml,$(LOCAL_VINTF_FRAGMENTS),$(LOCAL_PATH)/$(xml))
568 endif
569 ifneq ($(strip $(my_vintf_fragments)),)
Steven Morelandb1861832021-11-01 17:58:28 -0700570 # Make doesn't support recovery as an output partition, but some Soong modules installed in recovery
571 # have init.rc files that need to be installed alongside them. Manually handle the case where the
572 # output file is in the recovery partition.
573 my_vintf_path := $(if $(filter $(TARGET_RECOVERY_ROOT_OUT)/%,$(my_module_path)),$(TARGET_RECOVERY_ROOT_OUT)/system/etc,$(TARGET_OUT$(partition_tag)_ETC))
574 my_vintf_pairs := $(foreach xml,$(my_vintf_fragments),$(xml):$(my_vintf_path)/vintf/manifest/$(notdir $(xml)))
Colin Cross23ee3752021-09-24 15:48:03 -0700575 my_vintf_installed := $(foreach xml,$(my_vintf_pairs),$(call word-colon,2,$(xml)))
Steven Moreland3629aa72018-04-04 15:41:05 -0700576
Colin Cross23ee3752021-09-24 15:48:03 -0700577 # Only set up copy rules once, even if another arch variant shares it
578 my_vintf_new_pairs := $(filter-out $(ALL_VINTF_MANIFEST_FRAGMENTS_LIST),$(my_vintf_pairs))
579 my_vintf_new_installed := $(call copy-many-vintf-manifest-files-checked,$(my_vintf_new_pairs))
Steven Moreland3629aa72018-04-04 15:41:05 -0700580
Colin Cross23ee3752021-09-24 15:48:03 -0700581 ALL_VINTF_MANIFEST_FRAGMENTS_LIST += $(my_vintf_new_pairs)
Steven Moreland3629aa72018-04-04 15:41:05 -0700582
Colin Cross23ee3752021-09-24 15:48:03 -0700583 $(my_all_targets) : $(my_vintf_new_installed)
584 endif # my_vintf_fragments
585
586 # Rule to install the module's companion init.rc.
587 ifneq ($(strip $(LOCAL_FULL_INIT_RC)),)
588 my_init_rc := $(LOCAL_FULL_INIT_RC)
589 else
590 my_init_rc := $(foreach rc,$(LOCAL_INIT_RC_$(my_32_64_bit_suffix)) $(LOCAL_INIT_RC),$(LOCAL_PATH)/$(rc))
591 endif
592 ifneq ($(strip $(my_init_rc)),)
Kelvin Zhang701f1612022-04-13 16:40:06 -0700593 # Make doesn't support recovery or ramdisk as an output partition,
594 # but some Soong modules installed in recovery or ramdisk
595 # have init.rc files that need to be installed alongside them.
596 # Manually handle the case where the
597 # output file is in the recovery or ramdisk partition.
598 ifneq (,$(filter $(TARGET_RECOVERY_ROOT_OUT)/%,$(my_module_path)))
599 my_init_rc_path := $(TARGET_RECOVERY_ROOT_OUT)/system/etc
600 else ifneq (,$(filter $(TARGET_RAMDISK_OUT)/%,$(my_module_path)))
601 my_init_rc_path := $(TARGET_RAMDISK_OUT)/system/etc
602 else
603 my_init_rc_path := $(TARGET_OUT$(partition_tag)_ETC)
604 endif
Colin Cross23ee3752021-09-24 15:48:03 -0700605 my_init_rc_pairs := $(foreach rc,$(my_init_rc),$(rc):$(my_init_rc_path)/init/$(notdir $(rc)))
606 my_init_rc_installed := $(foreach rc,$(my_init_rc_pairs),$(call word-colon,2,$(rc)))
607
608 # Make sure we only set up the copy rules once, even if another arch variant
609 # shares a common LOCAL_INIT_RC.
610 my_init_rc_new_pairs := $(filter-out $(ALL_INIT_RC_INSTALLED_PAIRS),$(my_init_rc_pairs))
611 my_init_rc_new_installed := $(call copy-many-init-script-files-checked,$(my_init_rc_new_pairs))
612
613 ALL_INIT_RC_INSTALLED_PAIRS += $(my_init_rc_new_pairs)
614
615 $(my_all_targets) : $(my_init_rc_installed)
616 endif # my_init_rc
617
618 endif # !LOCAL_IS_HOST_MODULE
Steven Moreland3629aa72018-04-04 15:41:05 -0700619endif # !LOCAL_UNINSTALLABLE_MODULE
620
621###########################################################
Joe Onoratoe334d252009-07-17 15:33:40 -0400622## CHECK_BUILD goals
623###########################################################
Ying Wang6c1d1cc2014-09-29 14:34:32 -0700624my_checked_module :=
Joe Onoratoe334d252009-07-17 15:33:40 -0400625# If nobody has defined a more specific module for the
Ying Wang5a8d3452013-01-30 14:43:05 -0800626# checked modules, use LOCAL_BUILT_MODULE.
Ying Wang6c1d1cc2014-09-29 14:34:32 -0700627ifdef LOCAL_CHECKED_MODULE
628 my_checked_module := $(LOCAL_CHECKED_MODULE)
629else
630 my_checked_module := $(LOCAL_BUILT_MODULE)
Joe Onoratoe334d252009-07-17 15:33:40 -0400631endif
632
Colin Cross0162cc82019-01-29 15:04:39 -0800633my_checked_module += $(LOCAL_ADDITIONAL_CHECKED_MODULE)
634
Joe Onoratoe334d252009-07-17 15:33:40 -0400635# If they request that this module not be checked, then don't.
636# PLEASE DON'T SET THIS. ANY PLACES THAT SET THIS WITHOUT
637# GOOD REASON WILL HAVE IT REMOVED.
638ifdef LOCAL_DONT_CHECK_MODULE
Ying Wang6c1d1cc2014-09-29 14:34:32 -0700639 my_checked_module :=
Joe Onoratoe334d252009-07-17 15:33:40 -0400640endif
Ying Wang966c1e02014-05-20 14:43:51 -0700641# Don't check build target module defined for the 2nd arch
642ifndef LOCAL_IS_HOST_MODULE
Ying Wang6ef65192014-01-15 16:02:16 -0800643ifdef LOCAL_2ND_ARCH_VAR_PREFIX
Ying Wang6c1d1cc2014-09-29 14:34:32 -0700644 my_checked_module :=
Ying Wang6ef65192014-01-15 16:02:16 -0800645endif
Ying Wang966c1e02014-05-20 14:43:51 -0700646endif
Joe Onoratoe334d252009-07-17 15:33:40 -0400647
The Android Open Source Project88b60792009-03-03 19:28:42 -0800648###########################################################
Simran Basi5691cb82017-12-04 14:44:16 -0800649## Test Data
650###########################################################
651my_test_data_pairs :=
652my_installed_test_data :=
653# Source to relative dst file paths for reuse in LOCAL_COMPATIBILITY_SUITE.
654my_test_data_file_pairs :=
655
Mitch Phillipsfd6d9022019-09-13 17:39:49 -0700656ifneq ($(strip $(filter NATIVE_TESTS,$(LOCAL_MODULE_CLASS)) $(LOCAL_IS_FUZZ_TARGET)),)
Simran Basi5691cb82017-12-04 14:44:16 -0800657ifneq ($(strip $(LOCAL_TEST_DATA)),)
658ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
659
Chris Parsons1abe7ef2020-07-17 15:27:27 -0400660# Soong LOCAL_TEST_DATA is of the form <from_base>:<file>:<relative_install_path>
661# or <from_base>:<file>, to be installed to
662# <install_root>/<relative_install_path>/<file> or <install_root>/<file>,
663# respectively.
Dan Willemsenc5ec8e92020-06-05 22:28:20 -0700664ifeq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
665 define copy_test_data_pairs
666 _src_base := $$(call word-colon,1,$$(td))
667 _file := $$(call word-colon,2,$$(td))
Chris Parsons1abe7ef2020-07-17 15:27:27 -0400668 _relative_install_path := $$(call word-colon,3,$$(td))
669 ifeq (,$$(_relative_install_path))
670 _relative_dest_file := $$(_file)
671 else
672 _relative_dest_file := $$(call append-path,$$(_relative_install_path),$$(_file))
673 endif
674 my_test_data_pairs += $$(call append-path,$$(_src_base),$$(_file)):$$(call append-path,$$(my_module_path),$$(_relative_dest_file))
675 my_test_data_file_pairs += $$(call append-path,$$(_src_base),$$(_file)):$$(_relative_dest_file)
Dan Willemsenc5ec8e92020-06-05 22:28:20 -0700676 endef
677else
678 define copy_test_data_pairs
679 _src_base := $$(call word-colon,1,$$(td))
680 _file := $$(call word-colon,2,$$(td))
681 ifndef _file
682 _file := $$(_src_base)
683 _src_base := $$(LOCAL_PATH)
684 endif
685 ifneq (,$$(findstring ..,$$(_file)))
686 $$(call pretty-error,LOCAL_TEST_DATA may not include '..': $$(_file))
687 endif
688 ifneq (,$$(filter/%,$$(_src_base) $$(_file)))
689 $$(call pretty-error,LOCAL_TEST_DATA may not include absolute paths: $$(_src_base) $$(_file))
690 endif
691 my_test_data_pairs += $$(call append-path,$$(_src_base),$$(_file)):$$(call append-path,$$(my_module_path),$$(_file))
692 my_test_data_file_pairs += $$(call append-path,$$(_src_base),$$(_file)):$$(_file)
693 endef
694endif
695
696$(foreach td,$(LOCAL_TEST_DATA),$(eval $(copy_test_data_pairs)))
697
698copy_test_data_pairs :=
Simran Basi5691cb82017-12-04 14:44:16 -0800699
700my_installed_test_data := $(call copy-many-files,$(my_test_data_pairs))
701$(LOCAL_INSTALLED_MODULE): $(my_installed_test_data)
702
703endif
704endif
705endif
706
707###########################################################
Simran Basi6bea37c2017-02-16 18:04:10 -0800708## Compatibility suite files.
Ying Wang16243612015-06-03 12:43:50 -0700709###########################################################
710ifdef LOCAL_COMPATIBILITY_SUITE
Colin Crossfca369e2020-04-13 12:16:19 -0700711ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
Simran Basi3fb354c2017-02-08 15:53:32 -0800712
Simran Basi8a431d92017-04-04 12:47:19 -0700713# If we are building a native test or benchmark and its stem variants are not defined,
714# separate the multiple architectures into subdirectories of the testcase folder.
715arch_dir :=
716is_native :=
Simran Basi7160b062018-01-08 12:25:18 -0800717multi_arch :=
Simran Basi8a431d92017-04-04 12:47:19 -0700718ifeq ($(LOCAL_MODULE_CLASS),NATIVE_TESTS)
719 is_native := true
Simran Basi7160b062018-01-08 12:25:18 -0800720 multi_arch := true
Simran Basi8a431d92017-04-04 12:47:19 -0700721endif
Simran Basi8a431d92017-04-04 12:47:19 -0700722ifdef LOCAL_MULTILIB
Simran Basi7160b062018-01-08 12:25:18 -0800723 multi_arch := true
Trevor Radcliffe6bb8a1a2022-04-05 16:29:18 +0000724# These conditionals allow this functionality to be mimicked in Soong
Trevor Radcliffe74a4de72022-03-30 16:46:32 +0000725else ifeq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
726 ifeq ($(LOCAL_MODULE_CLASS),SHARED_LIBRARIES)
727 multi_arch := true
728 endif
Simran Basi8a431d92017-04-04 12:47:19 -0700729endif
Nelson Li1f8357f2019-03-14 01:04:05 +0000730
Simran Basi7160b062018-01-08 12:25:18 -0800731ifdef multi_arch
Nelson Li1f8357f2019-03-14 01:04:05 +0000732arch_dir := /$($(my_prefix)$(LOCAL_2ND_ARCH_VAR_PREFIX)ARCH)
733else
734ifeq ($(use_testcase_folder),true)
Simran Basi8a431d92017-04-04 12:47:19 -0700735 arch_dir := /$($(my_prefix)$(LOCAL_2ND_ARCH_VAR_PREFIX)ARCH)
Simran Basi8a431d92017-04-04 12:47:19 -0700736endif
Nelson Li1f8357f2019-03-14 01:04:05 +0000737endif
738
Simran Basi7160b062018-01-08 12:25:18 -0800739multi_arch :=
Simran Basi8a431d92017-04-04 12:47:19 -0700740
nelsonlife043512019-03-19 16:00:45 +0800741my_default_test_module :=
742my_default_test_module := $($(my_prefix)OUT_TESTCASES)/$(LOCAL_MODULE)$(arch_dir)/$(my_installed_module_stem)
743ifneq ($(LOCAL_INSTALLED_MODULE),$(my_default_test_module))
744# Install into the testcase folder
745$(LOCAL_INSTALLED_MODULE) : $(my_default_test_module)
746endif
747
Ying Wang719f1982015-10-20 18:18:40 -0700748# The module itself.
Simran Basi6bea37c2017-02-16 18:04:10 -0800749$(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
Colin Crossa69b8092021-11-03 13:15:59 -0700750 $(eval my_compat_dist_$(suite) := $(patsubst %:$(LOCAL_INSTALLED_MODULE),$(LOCAL_INSTALLED_MODULE):$(LOCAL_INSTALLED_MODULE),\
751 $(foreach dir, $(call compatibility_suite_dirs,$(suite),$(arch_dir)), \
752 $(LOCAL_BUILT_MODULE):$(dir)/$(my_installed_module_stem)))) \
Nelson Lia2a8b9b2018-06-25 05:47:53 +0000753 $(eval my_compat_dist_config_$(suite) := ))
Ying Wang719f1982015-10-20 18:18:40 -0700754
yangbill86f441d2018-07-13 22:55:36 +0800755
yangbillc9347b32018-08-23 23:04:37 +0800756# Auto-generate build config.
757ifneq (,$(LOCAL_FULL_TEST_CONFIG))
758 test_config := $(LOCAL_FULL_TEST_CONFIG)
759else ifneq (,$(LOCAL_TEST_CONFIG))
760 test_config := $(LOCAL_PATH)/$(LOCAL_TEST_CONFIG)
761else
762 test_config := $(wildcard $(LOCAL_PATH)/AndroidTest.xml)
763endif
764ifeq (,$(test_config))
765 ifneq (true,$(is_native))
766 is_instrumentation_test := true
767 ifeq (true, $(LOCAL_IS_HOST_MODULE))
768 is_instrumentation_test := false
769 endif
770 # If LOCAL_MODULE_CLASS is not APPS, it's certainly not an instrumentation
771 # test. However, some packages for test data also have LOCAL_MODULE_CLASS
772 # set to APPS. These will require flag LOCAL_DISABLE_AUTO_GENERATE_TEST_CONFIG
773 # to disable auto-generating test config file.
774 ifneq (APPS, $(LOCAL_MODULE_CLASS))
775 is_instrumentation_test := false
776 endif
777 endif
778 # CTS modules can be used for test data, so test config files must be
779 # explicitly created using AndroidTest.xml
780 ifeq (,$(filter cts, $(LOCAL_COMPATIBILITY_SUITE)))
781 ifneq (true, $(LOCAL_DISABLE_AUTO_GENERATE_TEST_CONFIG))
782 ifeq (true, $(filter true,$(is_native) $(is_instrumentation_test)))
783 include $(BUILD_SYSTEM)/autogen_test_config.mk
784 test_config := $(autogen_test_config_file)
785 autogen_test_config_file :=
786 endif
787 endif
788 endif
789endif
790is_instrumentation_test :=
791
Yuntao Xu32a085c2021-05-27 10:19:48 -0700792# Currently this flag variable is true only for the `android_test_helper_app` type module
793# which should not have any .config file
794ifeq (true, $(LOCAL_DISABLE_TEST_CONFIG))
795 test_config :=
796endif
797
Ying Wang719f1982015-10-20 18:18:40 -0700798# Make sure we only add the files once for multilib modules.
yangbill86f441d2018-07-13 22:55:36 +0800799ifdef $(my_prefix)$(LOCAL_MODULE_CLASS)_$(LOCAL_MODULE)_compat_files
800 # Sync the auto_test_config value for multilib modules.
801 ifdef $(my_prefix)$(LOCAL_MODULE_CLASS)_$(LOCAL_MODULE)_autogen
802 ALL_MODULES.$(my_register_name).auto_test_config := true
Dan Shiefb892d2017-12-06 15:57:31 -0800803 endif
yangbill86f441d2018-07-13 22:55:36 +0800804else
805 $(my_prefix)$(LOCAL_MODULE_CLASS)_$(LOCAL_MODULE)_compat_files := true
806 # LOCAL_COMPATIBILITY_SUPPORT_FILES is a list of <src>[:<dest>].
807 $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
808 $(eval my_compat_dist_$(suite) += $(foreach f, $(LOCAL_COMPATIBILITY_SUPPORT_FILES), \
809 $(eval p := $(subst :,$(space),$(f))) \
810 $(eval s := $(word 1,$(p))) \
811 $(eval n := $(or $(word 2,$(p)),$(notdir $(word 1, $(p))))) \
812 $(foreach dir, $(call compatibility_suite_dirs,$(suite)), \
813 $(s):$(dir)/$(n)))))
Dan Shiefb892d2017-12-06 15:57:31 -0800814
yangbill86f441d2018-07-13 22:55:36 +0800815 ifneq (,$(test_config))
816 $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
817 $(eval my_compat_dist_config_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite)), \
818 $(test_config):$(dir)/$(LOCAL_MODULE).config)))
819 endif
Ying Wang16243612015-06-03 12:43:50 -0700820
Dan Shi0c9a5252020-08-15 12:27:42 -0700821 ifneq (,$(LOCAL_EXTRA_FULL_TEST_CONFIGS))
822 $(foreach test_config_file, $(LOCAL_EXTRA_FULL_TEST_CONFIGS), \
823 $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
824 $(eval my_compat_dist_config_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite)), \
Dan Shi22bc0992020-09-16 15:51:28 -0700825 $(test_config_file):$(dir)/$(basename $(notdir $(test_config_file))).config))))
Dan Shi0c9a5252020-08-15 12:27:42 -0700826 endif
827
yangbill86f441d2018-07-13 22:55:36 +0800828 ifneq (,$(wildcard $(LOCAL_PATH)/DynamicConfig.xml))
829 $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
830 $(eval my_compat_dist_config_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite)), \
831 $(LOCAL_PATH)/DynamicConfig.xml:$(dir)/$(LOCAL_MODULE).dynamic)))
832 endif
Simran Basi3e73e2b2017-04-19 16:10:45 -0700833
yangbill86f441d2018-07-13 22:55:36 +0800834 ifneq (,$(wildcard $(LOCAL_PATH)/$(LOCAL_MODULE)_*.config))
835 $(foreach extra_config, $(wildcard $(LOCAL_PATH)/$(LOCAL_MODULE)_*.config), \
836 $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
837 $(eval my_compat_dist_config_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite)), \
838 $(extra_config):$(dir)/$(notdir $(extra_config))))))
839 endif
Ying Wang719f1982015-10-20 18:18:40 -0700840endif # $(my_prefix)$(LOCAL_MODULE_CLASS)_$(LOCAL_MODULE)_compat_files
Stuart Scott8fe4bc72015-08-18 14:31:08 -0700841
yangbillc9347b32018-08-23 23:04:37 +0800842# HACK: pretend a soong LOCAL_FULL_TEST_CONFIG is autogenerated by setting the flag in
Colin Crosse3a4df82018-08-14 14:52:54 -0700843# module-info.json
yangbillc9347b32018-08-23 23:04:37 +0800844# TODO: (b/113029686) Add explicit flag from Soong to determine if a test was
845# autogenerated.
846ifneq (,$(filter $(SOONG_OUT_DIR)%,$(LOCAL_FULL_TEST_CONFIG)))
Colin Crosse3a4df82018-08-14 14:52:54 -0700847 ifeq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
Colin Crosse3a4df82018-08-14 14:52:54 -0700848 ALL_MODULES.$(my_register_name).auto_test_config := true
Colin Crosse3a4df82018-08-14 14:52:54 -0700849 endif
850endif
851
Jaewoong Jung5ea69712019-09-13 19:02:46 +0000852
853ifeq ($(use_testcase_folder),true)
854ifneq ($(my_test_data_file_pairs),)
Jaewoong Jungb5aa16d2020-03-13 15:51:54 -0700855# Filter out existng installed test data paths when collecting test data files to be installed and
856# indexed as they cause build rule conflicts. Instead put them in a separate list which is only
857# used for indexing.
Jaewoong Jung5ea69712019-09-13 19:02:46 +0000858$(foreach pair, $(my_test_data_file_pairs), \
859 $(eval parts := $(subst :,$(space),$(pair))) \
860 $(eval src_path := $(word 1,$(parts))) \
861 $(eval file := $(word 2,$(parts))) \
862 $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
863 $(eval my_compat_dist_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite),$(arch_dir)), \
Jaewoong Jungb5aa16d2020-03-13 15:51:54 -0700864 $(call filter-copy-pair,$(src_path),$(call append-path,$(dir),$(file)),$(my_installed_test_data)))) \
865 $(eval my_compat_dist_test_data_$(suite) += \
866 $(foreach dir, $(call compatibility_suite_dirs,$(suite),$(arch_dir)), \
867 $(filter $(my_installed_test_data),$(call append-path,$(dir),$(file)))))))
Jaewoong Jung5ea69712019-09-13 19:02:46 +0000868endif
869else
Simran Basi5691cb82017-12-04 14:44:16 -0800870ifneq ($(my_test_data_file_pairs),)
871$(foreach pair, $(my_test_data_file_pairs), \
872 $(eval parts := $(subst :,$(space),$(pair))) \
873 $(eval src_path := $(word 1,$(parts))) \
874 $(eval file := $(word 2,$(parts))) \
875 $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
876 $(eval my_compat_dist_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite),$(arch_dir)), \
877 $(src_path):$(call append-path,$(dir),$(file))))))
878endif
Jaewoong Jung5ea69712019-09-13 19:02:46 +0000879endif
Nelson Li1f8357f2019-03-14 01:04:05 +0000880
881
Simran Basi5691cb82017-12-04 14:44:16 -0800882
Dan Willemsen41337932018-01-26 16:57:57 -0800883arch_dir :=
884is_native :=
885
Simran Basi6bea37c2017-02-16 18:04:10 -0800886$(call create-suite-dependencies)
Nelson Lia2a8b9b2018-06-25 05:47:53 +0000887$(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
Jaewoong Jungb5aa16d2020-03-13 15:51:54 -0700888 $(eval my_compat_dist_config_$(suite) := ) \
889 $(eval my_compat_dist_test_data_$(suite) := ))
Ying Wang25e01172015-09-17 12:24:56 -0700890
Colin Crossfca369e2020-04-13 12:16:19 -0700891endif # LOCAL_UNINSTALLABLE_MODULE
Ying Wang16243612015-06-03 12:43:50 -0700892endif # LOCAL_COMPATIBILITY_SUITE
893
yangbillb2219c72022-02-18 15:27:53 +0800894my_supported_variant :=
895ifeq ($(my_host_cross),true)
896 my_supported_variant := HOST_CROSS
897else
898 ifdef LOCAL_IS_HOST_MODULE
899 my_supported_variant := HOST
900 else
901 my_supported_variant := DEVICE
902 endif
903endif
Ying Wang16243612015-06-03 12:43:50 -0700904###########################################################
Dan Shi639c6cc2018-04-13 14:39:53 -0700905## Add test module to ALL_DISABLED_PRESUBMIT_TESTS if LOCAL_PRESUBMIT_DISABLED is set to true.
906###########################################################
907ifeq ($(LOCAL_PRESUBMIT_DISABLED),true)
908 ALL_DISABLED_PRESUBMIT_TESTS += $(LOCAL_MODULE)
909endif # LOCAL_PRESUBMIT_DISABLED
910
911###########################################################
The Android Open Source Project88b60792009-03-03 19:28:42 -0800912## Register with ALL_MODULES
913###########################################################
914
Dan Willemsen2abf1592019-08-26 23:25:17 -0700915ifndef ALL_MODULES.$(my_register_name).PATH
Dan Willemsen8e96a792019-04-02 14:43:32 -0700916 # These keys are no longer used, they've been replaced by keys that specify
917 # target/host/host_cross (REQUIRED_FROM_TARGET / REQUIRED_FROM_HOST) and similar.
918 #
919 # Marking them obsolete to ensure that anyone using these internal variables looks for
920 # alternates.
921 $(KATI_obsolete_var ALL_MODULES.$(my_register_name).REQUIRED)
922 $(KATI_obsolete_var ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED)
923 $(KATI_obsolete_var ALL_MODULES.$(my_register_name).HOST_REQUIRED)
924 $(KATI_obsolete_var ALL_MODULES.$(my_register_name).TARGET_REQUIRED)
925endif
926
Ying Wang6ef65192014-01-15 16:02:16 -0800927ALL_MODULES += $(my_register_name)
The Android Open Source Project88b60792009-03-03 19:28:42 -0800928
929# Don't use += on subvars, or else they'll end up being
930# recursively expanded.
Ying Wang6ef65192014-01-15 16:02:16 -0800931ALL_MODULES.$(my_register_name).CLASS := \
932 $(ALL_MODULES.$(my_register_name).CLASS) $(LOCAL_MODULE_CLASS)
933ALL_MODULES.$(my_register_name).PATH := \
934 $(ALL_MODULES.$(my_register_name).PATH) $(LOCAL_PATH)
935ALL_MODULES.$(my_register_name).TAGS := \
Ying Wang37bd1f22014-01-27 15:19:09 -0800936 $(ALL_MODULES.$(my_register_name).TAGS) $(my_module_tags)
Ying Wang6ef65192014-01-15 16:02:16 -0800937ALL_MODULES.$(my_register_name).CHECKED := \
Ying Wang6c1d1cc2014-09-29 14:34:32 -0700938 $(ALL_MODULES.$(my_register_name).CHECKED) $(my_checked_module)
Ying Wang6ef65192014-01-15 16:02:16 -0800939ALL_MODULES.$(my_register_name).BUILT := \
940 $(ALL_MODULES.$(my_register_name).BUILT) $(LOCAL_BUILT_MODULE)
Vic Yang1b834132019-01-18 19:37:47 -0800941ifndef LOCAL_IS_HOST_MODULE
942ALL_MODULES.$(my_register_name).TARGET_BUILT := \
943 $(ALL_MODULES.$(my_register_name).TARGET_BUILT) $(LOCAL_BUILT_MODULE)
944endif
Colin Cross23ee3752021-09-24 15:48:03 -0700945ifneq (,$(LOCAL_SOONG_INSTALLED_MODULE))
946 # Store the list of paths to installed locations of files provided by this
947 # module. Used as dependencies of the image packaging rules when the module
948 # is installed by the current product.
949 ALL_MODULES.$(my_register_name).INSTALLED := \
950 $(strip $(ALL_MODULES.$(my_register_name).INSTALLED) \
951 $(foreach f, $(LOCAL_SOONG_INSTALL_PAIRS),\
952 $(word 2,$(subst :,$(space),$(f)))) \
953 $(LOCAL_SOONG_INSTALL_SYMLINKS) \
954 $(my_init_rc_installed) \
955 $(my_installed_test_data) \
956 $(my_vintf_installed))
957 # Store the list of colon-separated pairs of the built and installed locations
958 # of files provided by this module. Used by custom packaging rules like
959 # package-modules.mk that need to copy the built files to a custom install
960 # location during packaging.
Colin Cross802f2112021-11-15 13:15:22 -0800961 #
962 # Translate copies from $(LOCAL_PREBUILT_MODULE_FILE) to $(LOCAL_BUILT_MODULE)
963 # so that package-modules.mk gets any transtive dependencies added to
964 # $(LOCAL_BUILT_MODULE), for example unstripped symbols files.
Colin Cross23ee3752021-09-24 15:48:03 -0700965 ALL_MODULES.$(my_register_name).BUILT_INSTALLED := \
966 $(strip $(ALL_MODULES.$(my_register_name).BUILT_INSTALLED) \
Colin Cross802f2112021-11-15 13:15:22 -0800967 $(patsubst $(LOCAL_PREBUILT_MODULE_FILE):%,$(LOCAL_BUILT_MODULE):%,$(LOCAL_SOONG_INSTALL_PAIRS)) \
Colin Cross23ee3752021-09-24 15:48:03 -0700968 $(my_init_rc_pairs) \
969 $(my_test_data_pairs) \
970 $(my_vintf_pairs))
971else ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
972 ALL_MODULES.$(my_register_name).INSTALLED := \
Ying Wang9fe15ac2015-08-20 12:02:10 -0700973 $(strip $(ALL_MODULES.$(my_register_name).INSTALLED) \
Dan Willemsend07ba4e2016-12-09 16:05:09 -0800974 $(LOCAL_INSTALLED_MODULE) $(my_init_rc_installed) $(my_installed_symlinks) \
Steven Moreland3629aa72018-04-04 15:41:05 -0700975 $(my_installed_test_data) $(my_vintf_installed))
Colin Cross23ee3752021-09-24 15:48:03 -0700976 ALL_MODULES.$(my_register_name).BUILT_INSTALLED := \
Ying Wang9fe15ac2015-08-20 12:02:10 -0700977 $(strip $(ALL_MODULES.$(my_register_name).BUILT_INSTALLED) \
978 $(LOCAL_BUILT_MODULE):$(LOCAL_INSTALLED_MODULE) \
Steven Moreland3629aa72018-04-04 15:41:05 -0700979 $(my_init_rc_pairs) $(my_test_data_pairs) $(my_vintf_pairs))
Ying Wang3380d3a2014-05-19 13:03:36 -0700980endif
Ying Wang3b81aab2014-05-05 16:46:52 -0700981ifdef LOCAL_PICKUP_FILES
982# Files or directories ready to pick up by the build system
983# when $(LOCAL_BUILT_MODULE) is done.
984ALL_MODULES.$(my_register_name).PICKUP_FILES := \
985 $(ALL_MODULES.$(my_register_name).PICKUP_FILES) $(LOCAL_PICKUP_FILES)
986endif
Jiyong Park403c2552020-05-04 11:12:00 +0000987# Record the platform availability of this module. Note that the availability is not
988# meaningful for non-installable modules (e.g., static libs) or host modules.
989# We only care about modules that are installable to the device.
990ifeq (true,$(LOCAL_NOT_AVAILABLE_FOR_PLATFORM))
991 ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
992 ifndef LOCAL_IS_HOST_MODULE
993 ALL_MODULES.$(my_register_name).NOT_AVAILABLE_FOR_PLATFORM := true
994 endif
995 endif
996endif
Logan Chiend71fbfc2017-12-19 17:46:55 +0800997
Dan Willemsen7a549852015-08-13 17:51:40 -0700998my_required_modules := $(LOCAL_REQUIRED_MODULES) \
999 $(LOCAL_REQUIRED_MODULES_$(TARGET_$(LOCAL_2ND_ARCH_VAR_PREFIX)ARCH))
1000ifdef LOCAL_IS_HOST_MODULE
1001my_required_modules += $(LOCAL_REQUIRED_MODULES_$($(my_prefix)OS))
1002endif
Logan Chiend71fbfc2017-12-19 17:46:55 +08001003
yangbill5f5e2362021-10-13 16:25:35 +08001004ALL_MODULES.$(my_register_name).SHARED_LIBS := \
1005 $(ALL_MODULES.$(my_register_name).SHARED_LIBS) $(LOCAL_SHARED_LIBRARIES)
1006
1007ALL_MODULES.$(my_register_name).SYSTEM_SHARED_LIBS := \
1008 $(ALL_MODULES.$(my_register_name).SYSTEM_SHARED_LIBS) $(LOCAL_SYSTEM_SHARED_LIBRARIES)
1009
yangbillfa5026c2022-02-08 16:59:21 +08001010ALL_MODULES.$(my_register_name).LOCAL_RUNTIME_LIBRARIES := \
1011 $(ALL_MODULES.$(my_register_name).LOCAL_RUNTIME_LIBRARIES) $(LOCAL_RUNTIME_LIBRARIES)
1012
yangbill724565d2021-12-21 18:59:33 +08001013ifdef LOCAL_TEST_DATA
1014 # Export the list of targets that are handled as data inputs and required
1015 # by tests at runtime. The LOCAL_TEST_DATA format is generated from below
1016 # https://cs.android.com/android/platform/superproject/+/master:build/soong/android/androidmk.go;l=925-944;drc=master
1017 # which format is like $(path):$(relative_file) but for module-info, only
1018 # the string after ":" is needed.
1019 ALL_MODULES.$(my_register_name).TEST_DATA := \
1020 $(strip $(ALL_MODULES.$(my_register_name).TEST_DATA) \
1021 $(foreach f, $(LOCAL_TEST_DATA),\
1022 $(call word-colon,2,$(f))))
1023endif
1024
yangbille6b498b2022-02-11 18:27:32 +08001025ifdef LOCAL_TEST_DATA_BINS
1026 ALL_MODULES.$(my_register_name).TEST_DATA_BINS := \
1027 $(ALL_MODULES.$(my_register_name).TEST_DATA_BINS) $(LOCAL_TEST_DATA_BINS)
1028endif
1029
yangbillb2219c72022-02-18 15:27:53 +08001030ALL_MODULES.$(my_register_name).SUPPORTED_VARIANTS := \
1031 $(ALL_MODULES.$(my_register_name).SUPPORTED_VARIANTS) \
1032 $(filter-out $(ALL_MODULES.$(my_register_name).SUPPORTED_VARIANTS),$(my_supported_variant))
1033
Justin Yun2bfe0a12020-01-20 18:57:01 +09001034##########################################################################
1035## When compiling against the VNDK, add the .vendor or .product suffix to
1036## required modules.
1037##########################################################################
Logan Chiend71fbfc2017-12-19 17:46:55 +08001038ifneq ($(LOCAL_USE_VNDK),)
Justin Yun2bfe0a12020-01-20 18:57:01 +09001039 #####################################################
1040 ## Soong modules may be built three times, once for
1041 ## /system, once for /vendor and once for /product.
1042 ## If we're using the VNDK, switch all soong
1043 ## libraries over to the /vendor or /product variant.
1044 #####################################################
Logan Chiend71fbfc2017-12-19 17:46:55 +08001045 ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
1046 # We don't do this renaming for soong-defined modules since they already
Justin Yun2bfe0a12020-01-20 18:57:01 +09001047 # have correct names (with .vendor or .product suffix when necessary) in
1048 # their LOCAL_*_LIBRARIES.
1049 ifeq ($(LOCAL_USE_VNDK_PRODUCT),true)
1050 my_required_modules := $(foreach l,$(my_required_modules),\
1051 $(if $(SPLIT_PRODUCT.SHARED_LIBRARIES.$(l)),$(l).product,$(l)))
1052 else
1053 my_required_modules := $(foreach l,$(my_required_modules),\
1054 $(if $(SPLIT_VENDOR.SHARED_LIBRARIES.$(l)),$(l).vendor,$(l)))
1055 endif
Logan Chiend71fbfc2017-12-19 17:46:55 +08001056 endif
1057endif
1058
Dan Willemsen8e96a792019-04-02 14:43:32 -07001059ifdef LOCAL_IS_HOST_MODULE
1060 ifneq ($(my_host_cross),true)
1061 ALL_MODULES.$(my_register_name).REQUIRED_FROM_HOST := \
1062 $(strip $(ALL_MODULES.$(my_register_name).REQUIRED_FROM_HOST) $(my_required_modules))
1063 ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_HOST := \
1064 $(strip $(ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_HOST)\
1065 $(my_required_modules))
1066 ALL_MODULES.$(my_register_name).TARGET_REQUIRED_FROM_HOST := \
1067 $(strip $(ALL_MODULES.$(my_register_name).TARGET_REQUIRED_FROM_HOST)\
1068 $(LOCAL_TARGET_REQUIRED_MODULES))
1069 else
1070 ALL_MODULES.$(my_register_name).REQUIRED_FROM_HOST_CROSS := \
1071 $(strip $(ALL_MODULES.$(my_register_name).REQUIRED_FROM_HOST_CROSS) $(my_required_modules))
1072 ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_HOST_CROSS := \
1073 $(strip $(ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_HOST_CROSS)\
1074 $(my_required_modules))
1075 ifdef LOCAL_TARGET_REQUIRED_MODULES
1076 $(call pretty-error,LOCAL_TARGET_REQUIRED_MODULES may not be used from host_cross modules)
1077 endif
1078 endif
1079 ifdef LOCAL_HOST_REQUIRED_MODULES
1080 $(call pretty-error,LOCAL_HOST_REQUIRED_MODULES may not be used from host modules. Use LOCAL_REQUIRED_MODULES instead)
1081 endif
1082else
1083 ALL_MODULES.$(my_register_name).REQUIRED_FROM_TARGET := \
1084 $(strip $(ALL_MODULES.$(my_register_name).REQUIRED_FROM_TARGET) $(my_required_modules))
1085 ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_TARGET := \
1086 $(strip $(ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_TARGET)\
1087 $(my_required_modules))
1088 ALL_MODULES.$(my_register_name).HOST_REQUIRED_FROM_TARGET := \
1089 $(strip $(ALL_MODULES.$(my_register_name).HOST_REQUIRED_FROM_TARGET)\
1090 $(LOCAL_HOST_REQUIRED_MODULES))
1091 ifdef LOCAL_TARGET_REQUIRED_MODULES
1092 $(call pretty-error,LOCAL_TARGET_REQUIRED_MODULES may not be used from target modules. Use LOCAL_REQUIRED_MODULES instead)
1093 endif
1094endif
Yasuhiro Matsudaff82e822015-09-04 16:23:49 +09001095ALL_MODULES.$(my_register_name).EVENT_LOG_TAGS := \
1096 $(ALL_MODULES.$(my_register_name).EVENT_LOG_TAGS) $(event_log_tags)
Ying Wang6ef65192014-01-15 16:02:16 -08001097ALL_MODULES.$(my_register_name).MAKEFILE := \
1098 $(ALL_MODULES.$(my_register_name).MAKEFILE) $(LOCAL_MODULE_MAKEFILE)
Ying Wangdbb31be2011-12-09 15:11:57 -08001099ifdef LOCAL_MODULE_OWNER
Ying Wang6ef65192014-01-15 16:02:16 -08001100ALL_MODULES.$(my_register_name).OWNER := \
1101 $(sort $(ALL_MODULES.$(my_register_name).OWNER) $(LOCAL_MODULE_OWNER))
Ying Wangdbb31be2011-12-09 15:11:57 -08001102endif
Ying Wang14a6cbd2014-02-10 22:26:23 -08001103ifdef LOCAL_2ND_ARCH_VAR_PREFIX
1104ALL_MODULES.$(my_register_name).FOR_2ND_ARCH := true
1105endif
Dan Willemsen057aaea2015-08-14 12:59:50 -07001106ALL_MODULES.$(my_register_name).FOR_HOST_CROSS := $(my_host_cross)
Morris Lina77d5a22018-08-07 21:22:21 +08001107ALL_MODULES.$(my_register_name).MODULE_NAME := $(LOCAL_MODULE)
yangbill6dd962f2021-12-08 15:30:23 +08001108ALL_MODULES.$(my_register_name).COMPATIBILITY_SUITES := \
1109 $(ALL_MODULES.$(my_register_name).COMPATIBILITY_SUITES) \
1110 $(filter-out $(ALL_MODULES.$(my_register_name).COMPATIBILITY_SUITES),$(LOCAL_COMPATIBILITY_SUITE))
yangbillc9347b32018-08-23 23:04:37 +08001111ALL_MODULES.$(my_register_name).TEST_CONFIG := $(test_config)
Dan Shi0c9a5252020-08-15 12:27:42 -07001112ALL_MODULES.$(my_register_name).EXTRA_TEST_CONFIGS := $(LOCAL_EXTRA_FULL_TEST_CONFIGS)
kellyhung0ba6ec62020-08-28 00:19:53 +08001113ALL_MODULES.$(my_register_name).TEST_MAINLINE_MODULES := $(LOCAL_TEST_MAINLINE_MODULES)
Jooyung Hanb27c2e82020-09-23 19:15:20 +09001114ifndef LOCAL_IS_HOST_MODULE
1115ALL_MODULES.$(my_register_name).FILE_CONTEXTS := $(LOCAL_FILE_CONTEXTS)
1116endif
yangbill877586c2021-04-19 20:30:17 +08001117ifdef LOCAL_IS_UNIT_TEST
yangbill732b8582021-01-08 17:36:56 +08001118ALL_MODULES.$(my_register_name).IS_UNIT_TEST := $(LOCAL_IS_UNIT_TEST)
yangbill877586c2021-04-19 20:30:17 +08001119endif
yangbillc9347b32018-08-23 23:04:37 +08001120test_config :=
The Android Open Source Project88b60792009-03-03 19:28:42 -08001121
Ying Wang6ef65192014-01-15 16:02:16 -08001122INSTALLABLE_FILES.$(LOCAL_INSTALLED_MODULE).MODULE := $(my_register_name)
Joe Onorato8a06bac2010-05-21 14:29:29 -07001123
Ying Wang39b9b692015-05-07 12:08:53 -07001124##########################################################
1125# Track module-level dependencies.
1126# Use $(LOCAL_MODULE) instead of $(my_register_name) to ignore module's bitness.
Jim Tang5c6410e2021-11-03 16:13:05 +08001127# (b/204397180) Unlock RECORD_ALL_DEPS was acknowledged reasonable for better Atest performance.
Dan Willemsen8447b812020-06-08 21:00:18 -07001128ALL_DEPS.MODULES += $(LOCAL_MODULE)
Ying Wang39b9b692015-05-07 12:08:53 -07001129ALL_DEPS.$(LOCAL_MODULE).ALL_DEPS := $(sort \
Martin Stjernholm43ee3552019-06-05 21:10:29 +01001130 $(ALL_DEPS.$(LOCAL_MODULE).ALL_DEPS) \
Ying Wang39b9b692015-05-07 12:08:53 -07001131 $(LOCAL_STATIC_LIBRARIES) \
1132 $(LOCAL_WHOLE_STATIC_LIBRARIES) \
1133 $(LOCAL_SHARED_LIBRARIES) \
Ivan Lozanod62e7122019-08-27 11:23:35 -07001134 $(LOCAL_DYLIB_LIBRARIES) \
1135 $(LOCAL_RLIB_LIBRARIES) \
1136 $(LOCAL_PROC_MACRO_LIBRARIES) \
Dan Willemsen8dae49c2017-02-15 15:48:11 -08001137 $(LOCAL_HEADER_LIBRARIES) \
Ying Wang39b9b692015-05-07 12:08:53 -07001138 $(LOCAL_STATIC_JAVA_LIBRARIES) \
Martin Stjernholm43ee3552019-06-05 21:10:29 +01001139 $(LOCAL_JAVA_LIBRARIES) \
Ying Wang39b9b692015-05-07 12:08:53 -07001140 $(LOCAL_JNI_SHARED_LIBRARIES))
1141
Dan Willemsen8447b812020-06-08 21:00:18 -07001142license_files := $(call find-parent-file,$(LOCAL_PATH),MODULE_LICENSE*)
Ying Wang39b9b692015-05-07 12:08:53 -07001143ALL_DEPS.$(LOCAL_MODULE).LICENSE := $(sort $(ALL_DEPS.$(LOCAL_MODULE).LICENSE) $(license_files))
1144
The Android Open Source Project88b60792009-03-03 19:28:42 -08001145###########################################################
Ying Wang37bd1f22014-01-27 15:19:09 -08001146## Take care of my_module_tags
The Android Open Source Project88b60792009-03-03 19:28:42 -08001147###########################################################
1148
1149# Keep track of all the tags we've seen.
Ying Wang37bd1f22014-01-27 15:19:09 -08001150ALL_MODULE_TAGS := $(sort $(ALL_MODULE_TAGS) $(my_module_tags))
The Android Open Source Project88b60792009-03-03 19:28:42 -08001151
The Android Open Source Project88b60792009-03-03 19:28:42 -08001152# Add this module name to the tag list of each specified tag.
Dan Willemsen46a88892019-08-27 00:49:31 -07001153$(foreach tag,$(filter-out optional,$(my_module_tags)),\
Dan Willemsen44fd0f62017-10-09 18:01:50 -07001154 $(eval ALL_MODULE_NAME_TAGS.$(tag) := $$(ALL_MODULE_NAME_TAGS.$(tag)) $(my_register_name)))
The Android Open Source Project88b60792009-03-03 19:28:42 -08001155
The Android Open Source Project88b60792009-03-03 19:28:42 -08001156###########################################################
Ying Wangef4d82f2013-01-29 16:59:18 -08001157## umbrella targets used to verify builds
1158###########################################################
Ying Wangef4d82f2013-01-29 16:59:18 -08001159j_or_n :=
Ivan Lozanod62e7122019-08-27 11:23:35 -07001160ifneq (,$(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 -08001161j_or_n := native
1162else
1163ifneq (,$(filter JAVA_LIBRARIES APPS,$(LOCAL_MODULE_CLASS)))
1164j_or_n := java
Ying Wangef4d82f2013-01-29 16:59:18 -08001165endif
1166endif
1167ifdef LOCAL_IS_HOST_MODULE
1168h_or_t := host
Colin Crossd76e2e62016-12-09 13:08:27 -08001169ifeq ($(my_host_cross),true)
1170h_or_hc_or_t := host-cross
Ying Wangef4d82f2013-01-29 16:59:18 -08001171else
Colin Crossd76e2e62016-12-09 13:08:27 -08001172h_or_hc_or_t := host
1173endif
1174else
1175h_or_hc_or_t := target
Ying Wangef4d82f2013-01-29 16:59:18 -08001176h_or_t := target
1177endif
1178
Colin Crossd76e2e62016-12-09 13:08:27 -08001179
Ying Wangef4d82f2013-01-29 16:59:18 -08001180ifdef j_or_n
Dan Willemsenc01ad7b2017-11-29 20:54:41 -08001181$(j_or_n) $(h_or_t) $(j_or_n)-$(h_or_hc_or_t) : $(my_checked_module)
Ying Wang37bd1f22014-01-27 15:19:09 -08001182ifneq (,$(filter $(my_module_tags),tests))
Ying Wang6c1d1cc2014-09-29 14:34:32 -07001183$(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 -08001184endif
Colin Crossd76e2e62016-12-09 13:08:27 -08001185$(LOCAL_MODULE)-$(h_or_hc_or_t) : $(my_all_targets)
Dan Willemsen14e10262018-06-17 21:54:21 -07001186.PHONY: $(LOCAL_MODULE)-$(h_or_hc_or_t)
Colin Crossd76e2e62016-12-09 13:08:27 -08001187ifeq ($(j_or_n),native)
1188$(LOCAL_MODULE)-$(h_or_hc_or_t)$(my_32_64_bit_suffix) : $(my_all_targets)
Dan Willemsen14e10262018-06-17 21:54:21 -07001189.PHONY: $(LOCAL_MODULE)-$(h_or_hc_or_t)$(my_32_64_bit_suffix)
Colin Crossd76e2e62016-12-09 13:08:27 -08001190endif
Ying Wangef4d82f2013-01-29 16:59:18 -08001191endif
1192
1193###########################################################
Nicolas Geoffrayb06c30b2017-09-19 11:51:45 +00001194# Ensure privileged applications always have LOCAL_PRIVILEGED_MODULE
1195###########################################################
1196ifndef LOCAL_PRIVILEGED_MODULE
1197 ifneq (,$(filter $(TARGET_OUT_APPS_PRIVILEGED)/% $(TARGET_OUT_VENDOR_APPS_PRIVILEGED)/%,$(my_module_path)))
1198 LOCAL_PRIVILEGED_MODULE := true
1199 endif
1200endif
1201
1202###########################################################
The Android Open Source Project88b60792009-03-03 19:28:42 -08001203## NOTICE files
1204###########################################################
1205
Ying Wang13d69502012-11-01 17:22:33 -07001206include $(BUILD_NOTICE_FILE)