2 # Copyright (C) 2008 The Android Open Source Project
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
8 # http://www.apache.org/licenses/LICENSE-2.0
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.
17 ###########################################################
18 ## Standard rules for building an application package.
20 ## Additional inputs from base_rules.make:
21 ## LOCAL_PACKAGE_NAME: The name of the package; the directory
22 ## will be called this.
24 ## MODULE, MODULE_PATH, and MODULE_SUFFIX will
26 ###########################################################
28 ifeq ($(TARGET_IS_64_BIT)|$(LOCAL_32BIT_ONLY),true|true)
29 LOCAL_2ND_ARCH_VAR_PREFIX := $(TARGET_2ND_ARCH_VAR_PREFIX)
31 LOCAL_2ND_ARCH_VAR_PREFIX :=
34 # If this makefile is being read from within an inheritance,
37 ifdef LOCAL_PACKAGE_OVERRIDES
38 package_overridden := $(call set-inherited-package-variables)
39 ifeq ($(strip $(package_overridden)),)
40 skip_definition := true
44 ifndef skip_definition
46 LOCAL_PACKAGE_NAME := $(strip $(LOCAL_PACKAGE_NAME))
47 ifeq ($(LOCAL_PACKAGE_NAME),)
48 $(error $(LOCAL_PATH): Package modules must define LOCAL_PACKAGE_NAME)
51 ifneq ($(strip $(LOCAL_MODULE_SUFFIX)),)
52 $(error $(LOCAL_PATH): Package modules may not define LOCAL_MODULE_SUFFIX)
54 LOCAL_MODULE_SUFFIX := $(COMMON_ANDROID_PACKAGE_SUFFIX)
56 ifneq ($(strip $(LOCAL_MODULE)),)
57 $(error $(LOCAL_PATH): Package modules may not define LOCAL_MODULE)
59 LOCAL_MODULE := $(LOCAL_PACKAGE_NAME)
61 ifneq ($(strip $(LOCAL_MODULE_CLASS)),)
62 $(error $(LOCAL_PATH): Package modules may not set LOCAL_MODULE_CLASS)
64 LOCAL_MODULE_CLASS := APPS
66 # Package LOCAL_MODULE_TAGS default to optional
67 LOCAL_MODULE_TAGS := $(strip $(LOCAL_MODULE_TAGS))
68 ifeq ($(LOCAL_MODULE_TAGS),)
69 LOCAL_MODULE_TAGS := optional
72 ifeq ($(filter tests, $(LOCAL_MODULE_TAGS)),)
73 # Force localization check if it's not tagged as tests.
74 LOCAL_AAPT_FLAGS := $(LOCAL_AAPT_FLAGS) -z
77 ifeq (,$(LOCAL_ASSET_DIR))
78 LOCAL_ASSET_DIR := $(LOCAL_PATH)/assets
81 ifeq (,$(LOCAL_RESOURCE_DIR))
82 LOCAL_RESOURCE_DIR := $(LOCAL_PATH)/res
85 package_resource_overlays := $(strip \
86 $(wildcard $(foreach dir, $(PRODUCT_PACKAGE_OVERLAYS), \
87 $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))) \
88 $(wildcard $(foreach dir, $(DEVICE_PACKAGE_OVERLAYS), \
89 $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))))
91 LOCAL_RESOURCE_DIR := $(package_resource_overlays) $(LOCAL_RESOURCE_DIR)
93 all_assets := $(strip \
94 $(foreach dir, $(LOCAL_ASSET_DIR), \
95 $(addprefix $(dir)/, \
96 $(patsubst assets/%,%, \
97 $(call find-subdir-assets, $(dir)) \
102 all_resources := $(strip \
103 $(foreach dir, $(LOCAL_RESOURCE_DIR), \
104 $(addprefix $(dir)/, \
105 $(patsubst res/%,%, \
106 $(call find-subdir-assets,$(dir)) \
111 all_res_assets := $(strip $(all_assets) $(all_resources))
113 package_expected_intermediates_COMMON := $(call local-intermediates-dir,COMMON)
114 # If no assets or resources were found, clear the directory variables so
115 # we don't try to build them.
116 ifeq (,$(all_assets))
119 ifeq (,$(all_resources))
123 # Make sure that R_file_stamp inherits the proper PRIVATE vars.
124 # If R.stamp moves, be sure to update the framework makefile,
125 # which has intimate knowledge of its location.
126 R_file_stamp := $(package_expected_intermediates_COMMON)/src/R.stamp
127 LOCAL_INTERMEDIATE_TARGETS += $(R_file_stamp)
130 LOCAL_BUILT_MODULE_STEM := package.apk
132 LOCAL_PROGUARD_ENABLED:=$(strip $(LOCAL_PROGUARD_ENABLED))
133 ifndef LOCAL_PROGUARD_ENABLED
134 ifneq ($(DISABLE_PROGUARD),true)
135 LOCAL_PROGUARD_ENABLED :=full
138 ifeq ($(LOCAL_PROGUARD_ENABLED),disabled)
139 # the package explicitly request to disable proguard.
140 LOCAL_PROGUARD_ENABLED :=
142 proguard_options_file :=
143 ifneq ($(LOCAL_PROGUARD_ENABLED),custom)
144 ifneq ($(all_resources),)
145 proguard_options_file := $(package_expected_intermediates_COMMON)/proguard_options
146 endif # all_resources
148 LOCAL_PROGUARD_FLAGS := $(addprefix -include ,$(proguard_options_file)) $(LOCAL_PROGUARD_FLAGS)
150 ifeq (true,$(EMMA_INSTRUMENT))
151 ifndef LOCAL_EMMA_INSTRUMENT
152 # No emma for test apks.
153 ifeq (,$(filer tests,$(LOCAL_MODULE_TAGS))$(LOCAL_INSTRUMENTATION_FOR))
154 LOCAL_EMMA_INSTRUMENT := true
156 endif # LOCAL_EMMA_INSTRUMENT is not set
158 LOCAL_EMMA_INSTRUMENT := false
159 endif # EMMA_INSTRUMENT is true
161 ifeq (true,$(LOCAL_EMMA_INSTRUMENT))
162 ifeq (true,$(EMMA_INSTRUMENT_STATIC))
163 LOCAL_STATIC_JAVA_LIBRARIES += emma
165 ifdef LOCAL_SDK_VERSION
166 ifdef TARGET_BUILD_APPS
167 # In unbundled build merge the emma library into the apk.
168 LOCAL_STATIC_JAVA_LIBRARIES += emma
170 # If build against the SDK in full build, core.jar is not used,
171 # we have to use prebiult emma.jar to make Proguard happy;
172 # Otherwise emma classes are included in core.jar.
173 LOCAL_PROGUARD_FLAGS += -libraryjars $(EMMA_JAR)
175 endif # LOCAL_SDK_VERSION
176 endif # EMMA_INSTRUMENT_STATIC
177 endif # LOCAL_EMMA_INSTRUMENT
179 rs_compatibility_jni_libs :=
181 #################################
182 include $(BUILD_SYSTEM)/java.mk
183 #################################
185 LOCAL_SDK_RES_VERSION:=$(strip $(LOCAL_SDK_RES_VERSION))
186 ifeq ($(LOCAL_SDK_RES_VERSION),)
187 LOCAL_SDK_RES_VERSION:=$(LOCAL_SDK_VERSION)
190 include $(BUILD_SYSTEM)/android_manifest.mk
192 $(LOCAL_INTERMEDIATE_TARGETS): \
193 PRIVATE_ANDROID_MANIFEST := $(full_android_manifest)
194 ifneq (,$(filter-out current, $(LOCAL_SDK_VERSION)))
195 $(LOCAL_INTERMEDIATE_TARGETS): \
196 PRIVATE_DEFAULT_APP_TARGET_SDK := $(LOCAL_SDK_VERSION)
198 $(LOCAL_INTERMEDIATE_TARGETS): \
199 PRIVATE_DEFAULT_APP_TARGET_SDK := $(DEFAULT_APP_TARGET_SDK)
202 ifneq ($(all_resources),)
204 # Since we don't know where the real R.java file is going to end up,
205 # we need to use another file to stand in its place. We'll just
206 # copy the generated file to src/R.stamp, which means it will
207 # have the same contents and timestamp as the actual file.
209 # At the same time, this will copy the R.java file to a central
210 # 'R' directory to make it easier to add the files to an IDE.
212 #TODO: use PRIVATE_SOURCE_INTERMEDIATES_DIR instead of
213 # $(intermediates.COMMON)/src
214 ifneq ($(package_expected_intermediates_COMMON),$(intermediates.COMMON))
215 $(error $(LOCAL_MODULE): internal error: expected intermediates.COMMON "$(package_expected_intermediates_COMMON)" != intermediates.COMMON "$(intermediates.COMMON)")
218 $(R_file_stamp): PRIVATE_RESOURCE_PUBLICS_OUTPUT := \
219 $(intermediates.COMMON)/public_resources.xml
220 $(R_file_stamp): PRIVATE_PROGUARD_OPTIONS_FILE := $(proguard_options_file)
221 $(R_file_stamp): $(all_res_assets) $(full_android_manifest) $(RenderScript_file_stamp) $(AAPT) | $(ACP)
222 @echo "target R.java/Manifest.java: $(PRIVATE_MODULE) ($@)"
224 $(create-resource-java-files)
225 $(hide) for GENERATED_MANIFEST_FILE in `find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) \
226 -name Manifest.java 2> /dev/null`; do \
227 dir=`awk '/package/{gsub(/\./,"/",$$2);gsub(/;/,"",$$2);print $$2;exit}' $$GENERATED_MANIFEST_FILE`; \
228 mkdir -p $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
229 $(ACP) -fp $$GENERATED_MANIFEST_FILE $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
231 $(hide) for GENERATED_R_FILE in `find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) \
232 -name R.java 2> /dev/null`; do \
233 dir=`awk '/package/{gsub(/\./,"/",$$2);gsub(/;/,"",$$2);print $$2;exit}' $$GENERATED_R_FILE`; \
234 mkdir -p $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \
235 $(ACP) -fp $$GENERATED_R_FILE $(TARGET_COMMON_OUT_ROOT)/R/$$dir \
237 $(ACP) -fp $$GENERATED_R_FILE $@ || exit 32; \
240 $(proguard_options_file): $(R_file_stamp)
242 ifdef LOCAL_EXPORT_PACKAGE_RESOURCES
243 # Put this module's resources into a PRODUCT-agnositc package that
244 # other packages can use to build their own PRODUCT-agnostic R.java (etc.)
246 resource_export_package := $(intermediates.COMMON)/package-export.apk
247 $(R_file_stamp): $(resource_export_package)
249 # add-assets-to-package looks at PRODUCT_AAPT_CONFIG, but this target
250 # can't know anything about PRODUCT. Clear it out just for this target.
251 $(resource_export_package): PRIVATE_PRODUCT_AAPT_CONFIG :=
252 $(resource_export_package): PRIVATE_PRODUCT_AAPT_PREF_CONFIG :=
253 $(resource_export_package): $(all_res_assets) $(full_android_manifest) $(RenderScript_file_stamp) $(AAPT)
254 @echo "target Export Resources: $(PRIVATE_MODULE) ($@)"
255 $(create-empty-package)
256 $(add-assets-to-package)
259 # Other modules should depend on the BUILT module if
260 # they want to use this module's R.java file.
261 $(LOCAL_BUILT_MODULE): $(R_file_stamp)
263 ifneq ($(full_classes_jar),)
264 # If full_classes_jar is non-empty, we're building sources.
265 # If we're building sources, the initial javac step (which
266 # produces full_classes_compiled_jar) needs to ensure the
267 # R.java and Manifest.java files have been generated first.
268 $(full_classes_compiled_jar): $(R_file_stamp)
271 endif # all_resources
273 ifeq ($(LOCAL_NO_STANDARD_LIBRARIES),true)
274 # We need to explicitly clear this var so that we don't
275 # inherit the value from whomever caused us to be built.
276 $(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_AAPT_INCLUDES :=
278 # Most packages should link against the resources defined by framework-res.
279 # Even if they don't have their own resources, they may use framework
281 ifneq ($(filter-out current,$(LOCAL_SDK_RES_VERSION))$(if $(TARGET_BUILD_APPS),$(filter current,$(LOCAL_SDK_RES_VERSION))),)
282 # for released sdk versions, the platform resources were built into android.jar.
283 framework_res_package_export := \
284 $(HISTORICAL_SDK_VERSIONS_ROOT)/$(LOCAL_SDK_RES_VERSION)/android.jar
285 framework_res_package_export_deps := $(framework_res_package_export)
286 else # LOCAL_SDK_RES_VERSION
287 framework_res_package_export := \
288 $(call intermediates-dir-for,APPS,framework-res,,COMMON)/package-export.apk
289 # We can't depend directly on the export.apk file; it won't get its
290 # PRIVATE_ vars set up correctly if we do. Instead, depend on the
291 # corresponding R.stamp file, which lists the export.apk as a dependency.
292 framework_res_package_export_deps := \
293 $(dir $(framework_res_package_export))src/R.stamp
294 endif # LOCAL_SDK_RES_VERSION
295 $(R_file_stamp): $(framework_res_package_export_deps)
296 $(LOCAL_INTERMEDIATE_TARGETS): \
297 PRIVATE_AAPT_INCLUDES := $(framework_res_package_export)
298 endif # LOCAL_NO_STANDARD_LIBRARIES
300 ifneq ($(full_classes_jar),)
301 $(LOCAL_BUILT_MODULE): PRIVATE_DEX_FILE := $(built_dex)
302 $(LOCAL_BUILT_MODULE): $(built_dex)
303 endif # full_classes_jar
306 # Get the list of jni libraries to be included in the apk file.
308 so_suffix := $($(my_prefix)SHLIB_SUFFIX)
310 jni_shared_libraries := \
311 $(addprefix $($(LOCAL_2ND_ARCH_VAR_PREFIX)$(my_prefix)OUT_INTERMEDIATE_LIBRARIES)/, \
312 $(addsuffix $(so_suffix), \
313 $(LOCAL_JNI_SHARED_LIBRARIES)))
315 # Include RS dynamically-generated libraries as well
316 # Keep this ifneq, as the += otherwise adds spaces that need to be stripped.
317 ifneq ($(rs_compatibility_jni_libs),)
318 jni_shared_libraries += $(rs_compatibility_jni_libs)
321 # App explicitly requires the prebuilt NDK libstlport_shared.so.
322 # libstlport_shared.so should never go to the system image.
323 # Instead it should be packaged into the apk.
324 ifeq (stlport_shared,$(LOCAL_NDK_STL_VARIANT))
325 ifndef LOCAL_SDK_VERSION
326 $(error LOCAL_SDK_VERSION has to be defined together with LOCAL_NDK_STL_VARIANT, \
327 LOCAL_PACKAGE_NAME=$(LOCAL_PACKAGE_NAME))
329 jni_shared_libraries += \
330 $(HISTORICAL_NDK_VERSIONS_ROOT)/current/sources/cxx-stl/stlport/libs/$(TARGET_$(LOCAL_2ND_ARCH_VAR_PREFIX)CPU_ABI)/libstlport_shared.so
333 # Set the abi directory used by the local JNI shared libraries.
334 # (Doesn't change how the local shared libraries are compiled, just
335 # sets where they are stored in the apk.)
337 ifeq ($(LOCAL_JNI_SHARED_LIBRARIES_ABI),)
338 jni_shared_libraries_abi := $(TARGET_$(LOCAL_2ND_ARCH_VAR_PREFIX)CPU_ABI)
340 jni_shared_libraries_abi := $(LOCAL_JNI_SHARED_LIBRARIES_ABI)
343 # Pick a key to sign the package with. If this package hasn't specified
344 # an explicit certificate, use the default.
345 # Secure release builds will have their packages signed after the fact,
346 # so it's ok for these private keys to be in the clear.
347 ifeq ($(LOCAL_CERTIFICATE),)
348 LOCAL_CERTIFICATE := $(DEFAULT_SYSTEM_DEV_CERTIFICATE)
351 ifeq ($(LOCAL_CERTIFICATE),EXTERNAL)
352 # The special value "EXTERNAL" means that we will sign it with the
353 # default devkey, apply predexopt, but then expect the final .apk
354 # (after dexopting) to be signed by an outside tool.
355 LOCAL_CERTIFICATE := $(DEFAULT_SYSTEM_DEV_CERTIFICATE)
356 PACKAGES.$(LOCAL_PACKAGE_NAME).EXTERNAL_KEY := 1
359 # If this is not an absolute certificate, assign it to a generic one.
360 ifeq ($(dir $(strip $(LOCAL_CERTIFICATE))),./)
361 LOCAL_CERTIFICATE := $(dir $(DEFAULT_SYSTEM_DEV_CERTIFICATE))$(LOCAL_CERTIFICATE)
363 private_key := $(LOCAL_CERTIFICATE).pk8
364 certificate := $(LOCAL_CERTIFICATE).x509.pem
366 $(LOCAL_BUILT_MODULE): $(private_key) $(certificate) $(SIGNAPK_JAR)
367 $(LOCAL_BUILT_MODULE): PRIVATE_PRIVATE_KEY := $(private_key)
368 $(LOCAL_BUILT_MODULE): PRIVATE_CERTIFICATE := $(certificate)
370 PACKAGES.$(LOCAL_PACKAGE_NAME).PRIVATE_KEY := $(private_key)
371 PACKAGES.$(LOCAL_PACKAGE_NAME).CERTIFICATE := $(certificate)
373 $(LOCAL_BUILT_MODULE): PRIVATE_ADDITIONAL_CERTIFICATES := $(foreach c,\
374 $(LOCAL_ADDITIONAL_CERTIFICATES), $(c).x509.pem $(c).pk8)
376 # Define the rule to build the actual package.
377 $(LOCAL_BUILT_MODULE): $(AAPT) | $(ZIPALIGN)
378 ifdef LOCAL_DEX_PREOPT
379 $(LOCAL_BUILT_MODULE): PRIVATE_DEX_LOCATION := $(patsubst $(PRODUCT_OUT)%,%,$(LOCAL_INSTALLED_MODULE))
380 $(LOCAL_BUILT_MODULE): PRIVATE_BUILT_ODEX := $(built_odex)
381 $(LOCAL_BUILT_MODULE): PRIVATE_DEX_PREOPT_IMAGE := $(LOCAL_DEX_PREOPT_IMAGE)
382 # Make sure the boot jars get dexpreopt-ed first
383 $(LOCAL_BUILT_MODULE) : $(DEXPREOPT_ONE_FILE_DEPENDENCY_BUILT_BOOT_PREOPT)
384 $(LOCAL_BUILT_MODULE) : $(DEXPREOPT_ONE_FILE_DEPENDENCY_TOOLS)
385 $(LOCAL_BUILT_MODULE) : $(LOCAL_DEX_PREOPT_IMAGE)
387 # built_odex is byproduct of LOCAL_BUILT_MODULE without its own build recipe.
388 $(built_odex) : $(LOCAL_BUILT_MODULE)
390 $(LOCAL_BUILT_MODULE): PRIVATE_JNI_SHARED_LIBRARIES := $(jni_shared_libraries)
391 $(LOCAL_BUILT_MODULE): PRIVATE_JNI_SHARED_LIBRARIES_ABI := $(jni_shared_libraries_abi)
392 ifneq ($(TARGET_BUILD_APPS),)
393 # Include all resources for unbundled apps.
394 LOCAL_AAPT_INCLUDE_ALL_RESOURCES := true
396 ifeq ($(LOCAL_AAPT_INCLUDE_ALL_RESOURCES),true)
397 $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_CONFIG :=
398 $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_PREF_CONFIG :=
400 $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_CONFIG := $(PRODUCT_AAPT_CONFIG)
401 $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_PREF_CONFIG := $(PRODUCT_AAPT_PREF_CONFIG)
403 $(LOCAL_BUILT_MODULE): $(all_res_assets) $(jni_shared_libraries) $(full_android_manifest)
404 @echo "target Package: $(PRIVATE_MODULE) ($@)"
405 $(create-empty-package)
406 $(add-assets-to-package)
407 ifneq ($(jni_shared_libraries),)
408 $(add-jni-shared-libs-to-package)
410 ifneq ($(full_classes_jar),)
411 $(add-dex-to-package)
413 $(add-carried-java-resources)
414 ifneq ($(extra_jar_args),)
415 $(add-java-resources-to-package)
418 ifdef LOCAL_DEX_PREOPT
419 $(call dexpreopt-one-file,$(PRIVATE_DEX_PREOPT_IMAGE),$@,$(PRIVATE_DEX_LOCATION),$(PRIVATE_BUILT_ODEX))
420 ifneq (nostripping,$(LOCAL_DEX_PREOPT))
421 $(call dexpreopt-remove-classes.dex,$@)
424 @# Alignment must happen after all other zip operations.
427 # Save information about this package
428 PACKAGES.$(LOCAL_PACKAGE_NAME).OVERRIDES := $(strip $(LOCAL_OVERRIDES_PACKAGES))
429 PACKAGES.$(LOCAL_PACKAGE_NAME).RESOURCE_FILES := $(all_resources)
430 ifdef package_resource_overlays
431 PACKAGES.$(LOCAL_PACKAGE_NAME).RESOURCE_OVERLAYS := $(package_resource_overlays)
434 PACKAGES := $(PACKAGES) $(LOCAL_PACKAGE_NAME)
436 # Dist the files that can be bundled in system.img.
437 # They include the jni shared libraries and the apk with jni libraries stripped.
438 ifeq ($(LOCAL_DIST_BUNDLED_BINARIES),true)
439 ifneq ($(filter $(LOCAL_PACKAGE_NAME),$(TARGET_BUILD_APPS)),)
440 ifneq ($(strip $(jni_shared_libraries)),)
441 dist_subdir := bundled_$(LOCAL_PACKAGE_NAME)
442 $(foreach f, $(jni_shared_libraries), \
443 $(call dist-for-goals, apps_only, $(f):$(dist_subdir)/$(notdir $(f))))
445 apk_jni_stripped := $(intermediates)/jni_stripped/package.apk
446 $(apk_jni_stripped): PRIVATE_JNI_SHARED_LIBRARIES := $(notdir $(jni_shared_libraries))
447 $(apk_jni_stripped) : $(LOCAL_BUILT_MODULE) | $(ZIPALIGN)
448 @rm -rf $(dir $@) && mkdir -p $(dir $@)
450 $(hide) zip -d $@ $(foreach f,$(PRIVATE_JNI_SHARED_LIBRARIES),\*/$(f))
451 $(call align-package)
453 $(call dist-for-goals, apps_only, $(apk_jni_stripped):$(dist_subdir)/$(LOCAL_PACKAGE_NAME).apk)
455 endif # jni_shared_libraries
456 endif # apps_only build
457 endif # LOCAL_DIST_BUNDLED_BINARIES
460 .PHONY: lint-$(LOCAL_PACKAGE_NAME)
461 lint-$(LOCAL_PACKAGE_NAME): PRIVATE_PATH := $(LOCAL_PATH)
462 lint-$(LOCAL_PACKAGE_NAME): PRIVATE_LINT_FLAGS := $(LOCAL_LINT_FLAGS)
463 lint-$(LOCAL_PACKAGE_NAME) :
464 @echo lint $(PRIVATE_PATH)
465 $(LINT) $(PRIVATE_LINT_FLAGS) $(PRIVATE_PATH)
467 lintall : lint-$(LOCAL_PACKAGE_NAME)
469 endif # skip_definition
471 # Reset internal variables.
474 LOCAL_2ND_ARCH_VAR_PREFIX :=