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