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