1# Package up modules to a zip file.
2# It preserves the install path of the modules' installed files.
3#
4# Input variables:
5#   my_modules: a list of module names
6#   my_package_name: the name of the output zip file.
7#   my_copy_pairs: a list of extra files to install (in src:dest format)
8# Optional input variables:
9#   my_modules_strict: what happens when a module from my_modules does not exist
10#     "true": error out when a module is missing
11#     "false": print a warning when a module is missing
12#     "": defaults to false currently
13# Output variables:
14#   my_package_zip: the path to the output zip file.
15#
16#
17
18my_makefile := $(lastword $(filter-out $(lastword $(MAKEFILE_LIST)),$(MAKEFILE_LIST)))
19
20include $(CLEAR_VARS)
21LOCAL_MODULE := $(my_package_name)
22LOCAL_LICENSE_KINDS := SPDX-license-identifier-Apache-2.0
23LOCAL_LICENSE_CONDITIONS := notice
24LOCAL_LICENSE_PACKAGE_NAME := Android
25LOCAL_NOTICE_FILE := build/soong/licenses/LICENSE
26LOCAL_MODULE_CLASS := PACKAGING
27LOCAL_MODULE_STEM := $(my_package_name).zip
28LOCAL_UNINSTALLABLE_MODULE := true
29include $(BUILD_SYSTEM)/base_rules.mk
30my_staging_dir := $(intermediates)/staging
31my_package_zip := $(LOCAL_BUILT_MODULE)
32
33my_built_modules := $(foreach p,$(my_copy_pairs),$(call word-colon,1,$(p)))
34my_copy_pairs := $(foreach p,$(my_copy_pairs),$(call word-colon,1,$(p)):$(my_staging_dir)/$(call word-colon,2,$(p)))
35my_pickup_files :=
36my_missing_error :=
37
38# Iterate over the modules and include their direct dependencies stated in the
39# LOCAL_REQUIRED_MODULES.
40my_modules_and_deps := $(my_modules)
41$(foreach m,$(my_modules),\
42  $(eval _explicitly_required := \
43    $(strip $(ALL_MODULES.$(m).EXPLICITLY_REQUIRED_FROM_TARGET)\
44    $(ALL_MODULES.$(m)$(TARGET_2ND_ARCH_MODULE_SUFFIX).EXPLICITLY_REQUIRED_FROM_TARGET)))\
45  $(eval my_modules_and_deps += $(_explicitly_required))\
46)
47
48ifneq ($(filter-out true false,$(my_modules_strict)),)
49  $(shell $(call echo-error,$(my_makefile),$(my_package_name): Invalid value for 'my_module_strict' = '$(my_modules_strict)'. Valid values: 'true', 'false', ''))
50  $(error done)
51endif
52
53my_missing_files = $(shell $(call echo-warning,$(my_makefile),$(my_package_name): Unknown installed file for module '$(1)'))$(shell$(call echo-warning,$(my_makefile),$(my_package_name): Some necessary modules may have been skipped by Soong. Check if PRODUCT_SOURCE_ROOT_DIRS is pruning necessary Android.bp files.))
54ifeq ($(ALLOW_MISSING_DEPENDENCIES),true)
55  # Ignore unknown installed files on partial builds
56  my_missing_files =
57else ifneq ($(my_modules_strict),false)
58  my_missing_files = $(shell $(call echo-error,$(my_makefile),$(my_package_name): Unknown installed file for module '$(1)'))$(shell$(call echo-warning,$(my_makefile),$(my_package_name): Some necessary modules may have been skipped by Soong. Check if PRODUCT_SOURCE_ROOT_DIRS is pruning necessary Android.bp files.))$(eval my_missing_error := true)
59endif
60
61# Iterate over modules' built files and installed files;
62# Calculate the dest files in the output zip file.
63
64$(foreach m,$(my_modules_and_deps),\
65  $(eval _pickup_files := $(strip $(ALL_MODULES.$(m).PICKUP_FILES)\
66    $(ALL_MODULES.$(m)$(TARGET_2ND_ARCH_MODULE_SUFFIX).PICKUP_FILES)))\
67  $(eval _built_files := $(strip $(ALL_MODULES.$(m).BUILT_INSTALLED)\
68    $(ALL_MODULES.$(m)$(TARGET_2ND_ARCH_MODULE_SUFFIX).BUILT_INSTALLED)))\
69  $(eval _module_class_folder := $($(strip MODULE_CLASS_$(word 1, $(strip $(ALL_MODULES.$(m).CLASS)\
70    $(ALL_MODULES.$(m)$(TARGET_2ND_ARCH_MODULE_SUFFIX).CLASS))))))\
71  $(if $(_pickup_files)$(_built_files),,\
72    $(call my_missing_files,$(m)))\
73  $(eval my_pickup_files += $(_pickup_files))\
74  $(foreach i, $(_built_files),\
75    $(eval bui_ins := $(subst :,$(space),$(i)))\
76    $(eval ins := $(word 2,$(bui_ins)))\
77    $(if $(filter $(TARGET_OUT_ROOT)/%,$(ins)),\
78      $(eval bui := $(word 1,$(bui_ins)))\
79      $(eval my_built_modules += $(bui))\
80      $(if $(filter $(_module_class_folder), nativetest benchmarktest),\
81        $(eval module_class_folder_stem := $(_module_class_folder)$(findstring 64, $(patsubst $(PRODUCT_OUT)/%,%,$(ins)))),\
82        $(eval module_class_folder_stem := $(_module_class_folder)))\
83      $(eval my_copy_dest := $(patsubst data/%,DATA/%,\
84                               $(patsubst testcases/%,DATA/$(module_class_folder_stem)/%,\
85                                 $(patsubst testcases/$(m)/$(TARGET_ARCH)/%,DATA/$(module_class_folder_stem)/$(m)/%,\
86                                   $(patsubst testcases/$(m)/$(TARGET_2ND_ARCH)/%,DATA/$(module_class_folder_stem)/$(m)/%,\
87                                     $(patsubst system/%,DATA/%,\
88                                       $(patsubst $(PRODUCT_OUT)/%,%,$(ins))))))))\
89      $(eval my_copy_pairs += $(bui):$(my_staging_dir)/$(my_copy_dest)))\
90  ))
91
92ifneq ($(my_missing_error),)
93  $(error done)
94endif
95
96$(my_package_zip): PRIVATE_COPY_PAIRS := $(my_copy_pairs)
97$(my_package_zip): PRIVATE_STAGING_DIR := $(my_staging_dir)
98$(my_package_zip): PRIVATE_PICKUP_FILES := $(my_pickup_files)
99$(my_package_zip) : $(my_built_modules)
100	@echo "Package $@"
101	@rm -rf $(PRIVATE_STAGING_DIR) && mkdir -p $(PRIVATE_STAGING_DIR)
102	$(foreach p, $(PRIVATE_COPY_PAIRS),\
103	  $(eval pair := $(subst :,$(space),$(p)))\
104	  mkdir -p $(dir $(word 2,$(pair))) && \
105	  cp -Rf $(word 1,$(pair)) $(word 2,$(pair)) && ) true
106	$(hide) $(foreach f, $(PRIVATE_PICKUP_FILES),\
107	  cp -RfL $(f) $(PRIVATE_STAGING_DIR) && ) true
108	$(hide) cd $(PRIVATE_STAGING_DIR) && zip -rqX ../$(notdir $@) *
109	rm -rf $(PRIVATE_STAGING_DIR)
110
111my_makefile :=
112my_staging_dir :=
113my_built_modules :=
114my_copy_dest :=
115my_copy_pairs :=
116my_pickup_files :=
117my_missing_files :=
118my_missing_error :=
119my_modules_and_deps :=
120my_modules_strict :=
121