• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1#
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
17# Catch users that directly include base_rules.mk
18$(call record-module-type,base_rules)
19
20# 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  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),)
28endif
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
38$(call verify-module-name)
39
40my_test_data :=
41my_test_config :=
42
43LOCAL_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
48  ifeq ($(LOCAL_HOST_PREFIX),)
49    my_prefix := HOST_
50  else
51    my_prefix := $(LOCAL_HOST_PREFIX)
52  endif
53  my_host := host-
54  my_kind := HOST
55else
56  my_prefix := TARGET_
57  my_kind :=
58  my_host :=
59endif
60
61ifeq ($(my_prefix),HOST_CROSS_)
62  my_host_cross := true
63else
64  my_host_cross :=
65endif
66
67ifeq (true, $(LOCAL_PRODUCT_MODULE))
68ifneq (,$(filter $(LOCAL_MODULE),$(PRODUCT_FORCE_PRODUCT_MODULES_TO_SYSTEM_PARTITION)))
69  LOCAL_PRODUCT_MODULE :=
70endif
71endif
72
73_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
80else ifneq ($(filter $(TARGET_OUT_PRODUCT)/%,$(_path)),)
81LOCAL_PRODUCT_MODULE := true
82else ifneq ($(filter $(TARGET_OUT_SYSTEM_EXT)/%,$(_path)),)
83LOCAL_SYSTEM_EXT_MODULE := true
84endif
85_path :=
86
87# 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
93ifndef 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
103ifeq ($(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
117non_system_module := $(filter true, \
118   $(LOCAL_PRODUCT_MODULE) \
119   $(LOCAL_SYSTEM_EXT_MODULE) \
120   $(LOCAL_VENDOR_MODULE) \
121   $(LOCAL_PROPRIETARY_MODULE))
122
123include $(BUILD_SYSTEM)/local_vendor_product.mk
124
125# local_current_sdk needs to run before local_systemsdk because the former may override
126# LOCAL_SDK_VERSION which is used by the latter.
127include $(BUILD_SYSTEM)/local_current_sdk.mk
128
129# Check if the use of System SDK is correct. Note that, for Soong modules, the system sdk version
130# check is done in Soong. No need to do it twice.
131ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
132include $(BUILD_SYSTEM)/local_systemsdk.mk
133endif
134
135# Ninja has an implicit dependency on the command being run, and kati will
136# regenerate the ninja manifest if any read makefile changes, so there is no
137# need to have dependencies on makefiles.
138# This won't catch all the cases where LOCAL_ADDITIONAL_DEPENDENCIES contains
139# a .mk file, because a few users of LOCAL_ADDITIONAL_DEPENDENCIES don't include
140# base_rules.mk, but it will fix the most common ones.
141LOCAL_ADDITIONAL_DEPENDENCIES := $(filter-out %.mk,$(LOCAL_ADDITIONAL_DEPENDENCIES))
142
143my_bad_deps := $(strip $(foreach dep,$(filter-out | ||,$(LOCAL_ADDITIONAL_DEPENDENCIES)),\
144                 $(if $(findstring /,$(dep)),,$(dep))))
145ifneq ($(my_bad_deps),)
146$(call pretty-warning,"Bad LOCAL_ADDITIONAL_DEPENDENCIES: $(my_bad_deps)")
147$(call pretty-error,"LOCAL_ADDITIONAL_DEPENDENCIES must only contain paths (not module names)")
148endif
149
150###########################################################
151## Validate and define fallbacks for input LOCAL_* variables.
152###########################################################
153
154LOCAL_UNINSTALLABLE_MODULE := $(strip $(LOCAL_UNINSTALLABLE_MODULE))
155
156# Only the tags mentioned in this test are expected to be set by module
157# makefiles. Anything else is either a typo or a source of unexpected
158# behaviors.
159ifneq ($(filter-out tests optional samples,$(LOCAL_MODULE_TAGS)),)
160$(call pretty-error,unusual tags: $(filter-out tests optional samples,$(LOCAL_MODULE_TAGS)))
161endif
162
163LOCAL_MODULE_CLASS := $(strip $(LOCAL_MODULE_CLASS))
164ifneq ($(words $(LOCAL_MODULE_CLASS)),1)
165  $(error $(LOCAL_PATH): LOCAL_MODULE_CLASS must contain exactly one word, not "$(LOCAL_MODULE_CLASS)")
166endif
167
168my_32_64_bit_suffix := $(if $($(LOCAL_2ND_ARCH_VAR_PREFIX)$(my_prefix)IS_64_BIT),64,32)
169
170ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
171my_multilib_module_path := $(strip $(LOCAL_MODULE_PATH_$(my_32_64_bit_suffix)))
172ifdef my_multilib_module_path
173my_module_path := $(my_multilib_module_path)
174else
175my_module_path := $(strip $(LOCAL_MODULE_PATH))
176endif
177my_module_path := $(patsubst %/,%,$(my_module_path))
178my_module_relative_path := $(strip $(LOCAL_MODULE_RELATIVE_PATH))
179
180ifdef LOCAL_IS_HOST_MODULE
181  partition_tag :=
182  actual_partition_tag :=
183else
184ifeq (true,$(strip $(LOCAL_VENDOR_MODULE)))
185  partition_tag := _VENDOR
186  # A vendor module could be on the vendor partition at "vendor" or the system
187  # partition at "system/vendor".
188  actual_partition_tag := $(if $(filter true,$(BOARD_USES_VENDORIMAGE)),vendor,system)
189else ifeq (true,$(strip $(LOCAL_OEM_MODULE)))
190  partition_tag := _OEM
191  actual_partition_tag := oem
192else ifeq (true,$(strip $(LOCAL_ODM_MODULE)))
193  partition_tag := _ODM
194  # An ODM module could be on the odm partition at "odm", the vendor partition
195  # at "vendor/odm", or the system partition at "system/vendor/odm".
196  actual_partition_tag := $(if $(filter true,$(BOARD_USES_ODMIMAGE)),odm,$(if $(filter true,$(BOARD_USES_VENDORIMAGE)),vendor,system))
197else ifeq (true,$(strip $(LOCAL_PRODUCT_MODULE)))
198  partition_tag := _PRODUCT
199  # A product module could be on the product partition at "product" or the
200  # system partition at "system/product".
201  actual_partition_tag := $(if $(filter true,$(BOARD_USES_PRODUCTIMAGE)),product,system)
202else ifeq (true,$(strip $(LOCAL_SYSTEM_EXT_MODULE)))
203  partition_tag := _SYSTEM_EXT
204  # A system_ext-specific module could be on the system_ext partition at
205  # "system_ext" or the system partition at "system/system_ext".
206  actual_partition_tag := $(if $(filter true,$(BOARD_USES_SYSTEM_EXTIMAGE)),system_ext,system)
207else ifeq (NATIVE_TESTS,$(LOCAL_MODULE_CLASS))
208  partition_tag := _DATA
209  actual_partition_tag := data
210else
211  # The definition of should-install-to-system will be different depending
212  # on which goal (e.g., sdk or just droid) is being built.
213  partition_tag := $(if $(call should-install-to-system,$(LOCAL_MODULE_TAGS)),,_DATA)
214  actual_partition_tag := $(if $(partition_tag),data,system)
215endif
216endif
217
218# if this is a soong module, verify that LOCAL_COMPATIBILITY_SUITE (legacy) matches
219# LOCAL_SOONG_PROVIDER_TEST_SUITES (new, via TestSuiteInfoProvider instead of AndroidMk stuff),
220# modulo "null-sute", "mts", and "mcts". mts/mcts are automatically added if there's a different
221# suite starting with "m(c)ts-". null-suite seems useless and is sometimes automatically added
222# if no other suites are added.
223ifneq (,$(filter $(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK)))
224  a := $(filter-out null-suite mts mcts,$(sort $(LOCAL_COMPATIBILITY_SUITE)))
225  b := $(filter-out null-suite mts mcts,$(sort $(LOCAL_SOONG_PROVIDER_TEST_SUITES)))
226  ifneq ($(a),$(b))
227    $(error $(LOCAL_MODULE): LOCAL_COMPATIBILITY_SUITE did not match LOCAL_SOONG_PROVIDER_TEST_SUITES$(newline)  LOCAL_COMPATIBILITY_SUITE: $(a)$(newline)  LOCAL_SOONG_PROVIDER_TEST_SUITES: $(b)$(newline))
228  endif
229  a :=
230  b :=
231endif
232
233# For test modules that lack a suite tag, set null-suite as the default.
234# We only support adding a default suite to native tests, native benchmarks, and instrumentation tests.
235# This is because they are the only tests we currently auto-generate test configs for.
236ifndef LOCAL_COMPATIBILITY_SUITE
237  ifneq ($(filter NATIVE_TESTS NATIVE_BENCHMARK, $(LOCAL_MODULE_CLASS)),)
238    LOCAL_COMPATIBILITY_SUITE := null-suite
239  endif
240  ifneq ($(filter APPS, $(LOCAL_MODULE_CLASS)),)
241    ifneq ($(filter $(LOCAL_MODULE_TAGS),tests),)
242      LOCAL_COMPATIBILITY_SUITE := null-suite
243    endif
244  endif
245endif
246
247use_testcase_folder :=
248ifeq ($(my_module_path),)
249  ifneq ($(LOCAL_MODULE),$(filter $(LOCAL_MODULE),$(DEFAULT_DATA_OUT_MODULES)))
250    ifdef LOCAL_COMPATIBILITY_SUITE
251      ifneq (true, $(LOCAL_IS_HOST_MODULE))
252        use_testcase_folder := true
253      endif
254    endif
255  endif
256endif
257
258ifeq ($(LOCAL_IS_UNIT_TEST),true)
259  ifeq ($(LOCAL_IS_HOST_MODULE),true)
260    LOCAL_COMPATIBILITY_SUITE += host-unit-tests
261  endif
262endif
263
264ifeq ($(my_module_path),)
265  install_path_var := $(LOCAL_2ND_ARCH_VAR_PREFIX)$(my_prefix)OUT$(partition_tag)_$(LOCAL_MODULE_CLASS)
266  ifeq (true,$(LOCAL_PRIVILEGED_MODULE))
267    install_path_var := $(install_path_var)_PRIVILEGED
268  endif
269
270  my_module_path := $($(install_path_var))
271
272  # If use_testcase_folder be set, and LOCAL_MODULE_PATH not set,
273  # overwrite the default path under testcase.
274  ifeq ($(use_testcase_folder),true)
275    arch_dir := $($(my_prefix)$(LOCAL_2ND_ARCH_VAR_PREFIX)ARCH)
276    testcase_folder := $($(my_prefix)OUT_TESTCASES)/$(LOCAL_MODULE)/$(arch_dir)
277    my_module_path := $(testcase_folder)
278    arch_dir :=
279  endif
280
281  ifeq ($(strip $(my_module_path)),)
282    $(error $(LOCAL_PATH): unhandled install path "$(install_path_var) for $(LOCAL_MODULE)")
283  endif
284endif
285ifneq ($(my_module_relative_path),)
286  my_module_path := $(my_module_path)/$(my_module_relative_path)
287endif
288endif # not LOCAL_UNINSTALLABLE_MODULE
289
290ifneq ($(strip $(LOCAL_BUILT_MODULE)$(LOCAL_INSTALLED_MODULE)),)
291  $(error $(LOCAL_PATH): LOCAL_BUILT_MODULE and LOCAL_INSTALLED_MODULE must not be defined by component makefiles)
292endif
293
294my_register_name := $(LOCAL_MODULE)
295ifeq ($(my_host_cross),true)
296  my_register_name := host_cross_$(LOCAL_MODULE)
297endif
298ifdef LOCAL_2ND_ARCH_VAR_PREFIX
299ifndef LOCAL_NO_2ND_ARCH_MODULE_SUFFIX
300my_register_name := $(my_register_name)$($(my_prefix)2ND_ARCH_MODULE_SUFFIX)
301endif
302endif
303
304ifeq ($(my_host_cross),true)
305  my_all_targets := host_cross_$(my_register_name)_all_targets
306else ifneq ($(LOCAL_IS_HOST_MODULE),)
307  my_all_targets := host_$(my_register_name)_all_targets
308else
309  my_all_targets := device_$(my_register_name)_all_targets
310endif
311
312# Make sure that this IS_HOST/CLASS/MODULE combination is unique.
313module_id := MODULE.$(if \
314    $(LOCAL_IS_HOST_MODULE),$($(my_prefix)OS),TARGET).$(LOCAL_MODULE_CLASS).$(my_register_name)
315ifdef $(module_id)
316$(error $(LOCAL_PATH): $(module_id) already defined by $($(module_id)))
317endif
318$(module_id) := $(LOCAL_PATH)
319
320# These are the same as local-intermediates-dir / local-generated-sources dir, but faster
321intermediates.COMMON := $($(my_prefix)OUT_COMMON_INTERMEDIATES)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
322ifneq (,$(filter $(my_prefix)$(LOCAL_MODULE_CLASS),$(COMMON_MODULE_CLASSES)))
323  intermediates := $($(my_prefix)OUT_COMMON_INTERMEDIATES)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
324  generated_sources_dir := $($(my_prefix)OUT_COMMON_GEN)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
325else
326  ifneq (,$(filter $(LOCAL_MODULE_CLASS),$(PER_ARCH_MODULE_CLASSES)))
327    intermediates := $($(LOCAL_2ND_ARCH_VAR_PREFIX)$(my_prefix)OUT_INTERMEDIATES)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
328  else
329    intermediates := $($(my_prefix)OUT_INTERMEDIATES)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
330  endif
331  generated_sources_dir := $($(my_prefix)OUT_GEN)/$(LOCAL_MODULE_CLASS)/$(LOCAL_MODULE)_intermediates
332endif
333
334ifneq ($(LOCAL_OVERRIDES_MODULES),)
335  ifndef LOCAL_IS_HOST_MODULE
336    ifeq ($(LOCAL_MODULE_CLASS),EXECUTABLES)
337      EXECUTABLES.$(LOCAL_MODULE).OVERRIDES := $(strip $(LOCAL_OVERRIDES_MODULES))
338    else ifeq ($(LOCAL_MODULE_CLASS),SHARED_LIBRARIES)
339      SHARED_LIBRARIES.$(LOCAL_MODULE).OVERRIDES := $(strip $(LOCAL_OVERRIDES_MODULES))
340    else ifeq ($(LOCAL_MODULE_CLASS),ETC)
341      ETC.$(LOCAL_MODULE).OVERRIDES := $(strip $(LOCAL_OVERRIDES_MODULES))
342    else
343      $(call pretty-error,LOCAL_MODULE_CLASS := $(LOCAL_MODULE_CLASS) cannot use LOCAL_OVERRIDES_MODULES)
344    endif
345  else
346    $(call pretty-error,host modules cannot use LOCAL_OVERRIDES_MODULES)
347  endif
348endif
349
350###########################################################
351# Pick a name for the intermediate and final targets
352###########################################################
353include $(BUILD_SYSTEM)/configure_module_stem.mk
354
355LOCAL_BUILT_MODULE := $(intermediates)/$(my_built_module_stem)
356
357ifneq (,$(LOCAL_SOONG_INSTALLED_MODULE))
358  ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
359    $(call pretty-error, LOCAL_MODULE_MAKEFILE can only be used from $(SOONG_ANDROID_MK))
360  endif
361  # Use the install path requested by Soong.
362  LOCAL_INSTALLED_MODULE := $(LOCAL_SOONG_INSTALLED_MODULE)
363else ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
364  # Apk and its attachments reside in its own subdir.
365  ifeq ($(LOCAL_MODULE_CLASS),APPS)
366    # framework-res.apk doesn't like the additional layer.
367    ifeq ($(LOCAL_NO_STANDARD_LIBRARIES),true)
368      # Neither do Runtime Resource Overlay apks, which contain just the overlaid resources.
369    else ifeq ($(LOCAL_IS_RUNTIME_RESOURCE_OVERLAY),true)
370    else
371      ifneq ($(use_testcase_folder),true)
372        my_module_path := $(my_module_path)/$(LOCAL_MODULE)
373      endif
374    endif
375  endif
376  LOCAL_INSTALLED_MODULE := $(my_module_path)/$(my_installed_module_stem)
377endif
378
379# Assemble the list of targets to create PRIVATE_ variables for.
380LOCAL_INTERMEDIATE_TARGETS += $(LOCAL_BUILT_MODULE)
381
382###########################################################
383## Create .toc files from shared objects to reduce unnecessary rebuild
384# .toc files have the list of external dynamic symbols without their addresses.
385# As .KATI_RESTAT is specified to .toc files and commit-change-for-toc is used,
386# dependent binaries of a .toc file will be rebuilt only when the content of
387# the .toc file is changed.
388#
389# Don't create .toc files for Soong shared libraries, that is handled in
390# Soong and soong_cc_prebuilt.mk
391###########################################################
392ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
393ifeq ($(LOCAL_MODULE_CLASS),SHARED_LIBRARIES)
394LOCAL_INTERMEDIATE_TARGETS += $(LOCAL_BUILT_MODULE).toc
395$(LOCAL_BUILT_MODULE).toc: $(LOCAL_BUILT_MODULE)
396	$(call $(PRIVATE_2ND_ARCH_VAR_PREFIX)$(PRIVATE_PREFIX)transform-shared-lib-to-toc,$<,$@.tmp)
397	$(call commit-change-for-toc,$@)
398
399# Kati adds restat=1 to ninja. GNU make does nothing for this.
400.KATI_RESTAT: $(LOCAL_BUILT_MODULE).toc
401# Build .toc file when using mm, mma, or make $(my_register_name)
402$(my_all_targets): $(LOCAL_BUILT_MODULE).toc
403endif
404endif
405
406###########################################################
407## logtags: Add .logtags files to global list
408###########################################################
409
410logtags_sources := $(filter %.logtags,$(LOCAL_SRC_FILES)) $(LOCAL_LOGTAGS_FILES)
411
412ifneq ($(strip $(logtags_sources) $(LOCAL_SOONG_LOGTAGS_FILES)),)
413event_log_tags := $(foreach f,$(LOCAL_SOONG_LOGTAGS_FILES) $(addprefix $(LOCAL_PATH)/,$(logtags_sources)),$(call clean-path,$(f)))
414else
415event_log_tags :=
416endif
417
418###########################################################
419## make clean- targets
420###########################################################
421cleantarget := clean-$(my_register_name)
422.PHONY: $(cleantarget)
423$(cleantarget) : PRIVATE_MODULE := $(my_register_name)
424$(cleantarget) : PRIVATE_CLEAN_FILES := \
425    $(LOCAL_BUILT_MODULE) \
426    $(LOCAL_INSTALLED_MODULE) \
427    $(intermediates)
428$(cleantarget)::
429	@echo "Clean: $(PRIVATE_MODULE)"
430	$(hide) rm -rf $(PRIVATE_CLEAN_FILES)
431
432###########################################################
433## Common definitions for module.
434###########################################################
435$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_PATH:=$(LOCAL_PATH)
436$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_IS_HOST_MODULE := $(LOCAL_IS_HOST_MODULE)
437$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_HOST:= $(my_host)
438$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_PREFIX := $(my_prefix)
439$(LOCAL_INTERMEDIATE_TARGETS) : .KATI_TAGS += ;module_name=$(LOCAL_MODULE)
440ifeq ($(LOCAL_MODULE_CLASS),)
441$(error "$(LOCAL_MODULE) in $(LOCAL_PATH) does not set $(LOCAL_MODULE_CLASS)")
442else
443$(LOCAL_INTERMEDIATE_TARGETS) : .KATI_TAGS += ;module_type=$(LOCAL_MODULE_CLASS)
444endif
445
446$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_INTERMEDIATES_DIR:= $(intermediates)
447$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_2ND_ARCH_VAR_PREFIX := $(LOCAL_2ND_ARCH_VAR_PREFIX)
448
449# Tell the module and all of its sub-modules who it is.
450$(LOCAL_INTERMEDIATE_TARGETS) : PRIVATE_MODULE:= $(my_register_name)
451
452# Provide a short-hand for building this module.
453# We name both BUILT and INSTALLED in case
454# LOCAL_UNINSTALLABLE_MODULE is set.
455.PHONY: $(my_all_targets)
456$(my_all_targets): $(LOCAL_BUILT_MODULE) $(LOCAL_INSTALLED_MODULE) $(LOCAL_ADDITIONAL_CHECKED_MODULE)
457
458.PHONY: $(my_register_name)
459$(my_register_name): $(my_all_targets)
460
461ifneq ($(my_register_name),$(LOCAL_MODULE))
462# $(LOCAL_MODULE) covers all the multilib targets.
463.PHONY: $(LOCAL_MODULE)
464$(LOCAL_MODULE) : $(my_all_targets)
465endif
466
467# Set up phony targets that covers all modules under the given paths.
468# This allows us to build everything in given paths by running mmma/mma.
469define my_path_comp
470parent := $(patsubst %/,%,$(dir $(1)))
471parent_target := MODULES-IN-$$(subst /,-,$$(parent))
472.PHONY: $$(parent_target)
473$$(parent_target): $(2)
474ifndef $$(parent_target)
475  $$(parent_target) := true
476  ifneq (,$$(findstring /,$$(parent)))
477    $$(eval $$(call my_path_comp,$$(parent),$$(parent_target)))
478  endif
479endif
480endef
481
482_local_path := $(patsubst %/,%,$(LOCAL_PATH))
483_local_path_target := MODULES-IN-$(subst /,-,$(_local_path))
484
485.PHONY: $(_local_path_target)
486$(_local_path_target): $(my_register_name)
487
488ifndef $(_local_path_target)
489  $(_local_path_target) := true
490  ifneq (,$(findstring /,$(_local_path)))
491    $(eval $(call my_path_comp,$(_local_path),$(_local_path_target)))
492  endif
493endif
494
495_local_path :=
496_local_path_target :=
497my_path_comp :=
498
499###########################################################
500## Module installation rule
501###########################################################
502
503my_installed_symlinks :=
504
505ifneq (,$(LOCAL_SOONG_INSTALLED_MODULE))
506  # Soong already generated the copy rule, but make the installed location depend on the Make
507  # copy of the intermediates for now, as some rules that collect intermediates may expect
508  # them to exist.
509  $(LOCAL_INSTALLED_MODULE): $(LOCAL_BUILT_MODULE)
510else ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
511  $(LOCAL_INSTALLED_MODULE): PRIVATE_POST_INSTALL_CMD := $(LOCAL_POST_INSTALL_CMD)
512  $(LOCAL_INSTALLED_MODULE): $(LOCAL_BUILT_MODULE)
513	@echo "Install: $@"
514  ifeq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
515	$(copy-file-or-link-to-new-target)
516  else
517	$(copy-file-to-new-target)
518  endif
519	$(PRIVATE_POST_INSTALL_CMD)
520
521  # Rule to install the module's companion symlinks
522  my_installed_symlinks := $(addprefix $(my_module_path)/,$(LOCAL_MODULE_SYMLINKS) $(LOCAL_MODULE_SYMLINKS_$(my_32_64_bit_suffix)))
523  $(foreach symlink,$(my_installed_symlinks),\
524      $(call symlink-file,$(LOCAL_INSTALLED_MODULE),$(my_installed_module_stem),$(symlink))\
525      $(call declare-0p-target,$(symlink)))
526
527  $(my_all_targets) : | $(my_installed_symlinks)
528
529endif # !LOCAL_UNINSTALLABLE_MODULE
530
531# Add dependencies on LOCAL_SOONG_INSTALL_SYMLINKS if we're installing any kind of module, not just
532# ones that set LOCAL_SOONG_INSTALLED_MODULE. This is so we can have a soong module that only
533# installs symlinks (e.g. install_symlink). We can't set LOCAL_SOONG_INSTALLED_MODULE to a symlink
534# because cp commands will fail on symlinks.
535ifneq (,$(or $(LOCAL_SOONG_INSTALLED_MODULE),$(call boolean-not,$(LOCAL_UNINSTALLABLE_MODULE))))
536  $(foreach symlink, $(LOCAL_SOONG_INSTALL_SYMLINKS), $(call declare-0p-target,$(symlink)))
537  $(my_all_targets) : | $(LOCAL_SOONG_INSTALL_SYMLINKS)
538endif
539
540###########################################################
541## VINTF manifest fragment and init.rc goals
542###########################################################
543
544my_vintf_installed:=
545my_vintf_path:=
546my_vintf_pairs:=
547my_init_rc_installed :=
548my_init_rc_path :=
549my_init_rc_pairs :=
550ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
551  ifndef LOCAL_IS_HOST_MODULE
552    # Rule to install the module's companion vintf fragments.
553    ifneq ($(strip $(LOCAL_FULL_VINTF_FRAGMENTS)),)
554      my_vintf_fragments := $(LOCAL_FULL_VINTF_FRAGMENTS)
555    else
556      my_vintf_fragments := $(foreach xml,$(LOCAL_VINTF_FRAGMENTS),$(LOCAL_PATH)/$(xml))
557    endif
558    ifneq ($(strip $(my_vintf_fragments)),)
559      # Make doesn't support recovery as an output partition, but some Soong modules installed in recovery
560      # have init.rc files that need to be installed alongside them. Manually handle the case where the
561      # output file is in the recovery partition.
562      my_vintf_path := $(if $(filter $(TARGET_RECOVERY_ROOT_OUT)/%,$(my_module_path)),$(TARGET_RECOVERY_ROOT_OUT)/system/etc,$(TARGET_OUT$(partition_tag)_ETC))
563      my_vintf_pairs := $(foreach xml,$(my_vintf_fragments),$(xml):$(my_vintf_path)/vintf/manifest/$(notdir $(xml)))
564      my_vintf_installed := $(foreach xml,$(my_vintf_pairs),$(call word-colon,2,$(xml)))
565
566      # Only set up copy rules once, even if another arch variant shares it
567      my_vintf_new_pairs := $(filter-out $(ALL_VINTF_MANIFEST_FRAGMENTS_LIST),$(my_vintf_pairs))
568      ALL_VINTF_MANIFEST_FRAGMENTS_LIST += $(my_vintf_new_pairs)
569
570      ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
571        $(call copy-many-vintf-manifest-files-checked,$(my_vintf_new_pairs))
572        $(my_all_targets) : $(my_vintf_installed)
573        # Install fragments together with the target
574        $(LOCAL_INSTALLED_MODULE) : | $(my_vintf_installed)
575     endif
576    endif # my_vintf_fragments
577
578    # Rule to install the module's companion init.rc.
579    ifneq ($(strip $(LOCAL_FULL_INIT_RC)),)
580      my_init_rc := $(LOCAL_FULL_INIT_RC)
581    else
582      my_init_rc := $(foreach rc,$(LOCAL_INIT_RC_$(my_32_64_bit_suffix)) $(LOCAL_INIT_RC),$(LOCAL_PATH)/$(rc))
583    endif
584    ifneq ($(strip $(my_init_rc)),)
585      # Make doesn't support recovery or ramdisk as an output partition,
586      # but some Soong modules installed in recovery or ramdisk
587      # have init.rc files that need to be installed alongside them.
588      # Manually handle the case where the
589      # output file is in the recovery or ramdisk partition.
590      ifneq (,$(filter $(TARGET_RECOVERY_ROOT_OUT)/%,$(my_module_path)))
591        ifneq (,$(filter $(TARGET_RECOVERY_ROOT_OUT)/first_stage_ramdisk/%,$(my_module_path)))
592            my_init_rc_path := $(TARGET_RECOVERY_ROOT_OUT)/first_stage_ramdisk/system/etc
593        else
594            my_init_rc_path := $(TARGET_RECOVERY_ROOT_OUT)/system/etc
595        endif
596      else ifneq (,$(filter $(TARGET_RAMDISK_OUT)/%,$(my_module_path)))
597        my_init_rc_path := $(TARGET_RAMDISK_OUT)/system/etc
598      else
599        my_init_rc_path := $(TARGET_OUT$(partition_tag)_ETC)
600      endif
601      my_init_rc_pairs := $(foreach rc,$(my_init_rc),$(rc):$(my_init_rc_path)/init/$(notdir $(rc)))
602      my_init_rc_installed := $(foreach rc,$(my_init_rc_pairs),$(call word-colon,2,$(rc)))
603
604      # Make sure we only set up the copy rules once, even if another arch variant
605      # shares a common LOCAL_INIT_RC.
606      my_init_rc_new_pairs := $(filter-out $(ALL_INIT_RC_INSTALLED_PAIRS),$(my_init_rc_pairs))
607      ALL_INIT_RC_INSTALLED_PAIRS += $(my_init_rc_new_pairs)
608
609      ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
610        $(call copy-many-init-script-files-checked,$(my_init_rc_new_pairs))
611        $(my_all_targets) : $(my_init_rc_installed)
612        # Install init_rc together with the target
613        $(LOCAL_INSTALLED_MODULE) : | $(my_init_rc_installed)
614      endif
615    endif # my_init_rc
616
617  endif # !LOCAL_IS_HOST_MODULE
618endif # !LOCAL_UNINSTALLABLE_MODULE
619
620###########################################################
621## CHECK_BUILD goals
622###########################################################
623my_checked_module :=
624# If nobody has defined a more specific module for the
625# checked modules, use LOCAL_BUILT_MODULE.
626ifdef LOCAL_CHECKED_MODULE
627  my_checked_module := $(LOCAL_CHECKED_MODULE)
628else
629  my_checked_module := $(LOCAL_BUILT_MODULE)
630endif
631
632my_checked_module += $(LOCAL_ADDITIONAL_CHECKED_MODULE)
633
634# If they request that this module not be checked, then don't.
635# PLEASE DON'T SET THIS.  ANY PLACES THAT SET THIS WITHOUT
636# GOOD REASON WILL HAVE IT REMOVED.
637ifdef LOCAL_DONT_CHECK_MODULE
638  my_checked_module :=
639endif
640# Don't check build target module defined for the 2nd arch
641ifndef LOCAL_IS_HOST_MODULE
642ifdef LOCAL_2ND_ARCH_VAR_PREFIX
643  my_checked_module :=
644endif
645endif
646
647###########################################################
648## Test Data
649###########################################################
650my_test_data_pairs :=
651my_installed_test_data :=
652# Source to relative dst file paths for reuse in LOCAL_COMPATIBILITY_SUITE.
653my_test_data_file_pairs :=
654
655ifneq ($(strip $(filter NATIVE_TESTS,$(LOCAL_MODULE_CLASS)) $(LOCAL_IS_FUZZ_TARGET)),)
656ifneq ($(strip $(LOCAL_TEST_DATA)),)
657ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
658
659# Soong LOCAL_TEST_DATA is of the form <from_base>:<file>:<relative_install_path>
660# or <from_base>:<file>, to be installed to
661# <install_root>/<relative_install_path>/<file> or <install_root>/<file>,
662# respectively.
663ifeq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
664  define copy_test_data_pairs
665    _src_base := $$(call word-colon,1,$$(td))
666    _file := $$(call word-colon,2,$$(td))
667    _relative_install_path := $$(call word-colon,3,$$(td))
668    ifeq (,$$(_relative_install_path))
669        _relative_dest_file := $$(_file)
670    else
671        _relative_dest_file := $$(call append-path,$$(_relative_install_path),$$(_file))
672    endif
673    my_test_data_pairs += $$(call append-path,$$(_src_base),$$(_file)):$$(call append-path,$$(my_module_path),$$(_relative_dest_file))
674    my_test_data_file_pairs += $$(call append-path,$$(_src_base),$$(_file)):$$(_relative_dest_file)
675  endef
676else
677  define copy_test_data_pairs
678    _src_base := $$(call word-colon,1,$$(td))
679    _file := $$(call word-colon,2,$$(td))
680    ifndef _file
681      _file := $$(_src_base)
682      _src_base := $$(LOCAL_PATH)
683    endif
684    ifneq (,$$(findstring ..,$$(_file)))
685      $$(call pretty-error,LOCAL_TEST_DATA may not include '..': $$(_file))
686    endif
687    ifneq (,$$(filter/%,$$(_src_base) $$(_file)))
688      $$(call pretty-error,LOCAL_TEST_DATA may not include absolute paths: $$(_src_base) $$(_file))
689    endif
690    my_test_data_pairs += $$(call append-path,$$(_src_base),$$(_file)):$$(call append-path,$$(my_module_path),$$(_file))
691    my_test_data_file_pairs += $$(call append-path,$$(_src_base),$$(_file)):$$(_file)
692  endef
693endif
694
695$(foreach td,$(LOCAL_TEST_DATA),$(eval $(copy_test_data_pairs)))
696
697copy_test_data_pairs :=
698
699ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
700  my_installed_test_data := $(call copy-many-files,$(my_test_data_pairs))
701  $(LOCAL_INSTALLED_MODULE): $(my_installed_test_data)
702else
703  # Skip installing test data for Soong modules, it's already been handled.
704  # Just compute my_installed_test_data.
705  my_installed_test_data := $(foreach f, $(my_test_data_pairs), $(call word-colon,2,$(f)))
706endif
707
708endif
709endif
710endif
711
712###########################################################
713## SOONG INSTALL PAIRS
714###########################################################
715# Declare dependencies for LOCAL_SOONG_INSTALL_PAIRS in soong to the module it relies on.
716ifneq (,$(LOCAL_SOONG_INSTALLED_MODULE))
717$(my_all_targets): \
718    $(foreach f, $(LOCAL_SOONG_INSTALL_PAIRS),\
719      $(word 2,$(subst :,$(space),$(f))))
720endif
721
722###########################################################
723## Compatibility suite files.
724###########################################################
725ifdef LOCAL_COMPATIBILITY_SUITE
726
727ifneq (,$(LOCAL_FULL_TEST_CONFIG))
728  test_config := $(LOCAL_FULL_TEST_CONFIG)
729else ifneq (,$(LOCAL_TEST_CONFIG))
730  test_config := $(LOCAL_PATH)/$(LOCAL_TEST_CONFIG)
731else
732  test_config := $(wildcard $(LOCAL_PATH)/AndroidTest.xml)
733endif
734
735ifeq ($(EXCLUDE_MCTS),true)
736ifeq (,$(filter $(LOCAL_MODULE),$(mcts_whitelist)))
737  ifneq (,$(test_config))
738    ifneq (,$(filter mcts-%,$(LOCAL_COMPATIBILITY_SUITE)))
739      LOCAL_COMPATIBILITY_SUITE := $(filter-out cts,$(LOCAL_COMPATIBILITY_SUITE))
740    endif
741  endif
742endif
743endif
744
745ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
746
747ifeq ($(EXCLUDE_MCTS),true)
748  ifneq (,$(test_config))
749    ifneq (,$(filter mcts-%,$(LOCAL_COMPATIBILITY_SUITE)))
750      LOCAL_COMPATIBILITY_SUITE := $(filter-out cts,$(LOCAL_COMPATIBILITY_SUITE))
751    endif
752  endif
753endif
754
755# If we are building a native test or benchmark and its stem variants are not defined,
756# separate the multiple architectures into subdirectories of the testcase folder.
757arch_dir :=
758is_native :=
759multi_arch :=
760ifeq ($(LOCAL_MODULE_CLASS),NATIVE_TESTS)
761  is_native := true
762  multi_arch := true
763endif
764ifdef LOCAL_MULTILIB
765  multi_arch := true
766# These conditionals allow this functionality to be mimicked in Soong
767else ifeq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
768  ifeq ($(LOCAL_MODULE_CLASS),SHARED_LIBRARIES)
769    multi_arch := true
770  endif
771endif
772
773ifdef multi_arch
774arch_dir := /$($(my_prefix)$(LOCAL_2ND_ARCH_VAR_PREFIX)ARCH)
775else
776ifeq ($(use_testcase_folder),true)
777  arch_dir := /$($(my_prefix)$(LOCAL_2ND_ARCH_VAR_PREFIX)ARCH)
778endif
779endif
780
781multi_arch :=
782
783my_default_test_module :=
784my_default_test_module := $($(my_prefix)OUT_TESTCASES)/$(LOCAL_MODULE)$(arch_dir)/$(my_installed_module_stem)
785ifneq ($(LOCAL_INSTALLED_MODULE),$(my_default_test_module))
786# Install into the testcase folder
787$(LOCAL_INSTALLED_MODULE) : $(my_default_test_module)
788endif
789
790# The module itself.
791$(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
792  $(eval my_compat_dist_$(suite) := $(patsubst %:$(LOCAL_INSTALLED_MODULE),$(LOCAL_INSTALLED_MODULE):$(LOCAL_INSTALLED_MODULE),\
793    $(foreach dir, $(call compatibility_suite_dirs,$(suite),$(arch_dir)), \
794      $(LOCAL_BUILT_MODULE):$(dir)/$(my_installed_module_stem)))) \
795  $(eval my_compat_module_arch_dir_$(suite).$(my_register_name) :=) \
796  $(foreach dir,$(call compatibility_suite_dirs,$(suite),$(arch_dir)),$(eval my_compat_module_arch_dir_$(suite).$(my_register_name) += $(dir))) \
797  $(eval my_compat_dist_config_$(suite) := ))
798
799ifneq (,$(LOCAL_SOONG_CLASSES_JAR))
800    $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
801      $(eval my_compat_api_map_$(suite) += $(LOCAL_SOONG_CLASSES_JAR)))
802endif
803
804# Auto-generate build config.
805ifeq (,$(test_config))
806  ifneq (true,$(is_native))
807    is_instrumentation_test := true
808    ifeq (true, $(LOCAL_IS_HOST_MODULE))
809      is_instrumentation_test := false
810    endif
811    # If LOCAL_MODULE_CLASS is not APPS, it's certainly not an instrumentation
812    # test. However, some packages for test data also have LOCAL_MODULE_CLASS
813    # set to APPS. These will require flag LOCAL_DISABLE_AUTO_GENERATE_TEST_CONFIG
814    # to disable auto-generating test config file.
815    ifneq (APPS, $(LOCAL_MODULE_CLASS))
816      is_instrumentation_test := false
817    endif
818  endif
819  # CTS modules can be used for test data, so test config files must be
820  # explicitly created using AndroidTest.xml
821  ifeq (,$(filter cts, $(LOCAL_COMPATIBILITY_SUITE)))
822    ifneq (true, $(LOCAL_DISABLE_AUTO_GENERATE_TEST_CONFIG))
823      ifeq (true, $(filter true,$(is_native) $(is_instrumentation_test)))
824        include $(BUILD_SYSTEM)/autogen_test_config.mk
825        test_config := $(autogen_test_config_file)
826        autogen_test_config_file :=
827      endif
828    endif
829  endif
830endif
831is_instrumentation_test :=
832
833# Currently this flag variable is true only for the `android_test_helper_app` type module
834# which should not have any .config file
835ifeq (true, $(LOCAL_DISABLE_TEST_CONFIG))
836  test_config :=
837endif
838
839# Make sure we only add the files once for multilib modules.
840ifdef $(my_prefix)$(LOCAL_MODULE_CLASS)_$(LOCAL_MODULE)_compat_files
841  # Sync the auto_test_config value for multilib modules.
842  ifdef $(my_prefix)$(LOCAL_MODULE_CLASS)_$(LOCAL_MODULE)_autogen
843    ALL_MODULES.$(my_register_name).auto_test_config := true
844  endif
845else
846  $(my_prefix)$(LOCAL_MODULE_CLASS)_$(LOCAL_MODULE)_compat_files := true
847  # LOCAL_COMPATIBILITY_SUPPORT_FILES is a list of <src>[:<dest>].
848  $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
849    $(eval my_compat_dist_$(suite) += $(foreach f, $(LOCAL_COMPATIBILITY_SUPPORT_FILES), \
850      $(eval p := $(subst :,$(space),$(f))) \
851      $(eval s := $(word 1,$(p))) \
852      $(eval n := $(or $(word 2,$(p)),$(notdir $(word 1, $(p))))) \
853      $(foreach dir, $(call compatibility_suite_dirs,$(suite)), \
854        $(s):$(dir)/$(n)))))
855
856  $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
857     $(eval my_compat_api_map_$(suite) += $(foreach f, $(LOCAL_COMPATIBILITY_SUPPORT_FILES), \
858       $(eval p := $(subst :,$(space),$(f))) \
859       $(eval s := $(word 1,$(p))) \
860       $(if $(filter %.apk,$(s)) $(filter %.jar,$(s)),$(s),))))
861
862  ifneq (,$(test_config))
863    $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
864      $(eval my_compat_dist_config_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite)), \
865        $(test_config):$(dir)/$(LOCAL_MODULE).config$(LOCAL_TEST_CONFIG_SUFFIX))))
866  endif
867
868  ifneq (,$(LOCAL_EXTRA_FULL_TEST_CONFIGS))
869    $(foreach test_config_file, $(LOCAL_EXTRA_FULL_TEST_CONFIGS), \
870      $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
871        $(eval my_compat_dist_config_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite)), \
872          $(test_config_file):$(dir)/$(basename $(notdir $(test_config_file))).config))))
873  endif
874
875  ifneq (,$(wildcard $(LOCAL_PATH)/DynamicConfig.xml))
876    $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
877      $(eval my_compat_dist_config_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite)), \
878        $(LOCAL_PATH)/DynamicConfig.xml:$(dir)/$(LOCAL_MODULE).dynamic)))
879  endif
880endif # $(my_prefix)$(LOCAL_MODULE_CLASS)_$(LOCAL_MODULE)_compat_files
881
882
883ifeq ($(use_testcase_folder),true)
884ifneq ($(my_test_data_file_pairs),)
885# Filter out existng installed test data paths when collecting test data files to be installed and
886# indexed as they cause build rule conflicts. Instead put them in a separate list which is only
887# used for indexing.
888$(foreach pair, $(my_test_data_file_pairs), \
889  $(eval parts := $(subst :,$(space),$(pair))) \
890  $(eval src_path := $(word 1,$(parts))) \
891  $(eval file := $(word 2,$(parts))) \
892  $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
893    $(eval my_compat_dist_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite),$(arch_dir)), \
894      $(call filter-copy-pair,$(src_path),$(call append-path,$(dir),$(file)),$(my_installed_test_data)))) \
895    $(eval my_compat_dist_test_data_$(suite) += \
896      $(foreach dir, $(call compatibility_suite_dirs,$(suite),$(arch_dir)), \
897        $(filter $(my_installed_test_data),$(call append-path,$(dir),$(file))))) \
898    $(eval my_compat_api_map_$(suite) += \
899      $(if $(filter %.apk,$(src_path)) $(filter %.jar,$(src_path)),$(src_path),))))
900endif
901else
902ifneq ($(my_test_data_file_pairs),)
903$(foreach pair, $(my_test_data_file_pairs), \
904  $(eval parts := $(subst :,$(space),$(pair))) \
905  $(eval src_path := $(word 1,$(parts))) \
906  $(eval file := $(word 2,$(parts))) \
907  $(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
908    $(eval my_compat_dist_$(suite) += $(foreach dir, $(call compatibility_suite_dirs,$(suite),$(arch_dir)), \
909      $(src_path):$(call append-path,$(dir),$(file)))) \
910    $(eval my_compat_api_map_$(suite) += \
911      $(if $(filter %.apk,$(src_path)) $(filter %.jar,$(src_path)),$(src_path),))))
912endif
913endif
914
915
916
917arch_dir :=
918is_native :=
919
920$(call create-suite-dependencies)
921$(foreach suite, $(LOCAL_COMPATIBILITY_SUITE), \
922  $(eval my_compat_dist_config_$(suite) := ) \
923  $(eval my_compat_dist_test_data_$(suite) := ) \
924  $(eval my_compat_api_map_$(suite) := ))
925
926endif  # LOCAL_UNINSTALLABLE_MODULE
927
928# HACK: pretend a soong LOCAL_FULL_TEST_CONFIG is autogenerated by setting the flag in
929# module-info.json
930# TODO: (b/113029686) Add explicit flag from Soong to determine if a test was
931# autogenerated.
932ifneq (,$(filter $(SOONG_OUT_DIR)%,$(LOCAL_FULL_TEST_CONFIG)))
933  ifeq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
934    ALL_MODULES.$(my_register_name).auto_test_config := true
935  endif
936endif
937
938endif  # LOCAL_COMPATIBILITY_SUITE
939
940my_supported_variant :=
941ifeq ($(my_host_cross),true)
942  my_supported_variant := HOST_CROSS
943else
944  ifdef LOCAL_IS_HOST_MODULE
945    my_supported_variant := HOST
946  else
947    my_supported_variant := DEVICE
948  endif
949endif
950
951###########################################################
952## Register with ALL_MODULES
953###########################################################
954
955ifndef ALL_MODULES.$(my_register_name).PATH
956    # These keys are no longer used, they've been replaced by keys that specify
957    # target/host/host_cross (REQUIRED_FROM_TARGET / REQUIRED_FROM_HOST) and similar.
958    #
959    # Marking them obsolete to ensure that anyone using these internal variables looks for
960    # alternates.
961    $(KATI_obsolete_var ALL_MODULES.$(my_register_name).REQUIRED)
962    $(KATI_obsolete_var ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED)
963    $(KATI_obsolete_var ALL_MODULES.$(my_register_name).HOST_REQUIRED)
964    $(KATI_obsolete_var ALL_MODULES.$(my_register_name).TARGET_REQUIRED)
965endif
966
967ALL_MODULES += $(my_register_name)
968
969# Don't use += on subvars, or else they'll end up being
970# recursively expanded.
971ALL_MODULES.$(my_register_name).CLASS := \
972    $(ALL_MODULES.$(my_register_name).CLASS) $(LOCAL_MODULE_CLASS)
973ALL_MODULES.$(my_register_name).PATH := \
974    $(ALL_MODULES.$(my_register_name).PATH) $(LOCAL_PATH)
975ALL_MODULES.$(my_register_name).TAGS := \
976    $(ALL_MODULES.$(my_register_name).TAGS) $(LOCAL_MODULE_TAGS)
977ALL_MODULES.$(my_register_name).CHECKED := \
978    $(ALL_MODULES.$(my_register_name).CHECKED) $(my_checked_module)
979ALL_MODULES.$(my_register_name).BUILT := \
980    $(ALL_MODULES.$(my_register_name).BUILT) $(LOCAL_BUILT_MODULE)
981ALL_MODULES.$(my_register_name).SOONG_MODULE_TYPE := \
982    $(ALL_MODULES.$(my_register_name).SOONG_MODULE_TYPE) $(LOCAL_SOONG_MODULE_TYPE)
983ALL_MODULES.$(my_register_name).IS_SOONG_MODULE := \
984    $(if $(filter $(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK)),true)
985ifndef LOCAL_IS_HOST_MODULE
986ALL_MODULES.$(my_register_name).TARGET_BUILT := \
987    $(ALL_MODULES.$(my_register_name).TARGET_BUILT) $(LOCAL_BUILT_MODULE)
988endif
989ifneq (,$(LOCAL_SOONG_INSTALLED_MODULE))
990  # Store the list of paths to installed locations of files provided by this
991  # module.  Used as dependencies of the image packaging rules when the module
992  # is installed by the current product.
993  ALL_MODULES.$(my_register_name).INSTALLED := \
994    $(strip $(ALL_MODULES.$(my_register_name).INSTALLED) \
995      $(foreach f, $(LOCAL_SOONG_INSTALL_PAIRS),\
996        $(word 2,$(subst :,$(space),$(f)))) \
997      $(LOCAL_SOONG_INSTALL_SYMLINKS) \
998      $(my_init_rc_installed) \
999      $(my_installed_test_data) \
1000      $(my_vintf_installed))
1001
1002  ALL_MODULES.$(my_register_name).INSTALLED_SYMLINKS := $(LOCAL_SOONG_INSTALL_SYMLINKS)
1003
1004  # Store the list of colon-separated pairs of the built and installed locations
1005  # of files provided by this module.  Used by custom packaging rules like
1006  # package-modules.mk that need to copy the built files to a custom install
1007  # location during packaging.
1008  #
1009  # Translate copies from $(LOCAL_PREBUILT_MODULE_FILE) to $(LOCAL_BUILT_MODULE)
1010  # so that package-modules.mk gets any transtive dependencies added to
1011  # $(LOCAL_BUILT_MODULE), for example unstripped symbols files.
1012  ALL_MODULES.$(my_register_name).BUILT_INSTALLED := \
1013    $(strip $(ALL_MODULES.$(my_register_name).BUILT_INSTALLED) \
1014      $(patsubst $(LOCAL_PREBUILT_MODULE_FILE):%,$(LOCAL_BUILT_MODULE):%,$(LOCAL_SOONG_INSTALL_PAIRS)) \
1015      $(my_init_rc_pairs) \
1016      $(my_test_data_pairs) \
1017      $(my_vintf_pairs))
1018  # Store the list of vintf/init_rc as order-only dependencies
1019  ALL_MODULES.$(my_register_name).ORDERONLY_INSTALLED := \
1020    $(strip $(ALL_MODULES.$(my_register_name).ORDERONLY_INSTALLED) \
1021      $(my_init_rc_installed) \
1022      $(my_vintf_installed))
1023else ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
1024  ALL_MODULES.$(my_register_name).INSTALLED := \
1025    $(strip $(ALL_MODULES.$(my_register_name).INSTALLED) \
1026    $(LOCAL_INSTALLED_MODULE) $(my_init_rc_installed) $(my_installed_symlinks) \
1027    $(my_installed_test_data) $(my_vintf_installed))
1028  ALL_MODULES.$(my_register_name).BUILT_INSTALLED := \
1029    $(strip $(ALL_MODULES.$(my_register_name).BUILT_INSTALLED) \
1030    $(LOCAL_BUILT_MODULE):$(LOCAL_INSTALLED_MODULE) \
1031    $(my_init_rc_pairs) $(my_test_data_pairs) $(my_vintf_pairs))
1032  ALL_MODULES.$(my_register_name).ORDERONLY_INSTALLED := \
1033    $(strip $(ALL_MODULES.$(my_register_name).ORDERONLY_INSTALLED) \
1034      $(my_init_rc_installed) \
1035      $(my_vintf_installed))
1036endif
1037
1038# Mark LOCAL_SOONG_INSTALL_SYMLINKS as installed if we're installing any kind of module, not just
1039# ones that set LOCAL_SOONG_INSTALLED_MODULE. This is so we can have a soong module that only
1040# installs symlinks (e.g. installed_symlink). We can't set LOCAL_SOONG_INSTALLED_MODULE to a symlink
1041# because cp commands will fail on symlinks.
1042ifneq (,$(or $(LOCAL_SOONG_INSTALLED_MODULE),$(call boolean-not,$(LOCAL_UNINSTALLABLE_MODULE))))
1043  ALL_MODULES.$(my_register_name).INSTALLED += $(LOCAL_SOONG_INSTALL_SYMLINKS)
1044  ALL_MODULES.$(my_register_name).INSTALLED_SYMLINKS := $(LOCAL_SOONG_INSTALL_SYMLINKS)
1045endif
1046
1047ifdef LOCAL_PICKUP_FILES
1048# Files or directories ready to pick up by the build system
1049# when $(LOCAL_BUILT_MODULE) is done.
1050ALL_MODULES.$(my_register_name).PICKUP_FILES := \
1051    $(ALL_MODULES.$(my_register_name).PICKUP_FILES) $(LOCAL_PICKUP_FILES)
1052endif
1053# Record the platform availability of this module. Note that the availability is not
1054# meaningful for non-installable modules (e.g., static libs) or host modules.
1055# We only care about modules that are installable to the device.
1056ifeq (true,$(LOCAL_NOT_AVAILABLE_FOR_PLATFORM))
1057  ifneq (true,$(LOCAL_UNINSTALLABLE_MODULE))
1058    ifndef LOCAL_IS_HOST_MODULE
1059      ALL_MODULES.$(my_register_name).NOT_AVAILABLE_FOR_PLATFORM := true
1060    endif
1061  endif
1062endif
1063
1064my_required_modules := $(LOCAL_REQUIRED_MODULES) \
1065    $(LOCAL_REQUIRED_MODULES_$(TARGET_$(LOCAL_2ND_ARCH_VAR_PREFIX)ARCH))
1066ifdef LOCAL_IS_HOST_MODULE
1067my_required_modules += $(LOCAL_REQUIRED_MODULES_$($(my_prefix)OS))
1068endif
1069
1070ifdef LOCAL_ACONFIG_FILES
1071  ALL_MODULES.$(my_register_name).ACONFIG_FILES := \
1072      $(ALL_MODULES.$(my_register_name).ACONFIG_FILES) $(LOCAL_ACONFIG_FILES)
1073endif
1074
1075ifdef LOCAL_FILESYSTEM_FILELIST
1076  ALL_MODULES.$(my_register_name).FILESYSTEM_FILELIST := \
1077      $(ALL_MODULES.$(my_register_name).FILESYSTEM_FILELIST) $(LOCAL_FILESYSTEM_FILELIST)
1078endif
1079
1080ifndef LOCAL_SOONG_MODULE_INFO_JSON
1081  ALL_MAKE_MODULE_INFO_JSON_MODULES += $(my_register_name)
1082  ALL_MODULES.$(my_register_name).SHARED_LIBS := \
1083      $(ALL_MODULES.$(my_register_name).SHARED_LIBS) $(LOCAL_SHARED_LIBRARIES)
1084
1085  ALL_MODULES.$(my_register_name).STATIC_LIBS := \
1086      $(ALL_MODULES.$(my_register_name).STATIC_LIBS) $(LOCAL_STATIC_LIBRARIES)
1087
1088  ALL_MODULES.$(my_register_name).SYSTEM_SHARED_LIBS := \
1089      $(ALL_MODULES.$(my_register_name).SYSTEM_SHARED_LIBS) $(LOCAL_SYSTEM_SHARED_LIBRARIES)
1090
1091  ALL_MODULES.$(my_register_name).LOCAL_RUNTIME_LIBRARIES := \
1092      $(ALL_MODULES.$(my_register_name).LOCAL_RUNTIME_LIBRARIES) $(LOCAL_RUNTIME_LIBRARIES) \
1093      $(LOCAL_JAVA_LIBRARIES)
1094
1095  ALL_MODULES.$(my_register_name).LOCAL_STATIC_LIBRARIES := \
1096      $(ALL_MODULES.$(my_register_name).LOCAL_STATIC_LIBRARIES) $(LOCAL_STATIC_JAVA_LIBRARIES)
1097
1098  ifneq ($(my_test_data_file_pairs),)
1099    # Export the list of targets that are handled as data inputs and required
1100    # by tests at runtime. The format of my_test_data_file_pairs is
1101    # is $(path):$(relative_file) but for module-info, only the string after
1102    # ":" is needed.
1103    ALL_MODULES.$(my_register_name).TEST_DATA := \
1104      $(strip $(ALL_MODULES.$(my_register_name).TEST_DATA) \
1105        $(foreach f, $(my_test_data_file_pairs),\
1106          $(call word-colon,2,$(f))))
1107  endif
1108
1109  ifdef LOCAL_TEST_DATA_BINS
1110    ALL_MODULES.$(my_register_name).TEST_DATA_BINS := \
1111        $(ALL_MODULES.$(my_register_name).TEST_DATA_BINS) $(LOCAL_TEST_DATA_BINS)
1112  endif
1113
1114  ALL_MODULES.$(my_register_name).SUPPORTED_VARIANTS := \
1115      $(ALL_MODULES.$(my_register_name).SUPPORTED_VARIANTS) \
1116      $(filter-out $(ALL_MODULES.$(my_register_name).SUPPORTED_VARIANTS),$(my_supported_variant))
1117
1118  ALL_MODULES.$(my_register_name).COMPATIBILITY_SUITES := \
1119      $(ALL_MODULES.$(my_register_name).COMPATIBILITY_SUITES) $(LOCAL_COMPATIBILITY_SUITE)
1120  ALL_MODULES.$(my_register_name).MODULE_NAME := $(LOCAL_MODULE)
1121  ALL_MODULES.$(my_register_name).TEST_CONFIG := $(test_config)
1122  ALL_MODULES.$(my_register_name).EXTRA_TEST_CONFIGS := $(LOCAL_EXTRA_FULL_TEST_CONFIGS)
1123  ALL_MODULES.$(my_register_name).TEST_MAINLINE_MODULES := $(LOCAL_TEST_MAINLINE_MODULES)
1124  ifdef LOCAL_IS_UNIT_TEST
1125    ALL_MODULES.$(my_register_name).IS_UNIT_TEST := $(LOCAL_IS_UNIT_TEST)
1126  endif
1127  ifdef LOCAL_TEST_OPTIONS_TAGS
1128    ALL_MODULES.$(my_register_name).TEST_OPTIONS_TAGS := $(LOCAL_TEST_OPTIONS_TAGS)
1129  endif
1130
1131  ##########################################################
1132  # Track module-level dependencies.
1133  # (b/204397180) Unlock RECORD_ALL_DEPS was acknowledged reasonable for better Atest performance.
1134  ALL_MODULES.$(my_register_name).ALL_DEPS := \
1135    $(ALL_MODULES.$(my_register_name).ALL_DEPS) \
1136    $(LOCAL_STATIC_LIBRARIES) \
1137    $(LOCAL_WHOLE_STATIC_LIBRARIES) \
1138    $(LOCAL_SHARED_LIBRARIES) \
1139    $(LOCAL_DYLIB_LIBRARIES) \
1140    $(LOCAL_RLIB_LIBRARIES) \
1141    $(LOCAL_PROC_MACRO_LIBRARIES) \
1142    $(LOCAL_HEADER_LIBRARIES) \
1143    $(LOCAL_STATIC_JAVA_LIBRARIES) \
1144    $(LOCAL_JAVA_LIBRARIES) \
1145    $(LOCAL_JNI_SHARED_LIBRARIES)
1146
1147endif
1148ALL_MODULES.$(my_register_name).TEST_MODULE_CONFIG_BASE := $(LOCAL_TEST_MODULE_CONFIG_BASE)
1149
1150##########################################################################
1151## When compiling against API imported module, use API import stub
1152## libraries.
1153##########################################################################
1154ifneq ($(call module-in-vendor-or-product),)
1155  ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
1156    apiimport_postfix := .apiimport
1157    ifeq ($(LOCAL_IN_PRODUCT),true)
1158      apiimport_postfix := .apiimport.product
1159    else
1160      apiimport_postfix := .apiimport.vendor
1161    endif
1162
1163    my_required_modules := $(foreach l,$(my_required_modules), \
1164      $(if $(filter $(l), $(API_IMPORTED_SHARED_LIBRARIES)), $(l)$(apiimport_postfix), $(l)))
1165  endif
1166endif
1167
1168##########################################################################
1169## When compiling against the VNDK, add the .vendor or .product suffix to
1170## required modules.
1171##########################################################################
1172ifneq ($(call module-in-vendor-or-product),)
1173  #####################################################
1174  ## Soong modules may be built three times, once for
1175  ## /system, once for /vendor and once for /product.
1176  ## If we're using the VNDK, switch all soong
1177  ## libraries over to the /vendor or /product variant.
1178  #####################################################
1179  ifneq ($(LOCAL_MODULE_MAKEFILE),$(SOONG_ANDROID_MK))
1180    # We don't do this renaming for soong-defined modules since they already
1181    # have correct names (with .vendor or .product suffix when necessary) in
1182    # their LOCAL_*_LIBRARIES.
1183    ifeq ($(LOCAL_IN_PRODUCT),true)
1184      my_required_modules := $(foreach l,$(my_required_modules),\
1185        $(if $(SPLIT_PRODUCT.SHARED_LIBRARIES.$(l)),$(l).product,$(l)))
1186    else
1187      my_required_modules := $(foreach l,$(my_required_modules),\
1188        $(if $(SPLIT_VENDOR.SHARED_LIBRARIES.$(l)),$(l).vendor,$(l)))
1189    endif
1190  endif
1191endif
1192
1193ifdef LOCAL_IS_HOST_MODULE
1194    ifneq ($(my_host_cross),true)
1195        ALL_MODULES.$(my_register_name).REQUIRED_FROM_HOST := \
1196            $(strip $(ALL_MODULES.$(my_register_name).REQUIRED_FROM_HOST) $(my_required_modules))
1197        ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_HOST := \
1198            $(strip $(ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_HOST)\
1199                $(my_required_modules))
1200        ALL_MODULES.$(my_register_name).TARGET_REQUIRED_FROM_HOST := \
1201            $(strip $(ALL_MODULES.$(my_register_name).TARGET_REQUIRED_FROM_HOST)\
1202                $(LOCAL_TARGET_REQUIRED_MODULES))
1203    else
1204        ALL_MODULES.$(my_register_name).REQUIRED_FROM_HOST_CROSS := \
1205            $(strip $(ALL_MODULES.$(my_register_name).REQUIRED_FROM_HOST_CROSS) $(my_required_modules))
1206        ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_HOST_CROSS := \
1207            $(strip $(ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_HOST_CROSS)\
1208                $(my_required_modules))
1209        ifdef LOCAL_TARGET_REQUIRED_MODULES
1210            $(call pretty-error,LOCAL_TARGET_REQUIRED_MODULES may not be used from host_cross modules)
1211        endif
1212    endif
1213    ifdef LOCAL_HOST_REQUIRED_MODULES
1214        $(call pretty-error,LOCAL_HOST_REQUIRED_MODULES may not be used from host modules. Use LOCAL_REQUIRED_MODULES instead)
1215    endif
1216else
1217    ALL_MODULES.$(my_register_name).REQUIRED_FROM_TARGET := \
1218        $(strip $(ALL_MODULES.$(my_register_name).REQUIRED_FROM_TARGET) $(my_required_modules))
1219    ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_TARGET := \
1220        $(strip $(ALL_MODULES.$(my_register_name).EXPLICITLY_REQUIRED_FROM_TARGET)\
1221            $(my_required_modules))
1222    ALL_MODULES.$(my_register_name).HOST_REQUIRED_FROM_TARGET := \
1223        $(strip $(ALL_MODULES.$(my_register_name).HOST_REQUIRED_FROM_TARGET)\
1224            $(LOCAL_HOST_REQUIRED_MODULES))
1225    ifdef LOCAL_TARGET_REQUIRED_MODULES
1226        $(call pretty-error,LOCAL_TARGET_REQUIRED_MODULES may not be used from target modules. Use LOCAL_REQUIRED_MODULES instead)
1227    endif
1228endif
1229
1230ifdef event_log_tags
1231  ALL_MODULES.$(my_register_name).EVENT_LOG_TAGS := \
1232      $(ALL_MODULES.$(my_register_name).EVENT_LOG_TAGS) $(event_log_tags)
1233endif
1234
1235ALL_MODULES.$(my_register_name).MAKEFILE := \
1236    $(ALL_MODULES.$(my_register_name).MAKEFILE) $(LOCAL_MODULE_MAKEFILE)
1237
1238ifdef LOCAL_MODULE_OWNER
1239  ALL_MODULES.$(my_register_name).OWNER := \
1240      $(sort $(ALL_MODULES.$(my_register_name).OWNER) $(LOCAL_MODULE_OWNER))
1241endif
1242
1243ifdef LOCAL_2ND_ARCH_VAR_PREFIX
1244ALL_MODULES.$(my_register_name).FOR_2ND_ARCH := true
1245endif
1246ALL_MODULES.$(my_register_name).FOR_HOST_CROSS := $(my_host_cross)
1247ifndef LOCAL_IS_HOST_MODULE
1248ALL_MODULES.$(my_register_name).APEX_KEYS_FILE := $(LOCAL_APEX_KEY_PATH)
1249endif
1250test_config :=
1251
1252INSTALLABLE_FILES.$(LOCAL_INSTALLED_MODULE).MODULE := $(my_register_name)
1253
1254###########################################################
1255## umbrella targets used to verify builds
1256###########################################################
1257j_or_n :=
1258ifneq (,$(filter EXECUTABLES SHARED_LIBRARIES STATIC_LIBRARIES HEADER_LIBRARIES NATIVE_TESTS RLIB_LIBRARIES DYLIB_LIBRARIES PROC_MACRO_LIBRARIES,$(LOCAL_MODULE_CLASS)))
1259j_or_n := native
1260else
1261ifneq (,$(filter JAVA_LIBRARIES APPS,$(LOCAL_MODULE_CLASS)))
1262j_or_n := java
1263endif
1264endif
1265ifdef LOCAL_IS_HOST_MODULE
1266h_or_t := host
1267ifeq ($(my_host_cross),true)
1268h_or_hc_or_t := host-cross
1269else
1270h_or_hc_or_t := host
1271endif
1272else
1273h_or_hc_or_t := target
1274h_or_t := target
1275endif
1276
1277
1278ifdef j_or_n
1279$(j_or_n) $(h_or_t) $(j_or_n)-$(h_or_hc_or_t) : $(my_checked_module)
1280ifneq (,$(filter $(LOCAL_MODULE_TAGS),tests))
1281$(j_or_n)-$(h_or_t)-tests $(j_or_n)-tests $(h_or_t)-tests : $(my_checked_module)
1282endif
1283$(LOCAL_MODULE)-$(h_or_hc_or_t) : $(my_all_targets)
1284.PHONY: $(LOCAL_MODULE)-$(h_or_hc_or_t)
1285ifeq ($(j_or_n),native)
1286$(LOCAL_MODULE)-$(h_or_hc_or_t)$(my_32_64_bit_suffix) : $(my_all_targets)
1287.PHONY: $(LOCAL_MODULE)-$(h_or_hc_or_t)$(my_32_64_bit_suffix)
1288endif
1289endif
1290
1291$(if $(my_register_name),$(eval ALL_MODULES.$(my_register_name).MAKE_MODULE_TYPE:=base_rules))
1292
1293###########################################################
1294# Ensure privileged applications always have LOCAL_PRIVILEGED_MODULE
1295###########################################################
1296ifndef LOCAL_PRIVILEGED_MODULE
1297  ifneq (,$(filter $(TARGET_OUT_APPS_PRIVILEGED)/% $(TARGET_OUT_VENDOR_APPS_PRIVILEGED)/%,$(my_module_path)))
1298    LOCAL_PRIVILEGED_MODULE := true
1299  endif
1300endif
1301
1302###########################################################
1303## NOTICE files
1304###########################################################
1305
1306include $(BUILD_NOTICE_FILE)
1307
1308###########################################################
1309## SBOM generation
1310###########################################################
1311include $(BUILD_SBOM_GEN)
1312