package_internal.mk revision bfcdf060bab129581acff32eb70896f719162bc9 
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
81need_compile_asset :=
82ifeq (,$(LOCAL_ASSET_DIR))
83LOCAL_ASSET_DIR := $(LOCAL_PATH)/assets
84else
85need_compile_asset := true
86endif
87
88# LOCAL_RESOURCE_DIR may point to resource generated during the build
89need_compile_res :=
90ifeq (,$(LOCAL_RESOURCE_DIR))
91  LOCAL_RESOURCE_DIR := $(LOCAL_PATH)/res
92else
93  need_compile_res := true
94endif
95
96package_resource_overlays := $(strip \
97    $(wildcard $(foreach dir, $(PRODUCT_PACKAGE_OVERLAYS), \
98      $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))) \
99    $(wildcard $(foreach dir, $(DEVICE_PACKAGE_OVERLAYS), \
100      $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))))
101
102LOCAL_RESOURCE_DIR := $(package_resource_overlays) $(LOCAL_RESOURCE_DIR)
103
104all_assets := $(call find-subdir-assets,$(LOCAL_ASSET_DIR))
105all_assets := $(addprefix $(LOCAL_ASSET_DIR)/,$(patsubst assets/%,%,$(all_assets)))
106
107ifneq ($(all_assets),)
108need_compile_asset := true
109endif
110
111all_resources := $(strip \
112    $(foreach dir, $(LOCAL_RESOURCE_DIR), \
113      $(addprefix $(dir)/, \
114        $(patsubst res/%,%, \
115          $(call find-subdir-assets,$(dir)) \
116         ) \
117       ) \
118     ))
119
120ifneq ($(all_resources),)
121  need_compile_res := true
122endif
123
124all_res_assets := $(strip $(all_assets) $(all_resources))
125
126package_expected_intermediates_COMMON := $(call local-intermediates-dir,COMMON)
127# If no assets or resources were found, clear the directory variables so
128# we don't try to build them.
129ifneq (true,$(need_compile_asset))
130LOCAL_ASSET_DIR:=
131endif
132ifneq (true,$(need_compile_res))
133LOCAL_RESOURCE_DIR:=
134R_file_stamp :=
135else
136# Make sure that R_file_stamp inherits the proper PRIVATE vars.
137# If R.stamp moves, be sure to update the framework makefile,
138# which has intimate knowledge of its location.
139R_file_stamp := $(package_expected_intermediates_COMMON)/src/R.stamp
140LOCAL_INTERMEDIATE_TARGETS += $(R_file_stamp)
141endif
142
143LOCAL_BUILT_MODULE_STEM := package.apk
144
145LOCAL_PROGUARD_ENABLED:=$(strip $(LOCAL_PROGUARD_ENABLED))
146ifndef LOCAL_PROGUARD_ENABLED
147ifneq ($(DISABLE_PROGUARD),true)
148    LOCAL_PROGUARD_ENABLED :=full
149endif
150endif
151ifeq ($(LOCAL_PROGUARD_ENABLED),disabled)
152    # the package explicitly request to disable proguard.
153    LOCAL_PROGUARD_ENABLED :=
154endif
155proguard_options_file :=
156ifneq ($(LOCAL_PROGUARD_ENABLED),custom)
157ifeq ($(need_compile_res),true)
158    proguard_options_file := $(package_expected_intermediates_COMMON)/proguard_options
159endif # need_compile_res
160endif # !custom
161LOCAL_PROGUARD_FLAGS := $(addprefix -include ,$(proguard_options_file)) $(LOCAL_PROGUARD_FLAGS)
162
163ifeq (true,$(EMMA_INSTRUMENT))
164ifndef LOCAL_EMMA_INSTRUMENT
165# No emma for test apks.
166ifeq (,$(filer tests,$(LOCAL_MODULE_TAGS))$(LOCAL_INSTRUMENTATION_FOR))
167LOCAL_EMMA_INSTRUMENT := true
168endif # No test apk
169endif # LOCAL_EMMA_INSTRUMENT is not set
170else
171LOCAL_EMMA_INSTRUMENT := false
172endif # EMMA_INSTRUMENT is true
173
174ifeq (true,$(LOCAL_EMMA_INSTRUMENT))
175ifeq (true,$(EMMA_INSTRUMENT_STATIC))
176LOCAL_STATIC_JAVA_LIBRARIES += emma
177else
178ifdef LOCAL_SDK_VERSION
179ifdef TARGET_BUILD_APPS
180# In unbundled build merge the emma library into the apk.
181LOCAL_STATIC_JAVA_LIBRARIES += emma
182else
183# If build against the SDK in full build, core.jar is not used,
184# we have to use prebiult emma.jar to make Proguard happy;
185# Otherwise emma classes are included in core.jar.
186LOCAL_PROGUARD_FLAGS += -libraryjars $(EMMA_JAR)
187endif # full build
188endif # LOCAL_SDK_VERSION
189endif # EMMA_INSTRUMENT_STATIC
190endif # LOCAL_EMMA_INSTRUMENT
191
192rs_compatibility_jni_libs :=
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
214ifeq ($(need_compile_res),true)
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  # need_compile_res
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
317include $(BUILD_SYSTEM)/install_jni_libs.mk
318
319# Pick a key to sign the package with.  If this package hasn't specified
320# an explicit certificate, use the default.
321# Secure release builds will have their packages signed after the fact,
322# so it's ok for these private keys to be in the clear.
323ifeq ($(LOCAL_CERTIFICATE),)
324    LOCAL_CERTIFICATE := $(DEFAULT_SYSTEM_DEV_CERTIFICATE)
325endif
326
327ifeq ($(LOCAL_CERTIFICATE),EXTERNAL)
328  # The special value "EXTERNAL" means that we will sign it with the
329  # default devkey, apply predexopt, but then expect the final .apk
330  # (after dexopting) to be signed by an outside tool.
331  LOCAL_CERTIFICATE := $(DEFAULT_SYSTEM_DEV_CERTIFICATE)
332  PACKAGES.$(LOCAL_PACKAGE_NAME).EXTERNAL_KEY := 1
333endif
334
335# If this is not an absolute certificate, assign it to a generic one.
336ifeq ($(dir $(strip $(LOCAL_CERTIFICATE))),./)
337    LOCAL_CERTIFICATE := $(dir $(DEFAULT_SYSTEM_DEV_CERTIFICATE))$(LOCAL_CERTIFICATE)
338endif
339private_key := $(LOCAL_CERTIFICATE).pk8
340certificate := $(LOCAL_CERTIFICATE).x509.pem
341
342$(LOCAL_BUILT_MODULE): $(private_key) $(certificate) $(SIGNAPK_JAR)
343$(LOCAL_BUILT_MODULE): PRIVATE_PRIVATE_KEY := $(private_key)
344$(LOCAL_BUILT_MODULE): PRIVATE_CERTIFICATE := $(certificate)
345
346PACKAGES.$(LOCAL_PACKAGE_NAME).PRIVATE_KEY := $(private_key)
347PACKAGES.$(LOCAL_PACKAGE_NAME).CERTIFICATE := $(certificate)
348
349$(LOCAL_BUILT_MODULE): PRIVATE_ADDITIONAL_CERTIFICATES := $(foreach c,\
350    $(LOCAL_ADDITIONAL_CERTIFICATES), $(c).x509.pem $(c).pk8)
351
352# Define the rule to build the actual package.
353$(LOCAL_BUILT_MODULE): $(AAPT) | $(ZIPALIGN)
354# PRIVATE_JNI_SHARED_LIBRARIES is a list of <abi>:<path_of_built_lib>.
355$(LOCAL_BUILT_MODULE): PRIVATE_JNI_SHARED_LIBRARIES := $(jni_shared_libraries_with_abis)
356# PRIVATE_JNI_SHARED_LIBRARIES_ABI is a list of ABI names.
357$(LOCAL_BUILT_MODULE): PRIVATE_JNI_SHARED_LIBRARIES_ABI := $(jni_shared_libraries_abis)
358ifneq ($(TARGET_BUILD_APPS),)
359    # Include all resources for unbundled apps.
360    LOCAL_AAPT_INCLUDE_ALL_RESOURCES := true
361endif
362ifeq ($(LOCAL_AAPT_INCLUDE_ALL_RESOURCES),true)
363    $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_CONFIG :=
364    $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_PREF_CONFIG :=
365else
366    $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_CONFIG := $(PRODUCT_AAPT_CONFIG)
367    $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_PREF_CONFIG := $(PRODUCT_AAPT_PREF_CONFIG)
368endif
369$(LOCAL_BUILT_MODULE): $(all_res_assets) $(jni_shared_libraries) $(full_android_manifest)
370	@echo "target Package: $(PRIVATE_MODULE) ($@)"
371	$(create-empty-package)
372	$(add-assets-to-package)
373ifneq ($(jni_shared_libraries),)
374	$(add-jni-shared-libs-to-package)
375endif
376ifneq ($(full_classes_jar),)
377	$(add-dex-to-package)
378endif
379	$(add-carried-java-resources)
380ifneq ($(extra_jar_args),)
381	$(add-java-resources-to-package)
382endif
383	$(sign-package)
384ifdef LOCAL_DEX_PREOPT
385ifneq (nostripping,$(LOCAL_DEX_PREOPT))
386	$(call dexpreopt-remove-classes.dex,$@)
387endif
388endif
389	@# Alignment must happen after all other zip operations.
390	$(align-package)
391
392###############################
393## Rule to build the odex file
394ifdef LOCAL_DEX_PREOPT
395$(built_odex): PRIVATE_DEX_FILE := $(built_dex)
396$(built_odex) : $(built_dex)
397	$(hide) mkdir -p $(dir $@) && rm -f $@
398	$(add-dex-to-package)
399	$(hide) mv $@ $@.input
400	$(call dexpreopt-one-file,$@.input,$@)
401	$(hide) rm $@.input
402endif
403
404# Save information about this package
405PACKAGES.$(LOCAL_PACKAGE_NAME).OVERRIDES := $(strip $(LOCAL_OVERRIDES_PACKAGES))
406PACKAGES.$(LOCAL_PACKAGE_NAME).RESOURCE_FILES := $(all_resources)
407ifdef package_resource_overlays
408PACKAGES.$(LOCAL_PACKAGE_NAME).RESOURCE_OVERLAYS := $(package_resource_overlays)
409endif
410
411PACKAGES := $(PACKAGES) $(LOCAL_PACKAGE_NAME)
412
413# Dist the files that can be bundled in system.img.
414# They include the jni shared libraries and the apk with jni libraries stripped.
415ifeq ($(LOCAL_DIST_BUNDLED_BINARIES),true)
416ifneq ($(filter $(LOCAL_PACKAGE_NAME),$(TARGET_BUILD_APPS)),)
417ifneq ($(strip $(jni_shared_libraries)),)
418dist_subdir := bundled_$(LOCAL_PACKAGE_NAME)
419$(foreach f, $(jni_shared_libraries), \
420  $(call dist-for-goals, apps_only, $(f):$(dist_subdir)/$(notdir $(f))))
421
422apk_jni_stripped := $(intermediates)/jni_stripped/package.apk
423$(apk_jni_stripped): PRIVATE_JNI_SHARED_LIBRARIES := $(notdir $(jni_shared_libraries))
424$(apk_jni_stripped) : $(LOCAL_BUILT_MODULE) | $(ZIPALIGN)
425	@rm -rf $(dir $@) && mkdir -p $(dir $@)
426	$(hide) cp $< $@
427	$(hide) zip -d $@ $(foreach f,$(PRIVATE_JNI_SHARED_LIBRARIES),\*/$(f))
428	$(call align-package)
429
430$(call dist-for-goals, apps_only, $(apk_jni_stripped):$(dist_subdir)/$(LOCAL_PACKAGE_NAME).apk)
431
432endif  # jni_shared_libraries
433endif  # apps_only build
434endif  # LOCAL_DIST_BUNDLED_BINARIES
435
436# Lint phony targets
437.PHONY: lint-$(LOCAL_PACKAGE_NAME)
438lint-$(LOCAL_PACKAGE_NAME): PRIVATE_PATH := $(LOCAL_PATH)
439lint-$(LOCAL_PACKAGE_NAME): PRIVATE_LINT_FLAGS := $(LOCAL_LINT_FLAGS)
440lint-$(LOCAL_PACKAGE_NAME) :
441	@echo lint $(PRIVATE_PATH)
442	$(LINT) $(PRIVATE_LINT_FLAGS) $(PRIVATE_PATH)
443
444lintall : lint-$(LOCAL_PACKAGE_NAME)
445
446endif # skip_definition
447
448# Reset internal variables.
449all_res_assets :=
450