cleanbuild.mk revision d37b540a39250991b5235b80d7db081b1cfaced4
1# Copyright (C) 2007 The Android Open Source Project 2# 3# Licensed under the Apache License, Version 2.0 (the "License"); 4# you may not use this file except in compliance with the License. 5# You may obtain a copy of the License at 6# 7# http://www.apache.org/licenses/LICENSE-2.0 8# 9# Unless required by applicable law or agreed to in writing, software 10# distributed under the License is distributed on an "AS IS" BASIS, 11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12# See the License for the specific language governing permissions and 13# limitations under the License. 14# 15 16# Don't bother with the cleanspecs if you are running mm/mmm 17ifeq ($(ONE_SHOT_MAKEFILE)$(dont_bother),) 18 19INTERNAL_CLEAN_STEPS := 20 21# Builds up a list of clean steps. Creates a unique 22# id for each step by taking makefile path, INTERNAL_CLEAN_BUILD_VERSION 23# and appending an increasing number of '@' characters. 24# 25# $(1): shell command to run 26# $(2): indicate to not use makefile path as part of step id if not empty. 27# $(2) should only be used in build/core/cleanspec.mk: just for compatibility. 28define _add-clean-step 29 $(if $(strip $(INTERNAL_CLEAN_BUILD_VERSION)),, \ 30 $(error INTERNAL_CLEAN_BUILD_VERSION not set)) 31 $(eval _acs_makefile_prefix := $(lastword $(MAKEFILE_LIST))) 32 $(eval _acs_makefile_prefix := $(subst /,_,$(_acs_makefile_prefix))) 33 $(eval _acs_makefile_prefix := $(subst .,-,$(_acs_makefile_prefix))) 34 $(eval _acs_makefile_prefix := $(_acs_makefile_prefix)_acs) 35 $(if $($(_acs_makefile_prefix)),,\ 36 $(eval $(_acs_makefile_prefix) := $(INTERNAL_CLEAN_BUILD_VERSION))) 37 $(eval $(_acs_makefile_prefix) := $($(_acs_makefile_prefix))@) 38 $(if $(strip $(2)),$(eval _acs_id := $($(_acs_makefile_prefix))),\ 39 $(eval _acs_id := $(_acs_makefile_prefix)$($(_acs_makefile_prefix)))) 40 $(eval INTERNAL_CLEAN_STEPS += $(_acs_id)) 41 $(eval INTERNAL_CLEAN_STEP.$(_acs_id) := $(1)) 42 $(eval _acs_id :=) 43 $(eval _acs_makefile_prefix :=) 44endef 45define add-clean-step 46$(eval # for build/core/cleanspec.mk, dont use makefile path as part of step id) \ 47$(if $(filter %/cleanspec.mk,$(lastword $(MAKEFILE_LIST))),\ 48 $(eval $(call _add-clean-step,$(1),true)),\ 49 $(eval $(call _add-clean-step,$(1)))) 50endef 51 52# Defines INTERNAL_CLEAN_BUILD_VERSION and the individual clean steps. 53# cleanspec.mk is outside of the core directory so that more people 54# can have permission to touch it. 55include $(BUILD_SYSTEM)/cleanspec.mk 56INTERNAL_CLEAN_BUILD_VERSION := $(strip $(INTERNAL_CLEAN_BUILD_VERSION)) 57 58# If the clean_steps.mk file is missing (usually after a clean build) 59# then we won't do anything. 60CURRENT_CLEAN_BUILD_VERSION := $(INTERNAL_CLEAN_BUILD_VERSION) 61CURRENT_CLEAN_STEPS := $(INTERNAL_CLEAN_STEPS) 62 63# Read the current state from the file, if present. 64# Will set CURRENT_CLEAN_BUILD_VERSION and CURRENT_CLEAN_STEPS. 65# 66clean_steps_file := $(PRODUCT_OUT)/clean_steps.mk 67-include $(clean_steps_file) 68 69ifneq ($(CURRENT_CLEAN_BUILD_VERSION),$(INTERNAL_CLEAN_BUILD_VERSION)) 70 # The major clean version is out-of-date. Do a full clean, and 71 # don't even bother with the clean steps. 72 $(info *** A clean build is required because of a recent change.) 73 $(shell rm -rf $(OUT_DIR)) 74 $(info *** Done with the cleaning, now starting the real build.) 75else 76 # The major clean version is correct. Find the list of clean steps 77 # that we need to execute to get up-to-date. 78 steps := \ 79 $(filter-out $(CURRENT_CLEAN_STEPS),$(INTERNAL_CLEAN_STEPS)) 80 $(foreach step,$(steps), \ 81 $(info Clean step: $(INTERNAL_CLEAN_STEP.$(step))) \ 82 $(shell $(INTERNAL_CLEAN_STEP.$(step))) \ 83 ) 84 85 # Rewrite the clean step for the second arch. 86 ifdef TARGET_2ND_ARCH 87 # $(1): the clean step cmd 88 # $(2): the prefix to search for 89 # $(3): the prefix to replace with 90 define -cs-rewrite-cleanstep 91 $(if $(filter $(2)/%,$(1)),\ 92 $(eval _crs_new_cmd := $(patsubst $(2)/%,$(3)/%,$(1)))\ 93 $(info Clean step: $(_crs_new_cmd))\ 94 $(shell $(_crs_new_cmd))) 95 endef 96 $(foreach step,$(steps), \ 97 $(call -cs-rewrite-cleanstep,$(INTERNAL_CLEAN_STEP.$(step)),$(TARGET_OUT_INTERMEDIATES),$($(TARGET_2ND_ARCH_VAR_PREFIX)TARGET_OUT_INTERMEDIATES))\ 98 $(call -cs-rewrite-cleanstep,$(INTERNAL_CLEAN_STEP.$(step)),$(TARGET_OUT_SHARED_LIBRARIES),$($(TARGET_2ND_ARCH_VAR_PREFIX)TARGET_OUT_SHARED_LIBRARIES))\ 99 $(call -cs-rewrite-cleanstep,$(INTERNAL_CLEAN_STEP.$(step)),$(TARGET_OUT_VENDOR_SHARED_LIBRARIES),$($(TARGET_2ND_ARCH_VAR_PREFIX)TARGET_OUT_VENDOR_SHARED_LIBRARIES))\ 100 $(call -cs-rewrite-cleanstep,$(INTERNAL_CLEAN_STEP.$(step)),$($(TARGET_2ND_ARCH_VAR_PREFIX)TARGET_OUT_INTERMEDIATES),$(TARGET_OUT_INTERMEDIATES))\ 101 $(call -cs-rewrite-cleanstep,$(INTERNAL_CLEAN_STEP.$(step)),$($(TARGET_2ND_ARCH_VAR_PREFIX)TARGET_OUT_SHARED_LIBRARIES),$(TARGET_OUT_SHARED_LIBRARIES))\ 102 $(call -cs-rewrite-cleanstep,$(INTERNAL_CLEAN_STEP.$(step)),$($(TARGET_2ND_ARCH_VAR_PREFIX)TARGET_OUT_VENDOR_SHARED_LIBRARIES),$(TARGET_OUT_VENDOR_SHARED_LIBRARIES))\ 103 ) 104 endif 105 _crs_new_cmd := 106 steps := 107endif 108CURRENT_CLEAN_BUILD_VERSION := 109CURRENT_CLEAN_STEPS := 110 111# Write the new state to the file. 112# 113$(shell \ 114 mkdir -p $(dir $(clean_steps_file)) && \ 115 echo "CURRENT_CLEAN_BUILD_VERSION := $(INTERNAL_CLEAN_BUILD_VERSION)" > \ 116 $(clean_steps_file) ;\ 117 echo "CURRENT_CLEAN_STEPS := $(INTERNAL_CLEAN_STEPS)" >> \ 118 $(clean_steps_file) \ 119 ) 120 121clean_steps_file := 122INTERNAL_CLEAN_STEPS := 123INTERNAL_CLEAN_BUILD_VERSION := 124 125endif # if not ONE_SHOT_MAKEFILE dont_bother 126 127# Since products and build variants (unfortunately) share the same 128# PRODUCT_OUT staging directory, things can get out of sync if different 129# build configurations are built in the same tree. The following logic 130# will notice when the configuration has changed and remove the files 131# necessary to keep things consistent. 132 133previous_build_config_file := $(PRODUCT_OUT)/previous_build_config.mk 134 135# A change in the list of aapt configs warrants an installclean, too. 136aapt_config_list := $(strip $(PRODUCT_AAPT_CONFIG) $(PRODUCT_AAPT_PREF_CONFIG)) 137 138current_build_config := \ 139 $(TARGET_PRODUCT)-$(TARGET_BUILD_VARIANT)-{$(aapt_config_list)} 140current_sanitize_target := $(strip $(SANITIZE_TARGET)) 141ifeq (,$(current_sanitize_target)) 142 current_sanitize_target := false 143endif 144aapt_config_list := 145force_installclean := false 146force_objclean := false 147 148# Read the current state from the file, if present. 149# Will set PREVIOUS_BUILD_CONFIG. 150# 151PREVIOUS_BUILD_CONFIG := 152PREVIOUS_SANITIZE_TARGET := 153-include $(previous_build_config_file) 154PREVIOUS_BUILD_CONFIG := $(strip $(PREVIOUS_BUILD_CONFIG)) 155PREVIOUS_SANITIZE_TARGET := $(strip $(PREVIOUS_SANITIZE_TARGET)) 156 157ifdef PREVIOUS_BUILD_CONFIG 158 ifneq "$(current_build_config)" "$(PREVIOUS_BUILD_CONFIG)" 159 $(info *** Build configuration changed: "$(PREVIOUS_BUILD_CONFIG)" -> "$(current_build_config)") 160 ifneq ($(DISABLE_AUTO_INSTALLCLEAN),true) 161 force_installclean := true 162 else 163 $(info DISABLE_AUTO_INSTALLCLEAN is set; skipping auto-clean. Your tree may be in an inconsistent state.) 164 endif 165 endif 166endif # else, this is the first build, so no need to clean. 167PREVIOUS_BUILD_CONFIG := 168 169ifdef PREVIOUS_SANITIZE_TARGET 170 ifneq "$(current_sanitize_target)" "$(PREVIOUS_SANITIZE_TARGET)" 171 $(info *** SANITIZE_TARGET changed: "$(PREVIOUS_SANITIZE_TARGET)" -> "$(current_sanitize_target)") 172 force_objclean := true 173 endif 174endif # else, this is the first build, so no need to clean. 175PREVIOUS_SANITIZE_TARGET := 176 177# Write the new state to the file. 178# 179$(shell \ 180 mkdir -p $(dir $(previous_build_config_file)) && \ 181 echo "PREVIOUS_BUILD_CONFIG := $(current_build_config)" > \ 182 $(previous_build_config_file) && \ 183 echo "PREVIOUS_SANITIZE_TARGET := $(current_sanitize_target)" >> \ 184 $(previous_build_config_file) \ 185 ) 186previous_build_config_file := 187current_build_config := 188 189# 190# installclean logic 191# 192 193# The files/dirs to delete during an installclean. This includes the 194# non-common APPS directory, which may contain the wrong resources. 195# 196# Deletes all of the files that change between different build types, 197# like "make user" vs. "make sdk". This lets you work with different 198# build types without having to do a full clean each time. E.g.: 199# 200# $ make -j8 all 201# $ make installclean 202# $ make -j8 user 203# $ make installclean 204# $ make -j8 sdk 205# 206installclean_files := \ 207 $(HOST_OUT)/obj/NOTICE_FILES \ 208 $(HOST_OUT)/sdk \ 209 $(PRODUCT_OUT)/*.img \ 210 $(PRODUCT_OUT)/*.ini \ 211 $(PRODUCT_OUT)/*.txt \ 212 $(PRODUCT_OUT)/*.xlb \ 213 $(PRODUCT_OUT)/*.zip \ 214 $(PRODUCT_OUT)/kernel \ 215 $(PRODUCT_OUT)/data \ 216 $(PRODUCT_OUT)/skin \ 217 $(PRODUCT_OUT)/obj/APPS \ 218 $(PRODUCT_OUT)/obj/NOTICE_FILES \ 219 $(PRODUCT_OUT)/obj/PACKAGING \ 220 $(PRODUCT_OUT)/recovery \ 221 $(PRODUCT_OUT)/root \ 222 $(PRODUCT_OUT)/system \ 223 $(PRODUCT_OUT)/vendor \ 224 $(PRODUCT_OUT)/oem \ 225 $(PRODUCT_OUT)/dex_bootjars \ 226 $(PRODUCT_OUT)/obj/JAVA_LIBRARIES \ 227 $(PRODUCT_OUT)/obj/FAKE \ 228 $(PRODUCT_OUT)/obj/EXECUTABLES/adbd_intermediates \ 229 $(PRODUCT_OUT)/obj/STATIC_LIBRARIES/libfs_mgr_intermediates \ 230 $(PRODUCT_OUT)/obj/EXECUTABLES/init_intermediates \ 231 $(PRODUCT_OUT)/obj/ETC/mac_permissions.xml_intermediates \ 232 $(PRODUCT_OUT)/obj/ETC/sepolicy_intermediates \ 233 $(PRODUCT_OUT)/obj/ETC/init.environ.rc_intermediates 234 235# The files/dirs to delete during a dataclean, which removes any files 236# in the staging and emulator data partitions. 237dataclean_files := \ 238 $(PRODUCT_OUT)/data/* \ 239 $(PRODUCT_OUT)/data-qemu/* \ 240 $(PRODUCT_OUT)/userdata-qemu.img 241 242# The files/dirs to delete during an objclean, which removes any files 243# in the staging and emulator data partitions. 244objclean_files := \ 245 $(TARGET_OUT_INTERMEDIATES) \ 246 $($(TARGET_2ND_ARCH_VAR_PREFIX)TARGET_OUT_INTERMEDIATES) 247 248# make sure *_OUT is set so that we won't result in deleting random parts 249# of the filesystem. 250ifneq (2,$(words $(HOST_OUT) $(PRODUCT_OUT))) 251 $(error both HOST_OUT and PRODUCT_OUT should be set at this point.) 252endif 253 254# Define the rules for commandline invocation. 255.PHONY: dataclean 256dataclean: FILES := $(dataclean_files) 257dataclean: 258 $(hide) rm -rf $(FILES) 259 @echo "Deleted emulator userdata images." 260 261.PHONY: installclean 262installclean: FILES := $(installclean_files) 263installclean: dataclean 264 $(hide) rm -rf $(FILES) 265 @echo "Deleted images and staging directories." 266 267.PHONY: objclean 268objclean: FILES := $(objclean_files) 269objclean: 270 $(hide) rm -rf $(FILES) 271 @echo "Deleted images and staging directories." 272 273ifeq "$(force_installclean)" "true" 274 $(info *** Forcing "make installclean"...) 275 $(info *** rm -rf $(dataclean_files) $(installclean_files)) 276 $(shell rm -rf $(dataclean_files) $(installclean_files)) 277 $(info *** Done with the cleaning, now starting the real build.) 278endif 279force_installclean := 280 281ifeq "$(force_objclean)" "true" 282 $(info *** Forcing cleanup of intermediate files...) 283 $(info *** rm -rf $(objclean_files)) 284 $(shell rm -rf $(objclean_files)) 285 $(info *** Done with the cleaning, now starting the real build.) 286endif 287force_objclean := 288 289########################################################### 290# Clean build tools when swithcing between prebuilt host tools (such as in 291# apps_only build) and tools built from source (platform build). 292previous_prebuilt_tools_config_file := $(HOST_OUT)/previous_prebuilt_tools_config.mk 293ifneq (,$(TARGET_BUILD_APPS)$(filter true,$(TARGET_BUILD_PDK))) 294current_prebuilt_tools := true 295else 296current_prebuilt_tools := false 297endif 298PREVIOUS_PREBUILT_TOOLS := 299-include $(previous_prebuilt_tools_config_file) 300force_tools_clean := 301ifdef PREVIOUS_PREBUILT_TOOLS 302ifneq ($(PREVIOUS_PREBUILT_TOOLS),$(current_prebuilt_tools)) 303force_tools_clean := true 304endif 305endif # else, this is the first build, so no need to clean. 306 307# Write the new state to the file. 308$(shell \ 309 mkdir -p $(dir $(previous_prebuilt_tools_config_file)) && \ 310 echo "PREVIOUS_PREBUILT_TOOLS:=$(current_prebuilt_tools)" > \ 311 $(previous_prebuilt_tools_config_file)) 312 313ifeq ($(force_tools_clean),true) 314# For this list of prebuilt tools, see prebuilts/sdk/tools/Android.mk. 315tools_clean_files := \ 316 $(HOST_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/signapk_intermediates \ 317 $(HOST_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/dx_intermediates \ 318 $(HOST_OUT_COMMON_INTERMEDIATES)/JAVA_LIBRARIES/shrinkedAndroid_intermediates \ 319 $(HOST_OUT)/obj*/EXECUTABLES/aapt_intermediates \ 320 $(HOST_OUT)/obj*/EXECUTABLES/aidl_intermediates \ 321 $(HOST_OUT)/obj*/EXECUTABLES/zipalign_intermediates \ 322 $(HOST_OUT)/obj*/lib/libc++$(HOST_SHLIB_SUFFIX) \ 323 324$(info *** build type changed, clean host tools...) 325$(info *** rm -rf $(tools_clean_files)) 326$(shell rm -rf $(tools_clean_files)) 327endif 328 329########################################################### 330 331.PHONY: clean-jack-files 332clean-jack-files: clean-dex-files 333 $(hide) find $(OUT_DIR) -name "*.jack" | xargs rm -f 334 $(hide) find $(OUT_DIR) -type d -name "jack" | xargs rm -rf 335 @echo "All jack files have been removed." 336 337.PHONY: clean-dex-files 338clean-dex-files: 339 $(hide) find $(OUT_DIR) -name "*.dex" ! -path "*/jack-incremental/*" | xargs rm -f 340 $(hide) for i in `find $(OUT_DIR) -name "*.jar" -o -name "*.apk"` ; do ((unzip -l $$i 2> /dev/null | \ 341 grep -q "\.dex$$" && rm -f $$i) || continue ) ; done 342 @echo "All dex files and archives containing dex files have been removed." 343 344.PHONY: clean-jack-incremental 345clean-jack-incremental: 346 $(hide) find $(OUT_DIR) -name "jack-incremental" -type d | xargs rm -rf 347 @echo "All jack incremental dirs have been removed." 348