package.mk revision 3c21fe5b12d95fe374b9b8c874dc4c48b7f9fce1
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 56# Android packages should use Android resources or assets. 57ifneq (,$(LOCAL_JAVA_RESOURCE_DIRS)) 58$(error $(LOCAL_PATH): Package modules may not set LOCAL_JAVA_RESOURCE_DIRS) 59endif 60ifneq (,$(LOCAL_JAVA_RESOURCE_FILES)) 61$(error $(LOCAL_PATH): Package modules may not set LOCAL_JAVA_RESOURCE_FILES) 62endif 63 64ifeq ($(strip $(LOCAL_MANIFEST_FILE)),) 65LOCAL_MANIFEST_FILE := AndroidManifest.xml 66endif 67 68ifneq ($(strip $(LOCAL_MODULE_CLASS)),) 69$(error $(LOCAL_PATH): Package modules may not set LOCAL_MODULE_CLASS) 70endif 71LOCAL_MODULE_CLASS := APPS 72 73# Package LOCAL_MODULE_TAGS default to optional 74LOCAL_MODULE_TAGS := $(strip $(LOCAL_MODULE_TAGS)) 75ifeq ($(LOCAL_MODULE_TAGS),) 76LOCAL_MODULE_TAGS := optional 77endif 78 79ifeq ($(filter tests, $(LOCAL_MODULE_TAGS)),) 80# Force localization check if it's not tagged as tests. 81LOCAL_AAPT_FLAGS := $(LOCAL_AAPT_FLAGS) -z 82endif 83 84ifeq (,$(LOCAL_ASSET_DIR)) 85LOCAL_ASSET_DIR := $(LOCAL_PATH)/assets 86endif 87 88ifeq (,$(LOCAL_RESOURCE_DIR)) 89 LOCAL_RESOURCE_DIR := $(LOCAL_PATH)/res 90endif 91LOCAL_RESOURCE_DIR := \ 92 $(wildcard $(foreach dir, $(PRODUCT_PACKAGE_OVERLAYS), \ 93 $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))) \ 94 $(wildcard $(foreach dir, $(DEVICE_PACKAGE_OVERLAYS), \ 95 $(addprefix $(dir)/, $(LOCAL_RESOURCE_DIR)))) \ 96 $(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 150ifeq (true,$(WITH_DEXPREOPT)) 151ifeq (,$(TARGET_BUILD_APPS)) 152ifneq (,$(LOCAL_SRC_FILES)) 153ifndef LOCAL_DEX_PREOPT 154LOCAL_DEX_PREOPT := true 155endif 156endif 157endif 158endif 159 160################################# 161include $(BUILD_SYSTEM)/java.mk 162################################# 163 164full_android_manifest := $(LOCAL_PATH)/$(LOCAL_MANIFEST_FILE) 165$(LOCAL_INTERMEDIATE_TARGETS): \ 166 PRIVATE_ANDROID_MANIFEST := $(full_android_manifest) 167ifneq (,$(filter-out current, $(LOCAL_SDK_VERSION))) 168$(LOCAL_INTERMEDIATE_TARGETS): \ 169 PRIVATE_DEFAULT_APP_TARGET_SDK := $(LOCAL_SDK_VERSION) 170else 171$(LOCAL_INTERMEDIATE_TARGETS): \ 172 PRIVATE_DEFAULT_APP_TARGET_SDK := $(DEFAULT_APP_TARGET_SDK) 173endif 174 175ifneq ($(all_resources),) 176 177# Since we don't know where the real R.java file is going to end up, 178# we need to use another file to stand in its place. We'll just 179# copy the generated file to src/R.stamp, which means it will 180# have the same contents and timestamp as the actual file. 181# 182# At the same time, this will copy the R.java file to a central 183# 'R' directory to make it easier to add the files to an IDE. 184# 185#TODO: use PRIVATE_SOURCE_INTERMEDIATES_DIR instead of 186# $(intermediates.COMMON)/src 187ifneq ($(package_expected_intermediates_COMMON),$(intermediates.COMMON)) 188 $(error $(LOCAL_MODULE): internal error: expected intermediates.COMMON "$(package_expected_intermediates_COMMON)" != intermediates.COMMON "$(intermediates.COMMON)") 189endif 190 191$(R_file_stamp): PRIVATE_RESOURCE_PUBLICS_OUTPUT := \ 192 $(intermediates.COMMON)/public_resources.xml 193$(R_file_stamp): PRIVATE_PROGUARD_OPTIONS_FILE := $(proguard_options_file) 194$(R_file_stamp): $(all_res_assets) $(full_android_manifest) $(RenderScript_file_stamp) $(AAPT) | $(ACP) 195 @echo "target R.java/Manifest.java: $(PRIVATE_MODULE) ($@)" 196 @rm -f $@ 197 $(create-resource-java-files) 198 $(hide) for GENERATED_MANIFEST_FILE in `find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) \ 199 -name Manifest.java 2> /dev/null`; do \ 200 dir=`awk '/package/{gsub(/\./,"/",$$2);gsub(/;/,"",$$2);print $$2;exit}' $$GENERATED_MANIFEST_FILE`; \ 201 mkdir -p $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \ 202 $(ACP) -fp $$GENERATED_MANIFEST_FILE $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \ 203 done; 204 $(hide) for GENERATED_R_FILE in `find $(PRIVATE_SOURCE_INTERMEDIATES_DIR) \ 205 -name R.java 2> /dev/null`; do \ 206 dir=`awk '/package/{gsub(/\./,"/",$$2);gsub(/;/,"",$$2);print $$2;exit}' $$GENERATED_R_FILE`; \ 207 mkdir -p $(TARGET_COMMON_OUT_ROOT)/R/$$dir; \ 208 $(ACP) -fp $$GENERATED_R_FILE $(TARGET_COMMON_OUT_ROOT)/R/$$dir \ 209 || exit 31; \ 210 $(ACP) -fp $$GENERATED_R_FILE $@ || exit 32; \ 211 done; \ 212 213$(proguard_options_file): $(R_file_stamp) 214 215ifdef LOCAL_EXPORT_PACKAGE_RESOURCES 216# Put this module's resources into a PRODUCT-agnositc package that 217# other packages can use to build their own PRODUCT-agnostic R.java (etc.) 218# files. 219resource_export_package := $(intermediates.COMMON)/package-export.apk 220$(R_file_stamp): $(resource_export_package) 221 222# add-assets-to-package looks at PRODUCT_AAPT_CONFIG, but this target 223# can't know anything about PRODUCT. Clear it out just for this target. 224$(resource_export_package): PRIVATE_PRODUCT_AAPT_CONFIG := 225$(resource_export_package): $(all_res_assets) $(full_android_manifest) $(RenderScript_file_stamp) $(AAPT) 226 @echo "target Export Resources: $(PRIVATE_MODULE) ($@)" 227 $(create-empty-package) 228 $(add-assets-to-package) 229endif 230 231# Other modules should depend on the BUILT module if 232# they want to use this module's R.java file. 233$(LOCAL_BUILT_MODULE): $(R_file_stamp) 234 235ifneq ($(full_classes_jar),) 236# If full_classes_jar is non-empty, we're building sources. 237# If we're building sources, the initial javac step (which 238# produces full_classes_compiled_jar) needs to ensure the 239# R.java and Manifest.java files have been generated first. 240$(full_classes_compiled_jar): $(R_file_stamp) 241endif 242 243endif # all_resources 244 245ifeq ($(LOCAL_NO_STANDARD_LIBRARIES),true) 246# We need to explicitly clear this var so that we don't 247# inherit the value from whomever caused us to be built. 248$(LOCAL_INTERMEDIATE_TARGETS): PRIVATE_AAPT_INCLUDES := 249else 250# Most packages should link against the resources defined by framework-res. 251# Even if they don't have their own resources, they may use framework 252# resources. 253ifneq ($(filter-out current,$(LOCAL_SDK_VERSION)),) 254# for released sdk versions, the platform resources were built into android.jar. 255framework_res_package_export := \ 256 $(HISTORICAL_SDK_VERSIONS_ROOT)/$(LOCAL_SDK_VERSION)/android.jar 257framework_res_package_export_deps := $(framework_res_package_export) 258else # LOCAL_SDK_VERSION 259framework_res_package_export := \ 260 $(call intermediates-dir-for,APPS,framework-res,,COMMON)/package-export.apk 261# We can't depend directly on the export.apk file; it won't get its 262# PRIVATE_ vars set up correctly if we do. Instead, depend on the 263# corresponding R.stamp file, which lists the export.apk as a dependency. 264framework_res_package_export_deps := \ 265 $(dir $(framework_res_package_export))src/R.stamp 266endif # LOCAL_SDK_VERSION 267$(R_file_stamp): $(framework_res_package_export_deps) 268$(LOCAL_INTERMEDIATE_TARGETS): \ 269 PRIVATE_AAPT_INCLUDES := $(framework_res_package_export) 270endif # LOCAL_NO_STANDARD_LIBRARIES 271 272ifneq ($(full_classes_jar),) 273$(LOCAL_BUILT_MODULE): PRIVATE_DEX_FILE := $(built_dex) 274$(LOCAL_BUILT_MODULE): $(built_dex) 275endif # full_classes_jar 276 277 278# Get the list of jni libraries to be included in the apk file. 279 280so_suffix := $($(my_prefix)SHLIB_SUFFIX) 281 282jni_shared_libraries := \ 283 $(addprefix $($(my_prefix)OUT_INTERMEDIATE_LIBRARIES)/, \ 284 $(addsuffix $(so_suffix), \ 285 $(LOCAL_JNI_SHARED_LIBRARIES))) 286 287# Set the abi directory used by the local JNI shared libraries. 288# (Doesn't change how the local shared libraries are compiled, just 289# sets where they are stored in the apk.) 290 291ifeq ($(LOCAL_JNI_SHARED_LIBRARIES_ABI),) 292 jni_shared_libraries_abi := $(TARGET_CPU_ABI) 293else 294 jni_shared_libraries_abi := $(LOCAL_JNI_SHARED_LIBRARIES_ABI) 295endif 296 297# Pick a key to sign the package with. If this package hasn't specified 298# an explicit certificate, use the default. 299# Secure release builds will have their packages signed after the fact, 300# so it's ok for these private keys to be in the clear. 301ifeq ($(LOCAL_CERTIFICATE),) 302 LOCAL_CERTIFICATE := $(DEFAULT_SYSTEM_DEV_CERTIFICATE) 303endif 304 305ifeq ($(LOCAL_CERTIFICATE),EXTERNAL) 306 # The special value "EXTERNAL" means that we will sign it with the 307 # default devkey, apply predexopt, but then expect the final .apk 308 # (after dexopting) to be signed by an outside tool. 309 LOCAL_CERTIFICATE := $(DEFAULT_SYSTEM_DEV_CERTIFICATE) 310 PACKAGES.$(LOCAL_PACKAGE_NAME).EXTERNAL_KEY := 1 311endif 312 313# If this is not an absolute certificate, assign it to a generic one. 314ifeq ($(dir $(strip $(LOCAL_CERTIFICATE))),./) 315 LOCAL_CERTIFICATE := $(dir $(DEFAULT_SYSTEM_DEV_CERTIFICATE))$(LOCAL_CERTIFICATE) 316endif 317private_key := $(LOCAL_CERTIFICATE).pk8 318certificate := $(LOCAL_CERTIFICATE).x509.pem 319 320$(LOCAL_BUILT_MODULE): $(private_key) $(certificate) $(SIGNAPK_JAR) 321$(LOCAL_BUILT_MODULE): PRIVATE_PRIVATE_KEY := $(private_key) 322$(LOCAL_BUILT_MODULE): PRIVATE_CERTIFICATE := $(certificate) 323 324PACKAGES.$(LOCAL_PACKAGE_NAME).PRIVATE_KEY := $(private_key) 325PACKAGES.$(LOCAL_PACKAGE_NAME).CERTIFICATE := $(certificate) 326 327# Define the rule to build the actual package. 328$(LOCAL_BUILT_MODULE): $(AAPT) | $(ZIPALIGN) 329ifeq ($(LOCAL_DEX_PREOPT),true) 330# Make sure the boot jars get dexpreopt-ed first 331$(LOCAL_BUILT_MODULE): $(DEXPREOPT_BOOT_ODEXS) | $(DEXPREOPT) $(DEXOPT) 332endif 333$(LOCAL_BUILT_MODULE): PRIVATE_JNI_SHARED_LIBRARIES := $(jni_shared_libraries) 334$(LOCAL_BUILT_MODULE): PRIVATE_JNI_SHARED_LIBRARIES_ABI := $(jni_shared_libraries_abi) 335ifneq ($(TARGET_BUILD_APPS),) 336 # Include all resources for unbundled apps. 337 LOCAL_AAPT_INCLUDE_ALL_RESOURCES := true 338endif 339ifeq ($(LOCAL_AAPT_INCLUDE_ALL_RESOURCES),true) 340 $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_CONFIG := 341else 342 $(LOCAL_BUILT_MODULE): PRIVATE_PRODUCT_AAPT_CONFIG := $(PRODUCT_AAPT_CONFIG) 343endif 344$(LOCAL_BUILT_MODULE): $(all_res_assets) $(jni_shared_libraries) $(full_android_manifest) 345 @echo "target Package: $(PRIVATE_MODULE) ($@)" 346 $(create-empty-package) 347 $(add-assets-to-package) 348ifneq ($(jni_shared_libraries),) 349 $(add-jni-shared-libs-to-package) 350endif 351ifneq ($(full_classes_jar),) 352 $(add-dex-to-package) 353endif 354 $(sign-package) 355 @# Alignment must happen after all other zip operations. 356 $(align-package) 357ifeq ($(LOCAL_DEX_PREOPT),true) 358 $(hide) rm -f $(patsubst %.apk,%.odex,$@) 359 $(call dexpreopt-one-file,$@,$(patsubst %.apk,%.odex,$@)) 360 $(call dexpreopt-remove-classes.dex,$@) 361 362built_odex := $(basename $(LOCAL_BUILT_MODULE)).odex 363$(built_odex): $(LOCAL_BUILT_MODULE) 364endif 365 366# Save information about this package 367PACKAGES.$(LOCAL_PACKAGE_NAME).OVERRIDES := $(strip $(LOCAL_OVERRIDES_PACKAGES)) 368PACKAGES.$(LOCAL_PACKAGE_NAME).RESOURCE_FILES := $(all_resources) 369 370PACKAGES := $(PACKAGES) $(LOCAL_PACKAGE_NAME) 371 372endif # skip_definition 373