MakeBase.gmk revision 1915:c2696ab4abae
1# 2# Copyright (c) 2011, 2015, Oracle and/or its affiliates. All rights reserved. 3# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4# 5# This code is free software; you can redistribute it and/or modify it 6# under the terms of the GNU General Public License version 2 only, as 7# published by the Free Software Foundation. Oracle designates this 8# particular file as subject to the "Classpath" exception as provided 9# by Oracle in the LICENSE file that accompanied this code. 10# 11# This code is distributed in the hope that it will be useful, but WITHOUT 12# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14# version 2 for more details (a copy is included in the LICENSE file that 15# accompanied this code). 16# 17# You should have received a copy of the GNU General Public License version 18# 2 along with this work; if not, write to the Free Software Foundation, 19# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20# 21# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22# or visit www.oracle.com if you need additional information or have any 23# questions. 24# 25 26################################################################ 27# 28# Setup common utility functions. 29# 30################################################################ 31 32ifndef _MAKEBASE_GMK 33_MAKEBASE_GMK := 1 34 35ifeq ($(wildcard $(SPEC)),) 36 $(error MakeBase.gmk needs SPEC set to a proper spec.gmk) 37endif 38 39# By defining this pseudo target, make will automatically remove targets 40# if their recipe fails so that a rebuild is automatically triggered on the 41# next make invocation. 42.DELETE_ON_ERROR: 43 44################################################################################ 45# Definitions for special characters 46################################################################################ 47 48# When calling macros, the spaces between arguments are 49# often semantically important! Sometimes we need to subst 50# spaces and commas, therefore we need the following macros. 51X:= 52SPACE:=$(X) $(X) 53COMMA:=, 54DOLLAR:=$$ 55HASH:=\# 56LEFT_PAREN:=( 57RIGHT_PAREN:=) 58SQUOTE:=' 59#' 60DQUOTE:=" 61#" 62define NEWLINE 63 64 65endef 66 67# In GNU Make 4.0 and higher, there is a file function for writing to files. 68ifeq (4.0, $(firstword $(sort 4.0 $(MAKE_VERSION)))) 69 HAS_FILE_FUNCTION := true 70endif 71 72############################## 73# Functions 74############################## 75 76### Debug functions 77 78# Prints the name and value of a variable 79PrintVar = \ 80 $(info $(strip $1) >$($(strip $1))<) 81 82### Functions for timers 83 84# Store the build times in this directory. 85BUILDTIMESDIR=$(OUTPUT_ROOT)/make-support/build-times 86 87# Record starting time for build of a sub repository. 88define RecordStartTime 89 $(DATE) '+%Y %m %d %H %M %S' | $(NAWK) '{ print $$1,$$2,$$3,$$4,$$5,$$6,($$4*3600+$$5*60+$$6) }' > $(BUILDTIMESDIR)/build_time_start_$(strip $1) && \ 90 $(DATE) '+%Y-%m-%d %H:%M:%S' > $(BUILDTIMESDIR)/build_time_start_$(strip $1)_human_readable 91endef 92 93# Record ending time and calculate the difference and store it in a 94# easy to read format. Handles builds that cross midnight. Expects 95# that a build will never take 24 hours or more. 96define RecordEndTime 97 $(DATE) '+%Y %m %d %H %M %S' | $(NAWK) '{ print $$1,$$2,$$3,$$4,$$5,$$6,($$4*3600+$$5*60+$$6) }' > $(BUILDTIMESDIR)/build_time_end_$(strip $1) 98 $(DATE) '+%Y-%m-%d %H:%M:%S' > $(BUILDTIMESDIR)/build_time_end_$(strip $1)_human_readable 99 $(ECHO) `$(CAT) $(BUILDTIMESDIR)/build_time_start_$(strip $1)` `$(CAT) $(BUILDTIMESDIR)/build_time_end_$(strip $1)` $1 | \ 100 $(NAWK) '{ F=$$7; T=$$14; if (F > T) { T+=3600*24 }; D=T-F; H=int(D/3600); \ 101 M=int((D-H*3600)/60); S=D-H*3600-M*60; printf("%02d:%02d:%02d %s\n",H,M,S,$$15); }' \ 102 > $(BUILDTIMESDIR)/build_time_diff_$(strip $1) 103endef 104 105# Hook to be called when starting to execute a top-level target 106define TargetEnter 107 $(PRINTF) "## Starting $(patsubst %-only,%,$@)\n" 108 $(call RecordStartTime,$(patsubst %-only,%,$@)) 109endef 110 111# Hook to be called when finish executing a top-level target 112define TargetExit 113 $(call RecordEndTime,$(patsubst %-only,%,$@)) 114 $(PRINTF) "## Finished $(patsubst %-only,%,$@) (build time %s)\n\n" \ 115 "`$(CAT) $(BUILDTIMESDIR)/build_time_diff_$(patsubst %-only,%,$@) | $(CUT) -f 1 -d ' '`" 116endef 117 118################################################################################ 119# This macro translates $ into \$ to protect the $ from expansion in the shell. 120# To make this macro resilient against already escaped strings, first remove 121# any present escapes before escaping so that no double escapes are added. 122EscapeDollar = $(subst $$,\$$,$(subst \$$,$$,$(strip $1))) 123 124################################################################################ 125# This macro translates $ into $$ to protect the string from make itself. 126DoubleDollar = $(subst $$,$$$$,$(strip $1)) 127 128################################################################################ 129# ListPathsSafely can be used to print command parameters to a file. This is 130# typically done if the command line lenght risk being too long for the 131# OS/shell. In later make versions, the file function can be used for this 132# purpose. For earlier versions, a more complex implementation is provided. 133# 134# The function ListPathsSafely can be called either directly or, more commonly 135# from a recipe line. If called from a recipe, it will be executed in the 136# evaluation phase of that recipe, which means that it will write to the file 137# before any other line in the recipe has been run. 138ifeq ($(HAS_FILE_FUNCTION), true) 139 # Param 1 - Name of variable containing paths/arguments to output 140 # Param 2 - File to print to 141 # Param 3 - Set to true to append to file instead of overwriting 142 define ListPathsSafely 143 $$(call MakeDir, $$(dir $$(strip $2))) 144 $$(file $$(if $$(filter true, $$(strip $3)),>>,>) \ 145 $$(strip $2),$$(subst $$(SPACE),$$(NEWLINE),$$(strip $$($$(strip $1))))) 146 endef 147 148else # HAS_FILE_FUNCTION 149 150 $(eval compress_paths = \ 151 $(strip $(shell $(CAT) $(SRC_ROOT)/make/common/support/ListPathsSafely-pre-compress.incl))) 152 compress_paths += \ 153 $(subst $(SRC_ROOT),X97, \ 154 $(subst $(OUTPUT_ROOT),X98, \ 155 $(subst X,X00, \ 156 $(subst $(SPACE),\n,$(strip $1))))) 157 $(eval compress_paths += \ 158 $(strip $(shell $(CAT) $(SRC_ROOT)/make/common/support/ListPathsSafely-post-compress.incl))) 159 160 decompress_paths=$(SED) -f $(SRC_ROOT)/make/common/support/ListPathsSafely-uncompress.sed \ 161 -e 's|X99|\\n|g' \ 162 -e 's|X98|$(OUTPUT_ROOT)|g' -e 's|X97|$(SRC_ROOT)|g' \ 163 -e 's|X00|X|g' 164 165 ListPathsSafely_IfPrintf = \ 166 $(if $(word $3,$($(strip $1))), \ 167 $(shell $(PRINTF) -- "$(strip $(call EscapeDollar, \ 168 $(call compress_paths, $(wordlist $3,$4,$($(strip $1))))))\n" \ 169 | $(decompress_paths) >> $2)) 170 171 # Param 1 - Name of variable containing paths/arguments to output 172 # Param 2 - File to print to 173 # Param 3 - Set to true to append to file instead of overwriting 174 define ListPathsSafely 175 ifneq (,$$(word 10001,$$($1))) 176 $$(error Cannot list safely more than 10000 paths. $1 has $$(words $$($1)) paths!) 177 endif 178 $$(call MakeDir, $$(dir $2)) 179 ifneq ($$(strip $3), true) 180 $$(shell $(RM) $$(strip $2)) 181 endif 182 183 $$(call ListPathsSafely_IfPrintf,$1,$2,1,250) 184 $$(call ListPathsSafely_IfPrintf,$1,$2,251,500) 185 $$(call ListPathsSafely_IfPrintf,$1,$2,501,750) 186 $$(call ListPathsSafely_IfPrintf,$1,$2,751,1000) 187 188 $$(call ListPathsSafely_IfPrintf,$1,$2,1001,1250) 189 $$(call ListPathsSafely_IfPrintf,$1,$2,1251,1500) 190 $$(call ListPathsSafely_IfPrintf,$1,$2,1501,1750) 191 $$(call ListPathsSafely_IfPrintf,$1,$2,1751,2000) 192 193 $$(call ListPathsSafely_IfPrintf,$1,$2,2001,2250) 194 $$(call ListPathsSafely_IfPrintf,$1,$2,2251,2500) 195 $$(call ListPathsSafely_IfPrintf,$1,$2,2501,2750) 196 $$(call ListPathsSafely_IfPrintf,$1,$2,2751,3000) 197 198 $$(call ListPathsSafely_IfPrintf,$1,$2,3001,3250) 199 $$(call ListPathsSafely_IfPrintf,$1,$2,3251,3500) 200 $$(call ListPathsSafely_IfPrintf,$1,$2,3501,3750) 201 $$(call ListPathsSafely_IfPrintf,$1,$2,3751,4000) 202 203 $$(call ListPathsSafely_IfPrintf,$1,$2,4001,4250) 204 $$(call ListPathsSafely_IfPrintf,$1,$2,4251,4500) 205 $$(call ListPathsSafely_IfPrintf,$1,$2,4501,4750) 206 $$(call ListPathsSafely_IfPrintf,$1,$2,4751,5000) 207 208 $$(call ListPathsSafely_IfPrintf,$1,$2,5001,5250) 209 $$(call ListPathsSafely_IfPrintf,$1,$2,5251,5500) 210 $$(call ListPathsSafely_IfPrintf,$1,$2,5501,5750) 211 $$(call ListPathsSafely_IfPrintf,$1,$2,5751,6000) 212 213 $$(call ListPathsSafely_IfPrintf,$1,$2,6001,6250) 214 $$(call ListPathsSafely_IfPrintf,$1,$2,6251,6500) 215 $$(call ListPathsSafely_IfPrintf,$1,$2,6501,6750) 216 $$(call ListPathsSafely_IfPrintf,$1,$2,6751,7000) 217 218 $$(call ListPathsSafely_IfPrintf,$1,$2,7001,7250) 219 $$(call ListPathsSafely_IfPrintf,$1,$2,7251,7500) 220 $$(call ListPathsSafely_IfPrintf,$1,$2,7501,7750) 221 $$(call ListPathsSafely_IfPrintf,$1,$2,7751,8000) 222 223 $$(call ListPathsSafely_IfPrintf,$1,$2,8001,8250) 224 $$(call ListPathsSafely_IfPrintf,$1,$2,8251,8500) 225 $$(call ListPathsSafely_IfPrintf,$1,$2,8501,8750) 226 $$(call ListPathsSafely_IfPrintf,$1,$2,8751,9000) 227 228 $$(call ListPathsSafely_IfPrintf,$1,$2,9001,9250) 229 $$(call ListPathsSafely_IfPrintf,$1,$2,9251,9500) 230 $$(call ListPathsSafely_IfPrintf,$1,$2,9501,9750) 231 $$(call ListPathsSafely_IfPrintf,$1,$2,9751,10000) 232 endef 233endif # HAS_FILE_FUNCTION 234 235################################################################################ 236# The source tips can come from the Mercurial repository, or in the files 237# $(HGTIP_FILENAME) which contains the tip but is also positioned in the same 238# directory as the original $(HGDIR) directory. 239# These should not be := assignments, only used from the root Makefile. 240HG_VERSION = $(shell $(HG) version 2> /dev/null) 241HG_DIRECTORY=.hg 242HGTIP_FILENAME=.hgtip 243HG_SEARCH = ./REPO ./*/REPO ./*/*/REPO ./*/*/*/REPO 244REPO_LIST = $(patsubst ./%,%,$(patsubst %/,%,$(sort $(dir \ 245 $(shell $(CD) $(SRC_ROOT) ; \ 246 $(LS) -d $(HG_SEARCH:%/REPO=%/$(HG_DIRECTORY)) \ 247 $(HG_SEARCH:%/REPO=%/$(HGTIP_FILENAME)) \ 248 2> /dev/null))))) 249 250# Emit the repo:tip pairs to $@ 251define GetSourceTips 252 $(CD) $(SRC_ROOT) ; \ 253 for i in $(REPO_LIST) IGNORE ; do \ 254 if [ "$${i}" = "IGNORE" ] ; then \ 255 continue; \ 256 elif [ -d $${i}/$(HG_DIRECTORY) -a "$(HG_VERSION)" != "" ] ; then \ 257 $(PRINTF) " %s:%s" \ 258 "$${i}" `$(HG) tip --repository $${i} --template '{node|short}\n'` ; \ 259 elif [ -f $${i}/$(HGTIP_FILENAME) ] ; then \ 260 $(PRINTF) " %s:%s" \ 261 "$${i}" `$(CAT) $${i}/$(HGTIP_FILENAME)` ; \ 262 fi; \ 263 done >> $@ 264 $(PRINTF) "\n" >> $@ 265endef 266 267# Create the HGTIP_FILENAME file. Called from closed/make/SourceBundles.gmk 268define CreateHgTip 269 $(HG) tip --repository $1 --template '{node|short}\n' > $1/$(HGTIP_FILENAME); \ 270 $(ECHO) $1/$(HGTIP_FILENAME) 271endef 272 273################################################################################ 274 275define SetupLogging 276 ifeq ($$(LOG_LEVEL), trace) 277 # Shell redefinition trick inspired by http://www.cmcrossroads.com/ask-mr-make/6535-tracing-rule-execution-in-gnu-make 278 # For each target executed, will print 279 # Building <TARGET> (from <FIRST PREREQUISITE>) (<ALL NEWER PREREQUISITES> newer) 280 # but with a limit of 20 on <ALL NEWER PREREQUISITES>, to avoid cluttering logs too much 281 # (and causing a crash on Cygwin). 282 # Default shell seems to always be /bin/sh. Must override with bash to get this to work on Solaris. 283 # Only use time if it's GNU time which supports format and output file. 284 WRAPPER_SHELL := $$(BASH) $$(SRC_ROOT)/common/bin/shell-tracer.sh $$(if $$(findstring yes,$$(IS_GNU_TIME)),$$(TIME),-) $$(OUTPUT_ROOT)/build-trace-time.log $$(SHELL) 285 SHELL := $$(warning $$(if $$@,Building $$@,Running shell command) $$(if $$<, (from $$<))$$(if $$?, ($$(wordlist 1, 20, $$?) $$(if $$(wordlist 21, 22, $$?), ... [in total $$(words $$?) files]) newer)))$$(WRAPPER_SHELL) 286 endif 287 # The warn level can never be turned off 288 LogWarn = $$(info $$(strip $$1)) 289 LOG_WARN := 290 ifneq ($$(findstring $$(LOG_LEVEL), info debug trace),) 291 LogInfo = $$(info $$(strip $$1)) 292 LOG_INFO := 293 else 294 LogInfo = 295 LOG_INFO := > /dev/null 296 endif 297 ifneq ($$(findstring $$(LOG_LEVEL), debug trace),) 298 LogDebug = $$(info $$(strip $$1)) 299 LOG_DEBUG := 300 else 301 LogDebug = 302 LOG_DEBUG := > /dev/null 303 endif 304 ifneq ($$(findstring $$(LOG_LEVEL), trace),) 305 LogTrace = $$(info $$(strip $$1)) 306 LOG_TRACE := 307 else 308 LogTrace = 309 LOG_TRACE := > /dev/null 310 endif 311endef 312 313# Make sure logging is setup for everyone that includes MakeBase.gmk. 314$(eval $(call SetupLogging)) 315 316################################################################################ 317# Creates a sequence of increasing numbers (inclusive). 318# Param 1 - starting number 319# Param 2 - ending number 320sequence = \ 321 $(wordlist $1, $2, $(strip \ 322 $(eval SEQUENCE_COUNT :=) \ 323 $(call _sequence-do,$(strip $2)))) 324 325_sequence-do = \ 326 $(if $(word $1, $(SEQUENCE_COUNT)),, \ 327 $(eval SEQUENCE_COUNT += .) \ 328 $(words $(SEQUENCE_COUNT)) \ 329 $(call _sequence-do,$1)) 330 331################################################################################ 332 333MAX_PARAMS := 35 334PARAM_SEQUENCE := $(call sequence, 2, $(MAX_PARAMS)) 335 336# Template for creating a macro taking named parameters. To use it, assign the 337# template to a variable with the name you want for your macro, using '=' 338# assignment. Then define a macro body with the suffix "Body". The Body macro 339# should take 1 parameter which should be a unique string for that invocation 340# of the macro. 341# Ex: 342# SetupFoo = $(NamedParamsMacroTemplate) 343# define SetupFooBody 344# # do something 345# # access parameters as $$($1_BAR) 346# endef 347# Call it like this 348# $(eval $(call SetupFoo, BUILD_SOMETHING, \ 349# BAR := some parameter value, \ 350# )) 351define NamedParamsMacroTemplate 352 $(if $($(MAX_PARAMS)),$(error Internal makefile error: \ 353 Too many named arguments to macro, please update MAX_PARAMS in MakeBase.gmk)) 354 # Iterate over 2 3 4... and evaluate the named parameters with $1_ as prefix 355 $(foreach i,$(PARAM_SEQUENCE), $(if $(strip $($i)),\ 356 $(strip $1)_$(strip $($i)))$(NEWLINE)) 357 # Debug print all named parameter names and values 358 $(if $(findstring $(LOG_LEVEL),debug trace), \ 359 $(info $0 $(strip $1) $(foreach i,$(PARAM_SEQUENCE), \ 360 $(if $(strip $($i)),$(NEWLINE) $(strip [$i] $(if $(filter $(LOG_LEVEL), trace), \ 361 $($i), $(wordlist 1, 20, $($(i))) $(if $(word 21, $($(i))), ...))))))) 362 363 $(if $(DEBUG_$(strip $1)), 364 $(info -------- <<< Begin expansion of $(strip $1)) \ 365 $(info $(call $(0)Body,$(strip $1))) \ 366 $(info -------- >>> End expansion of $(strip $1)) \ 367 ) 368 369 $(call $(0)Body,$(strip $1)) 370endef 371 372################################################################################ 373# Make directory without forking mkdir if not needed 374# 1: List of directories to create 375MakeDir = \ 376 $(strip \ 377 $(eval MakeDir_dirs_to_make := $(strip $(foreach d, $1, $(if $(wildcard $d), , $d)))) \ 378 $(if $(MakeDir_dirs_to_make), $(shell $(MKDIR) -p $(MakeDir_dirs_to_make))) \ 379 ) 380 381################################################################################ 382# Assign a variable only if it is empty 383# Param 1 - Variable to assign 384# Param 2 - Value to assign 385SetIfEmpty = \ 386 $(if $($(strip $1)),,$(eval $(strip $1) := $2)) 387 388################################################################################ 389 390ifeq ($(OPENJDK_TARGET_OS),solaris) 391 # On Solaris, if the target is a symlink and exists, cp won't overwrite. 392 # Cp has to operate in recursive mode to allow for -P flag, to preserve soft links. If the 393 # name of the target file differs from the source file, rename after copy. 394 # If the source and target parent directories are the same, recursive copy doesn't work 395 # so we fall back on regular copy, which isn't preserving symlinks. 396 define install-file 397 $(MKDIR) -p '$(@D)' 398 $(RM) '$@' 399 if [ "$(@D)" != "$(<D)" ]; then \ 400 $(CP) -f -r -P '$<' '$(@D)'; \ 401 if [ "$(@F)" != "$(<F)" ]; then \ 402 $(MV) '$(@D)/$(<F)' '$@'; \ 403 fi; \ 404 else \ 405 if [ -L '$<' ]; then \ 406 $(ECHO) "Source file is a symlink and target is in the same directory: $< $@" ; \ 407 exit 1; \ 408 fi; \ 409 $(CP) -f '$<' '$@'; \ 410 fi 411 endef 412else ifeq ($(OPENJDK_TARGET_OS),macosx) 413 # On mac, extended attributes sometimes creep into the source files, which may later 414 # cause the creation of ._* files which confuses testing. Clear these with xattr if 415 # set. Some files get their write permissions removed after being copied to the 416 # output dir. When these are copied again to images, xattr would fail. By only clearing 417 # attributes when they are present, failing on this is avoided. 418 define install-file 419 $(MKDIR) -p '$(@D)' 420 $(CP) -fRP '$<' '$@' 421 if [ -n "`$(XATTR) -l '$@'`" ]; then $(XATTR) -c '$@'; fi 422 endef 423else 424 # Running mkdir and cp in the same shell speeds up copy intensive tasks in Cygwin 425 # significantly. 426 define install-file 427 $(call MakeDir, $(@D)) 428 $(CP) -fP '$<' '$@' 429 endef 430endif 431 432################################################################################ 433# Filter out duplicate sub strings while preserving order. Keeps the first occurance. 434uniq = \ 435 $(if $1,$(firstword $1) $(call uniq,$(filter-out $(firstword $1),$1))) 436 437# Returns all whitespace-separated words in $2 where at least one of the 438# whitespace-separated words in $1 is a substring. 439containing = \ 440 $(strip \ 441 $(foreach v,$(strip $2),\ 442 $(call uniq,$(foreach p,$(strip $1),$(if $(findstring $p,$v),$v))))) 443 444# Returns all whitespace-separated words in $2 where none of the 445# whitespace-separated words in $1 is a substring. 446not-containing = \ 447 $(strip $(filter-out $(call containing,$1,$2),$2)) 448 449# Return a list of all string elements that are duplicated in $1. 450dups = \ 451 $(strip $(foreach v, $(sort $1), $(if $(filter-out 1, \ 452 $(words $(filter $v, $1))), $v))) 453 454# String equals 455equals = \ 456 $(and $(findstring $(strip $1),$(strip $2)),\ 457 $(findstring $(strip $2),$(strip $1))) 458 459# Remove a whole list of prefixes 460# $1 - List of prefixes 461# $2 - List of elements to process 462remove-prefixes = \ 463 $(strip $(if $1,$(patsubst $(firstword $1)%,%,\ 464 $(call remove-prefixes,$(filter-out $(firstword $1),$1),$2)),$2)) 465 466# Convert the string given to upper case, without any $(shell) 467# Inspired by http://lists.gnu.org/archive/html/help-make/2013-09/msg00009.html 468uppercase_table := a,A b,B c,C d,D e,E f,F g,G h,H i,I j,J k,K l,L m,M n,N o,O \ 469 p,P q,Q r,R s,S t,T u,U v,V w,W x,X y,Y z,Z 470 471uppercase_internal = \ 472 $(if $(strip $1), $$(subst $(firstword $1), $(call uppercase_internal, \ 473 $(wordlist 2, $(words $1), $1), $2)), $2) 474 475# Convert a string to upper case. Works only on a-z. 476# $1 - The string to convert 477uppercase = \ 478 $(strip \ 479 $(eval uppercase_result := $(call uppercase_internal, $(uppercase_table), $1)) \ 480 $(uppercase_result) \ 481 ) 482 483################################################################################ 484 485ifneq ($(DISABLE_CACHE_FIND), true) 486 # In Cygwin, finds are very costly, both because of expensive forks and because 487 # of bad file system caching. Find is used extensively in $(shell) commands to 488 # find source files. This makes rerunning make with no or few changes rather 489 # expensive. To speed this up, these two macros are used to cache the results 490 # of simple find commands for reuse. 491 # 492 # Runs a find and stores both the directories where it was run and the results. 493 # This macro can be called multiple times to add to the cache. Only finds files 494 # with no filters. 495 # 496 # Needs to be called with $(eval ) 497 # 498 # Even if the performance benifit is negligible on other platforms, keep the 499 # functionality active unless explicitly disabled to exercise it more. 500 # 501 # Initialize FIND_CACHE_DIRS with := to make it a non recursively-expanded variable 502 FIND_CACHE_DIRS := 503 # Param 1 - Dirs to find in 504 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 505 define FillCacheFind 506 # Filter out already cached dirs. The - is needed when FIND_CACHE_DIRS is empty 507 # since filter out will then return empty. 508 FIND_CACHE_NEW_DIRS := $$(filter-out $$(addsuffix /%,\ 509 - $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS), $1) 510 ifneq ($$(FIND_CACHE_NEW_DIRS), ) 511 # Remove any trailing slash from dirs in the cache dir list 512 FIND_CACHE_DIRS += $$(patsubst %/,%, $$(FIND_CACHE_NEW_DIRS)) 513 FIND_CACHE := $$(sort $$(FIND_CACHE) $$(shell $(FIND) $$(FIND_CACHE_NEW_DIRS) \( -type f -o -type l \) $2)) 514 endif 515 endef 516 517 # Mimics find by looking in the cache if all of the directories have been cached. 518 # Otherwise reverts to shell find. This is safe to call on all platforms, even if 519 # cache is deactivated. 520 # 521 # $1 can be either a directory or a file. If it's a directory, make 522 # sure we have exactly one trailing slash before the wildcard. 523 # The extra - is needed when FIND_CACHE_DIRS is empty but should be harmless. 524 # 525 # Param 1 - Dirs to find in 526 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 527 define CacheFind 528 $(if $(filter-out $(addsuffix /%,- $(FIND_CACHE_DIRS)) $(FIND_CACHE_DIRS),$1), \ 529 $(shell $(FIND) $1 \( -type f -o -type l \) $2), \ 530 $(filter $(addsuffix /%,$(patsubst %/,%,$1)) $1,$(FIND_CACHE))) 531 endef 532 533else 534 # If CacheFind is disabled, just run the find command. 535 # Param 1 - Dirs to find in 536 # Param 2 - (optional) specialization. Normally "-a \( ... \)" expression. 537 define CacheFind 538 $(shell $(FIND) $1 \( -type f -o -type l \) $2) 539 endef 540endif 541 542################################################################################ 543 544define AddFileToCopy 545 # Helper macro for SetupCopyFiles 546 # 1 : Source file 547 # 2 : Dest file 548 # 3 : Variable to add targets to 549 # 4 : Macro to call for copy operation 550 $2: $1 551 $$(call LogInfo, Copying $$(patsubst $(OUTPUT_ROOT)/%,%,$$@)) 552 $$($$(strip $4)) 553 554 $3 += $2 555endef 556 557# Returns the value of the first argument 558identity = \ 559 $(strip $1) 560 561# Setup make rules for copying files, with an option to do more complex 562# processing instead of copying. 563# 564# Parameter 1 is the name of the rule. This name is used as variable prefix, 565# and the targets generated are listed in a variable by that name. 566# 567# Remaining parameters are named arguments. These include: 568# SRC : Source root dir (defaults to dir of first file) 569# DEST : Dest root dir 570# FILES : List of files to copy with absolute paths, or path relative to SRC. 571# Must be in SRC. 572# FLATTEN : Set to flatten the directory structure in the DEST dir. 573# MACRO : Optionally override the default macro used for making the copy. 574# Default is 'install-file' 575# NAME_MACRO : Optionally supply a macro that rewrites the target file name 576# based on the source file name 577SetupCopyFiles = $(NamedParamsMacroTemplate) 578define SetupCopyFilesBody 579 580 ifeq ($$($1_MACRO), ) 581 $1_MACRO := install-file 582 endif 583 584 # Default SRC to the dir of the first file. 585 ifeq ($$($1_SRC), ) 586 $1_SRC := $$(dir $$(firstword $$($1_FILES))) 587 endif 588 589 ifeq ($$($1_NAME_MACRO), ) 590 $1_NAME_MACRO := identity 591 endif 592 593 # Remove any trailing slash from SRC and DEST 594 $1_SRC := $$(patsubst %/,%,$$($1_SRC)) 595 $1_DEST := $$(patsubst %/,%,$$($1_DEST)) 596 597 $$(foreach f, $$(patsubst $$($1_SRC)/%,%,$$($1_FILES)), \ 598 $$(eval $$(call AddFileToCopy, $$($1_SRC)/$$f, \ 599 $$($1_DEST)/$$(call $$(strip $$($1_NAME_MACRO)),$$(if $$($1_FLATTEN),$$(notdir $$f),$$f)), \ 600 $1, $$($1_MACRO)))) 601 602endef 603 604################################################################################ 605# ShellQuote 606# 607# Quotes a string with single quotes and replaces single quotes with '\'' so 608# that the contents survives being given to the shell. 609 610ShellQuote = \ 611 $(SQUOTE)$(subst $(SQUOTE),$(SQUOTE)\$(SQUOTE)$(SQUOTE),$(strip $1))$(SQUOTE) 612 613################################################################################ 614# Write to and read from file 615 616# Param 1 - File to read 617ReadFile = \ 618 $(shell $(CAT) $1) 619 620# Param 1 - Text to write 621# Param 2 - File to write to 622ifeq ($(HAS_FILE_FUNCTION), true) 623 WriteFile = \ 624 $(file >$2,$(strip $1)) 625else 626 # Use printf to get consistent behavior on all platforms. 627 WriteFile = \ 628 $(shell $(PRINTF) "%s" $(call ShellQuote, $1) > $2) 629endif 630 631################################################################################ 632# DependOnVariable 633# 634# This macro takes a variable name and puts the value in a file only if the 635# value has changed since last. The name of the file is returned. This can be 636# used to create rule dependencies on make variable values. The following 637# example would get rebuilt if the value of SOME_VAR was changed: 638# 639# path/to/some-file: $(call DependOnVariable, SOME_VAR) 640# echo $(SOME_VAR) > $@ 641# 642# Note that leading and trailing white space in the value is ignored. 643# 644 645# Defines the sub directory structure to store variable value file in 646DependOnVariableDirName = \ 647 $(strip $(subst $(SRC_ROOT)/,,\ 648 $(if $(filter /%, $(firstword $(MAKEFILE_LIST))), \ 649 $(firstword $(MAKEFILE_LIST)), \ 650 $(CURDIR)/$(firstword $(MAKEFILE_LIST))))) 651 652# Defines the name of the file to store variable value in. Generates a name 653# unless parameter 2 is given. 654# Param 1 - Name of variable 655# Param 2 - (optional) name of file to store value in 656DependOnVariableFileName = \ 657 $(strip $(if $(strip $2), $2, \ 658 $(MAKESUPPORT_OUTPUTDIR)/vardeps/$(DependOnVariableDirName)/$(strip $1).vardeps)) 659 660# Does the actual work with parameters stripped. 661# If the file exists AND the contents is the same as the variable, do nothing 662# else print a new file. 663# Always returns the name of the file where the value was printed. 664# Param 1 - Name of variable 665# Param 2 - (optional) name of file to store value in 666DependOnVariableHelper = \ 667 $(strip \ 668 $(eval -include $(call DependOnVariableFileName, $1, $2)) \ 669 $(if $(call equals, $(strip $($1)), $(strip $($1_old))),,\ 670 $(call MakeDir, $(dir $(call DependOnVariableFileName, $1, $2))) \ 671 $(if $(findstring $(LOG_LEVEL), trace), \ 672 $(info NewVariable $1: >$(strip $($1))<) \ 673 $(info OldVariable $1: >$(strip $($1_old))<)) \ 674 $(call WriteFile, $1_old:=$(call DoubleDollar,$($1)), \ 675 $(call DependOnVariableFileName, $1, $2))) \ 676 $(call DependOnVariableFileName, $1, $2) \ 677 ) 678 679# Main macro 680# Param 1 - Name of variable 681# Param 2 - (optional) name of file to store value in 682DependOnVariable = \ 683 $(call DependOnVariableHelper,$(strip $1),$(strip $2)) 684 685# LogCmdlines is only intended to be used by ExecuteWithLog 686ifeq ($(LOG_CMDLINES), true) 687 LogCmdlines = $(info $(strip $1)) 688else 689 LogCmdlines = 690endif 691 692################################################################################ 693# ExecuteWithLog will run a command and log the output appropriately. This is 694# meant to be used by commands that do "real" work, like a compilation. 695# The output is stored in a specified log file, which is displayed at the end 696# of the build in case of failure. The command line itself is stored in a file, 697# and also logged to stdout if the LOG=cmdlines option has been given. 698# 699# Param 1 - The path to base the name of the log file / command line file on 700# Param 2 - The command to run 701ExecuteWithLog = \ 702 $(call LogCmdlines, Exececuting: [$(strip $2)]) \ 703 $(call WriteFile, $2, $(strip $1).cmdline) \ 704 ( $(strip $2) > >($(TEE) $(strip $1).log) 2> >($(TEE) $(strip $1).log >&2) || \ 705 ( exitcode=$(DOLLAR)? && \ 706 $(CP) $(strip $1).log $(MAKESUPPORT_OUTPUTDIR)/failure-logs/$(subst /,_,$(patsubst $(BUILD_OUTPUT)/%,%,$(strip $1))).log && \ 707 exit $(DOLLAR)exitcode ) ) 708 709################################################################################ 710# Find lib dir for module 711# Param 1 - module name 712ifeq ($(OPENJDK_TARGET_OS_TYPE), unix) 713 FindLibDirForModule = \ 714 $(SUPPORT_OUTPUTDIR)/modules_libs/$(strip $1)$(OPENJDK_TARGET_CPU_LIBDIR) 715else 716 FindLibDirForModule = \ 717 $(SUPPORT_OUTPUTDIR)/modules_libs/$(strip $1) 718endif 719 720################################################################################ 721# Return a string suitable for use after a -classpath option. It will correct and safe to use 722# on all platforms. Arguments are given as space separate classpath entries. 723# param 1 : A space separated list of classpath entries 724# The surrounding strip is needed to keep additional whitespace out 725PathList = \ 726 "$(subst $(SPACE),$(PATH_SEP),$(strip $1))" 727 728################################################################################ 729 730# Hook to include the corresponding custom file, if present. 731$(eval $(call IncludeCustomExtension, , common/MakeBase.gmk)) 732 733endif # _MAKEBASE_GMK 734