package_internal.mk revision efb935800bce97abe0938270ba4c9cd3af6fb7b9 
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###########################################################
18## Standard rules for building an application package.
19##
20## Additional inputs from base_rules.make:
21## LOCAL_PACKAGE_NAME: The name of the package; the directory
22## will be called this.
23##
24## MODULE, MODULE_PATH, and MODULE_SUFFIX will
25## be set for you.
26###########################################################
27
28# If this makefile is being read from within an inheritance,
29# use the new values.
30skip_definition:=
31ifdef LOCAL_PACKAGE_OVERRIDES
32  package_overridden := $(call set-inherited-package-variables)
33  ifeq ($(strip $(package_overridden)),)
34    skip_definition := true
35  endif
36endif
37
38ifndef skip_definition
39
40LOCAL_PACKAGE_NAME := $(strip $(LOCAL_PACKAGE_NAME))
41ifeq ($(LOCAL_PACKAGE_NAME),)
42$(error $(LOCAL_PATH): Package modules must define LOCAL_PACKAGE_NAME)
43endif
44
45ifneq ($(strip $(LOCAL_MODULE_SUFFIX)),)
46$(error $(LOCAL_PATH): Package modules may not define LOCAL_MODULE_SUFFIX)
47endif
48LOCAL_MODULE_SUFFIX := $(COMMON_ANDROID_PACKAGE_SUFFIX)
49
50ifneq ($(strip $(LOCAL_MODULE)),)
51$(error $(LOCAL_PATH): Package modules may not define LOCAL_MODULE)
52endif
53LOCAL_MODULE := $(LOCAL_PACKAGE_NAME)
54
55ifneq ($(strip $(LOCAL_MODULE_CLASS)),)
56$(error $(LOCAL_PATH): Package modules may not set LOCAL_MODULE_CLASS)
57endif
58LOCAL_MODULE_CLASS := APPS
59
60# Package LOCAL_MODULE_TAGS default to optional
61LOCAL_MODULE_TAGS := $(strip $(LOCAL_MODULE_TAGS))
62ifeq ($(LOCAL_MODULE_TAGS),)
63LOCAL_MODULE_TAGS := optional
64endif
65
66ifeq ($(filter tests, $(LOCAL_MODULE_TAGS)),)
67# Force localization check if it's not tagged as tests.
68LOCAL_AAPT_FLAGS := $(LOCAL_AAPT_FLAGS) -z
69endif
70
71ifeq (,$(LOCAL_ASSET_DIR))
72LOCAL_ASSET_DIR := $(LOCAL_PATH)/assets
73endif
74
75# LOCAL_RESOURCE_DIR may point to resource generated during the build
76need_compile_res :=
77ifeq (,$(LOCAL_RESOURCE_DIR))
78  LOCAL_RESOURCE_DIR := $(LOCAL_PATH)/res
79else
80  need_compile_res := true
81endif
82
83package_resource_overlays := $(strip \
84    $(wildcard $(foreach dir, $(PRODUCT_PACKAGE_OVERLAYS), \
85      $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))) \
86    $(wildcard $(foreach dir, $(DEVICE_PACKAGE_OVERLAYS), \
87      $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))))
88
89LOCAL_RESOURCE_DIR := $(package_resource_overlays) $(LOCAL_RESOURCE_DIR)
90
91all_assets := $(strip \
92    $(foreach dir, $(LOCAL_ASSET_DIR), \
93      $(addprefix $(dir)/, \
94        $(patsubst assets/%,%, \
95          $(call find-subdir-assets, $(dir)) \
96         ) \
97       ) \
98     ))
99
100all_resources := $(strip \
101    $(foreach dir, $(LOCAL_RESOURCE_DIR), \
102      $(addprefix $(dir)/, \
103        $(patsubst res/%,%, \
104          $(call find-subdir-assets,$(dir)) \
105         ) \
106       ) \
107     ))
108
109ifneq ($(all_resources),)
110  need_compile_res := true
111endif
112
113all_res_assets := $(strip $(all_assets) $(all_resources))
114
115package_expected_intermediates_COMMON := $(call local-intermediates-dir,COMMON)
116# If no assets or resources were found, clear the directory variables so
117# we don't try to build them.
118ifeq (,$(all_assets))
119LOCAL_ASSET_DIR:=
120endif
121ifneq (true,$(need_compile_res))
122LOCAL_RESOURCE_DIR:=
123R_file_stamp :=
124else
125# Make sure that R_file_stamp inherits the proper PRIVATE vars.
126# If R.stamp moves, be sure to update the framework makefile,
127# which has intimate knowledge of its location.
128R_file_stamp := $(package_expected_intermediates_COMMON)/src/R.stamp
129LOCAL_INTERMEDIATE_TARGETS += $(R_file_stamp)
130endif
131
132LOCAL_BUILT_MODULE_STEM := package.apk
133LOCAL_INSTALLED_MODULE_STEM := $(LOCAL_MODULE).apk
134
135LOCAL_PROGUARD_ENABLED:=$(strip $(LOCAL_PROGUARD_ENABLED))
136ifndef LOCAL_PROGUARD_ENABLED
137ifneq ($(DISABLE_PROGUARD),true)
138    LOCAL_PROGUARD_ENABLED :=full
139endif
140endif
141ifeq ($(LOCAL_PROGUARD_ENABLED),disabled)
142    # the package explicitly request to disable proguard.
143    LOCAL_PROGUARD_ENABLED :=
144endif
145proguard_options_file :=
146ifneq ($(LOCAL_PROGUARD_ENABLED),custom)
147ifeq ($(need_compile_res),true)
148    proguard_options_file := $(package_expected_intermediates_COMMON)/proguard_options
149endif # need_compile_res
150endif # !custom
151LOCAL_PROGUARD_FLAGS := $(addprefix -include ,$(proguard_options_file)) $(LOCAL_PROGUARD_FLAGS)
152
153ifeq (true,$(EMMA_INSTRUMENT))
154ifndef LOCAL_EMMA_INSTRUMENT
155# No emma for test apks.
156ifeq (,$(filer tests,$(LOCAL_MODULE_TAGS))$(LOCAL_INSTRUMENTATION_FOR))
157LOCAL_EMMA_INSTRUMENT := true
158endif # No test apk
159endif # LOCAL_EMMA_INSTRUMENT is not set
160else
161LOCAL_EMMA_INSTRUMENT := false
162endif # EMMA_INSTRUMENT is true
163
164ifeq (true,$(LOCAL_EMMA_INSTRUMENT))
165ifeq (true,$(EMMA_INSTRUMENT_STATIC))
166LOCAL_STATIC_JAVA_LIBRARIES += emma
167else
168ifdef LOCAL_SDK_VERSION
169ifdef TARGET_BUILD_APPS
170# In unbundled build merge the emma library into the apk.
171LOCAL_STATIC_JAVA_LIBRARIES += emma
172else
173# If build against the SDK in full build, core.jar is not used,
174# we have to use prebiult emma.jar to make Proguard happy;
175# Otherwise emma classes are included in core.jar.
176LOCAL_PROGUARD_FLAGS += -libraryjars $(EMMA_JAR)
177endif # full build
178endif # LOCAL_SDK_VERSION
179endif # EMMA_INSTRUMENT_STATIC
180endif # LOCAL_EMMA_INSTRUMENT
181
182rs_compatibility_jni_libs :=
183
184#################################
185include $(BUILD_SYSTEM)/java.mk
186#################################
187
188LOCAL_SDK_RES_VERSION:=$(strip $(LOCAL_SDK_RES_VERSION))
189ifeq ($(LOCAL_SDK_RES_VERSION),)
190  LOCAL_SDK_RES_VERSION:=$(LOCAL_SDK_VERSION)
191endif
192
193include $(BUILD_SYSTEM)/android_manifest.mk
194
195$(LOCAL_INTERMEDIATE_TARGETS): \
196    PRIVATE_ANDROID_MANIFEST := $(full_android_manifest)
197ifneq (,$(filter-out current system_current, $(LOCAL_SDK_VERSION)))
198$(LOCAL_INTERMEDIATE_TARGETS): \
199    PRIVATE_DEFAULT_APP_TARGET_SDK := $(LOCAL_SDK_VERSION)
200else
201$(LOCAL_INTERMEDIATE_TARGETS): \
202    PRIVATE_DEFAULT_APP_TARGET_SDK := $(DEFAULT_APP_TARGET_SDK)
203endif
204
205ifeq ($(need_compile_res),true)
206
207# Since we don't know where the real R.java file is going to end up,
208# we need to use another file to stand in its place.  We'll just
209# copy the generated file to src/R.stamp, which means it will
210# have the same contents and timestamp as the actual file.
211#
212# At the same time, this will copy the R.java file to a central
213# 'R' directory to make it easier to add the files to an IDE.
214#
215#TODO: use PRIVATE_SOURCE_INTERMEDIATES_DIR instead of
216#      $(intermediates.COMMON)/src
217ifneq ($(package_expected_intermediates_COMMON),$(intermediates.COMMON))
218  $(error $(LOCAL_MODULE): internal error: expected intermediates.COMMON "$(package_expected_intermediates_COMMON)" != intermediates.COMMON "$(intermediates.COMMON)")
219endif
220
221$(R_file_stamp): PRIVATE_RESOURCE_PUBLICS_OUTPUT := \
222			$(intermediates.COMMON)/public_resources.xml
223$(R_file_stamp): PRIVATE_PROGUARD_OPTIONS_FILE := $(proguard_options_file)
224$(R_file_stamp): $(all_res_assets) $(full_android_manifest) $(RenderScript_file_stamp) $(AAPT) | $(ACP)
225	@echo "target R.java/Manifest.java: $(PRIVATE_MODULE) ($@)"
226	@rm -f $@
227	$(create-resource-java-files)
228	$(hide) for GENERATED_MANIFEST_FILE in `find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) \
229					-name Manifest.java 2> /dev/null`; do \
230		dir=`awk '/package/{gsub(/\./,"/",$$2);gsub(/;/,"",$$2);print $$2;exit}' $$GENERATED_MANIFEST_FILE`; \
231		mkdir -p $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
232		$(ACP) -fp $$GENERATED_MANIFEST_FILE $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
233	done;
234	$(hide) for GENERATED_R_FILE in `find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) \
235					-name R.java 2> /dev/null`; do \
236		dir=`awk '/package/{gsub(/\./,"/",$$2);gsub(/;/,"",$$2);print $$2;exit}' $$GENERATED_R_FILE`; \
237		mkdir -p $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
238		$(ACP) -fp $$GENERATED_R_FILE $(TARGET_COMMON_OUT_ROOT)/R/$$dir \
239			|| exit 31; \
240		$(ACP) -fp $$GENERATED_R_FILE $@ || exit 32; \
241	done; \
242
243$(proguard_options_file): $(R_file_stamp)
244
245resource_export_package :=
246ifdef LOCAL_EXPORT_PACKAGE_RESOURCES
247# Put this module's resources into a PRODUCT-agnositc package that
248# other packages can use to build their own PRODUCT-agnostic R.java (etc.)
249# files.
250resource_export_package := $(intermediates.COMMON)/package-export.apk
251$(R_file_stamp): $(resource_export_package)
252
253# add-assets-to-package looks at PRODUCT_AAPT_CONFIG, but this target
254# can't know anything about PRODUCT.  Clear it out just for this target.
255$(resource_export_package): PRIVATE_PRODUCT_AAPT_CONFIG :=
256$(resource_export_package): PRIVATE_PRODUCT_AAPT_PREF_CONFIG :=
257$(resource_export_package): $(all_res_assets) $(full_android_manifest) $(RenderScript_file_stamp) $(AAPT)
258	@echo "target Export Resources: $(PRIVATE_MODULE) ($@)"
259	$(create-empty-package)
260	$(add-assets-to-package)
261endif
262
263# Other modules should depend on the BUILT module if
264# they want to use this module's R.java file.
265$(LOCAL_BUILT_MODULE): $(R_file_stamp)
266
267ifneq ($(full_classes_jar),)
268# If full_classes_jar is non-empty, we're building sources.
269# If we're building sources, the initial javac step (which
270# produces full_classes_compiled_jar) needs to ensure the
271# R.java and Manifest.java files have been generated first.
272$(full_classes_compiled_jar): $(R_file_stamp)
273endif
274
275endif  # need_compile_res
276
277ifeq ($(LOCAL_NO_STANDARD_LIBRARIES),true)
278# We need to explicitly clear this var so that we don't
279# inherit the value from whomever caused us to be built.
280$(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_AAPT_INCLUDES :=
281else
282# Most packages should link against the resources defined by framework-res.
283# Even if they don't have their own resources, they may use framework
284# resources.
285ifneq ($(filter-out current system_current,$(LOCAL_SDK_RES_VERSION))$(if $(TARGET_BUILD_APPS),$(filter current system_current,$(LOCAL_SDK_RES_VERSION))),)
286# for released sdk versions, the platform resources were built into android.jar.
287framework_res_package_export := \
288    $(HISTORICAL_SDK_VERSIONS_ROOT)/$(LOCAL_SDK_RES_VERSION)/android.jar
289framework_res_package_export_deps := $(framework_res_package_export)
290else # LOCAL_SDK_RES_VERSION
291framework_res_package_export := \
292    $(call intermediates-dir-for,APPS,framework-res,,COMMON)/package-export.apk
293# We can't depend directly on the export.apk file; it won't get its
294# PRIVATE_ vars set up correctly if we do.  Instead, depend on the
295# corresponding R.stamp file, which lists the export.apk as a dependency.
296framework_res_package_export_deps := \
297    $(dir $(framework_res_package_export))src/R.stamp
298endif # LOCAL_SDK_RES_VERSION
299all_library_res_package_exports := \
300    $(framework_res_package_export) \
301    $(foreach lib,$(LOCAL_RES_LIBRARIES),\
302        $(call intermediates-dir-for,APPS,$(lib),,COMMON)/package-export.apk)
303
304all_library_res_package_export_deps := \
305    $(framework_res_package_export_deps) \
306    $(foreach lib,$(LOCAL_RES_LIBRARIES),\
307        $(call intermediates-dir-for,APPS,$(lib),,COMMON)/src/R.stamp)
308
309$(resource_export_package) $(R_file_stamp) $(LOCAL_BUILT_MODULE): $(all_library_res_package_export_deps)
310$(LOCAL_INTERMEDIATE_TARGETS): \
311    PRIVATE_AAPT_INCLUDES := $(all_library_res_package_exports)
312endif # LOCAL_NO_STANDARD_LIBRARIES
313
314ifneq ($(full_classes_jar),)
315$(LOCAL_BUILT_MODULE): PRIVATE_DEX_FILE := $(built_dex)
316$(LOCAL_BUILT_MODULE): $(built_dex)
317endif # full_classes_jar
318
319include $(BUILD_SYSTEM)/install_jni_libs.mk
320
321# Pick a key to sign the package with.  If this package hasn't specified
322# an explicit certificate, use the default.
323# Secure release builds will have their packages signed after the fact,
324# so it's ok for these private keys to be in the clear.
325ifeq ($(LOCAL_CERTIFICATE),)
326    LOCAL_CERTIFICATE := $(DEFAULT_SYSTEM_DEV_CERTIFICATE)
327endif
328
329ifeq ($(LOCAL_CERTIFICATE),EXTERNAL)
330  # The special value "EXTERNAL" means that we will sign it with the
331  # default devkey, apply predexopt, but then expect the final .apk
332  # (after dexopting) to be signed by an outside tool.
333  LOCAL_CERTIFICATE := $(DEFAULT_SYSTEM_DEV_CERTIFICATE)
334  PACKAGES.$(LOCAL_PACKAGE_NAME).EXTERNAL_KEY := 1
335endif
336
337# If this is not an absolute certificate, assign it to a generic one.
338ifeq ($(dir $(strip $(LOCAL_CERTIFICATE))),./)
339    LOCAL_CERTIFICATE := $(dir $(DEFAULT_SYSTEM_DEV_CERTIFICATE))$(LOCAL_CERTIFICATE)
340endif
341private_key := $(LOCAL_CERTIFICATE).pk8
342certificate := $(LOCAL_CERTIFICATE).x509.pem
343
344$(LOCAL_BUILT_MODULE): $(private_key) $(certificate) $(SIGNAPK_JAR)
345$(LOCAL_BUILT_MODULE): PRIVATE_PRIVATE_KEY := $(private_key)
346$(LOCAL_BUILT_MODULE): PRIVATE_CERTIFICATE := $(certificate)
347
348PACKAGES.$(LOCAL_PACKAGE_NAME).PRIVATE_KEY := $(private_key)
349PACKAGES.$(LOCAL_PACKAGE_NAME).CERTIFICATE := $(certificate)
350
351$(LOCAL_BUILT_MODULE): PRIVATE_ADDITIONAL_CERTIFICATES := $(foreach c,\
352    $(LOCAL_ADDITIONAL_CERTIFICATES), $(c).x509.pem $(c).pk8)
353
354# Define the rule to build the actual package.
355$(LOCAL_BUILT_MODULE): $(AAPT) | $(ZIPALIGN)
356# PRIVATE_JNI_SHARED_LIBRARIES is a list of <abi>:<path_of_built_lib>.
357$(LOCAL_BUILT_MODULE): PRIVATE_JNI_SHARED_LIBRARIES := $(jni_shared_libraries_with_abis)
358# PRIVATE_JNI_SHARED_LIBRARIES_ABI is a list of ABI names.
359$(LOCAL_BUILT_MODULE): PRIVATE_JNI_SHARED_LIBRARIES_ABI := $(jni_shared_libraries_abis)
360ifneq ($(TARGET_BUILD_APPS),)
361    # Include all resources for unbundled apps.
362    LOCAL_AAPT_INCLUDE_ALL_RESOURCES := true
363endif
364ifeq ($(LOCAL_AAPT_INCLUDE_ALL_RESOURCES),true)
365    $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_CONFIG :=
366    $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_PREF_CONFIG :=
367else
368    $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_CONFIG := $(PRODUCT_AAPT_CONFIG)
369    $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_PREF_CONFIG := $(PRODUCT_AAPT_PREF_CONFIG)
370endif
371$(LOCAL_BUILT_MODULE): $(all_res_assets) $(jni_shared_libraries) $(full_android_manifest)
372	@echo "target Package: $(PRIVATE_MODULE) ($@)"
373	$(create-empty-package)
374	$(add-assets-to-package)
375ifneq ($(jni_shared_libraries),)
376	$(add-jni-shared-libs-to-package)
377endif
378ifneq ($(full_classes_jar),)
379	$(add-dex-to-package)
380endif
381	$(add-carried-java-resources)
382ifneq ($(extra_jar_args),)
383	$(add-java-resources-to-package)
384endif
385	$(sign-package)
386ifdef LOCAL_DEX_PREOPT
387ifneq (nostripping,$(LOCAL_DEX_PREOPT))
388	$(call dexpreopt-remove-classes.dex,$@)
389endif
390endif
391	@# Alignment must happen after all other zip operations.
392	$(align-package)
393
394###############################
395## Rule to build the odex file
396ifdef LOCAL_DEX_PREOPT
397$(built_odex): PRIVATE_DEX_FILE := $(built_dex)
398$(built_odex) : $(built_dex)
399	$(hide) mkdir -p $(dir $@) && rm -f $@
400	$(add-dex-to-package)
401	$(hide) mv $@ $@.input
402	$(call dexpreopt-one-file,$@.input,$@)
403	$(hide) rm $@.input
404endif
405
406# Save information about this package
407PACKAGES.$(LOCAL_PACKAGE_NAME).OVERRIDES := $(strip $(LOCAL_OVERRIDES_PACKAGES))
408PACKAGES.$(LOCAL_PACKAGE_NAME).RESOURCE_FILES := $(all_resources)
409ifdef package_resource_overlays
410PACKAGES.$(LOCAL_PACKAGE_NAME).RESOURCE_OVERLAYS := $(package_resource_overlays)
411endif
412
413PACKAGES := $(PACKAGES) $(LOCAL_PACKAGE_NAME)
414
415# Dist the files that can be bundled in system.img.
416# They include the jni shared libraries and the apk with jni libraries stripped.
417ifeq ($(LOCAL_DIST_BUNDLED_BINARIES),true)
418ifneq ($(filter $(LOCAL_PACKAGE_NAME),$(TARGET_BUILD_APPS)),)
419ifneq ($(strip $(jni_shared_libraries)),)
420dist_subdir := bundled_$(LOCAL_PACKAGE_NAME)
421$(foreach f, $(jni_shared_libraries), \
422  $(call dist-for-goals, apps_only, $(f):$(dist_subdir)/$(notdir $(f))))
423
424apk_jni_stripped := $(intermediates)/jni_stripped/package.apk
425$(apk_jni_stripped): PRIVATE_JNI_SHARED_LIBRARIES := $(notdir $(jni_shared_libraries))
426$(apk_jni_stripped) : $(LOCAL_BUILT_MODULE) | $(ZIPALIGN)
427	@rm -rf $(dir $@) && mkdir -p $(dir $@)
428	$(hide) cp $< $@
429	$(hide) zip -d $@ $(foreach f,$(PRIVATE_JNI_SHARED_LIBRARIES),\*/$(f))
430	$(call align-package)
431
432$(call dist-for-goals, apps_only, $(apk_jni_stripped):$(dist_subdir)/$(LOCAL_PACKAGE_NAME).apk)
433
434endif  # jni_shared_libraries
435endif  # apps_only build
436endif  # LOCAL_DIST_BUNDLED_BINARIES
437
438# Lint phony targets
439.PHONY: lint-$(LOCAL_PACKAGE_NAME)
440lint-$(LOCAL_PACKAGE_NAME): PRIVATE_PATH := $(LOCAL_PATH)
441lint-$(LOCAL_PACKAGE_NAME): PRIVATE_LINT_FLAGS := $(LOCAL_LINT_FLAGS)
442lint-$(LOCAL_PACKAGE_NAME) :
443	@echo lint $(PRIVATE_PATH)
444	$(LINT) $(PRIVATE_LINT_FLAGS) $(PRIVATE_PATH)
445
446lintall : lint-$(LOCAL_PACKAGE_NAME)
447
448endif # skip_definition
449
450# Reset internal variables.
451all_res_assets :=
452