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