package.mk revision 0ec188f1c197709cf61d0de647b5220539b97322 
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
29# If this makefile is being read from within an inheritance,
30# use the new values.
31skip_definition:=
32ifdef LOCAL_PACKAGE_OVERRIDES
33  package_overridden := $(call set-inherited-package-variables)
34  ifeq ($(strip $(package_overridden)),)
35    skip_definition := true
36  endif
37endif
38
39ifndef skip_definition
40
41LOCAL_PACKAGE_NAME := $(strip $(LOCAL_PACKAGE_NAME))
42ifeq ($(LOCAL_PACKAGE_NAME),)
43$(error $(LOCAL_PATH): Package modules must define LOCAL_PACKAGE_NAME)
44endif
45
46ifneq ($(strip $(LOCAL_MODULE_SUFFIX)),)
47$(error $(LOCAL_PATH): Package modules may not define LOCAL_MODULE_SUFFIX)
48endif
49LOCAL_MODULE_SUFFIX := $(COMMON_ANDROID_PACKAGE_SUFFIX)
50
51ifneq ($(strip $(LOCAL_MODULE)),)
52$(error $(LOCAL_PATH): Package modules may not define LOCAL_MODULE)
53endif
54LOCAL_MODULE := $(LOCAL_PACKAGE_NAME)
55
56# Android packages should use Android resources or assets.
57ifneq (,$(LOCAL_JAVA_RESOURCE_DIRS))
58$(error $(LOCAL_PATH): Package modules may not set LOCAL_JAVA_RESOURCE_DIRS)
59endif
60ifneq (,$(LOCAL_JAVA_RESOURCE_FILES))
61$(error $(LOCAL_PATH): Package modules may not set LOCAL_JAVA_RESOURCE_FILES)
62endif
63
64ifeq ($(strip $(LOCAL_MANIFEST_FILE)),)
65LOCAL_MANIFEST_FILE := AndroidManifest.xml
66endif
67
68# If you need to put the MANIFEST_FILE outside of LOCAL_PATH
69# you can use FULL_MANIFEST_FILE
70ifeq ($(strip $(LOCAL_FULL_MANIFEST_FILE)),)
71LOCAL_FULL_MANIFEST_FILE := $(LOCAL_PATH)/$(LOCAL_MANIFEST_FILE)
72endif
73
74ifneq ($(strip $(LOCAL_MODULE_CLASS)),)
75$(error $(LOCAL_PATH): Package modules may not set LOCAL_MODULE_CLASS)
76endif
77LOCAL_MODULE_CLASS := APPS
78
79# Package LOCAL_MODULE_TAGS default to optional
80LOCAL_MODULE_TAGS := $(strip $(LOCAL_MODULE_TAGS))
81ifeq ($(LOCAL_MODULE_TAGS),)
82LOCAL_MODULE_TAGS := optional
83endif
84
85ifeq ($(filter tests, $(LOCAL_MODULE_TAGS)),)
86# Force localization check if it's not tagged as tests.
87LOCAL_AAPT_FLAGS := $(LOCAL_AAPT_FLAGS) -z
88endif
89
90ifeq (,$(LOCAL_ASSET_DIR))
91LOCAL_ASSET_DIR := $(LOCAL_PATH)/assets
92endif
93
94ifeq (,$(LOCAL_RESOURCE_DIR))
95  LOCAL_RESOURCE_DIR := $(LOCAL_PATH)/res
96endif
97LOCAL_RESOURCE_DIR := \
98  $(wildcard $(foreach dir, $(PRODUCT_PACKAGE_OVERLAYS), \
99    $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))) \
100  $(wildcard $(foreach dir, $(DEVICE_PACKAGE_OVERLAYS), \
101    $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))) \
102  $(LOCAL_RESOURCE_DIR)
103
104all_assets := $(call find-subdir-assets,$(LOCAL_ASSET_DIR))
105all_assets := $(addprefix $(LOCAL_ASSET_DIR)/,$(patsubst assets/%,%,$(all_assets)))
106
107all_resources := $(strip \
108    $(foreach dir, $(LOCAL_RESOURCE_DIR), \
109      $(addprefix $(dir)/, \
110        $(patsubst res/%,%, \
111          $(call find-subdir-assets,$(dir)) \
112         ) \
113       ) \
114     ))
115
116all_res_assets := $(strip $(all_assets) $(all_resources))
117
118package_expected_intermediates_COMMON := $(call local-intermediates-dir,COMMON)
119# If no assets or resources were found, clear the directory variables so
120# we don't try to build them.
121ifeq (,$(all_assets))
122LOCAL_ASSET_DIR:=
123endif
124ifeq (,$(all_resources))
125LOCAL_RESOURCE_DIR:=
126R_file_stamp :=
127else
128# Make sure that R_file_stamp inherits the proper PRIVATE vars.
129# If R.stamp moves, be sure to update the framework makefile,
130# which has intimate knowledge of its location.
131R_file_stamp := $(package_expected_intermediates_COMMON)/src/R.stamp
132LOCAL_INTERMEDIATE_TARGETS += $(R_file_stamp)
133endif
134
135LOCAL_BUILT_MODULE_STEM := package.apk
136
137LOCAL_PROGUARD_ENABLED:=$(strip $(LOCAL_PROGUARD_ENABLED))
138ifndef LOCAL_PROGUARD_ENABLED
139ifneq ($(filter user userdebug, $(TARGET_BUILD_VARIANT)),)
140    # turn on Proguard by default for user & userdebug build
141    LOCAL_PROGUARD_ENABLED :=full
142endif
143endif
144ifeq ($(LOCAL_PROGUARD_ENABLED),disabled)
145    # the package explicitly request to disable proguard.
146    LOCAL_PROGUARD_ENABLED :=
147endif
148proguard_options_file :=
149ifneq ($(LOCAL_PROGUARD_ENABLED),custom)
150ifneq ($(all_resources),)
151    proguard_options_file := $(package_expected_intermediates_COMMON)/proguard_options
152endif # all_resources
153endif # !custom
154LOCAL_PROGUARD_FLAGS := $(addprefix -include ,$(proguard_options_file)) $(LOCAL_PROGUARD_FLAGS)
155
156ifneq (true,$(WITH_DEXPREOPT))
157LOCAL_DEX_PREOPT :=
158else
159ifeq (,$(TARGET_BUILD_APPS))
160ifneq (,$(LOCAL_SRC_FILES))
161ifndef LOCAL_DEX_PREOPT
162LOCAL_DEX_PREOPT := true
163endif
164endif
165endif
166endif
167ifeq (false,$(LOCAL_DEX_PREOPT))
168LOCAL_DEX_PREOPT :=
169endif
170
171#################################
172include $(BUILD_SYSTEM)/java.mk
173#################################
174
175LOCAL_SDK_RES_VERSION:=$(strip $(LOCAL_SDK_RES_VERSION))
176ifeq ($(LOCAL_SDK_RES_VERSION),)
177  LOCAL_SDK_RES_VERSION:=$(LOCAL_SDK_VERSION)
178endif
179
180full_android_manifest := $(LOCAL_FULL_MANIFEST_FILE)
181$(LOCAL_INTERMEDIATE_TARGETS): \
182    PRIVATE_ANDROID_MANIFEST := $(full_android_manifest)
183ifneq (,$(filter-out current, $(LOCAL_SDK_VERSION)))
184$(LOCAL_INTERMEDIATE_TARGETS): \
185    PRIVATE_DEFAULT_APP_TARGET_SDK := $(LOCAL_SDK_VERSION)
186else
187$(LOCAL_INTERMEDIATE_TARGETS): \
188    PRIVATE_DEFAULT_APP_TARGET_SDK := $(DEFAULT_APP_TARGET_SDK)
189endif
190
191ifneq ($(all_resources),)
192
193# Since we don't know where the real R.java file is going to end up,
194# we need to use another file to stand in its place.  We'll just
195# copy the generated file to src/R.stamp, which means it will
196# have the same contents and timestamp as the actual file.
197#
198# At the same time, this will copy the R.java file to a central
199# 'R' directory to make it easier to add the files to an IDE.
200#
201#TODO: use PRIVATE_SOURCE_INTERMEDIATES_DIR instead of
202#      $(intermediates.COMMON)/src
203ifneq ($(package_expected_intermediates_COMMON),$(intermediates.COMMON))
204  $(error $(LOCAL_MODULE): internal error: expected intermediates.COMMON "$(package_expected_intermediates_COMMON)" != intermediates.COMMON "$(intermediates.COMMON)")
205endif
206
207$(R_file_stamp): PRIVATE_RESOURCE_PUBLICS_OUTPUT := \
208			$(intermediates.COMMON)/public_resources.xml
209$(R_file_stamp): PRIVATE_PROGUARD_OPTIONS_FILE := $(proguard_options_file)
210$(R_file_stamp): $(all_res_assets) $(full_android_manifest) $(RenderScript_file_stamp) $(AAPT) | $(ACP)
211	@echo "target R.java/Manifest.java: $(PRIVATE_MODULE) ($@)"
212	@rm -f $@
213	$(create-resource-java-files)
214	$(hide) for GENERATED_MANIFEST_FILE in `find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) \
215					-name Manifest.java 2> /dev/null`; do \
216		dir=`awk '/package/{gsub(/\./,"/",$$2);gsub(/;/,"",$$2);print $$2;exit}' $$GENERATED_MANIFEST_FILE`; \
217		mkdir -p $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
218		$(ACP) -fp $$GENERATED_MANIFEST_FILE $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
219	done;
220	$(hide) for GENERATED_R_FILE in `find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) \
221					-name R.java 2> /dev/null`; do \
222		dir=`awk '/package/{gsub(/\./,"/",$$2);gsub(/;/,"",$$2);print $$2;exit}' $$GENERATED_R_FILE`; \
223		mkdir -p $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
224		$(ACP) -fp $$GENERATED_R_FILE $(TARGET_COMMON_OUT_ROOT)/R/$$dir \
225			|| exit 31; \
226		$(ACP) -fp $$GENERATED_R_FILE $@ || exit 32; \
227	done; \
228
229$(proguard_options_file): $(R_file_stamp)
230
231ifdef LOCAL_EXPORT_PACKAGE_RESOURCES
232# Put this module's resources into a PRODUCT-agnositc package that
233# other packages can use to build their own PRODUCT-agnostic R.java (etc.)
234# files.
235resource_export_package := $(intermediates.COMMON)/package-export.apk
236$(R_file_stamp): $(resource_export_package)
237
238# add-assets-to-package looks at PRODUCT_AAPT_CONFIG, but this target
239# can't know anything about PRODUCT.  Clear it out just for this target.
240$(resource_export_package): PRIVATE_PRODUCT_AAPT_CONFIG :=
241$(resource_export_package): PRIVATE_PRODUCT_AAPT_PREF_CONFIG :=
242$(resource_export_package): $(all_res_assets) $(full_android_manifest) $(RenderScript_file_stamp) $(AAPT)
243	@echo "target Export Resources: $(PRIVATE_MODULE) ($@)"
244	$(create-empty-package)
245	$(add-assets-to-package)
246endif
247
248# Other modules should depend on the BUILT module if
249# they want to use this module's R.java file.
250$(LOCAL_BUILT_MODULE): $(R_file_stamp)
251
252ifneq ($(full_classes_jar),)
253# If full_classes_jar is non-empty, we're building sources.
254# If we're building sources, the initial javac step (which
255# produces full_classes_compiled_jar) needs to ensure the
256# R.java and Manifest.java files have been generated first.
257$(full_classes_compiled_jar): $(R_file_stamp)
258endif
259
260endif  # all_resources
261
262ifeq ($(LOCAL_NO_STANDARD_LIBRARIES),true)
263# We need to explicitly clear this var so that we don't
264# inherit the value from whomever caused us to be built.
265$(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_AAPT_INCLUDES :=
266else
267# Most packages should link against the resources defined by framework-res.
268# Even if they don't have their own resources, they may use framework
269# resources.
270ifneq ($(filter-out current,$(LOCAL_SDK_RES_VERSION))$(if $(TARGET_BUILD_APPS),$(filter current,$(LOCAL_SDK_RES_VERSION))),)
271# for released sdk versions, the platform resources were built into android.jar.
272framework_res_package_export := \
273    $(HISTORICAL_SDK_VERSIONS_ROOT)/$(LOCAL_SDK_RES_VERSION)/android.jar
274framework_res_package_export_deps := $(framework_res_package_export)
275else # LOCAL_SDK_RES_VERSION
276framework_res_package_export := \
277    $(call intermediates-dir-for,APPS,framework-res,,COMMON)/package-export.apk
278# We can't depend directly on the export.apk file; it won't get its
279# PRIVATE_ vars set up correctly if we do.  Instead, depend on the
280# corresponding R.stamp file, which lists the export.apk as a dependency.
281framework_res_package_export_deps := \
282    $(dir $(framework_res_package_export))src/R.stamp
283endif # LOCAL_SDK_RES_VERSION
284$(R_file_stamp): $(framework_res_package_export_deps)
285$(LOCAL_INTERMEDIATE_TARGETS): \
286    PRIVATE_AAPT_INCLUDES := $(framework_res_package_export)
287endif # LOCAL_NO_STANDARD_LIBRARIES
288
289ifneq ($(full_classes_jar),)
290$(LOCAL_BUILT_MODULE): PRIVATE_DEX_FILE := $(built_dex)
291$(LOCAL_BUILT_MODULE): $(built_dex)
292endif # full_classes_jar
293
294
295# Get the list of jni libraries to be included in the apk file.
296
297so_suffix := $($(my_prefix)SHLIB_SUFFIX)
298
299jni_shared_libraries := \
300    $(addprefix $($(my_prefix)OUT_INTERMEDIATE_LIBRARIES)/, \
301      $(addsuffix $(so_suffix), \
302        $(LOCAL_JNI_SHARED_LIBRARIES)))
303
304# App explicitly requires the prebuilt NDK libstlport_shared.so.
305# libstlport_shared.so should never go to the system image.
306# Instead it should be packaged into the apk.
307ifeq (stlport_shared,$(LOCAL_NDK_STL_VARIANT))
308ifndef LOCAL_NDK_VERSION
309$(error LOCAL_NDK_VERSION has to be defined together with LOCAL_NDK_STL_VARIANT, \
310    LOCAL_PACKAGE_NAME=$(LOCAL_PACKAGE_NAME))
311endif
312jni_shared_libraries += \
313    $(HISTORICAL_NDK_VERSIONS_ROOT)/android-ndk-r$(LOCAL_NDK_VERSION)/sources/cxx-stl/stlport/libs/$(TARGET_CPU_ABI)/libstlport_shared.so
314endif
315
316# Set the abi directory used by the local JNI shared libraries.
317# (Doesn't change how the local shared libraries are compiled, just
318# sets where they are stored in the apk.)
319
320ifeq ($(LOCAL_JNI_SHARED_LIBRARIES_ABI),)
321    jni_shared_libraries_abi := $(TARGET_CPU_ABI)
322else
323    jni_shared_libraries_abi := $(LOCAL_JNI_SHARED_LIBRARIES_ABI)
324endif
325
326# Pick a key to sign the package with.  If this package hasn't specified
327# an explicit certificate, use the default.
328# Secure release builds will have their packages signed after the fact,
329# so it's ok for these private keys to be in the clear.
330ifeq ($(LOCAL_CERTIFICATE),)
331    LOCAL_CERTIFICATE := $(DEFAULT_SYSTEM_DEV_CERTIFICATE)
332endif
333
334ifeq ($(LOCAL_CERTIFICATE),EXTERNAL)
335  # The special value "EXTERNAL" means that we will sign it with the
336  # default devkey, apply predexopt, but then expect the final .apk
337  # (after dexopting) to be signed by an outside tool.
338  LOCAL_CERTIFICATE := $(DEFAULT_SYSTEM_DEV_CERTIFICATE)
339  PACKAGES.$(LOCAL_PACKAGE_NAME).EXTERNAL_KEY := 1
340endif
341
342# If this is not an absolute certificate, assign it to a generic one.
343ifeq ($(dir $(strip $(LOCAL_CERTIFICATE))),./)
344    LOCAL_CERTIFICATE := $(dir $(DEFAULT_SYSTEM_DEV_CERTIFICATE))$(LOCAL_CERTIFICATE)
345endif
346private_key := $(LOCAL_CERTIFICATE).pk8
347certificate := $(LOCAL_CERTIFICATE).x509.pem
348
349$(LOCAL_BUILT_MODULE): $(private_key) $(certificate) $(SIGNAPK_JAR)
350$(LOCAL_BUILT_MODULE): PRIVATE_PRIVATE_KEY := $(private_key)
351$(LOCAL_BUILT_MODULE): PRIVATE_CERTIFICATE := $(certificate)
352
353PACKAGES.$(LOCAL_PACKAGE_NAME).PRIVATE_KEY := $(private_key)
354PACKAGES.$(LOCAL_PACKAGE_NAME).CERTIFICATE := $(certificate)
355
356# Define the rule to build the actual package.
357$(LOCAL_BUILT_MODULE): $(AAPT) | $(ZIPALIGN)
358ifdef LOCAL_DEX_PREOPT
359# Make sure the boot jars get dexpreopt-ed first
360$(LOCAL_BUILT_MODULE): $(DEXPREOPT_BOOT_ODEXS) | $(DEXPREOPT) $(DEXOPT)
361endif
362$(LOCAL_BUILT_MODULE): PRIVATE_JNI_SHARED_LIBRARIES := $(jni_shared_libraries)
363$(LOCAL_BUILT_MODULE): PRIVATE_JNI_SHARED_LIBRARIES_ABI := $(jni_shared_libraries_abi)
364ifneq ($(TARGET_BUILD_APPS),)
365    # Include all resources for unbundled apps.
366    LOCAL_AAPT_INCLUDE_ALL_RESOURCES := true
367endif
368ifeq ($(LOCAL_AAPT_INCLUDE_ALL_RESOURCES),true)
369    $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_CONFIG :=
370    $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_PREF_CONFIG :=
371else
372    $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_CONFIG := $(PRODUCT_AAPT_CONFIG)
373    $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_PREF_CONFIG := $(PRODUCT_AAPT_PREF_CONFIG)
374endif
375$(LOCAL_BUILT_MODULE): $(all_res_assets) $(jni_shared_libraries) $(full_android_manifest)
376	@echo "target Package: $(PRIVATE_MODULE) ($@)"
377	$(create-empty-package)
378	$(add-assets-to-package)
379ifneq ($(jni_shared_libraries),)
380	$(add-jni-shared-libs-to-package)
381endif
382ifneq ($(full_classes_jar),)
383	$(add-dex-to-package)
384endif
385	$(sign-package)
386	@# Alignment must happen after all other zip operations.
387	$(align-package)
388ifdef LOCAL_DEX_PREOPT
389	$(hide) rm -f $(patsubst %.apk,%.odex,$@)
390	$(call dexpreopt-one-file,$@,$(patsubst %.apk,%.odex,$@))
391ifneq (nostripping,$(LOCAL_DEX_PREOPT))
392	$(call dexpreopt-remove-classes.dex,$@)
393endif
394
395built_odex := $(basename $(LOCAL_BUILT_MODULE)).odex
396$(built_odex): $(LOCAL_BUILT_MODULE)
397endif
398
399# Save information about this package
400PACKAGES.$(LOCAL_PACKAGE_NAME).OVERRIDES := $(strip $(LOCAL_OVERRIDES_PACKAGES))
401PACKAGES.$(LOCAL_PACKAGE_NAME).RESOURCE_FILES := $(all_resources)
402
403PACKAGES := $(PACKAGES) $(LOCAL_PACKAGE_NAME)
404
405endif # skip_definition
406