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