1#
2# Copyright (C) 2019 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############################################################
18# Internal build rules for APPS prebuilt modules
19############################################################
20
21ifneq (APPS,$(LOCAL_MODULE_CLASS))
22$(call pretty-error,app_prebuilt_internal.mk is for APPS modules only)
23endif
24
25ifdef LOCAL_COMPRESSED_MODULE
26  ifneq (true,$(LOCAL_COMPRESSED_MODULE))
27    $(call pretty-error, Unknown value for LOCAL_COMPRESSED_MODULE $(LOCAL_COMPRESSED_MODULE))
28  endif
29  LOCAL_BUILT_MODULE_STEM := package.apk.gz
30  ifndef LOCAL_INSTALLED_MODULE_STEM
31    PACKAGES.$(LOCAL_MODULE).COMPRESSED := gz
32    LOCAL_INSTALLED_MODULE_STEM := $(LOCAL_MODULE).apk.gz
33  endif
34else  # LOCAL_COMPRESSED_MODULE
35  LOCAL_BUILT_MODULE_STEM := package.apk
36  ifndef LOCAL_INSTALLED_MODULE_STEM
37    LOCAL_INSTALLED_MODULE_STEM := $(LOCAL_MODULE).apk
38  endif
39endif  # LOCAL_COMPRESSED_MODULE
40
41include $(BUILD_SYSTEM)/base_rules.mk
42built_module := $(LOCAL_BUILT_MODULE)
43
44# Run veridex on product, system_ext and vendor modules.
45# We skip it for unbundled app builds where we cannot build veridex.
46module_run_appcompat :=
47ifeq (true,$(non_system_module))
48ifeq (,$(TARGET_BUILD_APPS)$(filter true,$(TARGET_BUILD_PDK)))  # ! unbundled app build
49ifneq ($(UNSAFE_DISABLE_HIDDENAPI_FLAGS),true)
50  module_run_appcompat := true
51endif
52endif
53endif
54
55PACKAGES.$(LOCAL_MODULE).OVERRIDES := $(strip $(LOCAL_OVERRIDES_PACKAGES))
56
57my_extract_apk := $(strip $(LOCAL_EXTRACT_APK))
58
59# Select dpi-specific source
60ifdef LOCAL_DPI_VARIANTS
61my_dpi := $(firstword $(filter $(LOCAL_DPI_VARIANTS),$(PRODUCT_AAPT_PREF_CONFIG) $(PRODUCT_AAPT_PREBUILT_DPI)))
62ifdef my_dpi
63ifdef LOCAL_DPI_FILE_STEM
64my_prebuilt_dpi_file_stem := $(LOCAL_DPI_FILE_STEM)
65else
66my_prebuilt_dpi_file_stem := $(LOCAL_MODULE)_%.apk
67endif
68my_prebuilt_src_file := $(dir $(my_prebuilt_src_file))$(subst %,$(my_dpi),$(my_prebuilt_dpi_file_stem))
69
70ifneq ($(strip $(LOCAL_EXTRACT_DPI_APK)),)
71my_extract_apk := $(subst %,$(my_dpi),$(LOCAL_EXTRACT_DPI_APK))
72endif  # LOCAL_EXTRACT_DPI_APK
73endif  # my_dpi
74endif  # LOCAL_DPI_VARIANTS
75
76ifdef my_extract_apk
77my_extracted_apk := $(intermediates)/extracted.apk
78
79$(my_extracted_apk): PRIVATE_EXTRACT := $(my_extract_apk)
80$(my_extracted_apk): $(my_prebuilt_src_file)
81	@echo Extract APK: $@
82	$(hide) mkdir -p $(dir $@) && rm -f $@
83	$(hide) unzip -p $< $(PRIVATE_EXTRACT) >$@
84
85my_prebuilt_src_file := $(my_extracted_apk)
86my_extracted_apk :=
87my_extract_apk :=
88ifeq ($(PRODUCT_ALWAYS_PREOPT_EXTRACTED_APK),true)
89# If the product property is set, always preopt for extracted modules to prevent executing out of
90# the APK.
91my_preopt_for_extracted_apk := true
92endif
93endif
94
95# Verify LOCAL_USES_LIBRARIES/LOCAL_OPTIONAL_USES_LIBRARIES
96# If LOCAL_ENFORCE_USES_LIBRARIES is not set, default to true if either of LOCAL_USES_LIBRARIES or
97# LOCAL_OPTIONAL_USES_LIBRARIES are specified.
98# Will change the default to true unconditionally in the future.
99ifndef LOCAL_ENFORCE_USES_LIBRARIES
100  ifneq (,$(strip $(LOCAL_USES_LIBRARIES)$(LOCAL_OPTIONAL_USES_LIBRARIES)))
101    LOCAL_ENFORCE_USES_LIBRARIES := true
102  endif
103endif
104
105my_enforced_uses_libraries :=
106ifdef LOCAL_ENFORCE_USES_LIBRARIES
107  my_enforced_uses_libraries := $(intermediates.COMMON)/enforce_uses_libraries.timestamp
108  $(my_enforced_uses_libraries): PRIVATE_USES_LIBRARIES := $(LOCAL_USES_LIBRARIES)
109  $(my_enforced_uses_libraries): PRIVATE_OPTIONAL_USES_LIBRARIES := $(LOCAL_OPTIONAL_USES_LIBRARIES)
110  $(my_enforced_uses_libraries): $(BUILD_SYSTEM)/verify_uses_libraries.sh $(AAPT)
111  $(my_enforced_uses_libraries): $(my_prebuilt_src_file)
112	@echo Verifying uses-libraries: $<
113	aapt_binary=$(AAPT) \
114	  uses_library_names="$(strip $(PRIVATE_USES_LIBRARIES))" \
115	  optional_uses_library_names="$(strip $(PRIVATE_OPTIONAL_USES_LIBRARIES))" \
116	  $(BUILD_SYSTEM)/verify_uses_libraries.sh $<
117	touch $@
118  $(built_module) : $(my_enforced_uses_libraries)
119endif
120
121dex_preopt_profile_src_file := $(my_prebuilt_src_file)
122
123rs_compatibility_jni_libs :=
124include $(BUILD_SYSTEM)/install_jni_libs.mk
125
126ifeq ($(LOCAL_CERTIFICATE),EXTERNAL)
127  # The magic string "EXTERNAL" means this package will be signed with
128  # the default dev key throughout the build process, but we expect
129  # the final package to be signed with a different key.
130  #
131  # This can be used for packages where we don't have access to the
132  # keys, but want the package to be predexopt'ed.
133  LOCAL_CERTIFICATE := $(DEFAULT_SYSTEM_DEV_CERTIFICATE)
134  PACKAGES.$(LOCAL_MODULE).EXTERNAL_KEY := 1
135
136  $(built_module) : $(LOCAL_CERTIFICATE).pk8 $(LOCAL_CERTIFICATE).x509.pem
137  $(built_module) : PRIVATE_PRIVATE_KEY := $(LOCAL_CERTIFICATE).pk8
138  $(built_module) : PRIVATE_CERTIFICATE := $(LOCAL_CERTIFICATE).x509.pem
139endif
140ifeq ($(LOCAL_CERTIFICATE),)
141  # It is now a build error to add a prebuilt .apk without
142  # specifying a key for it.
143  $(error No LOCAL_CERTIFICATE specified for prebuilt "$(my_prebuilt_src_file)")
144else ifeq ($(LOCAL_CERTIFICATE),PRESIGNED)
145  # The magic string "PRESIGNED" means this package is already checked
146  # signed with its release key.
147  #
148  # By setting .CERTIFICATE but not .PRIVATE_KEY, this package will be
149  # mentioned in apkcerts.txt (with certificate set to "PRESIGNED")
150  # but the dexpreopt process will not try to re-sign the app.
151  PACKAGES.$(LOCAL_MODULE).CERTIFICATE := PRESIGNED
152  PACKAGES := $(PACKAGES) $(LOCAL_MODULE)
153else
154  # If this is not an absolute certificate, assign it to a generic one.
155  ifeq ($(dir $(strip $(LOCAL_CERTIFICATE))),./)
156    LOCAL_CERTIFICATE := $(dir $(DEFAULT_SYSTEM_DEV_CERTIFICATE))$(LOCAL_CERTIFICATE)
157  endif
158
159  PACKAGES.$(LOCAL_MODULE).PRIVATE_KEY := $(LOCAL_CERTIFICATE).pk8
160  PACKAGES.$(LOCAL_MODULE).CERTIFICATE := $(LOCAL_CERTIFICATE).x509.pem
161  PACKAGES := $(PACKAGES) $(LOCAL_MODULE)
162
163  $(built_module) : $(LOCAL_CERTIFICATE).pk8 $(LOCAL_CERTIFICATE).x509.pem
164  $(built_module) : PRIVATE_PRIVATE_KEY := $(LOCAL_CERTIFICATE).pk8
165  $(built_module) : PRIVATE_CERTIFICATE := $(LOCAL_CERTIFICATE).x509.pem
166
167  additional_certificates := $(foreach c,$(LOCAL_ADDITIONAL_CERTIFICATES), $(c).x509.pem $(c).pk8)
168  $(built_module): $(additional_certificates)
169  $(built_module): PRIVATE_ADDITIONAL_CERTIFICATES := $(additional_certificates)
170
171  $(built_module): $(LOCAL_CERTIFICATE_LINEAGE)
172  $(built_module): PRIVATE_CERTIFICATE_LINEAGE := $(LOCAL_CERTIFICATE_LINEAGE)
173endif
174
175ifneq ($(LOCAL_MODULE_STEM),)
176  PACKAGES.$(LOCAL_MODULE).STEM := $(LOCAL_MODULE_STEM)
177else
178  PACKAGES.$(LOCAL_MODULE).STEM := $(LOCAL_MODULE)
179endif
180
181include $(BUILD_SYSTEM)/app_certificate_validate.mk
182
183# Set a actual_partition_tag (calculated in base_rules.mk) for the package.
184PACKAGES.$(LOCAL_MODULE).PARTITION := $(actual_partition_tag)
185
186# Disable dex-preopt of prebuilts to save space, if requested.
187ifndef LOCAL_DEX_PREOPT
188ifeq ($(DONT_DEXPREOPT_PREBUILTS),true)
189LOCAL_DEX_PREOPT := false
190endif
191endif
192
193# If the module is a compressed module, we don't pre-opt it because its final
194# installation location will be the data partition.
195ifdef LOCAL_COMPRESSED_MODULE
196LOCAL_DEX_PREOPT := false
197endif
198
199my_dex_jar := $(my_prebuilt_src_file)
200
201#######################################
202# defines built_odex along with rule to install odex
203include $(BUILD_SYSTEM)/dex_preopt_odex_install.mk
204#######################################
205ifneq ($(LOCAL_REPLACE_PREBUILT_APK_INSTALLED),)
206# There is a replacement for the prebuilt .apk we can install without any processing.
207$(built_module) : $(LOCAL_REPLACE_PREBUILT_APK_INSTALLED)
208	$(transform-prebuilt-to-target)
209
210else  # ! LOCAL_REPLACE_PREBUILT_APK_INSTALLED
211# Sign and align non-presigned .apks.
212# The embedded prebuilt jni to uncompress.
213ifeq ($(LOCAL_CERTIFICATE),PRESIGNED)
214# For PRESIGNED apks we must uncompress every .so file:
215# even if the .so file isn't for the current TARGET_ARCH,
216# we can't strip the file.
217embedded_prebuilt_jni_libs :=
218endif
219ifndef embedded_prebuilt_jni_libs
220# No LOCAL_PREBUILT_JNI_LIBS, uncompress all.
221embedded_prebuilt_jni_libs :=
222endif
223$(built_module): PRIVATE_EMBEDDED_JNI_LIBS := $(embedded_prebuilt_jni_libs)
224
225ifdef LOCAL_COMPRESSED_MODULE
226$(built_module) : $(MINIGZIP)
227endif
228
229ifeq ($(module_run_appcompat),true)
230$(built_module) : $(appcompat-files)
231$(LOCAL_BUILT_MODULE): PRIVATE_INSTALLED_MODULE := $(LOCAL_INSTALLED_MODULE)
232endif
233
234ifeq ($(module_run_appcompat),true)
235$(built_module) : $(AAPT2)
236endif
237$(built_module) : $(my_prebuilt_src_file) | $(ZIPALIGN) $(ZIP2ZIP) $(SIGNAPK_JAR)
238	$(transform-prebuilt-to-target)
239	$(uncompress-prebuilt-embedded-jni-libs)
240ifeq (true, $(LOCAL_UNCOMPRESS_DEX))
241	$(uncompress-dexs)
242endif  # LOCAL_UNCOMPRESS_DEX
243ifneq ($(LOCAL_CERTIFICATE),PRESIGNED)
244ifeq ($(module_run_appcompat),true)
245	$(call appcompat-header, aapt2)
246	$(run-appcompat)
247endif  # module_run_appcompat
248	$(sign-package)
249	# No need for align-package because sign-package takes care of alignment
250else  # LOCAL_CERTIFICATE == PRESIGNED
251	$(align-package)
252endif  # LOCAL_CERTIFICATE
253ifdef LOCAL_COMPRESSED_MODULE
254	$(compress-package)
255endif  # LOCAL_COMPRESSED_MODULE
256endif  # ! LOCAL_REPLACE_PREBUILT_APK_INSTALLED
257
258
259###############################
260## Install split apks.
261ifdef LOCAL_PACKAGE_SPLITS
262ifdef LOCAL_COMPRESSED_MODULE
263$(error $(LOCAL_MODULE): LOCAL_COMPRESSED_MODULE is not currently supported for split installs)
264endif  # LOCAL_COMPRESSED_MODULE
265
266# LOCAL_PACKAGE_SPLITS is a list of apks to be installed.
267built_apk_splits := $(addprefix $(intermediates)/,$(notdir $(LOCAL_PACKAGE_SPLITS)))
268installed_apk_splits := $(addprefix $(my_module_path)/,$(notdir $(LOCAL_PACKAGE_SPLITS)))
269
270# Rules to sign the split apks.
271my_src_dir := $(sort $(dir $(LOCAL_PACKAGE_SPLITS)))
272ifneq (1,$(words $(my_src_dir)))
273$(error You must put all the split source apks in the same folder: $(LOCAL_PACKAGE_SPLITS))
274endif
275my_src_dir := $(LOCAL_PATH)/$(my_src_dir)
276
277$(built_apk_splits) : $(LOCAL_CERTIFICATE).pk8 $(LOCAL_CERTIFICATE).x509.pem
278$(built_apk_splits) : PRIVATE_PRIVATE_KEY := $(LOCAL_CERTIFICATE).pk8
279$(built_apk_splits) : PRIVATE_CERTIFICATE := $(LOCAL_CERTIFICATE).x509.pem
280$(built_apk_splits) : $(intermediates)/%.apk : $(my_src_dir)/%.apk
281	$(copy-file-to-new-target)
282	$(sign-package)
283
284# Rules to install the split apks.
285$(installed_apk_splits) : $(my_module_path)/%.apk : $(intermediates)/%.apk
286	@echo "Install: $@"
287	$(copy-file-to-new-target)
288
289# Register the additional built and installed files.
290ALL_MODULES.$(my_register_name).INSTALLED += $(installed_apk_splits)
291ALL_MODULES.$(my_register_name).BUILT_INSTALLED += \
292  $(foreach s,$(LOCAL_PACKAGE_SPLITS),$(intermediates)/$(notdir $(s)):$(my_module_path)/$(notdir $(s)))
293
294# Make sure to install the splits when you run "make <module_name>".
295$(my_all_targets): $(installed_apk_splits)
296
297endif # LOCAL_PACKAGE_SPLITS
298
299